FIX: Errors when matching fields in InputDeviceDescription.capabilities (#1103).

Author: Rene Damm

Assets/Tests/InputSystem/CoreTests_Devices.cs

@@ -3285,6 +3285,7 @@ private struct TestDeviceCapabilities
         public string stringCap;
         public int intCap;
         public float floatCap;
+        public float floatCapWithExponent;
         public bool boolCap;
         public NestedCaps nestedCap;
         public string[] arrayCap;
@@ -3335,6 +3336,8 @@ public void Devices_CanMatchDeviceDescriptions_WithCapabilities()
             .WithCapability("intCap", "1234");
         var matchFloatCapWithString = new InputDeviceMatcher()
             .WithCapability("floatCap", "1.234");
+        var matchFloatWithExponentCapWithString = new InputDeviceMatcher()
+            .WithCapability("floatCapWithExponent", "1.234e-10");
         var matchBoolCapWithString = new InputDeviceMatcher()
             .WithCapability("boolCap", "true");
         var matchNone = new InputDeviceMatcher()
@@ -3348,6 +3351,7 @@ public void Devices_CanMatchDeviceDescriptions_WithCapabilities()
                 stringCap = "string",
                 intCap = 1234,
                 floatCap = 1.234f,
+                floatCapWithExponent = 1.234e-10f,
                 boolCap = true,
                 nestedCap = new TestDeviceCapabilities.NestedCaps
                 {
@@ -3368,6 +3372,7 @@ public void Devices_CanMatchDeviceDescriptions_WithCapabilities()
         Assert.That(matchIntCapWithRegex.MatchPercentage(description), Is.EqualTo(1 / 2.0).Within(0.0001));
         Assert.That(matchIntCapWithString.MatchPercentage(description), Is.EqualTo(1 / 2.0).Within(0.0001));
         Assert.That(matchFloatCapWithString.MatchPercentage(description), Is.EqualTo(1 / 2.0).Within(0.0001));
+        Assert.That(matchFloatWithExponentCapWithString.MatchPercentage(description), Is.EqualTo(1 / 2.0).Within(0.0001));
         Assert.That(matchBoolCapWithString.MatchPercentage(description), Is.EqualTo(1 / 2.0).Within(0.0001));
         Assert.That(matchNone.MatchPercentage(description), Is.EqualTo(0).Within(0.0001));
     }

Assets/Tests/InputSystem/Plugins/HIDTests.cs

@@ -106,16 +106,60 @@ public void Devices_DevicesNotAllowedBySupportedHIDUsagesAreSkipped()
 
         Assert.That(InputSystem.devices, Has.Count.EqualTo(0));
         Assert.That(InputSystem.GetDeviceById(deviceId), Is.Null);
+        Assert.That(InputSystem.GetUnsupportedDevices(), Has.Count.EqualTo(1));
+        Assert.That(InputSystem.GetUnsupportedDevices()[0].product, Is.EqualTo("TestHID"));
 
         HIDSupport.supportedHIDUsages = new ReadOnlyArray<HIDSupport.HIDPageUsage>(
             new[] {new HIDSupport.HIDPageUsage((HID.UsagePage) 5678, 1234)}
         );
 
-        runtime.ReportNewInputDevice(descriptionJson, deviceId);
-        InputSystem.Update();
+        Assert.That(InputSystem.devices, Has.Count.EqualTo(1));
+        Assert.That(InputSystem.GetDeviceById(deviceId), Is.Not.Null);
+        Assert.That(InputSystem.devices[0], Is.TypeOf<HID>());
+        Assert.That(InputSystem.devices[0].description.product, Is.EqualTo("TestHID"));
+        Assert.That(((HID)InputSystem.devices[0]).hidDescriptor.usagePage, Is.EqualTo((HID.UsagePage) 5678));
+        Assert.That(((HID)InputSystem.devices[0]).hidDescriptor.usage, Is.EqualTo(1234));
 
+        HIDSupport.supportedHIDUsages = new ReadOnlyArray<HIDSupport.HIDPageUsage>(
+            new[] {new HIDSupport.HIDPageUsage((HID.UsagePage) 5678, 1234)}
+        );
+
+        // No change.
         Assert.That(InputSystem.devices, Has.Count.EqualTo(1));
         Assert.That(InputSystem.GetDeviceById(deviceId), Is.Not.Null);
+        Assert.That(InputSystem.devices[0], Is.TypeOf<HID>());
+        Assert.That(InputSystem.devices[0].description.product, Is.EqualTo("TestHID"));
+        Assert.That(((HID)InputSystem.devices[0]).hidDescriptor.usagePage, Is.EqualTo((HID.UsagePage) 5678));
+        Assert.That(((HID)InputSystem.devices[0]).hidDescriptor.usage, Is.EqualTo(1234));
+
+        // Add another.
+        var descriptionJson2 = new InputDeviceDescription
+        {
+            interfaceName = HID.kHIDInterface,
+            manufacturer = "TestVendor",
+            product = "OtherTestHID",
+            capabilities = hidDescriptor.ToJson()
+        }.ToJson();
+        var deviceId2 = runtime.AllocateDeviceId();
+
+        runtime.ReportNewInputDevice(descriptionJson2, deviceId2);
+        InputSystem.Update();
+
+        Assert.That(InputSystem.devices, Has.Count.EqualTo(2));
+        Assert.That(InputSystem.GetDeviceById(deviceId2), Is.Not.Null);
+        Assert.That(InputSystem.devices[1], Is.TypeOf<HID>());
+        Assert.That(InputSystem.devices[1].description.product, Is.EqualTo("OtherTestHID"));
+        Assert.That(((HID)InputSystem.devices[1]).hidDescriptor.usagePage, Is.EqualTo((HID.UsagePage) 5678));
+        Assert.That(((HID)InputSystem.devices[1]).hidDescriptor.usage, Is.EqualTo(1234));
+
+        HIDSupport.supportedHIDUsages = new ReadOnlyArray<HIDSupport.HIDPageUsage>();
+
+        Assert.That(InputSystem.devices, Is.Empty);
+        Assert.That(InputSystem.GetDeviceById(deviceId), Is.Null);
+        Assert.That(InputSystem.GetDeviceById(deviceId2), Is.Null);
+        Assert.That(InputSystem.GetUnsupportedDevices(), Has.Count.EqualTo(2));
+        Assert.That(InputSystem.GetUnsupportedDevices(), Has.Exactly(1).With.Property("product").EqualTo("TestHID"));
+        Assert.That(InputSystem.GetUnsupportedDevices(), Has.Exactly(1).With.Property("product").EqualTo("OtherTestHID"));
     }
 
     [Test]

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -15,6 +15,8 @@ however, it has to be formatted properly to pass verification tests.
 - Can now override built-in Android gamepad layouts. Previously, the input system would always choose its default defaults even after registering more specific layouts using `InputSystem.RegisterLayout`.
 - `InputControlPath.TryGetControlLayout` no longer throws `NotImplementedException` for `<Mouse>/scroll/x` and similar paths where the layout is modifying a control it inherited from its base layout ([thread](https://forum.unity.com/threads/notimplementedexception-when-using-inputcontrolpath-trygetcontrollayout-on-mouse-controls.847129/)).
 - Fixed compilation errors when disabling built-in VR and XR packages. ([case 1214248](https://issuetracker.unity3d.com/issues/enable-input-system-symbol-is-not-being-updated-when-the-input-system-is-changed-in-player-settings/)).
+- No longer throws `NotImplementedException` when matching against a field of `InputDeviceDescription.capabilities` when the value of the field used scientific notation.
+- No longer incorrectly matches fields of `InputDeviceDescription.capabilities` by prefix only (i.e. previously it would find the field "foo" when actually looking for "foobar").
 
 #### Actions
 

Packages/com.unity.inputsystem/InputSystem/InputManager.cs

@@ -2292,7 +2292,7 @@ internal void ApplySettings()
                 m_SettingsChangedListeners[i]();
         }
 
-        private void AddAvailableDevicesThatAreNowRecognized()
+        internal void AddAvailableDevicesThatAreNowRecognized()
         {
             for (var i = 0; i < m_AvailableDeviceCount; ++i)
             {
@@ -3319,10 +3319,12 @@ internal void RestoreDevicesAfterDomainReload()
             using (InputDeviceBuilder.Ref())
             {
                 DeviceState[] retainedDeviceStates = null;
+                var deviceStates = m_SavedDeviceStates;
                 var deviceCount = m_SavedDeviceStates.LengthSafe();
+                m_SavedDeviceStates = null; // Prevent layout matcher registering themselves on the fly from picking anything off this list.
                 for (var i = 0; i < deviceCount; ++i)
                 {
-                    ref var deviceState = ref m_SavedDeviceStates[i];
+                    ref var deviceState = ref deviceStates[i];
 
                     var device = TryGetDeviceById(deviceState.deviceId);
                     if (device != null)
@@ -3425,7 +3427,7 @@ private bool RestoreDeviceFromSavedState(ref DeviceState deviceState, InternedSt
             catch (Exception exception)
             {
                 Debug.LogError(
-                    $"Could not re-recreate input device '{deviceState.description}' with layout '{deviceState.layout}' and variants '{deviceState.variants}' after domain reload");
+                    $"Could not recreate input device '{deviceState.description}' with layout '{deviceState.layout}' and variants '{deviceState.variants}' after domain reload");
                 Debug.LogException(exception);
                 return true; // Don't try again.
             }

Packages/com.unity.inputsystem/InputSystem/Plugins/HID/HID.cs

@@ -114,7 +114,6 @@ internal static string OnFindLayoutForDevice(ref InputDeviceDescription descript
             if (!hasUsableElements)
                 return null;
 
-
             ////TODO: we should be able to differentiate a HID joystick from other joysticks in bindings alone
             // Determine base layout.
             var baseType = typeof(HID);

Packages/com.unity.inputsystem/InputSystem/Plugins/HID/HIDSupport.cs

@@ -1,3 +1,4 @@
+using System.Linq;
 using UnityEngine.InputSystem.Utilities;
 #if UNITY_EDITOR
 using UnityEditor;
@@ -88,7 +89,25 @@ public HIDPageUsage(HID.GenericDesktop usage)
         public static ReadOnlyArray<HIDPageUsage> supportedHIDUsages
         {
             get => s_SupportedHIDUsages;
-            set => s_SupportedHIDUsages = value.ToArray();
+            set
+            {
+                s_SupportedHIDUsages = value.ToArray();
+
+                // Add HIDs we now support.
+                InputSystem.s_Manager.AddAvailableDevicesThatAreNowRecognized();
+
+                // Remove HIDs we no longer support.
+                for (var i = 0; i < InputSystem.devices.Count; ++i)
+                {
+                    var device = InputSystem.devices[i];
+                    if (device is HID hid && !s_SupportedHIDUsages.Contains(new HIDPageUsage(hid.hidDescriptor.usagePage, hid.hidDescriptor.usage)))
+                    {
+                        // Remove the entire generated layout. This will also remove all devices based on it.
+                        InputSystem.RemoveLayout(device.layout);
+                        --i;
+                    }
+                }
+            }
         }
 
         /// <summary>

Packages/com.unity.inputsystem/InputSystem/Utilities/JsonParser.cs

@@ -87,15 +87,15 @@ public bool NavigateToProperty(string path)
                 }
 
                 // See if we have a match.
-                if (m_Position < m_Length && m_Text[m_Position] == '"')
+                if (m_Position < m_Length && m_Text[m_Position] == '"' && (pathPosition >= pathLength || path[pathPosition] == '/' || path[pathPosition] == '['))
                 {
                     // Have matched a property name. Navigate to value.
                     ++m_Position;
                     if (!SkipToValue())
                         return false;
 
                     // Check if we have matched everything in the path.
-                    if (pathPosition == pathLength)
+                    if (pathPosition >= pathLength)
                         return true;
                     if (path[pathPosition] == '/')
                     {
@@ -374,6 +374,7 @@ public bool ParseNumber(out JsonValue result)
             var integralPart = 0L;
             var fractionalPart = 0.0;
             var fractionalDivisor = 10.0;
+            var exponent = 0;
 
             // Parse sign.
             if (m_Text[m_Position] == '-')
@@ -416,11 +417,36 @@ public bool ParseNumber(out JsonValue result)
             }
 
             if (m_Position < m_Length && (m_Text[m_Position] == 'e' || m_Text[m_Position] == 'E'))
-                throw new NotImplementedException("exponents");
+            {
+                ++m_Position;
+                var isNegative = false;
+                if (m_Position < m_Length && m_Text[m_Position] == '-')
+                {
+                    isNegative = true;
+                    ++m_Position;
+                }
+                else if (m_Position < m_Length && m_Text[m_Position] == '+')
+                {
+                    ++m_Position;
+                }
+
+                var multiplier = 1;
+                while (m_Position < m_Length && char.IsDigit(m_Text[m_Position]))
+                {
+                    var digit = m_Text[m_Position] - '0';
+                    exponent *= multiplier;
+                    exponent += digit;
+                    multiplier *= 10;
+                    ++m_Position;
+                }
+
+                if (isNegative)
+                    exponent *= -1;
+            }
 
             if (!m_DryRun)
             {
-                if (!haveFractionalPart)
+                if (!haveFractionalPart && exponent == 0)
                 {
                     if (negative)
                         result = -integralPart;
@@ -429,10 +455,14 @@ public bool ParseNumber(out JsonValue result)
                 }
                 else
                 {
+                    float value;
                     if (negative)
-                        result = (float)-(integralPart + fractionalPart);
+                        value = (float)-(integralPart + fractionalPart);
                     else
-                        result = (float)(integralPart + fractionalPart);
+                        value = (float)(integralPart + fractionalPart);
+                    if (exponent != 0)
+                        value *= Mathf.Pow(10, exponent);
+                    result = value;
                 }
             }