home *** CD-ROM | disk | FTP | other *** search
/ Freelog 11 / Freelog011.iso / Bas / Compression / ZLib / contrib / minizip / unzip.h < prev    next >
C/C++ Source or Header  |  1998-03-18  |  10KB  |  276 lines
  1. /* unzip.h -- IO for uncompress .zip files using zlib 
  2.    Version 0.15 beta, Mar 19th, 1998,
  3.  
  4.    Copyright (C) 1998 Gilles Vollant
  5.  
  6.    This unzip package allow extract file from .ZIP file, compatible with PKZip 2.04g
  7.      WinZip, InfoZip tools and compatible.
  8.    Encryption and multi volume ZipFile (span) are not supported.
  9.    Old compressions used by old PKZip 1.x are not supported
  10.  
  11.    THIS IS AN ALPHA VERSION. AT THIS STAGE OF DEVELOPPEMENT, SOMES API OR STRUCTURE
  12.    CAN CHANGE IN FUTURE VERSION !!
  13.    I WAIT FEEDBACK at mail info@winimage.com
  14.    Visit also http://www.winimage.com/zLibDll/unzip.htm for evolution
  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. /* for more info about .ZIP format, see 
  37.       ftp://ftp.cdrom.com/pub/infozip/doc/appnote-970311-iz.zip
  38.    PkWare has also a specification at :
  39.       ftp://ftp.pkware.com/probdesc.zip */
  40.  
  41. #ifndef _unz_H
  42. #define _unz_H
  43.  
  44. #ifdef __cplusplus
  45. extern "C" {
  46. #endif
  47.  
  48. #ifndef _ZLIB_H
  49. #include "zlib.h"
  50. #endif
  51.  
  52. #if defined(STRICTUNZIP) || defined(STRICTZIPUNZIP)
  53. /* like the STRICT of WIN32, we define a pointer that cannot be converted
  54.     from (void*) without cast */
  55. typedef struct TagunzFile__ { int unused; } unzFile__; 
  56. typedef unzFile__ *unzFile;
  57. #else
  58. typedef voidp unzFile;
  59. #endif
  60.  
  61.  
  62. #define UNZ_OK                                  (0)
  63. #define UNZ_END_OF_LIST_OF_FILE (-100)
  64. #define UNZ_ERRNO               (Z_ERRNO)
  65. #define UNZ_EOF                 (0)
  66. #define UNZ_PARAMERROR                  (-102)
  67. #define UNZ_BADZIPFILE                  (-103)
  68. #define UNZ_INTERNALERROR               (-104)
  69. #define UNZ_CRCERROR                    (-105)
  70.  
  71. /* tm_unz contain date/time info */
  72. typedef struct tm_unz_s 
  73. {
  74.     uInt tm_sec;            /* seconds after the minute - [0,59] */
  75.     uInt tm_min;            /* minutes after the hour - [0,59] */
  76.     uInt tm_hour;           /* hours since midnight - [0,23] */
  77.     uInt tm_mday;           /* day of the month - [1,31] */
  78.     uInt tm_mon;            /* months since January - [0,11] */
  79.     uInt tm_year;           /* years - [1980..2044] */
  80. } tm_unz;
  81.  
  82. /* unz_global_info structure contain global data about the ZIPfile
  83.    These data comes from the end of central dir */
  84. typedef struct unz_global_info_s
  85. {
  86.     uLong number_entry;         /* total number of entries in
  87.                        the central dir on this disk */
  88.     uLong size_comment;         /* size of the global comment of the zipfile */
  89. } unz_global_info;
  90.  
  91.  
  92. /* unz_file_info contain information about a file in the zipfile */
  93. typedef struct unz_file_info_s
  94. {
  95.     uLong version;              /* version made by                 2 bytes */
  96.     uLong version_needed;       /* version needed to extract       2 bytes */
  97.     uLong flag;                 /* general purpose bit flag        2 bytes */
  98.     uLong compression_method;   /* compression method              2 bytes */
  99.     uLong dosDate;              /* last mod file date in Dos fmt   4 bytes */
  100.     uLong crc;                  /* crc-32                          4 bytes */
  101.     uLong compressed_size;      /* compressed size                 4 bytes */ 
  102.     uLong uncompressed_size;    /* uncompressed size               4 bytes */ 
  103.     uLong size_filename;        /* filename length                 2 bytes */
  104.     uLong size_file_extra;      /* extra field length              2 bytes */
  105.     uLong size_file_comment;    /* file comment length             2 bytes */
  106.  
  107.     uLong disk_num_start;       /* disk number start               2 bytes */
  108.     uLong internal_fa;          /* internal file attributes        2 bytes */
  109.     uLong external_fa;          /* external file attributes        4 bytes */
  110.  
  111.     tm_unz tmu_date;
  112. } unz_file_info;
  113.  
  114. extern int ZEXPORT unzStringFileNameCompare OF ((const char* fileName1,
  115.                                                  const char* fileName2,
  116.                                                  int iCaseSensitivity));
  117. /*
  118.    Compare two filename (fileName1,fileName2).
  119.    If iCaseSenisivity = 1, comparision is case sensitivity (like strcmp)
  120.    If iCaseSenisivity = 2, comparision is not case sensitivity (like strcmpi
  121.                                 or strcasecmp)
  122.    If iCaseSenisivity = 0, case sensitivity is defaut of your operating system
  123.     (like 1 on Unix, 2 on Windows)
  124. */
  125.  
  126.  
  127. extern unzFile ZEXPORT unzOpen OF((const char *path));
  128. /*
  129.   Open a Zip file. path contain the full pathname (by example,
  130.      on a Windows NT computer "c:\\zlib\\zlib111.zip" or on an Unix computer
  131.      "zlib/zlib111.zip".
  132.      If the zipfile cannot be opened (file don't exist or in not valid), the
  133.        return value is NULL.
  134.      Else, the return value is a unzFile Handle, usable with other function
  135.        of this unzip package.
  136. */
  137.  
  138. extern int ZEXPORT unzClose OF((unzFile file));
  139. /*
  140.   Close a ZipFile opened with unzipOpen.
  141.   If there is files inside the .Zip opened with unzOpenCurrentFile (see later),
  142.     these files MUST be closed with unzipCloseCurrentFile before call unzipClose.
  143.   return UNZ_OK if there is no problem. */
  144.  
  145. extern int ZEXPORT unzGetGlobalInfo OF((unzFile file,
  146.                     unz_global_info *pglobal_info));
  147. /*
  148.   Write info about the ZipFile in the *pglobal_info structure.
  149.   No preparation of the structure is needed
  150.   return UNZ_OK if there is no problem. */
  151.  
  152.  
  153. extern int ZEXPORT unzGetGlobalComment OF((unzFile file,
  154.                                            char *szComment,
  155.                        uLong uSizeBuf));
  156. /*
  157.   Get the global comment string of the ZipFile, in the szComment buffer.
  158.   uSizeBuf is the size of the szComment buffer.
  159.   return the number of byte copied or an error code <0
  160. */
  161.  
  162.  
  163. /***************************************************************************/
  164. /* Unzip package allow you browse the directory of the zipfile */
  165.  
  166. extern int ZEXPORT unzGoToFirstFile OF((unzFile file));
  167. /*
  168.   Set the current file of the zipfile to the first file.
  169.   return UNZ_OK if there is no problem
  170. */
  171.  
  172. extern int ZEXPORT unzGoToNextFile OF((unzFile file));
  173. /*
  174.   Set the current file of the zipfile to the next file.
  175.   return UNZ_OK if there is no problem
  176.   return UNZ_END_OF_LIST_OF_FILE if the actual file was the latest.
  177. */
  178.  
  179. extern int ZEXPORT unzLocateFile OF((unzFile file, 
  180.                      const char *szFileName,
  181.                      int iCaseSensitivity));
  182. /*
  183.   Try locate the file szFileName in the zipfile.
  184.   For the iCaseSensitivity signification, see unzStringFileNameCompare
  185.  
  186.   return value :
  187.   UNZ_OK if the file is found. It becomes the current file.
  188.   UNZ_END_OF_LIST_OF_FILE if the file is not found
  189. */
  190.  
  191.  
  192. extern int ZEXPORT unzGetCurrentFileInfo OF((unzFile file,
  193.                          unz_file_info *pfile_info,
  194.                          char *szFileName,
  195.                          uLong fileNameBufferSize,
  196.                          void *extraField,
  197.                          uLong extraFieldBufferSize,
  198.                          char *szComment,
  199.                          uLong commentBufferSize));
  200. /*
  201.   Get Info about the current file
  202.   if pfile_info!=NULL, the *pfile_info structure will contain somes info about
  203.         the current file
  204.   if szFileName!=NULL, the filemane string will be copied in szFileName
  205.             (fileNameBufferSize is the size of the buffer)
  206.   if extraField!=NULL, the extra field information will be copied in extraField
  207.             (extraFieldBufferSize is the size of the buffer).
  208.             This is the Central-header version of the extra field
  209.   if szComment!=NULL, the comment string of the file will be copied in szComment
  210.             (commentBufferSize is the size of the buffer)
  211. */
  212.  
  213. /***************************************************************************/
  214. /* for reading the content of the current zipfile, you can open it, read data
  215.    from it, and close it (you can close it before reading all the file)
  216.    */
  217.  
  218. extern int ZEXPORT unzOpenCurrentFile OF((unzFile file));
  219. /*
  220.   Open for reading data the current file in the zipfile.
  221.   If there is no error, the return value is UNZ_OK.
  222. */
  223.  
  224. extern int ZEXPORT unzCloseCurrentFile OF((unzFile file));
  225. /*
  226.   Close the file in zip opened with unzOpenCurrentFile
  227.   Return UNZ_CRCERROR if all the file was read but the CRC is not good
  228. */
  229.  
  230.                                                 
  231. extern int ZEXPORT unzReadCurrentFile OF((unzFile file, 
  232.                       voidp buf,
  233.                       unsigned len));
  234. /*
  235.   Read bytes from the current file (opened by unzOpenCurrentFile)
  236.   buf contain buffer where data must be copied
  237.   len the size of buf.
  238.  
  239.   return the number of byte copied if somes bytes are copied
  240.   return 0 if the end of file was reached
  241.   return <0 with error code if there is an error
  242.     (UNZ_ERRNO for IO error, or zLib error for uncompress error)
  243. */
  244.  
  245. extern z_off_t ZEXPORT unztell OF((unzFile file));
  246. /*
  247.   Give the current position in uncompressed data
  248. */
  249.  
  250. extern int ZEXPORT unzeof OF((unzFile file));
  251. /*
  252.   return 1 if the end of file was reached, 0 elsewhere 
  253. */
  254.  
  255. extern int ZEXPORT unzGetLocalExtrafield OF((unzFile file,
  256.                                              voidp buf,
  257.                                              unsigned len));
  258. /*
  259.   Read extra field from the current file (opened by unzOpenCurrentFile)
  260.   This is the local-header version of the extra field (sometimes, there is
  261.     more info in the local-header version than in the central-header)
  262.  
  263.   if buf==NULL, it return the size of the local extra field
  264.  
  265.   if buf!=NULL, len is the size of the buffer, the extra header is copied in
  266.     buf.
  267.   the return value is the number of bytes copied in buf, or (if <0) 
  268.     the error code
  269. */
  270.  
  271. #ifdef __cplusplus
  272. }
  273. #endif
  274.  
  275. #endif /* _unz_H */
  276.