Merge pull request #7 from distributed-lab/feature/circuit-v2.2.0

Add suport for Circom v2.2.0. Restructure package

.gitmodules

@@ -1,4 +1,3 @@
 [submodule "circom-g4-grammar"]
 	path = circom-g4-grammar
-	branch = main
 	url = https://github.com/distributed-lab/circom-g4-grammar.git

.mocharc.json

@@ -1,5 +1,6 @@
 {
   "require": [ "ts-node/register" ],
+  "file": ["test/setup.ts"],
   "extensions": ["ts"],
   "spec": [
     "test/**/*.ts"

README.md

@@ -45,16 +45,3 @@ if (errorListener.hasErrors()) {
     throw new ParserError(errorListener.getErrors());
 }
 ```
-
-## Reference: Built-in Visitors
-
-You can use the built-in visitors provided in this package as a reference or starting point for your own implementations:
-- [CircomTemplateVisitor](./src/builtin/CircomTemplateVisitor.ts)
-- [CircomIncludeVisitor](./src/builtin/CircomIncludeVisitor.ts)
-- [CircomMainComponentVisitor](./src/builtin/CircomMainComponentVisitor.ts)
-- [CircomExpressionVisitor](./src/builtin/CircomExpressionVisitor.ts)
-
-## Known limitations
-
-1. Function calls inside the main component declaration or expressions are not supported.
-2. Currently, all 'simple' expressions are evaluated as-is, without accounting for the module.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@distributedlab/circom-parser",
   "description": "Circom circuit parser built with ANTLR4",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [

src/ExtendedCircomParser.ts

@@ -7,17 +7,21 @@ import { CircomLexer, CircomParser } from "./generated";
 import ErrorListener from "./errors/ErrorListener";
 
 export class ExtendedCircomParser extends CircomParser {
-  lexer: CircomLexer | null = null;
+  lexer: CircomLexer;
 
   parserErrorListener: ErrorListener<Token>;
-  lexerErrorListener: ErrorListener<number> | null = null;
+  lexerErrorListener: ErrorListener<number>;
 
-  constructor(tokens: antlr4.CommonTokenStream) {
+  constructor(tokens: antlr4.CommonTokenStream, lexer: CircomLexer) {
     super(tokens);
 
-    this.removeErrorListeners();
+    this.lexer = lexer;
+    this.lexerErrorListener = new ErrorListener();
     this.parserErrorListener = new ErrorListener();
-    this.addErrorListener(this.parserErrorListener);
+
+    this.initErrorListeners();
+
+    this.buildParseTrees = true;
   }
 
   circuit() {
@@ -32,33 +36,25 @@ export class ExtendedCircomParser extends CircomParser {
     this._interp.predictionMode = antlr4.PredictionMode.LL;
     this.reset();
 
-    this.parserErrorListener = new ErrorListener();
-    this.removeErrorListeners();
-    this.addErrorListener(this.parserErrorListener);
+    this.initErrorListeners();
 
     return super.circuit();
   }
 
-  setLexer(lexer: CircomLexer) {
-    this.lexer = lexer;
-  }
-
   initErrorListeners() {
     this.parserErrorListener = new ErrorListener();
     this.removeErrorListeners();
     this.addErrorListener(this.parserErrorListener);
 
-    if (this.lexer) {
-      this.lexerErrorListener = new ErrorListener();
-      this.lexer.removeErrorListeners();
-      this.lexer.addErrorListener(this.lexerErrorListener);
-    }
+    this.lexerErrorListener = new ErrorListener();
+    this.lexer.removeErrorListeners();
+    this.lexer.addErrorListener(this.lexerErrorListener);
   }
 
   hasAnyErrors(): boolean {
     return (
       this.parserErrorListener.hasErrors() ||
-      (this.lexerErrorListener !== null && this.lexerErrorListener.hasErrors())
+      this.lexerErrorListener.hasErrors()
     );
   }
 
@@ -69,11 +65,9 @@ export class ExtendedCircomParser extends CircomParser {
       errors.push(error);
     });
 
-    if (this.lexerErrorListener) {
-      this.lexerErrorListener.getErrors().forEach((error) => {
-        errors.push(error);
-      });
-    }
+    this.lexerErrorListener.getErrors().forEach((error) => {
+      errors.push(error);
+    });
 
     return errors;
   }

src/ExtendedCircomVisitor.ts

@@ -0,0 +1,29 @@
+import { ParserRuleContext } from "antlr4";
+
+import { CircomVisitor } from "./generated";
+
+import { ParserErrorItem } from "./types";
+
+export class ExtendedCircomVisitor<Result> extends CircomVisitor<Result> {
+  errors: ParserErrorItem[];
+
+  constructor(public templateIdentifier: string) {
+    super();
+
+    this.errors = [];
+  }
+
+  protected addError(message: string, context: ParserRuleContext) {
+    this.errors.push({
+      templateName: this.templateIdentifier,
+      message,
+      line: context.start.line,
+      column: context.start.column,
+      context,
+    });
+  }
+
+  public getErrors(): ParserErrorItem[] {
+    return this.errors;
+  }
+}