SCTextFile.h

Go to the documentation of this file.

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

#import <scl/SCText.h>
#import <scl/SCStream.h>

#define SCTextFileClass           @"SCTextFile"         ///< SCTextFile class name

@interface SCTextFile : SCText {
        NSString *fPath;                // Text file path
}
#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// File path property
@property (retain, readonly, getter=path) NSString *path;

#endif

#pragma mark -
#pragma mark Creating Text File

+ (SCTextFile *)textFileWithDataDictionary:(NSDictionary *)dictionary;

+ (SCTextFile *)textFileWithDataDictionaryFromFile:(NSString *)path;

+ (SCTextFile *)textFileWithCoder:(NSCoder *)coder;

+ (SCTextFile *)textFileWithContentsOfSerializedFile:(NSString *)path;

+ (SCTextFile *)textFileWithStream:(SCStream *)stream;

+ (SCTextFile *)textFileWithFileStream:(NSString *)path;

+ (SCTextFile *)textFileWithName:(NSString *)name
                                                capacity:(SCULong)capacity
                                                delegate:(id<SCTextDelegate>)delegate;

+ (SCTextFile *)textFileWithName:(NSString *)name capacity:(SCULong)capacity;

+ (SCTextFile *)textFileWithName:(NSString *)name delegate:(id<SCTextDelegate>)delegate;

+ (SCTextFile *)textFileWithName:(NSString *)name;

+ (SCTextFile *)textFileWithDelegate:(id<SCTextDelegate>)delegate;

+ (SCTextFile *)textFileWithCapacity:(SCULong)capacity;

+ (SCTextFile *)textFileWithName:(NSString *)name
                                                  stream:(SCStream *)stream
                                                delegate:(id<SCTextDelegate>)delegate;

+ (SCTextFile *)textFileWithName:(NSString *)name stream:(SCStream *)stream;

+ (SCTextFile *)textFileFromStream:(SCStream *)stream delegate:(id<SCTextDelegate>)delegate;

+ (SCTextFile *)textFileFromStream:(SCStream *)stream;

+ (SCTextFile *)textFileWithName:(NSString *)name
                                                        path:(NSString *)path
                                                delegate:(id<SCTextDelegate>)delegate;

+ (SCTextFile *)textFileWithName:(NSString *)name path:(NSString *)path;

+ (SCTextFile *)textFileWithPath:(NSString *)path delegate:(id<SCTextDelegate>)delegate;

+ (SCTextFile *)textFileWithPath:(NSString *)path;

+ (SCTextFile *)textFileWithString:(NSString *)string;

+ (SCTextFile *)textFileWithStrings:(NSString *)string, ...;

+ (SCTextFile *)textFileWithCollection:(id)collection;

+ (SCTextFile *)textFileWithText:(SCText *)text;

+ (SCTextFile *)textFileWithTextFile:(SCTextFile *)file;

+ (SCTextFile *)textFile;

#pragma mark -
#pragma mark Initializing Text File

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

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

- (id)initFromStream:(SCStream *)stream delegate:(id<SCTextDelegate>)delegate;

- (id)initFromStream:(SCStream *)stream;

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

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

- (id)initWithPath:(NSString *)path delegate:(id<SCTextDelegate>)delegate;

- (id)initWithPath:(NSString *)path;

- (id)initWithTextFile:(SCTextFile *)file;

#pragma mark -
#pragma mark Setting and Copying Text Files

- (void)copyFromTextFile:(SCTextFile *)file;

#pragma mark -
#pragma mark Getting Text File Properties

- (NSString *)path;

#pragma mark -
#pragma mark Converting Text File

- (SCText *)text;

#pragma mark -
#pragma mark Reading and Writing Text File

- (BOOL)load;

- (BOOL)loadFromStream:(SCStream *)stream;

- (BOOL)loadWithPath:(NSString *)path;

- (BOOL)save;

- (BOOL)saveToStream:(SCStream *)stream;

- (BOOL)saveWithPath:(NSString *)path;

- (BOOL)reset;

- (BOOL)appendToFileWithPath:(NSString *)path;

- (BOOL)addTextFromStream:(SCStream *)stream;

- (BOOL)addTextWithPath:(NSString *)path;

#pragma mark -
#pragma mark Reading and Writing Text Blocks

- (BOOL)insertTextFromStream:(SCStream *)stream atIndex:(SCIndex)index;

- (BOOL)insertTextWithPath:(NSString *)path atIndex:(SCIndex)index;

- (BOOL)replaceTextInRange:(NSRange)range withTextFromStream:(SCStream *)stream;

- (BOOL)replaceTextInRange:(NSRange)range withTextWithPath:(NSString *)path;

- (BOOL)saveTextInRange:(NSRange)range toStream:(SCStream *)stream;

- (BOOL)saveTextInRange:(NSRange)range withPath:(NSString *)path;

- (BOOL)appendTextInRange:(NSRange)range withPath:(NSString *)path;

- (BOOL)cutTextInRange:(NSRange)range toStream:(SCStream *)stream;

- (BOOL)cutTextInRange:(NSRange)range withPath:(NSString *)path;

- (BOOL)cutAndAppendTextInRange:(NSRange)range withPath:(NSString *)path;

- (BOOL)saveTextWithSubstring:(NSString *)substring
                                         toStream:(SCStream *)stream
                          caseInsensitive:(BOOL)value;

- (BOOL)saveTextWithSubstring:(NSString *)substring toStream:(SCStream *)stream;

- (BOOL)saveTextWithSubstring:(NSString *)substring
                                         withPath:(NSString *)path
                          caseInsensitive:(BOOL)value;

- (BOOL)saveTextWithSubstring:(NSString *)substring withPath:(NSString *)path;

- (BOOL)saveTextWithoutSubstring:(NSString *)substring
                                                toStream:(SCStream *)stream 
                                 caseInsensitive:(BOOL)value;

- (BOOL)saveTextWithoutSubstring:(NSString *)substring toStream:(SCStream *)stream;

- (BOOL)saveTextWithoutSubstring:(NSString *)substring
                                                withPath:(NSString *)path
                                 caseInsensitive:(BOOL)value;

- (BOOL)saveTextWithoutSubstring:(NSString *)substring withPath:(NSString *)path;

@end