Ananas Library  0.9.5
Public Member Functions | Protected Member Functions | List of all members
aContainer Class Reference

#include <acontainer.h>

Inheritance diagram for aContainer:

Public Member Functions

 aContainer ()
 
 aContainer (const QString &name)
 
virtual ~aContainer ()
 
virtual bool open ()
 
virtual bool open (const QString &name)
 
virtual void create ()
 
virtual void close ()
 
virtual bool save ()
 
virtual bool save (const QString &name)
 
virtual bool addFile (const QString &filename, const QString &newname, int type)
 
virtual QString realPath (const QString &fname) const
 
virtual QString lastError () const
 
void setLastError (const QString &errorText)
 
QString getFileContent (const QString &fileName) const
 

Protected Member Functions

void generateName4TmpDir ()
 
bool createTmpDir ()
 
bool extractManifest (const QString &archName, aCManifest *mf)
 
bool extractData (const QString &archName)
 
bool compressFile (const QString &fileName)
 
void cleanupTmpFiles ()
 

Detailed Description

Class for work with data container

Constructor & Destructor Documentation

◆ aContainer() [1/2]

aContainer::aContainer ( )

Constructor

◆ aContainer() [2/2]

aContainer::aContainer ( const QString &  name)

Constructor with name

◆ ~aContainer()

aContainer::~aContainer ( )
virtual

Destructor

Member Function Documentation

◆ addFile()

bool aContainer::addFile ( const QString &  filename,
const QString &  newname,
int  type 
)
virtual

Add specified file to container.

Parameters
filename- fully specified file name
newname- relative file name in container. Should be relative at container root. e.g. "forms/form111.ui"
type- type of file. See aCManifest class description for details.
Returns
true if success

References aCManifest::addEntry(), and aLog::print().

◆ cleanupTmpFiles()

void aContainer::cleanupTmpFiles ( )
protected

Clean templorary files.

References aCManifest::first(), aCManifest::next(), and aLog::print().

Referenced by close(), and open().

◆ close()

void aContainer::close ( )
virtual

Closes container. Don't save anything.

References cleanupTmpFiles().

Referenced by open().

◆ compressFile()

bool aContainer::compressFile ( const QString &  fileName)
protected

Zip one file to container. THE FUNCTION DOSEN'T WORK!

Parameters
fileName- container relative file name to zip.
Returns
true if success

References aLog::print(), and setLastError().

Referenced by save().

◆ create()

void aContainer::create ( )
virtual

Create new empty container.

References aCManifest::create(), createTmpDir(), and generateName4TmpDir().

◆ createTmpDir()

bool aContainer::createTmpDir ( )
protected

Creates new temporary directory.

Returns
true if success

References aLog::print(), and setLastError().

Referenced by create(), and open().

◆ extractData()

bool aContainer::extractData ( const QString &  archName)
protected

Extracts all files to temporary directory.

Parameters
archName- container name
Returns
true if success

References aLog::print(), and setLastError().

Referenced by open().

◆ extractManifest()

bool aContainer::extractManifest ( const QString &  archName,
aCManifest mf 
)
protected

Extracts manifest file. This file always named META-INF/manifest.xml

Parameters
archName- container name
mf(out) - pointer to manifest.
Returns
true if success

References aLog::print(), aCManifest::read(), and setLastError().

Referenced by open().

◆ generateName4TmpDir()

void aContainer::generateName4TmpDir ( )
protected

Generates new name for temporary directory.

Referenced by create(), and open().

◆ lastError()

QString aContainer::lastError ( ) const
virtual

Get last error text.

Returns
errorText - error text.
See also
aContainer::setLastError(const QString& errorText)

◆ open() [1/2]

bool aContainer::open ( )
virtual

Opens file. You should set name before (in constructor) or use aContainer::open(const QString& name)

Returns
true if success, false otherwise

◆ open() [2/2]

bool aContainer::open ( const QString &  name)
virtual

Opens file. You should set name before (in constructor) or use aContainer::open(const QString& name)

Parameters
name- file name
Returns
true if success, false otherwise

References cleanupTmpFiles(), close(), createTmpDir(), extractData(), extractManifest(), generateName4TmpDir(), and aLog::print().

◆ realPath()

QString aContainer::realPath ( const QString &  fname) const
virtual

Return real path to specified file.

Parameters
fname- container relative filename.
Returns
real path to file.

◆ save() [1/2]

bool aContainer::save ( )
virtual

Function for save container. File name to save should be setted before call this function in constructor or aContainer::open(const QString& name)

Returns
true if success
See also
aContainer::save(const QString& name)

◆ save() [2/2]

bool aContainer::save ( const QString &  name)
virtual

Saves container. Only files described in manifest will be saved.

Parameters
name- File name
Returns
true if success

References compressFile(), aCManifest::first(), aCManifest::next(), aLog::print(), and setLastError().

◆ setLastError()

void aContainer::setLastError ( const QString &  errorText)

Set last error text.

Parameters
errorText- error text.
See also
aContainer::lastError()

Referenced by compressFile(), createTmpDir(), extractData(), extractManifest(), and save().


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