]>
Commit | Line | Data |
---|---|---|
7eb75bcc DM |
1 | /* zlib.h -- interface of the 'zlib' general purpose compression library\r |
2 | version 1.2.8, April 28th, 2013\r | |
3 | \r | |
4 | Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler\r | |
5 | \r | |
6 | This software is provided 'as-is', without any express or implied\r | |
7 | warranty. In no event will the authors be held liable for any damages\r | |
8 | arising from the use of this software.\r | |
9 | \r | |
10 | Permission is granted to anyone to use this software for any purpose,\r | |
11 | including commercial applications, and to alter it and redistribute it\r | |
12 | freely, subject to the following restrictions:\r | |
13 | \r | |
14 | 1. The origin of this software must not be misrepresented; you must not\r | |
15 | claim that you wrote the original software. If you use this software\r | |
16 | in a product, an acknowledgment in the product documentation would be\r | |
17 | appreciated but is not required.\r | |
18 | 2. Altered source versions must be plainly marked as such, and must not be\r | |
19 | misrepresented as being the original software.\r | |
20 | 3. This notice may not be removed or altered from any source distribution.\r | |
21 | \r | |
22 | Jean-loup Gailly Mark Adler\r | |
23 | jloup@gzip.org madler@alumni.caltech.edu\r | |
24 | \r | |
25 | \r | |
26 | The data format used by the zlib library is described by RFCs (Request for\r | |
27 | Comments) 1950 to 1952 in the files http://tools.ietf.org/html/rfc1950\r | |
28 | (zlib format), rfc1951 (deflate format) and rfc1952 (gzip format).\r | |
29 | */\r | |
30 | \r | |
31 | #ifndef ZLIB_H\r | |
32 | #define ZLIB_H\r | |
33 | \r | |
34 | #include "zconf.h"\r | |
35 | \r | |
36 | #ifdef __cplusplus\r | |
37 | extern "C" {\r | |
38 | #endif\r | |
39 | \r | |
40 | #define ZLIB_VERSION "1.2.8"\r | |
41 | #define ZLIB_VERNUM 0x1280\r | |
42 | #define ZLIB_VER_MAJOR 1\r | |
43 | #define ZLIB_VER_MINOR 2\r | |
44 | #define ZLIB_VER_REVISION 8\r | |
45 | #define ZLIB_VER_SUBREVISION 0\r | |
46 | \r | |
47 | /*\r | |
48 | The 'zlib' compression library provides in-memory compression and\r | |
49 | decompression functions, including integrity checks of the uncompressed data.\r | |
50 | This version of the library supports only one compression method (deflation)\r | |
51 | but other algorithms will be added later and will have the same stream\r | |
52 | interface.\r | |
53 | \r | |
54 | Compression can be done in a single step if the buffers are large enough,\r | |
55 | or can be done by repeated calls of the compression function. In the latter\r | |
56 | case, the application must provide more input and/or consume the output\r | |
57 | (providing more output space) before each call.\r | |
58 | \r | |
59 | The compressed data format used by default by the in-memory functions is\r | |
60 | the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped\r | |
61 | around a deflate stream, which is itself documented in RFC 1951.\r | |
62 | \r | |
63 | The library also supports reading and writing files in gzip (.gz) format\r | |
64 | with an interface similar to that of stdio using the functions that start\r | |
65 | with "gz". The gzip format is different from the zlib format. gzip is a\r | |
66 | gzip wrapper, documented in RFC 1952, wrapped around a deflate stream.\r | |
67 | \r | |
68 | This library can optionally read and write gzip streams in memory as well.\r | |
69 | \r | |
70 | The zlib format was designed to be compact and fast for use in memory\r | |
71 | and on communications channels. The gzip format was designed for single-\r | |
72 | file compression on file systems, has a larger header than zlib to maintain\r | |
73 | directory information, and uses a different, slower check method than zlib.\r | |
74 | \r | |
75 | The library does not install any signal handler. The decoder checks\r | |
76 | the consistency of the compressed data, so the library should never crash\r | |
77 | even in case of corrupted input.\r | |
78 | */\r | |
79 | \r | |
80 | typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));\r | |
81 | typedef void (*free_func) OF((voidpf opaque, voidpf address));\r | |
82 | \r | |
83 | struct internal_state;\r | |
84 | \r | |
85 | typedef struct z_stream_s {\r | |
86 | z_const Bytef *next_in; /* next input byte */\r | |
87 | uInt avail_in; /* number of bytes available at next_in */\r | |
88 | uLong total_in; /* total number of input bytes read so far */\r | |
89 | \r | |
90 | Bytef *next_out; /* next output byte should be put there */\r | |
91 | uInt avail_out; /* remaining free space at next_out */\r | |
92 | uLong total_out; /* total number of bytes output so far */\r | |
93 | \r | |
94 | z_const char *msg; /* last error message, NULL if no error */\r | |
95 | struct internal_state FAR *state; /* not visible by applications */\r | |
96 | \r | |
97 | alloc_func zalloc; /* used to allocate the internal state */\r | |
98 | free_func zfree; /* used to free the internal state */\r | |
99 | voidpf opaque; /* private data object passed to zalloc and zfree */\r | |
100 | \r | |
101 | int data_type; /* best guess about the data type: binary or text */\r | |
102 | uLong adler; /* adler32 value of the uncompressed data */\r | |
103 | uLong reserved; /* reserved for future use */\r | |
104 | } z_stream;\r | |
105 | \r | |
106 | typedef z_stream FAR *z_streamp;\r | |
107 | \r | |
108 | /*\r | |
109 | gzip header information passed to and from zlib routines. See RFC 1952\r | |
110 | for more details on the meanings of these fields.\r | |
111 | */\r | |
112 | typedef struct gz_header_s {\r | |
113 | int text; /* true if compressed data believed to be text */\r | |
114 | uLong time; /* modification time */\r | |
115 | int xflags; /* extra flags (not used when writing a gzip file) */\r | |
116 | int os; /* operating system */\r | |
117 | Bytef *extra; /* pointer to extra field or Z_NULL if none */\r | |
118 | uInt extra_len; /* extra field length (valid if extra != Z_NULL) */\r | |
119 | uInt extra_max; /* space at extra (only when reading header) */\r | |
120 | Bytef *name; /* pointer to zero-terminated file name or Z_NULL */\r | |
121 | uInt name_max; /* space at name (only when reading header) */\r | |
122 | Bytef *comment; /* pointer to zero-terminated comment or Z_NULL */\r | |
123 | uInt comm_max; /* space at comment (only when reading header) */\r | |
124 | int hcrc; /* true if there was or will be a header crc */\r | |
125 | int done; /* true when done reading gzip header (not used\r | |
126 | when writing a gzip file) */\r | |
127 | } gz_header;\r | |
128 | \r | |
129 | typedef gz_header FAR *gz_headerp;\r | |
130 | \r | |
131 | /*\r | |
132 | The application must update next_in and avail_in when avail_in has dropped\r | |
133 | to zero. It must update next_out and avail_out when avail_out has dropped\r | |
134 | to zero. The application must initialize zalloc, zfree and opaque before\r | |
135 | calling the init function. All other fields are set by the compression\r | |
136 | library and must not be updated by the application.\r | |
137 | \r | |
138 | The opaque value provided by the application will be passed as the first\r | |
139 | parameter for calls of zalloc and zfree. This can be useful for custom\r | |
140 | memory management. The compression library attaches no meaning to the\r | |
141 | opaque value.\r | |
142 | \r | |
143 | zalloc must return Z_NULL if there is not enough memory for the object.\r | |
144 | If zlib is used in a multi-threaded application, zalloc and zfree must be\r | |
145 | thread safe.\r | |
146 | \r | |
147 | On 16-bit systems, the functions zalloc and zfree must be able to allocate\r | |
148 | exactly 65536 bytes, but will not be required to allocate more than this if\r | |
149 | the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, pointers\r | |
150 | returned by zalloc for objects of exactly 65536 bytes *must* have their\r | |
151 | offset normalized to zero. The default allocation function provided by this\r | |
152 | library ensures this (see zutil.c). To reduce memory requirements and avoid\r | |
153 | any allocation of 64K objects, at the expense of compression ratio, compile\r | |
154 | the library with -DMAX_WBITS=14 (see zconf.h).\r | |
155 | \r | |
156 | The fields total_in and total_out can be used for statistics or progress\r | |
157 | reports. After compression, total_in holds the total size of the\r | |
158 | uncompressed data and may be saved for use in the decompressor (particularly\r | |
159 | if the decompressor wants to decompress everything in a single step).\r | |
160 | */\r | |
161 | \r | |
162 | /* constants */\r | |
163 | \r | |
164 | #define Z_NO_FLUSH 0\r | |
165 | #define Z_PARTIAL_FLUSH 1\r | |
166 | #define Z_SYNC_FLUSH 2\r | |
167 | #define Z_FULL_FLUSH 3\r | |
168 | #define Z_FINISH 4\r | |
169 | #define Z_BLOCK 5\r | |
170 | #define Z_TREES 6\r | |
171 | /* Allowed flush values; see deflate() and inflate() below for details */\r | |
172 | \r | |
173 | #define Z_OK 0\r | |
174 | #define Z_STREAM_END 1\r | |
175 | #define Z_NEED_DICT 2\r | |
176 | #define Z_ERRNO (-1)\r | |
177 | #define Z_STREAM_ERROR (-2)\r | |
178 | #define Z_DATA_ERROR (-3)\r | |
179 | #define Z_MEM_ERROR (-4)\r | |
180 | #define Z_BUF_ERROR (-5)\r | |
181 | #define Z_VERSION_ERROR (-6)\r | |
182 | /* Return codes for the compression/decompression functions. Negative values\r | |
183 | * are errors, positive values are used for special but normal events.\r | |
184 | */\r | |
185 | \r | |
186 | #define Z_NO_COMPRESSION 0\r | |
187 | #define Z_BEST_SPEED 1\r | |
188 | #define Z_BEST_COMPRESSION 9\r | |
189 | #define Z_DEFAULT_COMPRESSION (-1)\r | |
190 | /* compression levels */\r | |
191 | \r | |
192 | #define Z_FILTERED 1\r | |
193 | #define Z_HUFFMAN_ONLY 2\r | |
194 | #define Z_RLE 3\r | |
195 | #define Z_FIXED 4\r | |
196 | #define Z_DEFAULT_STRATEGY 0\r | |
197 | /* compression strategy; see deflateInit2() below for details */\r | |
198 | \r | |
199 | #define Z_BINARY 0\r | |
200 | #define Z_TEXT 1\r | |
201 | #define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */\r | |
202 | #define Z_UNKNOWN 2\r | |
203 | /* Possible values of the data_type field (though see inflate()) */\r | |
204 | \r | |
205 | #define Z_DEFLATED 8\r | |
206 | /* The deflate compression method (the only one supported in this version) */\r | |
207 | \r | |
208 | #define Z_NULL 0 /* for initializing zalloc, zfree, opaque */\r | |
209 | \r | |
210 | #define zlib_version zlibVersion()\r | |
211 | /* for compatibility with versions < 1.0.2 */\r | |
212 | \r | |
213 | \r | |
214 | /* basic functions */\r | |
215 | \r | |
216 | ZEXTERN const char * ZEXPORT zlibVersion OF((void));\r | |
217 | /* The application can compare zlibVersion and ZLIB_VERSION for consistency.\r | |
218 | If the first character differs, the library code actually used is not\r | |
219 | compatible with the zlib.h header file used by the application. This check\r | |
220 | is automatically made by deflateInit and inflateInit.\r | |
221 | */\r | |
222 | \r | |
223 | /*\r | |
224 | ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level));\r | |
225 | \r | |
226 | Initializes the internal stream state for compression. The fields\r | |
227 | zalloc, zfree and opaque must be initialized before by the caller. If\r | |
228 | zalloc and zfree are set to Z_NULL, deflateInit updates them to use default\r | |
229 | allocation functions.\r | |
230 | \r | |
231 | The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9:\r | |
232 | 1 gives best speed, 9 gives best compression, 0 gives no compression at all\r | |
233 | (the input data is simply copied a block at a time). Z_DEFAULT_COMPRESSION\r | |
234 | requests a default compromise between speed and compression (currently\r | |
235 | equivalent to level 6).\r | |
236 | \r | |
237 | deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough\r | |
238 | memory, Z_STREAM_ERROR if level is not a valid compression level, or\r | |
239 | Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible\r | |
240 | with the version assumed by the caller (ZLIB_VERSION). msg is set to null\r | |
241 | if there is no error message. deflateInit does not perform any compression:\r | |
242 | this will be done by deflate().\r | |
243 | */\r | |
244 | \r | |
245 | \r | |
246 | ZEXTERN int ZEXPORT deflate OF((z_streamp strm, int flush));\r | |
247 | /*\r | |
248 | deflate compresses as much data as possible, and stops when the input\r | |
249 | buffer becomes empty or the output buffer becomes full. It may introduce\r | |
250 | some output latency (reading input without producing any output) except when\r | |
251 | forced to flush.\r | |
252 | \r | |
253 | The detailed semantics are as follows. deflate performs one or both of the\r | |
254 | following actions:\r | |
255 | \r | |
256 | - Compress more input starting at next_in and update next_in and avail_in\r | |
257 | accordingly. If not all input can be processed (because there is not\r | |
258 | enough room in the output buffer), next_in and avail_in are updated and\r | |
259 | processing will resume at this point for the next call of deflate().\r | |
260 | \r | |
261 | - Provide more output starting at next_out and update next_out and avail_out\r | |
262 | accordingly. This action is forced if the parameter flush is non zero.\r | |
263 | Forcing flush frequently degrades the compression ratio, so this parameter\r | |
264 | should be set only when necessary (in interactive applications). Some\r | |
265 | output may be provided even if flush is not set.\r | |
266 | \r | |
267 | Before the call of deflate(), the application should ensure that at least\r | |
268 | one of the actions is possible, by providing more input and/or consuming more\r | |
269 | output, and updating avail_in or avail_out accordingly; avail_out should\r | |
270 | never be zero before the call. The application can consume the compressed\r | |
271 | output when it wants, for example when the output buffer is full (avail_out\r | |
272 | == 0), or after each call of deflate(). If deflate returns Z_OK and with\r | |
273 | zero avail_out, it must be called again after making room in the output\r | |
274 | buffer because there might be more output pending.\r | |
275 | \r | |
276 | Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to\r | |
277 | decide how much data to accumulate before producing output, in order to\r | |
278 | maximize compression.\r | |
279 | \r | |
280 | If the parameter flush is set to Z_SYNC_FLUSH, all pending output is\r | |
281 | flushed to the output buffer and the output is aligned on a byte boundary, so\r | |
282 | that the decompressor can get all input data available so far. (In\r | |
283 | particular avail_in is zero after the call if enough output space has been\r | |
284 | provided before the call.) Flushing may degrade compression for some\r | |
285 | compression algorithms and so it should be used only when necessary. This\r | |
286 | completes the current deflate block and follows it with an empty stored block\r | |
287 | that is three bits plus filler bits to the next byte, followed by four bytes\r | |
288 | (00 00 ff ff).\r | |
289 | \r | |
290 | If flush is set to Z_PARTIAL_FLUSH, all pending output is flushed to the\r | |
291 | output buffer, but the output is not aligned to a byte boundary. All of the\r | |
292 | input data so far will be available to the decompressor, as for Z_SYNC_FLUSH.\r | |
293 | This completes the current deflate block and follows it with an empty fixed\r | |
294 | codes block that is 10 bits long. This assures that enough bytes are output\r | |
295 | in order for the decompressor to finish the block before the empty fixed code\r | |
296 | block.\r | |
297 | \r | |
298 | If flush is set to Z_BLOCK, a deflate block is completed and emitted, as\r | |
299 | for Z_SYNC_FLUSH, but the output is not aligned on a byte boundary, and up to\r | |
300 | seven bits of the current block are held to be written as the next byte after\r | |
301 | the next deflate block is completed. In this case, the decompressor may not\r | |
302 | be provided enough bits at this point in order to complete decompression of\r | |
303 | the data provided so far to the compressor. It may need to wait for the next\r | |
304 | block to be emitted. This is for advanced applications that need to control\r | |
305 | the emission of deflate blocks.\r | |
306 | \r | |
307 | If flush is set to Z_FULL_FLUSH, all output is flushed as with\r | |
308 | Z_SYNC_FLUSH, and the compression state is reset so that decompression can\r | |
309 | restart from this point if previous compressed data has been damaged or if\r | |
310 | random access is desired. Using Z_FULL_FLUSH too often can seriously degrade\r | |
311 | compression.\r | |
312 | \r | |
313 | If deflate returns with avail_out == 0, this function must be called again\r | |
314 | with the same value of the flush parameter and more output space (updated\r | |
315 | avail_out), until the flush is complete (deflate returns with non-zero\r | |
316 | avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that\r | |
317 | avail_out is greater than six to avoid repeated flush markers due to\r | |
318 | avail_out == 0 on return.\r | |
319 | \r | |
320 | If the parameter flush is set to Z_FINISH, pending input is processed,\r | |
321 | pending output is flushed and deflate returns with Z_STREAM_END if there was\r | |
322 | enough output space; if deflate returns with Z_OK, this function must be\r | |
323 | called again with Z_FINISH and more output space (updated avail_out) but no\r | |
324 | more input data, until it returns with Z_STREAM_END or an error. After\r | |
325 | deflate has returned Z_STREAM_END, the only possible operations on the stream\r | |
326 | are deflateReset or deflateEnd.\r | |
327 | \r | |
328 | Z_FINISH can be used immediately after deflateInit if all the compression\r | |
329 | is to be done in a single step. In this case, avail_out must be at least the\r | |
330 | value returned by deflateBound (see below). Then deflate is guaranteed to\r | |
331 | return Z_STREAM_END. If not enough output space is provided, deflate will\r | |
332 | not return Z_STREAM_END, and it must be called again as described above.\r | |
333 | \r | |
334 | deflate() sets strm->adler to the adler32 checksum of all input read\r | |
335 | so far (that is, total_in bytes).\r | |
336 | \r | |
337 | deflate() may update strm->data_type if it can make a good guess about\r | |
338 | the input data type (Z_BINARY or Z_TEXT). In doubt, the data is considered\r | |
339 | binary. This field is only for information purposes and does not affect the\r | |
340 | compression algorithm in any manner.\r | |
341 | \r | |
342 | deflate() returns Z_OK if some progress has been made (more input\r | |
343 | processed or more output produced), Z_STREAM_END if all input has been\r | |
344 | consumed and all output has been produced (only when flush is set to\r | |
345 | Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example\r | |
346 | if next_in or next_out was Z_NULL), Z_BUF_ERROR if no progress is possible\r | |
347 | (for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not\r | |
348 | fatal, and deflate() can be called again with more input and more output\r | |
349 | space to continue compressing.\r | |
350 | */\r | |
351 | \r | |
352 | \r | |
353 | ZEXTERN int ZEXPORT deflateEnd OF((z_streamp strm));\r | |
354 | /*\r | |
355 | All dynamically allocated data structures for this stream are freed.\r | |
356 | This function discards any unprocessed input and does not flush any pending\r | |
357 | output.\r | |
358 | \r | |
359 | deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the\r | |
360 | stream state was inconsistent, Z_DATA_ERROR if the stream was freed\r | |
361 | prematurely (some input or output was discarded). In the error case, msg\r | |
362 | may be set but then points to a static string (which must not be\r | |
363 | deallocated).\r | |
364 | */\r | |
365 | \r | |
366 | \r | |
367 | /*\r | |
368 | ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm));\r | |
369 | \r | |
370 | Initializes the internal stream state for decompression. The fields\r | |
371 | next_in, avail_in, zalloc, zfree and opaque must be initialized before by\r | |
372 | the caller. If next_in is not Z_NULL and avail_in is large enough (the\r | |
373 | exact value depends on the compression method), inflateInit determines the\r | |
374 | compression method from the zlib header and allocates all data structures\r | |
375 | accordingly; otherwise the allocation will be deferred to the first call of\r | |
376 | inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to\r | |
377 | use default allocation functions.\r | |
378 | \r | |
379 | inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough\r | |
380 | memory, Z_VERSION_ERROR if the zlib library version is incompatible with the\r | |
381 | version assumed by the caller, or Z_STREAM_ERROR if the parameters are\r | |
382 | invalid, such as a null pointer to the structure. msg is set to null if\r | |
383 | there is no error message. inflateInit does not perform any decompression\r | |
384 | apart from possibly reading the zlib header if present: actual decompression\r | |
385 | will be done by inflate(). (So next_in and avail_in may be modified, but\r | |
386 | next_out and avail_out are unused and unchanged.) The current implementation\r | |
387 | of inflateInit() does not process any header information -- that is deferred\r | |
388 | until inflate() is called.\r | |
389 | */\r | |
390 | \r | |
391 | \r | |
392 | ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush));\r | |
393 | /*\r | |
394 | inflate decompresses as much data as possible, and stops when the input\r | |
395 | buffer becomes empty or the output buffer becomes full. It may introduce\r | |
396 | some output latency (reading input without producing any output) except when\r | |
397 | forced to flush.\r | |
398 | \r | |
399 | The detailed semantics are as follows. inflate performs one or both of the\r | |
400 | following actions:\r | |
401 | \r | |
402 | - Decompress more input starting at next_in and update next_in and avail_in\r | |
403 | accordingly. If not all input can be processed (because there is not\r | |
404 | enough room in the output buffer), next_in is updated and processing will\r | |
405 | resume at this point for the next call of inflate().\r | |
406 | \r | |
407 | - Provide more output starting at next_out and update next_out and avail_out\r | |
408 | accordingly. inflate() provides as much output as possible, until there is\r | |
409 | no more input data or no more space in the output buffer (see below about\r | |
410 | the flush parameter).\r | |
411 | \r | |
412 | Before the call of inflate(), the application should ensure that at least\r | |
413 | one of the actions is possible, by providing more input and/or consuming more\r | |
414 | output, and updating the next_* and avail_* values accordingly. The\r | |
415 | application can consume the uncompressed output when it wants, for example\r | |
416 | when the output buffer is full (avail_out == 0), or after each call of\r | |
417 | inflate(). If inflate returns Z_OK and with zero avail_out, it must be\r | |
418 | called again after making room in the output buffer because there might be\r | |
419 | more output pending.\r | |
420 | \r | |
421 | The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, Z_FINISH,\r | |
422 | Z_BLOCK, or Z_TREES. Z_SYNC_FLUSH requests that inflate() flush as much\r | |
423 | output as possible to the output buffer. Z_BLOCK requests that inflate()\r | |
424 | stop if and when it gets to the next deflate block boundary. When decoding\r | |
425 | the zlib or gzip format, this will cause inflate() to return immediately\r | |
426 | after the header and before the first block. When doing a raw inflate,\r | |
427 | inflate() will go ahead and process the first block, and will return when it\r | |
428 | gets to the end of that block, or when it runs out of data.\r | |
429 | \r | |
430 | The Z_BLOCK option assists in appending to or combining deflate streams.\r | |
431 | Also to assist in this, on return inflate() will set strm->data_type to the\r | |
432 | number of unused bits in the last byte taken from strm->next_in, plus 64 if\r | |
433 | inflate() is currently decoding the last block in the deflate stream, plus\r | |
434 | 128 if inflate() returned immediately after decoding an end-of-block code or\r | |
435 | decoding the complete header up to just before the first byte of the deflate\r | |
436 | stream. The end-of-block will not be indicated until all of the uncompressed\r | |
437 | data from that block has been written to strm->next_out. The number of\r | |
438 | unused bits may in general be greater than seven, except when bit 7 of\r | |
439 | data_type is set, in which case the number of unused bits will be less than\r | |
440 | eight. data_type is set as noted here every time inflate() returns for all\r | |
441 | flush options, and so can be used to determine the amount of currently\r | |
442 | consumed input in bits.\r | |
443 | \r | |
444 | The Z_TREES option behaves as Z_BLOCK does, but it also returns when the\r | |
445 | end of each deflate block header is reached, before any actual data in that\r | |
446 | block is decoded. This allows the caller to determine the length of the\r | |
447 | deflate block header for later use in random access within a deflate block.\r | |
448 | 256 is added to the value of strm->data_type when inflate() returns\r | |
449 | immediately after reaching the end of the deflate block header.\r | |
450 | \r | |
451 | inflate() should normally be called until it returns Z_STREAM_END or an\r | |
452 | error. However if all decompression is to be performed in a single step (a\r | |
453 | single call of inflate), the parameter flush should be set to Z_FINISH. In\r | |
454 | this case all pending input is processed and all pending output is flushed;\r | |
455 | avail_out must be large enough to hold all of the uncompressed data for the\r | |
456 | operation to complete. (The size of the uncompressed data may have been\r | |
457 | saved by the compressor for this purpose.) The use of Z_FINISH is not\r | |
458 | required to perform an inflation in one step. However it may be used to\r | |
459 | inform inflate that a faster approach can be used for the single inflate()\r | |
460 | call. Z_FINISH also informs inflate to not maintain a sliding window if the\r | |
461 | stream completes, which reduces inflate's memory footprint. If the stream\r | |
462 | does not complete, either because not all of the stream is provided or not\r | |
463 | enough output space is provided, then a sliding window will be allocated and\r | |
464 | inflate() can be called again to continue the operation as if Z_NO_FLUSH had\r | |
465 | been used.\r | |
466 | \r | |
467 | In this implementation, inflate() always flushes as much output as\r | |
468 | possible to the output buffer, and always uses the faster approach on the\r | |
469 | first call. So the effects of the flush parameter in this implementation are\r | |
470 | on the return value of inflate() as noted below, when inflate() returns early\r | |
471 | when Z_BLOCK or Z_TREES is used, and when inflate() avoids the allocation of\r | |
472 | memory for a sliding window when Z_FINISH is used.\r | |
473 | \r | |
474 | If a preset dictionary is needed after this call (see inflateSetDictionary\r | |
475 | below), inflate sets strm->adler to the Adler-32 checksum of the dictionary\r | |
476 | chosen by the compressor and returns Z_NEED_DICT; otherwise it sets\r | |
477 | strm->adler to the Adler-32 checksum of all output produced so far (that is,\r | |
478 | total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described\r | |
479 | below. At the end of the stream, inflate() checks that its computed adler32\r | |
480 | checksum is equal to that saved by the compressor and returns Z_STREAM_END\r | |
481 | only if the checksum is correct.\r | |
482 | \r | |
483 | inflate() can decompress and check either zlib-wrapped or gzip-wrapped\r | |
484 | deflate data. The header type is detected automatically, if requested when\r | |
485 | initializing with inflateInit2(). Any information contained in the gzip\r | |
486 | header is not retained, so applications that need that information should\r | |
487 | instead use raw inflate, see inflateInit2() below, or inflateBack() and\r | |
488 | perform their own processing of the gzip header and trailer. When processing\r | |
489 | gzip-wrapped deflate data, strm->adler32 is set to the CRC-32 of the output\r | |
490 | producted so far. The CRC-32 is checked against the gzip trailer.\r | |
491 | \r | |
492 | inflate() returns Z_OK if some progress has been made (more input processed\r | |
493 | or more output produced), Z_STREAM_END if the end of the compressed data has\r | |
494 | been reached and all uncompressed output has been produced, Z_NEED_DICT if a\r | |
495 | preset dictionary is needed at this point, Z_DATA_ERROR if the input data was\r | |
496 | corrupted (input stream not conforming to the zlib format or incorrect check\r | |
497 | value), Z_STREAM_ERROR if the stream structure was inconsistent (for example\r | |
498 | next_in or next_out was Z_NULL), Z_MEM_ERROR if there was not enough memory,\r | |
499 | Z_BUF_ERROR if no progress is possible or if there was not enough room in the\r | |
500 | output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and\r | |
501 | inflate() can be called again with more input and more output space to\r | |
502 | continue decompressing. If Z_DATA_ERROR is returned, the application may\r | |
503 | then call inflateSync() to look for a good compression block if a partial\r | |
504 | recovery of the data is desired.\r | |
505 | */\r | |
506 | \r | |
507 | \r | |
508 | ZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm));\r | |
509 | /*\r | |
510 | All dynamically allocated data structures for this stream are freed.\r | |
511 | This function discards any unprocessed input and does not flush any pending\r | |
512 | output.\r | |
513 | \r | |
514 | inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state\r | |
515 | was inconsistent. In the error case, msg may be set but then points to a\r | |
516 | static string (which must not be deallocated).\r | |
517 | */\r | |
518 | \r | |
519 | \r | |
520 | /* Advanced functions */\r | |
521 | \r | |
522 | /*\r | |
523 | The following functions are needed only in some special applications.\r | |
524 | */\r | |
525 | \r | |
526 | /*\r | |
527 | ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm,\r | |
528 | int level,\r | |
529 | int method,\r | |
530 | int windowBits,\r | |
531 | int memLevel,\r | |
532 | int strategy));\r | |
533 | \r | |
534 | This is another version of deflateInit with more compression options. The\r | |
535 | fields next_in, zalloc, zfree and opaque must be initialized before by the\r | |
536 | caller.\r | |
537 | \r | |
538 | The method parameter is the compression method. It must be Z_DEFLATED in\r | |
539 | this version of the library.\r | |
540 | \r | |
541 | The windowBits parameter is the base two logarithm of the window size\r | |
542 | (the size of the history buffer). It should be in the range 8..15 for this\r | |
543 | version of the library. Larger values of this parameter result in better\r | |
544 | compression at the expense of memory usage. The default value is 15 if\r | |
545 | deflateInit is used instead.\r | |
546 | \r | |
547 | windowBits can also be -8..-15 for raw deflate. In this case, -windowBits\r | |
548 | determines the window size. deflate() will then generate raw deflate data\r | |
549 | with no zlib header or trailer, and will not compute an adler32 check value.\r | |
550 | \r | |
551 | windowBits can also be greater than 15 for optional gzip encoding. Add\r | |
552 | 16 to windowBits to write a simple gzip header and trailer around the\r | |
553 | compressed data instead of a zlib wrapper. The gzip header will have no\r | |
554 | file name, no extra data, no comment, no modification time (set to zero), no\r | |
555 | header crc, and the operating system will be set to 255 (unknown). If a\r | |
556 | gzip stream is being written, strm->adler is a crc32 instead of an adler32.\r | |
557 | \r | |
558 | The memLevel parameter specifies how much memory should be allocated\r | |
559 | for the internal compression state. memLevel=1 uses minimum memory but is\r | |
560 | slow and reduces compression ratio; memLevel=9 uses maximum memory for\r | |
561 | optimal speed. The default value is 8. See zconf.h for total memory usage\r | |
562 | as a function of windowBits and memLevel.\r | |
563 | \r | |
564 | The strategy parameter is used to tune the compression algorithm. Use the\r | |
565 | value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a\r | |
566 | filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no\r | |
567 | string match), or Z_RLE to limit match distances to one (run-length\r | |
568 | encoding). Filtered data consists mostly of small values with a somewhat\r | |
569 | random distribution. In this case, the compression algorithm is tuned to\r | |
570 | compress them better. The effect of Z_FILTERED is to force more Huffman\r | |
571 | coding and less string matching; it is somewhat intermediate between\r | |
572 | Z_DEFAULT_STRATEGY and Z_HUFFMAN_ONLY. Z_RLE is designed to be almost as\r | |
573 | fast as Z_HUFFMAN_ONLY, but give better compression for PNG image data. The\r | |
574 | strategy parameter only affects the compression ratio but not the\r | |
575 | correctness of the compressed output even if it is not set appropriately.\r | |
576 | Z_FIXED prevents the use of dynamic Huffman codes, allowing for a simpler\r | |
577 | decoder for special applications.\r | |
578 | \r | |
579 | deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough\r | |
580 | memory, Z_STREAM_ERROR if any parameter is invalid (such as an invalid\r | |
581 | method), or Z_VERSION_ERROR if the zlib library version (zlib_version) is\r | |
582 | incompatible with the version assumed by the caller (ZLIB_VERSION). msg is\r | |
583 | set to null if there is no error message. deflateInit2 does not perform any\r | |
584 | compression: this will be done by deflate().\r | |
585 | */\r | |
586 | \r | |
587 | ZEXTERN int ZEXPORT deflateSetDictionary OF((z_streamp strm,\r | |
588 | const Bytef *dictionary,\r | |
589 | uInt dictLength));\r | |
590 | /*\r | |
591 | Initializes the compression dictionary from the given byte sequence\r | |
592 | without producing any compressed output. When using the zlib format, this\r | |
593 | function must be called immediately after deflateInit, deflateInit2 or\r | |
594 | deflateReset, and before any call of deflate. When doing raw deflate, this\r | |
595 | function must be called either before any call of deflate, or immediately\r | |
596 | after the completion of a deflate block, i.e. after all input has been\r | |
597 | consumed and all output has been delivered when using any of the flush\r | |
598 | options Z_BLOCK, Z_PARTIAL_FLUSH, Z_SYNC_FLUSH, or Z_FULL_FLUSH. The\r | |
599 | compressor and decompressor must use exactly the same dictionary (see\r | |
600 | inflateSetDictionary).\r | |
601 | \r | |
602 | The dictionary should consist of strings (byte sequences) that are likely\r | |
603 | to be encountered later in the data to be compressed, with the most commonly\r | |
604 | used strings preferably put towards the end of the dictionary. Using a\r | |
605 | dictionary is most useful when the data to be compressed is short and can be\r | |
606 | predicted with good accuracy; the data can then be compressed better than\r | |
607 | with the default empty dictionary.\r | |
608 | \r | |
609 | Depending on the size of the compression data structures selected by\r | |
610 | deflateInit or deflateInit2, a part of the dictionary may in effect be\r | |
611 | discarded, for example if the dictionary is larger than the window size\r | |
612 | provided in deflateInit or deflateInit2. Thus the strings most likely to be\r | |
613 | useful should be put at the end of the dictionary, not at the front. In\r | |
614 | addition, the current implementation of deflate will use at most the window\r | |
615 | size minus 262 bytes of the provided dictionary.\r | |
616 | \r | |
617 | Upon return of this function, strm->adler is set to the adler32 value\r | |
618 | of the dictionary; the decompressor may later use this value to determine\r | |
619 | which dictionary has been used by the compressor. (The adler32 value\r | |
620 | applies to the whole dictionary even if only a subset of the dictionary is\r | |
621 | actually used by the compressor.) If a raw deflate was requested, then the\r | |
622 | adler32 value is not computed and strm->adler is not set.\r | |
623 | \r | |
624 | deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a\r | |
625 | parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is\r | |
626 | inconsistent (for example if deflate has already been called for this stream\r | |
627 | or if not at a block boundary for raw deflate). deflateSetDictionary does\r | |
628 | not perform any compression: this will be done by deflate().\r | |
629 | */\r | |
630 | \r | |
631 | ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest,\r | |
632 | z_streamp source));\r | |
633 | /*\r | |
634 | Sets the destination stream as a complete copy of the source stream.\r | |
635 | \r | |
636 | This function can be useful when several compression strategies will be\r | |
637 | tried, for example when there are several ways of pre-processing the input\r | |
638 | data with a filter. The streams that will be discarded should then be freed\r | |
639 | by calling deflateEnd. Note that deflateCopy duplicates the internal\r | |
640 | compression state which can be quite large, so this strategy is slow and can\r | |
641 | consume lots of memory.\r | |
642 | \r | |
643 | deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not\r | |
644 | enough memory, Z_STREAM_ERROR if the source stream state was inconsistent\r | |
645 | (such as zalloc being Z_NULL). msg is left unchanged in both source and\r | |
646 | destination.\r | |
647 | */\r | |
648 | \r | |
649 | ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm));\r | |
650 | /*\r | |
651 | This function is equivalent to deflateEnd followed by deflateInit,\r | |
652 | but does not free and reallocate all the internal compression state. The\r | |
653 | stream will keep the same compression level and any other attributes that\r | |
654 | may have been set by deflateInit2.\r | |
655 | \r | |
656 | deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source\r | |
657 | stream state was inconsistent (such as zalloc or state being Z_NULL).\r | |
658 | */\r | |
659 | \r | |
660 | ZEXTERN int ZEXPORT deflateParams OF((z_streamp strm,\r | |
661 | int level,\r | |
662 | int strategy));\r | |
663 | /*\r | |
664 | Dynamically update the compression level and compression strategy. The\r | |
665 | interpretation of level and strategy is as in deflateInit2. This can be\r | |
666 | used to switch between compression and straight copy of the input data, or\r | |
667 | to switch to a different kind of input data requiring a different strategy.\r | |
668 | If the compression level is changed, the input available so far is\r | |
669 | compressed with the old level (and may be flushed); the new level will take\r | |
670 | effect only at the next call of deflate().\r | |
671 | \r | |
672 | Before the call of deflateParams, the stream state must be set as for\r | |
673 | a call of deflate(), since the currently available input may have to be\r | |
674 | compressed and flushed. In particular, strm->avail_out must be non-zero.\r | |
675 | \r | |
676 | deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source\r | |
677 | stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR if\r | |
678 | strm->avail_out was zero.\r | |
679 | */\r | |
680 | \r | |
681 | ZEXTERN int ZEXPORT deflateTune OF((z_streamp strm,\r | |
682 | int good_length,\r | |
683 | int max_lazy,\r | |
684 | int nice_length,\r | |
685 | int max_chain));\r | |
686 | /*\r | |
687 | Fine tune deflate's internal compression parameters. This should only be\r | |
688 | used by someone who understands the algorithm used by zlib's deflate for\r | |
689 | searching for the best matching string, and even then only by the most\r | |
690 | fanatic optimizer trying to squeeze out the last compressed bit for their\r | |
691 | specific input data. Read the deflate.c source code for the meaning of the\r | |
692 | max_lazy, good_length, nice_length, and max_chain parameters.\r | |
693 | \r | |
694 | deflateTune() can be called after deflateInit() or deflateInit2(), and\r | |
695 | returns Z_OK on success, or Z_STREAM_ERROR for an invalid deflate stream.\r | |
696 | */\r | |
697 | \r | |
698 | ZEXTERN uLong ZEXPORT deflateBound OF((z_streamp strm,\r | |
699 | uLong sourceLen));\r | |
700 | /*\r | |
701 | deflateBound() returns an upper bound on the compressed size after\r | |
702 | deflation of sourceLen bytes. It must be called after deflateInit() or\r | |
703 | deflateInit2(), and after deflateSetHeader(), if used. This would be used\r | |
704 | to allocate an output buffer for deflation in a single pass, and so would be\r | |
705 | called before deflate(). If that first deflate() call is provided the\r | |
706 | sourceLen input bytes, an output buffer allocated to the size returned by\r | |
707 | deflateBound(), and the flush value Z_FINISH, then deflate() is guaranteed\r | |
708 | to return Z_STREAM_END. Note that it is possible for the compressed size to\r | |
709 | be larger than the value returned by deflateBound() if flush options other\r | |
710 | than Z_FINISH or Z_NO_FLUSH are used.\r | |
711 | */\r | |
712 | \r | |
713 | ZEXTERN int ZEXPORT deflatePending OF((z_streamp strm,\r | |
714 | unsigned *pending,\r | |
715 | int *bits));\r | |
716 | /*\r | |
717 | deflatePending() returns the number of bytes and bits of output that have\r | |
718 | been generated, but not yet provided in the available output. The bytes not\r | |
719 | provided would be due to the available output space having being consumed.\r | |
720 | The number of bits of output not provided are between 0 and 7, where they\r | |
721 | await more bits to join them in order to fill out a full byte. If pending\r | |
722 | or bits are Z_NULL, then those values are not set.\r | |
723 | \r | |
724 | deflatePending returns Z_OK if success, or Z_STREAM_ERROR if the source\r | |
725 | stream state was inconsistent.\r | |
726 | */\r | |
727 | \r | |
728 | ZEXTERN int ZEXPORT deflatePrime OF((z_streamp strm,\r | |
729 | int bits,\r | |
730 | int value));\r | |
731 | /*\r | |
732 | deflatePrime() inserts bits in the deflate output stream. The intent\r | |
733 | is that this function is used to start off the deflate output with the bits\r | |
734 | leftover from a previous deflate stream when appending to it. As such, this\r | |
735 | function can only be used for raw deflate, and must be used before the first\r | |
736 | deflate() call after a deflateInit2() or deflateReset(). bits must be less\r | |
737 | than or equal to 16, and that many of the least significant bits of value\r | |
738 | will be inserted in the output.\r | |
739 | \r | |
740 | deflatePrime returns Z_OK if success, Z_BUF_ERROR if there was not enough\r | |
741 | room in the internal buffer to insert the bits, or Z_STREAM_ERROR if the\r | |
742 | source stream state was inconsistent.\r | |
743 | */\r | |
744 | \r | |
745 | ZEXTERN int ZEXPORT deflateSetHeader OF((z_streamp strm,\r | |
746 | gz_headerp head));\r | |
747 | /*\r | |
748 | deflateSetHeader() provides gzip header information for when a gzip\r | |
749 | stream is requested by deflateInit2(). deflateSetHeader() may be called\r | |
750 | after deflateInit2() or deflateReset() and before the first call of\r | |
751 | deflate(). The text, time, os, extra field, name, and comment information\r | |
752 | in the provided gz_header structure are written to the gzip header (xflag is\r | |
753 | ignored -- the extra flags are set according to the compression level). The\r | |
754 | caller must assure that, if not Z_NULL, name and comment are terminated with\r | |
755 | a zero byte, and that if extra is not Z_NULL, that extra_len bytes are\r | |
756 | available there. If hcrc is true, a gzip header crc is included. Note that\r | |
757 | the current versions of the command-line version of gzip (up through version\r | |
758 | 1.3.x) do not support header crc's, and will report that it is a "multi-part\r | |
759 | gzip file" and give up.\r | |
760 | \r | |
761 | If deflateSetHeader is not used, the default gzip header has text false,\r | |
762 | the time set to zero, and os set to 255, with no extra, name, or comment\r | |
763 | fields. The gzip header is returned to the default state by deflateReset().\r | |
764 | \r | |
765 | deflateSetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source\r | |
766 | stream state was inconsistent.\r | |
767 | */\r | |
768 | \r | |
769 | /*\r | |
770 | ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm,\r | |
771 | int windowBits));\r | |
772 | \r | |
773 | This is another version of inflateInit with an extra parameter. The\r | |
774 | fields next_in, avail_in, zalloc, zfree and opaque must be initialized\r | |
775 | before by the caller.\r | |
776 | \r | |
777 | The windowBits parameter is the base two logarithm of the maximum window\r | |
778 | size (the size of the history buffer). It should be in the range 8..15 for\r | |
779 | this version of the library. The default value is 15 if inflateInit is used\r | |
780 | instead. windowBits must be greater than or equal to the windowBits value\r | |
781 | provided to deflateInit2() while compressing, or it must be equal to 15 if\r | |
782 | deflateInit2() was not used. If a compressed stream with a larger window\r | |
783 | size is given as input, inflate() will return with the error code\r | |
784 | Z_DATA_ERROR instead of trying to allocate a larger window.\r | |
785 | \r | |
786 | windowBits can also be zero to request that inflate use the window size in\r | |
787 | the zlib header of the compressed stream.\r | |
788 | \r | |
789 | windowBits can also be -8..-15 for raw inflate. In this case, -windowBits\r | |
790 | determines the window size. inflate() will then process raw deflate data,\r | |
791 | not looking for a zlib or gzip header, not generating a check value, and not\r | |
792 | looking for any check values for comparison at the end of the stream. This\r | |
793 | is for use with other formats that use the deflate compressed data format\r | |
794 | such as zip. Those formats provide their own check values. If a custom\r | |
795 | format is developed using the raw deflate format for compressed data, it is\r | |
796 | recommended that a check value such as an adler32 or a crc32 be applied to\r | |
797 | the uncompressed data as is done in the zlib, gzip, and zip formats. For\r | |
798 | most applications, the zlib format should be used as is. Note that comments\r | |
799 | above on the use in deflateInit2() applies to the magnitude of windowBits.\r | |
800 | \r | |
801 | windowBits can also be greater than 15 for optional gzip decoding. Add\r | |
802 | 32 to windowBits to enable zlib and gzip decoding with automatic header\r | |
803 | detection, or add 16 to decode only the gzip format (the zlib format will\r | |
804 | return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is a\r | |
805 | crc32 instead of an adler32.\r | |
806 | \r | |
807 | inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough\r | |
808 | memory, Z_VERSION_ERROR if the zlib library version is incompatible with the\r | |
809 | version assumed by the caller, or Z_STREAM_ERROR if the parameters are\r | |
810 | invalid, such as a null pointer to the structure. msg is set to null if\r | |
811 | there is no error message. inflateInit2 does not perform any decompression\r | |
812 | apart from possibly reading the zlib header if present: actual decompression\r | |
813 | will be done by inflate(). (So next_in and avail_in may be modified, but\r | |
814 | next_out and avail_out are unused and unchanged.) The current implementation\r | |
815 | of inflateInit2() does not process any header information -- that is\r | |
816 | deferred until inflate() is called.\r | |
817 | */\r | |
818 | \r | |
819 | ZEXTERN int ZEXPORT inflateSetDictionary OF((z_streamp strm,\r | |
820 | const Bytef *dictionary,\r | |
821 | uInt dictLength));\r | |
822 | /*\r | |
823 | Initializes the decompression dictionary from the given uncompressed byte\r | |
824 | sequence. This function must be called immediately after a call of inflate,\r | |
825 | if that call returned Z_NEED_DICT. The dictionary chosen by the compressor\r | |
826 | can be determined from the adler32 value returned by that call of inflate.\r | |
827 | The compressor and decompressor must use exactly the same dictionary (see\r | |
828 | deflateSetDictionary). For raw inflate, this function can be called at any\r | |
829 | time to set the dictionary. If the provided dictionary is smaller than the\r | |
830 | window and there is already data in the window, then the provided dictionary\r | |
831 | will amend what's there. The application must insure that the dictionary\r | |
832 | that was used for compression is provided.\r | |
833 | \r | |
834 | inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a\r | |
835 | parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is\r | |
836 | inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the\r | |
837 | expected one (incorrect adler32 value). inflateSetDictionary does not\r | |
838 | perform any decompression: this will be done by subsequent calls of\r | |
839 | inflate().\r | |
840 | */\r | |
841 | \r | |
842 | ZEXTERN int ZEXPORT inflateGetDictionary OF((z_streamp strm,\r | |
843 | Bytef *dictionary,\r | |
844 | uInt *dictLength));\r | |
845 | /*\r | |
846 | Returns the sliding dictionary being maintained by inflate. dictLength is\r | |
847 | set to the number of bytes in the dictionary, and that many bytes are copied\r | |
848 | to dictionary. dictionary must have enough space, where 32768 bytes is\r | |
849 | always enough. If inflateGetDictionary() is called with dictionary equal to\r | |
850 | Z_NULL, then only the dictionary length is returned, and nothing is copied.\r | |
851 | Similary, if dictLength is Z_NULL, then it is not set.\r | |
852 | \r | |
853 | inflateGetDictionary returns Z_OK on success, or Z_STREAM_ERROR if the\r | |
854 | stream state is inconsistent.\r | |
855 | */\r | |
856 | \r | |
857 | ZEXTERN int ZEXPORT inflateSync OF((z_streamp strm));\r | |
858 | /*\r | |
859 | Skips invalid compressed data until a possible full flush point (see above\r | |
860 | for the description of deflate with Z_FULL_FLUSH) can be found, or until all\r | |
861 | available input is skipped. No output is provided.\r | |
862 | \r | |
863 | inflateSync searches for a 00 00 FF FF pattern in the compressed data.\r | |
864 | All full flush points have this pattern, but not all occurrences of this\r | |
865 | pattern are full flush points.\r | |
866 | \r | |
867 | inflateSync returns Z_OK if a possible full flush point has been found,\r | |
868 | Z_BUF_ERROR if no more input was provided, Z_DATA_ERROR if no flush point\r | |
869 | has been found, or Z_STREAM_ERROR if the stream structure was inconsistent.\r | |
870 | In the success case, the application may save the current current value of\r | |
871 | total_in which indicates where valid compressed data was found. In the\r | |
872 | error case, the application may repeatedly call inflateSync, providing more\r | |
873 | input each time, until success or end of the input data.\r | |
874 | */\r | |
875 | \r | |
876 | ZEXTERN int ZEXPORT inflateCopy OF((z_streamp dest,\r | |
877 | z_streamp source));\r | |
878 | /*\r | |
879 | Sets the destination stream as a complete copy of the source stream.\r | |
880 | \r | |
881 | This function can be useful when randomly accessing a large stream. The\r | |
882 | first pass through the stream can periodically record the inflate state,\r | |
883 | allowing restarting inflate at those points when randomly accessing the\r | |
884 | stream.\r | |
885 | \r | |
886 | inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not\r | |
887 | enough memory, Z_STREAM_ERROR if the source stream state was inconsistent\r | |
888 | (such as zalloc being Z_NULL). msg is left unchanged in both source and\r | |
889 | destination.\r | |
890 | */\r | |
891 | \r | |
892 | ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm));\r | |
893 | /*\r | |
894 | This function is equivalent to inflateEnd followed by inflateInit,\r | |
895 | but does not free and reallocate all the internal decompression state. The\r | |
896 | stream will keep attributes that may have been set by inflateInit2.\r | |
897 | \r | |
898 | inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source\r | |
899 | stream state was inconsistent (such as zalloc or state being Z_NULL).\r | |
900 | */\r | |
901 | \r | |
902 | ZEXTERN int ZEXPORT inflateReset2 OF((z_streamp strm,\r | |
903 | int windowBits));\r | |
904 | /*\r | |
905 | This function is the same as inflateReset, but it also permits changing\r | |
906 | the wrap and window size requests. The windowBits parameter is interpreted\r | |
907 | the same as it is for inflateInit2.\r | |
908 | \r | |
909 | inflateReset2 returns Z_OK if success, or Z_STREAM_ERROR if the source\r | |
910 | stream state was inconsistent (such as zalloc or state being Z_NULL), or if\r | |
911 | the windowBits parameter is invalid.\r | |
912 | */\r | |
913 | \r | |
914 | ZEXTERN int ZEXPORT inflatePrime OF((z_streamp strm,\r | |
915 | int bits,\r | |
916 | int value));\r | |
917 | /*\r | |
918 | This function inserts bits in the inflate input stream. The intent is\r | |
919 | that this function is used to start inflating at a bit position in the\r | |
920 | middle of a byte. The provided bits will be used before any bytes are used\r | |
921 | from next_in. This function should only be used with raw inflate, and\r | |
922 | should be used before the first inflate() call after inflateInit2() or\r | |
923 | inflateReset(). bits must be less than or equal to 16, and that many of the\r | |
924 | least significant bits of value will be inserted in the input.\r | |
925 | \r | |
926 | If bits is negative, then the input stream bit buffer is emptied. Then\r | |
927 | inflatePrime() can be called again to put bits in the buffer. This is used\r | |
928 | to clear out bits leftover after feeding inflate a block description prior\r | |
929 | to feeding inflate codes.\r | |
930 | \r | |
931 | inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source\r | |
932 | stream state was inconsistent.\r | |
933 | */\r | |
934 | \r | |
935 | ZEXTERN long ZEXPORT inflateMark OF((z_streamp strm));\r | |
936 | /*\r | |
937 | This function returns two values, one in the lower 16 bits of the return\r | |
938 | value, and the other in the remaining upper bits, obtained by shifting the\r | |
939 | return value down 16 bits. If the upper value is -1 and the lower value is\r | |
940 | zero, then inflate() is currently decoding information outside of a block.\r | |
941 | If the upper value is -1 and the lower value is non-zero, then inflate is in\r | |
942 | the middle of a stored block, with the lower value equaling the number of\r | |
943 | bytes from the input remaining to copy. If the upper value is not -1, then\r | |
944 | it is the number of bits back from the current bit position in the input of\r | |
945 | the code (literal or length/distance pair) currently being processed. In\r | |
946 | that case the lower value is the number of bytes already emitted for that\r | |
947 | code.\r | |
948 | \r | |
949 | A code is being processed if inflate is waiting for more input to complete\r | |
950 | decoding of the code, or if it has completed decoding but is waiting for\r | |
951 | more output space to write the literal or match data.\r | |
952 | \r | |
953 | inflateMark() is used to mark locations in the input data for random\r | |
954 | access, which may be at bit positions, and to note those cases where the\r | |
955 | output of a code may span boundaries of random access blocks. The current\r | |
956 | location in the input stream can be determined from avail_in and data_type\r | |
957 | as noted in the description for the Z_BLOCK flush parameter for inflate.\r | |
958 | \r | |
959 | inflateMark returns the value noted above or -1 << 16 if the provided\r | |
960 | source stream state was inconsistent.\r | |
961 | */\r | |
962 | \r | |
963 | ZEXTERN int ZEXPORT inflateGetHeader OF((z_streamp strm,\r | |
964 | gz_headerp head));\r | |
965 | /*\r | |
966 | inflateGetHeader() requests that gzip header information be stored in the\r | |
967 | provided gz_header structure. inflateGetHeader() may be called after\r | |
968 | inflateInit2() or inflateReset(), and before the first call of inflate().\r | |
969 | As inflate() processes the gzip stream, head->done is zero until the header\r | |
970 | is completed, at which time head->done is set to one. If a zlib stream is\r | |
971 | being decoded, then head->done is set to -1 to indicate that there will be\r | |
972 | no gzip header information forthcoming. Note that Z_BLOCK or Z_TREES can be\r | |
973 | used to force inflate() to return immediately after header processing is\r | |
974 | complete and before any actual data is decompressed.\r | |
975 | \r | |
976 | The text, time, xflags, and os fields are filled in with the gzip header\r | |
977 | contents. hcrc is set to true if there is a header CRC. (The header CRC\r | |
978 | was valid if done is set to one.) If extra is not Z_NULL, then extra_max\r | |
979 | contains the maximum number of bytes to write to extra. Once done is true,\r | |
980 | extra_len contains the actual extra field length, and extra contains the\r | |
981 | extra field, or that field truncated if extra_max is less than extra_len.\r | |
982 | If name is not Z_NULL, then up to name_max characters are written there,\r | |
983 | terminated with a zero unless the length is greater than name_max. If\r | |
984 | comment is not Z_NULL, then up to comm_max characters are written there,\r | |
985 | terminated with a zero unless the length is greater than comm_max. When any\r | |
986 | of extra, name, or comment are not Z_NULL and the respective field is not\r | |
987 | present in the header, then that field is set to Z_NULL to signal its\r | |
988 | absence. This allows the use of deflateSetHeader() with the returned\r | |
989 | structure to duplicate the header. However if those fields are set to\r | |
990 | allocated memory, then the application will need to save those pointers\r | |
991 | elsewhere so that they can be eventually freed.\r | |
992 | \r | |
993 | If inflateGetHeader is not used, then the header information is simply\r | |
994 | discarded. The header is always checked for validity, including the header\r | |
995 | CRC if present. inflateReset() will reset the process to discard the header\r | |
996 | information. The application would need to call inflateGetHeader() again to\r | |
997 | retrieve the header from the next gzip stream.\r | |
998 | \r | |
999 | inflateGetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source\r | |
1000 | stream state was inconsistent.\r | |
1001 | */\r | |
1002 | \r | |
1003 | /*\r | |
1004 | ZEXTERN int ZEXPORT inflateBackInit OF((z_streamp strm, int windowBits,\r | |
1005 | unsigned char FAR *window));\r | |
1006 | \r | |
1007 | Initialize the internal stream state for decompression using inflateBack()\r | |
1008 | calls. The fields zalloc, zfree and opaque in strm must be initialized\r | |
1009 | before the call. If zalloc and zfree are Z_NULL, then the default library-\r | |
1010 | derived memory allocation routines are used. windowBits is the base two\r | |
1011 | logarithm of the window size, in the range 8..15. window is a caller\r | |
1012 | supplied buffer of that size. Except for special applications where it is\r | |
1013 | assured that deflate was used with small window sizes, windowBits must be 15\r | |
1014 | and a 32K byte window must be supplied to be able to decompress general\r | |
1015 | deflate streams.\r | |
1016 | \r | |
1017 | See inflateBack() for the usage of these routines.\r | |
1018 | \r | |
1019 | inflateBackInit will return Z_OK on success, Z_STREAM_ERROR if any of\r | |
1020 | the parameters are invalid, Z_MEM_ERROR if the internal state could not be\r | |
1021 | allocated, or Z_VERSION_ERROR if the version of the library does not match\r | |
1022 | the version of the header file.\r | |
1023 | */\r | |
1024 | \r | |
1025 | typedef unsigned (*in_func) OF((void FAR *,\r | |
1026 | z_const unsigned char FAR * FAR *));\r | |
1027 | typedef int (*out_func) OF((void FAR *, unsigned char FAR *, unsigned));\r | |
1028 | \r | |
1029 | ZEXTERN int ZEXPORT inflateBack OF((z_streamp strm,\r | |
1030 | in_func in, void FAR *in_desc,\r | |
1031 | out_func out, void FAR *out_desc));\r | |
1032 | /*\r | |
1033 | inflateBack() does a raw inflate with a single call using a call-back\r | |
1034 | interface for input and output. This is potentially more efficient than\r | |
1035 | inflate() for file i/o applications, in that it avoids copying between the\r | |
1036 | output and the sliding window by simply making the window itself the output\r | |
1037 | buffer. inflate() can be faster on modern CPUs when used with large\r | |
1038 | buffers. inflateBack() trusts the application to not change the output\r | |
1039 | buffer passed by the output function, at least until inflateBack() returns.\r | |
1040 | \r | |
1041 | inflateBackInit() must be called first to allocate the internal state\r | |
1042 | and to initialize the state with the user-provided window buffer.\r | |
1043 | inflateBack() may then be used multiple times to inflate a complete, raw\r | |
1044 | deflate stream with each call. inflateBackEnd() is then called to free the\r | |
1045 | allocated state.\r | |
1046 | \r | |
1047 | A raw deflate stream is one with no zlib or gzip header or trailer.\r | |
1048 | This routine would normally be used in a utility that reads zip or gzip\r | |
1049 | files and writes out uncompressed files. The utility would decode the\r | |
1050 | header and process the trailer on its own, hence this routine expects only\r | |
1051 | the raw deflate stream to decompress. This is different from the normal\r | |
1052 | behavior of inflate(), which expects either a zlib or gzip header and\r | |
1053 | trailer around the deflate stream.\r | |
1054 | \r | |
1055 | inflateBack() uses two subroutines supplied by the caller that are then\r | |
1056 | called by inflateBack() for input and output. inflateBack() calls those\r | |
1057 | routines until it reads a complete deflate stream and writes out all of the\r | |
1058 | uncompressed data, or until it encounters an error. The function's\r | |
1059 | parameters and return types are defined above in the in_func and out_func\r | |
1060 | typedefs. inflateBack() will call in(in_desc, &buf) which should return the\r | |
1061 | number of bytes of provided input, and a pointer to that input in buf. If\r | |
1062 | there is no input available, in() must return zero--buf is ignored in that\r | |
1063 | case--and inflateBack() will return a buffer error. inflateBack() will call\r | |
1064 | out(out_desc, buf, len) to write the uncompressed data buf[0..len-1]. out()\r | |
1065 | should return zero on success, or non-zero on failure. If out() returns\r | |
1066 | non-zero, inflateBack() will return with an error. Neither in() nor out()\r | |
1067 | are permitted to change the contents of the window provided to\r | |
1068 | inflateBackInit(), which is also the buffer that out() uses to write from.\r | |
1069 | The length written by out() will be at most the window size. Any non-zero\r | |
1070 | amount of input may be provided by in().\r | |
1071 | \r | |
1072 | For convenience, inflateBack() can be provided input on the first call by\r | |
1073 | setting strm->next_in and strm->avail_in. If that input is exhausted, then\r | |
1074 | in() will be called. Therefore strm->next_in must be initialized before\r | |
1075 | calling inflateBack(). If strm->next_in is Z_NULL, then in() will be called\r | |
1076 | immediately for input. If strm->next_in is not Z_NULL, then strm->avail_in\r | |
1077 | must also be initialized, and then if strm->avail_in is not zero, input will\r | |
1078 | initially be taken from strm->next_in[0 .. strm->avail_in - 1].\r | |
1079 | \r | |
1080 | The in_desc and out_desc parameters of inflateBack() is passed as the\r | |
1081 | first parameter of in() and out() respectively when they are called. These\r | |
1082 | descriptors can be optionally used to pass any information that the caller-\r | |
1083 | supplied in() and out() functions need to do their job.\r | |
1084 | \r | |
1085 | On return, inflateBack() will set strm->next_in and strm->avail_in to\r | |
1086 | pass back any unused input that was provided by the last in() call. The\r | |
1087 | return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR\r | |
1088 | if in() or out() returned an error, Z_DATA_ERROR if there was a format error\r | |
1089 | in the deflate stream (in which case strm->msg is set to indicate the nature\r | |
1090 | of the error), or Z_STREAM_ERROR if the stream was not properly initialized.\r | |
1091 | In the case of Z_BUF_ERROR, an input or output error can be distinguished\r | |
1092 | using strm->next_in which will be Z_NULL only if in() returned an error. If\r | |
1093 | strm->next_in is not Z_NULL, then the Z_BUF_ERROR was due to out() returning\r | |
1094 | non-zero. (in() will always be called before out(), so strm->next_in is\r | |
1095 | assured to be defined if out() returns non-zero.) Note that inflateBack()\r | |
1096 | cannot return Z_OK.\r | |
1097 | */\r | |
1098 | \r | |
1099 | ZEXTERN int ZEXPORT inflateBackEnd OF((z_streamp strm));\r | |
1100 | /*\r | |
1101 | All memory allocated by inflateBackInit() is freed.\r | |
1102 | \r | |
1103 | inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream\r | |
1104 | state was inconsistent.\r | |
1105 | */\r | |
1106 | \r | |
1107 | ZEXTERN uLong ZEXPORT zlibCompileFlags OF((void));\r | |
1108 | /* Return flags indicating compile-time options.\r | |
1109 | \r | |
1110 | Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other:\r | |
1111 | 1.0: size of uInt\r | |
1112 | 3.2: size of uLong\r | |
1113 | 5.4: size of voidpf (pointer)\r | |
1114 | 7.6: size of z_off_t\r | |
1115 | \r | |
1116 | Compiler, assembler, and debug options:\r | |
1117 | 8: DEBUG\r | |
1118 | 9: ASMV or ASMINF -- use ASM code\r | |
1119 | 10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention\r | |
1120 | 11: 0 (reserved)\r | |
1121 | \r | |
1122 | One-time table building (smaller code, but not thread-safe if true):\r | |
1123 | 12: BUILDFIXED -- build static block decoding tables when needed\r | |
1124 | 13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed\r | |
1125 | 14,15: 0 (reserved)\r | |
1126 | \r | |
1127 | Library content (indicates missing functionality):\r | |
1128 | 16: NO_GZCOMPRESS -- gz* functions cannot compress (to avoid linking\r | |
1129 | deflate code when not needed)\r | |
1130 | 17: NO_GZIP -- deflate can't write gzip streams, and inflate can't detect\r | |
1131 | and decode gzip streams (to avoid linking crc code)\r | |
1132 | 18-19: 0 (reserved)\r | |
1133 | \r | |
1134 | Operation variations (changes in library functionality):\r | |
1135 | 20: PKZIP_BUG_WORKAROUND -- slightly more permissive inflate\r | |
1136 | 21: FASTEST -- deflate algorithm with only one, lowest compression level\r | |
1137 | 22,23: 0 (reserved)\r | |
1138 | \r | |
1139 | The sprintf variant used by gzprintf (zero is best):\r | |
1140 | 24: 0 = vs*, 1 = s* -- 1 means limited to 20 arguments after the format\r | |
1141 | 25: 0 = *nprintf, 1 = *printf -- 1 means gzprintf() not secure!\r | |
1142 | 26: 0 = returns value, 1 = void -- 1 means inferred string length returned\r | |
1143 | \r | |
1144 | Remainder:\r | |
1145 | 27-31: 0 (reserved)\r | |
1146 | */\r | |
1147 | \r | |
1148 | #ifndef Z_SOLO\r | |
1149 | \r | |
1150 | /* utility functions */\r | |
1151 | \r | |
1152 | /*\r | |
1153 | The following utility functions are implemented on top of the basic\r | |
1154 | stream-oriented functions. To simplify the interface, some default options\r | |
1155 | are assumed (compression level and memory usage, standard memory allocation\r | |
1156 | functions). The source code of these utility functions can be modified if\r | |
1157 | you need special options.\r | |
1158 | */\r | |
1159 | \r | |
1160 | ZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen,\r | |
1161 | const Bytef *source, uLong sourceLen));\r | |
1162 | /*\r | |
1163 | Compresses the source buffer into the destination buffer. sourceLen is\r | |
1164 | the byte length of the source buffer. Upon entry, destLen is the total size\r | |
1165 | of the destination buffer, which must be at least the value returned by\r | |
1166 | compressBound(sourceLen). Upon exit, destLen is the actual size of the\r | |
1167 | compressed buffer.\r | |
1168 | \r | |
1169 | compress returns Z_OK if success, Z_MEM_ERROR if there was not\r | |
1170 | enough memory, Z_BUF_ERROR if there was not enough room in the output\r | |
1171 | buffer.\r | |
1172 | */\r | |
1173 | \r | |
1174 | ZEXTERN int ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen,\r | |
1175 | const Bytef *source, uLong sourceLen,\r | |
1176 | int level));\r | |
1177 | /*\r | |
1178 | Compresses the source buffer into the destination buffer. The level\r | |
1179 | parameter has the same meaning as in deflateInit. sourceLen is the byte\r | |
1180 | length of the source buffer. Upon entry, destLen is the total size of the\r | |
1181 | destination buffer, which must be at least the value returned by\r | |
1182 | compressBound(sourceLen). Upon exit, destLen is the actual size of the\r | |
1183 | compressed buffer.\r | |
1184 | \r | |
1185 | compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough\r | |
1186 | memory, Z_BUF_ERROR if there was not enough room in the output buffer,\r | |
1187 | Z_STREAM_ERROR if the level parameter is invalid.\r | |
1188 | */\r | |
1189 | \r | |
1190 | ZEXTERN uLong ZEXPORT compressBound OF((uLong sourceLen));\r | |
1191 | /*\r | |
1192 | compressBound() returns an upper bound on the compressed size after\r | |
1193 | compress() or compress2() on sourceLen bytes. It would be used before a\r | |
1194 | compress() or compress2() call to allocate the destination buffer.\r | |
1195 | */\r | |
1196 | \r | |
1197 | ZEXTERN int ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen,\r | |
1198 | const Bytef *source, uLong sourceLen));\r | |
1199 | /*\r | |
1200 | Decompresses the source buffer into the destination buffer. sourceLen is\r | |
1201 | the byte length of the source buffer. Upon entry, destLen is the total size\r | |
1202 | of the destination buffer, which must be large enough to hold the entire\r | |
1203 | uncompressed data. (The size of the uncompressed data must have been saved\r | |
1204 | previously by the compressor and transmitted to the decompressor by some\r | |
1205 | mechanism outside the scope of this compression library.) Upon exit, destLen\r | |
1206 | is the actual size of the uncompressed buffer.\r | |
1207 | \r | |
1208 | uncompress returns Z_OK if success, Z_MEM_ERROR if there was not\r | |
1209 | enough memory, Z_BUF_ERROR if there was not enough room in the output\r | |
1210 | buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete. In\r | |
1211 | the case where there is not enough room, uncompress() will fill the output\r | |
1212 | buffer with the uncompressed data up to that point.\r | |
1213 | */\r | |
1214 | \r | |
1215 | /* gzip file access functions */\r | |
1216 | \r | |
1217 | /*\r | |
1218 | This library supports reading and writing files in gzip (.gz) format with\r | |
1219 | an interface similar to that of stdio, using the functions that start with\r | |
1220 | "gz". The gzip format is different from the zlib format. gzip is a gzip\r | |
1221 | wrapper, documented in RFC 1952, wrapped around a deflate stream.\r | |
1222 | */\r | |
1223 | \r | |
1224 | typedef struct gzFile_s *gzFile; /* semi-opaque gzip file descriptor */\r | |
1225 | \r | |
1226 | /*\r | |
1227 | ZEXTERN gzFile ZEXPORT gzopen OF((const char *path, const char *mode));\r | |
1228 | \r | |
1229 | Opens a gzip (.gz) file for reading or writing. The mode parameter is as\r | |
1230 | in fopen ("rb" or "wb") but can also include a compression level ("wb9") or\r | |
1231 | a strategy: 'f' for filtered data as in "wb6f", 'h' for Huffman-only\r | |
1232 | compression as in "wb1h", 'R' for run-length encoding as in "wb1R", or 'F'\r | |
1233 | for fixed code compression as in "wb9F". (See the description of\r | |
1234 | deflateInit2 for more information about the strategy parameter.) 'T' will\r | |
1235 | request transparent writing or appending with no compression and not using\r | |
1236 | the gzip format.\r | |
1237 | \r | |
1238 | "a" can be used instead of "w" to request that the gzip stream that will\r | |
1239 | be written be appended to the file. "+" will result in an error, since\r | |
1240 | reading and writing to the same gzip file is not supported. The addition of\r | |
1241 | "x" when writing will create the file exclusively, which fails if the file\r | |
1242 | already exists. On systems that support it, the addition of "e" when\r | |
1243 | reading or writing will set the flag to close the file on an execve() call.\r | |
1244 | \r | |
1245 | These functions, as well as gzip, will read and decode a sequence of gzip\r | |
1246 | streams in a file. The append function of gzopen() can be used to create\r | |
1247 | such a file. (Also see gzflush() for another way to do this.) When\r | |
1248 | appending, gzopen does not test whether the file begins with a gzip stream,\r | |
1249 | nor does it look for the end of the gzip streams to begin appending. gzopen\r | |
1250 | will simply append a gzip stream to the existing file.\r | |
1251 | \r | |
1252 | gzopen can be used to read a file which is not in gzip format; in this\r | |
1253 | case gzread will directly read from the file without decompression. When\r | |
1254 | reading, this will be detected automatically by looking for the magic two-\r | |
1255 | byte gzip header.\r | |
1256 | \r | |
1257 | gzopen returns NULL if the file could not be opened, if there was\r | |
1258 | insufficient memory to allocate the gzFile state, or if an invalid mode was\r | |
1259 | specified (an 'r', 'w', or 'a' was not provided, or '+' was provided).\r | |
1260 | errno can be checked to determine if the reason gzopen failed was that the\r | |
1261 | file could not be opened.\r | |
1262 | */\r | |
1263 | \r | |
1264 | ZEXTERN gzFile ZEXPORT gzdopen OF((int fd, const char *mode));\r | |
1265 | /*\r | |
1266 | gzdopen associates a gzFile with the file descriptor fd. File descriptors\r | |
1267 | are obtained from calls like open, dup, creat, pipe or fileno (if the file\r | |
1268 | has been previously opened with fopen). The mode parameter is as in gzopen.\r | |
1269 | \r | |
1270 | The next call of gzclose on the returned gzFile will also close the file\r | |
1271 | descriptor fd, just like fclose(fdopen(fd, mode)) closes the file descriptor\r | |
1272 | fd. If you want to keep fd open, use fd = dup(fd_keep); gz = gzdopen(fd,\r | |
1273 | mode);. The duplicated descriptor should be saved to avoid a leak, since\r | |
1274 | gzdopen does not close fd if it fails. If you are using fileno() to get the\r | |
1275 | file descriptor from a FILE *, then you will have to use dup() to avoid\r | |
1276 | double-close()ing the file descriptor. Both gzclose() and fclose() will\r | |
1277 | close the associated file descriptor, so they need to have different file\r | |
1278 | descriptors.\r | |
1279 | \r | |
1280 | gzdopen returns NULL if there was insufficient memory to allocate the\r | |
1281 | gzFile state, if an invalid mode was specified (an 'r', 'w', or 'a' was not\r | |
1282 | provided, or '+' was provided), or if fd is -1. The file descriptor is not\r | |
1283 | used until the next gz* read, write, seek, or close operation, so gzdopen\r | |
1284 | will not detect if fd is invalid (unless fd is -1).\r | |
1285 | */\r | |
1286 | \r | |
1287 | ZEXTERN int ZEXPORT gzbuffer OF((gzFile file, unsigned size));\r | |
1288 | /*\r | |
1289 | Set the internal buffer size used by this library's functions. The\r | |
1290 | default buffer size is 8192 bytes. This function must be called after\r | |
1291 | gzopen() or gzdopen(), and before any other calls that read or write the\r | |
1292 | file. The buffer memory allocation is always deferred to the first read or\r | |
1293 | write. Two buffers are allocated, either both of the specified size when\r | |
1294 | writing, or one of the specified size and the other twice that size when\r | |
1295 | reading. A larger buffer size of, for example, 64K or 128K bytes will\r | |
1296 | noticeably increase the speed of decompression (reading).\r | |
1297 | \r | |
1298 | The new buffer size also affects the maximum length for gzprintf().\r | |
1299 | \r | |
1300 | gzbuffer() returns 0 on success, or -1 on failure, such as being called\r | |
1301 | too late.\r | |
1302 | */\r | |
1303 | \r | |
1304 | ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy));\r | |
1305 | /*\r | |
1306 | Dynamically update the compression level or strategy. See the description\r | |
1307 | of deflateInit2 for the meaning of these parameters.\r | |
1308 | \r | |
1309 | gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not\r | |
1310 | opened for writing.\r | |
1311 | */\r | |
1312 | \r | |
1313 | ZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len));\r | |
1314 | /*\r | |
1315 | Reads the given number of uncompressed bytes from the compressed file. If\r | |
1316 | the input file is not in gzip format, gzread copies the given number of\r | |
1317 | bytes into the buffer directly from the file.\r | |
1318 | \r | |
1319 | After reaching the end of a gzip stream in the input, gzread will continue\r | |
1320 | to read, looking for another gzip stream. Any number of gzip streams may be\r | |
1321 | concatenated in the input file, and will all be decompressed by gzread().\r | |
1322 | If something other than a gzip stream is encountered after a gzip stream,\r | |
1323 | that remaining trailing garbage is ignored (and no error is returned).\r | |
1324 | \r | |
1325 | gzread can be used to read a gzip file that is being concurrently written.\r | |
1326 | Upon reaching the end of the input, gzread will return with the available\r | |
1327 | data. If the error code returned by gzerror is Z_OK or Z_BUF_ERROR, then\r | |
1328 | gzclearerr can be used to clear the end of file indicator in order to permit\r | |
1329 | gzread to be tried again. Z_OK indicates that a gzip stream was completed\r | |
1330 | on the last gzread. Z_BUF_ERROR indicates that the input file ended in the\r | |
1331 | middle of a gzip stream. Note that gzread does not return -1 in the event\r | |
1332 | of an incomplete gzip stream. This error is deferred until gzclose(), which\r | |
1333 | will return Z_BUF_ERROR if the last gzread ended in the middle of a gzip\r | |
1334 | stream. Alternatively, gzerror can be used before gzclose to detect this\r | |
1335 | case.\r | |
1336 | \r | |
1337 | gzread returns the number of uncompressed bytes actually read, less than\r | |
1338 | len for end of file, or -1 for error.\r | |
1339 | */\r | |
1340 | \r | |
1341 | ZEXTERN int ZEXPORT gzwrite OF((gzFile file,\r | |
1342 | voidpc buf, unsigned len));\r | |
1343 | /*\r | |
1344 | Writes the given number of uncompressed bytes into the compressed file.\r | |
1345 | gzwrite returns the number of uncompressed bytes written or 0 in case of\r | |
1346 | error.\r | |
1347 | */\r | |
1348 | \r | |
1349 | ZEXTERN int ZEXPORTVA gzprintf Z_ARG((gzFile file, const char *format, ...));\r | |
1350 | /*\r | |
1351 | Converts, formats, and writes the arguments to the compressed file under\r | |
1352 | control of the format string, as in fprintf. gzprintf returns the number of\r | |
1353 | uncompressed bytes actually written, or 0 in case of error. The number of\r | |
1354 | uncompressed bytes written is limited to 8191, or one less than the buffer\r | |
1355 | size given to gzbuffer(). The caller should assure that this limit is not\r | |
1356 | exceeded. If it is exceeded, then gzprintf() will return an error (0) with\r | |
1357 | nothing written. In this case, there may also be a buffer overflow with\r | |
1358 | unpredictable consequences, which is possible only if zlib was compiled with\r | |
1359 | the insecure functions sprintf() or vsprintf() because the secure snprintf()\r | |
1360 | or vsnprintf() functions were not available. This can be determined using\r | |
1361 | zlibCompileFlags().\r | |
1362 | */\r | |
1363 | \r | |
1364 | ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s));\r | |
1365 | /*\r | |
1366 | Writes the given null-terminated string to the compressed file, excluding\r | |
1367 | the terminating null character.\r | |
1368 | \r | |
1369 | gzputs returns the number of characters written, or -1 in case of error.\r | |
1370 | */\r | |
1371 | \r | |
1372 | ZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, int len));\r | |
1373 | /*\r | |
1374 | Reads bytes from the compressed file until len-1 characters are read, or a\r | |
1375 | newline character is read and transferred to buf, or an end-of-file\r | |
1376 | condition is encountered. If any characters are read or if len == 1, the\r | |
1377 | string is terminated with a null character. If no characters are read due\r | |
1378 | to an end-of-file or len < 1, then the buffer is left untouched.\r | |
1379 | \r | |
1380 | gzgets returns buf which is a null-terminated string, or it returns NULL\r | |
1381 | for end-of-file or in case of error. If there was an error, the contents at\r | |
1382 | buf are indeterminate.\r | |
1383 | */\r | |
1384 | \r | |
1385 | ZEXTERN int ZEXPORT gzputc OF((gzFile file, int c));\r | |
1386 | /*\r | |
1387 | Writes c, converted to an unsigned char, into the compressed file. gzputc\r | |
1388 | returns the value that was written, or -1 in case of error.\r | |
1389 | */\r | |
1390 | \r | |
1391 | ZEXTERN int ZEXPORT gzgetc OF((gzFile file));\r | |
1392 | /*\r | |
1393 | Reads one byte from the compressed file. gzgetc returns this byte or -1\r | |
1394 | in case of end of file or error. This is implemented as a macro for speed.\r | |
1395 | As such, it does not do all of the checking the other functions do. I.e.\r | |
1396 | it does not check to see if file is NULL, nor whether the structure file\r | |
1397 | points to has been clobbered or not.\r | |
1398 | */\r | |
1399 | \r | |
1400 | ZEXTERN int ZEXPORT gzungetc OF((int c, gzFile file));\r | |
1401 | /*\r | |
1402 | Push one character back onto the stream to be read as the first character\r | |
1403 | on the next read. At least one character of push-back is allowed.\r | |
1404 | gzungetc() returns the character pushed, or -1 on failure. gzungetc() will\r | |
1405 | fail if c is -1, and may fail if a character has been pushed but not read\r | |
1406 | yet. If gzungetc is used immediately after gzopen or gzdopen, at least the\r | |
1407 | output buffer size of pushed characters is allowed. (See gzbuffer above.)\r | |
1408 | The pushed character will be discarded if the stream is repositioned with\r | |
1409 | gzseek() or gzrewind().\r | |
1410 | */\r | |
1411 | \r | |
1412 | ZEXTERN int ZEXPORT gzflush OF((gzFile file, int flush));\r | |
1413 | /*\r | |
1414 | Flushes all pending output into the compressed file. The parameter flush\r | |
1415 | is as in the deflate() function. The return value is the zlib error number\r | |
1416 | (see function gzerror below). gzflush is only permitted when writing.\r | |
1417 | \r | |
1418 | If the flush parameter is Z_FINISH, the remaining data is written and the\r | |
1419 | gzip stream is completed in the output. If gzwrite() is called again, a new\r | |
1420 | gzip stream will be started in the output. gzread() is able to read such\r | |
1421 | concatented gzip streams.\r | |
1422 | \r | |
1423 | gzflush should be called only when strictly necessary because it will\r | |
1424 | degrade compression if called too often.\r | |
1425 | */\r | |
1426 | \r | |
1427 | /*\r | |
1428 | ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file,\r | |
1429 | z_off_t offset, int whence));\r | |
1430 | \r | |
1431 | Sets the starting position for the next gzread or gzwrite on the given\r | |
1432 | compressed file. The offset represents a number of bytes in the\r | |
1433 | uncompressed data stream. The whence parameter is defined as in lseek(2);\r | |
1434 | the value SEEK_END is not supported.\r | |
1435 | \r | |
1436 | If the file is opened for reading, this function is emulated but can be\r | |
1437 | extremely slow. If the file is opened for writing, only forward seeks are\r | |
1438 | supported; gzseek then compresses a sequence of zeroes up to the new\r | |
1439 | starting position.\r | |
1440 | \r | |
1441 | gzseek returns the resulting offset location as measured in bytes from\r | |
1442 | the beginning of the uncompressed stream, or -1 in case of error, in\r | |
1443 | particular if the file is opened for writing and the new starting position\r | |
1444 | would be before the current position.\r | |
1445 | */\r | |
1446 | \r | |
1447 | ZEXTERN int ZEXPORT gzrewind OF((gzFile file));\r | |
1448 | /*\r | |
1449 | Rewinds the given file. This function is supported only for reading.\r | |
1450 | \r | |
1451 | gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)\r | |
1452 | */\r | |
1453 | \r | |
1454 | /*\r | |
1455 | ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file));\r | |
1456 | \r | |
1457 | Returns the starting position for the next gzread or gzwrite on the given\r | |
1458 | compressed file. This position represents a number of bytes in the\r | |
1459 | uncompressed data stream, and is zero when starting, even if appending or\r | |
1460 | reading a gzip stream from the middle of a file using gzdopen().\r | |
1461 | \r | |
1462 | gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)\r | |
1463 | */\r | |
1464 | \r | |
1465 | /*\r | |
1466 | ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile file));\r | |
1467 | \r | |
1468 | Returns the current offset in the file being read or written. This offset\r | |
1469 | includes the count of bytes that precede the gzip stream, for example when\r | |
1470 | appending or when using gzdopen() for reading. When reading, the offset\r | |
1471 | does not include as yet unused buffered input. This information can be used\r | |
1472 | for a progress indicator. On error, gzoffset() returns -1.\r | |
1473 | */\r | |
1474 | \r | |
1475 | ZEXTERN int ZEXPORT gzeof OF((gzFile file));\r | |
1476 | /*\r | |
1477 | Returns true (1) if the end-of-file indicator has been set while reading,\r | |
1478 | false (0) otherwise. Note that the end-of-file indicator is set only if the\r | |
1479 | read tried to go past the end of the input, but came up short. Therefore,\r | |
1480 | just like feof(), gzeof() may return false even if there is no more data to\r | |
1481 | read, in the event that the last read request was for the exact number of\r | |
1482 | bytes remaining in the input file. This will happen if the input file size\r | |
1483 | is an exact multiple of the buffer size.\r | |
1484 | \r | |
1485 | If gzeof() returns true, then the read functions will return no more data,\r | |
1486 | unless the end-of-file indicator is reset by gzclearerr() and the input file\r | |
1487 | has grown since the previous end of file was detected.\r | |
1488 | */\r | |
1489 | \r | |
1490 | ZEXTERN int ZEXPORT gzdirect OF((gzFile file));\r | |
1491 | /*\r | |
1492 | Returns true (1) if file is being copied directly while reading, or false\r | |
1493 | (0) if file is a gzip stream being decompressed.\r | |
1494 | \r | |
1495 | If the input file is empty, gzdirect() will return true, since the input\r | |
1496 | does not contain a gzip stream.\r | |
1497 | \r | |
1498 | If gzdirect() is used immediately after gzopen() or gzdopen() it will\r | |
1499 | cause buffers to be allocated to allow reading the file to determine if it\r | |
1500 | is a gzip file. Therefore if gzbuffer() is used, it should be called before\r | |
1501 | gzdirect().\r | |
1502 | \r | |
1503 | When writing, gzdirect() returns true (1) if transparent writing was\r | |
1504 | requested ("wT" for the gzopen() mode), or false (0) otherwise. (Note:\r | |
1505 | gzdirect() is not needed when writing. Transparent writing must be\r | |
1506 | explicitly requested, so the application already knows the answer. When\r | |
1507 | linking statically, using gzdirect() will include all of the zlib code for\r | |
1508 | gzip file reading and decompression, which may not be desired.)\r | |
1509 | */\r | |
1510 | \r | |
1511 | ZEXTERN int ZEXPORT gzclose OF((gzFile file));\r | |
1512 | /*\r | |
1513 | Flushes all pending output if necessary, closes the compressed file and\r | |
1514 | deallocates the (de)compression state. Note that once file is closed, you\r | |
1515 | cannot call gzerror with file, since its structures have been deallocated.\r | |
1516 | gzclose must not be called more than once on the same file, just as free\r | |
1517 | must not be called more than once on the same allocation.\r | |
1518 | \r | |
1519 | gzclose will return Z_STREAM_ERROR if file is not valid, Z_ERRNO on a\r | |
1520 | file operation error, Z_MEM_ERROR if out of memory, Z_BUF_ERROR if the\r | |
1521 | last read ended in the middle of a gzip stream, or Z_OK on success.\r | |
1522 | */\r | |
1523 | \r | |
1524 | ZEXTERN int ZEXPORT gzclose_r OF((gzFile file));\r | |
1525 | ZEXTERN int ZEXPORT gzclose_w OF((gzFile file));\r | |
1526 | /*\r | |
1527 | Same as gzclose(), but gzclose_r() is only for use when reading, and\r | |
1528 | gzclose_w() is only for use when writing or appending. The advantage to\r | |
1529 | using these instead of gzclose() is that they avoid linking in zlib\r | |
1530 | compression or decompression code that is not used when only reading or only\r | |
1531 | writing respectively. If gzclose() is used, then both compression and\r | |
1532 | decompression code will be included the application when linking to a static\r | |
1533 | zlib library.\r | |
1534 | */\r | |
1535 | \r | |
1536 | ZEXTERN const char * ZEXPORT gzerror OF((gzFile file, int *errnum));\r | |
1537 | /*\r | |
1538 | Returns the error message for the last error which occurred on the given\r | |
1539 | compressed file. errnum is set to zlib error number. If an error occurred\r | |
1540 | in the file system and not in the compression library, errnum is set to\r | |
1541 | Z_ERRNO and the application may consult errno to get the exact error code.\r | |
1542 | \r | |
1543 | The application must not modify the returned string. Future calls to\r | |
1544 | this function may invalidate the previously returned string. If file is\r | |
1545 | closed, then the string previously returned by gzerror will no longer be\r | |
1546 | available.\r | |
1547 | \r | |
1548 | gzerror() should be used to distinguish errors from end-of-file for those\r | |
1549 | functions above that do not distinguish those cases in their return values.\r | |
1550 | */\r | |
1551 | \r | |
1552 | ZEXTERN void ZEXPORT gzclearerr OF((gzFile file));\r | |
1553 | /*\r | |
1554 | Clears the error and end-of-file flags for file. This is analogous to the\r | |
1555 | clearerr() function in stdio. This is useful for continuing to read a gzip\r | |
1556 | file that is being written concurrently.\r | |
1557 | */\r | |
1558 | \r | |
1559 | #endif /* !Z_SOLO */\r | |
1560 | \r | |
1561 | /* checksum functions */\r | |
1562 | \r | |
1563 | /*\r | |
1564 | These functions are not related to compression but are exported\r | |
1565 | anyway because they might be useful in applications using the compression\r | |
1566 | library.\r | |
1567 | */\r | |
1568 | \r | |
1569 | ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len));\r | |
1570 | /*\r | |
1571 | Update a running Adler-32 checksum with the bytes buf[0..len-1] and\r | |
1572 | return the updated checksum. If buf is Z_NULL, this function returns the\r | |
1573 | required initial value for the checksum.\r | |
1574 | \r | |
1575 | An Adler-32 checksum is almost as reliable as a CRC32 but can be computed\r | |
1576 | much faster.\r | |
1577 | \r | |
1578 | Usage example:\r | |
1579 | \r | |
1580 | uLong adler = adler32(0L, Z_NULL, 0);\r | |
1581 | \r | |
1582 | while (read_buffer(buffer, length) != EOF) {\r | |
1583 | adler = adler32(adler, buffer, length);\r | |
1584 | }\r | |
1585 | if (adler != original_adler) error();\r | |
1586 | */\r | |
1587 | \r | |
1588 | /*\r | |
1589 | ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2,\r | |
1590 | z_off_t len2));\r | |
1591 | \r | |
1592 | Combine two Adler-32 checksums into one. For two sequences of bytes, seq1\r | |
1593 | and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for\r | |
1594 | each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of\r | |
1595 | seq1 and seq2 concatenated, requiring only adler1, adler2, and len2. Note\r | |
1596 | that the z_off_t type (like off_t) is a signed integer. If len2 is\r | |
1597 | negative, the result has no meaning or utility.\r | |
1598 | */\r | |
1599 | \r | |
1600 | ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len));\r | |
1601 | /*\r | |
1602 | Update a running CRC-32 with the bytes buf[0..len-1] and return the\r | |
1603 | updated CRC-32. If buf is Z_NULL, this function returns the required\r | |
1604 | initial value for the crc. Pre- and post-conditioning (one's complement) is\r | |
1605 | performed within this function so it shouldn't be done by the application.\r | |
1606 | \r | |
1607 | Usage example:\r | |
1608 | \r | |
1609 | uLong crc = crc32(0L, Z_NULL, 0);\r | |
1610 | \r | |
1611 | while (read_buffer(buffer, length) != EOF) {\r | |
1612 | crc = crc32(crc, buffer, length);\r | |
1613 | }\r | |
1614 | if (crc != original_crc) error();\r | |
1615 | */\r | |
1616 | \r | |
1617 | /*\r | |
1618 | ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2));\r | |
1619 | \r | |
1620 | Combine two CRC-32 check values into one. For two sequences of bytes,\r | |
1621 | seq1 and seq2 with lengths len1 and len2, CRC-32 check values were\r | |
1622 | calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32\r | |
1623 | check value of seq1 and seq2 concatenated, requiring only crc1, crc2, and\r | |
1624 | len2.\r | |
1625 | */\r | |
1626 | \r | |
1627 | \r | |
1628 | /* various hacks, don't look :) */\r | |
1629 | \r | |
1630 | /* deflateInit and inflateInit are macros to allow checking the zlib version\r | |
1631 | * and the compiler's view of z_stream:\r | |
1632 | */\r | |
1633 | ZEXTERN int ZEXPORT deflateInit_ OF((z_streamp strm, int level,\r | |
1634 | const char *version, int stream_size));\r | |
1635 | ZEXTERN int ZEXPORT inflateInit_ OF((z_streamp strm,\r | |
1636 | const char *version, int stream_size));\r | |
1637 | ZEXTERN int ZEXPORT deflateInit2_ OF((z_streamp strm, int level, int method,\r | |
1638 | int windowBits, int memLevel,\r | |
1639 | int strategy, const char *version,\r | |
1640 | int stream_size));\r | |
1641 | ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int windowBits,\r | |
1642 | const char *version, int stream_size));\r | |
1643 | ZEXTERN int ZEXPORT inflateBackInit_ OF((z_streamp strm, int windowBits,\r | |
1644 | unsigned char FAR *window,\r | |
1645 | const char *version,\r | |
1646 | int stream_size));\r | |
1647 | #define deflateInit(strm, level) \\r | |
1648 | deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream))\r | |
1649 | #define inflateInit(strm) \\r | |
1650 | inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream))\r | |
1651 | #define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \\r | |
1652 | deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\\r | |
1653 | (strategy), ZLIB_VERSION, (int)sizeof(z_stream))\r | |
1654 | #define inflateInit2(strm, windowBits) \\r | |
1655 | inflateInit2_((strm), (windowBits), ZLIB_VERSION, \\r | |
1656 | (int)sizeof(z_stream))\r | |
1657 | #define inflateBackInit(strm, windowBits, window) \\r | |
1658 | inflateBackInit_((strm), (windowBits), (window), \\r | |
1659 | ZLIB_VERSION, (int)sizeof(z_stream))\r | |
1660 | \r | |
1661 | #ifndef Z_SOLO\r | |
1662 | \r | |
1663 | /* gzgetc() macro and its supporting function and exposed data structure. Note\r | |
1664 | * that the real internal state is much larger than the exposed structure.\r | |
1665 | * This abbreviated structure exposes just enough for the gzgetc() macro. The\r | |
1666 | * user should not mess with these exposed elements, since their names or\r | |
1667 | * behavior could change in the future, perhaps even capriciously. They can\r | |
1668 | * only be used by the gzgetc() macro. You have been warned.\r | |
1669 | */\r | |
1670 | struct gzFile_s {\r | |
1671 | unsigned have;\r | |
1672 | unsigned char *next;\r | |
1673 | z_off64_t pos;\r | |
1674 | };\r | |
1675 | ZEXTERN int ZEXPORT gzgetc_ OF((gzFile file)); /* backward compatibility */\r | |
1676 | #ifdef Z_PREFIX_SET\r | |
1677 | # undef z_gzgetc\r | |
1678 | # define z_gzgetc(g) \\r | |
1679 | ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g))\r | |
1680 | #else\r | |
1681 | # define gzgetc(g) \\r | |
1682 | ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g))\r | |
1683 | #endif\r | |
1684 | \r | |
1685 | /* provide 64-bit offset functions if _LARGEFILE64_SOURCE defined, and/or\r | |
1686 | * change the regular functions to 64 bits if _FILE_OFFSET_BITS is 64 (if\r | |
1687 | * both are true, the application gets the *64 functions, and the regular\r | |
1688 | * functions are changed to 64 bits) -- in case these are set on systems\r | |
1689 | * without large file support, _LFS64_LARGEFILE must also be true\r | |
1690 | */\r | |
1691 | #ifdef Z_LARGE64\r | |
1692 | ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *));\r | |
1693 | ZEXTERN z_off64_t ZEXPORT gzseek64 OF((gzFile, z_off64_t, int));\r | |
1694 | ZEXTERN z_off64_t ZEXPORT gztell64 OF((gzFile));\r | |
1695 | ZEXTERN z_off64_t ZEXPORT gzoffset64 OF((gzFile));\r | |
1696 | ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off64_t));\r | |
1697 | ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off64_t));\r | |
1698 | #endif\r | |
1699 | \r | |
1700 | #if !defined(ZLIB_INTERNAL) && defined(Z_WANT64)\r | |
1701 | # ifdef Z_PREFIX_SET\r | |
1702 | # define z_gzopen z_gzopen64\r | |
1703 | # define z_gzseek z_gzseek64\r | |
1704 | # define z_gztell z_gztell64\r | |
1705 | # define z_gzoffset z_gzoffset64\r | |
1706 | # define z_adler32_combine z_adler32_combine64\r | |
1707 | # define z_crc32_combine z_crc32_combine64\r | |
1708 | # else\r | |
1709 | # define gzopen gzopen64\r | |
1710 | # define gzseek gzseek64\r | |
1711 | # define gztell gztell64\r | |
1712 | # define gzoffset gzoffset64\r | |
1713 | # define adler32_combine adler32_combine64\r | |
1714 | # define crc32_combine crc32_combine64\r | |
1715 | # endif\r | |
1716 | # ifndef Z_LARGE64\r | |
1717 | ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *));\r | |
1718 | ZEXTERN z_off_t ZEXPORT gzseek64 OF((gzFile, z_off_t, int));\r | |
1719 | ZEXTERN z_off_t ZEXPORT gztell64 OF((gzFile));\r | |
1720 | ZEXTERN z_off_t ZEXPORT gzoffset64 OF((gzFile));\r | |
1721 | ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off_t));\r | |
1722 | ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off_t));\r | |
1723 | # endif\r | |
1724 | #else\r | |
1725 | ZEXTERN gzFile ZEXPORT gzopen OF((const char *, const char *));\r | |
1726 | ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile, z_off_t, int));\r | |
1727 | ZEXTERN z_off_t ZEXPORT gztell OF((gzFile));\r | |
1728 | ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile));\r | |
1729 | ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t));\r | |
1730 | ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t));\r | |
1731 | #endif\r | |
1732 | \r | |
1733 | #else /* Z_SOLO */\r | |
1734 | \r | |
1735 | ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t));\r | |
1736 | ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t));\r | |
1737 | \r | |
1738 | #endif /* !Z_SOLO */\r | |
1739 | \r | |
1740 | /* hack for buggy compilers */\r | |
1741 | #if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL)\r | |
1742 | struct internal_state {int dummy;};\r | |
1743 | #endif\r | |
1744 | \r | |
1745 | /* undocumented functions */\r | |
1746 | ZEXTERN const char * ZEXPORT zError OF((int));\r | |
1747 | ZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp));\r | |
1748 | ZEXTERN const z_crc_t FAR * ZEXPORT get_crc_table OF((void));\r | |
1749 | ZEXTERN int ZEXPORT inflateUndermine OF((z_streamp, int));\r | |
1750 | ZEXTERN int ZEXPORT inflateResetKeep OF((z_streamp));\r | |
1751 | ZEXTERN int ZEXPORT deflateResetKeep OF((z_streamp));\r | |
1752 | #if defined(_WIN32) && !defined(Z_SOLO)\r | |
1753 | ZEXTERN gzFile ZEXPORT gzopen_w OF((const wchar_t *path,\r | |
1754 | const char *mode));\r | |
1755 | #endif\r | |
1756 | #if defined(STDC) || defined(Z_HAVE_STDARG_H)\r | |
1757 | # ifndef Z_SOLO\r | |
1758 | ZEXTERN int ZEXPORTVA gzvprintf Z_ARG((gzFile file,\r | |
1759 | const char *format,\r | |
1760 | va_list va));\r | |
1761 | # endif\r | |
1762 | #endif\r | |
1763 | \r | |
1764 | #ifdef __cplusplus\r | |
1765 | }\r | |
1766 | #endif\r | |
1767 | \r | |
1768 | #endif /* ZLIB_H */\r |