The cl-annot-prove Reference Manual

This is the cl-annot-prove Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 19:51:00 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-annot-prove

Annotation Syntax Test Library.

Author

Rudolph Miller

Home Page

https://github.com/Rudolph-Miller/cl-annot-prove

License

MIT

Long Description

# Cl-Annot-Prove - Annotation Syntax Test Library.
[![Build Status](https://circleci.com/gh/Rudolph-Miller/cl-annot-prove.svg?style=shield)](https://circleci.com/gh/Rudolph-Miller/cl-annot-prove)

## API

See [Document](https://rudolph-miller.github.io/cl-annot-prove/overview.html).
This HTML is generated by [Codex](https://github.com/CommonDoc/codex).

## Author

* Rudolph Miller (chopsticks.tk.ppfm@gmail.com)

## Copyright

Copyright (c) 2015 Rudolph Miller (chopsticks.tk.ppfm@gmail.com)

## License

Licensed under the MIT License.

Version

0.1

Dependencies
  • cl-syntax (system).
  • cl-syntax-annot (system).
  • cl-ppcre (system).
  • prove (system).
  • trivial-types (system).
  • cl-fad (system).
Source

cl-annot-prove.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-annot-prove/src

Source

cl-annot-prove.asd.

Parent Component

cl-annot-prove (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 cl-annot-prove/cl-annot-prove.asd

Source

cl-annot-prove.asd.

Parent Component

cl-annot-prove (system).

ASDF Systems

cl-annot-prove.

Packages

cl-annot-prove-asd.


4.1.3 cl-annot-prove/src/render.lisp

Dependency

struct.lisp (file).

Source

cl-annot-prove.asd.

Parent Component

src (module).

Packages

cl-annot-prove.render.

Public Interface
Internals

4.1.4 cl-annot-prove/src/helper.lisp

Dependency

render.lisp (file).

Source

cl-annot-prove.asd.

Parent Component

src (module).

Packages

cl-annot-prove.helper.

Public Interface
Internals

4.1.5 cl-annot-prove/src/annotation.lisp

Dependency

helper.lisp (file).

Source

cl-annot-prove.asd.

Parent Component

src (module).

Packages

cl-annot-prove.annotation.

Public Interface
Internals

deftests-annotation (macro).


4.1.6 cl-annot-prove/src/cl-annot-prove.lisp

Dependency

annotation.lisp (file).

Source

cl-annot-prove.asd.

Parent Component

src (module).

Packages

cl-annot-prove.


5 Packages

Packages are listed by definition order.


5.1 cl-annot-prove

Source

cl-annot-prove.lisp.

Nickname

annot.prove

Use List

prove.


5.2 cl-annot-prove.helper

Source

helper.lisp.

Use List
Used By List

cl-annot-prove.annotation.

Public Interface
Internals

5.3 cl-annot-prove.annotation

Source

annotation.lisp.

Use List
Public Interface
Internals

deftests-annotation (macro).


5.4 cl-annot-prove-asd

Source

cl-annot-prove.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.5 cl-annot-prove.render

Source

render.lisp.

Use List
Used By List

cl-annot-prove.helper.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *symbol-tests-list*

List of #S(SYMBOL-TESTS ...)s.

Package

cl-annot-prove.struct.

Source

struct.lisp.


6.1.2 Macros

Macro: tests (form1 definition-form0)
Package

cl-annot-prove.annotation.

Source

annotation.lisp.

Macro: tests.after (form1 definition-form0)
Package

cl-annot-prove.annotation.

Source

annotation.lisp.

Macro: tests.after.each (form1 definition-form0)
Package

cl-annot-prove.annotation.

Source

annotation.lisp.

Macro: tests.around (form1 definition-form0)
Package

cl-annot-prove.annotation.

Source

annotation.lisp.

Macro: tests.around.each (form1 definition-form0)
Package

cl-annot-prove.annotation.

Source

annotation.lisp.

Macro: tests.before (form1 definition-form0)
Package

cl-annot-prove.annotation.

Source

annotation.lisp.

Macro: tests.before.each (form1 definition-form0)
Package

cl-annot-prove.annotation.

Source

annotation.lisp.


6.1.3 Ordinary functions

Function: add-symbol-tests (symbol-tests)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Function: call-tests ()
Package

cl-annot-prove.render.

Source

render.lisp.

Function: make-symbol-tests (symbol &key tests before after around before-each after-each around-each load-pathname)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Function: make-test-document (&key got expected)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Function: query-symbol-tests (&key symbol symbol-name symbol-package symbol-tests-list)

Return list of #S(SYMBOL-TESTS ...)s which match the conditions.

Package

cl-annot-prove.helper.

Source

helper.lisp.

Function: render-around (symbol-tests)
Package

cl-annot-prove.render.

Source

render.lisp.

Function: render-method-chain (main &key before after around)
Package

cl-annot-prove.render.

Source

render.lisp.

Function: render-symbol-tests (symbol-tests)

Render #S(SYMBOL-TESTS ...) for documents.

Package

cl-annot-prove.render.

Source

render.lisp.

Function: replace-call-tests (form new)
Package

cl-annot-prove.render.

Source

render.lisp.

Function: replace-test-form (test-form around)
Package

cl-annot-prove.render.

Source

render.lisp.

Function: replace-test-with-setq-form (form)
Package

cl-annot-prove.render.

Source

render.lisp.

Function: run-package-tests (package)

Run symbol-tests in the package.

Package

cl-annot-prove.helper.

Source

helper.lisp.

Function: run-symbol-tests (symbol-tests)

Run symbol-tests.

Package

cl-annot-prove.helper.

Source

helper.lisp.

Function: run-system-tests (system-designator &key reload-system)

Run symbol-tests in the system.

Package

cl-annot-prove.helper.

Source

helper.lisp.

Reader: symbol-tests-after (instance)
Writer: (setf symbol-tests-after) (instance)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Target Slot

after.

Reader: symbol-tests-after-each (instance)
Writer: (setf symbol-tests-after-each) (instance)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Target Slot

after-each.

Reader: symbol-tests-around (instance)
Writer: (setf symbol-tests-around) (instance)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Target Slot

around.

Reader: symbol-tests-around-each (instance)
Writer: (setf symbol-tests-around-each) (instance)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Target Slot

around-each.

Reader: symbol-tests-before (instance)
Writer: (setf symbol-tests-before) (instance)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Target Slot

before.

Reader: symbol-tests-before-each (instance)
Writer: (setf symbol-tests-before-each) (instance)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Target Slot

before-each.

Reader: symbol-tests-load-pathname (instance)
Writer: (setf symbol-tests-load-pathname) (instance)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Target Slot

load-pathname.

Reader: symbol-tests-symbol (instance)
Writer: (setf symbol-tests-symbol) (instance)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Target Slot

symbol.

Reader: symbol-tests-tests (instance)
Writer: (setf symbol-tests-tests) (instance)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Target Slot

tests.

Function: system-symbol-tests-list (system-designator &key reload-system)

Return list of #S(SYMBOL-TESTS ...)s in the system.

Package

cl-annot-prove.helper.

Source

helper.lisp.

Reader: test-document-expected (instance)
Writer: (setf test-document-expected) (instance)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Target Slot

expected.

Reader: test-document-got (instance)
Writer: (setf test-document-got) (instance)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Target Slot

got.


6.1.4 Generic functions

Generic Function: expected-formatter (operator)
Package

cl-annot-prove.render.

Source

render.lisp.

Methods
Method: expected-formatter ((operator0 (eql prove.test:is-expand)))
Method: expected-formatter ((operator0 (eql prove.test:like)))
Method: expected-formatter ((operator0 (eql prove.test:is-type)))
Method: expected-formatter ((operator0 (eql prove.test:is-error)))
Method: expected-formatter ((operator0 (eql prove.test:is-print)))
Method: expected-formatter ((operator0 (eql prove.test:is-values)))
Method: expected-formatter ((operator0 (eql prove.test:isnt)))
Method: expected-formatter ((operator0 (eql prove.test:is)))
Method: expected-formatter ((operator0 (eql prove.test:ok)))
Method: expected-formatter (operator)

6.1.5 Standalone methods

Method: print-object ((object test-document) stream)
Source

struct.lisp.


6.1.6 Structures

Structure: symbol-tests

Structure of tests for symbol.

Package

cl-annot-prove.struct.

Source

struct.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: symbol
Package

common-lisp.

Type

symbol

Readers

symbol-tests-symbol.

Writers

(setf symbol-tests-symbol).

Slot: tests
Type

list

Readers

symbol-tests-tests.

Writers

(setf symbol-tests-tests).

Slot: before
Readers

symbol-tests-before.

Writers

(setf symbol-tests-before).

Slot: after
Readers

symbol-tests-after.

Writers

(setf symbol-tests-after).

Slot: around
Readers

symbol-tests-around.

Writers

(setf symbol-tests-around).

Slot: before-each
Readers

symbol-tests-before-each.

Writers

(setf symbol-tests-before-each).

Slot: after-each
Readers

symbol-tests-after-each.

Writers

(setf symbol-tests-after-each).

Slot: around-each
Readers

symbol-tests-around-each.

Writers

(setf symbol-tests-around-each).

Slot: load-pathname
Type

(or null pathname)

Readers

symbol-tests-load-pathname.

Writers

(setf symbol-tests-load-pathname).

Structure: test-document
Package

cl-annot-prove.struct.

Source

struct.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: got
Readers

test-document-got.

Writers

(setf test-document-got).

Slot: expected
Readers

test-document-expected.

Writers

(setf test-document-expected).


6.2 Internals


6.2.1 Macros

Macro: def-expected-formatter ((symbol expected) &body body)
Package

cl-annot-prove.render.

Source

render.lisp.

Macro: deftests-annotation (name accessor)
Package

cl-annot-prove.annotation.

Source

annotation.lisp.

Macro: stub-progn (&body body)
Package

cl-annot-prove.render.

Source

render.lisp.


6.2.2 Ordinary functions

Function: copy-symbol-tests (instance)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Function: copy-test-document (instance)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Function: eval-silently (form)
Package

cl-annot-prove.render.

Source

render.lisp.

Function: format-expected (expected)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Function: load-system-silestly (system-designator)
Package

cl-annot-prove.helper.

Source

helper.lisp.

Function: replace-stub-progn (form)
Package

cl-annot-prove.render.

Source

render.lisp.

Function: run-symbol-tests-list (symbol-tests-list)
Package

cl-annot-prove.helper.

Source

helper.lisp.

Function: symbol-tests-p (object)
Package

cl-annot-prove.struct.

Source

struct.lisp.

Function: test-document-p (object)
Package

cl-annot-prove.struct.

Source

struct.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   E   F   G   L   M   P   Q   R   S   T  
Index Entry  Section

(
(setf symbol-tests-after): Public ordinary functions
(setf symbol-tests-after-each): Public ordinary functions
(setf symbol-tests-around): Public ordinary functions
(setf symbol-tests-around-each): Public ordinary functions
(setf symbol-tests-before): Public ordinary functions
(setf symbol-tests-before-each): Public ordinary functions
(setf symbol-tests-load-pathname): Public ordinary functions
(setf symbol-tests-symbol): Public ordinary functions
(setf symbol-tests-tests): Public ordinary functions
(setf test-document-expected): Public ordinary functions
(setf test-document-got): Public ordinary functions

A
add-symbol-tests: Public ordinary functions

C
call-tests: Public ordinary functions
copy-symbol-tests: Private ordinary functions
copy-test-document: Private ordinary functions

D
def-expected-formatter: Private macros
deftests-annotation: Private macros

E
eval-silently: Private ordinary functions
expected-formatter: Public generic functions
expected-formatter: Public generic functions
expected-formatter: Public generic functions
expected-formatter: Public generic functions
expected-formatter: Public generic functions
expected-formatter: Public generic functions
expected-formatter: Public generic functions
expected-formatter: Public generic functions
expected-formatter: Public generic functions
expected-formatter: Public generic functions
expected-formatter: Public generic functions

F
format-expected: Private ordinary functions
Function, (setf symbol-tests-after): Public ordinary functions
Function, (setf symbol-tests-after-each): Public ordinary functions
Function, (setf symbol-tests-around): Public ordinary functions
Function, (setf symbol-tests-around-each): Public ordinary functions
Function, (setf symbol-tests-before): Public ordinary functions
Function, (setf symbol-tests-before-each): Public ordinary functions
Function, (setf symbol-tests-load-pathname): Public ordinary functions
Function, (setf symbol-tests-symbol): Public ordinary functions
Function, (setf symbol-tests-tests): Public ordinary functions
Function, (setf test-document-expected): Public ordinary functions
Function, (setf test-document-got): Public ordinary functions
Function, add-symbol-tests: Public ordinary functions
Function, call-tests: Public ordinary functions
Function, copy-symbol-tests: Private ordinary functions
Function, copy-test-document: Private ordinary functions
Function, eval-silently: Private ordinary functions
Function, format-expected: Private ordinary functions
Function, load-system-silestly: Private ordinary functions
Function, make-symbol-tests: Public ordinary functions
Function, make-test-document: Public ordinary functions
Function, query-symbol-tests: Public ordinary functions
Function, render-around: Public ordinary functions
Function, render-method-chain: Public ordinary functions
Function, render-symbol-tests: Public ordinary functions
Function, replace-call-tests: Public ordinary functions
Function, replace-stub-progn: Private ordinary functions
Function, replace-test-form: Public ordinary functions
Function, replace-test-with-setq-form: Public ordinary functions
Function, run-package-tests: Public ordinary functions
Function, run-symbol-tests: Public ordinary functions
Function, run-symbol-tests-list: Private ordinary functions
Function, run-system-tests: Public ordinary functions
Function, symbol-tests-after: Public ordinary functions
Function, symbol-tests-after-each: Public ordinary functions
Function, symbol-tests-around: Public ordinary functions
Function, symbol-tests-around-each: Public ordinary functions
Function, symbol-tests-before: Public ordinary functions
Function, symbol-tests-before-each: Public ordinary functions
Function, symbol-tests-load-pathname: Public ordinary functions
Function, symbol-tests-p: Private ordinary functions
Function, symbol-tests-symbol: Public ordinary functions
Function, symbol-tests-tests: Public ordinary functions
Function, system-symbol-tests-list: Public ordinary functions
Function, test-document-expected: Public ordinary functions
Function, test-document-got: Public ordinary functions
Function, test-document-p: Private ordinary functions

G
Generic Function, expected-formatter: Public generic functions

L
load-system-silestly: Private ordinary functions

M
Macro, def-expected-formatter: Private macros
Macro, deftests-annotation: Private macros
Macro, stub-progn: Private macros
Macro, tests: Public macros
Macro, tests.after: Public macros
Macro, tests.after.each: Public macros
Macro, tests.around: Public macros
Macro, tests.around.each: Public macros
Macro, tests.before: Public macros
Macro, tests.before.each: Public macros
make-symbol-tests: Public ordinary functions
make-test-document: Public ordinary functions
Method, expected-formatter: Public generic functions
Method, expected-formatter: Public generic functions
Method, expected-formatter: Public generic functions
Method, expected-formatter: Public generic functions
Method, expected-formatter: Public generic functions
Method, expected-formatter: Public generic functions
Method, expected-formatter: Public generic functions
Method, expected-formatter: Public generic functions
Method, expected-formatter: Public generic functions
Method, expected-formatter: Public generic functions
Method, print-object: Public standalone methods

P
print-object: Public standalone methods

Q
query-symbol-tests: Public ordinary functions

R
render-around: Public ordinary functions
render-method-chain: Public ordinary functions
render-symbol-tests: Public ordinary functions
replace-call-tests: Public ordinary functions
replace-stub-progn: Private ordinary functions
replace-test-form: Public ordinary functions
replace-test-with-setq-form: Public ordinary functions
run-package-tests: Public ordinary functions
run-symbol-tests: Public ordinary functions
run-symbol-tests-list: Private ordinary functions
run-system-tests: Public ordinary functions

S
stub-progn: Private macros
symbol-tests-after: Public ordinary functions
symbol-tests-after-each: Public ordinary functions
symbol-tests-around: Public ordinary functions
symbol-tests-around-each: Public ordinary functions
symbol-tests-before: Public ordinary functions
symbol-tests-before-each: Public ordinary functions
symbol-tests-load-pathname: Public ordinary functions
symbol-tests-p: Private ordinary functions
symbol-tests-symbol: Public ordinary functions
symbol-tests-tests: Public ordinary functions
system-symbol-tests-list: Public ordinary functions

T
test-document-expected: Public ordinary functions
test-document-got: Public ordinary functions
test-document-p: Private ordinary functions
tests: Public macros
tests.after: Public macros
tests.after.each: Public macros
tests.around: Public macros
tests.around.each: Public macros
tests.before: Public macros
tests.before.each: Public macros


A.4 Data types

Jump to:   A   C   F   H   M   P   R   S   T  
Index Entry  Section

A
annotation.lisp: The cl-annot-prove/src/annotation․lisp file

C
cl-annot-prove: The cl-annot-prove system
cl-annot-prove: The cl-annot-prove package
cl-annot-prove-asd: The cl-annot-prove-asd package
cl-annot-prove.annotation: The cl-annot-prove․annotation package
cl-annot-prove.asd: The cl-annot-prove/cl-annot-prove․asd file
cl-annot-prove.helper: The cl-annot-prove․helper package
cl-annot-prove.lisp: The cl-annot-prove/src/cl-annot-prove․lisp file
cl-annot-prove.render: The cl-annot-prove․render package
cl-annot-prove.struct: The cl-annot-prove․struct package

F
File, annotation.lisp: The cl-annot-prove/src/annotation․lisp file
File, cl-annot-prove.asd: The cl-annot-prove/cl-annot-prove․asd file
File, cl-annot-prove.lisp: The cl-annot-prove/src/cl-annot-prove․lisp file
File, helper.lisp: The cl-annot-prove/src/helper․lisp file
File, render.lisp: The cl-annot-prove/src/render․lisp file
File, struct.lisp: The cl-annot-prove/src/struct․lisp file

H
helper.lisp: The cl-annot-prove/src/helper․lisp file

M
Module, src: The cl-annot-prove/src module

P
Package, cl-annot-prove: The cl-annot-prove package
Package, cl-annot-prove-asd: The cl-annot-prove-asd package
Package, cl-annot-prove.annotation: The cl-annot-prove․annotation package
Package, cl-annot-prove.helper: The cl-annot-prove․helper package
Package, cl-annot-prove.render: The cl-annot-prove․render package
Package, cl-annot-prove.struct: The cl-annot-prove․struct package

R
render.lisp: The cl-annot-prove/src/render․lisp file

S
src: The cl-annot-prove/src module
struct.lisp: The cl-annot-prove/src/struct․lisp file
Structure, symbol-tests: Public structures
Structure, test-document: Public structures
symbol-tests: Public structures
System, cl-annot-prove: The cl-annot-prove system

T
test-document: Public structures