The cl-monad-macros Reference Manual

This is the cl-monad-macros Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:28:23 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 cl-monad-macros

Monad Macros for Common Lisp.

Author

David Sorokin <>

Version

0.2

Source

cl-monad-macros.asd.

Child 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/cl-monad-macros.asd

Source

cl-monad-macros.asd.

Parent Component

cl-monad-macros (system).

ASDF Systems

cl-monad-macros.

Packages

cl-monad-macros-asd.


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

Source

cl-monad-macros.asd.

Parent Component

cl-monad-macros (system).

Packages

cl-monad-macros.

Public Interface
Internals

3 Packages

Packages are listed by definition order.


3.1 cl-monad-macros

Source

cl-monad-macros.lisp.

Use List

common-lisp.

Public Interface
Internals

3.2 cl-monad-macros-asd

Source

cl-monad-macros.asd.

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

4 Definitions

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


4.1 Public Interface


4.1.1 Macros

Macro: make-maybe (&key just)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: maybe-just (a)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: maybe-just-p (m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: maybe-nil ()
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: maybe-nil-p (m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: with-identity-monad (&body body)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: with-list-monad (&body body)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: with-maybe-monad (&body body)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: with-monad ((unit-func funcall-func) &body body)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: with-monad-trans (outer-monad &body body)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: with-reader-monad (&body body)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: with-reader-monad-trans (inner-monad &body body)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: with-state-monad (&body body)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: with-state-monad-trans (inner-monad &body body)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: with-writer-monad (&body body)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: with-writer-monad-trans (inner-monad &body body)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.


4.2 Internals


4.2.1 Macros

Macro: make-state (a st)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: make-writer (a fun)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: state-state (m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: state-value (m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: writer-compose (f g)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: writer-fun (m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Macro: writer-value (m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.


4.2.2 Ordinary functions

Function: generic-inner-funcall! (k m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: generic-inner-let! (decls m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: generic-inner-progn! (ms)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: generic-inner-unit (a)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: generic-let! (funcall-func decls m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: generic-progn! (funcall-func ms)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: list-let! (decls m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: list-progn! (ms)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: maybe-funcall! (k m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: maybe-let! (decls m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: maybe-progn! (ms)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: maybe-unit (a)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: reader-funcall! (k m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: reader-let! (decls m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: reader-progn! (ms)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: reader-read! ()
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: reader-run! (m r)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: reader-trans-funcall! (k m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: reader-trans-let! (decls m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: reader-trans-lift! (m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: reader-trans-progn! (ms)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: reader-trans-read! ()
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: reader-trans-run! (m r)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: reader-trans-unit (a)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: reader-unit (a)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-funcall! (k m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-get! ()
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-let! (decls m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-progn! (ms)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-put! (new-st)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-run! (m init-st)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-trans-funcall! (k m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-trans-get! ()
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-trans-let! (decls m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-trans-lift! (m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-trans-progn! (ms)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-trans-put! (new-st)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-trans-run! (m init-st)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-trans-unit (a)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: state-unit (a)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: with-inner-monad-prototype (outer-monad inner-monad id body)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-funcall! (k m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-let! (decls m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-progn! (ms)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-run! (m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-trans-funcall! (k m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-trans-let! (decls m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-trans-lift! (m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-trans-progn! (ms)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-trans-run! (m)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-trans-unit (a)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-trans-write! (ws)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-trans-write-list! (wss)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-unit (a)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-write! (ws)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.

Function: writer-write-list! (wss)
Package

cl-monad-macros.

Source

cl-monad-macros.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   F   G   L   M   R   S   W  
Index Entry  Section

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

G
generic-inner-funcall!: Private ordinary functions
generic-inner-let!: Private ordinary functions
generic-inner-progn!: Private ordinary functions
generic-inner-unit: Private ordinary functions
generic-let!: Private ordinary functions
generic-progn!: Private ordinary functions

L
list-let!: Private ordinary functions
list-progn!: Private ordinary functions

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

R
reader-funcall!: Private ordinary functions
reader-let!: Private ordinary functions
reader-progn!: Private ordinary functions
reader-read!: Private ordinary functions
reader-run!: Private ordinary functions
reader-trans-funcall!: Private ordinary functions
reader-trans-let!: Private ordinary functions
reader-trans-lift!: Private ordinary functions
reader-trans-progn!: Private ordinary functions
reader-trans-read!: Private ordinary functions
reader-trans-run!: Private ordinary functions
reader-trans-unit: Private ordinary functions
reader-unit: Private ordinary functions

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

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


A.3 Variables