Merge lp:~vanvugt/mir/simplify-DisplayBufferCompositors into lp:mir

[Daniel van Vugt]

Simplify {Default,Basic}DisplayBufferCompositor classes into one.
Less code and resolves a TODO.

This does not appear to affect Unity8 or ABIs.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1098
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/67/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-saucy-i386-build/2195
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-saucy-amd64-build/2080
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-saucy-amd64-ci/67
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-saucy-amd64-ci/67/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins:8080/job/mir-team-mir-development-branch-ci/67/rebuild

review: Approve (continuous-integration)

[Alan Griffiths (alan-griffiths)]

This make more sense in conjunction with the dependent composite-not-compose, but is OK.

Note that this is both an API and ABI change - but shouldn't affect any downstream projects we know about.

review: Approve

[Kevin DuBois (kdub)]

much better

review: Approve

=== removed file 'include/server/mir/compositor/basic_display_buffer_compositor.h'
--- include/server/mir/compositor/basic_display_buffer_compositor.h	2013-08-28 03:41:48 +0000
+++ include/server/mir/compositor/basic_display_buffer_compositor.h	1970-01-01 00:00:00 +0000
@@ -1,58 +0,0 @@
-/*
- * Copyright © 2013 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 MIR_COMPOSITOR_BASIC_DISPLAY_BUFFER_COMPOSITOR_H_
-#define MIR_COMPOSITOR_BASIC_DISPLAY_BUFFER_COMPOSITOR_H_
-
-#include "mir/compositor/display_buffer_compositor.h"
-
-#include <functional>
-#include <memory>
-
-namespace mir
-{
-namespace graphics
-{
-class DisplayBuffer;
-}
-
-namespace geometry
-{
-struct Rectangle;
-}
-
-namespace compositor
-{
-class BasicDisplayBufferCompositor : public DisplayBufferCompositor
-{
-public:
-    BasicDisplayBufferCompositor(graphics::DisplayBuffer& display_buffer);
-
-    virtual void composite();
-    virtual void compose(
-        mir::geometry::Rectangle const& view_area,
-        std::function<void(std::shared_ptr<void> const&)> save_resource) = 0;
-
-protected:
-    graphics::DisplayBuffer& display_buffer;
-};
-}
-}
-
-#endif /* MIR_COMPOSITOR_BASIC_DISPLAY_BUFFER_COMPOSITOR_H_ */

=== modified file 'src/server/compositor/CMakeLists.txt'
--- src/server/compositor/CMakeLists.txt	2013-08-28 03:41:48 +0000
+++ src/server/compositor/CMakeLists.txt	2013-10-02 07:14:01 +0000
@@ -1,7 +1,6 @@
 set(
   MIR_COMPOSITOR_SRCS
 
-  basic_display_buffer_compositor.cpp
   default_display_buffer_compositor.cpp
   default_display_buffer_compositor_factory.cpp
   temporary_buffers.cpp

=== removed file 'src/server/compositor/basic_display_buffer_compositor.cpp'
--- src/server/compositor/basic_display_buffer_compositor.cpp	2013-08-28 03:41:48 +0000
+++ src/server/compositor/basic_display_buffer_compositor.cpp	1970-01-01 00:00:00 +0000
@@ -1,49 +0,0 @@
-/*
- * Copyright © 2013 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 "mir/compositor/basic_display_buffer_compositor.h"
-
-#include "mir/graphics/display_buffer.h"
-
-#include <vector>
-
-namespace mc = mir::compositor;
-namespace mg = mir::graphics;
-
-mc::BasicDisplayBufferCompositor::BasicDisplayBufferCompositor(
-    mg::DisplayBuffer& display_buffer)
-    : display_buffer(display_buffer)
-{
-}
-
-// TODO I'm not clear why this code is in the DisplayBufferCompositor hierarchy.
-//      (As opposed to the call site calling compose directly.)
-//      But changing that breaks RecordingDisplayBufferCompositor - which is too
-//      much churn for this refactoring.
-void mc::BasicDisplayBufferCompositor::composite()
-{
-    // preserves buffers used in rendering until after post_update()
-    std::vector<std::shared_ptr<void>> saved_resources;
-    auto save_resource = [&](std::shared_ptr<void> const& r) { saved_resources.push_back(r); };
-
-    display_buffer.make_current();
-
-    compose(display_buffer.view_area(), save_resource);
-
-    display_buffer.post_update();
-}

=== modified file 'src/server/compositor/default_display_buffer_compositor.cpp'
--- src/server/compositor/default_display_buffer_compositor.cpp	2013-09-20 18:19:53 +0000
+++ src/server/compositor/default_display_buffer_compositor.cpp	2013-10-02 07:14:01 +0000
@@ -28,6 +28,7 @@
 #include "bypass.h"
 #include <mutex>
 #include <cstdlib>
+#include <vector>
 
 namespace mc = mir::compositor;
 namespace mg = mir::graphics;
@@ -64,7 +65,7 @@
     std::shared_ptr<mc::Scene> const& scene,
     std::shared_ptr<mc::Renderer> const& renderer,
     std::shared_ptr<mc::OverlayRenderer> const& overlay_renderer)
-    : mc::BasicDisplayBufferCompositor{display_buffer},
+    : display_buffer(display_buffer),
       scene{scene},
       renderer{renderer},
       overlay_renderer{overlay_renderer},
@@ -118,7 +119,17 @@
     }
 
     if (!bypassed)
-        mc::BasicDisplayBufferCompositor::composite();
+    {
+        // preserves buffers used in rendering until after post_update()
+        std::vector<std::shared_ptr<void>> saved_resources;
+        auto save_resource = [&](std::shared_ptr<void> const& r) { saved_resources.push_back(r); };
+    
+        display_buffer.make_current();
+    
+        compose(display_buffer.view_area(), save_resource);
+    
+        display_buffer.post_update();
+    }
 }
 
 void mc::DefaultDisplayBufferCompositor::compose(

=== modified file 'src/server/compositor/default_display_buffer_compositor.h'
--- src/server/compositor/default_display_buffer_compositor.h	2013-08-29 09:00:55 +0000
+++ src/server/compositor/default_display_buffer_compositor.h	2013-10-02 07:14:01 +0000
@@ -19,7 +19,8 @@
 #ifndef MIR_COMPOSITOR_DEFAULT_DISPLAY_BUFFER_COMPOSITOR_H_
 #define MIR_COMPOSITOR_DEFAULT_DISPLAY_BUFFER_COMPOSITOR_H_
 
-#include "mir/compositor/basic_display_buffer_compositor.h"
+#include "mir/compositor/display_buffer_compositor.h"
+#include <memory>
 
 namespace mir
 {
@@ -27,6 +28,10 @@
 {
 class DisplayBuffer;
 }
+namespace geometry
+{
+struct Rectangle;
+}
 namespace compositor
 {
 
@@ -34,7 +39,7 @@
 class Renderer;
 class OverlayRenderer;
 
-class DefaultDisplayBufferCompositor : public BasicDisplayBufferCompositor
+class DefaultDisplayBufferCompositor : public DisplayBufferCompositor
 {
 public:
     DefaultDisplayBufferCompositor(
@@ -50,6 +55,8 @@
         std::function<void(std::shared_ptr<void> const&)> save_resource);
 
 private:
+    graphics::DisplayBuffer& display_buffer;
+
     std::shared_ptr<Scene> const scene;
     std::shared_ptr<Renderer> const renderer;
     std::shared_ptr<OverlayRenderer> const overlay_renderer;