Merge lp:~gerboland/qtubuntu/exposeOrientation into lp:qtubuntu

[Gerry Boland]

Expose Mir surface orientation property instead of connecting to orientation sensor directly

Requires:
https://code.launchpad.net/~gerboland/platform-api/exposeOrientation/+merge/232250

[lp:~gerboland/qtubuntu/exposeOrientation]

244. By Gerry Boland on 2014-08-26

Depend on PAPI 2.2.1

245. By Gerry Boland on 2014-08-26

Alphabetize

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:243
http://jenkins.qa.ubuntu.com/job/qtubuntu-ci/155/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/qtubuntu-utopic-armhf-ci/21/console

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:245
http://jenkins.qa.ubuntu.com/job/qtubuntu-ci/156/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/qtubuntu-utopic-armhf-ci/22/console

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

review: Needs Fixing (continuous-integration)

[Daniel d'Andrada (dandrader)]

In src/ubuntumirclient/input.cpp

"""
    LOG("ORIENTATION direction:%d", event->orientation.direction);
"""

Convert the enum value to a nice human-readable string, please.

""""
    Qt::ScreenOrientation orientation;
    switch (event->orientation.direction) {
    case U_ORIENTATION_NORMAL:
        orientation = Qt::PortraitOrientation;
        break;
    case U_ORIENTATION_LEFT:
        orientation = Qt::LandscapeOrientation;
        break;
    case U_ORIENTATION_INVERTED:
        orientation = Qt::InvertedPortraitOrientation;
        break;
    case U_ORIENTATION_RIGHT:
        orientation = Qt::InvertedLandscapeOrientation;
        break;
    default:
        DLOG("No such orientation %d", event->orientation.direction);
        return;
    }

    // Dispatch orientation event to [Platform]Screen, as that is where Qt reads it. Screen will handle
    // notifying Qt of the actual orientation change - done to prevent multiple Windows each creating
    // an identical orientation change event and passing it directly to Qt.
    // [Platform]Screen can also factor in the native orientation.
    QCoreApplication::postEvent(static_cast<UbuntuScreen*>(window->screen()->handle()),
                                new OrientationChangeEvent(OrientationChangeEvent::mType, orientation));
""""

Then please use the same nomenclature that the mir event uses in that internal OrientationChangeEvent, thus avoiding mentioning landscape or portrait at this point, which is misleading. You could stick with the QOrientationReading::Orientation enum.

review: Needs Fixing

[Gerry Boland (gerboland)]

> Then please use the same nomenclature that the mir event uses in that internal
> OrientationChangeEvent, thus avoiding mentioning landscape or portrait at this
> point, which is misleading. You could stick with the
> QOrientationReading::Orientation enum.

Can you explain your reasoning why this is misleading? We need to convert from Mir event nomenclature (normal,left,right,inverted) to QScreenOrientation (portrait, landscape, invertedlandscape, invertedportrait) somewhere, it struck me as a good idea to convert to Qt's definition as quickly as possible.

Do I understand you want me to add an intermediary 3rd nomenclature, the QOrientationReading::Orientation. So then we have Mir->QOrientationReading->QScreenOrientation ?

[lp:~gerboland/qtubuntu/exposeOrientation]

246. By Gerry Boland on 2014-09-01

Add text description for a debug output

[Daniel d'Andrada (dandrader)]

> > Then please use the same nomenclature that the mir event uses in that
> internal
> > OrientationChangeEvent, thus avoiding mentioning landscape or portrait at
> this
> > point, which is misleading. You could stick with the
> > QOrientationReading::Orientation enum.
>
> Can you explain your reasoning why this is misleading? We need to convert from
> Mir event nomenclature (normal,left,right,inverted) to QScreenOrientation
> (portrait, landscape, invertedlandscape, invertedportrait) somewhere, it
> struck me as a good idea to convert to Qt's definition as quickly as possible.

Because in UbuntuInput::dispatchOrientationEvent you're doing a wrong conversion as you're assuming that the native orientation is portrait, just to later fix it in QScreen. By converting it to QOrientationReading you don't have to make any such assumptions. For what it's worth, QOrientationReading is also a "Qt definition".

>
> Do I understand you want me to add an intermediary 3rd nomenclature, the
> QOrientationReading::Orientation. So then we have
> Mir->QOrientationReading->QScreenOrientation ?

Yes. If I understood QOrientationReading correctly, it's a one-to-one mapping of the Mir enum.

But if you don't like that intermediate enum, then I'm fine if you store the Mir enum value in that internal QEvent as well. I just don't want the wrong conversion I mentioned above.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:246
http://jenkins.qa.ubuntu.com/job/qtubuntu-ci/157/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/qtubuntu-utopic-armhf-ci/23/console

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

review: Needs Fixing (continuous-integration)

[Daniel d'Andrada (dandrader)]

"""
LOG("ORIENTATION direction: %d", nativeOrientationDirectionToStr(event->orientation.direction));
"""

Should be '%s', not '%d'. Did it work at all like that?

review: Needs Fixing

[lp:~gerboland/qtubuntu/exposeOrientation]

247. By Gerry Boland on 2014-09-01

oops, %s not %d

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:247
http://jenkins.qa.ubuntu.com/job/qtubuntu-ci/158/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/qtubuntu-utopic-armhf-ci/24/console

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

review: Needs Fixing (continuous-integration)

[lp:~gerboland/qtubuntu/exposeOrientation]

248. By Gerry Boland on 2014-09-02

Use QOrientationReading::Orientation in the OrientationChangeEvent

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:248
http://jenkins.qa.ubuntu.com/job/qtubuntu-ci/159/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/qtubuntu-utopic-armhf-ci/25/console

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

review: Needs Fixing (continuous-integration)

[Daniel d'Andrada (dandrader)]

In src/ubuntumirclient/screen.cpp:

"""
- case QOrientationReading::LeftUp: {
+ case QOrientationReading::RightUp: {
             mCurrentOrientation = (mNativeOrientation == Qt::LandscapeOrientation) ?
- Qt::InvertedPortraitOrientation : Qt::LandscapeOrientation;
+ Qt::InvertedPortraitOrientation : Qt::InvertedLandscapeOrientation;
"""

This is wrong. The original code had the correct conversion.

"""
- case QOrientationReading::RightUp: {
+ case QOrientationReading::LeftUp: {
             mCurrentOrientation = (mNativeOrientation == Qt::LandscapeOrientation) ?
- Qt::PortraitOrientation : Qt::InvertedLandscapeOrientation;
+ Qt::PortraitOrientation : Qt::LandscapeOrientation;
"""

Same here.

See https://www.dropbox.com/s/4ctoecuq4269j5m/QtScreenOrientation.png?dl=0

review: Needs Fixing

[lp:~gerboland/qtubuntu/exposeOrientation]

249. By Gerry Boland on 2014-09-09

Undo changes to mapping of OrientationReading->ScreenOrientation, better the old way

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:249
http://jenkins.qa.ubuntu.com/job/qtubuntu-ci/160/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/qtubuntu-utopic-armhf-ci/26/console

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

review: Needs Fixing (continuous-integration)

[Daniel d'Andrada (dandrader)]

Looking good.

review: Approve

[lp:~gerboland/qtubuntu/exposeOrientation]

250. By Gerry Boland on 2014-09-19

Dump dependency on papi to 2.4.0

=== modified file 'debian/control'
--- debian/control	2014-07-09 17:17:05 +0000
+++ debian/control	2014-09-19 12:18:46 +0000
@@ -8,7 +8,7 @@
                libfreetype6-dev,
                libgles2-mesa-dev,
                libglib2.0-dev,
-               libubuntu-application-api-dev (>= 2.2.0),
+               libubuntu-application-api-dev (>= 2.4.0),
                libudev-dev,
                libxrender-dev,
                libxkbcommon-dev,

=== modified file 'src/ubuntumirclient/input.cpp'
--- src/ubuntumirclient/input.cpp	2014-08-14 09:45:04 +0000
+++ src/ubuntumirclient/input.cpp	2014-09-19 12:18:46 +0000
@@ -18,8 +18,10 @@
 #include "input.h"
 #include "integration.h"
 #include "nativeinterface.h"
+#include "screen.h"
 #include "window.h"
 #include "logging.h"
+#include "orientationchangeevent_p.h"
 
 // Qt
 #if !defined(QT_NO_DEBUG)
@@ -36,6 +38,7 @@
 
 // Platform API
 #include <ubuntu/application/ui/input/event.h>
+#include <ubuntu/application/ui/window_orientation.h>
 
 #define LOG_EVENTS 0
 
@@ -174,6 +177,10 @@
         break;
     case SURFACE_WEVENT_TYPE:
         return "SURFACE_WEVENT_TYPE";
+        break;
+    case ORIENTATION_WEVENT_TYPE:
+        return "ORIENTATION_WEVENT_TYPE";
+        break;
     default:
         return "INVALID!";
     }
@@ -218,6 +225,9 @@
             ubuntuEvent->window->handleSurfaceFocusChange(nativeEvent->surface.value == 1);
         }
         break;
+    case ORIENTATION_WEVENT_TYPE:
+        dispatchOrientationEvent(ubuntuEvent->window->window(), nativeEvent);
+        break;
     default:
         DLOG("unhandled event type %d", nativeEvent->type);
     }
@@ -408,3 +418,67 @@
 
     QWindowSystemInterface::handleKeyEvent(window, timestamp, keyType, sym, modifiers, text);
 }
+
+#if (LOG_EVENTS != 0)
+static const char* nativeOrientationDirectionToStr(const int orientation)
+{
+    switch (orientation) {
+    case U_ORIENTATION_NORMAL:
+        return "Normal";
+        break;
+    case U_ORIENTATION_LEFT:
+        return "Left";
+        break;
+    case U_ORIENTATION_INVERTED:
+        return "Inverted";
+        break;
+    case U_ORIENTATION_RIGHT:
+        return "Right";
+        break;
+    default:
+        return "INVALID!";
+    }
+}
+#endif
+
+void UbuntuInput::dispatchOrientationEvent(QWindow* window, const void* ev)
+{
+    const WindowEvent* event = reinterpret_cast<const WindowEvent*>(ev);
+
+    #if (LOG_EVENTS != 0)
+    // Orientation event logging.
+    LOG("ORIENTATION direction: %s", nativeOrientationDirectionToStr(event->orientation.direction));
+    #endif
+
+    if (!window->screen()) {
+        DLOG("Window has no associated screen, dropping orientation event");
+        return;
+    }
+
+    QOrientationReading::Orientation orientation;
+    switch (event->orientation.direction) {
+    case U_ORIENTATION_NORMAL:
+        orientation = QOrientationReading::TopUp;
+        break;
+    case U_ORIENTATION_LEFT:
+        orientation = QOrientationReading::LeftUp;
+        break;
+    case U_ORIENTATION_INVERTED:
+        orientation = QOrientationReading::TopDown;
+        break;
+    case U_ORIENTATION_RIGHT:
+        orientation = QOrientationReading::RightUp;
+        break;
+    default:
+        DLOG("No such orientation %d", event->orientation.direction);
+        return;
+    }
+
+    // Dispatch orientation event to [Platform]Screen, as that is where Qt reads it. Screen will handle
+    // notifying Qt of the actual orientation change - done to prevent multiple Windows each creating
+    // an identical orientation change event and passing it directly to Qt.
+    // [Platform]Screen can also factor in the native orientation.
+    QCoreApplication::postEvent(static_cast<UbuntuScreen*>(window->screen()->handle()),
+                                new OrientationChangeEvent(OrientationChangeEvent::mType, orientation));
+}
+

=== modified file 'src/ubuntumirclient/input.h'
--- src/ubuntumirclient/input.h	2014-07-15 12:45:14 +0000
+++ src/ubuntumirclient/input.h	2014-09-19 12:18:46 +0000
@@ -40,6 +40,7 @@
 protected:
     void dispatchKeyEvent(QWindow* window, const void* event);
     void dispatchMotionEvent(QWindow* window, const void* event);
+    void dispatchOrientationEvent(QWindow* window, const void* event);
 
 private:
     UbuntuClientIntegration* mIntegration;

=== added file 'src/ubuntumirclient/orientationchangeevent_p.h'
--- src/ubuntumirclient/orientationchangeevent_p.h	1970-01-01 00:00:00 +0000
+++ src/ubuntumirclient/orientationchangeevent_p.h	2014-09-19 12:18:46 +0000
@@ -0,0 +1,36 @@
+/*
+ * 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/>.
+ */
+
+#ifndef ORIENTATIONCHANGEEVENT_P_H
+#define ORIENTATIONCHANGEEVENT_P_H
+
+#include <QEvent>
+#include <QOrientationReading>
+#include "logging.h"
+
+class OrientationChangeEvent : public QEvent {
+public:
+    OrientationChangeEvent(QEvent::Type type, QOrientationReading::Orientation orientation)
+        : QEvent(type)
+        , mOrientation(orientation)
+    {
+    }
+
+    static const QEvent::Type mType;
+    QOrientationReading::Orientation mOrientation;
+};
+
+#endif // ORIENTATIONCHANGEEVENT_P_H

=== modified file 'src/ubuntumirclient/screen.cpp'
--- src/ubuntumirclient/screen.cpp	2014-06-30 14:40:47 +0000
+++ src/ubuntumirclient/screen.cpp	2014-09-19 12:18:46 +0000
@@ -22,13 +22,10 @@
 #include <qpa/qwindowsysteminterface.h>
 #include <QtPlatformSupport/private/qeglconvenience_p.h>
 
-// Qt sensors
-#include <QtSensors/QOrientationSensor>
-#include <QtSensors/QOrientationReading>
-
 // local
 #include "screen.h"
 #include "logging.h"
+#include "orientationchangeevent_p.h"
 
 // platform-api
 #include <ubuntu/application/ui/display.h>
@@ -85,21 +82,8 @@
 }
 #endif
 
-class OrientationReadingEvent : public QEvent {
-public:
-    OrientationReadingEvent(QEvent::Type type, QOrientationReading::Orientation orientation)
-        : QEvent(type)
-        , mOrientation(orientation) {
-        DLOG("OrientationReadingEvent::OrientationReadingEvent()");
-    }
-    ~OrientationReadingEvent() {
-        DLOG("OrientationReadingEvent::~OrientationReadingEvent()");
-    }
-    static const QEvent::Type mType;
-    QOrientationReading::Orientation mOrientation;
-};
 
-const QEvent::Type OrientationReadingEvent::mType =
+const QEvent::Type OrientationChangeEvent::mType =
         static_cast<QEvent::Type>(QEvent::registerEventType());
 
 
@@ -171,31 +155,17 @@
 
     // If it's a landscape device (i.e. some tablets), start in landscape, otherwise portrait
     mCurrentOrientation = (mNativeOrientation == Qt::LandscapeOrientation) ? Qt::LandscapeOrientation : Qt::PortraitOrientation;
-
-    mOrientationSensor = new QOrientationSensor();
-    QObject::connect(mOrientationSensor, SIGNAL(readingChanged()), this, SLOT(onOrientationReadingChanged()));
-    mOrientationSensor->start();
 }
 
 UbuntuScreen::~UbuntuScreen()
 {
     eglTerminate(mEglDisplay);
-    delete mOrientationSensor;
-}
-
-void UbuntuScreen::toggleSensors(const bool enable) const {
-    DLOG("UbuntuScreen::toggleSensors (this=%p, enable=%d)", this, enable);
-    if (enable)
-        mOrientationSensor->start();
-    else
-        mOrientationSensor->stop();
 }
 
 void UbuntuScreen::customEvent(QEvent* event) {
-    DLOG("UbuntuScreen::customEvent (event: %p)", event);
     DASSERT(QThread::currentThread() == thread());
 
-    OrientationReadingEvent* oReadingEvent = static_cast<OrientationReadingEvent*>(event);
+    OrientationChangeEvent* oReadingEvent = static_cast<OrientationChangeEvent*>(event);
     switch (oReadingEvent->mOrientation) {
         case QOrientationReading::LeftUp: {
             mCurrentOrientation = (mNativeOrientation == Qt::LandscapeOrientation) ?
@@ -218,20 +188,12 @@
             break;
         }
         default: {
-            DLOG("Unknown orientation.");
+            DLOG("UbuntuScreen::customEvent - Unknown orientation.");
+            return;
         }
     }
 
     // Raise the event signal so that client apps know the orientation changed
     QWindowSystemInterface::handleScreenOrientationChange(screen(), mCurrentOrientation);
-}
-
-void UbuntuScreen::onOrientationReadingChanged() {
-    DLOG("UbuntuScreen::onOrientationReadingChanged");
-    DASSERT(mOrientationSensor != NULL);
-
-    // Make sure to switch to the main Qt thread context
-    QCoreApplication::postEvent(this, new OrientationReadingEvent(
-                                    OrientationReadingEvent::mType, mOrientationSensor->reading()->orientation()));
-}
-
+    DLOG("UbuntuScreen::customEvent - handling orientation change to %d", mCurrentOrientation);
+}

=== modified file 'src/ubuntumirclient/screen.h'
--- src/ubuntumirclient/screen.h	2014-06-30 14:40:47 +0000
+++ src/ubuntumirclient/screen.h	2014-09-19 12:18:46 +0000
@@ -21,8 +21,6 @@
 #include <QSurfaceFormat>
 #include <EGL/egl.h>
 
-class QOrientationSensor;
-
 class UbuntuScreen : public QObject, public QPlatformScreen
 {
     Q_OBJECT
@@ -44,20 +42,14 @@
     EGLConfig eglConfig() const { return mEglConfig; }
     EGLNativeDisplayType eglNativeDisplay() const { return mEglNativeDisplay; }
 
-    void toggleSensors(bool enable) const;
-
     // QObject methods.
     void customEvent(QEvent* event);
 
-public Q_SLOTS:
-   void onOrientationReadingChanged();
-
 private:
     QRect mGeometry;
     QRect mAvailableGeometry;
     Qt::ScreenOrientation mNativeOrientation;
     Qt::ScreenOrientation mCurrentOrientation;
-    QOrientationSensor* mOrientationSensor;
     QImage::Format mFormat;
     int mDepth;
     QSurfaceFormat mSurfaceFormat;

=== modified file 'src/ubuntumirclient/ubuntumirclient.pro'
--- src/ubuntumirclient/ubuntumirclient.pro	2014-08-14 13:18:24 +0000
+++ src/ubuntumirclient/ubuntumirclient.pro	2014-09-19 12:18:46 +0000
@@ -37,6 +37,7 @@
     integration.h \
     logging.h \
     nativeinterface.h \
+    orientationchangeevent_p.h \    
     platformservices.h \
     plugin.h \
     screen.h \