ZT_FALSE(3)

ZT_FALSE3

Construct a claim that a value is false

Usage

#include <zt.h>

#define ZT_FALSE(value) \
  zt_false( \
    ZT_CURRENT_LOCATION(), \
    zt_pack_boolean((value), #value)) \

zt_claim

zt_false(zt_location location, zt_value value);

Overview

zt_false() constructs a claim that a given value is false. It should be used through the macro ZT_FALSE(), which passes source code location and packs argument.

zt_false() can be used to check custom properties by calling arbitrary verification logic. The disadvantage of this approach is that on failure, the error message cannot precisely explain the problem.

Implementation notes

ZT_FALSE() evaluates value only once.

Return values

Both the macro and the function return a claim structure with the right attributes set. The returned claim is usually passed to zt_check() or to zt_assert().

Releases

Unchanged in 3 releases since Debian 11 (Bullseye).

  1. 11–13

History

The ZT_FALSE() macro and the zt_false() function first appeared in libzt 0.1

Authors

Zygmunt Krynicki ⟨[email protected]⟩

From libzt-doc 0.3.1-4 in Debian 13 (Trixie). Parsed by carta from the page's mdoc source.