Merge pull request #1203 from dcz-purism/input

Support input method and text input

3 files changed, 182 insertions, 0 deletions

diff --git a/include/wlr/types/meson.build b/include/wlr/types/meson.build
index 7a02c3da..3f61ae20 100644
--- a/include/wlr/types/meson.build
+++ b/include/wlr/types/meson.build
@@ -11,6 +11,7 @@ install_headers(
 	'wlr_idle.h',
 	'wlr_input_device.h',
 	'wlr_input_inhibitor.h',
+	'wlr_input_method_v2.h',
 	'wlr_keyboard.h',
 	'wlr_layer_shell_v1.h',
 	'wlr_linux_dmabuf_v1.h',
@@ -31,6 +32,7 @@ install_headers(
 	'wlr_tablet_pad.h',
 	'wlr_tablet_tool.h',
 	'wlr_tablet_v2.h',
+	'wlr_text_input_v3.h',
 	'wlr_touch.h',
 	'wlr_virtual_keyboard_v1.h',
 	'wlr_wl_shell.h',
diff --git a/include/wlr/types/wlr_input_method_v2.h b/include/wlr/types/wlr_input_method_v2.h
new file mode 100644
index 00000000..823088b7
--- /dev/null
+++ b/include/wlr/types/wlr_input_method_v2.h
@@ -0,0 +1,87 @@
+/*
+ * This an unstable interface of wlroots. No guarantees are made regarding the
+ * future consistency of this API.
+ */
+#ifndef WLR_USE_UNSTABLE
+#error "Add -DWLR_USE_UNSTABLE to enable unstable wlroots features"
+#endif
+
+#ifndef WLR_TYPES_WLR_INPUT_METHOD_V1_H
+#define WLR_TYPES_WLR_INPUT_METHOD_V1_H
+#include <stdint.h>
+#include <stdlib.h>
+#include <wayland-server.h>
+#include <wlr/types/wlr_seat.h>
+
+struct wlr_input_method_v2_preedit_string {
+	char *text;
+	int32_t cursor_begin;
+	int32_t cursor_end;
+};
+
+struct wlr_input_method_v2_delete_surrounding_text {
+	uint32_t before_length;
+	uint32_t after_length;
+};
+
+struct wlr_input_method_v2_state {
+	struct wlr_input_method_v2_preedit_string preedit;
+	char *commit_text;
+	struct wlr_input_method_v2_delete_surrounding_text delete;
+};
+
+struct wlr_input_method_v2 {
+	struct wl_resource *resource;
+
+	struct wlr_seat *seat;
+
+	struct wlr_input_method_v2_state pending;
+	struct wlr_input_method_v2_state current;
+	bool active; // pending compositor-side state
+	bool client_active; // state known to the client
+	uint32_t current_serial; // received in last commit call
+
+	struct wl_list link;
+
+	struct wl_listener seat_destroy;
+
+	struct {
+		struct wl_signal commit; // (struct wlr_input_method_v2*)
+		struct wl_signal destroy; // (struct wlr_input_method_v2*)
+	} events;
+};
+
+struct wlr_input_method_manager_v2 {
+	struct wl_global *global;
+	struct wl_list bound_resources; // struct wl_resource*::link
+	struct wl_list input_methods; // struct wlr_input_method_v2*::link
+
+	struct wl_listener display_destroy;
+
+	struct {
+		struct wl_signal input_method; // (struct wlr_input_method_v2*)
+		struct wl_signal destroy; // (struct wlr_input_method_manager_v2*)
+	} events;
+};
+
+struct wlr_input_method_manager_v2 *wlr_input_method_manager_v2_create(
+	struct wl_display *display);
+void wlr_input_method_manager_v2_destroy(
+	struct wlr_input_method_manager_v2 *manager);
+
+void wlr_input_method_v2_send_activate(
+	struct wlr_input_method_v2 *input_method);
+void wlr_input_method_v2_send_deactivate(
+	struct wlr_input_method_v2 *input_method);
+void wlr_input_method_v2_send_surrounding_text(
+	struct wlr_input_method_v2 *input_method, const char *text,
+	uint32_t cursor, uint32_t anchor);
+void wlr_input_method_v2_send_content_type(
+	struct wlr_input_method_v2 *input_method, uint32_t hint,
+	uint32_t purpose);
+void wlr_input_method_v2_send_text_change_cause(
+	struct wlr_input_method_v2 *input_method, uint32_t cause);
+void wlr_input_method_v2_send_done(struct wlr_input_method_v2 *input_method);
+void wlr_input_method_v2_send_unavailable(
+	struct wlr_input_method_v2 *input_method);
+#endif
diff --git a/include/wlr/types/wlr_text_input_v3.h b/include/wlr/types/wlr_text_input_v3.h
new file mode 100644
index 00000000..0db0cf47
--- /dev/null
+++ b/include/wlr/types/wlr_text_input_v3.h
@@ -0,0 +1,93 @@
+/*
+ * This an unstable interface of wlroots. No guarantees are made regarding the
+ * future consistency of this API.
+ */
+#ifndef WLR_USE_UNSTABLE
+#error "Add -DWLR_USE_UNSTABLE to enable unstable wlroots features"
+#endif
+
+#ifndef WLR_TYPES_WLR_TEXT_INPUT_V3_H
+#define WLR_TYPES_WLR_TEXT_INPUT_V3_H
+
+#include <wayland-server.h>
+#include <wlr/types/wlr_seat.h>
+#include <wlr/types/wlr_surface.h>
+
+struct wlr_text_input_v3_state {
+	struct {
+		char *text; // NULL is allowed and equivalent to empty string
+		uint32_t cursor;
+		uint32_t anchor;
+	} surrounding;
+
+	uint32_t text_change_cause;
+
+	struct {
+		uint32_t hint;
+		uint32_t purpose;
+	} content_type;
+
+	struct {
+		int32_t x;
+		int32_t y;
+		int32_t width;
+		int32_t height;
+	} cursor_rectangle;
+};
+
+struct wlr_text_input_v3 {
+	struct wlr_seat *seat; // becomes null when seat destroyed
+	struct wl_resource *resource;
+	struct wlr_surface *focused_surface;
+	struct wlr_text_input_v3_state pending;
+	struct wlr_text_input_v3_state current;
+	uint32_t current_serial; // next in line to send
+	bool pending_enabled;
+	bool current_enabled;
+
+	struct wl_list link;
+
+	struct wl_listener surface_destroy;
+	struct wl_listener seat_destroy;
+
+	struct {
+		struct wl_signal enable; // (struct wlr_text_input_v3*)
+		struct wl_signal commit; // (struct wlr_text_input_v3*)
+		struct wl_signal disable; // (struct wlr_text_input_v3*)
+		struct wl_signal destroy; // (struct wlr_text_input_v3*)
+	} events;
+};
+
+struct wlr_text_input_manager_v3 {
+	struct wl_global *global;
+
+	struct wl_list bound_resources; // struct wl_resource*::link
+	struct wl_list text_inputs; // struct wlr_text_input_v3::resource::link
+
+	struct wl_listener display_destroy;
+
+	struct {
+		struct wl_signal text_input; // (struct wlr_text_input_v3*)
+		struct wl_signal destroy; // (struct wlr_input_method_manager_v3*)
+	} events;
+};
+
+struct wlr_text_input_manager_v3 *wlr_text_input_manager_v3_create(
+	struct wl_display *wl_display);
+void wlr_text_input_manager_v3_destroy(
+	struct wlr_text_input_manager_v3 *manager);
+
+// Sends enter to the surface and saves it
+void wlr_text_input_v3_send_enter(struct wlr_text_input_v3 *text_input,
+	struct wlr_surface *wlr_surface);
+// Sends leave to the currently focused surface and clears it
+void wlr_text_input_v3_send_leave(struct wlr_text_input_v3 *text_input);
+void wlr_text_input_v3_send_preedit_string(struct wlr_text_input_v3 *text_input,
+	const char *text, uint32_t cursor_begin, uint32_t cursor_end);
+void wlr_text_input_v3_send_commit_string(struct wlr_text_input_v3 *text_input,
+	const char *text);
+void wlr_text_input_v3_send_delete_surrounding_text(
+	struct wlr_text_input_v3 *text_input, uint32_t before_length,
+	uint32_t after_length);
+void wlr_text_input_v3_send_done(struct wlr_text_input_v3 *text_input);
+#endif