Merge lp:~josharenson/qtmir/disable_orientation_sensors_based_on_screen_state into lp:qtmir

[Josh Arenson]

Add support for enabling/disabling orientation sensor based on screen power state.

* Are there any related MPs required for this MP to build/function as expected? Please list.
No

 * Did you perform an exploratory manual test run of your code change and any related functionality?
Yes

 * If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?
N/A

Fix lp:1375297

This turns the orientation sensor on or off depending on the power state of the screen.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:269
http://jenkins.qa.ubuntu.com/job/qtmir-ci/142/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/qtmir-utopic-amd64-ci/142
    SUCCESS: http://jenkins.qa.ubuntu.com/job/qtmir-utopic-armhf-ci/142
        deb: http://jenkins.qa.ubuntu.com/job/qtmir-utopic-armhf-ci/142/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/qtmir-ci/142/rebuild

review: Approve (continuous-integration)

[lp:~josharenson/qtmir/disable_orientation_sensors_based_on_screen_state]

270. By Josh Arenson on 2014-10-22

Fix whitespace issues

271. By Josh Arenson on 2014-10-22

Remove leftover tab

272. By Josh Arenson on 2014-10-22

Add FIXME

273. By Josh Arenson on 2014-10-22

Fix whitespace

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:270
http://jenkins.qa.ubuntu.com/job/qtmir-ci/146/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/qtmir-utopic-amd64-ci/146
    SUCCESS: http://jenkins.qa.ubuntu.com/job/qtmir-utopic-armhf-ci/146
        deb: http://jenkins.qa.ubuntu.com/job/qtmir-utopic-armhf-ci/146/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/qtmir-ci/146/rebuild

review: Approve (continuous-integration)

[lp:~josharenson/qtmir/disable_orientation_sensors_based_on_screen_state]

274. By Josh Arenson on 2014-10-22

Change unityScreen to m_unityScreen as it is a member variable

[Daniel d'Andrada (dandrader)]

Looks good to me.

* Did you perform an exploratory manual test run of the code change and any related functionality?
Yes.

* Did CI run pass? If not, please explain why.
Yes.

review: Approve

[Gerry Boland (gerboland)]

+1

review: Approve

=== modified file 'src/platforms/mirserver/screen.cpp'
--- src/platforms/mirserver/screen.cpp	2014-09-10 15:04:42 +0000
+++ src/platforms/mirserver/screen.cpp	2014-10-22 15:48:16 +0000
@@ -104,11 +104,12 @@
 const QEvent::Type OrientationReadingEvent::m_type =
         static_cast<QEvent::Type>(QEvent::registerEventType());
 
-
+bool Screen::skipDBusRegistration = false;
 
 Screen::Screen(mir::graphics::DisplayConfigurationOutput const &screen)
     : QObject(nullptr)
     , m_orientationSensor(new QOrientationSensor(this))
+    , m_unityScreen(nullptr)
 {
     readMirDisplayConfiguration(screen);
 
@@ -125,6 +126,32 @@
     QObject::connect(m_orientationSensor, &QOrientationSensor::readingChanged,
                      this, &Screen::onOrientationReadingChanged);
     m_orientationSensor->start();
+
+    if (!skipDBusRegistration) {
+        // FIXME This is a unity8 specific dbus call and shouldn't be in qtmir
+        m_unityScreen = new QDBusInterface("com.canonical.Unity.Screen",
+                                         "/com/canonical/Unity/Screen",
+                                         "com.canonical.Unity.Screen",
+                                         QDBusConnection::systemBus(), this);
+
+        m_unityScreen->connection().connect("com.canonical.Unity.Screen",
+                                          "/com/canonical/Unity/Screen",
+                                          "com.canonical.Unity.Screen",
+                                          "DisplayPowerStateChange",
+                                          this,
+                                          SLOT(onDisplayPowerStateChanged(int, int)));
+    }
+}
+
+bool Screen::orientationSensorEnabled()
+{
+    return m_orientationSensor->isActive();
+}
+
+void Screen::onDisplayPowerStateChanged(int status, int reason)
+{
+    Q_UNUSED(reason);
+    toggleSensors(status);
 }
 
 void Screen::readMirDisplayConfiguration(mir::graphics::DisplayConfigurationOutput const &screen)
@@ -147,7 +174,6 @@
     m_refreshRate = mode.vrefresh_hz;
 }
 
-// FIXME: nothing is using this method yet, but we should turn off sensors when display is off.
 void Screen::toggleSensors(const bool enable) const
 {
     qCDebug(QTMIR_SENSOR_MESSAGES) << "Screen::toggleSensors - enable=" << enable;

=== modified file 'src/platforms/mirserver/screen.h'
--- src/platforms/mirserver/screen.h	2014-08-25 15:26:08 +0000
+++ src/platforms/mirserver/screen.h	2014-10-22 15:48:16 +0000
@@ -22,6 +22,7 @@
 
 #include <QObject>
 #include <QTimer>
+#include <QtDBus/QDBusInterface>
 #include <qpa/qplatformscreen.h>
 
 #include "mir/graphics/display_configuration.h"
@@ -48,7 +49,12 @@
     // QObject methods.
     void customEvent(QEvent* event) override;
 
+    // To make it testable
+    static bool skipDBusRegistration;
+    bool orientationSensorEnabled();
+
 public Q_SLOTS:
+   void onDisplayPowerStateChanged(int, int);
    void onOrientationReadingChanged();
 
 private:
@@ -63,6 +69,8 @@
     Qt::ScreenOrientation m_nativeOrientation;
     Qt::ScreenOrientation m_currentOrientation;
     QOrientationSensor *m_orientationSensor;
+
+    QDBusInterface *m_unityScreen;
 };
 
 #endif // SCREEN_H

=== added directory 'tests/mirserver/Screen'
=== added file 'tests/mirserver/Screen/Screen.pro'
--- tests/mirserver/Screen/Screen.pro	1970-01-01 00:00:00 +0000
+++ tests/mirserver/Screen/Screen.pro	2014-10-22 15:48:16 +0000
@@ -0,0 +1,16 @@
+include(../../test-includes.pri)
+
+TARGET = ScreenTest
+
+QT += gui-private
+
+INCLUDEPATH += \
+    ../../../src/platforms/mirserver \
+    ../../../src/common
+
+SOURCES += \
+    screen_test.cpp \
+    ../../../src/common/debughelpers.cpp
+
+LIBS += -Wl,-rpath,$${OUT_PWD}/../../../src/platforms/mirserver \
+    -L../../../src/platforms/mirserver -lqpa-mirserver

=== added file 'tests/mirserver/Screen/screen_test.cpp'
--- tests/mirserver/Screen/screen_test.cpp	1970-01-01 00:00:00 +0000
+++ tests/mirserver/Screen/screen_test.cpp	2014-10-22 15:48:16 +0000
@@ -0,0 +1,65 @@
+/*
+ * Copyright (C) 2014 Canonical, Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License version 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 warranties of MERCHANTABILITY,
+ * SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+#include "mir/graphics/display_configuration.h"
+
+#include <screen.h>
+
+namespace mg = mir::graphics;
+namespace geom = mir::geometry;
+
+mg::DisplayConfigurationOutput const fake_output
+{
+    mg::DisplayConfigurationOutputId{3},
+    mg::DisplayConfigurationCardId{2},
+    mg::DisplayConfigurationOutputType::dvid,
+    {
+        mir_pixel_format_abgr_8888
+    },
+    {
+        {geom::Size{10, 20}, 60.0},
+        {geom::Size{10, 20}, 59.0},
+        {geom::Size{15, 20}, 59.0}
+    },
+    0,
+    geom::Size{10, 20},
+    true,
+    true,
+    geom::Point(),
+    2,
+    mir_pixel_format_abgr_8888,
+    mir_power_mode_on,
+    mir_orientation_normal
+};
+
+TEST(ScreenTest, OrientationSensor)
+{
+    Screen::skipDBusRegistration = true;
+    Screen *screen = new Screen(fake_output);
+
+    // Default state should be active
+    ASSERT_TRUE(screen->orientationSensorEnabled());
+
+    screen->onDisplayPowerStateChanged(0,0);
+    ASSERT_FALSE(screen->orientationSensorEnabled());
+
+    screen->onDisplayPowerStateChanged(1,0);
+    ASSERT_TRUE(screen->orientationSensorEnabled());
+}

=== modified file 'tests/mirserver/mirserver.pro'
--- tests/mirserver/mirserver.pro	2014-09-22 17:26:06 +0000
+++ tests/mirserver/mirserver.pro	2014-10-22 15:48:16 +0000
@@ -1,2 +1,2 @@
 TEMPLATE = subdirs
-SUBDIRS = QtEventFeeder Clipboard
+SUBDIRS = QtEventFeeder Clipboard Screen