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 <Foundation/Foundation.h>
28 #import "TokenStream.h"
29 #import "Token.h"
30 #import "CommonToken.h"
31 #import "TokenSource.h"
32 #import "ANTLRBitSet.h"
33 #import "BufferedTokenStream.h"
34 #import "AMutableDictionary.h"
35 
36 @interface CommonTokenStream : BufferedTokenStream < TokenStream >
37 {
38 	__strong AMutableDictionary *channelOverride;
39 	NSUInteger channel;
40 }
41 
42 @property (retain, getter=getChannelOverride,setter=setChannelOverride:) AMutableDictionary *channelOverride;
43 @property (assign, getter=channel,setter=setChannel:) NSUInteger channel;
44 
45 + (CommonTokenStream *)newCommonTokenStream;
46 + (CommonTokenStream *)newCommonTokenStreamWithTokenSource:(id<TokenSource>)theTokenSource;
47 + (CommonTokenStream *)newCommonTokenStreamWithTokenSource:(id<TokenSource>)theTokenSource
48                                                                Channel:(NSUInteger)aChannel;
49 
50 - (id) init;
51 - (id) initWithTokenSource:(id<TokenSource>)theTokenSource;
52 - (id) initWithTokenSource:(id<TokenSource>)theTokenSource Channel:(NSUInteger)aChannel;
53 
54 - (void) consume;
55 - (id<Token>) LB:(NSInteger)k;
56 - (id<Token>) LT:(NSInteger)k;
57 
58 - (NSInteger) skipOffTokenChannels:(NSInteger) i;
59 - (NSInteger) skipOffTokenChannelsReverse:(NSInteger) i;
60 
61 - (void)setup;
62 - (void)reset;
63 
64 - (NSInteger) getNumberOfOnChannelTokens;
65 
66 // - (id<TokenSource>) getTokenSource;
67 - (void) setTokenSource: (id<TokenSource>) aTokenSource;
68 
69 - (NSUInteger)channel;
70 - (void)setChannel:(NSUInteger)aChannel;
71 
72 - (AMutableDictionary *)channelOverride;
73 - (void)setChannelOverride:(AMutableDictionary *)anOverride;
74 
75 - (id) copyWithZone:(NSZone *)aZone;
76 
77 #ifdef DONTUSENOMO
78 - (NSArray *) tokensInRange:(NSRange)aRange;
79 - (NSArray *) tokensInRange:(NSRange)aRange inBitSet:(ANTLRBitSet *)aBitSet;
80 - (NSArray *) tokensInRange:(NSRange)aRange withTypes:(NSArray *)tokenTypes;
81 - (NSArray *) tokensInRange:(NSRange)aRange withType:(NSInteger)tokenType;
82 
83 - (id<Token>) getToken:(NSInteger)i;
84 
85 - (NSInteger) size;
86 - (void) rewind;
87 - (void) rewind:(NSInteger)marker;
88 - (void) seek:(NSInteger)index;
89 
90 - (NSString *) toString;
91 - (NSString *) toStringFromStart:(NSInteger)startIndex ToEnd:(NSInteger)stopIndex;
92 - (NSString *) toStringFromToken:(id<Token>)startToken ToToken:(id<Token>)stopToken;
93 
94 #endif
95 
96 @end
97