Merge lp:~gerboland/miral/add-input-method-to-window-model into lp:miral

[Gerry Boland]

[miral-qt] Add inputMethodSurface property to WindowManager

[Alan Griffiths (alan-griffiths)]

Looks good (modulo discussion in prerequisite)

review: Approve

=== modified file 'miral-qt/src/common/windowmodelnotifierinterface.h'
--- miral-qt/src/common/windowmodelnotifierinterface.h	2016-09-08 14:00:59 +0000
+++ miral-qt/src/common/windowmodelnotifierinterface.h	2016-09-08 23:46:50 +0000
@@ -91,6 +91,10 @@
     void windowInfoChanged(const qtmir::WindowInfo, const int index);
     void windowsRaised(const QVector<int> indices);
 
+    // Assuming only 1 input method surface for now
+    void inputMethodWindowAdded(const qtmir::NewWindow);
+    void inputMethodWindowRemoved();
+
 private:
     Q_DISABLE_COPY(WindowModelNotifierInterface)
 };

=== modified file 'miral-qt/src/modules/Unity/Application/windowmodel.cpp'
--- miral-qt/src/modules/Unity/Application/windowmodel.cpp	2016-09-08 14:00:59 +0000
+++ miral-qt/src/modules/Unity/Application/windowmodel.cpp	2016-09-08 23:46:50 +0000
@@ -30,7 +30,6 @@
 using namespace qtmir;
 
 WindowModel::WindowModel()
-    : m_focusedWindow(nullptr)
 {
     auto nativeInterface = dynamic_cast<NativeInterface*>(QGuiApplication::platformNativeInterface());
 
@@ -60,6 +59,10 @@
     connect(notifier, &WindowModelNotifierInterface::windowFocused,     this, &WindowModel::onWindowFocused,     Qt::QueuedConnection);
     connect(notifier, &WindowModelNotifierInterface::windowInfoChanged, this, &WindowModel::onWindowInfoChanged, Qt::QueuedConnection);
     connect(notifier, &WindowModelNotifierInterface::windowsRaised,     this, &WindowModel::onWindowsRaised,     Qt::QueuedConnection);
+    connect(notifier, &WindowModelNotifierInterface::inputMethodWindowAdded,
+            this, &WindowModel::onInputMethodWindowAdded,     Qt::QueuedConnection);
+    connect(notifier, &WindowModelNotifierInterface::inputMethodWindowRemoved,
+            this, &WindowModel::onInputMethodWindowRemoved,   Qt::QueuedConnection);
 }
 
 QHash<int, QByteArray> WindowModel::roleNames() const
@@ -120,6 +123,25 @@
     Q_EMIT dataChanged(row, row, QVector<int>() << SurfaceRole);
 }
 
+void WindowModel::onInputMethodWindowAdded(const NewWindow windowInfo)
+{
+    if (m_inputMethodSurface) {
+        qDebug("Multiple Input Method Surfaces created, removing the old one!");
+        delete m_inputMethodSurface;
+    }
+    m_inputMethodSurface = new MirSurface(windowInfo, m_windowController);
+    Q_EMIT inputMethodSurfaceChanged(m_inputMethodSurface);
+}
+
+void WindowModel::onInputMethodWindowRemoved()
+{
+    if (m_inputMethodSurface) {
+        delete m_inputMethodSurface;
+        m_inputMethodSurface = nullptr;
+        Q_EMIT inputMethodSurfaceChanged(m_inputMethodSurface);
+    }
+}
+
 void WindowModel::onWindowsRaised(QVector<int> indices)
 {
     const int modelCount = m_windowModel.count();

=== modified file 'miral-qt/src/modules/Unity/Application/windowmodel.h'
--- miral-qt/src/modules/Unity/Application/windowmodel.h	2016-09-08 14:00:59 +0000
+++ miral-qt/src/modules/Unity/Application/windowmodel.h	2016-09-08 23:46:50 +0000
@@ -32,6 +32,8 @@
 
     Q_PROPERTY(int count READ count NOTIFY countChanged)
 
+    Q_PROPERTY(MirSurfaceInterface* inputMethodSurface READ inputMethodSurface NOTIFY inputMethodSurfaceChanged)
+
 public:
     enum Roles {
         SurfaceRole = Qt::UserRole
@@ -49,8 +51,11 @@
 
     int count() const { return rowCount(); }
 
+    MirSurfaceInterface* inputMethodSurface() const { return m_inputMethodSurface; }
+
 Q_SIGNALS:
     void countChanged();
+    void inputMethodSurfaceChanged(MirSurfaceInterface* inputMethodSurface);
 
 private Q_SLOTS:
     void onWindowAdded(const NewWindow windowInfo, const int index);
@@ -61,12 +66,16 @@
     void onWindowInfoChanged(const WindowInfo windowInfo, const int index);
     void onWindowsRaised(const QVector<int> indices);
 
+    void onInputMethodWindowAdded(const NewWindow windowInfo);
+    void onInputMethodWindowRemoved();
+
 private:
     void connectToWindowModelNotifier(WindowModelNotifierInterface *notifier);
 
     QVector<MirSurfaceInterface *> m_windowModel;
     WindowControllerInterface *m_windowController;
-    MirSurfaceInterface* m_focusedWindow;
+    MirSurfaceInterface* m_focusedWindow{nullptr};
+    MirSurfaceInterface* m_inputMethodSurface{nullptr};
 };
 
 } // namespace qtmir

=== modified file 'miral-qt/src/platforms/mirserver/windowmodelnotifier.cpp'
--- miral-qt/src/platforms/mirserver/windowmodelnotifier.cpp	2016-09-08 14:00:59 +0000
+++ miral-qt/src/platforms/mirserver/windowmodelnotifier.cpp	2016-09-08 23:46:50 +0000
@@ -43,6 +43,12 @@
 
 void WindowModelNotifier::addWindow(const miral::WindowInfo &windowInfo, const std::string &persistentId)
 {
+    if (windowInfo.type() == mir_surface_type_inputmethod) {
+        NewWindow newWindowInfo{windowInfo};
+        Q_EMIT inputMethodWindowAdded(newWindowInfo);
+        return;
+    }
+
     auto stackPosition = m_windowStack.count();
     m_windowStack.push_back(windowInfo.window()); // ASSUMPTION: Mir should tell us where in stack
 
@@ -52,6 +58,11 @@
 
 void WindowModelNotifier::removeWindow(const miral::WindowInfo &windowInfo)
 {
+    if (windowInfo.type() == mir_surface_type_inputmethod) {
+        Q_EMIT inputMethodWindowRemoved();
+        return;
+    }
+
     const int pos = m_windowStack.indexOf(windowInfo.window());
     if (pos < 0) {
         qDebug("Unknown window removed");

=== modified file 'miral-qt/tests/modules/WindowManager/windowmodel_test.cpp'
--- miral-qt/tests/modules/WindowManager/windowmodel_test.cpp	2016-09-08 23:46:50 +0000
+++ miral-qt/tests/modules/WindowManager/windowmodel_test.cpp	2016-09-08 23:46:50 +0000
@@ -69,6 +69,16 @@
         return miral::WindowInfo{window, windowSpec};
     }
 
+    miral::WindowInfo createMirALWindowInfoForInputMethod()
+    {
+        const miral::Application app{stubSession};
+        const miral::Window window{app, stubSurface};
+
+        ms::SurfaceCreationParameters windowSpec;
+        windowSpec.of_type(mir_surface_type_inputmethod);
+        return miral::WindowInfo{window, windowSpec};
+    }
+
     MirSurface *getMirSurfaceFromModel(const WindowModel &model, int index)
     {
         flushEvents();
@@ -672,3 +682,59 @@
     // Ensure other window untouched
     EXPECT_EQ(fixedSize, surface->size());
 }
+
+/*
+ * Test: that the WindowModelNotifier.addWindow for an Input Method Window causes
+ * the Qt-side WindowModel to register the input method surface
+ */
+TEST_F(WindowModelTest, WhenAddInputMethodWindowNotifiedModelEmitsInputMethodChangedSignal)
+{
+    WindowModelNotifier notifier;
+    WindowModel model(&notifier, nullptr); // no need for controller in this testcase
+
+    auto mirWindowInfo = createMirALWindowInfoForInputMethod();
+
+    QSignalSpy spyCountChanged(&model, SIGNAL(inputMethodSurfaceChanged(MirSurfaceInterface*)));
+
+    notifier.addWindow(mirWindowInfo);
+    flushEvents();
+
+    EXPECT_EQ(1, spyCountChanged.count());
+}
+
+/*
+ * Test: that the WindowModelNotifier.addWindow for an Input Method Window causes
+ * the Qt-side WindowModel::inputMethodSurface property to be correctly set
+ */
+TEST_F(WindowModelTest, WhenAddInputMethodWindowNotifiedModelPropertyHasCorrectWindow)
+{
+    WindowModelNotifier notifier;
+    WindowModel model(&notifier, nullptr); // no need for controller in this testcase
+
+    auto mirWindowInfo = createMirALWindowInfoForInputMethod();
+
+    notifier.addWindow(mirWindowInfo);
+    flushEvents();
+
+    auto miralWindow = static_cast<MirSurface*>(model.inputMethodSurface())->window();
+    EXPECT_EQ(mirWindowInfo.window(), miralWindow);
+}
+
+/*
+ * Test: that the WindowModelNotifier.removeWindow for an Input Method Window causes
+ * the Qt-side WindowModel to reset the WindowModel::inputMethodSurface property to null
+ */
+TEST_F(WindowModelTest, WhenRemoveInputMethodWindowNotifiedModelPropertyReset)
+{
+    WindowModelNotifier notifier;
+    WindowModel model(&notifier, nullptr); // no need for controller in this testcase
+
+    auto mirWindowInfo = createMirALWindowInfoForInputMethod();
+    notifier.addWindow(mirWindowInfo);
+
+    // Test removing the window
+    notifier.removeWindow(mirWindowInfo);
+    flushEvents();
+
+    EXPECT_EQ(nullptr, model.inputMethodSurface());
+}