The 3bz Reference Manual

1 Introduction
2 Systems
- 2.1 3bz
3 Files
- 3.1 Lisp
4 Packages
- 4.1 3bz
5 Definitions
- 5.1 Exported definitions
- 5.2 Internal definitions
Appendix A Indexes

The 3bz Reference Manual

This is the 3bz Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 08:50:19 2021 GMT+0.

1 Introduction

Yet another CL impementation of rfc1951 deflate decompression (optionally with rfc1950 zlib or rfc1952 gzip wrappers), with support for reading from foreign pointers (for use with mmap and similar, etc), and from CL octet vectors and streams.

Still somewhat WIP, but approaching usability.

Performance for vectors/pointers is somewhere between FFI to libz and chipz, still needs some low-level optimization of copy routines and checksums. Stream API is very slow, and may be replaced at some point.

API isn't completely stable yet, needs some actual use to figure out the details.

API/usage

easy API:

decompress-vector (compressed &key (format :zlib) output

;; pass a (simple-array (unsigned-byte 8) (*))
(3bz:decompress-vector (alexandria:read-file-into-byte-vector "foo.gz")
                       :format :gzip) ;; accepts :deflate, :zlib, :gzip
;; ->
#(....)
1234
;; get back decompressed data and size as 2 values

If decompressed size is known, you can save some copies by passing in a pre-allocated (simple-array (unsigned-byte 8) (*)) vector with :OUTPUT.

full API:

Allows input and output in multiple pieces, as well as input from vectors, FFI pointers, or streams (streams are currently very slow though).

step 1: make a decompression state:

make-deflate-state, make-zlib-state, or make-gzip-state. Optionally with :output-buffer octet-vector to provide initial output buffer.
step 2: make an input context

make-octet-vector-context, make-octet-stream-context, or with-octet-pointer+make-octet-pointer-context.

pass source of coresponding type, + optional :start,:end,:offset to specify valid region within source. For FFI pointers, use (with-octet-pointer (octet-pointer ffi-pointer size) ...) to wrap a raw pointer + size into octet-pointer to pass to make-octet-pointer-context. (If you need indefinite scope pointers, file an issue so support that can be added to API.)
step 3: decompress

(decompress context state) returns current offset into output buffer.
step 4: check decompression state
- if (finished state), you are done.
- if (input-underrun state), you need to supply more input by creating a new input context, and call decompress again with new context.
- if (output-overflow state), you need to provide a new output buffer with (replace-output-buffer state new-buffer) and call decompress again.

performance notes:

Streams API is currently very slow, and will probably be rewritten at some point.
Output in small pieces is slow:

deflate needs to maintain a 32kb history window, so every time output buffer overflows, it copies 32kb of history. If output buffer is smaller than 32kb, that means more history is copied than total output, so avoid small output buffers.

Ideally, if output size is known in advance and output buffer never overflows, there is no extra copies for history window.

If output size isn't known, if you start with something like (min input-size 32768) and double (or at least scale by 1.x) on each overflow, there will only be O(N) bytes copied to combine output buffers, and O(lgN) byytes copied for history.

2 Systems

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

2.1 `3bz`

Author

Bart Botta

License

MIT

Description

deflate decompressor

Dependencies

alexandria
cffi (for feature (and (not mezzano) (not abcl)))
mmap (for feature (and (not mezzano) (not abcl)))
trivial-features
nibbles
babel

Source

3bz.asd (file)

Components

package.lisp (file)
tuning.lisp (file)
util.lisp (file)
constants.lisp (file)
types.lisp (file)
huffman-tree.lisp (file)
ht-constants.lisp (file)
io-common.lisp (file)
io-nommap.lisp (file)
io-mmap.lisp (file)
io.lisp (file)
deflate.lisp (file)
checksums.lisp (file)
zlib.lisp (file)
gzip.lisp (file)
api.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 `3bz.asd`

Location: 3bz.asd
Systems: 3bz (system)

3.1.2 `3bz/package.lisp`

Parent: 3bz (system)
Location: package.lisp
Packages: 3bz

3.1.3 `3bz/tuning.lisp`

Dependency

package.lisp (file)

Parent

3bz (system)

Location

tuning.lisp

Internal Definitions

+adler32-unroll+ (constant)
use-adler32 (function)
use-ub64 (function)

3.1.4 `3bz/util.lisp`

Dependency

tuning.lisp (file)

Parent

3bz (system)

Location

util.lisp

Internal Definitions

*bit-rev-table* (special variable)
*cached-struct-defs* (special variable)
bit-rev (function)
defstruct-cached (macro)
fixnum+ (macro)
ub64+ (macro)
with-cached-state (macro)
wrap-fixnum (macro)

3.1.5 `3bz/constants.lisp`

Dependency

util.lisp (file)

Parent

3bz (system)

Location

constants.lisp

Internal Definitions

+adler32-prime+ (constant)
+end-code+ (constant)
+extra-bits+ (constant)
+ht-invalid+ (constant)
+ht-len/dist+ (constant)
+ht-link/end+ (constant)
+ht-literal+ (constant)
+ht-max-bits+ (constant)
+len-code-extra+ (constant)
+len-code-order+ (constant)
+len/dist-bases+ (constant)
+lengths-end+ (constant)
+lengths-extra-bits-offset+ (constant)
+lengths-start+ (constant)
+max-tree-entries/dist+ (constant)
+max-tree-entries/len+ (constant)
+max-tree-size+ (constant)

3.1.6 `3bz/types.lisp`

Dependency

constants.lisp (file)

Parent

3bz (system)

Location

types.lisp

Internal Definitions

code-table-type (type)
ht-bit-count-type (type)
ht-node-array-type (type)
ht-node-type (type)
ht-offset-type (type)
non-negative-fixnum (type)
ub16 (type)
ub32 (type)
ub64 (type)
ub8 (type)

3.1.7 `3bz/huffman-tree.lisp`

Dependency

types.lisp (file)

Parent

3bz (system)

Location

huffman-tree.lisp

Internal Definitions

*fixed-dist-table* (special variable)
*fixed-lit/length-table* (special variable)
build-tree-part (function)
build-trees (function)
build-trees* (function)
copy-huffman-tree (function)
ht-dist-node (function)
ht-end-node (function)
ht-endp (function)
ht-extra-bits (function)
ht-invalid-node (function)
ht-invalidp (function)
ht-len-node (function)
ht-len/dist-p (function)
ht-link-bits (function)
ht-link-node (function)
ht-link-offset (function)
ht-linkp (function)
ht-literal-node (function)
ht-literalp (function)
ht-max-bits (function)
(setf ht-max-bits) (function)
ht-node-type (function)
ht-nodes (function)
(setf ht-nodes) (function)
ht-start-bits (function)
(setf ht-start-bits) (function)
ht-value (function)
huffman-tree (structure)
huffman-tree-p (function)
make-huffman-tree (function)

3.1.8 `3bz/ht-constants.lisp`

Dependency

huffman-tree.lisp (file)

Parent

3bz (system)

Location

ht-constants.lisp

Internal Definitions

%static-huffman-tree/dist% (special variable)
%static-huffman-tree/len% (special variable)
+static-huffman-tree/dist+ (constant)
+static-huffman-tree/len+ (constant)
+static-huffman-trees+ (constant)

3.1.9 `3bz/io-common.lisp`

Dependency

ht-constants.lisp (file)

Parent

3bz (system)

Location

io-common.lisp

Exported Definitions

%resync-file-stream (method)
%resync-file-stream (method)
make-octet-stream-context (function)
make-octet-vector-context (function)

Internal Definitions

boxes (method)
boxes (method)
cb-end (function)
(setf cb-end) (function)
cb-offset (function)
(setf cb-offset) (function)
cb-start (function)
(setf cb-start) (function)
context-boxes (structure)
context-boxes-p (function)
context-common (macro)
copy-context-boxes (function)
make-context-boxes (function)
octet (type)
octet-stream (method)
octet-stream-context (class)
octet-vector (method)
octet-vector (type)
octet-vector-context (class)
valid-octet-stream (function)

3.1.10 `3bz/io-nommap.lisp`

If Feature: (or mezzano abcl)
Dependency: io-common.lisp (file)
Parent: 3bz (system)
Location: io-nommap.lisp

3.1.11 `3bz/io-mmap.lisp`

If Feature

(and (not mezzano) (not abcl))

Dependencies

io-nommap.lisp (file)
io-common.lisp (file)

Parent

3bz (system)

Location

io-mmap.lisp

Exported Definitions

make-octet-pointer-context (function)
with-octet-pointer (macro)

Internal Definitions

%pointer (method)
base (method)
boxes (method)
octet-pointer (class)
octet-pointer-context (class)
offset-t (type)
op (method)
scope (method)
size (method)
size-t (type)
valid-octet-pointer (function)
with-pointer-context (macro)

3.1.12 `3bz/io.lisp`

Dependencies

io-mmap.lisp (file)
io-nommap.lisp (file)
io-common.lisp (file)

Parent

3bz (system)

Location

io.lisp

Internal Definitions

defun-with-reader-contexts (macro)
with-reader-contexts (macro)
with-stream-context (macro)
with-vector-context (macro)

3.1.13 `3bz/deflate.lisp`

Dependency

io.lisp (file)

Parent

3bz (system)

Location

deflate.lisp

Exported Definitions

make-deflate-state (function)

Internal Definitions

*stats* (special variable)
copy-deflate-state (function)
decompress-deflate (function)
decompress-deflate/pointer (function)
decompress-deflate/stream (function)
decompress-deflate/vector (function)
deflate-state (structure)
deflate-state-p (function)
ds-bits-remaining (function)
(setf ds-bits-remaining) (function)
ds-bytes-to-copy (function)
(setf ds-bytes-to-copy) (function)
ds-copy-offset (function)
(setf ds-copy-offset) (function)
ds-current-huffman-tree (function)
(setf ds-current-huffman-tree) (function)
ds-current-state (function)
(setf ds-current-state) (function)
ds-dht-hclen (function)
(setf ds-dht-hclen) (function)
ds-dht-hlit (function)
(setf ds-dht-hlit) (function)
ds-dht-hlit+hdist (function)
(setf ds-dht-hlit+hdist) (function)
ds-dht-last-len (function)
(setf ds-dht-last-len) (function)
ds-dht-len-codes (function)
(setf ds-dht-len-codes) (function)
ds-dht-len-tree (function)
(setf ds-dht-len-tree) (function)
ds-dht-lit/len/dist (function)
(setf ds-dht-lit/len/dist) (function)
ds-dht-lit/len/dist-index (function)
(setf ds-dht-lit/len/dist-index) (function)
ds-dynamic-huffman-tree (function)
(setf ds-dynamic-huffman-tree) (function)
ds-finished (function)
(setf ds-finished) (function)
ds-input-underrun (function)
(setf ds-input-underrun) (function)
ds-last-block-flag (function)
(setf ds-last-block-flag) (function)
ds-output-buffer (function)
(setf ds-output-buffer) (function)
ds-output-offset (function)
(setf ds-output-offset) (function)
ds-output-overflow (function)
(setf ds-output-overflow) (function)
ds-partial-bits (function)
(setf ds-partial-bits) (function)
ds-window (function)
(setf ds-window) (function)
state-machine (macro)

3.1.14 `3bz/checksums.lisp`

Dependency

deflate.lisp (file)

Parent

3bz (system)

Location

checksums.lisp

Internal Definitions

+accumulate-count+ (constant)
+crc32/table+ (constant)
adler32 (function)
adler32/fixnum (function)
adler32/ub32 (function)
adler32/ub64 (function)
crc32/table (function)
generate-crc32-table (function)

3.1.15 `3bz/zlib.lisp`

Dependency

checksums.lisp (file)

Parent

3bz (system)

Location

zlib.lisp

Exported Definitions

make-zlib-state (function)

Internal Definitions

check-zlib-header (function)
copy-zlib-state (function)
decompress-zlib (function)
zlib-state (structure)
zlib-state-p (function)
zs-bits-remaining (function)
(setf zs-bits-remaining) (function)
zs-bytes-to-copy (function)
(setf zs-bytes-to-copy) (function)
zs-compression-level (function)
(setf zs-compression-level) (function)
zs-compression-method (function)
(setf zs-compression-method) (function)
zs-copy-offset (function)
(setf zs-copy-offset) (function)
zs-current-huffman-tree (function)
(setf zs-current-huffman-tree) (function)
zs-current-state (function)
(setf zs-current-state) (function)
zs-dht-hclen (function)
(setf zs-dht-hclen) (function)
zs-dht-hlit (function)
(setf zs-dht-hlit) (function)
zs-dht-hlit+hdist (function)
(setf zs-dht-hlit+hdist) (function)
zs-dht-last-len (function)
(setf zs-dht-last-len) (function)
zs-dht-len-codes (function)
(setf zs-dht-len-codes) (function)
zs-dht-len-tree (function)
(setf zs-dht-len-tree) (function)
zs-dht-lit/len/dist (function)
(setf zs-dht-lit/len/dist) (function)
zs-dht-lit/len/dist-index (function)
(setf zs-dht-lit/len/dist-index) (function)
zs-dict-id (function)
(setf zs-dict-id) (function)
zs-dynamic-huffman-tree (function)
(setf zs-dynamic-huffman-tree) (function)
zs-finished (function)
(setf zs-finished) (function)
zs-input-underrun (function)
(setf zs-input-underrun) (function)
zs-last-block-flag (function)
(setf zs-last-block-flag) (function)
zs-output-buffer (function)
(setf zs-output-buffer) (function)
zs-output-offset (function)
(setf zs-output-offset) (function)
zs-output-overflow (function)
(setf zs-output-overflow) (function)
zs-partial-bits (function)
(setf zs-partial-bits) (function)
zs-s1 (function)
(setf zs-s1) (function)
zs-s2 (function)
(setf zs-s2) (function)
zs-window (function)
(setf zs-window) (function)
zs-window-size (function)
(setf zs-window-size) (function)
zs-zlib-state (function)
(setf zs-zlib-state) (function)

3.1.16 `3bz/gzip.lisp`

Dependency

zlib.lisp (file)

Parent

3bz (system)

Location

gzip.lisp

Exported Definitions

make-gzip-state (function)

Internal Definitions

copy-gzip-state (function)
decompress-gzip (function)
gs-bits-remaining (function)
(setf gs-bits-remaining) (function)
gs-bytes-to-copy (function)
(setf gs-bytes-to-copy) (function)
gs-comment (function)
(setf gs-comment) (function)
gs-compression-level (function)
(setf gs-compression-level) (function)
gs-compression-method (function)
(setf gs-compression-method) (function)
gs-copy-offset (function)
(setf gs-copy-offset) (function)
gs-crc32 (function)
(setf gs-crc32) (function)
gs-current-huffman-tree (function)
(setf gs-current-huffman-tree) (function)
gs-current-state (function)
(setf gs-current-state) (function)
gs-dht-hclen (function)
(setf gs-dht-hclen) (function)
gs-dht-hlit (function)
(setf gs-dht-hlit) (function)
gs-dht-hlit+hdist (function)
(setf gs-dht-hlit+hdist) (function)
gs-dht-last-len (function)
(setf gs-dht-last-len) (function)
gs-dht-len-codes (function)
(setf gs-dht-len-codes) (function)
gs-dht-len-tree (function)
(setf gs-dht-len-tree) (function)
gs-dht-lit/len/dist (function)
(setf gs-dht-lit/len/dist) (function)
gs-dht-lit/len/dist-index (function)
(setf gs-dht-lit/len/dist-index) (function)
gs-dynamic-huffman-tree (function)
(setf gs-dynamic-huffman-tree) (function)
gs-extra (function)
(setf gs-extra) (function)
gs-finished (function)
(setf gs-finished) (function)
gs-flags (function)
(setf gs-flags) (function)
gs-gzip-state (function)
(setf gs-gzip-state) (function)
gs-header-bytes (function)
(setf gs-header-bytes) (function)
gs-input-underrun (function)
(setf gs-input-underrun) (function)
gs-last-block-flag (function)
(setf gs-last-block-flag) (function)
gs-mtime/universal (function)
(setf gs-mtime/universal) (function)
gs-mtime/unix (function)
(setf gs-mtime/unix) (function)
gs-name (function)
(setf gs-name) (function)
gs-operating-system (function)
(setf gs-operating-system) (function)
gs-output-buffer (function)
(setf gs-output-buffer) (function)
gs-output-offset (function)
(setf gs-output-offset) (function)
gs-output-overflow (function)
(setf gs-output-overflow) (function)
gs-partial-bits (function)
(setf gs-partial-bits) (function)
gs-window (function)
(setf gs-window) (function)
gzip-state (structure)
gzip-state-p (function)

3.1.17 `3bz/api.lisp`

Dependency

gzip.lisp (file)

Parent

3bz (system)

Location

api.lisp

Exported Definitions

decompress (function)
decompress-vector (function)
finished (function)
input-underrun (function)
output-overflow (function)
replace-output-buffer (function)

4 Packages

Packages are listed by definition order.

4.1 `3bz`

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

%resync-file-stream (generic function)
%resync-file-stream (method)
%resync-file-stream (method)
decompress (function)
decompress-vector (function)
finished (function)
input-underrun (function)
make-deflate-state (function)
make-gzip-state (function)
make-octet-pointer-context (function)
make-octet-stream-context (function)
make-octet-vector-context (function)
make-zlib-state (function)
output-overflow (function)
replace-output-buffer (function)
with-octet-pointer (macro)

Internal Definitions

%pointer (generic function)
%pointer (method)
%static-huffman-tree/dist% (special variable)
%static-huffman-tree/len% (special variable)
*bit-rev-table* (special variable)
*cached-struct-defs* (special variable)
*fixed-dist-table* (special variable)
*fixed-lit/length-table* (special variable)
*stats* (special variable)
+accumulate-count+ (constant)
+adler32-prime+ (constant)
+adler32-unroll+ (constant)
+crc32/table+ (constant)
+end-code+ (constant)
+extra-bits+ (constant)
+ht-invalid+ (constant)
+ht-len/dist+ (constant)
+ht-link/end+ (constant)
+ht-literal+ (constant)
+ht-max-bits+ (constant)
+len-code-extra+ (constant)
+len-code-order+ (constant)
+len/dist-bases+ (constant)
+lengths-end+ (constant)
+lengths-extra-bits-offset+ (constant)
+lengths-start+ (constant)
+max-tree-entries/dist+ (constant)
+max-tree-entries/len+ (constant)
+max-tree-size+ (constant)
+static-huffman-tree/dist+ (constant)
+static-huffman-tree/len+ (constant)
+static-huffman-trees+ (constant)
adler32 (function)
adler32/fixnum (function)
adler32/ub32 (function)
adler32/ub64 (function)
base (generic function)
base (method)
bit-rev (function)
boxes (generic function)
boxes (method)
boxes (method)
boxes (method)
build-tree-part (function)
build-trees (function)
build-trees* (function)
cb-end (function)
(setf cb-end) (function)
cb-offset (function)
(setf cb-offset) (function)
cb-start (function)
(setf cb-start) (function)
check-zlib-header (function)
code-table-type (type)
context-boxes (structure)
context-boxes-p (function)
context-common (macro)
copy-context-boxes (function)
copy-deflate-state (function)
copy-gzip-state (function)
copy-huffman-tree (function)
copy-zlib-state (function)
crc32/table (function)
decompress-deflate (function)
decompress-deflate/pointer (function)
decompress-deflate/stream (function)
decompress-deflate/vector (function)
decompress-gzip (function)
decompress-zlib (function)
deflate-state (structure)
deflate-state-p (function)
defstruct-cached (macro)
defun-with-reader-contexts (macro)
ds-bits-remaining (function)
(setf ds-bits-remaining) (function)
ds-bytes-to-copy (function)
(setf ds-bytes-to-copy) (function)
ds-copy-offset (function)
(setf ds-copy-offset) (function)
ds-current-huffman-tree (function)
(setf ds-current-huffman-tree) (function)
ds-current-state (function)
(setf ds-current-state) (function)
ds-dht-hclen (function)
(setf ds-dht-hclen) (function)
ds-dht-hlit (function)
(setf ds-dht-hlit) (function)
ds-dht-hlit+hdist (function)
(setf ds-dht-hlit+hdist) (function)
ds-dht-last-len (function)
(setf ds-dht-last-len) (function)
ds-dht-len-codes (function)
(setf ds-dht-len-codes) (function)
ds-dht-len-tree (function)
(setf ds-dht-len-tree) (function)
ds-dht-lit/len/dist (function)
(setf ds-dht-lit/len/dist) (function)
ds-dht-lit/len/dist-index (function)
(setf ds-dht-lit/len/dist-index) (function)
ds-dynamic-huffman-tree (function)
(setf ds-dynamic-huffman-tree) (function)
ds-finished (function)
(setf ds-finished) (function)
ds-input-underrun (function)
(setf ds-input-underrun) (function)
ds-last-block-flag (function)
(setf ds-last-block-flag) (function)
ds-output-buffer (function)
(setf ds-output-buffer) (function)
ds-output-offset (function)
(setf ds-output-offset) (function)
ds-output-overflow (function)
(setf ds-output-overflow) (function)
ds-partial-bits (function)
(setf ds-partial-bits) (function)
ds-window (function)
(setf ds-window) (function)
fixnum+ (macro)
generate-crc32-table (function)
gs-bits-remaining (function)
(setf gs-bits-remaining) (function)
gs-bytes-to-copy (function)
(setf gs-bytes-to-copy) (function)
gs-comment (function)
(setf gs-comment) (function)
gs-compression-level (function)
(setf gs-compression-level) (function)
gs-compression-method (function)
(setf gs-compression-method) (function)
gs-copy-offset (function)
(setf gs-copy-offset) (function)
gs-crc32 (function)
(setf gs-crc32) (function)
gs-current-huffman-tree (function)
(setf gs-current-huffman-tree) (function)
gs-current-state (function)
(setf gs-current-state) (function)
gs-dht-hclen (function)
(setf gs-dht-hclen) (function)
gs-dht-hlit (function)
(setf gs-dht-hlit) (function)
gs-dht-hlit+hdist (function)
(setf gs-dht-hlit+hdist) (function)
gs-dht-last-len (function)
(setf gs-dht-last-len) (function)
gs-dht-len-codes (function)
(setf gs-dht-len-codes) (function)
gs-dht-len-tree (function)
(setf gs-dht-len-tree) (function)
gs-dht-lit/len/dist (function)
(setf gs-dht-lit/len/dist) (function)
gs-dht-lit/len/dist-index (function)
(setf gs-dht-lit/len/dist-index) (function)
gs-dynamic-huffman-tree (function)
(setf gs-dynamic-huffman-tree) (function)
gs-extra (function)
(setf gs-extra) (function)
gs-finished (function)
(setf gs-finished) (function)
gs-flags (function)
(setf gs-flags) (function)
gs-gzip-state (function)
(setf gs-gzip-state) (function)
gs-header-bytes (function)
(setf gs-header-bytes) (function)
gs-input-underrun (function)
(setf gs-input-underrun) (function)
gs-last-block-flag (function)
(setf gs-last-block-flag) (function)
gs-mtime/universal (function)
(setf gs-mtime/universal) (function)
gs-mtime/unix (function)
(setf gs-mtime/unix) (function)
gs-name (function)
(setf gs-name) (function)
gs-operating-system (function)
(setf gs-operating-system) (function)
gs-output-buffer (function)
(setf gs-output-buffer) (function)
gs-output-offset (function)
(setf gs-output-offset) (function)
gs-output-overflow (function)
(setf gs-output-overflow) (function)
gs-partial-bits (function)
(setf gs-partial-bits) (function)
gs-window (function)
(setf gs-window) (function)
gzip-state (structure)
gzip-state-p (function)
ht-bit-count-type (type)
ht-dist-node (function)
ht-end-node (function)
ht-endp (function)
ht-extra-bits (function)
ht-invalid-node (function)
ht-invalidp (function)
ht-len-node (function)
ht-len/dist-p (function)
ht-link-bits (function)
ht-link-node (function)
ht-link-offset (function)
ht-linkp (function)
ht-literal-node (function)
ht-literalp (function)
ht-max-bits (function)
(setf ht-max-bits) (function)
ht-node-array-type (type)
ht-node-type (function)
ht-node-type (type)
ht-nodes (function)
(setf ht-nodes) (function)
ht-offset-type (type)
ht-start-bits (function)
(setf ht-start-bits) (function)
ht-value (function)
huffman-tree (structure)
huffman-tree-p (function)
make-context-boxes (function)
make-huffman-tree (function)
non-negative-fixnum (type)
octet (type)
octet-pointer (class)
octet-pointer-context (class)
octet-stream (generic function)
octet-stream (method)
octet-stream-context (class)
octet-vector (generic function)
octet-vector (method)
octet-vector (type)
octet-vector-context (class)
offset-t (type)
op (generic function)
op (method)
scope (generic function)
scope (method)
size (generic function)
size (method)
size-t (type)
state-machine (macro)
ub16 (type)
ub32 (type)
ub64 (type)
ub64+ (macro)
ub8 (type)
use-adler32 (function)
use-ub64 (function)
valid-octet-pointer (function)
valid-octet-stream (function)
with-cached-state (macro)
with-pointer-context (macro)
with-reader-contexts (macro)
with-stream-context (macro)
with-vector-context (macro)
wrap-fixnum (macro)
zlib-state (structure)
zlib-state-p (function)
zs-bits-remaining (function)
(setf zs-bits-remaining) (function)
zs-bytes-to-copy (function)
(setf zs-bytes-to-copy) (function)
zs-compression-level (function)
(setf zs-compression-level) (function)
zs-compression-method (function)
(setf zs-compression-method) (function)
zs-copy-offset (function)
(setf zs-copy-offset) (function)
zs-current-huffman-tree (function)
(setf zs-current-huffman-tree) (function)
zs-current-state (function)
(setf zs-current-state) (function)
zs-dht-hclen (function)
(setf zs-dht-hclen) (function)
zs-dht-hlit (function)
(setf zs-dht-hlit) (function)
zs-dht-hlit+hdist (function)
(setf zs-dht-hlit+hdist) (function)
zs-dht-last-len (function)
(setf zs-dht-last-len) (function)
zs-dht-len-codes (function)
(setf zs-dht-len-codes) (function)
zs-dht-len-tree (function)
(setf zs-dht-len-tree) (function)
zs-dht-lit/len/dist (function)
(setf zs-dht-lit/len/dist) (function)
zs-dht-lit/len/dist-index (function)
(setf zs-dht-lit/len/dist-index) (function)
zs-dict-id (function)
(setf zs-dict-id) (function)
zs-dynamic-huffman-tree (function)
(setf zs-dynamic-huffman-tree) (function)
zs-finished (function)
(setf zs-finished) (function)
zs-input-underrun (function)
(setf zs-input-underrun) (function)
zs-last-block-flag (function)
(setf zs-last-block-flag) (function)
zs-output-buffer (function)
(setf zs-output-buffer) (function)
zs-output-offset (function)
(setf zs-output-offset) (function)
zs-output-overflow (function)
(setf zs-output-overflow) (function)
zs-partial-bits (function)
(setf zs-partial-bits) (function)
zs-s1 (function)
(setf zs-s1) (function)
zs-s2 (function)
(setf zs-s2) (function)
zs-window (function)
(setf zs-window) (function)
zs-window-size (function)
(setf zs-window-size) (function)
zs-zlib-state (function)
(setf zs-zlib-state) (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: with-octet-pointer (VAR POINTER SIZE) &body BODY

Package: 3bz
Source: io-mmap.lisp (file)

5.1.2 Functions

Function: decompress CONTEXT STATE

Package: 3bz
Source: api.lisp (file)

Function: decompress-vector COMPRESSED &key FORMAT START END OUTPUT

decompress octet-vector COMPRESSED using
FORMAT (:deflate,:zlib,:gzip). If output is supplied, it should be an octet-vector large enough to hold entire uncompressed output.

Returns buffer containing decompressed data (OUTPUT if supplied) and # of octets decompressed.

Package: 3bz
Source: api.lisp (file)

Function: finished STATE

Package: 3bz
Source: api.lisp (file)

Function: input-underrun STATE

Package: 3bz
Source: api.lisp (file)

Function: make-deflate-state &key (CURRENT-STATE CURRENT-STATE) (LAST-BLOCK-FLAG LAST-BLOCK-FLAG) (DYNAMIC-HUFFMAN-TREE DYNAMIC-HUFFMAN-TREE) (CURRENT-HUFFMAN-TREE CURRENT-HUFFMAN-TREE) (DHT-HLIT DHT-HLIT) (DHT-HLIT+HDIST DHT-HLIT+HDIST) (DHT-HCLEN DHT-HCLEN) (DHT-LEN-CODES DHT-LEN-CODES) (DHT-LEN-TREE DHT-LEN-TREE) (DHT-LIT/LEN/DIST DHT-LIT/LEN/DIST) (DHT-LIT/LEN/DIST-INDEX DHT-LIT/LEN/DIST-INDEX) (DHT-LAST-LEN DHT-LAST-LEN) (BYTES-TO-COPY BYTES-TO-COPY) (COPY-OFFSET COPY-OFFSET) (PARTIAL-BITS PARTIAL-BITS) (BITS-REMAINING BITS-REMAINING) (OUTPUT-OFFSET OUTPUT-OFFSET) (OUTPUT-BUFFER OUTPUT-BUFFER) (WINDOW WINDOW) (FINISHED FINISHED) (OUTPUT-OVERFLOW OUTPUT-OVERFLOW) (INPUT-UNDERRUN INPUT-UNDERRUN)

Package: 3bz
Source: deflate.lisp (file)

Function: make-gzip-state &key (CURRENT-STATE CURRENT-STATE) (LAST-BLOCK-FLAG LAST-BLOCK-FLAG) (DYNAMIC-HUFFMAN-TREE DYNAMIC-HUFFMAN-TREE) (CURRENT-HUFFMAN-TREE CURRENT-HUFFMAN-TREE) (DHT-HLIT DHT-HLIT) (DHT-HLIT+HDIST DHT-HLIT+HDIST) (DHT-HCLEN DHT-HCLEN) (DHT-LEN-CODES DHT-LEN-CODES) (DHT-LEN-TREE DHT-LEN-TREE) (DHT-LIT/LEN/DIST DHT-LIT/LEN/DIST) (DHT-LIT/LEN/DIST-INDEX DHT-LIT/LEN/DIST-INDEX) (DHT-LAST-LEN DHT-LAST-LEN) (BYTES-TO-COPY BYTES-TO-COPY) (COPY-OFFSET COPY-OFFSET) (PARTIAL-BITS PARTIAL-BITS) (BITS-REMAINING BITS-REMAINING) (OUTPUT-OFFSET OUTPUT-OFFSET) (OUTPUT-BUFFER OUTPUT-BUFFER) (WINDOW WINDOW) (FINISHED FINISHED) (OUTPUT-OVERFLOW OUTPUT-OVERFLOW) (INPUT-UNDERRUN INPUT-UNDERRUN) (GZIP-STATE GZIP-STATE) (COMPRESSION-METHOD COMPRESSION-METHOD) (FLAGS FLAGS) (EXTRA EXTRA) (NAME NAME) (COMMENT COMMENT) (OPERATING-SYSTEM OPERATING-SYSTEM) (MTIME/UNIX MTIME/UNIX) (MTIME/UNIVERSAL MTIME/UNIVERSAL) (COMPRESSION-LEVEL COMPRESSION-LEVEL) (HEADER-BYTES HEADER-BYTES) (CRC32 CRC32)

Package: 3bz
Source: gzip.lisp (file)

Function: make-octet-pointer-context OCTET-POINTER &key START OFFSET END

Package: 3bz
Source: io-mmap.lisp (file)

Function: make-octet-stream-context FILE-STREAM &key START OFFSET END

Package: 3bz
Source: io-common.lisp (file)

Function: make-octet-vector-context VECTOR &key START OFFSET END

Package: 3bz
Source: io-common.lisp (file)

Function: make-zlib-state &key (CURRENT-STATE CURRENT-STATE) (LAST-BLOCK-FLAG LAST-BLOCK-FLAG) (DYNAMIC-HUFFMAN-TREE DYNAMIC-HUFFMAN-TREE) (CURRENT-HUFFMAN-TREE CURRENT-HUFFMAN-TREE) (DHT-HLIT DHT-HLIT) (DHT-HLIT+HDIST DHT-HLIT+HDIST) (DHT-HCLEN DHT-HCLEN) (DHT-LEN-CODES DHT-LEN-CODES) (DHT-LEN-TREE DHT-LEN-TREE) (DHT-LIT/LEN/DIST DHT-LIT/LEN/DIST) (DHT-LIT/LEN/DIST-INDEX DHT-LIT/LEN/DIST-INDEX) (DHT-LAST-LEN DHT-LAST-LEN) (BYTES-TO-COPY BYTES-TO-COPY) (COPY-OFFSET COPY-OFFSET) (PARTIAL-BITS PARTIAL-BITS) (BITS-REMAINING BITS-REMAINING) (OUTPUT-OFFSET OUTPUT-OFFSET) (OUTPUT-BUFFER OUTPUT-BUFFER) (WINDOW WINDOW) (FINISHED FINISHED) (OUTPUT-OVERFLOW OUTPUT-OVERFLOW) (INPUT-UNDERRUN INPUT-UNDERRUN) (ZLIB-STATE ZLIB-STATE) (COMPRESSION-METHOD COMPRESSION-METHOD) (WINDOW-SIZE WINDOW-SIZE) (DICT-ID DICT-ID) (COMPRESSION-LEVEL COMPRESSION-LEVEL) (S1 S1) (S2 S2)

Package: 3bz
Source: zlib.lisp (file)

Function: output-overflow STATE

Package: 3bz
Source: api.lisp (file)

Function: replace-output-buffer STATE BUFFER

Package: 3bz
Source: api.lisp (file)

5.1.3 Generic functions

Generic Function: %resync-file-stream CONTEXT

Package

3bz

Methods

Method: %resync-file-stream (CONTEXT octet-stream-context)

Source: io-common.lisp (file)

Method: %resync-file-stream CONTEXT

Source: io-common.lisp (file)

5.2 Internal definitions

5.2.1 Constants

Constant: +accumulate-count+

Package: 3bz
Source: checksums.lisp (file)

Constant: +adler32-prime+

Package: 3bz
Source: constants.lisp (file)

Constant: +adler32-unroll+

Package: 3bz
Source: tuning.lisp (file)

Constant: +crc32/table+

Package: 3bz
Source: checksums.lisp (file)

Constant: +end-code+

Package: 3bz
Source: constants.lisp (file)

Constant: +extra-bits+

Package: 3bz
Source: constants.lisp (file)

Constant: +ht-invalid+

Package: 3bz
Source: constants.lisp (file)

Constant: +ht-len/dist+

Package: 3bz
Source: constants.lisp (file)

Constant: +ht-link/end+

Package: 3bz
Source: constants.lisp (file)

Constant: +ht-literal+

Package: 3bz
Source: constants.lisp (file)

Constant: +ht-max-bits+

Package: 3bz
Source: constants.lisp (file)

Constant: +len-code-extra+

Package: 3bz
Source: constants.lisp (file)

Constant: +len-code-order+

Package: 3bz
Source: constants.lisp (file)

Constant: +len/dist-bases+

Package: 3bz
Source: constants.lisp (file)

Constant: +lengths-end+

Package: 3bz
Source: constants.lisp (file)

Constant: +lengths-extra-bits-offset+

Package: 3bz
Source: constants.lisp (file)

Constant: +lengths-start+

Package: 3bz
Source: constants.lisp (file)

Constant: +max-tree-entries/dist+

Package: 3bz
Source: constants.lisp (file)

Constant: +max-tree-entries/len+

Package: 3bz
Source: constants.lisp (file)

Constant: +max-tree-size+

Package: 3bz
Source: constants.lisp (file)

Constant: +static-huffman-tree/dist+

Package: 3bz
Source: ht-constants.lisp (file)

Constant: +static-huffman-tree/len+

Package: 3bz
Source: ht-constants.lisp (file)

Constant: +static-huffman-trees+

Package: 3bz
Source: ht-constants.lisp (file)

5.2.2 Special variables

Special Variable: %static-huffman-tree/dist%

Package: 3bz
Source: ht-constants.lisp (file)

Special Variable: %static-huffman-tree/len%

Package: 3bz
Source: ht-constants.lisp (file)

Special Variable: *bit-rev-table*

Package: 3bz
Source: util.lisp (file)

Special Variable: *cached-struct-defs*

Package: 3bz
Source: util.lisp (file)

Special Variable: *fixed-dist-table*

Package: 3bz
Source: huffman-tree.lisp (file)

Special Variable: *fixed-lit/length-table*

Package: 3bz
Source: huffman-tree.lisp (file)

Special Variable: *stats*

Package: 3bz
Source: deflate.lisp (file)

5.2.3 Macros

Macro: context-common (BOXES) &body BODY

Package: 3bz
Source: io-common.lisp (file)

Macro: defstruct-cached NAME-AND-OPTIONS &body SLOTS

Package: 3bz
Source: util.lisp (file)

Macro: defun-with-reader-contexts BASE-NAME LAMBDA-LIST (IN) &body BODY

Package: 3bz
Source: io.lisp (file)

Macro: fixnum+ A B

Package: 3bz
Source: util.lisp (file)

Macro: state-machine (STATE) &body TAGBODY

Package: 3bz
Source: deflate.lisp (file)

Macro: ub64+ A B

Package: 3bz
Source: util.lisp (file)

Macro: with-cached-state (STRUCT TYPE SAVE-STATE-FUN &body VARS) &body BODY

Package: 3bz
Source: util.lisp (file)

Macro: with-pointer-context (CONTEXT) &body BODY

Package: 3bz
Source: io-mmap.lisp (file)

Macro: with-reader-contexts (CONTEXT) &body BODY

Package: 3bz
Source: io.lisp (file)

Macro: with-stream-context (CONTEXT) &body BODY

Package: 3bz
Source: io.lisp (file)

Macro: with-vector-context (CONTEXT) &body BODY

Package: 3bz
Source: io.lisp (file)

Macro: wrap-fixnum X

Package: 3bz
Source: util.lisp (file)

5.2.4 Functions

Function: adler32 BUF END S1 S2

Package: 3bz
Source: checksums.lisp (file)

Function: adler32/fixnum BUF END S1 S2

Package: 3bz
Source: checksums.lisp (file)

Function: adler32/ub32 BUF END S1 S2

Package: 3bz
Source: checksums.lisp (file)

Function: adler32/ub64 BUF END S1 S2

Package: 3bz
Source: checksums.lisp (file)

Function: bit-rev X BITS

Package: 3bz
Source: util.lisp (file)

Function: build-tree-part TREE TREE-OFFSET TABLE TYPE START END SCRATCH EXTRA-BITS

Package: 3bz
Source: huffman-tree.lisp (file)

Function: build-trees LTREE DTREE LIT/LEN DIST

Package: 3bz
Source: huffman-tree.lisp (file)

Function: build-trees* LTREE DTREE LIT/LEN/DIST MID END SCRATCH

Package: 3bz
Source: huffman-tree.lisp (file)

Function: cb-end INSTANCE

Function: (setf cb-end) VALUE INSTANCE

Package: 3bz
Source: io-common.lisp (file)

Function: cb-offset INSTANCE

Function: (setf cb-offset) VALUE INSTANCE

Package: 3bz
Source: io-common.lisp (file)

Function: cb-start INSTANCE

Function: (setf cb-start) VALUE INSTANCE

Package: 3bz
Source: io-common.lisp (file)

Function: check-zlib-header CMF FLG &key ERRORP

Package: 3bz
Source: zlib.lisp (file)

Function: context-boxes-p OBJECT

Package: 3bz
Source: io-common.lisp (file)

Function: copy-context-boxes INSTANCE

Package: 3bz
Source: io-common.lisp (file)

Function: copy-deflate-state INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: copy-gzip-state INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: copy-huffman-tree INSTANCE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: copy-zlib-state INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: crc32/table BUF END CRC

Package: 3bz
Source: checksums.lisp (file)

Function: decompress-deflate READ-CONTEXT STATE

Package: 3bz
Source: deflate.lisp (file)

Function: decompress-deflate/pointer READ-CONTEXT STATE

Package: 3bz
Source: deflate.lisp (file)

Function: decompress-deflate/stream READ-CONTEXT STATE

Package: 3bz
Source: deflate.lisp (file)

Function: decompress-deflate/vector READ-CONTEXT STATE

Package: 3bz
Source: deflate.lisp (file)

Function: decompress-gzip READ-CONTEXT STATE

Package: 3bz
Source: gzip.lisp (file)

Function: decompress-zlib READ-CONTEXT STATE

Package: 3bz
Source: zlib.lisp (file)

Function: deflate-state-p OBJECT

Package: 3bz
Source: deflate.lisp (file)

Function: ds-bits-remaining INSTANCE

Function: (setf ds-bits-remaining) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-bytes-to-copy INSTANCE

Function: (setf ds-bytes-to-copy) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-copy-offset INSTANCE

Function: (setf ds-copy-offset) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-current-huffman-tree INSTANCE

Function: (setf ds-current-huffman-tree) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-current-state INSTANCE

Function: (setf ds-current-state) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-dht-hclen INSTANCE

Function: (setf ds-dht-hclen) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-dht-hlit INSTANCE

Function: (setf ds-dht-hlit) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-dht-hlit+hdist INSTANCE

Function: (setf ds-dht-hlit+hdist) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-dht-last-len INSTANCE

Function: (setf ds-dht-last-len) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-dht-len-codes INSTANCE

Function: (setf ds-dht-len-codes) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-dht-len-tree INSTANCE

Function: (setf ds-dht-len-tree) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-dht-lit/len/dist INSTANCE

Function: (setf ds-dht-lit/len/dist) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-dht-lit/len/dist-index INSTANCE

Function: (setf ds-dht-lit/len/dist-index) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-dynamic-huffman-tree INSTANCE

Function: (setf ds-dynamic-huffman-tree) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-finished INSTANCE

Function: (setf ds-finished) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-input-underrun INSTANCE

Function: (setf ds-input-underrun) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-last-block-flag INSTANCE

Function: (setf ds-last-block-flag) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-output-buffer INSTANCE

Function: (setf ds-output-buffer) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-output-offset INSTANCE

Function: (setf ds-output-offset) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-output-overflow INSTANCE

Function: (setf ds-output-overflow) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-partial-bits INSTANCE

Function: (setf ds-partial-bits) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: ds-window INSTANCE

Function: (setf ds-window) VALUE INSTANCE

Package: 3bz
Source: deflate.lisp (file)

Function: generate-crc32-table ()

Package: 3bz
Source: checksums.lisp (file)

Function: gs-bits-remaining INSTANCE

Function: (setf gs-bits-remaining) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-bytes-to-copy INSTANCE

Function: (setf gs-bytes-to-copy) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-comment INSTANCE

Function: (setf gs-comment) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-compression-level INSTANCE

Function: (setf gs-compression-level) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-compression-method INSTANCE

Function: (setf gs-compression-method) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-copy-offset INSTANCE

Function: (setf gs-copy-offset) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-crc32 INSTANCE

Function: (setf gs-crc32) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-current-huffman-tree INSTANCE

Function: (setf gs-current-huffman-tree) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-current-state INSTANCE

Function: (setf gs-current-state) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-dht-hclen INSTANCE

Function: (setf gs-dht-hclen) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-dht-hlit INSTANCE

Function: (setf gs-dht-hlit) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-dht-hlit+hdist INSTANCE

Function: (setf gs-dht-hlit+hdist) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-dht-last-len INSTANCE

Function: (setf gs-dht-last-len) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-dht-len-codes INSTANCE

Function: (setf gs-dht-len-codes) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-dht-len-tree INSTANCE

Function: (setf gs-dht-len-tree) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-dht-lit/len/dist INSTANCE

Function: (setf gs-dht-lit/len/dist) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-dht-lit/len/dist-index INSTANCE

Function: (setf gs-dht-lit/len/dist-index) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-dynamic-huffman-tree INSTANCE

Function: (setf gs-dynamic-huffman-tree) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-extra INSTANCE

Function: (setf gs-extra) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-finished INSTANCE

Function: (setf gs-finished) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-flags INSTANCE

Function: (setf gs-flags) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-gzip-state INSTANCE

Function: (setf gs-gzip-state) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-header-bytes INSTANCE

Function: (setf gs-header-bytes) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-input-underrun INSTANCE

Function: (setf gs-input-underrun) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-last-block-flag INSTANCE

Function: (setf gs-last-block-flag) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-mtime/universal INSTANCE

Function: (setf gs-mtime/universal) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-mtime/unix INSTANCE

Function: (setf gs-mtime/unix) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-name INSTANCE

Function: (setf gs-name) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-operating-system INSTANCE

Function: (setf gs-operating-system) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-output-buffer INSTANCE

Function: (setf gs-output-buffer) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-output-offset INSTANCE

Function: (setf gs-output-offset) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-output-overflow INSTANCE

Function: (setf gs-output-overflow) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-partial-bits INSTANCE

Function: (setf gs-partial-bits) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gs-window INSTANCE

Function: (setf gs-window) VALUE INSTANCE

Package: 3bz
Source: gzip.lisp (file)

Function: gzip-state-p OBJECT

Package: 3bz
Source: gzip.lisp (file)

Function: ht-dist-node VALUE EXTRA-BITS

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-end-node ()

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-endp NODE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-extra-bits NODE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-invalid-node ()

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-invalidp NODE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-len-node VALUE EXTRA-BITS

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-len/dist-p NODE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-link-bits NODE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-link-node BITS INDEX

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-link-offset NODE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-linkp NODE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-literal-node VALUE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-literalp NODE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-max-bits INSTANCE

Function: (setf ht-max-bits) VALUE INSTANCE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-node-type NODE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-nodes INSTANCE

Function: (setf ht-nodes) VALUE INSTANCE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-start-bits INSTANCE

Function: (setf ht-start-bits) VALUE INSTANCE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: ht-value NODE

Package: 3bz
Source: huffman-tree.lisp (file)

Function: huffman-tree-p OBJECT

Package: 3bz
Source: huffman-tree.lisp (file)

Function: make-context-boxes &key (START START) (END END) (OFFSET OFFSET)

Package: 3bz
Source: io-common.lisp (file)

Function: make-huffman-tree &key (START-BITS START-BITS) (MAX-BITS MAX-BITS) (NODES NODES)

Package: 3bz
Source: huffman-tree.lisp (file)

Function: use-adler32 VERSION

Package: 3bz
Source: tuning.lisp (file)

Function: use-ub64 ()

Package: 3bz
Source: tuning.lisp (file)

Function: valid-octet-pointer OP

Package: 3bz
Source: io-mmap.lisp (file)

Function: valid-octet-stream OS

Package: 3bz
Source: io-common.lisp (file)

Function: zlib-state-p OBJECT

Package: 3bz
Source: zlib.lisp (file)

Function: zs-bits-remaining INSTANCE

Function: (setf zs-bits-remaining) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-bytes-to-copy INSTANCE

Function: (setf zs-bytes-to-copy) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-compression-level INSTANCE

Function: (setf zs-compression-level) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-compression-method INSTANCE

Function: (setf zs-compression-method) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-copy-offset INSTANCE

Function: (setf zs-copy-offset) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-current-huffman-tree INSTANCE

Function: (setf zs-current-huffman-tree) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-current-state INSTANCE

Function: (setf zs-current-state) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-dht-hclen INSTANCE

Function: (setf zs-dht-hclen) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-dht-hlit INSTANCE

Function: (setf zs-dht-hlit) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-dht-hlit+hdist INSTANCE

Function: (setf zs-dht-hlit+hdist) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-dht-last-len INSTANCE

Function: (setf zs-dht-last-len) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-dht-len-codes INSTANCE

Function: (setf zs-dht-len-codes) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-dht-len-tree INSTANCE

Function: (setf zs-dht-len-tree) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-dht-lit/len/dist INSTANCE

Function: (setf zs-dht-lit/len/dist) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-dht-lit/len/dist-index INSTANCE

Function: (setf zs-dht-lit/len/dist-index) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-dict-id INSTANCE

Function: (setf zs-dict-id) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-dynamic-huffman-tree INSTANCE

Function: (setf zs-dynamic-huffman-tree) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-finished INSTANCE

Function: (setf zs-finished) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-input-underrun INSTANCE

Function: (setf zs-input-underrun) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-last-block-flag INSTANCE

Function: (setf zs-last-block-flag) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-output-buffer INSTANCE

Function: (setf zs-output-buffer) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-output-offset INSTANCE

Function: (setf zs-output-offset) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-output-overflow INSTANCE

Function: (setf zs-output-overflow) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-partial-bits INSTANCE

Function: (setf zs-partial-bits) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-s1 INSTANCE

Function: (setf zs-s1) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-s2 INSTANCE

Function: (setf zs-s2) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-window INSTANCE

Function: (setf zs-window) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-window-size INSTANCE

Function: (setf zs-window-size) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

Function: zs-zlib-state INSTANCE

Function: (setf zs-zlib-state) VALUE INSTANCE

Package: 3bz
Source: zlib.lisp (file)

5.2.5 Generic functions

Generic Function: %pointer OBJECT

Package

3bz

Methods

Method: %pointer (OCTET-POINTER-CONTEXT octet-pointer-context)

automatically generated reader method

Source: io-mmap.lisp (file)

Generic Function: base OBJECT

Package

3bz

Methods

Method: base (OCTET-POINTER octet-pointer)

automatically generated reader method

Source: io-mmap.lisp (file)

Generic Function: boxes OBJECT

Package

3bz

Methods

Method: boxes (OCTET-POINTER-CONTEXT octet-pointer-context)

automatically generated reader method

Source: io-mmap.lisp (file)

Method: boxes (OCTET-STREAM-CONTEXT octet-stream-context)

automatically generated reader method

Source: io-common.lisp (file)

Method: boxes (OCTET-VECTOR-CONTEXT octet-vector-context)

automatically generated reader method

Source: io-common.lisp (file)

Generic Function: octet-stream OBJECT

Package

3bz

Methods

Method: octet-stream (OCTET-STREAM-CONTEXT octet-stream-context)

automatically generated reader method

Source: io-common.lisp (file)

Generic Function: octet-vector OBJECT

Package

3bz

Methods

Method: octet-vector (OCTET-VECTOR-CONTEXT octet-vector-context)

automatically generated reader method

Source: io-common.lisp (file)

Generic Function: op OBJECT

Package

3bz

Methods

Method: op (OCTET-POINTER-CONTEXT octet-pointer-context)

automatically generated reader method

Source: io-mmap.lisp (file)

Generic Function: scope OBJECT

Package

3bz

Methods

Method: scope (OCTET-POINTER octet-pointer)

automatically generated reader method

Source: io-mmap.lisp (file)

Generic Function: size OBJECT

Package

3bz

Methods

Method: size (OCTET-POINTER octet-pointer)

automatically generated reader method

Source: io-mmap.lisp (file)

5.2.6 Structures

Structure: context-boxes ()

Package

3bz

Source

io-common.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: start

Type: 3bz::size-t
Initform: 0
Readers: cb-start (function)
Writers: (setf cb-start) (function)

Slot: end

Type: 3bz::size-t
Initform: 0
Readers: cb-end (function)
Writers: (setf cb-end) (function)

Slot: offset

Type: 3bz::size-t
Initform: 0
Readers: cb-offset (function)
Writers: (setf cb-offset) (function)

Structure: deflate-state ()

Package

3bz

Source

deflate.lisp (file)

Direct superclasses

structure-object (structure)

Direct subclasses

zlib-state (structure)
gzip-state (structure)

Direct slots

Slot: current-state

Initform: :start-of-block
Readers: ds-current-state (function)
Writers: (setf ds-current-state) (function)

Slot: last-block-flag

Type: (or nil t)
Readers: ds-last-block-flag (function)
Writers: (setf ds-last-block-flag) (function)

Slot: dynamic-huffman-tree

Type: (cons 3bz::huffman-tree 3bz::huffman-tree)
Initform: (cons (3bz::make-huffman-tree) (3bz::make-huffman-tree))
Readers: ds-dynamic-huffman-tree (function)
Writers: (setf ds-dynamic-huffman-tree) (function)

Slot: current-huffman-tree

Type: (cons 3bz::huffman-tree 3bz::huffman-tree)
Initform: 3bz::+static-huffman-trees+
Readers: ds-current-huffman-tree (function)
Writers: (setf ds-current-huffman-tree) (function)

Slot: dht-hlit

Type: (unsigned-byte 10)
Initform: 0
Readers: ds-dht-hlit (function)
Writers: (setf ds-dht-hlit) (function)

Slot: dht-hlit+hdist

Type: (unsigned-byte 10)
Initform: 0
Readers: ds-dht-hlit+hdist (function)
Writers: (setf ds-dht-hlit+hdist) (function)

Slot: dht-hclen

Type: (unsigned-byte 4)
Initform: 0
Readers: ds-dht-hclen (function)
Writers: (setf ds-dht-hclen) (function)

Slot: dht-len-codes

Type: (simple-array (unsigned-byte 4) (19))
Initform: (make-array 19 :element-type (quote (unsigned-byte 4)) :initial-element 0)
Readers: ds-dht-len-codes (function)
Writers: (setf ds-dht-len-codes) (function)

Slot: dht-len-tree

Initform: (3bz::make-huffman-tree)
Readers: ds-dht-len-tree (function)
Writers: (setf ds-dht-len-tree) (function)

Slot: dht-lit/len/dist

Type: 3bz::code-table-type
Initform: (make-array (+ 288 32) :element-type (quote (unsigned-byte 4)) :initial-element 0)
Readers: ds-dht-lit/len/dist (function)
Writers: (setf ds-dht-lit/len/dist) (function)

Slot: dht-lit/len/dist-index

Type: (mod 320)
Initform: 0
Readers: ds-dht-lit/len/dist-index (function)
Writers: (setf ds-dht-lit/len/dist-index) (function)

Slot: dht-last-len

Type: 3bz::octet
Initform: 255
Readers: ds-dht-last-len (function)
Writers: (setf ds-dht-last-len) (function)

Slot: bytes-to-copy

Type: (unsigned-byte 16)
Initform: 0
Readers: ds-bytes-to-copy (function)
Writers: (setf ds-bytes-to-copy) (function)

Slot: copy-offset

Type: (unsigned-byte 16)
Initform: 0
Readers: ds-copy-offset (function)
Writers: (setf ds-copy-offset) (function)

Slot: partial-bits

Type: (unsigned-byte 64)
Initform: 0
Readers: ds-partial-bits (function)
Writers: (setf ds-partial-bits) (function)

Slot: bits-remaining

Type: (unsigned-byte 7)
Initform: 0
Readers: ds-bits-remaining (function)
Writers: (setf ds-bits-remaining) (function)

Slot: output-offset

Type: fixnum
Initform: 0
Readers: ds-output-offset (function)
Writers: (setf ds-output-offset) (function)

Slot: output-buffer

Type: 3bz::octet-vector
Initform: (make-array 0 :element-type (quote 3bz::octet))
Readers: ds-output-buffer (function)
Writers: (setf ds-output-buffer) (function)

Slot: window

Type: (or null 3bz::octet-vector)
Readers: ds-window (function)
Writers: (setf ds-window) (function)

Slot: finished

Type: (or nil t)
Readers: ds-finished (function)
Writers: (setf ds-finished) (function)

Slot: output-overflow

Type: (or nil t)
Readers: ds-output-overflow (function)
Writers: (setf ds-output-overflow) (function)

Slot: input-underrun

Type: (or nil t)
Readers: ds-input-underrun (function)
Writers: (setf ds-input-underrun) (function)

Structure: gzip-state ()

Package

3bz

Source

gzip.lisp (file)

Direct superclasses

deflate-state (structure)

Direct slots

Slot: gzip-state

Initform: :header
Readers: gs-gzip-state (function)
Writers: (setf gs-gzip-state) (function)

Slot: compression-method

Readers: gs-compression-method (function)
Writers: (setf gs-compression-method) (function)

Slot: flags

Readers: gs-flags (function)
Writers: (setf gs-flags) (function)

Slot: extra

Readers: gs-extra (function)
Writers: (setf gs-extra) (function)

Slot: name

Readers: gs-name (function)
Writers: (setf gs-name) (function)

Slot: comment

Readers: gs-comment (function)
Writers: (setf gs-comment) (function)

Slot: operating-system

Readers: gs-operating-system (function)
Writers: (setf gs-operating-system) (function)

Slot: mtime/unix

Readers: gs-mtime/unix (function)
Writers: (setf gs-mtime/unix) (function)

Slot: mtime/universal

Readers: gs-mtime/universal (function)
Writers: (setf gs-mtime/universal) (function)

Slot: compression-level

Initform: :default
Readers: gs-compression-level (function)
Writers: (setf gs-compression-level) (function)

Slot: header-bytes

Initform: (make-array 16 :adjustable t :fill-pointer 0)
Readers: gs-header-bytes (function)
Writers: (setf gs-header-bytes) (function)

Slot: crc32

Type: (unsigned-byte 32)
Initform: 0
Readers: gs-crc32 (function)
Writers: (setf gs-crc32) (function)

Structure: huffman-tree ()

Package

3bz

Source

huffman-tree.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

make-load-form (method)

Direct slots

Slot: start-bits

Type: 3bz::ht-bit-count-type
Initform: 0
Readers: ht-start-bits (function)
Writers: (setf ht-start-bits) (function)

Slot: max-bits

Type: (mod 29)
Initform: 0
Readers: ht-max-bits (function)
Writers: (setf ht-max-bits) (function)

Slot: nodes

Type: 3bz::ht-node-array-type
Initform: (make-array 3bz::+max-tree-size+ :element-type (quote 3bz::ht-node-type) :initial-element (3bz::ht-invalid-node))
Readers: ht-nodes (function)
Writers: (setf ht-nodes) (function)

Structure: zlib-state ()

Package

3bz

Source

zlib.lisp (file)

Direct superclasses

deflate-state (structure)

Direct slots

Slot: zlib-state

Initform: :header
Readers: zs-zlib-state (function)
Writers: (setf zs-zlib-state) (function)

Slot: compression-method

Readers: zs-compression-method (function)
Writers: (setf zs-compression-method) (function)

Slot: window-size

Initform: 0
Readers: zs-window-size (function)
Writers: (setf zs-window-size) (function)

Slot: dict-id

Readers: zs-dict-id (function)
Writers: (setf zs-dict-id) (function)

Slot: compression-level

Initform: :default
Readers: zs-compression-level (function)
Writers: (setf zs-compression-level) (function)

Slot: s1

Type: (unsigned-byte 16)
Initform: 1
Readers: zs-s1 (function)
Writers: (setf zs-s1) (function)

Slot: s2

Type: (unsigned-byte 16)
Initform: 0
Readers: zs-s2 (function)
Writers: (setf zs-s2) (function)

5.2.7 Classes

Class: octet-pointer ()

Package

3bz

Source

io-mmap.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

scope (method)
size (method)
base (method)

Direct slots

Slot: base

Initargs: :base
Readers: base (generic function)

Slot: size

Initargs: :size
Readers: size (generic function)

Slot: scope

Initargs: :scope
Readers: scope (generic function)

Class: octet-pointer-context ()

Package

3bz

Source

io-mmap.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

boxes (method)
%pointer (method)
op (method)

Direct slots

Slot: op

Initargs: :op
Readers: op (generic function)

Slot: pointer

Initargs: :pointer
Readers: %pointer (generic function)

Slot: boxes

Initargs: :boxes
Readers: boxes (generic function)

Class: octet-stream-context ()

Package

3bz

Source

io-common.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

%resync-file-stream (method)
boxes (method)
octet-stream (method)

Direct slots

Slot: octet-stream

Initargs: :octet-stream
Readers: octet-stream (generic function)

Slot: boxes

Initargs: :boxes
Readers: boxes (generic function)

Class: octet-vector-context ()

Package

3bz

Source

io-common.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

boxes (method)
octet-vector (method)

Direct slots

Slot: octet-vector

Initargs: :octet-vector
Readers: octet-vector (generic function)

Slot: boxes

Initargs: :boxes
Readers: boxes (generic function)

5.2.8 Types

Type: code-table-type ()

Package: 3bz
Source: types.lisp (file)

Type: ht-bit-count-type ()

Package: 3bz
Source: types.lisp (file)

Type: ht-node-array-type ()

Package: 3bz
Source: types.lisp (file)

Type: ht-node-type ()

Package: 3bz
Source: types.lisp (file)

Type: ht-offset-type ()

Package: 3bz
Source: types.lisp (file)

Type: non-negative-fixnum ()

Package: 3bz
Source: types.lisp (file)

Type: octet ()

Package: 3bz
Source: io-common.lisp (file)

Type: octet-vector ()

Package: 3bz
Source: io-common.lisp (file)

Type: offset-t ()

Package: 3bz
Source: io-mmap.lisp (file)

Type: size-t ()

Package: 3bz
Source: io-mmap.lisp (file)

Type: ub16 ()

Package: 3bz
Source: types.lisp (file)

Type: ub32 ()

Package: 3bz
Source: types.lisp (file)

Type: ub64 ()

Package: 3bz
Source: types.lisp (file)

Type: ub8 ()

Package: 3bz
Source: types.lisp (file)

Appendix A Indexes

A.1 Concepts

Jump to:	3 F L

	Index Entry	Section

3
	`3bz.asd`:	The 3bz․asd file
	`3bz/api.lisp`:	The 3bz/api․lisp file
	`3bz/checksums.lisp`:	The 3bz/checksums․lisp file
	`3bz/constants.lisp`:	The 3bz/constants․lisp file
	`3bz/deflate.lisp`:	The 3bz/deflate․lisp file
	`3bz/gzip.lisp`:	The 3bz/gzip․lisp file
	`3bz/ht-constants.lisp`:	The 3bz/ht-constants․lisp file
	`3bz/huffman-tree.lisp`:	The 3bz/huffman-tree․lisp file
	`3bz/io-common.lisp`:	The 3bz/io-common․lisp file
	`3bz/io-mmap.lisp`:	The 3bz/io-mmap․lisp file
	`3bz/io-nommap.lisp`:	The 3bz/io-nommap․lisp file
	`3bz/io.lisp`:	The 3bz/io․lisp file
	`3bz/package.lisp`:	The 3bz/package․lisp file
	`3bz/tuning.lisp`:	The 3bz/tuning․lisp file
	`3bz/types.lisp`:	The 3bz/types․lisp file
	`3bz/util.lisp`:	The 3bz/util․lisp file
	`3bz/zlib.lisp`:	The 3bz/zlib․lisp file

F
	File, Lisp, `3bz.asd`:	The 3bz․asd file
	File, Lisp, `3bz/api.lisp`:	The 3bz/api․lisp file
	File, Lisp, `3bz/checksums.lisp`:	The 3bz/checksums․lisp file
	File, Lisp, `3bz/constants.lisp`:	The 3bz/constants․lisp file
	File, Lisp, `3bz/deflate.lisp`:	The 3bz/deflate․lisp file
	File, Lisp, `3bz/gzip.lisp`:	The 3bz/gzip․lisp file
	File, Lisp, `3bz/ht-constants.lisp`:	The 3bz/ht-constants․lisp file
	File, Lisp, `3bz/huffman-tree.lisp`:	The 3bz/huffman-tree․lisp file
	File, Lisp, `3bz/io-common.lisp`:	The 3bz/io-common․lisp file
	File, Lisp, `3bz/io-mmap.lisp`:	The 3bz/io-mmap․lisp file
	File, Lisp, `3bz/io-nommap.lisp`:	The 3bz/io-nommap․lisp file
	File, Lisp, `3bz/io.lisp`:	The 3bz/io․lisp file
	File, Lisp, `3bz/package.lisp`:	The 3bz/package․lisp file
	File, Lisp, `3bz/tuning.lisp`:	The 3bz/tuning․lisp file
	File, Lisp, `3bz/types.lisp`:	The 3bz/types․lisp file
	File, Lisp, `3bz/util.lisp`:	The 3bz/util․lisp file
	File, Lisp, `3bz/zlib.lisp`:	The 3bz/zlib․lisp file

L
	Lisp File, `3bz.asd`:	The 3bz․asd file
	Lisp File, `3bz/api.lisp`:	The 3bz/api․lisp file
	Lisp File, `3bz/checksums.lisp`:	The 3bz/checksums․lisp file
	Lisp File, `3bz/constants.lisp`:	The 3bz/constants․lisp file
	Lisp File, `3bz/deflate.lisp`:	The 3bz/deflate․lisp file
	Lisp File, `3bz/gzip.lisp`:	The 3bz/gzip․lisp file
	Lisp File, `3bz/ht-constants.lisp`:	The 3bz/ht-constants․lisp file
	Lisp File, `3bz/huffman-tree.lisp`:	The 3bz/huffman-tree․lisp file
	Lisp File, `3bz/io-common.lisp`:	The 3bz/io-common․lisp file
	Lisp File, `3bz/io-mmap.lisp`:	The 3bz/io-mmap․lisp file
	Lisp File, `3bz/io-nommap.lisp`:	The 3bz/io-nommap․lisp file
	Lisp File, `3bz/io.lisp`:	The 3bz/io․lisp file
	Lisp File, `3bz/package.lisp`:	The 3bz/package․lisp file
	Lisp File, `3bz/tuning.lisp`:	The 3bz/tuning․lisp file
	Lisp File, `3bz/types.lisp`:	The 3bz/types․lisp file
	Lisp File, `3bz/util.lisp`:	The 3bz/util․lisp file
	Lisp File, `3bz/zlib.lisp`:	The 3bz/zlib․lisp file

Jump to:	3 F L

A.2 Functions

Jump to:	% ( A B C D F G H I M O R S U V W Z

	Index Entry	Section

%
	`%pointer`:	Internal generic functions
	`%pointer`:	Internal generic functions
	`%resync-file-stream`:	Exported generic functions
	`%resync-file-stream`:	Exported generic functions
	`%resync-file-stream`:	Exported generic functions

(
	`(setf cb-end)`:	Internal functions
	`(setf cb-offset)`:	Internal functions
	`(setf cb-start)`:	Internal functions
	`(setf ds-bits-remaining)`:	Internal functions
	`(setf ds-bytes-to-copy)`:	Internal functions
	`(setf ds-copy-offset)`:	Internal functions
	`(setf ds-current-huffman-tree)`:	Internal functions
	`(setf ds-current-state)`:	Internal functions
	`(setf ds-dht-hclen)`:	Internal functions
	`(setf ds-dht-hlit)`:	Internal functions
	`(setf ds-dht-hlit+hdist)`:	Internal functions
	`(setf ds-dht-last-len)`:	Internal functions
	`(setf ds-dht-len-codes)`:	Internal functions
	`(setf ds-dht-len-tree)`:	Internal functions
	`(setf ds-dht-lit/len/dist)`:	Internal functions
	`(setf ds-dht-lit/len/dist-index)`:	Internal functions
	`(setf ds-dynamic-huffman-tree)`:	Internal functions
	`(setf ds-finished)`:	Internal functions
	`(setf ds-input-underrun)`:	Internal functions
	`(setf ds-last-block-flag)`:	Internal functions
	`(setf ds-output-buffer)`:	Internal functions
	`(setf ds-output-offset)`:	Internal functions
	`(setf ds-output-overflow)`:	Internal functions
	`(setf ds-partial-bits)`:	Internal functions
	`(setf ds-window)`:	Internal functions
	`(setf gs-bits-remaining)`:	Internal functions
	`(setf gs-bytes-to-copy)`:	Internal functions
	`(setf gs-comment)`:	Internal functions
	`(setf gs-compression-level)`:	Internal functions
	`(setf gs-compression-method)`:	Internal functions
	`(setf gs-copy-offset)`:	Internal functions
	`(setf gs-crc32)`:	Internal functions
	`(setf gs-current-huffman-tree)`:	Internal functions
	`(setf gs-current-state)`:	Internal functions
	`(setf gs-dht-hclen)`:	Internal functions
	`(setf gs-dht-hlit)`:	Internal functions
	`(setf gs-dht-hlit+hdist)`:	Internal functions
	`(setf gs-dht-last-len)`:	Internal functions
	`(setf gs-dht-len-codes)`:	Internal functions
	`(setf gs-dht-len-tree)`:	Internal functions
	`(setf gs-dht-lit/len/dist)`:	Internal functions
	`(setf gs-dht-lit/len/dist-index)`:	Internal functions
	`(setf gs-dynamic-huffman-tree)`:	Internal functions
	`(setf gs-extra)`:	Internal functions
	`(setf gs-finished)`:	Internal functions
	`(setf gs-flags)`:	Internal functions
	`(setf gs-gzip-state)`:	Internal functions
	`(setf gs-header-bytes)`:	Internal functions
	`(setf gs-input-underrun)`:	Internal functions
	`(setf gs-last-block-flag)`:	Internal functions
	`(setf gs-mtime/universal)`:	Internal functions
	`(setf gs-mtime/unix)`:	Internal functions
	`(setf gs-name)`:	Internal functions
	`(setf gs-operating-system)`:	Internal functions
	`(setf gs-output-buffer)`:	Internal functions
	`(setf gs-output-offset)`:	Internal functions
	`(setf gs-output-overflow)`:	Internal functions
	`(setf gs-partial-bits)`:	Internal functions
	`(setf gs-window)`:	Internal functions
	`(setf ht-max-bits)`:	Internal functions
	`(setf ht-nodes)`:	Internal functions
	`(setf ht-start-bits)`:	Internal functions
	`(setf zs-bits-remaining)`:	Internal functions
	`(setf zs-bytes-to-copy)`:	Internal functions
	`(setf zs-compression-level)`:	Internal functions
	`(setf zs-compression-method)`:	Internal functions
	`(setf zs-copy-offset)`:	Internal functions
	`(setf zs-current-huffman-tree)`:	Internal functions
	`(setf zs-current-state)`:	Internal functions
	`(setf zs-dht-hclen)`:	Internal functions
	`(setf zs-dht-hlit)`:	Internal functions
	`(setf zs-dht-hlit+hdist)`:	Internal functions
	`(setf zs-dht-last-len)`:	Internal functions
	`(setf zs-dht-len-codes)`:	Internal functions
	`(setf zs-dht-len-tree)`:	Internal functions
	`(setf zs-dht-lit/len/dist)`:	Internal functions
	`(setf zs-dht-lit/len/dist-index)`:	Internal functions
	`(setf zs-dict-id)`:	Internal functions
	`(setf zs-dynamic-huffman-tree)`:	Internal functions
	`(setf zs-finished)`:	Internal functions
	`(setf zs-input-underrun)`:	Internal functions
	`(setf zs-last-block-flag)`:	Internal functions
	`(setf zs-output-buffer)`:	Internal functions
	`(setf zs-output-offset)`:	Internal functions
	`(setf zs-output-overflow)`:	Internal functions
	`(setf zs-partial-bits)`:	Internal functions
	`(setf zs-s1)`:	Internal functions
	`(setf zs-s2)`:	Internal functions
	`(setf zs-window)`:	Internal functions
	`(setf zs-window-size)`:	Internal functions
	`(setf zs-zlib-state)`:	Internal functions

A
	`adler32`:	Internal functions
	`adler32/fixnum`:	Internal functions
	`adler32/ub32`:	Internal functions
	`adler32/ub64`:	Internal functions

B
	`base`:	Internal generic functions
	`base`:	Internal generic functions
	`bit-rev`:	Internal functions
	`boxes`:	Internal generic functions
	`boxes`:	Internal generic functions
	`boxes`:	Internal generic functions
	`boxes`:	Internal generic functions
	`build-tree-part`:	Internal functions
	`build-trees`:	Internal functions
	`build-trees*`:	Internal functions

C
	`cb-end`:	Internal functions
	`cb-offset`:	Internal functions
	`cb-start`:	Internal functions
	`check-zlib-header`:	Internal functions
	`context-boxes-p`:	Internal functions
	`context-common`:	Internal macros
	`copy-context-boxes`:	Internal functions
	`copy-deflate-state`:	Internal functions
	`copy-gzip-state`:	Internal functions
	`copy-huffman-tree`:	Internal functions
	`copy-zlib-state`:	Internal functions
	`crc32/table`:	Internal functions

D
	`decompress`:	Exported functions
	`decompress-deflate`:	Internal functions
	`decompress-deflate/pointer`:	Internal functions
	`decompress-deflate/stream`:	Internal functions
	`decompress-deflate/vector`:	Internal functions
	`decompress-gzip`:	Internal functions
	`decompress-vector`:	Exported functions
	`decompress-zlib`:	Internal functions
	`deflate-state-p`:	Internal functions
	`defstruct-cached`:	Internal macros
	`defun-with-reader-contexts`:	Internal macros
	`ds-bits-remaining`:	Internal functions
	`ds-bytes-to-copy`:	Internal functions
	`ds-copy-offset`:	Internal functions
	`ds-current-huffman-tree`:	Internal functions
	`ds-current-state`:	Internal functions
	`ds-dht-hclen`:	Internal functions
	`ds-dht-hlit`:	Internal functions
	`ds-dht-hlit+hdist`:	Internal functions
	`ds-dht-last-len`:	Internal functions
	`ds-dht-len-codes`:	Internal functions
	`ds-dht-len-tree`:	Internal functions
	`ds-dht-lit/len/dist`:	Internal functions
	`ds-dht-lit/len/dist-index`:	Internal functions
	`ds-dynamic-huffman-tree`:	Internal functions
	`ds-finished`:	Internal functions
	`ds-input-underrun`:	Internal functions
	`ds-last-block-flag`:	Internal functions
	`ds-output-buffer`:	Internal functions
	`ds-output-offset`:	Internal functions
	`ds-output-overflow`:	Internal functions
	`ds-partial-bits`:	Internal functions
	`ds-window`:	Internal functions

F
	`finished`:	Exported functions
	`fixnum+`:	Internal macros
	`Function, (setf cb-end)`:	Internal functions
	`Function, (setf cb-offset)`:	Internal functions
	`Function, (setf cb-start)`:	Internal functions
	`Function, (setf ds-bits-remaining)`:	Internal functions
	`Function, (setf ds-bytes-to-copy)`:	Internal functions
	`Function, (setf ds-copy-offset)`:	Internal functions
	`Function, (setf ds-current-huffman-tree)`:	Internal functions
	`Function, (setf ds-current-state)`:	Internal functions
	`Function, (setf ds-dht-hclen)`:	Internal functions
	`Function, (setf ds-dht-hlit)`:	Internal functions
	`Function, (setf ds-dht-hlit+hdist)`:	Internal functions
	`Function, (setf ds-dht-last-len)`:	Internal functions
	`Function, (setf ds-dht-len-codes)`:	Internal functions
	`Function, (setf ds-dht-len-tree)`:	Internal functions
	`Function, (setf ds-dht-lit/len/dist)`:	Internal functions
	`Function, (setf ds-dht-lit/len/dist-index)`:	Internal functions
	`Function, (setf ds-dynamic-huffman-tree)`:	Internal functions
	`Function, (setf ds-finished)`:	Internal functions
	`Function, (setf ds-input-underrun)`:	Internal functions
	`Function, (setf ds-last-block-flag)`:	Internal functions
	`Function, (setf ds-output-buffer)`:	Internal functions
	`Function, (setf ds-output-offset)`:	Internal functions
	`Function, (setf ds-output-overflow)`:	Internal functions
	`Function, (setf ds-partial-bits)`:	Internal functions
	`Function, (setf ds-window)`:	Internal functions
	`Function, (setf gs-bits-remaining)`:	Internal functions
	`Function, (setf gs-bytes-to-copy)`:	Internal functions
	`Function, (setf gs-comment)`:	Internal functions
	`Function, (setf gs-compression-level)`:	Internal functions
	`Function, (setf gs-compression-method)`:	Internal functions
	`Function, (setf gs-copy-offset)`:	Internal functions
	`Function, (setf gs-crc32)`:	Internal functions
	`Function, (setf gs-current-huffman-tree)`:	Internal functions
	`Function, (setf gs-current-state)`:	Internal functions
	`Function, (setf gs-dht-hclen)`:	Internal functions
	`Function, (setf gs-dht-hlit)`:	Internal functions
	`Function, (setf gs-dht-hlit+hdist)`:	Internal functions
	`Function, (setf gs-dht-last-len)`:	Internal functions
	`Function, (setf gs-dht-len-codes)`:	Internal functions
	`Function, (setf gs-dht-len-tree)`:	Internal functions
	`Function, (setf gs-dht-lit/len/dist)`:	Internal functions
	`Function, (setf gs-dht-lit/len/dist-index)`:	Internal functions
	`Function, (setf gs-dynamic-huffman-tree)`:	Internal functions
	`Function, (setf gs-extra)`:	Internal functions
	`Function, (setf gs-finished)`:	Internal functions
	`Function, (setf gs-flags)`:	Internal functions
	`Function, (setf gs-gzip-state)`:	Internal functions
	`Function, (setf gs-header-bytes)`:	Internal functions
	`Function, (setf gs-input-underrun)`:	Internal functions
	`Function, (setf gs-last-block-flag)`:	Internal functions
	`Function, (setf gs-mtime/universal)`:	Internal functions
	`Function, (setf gs-mtime/unix)`:	Internal functions
	`Function, (setf gs-name)`:	Internal functions
	`Function, (setf gs-operating-system)`:	Internal functions
	`Function, (setf gs-output-buffer)`:	Internal functions
	`Function, (setf gs-output-offset)`:	Internal functions
	`Function, (setf gs-output-overflow)`:	Internal functions
	`Function, (setf gs-partial-bits)`:	Internal functions
	`Function, (setf gs-window)`:	Internal functions
	`Function, (setf ht-max-bits)`:	Internal functions
	`Function, (setf ht-nodes)`:	Internal functions
	`Function, (setf ht-start-bits)`:	Internal functions
	`Function, (setf zs-bits-remaining)`:	Internal functions
	`Function, (setf zs-bytes-to-copy)`:	Internal functions
	`Function, (setf zs-compression-level)`:	Internal functions
	`Function, (setf zs-compression-method)`:	Internal functions
	`Function, (setf zs-copy-offset)`:	Internal functions
	`Function, (setf zs-current-huffman-tree)`:	Internal functions
	`Function, (setf zs-current-state)`:	Internal functions
	`Function, (setf zs-dht-hclen)`:	Internal functions
	`Function, (setf zs-dht-hlit)`:	Internal functions
	`Function, (setf zs-dht-hlit+hdist)`:	Internal functions
	`Function, (setf zs-dht-last-len)`:	Internal functions
	`Function, (setf zs-dht-len-codes)`:	Internal functions
	`Function, (setf zs-dht-len-tree)`:	Internal functions
	`Function, (setf zs-dht-lit/len/dist)`:	Internal functions
	`Function, (setf zs-dht-lit/len/dist-index)`:	Internal functions
	`Function, (setf zs-dict-id)`:	Internal functions
	`Function, (setf zs-dynamic-huffman-tree)`:	Internal functions
	`Function, (setf zs-finished)`:	Internal functions
	`Function, (setf zs-input-underrun)`:	Internal functions
	`Function, (setf zs-last-block-flag)`:	Internal functions
	`Function, (setf zs-output-buffer)`:	Internal functions
	`Function, (setf zs-output-offset)`:	Internal functions
	`Function, (setf zs-output-overflow)`:	Internal functions
	`Function, (setf zs-partial-bits)`:	Internal functions
	`Function, (setf zs-s1)`:	Internal functions
	`Function, (setf zs-s2)`:	Internal functions
	`Function, (setf zs-window)`:	Internal functions
	`Function, (setf zs-window-size)`:	Internal functions
	`Function, (setf zs-zlib-state)`:	Internal functions
	`Function, adler32`:	Internal functions
	`Function, adler32/fixnum`:	Internal functions
	`Function, adler32/ub32`:	Internal functions
	`Function, adler32/ub64`:	Internal functions
	`Function, bit-rev`:	Internal functions
	`Function, build-tree-part`:	Internal functions
	`Function, build-trees`:	Internal functions
	`Function, build-trees*`:	Internal functions
	`Function, cb-end`:	Internal functions
	`Function, cb-offset`:	Internal functions
	`Function, cb-start`:	Internal functions
	`Function, check-zlib-header`:	Internal functions
	`Function, context-boxes-p`:	Internal functions
	`Function, copy-context-boxes`:	Internal functions
	`Function, copy-deflate-state`:	Internal functions
	`Function, copy-gzip-state`:	Internal functions
	`Function, copy-huffman-tree`:	Internal functions
	`Function, copy-zlib-state`:	Internal functions
	`Function, crc32/table`:	Internal functions
	`Function, decompress`:	Exported functions
	`Function, decompress-deflate`:	Internal functions
	`Function, decompress-deflate/pointer`:	Internal functions
	`Function, decompress-deflate/stream`:	Internal functions
	`Function, decompress-deflate/vector`:	Internal functions
	`Function, decompress-gzip`:	Internal functions
	`Function, decompress-vector`:	Exported functions
	`Function, decompress-zlib`:	Internal functions
	`Function, deflate-state-p`:	Internal functions
	`Function, ds-bits-remaining`:	Internal functions
	`Function, ds-bytes-to-copy`:	Internal functions
	`Function, ds-copy-offset`:	Internal functions
	`Function, ds-current-huffman-tree`:	Internal functions
	`Function, ds-current-state`:	Internal functions
	`Function, ds-dht-hclen`:	Internal functions
	`Function, ds-dht-hlit`:	Internal functions
	`Function, ds-dht-hlit+hdist`:	Internal functions
	`Function, ds-dht-last-len`:	Internal functions
	`Function, ds-dht-len-codes`:	Internal functions
	`Function, ds-dht-len-tree`:	Internal functions
	`Function, ds-dht-lit/len/dist`:	Internal functions
	`Function, ds-dht-lit/len/dist-index`:	Internal functions
	`Function, ds-dynamic-huffman-tree`:	Internal functions
	`Function, ds-finished`:	Internal functions
	`Function, ds-input-underrun`:	Internal functions
	`Function, ds-last-block-flag`:	Internal functions
	`Function, ds-output-buffer`:	Internal functions
	`Function, ds-output-offset`:	Internal functions
	`Function, ds-output-overflow`:	Internal functions
	`Function, ds-partial-bits`:	Internal functions
	`Function, ds-window`:	Internal functions
	`Function, finished`:	Exported functions
	`Function, generate-crc32-table`:	Internal functions
	`Function, gs-bits-remaining`:	Internal functions
	`Function, gs-bytes-to-copy`:	Internal functions
	`Function, gs-comment`:	Internal functions
	`Function, gs-compression-level`:	Internal functions
	`Function, gs-compression-method`:	Internal functions
	`Function, gs-copy-offset`:	Internal functions
	`Function, gs-crc32`:	Internal functions
	`Function, gs-current-huffman-tree`:	Internal functions
	`Function, gs-current-state`:	Internal functions
	`Function, gs-dht-hclen`:	Internal functions
	`Function, gs-dht-hlit`:	Internal functions
	`Function, gs-dht-hlit+hdist`:	Internal functions
	`Function, gs-dht-last-len`:	Internal functions
	`Function, gs-dht-len-codes`:	Internal functions
	`Function, gs-dht-len-tree`:	Internal functions
	`Function, gs-dht-lit/len/dist`:	Internal functions
	`Function, gs-dht-lit/len/dist-index`:	Internal functions
	`Function, gs-dynamic-huffman-tree`:	Internal functions
	`Function, gs-extra`:	Internal functions
	`Function, gs-finished`:	Internal functions
	`Function, gs-flags`:	Internal functions
	`Function, gs-gzip-state`:	Internal functions
	`Function, gs-header-bytes`:	Internal functions
	`Function, gs-input-underrun`:	Internal functions
	`Function, gs-last-block-flag`:	Internal functions
	`Function, gs-mtime/universal`:	Internal functions
	`Function, gs-mtime/unix`:	Internal functions
	`Function, gs-name`:	Internal functions
	`Function, gs-operating-system`:	Internal functions
	`Function, gs-output-buffer`:	Internal functions
	`Function, gs-output-offset`:	Internal functions
	`Function, gs-output-overflow`:	Internal functions
	`Function, gs-partial-bits`:	Internal functions
	`Function, gs-window`:	Internal functions
	`Function, gzip-state-p`:	Internal functions
	`Function, ht-dist-node`:	Internal functions
	`Function, ht-end-node`:	Internal functions
	`Function, ht-endp`:	Internal functions
	`Function, ht-extra-bits`:	Internal functions
	`Function, ht-invalid-node`:	Internal functions
	`Function, ht-invalidp`:	Internal functions
	`Function, ht-len-node`:	Internal functions
	`Function, ht-len/dist-p`:	Internal functions
	`Function, ht-link-bits`:	Internal functions
	`Function, ht-link-node`:	Internal functions
	`Function, ht-link-offset`:	Internal functions
	`Function, ht-linkp`:	Internal functions
	`Function, ht-literal-node`:	Internal functions
	`Function, ht-literalp`:	Internal functions
	`Function, ht-max-bits`:	Internal functions
	`Function, ht-node-type`:	Internal functions
	`Function, ht-nodes`:	Internal functions
	`Function, ht-start-bits`:	Internal functions
	`Function, ht-value`:	Internal functions
	`Function, huffman-tree-p`:	Internal functions
	`Function, input-underrun`:	Exported functions
	`Function, make-context-boxes`:	Internal functions
	`Function, make-deflate-state`:	Exported functions
	`Function, make-gzip-state`:	Exported functions
	`Function, make-huffman-tree`:	Internal functions
	`Function, make-octet-pointer-context`:	Exported functions
	`Function, make-octet-stream-context`:	Exported functions
	`Function, make-octet-vector-context`:	Exported functions
	`Function, make-zlib-state`:	Exported functions
	`Function, output-overflow`:	Exported functions
	`Function, replace-output-buffer`:	Exported functions
	`Function, use-adler32`:	Internal functions
	`Function, use-ub64`:	Internal functions
	`Function, valid-octet-pointer`:	Internal functions
	`Function, valid-octet-stream`:	Internal functions
	`Function, zlib-state-p`:	Internal functions
	`Function, zs-bits-remaining`:	Internal functions
	`Function, zs-bytes-to-copy`:	Internal functions
	`Function, zs-compression-level`:	Internal functions
	`Function, zs-compression-method`:	Internal functions
	`Function, zs-copy-offset`:	Internal functions
	`Function, zs-current-huffman-tree`:	Internal functions
	`Function, zs-current-state`:	Internal functions
	`Function, zs-dht-hclen`:	Internal functions
	`Function, zs-dht-hlit`:	Internal functions
	`Function, zs-dht-hlit+hdist`:	Internal functions
	`Function, zs-dht-last-len`:	Internal functions
	`Function, zs-dht-len-codes`:	Internal functions
	`Function, zs-dht-len-tree`:	Internal functions
	`Function, zs-dht-lit/len/dist`:	Internal functions
	`Function, zs-dht-lit/len/dist-index`:	Internal functions
	`Function, zs-dict-id`:	Internal functions
	`Function, zs-dynamic-huffman-tree`:	Internal functions
	`Function, zs-finished`:	Internal functions
	`Function, zs-input-underrun`:	Internal functions
	`Function, zs-last-block-flag`:	Internal functions
	`Function, zs-output-buffer`:	Internal functions
	`Function, zs-output-offset`:	Internal functions
	`Function, zs-output-overflow`:	Internal functions
	`Function, zs-partial-bits`:	Internal functions
	`Function, zs-s1`:	Internal functions
	`Function, zs-s2`:	Internal functions
	`Function, zs-window`:	Internal functions
	`Function, zs-window-size`:	Internal functions
	`Function, zs-zlib-state`:	Internal functions

G
	`generate-crc32-table`:	Internal functions
	`Generic Function, %pointer`:	Internal generic functions
	`Generic Function, %resync-file-stream`:	Exported generic functions
	`Generic Function, base`:	Internal generic functions
	`Generic Function, boxes`:	Internal generic functions
	`Generic Function, octet-stream`:	Internal generic functions
	`Generic Function, octet-vector`:	Internal generic functions
	`Generic Function, op`:	Internal generic functions
	`Generic Function, scope`:	Internal generic functions
	`Generic Function, size`:	Internal generic functions
	`gs-bits-remaining`:	Internal functions
	`gs-bytes-to-copy`:	Internal functions
	`gs-comment`:	Internal functions
	`gs-compression-level`:	Internal functions
	`gs-compression-method`:	Internal functions
	`gs-copy-offset`:	Internal functions
	`gs-crc32`:	Internal functions
	`gs-current-huffman-tree`:	Internal functions
	`gs-current-state`:	Internal functions
	`gs-dht-hclen`:	Internal functions
	`gs-dht-hlit`:	Internal functions
	`gs-dht-hlit+hdist`:	Internal functions
	`gs-dht-last-len`:	Internal functions
	`gs-dht-len-codes`:	Internal functions
	`gs-dht-len-tree`:	Internal functions
	`gs-dht-lit/len/dist`:	Internal functions
	`gs-dht-lit/len/dist-index`:	Internal functions
	`gs-dynamic-huffman-tree`:	Internal functions
	`gs-extra`:	Internal functions
	`gs-finished`:	Internal functions
	`gs-flags`:	Internal functions
	`gs-gzip-state`:	Internal functions
	`gs-header-bytes`:	Internal functions
	`gs-input-underrun`:	Internal functions
	`gs-last-block-flag`:	Internal functions
	`gs-mtime/universal`:	Internal functions
	`gs-mtime/unix`:	Internal functions
	`gs-name`:	Internal functions
	`gs-operating-system`:	Internal functions
	`gs-output-buffer`:	Internal functions
	`gs-output-offset`:	Internal functions
	`gs-output-overflow`:	Internal functions
	`gs-partial-bits`:	Internal functions
	`gs-window`:	Internal functions
	`gzip-state-p`:	Internal functions

H
	`ht-dist-node`:	Internal functions
	`ht-end-node`:	Internal functions
	`ht-endp`:	Internal functions
	`ht-extra-bits`:	Internal functions
	`ht-invalid-node`:	Internal functions
	`ht-invalidp`:	Internal functions
	`ht-len-node`:	Internal functions
	`ht-len/dist-p`:	Internal functions
	`ht-link-bits`:	Internal functions
	`ht-link-node`:	Internal functions
	`ht-link-offset`:	Internal functions
	`ht-linkp`:	Internal functions
	`ht-literal-node`:	Internal functions
	`ht-literalp`:	Internal functions
	`ht-max-bits`:	Internal functions
	`ht-node-type`:	Internal functions
	`ht-nodes`:	Internal functions
	`ht-start-bits`:	Internal functions
	`ht-value`:	Internal functions
	`huffman-tree-p`:	Internal functions

I
	`input-underrun`:	Exported functions

M
	`Macro, context-common`:	Internal macros
	`Macro, defstruct-cached`:	Internal macros
	`Macro, defun-with-reader-contexts`:	Internal macros
	`Macro, fixnum+`:	Internal macros
	`Macro, state-machine`:	Internal macros
	`Macro, ub64+`:	Internal macros
	`Macro, with-cached-state`:	Internal macros
	`Macro, with-octet-pointer`:	Exported macros
	`Macro, with-pointer-context`:	Internal macros
	`Macro, with-reader-contexts`:	Internal macros
	`Macro, with-stream-context`:	Internal macros
	`Macro, with-vector-context`:	Internal macros
	`Macro, wrap-fixnum`:	Internal macros
	`make-context-boxes`:	Internal functions
	`make-deflate-state`:	Exported functions
	`make-gzip-state`:	Exported functions
	`make-huffman-tree`:	Internal functions
	`make-octet-pointer-context`:	Exported functions
	`make-octet-stream-context`:	Exported functions
	`make-octet-vector-context`:	Exported functions
	`make-zlib-state`:	Exported functions
	`Method, %pointer`:	Internal generic functions
	`Method, %resync-file-stream`:	Exported generic functions
	`Method, %resync-file-stream`:	Exported generic functions
	`Method, base`:	Internal generic functions
	`Method, boxes`:	Internal generic functions
	`Method, boxes`:	Internal generic functions
	`Method, boxes`:	Internal generic functions
	`Method, octet-stream`:	Internal generic functions
	`Method, octet-vector`:	Internal generic functions
	`Method, op`:	Internal generic functions
	`Method, scope`:	Internal generic functions
	`Method, size`:	Internal generic functions

O
	`octet-stream`:	Internal generic functions
	`octet-stream`:	Internal generic functions
	`octet-vector`:	Internal generic functions
	`octet-vector`:	Internal generic functions
	`op`:	Internal generic functions
	`op`:	Internal generic functions
	`output-overflow`:	Exported functions

R
	`replace-output-buffer`:	Exported functions

S
	`scope`:	Internal generic functions
	`scope`:	Internal generic functions
	`size`:	Internal generic functions
	`size`:	Internal generic functions
	`state-machine`:	Internal macros

U
	`ub64+`:	Internal macros
	`use-adler32`:	Internal functions
	`use-ub64`:	Internal functions

V
	`valid-octet-pointer`:	Internal functions
	`valid-octet-stream`:	Internal functions

W
	`with-cached-state`:	Internal macros
	`with-octet-pointer`:	Exported macros
	`with-pointer-context`:	Internal macros
	`with-reader-contexts`:	Internal macros
	`with-stream-context`:	Internal macros
	`with-vector-context`:	Internal macros
	`wrap-fixnum`:	Internal macros

Z
	`zlib-state-p`:	Internal functions
	`zs-bits-remaining`:	Internal functions
	`zs-bytes-to-copy`:	Internal functions
	`zs-compression-level`:	Internal functions
	`zs-compression-method`:	Internal functions
	`zs-copy-offset`:	Internal functions
	`zs-current-huffman-tree`:	Internal functions
	`zs-current-state`:	Internal functions
	`zs-dht-hclen`:	Internal functions
	`zs-dht-hlit`:	Internal functions
	`zs-dht-hlit+hdist`:	Internal functions
	`zs-dht-last-len`:	Internal functions
	`zs-dht-len-codes`:	Internal functions
	`zs-dht-len-tree`:	Internal functions
	`zs-dht-lit/len/dist`:	Internal functions
	`zs-dht-lit/len/dist-index`:	Internal functions
	`zs-dict-id`:	Internal functions
	`zs-dynamic-huffman-tree`:	Internal functions
	`zs-finished`:	Internal functions
	`zs-input-underrun`:	Internal functions
	`zs-last-block-flag`:	Internal functions
	`zs-output-buffer`:	Internal functions
	`zs-output-offset`:	Internal functions
	`zs-output-overflow`:	Internal functions
	`zs-partial-bits`:	Internal functions
	`zs-s1`:	Internal functions
	`zs-s2`:	Internal functions
	`zs-window`:	Internal functions
	`zs-window-size`:	Internal functions
	`zs-zlib-state`:	Internal functions

Jump to:	% ( A B C D F G H I M O R S U V W Z

A.3 Variables

Jump to:	% * + B C D E F G H I L M N O P S W Z

	Index Entry	Section

%
	`%static-huffman-tree/dist%`:	Internal special variables
	`%static-huffman-tree/len%`:	Internal special variables

*
	`bit-rev-table`:	Internal special variables
	`cached-struct-defs`:	Internal special variables
	`fixed-dist-table`:	Internal special variables
	`fixed-lit/length-table`:	Internal special variables
	`stats`:	Internal special variables

+
	`+accumulate-count+`:	Internal constants
	`+adler32-prime+`:	Internal constants
	`+adler32-unroll+`:	Internal constants
	`+crc32/table+`:	Internal constants
	`+end-code+`:	Internal constants
	`+extra-bits+`:	Internal constants
	`+ht-invalid+`:	Internal constants
	`+ht-len/dist+`:	Internal constants
	`+ht-link/end+`:	Internal constants
	`+ht-literal+`:	Internal constants
	`+ht-max-bits+`:	Internal constants
	`+len-code-extra+`:	Internal constants
	`+len-code-order+`:	Internal constants
	`+len/dist-bases+`:	Internal constants
	`+lengths-end+`:	Internal constants
	`+lengths-extra-bits-offset+`:	Internal constants
	`+lengths-start+`:	Internal constants
	`+max-tree-entries/dist+`:	Internal constants
	`+max-tree-entries/len+`:	Internal constants
	`+max-tree-size+`:	Internal constants
	`+static-huffman-tree/dist+`:	Internal constants
	`+static-huffman-tree/len+`:	Internal constants
	`+static-huffman-trees+`:	Internal constants

B
	`base`:	Internal classes
	`bits-remaining`:	Internal structures
	`boxes`:	Internal classes
	`boxes`:	Internal classes
	`boxes`:	Internal classes
	`bytes-to-copy`:	Internal structures

C
	`comment`:	Internal structures
	`compression-level`:	Internal structures
	`compression-level`:	Internal structures
	`compression-method`:	Internal structures
	`compression-method`:	Internal structures
	`Constant, +accumulate-count+`:	Internal constants
	`Constant, +adler32-prime+`:	Internal constants
	`Constant, +adler32-unroll+`:	Internal constants
	`Constant, +crc32/table+`:	Internal constants
	`Constant, +end-code+`:	Internal constants
	`Constant, +extra-bits+`:	Internal constants
	`Constant, +ht-invalid+`:	Internal constants
	`Constant, +ht-len/dist+`:	Internal constants
	`Constant, +ht-link/end+`:	Internal constants
	`Constant, +ht-literal+`:	Internal constants
	`Constant, +ht-max-bits+`:	Internal constants
	`Constant, +len-code-extra+`:	Internal constants
	`Constant, +len-code-order+`:	Internal constants
	`Constant, +len/dist-bases+`:	Internal constants
	`Constant, +lengths-end+`:	Internal constants
	`Constant, +lengths-extra-bits-offset+`:	Internal constants
	`Constant, +lengths-start+`:	Internal constants
	`Constant, +max-tree-entries/dist+`:	Internal constants
	`Constant, +max-tree-entries/len+`:	Internal constants
	`Constant, +max-tree-size+`:	Internal constants
	`Constant, +static-huffman-tree/dist+`:	Internal constants
	`Constant, +static-huffman-tree/len+`:	Internal constants
	`Constant, +static-huffman-trees+`:	Internal constants
	`copy-offset`:	Internal structures
	`crc32`:	Internal structures
	`current-huffman-tree`:	Internal structures
	`current-state`:	Internal structures

D
	`dht-hclen`:	Internal structures
	`dht-hlit`:	Internal structures
	`dht-hlit+hdist`:	Internal structures
	`dht-last-len`:	Internal structures
	`dht-len-codes`:	Internal structures
	`dht-len-tree`:	Internal structures
	`dht-lit/len/dist`:	Internal structures
	`dht-lit/len/dist-index`:	Internal structures
	`dict-id`:	Internal structures
	`dynamic-huffman-tree`:	Internal structures

E
	`end`:	Internal structures
	`extra`:	Internal structures

F
	`finished`:	Internal structures
	`flags`:	Internal structures

G
	`gzip-state`:	Internal structures

H
	`header-bytes`:	Internal structures

I
	`input-underrun`:	Internal structures

L
	`last-block-flag`:	Internal structures

M
	`max-bits`:	Internal structures
	`mtime/universal`:	Internal structures
	`mtime/unix`:	Internal structures

N
	`name`:	Internal structures
	`nodes`:	Internal structures

O
	`octet-stream`:	Internal classes
	`octet-vector`:	Internal classes
	`offset`:	Internal structures
	`op`:	Internal classes
	`operating-system`:	Internal structures
	`output-buffer`:	Internal structures
	`output-offset`:	Internal structures
	`output-overflow`:	Internal structures

P
	`partial-bits`:	Internal structures
	`pointer`:	Internal classes

S
	`s1`:	Internal structures
	`s2`:	Internal structures
	`scope`:	Internal classes
	`size`:	Internal classes
	`Slot, base`:	Internal classes
	`Slot, bits-remaining`:	Internal structures
	`Slot, boxes`:	Internal classes
	`Slot, boxes`:	Internal classes
	`Slot, boxes`:	Internal classes
	`Slot, bytes-to-copy`:	Internal structures
	`Slot, comment`:	Internal structures
	`Slot, compression-level`:	Internal structures
	`Slot, compression-level`:	Internal structures
	`Slot, compression-method`:	Internal structures
	`Slot, compression-method`:	Internal structures
	`Slot, copy-offset`:	Internal structures
	`Slot, crc32`:	Internal structures
	`Slot, current-huffman-tree`:	Internal structures
	`Slot, current-state`:	Internal structures
	`Slot, dht-hclen`:	Internal structures
	`Slot, dht-hlit`:	Internal structures
	`Slot, dht-hlit+hdist`:	Internal structures
	`Slot, dht-last-len`:	Internal structures
	`Slot, dht-len-codes`:	Internal structures
	`Slot, dht-len-tree`:	Internal structures
	`Slot, dht-lit/len/dist`:	Internal structures
	`Slot, dht-lit/len/dist-index`:	Internal structures
	`Slot, dict-id`:	Internal structures
	`Slot, dynamic-huffman-tree`:	Internal structures
	`Slot, end`:	Internal structures
	`Slot, extra`:	Internal structures
	`Slot, finished`:	Internal structures
	`Slot, flags`:	Internal structures
	`Slot, gzip-state`:	Internal structures
	`Slot, header-bytes`:	Internal structures
	`Slot, input-underrun`:	Internal structures
	`Slot, last-block-flag`:	Internal structures
	`Slot, max-bits`:	Internal structures
	`Slot, mtime/universal`:	Internal structures
	`Slot, mtime/unix`:	Internal structures
	`Slot, name`:	Internal structures
	`Slot, nodes`:	Internal structures
	`Slot, octet-stream`:	Internal classes
	`Slot, octet-vector`:	Internal classes
	`Slot, offset`:	Internal structures
	`Slot, op`:	Internal classes
	`Slot, operating-system`:	Internal structures
	`Slot, output-buffer`:	Internal structures
	`Slot, output-offset`:	Internal structures
	`Slot, output-overflow`:	Internal structures
	`Slot, partial-bits`:	Internal structures
	`Slot, pointer`:	Internal classes
	`Slot, s1`:	Internal structures
	`Slot, s2`:	Internal structures
	`Slot, scope`:	Internal classes
	`Slot, size`:	Internal classes
	`Slot, start`:	Internal structures
	`Slot, start-bits`:	Internal structures
	`Slot, window`:	Internal structures
	`Slot, window-size`:	Internal structures
	`Slot, zlib-state`:	Internal structures
	`Special Variable, %static-huffman-tree/dist%`:	Internal special variables
	`Special Variable, %static-huffman-tree/len%`:	Internal special variables
	`Special Variable, bit-rev-table`:	Internal special variables
	`Special Variable, cached-struct-defs`:	Internal special variables
	`Special Variable, fixed-dist-table`:	Internal special variables
	`Special Variable, fixed-lit/length-table`:	Internal special variables
	`Special Variable, stats`:	Internal special variables
	`start`:	Internal structures
	`start-bits`:	Internal structures

W
	`window`:	Internal structures
	`window-size`:	Internal structures

Z
	`zlib-state`:	Internal structures

Jump to:	% * + B C D E F G H I L M N O P S W Z

A.4 Data types

Jump to:	3 C D G H N O P S T U Z

	Index Entry	Section

3
	`3bz`:	The 3bz system
	`3bz`:	The 3bz package

C
	`Class, octet-pointer`:	Internal classes
	`Class, octet-pointer-context`:	Internal classes
	`Class, octet-stream-context`:	Internal classes
	`Class, octet-vector-context`:	Internal classes
	`code-table-type`:	Internal types
	`context-boxes`:	Internal structures

D
	`deflate-state`:	Internal structures

G
	`gzip-state`:	Internal structures

H
	`ht-bit-count-type`:	Internal types
	`ht-node-array-type`:	Internal types
	`ht-node-type`:	Internal types
	`ht-offset-type`:	Internal types
	`huffman-tree`:	Internal structures

N
	`non-negative-fixnum`:	Internal types

O
	`octet`:	Internal types
	`octet-pointer`:	Internal classes
	`octet-pointer-context`:	Internal classes
	`octet-stream-context`:	Internal classes
	`octet-vector`:	Internal types
	`octet-vector-context`:	Internal classes
	`offset-t`:	Internal types

P
	`Package, 3bz`:	The 3bz package

S
	`size-t`:	Internal types
	`Structure, context-boxes`:	Internal structures
	`Structure, deflate-state`:	Internal structures
	`Structure, gzip-state`:	Internal structures
	`Structure, huffman-tree`:	Internal structures
	`Structure, zlib-state`:	Internal structures
	`System, 3bz`:	The 3bz system

T
	`Type, code-table-type`:	Internal types
	`Type, ht-bit-count-type`:	Internal types
	`Type, ht-node-array-type`:	Internal types
	`Type, ht-node-type`:	Internal types
	`Type, ht-offset-type`:	Internal types
	`Type, non-negative-fixnum`:	Internal types
	`Type, octet`:	Internal types
	`Type, octet-vector`:	Internal types
	`Type, offset-t`:	Internal types
	`Type, size-t`:	Internal types
	`Type, ub16`:	Internal types
	`Type, ub32`:	Internal types
	`Type, ub64`:	Internal types
	`Type, ub8`:	Internal types

U
	`ub16`:	Internal types
	`ub32`:	Internal types
	`ub64`:	Internal types
	`ub8`:	Internal types

Z
	`zlib-state`:	Internal structures

Jump to:	3 C D G H N O P S T U Z

• Introduction		What 3bz is all about
• Systems		The systems documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• The 3bz.asd file
• The 3bz/package.lisp file
• The 3bz/tuning.lisp file
• The 3bz/util.lisp file
• The 3bz/constants.lisp file
• The 3bz/types.lisp file
• The 3bz/huffman-tree.lisp file
• The 3bz/ht-constants.lisp file
• The 3bz/io-common.lisp file
• The 3bz/io-nommap.lisp file
• The 3bz/io-mmap.lisp file
• The 3bz/io.lisp file
• The 3bz/deflate.lisp file
• The 3bz/checksums.lisp file
• The 3bz/zlib.lisp file
• The 3bz/gzip.lisp file
• The 3bz/api.lisp file

• Internal constants
• Internal special variables
• Internal macros
• Internal functions
• Internal generic functions
• Internal structures
• Internal classes
• Internal types

• Concept index
• Function index
• Variable index
• Data type index

• Exported macros
• Exported functions
• Exported generic functions

The 3bz Reference Manual

Table of Contents

The 3bz Reference Manual

1 Introduction

Still somewhat WIP, but approaching usability.

API/usage

easy API:

full API:

performance notes:

2 Systems

2.1 3bz

3 Files

3.1 Lisp

3.1.1 3bz.asd

3.1.2 3bz/package.lisp

3.1.3 3bz/tuning.lisp

3.1.4 3bz/util.lisp

3.1.5 3bz/constants.lisp

3.1.6 3bz/types.lisp

3.1.7 3bz/huffman-tree.lisp

3.1.8 3bz/ht-constants.lisp

3.1.9 3bz/io-common.lisp

3.1.10 3bz/io-nommap.lisp

3.1.11 3bz/io-mmap.lisp

3.1.12 3bz/io.lisp

3.1.13 3bz/deflate.lisp

3.1.14 3bz/checksums.lisp

3.1.15 3bz/zlib.lisp

3.1.16 3bz/gzip.lisp

3.1.17 3bz/api.lisp

4 Packages

4.1 3bz

5 Definitions

5.1 Exported definitions

5.1.1 Macros

5.1.2 Functions

5.1.3 Generic functions

5.2 Internal definitions

5.2.1 Constants

5.2.2 Special variables

5.2.3 Macros

5.2.4 Functions

5.2.5 Generic functions

5.2.6 Structures

5.2.7 Classes

5.2.8 Types

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `3bz`

3.1.1 `3bz.asd`

3.1.2 `3bz/package.lisp`

3.1.3 `3bz/tuning.lisp`

3.1.4 `3bz/util.lisp`

3.1.5 `3bz/constants.lisp`

3.1.6 `3bz/types.lisp`

3.1.7 `3bz/huffman-tree.lisp`

3.1.8 `3bz/ht-constants.lisp`

3.1.9 `3bz/io-common.lisp`

3.1.10 `3bz/io-nommap.lisp`

3.1.11 `3bz/io-mmap.lisp`

3.1.12 `3bz/io.lisp`

3.1.13 `3bz/deflate.lisp`

3.1.14 `3bz/checksums.lisp`

3.1.15 `3bz/zlib.lisp`

3.1.16 `3bz/gzip.lisp`

3.1.17 `3bz/api.lisp`

4.1 `3bz`