wayland: input method protocol by CMurtagh-LGTM · Pull Request #195 · quickshell-mirror/quickshell

CMurtagh-LGTM · 2025-08-22T17:27:35Z

~~Popup surface~~ This PR is already large, will add in future PR.
Handle surrounding_text, text_change_cause and content_type events somehow.
Key repeat
Documentation

~~Do we want to also expose the virtual keyboard so people can create their own clients?~~

Popup surface and qml virtual keyboard will be in future PRs.

outfoxxed · 2025-09-03T06:02:07Z

~~Exposing virtual keyboard would be a good idea, but as a separate PR.~~
Oh I see it was added. Is this ready for review?

CMurtagh-LGTM · 2025-09-03T06:50:38Z

I still need to do a couple things - especially documentation. I'll add the popup screen and exposing virtual keyboard in future prs since this one is already quite large.

CMurtagh-LGTM · 2025-11-17T03:41:39Z

Sorry I haven't updated in a while.
This pull request is good to go.

I have a separate branch that I have been working on the adding the popup surface functionality however it looks like I need to use the private qt headers, which I have not yet been able to work out.

outfoxxed · 2025-11-18T05:04:47Z

Looks like CI is broken here, can you rebase on master? For private qt headers you should just be able to import them if you add a dependency on the private qt module.

outfoxxed

Reviewed most of it that didn't seem likely to greatly change. It would also be useful if you included a couple tests. They dont have to be complex or automatic, just some QML files we can run to make sure its still working.

outfoxxed · 2025-11-21T06:58:56Z

Why is this protocol included directly instead of from w-p?

It is kind of confusing as there are three versions of input-method floating around.

zwp_input_method_v1 - unstable

xx_input_method_v1 - experimental

zwp_input_method_v2 - external
Hyprland uses zwp_input_method_v2 so I went with that one.
zwp_input_method_v2 is not included in Wayland protocols.

I'd gotten it confused with xx-input since they seem pretty similar in most respects. Diffed them and it looks like xx can't grab the keyboard properly and zwp v2 can't position its surface properly. Beautiful.

Fine to vendor it then I guess

outfoxxed · 2025-11-21T09:13:18Z

Might be better to split this

Include from w-p instead?

I'm unsure what you mean by "split this".

This protocol is not inside Wayland protocols unfortunately.

It seems pretty independent from input method and looks like it makes sense to pr separately and not in the input method dir

Unfortunate, fine to vendor then

CMurtagh-LGTM

I still need to have a look at adding qml test files.

CMurtagh-LGTM · 2025-12-03T00:02:36Z

It is kind of confusing as there are three versions of input-method floating around.

zwp_input_method_v1 - unstable

xx_input_method_v1 - experimental

zwp_input_method_v2 - external
Hyprland uses zwp_input_method_v2 so I went with that one.
zwp_input_method_v2 is not included in Wayland protocols.

CMurtagh-LGTM · 2025-12-03T00:05:07Z

+void InputMethodHandle::zwp_input_method_v2_unavailable() {
+	if (!this->mAvailable) return;
+	this->mAvailable = false;
+	InputMethodManager::instance()->releaseInput();
+	qDebug()
+	    << "Compositor denied input method request, likely due to one already existing elsewhere";
+}


I don't know of a better way to report it than a log message.

CMurtagh-LGTM · 2025-12-03T00:09:30Z

I'm unsure what you mean by "split this".

This protocol is not inside Wayland protocols unfortunately.

CMurtagh-LGTM · 2025-12-04T02:45:35Z

+void InputMethodKeyboardGrab::zwp_input_method_keyboard_grab_v2_keymap(
+    uint32_t format [[maybe_unused]],
+    int32_t fd,
+    uint32_t size
+) {
+	// https://wayland-book.com/seat/example.html
+	assert(format == WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1);
+
+	char* mapShm = static_cast<char*>(mmap(nullptr, size, PROT_READ, MAP_PRIVATE, fd, 0));
+	assert(mapShm != MAP_FAILED);
+
+	this->mKeyMapState = KeyMapState(mapShm);
+
+	munmap(mapShm, size);
+	close(fd);
+
+	this->mVirturalKeyboard =
+	    VirtualKeyboardManager::instance()->createVirtualKeyboard(this->mKeyMapState);
+	this->mKeyState = std::vector<KeyState>(
+	    this->mKeyMapState.maxKeycode() - this->mKeyMapState.minKeycode() - WAYLAND_KEY_OFFSET,
+	    KeyState::RELEASED
+	);
+
+	// Tell the text input to release all the keys
+	for (xkb_keycode_t key = 0; key < this->mKeyState.size(); ++key) {
+		this->mVirturalKeyboard->sendKey(
+		    key + this->mKeyMapState.minKeycode(),
+		    WL_KEYBOARD_KEY_STATE_RELEASED
+		);
+	}
+}


I had a look at the private header QXkbCommon, it doesn't have any functions that would be useful here.

If you think there is a particular function I should be using then please tell me.

outfoxxed · 2025-12-13T10:43:42Z

Responded inline to the comments above but github seems to have eaten them. They're in the files still

CMurtagh-LGTM · 2026-01-23T13:00:01Z

This protocol is likely to change in the future, I'd prefer to wait for things to settle down before merging something in.
See https://gitlab.freedesktop.org/wayland/wayland-protocols/-/merge_requests/405.

CMurtagh-LGTM force-pushed the cmurtagh/inputmethod branch from f07a697 to d92ced5 Compare August 24, 2025 10:30

outfoxxed force-pushed the master branch from df77d21 to 6eb1255 Compare September 4, 2025 10:21

CMurtagh-LGTM force-pushed the cmurtagh/inputmethod branch 2 times, most recently from b265756 to 7054e2d Compare September 5, 2025 05:18

CMurtagh-LGTM marked this pull request as ready for review September 5, 2025 05:36

outfoxxed force-pushed the master branch from c123799 to e9a574d Compare September 19, 2025 09:16

outfoxxed force-pushed the master branch 3 times, most recently from a92879d to 9bb2c04 Compare October 4, 2025 20:00

CMurtagh-LGTM added 3 commits November 19, 2025 12:03

wayland: input method protocol

a02513e

lint errors

2e3ebd6

add some more <cstdint>

c7ed0c2

CMurtagh-LGTM force-pushed the cmurtagh/inputmethod branch from 44f8232 to c7ed0c2 Compare November 19, 2025 01:04

CMurtagh-LGTM added 2 commits November 20, 2025 14:32

this->

5979012

Perhaps fix 6.6.0 gcc build

79ed7ee

outfoxxed requested changes Nov 21, 2025

View reviewed changes

CMurtagh-LGTM commented Dec 7, 2025

View reviewed changes

CMurtagh-LGTM added 5 commits December 7, 2025 17:44

Respond to review

8c35f43

format

fc4b417

fix lint errors

c28911e

add test qml file

404f11e

fix lint errors

0d33d7c

outfoxxed force-pushed the master branch 2 times, most recently from 08c7fc2 to bcc3d42 Compare January 10, 2026 21:24

CMurtagh-LGTM closed this Jan 23, 2026

Conversation

CMurtagh-LGTM commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

outfoxxed commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CMurtagh-LGTM commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CMurtagh-LGTM commented Nov 17, 2025

Uh oh!

outfoxxed commented Nov 18, 2025

Uh oh!

outfoxxed left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CMurtagh-LGTM left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

outfoxxed commented Dec 13, 2025

Uh oh!

CMurtagh-LGTM commented Jan 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

CMurtagh-LGTM commented Aug 22, 2025 •

edited

Loading

outfoxxed commented Sep 3, 2025 •

edited

Loading

CMurtagh-LGTM commented Sep 3, 2025 •

edited

Loading