1// [The "BSD licence"]
2// Copyright (c) 2006-2007 Kay Roepke 2010 Alan Condit
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions
7// are met:
8// 1. Redistributions of source code must retain the above copyright
9//    notice, this list of conditions and the following disclaimer.
10// 2. Redistributions in binary form must reproduce the above copyright
11//    notice, this list of conditions and the following disclaimer in the
12//    documentation and/or other materials provided with the distribution.
13// 3. The name of the author may not be used to endorse or promote products
14//    derived from this software without specific prior written permission.
15//
16// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
27
28#import <Cocoa/Cocoa.h>
29#import <CoreFoundation/CoreFoundation.h>
30#import "ANTLRToken.h"
31
32#define BITS (sizeof(NSUInteger) * 8)
33#define LOG_BITS ((sizeof(NSUInteger)==8)?6:5)
34
35// A simple wrapper around CoreFoundation bit vectors to shield the rest of the implementation
36// from the specifics of the BitVector initialization and query functions.
37// This is fast, so there is no need to reinvent the wheel just yet.
38
39@interface ANTLRBitSet : NSObject < NSMutableCopying > {
40	CFMutableBitVectorRef bitVector;
41}
42
43#pragma mark Class Methods
44
45+ (ANTLRBitSet *) newANTLRBitSet;
46+ (ANTLRBitSet *) newANTLRBitSetWithType:(ANTLRTokenType)type;
47/** Construct a ANTLRBitSet given the size
48 * @param nbits The size of the ANTLRBitSet in bits
49 */
50+ (ANTLRBitSet *) newANTLRBitSetWithNBits:(NSUInteger)nbits;
51+ (ANTLRBitSet *) newANTLRBitSetWithArray:(NSMutableArray *)types;
52+ (ANTLRBitSet *) newANTLRBitSetWithBits:(const unsigned long long *)theBits Count:(NSUInteger)longCount;
53
54+ (ANTLRBitSet *) of:(NSUInteger)el;
55+ (ANTLRBitSet *) of:(NSUInteger)a And2:(NSUInteger)b;
56+ (ANTLRBitSet *) of:(NSUInteger)a And2:(NSUInteger)b And3:(NSUInteger)c;
57+ (ANTLRBitSet *) of:(NSUInteger)a And2:(NSUInteger)b And3:(NSUInteger)c And4:(NSUInteger)d;
58
59#pragma mark Initializer
60
61- (ANTLRBitSet *) init;
62- (ANTLRBitSet *) initWithType:(ANTLRTokenType)type;
63- (ANTLRBitSet *) initWithNBits:(NSUInteger)nbits;
64- (ANTLRBitSet *) initWithBitVector:(CFMutableBitVectorRef)theBitVector;
65- (ANTLRBitSet *) initWithBits:(const unsigned long long const*)theBits Count:(NSUInteger)theCount;
66- (ANTLRBitSet *) initWithArrayOfBits:(NSArray *)theArray;
67
68#pragma mark Operations
69- (ANTLRBitSet *) or:(ANTLRBitSet *) aBitSet;
70- (void) orInPlace:(ANTLRBitSet *) aBitSet;
71- (void) add:(NSUInteger) bit;
72- (void) remove:(NSUInteger) bit;
73- (void) setAllBits:(BOOL) aState;
74
75- (NSInteger) numBits;
76- (NSUInteger) size;
77- (void) setSize:(NSUInteger) noOfWords;
78
79#pragma mark Informational
80- (unsigned long long) bitMask:(NSUInteger) bitNumber;
81- (BOOL) member:(NSUInteger)bitNumber;
82- (BOOL) isNil;
83- (NSString *) toString;
84- (NSString *) description;
85
86#pragma mark NSCopying support
87
88- (id) mutableCopyWithZone:(NSZone *) theZone;
89
90
91//private
92- (CFMutableBitVectorRef) _bitVector;
93@end
94