Merge lp:~brandontschaefer/mir/usr-mir-window-placement into lp:mir

[Brandon Schaefer]

Use MirWindowPlacementEvent vs MirSurfacePlacement

Use MirWindowPlacementEvent vs MirSurfacePlacement

[Cemil Azizoglu (cemil-azizoglu)]

36 MirSurfacePlacementEvent const* mir_event_get_surface_placement_event(MirEvent const* event);
37

Forgot to follow 'deprecated' in a comment as a reminder.
-------------------------------------------------------

71 + * Authored by: Alan Griffiths <email address hidden>
72

your name should be added?
-------------------------------------------------------

87 +typedef struct MirSurfacePlacementEvent MirWindowPlacementEvent;
88 +

Must not be typedef'ed again... Just include the right file where it was originally typedefed.
-------------------------------------------------------

132 -MirRectangle mir_surface_placement_get_relative_position(MirSurfacePlacementEvent const* event) MIR_HANDLE_EVENT_EXCEPTION(
133 +MirRectangle mir_window_placement_get_relative_position(MirWindowPlacementEvent const* event) MIR_HANDLE_EVENT_EXCEPTION(

Must not replace the old function. Just call the new function from the old

review: Needs Fixing

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

PASSED: Continuous integration, rev:3926
https://mir-jenkins.ubuntu.com/job/mir-ci/2626/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/3414
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/3481
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/3473
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/3473
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/3473
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3443
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3443/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3443
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3443/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3443
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3443/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3443
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3443/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3443
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3443/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3443
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3443/artifact/output/*zip*/output.zip

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

review: Approve (continuous-integration)

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

FAILED: Continuous integration, rev:3931
https://mir-jenkins.ubuntu.com/job/mir-ci/2635/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/3425/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/3492
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/3484
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/3484
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/3484
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3454
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3454/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3454
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3454/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3454
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3454/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3454
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3454/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3454
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3454/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3454/console

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:3933
https://mir-jenkins.ubuntu.com/job/mir-ci/2654/
Executed test runs:
    ABORTED: https://mir-jenkins.ubuntu.com/job/build-mir/3448/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/3515
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/3507
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/3507
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/3507

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

review: Needs Fixing (continuous-integration)

=== modified file 'include/client/mir/event_printer.h'
--- include/client/mir/event_printer.h	2017-01-11 14:16:14 +0000
+++ include/client/mir/event_printer.h	2017-01-11 14:16:15 +0000
@@ -52,7 +52,7 @@
 std::ostream& operator<<(std::ostream& out, MirKeymapEvent const& event);
 std::ostream& operator<<(std::ostream& out, MirWindowEvent const& event);
 std::ostream& operator<<(std::ostream& out, MirInputDeviceStateEvent const& event);
-std::ostream& operator<<(std::ostream& out, MirSurfacePlacementEvent const& event);
+std::ostream& operator<<(std::ostream& out, MirWindowPlacementEvent const& event);
 std::ostream& operator<<(std::ostream& out, MirEvent const& event);
 
 }

=== modified file 'include/client/mir_toolkit/events/event.h'
--- include/client/mir_toolkit/events/event.h	2017-01-11 14:16:14 +0000
+++ include/client/mir_toolkit/events/event.h	2017-01-11 14:16:15 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2014-2016 Canonical Ltd.
+ * Copyright © 2014-2017 Canonical Ltd.
  *
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU Lesser General Public License version 3,
@@ -70,7 +70,8 @@
 typedef struct MirSurfaceOutputEvent MirSurfaceOutputEvent; /* __attribute__ ((deprecated("use MirWindowOutputEvent instead"))); */
 typedef struct MirSurfaceOutputEvent MirWindowOutputEvent;
 typedef struct MirInputDeviceStateEvent MirInputDeviceStateEvent;
-typedef struct MirSurfacePlacementEvent MirSurfacePlacementEvent;
+typedef struct MirSurfacePlacementEvent MirSurfacePlacementEvent; /* __attribute__ ((deprecated("use MirWindowPlacementEvent instead"))); */
+typedef struct MirSurfacePlacementEvent MirWindowPlacementEvent;
 
 typedef struct MirCookie MirCookie;
 
@@ -266,6 +267,17 @@
  * \return           The associated MirSurfacePlacementEvent
  */
 MirSurfacePlacementEvent const* mir_event_get_surface_placement_event(MirEvent const* event);
+/* __attribute__((deprecated("use mir_event_get_window_placement_event))) */
+
+/**
+ * Retrieve the MirWindowPlacementEvent associated with a MirEvent of
+ * type mir_event_type_window_placement. The event signifies that the
+ * the server has fulfilled a request for relative window placement.
+ *
+ * \param [in] event The event
+ * \return           The associated MirWindowPlacementEvent
+ */
+MirWindowPlacementEvent const* mir_event_get_window_placement_event(MirEvent const* event);
 
 /*
  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

=== added file 'include/client/mir_toolkit/events/window_placement.h'
--- include/client/mir_toolkit/events/window_placement.h	1970-01-01 00:00:00 +0000
+++ include/client/mir_toolkit/events/window_placement.h	2017-01-11 14:16:15 +0000
@@ -0,0 +1,46 @@
+/*
+ * Copyright © 2017 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Alan Griffiths <[e-mail]>
+ *              Brandon Schaefer <[e-mail]>
+ */
+
+#ifndef MIR_TOOLKIT_WINDOW_PLACEMENT_H_
+#define MIR_TOOLKIT_WINDOW_PLACEMENT_H_
+
+#include <mir_toolkit/client_types.h>
+
+#ifdef __cplusplus
+/**
+ * \addtogroup mir_toolkit
+ * @{
+ */
+extern "C" {
+#endif
+
+/**
+ * Retrieve the relative position from a placement notification
+ *
+ * \param [in] event  The placement event
+ * \return            The position relative to the parent window
+ */
+MirRectangle mir_window_placement_get_relative_position(MirWindowPlacementEvent const* event);
+
+#ifdef __cplusplus
+}
+/**@}*/
+#endif
+
+#endif //MIR_TOOLKIT_WINDOW_PLACEMENT_H_

=== modified file 'src/client/event.cpp'
--- src/client/event.cpp	2017-01-11 14:16:14 +0000
+++ src/client/event.cpp	2017-01-11 14:16:15 +0000
@@ -33,6 +33,7 @@
 #include "mir_toolkit/events/orientation_event.h"
 #include "mir_toolkit/events/input_device_state_event.h"
 #include "mir_toolkit/events/surface_placement.h"
+#include "mir_toolkit/events/window_placement.h"
 
 #include <cstdlib>
 #include <cstring>
@@ -412,10 +413,20 @@
 
 MirSurfacePlacementEvent const* mir_event_get_surface_placement_event(MirEvent const* event) MIR_HANDLE_EVENT_EXCEPTION(
 {
+    return mir_event_get_window_placement_event(event);
+})
+
+MirRectangle mir_surface_placement_get_relative_position(MirSurfacePlacementEvent const* event) MIR_HANDLE_EVENT_EXCEPTION(
+{
+    return mir_window_placement_get_relative_position(event);
+})
+
+MirWindowPlacementEvent const* mir_event_get_window_placement_event(MirEvent const* event) MIR_HANDLE_EVENT_EXCEPTION(
+{
     return event->to_surface_placement();
 })
 
-MirRectangle mir_surface_placement_get_relative_position(MirSurfacePlacementEvent const* event) MIR_HANDLE_EVENT_EXCEPTION(
+MirRectangle mir_window_placement_get_relative_position(MirWindowPlacementEvent const* event) MIR_HANDLE_EVENT_EXCEPTION(
 {
     return event->placement();
 })

=== modified file 'src/client/event_printer.cpp'
--- src/client/event_printer.cpp	2017-01-11 14:16:14 +0000
+++ src/client/event_printer.cpp	2017-01-11 14:16:15 +0000
@@ -319,7 +319,7 @@
 
 std::ostream& mir::operator<<(std::ostream& out, MirCloseWindowEvent const&)
 {
-    return out << "close_surface_event()";
+    return out << "close_window_event()";
 }
 
 std::ostream& mir::operator<<(std::ostream& out, MirWindowEvent const& event)
@@ -357,10 +357,10 @@
     return out << ')';
 }
 
-std::ostream& mir::operator<<(std::ostream& out, MirSurfacePlacementEvent const& event)
+std::ostream& mir::operator<<(std::ostream& out, MirWindowPlacementEvent const& event)
 {
     auto const& placement = event.placement();
-    return out << "surface_placement_event({"
+    return out << "window_placement_event({"
                << placement.left << ", "
                << placement.top << ", "
                << placement.width << ", "

=== modified file 'src/client/symbols.map'
--- src/client/symbols.map	2017-01-11 14:16:14 +0000
+++ src/client/symbols.map	2017-01-11 14:16:15 +0000
@@ -560,4 +560,6 @@
     mir_window_output_event_get_scale;
     mir_window_output_event_get_output_id;
     mir_window_output_event_get_refresh_rate;
+    mir_event_get_window_placement_event;
+    mir_window_placement_get_relative_position;
 } MIR_CLIENT_0.25;

=== modified file 'tests/acceptance-tests/test_custom_window_management.cpp'
--- tests/acceptance-tests/test_custom_window_management.cpp	2017-01-11 14:16:14 +0000
+++ tests/acceptance-tests/test_custom_window_management.cpp	2017-01-11 14:16:15 +0000
@@ -19,6 +19,7 @@
 #include "mir/geometry/rectangle.h"
 #include "mir/scene/session.h"
 #include "mir_toolkit/events/surface_placement.h"
+#include "mir_toolkit/events/window_placement.h"
 #include "mir/events/event_builders.h"
 #include "mir/scene/surface.h"
 
@@ -529,12 +530,12 @@
 {
     PlacementCheck(MirRectangle const& placement) : expected_rect{placement} {}
 
-    void check(MirSurfacePlacementEvent const* placement_event)
+    void check(MirWindowPlacementEvent const* placement_event)
     {
-        EXPECT_THAT(mir_surface_placement_get_relative_position(placement_event).top, Eq(expected_rect.top));
-        EXPECT_THAT(mir_surface_placement_get_relative_position(placement_event).left, Eq(expected_rect.left));
-        EXPECT_THAT(mir_surface_placement_get_relative_position(placement_event).height, Eq(expected_rect.height));
-        EXPECT_THAT(mir_surface_placement_get_relative_position(placement_event).width, Eq(expected_rect.width));
+        EXPECT_THAT(mir_window_placement_get_relative_position(placement_event).top, Eq(expected_rect.top));
+        EXPECT_THAT(mir_window_placement_get_relative_position(placement_event).left, Eq(expected_rect.left));
+        EXPECT_THAT(mir_window_placement_get_relative_position(placement_event).height, Eq(expected_rect.height));
+        EXPECT_THAT(mir_window_placement_get_relative_position(placement_event).width, Eq(expected_rect.width));
 
         received.raise();
     }