Merge pull request #6679 from bdach/expose-virtual-key-helper

Expose public helper to get a virtual key for a physical modifier key

Author: smoogipoo

osu.Framework/Extensions/InputKeyExtensions.cs

@@ -38,5 +38,43 @@ public static bool IsVirtual(this InputKey key)
                     return false;
             }
         }
+
+        /// <summary>
+        /// If <paramref name="key"/> is a <see cref="IsPhysical">physical</see> key which is covered by another <see cref="IsVirtual">virtual</see> key, returns that virtual key.
+        /// Otherwise, returns <see langword="null"/>.
+        /// </summary>
+        /// <example>
+        /// <code>
+        /// &gt; InputKey.LShift.GetVirtualKey()
+        /// Shift
+        /// &gt; InputKey.RSuper.GetVirtualKey()
+        /// Super
+        /// &gt; InputKey.A.GetVirtualKey()
+        /// null
+        /// </code>
+        /// </example>
+        public static InputKey? GetVirtualKey(this InputKey key)
+        {
+            switch (key)
+            {
+                case InputKey.LShift:
+                case InputKey.RShift:
+                    return InputKey.Shift;
+
+                case InputKey.LControl:
+                case InputKey.RControl:
+                    return InputKey.Control;
+
+                case InputKey.LAlt:
+                case InputKey.RAlt:
+                    return InputKey.Alt;
+
+                case InputKey.LSuper:
+                case InputKey.RSuper:
+                    return InputKey.Super;
+            }
+
+            return null;
+        }
     }
 }

osu.Framework/Input/Bindings/KeyCombination.cs

@@ -108,30 +108,6 @@ public bool IsPressed(KeyCombination pressedKeys, InputState inputState, KeyComb
             return ContainsAll(Keys, pressedKeys.Keys, matchingMode);
         }
 
-        private static InputKey? getVirtualKey(InputKey key)
-        {
-            switch (key)
-            {
-                case InputKey.LShift:
-                case InputKey.RShift:
-                    return InputKey.Shift;
-
-                case InputKey.LControl:
-                case InputKey.RControl:
-                    return InputKey.Control;
-
-                case InputKey.LAlt:
-                case InputKey.RAlt:
-                    return InputKey.Alt;
-
-                case InputKey.LSuper:
-                case InputKey.RSuper:
-                    return InputKey.Super;
-            }
-
-            return null;
-        }
-
         /// <summary>
         /// Check whether the provided set of pressed keys matches the candidate binding.
         /// </summary>
@@ -192,7 +168,7 @@ internal static bool ContainsAll(ImmutableArray<InputKey> candidateKeyBinding, I
         internal static bool KeyBindingContains(ImmutableArray<InputKey> candidateKeyBinding, InputKey physicalKey)
         {
             return candidateKeyBinding.Contains(physicalKey) ||
-                   (getVirtualKey(physicalKey) is InputKey vKey && candidateKeyBinding.Contains(vKey));
+                   (physicalKey.GetVirtualKey() is InputKey vKey && candidateKeyBinding.Contains(vKey));
         }
 
         /// <summary>
@@ -210,7 +186,7 @@ internal static bool IsPressed(ImmutableArray<InputKey> pressedPhysicalKeys, Inp
 
             foreach (var pk in pressedPhysicalKeys)
             {
-                if (getVirtualKey(pk) == candidateKey)
+                if (pk.GetVirtualKey() == candidateKey)
                     return true;
             }