javacc:jjtree-javacc

Full name:

org.codehaus.mojo:javacc-maven-plugin:2.5:jjtree-javacc

Description:

Preprocesses decorated grammar files (*.jjt) with JJTree and passes the output to JavaCC in order to finally generate a parser with parse tree actions.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Since version: 2.4.
  • Binds by default to the lifecycle phase: generate-sources.

Optional Parameters

Name Type Since Description
buildNodeFiles Boolean 2.4 A flag whether to generate sample implementations for SimpleNode and any other nodes used in the grammar. Default value is true.
buildParser Boolean 2.4 A flag that controls whether the parser file (*Parser.java) should be generated or not. If set to false, only the token manager is generated. Default value is true.
buildTokenManager Boolean 2.4 A flag that controls whether the token manager file (*TokenManager.java) should be generated or not. Setting this to false can speed up the generation process if only the parser part of the grammar changed. Default value is true.
cacheTokens Boolean 2.4 Setting this option to true causes the generated parser to lookahead for extra tokens ahead of time. Default value is false.
choiceAmbiguityCheck Integer 2.4 This is the number of tokens considered in checking choices of the form "A | B | ..." for ambiguity. Default value is 2.
commonTokenAction Boolean 2.4 When set to true, every call to the token manager's method getNextToken() (see the description of the Java Compiler Compiler API) will cause a call to a user-defined method CommonTokenAction() after the token has been scanned in by the token manager. Default value is false.
debugLookAhead Boolean 2.4 This is a boolean option whose default value is false. Setting this option to true causes the parser to generate all the tracing information it does when the option debugParser is true, and in addition, also causes it to generated a trace of actions performed during lookahead operation.
debugParser Boolean 2.4 This option is used to obtain debugging information from the generated parser. Setting this option to true causes the parser to generate a trace of its actions. Default value is false.
debugTokenManager Boolean 2.4 This option is used to obtain debugging information from the generated token manager. Default value is false.
errorReporting Boolean 2.4 Setting it to false causes errors due to parse errors to be reported in somewhat less detail. Default value is true.
excludes String[] 2.4 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.
forceLaCheck Boolean 2.4 This option setting controls lookahead ambiguity checking performed by JavaCC. Default value is false.
ignoreCase Boolean 2.4 Setting this option to true causes the generated token manager to ignore case in the token specifications and the input files. Default value is false.
includes String[] 2.4 A set of Ant-like inclusion patterns used to select files from the source directory for processing. By default, the patterns **/*.jj, **/*.JJ, **/*.jjt and **/*.JJT are used to select grammar files.
interimDirectory File 2.4 The directory where the AST node files generated by JJTree 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. Default value is: ${project.build.directory}/generated-sources/jjtree.
isStatic Boolean 2.4 If true, all methods and class variables are specified as static in the generated parser and token manager. This allows only one parser object to be present, but it improves the performance of the parser. Default value is true.
javaUnicodeEscape Boolean 2.4 When set to true, the generated parser uses an input stream object that processes Java Unicode escapes (\uxxxx) before sending characters to the token manager. Default value is false.
jdkVersion String 2.4 The Java version for which to generate source code. Default value is 1.4.
keepLineColumn Boolean 2.4 A flag whether to keep line and column information along with a token. Default value is true.
lookAhead Integer 2.4 The number of tokens to look ahead before making a decision at a choice point during parsing. The default value is 1.
multi Boolean 2.4 A flag whether to generate a multi mode parse tree or a single mode parse tree. Default value is false.
nodeClass String 2.5 The name of a custom class that extends SimpleNode and will be used as the super class for the generated tree node classes. By default, the tree node classes will directly extend the class SimpleNode.
nodeDefaultVoid Boolean 2.4 A flag whether to make each non-decorated production void instead of an indefinite node. Default value is false.
nodeFactory String 2.4 The name of a custom factory class used to create Node objects. This class must have a method with the signature public static Node jjtCreate(int id). By default, the class SimpleNode will be used as the factory class.
nodePackage String 2.4 The package to generate the AST node classes into. This value may use a leading asterisk to reference the package of the corresponding parser. For example, if the parser package is org.apache and this parameter is set to *.node, the tree node classes will be located in the package org.apache.node. By default, the package of the corresponding parser is used.
nodePrefix String 2.4 The prefix used to construct node class names from node identifiers in multi mode. Default value is AST.
nodeScopeHook Boolean 2.4 A flag whether user-defined parser methods should be called on entry and exit of every node scope. Default value is false.
nodeUsesParser Boolean 2.4 A flag whether the node construction routines need an additional method parameter to receive the parser object. Default value is false.
otherAmbiguityCheck Integer 2.4 This is the number of tokens considered in checking all other kinds of choices (i.e., of the forms "(A)*", "(A)+", and "(A)?") for ambiguity. Default value is 1.
outputDirectory File 2.4 The directory where the parser files generated by JavaCC 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. Default value is: ${project.build.directory}/generated-sources/javacc.
sanityCheck Boolean 2.4 Enables/disables many syntactic and semantic checks on the grammar file during parser generation. Default value is true.
sourceDirectory File 2.4 The directory where the decorated JavaCC grammar files (*.jjt) are located. It will be recursively scanned for input files to pass to JJTree. The parameters includes and excludes can be used to select a subset of files. Default value is: ${basedir}/src/main/jjtree.
staleMillis int 2.4 The granularity in milliseconds of the last modification date for testing whether a grammar file needs recompilation. Default value is: 0.
tokenExtends String 2.5 The name of the base class for the generated Token class. Default value is java.lang.Object.
tokenFactory String 2.5 The name of a custom factory class used to create Token objects. This class must have a method with the signature public static Token newToken(int ofKind, String image). By default, tokens are created by calling Token.newToken().
tokenManagerUsesParser Boolean 2.4 When set to true, the generated token manager will include a field called parser that references the instantiating parser instance. Default value is false.
trackTokens Boolean 2.5 A flag whether to insert the methods jjtGetFirstToken(), jjtSetFirstToken(), getLastToken() and jjtSetLastToken() into the class SimpleNode. Default value is false.
unicodeInput Boolean 2.4 When set to true, the generated parser uses uses an input stream object that reads Unicode files. By default, ASCII files are assumed. Default value is false.
userCharStream Boolean 2.4 This flag controls whether the token manager will read characters from a character stream reader as defined by the options javaUnicodeEscape and unicodeInput or whether the token manager reads from a user-supplied implementation of CharStream. Default value is false.
userTokenManager Boolean 2.4 The default action is to generate a token manager that works on the specified grammar tokens. If this option is set to true, then the parser is generated to accept tokens from any token manager of type TokenManager - this interface is generated into the generated parser directory. Default value is false.
visitor Boolean 2.4 A flag whether to insert a jjtAccept() method in the node classes and to generate a visitor implementation with an entry for every node type used in the grammar. Default value is false.
visitorDataType String 2.5 The name of a class to use for the data argument of the jjtAccept() and visit() methods. Default value is java.lang.Object.
visitorException String 2.4 The name of an exception class to include in the signature of the generated jjtAccept() and visit() methods. By default, the throws clause of the generated methods is empty such that only unchecked exceptions can be thrown.
visitorReturnType String 2.5 The name of a class to use as the return type of the jjtAccept() and visit() methods. Default value is java.lang.Object.

Parameter Details

buildNodeFiles:

A flag whether to generate sample implementations for SimpleNode and any other nodes used in the grammar. Default value is true.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${buildNodeFiles}

buildParser:

A flag that controls whether the parser file (*Parser.java) should be generated or not. If set to false, only the token manager is generated. Default value is true.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${buildParser}

buildTokenManager:

A flag that controls whether the token manager file (*TokenManager.java) should be generated or not. Setting this to false can speed up the generation process if only the parser part of the grammar changed. Default value is true.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${buildTokenManager}

cacheTokens:

Setting this option to true causes the generated parser to lookahead for extra tokens ahead of time. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${cacheTokens}

choiceAmbiguityCheck:

This is the number of tokens considered in checking choices of the form "A | B | ..." for ambiguity. Default value is 2.
  • Type: java.lang.Integer
  • Since: 2.4
  • Required: No
  • Expression: ${choiceAmbiguityCheck}

commonTokenAction:

When set to true, every call to the token manager's method getNextToken() (see the description of the Java Compiler Compiler API) will cause a call to a user-defined method CommonTokenAction() after the token has been scanned in by the token manager. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${commonTokenAction}

debugLookAhead:

This is a boolean option whose default value is false. Setting this option to true causes the parser to generate all the tracing information it does when the option debugParser is true, and in addition, also causes it to generated a trace of actions performed during lookahead operation.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${debugLookAhead}

debugParser:

This option is used to obtain debugging information from the generated parser. Setting this option to true causes the parser to generate a trace of its actions. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${debugParser}

debugTokenManager:

This option is used to obtain debugging information from the generated token manager. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${debugTokenManager}

errorReporting:

Setting it to false causes errors due to parse errors to be reported in somewhat less detail. Default value is true.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${errorReporting}

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.
  • Type: java.lang.String[]
  • Since: 2.4
  • Required: No

forceLaCheck:

This option setting controls lookahead ambiguity checking performed by JavaCC. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${forceLaCheck}

ignoreCase:

Setting this option to true causes the generated token manager to ignore case in the token specifications and the input files. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${ignoreCase}

includes:

A set of Ant-like inclusion patterns used to select files from the source directory for processing. By default, the patterns **/*.jj, **/*.JJ, **/*.jjt and **/*.JJT are used to select grammar files.
  • Type: java.lang.String[]
  • Since: 2.4
  • Required: No

interimDirectory:

The directory where the AST node files generated by JJTree 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.
  • Type: java.io.File
  • Since: 2.4
  • Required: No
  • Expression: ${interimDirectory}
  • Default: ${project.build.directory}/generated-sources/jjtree

isStatic:

If true, all methods and class variables are specified as static in the generated parser and token manager. This allows only one parser object to be present, but it improves the performance of the parser. Default value is true.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${isStatic}

javaUnicodeEscape:

When set to true, the generated parser uses an input stream object that processes Java Unicode escapes (\uxxxx) before sending characters to the token manager. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${javaUnicodeEscape}

jdkVersion:

The Java version for which to generate source code. Default value is 1.4.
  • Type: java.lang.String
  • Since: 2.4
  • Required: No
  • Expression: ${jdkVersion}

keepLineColumn:

A flag whether to keep line and column information along with a token. Default value is true.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${keepLineColumn}

lookAhead:

The number of tokens to look ahead before making a decision at a choice point during parsing. The default value is 1.
  • Type: java.lang.Integer
  • Since: 2.4
  • Required: No
  • Expression: ${lookAhead}

multi:

A flag whether to generate a multi mode parse tree or a single mode parse tree. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${multi}

nodeClass:

The name of a custom class that extends SimpleNode and will be used as the super class for the generated tree node classes. By default, the tree node classes will directly extend the class SimpleNode.
  • Type: java.lang.String
  • Since: 2.5
  • Required: No
  • Expression: ${nodeClass}

nodeDefaultVoid:

A flag whether to make each non-decorated production void instead of an indefinite node. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${nodeDefaultVoid}

nodeFactory:

The name of a custom factory class used to create Node objects. This class must have a method with the signature public static Node jjtCreate(int id). By default, the class SimpleNode will be used as the factory class.
  • Type: java.lang.String
  • Since: 2.4
  • Required: No
  • Expression: ${nodeFactory}

nodePackage:

The package to generate the AST node classes into. This value may use a leading asterisk to reference the package of the corresponding parser. For example, if the parser package is org.apache and this parameter is set to *.node, the tree node classes will be located in the package org.apache.node. By default, the package of the corresponding parser is used.
  • Type: java.lang.String
  • Since: 2.4
  • Required: No
  • Expression: ${nodePackage}

nodePrefix:

The prefix used to construct node class names from node identifiers in multi mode. Default value is AST.
  • Type: java.lang.String
  • Since: 2.4
  • Required: No
  • Expression: ${nodePrefix}

nodeScopeHook:

A flag whether user-defined parser methods should be called on entry and exit of every node scope. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${nodeScopeHook}

nodeUsesParser:

A flag whether the node construction routines need an additional method parameter to receive the parser object. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${nodeUsesParser}

otherAmbiguityCheck:

This is the number of tokens considered in checking all other kinds of choices (i.e., of the forms "(A)*", "(A)+", and "(A)?") for ambiguity. Default value is 1.
  • Type: java.lang.Integer
  • Since: 2.4
  • Required: No
  • Expression: ${otherAmbiguityCheck}

outputDirectory:

The directory where the parser files generated by JavaCC 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.
  • Type: java.io.File
  • Since: 2.4
  • Required: No
  • Expression: ${outputDirectory}
  • Default: ${project.build.directory}/generated-sources/javacc

sanityCheck:

Enables/disables many syntactic and semantic checks on the grammar file during parser generation. Default value is true.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${sanityCheck}

sourceDirectory:

The directory where the decorated JavaCC grammar files (*.jjt) are located. It will be recursively scanned for input files to pass to JJTree. The parameters includes and excludes can be used to select a subset of files.
  • Type: java.io.File
  • Since: 2.4
  • Required: No
  • Expression: ${sourceDirectory}
  • Default: ${basedir}/src/main/jjtree

staleMillis:

The granularity in milliseconds of the last modification date for testing whether a grammar file needs recompilation.
  • Type: int
  • Since: 2.4
  • Required: No
  • Expression: ${lastModGranularityMs}
  • Default: 0

tokenExtends:

The name of the base class for the generated Token class. Default value is java.lang.Object.
  • Type: java.lang.String
  • Since: 2.5
  • Required: No
  • Expression: ${tokenExtends}

tokenFactory:

The name of a custom factory class used to create Token objects. This class must have a method with the signature public static Token newToken(int ofKind, String image). By default, tokens are created by calling Token.newToken().
  • Type: java.lang.String
  • Since: 2.5
  • Required: No
  • Expression: ${tokenFactory}

tokenManagerUsesParser:

When set to true, the generated token manager will include a field called parser that references the instantiating parser instance. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${tokenManagerUsesParser}

trackTokens:

A flag whether to insert the methods jjtGetFirstToken(), jjtSetFirstToken(), getLastToken() and jjtSetLastToken() into the class SimpleNode. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.5
  • Required: No
  • Expression: ${trackTokens}

unicodeInput:

When set to true, the generated parser uses uses an input stream object that reads Unicode files. By default, ASCII files are assumed. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${unicodeInput}

userCharStream:

This flag controls whether the token manager will read characters from a character stream reader as defined by the options javaUnicodeEscape and unicodeInput or whether the token manager reads from a user-supplied implementation of CharStream. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${userCharStream}

userTokenManager:

The default action is to generate a token manager that works on the specified grammar tokens. If this option is set to true, then the parser is generated to accept tokens from any token manager of type TokenManager - this interface is generated into the generated parser directory. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${userTokenManager}

visitor:

A flag whether to insert a jjtAccept() method in the node classes and to generate a visitor implementation with an entry for every node type used in the grammar. Default value is false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${visitor}

visitorDataType:

The name of a class to use for the data argument of the jjtAccept() and visit() methods. Default value is java.lang.Object.
  • Type: java.lang.String
  • Since: 2.5
  • Required: No
  • Expression: ${visitorDataType}

visitorException:

The name of an exception class to include in the signature of the generated jjtAccept() and visit() methods. By default, the throws clause of the generated methods is empty such that only unchecked exceptions can be thrown.
  • Type: java.lang.String
  • Since: 2.4
  • Required: No
  • Expression: ${visitorException}

visitorReturnType:

The name of a class to use as the return type of the jjtAccept() and visit() methods. Default value is java.lang.Object.
  • Type: java.lang.String
  • Since: 2.5
  • Required: No
  • Expression: ${visitorReturnType}