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="antlr",
      defaultPhase=PROCESS_SOURCES,
      requiresDependencyResolution=COMPILE,
      requiresProject=true)
public class Antlr4Mojo
extends org.apache.maven.plugin.AbstractMojo

Goal that picks up all the ANTLR grammars in a project and moves those that are required for generation of the compilable sources into the location that we use to compile them, such as target/generated-sources/antlr4.

Author:

Sam Harwell

Field Summary

Fields

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 Provides an explicit list of any grammars that should be excluded from the generate phase of the plugin.
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 (default)
protected Map<String,String>	options A list of grammar options to explicitly specify to the tool.
protected org.apache.maven.project.MavenProject	project
protected Tool	tool An instance of the ANTLR tool build
protected boolean	treatWarningsAsErrors treat warnings as errors
protected boolean	visitor generate parse tree visitor

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

ROLE

Constructor Summary

Constructors

Constructor and Description
Antlr4Mojo()

Method Summary

Methods

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()

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
protected String encoding

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

listener

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

generate parse tree listener (default)

visitor

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

generate parse tree visitor

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 Map<String,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 List<String> arguments

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

includes

@Parameter
protected Set<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. Unless otherwise specified, the include list scans for and includes all files that end in ".g" in any directory beneath src/main/antlr4. Note that this version of the plugin looks for the directory antlr4 and not the directory antlr, so as to avoid clashes and confusion for projects that use both v3 and v4 grammars such as ANTLR itself.

excludes

@Parameter
protected Set<String> excludes

Provides an explicit list of any grammars that should be excluded from the generate phase of the plugin. Files listed here will not be sent for processing by the ANTLR tool.

project

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

tool

protected Tool tool

An instance of the ANTLR tool build

Constructor Detail

Antlr4Mojo

public Antlr4Mojo()

Method Detail

getSourceDirectory

public File getSourceDirectory()

getOutputDirectory

public File getOutputDirectory()

getLibDirectory

public File getLibDirectory()

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 - When something is discovered such as a missing source

org.apache.maven.plugin.MojoFailureException - When something really bad happens such as not being able to create the ANTLR Tool

getIncludesPatterns

public Set<String> getIncludesPatterns()