2 * Definition of the ANTLR3 base tree adaptor.
\r
5 #ifndef _ANTLR3_BASE_TREE_ADAPTOR_H
\r
6 #define _ANTLR3_BASE_TREE_ADAPTOR_H
\r
8 // [The "BSD licence"]
\r
9 // Copyright (c) 2005-2009 Jim Idle, Temporal Wave LLC
\r
10 // http://www.temporal-wave.com
\r
11 // http://www.linkedin.com/in/jimidle
\r
13 // All rights reserved.
\r
15 // Redistribution and use in source and binary forms, with or without
\r
16 // modification, are permitted provided that the following conditions
\r
18 // 1. Redistributions of source code must retain the above copyright
\r
19 // notice, this list of conditions and the following disclaimer.
\r
20 // 2. Redistributions in binary form must reproduce the above copyright
\r
21 // notice, this list of conditions and the following disclaimer in the
\r
22 // documentation and/or other materials provided with the distribution.
\r
23 // 3. The name of the author may not be used to endorse or promote products
\r
24 // derived from this software without specific prior written permission.
\r
26 // THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
\r
27 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
\r
28 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
\r
29 // IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
\r
30 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
\r
31 // NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
\r
32 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
\r
33 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
\r
34 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
\r
35 // THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\r
37 #include <antlr3defs.h>
\r
38 #include <antlr3collections.h>
\r
39 #include <antlr3string.h>
\r
40 #include <antlr3basetree.h>
\r
41 #include <antlr3commontoken.h>
\r
42 #include <antlr3debugeventlistener.h>
\r
48 typedef struct ANTLR3_BASE_TREE_ADAPTOR_struct
\r
50 /** Pointer to any enclosing structure/interface that
\r
51 * contains this structure.
\r
55 /** We need a string factory for creating imaginary tokens, we take this
\r
56 * from the stream we are supplied to walk.
\r
58 pANTLR3_STRING_FACTORY strFactory;
\r
60 /* And we also need a token factory for creating imaginary tokens
\r
61 * this is also taken from the input source.
\r
63 pANTLR3_TOKEN_FACTORY tokenFactory;
\r
65 /// If set to something other than NULL, then this structure is
\r
66 /// points to an instance of the debugger interface. In general, the
\r
67 /// debugger is only referenced internally in recovery/error operations
\r
68 /// so that it does not cause overhead by having to check this pointer
\r
69 /// in every function/method
\r
71 pANTLR3_DEBUG_EVENT_LISTENER debugger;
\r
73 void * (*nilNode) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor);
\r
76 void * (*dupTree) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * tree);
\r
77 void * (*dupTreeTT) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t, void * tree);
\r
79 void (*addChild) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t, void * child);
\r
80 void (*addChildToken) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t, pANTLR3_COMMON_TOKEN child);
\r
81 void (*setParent) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * child, void * parent);
\r
82 void * (*getParent) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * child);
\r
84 void * (*errorNode) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, pANTLR3_TOKEN_STREAM tnstream, pANTLR3_COMMON_TOKEN startToken, pANTLR3_COMMON_TOKEN stopToken, pANTLR3_EXCEPTION e);
\r
85 ANTLR3_BOOLEAN (*isNilNode) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t);
\r
87 void * (*becomeRoot) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * newRoot, void * oldRoot);
\r
89 void * (*rulePostProcessing) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * root);
\r
91 void * (*becomeRootToken) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * newRoot, void * oldRoot);
\r
93 void * (*create) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, pANTLR3_COMMON_TOKEN payload);
\r
94 void * (*createTypeToken) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, ANTLR3_UINT32 tokenType, pANTLR3_COMMON_TOKEN fromToken);
\r
95 void * (*createTypeTokenText) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, ANTLR3_UINT32 tokenType, pANTLR3_COMMON_TOKEN fromToken, pANTLR3_UINT8 text);
\r
96 void * (*createTypeText) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, ANTLR3_UINT32 tokenType, pANTLR3_UINT8 text);
\r
98 void * (*dupNode) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * treeNode);
\r
100 ANTLR3_UINT32 (*getType) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t);
\r
102 void (*setType) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t, ANTLR3_UINT32 type);
\r
104 pANTLR3_STRING (*getText) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t);
\r
106 void (*setText) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, pANTLR3_STRING t);
\r
107 void (*setText8) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, pANTLR3_UINT8 t);
\r
109 void * (*getChild) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t, ANTLR3_UINT32 i);
\r
110 void (*setChild) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t, ANTLR3_UINT32 i, void * child);
\r
111 void (*deleteChild) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t, ANTLR3_UINT32 i);
\r
112 void (*setChildIndex) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t, ANTLR3_UINT32 i);
\r
113 ANTLR3_INT32 (*getChildIndex) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t);
\r
115 ANTLR3_UINT32 (*getChildCount) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void *);
\r
117 ANTLR3_UINT32 (*getUniqueID) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void *);
\r
119 pANTLR3_COMMON_TOKEN (*createToken) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, ANTLR3_UINT32 tokenType, pANTLR3_UINT8 text);
\r
120 pANTLR3_COMMON_TOKEN (*createTokenFromToken) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, pANTLR3_COMMON_TOKEN fromToken);
\r
121 pANTLR3_COMMON_TOKEN (*getToken) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t);
\r
123 void (*setTokenBoundaries) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t, pANTLR3_COMMON_TOKEN startToken, pANTLR3_COMMON_TOKEN stopToken);
\r
125 ANTLR3_MARKER (*getTokenStartIndex) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t);
\r
127 ANTLR3_MARKER (*getTokenStopIndex) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * t);
\r
129 void (*setDebugEventListener)(struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, pANTLR3_DEBUG_EVENT_LISTENER debugger);
\r
131 /// Produce a DOT (see graphviz freeware suite) from a base tree
\r
133 pANTLR3_STRING (*makeDot) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * theTree);
\r
135 /// Replace from start to stop child index of parent with t, which might
\r
136 /// be a list. Number of children may be different
\r
137 /// after this call.
\r
139 /// If parent is null, don't do anything; must be at root of overall tree.
\r
140 /// Can't replace whatever points to the parent externally. Do nothing.
\r
142 void (*replaceChildren) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor, void * parent, ANTLR3_INT32 startChildIndex, ANTLR3_INT32 stopChildIndex, void * t);
\r
144 void (*free) (struct ANTLR3_BASE_TREE_ADAPTOR_struct * adaptor);
\r
147 ANTLR3_TREE_ADAPTOR, *pANTLR3_TREE_ADAPTOR;
\r