Merge lp:~raof/mir/add-mirclientcpp-event into lp:mir

[Chris Halse Rogers]

Add a smart-pointer-ish wrapper for MirEvent to mirclientcpp.

Useful for the obvious reasons.

[Alan Griffiths (alan-griffiths)]

LGTM

review: Approve

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:4265
https://mir-jenkins.ubuntu.com/job/mir-ci/3684/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/5051/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/5287
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=artful/5275
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/5275
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/5275
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=artful/5095
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=artful/5095/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/5095
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/5095/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=artful/5095
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=artful/5095/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/5095/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/5095
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/5095/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=artful/5095
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=artful/5095/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=zesty/5095
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=zesty/5095/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/5095
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/5095/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/3684/rebuild

review: Needs Fixing (continuous-integration)

[Mir CI Bot (mir-ci-bot)]

review: Approve (continuous-integration)

=== added file 'include/client/mir/client/event.h'
--- include/client/mir/client/event.h	1970-01-01 00:00:00 +0000
+++ include/client/mir/client/event.h	2017-09-25 18:10:00 +0000
@@ -0,0 +1,54 @@
+/*
+ * Copyright © 2017 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 2 or 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: Christopher James Halse Rogers <[e-mail]>
+ */
+
+#ifndef MIR_CLIENT_EVENT_H_
+#define MIR_CLIENT_EVENT_H_
+
+#include "mir_toolkit/events/event.h"
+
+#include <memory>
+
+namespace mir
+{
+namespace client
+{
+/// Handle class for MirEvent - provides automatic reference counting.
+class Event
+{
+public:
+    Event() = default;
+    explicit Event(MirEvent const* event) : self{mir_event_ref(event), deleter}
+    {
+    }
+
+    operator MirEvent const*() const { return self.get(); }
+
+    void reset() { self.reset(); }
+
+private:
+    static void deleter(MirEvent const* event) { mir_event_unref(event); }
+    std::shared_ptr<MirEvent const> self;
+};
+
+// Provide a deleted overload to avoid double release "accidents".
+void mir_event_unref(Event const& event) = delete;
+}
+}
+
+#endif //MIR_CLIENT_EVENT_H_
+

=== modified file 'src/client/CMakeLists.txt'
--- src/client/CMakeLists.txt	2017-08-29 14:23:50 +0000
+++ src/client/CMakeLists.txt	2017-09-25 18:10:00 +0000
@@ -118,6 +118,7 @@
   ${CMAKE_SOURCE_DIR}/include/client/mir/client/connection.h
   ${CMAKE_SOURCE_DIR}/include/client/mir/client/display_config.h
   ${CMAKE_SOURCE_DIR}/include/client/mir/client/window.h
+  ${CMAKE_SOURCE_DIR}/include/client/mir/client/event.h
 )
 
 # Ensure protobuf C++ headers have been produced before