Merge lp:~dandrader/qtmir/miral-surfaceLocalPos into lp:qtmir

[Daniel d'Andrada]

Changes need for child windows support

- MirSurface::parentSurface
- MirSurface::childSurfaceList
- MirSurface::position in local coordinates

Depends on
https://code.launchpad.net/~dandrader/unity-api/parentSurface/+merge/311975

[Unity8 CI Bot (unity8-ci-bot)]

FAILED: Continuous integration, rev:588
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/415/
Executed test runs:
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build/3404/console
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-0-fetch/3432
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=vivid+overlay/3283/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=xenial+overlay/3283/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=zesty/3283/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=vivid+overlay/3283/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=xenial+overlay/3283/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=zesty/3283/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=vivid+overlay/3283/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=xenial+overlay/3283/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=zesty/3283/console

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/415/rebuild

review: Needs Fixing (continuous-integration)

[Gerry Boland (gerboland)]

+ // assumes parent won't be detroyed before its children
typo.
Time will tell how correct this assumption is :)

review: Needs Fixing

[Daniel d'Andrada (dandrader)]

On 29/11/2016 11:03, Gerry Boland wrote:
> Review: Needs Fixing
>
> + // assumes parent won't be detroyed before its children
> typo.
> Time will tell how correct this assumption is :)

Fixed.

Indeed.

[Unity8 CI Bot (unity8-ci-bot)]

PASSED: Continuous integration, rev:589
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/416/
Executed test runs:
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build/3412
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-0-fetch/3440

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/416/rebuild

review: Approve (continuous-integration)

[Gerry Boland (gerboland)]

Code looks ok, not tested though

review: Approve (code)

[Unity8 CI Bot (unity8-ci-bot)]

FAILED: Continuous integration, rev:589
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/417/
Executed test runs:
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build/3421/console
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-0-fetch/3449
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=xenial+overlay/3292/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=zesty/3292/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=xenial+overlay/3292/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=zesty/3292/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=xenial+overlay/3292/console
    FAILURE: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=zesty/3292/console

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/417/rebuild

review: Needs Fixing (continuous-integration)

[lp:~dandrader/qtmir/miral-surfaceLocalPos]

575. By Brandon Schaefer on 2016-12-03

Mir 0.25 compat

576. By CI Train Bot Account on 2016-12-03

Releasing 0.5.0+17.04.20161203-0ubuntu1

577. By CI Train Bot Account on 2016-12-16

First release using MirAL

578. By Daniel d'Andrada on 2016-12-16

Get rid of the ApplicationManager::Factory class

It's useless

Approved by: Gerry Boland, Unity8 CI Bot

579. By Daniel d'Andrada on 2016-12-16

Enable tests in Xenial

This workaround was needed only for the glib version present in Vivid

Approved by: Gerry Boland, Unity8 CI Bot

580. By CI Train Bot Account on 2016-12-16

Releasing 0.5.1+17.04.20161216-0ubuntu1

581. By Łukasz Zemczak on 2016-12-22

No-change rebuild against latest miral.

582. By Albert Astals Cid on 2017-01-04

Specify C++14 in a more CMake-ish way

Works better when building with Qt 5.7 otherwise one would say C++14, the other C++11 and things would not work out (LP: #1653902)

Approved by: Gerry Boland

583. By CI Train Bot Account on 2017-01-04

Releasing 0.5.1+17.04.20170104-0ubuntu1

584. By CI Train Bot Account on 2017-01-16

Resync trunk.

585. By Lukáš Tinkl on 2017-01-24

Some assorted cleanups and small optimizations

Approved by: Gerry Boland, Unity8 CI Bot

586. By Lukáš Tinkl on 2017-01-24

Apply default device keymap (LP: #1626435)

Approved by: Gerry Boland, Unity8 CI Bot

587. By Gerry Boland on 2017-01-24

Recalculate MirSurface.visible after first frame swap by client

Fixes issue where OSK would be invisible at startup (LP: #1649077)

Approved by: Nick Dedekind, Unity8 CI Bot

588. By CI Train Bot Account on 2017-01-24

Releasing 0.5.1+17.04.20170124-0ubuntu1

589. By Cemil Azizoglu on 2017-01-27

Mir 0.26 compatibility branch for QtMir.

Approved by: Gerry Boland

590. By CI Train Bot Account on 2017-01-27

Releasing 0.5.1+17.04.20170127-0ubuntu1

591. By Daniel d'Andrada on 2017-02-02

MirSurface: parentSurface, childSurfaceList and position in local coords

Unmerged revisions

=== modified file 'src/common/debughelpers.cpp'
--- src/common/debughelpers.cpp	2016-11-29 13:05:57 +0000
+++ src/common/debughelpers.cpp	2016-11-29 13:05:57 +0000
@@ -115,23 +115,18 @@
 const char *mirSurfaceTypeToStr(int value)
 {
     switch (value) {
-    case mir_surface_type_normal:
-        return "normal";
-    case mir_surface_type_utility:
-        return "utility";
-    case mir_surface_type_dialog:
-        return "dialog";
-    case mir_surface_type_overlay:
-        return "overlay";
-    case mir_surface_type_freestyle:
-        return "freestyle";
-    case mir_surface_type_popover:
-        return "popover";
-    case mir_surface_type_inputmethod:
-        return "inputmethod";
-    default:
-        return "???";
+    case mir_surface_type_normal:       return "normal";        /**< AKA "regular"                   */
+    case mir_surface_type_utility:      return "utility";       /**< AKA "floating regular"          */
+    case mir_surface_type_dialog:       return "dialog";
+    case mir_surface_type_gloss:        return "gloss";
+    case mir_surface_type_freestyle:    return "freestyle";
+    case mir_surface_type_menu:         return "menu";
+    case mir_surface_type_inputmethod:  return "input Method";  /**< AKA "OSK" or handwriting etc.   */
+    case mir_surface_type_satellite:    return "satellite";     /**< AKA "toolbox"/"toolbar"         */
+    case mir_surface_type_tip:          return "tip";           /**< AKA "tooltip"                   */
+    case mir_surface_types:             Q_UNREACHABLE();
     }
+    return "";
 }
 
 const char *mirSurfaceStateToStr(int value)

=== modified file 'src/modules/Unity/Application/mirsurface.cpp'
--- src/modules/Unity/Application/mirsurface.cpp	2016-11-29 13:05:57 +0000
+++ src/modules/Unity/Application/mirsurface.cpp	2016-11-29 13:05:57 +0000
@@ -47,6 +47,7 @@
 #include <limits>
 
 using namespace qtmir;
+namespace unityapi = unity::shell::application;
 
 #define DEBUG_MSG qCDebug(QTMIR_SURFACES).nospace() << "MirSurface[" << (void*)this << "," << appId() << "]::" << __func__
 #define WARNING_MSG qCWarning(QTMIR_SURFACES).nospace() << "MirSurface[" << (void*)this << "," << appId() << "]::" << __func__
@@ -108,7 +109,8 @@
 
 MirSurface::MirSurface(NewWindow newWindowInfo,
         WindowControllerInterface* controller,
-        SessionInterface *session)
+        SessionInterface *session,
+        MirSurface *parentSurface)
     : MirSurfaceInterface()
     , m_window{newWindowInfo.windowInfo.window()}
     , m_extraInfo{getExtraInfo(newWindowInfo.windowInfo)}
@@ -129,12 +131,19 @@
     , m_visible(newWindowInfo.windowInfo.is_visible())
     , m_live(true)
     , m_surfaceObserver(std::make_shared<SurfaceObserverImpl>())
-    , m_position(toQPoint(m_window.top_left()))
     , m_size(toQSize(m_window.size()))
     , m_state(toQtState(newWindowInfo.windowInfo.state()))
     , m_shellChrome(Mir::NormalChrome)
+    , m_parentSurface(parentSurface)
+    , m_childSurfaceList(new MirSurfaceListModel(this))
 {
-    DEBUG_MSG << "()";
+    DEBUG_MSG << "("
+        << "type=" << mirSurfaceTypeToStr(m_type)
+        << ",state=" << unityapiMirStateToStr(m_state)
+        << ",parentSurface=" << m_parentSurface
+        << ")";
+
+    m_position = convertDisplayToLocalCoords(toQPoint(m_window.top_left()));
 
     SurfaceObserver::registerObserverForSurface(m_surfaceObserver.get(), m_surface.get());
     m_surface->add_observer(m_surfaceObserver);
@@ -470,8 +479,9 @@
     return m_position;
 }
 
-void MirSurface::setPosition(const QPoint newPosition)
+void MirSurface::setPosition(const QPoint newDisplayPosition)
 {
+    QPoint newPosition = convertDisplayToLocalCoords(newDisplayPosition);
     if (m_position != newPosition) {
         m_position = newPosition;
         Q_EMIT positionChanged(newPosition);
@@ -903,7 +913,9 @@
 void MirSurface::activate()
 {
     DEBUG_MSG << "()";
-    m_controller->activate(m_window);
+    if (m_live) {
+        m_controller->activate(m_window);
+    }
 }
 
 void MirSurface::onCloseTimedOut()
@@ -914,7 +926,9 @@
 
     m_closingState = CloseOverdue;
 
-    m_controller->forceClose(m_window);
+    if (m_live) {
+        m_controller->forceClose(m_window);
+    }
 }
 
 void MirSurface::setCloseTimer(AbstractTimer *timer)
@@ -960,7 +974,12 @@
     if (point != m_requestedPosition) {
         m_requestedPosition = point;
         Q_EMIT requestedPositionChanged(m_requestedPosition);
-        m_controller->move(m_window, m_requestedPosition);
+
+        QPoint requestedDisplayPos = convertLocalToDisplayCoords(m_requestedPosition);
+
+        if (m_live) {
+            m_controller->move(m_window, requestedDisplayPos);
+        }
     }
 }
 
@@ -1173,3 +1192,39 @@
     DEBUG_MSG << "()";
     Q_EMIT focusRequested();
 }
+
+QPoint MirSurface::convertDisplayToLocalCoords(const QPoint &displayPos) const
+{
+    QPoint localPos = displayPos;
+
+    if (m_surface->parent()) {
+        auto parentPos = m_surface->parent()->top_left();
+        localPos.rx() -= parentPos.x.as_int();
+        localPos.ry() -= parentPos.y.as_int();
+    }
+
+    return localPos;
+}
+
+QPoint MirSurface::convertLocalToDisplayCoords(const QPoint &localPos) const
+{
+    QPoint displayPos = localPos;
+
+    if (m_surface->parent()) {
+        auto parentPos = m_surface->parent()->top_left();
+        displayPos.rx() += parentPos.x.as_int();
+        displayPos.ry() += parentPos.y.as_int();
+    }
+
+    return displayPos;
+}
+
+unityapi::MirSurfaceInterface *MirSurface::parentSurface() const
+{
+    return m_parentSurface;
+}
+
+unityapi::MirSurfaceListInterface *MirSurface::childSurfaceList() const
+{
+    return m_childSurfaceList;
+}

=== modified file 'src/modules/Unity/Application/mirsurface.h'
--- src/modules/Unity/Application/mirsurface.h	2016-11-29 13:05:57 +0000
+++ src/modules/Unity/Application/mirsurface.h	2016-11-29 13:05:57 +0000
@@ -43,6 +43,7 @@
 namespace qtmir {
 
 class AbstractTimer;
+class MirSurfaceListModel;
 class SessionInterface;
 
 class MirSurface : public MirSurfaceInterface
@@ -52,7 +53,8 @@
 public:
     MirSurface(NewWindow windowInfo,
                WindowControllerInterface *controller,
-               SessionInterface *session = nullptr);
+               SessionInterface *session = nullptr,
+               MirSurface *parentSurface = nullptr);
     virtual ~MirSurface();
 
     ////
@@ -95,6 +97,10 @@
     bool confinesMousePointer() const override;
 
     Q_INVOKABLE void activate() override;
+
+    unity::shell::application::MirSurfaceInterface *parentSurface() const override;
+    unity::shell::application::MirSurfaceListInterface *childSurfaceList() const override;
+
     Q_INVOKABLE void close() override;
 
     ////
@@ -202,6 +208,8 @@
     void onMaximumHeightChanged(int maxHeight);
     void onWidthIncrementChanged(int incWidth);
     void onHeightIncrementChanged(int incHeight);
+    QPoint convertDisplayToLocalCoords(const QPoint &displayPos) const;
+    QPoint convertLocalToDisplayCoords(const QPoint &localPos) const;
 
     const miral::Window m_window;
     const std::shared_ptr<ExtraWindowInfo> m_extraInfo;
@@ -265,6 +273,11 @@
     };
     ClosingState m_closingState{NotClosing};
     AbstractTimer *m_closeTimer{nullptr};
+
+    // assumes parent won't be destroyed before its children
+    MirSurface *m_parentSurface;
+
+    MirSurfaceListModel *m_childSurfaceList;
 };
 
 } // namespace qtmir

=== modified file 'src/modules/Unity/Application/surfacemanager.cpp'
--- src/modules/Unity/Application/surfacemanager.cpp	2016-11-29 13:05:57 +0000
+++ src/modules/Unity/Application/surfacemanager.cpp	2016-11-29 13:05:57 +0000
@@ -22,6 +22,13 @@
 // mirserver
 #include "nativeinterface.h"
 
+// common
+#include <debughelpers.h>
+#include <mirqtconversion.h>
+
+// Mir
+#include <mir/scene/surface.h>
+
 // Qt
 #include <QGuiApplication>
 
@@ -78,14 +85,34 @@
         }
     }
 }
+
 void SurfaceManager::onWindowAdded(const NewWindow &window)
 {
+    {
+        std::shared_ptr<mir::scene::Surface> surface = window.surface;
+        DEBUG_MSG << " mir::scene::Surface[type=" << mirSurfaceTypeToStr(surface->type())
+            << ",parent=" << (void*)(surface->parent().get())
+            << ",state=" << mirSurfaceStateToStr(surface->state())
+            << ",top_left=" << toQPoint(surface->top_left())
+            << "]";
+    }
+
     auto mirSession = window.windowInfo.window().application();
     SessionInterface* session = m_sessionManager->findSession(mirSession.get());
 
-    auto surface = new MirSurface(window, m_windowController, session);
+    MirSurface *parentSurface;
+    {
+        std::shared_ptr<mir::scene::Surface> surface = window.windowInfo.window();
+        parentSurface = find(surface->parent());
+    }
+
+    auto surface = new MirSurface(window, m_windowController, session, parentSurface);
     rememberMirSurface(surface);
 
+    if (parentSurface) {
+        static_cast<MirSurfaceListModel*>(parentSurface->childSurfaceList())->prependSurface(surface);
+    }
+
     if (session)
         session->registerSurface(surface);
 
@@ -114,6 +141,16 @@
     return nullptr;
 }
 
+MirSurface *SurfaceManager::find(const std::shared_ptr<mir::scene::Surface> &needle) const
+{
+    Q_FOREACH(const auto surface, m_allSurfaces) {
+        if (surface->window() == needle) {
+            return surface;
+        }
+    }
+    return nullptr;
+}
+
 void SurfaceManager::onWindowReady(const miral::WindowInfo &windowInfo)
 {
     if (auto mirSurface = find(windowInfo)) {

=== modified file 'src/modules/Unity/Application/surfacemanager.h'
--- src/modules/Unity/Application/surfacemanager.h	2016-11-29 13:05:57 +0000
+++ src/modules/Unity/Application/surfacemanager.h	2016-11-29 13:05:57 +0000
@@ -61,6 +61,7 @@
     void forgetMirSurface(const miral::Window &window);
     MirSurface* find(const miral::WindowInfo &needle) const;
     MirSurface* find(const miral::Window &needle) const;
+    MirSurface* find(const std::shared_ptr<mir::scene::Surface> &needle) const;
 
     QVector<MirSurface*> m_allSurfaces;
 

=== modified file 'tests/framework/fake_mirsurface.h'
--- tests/framework/fake_mirsurface.h	2016-11-29 13:05:57 +0000
+++ tests/framework/fake_mirsurface.h	2016-11-29 13:05:57 +0000
@@ -79,6 +79,9 @@
     QRect inputBounds() const override { return QRect(0,0,10,10); }
     bool confinesMousePointer() const override { return false; }
 
+    unity::shell::application::MirSurfaceInterface *parentSurface() const override { return nullptr; }
+    unity::shell::application::MirSurfaceListInterface *childSurfaceList() const override { return nullptr; }
+
     void close() override {
         Q_EMIT closeRequested();
     }