ZipFile.h

Go to the documentation of this file.

/***************************************************************************
 * Copyright (C) 2009 by Benjamin Hadorn (b_hadorn@bluewin.ch)             *
 ***************************************************************************
 * Projekt : Zeus Base Library
 * Module  : ZipFile
 * Package : System
 * Author  : Benjamin Hadorn
 * Datum   : $Date$
 * Ablage  : $File$
 * System  : Cell Computing Model
 ***************************************************************************
 * Licence:                                                                *
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Lesser General Public License as        *
 *   published by the Free Software Foundation; either version             *
 *   2.1 of the License, or (at your option) any later version.            *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the          *
 *   GNU Lesser General Public License for more details.                   *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA  *
 ***************************************************************************/

/***************************************************************************
 Changes :
 $Log$
***************************************************************************/
//---------------------------------------------------------------------------

#ifndef ZipFileH
#define ZipFileH
//---------------------------------------------------------------------------

#include <zeusbase/Config/PlatformDefines.hpp>
#include <zeusbase/System/File.h>
#include <zeusbase/System/StringList.h>

BEGIN_NAMESPACE_Zeus

class TZipDataSource;
class TZippedFileEntry;

/****************************************************************************/
/****************************************************************************/
zeusbase_class TZipFile : public TFile
{
  public:
    TZipFile(const TString& rFileName);

    //Methods of the zip data source
    Retval addFileEntry(const IString& rEntryName, const IString& rFileName, bool bOverwriteIfExists, Int iZipLevel = 4);
    Retval deleteFileEntry(Int iIndex);
    Retval getFileEntry(Int iIndex, TZippedFileEntry*& rpEntry) const;
    Retval getFileEntryByName(const IString& rEntryName, TZippedFileEntry*& rpEntry) const;
    Int getFileEntryCount() const;
    bool isValid() const;
    Retval removeFileEntry(const IString& rEntryName);

    //file related methods
    void createArchive();
    Retval saveArchive();
    void setPassword(const IString& rPassword);
    Retval unzipAllFiles(const IString& rTargetDirectory,
                         bool bOptUsePath = true,
                         bool bOptOverwrite = false);
    Retval unzipFiles(const IString& rTargetDirectory,
                      const IStringList& lstEntries,
                      bool bOptUsePath = true,
                      bool bOptOverwrite = false);
    Retval unzipSingleFile(const IString& rTargetDirectory,
                           const IString& rFileEntry,
                           bool bOptUsePath = true,
                           bool bOptOverwrite = false);

  protected:
    virtual ~TZipFile();

    void checkOpen() const;
    void close();

  private:
    mutable TZipDataSource* m_pDataSource;
    TString m_strPassword;
};

//INLINE METHODS

/****************************************************************************/
/****************************************************************************/
inline void TZipFile::setPassword(const IString& rPassword)
{
  m_strPassword = rPassword;
}

/****************************************************************************/
/****************************************************************************/
inline Retval TZipFile::unzipSingleFile(const IString& rTargetDirectory,
                                        const IString& rFileEntry,
                                        bool bOptUsePath /*= true*/,
                                        bool bOptOverwrite /*= false*/)
{
  TStringList lstFiles;
  lstFiles.add(rFileEntry);
  return unzipFiles(rTargetDirectory, lstFiles, bOptUsePath, bOptOverwrite);
}


END_NAMESPACE_Zeus

#endif

---

Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Wed Oct 28 21:42:31 2009