SCList.h

Go to the documentation of this file.

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

#import <Foundation/Foundation.h>
#import <scl/NSArray+SCArray.h>
#import <scl/NSDictionary+SCDictionary.h>
#import <scl/SCCollection.h>

#pragma mark -
#pragma mark Class Constants

#define SCListClass @"SCList"


@interface SCList : SCCollection {
    NSMutableArray  *_list;             // Internal data storage
    SCIndex          _currentObject;    // Index of the current object
}

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

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

#pragma mark -
#pragma mark Creating Lists
+ (instancetype)listWithCoder:(NSCoder *)coder;
+ (instancetype)listWithContentsOfSerializedFile:(NSString *)path;
+ (instancetype)listWithDataDictionary:(NSDictionary *)dictionary;
+ (instancetype)listWithDataDictionaryFromFile:(NSString *)path;
+ (instancetype)listWithStream:(SCStream *)stream;
+ (instancetype)listWithFileStream:(NSString *)path;
+ (instancetype)listWithData:(NSData *)data;
+ (instancetype)listWithContentsOfFile:(NSString *)path;
+ (instancetype)listWithContentsOfURL:(NSURL *)url;
+ (instancetype)listWithContentsOfURLString:(NSString *)urlString;

+ (instancetype)listWithName:(NSString *)name;
+ (instancetype)listWithObject:(id<SCCollectioning>)object;
+ (instancetype)listWithObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
+ (instancetype)listWithCollection:(id<SCCollection>)collection;
+ (instancetype)listWithArray:(SCArray *)array;
+ (instancetype)listWithList:(SCList *)list;
+ (instancetype)list;

#pragma mark -
#pragma mark Initializing Lists
- (instancetype)initWithName:(NSString *)name;
- (instancetype)initWithObject:(id<SCCollectioning>)object;
- (instancetype)initWithObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (instancetype)initWithCollection:(id<SCCollection>)collection;
- (instancetype)initWithArray:(SCArray *)array;
- (instancetype)initWithList:(SCList *)list;
- (instancetype)init;

#pragma mark -
#pragma mark Copying Lists
- (void)setList:(SCList *)list;

#pragma mark -
#pragma mark Comparing Lists
- (BOOL)isEqualToList:(SCList *)list;

#pragma mark -
#pragma mark Deriving New Lists
- (instancetype)listByAddingObject:(id<SCCollectioning>)object;
- (instancetype)listByAddingObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (instancetype)listByAddingCollection:(id<SCCollection>)collection;
- (instancetype)listByAddingObjectsFromArray:(SCArray *)array;
- (instancetype)listByAddingArray:(SCArray *)array;
- (instancetype)listByAddingObjectsFromList:(SCList *)list;
- (instancetype)listByAddingList:(SCList *)list;

#pragma mark -
#pragma mark List Control
- (id)nextObject;

#pragma mark -
#pragma mark Adding Objects
- (void)insertCurrentObject:(id<SCCollectioning>)object;
- (void)insertCurrentObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (void)insertCurrentCollection:(id<SCCollection>)collection;

- (void)insertFirstObject:(id<SCCollectioning>)object;
- (void)insertFirstObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (void)insertFirstCollection:(id<SCCollection>)collection;

- (void)addObjectsFromArray:(SCArray *)array;
- (void)addArray:(SCArray *)array;
- (void)addObjectsFromList:(SCList *)list;
- (void)addList:(SCList *)list;

#pragma mark -
#pragma mark Removing Objects
- (void)removeCurrentObject;
- (void)removeFirstObject;

#pragma mark -
#pragma mark Replacing Objects
- (void)replaceCurrentObjectWithObject:(id<SCCollectioning>)object;
- (void)replaceFirstObjectWithObject:(id<SCCollectioning>)object;

#pragma mark -
#pragma mark Copying Objects
- (void)duplicateCurrentObject;
- (void)duplicateFirstObject;

@end