Debian Codegraph @

compat/zlib/contrib/minizip/unzip.h

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