panic.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-only
 
#pragma once
 
#include <ctu_base_api.h>
#include <ctu_config.h>
 
#include "core/source_info.h"
 
#include <stdarg.h>
 
CT_BEGIN_API
 
 
 
 
#ifdef WITH_DOXYGEN
#   define CTU_DEBUG 0
#   define CTU_PARANOID 0
#endif
 
typedef void (*panic_handler_t)(source_info_t location, STA_FORMAT_STRING const char *fmt, va_list args);
 
CT_BASE_API extern panic_handler_t gPanicHandler;
 
STA_PRINTF(2, 3)
CT_BASE_API CT_NORETURN ctu_panic(source_info_t location, STA_FORMAT_STRING const char *msg, ...);
 
CT_BASE_API CT_NORETURN ctu_vpanic(source_info_t location, STA_FORMAT_STRING const char *msg,
                                   va_list args);
 
#define CT_PANIC_INNER(...)                         \
    source_info_t panic_source = CT_SOURCE_CURRENT; \
    ctu_panic(panic_source, __VA_ARGS__)
 
#define CT_PANIC(...)                \
    do                               \
    {                                \
        CT_PANIC_INNER(__VA_ARGS__); \
    } while (0)
 
 
#define CTASSERTF_ALWAYS(expr, ...)      \
    do                                   \
    {                                    \
        if (!(expr))                     \
        {                                \
            CT_PANIC_INNER(__VA_ARGS__); \
        }                                \
    } while (0)
 
#define CTASSERT_ALWAYS(expr) CTASSERTF_ALWAYS(expr, "assertion failed: %s", #expr)
#define CTASSERTM_ALWAYS(expr, msg) CTASSERTF_ALWAYS(expr, "%s", msg)
 
 
#if CTU_ASSERTS
#   define CTASSERTF(expr, ...) CTASSERTF_ALWAYS(expr, __VA_ARGS__)
#elif defined(__cplusplus) && (defined(__clang__) || defined(__GNUC__))
#   define CTASSERTF(expr, ...) \
    do { \
        if (__builtin_constant_p(expr) && !(expr)) { \
            CT_UNREACHABLE(); \
        } else { \
            CTASSERTF_ALWAYS(expr, __VA_ARGS__); \
        } \
    } while (0)
#else
#   define CTASSERTF(expr, ...) CT_ASSUME(expr)
#endif
 
#define CTASSERTM(expr, msg) CTASSERTF(expr, "%s", msg)
 
#define CTASSERT(expr) CTASSERTM(expr, #expr)
 
#define CT_NEVER(...) CT_PANIC(__VA_ARGS__)
 
#define CT_ASSERT_RANGE_PRI(value, min, max, pri) \
    CTASSERTF((value) >= (min) && (value) <= (max), "value " pri " not in range " pri "-" pri, (value), (min), (max))
 
#define CT_ASSERT_RANGE(value, min, max)                                                           \
    CT_ASSERT_RANGE_PRI(value, min, max, "%d")
 
#if CTU_PARANOID
#   define CT_PARANOID(...) __VA_ARGS__
#   define CT_PARANOID_ASSERTF(expr, ...) CTASSERTF(expr, __VA_ARGS__)
#else
#   define CT_PARANOID(...)
#   define CT_PARANOID_ASSERTF(expr, ...)
#endif
 
 
 
 
CT_END_API