← Back to branch summary

~alan-griffiths/mir/migrate-tests-to-miral

« back to all changes in this revision

Viewing changes to tests/miral/window_placement_anchors_to_parent.cpp

  • Committer: Christopher James Halse Rogers
  • Date: 2017-09-07 05:58:13 UTC
  • mfrom: (4242 development-branch)
  • mto: (4243.1.1 mir3)
  • mto: This revision was merged to the branch mainline in revision 4244.
  • Revision ID: christopher.halse.rogers@canonical.com-20170907055813-4qsg25nirybc8jj3
Merge trunk, resolving conflict

Show diffs side-by-side

added added

removed removed

Lines of Context:
tests/miral/window_placement_anchors_to_parent.cpp
 
1
/*
 
2
 * Copyright © 2016 Canonical Ltd.
 
3
 *
 
4
 * This program is free software: you can redistribute it and/or modify it
 
5
 * under the terms of the GNU General Public License version 2 or 3 as
 
6
 * published by the Free Software Foundation.
 
7
 *
 
8
 * This program is distributed in the hope that it will be useful,
 
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
 * GNU General Public License for more details.
 
12
 *
 
13
 * You should have received a copy of the GNU General Public License
 
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
15
 *
 
16
 * Authored by: Alan Griffiths <alan@octopull.co.uk>
 
17
 */
 
18
 
 
19
#include "test_window_manager_tools.h"
 
20
 
 
21
using namespace miral;
 
22
using namespace testing;
 
23
namespace mt = mir::test;
 
24
 
 
25
namespace
 
26
{
 
27
auto const display_area = Rectangle{{0, 0}, {800, 600}};
 
28
auto const parent_width = 400;
 
29
auto const parent_height = 300;
 
30
 
 
31
auto placement(
 
32
    Rectangle const& aux_rect,
 
33
    MirPlacementGravity aux_rect_placement_gravity,
 
34
    MirPlacementGravity window_placement_gravity,
 
35
    MirPlacementHints placement_hints) -> WindowSpecification
 
36
{
 
37
    WindowSpecification modification;
 
38
 
 
39
    modification.aux_rect() = aux_rect;
 
40
    modification.aux_rect_placement_gravity() = aux_rect_placement_gravity;
 
41
    modification.window_placement_gravity() = window_placement_gravity;
 
42
    modification.placement_hints() = placement_hints;
 
43
 
 
44
    return modification;
 
45
}
 
46
 
 
47
struct WindowPlacementAnchorsToParent : TestWindowManagerTools
 
48
{
 
49
    Size const parent_size{parent_width, parent_height};
 
50
    Size const initial_child_size{100, 50};
 
51
 
 
52
    Window parent;
 
53
    Window child;
 
54
 
 
55
    Point parent_position;
 
56
    WindowSpecification modification;
 
57
 
 
58
    void SetUp() override
 
59
    {
 
60
        TestWindowManagerTools::SetUp();
 
61
 
 
62
        basic_window_manager.add_display_for_testing(display_area);
 
63
 
 
64
        mir::scene::SurfaceCreationParameters creation_parameters;
 
65
        basic_window_manager.add_session(session);
 
66
 
 
67
        EXPECT_CALL(*window_manager_policy, advise_new_window(_))
 
68
            .WillOnce(Invoke([this](WindowInfo const& window_info){ parent = window_info.window(); }))
 
69
            .WillOnce(Invoke([this](WindowInfo const& window_info){ child = window_info.window(); }));
 
70
 
 
71
        creation_parameters.size = parent_size;
 
72
        basic_window_manager.add_surface(session, creation_parameters, &create_surface);
 
73
 
 
74
        creation_parameters.type = mir_window_type_tip;
 
75
        creation_parameters.parent = parent;
 
76
        creation_parameters.size = initial_child_size;
 
77
        basic_window_manager.add_surface(session, creation_parameters, &create_surface);
 
78
 
 
79
        // Clear the expectations used to capture parent & child
 
80
        Mock::VerifyAndClearExpectations(window_manager_policy);
 
81
 
 
82
        parent_position = parent.top_left();
 
83
    }
 
84
};
 
85
}
 
86
 
 
87
// there was an IRC conversation to sort this out between myself William and Thomas.
 
88
// I think the resulting consensus was:
 
89
//
 
90
//   1. Mir will constrain the placement anchor of the aux_rect to the parent
 
91
//      surface. I don't think we agreed exactly how (e.g. do we "clip" the
 
92
//      rect? What happens if there is *no* intersection?)
 
93
//
 
94
//   2. Mir will constrain the the offset placement anchor to the parent surface.
 
95
//      Again I don't think we agreed how. (Slide it horizontally and/or vertically
 
96
//      the minimum amount?)
 
97
//                                      - alan_g (mir-devel, Mon, 5 Sep 2016 17:21:01 +0100)
 
98
//
 
99
// What we have implemented is to constrain the result of offsetting to the parent. That
 
100
// seems to provide reasonable behaviour. Are there test cases that require something more?
 
101
 
 
102
TEST_F(WindowPlacementAnchorsToParent, given_rect_anchor_right_of_parent_client_is_anchored_to_parent)
 
103
{
 
104
    auto const rect_size = 10;
 
105
    Rectangle const overlapping_right{{parent_width-rect_size/2, parent_height/2}, {rect_size, rect_size}};
 
106
 
 
107
    modification = placement(
 
108
        overlapping_right,
 
109
        mir_placement_gravity_northeast,
 
110
        mir_placement_gravity_northwest,
 
111
        MirPlacementHints(mir_placement_hints_slide_y|mir_placement_hints_resize_x));
 
112
 
 
113
    auto const expected_position = parent_position + Displacement{parent_width, parent_height/2};
 
114
 
 
115
    EXPECT_CALL(*window_manager_policy, advise_move_to(_, expected_position));
 
116
    EXPECT_CALL(*window_manager_policy, advise_resize(_, _)).Times(0);
 
117
    basic_window_manager.modify_window(basic_window_manager.info_for(child), modification);
 
118
    ASSERT_THAT(child.top_left(), Eq(expected_position));
 
119
    ASSERT_THAT(child.size(), Eq(initial_child_size));
 
120
}
 
121
 
 
122
TEST_F(WindowPlacementAnchorsToParent, given_rect_anchor_above_parent_client_is_anchored_to_parent)
 
123
{
 
124
    auto const rect_size = 10;
 
125
    Rectangle const overlapping_above{{parent_width/2, -rect_size/2}, {rect_size, rect_size}};
 
126
 
 
127
    modification = placement(
 
128
        overlapping_above,
 
129
        mir_placement_gravity_northeast,
 
130
        mir_placement_gravity_southeast,
 
131
        mir_placement_hints_slide_x);
 
132
 
 
133
    auto const expected_position = parent_position + DeltaX{parent_width/2 + rect_size}
 
134
                                   - as_displacement(initial_child_size);
 
135
 
 
136
    EXPECT_CALL(*window_manager_policy, advise_move_to(_, expected_position));
 
137
    EXPECT_CALL(*window_manager_policy, advise_resize(_, _)).Times(0);
 
138
    basic_window_manager.modify_window(basic_window_manager.info_for(child), modification);
 
139
    ASSERT_THAT(child.top_left(), Eq(expected_position));
 
140
    ASSERT_THAT(child.size(), Eq(initial_child_size));
 
141
}
 
142
 
 
143
TEST_F(WindowPlacementAnchorsToParent, given_offset_right_of_parent_client_is_anchored_to_parent)
 
144
{
 
145
    auto const rect_size = 10;
 
146
    Rectangle const mid_right{{parent_width-rect_size, parent_height/2}, {rect_size, rect_size}};
 
147
 
 
148
    modification = placement(
 
149
        mid_right,
 
150
        mir_placement_gravity_northeast,
 
151
        mir_placement_gravity_northwest,
 
152
        MirPlacementHints(mir_placement_hints_slide_y|mir_placement_hints_resize_x));
 
153
 
 
154
    modification.aux_rect_placement_offset() = Displacement{rect_size, 0};
 
155
 
 
156
    auto const expected_position = parent_position + Displacement{parent_width, parent_height/2};
 
157
 
 
158
    EXPECT_CALL(*window_manager_policy, advise_move_to(_, expected_position));
 
159
    EXPECT_CALL(*window_manager_policy, advise_resize(_, _)).Times(0);
 
160
    basic_window_manager.modify_window(basic_window_manager.info_for(child), modification);
 
161
    ASSERT_THAT(child.top_left(), Eq(expected_position));
 
162
    ASSERT_THAT(child.size(), Eq(initial_child_size));
 
163
}
 
164
 
 
165
TEST_F(WindowPlacementAnchorsToParent, given_offset_above_parent_client_is_anchored_to_parent)
 
166
{
 
167
    auto const rect_size = 10;
 
168
    Rectangle const mid_top{{parent_width/2, 0}, {rect_size, rect_size}};
 
169
 
 
170
    modification = placement(
 
171
        mid_top,
 
172
        mir_placement_gravity_northeast,
 
173
        mir_placement_gravity_southeast,
 
174
        mir_placement_hints_slide_x);
 
175
 
 
176
    modification.aux_rect_placement_offset() = Displacement{0, -rect_size};
 
177
 
 
178
    auto const expected_position = parent_position + DeltaX{parent_width/2 + rect_size}
 
179
                                   - as_displacement(initial_child_size);
 
180
 
 
181
    EXPECT_CALL(*window_manager_policy, advise_move_to(_, expected_position));
 
182
    EXPECT_CALL(*window_manager_policy, advise_resize(_, _)).Times(0);
 
183
    basic_window_manager.modify_window(basic_window_manager.info_for(child), modification);
 
184
    ASSERT_THAT(child.top_left(), Eq(expected_position));
 
185
    ASSERT_THAT(child.size(), Eq(initial_child_size));
 
186
}
 
187
 
 
188
TEST_F(WindowPlacementAnchorsToParent, given_rect_and_offset_below_left_parent_client_is_anchored_to_parent)
 
189
{
 
190
    auto const rect_size = 10;
 
191
    Rectangle const below_left{{-rect_size, parent_height}, {rect_size, rect_size}};
 
192
 
 
193
    modification = placement(
 
194
        below_left,
 
195
        mir_placement_gravity_southwest,
 
196
        mir_placement_gravity_northeast,
 
197
        mir_placement_hints_resize_any);
 
198
 
 
199
    modification.aux_rect_placement_offset() = Displacement{-rect_size, rect_size};
 
200
 
 
201
    auto const expected_position = parent_position + DeltaY{parent_height} - as_displacement(initial_child_size).dx;
 
202
 
 
203
    EXPECT_CALL(*window_manager_policy, advise_move_to(_, expected_position));
 
204
    EXPECT_CALL(*window_manager_policy, advise_resize(_, _)).Times(0);
 
205
    basic_window_manager.modify_window(basic_window_manager.info_for(child), modification);
 
206
    ASSERT_THAT(child.top_left(), Eq(expected_position));
 
207
    ASSERT_THAT(child.size(), Eq(initial_child_size));
 
208
}