/* ***********************************************************************
//
//   Copyright (C) 2025 -- The 4D-STAR Collaboration
//   File Author: Emily Boudreaux
//   Last Modified: March 20, 2025
//
//   4DSSE is free software; you can use it and/or modify
//   it under the terms and restrictions the GNU General Library Public
//   License version 3 (GPLv3) as published by the Free Software Foundation.
//
//   4DSSE is distributed in the hope that it will be useful,
//   but WITHOUT ANY WARRANTY; without even the implied warranty of
//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//   See the GNU Library General Public License for more details.
//
//   You should have received a copy of the GNU Library General Public License
//   along with this software; if not, write to the Free Software
//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
// *********************************************************************** */
/**
 * @file debug.h
 * @brief Defines a macro for triggering a breakpoint in different compilers and platforms.
 * 
 * This file provides a macro `BREAKPOINT()` that triggers a breakpoint
 * in the debugger, depending on the compiler and platform being used.
 * 
 * Usage:
 * @code
 * BREAKPOINT(); // Triggers a breakpoint in the debugger
 * @endcode
 */
#pragma once

#ifdef __GNUC__ // GCC and Clang
    /**
     * @brief Triggers a breakpoint in GCC and Clang.
     */
    #define BREAKPOINT() __builtin_debugtrap()
#elif defined(_MSC_VER) // MSVC
    /**
     * @brief Triggers a breakpoint in MSVC.
     */
    #define BREAKPOINT() __debugbreak()
#elif defined(__APPLE__) && defined(__MACH__) // macOS with Clang and LLDB
    #include <signal.h>
    /**
     * @brief Triggers a breakpoint in macOS with Clang and LLDB.
     */
    #define BREAKPOINT() raise(SIGTRAP)
#else
    #include <csignal>
    /**
     * @brief Triggers a breakpoint in other platforms.
     */
    #define BREAKPOINT() std::raise(SIGTRAP)
#endif
