Interface for a seekable & readable data stream. More...

#include <readstream.h>

Inheritance diagram for Common::SeekableReadStream:

[legend]

Collaboration diagram for Common::SeekableReadStream:

Public Types
enum	Origin { kOriginBegin = 0, kOriginCurrent = 1, kOriginEnd = 2, kOriginMAX }
	The position a seeking offset takes as a base. More...

Public Member Functions
	SeekableReadStream ()

	~SeekableReadStream ()

virtual size_t	pos () const =0
	Obtains the current value of the stream position indicator of the stream. More...

virtual size_t	size () const =0
	Obtains the total size of the stream, measured in bytes. More...

virtual size_t	seek (ptrdiff_t offset, Origin whence=kOriginBegin)=0
	Sets the stream position indicator for the stream. More...

virtual size_t	skip (ptrdiff_t offset)
	Skip the specified number of bytes, adding that offset to the current position in the stream. More...

Public Member Functions inherited from Common::ReadStream
	ReadStream ()

virtual	~ReadStream ()

virtual bool	eos () const =0
	Returns true if a read failed because the stream has been reached. More...

virtual size_t	read (void *dataPtr, size_t dataSize)=0
	Read data from the stream. More...

byte	readByte ()
	Read an unsigned byte from the stream and return it. More...

FORCEINLINE int8	readSByte ()
	Read a signed byte from the stream and return it. More...

uint32	readChar ()
	Reads the next character from stream and returns it as an unsigned char cast to an uint32, or kEOF on end of file or error. More...

uint16	readUint16LE ()
	Read an unsigned 16-bit word stored in little endian (LSB first) order from the stream and return it. More...

uint32	readUint32LE ()
	Read an unsigned 32-bit word stored in little endian (LSB first) order from the stream and return it. More...

uint64	readUint64LE ()
	Read an unsigned 64-bit word stored in little endian (LSB first) order from the stream and return it. More...

uint16	readUint16BE ()
	Read an unsigned 16-bit word stored in big endian (MSB first) order from the stream and return it. More...

uint32	readUint32BE ()
	Read an unsigned 32-bit word stored in big endian (MSB first) order from the stream and return it. More...

uint64	readUint64BE ()
	Read an unsigned 64-bit word stored in big endian (MSB first) order from the stream and return it. More...

FORCEINLINE int16	readSint16LE ()
	Read a signed 16-bit word stored in little endian (LSB first) order from the stream and return it. More...

FORCEINLINE int32	readSint32LE ()
	Read a signed 32-bit word stored in little endian (LSB first) order from the stream and return it. More...

FORCEINLINE int64	readSint64LE ()
	Read a signed 64-bit word stored in little endian (LSB first) order from the stream and return it. More...

FORCEINLINE int16	readSint16BE ()
	Read a signed 16-bit word stored in big endian (MSB first) order from the stream and return it. More...

FORCEINLINE int32	readSint32BE ()
	Read a signed 32-bit word stored in big endian (MSB first) order from the stream and return it. More...

FORCEINLINE int64	readSint64BE ()
	Read a signed 64-bit word stored in big endian (MSB first) order from the stream and return it. More...

FORCEINLINE float	readIEEEFloatLE ()
	Read a 32-bit IEEE float stored in little endian (LSB first) order from the stream and return it. More...

FORCEINLINE float	readIEEEFloatBE ()
	Read a 32-bit IEEE float stored in big endian (MSB first) order from the stream and return it. More...

FORCEINLINE double	readIEEEDoubleLE ()
	Read a 64-bit IEEE double stored in little endian (LSB first) order from the stream and return it. More...

FORCEINLINE double	readIEEEDoubleBE ()
	Read a 64-bit IEEE double stored in big endian (MSB first) order from the stream and return it. More...

MemoryReadStream *	readStream (size_t dataSize)
	Read the specified amount of data into a new[]'ed buffer which then is wrapped into a MemoryReadStream. More...

Static Public Member Functions
static size_t	evalSeek (ptrdiff_t offset, Origin whence, size_t pos, size_t begin, size_t size)
	Evaluate the seek offset relative to whence into a position from the beginning. More...

Additional Inherited Members
Static Public Attributes inherited from Common::ReadStream
static const uint32	kEOF = 0xFFFFFFFF
	Return value for end-of-file. More...

static const size_t	kSizeInvalid = SIZE_MAX

static const size_t	kPositionInvalid = SIZE_MAX

Detailed Description

Interface for a seekable & readable data stream.

Definition at line 265 of file readstream.h.

Member Enumeration Documentation

◆ Origin

enum Common::SeekableReadStream::Origin

The position a seeking offset takes as a base.

Enumerator
kOriginBegin	Seek from the begin of the stream.
kOriginCurrent	Seek from the current position of the stream.
kOriginEnd	Seek from the end of the stream.
kOriginMAX	For range checks.

Definition at line 268 of file readstream.h.

Constructor & Destructor Documentation

◆ SeekableReadStream()

Common::SeekableReadStream::SeekableReadStream ( )

Definition at line 77 of file readstream.cpp.

◆ ~SeekableReadStream()

Common::SeekableReadStream::~SeekableReadStream ( )

Definition at line 80 of file readstream.cpp.

Member Function Documentation

◆ evalSeek()

size_t Common::SeekableReadStream::evalSeek	(	ptrdiff_t	offset,
		Origin	whence,
		size_t	pos,
		size_t	begin,
		size_t	size
	)

static

Evaluate the seek offset relative to whence into a position from the beginning.

Definition at line 83 of file readstream.cpp.

References kOriginBegin, kOriginCurrent, kOriginEnd, pos(), size(), and XOREOS_FALLTHROUGH.

Referenced by Common::MemoryReadStream::seek(), and Common::SeekableSubReadStream::seek().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pos()

virtual size_t Common::SeekableReadStream::pos ( ) const

pure virtual

Obtains the current value of the stream position indicator of the stream.

Returns: the current position indicator, or kPositionInvalid if an error occurred.

Implemented in Common::SeekableSubReadStream, Common::MemoryReadStream, and Common::ReadFile.

Here is the caller graph for this function:

◆ seek()

virtual size_t Common::SeekableReadStream::seek	(	ptrdiff_t	offset,
		Origin	whence = `kOriginBegin`
	)

pure virtual

Sets 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 kOriginBegin, kOriginCurrent, or kOriginEnd, the offset is relative to the start of the file, the current position indicator, or end-of-file, respectively. A successful call to the seek() method clears the end-of-file indicator for the stream.

On error, or when trying to seek outside the stream, a kSeekError exception is thrown.

Parameters