mi32/zipfile.h

Go to the documentation of this file.

/******************************************************************************
 * mi32/zipfile.h - Class for working with .zip files
 *  \if NODOC
 *  $Log: zipfile.h_v $
 *  Revision 1.9  2010/04/29 21:27:16  bcolombe
 *  Added GetNext, Find, OpenCurrent
 *
 *  Revision 1.8  2010/04/13 22:05:28  bcolombe
 *  Added includedirectory option for adddirectory
 *
 *  Revision 1.7  2010/04/07 19:43:53  bcolombe
 *  Added Unzip
 *
 *  Revision 1.6  2009/05/07 22:24:44  bcolombe
 *  Added OpenInZip
 *  This method only creates new file in zip
 *  zipfile must be open for write
 *
 *  Revision 1.5  2009/03/17 21:47:34  bcolombe
 *  AddFile now can also take the name you want the file ot have in the zipfile
 *
 *  Revision 1.4  2009/03/16 17:39:17  bcolombe
 *  AddFile and AddDirectory added
 *
 *  Revision 1.3  2007/06/08 23:56:08  ldyas
 *  added method for setting compression rating.
 *
 *  Revision 1.2  2007/06/07 14:47:16  dwilliss
 *  fixed documentation.
 *
 *  Revision 1.1  2007/02/15 18:00:18  dwilliss
 *  Initial revision
 *
 *  \endif
 **/

#ifndef INC_MI32_ZIPFILE_H
#define INC_MI32_ZIPFILE_H


#ifndef INC_MI32_GENERICRW_H
#include <mi32/genericrw.h>
#endif

#ifndef INC_MI32_FILEACCESS_H
#include <mi32/fileaccess.h>
#endif

class FILEPATH;
class MISTRING;
class MISTRINGLIST;
class FILEPATHLIST;

class ZIPFILE : public GENERICRW{
   public:
      ZIPFILE();
      ~ZIPFILE();

      ERRVALUE AddDirectory (
         const FILEPATH& zippath,      
         const FILEPATH& directory,    
         bool DoSubDirectories = false,   
         bool DoDeleteFiles = false,      
         bool IncludeDirectory = false 
         );

      ERRVALUE AddFile (
         const FILEPATH& zippath,      
         const FILEPATH& filepath,     
         bool DoDeleteFiles = false    
         );

      ERRVALUE AddFile (
         const FILEPATH& zippath,      
         const FILEPATH& filepath,     
         const MISTRING& name,         
         bool DoDeleteFiles = false    
         );

      ERRVALUE GetFileList (
         MISTRINGLIST& FileNameList
         );

      ERRVALUE GetGlobalComment (
         MISTRING& comment
         );
      
      ERRVALUE Open (
         const FILEPATH& filepath,
         FILE_ACCESS access = FILE_ACCESS_Read,
         FILE_SHARE share = FILE_SHARE_Any
         );

      ERRVALUE Open (
         const FILEPATH& filepath,
         const MISTRING& filename,     
         const char* password = 0,     
         FILE_ACCESS access = FILE_ACCESS_Read,
         FILE_SHARE share = FILE_SHARE_Any
         );
 
      ERRVALUE OpenInZip (
         const MISTRING& filename      
         );

      bool Find (
         const MISTRING& filename      
         );

      MISTRING GetNext () const;

      ERRVALUE OpenCurrentFile ();

      void SetCompression (
         int compression = 9 
         );

      ERRVALUE Unzip (
         const FILEPATH& filepath,  
         const FILEPATH& output,    
         bool bDeleteAfterUnzip     
         );

      void Close ();

#ifndef GENERATING_DOXYGEN_OUTPUT
   private:
      class PRIV;
      PRIV *m_priv;

      virtual CAPABILITIES v_GetCapabilities() const;
      virtual INT64 v_GetSize() const;
      virtual INT64 v_GetSizeLimit() const;
      virtual INT32 v_Read(void*, INT32, bool);
      virtual ERRVALUE v_Resize(INT64);
      virtual INT64 v_Seek(INT64, SEEKFROM);
      virtual INT64 v_Tell() const;
      virtual ERRVALUE v_Write(const void*, INT32);
#endif

   };


#endif // INC_MI32_ZIPFILE_H

---