Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #3095. WindowsDriver should return the mask keys to IsShift, IsAlt and IsCtrl return the right value. #3096

Closed
wants to merge 2 commits into from
Closed

Fixes #3095. WindowsDriver should return the mask keys to IsShift, IsAlt and IsCtrl return the right value. #3096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf23b5e
Fixes #3095. WindowsDriver should return the mask keys to IsShift, Is…
BDisp Dec 28, 2023
cd0af27
Modifiers keys are valid to be handled on key down and key up.
BDisp Dec 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Terminal.Gui/ConsoleDrivers/WindowsDriver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1053,15 +1053,15 @@ KeyCode MapKey (WindowsConsole.ConsoleKeyInfoEx keyInfoEx)

// If the key is JUST a modifier, return it as that key
if (key == (ConsoleKey)16) { // Shift
return KeyCode.ShiftKey;
return KeyCode.ShiftMask;
}

if (key == (ConsoleKey)17) { // Ctrl
return KeyCode.CtrlKey;
return KeyCode.CtrlMask;
}

if (key == (ConsoleKey)18) { // Alt
return KeyCode.AltKey;
return KeyCode.AltMask;
}

return ConsoleKeyMapping.MapKeyModifiers (keyInfo, (KeyCode)((uint)keyInfo.KeyChar));
Expand Down
2 changes: 1 addition & 1 deletion Terminal.Gui/Input/Key.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ static string GetKeyString (KeyCode key)
/// <returns>The formatted string. If the key is a printable character, it will be returned as a string. Otherwise, the key name will be returned.</returns>
public static string ToString (KeyCode key, Rune separator)
{
if (key is KeyCode.Null || (key & ~KeyCode.CtrlMask & ~KeyCode.AltMask & ~KeyCode.ShiftMask) == 0) {
if (key is KeyCode.Null) {
// Same as Key.IsValid
return @"Null";
}
Expand Down
77 changes: 67 additions & 10 deletions UnitTests/Input/KeyTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,11 +333,11 @@ public void ToString_ShouldReturnReadableString ()

[Theory]
[InlineData ((KeyCode)'☑', "☑")]
//[InlineData ((ConsoleDriverKey)'英', "英")]
//[InlineData ((ConsoleDriverKey)'{', "{")]
[InlineData ((KeyCode)'英', "英")]
[InlineData ((KeyCode)'{', "{")]
[InlineData ((KeyCode)'\'', "\'")]
[InlineData ((KeyCode)'ó', "ó")]
[InlineData ((KeyCode)'ó' | KeyCode.ShiftMask, "Shift+ó")] // is this right???
[InlineData ((KeyCode)'ó' | KeyCode.ShiftMask, "Shift+ó")] // is this right??? No, it should be Ó upper case
[InlineData ((KeyCode)'Ó', "Ó")]
[InlineData ((KeyCode)'ç' | KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.CtrlMask, "Ctrl+Alt+Shift+ç")]
[InlineData ((KeyCode)'a', "a")] // 97 or Key.Space | Key.A
Expand Down Expand Up @@ -398,13 +398,22 @@ public void ToString_ShouldReturnReadableString ()
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask | KeyCode.CursorUp, "Ctrl+Alt+CursorUp")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.CursorUp, "Ctrl+Alt+Shift+CursorUp")]
[InlineData (KeyCode.Null, "Null")]
[InlineData (KeyCode.ShiftMask | KeyCode.Null, "Null")]
[InlineData (KeyCode.CtrlMask | KeyCode.Null, "Null")]
[InlineData (KeyCode.AltMask | KeyCode.Null, "Null")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.Null, "Null")]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.Null, "Null")]
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask | KeyCode.Null, "Null")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.Null, "Null")]
[InlineData (KeyCode.ShiftMask | KeyCode.Null, "Shift")]
[InlineData (KeyCode.CtrlMask | KeyCode.Null, "Ctrl")]
[InlineData (KeyCode.AltMask | KeyCode.Null, "Alt")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.Null, "Ctrl+Shift")]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.Null, "Alt+Shift")]
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask | KeyCode.Null, "Ctrl+Alt")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask | KeyCode.Null, "Ctrl+Alt+Shift")]
#pragma warning disable xUnit1025 // InlineData should be unique within the Theory it belongs to
[InlineData (KeyCode.ShiftMask, "Shift")]
[InlineData (KeyCode.CtrlMask, "Ctrl")]
[InlineData (KeyCode.AltMask, "Alt")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask, "Ctrl+Shift")]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask, "Alt+Shift")]
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask, "Ctrl+Alt")]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask, "Ctrl+Alt+Shift")]
#pragma warning restore xUnit1025 // InlineData should be unique within the Theory it belongs to
[InlineData (KeyCode.AltKey, "AltKey")]
[InlineData (KeyCode.CtrlKey, "CtrlKey")]
[InlineData (KeyCode.ShiftKey, "ShiftKey")]
Expand Down Expand Up @@ -471,4 +480,52 @@ public void TryParse_ShouldReturnTrue_WhenValidKey (string keyString, Key expect
[InlineData ("0x99")]
[InlineData ("Ctrl-Ctrl")]
public void TryParse_ShouldReturnFalse_On_InvalidKey (string keyString) => Assert.False (Key.TryParse (keyString, out var _));

[Theory]
[InlineData (KeyCode.ShiftKey, KeyCode.ShiftMask, true)]
[InlineData (KeyCode.ShiftKey | KeyCode.A, KeyCode.ShiftMask | KeyCode.A, true)]
public void IsShift_With_Wrong_And_Right_ShiftMask_NoShift (KeyCode wrongKeyCode, KeyCode rightKeyCode, bool isShift)
{
Assert.NotEqual (((Key)wrongKeyCode).IsShift, isShift);
Assert.NotEqual ((Key)(wrongKeyCode & ~KeyCode.ShiftKey), ((Key)wrongKeyCode).NoShift);
Assert.Equal (((Key)rightKeyCode).IsShift, isShift);
Assert.Equal ((Key)(rightKeyCode & ~KeyCode.ShiftMask), ((Key)rightKeyCode).NoShift);
}

[Theory]
[InlineData (KeyCode.AltKey, KeyCode.AltMask, true)]
[InlineData (KeyCode.AltKey | KeyCode.A, KeyCode.AltMask | KeyCode.A, true)]
public void IsAlt_With_Wrong_And_Right_AltMask_NoAlt (KeyCode wrongKeyCode, KeyCode rightKeyCode, bool isAlt)
{
Assert.NotEqual (((Key)wrongKeyCode).IsAlt, isAlt);
Assert.NotEqual ((Key)(wrongKeyCode & ~KeyCode.AltKey), ((Key)wrongKeyCode).NoAlt);
Assert.Equal (((Key)rightKeyCode).IsAlt, isAlt);
Assert.Equal ((Key)(rightKeyCode & ~KeyCode.AltMask), ((Key)rightKeyCode).NoAlt);
}

[Theory]
[InlineData (KeyCode.CtrlKey, KeyCode.CtrlMask, true)]
[InlineData (KeyCode.CtrlKey | KeyCode.A, KeyCode.CtrlMask | KeyCode.A, true)]
public void IsCtrl_With_Wrong_And_Right_CtrlMask_NoCtrl (KeyCode wrongKeyCode, KeyCode rightKeyCode, bool isCtrl)
{
Assert.NotEqual (((Key)wrongKeyCode).IsCtrl, isCtrl);
Assert.NotEqual ((Key)(wrongKeyCode & ~KeyCode.CtrlKey), ((Key)wrongKeyCode).NoCtrl);
Assert.Equal (((Key)rightKeyCode).IsCtrl, isCtrl);
Assert.Equal ((Key)(rightKeyCode & ~KeyCode.CtrlMask), ((Key)rightKeyCode).NoCtrl);
}

[Theory]
[InlineData (KeyCode.ShiftMask, true, false, false)]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask, true, true, false)]
[InlineData (KeyCode.ShiftMask | KeyCode.AltMask | KeyCode.CtrlMask, true, true, true)]
[InlineData (KeyCode.ShiftMask | KeyCode.CtrlMask, true, false, true)]
[InlineData (KeyCode.AltMask, false, true, false)]
[InlineData (KeyCode.AltMask | KeyCode.CtrlMask, false, true, true)]
[InlineData (KeyCode.CtrlMask, false, false, true)]
public void IsShift_IsAlt_IsCtrl (KeyCode keyCode, bool isShift, bool isAlt, bool isCtrl)
{
Assert.Equal (((Key)keyCode).IsShift, isShift);
Assert.Equal (((Key)keyCode).IsAlt, isAlt);
Assert.Equal (((Key)keyCode).IsCtrl, isCtrl);
}
}