// [The "BSD licence"]
// Copyright (c) 2007 Kay Roepke 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 "Token.h"
#import "ANTLRBitSet.h"
#import "RuleStack.h"
#import "AMutableArray.h"

@interface RecognizerSharedState : NSObject {
	__strong AMutableArray *following;  // a stack of FOLLOW bitsets used for context sensitive prediction and recovery
    NSInteger _fsp;                     // Follow stack pointer
	BOOL errorRecovery;                 // are we recovering?
	NSInteger lastErrorIndex;
	BOOL failed;                        // indicate that some match failed
    NSInteger syntaxErrors;
	NSInteger backtracking;             // the level of backtracking
	__strong RuleStack *ruleMemo;	// store previous results of matching rules so we don't have to do it again. Hook in incremental stuff here, too.

	__strong id<Token> token;
	NSInteger  tokenStartCharIndex;
	NSUInteger tokenStartLine;
	NSUInteger tokenStartCharPositionInLine;
	NSUInteger channel;
	NSUInteger type;
	NSString   *text;
}

@property (retain, getter=getFollowing, setter=setFollowing:) AMutableArray *following;
@property (assign) NSInteger _fsp;
@property (assign) BOOL errorRecovery;
@property (assign) NSInteger lastErrorIndex;
@property (assign, getter=getFailed, setter=setFailed:) BOOL failed;
@property (assign) NSInteger syntaxErrors;
@property (assign, getter=getBacktracking, setter=setBacktracking:) NSInteger backtracking;
@property (retain, getter=getRuleMemo, setter=setRuleMemo:) RuleStack *ruleMemo;
@property (copy, getter=getToken, setter=setToken:) id<Token> token;
@property (getter=type,setter=setType:) NSUInteger type;
@property (getter=channel,setter=setChannel:) NSUInteger channel;
@property (getter=getTokenStartLine,setter=setTokenStartLine:) NSUInteger tokenStartLine;
@property (getter=charPositionInLine,setter=setCharPositionInLine:) NSUInteger tokenStartCharPositionInLine;
@property (getter=getTokenStartCharIndex,setter=setTokenStartCharIndex:) NSInteger tokenStartCharIndex;
@property (retain, getter=text, setter=setText:) NSString *text;

+ (RecognizerSharedState *) newRecognizerSharedState;
+ (RecognizerSharedState *) newRecognizerSharedStateWithRuleLen:(NSInteger)aLen;
+ (RecognizerSharedState *) newRecognizerSharedState:(RecognizerSharedState *)aState;

- (id) init;
- (id) initWithRuleLen:(NSInteger)aLen;
- (id) initWithState:(RecognizerSharedState *)state;

- (id<Token>) getToken;
- (void) setToken:(id<Token>) theToken;

- (NSUInteger)type;
- (void) setType:(NSUInteger) theTokenType;

- (NSUInteger)channel;
- (void) setChannel:(NSUInteger) theChannel;

- (NSUInteger) getTokenStartLine;
- (void) setTokenStartLine:(NSUInteger) theTokenStartLine;

- (NSUInteger) charPositionInLine;
- (void) setCharPositionInLine:(NSUInteger) theCharPosition;

- (NSInteger) getTokenStartCharIndex;
- (void) setTokenStartCharIndex:(NSInteger) theTokenStartCharIndex;

- (NSString *)text;
- (void) setText:(NSString *) theText;


- (AMutableArray *) getFollowing;
- (void)setFollowing:(AMutableArray *)aFollow;
- (RuleStack *) getRuleMemo;
- (void)setRuleMemo:(RuleStack *)aRuleMemo;
- (BOOL) isErrorRecovery;
- (void) setIsErrorRecovery: (BOOL) flag;

- (BOOL) getFailed;
- (void) setFailed: (BOOL) flag;

- (NSInteger)  getBacktracking;
- (void) setBacktracking:(NSInteger) value;
- (void) increaseBacktracking;
- (void) decreaseBacktracking;
- (BOOL) isBacktracking;

- (NSInteger) lastErrorIndex;
- (void) setLastErrorIndex:(NSInteger) value;

@end