map-code-coverage-data

map-code-coverage-data Function

Summary

Calls a function on each of the files in a code-coverage-data object.

Package

hcl

Signature

map-code-coverage-data ccd function &key without-stats collect => list

Arguments

`ccd`⇩	A code-coverage-data object or `t`.
`function`⇩	A function designator.
`without-stats`⇩	A generalized boolean.
`collect`⇩	`nil`, `t` or `:truenames`.

Values

list

nil or a list either of truenames or of code-coverage-file-stats objects.

Description

The function map-code-coverage-data maps function over the files in ccd and optionally collects items for some of them. If ccd is t, this is interpreted as the internal code-coverage-data object.

The arguments passed to function depend on without-stats. If without-stats is false then function is called with the truename and a code-coverage-file-stats object for the file. If without-stats is true, then function is applied only to the truename. The default value of without-stats is false.

If collect is t (the default), then map-code-coverage-data collects the stats (when without-stats is false) or the truename (when without-stats is true) for each call to function that returns true. If collect is :truenames, then map-code-coverage-data collects the truename for each call to function that returns true.

When collect is nil, map-code-coverage-data returns nil. Otherwise, it returns a list of the objects it collected.