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

The macrodynamics Reference Manual

This is the macrodynamics Reference Manual, version 0.1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 05:59:13 2024 GMT+0.

Next: Systems, Previous: The macrodynamics Reference Manual, Up: The macrodynamics Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The macrodynamics Reference Manual [Contents][Index]

2 Systems

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

macrodynamics

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

2.1 `macrodynamics`

A language extension for creating bindings scoped to the entire expansion process of a region of code.

Author: Kyle Littler
Home Page: https://github.com/DalekBaldwin/macrodynamics
License: LLGPL
Version: 0.1.1
Dependency: alexandria (system).
Source: macrodynamics.asd.
Child Component: src (module).

Next: Files, Previous: Systems, Up: The macrodynamics Reference Manual [Contents][Index]

3 Modules

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

macrodynamics/src

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

3.1 `macrodynamics/src`

Source

macrodynamics.asd.

Parent Component

macrodynamics (system).

Child Components

package.lisp (file).
util.lisp (file).
macrodynamics.lisp (file).

Next: Packages, Previous: Modules, Up: The macrodynamics 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: macrodynamics/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `macrodynamics/macrodynamics.asd`

Source: macrodynamics.asd.
Parent Component: macrodynamics (system).
ASDF Systems: macrodynamics.

Next: macrodynamics/src/util.lisp, Previous: macrodynamics/macrodynamics.asd, Up: Lisp [Contents][Index]

4.1.2 `macrodynamics/src/package.lisp`

Source: macrodynamics.asd.
Parent Component: src (module).
Packages: macrodynamics.
Internals: *system-directory* (special variable).

Next: macrodynamics/src/macrodynamics.lisp, Previous: macrodynamics/src/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `macrodynamics/src/util.lisp`

Dependency

package.lisp (file).

Source

macrodynamics.asd.

Parent Component

src (module).

Internals

get-assoc (function).
update-alist (function).

Previous: macrodynamics/src/util.lisp, Up: Lisp [Contents][Index]

4.1.4 `macrodynamics/src/macrodynamics.lisp`

Dependency

util.lisp (file).

Source

macrodynamics.asd.

Parent Component

src (module).

Public Interface

ct-flet (macro).
ct-let (macro).
ct-let* (macro).
def-dynenv-fun (macro).
def-dynenv-macro (macro).
def-dynenv-var (macro).
def-unbound-dynenv-fun (macro).
dynenv-function (macro).
dynenv-macrolet (macro).
unbound-dynenv-macro-fun (condition).
unbound-dynenv-macro-var (condition).
with-dynenv (macro).

Internals

*eval-phases* (special variable).
*fun-space* (special variable).
*unbound* (special variable).
*var-space* (special variable).
*within-captured-dynenv* (special variable).
-unbound- (symbol macro).
dynenv-function% (function).
fun (reader method).
(setf fun) (writer method).
get-dynenv-var (function).
(setf get-dynenv-var) (function).
var (reader method).
(setf var) (writer method).

Next: Definitions, Previous: Files, Up: The macrodynamics Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

macrodynamics

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

5.1 `macrodynamics`

Source

package.lisp.

Use List

alexandria.
common-lisp.

Public Interface

ct-flet (macro).
ct-let (macro).
ct-let* (macro).
def-dynenv-fun (macro).
def-dynenv-macro (macro).
def-dynenv-var (macro).
def-unbound-dynenv-fun (macro).
dynenv-function (macro).
dynenv-macrolet (macro).
unbound-dynenv-macro-fun (condition).
unbound-dynenv-macro-var (condition).
with-dynenv (macro).

Internals

*eval-phases* (special variable).
*fun-space* (special variable).
*system-directory* (special variable).
*unbound* (special variable).
*var-space* (special variable).
*within-captured-dynenv* (special variable).
-unbound- (symbol macro).
dynenv-function% (function).
fun (generic reader).
(setf fun) (generic writer).
get-assoc (function).
get-dynenv-var (function).
(setf get-dynenv-var) (function).
update-alist (function).
var (generic reader).
(setf var) (generic writer).

Next: Indexes, Previous: Packages, Up: The macrodynamics 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
Conditions

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

6.1.1 Macros

Macro: ct-flet (definitions &body body) ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Macro: ct-let (bindings &body body) ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Macro: ct-let* (bindings &body body) ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Macro: def-dynenv-fun (name args &body body) ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Macro: def-dynenv-macro (name lambda-list &body body) ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Macro: def-dynenv-var (var &optional val) ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Macro: def-unbound-dynenv-fun (name) ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Macro: dynenv-function (name) ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Macro: dynenv-macrolet (definitions &body body) ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Macro: with-dynenv (environment &body body) ¶

Macro for capturing a dynenv within another macro’s body.

Package: macrodynamics.
Source: macrodynamics.lisp.

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

6.1.2 Conditions

Condition: unbound-dynenv-macro-fun ¶

Package

macrodynamics.

Source

macrodynamics.lisp.

Direct superclasses

condition.

Direct methods

(setf fun).
fun.

Direct slots

Slot: fun ¶

Initargs: :fun
Readers: fun.
Writers: (setf fun).

Condition: unbound-dynenv-macro-var ¶

Package

macrodynamics.

Source

macrodynamics.lisp.

Direct superclasses

condition.

Direct methods

(setf var).
var.

Direct slots

Slot: var ¶

Initargs: :var
Readers: var.
Writers: (setf var).

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

6.2 Internals

Special variables
Symbol macros
Ordinary functions
Generic functions

Next: Symbol macros, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Special variables

Special Variable: *eval-phases* ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Special Variable: *fun-space* ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Special Variable: *system-directory* ¶

Package: macrodynamics.
Source: package.lisp.

Special Variable: *unbound* ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Special Variable: *var-space* ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Special Variable: *within-captured-dynenv* ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

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

6.2.2 Symbol macros

Symbol Macro: -unbound- ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Next: Generic functions, Previous: Symbol macros, Up: Internals [Contents][Index]

6.2.3 Ordinary functions

Function: dynenv-function% (symbol) ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Function: get-assoc (item alist &rest keys &key key test test-not) ¶

Like ASSOC but returns the cdr instead of the whole matching cons and a second value indicating success or failure.

Package: macrodynamics.
Source: util.lisp.

Function: get-dynenv-var (var) ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Function: (setf get-dynenv-var) (var) ¶

Package: macrodynamics.
Source: macrodynamics.lisp.

Function: update-alist (item value alist) ¶

Non-destructively replace cdr of the cons whose car matches ITEM in ALIST with VALUE, or insert a new cons if no car matches ITEM.

Package: macrodynamics.
Source: util.lisp.

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

6.2.4 Generic functions

Generic Reader: fun (condition) ¶

Generic Writer: (setf fun) (condition) ¶

Package

macrodynamics.

Methods

Reader Method: fun ((condition unbound-dynenv-macro-fun)) ¶

Writer Method: (setf fun) ((condition unbound-dynenv-macro-fun)) ¶

Source: macrodynamics.lisp.
Target Slot: fun.

Generic Reader: var (condition) ¶

Generic Writer: (setf var) (condition) ¶

Package

macrodynamics.

Methods

Reader Method: var ((condition unbound-dynenv-macro-var)) ¶

Writer Method: (setf var) ((condition unbound-dynenv-macro-var)) ¶

Source: macrodynamics.lisp.
Target Slot: var.

Previous: Definitions, Up: The macrodynamics 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 D F G M U V W

	Index Entry	Section

(
	`(setf fun)`:	Private generic functions
	`(setf fun)`:	Private generic functions
	`(setf get-dynenv-var)`:	Private ordinary functions
	`(setf var)`:	Private generic functions
	`(setf var)`:	Private generic functions

C
	`ct-flet`:	Public macros
	`ct-let`:	Public macros
	`ct-let*`:	Public macros

D
	`def-dynenv-fun`:	Public macros
	`def-dynenv-macro`:	Public macros
	`def-dynenv-var`:	Public macros
	`def-unbound-dynenv-fun`:	Public macros
	`dynenv-function`:	Public macros
	`dynenv-function%`:	Private ordinary functions
	`dynenv-macrolet`:	Public macros

F
	`fun`:	Private generic functions
	`fun`:	Private generic functions
	`Function, (setf get-dynenv-var)`:	Private ordinary functions
	`Function, dynenv-function%`:	Private ordinary functions
	`Function, get-assoc`:	Private ordinary functions
	`Function, get-dynenv-var`:	Private ordinary functions
	`Function, update-alist`:	Private ordinary functions

G
	`Generic Function, (setf fun)`:	Private generic functions
	`Generic Function, (setf var)`:	Private generic functions
	`Generic Function, fun`:	Private generic functions
	`Generic Function, var`:	Private generic functions
	`get-assoc`:	Private ordinary functions
	`get-dynenv-var`:	Private ordinary functions

M
	`Macro, ct-flet`:	Public macros
	`Macro, ct-let`:	Public macros
	`Macro, ct-let*`:	Public macros
	`Macro, def-dynenv-fun`:	Public macros
	`Macro, def-dynenv-macro`:	Public macros
	`Macro, def-dynenv-var`:	Public macros
	`Macro, def-unbound-dynenv-fun`:	Public macros
	`Macro, dynenv-function`:	Public macros
	`Macro, dynenv-macrolet`:	Public macros
	`Macro, with-dynenv`:	Public macros
	`Method, (setf fun)`:	Private generic functions
	`Method, (setf var)`:	Private generic functions
	`Method, fun`:	Private generic functions
	`Method, var`:	Private generic functions

U
	`update-alist`:	Private ordinary functions

V
	`var`:	Private generic functions
	`var`:	Private generic functions

W
	`with-dynenv`:	Public macros

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

A.3 Variables

Jump to:	* - F S V

	Index Entry	Section

*
	`eval-phases`:	Private special variables
	`fun-space`:	Private special variables
	`system-directory`:	Private special variables
	`unbound`:	Private special variables
	`var-space`:	Private special variables
	`within-captured-dynenv`:	Private special variables

-
	`-unbound-`:	Private symbol macros

F
	`fun`:	Public conditions

S
	`Slot, fun`:	Public conditions
	`Slot, var`:	Public conditions
	`Special Variable, eval-phases`:	Private special variables
	`Special Variable, fun-space`:	Private special variables
	`Special Variable, system-directory`:	Private special variables
	`Special Variable, unbound`:	Private special variables
	`Special Variable, var-space`:	Private special variables
	`Special Variable, within-captured-dynenv`:	Private special variables
	`Symbol Macro, -unbound-`:	Private symbol macros

V
	`var`:	Public conditions

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

A.4 Data types

Jump to:	C F M P S U

	Index Entry	Section

C
	`Condition, unbound-dynenv-macro-fun`:	Public conditions
	`Condition, unbound-dynenv-macro-var`:	Public conditions

F
	`File, macrodynamics.asd`:	The macrodynamics/macrodynamics․asd file
	`File, macrodynamics.lisp`:	The macrodynamics/src/macrodynamics․lisp file
	`File, package.lisp`:	The macrodynamics/src/package․lisp file
	`File, util.lisp`:	The macrodynamics/src/util․lisp file

M
	`macrodynamics`:	The macrodynamics system
	`macrodynamics`:	The macrodynamics package
	`macrodynamics.asd`:	The macrodynamics/macrodynamics․asd file
	`macrodynamics.lisp`:	The macrodynamics/src/macrodynamics․lisp file
	`Module, src`:	The macrodynamics/src module

P
	`Package, macrodynamics`:	The macrodynamics package
	`package.lisp`:	The macrodynamics/src/package․lisp file

S
	`src`:	The macrodynamics/src module
	`System, macrodynamics`:	The macrodynamics system

U
	`unbound-dynenv-macro-fun`:	Public conditions
	`unbound-dynenv-macro-var`:	Public conditions
	`util.lisp`:	The macrodynamics/src/util․lisp file

The macrodynamics Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 macrodynamics

3 Modules

3.1 macrodynamics/src

4 Files

4.1 Lisp

4.1.1 macrodynamics/macrodynamics.asd

4.1.2 macrodynamics/src/package.lisp

4.1.3 macrodynamics/src/util.lisp

4.1.4 macrodynamics/src/macrodynamics.lisp

5 Packages

5.1 macrodynamics

6 Definitions

6.1 Public Interface

6.1.1 Macros

6.1.2 Conditions

6.2 Internals

6.2.1 Special variables

6.2.2 Symbol macros

6.2.3 Ordinary functions

6.2.4 Generic functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `macrodynamics`

3.1 `macrodynamics/src`

4.1.1 `macrodynamics/macrodynamics.asd`

4.1.2 `macrodynamics/src/package.lisp`

4.1.3 `macrodynamics/src/util.lisp`

4.1.4 `macrodynamics/src/macrodynamics.lisp`

5.1 `macrodynamics`