ScummVM API documentation
Public Member Functions | List of all members
Titanic::File Class Reference

#include <simple_file.h>

Inheritance diagram for Titanic::File:
Common::File Common::SeekableReadStream Common::NonCopyable Common::ReadStream Common::Stream

Public Member Functions

bool open (const Common::Path &filename) override
 
- Public Member Functions inherited from Common::File
virtual bool open (const Path &filename, Archive &archive)
 
virtual bool open (const FSNode &node)
 
virtual bool open (SeekableReadStream *stream, const String &name)
 
virtual void close ()
 
bool isOpen () const
 
const char * getName () const
 
bool err () const override
 
void clearErr () 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 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)
 

Additional Inherited Members

- Static Public Member Functions inherited from Common::File
static bool exists (const Path &filename)
 
- Protected Attributes inherited from Common::File
SeekableReadStream * _handle
 
String _name
 

Detailed Description

Simple ScummVM File descendent that throws a wobbly if the file it tries to open isn't present

Member Function Documentation

◆ open()

bool Titanic::File::open ( const Common::Path &  filename)
overridevirtual

Try to open the file with the given file name, by searching SearchMan.

Note
Must not be called if this file is already open (i.e. if isOpen returns true).
Parameters
filenameName of the file to open.
Returns
True if the file was opened successfully, false otherwise.

Reimplemented from Common::File.

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