chipz

API Reference

chipz

A library for decompressing deflate, zlib, and gzip data

CHIPZ

  • Condition CHIPZ-ERROR  (SIMPLE-ERROR)
    The base condition of the CHIPZ library. All other conditions inherit from this error.
  • Condition DECOMPRESSION-ERROR  (CHIPZ-ERROR)
    The base condition of all conditions signaled during decompression.
  • Condition INVALID-FORMAT-ERROR  (CHIPZ-ERROR)
    Signaled when an invalid format name is passed to MAKE-DSTATE, MAKE-INFLATE-STATE, or DECOMPRESS.
  • Condition INVALID-CHECKSUM-ERROR  (DECOMPRESSION-ERROR)
    Signaled when the checksum of decompressed data does not match the expected value.
  • Condition PREMATURE-END-OF-STREAM  (DECOMPRESSION-ERROR)
    Signaled when FINISH-DSTATE is called on a state that has not actually reached the end of the input being decompressed.
  • Condition INFLATE-ERROR  (DECOMPRESSION-ERROR)
    The base condition of conditions signaled when decompressing DEFLATE-related formats.
  • Condition INVALID-ZLIB-HEADER-ERROR  (INFLATE-ERROR)
    Signaled when a zlib header does not pass the consistency check.
  • Condition INVALID-GZIP-HEADER-ERROR  (INFLATE-ERROR)
    Signaled when a gzip header does not have the proper ID.
  • Condition RESERVED-BLOCK-TYPE-ERROR  (INFLATE-ERROR)
    Signaled when an invalid deflate block is found.
  • Condition INVALID-STORED-BLOCK-LENGTH-ERROR  (INFLATE-ERROR)
    Signaled when a stored block's length does not pass the consistency check.
  • Condition BZIP2-ERROR  (DECOMPRESSION-ERROR)
    The base condition of conditions signaled when decompressing BZIP2-related formats.
  • Condition INVALID-BZIP2-DATA  (BZIP2-ERROR)
    Signaled when invalid bzip2 data is found.
  • Struct DECOMPRESSION-STATE
    STATE
    DONE
    INPUT
    INPUT-START
    INPUT-INDEX
    INPUT-END
    OUTPUT
    OUTPUT-START
    OUTPUT-INDEX
    OUTPUT-END
    CHECKSUM
    UPDATE-CHECKSUM
    BITS
    N-BITS
  • Function MAKE-DSTATE (format)
    Return a structure suitable for uncompressing data in DATA-FORMAT; DATA-FORMAT should be: :BZIP2 or CHIPZ:BZIP2 For decompressing data in the `bzip2' format; :GZIP or CHIPZ:GZIP For decompressing data in the `gzip' format; :ZLIB or CHIPZ:ZLIB For decompressing data in the `zlib' format; :DEFLATE or CHIPZ:DEFLATE For decompressing data in the `deflate' format. The usual value of DATA-FORMAT will be one of CHIPZ:BZIP2 or CHIPZ:GZIP.
  • Function FINISH-DSTATE (state)
  • Struct INFLATE-STATE
    FINAL-BLOCK-P
    LENGTH
    DISTANCE
    LENGTH-CODE
    DISTANCE-CODE
    N-LENGTH-CODES
    N-DISTANCE-CODES
    N-CODES
    N-VALUES-READ
    CODE-LENGTHS
    WINDOW
    WINDOW-INDEX
    CODES-TABLE
    LITERAL/LENGTH-TABLE
    DISTANCE-TABLE
    HEADER
    DATA-FORMAT
  • Function MAKE-INFLATE-STATE (format)
    Return a INFLATE-STATE structure suitable for uncompressing data in FORMAT; FORMAT should be: :GZIP or CHIPZ:GZIP For decompressing data in the `gzip' format; :ZLIB or CHIPZ:ZLIB For decompressing data in the `zlib' format; :DEFLATE or CHIPZ:DEFLATE For decompressing data in the `deflate' format. The usual value of FORMAT will be one of CHIPZ:GZIP or CHIPZ:ZLIB.
  • Function FINISH-INFLATE-STATE (state)
  • Struct BZIP2-STATE
    OUT-CH
    OUT-LEN
    BLOCK-RANDOMIZED-P
    RNTOGO
    RNTPOS
    100K-BLOCK-SIZE
    SMALL-DECOMPRESSION-P
    CURRENT-BLOCK-NUMBER
    ORIGINAL-POINTER
    T-POSITION
    K0
    UNZFTAB
    N-BLOCKS-USED
    CFTAB
    CFTAB-COPY
    TT
    STORED-BLOCK-CRC
    STORED-COMBINED-CRC
    CALCULATED-BLOCK-CRC
    CALCULATED-COMBINED-CRC
    N-IN-USE
    IN-USE
    IN-USE-16
    SEQ-TO-UNSEQ
    MTFA
    MTFBASE
    SELECTOR
    SELECTOR-MTF
    LEN
    MTF-CONTINUATION
    LIMIT
    BASE
    PERM
    MIN-LENGTHS
    I
    J
    ALPHA-SIZE
    N-GROUPS
    N-SELECTORS
    EOB
    GROUP-NUMBER
    GROUP-POSITION
    LVAL
    NBLOCKMAX
    NBLOCK
    ES
    N
    CURR
    ZN
    ZVEC
    G-MINLEN
    G-LIMIT
    G-BASE
    G-PERM
  • Generic-Function DECOMPRESS (output state input &key &allow-other-keys)
  • Method DECOMPRESS (output format (input list) &rest keys)
  • Method DECOMPRESS (output format (input list) &rest keys)
  • Method DECOMPRESS (output format (input list) &rest keys)
  • Method DECOMPRESS (output format input &rest keys)
  • Method DECOMPRESS (output format input &rest keys)
  • Method DECOMPRESS (output format input &rest keys)
  • Method DECOMPRESS ((output null) (state decompression-state) (input pathname) &key)
  • Method DECOMPRESS ((output pathname) (state decompression-state) (input pathname) &key buffer-size)
  • Method DECOMPRESS ((output stream) (state decompression-state) (input pathname) &key buffer-size)
  • Method DECOMPRESS ((output null) (state decompression-state) (input vector) &key (input-start 0) input-end buffer-size)
  • Method DECOMPRESS ((output null) (state decompression-state) (input stream) &key buffer-size)
  • Method DECOMPRESS ((output vector) (state decompression-state) (input vector) &key (input-start 0) input-end (output-start 0) output-end)
  • Method DECOMPRESS ((output stream) (state decompression-state) (input vector) &key (input-start 0) input-end)
  • Method DECOMPRESS ((output stream) (state decompression-state) (input stream) &key)
  • Function MAKE-DECOMPRESSING-STREAM (format stream)