Package antlr
Class PythonCodeGenerator
java.lang.Object
antlr.CodeGenerator
antlr.PythonCodeGenerator
Generate MyParser.java, MyLexer.java and MyParserTokenTypes.java
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) int
static final int
(package private) String
(package private) String
(package private) String
(package private) String
Tracks the rule or labeled subrule being generated.(package private) RuleBlock
Tracks the rule being generated.(package private) Hashtable
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) String
protected boolean
static final String
(package private) String
(package private) String
(package private) String
(package private) String
(package private) String
static final String
protected static final String
Special value used to mark duplicate in treeVariableMap(package private) String
protected boolean
protected int
(package private) String
(package private) Hashtable
Mapping between the ids used in the current alt, and the names of variables used to represent their AST values.(package private) String
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 -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Print an action without leading tabs, attempting to preserve the current indentation level for multi-line actions Ignored if string is null.protected void
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.protected void
void
protected String
extractIdOfAction
(String s, int line, int column) Get the identifier portion of an argument-action.protected String
extractTypeOfAction
(String s, int line, int column) Get the type portion of an argument-action.protected void
void
gen()
Generate the parser, lexer, treeparser, and token types in Javavoid
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
Generate code for the given grammar element.void
gen
(LexerGrammar g) Generate the lexer Java filevoid
gen
(OneOrMoreBlock blk) Generate code for the given grammar element.void
gen
(ParserGrammar g) Generate the parser Java filevoid
gen
(RuleRefElement rr) Generate code for the given grammar element.void
gen
(StringLiteralElement atom) Generate code for the given grammar element.void
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
Generate the tree-parser Java filevoid
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
protected void
genASTDeclaration
(AlternativeElement el, String node_type) protected void
genASTDeclaration
(AlternativeElement el, String var_name, String node_type) 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
Generate the init action for a block, which may be a RuleBlock or a plain AlternativeBLock.protected void
Generate the header for a block, which may be a RuleBlock or a plain AlternativeBLock.protected void
Generate a series of case statements that implement a BitSet test.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
Generate a header that is common to all Python filesprotected void
genHeaderInit
(Grammar grammar) protected void
genHeaderMain
(Grammar grammar) protected void
protected void
protected void
Generate an automated test for Python CharScanner (sub)classes.protected void
protected void
genMatch
(GrammarAtom atom) protected void
protected void
void
Generate the nextToken() rule.void
genRule
(RuleSymbol s, boolean startSymbol, int ruleNum) Gen a named rule block.protected void
genSemPred
(String pred, int line) protected void
Write an array of Strings which are the semantic predicate expressions.protected void
genSynPred
(SynPredBlock blk, String lookaheadExpr) protected void
Create and set Integer token type objects that map to Java Class objects (which AST node to create).void
Generate a static array containing the names of the tokens, indexed by the token type values.protected void
Generate the token types Java fileGet a string for an expression to generate creation of an AST subtree.getASTCreateString
(GrammarAtom atom, String astCtorArgs) Get a string for an expression to generate creating of an AST nodegetASTCreateString
(String astCtorArgs) Get a string for an expression to generate creating of an AST node.protected String
getLookaheadTestExpression
(Alternative alt, int maxDepth) Generate a lookahead test expression for an alternate.protected String
getLookaheadTestExpression
(Lookahead[] look, int k) protected String
getLookaheadTestTerm
(int k, BitSet p) Generate a depth==1 lookahead test expression given the BitSet.getRangeExpression
(int k, int[] elems) Return an expression for testing a contiguous renage of elements(package private) static boolean
protected boolean
isspace
(char c) protected boolean
lookaheadIsEmpty
(Alternative alt, int maxDepth) Is the lookahead for this alt empty?mapTreeId
(String idParam, ActionTransInfo transInfo) Map an identifier to it's corresponding tree-node variable.protected void
protected void
Print an action with leading tabs, attempting to preserve the current indentation level for multi-line actions Ignored if string is null.protected void
printActionCode
(String actionStr, int line) protected void
printGrammarAction
(Grammar grammar) protected void
protected void
Create a Java code-generator using the given Grammar.protected String
processActionCode
(String actionStr, int line) protected String
processActionForSpecialSymbols
(String actionStr, int line, RuleBlock currentRule, ActionTransInfo tInfo) Lexically process $var and tree-specifiers in the action.void
setupOutput
(String className) This method exists so a subclass, namely VAJCodeGenerator, can open the file in its own evil way.(package private) String
toString
(boolean v) Methods inherited from class antlr.CodeGenerator
_print, _println, decodeLexerRuleName, elementsAreRange, encodeLexerRuleName, extractIdOfAction, extractTypeOfAction, genTokenInterchange, getBitsetName, getFIRSTBitSet, getFOLLOWBitSet, markBitsetForGen, print, println, processStringForASTConstructor, removeAssignmentFromDeclaration, reverseLexerRuleName, setAnalyzer, setBehavior, setGrammar, setTool
-
Field Details
-
syntacticPredLevel
protected int syntacticPredLevel -
genAST
protected boolean genAST -
saveText
protected boolean saveText -
labeledElementType
String labeledElementType -
labeledElementASTType
String labeledElementASTType -
labeledElementInit
String labeledElementInit -
commonExtraArgs
String commonExtraArgs -
commonExtraParams
String commonExtraParams -
commonLocalVars
String commonLocalVars -
lt1Value
String lt1Value -
exceptionThrown
String exceptionThrown -
throwNoViable
String throwNoViable -
initHeaderAction
- See Also:
-
mainHeaderAction
- See Also:
-
lexerClassName
String lexerClassName -
parserClassName
String parserClassName -
treeWalkerClassName
String treeWalkerClassName -
currentRule
RuleBlock currentRuleTracks the rule being generated. Used for mapTreeId -
currentASTResult
String currentASTResultTracks the rule or labeled subrule being generated. Used for AST generation. -
treeVariableMap
Hashtable treeVariableMapMapping between the ids used in the current alt, and the names of variables used to represent their AST values. -
declaredASTVariables
Hashtable declaredASTVariablesUsed 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
Special value used to mark duplicate in treeVariableMap -
caseSizeThreshold
public static final int caseSizeThreshold- See Also:
-
-
Constructor Details
-
PythonCodeGenerator
public PythonCodeGenerator()
-
-
Method Details
-
printTabs
protected void printTabs()Create a Java code-generator using the given Grammar. The caller must still call setTool, setBehavior, and setAnalyzer before generating code.- Overrides:
printTabs
in classCodeGenerator
-
addSemPred
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() -
checkCurrentOutputStream
protected void checkCurrentOutputStream() -
extractIdOfAction
Get the identifier portion of an argument-action. For Python the ID of an action is assumed to be everything before the assignment, as Python does not support a type.- Overrides:
extractIdOfAction
in classCodeGenerator
- Parameters:
s
- The action textline
- Line used for error reporting.column
- Line used for error reporting.- Returns:
- A string containing the text of the identifier
-
extractTypeOfAction
Get the type portion of an argument-action. Python does not have a type declaration before an identifier, so we just return the empty string.- Overrides:
extractTypeOfAction
in classCodeGenerator
- Parameters:
s
- The action textline
- Line used for error reporting.- Returns:
- A string containing the text of the type
-
flushTokens
protected void flushTokens() -
gen
public void gen()Generate the parser, lexer, treeparser, and token types in Java- Specified by:
gen
in classCodeGenerator
-
gen
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
action
- The {...} action to generateblk
- The {...} action to generate
-
gen
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
blk
- The "x|y|z|..." block to generate
-
gen
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
end
- The block-end element to generate. Block-end elements are synthesized by the grammar parser to represent the end of a block.blk
- The block-end element to generate. Block-end elements are synthesized by the grammar parser to represent the end of a block.
-
gen
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
atom
- The character literal reference to generateblk
- The character literal reference to generate
-
toString
-
gen
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
r
- The character-range reference to generateblk
- The character-range reference to generate
-
gen
Generate the lexer Java file- Specified by:
gen
in classCodeGenerator
- Throws:
IOException
-
genHeaderMain
-
genHeaderInit
-
printMainFunc
-
gen
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
blk
- The (...)+ block to generate
-
gen
Generate the parser Java file- Specified by:
gen
in classCodeGenerator
- Throws:
IOException
-
gen
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
rr
- The rule-reference to generateblk
- The rule-reference to generate
-
gen
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
atom
- The string-literal reference to generateblk
- The string-literal reference to generate
-
gen
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
r
- The token-range reference to generateblk
- The token-range reference to generate
-
gen
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
atom
- The token-reference to generateblk
- The token-reference to generate
-
gen
Description copied from class:CodeGenerator
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
-
gen
Generate the tree-parser Java file- Specified by:
gen
in classCodeGenerator
- Throws:
IOException
-
gen
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
wc
- The wildcard element to generate
-
gen
Generate code for the given grammar element.- Specified by:
gen
in classCodeGenerator
- Parameters:
blk
- The (...)* block to generate
-
genAlt
Generate an alternative.- Parameters:
alt
- The alternative to generateblk
- The block to which the alternative belongs
-
genBitsets
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.
-
genBlockInitAction
Generate the init action for a block, which may be a RuleBlock or a plain AlternativeBLock. -
genBlockPreamble
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
Generate a series of case statements that implement a BitSet test.- Parameters:
p
- The Bitset for which cases are to be generated
-
genCommonBlock
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. -
genASTDeclaration
-
genASTDeclaration
-
genASTDeclaration
-
genHeader
protected void genHeader()Generate a header that is common to all Python files -
genLexerTest
protected void genLexerTest()Generate an automated test for Python CharScanner (sub)classes. -
genMatch
-
genMatch
-
genMatchUsingAtomText
-
genMatchUsingAtomTokenType
-
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. -
genRule
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:
startSymbol
- true if the rule is a start symbol (i.e., not referenced elsewhere)rule
- The name of the rule to generate
-
genSemPred
-
genSemPredMap
protected void genSemPredMap()Write an array of Strings which are the semantic predicate expressions. The debugger will reference them by number only -
genSynPred
-
genTokenStrings
public void genTokenStrings()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. -
genTokenASTNodeMap
protected void genTokenASTNodeMap()Create and set Integer token type objects that map to Java Class objects (which AST node to create). -
genTokenTypes
Generate the token types Java file- Throws:
IOException
-
getASTCreateString
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
Get a string for an expression to generate creating of an AST node- Specified by:
getASTCreateString
in classCodeGenerator
- Parameters:
atom
- The grammar node for which you are creating the nodeastCtorArgs
- The text of the arguments to the AST constructionstr
- The arguments to the AST constructor
-
getASTCreateString
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
-
getLookaheadTestExpression
Generate a lookahead test expression for an alternate. This will be a series of tests joined by 'invalid input: '&'invalid input: '&'' and enclosed by '()', the number of such tests being determined by the depth of the lookahead. -
getLookaheadTestTerm
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 >= invalid input: '&'invalid input: '&' invalid input: '<'= where possible, 3) a bitset membership test for complex comparisons- Parameters:
k
- The lookahead levelp
- The lookahead set for level k
-
getRangeExpression
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
Is the lookahead for this alt empty? -
mapTreeId
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 String processActionForSpecialSymbols(String actionStr, int line, RuleBlock currentRule, ActionTransInfo tInfo) Lexically process $var and tree-specifiers in the action. This will replace #id and #(...) with the appropriate function calls and/or variables etc...- Specified by:
processActionForSpecialSymbols
in classCodeGenerator
-
isEmpty
-
processActionCode
-
printActionCode
-
setupOutput
This method exists so a subclass, namely VAJCodeGenerator, can open the file in its own evil way. JavaCodeGenerator simply opens a text file...- Throws:
IOException
-
isspace
protected boolean isspace(char c) -
_printAction
Description copied from class:CodeGenerator
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
-
od
-
printAction
Description copied from class:CodeGenerator
Print an action with 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
-
printGrammarAction
-
_printJavadoc
-
genJavadocComment
-
genJavadocComment
-