Merge lp:~alan-griffiths/miral/WindowManagementPolicy-advise_begin-end into lp:miral

[Alan Griffiths]

Add WindowManagementPolicy::advise_begin/advise_end()

[lp:~alan-griffiths/miral/WindowManagementPolicy-advise_begin-end]

205. By Alan Griffiths on 2016-06-08

WindowManagementPolicy::advise_begin/end()

[Gerry Boland (gerboland)]

Great, thank you.

review: Approve

=== modified file 'include/miral/canonical_window_manager.h'
--- include/miral/canonical_window_manager.h	2016-06-08 15:16:20 +0000
+++ include/miral/canonical_window_manager.h	2016-06-08 16:27:11 +0000
@@ -60,6 +60,9 @@
     bool handle_touch_event(MirTouchEvent const* event) override;
     bool handle_pointer_event(MirPointerEvent const* event) override;
 
+    void advise_begin() override;
+    void advise_end() override;
+
     void advise_new_window(WindowInfo& window_info) override;
     void advise_focus_lost(WindowInfo const& info) override;
     void advise_focus_gained(WindowInfo const& info) override;
 
=== modified file 'include/miral/window_management_policy.h'
--- include/miral/window_management_policy.h	2016-06-08 15:16:20 +0000
+++ include/miral/window_management_policy.h	2016-06-08 16:27:11 +0000
@@ -63,6 +63,13 @@
  * \note if the policy updates a Window object directly (as opposed to using tools)
  * no notification is generated.
  *  @{ */
+
+    /// before any related changes begin
+    virtual void advise_begin() = 0;
+
+    /// after any related changes end
+    virtual void advise_end() = 0;
+
     virtual void advise_new_app(ApplicationInfo& application) = 0;
     virtual void advise_delete_app(ApplicationInfo const& application) = 0;
     virtual void advise_new_window(WindowInfo& window_info) = 0;
 
=== modified file 'miral-kiosk/kiosk_window_manager.cpp'
--- miral-kiosk/kiosk_window_manager.cpp	2016-06-08 15:16:20 +0000
+++ miral-kiosk/kiosk_window_manager.cpp	2016-06-08 16:27:11 +0000
@@ -216,3 +216,11 @@
 void KioskWindowManagerPolicy::advise_move_to(miral::WindowInfo const& /*window_info*/, Point /*top_left*/)
 {
 }
+
+void KioskWindowManagerPolicy::advise_begin()
+{
+}
+
+void KioskWindowManagerPolicy::advise_end()
+{
+}
 
=== modified file 'miral-kiosk/kiosk_window_manager.h'
--- miral-kiosk/kiosk_window_manager.h	2016-06-08 15:16:20 +0000
+++ miral-kiosk/kiosk_window_manager.h	2016-06-08 16:27:11 +0000
@@ -55,6 +55,9 @@
 
     void handle_raise_window(miral::WindowInfo& window_info) override;
 
+    void advise_begin() override;
+    void advise_end() override;
+
     void advise_focus_lost(miral::WindowInfo const& info) override;
 
     void advise_focus_gained(miral::WindowInfo const& info) override;
 
=== modified file 'miral-qt/src/platforms/mirserver/windowmanagementpolicy.cpp'
--- miral-qt/src/platforms/mirserver/windowmanagementpolicy.cpp	2016-06-08 15:16:20 +0000
+++ miral-qt/src/platforms/mirserver/windowmanagementpolicy.cpp	2016-06-08 16:27:11 +0000
@@ -129,3 +129,11 @@
 {
 
 }
+
+void WindowManagementPolicy::advise_begin()
+{
+}
+
+void WindowManagementPolicy::advise_end()
+{
+}
 
=== modified file 'miral-qt/src/platforms/mirserver/windowmanagementpolicy.h'
--- miral-qt/src/platforms/mirserver/windowmanagementpolicy.h	2016-06-08 15:16:20 +0000
+++ miral-qt/src/platforms/mirserver/windowmanagementpolicy.h	2016-06-08 16:27:11 +0000
@@ -50,6 +50,9 @@
     bool handle_touch_event(const MirTouchEvent *event) override;
     bool handle_pointer_event(const MirPointerEvent *event) override;
 
+    void advise_begin() override;
+    void advise_end() override;
+
     void advise_new_app(miral::ApplicationInfo &application) override;
     void advise_delete_app(const miral::ApplicationInfo &application) override;
 
 
=== modified file 'miral-shell/tiling_window_manager.cpp'
--- miral-shell/tiling_window_manager.cpp	2016-06-08 15:16:20 +0000
+++ miral-shell/tiling_window_manager.cpp	2016-06-08 16:27:11 +0000
@@ -577,3 +577,11 @@
 void TilingWindowManagerPolicy::advise_move_to(miral::WindowInfo const& /*window_info*/, Point /*top_left*/)
 {
 }
+
+void TilingWindowManagerPolicy::advise_begin()
+{
+}
+
+void TilingWindowManagerPolicy::advise_end()
+{
+}
 
=== modified file 'miral-shell/tiling_window_manager.h'
--- miral-shell/tiling_window_manager.h	2016-06-08 15:16:20 +0000
+++ miral-shell/tiling_window_manager.h	2016-06-08 16:27:11 +0000
@@ -57,6 +57,9 @@
     bool handle_pointer_event(MirPointerEvent const* event) override;
     void handle_raise_window(miral::WindowInfo& window_info) override;
 
+    void advise_begin() override;
+    void advise_end() override;
+
     void advise_focus_lost(miral::WindowInfo const& info) override;
     void advise_focus_gained(miral::WindowInfo const& info) override;
     void advise_state_change(miral::WindowInfo const& window_info, MirSurfaceState state) override;
 
=== modified file 'miral/basic_window_manager.cpp'
--- miral/basic_window_manager.cpp	2016-06-08 15:16:20 +0000
+++ miral/basic_window_manager.cpp	2016-06-08 16:27:11 +0000
@@ -32,6 +32,24 @@
 namespace
 {
 int const title_bar_height = 10;
+
+struct Locker
+{
+    Locker(std::mutex& mutex, std::unique_ptr<miral::WindowManagementPolicy> const& policy) :
+        lock{mutex},
+        policy{policy.get()}
+    {
+        policy->advise_begin();
+    }
+
+    ~Locker()
+    {
+        policy->advise_end();
+    }
+
+    std::lock_guard<std::mutex> const lock;
+    miral::WindowManagementPolicy* const policy;
+};
 }
 
 miral::BasicWindowManager::BasicWindowManager(
@@ -69,14 +87,14 @@
 
 void miral::BasicWindowManager::add_session(std::shared_ptr<scene::Session> const& session)
 {
-    std::lock_guard<decltype(mutex)> lock(mutex);
+    Locker lock{mutex, policy};
     policy->advise_new_app(app_info[session] = ApplicationInfo(session));
     policy->handle_app_info_updated(displays);
 }
 
 void miral::BasicWindowManager::remove_session(std::shared_ptr<scene::Session> const& session)
 {
-    std::lock_guard<decltype(mutex)> lock(mutex);
+    Locker lock{mutex, policy};
     policy->advise_delete_app(app_info[session]);
     app_info.erase(session);
     policy->handle_app_info_updated(displays);
@@ -88,7 +106,7 @@
     std::function<frontend::SurfaceId(std::shared_ptr<scene::Session> const& session, scene::SurfaceCreationParameters const& params)> const& build)
 -> frontend::SurfaceId
 {
-    std::lock_guard<decltype(mutex)> lock(mutex);
+    Locker lock{mutex, policy};
     surface_builder = [build](std::shared_ptr<scene::Session> const& session, WindowSpecification const& params)
         {
             scene::SurfaceCreationParameters parameters;
@@ -131,7 +149,7 @@
     std::shared_ptr<scene::Surface> const& surface,
     shell::SurfaceSpecification const& modifications)
 {
-    std::lock_guard<decltype(mutex)> lock(mutex);
+    Locker lock{mutex, policy};
     policy->handle_modify_window(info_for(surface), modifications);
 }
 
@@ -139,7 +157,7 @@
     std::shared_ptr<scene::Session> const& session,
     std::weak_ptr<scene::Surface> const& surface)
 {
-    std::lock_guard<decltype(mutex)> lock(mutex);
+    Locker lock{mutex, policy};
     auto& info = info_for(surface);
 
     bool const is_active_window{mru_active_windows.top() == info.window()};
@@ -198,7 +216,7 @@
 
 void miral::BasicWindowManager::add_display(geometry::Rectangle const& area)
 {
-    std::lock_guard<decltype(mutex)> lock(mutex);
+    Locker lock{mutex, policy};
     displays.add(area);
 
     for (auto window : fullscreen_surfaces)
@@ -219,7 +237,7 @@
 
 void miral::BasicWindowManager::remove_display(geometry::Rectangle const& area)
 {
-    std::lock_guard<decltype(mutex)> lock(mutex);
+    Locker lock{mutex, policy};
     displays.remove(area);
     for (auto window : fullscreen_surfaces)
     {
@@ -239,21 +257,21 @@
 
 bool miral::BasicWindowManager::handle_keyboard_event(MirKeyboardEvent const* event)
 {
-    std::lock_guard<decltype(mutex)> lock(mutex);
+    Locker lock{mutex, policy};
     update_event_timestamp(event);
     return policy->handle_keyboard_event(event);
 }
 
 bool miral::BasicWindowManager::handle_touch_event(MirTouchEvent const* event)
 {
-    std::lock_guard<decltype(mutex)> lock(mutex);
+    Locker lock{mutex, policy};
     update_event_timestamp(event);
     return policy->handle_touch_event(event);
 }
 
 bool miral::BasicWindowManager::handle_pointer_event(MirPointerEvent const* event)
 {
-    std::lock_guard<decltype(mutex)> lock(mutex);
+    Locker lock{mutex, policy};
     update_event_timestamp(event);
 
     cursor = {
@@ -268,7 +286,7 @@
     std::shared_ptr<scene::Surface> const& surface,
     uint64_t timestamp)
 {
-    std::lock_guard<decltype(mutex)> lock(mutex);
+    Locker lock{mutex, policy};
     if (timestamp >= last_input_event_timestamp)
         policy->handle_raise_window(info_for(surface));
 }
@@ -309,7 +327,7 @@
         return surface->configure(attrib, value);
     }
 
-    std::lock_guard<decltype(mutex)> lock(mutex);
+    Locker lock{mutex, policy};
     auto& info = info_for(surface);
     policy->handle_modify_window(info, modification);
 
@@ -761,7 +779,7 @@
 
 void miral::BasicWindowManager::invoke_under_lock(std::function<void()> const& callback)
 {
-    std::lock_guard<decltype(mutex)> lock(mutex);
+    Locker lock{mutex, policy};
     callback();
 }
 
 
=== modified file 'miral/canonical_window_manager.cpp'
--- miral/canonical_window_manager.cpp	2016-06-08 15:16:20 +0000
+++ miral/canonical_window_manager.cpp	2016-06-08 16:27:11 +0000
@@ -409,3 +409,11 @@
 void miral::CanonicalWindowManagerPolicy::advise_move_to(miral::WindowInfo const& /*window_info*/, Point /*top_left*/)
 {
 }
+
+void miral::CanonicalWindowManagerPolicy::advise_begin()
+{
+}
+
+void miral::CanonicalWindowManagerPolicy::advise_end()
+{
+}