Merge lp:~mir-team/mir/add-input-method-surface-spec into lp:mir

[Robert Carr]

Add input method surface spec constructor to client API

For the OSK. Presently its using platform API via qtubuntu. Platform API doesn't build with -Werror-deprecated-declarations and hascontinued to use mir_surface_set_type.

This is required to unblock qtubuntu/port-to-mirclient

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:2279
http://jenkins.qa.ubuntu.com/job/mir-ci/2859/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/1132
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/1131/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/1093
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/856
        deb: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/856/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/1093
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/1093/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/4147
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/17626

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

review: Needs Fixing (continuous-integration)

[Chris Halse Rogers (raof)]

Seems legit

review: Approve

[Alexandros Frantzis (afrantzis)]

Looks good. CI failure is unrelated.

review: Approve

[Alan Griffiths (alan-griffiths)]

71 +
72 +
73 +
...
110 +

Is there a surplus of whitespace?

review: Approve

[Alberto Aguirre (albaguirre)]

LGTM

review: Approve

[Robert Carr (robertcarr)]

Accidentally --overwrote branch with lp:mir lol...just a sec.

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/mir-autolanding/1090/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/1147/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/1146
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/1108
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-autolanding/270
        deb: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-autolanding/270/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/1108
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/1108/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/4161
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/17657

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/mir-autolanding/1092/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/1158
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/1157/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/1117/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-autolanding/272/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/1117/console

review: Needs Fixing (continuous-integration)

[Robert Carr (robertcarr)]

sha1sums strikes again :(

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:2284
http://jenkins.qa.ubuntu.com/job/mir-ci/2881/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/1164
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/1163
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/1123
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/878
        deb: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/878/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/1123
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/1123/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/4175
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/17703

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

review: Approve (continuous-integration)

=== modified file 'client-ABI-sha1sums'
--- client-ABI-sha1sums	2015-01-29 04:34:12 +0000
+++ client-ABI-sha1sums	2015-02-03 09:56:22 +0000
@@ -6,7 +6,7 @@
 d739af6e64db6b314a727b5fb00be662b98ccd57  include/client/mir_toolkit/mir_platform_message.h
 9d50df5a141ca03ee8a79f7e844ed4b8b3b7d5d3  include/client/mir_toolkit/mir_prompt_session.h
 21d07e655e85eeec8a3523e1c6f9c2252176ec01  include/client/mir_toolkit/mir_screencast.h
-232664cab86958838946ab051e845be5fbd485ca  include/client/mir_toolkit/mir_surface.h
+07c140966a72af13606993f7f8e58b79441f92e6  include/client/mir_toolkit/mir_surface.h
 b141c4d79802ad626d969249c0004744e5c2a525  include/client/mir_toolkit/mir_wait.h
 6f7b4ecc22afba923806ed2bd7d8244be90b0cfd  include/client/mir_toolkit/version.h
 3350dac884d6006753de2a955bc7a05663cd9449  include/common/mir_toolkit/client_types.h

=== modified file 'include/client/mir_toolkit/mir_surface.h'
--- include/client/mir_toolkit/mir_surface.h	2015-01-22 14:33:14 +0000
+++ include/client/mir_toolkit/mir_surface.h	2015-02-03 09:56:22 +0000
@@ -548,6 +548,22 @@
  */
 MirOrientationMode mir_surface_get_preferred_orientation(MirSurface *surface);
 
+/**
+ * Create a surface specification for an input method surface.
+ *
+ * Currently this is only appropriate for the Unity On-Screen-Keyboard.
+ *
+ * \param [in] connection   Connection the surface will be created on
+ * \param [in] width        Requested width. The server is not guaranteed to return a surface of this width.
+ * \param [in] height       Requested height. The server is not guaranteed to return a surface of this height.
+ * \param [in] format       Pixel format for the surface.
+ * \return                  A handle that can be passed to mir_surface_create() to complete construction.
+ */
+MirSurfaceSpec* mir_connection_create_spec_for_input_method(MirConnection* connection,
+                                                            int width,
+                                                            int height,
+                                                            MirPixelFormat format);
+
 #ifdef __cplusplus
 }
 /**@}*/

=== modified file 'src/client/mir_surface_api.cpp'
--- src/client/mir_surface_api.cpp	2015-01-22 14:33:14 +0000
+++ src/client/mir_surface_api.cpp	2015-02-03 09:56:22 +0000
@@ -97,6 +97,16 @@
     return spec;
 }
 
+MirSurfaceSpec* mir_connection_create_spec_for_input_method(MirConnection* connection,
+                                                      int width,
+                                                      int height,
+                                                      MirPixelFormat format)
+{
+    auto spec = new MirSurfaceSpec{connection, width, height, format};
+    spec->type = mir_surface_type_inputmethod;
+    return spec;
+}
+
 MirSurfaceSpec* mir_connection_create_spec_for_modal_dialog(MirConnection* connection,
                                                            int width,
                                                            int height,

=== modified file 'tests/acceptance-tests/test_client_surfaces.cpp'
--- tests/acceptance-tests/test_client_surfaces.cpp	2015-01-20 16:30:18 +0000
+++ tests/acceptance-tests/test_client_surfaces.cpp	2015-02-03 09:56:22 +0000
@@ -282,3 +282,17 @@
     mir_surface_release_sync(dialog);
 }
 
+TEST_F(ClientSurfaces, can_be_input_methods)
+{
+    auto spec = mir_connection_create_spec_for_input_method(connection, 640, 480,
+        mir_pixel_format_abgr_8888);
+    ASSERT_THAT(spec, NotNull());
+
+    auto im = mir_surface_create_sync(spec);
+    mir_surface_spec_release(spec);
+
+    EXPECT_EQ(mir_surface_get_type(im), mir_surface_type_inputmethod);
+
+    mir_surface_release_sync(im);
+}
+