Edit Shortcuts UI (dev/keyboardManager) (#1647)

* Added EditShortcuts Window and added Detecting shortcuts functionality * Fixed build error * Changed detection to take place only when window is in focus * Added solution folder * Added a common project and refactored shared variables to an object with wrapper functions * Added dynamic addition of shortcuts * Moved all shared variables in detection to state variable with wrapper functions * Added code to re-load saved shortcuts in the UI * Added comments * Fixed argument modifiers in Helpers * Updated arg modifiers in all functions * Removed unused headers and added precompiled headers
2026-04-05 10:46:33 +02:00 · 2020-03-23 10:44:02 -07:00
parent fc7e7074ce
commit b713083574
31 changed files with 1062 additions and 214 deletions
--- a/src/modules/keyboardmanager/common/Helpers.cpp
+++ b/src/modules/keyboardmanager/common/Helpers.cpp
@@ -0,0 +1,28 @@
+#include "pch.h"
+#include "Helpers.h"
+#include <sstream>
+
+// Function to split a wstring based on a delimiter and return a vector of split strings
+std::vector<std::wstring> splitwstring(const std::wstring& input, wchar_t delimiter)
+{
+    std::wstringstream ss(input);
+    std::wstring item;
+    std::vector<std::wstring> splittedStrings;
+    while (std::getline(ss, item, L' '))
+    {
+        splittedStrings.push_back(item);
+    }
+
+    return splittedStrings;
+}
+
+// Function to return the next sibling element for an element under a stack panel
+IInspectable getSiblingElement(IInspectable const& element)
+{
+    FrameworkElement frameworkElement = element.as<FrameworkElement>();
+    StackPanel parentElement = frameworkElement.Parent().as<StackPanel>();
+    uint32_t index;
+
+    parentElement.Children().IndexOf(frameworkElement, index);
+    return parentElement.Children().GetAt(index + 1);
+}
--- a/src/modules/keyboardmanager/common/Helpers.h
+++ b/src/modules/keyboardmanager/common/Helpers.h
@@ -0,0 +1,34 @@
+#pragma once
+#include <vector>
+#include <winrt/Windows.System.h>
+
+// Function to split a wstring based on a delimiter and return a vector of split strings
+std::vector<std::wstring> splitwstring(const std::wstring& input, wchar_t delimiter);
+
+// Function to return the next sibling element for an element under a stack panel
+winrt::Windows::Foundation::IInspectable getSiblingElement(winrt::Windows::Foundation::IInspectable const& element);
+
+// Function to convert an unsigned int vector to hstring by concatenating them
+template<typename T>
+winrt::hstring convertVectorToHstring(const std::vector<T>& input)
+{
+    winrt::hstring output;
+    for (int i = 0; i < input.size(); i++)
+    {
+        output = output + winrt::to_hstring((unsigned int)input[i]) + winrt::to_hstring(L" ");
+    }
+    return output;
+}
+
+// Function to convert a wstring vector to a integer vector
+template<typename T>
+std::vector<T> convertWStringVectorToIntegerVector(const std::vector<std::wstring>& input)
+{
+    std::vector<T> typeVector;
+    for (int i = 0; i < input.size(); i++)
+    {
+        typeVector.push_back((T)std::stoi(input[i]));
+    }
+
+    return typeVector;
+}
--- a/src/modules/keyboardmanager/common/KeyboardManagerCommon.vcxproj
+++ b/src/modules/keyboardmanager/common/KeyboardManagerCommon.vcxproj
@@ -0,0 +1,110 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <ItemGroup Label="ProjectConfigurations">
+    <ProjectConfiguration Include="Debug|x64">
+      <Configuration>Debug</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release|x64">
+      <Configuration>Release</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+  </ItemGroup>
+  <PropertyGroup Label="Globals">
+    <VCProjectVersion>16.0</VCProjectVersion>
+    <ProjectGuid>{8AFFA899-0B73-49EC-8C50-0FADDA57B2FC}</ProjectGuid>
+    <RootNamespace>KeyboardManagerCommon</RootNamespace>
+    <WindowsTargetPlatformVersion>10.0</WindowsTargetPlatformVersion>
+  </PropertyGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
+    <ConfigurationType>StaticLibrary</ConfigurationType>
+    <UseDebugLibraries>true</UseDebugLibraries>
+    <PlatformToolset>v142</PlatformToolset>
+    <CharacterSet>Unicode</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
+    <ConfigurationType>StaticLibrary</ConfigurationType>
+    <UseDebugLibraries>false</UseDebugLibraries>
+    <PlatformToolset>v142</PlatformToolset>
+    <WholeProgramOptimization>true</WholeProgramOptimization>
+    <CharacterSet>Unicode</CharacterSet>
+  </PropertyGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
+  <ImportGroup Label="ExtensionSettings">
+  </ImportGroup>
+  <ImportGroup Label="Shared">
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <PropertyGroup Label="UserMacros" />
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <LinkIncremental>true</LinkIncremental>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <LinkIncremental>false</LinkIncremental>
+  </PropertyGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <ClCompile>
+      <WarningLevel>Level3</WarningLevel>
+      <SDLCheck>true</SDLCheck>
+      <PreprocessorDefinitions>_DEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <ConformanceMode>true</ConformanceMode>
+      <LanguageStandard>stdcpplatest</LanguageStandard>
+      <RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>
+      <AdditionalIncludeDirectories>$(SolutionDir)src\;$(SolutionDir)src\modules;$(SolutionDir)src\common\Telemetry;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <PrecompiledHeader>Use</PrecompiledHeader>
+      <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
+    </ClCompile>
+    <Link>
+      <SubSystem>Console</SubSystem>
+      <GenerateDebugInformation>true</GenerateDebugInformation>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <ClCompile>
+      <WarningLevel>Level3</WarningLevel>
+      <FunctionLevelLinking>true</FunctionLevelLinking>
+      <IntrinsicFunctions>true</IntrinsicFunctions>
+      <SDLCheck>true</SDLCheck>
+      <PreprocessorDefinitions>NDEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <ConformanceMode>true</ConformanceMode>
+      <LanguageStandard>stdcpplatest</LanguageStandard>
+      <AdditionalIncludeDirectories>$(SolutionDir)src\;$(SolutionDir)src\modules;$(SolutionDir)src\common\Telemetry;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
+      <PrecompiledHeader>Use</PrecompiledHeader>
+      <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
+    </ClCompile>
+    <Link>
+      <SubSystem>Console</SubSystem>
+      <EnableCOMDATFolding>true</EnableCOMDATFolding>
+      <OptimizeReferences>true</OptimizeReferences>
+      <GenerateDebugInformation>true</GenerateDebugInformation>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemGroup>
+    <ClCompile Include="Helpers.cpp" />
+    <ClCompile Include="KeyboardManagerState.cpp" />
+    <ClCompile Include="pch.cpp">
+      <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Release|x64'">Create</PrecompiledHeader>
+      <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">Create</PrecompiledHeader>
+    </ClCompile>
+  </ItemGroup>
+  <ItemGroup>
+    <ClInclude Include="Helpers.h" />
+    <ClInclude Include="KeyboardManagerState.h" />
+    <ClInclude Include="pch.h" />
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\..\..\common\common.vcxproj">
+      <Project>{74485049-c722-400f-abe5-86ac52d929b3}</Project>
+    </ProjectReference>
+  </ItemGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
+  <ImportGroup Label="ExtensionTargets">
+  </ImportGroup>
+</Project>
--- a/src/modules/keyboardmanager/common/KeyboardManagerCommon.vcxproj.filters
+++ b/src/modules/keyboardmanager/common/KeyboardManagerCommon.vcxproj.filters
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <ItemGroup>
+    <Filter Include="Source Files">
+      <UniqueIdentifier>{4FC737F1-C7A5-4376-A066-2A32D752A2FF}</UniqueIdentifier>
+      <Extensions>cpp;c;cc;cxx;c++;def;odl;idl;hpj;bat;asm;asmx</Extensions>
+    </Filter>
+    <Filter Include="Header Files">
+      <UniqueIdentifier>{93995380-89BD-4b04-88EB-625FBE52EBFB}</UniqueIdentifier>
+      <Extensions>h;hh;hpp;hxx;h++;hm;inl;inc;ipp;xsd</Extensions>
+    </Filter>
+    <Filter Include="Resource Files">
+      <UniqueIdentifier>{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}</UniqueIdentifier>
+      <Extensions>rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms</Extensions>
+    </Filter>
+  </ItemGroup>
+  <ItemGroup>
+    <ClCompile Include="KeyboardManagerState.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
+    <ClCompile Include="Helpers.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
+    <ClCompile Include="pch.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
+  </ItemGroup>
+  <ItemGroup>
+    <ClInclude Include="KeyboardManagerState.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="Helpers.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="pch.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+  </ItemGroup>
+</Project>
--- a/src/modules/keyboardmanager/common/KeyboardManagerState.cpp
+++ b/src/modules/keyboardmanager/common/KeyboardManagerState.cpp
@@ -0,0 +1,140 @@
+#include "pch.h"
+#include "KeyboardManagerState.h"
+
+// Constructor
+KeyboardManagerState::KeyboardManagerState() :
+    uiState(KeyboardManagerUIState::Deactivated), currentUIWindow(nullptr), currentShortcutTextBlock(nullptr)
+{
+}
+
+// Function to check the if the UI state matches the argument state. For states with activated windows it also checks if the window is in focus.
+bool KeyboardManagerState::CheckUIState(KeyboardManagerUIState state)
+{
+    if (uiState == state)
+    {
+        if (uiState == KeyboardManagerUIState::Deactivated)
+        {
+            return true;
+        }
+        // If the UI state is activated then we also have to ensure that the UI window is in focus.
+        // GetForegroundWindow can be used here since we only need to check the main parent window and not the sub windows within the content dialog. Using GUIThreadInfo will give more specific sub-windows within the XAML window which is not needed.
+        else if (currentUIWindow == GetForegroundWindow())
+        {
+            return true;
+        }
+    }
+
+    return false;
+}
+
+// Function to set the window handle of the current UI window that is activated
+void KeyboardManagerState::SetCurrentUIWindow(HWND windowHandle)
+{
+    currentUIWindow = windowHandle;
+}
+
+// Function to set the UI state. When a window is activated, the handle to the window can be passed in the windowHandle argument.
+void KeyboardManagerState::SetUIState(KeyboardManagerUIState state, HWND windowHandle)
+{
+    uiState = state;
+    currentUIWindow = windowHandle;
+}
+
+// Function to reset the UI state members
+void KeyboardManagerState::ResetUIState()
+{
+    SetUIState(KeyboardManagerUIState::Deactivated);
+    currentShortcutTextBlock = nullptr;
+    detectedShortcut.clear();
+}
+
+// Function to clear the OS Level shortcut remapping table
+void KeyboardManagerState::ClearOSLevelShortcuts()
+{
+    osLevelShortcutReMap.clear();
+}
+
+// Function to add a new OS level shortcut remapping
+void KeyboardManagerState::AddOSLevelShortcut(const std::vector<DWORD>& originalSC, const std::vector<WORD>& newSC)
+{
+    osLevelShortcutReMap[originalSC] = std::make_pair(newSC, false);
+}
+
+// Function to set the textblock of the detect shortcut UI so that it can be accessed by the hook
+void KeyboardManagerState::ConfigureDetectShortcutUI(const TextBlock& textBlock)
+{
+    currentShortcutTextBlock = textBlock;
+}
+
+// Function to update the detect shortcut UI based on the entered keys
+void KeyboardManagerState::UpdateDetectShortcutUI()
+{
+    if (currentShortcutTextBlock == nullptr)
+    {
+        return;
+    }
+
+    hstring shortcutString = convertVectorToHstring<DWORD>(detectedShortcut);
+
+    // Since this function is invoked from the back-end thread, in order to update the UI the dispatcher must be used.
+    currentShortcutTextBlock.Dispatcher().RunAsync(Windows::UI::Core::CoreDispatcherPriority::Normal, [=]() {
+        currentShortcutTextBlock.Text(shortcutString);
+    });
+}
+
+// Function to return the currently detected shortcut which is displayed on the UI
+std::vector<DWORD> KeyboardManagerState::GetDetectedShortcut()
+{
+    hstring detectedShortcutString = currentShortcutTextBlock.Text();
+    std::wstring detectedShortcutWstring = detectedShortcutString.c_str();
+    std::vector<std::wstring> detectedShortcutVector = splitwstring(detectedShortcutWstring, L' ');
+    return convertWStringVectorToIntegerVector<DWORD>(detectedShortcutVector);
+}
+
+// Function which can be used in HandleKeyboardHookEvent before the single key remap event to use the UI and suppress events while the remap window is active.
+bool KeyboardManagerState::DetectKeyUIBackend(LowlevelKeyboardEvent* data)
+{
+    // Check if the detect key UI window has been activated
+    if (CheckUIState(KeyboardManagerUIState::DetectKeyWindowActivated))
+    {
+        // Suppress the keyboard event
+        return true;
+    }
+
+    return false;
+}
+
+// Function which can be used in HandleKeyboardHookEvent before the os level shortcut remap event to use the UI and suppress events while the remap window is active.
+bool KeyboardManagerState::DetectShortcutUIBackend(LowlevelKeyboardEvent* data)
+{
+    // Check if the detect shortcut UI window has been activated
+    if (CheckUIState(KeyboardManagerUIState::DetectShortcutWindowActivated))
+    {
+        // Add the key if it is pressed down
+        if (data->wParam == WM_KEYDOWN || data->wParam == WM_SYSKEYDOWN)
+        {
+            if (std::find(detectedShortcut.begin(), detectedShortcut.end(), data->lParam->vkCode) == detectedShortcut.end())
+            {
+                detectedShortcut.push_back(data->lParam->vkCode);
+                // Update the UI. This function is called here because it should store the set of keys pressed till the last key which was pressed down.
+                UpdateDetectShortcutUI();
+            }
+        }
+        // Remove the key if it has been released
+        else if (data->wParam == WM_KEYUP || data->wParam == WM_SYSKEYUP)
+        {
+            detectedShortcut.erase(std::remove(detectedShortcut.begin(), detectedShortcut.end(), data->lParam->vkCode), detectedShortcut.end());
+        }
+
+        // Suppress the keyboard event
+        return true;
+    }
+
+    // If the detect shortcut UI window is not activated, then clear the shortcut buffer if it isn't empty
+    else if (!detectedShortcut.empty())
+    {
+        detectedShortcut.clear();
+    }
+
+    return false;
+}
--- a/src/modules/keyboardmanager/common/KeyboardManagerState.h
+++ b/src/modules/keyboardmanager/common/KeyboardManagerState.h
@@ -0,0 +1,84 @@
+#pragma once
+//#include "pch.h"
+#include "Helpers.h"
+#include <interface/lowlevel_keyboard_event_data.h>
+#include <winrt/Windows.UI.Xaml.Controls.h>
+
+
+// Enum type to store different states of the UI
+enum class KeyboardManagerUIState
+{
+    // If set to this value then there is no keyboard manager window currently active that requires a hook
+    Deactivated,
+    // If set to this value then the detect key window is currently active and it requires a hook
+    DetectKeyWindowActivated,
+    // If set to this value then the detect shortcut window is currently active and it requires a hook
+    DetectShortcutWindowActivated
+};
+
+// Class to store the shared state of the keyboard manager between the UI and the hook
+class KeyboardManagerState
+{
+private:
+    // State variable used to store which UI window is currently active that requires interaction with the hook
+    KeyboardManagerUIState uiState;
+
+    // Window handle for the current UI window which is active. Should be set to nullptr if UI is deactivated
+    HWND currentUIWindow;
+
+    // Vector to store the shortcut detected in the detect shortcut UI window. This is used in both the backend and the UI.
+    std::vector<DWORD> detectedShortcut;
+
+    // Stores the UI element which is to be updated based on the shortcut entered
+    winrt::Windows::UI::Xaml::Controls::TextBlock currentShortcutTextBlock;
+
+public:
+    // Maps which store the remappings for each of the features. The bool fields should be initalised to false. They are used to check the current state of the shortcut (i.e is that particular shortcut currently pressed down or not).
+    // Stores single key remappings
+    std::unordered_map<DWORD, WORD> singleKeyReMap;
+
+    // Stores keys which need to be changed from toggle behaviour to modifier behaviour. Eg. Caps Lock
+    std::unordered_map<DWORD, bool> singleKeyToggleToMod;
+
+    // Stores the os level shortcut remappings
+    std::map<std::vector<DWORD>, std::pair<std::vector<WORD>, bool>> osLevelShortcutReMap;
+
+    // Stores the app-specific shortcut remappings. Maps application name to the shortcut map
+    std::map<std::wstring, std::map<std::vector<DWORD>, std::pair<std::vector<WORD>, bool>>> appSpecificShortcutReMap;
+
+    // Constructor
+    KeyboardManagerState();
+
+    // Function to reset the UI state members
+    void ResetUIState();
+
+    // Function to check the if the UI state matches the argument state. For states with activated windows it also checks if the window is in focus.
+    bool CheckUIState(KeyboardManagerUIState state);
+
+    // Function to set the window handle of the current UI window that is activated
+    void SetCurrentUIWindow(HWND windowHandle);
+
+    // Function to set the UI state. When a window is activated, the handle to the window can be passed in the windowHandle argument.
+    void SetUIState(KeyboardManagerUIState state, HWND windowHandle = nullptr);
+
+    // Function to clear the OS Level shortcut remapping table
+    void ClearOSLevelShortcuts();
+
+    // Function to add a new OS level shortcut remapping
+    void AddOSLevelShortcut(const std::vector<DWORD>& originalSC, const std::vector<WORD>& newSC);
+
+    // Function to set the textblock of the detect shortcut UI so that it can be accessed by the hook
+    void ConfigureDetectShortcutUI(const winrt::Windows::UI::Xaml::Controls::TextBlock& textBlock);
+
+    // Function to update the detect shortcut UI based on the entered keys
+    void UpdateDetectShortcutUI();
+
+    // Function to return the currently detected shortcut which is displayed on the UI
+    std::vector<DWORD> GetDetectedShortcut();
+
+    // Function which can be used in HandleKeyboardHookEvent before the single key remap event to use the UI and suppress events while the remap window is active.
+    bool DetectKeyUIBackend(LowlevelKeyboardEvent* data);
+
+    // Function which can be used in HandleKeyboardHookEvent before the os level shortcut remap event to use the UI and suppress events while the remap window is active.
+    bool DetectShortcutUIBackend(LowlevelKeyboardEvent* data);
+};
--- a/src/modules/keyboardmanager/common/pch.cpp
+++ b/src/modules/keyboardmanager/common/pch.cpp
@@ -0,0 +1 @@
+#include "pch.h"
--- a/src/modules/keyboardmanager/common/pch.h
+++ b/src/modules/keyboardmanager/common/pch.h
@@ -0,0 +1,24 @@
+#pragma once
+#define WIN32_LEAN_AND_MEAN
+#include <Windows.h>
+#include <winrt/Windows.system.h>
+#include <winrt/windows.ui.xaml.hosting.h>
+#include <windows.ui.xaml.hosting.desktopwindowxamlsource.h>
+#include <winrt/windows.ui.xaml.controls.h>
+#include <winrt/Windows.ui.xaml.media.h>
+#include <winrt/Windows.Foundation.Collections.h>
+#include "winrt/Windows.Foundation.h"
+#include "winrt/Windows.Foundation.Numerics.h"
+#include "winrt/Windows.UI.Xaml.Controls.Primitives.h"
+#include "winrt/Windows.UI.Text.h"
+#include "winrt/Windows.UI.Core.h"
+#include <stdlib.h>
+
+using namespace winrt;
+using namespace Windows::UI;
+using namespace Windows::UI::Composition;
+using namespace Windows::UI::Xaml::Hosting;
+using namespace Windows::Foundation::Numerics;
+using namespace Windows::Foundation;
+using namespace Windows::UI::Xaml;
+using namespace Windows::UI::Xaml::Controls;