antlr
Class JavaCodeGenerator

java.lang.Object
  antlr.CodeGenerator
      antlr.JavaCodeGenerator

public class JavaCodeGenerator

extends CodeGenerator

Generate MyParser.java, MyLexer.java and MyParserTokenTypes.java

caseSizeThreshold

public static final int caseSizeThreshold

See Also:

Constant Field Values

JavaCodeGenerator

public JavaCodeGenerator()

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

exitIfError

public void exitIfError()

gen

public void gen()

Generate the parser, lexer, treeparser, and token types in Java

Specified by:

gen in class CodeGenerator

gen

public void gen(antlr.ActionElement action)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

action - The {...} action to generate

gen

public void gen(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(antlr.BlockEndElement end)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

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

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

atom - The character literal reference to generate

gen

public void gen(antlr.CharRangeElement r)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

r - The character-range reference to generate

gen

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

Generate the lexer Java file

Specified by:

gen in class CodeGenerator

Throws:

java.io.IOException

gen

public void gen(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(antlr.ParserGrammar g)
         throws java.io.IOException

Generate the parser Java file

Specified by:

gen in class CodeGenerator

Throws:

java.io.IOException

gen

public void gen(antlr.RuleRefElement rr)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

rr - The rule-reference to generate

gen

public void gen(antlr.StringLiteralElement atom)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

atom - The string-literal reference to generate

gen

public void gen(antlr.TokenRangeElement r)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

r - The token-range reference to generate

gen

public void gen(antlr.TokenRefElement atom)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

atom - The token-reference to generate

gen

public void gen(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(antlr.TreeWalkerGrammar g)
         throws java.io.IOException

Generate the tree-parser Java file

Specified by:

gen in class CodeGenerator

Throws:

java.io.IOException

gen

public void gen(antlr.WildcardElement wc)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

wc - The wildcard element to generate

gen

public void gen(antlr.ZeroOrMoreBlock blk)

Generate code for the given grammar element.

Specified by:

gen in class CodeGenerator

Parameters:

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

genCommonBlock

public antlr.JavaBlockFinishingInfo genCommonBlock(antlr.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. @param blk The block to generate @param noTestForSingle If true, then it does not generate a test for a single alternative.

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(antlr.RuleSymbol s,
                    boolean startSymbol,
                    int ruleNum)

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)

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.

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

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

Specified by:

getASTCreateString in class CodeGenerator

Parameters:

atom - The grammar node for which you are creating the node

astCtorArgs - The text of the arguments to the AST construction

getASTCreateString

public java.lang.String getASTCreateString(java.lang.String astCtorArgs)

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].

getRangeExpression

public java.lang.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.

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

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

setupOutput

public void setupOutput(java.lang.String className)
                 throws java.io.IOException

This method exists so a subclass, namely VAJCodeGenerator, can open the file in its own evil way. JavaCodeGenerator simply opens a text file...

Throws:

java.io.IOException