FIX: LayoutNotFoundExceptions from ToHumanReadableString (#946).

Author: Rene Damm

Assets/Tests/InputSystem/CoreTests_Controls.cs

@@ -9,6 +9,7 @@
 using UnityEngine.InputSystem.LowLevel;
 using UnityEngine.InputSystem.Processors;
 using UnityEngine.InputSystem.Utilities;
+using UnityEngine.Scripting;
 using UnityEngine.TestTools.Constraints;
 using Is = UnityEngine.TestTools.Constraints.Is;
 
@@ -1021,6 +1022,22 @@ public void Controls_CanTurnControlPathIntoHumanReadableText()
                 InputControlPath.HumanReadableStringOptions.OmitDevice), Is.EqualTo("PrimaryAction"));
     }
 
+    [Preserve]
+    private class DeviceWithoutAnyControls : InputDevice
+    {
+    }
+
+    [Test]
+    [Category("Controls")]
+    public void Controls_CanTurnControlPathIntoHumanReadableText_EvenIfLayoutCannotBeFoundOrHasErrors()
+    {
+        // This one will throw as the layout will result in a zero-size memory block.
+        InputSystem.RegisterLayout<DeviceWithoutAnyControls>();
+
+        Assert.That(InputControlPath.ToHumanReadableString("<UnknownGamepad>/leftStick"), Is.EqualTo("leftStick [UnknownGamepad]"));
+        Assert.That(InputControlPath.ToHumanReadableString("<DeviceWithoutAnyControls>/control"), Is.EqualTo("control [DeviceWithoutAnyControls]"));
+    }
+
     [Test]
     [Category("Controls")]
     public void Controls_CanCheckIfControlMatchesGivenPath()

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 Due to package verification, the latest version below is the unpublished version and the date is meaningless.
 however, it has to be formatted properly to pass verification tests.
 
+## [1.0.0-preview.3] - 2019-12-12
+
+### Fixed
+
+- Fixed `LayoutNotFoundException` being thrown when `InputControlPath.ToHumanReadableString` referenced a layout that could not be found.
+
 ## [1.0.0-preview.2] - 2019-11-4
 
 ### Changed

Packages/com.unity.inputsystem/Documentation~/Components.md

@@ -13,7 +13,7 @@ The Input System provides two `MonoBehaviour` components that simplify setting u
 
 ![PlayerInput](Images/PlayerInput.png)
 
-Each [`PlayerInput`](../api/UnityEngine.InputSystem.PlayerInput.html) instance represents a separate player in the game. Multiple [`PlayerInput`](../api/UnityEngine.InputSystem.PlayerInput.html) instances can coexist at the same time (though not on the same `GameObject`) to represent local multiplayer setups. The Input System pairs each player to a unique set of Devices that the player uses excplusively, but you can also manually pair Devices in a way that enables two or more players to share a Device (for example, left/right keyboard splits or hot seat use).
+Each [`PlayerInput`](../api/UnityEngine.InputSystem.PlayerInput.html) instance represents a separate player in the game. Multiple [`PlayerInput`](../api/UnityEngine.InputSystem.PlayerInput.html) instances can coexist at the same time (though not on the same `GameObject`) to represent local multiplayer setups. The Input System pairs each player to a unique set of Devices that the player uses exclusively, but you can also manually pair Devices in a way that enables two or more players to share a Device (for example, left/right keyboard splits or hot seat use).
 
 Each [`PlayerInput`](../api/UnityEngine.InputSystem.PlayerInput.html) corresponds to one [`InputUser`](UserManagement.md). You can query the [`InputUser`](UserManagement.md) from the component using [`PlayerInput.user`](../api/UnityEngine.InputSystem.PlayerInput.html#UnityEngine_InputSystem_PlayerInput_user).
 

Packages/com.unity.inputsystem/InputSystem/Controls/InputControlLayout.cs

@@ -2052,7 +2052,7 @@ public void Clear()
                 table = null;
             }
 
-            public InputControlLayout FindOrLoadLayout(string name)
+            public InputControlLayout FindOrLoadLayout(string name, bool throwIfNotFound = true)
             {
                 var internedName = new InternedString(name);
 
@@ -2064,7 +2064,9 @@ public InputControlLayout FindOrLoadLayout(string name)
                     return layout;
 
                 // Nothing.
-                throw new LayoutNotFoundException(name);
+                if (throwIfNotFound)
+                    throw new LayoutNotFoundException(name);
+                return null;
             }
         }
 

Packages/com.unity.inputsystem/InputSystem/Controls/InputControlPath.cs

@@ -325,7 +325,7 @@ private static string FindControlLayoutRecursive(ref PathParser parser, string l
             using (InputControlLayout.CacheRef())
             {
                 // Load layout.
-                var layout = InputControlLayout.cache.FindOrLoadLayout(new InternedString(layoutName));
+                var layout = InputControlLayout.cache.FindOrLoadLayout(new InternedString(layoutName), throwIfNotFound: false);
                 if (layout == null)
                     return null;
 
@@ -1062,7 +1062,7 @@ public string ToHumanReadableString(string parentLayoutName, out string referenc
                     // Where possible, use the displayName of the given layout rather than
                     // just the internal layout name.
                     string layoutString;
-                    var referencedLayout = InputControlLayout.cache.FindOrLoadLayout(referencedLayoutName);
+                    var referencedLayout = InputControlLayout.cache.FindOrLoadLayout(referencedLayoutName, throwIfNotFound: false);
                     if (referencedLayout != null && !string.IsNullOrEmpty(referencedLayout.m_DisplayName))
                         layoutString = referencedLayout.m_DisplayName;
                     else
@@ -1084,7 +1084,8 @@ public string ToHumanReadableString(string parentLayoutName, out string referenc
                     {
                         // NOTE: This produces a fully merged layout. We should thus pick up display names
                         //       from base layouts automatically wherever applicable.
-                        var parentLayout = InputControlLayout.cache.FindOrLoadLayout(new InternedString(parentLayoutName));
+                        var parentLayout =
+                            InputControlLayout.cache.FindOrLoadLayout(new InternedString(parentLayoutName), throwIfNotFound: false);
                         if (parentLayout != null)
                         {
                             var controlName = new InternedString(name.ToString());

Packages/com.unity.inputsystem/InputSystem/Editor/EditorInputControlLayoutCache.cs

@@ -80,7 +80,7 @@ public static InputControlLayout TryGetLayout(string layoutName)
                 throw new ArgumentException("Layout name cannot be null or empty", nameof(layoutName));
 
             Refresh();
-            return InputControlLayout.cache.FindOrLoadLayout(layoutName);
+            return InputControlLayout.cache.FindOrLoadLayout(layoutName, throwIfNotFound: false);
         }
 
         public static Type GetValueType(string layoutName)
@@ -232,7 +232,10 @@ private static void Refresh()
             // Load and store all layouts.
             foreach (var layoutName in layoutNames)
             {
-                var layout = InputControlLayout.cache.FindOrLoadLayout(layoutName);
+                var layout = InputControlLayout.cache.FindOrLoadLayout(layoutName, throwIfNotFound: false);
+                if (layout == null)
+                    continue;
+
                 ScanLayout(layout);
 
                 if (layout.isOverride)
@@ -264,7 +267,9 @@ private static void Refresh()
                         break;
                     }
 
-                    var baseLayout = InputControlLayout.cache.FindOrLoadLayout(baseLayoutName);
+                    var baseLayout = InputControlLayout.cache.FindOrLoadLayout(baseLayoutName, throwIfNotFound: false);
+                    if (baseLayout == null)
+                        continue;
                     if (baseLayout.m_BaseLayouts.length > 1)
                         throw new NotImplementedException();
                     baseLayoutName = baseLayout.baseLayouts.FirstOrDefault();

Packages/com.unity.inputsystem/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "com.unity.inputsystem",
 	"displayName": "Input System",
-	"version": "1.0.0-preview.2",
+	"version": "1.0.0-preview.3",
 	"unity": "2019.1",
 	"repository": {
 		"type": "git",