Merge pull request #2667 from Flow-Launcher/duplicate-hotkey-handling

Handle duplicate hotkeys in HotkeyControlDialog

Author: onesounds

Flow.Launcher.Infrastructure/Hotkey/IHotkeySettings.cs

@@ -0,0 +1,17 @@
+using System.Collections.Generic;
+
+namespace Flow.Launcher.Infrastructure.Hotkey;
+
+/// <summary>
+/// Interface that you should implement in your settings class to be able to pass it to
+/// <c>Flow.Launcher.HotkeyControlDialog</c>. It allows the dialog to display the hotkeys that have already been
+/// registered, and optionally provide a way to unregister them.
+/// </summary>
+public interface IHotkeySettings
+{
+    /// <summary>
+    /// A list of hotkeys that have already been registered. The dialog will display these hotkeys and provide a way to
+    /// unregister them.
+    /// </summary>
+    public List<RegisteredHotkeyData> RegisteredHotkeys { get; }
+}

Flow.Launcher.Infrastructure/Hotkey/RegisteredHotkeyData.cs

@@ -0,0 +1,119 @@
+using System;
+
+namespace Flow.Launcher.Infrastructure.Hotkey;
+
+#nullable enable
+
+/// <summary>
+/// Represents a hotkey that has been registered. Used in <c>Flow.Launcher.HotkeyControlDialog</c> via
+/// <see cref="UserSettings"/> and <see cref="IHotkeySettings"/> to display errors if user tries to register a hotkey
+/// that has already been registered, and optionally provides a way to unregister the hotkey.
+/// </summary>
+public record RegisteredHotkeyData
+{
+    /// <summary>
+    /// <see cref="HotkeyModel"/> representation of this hotkey.
+    /// </summary>
+    public HotkeyModel Hotkey { get; }
+
+    /// <summary>
+    /// String key in the localization dictionary that represents this hotkey. For example, <c>ReloadPluginHotkey</c>,
+    /// which represents the string "Reload Plugins Data" in <c>en.xaml</c>
+    /// </summary>
+    public string DescriptionResourceKey { get; }
+
+    /// <summary>
+    /// Array of values that will replace <c>{0}</c>, <c>{1}</c>, <c>{2}</c>, etc. in the localized string found via
+    /// <see cref="DescriptionResourceKey"/>.
+    /// </summary>
+    public object?[] DescriptionFormatVariables { get; } = Array.Empty<object?>();
+
+    /// <summary>
+    /// An action that, when called, will unregister this hotkey. If it's <c>null</c>, it's assumed that
+    /// this hotkey can't be unregistered, and the "Overwrite" option will not appear in the hotkey dialog.
+    /// </summary>
+    public Action? RemoveHotkey { get; }
+
+    /// <summary>
+    /// Creates an instance of <c>RegisteredHotkeyData</c>. Assumes that the key specified in
+    /// <c>descriptionResourceKey</c> doesn't need any arguments for <c>string.Format</c>. If it does,
+    /// use one of the other constructors.
+    /// </summary>
+    /// <param name="hotkey">
+    /// The hotkey this class will represent.
+    /// Example values: <c>F1</c>, <c>Ctrl+Shift+Enter</c>
+    /// </param>
+    /// <param name="descriptionResourceKey">
+    /// The key in the localization dictionary that represents this hotkey. For example, <c>ReloadPluginHotkey</c>,
+    /// which represents the string "Reload Plugins Data" in <c>en.xaml</c>
+    /// </param>
+    /// <param name="removeHotkey">
+    /// An action that, when called, will unregister this hotkey. If it's <c>null</c>, it's assumed that this hotkey
+    /// can't be unregistered, and the "Overwrite" option will not appear in the hotkey dialog.
+    /// </param>
+    public RegisteredHotkeyData(string hotkey, string descriptionResourceKey, Action? removeHotkey = null)
+    {
+        Hotkey = new HotkeyModel(hotkey);
+        DescriptionResourceKey = descriptionResourceKey;
+        RemoveHotkey = removeHotkey;
+    }
+
+    /// <summary>
+    /// Creates an instance of <c>RegisteredHotkeyData</c>. Assumes that the key specified in
+    /// <c>descriptionResourceKey</c> needs exactly one argument for <c>string.Format</c>.
+    /// </summary>
+    /// <param name="hotkey">
+    /// The hotkey this class will represent.
+    /// Example values: <c>F1</c>, <c>Ctrl+Shift+Enter</c>
+    /// </param>
+    /// <param name="descriptionResourceKey">
+    /// The key in the localization dictionary that represents this hotkey. For example, <c>ReloadPluginHotkey</c>,
+    /// which represents the string "Reload Plugins Data" in <c>en.xaml</c>
+    /// </param>
+    /// <param name="descriptionFormatVariable">
+    /// The value that will replace <c>{0}</c> in the localized string found via <c>description</c>.
+    /// </param>
+    /// <param name="removeHotkey">
+    /// An action that, when called, will unregister this hotkey. If it's <c>null</c>, it's assumed that this hotkey
+    /// can't be unregistered, and the "Overwrite" option will not appear in the hotkey dialog.
+    /// </param>
+    public RegisteredHotkeyData(
+        string hotkey, string descriptionResourceKey, object? descriptionFormatVariable, Action? removeHotkey = null
+    )
+    {
+        Hotkey = new HotkeyModel(hotkey);
+        DescriptionResourceKey = descriptionResourceKey;
+        DescriptionFormatVariables = new[] { descriptionFormatVariable };
+        RemoveHotkey = removeHotkey;
+    }
+
+    /// <summary>
+    /// Creates an instance of <c>RegisteredHotkeyData</c>. Assumes that the key specified in
+    /// <paramref name="descriptionResourceKey"/> needs multiple arguments for <c>string.Format</c>.
+    /// </summary>
+    /// <param name="hotkey">
+    /// The hotkey this class will represent.
+    /// Example values: <c>F1</c>, <c>Ctrl+Shift+Enter</c>
+    /// </param>
+    /// <param name="descriptionResourceKey">
+    /// The key in the localization dictionary that represents this hotkey. For example, <c>ReloadPluginHotkey</c>,
+    /// which represents the string "Reload Plugins Data" in <c>en.xaml</c>
+    /// </param>
+    /// <param name="descriptionFormatVariables">
+    /// Array of values that will replace <c>{0}</c>, <c>{1}</c>, <c>{2}</c>, etc.
+    /// in the localized string found via <c>description</c>.
+    /// </param>
+    /// <param name="removeHotkey">
+    /// An action that, when called, will unregister this hotkey. If it's <c>null</c>, it's assumed that this hotkey
+    /// can't be unregistered, and the "Overwrite" option will not appear in the hotkey dialog.
+    /// </param>
+    public RegisteredHotkeyData(
+        string hotkey, string descriptionResourceKey, object?[] descriptionFormatVariables, Action? removeHotkey = null
+    )
+    {
+        Hotkey = new HotkeyModel(hotkey);
+        DescriptionResourceKey = descriptionResourceKey;
+        DescriptionFormatVariables = descriptionFormatVariables;
+        RemoveHotkey = removeHotkey;
+    }
+}

Flow.Launcher.Infrastructure/UserSettings/Settings.cs

@@ -4,13 +4,14 @@
 using System.Drawing;
 using System.Text.Json.Serialization;
 using System.Windows;
+using Flow.Launcher.Infrastructure.Hotkey;
 using Flow.Launcher.Plugin;
 using Flow.Launcher.Plugin.SharedModels;
 using Flow.Launcher.ViewModel;
 
 namespace Flow.Launcher.Infrastructure.UserSettings
 {
-    public class Settings : BaseModel
+    public class Settings : BaseModel, IHotkeySettings
     {
         private string language = "en";
         private string _theme = Constant.DefaultTheme;
@@ -207,17 +208,17 @@ public string QuerySearchPrecisionString
 
         public double WindowLeft { get; set; }
         public double WindowTop { get; set; }
-        
+
         /// <summary>
         /// Custom left position on selected monitor
         /// </summary>
         public double CustomWindowLeft { get; set; } = 0;
-        
+
         /// <summary>
         /// Custom top position on selected monitor
         /// </summary>
         public double CustomWindowTop { get; set; } = 0;
-        
+
         public int MaxResultsToShow { get; set; } = 5;
         public int ActivateTimes { get; set; }
 
@@ -229,7 +230,7 @@ public string QuerySearchPrecisionString
         [JsonIgnore]
         public ObservableCollection<BuiltinShortcutModel> BuiltinShortcuts { get; set; } = new()
         {
-            new BuiltinShortcutModel("{clipboard}", "shortcut_clipboard_description", Clipboard.GetText), 
+            new BuiltinShortcutModel("{clipboard}", "shortcut_clipboard_description", Clipboard.GetText),
             new BuiltinShortcutModel("{active_explorer_path}", "shortcut_active_explorer_path", FileExplorerHelper.GetActiveExplorerPath)
         };
 
@@ -253,7 +254,7 @@ public bool HideNotifyIcon
 
         [JsonConverter(typeof(JsonStringEnumConverter))]
         public SearchWindowScreens SearchWindowScreen { get; set; } = SearchWindowScreens.Cursor;
-        
+
         [JsonConverter(typeof(JsonStringEnumConverter))]
         public SearchWindowAligns SearchWindowAlign { get; set; } = SearchWindowAligns.Center;
 
@@ -273,6 +274,82 @@ public bool HideNotifyIcon
 
         // This needs to be loaded last by staying at the bottom
         public PluginsSettings PluginSettings { get; set; } = new PluginsSettings();
+
+        [JsonIgnore]
+        public List<RegisteredHotkeyData> RegisteredHotkeys
+        {
+            get
+            {
+                var list = new List<RegisteredHotkeyData>
+                {
+                    new("Up", "HotkeyLeftRightDesc"),
+                    new("Down", "HotkeyLeftRightDesc"),
+                    new("Left", "HotkeyUpDownDesc"),
+                    new("Right", "HotkeyUpDownDesc"),
+                    new("Escape", "HotkeyESCDesc"),
+                    new("F5", "ReloadPluginHotkey"),
+                    new("Alt+Home", "HotkeySelectFirstResult"),
+                    new("Alt+End", "HotkeySelectLastResult"),
+                    new("Ctrl+R", "HotkeyRequery"),
+                    new("Ctrl+H", "ToggleHistoryHotkey"),
+                    new("Ctrl+OemCloseBrackets", "QuickWidthHotkey"),
+                    new("Ctrl+OemOpenBrackets", "QuickWidthHotkey"),
+                    new("Ctrl+OemPlus", "QuickHeightHotkey"),
+                    new("Ctrl+OemMinus", "QuickHeightHotkey"),
+                    new("Ctrl+Shift+Enter", "HotkeyCtrlShiftEnterDesc"),
+                    new("Shift+Enter", "OpenContextMenuHotkey"),
+                    new("Enter", "HotkeyRunDesc"),
+                    new("Ctrl+Enter", "OpenContainFolderHotkey"),
+                    new("Alt+Enter", "HotkeyOpenResult"),
+                    new("Ctrl+F12", "ToggleGameModeHotkey"),
+                    new("Ctrl+Shift+C", "CopyFilePathHotkey"),
+
+                    new($"{OpenResultModifiers}+D1", "HotkeyOpenResultN", 1),
+                    new($"{OpenResultModifiers}+D2", "HotkeyOpenResultN", 2),
+                    new($"{OpenResultModifiers}+D3", "HotkeyOpenResultN", 3),
+                    new($"{OpenResultModifiers}+D4", "HotkeyOpenResultN", 4),
+                    new($"{OpenResultModifiers}+D5", "HotkeyOpenResultN", 5),
+                    new($"{OpenResultModifiers}+D6", "HotkeyOpenResultN", 6),
+                    new($"{OpenResultModifiers}+D7", "HotkeyOpenResultN", 7),
+                    new($"{OpenResultModifiers}+D8", "HotkeyOpenResultN", 8),
+                    new($"{OpenResultModifiers}+D9", "HotkeyOpenResultN", 9),
+                    new($"{OpenResultModifiers}+D0", "HotkeyOpenResultN", 10)
+                };
+
+                if(!string.IsNullOrEmpty(Hotkey))
+                    list.Add(new(Hotkey, "flowlauncherHotkey", () => Hotkey = ""));
+                if(!string.IsNullOrEmpty(PreviewHotkey))
+                    list.Add(new(PreviewHotkey, "previewHotkey", () => PreviewHotkey = ""));
+                if(!string.IsNullOrEmpty(AutoCompleteHotkey))
+                    list.Add(new(AutoCompleteHotkey, "autoCompleteHotkey", () => AutoCompleteHotkey = ""));
+                if(!string.IsNullOrEmpty(AutoCompleteHotkey2))
+                    list.Add(new(AutoCompleteHotkey2, "autoCompleteHotkey", () => AutoCompleteHotkey2 = ""));
+                if(!string.IsNullOrEmpty(SelectNextItemHotkey))
+                    list.Add(new(SelectNextItemHotkey, "SelectNextItemHotkey", () => SelectNextItemHotkey = ""));
+                if(!string.IsNullOrEmpty(SelectNextItemHotkey2))
+                    list.Add(new(SelectNextItemHotkey2, "SelectNextItemHotkey", () => SelectNextItemHotkey2 = ""));
+                if(!string.IsNullOrEmpty(SelectPrevItemHotkey))
+                    list.Add(new(SelectPrevItemHotkey, "SelectPrevItemHotkey", () => SelectPrevItemHotkey = ""));
+                if(!string.IsNullOrEmpty(SelectPrevItemHotkey2))
+                    list.Add(new(SelectPrevItemHotkey2, "SelectPrevItemHotkey", () => SelectPrevItemHotkey2 = ""));
+                if(!string.IsNullOrEmpty(SettingWindowHotkey))
+                    list.Add(new(SettingWindowHotkey, "SettingWindowHotkey", () => SettingWindowHotkey = ""));
+                if(!string.IsNullOrEmpty(OpenContextMenuHotkey))
+                    list.Add(new(OpenContextMenuHotkey, "OpenContextMenuHotkey", () => OpenContextMenuHotkey = ""));
+                if(!string.IsNullOrEmpty(SelectNextPageHotkey))
+                    list.Add(new(SelectNextPageHotkey, "SelectNextPageHotkey", () => SelectNextPageHotkey = ""));
+                if(!string.IsNullOrEmpty(SelectPrevPageHotkey))
+                    list.Add(new(SelectPrevPageHotkey, "SelectPrevPageHotkey", () => SelectPrevPageHotkey = ""));
+
+                foreach (var customPluginHotkey in CustomPluginHotkeys)
+                {
+                    if (!string.IsNullOrEmpty(customPluginHotkey.Hotkey))
+                        list.Add(new(customPluginHotkey.Hotkey, "customQueryHotkey", () => customPluginHotkey.Hotkey = ""));
+                }
+
+                return list;
+            }
+        }
     }
 
     public enum LastQueryMode
@@ -288,7 +365,7 @@ public enum ColorSchemes
         Light,
         Dark
     }
-    
+
     public enum SearchWindowScreens
     {
         RememberLastLaunchLocation,
@@ -297,7 +374,7 @@ public enum SearchWindowScreens
         Primary,
         Custom
     }
-    
+
     public enum SearchWindowAligns
     {
         Center,

Flow.Launcher/CustomQueryHotkeySetting.xaml

@@ -106,6 +106,7 @@
                         HorizontalAlignment="Left"
                         VerticalAlignment="Center"
                         HorizontalContentAlignment="Left"
+                        HotkeySettings="{Binding Settings}"
                         DefaultHotkey="" />
                     <TextBlock
                         Grid.Row="1"

Flow.Launcher/CustomQueryHotkeySetting.xaml.cs

@@ -15,13 +15,13 @@ public partial class CustomQueryHotkeySetting : Window
         private SettingWindow _settingWidow;
         private bool update;
         private CustomPluginHotkey updateCustomHotkey;
-        private Settings _settings;
+        public Settings Settings { get; }
 
         public CustomQueryHotkeySetting(SettingWindow settingWidow, Settings settings)
         {
             _settingWidow = settingWidow;
+            Settings = settings;
             InitializeComponent();
-            _settings = settings;
         }
 
         private void BtnCancel_OnClick(object sender, RoutedEventArgs e)
@@ -33,13 +33,13 @@ private void btnAdd_OnClick(object sender, RoutedEventArgs e)
         {
             if (!update)
             {
-                _settings.CustomPluginHotkeys ??= new ObservableCollection<CustomPluginHotkey>();
+                Settings.CustomPluginHotkeys ??= new ObservableCollection<CustomPluginHotkey>();
 
                 var pluginHotkey = new CustomPluginHotkey
                 {
                     Hotkey = HotkeyControl.CurrentHotkey.ToString(), ActionKeyword = tbAction.Text
                 };
-                _settings.CustomPluginHotkeys.Add(pluginHotkey);
+                Settings.CustomPluginHotkeys.Add(pluginHotkey);
 
                 HotKeyMapper.SetCustomQueryHotkey(pluginHotkey);
             }
@@ -59,7 +59,7 @@ private void btnAdd_OnClick(object sender, RoutedEventArgs e)
 
         public void UpdateItem(CustomPluginHotkey item)
         {
-            updateCustomHotkey = _settings.CustomPluginHotkeys.FirstOrDefault(o =>
+            updateCustomHotkey = Settings.CustomPluginHotkeys.FirstOrDefault(o =>
                 o.ActionKeyword == item.ActionKeyword && o.Hotkey == item.Hotkey);
             if (updateCustomHotkey == null)
             {

Flow.Launcher/HotkeyControl.xaml.cs

@@ -12,6 +12,17 @@ namespace Flow.Launcher
 {
     public partial class HotkeyControl
     {
+        public IHotkeySettings HotkeySettings {
+            get { return (IHotkeySettings)GetValue(HotkeySettingsProperty); }
+            set { SetValue(HotkeySettingsProperty, value); }
+        }
+
+        public static readonly DependencyProperty HotkeySettingsProperty = DependencyProperty.Register(
+            nameof(HotkeySettings),
+            typeof(IHotkeySettings),
+            typeof(HotkeyControl),
+            new PropertyMetadata()
+        );
         public string WindowTitle {
             get { return (string)GetValue(WindowTitleProperty); }
             set { SetValue(WindowTitleProperty, value); }
@@ -122,7 +133,7 @@ private async Task OpenHotkeyDialog()
                 HotKeyMapper.RemoveHotkey(Hotkey);
             }
 
-            var dialog = new HotkeyControlDialog(Hotkey, DefaultHotkey, WindowTitle);
+            var dialog = new HotkeyControlDialog(Hotkey, DefaultHotkey, HotkeySettings, WindowTitle);
             await dialog.ShowAsync();
             switch (dialog.ResultType)
             {