Merge lp:~gerboland/unity-api/remove-focus-statetracking into lp:unity-api

[Gerry Boland]

AppMan: expose lifecycle state to shell as writable. Focus no longer responsible for lifecycle state

AppMan: expose lifecycle state to shell as writable. Focus no longer responsible for lifecycle state

Unmerged revisions

165. By Gerry Boland on 2014-11-24

Update doc to remove old reference

164. By Gerry Boland on 2014-11-21

Unity.Application: Remove focus tracking API and add lifecycle control methods

=== modified file 'debian/changelog'
--- debian/changelog	2014-11-04 14:42:57 +0000
+++ debian/changelog	2014-12-02 16:14:36 +0000
@@ -1,3 +1,9 @@
+unity-api (7.94) UNRELEASED; urgency=medium
+
+  * Unity.Application: Remove focus state tracking from AppMan API
+
+ -- Gerry Boland <[e-mail]>  Thu, 20 Nov 2014 16:57:34 +0000
+
 unity-api (7.93+15.04.20141104-0ubuntu1) vivid; urgency=medium
 
   [ Michael Zanetti ]
 
=== modified file 'include/unity/shell/application/ApplicationInfoInterface.h'
--- include/unity/shell/application/ApplicationInfoInterface.h	2014-09-09 15:51:47 +0000
+++ include/unity/shell/application/ApplicationInfoInterface.h	2014-12-02 16:14:36 +0000
@@ -232,6 +232,44 @@
     virtual QColor splashColorFooter() const = 0;
     /// @endcond
 
+    /**
+     * @brief Request that the application is suspended
+     *
+     * @see resume
+     * Attempts to suspend the application process.
+     *
+     * @returns If application is in Starting or Running state, and not in the lifecycle exception list,
+     * it will update the state to be Suspended, and return true. The process will be notified that
+     * it is about to be suspended, allowing it time to prepare, before being suspended 3 seconds later.
+     *
+     * If already Suspended, it will immediately return true.
+     *
+     * Will return false otherwise.
+     *
+     * Method is non-blocking and process manipulation is asynchroneous.
+     */
+    Q_INVOKABLE virtual bool suspend() = 0;
+
+    /**
+     * @brief Request that the application is resumed
+     *
+     * @see suspend
+     * Attempts to resume a suspended or stopped application process.
+     *
+     * @returns If application is in Starting or Running state, it will return true immediately;
+     *
+     * If application Suspended, it will initiate resumption the process, update the state to be
+     * Running.
+     *
+     * If application in Stopped state, it will initiate respawn of the process. Should this succeed
+     * the application state will be updated to Starting and return true;
+     *
+     * Will return false if process can not be resumed.
+     *
+     * Method is non-blocking and process manipulation is asynchroneous.
+     */
+    Q_INVOKABLE virtual bool resume() = 0;
+
 Q_SIGNALS:
     /// @cond
     void nameChanged(const QString &name);
 
=== modified file 'include/unity/shell/application/ApplicationManagerInterface.h'
--- include/unity/shell/application/ApplicationManagerInterface.h	2014-09-29 13:39:01 +0000
+++ include/unity/shell/application/ApplicationManagerInterface.h	2014-12-02 16:14:36 +0000
@@ -55,7 +55,7 @@
     /**
      * @brief The currently focused application.
      *
-     * Use focusApplication() and unfocusCurrentApplication() to modify this.
+     * This is updated by any Application's MirSurface getting activeFocus
      */
     Q_PROPERTY(QString focusedApplicationId READ focusedApplicationId NOTIFY focusedApplicationIdChanged)
 
@@ -66,13 +66,6 @@
      */
     Q_PROPERTY(bool suspended READ suspended WRITE setSuspended NOTIFY suspendedChanged)
 
-    /**
-     * @brief Activate the dash, regardless of its focused state.
-     *
-     * If this is set to true, the dash will not be put to suspend or will be woken up from suspend.
-     */
-    Q_PROPERTY(bool forceDashActive READ forceDashActive WRITE setForceDashActive NOTIFY forceDashActiveChanged)
-
 protected:
     /// @cond
     ApplicationManagerInterface(QObject* parent = 0): QAbstractListModel(parent)
@@ -124,9 +117,6 @@
 
     virtual bool suspended() const = 0;
     virtual void setSuspended(bool suspended) = 0;
-
-    virtual bool forceDashActive() const = 0;
-    virtual void setForceDashActive(bool forceDashActive) = 0;
     /// @endcond
 
     /**
@@ -150,33 +140,6 @@
     Q_INVOKABLE virtual unity::shell::application::ApplicationInfoInterface *findApplication(const QString &appId) const = 0;
 
     /**
-     * @brief Request to focus a given application
-     *
-     * This will request the shell to focus the given application.
-     *
-     * @param appId The appId of the app to be focused.
-     * @returns True if the request will processed, false if it was discarded (i.e. the given appid could not be found)
-     */
-    Q_INVOKABLE virtual bool requestFocusApplication(const QString &appId) = 0;
-
-    /**
-     * @brief Focus the given application.
-     *
-     * This will immediately focus the given application. Usually you should not use this
-     * but instead call requestFocusApplication() in order to allow the shell to prepare
-     * for the upcoming animation or even block the focus request (e.g. focus stealing prevention)
-     *
-     * @param appId The application to be focused.
-     * @returns True if appId found and application focused, else false.
-     */
-    Q_INVOKABLE virtual bool focusApplication(const QString &appId) = 0;
-
-    /**
-     * @brief Unfocus the currently focused application.
-     */
-    Q_INVOKABLE virtual void unfocusCurrentApplication() = 0;
-
-    /**
      * @brief Start an application.
      *
      * @param appId The appId for the application to be spawned.
@@ -217,11 +180,6 @@
     void suspendedChanged();
 
     /**
-     * @brief Will be emitted when the forceDashActive property changes.
-     */
-    void forceDashActiveChanged();
-
-    /**
      * @brief Will be emitted when an application was added to the model.
      *
      * @param appId The appId of the application that was added.
 
=== modified file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.cpp'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.cpp	2014-09-03 22:59:26 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.cpp	2014-12-02 16:14:36 +0000
@@ -125,3 +125,13 @@
 {
     return QColor(0,0,0,0);
 }
+
+bool MockApplicationInfo::suspend()
+{
+    return true;
+}
+
+bool MockApplicationInfo::resume()
+{
+    return true;
+}
 
=== modified file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h	2014-09-03 22:59:26 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h	2014-12-02 16:14:36 +0000
@@ -53,6 +53,9 @@
     QColor splashColorHeader() const override;
     QColor splashColorFooter() const override;
 
+    Q_INVOKABLE bool suspend() override;
+    Q_INVOKABLE bool resume() override;
+
 private:
     QString m_appId;
     QString m_name;
 
=== modified file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.cpp'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.cpp	2014-09-29 10:58:06 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.cpp	2014-12-02 16:14:36 +0000
@@ -108,32 +108,6 @@
     Q_UNUSED(suspended)
 }
 
-bool MockApplicationManager::forceDashActive() const
-{
-    return false;
-}
-
-void MockApplicationManager::setForceDashActive(bool forceDashActive)
-{
-    Q_UNUSED(forceDashActive)
-}
-
-bool MockApplicationManager::requestFocusApplication(const QString &appId)
-{
-    Q_UNUSED(appId)
-    return true;
-}
-
-bool MockApplicationManager::focusApplication(const QString &appId)
-{
-    Q_UNUSED(appId)
-    return true;
-}
-
-void MockApplicationManager::unfocusCurrentApplication()
-{
-}
-
 unity::shell::application::ApplicationInfoInterface *MockApplicationManager::startApplication(const QString &appId, const QStringList &arguments)
 {
     Q_UNUSED(arguments)
 
=== modified file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.h'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.h	2014-09-29 10:58:06 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.h	2014-12-02 16:14:36 +0000
@@ -43,19 +43,10 @@
     bool suspended() const;
     void setSuspended(bool suspended);
 
-    bool forceDashActive() const override;
-    void setForceDashActive(bool forceDashActive) override;
-
     Q_INVOKABLE unity::shell::application::ApplicationInfoInterface *get(const int index) const;
 
     Q_INVOKABLE unity::shell::application::ApplicationInfoInterface *findApplication(const QString &appId) const;
 
-    Q_INVOKABLE bool requestFocusApplication(const QString &appId);
-
-    Q_INVOKABLE bool focusApplication(const QString &appId);
-
-    Q_INVOKABLE void unfocusCurrentApplication();
-
     Q_INVOKABLE unity::shell::application::ApplicationInfoInterface *startApplication(const QString &appId, const QStringList &arguments);
 
     Q_INVOKABLE bool stopApplication(const QString &appId);
 
=== modified file 'test/qmltest/unity/shell/application/tst_Application.qml'
--- test/qmltest/unity/shell/application/tst_Application.qml	2014-09-29 10:58:06 +0000
+++ test/qmltest/unity/shell/application/tst_Application.qml	2014-12-02 16:14:36 +0000
@@ -106,9 +106,6 @@
             return [
                 { tag: "ApplicationManager.methods[get]", method: "get" },
                 { tag: "ApplicationManager.methods[findApplication]", method: "findApplication" },
-                { tag: "ApplicationManager.methods[requestFocusApplication]", method: "requestFocusApplication" },
-                { tag: "ApplicationManager.methods[focusApplication]", method: "focusApplication" },
-                { tag: "ApplicationManager.methods[unfocusCurrentApplication]", method: "unfocusCurrentApplication" },
                 { tag: "ApplicationManager.methods[startApplication]", method: "startApplication" },
                 { tag: "ApplicationManager.methods[stopApplication]", method: "stopApplication" },
             ];
@@ -125,7 +122,6 @@
                 { tag: "ApplicationManager.count", property: "count", type: "number" },
                 { tag: "ApplicationManager.focusedApplicationId", property: "focusedApplicationId", type: "string" },
                 { tag: "ApplicationManager.suspended", property: "suspended", type: "boolean" },
-                { tag: "ApplicationManager.forceDashActive", property: "forceDashActive", type: "boolean" },
             ];
         }
 
@@ -164,5 +160,24 @@
 
             verifyData(data)
         }
+
+        function test_item_methods_data() {
+            return [
+                { tag: "ApplicationInfo.methods[suspend]", method: "suspend" },
+                { tag: "ApplicationInfo.methods[resume]", method: "resume" },
+            ];
+        }
+
+        function test_item_methods(data) {
+            name = "ApplicationInfo";
+            try {
+                object = ApplicationManager.get(0)
+            } catch(err) {
+                object = undefined;
+                print(err)
+            }
+
+            verifyData(data);
+        }
     }
 }