Home | History | Annotate | Line # | Download | only in zlib
zutil.h revision 1.5
      1 /*	$NetBSD: zutil.h,v 1.5 2017/01/10 01:27:41 christos Exp $	*/
      2 
      3 /* zutil.h -- internal interface and configuration of the compression library
      4  * Copyright (C) 1995-2016 Jean-loup Gailly, Mark Adler
      5  * For conditions of distribution and use, see copyright notice in zlib.h
      6  */
      7 
      8 /* WARNING: this file should *not* be used by applications. It is
      9    part of the implementation of the compression library and is
     10    subject to change. Applications should only use zlib.h.
     11  */
     12 
     13 /* @(#) $Id: zutil.h,v 1.5 2017/01/10 01:27:41 christos Exp $ */
     14 
     15 #ifndef ZUTIL_H
     16 #define ZUTIL_H
     17 
     18 #ifdef HAVE_HIDDEN
     19 #  define ZLIB_INTERNAL __attribute__((visibility ("hidden")))
     20 #else
     21 #  define ZLIB_INTERNAL
     22 #endif
     23 
     24 #include "zlib.h"
     25 
     26 #if defined(STDC) && !defined(Z_SOLO)
     27 #  if defined(_KERNEL) || defined(_STANDALONE)
     28 #    include <lib/libkern/libkern.h>
     29 #  else
     30 #    if !(defined(_WIN32_WCE) && defined(_MSC_VER))
     31 #      include <stddef.h>
     32 #    endif
     33 #    include <string.h>
     34 #    include <stdlib.h>
     35 #  endif
     36 #endif
     37 
     38 #ifdef Z_SOLO
     39    typedef long ptrdiff_t;  /* guess -- will be caught if guess is wrong */
     40 #endif
     41 
     42 #ifndef local
     43 #  define local static
     44 #endif
     45 /* since "static" is used to mean two completely different things in C, we
     46    define "local" for the non-static meaning of "static", for readability
     47    (compile with -Dlocal if your debugger can't find static symbols) */
     48 
     49 typedef unsigned char  uch;
     50 typedef uch FAR uchf;
     51 typedef unsigned short ush;
     52 typedef ush FAR ushf;
     53 typedef unsigned long  ulg;
     54 
     55 extern z_const char * const z_errmsg[10]; /* indexed by 2-zlib_error */
     56 /* (size given to avoid silly warnings with Visual C++) */
     57 
     58 #define ERR_MSG(err) z_errmsg[Z_NEED_DICT-(err)]
     59 
     60 #define ERR_RETURN(strm,err) \
     61   return (strm->msg = __UNCONST(ERR_MSG(err)), (err))
     62 /* To be used only when the state is known to be valid */
     63 
     64         /* common constants */
     65 
     66 #ifndef DEF_WBITS
     67 #  define DEF_WBITS MAX_WBITS
     68 #endif
     69 /* default windowBits for decompression. MAX_WBITS is for compression only */
     70 
     71 #if MAX_MEM_LEVEL >= 8
     72 #  define DEF_MEM_LEVEL 8
     73 #else
     74 #  define DEF_MEM_LEVEL  MAX_MEM_LEVEL
     75 #endif
     76 /* default memLevel */
     77 
     78 #define STORED_BLOCK 0
     79 #define STATIC_TREES 1
     80 #define DYN_TREES    2
     81 /* The three kinds of block type */
     82 
     83 #define MIN_MATCH  3
     84 #define MAX_MATCH  258
     85 /* The minimum and maximum match lengths */
     86 
     87 #define PRESET_DICT 0x20 /* preset dictionary flag in zlib header */
     88 
     89         /* target dependencies */
     90 
     91 #if defined(MSDOS) || (defined(WINDOWS) && !defined(WIN32))
     92 #  define OS_CODE  0x00
     93 #  ifndef Z_SOLO
     94 #    if defined(__TURBOC__) || defined(__BORLANDC__)
     95 #      if (__STDC__ == 1) && (defined(__LARGE__) || defined(__COMPACT__))
     96          /* Allow compilation with ANSI keywords only enabled */
     97          void _Cdecl farfree( void *block );
     98          void *_Cdecl farmalloc( unsigned long nbytes );
     99 #      else
    100 #        include <alloc.h>
    101 #      endif
    102 #    else /* MSC or DJGPP */
    103 #      include <malloc.h>
    104 #    endif
    105 #  endif
    106 #endif
    107 
    108 #ifdef AMIGA
    109 #  define OS_CODE  1
    110 #endif
    111 
    112 #if defined(VAXC) || defined(VMS)
    113 #  define OS_CODE  2
    114 #  define F_OPEN(name, mode) \
    115      fopen((name), (mode), "mbc=60", "ctx=stm", "rfm=fix", "mrs=512")
    116 #endif
    117 
    118 #ifdef __370__
    119 #  if __TARGET_LIB__ < 0x20000000
    120 #    define OS_CODE 4
    121 #  elif __TARGET_LIB__ < 0x40000000
    122 #    define OS_CODE 11
    123 #  else
    124 #    define OS_CODE 8
    125 #  endif
    126 #endif
    127 
    128 #if defined(ATARI) || defined(atarist)
    129 #  define OS_CODE  5
    130 #endif
    131 
    132 #ifdef OS2
    133 #  define OS_CODE  6
    134 #  if defined(M_I86) && !defined(Z_SOLO)
    135 #    include <malloc.h>
    136 #  endif
    137 #endif
    138 
    139 #if defined(MACOS) || defined(TARGET_OS_MAC)
    140 #  define OS_CODE  7
    141 #  ifndef Z_SOLO
    142 #    if defined(__MWERKS__) && __dest_os != __be_os && __dest_os != __win32_os
    143 #      include <unix.h> /* for fdopen */
    144 #    else
    145 #      ifndef fdopen
    146 #        define fdopen(fd,mode) NULL /* No fdopen() */
    147 #      endif
    148 #    endif
    149 #  endif
    150 #endif
    151 
    152 #ifdef __acorn
    153 #  define OS_CODE 13
    154 #endif
    155 
    156 #if defined(WIN32) && !defined(__CYGWIN__)
    157 #  define OS_CODE  10
    158 #endif
    159 
    160 #ifdef _BEOS_
    161 #  define OS_CODE  16
    162 #endif
    163 
    164 #ifdef __TOS_OS400__
    165 #  define OS_CODE 18
    166 #endif
    167 
    168 #ifdef __APPLE__
    169 #  define OS_CODE 19
    170 #endif
    171 
    172 #if defined(_BEOS_) || defined(RISCOS)
    173 #  define fdopen(fd,mode) NULL /* No fdopen() */
    174 #endif
    175 
    176 #if (defined(_MSC_VER) && (_MSC_VER > 600)) && !defined __INTERIX
    177 #  if defined(_WIN32_WCE)
    178 #    define fdopen(fd,mode) NULL /* No fdopen() */
    179 #    ifndef _PTRDIFF_T_DEFINED
    180        typedef int ptrdiff_t;
    181 #      define _PTRDIFF_T_DEFINED
    182 #    endif
    183 #  else
    184 #    define fdopen(fd,type)  _fdopen(fd,type)
    185 #  endif
    186 #endif
    187 
    188 #if defined(__BORLANDC__) && !defined(MSDOS)
    189   #pragma warn -8004
    190   #pragma warn -8008
    191   #pragma warn -8066
    192 #endif
    193 
    194 /* provide prototypes for these when building zlib without LFS */
    195 #if !defined(_WIN32) && \
    196     (!defined(_LARGEFILE64_SOURCE) || _LFS64_LARGEFILE-0 == 0)
    197     ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off_t));
    198     ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off_t));
    199 #endif
    200 
    201         /* common defaults */
    202 
    203 #ifndef OS_CODE
    204 #  define OS_CODE  3     /* assume Unix */
    205 #endif
    206 
    207 #ifndef F_OPEN
    208 #  define F_OPEN(name, mode) fopen((name), (mode))
    209 #endif
    210 
    211          /* functions */
    212 
    213 #if defined(pyr) || defined(Z_SOLO)
    214 #  define NO_MEMCPY
    215 #endif
    216 #if defined(SMALL_MEDIUM) && !defined(_MSC_VER) && !defined(__SC__)
    217  /* Use our own functions for small and medium model with MSC <= 5.0.
    218   * You may have to use the same strategy for Borland C (untested).
    219   * The __SC__ check is for Symantec.
    220   */
    221 #  define NO_MEMCPY
    222 #endif
    223 #if defined(STDC) && !defined(HAVE_MEMCPY) && !defined(NO_MEMCPY)
    224 #  define HAVE_MEMCPY
    225 #endif
    226 #ifdef HAVE_MEMCPY
    227 #  ifdef SMALL_MEDIUM /* MSDOS small or medium model */
    228 #    define zmemcpy _fmemcpy
    229 #    define zmemcmp _fmemcmp
    230 #    define zmemzero(dest, len) _fmemset(dest, 0, len)
    231 #  else
    232 #    define zmemcpy memcpy
    233 #    define zmemcmp memcmp
    234 #    define zmemzero(dest, len) memset(dest, 0, len)
    235 #  endif
    236 #else
    237    void ZLIB_INTERNAL zmemcpy OF((Bytef* dest, const Bytef* source, uInt len));
    238    int ZLIB_INTERNAL zmemcmp OF((const Bytef* s1, const Bytef* s2, uInt len));
    239    void ZLIB_INTERNAL zmemzero OF((Bytef* dest, uInt len));
    240 #endif
    241 
    242 /* Diagnostic functions */
    243 #ifdef ZLIB_DEBUG
    244 #  include <stdio.h>
    245    extern int ZLIB_INTERNAL z_verbose;
    246    extern void ZLIB_INTERNAL z_error OF((char *m));
    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 #ifndef Z_SOLO
    263    voidpf ZLIB_INTERNAL zcalloc OF((voidpf opaque, unsigned items,
    264                                     unsigned size));
    265    void ZLIB_INTERNAL zcfree  OF((voidpf opaque, voidpf ptr));
    266 #endif
    267 
    268 #define ZALLOC(strm, items, size) \
    269            (*((strm)->zalloc))((strm)->opaque, (items), (size))
    270 #define ZFREE(strm, addr)  (*((strm)->zfree))((strm)->opaque, (voidpf)(addr))
    271 #define TRY_FREE(s, p) {if (p) ZFREE(s, p);}
    272 
    273 /* Reverse the bytes in a 32-bit value */
    274 #define ZSWAP32(q) ((((q) >> 24) & 0xff) + (((q) >> 8) & 0xff00) + \
    275                     (((q) & 0xff00) << 8) + (((q) & 0xff) << 24))
    276 
    277 #endif /* ZUTIL_H */
    278