org.antlr.mojo.antlr4

Class Antlr4Mojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.antlr.mojo.antlr4.Antlr4Mojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="antlr4",
      defaultPhase=GENERATE_SOURCES,
      requiresDependencyResolution=COMPILE,
      requiresProject=true)
public class Antlr4Mojo
extends org.apache.maven.plugin.AbstractMojo

Parses ANTLR 4 grammar files *.g4 and transforms them into Java source files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	Antlr4Mojo.CustomTool

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.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.
private org.sonatype.plexus.build.incremental.BuildContext	buildContext
protected java.lang.String	encoding specify grammar file encoding; e.g., euc-jp
protected java.util.Set<java.lang.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 java.util.Set<java.lang.String>	includes Provides an explicit list of all the grammars that should be included in the generate phase of the plugin.
private java.io.File	libDirectory Specify location of imported grammars and tokens files.
protected boolean	listener Generate parse tree listener interface and base class.
protected java.util.Map<java.lang.String,java.lang.String>	options A list of grammar options to explicitly specify to the tool.
private java.io.File	outputDirectory Specify output directory where the Java files are generated.
protected org.apache.maven.project.MavenProject	project The current Maven project.
private java.io.File	sourceDirectory The directory where the ANTLR grammar files (*.g4) are located.
protected 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.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
Antlr4Mojo()

Method Summary

Modifier and Type	Method and Description
(package private) void	addSourceRoot(java.io.File outputDir)
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.
private java.lang.String	findSourceSubdir(java.io.File sourceDirectory, java.lang.String grammarFileName) Given the source directory File object and the full PATH to a grammar, produce the path to the named grammar file in relative terms to the sourceDirectory.
private java.util.List<java.lang.String>	getCommandArguments()
java.util.Set<java.lang.String>	getIncludesPatterns()
java.io.File	getLibDirectory()
java.io.File	getOutputDirectory()
private static java.lang.String	getPackageName(java.lang.String relativeFolderPath)
java.io.File	getSourceDirectory()
private java.util.List<java.util.List<java.lang.String>>	processGrammarFiles(java.util.List<java.lang.String> args, java.io.File sourceDirectory)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

atn

@Parameter(property="antlr4.atn",
           defaultValue="false")
protected boolean atn

If set to true then the ANTLR tool will generate a description of the ATN for each rule in Dot format.

encoding

@Parameter(property="project.build.sourceEncoding")
protected java.lang.String encoding

specify grammar file encoding; e.g., euc-jp

listener

@Parameter(property="antlr4.listener",
           defaultValue="true")
protected boolean listener

Generate parse tree listener interface and base class.

visitor

@Parameter(property="antlr4.visitor",
           defaultValue="false")
protected boolean visitor

Generate parse tree visitor interface and base class.

treatWarningsAsErrors

@Parameter(property="antlr4.treatWarningsAsErrors",
           defaultValue="false")
protected boolean treatWarningsAsErrors

Treat warnings as errors.

forceATN

@Parameter(property="antlr4.forceATN",
           defaultValue="false")
protected boolean forceATN

Use the ATN simulator for all predictions.

options

@Parameter
protected java.util.Map<java.lang.String,java.lang.String> options

A list of grammar options to explicitly specify to the tool. These options are passed to the tool using the -D<option>=<value> syntax.

arguments

@Parameter
protected java.util.List<java.lang.String> arguments

A list of additional command line arguments to pass to the ANTLR tool.

includes

@Parameter
protected java.util.Set<java.lang.String> includes

Provides an explicit list of all the grammars that should be included in the generate phase of the plugin. Note that the plugin is smart enough to realize that imported grammars should be included but not acted upon directly by the ANTLR Tool.

A set of Ant-like inclusion patterns used to select files from the source directory for processing. By default, the pattern **/*.g4 is used to select grammar files.

excludes

@Parameter
protected java.util.Set<java.lang.String> excludes

A set of Ant-like exclusion patterns used to prevent certain files from being processed. By default, this set is empty such that no files are excluded.

project

@Parameter(property="project",
           required=true,
           readonly=true)
protected org.apache.maven.project.MavenProject project

The current Maven project.

sourceDirectory

@Parameter(defaultValue="${basedir}/src/main/antlr4")
private java.io.File sourceDirectory

The directory where the ANTLR grammar files (*.g4) are located.

outputDirectory

@Parameter(defaultValue="${project.build.directory}/generated-sources/antlr4")
private java.io.File outputDirectory

Specify output directory where the Java files are generated.

libDirectory

@Parameter(defaultValue="${basedir}/src/main/antlr4/imports")
private java.io.File libDirectory

Specify location of imported grammars and tokens files.

buildContext

@Component
private org.sonatype.plexus.build.incremental.BuildContext buildContext

tool

protected Tool tool

An instance of the ANTLR tool build

Constructor Detail

Antlr4Mojo

public Antlr4Mojo()

Method Detail

getSourceDirectory

public java.io.File getSourceDirectory()

getOutputDirectory

public java.io.File getOutputDirectory()

getLibDirectory

public java.io.File getLibDirectory()

addSourceRoot

void addSourceRoot(java.io.File outputDir)

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

The main entry point for this Mojo, it is responsible for converting ANTLR 4.x grammars into the target language specified by the grammar.

Throws:

org.apache.maven.plugin.MojoExecutionException - if a configuration or grammar error causes the code generation process to fail

org.apache.maven.plugin.MojoFailureException - if an instance of the ANTLR 4 Tool cannot be created

getCommandArguments

private java.util.List<java.lang.String> getCommandArguments()

processGrammarFiles

private java.util.List<java.util.List<java.lang.String>> processGrammarFiles(java.util.List<java.lang.String> args,
                                                                             java.io.File sourceDirectory)
                                                                      throws org.codehaus.plexus.compiler.util.scan.InclusionScanException

Parameters:

sourceDirectory -

Throws:

org.codehaus.plexus.compiler.util.scan.InclusionScanException

getPackageName

private static java.lang.String getPackageName(java.lang.String relativeFolderPath)

getIncludesPatterns

public java.util.Set<java.lang.String> getIncludesPatterns()

findSourceSubdir

private java.lang.String findSourceSubdir(java.io.File sourceDirectory,
                                          java.lang.String grammarFileName)

Given the source directory File object and the full PATH to a grammar, produce the path to the named grammar file in relative terms to the sourceDirectory. This will then allow ANTLR to produce output relative to the base of the output directory and reflect the input organization of the grammar files.

Parameters:

sourceDirectory - The source directory File object

grammarFileName - The full path to the input grammar file

Returns:

The path to the grammar file relative to the source directory