org.javacc.jjtree.JJTreeOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-javacc-maven-plugin Show documentation
Show all versions of ph-javacc-maven-plugin Show documentation
Maven 3 Plugin for processing JavaCC grammar files.
// Copyright 2011 Google Inc. All Rights Reserved.
// Author: [email protected] (Sreeni Viswanadha)
/* Copyright (c) 2005-2006, Kees Jan Koster [email protected]
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the Sun Microsystems, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.javacc.jjtree;
import java.io.File;
import org.javacc.parser.JavaCCErrors;
import org.javacc.parser.Options;
/**
* The JJTree-specific options.
*
* @author Kees Jan Koster <[email protected]>
*/
class JJTreeOptions extends Options
{
/**
* Limit subclassing to derived classes.
*/
protected JJTreeOptions ()
{
super ();
}
/**
* Initialize the JJTree-specific options.
*/
public static void init ()
{
Options.init ();
Options.optionValues.put ("MULTI", Boolean.FALSE);
Options.optionValues.put ("NODE_DEFAULT_VOID", Boolean.FALSE);
Options.optionValues.put ("NODE_SCOPE_HOOK", Boolean.FALSE);
Options.optionValues.put ("NODE_USES_PARSER", Boolean.FALSE);
Options.optionValues.put ("BUILD_NODE_FILES", Boolean.TRUE);
Options.optionValues.put ("VISITOR", Boolean.FALSE);
Options.optionValues.put ("VISITOR_METHOD_NAME_INCLUDES_TYPE_NAME", Boolean.FALSE);
Options.optionValues.put ("TRACK_TOKENS", Boolean.FALSE);
Options.optionValues.put ("NODE_PREFIX", "AST");
Options.optionValues.put ("NODE_PACKAGE", "");
Options.optionValues.put ("NODE_EXTENDS", "");
Options.optionValues.put ("NODE_CLASS", "");
Options.optionValues.put ("NODE_FACTORY", "");
Options.optionValues.put ("NODE_INCLUDES", "");
Options.optionValues.put ("OUTPUT_FILE", "");
Options.optionValues.put ("VISITOR_DATA_TYPE", "");
Options.optionValues.put ("VISITOR_RETURN_TYPE", "Object");
Options.optionValues.put ("VISITOR_EXCEPTION", "");
Options.optionValues.put ("JJTREE_OUTPUT_DIRECTORY", "");
// TODO :: 2013/07/23 -- This appears to be a duplicate from the parent
// class
Options.optionValues.put (Options.USEROPTION__JDK_VERSION, "1.5");
// Also appears to be a duplicate
Options.optionValues.put (Options.USEROPTION_CPP_NAMESPACE, "");
// Also appears to be a duplicate
Options.optionValues.put (Options.USEROPTION__CPP_IGNORE_ACTIONS, Boolean.FALSE);
}
/**
* Check options for consistency
*/
public static void validate ()
{
if (!getVisitor ())
{
if (getVisitorDataType ().length () > 0)
{
JavaCCErrors.warning ("VISITOR_DATA_TYPE option will be ignored since VISITOR is false");
}
if (getVisitorReturnType ().length () > 0 && !getVisitorReturnType ().equals ("Object"))
{
JavaCCErrors.warning ("VISITOR_RETURN_TYPE option will be ignored since VISITOR is false");
}
if (getVisitorException ().length () > 0)
{
JavaCCErrors.warning ("VISITOR_EXCEPTION option will be ignored since VISITOR is false");
}
}
}
/**
* Find the multi value.
*
* @return The requested multi value.
*/
public static boolean getMulti ()
{
return booleanValue ("MULTI");
}
/**
* Find the node default void value.
*
* @return The requested node default void value.
*/
public static boolean getNodeDefaultVoid ()
{
return booleanValue ("NODE_DEFAULT_VOID");
}
/**
* Find the node scope hook value.
*
* @return The requested node scope hook value.
*/
public static boolean getNodeScopeHook ()
{
return booleanValue ("NODE_SCOPE_HOOK");
}
/**
* Find the node factory value.
*
* @return The requested node factory value.
*/
public static String getNodeFactory ()
{
return stringValue ("NODE_FACTORY");
}
/**
* Find the node uses parser value.
*
* @return The requested node uses parser value.
*/
public static boolean getNodeUsesParser ()
{
return booleanValue ("NODE_USES_PARSER");
}
/**
* Find the build node files value.
*
* @return The requested build node files value.
*/
public static boolean getBuildNodeFiles ()
{
return booleanValue ("BUILD_NODE_FILES");
}
/**
* Find the visitor value.
*
* @return The requested visitor value.
*/
public static boolean getVisitor ()
{
return booleanValue ("VISITOR");
}
/**
* Find the trackTokens value.
*
* @return The requested trackTokens value.
*/
public static boolean getTrackTokens ()
{
return booleanValue ("TRACK_TOKENS");
}
/**
* Find the node prefix value.
*
* @return The requested node prefix value.
*/
public static String getNodePrefix ()
{
return stringValue ("NODE_PREFIX");
}
/**
* Find the node super class name.
*
* @return The requested node super class
*/
public static String getNodeExtends ()
{
return stringValue ("NODE_EXTENDS");
}
/**
* Find the node class name.
*
* @return The requested node class
*/
public static String getNodeClass ()
{
return stringValue ("NODE_CLASS");
}
/**
* Find the node package value.
*
* @return The requested node package value.
*/
public static String getNodePackage ()
{
return stringValue ("NODE_PACKAGE");
}
/**
* Find the output file value.
*
* @return The requested output file value.
*/
public static String getOutputFile ()
{
return stringValue ("OUTPUT_FILE");
}
/**
* Find the visitor exception value
*
* @return The requested visitor exception value.
*/
public static String getVisitorException ()
{
return stringValue ("VISITOR_EXCEPTION");
}
/**
* Find the visitor data type value
*
* @return The requested visitor data type value.
*/
public static String getVisitorDataType ()
{
return stringValue ("VISITOR_DATA_TYPE");
}
/**
* Find the visitor return type value
*
* @return The requested visitor return type value.
*/
public static String getVisitorReturnType ()
{
return stringValue ("VISITOR_RETURN_TYPE");
}
/**
* Find the output directory to place the generated .jj files
* into. If none is configured, use the value of
* getOutputDirectory().
*
* @return The requested JJTree output directory
*/
public static File getJJTreeOutputDirectory ()
{
final String dirName = stringValue ("JJTREE_OUTPUT_DIRECTORY");
File dir = null;
if ("".equals (dirName))
{
dir = getOutputDirectory ();
}
else
{
dir = new File (dirName);
}
return dir;
}
}