public class Options
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
Options.Language |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
JAVA_TEMPLATE_TYPE_CLASSIC
The old style of Java code generation (tight coupling of code to Java IO classes - not GWT compatible)
|
static java.lang.String |
JAVA_TEMPLATE_TYPE_MODERN
2013/07/22 -- GWT Compliant Output -- no external dependencies on GWT,
but generated code adds loose coupling to IO, for 6.1 release, this is
opt-in, moving forward to 7.0, after thorough testing, this will likely
become the default option with classic being deprecated
|
static Options.Language |
language |
static java.lang.String |
NONUSER_OPTION__HAS_NAMESPACE |
static java.lang.String |
NONUSER_OPTION__LEGACY_EXCEPTION_HANDLING |
static java.lang.String |
NONUSER_OPTION__NAMESPACE_CLOSE
These are options that are not settable by the user themselves, and that
are set indirectly via some configuration of user options
|
static java.lang.String |
NONUSER_OPTION__NAMESPACE_OPEN |
static java.lang.String |
NONUSER_OPTION__PARSER_NAME |
protected static java.util.Map<java.lang.String,java.lang.Object> |
optionValues
A mapping of option names (Strings) to values (Integer, Boolean, String).
|
static java.lang.String |
OUTPUT_LANGUAGE__CPP
Various constants relating to possible values for certain options
|
static java.lang.String |
OUTPUT_LANGUAGE__JAVA |
static java.lang.String |
USEROPTION__BUILD_PARSER |
static java.lang.String |
USEROPTION__BUILD_TOKEN_MANAGER |
static java.lang.String |
USEROPTION__CACHE_TOKENS |
static java.lang.String |
USEROPTION__CHOICE_AMBIGUITY_CHECK |
static java.lang.String |
USEROPTION__COMMON_TOKEN_ACTION |
static java.lang.String |
USEROPTION__CPP_IGNORE_ACTIONS |
static java.lang.String |
USEROPTION__CPP_NAMESPACE |
static java.lang.String |
USEROPTION__CPP_PARSER_INCLUDE |
static java.lang.String |
USEROPTION__CPP_PARSER_INCLUDES |
static java.lang.String |
USEROPTION__CPP_STACK_LIMIT |
static java.lang.String |
USEROPTION__CPP_STOP_ON_FIRST_ERROR |
static java.lang.String |
USEROPTION__CPP_TOKEN_INCLUDE |
static java.lang.String |
USEROPTION__CPP_TOKEN_INCLUDES |
static java.lang.String |
USEROPTION__CPP_TOKEN_MANAGER_INCLUDES |
static java.lang.String |
USEROPTION__CPP_TOKEN_MANAGER_SUPERCLASS |
static java.lang.String |
USEROPTION__DEBUG_LOOKAHEAD |
static java.lang.String |
USEROPTION__DEBUG_PARSER |
static java.lang.String |
USEROPTION__DEBUG_TOKEN_MANAGER |
static java.lang.String |
USEROPTION__DEPTH_LIMIT |
static java.lang.String |
USEROPTION__ERROR_REPORTING |
static java.lang.String |
USEROPTION__FORCE_LA_CHECK |
static java.lang.String |
USEROPTION__GENERATE_ANNOTATIONS |
static java.lang.String |
USEROPTION__GENERATE_BOILERPLATE |
static java.lang.String |
USEROPTION__GENERATE_CHAINED_EXCEPTION |
static java.lang.String |
USEROPTION__GENERATE_GENERICS |
static java.lang.String |
USEROPTION__GENERATE_STRING_BUILDER |
static java.lang.String |
USEROPTION__GRAMMAR_ENCODING |
static java.lang.String |
USEROPTION__IGNORE_CASE |
static java.lang.String |
USEROPTION__JAVA_TEMPLATE_TYPE |
static java.lang.String |
USEROPTION__JAVA_UNICODE_ESCAPE |
static java.lang.String |
USEROPTION__JDK_VERSION |
static java.lang.String |
USEROPTION__KEEP_LINE_COLUMN |
static java.lang.String |
USEROPTION__LOOKAHEAD |
static java.lang.String |
USEROPTION__NO_DFA |
static java.lang.String |
USEROPTION__OTHER_AMBIGUITY_CHECK |
static java.lang.String |
USEROPTION__OUTPUT_DIRECTORY |
static java.lang.String |
USEROPTION__OUTPUT_LANGUAGE |
static java.lang.String |
USEROPTION__PARSER_CODE_GENERATOR |
static java.lang.String |
USEROPTION__PARSER_SUPER_CLASS
Options that the user can specify from .javacc file
|
static java.lang.String |
USEROPTION__SANITY_CHECK |
static java.lang.String |
USEROPTION__STATIC |
static java.lang.String |
USEROPTION__SUPPORT_CLASS_VISIBILITY_PUBLIC |
static java.lang.String |
USEROPTION__TOKEN_EXTENDS |
static java.lang.String |
USEROPTION__TOKEN_FACTORY |
static java.lang.String |
USEROPTION__TOKEN_MANAGER_CODE_GENERATOR |
static java.lang.String |
USEROPTION__TOKEN_MANAGER_SUPER_CLASS |
static java.lang.String |
USEROPTION__TOKEN_MANAGER_USES_PARSER |
static java.lang.String |
USEROPTION__UNICODE_INPUT |
static java.lang.String |
USEROPTION__USER_CHAR_STREAM |
static java.lang.String |
USEROPTION__USER_TOKEN_MANAGER |
Modifier | Constructor and Description |
---|---|
protected |
Options()
Limit subclassing to derived classes.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
booleanValue(java.lang.String option)
Convenience method to retrieve boolean options.
|
static java.lang.String |
getBooleanType() |
static boolean |
getBuildParser()
Find the build parser value.
|
static boolean |
getBuildTokenManager()
Find the build token manager value.
|
static boolean |
getCacheTokens()
Find the cache tokens value.
|
static int |
getChoiceAmbiguityCheck()
Find the choice ambiguity check value.
|
static boolean |
getCommonTokenAction()
Find the common token action value.
|
static boolean |
getDebugLookahead()
Find the debug lookahead value.
|
static boolean |
getDebugParser()
Find the debug parser value.
|
static boolean |
getDebugTokenManager()
Find the debug tokenmanager value.
|
static int |
getDepthLimit()
Get defined parser recursion depth limit.
|
static boolean |
getErrorReporting()
Find the error reporting value.
|
static boolean |
getForceLaCheck()
Find the force lookahead check value.
|
static boolean |
getGenerateAnnotations()
Should the generated code contain Annotations?
|
static boolean |
getGenerateChainedException()
Should the generated code create Exceptions using a constructor taking a
nested exception?
|
static boolean |
getGenerateGenerics()
Should the generated code contain Generics?
|
static boolean |
getGenerateStringBuilder()
Should the generated code use StringBuilder rather than StringBuffer?
|
static java.lang.String |
getGrammarEncoding()
Return the file encoding; this will return the file.encoding system
property if no value was explicitly set
|
static boolean |
getIgnoreCase()
Find the ignore case value.
|
static java.lang.String |
getJavaTemplateType() |
static boolean |
getJavaUnicodeEscape()
Find the Java unicode escape value.
|
static java.lang.String |
getJdkVersion()
Find the JDK version.
|
static boolean |
getKeepLineColumn()
Find the keep line column value.
|
static java.lang.String |
getLongType() |
static int |
getLookahead()
Find the lookahead setting.
|
static boolean |
getNoDfa() |
static java.util.Map<java.lang.String,java.lang.Object> |
getOptions() |
static java.lang.String |
getOptionsString(java.lang.String[] interestingOptions)
Returns a string representation of the specified options of interest.
|
static int |
getOtherAmbiguityCheck()
Find the other ambiguity check value.
|
static java.io.File |
getOutputDirectory()
Find the output directory.
|
static java.lang.String |
getOutputLanguage() |
static java.lang.String |
getParserCodeGenerator() |
static boolean |
getSanityCheck()
Find the sanity check value.
|
static java.lang.String |
getStackLimit()
Get defined parser stack usage limit.
|
static boolean |
getStatic()
Find the static value.
|
static boolean |
getSupportClassVisibilityPublic()
Should the generated code class visibility public?
|
static java.lang.String |
getTokenExtends()
Return the Token's superclass.
|
static java.lang.String |
getTokenFactory()
Return the Token's factory class.
|
static java.lang.String |
getTokenManagerCodeGenerator() |
static boolean |
getTokenManagerUsesParser()
Find the token manager uses parser value.
|
static java.lang.String |
getTokenMgrErrorClass() |
static boolean |
getUnicodeInput()
Find the unicode input value.
|
static boolean |
getUserCharStream()
Find the user charstream value.
|
static java.util.Set<OptionInfo> |
getUserOptions()
Gets all the user options (in order)
|
static boolean |
getUserTokenManager()
Find the user tokenmanager value.
|
static void |
init()
Initialize for JavaCC
|
static int |
intValue(java.lang.String option)
Convenience method to retrieve integer options.
|
static boolean |
isGenerateBoilerplateCode() |
static boolean |
isLegacyExceptionHandling()
As of 6.1 JavaCC now throws subclasses of
RuntimeException rather
than Error s (by default), as Error s typically lead to
the closing down of the parent VM and are only to be used in extreme
circumstances (failure of parsing is generally not regarded as such). |
static boolean |
isOption(java.lang.String opt)
Determine if a given command line argument might be an option flag.
|
static boolean |
isOutputLanguageCpp() |
static boolean |
isOutputLanguageJava() |
static boolean |
isTokenManagerRequiresParserAccess() |
static boolean |
isValidJavaTemplateType(java.lang.String type) |
static boolean |
isValidOutputLanguage(java.lang.String language) |
static boolean |
jdkVersionAtLeast(double version)
Determine if the output language is at least the specified version.
|
static void |
normalize() |
static java.lang.Object |
objectValue(java.lang.String option) |
static void |
processCPPNamespaceOption(java.lang.String optionValue) |
static void |
setCmdLineOption(java.lang.String arg)
Process a single command-line option.
|
static void |
setInputFileOption(java.lang.Object nameloc,
java.lang.Object valueloc,
java.lang.String name,
java.lang.Object value) |
static void |
setStringOption(java.lang.String optionName,
java.lang.String optionValue) |
static java.lang.String |
stringBufOrBuild() |
static java.lang.String |
stringValue(java.lang.String option)
Convenience method to retrieve string options.
|
static java.lang.Object |
upgradeValue(java.lang.String name,
java.lang.Object value)
Help function to handle cases where the meaning of an option has changed
over time.
|
public static final java.lang.String NONUSER_OPTION__NAMESPACE_CLOSE
public static final java.lang.String NONUSER_OPTION__HAS_NAMESPACE
public static final java.lang.String NONUSER_OPTION__NAMESPACE_OPEN
public static final java.lang.String NONUSER_OPTION__PARSER_NAME
public static final java.lang.String NONUSER_OPTION__LEGACY_EXCEPTION_HANDLING
public static final java.lang.String USEROPTION__PARSER_SUPER_CLASS
public static final java.lang.String USEROPTION__JAVA_TEMPLATE_TYPE
public static final java.lang.String USEROPTION__GENERATE_BOILERPLATE
public static final java.lang.String USEROPTION__OUTPUT_LANGUAGE
public static final java.lang.String USEROPTION__PARSER_CODE_GENERATOR
public static final java.lang.String USEROPTION__TOKEN_MANAGER_CODE_GENERATOR
public static final java.lang.String USEROPTION__NO_DFA
public static final java.lang.String USEROPTION__STATIC
public static final java.lang.String USEROPTION__TOKEN_MANAGER_SUPER_CLASS
public static final java.lang.String USEROPTION__LOOKAHEAD
public static final java.lang.String USEROPTION__IGNORE_CASE
public static final java.lang.String USEROPTION__UNICODE_INPUT
public static final java.lang.String USEROPTION__JAVA_UNICODE_ESCAPE
public static final java.lang.String USEROPTION__ERROR_REPORTING
public static final java.lang.String USEROPTION__DEBUG_TOKEN_MANAGER
public static final java.lang.String USEROPTION__DEBUG_LOOKAHEAD
public static final java.lang.String USEROPTION__DEBUG_PARSER
public static final java.lang.String USEROPTION__OTHER_AMBIGUITY_CHECK
public static final java.lang.String USEROPTION__CHOICE_AMBIGUITY_CHECK
public static final java.lang.String USEROPTION__CACHE_TOKENS
public static final java.lang.String USEROPTION__COMMON_TOKEN_ACTION
public static final java.lang.String USEROPTION__FORCE_LA_CHECK
public static final java.lang.String USEROPTION__SANITY_CHECK
public static final java.lang.String USEROPTION__TOKEN_MANAGER_USES_PARSER
public static final java.lang.String USEROPTION__BUILD_TOKEN_MANAGER
public static final java.lang.String USEROPTION__BUILD_PARSER
public static final java.lang.String USEROPTION__USER_CHAR_STREAM
public static final java.lang.String USEROPTION__USER_TOKEN_MANAGER
public static final java.lang.String USEROPTION__JDK_VERSION
public static final java.lang.String USEROPTION__SUPPORT_CLASS_VISIBILITY_PUBLIC
public static final java.lang.String USEROPTION__GENERATE_ANNOTATIONS
public static final java.lang.String USEROPTION__GENERATE_STRING_BUILDER
public static final java.lang.String USEROPTION__GENERATE_GENERICS
public static final java.lang.String USEROPTION__GENERATE_CHAINED_EXCEPTION
public static final java.lang.String USEROPTION__OUTPUT_DIRECTORY
public static final java.lang.String USEROPTION__KEEP_LINE_COLUMN
public static final java.lang.String USEROPTION__GRAMMAR_ENCODING
public static final java.lang.String USEROPTION__TOKEN_FACTORY
public static final java.lang.String USEROPTION__TOKEN_EXTENDS
public static final java.lang.String USEROPTION__DEPTH_LIMIT
public static final java.lang.String USEROPTION__CPP_NAMESPACE
public static final java.lang.String USEROPTION__CPP_TOKEN_INCLUDES
public static final java.lang.String USEROPTION__CPP_PARSER_INCLUDES
public static final java.lang.String USEROPTION__CPP_IGNORE_ACTIONS
public static final java.lang.String USEROPTION__CPP_TOKEN_MANAGER_INCLUDES
public static final java.lang.String USEROPTION__CPP_TOKEN_MANAGER_SUPERCLASS
public static final java.lang.String USEROPTION__CPP_STOP_ON_FIRST_ERROR
public static final java.lang.String USEROPTION__CPP_STACK_LIMIT
public static final java.lang.String USEROPTION__CPP_TOKEN_INCLUDE
public static final java.lang.String USEROPTION__CPP_PARSER_INCLUDE
public static final java.lang.String OUTPUT_LANGUAGE__CPP
public static final java.lang.String OUTPUT_LANGUAGE__JAVA
public static Options.Language language
public static final java.lang.String JAVA_TEMPLATE_TYPE_MODERN
public static final java.lang.String JAVA_TEMPLATE_TYPE_CLASSIC
protected static java.util.Map<java.lang.String,java.lang.Object> optionValues
public static void init()
public static int intValue(java.lang.String option)
public static boolean booleanValue(java.lang.String option)
public static java.lang.String stringValue(java.lang.String option)
public static java.lang.Object objectValue(java.lang.String option)
public static java.util.Map<java.lang.String,java.lang.Object> getOptions()
public static java.lang.String getOptionsString(java.lang.String[] interestingOptions)
interestingOptions
- the options of interest, eg {Options.USEROPTION__STATIC, Options.USEROPTION__CACHE_TOKENS}public static java.lang.String getTokenMgrErrorClass()
public static boolean isOption(java.lang.String opt)
opt
- The command line argument to examine.public static java.lang.Object upgradeValue(java.lang.String name, java.lang.Object value)
name
- The name of the option being checked.value
- The option's value.public static void setInputFileOption(java.lang.Object nameloc, java.lang.Object valueloc, java.lang.String name, java.lang.Object value)
public static void setCmdLineOption(java.lang.String arg)
arg
- public static void normalize()
public static int getLookahead()
public static int getChoiceAmbiguityCheck()
public static int getOtherAmbiguityCheck()
public static boolean getStatic()
public static java.lang.String getParserCodeGenerator()
public static java.lang.String getTokenManagerCodeGenerator()
public static boolean getNoDfa()
public static boolean getDebugParser()
public static boolean getDebugLookahead()
public static boolean getDebugTokenManager()
public static boolean getErrorReporting()
public static boolean getJavaUnicodeEscape()
public static boolean getUnicodeInput()
public static boolean getIgnoreCase()
public static boolean getUserTokenManager()
public static boolean getUserCharStream()
public static boolean getBuildParser()
public static boolean getBuildTokenManager()
public static boolean getTokenManagerUsesParser()
public static boolean getSanityCheck()
public static boolean getForceLaCheck()
public static boolean getCommonTokenAction()
public static boolean getCacheTokens()
public static boolean getKeepLineColumn()
public static java.lang.String getJdkVersion()
public static boolean getGenerateChainedException()
public static boolean isGenerateBoilerplateCode()
public static boolean isLegacyExceptionHandling()
RuntimeException
rather
than Error
s (by default), as Error
s typically lead to
the closing down of the parent VM and are only to be used in extreme
circumstances (failure of parsing is generally not regarded as such). If
this value is set to true, then then Error
s will be thrown (for
compatibility with older .jj files)RuntimeException
s (better approach)public static boolean getGenerateGenerics()
public static boolean getGenerateStringBuilder()
public static boolean getGenerateAnnotations()
public static boolean getSupportClassVisibilityPublic()
public static boolean jdkVersionAtLeast(double version)
version
- the version to check against. E.g. 1.5
public static java.lang.String getTokenExtends()
public static java.lang.String getTokenFactory()
public static java.lang.String getGrammarEncoding()
public static java.io.File getOutputDirectory()
public static java.lang.String stringBufOrBuild()
public static boolean isValidOutputLanguage(java.lang.String language)
public static boolean isValidJavaTemplateType(java.lang.String type)
public static java.lang.String getOutputLanguage()
public static java.lang.String getJavaTemplateType()
public static void setStringOption(java.lang.String optionName, java.lang.String optionValue)
public static void processCPPNamespaceOption(java.lang.String optionValue)
public static java.lang.String getLongType()
public static java.lang.String getBooleanType()
public static boolean isOutputLanguageJava()
public static boolean isOutputLanguageCpp()
public static boolean isTokenManagerRequiresParserAccess()
public static int getDepthLimit()
public static java.lang.String getStackLimit()
public static java.util.Set<OptionInfo> getUserOptions()