1//
2//  ANTLRLookaheadStream.h
3//  ANTLR
4//
5//  Created by Ian Michell on 26/04/2010.
6//  [The "BSD licence"]
7//  Copyright (c) 2010 Ian Michell 2010 Alan Condit
8//  All rights reserved.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions
12// are met:
13// 1. Redistributions of source code must retain the above copyright
14//    notice, this list of conditions and the following disclaimer.
15// 2. Redistributions in binary form must reproduce the above copyright
16//    notice, this list of conditions and the following disclaimer in the
17//    documentation and/or other materials provided with the distribution.
18// 3. The name of the author may not be used to endorse or promote products
19//    derived from this software without specific prior written permission.
20//
21// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
32#import <Cocoa/Cocoa.h>
33#import "ANTLRFastQueue.h"
34
35#define UNITIALIZED_EOF_ELEMENT_INDEX NSIntegerMax
36
37@interface ANTLRLookaheadStream : ANTLRFastQueue
38{
39	id eof;
40	NSInteger eofElementIndex;
41	NSInteger lastMarker;
42	NSInteger markDepth;
43}
44
45@property (readwrite, retain, getter=getEof, setter=setEof) id eof;
46@property (assign, getter=getEofElementIndex, setter=setEofElementIndex) NSInteger eofElementIndex;
47@property (assign, getter=getLastMarker, setter=setLastMarker) NSInteger lastMarker;
48@property (assign, getter=getMarkDepth, setter=setMarkDepth) NSInteger markDepth;
49
50- (id) initWithEOF:(id) o;
51- (id) nextElement;
52- (void) consume;
53- (void) sync:(NSInteger) need;
54- (void) fill:(NSInteger) n;
55- (id) LT:(NSInteger) i;
56- (id) LB:(NSInteger) i;
57- (id) currentSymbol;
58- (NSInteger) getIndex;
59- (NSInteger) mark;
60- (void) release:(NSInteger) marker;
61- (void) rewind:(NSInteger) marker;
62- (void) rewind;
63- (void) seek:(NSInteger) i;
64- (id) getEof;
65- (void) setEof:(id) anID;
66- (NSInteger) getEofElementIndex;
67- (void) setEofElementIndex:(NSInteger) anInt;
68- (NSInteger) getLastMarker;
69- (void) setLastMarker:(NSInteger) anInt;
70- (NSInteger) getMarkDepth;
71- (void) setMarkDepth:(NSInteger) anInt;
72
73@end
74