src/common/unzip.h

   1 /*
   2
   3 This file was altered for needs of wxWindows.
   4 $Id$
   5
   6 */
   7
   8 /* unzip.h -- IO for uncompress .zip files using zlib
   9    Version 0.15 beta, Mar 19th, 1998,
  10
  11    Copyright (C) 1998 Gilles Vollant
  12
  13    This unzip package allow extract file from .ZIP file, compatible with PKZip 2.04g
  14      WinZip, InfoZip tools and compatible.
  15    Encryption and multi volume ZipFile (span) are not supported.
  16    Old compressions used by old PKZip 1.x are not supported
  17
  18    THIS IS AN ALPHA VERSION. AT THIS STAGE OF DEVELOPPEMENT, SOMES API OR STRUCTURE
  19    CAN CHANGE IN FUTURE VERSION !!
  20    I WAIT FEEDBACK at mail info@winimage.com
  21    Visit also http://www.winimage.com/zLibDll/unzip.htm for evolution
  22
  23    Condition of use and distribution are the same than zlib :
  24
  25   This software is provided 'as-is', without any express or implied
  26   warranty.  In no event will the authors be held liable for any damages
  27   arising from the use of this software.
  28
  29   Permission is granted to anyone to use this software for any purpose,
  30   including commercial applications, and to alter it and redistribute it
  31   freely, subject to the following restrictions:
  32
  33   1. The origin of this software must not be misrepresented; you must not
  34      claim that you wrote the original software. If you use this software
  35      in a product, an acknowledgment in the product documentation would be
  36      appreciated but is not required.
  37   2. Altered source versions must be plainly marked as such, and must not be
  38      misrepresented as being the original software.
  39   3. This notice may not be removed or altered from any source distribution.
  40
  41
  42 */
  43 /* for more info about .ZIP format, see
  44       ftp://ftp.cdrom.com/pub/infozip/doc/appnote-970311-iz.zip
  45    PkWare has also a specification at :
  46       ftp://ftp.pkware.com/probdesc.zip */
  47
  48 #ifndef _unz_H
  49 #define _unz_H
  50
  51 #ifdef __cplusplus
  52 extern "C" {
  53 #endif
  54
  55 #ifndef _ZLIB_H
  56 //#include "zlib.h"
  57 // normally, the compiler options should contain -I../zlib, but it is
  58 // apparently not the case for all MSW makefiles and so, unless we use
  59 // configure (which defines __WX_SETUP_H__) or it is explicitly overridden by
  60 // the user (who can define wxUSE_ZLIB_H_IN_PATH), we hardcode the path here
  61 #if defined(__WXMSW__) && !defined(__WX_SETUP_H__) && !defined(wxUSE_ZLIB_H_IN_PATH)
  62    #include "../zlib/zlib.h"
  63 #else
  64    #include "zlib.h"
  65 #endif
  66 #endif
  67
  68 #if defined(STRICTUNZIP) || defined(STRICTZIPUNZIP)
  69 /* like the STRICT of WIN32, we define a pointer that cannot be converted
  70     from (void*) without cast */
  71 typedef struct TagunzFile__ { int unused; } unzFile__;
  72 typedef unzFile__ *unzFile;
  73 #else
  74 typedef voidp unzFile;
  75 #endif
  76
  77
  78 #define UNZ_OK                                  (0)
  79 #define UNZ_END_OF_LIST_OF_FILE (-100)
  80 #define UNZ_ERRNO               (Z_ERRNO)
  81 #define UNZ_EOF                 (0)
  82 #define UNZ_PARAMERROR                  (-102)
  83 #define UNZ_BADZIPFILE                  (-103)
  84 #define UNZ_INTERNALERROR               (-104)
  85 #define UNZ_CRCERROR                    (-105)
  86
  87 /* tm_unz contain date/time info */
  88 typedef struct tm_unz_s
  89 {
  90         uInt tm_sec;            /* seconds after the minute - [0,59] */
  91         uInt tm_min;            /* minutes after the hour - [0,59] */
  92         uInt tm_hour;           /* hours since midnight - [0,23] */
  93         uInt tm_mday;           /* day of the month - [1,31] */
  94         uInt tm_mon;            /* months since January - [0,11] */
  95         uInt tm_year;           /* years - [1980..2044] */
  96 } tm_unz;
  97
  98 /* unz_global_info structure contain global data about the ZIPfile
  99    These data comes from the end of central dir */
 100 typedef struct unz_global_info_s
 101 {
 102         uLong number_entry;         /* total number of entries in
 103                                        the central dir on this disk */
 104         uLong size_comment;         /* size of the global comment of the zipfile */
 105 } unz_global_info;
 106
 107
 108 /* unz_file_info contain information about a file in the zipfile */
 109 typedef struct unz_file_info_s
 110 {
 111     uLong version;              /* version made by                 2 bytes */
 112     uLong version_needed;       /* version needed to extract       2 bytes */
 113     uLong flag;                 /* general purpose bit flag        2 bytes */
 114     uLong compression_method;   /* compression method              2 bytes */
 115     uLong dosDate;              /* last mod file date in Dos fmt   4 bytes */
 116     uLong crc;                  /* crc-32                          4 bytes */
 117     uLong compressed_size;      /* compressed size                 4 bytes */
 118     uLong uncompressed_size;    /* uncompressed size               4 bytes */
 119     uLong size_filename;        /* filename length                 2 bytes */
 120     uLong size_file_extra;      /* extra field length              2 bytes */
 121     uLong size_file_comment;    /* file comment length             2 bytes */
 122
 123     uLong disk_num_start;       /* disk number start               2 bytes */
 124     uLong internal_fa;          /* internal file attributes        2 bytes */
 125     uLong external_fa;          /* external file attributes        4 bytes */
 126
 127     tm_unz tmu_date;
 128 } unz_file_info;
 129
 130 extern int ZEXPORT unzStringFileNameCompare OF ((const char* fileName1,
 131                                                                                                  const char* fileName2,
 132                                                                                                  int iCaseSensitivity));
 133 /*
 134    Compare two filename (fileName1,fileName2).
 135    If iCaseSenisivity = 1, comparision is case sensitivity (like strcmp)
 136    If iCaseSenisivity = 2, comparision is not case sensitivity (like strcmpi
 137                                                                 or strcasecmp)
 138    If iCaseSenisivity = 0, case sensitivity is defaut of your operating system
 139         (like 1 on Unix, 2 on Windows)
 140 */
 141
 142
 143 extern unzFile ZEXPORT unzOpen OF((const char *path));
 144 /*
 145   Open a Zip file. path contain the full pathname (by example,
 146      on a Windows NT computer "c:\\zlib\\zlib111.zip" or on an Unix computer
 147          "zlib/zlib111.zip".
 148          If the zipfile cannot be opened (file don't exist or in not valid), the
 149            return value is NULL.
 150      Else, the return value is a unzFile Handle, usable with other function
 151            of this unzip package.
 152 */
 153
 154 extern int ZEXPORT unzClose OF((unzFile file));
 155 /*
 156   Close a ZipFile opened with unzipOpen.
 157   If there is files inside the .Zip opened with unzOpenCurrentFile (see later),
 158     these files MUST be closed with unzipCloseCurrentFile before call unzipClose.
 159   return UNZ_OK if there is no problem. */
 160
 161 extern int ZEXPORT unzGetGlobalInfo OF((unzFile file,
 162                                         unz_global_info *pglobal_info));
 163 /*
 164   Write info about the ZipFile in the *pglobal_info structure.
 165   No preparation of the structure is needed
 166   return UNZ_OK if there is no problem. */
 167
 168
 169 extern int ZEXPORT unzGetGlobalComment OF((unzFile file,
 170                                                                                    char *szComment,
 171                                            uLong uSizeBuf));
 172 /*
 173   Get the global comment string of the ZipFile, in the szComment buffer.
 174   uSizeBuf is the size of the szComment buffer.
 175   return the number of byte copied or an error code <0
 176 */
 177
 178
 179 /***************************************************************************/
 180 /* Unzip package allow you browse the directory of the zipfile */
 181
 182 extern int ZEXPORT unzGoToFirstFile OF((unzFile file));
 183 /*
 184   Set the current file of the zipfile to the first file.
 185   return UNZ_OK if there is no problem
 186 */
 187
 188 extern int ZEXPORT unzGoToNextFile OF((unzFile file));
 189 /*
 190   Set the current file of the zipfile to the next file.
 191   return UNZ_OK if there is no problem
 192   return UNZ_END_OF_LIST_OF_FILE if the actual file was the latest.
 193 */
 194
 195 extern int ZEXPORT unzLocateFile OF((unzFile file,
 196                                      const char *szFileName,
 197                                      int iCaseSensitivity));
 198 /*
 199   Try locate the file szFileName in the zipfile.
 200   For the iCaseSensitivity signification, see unzStringFileNameCompare
 201
 202   return value :
 203   UNZ_OK if the file is found. It becomes the current file.
 204   UNZ_END_OF_LIST_OF_FILE if the file is not found
 205 */
 206
 207
 208 extern int ZEXPORT unzGetCurrentFileInfo OF((unzFile file,
 209                                              unz_file_info *pfile_info,
 210                                              char *szFileName,
 211                                              uLong fileNameBufferSize,
 212                                              void *extraField,
 213                                              uLong extraFieldBufferSize,
 214                                              char *szComment,
 215                                              uLong commentBufferSize));
 216 /*
 217   Get Info about the current file
 218   if pfile_info!=NULL, the *pfile_info structure will contain somes info about
 219             the current file
 220   if szFileName!=NULL, the filemane string will be copied in szFileName
 221                         (fileNameBufferSize is the size of the buffer)
 222   if extraField!=NULL, the extra field information will be copied in extraField
 223                         (extraFieldBufferSize is the size of the buffer).
 224                         This is the Central-header version of the extra field
 225   if szComment!=NULL, the comment string of the file will be copied in szComment
 226                         (commentBufferSize is the size of the buffer)
 227 */
 228
 229 /***************************************************************************/
 230 /* for reading the content of the current zipfile, you can open it, read data
 231    from it, and close it (you can close it before reading all the file)
 232    */
 233
 234 extern int ZEXPORT unzOpenCurrentFile OF((unzFile file));
 235 /*
 236   Open for reading data the current file in the zipfile.
 237   If there is no error, the return value is UNZ_OK.
 238 */
 239
 240 extern int ZEXPORT unzCloseCurrentFile OF((unzFile file));
 241 /*
 242   Close the file in zip opened with unzOpenCurrentFile
 243   Return UNZ_CRCERROR if all the file was read but the CRC is not good
 244 */
 245
 246
 247 extern int ZEXPORT unzReadCurrentFile OF((unzFile file,
 248                                           voidp buf,
 249                                           unsigned len));
 250 /*
 251   Read bytes from the current file (opened by unzOpenCurrentFile)
 252   buf contain buffer where data must be copied
 253   len the size of buf.
 254
 255   return the number of byte copied if somes bytes are copied
 256   return 0 if the end of file was reached
 257   return <0 with error code if there is an error
 258     (UNZ_ERRNO for IO error, or zLib error for uncompress error)
 259 */
 260
 261 extern z_off_t ZEXPORT unztell OF((unzFile file));
 262 /*
 263   Give the current position in uncompressed data
 264 */
 265
 266 extern int ZEXPORT unzeof OF((unzFile file));
 267 /*
 268   return 1 if the end of file was reached, 0 elsewhere
 269 */
 270
 271 extern int ZEXPORT unzGetLocalExtrafield OF((unzFile file,
 272                                                                                          voidp buf,
 273                                                                                          unsigned len));
 274 /*
 275   Read extra field from the current file (opened by unzOpenCurrentFile)
 276   This is the local-header version of the extra field (sometimes, there is
 277     more info in the local-header version than in the central-header)
 278
 279   if buf==NULL, it return the size of the local extra field
 280
 281   if buf!=NULL, len is the size of the buffer, the extra header is copied in
 282         buf.
 283   the return value is the number of bytes copied in buf, or (if <0)
 284         the error code
 285 */
 286
 287 #if defined(__VISAGECPP__) || defined(__BORLANDC__)
 288 /*Visualage complains of no prototypes*/
 289 int unzlocal_getByte(FILE* , int*);
 290 int strcmpcasenosensitive_internal (const char*, const char*);
 291 int unzlocal_getShort (FILE*, uLong*);
 292 int unzlocal_getLong (FILE*, uLong*);
 293 uLong unzlocal_SearchCentralDir(FILE*);
 294 void unzlocal_DosDateToTmuDate (uLong, tm_unz*);
 295 #endif
 296
 297 #ifdef __cplusplus
 298 }
 299 #endif
 300
 301 #endif /* _unz_H */