The mop-utils Reference Manual

Table of Contents

The mop-utils Reference Manual

This is the mop-utils Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:27:53 2020 GMT+0.

1 Systems

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

1.1 mop-utils

Author

Ryszard Szopa

Description

A set of Metaobject Protocol utilities.

Version

0.0.1

Source

mop-utils.asd (file)

Component

mop-utils.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 mop-utils.asd

Location

mop-utils.asd

Systems

mop-utils (system)

Packages

mop-utils-system

2.1.2 mop-utils/mop-utils.lisp

Parent

mop-utils (system)

Location

mop-utils.lisp

Packages

mop-utils

Exported Definitions

• class-name-of (function)
• defmetaclass (macro)
• do-children (macro)
• do-macro-for-children (macro)
• get-slot-by-name (function)
• get-slot-of-by-name (function)
• slot-names-of (function)
• slots-of (function)

3 Packages

Packages are listed by definition order.

3.1 mop-utils-system

Source

mop-utils.asd

Use List

• asdf/interface
• common-lisp

3.2 mop-utils

A set of Metaobject Protocol utilities.

Source

mop-utils.lisp (file)

Use List

• sb-mop
• common-lisp

Exported Definitions

• class-name-of (function)
• defmetaclass (macro)
• do-children (macro)
• do-macro-for-children (macro)
• get-slot-by-name (function)
• get-slot-of-by-name (function)
• slot-names-of (function)
• slots-of (function)

4 Definitions

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

4.1 Exported definitions

4.1.1 Macros

Macro: defmetaclass METACLASS SUPERS SLOT-DEFINITIONS &body BODY

Macro for easy metaclass definition. It takes all the options
DEFCLASS takes, plus the following:

- :VALIDATE-SUPERCLASSES, classes for which VALIDATE-SUPERCLASS
methods (with METACLASS in the subclass position) will be created.

- :VALIDATE-SUBCLASSES, a list of classes for which
VALIDATE-SUPERCLASS methods (with METACLASS in the superclass
position) will be created.

- :SLOT-FIXTURES, a list of classes from which
EFFECTIVE-SLOT-DEFINITION and DIRECT-SLOT-DEFINITION should
inherit. This class should already exist at the time DEFMETACLASS is called.

DEFMETACLASS apart from creating the metaclass defines some additional things:

- The classes <METACLASS>-DIRECT-SLOT-DEFINITION and <METACLASS>-EFFECTIVE-SLOT-DEFINITION (where <METACLASS> should be substituted by METACLASS), which inherit from the fixtures and STANDARD-CLASS-DIRECT-SLOT-DEFINITION and STANDARD-CLASS-EFFECTIVE-SLOT-DEFINITION, respectively.

- The methods DB-CLASS-{DIRECT|EFFECTIVE}-SLOT-DEFINITION.

Package

mop-utils

Source

mop-utils.lisp (file)

Macro: do-children (VAR CLASS-NAME) &body BODY

For every subclass of class named by CLASS-NAME, execute BODY with VAR bind to it.

Package

mop-utils

Source

mop-utils.lisp (file)

Macro: do-macro-for-children MACRO CLASS-NAME

Use MACRO with the names of all the subclasses of the class named by CLASS-NAME.

Package

mop-utils

Source

mop-utils.lisp (file)

4.1.2 Functions

Function: class-name-of OBJECT

The class-name of the class of OBJECT.

Package

mop-utils

Source

mop-utils.lisp (file)

Function: get-slot-by-name CLASS NAME

Get slot whose name is ‘NAME’ from ‘CLASS’.

Package

mop-utils

Source

mop-utils.lisp (file)

Function: get-slot-of-by-name OBJECT NAME

Get slot whose name is ‘NAME’ of the class of ‘OBJECT’.

Package

mop-utils

Source

mop-utils.lisp (file)

Function: slot-names-of OBJECT

List of names of the slots of OBJECT.

Package

mop-utils

Source

mop-utils.lisp (file)

Function: slots-of OBJECT

List of slots of OBJECT.

Package

mop-utils

Source

mop-utils.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types