File size: 16,964 Bytes
18a519f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 | #if UNITY_EDITOR
using System;
using System.Collections.Generic;
using System.Linq;
using UnityEngine.InputSystem.Layouts;
using UnityEngine.InputSystem.DualShock;
using UnityEngine.InputSystem.Utilities;
namespace UnityEngine.InputSystem.Editor
{
/// <summary>
/// Caches <see cref="InputControlLayout"/> instances.
/// </summary>
/// <remarks>
/// In the editor we need access to the <see cref="InputControlLayout">InputControlLayouts</see>
/// registered with the system in order to facilitate various UI features. Instead of
/// constructing layout instances over and over, we keep them around in here.
///
/// This class is only available in the editor (when <c>UNITY_EDITOR</c> is true).
/// </remarks>
internal static class EditorInputControlLayoutCache
{
/// <summary>
/// Iterate over all control layouts in the system.
/// </summary>
public static IEnumerable<InputControlLayout> allLayouts
{
get
{
Refresh();
return InputControlLayout.cache.table.Values;
}
}
/// <summary>
/// Iterate over all unique usages and their respective lists of layouts that use them.
/// </summary>
public static IEnumerable<Tuple<string, IEnumerable<string>>> allUsages
{
get
{
Refresh();
return s_Usages.Select(pair => new Tuple<string, IEnumerable<string>>(pair.Key, pair.Value.Select(x => x.ToString())));
}
}
public static IEnumerable<InputControlLayout> allControlLayouts
{
get
{
Refresh();
foreach (var name in s_ControlLayouts)
yield return InputControlLayout.cache.FindOrLoadLayout(name.ToString());
}
}
public static IEnumerable<InputControlLayout> allDeviceLayouts
{
get
{
Refresh();
foreach (var name in s_DeviceLayouts)
yield return InputControlLayout.cache.FindOrLoadLayout(name.ToString());
}
}
public static IEnumerable<InputControlLayout> allProductLayouts
{
get
{
Refresh();
foreach (var name in s_ProductLayouts)
yield return InputControlLayout.cache.FindOrLoadLayout(name.ToString());
}
}
public static InputControlLayout TryGetLayout(string layoutName)
{
if (string.IsNullOrEmpty(layoutName))
throw new ArgumentException("Layout name cannot be null or empty", nameof(layoutName));
Refresh();
return InputControlLayout.cache.FindOrLoadLayout(layoutName, throwIfNotFound: false);
}
public static Type GetValueType(string layoutName)
{
if (string.IsNullOrEmpty(layoutName))
throw new ArgumentException("Layout name cannot be null or empty", nameof(layoutName));
// Load layout.
var layout = TryGetLayout(layoutName);
if (layout == null)
return null;
// Grab type.
var type = layout.type;
Debug.Assert(type != null, "Layout should have associated type");
Debug.Assert(typeof(InputControl).IsAssignableFrom(type),
"Layout's associated type should be derived from InputControl");
return layout.GetValueType();
}
public static IEnumerable<InputDeviceMatcher> GetDeviceMatchers(string layoutName)
{
if (string.IsNullOrEmpty(layoutName))
throw new ArgumentException("Layout name cannot be null or empty", nameof(layoutName));
Refresh();
s_DeviceMatchers.TryGetValue(new InternedString(layoutName), out var matchers);
return matchers;
}
public static string GetDisplayName(string layoutName)
{
if (string.IsNullOrEmpty(layoutName))
throw new ArgumentException("Layout name cannot be null or empty", nameof(layoutName));
var layout = TryGetLayout(layoutName);
if (layout == null)
return layoutName;
if (!string.IsNullOrEmpty(layout.displayName))
return layout.displayName;
return layout.name;
}
/// <summary>
/// List the controls that may be present on controls or devices of the given layout by virtue
/// of being defined in other layouts based on it.
/// </summary>
/// <param name="layoutName"></param>
/// <returns></returns>
public static IEnumerable<OptionalControl> GetOptionalControlsForLayout(string layoutName)
{
if (string.IsNullOrEmpty(layoutName))
throw new ArgumentException("Layout name cannot be null or empty", nameof(layoutName));
Refresh();
if (!s_OptionalControls.TryGetValue(new InternedString(layoutName), out var list))
return Enumerable.Empty<OptionalControl>();
return list;
}
public static Texture2D GetIconForLayout(string layoutName)
{
if (string.IsNullOrEmpty(layoutName))
throw new ArgumentNullException(nameof(layoutName));
Refresh();
// See if we already have it in the cache.
var internedName = new InternedString(layoutName);
if (s_Icons.TryGetValue(internedName, out var icon))
return icon;
// No, so see if we have an icon on disk for exactly the layout
// we're looking at (i.e. with the same name).
icon = GUIHelpers.LoadIcon(layoutName);
if (icon != null)
{
s_Icons.Add(internedName, icon);
return icon;
}
// No, not that either so start walking up the inheritance chain
// until we either bump against the ceiling or find an icon.
var layout = TryGetLayout(layoutName);
if (layout != null)
{
foreach (var baseLayoutName in layout.baseLayouts)
{
icon = GetIconForLayout(baseLayoutName);
if (icon != null)
return icon;
}
// If it's a control and there's no specific icon, return a generic one.
if (layout.isControlLayout)
{
var genericIcon = GUIHelpers.LoadIcon("InputControl");
if (genericIcon != null)
{
s_Icons.Add(internedName, genericIcon);
return genericIcon;
}
}
}
// No icon for anything in this layout's chain.
return null;
}
public struct ControlSearchResult
{
public string controlPath;
public InputControlLayout layout;
public InputControlLayout.ControlItem item;
}
internal static void Clear()
{
s_LayoutRegistrationVersion = 0;
s_LayoutCacheRef.Dispose();
s_Usages.Clear();
s_ControlLayouts.Clear();
s_DeviceLayouts.Clear();
s_ProductLayouts.Clear();
s_DeviceMatchers.Clear();
s_Icons.Clear();
}
// If our layout data is outdated, rescan all the layouts in the system.
private static void Refresh()
{
var manager = InputSystem.s_Manager;
if (manager.m_LayoutRegistrationVersion == s_LayoutRegistrationVersion)
return;
Clear();
if (!s_LayoutCacheRef.valid)
{
// In the editor, we keep a permanent reference on the global layout
// cache. Means that in the editor, we always have all layouts loaded in full
// at all times whereas in the player, we load layouts only while we need
// them and then release them again.
s_LayoutCacheRef = InputControlLayout.CacheRef();
}
var layoutNames = manager.ListControlLayouts().ToArray();
// Remember which layout maps to which device matchers.
var layoutMatchers = InputControlLayout.s_Layouts.layoutMatchers;
foreach (var entry in layoutMatchers)
{
s_DeviceMatchers.TryGetValue(entry.layoutName, out var matchers);
matchers.Append(entry.deviceMatcher);
s_DeviceMatchers[entry.layoutName] = matchers;
}
// Load and store all layouts.
foreach (var layoutName in layoutNames)
{
////FIXME: does not protect against exceptions
var layout = InputControlLayout.cache.FindOrLoadLayout(layoutName, throwIfNotFound: false);
if (layout == null)
continue;
ScanLayout(layout);
if (layout.isOverride)
continue;
if (layout.isControlLayout)
s_ControlLayouts.Add(layout.name);
else if (s_DeviceMatchers.ContainsKey(layout.name))
s_ProductLayouts.Add(layout.name);
else
s_DeviceLayouts.Add(layout.name);
}
// Move all device layouts without a device description but derived from
// a layout that has one over to the product list.
foreach (var name in s_DeviceLayouts)
{
var layout = InputControlLayout.cache.FindOrLoadLayout(name);
if (layout.m_BaseLayouts.length > 1)
throw new NotImplementedException();
for (var baseLayoutName = layout.baseLayouts.FirstOrDefault(); !baseLayoutName.IsEmpty();)
{
if (s_ProductLayouts.Contains(baseLayoutName))
{
// Defer removing from s_DeviceLayouts to keep iteration stable.
s_ProductLayouts.Add(name);
break;
}
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();
}
}
// Remove every product device layout now.
s_DeviceLayouts.ExceptWith(s_ProductLayouts);
s_LayoutRegistrationVersion = manager.m_LayoutRegistrationVersion;
}
private static int s_LayoutRegistrationVersion;
private static InputControlLayout.CacheRefInstance s_LayoutCacheRef;
private static readonly HashSet<InternedString> s_ControlLayouts = new HashSet<InternedString>();
private static readonly HashSet<InternedString> s_DeviceLayouts = new HashSet<InternedString>();
private static readonly HashSet<InternedString> s_ProductLayouts = new HashSet<InternedString>();
private static readonly Dictionary<InternedString, List<OptionalControl>> s_OptionalControls =
new Dictionary<InternedString, List<OptionalControl>>();
private static readonly Dictionary<InternedString, InlinedArray<InputDeviceMatcher>> s_DeviceMatchers =
new Dictionary<InternedString, InlinedArray<InputDeviceMatcher>>();
private static Dictionary<InternedString, Texture2D> s_Icons =
new Dictionary<InternedString, Texture2D>();
// We keep a map of all unique usages we find in layouts and also
// retain a list of the layouts they are used with.
private static readonly SortedDictionary<InternedString, List<InternedString>> s_Usages =
new SortedDictionary<InternedString, List<InternedString>>();
private static void ScanLayout(InputControlLayout layout)
{
var controls = layout.controls;
for (var i = 0; i < controls.Count; ++i)
{
var control = controls[i];
// If it's not just a control modifying some inner child control, add control to all base
// layouts as an optional control.
//
// NOTE: We're looking at layouts post-merging here. Means we have already picked up all the
// controls present on the base.
if (control.isFirstDefinedInThisLayout && !control.isModifyingExistingControl && !control.layout.IsEmpty())
{
foreach (var baseLayout in layout.baseLayouts)
AddOptionalControlRecursive(baseLayout, ref control);
}
// Collect unique usages and the layouts used with them.
foreach (var usage in control.usages)
{
// Empty usages can occur for controls that want to reset inherited usages.
if (string.IsNullOrEmpty(usage))
continue;
var internedUsage = new InternedString(usage);
var internedLayout = new InternedString(control.layout);
if (!s_Usages.TryGetValue(internedUsage, out var layoutList))
{
layoutList = new List<InternedString> {internedLayout};
s_Usages[internedUsage] = layoutList;
}
else
{
var layoutAlreadyInList =
layoutList.Any(x => x == internedLayout);
if (!layoutAlreadyInList)
layoutList.Add(internedLayout);
}
}
}
}
private static void AddOptionalControlRecursive(InternedString layoutName, ref InputControlLayout.ControlItem controlItem)
{
Debug.Assert(!controlItem.isModifyingExistingControl);
Debug.Assert(!controlItem.layout.IsEmpty());
// Recurse into base.
if (InputControlLayout.s_Layouts.baseLayoutTable.TryGetValue(layoutName, out var baseLayoutName))
AddOptionalControlRecursive(baseLayoutName, ref controlItem);
// See if we already have this optional control.
var alreadyPresent = false;
if (!s_OptionalControls.TryGetValue(layoutName, out var list))
{
list = new List<OptionalControl>();
s_OptionalControls[layoutName] = list;
}
else
{
// See if we already have this control.
foreach (var item in list)
{
if (item.name == controlItem.name && item.layout == controlItem.layout)
{
alreadyPresent = true;
break;
}
}
}
if (!alreadyPresent)
list.Add(new OptionalControl {name = controlItem.name, layout = controlItem.layout});
}
/// <summary>
/// An optional control is a control that is not defined on a layout but which is defined
/// on a derived layout.
/// </summary>
/// <remarks>
/// An example is the "acceleration" control defined by some layouts based on <see cref="Gamepad"/> (e.g.
/// <see cref="DualShockGamepad.acceleration"/>. This means gamepads
/// MAY have a gyro and thus MAY have an "acceleration" control.
///
/// In bindings (<see cref="InputBinding"/>), it is perfectly valid to deal with this opportunistically
/// and create a binding to <c>"<Gamepad>/acceleration"</c> which will bind correctly IF the gamepad has
/// an acceleration control but will do nothing if it doesn't.
///
/// The concept of optional controls permits setting up such bindings in the UI by making controls that
/// are present on more specific layouts than the one currently looked at available directly on the
/// base layout.
/// </remarks>
public struct OptionalControl
{
public InternedString name;
public InternedString layout;
////REVIEW: do we want to have the list of layouts that define the control?
}
}
}
#endif // UNITY_EDITOR
|