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 "ANTLRTokenSource.h"
30 #import "ANTLRBitSet.h"
31 
32 @interface ANTLRBufferedTokenStream : NSObject <ANTLRTokenStream>
33 {
34 id<ANTLRTokenSource> tokenSource;
35 
36     /** Record every single token pulled from the source so we can reproduce
37      *  chunks of it later.  The buffer in LookaheadStream overlaps sometimes
38      *  as its moving window moves through the input.  This list captures
39      *  everything so we can access complete input text.
40      */
41 NSMutableArray *tokens;
42 
43     /** Track the last mark() call result value for use in rewind(). */
44 NSInteger lastMarker;
45 
46     /** The index into the tokens list of the current token (next token
47      *  to consume).  tokens[p] should be LT(1).  p=-1 indicates need
48      *  to initialize with first token.  The ctor doesn't get a token.
49      *  First call to LT(1) or whatever gets the first token and sets p=0;
50      */
51 NSInteger p;
52 
53 NSInteger range; // how deep have we gone?
54 
55 }
56 @property (retain, getter=getTokenSource,setter=setTokenSource) id<ANTLRTokenSource> tokenSource;
57 @property (retain, getter=getTokens,setter=setTokens) NSMutableArray *tokens;
58 @property (assign, getter=getLastMarker,setter=setLastMarker) NSInteger lastMarker;
59 @property (assign, getter=getIndex,setter=setIndex) NSInteger p;
60 @property (assign, getter=getRange,setter=setRange) NSInteger range;
61 
62 + (ANTLRBufferedTokenStream *) newANTLRBufferedTokenStream;
63 + (ANTLRBufferedTokenStream *) newANTLRBufferedTokenStreamWith:(id<ANTLRTokenSource>)aSource;
64 - (id) initWithSource:(id<ANTLRTokenSource>)aSource;
65 - (id) copyWithZone:(NSZone *)aZone;
66 - (NSInteger) getIndex;
67 - (void) setIndex:(NSInteger)index;
68 - (NSInteger) getRange;
69 - (void) setRange:(NSInteger)anInt;
70 - (NSInteger) mark;
71 - (void) release:(NSInteger) marker;
72 - (void) rewind:(NSInteger) marker;
73 - (void) rewind;
74 - (void) reset;
75 - (void) seek:(NSInteger) index;
76 - (NSInteger) size;
77 - (void) consume;
78 - (void) sync:(NSInteger) i;
79 - (void) fetch:(NSInteger) n;
80 - (id<ANTLRToken>) getToken:(NSInteger) i;
81 - (NSMutableArray *)getFrom:(NSInteger)startIndex To:(NSInteger) stopIndex;
82 - (NSInteger) LA:(NSInteger)k;
83 - (id<ANTLRToken>) LT:(NSInteger) k;
84 - (id<ANTLRToken>) LB:(NSInteger) k;
85 - (void) setup;
86 - (id<ANTLRTokenSource>) getTokenSource;
87 - (void) setTokenSource:(id<ANTLRTokenSource>) aTokenSource;
88 - (NSMutableArray *)getTokens;
89 - (NSString *) getSourceName;
90 - (NSMutableArray *)getTokensFrom:(NSInteger)startIndex To:(NSInteger)stopIndex;
91 - (NSMutableArray *)getTokensFrom:(NSInteger)startIndex To:(NSInteger)stopIndex With:(ANTLRBitSet *)types;
92 - (NSMutableArray *)getTokensFrom:(NSInteger)startIndex To:(NSInteger)stopIndex WithList:(NSMutableArray *)types;
93 - (NSMutableArray *)getTokensFrom:(NSInteger)startIndex To:(NSInteger)stopIndex WithType:(NSInteger)ttype;
94 - (NSString *) toStringFromStart:(NSInteger)startIndex ToEnd:(NSInteger)stopIndex;
95 - (NSString *) toStringFromToken:(id<ANTLRToken>)startIndex ToToken:(id<ANTLRToken>)stopIndex;
96 - (void) fill;
97 
98 @end
99