Merge lp:~brandontschaefer/mir/new-display-blob into lp:mir

[Brandon Schaefer]

Add new blob functions for the new display API.

Add new blob functions for the new display API.

Since it really is just an mir::protobuf::DisplayConfiguration

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

FAILED: Continuous integration, rev:3883
https://mir-jenkins.ubuntu.com/job/mir-ci/2413/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/3142/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/3209
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/3201
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/3201
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/3201
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/3171
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/3171/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3171
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3171/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/3171
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/3171/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3171
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3171/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3171
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3171/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3171/console

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

review: Needs Fixing (continuous-integration)

[Brandon Schaefer (brandontschaefer)]

https://bugs.launchpad.net/mir/+bug/1649758

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

FAILED: Continuous integration, rev:3883
https://mir-jenkins.ubuntu.com/job/mir-ci/2422/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/3153/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/3220
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/3212
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/3212
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/3212
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/3182/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3182
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3182/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/3182
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/3182/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3182
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3182/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3182
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3182/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3182
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3182/artifact/output/*zip*/output.zip

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

review: Needs Fixing (continuous-integration)

[Alan Griffiths (alan-griffiths)]

OK, although the commit comment "Add new blob functions for the new display API" doesn't really reflect the complexity of name changes needed before the "new API" is available.

review: Approve

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

PASSED: Continuous integration, rev:3883
https://mir-jenkins.ubuntu.com/job/mir-ci/2446/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/3189
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/3256
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/3248
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/3248
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/3248
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/3218
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/3218/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3218
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3218/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/3218
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/3218/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3218
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3218/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3218
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3218/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3218
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3218/artifact/output/*zip*/output.zip

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

review: Approve (continuous-integration)

=== modified file 'include/client/mir_toolkit/mir_blob.h'
--- include/client/mir_toolkit/mir_blob.h	2015-09-03 09:08:29 +0000
+++ include/client/mir_toolkit/mir_blob.h	2016-12-16 02:16:24 +0000
@@ -37,6 +37,14 @@
 MirBlob* mir_blob_from_display_configuration(MirDisplayConfiguration* configuration);
 
 /**
+ * Create a blob from a display config
+ *
+ * \param [in] config  The display config
+ * \return             A blob
+ */
+MirBlob* mir_blob_from_display_config(MirDisplayConfig* config);
+
+/**
  * Create a blob from a buffer.
  * \note this does not copy the data, the buffer is assumed to be available
  *       until the blob is released.
@@ -58,6 +66,16 @@
 MirDisplayConfiguration* mir_blob_to_display_configuration(MirBlob* blob);
 
 /**
+ * Create a blob from a display config
+ *
+ * \warning will abort() if the blob doesn't represent a meaningful display config
+ *
+ * \param [in] blob        The blob
+ * \return                 A display config
+ */
+MirDisplayConfig* mir_blob_to_display_config(MirBlob* blob);
+
+/**
  * Get the size of a blob
  * \param [in] blob        The blob
  * \return                 the size

=== modified file 'src/client/mir_blob.cpp'
--- src/client/mir_blob.cpp	2015-09-16 16:30:28 +0000
+++ src/client/mir_blob.cpp	2016-12-16 02:16:24 +0000
@@ -16,6 +16,8 @@
  * Authored by: Alan Griffiths <[e-mail]>
  */
 
+#include "display_configuration.h"
+
 #include "mir_toolkit/mir_blob.h"
 #include "mir_protobuf.pb.h"
 
@@ -126,6 +128,21 @@
     return nullptr;
 }
 
+MirBlob* mir_blob_from_display_config(MirDisplayConfig* configuration)
+try
+{
+    auto blob = std::make_unique<MirManagedBlob>(static_cast<size_t>(configuration->ByteSize()));
+
+    configuration->SerializeWithCachedSizesToArray(blob->data());
+
+    return blob.release();
+}
+catch (std::exception const& x)
+{
+    MIR_LOG_UNCAUGHT_EXCEPTION(x);
+    return nullptr;
+}
+
 MirBlob* mir_blob_onto_buffer(void const* buffer, size_t buffer_size)
 try
 {
@@ -213,6 +230,21 @@
     abort();
 }
 
+MirDisplayConfig* mir_blob_to_display_config(MirBlob* blob)
+try
+{
+    auto config = new mir::protobuf::DisplayConfiguration;
+
+    config->ParseFromArray(mir_blob_data(blob), mir_blob_size(blob));
+
+    return static_cast<MirDisplayConfig*>(config);
+}
+catch (std::exception const& x)
+{
+    MIR_LOG_UNCAUGHT_EXCEPTION(x);
+    abort();
+}
+
 size_t mir_blob_size(MirBlob* blob)
 {
     return blob->size();

=== modified file 'src/client/symbols.map'
--- src/client/symbols.map	2016-12-14 06:27:05 +0000
+++ src/client/symbols.map	2016-12-16 02:16:24 +0000
@@ -500,4 +500,6 @@
     mir_touchpad_configuration_set_scroll_modes;
     mir_touchpad_configuration_set_tap_to_click;
     mir_output_get_model;
+    mir_blob_from_display_config;
+    mir_blob_to_display_config;
 } MIR_CLIENT_0.25;

=== modified file 'tests/acceptance-tests/test_mirblob.cpp'
--- tests/acceptance-tests/test_mirblob.cpp	2015-09-03 11:54:34 +0000
+++ tests/acceptance-tests/test_mirblob.cpp	2016-12-16 02:16:24 +0000
@@ -55,4 +55,31 @@
 
     mir_display_config_destroy(restore_display_config);
     mir_display_config_destroy(save_display_config);
-}
\ No newline at end of file
+}
+
+TEST_F(MirBlobAPI, can_serialize_display_config)
+{
+    std::vector<uint8_t> buffer;
+
+    auto const save_display_config = mir_connection_create_display_configuration(connection);
+
+    {
+        auto const save_blob = mir_blob_from_display_config(save_display_config);
+
+        buffer.resize(mir_blob_size(save_blob));
+        memcpy(buffer.data(), mir_blob_data(save_blob), buffer.size());
+        mir_blob_release(save_blob);
+    }
+
+    MirDisplayConfig* restore_display_config;
+    {
+        auto const restore_blob = mir_blob_onto_buffer(buffer.data(), buffer.size());
+        restore_display_config = mir_blob_to_display_config(restore_blob);
+        mir_blob_release(restore_blob);
+    }
+
+    EXPECT_THAT(save_display_config, DisplayConfigMatches(restore_display_config));
+
+    mir_display_config_release(restore_display_config);
+    mir_display_config_release(save_display_config);
+}