1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#ifndef ANTLR3REWRITESTREAM_H 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define ANTLR3REWRITESTREAM_H 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// [The "BSD licence"] 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Copyright (c) 2005-2009 Jim Idle, Temporal Wave LLC 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// http://www.temporal-wave.com 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// http://www.linkedin.com/in/jimidle 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// All rights reserved. 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Redistribution and use in source and binary forms, with or without 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// modification, are permitted provided that the following conditions 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// are met: 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 1. Redistributions of source code must retain the above copyright 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// notice, this list of conditions and the following disclaimer. 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 2. Redistributions in binary form must reproduce the above copyright 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// notice, this list of conditions and the following disclaimer in the 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// documentation and/or other materials provided with the distribution. 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 3. The name of the author may not be used to endorse or promote products 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// derived from this software without specific prior written permission. 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include <antlr3defs.h> 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include <antlr3collections.h> 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include <antlr3commontreeadaptor.h> 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include <antlr3baserecognizer.h> 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#ifdef __cplusplus 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverextern "C" { 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#endif 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// A generic list of elements tracked in an alternative to be used in 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// a -> rewrite rule. 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// In the C implementation, all tree oriented streams return a pointer to 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// the same type: pANTLR3_BASE_TREE. Anything that has subclassed from this 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// still passes this type, within which there is a super pointer, which points 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// to it's own data and methods. Hence we do not need to implement this as 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// the equivalent of an abstract class, but just fill in the appropriate interface 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// as usual with this model. 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// Once you start next()ing, do not try to add more elements. It will 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// break the cursor tracking I believe. 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// \see #pANTLR3_REWRITE_RULE_NODE_STREAM 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// \see #pANTLR3_REWRITE_RULE_ELEMENT_STREAM 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// \see #pANTLR3_REWRITE_RULE_SUBTREE_STREAM 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// TODO: add mechanism to detect/puke on modification after reading from stream 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvertypedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Cursor 0..n-1. If singleElement!=NULL, cursor is 0 until you next(), 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// which bumps it to 1 meaning no more elements. 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLR3_UINT32 cursor; 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Track single elements w/o creating a list. Upon 2nd add, alloc list 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void * singleElement; 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// The list of tokens or subtrees we are tracking 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver pANTLR3_VECTOR elements; 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Indicates whether we should free the vector or it was supplied to us 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLR3_BOOLEAN freeElements; 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// The element or stream description; usually has name of the token or 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// rule reference that this list tracks. Can include rulename too, but 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// the exception would track that info. 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void * elementDescription; 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Pointer to the tree adaptor in use for this stream 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver pANTLR3_BASE_TREE_ADAPTOR adaptor; 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Once a node / subtree has been used in a stream, it must be dup'ed 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// from then on. Streams are reset after sub rules so that the streams 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// can be reused in future sub rules. So, reset must set a dirty bit. 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// If dirty, then next() always returns a dup. 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLR3_BOOLEAN dirty; 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // Pointer to the recognizer shared state to which this stream belongs 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver pANTLR3_BASE_RECOGNIZER rec; 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // Methods 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Reset the condition of this stream so that it appears we have 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// not consumed any of its elements. Elements themselves are untouched. 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void (*reset) (struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct * stream); 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Add a new pANTLR3_BASE_TREE to this stream 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void (*add) (struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct * stream, void *el, void (ANTLR3_CDECL *freePtr)(void *)); 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Return the next element in the stream. If out of elements, throw 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// an exception unless size()==1. If size is 1, then return elements[0]. 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void * (*next) (struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct * stream); 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver pANTLR3_BASE_TREE (*nextTree) (struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct * stream); 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void * (*nextToken) (struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct * stream); 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void * (*_next) (struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct * stream); 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// When constructing trees, sometimes we need to dup a token or AST 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// subtree. Dup'ing a token means just creating another AST node 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// around it. For trees, you must call the adaptor.dupTree(). 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void * (*dup) (struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct * stream, void * el); 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Ensure stream emits trees; tokens must be converted to AST nodes. 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// AST nodes can be passed through unmolested. 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver pANTLR3_BASE_TREE (*toTree) (struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct * stream, void * el); 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Returns ANTLR3_TRUE if there is a next element available 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLR3_BOOLEAN (*hasNext) (struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct * stream); 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Treat next element as a single node even if it's a subtree. 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// This is used instead of next() when the result has to be a 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// tree root node. Also prevents us from duplicating recently-added 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// children; e.g., ^(type ID)+ adds ID to type and then 2nd iteration 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// must dup the type node, but ID has been added. 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Referencing to a rule result twice is ok; dup entire tree as 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// we can't be adding trees; e.g., expr expr. 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver pANTLR3_BASE_TREE (*nextNode) (struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct * stream); 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Number of elements available in the stream 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLR3_UINT32 (*size) (struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct * stream); 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Returns the description string if there is one available (check for NULL). 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void * (*getDescription) (struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct * stream); 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void (*free) (struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct * stream); 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLR3_REWRITE_RULE_ELEMENT_STREAM; 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// This is an implementation of a token stream, which is basically an element 162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// stream that deals with tokens only. 163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// 164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvertypedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct ANTLR3_REWRITE_RULE_TOKEN_STREAM; 165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// This is an implementation of a subtree stream which is a set of trees 167324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// modelled as an element stream. 168324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// 169324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvertypedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct ANTLR3_REWRITE_RULE_SUBTREE_STREAM; 170324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 171324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// This is an implementation of a node stream, which is basically an element 172324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// stream that deals with tree nodes only. 173324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/// 174324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvertypedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct ANTLR3_REWRITE_RULE_NODE_STREAM; 175324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 176324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#ifdef __cplusplus 177324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 178324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#endif 179324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 180324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#endif 181