QtMir

Merge lp:~dandrader/qtmir/keyState into lp:qtmir

keyState
Merge into trunk

Proposed by Daniel d'Andrada on 2017-03-22

Status:

Superseded

Proposed branch:

lp:~dandrader/qtmir/keyState

Merge into:

lp:qtmir

Prerequisite:

lp:~ci-train-bot/qtmir/qtmir-ubuntu-zesty-2555

Diff against target:

587 lines (+300/-12)

13 files modified

src/common/mirqtconversion.h (+16/-0)
src/common/windowcontrollerinterface.h (+4/-0)
src/modules/Unity/Application/mirsurface.cpp (+107/-4)
src/modules/Unity/Application/mirsurface.h (+24/-0)
src/platforms/mirserver/eventbuilder.h (+1/-1)
src/platforms/mirserver/nativeinterface.cpp (+40/-0)
src/platforms/mirserver/nativeinterface.h (+1/-0)
src/platforms/mirserver/windowcontroller.cpp (+14/-0)
src/platforms/mirserver/windowcontroller.h (+3/-0)
src/platforms/mirserver/windowmanagementpolicy.cpp (+75/-4)
src/platforms/mirserver/windowmanagementpolicy.h (+9/-3)
tests/framework/mock_window_controller.h (+3/-0)
tests/framework/stub_windowcontroller.h (+3/-0)

To merge this branch:

bzr merge lp:~dandrader/qtmir/keyState

High

Fix Released

Link a bug report

Reviewer	Review Type	Date Requested	Status
Unity8 CI Bot (community)	continuous-integration	2017-03-22	Approve on 2017-03-24
Gerry Boland		2017-03-22	Pending
Review via email: mp+320710@code.launchpad.net

This proposal supersedes a proposal from 2017-03-20.

This proposal has been superseded by a proposal from 2017-03-24.

Commit message

Ensure the window that got a key down also gets the corresponding key up

Otherwise it will be left in a inconsistent state (with a pressed key hanging around).

QQuickWindow's input dispatching doesn't guarantee that for its QQuickItem.
So we have to do it ourselves.

This can happen when qml active focus changes in response to a key press.
Eg: client creates a child window in response to a Ctrl+O. By the time the user
releases the Ctrl, active focus will already be in the child window, so the child window
will get the release event instead of the top-level one.

Description of the change

* Are there any related MPs required for this MP to build/function as expected? Please list.
https://code.launchpad.net/~dandrader/unity8/childWindowFocus/+merge/320712

Revision history for this message

Unity8 CI Bot (unity8-ci-bot) wrote on 2017-03-20: Posted in a previous version of this proposal

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Gerry Boland (gerboland) wrote on 2017-03-20: Posted in a previous version of this proposal

If the surface looses active focus, don't we inform Mir? Why not send the key release event then? Would be more efficient than checking on every key_up

Also, please avoid using singleton pattern, it makes testing impossible. And speaking of which, can you add test?

review: Needs Information

Revision history for this message

Daniel d'Andrada (dandrader) wrote on 2017-03-20: Posted in a previous version of this proposal

On 20/03/2017 14:08, Gerry Boland wrote:
> Review: Needs Information
>
> If the surface looses active focus, don't we inform Mir?

It's the other way around. Mir surface focus is what drives qml active
focus. Nowadays qml active focus by itself doesn't carry much meaning in
terms of window management.

> Why not send the key release event then? Would be more efficient than checking on every key_up

Because the key is actually still pressed. If the same window gets focus
again moments later and only then the key is lifted the client would
receive a second key_up event. Unless we keep track of what lies we have
told already to the clients or devise some other special rules.

> Also, please avoid using singleton pattern, it makes testing impossible.

Yeah, that was the easiest (laziest) way to get the two talking (event
feeder and policy). Will see if I can get something nicer. Suggestions?

But before I spend too much time on the implementation details of this
MP I would like to get feedback on the overall approach first.

> And speaking of which, can you add test?

For WindowManagementPolicy?

Revision history for this message

Gerry Boland (gerboland) wrote on 2017-03-21: Posted in a previous version of this proposal

> On 20/03/2017 14:08, Gerry Boland wrote:
> > Review: Needs Information
> >
> > If the surface looses active focus, don't we inform Mir?
>
> It's the other way around. Mir surface focus is what drives qml active
> focus. Nowadays qml active focus by itself doesn't carry much meaning in
> terms of window management.

There are more things in the QML scene that just MirSurfaces that can get activeFocus though. When activeFocus does switch to the search box in the AppDrawer (as example), we are indeed telling Mir somehow that the MirSurface has not got input focus (I just tested gedit, the cursor does stop flashing when the text box in the app drawer is focused). Since this bug occurs due to focus changing while modifier key is down, my initial thinking was we could use the focus change to implement a workaround.

What I don't know is if the WMpolicy if notified when the MirSurface it has selected to be focused has lost actual input focus (activeFocus). Do you know?

> > Why not send the key release event then? Would be more efficient than
> checking on every key_up
>
> Because the key is actually still pressed. If the same window gets focus
> again moments later and only then the key is lifted the client would
> receive a second key_up event. Unless we keep track of what lies we have
> told already to the clients or devise some other special rules.

This appears to be a QML subtlety we're working around, as a non-QML Qt shell would not suffer from this issue, right? So could the MirSurfaceItem keep track of the key state itself? If the MSI looses activeFocus, it send key-release to the client. Then if it gets focus again, check if key is still down (not sure how tbh, maybe QML sends the key to the Item again immediately??), and if so, re-send it to client.

I'm not 100% certain what is the best approach yet.

> > Also, please avoid using singleton pattern, it makes testing impossible.
>
> Yeah, that was the easiest (laziest) way to get the two talking (event
> feeder and policy). Will see if I can get something nicer. Suggestions?

Nothing better than the usual piping an object around, so everyone who needs it gets a pointer to it. Sorry :(

> But before I spend too much time on the implementation details of this
> MP I would like to get feedback on the overall approach first.

Ah ok, I hope I've supplied that at least

>
> > And speaking of which, can you add test?
>
> For WindowManagementPolicy?

More the logic you're adding. But please ignore me until you settle on the approach you want.

> On 20/03/2017 14:08, Gerry Boland wrote:
> > Review: Needs Information
> >
> > If the surface looses active focus, don't we inform Mir?
> 
> It's the other way around. Mir surface focus is what drives qml active
> focus. Nowadays qml active focus by itself doesn't carry much meaning in
> terms of window management.

What I don't know is if the WMpolicy if notified when the MirSurface it has selected to be focused has lost actual input focus (activeFocus). Do you know?

> >   Why not send the key release event then? Would be more efficient than
> checking on every key_up
> 
> Because the key is actually still pressed. If the same window gets focus
> again moments later and only then the key is lifted the client would
> receive a second key_up event. Unless we keep track of what lies we have
> told already to the clients or devise some other special rules.

I'm not 100% certain what is the best approach yet.

> > Also, please avoid using singleton pattern, it makes testing impossible.
> 
> Yeah, that was the easiest (laziest) way to get the two talking (event
> feeder and policy). Will see if I can get something nicer. Suggestions?

Nothing better than the usual piping an object around, so everyone who needs it gets a pointer to it. Sorry :(

> But before I spend too much time on the implementation details of this
> MP I would like to get feedback on the overall approach first.

Ah ok, I hope I've supplied that at least

> 
> > And speaking of which, can you add test?
> 
> For WindowManagementPolicy?

More the logic you're adding. But please ignore me until you settle on the approach you want.

Revision history for this message

Daniel d'Andrada (dandrader) wrote on 2017-03-21: Posted in a previous version of this proposal

On 21/03/2017 09:37, Gerry Boland wrote:
> This appears to be a QML subtlety we're working around, as a non-QML Qt shell would not suffer from this issue, right?

Yes. As I said, QQuickWindow input dispatching not perfectly suited for
shells.

> So could the MirSurfaceItem keep track of the key state itself?
Sure.

> If the MSI looses activeFocus, it send key-release to the client. Then if it gets focus again, check if key is still down (not sure how tbh, maybe QML sends the key to the Item again immediately??), and if so, re-send it to client.

It can't check the key state, but it can ignore a key-up for a key that
it didn't tell its surface it was down (because lied or whatever).

> I'm not 100% certain what is the best approach yet.

Working around QQuickWindow input dispatching will never be beautiful. So, should I go for the MirSurfaceItem-based key filtering/manipulation?

I'm fine either way. I put in the policy to avoid sending fake input to clients and as a general rule-of-thumb of "putting things in the miral policy"/"keep the policy in the loop".

Revision history for this message

Gerry Boland (gerboland) wrote on 2017-03-22: Posted in a previous version of this proposal

I think I'd prefer using MirSurfaceItem-based key filtering. Since it's working around the QQuickWindow/QML problem, it makes sense to me to confine the workaround in code only used in code exposed to QQuickWindow/QML.

Revision history for this message

Unity8 CI Bot (unity8-ci-bot) wrote on 2017-03-22:

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Gerry Boland (gerboland) wrote on 2017-03-23:

+++ src/modules/Unity/Application/mirsurface.h
Could you move the implementation of the PressedKey constructor into the cpp file please, it is big enough a header file.

+++ src/modules/Unity/Application/mirsurface.cpp
You're using QElapsedTimer to get the current value of the monotonic clock, yes? If so, we really only need one QElapsedTimer everywhere, so could make it static singeton and add a static function that calls msecsSinceReference on it and returns the val. wdyt?

Code makes sense, I just need to test. It does need a big comment explaining why we're doing this though. Do the QtWayland guys have the same issue, wonder if they do a similar fix or not...

Revision history for this message

Daniel d'Andrada (dandrader) wrote on 2017-03-23:

> +++ src/modules/Unity/Application/mirsurface.h
> Could you move the implementation of the PressedKey constructor into the cpp
> file please, it is big enough a header file.

Done.

>
> +++ src/modules/Unity/Application/mirsurface.cpp
> You're using QElapsedTimer to get the current value of the monotonic clock,
> yes? If so, we really only need one QElapsedTimer everywhere, so could make it
> static singeton and add a static function that calls msecsSinceReference on it
> and returns the val. wdyt?

Right. Done.

> Code makes sense, I just need to test. It does need a big comment explaining
> why we're doing this though. Do the QtWayland guys have the same issue, wonder
> if they do a similar fix or not...

Added a big fat comment.

Revision history for this message

Unity8 CI Bot (unity8-ci-bot) wrote on 2017-03-23:

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Unity8 CI Bot (unity8-ci-bot) wrote on 2017-03-24:

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Unity8 CI Bot (unity8-ci-bot) wrote on 2017-03-24:

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

review: Approve (continuous-integration)

lp:~dandrader/qtmir/keyState updated on 2017-03-24

626. By Daniel d'Andrada on 2017-03-24

merge lp:~gerboland/qtmir/availableDesktopAreaTrial

627. By Daniel d'Andrada on 2017-03-24

Ensure the window that got a key down also gets the corresponding key up

Otherwise it will be left in a inconsistent state (with a pressed key hanging around).

QQuickWindow's input dispatching doesn't guarantee that for its QQuickItem.
So we have to do it ourselves.

628. By Daniel d'Andrada on 2017-03-24

Some refactoring as per review feedback

629. By Daniel d'Andrada on 2017-03-24

update copyright header

Unmerged revisions

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Daniel d'Andrada

Mir development team

 === modified file 'src/common/mirqtconversion.h'
 --- src/common/mirqtconversion.h	2017-02-07 15:02:20 +0000
 +++ src/common/mirqtconversion.h	2017-03-24 13:53:28 +0000
@@ -113,6 +113,22 @@
+     }
+ }
++inline MirWindowType toMirType(Mir::Type type)
++{
++    switch (type) {
++    case Mir::NormalType:         return mir_window_type_normal;
++    case Mir::UtilityType:        return mir_window_type_utility;
++    case Mir::DialogType:         return mir_window_type_dialog;
++    case Mir::GlossType:          return mir_window_type_gloss;
++    case Mir::FreeStyleType:      return mir_window_type_freestyle;
++    case Mir::MenuType:           return mir_window_type_menu;
++    case Mir::InputMethodType:    return mir_window_type_inputmethod;
++    case Mir::SatelliteType:      return mir_window_type_satellite;
++    case Mir::TipType:            return mir_window_type_tip;
++    default: Q_UNREACHABLE();
++    }
++}
++
  inline Mir::ShellChrome toQtShellChrome(MirShellChrome chrome)
+ {
      switch (chrome) {
 === modified file 'src/common/windowcontrollerinterface.h'
 --- src/common/windowcontrollerinterface.h	2016-11-03 20:17:46 +0000
 +++ src/common/windowcontrollerinterface.h	2017-03-24 13:53:28 +0000
@@ -23,6 +23,7 @@
  #include <QPoint>
  #include <QSize>
++#include <QMargins>
  // Unity API
  #include <unity/shell/application/Mir.h>
@@ -51,6 +52,9 @@
      virtual void deliverKeyboardEvent(const miral::Window &window, const MirKeyboardEvent *event) = 0;
      virtual void deliverTouchEvent   (const miral::Window &window, const MirTouchEvent *event) = 0;
      virtual void deliverPointerEvent (const miral::Window &window, const MirPointerEvent *event) = 0;
++
++    virtual void setWindowConfinementRegions(const QVector<QRect> &regions) = 0;
++    virtual void setWindowMargins(Mir::Type windowType, const QMargins &margins) = 0;
  };
  } // namespace qtmir
 === modified file 'src/modules/Unity/Application/mirsurface.cpp'
 --- src/modules/Unity/Application/mirsurface.cpp	2017-03-20 21:15:13 +0000
 +++ src/modules/Unity/Application/mirsurface.cpp	2017-03-24 13:53:28 +0000
@@ -70,6 +70,9 @@
  } // namespace {
++
++QElapsedTimer MirSurface::m_elapsedTimer;
++
  class MirSurface::SurfaceObserverImpl : public SurfaceObserver, public mir::scene::SurfaceObserver
+ {
  public:
@@ -409,6 +412,25 @@
      m_focused = value;
      Q_EMIT focusedChanged(value);
++
++    if (m_focused) {
++        /*
++            Ensure the window that got a key down also gets the corresponding key up
++
++            Otherwise it will be left in a inconsistent state (with a pressed key hanging around).
++
++            QQuickWindow's input dispatching doesn't guarantee that for its QQuickItems.
++            So we have to do it ourselves.
++
++            This can happen when qml active focus changes in response to a key press.
++            Eg: client creates a child window in response to a Ctrl+O. By the time the user
++            releases the Ctrl, active focus will already be in the child window, so the child window
++            will get the release event instead of the top-level one. To solve this, once the top-level
++            window gets active focus again, we synthesize KeyRelease events for all keys this window
++            thinks are still pressed.
++        */
++        releaseAllPressedKeys();
++    }
+ }
  void MirSurface::setViewActiveFocus(qintptr viewId, bool value)
@@ -508,6 +530,13 @@
      if (m_position != newPosition) {
          m_position = newPosition;
          Q_EMIT positionChanged(newPosition);
++
++        // Parent might have moved but children might stay put (in display coords). This
++        // means different local child coords, hence the need to update them.
++        for (int i = 0; i < m_childSurfaceList->count(); ++i) {
++            auto childSurface = static_cast<MirSurface*>(m_childSurfaceList->get(i));
++            childSurface->updatePosition();
++        }
+     }
+ }
@@ -654,6 +683,18 @@
  void MirSurface::keyPressEvent(QKeyEvent *qtEvent)
+ {
++    {
++        if (!qtEvent->isAutoRepeat()) {
++            Q_ASSERT(!isKeyPressed(qtEvent->nativeVirtualKey()));
++            PressedKey pressedKey(qtEvent, msecsSinceReference());
++            auto info = EventBuilder::instance()->findInfo(qtEvent->timestamp());
++            if (info) {
++                pressedKey.deviceId = info->deviceId;
++            }
++            m_pressedKeys.append(std::move(pressedKey));
++        }
++    }
++
      auto ev = EventBuilder::instance()->makeMirEvent(qtEvent);
      auto ev1 = reinterpret_cast<MirKeyboardEvent const*>(ev.get());
      m_controller->deliverKeyboardEvent(m_window, ev1);
@@ -662,10 +703,14 @@
  void MirSurface::keyReleaseEvent(QKeyEvent *qtEvent)
+ {
--    auto ev = EventBuilder::instance()->makeMirEvent(qtEvent);
--    auto ev1 = reinterpret_cast<MirKeyboardEvent const*>(ev.get());
--    m_controller->deliverKeyboardEvent(m_window, ev1);
--    qtEvent->accept();
++    if (isKeyPressed(qtEvent->nativeVirtualKey())) {
++        forgetPressedKey(qtEvent->nativeVirtualKey());
++        auto ev = EventBuilder::instance()->makeMirEvent(qtEvent);
++        auto ev1 = reinterpret_cast<MirKeyboardEvent const*>(ev.get());
++        m_controller->deliverKeyboardEvent(m_window, ev1);
++    } else {
++        // don't send a release event for a key for which we did not send a press in the first place
++    }
+ }
  void MirSurface::touchEvent(Qt::KeyboardModifiers mods,
@@ -1251,3 +1296,61 @@
+ {
      return m_childSurfaceList;
+ }
++
++void MirSurface::updatePosition()
++{
++    QPoint point(m_surface->top_left().x.as_int(),m_surface->top_left().y.as_int());
++    setPosition(point);
++}
++
++bool MirSurface::isKeyPressed(quint32 nativeVirtualKey) const
++{
++    for (const auto &pressedKey : m_pressedKeys) {
++        if (pressedKey.nativeVirtualKey == nativeVirtualKey) {
++            return true;
++        }
++    }
++    return false;
++}
++
++void MirSurface::forgetPressedKey(quint32 nativeVirtualKey)
++{
++    for (int i = 0; i < m_pressedKeys.count(); ++i) {
++        if (m_pressedKeys[i].nativeVirtualKey == nativeVirtualKey) {
++            m_pressedKeys.removeAt(i);
++            return;
++        }
++    }
++}
++
++void MirSurface::releaseAllPressedKeys()
++{
++    for (auto &pressedKey : m_pressedKeys) {
++        auto deltaMs = (ulong)(msecsSinceReference() - pressedKey.msecsSinceReference);
++        ulong timestamp = pressedKey.timestamp + deltaMs;
++        std::vector<uint8_t> cookie{};
++
++        auto ev = mir::events::make_event(pressedKey.deviceId,
++                uncompressTimestamp<qtmir::Timestamp>(qtmir::Timestamp(timestamp)),
++                cookie, mir_keyboard_action_up, pressedKey.nativeVirtualKey, pressedKey.nativeScanCode,
++                mir_input_event_modifier_none);
++
++        auto ev1 = reinterpret_cast<MirKeyboardEvent const*>(ev.get());
++        m_controller->deliverKeyboardEvent(m_window, ev1);
++    }
++    m_pressedKeys.clear();
++}
++
++qint64 MirSurface::msecsSinceReference()
++{
++    m_elapsedTimer.start();
++    return m_elapsedTimer.msecsSinceReference();
++}
++
++MirSurface::PressedKey::PressedKey(QKeyEvent *qtEvent, qint64 msecsSinceReference)
++    : nativeVirtualKey(qtEvent->nativeVirtualKey())
++    , nativeScanCode(qtEvent->nativeScanCode())
++    , timestamp(qtEvent->timestamp())
++    , msecsSinceReference(msecsSinceReference)
++{
++}
 === modified file 'src/modules/Unity/Application/mirsurface.h'
 --- src/modules/Unity/Application/mirsurface.h	2017-03-20 21:15:13 +0000
 +++ src/modules/Unity/Application/mirsurface.h	2017-03-24 13:53:28 +0000
@@ -22,6 +22,7 @@
  // Qt
  #include <QCursor>
++#include <QElapsedTimer>
  #include <QMutex>
  #include <QPointer>
  #include <QRect>
@@ -29,6 +30,8 @@
  #include <QWeakPointer>
  #include <QSet>
  #include <QTimer>
++#include <QVector>
++#include <QKeyEvent>
  #include "mirbuffersgtexture.h"
  #include "windowcontrollerinterface.h"
@@ -212,6 +215,13 @@
      void onHeightIncrementChanged(int incHeight);
      QPoint convertDisplayToLocalCoords(const QPoint &displayPos) const;
      QPoint convertLocalToDisplayCoords(const QPoint &localPos) const;
++    void updatePosition();
++
++    // Handling of missing key release events from Qt
++    bool isKeyPressed(quint32 nativeVirtualKey) const;
++    void forgetPressedKey(quint32 nativeVirtualKey);
++    void releaseAllPressedKeys();
++    static qint64 msecsSinceReference();
      const miral::Window m_window;
      const std::shared_ptr<ExtraWindowInfo> m_extraInfo;
@@ -280,6 +290,20 @@
      MirSurface *m_parentSurface;
      MirSurfaceListModel *m_childSurfaceList;
++
++    // Track all keys that we told our mir window are currently pressed
++    struct PressedKey {
++        PressedKey() {}
++        PressedKey(QKeyEvent *qtEvent, qint64 msecsSinceReference);
++        quint32 nativeVirtualKey{0};
++        quint32 nativeScanCode{0};
++        ulong timestamp{0};
++        MirInputDeviceId deviceId{0};
++        qint64 msecsSinceReference{0};
++    };
++    QVector<PressedKey> m_pressedKeys;
++
++    static QElapsedTimer m_elapsedTimer;
  };
  } // namespace qtmir
 === modified file 'src/platforms/mirserver/eventbuilder.h'
 --- src/platforms/mirserver/eventbuilder.h	2017-03-03 10:39:24 +0000
 +++ src/platforms/mirserver/eventbuilder.h	2017-03-24 13:53:28 +0000
@@ -69,7 +69,6 @@
                                  const QList<QTouchEvent::TouchPoint> &qtTouchPoints,
                                  Qt::TouchPointStates /* qtTouchPointStates */,
                                  ulong qtTimestamp);
--private:
      class EventInfo {
      public:
          void store(const MirInputEvent *mirInputEvent, ulong qtTimestamp);
@@ -82,6 +81,7 @@
      EventInfo *findInfo(ulong qtTimestamp);
++private:
      mir::EventUPtr makeMirEvent(QInputEvent *qtEvent, int x, int y, MirPointerButtons buttons);
 === modified file 'src/platforms/mirserver/nativeinterface.cpp'
 --- src/platforms/mirserver/nativeinterface.cpp	2016-11-03 20:17:46 +0000
 +++ src/platforms/mirserver/nativeinterface.cpp	2017-03-24 13:53:28 +0000
@@ -18,6 +18,9 @@
  #include "qmirserver.h"
  #include "screen.h"
++#include "windowcontrollerinterface.h"
++
++#include <QDebug>
  NativeInterface::NativeInterface(QMirServer *server)
      : m_qMirServer(server)
@@ -73,6 +76,43 @@
+     }
+ }
++void NativeInterface::setWindowProperty(QPlatformWindow */*window*/, const QString &name, const QVariant &value)
++{
++    if (name.isNull()) {
++        return;
++    }
++
++    // TODO remove this hack and expose this properly when QtMir can share WindowController in a C++ header
++
++    // Get WindowController
++    auto windowController = static_cast<qtmir::WindowControllerInterface *>(m_qMirServer->nativeResourceForIntegration("WindowController"));
++
++    if (name == QStringLiteral("availableDesktopArea")) {
++        QRect rect = value.toRect();
++        if (rect.isValid()) {
++            windowController->setWindowConfinementRegions({rect});
++        } else {
++            qWarning().nospace() << "NativeInterface::setWindowProperty("
++                << name << "," << value << ") - value is not a QRect";
++       }
++    } else if (name.endsWith(QStringLiteral("WindowMargins"))) {
++        if (value.canConvert(QMetaType::QRect)) {
++            QRect rect = value.toRect();
++            QMargins margin(rect.x(), rect.y(), rect.width(), rect.height());
++            if (name == QStringLiteral("normalWindowMargins")) {
++                windowController->setWindowMargins(Mir::NormalType, margin);
++            } else if (name == QStringLiteral("dialogWindowMargins")) {
++                windowController->setWindowMargins(Mir::DialogType, margin);
++            } else {
++                qWarning() << "NativeInterface::setWindowProperty missing support for:" << name;
++            }
++        } else {
++            qWarning().nospace() << "NativeInterface::setWindowProperty("
++                << name << "," << value << ") - value is not a QRect";
++        }
++    }
++}
++
  std::shared_ptr<qtmir::PromptSessionManager> NativeInterface::thePromptSessionManager() const
+ {
      return m_qMirServer->thePromptSessionManager();
 === modified file 'src/platforms/mirserver/nativeinterface.h'
 --- src/platforms/mirserver/nativeinterface.h	2016-11-03 20:17:46 +0000
 +++ src/platforms/mirserver/nativeinterface.h	2017-03-24 13:53:28 +0000
@@ -41,6 +41,7 @@
      QVariantMap windowProperties(QPlatformWindow *window) const override;
      QVariant windowProperty(QPlatformWindow *window, const QString &name) const override;
      QVariant windowProperty(QPlatformWindow *window, const QString &name, const QVariant &defaultValue) const override;
++    void setWindowProperty(QPlatformWindow *, const QString &name, const QVariant &value) override;
      std::shared_ptr<qtmir::PromptSessionManager> thePromptSessionManager() const;
      std::shared_ptr<mir::shell::PersistentSurfaceStore> thePersistentSurfaceStore() const;
 === modified file 'src/platforms/mirserver/windowcontroller.cpp'
 --- src/platforms/mirserver/windowcontroller.cpp	2016-11-03 20:17:46 +0000
 +++ src/platforms/mirserver/windowcontroller.cpp	2017-03-24 13:53:28 +0000
@@ -97,6 +97,20 @@
+     }
+ }
++void WindowController::setWindowConfinementRegions(const QVector<QRect> &regions)
++{
++    if (m_policy) {
++        m_policy->set_window_confinement_regions(regions);
++    }
++}
++
++void WindowController::setWindowMargins(Mir::Type windowType, const QMargins &margins)
++{
++    if (m_policy) {
++        m_policy->set_window_margins(toMirType(windowType), margins);
++    }
++}
++
  void WindowController::setPolicy(WindowManagementPolicy * const policy)
+ {
      m_policy = policy;
 === modified file 'src/platforms/mirserver/windowcontroller.h'
 --- src/platforms/mirserver/windowcontroller.h	2016-11-03 20:17:46 +0000
 +++ src/platforms/mirserver/windowcontroller.h	2017-03-24 13:53:28 +0000
@@ -43,6 +43,9 @@
      void deliverTouchEvent   (const miral::Window &window, const MirTouchEvent *event) override;
      void deliverPointerEvent (const miral::Window &window, const MirPointerEvent *event) override;
++    void setWindowConfinementRegions(const QVector<QRect> &regions) override;
++    void setWindowMargins(Mir::Type windowType, const QMargins &margins) override;
++
      void setPolicy(WindowManagementPolicy *policy);
  protected:
 === modified file 'src/platforms/mirserver/windowmanagementpolicy.cpp'
 --- src/platforms/mirserver/windowmanagementpolicy.cpp	2017-03-08 13:27:33 +0000
 +++ src/platforms/mirserver/windowmanagementpolicy.cpp	2017-03-24 13:53:28 +0000
@@ -27,8 +27,6 @@
  #include "mirqtconversion.h"
  #include "tracepoints.h"
--#include <QDebug>
--
  namespace qtmir {
      std::shared_ptr<ExtraWindowInfo> getExtraInfo(const miral::WindowInfo &windowInfo) {
          return std::static_pointer_cast<ExtraWindowInfo>(windowInfo.userdata());
@@ -36,7 +34,6 @@
+ }
  using namespace qtmir;
--using namespace mir::geometry;
  WindowManagementPolicy::WindowManagementPolicy(const miral::WindowManagerTools &tools,
                                                 qtmir::WindowModelNotifier &windowModel,
@@ -69,7 +66,7 @@
          QSize initialSize = InitialSurfaceSizes::get(miral::pid_of(appInfo.application()));
          if (initialSize.isValid() && surfaceType == mir_surface_type_normal) {
--            parameters.size() = Size{Width(initialSize.width()), Height(initialSize.height())};
++            parameters.size() = toMirSize(initialSize);
+         }
+     }
@@ -227,6 +224,19 @@
      });
+ }
++QRect WindowManagementPolicy::getConfinementRect(const QRect rect) const
++{
++    QRect confinementRect;
++    for (const QRect r : m_confinementRegions) {
++        if (r.intersects(rect)) {
++            confinementRect = r;
++            // TODO: What if there are multiple confinement regions and they intersect??
++            break;
++        }
++    }
++    return confinementRect;
++}
++
  /* Following methods all called from the Qt GUI thread to deliver events to clients */
  void WindowManagementPolicy::deliver_keyboard_event(const MirKeyboardEvent *event,
                                                      const miral::Window &window)
@@ -330,6 +340,20 @@
      });
+ }
++void WindowManagementPolicy::set_window_confinement_regions(const QVector<QRect> &regions)
++{
++    m_confinementRegions = regions;
++
++    // TODO: update window positions to respect new boundary.
++}
++
++void WindowManagementPolicy::set_window_margins(MirWindowType windowType, const QMargins &margins)
++{
++    m_windowMargins[windowType] = margins;
++
++    // TODO: update window positions/sizes to respect new margins.
++}
++
  void WindowManagementPolicy::requestState(const miral::Window &window, const Mir::State state)
+ {
      auto &windowInfo = m_tools.info_for(window);
@@ -354,3 +378,50 @@
          });
+     }
+ }
++
++Rectangle WindowManagementPolicy::confirm_inherited_move(miral::WindowInfo const& windowInfo, Displacement movement)
++{
++    if (m_confinementRegions.isEmpty()) {
++        return CanonicalWindowManagerPolicy::confirm_inherited_move(windowInfo, movement);
++    }
++
++    auto window = windowInfo.window();
++    const QMargins windowMargins = m_windowMargins[windowInfo.type()];
++    QRect windowGeom(toQPoint(window.top_left()), toQSize(window.size()));
++
++    QRect geom = windowGeom.marginsAdded(windowMargins);
++    const QRect confinementRect = getConfinementRect(geom);
++
++    int x = geom.x();
++    int y = geom.y();
++    int moveX = movement.dx.as_int();
++    int moveY = movement.dy.as_int();
++
++    // If the child window is already partially beyond the available desktop area (most likely because the user
++    // explicitly moved it there) we won't pull it back, unless the inherited movement is this direction, but also won't
++    // push it even further astray. But if it currently is completely within the available desktop area boundaries
++    // we won't let go beyond it.
++
++    if (moveX > 0) {
++        if (geom.right() < confinementRect.right()) {
++            x = qMin(x + moveX, confinementRect.right() + 1 - geom.width()); // +1 because QRect::right() weird
++        }
++    } else {
++        if (geom.x() > confinementRect.left()) {
++            x = qMax(x + moveX, confinementRect.left());
++        }
++    }
++
++    if (moveY > 0) {
++        if (geom.bottom() < confinementRect.bottom()) {
++            y = qMin(y + moveY, confinementRect.bottom() + 1 - geom.height()); // +1 because QRect::bottom() weird
++        }
++    } else {
++        if (geom.y() > confinementRect.top()) {
++            y = qMax(y + moveY, confinementRect.top());
++        }
++    }
++
++    geom.moveTo(x, y);
++    return toMirRectangle(geom.marginsRemoved(windowMargins));
++}
 === modified file 'src/platforms/mirserver/windowmanagementpolicy.h'
 --- src/platforms/mirserver/windowmanagementpolicy.h	2017-02-06 09:10:20 +0000
 +++ src/platforms/mirserver/windowmanagementpolicy.h	2017-03-24 13:53:28 +0000
@@ -1,5 +1,5 @@
  /*
-- * Copyright (C) 2016 Canonical, Ltd.
++ * Copyright (C) 2016-2017 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
@@ -25,7 +25,6 @@
  #include "windowmodelnotifier.h"
  #include <QScopedPointer>
--#include <QSize>
  using namespace mir::geometry;
@@ -70,6 +69,9 @@
      void advise_delete_window(const miral::WindowInfo &windowInfo) override;
      void advise_raise(const std::vector<miral::Window> &windows) override;
++    Rectangle confirm_inherited_move(miral::WindowInfo const& windowInfo, Displacement movement) override;
++
++
      // Methods for consumption by WindowControllerInterface
      void deliver_keyboard_event(const MirKeyboardEvent *event, const miral::Window &window);
      void deliver_touch_event   (const MirTouchEvent *event,    const miral::Window &window);
@@ -84,15 +86,19 @@
      void ask_client_to_close(const miral::Window &window);
      void forceClose(const miral::Window &window);
--Q_SIGNALS:
++    void set_window_confinement_regions(const QVector<QRect> &regions);
++    void set_window_margins(MirWindowType windowType, const QMargins &margins);
  private:
      void ensureWindowIsActive(const miral::Window &window);
++    QRect getConfinementRect(const QRect rect) const;
      miral::WindowManagerTools m_tools;
      qtmir::WindowModelNotifier &m_windowModel;
      qtmir::AppNotifier &m_appNotifier;
      const QScopedPointer<QtEventFeeder> m_eventFeeder;
++    QVector<QRect> m_confinementRegions;
++    QMargins m_windowMargins[mir_window_types];
  };
  #endif // WINDOWMANAGEMENTPOLICY_H
 === modified file 'tests/framework/mock_window_controller.h'
 --- tests/framework/mock_window_controller.h	2017-03-20 16:19:42 +0000
 +++ tests/framework/mock_window_controller.h	2017-03-24 13:53:28 +0000
@@ -38,6 +38,9 @@
      MOCK_METHOD2(deliverKeyboardEvent, void(const miral::Window &, const MirKeyboardEvent *));
      MOCK_METHOD2(deliverTouchEvent,    void(const miral::Window &, const MirTouchEvent *));
      MOCK_METHOD2(deliverPointerEvent,  void(const miral::Window &, const MirPointerEvent *));
++
++    MOCK_METHOD1(setWindowConfinementRegions, void(const QVector<QRect> &regions));
++    MOCK_METHOD2(setWindowMargins, void(Mir::Type windowType, const QMargins &margins));
  };
  #endif // MOCK_WINDOW_CONTROLLER_H
 === modified file 'tests/framework/stub_windowcontroller.h'
 --- tests/framework/stub_windowcontroller.h	2016-11-03 20:17:46 +0000
 +++ tests/framework/stub_windowcontroller.h	2017-03-24 13:53:28 +0000
@@ -37,6 +37,9 @@
      void deliverKeyboardEvent(const miral::Window &/*window*/, const MirKeyboardEvent */*event*/) override { return; }
      void deliverTouchEvent   (const miral::Window &/*window*/, const MirTouchEvent */*event*/)    override { return; }
      void deliverPointerEvent (const miral::Window &/*window*/, const MirPointerEvent */*event*/)  override { return; }
++
++    void setWindowConfinementRegions(const QVector<QRect> &/*regions*/) override { return; }
++    void setWindowMargins(Mir::Type /*windowType*/, const QMargins &/*margins*/) override { return; }
  };
  } //namespace qtmir