org.snt.inmemantlr.tool

Class InmemantlrTool

java.lang.Object

org.antlr.v4.Tool

org.snt.inmemantlr.tool.InmemantlrTool

public class InmemantlrTool
extends org.antlr.v4.Tool

special tool class that implements in-memory operations for the original antlr tool

Nested Class Summary

Nested classes/interfaces inherited from class org.antlr.v4.Tool

org.antlr.v4.Tool.Option, org.antlr.v4.Tool.OptionArgType

Field Summary

Fields inherited from class org.antlr.v4.Tool

ALL_GRAMMAR_EXTENSIONS, args, errMgr, force_atn, gen_dependencies, gen_listener, gen_visitor, generate_ATN_dot, genPackage, GRAMMAR_EXTENSION, grammarEncoding, grammarFiles, grammarOptions, haveOutputDir, inputDirectory, internalOption_PrintGrammarTree, internalOption_ShowATNConfigsInDFA, launch_ST_inspector, LEGACY_GRAMMAR_EXTENSION, libDirectory, log, logMgr, longMessages, msgFormat, optionDefs, outputDirectory, return_dont_exit, ST_inspector_wait_for_close, VERSION, warnings_are_errors

Constructor Summary

Constructors

Constructor and Description
InmemantlrTool()

Method Summary

Modifier and Type	Method and Description
org.antlr.v4.tool.Grammar	createGrammar(org.antlr.v4.tool.ast.GrammarRootAST ast)
StringCodeGenPipeline	createPipeline(org.antlr.v4.tool.ast.GrammarRootAST ast) create code generation pipeline from grammar ast
Set<StringCodeGenPipeline>	getCompilationUnits() get compilation units, i.e.
String	getDepTokVocName(org.antlr.v4.tool.Grammar g) return name of token vocab if imported by grammar g
String	getPackagePrefix() return package prefix if configured by user
Set<StringCodeGenPipeline>	getPipelines() get string code generation pipelines in-order (based on imported token vocab)
boolean	isImported(String name) check whether grammar is imported
org.antlr.v4.tool.Grammar	loadImportedGrammar(org.antlr.v4.tool.Grammar g, org.antlr.v4.tool.ast.GrammarAST nameNode)
Tuple<String,String>	process() process all code generation pipeline and return the 'main' grammar and lexer names which are used to load the right classes afterwards
void	process(org.antlr.v4.tool.Grammar g) process a grammar
Set<org.antlr.v4.tool.ast.GrammarRootAST>	sortGrammarByTokenVocab(Set<String> gcs) wrapper for sorting grammars based on the imported token vocab

Methods inherited from class org.antlr.v4.Tool

addListener, checkForRuleIssues, error, exit, findOptionValueAST, generateATNs, getImportedGrammarFile, getListeners, getNumErrors, getOutputDirectory, getOutputFileWriter, handleArgs, handleOptionSetArg, help, info, loadGrammar, log, log, main, panic, parse, parseGrammar, parseGrammarFromString, process, processGrammarsOnCommandLine, processNonCombinedGrammar, removeListener, removeListeners, sortGrammarByTokenVocab, version, warning, writeDOTFile, writeDOTFile

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InmemantlrTool

public InmemantlrTool()

Method Detail

process

public void process(org.antlr.v4.tool.Grammar g)

process a grammar

Parameters:

g - grammar

createGrammar

public org.antlr.v4.tool.Grammar createGrammar(org.antlr.v4.tool.ast.GrammarRootAST ast)

Overrides:

createGrammar in class org.antlr.v4.Tool

sortGrammarByTokenVocab

public Set<org.antlr.v4.tool.ast.GrammarRootAST> sortGrammarByTokenVocab(Set<String> gcs)

wrapper for sorting grammars based on the imported token vocab

Parameters:

gcs - grammar content collection

Returns:

set of grammar asts

loadImportedGrammar

public org.antlr.v4.tool.Grammar loadImportedGrammar(org.antlr.v4.tool.Grammar g,
                                                     org.antlr.v4.tool.ast.GrammarAST nameNode)
                                              throws IOException

Overrides:

loadImportedGrammar in class org.antlr.v4.Tool

Throws:

IOException

getPackagePrefix

public String getPackagePrefix()

return package prefix if configured by user

Returns:

package prefix

createPipeline

public StringCodeGenPipeline createPipeline(org.antlr.v4.tool.ast.GrammarRootAST ast)

create code generation pipeline from grammar ast

Parameters:

ast - grammar ast

Returns:

string code generation pipeline

getPipelines

public Set<StringCodeGenPipeline> getPipelines()

get string code generation pipelines in-order (based on imported token vocab)

Returns:

ordered set of string code gen pipelines

isImported

public boolean isImported(String name)

check whether grammar is imported

Parameters:

name - grammar name

Returns:

true if grammar is imported, false otherwise

process

public Tuple<String,String> process()

process all code generation pipeline and return the 'main' grammar and lexer names which are used to load the right classes afterwards

Returns:

tuple of lexer and parser names

getDepTokVocName

public String getDepTokVocName(org.antlr.v4.tool.Grammar g)

return name of token vocab if imported by grammar g

Parameters:

g - grammar

Returns:

name of token vocab

getCompilationUnits

public Set<StringCodeGenPipeline> getCompilationUnits()

get compilation units, i.e. all string code generation pipelines that are not imported

Returns:

ordered set of string code pipelines