logger: show message popup for log_fatal (#412)

## Link to GitHub Issue, if one exists
#410 

## Description of change
When raising fatal errors via `log_fatal`, also show a modal popup.

Update instances of `log_fatal` where the message was too long to fit.

## Testing
Tested various failure conditions.

src/spice2x/util/deferlog.cpp

@@ -2,7 +2,6 @@
 #include <atomic>
 
 #include "build/defs.h"
-#include "hooks/graphics/graphics.h"
 #include "deferlog.h"
 #include "util/logging.h"
 
@@ -73,32 +72,4 @@ namespace deferredlogs {
             log_warning("troubleshooter", "{}", msg);
         });
     }
-
-    void show_popup_for_crash() {
-        static std::once_flag shown;
-        std::call_once(shown, []() {
-
-            // minimize all windows
-            // only needed because in multi-monitor full screen games, MessageBox fails to show above the game
-            for (auto &hwnd : GRAPHICS_WINDOWS) {
-                ShowWindow(hwnd, SW_FORCEMINIMIZE); 
-            }
-
-            const std::string title = "spice2x (" + to_string(VERSION_STRING_CFG) + ") - crash handler";
-            std::string text;
-            text += "Game has crashed.\n\n";
-            text += "Check log.txt and look for error messages near the end of file.\n\n";
-            text += "Unsure what to do next?\n";
-            text += "  * update spice2x to the latest version\n";
-            text += "  * check the FAQ on spice2x wiki on github\n";
-            text += "  * do NOT screenshot this, instead, share log.txt with someone and ask for help\n\n";
-            text += "Press Enter, Esc, Alt+F4, or click OK to exit. Otherwise, game will close in 30 seconds.";
-
-            MessageBox(
-                nullptr,
-                text.c_str(),
-                title.c_str(),
-                MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
-        });
-    }
 }

src/spice2x/util/deferlog.h

@@ -11,5 +11,4 @@ namespace deferredlogs {
 
     void defer_error_messages(std::initializer_list<std::string> messages);
     void dump_to_logger(bool is_crash=false);
-    void show_popup_for_crash();
 }

src/spice2x/util/libutils.cpp

@@ -43,7 +43,8 @@ static inline void load_library_fail(const std::string &file_name, bool fatal) {
         "     b. http://www.dependencywalker.com/ (for old OS) \n"
     , file_name) };
     if (fatal) {
-        log_fatal("libutils", "{}", info_str);
+        log_warning("libutils", "{}", info_str);
+        log_fatal("libutils", "DLL failed to load: {}, see log.txt for troubleshooting", file_name);
     } else {
         log_warning("libutils", "{}", info_str);
     }

src/spice2x/util/logging.cpp

@@ -1,6 +1,10 @@
-#include "logging.h"
+#include <atomic>
+#include <chrono>
+#include <future>
 
-DWORD LOG_FATAL_SLEEP = 10000;
+#include "logging.h"
+#include "build/defs.h"
+#include "hooks/graphics/graphics.h"
 
 std::string_view log_get_datetime() {
     return log_get_datetime(time(nullptr));
@@ -14,3 +18,66 @@ std::string_view log_get_datetime(std::time_t now) {
 
     return buf;
 }
+
+static void show_popup(const std::string text) {
+    static std::once_flag shown;
+    std::call_once(shown, [text]() {
+
+        // minimize all windows
+        // only needed because in multi-monitor full screen games, MessageBox fails to show above the game
+        for (auto &hwnd : GRAPHICS_WINDOWS) {
+            ShowWindow(hwnd, SW_FORCEMINIMIZE); 
+        }
+
+        // schedule a worker to terminate the game in 30 seconds in case user can't dismiss UI
+        std::atomic_bool cancel_popup = false;
+        auto worker = std::async(std::launch::async, [&cancel_popup]{
+            for (int ms = 300; ms > 0; ms--) {
+                std::this_thread::sleep_for(std::chrono::milliseconds(100));
+                if (cancel_popup) {
+                    return;
+                }
+            }
+            launcher::stop_subsystems();
+            launcher::kill();
+            std::terminate();
+        });
+
+        // MessageBox will block until user presses OK
+        const std::string title = "spice2x (" + to_string(VERSION_STRING_CFG) + ")";
+        MessageBox(
+            nullptr,
+            text.c_str(),
+            title.c_str(),
+            MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
+
+        // cancel the worker since the user acknowledged the popup
+        cancel_popup = true;
+    });
+}
+
+void show_popup_for_crash() {
+    std::string text;
+    text += "Game has crashed.\n\n";
+    text += "Check log.txt and look for error messages near the end of file.\n\n";
+    text += "Unsure what to do next?\n";
+    text += "  * update spice2x to the latest version\n";
+    text += "  * check the FAQ on spice2x github wiki\n";
+    text += "  * do NOT screenshot this, instead, share log.txt with someone and ask for help\n\n";
+    text += "Press Enter, Esc, Alt+F4, or click OK to exit. Otherwise, game will close in 30 seconds.";
+    show_popup(text);
+}
+
+void show_popup_for_fatal_error(std::string message) {
+    std::string text;
+    text += "A fatal error was encountered. For details, check log.txt.\n\n";
+    text += "----------------------------------------------------------\n";
+    text += message;
+    text += "----------------------------------------------------------\n\n";
+    text += "Unsure what to do next?\n";
+    text += "  * update spice2x to the latest version\n";
+    text += "  * check the FAQ on spice2x github wiki\n";
+    text += "  * do NOT screenshot this, instead, share log.txt with someone and ask for help\n\n";
+    text += "Press Enter, Esc, Alt+F4, or click OK to exit. Otherwise, game will close in 30 seconds.";
+    show_popup(text);
+}

src/spice2x/util/logging.h

@@ -71,22 +71,28 @@ struct fmt::formatter<fmt_hresult> {
     }
 };
 
-extern DWORD LOG_FATAL_SLEEP;
+void show_popup_for_crash();
+void show_popup_for_fatal_error(std::string message);
 
 // misc log
 #define LOG_FORMAT(level, module, fmt_str, ...) fmt::format(FMT_COMPILE("{}" fmt_str "\n"), \
     fmt_log { std::time(nullptr), level, module }, ## __VA_ARGS__)
+   
+#define LOG_FORMAT_POPUP(module, fmt_str, ...) fmt::format(FMT_COMPILE("{}: " fmt_str "\n"), module, ## __VA_ARGS__)
+
 #define log_misc(module, format_str, ...) logger::push( \
     LOG_FORMAT("M", module, format_str, ## __VA_ARGS__), logger::Style::GREY)
+
 #define log_info(module, format_str, ...) logger::push( \
     LOG_FORMAT("I", module, format_str, ## __VA_ARGS__), logger::Style::DEFAULT)
+
 #define log_warning(module, format_str, ...) logger::push( \
     LOG_FORMAT("W", module, format_str, ## __VA_ARGS__), logger::Style::YELLOW)
+
 #define log_fatal(module, format_str, ...) { \
     logger::push(LOG_FORMAT("F", module, format_str, ## __VA_ARGS__), logger::Style::RED); \
-    logger::push(LOG_FORMAT("F", "spice", "encountered a fatal error, you can close the window or press ctrl + c"), logger::Style::RED); \
+    show_popup_for_fatal_error(LOG_FORMAT_POPUP(module, format_str, ## __VA_ARGS__)); \
     launcher::stop_subsystems(); \
-    Sleep(LOG_FATAL_SLEEP); \
     launcher::kill(); \
     std::terminate(); \
 } ((void) 0 )