]> git.saurik.com Git - wxWidgets.git/blame - src/common/unzip.h
Compare and assign wxChars to wxChar instead char local variable.
[wxWidgets.git] / src / common / unzip.h
CommitLineData
076bae67
VS
1/*
2
77ffb593 3This file was altered for needs of wxWidgets.
076bae67
VS
4$Id$
5
6*/
7
913df6f2 8/* unzip.h -- IO for uncompress .zip files using zlib
5526e819
VS
9 Version 0.15 beta, Mar 19th, 1998,
10
11 Copyright (C) 1998 Gilles Vollant
12
13 This unzip package allow extract file from .ZIP file, compatible with PKZip 2.04g
14 WinZip, InfoZip tools and compatible.
15 Encryption and multi volume ZipFile (span) are not supported.
16 Old compressions used by old PKZip 1.x are not supported
17
18 THIS IS AN ALPHA VERSION. AT THIS STAGE OF DEVELOPPEMENT, SOMES API OR STRUCTURE
19 CAN CHANGE IN FUTURE VERSION !!
20 I WAIT FEEDBACK at mail info@winimage.com
21 Visit also http://www.winimage.com/zLibDll/unzip.htm for evolution
22
23 Condition of use and distribution are the same than zlib :
24
25 This software is provided 'as-is', without any express or implied
26 warranty. In no event will the authors be held liable for any damages
27 arising from the use of this software.
28
29 Permission is granted to anyone to use this software for any purpose,
30 including commercial applications, and to alter it and redistribute it
31 freely, subject to the following restrictions:
32
33 1. The origin of this software must not be misrepresented; you must not
34 claim that you wrote the original software. If you use this software
35 in a product, an acknowledgment in the product documentation would be
36 appreciated but is not required.
37 2. Altered source versions must be plainly marked as such, and must not be
38 misrepresented as being the original software.
39 3. This notice may not be removed or altered from any source distribution.
40
41
42*/
913df6f2 43/* for more info about .ZIP format, see
5526e819
VS
44 ftp://ftp.cdrom.com/pub/infozip/doc/appnote-970311-iz.zip
45 PkWare has also a specification at :
46 ftp://ftp.pkware.com/probdesc.zip */
47
48#ifndef _unz_H
49#define _unz_H
50
51#ifdef __cplusplus
52extern "C" {
53#endif
54
2b5f62a0 55/* include zlib.h if not done yet */
5526e819 56#ifndef _ZLIB_H
2b5f62a0
VZ
57 /*
58 normally, the compiler options should contain -I../zlib, but it is
59 apparently not the case for all MSW makefiles and so, unless we use
60 configure (which defines __WX_SETUP_H__) or it is explicitly overridden
61 by the user (who can define wxUSE_ZLIB_H_IN_PATH), we hardcode the path
62 here
63 */
64# if defined(__WXMSW__) && !defined(__WX_SETUP_H__) && !defined(wxUSE_ZLIB_H_IN_PATH)
65# include "../zlib/zlib.h"
66# else
67# include "zlib.h"
68# endif
69#endif /* _ZLIB_H */
70
71/*
72 Some system zlib.h headers are modified to not define the OF() macro but use
73 the (standard) __P() instead (example: NetBSD 1.6), work around this if
74 needed assuming that we deal with an ANSI C compiler (which is a natural
75 assumption in 21st century!)
76 */
77#ifndef OF
78# define OF(args) args
ac2834ab 79#endif
2b5f62a0
VZ
80
81/*
82 And on some systems ZEXPORT is not defined neither -- work around this too
83 */
84#ifndef ZEXPORT
85# define ZEXPORT
5526e819
VS
86#endif
87
88#if defined(STRICTUNZIP) || defined(STRICTZIPUNZIP)
89/* like the STRICT of WIN32, we define a pointer that cannot be converted
90 from (void*) without cast */
913df6f2 91typedef struct TagunzFile__ { int unused; } unzFile__;
5526e819
VS
92typedef unzFile__ *unzFile;
93#else
94typedef voidp unzFile;
95#endif
96
97
98#define UNZ_OK (0)
99#define UNZ_END_OF_LIST_OF_FILE (-100)
100#define UNZ_ERRNO (Z_ERRNO)
101#define UNZ_EOF (0)
102#define UNZ_PARAMERROR (-102)
103#define UNZ_BADZIPFILE (-103)
104#define UNZ_INTERNALERROR (-104)
105#define UNZ_CRCERROR (-105)
106
107/* tm_unz contain date/time info */
913df6f2 108typedef struct tm_unz_s
5526e819 109{
cb719f2e
WS
110 uInt tm_sec; /* seconds after the minute - [0,59] */
111 uInt tm_min; /* minutes after the hour - [0,59] */
112 uInt tm_hour; /* hours since midnight - [0,23] */
113 uInt tm_mday; /* day of the month - [1,31] */
114 uInt tm_mon; /* months since January - [0,11] */
115 uInt tm_year; /* years - [1980..2044] */
5526e819
VS
116} tm_unz;
117
118/* unz_global_info structure contain global data about the ZIPfile
119 These data comes from the end of central dir */
120typedef struct unz_global_info_s
121{
cb719f2e
WS
122 uLong number_entry; /* total number of entries in
123 the central dir on this disk */
124 uLong size_comment; /* size of the global comment of the zipfile */
5526e819
VS
125} unz_global_info;
126
127
128/* unz_file_info contain information about a file in the zipfile */
129typedef struct unz_file_info_s
130{
131 uLong version; /* version made by 2 bytes */
132 uLong version_needed; /* version needed to extract 2 bytes */
133 uLong flag; /* general purpose bit flag 2 bytes */
134 uLong compression_method; /* compression method 2 bytes */
135 uLong dosDate; /* last mod file date in Dos fmt 4 bytes */
136 uLong crc; /* crc-32 4 bytes */
913df6f2
DW
137 uLong compressed_size; /* compressed size 4 bytes */
138 uLong uncompressed_size; /* uncompressed size 4 bytes */
5526e819
VS
139 uLong size_filename; /* filename length 2 bytes */
140 uLong size_file_extra; /* extra field length 2 bytes */
141 uLong size_file_comment; /* file comment length 2 bytes */
142
143 uLong disk_num_start; /* disk number start 2 bytes */
144 uLong internal_fa; /* internal file attributes 2 bytes */
145 uLong external_fa; /* external file attributes 4 bytes */
146
147 tm_unz tmu_date;
148} unz_file_info;
149
150extern int ZEXPORT unzStringFileNameCompare OF ((const char* fileName1,
cb719f2e
WS
151 const char* fileName2,
152 int iCaseSensitivity));
5526e819
VS
153/*
154 Compare two filename (fileName1,fileName2).
cb719f2e
WS
155 If iCaseSenisivity = 1, comparision is case sensitivity
156 (like strcmp)
157 If iCaseSenisivity = 2, comparision is not case sensitivity
158 (like strcmpi or strcasecmp)
5526e819 159 If iCaseSenisivity = 0, case sensitivity is defaut of your operating system
cb719f2e 160 (like 1 on Unix, 2 on Windows)
5526e819
VS
161*/
162
163
164extern unzFile ZEXPORT unzOpen OF((const char *path));
165/*
166 Open a Zip file. path contain the full pathname (by example,
167 on a Windows NT computer "c:\\zlib\\zlib111.zip" or on an Unix computer
cb719f2e
WS
168 "zlib/zlib111.zip".
169 If the zipfile cannot be opened (file don't exist or in not valid), the
170 return value is NULL.
5526e819 171 Else, the return value is a unzFile Handle, usable with other function
cb719f2e 172 of this unzip package.
5526e819
VS
173*/
174
175extern int ZEXPORT unzClose OF((unzFile file));
176/*
177 Close a ZipFile opened with unzipOpen.
178 If there is files inside the .Zip opened with unzOpenCurrentFile (see later),
179 these files MUST be closed with unzipCloseCurrentFile before call unzipClose.
180 return UNZ_OK if there is no problem. */
181
182extern int ZEXPORT unzGetGlobalInfo OF((unzFile file,
cb719f2e 183 unz_global_info *pglobal_info));
5526e819
VS
184/*
185 Write info about the ZipFile in the *pglobal_info structure.
186 No preparation of the structure is needed
187 return UNZ_OK if there is no problem. */
188
189
190extern int ZEXPORT unzGetGlobalComment OF((unzFile file,
cb719f2e
WS
191 char *szComment,
192 uLong uSizeBuf));
5526e819
VS
193/*
194 Get the global comment string of the ZipFile, in the szComment buffer.
195 uSizeBuf is the size of the szComment buffer.
196 return the number of byte copied or an error code <0
197*/
198
199
200/***************************************************************************/
201/* Unzip package allow you browse the directory of the zipfile */
202
203extern int ZEXPORT unzGoToFirstFile OF((unzFile file));
204/*
205 Set the current file of the zipfile to the first file.
206 return UNZ_OK if there is no problem
207*/
208
209extern int ZEXPORT unzGoToNextFile OF((unzFile file));
210/*
211 Set the current file of the zipfile to the next file.
212 return UNZ_OK if there is no problem
213 return UNZ_END_OF_LIST_OF_FILE if the actual file was the latest.
214*/
215
913df6f2 216extern int ZEXPORT unzLocateFile OF((unzFile file,
cb719f2e
WS
217 const char *szFileName,
218 int iCaseSensitivity));
5526e819
VS
219/*
220 Try locate the file szFileName in the zipfile.
221 For the iCaseSensitivity signification, see unzStringFileNameCompare
222
223 return value :
224 UNZ_OK if the file is found. It becomes the current file.
225 UNZ_END_OF_LIST_OF_FILE if the file is not found
226*/
227
228
229extern int ZEXPORT unzGetCurrentFileInfo OF((unzFile file,
cb719f2e
WS
230 unz_file_info *pfile_info,
231 char *szFileName,
232 uLong fileNameBufferSize,
233 void *extraField,
234 uLong extraFieldBufferSize,
235 char *szComment,
236 uLong commentBufferSize));
5526e819
VS
237/*
238 Get Info about the current file
239 if pfile_info!=NULL, the *pfile_info structure will contain somes info about
cb719f2e 240 the current file
5526e819 241 if szFileName!=NULL, the filemane string will be copied in szFileName
cb719f2e 242 (fileNameBufferSize is the size of the buffer)
5526e819 243 if extraField!=NULL, the extra field information will be copied in extraField
cb719f2e
WS
244 (extraFieldBufferSize is the size of the buffer).
245 This is the Central-header version of the extra field
5526e819 246 if szComment!=NULL, the comment string of the file will be copied in szComment
cb719f2e 247 (commentBufferSize is the size of the buffer)
5526e819
VS
248*/
249
250/***************************************************************************/
251/* for reading the content of the current zipfile, you can open it, read data
252 from it, and close it (you can close it before reading all the file)
253 */
254
255extern int ZEXPORT unzOpenCurrentFile OF((unzFile file));
256/*
257 Open for reading data the current file in the zipfile.
258 If there is no error, the return value is UNZ_OK.
259*/
260
261extern int ZEXPORT unzCloseCurrentFile OF((unzFile file));
262/*
263 Close the file in zip opened with unzOpenCurrentFile
264 Return UNZ_CRCERROR if all the file was read but the CRC is not good
265*/
266
cb719f2e 267
913df6f2 268extern int ZEXPORT unzReadCurrentFile OF((unzFile file,
cb719f2e
WS
269 voidp buf,
270 unsigned len));
5526e819
VS
271/*
272 Read bytes from the current file (opened by unzOpenCurrentFile)
273 buf contain buffer where data must be copied
274 len the size of buf.
275
276 return the number of byte copied if somes bytes are copied
277 return 0 if the end of file was reached
278 return <0 with error code if there is an error
279 (UNZ_ERRNO for IO error, or zLib error for uncompress error)
280*/
281
282extern z_off_t ZEXPORT unztell OF((unzFile file));
283/*
284 Give the current position in uncompressed data
285*/
286
287extern int ZEXPORT unzeof OF((unzFile file));
288/*
913df6f2 289 return 1 if the end of file was reached, 0 elsewhere
5526e819
VS
290*/
291
292extern int ZEXPORT unzGetLocalExtrafield OF((unzFile file,
cb719f2e
WS
293 voidp buf,
294 unsigned len));
5526e819
VS
295/*
296 Read extra field from the current file (opened by unzOpenCurrentFile)
297 This is the local-header version of the extra field (sometimes, there is
298 more info in the local-header version than in the central-header)
299
300 if buf==NULL, it return the size of the local extra field
301
302 if buf!=NULL, len is the size of the buffer, the extra header is copied in
cb719f2e 303 buf.
913df6f2 304 the return value is the number of bytes copied in buf, or (if <0)
cb719f2e 305 the error code
5526e819
VS
306*/
307
c0bcc480 308#if defined(__VISAGECPP__) || defined(__BORLANDC__)
076bae67 309/*Visualage complains of no prototypes*/
913df6f2
DW
310int unzlocal_getByte(FILE* , int*);
311int strcmpcasenosensitive_internal (const char*, const char*);
312int unzlocal_getShort (FILE*, uLong*);
313int unzlocal_getLong (FILE*, uLong*);
314uLong unzlocal_SearchCentralDir(FILE*);
315void unzlocal_DosDateToTmuDate (uLong, tm_unz*);
316#endif
317
5526e819
VS
318#ifdef __cplusplus
319}
320#endif
321
322#endif /* _unz_H */