SCString.h

Go to the documentation of this file.

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

#import <Foundation/Foundation.h>
#import <scl/SCTypes.h>
#import <scl/SCCoding.h>
#import <scl/SCDictionaring.h>
#import <scl/SCStreaming.h>
#import <scl/SCCollectioning.h>
#import <scl/SCArray.h>

#pragma mark -
#pragma mark Логические константы

#define SC_BOOL_YES         @"YES"

#define SC_BOOL_NO          @"NO"

#define SC_BOOL_TRUE        @"TRUE"

#define SC_BOOL_FALSE       @"FALSE"

#define SC_BOOL_ON          @"ON"

#define SC_BOOL_OFF         @"OFF"

#define SC_BOOL_RU_YES      @"ДА"

#define SC_BOOL_RU_NO       @"НЕТ"

#define SC_BOOL_RU_TRUE     @"ИСТИНА"

#define SC_BOOL_RU_FALSE    @"ЛОЖЬ"

#define SC_BOOL_RU_ON       @"ВКЛ"

#define SC_BOOL_RU_OFF      @"ВЫКЛ"

#pragma mark -
#pragma mark Строковые константы

#define SC_STR_EMPTY   @""

#define SC_STR_SPACE   @" "

#pragma mark Константы строковых символов

#define SC_STR_ZERO     @"0"

#define SC_STR_ONE      @"1"

#define SC_STR_TWO      @"2"

#define SC_STR_THREE    @"3"

#define SC_STR_FOUR     @"4"

#define SC_STR_FIVE     @"5"

#define SC_STR_SIX      @"6"

#define SC_STR_SEVEN    @"7"

#define SC_STR_EIGHT    @"8"

#define SC_STR_NINE     @"9"

#pragma mark -
#pragma mark Символьные константы

#define SC_CHR_SPACE ' '

#define SC_CHR_TAB   '\t'

#pragma mark Константы цифровых символов

#define SC_CHR_ZERO     '0'

#define SC_CHR_ONE      '1'

#define SC_CHR_TWO      '2'

#define SC_CHR_THREE    '3'

#define SC_CHR_FOUR     '4'

#define SC_CHR_FIVE     '5'

#define SC_CHR_SIX      '6'

#define SC_CHR_SEVEN    '7'

#define SC_CHR_EIGHT    '8'

#define SC_CHR_NINE     '9'

#define SC_CHR_DOT      '.'

#define SC_CHR_COMMA    ','

#define SC_CHR_PLUS     '+'

#define SC_CHR_MINUS    '-'

#pragma mark -
#pragma mark Константы различных форматов

#define SC_FMT_OCTAL    @"%qo"

#define SC_FMT_UDECIMAL @"%qu"

#define SC_FMT_SDECIMAL @"%qd"

#define SC_FMT_HEX      @"%qX"

#define SC_FMT_FLOAT    @"%f"

#define SC_FMT_DOUBLE   @"%f"

#define SC_FMT_POINTER  @"%p"

#define SC_FMT_OBJECT   @"%@"

#pragma mark -
#pragma mark Константы класса

#define NSStringClass @"NSString"

#pragma mark -

@interface NSString(SCString) <SCCoding, SCDictionaring, SCStreaming, SCCollectioning>

@property (nonatomic, retain, readonly, getter=normalizedString) NSString *normalizedString;

@property (nonatomic, assign, readonly, getter=wordsCount) SCUInteger wordsCount;

@property (nonatomic, retain, readonly, getter=firstWord) NSString *firstWord;

@property (nonatomic, retain, readonly, getter=lastWord) NSString *lastWord;

@property (nonatomic, retain, readonly, getter=endOfString) NSString *endOfString;

@property (nonatomic, assign, readonly, getter=binaryValue) SCULong binaryValue;

@property (nonatomic, assign, readonly, getter=octalValue) SCULong octalValue;

@property (nonatomic, assign, readonly, getter=decimalValue) SCULong decimalValue;

@property (nonatomic, assign, readonly, getter=hexadecimalValue) SCULong hexadecimalValue;

@property (nonatomic, assign, readonly, getter=booleanValue) BOOL booleanValue;

@property (nonatomic, retain, readonly, getter=reversedString) NSString *reversedString;

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

#pragma mark -
#pragma mark Создание строк
+ (NSString *)stringWithIndexSet:(NSIndexSet *)indexSet;
+ (NSString *)stringWithCharacter:(unichar)character;
+ (NSString *)stringWithCharacter:(unichar)character length:(SCUInteger)length;
+ (NSString *)stringWithLength:(SCUInteger)length;
+ (NSString *)stringWithPointer:(void *)pointer;
+ (NSString *)stringWithID:(id)object;

#pragma mark -
#pragma mark Инициализация строк
- (id)initWithIndexSet:(NSIndexSet *)indexSet;
- (id)initWithCharacter:(unichar)character;
- (id)initWithCharacter:(unichar)character length:(SCUInteger)length;
- (id)initWithLength:(SCUInteger)length;
- (id)initWithPointer:(void *)pointer;
- (id)initWithID:(id)object;

#pragma mark -
#pragma mark Поддержка последовательных файлов
+ (NSString *)stringWithCoder:(NSCoder *)coder;
+ (NSString *)stringWithContentsOfSerializedFile:(NSString *)path;
- (id)initWithContentsOfSerializedFile:(NSString *)path;
- (BOOL)writeContentsToSerializedFile:(NSString *)path;

#pragma mark -
#pragma mark Поддержка словарей
+ (NSString *)stringWithDataDictionary:(NSDictionary *)dictionary;
+ (NSString *)stringWithDataDictionaryFromFile:(NSString *)path;
- (id)initWithDataDictionary:(NSDictionary *)dictionary;
- (id)initWithDataDictionaryFromFile:(NSString *)path;
- (void)writeToDataDictionary:(NSMutableDictionary *)dictionary;
- (void)writeToDataDictionaryFile:(NSString *)path atomically:(BOOL)atomically;
- (void)writeToDataDictionaryFile:(NSString *)path;
- (NSDictionary *)dataDictionary;

#pragma mark -
#pragma mark Поддержка потоков
+ (NSString *)stringWithStream:(SCStream *)stream;
+ (NSString *)stringWithFileStream:(NSString *)path;
- (id)initWithStream:(SCStream *)stream;
- (id)initWithFileStream:(NSString *)path;
- (void)writeToStream:(SCStream *)stream;
- (void)writeToFileStream:(NSString *)path;
- (void)appendToFileStream:(NSString *)path;

#pragma mark -
#pragma mark Поддержка коллекций
- (id<SCCollectioning>)copyObject;
- (SCComparisonResult)compareWithObject:(id<SCCollectioning>)object;

#pragma mark -
#pragma mark Разделение и замена строк и подстрок
- (NSString *)ltrim;
- (NSString *)rtrim;
- (NSString *)trim;

- (NSString *)stringWithLeftCharacters:(SCUInteger)characters;
- (NSString *)stringWithRightCharacters:(SCUInteger)characters;
- (NSString *)skipLeftPart:(SCUInteger)characters;
- (NSString *)skipRightPart:(SCUInteger)characters;

- (BOOL)isCorrectRange:(NSRange)range;
- (BOOL)existsSubstring:(NSString *)substring caseInsensitive:(BOOL)caseInsensitive;
- (BOOL)existsSubstring:(NSString *)substring;
- (SCUInteger)countOfSubstring:(NSString *)substring caseInsensitive:(BOOL)caseInsensitive;
- (SCUInteger)countOfSubstring:(NSString *)substring;

- (NSString *)stringWithDeletedSubstring:(NSString *)substring caseInsensitive:(BOOL)caseInsensitive;
- (NSString *)stringWithDeletedSubstring:(NSString *)substring;
- (NSString *)stringWithDeletedSubstringToIndex:(SCUInteger)index;
- (NSString *)stringWithDeletedSubstringToRange:(NSRange)range;
- (NSString *)stringWithDeletedSubstringFromIndex:(SCUInteger)index;
- (NSString *)stringWithDeletedSubstringWithRange:(NSRange)range;

- (SCUInteger)indexOfSubstring:(NSString *)substring caseInsensitive:(BOOL)caseInsensitive;
- (SCUInteger)indexOfSubstring:(NSString *)substring;
- (SCArray *)indexesOfSubstring:(NSString *)substring caseInsensitive:(BOOL)caseInsensitive;
- (SCArray *)indexesOfSubstring:(NSString *)substring;

- (NSString *)stringWithReplacedSubstringToIndex:(SCUInteger)index withString:(NSString *)string;
- (NSString *)stringWithReplacedSubstringFromIndex:(SCUInteger)index withString:(NSString *)string;
- (NSString *)stringWithReplacedSubstringWithRange:(NSRange)range withString:(NSString *)string;
- (NSString *)stringWithReplacedSubstring:(NSString *)substring
                               withString:(NSString *)string
                          caseInsensitive:(BOOL)caseInsensitive;
- (NSString *)stringWithReplacedSubstring:(NSString *)substring withString:(NSString *)string;

- (NSString *)stringWithInsertedString:(NSString *)string;
- (NSString *)stringWithInsertedString:(NSString *)string index:(SCUInteger)index;

#pragma mark -
#pragma mark Работа со словами в составе строк
- (NSString *)normalizedString;
- (SCUInteger)wordsCount;
- (NSString *)word:(SCUInteger)word;
- (NSString *)firstWord;
- (NSString *)lastWord;
- (NSString *)endOfString;

#pragma mark -
#pragma mark Сравнение строк
- (BOOL)isEqualToStrings:(NSString *)string, ... NS_REQUIRES_NIL_TERMINATION;

#pragma mark -
#pragma mark Расширение строк
- (NSString *)leftExpandedStringToLength:(SCUInteger)length character:(unichar)character;
- (NSString *)leftExpandedStringToLength:(SCUInteger)length;
- (NSString *)leftZeroExpandedStringToLength:(SCUInteger)length;
- (NSString *)rightExpandedStringToLength:(SCUInteger)length character:(unichar)character;
- (NSString *)rightExpandedStringToLength:(SCUInteger)length;

+ (NSString *)stringWithLeftExpandedString:(NSString *)string length:(SCUInteger)length character:(unichar)character;
+ (NSString *)stringWithLeftExpandedString:(NSString *)string length:(SCUInteger)length;
+ (NSString *)stringWithLeftZeroExpandedString:(NSString *)string length:(SCUInteger)length;
+ (NSString *)stringWithRightExpandedString:(NSString *)string length:(SCUInteger)length character:(unichar)character;
+ (NSString *)stringWithRightExpandedString:(NSString *)string length:(SCUInteger)length;

- (id)initWithLeftExpandedString:(NSString *)string length:(SCUInteger)length character:(unichar)character;
- (id)initWithLeftExpandedString:(NSString *)string length:(SCUInteger)length;
- (id)initWithLeftZeroExpandedString:(NSString *)string length:(SCUInteger)length;
- (id)initWithRightExpandedString:(NSString *)string length:(SCUInteger)length character:(unichar)character;
- (id)initWithRightExpandedString:(NSString *)string length:(SCUInteger)length;

#pragma mark -
#pragma mark Добавление разделителей групп символов
- (NSString *)stringWithSeparator:(NSString *)separator left:(SCUInteger)left;
- (NSString *)stringWithSpacesLeft:(SCUInteger)left;
- (NSString *)stringWithSeparator:(NSString *)separator right:(SCUInteger)right;
- (NSString *)stringWithSpacesRight:(SCUInteger)right;

+ (NSString *)stringWithString:(NSString *)string separator:(NSString *)separator left:(SCUInteger)left;
+ (NSString *)stringWithString:(NSString *)string spacesLeft:(SCUInteger)left;
+ (NSString *)stringWithString:(NSString *)string separator:(NSString *)separator right:(SCUInteger)right;
+ (NSString *)stringWithString:(NSString *)string spacesRight:(SCUInteger)right;

- (id)initWithString:(NSString *)string separator:(NSString *)separator left:(SCUInteger)left;
- (id)initWithString:(NSString *)string spacesLeft:(SCUInteger)left;
- (id)initWithString:(NSString *)string separator:(NSString *)separator right:(SCUInteger)right;
- (id)initWithString:(NSString *)string spacesRight:(SCUInteger)right;

#pragma mark -
#pragma mark Работа с текстовыми представлениями различных типов
- (BOOL)isBinaryString;
- (BOOL)isOctalString;
- (BOOL)isDecimalString;
- (BOOL)isHexadecimalString;
- (BOOL)isBooleanString;
- (BOOL)isFloatString;
- (BOOL)isDoubleString;

- (SCULong)binaryValue;
- (SCULong)octalValue;
- (SCULong)decimalValue;
- (SCULong)hexadecimalValue;
- (BOOL)booleanValue;

+ (NSString *)stringWithBinaryInteger:(SCULong)integer capacity:(SCCapacity)capacity;
+ (NSString *)stringWithBinaryInteger:(SCULong)integer;
+ (NSString *)stringWithOctalInteger:(SCULong)integer;
+ (NSString *)stringWithDecimalInteger:(SCLong)integer separators:(BOOL)separators;
+ (NSString *)stringWithDecimalInteger:(SCLong)integer;
+ (NSString *)stringWithInteger:(SCLong)integer;
+ (NSString *)stringWithHexadecimalInteger:(SCULong)integer capacity:(SCCapacity)capacity;
+ (NSString *)stringWithHexadecimalInteger:(SCULong)integer;
+ (NSString *)stringWithBool:(BOOL)boolean;
+ (NSString *)stringWithFloat:(SCFloat)value;
+ (NSString *)stringWithDouble:(SCDouble)value;

- (id)initWithBinaryInteger:(SCULong)integer capacity:(SCCapacity)capacity;
- (id)initWithBinaryInteger:(SCULong)integer;
- (id)initWithOctalInteger:(SCULong)integer;
- (id)initWithDecimalInteger:(SCLong)integer separators:(BOOL)separators;
- (id)initWithDecimalInteger:(SCLong)integer;
- (id)initWithInteger:(SCLong)integer;
- (id)initWithHexadecimalInteger:(SCULong)integer capacity:(SCCapacity)capacity;
- (id)initWithHexadecimalInteger:(SCULong)integer;
- (id)initWithBool:(BOOL)boolean;
- (id)initWithFloat:(SCFloat)value;
- (id)initWithDouble:(SCDouble)value;

#pragma mark -
#pragma mark Переворачивание строк
- (NSString *)reversedString;
+ (NSString *)stringWithReversedString:(NSString *)string;
- (id)initWithReversedString:(NSString *)string;

#pragma mark -
#pragma mark Другие методы
- (BOOL)empty;
- (NSString *)stringWithUpperFirstLetter;

@end