Refactor joystick handling #1811
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -96,54 +96,22 @@ protected virtual void EnumerateDevices() | |
| { | ||
| this.DIJoystick.GetObjectInfoById(device.ObjectId); | ||
|
|
||
| bool IsAxis = (device.ObjectId.Flags & DeviceObjectTypeFlags.AbsoluteAxis) > 0; | ||
| bool IsButton = (device.ObjectId.Flags & DeviceObjectTypeFlags.Button) > 0; | ||
| bool IsPOV = (device.ObjectId.Flags & DeviceObjectTypeFlags.PointOfViewController) > 0; | ||
|
|
||
|
|
||
| if (IsAxis && Axes.Count < DIJoystick.Capabilities.AxeCount) | ||
| { | ||
| RegisterAxis(device); | ||
| } | ||
| else if (IsButton) | ||
| { | ||
| RegisterButton(device); | ||
| } | ||
| else if (IsPOV) | ||
| { | ||
| RegisterPOV(device); | ||
| } | ||
| else | ||
| { | ||
|
|
@@ -152,6 +120,69 @@ protected virtual void EnumerateDevices() | |
| } | ||
| } | ||
|
|
||
| protected virtual void RegisterAxis(DeviceObjectInstance device) | ||
| { | ||
| String axisName; | ||
| string axisLabel = "Unknown"; | ||
| try | ||
| { | ||
| var OffsetAxisName = GetAxisNameForUsage(device.Usage); | ||
| axisName = $"{AxisPrefix} {OffsetAxisName}"; | ||
| axisLabel = MapDeviceNameToLabel($"{AxisPrefix} {OffsetAxisName}"); | ||
|
|
||
| } | ||
| catch (ArgumentOutOfRangeException) | ||
| { | ||
| LogAddInputError(device, axisLabel, "Axis can't be mapped"); | ||
| return; | ||
| } | ||
| Axes.Add(new JoystickDevice() { Name = axisName, Label = axisLabel, Type = DeviceType.AnalogInput, JoystickDeviceType = JoystickDeviceType.Axis }); | ||
| LogInputAdded(device, axisLabel); | ||
| } | ||
|
|
||
| protected virtual void RegisterButton(DeviceObjectInstance device) | ||
| { | ||
| // Use the device.Usage value so this is consistent with how Axes are referenced and avoid ID collisions | ||
| // when looking up names in the the .joystick.json file. | ||
| var buttonName = $"{ButtonPrefix} {device.Usage}"; | ||
| var buttonLabel = MapDeviceNameToLabel(buttonName); | ||
| Buttons.Add(new JoystickDevice() { Name = buttonName, Label = buttonLabel, Type = DeviceType.Button, JoystickDeviceType = JoystickDeviceType.Button }); | ||
| LogInputAdded(device, buttonLabel); | ||
| } | ||
|
|
||
| protected virtual void RegisterPOV(DeviceObjectInstance device) | ||
| { | ||
| String name = device.Name; | ||
|
|
||
| POV.Add(new JoystickDevice() { Name = $"{PovPrefix} {name}U", Label = $"{name} (↑)", Type = DeviceType.Button, JoystickDeviceType = JoystickDeviceType.POV }); | ||
| POV.Add(new JoystickDevice() { Name = $"{PovPrefix} {name}UR", Label = $"{name} (↗)", Type = DeviceType.Button, JoystickDeviceType = JoystickDeviceType.POV }); | ||
| POV.Add(new JoystickDevice() { Name = $"{PovPrefix} {name}R", Label = $"{name} (→)", Type = DeviceType.Button, JoystickDeviceType = JoystickDeviceType.POV }); | ||
| POV.Add(new JoystickDevice() { Name = $"{PovPrefix} {name}DR", Label = $"{name} (↘)", Type = DeviceType.Button, JoystickDeviceType = JoystickDeviceType.POV }); | ||
| POV.Add(new JoystickDevice() { Name = $"{PovPrefix} {name}D", Label = $"{name} (↓)", Type = DeviceType.Button, JoystickDeviceType = JoystickDeviceType.POV }); | ||
| POV.Add(new JoystickDevice() { Name = $"{PovPrefix} {name}DL", Label = $"{name} (↙)", Type = DeviceType.Button, JoystickDeviceType = JoystickDeviceType.POV }); | ||
| POV.Add(new JoystickDevice() { Name = $"{PovPrefix} {name}L", Label = $"{name} (←)", Type = DeviceType.Button, JoystickDeviceType = JoystickDeviceType.POV }); | ||
| POV.Add(new JoystickDevice() { Name = $"{PovPrefix} {name}UL", Label = $"{name} (↖)", Type = DeviceType.Button, JoystickDeviceType = JoystickDeviceType.POV }); | ||
| LogInputAdded(device, name); | ||
| } | ||
|
|
||
| protected void LogInputAdded(DeviceObjectInstance device, string label) | ||
|
There was a problem hiding this comment. Trading debug information (calling function name) for DRYness here. If having the log point to dedicated logging methods is unwanted, I have a different compromise in mind as an alternative option (generate the string in a method and call Log.Instance.log with that). |
||
| { | ||
| int offset = device.Offset; | ||
| int usage = device.Usage; | ||
| ObjectAspect aspect = device.Aspect; | ||
| String name = device.Name; | ||
| Log.Instance.log($"Added {DIJoystick.Information.InstanceName} Aspect: {aspect} Offset: {offset} Usage: {usage} Button: {name} Label: {label}.", LogSeverity.Debug); | ||
| } | ||
|
|
||
| protected void LogAddInputError(DeviceObjectInstance device, string label, string errmsg) | ||
| { | ||
| int offset = device.Offset; | ||
| int usage = device.Usage; | ||
| ObjectAspect aspect = device.Aspect; | ||
| String name = device.Name; | ||
| Log.Instance.log($"{errmsg}: {DIJoystick.Information.InstanceName} Aspect: {aspect} Offset: {offset} Usage: {usage} Axis: {name} Label: {label}.", LogSeverity.Error); | ||
| } | ||
|
|
||
| public string MapDeviceNameToLabel(string deviceName) | ||
| { | ||
| // First try and look for a custom label. | ||
|
|
@@ -160,7 +191,6 @@ public string MapDeviceNameToLabel(string deviceName) | |
| { | ||
| return input.Label; | ||
| } | ||
| string result = string.Empty; | ||
|
|
||
| if (deviceName.StartsWith(ButtonPrefix)) | ||
|
|
@@ -216,32 +246,33 @@ public List<ListItem<IBaseDevice>> GetAvailableDevicesAsListItems() | |
|
|
||
| private List<JoystickDevice> GetButtonsSorted() | ||
| { | ||
| return Buttons.OrderBy(button => GetIndexForJoystickDevice(button)).ToList(); | ||
|
There was a problem hiding this comment. This addresses two nuisances (cf. issue #1808):
The Lambda could also be a function pointer, writing it this way mainly makes it more explicit that it is acting on individual buttons. |
||
| } | ||
|
|
||
| private List<JoystickDevice> GetAxisSorted() | ||
| { | ||
| return Axes.OrderBy(axis => GetIndexForJoystickDevice(axis)).ToList(); | ||
|
There was a problem hiding this comment. Same as the buttons, with the added fun that the sort function was run on the member axes, not the local axes. |
||
| } | ||
|
|
||
| public virtual int GetIndexForKey(string key) | ||
| { | ||
| // -2 = definition not found / no inputs in definition | ||
| // -1 = index not found | ||
| // 0 or greater: valid index | ||
| return Definition?.Inputs?.FindIndex(input => input.Name == key) ?? -2; | ||
|
There was a problem hiding this comment. Documented some outputs and changed the return value in case of null pointers from a valid index to something the caller can distinguish. |
||
| } | ||
|
|
||
| public int GetIndexForJoystickDevice(JoystickDevice button) | ||
|
There was a problem hiding this comment. Enumerable.OrderBy, unlike List.Sort, allows us to define what property to sort by. Therefore, the approach to integrate the index retrieval into the function is somewhat different. |
||
| { | ||
| var index = GetIndexForKey(button.Name); | ||
| // Ensure items in definition appear first | ||
| if(index < 0) | ||
| { | ||
| index = Int32.MaxValue; // force undefined stuff to the end of the list | ||
|
There was a problem hiding this comment. The inputs most relevant to MobiFlight users are probably spelled out in the definition. Entries not in the definition are likely to be less relevant, so let us move them after the named ones. |
||
| } | ||
| return index; | ||
| } | ||
|
|
||
| private void Connect() | ||
| { | ||
| if (Device == null) | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This method has three sub-methods abstracted for more specific overrides in derived classes and to keep function length down - derived classes do not need to copy the full size of the method if all they want to change is a line or two.