feat: Added debug variables to aid with development

lib/libimhex/CMakeLists.txt

@@ -35,6 +35,7 @@ set(LIBIMHEX_SOURCES
         source/helpers/logger.cpp
         source/helpers/stacktrace.cpp
         source/helpers/tar.cpp
+        source/helpers/debugging.cpp
 
         source/providers/provider.cpp
 

lib/libimhex/include/hex/helpers/debugging.hpp

@@ -0,0 +1,48 @@
+#pragma once
+
+#include <wolv/types/static_string.hpp>
+#include <wolv/utils/preproc.hpp>
+
+#include <hex/ui/imgui_imhex_extensions.h>
+
+
+#if defined(DEBUG)
+    #define DBG_DEFINE_DEBUG_VARIABLE(type, name)                       \
+        static type name;                                               \
+        hex::dbg::impl::drawDebugVariable(name, WOLV_STRINGIFY(name));
+#else
+    #define DBG_DEFINE_DEBUG_VARIABLE(type, name)                       \
+        static_assert(false, "Debug variables are only intended for use during development.");
+#endif
+
+namespace hex::dbg {
+
+    namespace impl {
+        bool &getDebugWindowState();
+
+        template<typename T>
+        static void drawDebugVariable(T &variable, std::string_view name) {
+            if (!getDebugWindowState())
+                return;
+
+            if (ImGui::Begin("Debug Variables", &getDebugWindowState(), ImGuiWindowFlags_AlwaysAutoResize)) {
+                using Type = std::remove_cvref_t<T>;
+                if constexpr (std::same_as<Type, bool>) {
+                    ImGui::Checkbox(name.data(), &variable);
+                } else if constexpr (std::integral<Type> || std::floating_point<Type>) {
+                    ImGui::InputScalar(name.data(), ImGui::getImGuiDataType<Type>(), &variable);
+                } else if constexpr (std::same_as<Type, ImVec2>) {
+                    ImGui::InputFloat2(name.data(), &variable.x);
+                } else if constexpr (std::same_as<Type, std::string>) {
+                    ImGui::InputText(name.data(), variable);
+                } else if constexpr (std::same_as<Type, ImColor>) {
+                    ImGui::ColorEdit4(name.data(), &variable.Value.x, ImGuiColorEditFlags_AlphaBar);
+                } else {
+                    static_assert(hex::always_false<Type>::value, "Unsupported type");
+                }
+            }
+            ImGui::End();
+        }
+    }
+
+}

lib/libimhex/include/hex/ui/imgui_imhex_extensions.h

@@ -11,6 +11,7 @@
 #include <imgui_internal.h>
 
 #include <hex/helpers/fmt.hpp>
+#include <hex/helpers/concepts.hpp>
 
 #include <wolv/utils/string.hpp>
 
@@ -246,4 +247,33 @@ namespace ImGui {
     bool DimmedIconToggle(const char *icon, bool *v);
 
     void TextOverlay(const char *text, ImVec2 pos);
+
+    template<typename T>
+    constexpr ImGuiDataType getImGuiDataType() {
+        if constexpr      (std::same_as<T, u8>)     return ImGuiDataType_U8;
+        else if constexpr (std::same_as<T, u16>)    return ImGuiDataType_U16;
+        else if constexpr (std::same_as<T, u32>)    return ImGuiDataType_U32;
+        else if constexpr (std::same_as<T, u64>)    return ImGuiDataType_U64;
+        else if constexpr (std::same_as<T, i8>)     return ImGuiDataType_S8;
+        else if constexpr (std::same_as<T, i16>)    return ImGuiDataType_S16;
+        else if constexpr (std::same_as<T, i32>)    return ImGuiDataType_S32;
+        else if constexpr (std::same_as<T, i64>)    return ImGuiDataType_S64;
+        else if constexpr (std::same_as<T, float>)  return ImGuiDataType_Float;
+        else if constexpr (std::same_as<T, double>) return ImGuiDataType_Double;
+        else static_assert(hex::always_false<T>::value, "Invalid data type!");
+    }
+
+    template<typename T>
+    constexpr const char *getFormatLengthSpecifier() {
+        if constexpr      (std::same_as<T, u8>)     return "hh";
+        else if constexpr (std::same_as<T, u16>)    return "h";
+        else if constexpr (std::same_as<T, u32>)    return "l";
+        else if constexpr (std::same_as<T, u64>)    return "ll";
+        else if constexpr (std::same_as<T, i8>)     return "hh";
+        else if constexpr (std::same_as<T, i16>)    return "h";
+        else if constexpr (std::same_as<T, i32>)    return "l";
+        else if constexpr (std::same_as<T, i64>)    return "ll";
+        else static_assert(hex::always_false<T>::value, "Invalid data type!");
+    }
+
 }

lib/libimhex/source/helpers/debugging.cpp

@@ -0,0 +1,15 @@
+#include <hex/helpers/debugging.hpp>
+
+namespace hex::dbg {
+
+    namespace impl {
+
+        bool &getDebugWindowState() {
+            static bool state = false;
+
+            return state;
+        }
+
+    }
+
+}