Reworked debug message handling to allow user-specified callbacks

1 files changed, 142 insertions, 0 deletions

diff --git a/Primitives/interface/Errors.h b/Primitives/interface/Errors.h
new file mode 100644
index 00000000..faee22b5
--- /dev/null
+++ b/Primitives/interface/Errors.h
@@ -0,0 +1,142 @@
+/*     Copyright 2015-2018 Egor Yusov
+ *  
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ * 
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF ANY PROPRIETARY RIGHTS.
+ *
+ *  In no event and under no legal theory, whether in tort (including negligence), 
+ *  contract, or otherwise, unless required by applicable law (such as deliberate 
+ *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
+ *  liable for any damages, including any direct, indirect, special, incidental, 
+ *  or consequential damages of any character arising as a result of this License or 
+ *  out of the use or inability to use the software (including but not limited to damages 
+ *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
+ *  all other commercial damages or losses), even if such Contributor has been advised 
+ *  of the possibility of such damages.
+ */
+
+#pragma once
+
+#include <stdexcept>
+#include <string>
+#include <iostream>
+
+#include "BasicTypes.h"
+#include "FormatMessage.h"
+
+namespace Diligent
+{
+
+/// Describes debug message severity
+enum class DebugMessageSeverity : Int32
+{
+    /// Information message
+    Info = 0,
+
+    /// Warning message
+    Warning,
+
+    /// Error, with potential recovery
+    Error,
+
+    /// Fatal error - recovery is not possible
+    FatalError
+};
+
+using DebugMessageCallbackType = void(*)(DebugMessageSeverity, const Char* Message, const char* Function, const char* File, int Line);
+extern DebugMessageCallbackType DebugMessageCallback;
+
+void SetDebugMessageCallback(DebugMessageCallbackType DbgMessageCallback);
+
+
+template<bool>
+void ThrowIf(std::string &&)
+{
+}
+
+template<>
+inline void ThrowIf<true>(std::string &&msg)
+{
+    throw std::runtime_error( std::move(msg) );
+}
+
+template<bool bThrowException, typename FirstArgType, typename... RestArgsType>
+void LogError( const char *Function, const char *FullFilePath, int Line, const FirstArgType& first, const RestArgsType&... RestArgs )
+{
+    std::string FileName(FullFilePath);
+    auto LastSlashPos = FileName.find_last_of("/\\");
+    if(LastSlashPos != std::string::npos)
+        FileName.erase(0, LastSlashPos+1);
+    Diligent::MsgStream ss;
+    Diligent::FormatMsg( ss, first, RestArgs... );
+    auto Msg = ss.str();
+    if(DebugMessageCallback != nullptr)
+    {
+        DebugMessageCallback( bThrowException ? DebugMessageSeverity::FatalError : DebugMessageSeverity::Error, Msg.c_str(), Function, FileName.c_str(), Line);
+    }
+    else
+    {
+        // No callback set - output to cerr
+        std::cerr << "Diligent Engine: " << (bThrowException ? "Fatal Error" : "Error") << " in " << Function << "() (" << FileName << ", " << Line << "): " << Msg << '\n';
+    }
+    ThrowIf<bThrowException>(std::move(Msg));
+}
+
+}
+
+
+
+#define LOG_ERROR(...)\
+do{                                       \
+    Diligent::LogError<false>(__FUNCTION__, __FILE__, __LINE__, ##__VA_ARGS__); \
+}while(false)
+
+
+#define LOG_ERROR_ONCE(...)\
+do{                                     \
+    static bool IsFirstTime = true;     \
+    if(IsFirstTime)                     \
+    {                                   \
+        LOG_ERROR(##__VA_ARGS__);       \
+        IsFirstTime = false;            \
+    }                                   \
+}while(false)
+
+
+#define LOG_ERROR_AND_THROW(...)\
+do{                                     \
+    Diligent::LogError<true>(__FUNCTION__, __FILE__, __LINE__, ##__VA_ARGS__);\
+}while(false)
+
+
+#define LOG_DEBUG_MESSAGE(Severity, ...)\
+do{                                     \
+    Diligent::MsgStream ss;             \
+    Diligent::FormatMsg( ss, ##__VA_ARGS__ );\
+    if(Diligent::DebugMessageCallback != nullptr) Diligent::DebugMessageCallback( Severity, ss.str().c_str(), nullptr, nullptr, 0 );\
+}while(false)
+
+#define LOG_ERROR_MESSAGE(...)    LOG_DEBUG_MESSAGE(Diligent::DebugMessageSeverity::Error,   ##__VA_ARGS__)
+#define LOG_WARNING_MESSAGE(...)  LOG_DEBUG_MESSAGE(Diligent::DebugMessageSeverity::Warning, ##__VA_ARGS__)
+#define LOG_INFO_MESSAGE(...)     LOG_DEBUG_MESSAGE(Diligent::DebugMessageSeverity::Info,    ##__VA_ARGS__)
+
+
+#define LOG_DEBUG_MESSAGE_ONCE(Severity, ...)\
+do{                                                \
+    static bool IsFirstTime = true;                \
+    if(IsFirstTime)                                \
+    {                                              \
+        LOG_DEBUG_MESSAGE(Severity, ##__VA_ARGS__);\
+        IsFirstTime = false;                       \
+    }                                              \
+}while(false)
+
+#define LOG_ERROR_MESSAGE_ONCE(...)    LOG_DEBUG_MESSAGE_ONCE(Diligent::DebugMessageSeverity::Error,   ##__VA_ARGS__)
+#define LOG_WARNING_MESSAGE_ONCE(...)  LOG_DEBUG_MESSAGE_ONCE(Diligent::DebugMessageSeverity::Warning, ##__VA_ARGS__)
+#define LOG_INFO_MESSAGE_ONCE(...)     LOG_DEBUG_MESSAGE_ONCE(Diligent::DebugMessageSeverity::Info,    ##__VA_ARGS__)