zlib/zutil.h

   1 /* zutil.h -- internal interface and configuration of the compression library
   2  * Copyright (C) 1995-2003 Jean-loup Gailly.
   3  * For conditions of distribution and use, see copyright notice in zlib.h
   4  */
   5
   6 /* WARNING: this file should *not* be used by applications. It is
   7    part of the implementation of the compression library and is
   8    subject to change. Applications should only use zlib.h.
   9  */
  10
  11 /* @(#) $Id$ */
  12
  13 #ifndef ZUTIL_H
  14 #define ZUTIL_H
  15
  16 #define ZLIB_INTERNAL
  17 #include "zlib.h"
  18
  19 #ifdef STDC
  20 #  include <stddef.h>
  21 #  include <string.h>
  22 #  include <stdlib.h>
  23 #endif
  24 #ifdef NO_ERRNO_H
  25     extern int errno;
  26 #else
  27 #   include <errno.h>
  28 #endif
  29
  30 #ifndef local
  31 #  define local static
  32 #endif
  33 /* compile with -Dlocal if your debugger can't find static symbols */
  34
  35 typedef unsigned char  uch;
  36 typedef uch FAR uchf;
  37 typedef unsigned short ush;
  38 typedef ush FAR ushf;
  39 typedef unsigned long  ulg;
  40
  41 /*@unchecked@*/ /*@observer@*/
  42 extern const char * const z_errmsg[10]; /* indexed by 2-zlib_error */
  43 /* (size given to avoid silly warnings with Visual C++) */
  44
  45 #define ERR_MSG(err) z_errmsg[Z_NEED_DICT-(err)]
  46
  47 #define ERR_RETURN(strm,err) \
  48   /*@-mods@*/ return (strm->msg = (char*)ERR_MSG(err), (err)) /*@=mods@*/
  49 /* To be used only when the state is known to be valid */
  50
  51         /* common constants */
  52
  53 #ifndef DEF_WBITS
  54 #  define DEF_WBITS MAX_WBITS
  55 #endif
  56 /* default windowBits for decompression. MAX_WBITS is for compression only */
  57
  58 #if MAX_MEM_LEVEL >= 8
  59 #  define DEF_MEM_LEVEL 8
  60 #else
  61 #  define DEF_MEM_LEVEL  MAX_MEM_LEVEL
  62 #endif
  63 /* default memLevel */
  64
  65 #define STORED_BLOCK 0
  66 #define STATIC_TREES 1
  67 #define DYN_TREES    2
  68 /* The three kinds of block type */
  69
  70 #define MIN_MATCH  3
  71 #define MAX_MATCH  258
  72 /* The minimum and maximum match lengths */
  73
  74 #define PRESET_DICT 0x20 /* preset dictionary flag in zlib header */
  75
  76         /* target dependencies */
  77
  78 #if defined(MSDOS) || (defined(WINDOWS) && !defined(WIN32))
  79 #  define OS_CODE  0x00
  80 #  if defined(__TURBOC__) || defined(__BORLANDC__)
  81 #    if(__STDC__ == 1) && (defined(__LARGE__) || defined(__COMPACT__))
  82        /* Allow compilation with ANSI keywords only enabled */
  83        void _Cdecl farfree( void *block )
  84         /*@*/;
  85        void *_Cdecl farmalloc( unsigned long nbytes )
  86         /*@*/;
  87 #    else
  88 #      include <alloc.h>
  89 #    endif
  90 #  else /* MSC or DJGPP */
  91 #    include <malloc.h>
  92 #  endif
  93 #endif
  94
  95 #ifdef AMIGA
  96 #  define OS_CODE  0x01
  97 #endif
  98
  99 #if defined(VAXC) || defined(VMS)
 100 #  define OS_CODE  0x02
 101 #  define F_OPEN(name, mode) \
 102      fopen((name), (mode), "mbc=60", "ctx=stm", "rfm=fix", "mrs=512")
 103 #endif
 104
 105 #if defined(ATARI) || defined(atarist)
 106 #  define OS_CODE  0x05
 107 #endif
 108
 109 #ifdef OS2
 110 #  define OS_CODE  0x06
 111 #endif
 112
 113 #if defined(MACOS) || defined(TARGET_OS_MAC)
 114 #  define OS_CODE  0x07
 115 #  if defined(__MWERKS__) && __dest_os != __be_os && __dest_os != __win32_os
 116 #    include <unix.h> /* for fdopen */
 117 #  else
 118 #    ifndef fdopen
 119 #      define fdopen(fd,mode) NULL /* No fdopen() */
 120 #    endif
 121 #  endif
 122 #endif
 123
 124 #ifdef TOPS20
 125 #  define OS_CODE  0x0a
 126 #endif
 127
 128 #ifdef WIN32
 129 #  ifndef __CYGWIN__  /* Cygwin is Unix, not Win32 */
 130 #    define OS_CODE  0x0b
 131 #  endif
 132 #endif
 133
 134 #ifdef __50SERIES /* Prime/PRIMOS */
 135 #  define OS_CODE  0x0f
 136 #endif
 137
 138 #if defined(_BEOS_) || defined(RISCOS)
 139 #  define fdopen(fd,mode) NULL /* No fdopen() */
 140 #endif
 141
 142 #if (defined(_MSC_VER) && (_MSC_VER > 600))
 143 #  if defined(_WIN32_WCE)
 144 #    define fdopen(fd,mode) NULL /* No fdopen() */
 145 #    ifndef _PTRDIFF_T_DEFINED
 146        typedef int ptrdiff_t;
 147 #      define _PTRDIFF_T_DEFINED
 148 #    endif
 149 #  else
 150 #    define fdopen(fd,type)  _fdopen(fd,type)
 151 #  endif
 152 #endif
 153
 154         /* common defaults */
 155
 156 #ifndef OS_CODE
 157 #  define OS_CODE  0x03  /* assume Unix */
 158 #endif
 159
 160 #ifndef F_OPEN
 161 #  define F_OPEN(name, mode) fopen((name), (mode))
 162 #endif
 163
 164          /* functions */
 165
 166 #if defined(STDC99) || (defined(__TURBOC__) && __TURBOC__ >= 0x550)
 167 #  ifndef HAVE_VSNPRINTF
 168 #    define HAVE_VSNPRINTF
 169 #  endif
 170 #endif
 171 #if defined(__CYGWIN__)
 172 #  ifndef HAVE_VSNPRINTF
 173 #    define HAVE_VSNPRINTF
 174 #  endif
 175 #endif
 176 #ifndef HAVE_VSNPRINTF
 177 #  ifdef MSDOS
 178      /* vsnprintf may exist on some MS-DOS compilers (DJGPP?),
 179         but for now we just assume it doesn't. */
 180 #    define NO_vsnprintf
 181 #  endif
 182 #  ifdef __TURBOC__
 183 #    define NO_vsnprintf
 184 #  endif
 185 #  ifdef WIN32
 186      /* In Win32, vsnprintf is available as the "non-ANSI" _vsnprintf. */
 187 #    if !defined(vsnprintf) && !defined(NO_vsnprintf)
 188 #      define vsnprintf _vsnprintf
 189 #    endif
 190 #  endif
 191 #  ifdef __SASC
 192 #    define NO_vsnprintf
 193 #  endif
 194 #endif
 195 #ifdef VMS
 196 #  define NO_vsnprintf
 197 #endif
 198
 199 #ifdef HAVE_STRERROR
 200 #  ifndef VMS
 201      extern char *strerror OF((int))
 202         /*@*/;
 203 #  endif
 204 #  define zstrerror(errnum) strerror(errnum)
 205 #else
 206 #  define zstrerror(errnum) ""
 207 #endif
 208
 209 #if defined(pyr)
 210 #  define NO_MEMCPY
 211 #endif
 212 #if defined(SMALL_MEDIUM) && !defined(_MSC_VER) && !defined(__SC__)
 213  /* Use our own functions for small and medium model with MSC <= 5.0.
 214   * You may have to use the same strategy for Borland C (untested).
 215   * The __SC__ check is for Symantec.
 216   */
 217 #  define NO_MEMCPY
 218 #endif
 219 #if defined(STDC) && !defined(HAVE_MEMCPY) && !defined(NO_MEMCPY)
 220 #  define HAVE_MEMCPY
 221 #endif
 222 #ifdef HAVE_MEMCPY
 223 #  ifdef SMALL_MEDIUM /* MSDOS small or medium model */
 224 #    define zmemcpy _fmemcpy
 225 #    define zmemcmp _fmemcmp
 226 #    define zmemzero(dest, len) _fmemset(dest, 0, len)
 227 #  else
 228 #    define zmemcpy memcpy
 229 #    define zmemcmp memcmp
 230 #    define zmemzero(dest, len) memset(dest, 0, len)
 231 #  endif
 232 #else
 233    extern void zmemcpy  OF((Bytef* dest, const Bytef* source, uInt len))
 234         /*@*/;
 235    extern int  zmemcmp  OF((const Bytef* s1, const Bytef* s2, uInt len))
 236         /*@*/;
 237    extern void zmemzero OF((Bytef* dest, uInt len))
 238         /*@*/;
 239 #endif
 240
 241 /* Diagnostic functions */
 242 #ifdef DEBUG
 243 #  include <stdio.h>
 244    extern int z_verbose;
 245    extern void z_error    OF((char *m))
 246         /*@*/;
 247 #  define Assert(cond,msg) {if(!(cond)) z_error(msg);}
 248 #  define Trace(x) {if (z_verbose>=0) fprintf x ;}
 249 #  define Tracev(x) {if (z_verbose>0) fprintf x ;}
 250 #  define Tracevv(x) {if (z_verbose>1) fprintf x ;}
 251 #  define Tracec(c,x) {if (z_verbose>0 && (c)) fprintf x ;}
 252 #  define Tracecv(c,x) {if (z_verbose>1 && (c)) fprintf x ;}
 253 #else
 254 #  define Assert(cond,msg)
 255 #  define Trace(x)
 256 #  define Tracev(x)
 257 #  define Tracevv(x)
 258 #  define Tracec(c,x)
 259 #  define Tracecv(c,x)
 260 #endif
 261
 262
 263 /*@only@*/ /*@null@*/
 264 voidpf zcalloc OF((voidpf opaque, unsigned items, unsigned size))
 265         /*@*/;
 266 void   zcfree  OF((voidpf opaque, /*@only@*/ voidpf ptr))
 267         /*@modifies ptr @*/;
 268
 269 #define ZALLOC(strm, items, size) \
 270            (*((strm)->zalloc))((strm)->opaque, (items), (size))
 271 #define ZFREE(strm, addr)  (*((strm)->zfree))((strm)->opaque, (voidpf)(addr))
 272 #define TRY_FREE(s, p) {if (p) ZFREE(s, p);}
 273
 274 #endif /* ZUTIL_H */