The trivial-coverage Reference Manual

This is the trivial-coverage Reference Manual, version 0.0.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:32:01 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-coverage

A simple Common Lisp library to print out the code coverage collected. Supports SBCL and CCL.

Author

Eric Diethelm <>

License

MIT

Version

0.0.4

Dependency

lquery (system).

Source

trivial-coverage.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 trivial-coverage/trivial-coverage.asd

Source

trivial-coverage.asd.

Parent Component

trivial-coverage (system).

ASDF Systems

trivial-coverage.


3.1.2 trivial-coverage/package.lisp

Source

trivial-coverage.asd.

Parent Component

trivial-coverage (system).

Packages

trivial-coverage.


3.1.3 trivial-coverage/trivial-coverage.lisp

Source

trivial-coverage.asd.

Parent Component

trivial-coverage (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 trivial-coverage

A simple Common Lisp library to print out the code coverage collected by sb-cover. As such it only supports SBCL.

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: get-coverage (report-path &key exclude)

Calculates the total code coverage reported by sb-cover (via the HTML report) and returns this value. *report-path* - the path to the directory containing the HTML coverage report
*exclude* - files to be excluded from the calculation

Package

trivial-coverage.

Source

trivial-coverage.lisp.

Function: test-and-print-coverage (system &key exclude keep-report stream)

Loads and tests the given *system* collecting coverage information. Also prints a line containing the coverage to *stream*. *system* - name of the system to be tested
*exclude* - files to be excluded from the calculation
*keep-report* - if NIL, the generated HTML coverage files are removed
*stream* - the stream to which the coverage result shall be written

Package

trivial-coverage.

Source

trivial-coverage.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: clear-coverage ()
Package

trivial-coverage.

Source

trivial-coverage.lisp.

Function: create-coverage-report (path)
Package

trivial-coverage.

Source

trivial-coverage.lisp.

Function: disable-coverage ()
Package

trivial-coverage.

Source

trivial-coverage.lisp.

Function: enable-coverage ()
Package

trivial-coverage.

Source

trivial-coverage.lisp.

Function: get-coverage-for-file (html)
Package

trivial-coverage.

Source

trivial-coverage.lisp.

Function: pprint-coverage (coverage &key stream)
Package

trivial-coverage.

Source

trivial-coverage.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables