Skip to content
This repository has been archived by the owner on Nov 1, 2021. It is now read-only.

Implement input_method_v2 popups #2550

Merged
merged 2 commits into from
Sep 22, 2021
Merged

Implement input_method_v2 popups #2550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b8afd2
input-method-unstable-v2: Add error for surface with existing role
tadeokondrak Dec 30, 2020
1a8c3a2
Implement input_method_v2 popups
tadeokondrak Dec 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions include/wlr/types/wlr_input_method_v2.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
#include <stdlib.h>
#include <wayland-server-core.h>
#include <wlr/types/wlr_seat.h>
#include <wlr/util/box.h>

struct wlr_input_method_v2_preedit_string {
char *text;
Expand Down Expand Up @@ -42,6 +43,7 @@ struct wlr_input_method_v2 {
bool client_active; // state known to the client
uint32_t current_serial; // received in last commit call

struct wl_list popup_surfaces;
struct wlr_input_method_keyboard_grab_v2 *keyboard_grab;

struct wl_list link;
Expand All @@ -50,11 +52,31 @@ struct wlr_input_method_v2 {

struct {
struct wl_signal commit; // (struct wlr_input_method_v2*)
struct wl_signal new_popup_surface; // (struct wlr_input_popup_surface_v2*)
struct wl_signal grab_keyboard; // (struct wlr_input_method_keyboard_grab_v2*)
struct wl_signal destroy; // (struct wlr_input_method_v2*)
} events;
};

struct wlr_input_popup_surface_v2 {
struct wl_resource *resource;
struct wlr_input_method_v2 *input_method;
struct wl_list link;
bool mapped;

struct wlr_surface *surface;

struct wl_listener surface_destroy;

struct {
struct wl_signal map;
struct wl_signal unmap;
struct wl_signal destroy;
} events;

void *data;
};

struct wlr_input_method_keyboard_grab_v2 {
struct wl_resource *resource;
struct wlr_input_method_v2 *input_method;
Expand Down Expand Up @@ -100,6 +122,12 @@ 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);

bool wlr_surface_is_input_popup_surface_v2(struct wlr_surface *surface);
struct wlr_input_popup_surface_v2 *wlr_input_popup_surface_v2_from_wlr_surface(
struct wlr_surface *surface);
void wlr_input_popup_surface_v2_send_text_input_rectangle(
struct wlr_input_popup_surface_v2 *popup_surface, struct wlr_box *sbox);

void wlr_input_method_keyboard_grab_v2_send_key(
struct wlr_input_method_keyboard_grab_v2 *keyboard_grab,
uint32_t time, uint32_t key, uint32_t state);
Expand Down
8 changes: 2 additions & 6 deletions include/wlr/types/wlr_text_input_v3.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
#include <wayland-server-core.h>
#include <wlr/types/wlr_seat.h>
#include <wlr/types/wlr_surface.h>
#include <wlr/util/box.h>

enum wlr_text_input_v3_features {
WLR_TEXT_INPUT_V3_FEATURE_SURROUNDING_TEXT = 1 << 0,
Expand All @@ -33,12 +34,7 @@ struct wlr_text_input_v3_state {
uint32_t purpose;
} content_type;

struct {
int32_t x;
int32_t y;
int32_t width;
int32_t height;
} cursor_rectangle;
struct wlr_box cursor_rectangle;

// Tracks which features were used in the current commit.
// Useful in the enabling commit, where usage means support.
Expand Down
4 changes: 4 additions & 0 deletions protocol/input-method-unstable-v2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@
There must be no more than one input method object per seat.
</description>

<enum name="error">
<entry name="role" value="0" summary="wl_surface has another role"/>
</enum>

<event name="activate">
<description summary="input method has been requested">
Notification that a text input focused on this seat requested the input
Expand Down
144 changes: 142 additions & 2 deletions types/wlr_input_method_v2.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
static const struct zwp_input_method_v2_interface input_method_impl;
static const struct zwp_input_method_keyboard_grab_v2_interface keyboard_grab_impl;

static void popup_surface_destroy(
struct wlr_input_popup_surface_v2 *popup_surface);

static struct wlr_input_method_v2 *input_method_from_resource(
struct wl_resource *resource) {
assert(wl_resource_instance_of(resource,
Expand All @@ -33,6 +36,11 @@ static struct wlr_input_method_keyboard_grab_v2 *keyboard_grab_from_resource(
}

static void input_method_destroy(struct wlr_input_method_v2 *input_method) {
struct wlr_input_popup_surface_v2 *popup_surface, *tmp;
wl_list_for_each_safe(
popup_surface, tmp, &input_method->popup_surfaces, link) {
popup_surface_destroy(popup_surface);
}
wlr_signal_emit_safe(&input_method->events.destroy, input_method);
wl_list_remove(wl_resource_get_link(input_method->resource));
wl_list_remove(&input_method->seat_client_destroy.link);
Expand Down Expand Up @@ -108,10 +116,134 @@ static void im_delete_surrounding_text(struct wl_client *client,
input_method->pending.delete.after_length = after_length;
}

struct wlr_input_popup_surface_v2 *wlr_input_popup_surface_v2_from_wlr_surface(
struct wlr_surface *surface) {
assert(wlr_surface_is_input_popup_surface_v2(surface));
return (struct wlr_input_popup_surface_v2 *)surface->role_data;
}

void wlr_input_popup_surface_v2_send_text_input_rectangle(
struct wlr_input_popup_surface_v2 *popup_surface,
struct wlr_box *sbox) {
zwp_input_popup_surface_v2_send_text_input_rectangle(
popup_surface->resource, sbox->x, sbox->y, sbox->width, sbox->height);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Protocol issue: the compositor has no way to know when the client has taken this new information into account. Thus the compositor might draw an old buffer at a new position, resulting in a glitch.

}

static void popup_surface_set_mapped(
struct wlr_input_popup_surface_v2 *popup_surface, bool mapped) {
if (mapped && !popup_surface->mapped) {
popup_surface->mapped = true;
wlr_signal_emit_safe(&popup_surface->events.map, popup_surface);
} else if (!mapped && popup_surface->mapped) {
wlr_signal_emit_safe(&popup_surface->events.unmap, popup_surface);
popup_surface->mapped = false;
}
}

static void popup_surface_surface_role_commit(struct wlr_surface *surface) {
struct wlr_input_popup_surface_v2 *popup_surface = surface->role_data;
if (popup_surface == NULL) {
return;
}
popup_surface_set_mapped(popup_surface, wlr_surface_has_buffer(surface)
&& popup_surface->input_method->client_active);
}

static const struct wlr_surface_role input_popup_surface_v2_role = {
.name = "zwp_input_popup_surface_v2",
.commit = popup_surface_surface_role_commit,
};

bool wlr_surface_is_input_popup_surface_v2(struct wlr_surface *surface) {
return surface->role == &input_popup_surface_v2_role;
}

static void popup_surface_destroy(
struct wlr_input_popup_surface_v2 *popup_surface) {
popup_surface_set_mapped(popup_surface, false);
wlr_signal_emit_safe(&popup_surface->events.destroy, NULL);
wl_list_remove(&popup_surface->surface_destroy.link);
wl_list_remove(&popup_surface->link);
wl_resource_set_user_data(popup_surface->resource, NULL);
free(popup_surface);
tadeokondrak marked this conversation as resolved.
Show resolved Hide resolved
}

static void popup_surface_handle_surface_destroy(struct wl_listener *listener,
void *data) {
struct wlr_input_popup_surface_v2 *popup_surface =
wl_container_of(listener, popup_surface, surface_destroy);
popup_surface_destroy(popup_surface);
}

static void popup_resource_destroy(struct wl_resource *resource) {
struct wlr_input_popup_surface_v2 *popup_surface =
wl_resource_get_user_data(resource);
if (popup_surface == NULL) {
return;
}
popup_surface_destroy(popup_surface);
}

static void popup_destroy(struct wl_client *client,
struct wl_resource *resource) {
wl_resource_destroy(resource);
}

static const struct zwp_input_popup_surface_v2_interface input_popup_impl = {
.destroy = popup_destroy,
};

static void im_get_input_popup_surface(struct wl_client *client,
struct wl_resource *resource, uint32_t id,
struct wl_resource *surface) {
wlr_log(WLR_INFO, "Stub: zwp_input_method_v2::get_input_popup_surface");
struct wl_resource *surface_resource) {
struct wlr_input_method_v2 *input_method =
input_method_from_resource(resource);
if (!input_method) {
return;
}

struct wl_resource *popup_resource = wl_resource_create(
tadeokondrak marked this conversation as resolved.
Show resolved Hide resolved
client, &zwp_input_popup_surface_v2_interface,
wl_resource_get_version(resource), id);
if (!popup_resource) {
wl_client_post_no_memory(client);
return;
}

struct wlr_input_popup_surface_v2 *popup_surface =
calloc(1, sizeof(struct wlr_input_popup_surface_v2));
if (!popup_surface) {
wl_client_post_no_memory(client);
return;
}
wl_resource_set_implementation(popup_resource, &input_popup_impl,
popup_surface, popup_resource_destroy);

struct wlr_surface *surface = wlr_surface_from_resource(surface_resource);
if (!wlr_surface_set_role(surface, &input_popup_surface_v2_role,
popup_surface, resource, ZWP_INPUT_METHOD_V2_ERROR_ROLE)) {
free(popup_surface);
return;
}

popup_surface->resource = popup_resource;
popup_surface->input_method = input_method;
popup_surface->surface = surface;
wl_signal_add(&popup_surface->surface->events.destroy,
&popup_surface->surface_destroy);
popup_surface->surface_destroy.notify =
popup_surface_handle_surface_destroy;

wl_signal_init(&popup_surface->events.map);
wl_signal_init(&popup_surface->events.unmap);
wl_signal_init(&popup_surface->events.destroy);

popup_surface_set_mapped(popup_surface,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we allow already-mapped surfaces? I guess the protocol allows them, and disallowing them would be a breaking change. But before getting the text input box, the client can't really know how to draw the popup.

wlr_surface_has_buffer(popup_surface->surface)
&& popup_surface->input_method->client_active);

wl_list_insert(&input_method->popup_surfaces, &popup_surface->link);
wlr_signal_emit_safe(&input_method->events.new_popup_surface, popup_surface);
}

void wlr_input_method_keyboard_grab_v2_destroy(
Expand Down Expand Up @@ -351,6 +483,12 @@ void wlr_input_method_v2_send_done(struct wlr_input_method_v2 *input_method) {
zwp_input_method_v2_send_done(input_method->resource);
input_method->client_active = input_method->active;
input_method->current_serial++;
struct wlr_input_popup_surface_v2 *popup_surface;
wl_list_for_each(popup_surface, &input_method->popup_surfaces, link) {
popup_surface_set_mapped(popup_surface,
wlr_surface_has_buffer(popup_surface->surface) &&
input_method->client_active);
}
}

void wlr_input_method_v2_send_unavailable(
Expand Down Expand Up @@ -390,7 +528,9 @@ static void manager_get_input_method(struct wl_client *client,
wl_client_post_no_memory(client);
return;
}
wl_list_init(&input_method->popup_surfaces);
wl_signal_init(&input_method->events.commit);
wl_signal_init(&input_method->events.new_popup_surface);
wl_signal_init(&input_method->events.grab_keyboard);
wl_signal_init(&input_method->events.destroy);
int version = wl_resource_get_version(resource);
Expand Down