Package org.antlr.tool
Class BuildDependencyGenerator
- java.lang.Object
-
- org.antlr.tool.BuildDependencyGenerator
-
public class BuildDependencyGenerator extends Object
Given a grammar file, show the dependencies on .tokens etc... Using ST, emit a simple "make compatible" list of dependencies. For example, combined grammar T.g (no token import) generates: TParser.java : T.g T.tokens : T.g T__g : T.g For tree grammar TP with import of T.tokens: TP.g : T.tokens TP.java : TP.g If "-lib libdir" is used on command-line with -depend, then include the path like TP.g : libdir/T.tokens Pay attention to -o as well: outputdir/TParser.java : T.g So this output shows what the grammar depends on *and* what it generates. Operate on one grammar file at a time. If given a list of .g on the command-line with -depend, just emit the dependencies. The grammars may depend on each other, but the order doesn't matter. Build tools, reading in this output, will know how to organize it. This is a wee bit slow probably because the code generator has to load all of its template files in order to figure out the file extension for the generated recognizer. This code was obvious until I removed redundant "./" on front of files and had to escape spaces in filenames :(
-
-
Field Summary
Fields Modifier and Type Field Description protected CodeGenerator
generator
protected Grammar
grammar
protected String
grammarFileName
protected org.stringtemplate.v4.STGroup
templates
protected String
tokenVocab
protected Tool
tool
-
Constructor Summary
Constructors Constructor Description BuildDependencyGenerator(Tool tool, String grammarFileName)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.stringtemplate.v4.ST
getDependencies()
List<File>
getDependenciesFileList()
Return a list of File objects that name files ANTLR will read to process T.g; This can be .tokens files if the grammar uses the tokenVocab option as well as any imported grammar files.List<File>
getGeneratedFileList()
From T.g return a list of File objects that name files ANTLR will emit from T.g.CodeGenerator
getGenerator()
List<File>
getNonImportDependenciesFileList()
Return a list of File objects that name files ANTLR will read to process T.g; This can only be .tokens files and only if they use the tokenVocab option.String
getTokenVocab()
String
groomQualifiedFileName(String outputDir, String fileName)
void
loadDependencyTemplates()
-
-
-
Field Detail
-
grammarFileName
protected String grammarFileName
-
tokenVocab
protected String tokenVocab
-
tool
protected Tool tool
-
grammar
protected Grammar grammar
-
generator
protected CodeGenerator generator
-
templates
protected org.stringtemplate.v4.STGroup templates
-
-
Constructor Detail
-
BuildDependencyGenerator
public BuildDependencyGenerator(Tool tool, String grammarFileName) throws IOException
- Throws:
IOException
-
-
Method Detail
-
getGeneratedFileList
public List<File> getGeneratedFileList()
From T.g return a list of File objects that name files ANTLR will emit from T.g.
-
getDependenciesFileList
public List<File> getDependenciesFileList()
Return a list of File objects that name files ANTLR will read to process T.g; This can be .tokens files if the grammar uses the tokenVocab option as well as any imported grammar files.
-
getNonImportDependenciesFileList
public List<File> getNonImportDependenciesFileList()
Return a list of File objects that name files ANTLR will read to process T.g; This can only be .tokens files and only if they use the tokenVocab option.- Returns:
- List of dependencies other than imported grammars
-
getDependencies
public org.stringtemplate.v4.ST getDependencies()
-
loadDependencyTemplates
public void loadDependencyTemplates()
-
getTokenVocab
public String getTokenVocab()
-
getGenerator
public CodeGenerator getGenerator()
-
-