public Class Tool

Checks to see if the list of outputFiles all exist, and have last-modified timestamps which are later than the last-modified timestamp of all the grammar files involved in build the output (imports must be checked). If these conditions hold, the method returns false, otherwise, it returns true.

Parameters

grammarFileName:String

The grammar file we are checking

Provide the current setting of the conversion timeout on DFA creation.

Returns:int

DFA creation timeout value in milliseconds

Return a time stamp string accurate to sec: yyyy-mm-dd hh:mm:ss

Return the directory containing the grammar file for this grammar. normally this is a relative path from current directory. People will often do "java org.antlr.Tool grammars/*.g3" So the file will be "grammars/foo.g3" etc... This method returns "grammars". If we have been given a specific input directory as a base, then we must find the directory relative to this directory, unless the file name is given to us in absolute terms.

Provide the List of all grammar file names that the ANTLR tool will process or has processed.

Returns:List<String>

the grammarFileNames

Return a File descriptor for vocab file. Look in library or in -o output path. antlr -o foo T.g U.g where U needs T.tokens won't work unless we look in foo too. If we do not find the file in the lib directory then must assume that the .tokens file is going to be generated as part of this build and we have defined .tokens files so that they ALWAYS are generated in the base output directory, which means the current directory for the command line tool if there was no output directory specified.

Return the Path to the directory in which ANTLR will search for ancillary files such as .tokens vocab files and imported grammar files.

Returns:String

the lib Directory

Name a file from the -lib dir. Imported grammars and .tokens files If we do not locate the file in the library directory, then we try the location of the originating grammar.

Parameters

fileName:String

input name we are looking for

Returns:String

Path to file that we think shuold be the import file

Indicate whether the tool will analyze the dependencies of the provided grammar file list and ensure that grammars with dependencies are built after any of the other gramamrs in the list that they are dependent on. Setting this option also has the side effect that any grammars that are includes for other grammars in the list are excluded from individual analysis, which allows the caller to invoke the tool via org.antlr.tool -make *.g and not worry about the inclusion of grammars that are just includes for other grammars or what order the grammars appear on the command line. This option was coded to make life easier for tool integration (such as Maven) but may also be useful at the command line.

Returns:boolean

true if the tool is currently configured to analyze and sort grammar files.

Returns the current setting of the message format descriptor

Returns:String

Current message format

Returns the number of errors that the analysis/processing threw up.

Returns:int

Error count

Return the location where ANTLR will generate output files for a given file. This is a base directory and output files will be relative to here in some cases such as when -o option is used and input files are given relative to the input directory.

Parameters

fileNameWithPath:String

path to input source

Return the Path to the base output directory, where ANTLR will generate all the output files for the current language target as well as any ancillary files such as .tokens vocab files.

Returns:String

the output Directory

This method is used by all code generators to create new output files. If the outputDir set by -o is not present it will be created. The final filename is sensitive to the output directory and the directory where the grammar file was found. If -o is /tmp and the original grammar file was foo/t.g then output files go in /tmp/foo. The output dir -o spec takes precedence if it's absolute. E.g., if the grammar file dir is absolute the output dir is given precendence. "-o /tmp /usr/lib/t.g" results in "/tmp/T.java" as output (assuming t.g holds T.java). If no -o is specified, then just write to the directory where the grammar file was found. If outputDirectory==null then write a String.

Get a grammar mentioned on the command-line and any delegates

Indicate if ANTLR has generated, or will generate a debug version of the recognizer. Debug versions of a parser communicate with a debugger such as that contained in ANTLRWorks and at start up will 'hang' waiting for a connection on an IP port (49100 by default).

Returns:boolean

the debug flag

Indicates whether ANTLR has supplied, or will supply, a list of all the things that the input grammar depends upon and all the things that will be generated when that grammar is successfully analyzed.

Returns:boolean

the depend flag

Indicates whether ANTLR will force all files to the output directory, even if the input files have relative paths from the input directory.

Returns:boolean

the forceAllFilesToOutputDir flag

Indicates whether ANTLR has generated or will generate a description of all the NFAs in Dot format

Returns:boolean

the generate_DFA_dot

Indicates whether ANTLR has gnerated or will generate a description of all the NFAs in Dot format

Returns:boolean

the generate_NFA_dot

Indicates whether ANTLR has printed, or will print, a version of the input grammar file(s) that is stripped of any action code embedded within.

Returns:boolean

the printGrammar flag

Indicates whether ANTLR has generated or will generate a version of the recognizer that gathers statistics about its execution, which it prints when it terminates.

Returns:boolean

the profile

Indicates whether ANTLR has generated or will generate a report of various elements of the grammar analysis, once it it has finished analyzing a grammar file.

Returns:boolean

the report flag

Indicate whether ANTLR has generated, or will generate a version of the recognizer that prints trace messages on entry and exit of each rule.

Returns:boolean

the trace flag

Indicates whether ANTLR will be verbose when analyzing grammar files, such as displaying the names of the files it is generating and similar information.

Returns:boolean

the verbose flag

A list of dependency generators that are accumulated aaaas (and if) the tool is required to sort the provided grammars into build dependency order. protected Map<String, BuildDependencyGenerator> buildDependencyGenerators;

If the tool needs to panic/exit, how do we do that?

Indicate whether ANTLR should generate a debug version of the recognizer. Debug versions of a parser communicate with a debugger such as that contained in ANTLRWorks and at start up will 'hang' waiting for a connection on an IP port (49100 by default).

Parameters

debug:boolean

true to generate a debug mode parser

Indicate whether ANTLR should supply a list of all the things that the input grammar depends upon and all the things that will be generated when that gramamr is successfully analyzed.

Parameters

depend:boolean

true to get depends set rather than process the grammar

Indicates whether ANTLR will force all files to the output directory, even if the input files have relative paths from the input directory.

Parameters

forceAllFilesToOutputDir:boolean

true to force files to output directory

Used by build tools to force the output files to always be relative to the base output directory, even though the tool had to set the output directory to an absolute path as it cannot rely on the workign directory like command line invocation can.

Parameters

forceRelativeOutput:boolean

true if output files hould always be relative to base output directory

Indicates whether ANTLR should generate a description of all the NFAs in Dot format

Parameters

generate_DFA_dot:boolean

True to generate dot descriptions

Indicate whether ANTLR should generate a description of all the NFAs in Dot format

Parameters

generate_NFA_dot:boolean

True to generate dot descriptions

Provide the List of all grammar file names that the ANTLR tool should process.

Parameters

grammarFileNames:List<String>

The list of grammar files to process

Set the base location of input files. Normally (when the tool is invoked from the command line), the inputDirectory is not set, but for build tools such as Maven, we need to be able to locate the input files relative to the base, as the working directory could be anywhere and changing workig directories is not a valid concept for JVMs because of threading and so on. Setting the directory just means that the getFileDirectory() method will try to open files relative to this input directory.

Parameters

inputDirectory:String

Input source base directory

Set the Path to the directory in which ANTLR will search for ancillary files such as .tokens vocab files and imported grammar files.

Parameters

libDirectory:String

the libDirectory to set

Indicate whether the tool should analyze the dependencies of the provided grammar file list and ensure that the grammars with dependencies are built after any of the other gramamrs in the list that they are dependent on. Setting this option also has the side effect that any grammars that are includes for other grammars in the list are excluded from individual analysis, which allows the caller to invoke the tool via org.antlr.tool -make *.g and not worry about the inclusion of grammars that are just includes for other grammars or what order the grammars appear on the command line. This option was coded to make life easier for tool integration (such as Maven) but may also be useful at the command line.

Set the threshold of case labels beyond which ANTLR will not instruct the target template to generate switch() { case xxx: ...

Parameters

maxSwitchCaseLabels:int

Maximum number of case lables that ANTLR should allow the target code

Set the message format to one of ANTLR, gnu, vs2005

Set the threshold of the number alts, below which ANTLR will not instruct the target template to use a switch statement.

Parameters

minSwitchAlts:int

the minimum number of alts required to use a switch staement

Set the location (base directory) where output files should be produced by the ANTLR tool.

Indicate whether ANTLR should print a version of the input grammar file(s) that is stripped of any action code embedded within.

Parameters

printGrammar:boolean

true to generate a stripped file

Indicate whether ANTLR should generate a version of the recognizer that gathers statistics about its execution, which it prints when it terminates.

Parameters

profile:boolean

true to generate a profiling parser

Indicate whether ANTLR should generate a report of various elements of the grammar analysis, once it it has finished analyzing a grammar file.

Parameters

report:boolean

true to generate the analysis report

Indicate whether ANTLR should generate a version of the recognizer that prints trace messages on entry and exit of each rule

Parameters

trace:boolean

true to generate a tracing parser

Indicate whether ANTLR should be verbose when analyzing grammar files, such as displaying the names of the files it is generating and similar information.

Parameters

verbose:boolean

true to be verbose