Merge lp:~dandrader/miral/confine_pointer into lp:miral

[Daniel d'Andrada]

Add miral::WindowSpecification::confine_pointer

[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()

[lp:~dandrader/miral/confine_pointer]

356. By Daniel d'Andrada on 2016-09-22

Make it build in xenial

[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

Unmerged revisions

=== added directory 'include/miral/detail'
=== 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-22 16:21:09 +0000
@@ -29,6 +29,8 @@
 
 #include <memory>
 
+#include "miral/detail/mir_features.h"
+
 // TODO this wants to move to Mir's toolkit API
 #if MIR_CLIENT_VERSION < MIR_VERSION_NUMBER(3, 4, 0)
 
@@ -193,6 +195,9 @@
     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&;
+#if MIRAL_MIR_POINTER_CONFINEMENT
+    auto confine_pointer() const -> mir::optional_value<MirPointerConfinementState> const&;
+#endif
 
     auto top_left() -> mir::optional_value<Point>&;
     auto size() -> mir::optional_value<Size>&;
@@ -218,6 +223,9 @@
     auto input_shape() -> mir::optional_value<std::vector<Rectangle>>&;
     auto input_mode() -> mir::optional_value<InputReceptionMode>&;
     auto shell_chrome() -> mir::optional_value<MirShellChrome>&;
+#if MIRAL_MIR_POINTER_CONFINEMENT
+    auto confine_pointer() -> mir::optional_value<MirPointerConfinementState>&;
+#endif
 
 private:
     struct Self;

=== modified file 'miral/CMakeLists.txt'
--- miral/CMakeLists.txt	2016-09-21 16:49:48 +0000
+++ miral/CMakeLists.txt	2016-09-22 16:21:09 +0000
@@ -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")

=== 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-22 16:21:09 +0000
@@ -0,0 +1,22 @@
+/*
+ * 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
+
+#define MIRAL_MIR_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-22 16:21:09 +0000
@@ -182,6 +182,7 @@
     miral::WindowSpecification::placement_hints*;
     miral::WindowSpecification::preferred_orientation*;
     miral::WindowSpecification::shell_chrome*;
+    miral::WindowSpecification::confine_pointer*;
     miral::WindowSpecification::size*;
     miral::WindowSpecification::state*;
     miral::WindowSpecification::top_left*;

=== modified file 'miral/window_specification.cpp'
--- miral/window_specification.cpp	2016-09-14 15:54:54 +0000
+++ miral/window_specification.cpp	2016-09-22 16:21:09 +0000
@@ -59,6 +59,9 @@
     mir::optional_value<std::vector<Rectangle>> input_shape;
     mir::optional_value<InputReceptionMode> input_mode;
     mir::optional_value<MirShellChrome> shell_chrome;
+#if MIRAL_MIR_POINTER_CONFINEMENT
+    mir::optional_value<MirPointerConfinementState> confine_pointer;
+#endif
 };
 
 miral::WindowSpecification::Self::Self(mir::shell::SurfaceSpecification const& spec) :
@@ -90,6 +93,9 @@
     input_shape(spec.input_shape),
     input_mode(),
     shell_chrome(spec.shell_chrome)
+#if MIRAL_MIR_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 +242,9 @@
     input_shape(params.input_shape),
     input_mode(static_cast<InputReceptionMode>(params.input_mode)),
     shell_chrome(params.shell_chrome)
+#if MIRAL_MIR_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 +313,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_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 +484,13 @@
     return self->shell_chrome;
 }
 
+#if MIRAL_MIR_POINTER_CONFINEMENT
+auto miral::WindowSpecification::confine_pointer() const -> mir::optional_value<MirPointerConfinementState> const&
+{
+    return self->confine_pointer;
+}
+#endif
+
 auto miral::WindowSpecification::top_left() -> mir::optional_value<Point>&
 {
     return self->top_left;
@@ -591,3 +610,10 @@
 {
     return self->shell_chrome;
 }
+
+#if MIRAL_MIR_POINTER_CONFINEMENT
+auto miral::WindowSpecification::confine_pointer() -> mir::optional_value<MirPointerConfinementState>&
+{
+    return self->confine_pointer;
+}
+#endif