Merge lp:~alan-griffiths/miral/confine_pointer into lp:miral

[Alan Griffiths]

Add pointer confinement

[Alan Griffiths (alan-griffiths)]

Does not compile against Mir-0.20 - which is in 16.04 LTS, it needs similar compatibility hacks to MirPlacementGravity. (A PITA I know, but we should support the LTS.)

/home/alan/display_server/miral/include/miral/window_specification.h:196:57: error: ‘MirPointerConfinementState’ was not declared in this scope
     auto confine_pointer() const -> mir::optional_value<MirPointerConfinementState> const&;
                                                         ^

review: Needs Fixing

[Daniel d'Andrada (dandrader)]

On 22/09/2016 05:26, Alan Griffiths wrote:
> Review: Needs Fixing
>
> Does not compile against Mir-0.20 - which is in 16.04 LTS, it needs similar compatibility hacks to MirPlacementGravity. (A PITA I know, but we should support the LTS.)
>
> /home/alan/display_server/miral/include/miral/window_specification.h:196:57: error: ‘MirPointerConfinementState’ was not declared in this scope
> auto confine_pointer() const -> mir::optional_value<MirPointerConfinementState> const&;
> ^
>
>
MIR_CLIENT_VERSION hasn't changed between mir 0.23 and 0.24 (where that
symbol got released). What do you suggest?

[Alan Griffiths (alan-griffiths)]

> MIR_CLIENT_VERSION hasn't changed between mir 0.23 and 0.24 (where that
> symbol got released). What do you suggest?

That's a Mir bug (not sure if I actually reported it).

I suggest detecting MIRCLIENT_VERSION (set by pkg_check_modules()) in CMakeLists.txt with:

    if (MIRTEST_VERSION VERSION_LESS 0.24)
    add_definitions(-DMIRAL_NO_POINTER_CONFINEMENT_IN_MIR)
    endif()

[Alan Griffiths (alan-griffiths)]

> > MIR_CLIENT_VERSION hasn't changed between mir 0.23 and 0.24 (where that
> > symbol got released). What do you suggest?
>
> That's a Mir bug (not sure if I actually reported it).
>
> I suggest detecting MIRCLIENT_VERSION (set by pkg_check_modules()) in
> CMakeLists.txt with:
>
> if (MIRTEST_VERSION VERSION_LESS 0.24)
MIRCLIENT_VERSION
> add_definitions(-DMIRAL_NO_POINTER_CONFINEMENT_IN_MIR)
> endif()

[Daniel d'Andrada (dandrader)]

On 22/09/2016 05:26, Alan Griffiths wrote:
> Review: Needs Fixing
>
> Does not compile against Mir-0.20 - which is in 16.04 LTS, it needs similar compatibility hacks to MirPlacementGravity. (A PITA I know, but we should support the LTS.)
>
> /home/alan/display_server/miral/include/miral/window_specification.h:196:57: error: ‘MirPointerConfinementState’ was not declared in this scope
> auto confine_pointer() const -> mir::optional_value<MirPointerConfinementState> const&;
> ^
>
>
Fixed.

[Alan Griffiths (alan-griffiths)]

I'd like it fixed in a similar way to the window_placement_gravity() - i.e. on earlier versions of Mir the miral downstream sees the API (and ABI) but the feature is inactive.

That way the downstream never needs to care about the Mir version - they just write against the MirAL API.

review: Needs Fixing

[lp:~alan-griffiths/miral/confine_pointer]

362. By Alan Griffiths on 2016-09-23

Fix build on yakkety

[Alan Griffiths (alan-griffiths)]

Hmm, debuild doesn't seem to like my libmiral1.symbols file. I wish I understood it.

[lp:~alan-griffiths/miral/confine_pointer]

363. By Alan Griffiths on 2016-09-23

Add pointer confinement to WM trace

[Daniel d'Andrada (dandrader)]

Looks good to me.
Thanks.

review: Approve

[Brandon Schaefer (brandontschaefer)]

LGTM

review: Approve

=== modified file 'debian/libmiral1.symbols'
--- debian/libmiral1.symbols	2016-09-20 13:43:29 +0000
+++ debian/libmiral1.symbols	2016-09-23 15:39:15 +0000
@@ -1,5 +1,6 @@
 libmiral.so.1 libmiral1 #MINVER#
- MIRAL_0.1@MIRAL_0.1 0.1.0
+ MIRAL_0.1@MIRAL_0.1 0.1.0+16.10.20160919-0ubuntu1
+ MIRAL_0.2@MIRAL_0.2 0.2.0
  (c++)"miral::ActiveOutputsListener::advise_output_begin()@MIRAL_0.1" 0.1.0
  (c++)"miral::ActiveOutputsListener::advise_output_create(miral::Output const&)@MIRAL_0.1" 0.1.0
  (c++)"miral::ActiveOutputsListener::advise_output_delete(miral::Output const&)@MIRAL_0.1" 0.1.0
@@ -97,6 +98,8 @@
  (c++)"miral::WindowInfo::can_be_active() const@MIRAL_0.1" 0.1.0
  (c++)"miral::WindowInfo::can_morph_to(MirSurfaceType) const@MIRAL_0.1" 0.1.0
  (c++)"miral::WindowInfo::children() const@MIRAL_0.1" 0.1.0
+ (c++)"miral::WindowInfo::confine_pointer() const@MIRAL_0.2" 0.2.0
+ (c++)"miral::WindowInfo::confine_pointer(MirPointerConfinementState)@MIRAL_0.2" 0.2.0
  (c++)"miral::WindowInfo::constrain_resize(mir::geometry::Point&, mir::geometry::Size&) const@MIRAL_0.1" 0.1.0
  (c++)"miral::WindowInfo::has_name() const@MIRAL_0.1" 0.1.0
  (c++)"miral::WindowInfo::has_output_id() const@MIRAL_0.1" 0.1.0
@@ -190,6 +193,8 @@
  (c++)"miral::WindowSpecification::aux_rect_placement_gravity()@MIRAL_0.1" 0.1.0
  (c++)"miral::WindowSpecification::aux_rect_placement_offset() const@MIRAL_0.1" 0.1.0
  (c++)"miral::WindowSpecification::aux_rect_placement_offset()@MIRAL_0.1" 0.1.0
+ (c++)"miral::WindowSpecification::confine_pointer const@MIRAL_0.2" 0.2.0
+ (c++)"miral::WindowSpecification::confine_pointer@MIRAL_0.2" 0.2.0
  (c++)"miral::WindowSpecification::height_inc() const@MIRAL_0.1" 0.1.0
  (c++)"miral::WindowSpecification::height_inc()@MIRAL_0.1" 0.1.0
  (c++)"miral::WindowSpecification::input_mode() const@MIRAL_0.1" 0.1.0

=== added directory 'include/miral/detail'
=== added file 'include/miral/detail/mir_forward_compatibility.h'
--- include/miral/detail/mir_forward_compatibility.h	1970-01-01 00:00:00 +0000
+++ include/miral/detail/mir_forward_compatibility.h	2016-09-23 15:39:15 +0000
@@ -0,0 +1,130 @@
+/*
+ * Copyright © 2016 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Alan Griffiths <[e-mail]>
+ */
+
+#ifndef MIRAL_MIR_FORWARD_COMPATIBILITY_H
+#define MIRAL_MIR_FORWARD_COMPATIBILITY_H
+
+#include <mir_toolkit/version.h>
+#include <miral/detail/mir_features.h>
+
+// Types that don't exist in earlier versions of Mir's toolkit
+#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
+{
+    /// 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
+/**
+ * Positioning hints for aligning a window relative to a rectangle.
+ *
+ * These hints determine how the window should be positioned in the case that
+ * the surface would fall off-screen if placed in its ideal position.
+ *
+ * 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 \p mir_placement_hints_slide_x is set, the window can be shifted
+ * horizontally to fit on-screen.
+ *
+ * If \p mir_placement_hints_resize_x is set, the window can be shrunken
+ * horizontally to fit.
+ *
+ * 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
+{
+    /// 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
+
+#if !MIRAL_MIR_DEFINES_POINTER_CONFINEMENT
+typedef enum MirPointerConfinementState
+{
+    mir_pointer_unconfined,
+    mir_pointer_confined_to_surface,
+} MirPointerConfinementState;
+#endif
+
+#endif //MIRAL_MIR_FORWARD_COMPATIBILITY_H

=== modified file 'include/miral/window_info.h'
--- include/miral/window_info.h	2016-09-12 14:24:21 +0000
+++ include/miral/window_info.h	2016-09-23 15:39:15 +0000
@@ -104,6 +104,9 @@
     auto preferred_orientation() const -> MirOrientationMode;
     void preferred_orientation(MirOrientationMode preferred_orientation);
 
+    auto confine_pointer() const -> MirPointerConfinementState;
+    void confine_pointer(MirPointerConfinementState confinement);
+
     /// This can be used by client code to store window manager specific information
     auto userdata() const -> std::shared_ptr<void>;
     void userdata(std::shared_ptr<void> userdata);

=== modified file 'include/miral/window_specification.h'
--- include/miral/window_specification.h	2016-09-14 15:54:54 +0000
+++ include/miral/window_specification.h	2016-09-23 15:39:15 +0000
@@ -20,7 +20,8 @@
 #define MIRAL_WINDOW_SPECIFICATION_H
 
 #include <mir_toolkit/common.h>
-#include <mir_toolkit/version.h>
+
+#include "miral/detail/mir_forward_compatibility.h"
 
 #include <mir/geometry/displacement.h>
 #include <mir/geometry/rectangles.h>
@@ -29,103 +30,6 @@
 
 #include <memory>
 
-// TODO this wants to move to Mir's toolkit API
-#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
-{
-    /// 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
-/**
- * Positioning hints for aligning a window relative to a rectangle.
- *
- * These hints determine how the window should be positioned in the case that
- * the surface would fall off-screen if placed in its ideal position.
- *
- * 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 \p mir_placement_hints_slide_x is set, the window can be shifted
- * horizontally to fit on-screen.
- *
- * If \p mir_placement_hints_resize_x is set, the window can be shrunken
- * horizontally to fit.
- *
- * 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
-{
-    /// 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
-
 namespace mir
 {
 namespace scene { class Surface; struct SurfaceCreationParameters; }
@@ -193,6 +97,7 @@
     auto input_shape() const -> mir::optional_value<std::vector<Rectangle>> const&;
     auto input_mode() const -> mir::optional_value<InputReceptionMode> const&;
     auto shell_chrome() const -> mir::optional_value<MirShellChrome> const&;
+    auto confine_pointer() const -> mir::optional_value<MirPointerConfinementState> const&;
 
     auto top_left() -> mir::optional_value<Point>&;
     auto size() -> mir::optional_value<Size>&;
@@ -218,6 +123,7 @@
     auto input_shape() -> mir::optional_value<std::vector<Rectangle>>&;
     auto input_mode() -> mir::optional_value<InputReceptionMode>&;
     auto shell_chrome() -> mir::optional_value<MirShellChrome>&;
+    auto confine_pointer() -> mir::optional_value<MirPointerConfinementState>&;
 
 private:
     struct Self;

=== modified file 'miral/CMakeLists.txt'
--- miral/CMakeLists.txt	2016-09-21 16:49:48 +0000
+++ miral/CMakeLists.txt	2016-09-23 15:39:15 +0000
@@ -45,7 +45,7 @@
                                         ${CMAKE_SOURCE_DIR}/include/miral/toolkit/persistent_id.h
                                         ${CMAKE_SOURCE_DIR}/include/miral/toolkit/connection.h
                                         ${CMAKE_SOURCE_DIR}/include/miral/toolkit/surface.h
-)
+        ../include/miral/detail/mir_forward_compatibility.h)
 
 target_link_libraries(miral
     PUBLIC
@@ -71,6 +71,17 @@
     @ONLY
 )
 
+if (MIRSERVER_VERSION VERSION_LESS 0.24)
+    set(MIR_POINTER_CONFINEMENT 0)
+else()
+    set(MIR_POINTER_CONFINEMENT 1)
+endif()
+
+configure_file(
+  ${CMAKE_CURRENT_SOURCE_DIR}/mir_features.h.in
+  ${PROJECT_SOURCE_DIR}/include/miral/detail/mir_features.h
+)
+
 install(TARGETS     miral                           LIBRARY DESTINATION "${CMAKE_INSTALL_FULL_LIBDIR}")
 install(DIRECTORY   ${CMAKE_SOURCE_DIR}/include/            DESTINATION "${INCLUDEDIR}")
 install(FILES       ${CMAKE_CURRENT_BINARY_DIR}/miral.pc    DESTINATION "${CMAKE_INSTALL_FULL_LIBDIR}/pkgconfig")

=== modified file 'miral/basic_window_manager.cpp'
--- miral/basic_window_manager.cpp	2016-09-20 13:42:15 +0000
+++ miral/basic_window_manager.cpp	2016-09-23 15:39:15 +0000
@@ -543,6 +543,7 @@
     COPY_IF_SET(max_aspect);
     COPY_IF_SET(output_id);
     COPY_IF_SET(preferred_orientation);
+    COPY_IF_SET(confine_pointer);
 
 #undef COPY_IF_SET
 
@@ -641,6 +642,11 @@
     {
         set_state(window_info, modifications.state().value());
     }
+
+#if MIR_SERVER_VERSION >= MIR_VERSION_NUMBER(0, 24, 0)
+    if (modifications.confine_pointer().is_set())
+        std::shared_ptr<scene::Surface>(window)->set_confine_pointer_state(modifications.confine_pointer().value());
+#endif
 }
 
 auto miral::BasicWindowManager::info_for_window_id(std::string const& id) const -> WindowInfo&

=== added file 'miral/mir_features.h.in'
--- miral/mir_features.h.in	1970-01-01 00:00:00 +0000
+++ miral/mir_features.h.in	2016-09-23 15:39:15 +0000
@@ -0,0 +1,28 @@
+/*
+ * Copyright © 2016 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef MIRAL_MIR_FEATURES_H
+#define MIRAL_MIR_FEATURES_H
+
+// ============================================================
+// ==>  miral/detail/mir_features.h is generated by cmake.  <==  
+// ==>                    DO NOT EDIT!                      <==
+// ==>            (edit mir_features.h.in instead)          <==
+// ============================================================
+
+#define MIRAL_MIR_DEFINES_POINTER_CONFINEMENT (@MIR_POINTER_CONFINEMENT@)
+
+#endif // MIRAL_MIR_FEATURES_H

=== modified file 'miral/symbols.map'
--- miral/symbols.map	2016-09-14 15:55:48 +0000
+++ miral/symbols.map	2016-09-23 15:39:15 +0000
@@ -281,3 +281,11 @@
   };
 local: *;
 };
+
+MIRAL_0.2 {
+global:
+  extern "C++" {
+    miral::WindowInfo::confine_pointer*;
+    miral::WindowSpecification::confine_pointer*;
+  };
+} MIRAL_0.1;

=== modified file 'miral/window_info.cpp'
--- miral/window_info.cpp	2016-09-16 10:25:45 +0000
+++ miral/window_info.cpp	2016-09-23 15:39:15 +0000
@@ -49,6 +49,7 @@
     mir::geometry::Width max_width;
     mir::geometry::Height max_height;
     MirOrientationMode preferred_orientation;
+    MirPointerConfinementState confine_pointer;
 
     mir::geometry::DeltaX width_inc;
     mir::geometry::DeltaY height_inc;
@@ -69,6 +70,7 @@
     max_width{optional_value_or_default(params.max_width(), Width{std::numeric_limits<int>::max()})},
     max_height{optional_value_or_default(params.max_height(), Height{std::numeric_limits<int>::max()})},
     preferred_orientation{optional_value_or_default(params.preferred_orientation(), mir_orientation_mode_any)},
+    confine_pointer(optional_value_or_default(params.confine_pointer(), mir_pointer_unconfined)),
     width_inc{optional_value_or_default(params.width_inc(), DeltaX{1})},
     height_inc{optional_value_or_default(params.height_inc(), DeltaY{1})},
     min_aspect(optional_value_or_default(params.min_aspect(), AspectRatio{0U, std::numeric_limits<unsigned>::max()})),
@@ -537,6 +539,15 @@
     self->preferred_orientation = preferred_orientation;
 }
 
+auto miral::WindowInfo::confine_pointer() const -> MirPointerConfinementState
+{
+    return self->confine_pointer;
+}
+
+void miral::WindowInfo::confine_pointer(MirPointerConfinementState confinement)
+{
+    self->confine_pointer = confinement;
+}
 
 bool miral::WindowInfo::has_name() const
 {

=== modified file 'miral/window_management_trace.cpp'
--- miral/window_management_trace.cpp	2016-09-22 09:47:05 +0000
+++ miral/window_management_trace.cpp	2016-09-23 15:39:15 +0000
@@ -108,6 +108,7 @@
         APPEND(min_aspect);
         APPEND(max_aspect);
         APPEND(preferred_orientation);
+        APPEND(confine_pointer);
 
 #define APPEND_IF_SET(field) if (info.has_##field()) bout.append(#field, info.field());
         APPEND_IF_SET(output_id);
@@ -153,7 +154,7 @@
 //        APPEND_IF_SET(input_mode);
         APPEND_IF_SET(shell_chrome);
         APPEND_IF_SET(top_left);
-        APPEND_IF_SET(size);
+        APPEND_IF_SET(confine_pointer);
 #undef  APPEND_IF_SET
     }
 

=== modified file 'miral/window_specification.cpp'
--- miral/window_specification.cpp	2016-09-14 15:54:54 +0000
+++ miral/window_specification.cpp	2016-09-23 15:39:15 +0000
@@ -59,6 +59,7 @@
     mir::optional_value<std::vector<Rectangle>> input_shape;
     mir::optional_value<InputReceptionMode> input_mode;
     mir::optional_value<MirShellChrome> shell_chrome;
+    mir::optional_value<MirPointerConfinementState> confine_pointer;
 };
 
 miral::WindowSpecification::Self::Self(mir::shell::SurfaceSpecification const& spec) :
@@ -90,6 +91,9 @@
     input_shape(spec.input_shape),
     input_mode(),
     shell_chrome(spec.shell_chrome)
+#if MIRAL_MIR_DEFINES_POINTER_CONFINEMENT
+    ,confine_pointer(spec.confine_pointer)
+#endif
 {
 #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())
@@ -236,6 +240,9 @@
     input_shape(params.input_shape),
     input_mode(static_cast<InputReceptionMode>(params.input_mode)),
     shell_chrome(params.shell_chrome)
+#if MIRAL_MIR_DEFINES_POINTER_CONFINEMENT
+    ,confine_pointer(params.confine_pointer)
+#endif
 {
 #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())
@@ -304,6 +311,9 @@
     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 MIRAL_MIR_DEFINES_POINTER_CONFINEMENT
+    copy_if_set(params.confine_pointer, confine_pointer);
+#endif
 
 #if MIR_SERVER_VERSION >= MIR_VERSION_NUMBER(0, 25, 0)
     copy_if_set(params.placement_hints, placement_hints);
@@ -472,6 +482,11 @@
     return self->shell_chrome;
 }
 
+auto miral::WindowSpecification::confine_pointer() const -> mir::optional_value<MirPointerConfinementState> const&
+{
+    return self->confine_pointer;
+}
+
 auto miral::WindowSpecification::top_left() -> mir::optional_value<Point>&
 {
     return self->top_left;
@@ -591,3 +606,8 @@
 {
     return self->shell_chrome;
 }
+
+auto miral::WindowSpecification::confine_pointer() -> mir::optional_value<MirPointerConfinementState>&
+{
+    return self->confine_pointer;
+}