ScummVM API documentation
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
Tetraedge::ObbArchive Class Reference
Inheritance diagram for Tetraedge::ObbArchive:
Common::Archive

Classes

struct  FileDescriptor
 

Public Types

typedef Common::HashMap< Common::String, FileDescriptor, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo > FileMap
 
- Public Types inherited from Common::Archive
enum  ListMode { kListFilesOnly = 1, kListDirectoriesOnly = 2, kListAll = 3 }
 

Public Member Functions

bool hasFile (const Common::Path &path) const override
 
int listMembers (Common::ArchiveMemberList &) const override
 
const Common::ArchiveMemberPtr getMember (const Common::Path &path) const override
 
Common::SeekableReadStream * createReadStreamForMember (const Common::Path &path) const override
 
- Public Member Functions inherited from Common::Archive
virtual bool isPathDirectory (const Path &path) const
 
virtual int listMatchingMembers (ArchiveMemberList &list, const Path &pattern, bool matchPathComponents=false) const
 
virtual SeekableReadStream * createReadStreamForMemberAltStream (const Path &path, AltStreamType altStreamType) const
 
virtual SeekableReadStream * createReadStreamForMemberNext (const Path &path, const Archive *starting) const
 
Common::Error dumpArchive (const Path &destPath)
 
virtual char getPathSeparator () const
 
virtual bool getChildren (const Common::Path &path, Common::Array< Common::String > &list, ListMode mode=kListDirectoriesOnly, bool hidden=true) const
 

Static Public Member Functions

static bool readFileMap (Common::SeekableReadStream &indexFile, FileMap &files)
 
static ObbArchive * open (const Common::Path &obbName)
 

Member Function Documentation

◆ hasFile()

bool Tetraedge::ObbArchive::hasFile ( const Common::Path &  path) const
overridevirtual

Check if a member with the given name is present in the Archive. Patterns are not allowed, as this is meant to be a quick File::exists() replacement. This returns "true" for both files and directories.

Implements Common::Archive.

◆ listMembers()

int Tetraedge::ObbArchive::listMembers ( Common::ArchiveMemberList &  list) const
overridevirtual

Add all members of the Archive to the list. Must only append to list, and not remove elements from it.

Returns
The number of names added to list.

Implements Common::Archive.

◆ getMember()

const Common::ArchiveMemberPtr Tetraedge::ObbArchive::getMember ( const Common::Path &  path) const
overridevirtual

Return an ArchiveMember representation of the given file.

Implements Common::Archive.

◆ createReadStreamForMember()

Common::SeekableReadStream* Tetraedge::ObbArchive::createReadStreamForMember ( const Common::Path &  path) const
overridevirtual

Create a stream bound to a member with the specified name in the archive. If no member with this name exists, 0 is returned.

Returns
The newly created input stream.

Implements Common::Archive.

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