Merge lp:~alan-griffiths/mir/create-windowspec-for-all-types into lp:mir

[Alan Griffiths]

[libmirclient] Add mir_create_[freestyle|gloss|satellite|utility]_window_spec

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

PASSED: Continuous integration, rev:4050
https://mir-jenkins.ubuntu.com/job/mir-ci/3039/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/4062
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/4149
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/4139
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/4139
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/4139
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/4089
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/4089/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/4089
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/4089/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/4089
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/4089/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/4089
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/4089/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/4089
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/4089/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/4089
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/4089/artifact/output/*zip*/output.zip

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

review: Approve (continuous-integration)

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

PASSED: Continuous integration, rev:4051
https://mir-jenkins.ubuntu.com/job/mir-ci/3059/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/4090
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/4177
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/4167
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/4167
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/4167
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/4117
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/4117/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/4117
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/4117/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/4117
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/4117/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/4117
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/4117/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/4117
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/4117/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/4117
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/4117/artifact/output/*zip*/output.zip

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

review: Approve (continuous-integration)

[Alexandros Frantzis (afrantzis)]

Nits:

+ mir_output_get_logical_width;
  mir_output_get_logical_height;
- mir_output_get_logical_width;
+ mir_create_freestyle_window_spec;
+ mir_create_gloss_window_spec;
+ mir_create_satellite_window_spec;
+ mir_create_utility_window_spec;

I thought we were trying to keep symbols in alphabetical order :)

+ auto parent = mtf::make_any_surface(connection);

Not used, but fixed in dependent branch, so non-blocking.

review: Approve

[Alan Griffiths (alan-griffiths)]

> Not used, but fixed in dependent branch, so non-blocking.

fixed

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

PASSED: Continuous integration, rev:4052
https://mir-jenkins.ubuntu.com/job/mir-ci/3060/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/4091
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/4178
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/4168
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/4168
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/4168
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/4118
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/4118/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/4118
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/4118/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/4118
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/4118/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/4118
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/4118/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/4118
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/4118/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/4118
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/4118/artifact/output/*zip*/output.zip

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

review: Approve (continuous-integration)

=== modified file 'include/client/mir_toolkit/mir_window.h'
--- include/client/mir_toolkit/mir_window.h	2017-02-15 07:38:33 +0000
+++ include/client/mir_toolkit/mir_window.h	2017-02-24 14:11:58 +0000
@@ -170,6 +170,51 @@
                                     int width, int height);
 
 /**
+ * Create a window specification for a gloss window.
+ *
+ * \param [in] connection   Connection the window will be created on
+ * \param [in] width        Requested width. The server is not guaranteed to return a window of this width.
+ * \param [in] height       Requested height. The server is not guaranteed to return a window of this height.
+ * \return                  A handle that can be passed to mir_create_window() to complete construction.
+ */
+MirWindowSpec*
+mir_create_gloss_window_spec(MirConnection* connection, int width, int height);
+
+/**
+ * Create a window specification for a satellite window.
+ *
+ * \param [in] connection   Connection the window will be created on
+ * \param [in] width        Requested width. The server is not guaranteed to return a window of this width.
+ * \param [in] height       Requested height. The server is not guaranteed to return a window of this height.
+ * \param [in] parent       A valid parent window.
+ * \return                  A handle that can be passed to mir_create_window() to complete construction.
+ */
+MirWindowSpec*
+mir_create_satellite_window_spec(MirConnection* connection, int width, int height, MirWindow* parent);
+
+/**
+ * Create a window specification for a utility window.
+ *
+ * \param [in] connection   Connection the window will be created on
+ * \param [in] width        Requested width. The server is not guaranteed to return a window of this width.
+ * \param [in] height       Requested height. The server is not guaranteed to return a window of this height.
+ * \return                  A handle that can be passed to mir_create_window() to complete construction.
+ */
+MirWindowSpec*
+mir_create_utility_window_spec(MirConnection* connection, int width, int height);
+
+/**
+ * Create a window specification for a freestyle window.
+ *
+ * \param [in] connection   Connection the window will be created on
+ * \param [in] width        Requested width. The server is not guaranteed to return a window of this width.
+ * \param [in] height       Requested height. The server is not guaranteed to return a window of this height.
+ * \return                  A handle that can be passed to mir_create_window() to complete construction.
+ */
+MirWindowSpec*
+mir_create_freestyle_window_spec(MirConnection* connection, int width, int height);
+
+/**
  * Create a window specification.
  * This can be used with mir_create_window() to create a window or with
  * mir_window_apply_spec() to change an existing window.

=== modified file 'src/client/mir_surface_api.cpp'
--- src/client/mir_surface_api.cpp	2017-02-15 07:38:33 +0000
+++ src/client/mir_surface_api.cpp	2017-02-24 14:11:58 +0000
@@ -132,6 +132,41 @@
     return spec;
 }
 
+MirWindowSpec*
+mir_create_gloss_window_spec(MirConnection* connection, int width, int height)
+{
+    auto spec = new MirWindowSpec{connection, width, height, mir_pixel_format_invalid};
+    spec->type = mir_window_type_gloss;
+    return spec;
+}
+
+MirWindowSpec*
+mir_create_satellite_window_spec(MirConnection* connection, int width, int height, MirWindow* parent)
+{
+    mir::require(mir_window_is_valid(parent));
+
+    auto spec = new MirWindowSpec{connection, width, height, mir_pixel_format_invalid};
+    spec->type = mir_window_type_satellite;
+    spec->parent = parent;
+
+    return spec;
+}
+
+MirWindowSpec*
+mir_create_utility_window_spec(MirConnection* connection, int width, int height)
+{
+    auto spec = new MirWindowSpec{connection, width, height, mir_pixel_format_invalid};
+    spec->type = mir_window_type_utility;
+    return spec;
+}
+
+MirWindowSpec*
+mir_create_freestyle_window_spec(MirConnection* connection, int width, int height){
+    auto spec = new MirWindowSpec{connection, width, height, mir_pixel_format_invalid};
+    spec->type = mir_window_type_freestyle;
+    return spec;
+}
+
 MirWindowSpec* mir_create_window_spec(MirConnection* connection)
 try
 {

=== modified file 'src/client/symbols.map'
--- src/client/symbols.map	2017-02-22 14:36:45 +0000
+++ src/client/symbols.map	2017-02-24 14:11:58 +0000
@@ -609,6 +609,10 @@
   global:
     mir_connection_apply_session_input_config;
     mir_connection_set_base_input_config;
+    mir_create_freestyle_window_spec;
+    mir_create_gloss_window_spec;
+    mir_create_satellite_window_spec;
+    mir_create_utility_window_spec;
     mir_get_client_api_version;
     mir_input_device_get_keyboard_config;
     mir_input_device_get_mutable_keyboard_config;

=== modified file 'tests/acceptance-tests/test_client_surfaces.cpp'
--- tests/acceptance-tests/test_client_surfaces.cpp	2017-02-15 07:38:33 +0000
+++ tests/acceptance-tests/test_client_surfaces.cpp	2017-02-24 14:11:58 +0000
@@ -248,6 +248,65 @@
     mir_window_release_sync(im);
 }
 
+TEST_F(ClientSurfaces, can_be_gloss)
+{
+    auto parent = mtf::make_any_surface(connection);
+    auto spec = mir_create_gloss_window_spec(connection, 640, 480);
+    ASSERT_THAT(spec, NotNull());
+    mir_window_spec_set_pixel_format(spec, mir_pixel_format_abgr_8888);
+
+    auto window = mir_create_window_sync(spec);
+    mir_window_spec_release(spec);
+    EXPECT_EQ(mir_window_get_type(window), mir_window_type_gloss);
+
+    mir_window_release_sync(window);
+    mir_window_release_sync(parent);
+}
+
+TEST_F(ClientSurfaces, can_be_satellite)
+{
+    auto parent = mtf::make_any_surface(connection);
+    auto spec = mir_create_satellite_window_spec(connection, 640, 480, parent);
+    ASSERT_THAT(spec, NotNull());
+    mir_window_spec_set_pixel_format(spec, mir_pixel_format_abgr_8888);
+
+    auto window = mir_create_window_sync(spec);
+    mir_window_spec_release(spec);
+
+    EXPECT_EQ(mir_window_get_type(window), mir_window_type_satellite);
+
+    mir_window_release_sync(window);
+    mir_window_release_sync(parent);
+}
+
+TEST_F(ClientSurfaces, can_be_utility)
+{
+    auto spec = mir_create_utility_window_spec(connection, 640, 480);
+    ASSERT_THAT(spec, NotNull());
+    mir_window_spec_set_pixel_format(spec, mir_pixel_format_abgr_8888);
+
+    auto window = mir_create_window_sync(spec);
+    mir_window_spec_release(spec);
+
+    EXPECT_EQ(mir_window_get_type(window), mir_window_type_utility);
+
+    mir_window_release_sync(window);
+}
+
+TEST_F(ClientSurfaces, can_be_freestyle)
+{
+    auto spec = mir_create_freestyle_window_spec(connection, 640, 480);
+    ASSERT_THAT(spec, NotNull());
+    mir_window_spec_set_pixel_format(spec, mir_pixel_format_abgr_8888);
+
+    auto window = mir_create_window_sync(spec);
+    mir_window_spec_release(spec);
+
+    EXPECT_EQ(mir_window_get_type(window), mir_window_type_freestyle);
+
+    mir_window_release_sync(window);
+}
+
 TEST_F(ClientSurfaces, can_be_renamed)
 {
     auto spec = mir_create_normal_window_spec(connection, 123, 456);