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