SCList.h

Go to the documentation of this file.

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

#import <scl/SCCollection.h>

#define SCListClass @"SCList" ///< SCList class name

@interface SCList : SCCollection {
    NSMutableArray *fList;  // Internal list representation
        SCIndex fCurrentObject; // Index of the current object
}
#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// List name property
@property (retain, getter=listName, setter=setListName:) NSString *listName;
// Current object property
@property (retain, readonly, getter=currentObject) id currentObject;
// First object property
@property (retain, readonly, getter=firstObject) id firstObject;
#endif

#pragma mark -
#pragma mark Initializing List

- (id)initWithListName:(NSString *)name capacity:(SCULong)capacity;

- (id)initWithListName:(NSString *)name;

- (id)initWithCapacity:(SCULong)capacity;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate collection:(id)collection;

- (id)initWithCollection:(id)collection;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate object:(id)object;

- (id)initWithObject:(id)object;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate objects:(id)object, ...;

- (id)initWithObjects:(id)object, ...;

- (id)initWithList:(SCList *)list;

#pragma mark -
#pragma mark Querying and Setting List Properties

- (NSString *)listName;

- (void)setListName:(NSString *)listName;

#pragma mark -
#pragma mark Querying List

- (id)firstObject;

- (NSString *)firstString;

- (NSNumber *)firstNumber;

- (SCByte)firstByte;

- (SCUByte)firstUByte;

- (SCShort)firstShort;

- (SCUShort)firstUShort;

- (SCInteger)firstInteger;

- (SCUInteger)firstUInteger;

- (SCLong)firstLong;

- (SCULong)firstULong;

- (char)firstChar;

- (unichar)firstUnichar;

- (const char *)firstCharString;

- (BOOL)firstBool;

- (SCFloat)firstFloat;

- (SCDouble)firstDouble;

- (id)currentObject;

- (NSString *)currentString;

- (NSNumber *)currentNumber;

- (SCByte)currentByte;

- (SCUByte)currentUByte;

- (SCShort)currentShort;

- (SCUShort)currentUShort;

- (SCInteger)currentInteger;

- (SCUInteger)currentUInteger;

- (SCLong)currentLong;

- (SCULong)currentULong;

- (char)currentChar;

- (unichar)currentUnichar;

- (const char *)currentCharString;

- (BOOL)currentBool;

- (SCFloat)currentFloat;

- (SCDouble)currentDouble;

#pragma mark -
#pragma mark Controlling List

- (id)nextObject;

#pragma mark -
#pragma mark Inserting Objects

- (void)insertFirstObject:(id)object;

- (void)insertFirstByte:(SCByte)byte;

- (void)insertFirstUByte:(SCUByte)byte;

- (void)insertFirstShort:(SCShort)shortint;

- (void)insertFirstUShort:(SCUShort)shortint;

- (void)insertFirstInteger:(SCInteger)integer;

- (void)insertFirstUInteger:(SCUInteger)integer;

- (void)insertFirstLong:(SCLong)longint;

- (void)insertFirstULong:(SCULong)longint;

- (void)insertFirstChar:(char)chr;

- (void)insertFirstUnichar:(unichar)chr;

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

- (void)insertFirstBool:(BOOL)boolean;

- (void)insertFirstFloat:(SCFloat)flt;

- (void)insertFirstDouble:(SCDouble)dbl;

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

- (void)insertFirstObjectsFromCollection:(id)collection;

- (void)insertCurrentObject:(id)object;

- (void)insertCurrentByte:(SCByte)byte;

- (void)insertCurrentUByte:(SCUByte)byte;

- (void)insertCurrentShort:(SCShort)shortint;

- (void)insertCurrentUShort:(SCUShort)shortint;

- (void)insertCurrentInteger:(SCInteger)integer;

- (void)insertCurrentUInteger:(SCUInteger)integer;

- (void)insertCurrentLong:(SCLong)longint;

- (void)insertCurrentULong:(SCULong)longint;

- (void)insertCurrentChar:(char)chr;

- (void)insertCurrentUnichar:(unichar)chr;

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

- (void)insertCurrentBool:(BOOL)boolean;

- (void)insertCurrentFloat:(SCFloat)flt;

- (void)insertCurrentDouble:(SCDouble)dbl;

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

- (void)insertCurrentObjectsFromCollection:(id)collection;

#pragma mark -
#pragma mark Removing Objects

- (void)removeFirstObject;

- (void)removeCurrentObject;

#pragma mark -
#pragma mark Replacing Objects

- (void)replaceFirstObjectWithObject:(id)object;

- (void)replaceFirstObjectWithByte:(SCByte)byte;

- (void)replaceFirstObjectWithUByte:(SCUByte)byte;

- (void)replaceFirstObjectWithShort:(SCShort)shortint;

- (void)replaceFirstObjectWithUShort:(SCUShort)shortint;

- (void)replaceFirstObjectWithInteger:(SCInteger)integer;

- (void)replaceFirstObjectWithUInteger:(SCUInteger)integer;

- (void)replaceFirstObjectWithLong:(SCLong)longint;

- (void)replaceFirstObjectWithULong:(SCULong)longint;

- (void)replaceFirstObjectWithChar:(char)chr;

- (void)replaceFirstObjectWithUnichar:(unichar)chr;

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

- (void)replaceFirstObjectWithBool:(BOOL)boolean;

- (void)replaceFirstObjectWithFloat:(SCFloat)flt;

- (void)replaceFirstObjectWithDouble:(SCDouble)dbl;

- (void)replaceCurrentObjectWithObject:(id)object;

- (void)replaceCurrentObjectWithByte:(SCByte)byte;

- (void)replaceCurrentObjectWithUByte:(SCUByte)byte;

- (void)replaceCurrentObjectWithShort:(SCShort)shortint;

- (void)replaceCurrentObjectWithUShort:(SCUShort)shortint;

- (void)replaceCurrentObjectWithInteger:(SCInteger)integer;

- (void)replaceCurrentObjectWithUInteger:(SCUInteger)integer;

- (void)replaceCurrentObjectWithLong:(SCLong)longint;

- (void)replaceCurrentObjectWithULong:(SCULong)longint;

- (void)replaceCurrentObjectWithChar:(char)chr;

- (void)replaceCurrentObjectWithUnichar:(unichar)chr;

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

- (void)replaceCurrentObjectWithBool:(BOOL)boolean;

- (void)replaceCurrentObjectWithFloat:(SCFloat)flt;

- (void)replaceCurrentObjectWithDouble:(SCDouble)dbl;

#pragma mark -
#pragma mark Copying Objects

- (void)duplicateFirstObject;

- (void)duplicateCurrentObject;

@end