pd.if.org Git - pdclib/blob - man3/assert.h.3

   1 .\" This file is part of the Public Domain C Library (PDCLib).
   2 .\" Permission is granted to use, modify, and / or redistribute at will.
   3 .\"
   4 .Dd
   5 .Dt ASSERT.H 3
   6 .Os
   7 .\"
   8 .Sh NAME
   9 .Nm assert.h
  10 .Nd verify program assertion
  11 .\"
  12 .Sh SYNOPSIS
  13 .In assert.h
  14 .\"
  15 .Sh DESCRIPTION
  16 The header
  17 .In assert.h
  18 shall define one macro:
  19 .Dv assert(<scalar expression>) .
  20 .Pp
  21 If
  22 .Dv NDEBUG
  23 was undefined at the most recent inclusion of this header, then it shall be
  24 defined as a macro which will evaluate the scalar expression and, if it is
  25 false, abort the program with a descriptive error message as defined in
  26 .Xr assert 3 .
  27 .\"
  28 .Pp
  29 If
  30 .Dv NDEBUG
  31 was defined at the most recent inclusion of this header, then it shall be
  32 defined as a macro which evaluates as a void expression and
  33 .Sy does not
  34 evaluate its parameter.
  35 .\"
  36 .Sh STANDARDS
  37 Conforming to
  38 .St -isoC-90 ,
  39 .St -isoC-99 .