Mir

Merge lp:~albaguirre/mir/dialogs_and_tooltips into lp:mir

dialogs_and_tooltips
Merge into development-branch

Proposed by Alberto Aguirre on 2015-01-15

Status:

Merged

Approved by:

Alan Griffiths on 2015-01-22

Approved revision:

2239

Merged at revision:

2249

Proposed branch:

lp:~albaguirre/mir/dialogs_and_tooltips

Merge into:

lp:mir

Diff against target:

520 lines (+290/-41)

13 files modified

client-ABI-sha1sums (+1/-1)
include/client/mir_toolkit/mir_surface.h (+87/-4)
include/server/mir/scene/surface_creation_parameters.h (+2/-2)
server-ABI-sha1sums (+1/-1)
src/client/mir_surface.cpp (+5/-6)
src/client/mir_surface.h (+1/-1)
src/client/mir_surface_api.cpp (+50/-8)
src/client/symbols.map (+3/-1)
src/protobuf/mir_protobuf.proto (+1/-1)
src/server/frontend/session_mediator.cpp (+4/-4)
src/server/scene/surface_creation_parameters.cpp (+2/-2)
tests/acceptance-tests/test_client_surfaces.cpp (+52/-1)
tests/integration-tests/client/test_mirsurface.cpp (+81/-9)

To merge this branch:

bzr merge lp:~albaguirre/mir/dialogs_and_tooltips

High

Fix Released

Link a bug report

Reviewer	Review Type	Date Requested	Status
Alan Griffiths			Approve on 2015-01-22
PS Jenkins bot (community)	continuous-integration		Approve on 2015-01-22
Robert Carr (community)			Approve on 2015-01-20
Chris Halse Rogers		2015-01-15	Needs Fixing on 2015-01-16
Review via email: mp+246655@code.launchpad.net

Commit message

Add API to create dialog and tooltip surfaces.

Description of the change

Add API to create dialog and tooltip surfaces.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-15:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/2666/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-16:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/2667/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-16:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/2669/rebuild

review: Approve (continuous-integration)

Revision history for this message

Chris Halse Rogers (raof) wrote on 2015-01-16:

Firstly, spec questions:
*) Huh. Why do the docs allow the client to specify the location of a dialog‽ That's surely an error.
*) Relatedly, the spec is inconsistent on whether or not dialogs can have dialog children.

Again, we need to specify input behaviour of tooltips.

And maybe something about the input behaviour of modal dialogs, but that's less complicated.

I lean towards having two spec creation functions; _spec_for_dialog_surface and _spec_for_modal_dialog_surface, *particularly* if we really do need to allow client-specified positioning of modal dialogs. _spec_for_dialog_surface has half the parameters of _spec_for_modal_dialog_surface.

Relatedly, I wonder if we should drop the “_surface” from mir_connection_create_spec_for_*_surface? They're getting a bit long.

review: Needs Fixing

Revision history for this message

Alberto Aguirre (albaguirre) wrote on 2015-01-20:

> Firstly, spec questions:
> *) Huh. Why do the docs allow the client to specify the location of a dialog‽
> That's surely an error.
It actually mentions a client specifying an optional initial position for more than dialogs so yeah doesn't belong in this dialog API.

> *) Relatedly, the spec is inconsistent on whether or not dialogs can have
> dialog children.
I could only find one sentence where it's inconsistent. However there's a full paragraph with motivation for avoiding trees of dialogs

> Again, we need to specify input behaviour of tooltips.
>
> And maybe something about the input behaviour of modal dialogs, but that's
> less complicated.
>
I added a bit of info there.

> I lean towards having two spec creation functions; _spec_for_dialog_surface
> and _spec_for_modal_dialog_surface, *particularly* if we really do need to
> allow client-specified positioning of modal dialogs. _spec_for_dialog_surface
> has half the parameters of _spec_for_modal_dialog_surface.

I think it makes sense to split them, done.

> Relatedly, I wonder if we should drop the “_surface” from
> mir_connection_create_spec_for_*_surface? They're getting a bit long.

Dropped.

Revision history for this message

Robert Carr (robertcarr) wrote on 2015-01-20:

LGTM.

Had the strange thought that maybe create_spec_for_tooltip could take an event or input device ID rather than relative position and parent...

review: Approve

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-20:

FAILED: Continuous integration, rev:2235
http://jenkins.qa.ubuntu.com/job/mir-ci/2721/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/942
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/942
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/904
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/718/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/904
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/904/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/4006
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/17247

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/2721/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-20:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/2726/rebuild

review: Approve (continuous-integration)

Revision history for this message

Alan Griffiths (alan-griffiths) wrote on 2015-01-21:

Mostly OK but...

49 + * \param [in] rect A target zone relative to parent where the tooltip
50 + * will

...will what?

review: Needs Fixing

lp:~albaguirre/mir/dialogs_and_tooltips updated on 2015-01-21

2236. By Alberto Aguirre on 2015-01-21: merge lp:mir, fix conflicts
2237. By Alberto Aguirre on 2015-01-21: Fix doc
2238. By Alberto Aguirre on 2015-01-21: update sha1sum

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-21:

FAILED: Continuous integration, rev:2238
http://jenkins.qa.ubuntu.com/job/mir-ci/2753/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/983/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/982/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/944/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/750/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/944/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/2753/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-22:

FAILED: Continuous integration, rev:2238
http://jenkins.qa.ubuntu.com/job/mir-ci/2754/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/984/console
    None: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/983/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/945/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/751/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/945/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/2754/rebuild

review: Needs Fixing (continuous-integration)

lp:~albaguirre/mir/dialogs_and_tooltips updated on 2015-01-22

2239. By Alberto Aguirre on 2015-01-22: merge lp:mir, fix sha1sum conflict

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-22:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/2755/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-22:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/2759/rebuild

review: Approve (continuous-integration)

Revision history for this message

Alan Griffiths (alan-griffiths) wrote on 2015-01-22:

OK (and I think Chris's "Needs Fixing" is addressed too)

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Alberto Aguirre

Emanuele Antonio Faraone

Gerry Boland

Mir development team

 === modified file 'client-ABI-sha1sums'
 --- client-ABI-sha1sums	2015-01-21 22:27:07 +0000
 +++ client-ABI-sha1sums	2015-01-22 00:48:27 +0000
@@ -6,7 +6,7 @@
  d739af6e64db6b314a727b5fb00be662b98ccd57  include/client/mir_toolkit/mir_platform_message.h
 d50df5a141ca03ee8a79f7e844ed4b8b3b7d5d3  include/client/mir_toolkit/mir_prompt_session.h
 d07e655e85eeec8a3523e1c6f9c2252176ec01  include/client/mir_toolkit/mir_screencast.h
--84dc4ff6dcceb507153578fbaa8e0c1a74b1c570  include/client/mir_toolkit/mir_surface.h
++232664cab86958838946ab051e845be5fbd485ca  include/client/mir_toolkit/mir_surface.h
  b141c4d79802ad626d969249c0004744e5c2a525  include/client/mir_toolkit/mir_wait.h
 f7b4ecc22afba923806ed2bd7d8244be90b0cfd  include/client/mir_toolkit/version.h
 dac884d6006753de2a955bc7a05663cd9449  include/common/mir_toolkit/client_types.h
 === modified file 'include/client/mir_toolkit/mir_surface.h'
 --- include/client/mir_toolkit/mir_surface.h	2015-01-20 23:07:45 +0000
 +++ include/client/mir_toolkit/mir_surface.h	2015-01-22 00:48:27 +0000
@@ -76,13 +76,96 @@
   *                          to complete construction.
   */
  MirSurfaceSpec*
--mir_connection_create_spec_for_menu_surface(MirConnection* connection,
++mir_connection_create_spec_for_menu(MirConnection* connection,
++                                    int width,
++                                    int height,
++                                    MirPixelFormat format,
++                                    MirSurface* parent,
++                                    MirRectangle* rect,
++                                    MirEdgeAttachment edge);
++
++/**
++ * Create a surface specification for a tooltip surface.
++ *
++ * A tooltip surface becomes visible when the pointer hovers the specified
++ * target zone. A tooltip surface has no input focus and will be closed when
++ * the pointer moves out of the target zone or the parent closes, moves or hides
++ *
++ * The tooltip parent cannot be another tooltip surface.
++ *
++ * The tooltip position is decided by the server but typically it will appear
++ * near the pointer.
++ *
++ * \param [in] connection   Connection the surface will be created on
++ * \param [in] width        Requested width. The server is not guaranteed to
++ *                          return a surface of this width.
++ * \param [in] height       Requested height. The server is not guaranteed to
++ *                          return a surface of this height.
++ * \param [in] format       Pixel format for the surface.
++ * \param [in] parent       A valid parent surface for this tooltip.
++ * \param [in] rect         A target zone relative to parent.
++ * \return                  A handle that can be passed to mir_surface_create()
++ *                          to complete construction.
++ */
++MirSurfaceSpec*
++mir_connection_create_spec_for_tooltip(MirConnection* connection,
++                                       int width,
++                                       int height,
++                                       MirPixelFormat format,
++                                       MirSurface* parent,
++                                       MirRectangle* zone);
++
++/**
++ * Create a surface specification for a modal dialog surface.
++ *
++ * The dialog surface will have input focus; the parent can still be moved,
++ * resized or hidden/minimized but no interaction is possible until the dialog
++ * is dismissed.
++ *
++ * A dialog will typically have no close/maximize button decorations.
++ *
++ * During surface creation, if the specified parent is another dialog surface
++ * the server may choose to close the specified parent in order to show this
++ * new dialog surface.
++ *
++ * \param [in] connection   Connection the surface will be created on
++ * \param [in] width        Requested width. The server is not guaranteed to
++ *                          return a surface of this width.
++ * \param [in] height       Requested height. The server is not guaranteed to
++ *                          return a surface of this height.
++ * \param [in] format       Pixel format for the surface.
++ * \param [in] parent       A valid parent surface.
++ *
++ */
++MirSurfaceSpec*
++mir_connection_create_spec_for_modal_dialog(MirConnection* connection,
                                              int width,
                                              int height,
                                              MirPixelFormat format,
--                                            MirSurface* parent,
--                                            MirRectangle* rect,
--                                            MirEdgeAttachment edge);
++                                            MirSurface* parent);
++
++/**
++ * Create a surface specification for a parentless dialog surface.
++ *
++ * A parentless dialog surface is similar to a normal surface, but it cannot
++ * be fullscreen and typically won't have any maximize/close button decorations.
++ *
++ * A parentless dialog is not allowed to have other dialog children. The server
++ * may decide to close the parent and show the child dialog only.
++ *
++ * \param [in] connection   Connection the surface will be created on
++ * \param [in] width        Requested width. The server is not guaranteed to
++ *                          return a surface of this width.
++ * \param [in] height       Requested height. The server is not guaranteed to
++ *                          return a surface of this height.
++ * \param [in] format       Pixel format for the surface.
++ *
++ */
++MirSurfaceSpec*
++mir_connection_create_spec_for_dialog(MirConnection* connection,
++                                      int width,
++                                      int height,
++                                      MirPixelFormat format);
  /**
   * Create a surface from a given specification
 === modified file 'include/server/mir/scene/surface_creation_parameters.h'
 --- include/server/mir/scene/surface_creation_parameters.h	2015-01-21 15:47:25 +0000
 +++ include/server/mir/scene/surface_creation_parameters.h	2015-01-22 00:48:27 +0000
@@ -68,7 +68,7 @@
      SurfaceCreationParameters& with_parent_id(frontend::SurfaceId const& id);
--    SurfaceCreationParameters& with_attachment_rect(geometry::Rectangle const& rect);
++    SurfaceCreationParameters& with_aux_rect(geometry::Rectangle const& rect);
      SurfaceCreationParameters& with_edge_attachment(MirEdgeAttachment edge);
@@ -85,7 +85,7 @@
      mir::optional_value<MirSurfaceType> type;
      mir::optional_value<MirOrientationMode> preferred_orientation;
      mir::optional_value<frontend::SurfaceId> parent_id;
--    mir::optional_value<geometry::Rectangle> attachment_rect;
++    mir::optional_value<geometry::Rectangle> aux_rect;
      mir::optional_value<MirEdgeAttachment> edge_attachment;
      std::weak_ptr<Surface> parent;
 === modified file 'server-ABI-sha1sums'
 --- server-ABI-sha1sums	2015-01-21 15:47:25 +0000
 +++ server-ABI-sha1sums	2015-01-22 00:48:27 +0000
@@ -97,7 +97,7 @@
 bab4dc0a6488b8b9d47e958c6bab94f1dcf2c57  include/server/mir/scene/surface_buffer_access.h
  bbc9e2e2bb71634cd6f1c5c0430093e10e74fa23  include/server/mir/scene/surface_configurator.h
  e5e4dd7bcaf186810043fa0f05be42d7e49b0843  include/server/mir/scene/surface_coordinator.h
--308d886cae96072a87ec1119fc31a66031727893  include/server/mir/scene/surface_creation_parameters.h
++da52304237a348a90fcb56729293d628ceaa351c  include/server/mir/scene/surface_creation_parameters.h
  aceccc0bdeea5c90d6c5ea17ed4ce6b5dc1b0ed4  include/server/mir/scene/surface.h
 e22d751656ce2d9536afdf5659276ff9bbc46  include/server/mir/scene/surface_observer.h
 ef3e99901168cda296d74d05a979f47bf9c3ff1  include/server/mir/server_action_queue.h
 === modified file 'src/client/mir_surface.cpp'
 --- src/client/mir_surface.cpp	2015-01-19 04:52:47 +0000
 +++ src/client/mir_surface.cpp	2015-01-22 00:48:27 +0000
@@ -89,15 +89,14 @@
      SERIALIZE_OPTION_IF_SET(pref_orientation, message);
      if (parent.is_set() && parent.value() != nullptr)
          message.set_parent_id(parent.value()->id());
--    if (attachment_rect.is_set())
++    if (aux_rect.is_set())
+     {
--        message.mutable_attachment_rect()->set_left(attachment_rect.value().left);
--        message.mutable_attachment_rect()->set_top(attachment_rect.value().top);
--        message.mutable_attachment_rect()->set_width(attachment_rect.value().width);
--        message.mutable_attachment_rect()->set_height(attachment_rect.value().height);
++        message.mutable_aux_rect()->set_left(aux_rect.value().left);
++        message.mutable_aux_rect()->set_top(aux_rect.value().top);
++        message.mutable_aux_rect()->set_width(aux_rect.value().width);
++        message.mutable_aux_rect()->set_height(aux_rect.value().height);
+     }
      SERIALIZE_OPTION_IF_SET(edge_attachment, message);
--
      return message;
+ }
 === modified file 'src/client/mir_surface.h'
 --- src/client/mir_surface.h	2015-01-19 04:52:47 +0000
 +++ src/client/mir_surface.h	2015-01-22 00:48:27 +0000
@@ -78,7 +78,7 @@
      mir::optional_value<MirOrientationMode> pref_orientation;
      mir::optional_value<MirSurface*> parent;
--    mir::optional_value<MirRectangle> attachment_rect;
++    mir::optional_value<MirRectangle> aux_rect;
      mir::optional_value<MirEdgeAttachment> edge_attachment;
  };
 === modified file 'src/client/mir_surface_api.cpp'
 --- src/client/mir_surface_api.cpp	2015-01-20 23:07:45 +0000
 +++ src/client/mir_surface_api.cpp	2015-01-22 00:48:27 +0000
@@ -51,13 +51,13 @@
      return new MirSurfaceSpec{connection, width, height, format};
+ }
--MirSurfaceSpec* mir_connection_create_spec_for_menu_surface(MirConnection* connection,
--                                                            int width,
--                                                            int height,
--                                                            MirPixelFormat format,
--                                                            MirSurface* parent,
--                                                            MirRectangle* rect,
--                                                            MirEdgeAttachment edge)
++MirSurfaceSpec* mir_connection_create_spec_for_menu(MirConnection* connection,
++                                                    int width,
++                                                    int height,
++                                                    MirPixelFormat format,
++                                                    MirSurface* parent,
++                                                    MirRectangle* rect,
++                                                    MirEdgeAttachment edge)
+ {
      mir::require(mir_surface_is_valid(parent));
      mir::require(rect != nullptr);
@@ -65,11 +65,53 @@
      auto spec = new MirSurfaceSpec{connection, width, height, format};
      spec->type = mir_surface_type_menu;
      spec->parent = parent;
--    spec->attachment_rect = *rect;
++    spec->aux_rect = *rect;
      spec->edge_attachment = edge;
      return spec;
+ }
++MirSurfaceSpec* mir_connection_create_spec_for_tooltip(MirConnection* connection,
++                                                       int width,
++                                                       int height,
++                                                       MirPixelFormat format,
++                                                       MirSurface* parent,
++                                                       MirRectangle* rect)
++{
++    mir::require(mir_surface_is_valid(parent));
++    mir::require(rect != nullptr);
++
++    auto spec = new MirSurfaceSpec{connection, width, height, format};
++    spec->type = mir_surface_type_tip;
++    spec->parent = parent;
++    spec->aux_rect = *rect;
++    return spec;
++}
++
++MirSurfaceSpec* mir_connection_create_spec_for_dialog(MirConnection* connection,
++                                                      int width,
++                                                      int height,
++                                                      MirPixelFormat format)
++{
++    auto spec = new MirSurfaceSpec{connection, width, height, format};
++    spec->type = mir_surface_type_dialog;
++    return spec;
++}
++
++MirSurfaceSpec* mir_connection_create_spec_for_modal_dialog(MirConnection* connection,
++                                                           int width,
++                                                           int height,
++                                                           MirPixelFormat format,
++                                                           MirSurface* parent)
++{
++    mir::require(mir_surface_is_valid(parent));
++
++    auto spec = new MirSurfaceSpec{connection, width, height, format};
++    spec->type = mir_surface_type_dialog;
++    spec->parent = parent;
++
++    return spec;
++}
++
  MirSurface* mir_surface_create_sync(MirSurfaceSpec* requested_specification)
+ {
      MirSurface* surface = nullptr;
 === modified file 'src/client/symbols.map'
 --- src/client/symbols.map	2015-01-16 02:57:31 +0000
 +++ src/client/symbols.map	2015-01-22 00:48:27 +0000
@@ -42,5 +42,7 @@
      mir_pointer_input_event_get_action;
      mir_pointer_input_event_get_button_state;
      mir_pointer_input_event_get_axis_value;
--    mir_connection_create_spec_for_menu_surface;
++    mir_connection_create_spec_for_menu;
++    mir_connection_create_spec_for_tooltip;
++    mir_connection_create_spec_for_dialog;
  } MIR_CLIENT_8.2;
 \ No newline at end of file
 === modified file 'src/protobuf/mir_protobuf.proto'
 --- src/protobuf/mir_protobuf.proto	2015-01-14 06:39:13 +0000
 +++ src/protobuf/mir_protobuf.proto	2015-01-22 00:48:27 +0000
@@ -25,7 +25,7 @@
    optional int32 pref_orientation = 9;
    optional int32 parent_id = 10;
--  optional Rectangle attachment_rect = 11;
++  optional Rectangle aux_rect = 11;
    optional int32 edge_attachment = 12;
+ }
 === modified file 'src/server/frontend/session_mediator.cpp'
 --- src/server/frontend/session_mediator.cpp	2015-01-19 11:36:40 +0000
 +++ src/server/frontend/session_mediator.cpp	2015-01-22 00:48:27 +0000
@@ -198,11 +198,11 @@
      if (request->has_parent_id())
          params.with_parent_id(SurfaceId{request->parent_id()});
--    if (request->has_attachment_rect())
++    if (request->has_aux_rect())
+     {
--        params.with_attachment_rect(geom::Rectangle{
--            {request->attachment_rect().left(), request->attachment_rect().top()},
--            {request->attachment_rect().width(), request->attachment_rect().height()}
++        params.with_aux_rect(geom::Rectangle{
++            {request->aux_rect().left(), request->aux_rect().top()},
++            {request->aux_rect().width(), request->aux_rect().height()}
          });
+     }
 === modified file 'src/server/scene/surface_creation_parameters.cpp'
 --- src/server/scene/surface_creation_parameters.cpp	2015-01-14 06:39:13 +0000
 +++ src/server/scene/surface_creation_parameters.cpp	2015-01-22 00:48:27 +0000
@@ -124,9 +124,9 @@
      return *this;
+ }
--ms::SurfaceCreationParameters& ms::SurfaceCreationParameters::with_attachment_rect(geometry::Rectangle const& rect)
++ms::SurfaceCreationParameters& ms::SurfaceCreationParameters::with_aux_rect(geometry::Rectangle const& rect)
+ {
--    attachment_rect = rect;
++    aux_rect = rect;
      return *this;
+ }
 === modified file 'tests/acceptance-tests/test_client_surfaces.cpp'
 --- tests/acceptance-tests/test_client_surfaces.cpp	2015-01-14 06:39:13 +0000
 +++ tests/acceptance-tests/test_client_surfaces.cpp	2015-01-22 00:48:27 +0000
@@ -217,7 +217,7 @@
      auto parent = mtf::make_any_surface(connection);
      MirRectangle attachment_rect{100, 200, 100, 100};
--    auto spec = mir_connection_create_spec_for_menu_surface(connection, 640, 480,
++    auto spec = mir_connection_create_spec_for_menu(connection, 640, 480,
          mir_pixel_format_abgr_8888, parent, &attachment_rect, mir_edge_attachment_vertical);
      ASSERT_THAT(spec, NotNull());
@@ -231,3 +231,54 @@
      mir_surface_release_sync(menu);
+ }
++TEST_F(ClientSurfaces, can_be_tooltips)
++{
++    auto parent = mtf::make_any_surface(connection);
++    MirRectangle zone_rect{100, 200, 100, 100};
++
++    auto spec = mir_connection_create_spec_for_tooltip(connection, 640, 480,
++        mir_pixel_format_abgr_8888, parent, &zone_rect);
++    ASSERT_THAT(spec, NotNull());
++
++    auto tooltip = mir_surface_create_sync(spec);
++    mir_surface_spec_release(spec);
++
++    ASSERT_THAT(tooltip, IsValid());
++    EXPECT_EQ(mir_surface_get_type(tooltip), mir_surface_type_tip);
++
++    mir_surface_release_sync(parent);
++    mir_surface_release_sync(tooltip);
++}
++
++TEST_F(ClientSurfaces, can_be_dialogs)
++{
++    auto spec = mir_connection_create_spec_for_dialog(connection, 640, 480,
++        mir_pixel_format_abgr_8888);
++    ASSERT_THAT(spec, NotNull());
++
++    auto dialog = mir_surface_create_sync(spec);
++    mir_surface_spec_release(spec);
++
++    ASSERT_THAT(dialog, IsValid());
++    EXPECT_EQ(mir_surface_get_type(dialog), mir_surface_type_dialog);
++
++    mir_surface_release_sync(dialog);
++}
++
++TEST_F(ClientSurfaces, can_be_modal_dialogs)
++{
++    auto parent = mtf::make_any_surface(connection);
++    auto spec = mir_connection_create_spec_for_modal_dialog(connection, 640, 480,
++        mir_pixel_format_abgr_8888, parent);
++    ASSERT_THAT(spec, NotNull());
++
++    auto dialog = mir_surface_create_sync(spec);
++    mir_surface_spec_release(spec);
++
++    ASSERT_THAT(dialog, IsValid());
++    EXPECT_EQ(mir_surface_get_type(dialog), mir_surface_type_dialog);
++
++    mir_surface_release_sync(parent);
++    mir_surface_release_sync(dialog);
++}
++
 === modified file 'tests/integration-tests/client/test_mirsurface.cpp'
 --- tests/integration-tests/client/test_mirsurface.cpp	2015-01-14 06:39:13 +0000
 +++ tests/integration-tests/client/test_mirsurface.cpp	2015-01-22 00:48:27 +0000
@@ -79,18 +79,33 @@
      return arg.type == mir_surface_type_menu;
+ }
++MATCHER(IsATooltip, "")
++{
++    return arg.type == mir_surface_type_tip;
++}
++
++MATCHER(IsADialog, "")
++{
++    return arg.type == mir_surface_type_dialog;
++}
++
  MATCHER_P(HasParent, parent, "")
+ {
      return arg.parent_id.is_set() && arg.parent_id.value().as_value() == parent->id();
+ }
--MATCHER_P(MatchesAttachment, rect, "")
--{
--    return arg.attachment_rect.is_set() &&
--           arg.attachment_rect.value().top_left.x.as_int() == rect.left &&
--           arg.attachment_rect.value().top_left.y.as_int() == rect.top &&
--           arg.attachment_rect.value().size.width.as_uint32_t() == rect.width &&
--           arg.attachment_rect.value().size.height.as_uint32_t() == rect.height;
++MATCHER(NoParentSet, "")
++{
++    return arg.parent_id.is_set() == false;
++}
++
++MATCHER_P(MatchesAuxRect, rect, "")
++{
++    return arg.aux_rect.is_set() &&
++           arg.aux_rect.value().top_left.x.as_int() == rect.left &&
++           arg.aux_rect.value().top_left.y.as_int() == rect.top &&
++           arg.aux_rect.value().size.width.as_uint32_t() == rect.width &&
++           arg.aux_rect.value().size.height.as_uint32_t() == rect.height;
+ }
  MATCHER_P(MatchesEdge, edge, "")
@@ -170,7 +185,7 @@
      auto spec_deleter = [](MirSurfaceSpec* spec) {mir_surface_spec_release(spec);};
      std::unique_ptr<MirSurfaceSpec, decltype(spec_deleter)> menu_spec{
--        mir_connection_create_spec_for_menu_surface(connection, 640, 480,
++        mir_connection_create_spec_for_menu(connection, 640, 480,
              mir_pixel_format_abgr_8888, parent.get(), &attachment_rect,
              edge),
          spec_deleter
@@ -179,6 +194,63 @@
      ASSERT_THAT(menu_spec, NotNull());
      EXPECT_CALL(*mock_surface_coordinator, add_surface(AllOf(IsAMenu(),
--        HasParent(parent.get()), MatchesAttachment(attachment_rect), MatchesEdge(edge)),_));
++        HasParent(parent.get()), MatchesAuxRect(attachment_rect), MatchesEdge(edge)),_));
      create_surface(menu_spec.get());
+ }
++
++TEST_F(ClientMirSurface, as_tooltip_sends_correct_params)
++{
++    EXPECT_CALL(*mock_surface_coordinator, add_surface(_,_));
++    auto parent = create_surface(&spec);
++    ASSERT_THAT(parent.get(), IsValid());
++
++    MirRectangle target_zone_rect{100, 200, 300, 400};
++
++    auto spec_deleter = [](MirSurfaceSpec* spec) {mir_surface_spec_release(spec);};
++    std::unique_ptr<MirSurfaceSpec, decltype(spec_deleter)> tooltip_spec{
++        mir_connection_create_spec_for_tooltip(connection, 640, 480,
++            mir_pixel_format_abgr_8888, parent.get(), &target_zone_rect),
++        spec_deleter
++    };
++
++    ASSERT_THAT(tooltip_spec, NotNull());
++
++    EXPECT_CALL(*mock_surface_coordinator, add_surface(AllOf(IsATooltip(),
++        HasParent(parent.get()), MatchesAuxRect(target_zone_rect)),_));
++    create_surface(tooltip_spec.get());
++}
++
++TEST_F(ClientMirSurface, as_dialog_sends_correct_params)
++{
++    auto spec_deleter = [](MirSurfaceSpec* spec) {mir_surface_spec_release(spec);};
++    std::unique_ptr<MirSurfaceSpec, decltype(spec_deleter)> dialog_spec{
++        mir_connection_create_spec_for_dialog(connection, 640, 480, mir_pixel_format_abgr_8888),
++        spec_deleter
++    };
++
++    ASSERT_THAT(dialog_spec, NotNull());
++
++    EXPECT_CALL(*mock_surface_coordinator, add_surface(AllOf(IsADialog(),
++        NoParentSet()),_));
++    create_surface(dialog_spec.get());
++}
++
++TEST_F(ClientMirSurface, as_modal_dialog_sends_correct_params)
++{
++    EXPECT_CALL(*mock_surface_coordinator, add_surface(_,_));
++    auto parent = create_surface(&spec);
++    ASSERT_THAT(parent.get(), IsValid());
++
++    auto spec_deleter = [](MirSurfaceSpec* spec) {mir_surface_spec_release(spec);};
++    std::unique_ptr<MirSurfaceSpec, decltype(spec_deleter)> dialog_spec{
++        mir_connection_create_spec_for_modal_dialog(connection, 640, 480,
++            mir_pixel_format_abgr_8888, parent.get()),
++        spec_deleter
++    };
++
++    ASSERT_THAT(dialog_spec, NotNull());
++
++    EXPECT_CALL(*mock_surface_coordinator, add_surface(AllOf(IsADialog(),
++        HasParent(parent.get())),_));
++    create_surface(dialog_spec.get());
++}