Package antlr
Class HTMLCodeGenerator
- java.lang.Object
-
- antlr.CodeGenerator
-
- antlr.HTMLCodeGenerator
-
public class HTMLCodeGenerator extends CodeGenerator
Generate P.html, a cross-linked representation of P with or without actions
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
doingLexRules
true during lexer generation, false during parser generationprotected boolean
firstElementInAlt
protected AlternativeElement
prevAltElem
protected int
syntacticPredLevel
non-zero if inside syntactic predicate generation-
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 HTMLCodeGenerator()
Create a Diagnostic code-generator using the given Grammar The caller must still call setTool, setBehavior, and setAnalyzer before generating code.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
gen()
Generate the code for all grammarsvoid
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 HTML filevoid
gen(OneOrMoreBlock blk)
Generate code for the given grammar element.void
gen(ParserGrammar g)
Generate the parser HTML 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-walker TXT filevoid
gen(WildcardElement wc)
Generate a wildcard elementvoid
gen(ZeroOrMoreBlock blk)
Generate code for the given grammar element.protected void
genAlt(Alternative alt)
void
genCommonBlock(AlternativeBlock blk)
Generate common code for a block of alternatives; return a postscript that needs to be generated at the end of the block.void
genFollowSetForRuleBlock(RuleBlock blk)
Generate a textual representation of the follow set for a block.protected void
genGenericBlock(AlternativeBlock blk, java.lang.String blkOp)
protected void
genHeader()
Generate a header that is common to all TXT filesprotected void
genLookaheadSetForAlt(Alternative alt)
Generate the lookahead set for an alternate.void
genLookaheadSetForBlock(AlternativeBlock blk)
Generate a textual representation of the lookahead set for a block.void
genNextToken()
Generate the nextToken rule.void
genRule(RuleSymbol s)
Generate code for a named rule blockprotected void
genSynPred(SynPredBlock blk)
Generate the syntactic predicate.void
genTail()
protected void
genTokenTypes(TokenManager tm)
Generate the token types TXT 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 node(package private) static java.lang.String
HTMLEncode(java.lang.String s)
Encode a string for printing in a HTML document..java.lang.String
mapTreeId(java.lang.String id, ActionTransInfo tInfo)
Map an identifier to it's corresponding tree-node variable.void
printSet(int depth, int k, Lookahead lookahead)
Format a lookahead or follow set.protected java.lang.String
processActionForSpecialSymbols(java.lang.String actionStr, int line, RuleBlock currentRule, ActionTransInfo tInfo)
Lexically process $ and # references within the action.-
Methods inherited from class antlr.CodeGenerator
_print, _printAction, _println, decodeLexerRuleName, elementsAreRange, encodeLexerRuleName, extractIdOfAction, extractIdOfAction, extractTypeOfAction, extractTypeOfAction, genTokenInterchange, getBitsetName, getFIRSTBitSet, getFOLLOWBitSet, markBitsetForGen, print, printAction, println, printTabs, processStringForASTConstructor, removeAssignmentFromDeclaration, reverseLexerRuleName, setAnalyzer, setBehavior, setGrammar, setTool
-
-
-
-
Field Detail
-
syntacticPredLevel
protected int syntacticPredLevel
non-zero if inside syntactic predicate generation
-
doingLexRules
protected boolean doingLexRules
true during lexer generation, false during parser generation
-
firstElementInAlt
protected boolean firstElementInAlt
-
prevAltElem
protected AlternativeElement prevAltElem
-
-
Method Detail
-
HTMLEncode
static java.lang.String HTMLEncode(java.lang.String s)
Encode a string for printing in a HTML document.. e.g. encode '<' '>' and similar stuff- Parameters:
s
- the string to encode
-
gen
public void gen()
Description copied from class:CodeGenerator
Generate the code for all grammars- 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.- 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.- 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 HTML file- 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 HTML 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-walker TXT file- Specified by:
gen
in classCodeGenerator
- Throws:
java.io.IOException
-
gen
public void gen(WildcardElement wc)
Generate a wildcard 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)
-
genCommonBlock
public void genCommonBlock(AlternativeBlock blk)
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.
-
genFollowSetForRuleBlock
public void genFollowSetForRuleBlock(RuleBlock blk)
Generate a textual representation of the follow set for a block.- Parameters:
blk
- The rule block of interest
-
genGenericBlock
protected void genGenericBlock(AlternativeBlock blk, java.lang.String blkOp)
-
genHeader
protected void genHeader()
Generate a header that is common to all TXT files
-
genLookaheadSetForAlt
protected void genLookaheadSetForAlt(Alternative alt)
Generate the lookahead set for an alternate.
-
genLookaheadSetForBlock
public void genLookaheadSetForBlock(AlternativeBlock blk)
Generate a textual representation of the lookahead set for a block.- Parameters:
blk
- The block of interest
-
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
public void genRule(RuleSymbol s)
Generate code for a named rule block- Parameters:
s
- The RuleSymbol describing the rule to generate
-
genSynPred
protected void genSynPred(SynPredBlock blk)
Generate the syntactic predicate. This basically generates the alternative block, buts tracks if we are inside a synPred- Parameters:
blk
- The syntactic predicate block
-
genTail
public void genTail()
-
genTokenTypes
protected void genTokenTypes(TokenManager tm) throws java.io.IOException
Generate the token types TXT file- Throws:
java.io.IOException
-
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
-
mapTreeId
public java.lang.String mapTreeId(java.lang.String id, ActionTransInfo tInfo)
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:
id
- The identifier name to mapforInput
- true if the input tree node variable is to be returned, otherwise the output variable is returned.- 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)
Description copied from class:CodeGenerator
Lexically process $ and # references within the action. This will replace #id and #(...) with the appropriate function calls and/or variables etc...- Specified by:
processActionForSpecialSymbols
in classCodeGenerator
-
printSet
public void printSet(int depth, int k, Lookahead lookahead)
Format a lookahead or follow set.- Parameters:
depth
- The depth of the entire lookahead/followk
- The lookahead level to printlookahead
- The lookahead/follow set to print
-
-