14.2 Displaying a Code Coverage data

The Code Coverage Browser displays the data as a list, where each line corresponds to a file. Each line starts with a relative path, which is currently always the cl:file-namestring of the file, followed by columns showing statistics about code coverage in this file, and ends with the full cl:truename of the file as recorded in the data. You can configure which columns are actually displayed via LispWorks > Preferences... > Files List .

The statistics columns are divided into "Runtime" and "All" columns, which correspond to the information returned when using the keyword :runtime or :all when accessing hcl:code-coverage-file-stats. In general "Runtime" excludes code that is normally executed only at compile time or load time. The numbers in the statistics columns are numbers of "lambdas" (pieces of code). See the entry for hcl:code-coverage-file-stats in the LispWorks User Guide and Reference Manual for more details. By default, only the "Runtime" columns are displayed.

For each of "Runtime" or "All", there are 4 columns:

Number

Number of lambdas.

Not Called

Number and percentage of lambdas that have never been called.

Not Covered

Number and percentage of lambdas that have been called, but not completely covered.

Called

Number and percentage of lambdas that have been called.

By default, only the Runtime Not Called and Runtime Not Covered columns are displayed, based on the assumption that these are the most useful ones.

For columns that display both number and percentage, the number is the number of lambdas, and the percentage is this number as a percentage of the total number of lambdas. You can configure which of the number or percentage is the "leading" value via LispWorks > Preferences... > Files List > Sort By , by selecting Percent or Number . This also affects the sorting. You can also configure it to display only one of the percentage or the number by deselecting Display Both Percent And Number in the Files List tab.

By default, the tool displays all the files in the specified code coverage data. You can restrict which files are displayed by several mechanisms:

• The list has a standard filter above it, which allows filtering on the displayed text. Since the default display contains the truename, this gives you an easy way of filtering by filenames or directories. For example, if you want to see only the files in directory dir-a, just type /dir-a/ in the filter. Note that the filter also supports regular expressions. See Filtering information for full details of using the standard filter.
• You can explicitly hide files by using the context menu (see Code Coverage Files List Context Menu). This is useful when you are no longer interested in code coverage for a specific source file.
• In LispWorks > Preferences... > Files List , you can select a filter such as Runtime Uncovered . Only files containing lambdas matching the filter are shown.

LispWorks IDE User Guide (Macintosh version) - 13 Sep 2017