The clite Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The clite Reference Manual

This is the clite Reference Manual, version 1.0.0, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:26:25 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

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

Next: , Previous: , Up: Top   [Contents][Index]

2 Files

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


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 clite.asd

Location

clite.asd

Systems

clite (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.2 clite/core.lisp

Parent

clite (system)

Location

core.lisp

Packages

core

Exported Definitions

Previous: , Up: Lisp files   [Contents][Index]

2.1.3 clite/clite.lisp

Dependency

core.lisp (file)

Parent

clite (system)

Location

clite.lisp

Packages

clite

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

3.1 core

Source

core.lisp (file)

Use List

common-lisp

Used By List

clite

Exported Definitions

Previous: , Up: Packages   [Contents][Index]

3.2 clite

Source

clite.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Definitions   [Contents][Index]

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.2 Macros

Macro: define-ops &rest OPS
Package

clite

Source

clite.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
clite.asd: The clite<dot>asd file
clite/clite.lisp: The clite/clite<dot>lisp file
clite/core.lisp: The clite/core<dot>lisp file

F
File, Lisp, clite.asd: The clite<dot>asd file
File, Lisp, clite/clite.lisp: The clite/clite<dot>lisp file
File, Lisp, clite/core.lisp: The clite/core<dot>lisp file

L
Lisp File, clite.asd: The clite<dot>asd file
Lisp File, clite/clite.lisp: The clite/clite<dot>lisp file
Lisp File, clite/core.lisp: The clite/core<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   C   D   F   K   L   M   P   R   S   T  
Index Entry  Section

A
assq: Exported macros

C
compose: Exported functions

D
define-ops: Internal macros
defmac: Exported macros
do-until: Exported macros
do-while: Exported macros
do-with: Exported macros
dolist-reverse: Exported macros
doplist: Exported macros

F
filter: Exported functions
flatten: Exported functions
Function, compose: Exported functions
Function, filter: Exported functions
Function, flatten: Exported functions
Function, kw: Exported functions
Function, mapcars: Exported functions
Function, maptree: Exported functions
Function, plist-remove-if: Exported functions
Function, prob: Exported functions
Function, remove-tree: Exported functions
Function, run?: Internal functions
Function, str: Exported functions
Function, sym: Exported functions
Function, sym<: Exported functions
Function, test-eq: Exported functions
Function, test-eql: Exported functions
Function, test-equal: Exported functions
Function, test-equalp: Exported functions
Function, test-fail: Exported functions
Function, test-pass: Exported functions
Function, test-string=: Exported functions
Function, test=: Exported functions
Function, testp: Exported functions

K
kw: Exported functions

L
let-if: Exported macros

M
Macro, assq: Exported macros
Macro, define-ops: Internal macros
Macro, defmac: Exported macros
Macro, do-until: Exported macros
Macro, do-while: Exported macros
Macro, do-with: Exported macros
Macro, dolist-reverse: Exported macros
Macro, doplist: Exported macros
Macro, let-if: Exported macros
Macro, memq: Exported macros
Macro, mexpand: Exported macros
Macro, rassq: Exported macros
Macro, run-tests: Exported macros
Macro, test: Exported macros
mapcars: Exported functions
maptree: Exported functions
memq: Exported macros
mexpand: Exported macros

P
plist-remove-if: Exported functions
prob: Exported functions

R
rassq: Exported macros
remove-tree: Exported functions
run-tests: Exported macros
run?: Internal functions

S
str: Exported functions
sym: Exported functions
sym<: Exported functions

T
test: Exported macros
test-eq: Exported functions
test-eql: Exported functions
test-equal: Exported functions
test-equalp: Exported functions
test-fail: Exported functions
test-pass: Exported functions
test-string=: Exported functions
test=: Exported functions
testp: Exported functions

Jump to:   A   C   D   F   K   L   M   P   R   S   T  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   R   S   T  
Index Entry  Section

R
running-tags: Internal special variables

S
Special Variable, running-tags: Internal special variables
Special Variable, test-count: Internal special variables
Special Variable, tests: Internal special variables

T
test-count: Internal special variables
tests: Internal special variables

Jump to:   R   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
clite: The clite system
clite: The clite package
core: The core package

P
Package, clite: The clite package
Package, core: The core package

S
System, clite: The clite system

Jump to:   C   P   S