blankie
/
wlroots
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

rootston: add support for text input and the basic of input method 

The compositor acts as a relay between applications using the text-input protocol and input methods using the input-method protocol.

This change implements the basic but useful support for input-method, leaving out grabs as well as popups.
This commit is contained in:
Dorota Czaplejewicz 2018-08-23 11:39:49 +02:00
parent cec7471119
commit 585757d6e6
7 changed files with 394 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/rootston/desktop.h
View File

@ -9,6 +9,7 @@
#include <wlr/types/wlr_idle_inhibit_v1.h>
#include <wlr/types/wlr_idle.h>
#include <wlr/types/wlr_input_inhibitor.h>
#include <wlr/types/wlr_input_method_v2.h>
#include <wlr/types/wlr_layer_shell_v1.h>
#include <wlr/types/wlr_list.h>
#include <wlr/types/wlr_output_layout.h>
@ -16,6 +17,7 @@
#include <wlr/types/wlr_primary_selection.h>
#include <wlr/types/wlr_screencopy_v1.h>
#include <wlr/types/wlr_screenshooter.h>
#include <wlr/types/wlr_text_input_v3.h>
#include <wlr/types/wlr_virtual_keyboard_v1.h>
#include <wlr/types/wlr_wl_shell.h>
#include <wlr/types/wlr_xcursor_manager.h>
@ -53,6 +55,8 @@ struct roots_desktop {
struct wlr_idle_inhibit_manager_v1 *idle_inhibit;
struct wlr_input_inhibit_manager *input_inhibit;
struct wlr_layer_shell_v1 *layer_shell;
struct wlr_input_method_manager_v2 *input_method;
struct wlr_text_input_manager_v3 *text_input;
struct wlr_virtual_keyboard_manager_v1 *virtual_keyboard;
struct wlr_screencopy_manager_v1 *screencopy;
struct wlr_tablet_manager_v2 *tablet_v2;

3
include/rootston/seat.h
View File

@ -5,6 +5,7 @@
#include "rootston/input.h"
#include "rootston/keyboard.h"
#include "rootston/layers.h"
#include "rootston/text_input.h"
struct roots_seat {
struct roots_input *input;
@ -19,6 +20,8 @@ struct roots_seat {
// If the focused layer is set, views cannot receive keyboard focus
struct wlr_layer_surface_v1 *focused_layer;
struct roots_input_method_relay im_relay;
// If non-null, only this client can receive input events
struct wl_client *exclusive_client;

63
include/rootston/text_input.h Normal file
View File

@ -0,0 +1,63 @@
#ifndef ROOTSTON_TEXT_INPUT_H
#define ROOTSTON_TEXT_INPUT_H
#include <wlr/types/wlr_text_input_v3.h>
#include <wlr/types/wlr_input_method_v2.h>
#include <wlr/types/wlr_surface.h>
#include "rootston/seat.h"
/**
* The relay structure manages the relationship between text-input and
* input_method interfaces on a given seat. Multiple text-input interfaces may
* be bound to a relay, but at most one will be focused (reveiving events) at
* a time. At most one input-method interface may be bound to the seat. The
* relay manages life cycle of both sides. When both sides are present and
* focused, the relay passes messages between them.
*
* Text input focus is a subset of keyboard focus - if the text-input is
* in the focused state, wl_keyboard sent an enter as well. However, having
* wl_keyboard focused doesn't mean that text-input will be focused.
*/
struct roots_input_method_relay {
struct roots_seat *seat;
struct wl_list text_inputs; // roots_text_input::link
struct wlr_input_method_v2 *input_method; // doesn't have to be present
struct wl_listener text_input_new;
struct wl_listener text_input_enable;
struct wl_listener text_input_commit;
struct wl_listener text_input_disable;
struct wl_listener text_input_destroy;
struct wl_listener input_method_new;
struct wl_listener input_method_commit;
struct wl_listener input_method_destroy;
};
struct roots_text_input {
struct roots_input_method_relay *relay;
struct wlr_text_input_v3 *input;
// The surface getting seat's focus. Stored for when text-input cannot
// be sent an enter event immediately after getting focus, e.g. when
// there's no input method available. Cleared once text-input is entered.
struct wlr_surface *pending_focused_surface;
struct wl_list link;
struct wl_listener pending_focused_surface_destroy;
};
void roots_input_method_relay_init(struct roots_seat *seat,
struct roots_input_method_relay *relay);
// Updates currently focused surface. Surface must belong to the same seat.
void roots_input_method_relay_set_focus(struct roots_input_method_relay *relay,
struct wlr_surface *surface);
struct roots_text_input *roots_text_input_create(
struct roots_input_method_relay *relay,
struct wlr_text_input_v3 *text_input);
#endif

5
rootston/desktop.c
View File

@ -949,6 +949,11 @@ struct roots_desktop *desktop_create(struct roots_server *server,
wl_signal_add(&desktop->input_inhibit->events.deactivate,
&desktop->input_inhibit_deactivate);
desktop->input_method =
wlr_input_method_manager_v2_create(server->wl_display);
desktop->text_input = wlr_text_input_manager_v3_create(server->wl_display);
desktop->virtual_keyboard = wlr_virtual_keyboard_manager_v1_create(
server->wl_display);
wl_signal_add(&desktop->virtual_keyboard->events.new_virtual_keyboard,

1
rootston/meson.build
View File

@ -9,6 +9,7 @@ sources = [
'main.c',
'output.c',
'seat.c',
'text_input.c',
'virtual_keyboard.c',
'wl_shell.c',
'xdg_shell.c',

6
rootston/seat.c
View File

@ -16,6 +16,7 @@
#include "rootston/input.h"
#include "rootston/keyboard.h"
#include "rootston/seat.h"
#include "rootston/text_input.h"
#include "rootston/xcursor.h"
@ -605,6 +606,8 @@ struct roots_seat *roots_seat_create(struct roots_input *input, char *name) {
return NULL;
}
roots_input_method_relay_init(seat, &seat->im_relay);
wl_list_insert(&input->seats, &seat->link);
seat->new_drag_icon.notify = roots_seat_handle_new_drag_icon;
@ -1182,6 +1185,7 @@ void roots_seat_set_focus(struct roots_seat *seat, struct roots_view *view) {
if (view == NULL) {
seat->cursor->mode = ROOTS_CURSOR_PASSTHROUGH;
wlr_seat_keyboard_clear_focus(seat->seat);
roots_input_method_relay_set_focus(&seat->im_relay, NULL);
return;
}
@ -1220,6 +1224,8 @@ void roots_seat_set_focus(struct roots_seat *seat, struct roots_view *view) {
if (seat->cursor) {
roots_cursor_update_focus(seat->cursor);
}
roots_input_method_relay_set_focus(&seat->im_relay, view->wlr_surface);
}
/**

312
rootston/text_input.c Normal file
View File

@ -0,0 +1,312 @@
#include <assert.h>
#include <stdlib.h>
#include <wlr/util/log.h>
#include "rootston/seat.h"
#include "rootston/text_input.h"
static struct roots_text_input *relay_get_focusable_text_input(
struct roots_input_method_relay *relay) {
struct roots_text_input *text_input = NULL;
wl_list_for_each(text_input, &relay->text_inputs, link) {
if (text_input->pending_focused_surface) {
return text_input;
}
}
return NULL;
}
static struct roots_text_input *relay_get_focused_text_input(
struct roots_input_method_relay *relay) {
struct roots_text_input *text_input = NULL;
wl_list_for_each(text_input, &relay->text_inputs, link) {
if (text_input->input->focused_surface) {
return text_input;
}
}
return NULL;
}
static void handle_im_commit(struct wl_listener *listener, void *data) {
struct roots_input_method_relay *relay = wl_container_of(listener, relay,
input_method_commit);
struct roots_text_input *text_input = relay_get_focused_text_input(relay);
if (!text_input) {
return;
}
struct wlr_input_method_v2 *context = data;
assert(context == relay->input_method);
if (context->current.preedit.text) {
wlr_text_input_v3_send_preedit_string(text_input->input,
context->current.preedit.text,
context->current.preedit.cursor_begin,
context->current.preedit.cursor_end);
}
if (context->current.commit_text) {
wlr_text_input_v3_send_commit_string(text_input->input,
context->current.commit_text);
}
if (context->current.delete.before_length
|| context->current.delete.after_length) {
wlr_text_input_v3_send_delete_surrounding_text(text_input->input,
context->current.delete.before_length,
context->current.delete.after_length);
}
wlr_text_input_v3_send_done(text_input->input);
}
static void text_input_set_pending_focused_surface(
struct roots_text_input *text_input, struct wlr_surface *surface) {
text_input->pending_focused_surface = surface;
wl_signal_add(&surface->events.destroy,
&text_input->pending_focused_surface_destroy);
}
static void text_input_clear_pending_focused_surface(
struct roots_text_input *text_input) {
wl_list_remove(&text_input->pending_focused_surface_destroy.link);
text_input->pending_focused_surface = NULL;
}
static void handle_im_destroy(struct wl_listener *listener, void *data) {
struct roots_input_method_relay *relay = wl_container_of(listener, relay,
input_method_destroy);
struct wlr_input_method_v2 *context = data;
assert(context == relay->input_method);
relay->input_method = NULL;
struct roots_text_input *text_input = relay_get_focused_text_input(relay);
if (text_input) {
// keyboard focus is still there, so keep the surface at hand in case
// the input method returns
text_input_set_pending_focused_surface(text_input,
text_input->input->focused_surface);
wlr_text_input_v3_send_leave(text_input->input);
}
}
static void relay_send_im_done(struct roots_input_method_relay *relay,
struct wlr_text_input_v3 *input) {
struct wlr_input_method_v2 *input_method = relay->input_method;
if (!input_method) {
wlr_log(WLR_INFO, "Sending IM_DONE but im is gone");
return;
}
// TODO: only send each of those if they were modified
wlr_input_method_v2_send_surrounding_text(input_method,
input->current.surrounding.text, input->current.surrounding.cursor,
input->current.surrounding.anchor);
wlr_input_method_v2_send_text_change_cause(input_method,
input->current.text_change_cause);
wlr_input_method_v2_send_content_type(input_method,
input->current.content_type.hint, input->current.content_type.purpose);
wlr_input_method_v2_send_done(input_method);
// TODO: pass intent, display popup size
}
static struct roots_text_input *text_input_to_roots(
struct roots_input_method_relay *relay,
struct wlr_text_input_v3 *text_input) {
struct roots_text_input *roots_text_input = NULL;
wl_list_for_each(roots_text_input, &relay->text_inputs, link) {
if (roots_text_input->input == text_input) {
return roots_text_input;
}
}
return NULL;
}
static void handle_text_input_enable(struct wl_listener *listener, void *data) {
struct roots_input_method_relay *relay = wl_container_of(listener, relay,
text_input_enable);
if (relay->input_method == NULL) {
wlr_log(WLR_INFO, "Enabling text input when input method is gone");
return;
}
struct roots_text_input *text_input = text_input_to_roots(relay,
(struct wlr_text_input_v3*)data);
wlr_input_method_v2_send_activate(relay->input_method);
relay_send_im_done(relay, text_input->input);
}
static void handle_text_input_commit(struct wl_listener *listener,
void *data) {
struct roots_input_method_relay *relay = wl_container_of(listener, relay,
text_input_commit);
struct roots_text_input *text_input = text_input_to_roots(relay,
(struct wlr_text_input_v3*)data);
if (!text_input->input->current_enabled) {
wlr_log(WLR_INFO, "Inactive text input tried to commit an update");
return;
}
wlr_log(WLR_DEBUG, "Text input committed update");
if (relay->input_method == NULL) {
wlr_log(WLR_INFO, "Text input committed, but input method is gone");
return;
}
relay_send_im_done(relay, text_input->input);
}
static void relay_disable_text_input(struct roots_input_method_relay *relay,
struct roots_text_input *text_input) {
if (relay->input_method == NULL) {
wlr_log(WLR_DEBUG, "Disabling text input, but input method is gone");
return;
}
wlr_input_method_v2_send_deactivate(relay->input_method);
relay_send_im_done(relay, text_input->input);
}
static void handle_text_input_disable(struct wl_listener *listener,
void *data) {
struct roots_input_method_relay *relay = wl_container_of(listener, relay,
text_input_disable);
struct roots_text_input *text_input = text_input_to_roots(relay,
(struct wlr_text_input_v3*)data);
if (!text_input->input->current_enabled) {
wlr_log(WLR_DEBUG, "Inactive text input tried to disable itself");
return;
}
relay_disable_text_input(relay, text_input);
}
static void handle_text_input_destroy(struct wl_listener *listener,
void *data) {
struct roots_input_method_relay *relay = wl_container_of(listener, relay,
text_input_destroy);
struct roots_text_input *text_input = text_input_to_roots(relay,
(struct wlr_text_input_v3*)data);
if (text_input->input->current_enabled) {
relay_disable_text_input(relay, text_input);
}
wl_list_remove(&text_input->link);
text_input->input = NULL;
free(text_input);
}
static void handle_pending_focused_surface_destroy(struct wl_listener *listener,
void *data) {
struct roots_text_input *text_input = wl_container_of(listener, text_input,
pending_focused_surface_destroy);
struct wlr_surface *surface = data;
assert(text_input->pending_focused_surface == surface);
text_input->pending_focused_surface = NULL;
}
struct roots_text_input *roots_text_input_create(
struct roots_input_method_relay *relay,
struct wlr_text_input_v3 *text_input) {
struct roots_text_input *input = calloc(1, sizeof(struct roots_text_input));
if (!input) {
return NULL;
}
input->input = text_input;
input->relay = relay;
wl_signal_add(&text_input->events.enable, &relay->text_input_enable);
relay->text_input_enable.notify = handle_text_input_enable;
wl_signal_add(&text_input->events.commit, &relay->text_input_commit);
relay->text_input_commit.notify = handle_text_input_commit;
wl_signal_add(&text_input->events.disable, &relay->text_input_disable);
relay->text_input_disable.notify = handle_text_input_disable;
wl_signal_add(&text_input->events.destroy, &relay->text_input_destroy);
relay->text_input_destroy.notify = handle_text_input_destroy;
input->pending_focused_surface_destroy.notify =
handle_pending_focused_surface_destroy;
return input;
}
static void relay_handle_text_input(struct wl_listener *listener,
void *data) {
struct roots_input_method_relay *relay = wl_container_of(listener, relay,
text_input_new);
struct wlr_text_input_v3 *wlr_text_input = data;
if (relay->seat->seat != wlr_text_input->seat) {
return;
}
struct roots_text_input *text_input = roots_text_input_create(relay,
wlr_text_input);
if (!text_input) {
return;
}
wl_list_insert(&relay->text_inputs, &text_input->link);
}
static void relay_handle_input_method(struct wl_listener *listener,
void *data) {
struct roots_input_method_relay *relay = wl_container_of(listener, relay,
input_method_new);
struct wlr_input_method_v2 *input_method = data;
if (relay->seat->seat != input_method->seat) {
return;
}
if (relay->input_method != NULL) {
wlr_log(WLR_INFO, "Attempted to connect second input method to a seat");
wlr_input_method_v2_send_unavailable(input_method);
return;
}
relay->input_method = input_method;
wl_signal_add(&relay->input_method->events.commit,
&relay->input_method_commit);
relay->input_method_commit.notify = handle_im_commit;
wl_signal_add(&relay->input_method->events.destroy,
&relay->input_method_destroy);
relay->input_method_destroy.notify = handle_im_destroy;
struct roots_text_input *text_input = relay_get_focusable_text_input(relay);
if (text_input) {
wlr_text_input_v3_send_enter(text_input->input,
text_input->pending_focused_surface);
text_input_clear_pending_focused_surface(text_input);
}
}
void roots_input_method_relay_init(struct roots_seat *seat,
struct roots_input_method_relay *relay) {
relay->seat = seat;
wl_list_init(&relay->text_inputs);
relay->text_input_new.notify = relay_handle_text_input;
wl_signal_add(&seat->input->server->desktop->text_input->events.text_input,
&relay->text_input_new);
relay->input_method_new.notify = relay_handle_input_method;
wl_signal_add(
&seat->input->server->desktop->input_method->events.input_method,
&relay->input_method_new);
}
void roots_input_method_relay_set_focus(struct roots_input_method_relay *relay,
struct wlr_surface *surface) {
struct roots_text_input *text_input;
wl_list_for_each(text_input, &relay->text_inputs, link) {
if (text_input->pending_focused_surface) {
assert(text_input->input->focused_surface == NULL);
if (surface != text_input->pending_focused_surface) {
text_input_clear_pending_focused_surface(text_input);
}
} else if (text_input->input->focused_surface) {
assert(text_input->pending_focused_surface == NULL);
if (surface != text_input->input->focused_surface) {
relay_disable_text_input(relay, text_input);
wlr_text_input_v3_send_leave(text_input->input);
}
} else if (surface
&& wl_resource_get_client(text_input->input->resource)
== wl_resource_get_client(surface->resource)) {
if (relay->input_method) {
wlr_text_input_v3_send_enter(text_input->input, surface);
} else {
text_input_set_pending_focused_surface(text_input, surface);
}
}
}
}