The cl-store Reference Manual

2.1.1 cl-store/cl-store.asd

Source

cl-store.asd.

Parent Component

cl-store (system).

ASDF Systems

cl-store.

Packages

cl-store.system.

Public Interface

• component-pathname (method).
• non-required-file (class).
• operation-done-p (method).
• perform (method).
• perform (method).

Internals

lisp-system-shortname (function).

---

2.1.2 cl-store/package.lisp

Source

cl-store.asd.

Parent Component

cl-store (system).

Packages

cl-store.

---

2.1.3 cl-store/utils.lisp

Dependency

package.lisp (file).

Source

cl-store.asd.

Parent Component

cl-store (system).

Public Interface

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

Internals

• 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).

Source

cl-store.asd.

Parent Component

cl-store (system).

Public Interface

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

Internals

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

---

2.1.5 cl-store/plumbing.lisp

Dependency

backends.lisp (file).

Source

cl-store.asd.

Parent Component

cl-store (system).

Public Interface

• *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-object (generic function).
• backend-store (generic function).
• backend-store-object (generic function).
• caused-by (reader method).
• (setf caused-by) (writer method).
• check-magic-number (generic function).
• cl-store-error (condition).
• get-next-reader (generic function).
• internal-store-object (generic function).
• restore (generic function).
• (setf restore) (function).
• restore-error (function).
• restore-error (condition).
• restore-object (function).
• store (generic function).
• store-backend-code (generic function).
• store-error (function).
• store-error (condition).
• store-object (function).

Internals

• cl-store-report (function).
• format-args (reader method).
• (setf format-args) (writer method).
• format-string (reader method).
• (setf format-string) (writer 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).

Source

cl-store.asd.

Parent Component

cl-store (system).

Public Interface

• *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).
• make-referrer (function).
• referrerp (generic function).
• resolving-backend (class).
• resolving-object (macro).
• setting (macro).
• setting-hash (macro).
• store-referrer (generic function).
• with-serialization-unit (macro).

Internals

• *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 (reader).
• (setf delay-completed) (writer).
• delay-p (function).
• delay-value (reader).
• (setf delay-value) (writer).
• 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 (reader).
• (setf referrer-val) (writer).
• seen (function).
• update-restored (function).
• update-seen (function).

---

2.1.7 cl-store/default-backend.lisp

Dependency

circularities.lisp (file).

Source

cl-store.asd.

Parent Component

cl-store (system).

Public Interface

• *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 (reader method).
• (setf restorers) (writer method).
• store-referrer (method).

Internals

• *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).

Source

cl-store.asd.

Parent Component

cl-store (system).

Public Interface

internal-store-object (method).

Internals

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

---

4.1.1 Special variables

Special Variable: *check-for-circs* ¶

Package

cl-store.

Source

circularities.lisp.

Special Variable: *current-backend* ¶

Package

cl-store.

Source

plumbing.lisp.

Special Variable: *default-backend* ¶

Package

cl-store.

Source

plumbing.lisp.

Special Variable: *need-to-fix* ¶

Package

cl-store.

Source

circularities.lisp.

Special Variable: *nuke-existing-classes* ¶

Do we overwrite existing class definitions on restoration.

Package

cl-store.

Source

plumbing.lisp.

Special Variable: *nuke-existing-packages* ¶

Whether or not to overwrite existing packages on restoration.

Package

cl-store.

Source

plumbing.lisp.

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.

Special Variable: *restore-counter* ¶

Package

cl-store.

Source

circularities.lisp.

Special Variable: *restore-hash-size* ¶

Package

cl-store.

Source

circularities.lisp.

Special Variable: *restored-values* ¶

Package

cl-store.

Source

circularities.lisp.

Special Variable: *store-class-slots* ¶

Whether or not to serialize slots which are class allocated.

Package

cl-store.

Source

plumbing.lisp.

Special Variable: *store-class-superclasses* ¶

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

Package

cl-store.

Source

plumbing.lisp.

Special Variable: *store-hash-size* ¶

Package

cl-store.

Source

circularities.lisp.

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.

---

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.

Macro: defrestore-cl-store ((type place &optional qualifier) &body body) ¶

Package

cl-store.

Source

default-backend.lisp.

Macro: defstore-cl-store ((var type stream &optional qualifier) &body body) ¶

Package

cl-store.

Source

default-backend.lisp.

Macro: resolving-object ((var create) &body body) ¶

Execute body attempting to resolve circularities found in form CREATE.

Package

cl-store.

Source

circularities.lisp.

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.

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.

Macro: with-backend (backend &body body) ¶

Run BODY with *default-backend* bound to BACKEND

Package

cl-store.

Source

backends.lisp.

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.

---

4.1.3 Ordinary functions

Function: alias-backend (old alias) ¶

Package

cl-store.

Source

backends.lisp.

Function: create-serialize-hash (&key size) ¶

Package

cl-store.

Source

circularities.lisp.

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.

Function: float-type (float) ¶

Package

cl-store.

Source

utils.lisp.

Function: get-float-type (num) ¶

Package

cl-store.

Source

utils.lisp.

Function: make-referrer (&key val) ¶

Package

cl-store.

Source

circularities.lisp.

Function: output-type-code (code stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: read-32-bit (buf &optional signed) ¶

Read a signed or unsigned byte off STREAM.

Package

cl-store.

Source

utils.lisp.

Function: register-code (code name &optional errorp) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: (setf restore) (place &optional backend) ¶

Package

cl-store.

Source

plumbing.lisp.

Function: restore-error (format-string &rest args) ¶

Package

cl-store.

Source

plumbing.lisp.

Function: restore-object (place &optional backend) ¶

Restore the object in PLACE using BACKEND

Package

cl-store.

Source

plumbing.lisp.

Function: store-32-bit (obj stream) ¶

Write OBJ down STREAM as a 32 bit integer.

Package

cl-store.

Source

utils.lisp.

Function: store-error (format-string &rest args) ¶

Package

cl-store.

Source

plumbing.lisp.

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.

---

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.

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.

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.

Methods

Method: backend-restore-object ((backend resolving-backend) place) ¶

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

Source

circularities.lisp.

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.

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.

Method: backend-store :around ((backend resolving-backend) place obj) ¶

Source

circularities.lisp.

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.

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.

Method: backend-store-object ((backend backend) obj stream) ¶

The default, just calls internal-store-object.

Generic Reader: caused-by (condition) ¶

Generic Writer: (setf caused-by) (condition) ¶

Package

cl-store.

Methods

Reader Method: caused-by ((condition cl-store-error)) ¶

Writer Method: (setf caused-by) ((condition cl-store-error)) ¶

Source

plumbing.lisp.

Target Slot

caused-by.

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.

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.

Methods

Method: get-next-reader ((backend cl-store) (stream stream)) ¶

Source

default-backend.lisp.

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.

Methods

Method: get-slot-details ((slot-definition slot-definition)) ¶

Generic Function: int-or-char-p (backend fn) ¶

Package

cl-store.

Source

circularities.lisp.

Methods

Method: int-or-char-p ((backend cl-store) (type symbol)) ¶

Source

default-backend.lisp.

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.

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.

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.

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.

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.

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.

Method: internal-store-object ((backend cl-store) (obj (eql #<structure-class common-lisp:hash-table>)) stream) ¶

Source

default-backend.lisp.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Method: internal-store-object ((backend backend) obj place) ¶

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

Generic Reader: magic-number (object) ¶

Package

cl-store.

Methods

Reader Method: magic-number ((backend backend)) ¶

automatically generated reader method

Source

backends.lisp.

Target Slot

magic-number.

Generic Writer: (setf magic-number) (object) ¶

Package

cl-store.

Methods

Writer Method: (setf magic-number) ((backend backend)) ¶

automatically generated writer method

Source

backends.lisp.

Target Slot

magic-number.

Generic Function: referrerp (backend reader) ¶

Package

cl-store.

Source

circularities.lisp.

Methods

Method: referrerp ((backend cl-store) reader) ¶

Source

default-backend.lisp.

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.

Methods

Method: restore (place &optional designator) ¶

Entry point for restoring objects (setfable).

Generic Reader: restorers (object) ¶

Package

cl-store.

Methods

Reader Method: restorers ((cl-store cl-store)) ¶

automatically generated reader method

Source

default-backend.lisp.

Target Slot

restorers.

Generic Writer: (setf restorers) (object) ¶

Package

cl-store.

Methods

Writer Method: (setf restorers) ((cl-store cl-store)) ¶

automatically generated writer method

Source

default-backend.lisp.

Target Slot

restorers.

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.

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.

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.

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.

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.

Methods

Method: store-referrer ((backend cl-store) ref stream) ¶

Source

default-backend.lisp.

Method: store-referrer ((backend resolving-backend) obj place) ¶

Generic Reader: stream-type (object) ¶

Package

cl-store.

Methods

Reader Method: stream-type ((backend backend)) ¶

automatically generated reader method

Source

backends.lisp.

Target Slot

stream-type.

Generic Writer: (setf stream-type) (object) ¶

Package

cl-store.

Methods

Writer Method: (setf stream-type) ((backend backend)) ¶

automatically generated writer method

Source

backends.lisp.

Target Slot

stream-type.

---

4.1.5 Standalone methods

Method: component-pathname ((component non-required-file)) ¶

Package

asdf/component.

Source

cl-store.asd.

Method: operation-done-p ((o operation) (c non-required-file)) ¶

Package

asdf/action.

Source

cl-store.asd.

Method: perform ((op load-op) (component non-required-file)) ¶

Package

asdf/action.

Source

cl-store.asd.

Method: perform ((op compile-op) (component non-required-file)) ¶

Package

asdf/action.

Source

cl-store.asd.

---

4.1.6 Conditions

Condition: cl-store-error ¶

Root cl-store condition

Package

cl-store.

Source

plumbing.lisp.

Direct superclasses

error.

Direct subclasses

• restore-error.
• store-error.

Direct methods

• (setf caused-by).
• caused-by.
• (setf format-args).
• format-args.
• (setf format-string).
• format-string.

Direct slots

Slot: caused-by ¶

Initform

(quote nil)

Initargs

:caused-by

Readers

caused-by.

Writers

(setf caused-by).

Slot: format-string ¶

Initform

(quote "unknown")

Initargs

:format-string

Readers

format-string.

Writers

(setf format-string).

Slot: format-args ¶

Initform

(quote nil)

Initargs

:format-args

Readers

format-args.

Writers

(setf format-args).

Condition: restore-error ¶

Error thrown when restoring an object fails.

Package

cl-store.

Source

plumbing.lisp.

Direct superclasses

cl-store-error.

Condition: store-error ¶

Error thrown when storing an object fails.

Package

cl-store.

Source

plumbing.lisp.

Direct superclasses

cl-store-error.

---

4.1.7 Classes

Class: backend ¶

Core class which custom backends must extend

Package

cl-store.

Source

backends.lisp.

Direct subclasses

resolving-backend.

Direct methods

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

Direct slots

Slot: name ¶

Type

symbol

Initform

:|unknown|

Initargs

:name

Readers

name.

Writers

(setf name).

Slot: magic-number ¶

Type

integer

Initargs

:magic-number

Readers

magic-number.

Writers

(setf magic-number).

Slot: compatible-magic-numbers ¶

Type

list

Initargs

:compatible-magic-numbers

Readers

compatible-magic-numbers.

Writers

(setf compatible-magic-numbers).

Slot: old-magic-numbers ¶

Type

list

Initargs

:old-magic-numbers

Readers

old-magic-numbers.

Writers

(setf old-magic-numbers).

Slot: stream-type ¶

Type

(or symbol cons)

Initform

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

Initargs

:stream-type

Readers

stream-type.

Writers

(setf stream-type).

Class: cl-store ¶

Autogenerated cl-store class for backend cl-store.

Package

cl-store.

Source

default-backend.lisp.

Direct superclasses

resolving-backend.

Direct methods

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

Direct slots

Slot: restorers ¶

Initform

(make-hash-table :size 100)

Readers

restorers.

Writers

(setf restorers).

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.

Direct methods

• component-pathname.
• operation-done-p.
• perform.
• perform.

Class: resolving-backend ¶

A backend which does the setup for resolving circularities.

Package

cl-store.

Source

circularities.lisp.

Direct superclasses

backend.

Direct subclasses

cl-store.

Direct methods

• backend-restore.
• backend-restore-object.
• backend-store.
• backend-store.
• backend-store-object.
• store-referrer.

---

4.2.1 Constants

Constant: +double-float-inf+ ¶

Package

cl-store.

Source

default-backend.lisp.

Constant: +double-float-nan+ ¶

Package

cl-store.

Source

default-backend.lisp.

Constant: +double-float-neg-inf+ ¶

Package

cl-store.

Source

default-backend.lisp.

Constant: +long-float-inf+ ¶

Package

cl-store.

Source

default-backend.lisp.

Constant: +long-float-nan+ ¶

Package

cl-store.

Source

default-backend.lisp.

Constant: +long-float-neg-inf+ ¶

Package

cl-store.

Source

default-backend.lisp.

Constant: +short-float-inf+ ¶

Package

cl-store.

Source

default-backend.lisp.

Constant: +short-float-nan+ ¶

Package

cl-store.

Source

default-backend.lisp.

Constant: +short-float-neg-inf+ ¶

Package

cl-store.

Source

default-backend.lisp.

Constant: +single-float-inf+ ¶

Package

cl-store.

Source

default-backend.lisp.

Constant: +single-float-nan+ ¶

Package

cl-store.

Source

default-backend.lisp.

Constant: +single-float-neg-inf+ ¶

Package

cl-store.

Source

default-backend.lisp.

---

4.2.2 Special variables

Special Variable: *cdr-code* ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: *char-marker* ¶

Largest character that can be represented in 8 bits

Package

cl-store.

Source

default-backend.lisp.

Special Variable: *eol-code* ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: *grouped-restore-hash* ¶

Package

cl-store.

Source

circularities.lisp.

Special Variable: *grouped-store-hash* ¶

Package

cl-store.

Source

circularities.lisp.

Special Variable: *registered-backends* ¶

An assoc list mapping backend-names to the backend objects

Package

cl-store.

Source

backends.lisp.

Special Variable: *restorers* ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: *sbcl-readtable* ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: *special-floats* ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: *stored-counter* ¶

Package

cl-store.

Source

circularities.lisp.

Special Variable: *stored-values* ¶

Package

cl-store.

Source

circularities.lisp.

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

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +array-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

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

Package

cl-store.

Source

default-backend.lisp.

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

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +character-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +complex-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +condition-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +cons-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +correct-cons-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +float-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +function-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +gensym-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +gf-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +hash-table-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +integer-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +iterative-cons-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +nil-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +package-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +pathname-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +ratio-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +referrer-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

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

Package

cl-store.

Source

default-backend.lisp.

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

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +simple-string-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +simple-vector-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +special-float-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +standard-class-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +standard-object-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +struct-def-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +structure-class-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +structure-object-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +symbol-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +t-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

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

Package

cl-store.

Source

default-backend.lisp.

Special Variable: +unicode-string-code+ ¶

Package

cl-store.

Source

default-backend.lisp.

---

4.2.3 Macros

Macro: aif (test then &optional else) ¶

Package

cl-store.

Source

utils.lisp.

Macro: delay (&rest body) ¶

Package

cl-store.

Source

circularities.lisp.

Macro: make-ub32 (a b c d) ¶

Package

cl-store.

Source

utils.lisp.

Macro: when-let ((var test) &body body) ¶

Package

cl-store.

Source

utils.lisp.

Macro: with-gensyms (names &body body) ¶

Package

cl-store.

Source

utils.lisp.

---

4.2.4 Ordinary functions

Function: backend-designator->backend (designator) ¶

Package

cl-store.

Source

backends.lisp.

Function: bits->num (bits) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: cl-store-report (condition stream) ¶

Package

cl-store.

Source

plumbing.lisp.

Function: copy-delay (instance) ¶

Package

cl-store.

Source

circularities.lisp.

Function: copy-referrer (instance) ¶

Package

cl-store.

Source

circularities.lisp.

Function: correct-list-store (list stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: create-float-values (value &rest codes) ¶

Returns a alist of special float to float code mappings.

Package

cl-store.

Source

custom.lisp.

Reader: delay-completed (instance) ¶

Writer: (setf delay-completed) (instance) ¶

Package

cl-store.

Source

circularities.lisp.

Target Slot

completed.

Function: delay-p (object) ¶

Package

cl-store.

Source

circularities.lisp.

Reader: delay-value (instance) ¶

Writer: (setf delay-value) (instance) ¶

Package

cl-store.

Source

circularities.lisp.

Target Slot

value.

Function: dump-int (obj stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: dump-string (dumper obj stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: external-symbols (package) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: force (delay) ¶

Package

cl-store.

Source

circularities.lisp.

Function: get-class-form (name fields extends) ¶

Package

cl-store.

Source

backends.lisp.

Function: get-function-name (obj) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: get-ref (obj) ¶

Package

cl-store.

Source

circularities.lisp.

Function: get-restore-hash () ¶

Package

cl-store.

Source

circularities.lisp.

Function: get-restore-macro (name) ¶

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

Package

cl-store.

Source

backends.lisp.

Function: get-store-hash () ¶

Package

cl-store.

Source

circularities.lisp.

Function: get-store-macro (name) ¶

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

Package

cl-store.

Source

backends.lisp.

Function: handle-normal (backend reader place) ¶

Package

cl-store.

Source

circularities.lisp.

Function: handle-restore (place backend) ¶

Package

cl-store.

Source

circularities.lisp.

Function: internal-symbols (package) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: iterative-list-store (list stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: kwd (name) ¶

Package

cl-store.

Source

utils.lisp.

Function: lisp-system-shortname () ¶

Package

cl-store.system.

Source

cl-store.asd.

Function: lookup-code (code) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: lookup-reader (val readers) ¶

Package

cl-store.

Source

plumbing.lisp.

Function: make-delay (&key value completed) ¶

Package

cl-store.

Source

circularities.lisp.

Function: mkstr (&rest args) ¶

Package

cl-store.

Source

utils.lisp.

Function: needs-checkp (obj) ¶

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

Package

cl-store.

Source

circularities.lisp.

Function: new-val (val) ¶

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

Package

cl-store.

Source

circularities.lisp.

Function: num->bits (num) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: parse-name (name) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: read-list-code (stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: read-type-code (stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: referred-value (referrer hash) ¶

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

Package

cl-store.

Source

circularities.lisp.

Function: referrer-p (object) ¶

Package

cl-store.

Source

circularities.lisp.

Reader: referrer-val (instance) ¶

Writer: (setf referrer-val) (instance) ¶

Package

cl-store.

Source

circularities.lisp.

Target Slot

val.

Function: register-backend (name class magic-number stream-type old-magic-numbers compatible-magic-numbers) ¶

Package

cl-store.

Source

backends.lisp.

Function: remove-remaining (times stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: required-arg (name) ¶

Package

cl-store.

Source

backends.lisp.

Function: restore-from-file (place backend) ¶

Package

cl-store.

Source

plumbing.lisp.

Function: restore-package (package-name stream &key force) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: restore-type-object (stream) ¶

Package

cl-store.

Source

default-backend.lisp.

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.

Function: seen (obj) ¶

Has this object already been stored?

Package

cl-store.

Source

circularities.lisp.

Function: setup-special-floats () ¶

Package

cl-store.

Source

default-backend.lisp.

Function: store-32-bit-integer (obj stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: store-arbitrary-integer (obj stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: store-array (obj stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: store-list-code (x stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: store-simple-base-string (obj stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: store-simple-byte-vector (obj stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: store-simple-string (obj stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: store-simple-vector (obj stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: store-to-file (obj place backend) ¶

Package

cl-store.

Source

plumbing.lisp.

Function: store-type-object (obj stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: symbolicate (&rest syms) ¶

Concatenate all symbol names into one big symbol

Package

cl-store.

Source

utils.lisp.

Function: undump-int (stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: undump-string (reader type stream) ¶

Package

cl-store.

Source

default-backend.lisp.

Function: unicode-string-p (string) ¶

An implementation specific test for a unicode string.

Package

cl-store.

Source

default-backend.lisp.

Function: update-restored (spot val) ¶

Package

cl-store.

Source

circularities.lisp.

Function: update-seen (obj) ¶

Register OBJ as having been stored.

Package

cl-store.

Source

circularities.lisp.

---