ScummVM API documentation
Scumm::ScummNESFile Class Reference
Inheritance diagram for Scumm::ScummNESFile:
Scumm::BaseScummFile Common::SeekableReadStream Common::ReadStream Common::Stream

Public Types

enum  ROMset {
  kROMsetUSA, kROMsetEurope, kROMsetSweden, kROMsetFrance,
  kROMsetGermany, kROMsetSpain, kROMsetItaly, kROMsetNum
}
 
enum  ResType {
  NES_UNKNOWN, NES_GLOBDATA, NES_ROOM, NES_SCRIPT,
  NES_SOUND, NES_COSTUME, NES_ROOMGFX, NES_COSTUMEGFX,
  NES_SPRPALS, NES_SPRDESC, NES_SPRLENS, NES_SPROFFS,
  NES_SPRDATA, NES_CHARSET, NES_PREPLIST
}
 

Public Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from Scumm::BaseScummFile
byte _encbyte
 
Common::ScopedPtr< Common::SeekableReadStream_baseStream
 
Common::String _debugName
 

Member Function Documentation

◆ eos()

bool Scumm::ScummNESFile::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.

◆ pos()

int64 Scumm::ScummNESFile::pos ( ) const
inlineoverridevirtual

Obtain the current value of the stream position indicator.

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

Implements Scumm::BaseScummFile.

◆ size()

int64 Scumm::ScummNESFile::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 Scumm::BaseScummFile.

◆ seek()

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

Implements Scumm::BaseScummFile.

◆ read()

uint32 Scumm::ScummNESFile::read ( void *  dataPtr,
uint32  dataSize 
)
overridevirtual

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.


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