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
|
/*
* 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 <mir/input/composite_event_filter.h>
#include <mir/input/device.h>
#include <mir/input/event_builder.h>
#include <mir/input/input_device_hub.h>
#include <mir/input/input_device_observer.h>
#include <mir/input/input_device_registry.h>
#include <mir/input/input_sink.h>
#include <mir/input/virtual_input_device.h>
#include <mir/server.h>
#include <mir/test/signal.h>
#include <miral/append_event_filter.h>
#include <miral/locate_pointer.h>
#include <miral/test_server.h>
#include <gmock/gmock.h>
using namespace ::testing;
using namespace std::chrono_literals;
namespace
{
static constexpr auto locate_pointer_delay = 100ms;
// Mostly to account for CI slowness.
// Adds a test pointer and waits till it's added before proceeding
std::shared_ptr<mir::input::VirtualInputDevice> add_test_pointer(
std::weak_ptr<mir::input::InputDeviceRegistry> const& input_device_registry,
std::weak_ptr<mir::input::InputDeviceHub> const& input_device_hub)
{
std::shared_ptr<mir::input::VirtualInputDevice> test_device =
std::make_shared<mir::input::VirtualInputDevice>("test-device", mir::input::DeviceCapability::pointer);
struct SignalingObserver : public mir::input::InputDeviceObserver
{
using Device = mir::input::Device;
std::shared_ptr<Device> const device_to_wait_for;
std::weak_ptr<mir::input::InputDeviceHub> const device_hub;
mir::test::Signal device_added_;
SignalingObserver(std::shared_ptr<Device> const& to_wait_for) :
device_to_wait_for{to_wait_for}
{
}
virtual void device_added(std::shared_ptr<Device> const& device) override
{
if (device->unique_id() == device_to_wait_for->unique_id())
device_added_.raise();
}
virtual void device_changed(std::shared_ptr<Device> const&)
{
}
virtual void device_removed(std::shared_ptr<Device> const&)
{
}
virtual void changes_complete()
{
}
void wait()
{
device_added_.wait();
}
};
auto input_device_observer =
std::make_shared<SignalingObserver>(input_device_registry.lock()->add_device(test_device).lock());
input_device_hub.lock()->add_observer(input_device_observer);
input_device_observer->wait();
input_device_observer.reset();
return test_device;
}
}
struct TestLocatePointer : miral::TestServer
{
TestLocatePointer()
{
add_server_init(
[this](mir::Server& server)
{
server.add_init_callback(
[&server, this]
{
composite_event_filter = server.the_composite_event_filter();
input_device_registry = server.the_input_device_registry();
input_device_hub = server.the_input_device_hub();
});
});
add_server_init(locate_pointer);
locate_pointer
.delay(locate_pointer_delay)
.on_locate_pointer([this](auto...) { locate_pointer_invoked.raise(); });
}
void SetUp() override
{
miral::TestServer::SetUp();
}
miral::LocatePointer locate_pointer{miral::LocatePointer::enabled()};
std::shared_ptr<mir::input::VirtualInputDevice> test_device = std::make_shared<mir::input::VirtualInputDevice>(
"test-device", mir::input::DeviceCapability::keyboard | mir::input::DeviceCapability::pointer);
mir::test::Signal locate_pointer_invoked;
std::weak_ptr<mir::input::CompositeEventFilter> composite_event_filter;
std::weak_ptr<mir::input::InputDeviceRegistry> input_device_registry;
std::weak_ptr<mir::input::InputDeviceHub> input_device_hub;
};
struct TestDifferentLocatePointerDelays : public TestLocatePointer, public WithParamInterface<std::pair<std::chrono::milliseconds, bool>>{};
TEST_P(TestDifferentLocatePointerDelays, responding_to_schedule_and_request_with_different_delays)
{
auto [delay, on_pointer_locate_called] = GetParam();
locate_pointer.schedule_request();
locate_pointer_invoked.wait_for(delay);
locate_pointer.cancel_request();
EXPECT_THAT(locate_pointer_invoked.raised(), Eq(on_pointer_locate_called));
}
INSTANTIATE_TEST_SUITE_P(
TestLocatePointer,
TestDifferentLocatePointerDelays,
::Values(std::pair{locate_pointer_delay + 10ms, true}, std::pair{locate_pointer_delay - 10ms, false}));
struct TestPointerMovementTracking :
public TestLocatePointer,
public WithParamInterface<std::optional<mir::geometry::PointF>>
{
};
TEST_P(TestPointerMovementTracking, cursor_location_is_tracked_on_movement)
{
auto const final_pointer_position = GetParam();
std::optional<mir::geometry::PointF> locate_pointer_position;
locate_pointer.on_locate_pointer(
[this, &locate_pointer_position](auto pointer_position)
{
locate_pointer_position = pointer_position;
locate_pointer_invoked.raise();
});
auto test_device = add_test_pointer(input_device_registry, input_device_hub);
test_device->if_started_then(
[this, final_pointer_position](auto* sink, auto* builder)
{
sink->handle_input(builder->pointer_event(
std::nullopt,
mir_pointer_action_motion,
MirPointerButtons{0},
final_pointer_position,
mir::geometry::DisplacementF{0.0f, 0.0f},
mir_pointer_axis_source_none,
{},
{}));
locate_pointer.schedule_request();
});
locate_pointer_invoked.wait_for(locate_pointer_delay + 10ms);
auto const expected_position = final_pointer_position.value_or(mir::geometry::PointF{0, 0});
EXPECT_THAT(locate_pointer_position, Optional(expected_position));
}
INSTANTIATE_TEST_SUITE_P(
TestLocatePointer, TestPointerMovementTracking, ::Values(std::nullopt, mir::geometry::PointF{100.0f, 100.0f}));
|
