//
//  ANTLRMap.h
//  ANTLR
//
//  Created by Alan Condit on 6/9/10.
// [The "BSD licence"]
// Copyright (c) 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 <Cocoa/Cocoa.h>
#import "ANTLRPtrBuffer.h"
#import "ANTLRMapElement.h"

//#define GLOBAL_SCOPE      0
//#define LOCAL_SCOPE       1
#define HASHSIZE            101
#define HBUFSIZE            0x2000

@interface ANTLRMap : ANTLRPtrBuffer {
	//ANTLRMap *fNext; // found in superclass
    // TStringPool *fPool;
    NSInteger lastHash;
}

//@property (copy) ANTLRMap *fNext;
@property (getter=getLastHash, setter=setLastHash:) NSInteger lastHash;

// Contruction/Destruction
+ (id)newANTLRMap;
+ (id)newANTLRMapWithLen:(NSInteger)aHashSize;

- (id)init;
- (id)initWithLen:(NSInteger)cnt;
- (void)dealloc;
// Instance Methods
- (NSInteger)count;
- (NSInteger)length;
- (NSInteger)size;
/* clear -- reinitialize the maplist array */
- (void) clear;
/* form hash value for string s */
-(NSInteger)hash:(NSString *)s;
/*   look for s in ptrBuffer  */
-(id)lookup:(NSString *)s;
/* look for s in ptrBuffer  */
-(id)install:(ANTLRMapElement *)sym;
/*
 * delete entry from list
 */
- (void)deleteANTLRMap:(ANTLRMapElement *)np;
- (NSInteger)RemoveSym:(NSString *)s;
- (void)delete_chain:(ANTLRMapElement *)np;
- (ANTLRMapElement *)getTType:(NSString *)name;
- (ANTLRMapElement *)getName:(NSInteger)ttype;
- (NSInteger)getNode:(ANTLRMapElement *)aNode;
- (void)putNode:(NSInteger)aTType Node:(id)aNode;
- (void)putName:(NSString *)name TType:(NSInteger)ttype;
- (void)putName:(NSString *)name Node:(id)aNode;

@end