[WIP] On-screen keyboard support #892

dcz-purism · Apr 23, 2018

This pull request combines work on:

input-method protocol #856
text-input protocol #776
rootston glue

Its purpose is to develop these in sync, and to remove the need to juggle different long-running feature branches as different parts are being developed. This has proven to take up effort and lead to awkward situations, e.g. many of the rebased rootston commits were developed against an earlier version of wlr_input_method.h and are currently unbuildable.

One interesting thing is the addition of code duplicating some functionality of layer surfaces (panels, unfocusable windows) in rootston views, in order to support input-method-panel.

ddevault · Apr 23, 2018

ddevault reviewed Apr 23, 2018

View changes

ddevault · Apr 23, 2018

include/rootston/osk.c

+	panel->panel = wl_global_create(display, &zwp_input_panel_v1_interface, 1,
+		panel, input_panel_bind);
+	return panel;
+}


This should not be named osk.c, input-method supports more than OSKs

agx · Apr 23, 2018

Now that we have layer-surfaces can't OSK use just that?

dcz-purism · Apr 23, 2018

@agx: I wanted to have a reasonably complete implementation of the existing protocol first, especially because all existing software, namely weston-keyboard uses it. The plan is to update the protocol and remove the panel in its current form in favor of layer-surfaces in the future.

agx · Apr 23, 2018

@dcz-purism with existing you mean weston-keyboard using zwp_input_panel_surface_v1 ?
Looking at the protocol the panel part looks pretty much bolted onto generic input_method stuff.

ddevault · Apr 23, 2018

ddevault requested changes Apr 23, 2018

View changes

I'll come back around for another round of review when input-method is disentangled from rootston views

ddevault · Apr 23, 2018

include/rootston/osk.c

+
+struct roots_input_panel *roots_input_panel_create(struct wl_display *display) {
+	struct roots_input_panel *panel = calloc(1,
+											 sizeof(struct roots_input_panel));


ddevault · Apr 23, 2018

include/rootston/osk.c

+
+#include "input-method-unstable-v1-protocol.h"
+
+static void noop() {}


Add newlines and such and something to the effect of /* This space deliberately left blank */

ddevault · Apr 23, 2018

include/rootston/osk.h

+#include "rootston/desktop.h"
+
+struct roots_input_panel {
+	struct roots_desktop *desktop; // FIXME - remove when views come


If you expect this TODO to get merged, can you elaborate a bit? If you will resolve prior to merge no worries

ddevault · Apr 23, 2018

include/rootston/text_input.h

+    struct wlr_text_input *input;
+	struct wlr_input_method_context *context;
+
+    struct wl_list link;


Wrong indent here and sprinkled throughout this struct

ddevault · Apr 23, 2018

include/rootston/text_input.h

+	struct wlr_input_method_context *context;
+
+    struct wl_list link;
+	struct wl_listener text_input_enable; // uint32_t show_input_panel


Put the docs near the signal, not the listener

ddevault · Apr 23, 2018

include/wlr/types/wlr_input_method.h

+	struct wl_resource *resource;
+	struct {
+		struct wl_signal new_context; // struct wlr_input_method_context*
+		// TODO: create roots_keyboard (seat_add_keyboard) on this; modify roots_keyboard to support backend-less


I think this should be more along the lines of wlr_input_method creating a wlr_keyboard which roots_keyboard should just be able to pick up without changes. Maybe some silly changes to automatically associate it with the relevant seat if wlr_keyboard_is_input_method returns true.

I think this is what I did but forgot to update the comment. Thanks for the seat input.

ddevault · Apr 23, 2018

include/wlr/types/wlr_input_method.h

+
+void wlr_input_method_send_deactivate(struct wlr_input_method *input_method,
+	struct wlr_input_method_context *context);
+#endif


minor nit: extra newline above the #endif

ddevault · Apr 23, 2018

rootston/cursor.c

-			roots_seat_set_focus(seat, view);
+			if (!view || !view->special || view->features.focusable) {
+				roots_seat_set_focus(seat, view);
+            }


Weird indent

ddevault · Apr 23, 2018

rootston/desktop.c

+	view->x = x;
+	view->y = y;
+	view_damage_whole(view);
+}


Yeah all of this stuff can go if you don't try to hack it into views.

I'll be slow to address it, but it will get addressed eventually. I want to keep the whole stack working at any time, so I'll get rid of the current panel implementation once there's a keyboard that doesn't use it. It probably means implementing it on my own, so it will take time.

ddevault · Apr 23, 2018

rootston/input.c

@@ -43,7 +43,7 @@ struct roots_seat *input_get_seat(struct roots_input *input, char *name) {
 	return seat;
 }

-static void handle_new_input(struct wl_listener *listener, void *data) {
+void handle_new_input(struct wl_listener *listener, void *data) {


dcz-purism · Apr 23, 2018

@agx: yes, it's using input-method-panel-surface, which is definitely bolted, but it covers some things that layer-shell doesn't:

<SirCmpwn> input-method popups are shown by the compositor near the cursor of the client with keyboard focus
<SirCmpwn> xdg-shell and layer-shell popups are shown where the client asks them to be

and also the function of keyboards that they may need to be visible even when the lock screen is active.

Shugyousha · Apr 23, 2018

Shugyousha reviewed Apr 23, 2018

View changes

Mostly superficial things

Shugyousha · Apr 23, 2018

rootston/output.c

@@ -333,6 +336,9 @@ static bool has_standalone_surface(struct roots_view *view) {
 	case ROOTS_XWAYLAND_VIEW:
 		return wl_list_empty(&view->xwayland_surface->children);
 #endif
+	case ROOTS_INPUT_PANEL_VIEW:
+		printf("Stub: has_standalone_surface on OSK_VIEV returns true\n");
+		return true;


The printed text should be updated to correspond to the constant. There is also a typo in the current text (s/OSK_VIEV/OSK_VIEW/).

What's a standalone surface here?

It's used for fullscreen to know if the view has only one surface.

Shugyousha · Apr 23, 2018

rootston/seat.c

-		first_seat_view->link.next, next_seat_view, link);
+	// Focus the next view which is focusable
+	struct roots_seat_view *next_seat_view = first_seat_view;;
+	do {


Shugyousha · Apr 23, 2018

types/wlr_text_input.c

+	}
+	if (text_input->pending.surrounding.text) {
+		free(text_input->pending.surrounding.text);
+	}


Since free(NULL) is a noop, we don't need these two "if" statements here.

Shugyousha · Apr 23, 2018

types/wlr_text_input.c

+	if (text_input->pending.surrounding.text) {
+		free(text_input->pending.surrounding.text);
+	}
+	text_input->pending.surrounding.text = strdup(text);


Shugyousha · Apr 23, 2018

types/wlr_text_input.c

+	if (text_input->current.surrounding.text) {
+		free(text_input->pending.surrounding.text);
+	}
+	text_input->current = text_input->pending;


Shugyousha · Apr 23, 2018

types/wlr_text_input.c

+struct wlr_text_input_manager *wlr_text_input_manager_create(
+		struct wl_display *wl_display) {
+	struct wlr_text_input_manager *manager =
+		calloc(1, sizeof(struct wlr_text_input_manager));


Add out of memory check

agx · Apr 24, 2018

@dcz-purism my main concern is growing a third way to handle popups and overlay surfaces. layer-shell already has overlap with views and it would be nice if either one could be reused.

agx · Apr 26, 2018

agx reviewed Apr 26, 2018

View changes

agx · Apr 26, 2018

examples/text-input.c

+
+/**
+ * Usage: idle-inhibit
+ * Creates a xdg-toplevel using the idle-inhibit protocol.


It's rather text-input and does s.th. different?

Thanks. I didn't realize this push would send out notifications.

agx · Apr 26, 2018

agx reviewed Apr 26, 2018

View changes

agx · Apr 26, 2018

rootston/input_method.c

+	*im_pid = fork();
+	if (*im_pid == 0) {
+		sleep(1);
+		execl("/bin/sh", "/bin/sh", "-c", im_cmd, (void *)NULL);


Why does it need a shell?

The -E option pipes the command through a shell, so in order to maintain consistency, I made it the same. Personally, I don't see the need for a shell in either case, but maybe I'm missing something.

agx · Apr 27, 2018

On Thu, Apr 26, 2018 at 09:22:57PM +0000, dcz-purism wrote: dcz-purism commented on this pull request. > @@ -134,3 +144,55 @@ void handle_input_method_context_destroy(struct wl_listener *listener, } update_maximized_views(desktop); } + +static void spawn_im_process() { + *im_pid = fork(); + if (*im_pid == 0) { + sleep(1); + execl("/bin/sh", "/bin/sh", "-c", im_cmd, (void *)NULL); The -E command accepts a shell, so in order to maintain consistency, I made it the same. Personally, I don't see the need for a shell in either case, but maybe I'm missing something.

Shell uses $PATH but I'd rather not rely on that for the OSK.

agx · Apr 27, 2018

agx reviewed Apr 27, 2018

View changes

agx · Apr 27, 2018

include/rootston/text_input.h

+
+	bool enabled; // client requested state
+	bool sent_enter; // server requested state
+	bool active; // active focus


nitpick: Indentation is off here

ddevault · Jul 29, 2018

How're are things in this department going on your end? Should we expect an update to this soon?

dcz-purism · Jul 29, 2018

Yes indeed! Currently I'm busy upstreaming text-input to GTK, so after the merge window closes and I'm free to do other things again, I'll push my changes to get some formal feedback.

ddevault · Jul 29, 2018

Sweet, keep up the good work!

dcz-purism · Aug 6, 2018

The first replacement of the old input method was just posted to gather feedback today:

https://lists.freedesktop.org/archives/wayland-devel/2018-August/039255.html

dcz-purism · Aug 29, 2018

I rewrote this code to updated protocols and submitted it as a separate (out of forgetfulness) PR here.

This was referenced Apr 23, 2018

Closed

input-method protocol #856

Closed

WIP: Add partial support for zwp_text_input_unstable_v3 #776

Fix comment on text-input example

680949d

agx changed the title from WIP: On-screen keyboard support to [WIP] On-screen keyboard support Apr 27, 2018

ddevault referenced this pull request May 27, 2018
Merged
Support virtual keyboard protocol #999

dcz-purism closed this Aug 29, 2018

swaywm/wlroots

Join GitHub today

[WIP] On-screen keyboard support #892

Conversation

dcz-purism commented Apr 23, 2018

dcz-purism added some commits Mar 29, 2018

This was referenced Apr 23, 2018

ddevault reviewed Apr 23, 2018 View changes

This comment has been minimized.

This comment has been minimized.

agx commented Apr 23, 2018

This comment has been minimized.

dcz-purism commented Apr 23, 2018

This comment has been minimized.

agx commented Apr 23, 2018 • edited

ddevault requested changes Apr 23, 2018 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

dcz-purism commented Apr 23, 2018

Shugyousha reviewed Apr 23, 2018 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

agx commented Apr 24, 2018

dcz-purism added some commits Apr 11, 2018

agx reviewed Apr 26, 2018 View changes

This comment has been minimized.

This comment has been minimized.

agx reviewed Apr 26, 2018 View changes

This comment has been minimized.

This comment has been minimized.

dcz-purism Apr 26, 2018 • edited

This comment has been minimized.

agx commented Apr 27, 2018

agx changed the title from WIP: On-screen keyboard support to [WIP] On-screen keyboard support Apr 27, 2018

agx reviewed Apr 27, 2018 View changes

This comment has been minimized.

ddevault referenced this pull request May 27, 2018

This comment has been minimized.

ddevault commented Jul 29, 2018

This comment has been minimized.

dcz-purism commented Jul 29, 2018

This comment has been minimized.

ddevault commented Jul 29, 2018

This comment has been minimized.

dcz-purism commented Aug 6, 2018

This comment has been minimized.

dcz-purism commented Aug 29, 2018

dcz-purism closed this Aug 29, 2018

ddevault reviewed Apr 23, 2018

View changes

agx commented Apr 23, 2018 •

edited

ddevault requested changes Apr 23, 2018

View changes

Shugyousha reviewed Apr 23, 2018

View changes

agx reviewed Apr 26, 2018

View changes

agx reviewed Apr 26, 2018

View changes

dcz-purism Apr 26, 2018 •

edited

agx reviewed Apr 27, 2018

View changes