The cl-monad-macros Reference Manual

This is the cl-monad-macros Reference Manual, version 0.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:33:11 2020 GMT+0.

1 Systems

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

1.1 `cl-monad-macros`

Author: David Sorokin <david.sorokin@gmail.com>
Description: Monad Macros for Common Lisp.
Version: 0.2
Source: cl-monad-macros.asd (file)
Component: cl-monad-macros.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 `cl-monad-macros.asd`

Location: cl-monad-macros.asd
Systems: cl-monad-macros (system)
Packages: cl-monad-macros-asd

2.1.2 `cl-monad-macros/cl-monad-macros.lisp`

Parent

cl-monad-macros (system)

Location

cl-monad-macros.lisp

Packages

cl-monad-macros

Exported Definitions

make-maybe (macro)
maybe-just (macro)
maybe-just-p (macro)
maybe-nil (macro)
maybe-nil-p (macro)
with-identity-monad (macro)
with-list-monad (macro)
with-maybe-monad (macro)
with-monad (macro)
with-monad-trans (macro)
with-reader-monad (macro)
with-reader-monad-trans (macro)
with-state-monad (macro)
with-state-monad-trans (macro)
with-writer-monad (macro)
with-writer-monad-trans (macro)

Internal Definitions

generic-inner-funcall! (function)
generic-inner-let! (function)
generic-inner-progn! (function)
generic-inner-unit (function)
generic-let! (function)
generic-progn! (function)
list-let! (function)
list-progn! (function)
make-state (macro)
make-writer (macro)
maybe-funcall! (function)
maybe-let! (function)
maybe-progn! (function)
maybe-unit (function)
reader-funcall! (function)
reader-let! (function)
reader-progn! (function)
reader-read! (function)
reader-run! (function)
reader-trans-funcall! (function)
reader-trans-let! (function)
reader-trans-lift! (function)
reader-trans-progn! (function)
reader-trans-read! (function)
reader-trans-run! (function)
reader-trans-unit (function)
reader-unit (function)
state-funcall! (function)
state-get! (function)
state-let! (function)
state-progn! (function)
state-put! (function)
state-run! (function)
state-state (macro)
state-trans-funcall! (function)
state-trans-get! (function)
state-trans-let! (function)
state-trans-lift! (function)
state-trans-progn! (function)
state-trans-put! (function)
state-trans-run! (function)
state-trans-unit (function)
state-unit (function)
state-value (macro)
with-inner-monad-prototype (function)
writer-compose (macro)
writer-fun (macro)
writer-funcall! (function)
writer-let! (function)
writer-progn! (function)
writer-run! (function)
writer-trans-funcall! (function)
writer-trans-let! (function)
writer-trans-lift! (function)
writer-trans-progn! (function)
writer-trans-run! (function)
writer-trans-unit (function)
writer-trans-write! (function)
writer-trans-write-list! (function)
writer-unit (function)
writer-value (macro)
writer-write! (function)
writer-write-list! (function)

3 Packages

Packages are listed by definition order.

3.1 `cl-monad-macros-asd`

Source

cl-monad-macros.asd

Use List

common-lisp
asdf/interface

3.2 `cl-monad-macros`

Source

cl-monad-macros.lisp (file)

Use List

common-lisp

Exported Definitions

make-maybe (macro)
maybe-just (macro)
maybe-just-p (macro)
maybe-nil (macro)
maybe-nil-p (macro)
with-identity-monad (macro)
with-list-monad (macro)
with-maybe-monad (macro)
with-monad (macro)
with-monad-trans (macro)
with-reader-monad (macro)
with-reader-monad-trans (macro)
with-state-monad (macro)
with-state-monad-trans (macro)
with-writer-monad (macro)
with-writer-monad-trans (macro)

Internal Definitions

generic-inner-funcall! (function)
generic-inner-let! (function)
generic-inner-progn! (function)
generic-inner-unit (function)
generic-let! (function)
generic-progn! (function)
list-let! (function)
list-progn! (function)
make-state (macro)
make-writer (macro)
maybe-funcall! (function)
maybe-let! (function)
maybe-progn! (function)
maybe-unit (function)
reader-funcall! (function)
reader-let! (function)
reader-progn! (function)
reader-read! (function)
reader-run! (function)
reader-trans-funcall! (function)
reader-trans-let! (function)
reader-trans-lift! (function)
reader-trans-progn! (function)
reader-trans-read! (function)
reader-trans-run! (function)
reader-trans-unit (function)
reader-unit (function)
state-funcall! (function)
state-get! (function)
state-let! (function)
state-progn! (function)
state-put! (function)
state-run! (function)
state-state (macro)
state-trans-funcall! (function)
state-trans-get! (function)
state-trans-let! (function)
state-trans-lift! (function)
state-trans-progn! (function)
state-trans-put! (function)
state-trans-run! (function)
state-trans-unit (function)
state-unit (function)
state-value (macro)
with-inner-monad-prototype (function)
writer-compose (macro)
writer-fun (macro)
writer-funcall! (function)
writer-let! (function)
writer-progn! (function)
writer-run! (function)
writer-trans-funcall! (function)
writer-trans-let! (function)
writer-trans-lift! (function)
writer-trans-progn! (function)
writer-trans-run! (function)
writer-trans-unit (function)
writer-trans-write! (function)
writer-trans-write-list! (function)
writer-unit (function)
writer-value (macro)
writer-write! (function)
writer-write-list! (function)

4 Definitions

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

4.1 Exported definitions

4.1.1 Macros

Macro: make-maybe &key JUST

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: maybe-just A

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: maybe-just-p M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: maybe-nil ()

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: maybe-nil-p M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: with-identity-monad &body BODY

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: with-list-monad &body BODY

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: with-maybe-monad &body BODY

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: with-monad (UNIT-FUNC FUNCALL-FUNC) &body BODY

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: with-monad-trans OUTER-MONAD &body BODY

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: with-reader-monad &body BODY

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: with-reader-monad-trans INNER-MONAD &body BODY

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: with-state-monad &body BODY

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: with-state-monad-trans INNER-MONAD &body BODY

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: with-writer-monad &body BODY

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: with-writer-monad-trans INNER-MONAD &body BODY

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

4.2 Internal definitions

4.2.1 Macros

Macro: make-state A ST

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: make-writer A FUN

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: state-state M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: state-value M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: writer-compose F G

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: writer-fun M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Macro: writer-value M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

4.2.2 Functions

Function: generic-inner-funcall! K M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: generic-inner-let! DECLS M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: generic-inner-progn! MS

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: generic-inner-unit A

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: generic-let! FUNCALL-FUNC DECLS M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: generic-progn! FUNCALL-FUNC MS

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: list-let! DECLS M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: list-progn! MS

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: maybe-funcall! K M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: maybe-let! DECLS M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: maybe-progn! MS

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: maybe-unit A

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: reader-funcall! K M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: reader-let! DECLS M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: reader-progn! MS

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: reader-read! ()

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: reader-run! M R

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: reader-trans-funcall! K M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: reader-trans-let! DECLS M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: reader-trans-lift! M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: reader-trans-progn! MS

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: reader-trans-read! ()

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: reader-trans-run! M R

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: reader-trans-unit A

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: reader-unit A

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-funcall! K M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-get! ()

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-let! DECLS M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-progn! MS

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-put! NEW-ST

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-run! M INIT-ST

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-trans-funcall! K M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-trans-get! ()

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-trans-let! DECLS M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-trans-lift! M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-trans-progn! MS

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-trans-put! NEW-ST

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-trans-run! M INIT-ST

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-trans-unit A

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: state-unit A

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: with-inner-monad-prototype OUTER-MONAD INNER-MONAD ID BODY

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-funcall! K M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-let! DECLS M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-progn! MS

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-run! M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-trans-funcall! K M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-trans-let! DECLS M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-trans-lift! M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-trans-progn! MS

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-trans-run! M

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-trans-unit A

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-trans-write! WS

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-trans-write-list! WSS

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-unit A

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-write! WS

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Function: writer-write-list! WSS

Package: cl-monad-macros
Source: cl-monad-macros.lisp (file)

Appendix A Indexes

A.1 Concepts

Jump to:	C F L

	Index Entry	Section

C
	`cl-monad-macros.asd`:	The cl-monad-macros․asd file
	`cl-monad-macros/cl-monad-macros.lisp`:	The cl-monad-macros/cl-monad-macros․lisp file

F
	File, Lisp, `cl-monad-macros.asd`:	The cl-monad-macros․asd file
	File, Lisp, `cl-monad-macros/cl-monad-macros.lisp`:	The cl-monad-macros/cl-monad-macros․lisp file

L
	Lisp File, `cl-monad-macros.asd`:	The cl-monad-macros․asd file
	Lisp File, `cl-monad-macros/cl-monad-macros.lisp`:	The cl-monad-macros/cl-monad-macros․lisp file

Jump to:	C F L

A.2 Functions

Jump to:	F G L M R S W

	Index Entry	Section

F
	`Function, generic-inner-funcall!`:	Internal functions
	`Function, generic-inner-let!`:	Internal functions
	`Function, generic-inner-progn!`:	Internal functions
	`Function, generic-inner-unit`:	Internal functions
	`Function, generic-let!`:	Internal functions
	`Function, generic-progn!`:	Internal functions
	`Function, list-let!`:	Internal functions
	`Function, list-progn!`:	Internal functions
	`Function, maybe-funcall!`:	Internal functions
	`Function, maybe-let!`:	Internal functions
	`Function, maybe-progn!`:	Internal functions
	`Function, maybe-unit`:	Internal functions
	`Function, reader-funcall!`:	Internal functions
	`Function, reader-let!`:	Internal functions
	`Function, reader-progn!`:	Internal functions
	`Function, reader-read!`:	Internal functions
	`Function, reader-run!`:	Internal functions
	`Function, reader-trans-funcall!`:	Internal functions
	`Function, reader-trans-let!`:	Internal functions
	`Function, reader-trans-lift!`:	Internal functions
	`Function, reader-trans-progn!`:	Internal functions
	`Function, reader-trans-read!`:	Internal functions
	`Function, reader-trans-run!`:	Internal functions
	`Function, reader-trans-unit`:	Internal functions
	`Function, reader-unit`:	Internal functions
	`Function, state-funcall!`:	Internal functions
	`Function, state-get!`:	Internal functions
	`Function, state-let!`:	Internal functions
	`Function, state-progn!`:	Internal functions
	`Function, state-put!`:	Internal functions
	`Function, state-run!`:	Internal functions
	`Function, state-trans-funcall!`:	Internal functions
	`Function, state-trans-get!`:	Internal functions
	`Function, state-trans-let!`:	Internal functions
	`Function, state-trans-lift!`:	Internal functions
	`Function, state-trans-progn!`:	Internal functions
	`Function, state-trans-put!`:	Internal functions
	`Function, state-trans-run!`:	Internal functions
	`Function, state-trans-unit`:	Internal functions
	`Function, state-unit`:	Internal functions
	`Function, with-inner-monad-prototype`:	Internal functions
	`Function, writer-funcall!`:	Internal functions
	`Function, writer-let!`:	Internal functions
	`Function, writer-progn!`:	Internal functions
	`Function, writer-run!`:	Internal functions
	`Function, writer-trans-funcall!`:	Internal functions
	`Function, writer-trans-let!`:	Internal functions
	`Function, writer-trans-lift!`:	Internal functions
	`Function, writer-trans-progn!`:	Internal functions
	`Function, writer-trans-run!`:	Internal functions
	`Function, writer-trans-unit`:	Internal functions
	`Function, writer-trans-write!`:	Internal functions
	`Function, writer-trans-write-list!`:	Internal functions
	`Function, writer-unit`:	Internal functions
	`Function, writer-write!`:	Internal functions
	`Function, writer-write-list!`:	Internal functions

G
	`generic-inner-funcall!`:	Internal functions
	`generic-inner-let!`:	Internal functions
	`generic-inner-progn!`:	Internal functions
	`generic-inner-unit`:	Internal functions
	`generic-let!`:	Internal functions
	`generic-progn!`:	Internal functions

L
	`list-let!`:	Internal functions
	`list-progn!`:	Internal functions

M
	`Macro, make-maybe`:	Exported macros
	`Macro, make-state`:	Internal macros
	`Macro, make-writer`:	Internal macros
	`Macro, maybe-just`:	Exported macros
	`Macro, maybe-just-p`:	Exported macros
	`Macro, maybe-nil`:	Exported macros
	`Macro, maybe-nil-p`:	Exported macros
	`Macro, state-state`:	Internal macros
	`Macro, state-value`:	Internal macros
	`Macro, with-identity-monad`:	Exported macros
	`Macro, with-list-monad`:	Exported macros
	`Macro, with-maybe-monad`:	Exported macros
	`Macro, with-monad`:	Exported macros
	`Macro, with-monad-trans`:	Exported macros
	`Macro, with-reader-monad`:	Exported macros
	`Macro, with-reader-monad-trans`:	Exported macros
	`Macro, with-state-monad`:	Exported macros
	`Macro, with-state-monad-trans`:	Exported macros
	`Macro, with-writer-monad`:	Exported macros
	`Macro, with-writer-monad-trans`:	Exported macros
	`Macro, writer-compose`:	Internal macros
	`Macro, writer-fun`:	Internal macros
	`Macro, writer-value`:	Internal macros
	`make-maybe`:	Exported macros
	`make-state`:	Internal macros
	`make-writer`:	Internal macros
	`maybe-funcall!`:	Internal functions
	`maybe-just`:	Exported macros
	`maybe-just-p`:	Exported macros
	`maybe-let!`:	Internal functions
	`maybe-nil`:	Exported macros
	`maybe-nil-p`:	Exported macros
	`maybe-progn!`:	Internal functions
	`maybe-unit`:	Internal functions

R
	`reader-funcall!`:	Internal functions
	`reader-let!`:	Internal functions
	`reader-progn!`:	Internal functions
	`reader-read!`:	Internal functions
	`reader-run!`:	Internal functions
	`reader-trans-funcall!`:	Internal functions
	`reader-trans-let!`:	Internal functions
	`reader-trans-lift!`:	Internal functions
	`reader-trans-progn!`:	Internal functions
	`reader-trans-read!`:	Internal functions
	`reader-trans-run!`:	Internal functions
	`reader-trans-unit`:	Internal functions
	`reader-unit`:	Internal functions

S
	`state-funcall!`:	Internal functions
	`state-get!`:	Internal functions
	`state-let!`:	Internal functions
	`state-progn!`:	Internal functions
	`state-put!`:	Internal functions
	`state-run!`:	Internal functions
	`state-state`:	Internal macros
	`state-trans-funcall!`:	Internal functions
	`state-trans-get!`:	Internal functions
	`state-trans-let!`:	Internal functions
	`state-trans-lift!`:	Internal functions
	`state-trans-progn!`:	Internal functions
	`state-trans-put!`:	Internal functions
	`state-trans-run!`:	Internal functions
	`state-trans-unit`:	Internal functions
	`state-unit`:	Internal functions
	`state-value`:	Internal macros

W
	`with-identity-monad`:	Exported macros
	`with-inner-monad-prototype`:	Internal functions
	`with-list-monad`:	Exported macros
	`with-maybe-monad`:	Exported macros
	`with-monad`:	Exported macros
	`with-monad-trans`:	Exported macros
	`with-reader-monad`:	Exported macros
	`with-reader-monad-trans`:	Exported macros
	`with-state-monad`:	Exported macros
	`with-state-monad-trans`:	Exported macros
	`with-writer-monad`:	Exported macros
	`with-writer-monad-trans`:	Exported macros
	`writer-compose`:	Internal macros
	`writer-fun`:	Internal macros
	`writer-funcall!`:	Internal functions
	`writer-let!`:	Internal functions
	`writer-progn!`:	Internal functions
	`writer-run!`:	Internal functions
	`writer-trans-funcall!`:	Internal functions
	`writer-trans-let!`:	Internal functions
	`writer-trans-lift!`:	Internal functions
	`writer-trans-progn!`:	Internal functions
	`writer-trans-run!`:	Internal functions
	`writer-trans-unit`:	Internal functions
	`writer-trans-write!`:	Internal functions
	`writer-trans-write-list!`:	Internal functions
	`writer-unit`:	Internal functions
	`writer-value`:	Internal macros
	`writer-write!`:	Internal functions
	`writer-write-list!`:	Internal functions

Jump to:	F G L M R S W

A.3 Variables

A.4 Data types

Jump to:	C P S

	Index Entry	Section

C
	`cl-monad-macros`:	The cl-monad-macros system
	`cl-monad-macros`:	The cl-monad-macros package
	`cl-monad-macros-asd`:	The cl-monad-macros-asd package

P
	`Package, cl-monad-macros`:	The cl-monad-macros package
	`Package, cl-monad-macros-asd`:	The cl-monad-macros-asd package

S
	`System, cl-monad-macros`:	The cl-monad-macros system

Jump to:	C P S

• Systems		The systems documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• Concept index
• Function index
• Variable index
• Data type index

• The cl-monad-macros.asd file
• The cl-monad-macros/cl-monad-macros.lisp file

• The cl-monad-macros-asd package
• The cl-monad-macros package

The cl-monad-macros Reference Manual

Table of Contents

The cl-monad-macros Reference Manual

1 Systems

1.1 cl-monad-macros

2 Files

2.1 Lisp

2.1.1 cl-monad-macros.asd

2.1.2 cl-monad-macros/cl-monad-macros.lisp

3 Packages

3.1 cl-monad-macros-asd

3.2 cl-monad-macros

4 Definitions

4.1 Exported definitions

4.1.1 Macros

4.2 Internal definitions

4.2.1 Macros

4.2.2 Functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

1.1 `cl-monad-macros`

2.1.1 `cl-monad-macros.asd`

2.1.2 `cl-monad-macros/cl-monad-macros.lisp`

3.1 `cl-monad-macros-asd`

3.2 `cl-monad-macros`