1//
2//  ANTLRMap.h
3//  ANTLR
4//
5//  Created by Alan Condit on 6/9/10.
6// [The "BSD licence"]
7// Copyright (c) 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 "ANTLRPtrBuffer.h"
34#import "ANTLRMapElement.h"
35
36//#define GLOBAL_SCOPE      0
37//#define LOCAL_SCOPE       1
38#define HASHSIZE            101
39#define HBUFSIZE            0x2000
40
41@interface ANTLRMap : ANTLRPtrBuffer {
42	//ANTLRMap *fNext; // found in superclass
43    // TStringPool *fPool;
44    NSInteger lastHash;
45}
46
47//@property (copy) ANTLRMap *fNext;
48@property (getter=getLastHash, setter=setLastHash:) NSInteger lastHash;
49
50// Contruction/Destruction
51+ (id)newANTLRMap;
52+ (id)newANTLRMapWithLen:(NSInteger)aHashSize;
53
54- (id)init;
55- (id)initWithLen:(NSInteger)cnt;
56- (void)dealloc;
57// Instance Methods
58- (NSInteger)count;
59- (NSInteger)length;
60- (NSInteger)size;
61/* clear -- reinitialize the maplist array */
62- (void) clear;
63/* form hash value for string s */
64-(NSInteger)hash:(NSString *)s;
65/*   look for s in ptrBuffer  */
66-(id)lookup:(NSString *)s;
67/* look for s in ptrBuffer  */
68-(id)install:(ANTLRMapElement *)sym;
69/*
70 * delete entry from list
71 */
72- (void)deleteANTLRMap:(ANTLRMapElement *)np;
73- (NSInteger)RemoveSym:(NSString *)s;
74- (void)delete_chain:(ANTLRMapElement *)np;
75- (ANTLRMapElement *)getTType:(NSString *)name;
76- (ANTLRMapElement *)getName:(NSInteger)ttype;
77- (NSInteger)getNode:(ANTLRMapElement *)aNode;
78- (void)putNode:(NSInteger)aTType Node:(id)aNode;
79- (void)putName:(NSString *)name TType:(NSInteger)ttype;
80- (void)putName:(NSString *)name Node:(id)aNode;
81
82@end
83