Merge pull request #760 from emersion/xwayland-dnd

xwayland: add drag'n'drop support

4 files changed, 210 insertions, 37 deletions

diff --git a/include/wlr/types/wlr_data_device.h b/include/wlr/types/wlr_data_device.h
index ff4a0f7e..6fb41c29 100644
--- a/include/wlr/types/wlr_data_device.h
+++ b/include/wlr/types/wlr_data_device.h
@@ -30,23 +30,29 @@ struct wlr_data_offer {
 	struct wl_listener source_destroy;
 };
 
-struct wlr_data_source {
-	// source metadata
-	struct wl_array mime_types;
-	int32_t actions;
-
-	// source implementation
+/**
+ * A data source implementation. Only the `send` function is mandatory. Refer to
+ * the matching wl_data_source_* functions documentation to know what they do.
+ */
+struct wlr_data_source_impl {
 	void (*send)(struct wlr_data_source *source, const char *mime_type,
 		int32_t fd);
 	void (*accept)(struct wlr_data_source *source, uint32_t serial,
 		const char *mime_type);
 	void (*cancel)(struct wlr_data_source *source);
 
-	// drag'n'drop implementation
 	void (*dnd_drop)(struct wlr_data_source *source);
 	void (*dnd_finish)(struct wlr_data_source *source);
 	void (*dnd_action)(struct wlr_data_source *source,
 		enum wl_data_device_manager_dnd_action action);
+};
+
+struct wlr_data_source {
+	const struct wlr_data_source_impl *impl;
+
+	// source metadata
+	struct wl_array mime_types;
+	int32_t actions;
 
 	// source status
 	bool accepted;
@@ -104,13 +110,31 @@ struct wlr_drag {
 	struct wl_listener source_destroy;
 	struct wl_listener seat_client_destroy;
 	struct wl_listener icon_destroy;
+
+	struct {
+		struct wl_signal focus;
+		struct wl_signal motion;
+		struct wl_signal drop;
+		struct wl_signal destroy;
+	} events;
+};
+
+struct wlr_drag_motion_event {
+	struct wlr_drag *drag;
+	uint32_t time;
+	double sx, sy;
+};
+
+struct wlr_drag_drop_event {
+	struct wlr_drag *drag;
+	uint32_t time;
 };
 
 /**
  * Create a wl data device manager global for this display.
  */
 struct wlr_data_device_manager *wlr_data_device_manager_create(
-		struct wl_display *display);
+	struct wl_display *display);
 
 /**
  * Destroys a wlr_data_device_manager and removes its wl_data_device_manager global.
@@ -126,11 +150,67 @@ void wlr_data_device_manager_destroy(struct wlr_data_device_manager *manager);
  */
 void wlr_seat_client_send_selection(struct wlr_seat_client *seat_client);
 
+/**
+ * Sets the current selection for the seat. This removes the previous one if
+ * there was any.
+ */
 void wlr_seat_set_selection(struct wlr_seat *seat,
-		struct wlr_data_source *source, uint32_t serial);
+	struct wlr_data_source *source, uint32_t serial);
 
-void wlr_data_source_init(struct wlr_data_source *source);
+/**
+ * Initializes the data source with the provided implementation.
+ */
+void wlr_data_source_init(struct wlr_data_source *source,
+	const struct wlr_data_source_impl *impl);
 
+/**
+ * Finishes the data source.
+ */
 void wlr_data_source_finish(struct wlr_data_source *source);
 
+/**
+ * Sends the data as the specified MIME type over the passed file descriptor,
+ * then close it.
+ */
+void wlr_data_source_send(struct wlr_data_source *source, const char *mime_type,
+	int32_t fd);
+
+/**
+ * Notifies the data source that a target accepts one of the offered MIME types.
+ * If a target doesn't accept any of the offered types, `mime_type` is NULL.
+ */
+void wlr_data_source_accept(struct wlr_data_source *source, uint32_t serial,
+	const char *mime_type);
+
+/**
+ * Notifies the data source it is no longer valid and should be destroyed. That
+ * potentially destroys immediately the data source.
+ */
+void wlr_data_source_cancel(struct wlr_data_source *source);
+
+/**
+ * Notifies the data source that the drop operation was performed. This does not
+ * indicate acceptance.
+ *
+ * The data source may still be used in the future and should not be destroyed
+ * here.
+ */
+void wlr_data_source_dnd_drop(struct wlr_data_source *source);
+
+/**
+ * Notifies the data source that the drag-and-drop operation concluded. That
+ * potentially destroys immediately the data source.
+ */
+void wlr_data_source_dnd_finish(struct wlr_data_source *source);
+
+/**
+ * Notifies the data source that a target accepts the drag with the specified
+ * action.
+ *
+ * This shouldn't be called after `wlr_data_source_dnd_drop` unless the
+ * drag-and-drop operation ended in an "ask" action.
+ */
+void wlr_data_source_dnd_action(struct wlr_data_source *source,
+	enum wl_data_device_manager_dnd_action action);
+
 #endif
diff --git a/include/wlr/types/wlr_seat.h b/include/wlr/types/wlr_seat.h
index 4c7e34b9..ff907f97 100644
--- a/include/wlr/types/wlr_seat.h
+++ b/include/wlr/types/wlr_seat.h
@@ -181,19 +181,25 @@ struct wlr_seat {
 	uint32_t capabilities;
 	struct timespec last_event;
 
-	struct wlr_data_source *selection_data_source;
+	struct wlr_data_source *selection_source;
 	uint32_t selection_serial;
 
 	struct wlr_primary_selection_source *primary_selection_source;
 	uint32_t primary_selection_serial;
 
+	// `drag` goes away before `drag_source`, when the implicit grab ends
+	struct wlr_drag *drag;
+	struct wlr_data_source *drag_source;
+	uint32_t drag_serial;
+
 	struct wlr_seat_pointer_state pointer_state;
 	struct wlr_seat_keyboard_state keyboard_state;
 	struct wlr_seat_touch_state touch_state;
 
 	struct wl_listener display_destroy;
-	struct wl_listener selection_data_source_destroy;
+	struct wl_listener selection_source_destroy;
 	struct wl_listener primary_selection_source_destroy;
+	struct wl_listener drag_source_destroy;
 
 	struct {
 		struct wl_signal pointer_grab_begin;
@@ -210,6 +216,7 @@ struct wlr_seat {
 		struct wl_signal selection;
 		struct wl_signal primary_selection;
 
+		struct wl_signal start_drag;
 		struct wl_signal new_drag_icon;
 
 		struct wl_signal destroy;
diff --git a/include/xwayland/selection.h b/include/xwayland/selection.h
new file mode 100644
index 00000000..bb3a894d
--- /dev/null
+++ b/include/xwayland/selection.h
@@ -0,0 +1,72 @@
+#ifndef XWAYLAND_SELECTION_H
+#define XWAYLAND_SELECTION_H
+
+#include <xcb/xfixes.h>
+
+#define INCR_CHUNK_SIZE (64 * 1024)
+
+#define XDND_VERSION 5
+
+struct wlr_xwm_selection;
+
+struct wlr_xwm_selection_transfer {
+	struct wlr_xwm_selection *selection;
+
+	bool incr;
+	bool flush_property_on_delete;
+	bool property_set;
+	struct wl_array source_data;
+	int source_fd;
+	struct wl_event_source *source;
+
+	// when sending to x11
+	xcb_selection_request_event_t request;
+	struct wl_list outgoing_link;
+
+	// when receiving from x11
+	int property_start;
+	xcb_get_property_reply_t *property_reply;
+};
+
+struct wlr_xwm_selection {
+	struct wlr_xwm *xwm;
+	xcb_atom_t atom;
+	xcb_window_t window;
+	xcb_window_t owner;
+	xcb_timestamp_t timestamp;
+
+	struct wlr_xwm_selection_transfer incoming;
+	struct wl_list outgoing;
+};
+
+void xwm_selection_transfer_remove_source(
+	struct wlr_xwm_selection_transfer *transfer);
+void xwm_selection_transfer_close_source_fd(
+	struct wlr_xwm_selection_transfer *transfer);
+void xwm_selection_transfer_destroy_property_reply(
+	struct wlr_xwm_selection_transfer *transfer);
+
+xcb_atom_t xwm_mime_type_to_atom(struct wlr_xwm *xwm, char *mime_type);
+char *xwm_mime_type_from_atom(struct wlr_xwm *xwm, xcb_atom_t atom);
+struct wlr_xwm_selection *xwm_get_selection(struct wlr_xwm *xwm,
+	xcb_atom_t selection_atom);
+
+void xwm_send_incr_chunk(struct wlr_xwm_selection_transfer *transfer);
+void xwm_handle_selection_request(struct wlr_xwm *xwm,
+	xcb_selection_request_event_t *req);
+
+void xwm_get_incr_chunk(struct wlr_xwm_selection_transfer *transfer);
+void xwm_handle_selection_notify(struct wlr_xwm *xwm,
+	xcb_selection_notify_event_t *event);
+int xwm_handle_xfixes_selection_notify(struct wlr_xwm *xwm,
+	xcb_xfixes_selection_notify_event_t *event);
+bool wlr_data_source_is_xwayland_data_source(struct wlr_data_source *wlr_source);
+bool wlr_primary_selection_source_is_xwayland_primary_selection_source(
+	struct wlr_primary_selection_source *wlr_source);
+
+void xwm_seat_handle_start_drag(struct wlr_xwm *xwm, struct wlr_drag *drag);
+
+void xwm_selection_init(struct wlr_xwm *xwm);
+void xwm_selection_finish(struct wlr_xwm *xwm);
+
+#endif
diff --git a/include/xwayland/xwm.h b/include/xwayland/xwm.h
index 9e21ea3a..662d00af 100644
--- a/include/xwayland/xwm.h
+++ b/include/xwayland/xwm.h
@@ -5,13 +5,18 @@
 #include <wlr/config.h>
 #include <wlr/xwayland.h>
 #include <xcb/render.h>
-
 #ifdef WLR_HAS_XCB_ICCCM
-	#include <xcb/xcb_icccm.h>
+#include <xcb/xcb_icccm.h>
 #endif
 #ifdef WLR_HAS_XCB_ERRORS
-	#include <xcb/xcb_errors.h>
+#include <xcb/xcb_errors.h>
 #endif
+#include "xwayland/selection.h"
+
+/* This is in xcb/xcb_event.h, but pulling xcb-util just for a constant
+ * others redefine anyway is meh
+ */
+#define XCB_EVENT_RESPONSE_TYPE_MASK (0x7f)
 
 enum atom_name {
 	WL_SURFACE_ID,
@@ -47,12 +52,27 @@ enum atom_name {
 	INCR,
 	TEXT,
 	TIMESTAMP,
+	DELETE,
 	NET_WM_WINDOW_TYPE_UTILITY,
 	NET_WM_WINDOW_TYPE_TOOLTIP,
 	NET_WM_WINDOW_TYPE_DND,
 	NET_WM_WINDOW_TYPE_DROPDOWN_MENU,
 	NET_WM_WINDOW_TYPE_POPUP_MENU,
 	NET_WM_WINDOW_TYPE_COMBO,
+	DND_SELECTION,
+	DND_AWARE,
+	DND_STATUS,
+	DND_POSITION,
+	DND_ENTER,
+	DND_LEAVE,
+	DND_DROP,
+	DND_FINISHED,
+	DND_PROXY,
+	DND_TYPE_LIST,
+	DND_ACTION_MOVE,
+	DND_ACTION_COPY,
+	DND_ACTION_ASK,
+	DND_ACTION_PRIVATE,
 	ATOM_LAST,
 };
 
@@ -64,24 +84,6 @@ enum net_wm_state_action {
 	NET_WM_STATE_TOGGLE = 2,
 };
 
-struct wlr_xwm_selection {
-	struct wlr_xwm *xwm;
-	xcb_atom_t atom;
-	xcb_window_t window;
-	xcb_selection_request_event_t request;
-	xcb_window_t owner;
-	xcb_timestamp_t timestamp;
-	int incr;
-	int source_fd;
-	int property_start;
-	xcb_get_property_reply_t *property_reply;
-	struct wl_event_source *property_source;
-	int flush_property_on_delete;
-	struct wl_array source_data;
-	xcb_atom_t target;
-	bool property_set;
-};
-
 struct wlr_xwm {
 	struct wlr_xwayland *xwayland;
 	struct wl_event_source *event_source;
@@ -100,11 +102,17 @@ struct wlr_xwm {
 	struct wlr_xwm_selection clipboard_selection;
 	struct wlr_xwm_selection primary_selection;
 
+	xcb_window_t dnd_window;
+	struct wlr_xwm_selection dnd_selection;
+
 	struct wlr_xwayland_surface *focus_surface;
 
 	struct wl_list surfaces; // wlr_xwayland_surface::link
 	struct wl_list unpaired_surfaces; // wlr_xwayland_surface::unpaired_link
 
+	struct wlr_drag *drag;
+	struct wlr_xwayland_surface *drag_focus;
+
 	const xcb_query_extension_reply_t *xfixes;
 #ifdef WLR_HAS_XCB_ERRORS
 	xcb_errors_context_t *errors_context;
@@ -114,6 +122,12 @@ struct wlr_xwm {
 	struct wl_listener compositor_destroy;
 	struct wl_listener seat_selection;
 	struct wl_listener seat_primary_selection;
+	struct wl_listener seat_start_drag;
+	struct wl_listener seat_drag_focus;
+	struct wl_listener seat_drag_motion;
+	struct wl_listener seat_drag_drop;
+	struct wl_listener seat_drag_destroy;
+	struct wl_listener seat_drag_source_destroy;
 };
 
 struct wlr_xwm *xwm_create(struct wlr_xwayland *wlr_xwayland);
@@ -124,13 +138,13 @@ void xwm_set_cursor(struct wlr_xwm *xwm, const uint8_t *pixels, uint32_t stride,
 	uint32_t width, uint32_t height, int32_t hotspot_x, int32_t hotspot_y);
 
 int xwm_handle_selection_event(struct wlr_xwm *xwm, xcb_generic_event_t *event);
-
-void xwm_selection_init(struct wlr_xwm *xwm);
-void xwm_selection_finish(struct wlr_xwm *xwm);
+int xwm_handle_selection_client_message(struct wlr_xwm *xwm,
+	xcb_client_message_event_t *ev);
 
 void xwm_set_seat(struct wlr_xwm *xwm, struct wlr_seat *seat);
 
+char *xwm_get_atom_name(struct wlr_xwm *xwm, xcb_atom_t atom);
 bool xwm_atoms_contains(struct wlr_xwm *xwm, xcb_atom_t *atoms,
-		size_t num_atoms, enum atom_name needle);
+	size_t num_atoms, enum atom_name needle);
 
 #endif