assert.h

Go to the documentation of this file.

#pragma once
 
#include "pixelbullet/application/log.h"
 
#include <fmt/format.h>
 
#include <csignal>
#include <cstdlib>
#if defined(_MSC_VER)
#include <intrin.h>
#endif
 
namespace pixelbullet
{
namespace assert_detail
{
inline void TriggerDebugBreak()
{
#if defined(_MSC_VER)
    __debugbreak();
#elif defined(SIGTRAP)
    raise(SIGTRAP);
#endif
}
} // namespace assert_detail
 
[[noreturn]] inline void Fail(const char* file, int line, const char* conditionStr)
{
    log::Error("Assertion '{}' failed at {}:{}", conditionStr, file, line);
    assert_detail::TriggerDebugBreak();
    std::abort();
}
 
template <typename... Args>
[[noreturn]] void Fail(const char* file, int line, const char* conditionStr, fmt::format_string<Args...> msg, Args&&... args)
{
    (void)file;
    (void)line;
    (void)conditionStr;
    log::Error(msg, std::forward<Args>(args)...);
    assert_detail::TriggerDebugBreak();
    std::abort();
}
 
[[noreturn]] inline void Panic(const char* file, int line)
{
    log::Error("Panic triggered at {}:{}", file, line);
    assert_detail::TriggerDebugBreak();
    std::abort();
}
 
template <typename... Args>
[[noreturn]] void Panic(const char* file, int line, fmt::format_string<Args...> msg, Args&&... args)
{
    (void)file;
    (void)line;
    log::Error(msg, std::forward<Args>(args)...);
    assert_detail::TriggerDebugBreak();
    std::abort();
}
 
[[noreturn]] inline void Unreachable(const char* file, int line)
{
    log::Error("Reached unreachable code at {}:{}", file, line);
    assert_detail::TriggerDebugBreak();
    std::abort();
}
 
template <typename... Args>
[[noreturn]] void Unreachable(const char* file, int line, fmt::format_string<Args...> msg, Args&&... args)
{
    (void)file;
    (void)line;
    log::Error(msg, std::forward<Args>(args)...);
    assert_detail::TriggerDebugBreak();
    std::abort();
}
 
} // namespace pixelbullet
 
// -----------------------------------------------------------------------------
// === Conditional Assertions ================================================
// -----------------------------------------------------------------------------
 
#define ASSERT(condition, ...)                                                            \
    do                                                                                    \
    {                                                                                     \
        if (!(condition))                                                                 \
        {                                                                                 \
            pixelbullet::Fail(__FILE__, __LINE__, #condition __VA_OPT__(, ) __VA_ARGS__); \
        }                                                                                 \
    } while (0)
 
#ifdef PB_DEBUG
#define DEBUG_ASSERT(condition, ...) ASSERT(condition __VA_OPT__(, ) __VA_ARGS__)
#else
#define DEBUG_ASSERT(condition, ...) ((void)0)
#endif
 
#ifdef PB_DEBUG
#define ASSUME(condition, ...) ASSERT(condition __VA_OPT__(, ) __VA_ARGS__)
#else
#if defined(_MSC_VER)
#define ASSUME(condition, ...) __assume(condition)
#elif defined(__clang__) || defined(__GNUC__)
#define ASSUME(condition, ...)       \
    do                               \
    {                                \
        if (!(condition))            \
            __builtin_unreachable(); \
    } while (0)
#else
#define ASSUME(condition, ...) ((void)0)
#endif
#endif
 
// -----------------------------------------------------------------------------
// === Unconditional Assertions ================================================
// -----------------------------------------------------------------------------
 
#define PANIC(...)                                                         \
    do                                                                     \
    {                                                                      \
        pixelbullet::Panic(__FILE__, __LINE__ __VA_OPT__(, ) __VA_ARGS__); \
    } while (0)
 
#ifdef PB_DEBUG
#define UNREACHABLE(...)                                                         \
    do                                                                           \
    {                                                                            \
        pixelbullet::Unreachable(__FILE__, __LINE__ __VA_OPT__(, ) __VA_ARGS__); \
    } while (0)
#else
#if defined(_MSC_VER)
#define UNREACHABLE(...) __assume(0)
#elif defined(__clang__) || defined(__GNUC__)
#define UNREACHABLE(...) __builtin_unreachable()
#else
#define UNREACHABLE(...) ((void)0)
#endif
#endif