The trivial-do Reference Manual

Table of Contents

The trivial-do Reference Manual

This is the trivial-do Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 15:18:22 2020 GMT+0.

1 Introduction

trivial-do

Additional dolist style macros for Common Lisp. Currently provides doalist, dohash, dolist*, doplist, doseq and doseq*.

doalist

Iterates over the key value pairs of an alist.

(doalist (key value alist &optional return-form)
  (format t "key: ~A, value: ~A~%" key value))

dohash

Iterates over the key value pairs of a hash table.

(dohash (key value hash-table &optional return-form)
  (format t "key: ~A, value: ~A~%" key value))

dolist*

Iterates over a list with a position variable tracking the current index.

(dolist* (position value list &optional return-form)
  (format t "position: ~A, value: ~A~%" position value))

doplist

Iterates over the key value pairs of an plist.

(doplist (key value plist &optional return-form)
  (format t "key: ~A, value: ~A~%" key value))

doseq

Iterates over the values of a sequence.

(doseq (value sequence &optional return-form)
  (format t "value: ~A~%" position value))

doseq*

Iterates over a sequence with a position variable tracking the current index.

(doseq* (position value sequence &optional return-form)
  (format t "position: ~A, value: ~A~%" position value))

2 Systems

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

2.1 trivial-do

Author

Tarn W. Burton

License

MIT

Description

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

Version

0.1

Source

trivial-do.asd (file)

Component

src (module)

3 Modules

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

3.1 trivial-do/src

Parent

trivial-do (system)

Location

src/

Components

• packages.lisp (file)
• doalist.lisp (file)
• dohash.lisp (file)
• dolist.lisp (file)
• doplist.lisp (file)
• doseq.lisp (file)

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

Location

trivial-do.asd

Systems

trivial-do (system)

4.1.2 trivial-do/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

trivial-do

4.1.3 trivial-do/src/doalist.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/doalist.lisp

Exported Definitions

doalist (macro)

4.1.4 trivial-do/src/dohash.lisp

Dependency

doalist.lisp (file)

Parent

src (module)

Location

src/dohash.lisp

Exported Definitions

dohash (macro)

4.1.5 trivial-do/src/dolist.lisp

Dependency

dohash.lisp (file)

Parent

src (module)

Location

src/dolist.lisp

Exported Definitions

dolist* (macro)

4.1.6 trivial-do/src/doplist.lisp

Dependency

dolist.lisp (file)

Parent

src (module)

Location

src/doplist.lisp

Exported Definitions

doplist (macro)

4.1.7 trivial-do/src/doseq.lisp

Dependency

doplist.lisp (file)

Parent

src (module)

Location

src/doseq.lisp

Exported Definitions

• doseq (macro)
• doseq* (macro)

5 Packages

Packages are listed by definition order.

5.1 trivial-do

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

• doalist (macro)
• dohash (macro)
• dolist* (macro)
• doplist (macro)
• doseq (macro)
• doseq* (macro)

6 Definitions

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

6.1 Exported definitions

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 (file)

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 (file)

Macro: dolist* (POSITION-VAR VALUE-VAR LIST-FORM &optional RESULT-FORM) &rest 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 (file)

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 (file)

Macro: doseq (VAR SEQ-FORM &optional RESULT-FORM) &rest 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 (file)

Macro: doseq* (POSITION-VAR VALUE-VAR SEQ-FORM &optional RESULT-FORM) &rest 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 (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types