// [The "BSD licence"]
// Copyright (c) 2006-2007 Kay Roepke
// 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 <Cocoa/Cocoa.h>
#import "ANTLRParser.h"
#import "ANTLRTokenStream.h"
#import "ANTLRTokenSource.h"
#import "ANTLRDebugTokenStream.h"
#import "ANTLRDebugEventListener.h"

@interface ANTLRDebugTokenStream : NSObject <ANTLRTokenStream>
{
	id<ANTLRDebugEventListener> debugListener;
	id<ANTLRTokenStream> input;
	BOOL initialStreamState;
    NSInteger lastMarker;
}

- (id) initWithTokenStream:(id<ANTLRTokenStream>)theStream debugListener:(id<ANTLRDebugEventListener>)debugger;

- (id<ANTLRDebugEventListener>) debugListener;
- (void) setDebugListener: (id<ANTLRDebugEventListener>) aDebugListener;

- (id<ANTLRTokenStream>) input;
- (void) setInput:(id<ANTLRTokenStream>)aTokenStream;

- (void) consume;
- (id<ANTLRToken>) getToken:(NSInteger)index;
- (NSInteger) getIndex;
- (void) release:(NSInteger)marker;
- (void) seek:(NSInteger)index;
- (NSInteger) size;
- (id<ANTLRTokenSource>) getTokenSource;
- (NSString *) getSourceName;
- (NSString *) toString;
- (NSString *) toStringFromStart:(NSInteger)aStart ToEnd:(NSInteger)aStop;
- (NSString *) toStringFromToken:(id<ANTLRToken>)startToken ToToken:(id<ANTLRToken>)stopToken;

@end