add tests for rebinds

Author: jojoe77777

CMakeLists.txt

@@ -651,6 +651,7 @@ endif()
 set(TOOLSCREEN_GUI_INTEGRATION_SUITE_FILES
     ${CMAKE_CURRENT_SOURCE_DIR}/tests/gui_integration_tests.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/tests/gui_integration/config_tests.inl
+    ${CMAKE_CURRENT_SOURCE_DIR}/tests/gui_integration/rebind_tests.inl
     ${CMAKE_CURRENT_SOURCE_DIR}/tests/gui_integration/render_tests.inl
     ${CMAKE_CURRENT_SOURCE_DIR}/tests/gui_integration/ui_and_log_tests.inl
     ${CMAKE_CURRENT_SOURCE_DIR}/tests/gui_integration/runner.inl
@@ -678,6 +679,7 @@ target_compile_definitions(toolscreen_gui_integration_tests PRIVATE
     CMAKE_BUILD
     GLEW_STATIC
     NOMINMAX
+    TOOLSCREEN_GUI_INTEGRATION_TESTS
     UNICODE
     _UNICODE
 )
@@ -761,6 +763,21 @@ set(TOOLSCREEN_GUI_INTEGRATION_TEST_CASES
     config-load-key-rebind-escaped-unicode-string-parsed
     config-load-key-rebind-hex-unicode-string-parsed
     config-load-key-rebind-invalid-unicode-defaulted
+    config-load-key-rebind-shift-layer-caps-lock-parsed
+    config-load-key-rebind-shift-layer-caps-lock-defaulted
+    key-rebind-runtime-full-forwarding
+    key-rebind-runtime-split-vk-output
+    key-rebind-runtime-split-unicode-output
+    key-rebind-runtime-shift-layer-shift-activated
+    key-rebind-runtime-shift-layer-caps-lock-activated
+    key-rebind-runtime-full-caps-lock-honored
+    key-rebind-runtime-split-caps-lock-ignored
+    key-rebind-runtime-non-typable-trigger-consumes-char
+    key-rebind-runtime-mouse-source-emits-key-and-char
+    key-rebind-runtime-disabled-rebind-ignored
+    key-rebind-gui-keyboard-layout-full-bind-and-trigger
+    key-rebind-gui-keyboard-layout-split-bind-and-trigger
+    key-rebind-gui-keyboard-layout-mouse-source-bind-and-trigger
     config-load-fullscreen-stretch-repaired
     config-load-preemptive-sync-existing-mode
     config-load-thin-min-width-enforced

lang/en.json

@@ -298,6 +298,7 @@
     "inputs.tooltip.rebind_triggers": "Changes the game keybind this key triggers, including non-text actions like Backspace or Home.",
     "inputs.tooltip.rebind_types": "Changes what this key types in chat, search boxes, and other in-game text fields.",
     "inputs.tooltip.rebind_types_shift": "Changes what this key types while Shift is held in in-game text fields. Leave it unchanged to inherit Types.",
+    "inputs.tooltip.rebind_types_shift_caps_lock": "When enabled, Caps Lock also activates this key's Shift layer in split rebind mode.",
     "inputs.tooltip.rebind_toggle_hotkey": "Toggles key rebinding ACTIVE/DISABLED at runtime.",
     "inputs.tooltip.resolve_rebind_targets": "When enabled, hotkeys can match the rebind target key for the pressed source key. Disable to only match the actual pressed key.",
     "inputs.tooltip.right_click_to_configure": "Right-click to configure rebinds.",
@@ -307,6 +308,7 @@
     "inputs.triggers_format": "Triggers: {}",
     "inputs.triggers_label": "Triggers:",
     "inputs.shift_layer_label": "Shift layer",
+    "inputs.shift_layer_caps_lock_label": "Caps Lock triggers shift layer",
     "inputs.shift_layer_output_shifted_label": "Type uppercase / symbol",
     "inputs.types_shift_inherits_format": "Same as Types ({})",
     "inputs.types_shift_format": "Types (Shift): {}",

lang/zh_CN.json

@@ -298,6 +298,7 @@
     "inputs.tooltip.rebind_triggers": "更改此按键触发的游戏按键绑定，包括 Backspace 或 Home 之类的非文本动作。",
     "inputs.tooltip.rebind_types": "更改此按键在聊天、搜索框和其他游戏文本输入中实际输入的内容。",
     "inputs.tooltip.rebind_types_shift": "更改按住 Shift 时，此按键在游戏文本输入中实际输入的内容。留空时会继承“类型”设置。",
+    "inputs.tooltip.rebind_types_shift_caps_lock": "启用后，在拆分重绑定模式下，Caps Lock 也会触发该按键的 Shift 层。",
     "inputs.tooltip.rebind_toggle_hotkey": "在运行时切换按键重绑定的激活/禁用状态。",
     "inputs.tooltip.resolve_rebind_targets": "启用后，快捷键可以匹配按下源键的重绑定目标键。禁用以仅匹配实际按下的键。",
     "inputs.tooltip.right_click_to_configure": "右键单击以配置重绑定。",
@@ -307,6 +308,7 @@
     "inputs.triggers_format": "触发器：{}",
     "inputs.triggers_label": "触发器：",
     "inputs.shift_layer_label": "Shift 层",
+    "inputs.shift_layer_caps_lock_label": "Caps Lock 触发 Shift 层",
     "inputs.shift_layer_output_shifted_label": "输入大写 / 符号",
     "inputs.types_shift_inherits_format": "与类型相同（{}）",
     "inputs.types_shift_format": "类型（Shift）：{}",

src/config/config_defaults.h

@@ -182,6 +182,7 @@ constexpr DWORD KEY_REBIND_CUSTOM_OUTPUT_UNICODE = 0;
 constexpr DWORD KEY_REBIND_CUSTOM_OUTPUT_SCANCODE = 0;
 constexpr bool KEY_REBIND_BASE_OUTPUT_SHIFTED = false;
 constexpr bool KEY_REBIND_SHIFT_LAYER_ENABLED = false;
+constexpr bool KEY_REBIND_SHIFT_LAYER_USES_CAPS_LOCK = false;
 constexpr DWORD KEY_REBIND_SHIFT_LAYER_OUTPUT_VK = 0;
 constexpr DWORD KEY_REBIND_SHIFT_LAYER_OUTPUT_UNICODE = 0;
 constexpr bool KEY_REBIND_SHIFT_LAYER_OUTPUT_SHIFTED = false;

src/config/config_toml.cpp

@@ -1702,6 +1702,7 @@ void KeyRebindToToml(const KeyRebind& cfg, toml::table& out) {
     out.insert("customOutputScanCode", static_cast<int64_t>(cfg.customOutputScanCode));
     out.insert("baseOutputShifted", cfg.baseOutputShifted);
     out.insert("shiftLayerEnabled", cfg.shiftLayerEnabled);
+    out.insert("shiftLayerUsesCapsLock", cfg.shiftLayerUsesCapsLock);
     out.insert("shiftLayerOutputVK", static_cast<int64_t>(cfg.shiftLayerOutputVK));
     out.insert("shiftLayerOutputUnicode", static_cast<int64_t>(cfg.shiftLayerOutputUnicode));
     out.insert("shiftLayerOutputShifted", cfg.shiftLayerOutputShifted);
@@ -1809,6 +1810,8 @@ void KeyRebindFromToml(const toml::table& tbl, KeyRebind& cfg) {
         static_cast<DWORD>(GetOr<int64_t>(tbl, "customOutputScanCode", ConfigDefaults::KEY_REBIND_CUSTOM_OUTPUT_SCANCODE));
     cfg.baseOutputShifted = GetOr(tbl, "baseOutputShifted", ConfigDefaults::KEY_REBIND_BASE_OUTPUT_SHIFTED);
     cfg.shiftLayerEnabled = GetOr(tbl, "shiftLayerEnabled", ConfigDefaults::KEY_REBIND_SHIFT_LAYER_ENABLED);
+    cfg.shiftLayerUsesCapsLock =
+        GetOr(tbl, "shiftLayerUsesCapsLock", ConfigDefaults::KEY_REBIND_SHIFT_LAYER_USES_CAPS_LOCK);
     cfg.shiftLayerOutputVK =
         static_cast<DWORD>(GetOr<int64_t>(tbl, "shiftLayerOutputVK", ConfigDefaults::KEY_REBIND_SHIFT_LAYER_OUTPUT_VK));
     cfg.shiftLayerOutputUnicode = ConfigDefaults::KEY_REBIND_SHIFT_LAYER_OUTPUT_UNICODE;

src/gui/gui.cpp

@@ -74,6 +74,70 @@ namespace {
 const char* s_forcedSettingsTopTabLabel = nullptr;
 const char* s_forcedSettingsInputsSubTabLabel = nullptr;
 
+#ifdef TOOLSCREEN_GUI_INTEGRATION_TESTS
+std::unordered_map<std::string, GuiTestInteractionRect> s_guiTestInteractionRects;
+bool s_guiTestOpenKeyboardLayoutRequested = false;
+DWORD s_guiTestOpenKeyboardLayoutContextVk = 0;
+int s_guiTestKeyboardLayoutSplitModeRequest = -1;
+GuiTestKeyboardLayoutBindTarget s_guiTestKeyboardLayoutBindTargetRequest = GuiTestKeyboardLayoutBindTarget::None;
+int s_guiTestKeyboardLayoutShiftUppercaseRequest = -1;
+int s_guiTestKeyboardLayoutShiftCapsLockRequest = -1;
+
+void RecordGuiTestInteractionRect(const char* id, const ImVec2& min, const ImVec2& max) {
+    if (id == nullptr) {
+        return;
+    }
+
+    s_guiTestInteractionRects[std::string(id)] = GuiTestInteractionRect{ min.x, min.y, max.x, max.y };
+}
+
+void RecordGuiTestInteractionRect(const std::string& id, const ImVec2& min, const ImVec2& max) {
+    RecordGuiTestInteractionRect(id.c_str(), min, max);
+}
+
+void RecordGuiTestKeyboardLayoutKeyRect(DWORD vk, const ImVec2& min, const ImVec2& max) {
+    char id[96] = {};
+    sprintf_s(id, "inputs.keyboard_layout.key.%u", static_cast<unsigned>(vk));
+    RecordGuiTestInteractionRect(id, min, max);
+}
+
+bool ConsumeGuiTestOpenKeyboardLayoutRequest() {
+    const bool requested = s_guiTestOpenKeyboardLayoutRequested;
+    s_guiTestOpenKeyboardLayoutRequested = false;
+    return requested;
+}
+
+DWORD ConsumeGuiTestOpenKeyboardLayoutContextRequest() {
+    const DWORD vk = s_guiTestOpenKeyboardLayoutContextVk;
+    s_guiTestOpenKeyboardLayoutContextVk = 0;
+    return vk;
+}
+
+int ConsumeGuiTestKeyboardLayoutSplitModeRequest() {
+    const int request = s_guiTestKeyboardLayoutSplitModeRequest;
+    s_guiTestKeyboardLayoutSplitModeRequest = -1;
+    return request;
+}
+
+GuiTestKeyboardLayoutBindTarget ConsumeGuiTestKeyboardLayoutBindTargetRequest() {
+    const GuiTestKeyboardLayoutBindTarget request = s_guiTestKeyboardLayoutBindTargetRequest;
+    s_guiTestKeyboardLayoutBindTargetRequest = GuiTestKeyboardLayoutBindTarget::None;
+    return request;
+}
+
+int ConsumeGuiTestKeyboardLayoutShiftUppercaseRequest() {
+    const int request = s_guiTestKeyboardLayoutShiftUppercaseRequest;
+    s_guiTestKeyboardLayoutShiftUppercaseRequest = -1;
+    return request;
+}
+
+int ConsumeGuiTestKeyboardLayoutShiftCapsLockRequest() {
+    const int request = s_guiTestKeyboardLayoutShiftCapsLockRequest;
+    s_guiTestKeyboardLayoutShiftCapsLockRequest = -1;
+    return request;
+}
+#endif
+
 bool BeginSelectableSettingsTopTabItem(const char* label) {
     ImGuiTabItemFlags flags = ImGuiTabItemFlags_None;
     if (s_forcedSettingsTopTabLabel != nullptr && std::strcmp(s_forcedSettingsTopTabLabel, label) == 0) {
@@ -132,6 +196,50 @@ void CloseSettingsGuiWindow() {
 
 }
 
+#ifdef TOOLSCREEN_GUI_INTEGRATION_TESTS
+void ResetGuiTestInteractionRects() {
+    s_guiTestInteractionRects.clear();
+}
+
+bool GetGuiTestInteractionRect(const char* id, GuiTestInteractionRect& outRect) {
+    if (id == nullptr) {
+        return false;
+    }
+
+    const auto found = s_guiTestInteractionRects.find(id);
+    if (found == s_guiTestInteractionRects.end()) {
+        return false;
+    }
+
+    outRect = found->second;
+    return true;
+}
+
+void RequestGuiTestOpenKeyboardLayout() {
+    s_guiTestOpenKeyboardLayoutRequested = true;
+}
+
+void RequestGuiTestOpenKeyboardLayoutContext(DWORD vk) {
+    s_guiTestOpenKeyboardLayoutContextVk = vk;
+}
+
+void RequestGuiTestKeyboardLayoutSetSplitMode(bool splitMode) {
+    s_guiTestKeyboardLayoutSplitModeRequest = splitMode ? 1 : 0;
+}
+
+void RequestGuiTestKeyboardLayoutBeginBind(GuiTestKeyboardLayoutBindTarget target) {
+    s_guiTestKeyboardLayoutBindTargetRequest = target;
+}
+
+void RequestGuiTestKeyboardLayoutSetShiftLayerUppercase(bool enabled) {
+    s_guiTestKeyboardLayoutShiftUppercaseRequest = enabled ? 1 : 0;
+}
+
+void RequestGuiTestKeyboardLayoutSetShiftLayerUsesCapsLock(bool enabled) {
+    s_guiTestKeyboardLayoutShiftCapsLockRequest = enabled ? 1 : 0;
+}
+#endif
+
 void SetGuiTabSelectionOverride(const char* topLevelTabLabel, const char* inputsSubTabLabel) {
     s_forcedSettingsTopTabLabel = topLevelTabLabel;
     s_forcedSettingsInputsSubTabLabel = inputsSubTabLabel;
@@ -210,6 +318,10 @@ void RenderConfigErrorGUI() {
 void RenderSettingsGUI() {
     ResetTransientBindingUiState();
 
+#ifdef TOOLSCREEN_GUI_INTEGRATION_TESTS
+    ResetGuiTestInteractionRects();
+#endif
+
     static const std::vector<std::pair<const char*, const char*>>
         relativeToOptions = {
             {"topLeftViewport", trc("position.top_left_viewport")},

src/gui/gui.h

@@ -66,6 +66,32 @@ void ApplyDynamicGuiFontRefresh();
 void RequestKeyboardLayoutFontRefresh(const ImVec2& windowSize, float keyHeight, float keyboardScale, bool forceRefresh = false);
 void ApplyPendingKeyboardLayoutFontRefresh();
 
+#ifdef TOOLSCREEN_GUI_INTEGRATION_TESTS
+struct GuiTestInteractionRect {
+    float minX = 0.0f;
+    float minY = 0.0f;
+    float maxX = 0.0f;
+    float maxY = 0.0f;
+};
+
+enum class GuiTestKeyboardLayoutBindTarget {
+    None,
+    FullOutputVk,
+    TypesVk,
+    TypesVkShift,
+    TriggersVk,
+};
+
+void ResetGuiTestInteractionRects();
+bool GetGuiTestInteractionRect(const char* id, GuiTestInteractionRect& outRect);
+void RequestGuiTestOpenKeyboardLayout();
+void RequestGuiTestOpenKeyboardLayoutContext(DWORD vk);
+void RequestGuiTestKeyboardLayoutSetSplitMode(bool splitMode);
+void RequestGuiTestKeyboardLayoutBeginBind(GuiTestKeyboardLayoutBindTarget target);
+void RequestGuiTestKeyboardLayoutSetShiftLayerUppercase(bool enabled);
+void RequestGuiTestKeyboardLayoutSetShiftLayerUsesCapsLock(bool enabled);
+#endif
+
 extern ImFont* g_keyboardLayoutPrimaryFont;
 extern ImFont* g_keyboardLayoutSecondaryFont;
 
@@ -474,6 +500,7 @@ struct KeyRebind {
     DWORD customOutputScanCode = 0;
     bool baseOutputShifted = false;
     bool shiftLayerEnabled = false;
+    bool shiftLayerUsesCapsLock = false;
     DWORD shiftLayerOutputVK = 0;
     DWORD shiftLayerOutputUnicode = 0;
     bool shiftLayerOutputShifted = false;