Package org.antlr.mojo.antlr3

Class Antlr3Mojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    @Mojo(name="antlr",
      defaultPhase=GENERATE_SOURCES,
      requiresDependencyResolution=COMPILE,
      requiresProject=true,
      threadSafe=true)
public class Antlr3Mojo
extends org.apache.maven.plugin.AbstractMojo
    Parses ANTLR grammar files *.g and transforms them into Java source files.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean debug
      If set to true, then the code generated by the ANTLR code generator will be set to debug mode.
      protected boolean dfa
      If set to true, then the ANTLR tool will generate a description of the DFA for each decision in the grammar in Dot format.
      protected java.util.Set<java.lang.String> excludes
      A set of Ant-like exclusion patterns used to prevent certain files from being processed.
      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
      Location for imported token files, e.g.
      private int maxSwitchCaseLabels
      The maximum number of alternatives allowed in an inline switch statement.
      protected java.lang.String messageFormat
      If this parameter is set, it indicates that any warning or error messages returned by ANLTR, should be formatted in the specified way.
      private int minSwitchAlts
      The minimum number of alternatives for ANTLR to generate a switch statement.
      protected boolean nfa
      If set to true, then the ANTLR tool will generate a description of the NFA for each rule in Dot format
      private java.io.File outputDirectory
      The directory where the parser files generated by ANTLR will be stored.
      protected boolean printGrammar
      If set to true, then the ANTLR tool will print a version of the input grammar(s) which are stripped of any embedded actions.
      protected boolean profile
      If set to true, then the generated parser will compute and report profile information at runtime.
      protected org.apache.maven.project.MavenProject project
      The current Maven project.
      protected boolean report
      If set to true, then after the tool has processed an input grammar file it will report various statistics about the parser, such as information on cyclic DFAs, which rules may use backtracking, and so on.
      private java.io.File sourceDirectory
      The directory where the ANTLR grammar files (*.g) are located.
      protected Tool tool
      An instance of the ANTLR tool build.
      protected boolean trace
      If set to true, the generated parser code will log rule entry and exit points to stdout (System.out for the Java target) as an aid to debugging.
      protected boolean verbose
      If set to true, then ANTLR will report verbose messages during the code generation process.

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

        ROLE

    • Constructor Summary

      Constructors 
      Constructor Description
      Antlr3Mojo()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      (package private) void addSourceRoot​(java.io.File outputDir)  
      void execute()
      The main entry point for this Mojo, it is responsible for converting ANTLR 3.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.
      java.util.Set<java.lang.String> getIncludesPatterns()  
      java.io.File getLibDirectory()  
      java.io.File getOutputDirectory()  
      java.io.File getSourceDirectory()  
      private void processGrammarFiles​(java.io.File sourceDirectory, java.io.File outputDirectory)  

      • 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

      • report

        @Parameter(property="report",
           defaultValue="false")
protected boolean report
        If set to true, then after the tool has processed an input grammar file it will report various statistics about the parser, such as information on cyclic DFAs, which rules may use backtracking, and so on.

      • printGrammar

        @Parameter(property="printGrammar",
           defaultValue="false")
protected boolean printGrammar
        If set to true, then the ANTLR tool will print a version of the input grammar(s) which are stripped of any embedded actions.

      • debug

        @Parameter(property="debug",
           defaultValue="false")
protected boolean debug
        If set to true, then the code generated by the ANTLR code generator will be set to debug mode. This means that when run, the code will 'hang' and wait for a debug connection on a TCP port (49100 by default).

      • profile

        @Parameter(property="profile",
           defaultValue="false")
protected boolean profile
        If set to true, then the generated parser will compute and report profile information at runtime.

      • nfa

        @Parameter(property="nfa",
           defaultValue="false")
protected boolean nfa
        If set to true, then the ANTLR tool will generate a description of the NFA for each rule in Dot format

      • dfa

        @Parameter(property="dfa",
           defaultValue="false")
protected boolean dfa
        If set to true, then the ANTLR tool will generate a description of the DFA for each decision in the grammar in Dot format.

      • trace

        @Parameter(property="trace",
           defaultValue="false")
protected boolean trace
        If set to true, the generated parser code will log rule entry and exit points to stdout (System.out for the Java target) as an aid to debugging.

      • messageFormat

        @Parameter(property="messageFormat",
           defaultValue="antlr")
protected java.lang.String messageFormat
        If this parameter is set, it indicates that any warning or error messages returned by ANLTR, should be formatted in the specified way. Currently, ANTLR supports the built-in formats antlr, gnu and vs2005.

      • verbose

        @Parameter(property="verbose",
           defaultValue="true")
protected boolean verbose
        If set to true, then ANTLR will report verbose messages during the code generation process. This includes the names of files, the version of ANTLR, and more.

      • maxSwitchCaseLabels

        @Parameter(property="maxSwitchCaseLabels",
           defaultValue="300")
private int maxSwitchCaseLabels
        The maximum number of alternatives allowed in an inline switch statement. Beyond this, ANTLR will not generate a switch statement for the DFA.

      • minSwitchAlts

        @Parameter(property="minSwitchAlts",
           defaultValue="3")
private int minSwitchAlts
        The minimum number of alternatives for ANTLR to generate a switch statement. For decisions with fewer alternatives, an if/else if/else statement will be used instead.

      • 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 **/*.g 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/antlr3")
private java.io.File sourceDirectory
        The directory where the ANTLR grammar files (*.g) are located.

      • outputDirectory

        @Parameter(defaultValue="${project.build.directory}/generated-sources/antlr3",
           required=true)
private java.io.File outputDirectory
        The directory where the parser files generated by ANTLR will be stored. The directory will be registered as a compile source root of the project such that the generated files will participate in later build phases like compiling and packaging.

      • libDirectory

        @Parameter(defaultValue="${basedir}/src/main/antlr3/imports")
private java.io.File libDirectory
        Location for imported token files, e.g. *.tokens and imported grammars. Note that ANTLR will not try to process grammars that it finds to be imported into other grammars (in the same processing session).

      • tool

        protected Tool tool
        An instance of the ANTLR tool build.

    • Constructor Detail

      • Antlr3Mojo

        public Antlr3Mojo()

    • 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 3.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 3 Tool cannot be created

      • processGrammarFiles

        private void processGrammarFiles​(java.io.File sourceDirectory,
                                 java.io.File outputDirectory)
                          throws java.io.IOException,
                                 org.codehaus.plexus.compiler.util.scan.InclusionScanException
        Parameters:
        sourceDirectory -
        outputDirectory -
        Throws:
        java.io.IOException
        org.codehaus.plexus.compiler.util.scan.InclusionScanException

      • 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