SCStrings.h

Go to the documentation of this file.

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

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

#pragma mark -
#pragma mark Class Constants

#define SCStringsClass  @"SCStrings"


@interface SCStrings : SCObject <NSFastEnumeration> {
    SCArray             *_strings;          // Internal data storage
    BOOL                 _modified;         // Modified flag
    BOOL                 _caseInsensitive;  // Case insensitive flag
    id<SCTextDelegate>   _delegate;         // Delegate object
}

#pragma mark -
#pragma mark Instance Properties

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

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

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

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

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

@property (nonatomic, readwrite, assign) BOOL caseInsensitive;

@property (nonatomic, readwrite, retain) id<SCTextDelegate> delegate;

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

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

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

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

@property (nonatomic, readonly, assign) SCStrings *ascendingSortedStrings;

@property (nonatomic, readonly, assign) SCStrings *descendingSortedStrings;

@property (nonatomic, readonly, assign) SCStrings *sortedStrings;

@property (nonatomic, readonly, assign) SCStrings *reversedStrings;

@property (nonatomic, readonly, assign) NSString *firstString;

@property (nonatomic, readonly, assign) NSString *lastString;

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

#pragma mark -
#pragma mark Creating Strings Lists
+ (instancetype)stringsWithCoder:(NSCoder *)coder;
+ (instancetype)stringsWithContentsOfSerializedFile:(NSString *)path;
+ (instancetype)stringsWithDataDictionary:(NSDictionary *)dictionary;
+ (instancetype)stringsWithDataDictionaryFromFile:(NSString *)path;
+ (instancetype)stringsWithStream:(SCStream *)stream;
+ (instancetype)stringsWithFileStream:(NSString *)path;
+ (instancetype)stringsWithData:(NSData *)data;
+ (instancetype)stringsWithContentsOfFile:(NSString *)path;
+ (instancetype)stringsWithContentsOfURL:(NSURL *)url;
+ (instancetype)stringsWithContentsOfURLString:(NSString *)urlString;

+ (instancetype)stringsWithName:(NSString *)name;
+ (instancetype)stringsWithString:(NSString *)string;
+ (instancetype)stringsWithCollection:(id<SCCollection>)collection;
+ (instancetype)stringsWithArray:(SCArray *)array;
+ (instancetype)stringsWithStrings:(SCStrings *)strings;
+ (instancetype)strings;

#pragma mark -
#pragma mark Initializing Strings Lists
- (instancetype)initWithName:(NSString *)name;
- (instancetype)initWithString:(NSString *)string;
- (instancetype)initWithCollection:(id<SCCollection>)collection;
- (instancetype)initWithArray:(SCArray *)array;
- (instancetype)initWithStrings:(SCStrings *)strings;
- (instancetype)init;

#pragma mark -
#pragma mark Copying Strings Lists
- (void)setStrings:(SCStrings *)strings;
- (void)setCollection:(id<SCCollection>)collection;
- (void)setString:(NSString *)string;

#pragma mark -
#pragma mark Comparing Strings Lists
- (BOOL)isEqualToStrings:(SCStrings *)strings;
- (BOOL)isEqualToCollection:(id<SCCollection>)collection;
- (BOOL)isEqualTo:(id)object;
- (BOOL)isEqual:(id)object;

#pragma mark -
#pragma mark Deriving New Strings Lists
- (instancetype)stringsByAddingString:(NSString *)string;
- (instancetype)stringsByAddingCollection:(id<SCCollection>)collection;
- (instancetype)stringsByAddingStrings:(SCStrings *)strings;
- (instancetype)stringsByAddingStringsFromArray:(SCArray *)array;
- (instancetype)stringsByAddingArray:(SCArray *)array;

#pragma mark -
#pragma mark Strings Enumerators
- (void)enumerateWithDelegate:(id<SCTextDelegate>)delegate;
- (void)enumerate;
- (void)reverseEnumerateWithDelegate:(id<SCTextDelegate>)delegate;
- (void)reverseEnumerate;
- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state objects:(id *)buffer count:(NSUInteger)count;

#pragma mark -
#pragma mark Sorting Strings Lists
- (void)sortAscendingWithSorter:(id<SCSorter>)sorter;
- (void)sortDescendingWithSorter:(id<SCSorter>)sorter;
- (void)sortWithSorter:(id<SCSorter>)sorter;
- (void)sortAscending;
- (void)sortDescending;
- (void)sort;
- (SCStrings *)ascendingSortedStringsWithSorter:(id<SCSorter>)sorter;
- (SCStrings *)descendingSortedStringsWithSorter:(id<SCSorter>)sorter;
- (SCStrings *)sortedStringsWithSorter:(id<SCSorter>)sorter;

#pragma mark -
#pragma mark Adding Strings
- (void)addString:(NSString *)string;
- (void)addCollection:(id<SCCollection>)collection;
- (void)addStrings:(SCStrings *)strings;
- (void)addLine;
- (void)addStringsFromArray:(SCArray *)array;
- (void)addArray:(SCArray *)array;

- (void)insertString:(NSString *)string atIndex:(SCIndex)index;
- (void)insertStrings:(SCStrings *)strings atIndex:(SCIndex)index;
- (void)insertCollection:(id<SCCollection>)collection atIndex:(SCIndex)index;
- (void)insertStrings:(SCStrings *)strings atIndexes:(NSIndexSet *)indexes;
- (void)insertCollection:(id<SCCollection>)collection 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)removeString:(NSString *)string;
- (void)removeStrings:(SCStrings *)strings;
- (void)removeCollection:(id<SCCollection>)collection;
- (void)removeStringsWithSubstring:(NSString *)substring;
- (void)removeStringsNotAtIndexes:(NSIndexSet *)indexes;
- (void)removeStringsNotEqualTo:(NSString *)string;
- (void)removeStringsNotInStrings:(SCStrings *)strings;
- (void)removeStringsNotInCollection:(id<SCCollection>)collection;
- (void)removeStringsWithoutSubstring:(NSString *)substring;
- (void)removeDuplicatedStrings;

#pragma mark -
#pragma mark Replacing Strings
- (void)replaceStringAtIndex:(SCIndex)index withString:(NSString *)string;
- (void)replaceStringsAtIndexes:(NSIndexSet *)indexes withStrings:(SCStrings *)strings;
- (void)replaceStringsAtIndexes:(NSIndexSet *)indexes withCollection:(id<SCCollection>)collection;
- (void)replaceString:(NSString *)string withString:(NSString *)newString;
- (void)setObject:(NSString *)object atIndexedSubscript:(SCIndex)index;

#pragma mark -
#pragma mark Copying and Moving 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:(SCIndex)steps;
- (void)forwardMoveStringAtIndex:(SCIndex)index;
- (void)backwardMoveStringAtIndex:(SCIndex)index steps:(SCIndex)steps;
- (void)backwardMoveStringAtIndex:(SCIndex)index;
- (void)moveToFirstPositionStringAtIndex:(SCIndex)index;
- (void)moveToLastPositionStringAtIndex:(SCIndex)index;
- (void)reverse;

#pragma mark -
#pragma mark Querying a Strings List
- (NSString *)stringAtIndex:(SCIndex)index;
- (SCStrings *)stringsAtIndexes:(NSIndexSet *)indexes;
- (id)objectAtIndexedSubscript:(SCIndex)index;

#pragma mark -
#pragma mark Finding Strings in a Strings List
- (BOOL)containsString:(NSString *)string;
- (BOOL)containsStrings:(SCStrings *)strings;
- (BOOL)containsCollection:(id<SCCollection>)collection;
- (BOOL)containsAnyString:(SCStrings *)strings;
- (BOOL)containsAnyStringFromCollection:(id<SCCollection>)collection;
- (BOOL)containsSubstring:(NSString *)substring;
- (BOOL)containsSubstrings:(SCStrings *)substrings;
- (BOOL)containsSubstringsFromCollection:(id<SCCollection>)collection;
- (BOOL)containsAnySubstring:(SCStrings *)substrings;
- (BOOL)containsAnySubstringFromCollection:(id<SCCollection>)collection;
- (BOOL)containsDuplicatedStrings;

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

- (SCStrings *)stringsWithSubstring:(NSString *)substring;
- (SCStrings *)stringsWithSubstrings:(SCStrings *)substrings;
- (SCStrings *)stringsWithSubstringsFromCollection:(id<SCCollection>)collection;
- (SCStrings *)stringsWithAnySubstring:(SCStrings *)substrings;
- (SCStrings *)stringsWithAnySubstringFromCollection:(id<SCCollection>)collection;
- (SCStrings *)stringsWithoutSubstring:(NSString *)substring;
- (SCStrings *)stringsWithoutSubstrings:(SCStrings *)substrings;
- (SCStrings *)stringsWithoutSubstringsFromCollection:(id<SCCollection>)collection;

- (SCULong)countOfString:(NSString *)string;
- (SCULong)countOfSubstring:(NSString *)substring;
- (SCULong)countOfStringsWithSubstring:(NSString *)substring;

@end