Package inheriting-readers
Description
All symbols from this package should normally be explicitly qualified, such as inheriting-readers:standard-class.
Don't (:use)!
inheriting-readers
inheriting-readers provides a simple yet powerful value inheritance scheme.
⚓
Sorry for the incomplete documentation. See note on Libraries page.
⚓
⚓
⚓
⚓
Class inheriting-readers:standard-metaclass
inheriting-readers:inheritance-schemes-mixin, compatible-metaclasses:standard-class, compatible-metaclasses:standard-metaclass
Description
TBW.
⚓
Class inheriting-readers:class
Description
TBW.
⚓
Class inheriting-readers:standard-class
inheriting-readers:inheritance-schemes-mixin, inheriting-readers:inherit-class-option-mixin, class-options:class-mixin, compatible-metaclasses:standard-class
Class options: (:inheritance-schemes t (:parent-function #'inheriting-readers:parent))
Description
TBW.
Method c2mop:direct-slot-definition-class
(class inheriting-readers:standard-class) slot-names &key inherit => slot-definition-class
Description
If inherit is not nil, return the class inheriting-readers:standard-direct-slot, else call the next method.
Method c2mop:reader-method-class
(class inheriting-readers:standard-class) (class inheriting-readers:direct-slot) &key &allow-other-keys => reader-method-class
Description
Returns the class inheriting-readers:standard-reader-method.
⚓
Class inheriting-readers:direct-slot
c2mop:standard-direct-slot-definition
Description
TBW.
⚓
Class inheriting-readers:standard-direct-slot
inheriting-readers:inherit-mixin, inheriting-readers:inheritance-scheme-mixin, inheriting-readers:direct-slot
Description
TBW.
Around-Method initialize-instance
(slot inheriting-readers:standard-direct-slot) &key instance
Description
TBW.
⚓
Generic Function inheriting-readers:expand-inherit-slot-option
direct-slot &rest initargs &key &allow-other-keys => initargs-overrides
Arguments and Values
- direct-slot -- A direct slot.
- initargs -- A plist.
- initargs-overrides -- A fresh plist.
Description
TBW.
Methods
Method inheriting-readers:expand-inherit-slot-option
(slot inheriting-readers:standard-direct-slot) &key inherit inheritance-scheme => initargs-overrides
Description
TBW.
⚓
Class inheriting-readers:inherit-mixin
Description
Slots:
((inherit :initarg :inherit
:reader inheriting-readers:inherit
:initform nil))⚓
Generic Function inheriting-readers:inherit
object => inheritance-specification
Description
Returns the inheritance-specification associated with the object.
⚓
Class inheriting-readers:inherit-class-option-mixin
inheriting-readers:inherit-mixin, class-options:options-mixin, inheriting-readers:class
Description
TBW.
Method class-options:canonicalize-options
(class inheriting-readers:inherit-class-option-mixin) &key inherit direct-slots => canonicalized-options
Description
TBW.
⚓
Class inheriting-readers:reader-method
Description
TBW.
⚓
Class inheriting-readers:standard-reader-method
inheriting-readers:reader-method
Description
TBW.
Around-Method initialize-instance
(method inheriting-readers:standard-reader-method) &rest initargs &key slot-definition
Description
TBW.
⚓
Generic Function inheriting-readers:compute-inheriting-method-initargs-overrides
class direct-slot inheritance-scheme method &rest initargs &key &allow-other-keys => initargs-overrides
Arguments and Values
- class -- A class.
- direct-slot -- A direct slot.
- inheritance-scheme -- An
inheriting-readers:inheritance-scheme. - method -- A method.
- initargs -- A plist.
- initargs-overrides -- A fresh plist.
Description
TBW.
Methods
Method inheriting-readers:compute-inheriting-method-initargs-overrides
(class inheriting-readers:class) (direct-slot c2mop:direct-slot-definition) (inheritance-scheme inheriting-readers:standard-inheritance-scheme) (method inheriting-readers:reader-method) &key => initargs-overrides
Description
TBW.
⚓
⚓
Class inheriting-readers:inheritance-scheme
Description
TBW.
Generic Function inheriting-readers:inheritance-scheme
object => inheritance-scheme
Description
Returns the inheritance-scheme associated with the object.
⚓
Class inheriting-readers:standard-inheritance-scheme
inheriting-readers:parent-function-mixin, inheriting-readers:nil-is-valid-parent-p-mixin, inheriting-readers:inheritance-scheme
Description
TBW.
⚓
Class inheriting-readers:parent-mixin
Description
Slots:
((inherit :initarg :parent
:reader inheriting-readers:parent
:initform nil))⚓
Generic Function inheriting-readers:parent
object => parent
Description
Returns the object's parent.
An object could have multiple parents for various purposes, but this is a good default.
⚓
Class inheriting-readers:parent-function-mixin
Description
Slots:
((parent-function :initarg :parent-function
:reader inheriting-readers:parent-function
:type (or function symbol)
:initform #'inheriting-readers:parent))Around-Method shared-initialize
(mixin inheriting-readers:parent-function-mixin) slot-names &rest initargs &key parent-function => instance
Description
TBW.
⚓
Generic Function inheriting-readers:parent-function
object => parent-function
Description
Returns the parent-function to call to retrieve the parent.
⚓
Class inheriting-readers:nil-is-valid-parent-p-mixin
Description
Slots:
((nil-is-valid-parent-p :initarg :nil-is-valid-parent-p
:reader inheriting-readers:nil-is-valid-parent-p
:type boolean
:initform nil))⚓
Generic Function inheriting-readers:nil-is-valid-parent-p
object => nil-is-valid-parent-p
Description
Indicates whether or not nil is a valid parent.
⚓
Class inheriting-readers:inheritance-scheme-mixin
Description
Slots:
((inheritance-scheme :initarg :inheritance-scheme
:reader inheriting-readers:inheritance-scheme
:type inheriting-readers:inheritance-scheme))⚓
Generic Function inheriting-readers:inheritance-scheme-class
class &rest initargs &key &allow-other-keys => inheritance-scheme-class
Arguments and Values
- class -- A class.
- initargs -- A plist.
- inheritance-scheme-class -- A subclass of
inheriting-readers:inheritance-scheme.
Description
TBW.
Methods
Method inheriting-readers:inheritance-scheme-class
(class cl:class) &key => inheritance-scheme-class
Description
Returns the class inheriting-readers:standard-inheritance-scheme.
⚓
Generic Function inheriting-readers:resolve-inheritance-scheme
class inheritance-scheme-specification &key => inheritance-scheme
Arguments and Values
- class -- A class.
- inheritance-scheme-specification -- An inheritance scheme specification.
- inheritance-scheme -- An
inheriting-readers:inheritance-scheme.
Description
TBW.
Methods
Around-Method inheriting-readers:resolve-inheritance-scheme
class inheritance-scheme-specification &key (errorp t) => inheritance-scheme
Description
Call the next method. Return its result if it's not nil, else signal an error if errorp is true, else return nil.
Method inheriting-readers:resolve-inheritance-scheme
(class cl:class) (inheritance-scheme-specification cons) &key => inheritance-scheme
Description
Calls (apply #'make-instance (inheriting-readers:inheritance-scheme-class class) initargs).
Method inheriting-readers:resolve-inheritance-scheme
object (inheritance-scheme inheriting-readers:inheritance-scheme) &key => inheritance-scheme
Description
Returns the supplied inheritance-scheme.
Method inheriting-readers:resolve-inheritance-scheme
(mixin inheriting-readers:inheritance-schemes-mixin) (object symbol) &key => inheritance-scheme
Description
Returns the inheritance-scheme bound to name in (inheriting-readers:inheritance-schemes mixin), if there is one, else calls the next method.
Method inheriting-readers:resolve-inheritance-scheme
(mixin inheriting-readers:standard-metaclass) (name symbol) &rest rest => inheritance-scheme
Description
Call the next method and return that result if it's not nil.
Else, try to find the class named name, and if there is one then return the result of (apply #'inheriting-readers:resolve-inheritance-scheme class t :errorp nil rest), else return nil.
Method inheriting-readers:resolve-inheritance-scheme
(class inheriting-readers:class) inheritance-scheme-specification &rest rest => inheritance-scheme
Description
Call (apply #'inheriting-readers:resolve-inheritance-scheme (class-of class) inheritance-scheme-specification :errorp nil rest).
⚓
Class inheriting-readers:inheritance-schemes-mixin
Description
Slots:
((inheritance-schemes :reader inheriting-readers:inheritance-schemes
:initform nil))Before-Method initialize-instance
(mixin inheriting-readers:inheritance-schemes-mixin) &key inheritance-schemes
Description
Sets the value of the inheritance-schemes slot to the value of (inheriting-readers:canonicalize-inheritance-schemes mixin inheritance-schemes).
Before-Method reinitialize-instance
(mixin inheriting-readers:inheritance-schemes-mixin) &key inheritance-schemes
Description
If inheritance-schemes was supplied, then set the value of the inheritance-schemes slot to nil (to make sure previous local inheritance schemes don't participate in inheritance scheme resolution while canonicalizing inheritance schemes this time around) and execute the same code as the above method.
⚓
Generic Function inheriting-readers:inheritance-schemes
class => inheritance-schemes
Description
Returns the local inheritance-schemes associated with the class.
⚓
Generic Function inheriting-readers:canonicalize-inheritance-schemes
class inheritance-scheme-specifications &key => canonicalized-inheritance-schemes
Arguments and Values
- class -- A class.
- inheritance-scheme-specifications -- A plist. Each entry associates a name to an inheritance scheme specification.
- canonicalized-inheritance-schemes -- A plist. Each entry associates a name to an
inheriting-readers:inheritance-scheme.
Description
TBW.
Methods
Method inheriting-readers:canonicalize-inheritance-schemes
(mixin inheriting-readers:inheritance-schemes-mixin) (inheritance-scheme-specifications list) => canonicalized-inheritance-schemes
Description
Returns a fresh plist in which each inheritance-scheme-specification in inheritance-scheme-specifications has been resolved to an inheriting-readers:inheritance-scheme with (inheriting-readers:resolve-inheritance-scheme mixin inheritance-scheme-specification).