persistence.antlr

Class DocBookCodeGenerator

java.lang.Object

persistence.antlr.CodeGenerator

persistence.antlr.DocBookCodeGenerator

public class DocBookCodeGenerator
extends CodeGenerator

Generate P.sgml, a cross-linked representation of P with or without actions

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	doingLexRules true during lexer generation, false during parser generation
protected boolean	firstElementInAlt
protected persistence.antlr.AlternativeElement	prevAltElem
protected int	syntacticPredLevel non-zero if inside syntactic predicate generation

Fields inherited from class persistence.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 and Description
DocBookCodeGenerator() Create a Diagnostic code-generator using the given Grammar The caller must still call setTool, setBehavior, and setAnalyzer before generating code.

Method Summary

Methods

Modifier and Type	Method and Description
void	gen() Generate the code for all grammars
void	gen(persistence.antlr.ActionElement action) Generate code for the given grammar element.
void	gen(persistence.antlr.AlternativeBlock blk) Generate code for the given grammar element.
void	gen(persistence.antlr.BlockEndElement end) Generate code for the given grammar element.
void	gen(persistence.antlr.CharLiteralElement atom) Generate code for the given grammar element.
void	gen(persistence.antlr.CharRangeElement r) Generate code for the given grammar element.
void	gen(persistence.antlr.LexerGrammar g) Generate the lexer HTML file
void	gen(persistence.antlr.OneOrMoreBlock blk) Generate code for the given grammar element.
void	gen(persistence.antlr.ParserGrammar g) Generate the parser HTML file
void	gen(persistence.antlr.RuleRefElement rr) Generate code for the given grammar element.
void	gen(persistence.antlr.StringLiteralElement atom) Generate code for the given grammar element.
void	gen(persistence.antlr.TokenRangeElement r) Generate code for the given grammar element.
void	gen(persistence.antlr.TokenRefElement atom) Generate code for the given grammar element.
void	gen(persistence.antlr.TreeElement t) Generate code for the given grammar element.
void	gen(persistence.antlr.TreeWalkerGrammar g) Generate the tree-walker TXT file
void	gen(persistence.antlr.WildcardElement wc) Generate a wildcard element
void	gen(persistence.antlr.ZeroOrMoreBlock blk) Generate code for the given grammar element.
protected void	genAlt(persistence.antlr.Alternative alt)
void	genCommonBlock(persistence.antlr.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(persistence.antlr.AlternativeBlock blk, java.lang.String blkOp)
protected void	genHeader() Generate a header that is common to all TXT files
protected void	genLookaheadSetForAlt(persistence.antlr.Alternative alt) Generate the lookahead set for an alternate.
void	genLookaheadSetForBlock(persistence.antlr.AlternativeBlock blk) Generate a textual representation of the lookahead set for a block.
void	genNextToken() Generate the nextToken rule.
void	genRule(persistence.antlr.RuleSymbol s) Generate code for a named rule block
protected void	genSynPred(persistence.antlr.SynPredBlock blk) Generate the syntactic predicate.
void	genTail()
protected void	genTokenTypes(persistence.antlr.TokenManager tm) Generate the token types TXT file
java.lang.String	getASTCreateString(persistence.antlr.GrammarAtom atom, java.lang.String str) Get a string for an expression to generate creating of an AST node
java.lang.String	getASTCreateString(persistence.antlr.collections.impl.Vector v) Get a string for an expression to generate creation of an AST subtree.
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 persistence.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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 persistence.antlr.AlternativeElement prevAltElem

Constructor Detail

DocBookCodeGenerator

public DocBookCodeGenerator()

Create a Diagnostic code-generator using the given Grammar The caller must still call setTool, setBehavior, and setAnalyzer before generating code.

Method Detail

gen

public void gen()

Description copied from class: CodeGenerator

Generate the code for all grammars

Specified by:

gen in class CodeGenerator

gen

public void gen(persistence.antlr.ActionElement action)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

blk - The {...} action to generate

gen

public void gen(persistence.antlr.AlternativeBlock blk)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

blk - The "x|y|z|..." block to generate

gen

public void gen(persistence.antlr.BlockEndElement end)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

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(persistence.antlr.CharLiteralElement atom)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

blk - The character literal reference to generate

gen

public void gen(persistence.antlr.CharRangeElement r)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

blk - The character-range reference to generate

gen

public void gen(persistence.antlr.LexerGrammar g)
         throws java.io.IOException

Generate the lexer HTML file

Specified by:

gen in class CodeGenerator

Throws:

java.io.IOException

gen

public void gen(persistence.antlr.OneOrMoreBlock blk)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

blk - The (...)+ block to generate

gen

public void gen(persistence.antlr.ParserGrammar g)
         throws java.io.IOException

Generate the parser HTML file

Specified by:

gen in class CodeGenerator

Throws:

java.io.IOException

gen

public void gen(persistence.antlr.RuleRefElement rr)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

blk - The rule-reference to generate

gen

public void gen(persistence.antlr.StringLiteralElement atom)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

blk - The string-literal reference to generate

gen

public void gen(persistence.antlr.TokenRangeElement r)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

blk - The token-range reference to generate

gen

public void gen(persistence.antlr.TokenRefElement atom)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

blk - The token-reference to generate

gen

public void gen(persistence.antlr.TreeElement t)

Description copied from class: CodeGenerator

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

gen

public void gen(persistence.antlr.TreeWalkerGrammar g)
         throws java.io.IOException

Generate the tree-walker TXT file

Specified by:

gen in class CodeGenerator

Throws:

java.io.IOException

gen

public void gen(persistence.antlr.WildcardElement wc)

Generate a wildcard element

Specified by:

gen in class CodeGenerator

Parameters:

wc - The wildcard element to generate

gen

public void gen(persistence.antlr.ZeroOrMoreBlock blk)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

blk - The (...)* block to generate

genAlt

protected void genAlt(persistence.antlr.Alternative alt)

genCommonBlock

public void genCommonBlock(persistence.antlr.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(persistence.antlr.AlternativeBlock blk,
                   java.lang.String blkOp)

genHeader

protected void genHeader()

Generate a header that is common to all TXT files

genLookaheadSetForAlt

protected void genLookaheadSetForAlt(persistence.antlr.Alternative alt)

Generate the lookahead set for an alternate.

genLookaheadSetForBlock

public void genLookaheadSetForBlock(persistence.antlr.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(persistence.antlr.RuleSymbol s)

Generate code for a named rule block

Parameters:

s - The RuleSymbol describing the rule to generate

genSynPred

protected void genSynPred(persistence.antlr.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(persistence.antlr.TokenManager tm)
                      throws java.io.IOException

Generate the token types TXT file

Throws:

java.io.IOException

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 class CodeGenerator

getASTCreateString

public java.lang.String getASTCreateString(persistence.antlr.collections.impl.Vector v)

Get a string for an expression to generate creation of an AST subtree.

Specified by:

getASTCreateString in class CodeGenerator

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(persistence.antlr.GrammarAtom atom,
                                  java.lang.String str)

Get a string for an expression to generate creating of an AST node

Specified by:

getASTCreateString in class CodeGenerator

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 class CodeGenerator

Parameters:

id - The identifier name to map

forInput - 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

printSet

public void printSet(int depth,
            int k,
            Lookahead lookahead)

Format a lookahead or follow set.

Parameters:

depth - The depth of the entire lookahead/follow

k - The lookahead level to print

lookahead - The lookahead/follow set to print