src/OFStream.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011
 *   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.
 */

#include <stdarg.h>

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

@class OFDataArray;

@interface OFStream: OFObject
{
        char   *cache;
        char   *wBuffer;
        size_t cacheLen, wBufferLen;
        BOOL   buffersWrites;
        BOOL   isBlocking;
}

#ifdef OF_HAVE_PROPERTIES
@property (assign, setter=setBlocking:) BOOL isBlocking;
#endif

- (BOOL)isAtEndOfStream;

- (size_t)readNBytes: (size_t)size
          intoBuffer: (char*)buf;

- (void)readExactlyNBytes: (size_t)size
               intoBuffer: (char*)buf;

- (uint8_t)readInt8;

- (uint16_t)readBigEndianInt16;

- (uint32_t)readBigEndianInt32;

- (uint64_t)readBigEndianInt64;

- (uint16_t)readLittleEndianInt16;

- (uint32_t)readLittleEndianInt32;

- (uint64_t)readLittleEndianInt64;

- (OFDataArray*)readDataArrayWithItemSize: (size_t)itemsize
                                andNItems: (size_t)nitems;

- (OFDataArray*)readDataArrayTillEndOfStream;

- (OFString*)readLine;

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

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

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

- (BOOL)buffersWrites;

- (void)setBuffersWrites: (BOOL)enable;

- (void)flushWriteBuffer;

- (size_t)writeNBytes: (size_t)size
           fromBuffer: (const char*)buf;

- (void)writeInt8: (uint8_t)int8;

- (void)writeBigEndianInt16: (uint16_t)int16;

- (void)writeBigEndianInt32: (uint32_t)int32;

- (void)writeBigEndianInt64: (uint64_t)int64;

- (void)writeLittleEndianInt16: (uint16_t)int16;

- (void)writeLittleEndianInt32: (uint32_t)int32;

- (void)writeLittleEndianInt64: (uint64_t)int64;

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

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

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

- (size_t)writeFormat: (OFString*)fmt, ...;

- (size_t)writeFormat: (OFString*)fmt
        withArguments: (va_list)args;

- (size_t)pendingBytes;

- (BOOL)isBlocking;

- (void)setBlocking: (BOOL)enable;

- (int)fileDescriptor;

- (void)close;
@end