The zlib Reference Manual

Table of Contents

The zlib Reference Manual

This is the zlib Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 12:39:36 2020 GMT+0.

1 Introduction

zlib

What

It's a Common Lisp zlib implementation (i.e. it's not using FFI).

Maintainer and Project Home

The package was abandoned and then taken over by github.com/sharplispers.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 zlib

Source

zlib.asd (file)

Components

• package.lisp (file)
• zlib.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 zlib.asd

Location

zlib.asd

Systems

zlib (system)

Packages

zlib-system

3.1.2 zlib/package.lisp

Parent

zlib (system)

Location

package.lisp

Packages

zlib

3.1.3 zlib/zlib.lisp

Parent

zlib (system)

Location

zlib.lisp

Exported Definitions

• compress (function)
• uncompress (function)

Internal Definitions

• *debug-level* (special variable)
• *debug-stream* (special variable)
• +adler-base+ (constant)
• +deflate-max-hash-table-contents-length+ (constant)
• +distance-encoding+ (special variable)
• +dynamic-huffman-code-lengths-order+ (special variable)
• +fixed-huffman-code-bitlist+ (special variable)
• +fixed-huffman-code-lengths+ (special variable)
• +fixed-huffman-codes+ (special variable)
• +huffman-end-of-block-symbol+ (constant)
• +length-encoding+ (special variable)
• +max-distance+ (constant)
• +max-length+ (constant)
• +max-non-compressed-block-size+ (constant)
• +min-distance+ (constant)
• +min-length+ (constant)
• +zlib-major-version+ (constant)
• +zlib-minor-version+ (constant)
• add-hash-value (function)
• adler-32 (function)
• bit-list-from-value (function)
• bit-stream (structure)
• bit-stream-bytes (function)
• (setf bit-stream-bytes) (function)
• bit-stream-p (function)
• bit-stream-pad-to-byte-boundary (function)
• bit-stream-position (function)
• (setf bit-stream-position) (function)
• bit-stream-read-bit (function)
• bit-stream-read-bits (function)
• bit-stream-read-byte (function)
• bit-stream-read-length-and-distance (function)
• bit-stream-read-n-bytes (function)
• bit-stream-read-reversed-bit (function)
• bit-stream-read-reversed-bits (function)
• bit-stream-read-symbol (function)
• bit-stream-write-bit (function)
• bit-stream-write-bits (function)
• bit-stream-write-bits2 (function)
• bit-stream-write-byte (function)
• bit-vector-from-value (function)
• copy-bit-stream (function)
• debug-format-1 (macro)
• debug-format-2 (macro)
• decision-tree (macro)
• decode-dynamic-huffman-block (function)
• decode-fixed-huffman-block (function)
• decode-non-compressed-block (function)
• distance-code (function)
• distance-code-bits (function)
• distance-code-bits2 (function)
• encode-dynamic-huffman-block (function)
• encode-fixed-huffman-block (function)
• encode-non-compressed-block (function)
• extra-distance-bits (function)
• extra-length-bits (function)
• find-best-match (function)
• fixed-huffman-code (function)
• fixed-huffman-code2 (function)
• huffman-insert-element (function)
• infix-to-tree (function)
• length-code (function)
• make-bit-stream (function)
• make-huffman-tree (function)
• map-tree-postfix (function)
• number-of-blocks (function)
• read-32-bits-from-array (function)
• read-huffman-code-lengths (function)
• update-adler-32 (function)

4 Packages

Packages are listed by definition order.

4.1 zlib-system

Source

zlib.asd

Use List

• common-lisp
• asdf/interface

4.2 zlib

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• compress (function)
• uncompress (function)

Internal Definitions

• *debug-level* (special variable)
• *debug-stream* (special variable)
• +adler-base+ (constant)
• +deflate-max-hash-table-contents-length+ (constant)
• +distance-encoding+ (special variable)
• +dynamic-huffman-code-lengths-order+ (special variable)
• +fixed-huffman-code-bitlist+ (special variable)
• +fixed-huffman-code-lengths+ (special variable)
• +fixed-huffman-codes+ (special variable)
• +huffman-end-of-block-symbol+ (constant)
• +length-encoding+ (special variable)
• +max-distance+ (constant)
• +max-length+ (constant)
• +max-non-compressed-block-size+ (constant)
• +min-distance+ (constant)
• +min-length+ (constant)
• +zlib-major-version+ (constant)
• +zlib-minor-version+ (constant)
• add-hash-value (function)
• adler-32 (function)
• bit-list-from-value (function)
• bit-stream (structure)
• bit-stream-bytes (function)
• (setf bit-stream-bytes) (function)
• bit-stream-p (function)
• bit-stream-pad-to-byte-boundary (function)
• bit-stream-position (function)
• (setf bit-stream-position) (function)
• bit-stream-read-bit (function)
• bit-stream-read-bits (function)
• bit-stream-read-byte (function)
• bit-stream-read-length-and-distance (function)
• bit-stream-read-n-bytes (function)
• bit-stream-read-reversed-bit (function)
• bit-stream-read-reversed-bits (function)
• bit-stream-read-symbol (function)
• bit-stream-write-bit (function)
• bit-stream-write-bits (function)
• bit-stream-write-bits2 (function)
• bit-stream-write-byte (function)
• bit-vector-from-value (function)
• copy-bit-stream (function)
• debug-format-1 (macro)
• debug-format-2 (macro)
• decision-tree (macro)
• decode-dynamic-huffman-block (function)
• decode-fixed-huffman-block (function)
• decode-non-compressed-block (function)
• distance-code (function)
• distance-code-bits (function)
• distance-code-bits2 (function)
• encode-dynamic-huffman-block (function)
• encode-fixed-huffman-block (function)
• encode-non-compressed-block (function)
• extra-distance-bits (function)
• extra-length-bits (function)
• find-best-match (function)
• fixed-huffman-code (function)
• fixed-huffman-code2 (function)
• huffman-insert-element (function)
• infix-to-tree (function)
• length-code (function)
• make-bit-stream (function)
• make-huffman-tree (function)
• map-tree-postfix (function)
• number-of-blocks (function)
• read-32-bits-from-array (function)
• read-huffman-code-lengths (function)
• update-adler-32 (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: compress BUFFER BTYPE

Compresses BUFFER using deflate algorithm of type BTYPE. Recognized types are :NO-COMPRESSION, :FIXED and :DYNAMIC.

Package

zlib

Source

zlib.lisp (file)

Function: uncompress BUFFER &key UNCOMPRESSED-SIZE OUTPUT-BUFFER START END

Uncompresses BUFFER. Returns a vector of bytes containing the uncompressed data, and the length of the uncompressed data.
UNCOMPRESSED-SIZE is a hint to set the result buffer size.
If UNCOMPRESSED-SIZE is not specified it is set as double of comressed BUFFER size.
If OUTPUT-BUFFER is specified, the result will be written to this buffer, and the UNCOMPRESSED-SIZE is ignored.
Otherwise (default) a new array will be created of size UNCOMPRESSED-SIZE START specifies the start position in the BUFFER (0 by default)
END specifies the end position in the BUFFER (length of BUFFER by default)

Package

zlib

Source

zlib.lisp (file)

5.2 Internal definitions

5.2.1 Constants

Constant: +adler-base+

Package

zlib

Source

zlib.lisp (file)

Constant: +deflate-max-hash-table-contents-length+

Package

zlib

Source

zlib.lisp (file)

Constant: +huffman-end-of-block-symbol+

Package

zlib

Source

zlib.lisp (file)

Constant: +max-distance+

Package

zlib

Source

zlib.lisp (file)

Constant: +max-length+

Package

zlib

Source

zlib.lisp (file)

Constant: +max-non-compressed-block-size+

Package

zlib

Source

zlib.lisp (file)

Constant: +min-distance+

Package

zlib

Source

zlib.lisp (file)

Constant: +min-length+

Package

zlib

Source

zlib.lisp (file)

Constant: +zlib-major-version+

Package

zlib

Source

zlib.lisp (file)

Constant: +zlib-minor-version+

Package

zlib

Source

zlib.lisp (file)

5.2.2 Special variables

Special Variable: *debug-level*

Package

zlib

Source

zlib.lisp (file)

Special Variable: *debug-stream*

Package

zlib

Source

zlib.lisp (file)

Special Variable: +distance-encoding+

Gives the relationship between a code, and extra bits and distance

Package

zlib

Source

zlib.lisp (file)

Special Variable: +dynamic-huffman-code-lengths-order+

Package

zlib

Source

zlib.lisp (file)

Special Variable: +fixed-huffman-code-bitlist+

Package

zlib

Source

zlib.lisp (file)

Special Variable: +fixed-huffman-code-lengths+

The number of bits used to represent a code length

Package

zlib

Source

zlib.lisp (file)

Special Variable: +fixed-huffman-codes+

Package

zlib

Source

zlib.lisp (file)

Special Variable: +length-encoding+

Gives the relationship between a code, and extra bits and length

Package

zlib

Source

zlib.lisp (file)

5.2.3 Macros

Macro: debug-format-1 &body BODY

Package

zlib

Source

zlib.lisp (file)

Macro: debug-format-2 &body BODY

Package

zlib

Source

zlib.lisp (file)

Macro: decision-tree EXPRESSION &rest CLAUSES

CLAUSES: Each clause is of the forms:
(less|:less . <body>) ; must be the first clause if present. (<real> . <body>)
DO: Evaluate the expression, which must be a real,
and generate a binary decision tree to select the <body> of the clause whose limit is <= the expression and
the next clause limit is > the expression.

Package

zlib

Source

zlib.lisp (file)

5.2.4 Functions

Function: add-hash-value HASH-TABLE HASH-VALUE INDEX

Remove oldest hash-value index from HASH-TABLE (if necessary) and push INDEX into HASH-TABLE

Package

zlib

Source

zlib.lisp (file)

Function: adler-32 BUFFER

Compute Adler-32 checksum of BUFFER. Based on the sample code in appendix C of RFC 1950. update-adler-32 does all the work

Package

zlib

Source

zlib.lisp (file)

Function: bit-list-from-value VALUE LENGTH

Return a list with a bit representation of VALUE. The list has LENGTH elements

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-bytes INSTANCE

Function: (setf bit-stream-bytes) VALUE INSTANCE

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-p OBJECT

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-pad-to-byte-boundary BIT-STREAM

If necessary, pads the current byte in BIT-STREAM with zeroes

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-position INSTANCE

Function: (setf bit-stream-position) VALUE INSTANCE

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-read-bit BIT-STREAM

Return the next bit from BIT-STREAM

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-read-bits BIT-STREAM N

Read N bits from BIT-STREAM

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-read-byte BIT-STREAM

Read the next byte (8 bits) from BIT-STREAM

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-read-length-and-distance BIT-STREAM CODE &optional DISTANCE-HUFFMAN-TREE

Find the length and distance for CODE from BIT-STREAM and return them

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-read-n-bytes BIT-STREAM N

Read N bytes from BIT-STREAM

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-read-reversed-bit BIT-STREAM

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-read-reversed-bits BIT-STREAM N

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-read-symbol BIT-STREAM HUFFMAN-TREE

Read bits from BIT-STREAM and find the corresponding symbol in HUFFMAN-TREE

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-write-bit BIT-STREAM BIT

Write BIT to BIT-STREAM

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-write-bits BIT-STREAM BIT-LIST

Write bits from BIT-LIST to BIT-STREAM

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-write-bits2 BIT-STREAM BIT-VECTOR

Package

zlib

Source

zlib.lisp (file)

Function: bit-stream-write-byte BIT-STREAM BYTE

Write BYTE to BIT-STREAM

Package

zlib

Source

zlib.lisp (file)

Function: bit-vector-from-value VALUE LENGTH

Package

zlib

Source

zlib.lisp (file)

Function: copy-bit-stream INSTANCE

Package

zlib

Source

zlib.lisp (file)

Function: decode-dynamic-huffman-block ()

Decode one block in BIT-STREAM with dynamic Huffman coding and store the result in RESULT

Package

zlib

Source

zlib.lisp (file)

Function: decode-fixed-huffman-block BIT-STREAM RESULT

Decode one block in BIT-STREAM with fixed Huffman coding and store the result in RESULT.

Package

zlib

Source

zlib.lisp (file)

Function: decode-non-compressed-block BIT-STREAM RESULT

Decode one non-compressed block in BIT-STREAM and store the result in RESULT

Package

zlib

Source

zlib.lisp (file)

Function: distance-code DISTANCE

Return the distance-code for a given DISTANCE

Package

zlib

Source

zlib.lisp (file)

Function: distance-code-bits CODE

Return a list with 5 elements that are the binary representation of CODE.

Package

zlib

Source

zlib.lisp (file)

Function: distance-code-bits2 CODE

Package

zlib

Source

zlib.lisp (file)

Function: encode-dynamic-huffman-block BIT-STREAM BUFFER

Package

zlib

Source

zlib.lisp (file)

Function: encode-fixed-huffman-block BIT-STREAM BUFFER HASH-TABLE START END

Encode a DEFLATE block using the fixed Huffman code method

Package

zlib

Source

zlib.lisp (file)

Function: encode-non-compressed-block BIT-STREAM BUFFER START END

Encode a DEFLATE block using the non-compressing method

Package

zlib

Source

zlib.lisp (file)

Function: extra-distance-bits DISTANCE

The number of extra distance bits that are needed for a given DISTANCE.

Package

zlib

Source

zlib.lisp (file)

Function: extra-length-bits LENGTH

The number of extra length bits that are needed for a given DISTANCE.

Package

zlib

Source

zlib.lisp (file)

Function: find-best-match BUFFER MATCH INDEX

Searches all elements in MATCH to find the one with the lowest position. INDEX is the index to the current position in BUFFER

Package

zlib

Source

zlib.lisp (file)

Function: fixed-huffman-code SYMBOL

Return the code for the given SYMBOL.

Package

zlib

Source

zlib.lisp (file)

Function: fixed-huffman-code2 SYMBOL

Package

zlib

Source

zlib.lisp (file)

Function: huffman-insert-element TREE LENGTH CODE SYMBOL

Insert SYMBOL into TREE

Package

zlib

Source

zlib.lisp (file)

Function: infix-to-tree SEQUENCE

Package

zlib

Source

zlib.lisp (file)

Function: length-code LENGTH

Return the length-code for a given LENGTH

Package

zlib

Source

zlib.lisp (file)

Function: make-bit-stream &key (BYTES BYTES) (POSITION POSITION)

Package

zlib

Source

zlib.lisp (file)

Function: make-huffman-tree HUFFMAN-CODE-LENGTHS

Create a Huffman tree from HUFFMAN-CODE-LENGTHS

Package

zlib

Source

zlib.lisp (file)

Function: map-tree-postfix FUN TREE

Package

zlib

Source

zlib.lisp (file)

Function: number-of-blocks BUFFER BTYPE

Return the number of blocks that should be used to encode the BUFFER.

Package

zlib

Source

zlib.lisp (file)

Function: read-32-bits-from-array ARRAY &optional START

Read a 32-bit word from ARRAY, MSB first starting from position START

Package

zlib

Source

zlib.lisp (file)

Function: read-huffman-code-lengths BIT-STREAM HUFFMAN-TREE ITEMS

Package

zlib

Source

zlib.lisp (file)

Function: update-adler-32 ADLER BUFFER

Package

zlib

Source

zlib.lisp (file)

5.2.5 Structures

Structure: bit-stream ()

Package

zlib

Source

zlib.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: bytes

Readers

bit-stream-bytes (function)

Writers

(setf bit-stream-bytes) (function)

Slot: position

Type

fixnum

Initform

0

Readers

bit-stream-position (function)

Writers

(setf bit-stream-position) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types