Merge pull request #1 from joekolodz/buttonmap

new method to allow device list to be passed in when overlaying maps; include ShiftModePage in json converter

src/Controls/MacroTransport.xaml

@@ -12,7 +12,7 @@
 
             <TextBox Text="{Binding ButtonName}" HorizontalAlignment="Stretch" VerticalContentAlignment="Center" Foreground="{StaticResource TextBrush}" CaretBrush="{StaticResource TextBrush}" Margin="0,0,2,0" Width="200" Height="30" FontSize="14" Background="{StaticResource WindowBackgroundBrush}" BorderBrush="{StaticResource NormalBorderBrush}"/>
 
-            <Button Style="{StaticResource MacroButton}" Command="{Binding RecordMacroStartCommand, IsAsync=True}" Margin="0,0,1,0" ToolTip="Record a new keystroke activity" ToolTipService.InitialShowDelay="800" ToolTipService.ShowOnDisabled="True">
+            <Button Style="{StaticResource MacroButton}" Command="{Binding RecordMacroStartCommand, IsAsync=True}" Margin="0,0,1,0" ToolTip="Record a new keystroke or key-chord activity" ToolTipService.InitialShowDelay="800" ToolTipService.ShowOnDisabled="True">
                 <Image>
                     <Image.Style>
                         <Style TargetType="Image" BasedOn="{StaticResource MacroButtonImage}">

src/CustomJsonConverter.cs

@@ -126,6 +126,7 @@ public override void WriteJson(JsonWriter writer, object value, JsonSerializer s
                 if (button.Type == HOTASButton.ButtonType.Button && string.CompareOrdinal(button.MapName, JoystickOffsetValues.GetName(button.MapId)) != 0 ||
                     button.Type == HOTASButton.ButtonType.POV && string.CompareOrdinal(button.MapName, JoystickOffsetValues.GetPOVName(button.MapId)) != 0 ||
                     button.ActionCatalogItem?.Actions?.Count > 0 ||
+                    button.ShiftModePage >0 ||
                     button.IsShift)
                 {
                     SerializeButton(writer, serializer, button);

src/Models/HOTASDevice.cs

@@ -268,7 +268,27 @@ public void OverlayAllProfilesToDevice()
             }
 
             ModeProfiles = mergedModeProfiles;
-            _hotasQueue.SetModeProfiles(ModeProfiles);
+            _hotasQueue?.SetModeProfiles(ModeProfiles);
+        }
+
+        /// <summary>
+        /// Existing buttons in the profile will overlay buttons on the device. If a device has a button with matching profile, then we'll keep that button (otherwise we'd lose it if we just took profile buttons)
+        /// This allows a device to change without losing mappings (for instance when chaining a new Virpil device, or manually editing and removing buttons from the profile's JSON file)
+        /// </summary>
+        public void OverlayAllProfilesToDevice(Dictionary<int, ObservableCollection<IHotasBaseMap>> profilesToMergeIn)
+        {
+            var mergedModeProfiles = new Dictionary<int, ObservableCollection<IHotasBaseMap>>();
+            var deviceButtons = new ObservableCollection<IHotasBaseMap>();
+            SeedButtonMapProfileFromDeviceCapabilities(deviceButtons);
+
+            foreach (var p in profilesToMergeIn)
+            {
+                var d = deviceButtons.ToObservableCollection();//make a copy since we could have more than 1 profile and we don't need to rescan caps
+                mergedModeProfiles.Add(p.Key, MergeMaps(d, p.Value));
+            }
+
+            ModeProfiles = mergedModeProfiles;
+            _hotasQueue?.SetModeProfiles(ModeProfiles);
         }
 
         /// <summary>

src/Models/IHOTASDevice.cs

@@ -32,6 +32,7 @@ public interface IHOTASDevice
         void CopyModeProfileFromTemplate(int templateModeSource, int destinationMode);
         void ListenAsync();
         void OverlayAllProfilesToDevice();
+        void OverlayAllProfilesToDevice(Dictionary<int, ObservableCollection<IHotasBaseMap>> profilesToMergeIn);
         void ApplyButtonMap(ObservableCollection<IHotasBaseMap> existingButtonMap);
         void SetMode(int mode);
         void ForceButtonPress(JoystickOffset offset, bool isDown);

src/ViewModels/ActionCatalogViewModel.cs

@@ -53,6 +53,12 @@ public void Add(ButtonMapViewModel buttonMap)
             Logging.Log.Debug($"{item.ActionName} - {buttonMap.ButtonName} added to actions catalog");
         }
 
+        public ActionCatalogItem Get(string actionName)
+        {
+            if (!Contains(actionName)) return null;
+            return Catalog.First(x => x.ActionName == actionName);
+        }
+
         private void AddEmptyItem()
         {
             Add(new ActionCatalogItem() { NoAction = true, ActionName = NO_ACTION_TEXT, Actions = new ObservableCollection<ButtonAction>() });

src/ViewModels/HOTASCollectionViewModel.cs

@@ -346,7 +346,7 @@ private void AddActivity(IHotasBaseMap map, KeystrokeSentEventArgs e)
                 Activity.Insert(0, activity);
                 if (Activity.Count >= 200)
                 {
-                    Activity.RemoveAt(Activity.Count-1);
+                    Activity.RemoveAt(Activity.Count - 1);
                 }
             });
         }
@@ -405,7 +405,6 @@ private void BuildDevicesViewModelFromLoadedDevices(IHOTASCollection loadedDevic
                 {
                     Logging.Log.Warn($"Loaded mappings for {ld.Name}, but could not find the device attached!");
                     Logging.Log.Warn($"Mappings will be displayed, but they will not function");
-                    //deviceVm = new DeviceViewModel(_appDispatcher, _fileSystem, _mediaPlayerFactory, ld);
                     deviceVm = _deviceViewModelFactory.CreateDeviceViewModel(_appDispatcher, _fileSystem, _mediaPlayerFactory, ld);
                     Devices.Add(deviceVm);
                     _deviceList.AddDevice(ld);
@@ -415,8 +414,9 @@ private void BuildDevicesViewModelFromLoadedDevices(IHOTASCollection loadedDevic
                 {
                     d = _deviceList.GetDevice(ld.DeviceId);
                     if (d == null) continue;
+                    d.OverlayAllProfilesToDevice(ld.ModeProfiles);
+                    d.ApplyButtonMap(d.ModeProfiles[d.ModeProfiles.Keys.Min()].ToObservableCollection());
                 }
-                d.SetModeProfile(ld.ModeProfiles);
                 deviceVm.RebuildMap(d.ButtonMap);
             }
         }
@@ -524,8 +524,6 @@ private void LoadHotas(IHOTASCollection loadedDeviceList)
             AddHandlers();
             ProfileSetFileName = _fileSystem.LastSavedFileName;
 
-            //since the JSON file may have less button maps than are on the device, we need to overlay them individually instead of replacing the whole collection
-            _deviceList.ApplyButtonMapToAllProfiles();
             _deviceList.AutoSetMode();
             _deviceList.ListenToAllDevices();
 
@@ -579,6 +577,11 @@ private void ReBuildActionCatalog()
                                 }
                             case HOTASButton buttonMap:
                                 {
+                                    if (ActionCatalog.Contains(buttonMap.ActionName))
+                                    {
+                                        buttonMap.ActionCatalogItem = ActionCatalog.Get(buttonMap.ActionName);
+                                        break;
+                                    }
                                     AddButtonToCatalog(buttonMap.ActionName, buttonMap.ActionCatalogItem.Actions, buttonMap.MapName);
                                     break;
                                 }
@@ -592,6 +595,12 @@ private void AddButtonListToCatalog(ObservableCollection<HOTASButton> mapList)
         {
             foreach (var baseMap in mapList)
             {
+                if (ActionCatalog.Contains(baseMap.ActionName))
+                {
+                    //baseMap.ActionCatalogItem.Actions = ActionCatalog.Get(baseMap.ActionName).Actions;
+                    baseMap.ActionCatalogItem = ActionCatalog.Get(baseMap.ActionName);
+                    break;
+                }
                 AddButtonToCatalog(baseMap.ActionName, baseMap.ActionCatalogItem.Actions, baseMap.MapName);
             }
         }

tests/HOTASCollectionViewModelTests.cs

@@ -583,7 +583,7 @@ public void file_open_command_valid_file_existing_device()
             existingDevice.DeviceId = existingDeviceId;
             existingDevice.Name = "existing device";
             existingDevice.Capabilities = new Capabilities() { AxeCount = 2, ButtonCount = 1 };
-            
+
 
             AddHotasButtonMap(existingDevice.ButtonMap, existingButtonMapId);
 
@@ -937,7 +937,7 @@ public void add_activity_keystroke_down()
         {
             var hotasVm = CreateHotasCollectionViewModel(out _, out var subDeviceList, out _, out _, out _, out _);
             hotasVm.Initialize();
-            
+
             IHOTASQueue queue = new HOTASQueue(Substitute.For<IKeyboard>());
             IHotasBaseMap map = new HOTASButton() { Type = HOTASButton.ButtonType.Button, ActionName = "test action" };
             queue.SetButtonMap(new ObservableCollection<IHotasBaseMap>() { map });
@@ -1131,16 +1131,25 @@ public void load_profile()
 
             var hotasVm = CreateHotasCollectionViewModel(out var subFileSystem, out var subQuickProfilePanelVm);
 
-            var subHotasCollection = CreateHotasCollectionSubstitute();
-            subHotasCollection.Devices.Add(new HOTASDevice()
+            var device = new HOTASDevice()
             {
-                DeviceId = deviceId,
-                ButtonMap =
+                DeviceId = deviceId
+            };
+
+
+            var profile = new Dictionary<int, ObservableCollection<IHotasBaseMap>>();
+            var map = new ObservableCollection<IHotasBaseMap>()
             {
-                new HOTASButton(){MapId = 43, Type = HOTASButton.ButtonType.Button, ActionCatalogItem = new ActionCatalogItem(){ActionName = "test action 1"}},
-                new HOTASButton(){MapId = 44, Type = HOTASButton.ButtonType.Button, ActionCatalogItem = new ActionCatalogItem(){ActionName = "test action 2"}},
-            }
-            });
+                new HOTASButton() { MapId = 43, Type = HOTASButton.ButtonType.Button, ActionCatalogItem = new ActionCatalogItem() { ActionName = "test action 1" } },
+                new HOTASButton() { MapId = 44, Type = HOTASButton.ButtonType.Button, ActionCatalogItem = new ActionCatalogItem() { ActionName = "test action 2" } }
+
+            };
+            profile.Add(1, map);
+
+            device.SetModeProfile(profile);
+
+            var subHotasCollection = CreateHotasCollectionSubstitute();
+            subHotasCollection.Devices.Add(device);
 
             subFileSystem.FileOpen(Arg.Any<string>()).ReturnsForAnyArgs(subHotasCollection);
             subFileSystem.LastSavedFileName.Returns("last saved file");
@@ -1180,11 +1189,22 @@ public void load_profile_add_button_list_to_catalog()
                     new HOTASAxis() {MapName = "test2", MapId = 44, Type = HOTASButton.ButtonType.AxisLinear, ButtonMap = new ObservableCollection<HOTASButton>(){new HOTASButton(){MapName = "bm2", ActionName = "abm2", ActionCatalogItem = new ActionCatalogItem(){ActionName = "action2", Actions = new ObservableCollection<ButtonAction>(){new ButtonAction(){ScanCode = 2}}}}}},
                 }
             };
-            subDevice.ModeProfiles.Add(43, new ObservableCollection<IHotasBaseMap>());
-            subHotasCollection.Devices.Add(subDevice);
 
 
 
+
+            var profile = new Dictionary<int, ObservableCollection<IHotasBaseMap>>();
+            var map = new ObservableCollection<IHotasBaseMap>()
+            {
+                new HOTASAxis() {MapName = "test1", MapId = 43, Type = HOTASButton.ButtonType.AxisLinear, ButtonMap = new ObservableCollection<HOTASButton>(){new HOTASButton(){MapName = "bm1", ActionName = "abm1", ActionCatalogItem = new ActionCatalogItem(){ActionName = "action1", Actions = new ObservableCollection<ButtonAction>(){new ButtonAction(){ScanCode = 1}}}}}},
+                new HOTASAxis() {MapName = "test2", MapId = 44, Type = HOTASButton.ButtonType.AxisLinear, ButtonMap = new ObservableCollection<HOTASButton>(){new HOTASButton(){MapName = "bm2", ActionName = "abm2", ActionCatalogItem = new ActionCatalogItem(){ActionName = "action2", Actions = new ObservableCollection<ButtonAction>(){new ButtonAction(){ScanCode = 2}}}}}},
+            };
+            profile.Add(1, map);
+
+            subDevice.SetModeProfile(profile);
+
+            subHotasCollection.Devices.Add(subDevice);
+
             subHotasCollection.ModeProfileActivationButtons.Add(1, new ModeActivationItem() { ButtonId = 43, DeviceId = deviceId });
             subHotasCollection.SetupNewModeProfile();