Top Description Fields Constructors Methods
org.antlr.tool

public Class BuildDependencyGenerator

extends Object
Class Inheritance
Imports
org.antlr.Tool, org.antlr.codegen.CodeGenerator, org.antlr.misc.Utils, org.stringtemplate.v4.ST, .STGroup, java.io.*, java.util.ArrayList, .List

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

Modifier and TypeField and Description
protected CodeGenerator
protected Grammar
protected String
protected STGroup
protected String
protected Tool

Constructor Summary

AccessConstructor and Description
public
BuildDependencyGenerator(Tool tool, String grammarFileName)

Method Summary

Modifier and TypeMethod and Description
public ST
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.

public List<File>
getGeneratedFileList()

From T.g return a list of File objects that name files ANTLR will emit from T.g.

public CodeGenerator
public List<File>

Returns:

List of dependencies other than imported grammars
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.

public String
public String
groomQualifiedFileName(String outputDir, String fileName)

public void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

generatorback to summary
protected CodeGenerator generator
grammarback to summary
protected Grammar grammar
grammarFileNameback to summary
protected String grammarFileName
templatesback to summary
protected STGroup templates
tokenVocabback to summary
protected String tokenVocab
toolback to summary
protected Tool tool

Constructor Detail

BuildDependencyGeneratorback to summary
public BuildDependencyGenerator(Tool tool, String grammarFileName) throws IOException

Method Detail

getDependenciesback to summary
public ST getDependencies()
getDependenciesFileListback to summary
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.

getGeneratedFileListback to summary
public List<File> getGeneratedFileList()

From T.g return a list of File objects that name files ANTLR will emit from T.g.

getGeneratorback to summary
public CodeGenerator getGenerator()
getNonImportDependenciesFileListback to summary
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<File>

List of dependencies other than imported grammars

getTokenVocabback to summary
public String getTokenVocab()
groomQualifiedFileNameback to summary
public String groomQualifiedFileName(String outputDir, String fileName)
loadDependencyTemplatesback to summary
public void loadDependencyTemplates()