Skip to content

Moving common logic of keyboard's simulation into the helper class. #7537

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

Merged
merged 1 commit into from
Aug 11, 2022
Merged

Moving common logic of keyboard's simulation into the helper class. #7537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 34 additions & 0 deletions src/System.Windows.Forms/tests/TestUtilities/KeyboardSimulator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using static Interop;
using System.Windows.Forms;

namespace System
{
public static class KeyboardSimulator
{
public static void KeyDown(Control control, Keys key)
{
(nint keyCode, nint lParam) = GetKeyParameters(key);
User32.SendMessageW(control, User32.WM.KEYDOWN, keyCode, lParam);
}

public static void KeyPress(Control control, Keys key)
{
(nint keyCode, nint lParam) = GetKeyParameters(key);
User32.SendMessageW(control, User32.WM.KEYDOWN, keyCode, lParam);
User32.SendMessageW(control, User32.WM.KEYUP, keyCode, lParam);
}

private static (nint keyCode, nint lParam) GetKeyParameters(Keys key)
{
var keyCode = (nint)key;
var scanCode = (int)key;
const int repeatCount = 1;
nint lParam = PARAM.FromLowHighUnsigned(repeatCount, scanCode);
return (keyCode , lParam);
}
}
}
8 changes: 1 addition & 7 deletions src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/ComboBoxTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2282,15 +2282,9 @@ public void ComboBox_Select_Item_By_Key(Keys key, int expectedKeyPressesCount, i
comboBox.SelectedIndex = selectedIndex;
comboBox.ResetEventsCount();

// https://docs.microsoft.com/windows/win32/inputdev/wm-keyup
// The MSDN page tells us what bits of lParam to use for each of the parameters.
// All we need to do is some bit shifting to assemble lParam.
nint keyCode = (nint)key;
nint lParam = 0x00000001 | keyCode << 16;
for (int i = 0; i < expectedKeyPressesCount; i++)
{
User32.SendMessageW(comboBox, User32.WM.KEYDOWN, keyCode, lParam);
User32.SendMessageW(comboBox, User32.WM.KEYUP, keyCode, lParam);
KeyboardSimulator.KeyPress(comboBox, key);
}

Assert.Equal(expectedKeyPressesCount, comboBox.EventsCount);
Expand Down
48 changes: 8 additions & 40 deletions .../tests/UnitTests/System/Windows/Forms/ListViewGroup.ListViewGroupAccessibleObjectTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -759,44 +759,24 @@ public void ListViewGroupAccessibleObject_ExpandCollapseStateFromKeyboard_Return
Assert.True(listView.IsHandleCreated);
Assert.NotEqual(IntPtr.Zero, listView.Handle);

// https://docs.microsoft.com/windows/win32/inputdev/wm-keyup
// The MSDN page tells us what bits of lParam to use for each of the parameters.
// All we need to do is some bit shifting to assemble lParam
// lParam = repeatCount | (scanCode << 16)
nint keyCode = (nint)Keys.Up;
nint lParam = 0x00000001 | keyCode << 16;
User32.SendMessageW(listView, User32.WM.KEYDOWN, keyCode, lParam);
User32.SendMessageW(listView, User32.WM.KEYUP, keyCode, lParam);

keyCode = (nint)Keys.Left;
lParam = 0x00000001 | keyCode << 16;
User32.SendMessageW(listView, User32.WM.KEYDOWN, keyCode, lParam);
User32.SendMessageW(listView, User32.WM.KEYUP, keyCode, lParam);
KeyboardSimulator.KeyPress(listView, Keys.Up);
KeyboardSimulator.KeyPress(listView, Keys.Left);

Assert.Equal(ListViewGroupCollapsedState.Collapsed, listViewGroup.GetNativeCollapsedState());
Assert.Equal(ExpandCollapseState.Collapsed, listViewGroup.AccessibilityObject.ExpandCollapseState);

keyCode = (nint)Keys.Left;
lParam = 0x00000001 | keyCode << 16;
User32.SendMessageW(listView, User32.WM.KEYDOWN, keyCode, lParam);
User32.SendMessageW(listView, User32.WM.KEYUP, keyCode, lParam);
KeyboardSimulator.KeyPress(listView, Keys.Left);

// The second left key pressing should not change Collapsed state
Assert.Equal(ListViewGroupCollapsedState.Collapsed, listViewGroup.GetNativeCollapsedState());
Assert.Equal(ExpandCollapseState.Collapsed, listViewGroup.AccessibilityObject.ExpandCollapseState);

keyCode = (nint)Keys.Right;
lParam = 0x00000001 | keyCode << 16;
User32.SendMessageW(listView, User32.WM.KEYDOWN, keyCode, lParam);
User32.SendMessageW(listView, User32.WM.KEYUP, keyCode, lParam);
KeyboardSimulator.KeyPress(listView, Keys.Right);

Assert.Equal(ListViewGroupCollapsedState.Expanded, listViewGroup.GetNativeCollapsedState());
Assert.Equal(ExpandCollapseState.Expanded, listViewGroup.AccessibilityObject.ExpandCollapseState);

keyCode = (nint)Keys.Right;
lParam = 0x00000001 | keyCode << 16;
User32.SendMessageW(listView, User32.WM.KEYDOWN, keyCode, lParam);
User32.SendMessageW(listView, User32.WM.KEYUP, keyCode, lParam);
KeyboardSimulator.KeyPress(listView, Keys.Right);

// The second right key pressing should not change Expanded state
Assert.Equal(ListViewGroupCollapsedState.Expanded, listViewGroup.GetNativeCollapsedState());
Expand Down Expand Up @@ -829,12 +809,12 @@ public void ListViewGroupAccessibleObject_GroupCollapsedStateChanged_IsExpected_
listView.GroupCollapsedStateChanged += (_, e) => eventGroupIndices.Add(e.GroupIndex);

// Navigate to the second group
SimulateKeyPress(Keys.Down);
KeyboardSimulator.KeyPress(listView, Keys.Down);

if (firstGroupSate == ListViewGroupCollapsedState.Collapsed)
{
// This action is necessary to navigate to the second group correctly in this specific case.
SimulateKeyPress(Keys.Up);
KeyboardSimulator.KeyPress(listView, Keys.Up);
}

// Simulate multiple selection of several groups to test a specific case,
Expand All @@ -844,7 +824,7 @@ public void ListViewGroupAccessibleObject_GroupCollapsedStateChanged_IsExpected_
item3.Selected = true;

// Simulate the second group collapse action via keyboard.
SimulateKeyPress(Keys.Left);
KeyboardSimulator.KeyPress(listView, Keys.Left);

Assert.Equal(firstGroupSate, group1.GetNativeCollapsedState());
Assert.Equal(firstGroupSate, group1.CollapsedState);
Expand All @@ -862,18 +842,6 @@ public void ListViewGroupAccessibleObject_GroupCollapsedStateChanged_IsExpected_
// are still selected after keyboard navigation simulations.
Assert.Equal(3, listView.SelectedItems.Count);
Assert.True(listView.IsHandleCreated);

void SimulateKeyPress(Keys key)
{
// https://docs.microsoft.com/windows/win32/inputdev/wm-keyup
// The MSDN page tells us what bits of lParam to use for each of the parameters.
// All we need to do is some bit shifting to assemble lParam
// lParam = repeatCount | (scanCode << 16)
nint keyCode = (nint)key;
nint lParam = 0x00000001 | keyCode << 16;
User32.SendMessageW(listView, User32.WM.KEYDOWN, keyCode, lParam);
User32.SendMessageW(listView, User32.WM.KEYUP, keyCode, lParam);
}
}

[WinFormsTheory]
Expand Down
44 changes: 6 additions & 38 deletions src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/ListViewTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4486,14 +4486,8 @@ public unsafe void ListView_WmReflectNotify_LVN_KEYDOWN_SpaceKey_HasCheckBoxes_W
item1.Selected = selectItems;
item2.Selected = selectItems;

// https://docs.microsoft.com/windows/win32/inputdev/wm-keydown
// The MSDN page tells us what bits of lParam to use for each of the parameters.
// All we need to do is some bit shifting to assemble lParam
// lParam = repeatCount | (scanCode << 16)
uint keyCode = (uint)Keys.Space;
uint lParam = (0x00000001 | keyCode << 16);
KeyboardSimulator.KeyDown(control, Keys.Space);

User32.SendMessageW(control, User32.WM.KEYDOWN, (nint)keyCode, (nint)lParam);
Assert.Equal(selectItems ? 2 : 0, control.SelectedItems.Count);
Assert.Equal(!checkItem && selectItems && focusItem, item2.Checked);
}
Expand All @@ -4517,15 +4511,8 @@ public unsafe void ListView_WmReflectNotify_LVN_KEYDOWN_WithGroups_WithoutSelect
control.Groups.Add(group);
control.CreateControl();

// https://docs.microsoft.com/windows/win32/inputdev/wm-keydown
// The MSDN page tells us what bits of lParam to use for each of the parameters.
// All we need to do is some bit shifting to assemble lParam
// lParam = repeatCount | (scanCode << 16)
uint keyCode = (uint)key;
uint lParam = (0x00000001 | keyCode << 16);
KeyboardSimulator.KeyDown(control, key);

// If control doesn't have selected items none will be focused.
User32.SendMessageW(control, User32.WM.KEYDOWN, (nint)keyCode, (nint)lParam);
Assert.Empty(control.SelectedIndices);
Assert.Null(control.FocusedItem);
Assert.Null(control.FocusedGroup);
Expand Down Expand Up @@ -4562,14 +4549,9 @@ public unsafe void ListView_WmReflectNotify_LVN_KEYDOWN_WithGroups_and_SelectedI

item2.Selected = true;

// https://docs.microsoft.com/windows/win32/inputdev/wm-keydown
// The MSDN page tells us what bits of lParam to use for each of the parameters.
// All we need to do is some bit shifting to assemble lParam
// lParam = repeatCount | (scanCode << 16)
uint keyCode = (uint)(key_s == "Keys.Down" ? Keys.Down : Keys.Up);
uint lParam = (0x00000001 | keyCode << 16);
var key = key_s == "Keys.Down" ? Keys.Down : Keys.Up;
KeyboardSimulator.KeyDown(control, key);

User32.SendMessageW(control, User32.WM.KEYDOWN, (nint)keyCode, (nint)lParam);
Assert.False(control.GroupsEnabled);
Assert.True(control.Items.Count > 0);
int expectedGroupIndex = int.Parse(expectedGroupIndex_s);
Expand Down Expand Up @@ -4606,15 +4588,8 @@ public unsafe void ListView_VirtualMode_WmReflectNotify_LVN_KEYDOWN_WithGroups_D

control.CreateControl();

// https://docs.microsoft.com/windows/win32/inputdev/wm-keydown
// The MSDN page tells us what bits of lParam to use for each of the parameters.
// All we need to do is some bit shifting to assemble lParam
// lParam = repeatCount | (scanCode << 16)
uint keyCode = (uint)key;
uint lParam = (0x00000001 | keyCode << 16);
KeyboardSimulator.KeyDown(control, key);

// Actually ListView in VirtualMode can't have Groups
User32.SendMessageW(control, User32.WM.KEYDOWN, (nint)keyCode, (nint)lParam);
Assert.Null(control.FocusedGroup);
}

Expand Down Expand Up @@ -4648,15 +4623,8 @@ public unsafe void ListView_VirtualMode_WmReflectNotify_LVN_KEYDOWN_EnabledCheck
item2.Checked = false;
control.FocusedItem = item1;

// https://docs.microsoft.com/windows/win32/inputdev/wm-keydown
// The MSDN page tells us what bits of lParam to use for each of the parameters.
// All we need to do is some bit shifting to assemble lParam
// lParam = repeatCount | (scanCode << 16)
uint keyCode = (uint)Keys.Space;
uint lParam = (0x00000001 | keyCode << 16);
KeyboardSimulator.KeyDown(control, Keys.Space);

// Actually ListView in VirtualMode doesn't check items here
User32.SendMessageW(control, User32.WM.KEYDOWN, (nint)keyCode, (nint)lParam);
Assert.False(item2.Checked);
}

Expand Down