SCStream.h

Go to the documentation of this file.

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

#import <Foundation/Foundation.h>
#import <scl/SCObject.h>
#import <scl/SCSystemException.h>

#pragma mark -
#pragma mark Class Constants

#define SCStreamClass               @"SCStream"

#define SC_STREAM_MAX_STRING_LENGTH 4096

#define SC_NULL_NSSTRING            @"__NULL_NSSTRING__"

#define SC_NULL_OBJECT              @"__NULL_OBJECT__"


#pragma mark -
#pragma mark Stream Support Types

typedef enum {
    SCStreamErrorHandlingSystem = 1,
    
    SCStreamErrorHandlingStream = 2,
    
    SCStreamErrorHandlingStatus = 3
} SCStreamErrorHandling;

typedef enum {
    SCStreamOK                      = 0,
    
    SCStreamNotOpenError            = -20021,
    
    SCStreamReadOnlyError           = -20022,
    
    SCStreamWriteOnlyError          = -20023,
    
    SCStreamUnknownClassError       = -20024,
    
    SCStreamUnexpectedClassError    = -20025,
    
    SCStreamUnsupportedClassError   = -20026,
    
    SCStreamIncompleteReadError     = -20027,
    
    SCStreamIncompleteWriteError    = -20028,
    
    SCStreamOpenError               = -20029,
    
    SCStreamReadError               = -20030,
    
    SCStreamWriteError              = -20031,
} SCStreamStatusCode;

typedef SCInteger SCStreamStatus;


@protocol SCStreamDelegate;
@class SCStreamException;

#pragma mark -

@interface SCStream : SCObject {
    SCStreamErrorHandling   fErrorHandling;     // Errors handling mode
    SCStreamStatus          fStatus;            // Stream status
    NSString                *fName;             // Stream name
    BOOL                    fOpened;            // Stream opening flag
    id                      fObject;            // Pointer to the current loaded object
    SCStreamException      *fStreamException;   // Last detected stream error
    SCSystemException      *fSystemException;   // Last detected system error
    id<SCStreamDelegate>    fDelegate;          // Stream delegate object
    SCULong                 fTotalRead;         // Number of the totally readed characters
    SCULong                 fTotalWrite;        // Number of the totally writed characters
    SCULong                 fLastRead;          // Number of the characters that were readed during last operation
    SCULong                 fLastWrite;         // Number of the characters that were writed during last operation
}
#pragma mark -
#pragma mark Свойства экземпляра класса

@property (nonatomic, readwrite, assign) SCStreamErrorHandling errorHandling;

@property (nonatomic, readonly, assign) SCStreamStatus status;

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

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

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

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

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

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

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

@property (nonatomic, readonly, assign) id object;

@property (nonatomic, readonly, retain) SCStreamException *streamException;

@property (nonatomic, readonly, retain) SCSystemException *systemException;

@property (nonatomic, readwrite, retain) id<SCStreamDelegate> delegate;

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

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

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

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

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

#pragma mark -
#pragma mark Initializing Streams
- (instancetype)init;

#pragma mark -
#pragma mark Data Reading
- (SCSize)readBytes:(SCSize)count toBuffer:(void *)buffer;
- (id)readObject;
- (SCByte)readByte;
- (SCUByte)readUByte;
- (SCShort)readShort;
- (SCUShort)readUShort;
- (SCInteger)readInteger;
- (SCUInteger)readUInteger;
- (SCLong)readLong;
- (SCULong)readULong;
- (char)readChar;
- (unichar)readUnichar;
- (const char *)readCharString;
- (BOOL)readBool;
- (SCFloat)readFloat;
- (SCDouble)readDouble;
- (NSInteger)readNSInteger;
- (NSUInteger)readNSUInteger;
- (SCSize)readToByte:(SCByte *)buffer;
- (SCSize)readToUByte:(SCUByte *)buffer;
- (SCSize)readToShort:(SCShort *)buffer;
- (SCSize)readToUShort:(SCUShort *)buffer;
- (SCSize)readToInteger:(SCInteger *)buffer;
- (SCSize)readToUInteger:(SCUInteger *)buffer;
- (SCSize)readToLong:(SCULong *)buffer;
- (SCSize)readToULong:(SCULong *)buffer;
- (SCSize)readToChar:(char *)buffer;
- (SCSize)readToUnichar:(unichar *)buffer;
- (SCSize)readToCharString:(char *)buffer max:(SCSize)max;
- (SCSize)readToBool:(BOOL *)buffer;
- (SCSize)readToFloat:(SCFloat *)buffer;
- (SCSize)readToDouble:(SCDouble *)buffer;
- (SCSize)readToNSInteger:(NSInteger *)buffer;
- (SCSize)readToNSUInteger:(NSUInteger *)buffer;

#pragma mark -
#pragma mark Data Writing
- (SCSize)writeBytes:(SCSize)count fromBuffer:(const void *)buffer;
- (void)writeObject:(id<SCStreaming>)object;
- (void)writeByte:(SCByte)variable;
- (void)writeUByte:(SCUByte)variable;
- (void)writeShort:(SCShort)variable;
- (void)writeUShort:(SCUShort)variable;
- (void)writeInteger:(SCInteger)variable;
- (void)writeUInteger:(SCUInteger)variable;
- (void)writeLong:(SCLong)variable;
- (void)writeULong:(SCULong)variable;
- (void)writeChar:(char)variable;
- (void)writeUnichar:(unichar)variable;
- (void)writeCharString:(const char *)variable;
- (void)writeBool:(BOOL)variable;
- (void)writeFloat:(SCFloat)variable;
- (void)writeDouble:(SCDouble)variable;
- (void)writeNSInteger:(NSInteger)variable;
- (void)writeNSUInteger:(NSUInteger)variable;

#pragma mark -
#pragma mark Text Files Support
- (NSString *)readStringWithEncoding:(NSStringEncoding)encoding max:(SCInteger)max;
- (NSString *)readStringWithEncoding:(NSStringEncoding)encoding;
- (NSString *)readStringWithMax:(SCInteger)max;
- (NSString *)readString;
- (void)writeString:(NSString *)string encoding:(NSStringEncoding)encoding;
- (void)writeString:(NSString *)string;

#pragma mark -
#pragma mark Statistic Methods
- (void)resetStats;

@end