Merge lp:~alan-griffiths/miral/connect-gdk_window_move_to_rect-inspired-placement-logic-to-Mir-0.25-API into lp:miral

[Alan Griffiths]

Connect the placement logic to Mir-0.25 placement requests

Connect the placement logic to Mir-0.25 placement requests

This assumes that we land for 0.25 lp:~alan-griffiths/miral/connect-gdk_window_move_to_rect-inspired-placement-logic-to-Mir-0.25-API

[Gerry Boland (gerboland)]

review: Approve

[Alan Griffiths (alan-griffiths)]

Need to wait on the corresponding Mir MP

[lp:~alan-griffiths/miral/connect-gdk_window_move_to_rect-inspired-placement-logic-to-Mir-0.25-API]

328. By Alan Griffiths on 2016-09-05

Update enums to match latest version of Mir MP

329. By Alan Griffiths on 2016-09-05

merge :parent

[Alan Griffiths (alan-griffiths)]

API has landed in Mir

=== modified file 'include/miral/window_specification.h'
--- include/miral/window_specification.h	2016-09-01 11:34:45 +0000
+++ include/miral/window_specification.h	2016-09-05 15:52:44 +0000
@@ -33,17 +33,38 @@
 #if MIR_CLIENT_VERSION < MIR_VERSION_NUMBER(3, 4, 0)
 
 // Inspired by GdkGravity
+/**
+ * Reference point for aligning a surface relative to a rectangle.
+ * Each element (surface and rectangle) has a MirPlacementGravity assigned.
+ */
 typedef enum MirPlacementGravity
 {
-    mir_placement_gravity_northwest = 1,   // the reference point is at the top left corner.
-    mir_placement_gravity_north,           // the reference point is in the middle of the top edge.
-    mir_placement_gravity_northeast,       // the reference point is at the top right corner.
-    mir_placement_gravity_west,            // the reference point is at the middle of the left edge.
-    mir_placement_gravity_centre,          // the reference point is at the center of the window.
-    mir_placement_gravity_east,            // the reference point is at the middle of the right edge.
-    mir_placement_gravity_southwest,       // the reference point is at the lower left corner.
-    mir_placement_gravity_south,           // the reference point is at the middle of the lower edge.
-    mir_placement_gravity_southeast,       // the reference point is at the lower right corner.
+    /// the reference point is at the center.
+        mir_placement_gravity_center    = 0,
+
+    /// the reference point is at the middle of the left edge.
+        mir_placement_gravity_west      = 1 << 0,
+
+    /// the reference point is at the middle of the right edge.
+        mir_placement_gravity_east      = 1 << 1,
+
+    /// the reference point is in the middle of the top edge.
+        mir_placement_gravity_north     = 1 << 2,
+
+    /// the reference point is at the middle of the lower edge.
+        mir_placement_gravity_south     = 1 << 3,
+
+    /// the reference point is at the top left corner.
+        mir_placement_gravity_northwest = mir_placement_gravity_north | mir_placement_gravity_west,
+
+    /// the reference point is at the top right corner.
+        mir_placement_gravity_northeast = mir_placement_gravity_north | mir_placement_gravity_east,
+
+    /// the reference point is at the lower left corner.
+        mir_placement_gravity_southwest = mir_placement_gravity_south | mir_placement_gravity_west,
+
+    /// the reference point is at the lower right corner.
+        mir_placement_gravity_southeast = mir_placement_gravity_south | mir_placement_gravity_east
 } MirPlacementGravity;
 
 // Inspired by GdkAnchorHints
@@ -51,44 +72,57 @@
  * Positioning hints for aligning a window relative to a rectangle.
  *
  * These hints determine how the window should be positioned in the case that
- * the window would fall off-screen if placed in its ideal position.
+ * the surface would fall off-screen if placed in its ideal position.
  *
- * For example, mir_placement_hints_flip_x will invert the x component of
- * aux_rect_placement_offset and replace mir_placement_gravity_northwest with
- * mir_placement_gravity_northeast and vice versa if the window extends
+ * For example, \p mir_placement_hints_flip_x will invert the x component of
+ * \p aux_rect_placement_offset and replace \p mir_placement_gravity_northwest
+ * with \p mir_placement_gravity_northeast and vice versa if the window extends
  * beyond the left or right edges of the monitor.
  *
- * If mir_placement_hints_slide_x is set, the window can be shifted
+ * If \p mir_placement_hints_slide_x is set, the window can be shifted
  * horizontally to fit on-screen.
  *
- * If mir_placement_hints_resize_x is set, the window can be shrunken
+ * If \p mir_placement_hints_resize_x is set, the window can be shrunken
  * horizontally to fit.
  *
- * If mir_placement_hints_antipodes is set then the rect gravity may be
- * substituted with the opposite corner (e.g. mir_placement_gravity_northeast
- * to mir_placement_gravity_southwest) in combination with other options.
+ * If \p mir_placement_hints_antipodes is set then the rect gravity may be
+ * substituted with the opposite corner (e.g. \p mir_placement_gravity_northeast
+ * to \p mir_placement_gravity_southwest) in combination with other options.
  *
  * When multiple flags are set, flipping should take precedence over sliding,
  * which should take precedence over resizing.
  */
 typedef enum MirPlacementHints
 {
-    mir_placement_hints_flip_x   = 1 << 0,  // allow flipping anchors horizontally
-    mir_placement_hints_flip_y   = 1 << 1,  // allow flipping anchors vertically
-    mir_placement_hints_slide_x  = 1 << 2,  // allow sliding window horizontally
-    mir_placement_hints_slide_y  = 1 << 3,  // allow sliding window vertically
-    mir_placement_hints_resize_x = 1 << 4,  // allow resizing window horizontally
-    mir_placement_hints_resize_y = 1 << 5,  // allow resizing window vertically
-    mir_placement_hints_antipodes= 1 << 6,  // allow flipping aux_anchor to opposite corner
-
-    // allow flipping anchors on both axes
-    mir_placement_hints_flip_any = mir_placement_hints_flip_x|mir_placement_hints_flip_y,
-
-    // allow sliding window on both axes
-    mir_placement_hints_slide_any  = mir_placement_hints_slide_x|mir_placement_hints_slide_y,
-
-    // allow resizing window on both axes
-    mir_placement_hints_resize_any = mir_placement_hints_resize_x|mir_placement_hints_resize_y,
+    /// allow flipping anchors horizontally
+        mir_placement_hints_flip_x   = 1 << 0,
+
+    /// allow flipping anchors vertically
+        mir_placement_hints_flip_y   = 1 << 1,
+
+    /// allow sliding window horizontally
+        mir_placement_hints_slide_x  = 1 << 2,
+
+    /// allow sliding window vertically
+        mir_placement_hints_slide_y  = 1 << 3,
+
+    /// allow resizing window horizontally
+        mir_placement_hints_resize_x = 1 << 4,
+
+    /// allow resizing window vertically
+        mir_placement_hints_resize_y = 1 << 5,
+
+    /// allow flipping aux_anchor to opposite corner
+        mir_placement_hints_antipodes= 1 << 6,
+
+    /// allow flipping anchors on both axes
+        mir_placement_hints_flip_any = mir_placement_hints_flip_x|mir_placement_hints_flip_y,
+
+    /// allow sliding window on both axes
+        mir_placement_hints_slide_any  = mir_placement_hints_slide_x|mir_placement_hints_slide_y,
+
+    /// allow resizing window on both axes
+        mir_placement_hints_resize_any = mir_placement_hints_resize_x|mir_placement_hints_resize_y,
 } MirPlacementHints;
 #endif
 

=== modified file 'miral/basic_window_manager.cpp'
--- miral/basic_window_manager.cpp	2016-09-01 11:34:45 +0000
+++ miral/basic_window_manager.cpp	2016-09-05 15:52:44 +0000
@@ -1154,7 +1154,7 @@
     case mir_placement_gravity_west:
         return aux_rect.top_left + 0.5*as_displacement(aux_rect.size).dy;
 
-    case mir_placement_gravity_centre:
+    case mir_placement_gravity_center:
         return aux_rect.top_left + 0.5*as_displacement(aux_rect.size);
 
     case mir_placement_gravity_east:
@@ -1192,7 +1192,7 @@
     case mir_placement_gravity_west:
         return {0, -0.5 * displacement.dy};
 
-    case mir_placement_gravity_centre:
+    case mir_placement_gravity_center:
         return {-0.5 * displacement.dx, -0.5 * displacement.dy};
 
     case mir_placement_gravity_east:
@@ -1231,8 +1231,8 @@
 
     std::vector<MirPlacementGravity> rect_gravities{parameters.aux_rect_placement_gravity().value()};
 
-     if (hints & mir_placement_hints_antipodes)
-         rect_gravities.push_back(antipodes(parameters.aux_rect_placement_gravity().value()));
+    if (hints & mir_placement_hints_antipodes)
+        rect_gravities.push_back(antipodes(parameters.aux_rect_placement_gravity().value()));
 
     mir::optional_value<Rectangle> default_result;
 

=== modified file 'miral/window_specification.cpp'
--- miral/window_specification.cpp	2016-09-01 11:34:45 +0000
+++ miral/window_specification.cpp	2016-09-05 15:52:44 +0000
@@ -72,6 +72,11 @@
     state(spec.state),
     preferred_orientation(spec.preferred_orientation),
     aux_rect(spec.aux_rect),
+#if MIR_SERVER_VERSION >= MIR_VERSION_NUMBER(0, 25, 0)
+    placement_hints(spec.placement_hints),
+    window_placement_gravity(spec.surface_placement_gravity),
+    aux_rect_placement_gravity(spec.aux_rect_placement_gravity),
+#endif
     min_width(spec.min_width),
     min_height(spec.min_height),
     max_width(spec.max_width),
@@ -86,7 +91,12 @@
     input_mode(),
     shell_chrome(spec.shell_chrome)
 {
-    if (spec.edge_attachment.is_set())
+#if MIR_SERVER_VERSION >= MIR_VERSION_NUMBER(0, 25, 0)
+    if (spec.aux_rect_placement_offset_x.is_set() && spec.aux_rect_placement_offset_y.is_set())
+        aux_rect_placement_offset = Displacement{spec.aux_rect_placement_offset_x.value(), spec.aux_rect_placement_offset_y.value()};
+#endif
+
+    if (spec.edge_attachment.is_set() && !placement_hints.is_set())
     {
         switch (spec.edge_attachment.value())
         {
@@ -204,6 +214,11 @@
     state(params.state),
     preferred_orientation(params.preferred_orientation),
     aux_rect(params.aux_rect),
+#if MIR_SERVER_VERSION >= MIR_VERSION_NUMBER(0, 25, 0)
+    placement_hints(params.placement_hints),
+    window_placement_gravity(params.surface_placement_gravity),
+    aux_rect_placement_gravity(params.aux_rect_placement_gravity),
+#endif
     min_width(params.min_width),
     min_height(params.min_height),
     max_width(params.max_width),
@@ -222,7 +237,12 @@
     input_mode(static_cast<InputReceptionMode>(params.input_mode)),
     shell_chrome(params.shell_chrome)
 {
-    if (params.edge_attachment.is_set())
+#if MIR_SERVER_VERSION >= MIR_VERSION_NUMBER(0, 25, 0)
+    if (params.aux_rect_placement_offset_x.is_set() && params.aux_rect_placement_offset_y.is_set())
+        aux_rect_placement_offset = Displacement{params.aux_rect_placement_offset_x.value(), params.aux_rect_placement_offset_y.value()};
+#endif
+
+    if (params.edge_attachment.is_set() && !placement_hints.is_set())
     {
         switch (params.edge_attachment.value())
         {
@@ -284,6 +304,19 @@
     copy_if_set(params.input_shape, input_shape);
     copy_if_set(params.input_mode, input_mode);
     copy_if_set(params.shell_chrome, shell_chrome);
+
+#if MIR_SERVER_VERSION >= MIR_VERSION_NUMBER(0, 25, 0)
+    copy_if_set(params.placement_hints, placement_hints);
+    copy_if_set(params.surface_placement_gravity, window_placement_gravity);
+    copy_if_set(params.aux_rect_placement_gravity, aux_rect_placement_gravity);
+
+    if (aux_rect_placement_offset.is_set())
+    {
+        auto const offset = aux_rect_placement_offset.value();
+        params.aux_rect_placement_offset_x = offset.dx.as_int();
+        params.aux_rect_placement_offset_y = offset.dy.as_int();
+    }
+#endif
 }
 
 miral::WindowSpecification::WindowSpecification() :

=== modified file 'test/window_placement.cpp'
--- test/window_placement.cpp	2016-08-29 16:03:55 +0000
+++ test/window_placement.cpp	2016-09-05 15:52:44 +0000
@@ -362,7 +362,7 @@
     mir_placement_gravity_north,
     mir_placement_gravity_northeast,
     mir_placement_gravity_west,
-    mir_placement_gravity_centre,
+    mir_placement_gravity_center,
     mir_placement_gravity_east,
     mir_placement_gravity_southwest,
     mir_placement_gravity_south,
@@ -387,7 +387,7 @@
     case mir_placement_gravity_west:
         return rectangle.top_left + Displacement{0, 0.5 * displacement.dy};
 
-    case mir_placement_gravity_centre:
+    case mir_placement_gravity_center:
         return rectangle.top_left + 0.5 * displacement;
 
     case mir_placement_gravity_east: