the input-method and the text-input protocols we end up with an endless loop when I run the text-input example from wlroots.

My understand is your patch still does not work.
Unfortunately Fedora does not provide v2 and I don't evaluate it yet.

I think weston-editor can be a test application of Wayland protocol but not sure if text-input v3 can be used.
You may be better to find applications in Sway desktop which desktop may support it?

Not sure if that could help, but there's a small example of input-method-v2 impl https://github.com/emersion/wlhangul.
As for text-input-v3 gedit handles it quite fine, at least it sets surrounding text, ime window position, etc.

v3 is old enough....

Check https://github.com/swaywm/wlroots/blob/master/include/wlr/types/wlr_text_input_v3.h

I thought GTK used their own dbus protocol and not the Wayland one. I
could very well be wrong about this though.

You can clearly see that in WAYLAND_DEBUG=1 that something like gedit bindings and uses text-input-v3. Also, you may be required to use GTK_IM_MODULE=wayland for that, though, even on GNOME it was using text-input-v3.

I have adjusted the approach closer to how wlhangul is implementing these protocols. To do that I also had to implement handling of the virtual-keyboard-unstable-v1 protocol in the ibus client and apply the patches that implement this protocol in Sway for testing (as described in the wlhangul README ). Note that you will have to do the same to debug/test this code.

The current state is that regular keyboard input is just being passed unchanged through the ibus-wayland client and the protocol seems to be implemented the correct way (meaning I at least don't get any endless loop that continually increases the serial anymore). The two remaining major issues are:

1. I cannot get ibus to actually handle the key presses that I pass to it. I don't know if that is because I'm missing some function call or if my approach is completely wrong.
2. From what I understand I should pass the surrounding text sent by the text-input client(s) to the ibus core (the actual IME functionality) and send key presses that we get through the virtual keyboard grab to it as well. This is what I am trying to do in the code but IBus doesn't seem to want to handle the key presses that I send to it (see 1.). The Korean input method library that wlhangul is using returns the preedit and the commit text which wlhangul then sends back to the text-input client. I'm struggling to get ibus to give me the preedit and/or commit text in the same way because according to the ibus library documentation there is no synchronous way to get the preedit and/or commit strings that the ibus core is processing. IBus only provides you with signal callback functions that you can implement and these are called asynchronously which means we don't know when they are being called. If we don't know when they are being called, I don't think we are able to send these strings when we should according to the protocol spec.

Any info on how I can get ibus to handle the key presses that I send to it (see the ibus_input_context_process_key_event call in the code that I have added) and/or how I can get the commit/preedit strings (ideally in a synchronous way) from it would be highly appreciated!

Hello @Shugyousha,

I've also encountered this shortcoming of ibus and would like to contribute to a solution. I tried applying this pull request as a patch to the current master branch, but it seems like the files

• virtual-keyboard-unstable-v1-protocol.h
• virtual-keyboard-unstable-v1-protocol.c

are missing. I take it they are automatically generated from the XML-based protocol definitions. Shouldn't they, like the other code, also be included in the pull request?

Regards

I think I have now included all the files needed to build this.

Let me know if you run into any other issues!

Is there something that continues to hold this into draft status? Also, this should be rebased so it switches from Travis CI to GitHub Actions.

I appreciate any contributors to work and test on the patches in the actual desktop likes wlroot desktop.
V2 is still not an official protocol in wayland-protocols.

Working on #2695 and closing this issue.

Do you know how to make a panel applet for IBus in the Sway session?
swaybar may be used but not sure.

It would be nice if the GTK one could be ported to use StatusNotifier (for the panel applet) and layer shell for the candidate choices overlay but I don't know how feasible that is:
https://github.com/wmww/gtk4-layer-shell

I currently use ibus in KDE Plasma which works remarkably well but the GTK applet and candidate choices overlay is all going over XWayland still. I really like ibus over fcitx but its Wayland support is definitely in need of some polish.

input-method-v2 doesn't use layer-shell, it has its own popup surfaces

Working on #2695 and closing this issue.

Many thanks for your work on this!

Do you know how to make a panel applet for IBus in the Sway session? swaybar may be used but not sure.

According to https://man.archlinux.org/man/swaybar-protocol.7, swaybar doesn't support images (or interaction?). It would be possible to show the current state of ibus in text form though, I assume.

An alternative would be Waybar that also allows for images to be shown.

Not sure an applet is desirable for a tiling WM like Sway. If there is demand for it, I would assume that somebody will come up with a Waybar module or something else for ibus :P

Do you know how to make a panel applet for IBus in the Sway session?

SNI tray icon is not acceptable for some reason?

Thank you for the comments.
There are two problems at present.

V1 works with zwp_input_panel_surface_v1_set_overlay_panel() and V2 works with zwp_input_method_v2_get_input_popup_surface() but whenever I close the IBus candidate popup window, IBus gets
the disconnection from the Wayland display with an error of "surface was destroyed before its role object" in V2 and I'm not sure how to destroy the role object.

[4205273.958] {Default Queue} zwp_input_method_keyboard_grab_v2#40.key(2966, 1111139, 1, 0)
[4205275.639] {Default Queue}  -> zwp_virtual_keyboard_v1#35.key(1111139, 1, 0)
[4205276.643] {Default Queue}  -> wl_surface#44.destroy()
[4205276.687] {Default Queue}  -> wl_buffer#47.destroy()
[4205276.694] {Default Queue}  -> wl_shm_pool#46.destroy()
[4205282.894] {Display Queue} wl_display#1.error(nil, 4, "surface was destroyed before its role object")
Gdk-Message: Error 71 (Protocol error) dispatching to Wayland display.

I guess Sway does not work with the embedded GTK tray icon yet.
swaywm/sway#6249
I enabled the IBus floating panel in Sway because of no tray for external GTK icons but the window is not arranged correctly into the Sway screen division.
gsettings set org.freedesktop.ibus.panel show 2

I'm evaluating swaybar, waybar, nwg-panel, wlclock and gtk4-layer-shell.

It would be nice if the GTK one could be ported to use StatusNotifier (for the panel applet) and layer shell for the candidate choices overlay but I don't know how feasible that is:

@aidanharris Thank you. Maybe using gtk4-layer-shell is a good option, which is packaged in Fedora.

SNI tray icon is not acceptable for some reason?

@eternal-sorrow Thank you. I see sni-qt is packaged in Fedora.

V1 works with zwp_input_panel_surface_v1_set_overlay_panel() and V2 works with zwp_input_method_v2_get_input_popup_surface() but whenever I close the IBus candidate popup window, IBus gets
the disconnection from the Wayland display with an error of "surface was destroyed before its role object" in V2 and I'm not sure how to destroy the role object.

zwp_input_popup_surface_v2 is a surface role, so the error tells you to ensure that you call zwp_input_popup_surface_v2_destroy before wl_surface_destroy.

I guess Sway does not work with the embedded GTK tray icon yet.
swaywm/sway#6249
I enabled the IBus floating panel in Sway because of no tray for external GTK icons but the window is not arranged correctly into the Sway screen division.

The existing appindicator tray icon code works pretty well with Waybar. Just needed to convince the UI that it's running under KDE: XDG_CURRENT_DESKTOP=KDE /usr/libexec/ibus-ui-gtk3.

XDG_CURRENT_DESKTOP detection is kind of unreliable though, you'll end up checking for every compositor under the sun in Panel::is_kde(). At the very least, it should check for sway and wlroots.

The existing indicator uses Xembed, it's not the best but it does still work. If there's any chance at all that it could be ported to StatusNotifier that would be great but I'm not the one doing the work.

Swaybar should support StatusNotifier too as far as I know and it's pretty common for most desktops that use a tray to support this too.

zwp_input_popup_surface_v2 is a surface role, so the error tells you to ensure that you callzwp_input_popup_surface_v2_destroy before wl_surface_destroy.

@alebastr Thank you very much. I understand ibus-wayland calls wl_surface_destroy() and fix the issue.

XDG_CURRENT_DESKTOP detection is kind of unreliable though, you'll end up checking for every compositor under the sun in Panel::is_kde(). At the very least, it should check for sway and wlroots

Thank you. I missed the detection and I fixed it for sway at the moment.
You're right. I will think the better detection after I evaluate other Wayland desktop sessions.
Fedora wlroots package just provides libwlroots.so and I need to find the instance of the desktop session to set XDG_CURRENT_DESKTOP=wlroots.

I confirmed swaybar can show the IBus panel icon but swaybar does not show the panel menu, waybar can show the panel menu.

@aidanharris I understand you mean swaybar does not support the StatusNotifier yet.

Seems the task area is blue in waybar by default and I'd like to customize the color since IBus panel strings are also blue.

I added some patches in https://github.com/fujiwarat/ibus/commits/wayland-v2 to work with XIM and GTK2 applications in Wayland. Since implementing wl_surface is complicated for me, I use the raw GTK popup window without the GDK custom surface. Now IBus panel manages two popup dialogs for the lookup window, one is implements the Wayland panel protocol and another is a raw popup and I confirmed the memory usage is not changed.

I cannot find /usr/share/vala-0.56/vapi/wayland-client.vapi in valac-0.56-vapi package in Ubuntu Jammy.
https://github.com/ibus/ibus/actions/runs/12728634486/job/35479419810?pr=2695

Do you have any ideas?