Merge lp:~gerboland/unity-mir/add-surface-attribute-updates into lp:unity-mir

[Gerry Boland]

Listen for Mir Surface type and state property changes, propagate them up to QML

Mir added a SurfaceConfigurator interface, whose method attribute_set is called when any surface requests a property change. Here we inherit this class, and emit signals to the SurfaceManager when a property change occurs.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:35
http://jenkins.qa.ubuntu.com/job/unity-mir-ci/22/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-armhf-ci/22/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-i386-ci/22/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-mir-ci/22/rebuild

review: Needs Fixing (continuous-integration)

[Albert Astals Cid (aacid)]

Wonder if we should declare one Type/State to be the default values and in the constructor also emit the changed signals in case the passed values are not the ones we deem to be the default ones.

[lp:~gerboland/unity-mir/add-surface-attribute-updates]

36. By Gerry Boland on 2013-08-20

Add licences

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:36
http://jenkins.qa.ubuntu.com/job/unity-mir-ci/25/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-armhf-ci/25
        deb: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-armhf-ci/25/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-i386-ci/25

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-mir-ci/25/rebuild

review: Approve (continuous-integration)

[lp:~gerboland/unity-mir/add-surface-attribute-updates]

37. By Gerry Boland on 2013-08-20

Remove private copies of Mir Surface properties, just wrap the properties from Mir

[Gerry Boland (gerboland)]

Your comment made me aware that the code was copying the properties that Mir Surface supplies. I've changed it to only wrap those properties instead. Let me know if it is a satisfactory result

[lp:~gerboland/unity-mir/add-surface-attribute-updates]

38. By Gerry Boland on 2013-08-20

Duplicate header included, fixed

39. By Gerry Boland on 2013-08-20

Remove extra newline

40. By Gerry Boland on 2013-08-20

Small formatting tweak

41. By Gerry Boland on 2013-08-20

Header file, remove path supplied by pkgconfig

42. By Gerry Boland on 2013-08-20

Header file, remove path supplied by pkgconfig in other place

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:42
http://jenkins.qa.ubuntu.com/job/unity-mir-ci/31/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-armhf-ci/31
        deb: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-armhf-ci/31/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-i386-ci/31

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-mir-ci/31/rebuild

review: Approve (continuous-integration)

[lp:~gerboland/unity-mir/add-surface-attribute-updates]

43. By Gerry Boland on 2013-08-20

Correctly deal with attribute changescoming from Mir

44. By Gerry Boland on 2013-08-20

Nitpick in pro file

45. By Gerry Boland on 2013-08-20

Wait for confirmation from Mir before emitting changed signals

46. By Gerry Boland on 2013-08-20

Whitespace

47. By Gerry Boland on 2013-08-20

Merge trunk

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:47
http://jenkins.qa.ubuntu.com/job/unity-mir-ci/32/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-armhf-ci/32
        deb: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-armhf-ci/32/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-mir-saucy-i386-ci/32

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-mir-ci/32/rebuild

review: Approve (continuous-integration)

[Albert Astals Cid (aacid)]

Looks good

review: Approve

=== modified file 'src/modules/Unity/SurfaceManager/mirsurface.cpp'
--- src/modules/Unity/SurfaceManager/mirsurface.cpp	2013-08-09 13:16:13 +0000
+++ src/modules/Unity/SurfaceManager/mirsurface.cpp	2013-08-20 12:03:24 +0000
@@ -21,8 +21,9 @@
 // unity-mir
 #include "logging.h"
 
-// Qt
-#include <mircommon/mir/geometry/rectangle.h>
+// Mir
+#include <mir/shell/surface.h>
+#include <mir/geometry/rectangle.h>
 
 namespace mg = mir::geometry;
 
@@ -132,16 +133,13 @@
     Q_EMIT visibleChanged();
 }
 
-
 MirSurface::Type MirSurface::type() const
 {
-    //FIXME - how to listen to change in this property
     return static_cast<MirSurface::Type>(m_surface->type());
 }
 
 MirSurface::State MirSurface::state() const
 {
-    //FIXME - how to listen to change in this property
     return static_cast<MirSurface::State>(m_surface->state());
 }
 
@@ -192,3 +190,33 @@
     }
     m_surface->set_input_region(mirInputAreas);
 }
+
+void MirSurface::setType(const Type &type)
+{
+    if (this->type() != type) {
+        m_surface->configure(mir_surface_attrib_type, static_cast<int>(type));
+    }
+}
+
+void MirSurface::setState(const State &state)
+{
+    if (this->state() != state) {
+        m_surface->configure(mir_surface_attrib_state, static_cast<int>(state));
+    }
+}
+
+// Called by MirSurfaceManager upon a msh::Surface attribute change
+void MirSurface::setAttribute(const MirSurfaceAttrib attribute, const int /*value*/)
+{
+    switch (attribute) {
+    case mir_surface_attrib_type:
+        Q_EMIT typeChanged();
+        break;
+    case mir_surface_attrib_state:
+        Q_EMIT stateChanged();
+        break;
+    default:
+        break;
+    }
+}
+

=== modified file 'src/modules/Unity/SurfaceManager/mirsurface.h'
--- src/modules/Unity/SurfaceManager/mirsurface.h	2013-08-09 13:16:13 +0000
+++ src/modules/Unity/SurfaceManager/mirsurface.h	2013-08-20 12:03:24 +0000
@@ -23,6 +23,7 @@
 
 // mir
 #include <mir/shell/surface.h>
+#include <mir_toolkit/common.h>
 
 
 namespace mir { namespace geometry { struct Rectangle; }}
@@ -86,6 +87,8 @@
     void setHeight(qreal);
     void setVisible(bool);
 
+    void setAttribute(const MirSurfaceAttrib, const int);
+
 Q_SIGNALS:
     void typeChanged();
     void stateChanged();
@@ -108,6 +111,8 @@
     // end of methods used by InputArea
 
     void updateMirInputRegion();
+    void setType(const Type&);
+    void setState(const State&);
 
     bool disableMirInputArea(const mir::geometry::Rectangle& rect);
 

=== modified file 'src/modules/Unity/SurfaceManager/mirsurfacemanager.cpp'
--- src/modules/Unity/SurfaceManager/mirsurfacemanager.cpp	2013-08-20 08:20:36 +0000
+++ src/modules/Unity/SurfaceManager/mirsurfacemanager.cpp	2013-08-20 12:03:24 +0000
@@ -25,6 +25,7 @@
 #include "qmirserverapplication.h"
 #include "shellserverconfiguration.h"
 #include "sessionlistener.h"
+#include "surfaceconfigurator.h"
 #include "surfacesource.h"
 #include "logging.h"
 
@@ -61,6 +62,9 @@
                      this, &MirSurfaceManager::sessionCreatedSurface);
     QObject::connect(m_mirServer->sessionListener(), &SessionListener::sessionDestroyingSurface,
                      this, &MirSurfaceManager::sessionDestroyingSurface);
+
+    QObject::connect(m_mirServer->surfaceConfigurator(), &SurfaceConfigurator::surfaceAttributeChanged,
+                     this, &MirSurfaceManager::surfaceAttributeChanged);
 }
 
 MirSurfaceManager::~MirSurfaceManager()
@@ -108,14 +112,26 @@
         m_surfaces.erase(it);
         Q_EMIT surfaceDestroyed(*it);
         delete *it;
+        return;
     }
 
     DLOG("MirSurfaceManager::sessionDestroyingSurface: unable to find MirSurface corresponding to surface '%s'", surface->name().c_str());
 }
 
-void MirSurfaceManager::shellSurfaceCreated(const std::shared_ptr<mir::shell::Surface> &surface)
+void MirSurfaceManager::shellSurfaceCreated(const std::shared_ptr<msh::Surface> &surface)
 {
     DLOG("MirSurfaceManager::shellSurfaceCreated (this=%p)", this);
     m_shellSurface = new MirSurface(surface);
     Q_EMIT shellSurfaceChanged(m_shellSurface);
 }
+
+void MirSurfaceManager::surfaceAttributeChanged(const msh::Surface *surface, const MirSurfaceAttrib attribute, const int value)
+{
+    DLOG("MirSurfaceManager::surfaceAttributeChanged (this=%p, attrib=%d, value=%d)",
+         this, static_cast<int>(attribute), value);
+
+    auto it = m_surfaces.find(surface);
+    if (it != m_surfaces.end()) {
+        it.value()->setAttribute(attribute, value);
+    }
+}

=== modified file 'src/modules/Unity/SurfaceManager/mirsurfacemanager.h'
--- src/modules/Unity/SurfaceManager/mirsurfacemanager.h	2013-08-09 13:16:13 +0000
+++ src/modules/Unity/SurfaceManager/mirsurfacemanager.h	2013-08-20 12:03:24 +0000
@@ -23,7 +23,10 @@
 // Qt
 #include <QObject>
 
-// mir
+// Mir
+#include <mir_toolkit/common.h>
+
+// local
 #include "mirsurface.h"
 
 class ShellServerConfiguration;
@@ -55,8 +58,10 @@
     void sessionDestroyingSurface(mir::shell::ApplicationSession const*, std::shared_ptr<mir::shell::Surface> const&);
     void shellSurfaceCreated(std::shared_ptr<mir::shell::Surface> const&);
 
+    void surfaceAttributeChanged(mir::shell::Surface const*, MirSurfaceAttrib, int);
+
 private:
-    QHash<mir::shell::Surface *, MirSurface *> m_surfaces;
+    QHash<const mir::shell::Surface *, MirSurface *> m_surfaces;
     MirSurface* m_shellSurface;
     ShellServerConfiguration* m_mirServer;
     static MirSurfaceManager *the_surface_manager;

=== modified file 'src/unity-mir/shellserverconfiguration.cpp'
--- src/unity-mir/shellserverconfiguration.cpp	2013-08-09 13:16:13 +0000
+++ src/unity-mir/shellserverconfiguration.cpp	2013-08-20 12:03:24 +0000
@@ -18,6 +18,7 @@
 
 #include "initialsurfaceplacementstrategy.h"
 #include "sessionlistener.h"
+#include "surfaceconfigurator.h"
 #include "surfacesource.h"
 #include "sessionauthorizer.h"
 #include "surfacebuilder.h"
@@ -34,6 +35,7 @@
     : QObject(parent)
     , DefaultServerConfiguration(argc, argv)
     , m_surfaceBuilder(new SurfaceBuilder(the_surface_stack_model()))
+    , m_surfaceConfigurator(new SurfaceConfigurator)
     , m_sessionListener(new SessionListener)
     , m_surfaceSource(new SurfaceSource(the_surface_builder(), the_shell_surface_configurator()))
     , m_sessionAuthorizer(new SessionAuthorizer(the_session_manager()))
@@ -66,6 +68,12 @@
         });
 }
 
+std::shared_ptr<msh::SurfaceConfigurator>
+ShellServerConfiguration::the_shell_surface_configurator()
+{
+    return m_surfaceConfigurator;
+}
+
 std::shared_ptr<msh::SurfaceFactory>
 ShellServerConfiguration::the_shell_surface_factory()
 {
@@ -90,7 +98,12 @@
     return m_sessionAuthorizer;
 }
 
-SessionListener* ShellServerConfiguration::sessionListener() const
+SurfaceConfigurator *ShellServerConfiguration::surfaceConfigurator() const
+{
+    return m_surfaceConfigurator.get();
+}
+
+SessionListener *ShellServerConfiguration::sessionListener() const
 {
     return m_sessionListener.get();
 }

=== modified file 'src/unity-mir/shellserverconfiguration.h'
--- src/unity-mir/shellserverconfiguration.h	2013-08-09 13:16:13 +0000
+++ src/unity-mir/shellserverconfiguration.h	2013-08-20 12:03:24 +0000
@@ -24,11 +24,13 @@
 class SessionAuthorizer;
 class SurfaceSource;
 class SurfaceBuilder;
+class SurfaceConfigurator;
 
 class ShellServerConfiguration : public QObject, public mir::DefaultServerConfiguration
 {
     Q_OBJECT
 
+    Q_PROPERTY(SurfaceConfigurator* surfaceConfigurator READ surfaceConfigurator CONSTANT)
     Q_PROPERTY(SessionListener* sessionListener READ sessionListener CONSTANT)
     Q_PROPERTY(SurfaceSource* surfaceSource READ surfaceSource CONSTANT)
 
@@ -39,18 +41,20 @@
     /* mir specific */
     std::shared_ptr<mir::shell::PlacementStrategy> the_shell_placement_strategy() override;
     std::shared_ptr<mir::shell::SessionListener> the_shell_session_listener() override;
-
+    std::shared_ptr<mir::shell::SurfaceConfigurator> the_shell_surface_configurator() override;
     std::shared_ptr<mir::shell::SurfaceFactory> the_shell_surface_factory() override;
     std::shared_ptr<mir::frontend::SessionAuthorizer> the_session_authorizer() override;
     std::shared_ptr<mir::shell::SurfaceBuilder> the_surface_builder() override;
 
     /* qt specific */
     // getters
+    SurfaceConfigurator *surfaceConfigurator() const;
     SessionListener *sessionListener() const;
-    SurfaceSource* surfaceSource() const;
+    SurfaceSource *surfaceSource() const;
 
 protected:
     std::shared_ptr<SurfaceBuilder> m_surfaceBuilder;
+    std::shared_ptr<SurfaceConfigurator> m_surfaceConfigurator;
     std::shared_ptr<SessionListener> m_sessionListener;
     std::shared_ptr<SurfaceSource> m_surfaceSource;
     std::shared_ptr<SessionAuthorizer> m_sessionAuthorizer;

=== added file 'src/unity-mir/surfaceconfigurator.cpp'
--- src/unity-mir/surfaceconfigurator.cpp	1970-01-01 00:00:00 +0000
+++ src/unity-mir/surfaceconfigurator.cpp	2013-08-20 12:03:24 +0000
@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2013 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
+ * the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
+ * SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * 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/>.
+ */
+
+#include "surfaceconfigurator.h"
+
+namespace msh = mir::shell;
+
+SurfaceConfigurator::SurfaceConfigurator()
+{
+    qRegisterMetaType<MirSurfaceAttrib>("MirSurfaceAttrib");
+}
+
+int SurfaceConfigurator::select_attribute_value(msh::Surface const&, MirSurfaceAttrib, int requested_value)
+{
+    return requested_value;
+}
+
+void SurfaceConfigurator::attribute_set(msh::Surface const& surface, MirSurfaceAttrib attrib, int value)
+{
+    Q_EMIT surfaceAttributeChanged(&surface, attrib, value);
+}

=== added file 'src/unity-mir/surfaceconfigurator.h'
--- src/unity-mir/surfaceconfigurator.h	1970-01-01 00:00:00 +0000
+++ src/unity-mir/surfaceconfigurator.h	2013-08-20 12:03:24 +0000
@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) 2013 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
+ * the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
+ * SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * 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/>.
+ */
+
+#ifndef SURFACECONFIGURATOR_H
+#define SURFACECONFIGURATOR_H
+
+#include <QObject>
+
+#include <mir/shell/surface_configurator.h>
+#include <mir_toolkit/common.h>
+
+namespace mir { namespace shell { class Surface; }}
+
+class SurfaceConfigurator : public QObject, public mir::shell::SurfaceConfigurator
+{
+    Q_OBJECT
+
+public:
+    SurfaceConfigurator();
+
+    int select_attribute_value(mir::shell::Surface const&, MirSurfaceAttrib, int) override;
+    void attribute_set(mir::shell::Surface const&, MirSurfaceAttrib, int) override;
+
+Q_SIGNALS:
+    void surfaceAttributeChanged(mir::shell::Surface const*, const MirSurfaceAttrib, const int);
+};
+
+#endif // SURFACECONFIGURATOR_H

=== modified file 'src/unity-mir/unity-mir.pro'
--- src/unity-mir/unity-mir.pro	2013-08-20 08:25:11 +0000
+++ src/unity-mir/unity-mir.pro	2013-08-20 12:03:24 +0000
@@ -19,7 +19,8 @@
     sessionlistener.cpp \
     shellserverconfiguration.cpp \
     surfacebuilder.cpp \
-    surfacesource.cpp
+    surfacesource.cpp \
+    surfaceconfigurator.cpp
 
 HEADERS += initialsurfaceplacementstrategy.h \
     qmirserverapplication.h \
@@ -29,6 +30,7 @@
     shellserverconfiguration.h \
     surfacebuilder.h \
     surfacesource.h \
+    surfaceconfigurator.h \
     logging.h
 
 CONFIG(debug) {