Merge pull request #418 from acrisci/feature/wlr-seat-touch

wlr-seat: touch

4 files changed, 190 insertions, 5 deletions

diff --git a/include/wlr/types/wlr_cursor.h b/include/wlr/types/wlr_cursor.h
index 0db32eb2..c73a4c8d 100644
--- a/include/wlr/types/wlr_cursor.h
+++ b/include/wlr/types/wlr_cursor.h
@@ -126,4 +126,11 @@ void wlr_cursor_map_to_region(struct wlr_cursor *cur, struct wlr_box *box);
 void wlr_cursor_map_input_to_region(struct wlr_cursor *cur,
 	struct wlr_input_device *dev, struct wlr_box *box);
 
+/**
+ * Convert absolute coordinates to layout coordinates for the device.
+ */
+bool wlr_cursor_absolute_to_layout_coords(struct wlr_cursor *cur,
+		struct wlr_input_device *device, double x_mm, double y_mm,
+		double width_mm, double height_mm, double *lx, double *ly);
+
 #endif
diff --git a/include/wlr/types/wlr_data_device.h b/include/wlr/types/wlr_data_device.h
index f45c15a2..189ab59b 100644
--- a/include/wlr/types/wlr_data_device.h
+++ b/include/wlr/types/wlr_data_device.h
@@ -10,6 +10,9 @@ wlr_pointer_grab_interface wlr_data_device_pointer_drag_interface;
 extern const struct
 wlr_keyboard_grab_interface wlr_data_device_keyboard_drag_interface;
 
+extern const struct
+wlr_touch_grab_interface wlr_data_device_touch_drag_interface;
+
 struct wlr_data_device_manager {
 	struct wl_global *global;
 };
@@ -53,16 +56,22 @@ struct wlr_data_source {
 struct wlr_drag {
 	struct wlr_seat_pointer_grab pointer_grab;
 	struct wlr_seat_keyboard_grab keyboard_grab;
+	struct wlr_seat_touch_grab touch_grab;
 
+	struct wlr_seat *seat;
 	struct wlr_seat_client *seat_client;
 	struct wlr_seat_client *focus_client;
 
+	bool is_pointer_grab;
+
 	struct wlr_surface *icon;
 	struct wlr_surface *focus;
 	struct wlr_data_source *source;
 
 	bool cancelling;
+	int32_t grab_touch_id;
 
+	struct wl_listener point_destroy;
 	struct wl_listener icon_destroy;
 	struct wl_listener source_destroy;
 	struct wl_listener seat_client_unbound;
diff --git a/include/wlr/types/wlr_seat.h b/include/wlr/types/wlr_seat.h
index a5f00402..dbd03401 100644
--- a/include/wlr/types/wlr_seat.h
+++ b/include/wlr/types/wlr_seat.h
@@ -24,6 +24,26 @@ struct wlr_seat_client {
 	struct wl_list link;
 };
 
+struct wlr_touch_point {
+	int32_t touch_id;
+	struct wlr_surface *surface;
+	struct wlr_seat_client *client;
+
+	struct wlr_surface *focus_surface;
+	struct wlr_seat_client *focus_client;
+	double sx, sy;
+
+	struct wl_listener surface_destroy;
+	struct wl_listener focus_surface_destroy;
+	struct wl_listener resource_destroy;
+
+	struct {
+		struct wl_signal destroy;
+	} events;
+
+	struct wl_list link;
+};
+
 struct wlr_seat_pointer_grab;
 
 struct wlr_pointer_grab_interface {
@@ -49,6 +69,32 @@ struct wlr_keyboard_grab_interface {
 	void (*cancel)(struct wlr_seat_keyboard_grab *grab);
 };
 
+struct wlr_seat_touch_grab;
+
+struct wlr_touch_grab_interface {
+	uint32_t (*down)(struct wlr_seat_touch_grab *grab, uint32_t time,
+			struct wlr_touch_point *point);
+	void (*up)(struct wlr_seat_touch_grab *grab, uint32_t time,
+			struct wlr_touch_point *point);
+	void (*motion)(struct wlr_seat_touch_grab *grab, uint32_t time,
+			struct wlr_touch_point *point);
+	void (*enter)(struct wlr_seat_touch_grab *grab, uint32_t time,
+			struct wlr_touch_point *point);
+	// XXX this will conflict with the actual touch cancel which is different so
+	// we need to rename this
+	void (*cancel)(struct wlr_seat_touch_grab *grab);
+};
+
+/**
+ * Passed to `wlr_seat_touch_start_grab()` to start a grab of the touch device.
+ * The grabber is responsible for handling touch events for the seat.
+ */
+struct wlr_seat_touch_grab {
+	const struct wlr_touch_grab_interface *interface;
+	struct wlr_seat *seat;
+	void *data;
+};
+
 /**
  * Passed to `wlr_seat_keyboard_start_grab()` to start a grab of the keyboard.
  * The grabber is responsible for handling keyboard events for the seat.
@@ -86,6 +132,7 @@ struct wlr_seat_pointer_state {
 	struct wl_listener resource_destroy;
 };
 
+// TODO: May be useful to be able to simulate keyboard input events
 struct wlr_seat_keyboard_state {
 	struct wlr_seat *seat;
 	struct wlr_keyboard *keyboard;
@@ -103,6 +150,17 @@ struct wlr_seat_keyboard_state {
 	struct wlr_seat_keyboard_grab *default_grab;
 };
 
+struct wlr_seat_touch_state {
+	struct wlr_seat *seat;
+	struct wl_list touch_points; // wlr_touch_point::link
+
+	uint32_t grab_serial;
+	uint32_t grab_id;
+
+	struct wlr_seat_touch_grab *grab;
+	struct wlr_seat_touch_grab *default_grab;
+};
+
 struct wlr_seat {
 	struct wl_global *wl_global;
 	struct wl_display *display;
@@ -117,6 +175,7 @@ struct wlr_seat {
 
 	struct wlr_seat_pointer_state pointer_state;
 	struct wlr_seat_keyboard_state keyboard_state;
+	struct wlr_seat_touch_state touch_state;
 
 	struct wl_listener selection_data_source_destroy;
 
@@ -130,6 +189,9 @@ struct wlr_seat {
 		struct wl_signal keyboard_grab_begin;
 		struct wl_signal keyboard_grab_end;
 
+		struct wl_signal touch_grab_begin;
+		struct wl_signal touch_grab_end;
+
 		struct wl_signal request_set_cursor;
 
 		struct wl_signal selection;
@@ -260,6 +322,11 @@ void wlr_seat_pointer_notify_axis(struct wlr_seat *wlr_seat, uint32_t time,
 		enum wlr_axis_orientation orientation, double value);
 
 /**
+ * Whether or not the pointer has a grab other than the default grab.
+ */
+bool wlr_seat_pointer_has_grab(struct wlr_seat *seat);
+
+/**
  * Set this keyboard as the active keyboard for the seat.
  */
 void wlr_seat_set_keyboard(struct wlr_seat *seat, struct wlr_input_device *dev);
@@ -326,6 +393,108 @@ void wlr_seat_keyboard_enter(struct wlr_seat *wlr_seat,
  */
 void wlr_seat_keyboard_clear_focus(struct wlr_seat *wlr_seat);
 
-// TODO: May be useful to be able to simulate keyboard input events
+/**
+ * Whether or not the keyboard has a grab other than the default grab
+ */
+bool wlr_seat_keyboard_has_grab(struct wlr_seat *seat);
+
+/**
+ * Start a grab of the touch device of this seat. The grabber is responsible for
+ * handling all touch events until the grab ends.
+ */
+void wlr_seat_touch_start_grab(struct wlr_seat *wlr_seat,
+		struct wlr_seat_touch_grab *grab);
+
+/**
+ * End the grab of the touch device of this seat. This reverts the grab back to
+ * the default grab for the touch device.
+ */
+void wlr_seat_touch_end_grab(struct wlr_seat *wlr_seat);
+
+/**
+ * Get the active touch point with the given `touch_id`. If the touch point does
+ * not exist or is no longer active, returns NULL.
+ */
+struct wlr_touch_point *wlr_seat_touch_get_point(struct wlr_seat *seat,
+		int32_t touch_id);
+
+/**
+ * Notify the seat of a touch down on the given surface. Defers to any grab of
+ * the touch device.
+ */
+uint32_t wlr_seat_touch_notify_down(struct wlr_seat *seat,
+		struct wlr_surface *surface, uint32_t time, int32_t touch_id, double sx,
+		double sy);
+
+/**
+ * Notify the seat that the touch point given by `touch_id` is up. Defers to any
+ * grab of the touch device.
+ */
+void wlr_seat_touch_notify_up(struct wlr_seat *seat, uint32_t time,
+		int32_t touch_id);
+
+/**
+ * Notify the seat that the touch point given by `touch_id` has moved. Defers to
+ * any grab of the touch device. The seat should be notified of touch motion
+ * even if the surface is not the owner of the touch point for processing by
+ * grabs.
+ */
+void wlr_seat_touch_notify_motion(struct wlr_seat *seat, uint32_t time,
+		int32_t touch_id, double sx, double sy);
+
+/**
+ * Notify the seat that the touch point given by `touch_id` has entered a new
+ * surface. The surface is required. To clear focus, use
+ * `wlr_seat_touch_point_clear_focus()`.
+ */
+void wlr_seat_touch_point_focus(struct wlr_seat *seat,
+		struct wlr_surface *surface, uint32_t time, int32_t touch_id, double sx,
+		double sy);
+
+/**
+ * Clear the focused surface for the touch point given by `touch_id`.
+ */
+void wlr_seat_touch_point_clear_focus(struct wlr_seat *seat, uint32_t time,
+		int32_t touch_id);
+
+/**
+ * Send a touch down event to the client of the given surface. All future touch
+ * events for this point will go to this surface. If the touch down is valid,
+ * this will add a new touch point with the given `touch_id`. The touch down may
+ * not be valid if the surface seat client does not accept touch input.
+ * Coordinates are surface-local. Compositors should use
+ * `wlr_seat_touch_notify_down()` to respect any grabs of the touch device.
+ */
+uint32_t wlr_seat_touch_send_down(struct wlr_seat *seat,
+		struct wlr_surface *surface, uint32_t time, int32_t touch_id, double sx,
+		double sy);
+
+/**
+ * Send a touch up event for the touch point given by the `touch_id`. The event
+ * will go to the client for the surface given in the cooresponding touch down
+ * event. This will remove the touch point. Compositors should use
+ * `wlr_seat_touch_notify_up()` to respect any grabs of the touch device.
+ */
+void wlr_seat_touch_send_up(struct wlr_seat *seat, uint32_t time,
+		int32_t touch_id);
+
+/**
+ * Send a touch motion event for the touch point given by the `touch_id`. The
+ * event will go to the client for the surface given in the corresponding touch
+ * down event. Compositors should use `wlr_seat_touch_notify_motion()` to
+ * respect any grabs of the touch device.
+ */
+void wlr_seat_touch_send_motion(struct wlr_seat *seat, uint32_t time,
+		int32_t touch_id, double sx, double sy);
+
+/**
+ * How many touch points are currently down for the seat.
+ */
+int wlr_seat_touch_num_points(struct wlr_seat *seat);
+
+/**
+ * Whether or not the seat has a touch grab other than the default grab.
+ */
+bool wlr_seat_touch_has_grab(struct wlr_seat *seat);
 
 #endif
diff --git a/include/wlr/types/wlr_touch.h b/include/wlr/types/wlr_touch.h
index 072e25fd..2925fd01 100644
--- a/include/wlr/types/wlr_touch.h
+++ b/include/wlr/types/wlr_touch.h
@@ -22,7 +22,7 @@ struct wlr_touch {
 struct wlr_event_touch_down {
 	struct wlr_input_device *device;
 	uint32_t time_msec;
-	int32_t slot;
+	int32_t touch_id;
 	double x_mm, y_mm;
 	double width_mm, height_mm;
 };
@@ -30,13 +30,13 @@ struct wlr_event_touch_down {
 struct wlr_event_touch_up {
 	struct wlr_input_device *device;
 	uint32_t time_msec;
-	int32_t slot;
+	int32_t touch_id;
 };
 
 struct wlr_event_touch_motion {
 	struct wlr_input_device *device;
 	uint32_t time_msec;
-	int32_t slot;
+	int32_t touch_id;
 	double x_mm, y_mm;
 	double width_mm, height_mm;
 };
@@ -44,7 +44,7 @@ struct wlr_event_touch_motion {
 struct wlr_event_touch_cancel {
 	struct wlr_input_device *device;
 	uint32_t time_msec;
-	int32_t slot;
+	int32_t touch_id;
 };
 
 #endif