OFStream.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012
 *   Jonathan Schleifer <js@webkeks.org>
 *
 * All rights reserved.
 *
 * This file is part of ObjFW. It may be distributed under the terms of the
 * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
 * the packaging of this file.
 *
 * Alternatively, it may be distributed under the terms of the GNU General
 * Public License, either version 2 or 3, which can be found in the file
 * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
 * file.
 */

#ifndef __STDC_LIMIT_MACROS
# define __STDC_LIMIT_MACROS
#endif
#ifndef __STDC_CONSTANT_MACROS
# define __STDC_CONSTANT_MACROS
#endif

#include <stdarg.h>

#import "OFObject.h"
#import "OFString.h"

@class OFStream;
@class OFDataArray;
@class OFException;

#ifdef OF_HAVE_BLOCKS
typedef BOOL (^of_stream_async_read_block_t)(OFStream*, void*, size_t,
    OFException*);
typedef BOOL (^of_stream_async_read_line_block_t)(OFStream*, OFString*,
    OFException*);
#endif

@interface OFStream: OFObject <OFCopying>
{
    char   *cache;
    char   *writeBuffer;
    size_t cacheLength, writeBufferLength;
    BOOL   writeBufferEnabled;
    BOOL   blocking;
    BOOL   waitingForDelimiter;
}

#ifdef OF_HAVE_PROPERTIES
@property (getter=isBlocking) BOOL blocking;
@property (readonly, getter=isAtEndOfStream) BOOL atEndOfStream;
#endif

- (BOOL)isAtEndOfStream;

- (size_t)readIntoBuffer: (void*)buffer
          length: (size_t)size;

 - (void)readIntoBuffer: (void*)buffer
        exactLength: (size_t)length;

- (void)asyncReadIntoBuffer: (void*)buffer
             length: (size_t)length
             target: (id)target
           selector: (SEL)selector;

 - (void)asyncReadIntoBuffer: (void*)buffer
         exactLength: (size_t)length
              target: (id)target
            selector: (SEL)selector;

#ifdef OF_HAVE_BLOCKS

- (void)asyncReadIntoBuffer: (void*)buffer
             length: (size_t)length
              block: (of_stream_async_read_block_t)block;

 - (void)asyncReadIntoBuffer: (void*)buffer
         exactLength: (size_t)length
               block: (of_stream_async_read_block_t)block;
#endif

- (uint8_t)readInt8;

- (uint16_t)readBigEndianInt16;

- (uint32_t)readBigEndianInt32;

- (uint64_t)readBigEndianInt64;

- (float)readBigEndianFloat;

- (double)readBigEndianDouble;

- (size_t)readBigEndianInt16sIntoBuffer: (uint16_t*)buffer
                  count: (size_t)nInt16s;

- (size_t)readBigEndianInt32sIntoBuffer: (uint32_t*)buffer
                  count: (size_t)nInt32s;

- (size_t)readBigEndianInt64sIntoBuffer: (uint64_t*)buffer
                  count: (size_t)nInt64s;

- (size_t)readBigEndianFloatsIntoBuffer: (float*)buffer
                  count: (size_t)nFloats;

- (size_t)readBigEndianDoublesIntoBuffer: (double*)buffer
                   count: (size_t)nDoubles;

- (uint16_t)readLittleEndianInt16;

- (uint32_t)readLittleEndianInt32;

- (uint64_t)readLittleEndianInt64;

- (float)readLittleEndianFloat;

- (double)readLittleEndianDouble;

- (size_t)readLittleEndianInt16sIntoBuffer: (uint16_t*)buffer
                     count: (size_t)nInt16s;

- (size_t)readLittleEndianInt32sIntoBuffer: (uint32_t*)buffer
                     count: (size_t)nInt32s;

- (size_t)readLittleEndianInt64sIntoBuffer: (uint64_t*)buffer
                     count: (size_t)nInt64s;

- (size_t)readLittleEndianFloatsIntoBuffer: (float*)buffer
                     count: (size_t)nFloats;

- (size_t)readLittleEndianDoublesIntoBuffer: (double*)buffer
                      count: (size_t)nDoubles;

- (OFDataArray*)readDataArrayWithSize: (size_t)size;

- (OFDataArray*)readDataArrayWithItemSize: (size_t)itemSize
                    count: (size_t)nItems;

- (OFDataArray*)readDataArrayTillEndOfStream;

- (OFString*)readStringWithLength: (size_t)length;

- (OFString*)readStringWithLength: (size_t)length
             encoding: (of_string_encoding_t)encoding;

- (OFString*)readLine;

- (OFString*)readLineWithEncoding: (of_string_encoding_t)encoding;

- (void)asyncReadLineWithTarget: (id)target
               selector: (SEL)selector;

- (void)asyncReadLineWithEncoding: (of_string_encoding_t)encoding
               target: (id)target
             selector: (SEL)selector;

#ifdef OF_HAVE_BLOCKS

- (void)asyncReadLineWithBlock: (of_stream_async_read_line_block_t)block;

- (void)asyncReadLineWithEncoding: (of_string_encoding_t)encoding
                block: (of_stream_async_read_line_block_t)block;
#endif

- (OFString*)tryReadLine;

- (OFString*)tryReadLineWithEncoding: (of_string_encoding_t)encoding;

- (OFString*)readTillDelimiter: (OFString*)delimiter;

- (OFString*)readTillDelimiter: (OFString*)delimiter
              encoding: (of_string_encoding_t)encoding;

- (OFString*)tryReadTillDelimiter: (OFString*)delimiter;

- (OFString*)tryReadTillDelimiter: (OFString*)delimiter
             encoding: (of_string_encoding_t)encoding;

- (BOOL)writeBufferEnabled;

- (void)setWriteBufferEnabled: (BOOL)enable;

- (void)flushWriteBuffer;

- (void)writeBuffer: (const void*)buffer
         length: (size_t)length;

- (void)writeInt8: (uint8_t)int8;

- (void)writeBigEndianInt16: (uint16_t)int16;

- (void)writeBigEndianInt32: (uint32_t)int32;

- (void)writeBigEndianInt64: (uint64_t)int64;

- (void)writeBigEndianFloat: (float)float_;

- (void)writeBigEndianDouble: (double)double_;

- (size_t)writeBigEndianInt16s: (const uint16_t*)buffer
             count: (size_t)nInt16s;

- (size_t)writeBigEndianInt32s: (const uint32_t*)buffer
             count: (size_t)nInt32s;

- (size_t)writeBigEndianInt64s: (const uint64_t*)buffer
             count: (size_t)nInt64s;

- (size_t)writeBigEndianFloats: (const float*)buffer
             count: (size_t)nFloats;

- (size_t)writeBigEndianDoubles: (const double*)buffer
              count: (size_t)nDoubles;

- (void)writeLittleEndianInt16: (uint16_t)int16;

- (void)writeLittleEndianInt32: (uint32_t)int32;

- (void)writeLittleEndianInt64: (uint64_t)int64;

- (void)writeLittleEndianFloat: (float)float_;

- (void)writeLittleEndianDouble: (double)double_;

- (size_t)writeLittleEndianInt16s: (const uint16_t*)buffer
                count: (size_t)nInt16s;

- (size_t)writeLittleEndianInt32s: (const uint32_t*)buffer
                count: (size_t)nInt32s;

- (size_t)writeLittleEndianInt64s: (const uint64_t*)buffer
                count: (size_t)nInt64s;

- (size_t)writeLittleEndianFloats: (const float*)buffer
                count: (size_t)nFloats;

- (size_t)writeLittleEndianDoubles: (const double*)buffer
                 count: (size_t)nDoubles;

- (size_t)writeDataArray: (OFDataArray*)dataArray;

- (size_t)writeString: (OFString*)string;

- (size_t)writeLine: (OFString*)string;

- (size_t)writeFormat: (OFConstantString*)format, ...;

- (size_t)writeFormat: (OFConstantString*)format
        arguments: (va_list)arguments;

- (size_t)pendingBytes;

- (BOOL)isBlocking;

- (void)setBlocking: (BOOL)enable;

- (int)fileDescriptorForReading;

- (int)fileDescriptorForWriting;

- (void)close;

- (size_t)lowlevelReadIntoBuffer: (void*)buffer
              length: (size_t)length;

- (void)lowlevelWriteBuffer: (const void*)buffer
             length: (size_t)length;

- (BOOL)lowlevelIsAtEndOfStream;

- (BOOL)OF_isWaitingForDelimiter;
@end