Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The cl-pattern Reference Manual

This is the cl-pattern Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 04:12:21 2025 GMT+0.

Next: Systems, Previous: The cl-pattern Reference Manual, Up: The cl-pattern Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The cl-pattern Reference Manual [Contents][Index]

2 Systems

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

cl-pattern

Previous: Systems, Up: Systems [Contents][Index]

2.1 `cl-pattern`

Author

Tomohiro Matsuyama

License

LLGPL

Version

0.1

Dependencies

alexandria (system).
cl-annot (system).
cl-syntax (system).
cl-syntax-annot (system).

Source

cl-pattern.asd.

Child Component

src (module).

Next: Files, Previous: Systems, Up: The cl-pattern Reference Manual [Contents][Index]

3 Modules

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

cl-pattern/src

Previous: Modules, Up: Modules [Contents][Index]

3.1 `cl-pattern/src`

Source

cl-pattern.asd.

Parent Component

cl-pattern (system).

Child Components

package.lisp (file).
conditions.lisp (file).
pattern.lisp (file).
case.lisp (file).
compile.lisp (file).
match.lisp (file).

Next: Packages, Previous: Modules, Up: The cl-pattern Reference Manual [Contents][Index]

4 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

Next: cl-pattern/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-pattern/cl-pattern.asd`

Source: cl-pattern.asd.
Parent Component: cl-pattern (system).
ASDF Systems: cl-pattern.
Packages: cl-pattern-asd.

Next: cl-pattern/src/conditions.lisp, Previous: cl-pattern/cl-pattern.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-pattern/src/package.lisp`

Source: cl-pattern.asd.
Parent Component: src (module).
Packages: cl-pattern.

Next: cl-pattern/src/pattern.lisp, Previous: cl-pattern/src/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `cl-pattern/src/conditions.lisp`

Dependency: package.lisp (file).
Source: cl-pattern.asd.
Parent Component: src (module).
Internals: %match-error (function).

Next: cl-pattern/src/case.lisp, Previous: cl-pattern/src/conditions.lisp, Up: Lisp [Contents][Index]

4.1.4 `cl-pattern/src/pattern.lisp`

Dependency

conditions.lisp (file).

Source

cl-pattern.asd.

Parent Component

src (module).

Internals

%equal (macro).
free-variables (function).
optional-patterns (function).
pattern-type (function).

Next: cl-pattern/src/compile.lisp, Previous: cl-pattern/src/pattern.lisp, Up: Lisp [Contents][Index]

4.1.5 `cl-pattern/src/case.lisp`

Dependency

pattern.lisp (file).

Source

cl-pattern.asd.

Parent Component

src (module).

Internals

%case (macro).
compile-case (function).
compile-case-clause (function).

Next: cl-pattern/src/match.lisp, Previous: cl-pattern/src/case.lisp, Up: Lisp [Contents][Index]

4.1.6 `cl-pattern/src/compile.lisp`

Dependency

case.lisp (file).

Source

cl-pattern.asd.

Parent Component

src (module).

Internals

compile-match-constant (function).
compile-match-constructor (function).
compile-match-empty (function).
compile-match-group (function).
compile-match-groups (function).
compile-match-optional (function).
compile-match-optional-constructor (function).
compile-match-optional-null (function).
compile-match-variable (function).
partition-match-clauses (function).

Previous: cl-pattern/src/compile.lisp, Up: Lisp [Contents][Index]

4.1.7 `cl-pattern/src/match.lisp`

Dependency

compile.lisp (file).

Source

cl-pattern.asd.

Parent Component

src (module).

Public Interface

lambda-match (macro).
match (macro).

Internals

%match (macro).
match* (macro).

Next: Definitions, Previous: Files, Up: The cl-pattern Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-pattern
cl-pattern-asd

Next: cl-pattern-asd, Previous: Packages, Up: Packages [Contents][Index]

5.1 `cl-pattern`

Source

package.lisp.

Nickname

pattern

Use List

common-lisp.

Public Interface

lambda-match (macro).
match (macro).

Internals

%case (macro).
%equal (macro).
%match (macro).
%match-error (function).
compile-case (function).
compile-case-clause (function).
compile-match-constant (function).
compile-match-constructor (function).
compile-match-empty (function).
compile-match-group (function).
compile-match-groups (function).
compile-match-optional (function).
compile-match-optional-constructor (function).
compile-match-optional-null (function).
compile-match-variable (function).
free-variables (function).
match* (macro).
optional-patterns (function).
partition-match-clauses (function).
pattern-type (function).

Previous: cl-pattern, Up: Packages [Contents][Index]

5.2 `cl-pattern-asd`

Source

cl-pattern.asd.

Use List

asdf/interface.
common-lisp.

Next: Indexes, Previous: Packages, Up: The cl-pattern Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

6.1 Public Interface

Macros

Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Macros

Macro: lambda-match (&body clauses) ¶

Package: cl-pattern.
Source: match.lisp.

Macro: match (arg &body clauses) ¶

Package: cl-pattern.
Source: match.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

6.2 Internals

Macros
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Macros

Macro: %case (arg clauses else) ¶

Package: cl-pattern.
Source: case.lisp.

Macro: %equal (pattern value) ¶

Package: cl-pattern.
Source: pattern.lisp.

Macro: %match (vars clauses &optional else) ¶

Package: cl-pattern.
Source: match.lisp.

Macro: match* (args &body clauses) ¶

Package: cl-pattern.
Source: match.lisp.

Previous: Macros, Up: Internals [Contents][Index]

6.2.2 Ordinary functions

Function: %match-error (&optional args patterns) ¶

Package: cl-pattern.
Source: conditions.lisp.

Function: compile-case (var clauses else) ¶

Package: cl-pattern.
Source: case.lisp.

Function: compile-case-clause (var clause else) ¶

Package: cl-pattern.
Source: case.lisp.

Function: compile-match-constant (vars clauses else) ¶

Package: cl-pattern.
Source: compile.lisp.

Function: compile-match-constructor (vars clauses else) ¶

Package: cl-pattern.
Source: compile.lisp.

Function: compile-match-empty (clauses else) ¶

Package: cl-pattern.
Source: compile.lisp.

Function: compile-match-group (vars group else) ¶

Package: cl-pattern.
Source: compile.lisp.

Function: compile-match-groups (vars groups else) ¶

Package: cl-pattern.
Source: compile.lisp.

Function: compile-match-optional (vars clauses else) ¶

Package: cl-pattern.
Source: compile.lisp.

Function: compile-match-optional-constructor (var restvars clauses else) ¶

Package: cl-pattern.
Source: compile.lisp.

Function: compile-match-optional-null (restvars clauses else) ¶

Package: cl-pattern.
Source: compile.lisp.

Function: compile-match-variable (vars clauses else) ¶

Package: cl-pattern.
Source: compile.lisp.

Function: free-variables (pattern) ¶

Package: cl-pattern.
Source: pattern.lisp.

Function: optional-patterns (pattern) ¶

Package: cl-pattern.
Source: pattern.lisp.

Function: partition-match-clauses (clauses) ¶

Package: cl-pattern.
Source: compile.lisp.

Function: pattern-type (pattern) ¶

Package: cl-pattern.
Source: pattern.lisp.

Previous: Definitions, Up: The cl-pattern Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	% C F L M O P

	Index Entry	Section

%
	`%case`:	Private macros
	`%equal`:	Private macros
	`%match`:	Private macros
	`%match-error`:	Private ordinary functions

C
	`compile-case`:	Private ordinary functions
	`compile-case-clause`:	Private ordinary functions
	`compile-match-constant`:	Private ordinary functions
	`compile-match-constructor`:	Private ordinary functions
	`compile-match-empty`:	Private ordinary functions
	`compile-match-group`:	Private ordinary functions
	`compile-match-groups`:	Private ordinary functions
	`compile-match-optional`:	Private ordinary functions
	`compile-match-optional-constructor`:	Private ordinary functions
	`compile-match-optional-null`:	Private ordinary functions
	`compile-match-variable`:	Private ordinary functions

F
	`free-variables`:	Private ordinary functions
	`Function, %match-error`:	Private ordinary functions
	`Function, compile-case`:	Private ordinary functions
	`Function, compile-case-clause`:	Private ordinary functions
	`Function, compile-match-constant`:	Private ordinary functions
	`Function, compile-match-constructor`:	Private ordinary functions
	`Function, compile-match-empty`:	Private ordinary functions
	`Function, compile-match-group`:	Private ordinary functions
	`Function, compile-match-groups`:	Private ordinary functions
	`Function, compile-match-optional`:	Private ordinary functions
	`Function, compile-match-optional-constructor`:	Private ordinary functions
	`Function, compile-match-optional-null`:	Private ordinary functions
	`Function, compile-match-variable`:	Private ordinary functions
	`Function, free-variables`:	Private ordinary functions
	`Function, optional-patterns`:	Private ordinary functions
	`Function, partition-match-clauses`:	Private ordinary functions
	`Function, pattern-type`:	Private ordinary functions

L
	`lambda-match`:	Public macros

M
	`Macro, %case`:	Private macros
	`Macro, %equal`:	Private macros
	`Macro, %match`:	Private macros
	`Macro, lambda-match`:	Public macros
	`Macro, match`:	Public macros
	`Macro, match*`:	Private macros
	`match`:	Public macros
	`match*`:	Private macros

O
	`optional-patterns`:	Private ordinary functions

P
	`partition-match-clauses`:	Private ordinary functions
	`pattern-type`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F M P S

	Index Entry	Section

C
	`case.lisp`:	The cl-pattern/src/case․lisp file
	`cl-pattern`:	The cl-pattern system
	`cl-pattern`:	The cl-pattern package
	`cl-pattern-asd`:	The cl-pattern-asd package
	`cl-pattern.asd`:	The cl-pattern/cl-pattern․asd file
	`compile.lisp`:	The cl-pattern/src/compile․lisp file
	`conditions.lisp`:	The cl-pattern/src/conditions․lisp file

F
	`File, case.lisp`:	The cl-pattern/src/case․lisp file
	`File, cl-pattern.asd`:	The cl-pattern/cl-pattern․asd file
	`File, compile.lisp`:	The cl-pattern/src/compile․lisp file
	`File, conditions.lisp`:	The cl-pattern/src/conditions․lisp file
	`File, match.lisp`:	The cl-pattern/src/match․lisp file
	`File, package.lisp`:	The cl-pattern/src/package․lisp file
	`File, pattern.lisp`:	The cl-pattern/src/pattern․lisp file

M
	`match.lisp`:	The cl-pattern/src/match․lisp file
	`Module, src`:	The cl-pattern/src module

P
	`Package, cl-pattern`:	The cl-pattern package
	`Package, cl-pattern-asd`:	The cl-pattern-asd package
	`package.lisp`:	The cl-pattern/src/package․lisp file
	`pattern.lisp`:	The cl-pattern/src/pattern․lisp file

S
	`src`:	The cl-pattern/src module
	`System, cl-pattern`:	The cl-pattern system

The cl-pattern Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-pattern

3 Modules

3.1 cl-pattern/src

4 Files

4.1 Lisp

4.1.1 cl-pattern/cl-pattern.asd

4.1.2 cl-pattern/src/package.lisp

4.1.3 cl-pattern/src/conditions.lisp

4.1.4 cl-pattern/src/pattern.lisp

4.1.5 cl-pattern/src/case.lisp

4.1.6 cl-pattern/src/compile.lisp

4.1.7 cl-pattern/src/match.lisp

5 Packages

5.1 cl-pattern

5.2 cl-pattern-asd

6 Definitions

6.1 Public Interface

6.1.1 Macros

6.2 Internals

6.2.1 Macros

6.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-pattern`

3.1 `cl-pattern/src`

4.1.1 `cl-pattern/cl-pattern.asd`

4.1.2 `cl-pattern/src/package.lisp`

4.1.3 `cl-pattern/src/conditions.lisp`

4.1.4 `cl-pattern/src/pattern.lisp`

4.1.5 `cl-pattern/src/case.lisp`

4.1.6 `cl-pattern/src/compile.lisp`

4.1.7 `cl-pattern/src/match.lisp`

5.1 `cl-pattern`

5.2 `cl-pattern-asd`