From 99d879c8878f774aac66e39d7bf4b92f3ae7f0ed Mon Sep 17 00:00:00 2001 From: emersion Date: Fri, 7 Dec 2018 15:50:51 +0100 Subject: data-control-v1: initial protocol implementation --- protocol/wlr-data-control-unstable-v1.xml | 220 ++++++++++++++++++++++++++++++ 1 file changed, 220 insertions(+) create mode 100644 protocol/wlr-data-control-unstable-v1.xml (limited to 'protocol/wlr-data-control-unstable-v1.xml') diff --git a/protocol/wlr-data-control-unstable-v1.xml b/protocol/wlr-data-control-unstable-v1.xml new file mode 100644 index 00000000..c8d50d53 --- /dev/null +++ b/protocol/wlr-data-control-unstable-v1.xml @@ -0,0 +1,220 @@ + + + + Copyright © 2018 Simon Ser + + Permission to use, copy, modify, distribute, and sell this + software and its documentation for any purpose is hereby granted + without fee, provided that the above copyright notice appear in + all copies and that both that copyright notice and this permission + notice appear in supporting documentation, and that the name of + the copyright holders not be used in advertising or publicity + pertaining to distribution of the software without specific, + written prior permission. The copyright holders make no + representations about the suitability of this software for any + purpose. It is provided "as is" without express or implied + warranty. + + THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS + SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND + FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY + SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN + AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, + ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF + THIS SOFTWARE. + + + + This protocol allows a privileged client to control data devices. In + particular, the client will be able to manage the current selection and take + the role of a clipboard manager. + + Warning! The protocol described in this file is experimental and + backward incompatible changes may be made. Backward compatible changes + may be added together with the corresponding interface version bump. + Backward incompatible changes are done by bumping the version number in + the protocol and interface names and resetting the interface version. + Once the protocol is to be declared stable, the 'z' prefix and the + version number in the protocol and interface names are removed and the + interface version number is reset. + + + + + This interface is a manager that allows creating per-seat data controls. + + + + + Create a new data source. + + + + + + + Create a data control that can be used to manage a seat's data device. + + + + + + + + All objects created by the manager will still remain valid, until their + appropriate destroy request has been called. + + + + + + + This interface allows a client to manage a data device associated with a + seat. + + When the seat is destroyed, this object becomes inert. + + + + + All objects created by the manager will still remain valid, until their + appropriate destroy request has been called. + + + + + + + Destroys the data control object. + + + + + + The data_offer event introduces a new wlr_data_control_offer object, + which will subsequently be used in the wlr_data_control.selection event. + Immediately following the wlr_data_control.data_offer event, the new + data_offer object will send out wlr_data_control_offer.offer events to + describe the MIME types it offers. + + This event replaces the previous data offer, which should be destroyed + by the client. + + + + + + + The selection event is sent out to notify the client of a new + wlr_data_control_offer for the selection for this device. The + wlr_data_control.data_offer and the wlr_data_control_offer.offer events + are sent out immediately before this event to introduce the data offer + object. The selection event is sent to a client when a new selection is + set. The wlr_data_control_offer is valid until a new + wlr_data_control_offer or NULL is received. The client must destroy the + previous selection wlr_data_control_offer, if any, upon receiving this + event. + + + + + + + This data control object is no longer valid and should be destroyed by + the client. + + + + + + + The wlr_data_control_source object is the source side of a + wlr_data_control_offer. It is created by the source client in a data + transfer and provides a way to describe the offered data and a way to + respond to requests to transfer the data. + + + + + + + + + This request adds a MIME type to the set of MIME types advertised to + targets. Can be called several times to offer multiple types. + + Calling this after wlr_data_control.set_selection is a protocol error. + + + + + + + Destroys the data source object. + + + + + + Request for data from the client. Send the data as the specified MIME + type over the passed file descriptor, then close it. + + + + + + + + This data source is no longer valid. The data source has been replaced + by another data source. + + The client should clean up and destroy this data source. + + + + + + + A wlr_data_control_offer represents a piece of data offered for transfer + by another client (the source client). The offer describes the different + MIME types that the data can be converted to and provides the mechanism + for transferring the data directly from the source client. + + + + + To transfer the offered data, the client issues this request and + indicates the MIME type it wants to receive. The transfer happens + through the passed file descriptor (typically created with the pipe + system call). The source client writes the data in the MIME type + representation requested and then closes the file descriptor. + + The receiving client reads from the read end of the pipe until EOF and + then closes its end, at which point the transfer is complete. + + This request may happen multiple times for different MIME types. + + + + + + + + Destroys the data offer object. + + + + + + Sent immediately after creating the wlr_data_control_offer object. + One event per offered MIME type. + + + + + -- cgit v1.2.3 From 4423630687397e714183e7e0f690613175fd6df8 Mon Sep 17 00:00:00 2001 From: emersion Date: Wed, 12 Dec 2018 10:01:27 +0100 Subject: data-control-v1: update protocol to allow NULL selections --- protocol/wlr-data-control-unstable-v1.xml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'protocol/wlr-data-control-unstable-v1.xml') diff --git a/protocol/wlr-data-control-unstable-v1.xml b/protocol/wlr-data-control-unstable-v1.xml index c8d50d53..bd105f2e 100644 --- a/protocol/wlr-data-control-unstable-v1.xml +++ b/protocol/wlr-data-control-unstable-v1.xml @@ -82,7 +82,8 @@ All objects created by the manager will still remain valid, until their appropriate destroy request has been called. - + @@ -117,7 +118,8 @@ previous selection wlr_data_control_offer, if any, upon receiving this event. - + -- cgit v1.2.3 From 69e7fd61b7824ce683137b44beff02899d6ce78b Mon Sep 17 00:00:00 2001 From: emersion Date: Sun, 30 Dec 2018 02:52:03 +0100 Subject: data-control-v1: update to latest protocol proposal --- include/wlr/types/wlr_data_control_v1.h | 11 ++- protocol/wlr-data-control-unstable-v1.xml | 46 ++++----- types/wlr_data_control_v1.c | 150 +++++++++++++++--------------- 3 files changed, 105 insertions(+), 102 deletions(-) (limited to 'protocol/wlr-data-control-unstable-v1.xml') diff --git a/include/wlr/types/wlr_data_control_v1.h b/include/wlr/types/wlr_data_control_v1.h index 69d7281b..50c96736 100644 --- a/include/wlr/types/wlr_data_control_v1.h +++ b/include/wlr/types/wlr_data_control_v1.h @@ -15,20 +15,20 @@ struct wlr_data_control_manager_v1 { struct wl_global *global; struct wl_list resources; // wl_resource_get_link - struct wl_list controls; // wlr_data_control_v1::link + struct wl_list devices; // wlr_data_control_device_v1::link struct { struct wl_signal destroy; - struct wl_signal new_control; // wlr_data_control_v1 + struct wl_signal new_device; // wlr_data_control_device_v1 } events; struct wl_listener display_destroy; }; -struct wlr_data_control_v1 { +struct wlr_data_control_device_v1 { struct wl_resource *resource; struct wlr_data_control_manager_v1 *manager; - struct wl_list link; // wlr_data_control_manager_v1::controls + struct wl_list link; // wlr_data_control_manager_v1::devices struct wlr_seat *seat; struct wl_resource *selection_offer_resource; // current selection offer @@ -42,6 +42,7 @@ struct wlr_data_control_manager_v1 *wlr_data_control_manager_v1_create( void wlr_data_control_manager_v1_destroy( struct wlr_data_control_manager_v1 *manager); -void wlr_data_control_v1_destroy(struct wlr_data_control_v1 *control); +void wlr_data_control_device_v1_destroy( + struct wlr_data_control_device_v1 *device); #endif diff --git a/protocol/wlr-data-control-unstable-v1.xml b/protocol/wlr-data-control-unstable-v1.xml index bd105f2e..a5887550 100644 --- a/protocol/wlr-data-control-unstable-v1.xml +++ b/protocol/wlr-data-control-unstable-v1.xml @@ -41,8 +41,9 @@ - - This interface is a manager that allows creating per-seat data controls. + + This interface is a manager that allows creating per-seat data device + controls. @@ -53,11 +54,11 @@ summary="data source to create"/> - - - Create a data control that can be used to manage a seat's data device. + + + Create a data device that can be used to manage a seat's selection. - + @@ -69,17 +70,16 @@ - + - This interface allows a client to manage a data device associated with a - seat. + This interface allows a client to manage a seat's selection. When the seat is destroyed, this object becomes inert. - All objects created by the manager will still remain valid, until their + All objects created by the device will still remain valid, until their appropriate destroy request has been called. - - Destroys the data control object. + + Destroys the data device object. The data_offer event introduces a new wlr_data_control_offer object, - which will subsequently be used in the wlr_data_control.selection event. - Immediately following the wlr_data_control.data_offer event, the new - data_offer object will send out wlr_data_control_offer.offer events to - describe the MIME types it offers. + which will subsequently be used in the wlr_data_control_device.selection + event. Immediately following the wlr_data_control_device.data_offer + event, the new data_offer object will send out + wlr_data_control_offer.offer events to describe the MIME types it + offers. This event replaces the previous data offer, which should be destroyed by the client. @@ -110,10 +111,10 @@ The selection event is sent out to notify the client of a new wlr_data_control_offer for the selection for this device. The - wlr_data_control.data_offer and the wlr_data_control_offer.offer events - are sent out immediately before this event to introduce the data offer - object. The selection event is sent to a client when a new selection is - set. The wlr_data_control_offer is valid until a new + wlr_data_control_device.data_offer and the wlr_data_control_offer.offer + events are sent out immediately before this event to introduce the data + offer object. The selection event is sent to a client when a new + selection is set. The wlr_data_control_offer is valid until a new wlr_data_control_offer or NULL is received. The client must destroy the previous selection wlr_data_control_offer, if any, upon receiving this event. @@ -140,7 +141,7 @@ + summary="offer sent after wlr_data_control_device.set_selection"/> @@ -148,7 +149,8 @@ This request adds a MIME type to the set of MIME types advertised to targets. Can be called several times to offer multiple types. - Calling this after wlr_data_control.set_selection is a protocol error. + Calling this after wlr_data_control_device.set_selection is a protocol + error. diff --git a/types/wlr_data_control_v1.c b/types/wlr_data_control_v1.c index be8bfbe8..9812220c 100644 --- a/types/wlr_data_control_v1.c +++ b/types/wlr_data_control_v1.c @@ -107,7 +107,7 @@ static void source_handle_resource_destroy(struct wl_resource *resource) { static const struct zwlr_data_control_offer_v1_interface offer_impl; -static struct wlr_data_control_v1 *control_from_offer_resource( +static struct wlr_data_control_device_v1 *control_from_offer_resource( struct wl_resource *resource) { assert(wl_resource_instance_of(resource, &zwlr_data_control_offer_v1_interface, &offer_impl)); @@ -116,12 +116,12 @@ static struct wlr_data_control_v1 *control_from_offer_resource( static void offer_handle_receive(struct wl_client *client, struct wl_resource *resource, const char *mime_type, int fd) { - struct wlr_data_control_v1 *control = control_from_offer_resource(resource); - if (control == NULL || control->seat->selection_source == NULL) { + struct wlr_data_control_device_v1 *device = control_from_offer_resource(resource); + if (device == NULL || device->seat->selection_source == NULL) { close(fd); return; } - wlr_data_source_send(control->seat->selection_source, mime_type, fd); + wlr_data_source_send(device->seat->selection_source, mime_type, fd); } static void offer_handle_destroy(struct wl_client *client, @@ -135,25 +135,25 @@ static const struct zwlr_data_control_offer_v1_interface offer_impl = { }; static void offer_handle_resource_destroy(struct wl_resource *resource) { - struct wlr_data_control_v1 *control = control_from_offer_resource(resource); - if (control != NULL) { - control->selection_offer_resource = NULL; + struct wlr_data_control_device_v1 *device = control_from_offer_resource(resource); + if (device != NULL) { + device->selection_offer_resource = NULL; } } -static struct wl_resource *create_offer(struct wlr_data_control_v1 *control, +static struct wl_resource *create_offer(struct wlr_data_control_device_v1 *device, struct wlr_data_source *source) { - struct wl_client *client = wl_resource_get_client(control->resource); - uint32_t version = wl_resource_get_version(control->resource); + struct wl_client *client = wl_resource_get_client(device->resource); + uint32_t version = wl_resource_get_version(device->resource); struct wl_resource *resource = wl_resource_create(client, &zwlr_data_control_offer_v1_interface, version, 0); if (resource == NULL) { return NULL; } - wl_resource_set_implementation(resource, &offer_impl, control, + wl_resource_set_implementation(resource, &offer_impl, device, offer_handle_resource_destroy); - zwlr_data_control_v1_send_data_offer(control->resource, resource); + zwlr_data_control_device_v1_send_data_offer(device->resource, resource); char **p; wl_array_for_each(p, &source->mime_types) { @@ -164,28 +164,28 @@ static struct wl_resource *create_offer(struct wlr_data_control_v1 *control, } -static const struct zwlr_data_control_v1_interface control_impl; +static const struct zwlr_data_control_device_v1_interface control_impl; -static struct wlr_data_control_v1 *control_from_resource( +static struct wlr_data_control_device_v1 *control_from_resource( struct wl_resource *resource) { assert(wl_resource_instance_of(resource, - &zwlr_data_control_v1_interface, &control_impl)); + &zwlr_data_control_device_v1_interface, &control_impl)); return wl_resource_get_user_data(resource); } static void control_handle_set_selection(struct wl_client *client, struct wl_resource *control_resource, struct wl_resource *source_resource) { - struct wlr_data_control_v1 *control = + struct wlr_data_control_device_v1 *device = control_from_resource(control_resource); struct client_data_source *source = source_from_resource(source_resource); - if (control == NULL) { + if (device == NULL) { return; } struct wlr_data_source *wlr_source = source ? &source->source : NULL; struct wl_display *display = wl_client_get_display(client); - wlr_seat_set_selection(control->seat, wlr_source, + wlr_seat_set_selection(device->seat, wlr_source, wl_display_next_serial(display)); } @@ -194,65 +194,65 @@ static void control_handle_destroy(struct wl_client *client, wl_resource_destroy(control_resource); } -static const struct zwlr_data_control_v1_interface control_impl = { +static const struct zwlr_data_control_device_v1_interface control_impl = { .set_selection = control_handle_set_selection, .destroy = control_handle_destroy, }; -static void control_send_selection(struct wlr_data_control_v1 *control) { - struct wlr_data_source *source = control->seat->selection_source; +static void control_send_selection(struct wlr_data_control_device_v1 *device) { + struct wlr_data_source *source = device->seat->selection_source; - if (control->selection_offer_resource != NULL) { + if (device->selection_offer_resource != NULL) { // Make the offer inert - wl_resource_set_user_data(control->selection_offer_resource, NULL); + wl_resource_set_user_data(device->selection_offer_resource, NULL); } - control->selection_offer_resource = NULL; + device->selection_offer_resource = NULL; if (source != NULL) { - control->selection_offer_resource = create_offer(control, source); - if (control->selection_offer_resource == NULL) { - wl_resource_post_no_memory(control->resource); + device->selection_offer_resource = create_offer(device, source); + if (device->selection_offer_resource == NULL) { + wl_resource_post_no_memory(device->resource); return; } } - zwlr_data_control_v1_send_selection(control->resource, - control->selection_offer_resource); + zwlr_data_control_device_v1_send_selection(device->resource, + device->selection_offer_resource); } static void control_handle_resource_destroy(struct wl_resource *resource) { - struct wlr_data_control_v1 *control = control_from_resource(resource); - wlr_data_control_v1_destroy(control); + struct wlr_data_control_device_v1 *device = control_from_resource(resource); + wlr_data_control_device_v1_destroy(device); } static void control_handle_seat_destroy(struct wl_listener *listener, void *data) { - struct wlr_data_control_v1 *control = - wl_container_of(listener, control, seat_destroy); - wlr_data_control_v1_destroy(control); + struct wlr_data_control_device_v1 *device = + wl_container_of(listener, device, seat_destroy); + wlr_data_control_device_v1_destroy(device); } static void control_handle_seat_selection(struct wl_listener *listener, void *data) { - struct wlr_data_control_v1 *control = - wl_container_of(listener, control, seat_selection); - control_send_selection(control); + struct wlr_data_control_device_v1 *device = + wl_container_of(listener, device, seat_selection); + control_send_selection(device); } -void wlr_data_control_v1_destroy(struct wlr_data_control_v1 *control) { - if (control == NULL) { +void wlr_data_control_device_v1_destroy(struct wlr_data_control_device_v1 *device) { + if (device == NULL) { return; } - zwlr_data_control_v1_send_finished(control->resource); + zwlr_data_control_device_v1_send_finished(device->resource); // Make the resources inert - wl_resource_set_user_data(control->resource, NULL); - if (control->selection_offer_resource != NULL) { - wl_resource_set_user_data(control->selection_offer_resource, NULL); + wl_resource_set_user_data(device->resource, NULL); + if (device->selection_offer_resource != NULL) { + wl_resource_set_user_data(device->selection_offer_resource, NULL); } - wl_list_remove(&control->seat_destroy.link); - wl_list_remove(&control->seat_selection.link); - wl_list_remove(&control->link); - free(control); + wl_list_remove(&device->seat_destroy.link); + wl_list_remove(&device->seat_selection.link); + wl_list_remove(&device->link); + free(device); } @@ -287,7 +287,7 @@ static void manager_handle_create_data_source(struct wl_client *client, source_handle_resource_destroy); } -static void manager_handle_get_data_control(struct wl_client *client, +static void manager_handle_get_data_device(struct wl_client *client, struct wl_resource *manager_resource, uint32_t id, struct wl_resource *seat_resource) { struct wlr_data_control_manager_v1 *manager = @@ -295,41 +295,41 @@ static void manager_handle_get_data_control(struct wl_client *client, struct wlr_seat_client *seat_client = wlr_seat_client_from_resource(seat_resource); - struct wlr_data_control_v1 *control = - calloc(1, sizeof(struct wlr_data_control_v1)); - if (control == NULL) { + struct wlr_data_control_device_v1 *device = + calloc(1, sizeof(struct wlr_data_control_device_v1)); + if (device == NULL) { wl_resource_post_no_memory(manager_resource); return; } - control->manager = manager; - control->seat = seat_client->seat; + device->manager = manager; + device->seat = seat_client->seat; uint32_t version = wl_resource_get_version(manager_resource); - control->resource = wl_resource_create(client, - &zwlr_data_control_v1_interface, version, id); - if (control->resource == NULL) { + device->resource = wl_resource_create(client, + &zwlr_data_control_device_v1_interface, version, id); + if (device->resource == NULL) { wl_resource_post_no_memory(manager_resource); - free(control); + free(device); return; } - wl_resource_set_implementation(control->resource, &control_impl, control, + wl_resource_set_implementation(device->resource, &control_impl, device, control_handle_resource_destroy); - struct wl_resource *resource = control->resource; + struct wl_resource *resource = device->resource; - control->seat_destroy.notify = control_handle_seat_destroy; - wl_signal_add(&control->seat->events.destroy, &control->seat_destroy); + device->seat_destroy.notify = control_handle_seat_destroy; + wl_signal_add(&device->seat->events.destroy, &device->seat_destroy); - control->seat_selection.notify = control_handle_seat_selection; - wl_signal_add(&control->seat->events.selection, &control->seat_selection); + device->seat_selection.notify = control_handle_seat_selection; + wl_signal_add(&device->seat->events.selection, &device->seat_selection); - wl_list_insert(&manager->controls, &control->link); - wlr_signal_emit_safe(&manager->events.new_control, control); + wl_list_insert(&manager->devices, &device->link); + wlr_signal_emit_safe(&manager->events.new_device, device); - // At this point maybe the compositor decided to destroy the control. If + // At this point maybe the compositor decided to destroy the device. If // it's the case then the resource will be inert. - control = control_from_resource(resource); - if (control != NULL) { - control_send_selection(control); + device = control_from_resource(resource); + if (device != NULL) { + control_send_selection(device); } } @@ -340,7 +340,7 @@ static void manager_handle_destroy(struct wl_client *client, static const struct zwlr_data_control_manager_v1_interface manager_impl = { .create_data_source = manager_handle_create_data_source, - .get_data_control = manager_handle_get_data_control, + .get_data_device = manager_handle_get_data_device, .destroy = manager_handle_destroy, }; @@ -378,9 +378,9 @@ struct wlr_data_control_manager_v1 *wlr_data_control_manager_v1_create( return NULL; } wl_list_init(&manager->resources); - wl_list_init(&manager->controls); + wl_list_init(&manager->devices); wl_signal_init(&manager->events.destroy); - wl_signal_init(&manager->events.new_control); + wl_signal_init(&manager->events.new_device); manager->global = wl_global_create(display, &zwlr_data_control_manager_v1_interface, DATA_CONTROL_MANAGER_VERSION, @@ -404,9 +404,9 @@ void wlr_data_control_manager_v1_destroy( wlr_signal_emit_safe(&manager->events.destroy, manager); - struct wlr_data_control_v1 *control, *control_tmp; - wl_list_for_each_safe(control, control_tmp, &manager->controls, link) { - wl_resource_destroy(control->resource); + struct wlr_data_control_device_v1 *device, *control_tmp; + wl_list_for_each_safe(device, control_tmp, &manager->devices, link) { + wl_resource_destroy(device->resource); } struct wl_resource *resource, *resource_tmp; -- cgit v1.2.3