imgui: update to v1.91.4, make various fixes to overlay (#286)

## Link to GitHub Issue, if one exists
n/a

## Description of change
Update ImGui to `v1.91.4`. We can't update to `v1.91.5` or newer just
yet because impl_spice depends on the old IO model of ImGui which got
removed in `v1.91.5`.

We also can't update the DX9 renderer right now, because at some point
overlay breaks in TDJ (and only in TDJ...)

Enable the new debug logging functionality in ImGui. Add a button in
overlay to toggle debug log window.

Fix some minor bugs spotted by the new ImGui debug log: mismatched API
calls, font loading issues.

## Compiling
👍 

## Testing
In progress.

src/spice2x/overlay/imgui/impl_spice.cpp

@@ -17,7 +17,9 @@
     !defined(IMGUI_DISABLE_DEFAULT_ALLOCATORS) || \
     !defined(IMGUI_USE_BGRA_PACKED_COLOR) || \
     !defined(IMGUI_HAS_VIEWPORT) || \
-    !defined(IMGUI_HAS_DOCK)
+    !defined(IMGUI_HAS_DOCK) || \
+    !defined(IMGUI_DISABLE_DEMO_WINDOWS) || \
+    defined(IMGUI_DISABLE_DEBUG_TOOLS)
 #error "fix imconfig.h after updating imgui version"
 #endif
 
@@ -51,6 +53,7 @@ bool ImGui_ImplSpice_Init(HWND hWnd) {
     io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors;
     io.BackendFlags |= ImGuiBackendFlags_HasSetMousePos;
     io.BackendPlatformName = "imgui_impl_spice";
+    io.ConfigErrorRecoveryEnableTooltip = true;
 
     // keyboard mapping
     io.KeyMap[ImGuiKey_Tab] = VK_TAB;
@@ -68,7 +71,7 @@ bool ImGui_ImplSpice_Init(HWND hWnd) {
     io.KeyMap[ImGuiKey_Space] = VK_SPACE;
     io.KeyMap[ImGuiKey_Enter] = VK_RETURN;
     io.KeyMap[ImGuiKey_Escape] = VK_ESCAPE;
-    io.KeyMap[ImGuiKey_KeyPadEnter] = VK_RETURN;
+    io.KeyMap[ImGuiKey_KeypadEnter] = VK_RETURN;
     io.KeyMap[ImGuiKey_A] = 'A';
     io.KeyMap[ImGuiKey_C] = 'C';
     io.KeyMap[ImGuiKey_V] = 'V';

src/spice2x/overlay/imgui/impl_sw.cpp

@@ -678,7 +678,7 @@ void bind_imgui_painting()
 	int font_width, font_height;
 	io.Fonts->GetTexDataAsAlpha8(&tex_data, &font_width, &font_height);
 	const auto texture = new Texture{tex_data, font_width, font_height};
-	io.Fonts->TexID = texture;
+	io.Fonts->TexID = reinterpret_cast<ImTextureID>(texture);
 }
 
 static Stats s_stats; // TODO: pass as an argument?

src/spice2x/overlay/overlay.cpp

@@ -7,6 +7,7 @@
 #include "hooks/graphics/graphics.h"
 #include "misc/eamuse.h"
 #include "touch/touch.h"
+#include "util/fileutils.h"
 #include "util/logging.h"
 #include "util/resutils.h"
 #include "build/resource.h"
@@ -59,6 +60,7 @@ namespace overlay {
     std::mutex OVERLAY_MUTEX;
     std::unique_ptr<overlay::SpiceOverlay> OVERLAY = nullptr;
     ImFont* DSEG_FONT = nullptr;
+    bool SHOW_DEBUG_LOG_WINDOW = false;
 }
 
 static void *ImGui_Alloc(size_t sz, void *user_data) {
@@ -239,13 +241,20 @@ void overlay::SpiceOverlay::init() {
     io.UserData = this;
     io.ConfigFlags = ImGuiConfigFlags_NavEnableKeyboard
                      | ImGuiConfigFlags_NavEnableGamepad
-                     | ImGuiConfigFlags_NavEnableSetMousePos
-                     | ImGuiConfigFlags_DockingEnable
-                     | ImGuiConfigFlags_ViewportsEnable;
+                     | ImGuiConfigFlags_NavEnableSetMousePos;
+
+    if (!cfg::CONFIGURATOR_STANDALONE) {
+        io.ConfigFlags |= ImGuiConfigFlags_DockingEnable;
+        io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable;
+    }
     if (is_touch_available()) {
         io.ConfigFlags |= ImGuiConfigFlags_IsTouchScreen;
     }
 
+    // temporarily turn this off as it can cause crashes during font load failures
+    // turns back on in ImGui_ImplSpice_Init
+    io.ConfigErrorRecoveryEnableTooltip = false;
+
     io.MouseDrawCursor = !GRAPHICS_SHOW_CURSOR;
 
     // disable config
@@ -260,20 +269,14 @@ void overlay::SpiceOverlay::init() {
     // add fallback fonts for missing glyph ranges
     ImFontConfig config {};
     config.MergeMode = true;
-    io.Fonts->AddFontFromFileTTF(R"(C:\Windows\Fonts\simsun.ttc)",
-            13.0f, &config, io.Fonts->GetGlyphRangesChineseSimplifiedCommon());
-    io.Fonts->AddFontFromFileTTF(R"(C:\Windows\Fonts\arial.ttf)",
-            13.0f, &config, io.Fonts->GetGlyphRangesCyrillic());
-    io.Fonts->AddFontFromFileTTF(R"(C:\Windows\Fonts\meiryu.ttc)",
-            13.0f, &config, io.Fonts->GetGlyphRangesJapanese());
-    io.Fonts->AddFontFromFileTTF(R"(C:\Windows\Fonts\meiryo.ttc)",
-            13.0f, &config, io.Fonts->GetGlyphRangesJapanese());
-    io.Fonts->AddFontFromFileTTF(R"(C:\Windows\Fonts\gulim.ttc)",
-            13.0f, &config, io.Fonts->GetGlyphRangesKorean());
-    io.Fonts->AddFontFromFileTTF(R"(C:\Windows\Fonts\cordia.ttf)",
-            13.0f, &config, io.Fonts->GetGlyphRangesThai());
-    io.Fonts->AddFontFromFileTTF(R"(C:\Windows\Fonts\arial.ttf)",
-            13.0f, &config, io.Fonts->GetGlyphRangesVietnamese());
+
+    add_font("simsun.ttc", &config, io.Fonts->GetGlyphRangesChineseSimplifiedCommon());
+    add_font("arial.ttc", &config, io.Fonts->GetGlyphRangesCyrillic());
+    add_font("meiryu.ttc", &config, io.Fonts->GetGlyphRangesJapanese());
+    add_font("meiryo.ttc", &config, io.Fonts->GetGlyphRangesJapanese());
+    add_font("gulim.ttc", &config, io.Fonts->GetGlyphRangesKorean());
+    add_font("cordia.ttc", &config, io.Fonts->GetGlyphRangesThai());
+    add_font("arial.ttc", &config, io.Fonts->GetGlyphRangesVietnamese());
 
     // add special font
     if (avs::game::is_model("LDJ")) {
@@ -455,6 +458,10 @@ void overlay::SpiceOverlay::new_frame() {
         window->build();
     }
 
+    if (SHOW_DEBUG_LOG_WINDOW) {
+        ImGui::ShowDebugLogWindow(&SHOW_DEBUG_LOG_WINDOW);
+    }
+
     // end frame
     ImGui::EndFrame();
 }
@@ -690,3 +697,21 @@ uint32_t *overlay::SpiceOverlay::sw_get_pixel_data(int *width, int *height) {
     *height = this->pixel_data_height;
     return &this->pixel_data[0];
 }
+
+void overlay::SpiceOverlay::add_font(const char* font, ImFontConfig* config, const ImWchar* glyphs) {
+    CHAR fonts_dir[MAX_PATH];
+    ExpandEnvironmentStringsA(R"(%SYSTEMROOT%\Fonts\)", fonts_dir, MAX_PATH);
+    std::filesystem::path full_path = fonts_dir;
+    full_path += font;
+
+    if (fileutils::file_exists(full_path)) {
+        log_misc("overlay", "loading font: {}", full_path.string());
+        ImGui::GetIO().Fonts->AddFontFromFileTTF(
+            full_path.string().c_str(),
+            13.0f,
+            config,
+            glyphs);
+    } else {
+        log_misc("overlay", "font not found: {}", full_path.string());
+    }
+}

src/spice2x/overlay/overlay.h

@@ -26,6 +26,7 @@ namespace overlay {
     extern bool AUTO_SHOW_KEYPAD_P2;
     extern bool USE_WM_CHAR_FOR_IMGUI_CHAR_INPUT;
     extern bool FPS_SHOULD_FLIP;
+    extern bool SHOW_DEBUG_LOG_WINDOW;
 
     class SpiceOverlay {
     public:
@@ -128,6 +129,7 @@ namespace overlay {
         bool hotkey_toggle_last = false;
 
         void init();
+        void add_font(const char* font, ImFontConfig* config, const ImWchar* glyphs);
     };
 
     // global

src/spice2x/overlay/window.cpp

@@ -99,10 +99,9 @@ void overlay::Window::build() {
             for (auto &child : this->children) {
                 child->build();
             }
-
-            // end window
-            ImGui::End();
         }
+        // end window
+        ImGui::End();
 
         if (this->remove_window_padding) {
             ImGui::PopStyleVar();

src/spice2x/overlay/windows/card_manager.cpp

@@ -115,7 +115,6 @@ namespace overlay::windows {
             ImGui::BeginDisabled();
             ImGui::Button("  <No card>  \n  xxxx xxxx xxxx xxxx  ");
             ImGui::EndDisabled();
-            ImGui::PopStyleColor(4);
         }
     }
 

src/spice2x/overlay/windows/config.cpp

@@ -3054,13 +3054,13 @@ namespace overlay::windows {
 
         // workaround for popups triggered by menu, see https://github.com/ocornut/imgui/issues/331
         if (about_popup) {
-            ImGui::OpenPopup("About");
+            ImGui::OpenPopup("About##topbarpopup");
         }
         if (licenses_popup) {
-            ImGui::OpenPopup("Licenses");
+            ImGui::OpenPopup("Licenses##topbarpopup");
         }
         if (shutdown_popup) {
-            ImGui::OpenPopup("System");
+            ImGui::OpenPopup("System##topbarpopup");
         }
 
         // draw popups
@@ -3069,7 +3069,7 @@ namespace overlay::windows {
             bool unused_open = true;
 
             if (ImGui::BeginPopupModal(
-                "System",
+                "System##topbarpopup",
                 &unused_open,
                 ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoResize)) {
 
@@ -3108,13 +3108,15 @@ namespace overlay::windows {
             
             ImGui::SetNextWindowSize(popup_size, ImGuiCond_Appearing);
             ImGui::SetNextWindowPos(popup_pos, ImGuiCond_Appearing);
-            if (ImGui::BeginPopupModal("About", &unused_open)) {
+            bool unused_open2 = true;
+            if (ImGui::BeginPopupModal("About##topbarpopup", &unused_open2)) {
                 this->build_about();
                 ImGui::EndPopup();
             }
             ImGui::SetNextWindowSize(popup_size, ImGuiCond_Appearing);
             ImGui::SetNextWindowPos(popup_pos, ImGuiCond_Appearing);
-            if (ImGui::BeginPopupModal("Licenses", &unused_open)) {
+            bool unused_open3 = true;
+            if (ImGui::BeginPopupModal("Licenses##topbarpopup", &unused_open3)) {
                 this->build_licenses();
                 ImGui::EndPopup();
             }

src/spice2x/overlay/windows/control.cpp

@@ -178,9 +178,11 @@ namespace overlay::windows {
                     static_cast<int>(ImGui::GetIO().DisplaySize.x),
                     static_cast<int>(ImGui::GetIO().DisplaySize.y));
 
-            // removed for size (along with setting IMGUI_DISABLE_DEMO_WINDOWS
-            // and IMGUI_DISABLE_DEBUG_TOOLS) - saves about 300kb in each
-            // binary
+            if (ImGui::Button("ImGui Debug Log")) {
+                overlay::SHOW_DEBUG_LOG_WINDOW = !overlay::SHOW_DEBUG_LOG_WINDOW;
+            }
+
+            // removed for size (IMGUI_DISABLE_DEMO_WINDOWS)
 
             // metrics button
             // this->metrics_open |= ImGui::Button("Metrics Window");

src/spice2x/overlay/windows/generic_sub.cpp

@@ -206,7 +206,7 @@ namespace overlay::windows {
         bottom_right.x += overlay_content_top_left.x;
         bottom_right.y += overlay_content_top_left.y;
         ImGui::GetBackgroundDrawList()->AddImage(
-            reinterpret_cast<void *>(this->texture),
+            reinterpret_cast<ImTextureID>(this->texture),
             overlay_content_top_left,
             bottom_right);