share/man/man3head/assert.h.3head

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions  Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved.
  45 .\" Copyright 2016 Joyent, Inc.
  46 .\"
  47 .TH ASSERT.H 3HEAD "Jan 14, 2015"
  48 .SH NAME
  49 assert.h, assert \- verify program assertion
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <\fBassert.h\fR>
  54 .fi
  55
  56 .SH DESCRIPTION
  57 .LP
  58 The <\fBassert.h\fR> header defines the \fBassert()\fR macro. It refers to the
  59 macro \fBNDEBUG\fR which is not defined in the header. If \fBNDEBUG\fR is
  60 defined as a macro name before the inclusion of this header, the \fBassert()\fR
  61 macro is defined simply as:
  62 .sp
  63 .in +2
  64 .nf
  65 #define assert(ignore)((void) 0)
  66 .fi
  67 .in -2
  68
  69 .sp
  70 .LP
  71 Otherwise, the macro behaves as described in \fBassert\fR(3C).
  72 .sp
  73 .LP
  74 The \fBassert()\fR macro is redefined according to the current state of
  75 \fBNDEBUG\fR each time <\fBassert.h\fR> is included.
  76 .sp
  77 .LP
  78 The \fBassert()\fR macro is implemented as a macro, not as a function. If the
  79 macro definition is suppressed in order to access an actual function, the
  80 behavior is undefined.
  81 .sp
  82 .LP
  83 The <\fBassert.h\fR> header also defines the \fBstatic_assert()\fR macro. This
  84 macros is similar to \fBassert()\fR; however, while \fBassert()\fR is used at
  85 program execution time, \fBstatic_assert()\fR is evaluated and checked by the
  86 compiler at compilation-time.
  87 .SH ATTRIBUTES
  88 .LP
  89 See \fBattributes\fR(5) for descriptions of the following attributes:
  90 .sp
  91
  92 .sp
  93 .TS
  94 box;
  95 c | c
  96 l | l .
  97 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  98 _
  99 Interface Stability     Standard
 100 .TE
 101
 102 .SH SEE ALSO
 103 .LP
 104 \fBassert\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)