Package antlr

Class CppCodeGenerator

  • public class CppCodeGenerator
extends CodeGenerator
    Generate MyParser.cpp, MyParser.hpp, MyLexer.cpp, MyLexer.hpp and MyParserTokenTypes.hpp

    • Field Detail

      • DEBUG_CPP_CODE_GENERATOR

        boolean DEBUG_CPP_CODE_GENERATOR

      • syntacticPredLevel

        protected int syntacticPredLevel

      • genAST

        protected boolean genAST

      • saveText

        protected boolean saveText

      • genHashLines

        protected boolean genHashLines

      • noConstructors

        protected boolean noConstructors

      • outputLine

        protected int outputLine

      • outputFile

        protected java.lang.String outputFile

      • usingCustomAST

        boolean usingCustomAST

      • labeledElementType

        java.lang.String labeledElementType

      • labeledElementASTType

        java.lang.String labeledElementASTType

      • labeledElementASTInit

        java.lang.String labeledElementASTInit

      • labeledElementInit

        java.lang.String labeledElementInit

      • commonExtraArgs

        java.lang.String commonExtraArgs

      • commonExtraParams

        java.lang.String commonExtraParams

      • commonLocalVars

        java.lang.String commonLocalVars

      • lt1Value

        java.lang.String lt1Value

      • exceptionThrown

        java.lang.String exceptionThrown

      • throwNoViable

        java.lang.String throwNoViable

      • currentASTResult

        java.lang.String currentASTResult

      • treeVariableMap

        java.util.Hashtable treeVariableMap

      • declaredASTVariables

        java.util.Hashtable declaredASTVariables
        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

      • astVarNumber

        int astVarNumber

      • NONUNIQUE

        protected static final java.lang.String NONUNIQUE

    • Constructor Detail

      • CppCodeGenerator

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

    • Method Detail

      • addSemPred

        protected int addSemPred​(java.lang.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. This method should only be called when the debug option is specified

      • exitIfError

        public void exitIfError()

      • countLines

        protected int countLines​(java.lang.String s)

      • _print

        protected void _print​(java.lang.String s)
        Output a String to the currentOutput stream. Ignored if string is null.
        Overrides:
        _print in class CodeGenerator
        Parameters:
        s - The string to output

      • _printAction

        protected void _printAction​(java.lang.String s)
        Print an action without leading tabs, attempting to preserve the current indentation level for multi-line actions Ignored if string is null.
        Overrides:
        _printAction in class CodeGenerator
        Parameters:
        s - The action string to output

      • printAction

        public void printAction​(Token t)
        Print an action stored in a token surrounded by #line stuff

      • printHeaderAction

        public void printHeaderAction​(java.lang.String name)
        Print a header action by #line stuff also process any tree construction
        Parameters:
        name - The name of the header part

      • _println

        protected void _println​(java.lang.String s)
        Output a String followed by newline, to the currentOutput stream. Ignored if string is null.
        Overrides:
        _println in class CodeGenerator
        Parameters:
        s - The string to output

      • println

        protected void println​(java.lang.String s)
        Output tab indent followed by a String followed by newline, to the currentOutput stream. Ignored if string is null.
        Overrides:
        println in class CodeGenerator
        Parameters:
        s - The string to output

      • genLineNo

        public void genLineNo​(int line)
        Generate a #line or // line depending on options

      • genLineNo

        public void genLineNo​(GrammarElement el)
        Generate a #line or // line depending on options

      • genLineNo

        public void genLineNo​(Token t)
        Generate a #line or // line depending on options

      • genLineNo2

        public void genLineNo2()
        Generate a #line or // line depending on options

      • gen

        public void gen()
        Generate the parser, lexer, treeparser, and token types in C++
        Specified by:
        gen in class CodeGenerator

      • gen

        public void gen​(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​(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​(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​(CharLiteralElement atom)
        Generate code for the given grammar element. Only called from lexer grammars.
        Specified by:
        gen in class CodeGenerator
        Parameters:
        blk - The character literal reference to generate

      • gen

        public void gen​(CharRangeElement r)
        Generate code for the given grammar element. Only called from lexer grammars.
        Specified by:
        gen in class CodeGenerator
        Parameters:
        blk - The character-range reference to generate

      • gen

        public void gen​(LexerGrammar g)
         throws java.io.IOException
        Generate the lexer C++ files
        Specified by:
        gen in class CodeGenerator
        Throws:
        java.io.IOException

      • gen

        public void gen​(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​(ParserGrammar g)
         throws java.io.IOException
        Generate the parser C++ file
        Specified by:
        gen in class CodeGenerator
        Throws:
        java.io.IOException

      • gen

        public void gen​(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​(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​(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​(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​(TreeWalkerGrammar g)
         throws java.io.IOException
        Generate the tree-parser C++ files
        Specified by:
        gen in class CodeGenerator
        Throws:
        java.io.IOException

      • gen

        public void gen​(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​(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​(Alternative alt,
                      AlternativeBlock blk)
        Generate an alternative.
        Parameters:
        alt - The alternative to generate
        blk - The block to which the alternative belongs

      • genBitsets

        protected void genBitsets​(Vector bitsetList,
                          int maxVocabulary,
                          java.lang.String prefix)
        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.
        maxVocabulary - Ensure that each generated bitset can contain at least this value.
        prefix - string glued in from of bitset names used for namespace qualifications.

      • genBitsetsHeader

        protected void genBitsetsHeader​(Vector bitsetList,
                                int maxVocabulary)

      • genBlockInitAction

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

      • genBlockPreamble

        protected void genBlockPreamble​(AlternativeBlock blk)
        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 java.io.IOException
        Throws:
        java.io.IOException

      • genInitFactory

        public void genInitFactory​(Grammar g)

      • genBody

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

      • genBody

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

      • genCases

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

      • genCommonBlock

        public CppBlockFinishingInfo genCommonBlock​(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.
        Parameters:
        blk - The block to generate
        noTestForSingle - If true, then it does not generate a test for a single alternative.

      • genHeader

        protected void genHeader​(java.lang.String fileName)
        Generate a header that is common to all C++ files

      • genInclude

        public void genInclude​(LexerGrammar g)
                throws java.io.IOException
        Throws:
        java.io.IOException

      • genInclude

        public void genInclude​(ParserGrammar g)
                throws java.io.IOException
        Throws:
        java.io.IOException

      • genInclude

        public void genInclude​(TreeWalkerGrammar g)
                throws java.io.IOException
        Throws:
        java.io.IOException

      • genASTDeclaration

        protected void genASTDeclaration​(AlternativeElement el,
                                 java.lang.String node_type)

      • genASTDeclaration

        protected void genASTDeclaration​(AlternativeElement el,
                                 java.lang.String var_name,
                                 java.lang.String node_type)

      • genMatch

        protected void genMatch​(BitSet b)

      • genMatch

        protected void genMatch​(GrammarAtom atom)

      • genMatchUsingAtomText

        protected void genMatchUsingAtomText​(GrammarAtom atom)

      • genMatchUsingAtomTokenType

        protected void genMatchUsingAtomTokenType​(GrammarAtom atom)

      • 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.
        Parameters:
        RuleBlock -

      • genRule

        public void genRule​(RuleSymbol s,
                    boolean startSymbol,
                    int ruleNum,
                    java.lang.String prefix)
        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
        startSymbol - true if the rule is a start symbol (i.e., not referenced elsewhere)

      • genRuleHeader

        public void genRuleHeader​(RuleSymbol s,
                          boolean startSymbol)

      • genSemPred

        protected void genSemPred​(java.lang.String pred,
                          int line)

      • genSemPredMap

        protected void genSemPredMap​(java.lang.String prefix)
        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,
                          java.lang.String lookaheadExpr)

      • genTokenStrings

        public void genTokenStrings​(java.lang.String prefix)
        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 java.io.IOException
        Generate the token types C++ file
        Throws:
        java.io.IOException

      • 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​(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

      • getASTCreateString

        public java.lang.String getASTCreateString​(java.lang.String str)
        Get a string for an expression to generate creating of an AST node
        Parameters:
        str - The arguments to the AST constructor

      • getLookaheadTestExpression

        protected java.lang.String getLookaheadTestExpression​(Lookahead[] look,
                                                      int k)

      • getLookaheadTestExpression

        protected java.lang.String getLookaheadTestExpression​(Alternative alt,
                                                      int maxDepth)
        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 java.lang.String getLookaheadTestTerm​(int k,
                                                BitSet p)
        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
        p - The lookahead set for level k

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

      • lookaheadIsEmpty

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

      • 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

      • processActionForSpecialSymbols

        protected java.lang.String processActionForSpecialSymbols​(java.lang.String actionStr,
                                                          int line,
                                                          RuleBlock currentRule,
                                                          ActionTransInfo tInfo)
        Lexically process tree-specifiers in the action. This will replace #id and #(...) with the appropriate function calls and/or variables.
        Specified by:
        processActionForSpecialSymbols in class CodeGenerator