Encapsulate the config's Hotkeys dict

Exposing a mutable collection as a property never ends well.

Instead, keep the collection private and write methods for Add, Remove and Enumerate.

Fixes cases where hotkey changes were not getting written to disk.

Author: richardbuckle

ConfigService/Configurations/EDDIConfiguration.cs

@@ -1,5 +1,6 @@
 using Newtonsoft.Json;
 using System.Collections.Generic;
+using System.Collections.Immutable;
 using System.Windows;
 
 namespace EddiConfigService.Configurations
@@ -45,8 +46,11 @@ public class EDDIConfiguration : Config
 
         // Hotkeys
 
-        [ JsonProperty( "Hotkeys" ) ]
-        public Dictionary<string, string> Hotkeys { get; set; } = new Dictionary<string, string>();
+        [JsonProperty( "Hotkeys" )]
+        private ImmutableDictionary<string, string> Hotkeys = ImmutableDictionary<string, string>.Empty;
+        public ImmutableDictionary<string, string> GetHotkeysCopy () => Hotkeys;
+        public void AddHotkey ( string name, string gesture ) => Hotkeys = Hotkeys.Add( name, gesture );
+        public void RemoveHotkey ( string name ) => Hotkeys = Hotkeys.Remove( name );
 
         // Default
         public EDDIConfiguration()

EddiCore/Hotkeys/HotkeyManager.cs

@@ -1,5 +1,4 @@
-using EddiConfigService;
-using EddiSpeechService;
+using EddiSpeechService;
 using System;
 using System.Collections.Generic;
 using System.Runtime.CompilerServices;
@@ -32,8 +31,6 @@ public class HotkeyManager
 
         public void SetHandle ( IntPtr newHandle )
         {
-            ConfigService.Instance.eddiConfiguration.Hotkeys = ConfigService.Instance.eddiConfiguration.Hotkeys ??
-                                                               new Dictionary<string, string>();
             Hotkeys?.UnregisterAll();
             Hotkeys = new HotkeyRegistration( newHandle, new HotkeyActionCollection( HotkeyActions ) );
             Hotkeys.RegisterAll();

EddiCore/Hotkeys/HotkeyRegistration.cs

@@ -24,7 +24,7 @@ public HotkeyRegistration ( IntPtr handle, HotkeyActionCollection collection )
 
         internal void RegisterAll ()
         {
-            foreach ( var configuredHotkey in ConfigService.Instance.eddiConfiguration.Hotkeys )
+            foreach ( var configuredHotkey in ConfigService.Instance.eddiConfiguration.GetHotkeysCopy() )
             {
                 if ( Collection.TryGetValue( configuredHotkey.Key, out var hotkeyAction ) )
                 {
@@ -40,8 +40,7 @@ public void RegisterHotkey ( string name, KeyGesture keyGesture )
                 if ( TryRegisterHotkey( name, keyGesture, out var id ) )
                 {
                     Collection.AddGesture( name, keyGesture, id );
-                    ConfigService.Instance.eddiConfiguration.Hotkeys.Add( name,
-                        HotkeyConverter.ToString( keyGesture ) );
+                    ConfigService.Instance.eddiConfiguration.AddHotkey( name, HotkeyConverter.ToString( keyGesture ) );
                 }
                 else
                 {
@@ -95,7 +94,7 @@ public void UnregisterHotkey ( string name )
             if ( TryUnregisterHotkey( name ) )
             {
                 Collection.RemoveKeyGestures( name );
-                ConfigService.Instance.eddiConfiguration.Hotkeys.Remove( name );
+                ConfigService.Instance.eddiConfiguration.RemoveHotkey( name );
             }
         }