The rt Reference Manual

This is the rt Reference Manual, version 1990.12.19, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:49:01 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 rt

MIT Regression Tester

Maintainer

Kevin M. Rosenberg <>

License

MIT

Long Description

RT provides a framework for writing regression test suites

Version

1990.12.19

Source

rt.asd.

Child Component

rt.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 rt/rt.asd

Source

rt.asd.

Parent Component

rt (system).

ASDF Systems

rt.


2.1.2 rt/rt.lisp

Source

rt.asd.

Parent Component

rt (system).

Packages

regression-test.

Public Interface
Internals

3 Packages

Packages are listed by definition order.


3.1 regression-test

The MIT regression tester with pfdietz’s modifications

Source

rt.lisp.

Nicknames
  • rtest
  • rt
Use List

common-lisp.

Public Interface
Internals

4 Definitions

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


4.1 Public Interface


4.1.1 Special variables

Special Variable: *do-tests-when-defined*
Package

regression-test.

Source

rt.lisp.

Special Variable: *test*

Current test name

Package

regression-test.

Source

rt.lisp.


4.1.2 Macros

Macro: deftest (name &rest body)
Package

regression-test.

Source

rt.lisp.


4.1.3 Ordinary functions

Function: continue-testing ()
Package

regression-test.

Source

rt.lisp.

Function: do-test (&optional name)
Package

regression-test.

Source

rt.lisp.

Function: do-tests (&optional out)
Package

regression-test.

Source

rt.lisp.

Function: get-test (&optional name)
Package

regression-test.

Source

rt.lisp.

Function: pending-tests ()
Package

regression-test.

Source

rt.lisp.

Function: rem-all-tests ()
Package

regression-test.

Source

rt.lisp.

Function: rem-test (&optional name)
Package

regression-test.

Source

rt.lisp.


4.2 Internals


4.2.1 Special variables

Special Variable: *catch-errors*

When true, causes errors in a test to be caught.

Package

regression-test.

Source

rt.lisp.

Special Variable: *compile-tests*

When true, compile the tests before running them.

Package

regression-test.

Source

rt.lisp.

Special Variable: *debug*

For debugging

Package

regression-test.

Source

rt.lisp.

Special Variable: *entries*

Test database. Has a leading dummy cell that does not contain an entry.

Package

regression-test.

Source

rt.lisp.

Special Variable: *entries-table*

Map the names of entries to the cons cell in *entries* that precedes the one whose car is the entry.

Package

regression-test.

Source

rt.lisp.

Special Variable: *entries-tail*

Tail of the *entries* list

Package

regression-test.

Source

rt.lisp.

Special Variable: *expanded-eval*

When true, convert the tests into a form that is less likely to have compiler optimizations.

Package

regression-test.

Source

rt.lisp.

Special Variable: *expected-failures*

A list of test names that are expected to fail.

Package

regression-test.

Source

rt.lisp.

Special Variable: *in-test*

Used by TEST

Package

regression-test.

Source

rt.lisp.

Special Variable: *notes*

A mapping from names of notes to note objects.

Package

regression-test.

Source

rt.lisp.

Special Variable: *optimization-settings*
Package

regression-test.

Source

rt.lisp.

Special Variable: *print-circle-on-failure*

Failure reports are printed with *PRINT-CIRCLE* bound to this value.

Package

regression-test.

Source

rt.lisp.


4.2.2 Macros

Macro: defn (entry)
Package

regression-test.

Source

rt.lisp.

Macro: defnote (name contents &optional disabled)
Package

regression-test.

Source

rt.lisp.


4.2.3 Ordinary functions

Function: add-entry (entry)
Package

regression-test.

Source

rt.lisp.

Function: copy-entry (instance)
Package

regression-test.

Source

rt.lisp.

Function: copy-note (instance)
Package

regression-test.

Source

rt.lisp.

Function: disable-note (n)
Package

regression-test.

Source

rt.lisp.

Function: do-entries (s)
Package

regression-test.

Source

rt.lisp.

Function: do-entries* (s)
Package

regression-test.

Source

rt.lisp.

Function: do-entry (entry &optional s)
Package

regression-test.

Source

rt.lisp.

Function: enable-note (n)
Package

regression-test.

Source

rt.lisp.

Function: entry-notes (entry)
Package

regression-test.

Source

rt.lisp.

Function: entry-p (object)
Package

regression-test.

Source

rt.lisp.

Function: equalp-with-case (x y)

Like EQUALP, but doesn’t do case conversion of characters. Currently doesn’t work on arrays of dimension > 2.

Package

regression-test.

Source

rt.lisp.

Function: expanded-eval (form)

Split off top level of a form and eval separately. This reduces the chance that compiler optimizations will fold away runtime computation.

Package

regression-test.

Source

rt.lisp.

Reader: form (instance)
Writer: (setf form) (instance)
Package

regression-test.

Source

rt.lisp.

Target Slot

form.

Function: get-entry (name)
Package

regression-test.

Source

rt.lisp.

Function: has-disabled-note (entry)
Package

regression-test.

Source

rt.lisp.

Function: make-entry (&key pend name props form vals)
Package

regression-test.

Source

rt.lisp.

Function: make-note (&key name contents disabled)
Package

regression-test.

Source

rt.lisp.

Function: my-aref (a &rest args)
Package

regression-test.

Source

rt.lisp.

Function: my-row-major-aref (a index)
Package

regression-test.

Source

rt.lisp.

Reader: name (instance)
Writer: (setf name) (instance)
Package

regression-test.

Source

rt.lisp.

Target Slot

name.

Reader: note-contents (instance)
Writer: (setf note-contents) (instance)
Package

regression-test.

Source

rt.lisp.

Target Slot

contents.

Reader: note-disabled (instance)
Writer: (setf note-disabled) (instance)
Package

regression-test.

Source

rt.lisp.

Target Slot

disabled.

Reader: note-name (instance)
Writer: (setf note-name) (instance)
Package

regression-test.

Source

rt.lisp.

Target Slot

name.

Function: note-p (object)
Package

regression-test.

Source

rt.lisp.

Reader: pend (instance)
Writer: (setf pend) (instance)
Package

regression-test.

Source

rt.lisp.

Target Slot

pend.

Reader: props (instance)
Writer: (setf props) (instance)
Package

regression-test.

Source

rt.lisp.

Target Slot

props.

Function: report-error (error? &rest args)
Package

regression-test.

Source

rt.lisp.

Reader: vals (instance)
Writer: (setf vals) (instance)
Package

regression-test.

Source

rt.lisp.

Target Slot

vals.


4.2.4 Structures

Structure: entry
Package

regression-test.

Source

rt.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: pend
Readers

pend.

Writers

(setf pend).

Slot: name
Readers

name.

Writers

(setf name).

Slot: props
Readers

props.

Writers

(setf props).

Slot: form
Readers

form.

Writers

(setf form).

Slot: vals
Readers

vals.

Writers

(setf vals).

Structure: note
Package

regression-test.

Source

rt.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: name
Readers

note-name.

Writers

(setf note-name).

Slot: contents
Readers

note-contents.

Writers

(setf note-contents).

Slot: disabled
Readers

note-disabled.

Writers

(setf note-disabled).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   E   F   G   H   M   N   P   R   V  
Index Entry  Section

(
(setf form): Private ordinary functions
(setf name): Private ordinary functions
(setf note-contents): Private ordinary functions
(setf note-disabled): Private ordinary functions
(setf note-name): Private ordinary functions
(setf pend): Private ordinary functions
(setf props): Private ordinary functions
(setf vals): Private ordinary functions

A
add-entry: Private ordinary functions

C
continue-testing: Public ordinary functions
copy-entry: Private ordinary functions
copy-note: Private ordinary functions

D
defn: Private macros
defnote: Private macros
deftest: Public macros
disable-note: Private ordinary functions
do-entries: Private ordinary functions
do-entries*: Private ordinary functions
do-entry: Private ordinary functions
do-test: Public ordinary functions
do-tests: Public ordinary functions

E
enable-note: Private ordinary functions
entry-notes: Private ordinary functions
entry-p: Private ordinary functions
equalp-with-case: Private ordinary functions
expanded-eval: Private ordinary functions

F
form: Private ordinary functions
Function, (setf form): Private ordinary functions
Function, (setf name): Private ordinary functions
Function, (setf note-contents): Private ordinary functions
Function, (setf note-disabled): Private ordinary functions
Function, (setf note-name): Private ordinary functions
Function, (setf pend): Private ordinary functions
Function, (setf props): Private ordinary functions
Function, (setf vals): Private ordinary functions
Function, add-entry: Private ordinary functions
Function, continue-testing: Public ordinary functions
Function, copy-entry: Private ordinary functions
Function, copy-note: Private ordinary functions
Function, disable-note: Private ordinary functions
Function, do-entries: Private ordinary functions
Function, do-entries*: Private ordinary functions
Function, do-entry: Private ordinary functions
Function, do-test: Public ordinary functions
Function, do-tests: Public ordinary functions
Function, enable-note: Private ordinary functions
Function, entry-notes: Private ordinary functions
Function, entry-p: Private ordinary functions
Function, equalp-with-case: Private ordinary functions
Function, expanded-eval: Private ordinary functions
Function, form: Private ordinary functions
Function, get-entry: Private ordinary functions
Function, get-test: Public ordinary functions
Function, has-disabled-note: Private ordinary functions
Function, make-entry: Private ordinary functions
Function, make-note: Private ordinary functions
Function, my-aref: Private ordinary functions
Function, my-row-major-aref: Private ordinary functions
Function, name: Private ordinary functions
Function, note-contents: Private ordinary functions
Function, note-disabled: Private ordinary functions
Function, note-name: Private ordinary functions
Function, note-p: Private ordinary functions
Function, pend: Private ordinary functions
Function, pending-tests: Public ordinary functions
Function, props: Private ordinary functions
Function, rem-all-tests: Public ordinary functions
Function, rem-test: Public ordinary functions
Function, report-error: Private ordinary functions
Function, vals: Private ordinary functions

G
get-entry: Private ordinary functions
get-test: Public ordinary functions

H
has-disabled-note: Private ordinary functions

M
Macro, defn: Private macros
Macro, defnote: Private macros
Macro, deftest: Public macros
make-entry: Private ordinary functions
make-note: Private ordinary functions
my-aref: Private ordinary functions
my-row-major-aref: Private ordinary functions

N
name: Private ordinary functions
note-contents: Private ordinary functions
note-disabled: Private ordinary functions
note-name: Private ordinary functions
note-p: Private ordinary functions

P
pend: Private ordinary functions
pending-tests: Public ordinary functions
props: Private ordinary functions

R
rem-all-tests: Public ordinary functions
rem-test: Public ordinary functions
report-error: Private ordinary functions

V
vals: Private ordinary functions


A.3 Variables

Jump to:   *  
C   D   F   N   P   S   V  
Index Entry  Section

*
*catch-errors*: Private special variables
*compile-tests*: Private special variables
*debug*: Private special variables
*do-tests-when-defined*: Public special variables
*entries*: Private special variables
*entries-table*: Private special variables
*entries-tail*: Private special variables
*expanded-eval*: Private special variables
*expected-failures*: Private special variables
*in-test*: Private special variables
*notes*: Private special variables
*optimization-settings*: Private special variables
*print-circle-on-failure*: Private special variables
*test*: Public special variables

C
contents: Private structures

D
disabled: Private structures

F
form: Private structures

N
name: Private structures
name: Private structures

P
pend: Private structures
props: Private structures

S
Slot, contents: Private structures
Slot, disabled: Private structures
Slot, form: Private structures
Slot, name: Private structures
Slot, name: Private structures
Slot, pend: Private structures
Slot, props: Private structures
Slot, vals: Private structures
Special Variable, *catch-errors*: Private special variables
Special Variable, *compile-tests*: Private special variables
Special Variable, *debug*: Private special variables
Special Variable, *do-tests-when-defined*: Public special variables
Special Variable, *entries*: Private special variables
Special Variable, *entries-table*: Private special variables
Special Variable, *entries-tail*: Private special variables
Special Variable, *expanded-eval*: Private special variables
Special Variable, *expected-failures*: Private special variables
Special Variable, *in-test*: Private special variables
Special Variable, *notes*: Private special variables
Special Variable, *optimization-settings*: Private special variables
Special Variable, *print-circle-on-failure*: Private special variables
Special Variable, *test*: Public special variables

V
vals: Private structures