Introducing classes to track issues

.gitignore

@@ -13,3 +13,4 @@ __pycache__
 /.token
 /antlr-*.jar
 .DS_Store
+.coverage

pylasu/parsing/results.py

@@ -0,0 +1,37 @@
+from dataclasses import dataclass
+from typing import List
+
+from antlr4 import ParserRuleContext, Token
+
+from pylasu.model import Source
+from pylasu.validation.validation import WithIssues, IssueType, Issue
+
+
+@dataclass
+class FirstStageResult(WithIssues):
+    parse_tree: ParserRuleContext
+
+
+@dataclass
+class LexingResult(WithIssues):
+    tokens: List[Token]
+
+
+@dataclass
+class IssuesErrorListener:
+    """This Error Listener should be used with ANTLR lexers and parsers to capture issues"""
+    type: IssueType
+    source: Source
+    issues: WithIssues
+
+    def syntaxError(self, recognizer, offendingSymbol, line, column, msg, e):
+        self.issues.append(Issue(type=self.type, message=msg))
+
+    def reportAmbiguity(self, recognizer, dfa, startIndex, stopIndex, exact, ambigAlts, configs):
+        pass
+
+    def reportAttemptingFullContext(self, recognizer, dfa, startIndex, stopIndex, conflictingAlts, configs):
+        pass
+
+    def reportContextSensitivity(self, recognizer, dfa, startIndex, stopIndex, prediction, configs):
+        pass

pylasu/validation/validation.py

@@ -36,6 +36,11 @@ def semantic(message: str, severity: IssueSeverity = IssueSeverity.ERROR, positi
 
 
 @dataclass
-class Result:
+class WithIssues:
+    """Many classes have the necessity of tracking issues"""
+    issues: List[Issue] = field(default_factory=list, init=False)
+
+
+@dataclass
+class Result(WithIssues):
     root: Node
-    issues: List[Issue] = field(default_factory=list)