antlr

Class CppCodeGenerator

public class CppCodeGenerator extends CodeGenerator

Generate MyParser.cpp, MyParser.hpp, MyLexer.cpp, MyLexer.hpp and MyParserTokenTypes.hpp
Field Summary
intastVarNumber
static intcaseSizeThreshold
StringcommonExtraArgs
StringcommonExtraParams
StringcommonLocalVars
StringcurrentASTResult
RuleBlockcurrentRule
HashtabledeclaredASTVariables
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
booleanDEBUG_CPP_CODE_GENERATOR
StringexceptionThrown
protected booleangenAST
protected booleangenHashLines
StringlabeledElementASTInit
StringlabeledElementASTType
StringlabeledElementInit
StringlabeledElementType
Stringlt1Value
protected booleannoConstructors
protected static StringNONUNIQUE
protected StringoutputFile
protected intoutputLine
protected booleansaveText
protected intsyntacticPredLevel
StringthrowNoViable
HashtabletreeVariableMap
booleanusingCustomAST
Constructor Summary
CppCodeGenerator()
Create a C++ code-generator using the given Grammar.
Method Summary
protected intaddSemPred(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.
protected intcountLines(String s)
voidexitIfError()
voidgen()
Generate the parser, lexer, treeparser, and token types in C++
voidgen(ActionElement action)
Generate code for the given grammar element.
voidgen(AlternativeBlock blk)
Generate code for the given grammar element.
voidgen(BlockEndElement end)
Generate code for the given grammar element.
voidgen(CharLiteralElement atom)
Generate code for the given grammar element.
voidgen(CharRangeElement r)
Generate code for the given grammar element.
voidgen(LexerGrammar g)
Generate the lexer C++ files
voidgen(OneOrMoreBlock blk)
Generate code for the given grammar element.
voidgen(ParserGrammar g)
Generate the parser C++ file
voidgen(RuleRefElement rr)
Generate code for the given grammar element.
voidgen(StringLiteralElement atom)
Generate code for the given grammar element.
voidgen(TokenRangeElement r)
Generate code for the given grammar element.
voidgen(TokenRefElement atom)
Generate code for the given grammar element.
voidgen(TreeElement t)
voidgen(TreeWalkerGrammar g)
Generate the tree-parser C++ files
voidgen(WildcardElement wc)
Generate code for the given grammar element.
voidgen(ZeroOrMoreBlock blk)
Generate code for the given grammar element.
protected voidgenAlt(Alternative alt, AlternativeBlock blk)
Generate an alternative.
protected voidgenASTDeclaration(AlternativeElement el)
protected voidgenASTDeclaration(AlternativeElement el, String node_type)
protected voidgenASTDeclaration(AlternativeElement el, String var_name, String node_type)
protected voidgenBitsets(Vector bitsetList, int maxVocabulary, String prefix)
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 voidgenBitsetsHeader(Vector bitsetList, int maxVocabulary)
protected voidgenBlockInitAction(AlternativeBlock blk)
Generate the initaction for a block, which may be a RuleBlock or a plain AlternativeBLock.
protected voidgenBlockPreamble(AlternativeBlock blk)
Generate the header for a block, which may be a RuleBlock or a plain AlternativeBlock.
voidgenBody(LexerGrammar g)
voidgenBody(ParserGrammar g)
voidgenBody(TreeWalkerGrammar g)
protected voidgenCases(BitSet p)
Generate a series of case statements that implement a BitSet test.
CppBlockFinishingInfogenCommonBlock(AlternativeBlock blk, boolean noTestForSingle)
Generate common code for a block of alternatives; return a postscript that needs to be generated at the end of the block.
protected voidgenHeader(String fileName)
Generate a header that is common to all C++ files
voidgenInclude(LexerGrammar g)
voidgenInclude(ParserGrammar g)
voidgenInclude(TreeWalkerGrammar g)
voidgenInitFactory(Grammar g)
voidgenLineNo(int line)
Generate a #line or // line depending on options
voidgenLineNo(GrammarElement el)
Generate a #line or // line depending on options
voidgenLineNo(Token t)
Generate a #line or // line depending on options
voidgenLineNo2()
Generate a #line or // line depending on options
protected voidgenMatch(BitSet b)
protected voidgenMatch(GrammarAtom atom)
protected voidgenMatchUsingAtomText(GrammarAtom atom)
protected voidgenMatchUsingAtomTokenType(GrammarAtom atom)
voidgenNextToken()
Generate the nextToken() rule. nextToken() is a synthetic lexer rule that is the implicit OR of all user-defined lexer rules.
voidgenRule(RuleSymbol s, boolean startSymbol, int ruleNum, String prefix)
Gen a named rule block.
voidgenRuleHeader(RuleSymbol s, boolean startSymbol)
protected voidgenSemPred(String pred, int line)
protected voidgenSemPredMap(String prefix)
Write an array of Strings which are the semantic predicate expressions.
protected voidgenSynPred(SynPredBlock blk, String lookaheadExpr)
voidgenTokenStrings(String prefix)
Generate a static array containing the names of the tokens, indexed by the token type values.
protected voidgenTokenTypes(TokenManager tm)
Generate the token types C++ file
StringgetASTCreateString(Vector v)
Get a string for an expression to generate creation of an AST subtree.
StringgetASTCreateString(GrammarAtom atom, String str)
Get a string for an expression to generate creating of an AST node
StringgetASTCreateString(String str)
Get a string for an expression to generate creating of an AST node
protected StringgetLookaheadTestExpression(Lookahead[] look, int k)
protected StringgetLookaheadTestExpression(Alternative alt, int maxDepth)
Generate a lookahead test expression for an alternate.
protected StringgetLookaheadTestTerm(int k, BitSet p)
Generate a depth==1 lookahead test expression given the BitSet.
StringgetRangeExpression(int k, int[] elems)
Return an expression for testing a contiguous renage of elements
protected booleanlookaheadIsEmpty(Alternative alt, int maxDepth)
Is the lookahead for this alt empty?
StringmapTreeId(String idParam, ActionTransInfo transInfo)
Map an identifier to it's corresponding tree-node variable.
voidprintAction(Token t)
Print an action stored in a token surrounded by #line stuff
voidprintHeaderAction(String name)
Print a header action by #line stuff also process any tree construction
protected voidprintln(String s)
Output tab indent followed by a String followed by newline, to the currentOutput stream.
protected StringprocessActionForSpecialSymbols(String actionStr, int line, RuleBlock currentRule, ActionTransInfo tInfo)
Lexically process tree-specifiers in the action.
StringprocessStringForASTConstructor(String str)
Process a string for an simple expression for use in xx/action.g it is used to cast simple tokens/references to the right type for the generated language.
protected void_print(String s)
Output a String to the currentOutput stream.
protected void_printAction(String s)
Print an action without leading tabs, attempting to preserve the current indentation level for multi-line actions Ignored if string is null.
protected void_println(String s)
Output a String followed by newline, to the currentOutput stream.

Field Detail

astVarNumber

int astVarNumber

caseSizeThreshold

public static final int caseSizeThreshold

commonExtraArgs

String commonExtraArgs

commonExtraParams

String commonExtraParams

commonLocalVars

String commonLocalVars

currentASTResult

String currentASTResult

currentRule

RuleBlock currentRule

declaredASTVariables

Hashtable declaredASTVariables
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

DEBUG_CPP_CODE_GENERATOR

boolean DEBUG_CPP_CODE_GENERATOR

exceptionThrown

String exceptionThrown

genAST

protected boolean genAST

genHashLines

protected boolean genHashLines

labeledElementASTInit

String labeledElementASTInit

labeledElementASTType

String labeledElementASTType

labeledElementInit

String labeledElementInit

labeledElementType

String labeledElementType

lt1Value

String lt1Value

noConstructors

protected boolean noConstructors

NONUNIQUE

protected static final String NONUNIQUE

outputFile

protected String outputFile

outputLine

protected int outputLine

saveText

protected boolean saveText

syntacticPredLevel

protected int syntacticPredLevel

throwNoViable

String throwNoViable

treeVariableMap

Hashtable treeVariableMap

usingCustomAST

boolean usingCustomAST

Constructor Detail

CppCodeGenerator

public CppCodeGenerator()
Create a C++ code-generator using the given Grammar. The caller must still call setTool, setBehavior, and setAnalyzer before generating code.

Method Detail

addSemPred

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. This method should only be called when the debug option is specified

countLines

protected int countLines(String s)

exitIfError

public void exitIfError()

gen

public void gen()
Generate the parser, lexer, treeparser, and token types in C++

gen

public void gen(ActionElement action)
Generate code for the given grammar element.

Parameters: blk The {...} action to generate

gen

public void gen(AlternativeBlock blk)
Generate code for the given grammar element.

Parameters: blk The "x|y|z|..." block to generate

gen

public void gen(BlockEndElement end)
Generate code for the given grammar element.

Parameters: blk The block-end element to generate. Block-end elements are synthesized by the grammar parser to represent the end of a block.

gen

public void gen(CharLiteralElement atom)
Generate code for the given grammar element. Only called from lexer grammars.

Parameters: blk The character literal reference to generate

gen

public void gen(CharRangeElement r)
Generate code for the given grammar element. Only called from lexer grammars.

Parameters: blk The character-range reference to generate

gen

public void gen(LexerGrammar g)
Generate the lexer C++ files

gen

public void gen(OneOrMoreBlock blk)
Generate code for the given grammar element.

Parameters: blk The (...)+ block to generate

gen

public void gen(ParserGrammar g)
Generate the parser C++ file

gen

public void gen(RuleRefElement rr)
Generate code for the given grammar element.

Parameters: blk The rule-reference to generate

gen

public void gen(StringLiteralElement atom)
Generate code for the given grammar element.

Parameters: blk The string-literal reference to generate

gen

public void gen(TokenRangeElement r)
Generate code for the given grammar element.

Parameters: blk The token-range reference to generate

gen

public void gen(TokenRefElement atom)
Generate code for the given grammar element.

Parameters: blk The token-reference to generate

gen

public void gen(TreeElement t)

gen

public void gen(TreeWalkerGrammar g)
Generate the tree-parser C++ files

gen

public void gen(WildcardElement wc)
Generate code for the given grammar element.

Parameters: wc The wildcard element to generate

gen

public void gen(ZeroOrMoreBlock blk)
Generate code for the given grammar element.

Parameters: blk The (...)* block to generate

genAlt

protected void genAlt(Alternative alt, AlternativeBlock blk)
Generate an alternative.

Parameters: alt The alternative to generate blk The block to which the alternative belongs

genASTDeclaration

protected void genASTDeclaration(AlternativeElement el)

genASTDeclaration

protected void genASTDeclaration(AlternativeElement el, String node_type)

genASTDeclaration

protected void genASTDeclaration(AlternativeElement el, String var_name, String node_type)

genBitsets

protected void genBitsets(Vector bitsetList, int maxVocabulary, String prefix)
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. maxVocabulary Ensure that each generated bitset can contain at least this value. prefix string glued in from of bitset names used for namespace qualifications.

genBitsetsHeader

protected void genBitsetsHeader(Vector bitsetList, int maxVocabulary)

genBlockInitAction

protected void genBlockInitAction(AlternativeBlock blk)
Generate the initaction for a block, which may be a RuleBlock or a plain AlternativeBLock.

UNKNOWN: The block for which the preamble is to be generated.

genBlockPreamble

protected void genBlockPreamble(AlternativeBlock blk)
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.

UNKNOWN: The block for which the preamble is to be generated.

genBody

public void genBody(LexerGrammar g)

genBody

public void genBody(ParserGrammar g)

genBody

public void genBody(TreeWalkerGrammar g)

genCases

protected void genCases(BitSet p)
Generate a series of case statements that implement a BitSet test.

Parameters: p The Bitset for which cases are to be generated

genCommonBlock

public CppBlockFinishingInfo genCommonBlock(AlternativeBlock blk, boolean noTestForSingle)
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.

Parameters: blk The block to generate noTestForSingle If true, then it does not generate a test for a single alternative.

genHeader

protected void genHeader(String fileName)
Generate a header that is common to all C++ files

genInclude

public void genInclude(LexerGrammar g)

genInclude

public void genInclude(ParserGrammar g)

genInclude

public void genInclude(TreeWalkerGrammar g)

genInitFactory

public void genInitFactory(Grammar g)

genLineNo

public void genLineNo(int line)
Generate a #line or // line depending on options

genLineNo

public void genLineNo(GrammarElement el)
Generate a #line or // line depending on options

genLineNo

public void genLineNo(Token t)
Generate a #line or // line depending on options

genLineNo2

public void genLineNo2()
Generate a #line or // line depending on options

genMatch

protected void genMatch(BitSet b)

genMatch

protected void genMatch(GrammarAtom atom)

genMatchUsingAtomText

protected void genMatchUsingAtomText(GrammarAtom atom)

genMatchUsingAtomTokenType

protected void genMatchUsingAtomTokenType(GrammarAtom atom)

genNextToken

public void genNextToken()
Generate the nextToken() rule. nextToken() is a synthetic lexer rule that is the implicit OR of all user-defined lexer rules.

Parameters: RuleBlock

genRule

public void genRule(RuleSymbol s, boolean startSymbol, int ruleNum, String prefix)
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 startSymbol true if the rule is a start symbol (i.e., not referenced elsewhere)

genRuleHeader

public void genRuleHeader(RuleSymbol s, boolean startSymbol)

genSemPred

protected void genSemPred(String pred, int line)

genSemPredMap

protected void genSemPredMap(String prefix)
Write an array of Strings which are the semantic predicate expressions. The debugger will reference them by number only

genSynPred

protected void genSynPred(SynPredBlock blk, String lookaheadExpr)

genTokenStrings

public void genTokenStrings(String prefix)
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.

genTokenTypes

protected void genTokenTypes(TokenManager tm)
Generate the token types C++ file

getASTCreateString

public String getASTCreateString(Vector v)
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 str)
Get a string for an expression to generate creating of an AST node

Parameters: str The arguments to the AST constructor

getASTCreateString

public String getASTCreateString(String str)
Get a string for an expression to generate creating of an AST node

Parameters: str The arguments to the AST constructor

getLookaheadTestExpression

protected String getLookaheadTestExpression(Lookahead[] look, int k)

getLookaheadTestExpression

protected String getLookaheadTestExpression(Alternative alt, int maxDepth)
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)
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 p The lookahead set for level k

getRangeExpression

public String getRangeExpression(int k, int[] elems)
Return an expression for testing a contiguous renage of elements

Parameters: k The lookahead level elems The elements representing the set, usually from BitSet.toArray().

Returns: String containing test expression.

lookaheadIsEmpty

protected boolean lookaheadIsEmpty(Alternative alt, int maxDepth)
Is the lookahead for this alt empty?

mapTreeId

public String mapTreeId(String idParam, ActionTransInfo transInfo)
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

Returns: The mapped id (which may be the same as the input), or null if the mapping is invalid due to duplicates

printAction

public void printAction(Token t)
Print an action stored in a token surrounded by #line stuff

printHeaderAction

public void printHeaderAction(String name)
Print a header action by #line stuff also process any tree construction

Parameters: name The name of the header part

println

protected void println(String s)
Output tab indent followed by a String followed by newline, to the currentOutput stream. Ignored if string is null.

Parameters: s The string to output

processActionForSpecialSymbols

protected String processActionForSpecialSymbols(String actionStr, int line, RuleBlock currentRule, ActionTransInfo tInfo)
Lexically process tree-specifiers in the action. This will replace #id and #(...) with the appropriate function calls and/or variables.

processStringForASTConstructor

public String processStringForASTConstructor(String str)
Process a string for an simple expression for use in xx/action.g it is used to cast simple tokens/references to the right type for the generated language. Basically called for every element in the vector to getASTCreateString(vector V)

Parameters: str A String.

_print

protected void _print(String s)
Output a String to the currentOutput stream. Ignored if string is null.

Parameters: s The string to output

_printAction

protected void _printAction(String s)
Print an action without leading tabs, attempting to preserve the current indentation level for multi-line actions Ignored if string is null.

Parameters: s The action string to output

_println

protected void _println(String s)
Output a String followed by newline, to the currentOutput stream. Ignored if string is null.

Parameters: s The string to output