Common::SeekableReadStreamEndianWrapper Class Reference

#include <stream.h>

Inheritance diagram for Common::SeekableReadStreamEndianWrapper:

Public Member Functions
	SeekableReadStreamEndianWrapper (SeekableReadStream *parentStream, bool bigEndian, DisposeAfterUse::Flag disposeParentStream=DisposeAfterUse::NO)
bool	err () const override
void	clearErr () override
bool	eos () const override
uint32	read (void *dataPtr, uint32 dataSize) override
int64	pos () const override
int64	size () const override
bool	seek (int64 offset, int whence=SEEK_SET) override
Public Member Functions inherited from Common::SeekableReadStreamEndian
	SeekableReadStreamEndian (bool bigEndian)
Public Member Functions inherited from Common::SeekableReadStream
virtual bool	skip (uint32 offset)
virtual char *	readLine (char *s, size_t bufSize, bool handleCR=true)
virtual String	readLine (bool handleCR=true)
void	hexdump (int len, int bytesPerLine=16, int startOffset=0)
Public Member Functions inherited from Common::ReadStream
byte	readByte ()
FORCEINLINE int8	readSByte ()
uint16	readUint16LE ()
uint32	readUint32LE ()
uint64	readUint64LE ()
uint16	readUint16BE ()
uint32	readUint32BE ()
uint64	readUint64BE ()
FORCEINLINE int16	readSint16LE ()
FORCEINLINE int32	readSint32LE ()
FORCEINLINE int64	readSint64LE ()
FORCEINLINE int16	readSint16BE ()
FORCEINLINE int32	readSint32BE ()
FORCEINLINE int64	readSint64BE ()
FORCEINLINE float	readFloatLE ()
FORCEINLINE float	readFloatBE ()
FORCEINLINE double	readDoubleLE ()
FORCEINLINE double	readDoubleBE ()
template<class TDataFormat , class... T>
bool	readMultiple (const TDataFormat &dataFormat, T &...values)
template<class... T>
bool	readMultipleEndian (bool isLittle, T &...values)
template<class... T>
bool	readMultipleLE (T &...values)
template<class... T>
bool	readMultipleBE (T &...values)
SeekableReadStream *	readStream (uint32 dataSize)
String	readString (char terminator=0, size_t len=String::npos)
Common::String	readPascalString (bool transformCR=true)
Public Member Functions inherited from Common::ReadStreamEndian
	ReadStreamEndian (bool bigEndian)
bool	isBE () const
uint16	readUint16 ()
uint32	readUint32 ()
uint64	readUint64 ()
FORCEINLINE int16	readSint16 ()
FORCEINLINE int32	readSint32 ()
FORCEINLINE int64	readSint64 ()
FORCEINLINE float	readFloat ()
FORCEINLINE double	readDouble ()

Protected Attributes
DisposablePtr< SeekableReadStream >	_parentStream

Detailed Description

SeekableReadStreamEndian subclass that wraps around an existing stream.

Altering the position of the substream will affect the position of the parent stream, and vice versa.

Member Function Documentation

err()

bool Common::SeekableReadStreamEndianWrapper::err ( ) const

inlineoverridevirtual

Return true if an I/O failure occurred.

This flag is never cleared automatically. In order to clear it, the client code must call clearErr() explicitly.

Note

The semantics of any implementation of this method is supposed to match that of ISO C ferror().

Reimplemented from Common::Stream.

clearErr()

void Common::SeekableReadStreamEndianWrapper::clearErr ( )

inlineoverridevirtual

Reset the I/O error status as returned by err().

For a ReadStream, also reset the end-of-stream status returned by eos().

Note

The semantics of any implementation of this method is supposed to match that of ISO C clearerr().

Reimplemented from Common::Stream.

eos()

bool Common::SeekableReadStreamEndianWrapper::eos ( ) const

inlineoverridevirtual

Return true if a read failed because the stream end has been reached.

This flag is cleared by clearErr(). For a SeekableReadStream, the flag is also cleared by a successful seek.

Note

The semantics of any implementation of this method is supposed to match that of ISO C feof(). In particular, in a stream with N bytes, reading exactly N bytes from the start should not set eos; only reading beyond the available data should set it.

Implements Common::ReadStream.

read()

uint32 Common::SeekableReadStreamEndianWrapper::read ( void *  dataPtr, uint32  dataSize  )

inlineoverridevirtual

Read data from the stream.

Subclasses must implement this method. All other read methods are implemented using it.

Note

The semantics of any implementation of this method is supposed to match that of ISO C fread(), in particular where it concerns setting error and end of file/stream flags.

Parameters

dataPtr	Pointer to a buffer into which the data is read.
dataSize	Number of bytes to be read.

Returns

The number of bytes that were actually read.

Implements Common::ReadStream.

pos()

int64 Common::SeekableReadStreamEndianWrapper::pos ( ) const

inlineoverridevirtual

Obtain the current value of the stream position indicator.

Returns

The current position indicator, or -1 if an error occurred.

Implements Common::SeekableReadStream.

size()

int64 Common::SeekableReadStreamEndianWrapper::size ( ) const

inlineoverridevirtual

Obtain the total size of the stream, measured in bytes. If this value is unknown or cannot be computed, -1 is returned.

Returns

The size of the stream, or -1 if an error occurred.

Implements Common::SeekableReadStream.

seek()

bool Common::SeekableReadStreamEndianWrapper::seek ( int64  offset, int  whence = SEEK_SET  )

inlineoverridevirtual

Set the stream position indicator for the stream.

The new position, measured in bytes, is obtained by adding offset bytes to the position specified by whence. If whence is set to SEEK_SET, SEEK_CUR, or SEEK_END, the offset is relative to the start of the file, the current position indicator, or end-of-stream, respectively. A successful call to the seek() method clears the end-of-stream indicator for the stream.

Note

The semantics of any implementation of this method is supposed to match that of ISO C fseek().

Parameters

offset	Relative offset in bytes.
whence	Seek reference: SEEK_SET, SEEK_CUR, or SEEK_END.

Returns

True on success, false in case of a failure.

Implements Common::SeekableReadStream.

---

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

• common/stream.h