debug.h

Go to the documentation of this file.

/*
 * 🔖 prelude - debug.h
 * Copyright (c) 2026 Fawn <rubiefawn@gmail.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#pragma once
#include "hint.h"

#ifdef NDEBUG
    #include <stdlib.h>
    #define debug_break() abort()
#elif defined(__unix__) || (defined(__APPLE__) && defined(__MACH__))
    #include <signal.h>
    #define debug_break() raise(SIGTRAP)
#elif defined(_WIN32)
    #include <intrin.h>
    #define debug_break() __debugbreak()
#else
    #warning No debug break intrinsic found, debug_break() will exit instead
    #include <stdlib.h>
    #define debug_break() exit(EXIT_FAILURE)
#endif

#define debug_msg_always(FMT, ...) fprintf(stderr,  __FILE__ ":%d:%s: " FMT "\n", __LINE__, __func__ __VA_OPT__(,) __VA_ARGS__)

#define panic(FMT, ...) do { debug_msg_always(FMT __VA_OPT__(,) __VA_ARGS__); debug_break(); } while (0)

#ifdef NDEBUG
    #define debug_msg(FMT, ...)
#else
    #define debug_msg(FMT, ...) debug_msg_always(FMT __VA_OPT__(,) __VA_ARGS__)
#endif

#ifdef NDEBUG
    #define assert_msg(COND, FMT, ...) assume(COND)
#else
    #define assert_msg(COND, FMT, ...) do { if (COND) {} else { panic(FMT __VA_OPT__(,) __VA_ARGS__); } } while (0)
#endif