Quake-III-Arena

Quake III Arena GPL Source Release
Log | Files | Refs

unzip.h (12154B)


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