Logo Search packages:      
Sourcecode: djvulibre version File versions  Download package

ByteStream Class Reference

#include <ByteStream.h>

Inheritance diagram for ByteStream:

GPEnabled BSByteStream ByteStream::Memory ByteStream::Static ByteStream::Stdio ByteStream::Wrapper UnicodeByteStream IFFByteStream

List of all members.

Detailed Description

Abstract class for a stream of bytes. Class ByteStream# represent an object from which (resp. to which) bytes can be read (resp. written) as with a regular file. Virtual functions read# and write# must implement these two basic operations. In addition, function tell# returns an offset identifying the current position, and function seek# may be used to change the current position.

{ Note}. Both the copy constructor and the copy operator are declared as private members. It is therefore not possible to make multiple copies of instances of this class, as implied by the class semantic.

Definition at line 129 of file ByteStream.h.

Public Types

enum  codepage_type { RAW, AUTO, NATIVE, UTF8 }

Public Member Functions

int get_count (void) const
GNativeString getAsNative (void)
GUTF8String getAsUTF8 (void)
Utility Functions.
Class ByteStream# implements these functions using the virtual interface functions only. All subclasses of ByteStream# inherit these functions.

size_t copy (ByteStream &bsfrom, size_t size=0)
GP< ByteStreamduplicate (const size_t size=0) const
size_t format (const char *fmt,...)
 Allows printf() type operations to a bytestream.
void formatmessage (const char *fmt,...)
TArray< char > get_data (void)
 Use at your own risk, only guarenteed to work for ByteStream::Memorys.
virtual bool is_static (void) const
 Returns false, unless a subclass of ByteStream::Static.
unsigned int read16 ()
unsigned int read24 ()
unsigned int read32 ()
unsigned int read8 ()
size_t readall (void *buffer, size_t size)
virtual size_t readat (void *buffer, size_t sz, int pos)
int scanf (const char *fmt,...)
 Allows scanf() type operations on a bytestream.
virtual int size (void) const
size_t writall (const void *buffer, size_t size)
void write16 (unsigned int card16)
void write24 (unsigned int card24)
void write32 (unsigned int card32)
void write8 (unsigned int card8)
void writemessage (const char *message)
size_t writestring (const GNativeString &s)
size_t writestring (const GUTF8String &s)
Virtual Functions.
These functions are usually implemented by each subclass of ByteStream#.

virtual void flush (void)
virtual size_t read (void *buffer, size_t size)
virtual int seek (long offset, int whence=SEEK_SET, bool nothrow=false)
virtual long tell (void) const =0
virtual size_t write (const void *buffer, size_t size)
virtual ~ByteStream ()

Static Public Member Functions

static GP< ByteStreamcreate (FILE *const f, char const *const mode, const bool closeme)
static GP< ByteStreamcreate (const int fd, char const *const mode, const bool closeme)
static GP< ByteStreamcreate (char const *const mode)
static GP< ByteStreamcreate (const GURL &url, char const *const mode)
static GP< ByteStreamcreate (void const *const buffer, const size_t size)
static GP< ByteStreamcreate (void)
static GP< ByteStreamcreate_static (void const *buffer, size_t size)
static GP< ByteStreamget_stderr (char const *mode=0)
static GP< ByteStreamget_stdin (char const *mode=0)
static GP< ByteStreamget_stdout (char const *mode=0)

Public Attributes

enum ByteStream::codepage_type cp

Static Public Attributes

static const char * EndOfFile = ERR_MSG("EOF")

Protected Attributes

volatile int count
 The reference counter.

Private Member Functions

 ByteStream (const ByteStream &)
ByteStreamoperator= (const ByteStream &)


class  Memory
class  Static
class  Stdio
class  Wrapper

The documentation for this class was generated from the following files:

Generated by  Doxygen 1.6.0   Back to index