SCFileStream.h

Go to the documentation of this file.

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

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

#pragma mark -
#pragma mark Class Constants

#define SCFileStreamClass @"SCFileStream"

#pragma mark -
#pragma mark File Stream Support Types

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

typedef SCStreamStatus SCFileStreamStatus;

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

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


@interface SCFileStream : SCStream {
    FILE                    *_file;                    // Pointer to the file
    SCFileStreamOpenMode     _openMode; // File stream opening mode
}
#pragma mark -
#pragma mark Instance Properties

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

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

#pragma mark -
#pragma mark Creating File Streams
+ (instancetype)fileStreamWithPath:(NSString *)path
                              mode:(SCFileStreamOpenMode)mode
                          delegate:(id<SCStreamDelegate>)delegate
                          handling:(SCStreamErrorHandling)handling;
+ (instancetype)fileStreamWithPath:(NSString *)path
                              mode:(SCFileStreamOpenMode)mode
                          delegate:(id<SCStreamDelegate>) delegate;
+ (instancetype)fileStreamWithPath:(NSString *)path mode:(SCFileStreamOpenMode)mode;
+ (instancetype)fileStreamWithPath:(NSString *)path;
+ (instancetype)readOnlyFileStreamWithPath:(NSString *)path;
+ (instancetype)writeOnlyFileStreamWithPath:(NSString *)path;
+ (instancetype)appendFileStreamWithPath:(NSString *)path;
+ (instancetype)fileStream;

#pragma mark -
#pragma mark Initializing File Streams
- (instancetype)initWithPath:(NSString *)path
                        mode:(SCFileStreamOpenMode)mode
                    delegate:(id<SCStreamDelegate>)delegate
                    handling:(SCStreamErrorHandling)handling;
- (instancetype)initWithPath:(NSString *)path mode:(SCFileStreamOpenMode)mode delegate:(id<SCStreamDelegate>)delegate;
- (instancetype)initWithPath:(NSString *)path mode:(SCFileStreamOpenMode)mode;
- (instancetype)initWithPath:(NSString *)path;
- (instancetype)initReadOnlyWithPath:(NSString *)path;
- (instancetype)initWriteOnlyWithPath:(NSString *)path;
- (instancetype)initAppendWithPath:(NSString *)path;
- (instancetype)init;

#pragma mark -
#pragma mark Reading and Writing Data
- (SCSize)readBytes:(SCSize)count toBuffer:(void *)buffer;
- (SCSize)writeBytes:(SCSize)count fromBuffer:(const void *)buffer;

#pragma mark -
#pragma mark Opening and Closing Streams
- (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 Seeking Streams
- (void)setOffset:(NSInteger)offset whence:(SCFileStreamOffsetWhence)whence;
- (void)setOffset:(NSInteger)offset;
- (NSInteger)offset;
- (void)rewind;

@end