Package antlr
Class CppCodeGenerator
- java.lang.Object
-
- antlr.CodeGenerator
-
- antlr.CppCodeGenerator
-
public class CppCodeGenerator extends CodeGenerator
Generate MyParser.cpp, MyParser.hpp, MyLexer.cpp, MyLexer.hpp and MyParserTokenTypes.hpp
-
-
Field Summary
Fields Modifier and Type Field Description (package private) int
astVarNumber
static int
caseSizeThreshold
(package private) java.lang.String
commonExtraArgs
(package private) java.lang.String
commonExtraParams
(package private) java.lang.String
commonLocalVars
(package private) java.lang.String
currentASTResult
(package private) RuleBlock
currentRule
(package private) boolean
DEBUG_CPP_CODE_GENERATOR
(package private) java.util.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(package private) java.lang.String
exceptionThrown
protected boolean
genAST
protected boolean
genHashLines
(package private) java.lang.String
labeledElementASTInit
(package private) java.lang.String
labeledElementASTType
(package private) java.lang.String
labeledElementInit
(package private) java.lang.String
labeledElementType
(package private) java.lang.String
lt1Value
protected boolean
noConstructors
protected static java.lang.String
NONUNIQUE
protected java.lang.String
outputFile
protected int
outputLine
protected boolean
saveText
protected int
syntacticPredLevel
(package private) java.lang.String
throwNoViable
(package private) java.util.Hashtable
treeVariableMap
(package private) boolean
usingCustomAST
-
Fields inherited from class antlr.CodeGenerator
analyzer, antlrTool, behavior, BITSET_OPTIMIZE_INIT_THRESHOLD, bitsetsUsed, bitsetTestThreshold, charFormatter, currentOutput, DEBUG_CODE_GENERATOR, DEFAULT_BITSET_TEST_THRESHOLD, DEFAULT_MAKE_SWITCH_THRESHOLD, grammar, makeSwitchThreshold, tabs, TokenTypesFileExt, TokenTypesFileSuffix
-
-
Constructor Summary
Constructors Constructor Description CppCodeGenerator()
Create a C++ code-generator using the given Grammar.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
_print(java.lang.String s)
Output a String to the currentOutput stream.protected void
_printAction(java.lang.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(java.lang.String s)
Output a String followed by newline, to the currentOutput stream.protected int
addSemPred(java.lang.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 int
countLines(java.lang.String s)
void
exitIfError()
void
gen()
Generate the parser, lexer, treeparser, and token types in C++void
gen(ActionElement action)
Generate code for the given grammar element.void
gen(AlternativeBlock blk)
Generate code for the given grammar element.void
gen(BlockEndElement end)
Generate code for the given grammar element.void
gen(CharLiteralElement atom)
Generate code for the given grammar element.void
gen(CharRangeElement r)
Generate code for the given grammar element.void
gen(LexerGrammar g)
Generate the lexer C++ filesvoid
gen(OneOrMoreBlock blk)
Generate code for the given grammar element.void
gen(ParserGrammar g)
Generate the parser C++ filevoid
gen(RuleRefElement rr)
Generate code for the given grammar element.void
gen(StringLiteralElement atom)
Generate code for the given grammar element.void
gen(TokenRangeElement r)
Generate code for the given grammar element.void
gen(TokenRefElement atom)
Generate code for the given grammar element.void
gen(TreeElement t)
Generate code for the given grammar element.void
gen(TreeWalkerGrammar g)
Generate the tree-parser C++ filesvoid
gen(WildcardElement wc)
Generate code for the given grammar element.void
gen(ZeroOrMoreBlock blk)
Generate code for the given grammar element.protected void
genAlt(Alternative alt, AlternativeBlock blk)
Generate an alternative.protected void
genASTDeclaration(AlternativeElement el)
protected void
genASTDeclaration(AlternativeElement el, java.lang.String node_type)
protected void
genASTDeclaration(AlternativeElement el, java.lang.String var_name, java.lang.String node_type)
protected void
genBitsets(Vector bitsetList, int maxVocabulary, java.lang.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 void
genBitsetsHeader(Vector bitsetList, int maxVocabulary)
protected void
genBlockInitAction(AlternativeBlock blk)
Generate the initaction 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.void
genBody(LexerGrammar g)
void
genBody(ParserGrammar g)
void
genBody(TreeWalkerGrammar g)
protected void
genCases(BitSet p)
Generate a series of case statements that implement a BitSet test.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.protected void
genHeader(java.lang.String fileName)
Generate a header that is common to all C++ filesvoid
genInclude(LexerGrammar g)
void
genInclude(ParserGrammar g)
void
genInclude(TreeWalkerGrammar g)
void
genInitFactory(Grammar g)
void
genLineNo(int line)
Generate a #line or // line depending on optionsvoid
genLineNo(GrammarElement el)
Generate a #line or // line depending on optionsvoid
genLineNo(Token t)
Generate a #line or // line depending on optionsvoid
genLineNo2()
Generate a #line or // line depending on optionsprotected void
genMatch(BitSet b)
protected void
genMatch(GrammarAtom atom)
protected void
genMatchUsingAtomText(GrammarAtom atom)
protected void
genMatchUsingAtomTokenType(GrammarAtom atom)
void
genNextToken()
Generate the nextToken() rule.void
genRule(RuleSymbol s, boolean startSymbol, int ruleNum, java.lang.String prefix)
Gen a named rule block.void
genRuleHeader(RuleSymbol s, boolean startSymbol)
protected void
genSemPred(java.lang.String pred, int line)
protected void
genSemPredMap(java.lang.String prefix)
Write an array of Strings which are the semantic predicate expressions.protected void
genSynPred(SynPredBlock blk, java.lang.String lookaheadExpr)
void
genTokenStrings(java.lang.String prefix)
Generate a static array containing the names of the tokens, indexed by the token type values.protected void
genTokenTypes(TokenManager tm)
Generate the token types C++ filejava.lang.String
getASTCreateString(Vector v)
Get a string for an expression to generate creation of an AST subtree.java.lang.String
getASTCreateString(GrammarAtom atom, java.lang.String str)
Get a string for an expression to generate creating of an AST nodejava.lang.String
getASTCreateString(java.lang.String str)
Get a string for an expression to generate creating of an AST nodeprotected java.lang.String
getLookaheadTestExpression(Alternative alt, int maxDepth)
Generate a lookahead test expression for an alternate.protected java.lang.String
getLookaheadTestExpression(Lookahead[] look, int k)
protected java.lang.String
getLookaheadTestTerm(int k, BitSet p)
Generate a depth==1 lookahead test expression given the BitSet.java.lang.String
getRangeExpression(int k, int[] elems)
Return an expression for testing a contiguous renage of elementsprotected boolean
lookaheadIsEmpty(Alternative alt, int maxDepth)
Is the lookahead for this alt empty?java.lang.String
mapTreeId(java.lang.String idParam, ActionTransInfo transInfo)
Map an identifier to it's corresponding tree-node variable.void
printAction(Token t)
Print an action stored in a token surrounded by #line stuffvoid
printHeaderAction(java.lang.String name)
Print a header action by #line stuff also process any tree constructionprotected void
println(java.lang.String s)
Output tab indent followed by a String followed by newline, to the currentOutput stream.protected java.lang.String
processActionForSpecialSymbols(java.lang.String actionStr, int line, RuleBlock currentRule, ActionTransInfo tInfo)
Lexically process tree-specifiers in the action.java.lang.String
processStringForASTConstructor(java.lang.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.-
Methods inherited from class antlr.CodeGenerator
decodeLexerRuleName, elementsAreRange, encodeLexerRuleName, extractIdOfAction, extractIdOfAction, extractTypeOfAction, extractTypeOfAction, genTokenInterchange, getBitsetName, getFIRSTBitSet, getFOLLOWBitSet, markBitsetForGen, print, printAction, printTabs, removeAssignmentFromDeclaration, reverseLexerRuleName, setAnalyzer, setBehavior, setGrammar, setTool
-
-
-
-
Field Detail
-
DEBUG_CPP_CODE_GENERATOR
boolean DEBUG_CPP_CODE_GENERATOR
-
syntacticPredLevel
protected int syntacticPredLevel
-
genAST
protected boolean genAST
-
saveText
protected boolean saveText
-
genHashLines
protected boolean genHashLines
-
noConstructors
protected boolean noConstructors
-
outputLine
protected int outputLine
-
outputFile
protected java.lang.String outputFile
-
usingCustomAST
boolean usingCustomAST
-
labeledElementType
java.lang.String labeledElementType
-
labeledElementASTType
java.lang.String labeledElementASTType
-
labeledElementASTInit
java.lang.String labeledElementASTInit
-
labeledElementInit
java.lang.String labeledElementInit
-
commonExtraArgs
java.lang.String commonExtraArgs
-
commonExtraParams
java.lang.String commonExtraParams
-
commonLocalVars
java.lang.String commonLocalVars
-
lt1Value
java.lang.String lt1Value
-
exceptionThrown
java.lang.String exceptionThrown
-
throwNoViable
java.lang.String throwNoViable
-
currentRule
RuleBlock currentRule
-
currentASTResult
java.lang.String currentASTResult
-
treeVariableMap
java.util.Hashtable treeVariableMap
-
declaredASTVariables
java.util.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
-
astVarNumber
int astVarNumber
-
NONUNIQUE
protected static final java.lang.String NONUNIQUE
-
caseSizeThreshold
public static final int caseSizeThreshold
- See Also:
- Constant Field Values
-
-
Method Detail
-
addSemPred
protected int addSemPred(java.lang.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
-
exitIfError
public void exitIfError()
-
countLines
protected int countLines(java.lang.String s)
-
_print
protected void _print(java.lang.String s)
Output a String to the currentOutput stream. Ignored if string is null.- Overrides:
_print
in classCodeGenerator
- Parameters:
s
- The string to output
-
_printAction
protected void _printAction(java.lang.String s)
Print an action without leading tabs, attempting to preserve the current indentation level for multi-line actions Ignored if string is null.- Overrides:
_printAction
in classCodeGenerator
- Parameters:
s
- The action string to output
-
printAction
public void printAction(Token t)
Print an action stored in a token surrounded by #line stuff
-
printHeaderAction
public void printHeaderAction(java.lang.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(java.lang.String s)
Output a String followed by newline, to the currentOutput stream. Ignored if string is null.- Overrides:
_println
in classCodeGenerator
- Parameters:
s
- The string to output
-
println
protected void println(java.lang.String s)
Output tab indent followed by a String followed by newline, to the currentOutput stream. Ignored if string is null.- Overrides:
println
in classCodeGenerator
- Parameters:
s
- The string to output
-
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
-
gen
public void gen()
Generate the parser, lexer, treeparser, and token types in C++- Specified by:
gen
in classCodeGenerator
-
gen
public void gen(ActionElement action)
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
blk
- The {...} action to generate
-
gen
public void gen(AlternativeBlock blk)
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
blk
- The "x|y|z|..." block to generate
-
gen
public void gen(BlockEndElement end)
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- 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.- Specified by:
gen
in classCodeGenerator
- 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.- Specified by:
gen
in classCodeGenerator
- Parameters:
blk
- The character-range reference to generate
-
gen
public void gen(LexerGrammar g) throws java.io.IOException
Generate the lexer C++ files- Specified by:
gen
in classCodeGenerator
- Throws:
java.io.IOException
-
gen
public void gen(OneOrMoreBlock blk)
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
blk
- The (...)+ block to generate
-
gen
public void gen(ParserGrammar g) throws java.io.IOException
Generate the parser C++ file- Specified by:
gen
in classCodeGenerator
- Throws:
java.io.IOException
-
gen
public void gen(RuleRefElement rr)
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
blk
- The rule-reference to generate
-
gen
public void gen(StringLiteralElement atom)
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
blk
- The string-literal reference to generate
-
gen
public void gen(TokenRangeElement r)
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
blk
- The token-range reference to generate
-
gen
public void gen(TokenRefElement atom)
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
blk
- The token-reference to generate
-
gen
public void gen(TreeElement t)
Description copied from class:CodeGenerator
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
-
gen
public void gen(TreeWalkerGrammar g) throws java.io.IOException
Generate the tree-parser C++ files- Specified by:
gen
in classCodeGenerator
- Throws:
java.io.IOException
-
gen
public void gen(WildcardElement wc)
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
wc
- The wildcard element to generate
-
gen
public void gen(ZeroOrMoreBlock blk)
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
blk
- The (...)* block to generate
-
genAlt
protected void genAlt(Alternative alt, AlternativeBlock blk)
Generate an alternative.- Parameters:
alt
- The alternative to generateblk
- The block to which the alternative belongs
-
genBitsets
protected void genBitsets(Vector bitsetList, int maxVocabulary, java.lang.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.
-
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.
-
genBody
public void genBody(LexerGrammar g) throws java.io.IOException
- Throws:
java.io.IOException
-
genInitFactory
public void genInitFactory(Grammar g)
-
genBody
public void genBody(ParserGrammar g) throws java.io.IOException
- Throws:
java.io.IOException
-
genBody
public void genBody(TreeWalkerGrammar g) throws java.io.IOException
- Throws:
java.io.IOException
-
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 generatenoTestForSingle
- If true, then it does not generate a test for a single alternative.
-
genHeader
protected void genHeader(java.lang.String fileName)
Generate a header that is common to all C++ files
-
genInclude
public void genInclude(LexerGrammar g) throws java.io.IOException
- Throws:
java.io.IOException
-
genInclude
public void genInclude(ParserGrammar g) throws java.io.IOException
- Throws:
java.io.IOException
-
genInclude
public void genInclude(TreeWalkerGrammar g) throws java.io.IOException
- Throws:
java.io.IOException
-
genASTDeclaration
protected void genASTDeclaration(AlternativeElement el)
-
genASTDeclaration
protected void genASTDeclaration(AlternativeElement el, java.lang.String node_type)
-
genASTDeclaration
protected void genASTDeclaration(AlternativeElement el, java.lang.String var_name, java.lang.String node_type)
-
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, java.lang.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 generatestartSymbol
- 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(java.lang.String pred, int line)
-
genSemPredMap
protected void genSemPredMap(java.lang.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, java.lang.String lookaheadExpr)
-
genTokenStrings
public void genTokenStrings(java.lang.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) throws java.io.IOException
Generate the token types C++ file- Throws:
java.io.IOException
-
processStringForASTConstructor
public java.lang.String processStringForASTConstructor(java.lang.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)- Overrides:
processStringForASTConstructor
in classCodeGenerator
- Parameters:
str
- A String.
-
getASTCreateString
public java.lang.String getASTCreateString(Vector v)
Get a string for an expression to generate creation of an AST subtree.- Specified by:
getASTCreateString
in classCodeGenerator
- Parameters:
v
- A Vector of String, where each element is an expression in the target language yielding an AST node.
-
getASTCreateString
public java.lang.String getASTCreateString(GrammarAtom atom, java.lang.String str)
Get a string for an expression to generate creating of an AST node- Specified by:
getASTCreateString
in classCodeGenerator
- Parameters:
str
- The arguments to the AST constructor
-
getASTCreateString
public java.lang.String getASTCreateString(java.lang.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 java.lang.String getLookaheadTestExpression(Lookahead[] look, int k)
-
getLookaheadTestExpression
protected java.lang.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 java.lang.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 levelp
- The lookahead set for level k
-
getRangeExpression
public java.lang.String getRangeExpression(int k, int[] elems)
Return an expression for testing a contiguous renage of elements- Parameters:
k
- The lookahead levelelems
- 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 java.lang.String mapTreeId(java.lang.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- Specified by:
mapTreeId
in classCodeGenerator
- 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
-
processActionForSpecialSymbols
protected java.lang.String processActionForSpecialSymbols(java.lang.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.- Specified by:
processActionForSpecialSymbols
in classCodeGenerator
-
-