Merge lp:~dandrader/unity-api/app-state-handling into lp:unity-api

[Daniel d'Andrada]

Let users of the API suspend & resume individual apps at will

API Changes:
- Removed ApplicationManagerInterface.forceDashActive
- Removed ApplicationManagerInterface.suspended
- Added ApplicationInfoInterface.requestedState

Needed for having unity8 handling the application lifecycle (suspending&resuming apps) explicitly instead of having it tied to application focus.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:179
http://jenkins.qa.ubuntu.com/job/unity-api-ci/297/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-amd64-ci/17
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-armhf-ci/17
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-armhf-ci/17/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-i386-ci/17

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-api-ci/297/rebuild

review: Approve (continuous-integration)

[Gerry Boland (gerboland)]

+ Q_PROPERTY(bool active READ active WRITE setActive NOTIFY activeChanged)
FYI: on Thursday at UOS, we had a session on desktop app lifecycle stuff. There we decided that there will be more states than running/suspended. For the desktop we will want a "throttled" state, i.e. application has throttled CPU usage.

It will be up to unity8 to have that policy, so qtmir needs to export that capability.

In that case, we would prefer a property supporting an enum: Running/Suspended/Throttled

Could you change this property to have Running/Suspended states, with a view to supporting more in future?

review: Needs Fixing

[Daniel d'Andrada (dandrader)]

> + Q_PROPERTY(bool active READ active WRITE setActive NOTIFY activeChanged)
> FYI: on Thursday at UOS, we had a session on desktop app lifecycle stuff.
> There we decided that there will be more states than running/suspended. For
> the desktop we will want a "throttled" state, i.e. application has throttled
> CPU usage.
>
> It will be up to unity8 to have that policy, so qtmir needs to export that
> capability.
>
> In that case, we would prefer a property supporting an enum:
> Running/Suspended/Throttled
>
> Could you change this property to have Running/Suspended states, with a view
> to supporting more in future?

Done.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:180
http://jenkins.qa.ubuntu.com/job/unity-api-ci/298/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-amd64-ci/18
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-armhf-ci/18
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-armhf-ci/18/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-i386-ci/18

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-api-ci/298/rebuild

review: Approve (continuous-integration)

[Gerry Boland (gerboland)]

+ * @brief The aplication's requested state
typo. Also "state" is vague in this context, would elaborate slightly to "application's requested running state"

+ virtual void setRequestedState(RequestedState) = 0;
+ void requestedStateChanged(RequestedState value);
"const RequestedState" would do no harm, and would help compiler slightly

Looks good otherwise. Thanks for the API change

review: Needs Fixing

[Daniel d'Andrada (dandrader)]

On 11/05/15 08:07, Gerry Boland wrote:
> Review: Needs Fixing
>
> + * @brief The aplication's requested state
> typo. Also "state" is vague in this context, would elaborate slightly to "application's requested running state"

Done.

>
> + virtual void setRequestedState(RequestedState) = 0;
> + void requestedStateChanged(RequestedState value);
> "const RequestedState" would do no harm, and would help compiler slightly

I does do some harm by making the signature longer, and the benefit of
having a "const int" parameter (as merely a hint to the reader) is
arguable in my opinion. Would like a third vote on this.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:181
http://jenkins.qa.ubuntu.com/job/unity-api-ci/299/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-amd64-ci/19
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-armhf-ci/19
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-armhf-ci/19/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-vivid-i386-ci/19

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-api-ci/299/rebuild

review: Approve (continuous-integration)

[Michael Zanetti (mzanetti)]

> > + virtual void setRequestedState(RequestedState) = 0;
> > + void requestedStateChanged(RequestedState value);
> > "const RequestedState" would do no harm, and would help compiler slightly
>
> I does do some harm by making the signature longer, and the benefit of
> having a "const int" parameter (as merely a hint to the reader) is
> arguable in my opinion. Would like a third vote on this.

As Gerry said earlier, we are in Bikeshed land here, but as you asked for a third opinion, I'm -1 for const int and agree with Daniel here.

[Gerry Boland (gerboland)]

LGTM

review: Approve

[lp:~dandrader/unity-api/app-state-handling]

173. By Daniel d'Andrada on 2015-06-11

Add supportedOrientations and rotatesWindowContents to ApplicationInfo
Approved by: PS Jenkins bot, Gerry Boland

174. By CI Train Bot Account on 2015-06-11

Releasing 7.97+15.10.20150611-0ubuntu1

175. By Daniel d'Andrada on 2015-06-19

Changes to application lifecycle APIs

* Removed ApplicationManagerInterface.forceDashActive
* Removed ApplicationManagerInterface.suspended
* Added ApplicationInfoInterface.requestedState

[Gerry Boland (gerboland)]

ACK

review: Approve

[lp:~dandrader/unity-api/app-state-handling]

176. By Daniel d'Andrada on 2015-08-03

Merge trunk

[ Mirco Müller (MacSlow) ]
* added alerting/setAlerting API to LauncherModel and LauncherItem interfaces
[ Michi Henning ]
* Remove dependency on gcc 4.9. (LP: #1452342)

=== modified file 'debian/changelog'
--- debian/changelog	2015-07-24 09:53:02 +0000
+++ debian/changelog	2015-08-03 14:07:35 +0000
@@ -1,3 +1,11 @@
+unity-api (7.99) UNRELEASED; urgency=medium
+
+  * Remove ApplicationManagerInterface.forceDashActive
+  * Remove ApplicationManagerInterface.suspended
+  * Add ApplicationInfoInterface.requestedState
+
+ -- Daniel d'Andrada <[e-mail]>  Mon, 15 Jun 2015 13:53:07 -0300
+
 unity-api (7.98+15.10.20150724-0ubuntu1) wily; urgency=medium
 
   [ Mirco Müller (MacSlow) ]
@@ -123,7 +131,7 @@
 
   [ Michal Hruby ]
   * Added header links CategoriesInterface and performQuery() to
-    ScopeInterface 
+    ScopeInterface
 
   [ Michi Henning ]
   * A few minor fixes to the doc comments for comparison operators.
@@ -488,7 +496,7 @@
 
 unity-api (7.80.1) saucy; urgency=low
 
-  * This project forked from lp:unity/phablet. Updating the versioning to 
+  * This project forked from lp:unity/phablet. Updating the versioning to
     reflect that.
 
  -- Sergio Schvezov <[e-mail]>  Tue, 04 Jun 2013 16:06:54 -0300

=== modified file 'include/unity/shell/application/ApplicationInfoInterface.h'
--- include/unity/shell/application/ApplicationInfoInterface.h	2015-04-16 16:13:09 +0000
+++ include/unity/shell/application/ApplicationInfoInterface.h	2015-08-03 14:07:35 +0000
@@ -12,10 +12,6 @@
  *
  * You should have received a copy of the GNU Lesser General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- *
- * Authors:
- *      Michael Zanetti <[e-mail]>
- *      Daniel d'Andrada <[e-mail]>
  */
 
 #ifndef UNITY_SHELL_APPLICATION_APPLICATIONINFOINTERFACE_H
@@ -47,6 +43,7 @@
 
     Q_ENUMS(Stage)
     Q_ENUMS(State)
+    Q_ENUMS(RequestedState)
 
     /**
      * @brief The appId of the application.
@@ -93,6 +90,11 @@
     Q_PROPERTY(State state READ state NOTIFY stateChanged)
 
     /**
+     * @brief The application's requested running state
+     */
+    Q_PROPERTY(RequestedState requestedState READ requestedState WRITE setRequestedState NOTIFY requestedStateChanged)
+
+    /**
      * @brief The application's focus state.
      *
      * Holds the current application focus state. True if focused, false otherwise.
@@ -235,6 +237,18 @@
         Stopped
     };
 
+    /**
+     * @brief The desired state of an application
+     *
+     * RequestedRunning: If state is Suspended or Stopped, the application will be resumed
+     *                   or restarted, respectively.
+     * RequestedSuspended: If state is Running, the application will be suspended.
+     */
+    enum RequestedState {
+        RequestedRunning = Running,
+        RequestedSuspended = Suspended
+    };
+
     /// @cond
     virtual ~ApplicationInfoInterface() {}
 
@@ -244,6 +258,8 @@
     virtual QUrl icon() const = 0;
     virtual Stage stage() const = 0;
     virtual State state() const = 0;
+    virtual RequestedState requestedState() const = 0;
+    virtual void setRequestedState(RequestedState) = 0;
     virtual bool focused() const = 0;
     virtual QString splashTitle() const = 0;
     virtual QUrl splashImage() const = 0;
@@ -262,6 +278,7 @@
     void iconChanged(const QUrl &icon);
     void stageChanged(Stage stage);
     void stateChanged(State state);
+    void requestedStateChanged(RequestedState value);
     void focusedChanged(bool focused);
     /// @endcond
 };

=== 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	2015-08-03 14:07:35 +0000
@@ -59,20 +59,6 @@
      */
     Q_PROPERTY(QString focusedApplicationId READ focusedApplicationId NOTIFY focusedApplicationIdChanged)
 
-    /**
-     * @brief The suspended state of the ApplicationManager.
-     *
-     * If this is set to true, all apps (regardless if focused or not) will be suspended.
-     */
-    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)
@@ -122,11 +108,6 @@
 
     virtual QString focusedApplicationId() const = 0;
 
-    virtual bool suspended() const = 0;
-    virtual void setSuspended(bool suspended) = 0;
-
-    virtual bool forceDashActive() const = 0;
-    virtual void setForceDashActive(bool forceDashActive) = 0;
     /// @endcond
 
     /**
@@ -212,16 +193,6 @@
     void focusedApplicationIdChanged();
 
     /**
-     * @brief Will be emitted when the suspended state of the ApplicationManager changes.
-     */
-    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 'include/unity/shell/application/CMakeLists.txt'
--- include/unity/shell/application/CMakeLists.txt	2014-11-05 12:55:55 +0000
+++ include/unity/shell/application/CMakeLists.txt	2015-08-03 14:07:35 +0000
@@ -7,7 +7,7 @@
 
 set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE)
 
-set(VERSION 6)
+set(VERSION 7)
 set(PKGCONFIG_NAME "unity-shell-application")
 set(PKGCONFIG_DESCRIPTION "Unity shell Application APIs")
 set(PKGCONFIG_REQUIRES "Qt5Core")

=== modified file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.cpp'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.cpp	2014-11-05 12:55:55 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.cpp	2015-08-03 14:07:35 +0000
@@ -126,6 +126,15 @@
     return QColor(0,0,0,0);
 }
 
+ApplicationInfoInterface::RequestedState MockApplicationInfo::requestedState() const
+{
+    return RequestedRunning;
+}
+
+void MockApplicationInfo::setRequestedState(RequestedState)
+{
+}
+
 Qt::ScreenOrientations MockApplicationInfo::supportedOrientations() const
 {
     return Qt::PortraitOrientation | Qt::LandscapeOrientation;

=== modified file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h	2014-11-05 12:55:55 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h	2015-08-03 14:07:35 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Canonical Ltd.
+ * Copyright 2013,2015 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 as published by
@@ -12,9 +12,6 @@
  *
  * You should have received a copy of the GNU Lesser General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- *
- * Authors:
- *      Michael Zanetti <[e-mail]>
  */
 
 #ifndef MOCKAPPLICATIONINFO_H
@@ -52,6 +49,8 @@
     QColor splashColor() const override;
     QColor splashColorHeader() const override;
     QColor splashColorFooter() const override;
+    RequestedState requestedState() const override;
+    void setRequestedState(RequestedState) override;
 
     Qt::ScreenOrientations supportedOrientations() const override;
     bool rotatesWindowContents() const override;

=== 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	2015-08-03 14:07:35 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Canonical Ltd.
+ * Copyright 2013,2015 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 as published by
@@ -98,26 +98,6 @@
     return (first) ? first->appId() : QString();
 }
 
-bool MockApplicationManager::suspended() const
-{
-    return false;
-}
-
-void MockApplicationManager::setSuspended(bool suspended)
-{
-    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)

=== 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	2015-08-03 14:07:35 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Canonical Ltd.
+ * Copyright 2013,2015 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 as published by
@@ -40,12 +40,6 @@
 
     QString focusedApplicationId() const;
 
-    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;

=== modified file 'test/qmltest/unity/shell/application/tst_Application.qml'
--- test/qmltest/unity/shell/application/tst_Application.qml	2014-11-05 12:55:55 +0000
+++ test/qmltest/unity/shell/application/tst_Application.qml	2015-08-03 14:07:35 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Canonical Ltd.
+ * Copyright 2013,2015 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 as published by
@@ -124,8 +124,6 @@
             return [
                 { 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" },
             ];
         }
 
@@ -143,6 +141,7 @@
                 { tag: "ApplicationInfo.properties[icon]", property: "icon", type: "object" },
                 { tag: "ApplicationInfo.properties[stage]", property: "stage", type: "number" },
                 { tag: "ApplicationInfo.properties[state]", property: "state", type: "number" },
+                { tag: "ApplicationInfo.properties[requestedState]", property: "requestedState", type: "number" },
                 { tag: "ApplicationInfo.properties[focused]", property: "focused", type: "boolean" },
                 { tag: "ApplicationInfo.properties[splashTitle]", constant: "splashTitle", type: "string" },
                 { tag: "ApplicationInfo.properties[splashImage]", constant: "splashImage", type: "url" },