Merge lp:~vanvugt/mir/no-delegate into lp:mir

[Daniel van Vugt]

Deprecate MirEventDelegate. This makes the client API slightly more pleasant to use.

Binary ABI compatibility with the old form is also retained.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:2432
http://jenkins.qa.ubuntu.com/job/mir-ci/3406/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/1880
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/1879
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/1830
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/1403
        deb: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/1403/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/1830
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/1830/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/4783
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/19267

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/3406/rebuild

review: Approve (continuous-integration)

[Alan Griffiths (alan-griffiths)]

Nice

review: Approve

[Kevin DuBois (kdub)]

lgtm

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:2434
http://jenkins.qa.ubuntu.com/job/mir-ci/3409/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/1890
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/1889
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/1840
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/1406
        deb: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/1406/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/1840
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/1840/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/4793
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/19290

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/3409/rebuild

review: Approve (continuous-integration)

=== modified file 'benchmarks/frame-uniformity/touch_measuring_client.cpp'
--- benchmarks/frame-uniformity/touch_measuring_client.cpp	2015-03-30 03:20:27 +0000
+++ benchmarks/frame-uniformity/touch_measuring_client.cpp	2015-03-31 02:56:11 +0000
@@ -64,8 +64,7 @@
 
 void collect_input_and_frame_timing(MirSurface *surface, mt::Barrier& client_ready, std::chrono::high_resolution_clock::duration duration, std::shared_ptr<TouchSamples> const& results)
 {
-    MirEventDelegate event_handler = { input_callback, results.get() };
-    mir_surface_set_event_handler(surface, &event_handler);
+    mir_surface_set_event_handler(surface, input_callback, results.get());
     
     client_ready.ready();
 
 
=== modified file 'debian/changelog'
--- debian/changelog	2015-03-30 03:20:27 +0000
+++ debian/changelog	2015-03-31 02:56:11 +0000
@@ -22,6 +22,8 @@
       . Added support and example code for rendering window title strings.
       . Added proof-of-concept support for Snappy packaging for Ubuntu Core.
       . Drop support for C++11. Now C++14 is required to build Mir.
+      . Deprecated MirEventDelegate. Now you just pass the two fields as
+        parameters directly to mir_surface_set_event_handler().
       . TODO: mention more enhancements
     - ABI summary: Servers need rebuilding, but clients do not;
       . Mirclient ABI unchanged at 8
 
=== modified file 'examples/demo_client_display_config.c'
--- examples/demo_client_display_config.c	2015-03-30 03:20:27 +0000
+++ examples/demo_client_display_config.c	2015-03-31 02:56:11 +0000
@@ -368,8 +368,7 @@
     mir_connection_set_display_config_change_callback(
         connection, display_change_callback, &ctx);
 
-    struct MirEventDelegate ed = {event_callback, &ctx};
-    mir_surface_set_event_handler(surface, &ed);
+    mir_surface_set_event_handler(surface, event_callback, &ctx);
 
     time_t start = time(NULL);
 
 
=== modified file 'examples/eglapp.c'
--- examples/eglapp.c	2015-03-30 10:43:51 +0000
+++ examples/eglapp.c	2015-03-31 02:56:11 +0000
@@ -189,11 +189,6 @@
         EGL_CONTEXT_CLIENT_VERSION, 2,
         EGL_NONE
     };
-    MirEventDelegate delegate = 
-    {
-        mir_eglapp_handle_event,
-        NULL
-    };
     EGLConfig eglconfig;
     EGLint neglconfigs;
     EGLContext eglctx;
@@ -407,7 +402,7 @@
 
     CHECK(mir_surface_is_valid(surface), "Can't create a surface");
 
-    mir_surface_set_event_handler(surface, &delegate);
+    mir_surface_set_event_handler(surface, mir_eglapp_handle_event, NULL);
     
     MirCursorConfiguration *conf = mir_cursor_configuration_from_name(cursor_name);
     mir_surface_configure_cursor(surface, conf);
 
=== modified file 'examples/eglsquare.cpp'
--- examples/eglsquare.cpp	2015-03-30 03:20:27 +0000
+++ examples/eglsquare.cpp	2015-03-31 02:56:11 +0000
@@ -362,8 +362,7 @@
         mir_surface_spec_set_name(spec.get(), __PRETTY_FUNCTION__);
         mir_surface_spec_set_buffer_usage(spec.get(), mir_buffer_usage_hardware);
         auto surface = mir_surface_create_sync(spec.get());
-        MirEventDelegate delegate = {&on_event, this};
-        mir_surface_set_event_handler(surface, &delegate);
+        mir_surface_set_event_handler(surface, &on_event, this);
         return surface;
     }
     static void on_event(MirSurface*, const MirEvent *event, void *context)
 
=== modified file 'examples/fingerpaint.c'
--- examples/fingerpaint.c	2015-03-30 03:20:27 +0000
+++ examples/fingerpaint.c	2015-03-31 02:56:11 +0000
@@ -348,7 +348,6 @@
     MirConnection *conn;
     MirSurface *surf;
     MirGraphicsRegion canvas;
-    MirEventDelegate delegate = {&on_event, &canvas};
     unsigned int f;
     int swap_interval = 0;
 
@@ -452,7 +451,7 @@
     {
         mir_surface_set_title(surf, "Mir Fingerpaint");
         mir_surface_set_swapinterval(surf, swap_interval);
-        mir_surface_set_event_handler(surf, &delegate);
+        mir_surface_set_event_handler(surf, &on_event, &canvas);
     
         canvas.width = width;
         canvas.height = height;
@@ -475,7 +474,7 @@
             }
 
             /* Ensure canvas won't be used after it's freed */
-            mir_surface_set_event_handler(surf, NULL);
+            mir_surface_set_event_handler(surf, NULL, NULL);
             free(canvas.vaddr);
         }
         else
 
=== modified file 'include/client/mir_toolkit/client_types.h'
--- include/client/mir_toolkit/client_types.h	2015-03-30 03:20:27 +0000
+++ include/client/mir_toolkit/client_types.h	2015-03-31 02:56:11 +0000
@@ -278,17 +278,6 @@
     MirDisplayCard *cards;
 } MirDisplayConfiguration;
 
-/**
- * MirEventDelegate may be used to specify (at surface creation time)
- * callbacks for handling of events.
- */
-typedef mir_surface_event_callback mir_event_delegate_callback;
-typedef struct MirEventDelegate
-{
-    mir_event_delegate_callback callback;
-    void *context;
-} MirEventDelegate;
-
 typedef struct MirRectangle
 {
     int left;
 
=== modified file 'include/client/mir_toolkit/mir_surface.h'
--- include/client/mir_toolkit/mir_surface.h	2015-03-30 03:20:27 +0000
+++ include/client/mir_toolkit/mir_surface.h	2015-03-31 02:56:11 +0000
@@ -319,10 +319,12 @@
  *            called back in different threads, for the same surface,
  *            simultaneously.
  *   \param [in] surface        The surface
- *   \param [in] event_handler  The event handler to call
+ *   \param [in] callback       The callback function
+ *   \param [in] context        Additional argument to be passed to callback
  */
 void mir_surface_set_event_handler(MirSurface *surface,
-                                   MirEventDelegate const *event_handler);
+                                   mir_surface_event_callback callback,
+                                   void* context);
 
 /**
  * Retrieve the primary MirBufferStream associated with a surface (to advance buffers,
 
=== modified file 'src/client/mir_surface_api.cpp'
--- src/client/mir_surface_api.cpp	2015-03-30 03:20:27 +0000
+++ src/client/mir_surface_api.cpp	2015-03-31 02:56:11 +0000
@@ -225,14 +225,33 @@
     return surface;
 }
 
-void mir_surface_set_event_handler(MirSurface* surface,
-                                   MirEventDelegate const* delegate)
+__asm__(".symver new_mir_surface_set_event_handler,mir_surface_set_event_handler@@MIR_CLIENT_8.4");
+extern "C"
+void new_mir_surface_set_event_handler(MirSurface* surface,
+                                       mir_surface_event_callback callback,
+                                       void* context)
+{
+    surface->set_event_handler(callback, context);
+}
+
+// Deprecated but ABI backward compatible --->
+typedef struct MirEventDelegate
+{
+    mir_surface_event_callback callback;
+    void *context;
+} MirEventDelegate;
+
+__asm__(".symver old_mir_surface_set_event_handler,mir_surface_set_event_handler@MIR_CLIENT_8");
+extern "C"
+void old_mir_surface_set_event_handler(MirSurface* surface,
+                                       MirEventDelegate const* delegate)
 {
     if (delegate)
         surface->set_event_handler(delegate->callback, delegate->context);
     else
         surface->set_event_handler(nullptr, nullptr);
 }
+// <--- Deprecated
 
 MirEGLNativeWindowType mir_surface_get_egl_native_window(MirSurface* surface)
 {
 
=== modified file 'src/client/symbols.map'
--- src/client/symbols.map	2015-03-30 03:20:27 +0000
+++ src/client/symbols.map	2015-03-31 02:56:11 +0000
@@ -103,7 +103,7 @@
     mir_surface_spec_set_preferred_orientation;
 } MIR_CLIENT_8.1;
 
-MIR_CLIENT_8.3 {
+MIR_CLIENT_8.3 {   # New in Mir 0.11
  global:
     mir_connection_create_spec_for_dialog;
     mir_connection_create_spec_for_menu;
@@ -113,6 +113,7 @@
 
 MIR_CLIENT_8.4 {   # New in Mir 0.13
  global:
+    mir_surface_set_event_handler;
     mir_surface_set_title;
     mir_default_cursor_name;
     mir_disabled_cursor_name;
 
=== modified file 'src/server/graphics/nested/host_connection.h'
--- src/server/graphics/nested/host_connection.h	2015-02-02 12:18:18 +0000
+++ src/server/graphics/nested/host_connection.h	2015-03-31 02:56:11 +0000
@@ -43,7 +43,8 @@
     virtual ~HostSurface() = default;
 
     virtual EGLNativeWindowType egl_native_window() = 0;
-    virtual void set_event_handler(MirEventDelegate const* handler) = 0;
+    virtual void set_event_handler(mir_surface_event_callback cb,
+                                   void* context) = 0;
 
 protected:
     HostSurface() = default;
 
=== modified file 'src/server/graphics/nested/mir_client_host_connection.cpp'
--- src/server/graphics/nested/mir_client_host_connection.cpp	2015-03-30 03:20:27 +0000
+++ src/server/graphics/nested/mir_client_host_connection.cpp	2015-03-31 02:56:11 +0000
@@ -76,9 +76,9 @@
             mir_buffer_stream_get_egl_native_window(mir_surface_get_buffer_stream(mir_surface)));
     }
 
-    void set_event_handler(MirEventDelegate const* handler) override
+    void set_event_handler(mir_surface_event_callback cb, void* context) override
     {
-        mir_surface_set_event_handler(mir_surface, handler);
+        mir_surface_set_event_handler(mir_surface, cb, context);
     }
 
 private:
 
=== modified file 'src/server/graphics/nested/nested_output.cpp'
--- src/server/graphics/nested/nested_output.cpp	2015-03-30 03:20:27 +0000
+++ src/server/graphics/nested/nested_output.cpp	2015-03-31 02:56:11 +0000
@@ -45,8 +45,7 @@
     dispatcher{dispatcher},
     egl_surface{egl_display, host_surface->egl_native_window(), egl_config}
 {
-    MirEventDelegate ed = {event_thunk, this};
-    host_surface->set_event_handler(&ed);
+    host_surface->set_event_handler(event_thunk, this);
 }
 
 geom::Rectangle mgn::detail::NestedOutput::view_area() const
 
=== modified file 'tests/acceptance-tests/test_client_focus_notification.cpp'
--- tests/acceptance-tests/test_client_focus_notification.cpp	2015-03-30 10:43:51 +0000
+++ tests/acceptance-tests/test_client_focus_notification.cpp	2015-03-31 02:56:11 +0000
@@ -84,12 +84,7 @@
         // We need to set the event delegate from the surface_created
         // callback so we can block the reading of new events
         // until we are ready
-        MirEventDelegate const event_delegate =
-            {
-                handle_event,
-                self
-            };
-        mir_surface_set_event_handler(surface_, &event_delegate);
+        mir_surface_set_event_handler(surface_, handle_event, self);
     }
 };
 }
 
=== modified file 'tests/acceptance-tests/test_client_input.cpp'
--- tests/acceptance-tests/test_client_input.cpp	2015-03-12 14:12:15 +0000
+++ tests/acceptance-tests/test_client_input.cpp	2015-03-31 02:56:11 +0000
@@ -56,8 +56,7 @@
     {
         ConnectedClientWithASurface::SetUp();
 
-        MirEventDelegate const event_delegate { handle_input, this };
-        mir_surface_set_event_handler(surface, &event_delegate);
+        mir_surface_set_event_handler(surface, handle_input, this);
         mir_buffer_stream_swap_buffers_sync(
             mir_surface_get_buffer_stream(surface));
 
 
=== modified file 'tests/acceptance-tests/test_client_surface_events.cpp'
--- tests/acceptance-tests/test_client_surface_events.cpp	2015-03-30 20:13:06 +0000
+++ tests/acceptance-tests/test_client_surface_events.cpp	2015-03-31 02:56:11 +0000
@@ -71,7 +71,6 @@
     std::condition_variable last_event_cv;
     MirEvent last_event{};
     MirSurface* last_event_surface = nullptr;
-    MirEventDelegate delegate{&event_callback, this};
 
     std::shared_ptr<ms::Surface> scene_surface;
 
@@ -128,12 +127,12 @@
 
         mtf::ConnectedClientWithASurface::SetUp();
 
-        mir_surface_set_event_handler(surface, &delegate);
+        mir_surface_set_event_handler(surface, &event_callback, this);
 
         scene_surface = the_latest_surface();
 
         other_surface = mtf::make_any_surface(connection);
-        mir_surface_set_event_handler(other_surface, nullptr);
+        mir_surface_set_event_handler(other_surface, nullptr, nullptr);
 
         reset_last_event();
     }
 
=== modified file 'tests/acceptance-tests/test_client_surface_visibility.cpp'
--- tests/acceptance-tests/test_client_surface_visibility.cpp	2015-03-30 20:13:06 +0000
+++ tests/acceptance-tests/test_client_surface_visibility.cpp	2015-03-31 02:56:11 +0000
@@ -114,8 +114,7 @@
 
         mtf::ConnectedClientWithASurface::SetUp();
 
-        MirEventDelegate delegate{&event_callback, &mock_visibility_callback};
-        mir_surface_set_event_handler(surface, &delegate);
+        mir_surface_set_event_handler(surface, &event_callback, &mock_visibility_callback);
 
         // Swap enough buffers to ensure compositor threads are into run loop
         for (auto i = 0; i != 11; ++i)
 
=== modified file 'tests/acceptance-tests/throwback/test_client_input.cpp'
--- tests/acceptance-tests/throwback/test_client_input.cpp	2015-03-30 03:20:27 +0000
+++ tests/acceptance-tests/throwback/test_client_input.cpp	2015-03-31 02:56:11 +0000
@@ -91,8 +91,7 @@
         surface = mir_surface_create_sync(spec);
         mir_surface_spec_release(spec);
 
-        MirEventDelegate const event_delegate { handle_input, this };
-        mir_surface_set_event_handler(surface, &event_delegate);
+        mir_surface_set_event_handler(surface, handle_input, this);
         mir_buffer_stream_swap_buffers_sync(
             mir_surface_get_buffer_stream(surface));
 
 
=== modified file 'tests/include/mir_test_doubles/stub_host_connection.h'
--- tests/include/mir_test_doubles/stub_host_connection.h	2015-03-30 03:20:27 +0000
+++ tests/include/mir_test_doubles/stub_host_connection.h	2015-03-31 02:56:11 +0000
@@ -55,7 +55,7 @@
         {
         public:
             EGLNativeWindowType egl_native_window() override { return {}; }
-            void set_event_handler(MirEventDelegate const*) override {}
+            void set_event_handler(mir_surface_event_callback, void*) override {}
         };
 
         return std::make_shared<NullHostSurface>();
 
=== modified file 'tests/unit-tests/graphics/nested/test_nested_display_buffer.cpp'
--- tests/unit-tests/graphics/nested/test_nested_display_buffer.cpp	2015-03-30 03:20:27 +0000
+++ tests/unit-tests/graphics/nested/test_nested_display_buffer.cpp	2015-03-31 02:56:11 +0000
@@ -38,7 +38,7 @@
 {
 public:
     EGLNativeWindowType egl_native_window() override { return {}; }
-    void set_event_handler(MirEventDelegate const*) override {}
+    void set_event_handler(mir_surface_event_callback, void*) override {}
 };
 
 struct NestedDisplayBufferTest : testing::Test