commit 20cad8575a6b608caa15c6d3005a958c2810b974
parent f7e35b15b2e6413d5399c3b04753c1ba3c212ee5
Author: Nihal Jere <nihal@nihaljere.xyz>
Date: Sun, 30 May 2021 20:26:42 -0500
initial input method/text input protocol implementations
Diffstat:
12 files changed, 1007 insertions(+), 13 deletions(-)
diff --git a/libswc/compositor.c b/libswc/compositor.c
@@ -33,6 +33,7 @@
#include "drm.h"
#include "event.h"
#include "internal.h"
+#include "input_method.h"
#include "launch.h"
#include "output.h"
#include "pointer.h"
@@ -42,6 +43,7 @@
#include "shm.h"
#include "surface.h"
#include "touch.h"
+#include "text_input.h"
#include "util.h"
#include "view.h"
@@ -741,6 +743,8 @@ handle_touch_down(struct touch_handler *handler, uint32_t time, int32_t slot, wl
bool found = false;
int32_t x = wl_fixed_to_int(fx), y = wl_fixed_to_int(fy);
struct swc_rectangle *geom;
+ struct text_input_manager *timanager = wl_global_get_user_data(swc.text_input_manager);
+ struct wl_client *client = NULL;
wl_list_for_each (view, &compositor.views, link) {
if (!view->visible)
@@ -749,13 +753,19 @@ handle_touch_down(struct touch_handler *handler, uint32_t time, int32_t slot, wl
if (rectangle_contains_point(geom, x, y)) {
if (pixman_region32_contains_point(&view->surface->state.input, x - geom->x, y - geom->y, NULL)) {
found = true;
+ client = wl_resource_get_client(view->surface->resource);
break;
}
}
}
- if (found)
+ if (found) {
touch_point_add(swc.seat->touch, view, slot, fx, fy);
+ touch_set_focus(swc.seat->touch, view);
+ }
+ if (swc.seat->input_method && swc.seat->input_method->client != client) {
+ text_input_set_focus(timanager, view);
+ }
return false;
}
diff --git a/libswc/input_method.c b/libswc/input_method.c
@@ -0,0 +1,155 @@
+#include "internal.h"
+#include "seat.h"
+#include "input_method.h"
+#include "text_input.h"
+#include "util.h"
+
+#include <stdlib.h>
+#include <input-method-unstable-v2-server-protocol.h>
+#include <text-input-unstable-v3-server-protocol.h>
+#include <wayland-server.h>
+
+static void
+commit_string(struct wl_client *client, struct wl_resource *resource, const char *text)
+{
+ struct text_input *ti = text_input_get_enabled();
+ if (!ti)
+ return;
+ DEBUG("IM COMMIT_STRING\n");
+
+ zwp_text_input_v3_send_commit_string(ti->resource, text);
+}
+
+static void
+set_preedit_string(struct wl_client *client, struct wl_resource *resource, const char *text, int32_t cursor_begin, int32_t cursor_end)
+{
+ struct text_input *ti = text_input_get_enabled();
+ if (!ti)
+ return;
+ DEBUG("IM PREEDIT\n");
+
+ zwp_text_input_v3_send_preedit_string(ti->resource, text, cursor_begin, cursor_end);
+}
+
+static void
+delete_surrounding_text(struct wl_client *client, struct wl_resource *resource, uint32_t before_length, uint32_t after_length)
+{
+ struct text_input *ti = text_input_get_enabled();
+ if (!ti)
+ return;
+ DEBUG("IM DELETE\n");
+
+ zwp_text_input_v3_send_delete_surrounding_text(ti->resource, before_length, after_length);
+}
+
+static void
+commit(struct wl_client *client, struct wl_resource *resource, uint32_t serial)
+{
+ struct input_method *im = wl_resource_get_user_data(resource);
+ struct text_input *ti = text_input_get_enabled();
+
+ if (!ti)
+ return;
+
+ DEBUG("IM COMMIT: %u, %u\n", im->serial, serial);
+
+/*
+ if (im->serial != serial)
+ return;
+*/
+
+ im->serial++;
+ zwp_text_input_v3_send_done(ti->resource, ti->serial);
+}
+
+static void
+get_input_popup_surface(struct wl_client *client, struct wl_resource *resource, uint32_t id, struct wl_resource *surface)
+{}
+
+static void
+grab_keyboard(struct wl_client *client, struct wl_resource *resource, uint32_t keyboard)
+{}
+
+static void
+destroy(struct wl_client *client, struct wl_resource *resource)
+{
+ if (swc.seat->input_method) {
+ free(swc.seat->input_method);
+ swc.seat->input_method = NULL;
+ }
+ wl_resource_destroy(resource);
+}
+
+static void
+imremove(struct wl_resource *resource)
+{
+ if (swc.seat->input_method) {
+ free(swc.seat->input_method);
+ swc.seat->input_method = NULL;
+ }
+}
+
+static const struct zwp_input_method_v2_interface input_method_impl = {
+ .commit_string = commit_string,
+ .set_preedit_string = set_preedit_string,
+ .delete_surrounding_text = delete_surrounding_text,
+ .commit = commit,
+ .get_input_popup_surface = get_input_popup_surface,
+ .grab_keyboard = grab_keyboard,
+ .destroy = destroy
+};
+
+void
+get_input_method(struct wl_client *client, struct wl_resource *manager, struct wl_resource *seat, uint32_t id)
+{
+ DEBUG("IM GET INPUT METHOD\n");
+ struct wl_resource *input_method;
+
+ // TODO: for now, we only allow one input method to bind
+ if (swc.seat->input_method)
+ return;
+
+ swc.seat->input_method = malloc(sizeof(*swc.seat->input_method));
+ if (!swc.seat->input_method) {
+ wl_client_post_no_memory(client);
+ return;
+ }
+
+ swc.seat->input_method->client = client;
+ swc.seat->input_method->serial = 0;
+
+ input_method = wl_resource_create(client, &zwp_input_method_v2_interface, wl_resource_get_version(manager), id);
+ if (!input_method) {
+ free(swc.seat->input_method);
+ swc.seat->input_method = NULL;
+ wl_client_post_no_memory(client);
+ return;
+ }
+ wl_resource_set_implementation(input_method, &input_method_impl, swc.seat->input_method, &imremove);
+
+ swc.seat->input_method->resource = input_method;
+}
+
+static const struct zwp_input_method_manager_v2_interface input_method_manager_impl = {
+ .get_input_method = get_input_method,
+ .destroy = destroy,
+};
+
+static void
+bind_input_method_manager(struct wl_client *client, void *data, uint32_t version, uint32_t id)
+{
+ struct wl_resource *resource;
+
+ resource = wl_resource_create(client, &zwp_input_method_manager_v2_interface, version, id);
+ if (!resource) {
+ wl_client_post_no_memory(client);
+ return;
+ }
+ wl_resource_set_implementation(resource, &input_method_manager_impl, NULL, NULL);
+}
+
+struct wl_global *
+input_method_manager_create(struct wl_display *display)
+{
+ return wl_global_create(display, &zwp_input_method_manager_v2_interface, 1, NULL, &bind_input_method_manager);
+}
diff --git a/libswc/input_method.h b/libswc/input_method.h
@@ -0,0 +1,7 @@
+struct input_method {
+ struct wl_resource *resource;
+ uint32_t serial;
+ struct wl_client *client;
+};
+
+struct wl_global *input_method_manager_create(struct wl_display *display);
diff --git a/libswc/internal.h b/libswc/internal.h
@@ -46,10 +46,12 @@ struct swc {
struct swc_shm *shm;
struct swc_drm *const drm;
struct wl_global *data_device_manager;
+ struct wl_global *input_method_manager;
struct wl_global *kde_decoration_manager;
struct wl_global *panel_manager;
struct wl_global *shell;
struct wl_global *subcompositor;
+ struct wl_global *text_input_manager;
struct wl_global *xdg_decoration_manager;
struct wl_global *xdg_shell;
diff --git a/libswc/panel.c b/libswc/panel.c
@@ -29,6 +29,7 @@
#include "screen.h"
#include "seat.h"
#include "surface.h"
+#include "text_input.h"
#include "util.h"
#include "view.h"
@@ -83,6 +84,7 @@ static void
dock(struct wl_client *client, struct wl_resource *resource, uint32_t edge, struct wl_resource *screen_resource, uint32_t focus)
{
struct panel *panel = wl_resource_get_user_data(resource);
+ struct text_input_manager *timanager = wl_global_get_user_data(swc.text_input_manager);
struct screen *screen;
uint32_t length;
@@ -117,8 +119,10 @@ dock(struct wl_client *client, struct wl_resource *resource, uint32_t edge, stru
compositor_view_show(panel->view);
wl_list_insert(&screen->modifiers, &panel->modifier.link);
- if (focus)
+ if (focus) {
keyboard_set_focus(swc.seat->keyboard, panel->view);
+ text_input_set_focus(timanager, panel->view);
+ }
swc_panel_send_docked(resource, length);
}
diff --git a/libswc/seat.c b/libswc/seat.c
@@ -455,6 +455,8 @@ seat_create(struct wl_display *display, const char *seat_name)
goto error6;
}
+ seat->base.input_method = NULL;
+
if (!initialize_libinput(seat))
goto error7;
diff --git a/libswc/seat.h b/libswc/seat.h
@@ -31,6 +31,7 @@ struct swc_seat {
struct keyboard *keyboard;
struct touch *touch;
struct data_device *data_device;
+ struct input_method *input_method;
};
struct swc_seat *seat_create(struct wl_display *display, const char *name);
diff --git a/libswc/swc.c b/libswc/swc.c
@@ -27,6 +27,7 @@
#include "data_device_manager.h"
#include "drm.h"
#include "event.h"
+#include "input_method.h"
#include "internal.h"
#include "launch.h"
#include "kde_decoration.h"
@@ -39,6 +40,7 @@
#include "shm.h"
#include "subcompositor.h"
#include "touch.h"
+#include "text_input.h"
#include "util.h"
#include "window.h"
#include "xdg_decoration.h"
@@ -169,40 +171,52 @@ swc_initialize(struct wl_display *display, struct wl_event_loop *event_loop, con
goto error8;
}
+ swc.input_method_manager = input_method_manager_create(display);
+ if (!swc.input_method_manager) {
+ ERROR("Could not initialize input method manager\n");
+ goto error9;
+ }
+
+ swc.text_input_manager = text_input_manager_create(display);
+ if (!swc.text_input_manager) {
+ ERROR("Could not initialize text input manager\n");
+ goto error10;
+ }
+
swc.shell = shell_create(display);
if (!swc.shell) {
ERROR("Could not initialize shell\n");
- goto error9;
+ goto error11;
}
swc.xdg_shell = xdg_shell_create(display);
if (!swc.xdg_shell) {
ERROR("Could not initialize XDG shell\n");
- goto error10;
+ goto error12;
}
swc.xdg_decoration_manager = xdg_decoration_manager_create(display);
if (!swc.xdg_decoration_manager) {
ERROR("Could not initialize XDG decoration manager\n");
- goto error11;
+ goto error13;
}
swc.kde_decoration_manager = kde_decoration_manager_create(display);
if (!swc.kde_decoration_manager) {
ERROR("Could not initialize KDE decoration manager\n");
- goto error12;
+ goto error14;
}
swc.panel_manager = panel_manager_create(display);
if (!swc.panel_manager) {
ERROR("Could not initialize panel manager\n");
- goto error13;
+ goto error15;
}
#ifdef ENABLE_XWAYLAND
if (!xserver_initialize()) {
ERROR("Could not initialize xwayland\n");
- goto error14;
+ goto error16;
}
#endif
@@ -211,17 +225,21 @@ swc_initialize(struct wl_display *display, struct wl_event_loop *event_loop, con
return true;
#ifdef ENABLE_XWAYLAND
-error14:
+error16:
wl_global_destroy(swc.panel_manager);
#endif
-error13:
+error15:
wl_global_destroy(swc.kde_decoration_manager);
-error12:
+error14:
wl_global_destroy(swc.xdg_decoration_manager);
-error11:
+error13:
wl_global_destroy(swc.xdg_shell);
-error10:
+error12:
wl_global_destroy(swc.shell);
+error11:
+ wl_global_destroy(swc.text_input_manager);
+error10:
+ wl_global_destroy(swc.input_method_manager);
error9:
seat_destroy(swc.seat);
error8:
diff --git a/libswc/text_input.c b/libswc/text_input.c
@@ -0,0 +1,283 @@
+#include "compositor.h"
+#include "view.h"
+#include "surface.h"
+#include "seat.h"
+#include "internal.h"
+#include <stdlib.h>
+#include <wayland-server.h>
+#include <input-method-unstable-v2-server-protocol.h>
+#include <text-input-unstable-v3-server-protocol.h>
+#include "text_input.h"
+#include "input_method.h"
+#include "util.h"
+
+static void
+destroy(struct wl_client *client, struct wl_resource *resource)
+{
+ wl_resource_destroy(resource);
+}
+
+static void
+enable(struct wl_client *client, struct wl_resource *resource)
+{
+ struct text_input_manager *tim = wl_global_get_user_data(swc.text_input_manager);
+ struct text_input *ti = wl_resource_get_user_data(resource);
+ struct wl_resource *imresource;
+
+ if (tim->enabled && client != wl_resource_get_client(tim->enabled->resource))
+ return;
+
+ /* TODO remove */
+ if (!swc.seat->input_method)
+ return;
+
+ imresource = swc.seat->input_method->resource;
+ if (!imresource)
+ return;
+
+ wl_list_remove(&ti->link);
+ tim->enabled = ti;
+ zwp_input_method_v2_send_activate(swc.seat->input_method->resource);
+}
+
+static void
+disable(struct wl_client *client, struct wl_resource *resource)
+{
+ struct text_input_manager *tim = wl_global_get_user_data(swc.text_input_manager);
+ struct text_input *ti = wl_resource_get_user_data(resource);
+ struct wl_resource *imresource;
+
+ /* TODO remove */
+ if (!swc.seat->input_method)
+ return;
+
+ imresource = swc.seat->input_method->resource;
+ if (!imresource || ti != tim->enabled)
+ return;
+
+ wl_list_insert(&tim->disabled, &ti->link);
+ tim->enabled = NULL;
+ zwp_input_method_v2_send_deactivate(swc.seat->input_method->resource);
+}
+
+static void
+set_surrounding_text(struct wl_client *client, struct wl_resource *resource, const char *text, int32_t cursor, int32_t anchor)
+{
+ struct wl_resource *imresource;
+ /* TODO remove */
+ if (!swc.seat->input_method)
+ return;
+
+ imresource = swc.seat->input_method->resource;
+ if (!imresource)
+ return;
+
+ zwp_input_method_v2_send_surrounding_text(imresource, text, cursor, anchor);
+}
+
+static void
+set_text_change_cause(struct wl_client *client, struct wl_resource *resource, uint32_t cause)
+{
+ struct wl_resource *imresource;
+ /* TODO remove */
+ if (!swc.seat->input_method)
+ return;
+
+ imresource = swc.seat->input_method->resource;
+ if (!imresource)
+ return;
+
+ zwp_input_method_v2_send_text_change_cause(imresource, cause);
+}
+
+static void
+set_content_type(struct wl_client *client, struct wl_resource *resource, uint32_t hint, uint32_t purpose)
+{
+ struct wl_resource *imresource;
+ /* TODO remove */
+ if (!swc.seat->input_method)
+ return;
+
+ imresource = swc.seat->input_method->resource;
+ if (!imresource)
+ return;
+
+ zwp_input_method_v2_send_content_type(imresource, hint, purpose);
+}
+
+static void
+set_cursor_rectangle(struct wl_client *client, struct wl_resource *resource, int32_t x, int32_t y, int32_t width, int32_t height)
+{
+ /* we don't implement input_popup_surface */
+}
+
+static void
+commit(struct wl_client *client, struct wl_resource *resource)
+{
+ struct text_input_manager *tim = wl_global_get_user_data(swc.text_input_manager);
+ struct wl_resource *imresource;
+ /* TODO remove */
+ if (!swc.seat->input_method)
+ return;
+
+ if (tim->enabled)
+ tim->enabled->serial++;
+
+ imresource = swc.seat->input_method->resource;
+ if (!imresource)
+ return;
+
+ zwp_input_method_v2_send_done(imresource);
+}
+
+static const struct zwp_text_input_v3_interface text_input_impl = {
+ .destroy = destroy,
+ .enable = enable,
+ .disable = disable,
+ .set_surrounding_text = set_surrounding_text,
+ .set_text_change_cause = set_text_change_cause,
+ .set_content_type = set_content_type,
+ .set_cursor_rectangle = set_cursor_rectangle,
+ .commit = commit,
+};
+
+static void
+ti_remove_resource(struct wl_resource *resource)
+{
+ struct text_input_manager *tim = wl_global_get_user_data(swc.text_input_manager);
+ struct text_input *ti = wl_resource_get_user_data(resource);
+
+ if (ti == tim->enabled) {
+ tim->enabled = NULL;
+ free(ti);
+ return;
+ }
+
+ wl_list_for_each (ti, &tim->disabled, link) {
+ if (ti->resource == resource) {
+ wl_list_remove(&ti->link);
+ free(ti);
+ break;
+ }
+ }
+}
+
+static void
+get_text_input(struct wl_client *client, struct wl_resource *manager, uint32_t id, struct wl_resource *seat)
+{
+ struct text_input_manager *tim = wl_resource_get_user_data(manager);
+ struct wl_resource *tiresource;
+ struct text_input *text_input;
+
+ text_input = malloc(sizeof(*text_input));
+ if (!text_input) {
+ wl_client_post_no_memory(client);
+ return;
+ }
+
+ tiresource = wl_resource_create(client, &zwp_text_input_v3_interface, wl_resource_get_version(manager), id);
+ if (!tiresource) {
+ free(text_input);
+ wl_client_post_no_memory(client);
+ return;
+ }
+
+ text_input->resource = tiresource;
+ text_input->serial = 0;
+ wl_list_insert(&tim->disabled, &text_input->link);
+ wl_resource_set_implementation(tiresource, &text_input_impl, text_input, &ti_remove_resource);
+}
+
+static const struct zwp_text_input_manager_v3_interface text_input_manager_impl = {
+ .get_text_input = get_text_input,
+ .destroy = destroy_resource
+};
+
+static void
+bind_text_input_manager(struct wl_client *client, void *data, uint32_t version, uint32_t id)
+{
+ struct wl_resource *resource;
+
+ resource = wl_resource_create(client, &zwp_text_input_manager_v3_interface, version, id);
+ if (!resource) {
+ wl_client_post_no_memory(client);
+ return;
+ }
+ wl_resource_set_implementation(resource, &text_input_manager_impl, data, NULL);
+}
+
+void
+enter(struct input_focus_handler *handler, struct wl_list *resources, struct compositor_view *view)
+{
+ struct text_input_manager *tim = wl_global_get_user_data(swc.text_input_manager);
+ struct wl_resource *surface;
+ struct text_input *text_input;
+
+ if (!view)
+ return;
+
+ surface = view->surface->resource;
+ wl_list_for_each (text_input, &tim->disabled, link) {
+ if (wl_resource_get_client(text_input->resource) == wl_resource_get_client(surface)) {
+ zwp_text_input_v3_send_enter(text_input->resource, surface);
+ }
+ }
+}
+
+void
+leave(struct input_focus_handler *handler, struct wl_list *resources, struct compositor_view *view)
+{
+ struct text_input_manager *tim = wl_global_get_user_data(swc.text_input_manager);
+ struct wl_resource *surface;
+ struct text_input *text_input;
+
+ if (!view)
+ return;
+
+ surface = view->surface->resource;
+ wl_list_for_each (text_input, &tim->disabled, link) {
+ if (wl_resource_get_client(text_input->resource) == wl_resource_get_client(surface)) {
+ zwp_text_input_v3_send_leave(text_input->resource, surface);
+ }
+ }
+
+ if (tim->enabled) {
+ zwp_text_input_v3_send_leave(tim->enabled->resource, surface);
+ disable(wl_resource_get_client(tim->enabled->resource), tim->enabled->resource);
+ }
+}
+
+void
+text_input_set_focus(struct text_input_manager *manager, struct compositor_view *view)
+{
+ input_focus_set(&manager->focus, view);
+}
+
+struct text_input *
+text_input_get_enabled()
+{
+ struct text_input_manager *tim = wl_global_get_user_data(swc.text_input_manager);
+ return tim->enabled;
+}
+
+struct wl_global *
+text_input_manager_create(struct wl_display *display)
+{
+ struct text_input_manager *tim = malloc(sizeof(*tim));
+ if (!tim)
+ goto error0;
+
+ if (!input_focus_initialize(&tim->focus, &tim->focus_handler))
+ goto error1;
+
+ tim->focus_handler.enter = enter;
+ tim->focus_handler.leave = leave;
+
+ wl_list_init(&tim->disabled);
+
+ return wl_global_create(display, &zwp_text_input_manager_v3_interface, 1, tim, &bind_text_input_manager);
+error1:
+ free(tim);
+error0:
+ return NULL;
+}
diff --git a/libswc/text_input.h b/libswc/text_input.h
@@ -0,0 +1,19 @@
+#include "input.h"
+
+struct text_input {
+ struct wl_list link;
+ struct wl_resource *resource;
+ uint32_t serial;
+};
+
+struct text_input_manager {
+ struct input_focus focus;
+ struct input_focus_handler focus_handler;
+
+ struct text_input *enabled;
+ struct wl_list disabled;
+};
+
+struct text_input *text_input_get_enabled();
+struct wl_global *text_input_manager_create(struct wl_display *display);
+void text_input_set_focus(struct text_input_manager *manager, struct compositor_view *view);
diff --git a/libswc/window.c b/libswc/window.c
@@ -28,6 +28,7 @@
#include "keyboard.h"
#include "seat.h"
#include "swc.h"
+#include "text_input.h"
#include "util.h"
#include "view.h"
@@ -147,6 +148,7 @@ swc_window_focus(struct swc_window *base)
{
struct window *window = INTERNAL(base);
struct compositor_view *new = window ? window->view : NULL, *old = swc.seat->keyboard->focus.view;
+ struct text_input_manager *timanager = wl_global_get_user_data(swc.text_input_manager);
if (new == old)
return;
@@ -160,6 +162,7 @@ swc_window_focus(struct swc_window *base)
old->window->impl->unfocus(old->window);
keyboard_set_focus(swc.seat->keyboard, new);
+ text_input_set_focus(timanager, new);
}
EXPORT void
diff --git a/protocol/input-method-unstable-v2.xml b/protocol/input-method-unstable-v2.xml
@@ -0,0 +1,490 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<protocol name="input_method_unstable_v2">
+
+ <copyright>
+ Copyright © 2008-2011 Kristian Høgsberg
+ Copyright © 2010-2011 Intel Corporation
+ Copyright © 2012-2013 Collabora, Ltd.
+ Copyright © 2012, 2013 Intel Corporation
+ Copyright © 2015, 2016 Jan Arne Petersen
+ Copyright © 2017, 2018 Red Hat, Inc.
+ Copyright © 2018 Purism SPC
+
+ Permission is hereby granted, free of charge, to any person obtaining a
+ copy of this software and associated documentation files (the "Software"),
+ to deal in the Software without restriction, including without limitation
+ the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ and/or sell copies of the Software, and to permit persons to whom the
+ Software is furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice (including the next
+ paragraph) shall be included in all copies or substantial portions of the
+ Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ DEALINGS IN THE SOFTWARE.
+ </copyright>
+
+ <description summary="Protocol for creating input methods">
+ This protocol allows applications to act as input methods for compositors.
+
+ An input method context is used to manage the state of the input method.
+
+ Text strings are UTF-8 encoded, their indices and lengths are in bytes.
+
+ This document adheres to the RFC 2119 when using words like "must",
+ "should", "may", etc.
+
+ 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.
+ </description>
+
+ <interface name="zwp_input_method_v2" version="1">
+ <description summary="input method">
+ An input method object allows for clients to compose text.
+
+ The objects connects the client to a text input in an application, and
+ lets the client to serve as an input method for a seat.
+
+ The zwp_input_method_v2 object can occupy two distinct states: active and
+ inactive. In the active state, the object is associated to and
+ communicates with a text input. In the inactive state, there is no
+ associated text input, and the only communication is with the compositor.
+ Initially, the input method is in the inactive state.
+
+ Requests issued in the inactive state must be accepted by the compositor.
+ Because of the serial mechanism, and the state reset on activate event,
+ they will not have any effect on the state of the next text input.
+
+ There must be no more than one input method object per seat.
+ </description>
+
+ <event name="activate">
+ <description summary="input method has been requested">
+ Notification that a text input focused on this seat requested the input
+ method to be activated.
+
+ This event serves the purpose of providing the compositor with an
+ active input method.
+
+ This event resets all state associated with previous enable, disable,
+ surrounding_text, text_change_cause, and content_type events, as well
+ as the state associated with set_preedit_string, commit_string, and
+ delete_surrounding_text requests. In addition, it marks the
+ zwp_input_method_v2 object as active, and makes any existing
+ zwp_input_popup_surface_v2 objects visible.
+
+ The surrounding_text, and content_type events must follow before the
+ next done event if the text input supports the respective
+ functionality.
+
+ State set with this event is double-buffered. It will get applied on
+ the next zwp_input_method_v2.done event, and stay valid until changed.
+ </description>
+ </event>
+
+ <event name="deactivate">
+ <description summary="deactivate event">
+ Notification that no focused text input currently needs an active
+ input method on this seat.
+
+ This event marks the zwp_input_method_v2 object as inactive. The
+ compositor must make all existing zwp_input_popup_surface_v2 objects
+ invisible until the next activate event.
+
+ State set with this event is double-buffered. It will get applied on
+ the next zwp_input_method_v2.done event, and stay valid until changed.
+ </description>
+ </event>
+
+ <event name="surrounding_text">
+ <description summary="surrounding text event">
+ Updates the surrounding plain text around the cursor, excluding the
+ preedit text.
+
+ If any preedit text is present, it is replaced with the cursor for the
+ purpose of this event.
+
+ The argument text is a buffer containing the preedit string, and must
+ include the cursor position, and the complete selection. It should
+ contain additional characters before and after these. There is a
+ maximum length of wayland messages, so text can not be longer than 4000
+ bytes.
+
+ cursor is the byte offset of the cursor within the text buffer.
+
+ anchor is the byte offset of the selection anchor within the text
+ buffer. If there is no selected text, anchor must be the same as
+ cursor.
+
+ If this event does not arrive before the first done event, the input
+ method may assume that the text input does not support this
+ functionality and ignore following surrounding_text events.
+
+ Values set with this event are double-buffered. They will get applied
+ and set to initial values on the next zwp_input_method_v2.done
+ event.
+
+ The initial state for affected fields is empty, meaning that the text
+ input does not support sending surrounding text. If the empty values
+ get applied, subsequent attempts to change them may have no effect.
+ </description>
+ <arg name="text" type="string"/>
+ <arg name="cursor" type="uint"/>
+ <arg name="anchor" type="uint"/>
+ </event>
+
+ <event name="text_change_cause">
+ <description summary="indicates the cause of surrounding text change">
+ Tells the input method why the text surrounding the cursor changed.
+
+ Whenever the client detects an external change in text, cursor, or
+ anchor position, it must issue this request to the compositor. This
+ request is intended to give the input method a chance to update the
+ preedit text in an appropriate way, e.g. by removing it when the user
+ starts typing with a keyboard.
+
+ cause describes the source of the change.
+
+ The value set with this event is double-buffered. It will get applied
+ and set to its initial value on the next zwp_input_method_v2.done
+ event.
+
+ The initial value of cause is input_method.
+ </description>
+ <arg name="cause" type="uint" enum="zwp_text_input_v3.change_cause"/>
+ </event>
+
+ <event name="content_type">
+ <description summary="content purpose and hint">
+ Indicates the content type and hint for the current
+ zwp_input_method_v2 instance.
+
+ Values set with this event are double-buffered. They will get applied
+ on the next zwp_input_method_v2.done event.
+
+ The initial value for hint is none, and the initial value for purpose
+ is normal.
+ </description>
+ <arg name="hint" type="uint" enum="zwp_text_input_v3.content_hint"/>
+ <arg name="purpose" type="uint" enum="zwp_text_input_v3.content_purpose"/>
+ </event>
+
+ <event name="done">
+ <description summary="apply state">
+ Atomically applies state changes recently sent to the client.
+
+ The done event establishes and updates the state of the client, and
+ must be issued after any changes to apply them.
+
+ Text input state (content purpose, content hint, surrounding text, and
+ change cause) is conceptually double-buffered within an input method
+ context.
+
+ Events modify the pending state, as opposed to the current state in use
+ by the input method. A done event atomically applies all pending state,
+ replacing the current state. After done, the new pending state is as
+ documented for each related request.
+
+ Events must be applied in the order of arrival.
+
+ Neither current nor pending state are modified unless noted otherwise.
+ </description>
+ </event>
+
+ <request name="commit_string">
+ <description summary="commit string">
+ Send the commit string text for insertion to the application.
+
+ Inserts a string at current cursor position (see commit event
+ sequence). The string to commit could be either just a single character
+ after a key press or the result of some composing.
+
+ The argument text is a buffer containing the string to insert. There is
+ a maximum length of wayland messages, so text can not be longer than
+ 4000 bytes.
+
+ Values set with this event are double-buffered. They must be applied
+ and reset to initial on the next zwp_text_input_v3.commit request.
+
+ The initial value of text is an empty string.
+ </description>
+ <arg name="text" type="string"/>
+ </request>
+
+ <request name="set_preedit_string">
+ <description summary="pre-edit string">
+ Send the pre-edit string text to the application text input.
+
+ Place a new composing text (pre-edit) at the current cursor position.
+ Any previously set composing text must be removed. Any previously
+ existing selected text must be removed. The cursor is moved to a new
+ position within the preedit string.
+
+ The argument text is a buffer containing the preedit string. There is
+ a maximum length of wayland messages, so text can not be longer than
+ 4000 bytes.
+
+ The arguments cursor_begin and cursor_end are counted in bytes relative
+ to the beginning of the submitted string buffer. Cursor should be
+ hidden by the text input when both are equal to -1.
+
+ cursor_begin indicates the beginning of the cursor. cursor_end
+ indicates the end of the cursor. It may be equal or different than
+ cursor_begin.
+
+ Values set with this event are double-buffered. They must be applied on
+ the next zwp_input_method_v2.commit event.
+
+ The initial value of text is an empty string. The initial value of
+ cursor_begin, and cursor_end are both 0.
+ </description>
+ <arg name="text" type="string"/>
+ <arg name="cursor_begin" type="int"/>
+ <arg name="cursor_end" type="int"/>
+ </request>
+
+ <request name="delete_surrounding_text">
+ <description summary="delete text">
+ Remove the surrounding text.
+
+ before_length and after_length are the number of bytes before and after
+ the current cursor index (excluding the preedit text) to delete.
+
+ If any preedit text is present, it is replaced with the cursor for the
+ purpose of this event. In effect before_length is counted from the
+ beginning of preedit text, and after_length from its end (see commit
+ event sequence).
+
+ Values set with this event are double-buffered. They must be applied
+ and reset to initial on the next zwp_input_method_v2.commit request.
+
+ The initial values of both before_length and after_length are 0.
+ </description>
+ <arg name="before_length" type="uint"/>
+ <arg name="after_length" type="uint"/>
+ </request>
+
+ <request name="commit">
+ <description summary="apply state">
+ Apply state changes from commit_string, set_preedit_string and
+ delete_surrounding_text requests.
+
+ The state relating to these events is double-buffered, and each one
+ modifies the pending state. This request replaces the current state
+ with the pending state.
+
+ The connected text input is expected to proceed by evaluating the
+ changes in the following order:
+
+ 1. Replace existing preedit string with the cursor.
+ 2. Delete requested surrounding text.
+ 3. Insert commit string with the cursor at its end.
+ 4. Calculate surrounding text to send.
+ 5. Insert new preedit text in cursor position.
+ 6. Place cursor inside preedit text.
+
+ The serial number reflects the last state of the zwp_input_method_v2
+ object known to the client. The value of the serial argument must be
+ equal to the number of done events already issued by that object. When
+ the compositor receives a commit request with a serial different than
+ the number of past done events, it must proceed as normal, except it
+ should not change the current state of the zwp_input_method_v2 object.
+ </description>
+ <arg name="serial" type="uint"/>
+ </request>
+
+ <request name="get_input_popup_surface">
+ <description summary="create popup surface">
+ Creates a new zwp_input_popup_surface_v2 object wrapping a given
+ surface.
+
+ The surface gets assigned the "input_popup" role. If the surface
+ already has an assigned role, the compositor must issue a protocol
+ error.
+ </description>
+ <arg name="id" type="new_id" interface="zwp_input_popup_surface_v2"/>
+ <arg name="surface" type="object" interface="wl_surface"/>
+ </request>
+
+ <request name="grab_keyboard">
+ <description summary="grab hardware keyboard">
+ Allow an input method to receive hardware keyboard input and process
+ key events to generate text events (with pre-edit) over the wire. This
+ allows input methods which compose multiple key events for inputting
+ text like it is done for CJK languages.
+
+ The compositor should send all keyboard events on the seat to the grab
+ holder via the returned wl_keyboard object. Nevertheless, the
+ compositor may decide not to forward any particular event. The
+ compositor must not further process any event after it has been
+ forwarded to the grab holder.
+
+ Releasing the resulting wl_keyboard object releases the grab.
+ </description>
+ <arg name="keyboard" type="new_id"
+ interface="zwp_input_method_keyboard_grab_v2"/>
+ </request>
+
+ <event name="unavailable">
+ <description summary="input method unavailable">
+ The input method ceased to be available.
+
+ The compositor must issue this event as the only event on the object if
+ there was another input_method object associated with the same seat at
+ the time of its creation.
+
+ The compositor must issue this request when the object is no longer
+ useable, e.g. due to seat removal.
+
+ The input method context becomes inert and should be destroyed after
+ deactivation is handled. Any further requests and events except for the
+ destroy request must be ignored.
+ </description>
+ </event>
+
+ <request name="destroy" type="destructor">
+ <description summary="destroy the text input">
+ Destroys the zwp_text_input_v2 object and any associated child
+ objects, i.e. zwp_input_popup_surface_v2 and
+ zwp_input_method_keyboard_grab_v2.
+ </description>
+ </request>
+ </interface>
+
+ <interface name="zwp_input_popup_surface_v2" version="1">
+ <description summary="popup surface">
+ This interface marks a surface as a popup for interacting with an input
+ method.
+
+ The compositor should place it near the active text input area. It must
+ be visible if and only if the input method is in the active state.
+
+ The client must not destroy the underlying wl_surface while the
+ zwp_input_popup_surface_v2 object exists.
+ </description>
+
+ <event name="text_input_rectangle">
+ <description summary="set text input area position">
+ Notify about the position of the area of the text input expressed as a
+ rectangle in surface local coordinates.
+
+ This is a hint to the input method telling it the relative position of
+ the text being entered.
+ </description>
+ <arg name="x" type="int"/>
+ <arg name="y" type="int"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
+ </event>
+
+ <request name="destroy" type="destructor"/>
+ </interface>
+
+ <interface name="zwp_input_method_keyboard_grab_v2" version="1">
+ <!-- Closely follows wl_keyboard version 6 -->
+ <description summary="keyboard grab">
+ The zwp_input_method_keyboard_grab_v2 interface represents an exclusive
+ grab of the wl_keyboard interface associated with the seat.
+ </description>
+
+ <event name="keymap">
+ <description summary="keyboard mapping">
+ This event provides a file descriptor to the client which can be
+ memory-mapped to provide a keyboard mapping description.
+ </description>
+ <arg name="format" type="uint" enum="wl_keyboard.keymap_format"
+ summary="keymap format"/>
+ <arg name="fd" type="fd" summary="keymap file descriptor"/>
+ <arg name="size" type="uint" summary="keymap size, in bytes"/>
+ </event>
+
+ <event name="key">
+ <description summary="key event">
+ A key was pressed or released.
+ The time argument is a timestamp with millisecond granularity, with an
+ undefined base.
+ </description>
+ <arg name="serial" type="uint" summary="serial number of the key event"/>
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
+ <arg name="key" type="uint" summary="key that produced the event"/>
+ <arg name="state" type="uint" enum="wl_keyboard.key_state"
+ summary="physical state of the key"/>
+ </event>
+
+ <event name="modifiers">
+ <description summary="modifier and group state">
+ Notifies clients that the modifier and/or group state has changed, and
+ it should update its local state.
+ </description>
+ <arg name="serial" type="uint" summary="serial number of the modifiers event"/>
+ <arg name="mods_depressed" type="uint" summary="depressed modifiers"/>
+ <arg name="mods_latched" type="uint" summary="latched modifiers"/>
+ <arg name="mods_locked" type="uint" summary="locked modifiers"/>
+ <arg name="group" type="uint" summary="keyboard layout"/>
+ </event>
+
+ <request name="release" type="destructor">
+ <description summary="release the grab object"/>
+ </request>
+
+ <event name="repeat_info">
+ <description summary="repeat rate and delay">
+ Informs the client about the keyboard's repeat rate and delay.
+
+ This event is sent as soon as the zwp_input_method_keyboard_grab_v2
+ object has been created, and is guaranteed to be received by the
+ client before any key press event.
+
+ Negative values for either rate or delay are illegal. A rate of zero
+ will disable any repeating (regardless of the value of delay).
+
+ This event can be sent later on as well with a new value if necessary,
+ so clients should continue listening for the event past the creation
+ of zwp_input_method_keyboard_grab_v2.
+ </description>
+ <arg name="rate" type="int"
+ summary="the rate of repeating keys in characters per second"/>
+ <arg name="delay" type="int"
+ summary="delay in milliseconds since key down until repeating starts"/>
+ </event>
+ </interface>
+
+ <interface name="zwp_input_method_manager_v2" version="1">
+ <description summary="input method manager">
+ The input method manager allows the client to become the input method on
+ a chosen seat.
+
+ No more than one input method must be associated with any seat at any
+ given time.
+ </description>
+
+ <request name="get_input_method">
+ <description summary="request an input method object">
+ Request a new input zwp_input_method_v2 object associated with a given
+ seat.
+ </description>
+ <arg name="seat" type="object" interface="wl_seat"/>
+ <arg name="input_method" type="new_id" interface="zwp_input_method_v2"/>
+ </request>
+
+ <request name="destroy" type="destructor">
+ <description summary="destroy the input method manager">
+ Destroys the zwp_input_method_manager_v2 object.
+
+ The zwp_input_method_v2 objects originating from it remain valid.
+ </description>
+ </request>
+ </interface>
+</protocol>
