Merge lp:~mir-team/qtmir/iteration-0-of-miral-PersistDisplayConfig into lp:qtmir

[Alan Griffiths]

Iteration 0 of miral::PersistDisplayConfig. This does nothing yet (and breaks nothing in the process). This MP creates a place (miral-prototypes) to build prototype miral features and sketches out what will need to be implemented for PersistDisplayConfig.

[Nick Dedekind (nick-dedekind)]

Looks fine for iter 0.

review: Approve

[Nick Dedekind (nick-dedekind)]

We already have a policy in qmirserver

review: Needs Fixing

[Alan Griffiths (alan-griffiths)]

> We already have a policy in qmirserver

Added a first pass at incorporating this.

Also plumbed in use of the DisplayConfigurationObserver::base_configuration_updated() coming in Mir-0.26.

RAOF has picked up supplying the EDID - with that we'll be in a position to follow up by tracking hardware changes and persisting the stuff we want.

[Nick Dedekind (nick-dedekind)]

Are we changing the namespace to miral::experimental to resolve the conflict?

review: Needs Information

[Alan Griffiths (alan-griffiths)]

> Are we changing the namespace to miral::experimental to resolve the conflict?

We could just make it ::miral - we can co-ordinate with upstream well enough. (I'm OOTO today - will pick up in the morning.)

[Alan Griffiths (alan-griffiths)]

> > Are we changing the namespace to miral::experimental to resolve the
> conflict?
>
> We could just make it ::miral - we can co-ordinate with upstream well enough.
> (I'm OOTO today - will pick up in the morning.)

Actually, my flight's delayed so I've pushed the change

[Unity8 CI Bot (unity8-ci-bot)]

PASSED: Continuous integration, rev:589
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/439/
Executed test runs:
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build/3704
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-0-fetch/3732
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=xenial+overlay/3576
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=xenial+overlay/3576/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=zesty/3576
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=zesty/3576/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=xenial+overlay/3576
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=xenial+overlay/3576/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=zesty/3576
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=zesty/3576/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=xenial+overlay/3576
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=xenial+overlay/3576/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=zesty/3576
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=zesty/3576/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/439/rebuild

review: Approve (continuous-integration)

[Nick Dedekind (nick-dedekind)]

Still fine.

review: Approve

[lp:~mir-team/qtmir/iteration-0-of-miral-PersistDisplayConfig]

591. By Alan Griffiths on 2017-02-02

Fix for Mir-0.26 release

592. By Nick Dedekind on 2017-02-08

merged trunk

=== modified file 'src/platforms/mirserver/CMakeLists.txt'
--- src/platforms/mirserver/CMakeLists.txt	2017-02-02 09:36:07 +0000
+++ src/platforms/mirserver/CMakeLists.txt	2017-02-08 09:49:14 +0000
@@ -2,6 +2,8 @@
 # And also not anymore as pkgconfig module since Qt 5.6.
 #pkg_check_modules(QT5PLATFORM_SUPPORT Qt5PlatformSupport REQUIRED)
 
+add_subdirectory(miral)
+
 # Hacks for the QPA privates monster.
 pkg_check_modules(FONTCONFIG fontconfig REQUIRED)
 add_definitions(-DQ_FONTCONFIGDATABASE)
@@ -104,6 +106,7 @@
     offscreensurface.cpp
     inputdeviceobserver.cpp
     promptsessionmanager.cpp promptsessionmanager.h promptsession.h
+    $<TARGET_OBJECTS:miral-prototypes>
 # We need to run moc on these headers
     ${APPLICATION_API_INCLUDEDIR}/unity/shell/application/MirMousePointerInterface.h
 )

=== added directory 'src/platforms/mirserver/miral'
=== added file 'src/platforms/mirserver/miral/CMakeLists.txt'
--- src/platforms/mirserver/miral/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ src/platforms/mirserver/miral/CMakeLists.txt	2017-02-08 09:49:14 +0000
@@ -0,0 +1,5 @@
+include_directories(SYSTEM ${MIRSERVER_INCLUDE_DIRS})
+
+add_library(miral-prototypes OBJECT
+    persist_display_config.cpp persist_display_config.h
+)

=== added file 'src/platforms/mirserver/miral/persist_display_config.cpp'
--- src/platforms/mirserver/miral/persist_display_config.cpp	1970-01-01 00:00:00 +0000
+++ src/platforms/mirserver/miral/persist_display_config.cpp	2017-02-08 09:49:14 +0000
@@ -0,0 +1,151 @@
+/*
+ * Copyright © 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 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 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/>.
+ *
+ * Authored by: Alan Griffiths <[e-mail]>
+ */
+
+#include "persist_display_config.h"
+
+#include <mir/graphics/display_configuration_policy.h>
+#include <mir/server.h>
+#include <mir/version.h>
+
+#if MIR_SERVER_VERSION >= MIR_VERSION_NUMBER(0, 26, 0)
+#include <mir/graphics/display_configuration_observer.h>
+#include <mir/observer_registrar.h>
+#endif
+
+namespace mg = mir::graphics;
+
+namespace
+{
+struct PersistDisplayConfigPolicy
+{
+    PersistDisplayConfigPolicy() = default;
+    virtual ~PersistDisplayConfigPolicy() = default;
+    PersistDisplayConfigPolicy(PersistDisplayConfigPolicy const&) = delete;
+    auto operator=(PersistDisplayConfigPolicy const&) -> PersistDisplayConfigPolicy& = delete;
+
+    void apply_to(mg::DisplayConfiguration& conf, mg::DisplayConfigurationPolicy& default_policy);
+    void save_config(mg::DisplayConfiguration const& base_conf);
+};
+
+struct DisplayConfigurationPolicyAdapter : mg::DisplayConfigurationPolicy
+{
+    DisplayConfigurationPolicyAdapter(
+        std::shared_ptr<PersistDisplayConfigPolicy> const& self,
+        std::shared_ptr<mg::DisplayConfigurationPolicy> const& wrapped) :
+        self{self}, default_policy{wrapped}
+    {}
+
+    void apply_to(mg::DisplayConfiguration& conf) override
+    {
+        self->apply_to(conf, *default_policy);
+    }
+
+    std::shared_ptr<PersistDisplayConfigPolicy> const self;
+    std::shared_ptr<mg::DisplayConfigurationPolicy> const default_policy;
+};
+
+#if MIR_SERVER_VERSION >= MIR_VERSION_NUMBER(0, 26, 0)
+struct DisplayConfigurationObserver : mg::DisplayConfigurationObserver
+{
+    void initial_configuration(std::shared_ptr<mg::DisplayConfiguration const> const& /*config*/) override {}
+
+    void configuration_applied(std::shared_ptr<mg::DisplayConfiguration const> const& /*config*/) override {}
+
+    void configuration_failed(
+        std::shared_ptr<mg::DisplayConfiguration const> const& /*attempted*/,
+        std::exception const& /*error*/) override {}
+
+    void catastrophic_configuration_error(
+        std::shared_ptr<mg::DisplayConfiguration const> const& /*failed_fallback*/,
+        std::exception const& /*error*/) override {}
+};
+#else
+struct DisplayConfigurationObserver { };
+#endif
+}
+
+struct miral::PersistDisplayConfig::Self : PersistDisplayConfigPolicy, DisplayConfigurationObserver
+{
+    Self() = default;
+    Self(DisplayConfigurationPolicyWrapper const& custom_wrapper) :
+        custom_wrapper{custom_wrapper} {}
+
+    DisplayConfigurationPolicyWrapper const custom_wrapper =
+        [](const std::shared_ptr<mg::DisplayConfigurationPolicy> &wrapped) { return wrapped; };
+
+#if MIR_SERVER_VERSION >= MIR_VERSION_NUMBER(0, 26, 0)
+    void base_configuration_updated(std::shared_ptr<mg::DisplayConfiguration const> const& base_config) override
+    {
+        save_config(*base_config);
+    }
+
+    void session_configuration_applied(std::shared_ptr<mir::frontend::Session> const&,
+                                       std::shared_ptr<mg::DisplayConfiguration> const&){}
+    void session_configuration_removed(std::shared_ptr<mir::frontend::Session> const&)  {}
+#endif
+};
+
+miral::PersistDisplayConfig::PersistDisplayConfig() :
+    self{std::make_shared<Self>()}
+{
+}
+
+miral::PersistDisplayConfig::PersistDisplayConfig(DisplayConfigurationPolicyWrapper const& custom_wrapper) :
+    self{std::make_shared<Self>(custom_wrapper)}
+{
+}
+
+miral::PersistDisplayConfig::~PersistDisplayConfig() = default;
+
+miral::PersistDisplayConfig::PersistDisplayConfig(PersistDisplayConfig const&) = default;
+
+auto miral::PersistDisplayConfig::operator=(PersistDisplayConfig const&) -> PersistDisplayConfig& = default;
+
+void miral::PersistDisplayConfig::operator()(mir::Server& server)
+{
+    server.wrap_display_configuration_policy(
+        [this](std::shared_ptr<mg::DisplayConfigurationPolicy> const& wrapped)
+        -> std::shared_ptr<mg::DisplayConfigurationPolicy>
+        {
+            return std::make_shared<DisplayConfigurationPolicyAdapter>(self, self->custom_wrapper(wrapped));
+        });
+
+#if MIR_SERVER_VERSION >= MIR_VERSION_NUMBER(0, 26, 0)
+    server.add_init_callback([this, &server]
+        { server.the_display_configuration_observer_registrar()->register_interest(self); });
+#else
+    // Up to Mir-0.25 detecting changes to the base display config is only possible client-side
+    // (and gives a different configuration API)
+    // If we decide implementing this is necessary for earlier Mir versions then this is where to plumb it in.
+    (void)&PersistDisplayConfigPolicy::save_config; // Fake "using" the function for now
+#endif
+}
+
+void PersistDisplayConfigPolicy::apply_to(
+    mg::DisplayConfiguration& conf,
+    mg::DisplayConfigurationPolicy& default_policy)
+{
+    // TODO if the h/w profile (by some definition) has changed, then apply corresponding saved config (if any).
+    // TODO Otherwise...
+    default_policy.apply_to(conf);
+}
+
+void PersistDisplayConfigPolicy::save_config(mg::DisplayConfiguration const& /*base_conf*/)
+{
+    // TODO save display config options against the h/w profile
+}

=== added file 'src/platforms/mirserver/miral/persist_display_config.h'
--- src/platforms/mirserver/miral/persist_display_config.h	1970-01-01 00:00:00 +0000
+++ src/platforms/mirserver/miral/persist_display_config.h	2017-02-08 09:49:14 +0000
@@ -0,0 +1,52 @@
+/*
+ * Copyright © 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 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 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/>.
+ *
+ * Authored by: Alan Griffiths <[e-mail]>
+ */
+
+#ifndef MIRAL_PERSIST_DISPLAY_CONFIG_H
+#define MIRAL_PERSIST_DISPLAY_CONFIG_H
+
+#include <functional>
+#include <memory>
+
+namespace mir { class Server; namespace graphics { class DisplayConfigurationPolicy; }}
+
+// Prototyping namespace for later incorporation in MirAL
+namespace miral
+{
+/// Restores the saved display configuration and saves changes to the base configuration
+class PersistDisplayConfig
+{
+public:
+    PersistDisplayConfig();
+    ~PersistDisplayConfig();
+    PersistDisplayConfig(PersistDisplayConfig const&);
+    auto operator=(PersistDisplayConfig const&) -> PersistDisplayConfig&;
+
+    // TODO factor this out better
+    using DisplayConfigurationPolicyWrapper =
+        std::function<std::shared_ptr<mir::graphics::DisplayConfigurationPolicy>(const std::shared_ptr<mir::graphics::DisplayConfigurationPolicy> &wrapped)>;
+    PersistDisplayConfig(DisplayConfigurationPolicyWrapper const& custom_wrapper);
+
+    void operator()(mir::Server& server);
+
+private:
+    struct Self;
+    std::shared_ptr<Self> self;
+};
+}
+
+#endif //MIRAL_PERSIST_DISPLAY_CONFIG_H

=== modified file 'src/platforms/mirserver/mirdisplayconfigurationpolicy.cpp'
--- src/platforms/mirserver/mirdisplayconfigurationpolicy.cpp	2016-11-03 20:17:46 +0000
+++ src/platforms/mirserver/mirdisplayconfigurationpolicy.cpp	2017-02-08 09:49:14 +0000
@@ -112,15 +112,11 @@
             }
         });
 }
+
 } //namespace
 
-void qtmir::setDisplayConfigurationPolicy(mir::Server& server)
+auto qtmir::wrapDisplayConfigurationPolicy(const std::shared_ptr<mg::DisplayConfigurationPolicy>& wrapped)
+-> std::shared_ptr<mg::DisplayConfigurationPolicy>
 {
-    server.wrap_display_configuration_policy(
-        [](const std::shared_ptr<mg::DisplayConfigurationPolicy> &wrapped)
-            -> std::shared_ptr<mg::DisplayConfigurationPolicy>
-            {
-                return std::make_shared<MirDisplayConfigurationPolicy>(wrapped);
-            });
-
+    return std::make_shared<MirDisplayConfigurationPolicy>(wrapped);
 }

=== modified file 'src/platforms/mirserver/mirdisplayconfigurationpolicy.h'
--- src/platforms/mirserver/mirdisplayconfigurationpolicy.h	2016-11-03 20:17:46 +0000
+++ src/platforms/mirserver/mirdisplayconfigurationpolicy.h	2017-02-08 09:49:14 +0000
@@ -17,11 +17,15 @@
 #ifndef MIRDISPLAYCONFIGURATIONPOLICY_H
 #define MIRDISPLAYCONFIGURATIONPOLICY_H
 
-namespace mir { class Server; }
+#include <memory>
+
+namespace mir { namespace graphics { class DisplayConfigurationPolicy; }}
 
 namespace qtmir
 {
-void setDisplayConfigurationPolicy(mir::Server& server);
+
+auto wrapDisplayConfigurationPolicy(const std::shared_ptr<mir::graphics::DisplayConfigurationPolicy> &wrapped)
+-> std::shared_ptr<mir::graphics::DisplayConfigurationPolicy>;
 }
 
 

=== modified file 'src/platforms/mirserver/qmirserver_p.cpp'
--- src/platforms/mirserver/qmirserver_p.cpp	2017-01-03 20:59:50 +0000
+++ src/platforms/mirserver/qmirserver_p.cpp	2017-02-08 09:49:14 +0000
@@ -24,6 +24,9 @@
 #include "promptsessionmanager.h"
 #include "setqtcompositor.h"
 
+// prototyping for later incorporation in miral
+#include <miral/persist_display_config.h>
+
 // miral
 #include <miral/add_init_callback.h>
 #include <miral/set_command_line_hander.h>
@@ -135,11 +138,11 @@
             m_mirServerHooks,
             miral::set_window_managment_policy<WindowManagementPolicy>(m_windowModelNotifier, m_windowController,
                     m_appNotifier, screensModel),
-            qtmir::setDisplayConfigurationPolicy,
             setCommandLineHandler,
             addInitCallback,
             qtmir::SetQtCompositor{screensModel},
             setTerminator,
+            miral::PersistDisplayConfig{&qtmir::wrapDisplayConfigurationPolicy}
         });
 }