Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the dynamic-collect Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 10:45:53 2021 GMT+0.
| • Introduction | What dynamic-collect is all about | |
| • Systems | The systems documentation | |
| • Files | The files documentation | |
| • Packages | The packages documentation | |
| • Definitions | The symbols documentation | |
| • Indexes | Concepts, functions, variables and data types |
DYNAMIC-COLLECT
===============
By Robert Smith
DYNAMIC-COLLECT is a library for dynamic, continuable, and abortable
collection of data.
This code is useful for times when data needs to be collected at
various points in a program, but it is inconvenient to modify the
program and create new pipelines for passing data around. It is also
useful when such pipelines would take away from the intent of the
program.
This code was originally created for tasks in code analysis, where
warnings and errors were collected during the analysis, and then
processed a posteriori.
EXAMPLE
-------
First, we will define a function which intends to do some kind of
analysis of data, and warn if it's not the right type. In this case,
we will check that it's an integer. If it's not, we'll warn that we
wanted an integer. Actually, we will collect a message that represents
the warning.
(defun pass-1 (data)
(unless (integerp data)
(collect (format nil "Warning: Not an integer: ~S" data))))
Next, we will do a more stringent analysis. If the data is a non-null
list, then we will require that the first element of the list needs to
be a symbol. Perhaps this represents a function call. If the data
indeed doesn't look like a function call, then we will collect an
error, and specify that collection (and further analysis) must not
continue, so we pass NIL to CONTINUEP.
(defun pass-2 (data)
(when (and (listp data)
(plusp (length data)))
(unless (symbolp (car data))
(collect (format nil "Error: A function call needs a symbol ~
in the first position, given: ~S"
(car data))
:continuep nil))))
Now a simple function to process our collected messages. In this case,
we will just print them out in a friendly fashion.
(defun process-messages (messages)
(if (null messages)
(format t "No messages.~%")
(format t "~@(~R~) message~:P:~%~{ >> ~A~%~}"
(length messages)
messages)))
Finally, we have our main entry point to our analysis. We use
WITH-DYNAMIC-COLLECTION, and do the passes on our data. We will log
when a pass completes to the user.
(defun main (data)
(let ((messages (with-dynamic-collection ()
(pass-1 data)
(format t ";;; Done with pass 1.~%")
(force-output)
(pass-2 data)
(format t ";;; Done with pass 2.~%")
(force-output))))
(process-messages messages)))
Now for some test runs. First, we provide completely "legitimate" data
(according to our passes).
CL-USER> (main 5)
;;; Done with pass 1.
;;; Done with pass 2.
No messages.
NIL
As seen, the passes complete, and we have no messages. Now let's do
the analysis on something that warns on the first pass.
CL-USER> (main :quux)
;;; Done with pass 1.
;;; Done with pass 2.
One message:
>> Warning: Not an integer: :QUUX
NIL
As seen, both passes complete, but we ended up with a warning we
collected. Now let's do something that passes the second analysis, but
warns on the first, again.
CL-USER> (main '(hello))
;;; Done with pass 1.
;;; Done with pass 2.
One message:
>> Warning: Not an integer: (HELLO)
NIL
Same thing. Finally, let's do something that will cause issues with
both.
CL-USER> (main '(5 hello))
;;; Done with pass 1.
Two messages:
>> Warning: Not an integer: (5 HELLO)
>> Error: A function call needs a symbol in the first position, given: 5
NIL
Note this time that both warnings were collected and displayed. But
more importantly, note that we never reached the end of the second
pass; our collection aborted early.
Despite this very contrived example, early termination is very
useful. For example, if we are analyzing a file that ends up being
unable to be parsed, we can collect an error message, and fail early.
ENSURING CORRECTNESS
--------------------
Using the variable *ENSURE-HANDLED-COLLECT*, we can error if the
system detects that a COLLECT is used without a properly enclosing
WITH-DYNAMIC-COLLECTION.
By default, *ENSURE-HANDLED-COLLECT* is NIL, which means that
unhandled COLLECT forms will just return their RETURN keyword
parameter value.
COMPOSING DYNAMIC COLLECTIONS
-----------------------------
WITH-DYNAMIC-COLLECTION is actually composable via the notion of
tags. A "tag" is an EQL-comparable thing (often a keyword) that lets
one match up a WITH-DYNAMIC-COLLECTION with a COLLECT form. We simply
provide tags to each, and collection will be matched up
accordingly. For example:
CL-USER> (format t "OUTER: ~S~%"
(with-dynamic-collection (:tag :outer)
(collect 1 :tag :outer)
(format t "INNER: ~S~%"
(with-dynamic-collection (:tag :inner)
(collect 2 :tag :outer)
(collect 3 :tag :inner)))))
will print
INNER: (3)
OUTER: (1 2)
as expected. By default, the tags are NIL (an EQL-comparable value),
which is sufficient when there's no composition.
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The dynamic-collect system |
Robert Smith <quad@symbo1ics.com>
BSD 3-clause (see LICENSE)
A library for dynamic, continuable, and abortable collection.
dynamic-collect.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files |
| • The dynamic-collect.asd file | ||
| • The dynamic-collect/package.lisp file | ||
| • The dynamic-collect/dynamic-collect.lisp file |
Next: The dynamic-collect/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
dynamic-collect.asd
dynamic-collect (system)
Next: The dynamic-collect/dynamic-collect․lisp file, Previous: The dynamic-collect․asd file, Up: Lisp files [Contents][Index]
dynamic-collect (system)
package.lisp
Previous: The dynamic-collect/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
dynamic-collect (system)
dynamic-collect.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The dynamic-collect package |
package.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions | ||
| • Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported special variables | ||
| • Exported macros | ||
| • Exported functions |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
If T, ensure that COLLECT forms are inside WITH-DYNAMIC-COLLECTION. If NIL, return the specified RETURN value from COLLECT.
dynamic-collect.lisp (file)
Next: Exported functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Dynamically collect messages that were signalled during the execution of BODY from COLLECT. Return a list of messages in the order they were collected. If TAG is provided, then only COLLECT forms which have the same tag will be accrued.
dynamic-collect.lisp (file)
Previous: Exported macros, Up: Exported definitions [Contents][Index]
Collect the data DATA in a WITH-DYNAMIC-COLLECTION
environment. Return the value RETURN from the form in the event the
function is returned from.
If CONTINUEP is null, then collecting will cease and the
matching WITH-DYNAMIC-COLLECTION form will return.
The TAG denotes at which WITH-DYNAMIC-COLLECTION form the DATA will be accumulated.
dynamic-collect.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal generic functions | ||
| • Internal conditions |
Next: Internal conditions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
dynamic-collect.lisp (file)
dynamic-collect.lisp (file)
dynamic-collect.lisp (file)
dynamic-collect.lisp (file)
Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
A condition to carry messages between parts of programs.
dynamic-collect.lisp (file)
condition (condition)
:payload
messenger-payload (generic function)
:continuep
(quote t)
messenger-continuep (generic function)
:id
messenger-id (generic function)
:tag
(quote nil)
messenger-tag (generic function)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index | ||
| • Function index | ||
| • Variable index | ||
| • Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | D F L |
|---|
| Jump to: | D F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | C F G M W |
|---|
| Jump to: | C F G M W |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
C I P S T |
|---|
| Jump to: | *
C I P S T |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C D M P S |
|---|
| Jump to: | C D M P S |
|---|