Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::Zip Class Reference

#include <OgreZip.h>

Inheritance diagram for Ogre::Zip:

Ogre::ArchiveEx Ogre::Resource List of all members.

Public Methods

 Zip ()
 Zip (const String &name)
 ~Zip ()
void load ()
 Loads the archive. More...

void unload ()
 Unloads the archive. More...

bool fileOpen (const String &strFile, FILE **ppFile) const
bool fileRead (const String &strFile, DataChunk **ppChunk) const
 Reads the contents of a file within the archive and copies it in the passed DataChunk. More...

bool fileSave (FILE *pFile, const String &strPath, bool bOverwrite=false)
 Creates a new file in the archive and copies in it the contents of the file associated with the passed FILE stream. More...

bool fileWrite (const DataChunk &refChunk, const String &strPath, bool bOverwrite=false)
 Creates a new file in the archive and copies in it the contents of the passed DataChunk. More...

bool fileDele (const String &strFile)
 Deletes a file from the archive. More...

bool fileMove (const String &strSrc, const String &strDest, bool bOverwrite)
 Moves a file within the archive. More...

bool fileInfo (const String &strFile, FileInfo **ppInfo) const
 Retrieves information about a file within the archive. More...

bool fileCopy (const String &strSrc, const String &strDest, bool bOverwrite)
 Copies a file within the archive. More...

bool fileTest (const String &strFile) const
 Tests wheter a file within the archive can be succesfully read. More...

std::vector< String > dirGetFiles (const String &strDir) const
 Finds the names of all the files within a directory inside the archive. More...

std::vector< String > dirGetSubs (const String &strDir) const
 Finds the names of all the subdirectories within a directory inside the archive. More...

bool dirDele (const String &strDir, bool bRecursive)
 Deletes a directory from the archive. More...

bool dirMove (const String &strSrc, const String &strDest, bool bOverwrite)
bool dirInfo (const String &strDir, FileInfo **ppInfo) const
bool dirCopy (const String &strSrc, const String &strDest, bool bOverwrite)
bool dirTest (const String &strDir) const
std::vector< String > getAllNamesLike (const String &strStartPath, const String &strPattern, bool bRecursive=true)
bool _allowFileCaching () const
 This function gets called by the resource manager to know if it is okay to cahche all the files in the achive. More...

virtual size_t getSize (void)
 Retrieves info about the size of the resource. More...

void touch (void)
 'Touches' the resource to indicate it has been used. More...

time_t getLastAccess (void) const
 Gets the last time the resource was 'touched'. More...

const String & getName (void) const
 Gets resource name. More...

bool isLoaded (void) const
 Returns true if the Resource has been loaded, false otherwise. More...

virtual void destroy ()
 A method to make the resource delete itself. More...


Protected Attributes

String mName
bool mIsLoaded
time_t mLastAccess
size_t mSize

Private Attributes

unzFile mArchive

Constructor & Destructor Documentation

Ogre::Zip::Zip (    ) 
 

Ogre::Zip::Zip (  const String &    name ) 
 

Ogre::Zip::~Zip (    ) 
 

Member Function Documentation

bool Ogre::Zip::_allowFileCaching (    )  const [inline, virtual]
 

This function gets called by the resource manager to know if it is okay to cahche all the files in the achive.

Remarks:
Allowing file caching may not always be a very good idea. For example, caching all the files on a distant web server would work very slowly.
Since:
29.04.2002

Implements Ogre::ArchiveEx.

virtual void Ogre::Resource::destroy (  void    )  [inline, virtual, inherited]
 

A method to make the resource delete itself.

Note:
This exists because Resource objects could be created in other processes, and they need to be destroyed in the process that created them.

bool Ogre::Zip::dirCopy (  const String &    strSrc,
const String &    strDest,
bool    bOverwrite
)  [virtual]
 

Implements Ogre::ArchiveEx.

bool Ogre::Zip::dirDele (  const String &    strDir,
bool    bRecursive
)  [virtual]
 

Deletes a directory from the archive.

Parameters:
strDir  The path to the directory to delete.
bRecursive  If set to true, all the subdirectories of the given directory will also be deleted.
Returns:
If the function succeeds, true is returned.

If the function fails, false is returned.

Note:

If the directory contains other subdirectories, and the bRecursive parameter is set to false, only the files in the current directory are deleted and the directory will not be removed.

Implements Ogre::ArchiveEx.

std::vector< String > Ogre::Zip::dirGetFiles (  const String &    strDir )  const [virtual]
 

Finds the names of all the files within a directory inside the archive.

Parameters:
strDir  The directory's path.
Returns:
A StringVector containing all the files.

Implements Ogre::ArchiveEx.

std::vector< String > Ogre::Zip::dirGetSubs (  const String &    strDir )  const [virtual]
 

Finds the names of all the subdirectories within a directory inside the archive.

Parameters:
strDir  The directory's path.
Returns:
A StringVector containing the names of all the subdirectories.

Implements Ogre::ArchiveEx.

bool Ogre::Zip::dirInfo (  const String &    strDir,
FileInfo **    ppInfo
)  const [virtual]
 

Implements Ogre::ArchiveEx.

bool Ogre::Zip::dirMove (  const String &    strSrc,
const String &    strDest,
bool    bOverwrite
)  [virtual]
 

Implements Ogre::ArchiveEx.

bool Ogre::Zip::dirTest (  const String &    strDir )  const [virtual]
 

Implements Ogre::ArchiveEx.

bool Ogre::Zip::fileCopy (  const String &    strSrc,
const String &    strDest,
bool    bOverwrite
)  [virtual]
 

Copies a file within the archive.

Parameters:
strSrc  The source file.
strDest  The destination path.
bOverwrite  If set to true, a file with the same name already exists at the destination and appending or deleting is possible, the old file is deleted and a new one containing the new data is created.
Returns:
If the function succeeds, true is returned.

If the function fails, false is returned.

Implements Ogre::ArchiveEx.

bool Ogre::Zip::fileDele (  const String &    strFile )  [virtual]
 

Deletes a file from the archive.

Parameters:
strFile  The name of the file te be deleted.
Returns:
If the function succeeds, true is returned.

If the function fails, false is returned.

Implements Ogre::ArchiveEx.

bool Ogre::Zip::fileInfo (  const String &    strFile,
FileInfo **    ppInfo
)  const [virtual]
 

Retrieves information about a file within the archive.

Parameters:
strFile  The name of the file to retrieve information for.
ppInfo  Pointer to the memory address of a FileInfo struct that will be filled with the requested information.
Returns:
If the function succeeds, true is returned.

If the function fails, false is returned.

Implements Ogre::ArchiveEx.

bool Ogre::Zip::fileMove (  const String &    strSrc,
const String &    strDest,
bool    bOverwrite
)  [virtual]
 

Moves a file within the archive.

Parameters:
strSrc  The source file.
strDest  The location within the archive where to move the file.
bOverwrite  If set to true, a file with the same name already exists at the destination and appending or deleting is possible, the old file is deleted and a new one containing the new data is created.
Returns:
If the function succeeds, true is returned.

If the function fails, false is returned.

Implements Ogre::ArchiveEx.

bool Ogre::Zip::fileOpen (  const String &    strFile,
FILE **    ppFile
)  const [virtual]
 

Implements Ogre::ArchiveEx.

bool Ogre::Zip::fileRead (  const String &    strFile,
DataChunk **    ppChunk
)  const [virtual]
 

Reads the contents of a file within the archive and copies it in the passed DataChunk.

Parameters:
strFile  The name of the file to read from the archive.
ppChunk  A pointer to the addres of a DataChunk class that will hold the file's contens.
Returns:
If the function succeeds, true is returned.

If the function fails, false is returned.

Implements Ogre::ArchiveEx.

bool Ogre::Zip::fileSave (  FILE *    pFile,
const String &    strPath,
bool    bOverwrite = false
)  [virtual]
 

Creates a new file in the archive and copies in it the contents of the file associated with the passed FILE stream.

Parameters:
pFile  A valid FILE pointer that holds the file stream information.
strPath  The location inside the archive where the new file will be created.
bOverwrite  If set to true, a file with the same name already exists inside the archive and appending or deleting is possible, the old file is deleted and a new one containing the new data is created.
Returns:
If the function succeeds, true is returned.

If the function fails, false is returned.

Implements Ogre::ArchiveEx.

bool Ogre::Zip::fileTest (  const String &    strFile )  const [virtual]
 

Tests wheter a file within the archive can be succesfully read.

Parameters:
strFile  The name of the file to be tested.
Returns:
If the file can be read, true is returned.

If the file cannot be read, false is returned.

Implements Ogre::ArchiveEx.

bool Ogre::Zip::fileWrite (  const DataChunk &    refChunk,
const String &    strPath,
bool    bOverwrite = false
)  [virtual]
 

Creates a new file in the archive and copies in it the contents of the passed DataChunk.

Parameters:
refChunk  A DataChunk class that contains the data to be written to the new file.
strPath  The location inside the archive where the new file will be created.
bOverwrite  If set to true, a file with the same name already exists inside the archive and appending or deleting is possible, the old file is deleted and a new one containing the new data is created.
Returns:
If the function succeeds, true is returned.

If the function fails, false is returned.

Implements Ogre::ArchiveEx.

StringVector Ogre::Zip::getAllNamesLike (  const String &    strStartPath,
const String &    strPattern,
bool    bRecursive = true
)  [virtual]
 

Implements Ogre::ArchiveEx.

time_t Ogre::Resource::getLastAccess (  void    )  const [inline, inherited]
 

Gets the last time the resource was 'touched'.

const String& Ogre::Resource::getName (  void    )  const [inline, inherited]
 

Gets resource name.

Reimplemented in Ogre::Material.

virtual size_t Ogre::Resource::getSize (  void    )  [inline, virtual, inherited]
 

Retrieves info about the size of the resource.

bool Ogre::Resource::isLoaded (  void    )  const [inline, inherited]
 

Returns true if the Resource has been loaded, false otherwise.

void Ogre::Zip::load (    )  [virtual]
 

Loads the archive.

Remarks:
This initializes all the internal data of the class.
Warning:
Do not call this function directly, it is ment to be used only by the ArchiveManager class.

Implements Ogre::ArchiveEx.

void Ogre::Resource::touch (  void    )  [inline, inherited]
 

'Touches' the resource to indicate it has been used.

void Ogre::Zip::unload (    )  [virtual]
 

Unloads the archive.

Warning:
Do not call this function directly, it is ment to be used only by the ArchiveManager class.

Implements Ogre::ArchiveEx.

Member Data Documentation

unzFile Ogre::Zip::mArchive [private]
 

bool Ogre::Resource::mIsLoaded [protected, inherited]
 

time_t Ogre::Resource::mLastAccess [protected, inherited]
 

String Ogre::Resource::mName [protected, inherited]
 

size_t Ogre::Resource::mSize [protected, inherited]
 

Copyright © 2002 by The OGRE Team