xref: /xnu-10002.41.9/libkern/zlib/zutil.h (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions /*
2*699cd480SApple OSS Distributions  * Copyright (c) 2008 Apple Inc. All rights reserved.
3*699cd480SApple OSS Distributions  *
4*699cd480SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*699cd480SApple OSS Distributions  *
6*699cd480SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*699cd480SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*699cd480SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*699cd480SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*699cd480SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*699cd480SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*699cd480SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*699cd480SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*699cd480SApple OSS Distributions  *
15*699cd480SApple OSS Distributions  * Please obtain a copy of the License at
16*699cd480SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*699cd480SApple OSS Distributions  *
18*699cd480SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*699cd480SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*699cd480SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*699cd480SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*699cd480SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*699cd480SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*699cd480SApple OSS Distributions  * limitations under the License.
25*699cd480SApple OSS Distributions  *
26*699cd480SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*699cd480SApple OSS Distributions  */
28*699cd480SApple OSS Distributions /* zutil.h -- internal interface and configuration of the compression library
29*699cd480SApple OSS Distributions  * Copyright (C) 1995-2005 Jean-loup Gailly.
30*699cd480SApple OSS Distributions  * For conditions of distribution and use, see copyright notice in zlib.h
31*699cd480SApple OSS Distributions  */
32*699cd480SApple OSS Distributions 
33*699cd480SApple OSS Distributions /* WARNING: this file should *not* be used by applications. It is
34*699cd480SApple OSS Distributions    part of the implementation of the compression library and is
35*699cd480SApple OSS Distributions    subject to change. Applications should only use zlib.h.
36*699cd480SApple OSS Distributions  */
37*699cd480SApple OSS Distributions 
38*699cd480SApple OSS Distributions /* @(#) $Id$ */
39*699cd480SApple OSS Distributions 
40*699cd480SApple OSS Distributions #ifndef ZUTIL_H
41*699cd480SApple OSS Distributions #define ZUTIL_H
42*699cd480SApple OSS Distributions 
43*699cd480SApple OSS Distributions #define ZLIB_INTERNAL
44*699cd480SApple OSS Distributions 
45*699cd480SApple OSS Distributions #if KERNEL
46*699cd480SApple OSS Distributions #  include <libkern/zlib.h>
47*699cd480SApple OSS Distributions #  include <string.h>
48*699cd480SApple OSS Distributions #  ifndef NO_ERRNO_H
49*699cd480SApple OSS Distributions #    define NO_ERRNO_H 1
50*699cd480SApple OSS Distributions #  endif
51*699cd480SApple OSS Distributions #  ifndef NO_ZCFUNCS
52*699cd480SApple OSS Distributions #    define NO_ZCFUNCS 1
53*699cd480SApple OSS Distributions #  endif
54*699cd480SApple OSS Distributions #else
55*699cd480SApple OSS Distributions #  include "zlib.h"
56*699cd480SApple OSS Distributions #  ifdef STDC
57*699cd480SApple OSS Distributions #    ifndef _WIN32_WCE
58*699cd480SApple OSS Distributions #      include <stddef.h>
59*699cd480SApple OSS Distributions #    endif
60*699cd480SApple OSS Distributions #    include <string.h>
61*699cd480SApple OSS Distributions #    include <stdlib.h>
62*699cd480SApple OSS Distributions #  endif
63*699cd480SApple OSS Distributions #endif /* KERNEL */
64*699cd480SApple OSS Distributions 
65*699cd480SApple OSS Distributions #ifdef NO_ERRNO_H
66*699cd480SApple OSS Distributions #   ifdef _WIN32_WCE
67*699cd480SApple OSS Distributions       /* The Microsoft C Run-Time Library for Windows CE doesn't have
68*699cd480SApple OSS Distributions        * errno.  We define it as a global variable to simplify porting.
69*699cd480SApple OSS Distributions        * Its value is always 0 and should not be used.  We rename it to
70*699cd480SApple OSS Distributions        * avoid conflict with other libraries that use the same workaround.
71*699cd480SApple OSS Distributions        */
72*699cd480SApple OSS Distributions #     define errno z_errno
73*699cd480SApple OSS Distributions #   endif
74*699cd480SApple OSS Distributions     extern int errno;
75*699cd480SApple OSS Distributions #else
76*699cd480SApple OSS Distributions #  ifndef _WIN32_WCE
77*699cd480SApple OSS Distributions #    include <errno.h>
78*699cd480SApple OSS Distributions #  endif
79*699cd480SApple OSS Distributions #endif
80*699cd480SApple OSS Distributions 
81*699cd480SApple OSS Distributions #ifndef local
82*699cd480SApple OSS Distributions #  define local static
83*699cd480SApple OSS Distributions #endif
84*699cd480SApple OSS Distributions /* compile with -Dlocal if your debugger can't find static symbols */
85*699cd480SApple OSS Distributions 
86*699cd480SApple OSS Distributions typedef unsigned char  uch;
87*699cd480SApple OSS Distributions typedef uch FAR uchf;
88*699cd480SApple OSS Distributions typedef unsigned short ush;
89*699cd480SApple OSS Distributions typedef ush FAR ushf;
90*699cd480SApple OSS Distributions typedef unsigned long  ulg;
91*699cd480SApple OSS Distributions 
92*699cd480SApple OSS Distributions extern const char * const z_errmsg[10]; /* indexed by 2-zlib_error */
93*699cd480SApple OSS Distributions /* (size given to avoid silly warnings with Visual C++) */
94*699cd480SApple OSS Distributions 
95*699cd480SApple OSS Distributions #define ERR_MSG(err) z_errmsg[Z_NEED_DICT-(err)]
96*699cd480SApple OSS Distributions 
97*699cd480SApple OSS Distributions #define ERR_RETURN(strm,err) \
98*699cd480SApple OSS Distributions   return (strm->msg = (char*)ERR_MSG(err), (err))
99*699cd480SApple OSS Distributions /* To be used only when the state is known to be valid */
100*699cd480SApple OSS Distributions 
101*699cd480SApple OSS Distributions         /* common constants */
102*699cd480SApple OSS Distributions 
103*699cd480SApple OSS Distributions #ifndef DEF_WBITS
104*699cd480SApple OSS Distributions #  define DEF_WBITS MAX_WBITS
105*699cd480SApple OSS Distributions #endif
106*699cd480SApple OSS Distributions /* default windowBits for decompression. MAX_WBITS is for compression only */
107*699cd480SApple OSS Distributions 
108*699cd480SApple OSS Distributions #if MAX_MEM_LEVEL >= 8
109*699cd480SApple OSS Distributions #  define DEF_MEM_LEVEL 8
110*699cd480SApple OSS Distributions #else
111*699cd480SApple OSS Distributions #  define DEF_MEM_LEVEL  MAX_MEM_LEVEL
112*699cd480SApple OSS Distributions #endif
113*699cd480SApple OSS Distributions /* default memLevel */
114*699cd480SApple OSS Distributions 
115*699cd480SApple OSS Distributions #define STORED_BLOCK 0
116*699cd480SApple OSS Distributions #define STATIC_TREES 1
117*699cd480SApple OSS Distributions #define DYN_TREES    2
118*699cd480SApple OSS Distributions /* The three kinds of block type */
119*699cd480SApple OSS Distributions 
120*699cd480SApple OSS Distributions #define MIN_MATCH  3
121*699cd480SApple OSS Distributions #define MAX_MATCH  258
122*699cd480SApple OSS Distributions /* The minimum and maximum match lengths */
123*699cd480SApple OSS Distributions 
124*699cd480SApple OSS Distributions #define PRESET_DICT 0x20 /* preset dictionary flag in zlib header */
125*699cd480SApple OSS Distributions 
126*699cd480SApple OSS Distributions         /* target dependencies */
127*699cd480SApple OSS Distributions 
128*699cd480SApple OSS Distributions #if defined(MSDOS) || (defined(WINDOWS) && !defined(WIN32))
129*699cd480SApple OSS Distributions #  define OS_CODE  0x00
130*699cd480SApple OSS Distributions #  if defined(__TURBOC__) || defined(__BORLANDC__)
131*699cd480SApple OSS Distributions #    if(__STDC__ == 1) && (defined(__LARGE__) || defined(__COMPACT__))
132*699cd480SApple OSS Distributions        /* Allow compilation with ANSI keywords only enabled */
133*699cd480SApple OSS Distributions        void _Cdecl farfree( void *block );
134*699cd480SApple OSS Distributions        void *_Cdecl farmalloc( unsigned long nbytes );
135*699cd480SApple OSS Distributions #    else
136*699cd480SApple OSS Distributions #      include <alloc.h>
137*699cd480SApple OSS Distributions #    endif
138*699cd480SApple OSS Distributions #  else /* MSC or DJGPP */
139*699cd480SApple OSS Distributions #    include <malloc.h>
140*699cd480SApple OSS Distributions #  endif
141*699cd480SApple OSS Distributions #endif
142*699cd480SApple OSS Distributions 
143*699cd480SApple OSS Distributions #ifdef AMIGA
144*699cd480SApple OSS Distributions #  define OS_CODE  0x01
145*699cd480SApple OSS Distributions #endif
146*699cd480SApple OSS Distributions 
147*699cd480SApple OSS Distributions #if defined(VAXC) || defined(VMS)
148*699cd480SApple OSS Distributions #  define OS_CODE  0x02
149*699cd480SApple OSS Distributions #  define F_OPEN(name, mode) \
150*699cd480SApple OSS Distributions      fopen((name), (mode), "mbc=60", "ctx=stm", "rfm=fix", "mrs=512")
151*699cd480SApple OSS Distributions #endif
152*699cd480SApple OSS Distributions 
153*699cd480SApple OSS Distributions #if defined(ATARI) || defined(atarist)
154*699cd480SApple OSS Distributions #  define OS_CODE  0x05
155*699cd480SApple OSS Distributions #endif
156*699cd480SApple OSS Distributions 
157*699cd480SApple OSS Distributions #ifdef OS2
158*699cd480SApple OSS Distributions #  define OS_CODE  0x06
159*699cd480SApple OSS Distributions #  ifdef M_I86
160*699cd480SApple OSS Distributions      #include <malloc.h>
161*699cd480SApple OSS Distributions #  endif
162*699cd480SApple OSS Distributions #endif
163*699cd480SApple OSS Distributions 
164*699cd480SApple OSS Distributions #if defined(MACOS) || defined(TARGET_OS_MAC)
165*699cd480SApple OSS Distributions #  define OS_CODE  0x07
166*699cd480SApple OSS Distributions #  if defined(__MWERKS__) && __dest_os != __be_os && __dest_os != __win32_os
167*699cd480SApple OSS Distributions #    include <unix.h> /* for fdopen */
168*699cd480SApple OSS Distributions #  else
169*699cd480SApple OSS Distributions #    ifndef fdopen
170*699cd480SApple OSS Distributions #      define fdopen(fd,mode) NULL /* No fdopen() */
171*699cd480SApple OSS Distributions #    endif
172*699cd480SApple OSS Distributions #  endif
173*699cd480SApple OSS Distributions #endif
174*699cd480SApple OSS Distributions 
175*699cd480SApple OSS Distributions #ifdef TOPS20
176*699cd480SApple OSS Distributions #  define OS_CODE  0x0a
177*699cd480SApple OSS Distributions #endif
178*699cd480SApple OSS Distributions 
179*699cd480SApple OSS Distributions #ifdef WIN32
180*699cd480SApple OSS Distributions #  ifndef __CYGWIN__  /* Cygwin is Unix, not Win32 */
181*699cd480SApple OSS Distributions #    define OS_CODE  0x0b
182*699cd480SApple OSS Distributions #  endif
183*699cd480SApple OSS Distributions #endif
184*699cd480SApple OSS Distributions 
185*699cd480SApple OSS Distributions #ifdef __50SERIES /* Prime/PRIMOS */
186*699cd480SApple OSS Distributions #  define OS_CODE  0x0f
187*699cd480SApple OSS Distributions #endif
188*699cd480SApple OSS Distributions 
189*699cd480SApple OSS Distributions #if defined(_BEOS_) || defined(RISCOS)
190*699cd480SApple OSS Distributions #  define fdopen(fd,mode) NULL /* No fdopen() */
191*699cd480SApple OSS Distributions #endif
192*699cd480SApple OSS Distributions 
193*699cd480SApple OSS Distributions #if KERNEL
194*699cd480SApple OSS Distributions     typedef long ptrdiff_t;
195*699cd480SApple OSS Distributions #elif (defined(_MSC_VER) && (_MSC_VER > 600))
196*699cd480SApple OSS Distributions #  if defined(_WIN32_WCE)
197*699cd480SApple OSS Distributions #    define fdopen(fd,mode) NULL /* No fdopen() */
198*699cd480SApple OSS Distributions #    ifndef _PTRDIFF_T_DEFINED
199*699cd480SApple OSS Distributions        typedef int ptrdiff_t;
200*699cd480SApple OSS Distributions #      define _PTRDIFF_T_DEFINED
201*699cd480SApple OSS Distributions #    endif
202*699cd480SApple OSS Distributions #  else
203*699cd480SApple OSS Distributions #    define fdopen(fd,type)  _fdopen(fd,type)
204*699cd480SApple OSS Distributions #  endif
205*699cd480SApple OSS Distributions #endif
206*699cd480SApple OSS Distributions 
207*699cd480SApple OSS Distributions 
208*699cd480SApple OSS Distributions         /* common defaults */
209*699cd480SApple OSS Distributions 
210*699cd480SApple OSS Distributions #ifndef OS_CODE
211*699cd480SApple OSS Distributions #  define OS_CODE  0x03  /* assume Unix */
212*699cd480SApple OSS Distributions #endif
213*699cd480SApple OSS Distributions 
214*699cd480SApple OSS Distributions #ifndef F_OPEN
215*699cd480SApple OSS Distributions #  define F_OPEN(name, mode) fopen((name), (mode))
216*699cd480SApple OSS Distributions #endif
217*699cd480SApple OSS Distributions 
218*699cd480SApple OSS Distributions          /* functions */
219*699cd480SApple OSS Distributions 
220*699cd480SApple OSS Distributions #if defined(STDC99) || (defined(__TURBOC__) && __TURBOC__ >= 0x550)
221*699cd480SApple OSS Distributions #  ifndef HAVE_VSNPRINTF
222*699cd480SApple OSS Distributions #    define HAVE_VSNPRINTF
223*699cd480SApple OSS Distributions #  endif
224*699cd480SApple OSS Distributions #endif
225*699cd480SApple OSS Distributions #if defined(__CYGWIN__)
226*699cd480SApple OSS Distributions #  ifndef HAVE_VSNPRINTF
227*699cd480SApple OSS Distributions #    define HAVE_VSNPRINTF
228*699cd480SApple OSS Distributions #  endif
229*699cd480SApple OSS Distributions #endif
230*699cd480SApple OSS Distributions #ifndef HAVE_VSNPRINTF
231*699cd480SApple OSS Distributions #  ifdef MSDOS
232*699cd480SApple OSS Distributions      /* vsnprintf may exist on some MS-DOS compilers (DJGPP?),
233*699cd480SApple OSS Distributions         but for now we just assume it doesn't. */
234*699cd480SApple OSS Distributions #    define NO_vsnprintf
235*699cd480SApple OSS Distributions #  endif
236*699cd480SApple OSS Distributions #  ifdef __TURBOC__
237*699cd480SApple OSS Distributions #    define NO_vsnprintf
238*699cd480SApple OSS Distributions #  endif
239*699cd480SApple OSS Distributions #  ifdef WIN32
240*699cd480SApple OSS Distributions      /* In Win32, vsnprintf is available as the "non-ANSI" _vsnprintf. */
241*699cd480SApple OSS Distributions #    if !defined(vsnprintf) && !defined(NO_vsnprintf)
242*699cd480SApple OSS Distributions #      define vsnprintf _vsnprintf
243*699cd480SApple OSS Distributions #    endif
244*699cd480SApple OSS Distributions #  endif
245*699cd480SApple OSS Distributions #  ifdef __SASC
246*699cd480SApple OSS Distributions #    define NO_vsnprintf
247*699cd480SApple OSS Distributions #  endif
248*699cd480SApple OSS Distributions #endif
249*699cd480SApple OSS Distributions #ifdef VMS
250*699cd480SApple OSS Distributions #  define NO_vsnprintf
251*699cd480SApple OSS Distributions #endif
252*699cd480SApple OSS Distributions 
253*699cd480SApple OSS Distributions #if defined(pyr)
254*699cd480SApple OSS Distributions #  define NO_MEMCPY
255*699cd480SApple OSS Distributions #endif
256*699cd480SApple OSS Distributions #if defined(SMALL_MEDIUM) && !defined(_MSC_VER) && !defined(__SC__)
257*699cd480SApple OSS Distributions  /* Use our own functions for small and medium model with MSC <= 5.0.
258*699cd480SApple OSS Distributions   * You may have to use the same strategy for Borland C (untested).
259*699cd480SApple OSS Distributions   * The __SC__ check is for Symantec.
260*699cd480SApple OSS Distributions   */
261*699cd480SApple OSS Distributions #  define NO_MEMCPY
262*699cd480SApple OSS Distributions #endif
263*699cd480SApple OSS Distributions #if defined(STDC) && !defined(HAVE_MEMCPY) && !defined(NO_MEMCPY)
264*699cd480SApple OSS Distributions #  define HAVE_MEMCPY
265*699cd480SApple OSS Distributions #endif
266*699cd480SApple OSS Distributions #ifdef HAVE_MEMCPY
267*699cd480SApple OSS Distributions #  ifdef SMALL_MEDIUM /* MSDOS small or medium model */
268*699cd480SApple OSS Distributions #    define zmemcpy _fmemcpy
269*699cd480SApple OSS Distributions #    define zmemcmp _fmemcmp
270*699cd480SApple OSS Distributions #    define zmemzero(dest, len) _fmemset(dest, 0, len)
271*699cd480SApple OSS Distributions #  else
272*699cd480SApple OSS Distributions #    define zmemcpy memcpy
273*699cd480SApple OSS Distributions #    define zmemcmp memcmp
274*699cd480SApple OSS Distributions #    define zmemzero(dest, len) memset(dest, 0, len)
275*699cd480SApple OSS Distributions #  endif
276*699cd480SApple OSS Distributions #else
277*699cd480SApple OSS Distributions    extern void zmemcpy  OF((Bytef* dest, const Bytef* source, uInt len));
278*699cd480SApple OSS Distributions    extern int  zmemcmp  OF((const Bytef* s1, const Bytef* s2, uInt len));
279*699cd480SApple OSS Distributions    extern void zmemzero OF((Bytef* dest, uInt len));
280*699cd480SApple OSS Distributions #endif
281*699cd480SApple OSS Distributions 
282*699cd480SApple OSS Distributions /* Diagnostic functions */
283*699cd480SApple OSS Distributions #if defined(DEBUG) && !defined(KERNEL)
284*699cd480SApple OSS Distributions #  include <stdio.h>
285*699cd480SApple OSS Distributions    extern int z_verbose;
286*699cd480SApple OSS Distributions    extern void z_error    OF((char *m));
287*699cd480SApple OSS Distributions #  define Assert(cond,msg) {if(!(cond)) z_error(msg);}
288*699cd480SApple OSS Distributions #  define Trace(x) {if (z_verbose>=0) fprintf x ;}
289*699cd480SApple OSS Distributions #  define Tracev(x) {if (z_verbose>0) fprintf x ;}
290*699cd480SApple OSS Distributions #  define Tracevv(x) {if (z_verbose>1) fprintf x ;}
291*699cd480SApple OSS Distributions #  define Tracec(c,x) {if (z_verbose>0 && (c)) fprintf x ;}
292*699cd480SApple OSS Distributions #  define Tracecv(c,x) {if (z_verbose>1 && (c)) fprintf x ;}
293*699cd480SApple OSS Distributions #else
294*699cd480SApple OSS Distributions #  define Assert(cond,msg)
295*699cd480SApple OSS Distributions #  define Trace(x)
296*699cd480SApple OSS Distributions #  define Tracev(x)
297*699cd480SApple OSS Distributions #  define Tracevv(x)
298*699cd480SApple OSS Distributions #  define Tracec(c,x)
299*699cd480SApple OSS Distributions #  define Tracecv(c,x)
300*699cd480SApple OSS Distributions #endif
301*699cd480SApple OSS Distributions #undef DEBUG
302*699cd480SApple OSS Distributions 
303*699cd480SApple OSS Distributions #ifndef NO_ZCFUNCS
304*699cd480SApple OSS Distributions voidpf zcalloc OF((voidpf opaque, unsigned items, unsigned size));
305*699cd480SApple OSS Distributions void   zcfree  OF((voidpf opaque, voidpf ptr));
306*699cd480SApple OSS Distributions #endif /* NO_ZCFUNCS */
307*699cd480SApple OSS Distributions 
308*699cd480SApple OSS Distributions #define ZALLOC(strm, items, size) \
309*699cd480SApple OSS Distributions            (*((strm)->zalloc))((strm)->opaque, (items), (size))
310*699cd480SApple OSS Distributions #define ZFREE(strm, addr)  (*((strm)->zfree))((strm)->opaque, (voidpf)(addr))
311*699cd480SApple OSS Distributions #define TRY_FREE(s, p) {if (p) ZFREE(s, p);}
312*699cd480SApple OSS Distributions 
313*699cd480SApple OSS Distributions #endif /* ZUTIL_H */
314