Merge lp:~vanvugt/mir/retain-set-type into lp:mir

[Daniel van Vugt]

Undeprecate mir_surface_set_type until such time as we have some other
function that can replace it.

For windowed XMir we're going to need it. In X, windows don't have types
for some indefinite period after their creation. Optionally at some point,
some toolkits might tell us the type via _NET_WM_WINDOW_TYPE but
pure/old X apps won't bother to declare a type at all.

So to support the case where an X window does decide to give itself a type
later (usually while it's unmapped/hidden) we need mir_surface_set_type.
Or something else that doesn't exist yet.

This is just a revert of r2245.

[lp:~vanvugt/mir/retain-set-type]

2324. By Daniel van Vugt on 2015-02-17

test_client_library.cpp: Fix weird type/state mixup (which apparently was
a preexisting problem).

Unmerged revisions

2324. By Daniel van Vugt on 2015-02-17

test_client_library.cpp: Fix weird type/state mixup (which apparently was
a preexisting problem).

2323. By Daniel van Vugt on 2015-02-17

Undeprecate mir_surface_set_type until such time as we have some other
function that can replace it.

For windowed XMir we're going to need it. In X, windows don't have types
for some indefinite period after their creation. Optionally at some point,
some toolkits might tell us the type via _NET_WM_WINDOW_TYPE but
pure/old X apps won't bother to declare a type at all.

So to support the case where an X window does decide to give itself a type
later (usually while it's unmapped/hidden) we need mir_surface_set_type.
Or something else that doesn't exist yet.

=== modified file 'include/client/mir_toolkit/mir_surface.h'
--- include/client/mir_toolkit/mir_surface.h	2015-02-12 02:11:25 +0000
+++ include/client/mir_toolkit/mir_surface.h	2015-02-17 05:00:50 +0000
@@ -449,9 +449,13 @@
 int mir_surface_get_id(MirSurface *surface);
 
 /**
- * \deprecated Use the mir_connection_create_spec_for_xxx family of APIs
+ * Set the type (purpose) of a surface. This is not guaranteed to always work
+ * with some shell types (e.g. phone/tablet UIs). As such, you may have to
+ * wait on the function and check the result using mir_surface_get_type.
+ *   \param [in] surface  The surface to operate on
+ *   \param [in] type     The new type of the surface
+ *   \return              A wait handle that can be passed to mir_wait_for
  */
-__attribute__((__deprecated__("Use mir_connection_create_spec_for_xxx()")))
 MirWaitHandle* mir_surface_set_type(MirSurface *surface, MirSurfaceType type);
 
 /**

=== modified file 'src/utils/ping.c'
--- src/utils/ping.c	2015-01-22 09:00:14 +0000
+++ src/utils/ping.c	2015-02-17 05:00:50 +0000
@@ -103,10 +103,10 @@
     signal(SIGTERM, shutdown);
     signal(SIGHUP, shutdown);
 
-    static const MirOrientationMode types[2] =
+    static const MirSurfaceType types[2] =
     {
-        mir_orientation_mode_portrait_any,
-        mir_orientation_mode_landscape_any
+        mir_surface_type_normal,
+        mir_surface_type_utility
     };
     int t = 1;
 
@@ -116,7 +116,7 @@
         long long start, duration;
 
         start = now();
-        mir_wait_for(mir_surface_set_preferred_orientation(surf, types[t]));
+        mir_wait_for(mir_surface_set_type(surf, types[t]));
         duration = now() - start;
         t ^= 1;
 

=== modified file 'tests/acceptance-tests/test_client_library.cpp'
--- tests/acceptance-tests/test_client_library.cpp	2015-02-12 02:11:25 +0000
+++ tests/acceptance-tests/test_client_library.cpp	2015-02-17 05:00:50 +0000
@@ -135,10 +135,16 @@
         {
             mir_wait_for_one(mir_surface_set_state(surf,
                                             mir_surface_state_maximized));
+            mir_wait_for_one(mir_surface_set_type(surf,
+                                            mir_surface_type_normal));
             mir_wait_for_one(mir_surface_set_state(surf,
                                             mir_surface_state_restored));
+            mir_wait_for_one(mir_surface_set_type(surf,
+                                            mir_surface_type_utility));
             mir_wait_for_one(mir_surface_set_state(surf,
                                             mir_surface_state_fullscreen));
+            mir_wait_for_one(mir_surface_set_type(surf,
+                                            mir_surface_type_dialog));
             mir_wait_for_one(mir_surface_set_state(surf,
                                             mir_surface_state_minimized));
         }
@@ -201,9 +207,6 @@
     mir_connection_release(connection);
 }
 
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
-
 TEST_F(ClientLibrary, can_set_surface_types)
 {
     mir_wait_for(mir_connect(new_connection().c_str(), __PRETTY_FUNCTION__, connection_callback, this));
@@ -248,7 +251,6 @@
     mir_wait_for(mir_surface_release(surface, release_surface_callback, this));
     mir_connection_release(connection);
 }
-#pragma GCC diagnostic pop
 
 TEST_F(ClientLibrary, can_set_surface_state)
 {
@@ -540,6 +542,7 @@
     b.join();
     c.join();
 
+    EXPECT_THAT(mir_surface_get_type(surface), Eq(mir_surface_type_dialog));
     EXPECT_THAT(mir_surface_get_state(surface), Eq(mir_surface_state_minimized));
 
     mir_surface_release_sync(surface);

=== modified file 'tests/acceptance-tests/throwback/test_shell_control_of_surface_configuration.cpp'
--- tests/acceptance-tests/throwback/test_shell_control_of_surface_configuration.cpp	2015-01-22 09:00:14 +0000
+++ tests/acceptance-tests/throwback/test_shell_control_of_surface_configuration.cpp	2015-02-17 05:00:50 +0000
@@ -74,14 +74,14 @@
         {
             using namespace ::testing;
 
-            EXPECT_CALL(mock_configurator, select_attribute_value(_, Ne(mir_surface_attrib_state), _))
+            EXPECT_CALL(mock_configurator, select_attribute_value(_, Ne(mir_surface_attrib_type), _))
                 .Times(AnyNumber())
                 .WillRepeatedly(ReturnArg<2>());
-            EXPECT_CALL(mock_configurator, attribute_set(_, Ne(mir_surface_attrib_state), _)).Times(AnyNumber());
+            EXPECT_CALL(mock_configurator, attribute_set(_, Ne(mir_surface_attrib_type), _)).Times(AnyNumber());
 
-            ON_CALL(mock_configurator, select_attribute_value(_, _, _)).WillByDefault(Return(mir_surface_state_maximized));
-            EXPECT_CALL(mock_configurator, select_attribute_value(_, mir_surface_attrib_state, Eq(mir_surface_state_maximized))).Times(1);
-            EXPECT_CALL(mock_configurator, attribute_set(_, mir_surface_attrib_state, Eq(mir_surface_state_maximized))).Times(1);
+            ON_CALL(mock_configurator, select_attribute_value(_, _, _)).WillByDefault(Return(mir_surface_type_freestyle));
+            EXPECT_CALL(mock_configurator, select_attribute_value(_, mir_surface_attrib_type, Eq(mir_surface_type_freestyle))).Times(1);
+            EXPECT_CALL(mock_configurator, attribute_set(_, mir_surface_attrib_type, Eq(mir_surface_type_freestyle))).Times(1);
         }
 
         mtd::MockSurfaceConfigurator mock_configurator;
@@ -93,8 +93,10 @@
         void exec() override
         {
             SurfaceCreatingClient::exec();
-            mir_wait_for(mir_surface_set_state(surface, mir_surface_state_maximized));
-            EXPECT_EQ(mir_surface_state_maximized, mir_surface_get_state(surface));
+            mir_wait_for(mir_surface_set_type(surface,
+                                               mir_surface_type_freestyle));
+            EXPECT_EQ(mir_surface_type_freestyle,
+                      mir_surface_get_type(surface));
         }
     } client_config;
     launch_client_process(client_config);
@@ -112,14 +114,14 @@
         {
             using namespace ::testing;
 
-            EXPECT_CALL(mock_configurator, select_attribute_value(_, Ne(mir_surface_attrib_state), _))
+            EXPECT_CALL(mock_configurator, select_attribute_value(_, Ne(mir_surface_attrib_type), _))
                 .Times(AnyNumber())
                 .WillRepeatedly(ReturnArg<2>());
-            EXPECT_CALL(mock_configurator, attribute_set(_, Ne(mir_surface_attrib_state), _)).Times(AnyNumber());
+            EXPECT_CALL(mock_configurator, attribute_set(_, Ne(mir_surface_attrib_type), _)).Times(AnyNumber());
 
-            EXPECT_CALL(mock_configurator, select_attribute_value(_, mir_surface_attrib_state, Eq(mir_surface_state_maximized))).Times(1)
-                .WillOnce(Return(mir_surface_state_maximized));
-            EXPECT_CALL(mock_configurator, attribute_set(_, mir_surface_attrib_state, Eq(mir_surface_state_maximized))).Times(1);
+            EXPECT_CALL(mock_configurator, select_attribute_value(_, mir_surface_attrib_type, Eq(mir_surface_type_freestyle))).Times(1)
+                .WillOnce(Return(mir_surface_type_normal));
+            EXPECT_CALL(mock_configurator, attribute_set(_, mir_surface_attrib_type, Eq(mir_surface_type_normal))).Times(1);
         }
         mtd::MockSurfaceConfigurator mock_configurator;
     } server_config;
@@ -130,8 +132,10 @@
         void exec() override
         {
             SurfaceCreatingClient::exec();
-            mir_wait_for(mir_surface_set_state(surface, mir_surface_state_maximized));
-            EXPECT_EQ(mir_surface_state_maximized, mir_surface_get_state(surface));
+            mir_wait_for(mir_surface_set_type(surface,
+                                               mir_surface_type_freestyle));
+            EXPECT_EQ(mir_surface_type_normal,
+                      mir_surface_get_type(surface));
         }
     } client_config;
     launch_client_process(client_config);