SCStream.h

Go to the documentation of this file.

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

#import <Foundation/Foundation.h>
#import <scl/SCTypes.h>
#import <scl/SCObject.h>
#import <scl/SCStreamProtocol.h>
#import <scl/SCSystemException.h>
#import <scl/SCStreamException.h>

#define SCStreamClass @"SCStream" ///< SCStream class name

@protocol SCStreamDelegate;

#pragma mark -
#pragma mark Streams supporting constants

#define SC_STREAM_MAX_STRING_LENGTH     4096    ///< String maximum length

#pragma mark -
#pragma mark Streams supporing types

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

typedef enum _SCStreamErrorHandling SCStreamErrorHandling;

enum _SCStreamStatus {
        SCStreamOK                      = 0,    
    SCStreamUnexpectedClassError    = 1,    
    SCStreamIncompleteReadError     = 2,    
    SCStreamIncompleteWriteError    = 3,    
    SCStreamOpenError               = 4,    
    SCStreamNotOpenError            = 5,    
    SCStreamReadOnlyError           = 6,    
    SCStreamWriteOnlyError          = 7,    
    SCStreamReadError               = 8,    
    SCStreamWriteError              = 9,    
        SCStreamUnknownClassError               = 11,   
        SCStreamUnsupportedClass        = 12,   
};

typedef SCUInteger SCStreamStatus;

#pragma mark -

@interface SCStream : SCObject {
        SCStreamErrorHandling   fErrorHandling;         // Error handling mode
        SCStreamStatus                  fStatus;                        // Stream status
        NSString                            *fStreamName;               // Stream name
        BOOL                                    fOpenFlag;                      // Stream opening flag
    SCStreamException      *fStreamException;   // Last detected stream exception
    SCSystemException      *fSystemException;   // Last detected system exception
    id<SCStreamDelegate>        fDelegate;                      // Stream events delegate object
        id                                              fObject;                        // Currently loaded object
}
#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET

// Error handling mode type
@property (nonatomic, assign, getter=errorHandling, setter=setErrorHandling:)
        SCStreamErrorHandling errorHandling;
// Status property
@property (nonatomic, assign, readonly, getter=status) SCStreamStatus status;
// Stream name property
@property (nonatomic, retain, readonly, getter=streamName) NSString *streamName;
// Stream opening flag property
@property (nonatomic, assign, readonly, getter=isOpen) BOOL isOpen;
// Last detected stream exception property
@property (nonatomic, assign, readonly, getter=streamException) SCStreamException *streamException;
// Last detected system exception property
@property (nonatomic, assign, readonly, getter=systemException) SCSystemException *systemException;
// Stream is readable property
@property (nonatomic, assign, readonly, getter=isReadable) BOOL isReadable;
// Stream is writable property
@property (nonatomic, assign, readonly, getter=isWritable) BOOL isWritable;
// Stream is read only property
@property (nonatomic, assign, readonly, getter=isReadOnly) BOOL isReadOnly;
// Stream is write only property
@property (nonatomic, assign, readonly, getter=isWriteOnly) BOOL isWriteOnly;
// Stream is read and write property
@property (nonatomic, assign, readonly, getter=isReadWrite) BOOL isReadWrite;
// Stream events delegate object property
@property (assign, getter=delegate, setter=setDelegate:) id<SCStreamDelegate> delegate;
// Currently loaded object property
@property (retain, readonly, getter=object) id object;

#endif

#pragma mark -
#pragma mark Initializing Stream

- (id)init;

#pragma mark -
#pragma mark Handling Errors

- (SCStreamErrorHandling)errorHandling;

- (SCStreamStatus)status;

- (SCStreamException *)streamException;

- (SCSystemException *)systemException;

- (void)setErrorHandling:(SCStreamErrorHandling)mode;

#pragma mark -
#pragma mark Querying and Setting Exception Properties

- (NSString *)streamName;

- (BOOL)isOpen;

- (BOOL)isReadable;

- (BOOL)isWritable;

- (BOOL)isReadOnly;

- (BOOL)isWriteOnly;

- (BOOL)isReadWrite;

- (id<SCStreamDelegate>)delegate;

- (void)setDelegate:(id<SCStreamDelegate>)delegate;

- (id)object;

#pragma mark -
#pragma mark Reading from Stream

- (SCUSize)readBytes:(SCUSize)count toBuffer:(void *)buffer;

- (id<SCStreamProtocol>)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;

- (SCUSize)readToByte:(SCByte *)buffer;

- (SCUSize)readToUByte:(SCUByte *)buffer;

- (SCUSize)readToShort:(SCShort *)buffer;

- (SCUSize)readToUShort:(SCUShort *)buffer;

- (SCUSize)readToInteger:(SCInteger *)buffer;

- (SCUSize)readToUInteger:(SCUInteger *)buffer;

- (SCUSize)readToLong:(SCULong *)buffer;

- (SCUSize)readToULong:(SCULong *)buffer;

- (SCUSize)readToChar:(char *)buffer;

- (SCUSize)readToUnichar:(unichar *)buffer;

- (SCUSize)readToCharString:(char *)buffer max:(SCUSize)max;

- (SCUSize)readToBool:(BOOL *)buffer;

- (SCUSize)readToFloat:(SCFloat *)buffer;

- (SCUSize)readToDouble:(SCDouble *)buffer;

#pragma mark -
#pragma mark Writing into Stream

- (SCUSize)writeBytes:(SCUSize)count fromBuffer:(const void *)buffer;

- (void)writeObject:(id<SCStreamProtocol>)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;

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

- (NSString *)readStringWithEncoding:(NSStringEncoding)encoding max:(SCUInteger)max;

- (NSString *)readStringWithEncoding:(NSStringEncoding)encoding;

- (NSString *)readStringWithMax:(SCUInteger)max;

- (NSString *)readString;

- (void)writeString:(NSString *)string encoding:(NSStringEncoding)encoding;

- (void)writeString:(NSString *)string;

#pragma mark -
#pragma mark Seeking Stream

- (BOOL)eof;

@end