GNUCaParser.h

Go to the documentation of this file.

// [The "BSD licence"]
// Copyright (c) 2005-2009 Jim Idle, Temporal Wave LLC
// http://www.temporal-wave.com
// http://www.linkedin.com/in/jimidle
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. The name of the author may not be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef _GNUCaParser_H
#define _GNUCaParser_H
/* =============================================================================
 * Standard antlr3 C runtime definitions
 */
#include    <antlr3.h>

/* End of standard antlr 3 runtime definitions
 * =============================================================================
 */
 
#ifdef __cplusplus
extern "C" {
#endif

// Forward declare the context typedef so that we can use it before it is
// properly defined. Delegators and delegates (from import statements) are
// interdependent and their context structures contain pointers to each other
// C only allows such things to be declared if you pre-declare the typedef.
//
typedef struct GNUCaParser_Ctx_struct GNUCaParser, * pGNUCaParser;



#define HASH_SIZE       100


#ifdef  ANTLR3_WINDOWS
// Disable: Unreferenced parameter,                                                     - Rules with parameters that are not used
//          constant conditional,                                                       - ANTLR realizes that a prediction is always true (synpred usually)
//          initialized but unused variable                                     - tree rewrite variables declared but not needed
//          Unreferenced local variable                                         - lexer rule declares but does not always use _type
//          potentially unitialized variable used                       - retval always returned from a rule 
//                      unreferenced local function has been removed    - susually getTokenNames or freeScope, they can go without warnigns
//
// These are only really displayed at warning level /W4 but that is the code ideal I am aiming at
// and the codegen must generate some of these warnings by necessity, apart from 4100, which is
// usually generated when a parser rule is given a parameter that it does not use. Mostly though
// this is a matter of orthogonality hence I disable that one.
//
#pragma warning( disable : 4100 )
#pragma warning( disable : 4101 )
#pragma warning( disable : 4127 )
#pragma warning( disable : 4189 )
#pragma warning( disable : 4505 )
#pragma warning( disable : 4701 )
#endif

/* ========================
 * BACKTRACKING IS ENABLED
 * ========================
 */

/* globalAttributeScopeDecl(scope)
 */
/* makeScopeSet() 
 */
typedef struct  GNUCaParser_Symbols_SCOPE_struct
{
    void    (ANTLR3_CDECL *free)        (struct GNUCaParser_Symbols_SCOPE_struct * frame);
    
    /* =============================================================================
     * Programmer defined variables...
     */
    pANTLR3_HASH_TABLE types;

    /* End of programmer defined variables
     * =============================================================================
     */
} 
    GNUCaParser_Symbols_SCOPE, * pGNUCaParser_Symbols_SCOPE;
/* globalAttributeScopeDecl(scope)
 */
/* makeScopeSet() 
 */
typedef struct  GNUCaParser_Typedef_SCOPE_struct
{
    void    (ANTLR3_CDECL *free)        (struct GNUCaParser_Typedef_SCOPE_struct * frame);
    
    /* =============================================================================
     * Programmer defined variables...
     */
    _Bool isTypedef;

    /* End of programmer defined variables
     * =============================================================================
     */
} 
    GNUCaParser_Typedef_SCOPE, * pGNUCaParser_Typedef_SCOPE;

struct GNUCaParser_Ctx_struct
{
    pANTLR3_PARSER   pParser;
    /* globalAttributeScopeDef(scope)
     */
    pANTLR3_STACK pGNUCaParser_SymbolsStack;
    ANTLR3_UINT32 pGNUCaParser_SymbolsStack_limit;
    pGNUCaParser_Symbols_SCOPE    (*pGNUCaParser_SymbolsPush)(struct GNUCaParser_Ctx_struct * ctx);
    pGNUCaParser_Symbols_SCOPE    pGNUCaParser_SymbolsTop;


    /* globalAttributeScopeDef(scope)
     */
    pANTLR3_STACK pGNUCaParser_TypedefStack;
    ANTLR3_UINT32 pGNUCaParser_TypedefStack_limit;
    pGNUCaParser_Typedef_SCOPE    (*pGNUCaParser_TypedefPush)(struct GNUCaParser_Ctx_struct * ctx);
    pGNUCaParser_Typedef_SCOPE    pGNUCaParser_TypedefTop;


     void (*translationUnit)    (struct GNUCaParser_Ctx_struct * ctx);
     void (*externalDeclaration)        (struct GNUCaParser_Ctx_struct * ctx);
     void (*declarationOrFnDef) (struct GNUCaParser_Ctx_struct * ctx);
     void (*declarationSuffix)  (struct GNUCaParser_Ctx_struct * ctx);
     void (*functionDefinitionSuffix)   (struct GNUCaParser_Ctx_struct * ctx);
     void (*asmDefinition)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*simpleAsmExpr)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*asmStringLiteral)   (struct GNUCaParser_Ctx_struct * ctx);
     void (*declaration)        (struct GNUCaParser_Ctx_struct * ctx);
     void (*declarationSpecifiers)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*initDeclaratorList) (struct GNUCaParser_Ctx_struct * ctx);
     void (*initDeclarator)     (struct GNUCaParser_Ctx_struct * ctx);
     void (*storageClassSpecifier)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*typeSpecifier)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*structOrUnionSpecifier)     (struct GNUCaParser_Ctx_struct * ctx);
     void (*structOrUnion)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*structDeclaration)  (struct GNUCaParser_Ctx_struct * ctx);
     void (*specifierQualifier) (struct GNUCaParser_Ctx_struct * ctx);
     void (*structDeclaratorList)       (struct GNUCaParser_Ctx_struct * ctx);
     void (*structDeclarator)   (struct GNUCaParser_Ctx_struct * ctx);
     void (*enumSpecifier)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*enumeratorList)     (struct GNUCaParser_Ctx_struct * ctx);
     void (*enumerator) (struct GNUCaParser_Ctx_struct * ctx);
     void (*typeQualifier)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*functionSpecifier)  (struct GNUCaParser_Ctx_struct * ctx);
     void (*declarator) (struct GNUCaParser_Ctx_struct * ctx);
     void (*directDeclarator)   (struct GNUCaParser_Ctx_struct * ctx);
     void (*pointer)    (struct GNUCaParser_Ctx_struct * ctx);
     void (*parameterTypeList)  (struct GNUCaParser_Ctx_struct * ctx);
     void (*parameterList)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*parameterDeclaration)       (struct GNUCaParser_Ctx_struct * ctx);
     void (*identifierList)     (struct GNUCaParser_Ctx_struct * ctx);
     void (*typeName)   (struct GNUCaParser_Ctx_struct * ctx);
     void (*abstractDeclarator) (struct GNUCaParser_Ctx_struct * ctx);
     void (*directAbstractDeclarator)   (struct GNUCaParser_Ctx_struct * ctx);
     void (*arrayOrFunctionDeclarator)  (struct GNUCaParser_Ctx_struct * ctx);
     void (*typedefName)        (struct GNUCaParser_Ctx_struct * ctx);
     void (*typeofSpecifier)    (struct GNUCaParser_Ctx_struct * ctx);
     void (*initializer)        (struct GNUCaParser_Ctx_struct * ctx);
     void (*initializerList)    (struct GNUCaParser_Ctx_struct * ctx);
     void (*designation)        (struct GNUCaParser_Ctx_struct * ctx);
     void (*designator) (struct GNUCaParser_Ctx_struct * ctx);
     void (*arrayDesignator)    (struct GNUCaParser_Ctx_struct * ctx);
     void (*attributes) (struct GNUCaParser_Ctx_struct * ctx);
     void (*attribute)  (struct GNUCaParser_Ctx_struct * ctx);
     void (*attributeList)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*attrib)     (struct GNUCaParser_Ctx_struct * ctx);
     void (*primaryExpression)  (struct GNUCaParser_Ctx_struct * ctx);
     void (*offsetofMemberDesignator)   (struct GNUCaParser_Ctx_struct * ctx);
     void (*postfixExpression)  (struct GNUCaParser_Ctx_struct * ctx);
     void (*argumentExpressionList)     (struct GNUCaParser_Ctx_struct * ctx);
     void (*unaryExpression)    (struct GNUCaParser_Ctx_struct * ctx);
     void (*unaryOperator)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*castExpression)     (struct GNUCaParser_Ctx_struct * ctx);
     void (*multiplicativeExpression)   (struct GNUCaParser_Ctx_struct * ctx);
     void (*additiveExpression) (struct GNUCaParser_Ctx_struct * ctx);
     void (*shiftExpression)    (struct GNUCaParser_Ctx_struct * ctx);
     void (*relationalExpression)       (struct GNUCaParser_Ctx_struct * ctx);
     void (*equalityExpression) (struct GNUCaParser_Ctx_struct * ctx);
     void (*andExpression)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*xorExpression)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*orExpression)       (struct GNUCaParser_Ctx_struct * ctx);
     void (*landExpression)     (struct GNUCaParser_Ctx_struct * ctx);
     void (*lorExpression)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*conditionalExpression)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*assignmentExpression)       (struct GNUCaParser_Ctx_struct * ctx);
     void (*assignmentOperator) (struct GNUCaParser_Ctx_struct * ctx);
     void (*expression) (struct GNUCaParser_Ctx_struct * ctx);
     void (*constantExpression) (struct GNUCaParser_Ctx_struct * ctx);
     void (*statement)  (struct GNUCaParser_Ctx_struct * ctx);
     void (*labeledStatement)   (struct GNUCaParser_Ctx_struct * ctx);
     void (*compoundStatement)  (struct GNUCaParser_Ctx_struct * ctx);
     void (*blockItem)  (struct GNUCaParser_Ctx_struct * ctx);
     void (*labelDeclaration)   (struct GNUCaParser_Ctx_struct * ctx);
     void (*expressionStatement)        (struct GNUCaParser_Ctx_struct * ctx);
     void (*selectionStatement) (struct GNUCaParser_Ctx_struct * ctx);
     void (*iterationStatement) (struct GNUCaParser_Ctx_struct * ctx);
     void (*jumpStatement)      (struct GNUCaParser_Ctx_struct * ctx);
     void (*asmStatement)       (struct GNUCaParser_Ctx_struct * ctx);
     void (*asmArgument)        (struct GNUCaParser_Ctx_struct * ctx);
     void (*asmOperands)        (struct GNUCaParser_Ctx_struct * ctx);
     void (*asmOperand) (struct GNUCaParser_Ctx_struct * ctx);
     void (*asmClobbers)        (struct GNUCaParser_Ctx_struct * ctx);
     void (*asmLabels)  (struct GNUCaParser_Ctx_struct * ctx);
     void (*sTRING_LITERAL)     (struct GNUCaParser_Ctx_struct * ctx);
     void (*constant)   (struct GNUCaParser_Ctx_struct * ctx);
     ANTLR3_BOOLEAN (*synpred1_GNUCa)   (struct GNUCaParser_Ctx_struct * ctx);
     ANTLR3_BOOLEAN (*synpred2_GNUCa)   (struct GNUCaParser_Ctx_struct * ctx);
     ANTLR3_BOOLEAN (*synpred3_GNUCa)   (struct GNUCaParser_Ctx_struct * ctx);
     ANTLR3_BOOLEAN (*synpred4_GNUCa)   (struct GNUCaParser_Ctx_struct * ctx);
     ANTLR3_BOOLEAN (*synpred5_GNUCa)   (struct GNUCaParser_Ctx_struct * ctx);
     ANTLR3_BOOLEAN (*synpred6_GNUCa)   (struct GNUCaParser_Ctx_struct * ctx);
     ANTLR3_BOOLEAN (*synpred7_GNUCa)   (struct GNUCaParser_Ctx_struct * ctx);
     ANTLR3_BOOLEAN (*synpred8_GNUCa)   (struct GNUCaParser_Ctx_struct * ctx);
    // Delegated rules
    const char * (*getGrammarFileName)();
    void            (*free)   (struct GNUCaParser_Ctx_struct * ctx);
        
};

// Function protoypes for the constructor functions that external translation units
// such as delegators and delegates may wish to call.
//
ANTLR3_API pGNUCaParser GNUCaParserNew         (pANTLR3_COMMON_TOKEN_STREAM instream);
ANTLR3_API pGNUCaParser GNUCaParserNewSSD      (pANTLR3_COMMON_TOKEN_STREAM instream, pANTLR3_RECOGNIZER_SHARED_STATE state);

#ifdef  EOF
#undef  EOF
#endif
#ifdef  Tokens
#undef  Tokens
#endif 
#define OctalConstant      71
#define BinaryExponentPart      77
#define T__159      159
#define T__158      158
#define POINTER      36
#define NonDigit      58
#define T__160      160
#define BRACKET_DESIGNATOR      4
#define COMPLEX      6
#define E2      8
#define E1      7
#define E3      9
#define T__167      167
#define T__168      168
#define EOF      -1
#define T__165      165
#define T__166      166
#define T__163      163
#define T__164      164
#define T__161      161
#define T__162      162
#define T__93      93
#define T__94      94
#define T__91      91
#define T__92      92
#define T__148      148
#define STRING_LITERAL      56
#define T__147      147
#define T__90      90
#define T__149      149
#define Sign      63
#define T__154      154
#define T__155      155
#define T__156      156
#define T__157      157
#define T__99      99
#define T__150      150
#define T__98      98
#define FUNCTION_DEFINITION      39
#define T__151      151
#define T__97      97
#define T__152      152
#define T__96      96
#define T__153      153
#define T__95      95
#define T__139      139
#define T__138      138
#define T__137      137
#define T__136      136
#define T__82      82
#define T__83      83
#define XU      16
#define ASM      11
#define T__141      141
#define T__85      85
#define T__142      142
#define T__84      84
#define T__87      87
#define T__140      140
#define T__86      86
#define T__145      145
#define T__89      89
#define T__146      146
#define T__88      88
#define T__143      143
#define COMPOUND_LITERAL      30
#define T__144      144
#define T__126      126
#define T__125      125
#define T__128      128
#define T__127      127
#define DESIGNATOR      27
#define WS      78
#define T__129      129
#define TYPEOF      21
#define COMPOUND_STATEMENT      51
#define IntegerSuffix      70
#define EXPRESSION_STATEMENT      10
#define FUNCTION_CALL      53
#define T__130      130
#define T__131      131
#define T__132      132
#define T__133      133
#define T__134      134
#define T__135      135
#define CAST_EXPRESSION      48
#define T__118      118
#define T__119      119
#define T__116      116
#define T__117      117
#define T__114      114
#define T__115      115
#define T__124      124
#define T__123      123
#define T__122      122
#define T__121      121
#define T__120      120
#define DECLARATION      44
#define HexDigit      62
#define ASSIGNMENT_EXPRESSION      22
#define XTYPE_SPECIFIER      41
#define AU      17
#define T__107      107
#define T__108      108
#define T__109      109
#define T__103      103
#define T__104      104
#define T__105      105
#define T__106      106
#define T__111      111
#define T__110      110
#define PU      14
#define ENUMERATOR      28
#define T__113      113
#define T__112      112
#define PP      12
#define XTYPE_QUALIFIER      42
#define XSTORAGE_CLASS      43
#define T__102      102
#define T__101      101
#define T__100      100
#define TRANSLATION_UNIT      29
#define FloatingSuffix      76
#define XID      40
#define EXTENSION      57
#define OctalEscape      64
#define SIGNED      5
#define UniversalCharacterName      66
#define DecimalConstant      69
#define DecimalFloatingConstant      73
#define MU      15
#define TYPEDEF_NAME      20
#define HexadecimalFloatingConstant      74
#define MM      13
#define PARAMETER      32
#define ExponentPart      75
#define COMMENT      79
#define LINE_COMMENT      80
#define FUNCTION_DECLARATOR      24
#define HexadecimalEscape      65
#define DECLARATOR      35
#define ICONSTANT      67
#define RCONSTANT      68
#define STR_LITERAL      54
#define LINE_COMMAND      81
#define INIT_DECLARATOR      45
#define BASETYPE      47
#define EscapeSequence      60
#define ABSTRACT_DECLARATOR      34
#define VARARGS      33
#define CharacterLiteral      61
#define ALIGNOF      52
#define INITIALIZER      26
#define STRUCT_DECLARATOR      37
#define T__194      194
#define T__193      193
#define T__192      192
#define T__191      191
#define CONDITIONAL_EXPRESSION      49
#define T__190      190
#define IDENTIFIER      55
#define TYPE_NAME      23
#define T__184      184
#define T__183      183
#define T__186      186
#define T__185      185
#define T__188      188
#define T__187      187
#define T__189      189
#define T__180      180
#define HexadecimalConstant      72
#define T__182      182
#define T__181      181
#define ARRAY_ACCESS      31
#define Digit      59
#define T__175      175
#define ARRAY_DECLARATOR      25
#define T__174      174
#define T__173      173
#define T__172      172
#define T__179      179
#define T__178      178
#define T__177      177
#define BUILTIN_OFFSETOF      19
#define T__176      176
#define LABEL      50
#define LABREF      18
#define STRUCT_DECLARATION      38
#define T__171      171
#define T__170      170
#define DECLARATION_SPECIFIERS      46
#define T__169      169
#ifdef  EOF
#undef  EOF
#define EOF     ANTLR3_TOKEN_EOF
#endif

#ifndef TOKENSOURCE
#define TOKENSOURCE(lxr) lxr->pLexer->rec->state->tokSource
#endif

/* End of token definitions for GNUCaParser
 * =============================================================================
 */
#ifdef __cplusplus
}
#endif

#endif

/* END - Note:Keep extra line feed to satisfy UNIX systems */