Add a log viewer view.

Author: davidgiven

src/gui2/build.py

@@ -514,6 +514,8 @@ def plugin(name, id, srcs, hdrs, romfsdir, deps):
         "./globals.h",
         "./imageview.cc",
         "./imageview.h",
+        "./logview.cc",
+        "./logview.h",
         "./physicalview.cc",
         "./physicalview.h",
         "./summaryview.cc",

src/gui2/datastore.cc

@@ -17,6 +17,7 @@
 #include "lib/usb/usbfinder.h"
 #include "lib/vfs/vfs.h"
 #include "arch/arch.h"
+#include "logview.h"
 #include "globals.h"
 #include "datastore.h"
 #include "utils.h"
@@ -427,6 +428,7 @@ void wtRebuildConfiguration()
 
 void Datastore::onLogMessage(const AnyLogMessage& message)
 {
+    LogView::logMessage(message);
     std::visit(
         overloaded{
             /* Fallback --- do nothing */

src/gui2/fluxengine.cc

@@ -9,6 +9,7 @@
 #include "summaryview.h"
 #include "configview.h"
 #include "controlpanelview.h"
+#include "logview.h"
 #include "diskprovider.h"
 #include "datastore.h"
 
@@ -29,6 +30,7 @@ IMHEX_PLUGIN_SETUP("FluxEngine", "David Given", "FluxEngine integration")
     hex::ContentRegistry::Views::add<SummaryView>();
     hex::ContentRegistry::Views::add<ConfigView>();
     hex::ContentRegistry::Views::add<ControlPanelView>();
+    hex::ContentRegistry::Views::add<LogView>();
 
     Datastore::init();
 }

src/gui2/logview.cc

@@ -0,0 +1,68 @@
+#include <hex/api/content_registry/user_interface.hpp>
+#include <hex/api/theme_manager.hpp>
+#include <hex/helpers/logger.hpp>
+#include <fonts/vscode_icons.hpp>
+#include <fonts/tabler_icons.hpp>
+#include <fmt/format.h>
+#include "lib/core/globals.h"
+#include "lib/config/config.h"
+#include "lib/data/flux.h"
+#include "lib/data/sector.h"
+#include "lib/config/proto.h"
+#include "globals.h"
+#include "logview.h"
+#include "datastore.h"
+#include "utils.h"
+#include <implot.h>
+#include <implot_internal.h>
+
+using namespace hex;
+
+static std::stringstream logstream;
+static std::unique_ptr<LogRenderer> logRenderer =
+    LogRenderer::create(logstream);
+static bool scrollToEndOnNextRedraw = false;
+
+LogView::LogView(): View::Window("fluxengine.view.log.name", ICON_VS_DEBUG) {}
+
+void LogView::drawContent()
+{
+    ImGui::PushStyleColor(ImGuiCol_FrameBg, 0x00000000);
+    ON_SCOPE_EXIT
+    {
+        ImGui::PopStyleColor();
+    };
+
+    auto buffer = logstream.view();
+    ImGui::InputTextMultiline("##logview",
+        (char*)buffer.data(),
+        buffer.size(),
+        ImGui::GetContentRegionAvail(),
+        ImGuiInputTextFlags_ReadOnly);
+
+    /* Hacky code to scroll to the end of the window if something's changed.
+     * See https://github.com/ocornut/imgui/issues/5484
+     */
+
+    if (scrollToEndOnNextRedraw)
+    {
+        scrollToEndOnNextRedraw = false;
+
+        ImGuiContext& g = *GImGui;
+        const char* child_window_name = NULL;
+        ImFormatStringToTempBuffer(&child_window_name,
+            NULL,
+            "%s/%s_%08X",
+            g.CurrentWindow->Name,
+            "##logview",
+            ImGui::GetID("##logview"));
+        ImGuiWindow* child_window = ImGui::FindWindowByName(child_window_name);
+        ImGui::SetScrollY(child_window, child_window->ScrollMax.y);
+    }
+}
+
+void LogView::logMessage(const AnyLogMessage& message)
+{
+    logRenderer->add(message);
+    scrollToEndOnNextRedraw = true;
+}

src/gui2/logview.h

@@ -0,0 +1,23 @@
+#pragma once
+
+#include "lib/core/logger.h"
+#include <hex/ui/view.hpp>
+
+class LogView : public hex::View::Window
+{
+public:
+    LogView();
+    ~LogView() override = default;
+
+    void drawContent() override;
+    static void logMessage(const AnyLogMessage& message);
+
+    [[nodiscard]] bool shouldDraw() const override
+    {
+        return true;
+    }
+    [[nodiscard]] bool hasViewMenuItemEntry() const override
+    {
+        return true;
+    }
+};

src/gui2/rsrc/auto_extract/workspaces/default.hexws

@@ -40,5 +40,7 @@
     "fluxengine.view.controlpanel.writeImage": "Save disk image",
     "fluxengine.view.controlpanel.rereadBad": "Re-read bad tracks",
     "fluxengine.view.controlpanel.createBlank": "Format disk",
-    "fluxengine.view.controlpanel.stop": "Stop"
+    "fluxengine.view.controlpanel.stop": "Stop",
+
+    "fluxengine.view.log.name": "FluxEngine log viewer"
 }