core/zlib/inflate.h
author David Anderson <dvander@alliedmods.net>
Fri Feb 16 03:47:10 2007 +0000 (2007-02-16)
changeset 501 e209a7296936
parent 159 43c471413f70
permissions -rw-r--r--
removed this potential feature, not useful enough
dvander@159
     1
/* inflate.h -- internal inflate state definition
dvander@159
     2
 * Copyright (C) 1995-2004 Mark Adler
dvander@159
     3
 * For conditions of distribution and use, see copyright notice in zlib.h
dvander@159
     4
 */
dvander@159
     5
dvander@159
     6
/* WARNING: this file should *not* be used by applications. It is
dvander@159
     7
   part of the implementation of the compression library and is
dvander@159
     8
   subject to change. Applications should only use zlib.h.
dvander@159
     9
 */
dvander@159
    10
dvander@159
    11
/* define NO_GZIP when compiling if you want to disable gzip header and
dvander@159
    12
   trailer decoding by inflate().  NO_GZIP would be used to avoid linking in
dvander@159
    13
   the crc code when it is not needed.  For shared libraries, gzip decoding
dvander@159
    14
   should be left enabled. */
dvander@159
    15
#ifndef NO_GZIP
dvander@159
    16
#  define GUNZIP
dvander@159
    17
#endif
dvander@159
    18
dvander@159
    19
/* Possible inflate modes between inflate() calls */
dvander@159
    20
typedef enum {
dvander@159
    21
    HEAD,       /* i: waiting for magic header */
dvander@159
    22
    FLAGS,      /* i: waiting for method and flags (gzip) */
dvander@159
    23
    TIME,       /* i: waiting for modification time (gzip) */
dvander@159
    24
    OS,         /* i: waiting for extra flags and operating system (gzip) */
dvander@159
    25
    EXLEN,      /* i: waiting for extra length (gzip) */
dvander@159
    26
    EXTRA,      /* i: waiting for extra bytes (gzip) */
dvander@159
    27
    NAME,       /* i: waiting for end of file name (gzip) */
dvander@159
    28
    COMMENT,    /* i: waiting for end of comment (gzip) */
dvander@159
    29
    HCRC,       /* i: waiting for header crc (gzip) */
dvander@159
    30
    DICTID,     /* i: waiting for dictionary check value */
dvander@159
    31
    DICT,       /* waiting for inflateSetDictionary() call */
dvander@159
    32
        TYPE,       /* i: waiting for type bits, including last-flag bit */
dvander@159
    33
        TYPEDO,     /* i: same, but skip check to exit inflate on new block */
dvander@159
    34
        STORED,     /* i: waiting for stored size (length and complement) */
dvander@159
    35
        COPY,       /* i/o: waiting for input or output to copy stored block */
dvander@159
    36
        TABLE,      /* i: waiting for dynamic block table lengths */
dvander@159
    37
        LENLENS,    /* i: waiting for code length code lengths */
dvander@159
    38
        CODELENS,   /* i: waiting for length/lit and distance code lengths */
dvander@159
    39
            LEN,        /* i: waiting for length/lit code */
dvander@159
    40
            LENEXT,     /* i: waiting for length extra bits */
dvander@159
    41
            DIST,       /* i: waiting for distance code */
dvander@159
    42
            DISTEXT,    /* i: waiting for distance extra bits */
dvander@159
    43
            MATCH,      /* o: waiting for output space to copy string */
dvander@159
    44
            LIT,        /* o: waiting for output space to write literal */
dvander@159
    45
    CHECK,      /* i: waiting for 32-bit check value */
dvander@159
    46
    LENGTH,     /* i: waiting for 32-bit length (gzip) */
dvander@159
    47
    DONE,       /* finished check, done -- remain here until reset */
dvander@159
    48
    BAD,        /* got a data error -- remain here until reset */
dvander@159
    49
    MEM,        /* got an inflate() memory error -- remain here until reset */
dvander@159
    50
    SYNC        /* looking for synchronization bytes to restart inflate() */
dvander@159
    51
} inflate_mode;
dvander@159
    52
dvander@159
    53
/*
dvander@159
    54
    State transitions between above modes -
dvander@159
    55
dvander@159
    56
    (most modes can go to the BAD or MEM mode -- not shown for clarity)
dvander@159
    57
dvander@159
    58
    Process header:
dvander@159
    59
        HEAD -> (gzip) or (zlib)
dvander@159
    60
        (gzip) -> FLAGS -> TIME -> OS -> EXLEN -> EXTRA -> NAME
dvander@159
    61
        NAME -> COMMENT -> HCRC -> TYPE
dvander@159
    62
        (zlib) -> DICTID or TYPE
dvander@159
    63
        DICTID -> DICT -> TYPE
dvander@159
    64
    Read deflate blocks:
dvander@159
    65
            TYPE -> STORED or TABLE or LEN or CHECK
dvander@159
    66
            STORED -> COPY -> TYPE
dvander@159
    67
            TABLE -> LENLENS -> CODELENS -> LEN
dvander@159
    68
    Read deflate codes:
dvander@159
    69
                LEN -> LENEXT or LIT or TYPE
dvander@159
    70
                LENEXT -> DIST -> DISTEXT -> MATCH -> LEN
dvander@159
    71
                LIT -> LEN
dvander@159
    72
    Process trailer:
dvander@159
    73
        CHECK -> LENGTH -> DONE
dvander@159
    74
 */
dvander@159
    75
dvander@159
    76
/* state maintained between inflate() calls.  Approximately 7K bytes. */
dvander@159
    77
struct inflate_state {
dvander@159
    78
    inflate_mode mode;          /* current inflate mode */
dvander@159
    79
    int last;                   /* true if processing last block */
dvander@159
    80
    int wrap;                   /* bit 0 true for zlib, bit 1 true for gzip */
dvander@159
    81
    int havedict;               /* true if dictionary provided */
dvander@159
    82
    int flags;                  /* gzip header method and flags (0 if zlib) */
dvander@159
    83
    unsigned dmax;              /* zlib header max distance (INFLATE_STRICT) */
dvander@159
    84
    unsigned long check;        /* protected copy of check value */
dvander@159
    85
    unsigned long total;        /* protected copy of output count */
dvander@159
    86
    gz_headerp head;            /* where to save gzip header information */
dvander@159
    87
        /* sliding window */
dvander@159
    88
    unsigned wbits;             /* log base 2 of requested window size */
dvander@159
    89
    unsigned wsize;             /* window size or zero if not using window */
dvander@159
    90
    unsigned whave;             /* valid bytes in the window */
dvander@159
    91
    unsigned write;             /* window write index */
dvander@159
    92
    unsigned char FAR *window;  /* allocated sliding window, if needed */
dvander@159
    93
        /* bit accumulator */
dvander@159
    94
    unsigned long hold;         /* input bit accumulator */
dvander@159
    95
    unsigned bits;              /* number of bits in "in" */
dvander@159
    96
        /* for string and stored block copying */
dvander@159
    97
    unsigned length;            /* literal or length of data to copy */
dvander@159
    98
    unsigned offset;            /* distance back to copy string from */
dvander@159
    99
        /* for table and code decoding */
dvander@159
   100
    unsigned extra;             /* extra bits needed */
dvander@159
   101
        /* fixed and dynamic code tables */
dvander@159
   102
    code const FAR *lencode;    /* starting table for length/literal codes */
dvander@159
   103
    code const FAR *distcode;   /* starting table for distance codes */
dvander@159
   104
    unsigned lenbits;           /* index bits for lencode */
dvander@159
   105
    unsigned distbits;          /* index bits for distcode */
dvander@159
   106
        /* dynamic table building */
dvander@159
   107
    unsigned ncode;             /* number of code length code lengths */
dvander@159
   108
    unsigned nlen;              /* number of length code lengths */
dvander@159
   109
    unsigned ndist;             /* number of distance code lengths */
dvander@159
   110
    unsigned have;              /* number of code lengths in lens[] */
dvander@159
   111
    code FAR *next;             /* next available space in codes[] */
dvander@159
   112
    unsigned short lens[320];   /* temporary storage for code lengths */
dvander@159
   113
    unsigned short work[288];   /* work area for code table building */
dvander@159
   114
    code codes[ENOUGH];         /* space for code tables */
dvander@159
   115
};