sdk-world v2026.11.05
PS2 SDK - world tier (copyleft-allowed, non-essential packages)
Loading...
Searching...
No Matches
unzip.h
Go to the documentation of this file.
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
47#ifndef _unz64_H
48#define _unz64_H
49
50#ifdef __cplusplus
51extern "C" {
52#endif
53
54#ifndef _ZLIB_H
55#include "zlib.h"
56#endif
57
58#ifndef _ZLIBIOAPI_H
59#include "ioapi.h"
60#endif
61
62#ifdef HAVE_BZIP2
63#include "bzlib.h"
64#endif
65
66#define Z_BZIP2ED 12
67
68#if defined(STRICTUNZIP) || defined(STRICTZIPUNZIP)
69/* like the STRICT of WIN32, we define a pointer that cannot be converted
70 from (void*) without cast */
71typedef struct TagunzFile__ { int unused; } unzFile__;
72typedef unzFile__ *unzFile;
73#else
74typedef voidp unzFile;
75#endif
76
77
78#define UNZ_OK (0)
79#define UNZ_END_OF_LIST_OF_FILE (-100)
80#define UNZ_ERRNO (Z_ERRNO)
81#define UNZ_EOF (0)
82#define UNZ_PARAMERROR (-102)
83#define UNZ_BADZIPFILE (-103)
84#define UNZ_INTERNALERROR (-104)
85#define UNZ_CRCERROR (-105)
86
87/* tm_unz contain date/time info */
88typedef struct tm_unz_s
89{
90 int tm_sec; /* seconds after the minute - [0,59] */
91 int tm_min; /* minutes after the hour - [0,59] */
92 int tm_hour; /* hours since midnight - [0,23] */
93 int tm_mday; /* day of the month - [1,31] */
94 int tm_mon; /* months since January - [0,11] */
95 int tm_year; /* years - [1980..2044] */
96} tm_unz;
97
98/* unz_global_info structure contain global data about the ZIPfile
99 These data comes from the end of central dir */
100typedef struct unz_global_info64_s
101{
102 ZPOS64_T number_entry; /* total number of entries in
103 the central dir on this disk */
104 uLong size_comment; /* size of the global comment of the zipfile */
105} unz_global_info64;
106
107typedef struct unz_global_info_s
108{
109 uLong number_entry; /* total number of entries in
110 the central dir on this disk */
111 uLong size_comment; /* size of the global comment of the zipfile */
112} unz_global_info;
113
114/* unz_file_info contain information about a file in the zipfile */
115typedef struct unz_file_info64_s
116{
117 uLong version; /* version made by 2 bytes */
118 uLong version_needed; /* version needed to extract 2 bytes */
119 uLong flag; /* general purpose bit flag 2 bytes */
120 uLong compression_method; /* compression method 2 bytes */
121 uLong dosDate; /* last mod file date in Dos fmt 4 bytes */
122 uLong crc; /* crc-32 4 bytes */
123 ZPOS64_T compressed_size; /* compressed size 8 bytes */
124 ZPOS64_T uncompressed_size; /* uncompressed size 8 bytes */
125 uLong size_filename; /* filename length 2 bytes */
126 uLong size_file_extra; /* extra field length 2 bytes */
127 uLong size_file_comment; /* file comment length 2 bytes */
128
129 uLong disk_num_start; /* disk number start 2 bytes */
130 uLong internal_fa; /* internal file attributes 2 bytes */
131 uLong external_fa; /* external file attributes 4 bytes */
132
133 tm_unz tmu_date;
134} unz_file_info64;
135
136typedef struct unz_file_info_s
137{
138 uLong version; /* version made by 2 bytes */
139 uLong version_needed; /* version needed to extract 2 bytes */
140 uLong flag; /* general purpose bit flag 2 bytes */
141 uLong compression_method; /* compression method 2 bytes */
142 uLong dosDate; /* last mod file date in Dos fmt 4 bytes */
143 uLong crc; /* crc-32 4 bytes */
144 uLong compressed_size; /* compressed size 4 bytes */
145 uLong uncompressed_size; /* uncompressed size 4 bytes */
146 uLong size_filename; /* filename length 2 bytes */
147 uLong size_file_extra; /* extra field length 2 bytes */
148 uLong size_file_comment; /* file comment length 2 bytes */
149
150 uLong disk_num_start; /* disk number start 2 bytes */
151 uLong internal_fa; /* internal file attributes 2 bytes */
152 uLong external_fa; /* external file attributes 4 bytes */
153
154 tm_unz tmu_date;
155} unz_file_info;
156
157extern int ZEXPORT unzStringFileNameCompare(const char* fileName1,
158 const char* fileName2,
159 int iCaseSensitivity);
160/*
161 Compare two filenames (fileName1,fileName2).
162 If iCaseSensitivity = 1, comparison is case sensitive (like strcmp)
163 If iCaseSensitivity = 2, comparison is not case sensitive (like strcmpi
164 or strcasecmp)
165 If iCaseSensitivity = 0, case sensitivity is default of your operating system
166 (like 1 on Unix, 2 on Windows)
167*/
168
169
170extern unzFile ZEXPORT unzOpen(const char *path);
171extern unzFile ZEXPORT unzOpen64(const void *path);
172/*
173 Open a Zip file. path contain the full pathname (by example,
174 on a Windows XP computer "c:\\zlib\\zlib113.zip" or on an Unix computer
175 "zlib/zlib113.zip".
176 If the zipfile cannot be opened (file don't exist or in not valid), the
177 return value is NULL.
178 Else, the return value is a unzFile Handle, usable with other function
179 of this unzip package.
180 the "64" function take a const void* pointer, because the path is just the
181 value passed to the open64_file_func callback.
182 Under Windows, if UNICODE is defined, using fill_fopen64_filefunc, the path
183 is a pointer to a wide unicode string (LPCTSTR is LPCWSTR), so const char*
184 does not describe the reality
185*/
186
187
188extern unzFile ZEXPORT unzOpen2(const char *path,
189 zlib_filefunc_def* pzlib_filefunc_def);
190/*
191 Open a Zip file, like unzOpen, but provide a set of file low level API
192 for read/write the zip file (see ioapi.h)
193*/
194
195extern unzFile ZEXPORT unzOpen2_64(const void *path,
196 zlib_filefunc64_def* pzlib_filefunc_def);
197/*
198 Open a Zip file, like unz64Open, but provide a set of file low level API
199 for read/write the zip file (see ioapi.h)
200*/
201
202extern int ZEXPORT unzClose(unzFile file);
203/*
204 Close a ZipFile opened with unzOpen.
205 If there is files inside the .Zip opened with unzOpenCurrentFile (see later),
206 these files MUST be closed with unzCloseCurrentFile before call unzClose.
207 return UNZ_OK if there is no problem. */
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 filename 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
324
325extern ZPOS64_T ZEXPORT unzGetCurrentFileZStreamPos64(unzFile file);
326
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
397extern z_off_t ZEXPORT unztell(unzFile file);
398
399extern ZPOS64_T ZEXPORT unztell64(unzFile file);
400/*
401 Give the current position in uncompressed data
402*/
403
404extern int ZEXPORT unzeof(unzFile file);
405/*
406 return 1 if the end of file was reached, 0 elsewhere
407*/
408
409extern int ZEXPORT unzGetLocalExtrafield(unzFile file,
410 voidp buf,
411 unsigned len);
412/*
413 Read extra field from the current file (opened by unzOpenCurrentFile)
414 This is the local-header version of the extra field (sometimes, there is
415 more info in the local-header version than in the central-header)
416
417 if buf==NULL, it return the size of the local extra field
418
419 if buf!=NULL, len is the size of the buffer, the extra header is copied in
420 buf.
421 the return value is the number of bytes copied in buf, or (if <0)
422 the error code
423*/
424
425/***************************************************************************/
426
427/* Get the current file offset */
428extern ZPOS64_T ZEXPORT unzGetOffset64 (unzFile file);
429extern uLong ZEXPORT unzGetOffset (unzFile file);
430
431/* Set the current file offset */
432extern int ZEXPORT unzSetOffset64 (unzFile file, ZPOS64_T pos);
433extern int ZEXPORT unzSetOffset (unzFile file, uLong pos);
434
435
436
437#ifdef __cplusplus
438}
439#endif
440
441#endif /* _unz64_H */
tm_unz_s
Definition unzip.h:89
unz64_file_pos_s
Definition unzip.h:277
unz_file_info64_s
Definition unzip.h:116
unz_file_info_s
Definition unzip.h:137
unz_file_pos_s
Definition unzip.h:263
unz_global_info64_s
Definition unzip.h:101
unz_global_info_s
Definition unzip.h:108