The clite Reference Manual

Table of Contents

The clite Reference Manual

This is the clite Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 10:26:57 2021 GMT+0.

1 Systems

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

1.1 clite

Author

Andreas Wild <lispy.stuff@gmail.com>

License

ISC

Description

Lite weight testing framework

Version

1.0.0

Source

clite.asd (file)

Components

• core.lisp (file)
• clite.lisp (file)

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.

2.1 Lisp

2.1.1 clite.asd

Location

clite.asd

Systems

clite (system)

2.1.2 clite/core.lisp

Parent

clite (system)

Location

core.lisp

Packages

core

Exported Definitions

• assq (macro)
• compose (function)
• defmac (macro)
• do-until (macro)
• do-while (macro)
• do-with (macro)
• dolist-reverse (macro)
• doplist (macro)
• filter (function)
• flatten (function)
• kw (function)
• let-if (macro)
• mapcars (function)
• maptree (function)
• memq (macro)
• mexpand (macro)
• plist-remove-if (function)
• prob (function)
• rassq (macro)
• remove-tree (function)
• str (function)
• sym (function)
• sym< (function)

2.1.3 clite/clite.lisp

Dependency

core.lisp (file)

Parent

clite (system)

Location

clite.lisp

Packages

clite

Exported Definitions

• run-tests (macro)
• test (macro)
• test-eq (function)
• test-eql (function)
• test-equal (function)
• test-equalp (function)
• test-fail (function)
• test-pass (function)
• test-string= (function)
• test= (function)
• testp (function)

Internal Definitions

• define-ops (macro)
• run? (function)
• running-tags (special variable)
• test-count (special variable)
• tests (special variable)

3 Packages

Packages are listed by definition order.

3.1 core

Source

core.lisp (file)

Use List

common-lisp

Used By List

clite

Exported Definitions

• assq (macro)
• compose (function)
• defmac (macro)
• do-until (macro)
• do-while (macro)
• do-with (macro)
• dolist-reverse (macro)
• doplist (macro)
• filter (function)
• flatten (function)
• kw (function)
• let-if (macro)
• mapcars (function)
• maptree (function)
• memq (macro)
• mexpand (macro)
• plist-remove-if (function)
• prob (function)
• rassq (macro)
• remove-tree (function)
• str (function)
• sym (function)
• sym< (function)

3.2 clite

Source

clite.lisp (file)

Use List

• core
• common-lisp

Exported Definitions

• run-tests (macro)
• test (macro)
• test-eq (function)
• test-eql (function)
• test-equal (function)
• test-equalp (function)
• test-fail (function)
• test-pass (function)
• test-string= (function)
• test= (function)
• testp (function)

Internal Definitions

• define-ops (macro)
• run? (function)
• running-tags (special variable)
• test-count (special variable)
• tests (special variable)

4 Definitions

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

4.1 Exported definitions

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

Macro: defmac NAME ARGS &body BODY

Define macro with automagic GENSYM of $-symbols

Package

core

Source

core.lisp (file)

Macro: do-until TEST &body BODY

Execute body while cond is NIL

Package

core

Source

core.lisp (file)

Macro: do-while TEST &body BODY

Execute body while cond is not NIL

Package

core

Source

core.lisp (file)

Macro: do-with (VAR EXPR) &body BODY

Execute body while cond is NIL

Package

core

Source

core.lisp (file)

Macro: dolist-reverse (VAR LST) &body BODY

Perform BODY with VAR bound to items in reversed LST

Package

core

Source

core.lisp (file)

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

Macro: let-if (VAR EXPR) &body BODY

Package

core

Source

core.lisp (file)

Macro: memq IT LST &key KEY

Return sublist of LST starting with IT using #’eq for comparing

Package

core

Source

core.lisp (file)

Macro: mexpand EXPR

Pretty print macro expansion of expr

Package

core

Source

core.lisp (file)

Macro: rassq IT ALST &key KEY

Return rassoc of IT in ALST using #’eq for comparing

Package

core

Source

core.lisp (file)

Macro: run-tests &rest TAGS

Run TESTS matching TAGS

Package

clite

Source

clite.lisp (file)

Macro: test TAGS &body BODY

Package

clite

Source

clite.lisp (file)

4.1.2 Functions

Function: compose &rest FNS

Return composed function of FNS

Package

core

Source

core.lisp (file)

Function: filter FN LST

Call FN for each item in LST and return results that are not (EQ SKIP)

Package

core

Source

core.lisp (file)

Function: flatten X

Turn X into a flat list

Package

core

Source

core.lisp (file)

Function: kw &rest ARGS

Generate keyword from ARGS

Package

core

Source

core.lisp (file)

Function: mapcars FN &rest LSTS

Map FN over all items in all LSTS and return the results

Package

core

Source

core.lisp (file)

Function: maptree FN &rest TREES

Map FN over all items in all TREES and return the results

Package

core

Source

core.lisp (file)

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

Function: prob &rest ARGS

Calculate combined probability from ARGS

Package

core

Source

core.lisp (file)

Function: remove-tree TEST TREE

Return tree with all values for which TEST returns T removed

Package

core

Source

core.lisp (file)

Function: str &rest ARGS

Generate string from ARGS

Package

core

Source

core.lisp (file)

Function: sym &rest ARGS

Generate symbol from ARGS

Package

core

Source

core.lisp (file)

Function: sym< X Y

Return TRUE if X < Y

Package

core

Source

core.lisp (file)

Function: test-eq LEFT RIGHT &optional MESSAGE

Package

clite

Source

clite.lisp (file)

Function: test-eql LEFT RIGHT &optional MESSAGE

Package

clite

Source

clite.lisp (file)

Function: test-equal LEFT RIGHT &optional MESSAGE

Package

clite

Source

clite.lisp (file)

Function: test-equalp LEFT RIGHT &optional MESSAGE

Package

clite

Source

clite.lisp (file)

Function: test-fail &optional MSG &rest ARGS

Signal test failure

Package

clite

Source

clite.lisp (file)

Function: test-pass ()

Signal passed test

Package

clite

Source

clite.lisp (file)

Function: test-string= LEFT RIGHT &optional MESSAGE

Package

clite

Source

clite.lisp (file)

Function: test= LEFT RIGHT &optional MESSAGE

Package

clite

Source

clite.lisp (file)

Function: testp CONDITION &optional MSG

Signal test failure if CONDITION is false

Package

clite

Source

clite.lisp (file)

4.2 Internal definitions

4.2.1 Special variables

Special Variable: running-tags

Package

clite

Source

clite.lisp (file)

Special Variable: test-count

Package

clite

Source

clite.lisp (file)

Special Variable: tests

Package

clite

Source

clite.lisp (file)

4.2.2 Macros

Macro: define-ops &rest OPS

Package

clite

Source

clite.lisp (file)

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

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types