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