Generic interface for a readable data stream. More...

#include <readstream.h>

Inheritance diagram for Common::ReadStream:

[legend]

Public Member Functions
	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 Attributes
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

Generic interface for a readable data stream.

Definition at line 64 of file readstream.h.

Constructor & Destructor Documentation

◆ ReadStream()

Common::ReadStream::ReadStream ( )

Definition at line 61 of file readstream.cpp.

◆ ~ReadStream()

Common::ReadStream::~ReadStream ( )

virtual

Definition at line 64 of file readstream.cpp.

Member Function Documentation

◆ eos()

virtual bool Common::ReadStream::eos ( ) const

pure virtual

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

For a SeekableReadStream, it is cleared by a successful seek.

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

Referenced by Aurora::VISFile::load(), Aurora::LYTFile::load(), Sound::WwiseSoundBank::load(), Graphics::Aurora::ModelNode_NWN_ASCII::load(), Graphics::TXI::load(), Common::ConfigFile::load(), Graphics::Aurora::Model_NWN::loadASCII(), Common::FoxPro::loadFields(), Common::FoxPro::loadMemos(), Sound::makeWAVStream(), Aurora::TwoDAFile::readHeaders2a(), Aurora::TwoDAFile::readRows2a(), Common::readString(), Common::readStringLine(), Graphics::Aurora::Model_NWN::skipAnimASCII(), and Common::WriteStream::writeStream().

Here is the caller graph for this function:

◆ read()

virtual size_t Common::ReadStream::read	(	void *	dataPtr,
		size_t	dataSize
	)

pure virtual

Read data from the stream.

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

Parameters

dataPtr	pointer to a buffer into which the data is read.
dataSize	number of bytes to be read.

Returns: the number of bytes which were actually read.

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

Referenced by Sound::AACDecoder::AACDecoder(), Sound::ASFGUID::ASFGUID(), Common::blowfishEBC(), Aurora::compress10(), Video::VPXDecoder::decodeFrame(), Sound::AACDecoder::decodeFrame(), Sound::WMACodec::decodeSuperFrame(), Common::decompressDeflate(), Common::decompressDeflateChunk(), Common::decompressDeflateWithoutOutputSize(), Common::decompressLZMA1(), Common::PEResources::loadFromEXE(), Common::FoxPro::loadMemos(), Common::FoxPro::loadRecords(), Sound::PacketizedVorbisStream::parseExtraData(), Aurora::LanguageManager::preParseColorCodes(), Common::printDataHex(), Sound::read_stream_wrap(), readByte(), Graphics::TPC::readData(), Graphics::TXB::readData(), Graphics::SBM::readData(), Graphics::WinIconImage::readData(), Graphics::DDS::readData(), Graphics::TGA::readData(), Common::readFakeChar(), Graphics::XEOSITEX::readMipMaps(), Common::readStream(), readStream(), Common::readStringFixed(), readUint16BE(), readUint16LE(), readUint32BE(), readUint32LE(), readUint64BE(), readUint64LE(), Aurora::ERFFile::readV22Header(), Aurora::ERFFile::readV30Header(), Common::searchBackwards(), Common::FoxPro::setMemo(), Graphics::TTFRenderer::TTFRenderer(), and Common::WriteStream::writeStream().

Here is the caller graph for this function:

◆ readByte()

byte Common::ReadStream::readByte ( )

inline

Read an unsigned byte from the stream and return it.

Definition at line 92 of file readstream.h.

References Common::kReadError, and read().

Here is the call graph for this function:

◆ readChar()

uint32 Common::ReadStream::readChar ( )

inline

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.

Similar to fgetc().

Definition at line 108 of file readstream.h.

References kEOF, and readByte().

Referenced by Common::StreamTokenizer::findFirstToken(), Common::StreamTokenizer::getToken(), Common::StreamTokenizer::isChunkEnd(), Aurora::VISFile::load(), Common::StreamTokenizer::nextChunk(), Aurora::ActionScript::ASBuffer::readString(), and Common::StreamTokenizer::skipChunk().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readIEEEDoubleBE()

FORCEINLINE double Common::ReadStream::readIEEEDoubleBE ( )

inline

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

Definition at line 251 of file readstream.h.

References convertIEEEDouble(), and readUint64BE().

Referenced by Common::MemoryReadStreamEndian::readIEEEDouble(), and Common::SeekableSubReadStreamEndian::readIEEEDouble().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readIEEEDoubleLE()

FORCEINLINE double Common::ReadStream::readIEEEDoubleLE ( )

inline

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

Definition at line 244 of file readstream.h.

References convertIEEEDouble(), and readUint64LE().

Referenced by Aurora::ActionScript::ASBuffer::actionPush(), Aurora::GFF3Struct::getDouble(), Common::MemoryReadStreamEndian::readIEEEDouble(), and Common::SeekableSubReadStreamEndian::readIEEEDouble().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readIEEEFloatBE()

FORCEINLINE float Common::ReadStream::readIEEEFloatBE ( )

inline

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

Definition at line 237 of file readstream.h.

References convertIEEEFloat(), and readUint32BE().

Referenced by Common::MemoryReadStreamEndian::readIEEEFloat(), and Common::SeekableSubReadStreamEndian::readIEEEFloat().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readIEEEFloatLE()

FORCEINLINE float Common::ReadStream::readIEEEFloatLE ( )

inline

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

Definition at line 230 of file readstream.h.

References convertIEEEFloat(), and readUint32LE().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readSByte()

FORCEINLINE int8 Common::ReadStream::readSByte ( )

inline

Read a signed byte from the stream and return it.

Definition at line 101 of file readstream.h.

References readByte().

Referenced by Aurora::GFF4Struct::getSint(), and Aurora::GFF4Struct::getUint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readSint16BE()

FORCEINLINE int16 Common::ReadStream::readSint16BE ( )

inline

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

Definition at line 209 of file readstream.h.

References readUint16BE().

Referenced by Common::MemoryReadStreamEndian::readSint16(), and Common::SeekableSubReadStreamEndian::readSint16().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readSint16LE()

FORCEINLINE int16 Common::ReadStream::readSint16LE ( )

inline

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

Definition at line 188 of file readstream.h.

References readUint16LE().

Referenced by Aurora::ActionScript::ASBuffer::actionIf(), Aurora::ActionScript::ASBuffer::actionJump(), Sound::FMODSampleBank::load(), Common::MemoryReadStreamEndian::readSint16(), Common::SeekableSubReadStreamEndian::readSint16(), and Graphics::Aurora::ModelNode_KotOR::readSkin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readSint32BE()

FORCEINLINE int32 Common::ReadStream::readSint32BE ( )

inline

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

Definition at line 216 of file readstream.h.

References readUint32BE().

Referenced by Common::MemoryReadStreamEndian::readSint32(), and Common::SeekableSubReadStreamEndian::readSint32().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readSint32LE()

FORCEINLINE int32 Common::ReadStream::readSint32LE ( )

inline

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

Definition at line 195 of file readstream.h.

References readUint32LE().

Referenced by Sound::FMODSampleBank::load(), Aurora::FEVFile::readProperties(), Common::MemoryReadStreamEndian::readSint32(), Common::SeekableSubReadStreamEndian::readSint32(), and Aurora::ERFFile::readV30ResList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readSint64BE()

FORCEINLINE int64 Common::ReadStream::readSint64BE ( )

inline

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

Definition at line 223 of file readstream.h.

References readUint64BE().

Referenced by Common::MemoryReadStreamEndian::readSint64(), and Common::SeekableSubReadStreamEndian::readSint64().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readSint64LE()

FORCEINLINE int64 Common::ReadStream::readSint64LE ( )

inline

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

Definition at line 202 of file readstream.h.

References readUint64LE().

Referenced by Common::MemoryReadStreamEndian::readSint64(), and Common::SeekableSubReadStreamEndian::readSint64().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readStream()

MemoryReadStream * Common::ReadStream::readStream ( size_t dataSize )

Read the specified amount of data into a new[]'ed buffer which then is wrapped into a MemoryReadStream.

When reading fails, a kReadError exception is thrown.

Definition at line 67 of file readstream.cpp.

References Common::ScopedPtrBase< T, Deallocator >::get(), Common::kReadError, read(), and Common::ScopedPtrBase< T, Deallocator >::release().

Referenced by Aurora::ActionScript::ASBuffer::actionDefineFunction(), Common::ZipFile::decompressFile(), Aurora::GFF3Struct::getData(), Aurora::LocString::readString(), Graphics::TPC::readTXI(), and Graphics::TXB::readTXI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readUint16BE()

uint16 Common::ReadStream::readUint16BE ( )

inline

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

Definition at line 155 of file readstream.h.

References Common::kReadError, and read().

Referenced by Aurora::isBigEndian(), Aurora::OBBFile::load(), Common::PEResources::loadFromEXE(), Common::FoxPro::loadMemos(), Sound::PacketizedVorbisStream::parseExtraData(), readSint16BE(), Common::MemoryReadStreamEndian::readUint16(), and Common::SeekableSubReadStreamEndian::readUint16().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readUint16LE()

uint16 Common::ReadStream::readUint16LE ( )

inline

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

Definition at line 122 of file readstream.h.

References Common::kReadError, and read().

Here is the call graph for this function:

◆ readUint32BE()

uint32 Common::ReadStream::readUint32BE ( )

inline

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

Definition at line 166 of file readstream.h.

References Common::kReadError, and read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readUint32LE()

uint32 Common::ReadStream::readUint32LE ( )

inline

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

Definition at line 133 of file readstream.h.

References Common::kReadError, and read().

Here is the call graph for this function:

◆ readUint64BE()

uint64 Common::ReadStream::readUint64BE ( )

inline

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

Definition at line 177 of file readstream.h.

References Common::kReadError, and read().

Referenced by readIEEEDoubleBE(), readSint64BE(), Common::MemoryReadStreamEndian::readUint64(), and Common::SeekableSubReadStreamEndian::readUint64().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readUint64LE()

uint64 Common::ReadStream::readUint64LE ( )

inline

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

Definition at line 144 of file readstream.h.

References Common::kReadError, and read().

Referenced by Aurora::GFF3Struct::getSint(), Aurora::GFF3Struct::getUint(), readIEEEDoubleLE(), readSint64LE(), Common::MemoryReadStreamEndian::readUint64(), Common::SeekableSubReadStreamEndian::readUint64(), and Aurora::ERFFile::readV30ResList().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ kEOF

const uint32 Common::ReadStream::kEOF = 0xFFFFFFFF

static

Return value for end-of-file.

See readChar().

Definition at line 67 of file readstream.h.

Referenced by Common::StreamTokenizer::findFirstToken(), Common::StreamTokenizer::getToken(), Common::hashStringCRC32(), Common::hashStringDJB2(), Common::hashStringFNV32(), Common::hashStringFNV64(), Common::StreamTokenizer::isChunkEnd(), Common::StreamTokenizer::nextChunk(), readChar(), and Common::StreamTokenizer::skipChunk().

◆ kPositionInvalid

const size_t Common::ReadStream::kPositionInvalid = SIZE_MAX

static

Definition at line 70 of file readstream.h.

Referenced by Common::ReadFile::pos().

◆ kSizeInvalid

const size_t Common::ReadStream::kSizeInvalid = SIZE_MAX

static

Definition at line 69 of file readstream.h.

Referenced by Common::ReadFile::close().

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

src/common/readstream.h
src/common/readstream.cpp

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ReadStream()

◆ ~ReadStream()

Member Function Documentation

◆ eos()

◆ read()

◆ readByte()

◆ readChar()

◆ readIEEEDoubleBE()

◆ readIEEEDoubleLE()

◆ readIEEEFloatBE()

◆ readIEEEFloatLE()

◆ readSByte()

◆ readSint16BE()

◆ readSint16LE()

◆ readSint32BE()

◆ readSint32LE()

◆ readSint64BE()

◆ readSint64LE()

◆ readStream()

◆ readUint16BE()

◆ readUint16LE()

◆ readUint32BE()

◆ readUint32LE()

◆ readUint64BE()

◆ readUint64LE()

Member Data Documentation

◆ kEOF

◆ kPositionInvalid

◆ kSizeInvalid