SCTextFile.h

Go to the documentation of this file.

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

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

#pragma mark -
#pragma mark Class Constants

#define SCTextFileClass @"SCTextFile"


@interface SCTextFile : SCText {
    NSString    *_path; // Text file path
}
#pragma mark -
#pragma mark Instance Properties

@property (nonatomic, readonly, retain) NSString *path;

@property (nonatomic, readonly, assign) SCText *text;

#pragma mark -
#pragma mark Creating Text Files
+ (instancetype)textFileWithCoder:(NSCoder *)coder;
+ (instancetype)textFileWithContentsOfSerializedFile:(NSString *)path;
+ (instancetype)textFileWithDataDictionary:(NSDictionary *)dictionary;
+ (instancetype)textFileWithDataDictionaryFromFile:(NSString *)path;
+ (instancetype)textFileWithStream:(SCStream *)stream;
+ (instancetype)textFileWithFileStream:(NSString *)path;
+ (instancetype)textFileWithData:(NSData *)data;
+ (instancetype)textFileWithContentsOfFile:(NSString *)path;
+ (instancetype)textFileWithContentsOfURL:(NSURL *)url;
+ (instancetype)textFileWithContentsOfURLString:(NSString *)urlString;

+ (instancetype)textFileWithName:(NSString *)name;
+ (instancetype)textFileWithString:(NSString *)string;
+ (instancetype)textFileWithStrings:(SCStrings *)strings;
+ (instancetype)textFileWithCollection:(id<SCCollection>)collection;
+ (instancetype)textFileWithArray:(SCArray *)array;
+ (instancetype)textFileWithText:(SCText *)text;
+ (instancetype)textFileWithTextFile:(SCTextFile *)textFile;
+ (instancetype)textFileWithName:(NSString *)name stream:(SCStream *)stream;
+ (instancetype)textFileFromStream:(SCStream *)stream;
+ (instancetype)textFileWithName:(NSString *)name path:(NSString *)path;
+ (instancetype)textFileWithPath:(NSString *)path;
+ (instancetype)textFile;

#pragma mark -
#pragma mark Initializing Text Files
- (instancetype)initWithTextFile:(SCTextFile *)textFile;
- (instancetype)initWithName:(NSString *)name stream:(SCStream *)stream;
- (instancetype)initFromStream:(SCStream *)stream;
- (instancetype)initWithName:(NSString *)name path:(NSString *)path;
- (instancetype)initWithPath:(NSString *)path;

#pragma mark -
#pragma mark Copying Text Files
- (void)setTextFile:(SCTextFile *)textFile;

#pragma mark -
#pragma mark Deriving New Text Files
- (instancetype)textFileByAddingString:(NSString *)string;
- (instancetype)textFileByAddingCollection:(id<SCCollection>)collection;
- (instancetype)textFileByAddingStringsFromArray:(SCArray *)array;
- (instancetype)textFileByAddingArray:(SCArray *)array;
- (instancetype)textFileByAddingStrings:(SCStrings *)strings;
- (instancetype)textFileByAddingText:(SCText *)text;
- (instancetype)textFileByAddingTextFile:(SCTextFile *)textFile;
- (instancetype)textFileByAddingTextFileWithPath:(NSString *)path;

#pragma mark -
#pragma mark Reading and Writing Text Files
- (BOOL)read;
- (BOOL)readFromStream:(SCStream *)stream;
- (BOOL)readWithPath:(NSString *)path;
- (BOOL)write;
- (BOOL)writeTextToStream:(SCStream *)stream;
- (BOOL)writeWithPath:(NSString *)path;
- (BOOL)reset;
- (BOOL)appendToFileWithPath:(NSString *)path;

#pragma mark -
#pragma mark Reading and Writing Texts
- (BOOL)addTextFromStream:(SCStream *)stream;
- (BOOL)addTextWithPath:(NSString *)path;
- (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)replaceText:(SCStrings *)text withTextFromStream:(SCStream *)stream;
- (BOOL)replaceText:(SCStrings *)text withTextWithPath:(NSString *)path;

- (BOOL)writeTextInRange:(NSRange)range toStream:(SCStream *)stream;
- (BOOL)writeTextInRange:(NSRange)range withPath:(NSString *)path;
- (BOOL)appendTextInRange:(NSRange)range toFileWithPath:(NSString *)path;
- (SCText *)cutTextInRange:(NSRange)range toStream:(SCStream *)stream;
- (SCText *)cutTextInRange:(NSRange)range withPath:(NSString *)path;
- (SCText *)cutAndAppendTextInRange:(NSRange)range toFileWithPath:(NSString *)path;

- (BOOL)writeTextWithSubstring:(NSString *)substring toStream:(SCStream *)stream;
- (BOOL)writeTextWithSubstring:(NSString *)substring withPath:(NSString *)path;
- (BOOL)writeTextWithoutSubstring:(NSString *)substring toStream:(SCStream *)stream;
- (BOOL)writeTextWithoutSubstring:(NSString *)substring withPath:(NSString *)path;

@end