git.saurik.com Git - apple/libc.git/blame

Commit	Line	Data
224c7076 A	1	.\" $NetBSD: assert.3,v 1.5 1994/11/30 15:24:30 jtc Exp $
	2	.\"
	3	.\" Copyright (c) 1991, 1993
e9ce8d39 A	4	.\" The Regents of the University of California. All rights reserved.
	5	.\"
	6	.\" Redistribution and use in source and binary forms, with or without
	7	.\" modification, are permitted provided that the following conditions
	8	.\" are met:
	9	.\" 1. Redistributions of source code must retain the above copyright
	10	.\" notice, this list of conditions and the following disclaimer.
	11	.\" 2. Redistributions in binary form must reproduce the above copyright
	12	.\" notice, this list of conditions and the following disclaimer in the
	13	.\" documentation and/or other materials provided with the distribution.
	14	.\" 3. All advertising materials mentioning features or use of this software
	15	.\" must display the following acknowledgement:
	16	.\" This product includes software developed by the University of
	17	.\" California, Berkeley and its contributors.
	18	.\" 4. Neither the name of the University nor the names of its contributors
	19	.\" may be used to endorse or promote products derived from this software
	20	.\" without specific prior written permission.
	21	.\"
	22	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	23	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	24	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	25	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	26	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	27	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	28	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	29	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	30	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	31	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	32	.\" SUCH DAMAGE.
	33	.\"
224c7076	34	.\" @(#)assert.3 8.1 (Berkeley) 6/9/93
e9ce8d39	35	.\"
224c7076 A	36	.Dd June 9, 1993
224c7076 A	37	.Dt ASSERT 3
e9ce8d39 A	38	.Os
e9ce8d39 A	39	.Sh NAME
224c7076 A	40	.Nm assert
224c7076 A	41	.Nd expression verification macro
e9ce8d39	42	.Sh SYNOPSIS
224c7076 A	43	.Fd #include <assert.h>
224c7076 A	44	.Fn assert expression
e9ce8d39 A	45	.Sh DESCRIPTION
e9ce8d39 A	46	The
224c7076 A	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	.Em stderr
	55	and the
	56	.Xr abort 3
	57	function 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 with
	70	the
	71	.Xr cc 1
	72	option
	73	.Fl DNDEBUG .
	74	.Sh DIAGNOSTICS
	75	The following diagnostic message is written to
	76	.Em stderr
	77	if
	78	.Ar expression
	79	is false:
	80	.Bd -literal -offset indent
	81	"assertion \e"%s\e" failed: file \e"%s\e", line %d\en", \e
	82	"expression", __FILE__, __LINE__);
	83	.Ed
	84	.Sh SEE ALSO
	85	.Xr cc 1 ,
	86	.Xr abort 3
	87	.Sh STANDARDS
5b2abdfb	88	The
224c7076 A	89	.Fn assert
	90	macro conforms to
	91	.St -ansiC .
e9ce8d39	92	.Sh HISTORY
5b2abdfb	93	A
224c7076 A	94	.Nm assert
	95	macro appeared in
	96	.At v6 .