Merge branch 'blender2.7' of git.blender.org:blender
[blender.git] / source / blender / blenlib / BLI_assert.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __BLI_ASSERT_H__
18 #define __BLI_ASSERT_H__
19
20 /** \file
21  * \ingroup bli
22  *
23  * Defines:
24  * - #BLI_assert
25  * - #BLI_STATIC_ASSERT
26  * - #BLI_STATIC_ASSERT_ALIGN
27  */
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 #ifndef NDEBUG /* for BLI_assert */
34 #include <stdio.h>
35 #endif
36
37 /* BLI_assert(), default only to print
38  * for aborting need to define WITH_ASSERT_ABORT
39  */
40 /* For 'abort' only. */
41 #include <stdlib.h>
42
43 #ifndef NDEBUG
44 #  include "BLI_system.h"
45    /* _BLI_ASSERT_PRINT_POS */
46 #  if defined(__GNUC__)
47 #    define _BLI_ASSERT_PRINT_POS(a) \
48         fprintf(stderr, "BLI_assert failed: %s:%d, %s(), at \'%s\'\n", __FILE__, __LINE__, __func__, #a)
49 #  elif defined(_MSC_VER)
50 #    define _BLI_ASSERT_PRINT_POS(a) \
51         fprintf(stderr, "BLI_assert failed: %s:%d, %s(), at \'%s\'\n", __FILE__, __LINE__, __FUNCTION__, #a)
52 #  else
53 #    define _BLI_ASSERT_PRINT_POS(a) \
54         fprintf(stderr, "BLI_assert failed: %s:%d, at \'%s\'\n", __FILE__, __LINE__, #a)
55 #  endif
56    /* _BLI_ASSERT_ABORT */
57 #  ifdef WITH_ASSERT_ABORT
58 #    define _BLI_ASSERT_ABORT abort
59 #  else
60 #    define _BLI_ASSERT_ABORT() (void)0
61 #  endif
62    /* BLI_assert */
63 #  define BLI_assert(a) \
64         (void)((!(a)) ? ((BLI_system_backtrace(stderr), _BLI_ASSERT_PRINT_POS(a), _BLI_ASSERT_ABORT(), NULL)) : NULL)
65 #else
66 #  define BLI_assert(a) ((void)0)
67 #endif
68
69 /* C++ can't use _Static_assert, expects static_assert() but c++0x only,
70  * Coverity also errors out. */
71 #if (!defined(__cplusplus)) && \
72     (!defined(__COVERITY__)) && \
73     (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 406))  /* gcc4.6+ only */
74 #  define BLI_STATIC_ASSERT(a, msg) __extension__ _Static_assert(a, msg);
75 #else
76 /* Code adapted from http://www.pixelbeat.org/programming/gcc/static_assert.html */
77 /* Note we need the two concats below because arguments to ## are not expanded, so we need to
78  * expand __LINE__ with one indirection before doing the actual concatenation. */
79 #  define _BLI_ASSERT_CONCAT_(a, b) a##b
80 #  define _BLI_ASSERT_CONCAT(a, b) _BLI_ASSERT_CONCAT_(a, b)
81    /* These can't be used after statements in c89. */
82 #  if defined(__COUNTER__)  /* MSVC */
83 #    define BLI_STATIC_ASSERT(a, msg) \
84          ; enum { _BLI_ASSERT_CONCAT(static_assert_, __COUNTER__) = 1 / (int)(!!(a)) };
85 #  else  /* older gcc, clang... */
86     /* This can't be used twice on the same line so ensure if using in headers
87      * that the headers are not included twice (by wrapping in #ifndef...#endif)
88      * Note it doesn't cause an issue when used on same line of separate modules
89      * compiled with gcc -combine -fwhole-program. */
90 #    define BLI_STATIC_ASSERT(a, msg) \
91          ; enum { _BLI_ASSERT_CONCAT(assert_line_, __LINE__) = 1 / (int)(!!(a)) };
92 #  endif
93 #endif
94
95 #define BLI_STATIC_ASSERT_ALIGN(st, align) \
96   BLI_STATIC_ASSERT((sizeof(st) % (align) == 0), "Structure must be strictly aligned")
97
98 #ifdef __cplusplus
99 }
100 #endif
101
102 #endif  /* __BLI_ASSERT_H__ */