Engine and archiver factories: added SetBreakOnError method

TheMostDiligent · TheMostDiligent · commit 43546a6338d3 · 2024-08-18T12:52:38.000-07:00
diff --git a/Graphics/Archiver/interface/ArchiverFactory.h b/Graphics/Archiver/interface/ArchiverFactory.h
@@ -331,6 +331,12 @@ DILIGENT_BEGIN_INTERFACE(IArchiverFactory, IObject)
     /// \param [in]     MessageCallback - Debug message callback function to use instead of the default one.
     VIRTUAL void METHOD(SetMessageCallback)(THIS_
                                             DebugMessageCallbackType MessageCallback) CONST PURE;
+
+    /// Sets whether to break program execution on assertion failure.
+
+    /// \param [in]     BreakOnError - Whether to break on assertion failure.
+    VIRTUAL void METHOD(SetBreakOnError)(THIS_
+                                         bool BreakOnError) CONST PURE;
 };
 DILIGENT_END_INTERFACE
 
@@ -346,6 +352,7 @@ DILIGENT_END_INTERFACE
 #    define IArchiverFactory_MergeArchives(This, ...)                           CALL_IFACE_METHOD(ArchiverFactory, MergeArchives,                          This, __VA_ARGS__)
 #    define IArchiverFactory_PrintArchiveContent(This, ...)                     CALL_IFACE_METHOD(ArchiverFactory, PrintArchiveContent,                    This, __VA_ARGS__)
 #    define IArchiverFactory_SetMessageCallback(This, ...)                      CALL_IFACE_METHOD(ArchiverFactory, SetMessageCallback,                     This, __VA_ARGS__)
+#    define IEngineFactory_SetBreakOnError(This, ...)                           CALL_IFACE_METHOD(EngineFactory,   SetBreakOnError,                        This, __VA_ARGS__)
 
 #endif
 
diff --git a/Graphics/Archiver/src/ArchiverFactory.cpp b/Graphics/Archiver/src/ArchiverFactory.cpp
@@ -32,6 +32,7 @@
 #include "ArchiverImpl.hpp"
 #include "SerializationDeviceImpl.hpp"
 #include "EngineMemory.h"
+#include "PlatformDebug.hpp"
 
 namespace Diligent
 {
@@ -140,6 +141,8 @@ class ArchiverFactoryImpl final : public IArchiverFactory
 
     virtual void DILIGENT_CALL_TYPE SetMessageCallback(DebugMessageCallbackType MessageCallback) const override final;
 
+    virtual void DILIGENT_CALL_TYPE SetBreakOnError(bool BreakOnError) const override final;
+
 private:
     DummyReferenceCounters<ArchiverFactoryImpl> m_RefCounters;
 };
@@ -341,6 +344,11 @@ void ArchiverFactoryImpl::SetMessageCallback(DebugMessageCallbackType MessageCal
     SetDebugMessageCallback(MessageCallback);
 }
 
+void ArchiverFactoryImpl::SetBreakOnError(bool BreakOnError) const
+{
+    PlatformDebug::SetBreakOnError(BreakOnError);
+}
+
 } // namespace
 
 
diff --git a/Graphics/GraphicsEngine/include/EngineFactoryBase.hpp b/Graphics/GraphicsEngine/include/EngineFactoryBase.hpp
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -38,6 +38,7 @@
 #include "DummyReferenceCounters.hpp"
 #include "EngineMemory.h"
 #include "RefCntAutoPtr.hpp"
+#include "PlatformDebug.hpp"
 
 namespace Diligent
 {
@@ -116,6 +117,11 @@ class EngineFactoryBase : public BaseInterface
         SetDebugMessageCallback(MessageCallback);
     }
 
+    virtual void DILIGENT_CALL_TYPE SetBreakOnError(bool BreakOnError) const override final
+    {
+        PlatformDebug::SetBreakOnError(BreakOnError);
+    }
+
 protected:
     template <typename DearchiverImplType>
     void CreateDearchiver(const DearchiverCreateInfo& CreateInfo,
diff --git a/Graphics/GraphicsEngine/interface/EngineFactory.h b/Graphics/GraphicsEngine/interface/EngineFactory.h
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -132,6 +132,12 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactory, IObject)
     VIRTUAL void METHOD(SetMessageCallback)(THIS_
                                             DebugMessageCallbackType MessageCallback) CONST PURE;
 
+    /// Sets whether to break program execution on assertion failure.
+
+    /// \param [in]     BreakOnError - Whether to break on assertion failure.
+    VIRTUAL void METHOD(SetBreakOnError)(THIS_
+                                         bool BreakOnError) CONST PURE;
+
 #if PLATFORM_ANDROID
     /// On Android platform, it is necessary to initialize the file system before
     /// CreateDefaultShaderSourceStreamFactory() method can be called.
@@ -164,7 +170,7 @@ DILIGENT_END_INTERFACE
 #    define IEngineFactory_InitAndroidFileSystem(This, ...)                  CALL_IFACE_METHOD(EngineFactory, InitAndroidFileSystem,                  This, __VA_ARGS__)
 #    define IEngineFactory_CreateDearchiver(This, ...)                       CALL_IFACE_METHOD(EngineFactory, CreateDearchiver,                       This, __VA_ARGS__)
 #    define IEngineFactory_SetMessageCallback(This, ...)                     CALL_IFACE_METHOD(EngineFactory, SetMessageCallback,                     This, __VA_ARGS__)
-
+#    define IEngineFactory_SetBreakOnError(This, ...)                        CALL_IFACE_METHOD(EngineFactory, SetBreakOnError,                        This, __VA_ARGS__)
 // clang-format on
 
 #endif
diff --git a/Platforms/Android/src/AndroidDebug.cpp b/Platforms/Android/src/AndroidDebug.cpp
@@ -44,10 +44,11 @@ void AndroidDebug::AssertionFailed(const Char* Message, const char* Function, co
     else
     {
         OutputDebugMessage(DEBUG_MESSAGE_SEVERITY_ERROR, AssertionFailedMessage.c_str(), nullptr, nullptr, 0);
-        if (GetBreakOnError())
-        {
-            raise(SIGTRAP);
-        }
+    }
+
+    if (GetBreakOnError())
+    {
+        raise(SIGTRAP);
     }
 }
 
diff --git a/Platforms/Apple/src/AppleDebug.mm b/Platforms/Apple/src/AppleDebug.mm
@@ -44,10 +44,11 @@
     else
     {
         OutputDebugMessage(DEBUG_MESSAGE_SEVERITY_ERROR, AssertionFailedMessage.c_str(), nullptr, nullptr, 0);
-        if (GetBreakOnError())
-        {
-            raise(SIGTRAP);
-        }
+    }
+
+    if (GetBreakOnError())
+    {
+        raise(SIGTRAP);
     }
 }
 
diff --git a/Platforms/Emscripten/src/EmscriptenDebug.cpp b/Platforms/Emscripten/src/EmscriptenDebug.cpp
@@ -43,10 +43,11 @@ void EmscriptenDebug::AssertionFailed(const Char* Message, const char* Function,
     else
     {
         OutputDebugMessage(DEBUG_MESSAGE_SEVERITY_ERROR, AssertionFailedMessage.c_str(), nullptr, nullptr, 0);
-        if (GetBreakOnError())
-        {
-            raise(SIGTRAP);
-        }
+    }
+
+    if (GetBreakOnError())
+    {
+        raise(SIGTRAP);
     }
 }
 
diff --git a/Platforms/Linux/src/LinuxDebug.cpp b/Platforms/Linux/src/LinuxDebug.cpp
@@ -44,10 +44,11 @@ void LinuxDebug::AssertionFailed(const Char* Message, const char* Function, cons
     else
     {
         OutputDebugMessage(DEBUG_MESSAGE_SEVERITY_ERROR, AssertionFailedMessage.c_str(), nullptr, nullptr, 0);
-        if (GetBreakOnError())
-        {
-            raise(SIGTRAP);
-        }
+    }
+
+    if (GetBreakOnError())
+    {
+        raise(SIGTRAP);
     }
 }
 
diff --git a/Platforms/UWP/src/UWPDebug.cpp b/Platforms/UWP/src/UWPDebug.cpp
@@ -46,37 +46,38 @@ void WindowsStoreDebug::AssertionFailed(const Char* Message, const char* Functio
     else
     {
         OutputDebugMessage(DEBUG_MESSAGE_SEVERITY_ERROR, AssertionFailedMessage.c_str(), nullptr, nullptr, 0);
-        if (GetBreakOnError())
-        {
-            __debugbreak();
-            //int nCode = MessageBoxA(NULL,
-            //                        FullMsg.c_str(),
-            //                        "Runtime assertion failed",
-            //                        MB_TASKMODAL|MB_ICONHAND|MB_ABORTRETRYIGNORE|MB_SETFOREGROUND);
+    }
+
+    if (GetBreakOnError())
+    {
+        __debugbreak();
+        //int nCode = MessageBoxA(NULL,
+        //                        FullMsg.c_str(),
+        //                        "Runtime assertion failed",
+        //                        MB_TASKMODAL|MB_ICONHAND|MB_ABORTRETRYIGNORE|MB_SETFOREGROUND);
 
-            //// Abort: abort the program
-            //if (nCode == IDABORT)
-            //{
-            //    // raise abort signal
-            //    raise(SIGABRT);
+        //// Abort: abort the program
+        //if (nCode == IDABORT)
+        //{
+        //    // raise abort signal
+        //    raise(SIGABRT);
 
-            //    // We usually won't get here, but it's possible that
-            //    //  SIGABRT was ignored.  So exit the program anyway.
-            //    exit(3);
-            //}
+        //    // We usually won't get here, but it's possible that
+        //    //  SIGABRT was ignored.  So exit the program anyway.
+        //    exit(3);
+        //}
 
-            //// Retry: call the debugger
-            //if (nCode == IDRETRY)
-            //{
-            //    DebugBreak();
-            //    /* return to user code */
-            //    return;
-            //}
+        //// Retry: call the debugger
+        //if (nCode == IDRETRY)
+        //{
+        //    DebugBreak();
+        //    /* return to user code */
+        //    return;
+        //}
 
-            //// Ignore: continue execution
-            //if (nCode == IDIGNORE)
-            //    return;
-        }
+        //// Ignore: continue execution
+        //if (nCode == IDIGNORE)
+        //    return;
     }
 }
 
diff --git a/Platforms/Win32/src/Win32Debug.cpp b/Platforms/Win32/src/Win32Debug.cpp
@@ -79,36 +79,37 @@ void WindowsDebug::AssertionFailed(const Char* Message, const char* Function, co
     else
     {
         OutputDebugMessage(DEBUG_MESSAGE_SEVERITY_ERROR, AssertionFailedMessage.c_str(), nullptr, nullptr, 0);
-        if (GetBreakOnError())
-        {
-            int nCode = MessageBoxA(NULL,
-                                    AssertionFailedMessage.c_str(),
-                                    "Runtime assertion failed",
-                                    MB_TASKMODAL | MB_ICONHAND | MB_ABORTRETRYIGNORE | MB_SETFOREGROUND);
+    }
 
-            // Abort: abort the program
-            if (nCode == IDABORT)
-            {
-                // raise abort signal
-                raise(SIGABRT);
+    if (GetBreakOnError())
+    {
+        int nCode = MessageBoxA(NULL,
+                                AssertionFailedMessage.c_str(),
+                                "Runtime assertion failed",
+                                MB_TASKMODAL | MB_ICONHAND | MB_ABORTRETRYIGNORE | MB_SETFOREGROUND);
 
-                // We usually won't get here, but it's possible that
-                //  SIGABRT was ignored.  So exit the program anyway.
-                exit(3);
-            }
+        // Abort: abort the program
+        if (nCode == IDABORT)
+        {
+            // raise abort signal
+            raise(SIGABRT);
 
-            // Retry: call the debugger
-            if (nCode == IDRETRY)
-            {
-                DebugBreak();
-                // return to user code
-                return;
-            }
+            // We usually won't get here, but it's possible that
+            //  SIGABRT was ignored.  So exit the program anyway.
+            exit(3);
+        }
 
-            // Ignore: continue execution
-            if (nCode == IDIGNORE)
-                return;
+        // Retry: call the debugger
+        if (nCode == IDRETRY)
+        {
+            DebugBreak();
+            // return to user code
+            return;
         }
+
+        // Ignore: continue execution
+        if (nCode == IDIGNORE)
+            return;
     }
 }
 
diff --git a/Tests/GPUTestFramework/src/GPUTestingEnvironment.cpp b/Tests/GPUTestFramework/src/GPUTestingEnvironment.cpp
@@ -240,6 +240,7 @@ GPUTestingEnvironment::GPUTestingEnvironment(const CreateInfo& EnvCI, const Swap
 
             auto* pFactoryD3D11 = GetEngineFactoryD3D11();
             pFactoryD3D11->SetMessageCallback(EnvCI.MessageCallback);
+            pFactoryD3D11->SetBreakOnError(false);
 
             EngineD3D11CreateInfo EngineCI;
             EngineCI.GraphicsAPIVersion = Version{11, 0};
@@ -282,6 +283,7 @@ GPUTestingEnvironment::GPUTestingEnvironment(const CreateInfo& EnvCI, const Swap
 #    endif
             auto* pFactoryD3D12 = GetEngineFactoryD3D12();
             pFactoryD3D12->SetMessageCallback(EnvCI.MessageCallback);
+            pFactoryD3D12->SetBreakOnError(false);
 
             if (!pFactoryD3D12->LoadD3D12())
             {
@@ -347,6 +349,8 @@ GPUTestingEnvironment::GPUTestingEnvironment(const CreateInfo& EnvCI, const Swap
 #    endif
             auto* pFactoryOpenGL = GetEngineFactoryOpenGL();
             pFactoryOpenGL->SetMessageCallback(EnvCI.MessageCallback);
+            pFactoryOpenGL->SetBreakOnError(false);
+
             EnumerateAdapters(pFactoryOpenGL, Version{},
                               [](const GraphicsAdapterInfo& AdapterInfo, Uint32 AdapterId) {
                                   return std::vector<DisplayModeAttribs>{};
@@ -383,6 +387,7 @@ GPUTestingEnvironment::GPUTestingEnvironment(const CreateInfo& EnvCI, const Swap
 
             auto* pFactoryVk = GetEngineFactoryVk();
             pFactoryVk->SetMessageCallback(EnvCI.MessageCallback);
+            pFactoryVk->SetBreakOnError(false);
 
             if (EnvCI.EnableDeviceSimulation)
                 pFactoryVk->EnableDeviceSimulation();
@@ -433,6 +438,7 @@ GPUTestingEnvironment::GPUTestingEnvironment(const CreateInfo& EnvCI, const Swap
         {
             auto* pFactoryMtl = GetEngineFactoryMtl();
             pFactoryMtl->SetMessageCallback(EnvCI.MessageCallback);
+            pFactoryMtl->SetBreakOnError(false);
 
             EnumerateAdapters(pFactoryMtl, Version{},
                               [](const GraphicsAdapterInfo& AdapterInfo, Uint32 AdapterId) {
@@ -472,6 +478,8 @@ GPUTestingEnvironment::GPUTestingEnvironment(const CreateInfo& EnvCI, const Swap
 #    endif
             auto* pFactoryWGPU = GetEngineFactoryWebGPU();
             pFactoryWGPU->SetMessageCallback(MessageCallback);
+            pFactoryWGPU->SetBreakOnError(false);
+
             EngineWebGPUCreateInfo EngineCI{};
             EngineCI.Features = EnvCI.Features;
             ppContexts.resize(std::max(size_t{1}, ContextCI.size()) + NumDeferredCtx);
@@ -594,6 +602,7 @@ GPUTestingEnvironment::GPUTestingEnvironment(const CreateInfo& EnvCI, const Swap
         m_ArchiverFactory = Diligent::GetArchiverFactory();
 #    endif
         m_ArchiverFactory->SetMessageCallback(EnvCI.MessageCallback);
+        m_ArchiverFactory->SetBreakOnError(false);
     }
 #endif
 }
diff --git a/Tests/TestFramework/src/TestingEnvironment.cpp b/Tests/TestFramework/src/TestingEnvironment.cpp
@@ -49,6 +49,7 @@ TestingEnvironment::TestingEnvironment()
         GTEST_FLAG_SET(color, "no");
     }
     SetDebugMessageCallback(MessageCallback);
+    PlatformDebug::SetBreakOnError(false);
 }
 
 void TestingEnvironment::MessageCallback(DEBUG_MESSAGE_SEVERITY Severity,

Original file line number	Diff line number	Diff line change
`@@ -44,10 +44,11 @@ void AndroidDebug::AssertionFailed(const Char* Message, const char* Function, co`
`44`	`44`	`else`
`45`	`45`	`{`
`46`	`46`	`OutputDebugMessage(DEBUG_MESSAGE_SEVERITY_ERROR, AssertionFailedMessage.c_str(), nullptr, nullptr, 0);`
`47`		`- if (GetBreakOnError())`
`48`		`- {`
`49`		`- raise(SIGTRAP);`
`50`		`- }`
	`47`	`+ }`
	`48`	`+`
	`49`	`+ if (GetBreakOnError())`
	`50`	`+ {`
	`51`	`+ raise(SIGTRAP);`
`51`	`52`	`}`
`52`	`53`	`}`
`53`	`54`
Original file line number	Diff line number	Diff line change
`@@ -44,10 +44,11 @@`
`44`	`44`	`else`
`45`	`45`	`{`
`46`	`46`	`OutputDebugMessage(DEBUG_MESSAGE_SEVERITY_ERROR, AssertionFailedMessage.c_str(), nullptr, nullptr, 0);`
`47`		`- if (GetBreakOnError())`
`48`		`- {`
`49`		`- raise(SIGTRAP);`
`50`		`- }`
	`47`	`+ }`
	`48`	`+`
	`49`	`+ if (GetBreakOnError())`
	`50`	`+ {`
	`51`	`+ raise(SIGTRAP);`
`51`	`52`	`}`
`52`	`53`	`}`
`53`	`54`
Original file line number	Diff line number	Diff line change
`@@ -43,10 +43,11 @@ void EmscriptenDebug::AssertionFailed(const Char* Message, const char* Function,`
`43`	`43`	`else`
`44`	`44`	`{`
`45`	`45`	`OutputDebugMessage(DEBUG_MESSAGE_SEVERITY_ERROR, AssertionFailedMessage.c_str(), nullptr, nullptr, 0);`
`46`		`- if (GetBreakOnError())`
`47`		`- {`
`48`		`- raise(SIGTRAP);`
`49`		`- }`
	`46`	`+ }`
	`47`	`+`
	`48`	`+ if (GetBreakOnError())`
	`49`	`+ {`
	`50`	`+ raise(SIGTRAP);`
`50`	`51`	`}`
`51`	`52`	`}`
`52`	`53`
Original file line number	Diff line number	Diff line change
`@@ -44,10 +44,11 @@ void LinuxDebug::AssertionFailed(const Char* Message, const char* Function, cons`
`44`	`44`	`else`
`45`	`45`	`{`
`46`	`46`	`OutputDebugMessage(DEBUG_MESSAGE_SEVERITY_ERROR, AssertionFailedMessage.c_str(), nullptr, nullptr, 0);`
`47`		`- if (GetBreakOnError())`
`48`		`- {`
`49`		`- raise(SIGTRAP);`
`50`		`- }`
	`47`	`+ }`
	`48`	`+`
	`49`	`+ if (GetBreakOnError())`
	`50`	`+ {`
	`51`	`+ raise(SIGTRAP);`
`51`	`52`	`}`
`52`	`53`	`}`
`53`	`54`