antlr
Class CSharpCodeGenerator

java.lang.Object
  extended byantlr.CodeGenerator
      extended byantlr.CSharpCodeGenerator
public class CSharpCodeGenerator
extends CodeGenerator

Generates MyParser.cs, MyLexer.cs and MyParserTokenTypes.cs

Field Summary
static int caseSizeThreshold
           
 
Fields inherited from class antlr.CodeGenerator
TokenTypesFileExt, TokenTypesFileSuffix
 
Constructor Summary
CSharpCodeGenerator()
          Create a CSharp code-generator using the given Grammar.
 
Method Summary
 void exitIfError()
           
 void gen()
          Generate the parser, lexer, treeparser, and token types in CSharp
 void gen(antlr.ActionElement action)
          Generate code for the given grammar element.
 void gen(antlr.AlternativeBlock blk)
          Generate code for the given grammar element.
 void gen(antlr.BlockEndElement end)
          Generate code for the given grammar element.
 void gen(antlr.CharLiteralElement atom)
          Generate code for the given grammar element.
 void gen(antlr.CharRangeElement r)
          Generate code for the given grammar element.
 void gen(antlr.LexerGrammar g)
          Generate the lexer CSharp file
 void gen(antlr.OneOrMoreBlock blk)
          Generate code for the given grammar element.
 void gen(antlr.ParserGrammar g)
          Generate the parser CSharp file
 void gen(antlr.RuleRefElement rr)
          Generate code for the given grammar element.
 void gen(antlr.StringLiteralElement atom)
          Generate code for the given grammar element.
 void gen(antlr.TokenRangeElement r)
          Generate code for the given grammar element.
 void gen(antlr.TokenRefElement atom)
          Generate code for the given grammar element.
 void gen(antlr.TreeElement t)
          Generate code for the given grammar element.
 void gen(antlr.TreeWalkerGrammar g)
          Generate the tree-parser CSharp file
 void gen(antlr.WildcardElement wc)
          Generate code for the given grammar element.
 void gen(antlr.ZeroOrMoreBlock blk)
          Generate code for the given grammar element.
 void genBody(antlr.LexerGrammar g)
           
 void genBody(antlr.ParserGrammar g)
           
 void genBody(antlr.TreeWalkerGrammar g)
           
 antlr.CSharpBlockFinishingInfo 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.
 void genInitFactory(Grammar g)
           
 void genNextToken()
          Generate the nextToken() rule.
 void genRule(antlr.RuleSymbol s, boolean startSymbol, int ruleNum, antlr.TokenManager tm)
          Gen a named rule block.
 void genTokenStrings()
          Generate a static array containing the names of the tokens, indexed by the token type values.
 java.lang.String getASTCreateString(antlr.GrammarAtom atom, java.lang.String astCtorArgs)
          Get a string for an expression to generate creating of an AST node
 java.lang.String getASTCreateString(java.lang.String astCtorArgs)
          Returns a string expression that creates an AST node using the specified AST constructor argument string.
 java.lang.String getASTCreateString(Vector v)
          Get a string for an expression to generate creation of an AST subtree.
 java.lang.String getRangeExpression(int k, int[] elems)
          Return an expression for testing a contiguous renage of elements
 java.lang.String getTokenTypesClassName()
          Helper method that returns the name of the interface/class/enum type for token type constants.
 java.lang.String mapTreeId(java.lang.String idParam, ActionTransInfo transInfo)
          Map an identifier to it's corresponding tree-node variable.
 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.
 void setupOutput(java.lang.String className)
          This method exists so a subclass, namely VAJCodeGenerator, can open the file in its own evil way.
 
Methods inherited from class antlr.CodeGenerator
decodeLexerRuleName, elementsAreRange, encodeLexerRuleName, getFIRSTBitSet, getFOLLOWBitSet, reverseLexerRuleName, setAnalyzer, setBehavior, setTool
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

caseSizeThreshold

public static final int caseSizeThreshold
See Also:
Constant Field Values
Constructor Detail

CSharpCodeGenerator

public CSharpCodeGenerator()
Create a CSharp code-generator using the given Grammar. The caller must still call setTool, setBehavior, and setAnalyzer before generating code.

Method Detail

exitIfError

public void exitIfError()

gen

public void gen()
Generate the parser, lexer, treeparser, and token types in CSharp

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

genBody

public void genBody(antlr.LexerGrammar g)
             throws java.io.IOException
Throws:
java.io.IOException

genInitFactory

public void genInitFactory(Grammar g)

genBody

public void genBody(antlr.ParserGrammar g)
             throws java.io.IOException
Throws:
java.io.IOException

genBody

public void genBody(antlr.TreeWalkerGrammar g)
             throws java.io.IOException
Throws:
java.io.IOException

genCommonBlock

public antlr.CSharpBlockFinishingInfo 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,
                    antlr.TokenManager tm)
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.

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 class CodeGenerator
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 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)
Returns a string expression that creates an AST node using the specified AST constructor argument string. Parses the first (possibly only) argument in the supplied AST ctor argument string to obtain the token type -- ctorID. IF the token type is a valid token symbol AND it has an associated AST node type AND this is not a #[ID, "T", "ASTType"] constructor THEN generate a call to factory.create(ID, Text, token.ASTNodeType()) #[ID, "T", "ASTType"] constructors are mapped to astFactory.create(ID, "T", "ASTType") The supported AST constructor forms are: #[ID] #[ID, "text"] #[ID, "text", ASTclassname] -- introduced in 2.7.2

Parameters:
astCtorArgs - The arguments to the AST constructor

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

getTokenTypesClassName

public java.lang.String getTokenTypesClassName()
Helper method that returns the name of the interface/class/enum type for token type constants.