Package EDU.purdue.jtb.common
Class Constants
java.lang.Object
EDU.purdue.jtb.common.Constants
Class
Constants
contains static global flags, constants and names.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String[]
The list of base nodes classesstatic final String[]
The array of base nodes interfacesstatic final int
The javadoc break plus string lengthstatic final String
The javadoc break plus the OS line separatorstatic final int
The javadoc break plus the OS line separator string lengthstatic final boolean
Turns on / off printing class debug comments (useful to find where each line is produced)static final boolean
Turns on / off printing field and sub comment debug commentsstatic final String
Default node scope hook directory namestatic final String
Default node scope hook package namestatic final String
Default nodes directory namestatic final String
Default nodes package namestatic final String
Default nodes prefixstatic final String
Default nodes suffixstatic final String
Default JavaCC generated grammar file namestatic final String
Default signature directory namestatic final String
Default signature package namestatic final String
Default visitors directory namestatic final String
Default visitors package namestatic final String
The node scope hook empty class namestatic final int
The "file exists" return codestatic final String
File header commentstatic final String
Visitor methods user argument (second and more arguments) variablestatic final String
Visitor methods depth level local variablestatic final String
Visitor methods node argument (first argument) variablestatic final String
Visitor methods node argument (first argument) variable plus dotstatic final String
Visitor methods return variablestatic final String
Accept methods visitor variablestatic final String
The node scope hook interface namestatic final int
The indentation default number of charactersstatic final String
Name of the node interface that all tree nodes implementstatic final String
Name of the list interface that NodeList, NodeListOptional and NodeSequence implementstatic final String
Name of the (generated by JavaCC) class representing a tokenstatic final String
The jtb base nodes interfaces list key in the data modelstatic final String
The jtb base nodes classes list key in the data modelstatic final String
The jtb constants map key in the data modelstatic final String
The jtb number of sub-nodes to be created map key in the data modelstatic final String
The jtb nodes which must not be created map key in the data modelstatic final String
The jtb options map key in the data modelstatic final String
The jtb all nodes map key in the data modelstatic final String
The jtb user nodes map key in the data modelstatic final String
The program versionstatic final String
The external generator class method to be invokedstatic final String
The enter node scope hook method namestatic final String
The exit node scope hook method namestatic final String
The JTB node scope hook variable namestatic final String
The JTB created node variablestatic final String
The JTB result type save variables prefixstatic final String
The JTB result type variables prefixstatic final String
The JTB created control signature variable prefixstatic final String
The JTB created user node variable prefixstatic final String
The OS line separator stringstatic final char
The OS line separator first characterstatic final int
The OS line separator string lengthstatic final String
Name of the node class representing a grammar choice such as ( A | B )static final String
Name of the node class holding the constants reflecting the generated classes "static final String
Name of the node class representing a list such as ( A )+static final String
Name of the node class representing an optional list such as (A )*static final String
Name of the node class representing an optional such as [ A ] or ( A )?static final String
Name of the node class representing a nested sequence of nodesstatic final String
Name of the (generated by JavaCC) class representing a token; same asjjToken
static final int
The "OK" return codestatic final String
The java program nameA map holding the primitive types (except void)static final long
The serial version uidstatic final String
The signature annotation namestatic final String
The signature annotation processor namestatic final String
An indication in case of JTB internal errorsstatic final String
The TreeDumpervisitor class namestatic final String
The TreeFormatter visitor class name -
Method Summary
-
Field Details
-
DEBUG_CLASS
public static final boolean DEBUG_CLASSTurns on / off printing class debug comments (useful to find where each line is produced)- See Also:
-
DEBUG_COMMENT
public static final boolean DEBUG_COMMENTTurns on / off printing field and sub comment debug comments- See Also:
-
JTB_VERSION
The program version- See Also:
-
SERIALVERSIONUID
public static final long SERIALVERSIONUIDThe serial version uid -
PROG_NAME
The java program name- See Also:
-
fileHeaderComment
File header comment- See Also:
-
SUPPORT
An indication in case of JTB internal errors- See Also:
-
INDENT_AMT
public static final int INDENT_AMTThe indentation default number of characters- See Also:
-
LS
The OS line separator string -
LS0
public static final char LS0The OS line separator first character -
LSLEN
public static final int LSLENThe OS line separator string length -
BRLEN
public static final int BRLENThe javadoc break plus string length -
BRLS
The javadoc break plus the OS line separator -
BRLSLEN
public static final int BRLSLENThe javadoc break plus the OS line separator string length -
OK_RC
public static final int OK_RCThe "OK" return code- See Also:
-
FILE_EXISTS_RC
public static final int FILE_EXISTS_RCThe "file exists" return code- See Also:
-
iNode
Name of the node interface that all tree nodes implement -
iNodeList
Name of the list interface that NodeList, NodeListOptional and NodeSequence implement -
nodeChoice
Name of the node class representing a grammar choice such as ( A | B ) -
nodeList
Name of the node class representing a list such as ( A )+ -
nodeListOptional
Name of the node class representing an optional list such as (A )* -
nodeOptional
Name of the node class representing an optional such as [ A ] or ( A )? -
nodeSequence
Name of the node class representing a nested sequence of nodes -
nodeToken
Name of the (generated by JavaCC) class representing a token; same asjjToken
-
jjToken
Name of the (generated by JavaCC) class representing a token -
baseNodesInterfaces
The array of base nodes interfaces -
baseNodesClasses
The list of base nodes classes -
nodeConstants
Name of the node class holding the constants reflecting the generated classes " -
treeFormatterName
The TreeFormatter visitor class name- See Also:
-
treeDumperName
The TreeDumpervisitor class name- See Also:
-
genVisVar
Accept methods visitor variable- See Also:
-
genRetVar
Visitor methods return variable- See Also:
-
genNodeVar
Visitor methods node argument (first argument) variable- See Also:
-
genNodeVarDot
Visitor methods node argument (first argument) variable plus dot- See Also:
-
genArguVar
Visitor methods user argument (second and more arguments) variable- See Also:
-
genDepthLevelVar
Visitor methods depth level local variable- See Also:
-
jtbHookVar
The JTB node scope hook variable name- See Also:
-
iEnterExitHook
The node scope hook interface name- See Also:
-
emptyEnterExitHook
The node scope hook empty class name- See Also:
-
jtbHookEnter
The enter node scope hook method name- See Also:
-
jtbHookExit
The exit node scope hook method name- See Also:
-
jtbEgInvokedMethode
The external generator class method to be invoked- See Also:
-
jtb_constants_dm_key
The jtb constants map key in the data model- See Also:
-
jtb_options_dm_key
The jtb options map key in the data model- See Also:
-
jtb_base_interfaces_dm_key
The jtb base nodes interfaces list key in the data model- See Also:
-
jtb_base_nodes_dm_key
The jtb base nodes classes list key in the data model- See Also:
-
jtb_user_nodes_dm_key
The jtb user nodes map key in the data model- See Also:
-
jtb_notTbcNodes_dm_key
The jtb nodes which must not be created map key in the data model- See Also:
-
jtb_prod_dm_key
The jtb all nodes map key in the data model- See Also:
-
jtb_nbSubNodesTbc_dm_key
The jtb number of sub-nodes to be created map key in the data model- See Also:
-
jtbRtPrefix
The JTB result type variables prefix- See Also:
-
jtbRtOld
The JTB result type save variables prefix- See Also:
-
jtbNodeVar
The JTB created node variable- See Also:
-
jtbUserPfx
The JTB created user node variable prefix- See Also:
-
jtbSigPfx
The JTB created control signature variable prefix- See Also:
-
sigAnnName
The signature annotation name -
sigAnnProcName
The signature annotation processor name -
DEF_ND_PREFIX
Default nodes prefix- See Also:
-
DEF_ND_SUFFIX
Default nodes suffix- See Also:
-
DEF_ND_PKG_NAME
Default nodes package name- See Also:
-
DEF_VIS_PKG_NAME
Default visitors package name- See Also:
-
DEF_SIG_PKG_NAME
Default signature package name- See Also:
-
DEF_HOOK_PKG_NAME
Default node scope hook package name- See Also:
-
DEF_ND_DIR_NAME
Default nodes directory name- See Also:
-
DEF_VIS_DIR_NAME
Default visitors directory name- See Also:
-
DEF_SIG_DIR_NAME
Default signature directory name- See Also:
-
DEF_HOOK_DIR_NAME
Default node scope hook directory name- See Also:
-
DEF_OUT_FILE_NAME
Default JavaCC generated grammar file name- See Also:
-
ptHM
A map holding the primitive types (except void)
-