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
|
/*
* Copyright © Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 or 3 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "src/server/shell/basic_sticky_keys_transformer.h"
#include "src/server/input/default_event_builder.h"
#include <mir/test/doubles/advanceable_clock.h>
#include <mir/events/event.h>
#include <linux/input-event-codes.h>
#include <gtest/gtest.h>
#include <gmock/gmock.h>
using namespace testing;
namespace msh = mir::shell;
namespace mi = mir::input;
namespace mt = mir::time;
namespace miev = mir::events;
namespace mtd = mir::test::doubles;
namespace
{
class MockDispatcher
{
public:
MOCK_METHOD((void), dispatcher, (std::shared_ptr<MirEvent> const&), (const));
};
}
class TestStickyKeysTransformer : public Test
{
public:
TestStickyKeysTransformer()
: event_builder(0, clock),
dispatch([&](std::shared_ptr<MirEvent> const& event) { dispatcher->dispatcher(event); })
{
}
msh::BasicStickyKeysTransformer transformer = msh::BasicStickyKeysTransformer();
std::shared_ptr<mt::Clock> clock = std::make_shared<mtd::AdvanceableClock>();
mi::DefaultEventBuilder event_builder;
std::shared_ptr<MockDispatcher> dispatcher = std::make_shared<MockDispatcher>();
std::function<void(std::shared_ptr<MirEvent> const& event)> dispatch;
};
TEST_F(TestStickyKeysTransformer, non_modifier_events_are_passed_through_when_no_modifiers_are_previously_clicked)
{
auto const event = event_builder.key_event(std::nullopt, mir_keyboard_action_down, XKB_KEY_0, KEY_0);
EXPECT_THAT(transformer.transform_input_event(dispatch, &event_builder, *event.get()), Eq(false));
}
using KeyParam = std::pair<xkb_keysym_t, int32_t>;
class TestStickyKeysTransformerWithModifiers : public TestStickyKeysTransformer, public WithParamInterface<KeyParam>
{};
TEST_P(TestStickyKeysTransformerWithModifiers, modifier_keyboard_up_events_are_consumed)
{
auto const [keysym, scan_code] = GetParam();
auto const down_event = event_builder.key_event(std::nullopt, mir_keyboard_action_down, keysym, scan_code);
EXPECT_THAT(transformer.transform_input_event(dispatch, &event_builder, *down_event.get()), Eq(false));
auto const up_event = event_builder.key_event(std::nullopt, mir_keyboard_action_up, keysym, scan_code);
EXPECT_THAT(transformer.transform_input_event(dispatch, &event_builder, *up_event.get()), Eq(true));
}
TEST_P(TestStickyKeysTransformerWithModifiers, callback_triggered_on_modifier_key_up)
{
int count = 0;
transformer.on_modifier_clicked([&](auto const& key)
{
EXPECT_THAT(key, Eq(GetParam().second));
count++;
});
auto const [keysym, scan_code] = GetParam();
auto const down_event = event_builder.key_event(std::nullopt, mir_keyboard_action_down, keysym, scan_code);
transformer.transform_input_event(dispatch, &event_builder, *down_event.get());
auto const up_event = event_builder.key_event(std::nullopt, mir_keyboard_action_up, keysym, scan_code);
transformer.transform_input_event(dispatch, &event_builder, *up_event.get());
EXPECT_THAT(count, Eq(1));
}
TEST_P(TestStickyKeysTransformerWithModifiers, up_events_are_dispatched_following_non_modifier_key_up)
{
EXPECT_CALL(*dispatcher, dispatcher(_)).Times(2); // Once for the redispatch of the key event, once for the modifier up
// Setup: "Click" the modifier key
auto const [keysym, scan_code] = GetParam();
auto const down_event = event_builder.key_event(std::nullopt, mir_keyboard_action_down, keysym, scan_code);
transformer.transform_input_event(dispatch, &event_builder, *down_event.get());
auto const up_event = event_builder.key_event(std::nullopt, mir_keyboard_action_up, keysym, scan_code);
transformer.transform_input_event(dispatch, &event_builder, *up_event.get());
// Action: "Click" a non-modifier key
auto const non_modifier_down_event = event_builder.key_event(std::nullopt, mir_keyboard_action_down, XKB_KEY_0, KEY_0);
transformer.transform_input_event(dispatch, &event_builder, *non_modifier_down_event.get());
auto const non_modifier_up_event = event_builder.key_event(std::nullopt, mir_keyboard_action_up, XKB_KEY_0, KEY_0);
transformer.transform_input_event(dispatch, &event_builder, *non_modifier_up_event.get());
}
TEST_P(TestStickyKeysTransformerWithModifiers, up_events_are_dispatched_following_pointer_button_up_event)
{
EXPECT_CALL(*dispatcher, dispatcher(_)).Times(2); // Once for the redispatch of the mouse up event, once for the modifier up
// Setup: "Click" the modifier key
auto const [keysym, scan_code] = GetParam();
auto const down_event = event_builder.key_event(std::nullopt, mir_keyboard_action_down, keysym, scan_code);
transformer.transform_input_event(dispatch, &event_builder, *down_event.get());
auto const up_event = event_builder.key_event(std::nullopt, mir_keyboard_action_up, keysym, scan_code);
transformer.transform_input_event(dispatch, &event_builder, *up_event.get());
// Action: "Click" a mouse button
auto const mouse_down_event = event_builder.pointer_event(
std::nullopt, mir_pointer_action_button_down, mir_pointer_button_primary, 0, 0, 0, 0);
transformer.transform_input_event(dispatch, &event_builder, *mouse_down_event.get());
auto const mouse_up_event = event_builder.pointer_event(
std::nullopt, mir_pointer_action_button_up, mir_pointer_button_primary, 0, 0, 0, 0);
transformer.transform_input_event(dispatch, &event_builder, *mouse_up_event.get());
}
TEST_P(TestStickyKeysTransformerWithModifiers, up_events_are_dispatched_following_touch_up_event)
{
EXPECT_CALL(*dispatcher, dispatcher(_)).Times(2); // Once for the redispatch of the touch up event, once for the modifier up
// Setup: "Click" the modifier key
auto const [keysym, scan_code] = GetParam();
auto const down_event = event_builder.key_event(std::nullopt, mir_keyboard_action_down, keysym, scan_code);
transformer.transform_input_event(dispatch, &event_builder, *down_event.get());
auto const up_event = event_builder.key_event(std::nullopt, mir_keyboard_action_up, keysym, scan_code);
transformer.transform_input_event(dispatch, &event_builder, *up_event.get());
// Action: "Tap" on the screen
miev::TouchContactV2 contact_down;
contact_down.action = mir_touch_action_down;
auto const touch_down_event = event_builder.touch_event(std::nullopt, { contact_down });
transformer.transform_input_event(dispatch, &event_builder, *touch_down_event.get());
miev::TouchContactV2 contact_up;
contact_up.action = mir_touch_action_up;
auto const touch_up_event = event_builder.touch_event(std::nullopt, { contact_up });
transformer.transform_input_event(dispatch, &event_builder, *touch_up_event.get());
}
INSTANTIATE_TEST_SUITE_P(
TestStickyKeysTransformerWithModifiers,
TestStickyKeysTransformerWithModifiers,
Values(
KeyParam{XKB_KEY_Shift_R, KEY_RIGHTSHIFT},
KeyParam{XKB_KEY_Shift_L, KEY_LEFTSHIFT},
KeyParam{XKB_KEY_Alt_R, KEY_RIGHTALT},
KeyParam{XKB_KEY_Alt_L, KEY_LEFTALT},
KeyParam{XKB_KEY_Control_R, KEY_RIGHTCTRL},
KeyParam{XKB_KEY_Control_L, KEY_LEFTCTRL},
KeyParam{XKB_KEY_Meta_R, KEY_RIGHTMETA},
KeyParam{XKB_KEY_Meta_L, KEY_LEFTMETA},
KeyParam{XKB_KEY_Caps_Lock, KEY_CAPSLOCK},
KeyParam{XKB_KEY_Scroll_Lock, KEY_SCREENLOCK},
KeyParam{XKB_KEY_Num_Lock, KEY_NUMLOCK}
)
);
TEST_F(TestStickyKeysTransformer, holding_two_modifiers_simultaneously_disables_sticky_keys_transformer)
{
transformer.should_disable_if_two_keys_are_pressed_together(true);
auto const first_down_event = event_builder.key_event(std::nullopt, mir_keyboard_action_down, KEY_RIGHTSHIFT, KEY_RIGHTSHIFT);
EXPECT_THAT(transformer.transform_input_event(dispatch, &event_builder, *first_down_event.get()), Eq(false));
auto const second_down_event = event_builder.key_event(std::nullopt, mir_keyboard_action_down, KEY_RIGHTALT, KEY_RIGHTALT);
EXPECT_THAT(transformer.transform_input_event(dispatch, &event_builder, *second_down_event.get()), Eq(false));
auto const up_event = event_builder.key_event(std::nullopt, mir_keyboard_action_up, KEY_RIGHTSHIFT, KEY_RIGHTSHIFT);
EXPECT_THAT(transformer.transform_input_event(dispatch, &event_builder, *up_event.get()), Eq(false));
}
TEST_F(TestStickyKeysTransformer, holding_two_modifiers_simultaneously_does_not_disable_transformer_when_options_is_false)
{
transformer.should_disable_if_two_keys_are_pressed_together(false);
auto const first_down_event = event_builder.key_event(std::nullopt, mir_keyboard_action_down, KEY_RIGHTSHIFT, KEY_RIGHTSHIFT);
EXPECT_THAT(transformer.transform_input_event(dispatch, &event_builder, *first_down_event.get()), Eq(false));
auto const second_down_event = event_builder.key_event(std::nullopt, mir_keyboard_action_down, KEY_RIGHTALT, KEY_RIGHTALT);
EXPECT_THAT(transformer.transform_input_event(dispatch, &event_builder, *second_down_event.get()), Eq(false));
auto const up_event = event_builder.key_event(std::nullopt, mir_keyboard_action_up, KEY_RIGHTSHIFT, KEY_RIGHTSHIFT);
EXPECT_THAT(transformer.transform_input_event(dispatch, &event_builder, *up_event.get()), Eq(true));
}
TEST_F(TestStickyKeysTransformer, non_input_events_are_ignored)
{
class StubEvent : public MirEvent
{
public:
explicit StubEvent(MirEventType type) : MirEvent(type) {}
auto clone() const -> MirEvent* override { return nullptr; }
};
StubEvent event(mir_event_type_close_window);
EXPECT_THAT(transformer.transform_input_event(dispatch, &event_builder, event), Eq(false));
}
|
