Scumm::BaseScummFile Class Reference

Inheritance diagram for Scumm::BaseScummFile:

Public Member Functions
void	setEnc (byte value)
virtual bool	open (const Common::Path &filename)=0
virtual bool	openSubFile (const Common::Path &filename)=0
virtual void	close ()
int64	pos () const override=0
int64	size () const override=0
bool	seek (int64 offs, int whence=SEEK_SET) override=0
Common::String	getDebugName () const
bool	isOpen () const
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
virtual bool	eos () const =0
virtual uint32	read (void *dataPtr, uint32 dataSize)=0
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
virtual void	clearErr ()

Protected Attributes
byte	_encbyte
Common::ScopedPtr< Common::SeekableReadStream >	_baseStream
Common::String	_debugName

Member Function Documentation

pos()

int64 Scumm::BaseScummFile::pos ( ) const

overridepure virtual

Obtain the current value of the stream position indicator.

Returns

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

Implements Common::SeekableReadStream.

Implemented in Scumm::ScummDiskImage, Scumm::ScummNESFile, and Scumm::ScummFile.

size()

int64 Scumm::BaseScummFile::size ( ) const

overridepure virtual

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.

Implemented in Scumm::ScummDiskImage, Scumm::ScummNESFile, and Scumm::ScummFile.

seek()

bool Scumm::BaseScummFile::seek ( int64  offset, int  whence = SEEK_SET  )

overridepure 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

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.

Implemented in Scumm::ScummDiskImage, Scumm::ScummNESFile, and Scumm::ScummFile.

---

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

• engines/scumm/file.h