The Nebula Device 3: IO::ZipArchive Class Reference

The Nebula Device 3

IO::ZipArchive Class Reference

#include <ziparchive.h>

Inheritance diagram for IO::ZipArchive:

IO::ArchiveBase Core::RefCounted IO::Archive

Detailed Description

Private helper class for ZipFileSystem to hold per-Zip-archive data. Uses the zlib and the minizip lib for zip file access.

Multithreading: access to zlib archives needs to be serialized. A ZipArchive objects contains a critical section which it will hand down to ZipFileEntry objects.

(C) 2006 Radon Labs GmbH

Public Member Functions

 ZipArchive ()
 constructor
virtual ~ZipArchive ()
 destructor
bool Setup (const URI &uri)
 setup the archive from an URI
void Discard ()
 discard the archive
Util::Array< Util::StringListFiles (const Util::String &dirPathInArchive, const Util::String &pattern) const
 list all files in a directory in the archive
Util::Array< Util::StringListDirectories (const Util::String &dirPathInArchive, const Util::String &pattern) const
 list all subdirectories in a directory in the archive
URI ConvertToArchiveURI (const URI &fileURI) const
 convert a "file:" URI into a "zip:" URI pointing into this archive
Util::String ConvertToPathInArchive (const Util::String &absPath) const
 convert an absolute path to local path inside archive, returns empty string if absPath doesn't point into this archive
bool IsValid () const
 return true if archive is valid
const URIGetURI () const
 get the URI of the archive
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Member Function Documentation

bool IO::ZipArchive::Setup ( const URI zipFileURI  ) 

setup the archive from an URI

This opens the zip archive and reads the table of content as a tree of ZipDirEntry and ZipFileEntry objects.

Reimplemented from IO::ArchiveBase.

void IO::ZipArchive::Discard (  ) 

discard the archive

This closes the zip archive, releasing the table of contents and closing the zip file.

Reimplemented from IO::ArchiveBase.

URI IO::ZipArchive::ConvertToArchiveURI ( const URI fileURI  )  const

convert a "file:" URI into a "zip:" URI pointing into this archive

This method takes a normal "file:" scheme URI and convertes it into a "zip:" scheme URI which points to the file in this zip archive. This is used by the IoServer for transparent file access into zip archives.

Reimplemented from IO::ArchiveBase.

String IO::ZipArchive::ConvertToPathInArchive ( const Util::String absPath  )  const

convert an absolute path to local path inside archive, returns empty string if absPath doesn't point into this archive

Test if an absolute path points into the zip archive and return a locale path into the zip archive. This will not test, whether the file or directory inside the zip archive actually exists, only if the path points INTO the zip archive by checking against the location directory of the zip archive.

Reimplemented from IO::ArchiveBase.

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.