Merge lp:~alan-griffiths/mir/add-mir_surface_spec_set_shell_chrome into lp:mir

[Alan Griffiths]

client API, shell: Add an API to request a low-chrome display mode

client API, shell: Add an API to request a low-chrome display mode

The server may interpret this by, for example, hiding indicators

[Michał Sawicz (saviq)]

review: Approve (conceptual)

[Nick Dedekind (nick-dedekind)]

review: Approve

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

FAILED: Continuous integration, rev:3267
https://mir-jenkins.ubuntu.com/job/mir-ci/152/
Executed test runs:
    None: https://mir-jenkins.ubuntu.com/job/generic-update-mp/152/console

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

review: Needs Fixing (continuous-integration)

[Brandon Schaefer (brandontschaefer)]

   repeated Rectangle input_shape = 22;
+ optional int32 shell_chrome = 24;

23 here? Or 24 to be consistent with the other one?

- local:
- *;

As long as there is a different local:*; in client which IIRC theres hundreds.

Also not 100% what *chrome* is but code looks fine to me

review: Approve

[Alberto Aguirre (albaguirre)]

Good, separate from window state.

LGTM.

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3267
http://jenkins.qa.ubuntu.com/job/mir-ci/6124/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/5679
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/4586
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/5635
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-xenial-touch/333/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-xenial-amd64-ci/448
        deb: http://jenkins.qa.ubuntu.com/job/mir-xenial-amd64-ci/448/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-xenial-i386-ci/448
        deb: http://jenkins.qa.ubuntu.com/job/mir-xenial-i386-ci/448/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/5632
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/5632/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-touch/8067
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/27016
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-xenial-armhf/329
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-xenial-armhf/329/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-xenial-touch/185/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/27019

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

review: Approve (continuous-integration)

=== modified file 'include/client/mir_toolkit/mir_surface.h'
--- include/client/mir_toolkit/mir_surface.h	2016-01-20 23:59:18 +0000
+++ include/client/mir_toolkit/mir_surface.h	2016-01-25 14:54:02 +0000
@@ -499,6 +499,16 @@
     mir_surface_event_callback callback,
     void* context);
 
+
+/**
+ * Ask the shell to customize "chrome" for this surface.
+ * For example, on the phone hide indicators when this surface is active.
+ *
+ * \param [in] spec The spec to accumulate the request in.
+ * \param [in] style The requested level of "chrome"
+ */
+void mir_surface_spec_set_shell_chrome(MirSurfaceSpec* spec, MirShellChrome style);
+
 /**
  * Set the event handler to be called when events arrive for a surface.
  *   \warning event_handler could be called from another thread. You must do

=== modified file 'include/common/mir_toolkit/common.h'
--- include/common/mir_toolkit/common.h	2016-01-20 23:59:18 +0000
+++ include/common/mir_toolkit/common.h	2016-01-25 14:54:02 +0000
@@ -204,6 +204,15 @@
     mir_form_factor_projector,
 } MirFormFactor;
 
+/**
+ * Shell chrome
+ */
+typedef enum MirShellChrome
+{
+    mir_shell_chrome_normal,
+    mir_shell_chrome_low,
+} MirShellChrome;
+
 /**@}*/
 
 #endif

=== modified file 'include/server/mir/scene/surface_creation_parameters.h'
--- include/server/mir/scene/surface_creation_parameters.h	2016-01-20 23:59:18 +0000
+++ include/server/mir/scene/surface_creation_parameters.h	2016-01-25 14:54:02 +0000
@@ -100,6 +100,7 @@
     mir::optional_value<shell::SurfaceAspectRatio> max_aspect;
 
     mir::optional_value<std::vector<geometry::Rectangle>> input_shape;
+    mir::optional_value<MirShellChrome> shell_chrome;
 };
 
 bool operator==(const SurfaceCreationParameters& lhs, const SurfaceCreationParameters& rhs);

=== modified file 'include/server/mir/shell/surface_specification.h'
--- include/server/mir/shell/surface_specification.h	2016-01-20 23:59:18 +0000
+++ include/server/mir/shell/surface_specification.h	2016-01-25 14:54:02 +0000
@@ -81,6 +81,7 @@
     //
     //    it also has size instead of width + height
     // Maybe SurfaceCreationParameters /HasA/ SurfaceSpecification?
+    mir::optional_value<MirShellChrome> shell_chrome;
 };
 }
 }

=== modified file 'src/client/mir_connection.cpp'
--- src/client/mir_connection.cpp	2016-01-20 23:59:18 +0000
+++ src/client/mir_connection.cpp	2016-01-25 14:54:02 +0000
@@ -117,6 +117,7 @@
     SERIALIZE_OPTION_IF_SET(max_height);
     SERIALIZE_OPTION_IF_SET(width_inc);
     SERIALIZE_OPTION_IF_SET(height_inc);
+    SERIALIZE_OPTION_IF_SET(shell_chrome);
     // min_aspect is a special case (below)
     // max_aspect is a special case (below)
 

=== modified file 'src/client/mir_surface.cpp'
--- src/client/mir_surface.cpp	2016-01-23 03:16:06 +0000
+++ src/client/mir_surface.cpp	2016-01-25 14:54:02 +0000
@@ -555,6 +555,7 @@
     COPY_IF_SET(max_height);
     COPY_IF_SET(width_inc);
     COPY_IF_SET(height_inc);
+    COPY_IF_SET(shell_chrome);
     // min_aspect is a special case (below)
     // max_aspect is a special case (below)
     #undef COPY_IF_SET

=== modified file 'src/client/mir_surface.h'
--- src/client/mir_surface.h	2016-01-20 23:59:18 +0000
+++ src/client/mir_surface.h	2016-01-25 14:54:02 +0000
@@ -122,6 +122,7 @@
         void* context;
     };
     mir::optional_value<EventHandler> event_handler;
+    mir::optional_value<MirShellChrome> shell_chrome;
 };
 
 struct MirPersistentId

=== modified file 'src/client/mir_surface_api.cpp'
--- src/client/mir_surface_api.cpp	2016-01-20 23:59:18 +0000
+++ src/client/mir_surface_api.cpp	2016-01-25 14:54:02 +0000
@@ -224,6 +224,12 @@
     spec->event_handler = MirSurfaceSpec::EventHandler{callback, context};
 }
 
+void mir_surface_spec_set_shell_chrome(MirSurfaceSpec* spec, MirShellChrome style)
+{
+    mir::require(spec);
+    spec->shell_chrome = style;
+}
+
 void mir_surface_spec_release(MirSurfaceSpec* spec)
 {
     delete spec;

=== modified file 'src/client/symbols.map'
--- src/client/symbols.map	2016-01-23 03:16:06 +0000
+++ src/client/symbols.map	2016-01-25 14:54:02 +0000
@@ -212,8 +212,7 @@
     mir_connection_get_graphics_module;
     mir_keymap_event_get_keymap_buffer;
     mir_keymap_event_get_device_id;
-  local:
-    *;
+    mir_surface_spec_set_shell_chrome;
 } MIR_CLIENT_9v18;
 
 MIR_CLIENT_DETAIL_9 {

=== modified file 'src/protobuf/mir_protobuf.proto'
--- src/protobuf/mir_protobuf.proto	2016-01-20 23:59:18 +0000
+++ src/protobuf/mir_protobuf.proto	2016-01-25 14:54:02 +0000
@@ -38,6 +38,7 @@
 
   optional PersistentSurfaceId parent_persistent_id = 21;
   repeated Rectangle input_shape = 22;
+  optional int32 shell_chrome = 24;
 }
 
 message SurfaceAspectRatio
@@ -76,6 +77,7 @@
 
   optional PersistentSurfaceId parent_persistent_id = 22;
   repeated Rectangle input_shape = 23;
+  optional int32 shell_chrome = 24;
 }
 
 message StreamConfiguration {

=== modified file 'src/server/frontend/session_mediator.cpp'
--- src/server/frontend/session_mediator.cpp	2016-01-20 23:59:18 +0000
+++ src/server/frontend/session_mediator.cpp	2016-01-25 14:54:02 +0000
@@ -269,6 +269,7 @@
     COPY_IF_SET(max_height);
     COPY_IF_SET(width_inc);
     COPY_IF_SET(height_inc);
+    COPY_IF_SET(shell_chrome);
 
     #undef COPY_IF_SET
 
@@ -568,6 +569,7 @@
     COPY_IF_SET(max_height);
     COPY_IF_SET(width_inc);
     COPY_IF_SET(height_inc);
+    COPY_IF_SET(shell_chrome);
     // min_aspect is a special case (below)
     // max_aspect is a special case (below)
 

=== modified file 'tests/acceptance-tests/test_custom_window_management.cpp'
--- tests/acceptance-tests/test_custom_window_management.cpp	2016-01-20 23:59:18 +0000
+++ tests/acceptance-tests/test_custom_window_management.cpp	2016-01-25 14:54:02 +0000
@@ -287,3 +287,76 @@
     for (auto const surface : client_surface)
         mir_surface_release_sync(surface);
 }
+
+TEST_F(CustomWindowManagement, create_low_chrome_surface_from_spec)
+{
+    start_server();
+
+    auto connection = mir_connect_sync(new_connection().c_str(), __PRETTY_FUNCTION__);
+
+    int const width{800}, height{600};
+    MirPixelFormat const format{mir_pixel_format_bgr_888};
+    auto surface_spec = mir_connection_create_spec_for_normal_surface(connection,
+                                                                      width, height,
+                                                                      format);
+
+    mir_surface_spec_set_shell_chrome(surface_spec, mir_shell_chrome_low);
+
+    auto const check_add_surface = [](
+        std::shared_ptr<ms::Session> const& session,
+        ms::SurfaceCreationParameters const& params,
+        std::function<mf::SurfaceId(std::shared_ptr<ms::Session> const& session, ms::SurfaceCreationParameters const& params)> const& build)
+            {
+                EXPECT_TRUE(params.shell_chrome.is_set());
+                return build(session, params);
+            };
+
+    EXPECT_CALL(window_manager, add_surface(_,_,_)).WillOnce(Invoke(check_add_surface));
+
+    auto surface = mir_surface_create_sync(surface_spec);
+    mir_surface_spec_release(surface_spec);
+
+    mir_surface_release_sync(surface);
+    mir_connection_release(connection);
+}
+
+TEST_F(CustomWindowManagement, apply_low_chrome_to_surface)
+{
+    start_server();
+
+    auto connection = mir_connect_sync(new_connection().c_str(), __PRETTY_FUNCTION__);
+
+    int const width{800}, height{600};
+    MirPixelFormat const format{mir_pixel_format_bgr_888};
+    auto surface_spec = mir_connection_create_spec_for_normal_surface(connection,
+                                                                      width, height,
+                                                                      format);
+
+    auto surface = mir_surface_create_sync(surface_spec);
+    mir_surface_spec_release(surface_spec);
+
+    surface_spec = mir_connection_create_spec_for_changes(connection);
+
+    mt::Signal received;
+
+    mir_surface_spec_set_shell_chrome(surface_spec, mir_shell_chrome_low);
+
+    auto const check_apply_surface = [&received](
+        std::shared_ptr<ms::Session> const&,
+        std::shared_ptr<ms::Surface> const&,
+        msh::SurfaceSpecification const& spec)
+        {
+            EXPECT_TRUE(spec.shell_chrome.is_set());
+            received.raise();
+        };
+
+    EXPECT_CALL(window_manager, modify_surface(_,_,_)).WillOnce(Invoke(check_apply_surface));
+
+    mir_surface_apply_spec(surface, surface_spec);
+    mir_surface_spec_release(surface_spec);
+
+    EXPECT_TRUE(received.wait_for(400ms));
+
+    mir_surface_release_sync(surface);
+    mir_connection_release(connection);
+}