Merge lp:~mir-team/mir/fix-1528109 into lp:mir

[Daniel van Vugt]

Fix unresponsive cursor to slow mouse movement (LP: #1528109)

Since we started using libinput and its acceleration curve, that actually
reduces the amount of motion we receive for slow mouse movements. A device
increment of 1 actually results in us receiving a dx or dy from libinput
of less than 1.0. So this fix ensures that such small movements no longer
get truncated to zero.

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:3468
https://mir-jenkins.ubuntu.com/job/mir-ci/846/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/857/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/894
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/885
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/885
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/867/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/867
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/867/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/867/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/867/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/867
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/867/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/846/rebuild

review: Needs Fixing (continuous-integration)

[Alan Griffiths (alan-griffiths)]

+ auto confined{old};

See https://herbsutter.com/2013/06/05/gotw-92-auto-variables-part-1/

(part 4 applies)

review: Needs Fixing

[Mir CI Bot (mir-ci-bot)]

PASSED: Continuous integration, rev:3469
https://mir-jenkins.ubuntu.com/job/mir-ci/848/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/862
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/899
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/890
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/890
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/872
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/872/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/872
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/872/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/872
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/872/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/872
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/872/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/872
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/872/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/848/rebuild

review: Approve (continuous-integration)

[Alan Griffiths (alan-griffiths)]

> + auto confined{old};
>
> See https://herbsutter.com/2013/06/05/gotw-92-auto-variables-part-1/
>
> (part 4 applies)

Fixed

review: Approve

[Andreas Pokorny (andreas-pokorny)]

yes .. lgtm

review: Approve

=== modified file 'include/test/mir/test/event_matchers.h'
--- include/test/mir/test/event_matchers.h	2016-03-23 06:39:56 +0000
+++ include/test/mir/test/event_matchers.h	2016-04-15 15:11:30 +0000
@@ -383,16 +383,21 @@
     return false;
 }
 
-MATCHER_P2(PointerEventWithDiff, dx, dy, "")
+MATCHER_P2(PointerEventWithDiff, expect_dx, expect_dy, "")
 {
     auto pev = maybe_pointer_event(to_address(arg));
     if (pev == nullptr)
         return false;
     if (mir_pointer_event_action(pev) != mir_pointer_action_motion)
         return false;
-    if (mir_pointer_event_axis_value(pev, mir_pointer_axis_relative_x) != dx)
+    auto const error = 0.00001f;
+    auto const actual_dx = mir_pointer_event_axis_value(pev,
+                                                mir_pointer_axis_relative_x);
+    if (std::abs(expect_dx - actual_dx) > error)
         return false;
-    if (mir_pointer_event_axis_value(pev, mir_pointer_axis_relative_y) != dy)
+    auto const actual_dy = mir_pointer_event_axis_value(pev,
+                                                mir_pointer_axis_relative_y);
+    if (std::abs(expect_dy - actual_dy) > error)
         return false;
     return true;
 }

=== modified file 'src/platforms/evdev/libinput_device.cpp'
--- src/platforms/evdev/libinput_device.cpp	2016-03-23 06:39:56 +0000
+++ src/platforms/evdev/libinput_device.cpp	2016-04-15 15:11:30 +0000
@@ -171,11 +171,10 @@
 
     report->received_event_from_kernel(time.count(), EV_REL, 0, 0);
 
-    mir::geometry::Displacement const movement{libinput_event_pointer_get_dx(pointer),
-                                               libinput_event_pointer_get_dy(pointer)};
-
-    return builder->pointer_event(time, action, button_state, hscroll_value, vscroll_value, movement.dx.as_float(),
-                                  movement.dy.as_float());
+    return builder->pointer_event(time, action, button_state,
+                                  hscroll_value, vscroll_value,
+                                  libinput_event_pointer_get_dx(pointer),
+                                  libinput_event_pointer_get_dy(pointer));
 }
 
 mir::EventUPtr mie::LibInputDevice::convert_absolute_motion_event(libinput_event_pointer* pointer)

=== modified file 'src/server/input/seat_input_device_tracker.cpp'
--- src/server/input/seat_input_device_tracker.cpp	2016-03-23 06:39:56 +0000
+++ src/server/input/seat_input_device_tracker.cpp	2016-04-15 15:11:30 +0000
@@ -200,7 +200,7 @@
 
 mir::geometry::Point mi::SeatInputDeviceTracker::cursor_position() const
 {
-    return cursor_pos;
+    return {cursor_x, cursor_y};
 }
 
 MirPointerButtons mi::SeatInputDeviceTracker::button_state() const
@@ -210,12 +210,14 @@
 
 void mi::SeatInputDeviceTracker::update_cursor(MirPointerEvent const* event)
 {
-    mir::geometry::Displacement movement{
-        mir_pointer_event_axis_value(event, mir_pointer_axis_relative_x),
-        mir_pointer_event_axis_value(event, mir_pointer_axis_relative_y),
-    };
-    cursor_pos = cursor_pos + movement;
-    input_region->confine(cursor_pos);
-
-    cursor_listener->cursor_moved_to(cursor_pos.x.as_float(), cursor_pos.y.as_float());
+    cursor_x += mir_pointer_event_axis_value(event, mir_pointer_axis_relative_x);
+    cursor_y += mir_pointer_event_axis_value(event, mir_pointer_axis_relative_y);
+
+    mir::geometry::Point const old{cursor_x, cursor_y};
+    auto confined = old;
+    input_region->confine(confined);
+    if (confined.x != old.x) cursor_x = confined.x.as_int();
+    if (confined.y != old.y) cursor_y = confined.y.as_int();
+
+    cursor_listener->cursor_moved_to(cursor_x, cursor_y);
 }

=== modified file 'src/server/input/seat_input_device_tracker.h'
--- src/server/input/seat_input_device_tracker.h	2016-03-23 06:39:56 +0000
+++ src/server/input/seat_input_device_tracker.h	2016-04-15 15:11:30 +0000
@@ -80,7 +80,10 @@
         std::vector<TouchVisualizer::Spot> spots;
     };
 
-    mir::geometry::Point cursor_pos;
+    // Libinput's acceleration curve means the cursor moves by non-integer
+    // increments, and often less than 1.0, so float is required...
+    float cursor_x = 0.0f, cursor_y = 0.0f;
+
     MirInputEventModifiers modifier;
     MirPointerButtons buttons;
     std::unordered_map<MirInputDeviceId, DeviceData> device_data;

=== modified file 'tests/unit-tests/input/evdev/test_libinput_device.cpp'
--- tests/unit-tests/input/evdev/test_libinput_device.cpp	2016-03-23 06:39:56 +0000
+++ tests/unit-tests/input/evdev/test_libinput_device.cpp	2016-04-15 15:11:30 +0000
@@ -407,6 +407,20 @@
     process_events(mouse);
 }
 
+TEST_F(LibInputDeviceOnMouse, notices_slow_relative_movements)
+{   // Regression test for LP: #1528109
+    float x1 = 0.5f, x2 = 0.6f;
+    float y1 = 1.7f, y2 = 1.8f;
+
+    EXPECT_CALL(mock_sink, handle_input(mt::PointerEventWithDiff(x1,y1)));
+    EXPECT_CALL(mock_sink, handle_input(mt::PointerEventWithDiff(x2,y2)));
+
+    mouse.start(&mock_sink, &mock_builder);
+    env.mock_libinput.setup_pointer_event(fake_device, event_time_1, x1, y1);
+    env.mock_libinput.setup_pointer_event(fake_device, event_time_2, x2, y2);
+    process_events(mouse);
+}
+
 TEST_F(LibInputDeviceOnMouse, process_event_handles_press_and_release)
 {
     float const x = 0;

=== modified file 'tests/unit-tests/input/test_seat_input_device_tracker.cpp'
--- tests/unit-tests/input/test_seat_input_device_tracker.cpp	2016-02-05 10:19:39 +0000
+++ tests/unit-tests/input/test_seat_input_device_tracker.cpp	2016-04-15 15:11:30 +0000
@@ -149,6 +149,23 @@
                                                         move_x, move_y));
 }
 
+TEST_F(SeatInputDeviceTracker, slow_pointer_movement_updates_cursor)
+{   // Regression test for LP: #1528109
+    float const step = 0.25f;
+    float const target = 3.0f;
+
+    for (float x = step; x <= target; x += step)
+        EXPECT_CALL(mock_cursor_listener,
+                    cursor_moved_to(FloatEq(x), FloatEq(x))).Times(1);
+
+    tracker.add_device(some_device);
+
+    for (float x = step; x <= target; x += step)
+        tracker.dispatch(*some_device_builder.pointer_event(
+            arbitrary_timestamp, mir_pointer_action_motion, 0, 0.0f, 0.0f,
+            step, step));
+}
+
 TEST_F(SeatInputDeviceTracker, key_strokes_of_modifier_key_update_modifier)
 {
     const MirInputEventModifiers shift_left = mir_input_event_modifier_shift_left | mir_input_event_modifier_shift;