ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Stark::Formats::XARCArchive Class Reference

#include <xarc.h>

Inheritance diagram for Stark::Formats::XARCArchive:
Collaboration diagram for Stark::Formats::XARCArchive:

List of all members.

Public Member Functions

bool open (const Common::String &filename)
Common::String getFilename () const
bool hasFile (const Common::String &name) const
 Check if a member with the given name is present in the Archive.
int listMatchingMembers (Common::ArchiveMemberList &list, const Common::String &pattern) const
 Add all members of the Archive matching the specified pattern to list.
int listMembers (Common::ArchiveMemberList &list) const
 Add all members of the Archive to list.
const Common::ArchiveMemberPtr getMember (const Common::String &name) const
 Returns a ArchiveMember representation of the given file.
Common::SeekableReadStreamcreateReadStreamForMember (const Common::String &name) const
 Create a stream bound to a member with the specified name in the archive.
Common::SeekableReadStreamcreateReadStreamForMember (const XARCMember *member) const

Private Attributes

Common::String _filename
Common::ArchiveMemberList _members

Detailed Description

Definition at line 34 of file xarc.h.


Member Function Documentation

Common::SeekableReadStream * Stark::Formats::XARCArchive::createReadStreamForMember ( const Common::String name  )  const [virtual]

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.

Definition at line 184 of file xarc.cpp.

Common::SeekableReadStream * Stark::Formats::XARCArchive::createReadStreamForMember ( const XARCMember member  )  const

Definition at line 196 of file xarc.cpp.

Common::String Stark::Formats::XARCArchive::getFilename (  )  const

Definition at line 132 of file xarc.cpp.

const Common::ArchiveMemberPtr Stark::Formats::XARCArchive::getMember ( const Common::String name  )  const [virtual]

Returns a ArchiveMember representation of the given file.

Implements Common::Archive.

Definition at line 172 of file xarc.cpp.

bool Stark::Formats::XARCArchive::hasFile ( const Common::String name  )  const [virtual]

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.

Implements Common::Archive.

Definition at line 136 of file xarc.cpp.

int Stark::Formats::XARCArchive::listMatchingMembers ( Common::ArchiveMemberList list,
const Common::String pattern 
) const [virtual]

Add all members of the Archive matching the specified pattern to list.

Must only append to list, and not remove elements from it.

Returns:
the number of members added to list

Reimplemented from Common::Archive.

Definition at line 148 of file xarc.cpp.

int Stark::Formats::XARCArchive::listMembers ( Common::ArchiveMemberList list  )  const [virtual]

Add all members of the Archive to list.

Must only append to list, and not remove elements from it.

Returns:
the number of names added to list

Implements Common::Archive.

Definition at line 161 of file xarc.cpp.

bool Stark::Formats::XARCArchive::open ( const Common::String filename  ) 

Definition at line 98 of file xarc.cpp.


Member Data Documentation

Definition at line 49 of file xarc.h.


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


Generated on Sat Jul 20 2019 05:03:32 for ResidualVM by doxygen 1.7.1
curved edge   curved edge