SCText.h

Go to the documentation of this file.

//
//  SCText.h
//  scl
//
//  Created by Viacheslav Smolensky on 06.02.13.
//  Copyright (c) 2007 - 2017 by Samond Development Corporation. All rights reserved.
//

#import <scl/SCStrings.h>
#import <scl/SCUniqueStrings.h>
#import <scl/SCTextIndex.h>

#pragma mark -
#pragma mark Class Contants

#define SCTextClass @"SCText"


@interface SCText : SCStrings

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

@property (nonatomic, readonly, assign) SCUniqueStrings *uniqueStrings;

#pragma mark -
#pragma mark Creating Texts
+ (instancetype)textWithCoder:(NSCoder *)coder;
+ (instancetype)textWithContentsOfSerializedFile:(NSString *)path;
+ (instancetype)textWithDataDictionary:(NSDictionary *)dictionary;
+ (instancetype)textWithDataDictionaryFromFile:(NSString *)path;
+ (instancetype)textWithStream:(SCStream *)stream;
+ (instancetype)textWithFileStream:(NSString *)path;
+ (instancetype)textWithData:(NSData *)data;
+ (instancetype)textWithContentsOfFile:(NSString *)path;
+ (instancetype)textWithContentsOfURL:(NSURL *)url;
+ (instancetype)textWithContentsOfURLString:(NSString *)urlString;

+ (instancetype)textWithName:(NSString *)name;
+ (instancetype)textWithString:(NSString *)string;
+ (instancetype)textWithStrings:(SCStrings *)strings;
+ (instancetype)textWithCollection:(id<SCCollection>)collection;
+ (instancetype)textWithArray:(SCArray *)array;
+ (instancetype)textWithText:(SCText *)text;
+ (instancetype)text;

#pragma mark -
#pragma mark Initializing Texts
- (instancetype)initWithText:(SCText *)text;

#pragma mark -
#pragma mark Copying Texts
- (void)setText:(SCText *)text;

#pragma mark -
#pragma mark Comparing Texts
- (BOOL)isEqualToText:(SCText *)text;

#pragma mark -
#pragma mark Deriving New Texts
- (instancetype)textByAddingString:(NSString *)string;
- (instancetype)textByAddingCollection:(id<SCCollection>)collection;
- (instancetype)textByAddingStringsFromArray:(SCArray *)array;
- (instancetype)textByAddingArray:(SCArray *)array;
- (instancetype)textByAddingStrings:(SCStrings *)strings;
- (instancetype)textByAddingText:(SCText *)text;

#pragma mark -
#pragma mark Adding Text
- (void)addText:(SCStrings *)text;
- (void)insertText:(SCStrings *)text atIndex:(SCIndex)index;

#pragma mark -
#pragma mark Removing Text
- (void)removeAllText;
- (void)removeTextInRange:(NSRange)range;
- (void)removeTextWithSubstring:(NSString *)substring;
- (void)removeTextWithoutSubstring:(NSString *)substring;
- (void)removeSubstring:(NSString *)substring;
- (SCText *)cutTextInRange:(NSRange)range;
- (void)removeText:(SCStrings *)text;

#pragma mark -
#pragma mark Replacing Text
- (void)replaceTextInRange:(NSRange)range withText:(SCStrings *)text;
- (void)replaceTextInRange:(NSRange)range withCollection:(id<SCCollection>)collection;
- (void)replaceText:(SCStrings *)oldText withText:(SCStrings *)newText;

#pragma mark -
#pragma mark Copying and Moving Text
- (void)exchangeTextInRange:(NSRange)source withTextInRange:(NSRange)destination;
- (void)duplicateTextInRange:(NSRange)range;
- (void)duplicateStringsInRange:(NSRange)range;
- (void)copyTextInRange:(NSRange)range toIndex:(SCIndex)destination;
- (void)moveTextInRange:(NSRange)range toIndex:(SCIndex)destination;
- (void)forwardMoveTextInRange:(NSRange)range steps:(SCIndex)steps;
- (void)forwardMoveTextInRange:(NSRange)range;
- (void)backwardMoveTextInRange:(NSRange)range steps:(SCIndex)steps;
- (void)backwardMoveTextInRange:(NSRange)range;
- (void)moveToFirstPositionTextInRange:(NSRange)range;
- (void)moveToLastPositionTextInRange:(NSRange)range;

#pragma mark -
#pragma mark Querying a Text
- (SCText *)textInRange:(NSRange)range;

#pragma mark -
#pragma mark Finding and Selecting Text
- (BOOL)containsText:(SCStrings *)text;
- (NSRange)rangeOfText:(SCStrings *)text;
- (NSRange)rangeOfCollection:(id<SCCollection>)collection;
- (SCIndex)indexOfText:(SCStrings *)text;
- (SCIndex)indexOfCollection:(id<SCCollection>)collection;
- (SCUInteger)countOfText:(SCStrings *)text;
- (SCUInteger)countOfCollection:(id<SCCollection>)collection;
- (SCArray *)indexesOfText:(SCStrings *)text;
- (SCArray *)indexesOfCollection:(id<SCCollection>)collection;
- (SCText *)textWithSubstring:(NSString *)substring;
- (SCText *)textWithoutSubstring:(NSString *)substring;
- (SCTextIndex *)textIndexOfSubstring:(NSString *)substring;
- (SCArray *)textIndexesOfSubstring:(NSString *)substring;

@end