This is the checkl Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 03:40:02 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
checklCheckL: Dynamic testing for Common Lisp
Ryan Pavlik <rpavlik@gmail.com>
LLGPL, BSD
1.0
marshal (system).
package.lisp (file).
checkl.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
checkl/checkl.lisppackage.lisp (file).
checkl (system).
check (macro).
check-output (macro).
checkl-load (function).
checkl-store (function).
clear (function).
clear-anonymous (function).
perform (method).
perform (method).
result-equalp (generic function).
result-translate (generic function).
results (macro).
run (function).
run-all (function).
test-values (class).
tests (class).
*all-tests* (special variable).
*definitions-only* (special variable).
copy-package-tests (function).
current-tests (function).
do-categories (macro).
ensure-test (function).
make-package-tests (function).
package-tests (structure).
package-tests-categories (reader).
(setf package-tests-categories) (writer).
package-tests-default-checkl-store (reader).
(setf package-tests-default-checkl-store) (writer).
package-tests-lambdas (reader).
(setf package-tests-lambdas) (writer).
package-tests-p (function).
package-tests-results (reader).
(setf package-tests-results) (writer).
result-error (condition).
result-error-index (reader method).
result-error-last (reader method).
result-error-value (reader method).
test-values-package (reader method).
(setf test-values-package) (writer method).
verify-result (function).
Packages are listed by definition order.
checklcommon-lisp.
check (macro).
check-output (macro).
checkl-load (function).
checkl-store (function).
clear (function).
clear-anonymous (function).
result-equalp (generic function).
result-translate (generic function).
results (macro).
run (function).
run-all (function).
test-values (class).
tests (class).
*all-tests* (special variable).
*definitions-only* (special variable).
copy-package-tests (function).
current-tests (function).
do-categories (macro).
ensure-test (function).
make-package-tests (function).
package-tests (structure).
package-tests-categories (reader).
(setf package-tests-categories) (writer).
package-tests-default-checkl-store (reader).
(setf package-tests-default-checkl-store) (writer).
package-tests-lambdas (reader).
(setf package-tests-lambdas) (writer).
package-tests-p (function).
package-tests-results (reader).
(setf package-tests-results) (writer).
result-error (condition).
result-error-index (generic reader).
result-error-last (generic reader).
result-error-value (generic reader).
test-values-package (generic reader).
(setf test-values-package) (generic writer).
verify-result (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
=> test-results
Run ‘BODY‘. Check resulting values against the last run using
‘CHECKL:RESULT-EQUALP‘, or store them if this is the first run.
Sameness of the test is determined by comparing the body with
‘EQUALP‘, or by ‘NAME‘.
‘NAME‘ may be specified to name a test. If the test exists but is
anonymous (i.e., ‘NAME‘ has not been specified), specifying ‘NAME‘
will name the test and it will no longer be anonymous.
‘CATEGORY‘ may be specified for running groups of tests.
If ‘OUTPUT-P‘ is ‘t‘, the results will be printed to ‘*standard-output*‘ as well as returned. This may be helpful if the results are too long to see in your emacs minibuffer.
Use this within a ‘CHECK‘ block. Rebind ‘*standard-output*‘ and ‘*error-output*‘ and return a ‘CHECK‘-able result.
=> VALUES
This will evaluate each subform in order and call RESULT-TRANSLATE on
the result. This is especially useful if subforms repeatedly modify
and return the object, e.g. ‘(results (incf *x*) (incf *x*))‘.
If multiple values are returned, each value is mapped via RESULT-TRANSLATE and the result is returned as a list of the translated values.
Load package test results from ‘FILESPEC‘
Store package test results to ‘FILESPEC‘
Clear the test results from the tests ‘NAMES‘. For clearing anonymous test results, see ‘CLEAR-ANONYMOUS‘.
Clear anonymous test results. For clearing named tests, see ‘CLEAR‘.
=> test-results
Run tests named ‘NAMES‘, collecting their results.
=> test-results
Run all tests, optionally specifying categories.
Generic function to compare test results ‘O1‘ to ‘O2‘. Defaults to ‘EQUALP‘.
RESULT-TRANSLATE is called on RESULT before calling
RESULT-EQUALP and before storing RESULT. This defaults to RESULT, but
may be useful for converting more complex objects into simpler
objects. For sequences and structures, COPY-SEQ and COPY-STRUCTURE
are called. For STANDARD-OBJECT instances, (MS:UNMARSHAL (MS:MARSHAL
OBJECT)) is called.
load-op) (c test-values)) ¶asdf/action.
An ASDF component for loading CheckL test values.
static-file.
common-lisp.
:package
Load a file with CHECK or CHECK-FORMAL tests.
cl-source-file.
result-error)) ¶result-error)) ¶result-error)) ¶test-values)) ¶automatically generated reader method
test-values)) ¶automatically generated writer method
error.
(quote nil)
:result-index
This slot is read-only.
(quote nil)
:result-value
This slot is read-only.
(quote nil)
:last-value
This slot is read-only.
structure-object.
(make-hash-table :test (quote equalp))
(make-hash-table :test (quote equalp))
(make-hash-table :test (quote equalp))
| Jump to: | (
C D E F G M P R T V |
|---|
| Jump to: | (
C D E F G M P R T V |
|---|
| Jump to: | *
C D L P R S |
|---|
| Jump to: | *
C D L P R S |
|---|
| Jump to: | C F P R S T |
|---|
| Jump to: | C F P R S T |
|---|