The defvariant Reference Manual

Table of Contents

The defvariant Reference Manual

This is the defvariant Reference Manual, version 1.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:56:25 2020 GMT+0.

1 Introduction

defvariant

Variants for Common Lisp (for ML nostalgics ?)

(defpackage :try-defvariant
  (:use :cl :defvariant))

(in-package :try-defvariant)

(defvariant btree
   (leaf)
   (node val left right))

=> MATCH-BTREE

(let ((my-tree
        (make-btree-node :val 42 
                         :left (make-btree-leaf) 
                         :right (make-btree-leaf))))
  (match-btree my-tree
        (leaf _ "leaf !")
        (node (v _ _) v)))

=> 42

See. defvariant.md for the whole story.

2 Systems

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

2.1 defvariant

Author

Frederic Peschanski (format nil <frederic~Apeschanski~Awork~Agmail~Acom>

License

BSD 2-Clause. See LICENSE.

Description

Variants in Common Lisp.

Version

1.1

Source

defvariant.asd (file)

Components

• package.lisp (file)
• defvariant.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 defvariant.asd

Location

defvariant.asd

Systems

defvariant (system)

3.1.2 defvariant/package.lisp

Parent

defvariant (system)

Location

package.lisp

Packages

defvariant

3.1.3 defvariant/defvariant.lisp

Dependency

package.lisp (file)

Parent

defvariant (system)

Location

defvariant.lisp

Exported Definitions

• defvariant (macro)
• match-error (condition)
• match-error-message (method)

Internal Definitions

• *example-enabled* (special variable)
• build-case-slots (function)
• build-case-struct (function)
• build-condition (function)
• build-dispatch (function)
• build-lambda-parameters (function)
• build-match-args (function)
• build-match-function (function)
• build-match-macro (function)
• build-structs (function)
• build-type-struct (function)
• example (macro)
• lets (macro)
• match-warning (condition)
• match-warning-message (method)
• stringify (function)
• symbolize (function)

4 Packages

Packages are listed by definition order.

4.1 defvariant

Source

package.lisp (file)

Nickname

variant

Use List

common-lisp

Exported Definitions

• defvariant (macro)
• match-error (condition)
• match-error-message (generic function)
• match-error-message (method)

Internal Definitions

• *example-enabled* (special variable)
• build-case-slots (function)
• build-case-struct (function)
• build-condition (function)
• build-dispatch (function)
• build-lambda-parameters (function)
• build-match-args (function)
• build-match-function (function)
• build-match-macro (function)
• build-structs (function)
• build-type-struct (function)
• example (macro)
• lets (macro)
• match-warning (condition)
• match-warning-message (generic function)
• match-warning-message (method)
• stringify (function)
• symbolize (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: defvariant VARIANT &body VARIANT-CASES

Package

defvariant

Source

defvariant.lisp (file)

5.1.2 Generic functions

Generic Function: match-error-message CONDITION

Package

defvariant

Methods

Method: match-error-message (CONDITION match-error)

Source

defvariant.lisp (file)

5.1.3 Conditions

Condition: match-error ()

Package

defvariant

Source

defvariant.lisp (file)

Direct superclasses

error (condition)

Direct methods

match-error-message (method)

Direct slots

Slot: message

Initargs

:message

Readers

match-error-message (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *example-enabled*

Parameter for enabling/disabling
the ‘EXAMPLE‘ macro. Use NIL in production code.

Package

defvariant

Source

defvariant.lisp (file)

5.2.2 Macros

Macro: example EXPR ARROW EXPECTED &key EQ? WARN-ONLY

Show an evaluation example, useful for documentation and lightweight testing.

(example ‘EXPR‘ => ‘EXPECTED‘) evaluates ‘EXPR‘ and compare, wrt. ‘EQ?‘ (EQUAL by default) to ‘EXPECTED‘ and raise an error if inequal.

Set ‘WARN-ONLY‘ to T for warning instead of error.

Package

defvariant

Source

defvariant.lisp (file)

Macro: lets BINDERS EXPR &body BODY

An abbreviation for MULTIPLE-VALUE-BIND.

Package

defvariant

Source

defvariant.lisp (file)

5.2.3 Functions

Function: build-case-slots CASE-ID VARIANT-CASES

Package

defvariant

Source

defvariant.lisp (file)

Function: build-case-struct VARIANT CASE-LBL OPTS CASE-VALS

Package

defvariant

Source

defvariant.lisp (file)

Function: build-condition VARIANT CASE-ID VAL

Package

defvariant

Source

defvariant.lisp (file)

Function: build-dispatch VARIANT VARIANT-CASES MATCH-CASES VAL

Package

defvariant

Source

defvariant.lisp (file)

Function: build-lambda-parameters PARAMS BODY

Package

defvariant

Source

defvariant.lisp (file)

Function: build-match-args VARIANT CASE CASE-SLOTS VAL

Package

defvariant

Source

defvariant.lisp (file)

Function: build-match-function CASE-SPEC

Package

defvariant

Source

defvariant.lisp (file)

Function: build-match-macro VARIANT VARIANT-CASES

Package

defvariant

Source

defvariant.lisp (file)

Function: build-structs VARIANT OPTS CASES

Package

defvariant

Source

defvariant.lisp (file)

Function: build-type-struct VARIANT OPTS

Package

defvariant

Source

defvariant.lisp (file)

Function: stringify &rest ARGS

Converts to a string and append all ‘ARGS‘.

Package

defvariant

Source

defvariant.lisp (file)

Function: symbolize &rest ARGS

Converts to a string, append and create a symbol from the result.

Package

defvariant

Source

defvariant.lisp (file)

5.2.4 Generic functions

Generic Function: match-warning-message CONDITION

Package

defvariant

Methods

Method: match-warning-message (CONDITION match-warning)

Source

defvariant.lisp (file)

5.2.5 Conditions

Condition: match-warning ()

Package

defvariant

Source

defvariant.lisp (file)

Direct superclasses

warning (condition)

Direct methods

match-warning-message (method)

Direct slots

Slot: message

Initargs

:message

Readers

match-warning-message (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types