share/man/man3/assert.3

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)assert.3    8.1 (Berkeley) 6/9/93
  33 .\" $FreeBSD: src/share/man/man3/assert.3,v 1.15 2002/12/04 18:57:46 ru Exp $
  34 .\" $DragonFly: src/share/man/man3/assert.3,v 1.2 2003/06/17 04:36:58 dillon Exp $
  35 .\"
  36 .Dd January 26, 1999
  37 .Dt ASSERT 3
  38 .Os
  39 .Sh NAME
  40 .Nm assert
  41 .Nd expression verification macro
  42 .Sh SYNOPSIS
  43 .In assert.h
  44 .Fn assert expression
  45 .Sh DESCRIPTION
  46 The
  47 .Fn assert
  48 macro tests the given
  49 .Ar expression
  50 and if it is false,
  51 the calling process is terminated.
  52 A
  53 diagnostic message is written to
  54 .Dv stderr
  55 and the function
  56 .Xr abort 3
  57 is called, effectively terminating the program.
  58 .Pp
  59 If
  60 .Ar expression
  61 is true,
  62 the
  63 .Fn assert
  64 macro does nothing.
  65 .Pp
  66 The
  67 .Fn assert
  68 macro
  69 may be removed at compile time by defining
  70 .Dv NDEBUG
  71 as a macro
  72 (e.g., by using the
  73 .Xr cc 1
  74 option
  75 .Fl D Ns Dv NDEBUG ) .
  76 .Sh EXAMPLES
  77 The assertion:
  78 .Pp
  79 .Dl "assert(1 == 0);"
  80 .Pp
  81 generates a diagnostic message similar to the following:
  82 .Pp
  83 .Dl "Assertion failed: (1 == 0), function main, file assertion.c, line 100."
  84 .Sh SEE ALSO
  85 .Xr abort 3
  86 .Sh STANDARDS
  87 The
  88 .Fn assert
  89 macro conforms to
  90 .St -isoC-99 .
  91 .Sh HISTORY
  92 An
  93 .Nm
  94 macro appeared in
  95 .At v6 .