tools/quake3/common/unzip.h

   1 /*
   2    Copyright (C) 1999-2006 Id Software, Inc. and contributors.
   3    For a list of contributors, see the accompanying CONTRIBUTORS file.
   4
   5    This file is part of GtkRadiant.
   6
   7    GtkRadiant is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    GtkRadiant is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with GtkRadiant; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  */
  21
  22
  23 #if defined( STRICTUNZIP ) || defined( STRICTZIPUNZIP )
  24 /* like the STRICT of WIN32, we define a pointer that cannot be converted
  25     from (void*) without cast */
  26 typedef struct TagunzFile__ { int unused; } unzFile__;
  27 typedef unzFile__ *unzFile;
  28 #else
  29 typedef void* unzFile;
  30 #endif
  31
  32
  33 /* tm_unz contain date/time info */
  34 typedef struct tm_unz_s
  35 {
  36         unsigned int tm_sec;            /* seconds after the minute - [0,59] */
  37         unsigned int tm_min;            /* minutes after the hour - [0,59] */
  38         unsigned int tm_hour;           /* hours since midnight - [0,23] */
  39         unsigned int tm_mday;           /* day of the month - [1,31] */
  40         unsigned int tm_mon;            /* months since January - [0,11] */
  41         unsigned int tm_year;           /* years - [1980..2044] */
  42 } tm_unz;
  43
  44 /* unz_global_info structure contain global data about the ZIPfile
  45    These data comes from the end of central dir */
  46 typedef struct unz_global_info_s
  47 {
  48         unsigned long number_entry;         /* total number of entries in the central dir on this disk */
  49         unsigned long size_comment;         /* size of the global comment of the zipfile */
  50 } unz_global_info;
  51
  52
  53 /* unz_file_info contain information about a file in the zipfile */
  54 typedef struct unz_file_info_s
  55 {
  56         unsigned long version;              /* version made by                 2 unsigned chars */
  57         unsigned long version_needed;       /* version needed to extract       2 unsigned chars */
  58         unsigned long flag;                 /* general purpose bit flag        2 unsigned chars */
  59         unsigned long compression_method;   /* compression method              2 unsigned chars */
  60         unsigned long dosDate;              /* last mod file date in Dos fmt   4 unsigned chars */
  61         unsigned long crc;                  /* crc-32                          4 unsigned chars */
  62         unsigned long compressed_size;      /* compressed size                 4 unsigned chars */
  63         unsigned long uncompressed_size;    /* uncompressed size               4 unsigned chars */
  64         unsigned long size_filename;        /* filename length                 2 unsigned chars */
  65         unsigned long size_file_extra;      /* extra field length              2 unsigned chars */
  66         unsigned long size_file_comment;    /* file comment length             2 unsigned chars */
  67
  68         unsigned long disk_num_start;       /* disk number start               2 unsigned chars */
  69         unsigned long internal_fa;          /* internal file attributes        2 unsigned chars */
  70         unsigned long external_fa;          /* external file attributes        4 unsigned chars */
  71
  72         tm_unz tmu_date;
  73 } unz_file_info;
  74
  75 /* unz_file_info_interntal contain internal info about a file in zipfile*/
  76 typedef struct unz_file_info_internal_s
  77 {
  78         unsigned long offset_curfile; /* relative offset of static header 4 unsigned chars */
  79 } unz_file_info_internal;
  80
  81 typedef void* ( *alloc_func )( void* opaque, unsigned int items, unsigned int size );
  82 typedef void ( *free_func )( void* opaque, void* address );
  83
  84 struct internal_state;
  85
  86 typedef struct z_stream_s {
  87         unsigned char    *next_in;  /* next input unsigned char */
  88         unsigned int avail_in;      /* number of unsigned chars available at next_in */
  89         unsigned long total_in;     /* total nb of input unsigned chars read so */
  90
  91         unsigned char    *next_out; /* next output unsigned char should be put there */
  92         unsigned int avail_out;     /* remaining free space at next_out */
  93         unsigned long total_out;    /* total nb of unsigned chars output so */
  94
  95         char     *msg;      /* last error message, NULL if no error */
  96         struct internal_state *state; /* not visible by applications */
  97
  98         alloc_func zalloc;  /* used to allocate the internal state */
  99         free_func zfree;    /* used to free the internal state */
 100         unsigned char*     opaque;  /* private data object passed to zalloc and zfree */
 101
 102         int data_type;      /* best guess about the data type: ascii or binary */
 103         unsigned long adler;        /* adler32 value of the uncompressed data */
 104         unsigned long reserved;     /* reserved for future use */
 105 } z_stream;
 106
 107 typedef z_stream *z_streamp;
 108
 109
 110 /* file_in_zip_read_info_s contain internal information about a file in zipfile,
 111     when reading and decompress it */
 112 typedef struct
 113 {
 114         char  *read_buffer;         /* internal buffer for compressed data */
 115         z_stream stream;            /* zLib stream structure for inflate */
 116
 117         unsigned long pos_in_zipfile;       /* position in unsigned char on the zipfile, for fseek*/
 118         unsigned long stream_initialised;   /* flag set if stream structure is initialised*/
 119
 120         unsigned long offset_local_extrafield; /* offset of the static extra field */
 121         unsigned int size_local_extrafield; /* size of the static extra field */
 122         unsigned long pos_local_extrafield;   /* position in the static extra field in read*/
 123
 124         unsigned long crc32;                /* crc32 of all data uncompressed */
 125         unsigned long crc32_wait;           /* crc32 we must obtain after decompress all */
 126         unsigned long rest_read_compressed; /* number of unsigned char to be decompressed */
 127         unsigned long rest_read_uncompressed; /*number of unsigned char to be obtained after decomp*/
 128         FILE* file;                 /* io structore of the zipfile */
 129         unsigned long compression_method;   /* compression method (0==store) */
 130         unsigned long byte_before_the_zipfile; /* unsigned char before the zipfile, (>0 for sfx)*/
 131 } file_in_zip_read_info_s;
 132
 133
 134 /* unz_s contain internal information about the zipfile
 135  */
 136 typedef struct
 137 {
 138         FILE* file;                 /* io structore of the zipfile */
 139         unz_global_info gi;       /* public global information */
 140         unsigned long byte_before_the_zipfile; /* unsigned char before the zipfile, (>0 for sfx)*/
 141         unsigned long num_file;             /* number of the current file in the zipfile*/
 142         unsigned long pos_in_central_dir;   /* pos of the current file in the central dir*/
 143         unsigned long current_file_ok;      /* flag about the usability of the current file*/
 144         unsigned long central_pos;          /* position of the beginning of the central dir*/
 145
 146         unsigned long size_central_dir;     /* size of the central directory  */
 147         unsigned long offset_central_dir;   /* offset of start of central directory with
 148                                                respect to the starting disk number */
 149
 150         unz_file_info cur_file_info; /* public info about the current file in zip*/
 151         unz_file_info_internal cur_file_info_internal; /* private info about it*/
 152         file_in_zip_read_info_s* pfile_in_zip_read; /* structure about the current
 153                                                        file if we are decompressing it */
 154 } unz_s;
 155
 156 #define UNZ_OK                                  ( 0 )
 157 #define UNZ_END_OF_LIST_OF_FILE ( -100 )
 158 #define UNZ_ERRNO               ( Z_ERRNO )
 159 #define UNZ_EOF                 ( 0 )
 160 #define UNZ_PARAMERROR                  ( -102 )
 161 #define UNZ_BADZIPFILE                  ( -103 )
 162 #define UNZ_INTERNALERROR               ( -104 )
 163 #define UNZ_CRCERROR                    ( -105 )
 164
 165 #define UNZ_CASESENSITIVE       1
 166 #define UNZ_NOTCASESENSITIVE    2
 167 #define UNZ_OSDEFAULTCASE       0
 168
 169 extern int unzStringFileNameCompare( const char* fileName1, const char* fileName2, int iCaseSensitivity );
 170
 171 /*
 172    Compare two filename (fileName1,fileName2).
 173    If iCaseSenisivity = 1, comparision is case sensitivity (like strcmp)
 174    If iCaseSenisivity = 2, comparision is not case sensitivity (like strcmpi
 175                                 or strcasecmp)
 176    If iCaseSenisivity = 0, case sensitivity is defaut of your operating system
 177     (like 1 on Unix, 2 on Windows)
 178  */
 179
 180 extern unzFile unzOpen( const char *path );
 181 extern unzFile unzReOpen( const char* path, unzFile file );
 182
 183 /*
 184    Open a Zip file. path contain the full pathname (by example,
 185      on a Windows NT computer "c:\\zlib\\zlib111.zip" or on an Unix computer
 186      "zlib/zlib111.zip".
 187      If the zipfile cannot be opened (file don't exist or in not valid), the
 188        return value is NULL.
 189      Else, the return value is a unzFile Handle, usable with other function
 190        of this unzip package.
 191  */
 192
 193 extern int unzClose( unzFile file );
 194
 195 /*
 196    Close a ZipFile opened with unzipOpen.
 197    If there is files inside the .Zip opened with unzOpenCurrentFile (see later),
 198     these files MUST be closed with unzipCloseCurrentFile before call unzipClose.
 199    return UNZ_OK if there is no problem. */
 200
 201 extern int unzGetGlobalInfo( unzFile file, unz_global_info *pglobal_info );
 202
 203 /*
 204    Write info about the ZipFile in the *pglobal_info structure.
 205    No preparation of the structure is needed
 206    return UNZ_OK if there is no problem. */
 207
 208
 209 extern int unzGetGlobalComment( unzFile file, char *szComment, unsigned long uSizeBuf );
 210
 211 /*
 212    Get the global comment string of the ZipFile, in the szComment buffer.
 213    uSizeBuf is the size of the szComment buffer.
 214    return the number of unsigned char copied or an error code <0
 215  */
 216
 217
 218 /***************************************************************************/
 219 /* Unzip package allow you browse the directory of the zipfile */
 220
 221 extern int unzGoToFirstFile( unzFile file );
 222
 223 /*
 224    Set the current file of the zipfile to the first file.
 225    return UNZ_OK if there is no problem
 226  */
 227
 228 extern int unzGoToNextFile( unzFile file );
 229
 230 /*
 231    Set the current file of the zipfile to the next file.
 232    return UNZ_OK if there is no problem
 233    return UNZ_END_OF_LIST_OF_FILE if the actual file was the latest.
 234  */
 235
 236 extern int unzLocateFile( unzFile file, const char *szFileName, int iCaseSensitivity );
 237
 238 /*
 239    Try locate the file szFileName in the zipfile.
 240    For the iCaseSensitivity signification, see unzStringFileNameCompare
 241
 242    return value :
 243    UNZ_OK if the file is found. It becomes the current file.
 244    UNZ_END_OF_LIST_OF_FILE if the file is not found
 245  */
 246
 247
 248 extern int unzGetCurrentFileInfo( unzFile file, unz_file_info *pfile_info, char *szFileName, unsigned long fileNameBufferSize, void *extraField, unsigned long extraFieldBufferSize, char *szComment, unsigned long commentBufferSize );
 249
 250 /*
 251    Get Info about the current file
 252    if pfile_info!=NULL, the *pfile_info structure will contain somes info about
 253         the current file
 254    if szFileName!=NULL, the filemane string will be copied in szFileName
 255             (fileNameBufferSize is the size of the buffer)
 256    if extraField!=NULL, the extra field information will be copied in extraField
 257             (extraFieldBufferSize is the size of the buffer).
 258             This is the Central-header version of the extra field
 259    if szComment!=NULL, the comment string of the file will be copied in szComment
 260             (commentBufferSize is the size of the buffer)
 261  */
 262
 263 /***************************************************************************/
 264 /* for reading the content of the current zipfile, you can open it, read data
 265    from it, and close it (you can close it before reading all the file)
 266  */
 267
 268 extern int unzOpenCurrentFile( unzFile file );
 269
 270 /*
 271    Open for reading data the current file in the zipfile.
 272    If there is no error, the return value is UNZ_OK.
 273  */
 274
 275 extern int unzCloseCurrentFile( unzFile file );
 276
 277 /*
 278    Close the file in zip opened with unzOpenCurrentFile
 279    Return UNZ_CRCERROR if all the file was read but the CRC is not good
 280  */
 281
 282
 283 extern int unzReadCurrentFile( unzFile file, void* buf, unsigned len );
 284
 285 /*
 286    Read unsigned chars from the current file (opened by unzOpenCurrentFile)
 287    buf contain buffer where data must be copied
 288    len the size of buf.
 289
 290    return the number of unsigned char copied if somes unsigned chars are copied
 291    return 0 if the end of file was reached
 292    return <0 with error code if there is an error
 293     (UNZ_ERRNO for IO error, or zLib error for uncompress error)
 294  */
 295
 296 extern long unztell( unzFile file );
 297
 298 /*
 299    Give the current position in uncompressed data
 300  */
 301
 302 extern int unzeof( unzFile file );
 303
 304 /*
 305    return 1 if the end of file was reached, 0 elsewhere
 306  */
 307
 308 extern int unzGetLocalExtrafield( unzFile file, void* buf, unsigned len );
 309
 310 /*
 311    Read extra field from the current file (opened by unzOpenCurrentFile)
 312    This is the local-header version of the extra field (sometimes, there is
 313     more info in the local-header version than in the central-header)
 314
 315    if buf==NULL, it return the size of the local extra field
 316
 317    if buf!=NULL, len is the size of the buffer, the extra header is copied in
 318     buf.
 319    the return value is the number of unsigned chars copied in buf, or (if <0)
 320     the error code
 321  */