The clite Reference Manual
This is the clite Reference Manual, version 1.0.0,
generated automatically by Declt version 4.0 beta 2 "William Riker"
on Tue Jul 15 04:39:52 2025 GMT+0.
1 Systems
The main system appears first, followed by any subsystem dependency.
2 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
2.1 Lisp
2.1.2 clite/core.lisp
- Source
clite.asd.
- Parent Component
clite (system).
- Packages
core.
- Public Interface
-
2.1.3 clite/clite.lisp
- Dependency
core.lisp (file).
- Source
clite.asd.
- Parent Component
clite (system).
- Packages
clite.
- Public Interface
-
- Internals
-
3 Packages
Packages are listed by definition order.
3.1 clite
- Source
clite.lisp.
- Use List
-
- Public Interface
-
- Internals
-
3.2 core
- Source
core.lisp.
- Use List
common-lisp.
- Used By List
clite.
- Public Interface
-
4 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
4.1 Public Interface
4.1.1 Macros
- Macro: assq (it alst &key key) ¶
-
Return assoc of IT in ALST using #’eq for comparing
- Package
core.
- Source
core.lisp.
- Macro: defmac (name args &body body) ¶
-
Define macro with automagic GENSYM of $-symbols
- Package
core.
- Source
core.lisp.
- Macro: do-until (test &body body) ¶
-
Execute body while cond is NIL
- Package
core.
- Source
core.lisp.
- Macro: do-while (test &body body) ¶
-
Execute body while cond is not NIL
- Package
core.
- Source
core.lisp.
- Macro: do-with ((var expr) &body body) ¶
-
Execute body while cond is NIL
- Package
core.
- Source
core.lisp.
- Macro: dolist-reverse ((var lst) &body body) ¶
-
Perform BODY with VAR bound to items in reversed LST
- Package
core.
- Source
core.lisp.
- Macro: doplist ((key value lst) &body body) ¶
-
Perform BODY with KEY and VALUE bound to keys and values in LST
- Package
core.
- Source
core.lisp.
- Macro: let-if ((var expr) &body body) ¶
-
- Package
core.
- Source
core.lisp.
- Macro: memq (it lst &key key) ¶
-
Return sublist of LST starting with IT using #’eq for comparing
- Package
core.
- Source
core.lisp.
- Macro: mexpand (expr) ¶
-
Pretty print macro expansion of expr
- Package
core.
- Source
core.lisp.
- Macro: rassq (it alst &key key) ¶
-
Return rassoc of IT in ALST using #’eq for comparing
- Package
core.
- Source
core.lisp.
- Macro: run-tests (&rest tags) ¶
-
Run TESTS matching TAGS
- Package
clite.
- Source
clite.lisp.
- Macro: test (tags &body body) ¶
-
- Package
clite.
- Source
clite.lisp.
4.1.2 Ordinary functions
- Function: compose (&rest fns) ¶
-
Return composed function of FNS
- Package
core.
- Source
core.lisp.
- Function: filter (fn lst) ¶
-
Call FN for each item in LST and return results that are not (EQ SKIP)
- Package
core.
- Source
core.lisp.
- Function: flatten (x) ¶
-
Turn X into a flat list
- Package
core.
- Source
core.lisp.
- Function: kw (&rest args) ¶
-
Generate keyword from ARGS
- Package
core.
- Source
core.lisp.
- Function: mapcars (fn &rest lsts) ¶
-
Map FN over all items in all LSTS and return the results
- Package
core.
- Source
core.lisp.
- Function: maptree (fn &rest trees) ¶
-
Map FN over all items in all TREES and return the results
- Package
core.
- Source
core.lisp.
- Function: plist-remove-if (pred plst) ¶
-
Call FN for each item in PLST and return results that are not (EQ SKIP)
- Package
core.
- Source
core.lisp.
- Function: prob (&rest args) ¶
-
Calculate combined probability from ARGS
- Package
core.
- Source
core.lisp.
- Function: remove-tree (test tree) ¶
-
Return tree with all values for which TEST returns T removed
- Package
core.
- Source
core.lisp.
- Function: str (&rest args) ¶
-
Generate string from ARGS
- Package
core.
- Source
core.lisp.
- Function: sym (&rest args) ¶
-
Generate symbol from ARGS
- Package
core.
- Source
core.lisp.
- Function: sym< (x y) ¶
-
Return TRUE if X < Y
- Package
core.
- Source
core.lisp.
- Function: test-eq (left right &optional message) ¶
-
- Package
clite.
- Source
clite.lisp.
- Function: test-eql (left right &optional message) ¶
-
- Package
clite.
- Source
clite.lisp.
- Function: test-equal (left right &optional message) ¶
-
- Package
clite.
- Source
clite.lisp.
- Function: test-equalp (left right &optional message) ¶
-
- Package
clite.
- Source
clite.lisp.
- Function: test-fail (&optional msg &rest args) ¶
-
Signal test failure
- Package
clite.
- Source
clite.lisp.
- Function: test-pass () ¶
-
Signal passed test
- Package
clite.
- Source
clite.lisp.
- Function: test-string= (left right &optional message) ¶
-
- Package
clite.
- Source
clite.lisp.
- Function: test= (left right &optional message) ¶
-
- Package
clite.
- Source
clite.lisp.
- Function: testp (condition &optional msg) ¶
-
Signal test failure if CONDITION is false
- Package
clite.
- Source
clite.lisp.
4.2 Internals
4.2.3 Ordinary functions
- Function: run? (test-tags running-tags &key null-test-result) ¶
-
Return T if TEST-TAGS matches RUNNING-TAGS, second result value contains the
remaining RUNNING-TAGS
- Package
clite.
- Source
clite.lisp.
Appendix A Indexes
A.2 Functions
| |
|
| A | | |
| assq: | | Public macros |
|
| C | | |
| compose: | | Public ordinary functions |
|
| D | | |
| define-ops: | | Private macros |
| defmac: | | Public macros |
| do-until: | | Public macros |
| do-while: | | Public macros |
| do-with: | | Public macros |
| dolist-reverse: | | Public macros |
| doplist: | | Public macros |
|
| F | | |
| filter: | | Public ordinary functions |
| flatten: | | Public ordinary functions |
| Function, compose: | | Public ordinary functions |
| Function, filter: | | Public ordinary functions |
| Function, flatten: | | Public ordinary functions |
| Function, kw: | | Public ordinary functions |
| Function, mapcars: | | Public ordinary functions |
| Function, maptree: | | Public ordinary functions |
| Function, plist-remove-if: | | Public ordinary functions |
| Function, prob: | | Public ordinary functions |
| Function, remove-tree: | | Public ordinary functions |
| Function, run?: | | Private ordinary functions |
| Function, str: | | Public ordinary functions |
| Function, sym: | | Public ordinary functions |
| Function, sym<: | | Public ordinary functions |
| Function, test-eq: | | Public ordinary functions |
| Function, test-eql: | | Public ordinary functions |
| Function, test-equal: | | Public ordinary functions |
| Function, test-equalp: | | Public ordinary functions |
| Function, test-fail: | | Public ordinary functions |
| Function, test-pass: | | Public ordinary functions |
| Function, test-string=: | | Public ordinary functions |
| Function, test=: | | Public ordinary functions |
| Function, testp: | | Public ordinary functions |
|
| K | | |
| kw: | | Public ordinary functions |
|
| L | | |
| let-if: | | Public macros |
|
| M | | |
| Macro, assq: | | Public macros |
| Macro, define-ops: | | Private macros |
| Macro, defmac: | | Public macros |
| Macro, do-until: | | Public macros |
| Macro, do-while: | | Public macros |
| Macro, do-with: | | Public macros |
| Macro, dolist-reverse: | | Public macros |
| Macro, doplist: | | Public macros |
| Macro, let-if: | | Public macros |
| Macro, memq: | | Public macros |
| Macro, mexpand: | | Public macros |
| Macro, rassq: | | Public macros |
| Macro, run-tests: | | Public macros |
| Macro, test: | | Public macros |
| mapcars: | | Public ordinary functions |
| maptree: | | Public ordinary functions |
| memq: | | Public macros |
| mexpand: | | Public macros |
|
| P | | |
| plist-remove-if: | | Public ordinary functions |
| prob: | | Public ordinary functions |
|
| R | | |
| rassq: | | Public macros |
| remove-tree: | | Public ordinary functions |
| run-tests: | | Public macros |
| run?: | | Private ordinary functions |
|
| S | | |
| str: | | Public ordinary functions |
| sym: | | Public ordinary functions |
| sym<: | | Public ordinary functions |
|
| T | | |
| test: | | Public macros |
| test-eq: | | Public ordinary functions |
| test-eql: | | Public ordinary functions |
| test-equal: | | Public ordinary functions |
| test-equalp: | | Public ordinary functions |
| test-fail: | | Public ordinary functions |
| test-pass: | | Public ordinary functions |
| test-string=: | | Public ordinary functions |
| test=: | | Public ordinary functions |
| testp: | | Public ordinary functions |
|