The cl-store Reference Manual

Table of Contents

The cl-store Reference Manual

This is the cl-store Reference Manual, version 0.8.11, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:50:50 2020 GMT+0.

1 Systems

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

1.1 cl-store

Maintainer

Sean Ross <sross@common-lisp.net>

Author

Sean Ross <sross@common-lisp.net>

License

MIT

Description

Serialization package

Long Description

Portable CL Package to serialize data

Version

0.8.11

Source

cl-store.asd (file)

Components

• package.lisp (file)
• utils.lisp (file)
• backends.lisp (file)
• plumbing.lisp (file)
• circularities.lisp (file)
• default-backend.lisp (file)
• custom.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 cl-store.asd

Location

cl-store.asd

Systems

cl-store (system)

Packages

cl-store.system

Exported Definitions

non-required-file (class)

Internal Definitions

lisp-system-shortname (function)

2.1.2 cl-store/package.lisp

Parent

cl-store (system)

Location

package.lisp

Packages

cl-store

2.1.3 cl-store/utils.lisp

Dependency

package.lisp (file)

Parent

cl-store (system)

Location

utils.lisp

Exported Definitions

• float-type (function)
• get-float-type (function)
• get-slot-details (generic function)
• get-slot-details (method)
• read-32-bit (function)
• serializable-slots (generic function)
• serializable-slots (method)
• serializable-slots (method)
• serializable-slots (method)
• serializable-slots-using-class (generic function)
• serializable-slots-using-class (method)
• serializable-slots-using-class (method)
• serializable-slots-using-class (method)
• store-32-bit (function)

Internal Definitions

• aif (macro)
• array-size (type)
• array-tot-size (type)
• kwd (function)
• make-ub32 (macro)
• mkstr (function)
• safe-length (function)
• sb32 (type)
• symbolicate (function)
• ub32 (type)
• when-let (macro)
• with-gensyms (macro)

2.1.4 cl-store/backends.lisp

Dependency

utils.lisp (file)

Parent

cl-store (system)

Location

backends.lisp

Exported Definitions

• alias-backend (function)
• backend (class)
• defbackend (macro)
• find-backend (function)
• magic-number (method)
• (setf magic-number) (method)
• stream-type (method)
• (setf stream-type) (method)
• with-backend (macro)

Internal Definitions

• *registered-backends* (special variable)
• backend-designator (type)
• backend-designator->backend (function)
• compatible-magic-numbers (method)
• (setf compatible-magic-numbers) (method)
• get-class-form (function)
• get-restore-macro (function)
• get-store-macro (function)
• name (method)
• (setf name) (method)
• old-magic-numbers (method)
• (setf old-magic-numbers) (method)
• register-backend (function)
• required-arg (function)

2.1.5 cl-store/plumbing.lisp

Dependency

backends.lisp (file)

Parent

cl-store (system)

Location

plumbing.lisp

Exported Definitions

• *current-backend* (special variable)
• *default-backend* (special variable)
• *nuke-existing-classes* (special variable)
• *nuke-existing-packages* (special variable)
• *store-class-slots* (special variable)
• *store-class-superclasses* (special variable)
• *store-used-packages* (special variable)
• backend-restore (generic function)
• backend-restore (method)
• backend-restore (method)
• backend-restore (method)
• backend-restore-object (generic function)
• backend-restore-object (method)
• backend-store (generic function)
• backend-store (method)
• backend-store (method)
• backend-store (method)
• backend-store-object (generic function)
• backend-store-object (method)
• caused-by (method)
• (setf caused-by) (method)
• check-magic-number (generic function)
• check-magic-number (method)
• cl-store-error (condition)
• get-next-reader (generic function)
• get-next-reader (method)
• internal-store-object (generic function)
• internal-store-object (method)
• (setf restore) (function)
• restore (generic function)
• restore (method)
• (setf restore) (function)
• restore-error (function)
• restore-error (condition)
• restore-object (function)
• store (generic function)
• store (method)
• store-backend-code (generic function)
• store-backend-code (method)
• store-error (function)
• store-error (condition)
• store-object (function)

Internal Definitions

• cl-store-report (function)
• format-args (method)
• (setf format-args) (method)
• format-string (method)
• (setf format-string) (method)
• internal-restore-object (generic function)
• lookup-reader (function)
• restore-from-file (function)
• store-to-file (function)

2.1.6 cl-store/circularities.lisp

Dependency

plumbing.lisp (file)

Parent

cl-store (system)

Location

circularities.lisp

Exported Definitions

• *check-for-circs* (special variable)
• *need-to-fix* (special variable)
• *restore-counter* (special variable)
• *restore-hash-size* (special variable)
• *restored-values* (special variable)
• *store-hash-size* (special variable)
• backend-restore (method)
• backend-restore-object (method)
• backend-store (method)
• backend-store (method)
• backend-store-object (method)
• create-serialize-hash (function)
• int-or-char-p (generic function)
• int-or-char-p (method)
• make-referrer (function)
• referrerp (generic function)
• referrerp (method)
• resolving-backend (class)
• resolving-object (macro)
• setting (macro)
• setting-hash (macro)
• store-referrer (generic function)
• store-referrer (method)
• with-serialization-unit (macro)

Internal Definitions

• *grouped-restore-hash* (special variable)
• *grouped-store-hash* (special variable)
• *stored-counter* (special variable)
• *stored-values* (special variable)
• copy-delay (function)
• copy-referrer (function)
• delay (macro)
• delay (structure)
• delay-completed (function)
• (setf delay-completed) (function)
• delay-p (function)
• delay-value (function)
• (setf delay-value) (function)
• force (function)
• get-ref (function)
• get-restore-hash (function)
• get-store-hash (function)
• handle-normal (function)
• handle-restore (function)
• make-delay (function)
• needs-checkp (function)
• new-val (function)
• not-circ (type)
• referred-value (function)
• referrer (structure)
• referrer-p (function)
• referrer-val (function)
• (setf referrer-val) (function)
• seen (function)
• update-restored (function)
• update-seen (function)

2.1.7 cl-store/default-backend.lisp

Dependency

circularities.lisp (file)

Parent

cl-store (system)

Location

default-backend.lisp

Exported Definitions

• *precise-list-storage* (special variable)
• cl-store (class)
• defrestore-cl-store (macro)
• defstore-cl-store (macro)
• get-next-reader (method)
• int-or-char-p (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• output-type-code (function)
• referrerp (method)
• register-code (function)
• restorers (method)
• (setf restorers) (method)
• store-referrer (method)

Internal Definitions

• *cdr-code* (special variable)
• *char-marker* (special variable)
• *eol-code* (special variable)
• *restorers* (special variable)
• *sbcl-readtable* (special variable)
• *special-floats* (special variable)
• +32-bit-integer-code+ (special variable)
• +array-code+ (special variable)
• +built-in-class-code+ (special variable)
• +built-in-function-code+ (special variable)
• +character-code+ (special variable)
• +complex-code+ (special variable)
• +condition-code+ (special variable)
• +cons-code+ (special variable)
• +correct-cons-code+ (special variable)
• +double-float-inf+ (constant)
• +double-float-nan+ (constant)
• +double-float-neg-inf+ (constant)
• +float-code+ (special variable)
• +function-code+ (special variable)
• +gensym-code+ (special variable)
• +gf-code+ (special variable)
• +hash-table-code+ (special variable)
• +integer-code+ (special variable)
• +iterative-cons-code+ (special variable)
• +long-float-inf+ (constant)
• +long-float-nan+ (constant)
• +long-float-neg-inf+ (constant)
• +nil-code+ (special variable)
• +package-code+ (special variable)
• +pathname-code+ (special variable)
• +ratio-code+ (special variable)
• +referrer-code+ (special variable)
• +short-float-inf+ (constant)
• +short-float-nan+ (constant)
• +short-float-neg-inf+ (constant)
• +simple-base-string-code+ (special variable)
• +simple-byte-vector-code+ (special variable)
• +simple-string-code+ (special variable)
• +simple-vector-code+ (special variable)
• +single-float-inf+ (constant)
• +single-float-nan+ (constant)
• +single-float-neg-inf+ (constant)
• +special-float-code+ (special variable)
• +standard-class-code+ (special variable)
• +standard-object-code+ (special variable)
• +struct-def-code+ (special variable)
• +structure-class-code+ (special variable)
• +structure-object-code+ (special variable)
• +symbol-code+ (special variable)
• +t-code+ (special variable)
• +unicode-base-string-code+ (special variable)
• +unicode-string-code+ (special variable)
• bits->num (function)
• correct-list-store (function)
• dump-int (function)
• dump-string (function)
• external-symbols (function)
• get-function-name (function)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-symbols (function)
• iterative-list-store (function)
• lookup-code (function)
• num->bits (function)
• parse-name (function)
• read-list-code (function)
• read-type-code (function)
• remove-remaining (function)
• restore-package (function)
• restore-type-object (function)
• setup-special-floats (function)
• store-32-bit-integer (function)
• store-arbitrary-integer (function)
• store-array (function)
• store-list-code (function)
• store-simple-base-string (function)
• store-simple-byte-vector (function)
• store-simple-string (function)
• store-simple-vector (function)
• store-type-object (function)
• undump-int (function)
• undump-string (function)
• unicode-string-p (function)

2.1.8 cl-store/custom.lisp

Dependency

default-backend.lisp (file)

Parent

cl-store (system)

Location

sbcl/custom.lisp

Exported Definitions

internal-store-object (method)

Internal Definitions

• create-float-values (function)
• internal-restore-object (method)

3 Packages

Packages are listed by definition order.

3.1 cl-store.system

Source

cl-store.asd

Use List

• asdf/interface
• common-lisp

Exported Definitions

non-required-file (class)

Internal Definitions

lisp-system-shortname (function)

3.2 cl-store

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• *check-for-circs* (special variable)
• *current-backend* (special variable)
• *default-backend* (special variable)
• *need-to-fix* (special variable)
• *nuke-existing-classes* (special variable)
• *nuke-existing-packages* (special variable)
• *precise-list-storage* (special variable)
• *restore-counter* (special variable)
• *restore-hash-size* (special variable)
• *restored-values* (special variable)
• *store-class-slots* (special variable)
• *store-class-superclasses* (special variable)
• *store-hash-size* (special variable)
• *store-used-packages* (special variable)
• alias-backend (function)
• backend (class)
• backend-restore (generic function)
• backend-restore (method)
• backend-restore (method)
• backend-restore (method)
• backend-restore (method)
• backend-restore-object (generic function)
• backend-restore-object (method)
• backend-restore-object (method)
• backend-store (generic function)
• backend-store (method)
• backend-store (method)
• backend-store (method)
• backend-store (method)
• backend-store (method)
• backend-store-object (generic function)
• backend-store-object (method)
• backend-store-object (method)
• caused-by (generic function)
• caused-by (method)
• (setf caused-by) (method)
• (setf caused-by) (generic function)
• check-magic-number (generic function)
• check-magic-number (method)
• cl-store (class)
• cl-store-error (condition)
• create-serialize-hash (function)
• defbackend (macro)
• defrestore-cl-store (macro)
• defstore-cl-store (macro)
• find-backend (function)
• float-type (function)
• get-float-type (function)
• get-next-reader (generic function)
• get-next-reader (method)
• get-next-reader (method)
• get-slot-details (generic function)
• get-slot-details (method)
• int-or-char-p (generic function)
• int-or-char-p (method)
• int-or-char-p (method)
• internal-store-object (generic function)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-store-object (method)
• magic-number (generic function)
• magic-number (method)
• (setf magic-number) (method)
• (setf magic-number) (generic function)
• make-referrer (function)
• output-type-code (function)
• read-32-bit (function)
• referrerp (generic function)
• referrerp (method)
• referrerp (method)
• register-code (function)
• resolving-backend (class)
• resolving-object (macro)
• (setf restore) (function)
• restore (generic function)
• restore (method)
• (setf restore) (function)
• restore-error (function)
• restore-error (condition)
• restore-object (function)
• restorers (generic function)
• restorers (method)
• (setf restorers) (method)
• (setf restorers) (generic function)
• serializable-slots (generic function)
• serializable-slots (method)
• serializable-slots (method)
• serializable-slots (method)
• serializable-slots-using-class (generic function)
• serializable-slots-using-class (method)
• serializable-slots-using-class (method)
• serializable-slots-using-class (method)
• setting (macro)
• setting-hash (macro)
• store (generic function)
• store (method)
• store-32-bit (function)
• store-backend-code (generic function)
• store-backend-code (method)
• store-error (function)
• store-error (condition)
• store-object (function)
• store-referrer (generic function)
• store-referrer (method)
• store-referrer (method)
• stream-type (generic function)
• stream-type (method)
• (setf stream-type) (method)
• (setf stream-type) (generic function)
• with-backend (macro)
• with-serialization-unit (macro)

Internal Definitions

• *cdr-code* (special variable)
• *char-marker* (special variable)
• *eol-code* (special variable)
• *grouped-restore-hash* (special variable)
• *grouped-store-hash* (special variable)
• *registered-backends* (special variable)
• *restorers* (special variable)
• *sbcl-readtable* (special variable)
• *special-floats* (special variable)
• *stored-counter* (special variable)
• *stored-values* (special variable)
• +32-bit-integer-code+ (special variable)
• +array-code+ (special variable)
• +built-in-class-code+ (special variable)
• +built-in-function-code+ (special variable)
• +character-code+ (special variable)
• +complex-code+ (special variable)
• +condition-code+ (special variable)
• +cons-code+ (special variable)
• +correct-cons-code+ (special variable)
• +double-float-inf+ (constant)
• +double-float-nan+ (constant)
• +double-float-neg-inf+ (constant)
• +float-code+ (special variable)
• +function-code+ (special variable)
• +gensym-code+ (special variable)
• +gf-code+ (special variable)
• +hash-table-code+ (special variable)
• +integer-code+ (special variable)
• +iterative-cons-code+ (special variable)
• +long-float-inf+ (constant)
• +long-float-nan+ (constant)
• +long-float-neg-inf+ (constant)
• +nil-code+ (special variable)
• +package-code+ (special variable)
• +pathname-code+ (special variable)
• +ratio-code+ (special variable)
• +referrer-code+ (special variable)
• +short-float-inf+ (constant)
• +short-float-nan+ (constant)
• +short-float-neg-inf+ (constant)
• +simple-base-string-code+ (special variable)
• +simple-byte-vector-code+ (special variable)
• +simple-string-code+ (special variable)
• +simple-vector-code+ (special variable)
• +single-float-inf+ (constant)
• +single-float-nan+ (constant)
• +single-float-neg-inf+ (constant)
• +special-float-code+ (special variable)
• +standard-class-code+ (special variable)
• +standard-object-code+ (special variable)
• +struct-def-code+ (special variable)
• +structure-class-code+ (special variable)
• +structure-object-code+ (special variable)
• +symbol-code+ (special variable)
• +t-code+ (special variable)
• +unicode-base-string-code+ (special variable)
• +unicode-string-code+ (special variable)
• aif (macro)
• array-size (type)
• array-tot-size (type)
• backend-designator (type)
• backend-designator->backend (function)
• bits->num (function)
• cl-store-report (function)
• compatible-magic-numbers (generic function)
• compatible-magic-numbers (method)
• (setf compatible-magic-numbers) (method)
• (setf compatible-magic-numbers) (generic function)
• copy-delay (function)
• copy-referrer (function)
• correct-list-store (function)
• create-float-values (function)
• delay (macro)
• delay (structure)
• delay-completed (function)
• (setf delay-completed) (function)
• delay-p (function)
• delay-value (function)
• (setf delay-value) (function)
• dump-int (function)
• dump-string (function)
• external-symbols (function)
• force (function)
• format-args (generic function)
• format-args (method)
• (setf format-args) (method)
• (setf format-args) (generic function)
• format-string (generic function)
• format-string (method)
• (setf format-string) (method)
• (setf format-string) (generic function)
• get-class-form (function)
• get-function-name (function)
• get-ref (function)
• get-restore-hash (function)
• get-restore-macro (function)
• get-store-hash (function)
• get-store-macro (function)
• handle-normal (function)
• handle-restore (function)
• internal-restore-object (generic function)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-symbols (function)
• iterative-list-store (function)
• kwd (function)
• lookup-code (function)
• lookup-reader (function)
• make-delay (function)
• make-ub32 (macro)
• mkstr (function)
• name (generic function)
• name (method)
• (setf name) (method)
• (setf name) (generic function)
• needs-checkp (function)
• new-val (function)
• not-circ (type)
• num->bits (function)
• old-magic-numbers (generic function)
• old-magic-numbers (method)
• (setf old-magic-numbers) (method)
• (setf old-magic-numbers) (generic function)
• parse-name (function)
• read-list-code (function)
• read-type-code (function)
• referred-value (function)
• referrer (structure)
• referrer-p (function)
• referrer-val (function)
• (setf referrer-val) (function)
• register-backend (function)
• remove-remaining (function)
• required-arg (function)
• restore-from-file (function)
• restore-package (function)
• restore-type-object (function)
• safe-length (function)
• sb32 (type)
• seen (function)
• setup-special-floats (function)
• store-32-bit-integer (function)
• store-arbitrary-integer (function)
• store-array (function)
• store-list-code (function)
• store-simple-base-string (function)
• store-simple-byte-vector (function)
• store-simple-string (function)
• store-simple-vector (function)
• store-to-file (function)
• store-type-object (function)
• symbolicate (function)
• ub32 (type)
• undump-int (function)
• undump-string (function)
• unicode-string-p (function)
• update-restored (function)
• update-seen (function)
• when-let (macro)
• with-gensyms (macro)

4 Definitions

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

4.1 Exported definitions

4.1.1 Special variables

Special Variable: *check-for-circs*

Package

cl-store

Source

circularities.lisp (file)

Special Variable: *current-backend*

Package

cl-store

Source

plumbing.lisp (file)

Special Variable: *default-backend*

Package

cl-store

Source

plumbing.lisp (file)

Special Variable: *need-to-fix*

Package

cl-store

Source

circularities.lisp (file)

Special Variable: *nuke-existing-classes*

Do we overwrite existing class definitions on restoration.

Package

cl-store

Source

plumbing.lisp (file)

Special Variable: *nuke-existing-packages*

Whether or not to overwrite existing packages on restoration.

Package

cl-store

Source

plumbing.lisp (file)

Special Variable: *precise-list-storage*

When bound to true the precise list serializer will be used which will ensure that
all shared structure in a list will be serialized and deserialized correctly.
This method of storing lists, while more correct than the default, will NOT work with
large lists as it will blow the stack.
Binding this variable to true only affects storing and makes no difference when restoring lists.

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: *restore-counter*

Package

cl-store

Source

circularities.lisp (file)

Special Variable: *restore-hash-size*

Package

cl-store

Source

circularities.lisp (file)

Special Variable: *restored-values*

Package

cl-store

Source

circularities.lisp (file)

Special Variable: *store-class-slots*

Whether or not to serialize slots which are class allocated.

Package

cl-store

Source

plumbing.lisp (file)

Special Variable: *store-class-superclasses*

Whether or not to store the superclasses of a stored class.

Package

cl-store

Source

plumbing.lisp (file)

Special Variable: *store-hash-size*

Package

cl-store

Source

circularities.lisp (file)

Special Variable: *store-used-packages*

If non-nil will serialize each used package otherwise will only store the package name

Package

cl-store

Source

plumbing.lisp (file)

4.1.2 Macros

Macro: defbackend NAME &key STREAM-TYPE MAGIC-NUMBER FIELDS EXTENDS OLD-MAGIC-NUMBERS COMPATIBLE-MAGIC-NUMBERS

Defines a new backend called NAME. Stream type must be either ’char or ’binary. FIELDS is a list of legal slots for defclass. MAGIC-NUMBER, when supplied, will be written down stream as verification and checked on restoration.
EXTENDS is a class to extend, which must be backend or a class which extends backend

Package

cl-store

Source

backends.lisp (file)

Macro: defrestore-cl-store (TYPE PLACE &optional QUALIFIER) &body BODY

Package

cl-store

Source

default-backend.lisp (file)

Macro: defstore-cl-store (VAR TYPE STREAM &optional QUALIFIER) &body BODY

Package

cl-store

Source

default-backend.lisp (file)

Macro: resolving-object (VAR CREATE) &body BODY

Execute body attempting to resolve circularities found in form CREATE.

Package

cl-store

Source

circularities.lisp (file)

Macro: setting PLACE GET

Resolve the possible referring object retrieved by GET and set it into PLACE. Only usable within a resolving-object form.

Package

cl-store

Source

circularities.lisp (file)

Macro: setting-hash GETTING-KEY GETTING-VALUE

Insert the value retrieved by GETTING-VALUE with the key retrieved by GETTING-KEY, resolving possible circularities. Only usable within a resolving-object form.

Package

cl-store

Source

circularities.lisp (file)

Macro: with-backend BACKEND &body BODY

Run BODY with *default-backend* bound to BACKEND

Package

cl-store

Source

backends.lisp (file)

Macro: with-serialization-unit (&key STORE-HASH RESTORE-HASH) &body BODY

Executes body in a single serialization unit allowing various internal data structures to be reused.
The keys store-hash and restore-hash are expected to be either nil or hash-tables as produced by the function create-serialize-hash.

Package

cl-store

Source

circularities.lisp (file)

4.1.3 Functions

Function: alias-backend OLD ALIAS

Package

cl-store

Source

backends.lisp (file)

Function: create-serialize-hash &key SIZE

Package

cl-store

Source

circularities.lisp (file)

Function: find-backend NAME &optional ERRORP

Return backup called NAME. If there is no such backend NIL is returned if ERRORP is false, otherwise an error is signalled.

Package

cl-store

Source

backends.lisp (file)

Function: float-type FLOAT

Package

cl-store

Source

utils.lisp (file)

Function: get-float-type NUM

Package

cl-store

Source

utils.lisp (file)

Function: make-referrer &key (VAL VAL)

Package

cl-store

Source

circularities.lisp (file)

Function: output-type-code CODE STREAM

Package

cl-store

Source

default-backend.lisp (file)

Function: read-32-bit ()

Read a signed or unsigned byte off STREAM.

Package

cl-store

Source

utils.lisp (file)

Function: register-code CODE NAME &optional ERRORP

Package

cl-store

Source

default-backend.lisp (file)

Function: (setf restore) NEW-VAL PLACE &optional BACKEND

Package

cl-store

Source

plumbing.lisp (file)

Reader

restore (generic function)

Function: restore-error FORMAT-STRING &rest ARGS

Package

cl-store

Source

plumbing.lisp (file)

Function: restore-object PLACE &optional BACKEND

Restore the object in PLACE using BACKEND

Package

cl-store

Source

plumbing.lisp (file)

Function: store-32-bit ()

Write OBJ down STREAM as a 32 bit integer.

Package

cl-store

Source

utils.lisp (file)

Function: store-error FORMAT-STRING &rest ARGS

Package

cl-store

Source

plumbing.lisp (file)

Function: store-object OBJ STREAM &optional BACKEND

Store OBJ into STREAM. Not meant to be overridden, use backend-store-object instead

Package

cl-store

Source

plumbing.lisp (file)

4.1.4 Generic functions

Generic Function: backend-restore BACKEND PLACE

Wrapped by restore. Override this to do custom restoration

Package

cl-store

Source

plumbing.lisp (file)

Methods

Method: backend-restore (BACKEND resolving-backend) (PLACE stream)

Restore an object from PLACE using BACKEND. Does the setup for various variables used by resolving-object.

Source

circularities.lisp (file)

Method: backend-restore (BACKEND backend) (PLACE stream)

Restore the object found in stream PLACE using backend BACKEND. Checks the magic-number and invokes backend-restore-object

Method: backend-restore (BACKEND backend) (PLACE string)

Restore the object found in file designator PLACE using backend BACKEND.

Method: backend-restore (BACKEND backend) (PLACE pathname)

Restore the object found in file designator PLACE using backend BACKEND.

Generic Function: backend-restore-object BACKEND PLACE

Find the next function to call with BACKEND and invoke it with PLACE.

Package

cl-store

Source

plumbing.lisp (file)

Methods

Method: backend-restore-object (BACKEND resolving-backend) PLACE

Retrieve a object from PLACE, does housekeeping for circularity fixing.

Source

circularities.lisp (file)

Method: backend-restore-object (BACKEND backend) PLACE

The default

Generic Function: backend-store BACKEND PLACE OBJ

Method wrapped by store, override this method for custom behaviour (see circularities.lisp).

Package

cl-store

Source

plumbing.lisp (file)

Methods

Method: backend-store (BACKEND resolving-backend) (PLACE stream) OBJ

Store OBJ into PLACE. Does the setup for counters and seen values.

Source

circularities.lisp (file)

Method: backend-store (BACKEND resolving-backend) PLACE OBJ around

Source

circularities.lisp (file)

Method: backend-store (BACKEND backend) (PLACE stream) OBJ

The default. Checks the streams element-type, stores the backend code and calls store-object.

Method: backend-store (BACKEND backend) (PLACE string) OBJ

Store OBJ into file designator PLACE.

Method: backend-store (BACKEND backend) (PLACE pathname) OBJ

Store OBJ into file designator PLACE.

Generic Function: backend-store-object BACKEND OBJ STREAM

Wrapped by store-object, override this to do custom storing (see circularities.lisp for an example).

Package

cl-store

Source

plumbing.lisp (file)

Methods

Method: backend-store-object (BACKEND resolving-backend) OBJ PLACE

Store object if we have not seen this object before, otherwise retrieve the referrer object for it and store that using store-referrer.

Source

circularities.lisp (file)

Method: backend-store-object (BACKEND backend) OBJ STREAM

The default, just calls internal-store-object.

Generic Function: caused-by CONDITION

Generic Function: (setf caused-by) NEW-VALUE CONDITION

Package

cl-store

Methods

Method: caused-by (CONDITION cl-store-error)

Method: (setf caused-by) NEW-VALUE (CONDITION cl-store-error)

Source

plumbing.lisp (file)

Generic Function: check-magic-number BACKEND STREAM

Check to see if STREAM actually contains a stored object for BACKEND.

Package

cl-store

Source

plumbing.lisp (file)

Methods

Method: check-magic-number (BACKEND backend) STREAM

Generic Function: get-next-reader BACKEND PLACE

Method which must be specialized for BACKEND to return
the next function to restore an object from PLACE.
If no reader is found return a second value which will be included in the error.

Package

cl-store

Source

plumbing.lisp (file)

Methods

Method: get-next-reader (BACKEND cl-store) (STREAM stream)

Source

default-backend.lisp (file)

Method: get-next-reader (BACKEND backend) PLACE

The default, throw an error.

Generic Function: get-slot-details SLOT-DEFINITION

Return a list of slot details which can be used as an argument to ensure-class

Package

cl-store

Source

utils.lisp (file)

Methods

Method: get-slot-details (SLOT-DEFINITION slot-definition)

Generic Function: int-or-char-p BACKEND FN

Package

cl-store

Source

circularities.lisp (file)

Methods

Method: int-or-char-p (BACKEND cl-store) (TYPE symbol)

Source

default-backend.lisp (file)

Method: int-or-char-p (BACKEND backend) (FN symbol)

Is function FN registered to restore an integer or character in BACKEND.

Generic Function: internal-store-object BACKEND OBJ PLACE

Method which is specialized by defstore-? macros.

Package

cl-store

Source

plumbing.lisp (file)

Methods

Method: internal-store-object (G0 cl-store) (OBJ structure-object) STREAM

Definition for storing an object of type STRUCTURE-OBJECT with backend CL-STORE

Source

custom.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ generic-function) STREAM

Definition for storing an object of type GENERIC-FUNCTION with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ function) STREAM

Definition for storing an object of type FUNCTION with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ package) STREAM

Definition for storing an object of type PACKAGE with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ array) STREAM

Definition for storing an object of type ARRAY with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (BACKEND cl-store) (OBJ (eql #<structure-class common-lisp:hash-table>)) STREAM

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ built-in-class) STREAM

Definition for storing an object of type BUILT-IN-CLASS with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ standard-class) STREAM

Definition for storing an object of type STANDARD-CLASS with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ condition) STREAM

Definition for storing an object of type CONDITION with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ standard-object) STREAM

Definition for storing an object of type STANDARD-OBJECT with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ hash-table) STREAM

Definition for storing an object of type HASH-TABLE with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ pathname) STREAM

Definition for storing an object of type PATHNAME with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (LIST cons) STREAM

Definition for storing an object of type CONS with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ symbol) STREAM

Definition for storing an object of type SYMBOL with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ complex) STREAM

Definition for storing an object of type COMPLEX with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ character) STREAM

Definition for storing an object of type CHARACTER with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ ratio) STREAM

Definition for storing an object of type RATIO with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ float) STREAM

Definition for storing an object of type FLOAT with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ integer) STREAM

Definition for storing an object of type INTEGER with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ (eql nil)) STREAM

Definition for storing an object of type (EQL NIL) with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (G0 cl-store) (OBJ (eql t)) STREAM

Definition for storing an object of type (EQL T) with backend CL-STORE

Source

default-backend.lisp (file)

Method: internal-store-object (BACKEND backend) OBJ PLACE

If call falls back here then OBJ cannot be serialized with BACKEND.

Generic Function: magic-number OBJECT

Generic Function: (setf magic-number) NEW-VALUE OBJECT

Package

cl-store

Methods

Method: magic-number (BACKEND backend)

automatically generated reader method

Source

backends.lisp (file)

Method: (setf magic-number) NEW-VALUE (BACKEND backend)

automatically generated writer method

Source

backends.lisp (file)

Generic Function: referrerp BACKEND READER

Package

cl-store

Source

circularities.lisp (file)

Methods

Method: referrerp (BACKEND cl-store) READER

Source

default-backend.lisp (file)

Method: referrerp BACKEND READER

Generic Function: restore PLACE &optional BACKEND

Restore and object FROM PLACE using BACKEND. Not meant to be overridden, use backend-restore instead

Package

cl-store

Source

plumbing.lisp (file)

Writer

(setf restore) (function)

Methods

Method: restore PLACE &optional DESIGNATOR

Entry point for restoring objects (setfable).

Generic Function: restorers OBJECT

Generic Function: (setf restorers) NEW-VALUE OBJECT

Package

cl-store

Methods

Method: restorers (CL-STORE cl-store)

automatically generated reader method

Source

default-backend.lisp (file)

Method: (setf restorers) NEW-VALUE (CL-STORE cl-store)

automatically generated writer method

Source

default-backend.lisp (file)

Generic Function: serializable-slots OBJECT

Return a list of slot-definitions to serialize. The default is to call serializable-slots-using-class with the object and the objects class

Package

cl-store

Source

utils.lisp (file)

Methods

Method: serializable-slots (OBJECT standard-object)

Method: serializable-slots (OBJECT structure-object)

Method: serializable-slots (OBJECT condition)

Generic Function: serializable-slots-using-class OBJECT CLASS

Return a list of slot-definitions to serialize. The default calls compute slots with class

Package

cl-store

Source

utils.lisp (file)

Methods

Method: serializable-slots-using-class OBJECT (CLASS standard-class)

Method: serializable-slots-using-class OBJECT (CLASS structure-class)

Method: serializable-slots-using-class OBJECT (CLASS condition-class)

Generic Function: store OBJ PLACE &optional DESIGNATOR

Store OBJ into Stream PLACE using backend BACKEND.

Package

cl-store

Source

plumbing.lisp (file)

Methods

Method: store OBJ PLACE &optional DESIGNATOR

Store OBJ into Stream PLACE using backend BACKEND.

Generic Function: store-backend-code BACKEND STREAM

Store magic-number of BACKEND, when present, into STREAM.

Package

cl-store

Source

plumbing.lisp (file)

Methods

Method: store-backend-code (BACKEND backend) STREAM

Generic Function: store-referrer BACKEND OBJ PLACE

Store the number OBJ into PLACE as a referrer for BACKEND.

Package

cl-store

Source

circularities.lisp (file)

Methods

Method: store-referrer (BACKEND cl-store) REF STREAM

Source

default-backend.lisp (file)

Method: store-referrer (BACKEND resolving-backend) OBJ PLACE

Generic Function: stream-type OBJECT

Generic Function: (setf stream-type) NEW-VALUE OBJECT

Package

cl-store

Methods

Method: stream-type (BACKEND backend)

automatically generated reader method

Source

backends.lisp (file)

Method: (setf stream-type) NEW-VALUE (BACKEND backend)

automatically generated writer method

Source

backends.lisp (file)

4.1.5 Conditions

Condition: cl-store-error ()

Root cl-store condition

Package

cl-store

Source

plumbing.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• store-error (condition)
• restore-error (condition)

Direct methods

• format-args (method)
• format-args (method)
• format-string (method)
• format-string (method)
• caused-by (method)
• caused-by (method)

Direct slots

Slot: caused-by

Initargs

:caused-by

Initform

(quote nil)

Readers

caused-by (generic function)

Writers

(setf caused-by) (generic function)

Slot: format-string

Initargs

:format-string

Initform

(quote "unknown")

Readers

format-string (generic function)

Writers

(setf format-string) (generic function)

Slot: format-args

Initargs

:format-args

Initform

(quote nil)

Readers

format-args (generic function)

Writers

(setf format-args) (generic function)

Condition: restore-error ()

Error thrown when restoring an object fails.

Package

cl-store

Source

plumbing.lisp (file)

Direct superclasses

cl-store-error (condition)

Condition: store-error ()

Error thrown when storing an object fails.

Package

cl-store

Source

plumbing.lisp (file)

Direct superclasses

cl-store-error (condition)

4.1.6 Classes

Class: backend ()

Core class which custom backends must extend

Package

cl-store

Source

backends.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

resolving-backend (class)

Direct methods

• int-or-char-p (method)
• backend-restore-object (method)
• get-next-reader (method)
• check-magic-number (method)
• backend-restore (method)
• backend-restore (method)
• backend-restore (method)
• internal-store-object (method)
• backend-store-object (method)
• store-backend-code (method)
• backend-store (method)
• backend-store (method)
• backend-store (method)
• stream-type (method)
• stream-type (method)
• old-magic-numbers (method)
• old-magic-numbers (method)
• compatible-magic-numbers (method)
• compatible-magic-numbers (method)
• magic-number (method)
• magic-number (method)
• name (method)
• name (method)

Direct slots

Slot: name

Type

symbol

Initargs

:name

Initform

:|unknown|

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: magic-number

Type

integer

Initargs

:magic-number

Readers

magic-number (generic function)

Writers

(setf magic-number) (generic function)

Slot: compatible-magic-numbers

Type

list

Initargs

:compatible-magic-numbers

Readers

compatible-magic-numbers (generic function)

Writers

(setf compatible-magic-numbers) (generic function)

Slot: old-magic-numbers

Type

list

Initargs

:old-magic-numbers

Readers

old-magic-numbers (generic function)

Writers

(setf old-magic-numbers) (generic function)

Slot: stream-type

Type

(or symbol cons)

Initargs

:stream-type

Initform

(cl-store::required-arg :stream-type)

Readers

stream-type (generic function)

Writers

(setf stream-type) (generic function)

Class: cl-store ()

Autogenerated cl-store class for backend cl-store.

Package

cl-store

Source

default-backend.lisp (file)

Direct superclasses

resolving-backend (class)

Direct methods

• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• int-or-char-p (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• internal-store-object (method)
• internal-restore-object (method)
• store-referrer (method)
• get-next-reader (method)
• referrerp (method)
• restorers (method)
• restorers (method)

Direct slots

Slot: restorers

Initform

(make-hash-table :size 100)

Readers

restorers (generic function)

Writers

(setf restorers) (generic function)

Class: non-required-file ()

File containing implementation dependent code which may or may not be there.

Package

cl-store.system

Source

cl-store.asd

Direct superclasses

cl-source-file (class)

Direct methods

• operation-done-p (method)
• perform (method)
• perform (method)
• component-pathname (method)

Class: resolving-backend ()

A backend which does the setup for resolving circularities.

Package

cl-store

Source

circularities.lisp (file)

Direct superclasses

backend (class)

Direct subclasses

cl-store (class)

Direct methods

• backend-restore-object (method)
• backend-restore (method)
• backend-store-object (method)
• store-referrer (method)
• backend-store (method)
• backend-store (method)

4.2 Internal definitions

4.2.1 Constants

Constant: +double-float-inf+

Package

cl-store

Source

default-backend.lisp (file)

Constant: +double-float-nan+

Package

cl-store

Source

default-backend.lisp (file)

Constant: +double-float-neg-inf+

Package

cl-store

Source

default-backend.lisp (file)

Constant: +long-float-inf+

Package

cl-store

Source

default-backend.lisp (file)

Constant: +long-float-nan+

Package

cl-store

Source

default-backend.lisp (file)

Constant: +long-float-neg-inf+

Package

cl-store

Source

default-backend.lisp (file)

Constant: +short-float-inf+

Package

cl-store

Source

default-backend.lisp (file)

Constant: +short-float-nan+

Package

cl-store

Source

default-backend.lisp (file)

Constant: +short-float-neg-inf+

Package

cl-store

Source

default-backend.lisp (file)

Constant: +single-float-inf+

Package

cl-store

Source

default-backend.lisp (file)

Constant: +single-float-nan+

Package

cl-store

Source

default-backend.lisp (file)

Constant: +single-float-neg-inf+

Package

cl-store

Source

default-backend.lisp (file)

4.2.2 Special variables

Special Variable: *cdr-code*

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: *char-marker*

Largest character that can be represented in 8 bits

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: *eol-code*

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: *grouped-restore-hash*

Package

cl-store

Source

circularities.lisp (file)

Special Variable: *grouped-store-hash*

Package

cl-store

Source

circularities.lisp (file)

Special Variable: *registered-backends*

An assoc list mapping backend-names to the backend objects

Package

cl-store

Source

backends.lisp (file)

Special Variable: *restorers*

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: *sbcl-readtable*

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: *special-floats*

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: *stored-counter*

Package

cl-store

Source

circularities.lisp (file)

Special Variable: *stored-values*

Package

cl-store

Source

circularities.lisp (file)

Special Variable: +32-bit-integer-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +array-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +built-in-class-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +built-in-function-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +character-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +complex-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +condition-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +cons-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +correct-cons-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +float-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +function-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +gensym-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +gf-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +hash-table-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +integer-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +iterative-cons-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +nil-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +package-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +pathname-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +ratio-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +referrer-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +simple-base-string-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +simple-byte-vector-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +simple-string-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +simple-vector-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +special-float-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +standard-class-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +standard-object-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +struct-def-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +structure-class-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +structure-object-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +symbol-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +t-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +unicode-base-string-code+

Package

cl-store

Source

default-backend.lisp (file)

Special Variable: +unicode-string-code+

Package

cl-store

Source

default-backend.lisp (file)

4.2.3 Macros

Macro: aif TEST THEN &optional ELSE

Package

cl-store

Source

utils.lisp (file)

Macro: delay &rest BODY

Package

cl-store

Source

circularities.lisp (file)

Macro: make-ub32 A B C D

Package

cl-store

Source

utils.lisp (file)

Macro: when-let (VAR TEST) &body BODY

Package

cl-store

Source

utils.lisp (file)

Macro: with-gensyms NAMES &body BODY

Package

cl-store

Source

utils.lisp (file)

4.2.4 Functions

Function: backend-designator->backend DESIGNATOR

Package

cl-store

Source

backends.lisp (file)

Function: bits->num BITS

Package

cl-store

Source

default-backend.lisp (file)

Function: cl-store-report CONDITION STREAM

Package

cl-store

Source

plumbing.lisp (file)

Function: copy-delay INSTANCE

Package

cl-store

Source

circularities.lisp (file)

Function: copy-referrer INSTANCE

Package

cl-store

Source

circularities.lisp (file)

Function: correct-list-store LIST STREAM

Package

cl-store

Source

default-backend.lisp (file)

Function: create-float-values VALUE &rest CODES

Returns a alist of special float to float code mappings.

Package

cl-store

Source

custom.lisp (file)

Function: delay-completed INSTANCE

Function: (setf delay-completed) VALUE INSTANCE

Package

cl-store

Source

circularities.lisp (file)

Function: delay-p OBJECT

Package

cl-store

Source

circularities.lisp (file)

Function: delay-value INSTANCE

Function: (setf delay-value) VALUE INSTANCE

Package

cl-store

Source

circularities.lisp (file)

Function: dump-int ()

Package

cl-store

Source

default-backend.lisp (file)

Function: dump-string ()

Package

cl-store

Source

default-backend.lisp (file)

Function: external-symbols PACKAGE

Package

cl-store

Source

default-backend.lisp (file)

Function: force DELAY

Package

cl-store

Source

circularities.lisp (file)

Function: get-class-form NAME FIELDS EXTENDS

Package

cl-store

Source

backends.lisp (file)

Function: get-function-name OBJ

Package

cl-store

Source

default-backend.lisp (file)

Function: get-ref ()

Package

cl-store

Source

circularities.lisp (file)

Function: get-restore-hash ()

Package

cl-store

Source

circularities.lisp (file)

Function: get-restore-macro NAME

Return the defrestore-? macro which will be used by a custom backend

Package

cl-store

Source

backends.lisp (file)

Function: get-store-hash ()

Package

cl-store

Source

circularities.lisp (file)

Function: get-store-macro NAME

Return the defstore-? macro which will be used by a custom backend

Package

cl-store

Source

backends.lisp (file)

Function: handle-normal ()

Package

cl-store

Source

circularities.lisp (file)

Function: handle-restore ()

Package

cl-store

Source

circularities.lisp (file)

Function: internal-symbols PACKAGE

Package

cl-store

Source

default-backend.lisp (file)

Function: iterative-list-store LIST STREAM

Package

cl-store

Source

default-backend.lisp (file)

Function: kwd NAME

Package

cl-store

Source

utils.lisp (file)

Function: lisp-system-shortname ()

Package

cl-store.system

Source

cl-store.asd

Function: lookup-code ()

Package

cl-store

Source

default-backend.lisp (file)

Function: lookup-reader VAL READERS

Package

cl-store

Source

plumbing.lisp (file)

Function: make-delay &key (VALUE VALUE) (COMPLETED COMPLETED)

Package

cl-store

Source

circularities.lisp (file)

Function: mkstr &rest ARGS

Package

cl-store

Source

utils.lisp (file)

Function: needs-checkp OBJ

Do we need to check if this object has been stored before?

Package

cl-store

Source

circularities.lisp (file)

Function: new-val ()

Tries to get a referred value to reduce unnecessary cirularity fixing.

Package

cl-store

Source

circularities.lisp (file)

Function: num->bits NUM

Package

cl-store

Source

default-backend.lisp (file)

Function: parse-name NAME

Package

cl-store

Source

default-backend.lisp (file)

Function: read-list-code STREAM

Package

cl-store

Source

default-backend.lisp (file)

Function: read-type-code STREAM

Package

cl-store

Source

default-backend.lisp (file)

Function: referred-value REFERRER HASH

Return the value REFERRER is meant to be by looking in HASH.

Package

cl-store

Source

circularities.lisp (file)

Function: referrer-p OBJECT

Package

cl-store

Source

circularities.lisp (file)

Function: referrer-val INSTANCE

Function: (setf referrer-val) VALUE INSTANCE

Package

cl-store

Source

circularities.lisp (file)

Function: register-backend NAME CLASS MAGIC-NUMBER STREAM-TYPE OLD-MAGIC-NUMBERS COMPATIBLE-MAGIC-NUMBERS

Package

cl-store

Source

backends.lisp (file)

Function: remove-remaining TIMES STREAM

Package

cl-store

Source

default-backend.lisp (file)

Function: required-arg NAME

Package

cl-store

Source

backends.lisp (file)

Function: restore-from-file PLACE BACKEND

Package

cl-store

Source

plumbing.lisp (file)

Function: restore-package PACKAGE-NAME STREAM &key FORCE

Package

cl-store

Source

default-backend.lisp (file)

Function: restore-type-object STREAM

Package

cl-store

Source

default-backend.lisp (file)

Function: safe-length LIST

Similar to ‘list-length’, but avoid errors on improper lists. Return two values: the length of the list and the last cdr. Modified to work on non proper lists.

Package

cl-store

Source

utils.lisp (file)

Function: seen ()

Has this object already been stored?

Package

cl-store

Source

circularities.lisp (file)

Function: setup-special-floats ()

Package

cl-store

Source

default-backend.lisp (file)

Function: store-32-bit-integer ()

Package

cl-store

Source

default-backend.lisp (file)

Function: store-arbitrary-integer OBJ STREAM

Package

cl-store

Source

default-backend.lisp (file)

Function: store-array ()

Package

cl-store

Source

default-backend.lisp (file)

Function: store-list-code X STREAM

Package

cl-store

Source

default-backend.lisp (file)

Function: store-simple-base-string ()

Package

cl-store

Source

default-backend.lisp (file)

Function: store-simple-byte-vector ()

Package

cl-store

Source

default-backend.lisp (file)

Function: store-simple-string ()

Package

cl-store

Source

default-backend.lisp (file)