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 Wed May 15 04:21:07 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


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).


3 Modules

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


3.1 cl-pattern/src

Source

cl-pattern.asd.

Parent Component

cl-pattern (system).

Child Components

4 Files

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


4.1 Lisp


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.


4.1.2 cl-pattern/src/package.lisp

Source

cl-pattern.asd.

Parent Component

src (module).

Packages

cl-pattern.


4.1.3 cl-pattern/src/conditions.lisp

Dependency

package.lisp (file).

Source

cl-pattern.asd.

Parent Component

src (module).

Internals

%match-error (function).


4.1.4 cl-pattern/src/pattern.lisp

Dependency

conditions.lisp (file).

Source

cl-pattern.asd.

Parent Component

src (module).

Internals

4.1.5 cl-pattern/src/case.lisp

Dependency

pattern.lisp (file).

Source

cl-pattern.asd.

Parent Component

src (module).

Internals

4.1.6 cl-pattern/src/compile.lisp

Dependency

case.lisp (file).

Source

cl-pattern.asd.

Parent Component

src (module).

Internals

4.1.7 cl-pattern/src/match.lisp

Dependency

compile.lisp (file).

Source

cl-pattern.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 cl-pattern

Source

package.lisp.

Nickname

pattern

Use List

common-lisp.

Public Interface
Internals

5.2 cl-pattern-asd

Source

cl-pattern.asd.

Use List
  • asdf/interface.
  • common-lisp.

6 Definitions

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


6.1 Public Interface


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.


6.2 Internals


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.


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.


Appendix A Indexes


A.1 Concepts


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


A.3 Variables