1 // [The "BSD licence"]
2 // Copyright (c) 2006-2007 Kay Roepke 2010 Alan Condit
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions
7 // are met:
8 // 1. Redistributions of source code must retain the above copyright
9 //    notice, this list of conditions and the following disclaimer.
10 // 2. Redistributions in binary form must reproduce the above copyright
11 //    notice, this list of conditions and the following disclaimer in the
12 //    documentation and/or other materials provided with the distribution.
13 // 3. The name of the author may not be used to endorse or promote products
14 //    derived from this software without specific prior written permission.
15 //
16 // THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 // IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 // NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 // THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 
27 #import <Cocoa/Cocoa.h>
28 #import "ANTLRRewriteRuleElementStream.h"
29 
30 
31 @interface ANTLRRewriteRuleTokenStream : ANTLRRewriteRuleElementStream {
32 
33 }
34 
35 + (id) newANTLRRewriteRuleTokenStream:(id<ANTLRTreeAdaptor>)anAdaptor
36                           description:(NSString *)elementDescription;
37 /** Create a stream with one element */
38 + (id) newANTLRRewriteRuleTokenStream:(id<ANTLRTreeAdaptor>)adaptor
39                           description:(NSString *)elementDescription
40                               element:(id) oneElement;
41 /** Create a stream, but feed off an existing list */
42 + (id) newANTLRRewriteRuleTokenStream:(id<ANTLRTreeAdaptor>)adaptor
43                           description:(NSString *)elementDescription
44                              elements:(NSMutableArray *)elements;
45 
46 - (id) init;
47 - (id) initWithTreeAdaptor:(id<ANTLRTreeAdaptor>)anAdaptor
48                description:(NSString *)aDescription;
49 - (id) initWithTreeAdaptor:(id<ANTLRTreeAdaptor>)anAdaptor
50                description:(NSString *)aDescription
51                    element:(id)element;
52 - (id) initWithTreeAdaptor:(id<ANTLRTreeAdaptor>)anAdaptor
53                description:(NSString *)aDescription
54                   elements:(NSMutableArray *)elements;
55 
56 /** Get next token from stream and make a node for it */
57 - (id) nextNode;
58 
59 - (id) nextToken;
60 
61 /** Don't convert to a tree unless they explicitly call nextTree.
62  *  This way we can do hetero tree nodes in rewrite.
63  */
64 - (id<ANTLRTree>) toTree:(id<ANTLRToken>)element;
65 
66 @end