The metap Reference Manual

Table of Contents

The metap Reference Manual

This is the metap Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:03:59 2021 GMT+0.

1 Introduction

Metap

Metap provides metaclass propagation along class inheritance structure. Metap uses closer-mop and changes

• c2mop:ensure-class-using-class :around class name &rest args

so it could conflicts with other library modifing same method.

Motivation

You got some idea which use metaclass like

(defclass some-meta-class (standard-class) ())
(defmethod something1 ((class some-meta-class) ...) ...)
(defmethod something2 ((class some-meta-class) ...) ...)

and use this for some classes like

(defclass some-class1 () () (:metaclass 'some-meta-class))
(defclass some-class2 (some-class1) () (:metaclass 'some-meta-class))
(defclass some-class3 (some-class2) () (:metaclass 'some-meta-class))
(defclass some-class4 (some-class1) () (:metaclass 'some-meta-class))
... :metaclass :metaclass :metaclass :metaclass

This is boring. Using metap, it can simply be written like

(defclass some-mixin () ())
(metap:register-m1-m2-pair 'some-mixin 'some-meta-class)

(defclass some-class1 (some-mixin) ())
(defclass some-class2 (some-class1) ())
(defclass some-class3 (some-class2) ())
(defclass some-class4 (some-class1) ())

Also see cl-singleton-mixin (https://github.com/hipeta/cl-singleton-mixin) which is written by using metap.

APIs

Variables

• *metap-m1-m2-pairs*

• All pairs registered in metap.

Functions

• register-m1-m2-pair (m1class m2class)

• Register m1class and m2class pair which you want to enable metaclass propagation.

Macros

• validate-superclass* (&body validations)

• Syntax sugar for c2mop:validate-superclass.

Installation

(ql:quickload :metap)

License

Metap is released under the MIT License, see LICENSE file.

2 Systems

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

2.1 metap

Author

hipeta

License

MIT

Description

Metap provides metaclass propagation along class inheritance structure.

Dependency

closer-mop

Source

metap.asd (file)

Component

metap.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 metap.asd

Location

metap.asd

Systems

metap (system)

3.1.2 metap/metap.lisp

Parent

metap (system)

Location

metap.lisp

Packages

metap

Exported Definitions

• *metap-m1-m2-pairs* (special variable)
• register-m1-m2-pair (function)
• validate-superclass* (macro)

Internal Definitions

compute-precedense-list (function)

4 Packages

Packages are listed by definition order.

4.1 metap

Source

metap.lisp (file)

Use List

common-lisp

Exported Definitions

• *metap-m1-m2-pairs* (special variable)
• register-m1-m2-pair (function)
• validate-superclass* (macro)

Internal Definitions

compute-precedense-list (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *metap-m1-m2-pairs*

Package

metap

Source

metap.lisp (file)

5.1.2 Macros

Macro: validate-superclass* &body VALIDATIONS

Package

metap

Source

metap.lisp (file)

5.1.3 Functions

Function: register-m1-m2-pair M1CLASS M2CLASS

Package

metap

Source

metap.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: compute-precedense-list DIRECT-SUPERCLASSES

Package

metap

Source

metap.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types