1// Copyright (C) 2022 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#ifndef QASSERT_H
5#define QASSERT_H
6
7#include <QtCore/qcompilerdetection.h>
8#include <QtCore/qtconfigmacros.h>
9#include <QtCore/qtcoreexports.h>
10
11#if 0
12#pragma qt_class(QtAssert)
13#pragma qt_sync_stop_processing
14#endif
15
16QT_BEGIN_NAMESPACE
17
18#if defined(__cplusplus)
19
20#ifndef Q_CC_MSVC
21Q_NORETURN
22#endif
23Q_DECL_COLD_FUNCTION
24Q_CORE_EXPORT void qt_assert(const char *assertion, const char *file, int line) noexcept;
25
26#if !defined(Q_ASSERT)
27# if defined(QT_NO_DEBUG) && !defined(QT_FORCE_ASSERTS)
28# define Q_ASSERT(cond) static_cast<void>(false && (cond))
29# else
30# define Q_ASSERT(cond) ((cond) ? static_cast<void>(0) : qt_assert(#cond, __FILE__, __LINE__))
31# endif
32#endif
33
34#ifndef Q_CC_MSVC
35Q_NORETURN
36#endif
37Q_DECL_COLD_FUNCTION
38Q_CORE_EXPORT
39void qt_assert_x(const char *where, const char *what, const char *file, int line) noexcept;
40
41#if !defined(Q_ASSERT_X)
42# if defined(QT_NO_DEBUG) && !defined(QT_FORCE_ASSERTS)
43# define Q_ASSERT_X(cond, where, what) static_cast<void>(false && (cond))
44# else
45# define Q_ASSERT_X(cond, where, what) ((cond) ? static_cast<void>(0) : qt_assert_x(where, what, __FILE__, __LINE__))
46# endif
47#endif
48
49Q_NORETURN Q_CORE_EXPORT void qt_check_pointer(const char *, int) noexcept;
50Q_NORETURN Q_DECL_COLD_FUNCTION
51Q_CORE_EXPORT void qBadAlloc();
52
53#ifdef QT_NO_EXCEPTIONS
54# if defined(QT_NO_DEBUG) && !defined(QT_FORCE_ASSERTS)
55# define Q_CHECK_PTR(p) qt_noop()
56# else
57# define Q_CHECK_PTR(p) do {if (!(p)) qt_check_pointer(__FILE__,__LINE__);} while (false)
58# endif
59#else
60# define Q_CHECK_PTR(p) do { if (!(p)) qBadAlloc(); } while (false)
61#endif
62
63template <typename T>
64inline T *q_check_ptr(T *p) { Q_CHECK_PTR(p); return p; }
65
66// Q_UNREACHABLE_IMPL() and Q_ASSUME_IMPL() used below are defined in qcompilerdetection.h
67#define Q_UNREACHABLE() \
68 do {\
69 Q_ASSERT_X(false, "Q_UNREACHABLE()", "Q_UNREACHABLE was reached");\
70 Q_UNREACHABLE_IMPL();\
71 } while (false)
72
73#ifndef Q_UNREACHABLE_RETURN
74# ifdef Q_COMPILER_COMPLAINS_ABOUT_RETURN_AFTER_UNREACHABLE
75# define Q_UNREACHABLE_RETURN(...) Q_UNREACHABLE()
76# else
77# define Q_UNREACHABLE_RETURN(...) do { Q_UNREACHABLE(); return __VA_ARGS__; } while (0)
78# endif
79#endif
80
81#define Q_ASSUME(Expr) \
82 [] (bool valueOfExpression) {\
83 Q_ASSERT_X(valueOfExpression, "Q_ASSUME()", "Assumption in Q_ASSUME(\"" #Expr "\") was not correct");\
84 Q_ASSUME_IMPL(valueOfExpression);\
85 }(Expr)
86
87// Don't use these in C++ mode, use static_assert directly.
88// These are here only to keep old code compiling.
89# define Q_STATIC_ASSERT(Condition) static_assert(bool(Condition), #Condition)
90# define Q_STATIC_ASSERT_X(Condition, Message) static_assert(bool(Condition), Message)
91
92#elif defined(Q_COMPILER_STATIC_ASSERT)
93// C11 mode - using the _S version in case <assert.h> doesn't do the right thing
94# define Q_STATIC_ASSERT(Condition) _Static_assert(!!(Condition), #Condition)
95# define Q_STATIC_ASSERT_X(Condition, Message) _Static_assert(!!(Condition), Message)
96#else
97// C89 & C99 version
98# define Q_STATIC_ASSERT_PRIVATE_JOIN(A, B) Q_STATIC_ASSERT_PRIVATE_JOIN_IMPL(A, B)
99# define Q_STATIC_ASSERT_PRIVATE_JOIN_IMPL(A, B) A ## B
100# ifdef __COUNTER__
101# define Q_STATIC_ASSERT(Condition) \
102 typedef char Q_STATIC_ASSERT_PRIVATE_JOIN(q_static_assert_result, __COUNTER__) [(Condition) ? 1 : -1];
103# else
104# define Q_STATIC_ASSERT(Condition) \
105 typedef char Q_STATIC_ASSERT_PRIVATE_JOIN(q_static_assert_result, __LINE__) [(Condition) ? 1 : -1];
106# endif /* __COUNTER__ */
107# define Q_STATIC_ASSERT_X(Condition, Message) Q_STATIC_ASSERT(Condition)
108#endif // __cplusplus
109
110QT_END_NAMESPACE
111
112#endif // QASSERT_H
113