ErrorReporting.h

Go to the documentation of this file.

//
//      ██╗██████╗     ██╗     ██╗██████╗ ███████╗
//      ██║██╔══██╗    ██║     ██║██╔══██╗██╔════╝      ** JPLSpatialziation **
//      ██║██████╔╝    ██║     ██║██████╔╝███████╗
// ██   ██║██╔═══╝     ██║     ██║██╔══██╗╚════██║      https://github.com/Jaytheway/JPLSpatialziation
// ╚█████╔╝██║         ███████╗██║██████╔╝███████║
//  ╚════╝ ╚═╝         ╚══════╝╚═╝╚═════╝ ╚══════╝
//
//   Copyright 2024 Jaroslav Pevno, JPLSpatialziation is offered under the terms of the ISC license:
//
//   Permission to use, copy, modify, and/or 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
 
// Thanks Jorrit Rouwe and his JoltPhysics library for the boilerplate below
// https://github.com/jrouwe/JoltPhysics
 
#ifndef JPL_ERROR_REPORTING_DEFINED
#define JPL_ERROR_REPORTING_DEFINED
 
#include "Core.h"
 
#include <format>
#include <source_location>
 
namespace JPL
{
#ifdef JPL_TAGGED_LOGGING
    using TaggedTraceFunction = void (*)(std::string_view tag, std::string_view message);
    JPL_EXPORT extern TaggedTraceFunction JPLTraceTaggedTrace;
    JPL_EXPORT extern TaggedTraceFunction JPLTraceTaggedInfo;
    JPL_EXPORT extern TaggedTraceFunction JPLTraceTaggedWarn;
    JPL_EXPORT extern TaggedTraceFunction JPLTraceTaggedError;
#else
    using TraceFunction = void (*)(const char* message);
    JPL_EXPORT extern TraceFunction SpatialTrace;
#endif
 
// Always turn on asserts in Debug mode
#if defined(JPL_DEBUG)
#ifndef JPL_ENABLE_ASSERTS
#define JPL_ENABLE_ASSERTS
#endif
#if !defined (JPL_TEST) && !defined(JPL_ENABLE_ENSURE)
#define JPL_ENABLE_ENSURE
#endif
#endif
 
#if defined(JPL_ENABLE_ASSERTS) || defined(JPL_ENABLE_ENSURE)
using AssertFailedFunction = bool(*)(const char* inExpression, const char* inMessage, const std::source_location);
JPL_EXPORT extern AssertFailedFunction AssertFailed;
 
// Helper functions to pass message on to failed function
inline bool AssertFailedParamHelper(const char* inExpression, const std::source_location location)
{
    return AssertFailed(inExpression, nullptr, location);
}
 
inline bool AssertFailedParamHelper(const char* inExpression, const std::source_location location, const char* inMessage)
{
    return AssertFailed(inExpression, inMessage, location);
}
#endif
 
#ifdef JPL_ENABLE_ASSERTS
#define JPL_ASSERT(inExpression, ...)   do { if (!(inExpression) && ::JPL::AssertFailedParamHelper(#inExpression, std::source_location::current(), ##__VA_ARGS__)) JPL_BREAKPOINT; } while (false)
 
#define JPL_IF_ENABLE_ASSERTS(...)      __VA_ARGS__
#else
#define JPL_ASSERT(...)                 ((void)0)
 
#define JPL_IF_ENABLE_ASSERTS(...)
#endif // JPL_ENABLE_ASSERTS
 
 
#ifndef JPL_ENSURE
#ifdef JPL_ENABLE_ENSURE
 
#define JPL_ENSURE(inExpression, ...) [&]{ if(!(inExpression)  && ::JPL::AssertFailedParamHelper(#inExpression, std::source_location::current(), ##__VA_ARGS__)) { JPL_BREAKPOINT; } return (inExpression); }()
#else
#define JPL_ENSURE(inExpression, ...) (inExpression)
#endif
#endif // !JPL_ENSURE
 
#ifndef JPL_TRACE_TAG
    #ifdef JPL_TAGGED_LOGGING
        #define JPL_TRACE_TAG(tag, message) JPLTraceTaggedTrace(tag, message)
    #else
        #define JPL_TRACE_TAG(tag, message) SpatialTrace(std::format("[{}]: Trace: {}", tag, message).c_str())
    #endif
#endif // !JPL_TRACE_TAG
 
#ifndef JPL_INFO_TAG
    #ifdef JPL_TAGGED_LOGGING
        #define JPL_INFO_TAG(tag, message) JPLTraceTaggedInfo(tag, message)
    #else
        #define JPL_INFO_TAG(tag, message) SpatialTrace(std::format("[{}]: Info: {}", tag, message).c_str())
    #endif
#endif // !JPL_INFO_TAG
 
#ifndef JPL_WARN_TAG
    #ifdef JPL_TAGGED_LOGGING
        #define JPL_WARN_TAG(tag, message) JPLTraceTaggedWarn(tag, message)
    #else
        #define JPL_WARN_TAG(tag, message) SpatialTrace(std::format("[{}]: Warning: {}", tag, message).c_str())
    #endif
#endif // !JPL_WARN_TAG
 
#ifndef JPL_ERROR_TAG
    #ifdef JPL_TAGGED_LOGGING
        #define JPL_ERROR_TAG(tag, message) JPLTraceTaggedError(tag, message)
    #else
        #define JPL_ERROR_TAG(tag, message) SpatialTrace(std::format("[{}]: Error: {}", tag, message).c_str())
    #endif
#endif // !JPL_ERROR_TAG
 
} // namespace JPL
 
#endif // JPL_ERROR_REPORTING_DEFINED