This is the salza2 Reference Manual, version 2.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:38:40 2024 GMT+0.
salza2/salza2.asdsalza2/package.lispsalza2/reset.lispsalza2/specials.lispsalza2/types.lispsalza2/checksum.lispsalza2/adler32.lispsalza2/crc32.lispsalza2/chains.lispsalza2/bitstream.lispsalza2/matches.lispsalza2/compress.lispsalza2/huffman.lispsalza2/closures.lispsalza2/compressor.lispsalza2/utilities.lispsalza2/zlib.lispsalza2/gzip.lispsalza2/user.lispsalza2/stream.lispThe main system appears first, followed by any subsystem dependency.
salza2Create compressed data in the ZLIB, DEFLATE, or GZIP data formats
Zachary Beane <xach@xach.com>
BSD
2.1
trivial-gray-streams (system).
package.lisp (file).
reset.lisp (file).
specials.lisp (file).
types.lisp (file).
checksum.lisp (file).
adler32.lisp (file).
crc32.lisp (file).
chains.lisp (file).
bitstream.lisp (file).
matches.lisp (file).
compress.lisp (file).
huffman.lisp (file).
closures.lisp (file).
compressor.lisp (file).
utilities.lisp (file).
zlib.lisp (file).
gzip.lisp (file).
user.lisp (file).
stream.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
salza2/salza2.asdsalza2/package.lispsalza2/reset.lispsalza2/specials.lispsalza2/types.lispsalza2/checksum.lispsalza2/adler32.lispsalza2/crc32.lispsalza2/chains.lispsalza2/bitstream.lispsalza2/matches.lispsalza2/compress.lispsalza2/huffman.lispsalza2/closures.lispsalza2/compressor.lispsalza2/utilities.lispsalza2/zlib.lispsalza2/gzip.lispsalza2/user.lispsalza2/stream.lispsalza2/reset.lisppackage.lisp (file).
salza2 (system).
reset (generic function).
salza2/specials.lisppackage.lisp (file).
salza2 (system).
+bitstream-buffer-bitmask+ (special variable).
+bitstream-buffer-bits+ (special variable).
+bitstream-buffer-mask+ (special variable).
+bitstream-buffer-size+ (special variable).
+buffer-size+ (special variable).
+buffer-size-mask+ (special variable).
+final-block+ (constant).
+fixed-tables+ (constant).
+hashes-size+ (special variable).
+input-limit+ (special variable).
+input-limit-mask+ (special variable).
+input-mask+ (special variable).
+input-size+ (special variable).
+radix+ (special variable).
+rmax+ (special variable).
salza2/types.lisppackage.lisp (file).
specials.lisp (file).
salza2 (system).
array-index (type).
bitstream-buffer (type).
bitstream-buffer-bit-count (type).
chains-buffer (type).
hash (type).
hashes-buffer (type).
input-buffer (type).
input-index (type).
octet (type).
octet-vector (type).
salza2/checksum.lisppackage.lisp (file).
reset.lisp (file).
salza2 (system).
result (generic function).
result-octets (generic function).
update (generic function).
checksum (class).
ub32-octets (function).
salza2/adler32.lispchecksum.lisp (file).
types.lisp (file).
salza2 (system).
adler32-checksum (class).
reset (method).
result (method).
result-octets (method).
update (method).
+adler32-base+ (constant).
adler32-update (function).
high (reader method).
(setf high) (writer method).
low (reader method).
(setf low) (writer method).
salza2/crc32.lispchecksum.lisp (file).
types.lisp (file).
salza2 (system).
crc32-checksum (class).
reset (method).
result (method).
result-octets (method).
update (method).
*crc32-table* (special variable).
crc32 (function).
crc32-table (function).
high (reader method).
(setf high) (writer method).
low (reader method).
(setf low) (writer method).
salza2/chains.lisppackage.lisp (file).
specials.lisp (file).
salza2 (system).
hash-value (function).
mod8191 (function).
update-chains (function).
salza2/bitstream.lisppackage.lisp (file).
specials.lisp (file).
reset.lisp (file).
salza2 (system).
callback (reader method).
(setf callback) (writer method).
reset (method).
write-bits (generic function).
write-octet (generic function).
write-octet-vector (generic function).
bits (reader method).
(setf bits) (writer method).
bitstream (class).
bitstream-callback-missing (function).
buffer (reader method).
(setf buffer) (writer method).
flush (generic function).
merge-bits (function).
merge-octet (function).
salza2/matches.lisppackage.lisp (file).
types.lisp (file).
salza2 (system).
+maximum-match-distance+ (constant).
+maximum-match-length+ (constant).
longest-match (function).
match-length (function).
salza2/compress.lisptypes.lisp (file).
matches.lisp (file).
salza2 (system).
compress (function).
salza2/huffman.lisppackage.lisp (file).
salza2 (system).
*distance-codes* (special variable).
*fixed-huffman-codes* (special variable).
*length-codes* (special variable).
code-vector (function).
code-vector (type).
codes (reader method).
(setf codes) (writer method).
distance-codes (function).
fixed-huffman-codes (function).
huffman-codes (class).
length-codes (function).
reverse-bits (function).
size-vector (function).
size-vector (type).
sizes (reader method).
(setf sizes) (writer method).
salza2/closures.lisphuffman.lisp (file).
bitstream.lisp (file).
salza2 (system).
make-huffman-writer (function).
salza2/compressor.lisppackage.lisp (file).
closures.lisp (file).
utilities.lisp (file).
specials.lisp (file).
bitstream.lisp (file).
reset.lisp (file).
salza2 (system).
(setf callback) (method).
compress-octet (generic function).
compress-octet-vector (generic function).
deflate-compressor (class).
finish-compression (generic function).
finish-data-format (generic function).
initialize-instance (method).
process-input (generic function).
reset (method).
start-data-format (generic function).
with-compressor (macro).
write-bits (method).
write-octet (method).
write-octet-vector (method).
bitstream (reader method).
(setf bitstream) (writer method).
byte-fun (reader method).
(setf byte-fun) (writer method).
chains (reader method).
(setf chains) (writer method).
compress-fun (reader method).
(setf compress-fun) (writer method).
counter (reader method).
(setf counter) (writer method).
distance-fun (reader method).
(setf distance-fun) (writer method).
end (reader method).
(setf end) (writer method).
error-missing-callback (function).
final-compress (generic function).
hashes (reader method).
(setf hashes) (writer method).
input (reader method).
(setf input) (writer method).
length-fun (reader method).
(setf length-fun) (writer method).
literal-fun (reader method).
(setf literal-fun) (writer method).
make-chains (function).
make-compress-fun (generic function).
make-hashes (function).
make-input (function).
merge-input (function).
octet-buffer (reader method).
(setf octet-buffer) (writer method).
reinitialize-bitstream-funs (function).
start (reader method).
(setf start) (writer method).
salza2/utilities.lisppackage.lisp (file).
salza2 (system).
make-octet-vector (function).
octet-vector (function).
salza2/zlib.lisppackage.lisp (file).
adler32.lisp (file).
reset.lisp (file).
compressor.lisp (file).
salza2 (system).
finish-data-format (method).
process-input (method).
reset (method).
start-data-format (method).
zlib-compressor (class).
adler32 (reader method).
(setf adler32) (writer method).
salza2/gzip.lisppackage.lisp (file).
crc32.lisp (file).
reset.lisp (file).
compressor.lisp (file).
salza2 (system).
finish-data-format (method).
gzip-compressor (class).
process-input (method).
reset (method).
start-data-format (method).
*gzip-signature* (special variable).
+gzip-deflate-compression+ (constant).
+gzip-fast-compression+ (constant).
+gzip-flags+ (constant).
+gzip-mtime+ (constant).
+gzip-unix-os+ (constant).
checksum (reader method).
(setf checksum) (writer method).
data-length (reader method).
(setf data-length) (writer method).
gzip-write-u32 (function).
salza2/user.lisppackage.lisp (file).
compressor.lisp (file).
zlib.lisp (file).
gzip.lisp (file).
salza2 (system).
compress-data (function).
gzip-file (function).
gzip-stream (function).
make-stream-output-callback (function).
compressor-designator-compressor (function).
salza2/stream.lisppackage.lisp (file).
salza2 (system).
close (method).
make-compressing-stream (function).
stream-closed-error (condition).
stream-element-type (method).
(setf stream-file-position) (method).
stream-file-position (method).
stream-write-byte (method).
stream-write-sequence (method).
compressing-stream (class).
compressor (reader method).
(setf compressor) (writer method).
openp (reader method).
(setf openp) (writer method).
Packages are listed by definition order.
salza2common-lisp.
adler32-checksum (class).
callback (generic reader).
(setf callback) (generic function).
compress-data (function).
compress-octet (generic function).
compress-octet-vector (generic function).
crc32-checksum (class).
deflate-compressor (class).
finish-compression (generic function).
finish-data-format (generic function).
gzip-compressor (class).
gzip-file (function).
gzip-stream (function).
make-compressing-stream (function).
make-stream-output-callback (function).
process-input (generic function).
reset (generic function).
result (generic function).
result-octets (generic function).
start-data-format (generic function).
stream-closed-error (condition).
update (generic function).
with-compressor (macro).
write-bits (generic function).
write-octet (generic function).
write-octet-vector (generic function).
zlib-compressor (class).
*crc32-table* (special variable).
*distance-codes* (special variable).
*fixed-huffman-codes* (special variable).
*gzip-signature* (special variable).
*length-codes* (special variable).
+adler32-base+ (constant).
+bitstream-buffer-bitmask+ (special variable).
+bitstream-buffer-bits+ (special variable).
+bitstream-buffer-mask+ (special variable).
+bitstream-buffer-size+ (special variable).
+buffer-size+ (special variable).
+buffer-size-mask+ (special variable).
+final-block+ (constant).
+fixed-tables+ (constant).
+gzip-deflate-compression+ (constant).
+gzip-fast-compression+ (constant).
+gzip-flags+ (constant).
+gzip-mtime+ (constant).
+gzip-unix-os+ (constant).
+hashes-size+ (special variable).
+input-limit+ (special variable).
+input-limit-mask+ (special variable).
+input-mask+ (special variable).
+input-size+ (special variable).
+maximum-match-distance+ (constant).
+maximum-match-length+ (constant).
+radix+ (special variable).
+rmax+ (special variable).
adler32 (generic reader).
(setf adler32) (generic writer).
adler32-update (function).
array-index (type).
bits (generic reader).
(setf bits) (generic writer).
bitstream (generic reader).
(setf bitstream) (generic writer).
bitstream (class).
bitstream-buffer (type).
bitstream-buffer-bit-count (type).
bitstream-callback-missing (function).
buffer (generic reader).
(setf buffer) (generic writer).
byte-fun (generic reader).
(setf byte-fun) (generic writer).
chains (generic reader).
(setf chains) (generic writer).
chains-buffer (type).
checksum (generic reader).
(setf checksum) (generic writer).
checksum (class).
code-vector (function).
code-vector (type).
codes (generic reader).
(setf codes) (generic writer).
compress (function).
compress-fun (generic reader).
(setf compress-fun) (generic writer).
compressing-stream (class).
compressor (generic reader).
(setf compressor) (generic writer).
compressor-designator-compressor (function).
counter (generic reader).
(setf counter) (generic writer).
crc32 (function).
crc32-table (function).
data-length (generic reader).
(setf data-length) (generic writer).
distance-codes (function).
distance-fun (generic reader).
(setf distance-fun) (generic writer).
end (generic reader).
(setf end) (generic writer).
error-missing-callback (function).
final-compress (generic function).
fixed-huffman-codes (function).
flush (generic function).
gzip-write-u32 (function).
hash (type).
hash-value (function).
hashes (generic reader).
(setf hashes) (generic writer).
hashes-buffer (type).
high (generic reader).
(setf high) (generic writer).
huffman-codes (class).
input (generic reader).
(setf input) (generic writer).
input-buffer (type).
input-index (type).
length-codes (function).
length-fun (generic reader).
(setf length-fun) (generic writer).
literal-fun (generic reader).
(setf literal-fun) (generic writer).
longest-match (function).
low (generic reader).
(setf low) (generic writer).
make-chains (function).
make-compress-fun (generic function).
make-hashes (function).
make-huffman-writer (function).
make-input (function).
make-octet-vector (function).
match-length (function).
merge-bits (function).
merge-input (function).
merge-octet (function).
mod8191 (function).
octet (type).
octet-buffer (generic reader).
(setf octet-buffer) (generic writer).
octet-vector (function).
octet-vector (type).
openp (generic reader).
(setf openp) (generic writer).
reinitialize-bitstream-funs (function).
reverse-bits (function).
size-vector (function).
size-vector (type).
sizes (generic reader).
(setf sizes) (generic writer).
start (generic reader).
(setf start) (generic writer).
ub32-octets (function).
update-chains (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Return a COMPRESSING-STREAM that transparently compresses its input and
writes it to STREAM. COMPRESSOR-TYPE is a symbol naming the compressor class to
use.
Closing the returned COMPRESSING-STREAM merely finalizes the compression and does not close STREAM.
Return a function suitable for use as a compressor callback that writes all compressed data to STREAM.
deflate-compressor)) ¶Add OCTET to the compressed data of COMPRESSOR.
Add the octets of VECTOR to the compressed data of COMPRESSOR.
Finish the data format and flush all pending data in the bitstream.
deflate-compressor)) ¶Add any needed epilogue data to the output bitstream.
gzip-compressor)) ¶zlib-compressor)) ¶deflate-compressor)) ¶Map over pending octets in INPUT and perform
any needed processing. Called before the data is compressed. A
subclass might use this to compute a checksum of all input
data.
gzip-compressor) input start count) ¶zlib-compressor) input start count) ¶deflate-compressor) input start count) ¶Restore OBJECT’s initial state so it may be re-used.
gzip-compressor)) ¶zlib-compressor)) ¶deflate-compressor)) ¶crc32-checksum)) ¶adler32-checksum)) ¶Return the result of CHECKSUM as an integer.
crc32-checksum)) ¶adler32-checksum)) ¶Return the result of CHECKSUM as a list of octets, in MSB order.
crc32-checksum)) ¶adler32-checksum)) ¶Add any needed prologue data to the output bitstream.
gzip-compressor)) ¶zlib-compressor)) ¶deflate-compressor)) ¶Update the CHECKSUM object with COUNT octets from BUFFER, starting from START.
crc32-checksum) input start count) ¶adler32-checksum) buffer start count) ¶deflate-compressor)) ¶deflate-compressor)) ¶deflate-compressor) &key start end) ¶compressing-stream) &key abort) ¶deflate-compressor) &rest initargs &key literal-fun length-fun distance-fun compress-fun callback) ¶compressing-stream)) ¶compressing-stream)) ¶Unable to seek within the stream.
trivial-gray-streams.
compressing-stream)) ¶Does not keep track of position in the stream.
trivial-gray-streams.
compressing-stream) byte) ¶sb-gray.
compressing-stream) sequence start end &key) ¶trivial-gray-streams.
Signaled when attempting to write to a closed COMPRESSING-STREAM.
stream-error.
(setf high).
high.
(setf low).
low.
reset.
result.
result-octets.
update.
| Initarg | Value |
|---|---|
:high | 0 |
:low | 1 |
(setf high).
high.
(setf low).
low.
reset.
result.
result-octets.
update.
| Initarg | Value |
|---|---|
:low | 65535 |
:high | 65535 |
(setf bitstream).
bitstream.
(setf byte-fun).
byte-fun.
(setf callback).
(setf chains).
chains.
(setf compress-fun).
compress-fun.
(setf counter).
counter.
(setf distance-fun).
distance-fun.
(setf end).
end.
final-compress.
finish-compression.
finish-data-format.
(setf hashes).
hashes.
initialize-instance.
(setf input).
input.
(setf length-fun).
length-fun.
(setf literal-fun).
literal-fun.
make-compress-fun.
(setf octet-buffer).
octet-buffer.
process-input.
reset.
(setf start).
start.
start-data-format.
write-bits.
write-octet.
write-octet-vector.
| Initarg | Value |
|---|---|
:input | (make-input) |
:chains | (make-chains) |
:hashes | (make-hashes) |
:start | 0 |
:end | 0 |
:counter | 0 |
:bitstream | (make-instance (quote bitstream)) |
:octet-buffer | (make-octet-vector 1) |
:input
:chains
:hashes
:start
:counter
:octet-buffer
:bitstream
:literal-fun
:length-fun
:distance-fun
:byte-fun
:compress-fun
| Initarg | Value |
|---|---|
:adler32 | (make-instance (quote adler32-checksum)) |
:adler32
Code for gzip compression level. This is present only to create valid gzip data; it has no meaning to the compressor and is only a hint to the decompressor.
The maximum distance for a match.
The maximum match length allowed.
These two octets precede all data in the gzip format.
Compute a table of the (code + extra bits) values for all possible distances as specified by RFC1951.
Generate the fixed Huffman codes specified by RFC1951.
Compute a table of the (Huffman + extra bits) values for all possible lengths for the given HUFFMAN-TABLE.
Returns the length of the match between positions p1 and p2 in INPUT; END is a sentinel position that ends the match length check if reached.
Merge COUNT octets from START of INPUT into OUTPUT at OFFSET; on reaching 32k boundaries within OUTPUT, call the COMPRESS-FUN with OUTPUT, a starting offset, and the count of pending data.
zlib-compressor)) ¶automatically generated reader method
zlib-compressor)) ¶automatically generated writer method
deflate-compressor)) ¶automatically generated reader method
deflate-compressor)) ¶automatically generated writer method
deflate-compressor)) ¶automatically generated reader method
deflate-compressor)) ¶automatically generated writer method
deflate-compressor)) ¶automatically generated reader method
deflate-compressor)) ¶automatically generated writer method
gzip-compressor)) ¶automatically generated reader method
gzip-compressor)) ¶automatically generated writer method
huffman-codes)) ¶automatically generated reader method
huffman-codes)) ¶automatically generated writer method
deflate-compressor)) ¶automatically generated reader method
deflate-compressor)) ¶automatically generated writer method
compressing-stream)) ¶automatically generated reader method
compressing-stream)) ¶automatically generated writer method
deflate-compressor)) ¶automatically generated reader method
deflate-compressor)) ¶automatically generated writer method
gzip-compressor)) ¶automatically generated reader method
gzip-compressor)) ¶automatically generated writer method
deflate-compressor)) ¶automatically generated reader method
deflate-compressor)) ¶automatically generated writer method
deflate-compressor)) ¶automatically generated reader method
end.
deflate-compressor)) ¶automatically generated writer method
end.
Perform the final compression on pending input data in COMPRESSOR.
deflate-compressor)) ¶deflate-compressor)) ¶automatically generated reader method
deflate-compressor)) ¶automatically generated writer method
crc32-checksum)) ¶automatically generated reader method
high.
adler32-checksum)) ¶automatically generated reader method
high.
crc32-checksum)) ¶automatically generated writer method
high.
adler32-checksum)) ¶automatically generated writer method
high.
deflate-compressor)) ¶automatically generated reader method
deflate-compressor)) ¶automatically generated writer method
deflate-compressor)) ¶automatically generated reader method
deflate-compressor)) ¶automatically generated writer method
deflate-compressor)) ¶automatically generated reader method
deflate-compressor)) ¶automatically generated writer method
crc32-checksum)) ¶automatically generated reader method
low.
adler32-checksum)) ¶automatically generated reader method
low.
crc32-checksum)) ¶automatically generated writer method
low.
adler32-checksum)) ¶automatically generated writer method
low.
Create a callback suitable for passing to
MERGE-INPUT for performing incremental compression of the next
32k octets of input.
deflate-compressor)) ¶deflate-compressor)) ¶automatically generated reader method
deflate-compressor)) ¶automatically generated writer method
compressing-stream)) ¶automatically generated reader method
compressing-stream)) ¶automatically generated writer method
huffman-codes)) ¶automatically generated reader method
huffman-codes)) ¶automatically generated writer method
deflate-compressor)) ¶automatically generated reader method
deflate-compressor)) ¶automatically generated writer method
| Initarg | Value |
|---|---|
:buffer | (make-array +bitstream-buffer-size+ element-type (quote octet)) |
:bits | 0 |
:callback | (function bitstream-callback-missing) |
Holds accumulated bits packed into octets.
:buffer
A function of two arguments, BUFFER and END,
that should write out all the data in BUFFER up to END.
:callback
A gray stream that transparently compresses its input and writes the compressed data to another stream.
| Jump to: | (
A B C D E F G H I L M O P R S U W |
|---|
| Jump to: | (
A B C D E F G H I L M O P R S U W |
|---|
| Jump to: | *
+
A B C D E H I L O S |
|---|
| Jump to: | *
+
A B C D E H I L O S |
|---|
| Jump to: | A B C D F G H I M O P R S T U Z |
|---|
| Jump to: | A B C D F G H I M O P R S T U Z |
|---|