feat: add generic and plsql basic parser file

src/parser/common/BasicParser.ts

@@ -0,0 +1,111 @@
+import { Token, Lexer } from 'antlr4';
+import { ParseTreeWalker } from 'antlr4/tree';
+
+import ParserErrorListener, {
+    ParserError,
+    ErrorHandler,
+    ParserErrorCollector,
+} from './parserErrorListener';
+
+/**
+ * Custom Parser class, subclass needs extends it.
+ */
+export default abstract class BasicParser<C = any> {
+    private _parser;
+
+    public parse(
+        input: string,
+        errorListener?: ErrorHandler,
+    ) {
+        const parser = this.createParser(input);
+        this._parser = parser;
+
+        parser.removeErrorListeners();
+        parser.addErrorListener(new ParserErrorListener(errorListener));
+
+        const parserTree = parser.program();
+
+        return parserTree;
+    }
+
+    public validate(input: string): ParserError[] {
+        const lexerError = []; const syntaxErrors = [];
+
+        const parser = this.createParser(input);
+        this._parser = parser;
+
+        parser.removeErrorListeners();
+        parser.addErrorListener(new ParserErrorCollector(syntaxErrors));
+
+        parser.program();
+
+        return lexerError.concat(syntaxErrors);
+    }
+
+    /**
+     * Create antrl4 Lexer object
+     * @param input source string
+     */
+    public abstract createLexer(input: string): Lexer;
+
+    /**
+     * Create Parser by lexer
+     * @param lexer Lexer
+     */
+    public abstract createParserFromLexer(lexer: Lexer);
+
+    /**
+     * Visit parser tree
+     * @param parserTree
+     */
+    // public abstract visit(visitor: any, parserTree: any);
+
+    /**
+     * The source string
+     * @param input string
+     */
+    public getAllTokens(input: string): Token[] {
+        return this.createLexer(input).getAllTokens();
+    };
+
+    /**
+     * Get Parser instance by input string
+     * @param input
+     */
+    public createParser(input: string) {
+        const lexer = this.createLexer(input);
+        const parser: any = this.createParserFromLexer(lexer);
+        parser.buildParseTrees = true;
+        this._parser = parser;
+
+        return parser;
+    }
+
+    /**
+     * It convert tree to string, it's convenient to use in unit test.
+     * @param string input
+     */
+    public parserTreeToString(input: string): string {
+        const parser = this.createParser(input);
+        this._parser = parser;
+
+        const tree = parser.statement();
+        return tree.toStringTree(parser.ruleNames);
+    }
+
+    /**
+     * Get List-like style tree string
+     * @param parserTree
+     */
+    public toString(parserTree: any): string {
+        return parserTree.toStringTree(this._parser.ruleNames);
+    }
+
+    /**
+     * @param listener Listener instance extends ParserListener
+     * @param parserTree parser Tree
+     */
+    public listen(listener: any, parserTree: any) {
+        ParseTreeWalker.DEFAULT.walk(listener, parserTree);
+    }
+}

src/parser/common/parserErrorListener.ts

@@ -0,0 +1,84 @@
+import { Token, Recognizer } from 'antlr4';
+import { ErrorListener } from 'antlr4/error';
+
+export interface ParserError {
+    startLine: number;
+    endLine: number;
+    startCol: number;
+    endCol: number;
+    message: string;
+}
+
+export interface SyntaxError {
+    recognizer: Recognizer;
+    offendingSymbol: Token;
+    line: number;
+    charPositionInLine: number;
+    msg: string;
+    e: any;
+}
+
+export type ErrorHandler = (err: ParserError, errOption: SyntaxError) => void;
+
+export class ParserErrorCollector extends ErrorListener {
+    private _errors: ParserError[];
+
+    constructor(error: ParserError[]) {
+        super();
+        this._errors = error;
+    }
+
+    syntaxError(
+        recognizer: Recognizer, offendingSymbol: Token, line: number,
+        charPositionInLine: number, msg: string, e: any,
+    ) {
+        let endCol = charPositionInLine + 1;
+        if (offendingSymbol &&offendingSymbol.text !== null) {
+            endCol = charPositionInLine + offendingSymbol.text.length;
+        }
+        this._errors.push({
+            startLine: line,
+            endLine: line,
+            startCol: charPositionInLine,
+            endCol: endCol,
+            message: msg,
+        });
+    }
+}
+
+
+export default class ParserErrorListener extends ErrorListener {
+    private _errorHandler;
+
+    constructor(errorListener: ErrorHandler) {
+        super();
+        this._errorHandler = errorListener;
+    }
+
+    syntaxError(
+        recognizer: Recognizer, offendingSymbol: Token, line: number,
+        charPositionInLine: number, msg: string, e: any,
+    ) {
+        let endCol = charPositionInLine + 1;
+        if (offendingSymbol &&offendingSymbol.text !== null) {
+            endCol = charPositionInLine + offendingSymbol.text.length;
+        }
+        if (this._errorHandler) {
+            this._errorHandler({
+                startLine: line,
+                endLine: line,
+                startCol: charPositionInLine,
+                endCol: endCol,
+                message: msg,
+            }, {
+                e,
+                line,
+                msg,
+                recognizer,
+                offendingSymbol,
+                charPositionInLine,
+            });
+        }
+    }
+}
+