xref: /openbsd-src/share/man/man3/assert.3 (revision 75a9523c2147d1fb92bb3cc491818fbd662b74ab)
1*75a9523cSschwarze.\"	$OpenBSD: assert.3,v 1.10 2014/12/10 21:15:30 schwarze Exp $
2df930be7Sderaadt.\"	$NetBSD: assert.3,v 1.5 1994/11/30 15:24:30 jtc Exp $
3df930be7Sderaadt.\"
4df930be7Sderaadt.\" Copyright (c) 1991, 1993
5df930be7Sderaadt.\"	The Regents of the University of California.  All rights reserved.
6df930be7Sderaadt.\"
7df930be7Sderaadt.\" Redistribution and use in source and binary forms, with or without
8df930be7Sderaadt.\" modification, are permitted provided that the following conditions
9df930be7Sderaadt.\" are met:
10df930be7Sderaadt.\" 1. Redistributions of source code must retain the above copyright
11df930be7Sderaadt.\"    notice, this list of conditions and the following disclaimer.
12df930be7Sderaadt.\" 2. Redistributions in binary form must reproduce the above copyright
13df930be7Sderaadt.\"    notice, this list of conditions and the following disclaimer in the
14df930be7Sderaadt.\"    documentation and/or other materials provided with the distribution.
1529295d1cSmillert.\" 3. Neither the name of the University nor the names of its contributors
16df930be7Sderaadt.\"    may be used to endorse or promote products derived from this software
17df930be7Sderaadt.\"    without specific prior written permission.
18df930be7Sderaadt.\"
19df930be7Sderaadt.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20df930be7Sderaadt.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21df930be7Sderaadt.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22df930be7Sderaadt.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23df930be7Sderaadt.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24df930be7Sderaadt.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25df930be7Sderaadt.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26df930be7Sderaadt.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27df930be7Sderaadt.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28df930be7Sderaadt.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29df930be7Sderaadt.\" SUCH DAMAGE.
30df930be7Sderaadt.\"
31df930be7Sderaadt.\"     @(#)assert.3	8.1 (Berkeley) 6/9/93
32df930be7Sderaadt.\"
33*75a9523cSschwarze.Dd $Mdocdate: December 10 2014 $
34df930be7Sderaadt.Dt ASSERT 3
35df930be7Sderaadt.Os
36df930be7Sderaadt.Sh NAME
37df930be7Sderaadt.Nm assert
38df930be7Sderaadt.Nd expression verification macro
39df930be7Sderaadt.Sh SYNOPSIS
40cfcc6981Stedu.In assert.h
41df930be7Sderaadt.Fn assert expression
42df930be7Sderaadt.Sh DESCRIPTION
43df930be7SderaadtThe
44df930be7Sderaadt.Fn assert
45df930be7Sderaadtmacro tests the given
4679c8682eSschwarze.Fa expression
47431305c8Saaronand if it is false, the calling process is terminated.
48431305c8SaaronA diagnostic message is written to
4979c8682eSschwarze.Dv stderr
50df930be7Sderaadtand the
51df930be7Sderaadt.Xr abort 3
52df930be7Sderaadtfunction is called, effectively terminating the program.
53df930be7Sderaadt.Pp
54df930be7SderaadtIf
5579c8682eSschwarze.Fa expression
56431305c8Saaronis true, the
57df930be7Sderaadt.Fn assert
58df930be7Sderaadtmacro does nothing.
59df930be7Sderaadt.Pp
60df930be7SderaadtThe
61df930be7Sderaadt.Fn assert
62431305c8Saaronmacro may be removed at compile time with the
63df930be7Sderaadt.Xr cc 1
64df930be7Sderaadtoption
65df930be7Sderaadt.Fl DNDEBUG .
66df930be7Sderaadt.Sh DIAGNOSTICS
67df930be7SderaadtThe following diagnostic message is written to
6879c8682eSschwarze.Dv stderr
69df930be7Sderaadtif
7079c8682eSschwarze.Fa expression
71df930be7Sderaadtis false:
72df930be7Sderaadt.Bd -literal -offset indent
73df930be7Sderaadt"assertion \e"%s\e" failed: file \e"%s\e", line %d\en", \e
74df930be7Sderaadt		    "expression", __FILE__, __LINE__);
75df930be7Sderaadt.Ed
76df930be7Sderaadt.Sh SEE ALSO
77df930be7Sderaadt.Xr cc 1 ,
78df930be7Sderaadt.Xr abort 3
79df930be7Sderaadt.Sh STANDARDS
80df930be7SderaadtThe
81df930be7Sderaadt.Fn assert
82df930be7Sderaadtmacro conforms to
83df930be7Sderaadt.St -ansiC .
84df930be7Sderaadt.Sh HISTORY
854feec33dSaaronAn
86f33e0097Saaron.Fn assert
87*75a9523cSschwarzemacro first appeared in
88*75a9523cSschwarze.At v7 .
89