Revised the Hotkey Manager to send key presses to other applications. Resolves #2779.

Author: Tkael

ChangeLog.md

@@ -2,6 +2,11 @@
 
 Full details of the variables available for each noted event, and VoiceAttack integrations, are available in the individual [event pages](https://github.com/EDCD/EDDI/wiki/Events).
 
+## 4.1.9
+  * Core
+    * Various bug fixes
+    * Revised the Hotkey Manager to send key presses to other applications rather than blocking those key presses from being sent to other applications. This should improve compatibility other applications using the same keys. (#2779)
+
 ## 4.1.8
   * Core
     * Fixed a bad installer configuration which prevented the 4.1.7 release from running for some users. (#2776) 

EddiCore/Hotkeys/HotkeyAction.cs

@@ -5,7 +5,6 @@ namespace EddiCore.Hotkeys
 {
     public class HotkeyAction
     {
-        public int? id { get; set; }
         public string Name { get; set; }
         public string DisplayName { get; set; }
         public Action Action { get; set; }

EddiCore/Hotkeys/HotkeyActionCollection.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.Linq;
 using System.Windows.Input;
 
@@ -8,82 +9,72 @@ public class HotkeyActionCollection
     {
         public HotkeyActionCollection ( List<HotkeyAction> hotkeyActions )
         {
-            HotkeyActions = hotkeyActions;
+            HotkeyActions = hotkeyActions ?? throw new ArgumentNullException( nameof( hotkeyActions ) );
+            byName = HotkeyActions.ToDictionary( a => a.Name, a => a );
+            RebuildGestureIndex();
         }
 
         public readonly List<HotkeyAction> HotkeyActions;
 
-        public void AddGesture ( string name, KeyGesture gesture, int? id = null )
+        private readonly Dictionary<string, HotkeyAction> byName;
+        private readonly Dictionary<(Key key, ModifierKeys mods), HotkeyAction> byGesture = new Dictionary<(Key, ModifierKeys), HotkeyAction>();
+
+        private void RebuildGestureIndex ()
         {
-            var action = HotkeyActions.FirstOrDefault( a => a.Name == name );
-            if ( action != null )
+            byGesture.Clear();
+            foreach ( var a in HotkeyActions )
             {
-                action.KeyGesture = gesture;
-                action.id = id;
-                return;
+                if ( a.KeyGesture != null )
+                {
+                    byGesture[ (a.KeyGesture.Key, a.KeyGesture.Modifiers) ] = a;
+                }
             }
-
-            throw new KeyNotFoundException( $"The key name '{name}' was not found in the action list." );
         }
 
-        public void AddId ( string name, int id )
+        public void AddGesture ( string name, KeyGesture gesture )
         {
-            var action = HotkeyActions.FirstOrDefault( a => a.Name == name );
-            if ( action != null )
+            if ( !byName.TryGetValue( name, out var action ) )
             {
-                action.id = id;
-                return;
+                throw new KeyNotFoundException( $"The key name '{name}' was not found in the action list." );
             }
 
-            throw new KeyNotFoundException( $"The key name '{name}' was not found in the action list." );
+            action.KeyGesture = gesture;
+            RebuildGestureIndex();
         }
 
         public void ClearAllKeyGestures ()
         {
             foreach ( var action in HotkeyActions )
             {
-                RemoveKeyGestures( action.Name );
+                action.KeyGesture = null;
             }
+            RebuildGestureIndex();
         }
 
         public bool IsKeyGestureAssigned ( string name, Key key, ModifierKeys modifiers )
         {
-            var action = HotkeyActions.FirstOrDefault( a => a.Name == name );
-            if ( action != null )
+            if ( !byName.ContainsKey( name ) )
             {
-                return HotkeyActions.Any( a =>
-                    a.Name != name &&
-                    a.KeyGesture != null &&
-                    a.KeyGesture.Key == key &&
-                    a.KeyGesture.Modifiers == modifiers );
+                throw new KeyNotFoundException( $"The key name '{name}' was not found in the action list." );
             }
 
-            throw new KeyNotFoundException( $"The key name '{name}' was not found in the action list." );
+            return byGesture.TryGetValue( (key, modifiers), out var existing ) && existing.Name != name;
         }
 
         public void RemoveKeyGestures ( string name )
         {
-            var action = HotkeyActions.FirstOrDefault( a => a.Name == name );
-            if ( action != null )
+            if ( !byName.TryGetValue( name, out var action ) )
             {
-                action.id = null;
-                action.KeyGesture = null;     
-                return;
+                throw new KeyNotFoundException( $"The key name '{name}' was not found in the action list." );
             }
 
-            throw new KeyNotFoundException( $"The key name '{name}' was not found in the action list." );
+            action.KeyGesture = null;
+            RebuildGestureIndex();
         }
 
-        public bool TryGetValue ( string name, out HotkeyAction action )
-        {
-            action = HotkeyActions.FirstOrDefault( a => a.Name == name );
-            return action != null;
-        }
+        public bool TryGetValue ( string name, out HotkeyAction action ) => byName.TryGetValue( name, out action );
 
-        public bool TryGetValue ( int id, out HotkeyAction action )
-        {
-            action = HotkeyActions.FirstOrDefault( a => a.id != null && a.id == id );
-            return action != null;
-        }
+        public bool TryGetValue ( Key key, ModifierKeys modifiers, out HotkeyAction action ) =>
+            byGesture.TryGetValue( ( key, modifiers ), out action );
     }
 }

EddiCore/Hotkeys/HotkeyManager.cs

@@ -1,8 +1,8 @@
 using EddiSpeechService;
-using System;
 using System.Collections.Generic;
 using System.Runtime.CompilerServices;
 using System.Windows.Input;
+using Utilities;
 
 [assembly: InternalsVisibleTo( "Tests" )]
 namespace EddiCore.Hotkeys
@@ -14,41 +14,28 @@ public class HotkeyManager
             new HotkeyAction( "EnableEventResponses", Properties.Resources.hotkey_definition_enable_speech, () =>
             {
                 EDDI.Instance.State[ "speechresponder_quiet" ] = false;
+                Logging.Info("Hotkey action triggered: Enable Speech");
             } ),
             new HotkeyAction( "DisableEventResponses", Properties.Resources.hotkey_definition_disable_speech, () =>
             {
                 EDDI.Instance.State[ "speechresponder_quiet" ] = true;
                 SpeechService.Instance.ShutUp();
+                Logging.Info("Hotkey action triggered: Disable Speech");
             } ),
             new HotkeyAction( "Shutup", Properties.Resources.hotkey_definition_stop_speech, () =>
             {
                 SpeechService.Instance.ShutUp();
+                Logging.Info("Hotkey action triggered: Stop the Current Speech");
             } )
         };
 
         public HotkeyRegistration Hotkeys;
-        private const int WM_HOTKEY = 0x0312;
 
-        public void SetHandle ( IntPtr newHandle )
+        public void InitializeHotkeys ()
         {
-            Hotkeys?.UnregisterAll();
-            Hotkeys = new HotkeyRegistration( newHandle, new HotkeyActionCollection( HotkeyActions ) );
-            Hotkeys.RegisterAll();
-        }
-
-        public IntPtr HandleHotkeyMessage ( int msg, IntPtr wParam, ref bool handled )
-        {
-            if ( msg == WM_HOTKEY )
-            {
-                var id = wParam.ToInt32();
-                if ( Hotkeys.Collection?.TryGetValue( id, out var hotkeyAction ) ?? false )
-                {
-                    hotkeyAction.Action.Invoke();
-                    handled = true;
-                }
-            }
-
-            return IntPtr.Zero;
+            Hotkeys?.Dispose(); // unhook any previous instance
+            Hotkeys = new HotkeyRegistration( new HotkeyActionCollection( HotkeyActions ) );
+            Hotkeys?.RegisterAll();
         }
 
         public void RegisterHotkey ( string name, KeyGesture keyGesture ) => Hotkeys.RegisterHotkey( name, keyGesture );