1 /* unzip.h -- IO for uncompress .zip files using zlib
2 Version 1.01e, February 12th, 2005
4 Copyright (C) 1998-2005 Gilles Vollant
6 This unzip package allow extract file from .ZIP file, compatible with PKZip 2.04g
7 WinZip, InfoZip tools and compatible.
9 Multi volume ZipFile (span) are not supported.
10 Encryption compatible with pkzip 2.04g only supported
11 Old compressions used by old PKZip 1.x are not supported
14 I WAIT FEEDBACK at mail info@winimage.com
15 Visit also http://www.winimage.com/zLibDll/unzip.htm for evolution
17 Condition of use and distribution are the same than zlib :
19 This software is provided 'as-is', without any express or implied
20 warranty. In no event will the authors be held liable for any damages
21 arising from the use of this software.
23 Permission is granted to anyone to use this software for any purpose,
24 including commercial applications, and to alter it and redistribute it
25 freely, subject to the following restrictions:
27 1. The origin of this software must not be misrepresented; you must not
28 claim that you wrote the original software. If you use this software
29 in a product, an acknowledgment in the product documentation would be
30 appreciated but is not required.
31 2. Altered source versions must be plainly marked as such, and must not be
32 misrepresented as being the original software.
33 3. This notice may not be removed or altered from any source distribution.
38 /* for more info about .ZIP format, see
39 http://www.info-zip.org/pub/infozip/doc/appnote-981119-iz.zip
40 http://www.info-zip.org/pub/infozip/doc/
41 PkWare has also a specification at :
42 ftp://ftp.pkware.com/probdesc.zip
60 #if defined(STRICTUNZIP) || defined(STRICTZIPUNZIP)
61 /* like the STRICT of WIN32, we define a pointer that cannot be converted
62 from (void*) without cast */
63 typedef struct TagunzFile__
{ int unused
; } unzFile__
;
64 typedef unzFile__
*unzFile
;
66 typedef voidp unzFile
;
71 #define UNZ_END_OF_LIST_OF_FILE (-100)
72 #define UNZ_ERRNO (Z_ERRNO)
74 #define UNZ_PARAMERROR (-102)
75 #define UNZ_BADZIPFILE (-103)
76 #define UNZ_INTERNALERROR (-104)
77 #define UNZ_CRCERROR (-105)
79 /* tm_unz contain date/time info */
80 typedef struct tm_unz_s
82 uInt tm_sec
; /* seconds after the minute - [0,59] */
83 uInt tm_min
; /* minutes after the hour - [0,59] */
84 uInt tm_hour
; /* hours since midnight - [0,23] */
85 uInt tm_mday
; /* day of the month - [1,31] */
86 uInt tm_mon
; /* months since January - [0,11] */
87 uInt tm_year
; /* years - [1980..2044] */
90 /* unz_global_info structure contain global data about the ZIPfile
91 These data comes from the end of central dir */
92 typedef struct unz_global_info_s
94 uLong number_entry
; /* total number of entries in
95 the central dir on this disk */
96 uLong size_comment
; /* size of the global comment of the zipfile */
100 /* unz_file_info contain information about a file in the zipfile */
101 typedef struct unz_file_info_s
103 uLong version
; /* version made by 2 bytes */
104 uLong version_needed
; /* version needed to extract 2 bytes */
105 uLong flag
; /* general purpose bit flag 2 bytes */
106 uLong compression_method
; /* compression method 2 bytes */
107 uLong dosDate
; /* last mod file date in Dos fmt 4 bytes */
108 uLong crc
; /* crc-32 4 bytes */
109 uLong compressed_size
; /* compressed size 4 bytes */
110 uLong uncompressed_size
; /* uncompressed size 4 bytes */
111 uLong size_filename
; /* filename length 2 bytes */
112 uLong size_file_extra
; /* extra field length 2 bytes */
113 uLong size_file_comment
; /* file comment length 2 bytes */
115 uLong disk_num_start
; /* disk number start 2 bytes */
116 uLong internal_fa
; /* internal file attributes 2 bytes */
117 uLong external_fa
; /* external file attributes 4 bytes */
122 extern int ZEXPORT unzStringFileNameCompare
OF ((const char* fileName1
,
123 const char* fileName2
,
124 int iCaseSensitivity
));
126 Compare two filename (fileName1,fileName2).
127 If iCaseSensitivity = 1, comparison is case sensitive (like strcmp)
128 If iCaseSensitivity = 2, comparison is not case sensitive (like strcmpi
130 If iCaseSensitivity = 0, case sensitivity is default of your operating system
131 (like 1 on Unix, 2 on Windows)
135 extern unzFile ZEXPORT unzOpen
OF((const char *path
));
137 Open a Zip file. path contain the full pathname (by example,
138 on a Windows XP computer "c:\\zlib\\zlib113.zip" or on an Unix computer
140 If the zipfile cannot be opened (file don't exist or in not valid), the
141 return value is NULL.
142 Else, the return value is a unzFile Handle, usable with other function
143 of this unzip package.
146 extern unzFile ZEXPORT unzOpen2
OF((const char *path
,
147 zlib_filefunc_def
* pzlib_filefunc_def
));
149 Open a Zip file, like unzOpen, but provide a set of file low level API
150 for read/write the zip file (see ioapi.h)
153 extern int ZEXPORT unzClose
OF((unzFile file
));
155 Close a ZipFile opened with unzipOpen.
156 If there is files inside the .Zip opened with unzOpenCurrentFile (see later),
157 these files MUST be closed with unzipCloseCurrentFile before call unzipClose.
158 return UNZ_OK if there is no problem. */
160 extern int ZEXPORT unzGetGlobalInfo
OF((unzFile file
,
161 unz_global_info
*pglobal_info
));
163 Write info about the ZipFile in the *pglobal_info structure.
164 No preparation of the structure is needed
165 return UNZ_OK if there is no problem. */
168 extern int ZEXPORT unzGetGlobalComment
OF((unzFile file
,
172 Get the global comment string of the ZipFile, in the szComment buffer.
173 uSizeBuf is the size of the szComment buffer.
174 return the number of byte copied or an error code <0
178 /***************************************************************************/
179 /* Unzip package allow you browse the directory of the zipfile */
181 extern int ZEXPORT unzGoToFirstFile
OF((unzFile file
));
183 Set the current file of the zipfile to the first file.
184 return UNZ_OK if there is no problem
187 extern int ZEXPORT unzGoToNextFile
OF((unzFile file
));
189 Set the current file of the zipfile to the next file.
190 return UNZ_OK if there is no problem
191 return UNZ_END_OF_LIST_OF_FILE if the actual file was the latest.
194 extern int ZEXPORT unzLocateFile
OF((unzFile file
,
195 const char *szFileName
,
196 int iCaseSensitivity
));
198 Try locate the file szFileName in the zipfile.
199 For the iCaseSensitivity signification, see unzStringFileNameCompare
202 UNZ_OK if the file is found. It becomes the current file.
203 UNZ_END_OF_LIST_OF_FILE if the file is not found
207 /* ****************************************** */
208 /* Ryan supplied functions */
209 /* unz_file_info contain information about a file in the zipfile */
210 typedef struct unz_file_pos_s
212 uLong pos_in_zip_directory
; /* offset in zip file directory */
213 uLong num_of_file
; /* # of file */
216 extern int ZEXPORT
unzGetFilePos(
218 unz_file_pos
* file_pos
);
220 extern int ZEXPORT
unzGoToFilePos(
222 unz_file_pos
* file_pos
);
224 /* ****************************************** */
226 extern int ZEXPORT unzGetCurrentFileInfo
OF((unzFile file
,
227 unz_file_info
*pfile_info
,
229 uLong fileNameBufferSize
,
231 uLong extraFieldBufferSize
,
233 uLong commentBufferSize
));
235 Get Info about the current file
236 if pfile_info!=NULL, the *pfile_info structure will contain somes info about
238 if szFileName!=NULL, the filemane string will be copied in szFileName
239 (fileNameBufferSize is the size of the buffer)
240 if extraField!=NULL, the extra field information will be copied in extraField
241 (extraFieldBufferSize is the size of the buffer).
242 This is the Central-header version of the extra field
243 if szComment!=NULL, the comment string of the file will be copied in szComment
244 (commentBufferSize is the size of the buffer)
247 /***************************************************************************/
248 /* for reading the content of the current zipfile, you can open it, read data
249 from it, and close it (you can close it before reading all the file)
252 extern int ZEXPORT unzOpenCurrentFile
OF((unzFile file
));
254 Open for reading data the current file in the zipfile.
255 If there is no error, the return value is UNZ_OK.
258 extern int ZEXPORT unzOpenCurrentFilePassword
OF((unzFile file
,
259 const char* password
));
261 Open for reading data the current file in the zipfile.
262 password is a crypting password
263 If there is no error, the return value is UNZ_OK.
266 extern int ZEXPORT unzOpenCurrentFile2
OF((unzFile file
,
271 Same than unzOpenCurrentFile, but open for read raw the file (not uncompress)
273 *method will receive method of compression, *level will receive level of
275 note : you can set level parameter as NULL (if you did not want known level,
276 but you CANNOT set method parameter as NULL
279 extern int ZEXPORT unzOpenCurrentFile3
OF((unzFile file
,
283 const char* password
));
285 Same than unzOpenCurrentFile, but open for read raw the file (not uncompress)
287 *method will receive method of compression, *level will receive level of
289 note : you can set level parameter as NULL (if you did not want known level,
290 but you CANNOT set method parameter as NULL
294 extern int ZEXPORT unzCloseCurrentFile
OF((unzFile file
));
296 Close the file in zip opened with unzOpenCurrentFile
297 Return UNZ_CRCERROR if all the file was read but the CRC is not good
300 extern int ZEXPORT unzReadCurrentFile
OF((unzFile file
,
304 Read bytes from the current file (opened by unzOpenCurrentFile)
305 buf contain buffer where data must be copied
308 return the number of byte copied if somes bytes are copied
309 return 0 if the end of file was reached
310 return <0 with error code if there is an error
311 (UNZ_ERRNO for IO error, or zLib error for uncompress error)
314 extern z_off_t ZEXPORT unztell
OF((unzFile file
));
316 Give the current position in uncompressed data
319 extern int ZEXPORT unzeof
OF((unzFile file
));
321 return 1 if the end of file was reached, 0 elsewhere
324 extern int ZEXPORT unzGetLocalExtrafield
OF((unzFile file
,
328 Read extra field from the current file (opened by unzOpenCurrentFile)
329 This is the local-header version of the extra field (sometimes, there is
330 more info in the local-header version than in the central-header)
332 if buf==NULL, it return the size of the local extra field
334 if buf!=NULL, len is the size of the buffer, the extra header is copied in
336 the return value is the number of bytes copied in buf, or (if <0)
340 /***************************************************************************/
342 /* Get the current file offset */
343 extern uLong ZEXPORT
unzGetOffset (unzFile file
);
345 /* Set the current file offset */
346 extern int ZEXPORT
unzSetOffset (unzFile file
, uLong pos
);