121 lines
3.7 KiB
C++
121 lines
3.7 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bli
|
|
*
|
|
* Defines:
|
|
* - #BLI_assert
|
|
* - #BLI_STATIC_ASSERT
|
|
* - #BLI_STATIC_ASSERT_ALIGN
|
|
*/
|
|
|
|
#include <stddef.h>
|
|
|
|
/* Utility functions. */
|
|
|
|
void _BLI_assert_print_pos(const char *file, int line, const char *function, const char *id);
|
|
void _BLI_assert_print_extra(const char *str);
|
|
void _BLI_assert_print_backtrace();
|
|
void _BLI_assert_abort();
|
|
void _BLI_assert_unreachable_print(const char *file, int line, const char *function);
|
|
|
|
#ifdef _MSC_VER
|
|
# include <crtdbg.h> /* for _STATIC_ASSERT */
|
|
#endif
|
|
|
|
#ifndef NDEBUG
|
|
/* _BLI_ASSERT_PRINT_POS */
|
|
# if defined(__GNUC__)
|
|
# define _BLI_ASSERT_PRINT_POS(a) _BLI_assert_print_pos(__FILE__, __LINE__, __func__, #a)
|
|
# elif defined(_MSC_VER)
|
|
# define _BLI_ASSERT_PRINT_POS(a) _BLI_assert_print_pos(__FILE__, __LINE__, __func__, #a)
|
|
# else
|
|
# define _BLI_ASSERT_PRINT_POS(a) _BLI_assert_print_pos(__FILE__, __LINE__, "<?>", #a)
|
|
# endif
|
|
/* _BLI_ASSERT_ABORT */
|
|
# ifdef WITH_ASSERT_ABORT
|
|
# define _BLI_ASSERT_ABORT _BLI_assert_abort
|
|
# else
|
|
# define _BLI_ASSERT_ABORT() (void)0
|
|
# endif
|
|
/* BLI_assert */
|
|
# define BLI_assert(a) \
|
|
(void)((!(a)) ? ((_BLI_assert_print_backtrace(), \
|
|
_BLI_ASSERT_PRINT_POS(a), \
|
|
_BLI_ASSERT_ABORT(), \
|
|
NULL)) : \
|
|
NULL)
|
|
/** A version of #BLI_assert() to pass an additional message to be printed on failure. */
|
|
# define BLI_assert_msg(a, msg) \
|
|
(void)((!(a)) ? ((_BLI_assert_print_backtrace(), \
|
|
_BLI_ASSERT_PRINT_POS(a), \
|
|
_BLI_assert_print_extra(msg), \
|
|
_BLI_ASSERT_ABORT(), \
|
|
NULL)) : \
|
|
NULL)
|
|
#else
|
|
# define BLI_assert(a) ((void)0)
|
|
# define BLI_assert_msg(a, msg) ((void)0)
|
|
#endif
|
|
|
|
#if defined(__cplusplus)
|
|
/* C++11 */
|
|
# define BLI_STATIC_ASSERT(a, msg) static_assert(a, msg);
|
|
#elif defined(_MSC_VER)
|
|
/* Visual Studio */
|
|
# if !defined(__clang__)
|
|
# define BLI_STATIC_ASSERT(a, msg) static_assert(a, msg);
|
|
# else
|
|
# define BLI_STATIC_ASSERT(a, msg) _STATIC_ASSERT(a);
|
|
# endif
|
|
#elif defined(__COVERITY__)
|
|
/* Workaround error with COVERITY. */
|
|
# define BLI_STATIC_ASSERT(a, msg)
|
|
#elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)
|
|
/* C11 */
|
|
# define BLI_STATIC_ASSERT(a, msg) _Static_assert(a, msg);
|
|
#else
|
|
/* Old unsupported compiler */
|
|
# define BLI_STATIC_ASSERT(a, msg)
|
|
#endif
|
|
|
|
#define BLI_STATIC_ASSERT_ALIGN(st, align) \
|
|
BLI_STATIC_ASSERT((sizeof(st) % (align) == 0), "Structure must be strictly aligned")
|
|
|
|
/**
|
|
* Indicates that this line of code should never be executed. If it is reached, it will abort in
|
|
* debug builds and print an error in release builds.
|
|
*/
|
|
#define BLI_assert_unreachable() \
|
|
{ \
|
|
_BLI_assert_unreachable_print(__FILE__, __LINE__, __func__); \
|
|
BLI_assert_msg(0, "This line of code is marked to be unreachable."); \
|
|
} \
|
|
((void)0)
|
|
|
|
#ifdef __cplusplus
|
|
|
|
/**
|
|
* Indicates that this line should never be reached, even at compile-time. Just doing
|
|
* `static_assert(false)` doesn't work in C++20 for this use-case. BLI_assert_unreachable is
|
|
* similar but does not catch issues at compile-time.
|
|
*/
|
|
# define BLI_assert_unreachable_static() \
|
|
static_assert([]<bool flag = false>() { return flag; }(), \
|
|
"Unreachable code path reached at compile-time!")
|
|
|
|
template<class T> inline constexpr bool _bli_always_false = false;
|
|
|
|
/**
|
|
* Like #BLI_assert_unreachable_static but allows passing in a type. This results in a more useful
|
|
* error message containing the type name.
|
|
*/
|
|
# define BLI_assert_unreachable_static_t(T) \
|
|
static_assert(_bli_always_false<T>, "Unreachable code path reached at compile-time!")
|
|
|
|
#endif
|