JavaCCGlobals (parser-generator-cc 1.1.1 API)

java.lang.Object
- com.helger.pgcc.parser.JavaCCGlobals

```
public final class JavaCCGlobals
extends Object
```
This package contains data created as a result of parsing and semanticizing a JavaCC input file. This data is what is used by the back-ends of JavaCC as well as any other back-end of JavaCC related tools such as JJTree.

Field Summary

Fields
Modifier and Type	Field and Description
`static List<NormalProduction>`	`s_bnfproductions` A list of all grammar productions - normal and JAVACODE - in the order they appear in the input file.
`static int`	`s_ccol`
`static int`	`s_cline`
`static List<Token>`	`s_cu_from_insertion_point_2` This is the list of all tokens that appear after the tokens in "cu_to_insertion_point_2" and until "PARSER_END(name)".
`static String`	`s_cu_name` The name of the parser class (what appears in PARSER_BEGIN and PARSER_END).
`static List<Token>`	`s_cu_to_insertion_point_1` This is a list of tokens that appear after "PARSER_BEGIN(name)" all the way until (but not including) the opening brace "{" of the class "name".
`static List<Token>`	`s_cu_to_insertion_point_2` This is the list of all tokens that appear after the tokens in "cu_to_insertion_point_1" and until (but not including) the closing brace "}" of the class "name".
`static String`	`s_fileName` The name of the grammar file being processed.
`protected static int`	`s_jj2index`
`static boolean`	`s_jjtreeGenerated` Set to true if this file has been processed by JJTree.
`static Map<Integer,String>`	`s_lexstate_I2S` A mapping of the internal integer representations of lexical states to their strings.
`static Map<String,Integer>`	`s_lexstate_S2I` A mapping of lexical state strings to their integer internal representation.
`static boolean`	`s_lookaheadNeeded`
`protected static int`	`s_maskindex` maskindex, jj2index, maskVals are variables that are shared between ParseEngine and ParseGen.
`protected static List<int[]>`	`s_maskVals`
`static Map<String,AbstractExpRegularExpression>`	`s_named_tokens_table` This is a symbol table that contains all named tokens (those that are defined with a label).
`static Map<Integer,String>`	`s_names_of_tokens` A mapping of ordinal values (represented as objects of type "Integer") to the corresponding labels (of type "String").
`static List<AbstractExpRegularExpression>`	`s_ordered_named_tokens` Contains the same entries as "named_tokens_table", but this is an ordered list which is ordered by the order of appearance in the input file.
`static String`	`s_origFileName` The name of the original file (before processing by JJTree).
`static Map<String,NormalProduction>`	`s_production_table` A symbol table of all grammar productions - normal and JAVACODE.
`static List<TokenProduction>`	`s_rexprlist` The list of all TokenProductions from the input file.
`static Map<Integer,AbstractExpRegularExpression>`	`s_rexps_of_tokens` A mapping of ordinal values (represented as objects of type "Integer") to the corresponding RegularExpression's.
`static Map<String,Map<String,Map<String,AbstractExpRegularExpression>>>`	`s_simple_tokens_table` This is a three-level symbol table that contains all simple tokens (those that are defined using a single string (with or without a label).
`static List<Token>`	`s_token_mgr_decls` The declarations to be inserted into the TokenManager class.
`static int`	`s_tokenCount` The total number of distinct tokens.
`static List<String>`	`s_toolNames` The list of tools that have participated in generating the input grammar file.

Constructor Summary

Constructors
Constructor and Description

JavaCCGlobals()

Constructors
Constructor and Description
`JavaCCGlobals()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`addEscapes(String str)`
`static String`	`addUnicodeEscapes(String str)`
`static void`	`bannerLine(String fullName, String ver)` This prints the banner line when the various tools are invoked.
`static void`	`createOutputDir(File outputDir)`
`static String`	`getIdString(List<String> toolNames, String fileName)` Returns the identifying string for the file name, given a set of tool names that are used to generate it.
`static String`	`getIdString(String toolName, String fileName)` Returns the identifying string for the file name, given a toolname used to generate it.
`static List<String>`	`getToolNames(String fileName)` Returns a List of names of the tools that have been used to generate the given file.
`static boolean`	`isGeneratedBy(String toolName, String fileName)` Returns true if tool name passed is one of the tool names returned by getToolNames(fileName).
`protected static String`	`printLeadingComments(Token t)`
`protected static void`	`printLeadingComments(Token t, PrintWriter ostr)`
`static String`	`printToken(Token t)`
`static void`	`printToken(Token t, PrintWriter ostr)`
`protected static void`	`printTokenList(List<Token> list, PrintWriter ostr)`
`static String`	`printTokenOnly(Token t)`
`protected static void`	`printTokenOnly(Token t, PrintWriter ostr)`
`static void`	`printTokenSetup(Token t)`
`static String`	`printTrailingComments(Token t)`
`static void`	`reInitStatic()`
`static String`	`replaceBackslash(String str)` Replaces all backslahes with double backslashes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - s_fileName
```
public static String s_fileName
```
    The name of the grammar file being processed.
  - s_origFileName
```
public static String s_origFileName
```
    The name of the original file (before processing by JJTree). Currently this is the same as fileName.
  - s_jjtreeGenerated
```
public static boolean s_jjtreeGenerated
```
    Set to true if this file has been processed by JJTree.
  - s_toolNames
```
public static List<String> s_toolNames
```
    The list of tools that have participated in generating the input grammar file.
  - s_cu_name
```
public static String s_cu_name
```
    The name of the parser class (what appears in PARSER_BEGIN and PARSER_END).
  - s_cu_to_insertion_point_1
```
public static final List<Token> s_cu_to_insertion_point_1
```
    This is a list of tokens that appear after "PARSER_BEGIN(name)" all the way until (but not including) the opening brace "{" of the class "name".
  - s_cu_to_insertion_point_2
```
public static final List<Token> s_cu_to_insertion_point_2
```
    This is the list of all tokens that appear after the tokens in "cu_to_insertion_point_1" and until (but not including) the closing brace "}" of the class "name".
  - s_cu_from_insertion_point_2
```
public static final List<Token> s_cu_from_insertion_point_2
```
    This is the list of all tokens that appear after the tokens in "cu_to_insertion_point_2" and until "PARSER_END(name)".
  - s_bnfproductions
```
public static final List<NormalProduction> s_bnfproductions
```
    A list of all grammar productions - normal and JAVACODE - in the order they appear in the input file. Each entry here will be a subclass of "NormalProduction".
  - s_production_table
```
public static final Map<String,NormalProduction> s_production_table
```
    A symbol table of all grammar productions - normal and JAVACODE. The symbol table is indexed by the name of the left hand side non-terminal. Its contents are of type "NormalProduction".
  - s_lexstate_S2I
```
public static final Map<String,Integer> s_lexstate_S2I
```
    A mapping of lexical state strings to their integer internal representation. Integers are stored as java.lang.Integer's.
  - s_lexstate_I2S
```
public static final Map<Integer,String> s_lexstate_I2S
```
    A mapping of the internal integer representations of lexical states to their strings. Integers are stored as java.lang.Integer's.
  - s_token_mgr_decls
```
public static List<Token> s_token_mgr_decls
```
    The declarations to be inserted into the TokenManager class.
  - s_rexprlist
```
public static final List<TokenProduction> s_rexprlist
```
    The list of all TokenProductions from the input file. This list includes implicit TokenProductions that are created for uses of regular expressions within BNF productions.
  - s_tokenCount
```
public static int s_tokenCount
```
    The total number of distinct tokens. This is therefore one more than the largest assigned token ordinal.
  - s_named_tokens_table
```
public static final Map<String,AbstractExpRegularExpression> s_named_tokens_table
```
    This is a symbol table that contains all named tokens (those that are defined with a label). The index to the table is the image of the label and the contents of the table are of type "RegularExpression".
  - s_ordered_named_tokens
```
public static final List<AbstractExpRegularExpression> s_ordered_named_tokens
```
    Contains the same entries as "named_tokens_table", but this is an ordered list which is ordered by the order of appearance in the input file.
  - s_names_of_tokens
```
public static final Map<Integer,String> s_names_of_tokens
```
    A mapping of ordinal values (represented as objects of type "Integer") to the corresponding labels (of type "String"). An entry exists for an ordinal value only if there is a labeled token corresponding to this entry. If there are multiple labels representing the same ordinal value, then only one label is stored.
  - s_rexps_of_tokens
```
public static final Map<Integer,AbstractExpRegularExpression> s_rexps_of_tokens
```
    A mapping of ordinal values (represented as objects of type "Integer") to the corresponding RegularExpression's.
  - s_simple_tokens_table
```
public static final Map<String,Map<String,Map<String,AbstractExpRegularExpression>>> s_simple_tokens_table
```
    This is a three-level symbol table that contains all simple tokens (those that are defined using a single string (with or without a label). The index to the first level table is a lexical state which maps to a second level hashtable. The index to the second level hashtable is the string of the simple token converted to upper case, and this maps to a third level hashtable. This third level hashtable contains the actual string of the simple token and maps it to its RegularExpression.
  - s_maskindex
```
protected static int s_maskindex
```
    maskindex, jj2index, maskVals are variables that are shared between ParseEngine and ParseGen.
  - s_jj2index
```
protected static int s_jj2index
```
  - s_lookaheadNeeded
```
public static boolean s_lookaheadNeeded
```
  - s_maskVals
```
protected static final List<int[]> s_maskVals
```
  - s_cline
```
public static int s_cline
```
  - s_ccol
```
public static int s_ccol
```
- Constructor Detail
  - JavaCCGlobals
```
public JavaCCGlobals()
```
- Method Detail
  - bannerLine
```
public static void bannerLine(String fullName,
                              String ver)
```
    This prints the banner line when the various tools are invoked. This takes as argument the tool's full name and its version.
  - getIdString
```
public static String getIdString(String toolName,
                                 String fileName)
```
    Returns the identifying string for the file name, given a toolname used to generate it.
  - getIdString
```
public static String getIdString(List<String> toolNames,
                                 String fileName)
```
    Returns the identifying string for the file name, given a set of tool names that are used to generate it.
  - isGeneratedBy
```
public static boolean isGeneratedBy(String toolName,
                                    String fileName)
```
    Returns true if tool name passed is one of the tool names returned by getToolNames(fileName).
  - getToolNames
```
@Nonnull
public static List<String> getToolNames(String fileName)
```
    Returns a List of names of the tools that have been used to generate the given file.
  - createOutputDir
```
public static void createOutputDir(File outputDir)
```
  - addEscapes
```
@Nonnull
public static String addEscapes(@Nonnull
                                          String str)
```
  - addUnicodeEscapes
```
public static String addUnicodeEscapes(String str)
```
  - printTokenSetup
```
public static void printTokenSetup(Token t)
```
  - printTokenOnly
```
protected static void printTokenOnly(Token t,
                                     PrintWriter ostr)
```
  - printToken
```
public static void printToken(Token t,
                              PrintWriter ostr)
```
  - printTokenList
```
protected static void printTokenList(List<Token> list,
                                     PrintWriter ostr)
```
  - printLeadingComments
```
protected static void printLeadingComments(Token t,
                                           PrintWriter ostr)
```
  - printTokenOnly
```
@Nonnull
public static String printTokenOnly(@Nonnull
                                              Token t)
```
  - printToken
```
@Nonnull
public static String printToken(@Nonnull
                                          Token t)
```
  - printLeadingComments
```
@Nonnull
protected static String printLeadingComments(@Nonnull
                                                       Token t)
```
  - printTrailingComments
```
@Nonnull
public static String printTrailingComments(@Nonnull
                                                     Token t)
```
  - reInitStatic
```
public static void reInitStatic()
```
  - replaceBackslash
```
public static String replaceBackslash(String str)
```
    Replaces all backslahes with double backslashes.

Class JavaCCGlobals

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

s_fileName

s_origFileName

s_jjtreeGenerated

s_toolNames

s_cu_name

s_cu_to_insertion_point_1

s_cu_to_insertion_point_2

s_cu_from_insertion_point_2

s_bnfproductions

s_production_table

s_lexstate_S2I

s_lexstate_I2S

s_token_mgr_decls

s_rexprlist

s_tokenCount

s_named_tokens_table

s_ordered_named_tokens

s_names_of_tokens

s_rexps_of_tokens

s_simple_tokens_table

s_maskindex

s_jj2index

s_lookaheadNeeded

s_maskVals

s_cline

s_ccol

Constructor Detail

JavaCCGlobals

Method Detail

bannerLine

getIdString

getIdString

isGeneratedBy

getToolNames

createOutputDir

addEscapes

addUnicodeEscapes

printTokenSetup

printTokenOnly

printToken

printTokenList

printLeadingComments

printTokenOnly

printToken

printLeadingComments

printTrailingComments

reInitStatic

replaceBackslash