| Geant4 Cross Reference |
1 /* zlib.h -- interface of the 'zlib' general p 1
2 version 1.2.13, October 13th, 2022
3
4 Copyright (C) 1995-2022 Jean-loup Gailly and
5
6 This software is provided 'as-is', without a
7 warranty. In no event will the authors be h
8 arising from the use of this software.
9
10 Permission is granted to anyone to use this
11 including commercial applications, and to al
12 freely, subject to the following restriction
13
14 1. The origin of this software must not be m
15 claim that you wrote the original softwar
16 in a product, an acknowledgment in the pr
17 appreciated but is not required.
18 2. Altered source versions must be plainly m
19 misrepresented as being the original soft
20 3. This notice may not be removed or altered
21
22 Jean-loup Gailly Mark Adler
23 jloup@gzip.org madler@alumni.caltec
24
25
26 The data format used by the zlib library is
27 Comments) 1950 to 1952 in the files http://t
28 (zlib format), rfc1951 (deflate format) and
29 */
30
31 #ifndef ZLIB_H
32 #define ZLIB_H
33
34 #include "zconf.h"
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #define ZLIB_VERSION "1.2.13"
41 #define ZLIB_VERNUM 0x12d0
42 #define ZLIB_VER_MAJOR 1
43 #define ZLIB_VER_MINOR 2
44 #define ZLIB_VER_REVISION 13
45 #define ZLIB_VER_SUBREVISION 0
46
47 /*
48 The 'zlib' compression library provides in
49 decompression functions, including integrity
50 This version of the library supports only on
51 but other algorithms will be added later and
52 interface.
53
54 Compression can be done in a single step i
55 or can be done by repeated calls of the comp
56 case, the application must provide more inpu
57 (providing more output space) before each ca
58
59 The compressed data format used by default
60 the zlib format, which is a zlib wrapper doc
61 around a deflate stream, which is itself doc
62
63 The library also supports reading and writ
64 with an interface similar to that of stdio u
65 with "gz". The gzip format is different fro
66 gzip wrapper, documented in RFC 1952, wrappe
67
68 This library can optionally read and write
69 memory as well.
70
71 The zlib format was designed to be compact
72 and on communications channels. The gzip fo
73 file compression on file systems, has a larg
74 directory information, and uses a different,
75
76 The library does not install any signal ha
77 the consistency of the compressed data, so t
78 even in the case of corrupted input.
79 */
80
81 typedef voidpf (*alloc_func) OF((voidpf opaque
82 typedef void (*free_func) OF((voidpf opaque
83
84 struct internal_state;
85
86 typedef struct z_stream_s {
87 z_const Bytef *next_in; /* next input
88 uInt avail_in; /* number of bytes ava
89 uLong total_in; /* total number of inp
90
91 Bytef *next_out; /* next output byte wi
92 uInt avail_out; /* remaining free spac
93 uLong total_out; /* total number of byt
94
95 z_const char *msg; /* last error message,
96 struct internal_state FAR *state; /* not v
97
98 alloc_func zalloc; /* used to allocate th
99 free_func zfree; /* used to free the in
100 voidpf opaque; /* private data object
101
102 int data_type; /* best guess about th
103 for deflate, or the
104 uLong adler; /* Adler-32 or CRC-32
105 uLong reserved; /* reserved for future
106 } z_stream;
107
108 typedef z_stream FAR *z_streamp;
109
110 /*
111 gzip header information passed to and fro
112 for more details on the meanings of these fi
113 */
114 typedef struct gz_header_s {
115 int text; /* true if compressed
116 uLong time; /* modification time *
117 int xflags; /* extra flags (not us
118 int os; /* operating system */
119 Bytef *extra; /* pointer to extra fi
120 uInt extra_len; /* extra field length
121 uInt extra_max; /* space at extra (onl
122 Bytef *name; /* pointer to zero-ter
123 uInt name_max; /* space at name (only
124 Bytef *comment; /* pointer to zero-ter
125 uInt comm_max; /* space at comment (o
126 int hcrc; /* true if there was o
127 int done; /* true when done read
128 when writing a gzip
129 } gz_header;
130
131 typedef gz_header FAR *gz_headerp;
132
133 /*
134 The application must update next_in and a
135 to zero. It must update next_out and avail
136 to zero. The application must initialize z
137 calling the init function. All other field
138 library and must not be updated by the appl
139
140 The opaque value provided by the applicat
141 parameter for calls of zalloc and zfree. T
142 memory management. The compression library
143 opaque value.
144
145 zalloc must return Z_NULL if there is not
146 If zlib is used in a multi-threaded applica
147 thread safe. In that case, zlib is thread-
148 Z_NULL on entry to the initialization funct
149 routines that use the standard library func
150
151 On 16-bit systems, the functions zalloc a
152 exactly 65536 bytes, but will not be requir
153 the symbol MAXSEG_64K is defined (see zconf
154 returned by zalloc for objects of exactly 6
155 offset normalized to zero. The default all
156 library ensures this (see zutil.c). To red
157 any allocation of 64K objects, at the expen
158 the library with -DMAX_WBITS=14 (see zconf.
159
160 The fields total_in and total_out can be
161 reports. After compression, total_in holds
162 uncompressed data and may be saved for use
163 if the decompressor wants to decompress eve
164 */
165
166 /* constants */
167
168 #define Z_NO_FLUSH 0
169 #define Z_PARTIAL_FLUSH 1
170 #define Z_SYNC_FLUSH 2
171 #define Z_FULL_FLUSH 3
172 #define Z_FINISH 4
173 #define Z_BLOCK 5
174 #define Z_TREES 6
175 /* Allowed flush values; see deflate() and inf
176
177 #define Z_OK 0
178 #define Z_STREAM_END 1
179 #define Z_NEED_DICT 2
180 #define Z_ERRNO (-1)
181 #define Z_STREAM_ERROR (-2)
182 #define Z_DATA_ERROR (-3)
183 #define Z_MEM_ERROR (-4)
184 #define Z_BUF_ERROR (-5)
185 #define Z_VERSION_ERROR (-6)
186 /* Return codes for the compression/decompress
187 * are errors, positive values are used for sp
188 */
189
190 #define Z_NO_COMPRESSION 0
191 #define Z_BEST_SPEED 1
192 #define Z_BEST_COMPRESSION 9
193 #define Z_DEFAULT_COMPRESSION (-1)
194 /* compression levels */
195
196 #define Z_FILTERED 1
197 #define Z_HUFFMAN_ONLY 2
198 #define Z_RLE 3
199 #define Z_FIXED 4
200 #define Z_DEFAULT_STRATEGY 0
201 /* compression strategy; see deflateInit2() be
202
203 #define Z_BINARY 0
204 #define Z_TEXT 1
205 #define Z_ASCII Z_TEXT /* for compatibili
206 #define Z_UNKNOWN 2
207 /* Possible values of the data_type field for
208
209 #define Z_DEFLATED 8
210 /* The deflate compression method (the only on
211
212 #define Z_NULL 0 /* for initializing zalloc,
213
214 #define zlib_version zlibVersion()
215 /* for compatibility with versions < 1.0.2 */
216
217
218 /* basic functions */
219
220 ZEXTERN const char * ZEXPORT zlibVersion OF((v
221 /* The application can compare zlibVersion and
222 If the first character differs, the library
223 compatible with the zlib.h header file used
224 is automatically made by deflateInit and in
225 */
226
227 /*
228 ZEXTERN int ZEXPORT deflateInit OF((z_streamp
229
230 Initializes the internal stream state for
231 zalloc, zfree and opaque must be initialize
232 zalloc and zfree are set to Z_NULL, deflate
233 allocation functions.
234
235 The compression level must be Z_DEFAULT_C
236 1 gives best speed, 9 gives best compressio
237 (the input data is simply copied a block at
238 requests a default compromise between speed
239 equivalent to level 6).
240
241 deflateInit returns Z_OK if success, Z_ME
242 memory, Z_STREAM_ERROR if level is not a va
243 Z_VERSION_ERROR if the zlib library version
244 with the version assumed by the caller (ZLI
245 if there is no error message. deflateInit
246 this will be done by deflate().
247 */
248
249
250 ZEXTERN int ZEXPORT deflate OF((z_streamp strm
251 /*
252 deflate compresses as much data as possibl
253 buffer becomes empty or the output buffer be
254 some output latency (reading input without p
255 forced to flush.
256
257 The detailed semantics are as follows. de
258 following actions:
259
260 - Compress more input starting at next_in an
261 accordingly. If not all input can be proc
262 enough room in the output buffer), next_in
263 processing will resume at this point for t
264
265 - Generate more output starting at next_out
266 accordingly. This action is forced if the
267 Forcing flush frequently degrades the comp
268 should be set only when necessary. Some o
269 flush is zero.
270
271 Before the call of deflate(), the applicat
272 one of the actions is possible, by providing
273 output, and updating avail_in or avail_out a
274 never be zero before the call. The applicat
275 output when it wants, for example when the o
276 == 0), or after each call of deflate(). If
277 zero avail_out, it must be called again afte
278 buffer because there might be more output pe
279 which can be used if desired to determine wh
280 in that case.
281
282 Normally the parameter flush is set to Z_N
283 decide how much data to accumulate before pr
284 maximize compression.
285
286 If the parameter flush is set to Z_SYNC_FL
287 flushed to the output buffer and the output
288 that the decompressor can get all input data
289 particular avail_in is zero after the call i
290 provided before the call.) Flushing may degr
291 compression algorithms and so it should be u
292 completes the current deflate block and foll
293 that is three bits plus filler bits to the n
294 (00 00 ff ff).
295
296 If flush is set to Z_PARTIAL_FLUSH, all pe
297 output buffer, but the output is not aligned
298 input data so far will be available to the d
299 This completes the current deflate block and
300 codes block that is 10 bits long. This assu
301 in order for the decompressor to finish the
302 codes block.
303
304 If flush is set to Z_BLOCK, a deflate bloc
305 for Z_SYNC_FLUSH, but the output is not alig
306 seven bits of the current block are held to
307 the next deflate block is completed. In thi
308 be provided enough bits at this point in ord
309 the data provided so far to the compressor.
310 block to be emitted. This is for advanced a
311 the emission of deflate blocks.
312
313 If flush is set to Z_FULL_FLUSH, all outpu
314 Z_SYNC_FLUSH, and the compression state is r
315 restart from this point if previous compress
316 random access is desired. Using Z_FULL_FLUS
317 compression.
318
319 If deflate returns with avail_out == 0, th
320 with the same value of the flush parameter a
321 avail_out), until the flush is complete (def
322 avail_out). In the case of a Z_FULL_FLUSH o
323 avail_out is greater than six to avoid repea
324 avail_out == 0 on return.
325
326 If the parameter flush is set to Z_FINISH,
327 pending output is flushed and deflate return
328 enough output space. If deflate returns wit
329 function must be called again with Z_FINISH
330 avail_out) but no more input data, until it
331 error. After deflate has returned Z_STREAM_
332 on the stream are deflateReset or deflateEnd
333
334 Z_FINISH can be used in the first deflate
335 compression is to be done in a single step.
336 call, avail_out must be at least the value r
337 below). Then deflate is guaranteed to retur
338 output space is provided, deflate will not r
339 be called again as described above.
340
341 deflate() sets strm->adler to the Adler-32
342 so far (that is, total_in bytes). If a gzip
343 strm->adler will be the CRC-32 checksum of t
344 deflateInit2 below.)
345
346 deflate() may update strm->data_type if it
347 the input data type (Z_BINARY or Z_TEXT). I
348 considered binary. This field is only for i
349 affect the compression algorithm in any mann
350
351 deflate() returns Z_OK if some progress ha
352 processed or more output produced), Z_STREAM
353 consumed and all output has been produced (o
354 Z_FINISH), Z_STREAM_ERROR if the stream stat
355 if next_in or next_out was Z_NULL or the sta
356 by the application), or Z_BUF_ERROR if no pr
357 avail_in or avail_out was zero). Note that
358 deflate() can be called again with more inpu
359 continue compressing.
360 */
361
362
363 ZEXTERN int ZEXPORT deflateEnd OF((z_streamp s
364 /*
365 All dynamically allocated data structures
366 This function discards any unprocessed inpu
367 output.
368
369 deflateEnd returns Z_OK if success, Z_STR
370 stream state was inconsistent, Z_DATA_ERROR
371 prematurely (some input or output was disca
372 may be set but then points to a static stri
373 deallocated).
374 */
375
376
377 /*
378 ZEXTERN int ZEXPORT inflateInit OF((z_streamp
379
380 Initializes the internal stream state for
381 next_in, avail_in, zalloc, zfree and opaque
382 the caller. In the current version of infl
383 read or consumed. The allocation of a slid
384 the first call of inflate (if the decompres
385 first call). If zalloc and zfree are set t
386 them to use default allocation functions.
387
388 inflateInit returns Z_OK if success, Z_ME
389 memory, Z_VERSION_ERROR if the zlib library
390 version assumed by the caller, or Z_STREAM_
391 invalid, such as a null pointer to the stru
392 there is no error message. inflateInit doe
393 Actual decompression will be done by inflat
394 next_out, and avail_out are unused and unch
395 implementation of inflateInit() does not pr
396 that is deferred until inflate() is called.
397 */
398
399
400 ZEXTERN int ZEXPORT inflate OF((z_streamp strm
401 /*
402 inflate decompresses as much data as possi
403 buffer becomes empty or the output buffer be
404 some output latency (reading input without p
405 forced to flush.
406
407 The detailed semantics are as follows. infl
408 following actions:
409
410 - Decompress more input starting at next_in
411 accordingly. If not all input can be proc
412 enough room in the output buffer), then ne
413 accordingly, and processing will resume at
414 inflate().
415
416 - Generate more output starting at next_out
417 accordingly. inflate() provides as much o
418 no more input data or no more space in the
419 the flush parameter).
420
421 Before the call of inflate(), the applicat
422 one of the actions is possible, by providing
423 output, and updating the next_* and avail_*
424 caller of inflate() does not provide both av
425 output space, it is possible that there will
426 application can consume the uncompressed out
427 when the output buffer is full (avail_out ==
428 inflate(). If inflate returns Z_OK and with
429 called again after making room in the output
430 more output pending.
431
432 The flush parameter of inflate() can be Z_
433 Z_BLOCK, or Z_TREES. Z_SYNC_FLUSH requests
434 output as possible to the output buffer. Z_
435 stop if and when it gets to the next deflate
436 the zlib or gzip format, this will cause inf
437 after the header and before the first block.
438 inflate() will go ahead and process the firs
439 gets to the end of that block, or when it ru
440
441 The Z_BLOCK option assists in appending to
442 To assist in this, on return inflate() alway
443 number of unused bits in the last byte taken
444 inflate() is currently decoding the last blo
445 128 if inflate() returned immediately after
446 decoding the complete header up to just befo
447 stream. The end-of-block will not be indica
448 data from that block has been written to str
449 unused bits may in general be greater than s
450 data_type is set, in which case the number o
451 eight. data_type is set as noted here every
452 flush options, and so can be used to determi
453 consumed input in bits.
454
455 The Z_TREES option behaves as Z_BLOCK does
456 end of each deflate block header is reached,
457 block is decoded. This allows the caller to
458 deflate block header for later use in random
459 256 is added to the value of strm->data_type
460 immediately after reaching the end of the de
461
462 inflate() should normally be called until
463 error. However if all decompression is to b
464 single call of inflate), the parameter flush
465 this case all pending input is processed and
466 avail_out must be large enough to hold all o
467 operation to complete. (The size of the unc
468 saved by the compressor for this purpose.)
469 required to perform an inflation in one step
470 inform inflate that a faster approach can be
471 call. Z_FINISH also informs inflate to not
472 stream completes, which reduces inflate's me
473 does not complete, either because not all of
474 enough output space is provided, then a slid
475 inflate() can be called again to continue th
476 been used.
477
478 In this implementation, inflate() always
479 possible to the output buffer, and always us
480 first call. So the effects of the flush par
481 on the return value of inflate() as noted be
482 when Z_BLOCK or Z_TREES is used, and when in
483 memory for a sliding window when Z_FINISH is
484
485 If a preset dictionary is needed after th
486 below), inflate sets strm->adler to the Adle
487 chosen by the compressor and returns Z_NEED_
488 strm->adler to the Adler-32 checksum of all
489 total_out bytes) and returns Z_OK, Z_STREAM_
490 below. At the end of the stream, inflate()
491 checksum is equal to that saved by the compr
492 only if the checksum is correct.
493
494 inflate() can decompress and check either
495 deflate data. The header type is detected a
496 initializing with inflateInit2(). Any infor
497 header is not retained unless inflateGetHead
498 gzip-wrapped deflate data, strm->adler32 is
499 produced so far. The CRC-32 is checked agai
500 uncompressed length, modulo 2^32.
501
502 inflate() returns Z_OK if some progress ha
503 or more output produced), Z_STREAM_END if th
504 been reached and all uncompressed output has
505 preset dictionary is needed at this point, Z
506 corrupted (input stream not conforming to th
507 value, in which case strm->msg points to a s
508 error), Z_STREAM_ERROR if the stream structu
509 next_in or next_out was Z_NULL, or the state
510 by the application), Z_MEM_ERROR if there wa
511 if no progress was possible or if there was
512 buffer when Z_FINISH is used. Note that Z_B
513 inflate() can be called again with more inpu
514 continue decompressing. If Z_DATA_ERROR is
515 then call inflateSync() to look for a good c
516 recovery of the data is to be attempted.
517 */
518
519
520 ZEXTERN int ZEXPORT inflateEnd OF((z_streamp s
521 /*
522 All dynamically allocated data structures
523 This function discards any unprocessed inpu
524 output.
525
526 inflateEnd returns Z_OK if success, or Z_
527 was inconsistent.
528 */
529
530
531 /* Advanced functions
532
533 /*
534 The following functions are needed only in
535 */
536
537 /*
538 ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp
539 int leve
540 int meth
541 int wind
542 int memL
543 int stra
544
545 This is another version of deflateInit wi
546 fields zalloc, zfree and opaque must be ini
547
548 The method parameter is the compression m
549 this version of the library.
550
551 The windowBits parameter is the base two
552 (the size of the history buffer). It shoul
553 version of the library. Larger values of t
554 compression at the expense of memory usage.
555 deflateInit is used instead.
556
557 For the current implementation of deflate
558 window size of 256 bytes) is not supported.
559 will result in 9 (a 512-byte window). In t
560 inflateInit2() will result in an error when
561 checked against the initialization of infla
562 with deflateInit2() with this initializatio
563 with inflateInit2().
564
565 windowBits can also be -8..-15 for raw de
566 determines the window size. deflate() will
567 with no zlib header or trailer, and will no
568
569 windowBits can also be greater than 15 fo
570 16 to windowBits to write a simple gzip hea
571 compressed data instead of a zlib wrapper.
572 file name, no extra data, no comment, no mo
573 header crc, and the operating system will b
574 if the operating system was determined at c
575 being written, strm->adler is a CRC-32 inst
576
577 For raw deflate or gzip encoding, a reque
578 rejected as invalid, since only the zlib he
579 transmitting the window size to the decompr
580
581 The memLevel parameter specifies how much
582 for the internal compression state. memLev
583 slow and reduces compression ratio; memLeve
584 optimal speed. The default value is 8. Se
585 as a function of windowBits and memLevel.
586
587 The strategy parameter is used to tune th
588 value Z_DEFAULT_STRATEGY for normal data, Z
589 filter (or predictor), Z_HUFFMAN_ONLY to fo
590 string match), or Z_RLE to limit match dist
591 encoding). Filtered data consists mostly o
592 random distribution. In this case, the com
593 compress them better. The effect of Z_FILT
594 coding and less string matching; it is some
595 Z_DEFAULT_STRATEGY and Z_HUFFMAN_ONLY. Z_R
596 fast as Z_HUFFMAN_ONLY, but give better com
597 strategy parameter only affects the compres
598 correctness of the compressed output even i
599 Z_FIXED prevents the use of dynamic Huffman
600 decoder for special applications.
601
602 deflateInit2 returns Z_OK if success, Z_M
603 memory, Z_STREAM_ERROR if any parameter is
604 method), or Z_VERSION_ERROR if the zlib lib
605 incompatible with the version assumed by th
606 set to null if there is no error message.
607 compression: this will be done by deflate()
608 */
609
610 ZEXTERN int ZEXPORT deflateSetDictionary OF((z
611 c
612 u
613 /*
614 Initializes the compression dictionary fr
615 without producing any compressed output. W
616 function must be called immediately after d
617 deflateReset, and before any call of deflat
618 function must be called either before any c
619 after the completion of a deflate block, i.
620 consumed and all output has been delivered
621 options Z_BLOCK, Z_PARTIAL_FLUSH, Z_SYNC_FL
622 compressor and decompressor must use exactl
623 inflateSetDictionary).
624
625 The dictionary should consist of strings
626 to be encountered later in the data to be c
627 used strings preferably put towards the end
628 dictionary is most useful when the data to
629 predicted with good accuracy; the data can
630 with the default empty dictionary.
631
632 Depending on the size of the compression
633 deflateInit or deflateInit2, a part of the
634 discarded, for example if the dictionary is
635 provided in deflateInit or deflateInit2. T
636 useful should be put at the end of the dict
637 addition, the current implementation of def
638 size minus 262 bytes of the provided dictio
639
640 Upon return of this function, strm->adler
641 of the dictionary; the decompressor may lat
642 which dictionary has been used by the compr
643 applies to the whole dictionary even if onl
644 actually used by the compressor.) If a raw
645 Adler-32 value is not computed and strm->ad
646
647 deflateSetDictionary returns Z_OK if succ
648 parameter is invalid (e.g. dictionary bein
649 inconsistent (for example if deflate has al
650 or if not at a block boundary for raw defla
651 not perform any compression: this will be d
652 */
653
654 ZEXTERN int ZEXPORT deflateGetDictionary OF((z
655 B
656 u
657 /*
658 Returns the sliding dictionary being main
659 set to the number of bytes in the dictionar
660 to dictionary. dictionary must have enough
661 always enough. If deflateGetDictionary() i
662 Z_NULL, then only the dictionary length is
663 Similarly, if dictLength is Z_NULL, then it
664
665 deflateGetDictionary() may return a lengt
666 when more than the window size in input has
667 to 258 bytes less in that case, due to how
668 manages the sliding window and lookahead fo
669 up to 258 bytes long. If the application ne
670 input, then that would need to be saved by
671
672 deflateGetDictionary returns Z_OK on succ
673 stream state is inconsistent.
674 */
675
676 ZEXTERN int ZEXPORT deflateCopy OF((z_streamp
677 z_streamp
678 /*
679 Sets the destination stream as a complete
680
681 This function can be useful when several
682 tried, for example when there are several w
683 data with a filter. The streams that will
684 by calling deflateEnd. Note that deflateCo
685 compression state which can be quite large,
686 consume lots of memory.
687
688 deflateCopy returns Z_OK if success, Z_ME
689 enough memory, Z_STREAM_ERROR if the source
690 (such as zalloc being Z_NULL). msg is left
691 destination.
692 */
693
694 ZEXTERN int ZEXPORT deflateReset OF((z_streamp
695 /*
696 This function is equivalent to deflateEnd
697 does not free and reallocate the internal c
698 will leave the compression level and any ot
699 set unchanged.
700
701 deflateReset returns Z_OK if success, or
702 stream state was inconsistent (such as zall
703 */
704
705 ZEXTERN int ZEXPORT deflateParams OF((z_stream
706 int leve
707 int stra
708 /*
709 Dynamically update the compression level
710 interpretation of level and strategy is as
711 used to switch between compression and stra
712 to switch to a different kind of input data
713 If the compression approach (which is a fun
714 strategy is changed, and if there have been
715 state was initialized or reset, then the in
716 compressed with the old level and strategy
717 There are three approaches for the compress
718 respectively. The new level and strategy w
719 of deflate().
720
721 If a deflate(strm, Z_BLOCK) is performed
722 not have enough output space to complete, t
723 take effect. In this case, deflateParams()
724 same parameters and more output space to tr
725
726 In order to assure a change in the parame
727 deflate stream should be flushed using defl
728 request until strm.avail_out is not zero, b
729 Then no more input data should be provided
730 If this is done, the old level and strategy
731 compressed before deflateParams(), and the
732 applied to the the data compressed after de
733
734 deflateParams returns Z_OK on success, Z_
735 state was inconsistent or if a parameter wa
736 there was not enough output space to comple
737 available input data before a change in the
738 in the case of a Z_BUF_ERROR, the parameter
739 value of Z_BUF_ERROR is not fatal, in which
740 retried with more output space.
741 */
742
743 ZEXTERN int ZEXPORT deflateTune OF((z_streamp
744 int good_l
745 int max_la
746 int nice_l
747 int max_ch
748 /*
749 Fine tune deflate's internal compression
750 used by someone who understands the algorit
751 searching for the best matching string, and
752 fanatic optimizer trying to squeeze out the
753 specific input data. Read the deflate.c so
754 max_lazy, good_length, nice_length, and max
755
756 deflateTune() can be called after deflate
757 returns Z_OK on success, or Z_STREAM_ERROR
758 */
759
760 ZEXTERN uLong ZEXPORT deflateBound OF((z_strea
761 uLong s
762 /*
763 deflateBound() returns an upper bound on
764 deflation of sourceLen bytes. It must be c
765 deflateInit2(), and after deflateSetHeader(
766 to allocate an output buffer for deflation
767 called before deflate(). If that first def
768 sourceLen input bytes, an output buffer all
769 deflateBound(), and the flush value Z_FINIS
770 to return Z_STREAM_END. Note that it is po
771 be larger than the value returned by deflat
772 than Z_FINISH or Z_NO_FLUSH are used.
773 */
774
775 ZEXTERN int ZEXPORT deflatePending OF((z_strea
776 unsigne
777 int *bi
778 /*
779 deflatePending() returns the number of by
780 been generated, but not yet provided in the
781 provided would be due to the available outp
782 The number of bits of output not provided a
783 await more bits to join them in order to fi
784 or bits are Z_NULL, then those values are n
785
786 deflatePending returns Z_OK if success, o
787 stream state was inconsistent.
788 */
789
790 ZEXTERN int ZEXPORT deflatePrime OF((z_streamp
791 int bits,
792 int value
793 /*
794 deflatePrime() inserts bits in the deflat
795 is that this function is used to start off
796 leftover from a previous deflate stream whe
797 function can only be used for raw deflate,
798 deflate() call after a deflateInit2() or de
799 than or equal to 16, and that many of the l
800 will be inserted in the output.
801
802 deflatePrime returns Z_OK if success, Z_B
803 room in the internal buffer to insert the b
804 source stream state was inconsistent.
805 */
806
807 ZEXTERN int ZEXPORT deflateSetHeader OF((z_str
808 gz_he
809 /*
810 deflateSetHeader() provides gzip header i
811 stream is requested by deflateInit2(). def
812 after deflateInit2() or deflateReset() and
813 deflate(). The text, time, os, extra field
814 in the provided gz_header structure are wri
815 ignored -- the extra flags are set accordin
816 caller must assure that, if not Z_NULL, nam
817 a zero byte, and that if extra is not Z_NUL
818 available there. If hcrc is true, a gzip h
819 the current versions of the command-line ve
820 1.3.x) do not support header crc's, and wil
821 gzip file" and give up.
822
823 If deflateSetHeader is not used, the defa
824 the time set to zero, and os set to 255, wi
825 fields. The gzip header is returned to the
826
827 deflateSetHeader returns Z_OK if success,
828 stream state was inconsistent.
829 */
830
831 /*
832 ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp
833 int wind
834
835 This is another version of inflateInit wi
836 fields next_in, avail_in, zalloc, zfree and
837 before by the caller.
838
839 The windowBits parameter is the base two
840 size (the size of the history buffer). It
841 this version of the library. The default v
842 instead. windowBits must be greater than o
843 provided to deflateInit2() while compressin
844 deflateInit2() was not used. If a compress
845 size is given as input, inflate() will retu
846 Z_DATA_ERROR instead of trying to allocate
847
848 windowBits can also be zero to request th
849 the zlib header of the compressed stream.
850
851 windowBits can also be -8..-15 for raw in
852 determines the window size. inflate() will
853 not looking for a zlib or gzip header, not
854 looking for any check values for comparison
855 is for use with other formats that use the
856 such as zip. Those formats provide their o
857 format is developed using the raw deflate f
858 recommended that a check value such as an A
859 the uncompressed data as is done in the zli
860 most applications, the zlib format should b
861 above on the use in deflateInit2() applies
862
863 windowBits can also be greater than 15 fo
864 32 to windowBits to enable zlib and gzip de
865 detection, or add 16 to decode only the gzi
866 return a Z_DATA_ERROR). If a gzip stream i
867 CRC-32 instead of an Adler-32. Unlike the
868 below), inflate() will *not* automatically
869 inflate() will return Z_STREAM_END at the e
870 would need to be reset to continue decoding
871 *must* be done if there is more data after
872 decompression to be compliant with the gzip
873
874 inflateInit2 returns Z_OK if success, Z_M
875 memory, Z_VERSION_ERROR if the zlib library
876 version assumed by the caller, or Z_STREAM_
877 invalid, such as a null pointer to the stru
878 there is no error message. inflateInit2 do
879 apart from possibly reading the zlib header
880 will be done by inflate(). (So next_in and
881 next_out and avail_out are unused and uncha
882 of inflateInit2() does not process any head
883 deferred until inflate() is called.
884 */
885
886 ZEXTERN int ZEXPORT inflateSetDictionary OF((z
887 c
888 u
889 /*
890 Initializes the decompression dictionary
891 sequence. This function must be called imm
892 if that call returned Z_NEED_DICT. The dic
893 can be determined from the Adler-32 value r
894 The compressor and decompressor must use ex
895 deflateSetDictionary). For raw inflate, th
896 time to set the dictionary. If the provide
897 window and there is already data in the win
898 will amend what's there. The application m
899 that was used for compression is provided.
900
901 inflateSetDictionary returns Z_OK if succ
902 parameter is invalid (e.g. dictionary bein
903 inconsistent, Z_DATA_ERROR if the given dic
904 expected one (incorrect Adler-32 value). i
905 perform any decompression: this will be don
906 inflate().
907 */
908
909 ZEXTERN int ZEXPORT inflateGetDictionary OF((z
910 B
911 u
912 /*
913 Returns the sliding dictionary being main
914 set to the number of bytes in the dictionar
915 to dictionary. dictionary must have enough
916 always enough. If inflateGetDictionary() i
917 Z_NULL, then only the dictionary length is
918 Similarly, if dictLength is Z_NULL, then it
919
920 inflateGetDictionary returns Z_OK on succ
921 stream state is inconsistent.
922 */
923
924 ZEXTERN int ZEXPORT inflateSync OF((z_streamp
925 /*
926 Skips invalid compressed data until a pos
927 for the description of deflate with Z_FULL_
928 available input is skipped. No output is p
929
930 inflateSync searches for a 00 00 FF FF pa
931 All full flush points have this pattern, bu
932 pattern are full flush points.
933
934 inflateSync returns Z_OK if a possible fu
935 Z_BUF_ERROR if no more input was provided,
936 has been found, or Z_STREAM_ERROR if the st
937 In the success case, the application may sa
938 total_in which indicates where valid compre
939 error case, the application may repeatedly
940 input each time, until success or end of th
941 */
942
943 ZEXTERN int ZEXPORT inflateCopy OF((z_streamp
944 z_streamp
945 /*
946 Sets the destination stream as a complete
947
948 This function can be useful when randomly
949 first pass through the stream can periodica
950 allowing restarting inflate at those points
951 stream.
952
953 inflateCopy returns Z_OK if success, Z_ME
954 enough memory, Z_STREAM_ERROR if the source
955 (such as zalloc being Z_NULL). msg is left
956 destination.
957 */
958
959 ZEXTERN int ZEXPORT inflateReset OF((z_streamp
960 /*
961 This function is equivalent to inflateEnd
962 but does not free and reallocate the intern
963 stream will keep attributes that may have b
964
965 inflateReset returns Z_OK if success, or
966 stream state was inconsistent (such as zall
967 */
968
969 ZEXTERN int ZEXPORT inflateReset2 OF((z_stream
970 int wind
971 /*
972 This function is the same as inflateReset
973 the wrap and window size requests. The win
974 the same as it is for inflateInit2. If the
975 memory allocated for the window is freed, a
976 by inflate() if needed.
977
978 inflateReset2 returns Z_OK if success, or
979 stream state was inconsistent (such as zall
980 the windowBits parameter is invalid.
981 */
982
983 ZEXTERN int ZEXPORT inflatePrime OF((z_streamp
984 int bits,
985 int value
986 /*
987 This function inserts bits in the inflate
988 that this function is used to start inflati
989 middle of a byte. The provided bits will b
990 from next_in. This function should only be
991 should be used before the first inflate() c
992 inflateReset(). bits must be less than or
993 least significant bits of value will be ins
994
995 If bits is negative, then the input strea
996 inflatePrime() can be called again to put b
997 to clear out bits leftover after feeding in
998 to feeding inflate codes.
999
1000 inflatePrime returns Z_OK if success, or
1001 stream state was inconsistent.
1002 */
1003
1004 ZEXTERN long ZEXPORT inflateMark OF((z_stream
1005 /*
1006 This function returns two values, one in
1007 value, and the other in the remaining uppe
1008 return value down 16 bits. If the upper v
1009 zero, then inflate() is currently decoding
1010 If the upper value is -1 and the lower val
1011 the middle of a stored block, with the low
1012 bytes from the input remaining to copy. I
1013 it is the number of bits back from the cur
1014 the code (literal or length/distance pair)
1015 that case the lower value is the number of
1016 code.
1017
1018 A code is being processed if inflate is
1019 decoding of the code, or if it has complet
1020 more output space to write the literal or
1021
1022 inflateMark() is used to mark locations
1023 access, which may be at bit positions, and
1024 output of a code may span boundaries of ra
1025 location in the input stream can be determ
1026 as noted in the description for the Z_BLOC
1027
1028 inflateMark returns the value noted abov
1029 source stream state was inconsistent.
1030 */
1031
1032 ZEXTERN int ZEXPORT inflateGetHeader OF((z_st
1033 gz_h
1034 /*
1035 inflateGetHeader() requests that gzip he
1036 provided gz_header structure. inflateGetH
1037 inflateInit2() or inflateReset(), and befo
1038 As inflate() processes the gzip stream, he
1039 is completed, at which time head->done is
1040 being decoded, then head->done is set to -
1041 no gzip header information forthcoming. N
1042 used to force inflate() to return immediat
1043 complete and before any actual data is dec
1044
1045 The text, time, xflags, and os fields ar
1046 contents. hcrc is set to true if there is
1047 was valid if done is set to one.) If extra
1048 contains the maximum number of bytes to wr
1049 extra_len contains the actual extra field
1050 extra field, or that field truncated if ex
1051 If name is not Z_NULL, then up to name_max
1052 terminated with a zero unless the length i
1053 comment is not Z_NULL, then up to comm_max
1054 terminated with a zero unless the length i
1055 of extra, name, or comment are not Z_NULL
1056 present in the header, then that field is
1057 absence. This allows the use of deflateSe
1058 structure to duplicate the header. Howeve
1059 allocated memory, then the application wil
1060 elsewhere so that they can be eventually f
1061
1062 If inflateGetHeader is not used, then th
1063 discarded. The header is always checked f
1064 CRC if present. inflateReset() will reset
1065 information. The application would need t
1066 retrieve the header from the next gzip str
1067
1068 inflateGetHeader returns Z_OK if success
1069 stream state was inconsistent.
1070 */
1071
1072 /*
1073 ZEXTERN int ZEXPORT inflateBackInit OF((z_str
1074 unsig
1075
1076 Initialize the internal stream state for
1077 calls. The fields zalloc, zfree and opaqu
1078 before the call. If zalloc and zfree are
1079 derived memory allocation routines are use
1080 logarithm of the window size, in the range
1081 supplied buffer of that size. Except for
1082 assured that deflate was used with small w
1083 and a 32K byte window must be supplied to
1084 deflate streams.
1085
1086 See inflateBack() for the usage of these
1087
1088 inflateBackInit will return Z_OK on succ
1089 the parameters are invalid, Z_MEM_ERROR if
1090 allocated, or Z_VERSION_ERROR if the versi
1091 the version of the header file.
1092 */
1093
1094 typedef unsigned (*in_func) OF((void FAR *,
1095 z_const unsig
1096 typedef int (*out_func) OF((void FAR *, unsig
1097
1098 ZEXTERN int ZEXPORT inflateBack OF((z_streamp
1099 in_func i
1100 out_func
1101 /*
1102 inflateBack() does a raw inflate with a
1103 interface for input and output. This is p
1104 inflate() for file i/o applications, in th
1105 output and the sliding window by simply ma
1106 buffer. inflate() can be faster on modern
1107 buffers. inflateBack() trusts the applica
1108 buffer passed by the output function, at l
1109
1110 inflateBackInit() must be called first t
1111 and to initialize the state with the user-
1112 inflateBack() may then be used multiple ti
1113 deflate stream with each call. inflateBac
1114 allocated state.
1115
1116 A raw deflate stream is one with no zlib
1117 This routine would normally be used in a u
1118 files and writes out uncompressed files.
1119 header and process the trailer on its own,
1120 the raw deflate stream to decompress. Thi
1121 behavior of inflate(), which expects a zli
1122 deflate stream.
1123
1124 inflateBack() uses two subroutines suppl
1125 called by inflateBack() for input and outp
1126 routines until it reads a complete deflate
1127 uncompressed data, or until it encounters
1128 parameters and return types are defined ab
1129 typedefs. inflateBack() will call in(in_d
1130 number of bytes of provided input, and a p
1131 there is no input available, in() must ret
1132 case -- and inflateBack() will return a bu
1133 call out(out_desc, buf, len) to write the
1134 out() should return zero on success, or no
1135 returns non-zero, inflateBack() will retur
1136 out() are permitted to change the contents
1137 inflateBackInit(), which is also the buffe
1138 The length written by out() will be at mos
1139 amount of input may be provided by in().
1140
1141 For convenience, inflateBack() can be pr
1142 setting strm->next_in and strm->avail_in.
1143 in() will be called. Therefore strm->next
1144 calling inflateBack(). If strm->next_in i
1145 immediately for input. If strm->next_in i
1146 must also be initialized, and then if strm
1147 initially be taken from strm->next_in[0 ..
1148
1149 The in_desc and out_desc parameters of i
1150 first parameter of in() and out() respecti
1151 descriptors can be optionally used to pass
1152 supplied in() and out() functions need to
1153
1154 On return, inflateBack() will set strm->
1155 pass back any unused input that was provid
1156 return values of inflateBack() can be Z_ST
1157 if in() or out() returned an error, Z_DATA
1158 in the deflate stream (in which case strm-
1159 of the error), or Z_STREAM_ERROR if the st
1160 In the case of Z_BUF_ERROR, an input or ou
1161 using strm->next_in which will be Z_NULL o
1162 strm->next_in is not Z_NULL, then the Z_BU
1163 non-zero. (in() will always be called bef
1164 assured to be defined if out() returns non
1165 cannot return Z_OK.
1166 */
1167
1168 ZEXTERN int ZEXPORT inflateBackEnd OF((z_stre
1169 /*
1170 All memory allocated by inflateBackInit(
1171
1172 inflateBackEnd() returns Z_OK on success
1173 state was inconsistent.
1174 */
1175
1176 ZEXTERN uLong ZEXPORT zlibCompileFlags OF((vo
1177 /* Return flags indicating compile-time optio
1178
1179 Type sizes, two bits each, 00 = 16 bits,
1180 1.0: size of uInt
1181 3.2: size of uLong
1182 5.4: size of voidpf (pointer)
1183 7.6: size of z_off_t
1184
1185 Compiler, assembler, and debug options:
1186 8: ZLIB_DEBUG
1187 9: ASMV or ASMINF -- use ASM code
1188 10: ZLIB_WINAPI -- exported functions us
1189 11: 0 (reserved)
1190
1191 One-time table building (smaller code, bu
1192 12: BUILDFIXED -- build static block dec
1193 13: DYNAMIC_CRC_TABLE -- build CRC calcu
1194 14,15: 0 (reserved)
1195
1196 Library content (indicates missing functi
1197 16: NO_GZCOMPRESS -- gz* functions canno
1198 deflate code when n
1199 17: NO_GZIP -- deflate can't write gzip
1200 and decode gzip streams (
1201 18-19: 0 (reserved)
1202
1203 Operation variations (changes in library
1204 20: PKZIP_BUG_WORKAROUND -- slightly mor
1205 21: FASTEST -- deflate algorithm with on
1206 22,23: 0 (reserved)
1207
1208 The sprintf variant used by gzprintf (zer
1209 24: 0 = vs*, 1 = s* -- 1 means limited t
1210 25: 0 = *nprintf, 1 = *printf -- 1 means
1211 26: 0 = returns value, 1 = void -- 1 mea
1212
1213 Remainder:
1214 27-31: 0 (reserved)
1215 */
1216
1217 #ifndef Z_SOLO
1218
1219 /* utility functions
1220
1221 /*
1222 The following utility functions are impl
1223 stream-oriented functions. To simplify th
1224 are assumed (compression level and memory
1225 functions). The source code of these util
1226 you need special options.
1227 */
1228
1229 ZEXTERN int ZEXPORT compress OF((Bytef *dest,
1230 const Bytef
1231 /*
1232 Compresses the source buffer into the de
1233 the byte length of the source buffer. Upo
1234 of the destination buffer, which must be a
1235 compressBound(sourceLen). Upon exit, dest
1236 compressed data. compress() is equivalent
1237 parameter of Z_DEFAULT_COMPRESSION.
1238
1239 compress returns Z_OK if success, Z_MEM_
1240 enough memory, Z_BUF_ERROR if there was no
1241 buffer.
1242 */
1243
1244 ZEXTERN int ZEXPORT compress2 OF((Bytef *dest
1245 const Bytef
1246 int level))
1247 /*
1248 Compresses the source buffer into the de
1249 parameter has the same meaning as in defla
1250 length of the source buffer. Upon entry,
1251 destination buffer, which must be at least
1252 compressBound(sourceLen). Upon exit, dest
1253 compressed data.
1254
1255 compress2 returns Z_OK if success, Z_MEM
1256 memory, Z_BUF_ERROR if there was not enoug
1257 Z_STREAM_ERROR if the level parameter is i
1258 */
1259
1260 ZEXTERN uLong ZEXPORT compressBound OF((uLong
1261 /*
1262 compressBound() returns an upper bound o
1263 compress() or compress2() on sourceLen byt
1264 compress() or compress2() call to allocate
1265 */
1266
1267 ZEXTERN int ZEXPORT uncompress OF((Bytef *des
1268 const Byte
1269 /*
1270 Decompresses the source buffer into the
1271 the byte length of the source buffer. Upo
1272 of the destination buffer, which must be l
1273 uncompressed data. (The size of the uncom
1274 previously by the compressor and transmitt
1275 mechanism outside the scope of this compre
1276 is the actual size of the uncompressed dat
1277
1278 uncompress returns Z_OK if success, Z_ME
1279 enough memory, Z_BUF_ERROR if there was no
1280 buffer, or Z_DATA_ERROR if the input data
1281 the case where there is not enough room, u
1282 buffer with the uncompressed data up to th
1283 */
1284
1285 ZEXTERN int ZEXPORT uncompress2 OF((Bytef *de
1286 const Byt
1287 /*
1288 Same as uncompress, except that sourceLe
1289 length of the source is *sourceLen. On re
1290 source bytes consumed.
1291 */
1292
1293 /* gzip file access f
1294
1295 /*
1296 This library supports reading and writin
1297 an interface similar to that of stdio, usi
1298 "gz". The gzip format is different from t
1299 wrapper, documented in RFC 1952, wrapped a
1300 */
1301
1302 typedef struct gzFile_s *gzFile; /* semi-o
1303
1304 /*
1305 ZEXTERN gzFile ZEXPORT gzopen OF((const char
1306
1307 Open the gzip (.gz) file at path for rea
1308 compressing and writing. The mode paramet
1309 but can also include a compression level (
1310 filtered data as in "wb6f", 'h' for Huffma
1311 'R' for run-length encoding as in "wb1R",
1312 as in "wb9F". (See the description of def
1313 about the strategy parameter.) 'T' will r
1314 appending with no compression and not usin
1315
1316 "a" can be used instead of "w" to reques
1317 be written be appended to the file. "+" w
1318 reading and writing to the same gzip file
1319 "x" when writing will create the file excl
1320 already exists. On systems that support i
1321 reading or writing will set the flag to cl
1322
1323 These functions, as well as gzip, will r
1324 streams in a file. The append function of
1325 such a file. (Also see gzflush() for anot
1326 appending, gzopen does not test whether th
1327 nor does it look for the end of the gzip s
1328 will simply append a gzip stream to the ex
1329
1330 gzopen can be used to read a file which
1331 case gzread will directly read from the fi
1332 reading, this will be detected automatical
1333 byte gzip header.
1334
1335 gzopen returns NULL if the file could no
1336 insufficient memory to allocate the gzFile
1337 specified (an 'r', 'w', or 'a' was not pro
1338 errno can be checked to determine if the r
1339 file could not be opened.
1340 */
1341
1342 ZEXTERN gzFile ZEXPORT gzdopen OF((int fd, co
1343 /*
1344 Associate a gzFile with the file descrip
1345 obtained from calls like open, dup, creat,
1346 been previously opened with fopen). The m
1347
1348 The next call of gzclose on the returned
1349 descriptor fd, just like fclose(fdopen(fd,
1350 fd. If you want to keep fd open, use fd =
1351 mode);. The duplicated descriptor should
1352 gzdopen does not close fd if it fails. If
1353 file descriptor from a FILE *, then you wi
1354 double-close()ing the file descriptor. Bo
1355 close the associated file descriptor, so t
1356 descriptors.
1357
1358 gzdopen returns NULL if there was insuff
1359 gzFile state, if an invalid mode was speci
1360 provided, or '+' was provided), or if fd i
1361 used until the next gz* read, write, seek,
1362 will not detect if fd is invalid (unless f
1363 */
1364
1365 ZEXTERN int ZEXPORT gzbuffer OF((gzFile file,
1366 /*
1367 Set the internal buffer size used by thi
1368 size. The default buffer size is 8192 byt
1369 after gzopen() or gzdopen(), and before an
1370 the file. The buffer memory allocation is
1371 or write. Three times that size in buffer
1372 buffer size of, for example, 64K or 128K b
1373 speed of decompression (reading).
1374
1375 The new buffer size also affects the max
1376
1377 gzbuffer() returns 0 on success, or -1 o
1378 too late.
1379 */
1380
1381 ZEXTERN int ZEXPORT gzsetparams OF((gzFile fi
1382 /*
1383 Dynamically update the compression level
1384 description of deflateInit2 for the meanin
1385 provided data is flushed before applying t
1386
1387 gzsetparams returns Z_OK if success, Z_S
1388 opened for writing, Z_ERRNO if there is an
1389 or Z_MEM_ERROR if there is a memory alloca
1390 */
1391
1392 ZEXTERN int ZEXPORT gzread OF((gzFile file, v
1393 /*
1394 Read and decompress up to len uncompress
1395 the input file is not in gzip format, gzre
1396 bytes into the buffer directly from the fi
1397
1398 After reaching the end of a gzip stream
1399 to read, looking for another gzip stream.
1400 concatenated in the input file, and will a
1401 If something other than a gzip stream is e
1402 that remaining trailing garbage is ignored
1403
1404 gzread can be used to read a gzip file t
1405 Upon reaching the end of the input, gzread
1406 data. If the error code returned by gzerr
1407 gzclearerr can be used to clear the end of
1408 gzread to be tried again. Z_OK indicates
1409 on the last gzread. Z_BUF_ERROR indicates
1410 middle of a gzip stream. Note that gzread
1411 of an incomplete gzip stream. This error
1412 will return Z_BUF_ERROR if the last gzread
1413 stream. Alternatively, gzerror can be use
1414 case.
1415
1416 gzread returns the number of uncompresse
1417 len for end of file, or -1 for error. If
1418 then nothing is read, -1 is returned, and
1419 Z_STREAM_ERROR.
1420 */
1421
1422 ZEXTERN z_size_t ZEXPORT gzfread OF((voidp bu
1423 gzFile f
1424 /*
1425 Read and decompress up to nitems items o
1426 otherwise operating as gzread() does. Thi
1427 stdio's fread(), with size_t request and r
1428 defines size_t, then z_size_t is identical
1429 is an unsigned integer type that can conta
1430
1431 gzfread() returns the number of full ite
1432 the end of the file was reached and a full
1433 there was an error. gzerror() must be con
1434 order to determine if there was an error.
1435 nitems overflows, i.e. the product does no
1436 is read, zero is returned, and the error s
1437
1438 In the event that the end of file is rea
1439 available at the end, i.e. the remaining u
1440 multiple of size, then the final partial i
1441 and the end-of-file flag is set. The leng
1442 provided, but could be inferred from the r
1443 is the same as the behavior of fread() imp
1444 but it prevents the direct use of gzfread(
1445 file, resetting and retrying on end-of-fil
1446 */
1447
1448 ZEXTERN int ZEXPORT gzwrite OF((gzFile file,
1449 /*
1450 Compress and write the len uncompressed
1451 returns the number of uncompressed bytes w
1452 */
1453
1454 ZEXTERN z_size_t ZEXPORT gzfwrite OF((voidpc
1455 z_size_
1456 /*
1457 Compress and write nitems items of size
1458 the interface of stdio's fwrite(), with si
1459 the library defines size_t, then z_size_t
1460 then z_size_t is an unsigned integer type
1461
1462 gzfwrite() returns the number of full it
1463 if there was an error. If the multiplicat
1464 i.e. the product does not fit in a z_size_
1465 is returned, and the error state is set to
1466 */
1467
1468 ZEXTERN int ZEXPORTVA gzprintf Z_ARG((gzFile
1469 /*
1470 Convert, format, compress, and write the
1471 control of the string format, as in fprint
1472 uncompressed bytes actually written, or a
1473 of error. The number of uncompressed byte
1474 one less than the buffer size given to gzb
1475 that this limit is not exceeded. If it is
1476 return an error (0) with nothing written.
1477 buffer overflow with unpredictable consequ
1478 zlib was compiled with the insecure functi
1479 because the secure snprintf() or vsnprintf
1480 This can be determined using zlibCompileFl
1481 */
1482
1483 ZEXTERN int ZEXPORT gzputs OF((gzFile file, c
1484 /*
1485 Compress and write the given null-termin
1486 the terminating null character.
1487
1488 gzputs returns the number of characters
1489 */
1490
1491 ZEXTERN char * ZEXPORT gzgets OF((gzFile file
1492 /*
1493 Read and decompress bytes from file into
1494 read, or until a newline character is read
1495 end-of-file condition is encountered. If
1496 is one, the string is terminated with a nu
1497 are read due to an end-of-file or len is l
1498 left untouched.
1499
1500 gzgets returns buf which is a null-termi
1501 for end-of-file or in case of error. If t
1502 buf are indeterminate.
1503 */
1504
1505 ZEXTERN int ZEXPORT gzputc OF((gzFile file, i
1506 /*
1507 Compress and write c, converted to an un
1508 returns the value that was written, or -1
1509 */
1510
1511 ZEXTERN int ZEXPORT gzgetc OF((gzFile file));
1512 /*
1513 Read and decompress one byte from file.
1514 in case of end of file or error. This is
1515 As such, it does not do all of the checkin
1516 it does not check to see if file is NULL,
1517 points to has been clobbered or not.
1518 */
1519
1520 ZEXTERN int ZEXPORT gzungetc OF((int c, gzFil
1521 /*
1522 Push c back onto the stream for file to
1523 the next read. At least one character of
1524 gzungetc() returns the character pushed, o
1525 fail if c is -1, and may fail if a charact
1526 yet. If gzungetc is used immediately afte
1527 output buffer size of pushed characters is
1528 The pushed character will be discarded if
1529 gzseek() or gzrewind().
1530 */
1531
1532 ZEXTERN int ZEXPORT gzflush OF((gzFile file,
1533 /*
1534 Flush all pending output to file. The p
1535 deflate() function. The return value is t
1536 gzerror below). gzflush is only permitted
1537
1538 If the flush parameter is Z_FINISH, the
1539 gzip stream is completed in the output. I
1540 gzip stream will be started in the output.
1541 concatenated gzip streams.
1542
1543 gzflush should be called only when stric
1544 degrade compression if called too often.
1545 */
1546
1547 /*
1548 ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile fil
1549 z_off_t of
1550
1551 Set the starting position to offset rela
1552 or gzwrite on file. The offset represents
1553 uncompressed data stream. The whence para
1554 the value SEEK_END is not supported.
1555
1556 If the file is opened for reading, this
1557 extremely slow. If the file is opened for
1558 supported; gzseek then compresses a sequen
1559 starting position.
1560
1561 gzseek returns the resulting offset loca
1562 the beginning of the uncompressed stream,
1563 particular if the file is opened for writi
1564 would be before the current position.
1565 */
1566
1567 ZEXTERN int ZEXPORT gzrewind OF((gzFile fi
1568 /*
1569 Rewind file. This function is supported
1570
1571 gzrewind(file) is equivalent to (int)gzs
1572 */
1573
1574 /*
1575 ZEXTERN z_off_t ZEXPORT gztell OF((gzFile
1576
1577 Return the starting position for the nex
1578 This position represents a number of bytes
1579 and is zero when starting, even if appendi
1580 the middle of a file using gzdopen().
1581
1582 gztell(file) is equivalent to gzseek(fil
1583 */
1584
1585 /*
1586 ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile f
1587
1588 Return the current compressed (actual) r
1589 offset includes the count of bytes that pr
1590 when appending or when using gzdopen() for
1591 offset does not include as yet unused buff
1592 be used for a progress indicator. On erro
1593 */
1594
1595 ZEXTERN int ZEXPORT gzeof OF((gzFile file));
1596 /*
1597 Return true (1) if the end-of-file indic
1598 reading, false (0) otherwise. Note that t
1599 only if the read tried to go past the end
1600 Therefore, just like feof(), gzeof() may r
1601 more data to read, in the event that the l
1602 number of bytes remaining in the input fil
1603 file size is an exact multiple of the buff
1604
1605 If gzeof() returns true, then the read f
1606 unless the end-of-file indicator is reset
1607 has grown since the previous end of file w
1608 */
1609
1610 ZEXTERN int ZEXPORT gzdirect OF((gzFile file)
1611 /*
1612 Return true (1) if file is being copied
1613 (0) if file is a gzip stream being decompr
1614
1615 If the input file is empty, gzdirect() w
1616 does not contain a gzip stream.
1617
1618 If gzdirect() is used immediately after
1619 cause buffers to be allocated to allow rea
1620 is a gzip file. Therefore if gzbuffer() i
1621 gzdirect().
1622
1623 When writing, gzdirect() returns true (1
1624 requested ("wT" for the gzopen() mode), or
1625 gzdirect() is not needed when writing. Tr
1626 explicitly requested, so the application a
1627 linking statically, using gzdirect() will
1628 gzip file reading and decompression, which
1629 */
1630
1631 ZEXTERN int ZEXPORT gzclose OF((gzFile fil
1632 /*
1633 Flush all pending output for file, if ne
1634 deallocate the (de)compression state. Not
1635 cannot call gzerror with file, since its s
1636 gzclose must not be called more than once
1637 must not be called more than once on the s
1638
1639 gzclose will return Z_STREAM_ERROR if fi
1640 file operation error, Z_MEM_ERROR if out o
1641 last read ended in the middle of a gzip st
1642 */
1643
1644 ZEXTERN int ZEXPORT gzclose_r OF((gzFile file
1645 ZEXTERN int ZEXPORT gzclose_w OF((gzFile file
1646 /*
1647 Same as gzclose(), but gzclose_r() is on
1648 gzclose_w() is only for use when writing o
1649 using these instead of gzclose() is that t
1650 compression or decompression code that is
1651 writing respectively. If gzclose() is use
1652 decompression code will be included the ap
1653 zlib library.
1654 */
1655
1656 ZEXTERN const char * ZEXPORT gzerror OF((gzFi
1657 /*
1658 Return the error message for the last er
1659 errnum is set to zlib error number. If an
1660 and not in the compression library, errnum
1661 application may consult errno to get the e
1662
1663 The application must not modify the retu
1664 this function may invalidate the previousl
1665 closed, then the string previously returne
1666 available.
1667
1668 gzerror() should be used to distinguish
1669 functions above that do not distinguish th
1670 */
1671
1672 ZEXTERN void ZEXPORT gzclearerr OF((gzFile fi
1673 /*
1674 Clear the error and end-of-file flags fo
1675 clearerr() function in stdio. This is use
1676 file that is being written concurrently.
1677 */
1678
1679 #endif /* !Z_SOLO */
1680
1681 /* checksum functions
1682
1683 /*
1684 These functions are not related to compr
1685 anyway because they might be useful in app
1686 library.
1687 */
1688
1689 ZEXTERN uLong ZEXPORT adler32 OF((uLong adler
1690 /*
1691 Update a running Adler-32 checksum with
1692 return the updated checksum. An Adler-32 v
1693 unsigned integer. If buf is Z_NULL, this f
1694 initial value for the checksum.
1695
1696 An Adler-32 checksum is almost as reliab
1697 much faster.
1698
1699 Usage example:
1700
1701 uLong adler = adler32(0L, Z_NULL, 0);
1702
1703 while (read_buffer(buffer, length) != EO
1704 adler = adler32(adler, buffer, length)
1705 }
1706 if (adler != original_adler) error();
1707 */
1708
1709 ZEXTERN uLong ZEXPORT adler32_z OF((uLong adl
1710 z_size_t
1711 /*
1712 Same as adler32(), but with a size_t len
1713 */
1714
1715 /*
1716 ZEXTERN uLong ZEXPORT adler32_combine OF((uLo
1717 z_o
1718
1719 Combine two Adler-32 checksums into one.
1720 and seq2 with lengths len1 and len2, Adler
1721 each, adler1 and adler2. adler32_combine(
1722 seq1 and seq2 concatenated, requiring only
1723 that the z_off_t type (like off_t) is a si
1724 negative, the result has no meaning or uti
1725 */
1726
1727 ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, co
1728 /*
1729 Update a running CRC-32 with the bytes b
1730 updated CRC-32. A CRC-32 value is in the r
1731 If buf is Z_NULL, this function returns th
1732 crc. Pre- and post-conditioning (one's com
1733 function so it shouldn't be done by the ap
1734
1735 Usage example:
1736
1737 uLong crc = crc32(0L, Z_NULL, 0);
1738
1739 while (read_buffer(buffer, length) != EO
1740 crc = crc32(crc, buffer, length);
1741 }
1742 if (crc != original_crc) error();
1743 */
1744
1745 ZEXTERN uLong ZEXPORT crc32_z OF((uLong crc,
1746 z_size_t le
1747 /*
1748 Same as crc32(), but with a size_t lengt
1749 */
1750
1751 /*
1752 ZEXTERN uLong ZEXPORT crc32_combine OF((uLong
1753
1754 Combine two CRC-32 check values into one
1755 seq1 and seq2 with lengths len1 and len2,
1756 calculated for each, crc1 and crc2. crc32
1757 check value of seq1 and seq2 concatenated,
1758 len2.
1759 */
1760
1761 /*
1762 ZEXTERN uLong ZEXPORT crc32_combine_gen OF((z
1763
1764 Return the operator corresponding to len
1765 crc32_combine_op().
1766 */
1767
1768 ZEXTERN uLong ZEXPORT crc32_combine_op OF((uL
1769 /*
1770 Give the same result as crc32_combine(),
1771 is generated from len2 by crc32_combine_ge
1772 crc32_combine() if the generated op is use
1773 */
1774
1775
1776 /* various hacks, don
1777
1778 /* deflateInit and inflateInit are macros to
1779 * and the compiler's view of z_stream:
1780 */
1781 ZEXTERN int ZEXPORT deflateInit_ OF((z_stream
1782 const ch
1783 ZEXTERN int ZEXPORT inflateInit_ OF((z_stream
1784 const ch
1785 ZEXTERN int ZEXPORT deflateInit2_ OF((z_strea
1786 int win
1787 int str
1788 int str
1789 ZEXTERN int ZEXPORT inflateInit2_ OF((z_strea
1790 const c
1791 ZEXTERN int ZEXPORT inflateBackInit_ OF((z_st
1792 unsi
1793 cons
1794 int
1795 #ifdef Z_PREFIX_SET
1796 # define z_deflateInit(strm, level) \
1797 deflateInit_((strm), (level), ZLIB_
1798 # define z_inflateInit(strm) \
1799 inflateInit_((strm), ZLIB_VERSION,
1800 # define z_deflateInit2(strm, level, method,
1801 deflateInit2_((strm),(level),(metho
1802 (strategy), ZLIB_VERS
1803 # define z_inflateInit2(strm, windowBits) \
1804 inflateInit2_((strm), (windowBits),
1805 (int)sizeof(z_stream)
1806 # define z_inflateBackInit(strm, windowBits,
1807 inflateBackInit_((strm), (windowBit
1808 ZLIB_VERSION, (int
1809 #else
1810 # define deflateInit(strm, level) \
1811 deflateInit_((strm), (level), ZLIB_
1812 # define inflateInit(strm) \
1813 inflateInit_((strm), ZLIB_VERSION,
1814 # define deflateInit2(strm, level, method, w
1815 deflateInit2_((strm),(level),(metho
1816 (strategy), ZLIB_VERS
1817 # define inflateInit2(strm, windowBits) \
1818 inflateInit2_((strm), (windowBits),
1819 (int)sizeof(z_stream)
1820 # define inflateBackInit(strm, windowBits, w
1821 inflateBackInit_((strm), (windowBit
1822 ZLIB_VERSION, (int
1823 #endif
1824
1825 #ifndef Z_SOLO
1826
1827 /* gzgetc() macro and its supporting function
1828 * that the real internal state is much large
1829 * This abbreviated structure exposes just en
1830 * user should not mess with these exposed el
1831 * behavior could change in the future, perha
1832 * only be used by the gzgetc() macro. You h
1833 */
1834 struct gzFile_s {
1835 unsigned have;
1836 unsigned char *next;
1837 z_off64_t pos;
1838 };
1839 ZEXTERN int ZEXPORT gzgetc_ OF((gzFile file))
1840 #ifdef Z_PREFIX_SET
1841 # undef z_gzgetc
1842 # define z_gzgetc(g) \
1843 ((g)->have ? ((g)->have--, (g)->pos
1844 #else
1845 # define gzgetc(g) \
1846 ((g)->have ? ((g)->have--, (g)->pos
1847 #endif
1848
1849 /* provide 64-bit offset functions if _LARGEF
1850 * change the regular functions to 64 bits if
1851 * both are true, the application gets the *6
1852 * functions are changed to 64 bits) -- in ca
1853 * without large file support, _LFS64_LARGEFI
1854 */
1855 #ifdef Z_LARGE64
1856 ZEXTERN gzFile ZEXPORT gzopen64 OF((const
1857 ZEXTERN z_off64_t ZEXPORT gzseek64 OF((gzF
1858 ZEXTERN z_off64_t ZEXPORT gztell64 OF((gzF
1859 ZEXTERN z_off64_t ZEXPORT gzoffset64 OF((g
1860 ZEXTERN uLong ZEXPORT adler32_combine64 OF
1861 ZEXTERN uLong ZEXPORT crc32_combine64 OF((
1862 ZEXTERN uLong ZEXPORT crc32_combine_gen64
1863 #endif
1864
1865 #if !defined(ZLIB_INTERNAL) && defined(Z_WANT
1866 # ifdef Z_PREFIX_SET
1867 # define z_gzopen z_gzopen64
1868 # define z_gzseek z_gzseek64
1869 # define z_gztell z_gztell64
1870 # define z_gzoffset z_gzoffset64
1871 # define z_adler32_combine z_adler32_combi
1872 # define z_crc32_combine z_crc32_combine64
1873 # define z_crc32_combine_gen z_crc32_combi
1874 # else
1875 # define gzopen gzopen64
1876 # define gzseek gzseek64
1877 # define gztell gztell64
1878 # define gzoffset gzoffset64
1879 # define adler32_combine adler32_combine64
1880 # define crc32_combine crc32_combine64
1881 # define crc32_combine_gen crc32_combine_g
1882 # endif
1883 # ifndef Z_LARGE64
1884 ZEXTERN gzFile ZEXPORT gzopen64 OF((cons
1885 ZEXTERN z_off_t ZEXPORT gzseek64 OF((gzF
1886 ZEXTERN z_off_t ZEXPORT gztell64 OF((gzF
1887 ZEXTERN z_off_t ZEXPORT gzoffset64 OF((g
1888 ZEXTERN uLong ZEXPORT adler32_combine64
1889 ZEXTERN uLong ZEXPORT crc32_combine64 OF
1890 ZEXTERN uLong ZEXPORT crc32_combine_gen6
1891 # endif
1892 #else
1893 ZEXTERN gzFile ZEXPORT gzopen OF((const ch
1894 ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile,
1895 ZEXTERN z_off_t ZEXPORT gztell OF((gzFile)
1896 ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFil
1897 ZEXTERN uLong ZEXPORT adler32_combine OF((
1898 ZEXTERN uLong ZEXPORT crc32_combine OF((uL
1899 ZEXTERN uLong ZEXPORT crc32_combine_gen OF
1900 #endif
1901
1902 #else /* Z_SOLO */
1903
1904 ZEXTERN uLong ZEXPORT adler32_combine OF((
1905 ZEXTERN uLong ZEXPORT crc32_combine OF((uL
1906 ZEXTERN uLong ZEXPORT crc32_combine_gen OF
1907
1908 #endif /* !Z_SOLO */
1909
1910 /* undocumented functions */
1911 ZEXTERN const char * ZEXPORT zError
1912 ZEXTERN int ZEXPORT inflateSyncPoi
1913 ZEXTERN const z_crc_t FAR * ZEXPORT get_crc_t
1914 ZEXTERN int ZEXPORT inflateUndermi
1915 ZEXTERN int ZEXPORT inflateValidat
1916 ZEXTERN unsigned long ZEXPORT inflateCodesUs
1917 ZEXTERN int ZEXPORT inflateResetKe
1918 ZEXTERN int ZEXPORT deflateResetKe
1919 #if defined(_WIN32) && !defined(Z_SOLO)
1920 ZEXTERN gzFile ZEXPORT gzopen_w OF((c
1921 c
1922 #endif
1923 #if defined(STDC) || defined(Z_HAVE_STDARG_H)
1924 # ifndef Z_SOLO
1925 ZEXTERN int ZEXPORTVA gzvprintf Z_
1926
1927
1928 # endif
1929 #endif
1930
1931 #ifdef __cplusplus
1932 }
1933 #endif
1934
1935 #endif /* ZLIB_H */
1936