Functions

Summary

Generate "deltas", which are code-coverage-data objects with information for a period.

Package

hcl

Signature

get-code-coverage-delta &key snapshot name => ccd

reset-code-coverage-snapshot => nil

set-code-coverage-snapshot => t

Arguments

snapshot

A boolean.

name

A Lisp object, normally a symbol or a string.

Values

ccd

A code-coverage-data object.

Description

The function get-code-coverage-delta returns a code-coverage-data object with information covering the period since the previous snapshot, and with name name. Normally this would be set by set-code-coverage-snapshot or get-code-coverage-delta with snapshot non-nil. If there was no such previous call, then the "delta" period commences, for each file, from the time it was loaded.

The function reset-code-coverage-snapshot eliminates any snapshot. This is useful because the snapshot uses memory.

The function set-code-coverage-snapshot creates a snapshot of the internal code coverage data, to be used by get-code-coverage-delta.

When snapshot is non-nil, get-code-coverage-delta sets up a new snapshot. This is more efficient than using set-code-coverage-snapshot again, but otherwise has the same effect. The default value of snapshot is nil.

Notes

1. The functions reset-code-coverage, clear-code-coverage and restore-code-coverage-data also eliminate the snapshot.
2. Code coverage manipulation functions like subtract-code-coverage-data can also be used to compute deltas, but get-code-coverage-delta will normally do it using less memory.

See also

clear-code-coverage
code-coverage-data
reset-code-coverage
restore-code-coverage-data
subtract-code-coverage-data