The clutter Reference Manual

Table of Contents

The clutter Reference Manual

This is the clutter Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:27:21 2022 GMT+0.

1 Introduction

Clutter

Annotations/decorators/attributes for CLOS classes and slots

Clutter is a library to allow us Lispers to, well, clutter our beautiful CLOS classes and their slots with additional information (attributes or, as they're called in other languages, annotations or decorators).

One may thus define a class like the following:

(defclass my-class (my-superclass)
  ((some-slot :attributes ((pretty-name . "My precious") (validator . #'valid-treasure-p))))
  (:attributes (pretty-name . "My class") (version . "1.1"))
  (:metaclass clutter:standard-class-with-attributes))

Then, we can query the class and slot for information about their attributes:

(attribute 'pretty-name 'my-class) => "My class"
(attribute 'pretty-name (slot 'some-slot 'my-class)) => "My precious"

attribute is also a SETFable place.

Note that attributes in subclasses can override attributes in superclasses.

Internally, attributes are stored in hash tables. However, for convenience, we provide them as alists in defclass forms.

Note that defclass doesn't evaluate the attributes. If they're not literal constants you have to set them programmatically with setf attribute.

Also note that effective attributes are computed by finalize-inheritance, which is invoked by the MOP at some point between the declaration of the class and the creation of its first instance. When in doubt, call finalize-inheritance manually to ensure that you can query and update attributes.

2 Systems

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

2.1 clutter

Author

Alessio Stalla

License

LGPL

Description

Cluttering classes and slots with annotations/decorators/attributes metadata

Version

1.0.0

Dependencies

• closer-mop
• doplus

Source

clutter.asd (file)

Component

src (module)

3 Modules

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

3.1 clutter/src

Parent

clutter (system)

Location

src/

Components

• packages.lisp (file)
• clutter.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 clutter.asd

Location

clutter.asd

Systems

clutter (system)

4.1.2 clutter/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

clutter

4.1.3 clutter/src/clutter.lisp

Parent

src (module)

Location

src/clutter.lisp

Exported Definitions

• -with-attributes (class)
• attribute (function)
• (setf attribute) (function)
• attributes-of (method)
• attributes-of (method)
• attributes-of (method)
• (setf attributes-of) (method)
• slot (function)
• standard-class-with-attributes (class)

Internal Definitions

• ancestors (method)
• attributes->hash-table (function)
• direct-slot-definition-with-attributes (class)
• effective-slot-definition-with-attributes (class)
• get-attribute (generic function)
• get-attribute (method)
• get-attribute (method)
• merge-attributes (function)
• merged-attributes (class)
• own-attributes (method)
• set-attribute (generic function)
• set-attribute (method)
• set-attribute (method)

5 Packages

Packages are listed by definition order.

5.1 clutter

Source

packages.lisp (file)

Use List

• doplus
• common-lisp

Exported Definitions

• -with-attributes (class)
• attribute (function)
• (setf attribute) (function)
• attributes-of (generic function)
• attributes-of (method)
• attributes-of (method)
• attributes-of (method)
• (setf attributes-of) (method)
• (setf attributes-of) (generic function)
• slot (function)
• standard-class-with-attributes (class)

Internal Definitions

• ancestors (generic function)
• ancestors (method)
• attributes->hash-table (function)
• direct-slot-definition-with-attributes (class)
• effective-slot-definition-with-attributes (class)
• get-attribute (generic function)
• get-attribute (method)
• get-attribute (method)
• merge-attributes (function)
• merged-attributes (class)
• own-attributes (generic function)
• own-attributes (method)
• set-attribute (generic function)
• set-attribute (method)
• set-attribute (method)

6 Definitions

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

6.1 Exported definitions

6.1.1 Functions

Function: attribute NAME ATTRIBUTED-ELEMENT

Function: (setf attribute) VALUE NAME ATTRIBUTED-ELEMENT

Package

clutter

Source

clutter.lisp (file)

Function: slot NAME CLASS

Package

clutter

Source

clutter.lisp (file)

6.1.2 Generic functions

Generic Function: attributes-of OBJECT

Generic Function: (setf attributes-of) NEW-VALUE OBJECT

Package

clutter

Methods

Method: attributes-of ANYTHING

Source

clutter.lisp (file)

Method: attributes-of (C symbol)

Source

clutter.lisp (file)

Method: attributes-of (-WITH-ATTRIBUTES -with-attributes)

automatically generated reader method

Source

clutter.lisp (file)

Method: (setf attributes-of) NEW-VALUE (-WITH-ATTRIBUTES -with-attributes)

automatically generated writer method

Source

clutter.lisp (file)

6.1.3 Classes

Class: -with-attributes ()

Mixin for elements that can have attributes

Package

clutter

Source

clutter.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• direct-slot-definition-with-attributes (class)
• effective-slot-definition-with-attributes (class)
• standard-class-with-attributes (class)

Direct methods

• finalize-inheritance (method)
• attributes-of (method)
• attributes-of (method)

Direct slots

Slot: attributes

Initargs

:attributes

Initform

(make-hash-table)

Readers

attributes-of (generic function)

Writers

(setf attributes-of) (generic function)

Class: standard-class-with-attributes ()

Package

clutter

Source

clutter.lisp (file)

Direct superclasses

• -with-attributes (class)
• standard-class (class)

Direct methods

• compute-effective-slot-definition (method)
• effective-slot-definition-class (method)
• direct-slot-definition-class (method)
• validate-superclass (method)

6.2 Internal definitions

6.2.1 Functions

Function: attributes->hash-table ATTRIBUTES

Package

clutter

Source

clutter.lisp (file)

Function: merge-attributes INSTANCE &rest ANCESTORS

Package

clutter

Source

clutter.lisp (file)

6.2.2 Generic functions

Generic Function: ancestors OBJECT

Package

clutter

Methods

Method: ancestors (MERGED-ATTRIBUTES merged-attributes)

automatically generated reader method

Source

clutter.lisp (file)

Generic Function: get-attribute MAP NAME

Package

clutter

Source

clutter.lisp (file)

Methods

Method: get-attribute (MAP merged-attributes) NAME

Method: get-attribute (MAP hash-table) NAME

Generic Function: own-attributes OBJECT

Package

clutter

Methods

Method: own-attributes (MERGED-ATTRIBUTES merged-attributes)

automatically generated reader method

Source

clutter.lisp (file)

Generic Function: set-attribute MAP NAME VALUE

Package

clutter

Source

clutter.lisp (file)

Methods

Method: set-attribute (MAP merged-attributes) NAME VALUE

Method: set-attribute (MAP hash-table) NAME VALUE

6.2.3 Classes

Class: direct-slot-definition-with-attributes ()

Package

clutter

Source

clutter.lisp (file)

Direct superclasses

• -with-attributes (class)
• standard-direct-slot-definition (class)

Class: effective-slot-definition-with-attributes ()

Package

clutter

Source

clutter.lisp (file)

Direct superclasses

• -with-attributes (class)
• standard-effective-slot-definition (class)

Class: merged-attributes ()

Package

clutter

Source

clutter.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• set-attribute (method)
• get-attribute (method)
• ancestors (method)
• own-attributes (method)

Direct slots

Slot: own-attributes

Initargs

:own

Readers

own-attributes (generic function)

Slot: ancestors

Initargs

:ancestors

Readers

ancestors (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types