From 2362b5a847749decf630369b91bf04a8682d75ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dariusz=20Komosi=C5=84ski?= Date: Fri, 13 Sep 2019 17:07:32 +0200 Subject: [PATCH] Cleanup KeyGesture code. Add constructor taking non-deprecated arguments. --- src/Avalonia.Input/KeyGesture.cs | 131 ++++++++++-------- .../KeyGestureTests.cs | 20 +-- 2 files changed, 81 insertions(+), 70 deletions(-) diff --git a/src/Avalonia.Input/KeyGesture.cs b/src/Avalonia.Input/KeyGesture.cs index 2377edf640..0928b87264 100644 --- a/src/Avalonia.Input/KeyGesture.cs +++ b/src/Avalonia.Input/KeyGesture.cs @@ -1,41 +1,60 @@ +// Copyright (c) The Avalonia Project. All rights reserved. +// Licensed under the MIT license. See licence.md file in the project root for full license information. + using System; using System.Collections.Generic; using System.Linq; namespace Avalonia.Input { + /// + /// Defines a keyboard input combination. + /// public sealed class KeyGesture : IEquatable { + private static readonly Dictionary s_keySynonyms = new Dictionary + { + { "+", Key.OemPlus }, { "-", Key.OemMinus }, { ".", Key.OemPeriod } + }; + public KeyGesture() { - } - public KeyGesture(Key key, InputModifiers modifiers = InputModifiers.None) + [Obsolete("Use constructor taking KeyModifiers")] + public KeyGesture(Key key, InputModifiers modifiers) + { + Key = key; + KeyModifiers = (KeyModifiers)(((int)modifiers) & 0xf); + } + + public KeyGesture(Key key, KeyModifiers modifiers = KeyModifiers.None) { Key = key; - Modifiers = modifiers; + KeyModifiers = modifiers; } - + public bool Equals(KeyGesture other) { if (ReferenceEquals(null, other)) return false; if (ReferenceEquals(this, other)) return true; - return Key == other.Key && Modifiers == other.Modifiers; + + return Key == other.Key && KeyModifiers == other.KeyModifiers; } public override bool Equals(object obj) { if (ReferenceEquals(null, obj)) return false; if (ReferenceEquals(this, obj)) return true; - return obj is KeyGesture && Equals((KeyGesture) obj); + + return obj is KeyGesture && Equals((KeyGesture)obj); } public override int GetHashCode() { unchecked { - return ((int) Key*397) ^ (int) Modifiers; + return ((int)Key * 397) ^ (int)KeyModifiers; } } @@ -49,85 +68,85 @@ namespace Avalonia.Input return !Equals(left, right); } - public Key Key { get; set; } + public Key Key { get; } [Obsolete("Use KeyModifiers")] - public InputModifiers Modifiers - { - get => (InputModifiers)KeyModifiers; - set => KeyModifiers = (KeyModifiers)(((int)value) & 0xf); - } - - public KeyModifiers KeyModifiers { get; set; } + public InputModifiers Modifiers => (InputModifiers)KeyModifiers; - - static readonly Dictionary KeySynonyms = new Dictionary - { - {"+", Key.OemPlus }, - {"-", Key.OemMinus}, - {".", Key.OemPeriod } - }; - - //TODO: Move that to external key parser - static Key ParseKey(string key) - { - Key rv; - if (KeySynonyms.TryGetValue(key.ToLower(), out rv)) - return rv; - return (Key)Enum.Parse(typeof (Key), key, true); - } - - static InputModifiers ParseModifier(string modifier) - { - if (modifier.Equals("ctrl", StringComparison.OrdinalIgnoreCase)) - return InputModifiers.Control; - return (InputModifiers) Enum.Parse(typeof (InputModifiers), modifier, true); - } + public KeyModifiers KeyModifiers { get; } public static KeyGesture Parse(string gesture) { - //string.Split can't be used here because "Ctrl++" is a perfectly valid key gesture + // string.Split can't be used here because "Ctrl++" is a perfectly valid key gesture - var parts = new List(); + var key = Key.None; + var keyModifiers = KeyModifiers.None; var cstart = 0; + for (var c = 0; c <= gesture.Length; c++) { var ch = c == gesture.Length ? '\0' : gesture[c]; - if (c == gesture.Length || (ch == '+' && cstart != c)) + bool isLast = c == gesture.Length; + + if (isLast || (ch == '+' && cstart != c)) { - parts.Add(gesture.Substring(cstart, c - cstart)); + var partSpan = gesture.AsSpan(cstart, c - cstart).Trim(); + + if (isLast) + { + key = ParseKey(partSpan.ToString()); + } + else + { + keyModifiers |= ParseModifier(partSpan); + } + cstart = c + 1; } } - for (var c = 0; c < parts.Count; c++) - parts[c] = parts[c].Trim(); - var rv = new KeyGesture(); - for (var c = 0; c < parts.Count; c++) - { - if (c == parts.Count - 1) - rv.Key = ParseKey(parts[c]); - else - rv.Modifiers |= ParseModifier(parts[c]); - } - return rv; + return new KeyGesture(key, keyModifiers); } public override string ToString() { var parts = new List(); - foreach (var flag in Enum.GetValues(typeof (InputModifiers)).Cast()) + + foreach (var flag in Enum.GetValues(typeof(KeyModifiers)).Cast()) { - if (Modifiers.HasFlag(flag) && flag != InputModifiers.None) + if (KeyModifiers.HasFlag(flag) && flag != KeyModifiers.None) + { parts.Add(flag.ToString()); + } } + parts.Add(Key.ToString()); + return string.Join(" + ", parts); } - public bool Matches(KeyEventArgs keyEvent) => ResolveNumPadOperationKey(keyEvent.Key) == Key && keyEvent.Modifiers == Modifiers; + public bool Matches(KeyEventArgs keyEvent) => ResolveNumPadOperationKey(keyEvent.Key) == Key && keyEvent.KeyModifiers == KeyModifiers; + + // TODO: Move that to external key parser + private static Key ParseKey(string key) + { + if (s_keySynonyms.TryGetValue(key.ToLower(), out Key rv)) + return rv; + + return (Key)Enum.Parse(typeof(Key), key, true); + } + + private static KeyModifiers ParseModifier(ReadOnlySpan modifier) + { + if (modifier.Equals("ctrl".AsSpan(), StringComparison.OrdinalIgnoreCase)) + { + return KeyModifiers.Control; + } + + return (KeyModifiers)Enum.Parse(typeof(KeyModifiers), modifier.ToString(), true); + } private Key ResolveNumPadOperationKey(Key key) { diff --git a/tests/Avalonia.Input.UnitTests/KeyGestureTests.cs b/tests/Avalonia.Input.UnitTests/KeyGestureTests.cs index 006ed1140e..95eaab30de 100644 --- a/tests/Avalonia.Input.UnitTests/KeyGestureTests.cs +++ b/tests/Avalonia.Input.UnitTests/KeyGestureTests.cs @@ -1,8 +1,4 @@ -using System; using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; using Xunit; namespace Avalonia.Input.UnitTests @@ -11,13 +7,11 @@ namespace Avalonia.Input.UnitTests { public static readonly IEnumerable SampleData = new object[][] { - new object[]{"Ctrl+A", new KeyGesture {Key = Key.A, Modifiers = InputModifiers.Control}}, - new object[]{" \tShift\t+Alt +B", new KeyGesture {Key = Key.B, Modifiers = InputModifiers.Shift|InputModifiers.Alt} }, - new object[]{"Control++", new KeyGesture {Key = Key.OemPlus, Modifiers = InputModifiers.Control} } + new object[]{"Ctrl+A", new KeyGesture(Key.A, InputModifiers.Control)}, + new object[]{" \tShift\t+Alt +B", new KeyGesture(Key.B, InputModifiers.Shift | InputModifiers.Alt) }, + new object[]{"Control++", new KeyGesture(Key.OemPlus, InputModifiers.Control) } }; - - - + [Theory] [MemberData(nameof(SampleData))] public void Key_Gesture_Is_Able_To_Parse_Sample_Data(string text, KeyGesture gesture) @@ -31,10 +25,8 @@ namespace Avalonia.Input.UnitTests [InlineData(Key.OemPeriod, Key.Decimal)] public void Key_Gesture_Matches_NumPad_To_Regular_Digit(Key gestureKey, Key pressedKey) { - var keyGesture = new KeyGesture - { - Key = gestureKey - }; + var keyGesture = new KeyGesture(gestureKey); + Assert.True(keyGesture.Matches(new KeyEventArgs { Key = pressedKey