assert_base.hpp

/*
 * mstd - Maipa's Standard Library
 *
 * Licensed under the BSD 3-Clause License with Attribution Requirement.
 * See the LICENSE file for details: https://github.com/MAIPA01/mstd/blob/main/LICENSE
 *
 * Copyright (c) 2025, Patryk Antosik (MAIPA01)
 */
 
#pragma once
#ifndef _MSTD_ASSERT_BASE_HPP_
    #define _MSTD_ASSERT_BASE_HPP_
 
    #include <mstd/config.hpp>
 
    #if !_MSTD_HAS_CXX17
_MSTD_WARNING("this is only available for c++17 and greater!");
    #else
 
        #if _MSTD_HAS_CXX20
            #include <source_location>
        #endif
 
        #include <fmt/format.h>
        #include <filesystem>
        #include <string_view>
 
        #include <mstd/function_view.hpp>
 
        #pragma region DEBUGBREAK
        #if _DEBUG
            #ifdef _WIN32
                #define WIN32_LEAN_AND_MEAN
                #define NOMINMAX
                #include <crtdbg.h>
                #include <Windows.h>
                #define _MSTD_DEBUGBREAK() __debugbreak()
            #elif defined(__linux__) || defined(__APPLE__)
                #include <csignal>
                #define _MSTD_DEBUGBREAK() __builtin_trap()
            #else
                #include <cstdlib>
                #define _MSTD_DEBUGBREAK() std::abort()
            #endif
        #else
            #define _MSTD_DEBUGBREAK() ((void)0)
        #endif
        #pragma endregion
 
        #pragma region ASSERT_DEFINES
        #if _MSTD_HAS_CXX20
            #define _MSTD_SOURCE_LOCATION_ARG         const std::source_location& location
            #define _MSTD_GET_SOURCE_FILE_NAME        location.file_name()
            #define _MSTD_GET_SOURCE_FUNC_NAME        location.function_name()
            #define _MSTD_GET_SOURCE_LINE             location.line()
            #define _MSTD_GET_SOURCE_COLUMN           location.column()
            #define _MSTD_PASS_SOURCE_LOCATION        location
            #define _MSTD_GET_CURRENT_SOURCE_LOCATION ::std::source_location::current()
        #else
            #define _MSTD_SOURCE_LOCATION_ARG  const std::string_view &file_name, size_t line, const std::string_view &func_name
            #define _MSTD_GET_SOURCE_FILE_NAME file_name.data()
            #define _MSTD_GET_SOURCE_FUNC_NAME func_name.data()
            #define _MSTD_GET_SOURCE_LINE      line
            #define _MSTD_GET_SOURCE_COLUMN    0
            #define _MSTD_PASS_SOURCE_LOCATION file_name, line, func_name
            #define _MSTD_GET_CURRENT_SOURCE_LOCATION __FILE__, __LINE__, __FUNCTION__
        #endif
        #pragma endregion // ASSERT_DEFINES
 
        #pragma region ASSERT_BASE
        #define MSTD_STOP_ASSERT_BASE(expression, log_error_func, ...)
                do {
                        if (!(expression)) {
                                if (::mstd::stop_assert_handler(#expression, log_error_func,
                                      _MSTD_GET_CURRENT_SOURCE_LOCATION __VA_OPT__(, ) __VA_ARGS__)) {
                                    _MSTD_DEBUGBREAK();
                                }
                        }
            } while (0)
 
        #define MSTD_LOG_ASSERT_BASE(expression, log_error_func, ...)
            if (!(expression))
            ::mstd::log_assert_handler(#expression, log_error_func, _MSTD_GET_CURRENT_SOURCE_LOCATION __VA_OPT__(, ) __VA_ARGS__)
 
        #define MSTD_EMPTY_ASSERT_BASE(expression, log_error_func, ...) ((void)0)
        #pragma endregion
 
        #pragma region FUNCTIONS_DEFINES
 
namespace mstd {
        #pragma region FORMAT_LOG
 
    inline std::string format_log(const std::string_view expression, _MSTD_SOURCE_LOCATION_ARG,
      const std::string_view message = "") noexcept {
        const std::string shortFile = std::filesystem::path(_MSTD_GET_SOURCE_FILE_NAME).filename().string();
        std::string fullMessage     = fmt::format("Assertion failed [{}:{}:{},{}]: {}", shortFile, _MSTD_GET_SOURCE_FUNC_NAME,
          _MSTD_GET_SOURCE_LINE, _MSTD_GET_SOURCE_COLUMN, expression);
 
            if (!message.empty()) { fullMessage += fmt::format("\nmessage: {}", message); }
        return fullMessage;
    }
 
        #pragma endregion // FORMAT_LOG
 
        #pragma region REPORT_TO_SYSTEM
        #if _DEBUG
    _MSTD_CONSTEXPR17 bool report_to_system(_MSTD_SOURCE_LOCATION_ARG, const std::string_view message) noexcept {
            #ifdef _WIN32
        return _CrtDbgReport(_CRT_ASSERT, _MSTD_GET_SOURCE_FILE_NAME, _MSTD_GET_SOURCE_LINE, _MSTD_GET_SOURCE_FUNC_NAME, "%s",
                 message.data()) == 1;
            #else
        return true;
            #endif // _WIN32
    }
        #endif
        #pragma endregion // REPORT_TO_SYSTEM
 
        #pragma region ASSERT_HANDLER_NO_MSG
 
    inline void log_assert_handler(const std::string_view expression,
      const mstd::function_view<void(const std::string_view)>& errorLogger, _MSTD_SOURCE_LOCATION_ARG) noexcept {
        const std::string msg = format_log(expression, _MSTD_PASS_SOURCE_LOCATION);
        errorLogger(msg);
    }
 
    inline bool stop_assert_handler(const std::string_view expression,
      const mstd::function_view<void(const std::string_view)>& errorLogger, _MSTD_SOURCE_LOCATION_ARG) noexcept {
        const std::string msg = format_log(expression, _MSTD_PASS_SOURCE_LOCATION);
        errorLogger(msg);
        #if _DEBUG
        return report_to_system(_MSTD_PASS_SOURCE_LOCATION, msg);
        #else
        return true;
        #endif
    }
 
        #pragma endregion // ASSERT_HANDLER_NO_MSG
 
        #pragma region ASSERT_HANDLER_MSG
 
    template<class... Args>
    inline void log_assert_handler(const std::string_view expression,
      const mstd::function_view<void(const std::string_view)>& errorLogger, _MSTD_SOURCE_LOCATION_ARG,
      fmt::format_string<Args...> fmtFormat, Args&&... args) noexcept {
        const std::string formattedMsg = fmt::format(fmtFormat, std::forward<Args>(args)...);
        const std::string fullMsg      = format_log(expression, _MSTD_PASS_SOURCE_LOCATION, formattedMsg);
        errorLogger(fullMsg);
    }
 
    template<class... Args>
    inline bool stop_assert_handler(const std::string_view expression,
      const mstd::function_view<void(const std::string_view)>& errorLogger, _MSTD_SOURCE_LOCATION_ARG,
      fmt::format_string<Args...> fmtFormat, Args&&... args) noexcept {
        const std::string formattedMsg = fmt::format(fmtFormat, std::forward<Args>(args)...);
        const std::string fullMsg      = format_log(expression, _MSTD_PASS_SOURCE_LOCATION, formattedMsg);
        errorLogger(fullMsg);
        #if _DEBUG
        return report_to_system(_MSTD_PASS_SOURCE_LOCATION, fullMsg);
        #else
        return true;
        #endif
    }
 
        #pragma endregion // ASSERT_HANDLER_MSG
} // namespace mstd
 
        #pragma endregion
 
    #endif
#endif