Package EDU.purdue.jtb.common

Class Constants

  • public class Constants
extends java.lang.Object
    Class Constants contains static global flags, constants and names.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String[] baseNodesClasses
      The list of base nodes classes
      static java.lang.String[] baseNodesInterfaces
      The array of base nodes interfaces
      static int BRLEN
      The javadoc break plus string length
      static java.lang.String BRLS
      The javadoc break plus the OS line separator
      static int BRLSLEN
      The javadoc break plus the OS line separator string length
      static boolean DEBUG_CLASS
      Turns on / off printing class debug comments (useful to find where each line is produced)
      static boolean DEBUG_COMMENT
      Turns on / off printing field and sub comment debug comments
      static java.lang.String DEF_HOOK_DIR_NAME
      Default node scope hook directory name
      static java.lang.String DEF_HOOK_PKG_NAME
      Default node scope hook package name
      static java.lang.String DEF_ND_DIR_NAME
      Default nodes directory name
      static java.lang.String DEF_ND_PKG_NAME
      Default nodes package name
      static java.lang.String DEF_ND_PREFIX
      Default nodes prefix
      static java.lang.String DEF_ND_SUFFIX
      Default nodes suffix
      static java.lang.String DEF_OUT_FILE_NAME
      Default JavaCC generated grammar file name
      static java.lang.String DEF_SIG_DIR_NAME
      Default signature directory name
      static java.lang.String DEF_SIG_PKG_NAME
      Default signature package name
      static java.lang.String DEF_VIS_DIR_NAME
      Default visitors directory name
      static java.lang.String DEF_VIS_PKG_NAME
      Default visitors package name
      static java.lang.String emptyEnterExitHook
      The node scope hook empty class name
      static int FILE_EXISTS_RC
      The "file exists" return code
      static java.lang.String fileHeaderComment
      File header comment
      static java.lang.String genArguVar
      Visitor methods user argument (second and more arguments) variable
      static java.lang.String genDepthLevelVar
      Visitor methods depth level local variable
      static java.lang.String genNodeVar
      Visitor methods node argument (first argument) variable
      static java.lang.String genNodeVarDot
      Visitor methods node argument (first argument) variable plus dot
      static java.lang.String genRetVar
      Visitor methods return variable
      static java.lang.String genVisVar
      Accept methods visitor variable
      static java.lang.String iEnterExitHook
      The node scope hook interface name
      static int INDENT_AMT
      The indentation default number of characters
      static java.lang.String iNode
      Name of the node interface that all tree nodes implement
      static java.lang.String iNodeList
      Name of the list interface that NodeList, NodeListOptional and NodeSequence implement
      static java.lang.String jjToken
      Name of the (generated by JavaCC) class representing a token
      static java.lang.String jtb_base_interfaces_dm_key
      The jtb base nodes interfaces list key in the data model
      static java.lang.String jtb_base_nodes_dm_key
      The jtb base nodes classes list key in the data model
      static java.lang.String jtb_constants_dm_key
      The jtb constants map key in the data model
      static java.lang.String jtb_nbSubNodesTbc_dm_key
      The jtb number of sub-nodes to be created map key in the data model
      static java.lang.String jtb_notTbcNodes_dm_key
      The jtb nodes which must not be created map key in the data model
      static java.lang.String jtb_options_dm_key
      The jtb options map key in the data model
      static java.lang.String jtb_prod_dm_key
      The jtb all nodes map key in the data model
      static java.lang.String jtb_user_nodes_dm_key
      The jtb user nodes map key in the data model
      static java.lang.String JTB_VERSION
      The program version
      static java.lang.String jtbEgInvokedMethode
      The external generator class method to be invoked
      static java.lang.String jtbHookEnter
      The enter node scope hook method name
      static java.lang.String jtbHookExit
      The exit node scope hook method name
      static java.lang.String jtbHookVar
      The JTB node scope hook variable name
      static java.lang.String jtbNodeVar
      The JTB created node variable
      static java.lang.String jtbRtOld
      The JTB result type save variables prefix
      static java.lang.String jtbRtPrefix
      The JTB result type variables prefix
      static java.lang.String jtbSigPfx
      The JTB created control signature variable prefix
      static java.lang.String jtbUserPfx
      The JTB created user node variable prefix
      static java.lang.String LS
      The OS line separator string
      static char LS0
      The OS line separator first character
      static int LSLEN
      The OS line separator string length
      static java.lang.String nodeChoice
      Name of the node class representing a grammar choice such as ( A | B )
      static java.lang.String nodeConstants
      Name of the node class holding the constants reflecting the generated classes "
      static java.lang.String nodeList
      Name of the node class representing a list such as ( A )+
      static java.lang.String nodeListOptional
      Name of the node class representing an optional list such as (A )*
      static java.lang.String nodeOptional
      Name of the node class representing an optional such as [ A ] or ( A )?
      static java.lang.String nodeSequence
      Name of the node class representing a nested sequence of nodes
      static java.lang.String nodeToken
      Name of the (generated by JavaCC) class representing a token; same as jjToken
      static int OK_RC
      The "OK" return code
      static java.lang.String PROG_NAME
      The java program name
      static java.util.Map<java.lang.String,​java.lang.String> ptHM
      A map holding the primitive types (except void)
      static long SERIALVERSIONUID
      The serial version uid
      static java.lang.String sigAnnName
      The signature annotation name
      static java.lang.String sigAnnProcName
      The signature annotation processor name
      static java.lang.String SUPPORT
      An indication in case of JTB internal errors
      static java.lang.String treeDumperName
      The TreeDumpervisitor class name
      static java.lang.String treeFormatterName
      The TreeFormatter visitor class name

    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • 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:
        Constant Field Values

      • DEBUG_COMMENT

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

      • JTB_VERSION

        public static final java.lang.String JTB_VERSION
        The program version
        See Also:
        Constant Field Values

      • SERIALVERSIONUID

        public static final long SERIALVERSIONUID
        The serial version uid

      • PROG_NAME

        public static final java.lang.String PROG_NAME
        The java program name
        See Also:
        Constant Field Values

      • fileHeaderComment

        public static final java.lang.String fileHeaderComment
        File header comment
        See Also:
        Constant Field Values

      • SUPPORT

        public static final java.lang.String SUPPORT
        An indication in case of JTB internal errors
        See Also:
        Constant Field Values

      • INDENT_AMT

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

      • LS

        public static final java.lang.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 java.lang.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

      • FILE_EXISTS_RC

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

      • iNode

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

      • iNodeList

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

      • nodeChoice

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

      • nodeList

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

      • nodeListOptional

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

      • nodeOptional

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

      • nodeSequence

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

      • nodeToken

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

      • jjToken

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

      • baseNodesInterfaces

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

      • baseNodesClasses

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

      • nodeConstants

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

      • treeFormatterName

        public static final java.lang.String treeFormatterName
        The TreeFormatter visitor class name
        See Also:
        Constant Field Values

      • treeDumperName

        public static final java.lang.String treeDumperName
        The TreeDumpervisitor class name
        See Also:
        Constant Field Values

      • genVisVar

        public static final java.lang.String genVisVar
        Accept methods visitor variable
        See Also:
        Constant Field Values

      • genRetVar

        public static final java.lang.String genRetVar
        Visitor methods return variable
        See Also:
        Constant Field Values

      • genNodeVar

        public static final java.lang.String genNodeVar
        Visitor methods node argument (first argument) variable
        See Also:
        Constant Field Values

      • genNodeVarDot

        public static final java.lang.String genNodeVarDot
        Visitor methods node argument (first argument) variable plus dot
        See Also:
        Constant Field Values

      • genArguVar

        public static final java.lang.String genArguVar
        Visitor methods user argument (second and more arguments) variable
        See Also:
        Constant Field Values

      • genDepthLevelVar

        public static final java.lang.String genDepthLevelVar
        Visitor methods depth level local variable
        See Also:
        Constant Field Values

      • jtbHookVar

        public static final java.lang.String jtbHookVar
        The JTB node scope hook variable name
        See Also:
        Constant Field Values

      • iEnterExitHook

        public static final java.lang.String iEnterExitHook
        The node scope hook interface name
        See Also:
        Constant Field Values

      • emptyEnterExitHook

        public static final java.lang.String emptyEnterExitHook
        The node scope hook empty class name
        See Also:
        Constant Field Values

      • jtbHookEnter

        public static final java.lang.String jtbHookEnter
        The enter node scope hook method name
        See Also:
        Constant Field Values

      • jtbHookExit

        public static final java.lang.String jtbHookExit
        The exit node scope hook method name
        See Also:
        Constant Field Values

      • jtbEgInvokedMethode

        public static final java.lang.String jtbEgInvokedMethode
        The external generator class method to be invoked
        See Also:
        Constant Field Values

      • jtb_constants_dm_key

        public static final java.lang.String jtb_constants_dm_key
        The jtb constants map key in the data model
        See Also:
        Constant Field Values

      • jtb_options_dm_key

        public static final java.lang.String jtb_options_dm_key
        The jtb options map key in the data model
        See Also:
        Constant Field Values

      • jtb_base_interfaces_dm_key

        public static final java.lang.String jtb_base_interfaces_dm_key
        The jtb base nodes interfaces list key in the data model
        See Also:
        Constant Field Values

      • jtb_base_nodes_dm_key

        public static final java.lang.String jtb_base_nodes_dm_key
        The jtb base nodes classes list key in the data model
        See Also:
        Constant Field Values

      • jtb_user_nodes_dm_key

        public static final java.lang.String jtb_user_nodes_dm_key
        The jtb user nodes map key in the data model
        See Also:
        Constant Field Values

      • jtb_notTbcNodes_dm_key

        public static final java.lang.String jtb_notTbcNodes_dm_key
        The jtb nodes which must not be created map key in the data model
        See Also:
        Constant Field Values

      • jtb_prod_dm_key

        public static final java.lang.String jtb_prod_dm_key
        The jtb all nodes map key in the data model
        See Also:
        Constant Field Values

      • jtb_nbSubNodesTbc_dm_key

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

      • jtbRtPrefix

        public static final java.lang.String jtbRtPrefix
        The JTB result type variables prefix
        See Also:
        Constant Field Values

      • jtbRtOld

        public static final java.lang.String jtbRtOld
        The JTB result type save variables prefix
        See Also:
        Constant Field Values

      • jtbNodeVar

        public static final java.lang.String jtbNodeVar
        The JTB created node variable
        See Also:
        Constant Field Values

      • jtbUserPfx

        public static final java.lang.String jtbUserPfx
        The JTB created user node variable prefix
        See Also:
        Constant Field Values

      • jtbSigPfx

        public static final java.lang.String jtbSigPfx
        The JTB created control signature variable prefix
        See Also:
        Constant Field Values

      • sigAnnName

        public static final java.lang.String sigAnnName
        The signature annotation name

      • sigAnnProcName

        public static final java.lang.String sigAnnProcName
        The signature annotation processor name

      • DEF_ND_PREFIX

        public static final java.lang.String DEF_ND_PREFIX
        Default nodes prefix
        See Also:
        Constant Field Values

      • DEF_ND_SUFFIX

        public static final java.lang.String DEF_ND_SUFFIX
        Default nodes suffix
        See Also:
        Constant Field Values

      • DEF_ND_PKG_NAME

        public static final java.lang.String DEF_ND_PKG_NAME
        Default nodes package name
        See Also:
        Constant Field Values

      • DEF_VIS_PKG_NAME

        public static final java.lang.String DEF_VIS_PKG_NAME
        Default visitors package name
        See Also:
        Constant Field Values

      • DEF_SIG_PKG_NAME

        public static final java.lang.String DEF_SIG_PKG_NAME
        Default signature package name
        See Also:
        Constant Field Values

      • DEF_HOOK_PKG_NAME

        public static final java.lang.String DEF_HOOK_PKG_NAME
        Default node scope hook package name
        See Also:
        Constant Field Values

      • DEF_ND_DIR_NAME

        public static final java.lang.String DEF_ND_DIR_NAME
        Default nodes directory name
        See Also:
        Constant Field Values

      • DEF_VIS_DIR_NAME

        public static final java.lang.String DEF_VIS_DIR_NAME
        Default visitors directory name
        See Also:
        Constant Field Values

      • DEF_SIG_DIR_NAME

        public static final java.lang.String DEF_SIG_DIR_NAME
        Default signature directory name
        See Also:
        Constant Field Values

      • DEF_HOOK_DIR_NAME

        public static final java.lang.String DEF_HOOK_DIR_NAME
        Default node scope hook directory name
        See Also:
        Constant Field Values

      • DEF_OUT_FILE_NAME

        public static final java.lang.String DEF_OUT_FILE_NAME
        Default JavaCC generated grammar file name
        See Also:
        Constant Field Values

      • ptHM

        public static final java.util.Map<java.lang.String,​java.lang.String> ptHM
        A map holding the primitive types (except void)