//
//  LookaheadStream.h
//  ANTLR
//
//  Created by Ian Michell on 26/04/2010.
//  [The "BSD licence"]
//  Copyright (c) 2010 Ian Michell 2010 Alan Condit
//  All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. The name of the author may not be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#import <Foundation/Foundation.h>
#import "FastQueue.h"

#define UNITIALIZED_EOF_ELEMENT_INDEX NSIntegerMax

@interface LookaheadStream : FastQueue
{
    NSInteger index;
	NSInteger eofElementIndex;
	NSInteger lastMarker;
	NSInteger markDepth;
	id prevElement;
	id eof;
}

@property (readwrite, retain, getter=getEof, setter=setEof:) id eof;
@property (assign) NSInteger index;
@property (assign, getter=getEofElementIndex, setter=setEofElementIndex:) NSInteger eofElementIndex;
@property (assign, getter=getLastMarker, setter=setLastMarker:) NSInteger lastMarker;
@property (assign, getter=getMarkDepth, setter=setMarkDepth:) NSInteger markDepth;
@property (retain) id prevElement;

- (id) initWithEOF:(id) obj;
- (id) nextElement;
- (id) remove;
- (void) consume;
- (void) sync:(NSInteger) need;
- (void) fill:(NSInteger) n;
- (id) LT:(NSInteger) i;
- (id) LB:(NSInteger) i;
- (id) getCurrentSymbol;
- (NSInteger) mark;
- (void) release:(NSInteger) marker;
- (void) rewind:(NSInteger) marker;
- (void) rewind;
- (void) seek:(NSInteger) i;
- (id) getEof;
- (void) setEof:(id) anID;
- (NSInteger) getEofElementIndex;
- (void) setEofElementIndex:(NSInteger) anInt;
- (NSInteger) getLastMarker;
- (void) setLastMarker:(NSInteger) anInt;
- (NSInteger) getMarkDepth;
- (void) setMarkDepth:(NSInteger) anInt;

@end