data-device: Implement DnD progress notification

Weston now sends wl_data_source.dnd_drop_performed and .dnd_finished in
order to notify about the different phases of DnD.

wl_data_source.cancelled is also used as mentioned in the docs, being
emitted also on DnD when the operation is meant to fail (eg. source
and dest didn't agree on a mimetype).

The dnd demo is also fixed so the struct dnd_drag isn't leaked.

https://bugs.freedesktop.org/show_bug.cgi?id=91943
https://bugs.freedesktop.org/show_bug.cgi?id=91944

Changes since v6:
  - Add client-side version checks. Minor code shuffling.

Changes since v5:
  - Dissociate source and offer after cancel. Updated to
    apply on top of c9f8f8a7f.

Changes since v4:
  - Make wl_data_offer.finish with the wrong state an error.

Changes since v3:
  - Fixed wl_data_source.dnd_finished vs cancelled emission on
    when interoperating with version < 3 drag destinations.

Changes since v2:
  - Handle wl_data_offer.finish. Fixed commit log inconsistencies.
    Added version checks. Spaces vs tabs fixes. Fixed resource
    versioning.

Changes since v1:
  - Updated to protocol v2.

Signed-off-by: Carlos Garnacho <carlosg@gnome.org>
Reviewed-by: Michael Catanzaro <mcatanzaro@igalia.com>
Reviewed-by: Jonas Ådahl <jadahl@gmail.com>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>

diff --git a/clients/dnd.c b/clients/dnd.c
index e6a0c39..974429b 100644 (file)
--- a/clients/dnd.c
+++ b/clients/dnd.c
@@ -318,14 +318,8 @@ data_source_send(void *data, struct wl_data_source *source,
 }
 
 static void
-data_source_cancelled(void *data, struct wl_data_source *source)
+dnd_drag_destroy(struct dnd_drag *dnd_drag)
 {
-       struct dnd_drag *dnd_drag = data;
-
-       /* The 'cancelled' event means that the source is no longer in
-        * use by the drag (or current selection).  We need to clean
-        * up the drag object created and the local state. */
-
        wl_data_source_destroy(dnd_drag->data_source);
 
        /* Destroy the item that has been dragged out */
@@ -339,10 +333,39 @@ data_source_cancelled(void *data, struct wl_data_source *source)
        free(dnd_drag);
 }
 
+static void
+data_source_cancelled(void *data, struct wl_data_source *source)
+{
+       struct dnd_drag *dnd_drag = data;
+
+       /* The 'cancelled' event means that the source is no longer in
+        * use by the drag (or current selection).  We need to clean
+        * up the drag object created and the local state. */
+       dnd_drag_destroy(dnd_drag);
+}
+
+static void
+data_source_dnd_drop_performed(void *data, struct wl_data_source *source)
+{
+}
+
+static void
+data_source_dnd_finished(void *data, struct wl_data_source *source)
+{
+       struct dnd_drag *dnd_drag = data;
+
+       /* The operation is already finished, we can destroy all
+        * related data.
+        */
+       dnd_drag_destroy(dnd_drag);
+}
+
 static const struct wl_data_source_listener data_source_listener = {
        data_source_target,
        data_source_send,
-       data_source_cancelled
+       data_source_cancelled,
+       data_source_dnd_drop_performed,
+       data_source_dnd_finished,
 };
 
 static cairo_surface_t *

diff --git a/clients/window.c b/clients/window.c
index 7d45acd..1b3cbb1 100644 (file)
--- a/clients/window.c
+++ b/clients/window.c
@@ -3812,6 +3812,7 @@ offer_io_func(struct task *task, uint32_t events)
 {
        struct data_offer *offer =
                container_of(task, struct data_offer, io_task);
+       struct display *display = offer->input->display;
        unsigned int len;
        char buffer[4096];
 
@@ -3820,6 +3821,9 @@ offer_io_func(struct task *task, uint32_t events)
                    offer->x, offer->y, offer->user_data);
 
        if (len == 0) {
+               if (display->data_device_manager_version >=
+                   WL_DATA_OFFER_FINISH_SINCE_VERSION)
+                       wl_data_offer_finish(offer->offer);
                close(offer->fd);
                data_offer_destroy(offer);
        }
@@ -5413,7 +5417,7 @@ registry_handle_global(void *data, struct wl_registry *registry, uint32_t id,
                d->shm = wl_registry_bind(registry, id, &wl_shm_interface, 1);
                wl_shm_add_listener(d->shm, &shm_listener, d);
        } else if (strcmp(interface, "wl_data_device_manager") == 0) {
-               d->data_device_manager_version = MIN(version, 2);
+               d->data_device_manager_version = MIN(version, 3);
                d->data_device_manager =
                        wl_registry_bind(registry, id,
                                         &wl_data_device_manager_interface,

diff --git a/src/compositor.h b/src/compositor.h
index 5970e57..bc5f7b8 100644 (file)
--- a/src/compositor.h
+++ b/src/compositor.h
@@ -327,6 +327,9 @@ struct weston_data_source {
        struct wl_resource *resource;
        struct wl_signal destroy_signal;
        struct wl_array mime_types;
+       struct weston_data_offer *offer;
+       struct weston_seat *seat;
+       bool accepted;
 
        void (*accept)(struct weston_data_source *source,
                       uint32_t serial, const char *mime_type);

diff --git a/src/data-device.c b/src/data-device.c
index 545a895..d12b16c 100644 (file)
--- a/src/data-device.c
+++ b/src/data-device.c
@@ -62,12 +62,16 @@ data_offer_accept(struct wl_client *client, struct wl_resource *resource,
 {
        struct weston_data_offer *offer = wl_resource_get_user_data(resource);
 
+       /* Protect against untimely calls from older data offers */
+       if (!offer->source || offer != offer->source->offer)
+               return;
+
        /* FIXME: Check that client is currently focused by the input
         * device that is currently dragging this data source.  Should
         * this be a wl_data_device request? */
 
-       if (offer->source)
-               offer->source->accept(offer->source, serial, mime_type);
+       offer->source->accept(offer->source, serial, mime_type);
+       offer->source->accepted = mime_type != NULL;
 }
 
 static void
@@ -76,7 +80,7 @@ data_offer_receive(struct wl_client *client, struct wl_resource *resource,
 {
        struct weston_data_offer *offer = wl_resource_get_user_data(resource);
 
-       if (offer->source)
+       if (offer->source && offer == offer->source->offer)
                offer->source->send(offer->source, mime_type, fd);
        else
                close(fd);
@@ -88,10 +92,44 @@ data_offer_destroy(struct wl_client *client, struct wl_resource *resource)
        wl_resource_destroy(resource);
 }
 
+static void
+data_source_notify_finish(struct weston_data_source *source)
+{
+       if (wl_resource_get_version(source->resource) >=
+           WL_DATA_SOURCE_DND_FINISHED_SINCE_VERSION) {
+               wl_data_source_send_dnd_finished(source->resource);
+       }
+
+       source->offer = NULL;
+}
+
+static void
+data_offer_finish(struct wl_client *client, struct wl_resource *resource)
+{
+       struct weston_data_offer *offer = wl_resource_get_user_data(resource);
+
+       if (!offer->source || offer->source->offer != offer)
+               return;
+
+       /* Disallow finish while we have a grab driving drag-and-drop, or
+        * if the negotiation is not at the right stage
+        */
+       if (offer->source->seat ||
+           !offer->source->accepted) {
+               wl_resource_post_error(offer->resource,
+                                      WL_DATA_OFFER_ERROR_INVALID_FINISH,
+                                      "premature finish request");
+               return;
+       }
+
+       data_source_notify_finish(offer->source);
+}
+
 static const struct wl_data_offer_interface data_offer_interface = {
        data_offer_accept,
        data_offer_receive,
        data_offer_destroy,
+       data_offer_finish,
 };
 
 static void
@@ -99,8 +137,28 @@ destroy_data_offer(struct wl_resource *resource)
 {
        struct weston_data_offer *offer = wl_resource_get_user_data(resource);
 
-       if (offer->source)
-               wl_list_remove(&offer->source_destroy_listener.link);
+       if (!offer->source)
+               goto out;
+
+       wl_list_remove(&offer->source_destroy_listener.link);
+
+       if (offer->source->offer != offer)
+               goto out;
+
+       /* If the drag destination has version < 3, wl_data_offer.finish
+        * won't be called, so do this here as a safety net, because
+        * we still want the version >=3 drag source to be happy.
+        */
+       if (wl_resource_get_version(offer->resource) <
+           WL_DATA_OFFER_ACTION_SINCE_VERSION) {
+               data_source_notify_finish(offer->source);
+       } else if (wl_resource_get_version(offer->source->resource) >=
+                  WL_DATA_SOURCE_DND_FINISHED_SINCE_VERSION) {
+               wl_data_source_send_cancelled(offer->source->resource);
+       }
+
+       offer->source->offer = NULL;
+out:
        free(offer);
 }
 
@@ -128,7 +186,8 @@ weston_data_source_send_offer(struct weston_data_source *source,
 
        offer->resource =
                wl_resource_create(wl_resource_get_client(target),
-                                  &wl_data_offer_interface, 1, 0);
+                                  &wl_data_offer_interface,
+                                  wl_resource_get_version(target), 0);
        if (offer->resource == NULL) {
                free(offer);
                return NULL;
@@ -147,6 +206,9 @@ weston_data_source_send_offer(struct weston_data_source *source,
        wl_array_for_each(p, &source->mime_types)
                wl_data_offer_send_offer(offer->resource, *p);
 
+       source->offer = offer;
+       source->accepted = false;
+
        return offer->resource;
 }
 
@@ -270,8 +332,9 @@ weston_drag_set_focus(struct weston_drag *drag,
                        struct weston_view *view,
                        wl_fixed_t sx, wl_fixed_t sy)
 {
-       struct wl_resource *resource, *offer = NULL;
+       struct wl_resource *resource, *offer_resource = NULL;
        struct wl_display *display = seat->compositor->wl_display;
+       struct weston_data_offer *offer;
        uint32_t serial;
 
        if (drag->focus && view && drag->focus->surface == view->surface) {
@@ -293,6 +356,15 @@ weston_drag_set_focus(struct weston_drag *drag,
            wl_resource_get_client(view->surface->resource) != drag->client)
                return;
 
+       if (drag->data_source &&
+           drag->data_source->offer) {
+               /* Unlink the offer from the source */
+               offer = drag->data_source->offer;
+               offer->source = NULL;
+               drag->data_source->offer = NULL;
+               wl_list_remove(&offer->source_destroy_listener.link);
+       }
+
        resource = wl_resource_find_for_client(&seat->drag_resource_list,
                                               wl_resource_get_client(view->surface->resource));
        if (!resource)
@@ -301,14 +373,15 @@ weston_drag_set_focus(struct weston_drag *drag,
        serial = wl_display_next_serial(display);
 
        if (drag->data_source) {
-               offer = weston_data_source_send_offer(drag->data_source,
-                                                     resource);
-               if (offer == NULL)
+               drag->data_source->accepted = false;
+               offer_resource = weston_data_source_send_offer(drag->data_source,
+                                                              resource);
+               if (offer_resource == NULL)
                        return;
        }
 
        wl_data_device_send_enter(resource, serial, view->surface->resource,
-                                 sx, sy, offer);
+                                 sx, sy, offer_resource);
 
        drag->focus = view;
        drag->focus_listener.notify = destroy_drag_focus;
@@ -396,11 +469,25 @@ drag_grab_button(struct weston_pointer_grab *grab,
                container_of(grab, struct weston_pointer_drag, grab);
        struct weston_pointer *pointer = drag->grab.pointer;
        enum wl_pointer_button_state state = state_w;
+       struct weston_data_source *data_source = drag->base.data_source;
 
-       if (drag->base.focus_resource &&
+       if (data_source &&
            pointer->grab_button == button &&
-           state == WL_POINTER_BUTTON_STATE_RELEASED)
-               wl_data_device_send_drop(drag->base.focus_resource);
+           state == WL_POINTER_BUTTON_STATE_RELEASED) {
+               if (drag->base.focus_resource &&
+                   data_source->accepted) {
+                       wl_data_device_send_drop(drag->base.focus_resource);
+
+                       if (wl_resource_get_version(data_source->resource) >=
+                           WL_DATA_SOURCE_DND_DROP_PERFORMED_SINCE_VERSION)
+                               wl_data_source_send_dnd_drop_performed(data_source->resource);
+
+                       data_source->seat = NULL;
+               } else if (wl_resource_get_version(data_source->resource) >=
+                          WL_DATA_SOURCE_DND_FINISHED_SINCE_VERSION) {
+                       wl_data_source_send_cancelled(data_source->resource);
+               }
+       }
 
        if (pointer->button_count == 0 &&
            state == WL_POINTER_BUTTON_STATE_RELEASED) {
@@ -724,6 +811,8 @@ data_device_start_drag(struct wl_client *client, struct wl_resource *resource,
 
        if (ret < 0)
                wl_resource_post_no_memory(resource);
+       else
+               source->seat = seat;
 }
 
 static void
@@ -894,7 +983,8 @@ create_data_source(struct wl_client *client,
        }
 
        source->resource =
-               wl_resource_create(client, &wl_data_source_interface, 1, id);
+               wl_resource_create(client, &wl_data_source_interface,
+                                  wl_resource_get_version(resource), id);
        if (source->resource == NULL) {
                free(source);
                wl_resource_post_no_memory(resource);
@@ -905,6 +995,9 @@ create_data_source(struct wl_client *client,
        source->accept = client_source_accept;
        source->send = client_source_send;
        source->cancel = client_source_cancel;
+       source->offer = NULL;
+       source->accepted = false;
+       source->seat = NULL;
 
        wl_array_init(&source->mime_types);
 
@@ -983,7 +1076,7 @@ WL_EXPORT int
 wl_data_device_manager_init(struct wl_display *display)
 {
        if (wl_global_create(display,
-                            &wl_data_device_manager_interface, 2,
+                            &wl_data_device_manager_interface, 3,
                             NULL, bind_manager) == NULL)
                return -1;