macros.h

Go to the documentation of this file.

#pragma once
 
#include <cassert>
#include <cstdlib>
#include <print>
#include <string>
 
#define BROOM_UNLIKELY [[unlikely]]
#define BROOM_LIKELY [[likely]]
#define BROOM_NORETURN [[noreturn]]
 
template <typename... Args>
inline void Broom_Ensure(bool cond, const char* file, size_t line,
                         std::format_string<Args...> fmt, Args&&... args) {
  if (!cond) {
    std::print("{}:{}: ", file, line);
    std::println(fmt, std::forward<Args>(args)...);
    abort();
  }
}
 
#define BENSURE(x, m, ...) \
  Broom_Ensure(x, __FILE__, __LINE__, m __VA_OPT__(, ) __VA_ARGS__)
#define BENSURE_IMPLIES(lhs, rhs, m, ...) \
  BASSERT(!(lhs) || (rhs), m __VA_OPT__(, ) __VA_ARGS__)
#define BENSURE_EQ(lhs, rhs, m, ...) \
  BENSURE(lhs == rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BENSURE_GE(lhs, rhs, m, ...) \
  BENSURE(lhs >= rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BENSURE_GT(lhs, rhs, m, ...) \
  BENSURE(lhs > rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BENSURE_LE(lhs, rhs, m, ...) \
  BENSURE(lhs <= rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BENSURE_LT(lhs, rhs, m, ...) \
  BENSURE(lhs < rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BENSURE_NE(lhs, rhs, m, ...) \
  BENSURE(lhs != rhs, m __VA_OPT__(, ) __VA_ARGS__)
 
#ifdef BROOM_DEBUG
#define BASSERT(x, m, ...) BENSURE(x, m __VA_OPT__(, ) __VA_ARGS__)
#define BASSERT_IMPLIES(lhs, rhs, m, ...) \
  BASSERT(!(lhs) || (rhs), m __VA_OPT__(, ) __VA_ARGS__)
#define BASSERT_EQ(lhs, rhs, m, ...) \
  BASSERT(lhs == rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BASSERT_GE(lhs, rhs, m, ...) \
  BASSERT(lhs >= rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BASSERT_GT(lhs, rhs, m, ...) \
  BASSERT(lhs > rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BASSERT_LE(lhs, rhs, m, ...) \
  BASSERT(lhs <= rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BASSERT_LT(lhs, rhs, m, ...) \
  BASSERT(lhs < rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BASSERT_NE(lhs, rhs, m, ...) \
  BASSERT(lhs != rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BROOM_DEBUG_BOOL true
#else
#define BASSERT(x, m, ...)
#define BASSERT_EQ(lhs, rhs, m, ...)
#define BASSERT_GE(lhs, rhs, m, ...)
#define BASSERT_GT(lhs, rhs, m, ...)
#define BASSERT_LE(lhs, rhs, m, ...)
#define BASSERT_LT(lhs, rhs, m, ...)
#define BASSERT_NE(lhs, rhs, m, ...)
#define BROOM_DEBUG_BOOL false
#endif
 
#ifdef BROOM_DEBUG_SLOW
#define BROOM_DEBUG_SLOW_BOOL true
#define BASSERT_SLOW(x, m, ...) BENSURE(x, m __VA_OPT__(, ) __VA_ARGS__)
#define BASSERT_SLOW_IMPLIES(lhs, rhs, m, ...) \
  BASSERT_SLOW(!(lhs) || (rhs), m __VA_OPT__(, ) __VA_ARGS__)
#define BASSERT_SLOW_EQ(lhs, rhs, m, ...) \
  BASSERT_SLOW(lhs == rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BASSERT_SLOW_GE(lhs, rhs, m, ...) \
  BASSERT_SLOW(lhs >= rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BASSERT_SLOW_GT(lhs, rhs, m, ...) \
  BASSERT_SLOW(lhs > rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BASSERT_SLOW_LE(lhs, rhs, m, ...) \
  BASSERT_SLOW(lhs <= rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BASSERT_SLOW_LT(lhs, rhs, m, ...) \
  BASSERT_SLOW(lhs < rhs, m __VA_OPT__(, ) __VA_ARGS__)
#define BASSERT_SLOW_NE(lhs, rhs, m, ...) \
  BASSERT_SLOW(lhs != rhs, m __VA_OPT__(, ) __VA_ARGS__)
#else
#define BASSERT_SLOW(x, m, ...)
#define BASSERT_SLOW_EQ(lhs, rhs, m, ...)
#define BASSERT_SLOW_GE(lhs, rhs, m, ...)
#define BASSERT_SLOW_GT(lhs, rhs, m, ...)
#define BASSERT_SLOW_LE(lhs, rhs, m, ...)
#define BASSERT_SLOW_LT(lhs, rhs, m, ...)
#define BASSERT_SLOW_NE(lhs, rhs, m, ...)
#define BROOM_DEBUG_SLOW_BOOL false
#endif
 
#ifdef BROOM_VERBOSE_LOG
#define BDEBUG_LOG(m, ...) std::print(m __VA_OPT__(, ) __VA_ARGS__)
#else
#define BDEBUG_LOG(m, ...)
#endif
 
#if defined(__clang__) || defined(__GNUC__)
#define BROOM_NOINLINE __attribute__((noinline))
#define BROOM_INLINE __attribute__((always_inline))
#elif defined(_MSC_VER)
#define BROOM_NOINLINE __declspec(noinline)
#define BROOM_INLINE __forceinline
#endif
 
#define BROOM_UNUSED [[maybe_unused]]
 
#if defined(__has_feature)
#if __has_feature(address_sanitizer)
#define BROOM_NOASAN __attribute__((no_sanitize("address")))
#else
#define BROOM_NOASAN
#endif
 
#if __has_feature(thread_sanitizer)
#define BROOM_NOTSAN __attribute__((no_sanitize("thread")))
#else
#define BROOM_NOTSAN
#endif
 
#if __has_feature(memory_sanitizer)
#define BROOM_NOMSAN __attribute__((no_sanitize("memory")))
#else
#define BROOM_NOMSAN
#endif
 
#if __has_feature(undefined_sanitizer)
#define BROOM_NOUBSAN __attribute__((no_sanitize("undefined")))
#else
#define BROOM_NOUBSAN
#endif
 
#if __has_feature(leak_sanitizer)
#define BROOM_NOLSAN __attribute__((no_sanitize("leak")))
#else
#define BROOM_NOLSAN
#endif
 
#else
#define BROOM_NOASAN
#define BROOM_NOTSAN
#define BROOM_NOMSAN
#define BROOM_NOUBSAN
#define BROOM_NOLSAN
#endif