| 1 |
/* |
| 2 |
* mptAssert.h |
| 3 |
* ----------- |
| 4 |
* Purpose: assert and static_assert |
| 5 |
* Notes : (currently none) |
| 6 |
* Authors: OpenMPT Devs |
| 7 |
* The OpenMPT source code is released under the BSD license. Read LICENSE for more details. |
| 8 |
*/ |
| 9 |
|
| 10 |
|
| 11 |
#pragma once |
| 12 |
|
| 13 |
#include "openmpt/all/BuildSettings.hpp" |
| 14 |
|
| 15 |
|
| 16 |
#include "mpt/base/source_location.hpp" |
| 17 |
#include "mptBaseMacros.h" |
| 18 |
|
| 19 |
|
| 20 |
|
| 21 |
OPENMPT_NAMESPACE_BEGIN |
| 22 |
|
| 23 |
|
| 24 |
|
| 25 |
// Static code checkers might need to get the knowledge of our assertions transferred to them. |
| 26 |
#define MPT_CHECKER_ASSUME_ASSERTIONS 1 |
| 27 |
//#define MPT_CHECKER_ASSUME_ASSERTIONS 0 |
| 28 |
|
| 29 |
#ifdef MPT_BUILD_ANALYZED |
| 30 |
|
| 31 |
#if MPT_COMPILER_MSVC |
| 32 |
|
| 33 |
#if MPT_CHECKER_ASSUME_ASSERTIONS |
| 34 |
#define MPT_CHECKER_ASSUME(x) __analysis_assume(!!(x)) |
| 35 |
#endif |
| 36 |
|
| 37 |
#elif MPT_COMPILER_CLANG |
| 38 |
|
| 39 |
#if MPT_CHECKER_ASSUME_ASSERTIONS |
| 40 |
#ifdef NDEBUG |
| 41 |
#error "Builds for static analyzers depend on assert() being enabled, but the current build has #define NDEBUG. This makes no sense." |
| 42 |
#endif |
| 43 |
OPENMPT_NAMESPACE_END |
| 44 |
#include <cassert> |
| 45 |
OPENMPT_NAMESPACE_BEGIN |
| 46 |
#define MPT_CHECKER_ASSUME(x) assert(!!(x)) |
| 47 |
#endif |
| 48 |
|
| 49 |
#endif // MPT_COMPILER |
| 50 |
|
| 51 |
#endif // MPT_BUILD_ANALYZED |
| 52 |
|
| 53 |
#ifndef MPT_CHECKER_ASSUME |
| 54 |
#define MPT_CHECKER_ASSUME(x) do { } while(0) |
| 55 |
#endif |
| 56 |
|
| 57 |
|
| 58 |
|
| 59 |
#if defined(MPT_WITH_MFC) && !defined(MPT_CPPCHECK_CUSTOM) |
| 60 |
|
| 61 |
#if !defined(ASSERT) |
| 62 |
#error "MFC is expected to #define ASSERT" |
| 63 |
#endif // !defined(ASERRT) |
| 64 |
#define MPT_FRAMEWORK_ASSERT_IS_DEFINED |
| 65 |
|
| 66 |
#if defined(_DEBUG) |
| 67 |
#define MPT_FRAMEWORK_ASSERT_IS_ACTIVE 1 |
| 68 |
#else // !_DEBUG |
| 69 |
#define MPT_FRAMEWORK_ASSERT_IS_ACTIVE 0 |
| 70 |
#endif // _DEBUG |
| 71 |
|
| 72 |
// let MFC handle our asserts |
| 73 |
#define MPT_ASSERT_USE_FRAMEWORK 1 |
| 74 |
|
| 75 |
#else // !MPT_WITH_MFC |
| 76 |
|
| 77 |
#if defined(ASSERT) |
| 78 |
#define MPT_FRAMEWORK_ASSERT_IS_DEFINED |
| 79 |
#if defined(_DEBUG) |
| 80 |
#define MPT_FRAMEWORK_ASSERT_IS_ACTIVE 1 |
| 81 |
#else // !_DEBUG |
| 82 |
#define MPT_FRAMEWORK_ASSERT_IS_ACTIVE 0 |
| 83 |
#endif // _DEBUG |
| 84 |
#endif // !defined(ASERRT) |
| 85 |
|
| 86 |
// handle assert in our own way without relying on some platform-/framework-specific assert implementation |
| 87 |
#define MPT_ASSERT_USE_FRAMEWORK 0 |
| 88 |
|
| 89 |
#endif // MPT_WITH_MFC |
| 90 |
|
| 91 |
#if defined(MPT_FRAMEWORK_ASSERT_IS_DEFINED) && (MPT_ASSERT_USE_FRAMEWORK == 1) |
| 92 |
|
| 93 |
#define MPT_ASSERT_NOTREACHED() ASSERT(0) |
| 94 |
#define MPT_ASSERT(expr) ASSERT((expr)) |
| 95 |
#define MPT_ASSERT_MSG(expr, msg) ASSERT((expr) && (msg)) |
| 96 |
#if (MPT_FRAMEWORK_ASSERT_IS_ACTIVE == 1) |
| 97 |
#define MPT_ASSERT_ALWAYS(expr) ASSERT((expr)) |
| 98 |
#define MPT_ASSERT_ALWAYS_MSG(expr, msg) ASSERT((expr) && (msg)) |
| 99 |
#else |
| 100 |
#define MPT_ASSERT_ALWAYS(expr) do { if(!(expr)) { OPENMPT_NAMESPACE::AssertHandler(MPT_SOURCE_LOCATION_CURRENT(), #expr); } MPT_CHECKER_ASSUME(expr); } while(0) |
| 101 |
#define MPT_ASSERT_ALWAYS_MSG(expr, msg) do { if(!(expr)) { OPENMPT_NAMESPACE::AssertHandler(MPT_SOURCE_LOCATION_CURRENT(), #expr, msg); } MPT_CHECKER_ASSUME(expr); } while(0) |
| 102 |
#ifndef MPT_ASSERT_HANDLER_NEEDED |
| 103 |
#define MPT_ASSERT_HANDLER_NEEDED |
| 104 |
#endif |
| 105 |
#endif |
| 106 |
|
| 107 |
#elif defined(NO_ASSERTS) |
| 108 |
|
| 109 |
#define MPT_ASSERT_NOTREACHED() MPT_CHECKER_ASSUME(0) |
| 110 |
#define MPT_ASSERT(expr) MPT_CHECKER_ASSUME(expr) |
| 111 |
#define MPT_ASSERT_MSG(expr, msg) MPT_CHECKER_ASSUME(expr) |
| 112 |
#define MPT_ASSERT_ALWAYS(expr) do { if(!(expr)) { OPENMPT_NAMESPACE::AssertHandler(MPT_SOURCE_LOCATION_CURRENT(), #expr); } MPT_CHECKER_ASSUME(expr); } while(0) |
| 113 |
#define MPT_ASSERT_ALWAYS_MSG(expr, msg) do { if(!(expr)) { OPENMPT_NAMESPACE::AssertHandler(MPT_SOURCE_LOCATION_CURRENT(), #expr, msg); } MPT_CHECKER_ASSUME(expr); } while(0) |
| 114 |
#ifndef MPT_ASSERT_HANDLER_NEEDED |
| 115 |
#define MPT_ASSERT_HANDLER_NEEDED |
| 116 |
#endif |
| 117 |
|
| 118 |
#else // !NO_ASSERTS |
| 119 |
|
| 120 |
#define MPT_ASSERT_NOTREACHED() do { if constexpr(!(0)) { OPENMPT_NAMESPACE::AssertHandler(MPT_SOURCE_LOCATION_CURRENT(), "0"); } MPT_CHECKER_ASSUME(0); } while(0) |
| 121 |
#define MPT_ASSERT(expr) do { if(!(expr)) { OPENMPT_NAMESPACE::AssertHandler(MPT_SOURCE_LOCATION_CURRENT(), #expr); } MPT_CHECKER_ASSUME(expr); } while(0) |
| 122 |
#define MPT_ASSERT_MSG(expr, msg) do { if(!(expr)) { OPENMPT_NAMESPACE::AssertHandler(MPT_SOURCE_LOCATION_CURRENT(), #expr, msg); } MPT_CHECKER_ASSUME(expr); } while(0) |
| 123 |
#define MPT_ASSERT_ALWAYS(expr) do { if(!(expr)) { OPENMPT_NAMESPACE::AssertHandler(MPT_SOURCE_LOCATION_CURRENT(), #expr); } MPT_CHECKER_ASSUME(expr); } while(0) |
| 124 |
#define MPT_ASSERT_ALWAYS_MSG(expr, msg) do { if(!(expr)) { OPENMPT_NAMESPACE::AssertHandler(MPT_SOURCE_LOCATION_CURRENT(), #expr, msg); } MPT_CHECKER_ASSUME(expr); } while(0) |
| 125 |
#ifndef MPT_ASSERT_HANDLER_NEEDED |
| 126 |
#define MPT_ASSERT_HANDLER_NEEDED |
| 127 |
#endif |
| 128 |
|
| 129 |
#endif // NO_ASSERTS |
| 130 |
|
| 131 |
|
| 132 |
#if defined(MPT_ASSERT_HANDLER_NEEDED) |
| 133 |
// custom assert handler needed |
| 134 |
MPT_NOINLINE void AssertHandler(const mpt::source_location &loc, const char *expr, const char *msg=nullptr); |
| 135 |
#endif // MPT_ASSERT_HANDLER_NEEDED |
| 136 |
|
| 137 |
|
| 138 |
|
| 139 |
OPENMPT_NAMESPACE_END |