The class-options Reference Manual

Table of Contents

The class-options Reference Manual

This is the class-options Reference Manual, version 1.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 12:58:23 2020 GMT+0.

1 Introduction

Project's home: https://www.hexstreamsoft.com/libraries/class-options/


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


This library is in the Public Domain.
See the UNLICENSE file for details.

2 Systems

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

2.1 class-options

Author

Jean-Philippe Paradis <hexstream@hexstreamsoft.com>

License

Unlicense

Description

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

Version

1.0.1

Dependency

closer-mop

Source

class-options.asd (file)

Components

• package.lisp (file)
• conditions.lisp (file)
• class.lisp (file)
• operation.lisp (file)
• options.lisp (file)

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.asd

Location

class-options.asd

Systems

class-options (system)

3.1.2 class-options/package.lisp

Parent

class-options (system)

Location

package.lisp

Packages

class-options

3.1.3 class-options/conditions.lisp

Dependency

package.lisp (file)

Parent

class-options (system)

Location

conditions.lisp

Exported Definitions

• read-error (condition)
• reader (method)
• required-mixin (method)

3.1.4 class-options/class.lisp

Dependency

conditions.lisp (file)

Parent

class-options (system)

Location

class.lisp

Exported Definitions

• class (function)
• class-mixin (class)

Internal Definitions

*%class* (special variable)

3.1.5 class-options/operation.lisp

Dependency

class.lisp (file)

Parent

class-options (system)

Location

operation.lisp

Exported Definitions

• operation (function)
• operation-mixin (class)

Internal Definitions

*%operation* (special variable)

3.1.6 class-options/options.lisp

Dependency

operation.lisp (file)

Parent

class-options (system)

Location

options.lisp

Exported Definitions

• canonicalize-options (generic function)
• canonicalize-options (method)
• options (function)
• options-mixin (class)

Internal Definitions

• %canonicalize (function)
• *%options* (special variable)

4 Packages

Packages are listed by definition order.

4.1 class-options

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• canonicalize-options (generic function)
• canonicalize-options (method)
• class (function)
• class-mixin (class)
• operation (function)
• operation-mixin (class)
• options (function)
• options-mixin (class)
• read-error (condition)
• reader (generic function)
• reader (method)
• required-mixin (generic function)
• required-mixin (method)

Internal Definitions

• %canonicalize (function)
• *%class* (special variable)
• *%operation* (special variable)
• *%options* (special variable)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: class ()

Package

class-options

Source

class.lisp (file)

Function: operation ()

Package

class-options

Source

operation.lisp (file)

Function: options ()

Package

class-options

Source

options.lisp (file)

5.1.2 Generic functions

Generic Function: canonicalize-options CLASS &rest OPTIONS &key &allow-other-keys

Package

class-options

Source

options.lisp (file)

Methods

Method: canonicalize-options (CLASS class) &rest OPTIONS

Generic Function: reader CONDITION

Package

class-options

Methods

Method: reader (CONDITION read-error)

Source

conditions.lisp (file)

Generic Function: required-mixin CONDITION

Package

class-options

Methods

Method: required-mixin (CONDITION read-error)

Source

conditions.lisp (file)

5.1.3 Conditions

Condition: read-error ()

Package

class-options

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Direct methods

• required-mixin (method)
• reader (method)

Direct slots

Slot: %reader

Initargs

:reader

Initform

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

Readers

reader (generic function)

Slot: %required-mixin

Initargs

:required-mixin

Initform

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

Readers

required-mixin (generic function)

5.1.4 Classes

Class: class-mixin ()

Package

class-options

Source

class.lisp (file)

Direct superclasses

standard-class (class)

Direct methods

• reinitialize-instance (method)
• initialize-instance (method)

Class: operation-mixin ()

Package

class-options

Source

operation.lisp (file)

Direct superclasses

standard-class (class)

Direct methods

• reinitialize-instance (method)
• initialize-instance (method)

Class: options-mixin ()

Package

class-options

Source

options.lisp (file)

Direct superclasses

standard-class (class)

Direct methods

• reinitialize-instance (method)
• initialize-instance (method)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *%class*

Package

class-options

Source

class.lisp (file)

Special Variable: *%operation*

Package

class-options

Source

operation.lisp (file)

Special Variable: *%options*

Package

class-options

Source

options.lisp (file)

5.2.2 Functions

Function: %canonicalize CALL-NEXT-METHOD CLASS OPERATION OPTIONS

Package

class-options

Source

options.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types