Class Constants

java.lang.Object
EDU.purdue.jtb.common.Constants
public class Constants extends Object
Class Constants contains static global flags, constants and names.

  • Field Details

    • DEBUG_CLASS

      public static final boolean DEBUG_CLASS
      Turns on / off printing class debug comments (useful to find where each line is produced)
      See Also:

    • DEBUG_COMMENT

      public static final boolean DEBUG_COMMENT
      Turns on / off printing field and sub comment debug comments
      See Also:

    • JTB_VERSION

      public static final String JTB_VERSION
      The program version
      See Also:

    • SERIALVERSIONUID

      public static final long SERIALVERSIONUID
      The serial version uid

    • PROG_NAME

      public static final String PROG_NAME
      The java program name
      See Also:

    • fileHeaderComment

      public static final String fileHeaderComment
      File header comment
      See Also:

    • SUPPORT

      public static final String SUPPORT
      An indication in case of JTB internal errors
      See Also:

    • INDENT_AMT

      public static final int INDENT_AMT
      The indentation default number of characters
      See Also:

    • LS

      public static final String LS
      The OS line separator string

    • LS0

      public static final char LS0
      The OS line separator first character

    • LSLEN

      public static final int LSLEN
      The OS line separator string length

    • BRLEN

      public static final int BRLEN
      The javadoc break plus string length

    • BRLS

      public static final String BRLS
      The javadoc break plus the OS line separator

    • BRLSLEN

      public static final int BRLSLEN
      The javadoc break plus the OS line separator string length

    • OK_RC

      public static final int OK_RC
      The "OK" return code
      See Also:

    • FILE_EXISTS_RC

      public static final int FILE_EXISTS_RC
      The "file exists" return code
      See Also:

    • iNode

      public static final String iNode
      Name of the node interface that all tree nodes implement

    • iNodeList

      public static final String iNodeList
      Name of the list interface that NodeList, NodeListOptional and NodeSequence implement

    • nodeChoice

      public static final String nodeChoice
      Name of the node class representing a grammar choice such as ( A | B )

    • nodeList

      public static final String nodeList
      Name of the node class representing a list such as ( A )+

    • nodeListOptional

      public static final String nodeListOptional
      Name of the node class representing an optional list such as (A )*

    • nodeOptional

      public static final String nodeOptional
      Name of the node class representing an optional such as [ A ] or ( A )?

    • nodeSequence

      public static final String nodeSequence
      Name of the node class representing a nested sequence of nodes

    • nodeToken

      public static final String nodeToken
      Name of the (generated by JavaCC) class representing a token; same as jjToken

    • jjToken

      public static final String jjToken
      Name of the (generated by JavaCC) class representing a token

    • baseNodesInterfaces

      public static final String[] baseNodesInterfaces
      The array of base nodes interfaces

    • baseNodesClasses

      public static final String[] baseNodesClasses
      The list of base nodes classes

    • nodeConstants

      public static final String nodeConstants
      Name of the node class holding the constants reflecting the generated classes "

    • treeFormatterName

      public static final String treeFormatterName
      The TreeFormatter visitor class name
      See Also:

    • treeDumperName

      public static final String treeDumperName
      The TreeDumpervisitor class name
      See Also:

    • genVisVar

      public static final String genVisVar
      Accept methods visitor variable
      See Also:

    • genRetVar

      public static final String genRetVar
      Visitor methods return variable
      See Also:

    • genNodeVar

      public static final String genNodeVar
      Visitor methods node argument (first argument) variable
      See Also:

    • genNodeVarDot

      public static final String genNodeVarDot
      Visitor methods node argument (first argument) variable plus dot
      See Also:

    • genArguVar

      public static final String genArguVar
      Visitor methods user argument (second and more arguments) variable
      See Also:

    • genDepthLevelVar

      public static final String genDepthLevelVar
      Visitor methods depth level local variable
      See Also:

    • jtbHookVar

      public static final String jtbHookVar
      The JTB node scope hook variable name
      See Also:

    • iEnterExitHook

      public static final String iEnterExitHook
      The node scope hook interface name
      See Also:

    • emptyEnterExitHook

      public static final String emptyEnterExitHook
      The node scope hook empty class name
      See Also:

    • jtbHookEnter

      public static final String jtbHookEnter
      The enter node scope hook method name
      See Also:

    • jtbHookExit

      public static final String jtbHookExit
      The exit node scope hook method name
      See Also:

    • jtbEgInvokedMethode

      public static final String jtbEgInvokedMethode
      The external generator class method to be invoked
      See Also:

    • jtb_constants_dm_key

      public static final String jtb_constants_dm_key
      The jtb constants map key in the data model
      See Also:

    • jtb_options_dm_key

      public static final String jtb_options_dm_key
      The jtb options map key in the data model
      See Also:

    • jtb_base_interfaces_dm_key

      public static final String jtb_base_interfaces_dm_key
      The jtb base nodes interfaces list key in the data model
      See Also:

    • jtb_base_nodes_dm_key

      public static final String jtb_base_nodes_dm_key
      The jtb base nodes classes list key in the data model
      See Also:

    • jtb_user_nodes_dm_key

      public static final String jtb_user_nodes_dm_key
      The jtb user nodes map key in the data model
      See Also:

    • jtb_notTbcNodes_dm_key

      public static final String jtb_notTbcNodes_dm_key
      The jtb nodes which must not be created map key in the data model
      See Also:

    • jtb_prod_dm_key

      public static final String jtb_prod_dm_key
      The jtb all nodes map key in the data model
      See Also:

    • jtb_nbSubNodesTbc_dm_key

      public static final String jtb_nbSubNodesTbc_dm_key
      The jtb number of sub-nodes to be created map key in the data model
      See Also:

    • jtbRtPrefix

      public static final String jtbRtPrefix
      The JTB result type variables prefix
      See Also:

    • jtbRtOld

      public static final String jtbRtOld
      The JTB result type save variables prefix
      See Also:

    • jtbNodeVar

      public static final String jtbNodeVar
      The JTB created node variable
      See Also:

    • jtbUserPfx

      public static final String jtbUserPfx
      The JTB created user node variable prefix
      See Also:

    • jtbSigPfx

      public static final String jtbSigPfx
      The JTB created control signature variable prefix
      See Also:

    • sigAnnName

      public static final String sigAnnName
      The signature annotation name

    • sigAnnProcName

      public static final String sigAnnProcName
      The signature annotation processor name

    • DEF_ND_PREFIX

      public static final String DEF_ND_PREFIX
      Default nodes prefix
      See Also:

    • DEF_ND_SUFFIX

      public static final String DEF_ND_SUFFIX
      Default nodes suffix
      See Also:

    • DEF_ND_PKG_NAME

      public static final String DEF_ND_PKG_NAME
      Default nodes package name
      See Also:

    • DEF_VIS_PKG_NAME

      public static final String DEF_VIS_PKG_NAME
      Default visitors package name
      See Also:

    • DEF_SIG_PKG_NAME

      public static final String DEF_SIG_PKG_NAME
      Default signature package name
      See Also:

    • DEF_HOOK_PKG_NAME

      public static final String DEF_HOOK_PKG_NAME
      Default node scope hook package name
      See Also:

    • DEF_ND_DIR_NAME

      public static final String DEF_ND_DIR_NAME
      Default nodes directory name
      See Also:

    • DEF_VIS_DIR_NAME

      public static final String DEF_VIS_DIR_NAME
      Default visitors directory name
      See Also:

    • DEF_SIG_DIR_NAME

      public static final String DEF_SIG_DIR_NAME
      Default signature directory name
      See Also:

    • DEF_HOOK_DIR_NAME

      public static final String DEF_HOOK_DIR_NAME
      Default node scope hook directory name
      See Also:

    • DEF_OUT_FILE_NAME

      public static final String DEF_OUT_FILE_NAME
      Default JavaCC generated grammar file name
      See Also:

    • ptHM

      public static final Map<String,String> ptHM
      A map holding the primitive types (except void)