Home | History | Annotate | Download | only in Framework
      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 #import "AMutableArray.h"
     32 
     33 #define BITS (sizeof(NSUInteger) * 8)
     34 #define LOG_BITS ((sizeof(NSUInteger)==8)?6:5)
     35 
     36 // A simple wrapper around CoreFoundation bit vectors to shield the rest of the implementation
     37 // from the specifics of the BitVector initialization and query functions.
     38 // This is fast, so there is no need to reinvent the wheel just yet.
     39 
     40 @interface ANTLRBitSet : NSObject < NSMutableCopying > {
     41 	__strong CFMutableBitVectorRef bitVector;
     42 }
     43 
     44 #pragma mark Class Methods
     45 
     46 + (ANTLRBitSet *) newANTLRBitSet;
     47 + (ANTLRBitSet *) newANTLRBitSetWithType:(ANTLRTokenType)type;
     48 /** Construct a ANTLRBitSet given the size
     49  * @param nbits The size of the ANTLRBitSet in bits
     50  */
     51 + (ANTLRBitSet *) newANTLRBitSetWithNBits:(NSUInteger)nbits;
     52 + (ANTLRBitSet *) newANTLRBitSetWithArray:(AMutableArray *)types;
     53 + (ANTLRBitSet *) newANTLRBitSetWithBits:(const unsigned long long *)theBits Count:(NSUInteger)longCount;
     54 
     55 + (ANTLRBitSet *) of:(NSUInteger)el;
     56 + (ANTLRBitSet *) of:(NSUInteger)a And2:(NSUInteger)b;
     57 + (ANTLRBitSet *) of:(NSUInteger)a And2:(NSUInteger)b And3:(NSUInteger)c;
     58 + (ANTLRBitSet *) of:(NSUInteger)a And2:(NSUInteger)b And3:(NSUInteger)c And4:(NSUInteger)d;
     59 
     60 #pragma mark Initializer
     61 
     62 - (ANTLRBitSet *) init;
     63 - (ANTLRBitSet *) initWithType:(ANTLRTokenType)type;
     64 - (ANTLRBitSet *) initWithNBits:(NSUInteger)nbits;
     65 - (ANTLRBitSet *) initWithBitVector:(CFMutableBitVectorRef)theBitVector;
     66 - (ANTLRBitSet *) initWithBits:(const unsigned long long const*)theBits Count:(NSUInteger)theCount;
     67 - (ANTLRBitSet *) initWithArrayOfBits:(NSArray *)theArray;
     68 
     69 #pragma mark Operations
     70 - (ANTLRBitSet *) or:(ANTLRBitSet *) aBitSet;
     71 - (void) orInPlace:(ANTLRBitSet *) aBitSet;
     72 - (void) add:(NSUInteger) bit;
     73 - (void) remove:(NSUInteger) bit;
     74 - (void) setAllBits:(BOOL) aState;
     75 
     76 - (NSInteger) numBits;
     77 - (NSUInteger) size;
     78 - (void) setSize:(NSUInteger) noOfWords;
     79 
     80 #pragma mark Informational
     81 - (unsigned long long) bitMask:(NSUInteger) bitNumber;
     82 - (BOOL) member:(NSUInteger)bitNumber;
     83 - (BOOL) isNil;
     84 - (NSString *) toString;
     85 - (NSString *) description;
     86 
     87 #pragma mark NSCopying support
     88 
     89 - (id) mutableCopyWithZone:(NSZone *) theZone;
     90 
     91 
     92 //private
     93 - (CFMutableBitVectorRef) _bitVector;
     94 @property (getter=_bitVector) CFMutableBitVectorRef bitVector;
     95 @end
     96