error-situation-forms Macro

Summary

Informs the compiler of "error situation" forms.

Package

hcl

Signature

error-situation-forms &body body => result

Arguments

body⇩

Lisp forms.

Values

result

The result of evaluating body.

Description

The macro error-situation-forms tells the compiler that a body of code comprises "error situation" forms.

body is evaluated as an implicit progn, but its forms are treated as "error situation" forms. Currently that means that the compiler does not generate code coverage inside body or for the (error-situation-forms ...) form itself, unless force was supplied non-nil to generate-code-coverage or with-code-coverage-generation.

In the future, it may also affect other parameters.

Notes

For code coverage, error-situation-forms differs from without-code-coverage in that it does not generate a counter for the (error-situation-forms ...) form itself, and therefore is more convenient to use.

Examples

(if (check-something)
    (ok-code)
  (error-situation-forms (call-error)))

See also

without-code-coverage
generate-code-coverage
with-code-coverage-generation