The descriptions Reference Manual

Table of Contents

The descriptions Reference Manual

This is the descriptions Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 17:57:50 2020 GMT+0.

1 Introduction

{} descriptions

Overview

{} descriptions is a meta level descriptions library for Common Lisp.

It is inspired by Smalltalk Maggrite, as well as Lisp On Lines.

Documentation

HTML documentation

PDF manual

Install

Download the source code from https://github.com/mmontone/descriptions and point .asd system definition files from ./sbcl/system (ln -s <system definition file path>) and then evaluate:

(require :descriptions)

from your lisp listener.

You will also need to satisfy these system dependencies:

• alexandria
• anaphora
• sheeple
• cxml and cl-json for the serialization module
• cl-ppcre for the validation module

The easiest way of installing those packages is via Quicklisp.

This library is under the MIT licence.

Getting started

{} descriptions is a very dynamic meta-description library similar to Smalltalk Maggrite and Lisp On Lines. Meta description of the application's domain model is done defining descriptions for the different aspects is desired to represent. This helps automate the generation of different views, editors, serialization schemas, validation procedures for the domain model objects and to avoid very repetitive and error-prone work when those objects change its shape.

Domain model meta descriptions consist of the definition of description objects for its different aspects (viewing, editing, validation, persistence, serialization, etc). Description objects are a collections of attributes, can inherit from each other, and are composable.

Let's go through an example to see how this works.

Say we have a person model object:

(defclass person ()
  ((id :accessor id)
   (username :initarg :username
	     :accessor username)
   (fullname :initarg :fullname
             :accessor fullname)
   (email :initarg :email
          :accessor email)
   (password :initarg :password
	     :accessor password)))

We would like to print instances of that model on the screen. So first we define a {person} description that just describes which attributes person model objecs possess and their "types".

(define-description {person} ()
  ((username =>string
	     :reader #'username
	     :writer #'(setf username))
   (email =>email
	  :reader #'email
	  :writer #'(setf email))
   (fullname =>string
	     :reader #'fullname
	     :writer #'(setf fullname))
   (password =>password
	     :reader #'password
	     :writer #'(setf password)))
  :documentation "A person description")

Descriptions names are enclosed between brackets { } as a naming convention. Also, notice that the attribute types (=>string, =>email, =>password), begin with =>. Attributes types begin with => as a naming convention.

Now we can use the information on the attributes of a person, and its types, to print a description of a person on the screen. To do that we define a new description that indicates which person slots we would like to print, and in which order.

(define-description {person-view} ({person})
  ((fullname =>view :label "Full name")
   (username =>view)
   (email =>view :label "E-mail")
   (password =>view :view nil)))

We can see that the password is disabled for viewing, that "Full name" and "E-mail" are used for labels, and that fullname, username, email and password are to be displayed in that order.

We can see that in action:

(display-object (make-instance 'person :username "mmontone"
			       :email "mariano@copyleft.no"
			       :password "lalala"
			       :fullname "Mariano Montone")
		{person-view})

prints:

Full name: "Mariano Montone"
Username: "mmontone"
E-mail: "mariano@copyleft.no"

Descriptions composition

Descriptions can be composed using inheritance. Multiple inheritance is supported and they are implemented on top of a prototype based object system, so they can be composed in run time on the fly.

Attributes composition

When inheriting from other descriptions, attributes with the same name are collapsed into one containing all the attribute properties.

For example, consider the basic {person} description we had before. We can ask for an attribute name and type, but asking if that attribute is going to be displayed throws an error, because that attribute property does not belong to the {person} description, but the {person-view} description we saw before.

{}> (attribute-name (get-attribute {person} 'fullname))
FULLNAME
{}> (attribute-type (get-attribute {person} 'fullname))
#<Object =>STRING {1005A0A0A3}>
{}> (attribute-view (get-attribute {person} 'fullname))
;; Error

But if we ask the same to the {person-view} description, we can access to all the attributes properties.

{}> (attribute-name (get-attribute {person-view} 'fullname))
FULLNAME
{}> (attribute-type (get-attribute {person-view} 'fullname))
#<Object =>STRING {1005A0A0A3}>
{}> (attribute-view (get-attribute {person-view} 'fullname))
T

This makes the approach layered, with each description describing different aspects of the same model and extending other more basic descriptions.

Descriptions composition

As we mentioned before, descriptions can be composed on the fly thanks to the prototype object system the library is implemented in.

For example, we can create new descriptions with the make-description function, passing the descriptions we want to compose as parents:

(let ((description (make-description :parents
				     (list {person-validation} {person-repl-editing}))))
  (let ((person (make-instance 'person)))
      (edit-object person description)
      (validate-object person description)
      (describe person)))

A prettier way of doing it is using the description name as a function:

(let ((description ({person-validation} {person-repl-editing})))
    (let ((person (make-instance 'person)))
      (edit-object person description)
      (validate-object person description)
      (describe person)))

We can also choose not to compose descriptions, but work with them separately on the different aspects of the model objects:

(let ((person (make-instance 'person)))
  (edit-object person {person-repl-editing})
  (validate-object person {person-validation})
  (describe person)
  (print
   (with-output-to-string (s)
     (serialize-object person {person-serialization} s))))

Implementation

{} descriptions is implemented as a thin layer over Sheeple prototypes. As a consequence, descriptions and its attributes can be easily be combined in run time.

Why not just use metaclasses instead?

It is not possible to achieve quite the same with metaclasses. They do not allow to keep the metamodel independent of the actual implementation of the class. It should be possible to exchange descriptions on the fly, and even use multiple descriptions at the same time for the same underlying domain object.

Metaclasses have their own specific power though, and may be good to use them in combination with descriptions.

References

• http://code.google.com/p/magritte-metamodel/
• http://www.cliki.net/lisp-on-lines
• http://common-lisp.net/project/lisp-on-lines/repo/lisp-on-lines/doc/manual.html
• http://scg.unibe.ch/archive/papers/Reng07aMagritte.pdf

2 Systems

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

2.1 descriptions

Author

Mariano Montone

License

MIT

Description

A domain model meta level description library

Dependencies

• alexandria
• anaphora
• sheeple
• closer-mop

Source

descriptions.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 descriptions/src

Parent

descriptions (system)

Location

src/

Components

• package.lisp (file)
• descriptions.lisp (file)
• mop.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 descriptions.asd

Location

descriptions.asd

Systems

descriptions (system)

4.1.2 descriptions/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

descriptions

4.1.3 descriptions/src/descriptions.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/descriptions.lisp

Exported Definitions

• => (macro)
• =>boolean (function)
• =>email (function)
• =>integer (function)
• =>keyword (function)
• =>multiple-option (function)
• =>password (function)
• =>single-option (function)
• =>string (function)
• =>symbol (function)
• =>to-many-relation (function)
• =>to-one-relation (function)
• =>valued (function)
• =>view (function)
• add-attribute (function)
• attribute-documentation (function)
• attribute-properties (function)
• define-attribute (macro)
• define-description (macro)
• description-attributes (function)
• display-object (function)
• get-attribute (function)
• make-attribute (function)
• make-description (function)
• undefinedp (function)
• with-described-object (macro)
• with-description-attributes (macro)

Internal Definitions

• %undefined% (special variable)
• +undefined+ (symbol macro)
• =>option (function)
• =>reference (function)
• =>relation (function)
• copy-undefined (function)
• make-undefined (function)
• symbol->keyword (function)
• undefined (structure)
• undefined-p (function)

4.1.4 descriptions/src/mop.lisp

Dependency

descriptions.lisp (file)

Parent

src (module)

Location

src/mop.lisp

Exported Definitions

• default-description (method)
• (setf default-description) (method)
• default-description (method)
• (setf default-description) (method)
• define-described-class (macro)
• described-object (class)
• described-object-class (class)

Internal Definitions

• default-description-name (method)
• (setf default-description-name) (method)
• described-object-direct-slot-definition (class)
• described-object-effective-slot-definition (class)
• described-object-slot-mixin (class)
• described-p (method)
• described-p (method)
• (setf described-p) (method)
• described-slot-p (generic function)
• described-slot-p (method)
• described-slot-p (method)
• parent-descriptions (method)
• (setf parent-descriptions) (method)
• plist-keys (function)
• plist-values (function)
• slot-attribute (method)
• slot-attribute (method)
• (setf slot-attribute) (method)
• slot-attribute-name (method)

5 Packages

Packages are listed by definition order.

5.1 descriptions

Source

package.lisp (file)

Nicknames

• {}
• desc

Use List

• anaphora
• alexandria.1.0.0
• sheeple
• common-lisp

Exported Definitions

• => (special variable)
• => (macro)
• =>boolean (special variable)
• =>boolean (function)
• =>email (special variable)
• =>email (function)
• =>integer (special variable)
• =>integer (function)
• =>keyword (special variable)
• =>keyword (function)
• =>multiple-option (special variable)
• =>multiple-option (function)
• =>password (special variable)
• =>password (function)
• =>single-option (special variable)
• =>single-option (function)
• =>string (special variable)
• =>string (function)
• =>symbol (special variable)
• =>symbol (function)
• =>to-many-relation (special variable)
• =>to-many-relation (function)
• =>to-one-relation (special variable)
• =>to-one-relation (function)
• =>valued (special variable)
• =>valued (function)
• =>view (special variable)
• =>view (function)
• add-attribute (function)
• attribute-documentation (function)
• attribute-formatter (function)
• (setf attribute-formatter) (function)
• attribute-label (function)
• (setf attribute-label) (function)
• attribute-name (function)
• (setf attribute-name) (function)
• attribute-options (function)
• (setf attribute-options) (function)
• attribute-properties (function)
• attribute-reader (function)
• (setf attribute-reader) (function)
• attribute-reference (function)
• (setf attribute-reference) (function)
• attribute-serialize (function)
• (setf attribute-serialize) (function)
• attribute-sorted (function)
• (setf attribute-sorted) (function)
• attribute-sorter (function)
• (setf attribute-sorter) (function)
• attribute-type (function)
• (setf attribute-type) (function)
• attribute-undefinedp (function)
• attribute-value (function)
• (setf attribute-value) (function)
• attribute-view (function)
• (setf attribute-view) (function)
• attribute-writer (function)
• (setf attribute-writer) (function)
• default-description (generic function)
• default-description (method)
• (setf default-description) (method)
• default-description (method)
• (setf default-description) (method)
• (setf default-description) (generic function)
• define-attribute (macro)
• define-described-class (macro)
• define-description (macro)
• described-object (class)
• described-object-class (class)
• description-attributes (function)
• description-name (function)
• (setf description-name) (function)
• display-object (function)
• get-attribute (function)
• make-attribute (function)
• make-description (function)
• undefinedp (function)
• with-described-object (macro)
• with-description-attributes (macro)
• {description} (special variable)

Internal Definitions

• %undefined% (special variable)
• +undefined+ (symbol macro)
• =>option (special variable)
• =>option (function)
• =>reference (special variable)
• =>reference (function)
• =>relation (special variable)
• =>relation (function)
• copy-undefined (function)
• default-description-name (generic function)
• default-description-name (method)
• (setf default-description-name) (method)
• (setf default-description-name) (generic function)
• described-object-direct-slot-definition (class)
• described-object-effective-slot-definition (class)
• described-object-slot-mixin (class)
• described-p (generic function)
• described-p (method)
• described-p (method)
• (setf described-p) (method)
• (setf described-p) (generic function)
• described-slot-p (generic function)
• described-slot-p (method)
• described-slot-p (method)
• make-undefined (function)
• parent-descriptions (generic function)
• parent-descriptions (method)
• (setf parent-descriptions) (method)
• (setf parent-descriptions) (generic function)
• plist-keys (function)
• plist-values (function)
• slot-attribute (generic function)
• slot-attribute (method)
• slot-attribute (method)
• (setf slot-attribute) (method)
• (setf slot-attribute) (generic function)
• slot-attribute-name (generic function)
• slot-attribute-name (method)
• symbol->keyword (function)
• undefined (structure)
• undefined-p (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: =>

Package

descriptions

Special Variable: =>boolean

Boolean attribute

Package

descriptions

Special Variable: =>email

Email attribute

Package

descriptions

Special Variable: =>integer

Integer attribute

Package

descriptions

Special Variable: =>keyword

Keyword attribute

Package

descriptions

Special Variable: =>multiple-option

Package

descriptions

Special Variable: =>password

Password attribute

Package

descriptions

Special Variable: =>single-option

Package

descriptions

Special Variable: =>string

String attribute

Package

descriptions

Special Variable: =>symbol

Symbol attribute

Package

descriptions

Special Variable: =>to-many-relation

Package

descriptions

Special Variable: =>to-one-relation

Package

descriptions

Special Variable: =>valued

Package

descriptions

Special Variable: =>view

Package

descriptions

Special Variable: {description}

Package

descriptions

6.1.2 Macros

Macro: => TYPE-SPEC &rest PROPERTY-VALUES

Attribute builder macro

Package

descriptions

Source

descriptions.lisp (file)

Macro: define-attribute NAME PARENTS PROPERTIES &rest OPTIONS

Define an attribute type

:param name: the attribute type name.
:param parents: the attribute type parents. :param properties: list of properties.
:param options: options, like :documentation, etc

Package

descriptions

Source

descriptions.lisp (file)

Macro: define-described-class NAME DIRECT-SUPERCLASSES DIRECT-SLOTS &rest OPTIONS

Package

descriptions

Source

mop.lisp (file)

Macro: define-description NAME PARENTS ATTRIBUTES &rest OPTIONS

Define a new description

Package

descriptions

Source

descriptions.lisp (file)

Macro: with-described-object ATTRIBUTES (OBJECT &optional DESCRIPTION) &body BODY

Package

descriptions

Source

descriptions.lisp (file)

Macro: with-description-attributes ATTRIBUTES DESCRIPTION &body BODY

Run body with description attributes bound

Package

descriptions

Source

descriptions.lisp (file)

6.1.3 Functions

Function: =>boolean &rest PROPERTY-VALUES

Create a =>BOOLEAN attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: =>email &rest PROPERTY-VALUES

Create a =>EMAIL attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: =>integer &rest PROPERTY-VALUES

Create a =>INTEGER attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: =>keyword &rest PROPERTY-VALUES

Create a =>KEYWORD attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: =>multiple-option &rest PROPERTY-VALUES

Create a =>MULTIPLE-OPTION attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: =>password &rest PROPERTY-VALUES

Create a =>PASSWORD attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: =>single-option &rest PROPERTY-VALUES

Create a =>SINGLE-OPTION attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: =>string &rest PROPERTY-VALUES

Create a =>STRING attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: =>symbol &rest PROPERTY-VALUES

Create a =>SYMBOL attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: =>to-many-relation &rest PROPERTY-VALUES

Create a =>TO-MANY-RELATION attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: =>to-one-relation &rest PROPERTY-VALUES

Create a =>TO-ONE-RELATION attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: =>valued &rest PROPERTY-VALUES

Create a =>VALUED attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: =>view &rest PROPERTY-VALUES

Create a =>VIEW attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: add-attribute DESCRIPTION ATTRIBUTE &key READER WRITER ACCESSOR

Package

descriptions

Source

descriptions.lisp (file)

Function: attribute-documentation ATTRIBUTE

Package

descriptions

Source

descriptions.lisp (file)

Function: attribute-formatter &rest ARGS

Function: (setf attribute-formatter) &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: attribute-label &rest ARGS

Function: (setf attribute-label) &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: attribute-name &rest ARGS

Function: (setf attribute-name) &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: attribute-options &rest ARGS

Function: (setf attribute-options) &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: attribute-properties ATTRIBUTE

Package

descriptions

Source

descriptions.lisp (file)

Function: attribute-reader &rest ARGS

Function: (setf attribute-reader) &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: attribute-reference &rest ARGS

Function: (setf attribute-reference) &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: attribute-serialize &rest ARGS

Function: (setf attribute-serialize) &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: attribute-sorted &rest ARGS

Function: (setf attribute-sorted) &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: attribute-sorter &rest ARGS

Function: (setf attribute-sorter) &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: attribute-type &rest ARGS

Function: (setf attribute-type) &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: attribute-undefinedp &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: attribute-value &rest ARGS

Function: (setf attribute-value) &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: attribute-view &rest ARGS

Function: (setf attribute-view) &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: attribute-writer &rest ARGS

Function: (setf attribute-writer) &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: description-attributes DESCRIPTION

Obtain a description attributes. :param description: the description.

Package

descriptions

Source

descriptions.lisp (file)

Function: description-name &rest ARGS

Function: (setf description-name) &rest ARGS

Package

descriptions

Source

/home/quickref/quicklisp/dists/quicklisp/software/sheeple-20150302-git/src/messages.lisp

Function: display-object OBJECT &optional DESCRIPTION STREAM

Package

descriptions

Source

descriptions.lisp (file)

Function: get-attribute DESCRIPTION ATTRIBUTE-NAME

Package

descriptions

Source

descriptions.lisp (file)

Function: make-attribute ATTRIBUTE-TYPE &rest PROPERTY-VALUES

Create an attribute.

:param attribute-type: The attribute type :property-values: A plist of attribute properties values

Package

descriptions

Source

descriptions.lisp (file)

Function: make-description &key PARENTS ATTRIBUTES

Package

descriptions

Source

descriptions.lisp (file)

Function: undefinedp VALUE

Package

descriptions

Source

descriptions.lisp (file)

6.1.4 Generic functions

Generic Function: default-description OBJECT

Generic Function: (setf default-description) NEW-VALUE OBJECT

Package

descriptions

Methods

Method: default-description (DESCRIBED-OBJECT-CLASS described-object-class)

automatically generated reader method

Source

mop.lisp (file)

Method: (setf default-description) NEW-VALUE (DESCRIBED-OBJECT-CLASS described-object-class)

automatically generated writer method

Source

mop.lisp (file)

Method: default-description (DESCRIBED-OBJECT described-object)

automatically generated reader method

Source

mop.lisp (file)

Method: (setf default-description) NEW-VALUE (DESCRIBED-OBJECT described-object)

automatically generated writer method

Source

mop.lisp (file)

6.1.5 Classes

Class: described-object ()

Package

descriptions

Source

mop.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• shared-initialize (method)
• default-description-name (method)
• default-description-name (method)
• parent-descriptions (method)
• parent-descriptions (method)
• default-description (method)
• default-description (method)

Direct slots

Slot: default-description

Initargs

:default-description

Readers

default-description (generic function)

Writers

(setf default-description) (generic function)

Slot: parent-descriptions

Initargs

:parent-descriptions

Initform

(list descriptions:{description})

Readers

parent-descriptions (generic function)

Writers

(setf parent-descriptions) (generic function)

Slot: default-description-name

Initargs

:default-description-name

Readers

default-description-name (generic function)

Writers

(setf default-description-name) (generic function)

Class: described-object-class ()

Package

descriptions

Source

mop.lisp (file)

Direct superclasses

standard-class (class)

Direct methods

• shared-initialize (method)
• compute-effective-slot-definition (method)
• effective-slot-definition-class (method)
• direct-slot-definition-class (method)
• validate-superclass (method)
• default-description (method)
• default-description (method)

Direct slots

Slot: default-description

Initargs

:default-description

Readers

default-description (generic function)

Writers

(setf default-description) (generic function)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: %undefined%

Package

descriptions

Source

descriptions.lisp (file)

Special Variable: =>option

Package

descriptions

Special Variable: =>reference

Package

descriptions

Special Variable: =>relation

Package

descriptions

6.2.2 Symbol macros

Symbol Macro: +undefined+

Package

descriptions

Source

descriptions.lisp (file)

Expansion

descriptions::%undefined%

6.2.3 Functions

Function: =>option &rest PROPERTY-VALUES

Create a =>OPTION attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: =>reference &rest PROPERTY-VALUES

Create a =>REFERENCE attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: =>relation &rest PROPERTY-VALUES

Create a =>RELATION attribute. Takes a plist of property values for the created attribute

Package

descriptions

Source

descriptions.lisp (file)

Function: copy-undefined INSTANCE

Package

descriptions

Source

descriptions.lisp (file)

Function: make-undefined &key

Package

descriptions

Source

descriptions.lisp (file)

Function: plist-keys PLIST

Package

descriptions

Source

mop.lisp (file)

Function: plist-values PLIST

Package

descriptions

Source

mop.lisp (file)

Function: symbol->keyword SYMBOL

Package

descriptions

Source

descriptions.lisp (file)

Function: undefined-p OBJECT

Package

descriptions

Source

descriptions.lisp (file)

6.2.4 Generic functions

Generic Function: default-description-name OBJECT

Generic Function: (setf default-description-name) NEW-VALUE OBJECT

Package

descriptions

Methods

Method: default-description-name (DESCRIBED-OBJECT described-object)

automatically generated reader method

Source

mop.lisp (file)

Method: (setf default-description-name) NEW-VALUE (DESCRIBED-OBJECT described-object)

automatically generated writer method

Source

mop.lisp (file)

Generic Function: described-p OBJECT

Generic Function: (setf described-p) NEW-VALUE OBJECT

Package

descriptions

Methods

Method: described-p SLOT

Source

mop.lisp (file)

Method: described-p (DESCRIBED-OBJECT-SLOT-MIXIN described-object-slot-mixin)

automatically generated reader method

Source

mop.lisp (file)

Method: (setf described-p) NEW-VALUE (DESCRIBED-OBJECT-SLOT-MIXIN described-object-slot-mixin)

automatically generated writer method

Source

mop.lisp (file)

Generic Function: described-slot-p SLOT

Package

descriptions

Source

mop.lisp (file)

Methods

Method: described-slot-p SLOT

Method: described-slot-p (SLOT described-object-slot-mixin)

Generic Function: parent-descriptions OBJECT

Generic Function: (setf parent-descriptions) NEW-VALUE OBJECT

Package

descriptions

Methods

Method: parent-descriptions (DESCRIBED-OBJECT described-object)

automatically generated reader method

Source

mop.lisp (file)

Method: (setf parent-descriptions) NEW-VALUE (DESCRIBED-OBJECT described-object)

automatically generated writer method

Source

mop.lisp (file)

Generic Function: slot-attribute OBJECT

Generic Function: (setf slot-attribute) NEW-VALUE OBJECT

Package

descriptions

Methods

Method: slot-attribute SLOT

Source

mop.lisp (file)

Method: slot-attribute (DESCRIBED-OBJECT-SLOT-MIXIN described-object-slot-mixin)

automatically generated reader method

Source

mop.lisp (file)

Method: (setf slot-attribute) NEW-VALUE (DESCRIBED-OBJECT-SLOT-MIXIN described-object-slot-mixin)

automatically generated writer method

Source

mop.lisp (file)

Generic Function: slot-attribute-name SLOT

Package

descriptions

Methods

Method: slot-attribute-name SLOT

Source

mop.lisp (file)

6.2.5 Structures

Structure: undefined ()

Package

descriptions

Source

descriptions.lisp (file)

Direct superclasses

structure-object (structure)

6.2.6 Classes

Class: described-object-direct-slot-definition ()

Package

descriptions

Source

mop.lisp (file)

Direct superclasses

• standard-direct-slot-definition (class)
• described-object-slot-mixin (class)

Class: described-object-effective-slot-definition ()

Package

descriptions

Source

mop.lisp (file)

Direct superclasses

• standard-effective-slot-definition (class)
• described-object-slot-mixin (class)

Class: described-object-slot-mixin ()

Package

descriptions

Source

mop.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• described-object-direct-slot-definition (class)
• described-object-effective-slot-definition (class)

Direct methods

• described-slot-p (method)
• described-p (method)
• described-p (method)
• slot-attribute (method)
• slot-attribute (method)

Direct slots

Slot: attribute

Initargs

:attribute

Readers

slot-attribute (generic function)

Writers

(setf slot-attribute) (generic function)

Slot: described-p

Initargs

:described-p

Initform

t

Readers

described-p (generic function)

Writers

(setf described-p) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types