ScummVM API documentation
Xeen::File Class Reference

#include <files.h>

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

Public Member Functions

 File (const Common::String &filename)
 
 File (const Common::String &filename, int ccMode)
 
 File (const Common::String &filename, Common::Archive &archive)
 
bool open (const Common::Path &filename) override
 
bool open (const Common::Path &filename, Common::Archive &archive) override
 
virtual bool open (const Common::String &filename, int ccMode)
 
bool open (const Common::FSNode &node) override
 
bool open (SeekableReadStream *stream, const Common::String &name) override
 
Common::String readString ()
 
- Public Member Functions inherited from Common::File
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 ()
 
SeekableReadStreamreadStream (uint32 dataSize)
 
String readString (char terminator=0, size_t len=String::npos)
 
Common::String readPascalString (bool transformCR=true)
 

Static Public Member Functions

static void setCurrentArchive (int ccMode)
 
static void syncBitFlags (Common::Serializer &s, bool *startP, bool *endP)
 
static bool exists (const Common::String &filename)
 
static bool exists (const Common::String &filename, int ccMode)
 
static bool exists (const Common::String &filename, Common::Archive &archive)
 
- Static Public Member Functions inherited from Common::File
static bool exists (const Path &filename)
 

Additional Inherited Members

- Protected Attributes inherited from Common::File
SeekableReadStream_handle
 
String _name
 

Detailed Description

Derived file class

Member Function Documentation

◆ setCurrentArchive()

static void Xeen::File::setCurrentArchive ( int  ccMode)
static

Sets which archive is used by default

◆ syncBitFlags()

static void Xeen::File::syncBitFlags ( Common::Serializer s,
bool *  startP,
bool *  endP 
)
static

Synchronizes a boolean array as a bitfield set

◆ open() [1/5]

bool Xeen::File::open ( const Common::Path filename)
overridevirtual

Opens the given file, throwing an error if it can't be opened

Reimplemented from Common::File.

◆ open() [2/5]

bool Xeen::File::open ( const Common::Path filename,
Common::Archive archive 
)
overridevirtual

Opens the given file, throwing an error if it can't be opened

Reimplemented from Common::File.

◆ open() [3/5]

virtual bool Xeen::File::open ( const Common::String filename,
int  ccMode 
)
virtual

Opens the given file, throwing an error if it can't be opened

◆ open() [4/5]

bool Xeen::File::open ( const Common::FSNode node)
inlineoverridevirtual

Opens the given file

Reimplemented from Common::File.

◆ open() [5/5]

bool Xeen::File::open ( SeekableReadStream *  stream,
const Common::String name 
)
inlineoverride

Opens the given file

◆ readString()

Common::String Xeen::File::readString ( )

Reads in a null terminated string

◆ exists() [1/3]

static bool Xeen::File::exists ( const Common::String filename)
static

Checks if a given file exists

Parameters
filenamethe file to check for
Returns
true if the file exists, false otherwise

◆ exists() [2/3]

static bool Xeen::File::exists ( const Common::String filename,
int  ccMode 
)
static

Checks if a given file exists

Parameters
filenamethe file to check for
ccModeArchive to use
Returns
true if the file exists, false otherwise

◆ exists() [3/3]

static bool Xeen::File::exists ( const Common::String filename,
Common::Archive archive 
)
static

Checks if a given file exists

Parameters
filenamethe file to check for
archiveArchive to use
Returns
true if the file exists, false otherwise

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