This is the cl-conspack Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 03:50:54 2024 GMT+0.
cl-conspack/cl-conspack.asd
cl-conspack/package.lisp
cl-conspack/types.lisp
cl-conspack/properties.lisp
cl-conspack/secure.lisp
cl-conspack/reftable.lisp
cl-conspack/r-ref.lisp
cl-conspack/headers.lisp
cl-conspack/indexes.lisp
cl-conspack/tmap.lisp
cl-conspack/array.lisp
cl-conspack/encode.lisp
cl-conspack/decode.lisp
cl-conspack/explain.lisp
The main system appears first, followed by any subsystem dependency.
cl-conspack
CONSPACK implementation for Common Lisp
Ryan Pavlik
NewBSD
closer-mop
(system).
alexandria
(system).
ieee-floats
(system).
trivial-utf-8
(system).
fast-io
(system).
trivial-garbage
(system).
package.lisp
(file).
types.lisp
(file).
properties.lisp
(file).
secure.lisp
(file).
reftable.lisp
(file).
r-ref.lisp
(file).
headers.lisp
(file).
indexes.lisp
(file).
tmap.lisp
(file).
array.lisp
(file).
encode.lisp
(file).
decode.lisp
(file).
explain.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-conspack/cl-conspack.asd
cl-conspack/package.lisp
cl-conspack/types.lisp
cl-conspack/properties.lisp
cl-conspack/secure.lisp
cl-conspack/reftable.lisp
cl-conspack/r-ref.lisp
cl-conspack/headers.lisp
cl-conspack/indexes.lisp
cl-conspack/tmap.lisp
cl-conspack/array.lisp
cl-conspack/encode.lisp
cl-conspack/decode.lisp
cl-conspack/explain.lisp
cl-conspack/cl-conspack.asd
cl-conspack
(system).
cl-conspack/types.lisp
package.lisp
(file).
cl-conspack
(system).
conspack-error
(condition).
conspack-error-reason
(reader method).
conspack-error-value
(reader method).
duplicate-id
(condition).
invalid-header
(condition).
invalid-index
(condition).
invalid-package-name
(condition).
invalid-symbol-name
(condition).
invalid-symbol-package
(condition).
invalid-tmap-type
(condition).
unhandled-remote-reference
(condition).
duplicate-ref-existing-value
(reader method).
duplicate-ref-new-value
(reader method).
forward-referenced-properties
(condition).
header
(type).
header-decode-fun
(type).
header-test-fun
(type).
invalid-forward-ref
(condition).
invalid-size
(condition).
max-size-exceeded
(condition).
security-error
(condition).
toplevel-forward-ref
(condition).
vacuous-properties
(condition).
vacuous-ref
(condition).
cl-conspack/properties.lisp
types.lisp
(file).
cl-conspack
(system).
properties
(function).
property
(function).
(setf property)
(function).
remove-properties
(function).
remove-property
(function).
with-properties
(macro).
*properties*
(special variable).
cl-conspack/secure.lisp
properties.lisp
(file).
cl-conspack
(system).
*conspack-forward-refs*
(special variable).
*conspack-max-bytes*
(special variable).
with-conspack-security
(macro).
*bytes-alloc*
(special variable).
*conspack-security*
(special variable).
+platform-bytes+
(constant).
container-precheck-bytes
(function).
precheck-bytes
(function).
use-bytes
(function).
cl-conspack/reftable.lisp
secure.lisp
(file).
cl-conspack
(system).
clear-refs
(function).
make-ref-context
(function).
tracking-refs
(macro).
*ref-context*
(special variable).
add-ref
(function).
copy-ref-context
(function).
get-ref
(function).
get-ref-id
(function).
list-length-with-refs
(function).
notice-object
(function).
notice-recursively
(function).
noticed-p
(function).
ref-context
(structure).
ref-context-encoded-objects
(reader).
(setf ref-context-encoded-objects)
(writer).
ref-context-id-to-obj
(reader).
(setf ref-context-id-to-obj)
(writer).
ref-context-max-id
(reader).
(setf ref-context-max-id)
(writer).
ref-context-noticed-objects
(reader).
(setf ref-context-noticed-objects)
(writer).
ref-context-obj-to-id
(reader).
(setf ref-context-obj-to-id)
(writer).
ref-context-p
(function).
ref-context-written-objects
(reader).
(setf ref-context-written-objects)
(writer).
referrable-p
(function).
tag-object
(function).
tracking-refs-p
(function).
trivial-p
(function).
written-p
(function).
wrote
(function).
cl-conspack/r-ref.lisp
reftable.lisp
(file).
cl-conspack
(system).
make-r-ref
(function).
r-ref
(function).
r-ref
(structure).
with-remote-refs
(macro).
*remote-ref-fun*
(special variable).
copy-r-ref
(function).
r-ref-p
(function).
r-ref-value
(reader).
(setf r-ref-value)
(writer).
cl-conspack/headers.lisp
r-ref.lisp
(file).
cl-conspack
(system).
+boolean-header+
(constant).
+character-header+
(constant).
+complex+
(constant).
+cons-header+
(constant).
+container-fixed+
(constant).
+container-header+
(constant).
+container-list+
(constant).
+container-map+
(constant).
+container-tmap+
(constant).
+container-vector+
(constant).
+double-float+
(constant).
+index-header+
(constant).
+int128+
(constant).
+int16+
(constant).
+int32+
(constant).
+int64+
(constant).
+int8+
(constant).
+number-header+
(constant).
+package-header+
(constant).
+pointer-header+
(constant).
+properties-header+
(constant).
+r-ref-header+
(constant).
+rational+
(constant).
+ref-header+
(constant).
+reftag-inline+
(constant).
+single-float+
(constant).
+string-header+
(constant).
+symbol-header+
(constant).
+symbol-keyword+
(constant).
+tag-header+
(constant).
+uint128+
(constant).
+uint16+
(constant).
+uint32+
(constant).
+uint64+
(constant).
+uint8+
(constant).
bits-size-type
(function).
boolean-p
(function).
character-header
(function).
character-p
(function).
cons-p
(function).
container-fixed-p
(function).
container-header
(function).
container-p
(function).
container-type
(function).
decode-container-type
(function).
decode-header
(function).
decode-number-header
(function).
find-fixed-type
(function).
index-p
(function).
keyword-p
(function).
len-size-type
(function).
number-header
(function).
number-p
(function).
number-size
(function).
number-type
(function).
number-type-to-lisp
(function).
package-p
(function).
pointer-header-p
(function).
properties-p
(function).
ref-p
(function).
remote-ref-p
(function).
size-bytes
(function).
size-type
(function).
string-p
(function).
symbol-header
(function).
symbol-p
(function).
tag-inline-p
(function).
tag-p
(function).
type-header
(function).
cl-conspack/indexes.lisp
headers.lisp
(file).
cl-conspack
(system).
define-index
(macro).
delete-index
(function).
find-in-index
(function).
make-index
(function).
make-load-form
(method).
with-index
(macro).
with-named-index
(macro).
%make-symbol-index
(function).
*index*
(special variable).
*indexes*
(special variable).
copy-symbol-index
(function).
find-index
(function).
make-symbol-index
(function).
symbol-index
(structure).
symbol-index-id->sym
(reader).
(setf symbol-index-id->sym)
(writer).
symbol-index-p
(function).
symbol-index-sym->id
(reader).
(setf symbol-index-sym->id)
(writer).
cl-conspack/tmap.lisp
indexes.lisp
(file).
cl-conspack
(system).
alist-to-slots
(macro).
decode-object-allocate
(generic function).
decode-object-initialize
(generic function).
defencoding
(macro).
encode-object
(generic function).
object-class-identifier
(generic function).
slots-to-alist
(macro).
cl-conspack/array.lisp
tmap.lisp
(file).
cl-conspack
(system).
decode-object-allocate
(method).
decode-object-initialize
(method).
encode-object
(method).
object-class-identifier
(method).
cl-conspack/encode.lisp
array.lisp
(file).
cl-conspack
(system).
encode
(function).
encode-to-buffer
(function).
encode-to-file
(function).
pointer
(function).
pointer
(structure).
pointer-value
(reader).
(setf pointer-value)
(writer).
print-object
(method).
%encode
(function).
%properties-encode
(function).
copy-pointer
(function).
encode-boolean
(function).
encode-character
(function).
encode-cons
(function).
encode-hash
(function).
encode-header
(function).
encode-index
(function).
encode-length
(function).
encode-list
(function).
encode-number
(function).
encode-package
(function).
encode-pointer
(function).
encode-properties
(function).
encode-r-ref
(function).
encode-ref
(function).
encode-ref-or-value
(function).
encode-sequence
(function).
encode-string
(function).
encode-symbol
(function).
encode-tag
(function).
encode-tmap
(function).
encode-vector
(function).
make-pointer
(function).
pointer-bit-width
(reader).
(setf pointer-bit-width)
(writer).
pointer-p
(function).
cl-conspack/decode.lisp
encode.lisp
(file).
cl-conspack
(system).
*current-properties*
(special variable).
decode
(function).
decode-file
(function).
decode-stream
(function).
decode-value
(function).
with-interning
(macro).
%decode
(function).
*intern-symbols*
(special variable).
copy-incomplete
(function).
decode-boolean
(function).
decode-character
(function).
decode-cons
(function).
decode-container
(function).
decode-index
(function).
decode-list
(function).
decode-map
(function).
decode-number
(function).
decode-package
(function).
decode-pointer
(function).
decode-properties
(function).
decode-r-ref
(function).
decode-ref
(function).
decode-ref-id
(function).
decode-size
(function).
decode-string
(function).
decode-symbol
(function).
decode-tag
(function).
decode-tmap
(function).
decode-vector
(function).
incomplete
(structure).
incomplete-data
(reader).
(setf incomplete-data)
(writer).
incomplete-p
(function).
incomplete-type
(reader).
(setf incomplete-type)
(writer).
incomplete-value
(reader).
(setf incomplete-value)
(writer).
make-incomplete
(function).
mark-properties
(function).
try-completion
(function).
try-cons-completion
(function).
try-list-completion
(function).
try-map-completion
(function).
try-ref-completion
(function).
try-tmap-completion
(function).
try-vector-completion
(function).
cl-conspack/explain.lisp
decode.lisp
(file).
cl-conspack
(system).
explain
(function).
*explain-eof*
(special variable).
explain-buffer
(function).
explain-container
(function).
explaining-errors
(macro).
Packages are listed by definition order.
conspack
cpk
alexandria
.
closer-common-lisp
.
fast-io
.
*conspack-forward-refs*
(special variable).
*conspack-max-bytes*
(special variable).
*current-properties*
(special variable).
alist-to-slots
(macro).
clear-refs
(function).
conspack-error
(condition).
conspack-error-reason
(generic reader).
conspack-error-value
(generic reader).
decode
(function).
decode-file
(function).
decode-object-allocate
(generic function).
decode-object-initialize
(generic function).
decode-stream
(function).
decode-value
(function).
defencoding
(macro).
define-index
(macro).
delete-index
(function).
duplicate-id
(condition).
encode
(function).
encode-object
(generic function).
encode-to-buffer
(function).
encode-to-file
(function).
explain
(function).
find-in-index
(function).
invalid-header
(condition).
invalid-index
(condition).
invalid-package-name
(condition).
invalid-symbol-name
(condition).
invalid-symbol-package
(condition).
invalid-tmap-type
(condition).
make-index
(function).
make-r-ref
(function).
make-ref-context
(function).
object-class-identifier
(generic function).
pointer
(function).
pointer
(structure).
pointer-value
(reader).
(setf pointer-value)
(writer).
properties
(function).
property
(function).
(setf property)
(function).
r-ref
(function).
r-ref
(structure).
remove-properties
(function).
remove-property
(function).
slots-to-alist
(macro).
tracking-refs
(macro).
unhandled-remote-reference
(condition).
with-conspack-security
(macro).
with-index
(macro).
with-interning
(macro).
with-named-index
(macro).
with-properties
(macro).
with-remote-refs
(macro).
%decode
(function).
%encode
(function).
%make-symbol-index
(function).
%properties-encode
(function).
*bytes-alloc*
(special variable).
*conspack-security*
(special variable).
*explain-eof*
(special variable).
*index*
(special variable).
*indexes*
(special variable).
*intern-symbols*
(special variable).
*properties*
(special variable).
*ref-context*
(special variable).
*remote-ref-fun*
(special variable).
+boolean-header+
(constant).
+character-header+
(constant).
+complex+
(constant).
+cons-header+
(constant).
+container-fixed+
(constant).
+container-header+
(constant).
+container-list+
(constant).
+container-map+
(constant).
+container-tmap+
(constant).
+container-vector+
(constant).
+double-float+
(constant).
+index-header+
(constant).
+int128+
(constant).
+int16+
(constant).
+int32+
(constant).
+int64+
(constant).
+int8+
(constant).
+number-header+
(constant).
+package-header+
(constant).
+platform-bytes+
(constant).
+pointer-header+
(constant).
+properties-header+
(constant).
+r-ref-header+
(constant).
+rational+
(constant).
+ref-header+
(constant).
+reftag-inline+
(constant).
+single-float+
(constant).
+string-header+
(constant).
+symbol-header+
(constant).
+symbol-keyword+
(constant).
+tag-header+
(constant).
+uint128+
(constant).
+uint16+
(constant).
+uint32+
(constant).
+uint64+
(constant).
+uint8+
(constant).
add-ref
(function).
bits-size-type
(function).
boolean-p
(function).
character-header
(function).
character-p
(function).
cons-p
(function).
container-fixed-p
(function).
container-header
(function).
container-p
(function).
container-precheck-bytes
(function).
container-type
(function).
copy-incomplete
(function).
copy-pointer
(function).
copy-r-ref
(function).
copy-ref-context
(function).
copy-symbol-index
(function).
decode-boolean
(function).
decode-character
(function).
decode-cons
(function).
decode-container
(function).
decode-container-type
(function).
decode-header
(function).
decode-index
(function).
decode-list
(function).
decode-map
(function).
decode-number
(function).
decode-number-header
(function).
decode-package
(function).
decode-pointer
(function).
decode-properties
(function).
decode-r-ref
(function).
decode-ref
(function).
decode-ref-id
(function).
decode-size
(function).
decode-string
(function).
decode-symbol
(function).
decode-tag
(function).
decode-tmap
(function).
decode-vector
(function).
duplicate-ref-existing-value
(generic reader).
duplicate-ref-new-value
(generic reader).
encode-boolean
(function).
encode-character
(function).
encode-cons
(function).
encode-hash
(function).
encode-header
(function).
encode-index
(function).
encode-length
(function).
encode-list
(function).
encode-number
(function).
encode-package
(function).
encode-pointer
(function).
encode-properties
(function).
encode-r-ref
(function).
encode-ref
(function).
encode-ref-or-value
(function).
encode-sequence
(function).
encode-string
(function).
encode-symbol
(function).
encode-tag
(function).
encode-tmap
(function).
encode-vector
(function).
explain-buffer
(function).
explain-container
(function).
explaining-errors
(macro).
find-fixed-type
(function).
find-index
(function).
forward-referenced-properties
(condition).
get-ref
(function).
get-ref-id
(function).
header
(type).
header-decode-fun
(type).
header-test-fun
(type).
incomplete
(structure).
incomplete-data
(reader).
(setf incomplete-data)
(writer).
incomplete-p
(function).
incomplete-type
(reader).
(setf incomplete-type)
(writer).
incomplete-value
(reader).
(setf incomplete-value)
(writer).
index-p
(function).
invalid-forward-ref
(condition).
invalid-size
(condition).
keyword-p
(function).
len-size-type
(function).
list-length-with-refs
(function).
make-incomplete
(function).
make-pointer
(function).
make-symbol-index
(function).
mark-properties
(function).
max-size-exceeded
(condition).
notice-object
(function).
notice-recursively
(function).
noticed-p
(function).
number-header
(function).
number-p
(function).
number-size
(function).
number-type
(function).
number-type-to-lisp
(function).
package-p
(function).
pointer-bit-width
(reader).
(setf pointer-bit-width)
(writer).
pointer-header-p
(function).
pointer-p
(function).
precheck-bytes
(function).
properties-p
(function).
r-ref-p
(function).
r-ref-value
(reader).
(setf r-ref-value)
(writer).
ref-context
(structure).
ref-context-encoded-objects
(reader).
(setf ref-context-encoded-objects)
(writer).
ref-context-id-to-obj
(reader).
(setf ref-context-id-to-obj)
(writer).
ref-context-max-id
(reader).
(setf ref-context-max-id)
(writer).
ref-context-noticed-objects
(reader).
(setf ref-context-noticed-objects)
(writer).
ref-context-obj-to-id
(reader).
(setf ref-context-obj-to-id)
(writer).
ref-context-p
(function).
ref-context-written-objects
(reader).
(setf ref-context-written-objects)
(writer).
ref-p
(function).
referrable-p
(function).
remote-ref-p
(function).
security-error
(condition).
size-bytes
(function).
size-type
(function).
string-p
(function).
symbol-header
(function).
symbol-index
(structure).
symbol-index-id->sym
(reader).
(setf symbol-index-id->sym)
(writer).
symbol-index-p
(function).
symbol-index-sym->id
(reader).
(setf symbol-index-sym->id)
(writer).
symbol-p
(function).
tag-inline-p
(function).
tag-object
(function).
tag-p
(function).
toplevel-forward-ref
(condition).
tracking-refs-p
(function).
trivial-p
(function).
try-completion
(function).
try-cons-completion
(function).
try-list-completion
(function).
try-map-completion
(function).
try-ref-completion
(function).
try-tmap-completion
(function).
try-vector-completion
(function).
type-header
(function).
use-bytes
(function).
vacuous-properties
(condition).
vacuous-ref
(condition).
written-p
(function).
wrote
(function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Set slots via ‘(SETF (SLOT-VALUE ...))‘ based on the values of the
slots specified.
Slots are set on the provided ‘INSTANCE‘.
Trivially define ‘ENCODE-OBJECT‘ and ‘DECODE-OBJECT-INITIALIZE‘ to store and load the given slots.
Produce an ‘ALIST‘ of slot-names-to-slot-values, suitable for ‘ENCODE-OBJECT‘.
conspack-error
)) ¶conspack-error
)) ¶Create an empty object of the given ‘CLASS‘
based on the values in the ‘ALIST‘. Note that any values in the TMap
that are or contain forward references may not appear in the alist,
and containers may be uninitialized. The alist will only be complete
when passed to ‘DECODE-OBJECT-INITIALIZE‘.
Methods should specialize on ‘CLASS (EQL symbol)‘.
Initialize an empty OBJECT of the given ‘CLASS‘
based on the values in the ‘ALIST‘. Methods should specialize on ‘OBJECT‘,
but can use the ‘CLASS‘ if they wish. Return value is ignored.
progn
.
:most-specific-last
array
) class alist &key &allow-other-keys) ¶Return an alist for ‘OBJECT‘ which will be used for
key-value pairs for a Typed Map (tmap). The class of ‘OBJECT‘ will
be encoded along with these and used by the decoder to recreate
the object.
append
.
:most-specific-first
array
) &key &allow-other-keys) ¶Return a value for ‘OBJECT‘ which will be used as
the class for a Typed Map (tmap). This object will be encoded along
with the key-value pairs returned by ‘ENCODE-OBJECT‘ and used by
the decoder to recreate the object.
symbol-index
) &optional environment) ¶structure-object
.
Object => PLIST association for Properties. Setting a property and encoding will encode that property. Decoded properties will be included here as well.
Combine ‘VALUES‘ with LOGIOR and write.
This will try and find and interpret as many bytes as possible, up to ‘N‘ objects, or until end-of-file, if ‘N‘ is ‘nil‘.
data
.
type
.
Find the closest/smallest encoding type for NUMBER.
Find the lisp type (e.g., SINGLE-FLOAT) for a specified number type (e.g., :SINGLE-FLOAT). The inverse of NUMBER-TYPE.
duplicate-id
)) ¶duplicate-id
)) ¶structure-object
.
(unsigned-byte 32)
0
(make-hash-table)
(make-hash-table)
(make-hash-table)
(make-hash-table)
(make-hash-table)
Jump to: | %
(
A B C D E F G I K L M N O P R S T U W |
---|
Jump to: | %
(
A B C D E F G I K L M N O P R S T U W |
---|
Jump to: | *
+
B C D E I M N O R S T V W |
---|
Jump to: | *
+
B C D E I M N O R S T V W |
---|
Jump to: | A C D E F H I M P R S T U V |
---|
Jump to: | A C D E F H I M P R S T U V |
---|