Merge lp:~raof/mir/cursoring into lp:mir

[Chris Halse Rogers]

Add suspend()/resume() to Mesa::Cursor, replacing .show_at_last_position().

This is conceptually what show_at_last_position() was trying to do, and
with an explicit suspend/resume interface we can save whether or not the
cursor was hidden across VT switches.

Fixes: LP: #1323225

Make the cursor retain its shown/hidden state over VT switches

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1656
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/1728/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-utopic-i386-build/324
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-utopic-amd64-build/325
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-utopic-touch/324
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/247
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/247/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-ci/246
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-ci/246/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/907
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/907/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/1568
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/7729

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/1728/rebuild

review: Approve (continuous-integration)

[Brandon Schaefer (brandontschaefer)]

Confirmed fixes the issue.

review: Approve

[Alexandros Frantzis (afrantzis)]

108 +TEST_F(MesaCursorTest, cursor_is_shown_at_correct_locaiton_after_suspend_resume)

typo 'location'

18 +void mir::graphics::mesa::Cursor::suspend()
19 +{
20 + output_container.for_each_output(
21 + [&](KMSOutput& output) { output.clear_cursor(); });
22 +}

Lock needed (although with the current code I don't think we can hit a race here, but of course the situation can easily change).

review: Needs Fixing

[Daniel van Vugt (vanvugt)]

Works for me.

review: Approve

[Alan Griffiths (alan-griffiths)]

LGTM

review: Approve

[Alexandros Frantzis (afrantzis)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1658
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/1740/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-utopic-i386-build/341
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-utopic-amd64-build/342
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-utopic-touch/339/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/259
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/259/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-ci/258
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-ci/258/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/948/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/1740/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-autolanding/701/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-utopic-i386-build/352
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-clang-utopic-amd64-build/353/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-utopic-touch/350
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-autolanding/85
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-autolanding/85/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-autolanding/85
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-autolanding/85/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/981
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/981/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/1585
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/7792

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-autolanding/709/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-utopic-i386-build/363
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-clang-utopic-amd64-build/364/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-utopic-touch/361/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-autolanding/93
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-autolanding/93/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-autolanding/93
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-autolanding/93/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/1013
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/1013/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/1594/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/7828

review: Needs Fixing (continuous-integration)

=== modified file 'src/platform/graphics/mesa/cursor.cpp'
--- src/platform/graphics/mesa/cursor.cpp	2014-05-22 11:31:21 +0000
+++ src/platform/graphics/mesa/cursor.cpp	2014-05-27 08:08:21 +0000
@@ -83,7 +83,7 @@
 {
     show(*initial_image);
 
-    show_at_last_known_position();
+    resume();
 }
 
 mgm::Cursor::~Cursor() noexcept
@@ -116,7 +116,15 @@
     place_cursor_at(position, UpdateState);
 }
 
-void mgm::Cursor::show_at_last_known_position()
+void mir::graphics::mesa::Cursor::suspend()
+{
+    std::lock_guard<std::mutex> lg(guard);
+
+    output_container.for_each_output(
+        [&](KMSOutput& output) { output.clear_cursor(); });
+}
+
+void mgm::Cursor::resume()
 {
     place_cursor_at(current_position, ForceState);
 }

=== modified file 'src/platform/graphics/mesa/cursor.h'
--- src/platform/graphics/mesa/cursor.h	2014-05-22 11:31:21 +0000
+++ src/platform/graphics/mesa/cursor.h	2014-05-27 08:08:21 +0000
@@ -75,7 +75,8 @@
 
     void move_to(geometry::Point position);
 
-    void show_at_last_known_position();
+    void suspend();
+    void resume();
 
 private:
     enum ForceCursorState { UpdateState, ForceState };

=== modified file 'src/platform/graphics/mesa/display.cpp'
--- src/platform/graphics/mesa/display.cpp	2014-05-07 02:56:33 +0000
+++ src/platform/graphics/mesa/display.cpp	2014-05-27 08:08:21 +0000
@@ -224,7 +224,7 @@
         clear_connected_unused_outputs();
     }
 
-    if (auto c = cursor.lock()) c->show_at_last_known_position();
+    if (auto c = cursor.lock()) c->resume();
 }
 
 void mgm::Display::register_configuration_change_handler(
@@ -255,7 +255,7 @@
 {
     try
     {
-        if (auto c = cursor.lock()) c->hide();
+        if (auto c = cursor.lock()) c->suspend();
         platform->drm.drop_master();
     }
     catch(std::runtime_error const& e)
@@ -291,7 +291,7 @@
         clear_connected_unused_outputs();
     }
 
-    if (auto c = cursor.lock()) c->show_at_last_known_position();
+    if (auto c = cursor.lock()) c->resume();
 }
 
 auto mgm::Display::create_hardware_cursor(std::shared_ptr<mg::CursorImage> const& initial_image) -> std::shared_ptr<graphics::Cursor>

=== modified file 'tests/unit-tests/graphics/mesa/test_cursor.cpp'
--- tests/unit-tests/graphics/mesa/test_cursor.cpp	2014-05-22 11:31:21 +0000
+++ tests/unit-tests/graphics/mesa/test_cursor.cpp	2014-05-27 08:08:21 +0000
@@ -374,25 +374,6 @@
     output_container.verify_and_clear_expectations();
 }
 
-TEST_F(MesaCursorTest, shows_at_last_known_position)
-{
-    using namespace testing;
-
-    EXPECT_CALL(*output_container.outputs[10], move_cursor(geom::Point{150,75}));
-    EXPECT_CALL(*output_container.outputs[11], move_cursor(geom::Point{50,25}));
-
-    cursor.move_to({150, 75});
-
-    output_container.verify_and_clear_expectations();
-
-    EXPECT_CALL(*output_container.outputs[10], move_cursor(geom::Point{150,75}));
-    EXPECT_CALL(*output_container.outputs[11], move_cursor(geom::Point{50,25}));
-
-    cursor.show_at_last_known_position();
-
-    output_container.verify_and_clear_expectations();
-}
-
 TEST_F(MesaCursorTest, moves_properly_to_and_inside_left_rotated_output)
 {
     using namespace testing;
@@ -478,3 +459,48 @@
     EXPECT_CALL(*output_container.outputs[11], clear_cursor());
     EXPECT_CALL(*output_container.outputs[12], clear_cursor());
 }
+
+TEST_F(MesaCursorTest, cursor_is_shown_at_correct_location_after_suspend_resume)
+{
+    using namespace testing;
+
+    EXPECT_CALL(*output_container.outputs[10], move_cursor(geom::Point{150,75}));
+    EXPECT_CALL(*output_container.outputs[11], move_cursor(geom::Point{50,25}));
+    EXPECT_CALL(*output_container.outputs[10], clear_cursor());
+    EXPECT_CALL(*output_container.outputs[11], clear_cursor());
+    EXPECT_CALL(*output_container.outputs[12], clear_cursor());
+
+    cursor.move_to({150, 75});
+    cursor.suspend();
+
+    output_container.verify_and_clear_expectations();
+
+    EXPECT_CALL(*output_container.outputs[10], set_cursor(_));
+    EXPECT_CALL(*output_container.outputs[11], set_cursor(_));
+    EXPECT_CALL(*output_container.outputs[10], move_cursor(geom::Point{150,75}));
+    EXPECT_CALL(*output_container.outputs[11], move_cursor(geom::Point{50,25}));
+
+    cursor.resume();
+    output_container.verify_and_clear_expectations();
+}
+
+TEST_F(MesaCursorTest, hidden_cursor_is_not_shown_after_suspend_resume)
+{
+    using namespace testing;
+
+    EXPECT_CALL(*output_container.outputs[10], clear_cursor()).Times(AnyNumber());
+    EXPECT_CALL(*output_container.outputs[11], clear_cursor()).Times(AnyNumber());
+    EXPECT_CALL(*output_container.outputs[12], clear_cursor()).Times(AnyNumber());
+
+    cursor.hide();
+    cursor.suspend();
+
+    output_container.verify_and_clear_expectations();
+
+    EXPECT_CALL(*output_container.outputs[10], set_cursor(_)).Times(0);
+    EXPECT_CALL(*output_container.outputs[11], set_cursor(_)).Times(0);
+    EXPECT_CALL(*output_container.outputs[12], set_cursor(_)).Times(0);
+
+    cursor.resume();
+    output_container.verify_and_clear_expectations();
+}