Java Doc for CSharpCodeGenerator.java in  » Parser » Rats-Parser-Generators » antlr » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Parser » Rats Parser Generators » antlr 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


antlr.CSharpCodeGenerator

CSharpCodeGenerator
public class CSharpCodeGenerator extends CodeGenerator (Code)
Generates MyParser.cs, MyLexer.cs and MyParserTokenTypes.cs


Field Summary
final protected static  StringNONUNIQUE
    
 intastVarNumber
    
 booleanbSaveIndexCreated
    
final public static  intcaseSizeThreshold
    
 StringcommonExtraArgs
    
 StringcommonExtraParams
    
 StringcommonLocalVars
    
 StringcurrentASTResult
    
 RuleBlockcurrentRule
    
 HashSetdeclaredASTVariables
    
 StringexceptionThrown
    
protected  booleangenAST
    
 StringlabeledElementASTType
    
 StringlabeledElementInit
    
 StringlabeledElementType
    
 Stringlt1Value
    
protected  booleansaveText
    
protected  intsyntacticPredLevel
    
 StringthrowNoViable
    
 HashtabletreeVariableMap
     Mapping between the ids used in the current alt, and the names of variables used to represent their AST values.
 booleanusingCustomAST
    

Constructor Summary
public  CSharpCodeGenerator()
     Create a CSharp code-generator using the given Grammar.

Method Summary
protected  intaddSemPred(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.
public  voidexitIfError()
    
public  voidgen()
    
public  voidgen(ActionElement action)
     Generate code for the given grammar element.
public  voidgen(AlternativeBlock blk)
     Generate code for the given grammar element.
public  voidgen(BlockEndElement end)
     Generate code for the given grammar element.
Parameters:
  blk - The block-end element to generate.
public  voidgen(CharLiteralElement atom)
     Generate code for the given grammar element.
public  voidgen(CharRangeElement r)
     Generate code for the given grammar element.
public  voidgen(LexerGrammar g)
    
public  voidgen(OneOrMoreBlock blk)
     Generate code for the given grammar element.
public  voidgen(ParserGrammar g)
    
public  voidgen(RuleRefElement rr)
     Generate code for the given grammar element.
public  voidgen(StringLiteralElement atom)
     Generate code for the given grammar element.
public  voidgen(TokenRangeElement r)
     Generate code for the given grammar element.
public  voidgen(TokenRefElement atom)
     Generate code for the given grammar element.
public  voidgen(TreeElement t)
    
public  voidgen(TreeWalkerGrammar g)
    
public  voidgen(WildcardElement wc)
     Generate code for the given grammar element.
public  voidgen(ZeroOrMoreBlock blk)
     Generate code for the given grammar element.
protected  voidgenASTDeclaration(AlternativeElement el)
    
protected  voidgenASTDeclaration(AlternativeElement el, String node_type)
    
protected  voidgenASTDeclaration(AlternativeElement el, String var_name, String node_type)
    
protected  voidgenAlt(Alternative alt, AlternativeBlock blk)
     Generate an alternative.
protected  voidgenBitsets(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  voidgenBlockInitAction(AlternativeBlock blk)
     Generate the init action for a block, which may be a RuleBlock or a plain AlternativeBLock.
protected  voidgenBlockPreamble(AlternativeBlock blk)
     Generate the header for a block, which may be a RuleBlock or a plain AlternativeBLock.
public  voidgenBody(LexerGrammar g)
    
public  voidgenBody(ParserGrammar g)
    
public  voidgenBody(TreeWalkerGrammar g)
    
protected  voidgenCases(BitSet p)
     Generate a series of case statements that implement a BitSet test.
public  CSharpBlockFinishingInfogenCommonBlock(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  voidgenHeader()
    
public  voidgenInitFactory(Grammar g)
    
protected  voidgenMatch(BitSet b)
    
protected  voidgenMatch(GrammarAtom atom)
    
protected  voidgenMatchUsingAtomText(GrammarAtom atom)
    
protected  voidgenMatchUsingAtomTokenType(GrammarAtom atom)
    
public  voidgenNextToken()
     Generate the nextToken() rule.
public  voidgenRule(RuleSymbol s, boolean startSymbol, int ruleNum, TokenManager tm)
     Gen a named rule block.
protected  voidgenSemPred(String pred, int line)
    
protected  voidgenSemPredMap()
     Write an array of Strings which are the semantic predicate expressions.
protected  voidgenSynPred(SynPredBlock blk, String lookaheadExpr)
    
protected  voidgenTokenDefinitions(TokenManager tm)
    
public  voidgenTokenStrings()
     Generate a static array containing the names of the tokens, indexed by the token type values.
protected  voidgenTokenTypes(TokenManager tm)
    
public  StringgetASTCreateString(Vector v)
     Get a string for an expression to generate creation of an AST subtree.
public  StringgetASTCreateString(GrammarAtom atom, String astCtorArgs)
    
public  StringgetASTCreateString(String astCtorArgs)
     Returns a string expression that creates an AST node using the specified AST constructor argument string.
protected  StringgetBitsetName(int index)
     Given the index of a bitset in the bitset list, generate a unique name.
protected  StringgetLookaheadTestExpression(Lookahead[] look, int k)
    
protected  StringgetLookaheadTestExpression(Alternative alt, int maxDepth)
     Generate a lookahead test expression for an alternate.
protected  StringgetLookaheadTestTerm(int k, BitSet p)
     Generate a depth==1 lookahead test expression given the BitSet.
public  StringgetRangeExpression(int k, int[] elems)
     Return an expression for testing a contiguous renage of elements
Parameters:
  k - The lookahead level
Parameters:
  elems - The elements representing the set, usually from BitSet.toArray().
public  StringgetTokenTypesClassName()
     Helper method that returns the name of the interface/class/enum type for token type constants.
protected  booleanlookaheadIsEmpty(Alternative alt, int maxDepth)
    
public  StringmapTreeId(String idParam, ActionTransInfo transInfo)
     Map an identifier to it's corresponding tree-node variable.
protected  StringprocessActionForSpecialSymbols(String actionStr, int line, RuleBlock currentRule, ActionTransInfo tInfo)
     Lexically process tree-specifiers in the action.
public  StringprocessStringForASTConstructor(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.
public  voidsetupOutput(String className)
     This method exists so a subclass, namely VAJCodeGenerator, can open the file in its own evil way.

Field Detail
NONUNIQUE
final protected static String NONUNIQUE(Code)
Special value used to mark duplicate in treeVariableMap



astVarNumber
int astVarNumber(Code)



bSaveIndexCreated
boolean bSaveIndexCreated(Code)



caseSizeThreshold
final public static int caseSizeThreshold(Code)



commonExtraArgs
String commonExtraArgs(Code)



commonExtraParams
String commonExtraParams(Code)



commonLocalVars
String commonLocalVars(Code)



currentASTResult
String currentASTResult(Code)



currentRule
RuleBlock currentRule(Code)



declaredASTVariables
HashSet declaredASTVariables(Code)
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



exceptionThrown
String exceptionThrown(Code)



genAST
protected boolean genAST(Code)



labeledElementASTType
String labeledElementASTType(Code)



labeledElementInit
String labeledElementInit(Code)



labeledElementType
String labeledElementType(Code)



lt1Value
String lt1Value(Code)



saveText
protected boolean saveText(Code)



syntacticPredLevel
protected int syntacticPredLevel(Code)



throwNoViable
String throwNoViable(Code)



treeVariableMap
Hashtable treeVariableMap(Code)
Mapping between the ids used in the current alt, and the names of variables used to represent their AST values.



usingCustomAST
boolean usingCustomAST(Code)




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




Method Detail
addSemPred
protected int addSemPred(String predicate)(Code)
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()(Code)



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



gen
public void gen(ActionElement action)(Code)
Generate code for the given grammar element.
Parameters:
  blk - The {...} action to generate



gen
public void gen(AlternativeBlock blk)(Code)
Generate code for the given grammar element.
Parameters:
  blk - The "x|y|z|..." block to generate



gen
public void gen(BlockEndElement end)(Code)
Generate code for the given grammar element.
Parameters:
  blk - The block-end element to generate. Block-endelements are synthesized by the grammar parser to representthe end of a block.



gen
public void gen(CharLiteralElement atom)(Code)
Generate code for the given grammar element.
Parameters:
  blk - The character literal reference to generate



gen
public void gen(CharRangeElement r)(Code)
Generate code for the given grammar element.
Parameters:
  blk - The character-range reference to generate



gen
public void gen(LexerGrammar g) throws IOException(Code)
Generate the lexer CSharp file



gen
public void gen(OneOrMoreBlock blk)(Code)
Generate code for the given grammar element.
Parameters:
  blk - The (...)+ block to generate



gen
public void gen(ParserGrammar g) throws IOException(Code)
Generate the parser CSharp file



gen
public void gen(RuleRefElement rr)(Code)
Generate code for the given grammar element.
Parameters:
  blk - The rule-reference to generate



gen
public void gen(StringLiteralElement atom)(Code)
Generate code for the given grammar element.
Parameters:
  blk - The string-literal reference to generate



gen
public void gen(TokenRangeElement r)(Code)
Generate code for the given grammar element.
Parameters:
  blk - The token-range reference to generate



gen
public void gen(TokenRefElement atom)(Code)
Generate code for the given grammar element.
Parameters:
  blk - The token-reference to generate



gen
public void gen(TreeElement t)(Code)



gen
public void gen(TreeWalkerGrammar g) throws IOException(Code)
Generate the tree-parser CSharp file



gen
public void gen(WildcardElement wc)(Code)
Generate code for the given grammar element.
Parameters:
  wc - The wildcard element to generate



gen
public void gen(ZeroOrMoreBlock blk)(Code)
Generate code for the given grammar element.
Parameters:
  blk - The (...)* block to generate



genASTDeclaration
protected void genASTDeclaration(AlternativeElement el)(Code)



genASTDeclaration
protected void genASTDeclaration(AlternativeElement el, String node_type)(Code)



genASTDeclaration
protected void genASTDeclaration(AlternativeElement el, String var_name, String node_type)(Code)



genAlt
protected void genAlt(Alternative alt, AlternativeBlock blk)(Code)
Generate an alternative.
Parameters:
  alt - The alternative to generate
Parameters:
  blk - The block to which the alternative belongs



genBitsets
protected void genBitsets(Vector bitsetList, int maxVocabulary)(Code)
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.
Parameters:
  maxVocabulary - Ensure that each generated bitset can contain at least this value.



genBlockInitAction
protected void genBlockInitAction(AlternativeBlock blk)(Code)
Generate the init action for a block, which may be a RuleBlock or a plain AlternativeBLock.



genBlockPreamble
protected void genBlockPreamble(AlternativeBlock blk)(Code)
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.



genBody
public void genBody(LexerGrammar g) throws IOException(Code)



genBody
public void genBody(ParserGrammar g) throws IOException(Code)



genBody
public void genBody(TreeWalkerGrammar g) throws IOException(Code)



genCases
protected void genCases(BitSet p)(Code)
Generate a series of case statements that implement a BitSet test.
Parameters:
  p - The Bitset for which cases are to be generated



genCommonBlock
public CSharpBlockFinishingInfo genCommonBlock(AlternativeBlock blk, boolean noTestForSingle)(Code)
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.



genHeader
protected void genHeader()(Code)
Generate a header that is common to all CSharp files



genInitFactory
public void genInitFactory(Grammar g)(Code)



genMatch
protected void genMatch(BitSet b)(Code)



genMatch
protected void genMatch(GrammarAtom atom)(Code)



genMatchUsingAtomText
protected void genMatchUsingAtomText(GrammarAtom atom)(Code)



genMatchUsingAtomTokenType
protected void genMatchUsingAtomTokenType(GrammarAtom atom)(Code)



genNextToken
public void genNextToken()(Code)
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, boolean startSymbol, int ruleNum, TokenManager tm)(Code)
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:
  rule - The name of the rule to generate
Parameters:
  startSymbol - true if the rule is a start symbol (i.e., not referenced elsewhere)



genSemPred
protected void genSemPred(String pred, int line)(Code)



genSemPredMap
protected void genSemPredMap()(Code)
Write an array of Strings which are the semantic predicate expressions. The debugger will reference them by number only



genSynPred
protected void genSynPred(SynPredBlock blk, String lookaheadExpr)(Code)



genTokenDefinitions
protected void genTokenDefinitions(TokenManager tm) throws IOException(Code)



genTokenStrings
public void genTokenStrings()(Code)
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.



genTokenTypes
protected void genTokenTypes(TokenManager tm) throws IOException(Code)
Generate the token types CSharp file



getASTCreateString
public String getASTCreateString(Vector v)(Code)
Get a string for an expression to generate creation of an AST subtree.
Parameters:
  v - A Vector of String, where each element is an expressionin the target language yielding an AST node.



getASTCreateString
public String getASTCreateString(GrammarAtom atom, String astCtorArgs)(Code)
Get a string for an expression to generate creating of an AST node
Parameters:
  atom - The grammar node for which you are creating the node
Parameters:
  str - The arguments to the AST constructor



getASTCreateString
public String getASTCreateString(String astCtorArgs)(Code)
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



getBitsetName
protected String getBitsetName(int index)(Code)
Given the index of a bitset in the bitset list, generate a unique name. Specific code-generators may want to override this if the language does not allow '_' or numerals in identifiers.
Parameters:
  index - The index of the bitset in the bitset list.



getLookaheadTestExpression
protected String getLookaheadTestExpression(Lookahead[] look, int k)(Code)



getLookaheadTestExpression
protected String getLookaheadTestExpression(Alternative alt, int maxDepth)(Code)
Generate a lookahead test expression for an alternate. This will be a series of tests joined by '&&' and enclosed by '()', the number of such tests being determined by the depth of the lookahead.



getLookaheadTestTerm
protected String getLookaheadTestTerm(int k, BitSet p)(Code)
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 >= && <= where possible, 3) a bitset membership test for complex comparisons
Parameters:
  k - The lookahead level
Parameters:
  p - The lookahead set for level k



getRangeExpression
public String getRangeExpression(int k, int[] elems)(Code)
Return an expression for testing a contiguous renage of elements
Parameters:
  k - The lookahead level
Parameters:
  elems - The elements representing the set, usually from BitSet.toArray(). String containing test expression.



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



lookaheadIsEmpty
protected boolean lookaheadIsEmpty(Alternative alt, int maxDepth)(Code)
Is the lookahead for this alt empty?



mapTreeId
public String mapTreeId(String idParam, ActionTransInfo transInfo)(Code)
Map an identifier to it's corresponding tree-node variable. This is context-sensitive, depending on the rule and alternative being generated
Parameters:
  idParam - The identifier name to map 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)(Code)
Lexically process tree-specifiers in the action. This will replace #id and #(...) with the appropriate function calls and/or variables.



processStringForASTConstructor
public String processStringForASTConstructor(String str)(Code)
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)
Parameters:
  str - A String.



setupOutput
public void setupOutput(String className) throws IOException(Code)
This method exists so a subclass, namely VAJCodeGenerator, can open the file in its own evil way. JavaCodeGenerator simply opens a text file...



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.