1/* unzip.h -- IO for uncompress .zip files using zlib
2 Version 1.1, February 14h, 2010
3 part of the MiniZip project - ( http://www.winimage.com/zLibDll/minizip.html )
4
5 Copyright (C) 1998-2010 Gilles Vollant (minizip) ( http://www.winimage.com/zLibDll/minizip.html )
6
7 Modifications of Unzip for Zip64
8 Copyright (C) 2007-2008 Even Rouault
9
10 Modifications for Zip64 support on both zip and unzip
11 Copyright (C) 2009-2010 Mathias Svensson ( http://result42.com )
12
13 For more info read MiniZip_info.txt
14
15 ---------------------------------------------------------------------------------
16
17 Condition of use and distribution are the same than zlib :
18
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.
22
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:
26
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.
34
35 ---------------------------------------------------------------------------------
36
37 Changes
38
39 See header of unzip64.c
40
41*/
42
43#ifndef _unz64_H
44#define _unz64_H
45
46#ifdef __cplusplus
47extern "C" {
48#endif
49
50#ifndef _ZLIB_H
51#include "zlib.h"
52#endif
53
54#ifndef _ZLIBIOAPI_H
55#include "ioapi.h"
56#endif
57
58#ifdef HAVE_BZIP2
59#include "bzlib.h"
60#endif
61
62#define Z_BZIP2ED 12
63
64#if defined(STRICTUNZIP) || defined(STRICTZIPUNZIP)
65/* like the STRICT of WIN32, we define a pointer that cannot be converted
66 from (void*) without cast */
67typedef struct TagunzFile__ { int unused; } unzFile__;
68typedef unzFile__ *unzFile;
69#else
70typedef voidp unzFile;
71#endif
72
73
74#define UNZ_OK (0)
75#define UNZ_END_OF_LIST_OF_FILE (-100)
76#define UNZ_ERRNO (Z_ERRNO)
77#define UNZ_EOF (0)
78#define UNZ_PARAMERROR (-102)
79#define UNZ_BADZIPFILE (-103)
80#define UNZ_INTERNALERROR (-104)
81#define UNZ_CRCERROR (-105)
82
83/* tm_unz contain date/time info */
84typedef struct tm_unz_s
85{
86 int tm_sec; /* seconds after the minute - [0,59] */
87 int tm_min; /* minutes after the hour - [0,59] */
88 int tm_hour; /* hours since midnight - [0,23] */
89 int tm_mday; /* day of the month - [1,31] */
90 int tm_mon; /* months since January - [0,11] */
91 int tm_year; /* years - [1980..2044] */
92} tm_unz;
93
94/* unz_global_info structure contain global data about the ZIPfile
95 These data comes from the end of central dir */
96typedef struct unz_global_info64_s
97{
98 ZPOS64_T number_entry; /* total number of entries in
99 the central dir on this disk */
100 uLong size_comment; /* size of the global comment of the zipfile */
101} unz_global_info64;
102
103typedef struct unz_global_info_s
104{
105 uLong number_entry; /* total number of entries in
106 the central dir on this disk */
107 uLong size_comment; /* size of the global comment of the zipfile */
108} unz_global_info;
109
110/* unz_file_info contain information about a file in the zipfile */
111typedef struct unz_file_info64_s
112{
113 uLong version; /* version made by 2 bytes */
114 uLong version_needed; /* version needed to extract 2 bytes */
115 uLong flag; /* general purpose bit flag 2 bytes */
116 uLong compression_method; /* compression method 2 bytes */
117 uLong dosDate; /* last mod file date in Dos fmt 4 bytes */
118 uLong crc; /* crc-32 4 bytes */
119 ZPOS64_T compressed_size; /* compressed size 8 bytes */
120 ZPOS64_T uncompressed_size; /* uncompressed size 8 bytes */
121 uLong size_filename; /* filename length 2 bytes */
122 uLong size_file_extra; /* extra field length 2 bytes */
123 uLong size_file_comment; /* file comment length 2 bytes */
124
125 uLong disk_num_start; /* disk number start 2 bytes */
126 uLong internal_fa; /* internal file attributes 2 bytes */
127 uLong external_fa; /* external file attributes 4 bytes */
128
129 tm_unz tmu_date;
130} unz_file_info64;
131
132typedef struct unz_file_info_s
133{
134 uLong version; /* version made by 2 bytes */
135 uLong version_needed; /* version needed to extract 2 bytes */
136 uLong flag; /* general purpose bit flag 2 bytes */
137 uLong compression_method; /* compression method 2 bytes */
138 uLong dosDate; /* last mod file date in Dos fmt 4 bytes */
139 uLong crc; /* crc-32 4 bytes */
140 uLong compressed_size; /* compressed size 4 bytes */
141 uLong uncompressed_size; /* uncompressed size 4 bytes */
142 uLong size_filename; /* filename length 2 bytes */
143 uLong size_file_extra; /* extra field length 2 bytes */
144 uLong size_file_comment; /* file comment length 2 bytes */
145
146 uLong disk_num_start; /* disk number start 2 bytes */
147 uLong internal_fa; /* internal file attributes 2 bytes */
148 uLong external_fa; /* external file attributes 4 bytes */
149
150 tm_unz tmu_date;
151} unz_file_info;
152
153extern int ZEXPORT unzStringFileNameCompare(const char* fileName1,
154 const char* fileName2,
155 int iCaseSensitivity);
156/*
157 Compare two filenames (fileName1,fileName2).
158 If iCaseSensitivity = 1, comparison is case sensitive (like strcmp)
159 If iCaseSensitivity = 2, comparison is not case sensitive (like strcmpi
160 or strcasecmp)
161 If iCaseSensitivity = 0, case sensitivity is default of your operating system
162 (like 1 on Unix, 2 on Windows)
163*/
164
165
166extern unzFile ZEXPORT unzOpen(const char *path);
167extern unzFile ZEXPORT unzOpen64(const void *path);
168/*
169 Open a Zip file. path contain the full pathname (by example,
170 on a Windows XP computer "c:\\zlib\\zlib113.zip" or on an Unix computer
171 "zlib/zlib113.zip".
172 If the zipfile cannot be opened (file don't exist or in not valid), the
173 return value is NULL.
174 Else, the return value is a unzFile Handle, usable with other function
175 of this unzip package.
176 the "64" function take a const void* pointer, because the path is just the
177 value passed to the open64_file_func callback.
178 Under Windows, if UNICODE is defined, using fill_fopen64_filefunc, the path
179 is a pointer to a wide unicode string (LPCTSTR is LPCWSTR), so const char*
180 does not describe the reality
181*/
182
183
184extern unzFile ZEXPORT unzOpen2(const char *path,
185 zlib_filefunc_def* pzlib_filefunc_def);
186/*
187 Open a Zip file, like unzOpen, but provide a set of file low level API
188 for read/write the zip file (see ioapi.h)
189*/
190
191extern unzFile ZEXPORT unzOpen2_64(const void *path,
192 zlib_filefunc64_def* pzlib_filefunc_def);
193/*
194 Open a Zip file, like unz64Open, but provide a set of file low level API
195 for read/write the zip file (see ioapi.h)
196*/
197
198extern int ZEXPORT unzClose(unzFile file);
199/*
200 Close a ZipFile opened with unzOpen.
201 If there is files inside the .Zip opened with unzOpenCurrentFile (see later),
202 these files MUST be closed with unzCloseCurrentFile before call unzClose.
203 return UNZ_OK if there is no problem. */
204
205/* GODOT start */
206extern void* unzGetOpaque(unzFile file);
207/* GODOT end */
208
209extern int ZEXPORT unzGetGlobalInfo(unzFile file,
210 unz_global_info *pglobal_info);
211
212extern int ZEXPORT unzGetGlobalInfo64(unzFile file,
213 unz_global_info64 *pglobal_info);
214/*
215 Write info about the ZipFile in the *pglobal_info structure.
216 No preparation of the structure is needed
217 return UNZ_OK if there is no problem. */
218
219
220extern int ZEXPORT unzGetGlobalComment(unzFile file,
221 char *szComment,
222 uLong uSizeBuf);
223/*
224 Get the global comment string of the ZipFile, in the szComment buffer.
225 uSizeBuf is the size of the szComment buffer.
226 return the number of byte copied or an error code <0
227*/
228
229
230/***************************************************************************/
231/* Unzip package allow you browse the directory of the zipfile */
232
233extern int ZEXPORT unzGoToFirstFile(unzFile file);
234/*
235 Set the current file of the zipfile to the first file.
236 return UNZ_OK if there is no problem
237*/
238
239extern int ZEXPORT unzGoToNextFile(unzFile file);
240/*
241 Set the current file of the zipfile to the next file.
242 return UNZ_OK if there is no problem
243 return UNZ_END_OF_LIST_OF_FILE if the actual file was the latest.
244*/
245
246extern int ZEXPORT unzLocateFile(unzFile file,
247 const char *szFileName,
248 int iCaseSensitivity);
249/*
250 Try locate the file szFileName in the zipfile.
251 For the iCaseSensitivity signification, see unzStringFileNameCompare
252
253 return value :
254 UNZ_OK if the file is found. It becomes the current file.
255 UNZ_END_OF_LIST_OF_FILE if the file is not found
256*/
257
258
259/* ****************************************** */
260/* Ryan supplied functions */
261/* unz_file_info contain information about a file in the zipfile */
262typedef struct unz_file_pos_s
263{
264 uLong pos_in_zip_directory; /* offset in zip file directory */
265 uLong num_of_file; /* # of file */
266} unz_file_pos;
267
268extern int ZEXPORT unzGetFilePos(
269 unzFile file,
270 unz_file_pos* file_pos);
271
272extern int ZEXPORT unzGoToFilePos(
273 unzFile file,
274 unz_file_pos* file_pos);
275
276typedef struct unz64_file_pos_s
277{
278 ZPOS64_T pos_in_zip_directory; /* offset in zip file directory */
279 ZPOS64_T num_of_file; /* # of file */
280} unz64_file_pos;
281
282extern int ZEXPORT unzGetFilePos64(
283 unzFile file,
284 unz64_file_pos* file_pos);
285
286extern int ZEXPORT unzGoToFilePos64(
287 unzFile file,
288 const unz64_file_pos* file_pos);
289
290/* ****************************************** */
291
292extern int ZEXPORT unzGetCurrentFileInfo64(unzFile file,
293 unz_file_info64 *pfile_info,
294 char *szFileName,
295 uLong fileNameBufferSize,
296 void *extraField,
297 uLong extraFieldBufferSize,
298 char *szComment,
299 uLong commentBufferSize);
300
301extern int ZEXPORT unzGetCurrentFileInfo(unzFile file,
302 unz_file_info *pfile_info,
303 char *szFileName,
304 uLong fileNameBufferSize,
305 void *extraField,
306 uLong extraFieldBufferSize,
307 char *szComment,
308 uLong commentBufferSize);
309/*
310 Get Info about the current file
311 if pfile_info!=NULL, the *pfile_info structure will contain some info about
312 the current file
313 if szFileName!=NULL, the filemane string will be copied in szFileName
314 (fileNameBufferSize is the size of the buffer)
315 if extraField!=NULL, the extra field information will be copied in extraField
316 (extraFieldBufferSize is the size of the buffer).
317 This is the Central-header version of the extra field
318 if szComment!=NULL, the comment string of the file will be copied in szComment
319 (commentBufferSize is the size of the buffer)
320*/
321
322
323/** Addition for GDAL : START */
324
325extern ZPOS64_T ZEXPORT unzGetCurrentFileZStreamPos64(unzFile file);
326
327/** Addition for GDAL : END */
328
329
330/***************************************************************************/
331/* for reading the content of the current zipfile, you can open it, read data
332 from it, and close it (you can close it before reading all the file)
333 */
334
335extern int ZEXPORT unzOpenCurrentFile(unzFile file);
336/*
337 Open for reading data the current file in the zipfile.
338 If there is no error, the return value is UNZ_OK.
339*/
340
341extern int ZEXPORT unzOpenCurrentFilePassword(unzFile file,
342 const char* password);
343/*
344 Open for reading data the current file in the zipfile.
345 password is a crypting password
346 If there is no error, the return value is UNZ_OK.
347*/
348
349extern int ZEXPORT unzOpenCurrentFile2(unzFile file,
350 int* method,
351 int* level,
352 int raw);
353/*
354 Same than unzOpenCurrentFile, but open for read raw the file (not uncompress)
355 if raw==1
356 *method will receive method of compression, *level will receive level of
357 compression
358 note : you can set level parameter as NULL (if you did not want known level,
359 but you CANNOT set method parameter as NULL
360*/
361
362extern int ZEXPORT unzOpenCurrentFile3(unzFile file,
363 int* method,
364 int* level,
365 int raw,
366 const char* password);
367/*
368 Same than unzOpenCurrentFile, but open for read raw the file (not uncompress)
369 if raw==1
370 *method will receive method of compression, *level will receive level of
371 compression
372 note : you can set level parameter as NULL (if you did not want known level,
373 but you CANNOT set method parameter as NULL
374*/
375
376
377extern int ZEXPORT unzCloseCurrentFile(unzFile file);
378/*
379 Close the file in zip opened with unzOpenCurrentFile
380 Return UNZ_CRCERROR if all the file was read but the CRC is not good
381*/
382
383extern int ZEXPORT unzReadCurrentFile(unzFile file,
384 voidp buf,
385 unsigned len);
386/*
387 Read bytes from the current file (opened by unzOpenCurrentFile)
388 buf contain buffer where data must be copied
389 len the size of buf.
390
391 return the number of byte copied if some bytes are copied
392 return 0 if the end of file was reached
393 return <0 with error code if there is an error
394 (UNZ_ERRNO for IO error, or zLib error for uncompress error)
395*/
396
397/* GODOT start */
398extern int ZEXPORT unzSeekCurrentFile(unzFile file, int pos);
399/*
400 Seek to position in uncompressed data
401*/
402/* GODOT end */
403
404extern z_off_t ZEXPORT unztell(unzFile file);
405
406extern ZPOS64_T ZEXPORT unztell64(unzFile file);
407/*
408 Give the current position in uncompressed data
409*/
410
411extern int ZEXPORT unzeof(unzFile file);
412/*
413 return 1 if the end of file was reached, 0 elsewhere
414*/
415
416extern int ZEXPORT unzGetLocalExtrafield(unzFile file,
417 voidp buf,
418 unsigned len);
419/*
420 Read extra field from the current file (opened by unzOpenCurrentFile)
421 This is the local-header version of the extra field (sometimes, there is
422 more info in the local-header version than in the central-header)
423
424 if buf==NULL, it return the size of the local extra field
425
426 if buf!=NULL, len is the size of the buffer, the extra header is copied in
427 buf.
428 the return value is the number of bytes copied in buf, or (if <0)
429 the error code
430*/
431
432/***************************************************************************/
433
434/* Get the current file offset */
435extern ZPOS64_T ZEXPORT unzGetOffset64 (unzFile file);
436extern uLong ZEXPORT unzGetOffset (unzFile file);
437
438/* Set the current file offset */
439extern int ZEXPORT unzSetOffset64 (unzFile file, ZPOS64_T pos);
440extern int ZEXPORT unzSetOffset (unzFile file, uLong pos);
441
442
443
444#ifdef __cplusplus
445}
446#endif
447
448#endif /* _unz64_H */
449