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