Merge lp:~alan-griffiths/miral/raii-for-blob-and-cookie into lp:miral

[Alan Griffiths]

[libmirclientcpp] RAII wrappers for MirBlob and MirCookie

[Kevin DuBois (kdub)]

lgtm

review: Approve

[Gerry Boland (gerboland)]

Why include a default constructor at all?

review: Needs Information

[Andreas Pokorny (andreas-pokorny)]

What is the purpose of those two friend declarations?

review: Needs Information

[Alan Griffiths (alan-griffiths)]

> Why include a default constructor at all?

It makes it less surprising to use - e.g. it can be placed in a container.

[Alan Griffiths (alan-griffiths)]

> What is the purpose of those two friend declarations?

To make it impossible to pass the handle class directly to the release function. Vis:

    Cookie cookie;
    mir_cookie_release(cookie);

error: use of deleted function ‘void {anonymous}::mir_cookie_release(const {anonymous}::Cookie&)’

[Gerry Boland (gerboland)]

Ok for me

review: Approve

[Andreas Pokorny (andreas-pokorny)]

oh nice to know

review: Approve

=== added file 'include/mir/client/blob.h'
--- include/mir/client/blob.h	1970-01-01 00:00:00 +0000
+++ include/mir/client/blob.h	2017-03-07 16:36:50 +0000
@@ -0,0 +1,50 @@
+/*
+ * Copyright © 2017 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_CLIENT_BLOB_H
+#define MIR_CLIENT_BLOB_H
+
+#include <mir_toolkit/mir_blob.h>
+
+#include <memory>
+
+namespace mir
+{
+namespace client
+{
+class Blob
+{
+public:
+    Blob() = default;
+    explicit Blob(MirBlob* blob) : self{blob, deleter} {}
+
+    operator MirBlob*() const { return self.get(); }
+
+    void reset() { self.reset(); }
+    void reset(MirBlob* blob) { self.reset(blob, deleter); }
+
+    friend void mir_blob_release(Blob const&) = delete;
+
+private:
+    static void deleter(MirBlob* blob) { mir_blob_release(blob); }
+    std::shared_ptr<MirBlob> self;
+};
+}
+}
+
+#endif //MIR_CLIENT_BLOB_H

=== added file 'include/mir/client/cookie.h'
--- include/mir/client/cookie.h	1970-01-01 00:00:00 +0000
+++ include/mir/client/cookie.h	2017-03-07 16:36:50 +0000
@@ -0,0 +1,50 @@
+/*
+ * Copyright © 2017 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_CLIENT_COOKIE_H
+#define MIR_CLIENT_COOKIE_H
+
+#include <mir_toolkit/mir_cookie.h>
+
+#include <memory>
+
+namespace mir
+{
+namespace client
+{
+class Cookie
+{
+public:
+    Cookie() = default;
+    explicit Cookie(MirCookie const* cookie) : self{cookie, deleter} {}
+
+    operator MirCookie const*() const { return self.get(); }
+
+    void reset() { self.reset(); }
+    void reset(MirCookie const* cookie) { self.reset(cookie, deleter); }
+
+    friend void mir_cookie_release(Cookie const&) = delete;
+
+private:
+    static void deleter(MirCookie const* cookie) { mir_cookie_release(cookie); }
+    std::shared_ptr<MirCookie const> self;
+};
+}
+}
+
+#endif //MIR_CLIENT_COOKIE_H

=== modified file 'miral/CMakeLists.txt'
--- miral/CMakeLists.txt	2017-03-06 09:26:47 +0000
+++ miral/CMakeLists.txt	2017-03-07 16:36:50 +0000
@@ -53,6 +53,8 @@
     workspace_policy.cpp                ${CMAKE_SOURCE_DIR}/include/miral/workspace_policy.h
     window_management_policy.cpp        ${CMAKE_SOURCE_DIR}/include/miral/window_management_policy.h
     window_manager_tools.cpp            ${CMAKE_SOURCE_DIR}/include/miral/window_manager_tools.h
+                                        ${CMAKE_SOURCE_DIR}/include/mir/client/blob.h
+                                        ${CMAKE_SOURCE_DIR}/include/mir/client/cookie.h
                                         ${CMAKE_SOURCE_DIR}/include/mir/client/window_spec.h
                                         ${CMAKE_SOURCE_DIR}/include/mir/client/window_id.h
                                         ${CMAKE_SOURCE_DIR}/include/mir/client/connection.h