bundles/org.simantics.databoard/cpp/DataBoardTest/libantlr3c-3.2/include/antlr3parser.h

   1 /** \file
   2  * Base implementation of an ANTLR3 parser.
   3  *
   4  *
   5  */
   6 #ifndef _ANTLR3_PARSER_H
   7 #define _ANTLR3_PARSER_H
   8
   9 // [The "BSD licence"]
  10 // Copyright (c) 2005-2009 Jim Idle, Temporal Wave LLC
  11 // http://www.temporal-wave.com
  12 // http://www.linkedin.com/in/jimidle
  13 //
  14 // All rights reserved.
  15 //
  16 // Redistribution and use in source and binary forms, with or without
  17 // modification, are permitted provided that the following conditions
  18 // are met:
  19 // 1. Redistributions of source code must retain the above copyright
  20 //    notice, this list of conditions and the following disclaimer.
  21 // 2. Redistributions in binary form must reproduce the above copyright
  22 //    notice, this list of conditions and the following disclaimer in the
  23 //    documentation and/or other materials provided with the distribution.
  24 // 3. The name of the author may not be used to endorse or promote products
  25 //    derived from this software without specific prior written permission.
  26 //
  27 // THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  28 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  29 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  30 // IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  31 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  32 // NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  33 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  34 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  35 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  36 // THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37
  38 #include    <antlr3defs.h>
  39 #include    <antlr3baserecognizer.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /** This is the main interface for an ANTLR3 parser.
  46  */
  47 typedef struct ANTLR3_PARSER_struct
  48 {
  49     /** All superstructure implementers of this interface require a pointer to their selves,
  50      *  which they can reference using the super pointer here.
  51      */
  52     void                        * super;
  53
  54     /** A pointer to the base recognizer, where most of the parser functions actually
  55      *  live because they are shared between parser and tree parser and this is the
  56      *  easier way than copying the interface all over the place. Macros hide this
  57      *  for the generated code so it is easier on the eye (though not the debugger ;-).
  58      */
  59     pANTLR3_BASE_RECOGNIZER                     rec;
  60
  61     /** A provider of a tokenstream interface, for the parser to consume
  62      *  tokens from.
  63      */
  64     pANTLR3_TOKEN_STREAM                        tstream;
  65
  66         /** A pointer to a function that installs a debugger object (it also
  67          *  installs the debugging versions of the parser methods. This means that
  68          *  a non debug parser incurs no overhead because of the debugging stuff.
  69          */
  70         void                                    (*setDebugListener)     (struct ANTLR3_PARSER_struct    * parser, pANTLR3_DEBUG_EVENT_LISTENER dbg);
  71
  72     /** A pointer to a function that installs a token stream
  73      * for the parser.
  74      */
  75     void                                        (*setTokenStream)       (struct ANTLR3_PARSER_struct    * parser, pANTLR3_TOKEN_STREAM);
  76
  77     /** A pointer to a function that returns the token stream for this
  78      *  parser.
  79      */
  80     pANTLR3_TOKEN_STREAM        (*getTokenStream)       (struct ANTLR3_PARSER_struct    * parser);
  81
  82     /** Pointer to a function that knows how to free resources of an ANTLR3 parser.
  83      */
  84     void                        (*free)                 (struct ANTLR3_PARSER_struct    * parser);
  85
  86 }
  87     ANTLR3_PARSER;
  88
  89 #ifdef __cplusplus
  90 }
  91 #endif
  92
  93 #endif