avr-libc  2.0.0 Standard C library for AVR-GCC
assert.h
Go to the documentation of this file.
1 /* Copyright (c) 2005,2007 Joerg Wunsch
3
4  Portions of documentation Copyright (c) 1991, 1993
5  The Regents of the University of California.
6
8
9  Redistribution and use in source and binary forms, with or without
10  modification, are permitted provided that the following conditions are met:
11
12  * Redistributions of source code must retain the above copyright
13  notice, this list of conditions and the following disclaimer.
14
15  * Redistributions in binary form must reproduce the above copyright
16  notice, this list of conditions and the following disclaimer in
17  the documentation and/or other materials provided with the
18  distribution.
19
20  * Neither the name of the copyright holders nor the names of
21  contributors may be used to endorse or promote products derived
22  from this software without specific prior written permission.
23
24  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  POSSIBILITY OF SUCH DAMAGE.
35
36  $Id: assert_8h_source.html,v 1.1.1.6 2016/02/09 07:13:50 joerg_wunsch Exp$
37 */
38
39 /** \file */
40 /** \defgroup avr_assert <assert.h>: Diagnostics
41  \code #include <assert.h> \endcode
42
43  This header file defines a debugging aid.
44
45  As there is no standard error output stream available for many
46  applications using this library, the generation of a printable
47  error message is not enabled by default. These messages will
48  only be generated if the application defines the macro
49
50  \code __ASSERT_USE_STDERR \endcode
51
52  before including the \c <assert.h> header file. By default,
53  only abort() will be called to halt the application.
54 */
55
56 /*@{*/
57
58 /*
59  * The ability to include this file (with or without NDEBUG) is a
60  * feature.
61  */
62
63 #undef assert
64
65 #include <stdlib.h>
66
67 #if defined(__DOXYGEN__)
68 /**
69  * \def assert
70  * \param expression Expression to test for.
71  *
72  * The assert() macro tests the given expression and if it is false,
73  * the calling process is terminated. A diagnostic message is written
74  * to stderr and the function abort() is called, effectively
75  * terminating the program.
76  *
77  * If expression is true, the assert() macro does nothing.
78  *
79  * The assert() macro may be removed at compile time by defining
80  * NDEBUG as a macro (e.g., by using the compiler option -DNDEBUG).
81  */
82 # define assert(expression)
83
84 #else /* !DOXYGEN */
85
86 # if defined(NDEBUG)
87 # define assert(e) ((void)0)
88 # else /* !NDEBUG */
89 # if defined(__ASSERT_USE_STDERR)
90 # define assert(e) ((e) ? (void)0 : \
91  __assert(__func__, __FILE__, __LINE__, #e))
92 # else /* !__ASSERT_USE_STDERR */
93 # define assert(e) ((e) ? (void)0 : abort())
94 # endif /* __ASSERT_USE_STDERR */
95 # endif /* NDEBUG */
96 #endif /* DOXYGEN */
97
98 #ifdef __cplusplus
99 extern "C" {
100 #endif
101
102 #if !defined(__DOXYGEN__)
103
104 extern void __assert(const char *__func, const char *__file,
105  int __lineno, const char *__sexp);
106
107 #endif /* not __DOXYGEN__ */
108
109 #ifdef __cplusplus
110 }
111 #endif
112
113 /*@}*/
114 /* EOF */