@Mojo(name="antlr4",
defaultPhase=GENERATE_SOURCES,
requiresDependencyResolution=COMPILE,
requiresProject=true)
public class Antlr4Mojo
extends org.apache.maven.plugin.AbstractMojo
*.g4
and transforms them into Java
source files.Modifier and Type | Field and Description |
---|---|
protected List<String> |
arguments
A list of additional command line arguments to pass to the ANTLR tool.
|
protected boolean |
atn
If set to true then the ANTLR tool will generate a description of the ATN
for each rule in Dot format.
|
protected String |
encoding
specify grammar file encoding; e.g., euc-jp
|
protected Set<String> |
excludes
A set of Ant-like exclusion patterns used to prevent certain files from
being processed.
|
protected boolean |
forceATN
Use the ATN simulator for all predictions.
|
protected Set<String> |
includes
Provides an explicit list of all the grammars that should be included in
the generate phase of the plugin.
|
protected boolean |
listener
Generate parse tree listener interface and base class.
|
protected Map<String,String> |
options
A list of grammar options to explicitly specify to the tool.
|
protected org.apache.maven.project.MavenProject |
project
The current Maven project.
|
protected org.antlr.v4.Tool |
tool
An instance of the ANTLR tool build
|
protected boolean |
treatWarningsAsErrors
Treat warnings as errors.
|
protected boolean |
visitor
Generate parse tree visitor interface and base class.
|
Constructor and Description |
---|
Antlr4Mojo() |
Modifier and Type | Method and Description |
---|---|
void |
execute()
The main entry point for this Mojo, it is responsible for converting
ANTLR 4.x grammars into the target language specified by the grammar.
|
Set<String> |
getIncludesPatterns() |
File |
getLibDirectory() |
File |
getOutputDirectory() |
File |
getSourceDirectory() |
@Parameter(property="antlr4.atn", defaultValue="false") protected boolean atn
@Parameter(property="project.build.sourceEncoding") protected String encoding
@Parameter(property="antlr4.listener", defaultValue="true") protected boolean listener
@Parameter(property="antlr4.visitor", defaultValue="false") protected boolean visitor
@Parameter(property="antlr4.treatWarningsAsErrors", defaultValue="false") protected boolean treatWarningsAsErrors
@Parameter(property="antlr4.forceATN", defaultValue="false") protected boolean forceATN
@Parameter protected Map<String,String> options
-D<option>=<value>
syntax.@Parameter protected List<String> arguments
@Parameter protected Set<String> includes
**/*.g4
is used to select grammar files.@Parameter protected Set<String> excludes
@Parameter(property="project", required=true, readonly=true) protected org.apache.maven.project.MavenProject project
protected org.antlr.v4.Tool tool
public File getSourceDirectory()
public File getOutputDirectory()
public File getLibDirectory()
public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
org.apache.maven.plugin.MojoExecutionException
- if a configuration or grammar error causes
the code generation process to failorg.apache.maven.plugin.MojoFailureException
- if an instance of the ANTLR 4 Tool
cannot be createdCopyright © 2009-2014 ANTLR. All Rights Reserved.