diff options
Diffstat (limited to 'zlib.h')
-rw-r--r-- | zlib.h | 604 |
1 files changed, 604 insertions, 0 deletions
@@ -0,0 +1,604 @@ | |||
1 | /* zlib.h -- interface of the 'zlib' general purpose compression library | ||
2 | version 0.7 April 14th, 1995. | ||
3 | |||
4 | Copyright (C) 1995 Jean-loup Gailly and Mark Adler | ||
5 | |||
6 | This software is provided 'as-is', without any express or implied | ||
7 | warranty. In no event will the authors be held liable for any damages | ||
8 | arising from the use of this software. | ||
9 | |||
10 | Permission is granted to anyone to use this software for any purpose, | ||
11 | including commercial applications, and to alter it and redistribute it | ||
12 | freely, subject to the following restrictions: | ||
13 | |||
14 | 1. The origin of this software must not be misrepresented; you must not | ||
15 | claim that you wrote the original software. If you use this software | ||
16 | in a product, an acknowledgment in the product documentation would be | ||
17 | appreciated but is not required. | ||
18 | 2. Altered source versions must be plainly marked as such, and must not be | ||
19 | misrepresented as being the original software. | ||
20 | 3. This notice may not be removed or altered from any source distribution. | ||
21 | |||
22 | Jean-loup Gailly Mark Adler | ||
23 | gzip@prep.ai.mit.edu madler@cco.caltech.edu | ||
24 | */ | ||
25 | |||
26 | #ifndef _ZLIB_H | ||
27 | #define _ZLIB_H | ||
28 | |||
29 | #include "zconf.h" | ||
30 | |||
31 | #define ZLIB_VERSION "0.7" | ||
32 | |||
33 | /* | ||
34 | The 'zlib' compression library provides in-memory compression and | ||
35 | decompression functions, including integrity checks of the uncompressed | ||
36 | data. This version of the library supports only one compression method | ||
37 | (deflation) but other algorithms may be added later and will have the same | ||
38 | stream interface. | ||
39 | |||
40 | For compression the application must provide the output buffer and | ||
41 | may optionally provide the input buffer for optimization. For decompression, | ||
42 | the application must provide the input buffer and may optionally provide | ||
43 | the output buffer for optimization. | ||
44 | |||
45 | Compression can be done in a single step if the buffers are large | ||
46 | enough (for example if an input file is mmap'ed), or can be done by | ||
47 | repeated calls of the compression function. In the latter case, the | ||
48 | application must provide more input and/or consume the output | ||
49 | (providing more output space) before each call. | ||
50 | */ | ||
51 | |||
52 | typedef voidp (*alloc_func) __P((voidp opaque, uInt items, uInt size)); | ||
53 | typedef void (*free_func) __P((voidp opaque, voidp address)); | ||
54 | |||
55 | struct internal_state; | ||
56 | |||
57 | typedef struct z_stream_s { | ||
58 | Byte *next_in; /* next input byte */ | ||
59 | uInt avail_in; /* number of bytes available at next_in */ | ||
60 | uLong total_in; /* total nb of input bytes read so far */ | ||
61 | |||
62 | Byte *next_out; /* next output byte should be put there */ | ||
63 | uInt avail_out; /* remaining free space at next_out */ | ||
64 | uLong total_out; /* total nb of bytes output so far */ | ||
65 | |||
66 | char *msg; /* last error message, NULL if no error */ | ||
67 | struct internal_state *state; /* not visible by applications */ | ||
68 | |||
69 | alloc_func zalloc; /* used to allocate the internal state */ | ||
70 | free_func zfree; /* used to free the internal state */ | ||
71 | voidp opaque; /* private data object passed to zalloc and zfree */ | ||
72 | |||
73 | Byte data_type; /* best guess about the data type: ascii or binary */ | ||
74 | |||
75 | } z_stream; | ||
76 | |||
77 | /* | ||
78 | The application must update next_in and avail_in when avail_in has | ||
79 | dropped to zero. It must update next_out and avail_out when avail_out | ||
80 | has dropped to zero. The application must initialize zalloc, zfree and | ||
81 | opaque before calling the init function. All other fields are set by the | ||
82 | compression library and must not be updated by the application. | ||
83 | |||
84 | The opaque value provided by the application will be passed as first | ||
85 | parameter for calls of zalloc and zfree. This can be useful for custom | ||
86 | memory management. The compression library attaches no meaning to the | ||
87 | opaque value. | ||
88 | |||
89 | zalloc must return Z_NULL if there is not enough memory for the object. | ||
90 | On 16-bit systems, the functions zalloc and zfree must be able to allocate | ||
91 | exactly 65536 bytes, but will not be require to allocate more than this | ||
92 | if the symbol MAXSEG_64K is defined (see zconf.h). | ||
93 | |||
94 | The fields total_in and total_out can be used for statistics or | ||
95 | progress reports. After compression, total_in holds the total size of | ||
96 | the uncompressed data and may be saved for use in the decompressor | ||
97 | (particularly if the decompressor wants to decompress everything in | ||
98 | a single step). | ||
99 | */ | ||
100 | |||
101 | /* constants */ | ||
102 | |||
103 | #define Z_NO_FLUSH 0 | ||
104 | #define Z_PARTIAL_FLUSH 1 | ||
105 | #define Z_FULL_FLUSH 2 | ||
106 | #define Z_FINISH 4 | ||
107 | /* See deflate() below for the usage of these constants */ | ||
108 | |||
109 | #define Z_OK 0 | ||
110 | #define Z_STREAM_END 1 | ||
111 | #define Z_ERRNO (-1) | ||
112 | #define Z_STREAM_ERROR (-2) | ||
113 | #define Z_DATA_ERROR (-3) | ||
114 | #define Z_MEM_ERROR (-4) | ||
115 | #define Z_BUF_ERROR (-5) | ||
116 | /* error codes for the compression/decompression functions */ | ||
117 | |||
118 | #define Z_BEST_SPEED 1 | ||
119 | #define Z_BEST_COMPRESSION 9 | ||
120 | #define Z_DEFAULT_COMPRESSION (-1) | ||
121 | /* compression levels */ | ||
122 | |||
123 | #define Z_FILTERED 1 | ||
124 | #define Z_HUFFMAN_ONLY 2 | ||
125 | #define Z_DEFAULT_STRATEGY 0 | ||
126 | |||
127 | #define Z_BINARY 0 | ||
128 | #define Z_ASCII 1 | ||
129 | #define Z_UNKNOWN 2 | ||
130 | /* Used to set the data_type field */ | ||
131 | |||
132 | #define Z_NULL 0 /* for initializing zalloc, zfree, opaque */ | ||
133 | |||
134 | extern char *zlib_version; | ||
135 | /* The application can compare zlib_version and ZLIB_VERSION for consistency. | ||
136 | If the first character differs, the library code actually used is | ||
137 | not compatible with the zlib.h header file used by the application. | ||
138 | */ | ||
139 | |||
140 | /* basic functions */ | ||
141 | |||
142 | extern int deflateInit __P((z_stream *strm, int level)); | ||
143 | /* | ||
144 | Initializes the internal stream state for compression. The fields | ||
145 | zalloc, zfree and opaque must be initialized before by the caller. | ||
146 | If zalloc and zfree are set to Z_NULL, deflateInit updates them to | ||
147 | use default allocation functions. | ||
148 | |||
149 | The compression level must be Z_DEFAULT_COMPRESSION, or between 1 and 9: | ||
150 | 1 gives best speed, 9 gives best compression. Z_DEFAULT_COMPRESSION requests | ||
151 | a default compromise between speed and compression (currently equivalent | ||
152 | to level 6). | ||
153 | |||
154 | deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not | ||
155 | enough memory, Z_STREAM_ERROR if the stream state was inconsistent (such | ||
156 | as zalloc being NULL). msg is set to null if there is no error message. | ||
157 | deflateInit does not perform any compression: this will be done by | ||
158 | deflate(). */ | ||
159 | |||
160 | |||
161 | extern int deflate __P((z_stream *strm, int flush)); | ||
162 | /* | ||
163 | Performs one or both of the following actions: | ||
164 | |||
165 | - Compress more input starting at next_in and update next_in and avail_in | ||
166 | accordingly. If not all input can be processed (because there is not | ||
167 | enough room in the output buffer), next_in is updated and processing | ||
168 | will resume at this point for the next call of deflate(). | ||
169 | |||
170 | - Provide more output starting at next_out and update next_out and avail_out | ||
171 | accordingly. This action is forced if the parameter flush is non zero. | ||
172 | Forcing flush frequently degrades the compression ratio, so this parameter | ||
173 | should be set only when necessary (in interactive applications). | ||
174 | Some output may be provided even if flush is not set. | ||
175 | |||
176 | Before the call of deflate(), the application should ensure that at least | ||
177 | one of the actions is possible, by providing more input and/or consuming | ||
178 | more output, and updating avail_in or avail_out accordingly. | ||
179 | The application can consume the compressed output when the output | ||
180 | buffer is full (avail_out == 0), or after each call of deflate(). | ||
181 | |||
182 | If the parameter flush is set to Z_PARTIAL_FLUSH, the current compression | ||
183 | block is byte aligned and flushed to the output buffer so that the | ||
184 | decompressor can get all input data available so far; if the compression | ||
185 | method is 8 (deflate without partial flush capability), the current block | ||
186 | is terminated. If flush is set to Z_FULL_FLUSH, the compression block is | ||
187 | terminated, a special marker is output and the compression dictionary is | ||
188 | discarded; this is useful to allow the decompressor to synchronize if one | ||
189 | compressed block has been damaged. | ||
190 | Flushing degrades compression and so should be used only when necessary. | ||
191 | Using Z_FULL_FLUSH too often can seriously degrade the compression. | ||
192 | |||
193 | If the parameter flush is set to Z_FINISH, all pending input is | ||
194 | processed and all pending output is flushed. The next operation on this | ||
195 | stream must be another call of deflate with Z_FINISH but no more input data | ||
196 | (unchanged avail_in) if this call returned with avail_out equal to zero, | ||
197 | or a call of deflateEnd to deallocate the compression state. Z_FINISH can | ||
198 | be used immediately after deflateInit if all the compression is to be | ||
199 | done in a single step. In this case, avail_out must be at least 0.1% | ||
200 | larger than avail_in plus 8 bytes. | ||
201 | |||
202 | deflate() may update strm->data_type if it can make a good guess about | ||
203 | the input data type (Z_ASCII or Z_BINARY). In doubt, the data is considered | ||
204 | binary. This field is only for information purposes and does not affect | ||
205 | the compression algorithm in any manner. | ||
206 | |||
207 | deflate() return Z_OK if some progress has been made (more input processed | ||
208 | or more output produced), Z_STREAM_ERROR if the stream state was | ||
209 | inconsistent (for example if next_in or next_out was NULL), Z_BUF_ERROR if | ||
210 | no progress is possible or if there was not enough room in the output buffer | ||
211 | when Z_FINISH is used. | ||
212 | */ | ||
213 | |||
214 | |||
215 | extern int deflateEnd __P((z_stream *strm)); | ||
216 | /* | ||
217 | All dynamically allocated data structures for this stream are freed. | ||
218 | This function discards any unprocessed input and does not flush any | ||
219 | pending output. | ||
220 | |||
221 | deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the | ||
222 | stream state was inconsistent. In the error case, msg may be set | ||
223 | but then points to a static string (which must not be deallocated). | ||
224 | */ | ||
225 | |||
226 | |||
227 | extern int inflateInit __P((z_stream *strm)); | ||
228 | /* | ||
229 | Initializes the internal stream state for decompression. The fields | ||
230 | zalloc and zfree must be initialized before by the caller. If zalloc and | ||
231 | zfree are set to Z_NULL, deflateInit updates them to use default allocation | ||
232 | functions. | ||
233 | |||
234 | inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not | ||
235 | enough memory, Z_STREAM_ERROR if the stream state was inconsistent (such | ||
236 | as zalloc being NULL). msg is set to null if there is no error message. | ||
237 | inflateInit does not perform any decompression: this will be done by | ||
238 | inflate(). | ||
239 | */ | ||
240 | |||
241 | |||
242 | extern int inflate __P((z_stream *strm, int flush)); | ||
243 | /* | ||
244 | Performs one or both of the following actions: | ||
245 | |||
246 | - Decompress more input starting at next_in and update next_in and avail_in | ||
247 | accordingly. If not all input can be processed (because there is not | ||
248 | enough room in the output buffer), next_in is updated and processing | ||
249 | will resume at this point for the next call of inflate(). | ||
250 | |||
251 | - Provide more output starting at next_out and update next_out and avail_out | ||
252 | accordingly. inflate() always provides as much output as possible | ||
253 | (until no more input data or no more space in the output buffer). | ||
254 | |||
255 | Before the call of inflate(), the application should ensure that at least | ||
256 | one of the actions is possible, by providing more input and/or consuming | ||
257 | more output, and updating the next_* and avail_* values accordingly. | ||
258 | The application can consume the uncompressed output when the output | ||
259 | buffer is full (avail_out == 0), or after each call of inflate(). | ||
260 | |||
261 | If the parameter flush is set to Z_PARTIAL_FLUSH, inflate flushes as much | ||
262 | output as possible to the output buffer. The flushing behavior of inflate is | ||
263 | not specified for values of the flush paramater other than Z_PARTIAL_FLUSH | ||
264 | and Z_FINISH, but the current implementation actually flushes as much output | ||
265 | as possible anyway. | ||
266 | |||
267 | inflate() should normally be called until it returns Z_STREAM_END or an | ||
268 | error. However if all decompression is to be performed in a single step | ||
269 | (a single call of inflate), the parameter flush should be set to | ||
270 | Z_FINISH. In this case all pending input is processed and all pending | ||
271 | output is flushed; avail_out must be large enough to hold all the | ||
272 | uncompressed data. (The size of the uncompressed data may have been saved | ||
273 | by the compressor for this purpose.) The next operation on this stream must | ||
274 | be inflateEnd to deallocate the decompression state. | ||
275 | |||
276 | inflate() returns Z_OK if some progress has been made (more input | ||
277 | processed or more output produced), Z_STREAM_END if the end of the | ||
278 | compressed data has been reached, Z_DATA_ERROR if the input data was | ||
279 | corrupted, Z_STREAM_ERROR if the stream structure was inconsistent (for | ||
280 | example if next_in or next_out was NULL), Z_MEM_ERROR if there was not enough | ||
281 | memory, Z_BUF_ERROR if no progress is possible or if there was not enough | ||
282 | room in the output buffer when Z_FINISH is used. In the Z_DATA_ERROR case, | ||
283 | the application may then call inflateSync to look for a good compression | ||
284 | block. | ||
285 | */ | ||
286 | |||
287 | |||
288 | extern int inflateEnd __P((z_stream *strm)); | ||
289 | /* | ||
290 | All dynamically allocated data structures for this stream are freed. | ||
291 | This function discards any unprocessed input and does not flush any | ||
292 | pending output. | ||
293 | |||
294 | inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state | ||
295 | was inconsistent. In the error case, msg may be set but then points to a | ||
296 | static string (which must not be deallocated). | ||
297 | */ | ||
298 | |||
299 | /* advanced functions */ | ||
300 | |||
301 | /* | ||
302 | The following functions are needed only in some special applications. | ||
303 | */ | ||
304 | |||
305 | extern int deflateInit2 __P((z_stream *strm, | ||
306 | int level, | ||
307 | int method, | ||
308 | int windowBits, | ||
309 | int memLevel, | ||
310 | int strategy)); | ||
311 | /* | ||
312 | This is another version of deflateInit with more compression options. The | ||
313 | fields next_in, zalloc and zfree must be initialized before by the caller. | ||
314 | |||
315 | The method parameter is the compression method. It must be 8 in this | ||
316 | version of the library. (Method 9 will allow a 64K history buffer and | ||
317 | partial block flushes.) | ||
318 | |||
319 | The windowBits parameter is the base two logarithm of the window size | ||
320 | (the size of the history buffer). It should be in the range 8..15 for this | ||
321 | version of the library (the value 16 will be allowed soon). Larger values | ||
322 | of this parameter result in better compression at the expense of memory | ||
323 | usage. The default value is 15 if deflateInit is used instead. | ||
324 | |||
325 | The memLevel parameter specifies how much memory should be allocated | ||
326 | for the internal compression state. memLevel=1 uses minimum memory but | ||
327 | is slow and reduces compression ratio; memLevel=9 uses maximum memory | ||
328 | for optimal speed. The default value is 8. | ||
329 | |||
330 | The strategy parameter is used to tune the compression algorithm. Use | ||
331 | the value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data | ||
332 | produced by a filter (or predictor), or Z_HUFFMAN_ONLY to force Huffman | ||
333 | encoding only (no string match). Filtered data consists mostly of small | ||
334 | values with a somewhat random distribution. In this case, the | ||
335 | compression algorithm is tuned to compress them better. The strategy | ||
336 | parameter only affects the compression ratio but not the correctness of | ||
337 | the compressed output even if it is not set appropriately. | ||
338 | |||
339 | If next_in is not null, the library will use this buffer to hold also | ||
340 | some history information; the buffer must either hold the entire input | ||
341 | data, or have at least (1<<windowBits) bytes and be writable. If next_in is | ||
342 | null, the library will allocate its own history buffer (and leave next_in | ||
343 | null). next_out need not be provided here but must be provided by the | ||
344 | application for the next call of deflate(). | ||
345 | |||
346 | If the history buffer is provided by the application, next_in must | ||
347 | must never be changed by the application since the compressor maintains | ||
348 | information inside this buffer from call to call; the application | ||
349 | must provide more input only by increasing avail_in. next_in is always | ||
350 | reset by the library in this case. | ||
351 | |||
352 | deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was | ||
353 | not enough memory, Z_STREAM_ERROR if the stream state was inconsistent | ||
354 | (such as zalloc being NULL) or the parameters are invalid (such as | ||
355 | an invalid method). msg is set to null if there is no error message. | ||
356 | deflateInit2 does not perform any compression: this will be done by | ||
357 | deflate(). | ||
358 | */ | ||
359 | |||
360 | extern int deflateCopy __P((z_stream *dest, | ||
361 | z_stream *source)); | ||
362 | /* | ||
363 | Sets the destination stream as a complete copy of the source stream. If | ||
364 | the source stream is using an application-supplied history buffer, a new | ||
365 | buffer is allocated for the destination stream. The compressed output | ||
366 | buffer is always application-supplied. It's the responsability of the | ||
367 | application to provide the correct values of next_out and avail_out for the | ||
368 | next call of deflate. | ||
369 | |||
370 | This function is useful when several compression strategies will be | ||
371 | tried, for example when there are several ways of pre-processing the input | ||
372 | data with a filter. The streams that will be discarded should then be freed | ||
373 | by calling deflateEnd. Note that deflateCopy duplicates the internal | ||
374 | compression state which can be quite large, so this strategy is slow and | ||
375 | can consume lots of memory. | ||
376 | |||
377 | deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not | ||
378 | enough memory, Z_STREAM_ERROR if the source stream state was inconsistent | ||
379 | (such as zalloc being NULL). msg is left unchanged in both source and | ||
380 | destination. | ||
381 | */ | ||
382 | |||
383 | extern int deflateReset __P((z_stream *strm)); | ||
384 | /* | ||
385 | This function is equivalent to deflateEnd followed by deflateInit, | ||
386 | but does not free and reallocate all the internal compression state. | ||
387 | The stream will keep the same compression level and any other attributes | ||
388 | that may have been set by deflateInit2. | ||
389 | |||
390 | deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source | ||
391 | stream state was inconsistent (such as zalloc or state being NULL). | ||
392 | */ | ||
393 | |||
394 | extern int inflateInit2 __P((z_stream *strm, | ||
395 | int windowBits)); | ||
396 | /* | ||
397 | This is another version of inflateInit with more compression options. The | ||
398 | fields next_out, zalloc and zfree must be initialized before by the caller. | ||
399 | |||
400 | The windowBits parameter is the base two logarithm of the maximum window | ||
401 | size (the size of the history buffer). It should be in the range 8..15 for | ||
402 | this version of the library (the value 16 will be allowed soon). The | ||
403 | default value is 15 if inflateInit is used instead. If a compressed stream | ||
404 | with a larger window size is given as input, inflate() will return with | ||
405 | the error code Z_DATA_ERROR instead of trying to allocate a larger window. | ||
406 | |||
407 | If next_out is not null, the library will use this buffer for the history | ||
408 | buffer; the buffer must either be large enough to hold the entire output | ||
409 | data, or have at least 1<<(windowBits-1) bytes. If next_out is null, the | ||
410 | library will allocate its own buffer (and leave next_out null). next_in | ||
411 | need not be provided here but must be provided by the application for the | ||
412 | next call of inflate(). | ||
413 | |||
414 | If the history buffer is provided by the application, next_out must | ||
415 | never be changed by the application since the decompressor maintains | ||
416 | history information inside this buffer from call to call; the application | ||
417 | can only reset next_out to the beginning of the history buffer when | ||
418 | avail_out is zero and all output has been consumed. | ||
419 | |||
420 | inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was | ||
421 | not enough memory, Z_STREAM_ERROR if the stream state was inconsistent | ||
422 | (such as zalloc being NULL) or the parameters are invalid (such as | ||
423 | windowBits < 9). msg is set to null if there is no error message. | ||
424 | inflateInit2 does not perform any compression: this will be done by | ||
425 | inflate(). | ||
426 | */ | ||
427 | |||
428 | extern int inflateSync __P((z_stream *strm)); | ||
429 | /* | ||
430 | Skips invalid compressed data until the special marker and a valid block | ||
431 | can be found, or until all available input is skipped. No output is provided. | ||
432 | |||
433 | inflateSync returns Z_OK if a valid block has been found, Z_BUF_ERROR if | ||
434 | no more input was provided, Z_DATA_ERROR if not valid block has been found, | ||
435 | Z_STREAM_ERROR if the stream structure was inconsistent. In the success | ||
436 | case, the application may save the current current value of total_in which | ||
437 | indicates where valid compressed data was found. In the error case, the | ||
438 | application may repeatedly call inflateSync, providing more input each time, | ||
439 | until success or end of the input data. | ||
440 | */ | ||
441 | |||
442 | extern int inflateReset __P((z_stream *strm)); | ||
443 | /* | ||
444 | This function is equivalent to inflateEnd followed by inflateInit, | ||
445 | but does not free and reallocate all the internal decompression state. | ||
446 | The stream will keep attributes that may have been set by inflateInit2. | ||
447 | |||
448 | inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source | ||
449 | stream state was inconsistent (such as zalloc or state being NULL). | ||
450 | */ | ||
451 | |||
452 | |||
453 | /* utility functions */ | ||
454 | |||
455 | /* | ||
456 | The following utility functions are implemented on top of the | ||
457 | basic stream-oriented functions. To simplify the interface, some | ||
458 | default options are assumed (compression level, window size, | ||
459 | standard memory allocation functions). The source code of these | ||
460 | utility functions can easily be modified if you need special options. | ||
461 | */ | ||
462 | |||
463 | extern int compress __P((Byte *dest, uLong *destLen, | ||
464 | Byte *source, uLong sourceLen)); | ||
465 | /* | ||
466 | Compresses the source buffer into the destination buffer. sourceLen is | ||
467 | the byte length of the source buffer. Upon entry, destLen is the total | ||
468 | size of the destination buffer, which must be at least 0.1% larger than | ||
469 | sourceLen plus 8 bytes. Upon exit, destLen is the actual size of the | ||
470 | compressed buffer. | ||
471 | This function can be used to compress a whole file at once if the | ||
472 | input file is mmap'ed. | ||
473 | compress returns Z_OK if success, Z_MEM_ERROR if there was not | ||
474 | enough memory, Z_BUF_ERROR if there was not enough room in the output | ||
475 | buffer. | ||
476 | */ | ||
477 | |||
478 | extern int uncompress __P((Byte *dest, uLong *destLen, | ||
479 | Byte *source, uLong sourceLen)); | ||
480 | /* | ||
481 | Decompresses the source buffer into the destination buffer. sourceLen is | ||
482 | the byte length of the source buffer. Upon entry, destLen is the total | ||
483 | size of the destination buffer, which must be large enough to hold the | ||
484 | entire uncompressed data. (The size of the uncompressed data must have | ||
485 | been saved previously by the compressor and transmitted to the decompressor | ||
486 | by some mechanism outside the scope of this compression library.) | ||
487 | Upon exit, destLen is the actual size of the compressed buffer. | ||
488 | This function can be used to decompress a whole file at once if the | ||
489 | input file is mmap'ed. | ||
490 | |||
491 | uncompress returns Z_OK if success, Z_MEM_ERROR if there was not | ||
492 | enough memory, Z_BUF_ERROR if there was not enough room in the output | ||
493 | buffer, or Z_DATA_ERROR if the input data was corrupted. | ||
494 | */ | ||
495 | |||
496 | |||
497 | typedef voidp gzFile; | ||
498 | |||
499 | extern gzFile gzopen __P((char *path, char *mode)); | ||
500 | /* | ||
501 | Opens a gzip (.gz) file for reading or writing. The mode parameter | ||
502 | is as in fopen ("rb" or "wb"). gzopen can also be used to read a file | ||
503 | which is not in gzip format; in this case gzread will directly read from | ||
504 | the file without decompression. | ||
505 | gzopen return NULL if the file could not be opened or if there was | ||
506 | insufficient memory to allocate the (de)compression state; errno | ||
507 | can be checked to distinguish the two cases (if errno is zero, the | ||
508 | zlib error is Z_MEM_ERROR). | ||
509 | */ | ||
510 | |||
511 | extern gzFile gzdopen __P((int fd, char *mode)); | ||
512 | /* | ||
513 | gzdopen() associates a gzFile with the file descriptor fd. File | ||
514 | descriptors are obtained from calls like open, dup, creat, or pipe. | ||
515 | The mode parameter is as in fopen ("rb" or "wb"). | ||
516 | gzdopen return NULL if there was insufficient memory to allocate | ||
517 | the (de)compression state. | ||
518 | */ | ||
519 | |||
520 | extern int gzread __P((gzFile file, voidp buf, unsigned len)); | ||
521 | /* | ||
522 | Reads the given number of uncompressed bytes from the compressed file. | ||
523 | If the input file was not in gzip format, gzread copies the given number | ||
524 | of bytes into the buffer. | ||
525 | gzread returns the number of uncompressed bytes actually read (0 for | ||
526 | end of file, -1 for error). */ | ||
527 | |||
528 | extern int gzwrite __P((gzFile file, voidp buf, unsigned len)); | ||
529 | /* | ||
530 | Writes the given number of uncompressed bytes into the compressed file. | ||
531 | gzwrite returns the number of uncompressed bytes actually written | ||
532 | (0 in case of error). | ||
533 | */ | ||
534 | |||
535 | extern int gzflush __P((gzFile file, int flush)); | ||
536 | /* | ||
537 | Flushes all pending output into the compressed file. The parameter | ||
538 | flush is as in the deflate() function. The return value is the zlib | ||
539 | error number (see function gzerror below). | ||
540 | gzflush should be called only when strictly necessary because it can | ||
541 | degrade compression. | ||
542 | */ | ||
543 | |||
544 | extern int gzclose __P((gzFile file)); | ||
545 | /* | ||
546 | Flushes all pending output if necessary, closes the compressed file | ||
547 | and deallocates all the (de)compression state. The return value is the zlib | ||
548 | error number (see function gzerror below). | ||
549 | */ | ||
550 | |||
551 | extern char* gzerror __P((gzFile file, int *errnum)); | ||
552 | /* | ||
553 | Returns the error message for the last error which occurred on the | ||
554 | given compressed file. errnum is set to zlib error number. If an | ||
555 | error occurred in the file system and not in the compression library, | ||
556 | errnum is set to Z_ERRNO and the application may consult errno | ||
557 | to get the exact error code. | ||
558 | */ | ||
559 | |||
560 | /* checksum functions */ | ||
561 | |||
562 | /* | ||
563 | These functions are not related to compression but are exported | ||
564 | anyway because they might be useful in applications using the | ||
565 | compression library. | ||
566 | */ | ||
567 | |||
568 | extern uLong adler32 __P((uLong adler, Byte *buf, uInt len)); | ||
569 | /* | ||
570 | Update a running Adler-32 checksum with the bytes buf[0..len-1] and | ||
571 | return the updated checksum. If buf is NULL, this function returns | ||
572 | the required initial value for the checksum. | ||
573 | An Adler-32 cheksum is almost as reliable as a CRC32 but can be computed | ||
574 | much faster. Usage example: | ||
575 | |||
576 | uLong adler = adler32(0L, Z_NULL, 0); | ||
577 | |||
578 | while (read_buffer(buffer, length) != EOF) { | ||
579 | adler = adler32(adler, buffer, length); | ||
580 | } | ||
581 | if (adler != original_adler) error(); | ||
582 | */ | ||
583 | |||
584 | extern uLong crc32 __P((uLong crc, Byte *buf, uInt len)); | ||
585 | /* | ||
586 | Update a running crc with the bytes buf[0..len-1] and return the updated | ||
587 | crc. If buf is NULL, this function returns the required initial value | ||
588 | for the crc (0). Pre- and post-conditioning (one's complement) is performed | ||
589 | within this function so it shouldn't be done by the application. | ||
590 | Usage example: | ||
591 | |||
592 | uLong crc = crc32(0L, Z_NULL, 0); | ||
593 | |||
594 | while (read_buffer(buffer, length) != EOF) { | ||
595 | crc = crc32(crc, buffer, length); | ||
596 | } | ||
597 | if (crc != original_crc) error(); | ||
598 | */ | ||
599 | |||
600 | #ifndef _Z_UTIL_H | ||
601 | struct internal_state {int dummy;}; /* hack for buggy compilers */ | ||
602 | #endif | ||
603 | |||
604 | #endif /* _ZLIB_H */ | ||