Next: , Previous: , Up: Public Interface   [Contents][Index]


6.1.6 Classes

Class: abstract-class

The Abstract Class meta-class.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Direct superclasses

standard-class.

Direct methods
Class: accessor-method-definition

Abstract root class for accessor methods.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses
Direct subclasses
Class: accessor-mixin

Mixin class for accessor definitions.
An accessor is a funcoid which reads or writes a target slot in a classoid. More specifically, these are ordinary functions for structure slots, and methods for classes or conditions slots.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: target-slot

The target slot definition for this definition’s accessor.

Initargs

:target-slot

Readers

target-slot.

Writers

This slot is read-only.

Class: alias-definition

Abstract root class for alias definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

symbol-definition.

Direct subclasses
Direct methods
Direct slots
Slot: setf

Whether this is a setf alias definition.

Package

common-lisp.

Initargs

:setf

Readers

setfp.

Writers

This slot is read-only.

Slot: referee

The original definition this definition aliases.

Readers

referee.

Writers

(setf referee).

Class: c-file-definition

The class of ASDF C file definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

source-file-definition.

Class: cl-source-file.asd

A fake ASDF Lisp file component class for system files.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

cl-source-file.

Direct slots
Slot: type
Package

common-lisp.

Initform

"asd"

Class: class-definition

The class for class definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: object
Readers

definition-class.

Writers

This slot is read-only.

Slot: direct-superclassoids
Readers

direct-superclasses.

Writers

(setf direct-superclasses).

Slot: direct-subclassoids
Readers

direct-subclasses.

Writers

(setf direct-subclasses).

Class: classoid-definition

Abstract root class for classoid definitions. These are conditions, structures, and classes.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

symbol-definition.

Direct subclasses
Direct methods
Direct slots
Slot: object
Initargs

:classoid

Readers

classoid.

Writers

This slot is read-only.

Slot: direct-slots

The list of direct slot definitions for this definition’s classoid.

Readers

direct-slots.

Writers

(setf direct-slots).

Class: clos-classoid-mixin

Mixin for CLOS-based classoids.
These are conditions, ordinary structures, and classes.
All CLOS classoid mixin definitions respond to the following public protocols, which see:
- ‘direct-default-initargs’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: direct-superclassoids

The list of direct superclassoid definitions for this definition’s classoid.

Readers

direct-superclassoids.

Writers

(setf direct-superclassoids).

Slot: direct-subclassoids

The list of direct subclassoid definitions for this definition’s classoid.

Readers

direct-subclassoids.

Writers

(setf direct-subclassoids).

Slot: direct-methods

The list of direct method definitions for this definition’s classoid.

Readers

direct-methods.

Writers

(setf direct-methods).

Class: clos-slot-definition

The class of CLOS slot definitions.
All CLOS slot definitions respond to the following public protocols, which see:
- ‘allocation’,
- ‘initform’,
- ‘initargs’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

slot-definition.

Direct methods
Class: clos-structure-definition

The class of CLOS structure definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: direct-superclassoids
Readers

direct-superstructures.

Writers

(setf direct-superstructures).

Slot: direct-subclassoids
Readers

direct-substructures.

Writers

(setf direct-substructures).

Class: combination-definition

Root class for method combination definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

funcoid-definition.

Direct subclasses
Direct methods
Direct slots
Slot: object
Initargs

:combination

Readers

combination.

Writers

This slot is read-only.

Slot: clients

The list of client definitions for this definition’s method combnination. These are generic functions using this combination.

Readers

clients.

Writers

(setf clients).

Class: compiler-macro-alias-definition

The class of compiler macro alias definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

alias-definition.

Direct methods
Class: compiler-macro-definition

The class of compiler macro definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

funcoid-definition.

Direct methods
Direct slots
Slot: object
Initargs

:compiler-macro

Readers

definition-compiler-macro.

Writers

This slot is read-only.

Class: component-definition

Abstract root class for ASDF components.
All component definitions respond to the following public protocols, which see:
- ‘description’
- ‘long-description’
- ‘definition-version’
- ‘if-feature’.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

definition.

Direct subclasses
Direct methods
Direct slots
Slot: object
Readers

component.

Writers

This slot is read-only.

Slot: location

The component’s location (a namestring).

Readers

location.

Writers

(setf location).

Slot: parent

The parent definition for this definition’s component.

Readers

parent.

Writers

(setf parent).

Slot: dependencies

The list of dependency definitions for this definition’s component.

Readers

dependencies.

Writers

(setf dependencies).

Class: condition-definition

The class of condition definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: object
Readers

definition-condition.

Writers

This slot is read-only.

Slot: direct-superclassoids
Readers

direct-superconditions.

Writers

(setf direct-superconditions).

Slot: direct-subclassoids
Readers

direct-subconditions.

Writers

(setf direct-subconditions).

Class: constant-definition

The class of constant definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

variable-definition.

Direct methods
Class: definition

Abstract root class for all definitions.
All definitions respond to the following public protocols, which see: - ‘name’,
- ‘docstring’.

Package

net.didierverna.declt.assess.

Source

definition.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: object

The corresponding Lisp object, or NIL.
Only constants, special variables, symbol macros, and aliases lack such an object.

Initargs

:object

Readers

object.

Writers

This slot is read-only.

Slot: uid

This definition’s UID.

Readers

uid.

Writers

(setf uid).

Slot: source-file

The source file definition for this definition’s object.

Readers

source-file.

Writers

(setf source-file).

Slot: foreign

Whether this definition is foreign.

Initargs

:foreign

Readers

foreignp.

Writers

(setf foreignp).

Class: doc-file-definition

The class of ASDF doc file definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

static-file-definition.

Direct subclasses

html-file-definition.

Class: expander-definition

Abstract root class for setf expander definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

funcoid-definition.

Direct subclasses
Direct methods
Direct slots
Slot: object
Initargs

:expander

Readers

expander.

Writers

This slot is read-only.

Slot: setf
Package

common-lisp.

Initform

t

Slot: standalone-reader

A standalone reader definition for this definition’s expander, or NIL.
If it exists, it’s a definition for a function or macro with the same signature as that of the expander’s access-fn. Note that the Common Lisp standard does not impose any actual relation between the setf expander and its access-fn. In fact, the access-fn may not even exist at all. However, if it does, it is very likely that it is a reader for the place updated by this setf expander.

Readers

standalone-reader.

Writers

(setf standalone-reader).

Class: file-definition

The class of ASDF file definitions.
All file definitions respond to the following public protocols, which see: - ‘extension’.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

component-definition.

Direct subclasses

source-file-definition.

Direct methods
Direct slots
Slot: object
Initargs

:file

Readers

file.

Writers

This slot is read-only.

Class: funcoid-definition

Abstract root class for functional definitions.
These are (compiler) macros, (generic) functions, methods, setf expanders, method combinations, and types.
All funcoid definitions respond to the following public protocols, which see: - ‘lambda-list’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

symbol-definition.

Direct subclasses
Direct methods
Direct slots
Slot: object
Readers

funcoid.

Writers

This slot is read-only.

Slot: setf

Whether this is a setf definition.

Package

common-lisp.

Initargs

:setf

Readers

setfp.

Writers

This slot is read-only.

Class: function-alias-definition

The class of non-setf function alias definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

alias-definition.

Direct methods
Class: function-definition

Abstract root class for functions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

setfable-funcoid-definition.

Direct subclasses
Direct methods

definition-function.

Direct slots
Slot: object
Initargs

:function

Readers

definition-function.

Writers

This slot is read-only.

Class: generic-accessor-definition

Abstract root class for generic accessor functions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

generic-function-definition.

Direct subclasses
Class: generic-function-definition

The class of generic function definitions.
All generic function definitions respond to the following public protocols, which see:
- ‘combination-options’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

function-definition.

Direct subclasses

generic-accessor-definition.

Direct methods
Direct slots
Slot: object
Initargs

:generic

Readers

generic.

Writers

This slot is read-only.

Slot: methods

The list of method definitions for this definition’s generic function.

Readers

methods.

Writers

(setf methods).

Slot: combination

The method combination definition for this definition’s generic function.

Readers

combination.

Writers

(setf combination).

Class: generic-reader-definition

The class of generic reader function definitions.
A generic function is considered to be a reader function when all its mehtods are reader methods.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

generic-accessor-definition.

Direct methods
Class: generic-writer-definition

The class of generic writer function definitions.
A generic function is considered to be a writer function when all its mehtods are writer methods.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

generic-accessor-definition.

Direct methods
Class: html-file-definition

The class of ASDF HTML file definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

doc-file-definition.

Class: java-file-definition

The class of ASDF Java file definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

source-file-definition.

Class: lisp-file-definition

The class of ASDF Lisp file definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

source-file-definition.

Direct subclasses

system-file-definition.

Direct methods
Direct slots
Slot: definitions

The list of definitions for this definition’s file.

Readers

definitions.

Writers

(setf definitions).

Class: long-combination-definition

Class for long method combination definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

combination-definition.

Class: long-expander-definition

The class of long form setf expanders definitions.
This class is shared by expanders created with either the long form of DEFSETF, or DEFINE-SETF-EXPANDER.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

expander-definition.

Direct methods
Class: macro-alias-definition

The class of macro alias definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

alias-definition.

Direct methods
Class: macro-definition

The class of macro definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

setfable-funcoid-definition.

Direct methods
Direct slots
Slot: object
Initargs

:macro

Readers

macro.

Writers

This slot is read-only.

Class: method-definition

Abstract root class for method definitions.
All method definitions respond to the following public protocols, which see: - ‘qualifiers’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

funcoid-definition.

Direct subclasses

accessor-method-definition.

Direct methods
Direct slots
Slot: object
Initargs

:method

Readers

definition-method.

Writers

This slot is read-only.

Slot: owner

The generic function definition for this definition’s method.

Readers

owner.

Writers

(setf owner).

Slot: specializers

The specializers of this definition’s method.
This is a list of either class definitions (for regular specializers), or raw EQL specializers.

Readers

specializers.

Writers

(setf specializers).

Class: module-definition

The class of ASDF module definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

component-definition.

Direct subclasses

system-definition.

Direct methods
Direct slots
Slot: object
Initargs

:module

Readers

module.

Writers

This slot is read-only.

Slot: children

The list of child definitions for this definition’s module.

Readers

children.

Writers

(setf children).

Class: ordinary-accessor-definition

Abstract root class for ordinary accessor functions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses
Direct subclasses
Class: ordinary-function-definition

The class of ordinary functions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

function-definition.

Direct subclasses

ordinary-accessor-definition.

Direct methods
Class: ordinary-reader-definition

The class of ordinary reader definitions.
An ordinary reader is an ordinary function that reads a slot in a structure.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

ordinary-accessor-definition.

Direct methods
Class: ordinary-writer-definition

The class of ordinary writer definitions.
An ordinary writer is an ordinary function that writes a slot in a structure.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

ordinary-accessor-definition.

Direct methods
Direct slots
Slot: setf
Package

common-lisp.

Initform

t

Class: package-definition

The class of package definitions.
All package definitions respond to the following public protocols, which see:
- ‘nicknames’.

Package

net.didierverna.declt.assess.

Source

package.lisp.

Direct superclasses

definition.

Direct methods
Direct slots
Slot: object
Initargs

:package

Readers

definition-package.

Writers

This slot is read-only.

Slot: external-symbols

The list of corresponding external symbols.

Readers

external-symbols.

Writers

(setf external-symbols).

Slot: internal-symbols

The list of corresponding internal symbols.

Readers

internal-symbols.

Writers

(setf internal-symbols).

Slot: use-list

The definitions use-list for this definition’s package.

Readers

use-list.

Writers

(setf use-list).

Slot: used-by-list

The definitions used-by-list for this definition’s package.

Readers

used-by-list.

Writers

(setf used-by-list).

Slot: definitions

The list of corresponding definitions.

Readers

definitions.

Writers

(setf definitions).

Class: reader-method-definition

The class of reader method definitions.
A reader method is a method that reads a slot in a class or condition.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

accessor-method-definition.

Direct methods

category-name.

Class: report

The Report class.
This is the class holding all extracted documentation information.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Direct methods
Direct slots
Slot: library-name

The library’s name.

Readers

library-name.

Writers

(setf library-name).

Slot: tagline

The reference manual’s tagline.

Readers

tagline.

Writers

(setf tagline).

Slot: library-version

The library’s version.

Readers

library-version.

Writers

(setf library-version).

Slot: contacts

The list of contacts for the library.
Each element is of the form (NAME . EMAIL) where both NAME and EMAIL are strings or NIL, and cannot be null at the same time.

Readers

contacts.

Writers

(setf contacts).

A copyright years string.

Readers

copyright-years.

Writers

(setf copyright-years).

Slot: license

The library’s license.

Readers

license.

Writers

(setf license).

Slot: introduction

Contents for an introduction chapter.

Readers

introduction.

Writers

(setf introduction).

Slot: conclusion

Contents for a conclusion chapter.

Readers

conclusion.

Writers

(setf conclusion).

Slot: definitions

The list of definitions.

Readers

definitions.

Writers

(setf definitions).

Class: setfable-funcoid-definition

Abstract root class for setfable funcoids.
These are (generic) functions and macros. A funcoid is setfable when it may be related to one or more setf expanders. There are two kinds of relation to a setf expander: 1. the funcoid’ signature is the same as that of an expander’s access-fn, and 2. a short form setf expander expands to it (i.e., it has this funcoid as its update-fn).

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

funcoid-definition.

Direct subclasses
Direct methods
Direct slots
Slot: expander-for

A setf expander definition for this funcoid, or NIL.
This is the definition of a setf expander that expands forms identical to this funcoid’s signature. There can be only one. Note that the Common Lisp standard does not impose any actual relation between the setf expander and its access-fn. In fact, the access-fn may not even exist at all. However, if it does, it is very likely that it is a reader for the place updated by this setf expander.

Readers

expander-for.

Writers

(setf expander-for).

Slot: expanders-to

The list of setf expander definitions to this funcoid.
This is a list of definitions for short form setf expanders that have this funcoid as their update-fn. There might be more than one.

Readers

expanders-to.

Writers

(setf expanders-to).

Class: short-combination-definition

The class of short method combination definitions.
All short method combination definitions respond to the following public protocols, which see:
- ‘identity-with-one-argument’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

combination-definition.

Direct methods
Direct slots
Slot: standalone-combinator

The corresponding standalone combinator definition, or NIL.
This is a function or macro definition. Note that if this definition is unavailable, it means that the method combination itself cannot be used (yet).

Readers

standalone-combinator.

Writers

(setf standalone-combinator).

Class: short-expander-definition

The class of short form setf expanders definitions.
Short form setf expanders simply expand to a globally defined function or macro.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

expander-definition.

Direct methods
Direct slots
Slot: standalone-writer

A standalone writer definition for this definition’s expander, or NIL. This is a function or macro definition. Note that if this definition is unavailable, it means that the expander itself cannot be used (yet).

Readers

standalone-writer.

Writers

(setf standalone-writer).

Class: slot-definition

Abstract root class for slots.
All slot definitions respond to the following public protocols, which see: - ‘value-type’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

varoid-definition.

Direct subclasses
Direct methods
Direct slots
Slot: object
Initargs

:slot

Readers

slot.

Writers

This slot is read-only.

Slot: owner

The definition for the owner of this definition’s slot.

Readers

owner.

Writers

(setf owner).

Slot: readers

The list of definitions for this definition’s slot readers.

Readers

readers.

Writers

(setf readers).

Slot: writers

The list of definitions for this definition’s slot writers.

Readers

writers.

Writers

(setf writers).

Class: source-file-definition

The class of ASDF source file definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

file-definition.

Direct subclasses
Class: special-definition

The class of special variable definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

variable-definition.

Direct methods
Class: static-file-definition

The class of ASDF static file definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

source-file-definition.

Direct subclasses

doc-file-definition.

Class: structure-definition

Abstract root class for structures.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

classoid-definition.

Direct subclasses
Direct methods
Direct slots
Slot: object
Readers

definition-structure.

Writers

This slot is read-only.

Class: symbol-definition

Abstract root class for definitions named by symbols.
All symbol definitions respond to the following public protocols, which see: - ‘publicp’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

definition.

Direct subclasses
Direct methods
Direct slots
Slot: symbol

The symbol naming this definition.

Package

common-lisp.

Initargs

:symbol

Readers

definition-symbol.

Writers

This slot is read-only.

Slot: home-package

The home package definition for this definition’s symbol.
Every definition gets a home package, even foreign ones. A home package can only be null when the definition’s symbol is uninterned.

Readers

home-package.

Writers

(setf home-package).

Class: symbol-macro-definition

The class of symbol macro definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

varoid-definition.

Direct methods
Class: system-definition

The class of ASDF system definitions.
All system definitions respond to the following public protocols, which see: - ‘long-name’,
- ‘mailto’,
- ‘homepage’,
- ‘source-control’,
- ‘bug-tracker’,
- ‘license-name’.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

module-definition.

Direct methods
Direct slots
Slot: object
Initargs

:system

Readers

system.

Writers

This slot is read-only.

Slot: parent
Slot: maintainers

The list of parsed maintainer contacts.
See ‘parse-contact-string’ for more information.

Readers

maintainers.

Writers

(setf maintainers).

Slot: authors

The list of parsed author contacts.
See ‘parse-contact-string’ for more information.

Readers

authors.

Writers

(setf authors).

Slot: defsystem-dependencies

The list of defsystem dependency definitions.

Readers

defsystem-dependencies.

Writers

(setf defsystem-dependencies).

Class: system-file-definition

The class of ASDF system file definitions.
This class represents ASDF system files as Lisp files. Because system files are not components, we use an ad-hoc fake component class for them, ‘cl-source-file.asd’, which see.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

lisp-file-definition.

Direct methods

initialize-instance.

Class: type-definition

The class of type definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

funcoid-definition.

Direct methods
Direct slots
Slot: object
Initargs

:expander

Readers

expander.

Writers

This slot is read-only.

Class: typed-structure-definition

The class of typed structure definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

structure-definition.

Direct methods
Direct slots
Slot: type

The structure type, either LIST or VECTOR.

Package

common-lisp.

Initargs

:type

Readers

structure-type.

Writers

(setf structure-type).

Slot: element-type

The structure’s element type.
It is T for list structures, but may be something else for vector ones.

Initargs

:element-type

Readers

element-type.

Writers

(setf element-type).

Class: typed-structure-slot-definition

The class of typed structure slot definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

slot-definition.

Direct methods
Class: variable-definition

Abstract root class for constant and special variables.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

varoid-definition.

Direct subclasses
Direct methods

docstring.

Class: varoid-definition

Abstract root class for simply valued symbol definitions. These are constants, special variables, and symbol macros.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

symbol-definition.

Direct subclasses
Direct methods
Class: writer-method-definition

The class of writer method definitions.
A writer method is a method that writes a slot in a class or condition.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

accessor-method-definition.

Direct methods

category-name.


Next: Types, Previous: Standalone methods, Up: Public Interface   [Contents][Index]