[wxWidgets.git] / src / common / unzip.h

/*

This file was altered for needs of wxWindows.
$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

#ifndef _ZLIB_H
#include "zlib.h"
#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__)
/*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
076bae67 VS	1	/*
	2
	3	This file was altered for needs of wxWindows.
	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
	52	extern "C" {
	53	#endif
	54
	55	#ifndef _ZLIB_H
	56	#include "zlib.h"
	57	#endif
	58
	59	#if defined(STRICTUNZIP) \|\| defined(STRICTZIPUNZIP)
	60	/* like the STRICT of WIN32, we define a pointer that cannot be converted
	61	from (void) without cast /
913df6f2	62	typedef struct TagunzFile__ { int unused; } unzFile__;
5526e819 VS	63	typedef unzFile__ *unzFile;
	64	#else
	65	typedef voidp unzFile;
	66	#endif
	67
	68
	69	#define UNZ_OK (0)
	70	#define UNZ_END_OF_LIST_OF_FILE (-100)
	71	#define UNZ_ERRNO (Z_ERRNO)
	72	#define UNZ_EOF (0)
	73	#define UNZ_PARAMERROR (-102)
	74	#define UNZ_BADZIPFILE (-103)
	75	#define UNZ_INTERNALERROR (-104)
	76	#define UNZ_CRCERROR (-105)
	77
	78	/* tm_unz contain date/time info */
913df6f2	79	typedef struct tm_unz_s
5526e819 VS	80	{
	81	uInt tm_sec; /* seconds after the minute - [0,59] */
	82	uInt tm_min; /* minutes after the hour - [0,59] */
	83	uInt tm_hour; /* hours since midnight - [0,23] */
	84	uInt tm_mday; /* day of the month - [1,31] */
	85	uInt tm_mon; /* months since January - [0,11] */
	86	uInt tm_year; /* years - [1980..2044] */
	87	} tm_unz;
	88
	89	/* unz_global_info structure contain global data about the ZIPfile
	90	These data comes from the end of central dir */
	91	typedef struct unz_global_info_s
	92	{
	93	uLong number_entry; /* total number of entries in
	94	the central dir on this disk */
	95	uLong size_comment; /* size of the global comment of the zipfile */
	96	} unz_global_info;
	97
	98
	99	/* unz_file_info contain information about a file in the zipfile */
	100	typedef struct unz_file_info_s
	101	{
	102	uLong version; /* version made by 2 bytes */
	103	uLong version_needed; /* version needed to extract 2 bytes */
	104	uLong flag; /* general purpose bit flag 2 bytes */
	105	uLong compression_method; /* compression method 2 bytes */
	106	uLong dosDate; /* last mod file date in Dos fmt 4 bytes */
	107	uLong crc; /* crc-32 4 bytes */
913df6f2 DW	108	uLong compressed_size; /* compressed size 4 bytes */
913df6f2 DW	109	uLong uncompressed_size; /* uncompressed size 4 bytes */
5526e819 VS	110	uLong size_filename; /* filename length 2 bytes */
	111	uLong size_file_extra; /* extra field length 2 bytes */
	112	uLong size_file_comment; /* file comment length 2 bytes */
	113
	114	uLong disk_num_start; /* disk number start 2 bytes */
	115	uLong internal_fa; /* internal file attributes 2 bytes */
	116	uLong external_fa; /* external file attributes 4 bytes */
	117
	118	tm_unz tmu_date;
	119	} unz_file_info;
	120
	121	extern int ZEXPORT unzStringFileNameCompare OF ((const char* fileName1,
	122	const char* fileName2,
	123	int iCaseSensitivity));
	124	/*
	125	Compare two filename (fileName1,fileName2).
	126	If iCaseSenisivity = 1, comparision is case sensitivity (like strcmp)
	127	If iCaseSenisivity = 2, comparision is not case sensitivity (like strcmpi
	128	or strcasecmp)
	129	If iCaseSenisivity = 0, case sensitivity is defaut of your operating system
	130	(like 1 on Unix, 2 on Windows)
	131	*/
	132
	133
	134	extern unzFile ZEXPORT unzOpen OF((const char *path));
	135	/*
	136	Open a Zip file. path contain the full pathname (by example,
	137	on a Windows NT computer "c:\\zlib\\zlib111.zip" or on an Unix computer
	138	"zlib/zlib111.zip".
	139	If the zipfile cannot be opened (file don't exist or in not valid), the
	140	return value is NULL.
	141	Else, the return value is a unzFile Handle, usable with other function
	142	of this unzip package.
	143	*/
	144
	145	extern int ZEXPORT unzClose OF((unzFile file));
	146	/*
	147	Close a ZipFile opened with unzipOpen.
	148	If there is files inside the .Zip opened with unzOpenCurrentFile (see later),
	149	these files MUST be closed with unzipCloseCurrentFile before call unzipClose.
	150	return UNZ_OK if there is no problem. */
	151
	152	extern int ZEXPORT unzGetGlobalInfo OF((unzFile file,
	153	unz_global_info *pglobal_info));
	154	/*
	155	Write info about the ZipFile in the *pglobal_info structure.
	156	No preparation of the structure is needed
	157	return UNZ_OK if there is no problem. */
	158
	159
	160	extern int ZEXPORT unzGetGlobalComment OF((unzFile file,
	161	char *szComment,
	162	uLong uSizeBuf));
	163	/*
	164	Get the global comment string of the ZipFile, in the szComment buffer.
	165	uSizeBuf is the size of the szComment buffer.
	166	return the number of byte copied or an error code <0
	167	*/
	168
	169
	170	/***************************************************************************/
	171	/* Unzip package allow you browse the directory of the zipfile */
	172
	173	extern int ZEXPORT unzGoToFirstFile OF((unzFile file));
174	/*
175	Set the current file of the zipfile to the first file.
176	return UNZ_OK if there is no problem
177	*/
178
179	extern int ZEXPORT unzGoToNextFile OF((unzFile file));
180	/*
181	Set the current file of the zipfile to the next file.
182	return UNZ_OK if there is no problem
183	return UNZ_END_OF_LIST_OF_FILE if the actual file was the latest.
184	*/
185
913df6f2	186	extern int ZEXPORT unzLocateFile OF((unzFile file,
5526e819 VS	187	const char *szFileName,
	188	int iCaseSensitivity));
	189	/*
	190	Try locate the file szFileName in the zipfile.
	191	For the iCaseSensitivity signification, see unzStringFileNameCompare
	192
	193	return value :
	194	UNZ_OK if the file is found. It becomes the current file.
	195	UNZ_END_OF_LIST_OF_FILE if the file is not found
	196	*/
	197
	198
	199	extern int ZEXPORT unzGetCurrentFileInfo OF((unzFile file,
	200	unz_file_info *pfile_info,
	201	char *szFileName,
	202	uLong fileNameBufferSize,
	203	void *extraField,
	204	uLong extraFieldBufferSize,
	205	char *szComment,
	206	uLong commentBufferSize));
	207	/*
	208	Get Info about the current file
	209	if pfile_info!=NULL, the *pfile_info structure will contain somes info about
	210	the current file
	211	if szFileName!=NULL, the filemane string will be copied in szFileName
	212	(fileNameBufferSize is the size of the buffer)
	213	if extraField!=NULL, the extra field information will be copied in extraField
	214	(extraFieldBufferSize is the size of the buffer).
	215	This is the Central-header version of the extra field
	216	if szComment!=NULL, the comment string of the file will be copied in szComment
	217	(commentBufferSize is the size of the buffer)
	218	*/
	219
	220	/***************************************************************************/
	221	/* for reading the content of the current zipfile, you can open it, read data
	222	from it, and close it (you can close it before reading all the file)
	223	*/
	224
	225	extern int ZEXPORT unzOpenCurrentFile OF((unzFile file));
	226	/*
	227	Open for reading data the current file in the zipfile.
	228	If there is no error, the return value is UNZ_OK.
	229	*/
	230
	231	extern int ZEXPORT unzCloseCurrentFile OF((unzFile file));
	232	/*
	233	Close the file in zip opened with unzOpenCurrentFile
	234	Return UNZ_CRCERROR if all the file was read but the CRC is not good
	235	*/
	236
	237
913df6f2	238	extern int ZEXPORT unzReadCurrentFile OF((unzFile file,
5526e819 VS	239	voidp buf,
	240	unsigned len));
	241	/*
	242	Read bytes from the current file (opened by unzOpenCurrentFile)
	243	buf contain buffer where data must be copied
	244	len the size of buf.
	245
	246	return the number of byte copied if somes bytes are copied
	247	return 0 if the end of file was reached
	248	return <0 with error code if there is an error
	249	(UNZ_ERRNO for IO error, or zLib error for uncompress error)
	250	*/
	251
	252	extern z_off_t ZEXPORT unztell OF((unzFile file));
	253	/*
	254	Give the current position in uncompressed data
	255	*/
	256
	257	extern int ZEXPORT unzeof OF((unzFile file));
	258	/*
913df6f2	259	return 1 if the end of file was reached, 0 elsewhere
5526e819 VS	260	*/
	261
	262	extern int ZEXPORT unzGetLocalExtrafield OF((unzFile file,
	263	voidp buf,
	264	unsigned len));
	265	/*
	266	Read extra field from the current file (opened by unzOpenCurrentFile)
	267	This is the local-header version of the extra field (sometimes, there is
	268	more info in the local-header version than in the central-header)
	269
	270	if buf==NULL, it return the size of the local extra field
	271
	272	if buf!=NULL, len is the size of the buffer, the extra header is copied in
	273	buf.
913df6f2	274	the return value is the number of bytes copied in buf, or (if <0)
5526e819 VS	275	the error code
	276	*/
	277
913df6f2	278	#if defined(__VISAGECPP__)
076bae67	279	/Visualage complains of no prototypes/
913df6f2 DW	280	int unzlocal_getByte(FILE* , int*);
	281	int strcmpcasenosensitive_internal (const char, const char);
	282	int unzlocal_getShort (FILE, uLong);
	283	int unzlocal_getLong (FILE, uLong);
	284	uLong unzlocal_SearchCentralDir(FILE*);
	285	void unzlocal_DosDateToTmuDate (uLong, tm_unz*);
	286	#endif
	287
5526e819 VS	288	#ifdef __cplusplus
	289	}
	290	#endif
	291
	292	#endif /* _unz_H */