Merge lp:~dandrader/unity-api/miral-surfacemanager into lp:~unity-team/unity-api/miral

[Daniel d'Andrada]

Add SurfaceManager and remove TopLevelWindowModel and Window

[lp:~dandrader/unity-api/miral-surfacemanager]

259. By Daniel d'Andrada on 2016-11-17

Update useless tests

[Gerry Boland (gerboland)]

Ok

review: Approve

=== modified file 'include/unity/shell/application/ApplicationInfoInterface.h'
--- include/unity/shell/application/ApplicationInfoInterface.h	2016-07-25 13:56:35 +0000
+++ include/unity/shell/application/ApplicationInfoInterface.h	2016-11-17 12:23:58 +0000
@@ -282,6 +282,11 @@
         RequestedSuspended = Suspended
     };
 
+    /**
+     * @brief Closes the application
+     */
+    virtual void close() = 0;
+
     /// @cond
     virtual ~ApplicationInfoInterface() {}
 

=== modified file 'include/unity/shell/application/ApplicationManagerInterface.h'
--- include/unity/shell/application/ApplicationManagerInterface.h	2016-07-25 13:56:35 +0000
+++ include/unity/shell/application/ApplicationManagerInterface.h	2016-11-17 12:23:58 +0000
@@ -33,6 +33,7 @@
 {
 
 class ApplicationInfoInterface;
+class MirSurfaceInterface;
 
 /**
  * @brief The Application manager
@@ -134,6 +135,11 @@
      */
     Q_INVOKABLE virtual unity::shell::application::ApplicationInfoInterface *findApplication(const QString &appId) const = 0;
 
+    /*
+     * @brief Returns the AplicationInfo with the given surface
+     */
+    virtual ApplicationInfoInterface *findApplicationWithSurface(MirSurfaceInterface* surface) = 0;
+
     /**
      * @brief Request to focus a given application
      *

=== modified file 'include/unity/shell/application/MirSurfaceInterface.h'
--- include/unity/shell/application/MirSurfaceInterface.h	2016-11-03 12:25:43 +0000
+++ include/unity/shell/application/MirSurfaceInterface.h	2016-11-17 12:23:58 +0000
@@ -264,6 +264,11 @@
      * @brief Emitted in response to a requestFocus() call
      */
     void focusRequested();
+
+    /**
+     * @brief Emitted when close() is called
+     */
+    void closeRequested();
 };
 
 } // namespace application

=== added file 'include/unity/shell/application/SurfaceManagerInterface.h'
--- include/unity/shell/application/SurfaceManagerInterface.h	1970-01-01 00:00:00 +0000
+++ include/unity/shell/application/SurfaceManagerInterface.h	2016-11-17 12:23:58 +0000
@@ -0,0 +1,50 @@
+/*
+ * Copyright (C) 2016 Canonical, Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef UNITY_SHELL_APPLICATION_SURFACEMANAGERINTERFACE_H
+#define UNITY_SHELL_APPLICATION_SURFACEMANAGERINTERFACE_H
+
+#include <QObject>
+#include <QVector>
+
+namespace unity {
+namespace shell {
+namespace application {
+
+class MirSurfaceInterface;
+
+class SurfaceManagerInterface : public QObject
+{
+    Q_OBJECT
+
+public:
+    virtual ~SurfaceManagerInterface() {}
+
+    virtual void raise(MirSurfaceInterface *surface) = 0;
+    virtual void activate(MirSurfaceInterface *surface) = 0;
+
+Q_SIGNALS:
+    void surfaceCreated(MirSurfaceInterface *surface);
+    void surfacesRaised(const QVector<MirSurfaceInterface*> &surfaces);
+    void modificationsStarted();
+    void modificationsEnded();
+};
+
+} // namespace application
+} // namespace shell
+} // namespace unity
+
+#endif // UNITY_SHELL_APPLICATION_SURFACEMANAGERINTERFACE_H

=== removed file 'include/unity/shell/application/TopLevelWindowModelInterface.h'
--- include/unity/shell/application/TopLevelWindowModelInterface.h	2016-11-07 13:58:38 +0000
+++ include/unity/shell/application/TopLevelWindowModelInterface.h	1970-01-01 00:00:00 +0000
@@ -1,152 +0,0 @@
-/*
- * Copyright (C) 2016 Canonical, Ltd.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; version 3.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-#ifndef UNITY_SHELL_APPLICATION_TOPLEVELWINDOWMODELINTERFACE_H
-#define UNITY_SHELL_APPLICATION_TOPLEVELWINDOWMODELINTERFACE_H
-
-#include <QAbstractListModel>
-
-namespace unity
-{
-namespace shell
-{
-namespace application
-{
-
-class ApplicationInfoInterface;
-class MirSurfaceInterface;
-class WindowInterface;
-
-/**
- * @brief A model of top-level surfaces
- *
- * It's an abstraction of top-level application windows.
- *
- * When an entry first appears, it normaly doesn't have a surface yet, meaning that the application is
- * still starting up. A shell should then display a splash screen or saved screenshot of the application
- * until its surface comes up.
- *
- * As applications can have multiple surfaces and you can also have entries without surfaces at all,
- * the only way to unambiguously refer to an entry in this model is through its id.
- */
-class TopLevelWindowModelInterface : public QAbstractListModel
-{
-    Q_OBJECT
-
-    /**
-     * @brief Number of top-level surfaces in this model
-     *
-     * This is the same as rowCount, added in order to keep compatibility with QML ListModels.
-     */
-    Q_PROPERTY(int count READ rowCount NOTIFY countChanged)
-
-    /**
-     * @brief The input method surface, if any
-     *
-     * The surface of a onscreen keyboard (akak "virtual keyboard") would be kept here and not in the model itself.
-     */
-    Q_PROPERTY(unity::shell::application::MirSurfaceInterface* inputMethodSurface READ inputMethodSurface NOTIFY inputMethodSurfaceChanged)
-
-    /**
-     * @brief The currently focused window, if any
-     */
-    Q_PROPERTY(unity::shell::application::WindowInterface* focusedWindow READ focusedWindow
-                                                                         NOTIFY focusedWindowChanged)
-public:
-    /**
-     * @brief The Roles supported by the model
-     *
-     * WindowRole - A WindowInterface.
-     * ApplicationRole - An ApplicationInfoInterface
-     */
-    enum Roles {
-        WindowRole = Qt::UserRole,
-        ApplicationRole = Qt::UserRole + 1,
-    };
-
-    virtual ~TopLevelWindowModelInterface() {}
-
-    QHash<int, QByteArray> roleNames() const override {
-        QHash<int, QByteArray> roleNames { {WindowRole, "window"},
-                                           {ApplicationRole, "application"} };
-        return roleNames;
-    }
-
-    /// @cond
-    virtual MirSurfaceInterface* inputMethodSurface() const = 0;
-    virtual WindowInterface* focusedWindow() const = 0;
-    /// @endcond
-
-public Q_SLOTS:
-    /**
-     * @brief Returns the surface at the given index
-     *
-     * It will be a nullptr if the application is still starting up and thus hasn't yet created
-     * and drawn into a surface.
-     *
-     * Same as windowAt(index).surface()
-     */
-    virtual MirSurfaceInterface *surfaceAt(int index) const = 0;
-
-    /**
-     * @brief Returns the window at the given index
-     *
-     * Will always be valid
-     */
-    virtual WindowInterface *windowAt(int index) const = 0;
-
-    /**
-     * @brief Returns the application at the given index
-     */
-    virtual ApplicationInfoInterface *applicationAt(int index) const = 0;
-
-    /**
-     * @brief Returns the unique id of the element at the given index
-     */
-    virtual int idAt(int index) const = 0;
-
-    /**
-     * @brief Returns the index where the row with the given id is located
-     *
-     * Returns -1 if there's no row with the given id.
-     */
-    virtual int indexForId(int id) const = 0;
-
-    /**
-     * @brief Raises the row with the given id to the top of the window stack (index == count-1)
-     */
-    virtual void raiseId(int id) = 0;
-
-Q_SIGNALS:
-    /// @cond
-    void countChanged();
-    void inputMethodSurfaceChanged(unity::shell::application::MirSurfaceInterface* inputMethodSurface);
-    void focusedWindowChanged(unity::shell::application::WindowInterface *focusedWindow);
-    /// @endcond
-
-    /**
-     * @brief Emitted when the list changes
-     *
-     * Emitted when model gains an element, loses an element or when elements exchange positions.
-     */
-    void listChanged();
-};
-
-} // namespace application
-} // namespace shell
-} // namespace unity
-
-#endif // UNITY_SHELL_APPLICATION_TOPLEVELWINDOWMODELINTERFACE_H

=== removed file 'include/unity/shell/application/WindowInterface.h'
--- include/unity/shell/application/WindowInterface.h	2016-11-01 19:27:19 +0000
+++ include/unity/shell/application/WindowInterface.h	1970-01-01 00:00:00 +0000
@@ -1,144 +0,0 @@
-/*
- * Copyright (C) 2016 Canonical, Ltd.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; version 3.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-#ifndef UNITY_SHELL_APPLICATION_WINDOW_H
-#define UNITY_SHELL_APPLICATION_WINDOW_H
-
-#include <QObject>
-#include <QPoint>
-
-#include "Mir.h"
-
-namespace unity
-{
-namespace shell
-{
-namespace application
-{
-
-class MirSurfaceInterface;
-
-/**
-   @brief A slightly higher concept than MirSurface
-
-   A Window exists before its MirSurface gets created (for splashscreen purposes)
-   and might also hang around after the backing surface is gone (In case the application
-   was killed to free up memory, as it should still remain in the window list since the user
-   did not explicitly close it).
- */
-class WindowInterface : public QObject
-{
-    Q_OBJECT
-
-    /**
-     * @brief Position of the current surface buffer, in pixels.
-     */
-    Q_PROPERTY(QPoint position READ position NOTIFY positionChanged)
-
-    /**
-     * @brief Requested position of the current surface buffer, in pixels.
-     */
-    Q_PROPERTY(QPoint requestedPosition READ requestedPosition WRITE setRequestedPosition NOTIFY requestedPositionChanged)
-
-    /**
-     * @brief State of the surface
-     */
-    Q_PROPERTY(Mir::State state READ state NOTIFY stateChanged)
-
-    /**
-     * @brief Whether the surface is focused
-     *
-     * It will be true if this surface is MirFocusControllerInterface::focusedSurface
-     */
-    Q_PROPERTY(bool focused READ focused NOTIFY focusedChanged)
-
-    /**
-     * @brief Whether the surface wants to confine the mouse pointer within its boundaries
-     *
-     * If true, the surface doesn't want the mouse pointer to leave its boundaries while it's focused.
-     */
-    Q_PROPERTY(bool confinesMousePointer READ confinesMousePointer NOTIFY confinesMousePointerChanged)
-
-    /**
-     * @brief A unique identifier for this window.
-     * Useful for telling windows apart in a list model as they get moved around
-     */
-    Q_PROPERTY(int id READ id CONSTANT)
-
-    /**
-     * @brief Surface backing up this window
-     * It might be null if a surface hasn't been created yet (application is starting up) or if
-     * the corresponding application has been killed (but can still get restarted to continue from
-     * where it left)
-     */
-    Q_PROPERTY(unity::shell::application::MirSurfaceInterface* surface READ surface NOTIFY surfaceChanged)
-
-public:
-    /// @cond
-    WindowInterface(QObject *parent = nullptr) : QObject(parent) {}
-    virtual QPoint position() const = 0;
-    virtual QPoint requestedPosition() const = 0;
-    virtual void setRequestedPosition(const QPoint &) = 0;
-    virtual Mir::State state() const = 0;
-    virtual bool focused() const = 0;
-    virtual bool confinesMousePointer() const = 0;
-    virtual int id() const = 0;
-    virtual MirSurfaceInterface* surface() const = 0;
-    /// @endcond
-
-public Q_SLOTS:
-    /**
-     * @brief Requests a change to the specified state
-     */
-    virtual void requestState(Mir::State state) = 0;
-
-    /**
-     * @brief Requests focus for this surface
-     *
-     * Causes the emission of focusRequested()
-     */
-    virtual void requestFocus() = 0;
-
-    /**
-     * @brief Sends a close request
-     *
-     */
-    virtual void close() = 0;
-
-Q_SIGNALS:
-    /// @cond
-    void positionChanged(QPoint position);
-    void requestedPositionChanged(QPoint position);
-    void stateChanged(Mir::State value);
-    void focusedChanged(bool value);
-    void confinesMousePointerChanged(bool value);
-    void surfaceChanged(unity::shell::application::MirSurfaceInterface *surface);
-    /// @endcond
-
-    /**
-     * @brief Emitted in response to a requestFocus() call
-     */
-    void focusRequested();
-};
-
-
-} // namespace application
-} // namespace shell
-} // namespace unity
-
-Q_DECLARE_METATYPE(unity::shell::application::WindowInterface*)
-
-#endif // UNITY_SHELL_APPLICATION_WINDOw_H

=== modified file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h	2016-07-25 13:56:35 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h	2016-11-17 12:23:58 +0000
@@ -29,6 +29,8 @@
 public:
     MockApplicationInfo(const QString &appId, const QString& name, const QString& comment, const QUrl& icon, QObject* parent = 0);
 
+    void close() override {}
+
     QString appId() const;
     QString name() const;
     QString comment() const;

=== modified file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.h'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.h	2015-06-19 12:02:05 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.h	2016-11-17 12:23:58 +0000
@@ -44,6 +44,8 @@
 
     Q_INVOKABLE unity::shell::application::ApplicationInfoInterface *findApplication(const QString &appId) const;
 
+    ApplicationInfoInterface *findApplicationWithSurface(MirSurfaceInterface*) override { return nullptr; }
+
     Q_INVOKABLE bool requestFocusApplication(const QString &appId);
 
     Q_INVOKABLE bool focusApplication(const QString &appId);