Install escript-antlr4 and antlr4ts as dependencies using your preferred
package manager.
npm install escript-antlr4 antlr4ts --save
yarn add escript-antlr4 antlr4ts
Use your grammar in TypeScript (or JavaScript)
import { EscriptLexer, EscriptParser } from 'escript-antlr4';import { ANTLRInputStream, CommonTokenStream } from 'antlr4ts';const program = `program main(arg0, arg1) Print(arg0);endprogramfunction f1() endfunctionfunction f2() endfunction`;const inputStream = new ANTLRInputStream(program);const lexer = new EscriptLexer(inputStream);const tokenStream = new CommonTokenStream(lexer);const parser = new EscriptParser(tokenStream);/** * Parse the input: * - A source file (.src or .inc) has entry point `compilationUnit`. * - A module file (.em) has entry point `moduleUnit()`. */const tree = parser.compilationUnit();
The two main ways to inspect the tree are by using a listener or a visitor, you
can read about the differences between the two
here.
Listener Approach
// ...import { EscriptParserListener, ProgramDeclarationContext } from 'escript-antlr4';import { ParseTreeWalker } from 'antlr4ts/tree';class EnterProgramListener implements EscriptParserListener { enterProgramDeclaration(context: ProgramDeclarationContext) { console.log(`Program name: ${context.IDENTIFIER().text}`); // ... } // other enterX functions...}// Create the listenerconst listener: EscriptParserListener = new EnterProgramListener();// Use the entry point for listenersParseTreeWalker.DEFAULT.walk(listener, tree);
Visitor Approach
// ...import { EscriptParserVisitor, FunctionDeclarationContext } from 'escript-antlr4';import { AbstractParseTreeVisitor } from 'antlr4ts/tree';// Extend the AbstractParseTreeVisitor to get default visitor behaviourclass CountElementsVisitor extends AbstractParseTreeVisitor<number> implements EscriptParserVisitor<number> { defaultResult() { return 0; } aggregateResult(aggregate: number, nextResult: number) { return aggregate + nextResult; } visitFunctionDeclaration(context: FunctionDeclarationContext): number
{
return 1 + super.visitChildren(context);
}
}
// Create the visitor
const countElementsVisitor = new CountElementsVisitor();
// Use the visitor entry point
const count = countElementsVisitor.visit(tree);
console.log(`There are ${count} function declarations`);