SCCollectionProtocols.h

Go to the documentation of this file.

//
//  SCCollectionProtocols.h
//  scl
//
//  Created by Viacheslav Smolensky on 09.03.17.
//  Copyright (c) 2007 - 2018 by Samond Development Corporation. All rights reserved.
//

#import <Foundation/Foundation.h>
#if defined(GNUSTEP) && !defined(NS_ORDERED_SER_CLASS)
#import <scl/NSOrderedSet.h>
#endif
#import <scl/SCCollectioning.h>
#import <scl/SCTypes.h>

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

#pragma mark -
#pragma mark Collection Support Types

typedef NSUInteger SCIndex;

typedef enum {
    SCCollectionArray                   = 0x01,
    
    SCCollectionSet                     = 0x02,
    
    SCCollectionOrderedSet              = 0x03,
    
    SCCollectionDictionary              = 0x04,
    
    SCCollectionStack                   = 0x11,
    
    SCCollectionQueue                   = 0x12,
    
    SCCollectionList                    = 0x13,
    
    SCCollectionUnidirectionalList      = 0x14,
    
    SCCollectionBidirectionalList       = 0x15,
    
    SCCollectionFoundationArray         = 0x21,
    
    SCCollectionFoundationSet           = 0x22,
    
    SCCollectionFoundationOrderedSet    = 0x23,
    
    SCCollectionFoundationDictionary    = 0x24
} SCCollectionType;

@protocol SCCollectionDelegate;

#pragma mark -
#pragma mark Protocol SCCollection Declaration

@protocol SCCollection

#pragma mark -
#pragma mark Primary Collection Properties

@property (nonatomic, readonly, retain) NSString *name;

@property (nonatomic, readonly, assign) SCIndex count;

@property (nonatomic, readonly, assign) BOOL empty;

@property (nonatomic, readonly, assign) BOOL readOnly;

@property (nonatomic, readonly, retain) id<SCCollectionDelegate> delegate;

#pragma mark -
#pragma mark Additional Collection Properties

@property (nonatomic, readonly, assign) SCArray *array;

@property (nonatomic, readonly, assign) SCSet *set;

@property (nonatomic, readonly, assign) SCOrderedSet *orderedSet;

@property (nonatomic, readonly, assign) SCDictionary *dictionary;

@property (nonatomic, readonly, assign) SCStack *stack;

@property (nonatomic, readonly, assign) SCQueue *queue;

@property (nonatomic, readonly, assign) SCUnidirectionalList *unidirectionalList;

@property (nonatomic, readonly, assign) SCBidirectionalList *bidirectionalList;

@property (nonatomic, readonly, assign) NSArray *foundationArray;

@property (nonatomic, readonly, assign) NSSet *foundationSet;

@property (nonatomic, readonly, assign) NSOrderedSet *foundationOrderedSet;

@property (nonatomic, readonly, assign) NSDictionary *foundationDictionary;

@optional
#pragma mark -
#pragma mark Objects Enumerators

@property (nonatomic, readonly, assign) NSEnumerator *objectEnumerator;

@property (nonatomic, readonly, assign) NSEnumerator *reverseObjectEnumerator;

- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state objects:(id *)objects count:(NSUInteger)count;

#pragma mark -
#pragma mark Detecting Collection Type

@property (nonatomic, readonly, assign) SCCollectionType collectionType;

@property (nonatomic, readonly, assign) BOOL isCollection;

@property (nonatomic, readonly, assign) BOOL isLibraryCollection;

@property (nonatomic, readonly, assign) BOOL isFoundationCollection;

@property (nonatomic, readonly, assign) BOOL isArray;

@property (nonatomic, readonly, assign) BOOL isLibraryArray;

@property (nonatomic, readonly, assign) BOOL isFoundationArray;

@property (nonatomic, readonly, assign) BOOL isSet;

@property (nonatomic, readonly, assign) BOOL isLibrarySet;

@property (nonatomic, readonly, assign) BOOL isFoundationSet;

@property (nonatomic, readonly, assign) BOOL isOrderedSet;

@property (nonatomic, readonly, assign) BOOL isLibraryOrderedSet;

@property (nonatomic, readonly, assign) BOOL isFoundationOrderedSet;

@property (nonatomic, readonly, assign) BOOL isDictionary;

@property (nonatomic, readonly, assign) BOOL isLibraryDictionary;

@property (nonatomic, readonly, assign) BOOL isFoundationDictionary;

@property (nonatomic, readonly, assign) BOOL isStack;

@property (nonatomic, readonly, assign) BOOL isQueue;

@property (nonatomic, readonly, assign) BOOL isList;

@property (nonatomic, readonly, assign) BOOL isSortable;

@required
#pragma mark -
#pragma mark Initializing Collections

- (instancetype)initWithCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Поиск объектов коллекции

- (BOOL)containsObject:(id<SCCollectioning>)object;

- (BOOL)containsObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;

- (BOOL)containsCollection:(id<SCCollection>)collection;

- (BOOL)containsAnyObject:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;

- (BOOL)containsAnyObjectFromCollection:(id<SCCollection>)collection;

- (BOOL)isEqualToCollection:(id<SCCollection>)collection;

@end

#pragma mark -
#pragma mark Protocol SCMutableCollection Declaration

@protocol SCMutableCollection <SCCollection>

#pragma mark -
#pragma mark Copying Collections

- (void)setCollection:(id<SCCollection>)collection;

- (void)setObject:(id<SCCollectioning>)object;

- (void)setObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;

#pragma mark -
#pragma mark Adding Objects

- (void)addObject:(id<SCCollectioning>)object;

- (void)addObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;

- (void)addCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Removing Objects

- (void)removeAllObjects;

- (void)removeObjectsWithClass:(Class)oclass;

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

- (void)removeCollection:(id<SCCollection>)collection;

- (void)removeObject:(id<SCCollectioning>)object;

- (void)removeObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;

@end

#pragma mark -
#pragma mark Protocol SCIndexedCollection Declaration

@protocol SCIndexedCollection <SCCollection>

#pragma mark -
#pragma mark Querying a Collection

@property (nonatomic, readonly, assign) id firstObject;

@property (nonatomic, readonly, assign) id lastObject;

- (id)objectAtIndex:(SCIndex)index;

- (id)objectAtIndexedSubscript:(SCIndex)index;

#pragma mark -
#pragma mark Finding Objects in a Collection

- (SCIndex)indexOfObject:(id<SCCollectioning>)object;

@property (nonatomic, readonly, assign) SCIndex indexOfLastObject;

@end

#pragma mark -
#pragma mark Protocol SCMutableIndexedCollection Declaration

@protocol SCMutableIndexedCollection <SCIndexedCollection>

#pragma mark -
#pragma mark Adding Objects

- (void)insertObject:(id<SCCollectioning>)object atIndex:(SCIndex)index;

#pragma mark -
#pragma mark Removing Objects

- (void)removeObjectAtIndex:(SCIndex)index;

- (void)removeObjectsAtIndexes:(NSIndexSet *)indexes;

#pragma mark -
#pragma mark Replacing Objects

- (void)replaceObjectAtIndex:(SCIndex)index withObject:(id<SCCollectioning>)object;

- (void)setObject:(id<SCCollectioning>)object atIndexedSubscript:(SCIndex)index;

@end

#pragma mark -
#pragma mark Protocol SCKeydCollection Declaration

@protocol SCKeyedCollection <SCCollection>

#pragma mark -
#pragma mark Querying a Collection

- (id)objectForKey:(NSString *)key;

- (id)objectForKeyedSubscript:(NSString *)key;

- (id)valueForKey:(NSString *)key;

@end

#pragma mark -
#pragma mark Protocol SCMutableKeyedCollection Declaration

@protocol SCMutableKeyedCollection <SCKeyedCollection>

#pragma mark -
#pragma mark Adding and Changing Objects

- (void)setObject:(id<SCCollectioning>)object forKey:(NSString *)key;

- (void)setObject:(id<SCCollectioning>)object forKeyedSubscript:(NSString *)key;

- (void)setValue:(id<SCCollectioning>)value forKey:(NSString *)key;

#pragma mark -
#pragma mark Removing Objects

- (void)removeObjectForKey:(NSString *)key;

@end