ScummVM API documentation
Ultima::Ultima8::U8SaveFile Class Reference
Inheritance diagram for Ultima::Ultima8::U8SaveFile:
Common::Archive

Classes

struct  FileEntry
 

Public Member Functions

 U8SaveFile (Common::SeekableReadStream *rs)
 
bool isValid () const
 Check if constructed object is indeed a valid archive.
 
bool hasFile (const Common::Path &path) const override
 
int listMembers (Common::ArchiveMemberList &list) const override
 
const Common::ArchiveMemberPtr getMember (const Common::Path &path) const override
 
Common::SeekableReadStreamcreateReadStreamForMember (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 SeekableReadStreamcreateReadStreamForMemberAltStream (const Path &path, AltStreamType altStreamType) const
 
virtual SeekableReadStreamcreateReadStreamForMemberNext (const Path &path, const Archive *starting) const
 
Common::Error dumpArchive (const Path &destPath)
 
virtual char getPathSeparator () const
 

Static Public Member Functions

static bool isU8SaveFile (Common::SeekableReadStream *rs)
 

Protected Types

typedef Common::HashMap< Common::String, FileEntry, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualToU8SaveFileMap
 

Protected Attributes

Common::SeekableReadStream_rs
 
bool _valid
 
U8SaveFileMap _map
 

Constructor & Destructor Documentation

◆ U8SaveFile()

Ultima::Ultima8::U8SaveFile::U8SaveFile ( Common::SeekableReadStream rs)
explicit

create U8SaveFile from datasource; U8SaveFile takes ownership of ds and deletes it when destructed

Member Function Documentation

◆ hasFile()

bool Ultima::Ultima8::U8SaveFile::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 Ultima::Ultima8::U8SaveFile::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 Ultima::Ultima8::U8SaveFile::getMember ( const Common::Path path) const
overridevirtual

Return an ArchiveMember representation of the given file.

Implements Common::Archive.

◆ createReadStreamForMember()

Common::SeekableReadStream* Ultima::Ultima8::U8SaveFile::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: