]> git.ipfire.org Git - thirdparty/glibc.git/blame - assert/assert.h
Update copyright dates with scripts/update-copyrights
[thirdparty/glibc.git] / assert / assert.h
CommitLineData
2b778ceb 1/* Copyright (C) 1991-2021 Free Software Foundation, Inc.
ba1ffaa1 2 This file is part of the GNU C Library.
28f540f4 3
ba1ffaa1 4 The GNU C Library is free software; you can redistribute it and/or
41bdb6e2
AJ
5 modify it under the terms of the GNU Lesser General Public
6 License as published by the Free Software Foundation; either
7 version 2.1 of the License, or (at your option) any later version.
28f540f4 8
ba1ffaa1
UD
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41bdb6e2 12 Lesser General Public License for more details.
28f540f4 13
41bdb6e2 14 You should have received a copy of the GNU Lesser General Public
59ba27a6 15 License along with the GNU C Library; if not, see
5a82c748 16 <https://www.gnu.org/licenses/>. */
28f540f4
RM
17
18/*
d1646309 19 * ISO C99 Standard: 7.2 Diagnostics <assert.h>
28f540f4
RM
20 */
21
22#ifdef _ASSERT_H
23
40a55d20
UD
24# undef _ASSERT_H
25# undef assert
fd205052 26# undef __ASSERT_VOID_CAST
40a55d20
UD
27
28# ifdef __USE_GNU
29# undef assert_perror
30# endif
28f540f4
RM
31
32#endif /* assert.h */
33
34#define _ASSERT_H 1
35#include <features.h>
36
fd205052
UD
37#if defined __cplusplus && __GNUC_PREREQ (2,95)
38# define __ASSERT_VOID_CAST static_cast<void>
39#else
40# define __ASSERT_VOID_CAST (void)
41#endif
42
28f540f4
RM
43/* void assert (int expression);
44
45 If NDEBUG is defined, do nothing.
46 If not, and EXPRESSION is zero, print an error message and abort. */
47
48#ifdef NDEBUG
49
fd205052 50# define assert(expr) (__ASSERT_VOID_CAST (0))
28f540f4
RM
51
52/* void assert_perror (int errnum);
53
54 If NDEBUG is defined, do nothing. If not, and ERRNUM is not zero, print an
55 error message with the error text for ERRNUM and abort.
56 (This is a GNU extension.) */
57
f21acc89 58# ifdef __USE_GNU
fd205052 59# define assert_perror(errnum) (__ASSERT_VOID_CAST (0))
f21acc89 60# endif
28f540f4
RM
61
62#else /* Not NDEBUG. */
63
28f540f4
RM
64__BEGIN_DECLS
65
66/* This prints an "Assertion failed" message and aborts. */
a784e502
UD
67extern void __assert_fail (const char *__assertion, const char *__file,
68 unsigned int __line, const char *__function)
c1422e5b 69 __THROW __attribute__ ((__noreturn__));
28f540f4
RM
70
71/* Likewise, but prints the error text for ERRNUM. */
a784e502
UD
72extern void __assert_perror_fail (int __errnum, const char *__file,
73 unsigned int __line, const char *__function)
c1422e5b 74 __THROW __attribute__ ((__noreturn__));
28f540f4 75
8fb81470
UD
76
77/* The following is not at all used here but needed for standard
78 compliance. */
79extern void __assert (const char *__assertion, const char *__file, int __line)
80 __THROW __attribute__ ((__noreturn__));
81
82
28f540f4
RM
83__END_DECLS
84
e077349c
JM
85/* When possible, define assert so that it does not add extra
86 parentheses around EXPR. Otherwise, those added parentheses would
87 suppress warnings we'd expect to be detected by gcc's -Wparentheses. */
b5889d25
FW
88# if defined __cplusplus
89# define assert(expr) \
90 (static_cast <bool> (expr) \
91 ? void (0) \
92 : __assert_fail (#expr, __FILE__, __LINE__, __ASSERT_FUNCTION))
93# elif !defined __GNUC__ || defined __STRICT_ANSI__
e077349c
JM
94# define assert(expr) \
95 ((expr) \
96 ? __ASSERT_VOID_CAST (0) \
97 : __assert_fail (#expr, __FILE__, __LINE__, __ASSERT_FUNCTION))
98# else
8b2c63e4
FW
99/* The first occurrence of EXPR is not evaluated due to the sizeof,
100 but will trigger any pedantic warnings masked by the __extension__
b5889d25
FW
101 for the second occurrence. The ternary operator is required to
102 support function pointers and bit fields in this context, and to
103 suppress the evaluation of variable length arrays. */
e077349c 104# define assert(expr) \
b5889d25 105 ((void) sizeof ((expr) ? 1 : 0), __extension__ ({ \
e077349c
JM
106 if (expr) \
107 ; /* empty */ \
108 else \
109 __assert_fail (#expr, __FILE__, __LINE__, __ASSERT_FUNCTION); \
8b2c63e4 110 }))
e077349c 111# endif
28f540f4 112
f21acc89 113# ifdef __USE_GNU
389935d7
UD
114# define assert_perror(errnum) \
115 (!(errnum) \
116 ? __ASSERT_VOID_CAST (0) \
b3715c05 117 : __assert_perror_fail ((errnum), __FILE__, __LINE__, __ASSERT_FUNCTION))
f21acc89 118# endif
28f540f4
RM
119
120/* Version 2.4 and later of GCC define a magical variable `__PRETTY_FUNCTION__'
121 which contains the name of the function currently being defined.
05cc5bd9
UD
122 This is broken in G++ before version 2.6.
123 C9x has a similar variable called __func__, but prefer the GCC one since
124 it demangles C++ function names. */
d0db5f48 125# if defined __cplusplus ? __GNUC_PREREQ (2, 6) : __GNUC_PREREQ (2, 4)
8b2c63e4 126# define __ASSERT_FUNCTION __extension__ __PRETTY_FUNCTION__
05cc5bd9
UD
127# else
128# if defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L
129# define __ASSERT_FUNCTION __func__
130# else
a784e502 131# define __ASSERT_FUNCTION ((const char *) 0)
05cc5bd9 132# endif
f21acc89 133# endif
28f540f4 134
28f540f4 135#endif /* NDEBUG. */
839e283e
UD
136
137
8ecd6b2a 138#if defined __USE_ISOC11 && !defined __cplusplus
839e283e
UD
139# undef static_assert
140# define static_assert _Static_assert
141#endif