javacc:jjtree-javacc
Full name:
org.javacc.plugin:javacc-maven-plugin:3.8.0-SNAPSHOT:jjtree-javacc
Description:
The jjtree-javacc goal, for generating the tree and the parser files from a JJTree grammar.
It searches the source directory for all grammar files and run JJTree and JavaCC once for each file it finds, managing the output directory from the user setting or the default setting, and adding it to the project-wide compile source roots.
It uses an intermediate output directory for each processor to help discard any generated file when the user wants instead his customized version he has put in any compile source root.
Detailed information about the JJTree and JavaCC options can be found on the JavaCC website.
The code repositories can be found within JavaCC at GitHub.
Attributes:
- Requires a Maven project to be executed.
- The goal is thread-safe and supports parallel builds.
- Since version:
3.8.0. - Binds by default to the lifecycle phase:
generate-sources.
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<excludes> |
String[] |
- |
The 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. |
<failOnGrammarError> |
String |
- |
The fail on grammar error parameter.
It governs how the plugin will handle the errors it encountered while trying to read a grammar file to retrieve the parser name (and the parser package for languages that use it) (in an execution the plugin may process zero, one or many grammars). Possible values are first, last and ignore.
If set to first, the error message is displayed, the plugin will stop processing other grammars and will report an error for the build;
if set to last, the error message is displayed, the plugin will continue processing other grammars and at the end it will report an error for the build;
if set to ignore the error message(s) is(are) displayed but the plugin will not report an error for the current execution (i.e. it will continue with the next execution).Default: firstUser Property: javacc.failOnGrammarError |
<failOnPluginError> |
Boolean |
- |
The fail on plugin error flag.
It governs how the plugin will handle the errors it encountered on general configuration (i.e. parameters not related to grammars). Possible values are true and false.
On the first error: if set to false, the error message is displayed but the plugin will not report an error for the current execution (i.e. it will continue with the next execution);
if set to true the error message is displayed and the plugin will report an error for the build.Default: trueUser Property: javacc.failOnPluginError |
<failOnProcessorError> |
String |
- |
The fail on processor error parameter.
It governs how the plugin will handle the errors returned by the processor invocations and the plugin post-processor copy operations (in an execution the plugin may process zero, one or many grammars and invoke one or more processors for each). Possible values are first, last and ignore.
If set to first, the error message is displayed, the plugin will stop processing other grammars and will report an error for the build;
if set to last, the error message is displayed, the plugin will continue processing other grammars and at the end it will report an error for the build;
if set to ignore the error message(s) is(are) displayed but the plugin will not report an error for the current execution (i.e. it will continue with the next execution).Default: firstUser Property: javacc.failOnProcessorError |
<includes> |
String[] |
- |
The set of Ant-like inclusion patterns used to select files from the source directory for processing.
By default, the patterns are: **/*.jj for the javacc goal,
**/*.jjt for the jjtree and jjtree-javacc goals,
**/*.jtb for the jtb and jtb-javacc goals. |
<javaccCmdLineArgs> |
List<String> |
- |
See also: JavaCCGoalMojo.javaccCmdLineArgs User Property: javacc.javaccCmdLineArgs |
<jjtreeCmdLineArgs> |
List<String> |
- |
See also: JJTreeGoalMojo.jjtreeCmdLineArgs User Property: javacc.jjtreeCmdLineArgs |
<keepIntermediateDirectory> |
Boolean |
- |
The keep the intermediate directory(ies) flag.
If set to true, the intermediate directory(ies) will not be deleted, which may sometimes be handy for plugin or processor debug purposes. Default: falseUser Property: javacc.keepIntermediateDirectory |
<skip> |
Boolean |
- |
The skip processing flag.
If true, no goal will not be executed. Default: falseUser Property: javacc.skip |
<sourceDirectory> |
File |
- |
The directory where the grammar files are located.
It must exist and be a directory, otherwise a plugin error will be raised. This directory will be recursively scanned for input files to pass to JavaCC. If one wants a pom to process more than one source directory, he must configure multiple executions with different source directories. Note: we could have implemented a list of source directories (as in AbstractPluginReport, but most of the time different source directories will need different configurations, so the user would still have to configure multiple executions.
The parameters includes and excludes can be used to select a subset of the files.
If not an absolute path, maven internals considers it is relative to ${basedir} and converts it accordingly to an absolute path (i.e. src/main/javacc will be considered as ${basedir}/src/main/javacc, but /src/main/javacc will be considered as an absolute path, usually leading to an error.
The default value, adequate for a user written grammar, but not for a generated (by a preprocessor) grammar, is: ${basedir}/src/main/javacc for JavaCC,
${basedir}/src/main/jjtree for JJTree,
${basedir}/src/main/jtb for JTB.User Property: javacc.sourceDirectory |
<timestampDeltaMs> |
Long |
- |
The delta in milliseconds of the last modification timestamps for testing whether a grammar file needs regeneration.
If set to a negative value, no comparison will be performed and grammars will always be passed to the processor. Otherwise a grammar file will be passed to the processor if the sum of the main generated file timestamp plus this delta is lower than the grammar file timestamp or than the more recent of the dependent jars timestamps. Default: 0User Property: javacc.timestampDeltaMs |
Parameter Details
<excludes>
The 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.
By default, this set is empty such that no files are excluded.
- Type:
java.lang.String[] - Required:
No
<failOnGrammarError>
The fail on grammar error parameter.
It governs how the plugin will handle the errors it encountered while trying to read a grammar file to retrieve the parser name (and the parser package for languages that use it) (in an execution the plugin may process zero, one or many grammars).
Possible values are
If set to
if set to
if set to
It governs how the plugin will handle the errors it encountered while trying to read a grammar file to retrieve the parser name (and the parser package for languages that use it) (in an execution the plugin may process zero, one or many grammars).
Possible values are
first, last and ignore.
If set to
first, the error message is displayed, the plugin will stop processing other grammars and will report an error for the build;
if set to
last, the error message is displayed, the plugin will continue processing other grammars and at the end it will report an error for the build;
if set to
ignore the error message(s) is(are) displayed but the plugin will not report an error for the current execution (i.e. it will continue with the next execution).- Type:
java.lang.String - Required:
No - User Property:
javacc.failOnGrammarError - Default:
first
<failOnPluginError>
The fail on plugin error flag.
It governs how the plugin will handle the errors it encountered on general configuration (i.e. parameters not related to grammars).
Possible values are
On the first error: if set to
if set to
It governs how the plugin will handle the errors it encountered on general configuration (i.e. parameters not related to grammars).
Possible values are
true and false.
On the first error: if set to
false, the error message is displayed but the plugin will not report an error for the current execution (i.e. it will continue with the next execution);
if set to
true the error message is displayed and the plugin will report an error for the build.- Type:
java.lang.Boolean - Required:
No - User Property:
javacc.failOnPluginError - Default:
true
<failOnProcessorError>
The fail on processor error parameter.
It governs how the plugin will handle the errors returned by the processor invocations and the plugin post-processor copy operations (in an execution the plugin may process zero, one or many grammars and invoke one or more processors for each).
Possible values are
If set to
if set to
if set to
It governs how the plugin will handle the errors returned by the processor invocations and the plugin post-processor copy operations (in an execution the plugin may process zero, one or many grammars and invoke one or more processors for each).
Possible values are
first, last and ignore.
If set to
first, the error message is displayed, the plugin will stop processing other grammars and will report an error for the build;
if set to
last, the error message is displayed, the plugin will continue processing other grammars and at the end it will report an error for the build;
if set to
ignore the error message(s) is(are) displayed but the plugin will not report an error for the current execution (i.e. it will continue with the next execution).- Type:
java.lang.String - Required:
No - User Property:
javacc.failOnProcessorError - Default:
first
<includes>
The set of Ant-like inclusion patterns used to select files from the source directory for processing.
By default, the patterns are:
By default, the patterns are:
**/*.jj for the javacc goal,
**/*.jjt for the jjtree and jjtree-javacc goals,
**/*.jtb for the jtb and jtb-javacc goals.- Type:
java.lang.String[] - Required:
No
<javaccCmdLineArgs>
See also: JavaCCGoalMojo.javaccCmdLineArgs
- Type:
java.util.List<java.lang.String> - Required:
No - User Property:
javacc.javaccCmdLineArgs
<jjtreeCmdLineArgs>
See also: JJTreeGoalMojo.jjtreeCmdLineArgs
- Type:
java.util.List<java.lang.String> - Required:
No - User Property:
javacc.jjtreeCmdLineArgs
<keepIntermediateDirectory>
The keep the intermediate directory(ies) flag.
If set to true, the intermediate directory(ies) will not be deleted, which may sometimes be handy for plugin or processor debug purposes.
If set to true, the intermediate directory(ies) will not be deleted, which may sometimes be handy for plugin or processor debug purposes.
- Type:
java.lang.Boolean - Required:
No - User Property:
javacc.keepIntermediateDirectory - Default:
false
<skip>
The skip processing flag.
If true, no goal will not be executed.
If true, no goal will not be executed.
- Type:
java.lang.Boolean - Required:
No - User Property:
javacc.skip - Default:
false
<sourceDirectory>
The directory where the grammar files are located.
It must exist and be a directory, otherwise a plugin error will be raised.
This directory will be recursively scanned for input files to pass to JavaCC.
If one wants a pom to process more than one source directory, he must configure multiple executions with different source directories.
Note: we could have implemented a list of source directories (as in
The parameters
If not an absolute path, maven internals considers it is relative to
The default value, adequate for a user written grammar, but not for a generated (by a preprocessor) grammar, is:
It must exist and be a directory, otherwise a plugin error will be raised.
This directory will be recursively scanned for input files to pass to JavaCC.
If one wants a pom to process more than one source directory, he must configure multiple executions with different source directories.
Note: we could have implemented a list of source directories (as in
AbstractPluginReport, but most of the time different source directories will need different configurations, so the user would still have to configure multiple executions.
The parameters
includes and excludes can be used to select a subset of the files.
If not an absolute path, maven internals considers it is relative to
${basedir} and converts it accordingly to an absolute path (i.e. src/main/javacc will be considered as ${basedir}/src/main/javacc, but /src/main/javacc will be considered as an absolute path, usually leading to an error.
The default value, adequate for a user written grammar, but not for a generated (by a preprocessor) grammar, is:
${basedir}/src/main/javacc for JavaCC,
${basedir}/src/main/jjtree for JJTree,
${basedir}/src/main/jtb for JTB.- Type:
java.io.File - Required:
No - User Property:
javacc.sourceDirectory
<timestampDeltaMs>
The delta in milliseconds of the last modification timestamps for testing whether a grammar file needs regeneration.
If set to a negative value, no comparison will be performed and grammars will always be passed to the processor.
Otherwise a grammar file will be passed to the processor if the sum of the main generated file timestamp plus this delta is lower than the grammar file timestamp or than the more recent of the dependent jars timestamps.
If set to a negative value, no comparison will be performed and grammars will always be passed to the processor.
Otherwise a grammar file will be passed to the processor if the sum of the main generated file timestamp plus this delta is lower than the grammar file timestamp or than the more recent of the dependent jars timestamps.
- Type:
java.lang.Long - Required:
No - User Property:
javacc.timestampDeltaMs - Default:
0