SCFileStream.h

Go to the documentation of this file.

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

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

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

#define SCFileStreamClass @"SCFileStream" 

#pragma mark -
#pragma mark Типы поддержки файловых потоков

enum _SCFileStreamStatus {
    SCFileStreamOK                      = 0,
    
    SCFileStreamIncorrectOpenModeError  = -20033,
    
    SCFileStreamEmptyPathError          = -20034,
    
    SCFileStreamEOFError                = -20035,
    
    SCFileStreamOffsetError             = -20036,
    
    SCFileStreamOffsetWhenceError       = -20037,
};

typedef SCStreamStatus SCFileStreamStatus;

enum _SCFileStreamOpenMode {
    SCFileStreamOpenReadOnly        = 0,
    
    SCFileStreamOpenReadWrite       = 1,
    
    SCFileStreamOpenWriteOnly       = 2,
    
    SCFileStreamOpenWriteRead       = 3,
    
    SCFileStreamOpenAppendWriteOnly = 4,
    
    SCFileStreamOpenAppendReadWrite = 5
};

typedef enum _SCFileStreamOpenMode SCFileStreamOpenMode;

enum _SCFileStreamOffsetWhence {
    SCFileStreamOffsetStart   = SEEK_SET,
    
    SCFileStreamOffsetCurrent = SEEK_CUR,
    
    SCFileStreamOffsetEnd     = SEEK_END
};

typedef enum _SCFileStreamOffsetWhence SCFileStreamOffsetWhence;

@interface SCFileStream : SCStream {
    FILE *fFile;                    // Указатель на файловый поток
    SCFileStreamOpenMode fOpenMode; // Режим открытия файлового потока
}
#pragma mark -
#pragma mark Свойства экземпляра класса

@property (nonatomic, assign, readonly, getter=openMode) SCFileStreamOpenMode openMode;

#pragma mark -
#pragma mark Методы доступа к свойствам экземпляра класса
- (SCFileStreamOpenMode)openMode;

#pragma mark -
#pragma mark Создание файловых потоков
+ (SCFileStream *)fileStreamWithPath:(NSString *)path
                                mode:(SCFileStreamOpenMode)mode
                            delegate:(id<SCStreamDelegate>)delegate
                            handling:(SCStreamErrorHandling)handling;
+ (SCFileStream *)fileStreamWithPath:(NSString *)path
                                mode:(SCFileStreamOpenMode)mode
                            delegate:(id<SCStreamDelegate>) delegate;
+ (SCFileStream *)fileStreamWithPath:(NSString *)path mode:(SCFileStreamOpenMode)mode;
+ (SCFileStream *)fileStreamWithPath:(NSString *)path;
+ (SCFileStream *)readOnlyFileStreamWithPath:(NSString *)path;
+ (SCFileStream *)writeOnlyFileStreamWithPath:(NSString *)path;
+ (SCFileStream *)appendFileStreamWithPath:(NSString *)path;
+ (SCFileStream *)fileStream;

#pragma mark -
#pragma mark Инициализация файловых потоков
- (id)initWithPath:(NSString *)path
              mode:(SCFileStreamOpenMode)mode
          delegate:(id<SCStreamDelegate>)delegate
          handling:(SCStreamErrorHandling)handling;
- (id)initWithPath:(NSString *)path mode:(SCFileStreamOpenMode)mode delegate:(id<SCStreamDelegate>)delegate;
- (id)initWithPath:(NSString *)path mode:(SCFileStreamOpenMode)mode;
- (id)initWithPath:(NSString *)path;
- (id)initReadOnlyWithPath:(NSString *)path;
- (id)initWriteOnlyWithPath:(NSString *)path;
- (id)initAppendWithPath:(NSString *)path;
- (id)init;

#pragma mark -
#pragma mark Чтение и запись данных
- (SCUSize)readBytes:(SCUSize)count toBuffer:(void *)buffer;
- (SCUSize)writeBytes:(SCUSize)count fromBuffer:(const void *)buffer;

#pragma mark -
#pragma mark Открытие и закрытие потока
- (void)openWithPath:(NSString *)path
                mode:(SCFileStreamOpenMode)mode
            handling:(SCStreamErrorHandling)handling;
- (void)openWithPath:(NSString *)path mode:(SCFileStreamOpenMode)mode;
- (void)openWithPath:(NSString *)path;
- (void)openReadOnlyWithPath:(NSString *)path;
- (void)openWriteOnlyWithPath:(NSString *)path;
- (void)openAppendWithPath:(NSString *)path;
- (void)close;

#pragma mark -
#pragma mark Позиционирование в потоке
- (void)setOffset:(SCLong)offset whence:(SCFileStreamOffsetWhence)whence;
- (void)setOffset:(SCLong)offset;
- (SCLong)offset;
- (void)rewind;

@end