The definitions-systems Reference Manual

This is the definitions-systems Reference Manual, version 3.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:16:05 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 definitions-systems

Provides a simple unified extensible way of processing named definitions.

Author

Jean-Philippe Paradis <>

License

Unlicense

Version

3.0

Dependencies
  • canonicalized-initargs (system).
  • enhanced-defclass (system).
  • shared-preferences (system).
  • enhanced-find-class (system).
  • closer-mop (system).
Source

definitions-systems.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 definitions-systems/definitions-systems.asd

Source

definitions-systems.asd.

Parent Component

definitions-systems (system).

ASDF Systems

definitions-systems.


3.1.2 definitions-systems/package.lisp

Source

definitions-systems.asd.

Parent Component

definitions-systems (system).

Packages

definitions-systems.


3.1.3 definitions-systems/definitions.lisp

Dependency

package.lisp (file).

Source

definitions-systems.asd.

Parent Component

definitions-systems (system).

Public Interface
Internals

3.1.4 definitions-systems/systems.lisp

Dependency

definitions.lisp (file).

Source

definitions-systems.asd.

Parent Component

definitions-systems (system).

Public Interface
Internals

%hash (reader method).


3.1.5 definitions-systems/checking.lisp

Dependency

systems.lisp (file).

Source

definitions-systems.asd.

Parent Component

definitions-systems (system).

Public Interface

3.1.6 definitions-systems/root.lisp

Dependency

checking.lisp (file).

Source

definitions-systems.asd.

Parent Component

definitions-systems (system).

Public Interface
Internals

*root-system* (special variable).


3.1.7 definitions-systems/protocols.lisp

Dependency

root.lisp (file).

Source

definitions-systems.asd.

Parent Component

definitions-systems (system).

Public Interface

4 Packages

Packages are listed by definition order.


4.1 definitions-systems

Source

package.lisp.

Nickname

defsys

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: define ((definition-class-name definition-name &body options) &body args)
Package

definitions-systems.

Source

protocols.lisp.


5.1.2 Ordinary functions

Function: root-system ()
Package

definitions-systems.

Source

root.lisp.


5.1.3 Generic functions

Generic Reader: base-definition-class (system)
Package

definitions-systems.

Source

checking.lisp.

Methods
Reader Method: base-definition-class ((base-definition-class-mixin base-definition-class-mixin))

automatically generated reader method

Target Slot

%base-definition-class.

Generic Function: boundp (system definition-name)
Package

definitions-systems.

Source

protocols.lisp.

Methods
Method: boundp (system definition-name)
Generic Function: check-definition (system definition)
Package

definitions-systems.

Source

checking.lisp.

Methods
Method: check-definition ((system system) definition)
Method: check-definition ((system base-definition-class-mixin) definition)
Generic Function: count (system)
Package

definitions-systems.

Source

protocols.lisp.

Methods
Method: count ((system-name symbol))
Method: count ((system system))
Method: count ((system hash-table-mixin))
Generic Function: default-system (object)
Package

definitions-systems.

Source

protocols.lisp.

Methods
Method: default-system ((definition-class-name symbol))
Method: default-system ((definition-class class))
Method: default-system ((system standard-system))
Method: default-system ((system standard-root-system))
Generic Reader: definition (condition)
Package

definitions-systems.

Methods
Reader Method: definition ((condition unsuitable-definition-error))
Source

checking.lisp.

Target Slot

%definition.

Generic Reader: details (condition)
Package

definitions-systems.

Methods
Reader Method: details ((condition unsuitable-definition-error))
Source

checking.lisp.

Target Slot

%details.

Generic Function: ensure (system definition-name definition-class &rest initargs)
Package

definitions-systems.

Source

protocols.lisp.

Methods
Method: ensure ((system-name symbol) definition-name definition-class &rest initargs)
Method: ensure ((system system) definition-name definition-class &rest initargs)
Generic Function: expand (definition-prototype definition-name environment args &rest options)
Package

definitions-systems.

Source

protocols.lisp.

Methods
Method: expand ((prototype standard-definition) name env args &rest options)
Method: expand ((prototype standard-system) name env args &rest options)
Generic Function: locate (system definition-name &key errorp)
Package

definitions-systems.

Source

protocols.lisp.

Methods
Method: locate :around (system definition-name &key errorp)
Method: locate ((system-name symbol) definition-name &rest options)
Method: locate ((system hash-table-mixin) definition-name &key)
Method: locate ((system standard-root-system) definition-name &key errorp)
Source

root.lisp.

Generic Function: (setf locate) (system definition-name &key binding-type &allow-other-keys)
Package

definitions-systems.

Source

protocols.lisp.

Methods
Method: (setf locate) ((system-name symbol) definition-name &rest options &key &allow-other-keys)
Method: (setf locate) :before ((system check-definition-mixin) definition-name &key)
Method: (setf locate) :after ((system system) definition-name &key binding-type)
Method: (setf locate) :after ((system system) definition-name &key binding-type)
Method: (setf locate) ((system hash-table-mixin) definition-name &key)
Generic Function: location (system &key errorp)
Package

definitions-systems.

Source

root.lisp.

Methods
Method: location :around (system &key errorp)
Method: location ((system location-mixin) &key)
Generic Function: map (function system)
Package

definitions-systems.

Source

protocols.lisp.

Methods
Method: map (function (system-name symbol))
Method: map (function (system hash-table-mixin))
Generic Function: map-aliasing-systems (function definition)
Package

definitions-systems.

Source

definitions.lisp.

Methods
Method: map-aliasing-systems (function (definition alias-bindings-mixin))
Generic Reader: name (definition)
Package

definitions-systems.

Source

definitions.lisp.

Methods
Reader Method: name ((condition not-found))
Source

protocols.lisp.

Target Slot

%name.

Reader Method: name ((name-mixin name-mixin))

automatically generated reader method

Target Slot

%name.

Generic Function: (setf name) (definition)
Package

definitions-systems.

Methods
Method: (setf name) ((definition primary-binding-mixin))
Source

definitions.lisp.

Generic Reader: owner (definition)
Package

definitions-systems.

Source

definitions.lisp.

Methods
Reader Method: owner ((owner-mixin owner-mixin))

automatically generated reader method

Target Slot

%owner.

Generic Function: (setf owner) (definition)
Package

definitions-systems.

Methods
Method: (setf owner) ((definition primary-binding-mixin))
Source

definitions.lisp.

Generic Reader: system (condition)
Package

definitions-systems.

Methods
Reader Method: system ((condition not-found))
Source

protocols.lisp.

Target Slot

%system.

Reader Method: system ((condition unsuitable-definition-error))
Source

checking.lisp.

Target Slot

%system.

Generic Function: unbind (system definition-name)
Package

definitions-systems.

Source

protocols.lisp.

Methods
Method: unbind ((system-name symbol) definition-name)
Method: unbind ((system system) definition-name)
Generic Function: unbind-definition (system definition definition-name)
Package

definitions-systems.

Source

protocols.lisp.

Methods
Method: unbind-definition ((system hash-table-mixin) definition definition-name)
Method: unbind-definition :after ((system system) (definition primary-binding-mixin) definition-name)
Method: unbind-definition :after ((system system) (definition alias-bindings-mixin) definition-name)

5.1.4 Standalone methods

Method: make-load-form ((definition owner-mixin) &optional environment)
Source

definitions.lisp.

Method: make-load-form ((mixin location-mixin) &optional environment)
Source

root.lisp.

Method: print-object ((mixin name-mixin) stream)
Source

definitions.lisp.

Method: shared-initialize :after ((definition primary-binding-mixin) slot-names &key owner name)
Source

definitions.lisp.


5.1.5 Conditions

Condition: not-found
Package

definitions-systems.

Source

protocols.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: %system
Initargs

:system

Readers

system.

Writers

This slot is read-only.

Slot: %name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Condition: unsuitable-definition-error
Package

definitions-systems.

Source

checking.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: %system
Initform

(quote (error "~s is required." :system))

Initargs

:system

Readers

system.

Writers

This slot is read-only.

Slot: %definition
Initform

(quote (error "~s is required." :definition))

Initargs

:definition

Readers

definition.

Writers

This slot is read-only.

Slot: %details
Initform

(quote nil)

Initargs

:details

Readers

details.

Writers

This slot is read-only.


5.1.6 Classes

Class: alias-bindings-mixin
Package

definitions-systems.

Source

definitions.lisp.

Direct superclasses

definition.

Direct subclasses

standard-definition.

Direct methods
Direct slots
Slot: %aliasing-systems
Type

hash-table

Initform

(make-hash-table :test (quote eq))

Readers

%aliasing-systems.

Writers

This slot is read-only.

Class: base-definition-class-mixin
Package

definitions-systems.

Direct superclasses
Direct subclasses

standard-system.

Direct methods
Direct slots
Slot: %base-definition-class
Type

class

Initform

(enhanced-find-class:find-class (quote definitions-systems:definition))

Initargs

:base-definition-class

Readers

base-definition-class.

Writers

This slot is read-only.

Class: check-definition-mixin
Package

definitions-systems.

Source

checking.lisp.

Direct superclasses

system.

Direct subclasses

base-definition-class-mixin.

Direct methods

(setf locate).

Class: definition
Package

definitions-systems.

Source

definitions.lisp.

Direct subclasses
Class: hash-table-mixin
Package

definitions-systems.

Source

systems.lisp.

Direct superclasses

system.

Direct subclasses

standard-system.

Direct methods
Direct slots
Slot: %hash
Type

hash-table

Initform

(make-hash-table :test (quote eq))

Readers

%hash.

Writers

This slot is read-only.

Class: location-mixin
Package

definitions-systems.

Source

root.lisp.

Direct subclasses

standard-root-system.

Direct methods
Direct slots
Slot: %location
Initargs

:location

Class: name-mixin
Package

definitions-systems.

Source

definitions.lisp.

Direct subclasses

primary-binding-mixin.

Direct methods
Direct slots
Slot: %name
Type

symbol

Readers

name.

Writers

(setf %name).

Class: owner-mixin
Package

definitions-systems.

Source

definitions.lisp.

Direct subclasses

primary-binding-mixin.

Direct methods
Direct slots
Slot: %owner
Type

(or null definitions-systems:system)

Readers

owner.

Writers

(setf %owner).

Class: primary-binding-mixin
Package

definitions-systems.

Source

definitions.lisp.

Direct superclasses
Direct subclasses

standard-definition.

Direct methods
Class: root-system
Package

definitions-systems.

Source

root.lisp.

Direct superclasses

system.

Direct subclasses

standard-root-system.

Class: standard-definition
Package

definitions-systems.

Source

definitions.lisp.

Direct superclasses
Direct subclasses

standard-system.

Direct methods

expand.

Class: standard-root-system
Package

definitions-systems.

Source

root.lisp.

Direct superclasses
Direct methods
Class: standard-system
Package

definitions-systems.

Source

systems.lisp.

Direct superclasses
Direct subclasses

standard-root-system.

Direct methods
Class: system
Package

definitions-systems.

Source

systems.lisp.

Direct subclasses
Direct methods

5.2 Internals


5.2.1 Special variables

Special Variable: *root-system*
Package

definitions-systems.

Source

root.lisp.


5.2.2 Generic functions

Generic Reader: %aliasing-systems (object)
Package

definitions-systems.

Methods
Reader Method: %aliasing-systems ((alias-bindings-mixin alias-bindings-mixin))

automatically generated reader method

Source

definitions.lisp.

Target Slot

%aliasing-systems.

Generic Reader: %hash (object)
Package

definitions-systems.

Methods
Reader Method: %hash ((hash-table-mixin hash-table-mixin))

automatically generated reader method

Source

systems.lisp.

Target Slot

%hash.

Generic Writer: (setf %name) (object)
Package

definitions-systems.

Methods
Writer Method: (setf %name) ((name-mixin name-mixin))

automatically generated writer method

Source

definitions.lisp.

Target Slot

%name.

Generic Writer: (setf %owner) (object)
Package

definitions-systems.

Methods
Writer Method: (setf %owner) ((owner-mixin owner-mixin))

automatically generated writer method

Source

definitions.lisp.

Target Slot

%owner.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
B   C   D   E   F   G   L   M   N   O   P   R   S   U  
Index Entry  Section

%
%aliasing-systems: Private generic functions
%aliasing-systems: Private generic functions
%hash: Private generic functions
%hash: Private generic functions

(
(setf %name): Private generic functions
(setf %name): Private generic functions
(setf %owner): Private generic functions
(setf %owner): Private generic functions
(setf locate): Public generic functions
(setf locate): Public generic functions
(setf locate): Public generic functions
(setf locate): Public generic functions
(setf locate): Public generic functions
(setf locate): Public generic functions
(setf name): Public generic functions
(setf name): Public generic functions
(setf owner): Public generic functions
(setf owner): Public generic functions

B
base-definition-class: Public generic functions
base-definition-class: Public generic functions
boundp: Public generic functions
boundp: Public generic functions

C
check-definition: Public generic functions
check-definition: Public generic functions
check-definition: Public generic functions
count: Public generic functions
count: Public generic functions
count: Public generic functions
count: Public generic functions

D
default-system: Public generic functions
default-system: Public generic functions
default-system: Public generic functions
default-system: Public generic functions
default-system: Public generic functions
define: Public macros
definition: Public generic functions
definition: Public generic functions
details: Public generic functions
details: Public generic functions

E
ensure: Public generic functions
ensure: Public generic functions
ensure: Public generic functions
expand: Public generic functions
expand: Public generic functions
expand: Public generic functions

F
Function, root-system: Public ordinary functions

G
Generic Function, %aliasing-systems: Private generic functions
Generic Function, %hash: Private generic functions
Generic Function, (setf %name): Private generic functions
Generic Function, (setf %owner): Private generic functions
Generic Function, (setf locate): Public generic functions
Generic Function, (setf name): Public generic functions
Generic Function, (setf owner): Public generic functions
Generic Function, base-definition-class: Public generic functions
Generic Function, boundp: Public generic functions
Generic Function, check-definition: Public generic functions
Generic Function, count: Public generic functions
Generic Function, default-system: Public generic functions
Generic Function, definition: Public generic functions
Generic Function, details: Public generic functions
Generic Function, ensure: Public generic functions
Generic Function, expand: Public generic functions
Generic Function, locate: Public generic functions
Generic Function, location: Public generic functions
Generic Function, map: Public generic functions
Generic Function, map-aliasing-systems: Public generic functions
Generic Function, name: Public generic functions
Generic Function, owner: Public generic functions
Generic Function, system: Public generic functions
Generic Function, unbind: Public generic functions
Generic Function, unbind-definition: Public generic functions

L
locate: Public generic functions
locate: Public generic functions
locate: Public generic functions
locate: Public generic functions
locate: Public generic functions
location: Public generic functions
location: Public generic functions
location: Public generic functions

M
Macro, define: Public macros
make-load-form: Public standalone methods
make-load-form: Public standalone methods
map: Public generic functions
map: Public generic functions
map: Public generic functions
map-aliasing-systems: Public generic functions
map-aliasing-systems: Public generic functions
Method, %aliasing-systems: Private generic functions
Method, %hash: Private generic functions
Method, (setf %name): Private generic functions
Method, (setf %owner): Private generic functions
Method, (setf locate): Public generic functions
Method, (setf locate): Public generic functions
Method, (setf locate): Public generic functions
Method, (setf locate): Public generic functions
Method, (setf locate): Public generic functions
Method, (setf name): Public generic functions
Method, (setf owner): Public generic functions
Method, base-definition-class: Public generic functions
Method, boundp: Public generic functions
Method, check-definition: Public generic functions
Method, check-definition: Public generic functions
Method, count: Public generic functions
Method, count: Public generic functions
Method, count: Public generic functions
Method, default-system: Public generic functions
Method, default-system: Public generic functions
Method, default-system: Public generic functions
Method, default-system: Public generic functions
Method, definition: Public generic functions
Method, details: Public generic functions
Method, ensure: Public generic functions
Method, ensure: Public generic functions
Method, expand: Public generic functions
Method, expand: Public generic functions
Method, locate: Public generic functions
Method, locate: Public generic functions
Method, locate: Public generic functions
Method, locate: Public generic functions
Method, location: Public generic functions
Method, location: Public generic functions
Method, make-load-form: Public standalone methods
Method, make-load-form: Public standalone methods
Method, map: Public generic functions
Method, map: Public generic functions
Method, map-aliasing-systems: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, owner: Public generic functions
Method, print-object: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, system: Public generic functions
Method, system: Public generic functions
Method, unbind: Public generic functions
Method, unbind: Public generic functions
Method, unbind-definition: Public generic functions
Method, unbind-definition: Public generic functions
Method, unbind-definition: Public generic functions

N
name: Public generic functions
name: Public generic functions
name: Public generic functions

O
owner: Public generic functions
owner: Public generic functions

P
print-object: Public standalone methods

R
root-system: Public ordinary functions

S
shared-initialize: Public standalone methods
system: Public generic functions
system: Public generic functions
system: Public generic functions

U
unbind: Public generic functions
unbind: Public generic functions
unbind: Public generic functions
unbind-definition: Public generic functions
unbind-definition: Public generic functions
unbind-definition: Public generic functions
unbind-definition: Public generic functions


A.4 Data types

Jump to:   A   B   C   D   F   H   L   N   O   P   R   S   U  
Index Entry  Section

A
alias-bindings-mixin: Public classes

B
base-definition-class-mixin: Public classes

C
check-definition-mixin: Public classes
checking.lisp: The definitions-systems/checking․lisp file
Class, alias-bindings-mixin: Public classes
Class, base-definition-class-mixin: Public classes
Class, check-definition-mixin: Public classes
Class, definition: Public classes
Class, hash-table-mixin: Public classes
Class, location-mixin: Public classes
Class, name-mixin: Public classes
Class, owner-mixin: Public classes
Class, primary-binding-mixin: Public classes
Class, root-system: Public classes
Class, standard-definition: Public classes
Class, standard-root-system: Public classes
Class, standard-system: Public classes
Class, system: Public classes
Condition, not-found: Public conditions
Condition, unsuitable-definition-error: Public conditions

D
definition: Public classes
definitions-systems: The definitions-systems system
definitions-systems: The definitions-systems package
definitions-systems.asd: The definitions-systems/definitions-systems․asd file
definitions.lisp: The definitions-systems/definitions․lisp file

F
File, checking.lisp: The definitions-systems/checking․lisp file
File, definitions-systems.asd: The definitions-systems/definitions-systems․asd file
File, definitions.lisp: The definitions-systems/definitions․lisp file
File, package.lisp: The definitions-systems/package․lisp file
File, protocols.lisp: The definitions-systems/protocols․lisp file
File, root.lisp: The definitions-systems/root․lisp file
File, systems.lisp: The definitions-systems/systems․lisp file

H
hash-table-mixin: Public classes

L
location-mixin: Public classes

N
name-mixin: Public classes
not-found: Public conditions

O
owner-mixin: Public classes

P
Package, definitions-systems: The definitions-systems package
package.lisp: The definitions-systems/package․lisp file
primary-binding-mixin: Public classes
protocols.lisp: The definitions-systems/protocols․lisp file

R
root-system: Public classes
root.lisp: The definitions-systems/root․lisp file

S
standard-definition: Public classes
standard-root-system: Public classes
standard-system: Public classes
system: Public classes
System, definitions-systems: The definitions-systems system
systems.lisp: The definitions-systems/systems․lisp file

U
unsuitable-definition-error: Public conditions