2 * Declarations for all the antlr3 C runtime interfaces/classes. This
\r
3 * allows the structures that define the interfaces to contain pointers to
\r
4 * each other without trying to sort out the cyclic interdependencies that
\r
5 * would otherwise result.
\r
7 #ifndef _ANTLR3_INTERFACES_H
\r
8 #define _ANTLR3_INTERFACES_H
\r
10 // [The "BSD licence"]
\r
11 // Copyright (c) 2005-2009 Jim Idle, Temporal Wave LLC
\r
12 // http://www.temporal-wave.com
\r
13 // http://www.linkedin.com/in/jimidle
\r
15 // All rights reserved.
\r
17 // Redistribution and use in source and binary forms, with or without
\r
18 // modification, are permitted provided that the following conditions
\r
20 // 1. Redistributions of source code must retain the above copyright
\r
21 // notice, this list of conditions and the following disclaimer.
\r
22 // 2. Redistributions in binary form must reproduce the above copyright
\r
23 // notice, this list of conditions and the following disclaimer in the
\r
24 // documentation and/or other materials provided with the distribution.
\r
25 // 3. The name of the author may not be used to endorse or promote products
\r
26 // derived from this software without specific prior written permission.
\r
28 // THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
\r
29 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
\r
30 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
\r
31 // IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
\r
32 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
\r
33 // NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
\r
34 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
\r
35 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
\r
36 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
\r
37 // THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\r
43 typedef struct ANTLR3_INT_STREAM_struct *pANTLR3_INT_STREAM;
\r
45 /// Pointer to an instantiation of the 'class' #ANTLR3_BASE_RECOGNIZER
\r
46 /// \ingroup ANTLR3_BASE_RECOGNIZER
\r
48 typedef struct ANTLR3_BASE_RECOGNIZER_struct *pANTLR3_BASE_RECOGNIZER;
\r
49 /// Pointer to an instantiation of 'class' #ANTLR3_RECOGNIZER_SHARED_STATE
\r
50 /// \ingroup ANTLR3_RECOGNIZER_SHARED_STATE
\r
52 typedef struct ANTLR3_RECOGNIZER_SHARED_STATE_struct *pANTLR3_RECOGNIZER_SHARED_STATE;
\r
54 /// Pointer to an instantiation of 'class' #ANTLR3_BITSET_LIST
\r
55 /// \ingroup ANTLR3_BITSET_LIST
\r
57 typedef struct ANTLR3_BITSET_LIST_struct *pANTLR3_BITSET_LIST;
\r
59 /// Pointer to an instantiation of 'class' #ANTLR3_BITSET
\r
60 /// \ingroup ANTLR3_BITSET
\r
62 typedef struct ANTLR3_BITSET_struct *pANTLR3_BITSET;
\r
64 /// Pointer to an instantiation of 'class' #ANTLR3_TOKEN_FACTORY
\r
65 /// \ingroup ANTLR3_TOKEN_FACTORY
\r
67 typedef struct ANTLR3_TOKEN_FACTORY_struct *pANTLR3_TOKEN_FACTORY;
\r
68 /// Pointer to an instantiation of 'class' #ANTLR3_COMMON_TOKEN
\r
69 /// \ingroup ANTLR3_COMMON_TOKEN
\r
71 typedef struct ANTLR3_COMMON_TOKEN_struct *pANTLR3_COMMON_TOKEN;
\r
73 /// Pointer to an instantiation of 'class' #ANTLR3_EXCEPTION
\r
74 /// \ingroup ANTLR3_EXCEPTION
\r
76 typedef struct ANTLR3_EXCEPTION_struct *pANTLR3_EXCEPTION;
\r
78 /// Pointer to an instantiation of 'class' #ANTLR3_HASH_BUCKET
\r
79 /// \ingroup ANTLR3_HASH_BUCKET
\r
81 typedef struct ANTLR3_HASH_BUCKET_struct *pANTLR3_HASH_BUCKET;
\r
82 /// Pointer to an instantiation of 'class' #ANTLR3_HASH_ENTRY
\r
83 /// \ingroup ANTLR3_HASH_ENTRY
\r
85 typedef struct ANTLR3_HASH_ENTRY_struct *pANTLR3_HASH_ENTRY;
\r
86 /// Pointer to an instantiation of 'class' #ANTLR3_HASH_ENUM
\r
87 /// \ingroup ANTLR3_HASH_ENUM
\r
89 typedef struct ANTLR3_HASH_ENUM_struct *pANTLR3_HASH_ENUM;
\r
90 /// Pointer to an instantiation of 'class' #ANTLR3_HASH_TABLE
\r
91 /// \ingroup ANTLR3_HASH_TABLE
\r
93 typedef struct ANTLR3_HASH_TABLE_struct *pANTLR3_HASH_TABLE;
\r
95 /// Pointer to an instantiation of 'class' #ANTLR3_LIST
\r
96 /// \ingroup ANTLR3_LIST
\r
98 typedef struct ANTLR3_LIST_struct *pANTLR3_LIST;
\r
99 /// Pointer to an instantiation of 'class' #ANTLR3_VECTOR_FACTORY
\r
100 /// \ingroup ANTLR3_VECTOR_FACTORY
\r
102 typedef struct ANTLR3_VECTOR_FACTORY_struct *pANTLR3_VECTOR_FACTORY;
\r
103 /// Pointer to an instantiation of 'class' #ANTLR3_VECTOR
\r
104 /// \ingroup ANTLR3_VECTOR
\r
106 typedef struct ANTLR3_VECTOR_struct *pANTLR3_VECTOR;
\r
107 /// Pointer to an instantiation of 'class' #ANTLR3_STACK
\r
108 /// \ingroup ANTLR3_STACK
\r
110 typedef struct ANTLR3_STACK_struct *pANTLR3_STACK;
\r
112 /// Pointer to an instantiation of 'class' #ANTLR3_TOPO
\r
113 /// \ingroup ANTLR3_TOPO
\r
115 typedef struct ANTLR3_TOPO_struct *pANTLR3_TOPO;
\r
117 /// Pointer to an instantiation of 'class' #ANTLR3_INPUT_STREAM
\r
118 /// \ingroup ANTLR3_INPUT_STREAM
\r
120 typedef struct ANTLR3_INPUT_STREAM_struct *pANTLR3_INPUT_STREAM;
\r
121 /// Pointer to an instantiation of 'class' #ANTLR3_LEX_STATE
\r
122 /// \ingroup ANTLR3_LEX_STATE
\r
124 typedef struct ANTLR3_LEX_STATE_struct *pANTLR3_LEX_STATE;
\r
126 /// Pointer to an instantiation of 'class' #ANTLR3_STRING_FACTORY
\r
127 /// \ingroup ANTLR3_STRING_FACTORY
\r
129 typedef struct ANTLR3_STRING_FACTORY_struct *pANTLR3_STRING_FACTORY;
\r
130 /// Pointer to an instantiation of 'class' #ANTLR3_STRING
\r
131 /// \ingroup ANTLR3_STRING
\r
133 typedef struct ANTLR3_STRING_struct *pANTLR3_STRING;
\r
135 /// Pointer to an instantiation of 'class' #ANTLR3_TOKEN_SOURCE
\r
136 /// \ingroup ANTLR3_TOKEN_SOURCE
\r
138 typedef struct ANTLR3_TOKEN_SOURCE_struct *pANTLR3_TOKEN_SOURCE;
\r
139 /// Pointer to an instantiation of 'class' #ANTLR3_TOKEN_STREAM
\r
140 /// \ingroup ANTLR3_TOKEN_STREAM
\r
142 typedef struct ANTLR3_TOKEN_STREAM_struct *pANTLR3_TOKEN_STREAM;
\r
143 /// Pointer to an instantiation of 'class' #ANTLR3_COMMON_TOKEN_STREAM
\r
144 /// \ingroup ANTLR3_COMMON_TOKEN_STREAM
\r
146 typedef struct ANTLR3_COMMON_TOKEN_STREAM_struct *pANTLR3_COMMON_TOKEN_STREAM;
\r
148 /// Pointer to an instantiation of 'class' #ANTLR3_CYCLIC_DFA
\r
149 /// \ingroup ANTLR3_CYCLIC_DFA
\r
151 typedef struct ANTLR3_CYCLIC_DFA_struct *pANTLR3_CYCLIC_DFA;
\r
153 /// Pointer to an instantiation of 'class' #ANTLR3_LEXER
\r
154 /// \ingroup ANTLR3_LEXER
\r
156 typedef struct ANTLR3_LEXER_struct *pANTLR3_LEXER;
\r
157 /// Pointer to an instantiation of 'class' #ANTLR3_PARSER
\r
158 /// \ingroup ANTLR3_PARSER
\r
160 typedef struct ANTLR3_PARSER_struct *pANTLR3_PARSER;
\r
162 /// Pointer to an instantiation of 'class' #ANTLR3_BASE_TREE
\r
163 /// \ingroup ANTLR3_BASE_TREE
\r
165 typedef struct ANTLR3_BASE_TREE_struct *pANTLR3_BASE_TREE;
\r
166 /// Pointer to an instantiation of 'class' #ANTLR3_COMMON_TREE
\r
167 /// \ingroup ANTLR3_COMMON_TREE
\r
169 typedef struct ANTLR3_COMMON_TREE_struct *pANTLR3_COMMON_TREE;
\r
170 /// Pointer to an instantiation of 'class' #ANTLR3_ARBORETUM
\r
171 /// \ingroup ANTLR3_ARBORETUM
\r
173 typedef struct ANTLR3_ARBORETUM_struct *pANTLR3_ARBORETUM;
\r
174 /// Pointer to an instantiation of 'class' #ANTLR3_PARSE_TREE
\r
175 /// \ingroup ANTLR3_PARSE_TREE
\r
177 typedef struct ANTLR3_PARSE_TREE_struct *pANTLR3_PARSE_TREE;
\r
179 /// Pointer to an instantiation of 'class' #ANTLR3_TREE_NODE_STREAM
\r
180 /// \ingroup ANTLR3_TREE_NODE_STREAM
\r
182 typedef struct ANTLR3_TREE_NODE_STREAM_struct *pANTLR3_TREE_NODE_STREAM;
\r
183 /// Pointer to an instantiation of 'class' #ANTLR3_COMMON_TREE_NODE_STREAM
\r
184 /// \ingroup ANTLR3_COMMON_TREE_NODE_STREAM
\r
186 typedef struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *pANTLR3_COMMON_TREE_NODE_STREAM;
\r
187 /// Pointer to an instantiation of 'class' #ANTLR3_TREE_WALK_STATE
\r
188 /// \ingroup ANTLR3_TREE_WALK_STATE
\r
190 typedef struct ANTLR3_TREE_WALK_STATE_struct *pANTLR3_TREE_WALK_STATE;
\r
192 /// Pointer to an instantiation of 'class' #ANTLR3_BASE_TREE_ADAPTOR
\r
193 /// \ingroup ANTLR3_BASE_TREE_ADAPTOR
\r
195 typedef struct ANTLR3_BASE_TREE_ADAPTOR_struct *pANTLR3_BASE_TREE_ADAPTOR;
\r
196 /// Pointer to an instantiation of 'class' #ANTLR3_COMMON_TREE_ADAPTOR
\r
197 /// \ingroup ANTLR3_COMMON_TREE_ADAPTOR
\r
199 typedef struct ANTLR3_COMMON_TREE_ADAPTOR_struct *pANTLR3_COMMON_TREE_ADAPTOR;
\r
201 /// Pointer to an instantiation of 'class' #ANTLR3_TREE_PARSER
\r
202 /// \ingroup ANTLR3_TREE_PARSER
\r
204 typedef struct ANTLR3_TREE_PARSER_struct *pANTLR3_TREE_PARSER;
\r
206 /// Pointer to an instantiation of 'class' #ANTLR3_INT_TRIE
\r
207 /// \ingroup ANTLR3_INT_TRIE
\r
209 typedef struct ANTLR3_INT_TRIE_struct *pANTLR3_INT_TRIE;
\r
211 /// Pointer to an instantiation of 'class' #ANTLR3_REWRITE_RULE_ELEMENT_STREAM
\r
212 /// \ingroup ANTLR3_REWRITE_RULE_ELEMENT_STREAM
\r
214 typedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct *pANTLR3_REWRITE_RULE_ELEMENT_STREAM;
\r
215 /// Pointer to an instantiation of 'class' #ANTLR3_REWRITE_RULE_ELEMENT_STREAM
\r
216 /// \ingroup ANTLR3_REWRITE_RULE_ELEMENT_STREAM
\r
218 typedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct *pANTLR3_REWRITE_RULE_TOKEN_STREAM;
\r
220 /// Pointer to an instantiation of 'class' #ANTLR3_REWRITE_RULE_SUBSTREE_STREAM
\r
221 /// \ingroup ANTLR3_REWRITE_RULE_SUBTREE_STREAM
\r
223 typedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct *pANTLR3_REWRITE_RULE_SUBTREE_STREAM;
\r
225 /// Pointer to an instantiation of 'class' #ANTLR3_REWRITE_RULE_NODE_STREAM
\r
226 /// \ingroup ANTLR3_REWRITE_RULE_NODE_STREAM
\r
228 typedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct *pANTLR3_REWRITE_RULE_NODE_STREAM;
\r
230 /// Pointer to an instantiation of 'class' #ANTLR3_DEBUG_EVENT_LISTENER
\r
231 /// \ingroup ANTLR3_DEBUG_EVENT_LISTENER
\r
233 typedef struct ANTLR3_DEBUG_EVENT_LISTENER_struct *pANTLR3_DEBUG_EVENT_LISTENER;
\r