unzip.h

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