The trivial-do Reference Manual

This is the trivial-do Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 15:07:04 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-do

Looping extensions that follow the style of the core DO functions.

Author

Tarn W. Burton

License

MIT

Version

0.1

Source

trivial-do.asd.

Child Component

src (module).


3 Modules

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


3.1 trivial-do/src

Source

trivial-do.asd.

Parent Component

trivial-do (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 trivial-do/trivial-do.asd

Source

trivial-do.asd.

Parent Component

trivial-do (system).

ASDF Systems

trivial-do.


4.1.2 trivial-do/src/packages.lisp

Source

trivial-do.asd.

Parent Component

src (module).

Packages

trivial-do.


4.1.3 trivial-do/src/doalist.lisp

Dependency

packages.lisp (file).

Source

trivial-do.asd.

Parent Component

src (module).

Public Interface

doalist (macro).


4.1.4 trivial-do/src/dohash.lisp

Dependency

doalist.lisp (file).

Source

trivial-do.asd.

Parent Component

src (module).

Public Interface

dohash (macro).


4.1.5 trivial-do/src/dolist.lisp

Dependency

dohash.lisp (file).

Source

trivial-do.asd.

Parent Component

src (module).

Public Interface

dolist* (macro).


4.1.6 trivial-do/src/doplist.lisp

Dependency

dolist.lisp (file).

Source

trivial-do.asd.

Parent Component

src (module).

Public Interface

doplist (macro).


4.1.7 trivial-do/src/doseq.lisp

Dependency

doplist.lisp (file).

Source

trivial-do.asd.

Parent Component

src (module).

Public Interface

5 Packages

Packages are listed by definition order.


5.1 trivial-do

Source

packages.lisp.

Use List

common-lisp.

Public Interface

6 Definitions

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


6.1 Public Interface


6.1.1 Macros

Macro: doalist ((key-var value-var alist-form &optional result-form) &body body)

doalist iterates over the elements of an alist and binds key-var to the car of each element, value-var to the cdr of each element and then evaluates body as a tagbody that can include declarations. Finally the result-form is returned after the iteration completes.

Package

trivial-do.

Source

doalist.lisp.

Macro: dohash ((key-var value-var hash-table-form &optional result-form) &body body)

dohash iterates over the elements of an hash table and binds key-var to the key, value-var to the associated value and then evaluates body as a tagbody that can include declarations. Finally the result-form is returned after the iteration completes.

Package

trivial-do.

Source

dohash.lisp.

Macro: dolist* ((position-var value-var list-form &optional result-form) &body body)

dolist* iterates over the elements of an list and binds position-var to the index of each element, value-var to each element and then evaluates body as a tagbody that can include declarations. Finally the result-form is returned after the iteration completes.

Package

trivial-do.

Source

dolist.lisp.

Macro: doplist ((key-var value-var alist-form &optional result-form) &body body)

doplist iterates over the elements of an plist and binds key-var to the key, value-var to the associated value and then evaluates body as a tagbody that can include declarations. Finally the result-form is returned after the iteration completes.

Package

trivial-do.

Source

doplist.lisp.

Macro: doseq ((var seq-form &optional result-form) &body body)

doseq iterates over the elements of an sequence and binds value-var to successive values and then evaluates body as a tagbody that can include declarations. Finally the result-form is returned after the iteration completes.

Package

trivial-do.

Source

doseq.lisp.

Macro: doseq* ((position-var value-var seq-form &optional result-form) &body body)

doseq* iterates over the elements of an sequence and binds position-var to the index of each element, value-var to each element and then evaluates body as a tagbody that can include declarations. Finally the result-form is returned after the iteration completes.

Package

trivial-do.

Source

doseq.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables