NSString+SCString.h

Go to the documentation of this file.

//
//  NSString+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/NSObject+SCObject.h>
#import <scl/SCArray.h>

#pragma mark -
#pragma mark Boolean Constants

#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 String Constants

#define SC_STR_EMPTY   @""

#define SC_STR_SPACE   @" "

#define SC_STR_TAB     @"\t"

#pragma mark Digital String Constants

#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 Character Constants

#define SC_CHR_SPACE ' '

#define SC_CHR_TAB   '\t'

#pragma mark Digital Character Constants

#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 Format Constants

#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 Class Constants

#define NSStringClass @"NSString"


#pragma mark -

@interface NSString(SCString)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#pragma mark -
#pragma mark Creating Strings
+ (instancetype)stringWithCoder:(NSCoder *)coder;
+ (instancetype)stringWithContentsOfSerializedFile:(NSString *)path;
+ (instancetype)stringWithDataDictionary:(NSDictionary *)dictionary;
+ (instancetype)stringWithDataDictionaryFromFile:(NSString *)path;
+ (instancetype)stringWithStream:(SCStream *)stream;
+ (instancetype)stringWithFileStream:(NSString *)path;
+ (instancetype)stringWithData:(NSData *)data;
+ (instancetype)stringWithContentsOfFile:(NSString *)path;
+ (instancetype)stringWithContentsOfURL:(NSURL *)url;
+ (instancetype)stringWithContentsOfURLString:(NSString *)urlString;

+ (instancetype)stringWithIndexSet:(NSIndexSet *)indexSet;
+ (instancetype)stringWithCharacter:(unichar)character;
+ (instancetype)stringWithCharacter:(unichar)character length:(SCIndex)length;
+ (instancetype)stringWithLength:(SCUInteger)length;
+ (instancetype)stringWithPointer:(void *)pointer;
+ (instancetype)stringWithID:(id)object;

#pragma mark -
#pragma mark Initializing Strings
- (instancetype)initWithIndexSet:(NSIndexSet *)indexSet;
- (instancetype)initWithCharacter:(unichar)character;
- (instancetype)initWithCharacter:(unichar)character length:(SCIndex)length;
- (instancetype)initWithLength:(SCUInteger)length;
- (instancetype)initWithPointer:(void *)pointer;
- (instancetype)initWithID:(id)object;

#pragma mark -
#pragma mark Dividing Strings and Replacing Substrings
- (NSString *)ltrim;
- (NSString *)rtrim;
- (NSString *)trim;
- (NSString *)stringWithLeftCharacters:(SCIndex)characters;
- (NSString *)stringWithRightCharacters:(SCIndex)characters;
- (NSString *)skipLeftPart:(SCIndex)characters;
- (NSString *)skipRightPart:(SCIndex)characters;

- (BOOL)isCorrectRange:(NSRange)range;
- (BOOL)existsSubstring:(NSString *)substring caseInsensitive:(BOOL)caseInsensitive;
- (BOOL)existsSubstring:(NSString *)substring;
- (SCIndex)countOfSubstring:(NSString *)substring caseInsensitive:(BOOL)caseInsensitive;
- (SCIndex)countOfSubstring:(NSString *)substring;
- (SCIndex)indexOfSubstring:(NSString *)substring caseInsensitive:(BOOL)caseInsensitive;
- (SCIndex)indexOfSubstring:(NSString *)substring;
- (SCArray *)indexesOfSubstring:(NSString *)substring caseInsensitive:(BOOL)caseInsensitive;
- (SCArray *)indexesOfSubstring:(NSString *)substring;

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

- (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 String Words
- (NSString *)word:(SCIndex)word;

#pragma mark -
#pragma mark Comparing Strings
- (BOOL)isEqualToStrings:(NSString *)string, ... NS_REQUIRES_NIL_TERMINATION;

#pragma mark -
#pragma mark РExpanding Strings
- (NSString *)leftExpandedStringToLength:(SCIndex)length character:(unichar)character;
- (NSString *)leftExpandedStringToLength:(SCIndex)length;
- (NSString *)leftZeroExpandedStringToLength:(SCIndex)length;
- (NSString *)rightExpandedStringToLength:(SCIndex)length character:(unichar)character;
- (NSString *)rightExpandedStringToLength:(SCIndex)length;

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

- (instancetype)initWithLeftExpandedString:(NSString *)string length:(SCIndex)length character:(unichar)character;
- (instancetype)initWithLeftExpandedString:(NSString *)string length:(SCIndex)length;
- (instancetype)initWithLeftZeroExpandedString:(NSString *)string length:(SCIndex)length;
- (instancetype)initWithRightExpandedString:(NSString *)string length:(SCIndex)length character:(unichar)character;
- (instancetype)initWithRightExpandedString:(NSString *)string length:(SCIndex)length;

#pragma mark -
#pragma mark Adding Delimiters
- (NSString *)stringWithSeparator:(NSString *)separator left:(SCIndex)left;
- (NSString *)stringWithSpacesLeft:(SCIndex)left;
- (NSString *)stringWithSeparator:(NSString *)separator right:(SCIndex)right;
- (NSString *)stringWithSpacesRight:(SCIndex)right;

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

- (instancetype)initWithString:(NSString *)string separator:(NSString *)separator left:(SCIndex)left;
- (instancetype)initWithString:(NSString *)string spacesLeft:(SCIndex)left;
- (instancetype)initWithString:(NSString *)string separator:(NSString *)separator right:(SCIndex)right;
- (instancetype)initWithString:(NSString *)string spacesRight:(SCIndex)right;

#pragma mark -
#pragma mark Data Types Representation
+ (instancetype)stringWithBinaryInteger:(SCULong)integer capacity:(SCCapacity)capacity;
+ (instancetype)stringWithBinaryInteger:(SCULong)integer;
+ (instancetype)stringWithOctalInteger:(SCULong)integer;
+ (instancetype)stringWithDecimalInteger:(SCLong)integer separators:(BOOL)separators;
+ (instancetype)stringWithDecimalInteger:(SCLong)integer;
+ (instancetype)stringWithInteger:(SCLong)integer;
+ (instancetype)stringWithHexadecimalInteger:(SCULong)integer capacity:(SCCapacity)capacity;
+ (instancetype)stringWithHexadecimalInteger:(SCULong)integer;
+ (instancetype)stringWithBool:(BOOL)boolean;
+ (instancetype)stringWithFloat:(SCFloat)value;
+ (instancetype)stringWithDouble:(SCDouble)value;

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

#pragma mark -
#pragma mark Reversing Strings
+ (instancetype)stringWithReversedString:(NSString *)string;
- (instancetype)initWithReversedString:(NSString *)string;

#pragma mark -
#pragma mark Special Overrided Methods
- (instancetype)initWithContentsOfFile:(NSString *)path;
- (instancetype)initWithContentsOfURL:(NSURL *)url;

@end