The class-options Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

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.


Next: , Previous: , Up: Top   [Contents][Index]

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.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

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

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 class-options.asd

Location

class-options.asd

Systems

class-options (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 class-options/package.lisp

Parent

class-options (system)

Location

package.lisp

Packages

class-options


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 class-options/conditions.lisp

Dependency

package.lisp (file)

Parent

class-options (system)

Location

conditions.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 class-options/class.lisp

Dependency

conditions.lisp (file)

Parent

class-options (system)

Location

class.lisp

Exported Definitions
Internal Definitions

*%class* (special variable)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 class-options/operation.lisp

Dependency

class.lisp (file)

Parent

class-options (system)

Location

operation.lisp

Exported Definitions
Internal Definitions

*%operation* (special variable)


Previous: , Up: Lisp files   [Contents][Index]

3.1.6 class-options/options.lisp

Dependency

operation.lisp (file)

Parent

class-options (system)

Location

options.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 class-options

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Conditions

Condition: read-error ()
Package

class-options

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Direct methods
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)


Previous: , Up: Exported definitions   [Contents][Index]

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)

Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

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

class-options

Source

options.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
class-options.asd: The class-options․asd file
class-options/class.lisp: The class-options/class․lisp file
class-options/conditions.lisp: The class-options/conditions․lisp file
class-options/operation.lisp: The class-options/operation․lisp file
class-options/options.lisp: The class-options/options․lisp file
class-options/package.lisp: The class-options/package․lisp file

F
File, Lisp, class-options.asd: The class-options․asd file
File, Lisp, class-options/class.lisp: The class-options/class․lisp file
File, Lisp, class-options/conditions.lisp: The class-options/conditions․lisp file
File, Lisp, class-options/operation.lisp: The class-options/operation․lisp file
File, Lisp, class-options/options.lisp: The class-options/options․lisp file
File, Lisp, class-options/package.lisp: The class-options/package․lisp file

L
Lisp File, class-options.asd: The class-options․asd file
Lisp File, class-options/class.lisp: The class-options/class․lisp file
Lisp File, class-options/conditions.lisp: The class-options/conditions․lisp file
Lisp File, class-options/operation.lisp: The class-options/operation․lisp file
Lisp File, class-options/options.lisp: The class-options/options․lisp file
Lisp File, class-options/package.lisp: The class-options/package․lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

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

%
%canonicalize: Internal functions

C
canonicalize-options: Exported generic functions
canonicalize-options: Exported generic functions
class: Exported functions

F
Function, %canonicalize: Internal functions
Function, class: Exported functions
Function, operation: Exported functions
Function, options: Exported functions

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

M
Method, canonicalize-options: Exported generic functions
Method, reader: Exported generic functions
Method, required-mixin: Exported generic functions

O
operation: Exported functions
options: Exported functions

R
reader: Exported generic functions
reader: Exported generic functions
required-mixin: Exported generic functions
required-mixin: Exported generic functions

Jump to:   %  
C   F   G   M   O   R  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   %   *  
S  
Index Entry  Section

%
%reader: Exported conditions
%required-mixin: Exported conditions

*
*%class*: Internal special variables
*%operation*: Internal special variables
*%options*: Internal special variables

S
Slot, %reader: Exported conditions
Slot, %required-mixin: Exported conditions
Special Variable, *%class*: Internal special variables
Special Variable, *%operation*: Internal special variables
Special Variable, *%options*: Internal special variables

Jump to:   %   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   O   P   R   S  
Index Entry  Section

C
Class, class-mixin: Exported classes
Class, operation-mixin: Exported classes
Class, options-mixin: Exported classes
class-mixin: Exported classes
class-options: The class-options system
class-options: The class-options package
Condition, read-error: Exported conditions

O
operation-mixin: Exported classes
options-mixin: Exported classes

P
Package, class-options: The class-options package

R
read-error: Exported conditions

S
System, class-options: The class-options system

Jump to:   C   O   P   R   S