The toadstool Reference Manual

Table of Contents

The toadstool Reference Manual

This is the toadstool Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:40:21 2018 GMT+0.

1 Introduction

Toadstool

Toadstool is a library for pattern matching. The author is Stanisław Halik, and it is released to the public domain.

Toadstool has been criticized for having an unlispy syntax, but that concern appears to have been rectified.

The Git repository is at http://tehran.lain.pl/git/toadstool (browse it).

A mirror at github is at https://github.com/kisp/toadstool.

2 Systems

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

2.1 toadstool

Author

Stanislaw Halik

License

MIT/X11

Description

Pattern matcher

Dependencies

• closer-mop
• sb-cltl2

Source

toadstool.asd (file)

Components

• packages.lisp (file)
• utils.lisp (file)
• core.lisp (file)
• destructuring.lisp (file)
• forms.lisp (file)
• variables.lisp (file)
• api.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 toadstool.asd

Location

toadstool.asd

Systems

toadstool (system)

3.1.2 toadstool/packages.lisp

Parent

toadstool (system)

Location

packages.lisp

Packages

• toadstool
• toadstool-impl
• toadstool-system
• toadstool-utils

3.1.3 toadstool/utils.lisp

Dependency

packages.lisp (file)

Parent

toadstool (system)

Location

utils.lisp

Exported Definitions

• defcomponent (macro)
• extract-prefix (function)
• fmt (function)
• gensym? (function)
• if-matches (macro)
• mappend (function)
• mklist (function)
• partition (function)
• rec (macro)
• remove-from-plist (function)
• thunk (macro)
• with-gensyms (macro)

3.1.4 toadstool/core.lisp

Dependency

utils.lisp (file)

Parent

toadstool (system)

Location

core.lisp

Exported Definitions

• *toplevel-syms* (special variable)
• *used-components* (special variable)
• *using-k-once?* (special variable)
• component (class)
• component-mixin (class)
• defexpand (macro)
• definit (macro)
• effective-inner-forms-of (function)
• else-expr-of (method)
• equality (macro)
• expand-form (generic function)
• expand-form (method)
• expand-form (method)
• expand-nesting (generic function)
• find-form-expr (function)
• find-sequence-form (function)
• form (class)
• form-of (method)
• if-expr-of (method)
• inner-forms-of (method)
• k (macro)
• k-once (macro)
• macro-mixin (class)
• mapc/forms (function)
• matches? (generic function)
• matches? (method)
• matches? (method)
• mkform (function)
• name-of (generic function)
• name-of (method)
• nesting (class)
• operator (class)
• outer-form-of (method)
• sequence-mixin (class)
• toplevel-expansion (function)
• with-end-nesting (macro)

Internal Definitions

• %mkform (function)
• *end-nestings* (special variable)
• *inner-forms* (special variable)
• *outer-form* (special variable)
• *toplevel-patterns* (special variable)
• *trace* (special variable)
• +nesting-keyword-list+ (special variable)
• call/end-nestings (function)
• call/nestings (function)
• coerce-to-obj (generic function)
• coerce-to-obj (method)
• coerce-to-obj (method)
• coerce-to-obj (method)
• component? (function)
• components (function)
• define-predicate (macro)
• form-arguments (generic function)
• form-arguments (method)
• form-arguments (method)
• form? (function)
• nesting? (function)
• operator? (function)
• sequence-mixin? (function)
• with-root-mixins (macro)

3.1.5 toadstool/destructuring.lisp

Dependency

core.lisp (file)

Parent

toadstool (system)

Location

destructuring.lisp

Exported Definitions

• destructuring-mixin (class)
• sequence-cdr-state (method)
• sequence-endp (method)
• sequence-get-state (method)
• sequence-initial-state (method)
• sequence-item (method)
• sequence-set-state (method)

3.1.6 toadstool/forms.lisp

Dependency

destructuring.lisp (file)

Parent

toadstool (system)

Location

forms.lisp

Exported Definitions

• *-form (class)
• *default-components* (special variable)
• +-form (class)
• <-form (class)
• <=-form (class)
• >-form (class)
• >=-form (class)
• and-form (class)
• assoc-form (class)
• assoc-key (method)
• assoc-test (method)
• assoc-value (method)
• char-form (class)
• class-form (class)
• cons-form (class)
• debug-mixin (class)
• eql-form (class)
• equal-form (class)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• list*-form (class)
• list-form (class)
• literal-form (class)
• matches? (method)
• matches? (method)
• not-form (class)
• or-form (class)
• quote-form (class)
• satisfies-form (class)
• sequence-cdr-state (method)
• sequence-cdr-state (method)
• sequence-endp (method)
• sequence-endp (method)
• sequence-get-state (method)
• sequence-get-state (method)
• sequence-initial-state (method)
• sequence-initial-state (method)
• sequence-item (method)
• sequence-item (method)
• sequence-set-state (method)
• sequence-set-state (method)
• string-form (class)
• t-form (class)
• typep-form (class)
• vector-form (class)
• vector-rest-form (class)
• with-accessors-form (class)

Internal Definitions

• *debug-nesting-level* (special variable)
• car-of (method)
• cases-of (method)
• cdr-of (method)
• cdr-state-of (method)
• coerce-to-character-list (generic function)
• coerce-to-character-list (method)
• coerce-to-character-list (method)
• coerce-to-character-list (method)
• comparison-operator (class)
• constant-value (type)
• datum-of (method)
• datum-of (method)
• datum-of (method)
• debug-print (function)
• destructure-form (function)
• destructuring-loop (function)
• destructuring-of (method)
• destructuring-of (method)
• elt-count-of (method)
• elt-of (method)
• elt-of (method)
• forms-of (method)
• forms-of (method)
• forms-of (method)
• forms-of (method)
• forms-of (method)
• forms-of (method)
• forms-of (method)
• function-expr-of (method)
• functions-of (method)
• greedy-of (method)
• greedy-of (method)
• index-sym-of (method)
• index-sym-of (method)
• index-sym2-of (method)
• len-name-of (method)
• len-name-of (method)
• lisp-expr-of (method)
• rest-of (method)
• type-of* (method)
• vec-name-of (method)
• vec-name-of (method)

3.1.7 toadstool/variables.lisp

Dependency

forms.lisp (file)

Parent

toadstool (system)

Location

variables.lisp

Exported Definitions

• expand-form (method)
• expand-form (method)
• expand-nesting (method)
• expand-nesting (method)
• matches? (method)
• name-of (method)
• push-form (class)
• push-nesting (class)
• variable-form (class)
• variable-nesting (class)

Internal Definitions

• *variable-alist* (special variable)
• +nil+ (special variable)
• has-outer-destructuring? (function)
• inside-k-once? (function)
• matcher-variable (type)
• previous-of (method)
• (setf previous-of) (method)
• using-k-once-of (method)
• (setf using-k-once-of) (method)
• var-checked-every-time? (function)
• var-of (method)

3.1.8 toadstool/api.lisp

Dependency

variables.lisp (file)

Parent

toadstool (system)

Location

api.lisp

Exported Definitions

• expand-form (method)
• name-of (method)
• partial-pattern-error (condition)
• toad-case (macro)
• toad-case1 (macro)
• toad-ccase (macro)
• toad-ccase1 (macro)
• toad-ecase (macro)
• toad-ecase1 (macro)
• toad-macrolet (macro)

Internal Definitions

• %toad-case (function)
• expansion-of (method)
• exprs-of (method)
• function-of (method)
• macrolet-form (class)
• make-macrolet-class (function)
• partial-cerror (function)
• partial-error (function)
• patterns-of (method)

4 Packages

Packages are listed by definition order.

4.1 toadstool

Source

packages.lisp (file)

Use List

• toadstool-utils
• toadstool-system
• toadstool-impl
• common-lisp

Exported Definitions

• partial-pattern-error (condition)
• toad-case (macro)
• toad-case1 (macro)
• toad-ccase (macro)
• toad-ccase1 (macro)
• toad-ecase (macro)
• toad-ecase1 (macro)
• toad-macrolet (macro)

Internal Definitions

• %toad-case (function)
• expansion-of (generic function)
• expansion-of (method)
• exprs-of (generic function)
• exprs-of (method)
• function-of (generic function)
• function-of (method)
• macrolet-form (class)
• make-macrolet-class (function)
• partial-cerror (function)
• partial-error (function)
• patterns-of (generic function)
• patterns-of (method)

4.2 toadstool-impl

Source

packages.lisp (file)

Use List

• toadstool-utils
• toadstool-system
• common-lisp

Used By List

toadstool

Exported Definitions

• *-form (class)
• +-form (class)
• <-form (class)
• <=-form (class)
• >-form (class)
• >=-form (class)
• and-form (class)
• assoc-form (class)
• assoc-key (generic function)
• assoc-key (method)
• assoc-test (generic function)
• assoc-test (method)
• assoc-value (generic function)
• assoc-value (method)
• char-form (class)
• class-form (class)
• cons-form (class)
• eql-form (class)
• equal-form (class)
• list*-form (class)
• list-form (class)
• literal-form (class)
• not-form (class)
• or-form (class)
• push-form (class)
• push-nesting (class)
• quote-form (class)
• satisfies-form (class)
• string-form (class)
• t-form (class)
• typep-form (class)
• variable-form (class)
• variable-nesting (class)
• vector-form (class)
• vector-rest-form (class)
• with-accessors-form (class)

Internal Definitions

• *debug-nesting-level* (special variable)
• *variable-alist* (special variable)
• +nil+ (special variable)
• car-of (generic function)
• car-of (method)
• cases-of (generic function)
• cases-of (method)
• cdr-of (generic function)
• cdr-of (method)
• cdr-state-of (generic function)
• cdr-state-of (method)
• coerce-to-character-list (generic function)
• coerce-to-character-list (method)
• coerce-to-character-list (method)
• coerce-to-character-list (method)
• comparison-operator (class)
• constant-value (type)
• datum-of (generic function)
• datum-of (method)
• datum-of (method)
• datum-of (method)
• debug-print (function)
• destructure-form (function)
• destructuring-loop (function)
• destructuring-of (generic function)
• destructuring-of (method)
• destructuring-of (method)
• elt-count-of (generic function)
• elt-count-of (method)
• elt-of (generic function)
• elt-of (method)
• elt-of (method)
• forms-of (generic function)
• forms-of (method)
• forms-of (method)
• forms-of (method)
• forms-of (method)
• forms-of (method)
• forms-of (method)
• forms-of (method)
• function-expr-of (generic function)
• function-expr-of (method)
• functions-of (generic function)
• functions-of (method)
• greedy-of (generic function)
• greedy-of (method)
• greedy-of (method)
• has-outer-destructuring? (function)
• index-sym-of (generic function)
• index-sym-of (method)
• index-sym-of (method)
• index-sym2-of (generic function)
• index-sym2-of (method)
• inside-k-once? (function)
• len-name-of (generic function)
• len-name-of (method)
• len-name-of (method)
• lisp-expr-of (generic function)
• lisp-expr-of (method)
• matcher-variable (type)
• previous-of (generic function)
• previous-of (method)
• (setf previous-of) (method)
• (setf previous-of) (generic function)
• rest-of (generic function)
• rest-of (method)
• type-of* (generic function)
• type-of* (method)
• using-k-once-of (generic function)
• using-k-once-of (method)
• (setf using-k-once-of) (method)
• (setf using-k-once-of) (generic function)
• var-checked-every-time? (function)
• var-of (generic function)
• var-of (method)
• vec-name-of (generic function)
• vec-name-of (method)
• vec-name-of (method)

4.3 toadstool-system

Source

packages.lisp (file)

Use List

• toadstool-utils
• common-lisp

Used By List

• toadstool
• toadstool-impl

Exported Definitions

• *default-components* (special variable)
• *toplevel-syms* (special variable)
• *used-components* (special variable)
• *using-k-once?* (special variable)
• component (class)
• component-mixin (class)
• debug-mixin (class)
• defexpand (macro)
• definit (macro)
• destructuring-mixin (class)
• effective-inner-forms-of (function)
• else-expr-of (generic function)
• else-expr-of (method)
• equality (macro)
• expand-form (generic function)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-form (method)
• expand-nesting (generic function)
• expand-nesting (method)
• expand-nesting (method)
• find-form-expr (function)
• find-sequence-form (function)
• form (class)
• form-of (generic function)
• form-of (method)
• if-expr-of (generic function)
• if-expr-of (method)
• inner-forms-of (generic function)
• inner-forms-of (method)
• k (macro)
• k-once (macro)
• macro-mixin (class)
• mapc/forms (function)
• matches? (generic function)
• matches? (method)
• matches? (method)
• matches? (method)
• matches? (method)
• matches? (method)
• mkform (function)
• name-of (generic function)
• name-of (method)
• name-of (method)
• name-of (method)
• nesting (class)
• operator (class)
• outer-form-of (generic function)
• outer-form-of (method)
• sequence-cdr-state (generic function)
• sequence-cdr-state (method)
• sequence-cdr-state (method)
• sequence-cdr-state (method)
• sequence-endp (generic function)
• sequence-endp (method)
• sequence-endp (method)
• sequence-endp (method)
• sequence-get-state (generic function)
• sequence-get-state (method)
• sequence-get-state (method)
• sequence-get-state (method)
• sequence-initial-state (generic function)
• sequence-initial-state (method)
• sequence-initial-state (method)
• sequence-initial-state (method)
• sequence-item (generic function)
• sequence-item (method)
• sequence-item (method)
• sequence-item (method)
• sequence-mixin (class)
• sequence-set-state (generic function)
• sequence-set-state (method)
• sequence-set-state (method)
• sequence-set-state (method)
• toplevel-expansion (function)
• with-end-nesting (macro)

Internal Definitions

• %mkform (function)
• *end-nestings* (special variable)
• *inner-forms* (special variable)
• *outer-form* (special variable)
• *toplevel-patterns* (special variable)
• *trace* (special variable)
• +nesting-keyword-list+ (special variable)
• call/end-nestings (function)
• call/nestings (function)
• coerce-to-obj (generic function)
• coerce-to-obj (method)
• coerce-to-obj (method)
• coerce-to-obj (method)
• component? (function)
• components (function)
• define-predicate (macro)
• form-arguments (generic function)
• form-arguments (method)
• form-arguments (method)
• form? (function)
• nesting? (function)
• operator? (function)
• sequence-mixin? (function)
• with-root-mixins (macro)

4.4 toadstool-utils

Source

packages.lisp (file)

Use List

common-lisp

Used By List

• toadstool
• toadstool-impl
• toadstool-system

Exported Definitions

• defcomponent (macro)
• extract-prefix (function)
• fmt (function)
• gensym? (function)
• if-matches (macro)
• mappend (function)
• mklist (function)
• partition (function)
• rec (macro)
• remove-from-plist (function)
• thunk (macro)
• with-gensyms (macro)

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: *default-components*

Package

toadstool-system

Source

forms.lisp (file)

Special Variable: *toplevel-syms*

Package

toadstool-system

Source

core.lisp (file)

Special Variable: *used-components*

Package

toadstool-system

Source

core.lisp (file)

Special Variable: *using-k-once?*

Package

toadstool-system

Source

core.lisp (file)

5.1.2 Macros

Macro: defcomponent NAME SUPERS &body OPTIONS

Package

toadstool-utils

Source

utils.lisp (file)

Macro: defexpand NAME DLIST &body BODY

Package

toadstool-system

Source

core.lisp (file)

Macro: definit CLASS DLIST &body BODY

Package

toadstool-system

Source

core.lisp (file)

Macro: equality X Y

Package

toadstool-system

Source

core.lisp (file)

Macro: if-matches TEST K

Package

toadstool-utils

Source

utils.lisp (file)

Macro: k &body BODY

Package

toadstool-system

Source

core.lisp (file)

Macro: k-once K &body BODY

Package

toadstool-system

Source

core.lisp (file)

Macro: rec NAME (&rest VARS) &body BODY

Package

toadstool-utils

Source

utils.lisp (file)

Macro: thunk FORM

Package

toadstool-utils

Source

utils.lisp (file)

Macro: toad-case EXPRS &body CASES

Package

toadstool

Source

api.lisp (file)

Macro: toad-case1 EXPR &body CASES

Package

toadstool

Source

api.lisp (file)

Macro: toad-ccase EXPRS &body CASES

Package

toadstool

Source

api.lisp (file)

Macro: toad-ccase1 EXPR &body CASES

Package

toadstool

Source

api.lisp (file)

Macro: toad-ecase EXPRS &body CASES

Package

toadstool

Source

api.lisp (file)

Macro: toad-ecase1 EXPR &body CASES

Package

toadstool

Source

api.lisp (file)

Macro: toad-macrolet BINDINGS &body BODY

Package

toadstool

Source

api.lisp (file)

Macro: with-end-nesting ((IF-EXPR ELSE-EXPR K) &body NESTING-BODY) &body BODY

Package

toadstool-system

Source

core.lisp (file)

Macro: with-gensyms (&rest SYMS) &body BODY

Package

toadstool-utils

Source

utils.lisp (file)

5.1.3 Functions

Function: effective-inner-forms-of C

Package

toadstool-system

Source

core.lisp (file)

Function: extract-prefix SYM SUFFIX

Package

toadstool-utils

Source

utils.lisp (file)

Function: find-form-expr FORM

Package

toadstool-system

Source

core.lisp (file)

Function: find-sequence-form F

Package

toadstool-system

Source

core.lisp (file)

Function: fmt CONTROL &rest STUFF

Package

toadstool-utils

Source

utils.lisp (file)

Function: gensym? X

Package

toadstool-utils

Source

utils.lisp (file)

Function: mapc/forms FN

Package

toadstool-system

Source

core.lisp (file)

Function: mappend FN LIST &rest MORE-LISTS

Package

toadstool-utils

Source

utils.lisp (file)

Function: mkform DATUM

Instantiate a form basing on DATUM with component subtype TYPE.

Package

toadstool-system

Source

core.lisp (file)

Function: mklist X

Package

toadstool-utils

Source

utils.lisp (file)

Function: partition FN LIST &key KEY

Package

toadstool-utils

Source

utils.lisp (file)

Function: remove-from-plist PLIST TO-REMOVE

Package

toadstool-utils

Source

utils.lisp (file)

Function: toplevel-expansion BLOCK-NAME PATTERNS EXPRS GUARD IF-EXPR ELSE-EXPR

Package

toadstool-system

Source

core.lisp (file)

5.1.4 Generic functions

Generic Function: assoc-key C KEY

Package

toadstool-impl

Methods

Method: assoc-key (C assoc-form) KEY

Source

forms.lisp (file)

Generic Function: assoc-test C

Package

toadstool-impl

Methods

Method: assoc-test (C assoc-form)

Source

forms.lisp (file)

Generic Function: assoc-value C

Package

toadstool-impl

Methods

Method: assoc-value (C assoc-form)

Source

forms.lisp (file)

Generic Function: else-expr-of OBJECT

Package

toadstool-system

Methods

Method: else-expr-of (NESTING nesting)

automatically generated reader method

Source

core.lisp (file)

Generic Function: expand-form FORM EXPRESSION K

Generate an expansion of a pattern element

Package

toadstool-system

Source

core.lisp (file)

Methods

Method: expand-form (C macrolet-form) EXPR K

Source

api.lisp (file)

Method: expand-form (C push-form) EXPR K

Source

variables.lisp (file)

Method: expand-form (C variable-form) EXPR K

Source

variables.lisp (file)

Method: expand-form (C char-form) EXPR2 K

Source

forms.lisp (file)

Method: expand-form (C debug-mixin) EXPR K around

Source

forms.lisp (file)

Method: expand-form (C assoc-form) EXPR K

Source

forms.lisp (file)

Method: expand-form (C eql-form) EXPR K

Source

forms.lisp (file)

Method: expand-form (C comparison-operator) EXPR K

Source

forms.lisp (file)

Method: expand-form (C with-accessors-form) EXPR K

Source

forms.lisp (file)

Method: expand-form (C vector-form) EXPR K

Source

forms.lisp (file)

Method: expand-form (C vector-rest-form) EXPR K

Source

forms.lisp (file)

Method: expand-form (C +-form) EXPR2 K

Source

forms.lisp (file)

Method: expand-form (C t-form) EXPR K

Source

forms.lisp (file)

Method: expand-form (C *-form) EXPR2 K

Source

forms.lisp (file)

Method: expand-form (C cons-form) EXPR K

Source

forms.lisp (file)

Method: expand-form (C quote-form) EXPR K

Source

forms.lisp (file)

Method: expand-form (C or-form) EXPR K

Source

forms.lisp (file)

Method: expand-form (C and-form) EXPR K

Source

forms.lisp (file)

Method: expand-form (C not-form) EXPR K

Source

forms.lisp (file)

Method: expand-form (C satisfies-form) EXPR K

Source

forms.lisp (file)

Method: expand-form (C typep-form) EXPR K

Source

forms.lisp (file)

Method: expand-form (C literal-form) EXPR K

Source

forms.lisp (file)

Method: expand-form (C macro-mixin) EXPR K

Method: expand-form (F form) EXPRESSION K around

Generic Function: expand-nesting OBJ K

Package

toadstool-system

Source

core.lisp (file)

Methods

Method: expand-nesting (C push-nesting) K

Source

variables.lisp (file)

Method: expand-nesting (C variable-nesting) K

Source

variables.lisp (file)

Generic Function: form-of OBJECT

Package

toadstool-system

Methods

Method: form-of (FORM form)

automatically generated reader method

Source

core.lisp (file)

Generic Function: if-expr-of OBJECT

Package

toadstool-system

Methods

Method: if-expr-of (NESTING nesting)

automatically generated reader method

Source

core.lisp (file)

Generic Function: inner-forms-of OBJECT

Package

toadstool-system

Methods

Method: inner-forms-of (FORM form)

automatically generated reader method

Source

core.lisp (file)

Generic Function: matches? COMPONENT DATUM

Decide whether component can operate on given value

Package

toadstool-system

Source

core.lisp (file)

Methods

Method: matches? (C variable-form) DATUM

Source

variables.lisp (file)

Method: matches? (C t-form) DATUM

Source

forms.lisp (file)

Method: matches? (C literal-form) DATUM

Source

forms.lisp (file)

Method: matches? (C component) DATUM

Method: matches? (O operator) DATUM

Generic Function: name-of COMPONENT

Package

toadstool-system

Source

core.lisp (file)

Methods

Method: name-of (MACROLET-FORM macrolet-form)

automatically generated reader method

Source

api.lisp (file)

Method: name-of (VARIABLE-FORM variable-form)

automatically generated reader method

Source

variables.lisp (file)

Method: name-of (C operator)

Generic Function: outer-form-of OBJECT

Package

toadstool-system

Methods

Method: outer-form-of (FORM form)

automatically generated reader method

Source

core.lisp (file)

Generic Function: sequence-cdr-state F STATE

Package

toadstool-system

Methods

Method: sequence-cdr-state (F vector-rest-form) STATE

Source

forms.lisp (file)

Method: sequence-cdr-state (F cons-form) STATE

Source

forms.lisp (file)

Method: sequence-cdr-state (F destructuring-mixin) STATE

Source

destructuring.lisp (file)

Generic Function: sequence-endp F STATE

Package

toadstool-system

Methods

Method: sequence-endp (F vector-rest-form) STATE

Source

forms.lisp (file)

Method: sequence-endp (F cons-form) STATE

Source

forms.lisp (file)

Method: sequence-endp (F destructuring-mixin) STATE

Source

destructuring.lisp (file)

Generic Function: sequence-get-state F

Package

toadstool-system

Methods

Method: sequence-get-state (F vector-rest-form)

Source

forms.lisp (file)

Method: sequence-get-state (F cons-form)

Source

forms.lisp (file)

Method: sequence-get-state (F destructuring-mixin)

Source

destructuring.lisp (file)

Generic Function: sequence-initial-state F EXPR

Package

toadstool-system

Methods

Method: sequence-initial-state (F vector-rest-form) EXPR

Source

forms.lisp (file)

Method: sequence-initial-state (F cons-form) EXPR

Source

forms.lisp (file)

Method: sequence-initial-state (F destructuring-mixin) EXPR

Source

destructuring.lisp (file)

Generic Function: sequence-item F STATE

Package

toadstool-system

Methods

Method: sequence-item (F vector-rest-form) STATE

Source

forms.lisp (file)

Method: sequence-item (F cons-form) STATE

Source

forms.lisp (file)

Method: sequence-item (F destructuring-mixin) STATE

Source

destructuring.lisp (file)

Generic Function: sequence-set-state F STATE

Package

toadstool-system

Methods

Method: sequence-set-state (F vector-rest-form) STATE

Source

forms.lisp (file)

Method: sequence-set-state (F cons-form) STATE

Source

forms.lisp (file)

Method: sequence-set-state (F destructuring-mixin) STATE

Source

destructuring.lisp (file)

5.1.5 Conditions

Condition: partial-pattern-error ()

Package

toadstool

Source

api.lisp (file)

Direct superclasses

error (condition)

Direct methods

• exprs-of (method)
• patterns-of (method)

Direct slots

Slot: patterns

Initargs

:patterns

Readers

patterns-of (generic function)

Slot: exprs

Initargs

:exprs

Readers

exprs-of (generic function)

5.1.6 Classes

Class: *-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

• destructuring-mixin (class)
• operator (class)

Direct methods

• expand-form (method)
• initialize-instance (method)
• greedy-of (method)
• forms-of (method)

Direct slots

Slot: forms

Initargs

:forms

Readers

forms-of (generic function)

Slot: greedy?

Initargs

:greedy?

Initform

t

Readers

greedy-of (generic function)

Class: +-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

• destructuring-mixin (class)
• operator (class)

Direct methods

• expand-form (method)
• initialize-instance (method)
• greedy-of (method)
• forms-of (method)

Direct slots

Slot: forms

Initargs

:forms

Readers

forms-of (generic function)

Slot: greedy?

Initargs

:greedy?

Initform

t

Readers

greedy-of (generic function)

Class: <-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

comparison-operator (class)

Class: <=-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

comparison-operator (class)

Class: >-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

comparison-operator (class)

Class: >=-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

comparison-operator (class)

Class: and-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

operator (class)

Direct methods

• expand-form (method)
• initialize-instance (method)
• forms-of (method)

Direct slots

Slot: forms

Initargs

:forms

Readers

forms-of (generic function)

Class: assoc-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

operator (class)

Direct methods

• expand-form (method)
• assoc-test (method)
• assoc-key (method)
• assoc-value (method)
• initialize-instance (method)
• forms-of (method)
• cases-of (method)

Direct slots

Slot: cases

Initargs

:cases

Readers

cases-of (generic function)

Slot: forms

Initargs

:forms

Readers

forms-of (generic function)

Class: char-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

• destructuring-mixin (class)
• operator (class)

Direct methods

• expand-form (method)
• initialize-instance (method)
• forms-of (method)

Direct slots

Slot: forms

Initargs

:forms

Readers

forms-of (generic function)

Class: class-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

• macro-mixin (class)
• operator (class)

Direct methods

initialize-instance (method)

Class: component ()

Package

toadstool-system

Source

core.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• form (class)
• nesting (class)

Direct methods

• matches? (method)
• coerce-to-obj (method)

Class: component-mixin ()

Package

toadstool-system

Source

core.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

debug-mixin (class)

Class: cons-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

• sequence-mixin (class)
• operator (class)

Direct methods

• sequence-get-state (method)
• sequence-set-state (method)
• sequence-item (method)
• sequence-endp (method)
• sequence-cdr-state (method)
• sequence-initial-state (method)
• expand-form (method)
• initialize-instance (method)
• cdr-state-of (method)
• cdr-of (method)
• car-of (method)

Direct slots

Slot: car

Initargs

:car

Readers

car-of (generic function)

Slot: cdr

Initargs

:cdr

Readers

cdr-of (generic function)

Slot: cdr-state

Initargs

:cdr-state

Initform

(gensym)

Readers

cdr-state-of (generic function)

Class: debug-mixin ()

Package

toadstool-system

Source

forms.lisp (file)

Direct superclasses

component-mixin (class)

Direct methods

expand-form (method)

Class: destructuring-mixin ()

Package

toadstool-system

Source

destructuring.lisp (file)

Direct superclasses

sequence-mixin (class)

Direct subclasses

• *-form (class)
• +-form (class)
• char-form (class)

Direct methods

• sequence-get-state (method)
• sequence-set-state (method)
• sequence-item (method)
• sequence-endp (method)
• sequence-cdr-state (method)
• sequence-initial-state (method)

Class: eql-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

operator (class)

Direct subclasses

equal-form (class)

Direct methods

• expand-form (method)
• initialize-instance (method)
• lisp-expr-of (method)

Direct slots

Slot: lisp-expr

Initargs

:lisp-expr

Readers

lisp-expr-of (generic function)

Class: equal-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

eql-form (class)

Class: form ()

Superclass of all components being a part of a pattern.

Package

toadstool-system

Source

core.lisp (file)

Direct superclasses

component (class)

Direct subclasses

• operator (class)
• literal-form (class)
• t-form (class)
• variable-form (class)

Direct methods

• print-object (method)
• form-arguments (method)
• initialize-instance (method)
• expand-form (method)
• outer-form-of (method)
• inner-forms-of (method)
• form-of (method)

Direct slots

Slot: form

Initargs

toadstool-system:form

Readers

form-of (generic function)

Slot: inner-forms

Initargs

toadstool-system::inner-forms

Readers

inner-forms-of (generic function)

Slot: outer-form

Initargs

toadstool-system::outer-form

Readers

outer-form-of (generic function)

Class: list*-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

• macro-mixin (class)
• operator (class)

Direct methods

initialize-instance (method)

Class: list-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

• macro-mixin (class)
• operator (class)

Direct methods

initialize-instance (method)

Class: literal-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

form (class)

Direct methods

• initialize-instance (method)
• expand-form (method)
• matches? (method)
• datum-of (method)

Direct slots

Slot: datum

Initargs

:datum

Readers

datum-of (generic function)

Class: macro-mixin ()

Package

toadstool-system

Source

core.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• list*-form (class)
• list-form (class)
• class-form (class)
• string-form (class)

Direct methods

expand-form (method)

Direct slots

Slot: expansion

Class: nesting ()

Package

toadstool-system

Source

core.lisp (file)

Direct superclasses

component (class)

Direct subclasses

• variable-nesting (class)
• push-nesting (class)

Direct methods

• else-expr-of (method)
• if-expr-of (method)

Direct slots

Slot: if-expr

Initargs

:if-expr

Initform

(error "no if-expr")

Readers

if-expr-of (generic function)

Slot: else-expr

Initargs

:else-expr

Initform

(error "no else-expr")

Readers

else-expr-of (generic function)

Class: not-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

operator (class)

Direct methods

• expand-form (method)
• initialize-instance (method)
• datum-of (method)

Direct slots

Slot: datum

Initargs

:datum

Readers

datum-of (generic function)

Class: operator ()

Package

toadstool-system

Source

core.lisp (file)

Direct superclasses

form (class)

Direct subclasses

• typep-form (class)
• satisfies-form (class)
• not-form (class)
• and-form (class)
• or-form (class)
• quote-form (class)
• cons-form (class)
• list*-form (class)
• list-form (class)
• *-form (class)
• +-form (class)
• vector-rest-form (class)
• vector-form (class)
• with-accessors-form (class)
• comparison-operator (class)
• class-form (class)
• eql-form (class)
• assoc-form (class)
• char-form (class)
• string-form (class)
• push-form (class)
• macrolet-form (class)

Direct methods

• form-arguments (method)
• matches? (method)
• name-of (method)

Class: or-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

operator (class)

Direct methods

• expand-form (method)
• initialize-instance (method)
• forms-of (method)

Direct slots

Slot: forms

Initargs

:forms

Readers

forms-of (generic function)

Class: push-form ()

Package

toadstool-impl

Source

variables.lisp (file)

Direct superclasses

operator (class)

Direct methods

• expand-form (method)
• initialize-instance (method)
• var-of (method)

Direct slots

Slot: var

Initargs

:var

Readers

var-of (generic function)

Class: push-nesting ()

Package

toadstool-impl

Source

variables.lisp (file)

Direct superclasses

nesting (class)

Direct methods

expand-nesting (method)

Class: quote-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

operator (class)

Direct methods

• expand-form (method)
• initialize-instance (method)
• datum-of (method)

Direct slots

Slot: datum

Initargs

:datum

Readers

datum-of (generic function)

Class: satisfies-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

operator (class)

Direct methods

• expand-form (method)
• initialize-instance (method)
• function-expr-of (method)

Direct slots

Slot: function-expr

Initargs

:function-expr

Readers

function-expr-of (generic function)

Class: sequence-mixin ()

Package

toadstool-system

Source

core.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• destructuring-mixin (class)
• cons-form (class)
• vector-rest-form (class)

Class: string-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

• macro-mixin (class)
• operator (class)

Direct methods

initialize-instance (method)

Class: t-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

form (class)

Direct methods

• expand-form (method)
• matches? (method)

Class: typep-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

operator (class)

Direct methods

• expand-form (method)
• initialize-instance (method)
• type-of* (method)

Direct slots

Slot: type

Initargs

:type

Readers

type-of* (generic function)

Class: variable-form ()

Package

toadstool-impl

Source

variables.lisp (file)

Direct superclasses

form (class)

Direct methods

• expand-form (method)
• initialize-instance (method)
• matches? (method)
• previous-of (method)
• previous-of (method)
• using-k-once-of (method)
• using-k-once-of (method)
• name-of (method)

Direct slots

Slot: name

Initargs

:name

Readers

name-of (generic function)

Slot: using-k-once

Initargs

:using-k-once

Readers

using-k-once-of (generic function)

Writers

(setf using-k-once-of) (generic function)

Slot: previous

Initargs

:previous

Readers

previous-of (generic function)

Writers

(setf previous-of) (generic function)

Class: variable-nesting ()

Package

toadstool-impl

Source

variables.lisp (file)

Direct superclasses

nesting (class)

Direct methods

expand-nesting (method)

Class: vector-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

operator (class)

Direct methods

• expand-form (method)
• initialize-instance (method)
• elt-count-of (method)
• destructuring-of (method)
• vec-name-of (method)
• len-name-of (method)
• index-sym-of (method)
• elt-of (method)

Direct slots

Slot: elt

Initargs

:elt

Readers

elt-of (generic function)

Slot: index-sym

Initargs

:index-sym

Readers

index-sym-of (generic function)

Slot: len-name

Initargs

:len-name

Readers

len-name-of (generic function)

Slot: vec-name

Initargs

:vec-name

Readers

vec-name-of (generic function)

Slot: destructuring

Initargs

:destructuring

Readers

destructuring-of (generic function)

Slot: elt-count

Initargs

:elt-count

Readers

elt-count-of (generic function)

Class: vector-rest-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

• sequence-mixin (class)
• operator (class)

Direct methods

• sequence-get-state (method)
• sequence-set-state (method)
• sequence-item (method)
• sequence-endp (method)
• sequence-cdr-state (method)
• sequence-initial-state (method)
• expand-form (method)
• initialize-instance (method)
• destructuring-of (method)
• index-sym2-of (method)
• rest-of (method)
• vec-name-of (method)
• len-name-of (method)
• index-sym-of (method)
• elt-of (method)

Direct slots

Slot: elt

Initargs

:elt

Readers

elt-of (generic function)

Slot: index-sym

Initargs

:index-sym

Readers

index-sym-of (generic function)

Slot: len-name

Initargs

:len-name

Readers

len-name-of (generic function)

Slot: vec-name

Initargs

:vec-name

Readers

vec-name-of (generic function)

Slot: rest

Initargs

:rest

Readers

rest-of (generic function)

Slot: index-sym2

Initargs

:index-sym2

Readers

index-sym2-of (generic function)

Slot: destructuring

Initargs

:destructuring

Readers

destructuring-of (generic function)

Class: with-accessors-form ()

Package

toadstool-impl

Source

forms.lisp (file)

Direct superclasses

operator (class)

Direct methods

• expand-form (method)
• initialize-instance (method)
• forms-of (method)
• functions-of (method)

Direct slots

Slot: functions

Initargs

:functions

Readers

functions-of (generic function)

Slot: forms

Initargs

:forms

Readers

forms-of (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *debug-nesting-level*

Package

toadstool-impl

Source

forms.lisp (file)

Special Variable: *end-nestings*

Package

toadstool-system

Source

core.lisp (file)

Special Variable: *inner-forms*

Package

toadstool-system

Source

core.lisp (file)

Special Variable: *outer-form*

Package

toadstool-system

Source

core.lisp (file)

Special Variable: *toplevel-patterns*

Package

toadstool-system

Source

core.lisp (file)

Special Variable: *trace*

Package

toadstool-system

Source

core.lisp (file)

Special Variable: *variable-alist*

Package

toadstool-impl

Source

variables.lisp (file)

Special Variable: +nesting-keyword-list+

Package

toadstool-system

Source

core.lisp (file)

Special Variable: +nil+

Package

toadstool-impl

Source

variables.lisp (file)

5.2.2 Macros

Macro: define-predicate TYPE

Package

toadstool-system

Source

core.lisp (file)

Macro: with-root-mixins &body BODY

Package

toadstool-system

Source

core.lisp (file)

5.2.3 Functions

Function: %mkform CLASS DATUM &optional ARGS

Package

toadstool-system

Source

core.lisp (file)

Function: %toad-case EXPRS CASES PHAIL

Package

toadstool

Source

api.lisp (file)

Function: call/end-nestings NESTINGS IF-EXPR ELSE-EXPR K

Package

toadstool-system

Source

core.lisp (file)

Function: call/nestings NESTINGS IF-EXPR ELSE-EXPR K

Package

toadstool-system

Source

core.lisp (file)

Function: component? X

Package

toadstool-system

Source

core.lisp (file)

Function: components TYPE

Package

toadstool-system

Source

core.lisp (file)

Function: debug-print DATUM EXPR

Package

toadstool-impl

Source

forms.lisp (file)

Function: destructure-form SEQ FORMS K

Package

toadstool-impl

Source

forms.lisp (file)

Function: destructuring-loop C FORMS EXPR GREEDY? K

Package

toadstool-impl

Source

forms.lisp (file)

Function: form? X

Package

toadstool-system

Source

core.lisp (file)

Function: has-outer-destructuring? F

Package

toadstool-impl

Source

variables.lisp (file)

Function: inside-k-once? NAME

Package

toadstool-impl

Source

variables.lisp (file)

Function: make-macrolet-class NAME FUNCTION

Package

toadstool

Source

api.lisp (file)

Function: nesting? X

Package

toadstool-system

Source

core.lisp (file)

Function: operator? X

Package

toadstool-system

Source

core.lisp (file)

Function: partial-cerror EXPRS PATTERNS

Package

toadstool

Source

api.lisp (file)

Function: partial-error EXPRS PATTERNS

Package

toadstool

Source

api.lisp (file)

Function: sequence-mixin? X

Package

toadstool-system

Source

core.lisp (file)

Function: var-checked-every-time? VAR

Package

toadstool-impl

Source

variables.lisp (file)

5.2.4 Generic functions

Generic Function: car-of OBJECT

Package

toadstool-impl

Methods

Method: car-of (CONS-FORM cons-form)

automatically generated reader method

Source

forms.lisp (file)

Generic Function: cases-of OBJECT

Package

toadstool-impl

Methods

Method: cases-of (ASSOC-FORM assoc-form)

automatically generated reader method

Source

forms.lisp (file)

Generic Function: cdr-of OBJECT

Package

toadstool-impl

Methods

Method: cdr-of (CONS-FORM cons-form)

automatically generated reader method

Source

forms.lisp (file)

Generic Function: cdr-state-of OBJECT

Package

toadstool-impl

Methods

Method: cdr-state-of (CONS-FORM cons-form)

automatically generated reader method

Source

forms.lisp (file)

Generic Function: coerce-to-character-list DATUM

Package

toadstool-impl

Source

forms.lisp (file)

Methods

Method: coerce-to-character-list (C character)

Method: coerce-to-character-list (C string)

Method: coerce-to-character-list (C sequence)