Make error listeners configurable

Author: mtriff

package.json

@@ -1,6 +1,6 @@
 {
   "name": "antlr4ts-sql",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Pre-built ANTL4 lexers and parsers for SQL: PostgreSQL, MySQL, SQL Server and Oracle (PL/SQL)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/antlr4tsSQL.ts

@@ -1,4 +1,4 @@
-import { CommonTokenStream, ANTLRInputStream, Parser } from "antlr4ts";
+import { CommonTokenStream, ANTLRInputStream, Parser, ANTLRErrorListener, ConsoleErrorListener, Lexer } from "antlr4ts";
 import { ParseTree } from "antlr4ts/tree/ParseTree";
 import { CaseChangingStream } from "./models/CaseChangingStream";
 import { SQLDialect } from "./models/SQLDialect";
@@ -19,10 +19,10 @@ export class antlr4tsSQL {
     this.dialect = dialect;
   }
 
-  getTokens(sqlScript: string): CommonTokenStream {
+  getTokens(sqlScript: string, errorListeners?: ANTLRErrorListener<any>[]): CommonTokenStream {
     const chars = new ANTLRInputStream(sqlScript);
     const caseChangingCharStream = new CaseChangingStream(chars, true);
-    let lexer = null;
+    let lexer: Lexer = null;
     if (this.dialect === SQLDialect.TSQL) {
       lexer = new TSqlLexer(caseChangingCharStream);
     } else if (this.dialect === SQLDialect.PLSQL) {
@@ -32,12 +32,18 @@ export class antlr4tsSQL {
     } else if (this.dialect === SQLDialect.MYSQL) {
       lexer = new MySQLLexer(chars);
     }
+    if (errorListeners !== null && errorListeners !== undefined) {
+      lexer.removeErrorListener(ConsoleErrorListener.INSTANCE);
+      for (const listener of errorListeners) {
+        lexer.addErrorListener(listener);
+      }
+    }
     const tokens = new CommonTokenStream(lexer);
     return tokens;
   }
 
-  getParser(tokens: CommonTokenStream): Parser {
-    let parser = null;
+  getParser(tokens: CommonTokenStream, errorListeners?: ANTLRErrorListener<any>[]): Parser {
+    let parser: Parser = null;
     if (this.dialect === SQLDialect.TSQL) {
       parser = new TSqlParser(tokens);
     } else if (this.dialect === SQLDialect.PLSQL) {
@@ -47,6 +53,12 @@ export class antlr4tsSQL {
     } else if (this.dialect === SQLDialect.MYSQL) {
       parser = new MultiQueryMySQLParser(tokens);
     }
+    if (errorListeners !== null && errorListeners !== undefined) {
+      parser.removeErrorListener(ConsoleErrorListener.INSTANCE);
+      for (const listener of errorListeners) {
+        parser.addErrorListener(listener);
+      }
+    }
     return parser;
   }
 

test/common.test.ts

@@ -0,0 +1,33 @@
+import { antlr4tsSQL, ConsoleErrorListener, DiagnosticErrorListener, ProxyParserErrorListener, SQLDialect } from '../dist/index';
+
+let antlr4tssql = null;
+beforeAll(() => {
+  antlr4tssql = new antlr4tsSQL(SQLDialect.MYSQL);
+});
+
+test('can customize error listeners', () => {
+  const query = 'SELECT * FROM table1';
+  let tokens = antlr4tssql.getTokens(query);
+  expect(tokens._tokenSource._listeners.length).toBe(1);
+  expect(tokens._tokenSource._listeners[0] instanceof ConsoleErrorListener).toBeTruthy();
+
+  let parser = antlr4tssql.getParser(tokens);
+  expect(parser._listeners.length).toBe(1);
+  expect(parser._listeners[0] instanceof ConsoleErrorListener).toBeTruthy();
+
+  tokens = antlr4tssql.getTokens(query, []);
+  expect(tokens._tokenSource._listeners.length).toBe(0);
+  
+  parser = antlr4tssql.getParser(tokens, []);
+  expect(parser._listeners.length).toBe(0);
+  
+  tokens = antlr4tssql.getTokens(query, [ConsoleErrorListener.INSTANCE, new DiagnosticErrorListener()]);
+  expect(tokens._tokenSource._listeners.length).toBe(2);
+  expect(tokens._tokenSource._listeners[0] instanceof ConsoleErrorListener).toBeTruthy();
+  expect(tokens._tokenSource._listeners[1] instanceof DiagnosticErrorListener).toBeTruthy();
+
+  parser = antlr4tssql.getParser(tokens, [ConsoleErrorListener.INSTANCE, new DiagnosticErrorListener()]);
+  expect(parser._listeners.length).toBe(2);
+  expect(parser._listeners[0] instanceof ConsoleErrorListener).toBeTruthy();
+  expect(parser._listeners[1] instanceof DiagnosticErrorListener).toBeTruthy();
+});