The class-options Reference Manual

This is the class-options Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:42:26 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 class-options

Provides easy access to the defining class and its options during initialization or reinitialization of its subcomponents.

Author

Jean-Philippe Paradis <>

License

Unlicense

Version

1.0.1

Dependency

closer-mop (system).

Source

class-options.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 class-options/class-options.asd

Source

class-options.asd.

Parent Component

class-options (system).

ASDF Systems

class-options.


3.1.2 class-options/package.lisp

Source

class-options.asd.

Parent Component

class-options (system).

Packages

class-options.


3.1.3 class-options/conditions.lisp

Dependency

package.lisp (file).

Source

class-options.asd.

Parent Component

class-options (system).

Public Interface

3.1.4 class-options/class.lisp

Dependency

conditions.lisp (file).

Source

class-options.asd.

Parent Component

class-options (system).

Public Interface
Internals

*%class* (special variable).


3.1.5 class-options/operation.lisp

Dependency

class.lisp (file).

Source

class-options.asd.

Parent Component

class-options (system).

Public Interface
Internals

*%operation* (special variable).


3.1.6 class-options/options.lisp

Dependency

operation.lisp (file).

Source

class-options.asd.

Parent Component

class-options (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 class-options

Source

package.lisp.

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 Ordinary functions

Function: class ()
Package

class-options.

Source

class.lisp.

Function: operation ()
Package

class-options.

Source

operation.lisp.

Function: options ()
Package

class-options.

Source

options.lisp.


5.1.2 Generic functions

Generic Function: canonicalize-options (class &rest options &key &allow-other-keys)
Package

class-options.

Source

options.lisp.

Methods
Method: canonicalize-options ((class class) &rest options)
Generic Reader: reader (condition)
Package

class-options.

Methods
Reader Method: reader ((condition read-error))
Source

conditions.lisp.

Target Slot

%reader.

Generic Reader: required-mixin (condition)
Package

class-options.

Methods
Reader Method: required-mixin ((condition read-error))
Source

conditions.lisp.

Target Slot

%required-mixin.


5.1.3 Standalone methods

Method: initialize-instance :around ((class operation-mixin) &key)
Source

operation.lisp.

Method: initialize-instance :around ((class class-mixin) &key)
Source

class.lisp.

Method: initialize-instance :around ((class options-mixin) &rest options)
Source

options.lisp.

Method: reinitialize-instance :around ((class operation-mixin) &key)
Source

operation.lisp.

Method: reinitialize-instance :around ((class class-mixin) &key)
Source

class.lisp.

Method: reinitialize-instance :around ((class options-mixin) &rest options)
Source

options.lisp.


5.1.4 Conditions

Condition: read-error
Package

class-options.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: %reader
Initform

(quote (error "~s must be supplied." :reader))

Initargs

:reader

Readers

reader.

Writers

This slot is read-only.

Slot: %required-mixin
Initform

(quote (error "~s must be supplied." :required-mixin))

Initargs

:required-mixin

Readers

required-mixin.

Writers

This slot is read-only.


5.1.5 Classes

Class: class-mixin
Package

class-options.

Source

class.lisp.

Direct superclasses

standard-class.

Direct methods
Class: operation-mixin
Package

class-options.

Source

operation.lisp.

Direct superclasses

standard-class.

Direct methods
Class: options-mixin
Package

class-options.

Source

options.lisp.

Direct superclasses

standard-class.

Direct methods

5.2 Internals


5.2.1 Special variables

Special Variable: *%class*
Package

class-options.

Source

class.lisp.

Special Variable: *%operation*
Package

class-options.

Source

operation.lisp.

Special Variable: *%options*
Package

class-options.

Source

options.lisp.


5.2.2 Ordinary functions

Function: %canonicalize (call-next-method class operation options)
Package

class-options.

Source

options.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %  
C   F   G   I   M   O   R  
Index Entry  Section

%
%canonicalize: Private ordinary functions

C
canonicalize-options: Public generic functions
canonicalize-options: Public generic functions
class: Public ordinary functions

F
Function, %canonicalize: Private ordinary functions
Function, class: Public ordinary functions
Function, operation: Public ordinary functions
Function, options: Public ordinary functions

G
Generic Function, canonicalize-options: Public generic functions
Generic Function, reader: Public generic functions
Generic Function, required-mixin: Public generic functions

I
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods

M
Method, canonicalize-options: Public generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, reader: Public generic functions
Method, reinitialize-instance: Public standalone methods
Method, reinitialize-instance: Public standalone methods
Method, reinitialize-instance: Public standalone methods
Method, required-mixin: Public generic functions

O
operation: Public ordinary functions
options: Public ordinary functions

R
reader: Public generic functions
reader: Public generic functions
reinitialize-instance: Public standalone methods
reinitialize-instance: Public standalone methods
reinitialize-instance: Public standalone methods
required-mixin: Public generic functions
required-mixin: Public generic functions