SCStrings.h

Go to the documentation of this file.

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

#import <scl/SCObject.h>
#import <scl/SCArray.h>
#import <scl/SCTextDelegate.h>

#define SCStringsClass           @"SCStrings"         ///< SCStrings class name

#pragma mark Strings list support constants

#define SCTextUnlimited   0           ///< Unlimited text size

@interface SCStrings : SCObject {
        SCArray *fStrings;                              // Array with strings
        id<SCTextDelegate> fDelegate;   // Delegate object
        BOOL fModified;                                 // Modification flag
        BOOL fCaseInsensitive;                  // Case insensitive flag
        BOOL fUnique;                   // Unique flag
        BOOL fStrongUnique;             // String unique flag
}
#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// List name property
@property (retain, getter=textName, setter=setTextName:) NSString *textName;
// Items count property
@property (assign, readonly, getter=count) SCULong count;
// Read only property
@property (assign, getter=isReadOnly, setter=setReadOnly:) BOOL isReadOnly;
// List capacity property
@property (assign, getter=capacity, setter=setCapacity:) SCULong capacity;
// Unlimited list 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 list flag property
@property (assign, readonly, getter=isEmpty) BOOL isEmpty;
// Description property
@property (retain, readonly, getter=description) NSString *description;
// List events delegate object
@property (assign, getter=delegate, setter=setDelegate:) id<SCTextDelegate> delegate;
// Modified flag property
@property (assign, readonly, getter=isModified) BOOL isModified;
// Case insensitive flag property
@property (assign, getter=caseInsensitive, setter=setCaseInsensitive:) BOOL caseInsensitive;
// Unique flag property
@property (assign, getter=isUnique, setter=setUnique:) BOOL isUnique;
// String unique flag property
@property (assign, getter=isStrongUnique, setter=setStrongUnique:) BOOL isStrongUnique;
#endif

#pragma mark -
#pragma mark Creating List

+ (SCStrings *)listWithDataDictionary:(NSDictionary *)dictionary;

+ (SCStrings *)listWithDataDictionaryFromFile:(NSString *)path;

+ (SCStrings *)listWithCoder:(NSCoder *)coder;

+ (SCStrings *)listWithContentsOfSerializedFile:(NSString *)path;

+ (SCStrings *)listWithStream:(SCStream *)stream;

+ (SCStrings *)listWithFileStream:(NSString *)path;

+ (SCStrings *)listWithName:(NSString *)name
                                   capacity:(SCULong)capacity
                                   delegate:(id<SCTextDelegate>)delegate;

+ (SCStrings *)listWithName:(NSString *)name capacity:(SCULong)capacity;

+ (SCStrings *)listWithName:(NSString *)name delegate:(id<SCTextDelegate>)delegate;

+ (SCStrings *)listWithName:(NSString *)name;

+ (SCStrings *)listWithDelegate:(id<SCTextDelegate>)delegate;

+ (SCStrings *)listWithCapacity:(SCULong)capacity;

+ (SCStrings *)list;

+ (SCStrings *)listWithString:(NSString *)string;

+ (SCStrings *)listWithStrings:(NSString *)string, ...;

+ (SCStrings *)listWithCollection:(id)collection;

+ (SCStrings *)listWithList:(SCStrings *)list;

#pragma mark -
#pragma mark Initializing List

- (id)initWithName:(NSString *)name
                  capacity:(SCULong)capacity
                  delegate:(id<SCTextDelegate>)delegate;

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

- (id)initWithName:(NSString *)name delegate:(id<SCTextDelegate>)delegate;

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

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

- (id)initWithCapacity:(SCULong)capacity;

- (id)init;

- (id)initWithString:(NSString *)string;

- (id)initWithStrings:(NSString *)string, ...;

- (id)initWithCollection:(id)collection;

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

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

- (NSString *)textName;

- (SCULong)count;

- (BOOL)isReadOnly;

- (SCULong)capacity;

- (BOOL)isUnlimited;

- (SCLong)freeCount;

- (BOOL)freeItemsAvailable;

- (BOOL)isEmpty;

- (id<SCTextDelegate>)delegate;

- (BOOL)isModified;

- (BOOL)caseInsensitive;

- (BOOL)isUnique;

- (BOOL)isStrongUnique;

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

- (void)setReadOnly:(BOOL)flag;

- (void)setCapacity:(SCULong)capacity;

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

- (void)setCaseInsensitive:(BOOL)value;

- (void)setUnique:(BOOL)flag;

- (void)setStrongUnique:(BOOL)flag;

#pragma mark -
#pragma mark Setting and Copying Lists

- (void)copyFromCollection:(id)collection;

- (void)copyFromList:(SCStrings *)list;

- (void)copyFromString:(NSString *)string;

- (void)copyFromStrings:(NSString *)string, ...;

- (void)copySortedAscendingFromCollection:(id)collection usingMethod:(id<SCSortingProtocol>)method;

- (void)copySortedAscendingFromList:(SCStrings *)list usingMethod:(id<SCSortingProtocol>)method;

- (void)copySortedDescendingFromCollection:(id)collection usingMethod:(id<SCSortingProtocol>)method;

- (void)copySortedDescendingFromList:(SCStrings *)list usingMethod:(id<SCSortingProtocol>)method;

- (void)copySortedFromCollection:(id)collection usingMethod:(id<SCSortingProtocol>)method;

- (void)copySortedFromList:(SCStrings *)list usingMethod:(id<SCSortingProtocol>)method;

- (void)copySortedAscendingFromCollection:(id)collection;

- (void)copySortedAscendingFromList:(SCStrings *)list;

- (void)copySortedDescendingFromCollection:(id)collection;

- (void)copySortedDescendingFromList:(SCStrings *)list;

- (void)copySortedFromCollection:(id)collection;

- (void)copySortedFromList:(SCStrings *)list;

#pragma mark -
#pragma mark Comparing Lists

- (BOOL)isEqualToCollection:(id)collection caseInsensitive:(BOOL)value;

- (BOOL)isEqualToCollection:(id)collection;

- (BOOL)isEqualToList:(SCStrings *)list caseInsensitive:(BOOL)value;

- (BOOL)isEqualToList:(SCStrings *)list;

- (BOOL)isEqualToContentsOfCollection:(id)collection caseInsensitive:(BOOL)value;

- (BOOL)isEqualToContentsOfCollection:(id)collection;

- (BOOL)isEqualToContentsOfList:(SCStrings *)list caseInsensitive:(BOOL)value;

- (BOOL)isEqualToContentsOfList:(SCStrings *)list;

- (BOOL)isEqual:(id)object;

#pragma mark -
#pragma mark Enumerating Lists

- (NSEnumerator *)stringEnumerator;

- (NSEnumerator *)reverseStringEnumerator;

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

- (void)enumerate;

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

- (void)reverseEnumerate;

#pragma mark -
#pragma mark Describing List

- (NSString *)description;

#pragma mark -
#pragma mark Converting List

- (SCArray *)array;

- (SCSet *)set;

- (SCStack *)stack;

- (SCQueue *)queue;

- (SCDictionary *)dictionary;

- (SCUnidirectionalList *)unidirectionalList;

- (SCBidirectionalList *)bidirectionalList;

- (NSArray *)foundationArray;

- (NSSet *)foundationSet;

- (NSDictionary *)foundationDictionary;

#pragma mark -
#pragma mark Sorting List

- (void)sortingListAscendingWithMethod:(id<SCSortingProtocol>)method;

- (void)sortingListDescendingWithMethod:(id<SCSortingProtocol>)method;

- (void)sortingListWithMethod:(id<SCSortingProtocol>)method;

- (void)sortingListAscending;

- (void)sortingListDescending;

- (void)sortingList;

- (SCStrings *)sortedListAscendingWithMethod:(id<SCSortingProtocol>)method;

- (SCStrings *)sortedListDescendingWithMethod:(id<SCSortingProtocol>)method;

- (SCStrings *)sortedListWithMethod:(id<SCSortingProtocol>)method;

- (SCStrings *)sortedListAscending;

- (SCStrings *)sortedListDescending;

- (SCStrings *)sortedList;

#pragma mark -
#pragma mark Adding Strings

- (void)addString:(NSString *)string;

- (void)addStrings:(NSString *)string, ...;

- (void)addStringsFromCollection:(id)collection;

- (void)addStringsFromList:(SCStrings *)list;

- (void)addLine;

- (void)insertString:(NSString *)string atIndex:(SCIndex)index;

- (void)insertAtIndex:(SCIndex)index strings:(NSString *)string, ...;

- (void)insertStringsFromCollection:(id)collection atIndex:(SCIndex)index;

- (void)insertStringsFromList:(SCStrings *)list atIndex:(SCIndex)index;

- (void)insertAtIndexes:(NSIndexSet *)indexes strings:(NSString *)string, ...;

- (void)insertStringsFromCollection:(id)collection atIndexes:(NSIndexSet *)indexes;

- (void)insertStringsFromList:(SCStrings *)list atIndexes:(NSIndexSet *)indexes;

- (void)insertLineAtIndex:(SCIndex)index;

#pragma mark -
#pragma mark Removing Strings

- (void)removeAllStrings;

- (void)removeFirstString;

- (void)removeLastString;

- (void)removeStringAtIndex:(SCIndex)index;

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

- (void)removeStringsEqualTo:(NSString *)string caseInsensitive:(BOOL)value;

- (void)removeStringsEqualTo:(NSString *)string;

- (void)removeStringsInCollection:(id)collection caseInsensitive:(BOOL)value;

- (void)removeStringsInCollection:(id)collection;

- (void)removeStringsInList:(SCStrings *)list caseInsensitive:(BOOL)value;

- (void)removeStringsInList:(SCStrings *)list;

- (void)removeString:(NSString *)string caseInsensitive:(BOOL)value;

- (void)removeString:(NSString *)string;

- (void)removeWithCaseInsensitive:(BOOL)value strings:(NSString *)string, ...;

- (void)removeStrings:(NSString *)string, ...;

- (void)removeStringsWithSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (void)removeStringsWithSubstring:(NSString *)substring;

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

- (void)removeStringsNotEqualTo:(NSString *)string caseInsensitive:(BOOL)value;

- (void)removeStringsNotEqualTo:(NSString *)string;

- (void)removeStringsNotInCollection:(id)collection caseInsensitive:(BOOL)value;

- (void)removeStringsNotInCollection:(id)collection;

- (void)removeStringsNotInList:(SCStrings *)list caseInsensitive:(BOOL)value;

- (void)removeStringsNotInList:(SCStrings *)list;

- (void)removeStringsWithoutSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (void)removeStringsWithoutSubstring:(NSString *)substring;

- (void)removeDuplicatedStrings;

#pragma mark -
#pragma mark Replacing Strings

- (void)replaceStringAtIndex:(SCIndex)index withString:(NSString *)string;

- (void)replaceStringsAtIndexes:(NSIndexSet *)indexes withStrings:(NSString *)string, ...;

- (void)replaceStringsAtIndexes:(NSIndexSet *)indexes withStringsFromCollection:(id)collection;

- (void)replaceStringsAtIndexes:(NSIndexSet *)indexes withStringsFromList:(SCStrings *)list;

#pragma mark -
#pragma mark Moving and Copying Strings

- (void)exchangeStringAtIndex:(SCIndex)index withStringAtIndex:(SCIndex)destination;

- (void)duplicateStringAtIndex:(SCIndex)index;

- (void)duplicateAllStrings;

- (void)duplicate;

- (void)copyStringAtIndex:(SCIndex)index toIndex:(SCIndex)destination;

- (void)moveStringAtIndex:(SCIndex)index toIndex:(SCIndex)destination;

- (void)forwardMoveStringAtIndex:(SCIndex)index steps:(SCULong)steps;

- (void)forwardMoveStringAtIndex:(SCIndex)index;

- (void)backwardMoveStringAtIndex:(SCIndex)index steps:(SCULong)steps;

- (void)backwardMoveStringAtIndex:(SCIndex)index;

- (void)moveToFirstPositionStringAtIndex:(SCIndex)index;

- (void)moveToLastPositionStringAtIndex:(SCIndex)index;

- (void)reverse;

- (SCStrings *)reversedList;

#pragma mark -
#pragma mark Querying List

- (NSString *)firstString;

- (NSString *)lastString;

- (NSString *)stringAtIndex:(SCIndex)index;

- (SCStrings *)stringsAtIndexes:(NSIndexSet *)indexes;

#pragma mark -
#pragma mark Finding and Selecting Strings

- (BOOL)containsString:(NSString *)string caseInsensitive:(BOOL)value;

- (BOOL)containsString:(NSString *)string;

- (BOOL)containsWithCaseInsensitive:(BOOL)value strings:(NSString *)string, ...;

- (BOOL)containsStrings:(NSString *)string, ...;

- (BOOL)containsStringsFromCollection:(id)collection caseInsensitive:(BOOL)value;

- (BOOL)containsStringsFromCollection:(id)collection;

- (BOOL)containsStringsFromList:(SCStrings *)list caseInsensitive:(BOOL)value;

- (BOOL)containsStringsFromList:(SCStrings *)list;

- (BOOL)containsWithCaseInsensitive:(BOOL)value anyString:(NSString *)string, ...;

- (BOOL)containsAnyString:(NSString *)string, ...;

- (BOOL)containsAnyStringFromCollection:(id)collection caseInsensitive:(BOOL)value;

- (BOOL)containsAnyStringFromCollection:(id)collection;

- (BOOL)containsAnyStringFromList:(SCStrings *)list caseInsensitive:(BOOL)value;

- (BOOL)containsAnyStringFromList:(SCStrings *)list;

- (BOOL)containsSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (BOOL)containsSubstring:(NSString *)substring;

- (BOOL)containsWithCaseInsensitive:(BOOL)value substrings:(NSString *)substring, ...;

- (BOOL)containsSubstrings:(NSString *)substring, ...;

- (BOOL)containsSubstringsFromCollection:(id)collection caseInsensitive:(BOOL)value;

- (BOOL)containsSubstringsFromCollection:(id)collection;

- (BOOL)containsSubstringsFromList:(SCStrings *)list caseInsensitive:(BOOL)value;

- (BOOL)containsSubstringsFromList:(SCStrings *)list;

- (BOOL)containsWithCaseInsensitive:(BOOL)value anySubstring:(NSString *)substring, ...;

- (BOOL)containsAnySubstring:(NSString *)substring, ...;

- (BOOL)containsAnySubstringFromCollection:(id)collection caseInsensitive:(BOOL)value;

- (BOOL)containsAnySubstringFromCollection:(id)collection;

- (BOOL)containsAnySubstringFromList:(SCStrings *)list caseInsensitive:(BOOL)value;

- (BOOL)containsAnySubstringFromList:(SCStrings *)list;

- (BOOL)containsDuplicatedStrings;

- (SCIndex)indexOfString:(NSString *)string caseInsensitive:(BOOL)value;

- (SCIndex)indexOfString:(NSString *)string;

- (SCIndex)indexOfString:(NSString *)string fromIndex:(SCIndex)index caseInsensitive:(BOOL)value;

- (SCIndex)indexOfString:(NSString *)string fromIndex:(SCIndex)index;

- (SCIndex)indexOfLastString;

- (SCIndex)indexOfSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (SCIndex)indexOfSubstring:(NSString *)substring;

- (SCStrings *)stringsWithSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (SCStrings *)stringsWithSubstring:(NSString *)substring;

- (SCStrings *)stringsWithoutSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (SCStrings *)stringsWithoutSubstring:(NSString *)substring;

- (SCULong)countOfString:(NSString *)string caseInsensitive:(BOOL)value;

- (SCULong)countOfString:(NSString *)string;

- (SCULong)countOfSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (SCULong)countOfSubstring:(NSString *)substring;

- (SCULong)countOfStringsWithSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (SCULong)countOfStringsWithSubstring:(NSString *)substring;

@end