1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// [The "BSD licence"] 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Copyright (c) 2006-2007 Kay Roepke 2010 Alan Condit 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// All rights reserved. 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Redistribution and use in source and binary forms, with or without 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// modification, are permitted provided that the following conditions 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// are met: 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 1. Redistributions of source code must retain the above copyright 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// notice, this list of conditions and the following disclaimer. 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 2. Redistributions in binary form must reproduce the above copyright 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// notice, this list of conditions and the following disclaimer in the 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// documentation and/or other materials provided with the distribution. 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 3. The name of the author may not be used to endorse or promote products 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// derived from this software without specific prior written permission. 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import <Cocoa/Cocoa.h> 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import <CoreFoundation/CoreFoundation.h> 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRToken.h" 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define BITS (sizeof(NSUInteger) * 8) 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define LOG_BITS ((sizeof(NSUInteger)==8)?6:5) 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// A simple wrapper around CoreFoundation bit vectors to shield the rest of the implementation 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// from the specifics of the BitVector initialization and query functions. 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// This is fast, so there is no need to reinvent the wheel just yet. 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRBitSet : NSObject < NSMutableCopying > { 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver CFMutableBitVectorRef bitVector; 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#pragma mark Class Methods 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBitSet *) newANTLRBitSet; 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBitSet *) newANTLRBitSetWithType:(ANTLRTokenType)type; 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Construct a ANTLRBitSet given the size 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * @param nbits The size of the ANTLRBitSet in bits 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBitSet *) newANTLRBitSetWithNBits:(NSUInteger)nbits; 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBitSet *) newANTLRBitSetWithArray:(NSMutableArray *)types; 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBitSet *) newANTLRBitSetWithBits:(const unsigned long long *)theBits Count:(NSUInteger)longCount; 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBitSet *) of:(NSUInteger)el; 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBitSet *) of:(NSUInteger)a And2:(NSUInteger)b; 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBitSet *) of:(NSUInteger)a And2:(NSUInteger)b And3:(NSUInteger)c; 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBitSet *) of:(NSUInteger)a And2:(NSUInteger)b And3:(NSUInteger)c And4:(NSUInteger)d; 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#pragma mark Initializer 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRBitSet *) init; 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRBitSet *) initWithType:(ANTLRTokenType)type; 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRBitSet *) initWithNBits:(NSUInteger)nbits; 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRBitSet *) initWithBitVector:(CFMutableBitVectorRef)theBitVector; 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRBitSet *) initWithBits:(const unsigned long long const*)theBits Count:(NSUInteger)theCount; 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRBitSet *) initWithArrayOfBits:(NSArray *)theArray; 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#pragma mark Operations 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRBitSet *) or:(ANTLRBitSet *) aBitSet; 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) orInPlace:(ANTLRBitSet *) aBitSet; 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) add:(NSUInteger) bit; 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) remove:(NSUInteger) bit; 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setAllBits:(BOOL) aState; 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) numBits; 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSUInteger) size; 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setSize:(NSUInteger) noOfWords; 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#pragma mark Informational 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (unsigned long long) bitMask:(NSUInteger) bitNumber; 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) member:(NSUInteger)bitNumber; 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) isNil; 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toString; 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) description; 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#pragma mark NSCopying support 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) mutableCopyWithZone:(NSZone *) theZone; 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//private 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (CFMutableBitVectorRef) _bitVector; 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 94