Make all of the test cases type check

Author: rexim

porth.py

@@ -52,6 +52,7 @@ class Intrinsic(Enum):
     STORE=auto()
     LOAD64=auto()
     STORE64=auto()
+    CAST_PTR=auto()
     ARGC=auto()
     ARGV=auto()
     SYSCALL0=auto()
@@ -184,7 +185,7 @@ def simulate_little_endian_linux(program: Program, argv: List[str]):
             else:
                 ip += 1
         elif op.typ == OpType.INTRINSIC:
-            assert len(Intrinsic) == 33, "Exhaustive handling of intrinsic in simulate_little_endian_linux()"
+            assert len(Intrinsic) == 34, "Exhaustive handling of intrinsic in simulate_little_endian_linux()"
             if op.operand == Intrinsic.PLUS:
                 a = stack.pop()
                 b = stack.pop()
@@ -315,6 +316,9 @@ def simulate_little_endian_linux(program: Program, argv: List[str]):
             elif op.operand == Intrinsic.ARGV:
                 stack.append(argv_buf_ptr)
                 ip += 1
+            elif op.operand == Intrinsic.CAST_PTR:
+                # Ignore the type casting. It's only useful for type_check_program() phase
+                ip += 1
             elif op.operand == Intrinsic.SYSCALL0:
                 syscall_number = stack.pop();
                 if syscall_number == 39: # SYS_getpid
@@ -421,7 +425,7 @@ def type_check_program(program: Program):
             stack.append((DataType.INT, op.token))
             stack.append((DataType.PTR, op.token))
         elif op.typ == OpType.INTRINSIC:
-            assert len(Intrinsic) == 33, "Exhaustive intrinsic handling in type_check_program()"
+            assert len(Intrinsic) == 34, "Exhaustive intrinsic handling in type_check_program()"
             assert isinstance(op.operand, Intrinsic), "This could be a bug in compilation step"
             if op.operand == Intrinsic.PLUS:
                 assert len(DataType) == 3, "Exhaustive type handling in PLUS intrinsic"
@@ -665,7 +669,7 @@ def type_check_program(program: Program):
                 if a_type == DataType.PTR:
                     stack.append((DataType.INT, op.token))
                 else:
-                    compiler_error_(op.token, "invalid argument type for LOAD intrinsic")
+                    compiler_error_(op.token, "invalid argument type for LOAD intrinsic: %s" % a_type)
                     exit(1)
             elif op.operand == Intrinsic.STORE:
                 assert len(DataType) == 3, "Exhaustive type handling in STORE intrinsic"
@@ -707,6 +711,14 @@ def type_check_program(program: Program):
                 else:
                     compiler_error_(op.token, "invalid argument type for STORE64 intrinsic")
                     exit(1)
+            elif op.operand == Intrinsic.CAST_PTR:
+                if len(stack) < 1:
+                    not_enough_arguments(op)
+                    exit(1)
+
+                a_type, a_token = stack.pop()
+
+                stack.append((DataType.PTR, a_token))
             elif op.operand == Intrinsic.ARGC:
                 stack.append((DataType.INT, op.token))
             elif op.operand == Intrinsic.ARGV:
@@ -826,7 +838,7 @@ def type_check_program(program: Program):
         else:
             assert False, "unreachable"
     if len(stack) != 0:
-        compiler_error_(stack.pop()[1], "unhandled data on the stack")
+        compiler_error_(stack[-1][1], "unhandled data on the stack: %s" % list(map(lambda x: x[0], stack)))
         exit(1)
 
 def generate_nasm_linux_x86_64(program: Program, out_file_path: str):
@@ -912,7 +924,7 @@ def generate_nasm_linux_x86_64(program: Program, out_file_path: str):
                 assert isinstance(op.operand, int), "This could be a bug in the compilation step"
                 out.write("    jz addr_%d\n" % op.operand)
             elif op.typ == OpType.INTRINSIC:
-                assert len(Intrinsic) == 33, "Exhaustive intrinsic handling in generate_nasm_linux_x86_64()"
+                assert len(Intrinsic) == 34, "Exhaustive intrinsic handling in generate_nasm_linux_x86_64()"
                 if op.operand == Intrinsic.PLUS:
                     out.write("    ;; -- plus --\n")
                     out.write("    pop rax\n")
@@ -1077,6 +1089,8 @@ def generate_nasm_linux_x86_64(program: Program, out_file_path: str):
                     out.write("    pop rbx\n");
                     out.write("    pop rax\n");
                     out.write("    mov [rax], rbx\n");
+                elif op.operand == Intrinsic.CAST_PTR:
+                    out.write("    ;; -- cast(ptr) --\n")
                 elif op.operand == Intrinsic.SYSCALL0:
                     out.write("    ;; -- syscall0 --\n")
                     out.write("    pop rax\n")
@@ -1160,7 +1174,7 @@ def generate_nasm_linux_x86_64(program: Program, out_file_path: str):
     'include': Keyword.INCLUDE,
 }
 
-assert len(Intrinsic) == 33, "Exhaustive INTRINSIC_BY_NAMES definition"
+assert len(Intrinsic) == 34, "Exhaustive INTRINSIC_BY_NAMES definition"
 INTRINSIC_BY_NAMES = {
     '+': Intrinsic.PLUS,
     '-': Intrinsic.MINUS,
@@ -1186,6 +1200,7 @@ def generate_nasm_linux_x86_64(program: Program, out_file_path: str):
     ',': Intrinsic.LOAD,
     '.64': Intrinsic.STORE64,
     ',64': Intrinsic.LOAD64,
+    'cast(ptr)': Intrinsic.CAST_PTR,
     'argc': Intrinsic.ARGC,
     'argv': Intrinsic.ARGV,
     'syscall0': Intrinsic.SYSCALL0,
@@ -1470,7 +1485,6 @@ def usage(compiler_name: str):
     print("    -debug                Enable debug mode.")
     print("    -I <path>             Add the path to the include search list")
     print("    -E <expansion-limit>  Macro and include expansion limit. (Default %d)" % DEFAULT_EXPANSION_LIMIT)
-    print("    -check                Type check the program")
     print("  SUBCOMMAND:")
     print("    sim <file>            Simulate the program")
     print("    com [OPTIONS] <file>  Compile the program")
@@ -1487,7 +1501,6 @@ def usage(compiler_name: str):
 
     include_paths = ['.', './std/']
     expansion_limit = DEFAULT_EXPANSION_LIMIT
-    check = False
 
     while len(argv) > 0:
         if argv[0] == '-debug':
@@ -1509,9 +1522,6 @@ def usage(compiler_name: str):
                 exit(1)
             arg, *argv = argv
             expansion_limit = int(arg)
-        elif argv[0] == '-check':
-            argv = argv[1:]
-            check = True
         else:
             break
 
@@ -1534,8 +1544,7 @@ def usage(compiler_name: str):
         program_path, *argv = argv
         include_paths.append(path.dirname(program_path))
         program = compile_file_to_program(program_path, include_paths, expansion_limit);
-        if check:
-            type_check_program(program)
+        type_check_program(program)
         simulate_little_endian_linux(program, [program_path] + argv)
     elif subcommand == "com":
         silent = False
@@ -1591,8 +1600,7 @@ def usage(compiler_name: str):
         include_paths.append(path.dirname(program_path))
 
         program = compile_file_to_program(program_path, include_paths, expansion_limit);
-        if check:
-            type_check_program(program)
+        type_check_program(program)
         generate_nasm_linux_x86_64(program, basepath + ".asm")
         cmd_call_echoed(["nasm", "-felf64", basepath + ".asm"], silent)
         cmd_call_echoed(["ld", "-o", basepath, basepath + ".o"], silent)

test.py

@@ -91,12 +91,12 @@ def run_test_for_file(file_path: str) -> Tuple[bool, bool]:
         print("[ERROR] Unexpected simulation output")
         print("  Expected:")
         print("    return code: %s" % tc.returncode)
-        print("    stdout: %s" % tc.stdout.decode("utf-8"))
-        print("    stderr: %s" % tc.stderr.decode("utf-8"))
+        print("    stdout: \n%s" % tc.stdout.decode("utf-8"))
+        print("    stderr: \n%s" % tc.stderr.decode("utf-8"))
         print("  Actual:")
         print("    return code: %s" % sim.returncode)
-        print("    stdout: %s" % sim.stdout.decode("utf-8"))
-        print("    stderr: %s" % sim.stderr.decode("utf-8"))
+        print("    stdout: \n%s" % sim.stdout.decode("utf-8"))
+        print("    stderr: \n%s" % sim.stderr.decode("utf-8"))
 
     com = cmd_run_echoed([sys.executable, "./porth.py", "com", "-r", "-s", file_path, *tc.argv], input=tc.stdin, capture_output=True)
     com_ok = True
@@ -105,12 +105,12 @@ def run_test_for_file(file_path: str) -> Tuple[bool, bool]:
         print("[ERROR] Unexpected compilation output")
         print("  Expected:")
         print("    return code: %s" % tc.returncode)
-        print("    stdout: %s" % tc.stdout.decode("utf-8"))
-        print("    stderr: %s" % tc.stderr.decode("utf-8"))
+        print("    stdout: \n%s" % tc.stdout.decode("utf-8"))
+        print("    stderr: \n%s" % tc.stderr.decode("utf-8"))
         print("  Actual:")
         print("    return code: %s" % com.returncode)
-        print("    stdout: %s" % com.stdout.decode("utf-8"))
-        print("    stderr: %s" % com.stderr.decode("utf-8"))
+        print("    stdout: \n%s" % com.stdout.decode("utf-8"))
+        print("    stderr: \n%s" % com.stderr.decode("utf-8"))
 
     return (sim_ok, com_ok)
 

tests/argv.porth

@@ -3,8 +3,10 @@ include "./std.porth"
 argv 8 +
 argc 1 -
 while dup 0 > do
-  over ,64 dup strlen swap
+  over ,64 dup cast(ptr) strlen swap
   stdout write drop
   "\n" stdout write drop
   1 - swap 8 + swap
 end
+drop
+drop

tests/comments.porth

@@ -6,4 +6,4 @@ include "std.porth"
 //////nonsense comment
 
 // string literal with `//` should be printed
-"Hello, // World\n" stdout write // this comment should be allowed 
+"Hello, // World\n" stdout write drop // this comment should be allowed 

tests/dead-recursive-macro.porth

@@ -4,4 +4,4 @@ macro dead-recursive-macro
   dead-recursive-macro
 end
 
-"Dead recursive macros should not cause any problems. Because they are never expanded\n" stdout write
+"Dead recursive macros should not cause any problems. Because they are never expanded\n" stdout write drop

tests/macros.porth

@@ -1,11 +1,7 @@
 include "std.porth"
 
 macro check_less
-  < if
-    "YES\n" stdout write
-  else
-    "NO\n" stdout write
-  end
+  < if "YES\n" else "NO\n" end stdout write drop
 end
 
 1 2 check_less
@@ -17,9 +13,9 @@ macro even_fibs
       over print
     end
     swap over +
-  end
+  end drop drop
 end
 
-"------------------------------\n" stdout write
+"------------------------------\n" stdout write drop
 
 even_fibs