Improve error codes and ICEs (#72)

Author: smartycope

pyndustric/compiler.py

@@ -32,8 +32,10 @@ def __init__(self):
 
     def __str__(self):
         if self._lineno is None:
-            raise InternalCompilerError(
-                "lineno should be set. some instruction likely referenced this unstored label", None
+            raise CompilerError(
+                INTERNAL_COMPILER_ERR,
+                None,
+                "lineno should be set. some instruction likely referenced this unstored label",
             )
 
         return str(self._lineno)
@@ -63,7 +65,7 @@ class Function:
 
 
 class CompilerError(ValueError):
-    def __init__(self, code, node: ast.AST, **context):
+    def __init__(self, code, node: ast.AST, desc="", **context):
         if node is None:
             node = ast.Module(lineno=0, col_offset=0)  # dummy value
 
@@ -76,18 +78,10 @@ def __init__(self, code, node: ast.AST, **context):
         ]:
             context["unparsed"] = ast.unparse(node)
         super().__init__(
-            f"[{code}/{node.lineno}:{node.col_offset}] {ERROR_DESCRIPTIONS[code].format(**context)}"
+            f" {code}: {ERROR_DESCRIPTIONS[code].format(**context)}, line {node.lineno}, column {node.col_offset}\n{desc}"
         )
 
 
-class InternalCompilerError(CompilerError):
-    def __init__(self, code, node: ast.AST):
-        if node is None:
-            node = ast.Module(lineno=0, col_offset=0)  # dummy value
-
-        ValueError.__init__(self, f"[ICE/{node.lineno}:{node.col_offset}] {code}")
-
-
 class CompatTransformer(ast.NodeTransformer):
     if sys.version_info < (3, 9):
 
@@ -492,7 +486,7 @@ def visit_FunctionDef(self, node):
 
     def visit_Return(self, node):
         if not self._epilogue:
-            raise InternalCompilerError("return encountered with epilogue being unset", node)
+            raise CompilerError(INTERNAL_COMPILER_ERR, node, "return encountered with epilogue being unset")
 
         val = self.as_value(node.value)
         self.ins_append(f"set {REG_RET} {val}")

pyndustric/constants.py

@@ -1,22 +1,23 @@
 import ast
 
-ERR_COMPLEX_ASSIGN = "E002"
-ERR_COMPLEX_VALUE = "E003"
-ERR_UNSUPPORTED_OP = "E004"
-ERR_UNSUPPORTED_ITER = "E005"
-ERR_BAD_ITER_ARGS = "E006"
-ERR_UNSUPPORTED_IMPORT = "E007"
-ERR_UNSUPPORTED_EXPR = "E008"
-ERR_UNSUPPORTED_SYSCALL = "E009"
-ERR_BAD_SYSCALL_ARGS = "E010"
-ERR_NESTED_DEF = "E011"
-ERR_INVALID_DEF = "E012"
-ERR_REDEF = "E013"
-ERR_NO_DEF = "E014"
-ERR_ARGC_MISMATCH = "E015"
-ERR_TOO_LONG = "E016"
-ERR_INVALID_SOURCE = "E017"
-ERR_BAD_TUPLE_ASSIGN = "E018"
+ERR_COMPLEX_ASSIGN = "NoComplexError"
+ERR_COMPLEX_VALUE = "NoComplexMathError"
+ERR_UNSUPPORTED_OP = "UnsupportedOperationError"
+ERR_UNSUPPORTED_ITER = "UnsupportedIteratorError"
+ERR_BAD_ITER_ARGS = "InvalidRangeError"
+ERR_UNSUPPORTED_IMPORT = "InvalidImportError"
+ERR_UNSUPPORTED_EXPR = "StandaloneError"
+ERR_UNSUPPORTED_SYSCALL = "InvalidSysCallError"
+ERR_BAD_SYSCALL_ARGS = "InvalidSysCallArgsError"
+ERR_NESTED_DEF = "NoRecursionError"
+ERR_INVALID_DEF = "FuncDefError"
+ERR_REDEF = "RedefinitionError"
+ERR_NO_DEF = "UndefinedFuncError"
+ERR_ARGC_MISMATCH = "ArgumentsError"
+ERR_TOO_LONG = "OverflowError"
+ERR_INVALID_SOURCE = "CompilerError"
+ERR_BAD_TUPLE_ASSIGN = "BadTupleError"
+INTERNAL_COMPILER_ERR = "InternalCompilerError"
 
 ERROR_DESCRIPTIONS = {
     ERR_COMPLEX_ASSIGN: "cannot perform complex assignment `{unparsed}`",
@@ -36,6 +37,7 @@
     ERR_TOO_LONG: "the program is too long to fit in a logic processor",
     ERR_INVALID_SOURCE: "the provided source type to compile is not supported",
     ERR_BAD_TUPLE_ASSIGN: "can only assign to a tuple if the right-hand side is a tuple of the same length",
+    INTERNAL_COMPILER_ERR: "internal compiler error",
 }
 
 BIN_CMP = {

test_all.py

@@ -62,7 +62,7 @@ def test_all_err_have_desc_and_tests():
     error_values = {getattr(pyndustric, name) for name in error_names}
 
     assert len(error_values) == len(error_names), "some error constants have duplicate values"
-    assert len(error_values) == len(pyndustric.ERROR_DESCRIPTIONS), "not all errors are documented"
+    assert len(error_values) + 1 == len(pyndustric.ERROR_DESCRIPTIONS), "not all errors are documented"
 
     with open(__file__, encoding="utf-8") as fd:
         source = fd.read()