ScummVM API documentation
Classes | Public Member Functions | List of all members
Common::MemoryReadStream Class Reference
Common API » Memory » Memory pool

#include <memstream.h>

Inheritance diagram for Common::MemoryReadStream:
Common::SeekableReadStream Common::ReadStream Common::Stream Common::MemoryReadStreamEndian Lilliput::ScriptStream Saga::ByteArrayReadStreamEndian

Public Member Functions

 MemoryReadStream (MemoryReadStream &&other)
 
 MemoryReadStream (const byte *dataPtr, uint32 dataSize, DisposeAfterUse::Flag disposeMemory=DisposeAfterUse::NO)
 
 MemoryReadStream (SharedPtr< byte > dataPtr, uint32 dataSize)
 
uint32 read (void *dataPtr, uint32 dataSize)
 
bool eos () const
 
void clearErr ()
 
int64 pos () const
 
int64 size () const
 
bool seek (int64 offs, int whence=SEEK_SET)
 
- 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::Stream
virtual bool err () const
 

Detailed Description

Simple memory based 'stream', which implements the ReadStream interface for a plain memory block.

Constructor & Destructor Documentation

◆ MemoryReadStream()

Common::MemoryReadStream::MemoryReadStream ( const byte *  dataPtr,
uint32  dataSize,
DisposeAfterUse::Flag  disposeMemory = DisposeAfterUse::NO 
)
inline

This constructor takes a pointer to a memory buffer and a length, and wraps it. If disposeMemory is true, the MemoryReadStream takes ownership of the buffer and hence free's it when destructed.

Member Function Documentation

◆ read()

uint32 Common::MemoryReadStream::read ( void *  dataPtr,
uint32  dataSize 
)
virtual

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
dataPtrPointer to a buffer into which the data is read.
dataSizeNumber of bytes to be read.
Returns
The number of bytes that were actually read.

Implements Common::ReadStream.

◆ eos()

bool Common::MemoryReadStream::eos ( ) const
inlinevirtual

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.

◆ clearErr()

void Common::MemoryReadStream::clearErr ( )
inlinevirtual

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.

◆ pos()

int64 Common::MemoryReadStream::pos ( ) const
inlinevirtual

Obtain the current value of the stream position indicator.

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

Implements Common::SeekableReadStream.

Reimplemented in Common::MemoryReadStreamEndian.

◆ size()

int64 Common::MemoryReadStream::size ( ) const
inlinevirtual

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.

Reimplemented in Common::MemoryReadStreamEndian.

◆ seek()

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

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
offsetRelative offset in bytes.
whenceSeek reference: SEEK_SET, SEEK_CUR, or SEEK_END.
Returns
True on success, false in case of a failure.

Implements Common::SeekableReadStream.

Reimplemented in Common::MemoryReadStreamEndian.

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