SCCollection.h

Go to the documentation of this file.

//
//  SCCollection.h
//  scl
//
//  Created by Viacheslav Smolensky on 13.04.12.
//  Copyright (c) 2007 - 2014 by Samond Development Corporation. All rights reserved.
//

#import <scl/SCTypes.h>
#import <scl/SCObject.h>
#import <scl/SCSortingProtocol.h>
#import <scl/SCCollectionDelegate.h>

@class SCStack;
@class SCQueue;
@class SCArray;
@class SCSet;
@class SCDictionary;
@class SCList;
@class SCUnidirectionalList;
@class SCBidirectionalList;

#define SCCollectionClass           @"SCCollection"         ///< SCCollection class name
#define SCOrderedSetClass           @"SCOrderedSet"         ///< SCOrderedSet class name
#define NSOrderedSetClass           @"NSOrderedSet"         ///< NSOrderedSet class name
#define NSMutableOrderedSetClass    @"NSMutableOrderedSet"  ///< NSMutableOrderedSet class name

#pragma mark Collection support constants

#define SCCollectionUnlimited   0           ///< Unlimited collection size
#define SCNotFound              NSNotFound  ///< Constant indicates that required item not found

#pragma mark -
#pragma mark Collection support types

enum _SCCollectionType {
    SCCollectionGeneric             =  0,   
    SCCollectionArray               =  1,   
    SCCollectionSet                 =  2,   
    SCCollectionOrderedSet          =  3,   
    SCCollectionStack               =  4,   
    SCCollectionQueue               =  5,   
    SCCollectionDictionary          =  6,   
    SCCollectionGenericList         =  7,   
    SCCollectionUnidirectionalList  =  8,   
    SCCollectionBidirectionalList   =  9,   
    SCCollectionUserSpecified       = 10,   
};

typedef enum _SCCollectionType SCCollectionType;

#pragma mark -

@interface SCCollection : SCObject {
    NSString *fCollectionName;          // Collection name
    BOOL fReadOnly;                     // Read only flag
    SCULong fCapacity;                  // Collection maximum size
    id<SCCollectionDelegate> fDelegate; // Collection events delegate object
}
#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// Collection type property
@property (assign, readonly, getter=type) SCCollectionType type;
// Collection type name property
@property (retain, readonly, getter=typeName) NSString *typeName;
// Collection name property
@property (retain, getter=collectionName, setter=setCollectionName:) NSString *collectionName;
// Items count property
@property (assign, readonly, getter=count) SCULong count;
// Random access support property
@property (assign, readonly, getter=isRandomAccess) BOOL isRandomAccess;
// Indexing support property
@property (assign, readonly, getter=isIndexed) BOOL isIndexed;
// Read only property
@property (assign, getter=isReadOnly, setter=setReadOnly:) BOOL isReadOnly;
// Collection capacity property
@property (assign, getter=capacity, setter=setCapacity:) SCULong capacity;
// Unlimited collection size property
@property (assign, readonly, getter=isUnlimited) BOOL isUnlimited;
// Free items count property
@property (assign, readonly, getter=freeCount) SCLong freeCount;
// Free items availability property
@property (assign, readonly, getter=freeItemsAvailable) BOOL freeItemsAvailable;
// Empty collection flag property
@property (assign, readonly, getter=isEmpty) BOOL isEmpty;
// Description property
@property (retain, readonly, getter=description) NSString *description;
// Collection events delegate object
@property (assign, getter=delegate, setter=setDelegate:) id<SCCollectionDelegate> delegate;
#endif

#pragma mark -
#pragma mark Querying Collection Properties

- (SCCollectionType)type;

- (NSString *)typeName;

- (NSString *)collectionName;

- (SCULong)count;

- (BOOL)isRandomAccess;

- (BOOL)isIndexed;

- (BOOL)isReadOnly;

- (SCULong)capacity;

- (BOOL)isUnlimited;

- (SCLong)freeCount;

- (BOOL)freeItemsAvailable;

- (BOOL)isEmpty;

- (id<SCCollectionDelegate>)delegate;

#pragma mark -
#pragma mark Setting Collection Properties

- (void)setCollectionName:(NSString *)name;

- (void)setReadOnly:(BOOL)flag;

- (void)setCapacity:(SCULong)capacity;

- (void)setDelegate:(id<SCCollectionDelegate>)delegate;

#pragma mark -
#pragma mark Setting and Copying Collections

- (void)copyFromCollection:(id)collection;

- (void)copyFromObject:(id)object;

- (void)copyFromObjects:(id)object, ...;

#pragma mark -
#pragma mark Find Objects in Collection

- (BOOL)containsObject:(id)object;

- (BOOL)containsByte:(SCByte)byte;

- (BOOL)containsUByte:(SCUByte)byte;

- (BOOL)containsShort:(SCShort)sht;

- (BOOL)containsUShort:(SCUShort)sht;

- (BOOL)containsInteger:(SCInteger)integer;

- (BOOL)containsUInteger:(SCUInteger)integer;

- (BOOL)containsLong:(SCLong)longint;

- (BOOL)containsULong:(SCULong)longint;

- (BOOL)containsChar:(char)chr;

- (BOOL)containsUnichar:(unichar)chr;

- (BOOL)containsCharString:(const char *)string;

- (BOOL)containsBool:(BOOL)boolean;

- (BOOL)containsFloat:(SCFloat)flt;

- (BOOL)containsDouble:(SCDouble)dbl;

- (BOOL)containsObjects:(id)object, ...;

- (BOOL)containsObjectsFromCollection:(id)collection;

- (BOOL)containsAnyObject:(id)object, ...;

- (BOOL)containsAnyObjectFromCollection:(id)collection;

#pragma mark -
#pragma mark Comparing Collections

- (BOOL)isEqualToCollection:(id)collection;

- (BOOL)isEqualToContentsOfCollection:(id)collection;

- (BOOL)isEqual:(id)object;

#pragma mark -
#pragma mark Enumerating Collections

- (NSEnumerator *)objectEnumerator;

- (NSEnumerator *)reverseObjectEnumerator;

- (void)enumerateWithDelegate:(id<SCCollectionDelegate>)delegate;

- (void)enumerate;

- (void)reverseEnumerateWithDelegate:(id<SCCollectionDelegate>)delegate;

- (void)reverseEnumerate;

#pragma mark -
#pragma mark Describing Collection

- (NSString *)description;

#pragma mark -
#pragma mark Converting Collection

- (SCArray *)array;

- (SCSet *)set;

- (SCStack *)stack;

- (SCQueue *)queue;

- (SCDictionary *)dictionary;

- (SCUnidirectionalList *)unidirectionalList;

- (SCBidirectionalList *)bidirectionalList;

- (NSArray *)foundationArray;

- (NSSet *)foundationSet;

- (NSDictionary *)foundationDictionary;

#pragma mark -
#pragma mark Adding Objects

- (void)addObject:(id)object;

- (void)addObjects:(id)object, ...;

- (void)addByte:(SCByte)byte;

- (void)addUByte:(SCUByte)byte;

- (void)addShort:(SCShort)sht;

- (void)addUShort:(SCUShort)sht;

- (void)addInteger:(SCInteger)integer;

- (void)addUInteger:(SCUInteger)integer;

- (void)addLong:(SCLong)longint;

- (void)addULong:(SCULong)longint;

- (void)addChar:(char)chr;

- (void)addUnichar:(unichar)chr;

- (void)addCharString:(const char *)string;

- (void)addBool:(BOOL)boolean;

- (void)addFloat:(SCFloat)flt;

- (void)addDouble:(SCDouble)dbl;

- (void)addObjectsFromCollection:(id)collection;

#pragma mark -
#pragma mark Removing Objects

- (void)removeAllObjects;

- (void)removeObjectsWithClass:(Class)oclass;

- (void)removeObjectsWithClassName:(NSString *)name;

#pragma mark -
#pragma mark Detecting Collection Type

+ (BOOL)isCollectionClass:(NSString *)name;

+ (BOOL)isLibraryCollectionClass:(NSString *)name;

+ (BOOL)isFoundationCollectionClass:(NSString *)name;

+ (BOOL)isArrayClass:(NSString *)name;

+ (BOOL)isLibraryArrayClass:(NSString *)name;

+ (BOOL)isFoundationArrayClass:(NSString *)name;

+ (BOOL)isSetClass:(NSString *)name;

+ (BOOL)isLibrarySetClass:(NSString *)name;

+ (BOOL)isFoundationSetClass:(NSString *)name;

+ (BOOL)isOrderedSetClass:(NSString *)name;

+ (BOOL)isLibraryOrderedSetClass:(NSString *)name;

+ (BOOL)isFoundationOrderedSetClass:(NSString *)name;

+ (BOOL)isDictionaryClass:(NSString *)name;

+ (BOOL)isLibraryDictionaryClass:(NSString *)name;

+ (BOOL)isFoundationDictionaryClass:(NSString *)name;

+ (BOOL)isStackClass:(NSString *)name;

+ (BOOL)isQueueClass:(NSString *)name;

+ (BOOL)isListClass:(NSString *)name;

+ (BOOL)isSortableClass:(NSString *)name;

- (BOOL)isCollection;

- (BOOL)isLibraryCollection;

- (BOOL)isFoundationCollection;

- (BOOL)isArray;

- (BOOL)isLibraryArray;

- (BOOL)isFoundationArray;

- (BOOL)isSet;

- (BOOL)isLibrarySet;

- (BOOL)isFoundationSet;

- (BOOL)isOrderedSet;

- (BOOL)isLibraryOrderedSet;

- (BOOL)isFoundationOrderedSet;

- (BOOL)isDictionary;

- (BOOL)isLibraryDictionary;

- (BOOL)isFoundationDictionary;

- (BOOL)isStack;

- (BOOL)isQueue;

- (BOOL)isList;

- (BOOL)isSortable;

+ (BOOL)isCollection:(id)object;

+ (BOOL)isLibraryCollection:(id)object;

+ (BOOL)isFoundationCollection:(id)object;

+ (BOOL)isArray:(id)object;

+ (BOOL)isLibraryArray:(id)object;

+ (BOOL)isFoundationArray:(id)object;

+ (BOOL)isSet:(id)object;

+ (BOOL)isLibrarySet:(id)object;

+ (BOOL)isFoundationSet:(id)object;

+ (BOOL)isOrderedSet:(id)object;

+ (BOOL)isLibraryOrderedSet:(id)object;

+ (BOOL)isFoundationOrderedSet:(id)object;

+ (BOOL)isDictionary:(id)object;

+ (BOOL)isLibraryDictionary:(id)object;

+ (BOOL)isFoundationDictionary:(id)object;

+ (BOOL)isStack:(id)object;

+ (BOOL)isQueue:(id)object;

+ (BOOL)isList:(id)object;

+ (BOOL)isSortable:(id)object;

#pragma mark -
#pragma mark Additional methods

+ (SCULong)countOfCollection:(id)collection;

@end