org.javacc.mojo.JJTreeMojo Maven / Gradle / Ivy
package org.javacc.mojo;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
/**
* Parses a JJTree grammar file (*.jjt) and transforms it to Java source files and a JavaCC grammar
* file. Please see the JJTree Reference Documentation for
* more information.
*
* @goal jjtree
* @phase generate-sources
* @since 2.0
* @deprecated As of version 2.4, use the jjtree-javacc goal instead.
* @author jesse
* @version $Id$
*/
public class JJTreeMojo
extends AbstractPreprocessorMojo
{
/**
* The Java version for which to generate source code. Default value is 1.4.
*
* @parameter property="jdkVersion"
* @since 2.4
*/
private String jdkVersion;
/**
* A flag whether to generate sample implementations for SimpleNode and any other nodes used in the
* grammar. Default value is true.
*
* @parameter property="buildNodeFiles"
*/
private Boolean buildNodeFiles;
/**
* A flag whether to generate a multi mode parse tree or a single mode parse tree. Default value is
* false.
*
* @parameter property="multi"
*/
private Boolean multi;
/**
* A flag whether to make each non-decorated production void instead of an indefinite node. Default value is
* false.
*
* @parameter property="nodeDefaultVoid"
*/
private Boolean nodeDefaultVoid;
/**
* 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.
*
* @parameter property="nodeClass"
* @since 2.5
*/
private String nodeClass;
/**
* 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.
*
* @parameter property="nodeFactory"
*/
private String nodeFactory;
/**
* 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 *.demo, the tree node classes will be located in the package
* org.apache.demo. By default, the package of the corresponding parser is used.
*
* @parameter property="nodePackage"
*/
private String nodePackage;
/**
* The prefix used to construct node class names from node identifiers in multi mode. Default value is
* AST.
*
* @parameter property="nodePrefix"
*/
private String nodePrefix;
/**
* A flag whether user-defined parser methods should be called on entry and exit of every node scope. Default value
* is false.
*
* @parameter property="nodeScopeHook"
*/
private Boolean nodeScopeHook;
/**
* A flag whether the node construction routines need an additional method parameter to receive the parser object.
* Default value is false.
*
* @parameter property="nodeUsesParser"
*/
private Boolean nodeUsesParser;
/**
* A flag whether to generate code for a static parser. Note that this setting must match the corresponding option
* for the javacc mojo. Default value is true.
*
* @parameter property="isStatic" alias="staticOption"
*/
private Boolean isStatic;
/**
* A flag whether to insert the methods jjtGetFirstToken(), jjtSetFirstToken(),
* getLastToken() and jjtSetLastToken() into the class SimpleNode. Default
* value is false.
*
* @parameter property="trackTokens"
* @since 2.5
*/
private Boolean trackTokens;
/**
* 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.
*
* @parameter property="visitor"
*/
private Boolean visitor;
/**
* The name of a class to use for the data argument of the jjtAccept() and visit()
* methods. Default value is java.lang.Object.
*
* @parameter property="visitorDataType"
* @since 2.5
*/
private String visitorDataType;
/**
* The name of a class to use as the return type of the jjtAccept() and visit() methods.
* Default value is java.lang.Object.
*
* @parameter property="visitorReturnType"
* @since 2.5
*/
private String visitorReturnType;
/**
* 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.
*
* @parameter property="visitorException"
*/
private String visitorException;
/**
* Directory where the input JJTree files (*.jjt) are located.
*
* @parameter property="sourceDirectory" default-value="${basedir}/src/main/jjtree"
*/
private File sourceDirectory;
/**
* Directory where the output Java files for the node classes and the JavaCC grammar file will be located.
*
* @parameter property="outputDirectory" default-value="${project.build.directory}/generated-sources/jjtree"
*/
private File outputDirectory;
/**
* The directory to store the processed input files for later detection of stale sources.
*
* @parameter property="timestampDirectory"
* default-value="${project.build.directory}/generated-sources/jjtree-timestamp"
*/
private File timestampDirectory;
/**
* The granularity in milliseconds of the last modification date for testing whether a source needs recompilation.
*
* @parameter property="lastModGranularityMs" default-value="0"
*/
private int staleMillis;
/**
* A set of Ant-like inclusion patterns used to select files from the source directory for processing. By default,
* the patterns **/*.jjt and **/*.JJT are used to select grammar files.
*
* @parameter
*/
private String[] includes;
/**
* 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.
*
* @parameter
*/
private String[] excludes;
/**
* {@inheritDoc}
*/
protected File getSourceDirectory()
{
return this.sourceDirectory;
}
/**
* {@inheritDoc}
*/
protected String[] getIncludes()
{
if ( this.includes != null )
{
return this.includes;
}
else
{
return new String[] { "**/*.jjt", "**/*.JJT" };
}
}
/**
* {@inheritDoc}
*/
protected String[] getExcludes()
{
return this.excludes;
}
/**
* {@inheritDoc}
*/
protected File getOutputDirectory()
{
return this.outputDirectory;
}
/**
* {@inheritDoc}
*/
protected File getTimestampDirectory()
{
return this.timestampDirectory;
}
/**
* {@inheritDoc}
*/
protected int getStaleMillis()
{
return this.staleMillis;
}
/**
* {@inheritDoc}
*/
protected void processGrammar( GrammarInfo grammarInfo )
throws MojoExecutionException, MojoFailureException
{
File jjtFile = grammarInfo.getGrammarFile();
// determine target directory for tree node files
String nodePackageName = grammarInfo.resolvePackageName( this.nodePackage );
File nodeDirectory;
if ( nodePackageName != null )
{
nodeDirectory = new File( nodePackageName.replace( '.', File.separatorChar ) );
}
else
{
nodeDirectory = new File( grammarInfo.getParserDirectory() );
}
nodeDirectory = new File( getOutputDirectory(), nodeDirectory.getPath() );
// generate final grammar file and node files
JJTree jjtree = newJJTree();
jjtree.setInputFile( jjtFile );
jjtree.setOutputDirectory( nodeDirectory );
jjtree.setNodePackage( nodePackageName );
jjtree.run();
// create timestamp file
createTimestamp( grammarInfo );
}
/**
* Creates a new facade to invoke JJTree. Most options for the invocation are derived from the current values of the
* corresponding mojo parameters. The caller is responsible to set the input file, output directory and package on
* the returned facade.
*
* @return The facade for the tool invocation, never null.
*/
protected JJTree newJJTree()
{
JJTree jjtree = new JJTree();
jjtree.setLog( getLog() );
jjtree.setJdkVersion( this.jdkVersion );
jjtree.setStatic( this.isStatic );
jjtree.setBuildNodeFiles( this.buildNodeFiles );
jjtree.setMulti( this.multi );
jjtree.setNodeDefaultVoid( this.nodeDefaultVoid );
jjtree.setNodeClass( this.nodeClass );
jjtree.setNodeFactory( this.nodeFactory );
jjtree.setNodePrefix( this.nodePrefix );
jjtree.setNodeScopeHook( this.nodeScopeHook );
jjtree.setNodeUsesParser( this.nodeUsesParser );
jjtree.setTrackTokens( this.trackTokens );
jjtree.setVisitor( this.visitor );
jjtree.setVisitorDataType( this.visitorDataType );
jjtree.setVisitorReturnType( this.visitorReturnType );
jjtree.setVisitorException( this.visitorException );
return jjtree;
}
/**
* Prevents registration of our output or a following invocation of the javacc mojo will cause duplicate sources
* which in turn will make compilation fail.
*/
protected void addCompileSourceRoot()
{
// do nothing
}
}