src/common/unzip.h

/*

This file was altered for needs of wxWidgets.
$Id$

*/

/* unzip.h -- IO for uncompress .zip files using zlib
   Version 0.15 beta, Mar 19th, 1998,

   Copyright (C) 1998 Gilles Vollant

   This unzip package allow extract file from .ZIP file, compatible with PKZip 2.04g
     WinZip, InfoZip tools and compatible.
   Encryption and multi volume ZipFile (span) are not supported.
   Old compressions used by old PKZip 1.x are not supported

   THIS IS AN ALPHA VERSION. AT THIS STAGE OF DEVELOPPEMENT, SOMES API OR STRUCTURE
   CAN CHANGE IN FUTURE VERSION !!
   I WAIT FEEDBACK at mail info@winimage.com
   Visit also http://www.winimage.com/zLibDll/unzip.htm for evolution

   Condition of use and distribution are the same than zlib :

  This software is provided 'as-is', without any express or implied
  warranty.  In no event will the authors be held liable for any damages
  arising from the use of this software.

  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:

  1. The origin of this software must not be misrepresented; you must not
     claim that you wrote the original software. If you use this software
     in a product, an acknowledgment in the product documentation would be
     appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be
     misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.


*/
/* for more info about .ZIP format, see
      ftp://ftp.cdrom.com/pub/infozip/doc/appnote-970311-iz.zip
   PkWare has also a specification at :
      ftp://ftp.pkware.com/probdesc.zip */

#ifndef _unz_H
#define _unz_H

#ifdef __cplusplus
extern "C" {
#endif

/* include zlib.h if not done yet */
#ifndef _ZLIB_H
    /*
       normally, the compiler options should contain -I../zlib, but it is
       apparently not the case for all MSW makefiles and so, unless we use
       configure (which defines __WX_SETUP_H__) or it is explicitly overridden
       by the user (who can define wxUSE_ZLIB_H_IN_PATH), we hardcode the path
       here
     */
#   if defined(__WXMSW__) && !defined(__WX_SETUP_H__) && !defined(wxUSE_ZLIB_H_IN_PATH)
#       include "../zlib/zlib.h"
#   else
#       include "zlib.h"
#   endif
#endif /* _ZLIB_H */

/*
   Some system zlib.h headers are modified to not define the OF() macro but use
   the (standard) __P() instead (example: NetBSD 1.6), work around this if
   needed assuming that we deal with an ANSI C compiler (which is a natural
   assumption in 21st century!)
 */
#ifndef OF
#   define OF(args) args
#endif

/*
   And on some systems ZEXPORT is not defined neither -- work around this too
 */
#ifndef ZEXPORT
#   define ZEXPORT
#endif

#if defined(STRICTUNZIP) || defined(STRICTZIPUNZIP)
/* like the STRICT of WIN32, we define a pointer that cannot be converted
    from (void*) without cast */
typedef struct TagunzFile__ { int unused; } unzFile__;
typedef unzFile__ *unzFile;
#else
typedef voidp unzFile;
#endif


#define UNZ_OK                                  (0)
#define UNZ_END_OF_LIST_OF_FILE (-100)
#define UNZ_ERRNO               (Z_ERRNO)
#define UNZ_EOF                 (0)
#define UNZ_PARAMERROR                  (-102)
#define UNZ_BADZIPFILE                  (-103)
#define UNZ_INTERNALERROR               (-104)
#define UNZ_CRCERROR                    (-105)

/* tm_unz contain date/time info */
typedef struct tm_unz_s
{
    uInt tm_sec;            /* seconds after the minute - [0,59] */
    uInt tm_min;            /* minutes after the hour - [0,59] */
    uInt tm_hour;           /* hours since midnight - [0,23] */
    uInt tm_mday;           /* day of the month - [1,31] */
    uInt tm_mon;            /* months since January - [0,11] */
    uInt tm_year;           /* years - [1980..2044] */
} tm_unz;

/* unz_global_info structure contain global data about the ZIPfile
   These data comes from the end of central dir */
typedef struct unz_global_info_s
{
    uLong number_entry;         /* total number of entries in
                                   the central dir on this disk */
    uLong size_comment;         /* size of the global comment of the zipfile */
} unz_global_info;


/* unz_file_info contain information about a file in the zipfile */
typedef struct unz_file_info_s
{
    uLong version;              /* version made by                 2 bytes */
    uLong version_needed;       /* version needed to extract       2 bytes */
    uLong flag;                 /* general purpose bit flag        2 bytes */
    uLong compression_method;   /* compression method              2 bytes */
    uLong dosDate;              /* last mod file date in Dos fmt   4 bytes */
    uLong crc;                  /* crc-32                          4 bytes */
    uLong compressed_size;      /* compressed size                 4 bytes */
    uLong uncompressed_size;    /* uncompressed size               4 bytes */
    uLong size_filename;        /* filename length                 2 bytes */
    uLong size_file_extra;      /* extra field length              2 bytes */
    uLong size_file_comment;    /* file comment length             2 bytes */

    uLong disk_num_start;       /* disk number start               2 bytes */
    uLong internal_fa;          /* internal file attributes        2 bytes */
    uLong external_fa;          /* external file attributes        4 bytes */

    tm_unz tmu_date;
} unz_file_info;

extern int ZEXPORT unzStringFileNameCompare OF ((const char* fileName1,
                                                 const char* fileName2,
                                                 int iCaseSensitivity));
/*
   Compare two filename (fileName1,fileName2).
   If iCaseSenisivity = 1, comparision is case sensitivity
                           (like strcmp)
   If iCaseSenisivity = 2, comparision is not case sensitivity
                           (like strcmpi or strcasecmp)
   If iCaseSenisivity = 0, case sensitivity is defaut of your operating system
                           (like 1 on Unix, 2 on Windows)
*/


extern unzFile ZEXPORT unzOpen OF((const char *path));
/*
  Open a Zip file. path contain the full pathname (by example,
     on a Windows NT computer "c:\\zlib\\zlib111.zip" or on an Unix computer
     "zlib/zlib111.zip".
     If the zipfile cannot be opened (file don't exist or in not valid), the
       return value is NULL.
     Else, the return value is a unzFile Handle, usable with other function
       of this unzip package.
*/

extern int ZEXPORT unzClose OF((unzFile file));
/*
  Close a ZipFile opened with unzipOpen.
  If there is files inside the .Zip opened with unzOpenCurrentFile (see later),
    these files MUST be closed with unzipCloseCurrentFile before call unzipClose.
  return UNZ_OK if there is no problem. */

extern int ZEXPORT unzGetGlobalInfo OF((unzFile file,
                                        unz_global_info *pglobal_info));
/*
  Write info about the ZipFile in the *pglobal_info structure.
  No preparation of the structure is needed
  return UNZ_OK if there is no problem. */


extern int ZEXPORT unzGetGlobalComment OF((unzFile file,
                                           char *szComment,
                                           uLong uSizeBuf));
/*
  Get the global comment string of the ZipFile, in the szComment buffer.
  uSizeBuf is the size of the szComment buffer.
  return the number of byte copied or an error code <0
*/


/***************************************************************************/
/* Unzip package allow you browse the directory of the zipfile */

extern int ZEXPORT unzGoToFirstFile OF((unzFile file));
/*
  Set the current file of the zipfile to the first file.
  return UNZ_OK if there is no problem
*/

extern int ZEXPORT unzGoToNextFile OF((unzFile file));
/*
  Set the current file of the zipfile to the next file.
  return UNZ_OK if there is no problem
  return UNZ_END_OF_LIST_OF_FILE if the actual file was the latest.
*/

extern int ZEXPORT unzLocateFile OF((unzFile file,
                                     const char *szFileName,
                                     int iCaseSensitivity));
/*
  Try locate the file szFileName in the zipfile.
  For the iCaseSensitivity signification, see unzStringFileNameCompare

  return value :
  UNZ_OK if the file is found. It becomes the current file.
  UNZ_END_OF_LIST_OF_FILE if the file is not found
*/


extern int ZEXPORT unzGetCurrentFileInfo OF((unzFile file,
                                             unz_file_info *pfile_info,
                                             char *szFileName,
                                             uLong fileNameBufferSize,
                                             void *extraField,
                                             uLong extraFieldBufferSize,
                                             char *szComment,
                                             uLong commentBufferSize));
/*
  Get Info about the current file
  if pfile_info!=NULL, the *pfile_info structure will contain somes info about
        the current file
  if szFileName!=NULL, the filemane string will be copied in szFileName
            (fileNameBufferSize is the size of the buffer)
  if extraField!=NULL, the extra field information will be copied in extraField
            (extraFieldBufferSize is the size of the buffer).
            This is the Central-header version of the extra field
  if szComment!=NULL, the comment string of the file will be copied in szComment
            (commentBufferSize is the size of the buffer)
*/

/***************************************************************************/
/* for reading the content of the current zipfile, you can open it, read data
   from it, and close it (you can close it before reading all the file)
   */

extern int ZEXPORT unzOpenCurrentFile OF((unzFile file));
/*
  Open for reading data the current file in the zipfile.
  If there is no error, the return value is UNZ_OK.
*/

extern int ZEXPORT unzCloseCurrentFile OF((unzFile file));
/*
  Close the file in zip opened with unzOpenCurrentFile
  Return UNZ_CRCERROR if all the file was read but the CRC is not good
*/


extern int ZEXPORT unzReadCurrentFile OF((unzFile file,
                                          voidp buf,
                                          unsigned len));
/*
  Read bytes from the current file (opened by unzOpenCurrentFile)
  buf contain buffer where data must be copied
  len the size of buf.

  return the number of byte copied if somes bytes are copied
  return 0 if the end of file was reached
  return <0 with error code if there is an error
    (UNZ_ERRNO for IO error, or zLib error for uncompress error)
*/

extern z_off_t ZEXPORT unztell OF((unzFile file));
/*
  Give the current position in uncompressed data
*/

extern int ZEXPORT unzeof OF((unzFile file));
/*
  return 1 if the end of file was reached, 0 elsewhere
*/

extern int ZEXPORT unzGetLocalExtrafield OF((unzFile file,
                                             voidp buf,
                                             unsigned len));
/*
  Read extra field from the current file (opened by unzOpenCurrentFile)
  This is the local-header version of the extra field (sometimes, there is
    more info in the local-header version than in the central-header)

  if buf==NULL, it return the size of the local extra field

  if buf!=NULL, len is the size of the buffer, the extra header is copied in
    buf.
  the return value is the number of bytes copied in buf, or (if <0)
    the error code
*/

#if defined(__VISAGECPP__) || defined(__BORLANDC__)
/*Visualage complains of no prototypes*/
int unzlocal_getByte(FILE* , int*);
int strcmpcasenosensitive_internal (const char*, const char*);
int unzlocal_getShort (FILE*, uLong*);
int unzlocal_getLong (FILE*, uLong*);
uLong unzlocal_SearchCentralDir(FILE*);
void unzlocal_DosDateToTmuDate (uLong, tm_unz*);
#endif

#ifdef __cplusplus
}
#endif

#endif /* _unz_H */
Commit	Line	Data
	1	/*
	2
	3	This file was altered for needs of wxWidgets.
	4	$Id$
	5
	6	*/
	7
	8	/* unzip.h -- IO for uncompress .zip files using zlib
	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	*/
	43	/* for more info about .ZIP format, see
	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
	52	extern "C" {
	53	#endif
	54
	55	/* include zlib.h if not done yet */
	56	#ifndef _ZLIB_H
	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
	79	#endif
	80
	81	/*
	82	And on some systems ZEXPORT is not defined neither -- work around this too
	83	*/
	84	#ifndef ZEXPORT
	85	# define ZEXPORT
	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 /
	91	typedef struct TagunzFile__ { int unused; } unzFile__;
	92	typedef unzFile__ *unzFile;
	93	#else
	94	typedef 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 */
	108	typedef struct tm_unz_s
	109	{
	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] */
	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 */
	120	typedef struct unz_global_info_s
	121	{
	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 */
	125	} unz_global_info;
	126
	127
	128	/* unz_file_info contain information about a file in the zipfile */
	129	typedef 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 */
	137	uLong compressed_size; /* compressed size 4 bytes */
	138	uLong uncompressed_size; /* uncompressed size 4 bytes */
	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
	150	extern int ZEXPORT unzStringFileNameCompare OF ((const char* fileName1,
	151	const char* fileName2,
	152	int iCaseSensitivity));
	153	/*
	154	Compare two filename (fileName1,fileName2).
	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)
	159	If iCaseSenisivity = 0, case sensitivity is defaut of your operating system
	160	(like 1 on Unix, 2 on Windows)
	161	*/
	162
	163
	164	extern 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
	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.
	171	Else, the return value is a unzFile Handle, usable with other function
	172	of this unzip package.
	173	*/
	174
	175	extern 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
	182	extern int ZEXPORT unzGetGlobalInfo OF((unzFile file,
	183	unz_global_info *pglobal_info));
	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
	190	extern int ZEXPORT unzGetGlobalComment OF((unzFile file,
	191	char *szComment,
	192	uLong uSizeBuf));
	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
	203	extern 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
	209	extern 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
	216	extern int ZEXPORT unzLocateFile OF((unzFile file,
	217	const char *szFileName,
	218	int iCaseSensitivity));
	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
	229	extern int ZEXPORT unzGetCurrentFileInfo OF((unzFile file,
	230	unz_file_info *pfile_info,
	231	char *szFileName,
	232	uLong fileNameBufferSize,
	233	void *extraField,
	234	uLong extraFieldBufferSize,
	235	char *szComment,
	236	uLong commentBufferSize));
	237	/*
	238	Get Info about the current file
	239	if pfile_info!=NULL, the *pfile_info structure will contain somes info about
	240	the current file
	241	if szFileName!=NULL, the filemane string will be copied in szFileName
	242	(fileNameBufferSize is the size of the buffer)
	243	if extraField!=NULL, the extra field information will be copied in extraField
	244	(extraFieldBufferSize is the size of the buffer).
	245	This is the Central-header version of the extra field
	246	if szComment!=NULL, the comment string of the file will be copied in szComment
	247	(commentBufferSize is the size of the buffer)
	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
	255	extern 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
	261	extern 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
	267
	268	extern int ZEXPORT unzReadCurrentFile OF((unzFile file,
	269	voidp buf,
	270	unsigned len));
	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
	282	extern z_off_t ZEXPORT unztell OF((unzFile file));
	283	/*
	284	Give the current position in uncompressed data
	285	*/
	286
	287	extern int ZEXPORT unzeof OF((unzFile file));
	288	/*
	289	return 1 if the end of file was reached, 0 elsewhere
	290	*/
	291
	292	extern int ZEXPORT unzGetLocalExtrafield OF((unzFile file,
	293	voidp buf,
	294	unsigned len));
	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
	303	buf.
	304	the return value is the number of bytes copied in buf, or (if <0)
	305	the error code
	306	*/
	307
	308	#if defined(__VISAGECPP__) \|\| defined(__BORLANDC__)
	309	/Visualage complains of no prototypes/
	310	int unzlocal_getByte(FILE* , int*);
	311	int strcmpcasenosensitive_internal (const char, const char);
	312	int unzlocal_getShort (FILE, uLong);
	313	int unzlocal_getLong (FILE, uLong);
	314	uLong unzlocal_SearchCentralDir(FILE*);
	315	void unzlocal_DosDateToTmuDate (uLong, tm_unz*);
	316	#endif
	317
	318	#ifdef __cplusplus
	319	}
	320	#endif
	321
	322	#endif /* _unz_H */