The rt Reference Manual

Table of Contents

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

The rt Reference Manual

This is the rt Reference Manual, version 1990.12.19, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:32:29 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 rt

Maintainer

Kevin M. Rosenberg <kmr@debian.org>

License

MIT

Description

MIT Regression Tester

Long Description

RT provides a framework for writing regression test suites

Version

1990.12.19

Source

rt.asd (file)

Component

rt.lisp (file)


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

Location

rt.asd

Systems

rt (system)


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

2.1.2 rt/rt.lisp

Parent

rt (system)

Location

rt.lisp

Packages

regression-test

Exported Definitions
Internal Definitions

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

3 Packages

Packages are listed by definition order.


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

3.1 regression-test

The MIT regression tester with pfdietz’s modifications

Source

rt.lisp (file)

Nicknames
Use List

common-lisp

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 Special variables

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

regression-test

Source

rt.lisp (file)

Special Variable: *test*

Current test name

Package

regression-test

Source

rt.lisp (file)


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

4.1.2 Macros

Macro: deftest NAME &rest BODY
Package

regression-test

Source

rt.lisp (file)


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

4.1.3 Functions

Function: continue-testing ()
Package

regression-test

Source

rt.lisp (file)

Function: do-test &optional NAME
Package

regression-test

Source

rt.lisp (file)

Function: do-tests &optional OUT
Package

regression-test

Source

rt.lisp (file)

Function: get-test &optional NAME
Package

regression-test

Source

rt.lisp (file)

Function: pending-tests ()
Package

regression-test

Source

rt.lisp (file)

Function: rem-all-tests ()
Package

regression-test

Source

rt.lisp (file)

Function: rem-test &optional NAME
Package

regression-test

Source

rt.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: *catch-errors*

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

Package

regression-test

Source

rt.lisp (file)

Special Variable: *compile-tests*

When true, compile the tests before running them.

Package

regression-test

Source

rt.lisp (file)

Special Variable: *debug*

For debugging

Package

regression-test

Source

rt.lisp (file)

Special Variable: *entries*

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

Package

regression-test

Source

rt.lisp (file)

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

Special Variable: *entries-tail*

Tail of the *entries* list

Package

regression-test

Source

rt.lisp (file)

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

Special Variable: *expected-failures*

A list of test names that are expected to fail.

Package

regression-test

Source

rt.lisp (file)

Special Variable: *in-test*

Used by TEST

Package

regression-test

Source

rt.lisp (file)

Special Variable: *notes*

A mapping from names of notes to note objects.

Package

regression-test

Source

rt.lisp (file)

Special Variable: *optimization-settings*
Package

regression-test

Source

rt.lisp (file)

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

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

Package

regression-test

Source

rt.lisp (file)


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

4.2.2 Macros

Macro: defn ENTRY
Package

regression-test

Source

rt.lisp (file)

Macro: defnote NAME CONTENTS &optional DISABLED
Package

regression-test

Source

rt.lisp (file)


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

4.2.3 Functions

Function: add-entry ENTRY
Package

regression-test

Source

rt.lisp (file)

Function: copy-entry INSTANCE
Package

regression-test

Source

rt.lisp (file)

Function: copy-note INSTANCE
Package

regression-test

Source

rt.lisp (file)

Function: disable-note N
Package

regression-test

Source

rt.lisp (file)

Function: do-entries S
Package

regression-test

Source

rt.lisp (file)

Function: do-entries* S
Package

regression-test

Source

rt.lisp (file)

Function: do-entry ENTRY &optional S
Package

regression-test

Source

rt.lisp (file)

Function: enable-note N
Package

regression-test

Source

rt.lisp (file)

Function: entry-notes ENTRY
Package

regression-test

Source

rt.lisp (file)

Function: entry-p OBJECT
Package

regression-test

Source

rt.lisp (file)

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

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

Function: form INSTANCE
Function: (setf form) VALUE INSTANCE
Package

regression-test

Source

rt.lisp (file)

Function: get-entry NAME
Package

regression-test

Source

rt.lisp (file)

Function: has-disabled-note ENTRY
Package

regression-test

Source

rt.lisp (file)

Function: make-entry &key (PEND PEND) (NAME NAME) (PROPS PROPS) (FORM FORM) (VALS VALS)
Package

regression-test

Source

rt.lisp (file)

Function: make-note &key (NAME NAME) (CONTENTS CONTENTS) (DISABLED DISABLED)
Package

regression-test

Source

rt.lisp (file)

Function: my-aref A &rest ARGS
Package

regression-test

Source

rt.lisp (file)

Function: my-row-major-aref A INDEX
Package

regression-test

Source

rt.lisp (file)

Function: name INSTANCE
Function: (setf name) VALUE INSTANCE
Package

regression-test

Source

rt.lisp (file)

Function: note-contents INSTANCE
Function: (setf note-contents) VALUE INSTANCE
Package

regression-test

Source

rt.lisp (file)

Function: note-disabled INSTANCE
Function: (setf note-disabled) VALUE INSTANCE
Package

regression-test

Source

rt.lisp (file)

Function: note-name INSTANCE
Function: (setf note-name) VALUE INSTANCE
Package

regression-test

Source

rt.lisp (file)

Function: note-p OBJECT
Package

regression-test

Source

rt.lisp (file)

Function: pend INSTANCE
Function: (setf pend) VALUE INSTANCE
Package

regression-test

Source

rt.lisp (file)

Function: props INSTANCE
Function: (setf props) VALUE INSTANCE
Package

regression-test

Source

rt.lisp (file)

Function: report-error ERROR? &rest ARGS
Package

regression-test

Source

rt.lisp (file)

Function: vals INSTANCE
Function: (setf vals) VALUE INSTANCE
Package

regression-test

Source

rt.lisp (file)


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

4.2.4 Structures

Structure: entry ()
Package

regression-test

Source

rt.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: pend
Readers

pend (function)

Writers

(setf pend) (function)

Slot: name
Readers

name (function)

Writers

(setf name) (function)

Slot: props
Readers

props (function)

Writers

(setf props) (function)

Slot: form
Readers

form (function)

Writers

(setf form) (function)

Slot: vals
Readers

vals (function)

Writers

(setf vals) (function)

Structure: note ()
Package

regression-test

Source

rt.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: name
Readers

note-name (function)

Writers

(setf note-name) (function)

Slot: contents
Readers

note-contents (function)

Writers

(setf note-contents) (function)

Slot: disabled
Readers

note-disabled (function)

Writers

(setf note-disabled) (function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   R  
Index Entry  Section

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

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

R
rt.asd: The rt<dot>asd file
rt/rt.lisp: The rt/rt<dot>lisp file

Jump to:   F   L   R  

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

A.2 Functions

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

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

A
add-entry: Internal functions

C
continue-testing: Exported functions
copy-entry: Internal functions
copy-note: Internal functions

D
defn: Internal macros
defnote: Internal macros
deftest: Exported macros
disable-note: Internal functions
do-entries: Internal functions
do-entries*: Internal functions
do-entry: Internal functions
do-test: Exported functions
do-tests: Exported functions

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

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

G
get-entry: Internal functions
get-test: Exported functions

H
has-disabled-note: Internal functions

M
Macro, defn: Internal macros
Macro, defnote: Internal macros
Macro, deftest: Exported macros
make-entry: Internal functions
make-note: Internal functions
my-aref: Internal functions
my-row-major-aref: Internal functions

N
name: Internal functions
note-contents: Internal functions
note-disabled: Internal functions
note-name: Internal functions
note-p: Internal functions

P
pend: Internal functions
pending-tests: Exported functions
props: Internal functions

R
rem-all-tests: Exported functions
rem-test: Exported functions
report-error: Internal functions

V
vals: Internal functions

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

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

A.3 Variables

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

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

C
contents: Internal structures

D
disabled: Internal structures

F
form: Internal structures

N
name: Internal structures
name: Internal structures

P
pend: Internal structures
props: Internal structures

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

V
vals: Internal structures

Jump to:   *  
C   D   F   N   P   S   V  

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

A.4 Data types

Jump to:   E   N   P   R   S  
Index Entry  Section

E
entry: Internal structures

N
note: Internal structures

P
Package, regression-test: The regression-test package

R
regression-test: The regression-test package
rt: The rt system

S
Structure, entry: Internal structures
Structure, note: Internal structures
System, rt: The rt system

Jump to:   E   N   P   R   S