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 "ANTLRTokenStream.h"
29#import "ANTLRToken.h"
30#import "ANTLRCommonToken.h"
31#import "ANTLRTokenSource.h"
32#import "ANTLRBitSet.h"
33#import "ANTLRBufferedTokenStream.h"
34
35@interface ANTLRCommonTokenStream : ANTLRBufferedTokenStream < ANTLRTokenStream >
36{
37	NSMutableDictionary *channelOverride;
38	NSInteger channel;
39}
40
41@property (retain, getter=getChannelOverride,setter=setChannelOverride) NSMutableDictionary *channelOverride;
42@property (assign, getter=getChannel,setter=setChannel) NSInteger channel;
43
44+ (ANTLRCommonTokenStream *)newANTLRCommonTokenStream;
45+ (ANTLRCommonTokenStream *)newANTLRCommonTokenStreamWithTokenSource:(id<ANTLRTokenSource>)theTokenSource;
46+ (ANTLRCommonTokenStream *)newANTLRCommonTokenStreamWithTokenSource:(id<ANTLRTokenSource>)theTokenSource
47                                                               Channel:(NSInteger)aChannel;
48
49- (id) init;
50- (id) initWithTokenSource:(id<ANTLRTokenSource>)theTokenSource;
51- (id) initWithTokenSource:(id<ANTLRTokenSource>)theTokenSource Channel:(NSInteger)aChannel;
52
53- (id<ANTLRTokenSource>) getTokenSource;
54- (void) setTokenSource: (id<ANTLRTokenSource>) aTokenSource;
55
56- (void) consume;
57- (id<ANTLRToken>) LT:(NSInteger)k;
58- (id<ANTLRToken>) LB:(NSInteger)k;
59
60- (NSInteger) skipOffChannelTokens:(NSInteger) i;
61- (NSInteger) skipOffChannelTokensReverse:(NSInteger) i;
62
63- (void)setup;
64
65- (NSArray *) tokensInRange:(NSRange)aRange;
66- (NSArray *) tokensInRange:(NSRange)aRange inBitSet:(ANTLRBitSet *)aBitSet;
67- (NSArray *) tokensInRange:(NSRange)aRange withTypes:(NSArray *)tokenTypes;
68- (NSArray *) tokensInRange:(NSRange)aRange withType:(NSInteger)tokenType;
69
70- (id<ANTLRToken>) getToken:(NSInteger)i;
71
72- (NSInteger) size;
73- (NSInteger) getIndex;
74- (void) rewind;
75- (void) rewind:(NSInteger)marker;
76- (void) seek:(NSInteger)index;
77
78- (NSString *) toString;
79- (NSString *) toStringFromStart:(NSInteger)startIndex ToEnd:(NSInteger)stopIndex;
80- (NSString *) toStringFromToken:(id<ANTLRToken>)startToken ToToken:(id<ANTLRToken>)stopToken;
81
82- (id) copyWithZone:(NSZone *)aZone;
83
84- (NSInteger)getChannel;
85- (void)setChannel:(NSInteger)aChannel;
86
87- (NSMutableDictionary *)getChannelOverride;
88- (void)setChannelOverride:(NSMutableDictionary *)anOverride;
89
90@end
91