1
=== modified file 'include/client/mir_toolkit/mir_surface.h'
2
--- include/client/mir_toolkit/mir_surface.h	2015-06-17 05:20:42 +0000
3
+++ include/client/mir_toolkit/mir_surface.h	2015-06-29 06:21:38 +0000
4
@@ -416,6 +416,30 @@
5
416
void mir_surface_spec_set_preferred_orientation(MirSurfaceSpec* spec, MirOrientationMode mode);
416
void mir_surface_spec_set_preferred_orientation(MirSurfaceSpec* spec, MirOrientationMode mode);
6
417
417
7
418
/**
418
/**
8
419
 * Request that the created surface be attached to a surface of a different client.
9
420
 *
10
421
 * This is restricted to input methods, which need to attach their suggestion surface
11
422
 * to text entry widgets of other processes.
12
423
 *
13
424
 * \param [in] spec             Specification to mutate
14
425
 * \param [in] parent           A MirPersistentId reference to the parent surface
15
426
 * \param [in] attachment_rect  A rectangle specifying the region (in parent surface coordinates)
16
427
 *                              that the created surface should be attached to.
17
428
 * \param [in] edge             The preferred edge direction to attach to. Use
18
429
 *                              mir_edge_attachment_any for no preference.
19
430
 * \return                      False if the operation is invalid for this surface type.
20
431
 *
21
432
 * \note    If the parent surface becomes invalid before mir_surface_create() is processed,
22
433
 *          it will return an invalid surface. If the parent surface is valid at the time
23
434
 *          mir_surface_create() is called but is later closed, this surface will also receive
24
435
 *          a close event.
25
436
 */
26
437
bool mir_surface_spec_attach_to_foreign_parent(MirSurfaceSpec* spec,
27
438
                                               MirPersistentId* parent,
28
439
                                               MirRectangle* attachment_rect,
29
440
                                               MirEdgeAttachment edge);
30
441
31
442
/**
32
419
 * Set the requested state.
443
 * Set the requested state.
33
420
 * \param [in] spec    Specification to mutate
444
 * \param [in] spec    Specification to mutate
34
421
 * \param [in] mode    Requested state
445
 * \param [in] mode    Requested state
35
@@ -694,6 +718,23 @@
36
694
 */
718
 */
37
695
void mir_persistent_id_release(MirPersistentId* id);
719
void mir_persistent_id_release(MirPersistentId* id);
38
696
720
39
721
/**
40
722
 * \brief Get a string representation of a MirSurfaceId
41
723
 * \param [in] id  The ID to serialise
42
724
 * \return A string representation of id. This string is owned by the MirSurfaceId,
43
725
 *         and must not be freed by the caller.
44
726
 *
45
727
 * \see mir_surface_id_from_string
46
728
 */
47
729
char const* mir_persistent_id_as_string(MirPersistentId* id);
48
730
49
731
/**
50
732
 * \brief Deserialise a string representation of a MirSurfaceId
51
733
 * \param [in] string_representation  Serialised representation of the ID
52
734
 * \return The deserialised MirSurfaceId
53
735
 */
54
736
MirPersistentId* mir_persistent_id_from_string(char const* string_representation);
55
737
56
697
#ifdef __cplusplus
738
#ifdef __cplusplus
57
698
}
739
}
58
699
/**@}*/
740
/**@}*/
59
700
741
60
=== modified file 'src/client/mir_surface.cpp'
61
--- src/client/mir_surface.cpp	2015-06-17 18:24:42 +0000
62
+++ src/client/mir_surface.cpp	2015-06-29 06:21:38 +0000
63
@@ -107,6 +107,12 @@
64
107
    if (parent.is_set() && parent.value() != nullptr)
107
    if (parent.is_set() && parent.value() != nullptr)
65
108
        message->set_parent_id(parent.value()->id());
108
        message->set_parent_id(parent.value()->id());
66
109
109
67
110
    if (parent_id)
68
111
    {
69
112
        auto id = message->mutable_parent_persistent_id();
70
113
        id->set_value(parent_id->as_string());
71
114
    }
72
115
73
110
    if (aux_rect.is_set())
116
    if (aux_rect.is_set())
74
111
    {
117
    {
75
112
        message->mutable_aux_rect()->set_left(aux_rect.value().left);
118
        message->mutable_aux_rect()->set_left(aux_rect.value().left);
76
@@ -648,6 +654,12 @@
77
648
    if (spec.parent.is_set() && spec.parent.value())
654
    if (spec.parent.is_set() && spec.parent.value())
78
649
        surface_specification->set_parent_id(spec.parent.value()->id());
655
        surface_specification->set_parent_id(spec.parent.value()->id());
79
650
656
80
657
    if (spec.parent_id)
81
658
    {
82
659
        auto id = surface_specification->mutable_parent_persistent_id();
83
660
        id->set_value(spec.parent_id->as_string());
84
661
    }
85
662
86
651
    if (spec.aux_rect.is_set())
663
    if (spec.aux_rect.is_set())
87
652
    {
664
    {
88
653
        auto const rect = surface_specification->mutable_aux_rect();
665
        auto const rect = surface_specification->mutable_aux_rect();
89
654
666
90
=== modified file 'src/client/mir_surface.h'
91
--- src/client/mir_surface.h	2015-06-17 18:24:42 +0000
92
+++ src/client/mir_surface.h	2015-06-29 06:21:38 +0000
93
@@ -86,6 +86,7 @@
94
86
    mir::optional_value<MirOrientationMode> pref_orientation;
86
    mir::optional_value<MirOrientationMode> pref_orientation;
95
87
87
96
88
    mir::optional_value<MirSurface*> parent;
88
    mir::optional_value<MirSurface*> parent;
97
89
    std::unique_ptr<MirPersistentId> parent_id;
98
89
    mir::optional_value<MirRectangle> aux_rect;
90
    mir::optional_value<MirRectangle> aux_rect;
99
90
    mir::optional_value<MirEdgeAttachment> edge_attachment;
91
    mir::optional_value<MirEdgeAttachment> edge_attachment;
100
91
92
101
92
93
102
=== modified file 'src/client/mir_surface_api.cpp'
103
--- src/client/mir_surface_api.cpp	2015-06-17 05:20:42 +0000
104
+++ src/client/mir_surface_api.cpp	2015-06-29 06:21:38 +0000
105
@@ -632,3 +632,33 @@
106
632
{
632
{
107
633
    delete id;
633
    delete id;
108
634
}
634
}
109
635
110
636
bool mir_surface_spec_attach_to_foreign_parent(MirSurfaceSpec* spec,
111
637
                                               MirPersistentId* parent,
112
638
                                               MirRectangle* attachment_rect,
113
639
                                               MirEdgeAttachment edge)
114
640
{
115
641
    mir::require(mir_persistent_id_is_valid(parent));
116
642
    mir::require(attachment_rect != nullptr);
117
643
118
644
    if (!spec->type.is_set() ||
119
645
        spec->type.value() != mir_surface_type_inputmethod)
120
646
    {
121
647
        return false;
122
648
    }
123
649
124
650
    spec->parent_id = std::make_unique<MirPersistentId>(*parent);
125
651
    spec->aux_rect = *attachment_rect;
126
652
    spec->edge_attachment = edge;
127
653
    return true;
128
654
}
129
655
130
656
char const* mir_persistent_id_as_string(MirPersistentId *id)
131
657
{
132
658
    return id->as_string().c_str();
133
659
}
134
660
135
661
MirPersistentId* mir_persistent_id_from_string(char const* id_string)
136
662
{
137
663
    return new MirPersistentId{id_string};
138
664
}
139
635
665
140
=== modified file 'src/client/symbols.map'
141
--- src/client/symbols.map	2015-06-25 11:26:34 +0000
142
+++ src/client/symbols.map	2015-06-29 06:21:38 +0000
143
@@ -78,6 +78,8 @@
144
78
    mir_omnidirectional_resize_cursor_name;
78
    mir_omnidirectional_resize_cursor_name;
145
79
    mir_open_hand_cursor_name;
79
    mir_open_hand_cursor_name;
146
80
    mir_orientation_event_get_direction;
80
    mir_orientation_event_get_direction;
147
81
    mir_persistent_id_as_string;
148
82
    mir_persistent_id_from_string;
149
81
    mir_persistent_id_is_valid;
83
    mir_persistent_id_is_valid;
150
82
    mir_persistent_id_release;
84
    mir_persistent_id_release;
151
83
    mir_platform_message_create;
85
    mir_platform_message_create;
152
@@ -130,6 +132,7 @@
153
130
    mir_surface_set_state;
132
    mir_surface_set_state;
154
131
    mir_surface_set_swapinterval;
133
    mir_surface_set_swapinterval;
155
132
    mir_surface_spec_release;
134
    mir_surface_spec_release;
156
135
    mir_surface_spec_attach_to_foreign_parent;
157
133
    mir_surface_spec_set_buffer_usage;
136
    mir_surface_spec_set_buffer_usage;
158
134
    mir_surface_spec_set_fullscreen_on_output;
137
    mir_surface_spec_set_fullscreen_on_output;
159
135
    mir_surface_spec_set_height;
138
    mir_surface_spec_set_height;
160
136
139
161
=== modified file 'src/include/server/mir/frontend/shell.h'
162
--- src/include/server/mir/frontend/shell.h	2015-06-17 05:20:42 +0000
163
+++ src/include/server/mir/frontend/shell.h	2015-06-29 06:21:38 +0000
164
@@ -33,6 +33,7 @@
165
33
{
33
{
166
34
struct SurfaceCreationParameters;
34
struct SurfaceCreationParameters;
167
35
struct PromptSessionCreationParameters;
35
struct PromptSessionCreationParameters;
168
36
class Surface;
169
36
}
37
}
170
37
namespace shell { class SurfaceSpecification; }
38
namespace shell { class SurfaceSpecification; }
171
38
39
172
@@ -63,7 +64,9 @@
173
63
    virtual SurfaceId create_surface(std::shared_ptr<Session> const& session, scene::SurfaceCreationParameters const& params) = 0;
64
    virtual SurfaceId create_surface(std::shared_ptr<Session> const& session, scene::SurfaceCreationParameters const& params) = 0;
174
64
    virtual void modify_surface(std::shared_ptr<Session> const& session, SurfaceId surface, shell::SurfaceSpecification const& modifications) = 0;
65
    virtual void modify_surface(std::shared_ptr<Session> const& session, SurfaceId surface, shell::SurfaceSpecification const& modifications) = 0;
175
65
    virtual void destroy_surface(std::shared_ptr<Session> const& session, SurfaceId surface) = 0;
66
    virtual void destroy_surface(std::shared_ptr<Session> const& session, SurfaceId surface) = 0;
176
67
177
66
    virtual std::string persistent_id_for(std::shared_ptr<Session> const& session, SurfaceId surface) = 0;
68
    virtual std::string persistent_id_for(std::shared_ptr<Session> const& session, SurfaceId surface) = 0;
178
69
    virtual std::shared_ptr<scene::Surface> surface_for_id(std::string const& serialised_id) = 0;
179
67
70
180
68
    virtual int set_surface_attribute(
71
    virtual int set_surface_attribute(
181
69
        std::shared_ptr<Session> const& session,
72
        std::shared_ptr<Session> const& session,
182
70
73
183
=== modified file 'src/include/server/mir/frontend/template_protobuf_message_processor.h'
184
--- src/include/server/mir/frontend/template_protobuf_message_processor.h	2015-06-17 05:20:42 +0000
185
+++ src/include/server/mir/frontend/template_protobuf_message_processor.h	2015-06-29 06:21:38 +0000
186
@@ -27,6 +27,7 @@
187
27
#include <boost/exception/diagnostic_information.hpp>
27
#include <boost/exception/diagnostic_information.hpp>
188
28
28
189
29
#include <memory>
29
#include <memory>
190
30
#include <string>
191
30
31
192
31
namespace mir
32
namespace mir
193
32
{
33
{
194
@@ -79,7 +80,9 @@
195
79
    }
80
    }
196
80
    catch (std::exception const& x)
81
    catch (std::exception const& x)
197
81
    {
82
    {
199
82
        result_message.set_error(boost::diagnostic_information(x));
83
        using namespace std::literals::string_literals;
200
84
        result_message.set_error("Error processing request: "s +
201
85
            x.what() + "\nInternal error details: " + boost::diagnostic_information(x));
202
83
        self->send_response(invocation.id(), &result_message);
86
        self->send_response(invocation.id(), &result_message);
203
84
    }
87
    }
204
85
}
88
}
205
86
89
206
=== modified file 'src/protobuf/mir_protobuf.proto'
207
--- src/protobuf/mir_protobuf.proto	2015-06-25 19:29:44 +0000
208
+++ src/protobuf/mir_protobuf.proto	2015-06-29 06:21:38 +0000
209
@@ -35,6 +35,8 @@
210
35
  optional int32 height_inc = 18;
35
  optional int32 height_inc = 18;
211
36
  optional SurfaceAspectRatio min_aspect = 19;
36
  optional SurfaceAspectRatio min_aspect = 19;
212
37
  optional SurfaceAspectRatio max_aspect = 20;
37
  optional SurfaceAspectRatio max_aspect = 20;
213
38
214
39
  optional PersistentSurfaceId parent_persistent_id = 21;
215
38
}
40
}
216
39
41
217
40
message SurfaceAspectRatio
42
message SurfaceAspectRatio
218
@@ -63,11 +65,15 @@
219
63
  optional int32 min_height = 14;
65
  optional int32 min_height = 14;
220
64
  optional int32 max_width = 15;
66
  optional int32 max_width = 15;
221
65
  optional int32 max_height = 16;
67
  optional int32 max_height = 16;
222
68
223
66
  optional int32 width_inc = 17;
69
  optional int32 width_inc = 17;
224
67
  optional int32 height_inc = 18;
70
  optional int32 height_inc = 18;
225
68
  optional SurfaceAspectRatio min_aspect = 19;
71
  optional SurfaceAspectRatio min_aspect = 19;
226
69
  optional SurfaceAspectRatio max_aspect = 20;
72
  optional SurfaceAspectRatio max_aspect = 20;
227
73
228
70
  repeated StreamConfiguration stream = 21; 
74
  repeated StreamConfiguration stream = 21; 
229
75
230
76
  optional PersistentSurfaceId parent_persistent_id = 22;
231
71
}
77
}
232
72
78
233
73
message StreamConfiguration {
79
message StreamConfiguration {
234
74
80
235
=== modified file 'src/server/frontend/protobuf_message_processor.cpp'
236
--- src/server/frontend/protobuf_message_processor.cpp	2015-06-17 19:16:03 +0000
237
+++ src/server/frontend/protobuf_message_processor.cpp	2015-06-29 06:21:38 +0000
238
@@ -138,7 +138,9 @@
239
138
    }
138
    }
240
139
    catch (std::exception const& x)
139
    catch (std::exception const& x)
241
140
    {
140
    {
243
141
        result_message->set_error(boost::diagnostic_information(x));
141
        using namespace std::literals;
244
142
        result_message->set_error("Error processing request: "s +
245
143
            x.what() + "\nInternal error details: " + boost::diagnostic_information(x));
246
142
        callback->Run();
144
        callback->Run();
247
143
    }
145
    }
248
144
}
146
}
249
145
147
250
=== modified file 'src/server/frontend/session_mediator.cpp'
251
--- src/server/frontend/session_mediator.cpp	2015-06-19 12:35:35 +0000
252
+++ src/server/frontend/session_mediator.cpp	2015-06-29 06:21:38 +0000
253
@@ -203,6 +203,13 @@
254
203
    if (request->has_parent_id())
203
    if (request->has_parent_id())
255
204
        params.with_parent_id(SurfaceId{request->parent_id()});
204
        params.with_parent_id(SurfaceId{request->parent_id()});
256
205
205
257
206
258
207
    if (request->has_parent_persistent_id())
259
208
    {
260
209
        auto persistent_id = request->parent_persistent_id().value();
261
210
        params.parent = shell->surface_for_id(persistent_id);
262
211
    }
263
212
264
206
    if (request->has_aux_rect())
213
    if (request->has_aux_rect())
265
207
    {
214
    {
266
208
        params.with_aux_rect(geom::Rectangle{
215
        params.with_aux_rect(geom::Rectangle{
267
209
216
268
=== modified file 'src/server/frontend/shell_wrapper.cpp'
269
--- src/server/frontend/shell_wrapper.cpp	2015-06-17 05:20:42 +0000
270
+++ src/server/frontend/shell_wrapper.cpp	2015-06-29 06:21:38 +0000
271
@@ -19,6 +19,7 @@
272
19
#include "shell_wrapper.h"
19
#include "shell_wrapper.h"
273
20
20
274
21
namespace mf = mir::frontend;
21
namespace mf = mir::frontend;
275
22
namespace ms = mir::scene;
276
22
23
277
23
std::shared_ptr<mf::Session> mf::ShellWrapper::open_session(
24
std::shared_ptr<mf::Session> mf::ShellWrapper::open_session(
278
24
    pid_t client_pid,
25
    pid_t client_pid,
279
@@ -73,6 +74,11 @@
280
73
    return wrapped->persistent_id_for(session, surface);
74
    return wrapped->persistent_id_for(session, surface);
281
74
}
75
}
282
75
76
283
77
std::shared_ptr<ms::Surface> mf::ShellWrapper::surface_for_id(std::string const& serialised_id)
284
78
{
285
79
    return wrapped->surface_for_id(serialised_id);
286
80
}
287
81
288
76
int mf::ShellWrapper::set_surface_attribute(
82
int mf::ShellWrapper::set_surface_attribute(
289
77
    std::shared_ptr<Session> const& session,
83
    std::shared_ptr<Session> const& session,
290
78
    SurfaceId surface_id,
84
    SurfaceId surface_id,
291
79
85
292
=== modified file 'src/server/frontend/shell_wrapper.h'
293
--- src/server/frontend/shell_wrapper.h	2015-06-17 05:20:42 +0000
294
+++ src/server/frontend/shell_wrapper.h	2015-06-29 06:21:38 +0000
295
@@ -59,6 +59,8 @@
296
59
59
297
60
    std::string persistent_id_for(std::shared_ptr<Session> const& session, SurfaceId surface) override;
60
    std::string persistent_id_for(std::shared_ptr<Session> const& session, SurfaceId surface) override;
298
61
61
299
62
    std::shared_ptr<scene::Surface> surface_for_id(std::string const& serialised_id) override;
300
63
301
62
    int set_surface_attribute(
64
    int set_surface_attribute(
302
63
        std::shared_ptr<Session> const& session,
65
        std::shared_ptr<Session> const& session,
303
64
        SurfaceId surface_id,
66
        SurfaceId surface_id,
304
65
67
305
=== modified file 'src/server/shell/default_persistent_surface_store.cpp'
306
--- src/server/shell/default_persistent_surface_store.cpp	2015-05-29 03:30:25 +0000
307
+++ src/server/shell/default_persistent_surface_store.cpp	2015-06-29 06:21:38 +0000
308
@@ -87,5 +87,14 @@
309
87
87
310
88
std::shared_ptr<ms::Surface> msh::DefaultPersistentSurfaceStore::surface_for_id(Id const& id) const
88
std::shared_ptr<ms::Surface> msh::DefaultPersistentSurfaceStore::surface_for_id(Id const& id) const
311
89
{
89
{
313
90
    return (*store)[id];
90
    try
314
91
    {
315
92
        return (*store)[id];
316
93
    }
317
94
    catch (std::out_of_range& err)
318
95
    {
319
96
        using namespace std::literals;
320
97
        BOOST_THROW_EXCEPTION(std::out_of_range(
321
98
            "Lookup for surface with ID: "s + id.serialize_to_string() + " failed."));
322
99
    }
323
91
}
100
}
324
92
101
325
=== modified file 'src/server/shell/frontend_shell.cpp'
326
--- src/server/shell/frontend_shell.cpp	2015-06-17 05:20:42 +0000
327
+++ src/server/shell/frontend_shell.cpp	2015-06-29 06:21:38 +0000
328
@@ -25,6 +25,8 @@
329
25
#include "mir/scene/surface_creation_parameters.h"
25
#include "mir/scene/surface_creation_parameters.h"
330
26
#include "mir/scene/prompt_session.h"
26
#include "mir/scene/prompt_session.h"
331
27
27
332
28
#include <boost/throw_exception.hpp>
333
29
334
28
namespace mf = mir::frontend;
30
namespace mf = mir::frontend;
335
29
namespace ms = mir::scene;
31
namespace ms = mir::scene;
336
30
namespace msh = mir::shell::detail;
32
namespace msh = mir::shell::detail;
337
@@ -74,6 +76,15 @@
338
74
76
339
75
    auto populated_params = params;
77
    auto populated_params = params;
340
76
78
341
79
    // TODO: Fish out a policy verification object that enforces the various invariants
342
80
    //       in the surface spec requirements (eg: regular surface has no parent,
343
81
    //       dialog may have a parent, gloss must have a parent).
344
82
    if (populated_params.parent.lock() &&
345
83
        populated_params.type.value() != mir_surface_type_inputmethod)
346
84
    {
347
85
        BOOST_THROW_EXCEPTION(std::invalid_argument("Foreign parents may only be set on surfaces of type mir_surface_type_inputmethod"));
348
86
    }
349
87
350
77
    if (populated_params.parent_id.is_set())
88
    if (populated_params.parent_id.is_set())
351
78
        populated_params.parent = scene_session->surface(populated_params.parent_id.value());
89
        populated_params.parent = scene_session->surface(populated_params.parent_id.value());
352
79
90
353
@@ -107,6 +118,12 @@
354
107
    return surface_store->id_for_surface(surface).serialize_to_string();
118
    return surface_store->id_for_surface(surface).serialize_to_string();
355
108
}
119
}
356
109
120
357
121
std::shared_ptr<ms::Surface> msh::FrontendShell::surface_for_id(std::string const& serialized_id)
358
122
{
359
123
    PersistentSurfaceStore::Id const id{serialized_id};
360
124
    return surface_store->surface_for_id(id);
361
125
}
362
126
363
110
int msh::FrontendShell::set_surface_attribute(
127
int msh::FrontendShell::set_surface_attribute(
364
111
    std::shared_ptr<mf::Session> const& session,
128
    std::shared_ptr<mf::Session> const& session,
365
112
    mf::SurfaceId surface_id,
129
    mf::SurfaceId surface_id,
366
113
130
367
=== modified file 'src/server/shell/frontend_shell.h'
368
--- src/server/shell/frontend_shell.h	2015-06-17 05:20:42 +0000
369
+++ src/server/shell/frontend_shell.h	2015-06-29 06:21:38 +0000
370
@@ -71,6 +71,8 @@
371
71
71
372
72
    std::string persistent_id_for(std::shared_ptr<mf::Session> const& session, mf::SurfaceId surface) override;
72
    std::string persistent_id_for(std::shared_ptr<mf::Session> const& session, mf::SurfaceId surface) override;
373
73
73
374
74
    std::shared_ptr<ms::Surface> surface_for_id(std::string const& serialized_id) override;
375
75
376
74
    int set_surface_attribute(
76
    int set_surface_attribute(
377
75
        std::shared_ptr<mf::Session> const& session,
77
        std::shared_ptr<mf::Session> const& session,
378
76
        mf::SurfaceId surface_id,
78
        mf::SurfaceId surface_id,
379
77
79
380
=== modified file 'tests/acceptance-tests/test_client_library.cpp'
381
--- tests/acceptance-tests/test_client_library.cpp	2015-06-25 21:34:27 +0000
382
+++ tests/acceptance-tests/test_client_library.cpp	2015-06-29 06:21:38 +0000
383
@@ -913,3 +913,48 @@
384
913
    mir_persistent_id_release(surface_id);
913
    mir_persistent_id_release(surface_id);
385
914
    mir_connection_release(connection);
914
    mir_connection_release(connection);
386
915
}
915
}
387
916
388
917
TEST_F(ClientLibrary, input_method_can_specify_foreign_surface_id)
389
918
{
390
919
    auto first_client = mir_connect_sync(new_connection().c_str(), "Regular Client");
391
920
392
921
    auto surface_spec = mir_connection_create_spec_for_normal_surface(first_client,
393
922
                                                                      800, 600,
394
923
                                                                      mir_pixel_format_argb_8888);
395
924
    auto main_surface = mir_surface_create_sync(surface_spec);
396
925
    mir_surface_spec_release(surface_spec);
397
926
398
927
    ASSERT_THAT(main_surface, IsValid());
399
928
400
929
    auto main_surface_id = mir_surface_request_persistent_id_sync(main_surface);
401
930
    ASSERT_TRUE(mir_persistent_id_is_valid(main_surface_id));
402
931
403
932
    // Serialise & deserialise the ID
404
933
    auto im_parent_id = mir_persistent_id_from_string(mir_persistent_id_as_string(main_surface_id));
405
934
406
935
    auto im_client = mir_connect_sync(new_connection().c_str(), "IM Client");
407
936
    surface_spec = mir_connection_create_spec_for_input_method(im_client,
408
937
                                                               200, 20,
409
938
                                                               mir_pixel_format_argb_8888);
410
939
    MirRectangle attachment_rect {
411
940
        200,
412
941
        200,
413
942
        10,
414
943
        10
415
944
    };
416
945
    mir_surface_spec_attach_to_foreign_parent(surface_spec,
417
946
                                              im_parent_id,
418
947
                                              &attachment_rect,
419
948
                                              mir_edge_attachment_any);
420
949
    auto im_surface = mir_surface_create_sync(surface_spec);
421
950
422
951
    EXPECT_THAT(im_surface, IsValid());
423
952
424
953
    mir_surface_spec_release(surface_spec);
425
954
    mir_persistent_id_release(main_surface_id);
426
955
    mir_persistent_id_release(im_parent_id);
427
956
    mir_surface_release_sync(main_surface);
428
957
    mir_surface_release_sync(im_surface);
429
958
    mir_connection_release(first_client);
430
959
    mir_connection_release(im_client);
431
960
}
432
916
961
433
=== modified file 'tests/acceptance-tests/test_client_library_errors.cpp'
434
--- tests/acceptance-tests/test_client_library_errors.cpp	2015-06-25 03:00:08 +0000
435
+++ tests/acceptance-tests/test_client_library_errors.cpp	2015-06-29 06:21:38 +0000
436
@@ -247,6 +247,38 @@
437
247
    mir_connection_release(connection);
247
    mir_connection_release(connection);
438
248
}
248
}
439
249
249
440
250
TEST_F(ClientLibraryErrors, passing_invalid_parent_id_to_surface_create)
441
251
{
442
252
    using namespace testing;
443
253
444
254
    auto connection = mir_connect_sync(new_connection().c_str(), __PRETTY_FUNCTION__);
445
255
446
256
    ASSERT_THAT(connection, IsValid());
447
257
448
258
    // An ID that parses as valid, but doesn't correspond to any
449
259
    auto invalid_id = mir_persistent_id_from_string("05f223a2-39e5-48b9-9416-b0ce837351b6");
450
260
451
261
    auto spec = mir_connection_create_spec_for_input_method(connection,
452
262
                                                            200, 200,
453
263
                                                            mir_pixel_format_argb_8888);
454
264
    MirRectangle rect{
455
265
        100,
456
266
        100,
457
267
        10,
458
268
        10
459
269
    };
460
270
    mir_surface_spec_attach_to_foreign_parent(spec, invalid_id, &rect, mir_edge_attachment_any);
461
271
462
272
    auto surface = mir_surface_create_sync(spec);
463
273
    EXPECT_THAT(surface, Not(IsValid()));
464
274
    EXPECT_THAT(mir_surface_get_error_message(surface), MatchesRegex(".*Lookup.*failed.*"));
465
275
466
276
    mir_persistent_id_release(invalid_id);
467
277
    mir_surface_spec_release(spec);
468
278
    mir_surface_release_sync(surface);
469
279
    mir_connection_release(connection);
470
280
}
471
281
472
250
using ClientLibraryErrorsDeathTest = ClientLibraryErrors;
282
using ClientLibraryErrorsDeathTest = ClientLibraryErrors;
473
251
283
474
252
284
475
@@ -287,3 +319,34 @@
476
287
319
477
288
    mir_connection_release(connection);
320
    mir_connection_release(connection);
478
289
}
321
}
479
322
480
323
TEST_F(ClientLibraryErrorsDeathTest, surface_spec_attaching_invalid_parent_id)
481
324
{
482
325
    auto connection = mir_connect_sync(new_connection().c_str(), __PRETTY_FUNCTION__);
483
326
484
327
    auto spec = mir_connection_create_spec_for_input_method(connection, 100, 100, mir_pixel_format_argb_8888);
485
328
486
329
    MirRectangle rect{
487
330
        100,
488
331
        100,
489
332
        10,
490
333
        10
491
334
    };
492
335
    EXPECT_DEATH(mir_surface_spec_attach_to_foreign_parent(spec, nullptr, &rect, mir_edge_attachment_any), "");
493
336
494
337
    mir_connection_release(connection);
495
338
}
496
339
497
340
TEST_F(ClientLibraryErrorsDeathTest, surface_spec_attaching_invalid_rectangle)
498
341
{
499
342
    auto connection = mir_connect_sync(new_connection().c_str(), __PRETTY_FUNCTION__);
500
343
501
344
    auto spec = mir_connection_create_spec_for_input_method(connection, 100, 100, mir_pixel_format_argb_8888);
502
345
503
346
    auto id = mir_persistent_id_from_string("fa69b2e9-d507-4005-be61-5068f40a5aec");
504
347
505
348
    EXPECT_DEATH(mir_surface_spec_attach_to_foreign_parent(spec, id, nullptr, mir_edge_attachment_any), "");
506
349
507
350
    mir_persistent_id_release(id);
508
351
    mir_connection_release(connection);
509
352
}
510
290
353
511
=== modified file 'tests/acceptance-tests/test_client_surfaces.cpp'
512
--- tests/acceptance-tests/test_client_surfaces.cpp	2015-06-25 03:00:08 +0000
513
+++ tests/acceptance-tests/test_client_surfaces.cpp	2015-06-29 06:21:38 +0000
514
@@ -19,9 +19,15 @@
515
19
#include "mir_toolkit/mir_client_library.h"
19
#include "mir_toolkit/mir_client_library.h"
516
20
#include "mir_toolkit/debug/surface.h"
20
#include "mir_toolkit/debug/surface.h"
517
21
21
518
22
#include "mir/test/doubles/mock_window_manager.h"
519
23
520
24
#include "mir/scene/session.h"
521
25
#include "mir/geometry/rectangle.h"
522
26
523
22
#include "mir_test_framework/connected_client_headless_server.h"
27
#include "mir_test_framework/connected_client_headless_server.h"
524
23
#include "mir_test_framework/any_surface.h"
28
#include "mir_test_framework/any_surface.h"
525
24
#include "mir/test/validity_matchers.h"
29
#include "mir/test/validity_matchers.h"
526
30
#include "mir/test/fake_shared.h"
527
25
31
528
26
#include <gmock/gmock.h>
32
#include <gmock/gmock.h>
529
27
#include <gtest/gtest.h>
33
#include <gtest/gtest.h>
530
@@ -30,6 +36,11 @@
531
30
#include <mutex>
36
#include <mutex>
532
31
37
533
32
namespace mtf = mir_test_framework;
38
namespace mtf = mir_test_framework;
534
39
namespace mtd = mir::test::doubles;
535
40
namespace msh = mir::shell;
536
41
namespace ms = mir::scene;
537
42
namespace mt = mir::test;
538
43
namespace mg = mir::geometry;
539
33
44
540
34
namespace
45
namespace
541
35
{
46
{
542
@@ -79,6 +90,17 @@
543
79
        mir_buffer_usage_hardware,
90
        mir_buffer_usage_hardware,
544
80
        mir_display_output_id_invalid
91
        mir_display_output_id_invalid
545
81
    };
92
    };
546
93
547
94
    void SetUp() override
548
95
    {
549
96
        server.override_the_window_manager_builder([this](msh::FocusController*)
550
97
        {
551
98
            return mt::fake_shared(window_manager);
552
99
        });
553
100
        ConnectedClientHeadlessServer::SetUp();
554
101
    }
555
102
556
103
    testing::NiceMock<mtd::MockWindowManager> window_manager;
557
82
};
104
};
558
83
105
559
84
extern "C" void create_surface_callback(MirSurface* surface, void * context)
106
extern "C" void create_surface_callback(MirSurface* surface, void * context)
560
@@ -328,3 +350,55 @@
561
328
350
562
329
    mir_surface_release_sync(surf);
351
    mir_surface_release_sync(surf);
563
330
}
352
}
564
353
565
354
TEST_F(ClientSurfaces, input_methods_get_corret_parent_coordinates)
566
355
{
567
356
    using namespace testing;
568
357
569
358
    mg::Rectangle const server_rect{mg::Point{100, 100}, mg::Size{10, 10}};
570
359
    MirRectangle client_rect{ 100, 100, 10, 10 };
571
360
572
361
    auto const edge_attachment = mir_edge_attachment_vertical;
573
362
574
363
    std::shared_ptr<ms::Surface> parent_surface;
575
364
    InSequence seq;
576
365
    EXPECT_CALL(window_manager, add_surface(_,_,_)).WillOnce(Invoke([&parent_surface](auto session, auto params, auto builder)
577
366
    {
578
367
        auto id = builder(session, params);
579
368
        parent_surface = session->surface(id);
580
369
        return id;
581
370
    }));
582
371
    EXPECT_CALL(window_manager, add_surface(_,_,_)).WillOnce(Invoke([&parent_surface, server_rect, edge_attachment](auto session, auto params, auto builder)
583
372
    {
584
373
        EXPECT_THAT(params.parent.lock(), Eq(parent_surface));
585
374
        EXPECT_TRUE(params.aux_rect.is_set());
586
375
        EXPECT_THAT(params.aux_rect.value(), Eq(server_rect));
587
376
        EXPECT_TRUE(params.edge_attachment.is_set());
588
377
        EXPECT_THAT(params.edge_attachment.value(), Eq(edge_attachment));
589
378
590
379
        return builder(session, params);
591
380
    }));
592
381
593
382
    auto surface = mtf::make_any_surface(connection);
594
383
595
384
    auto parent_id = mir_surface_request_persistent_id_sync(surface);
596
385
597
386
    auto im_connection = mir_connect_sync(new_connection().c_str(), "Mock IM connection");
598
387
    ASSERT_THAT(im_connection, IsValid());
599
388
600
389
    auto spec = mir_connection_create_spec_for_input_method(im_connection, 100, 20,
601
390
        mir_pixel_format_abgr_8888);
602
391
    ASSERT_THAT(spec, NotNull());
603
392
604
393
    mir_surface_spec_attach_to_foreign_parent(spec, parent_id, &client_rect, edge_attachment);
605
394
606
395
    mir_persistent_id_release(parent_id);
607
396
608
397
    auto im = mir_surface_create_sync(spec);
609
398
    mir_surface_spec_release(spec);
610
399
611
400
    mir_surface_release_sync(im);
612
401
    mir_surface_release_sync(surface);
613
402
614
403
    mir_connection_release(im_connection);
615
404
}
616
331
405
617
=== modified file 'tests/include/mir/test/doubles/mock_shell.h'
618
--- tests/include/mir/test/doubles/mock_shell.h	2015-06-17 05:20:42 +0000
619
+++ tests/include/mir/test/doubles/mock_shell.h	2015-06-29 06:21:38 +0000
620
@@ -55,6 +55,8 @@
621
55
    MOCK_METHOD3(modify_surface, void(std::shared_ptr<frontend::Session> const&, frontend::SurfaceId, shell::SurfaceSpecification const&));
55
    MOCK_METHOD3(modify_surface, void(std::shared_ptr<frontend::Session> const&, frontend::SurfaceId, shell::SurfaceSpecification const&));
622
56
    MOCK_METHOD2(destroy_surface, void(std::shared_ptr<frontend::Session> const&, frontend::SurfaceId));
56
    MOCK_METHOD2(destroy_surface, void(std::shared_ptr<frontend::Session> const&, frontend::SurfaceId));
623
57
    MOCK_METHOD2(persistent_id_for, std::string(std::shared_ptr<frontend::Session> const&, frontend::SurfaceId));
57
    MOCK_METHOD2(persistent_id_for, std::string(std::shared_ptr<frontend::Session> const&, frontend::SurfaceId));
624
58
    MOCK_METHOD1(surface_for_id, std::shared_ptr<scene::Surface>(std::string const&));
625
59
626
58
60
627
59
61
628
60
    MOCK_METHOD4(set_surface_attribute, int(
62
    MOCK_METHOD4(set_surface_attribute, int(
Status:	Merged
Approved by:	Daniel van Vugt on 2015-07-01
Approved revision:	no longer in the source branch.
Merged at revision:	2721
Proposed branch:	lp:~raof/mir/input-methods-can-specify-foreign-parents
Merge into:	lp:mir
Prerequisite:	lp:~raof/mir/persistent-surface-id
Diff against target:	628 lines (+331/-3) 19 files modified include/client/mir_toolkit/mir_surface.h (+41/-0) src/client/mir_surface.cpp (+12/-0) src/client/mir_surface.h (+1/-0) src/client/mir_surface_api.cpp (+30/-0) src/client/symbols.map (+3/-0) src/include/server/mir/frontend/shell.h (+3/-0) src/include/server/mir/frontend/template_protobuf_message_processor.h (+4/-1) src/protobuf/mir_protobuf.proto (+6/-0) src/server/frontend/protobuf_message_processor.cpp (+3/-1) src/server/frontend/session_mediator.cpp (+7/-0) src/server/frontend/shell_wrapper.cpp (+6/-0) src/server/frontend/shell_wrapper.h (+2/-0) src/server/shell/default_persistent_surface_store.cpp (+10/-1) src/server/shell/frontend_shell.cpp (+17/-0) src/server/shell/frontend_shell.h (+2/-0) tests/acceptance-tests/test_client_library.cpp (+45/-0) tests/acceptance-tests/test_client_library_errors.cpp (+63/-0) tests/acceptance-tests/test_client_surfaces.cpp (+74/-0) tests/include/mir/test/doubles/mock_shell.h (+2/-0)
To merge this branch:	bzr merge lp:~raof/mir/input-methods-can-specify-foreign-parents
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Alberto Aguirre (community)			Approve on 2015-06-29
PS Jenkins bot (community)	continuous-integration		Approve on 2015-06-29
Alan Griffiths			Needs Fixing on 2015-06-16
Kevin DuBois (community)			Approve on 2015-06-09
Daniel van Vugt			Abstain on 2015-06-05
Robert Carr (community)		2015-05-01	Approve on 2015-06-03
Review via email: mp+258001@code.launchpad.net