| java.lang.Object
 antlr.CodeGenerator
antlr.JavaCodeGenerator
| JavaCodeGenerator | | public class JavaCodeGenerator extends CodeGenerator (Code) | | Generate MyParser.java, MyLexer.java and MyParserTokenTypes.java
|
| Constructor Summary | |
| public | JavaCodeGenerator()
Create a Java code-generator using the given Grammar. |
| Method Summary | |
| protected void | _print(String code)
| | protected void | _print(String code, int sourceStartLine)
| | protected void | _println(String code)
| | protected void | _println(String code, int sourceStartLine)
| | protected int | addSemPred(String predicate)
Adds a semantic predicate string to the sem pred vector
These strings will be used to build an array of sem pred names
when building a debugging parser. | | public void | exitIfError()
| | public void | gen()
| | public void | gen(ActionElement action, Context context)
Generate code for the given grammar element. | | public void | gen(AlternativeBlock blk, Context context)
Generate code for the given grammar element. | | public void | gen(BlockEndElement end, Context context)
Generate code for the given grammar element.
Parameters:
blk - The block-end element to generate. | | public void | gen(CharLiteralElement atom, Context context)
Generate code for the given grammar element. | | public void | gen(CharRangeElement r, Context context)
Generate code for the given grammar element. | | public void | gen(LexerGrammar g)
| | public void | gen(OneOrMoreBlock blk, Context context)
Generate code for the given grammar element. | | public void | gen(ParserGrammar g)
| | public void | gen(RuleRefElement rr, Context context)
Generate code for the given grammar element. | | public void | gen(StringLiteralElement atom, Context context)
Generate code for the given grammar element. | | public void | gen(TokenRangeElement r, Context context)
Generate code for the given grammar element. | | public void | gen(TokenRefElement atom, Context context)
Generate code for the given grammar element. | | public void | gen(TreeElement t, Context context)
| | public void | gen(TreeWalkerGrammar g)
| | public void | gen(WildcardElement wc, Context context)
Generate code for the given grammar element. | | public void | gen(ZeroOrMoreBlock blk, Context context)
Generate code for the given grammar element. | | protected void | genASTDeclaration(AlternativeElement el)
| | protected void | genASTDeclaration(AlternativeElement el, String node_type)
| | protected void | genASTDeclaration(AlternativeElement el, String var_name, String node_type)
| | protected void | genAlt(Alternative alt, AlternativeBlock blk, Context context)
Generate an alternative. | | protected void | genBitsets(Vector bitsetList, int maxVocabulary)
Generate all the bitsets to be used in the parser or lexer
Generate the raw bitset data like "long _tokenSet1_data[] = {...};"
and the BitSet object declarations like "BitSet _tokenSet1 = new BitSet(_tokenSet1_data);"
Note that most languages do not support object initialization inside a
class definition, so other code-generators may have to separate the
bitset declarations from the initializations (e.g., put the initializations
in the generated constructor instead). | | protected void | genBlockInitAction(AlternativeBlock blk, Context context)
Generate the init action for a block, which may be a RuleBlock or a
plain AlternativeBLock. | | protected void | genBlockPreamble(AlternativeBlock blk)
Generate the header for a block, which may be a RuleBlock or a
plain AlternativeBLock. | | protected void | genCases(BitSet p, int line)
Generate a series of case statements that implement a BitSet test. | | public JavaBlockFinishingInfo | genCommonBlock(AlternativeBlock blk, boolean noTestForSingle, Context context)
Generate common code for a block of alternatives; return a
postscript that needs to be generated at the end of the
block. | | protected void | genHeader()
| | protected void | genMatch(BitSet b)
| | protected void | genMatch(GrammarAtom atom)
| | protected void | genMatchUsingAtomText(GrammarAtom atom)
| | protected void | genMatchUsingAtomTokenType(GrammarAtom atom)
| | public void | genNextToken()
Generate the nextToken() rule. | | public void | genRule(RuleSymbol s, boolean startSymbol, int ruleNum, Context context)
Gen a named rule block. | | protected void | genSemPred(String pred, int line, Context context)
| | protected void | genSemPredMap()
Write an array of Strings which are the semantic predicate
expressions. | | protected void | genSynPred(SynPredBlock blk, String lookaheadExpr, Context context)
| | protected void | genTokenASTCreateMethod()
| | protected void | genTokenASTNodeMap()
Create and set Integer token type objects that map
to Java Class objects (which AST node to create). | | public void | genTokenStrings()
Generate a static array containing the names of the tokens,
indexed by the token type values. | | protected void | genTokenTypes(TokenManager tm)
| | public String | getASTCreateString(Vector v)
Get a string for an expression to generate creation of an AST subtree. | | public String | getASTCreateString(GrammarAtom atom, String astCtorArgs)
| | public String | getASTCreateString(String astCtorArgs)
Get a string for an expression to generate creating of an AST node.
Parse the first (possibly only) argument looking for the token type.
If the token type is a valid token symbol, ask for it's AST node type
and add to the end if only 2 arguments. | | public String | getCheckString(Context context)
| | protected String | getLookaheadTestExpression(Lookahead[] look, int k, int gr)
| | protected String | getLookaheadTestExpression(Alternative alt, int maxDepth, int gr)
Generate a lookahead test expression for an alternate. | | protected String | getLookaheadTestTerm(int k, BitSet p, int gr)
Generate a depth==1 lookahead test expression given the BitSet. | | public JavaCodeGeneratorPrintWriterManager | getPrintWriterManager()
| | public String | getRangeExpression(int k, int[] elems, int gr)
Return an expression for testing a contiguous renage of elements
Parameters:
k - The lookahead level
Parameters:
elems - The elements representing the set, usually from BitSet.toArray(). | | protected String | getThrowNoViableStr(Context context)
| | protected boolean | lookaheadIsEmpty(Alternative alt, int maxDepth)
| | public String | mapTreeId(String idParam, ActionTransInfo transInfo)
Map an identifier to it's corresponding tree-node variable. | | protected void | print(String code)
| | protected void | print(String code, int sourceStartLine)
| | protected void | printAction(String code)
| | protected void | printAction(String code, int sourceStartLine)
| | public void | printCheck(Context context)
| | public void | printLoopEnd(String label)
| | public void | printLoopStart(String label)
| | public void | println(String code)
| | public void | println(String code, int sourceStartLine)
| | protected String | processActionForSpecialSymbols(String actionStr, int line, RuleBlock currentRule, ActionTransInfo tInfo)
Lexically process $var and tree-specifiers in the action. | | public void | setPrintWriterManager(JavaCodeGeneratorPrintWriterManager printWriterManager)
| | public void | setTool(Tool tool)
|
| CONTINUE_LAST_MAPPING | | final public static int CONTINUE_LAST_MAPPING(Code) | | Constant to indicate that we should continue mapping based on the
last mapping seen by the SMAP generator (there may have been
intermediate mappings generated by nested elements)
|
| NONUNIQUE | | final protected static String NONUNIQUE(Code) | | Special value used to mark duplicate in treeVariableMap
|
| NO_MAPPING | | final public static int NO_MAPPING(Code) | | Constant to indicate that we shouldn't generate a mapping entry
|
| RECOVER_AST | | final public static boolean RECOVER_AST(Code) | | |
| astVarNumber | | int astVarNumber(Code) | | |
| caseSizeThreshold | | final public static int caseSizeThreshold(Code) | | |
| currentASTResult | | String currentASTResult(Code) | | Tracks the rule or labeled subrule being generated. Used for
AST generation.
|
| currentRule | | RuleBlock currentRule(Code) | | Tracks the rule being generated. Used for mapTreeId
|
| declaredASTVariables | | Hashtable declaredASTVariables(Code) | | Used to keep track of which AST variables have been defined in a rule
(except for the #rule_name and #rule_name_in var's
|
| genAST | | protected boolean genAST(Code) | | |
| loopCount | | public int loopCount(Code) | | |
| saveText | | protected boolean saveText(Code) | | |
| syntacticPredLevel | | protected int syntacticPredLevel(Code) | | |
| treeVariableMap | | Hashtable treeVariableMap(Code) | | Mapping between the ids used in the current alt, and the
names of variables used to represent their AST values.
|
| JavaCodeGenerator | | public JavaCodeGenerator()(Code) | | Create a Java code-generator using the given Grammar.
The caller must still call setTool, setBehavior, and setAnalyzer
before generating code.
|
| _print | | protected void _print(String code, int sourceStartLine)(Code) | | |
| _println | | protected void _println(String code, int sourceStartLine)(Code) | | |
| addSemPred | | protected int addSemPred(String predicate)(Code) | | Adds a semantic predicate string to the sem pred vector
These strings will be used to build an array of sem pred names
when building a debugging parser. This method should only be
called when the debug option is specified
|
| exitIfError | | public void exitIfError()(Code) | | |
| gen | | public void gen()(Code) | | Generate the parser, lexer, treeparser, and token types in Java
|
| gen | | public void gen(ActionElement action, Context context)(Code) | | Generate code for the given grammar element.
Parameters:
blk - The {...} action to generate |
| gen | | public void gen(AlternativeBlock blk, Context context)(Code) | | Generate code for the given grammar element.
Parameters:
blk - The "x|y|z|..." block to generate |
| gen | | public void gen(BlockEndElement end, Context context)(Code) | | Generate code for the given grammar element.
Parameters:
blk - The block-end element to generate. Block-endelements are synthesized by the grammar parser to representthe end of a block. |
| gen | | public void gen(CharLiteralElement atom, Context context)(Code) | | Generate code for the given grammar element.
Parameters:
blk - The character literal reference to generate |
| gen | | public void gen(CharRangeElement r, Context context)(Code) | | Generate code for the given grammar element.
Parameters:
blk - The character-range reference to generate |
| gen | | public void gen(OneOrMoreBlock blk, Context context)(Code) | | Generate code for the given grammar element.
Parameters:
blk - The (...)+ block to generate |
| gen | | public void gen(RuleRefElement rr, Context context)(Code) | | Generate code for the given grammar element.
Parameters:
blk - The rule-reference to generate |
| gen | | public void gen(StringLiteralElement atom, Context context)(Code) | | Generate code for the given grammar element.
Parameters:
blk - The string-literal reference to generate |
| gen | | public void gen(TokenRangeElement r, Context context)(Code) | | Generate code for the given grammar element.
Parameters:
r - The token-range reference to generate |
| gen | | public void gen(TokenRefElement atom, Context context)(Code) | | Generate code for the given grammar element.
Parameters:
blk - The token-reference to generate |
| gen | | public void gen(WildcardElement wc, Context context)(Code) | | Generate code for the given grammar element.
Parameters:
wc - The wildcard element to generate |
| gen | | public void gen(ZeroOrMoreBlock blk, Context context)(Code) | | Generate code for the given grammar element.
Parameters:
blk - The (...)* block to generate |
| genAlt | | protected void genAlt(Alternative alt, AlternativeBlock blk, Context context)(Code) | | Generate an alternative.
Parameters:
alt - The alternative to generate
Parameters:
blk - The block to which the alternative belongs |
| genBitsets | | protected void genBitsets(Vector bitsetList, int maxVocabulary)(Code) | | Generate all the bitsets to be used in the parser or lexer
Generate the raw bitset data like "long _tokenSet1_data[] = {...};"
and the BitSet object declarations like "BitSet _tokenSet1 = new BitSet(_tokenSet1_data);"
Note that most languages do not support object initialization inside a
class definition, so other code-generators may have to separate the
bitset declarations from the initializations (e.g., put the initializations
in the generated constructor instead).
Parameters:
bitsetList - The list of bitsets to generate.
Parameters:
maxVocabulary - Ensure that each generated bitset can contain at least this value. |
| genBlockInitAction | | protected void genBlockInitAction(AlternativeBlock blk, Context context)(Code) | | Generate the init action for a block, which may be a RuleBlock or a
plain AlternativeBLock.
|
| genBlockPreamble | | protected void genBlockPreamble(AlternativeBlock blk)(Code) | | Generate the header for a block, which may be a RuleBlock or a
plain AlternativeBLock. This generates any variable declarations
and syntactic-predicate-testing variables.
|
| genCases | | protected void genCases(BitSet p, int line)(Code) | | Generate a series of case statements that implement a BitSet test.
Parameters:
p - The Bitset for which cases are to be generated |
| genCommonBlock | | public JavaBlockFinishingInfo genCommonBlock(AlternativeBlock blk, boolean noTestForSingle, Context context)(Code) | | Generate common code for a block of alternatives; return a
postscript that needs to be generated at the end of the
block. Other routines may append else-clauses and such for
error checking before the postfix is generated. If the
grammar is a lexer, then generate alternatives in an order
where alternatives requiring deeper lookahead are generated
first, and EOF in the lookahead set reduces the depth of
the lookahead. @param blk The block to generate @param
noTestForSingle If true, then it does not generate a test
for a single alternative.
|
| genHeader | | protected void genHeader()(Code) | | Generate a header that is common to all Java files
|
| genMatchUsingAtomTokenType | | protected void genMatchUsingAtomTokenType(GrammarAtom atom)(Code) | | |
| genNextToken | | public void genNextToken()(Code) | | Generate the nextToken() rule. nextToken() is a synthetic
lexer rule that is the implicit OR of all user-defined
lexer rules.
|
| genRule | | public void genRule(RuleSymbol s, boolean startSymbol, int ruleNum, Context context)(Code) | | Gen a named rule block.
ASTs are generated for each element of an alternative unless
the rule or the alternative have a '!' modifier.
If an alternative defeats the default tree construction, it
must set _AST to the root of the returned AST.
Each alternative that does automatic tree construction, builds
up root and child list pointers in an ASTPair structure.
A rule finishes by setting the returnAST variable from the
ASTPair.
Parameters:
rule - The name of the rule to generate
Parameters:
startSymbol - true if the rule is a start symbol (i.e., not referenced elsewhere) |
| genSemPredMap | | protected void genSemPredMap()(Code) | | Write an array of Strings which are the semantic predicate
expressions. The debugger will reference them by number only
|
| genTokenASTCreateMethod | | protected void genTokenASTCreateMethod()(Code) | | |
| genTokenASTNodeMap | | protected void genTokenASTNodeMap()(Code) | | Create and set Integer token type objects that map
to Java Class objects (which AST node to create).
|
| genTokenStrings | | public void genTokenStrings()(Code) | | Generate a static array containing the names of the tokens,
indexed by the token type values. This static array is used
to format error messages so that the token identifers or literal
strings are displayed instead of the token numbers.
If a lexical rule has a paraphrase, use it rather than the
token label.
|
| getASTCreateString | | public String getASTCreateString(Vector v)(Code) | | Get a string for an expression to generate creation of an AST subtree.
Parameters:
v - A Vector of String, where each element is an expression in the target language yielding an AST node. |
| getASTCreateString | | public String getASTCreateString(GrammarAtom atom, String astCtorArgs)(Code) | | Get a string for an expression to generate creating of an AST node
Parameters:
atom - The grammar node for which you are creating the node
Parameters:
str - The arguments to the AST constructor |
| getASTCreateString | | public String getASTCreateString(String astCtorArgs)(Code) | | Get a string for an expression to generate creating of an AST node.
Parse the first (possibly only) argument looking for the token type.
If the token type is a valid token symbol, ask for it's AST node type
and add to the end if only 2 arguments. The forms are #[T], #[T,"t"],
and as of 2.7.2 #[T,"t",ASTclassname].
Parameters:
str - The arguments to the AST constructor |
| getLookaheadTestExpression | | protected String getLookaheadTestExpression(Lookahead[] look, int k, int gr)(Code) | | |
| getLookaheadTestExpression | | protected String getLookaheadTestExpression(Alternative alt, int maxDepth, int gr)(Code) | | Generate a lookahead test expression for an alternate. This
will be a series of tests joined by '&&' and enclosed by '()',
the number of such tests being determined by the depth of the lookahead.
|
| getLookaheadTestTerm | | protected String getLookaheadTestTerm(int k, BitSet p, int gr)(Code) | | Generate a depth==1 lookahead test expression given the BitSet.
This may be one of:
1) a series of 'x==X||' tests
2) a range test using >= && <= where possible,
3) a bitset membership test for complex comparisons
Parameters:
k - The lookahead level
Parameters:
p - The lookahead set for level k |
| getRangeExpression | | public String getRangeExpression(int k, int[] elems, int gr)(Code) | | Return an expression for testing a contiguous renage of elements
Parameters:
k - The lookahead level
Parameters:
elems - The elements representing the set, usually from BitSet.toArray(). String containing test expression. |
| lookaheadIsEmpty | | protected boolean lookaheadIsEmpty(Alternative alt, int maxDepth)(Code) | | Is the lookahead for this alt empty?
|
| mapTreeId | | public String mapTreeId(String idParam, ActionTransInfo transInfo)(Code) | | Map an identifier to it's corresponding tree-node variable.
This is context-sensitive, depending on the rule and alternative
being generated
Parameters:
idParam - The identifier name to map The mapped id (which may be the same as the input), or null if the mapping is invalid due to duplicates |
| print | | protected void print(String code, int sourceStartLine)(Code) | | |
| printAction | | protected void printAction(String code, int sourceStartLine)(Code) | | |
| printLoopStart | | public void printLoopStart(String label)(Code) | | |
| println | | public void println(String code, int sourceStartLine)(Code) | | |
| processActionForSpecialSymbols | | protected String processActionForSpecialSymbols(String actionStr, int line, RuleBlock currentRule, ActionTransInfo tInfo)(Code) | | Lexically process $var and tree-specifiers in the action.
This will replace #id and #(...) with the appropriate
function calls and/or variables etc...
|
| Methods inherited from antlr.CodeGenerator | protected void _print(String s)(Code)(Java Doc)
protected void _printAction(String s)(Code)(Java Doc)
protected void _println(String s)(Code)(Java Doc)
public static String decodeLexerRuleName(String id)(Code)(Java Doc)
public static boolean elementsAreRange(int[] elems)(Code)(Java Doc)
public static String encodeLexerRuleName(String id)(Code)(Java Doc)
protected String extractIdOfAction(Token t)(Code)(Java Doc)
protected String extractIdOfAction(String s, int line, int column)(Code)(Java Doc)
protected String extractTypeOfAction(Token t)(Code)(Java Doc)
protected String extractTypeOfAction(String s, int line, int column)(Code)(Java Doc)
abstract public void gen()(Code)(Java Doc)
abstract public void gen(ActionElement action, Context context)(Code)(Java Doc)
abstract public void gen(AlternativeBlock blk, Context context)(Code)(Java Doc)
abstract public void gen(BlockEndElement end, Context context)(Code)(Java Doc)
abstract public void gen(CharLiteralElement atom, Context context)(Code)(Java Doc)
abstract public void gen(CharRangeElement r, Context context)(Code)(Java Doc)
abstract public void gen(LexerGrammar g) throws IOException(Code)(Java Doc)
abstract public void gen(OneOrMoreBlock blk, Context context)(Code)(Java Doc)
abstract public void gen(ParserGrammar g) throws IOException(Code)(Java Doc)
abstract public void gen(RuleRefElement rr, Context context)(Code)(Java Doc)
abstract public void gen(StringLiteralElement atom, Context context)(Code)(Java Doc)
abstract public void gen(TokenRangeElement r, Context context)(Code)(Java Doc)
abstract public void gen(TokenRefElement atom, Context context)(Code)(Java Doc)
abstract public void gen(TreeElement t, Context context)(Code)(Java Doc)
abstract public void gen(TreeWalkerGrammar g) throws IOException(Code)(Java Doc)
abstract public void gen(WildcardElement wc, Context context)(Code)(Java Doc)
abstract public void gen(ZeroOrMoreBlock blk, Context context)(Code)(Java Doc)
protected void genTokenInterchange(TokenManager tm) throws IOException(Code)(Java Doc)
abstract public String getASTCreateString(Vector v)(Code)(Java Doc)
abstract public String getASTCreateString(GrammarAtom atom, String str)(Code)(Java Doc)
protected String getBitsetName(int index)(Code)(Java Doc)
public String getFIRSTBitSet(String ruleName, int k)(Code)(Java Doc)
public String getFOLLOWBitSet(String ruleName, int k)(Code)(Java Doc)
abstract public String mapTreeId(String id, ActionTransInfo tInfo)(Code)(Java Doc)
protected int markBitsetForGen(BitSet p)(Code)(Java Doc)
protected void print(String s)(Code)(Java Doc)
protected void printAction(String s)(Code)(Java Doc)
protected void printTabs()(Code)(Java Doc)
protected void println(String s)(Code)(Java Doc)
abstract protected String processActionForSpecialSymbols(String actionStr, int line, RuleBlock currentRule, ActionTransInfo tInfo)(Code)(Java Doc)
public String processStringForASTConstructor(String str)(Code)(Java Doc)
protected String removeAssignmentFromDeclaration(String d)(Code)(Java Doc)
public static String reverseLexerRuleName(String id)(Code)(Java Doc)
public void setAnalyzer(LLkGrammarAnalyzer analyzer_)(Code)(Java Doc)
public void setBehavior(DefineGrammarSymbols behavior_)(Code)(Java Doc)
protected void setGrammar(Grammar g)(Code)(Java Doc)
public void setTool(Tool tool)(Code)(Java Doc)
|
|
|