fix(waylib/inputmethod): restore IME keyboard grab after popup grab ends - #1226
Open
LFRon wants to merge 2 commits into
Open
fix(waylib/inputmethod): restore IME keyboard grab after popup grab ends#1226LFRon wants to merge 2 commits into
LFRon wants to merge 2 commits into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: LFRon The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Hi @LFRon. Thanks for your PR. I'm waiting for a linuxdeepin member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR ensures that when a temporary keyboard grab ends, the IME’s own keyboard grab is correctly restored, preventing situations where fcitx5 fails to appear or becomes unusable after other grabs interfere. Sequence diagram for restoring IME keyboard grab after other grab endssequenceDiagram
participant Seat
participant WInputMethodHelper
participant IMEKeyboardGrab
participant OtherKeyboardGrab
Seat->>WInputMethodHelper: notify_keyboard_grab_begin
WInputMethodHelper->>Seat: keyboard_start_grab(OtherKeyboardGrab)
Seat->>WInputMethodHelper: notify_keyboard_grab_end
WInputMethodHelper->>WInputMethodHelper: handleKeyboardGrabEnd()
alt [activeKeyboardGrab and current grab != keyboardGrab]
WInputMethodHelper->>Seat: keyboard_start_grab(keyboardGrab)
end
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
LFRon
marked this pull request as ready for review
July 30, 2026 12:00
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
LFRon
force-pushed
the
fix/IME
branch
2 times, most recently
from
July 31, 2026 03:13
6d84a13 to
f4d41e9
Compare
|
TAG Bot New tag: 0.8.17 |
LFRon
force-pushed
the
fix/IME
branch
2 times, most recently
from
July 31, 2026 07:37
c7ac3b3 to
60bf411
Compare
LFRon
marked this pull request as draft
July 31, 2026 07:37
LFRon
marked this pull request as ready for review
July 31, 2026 08:34
LFRon
force-pushed
the
fix/IME
branch
3 times, most recently
from
August 3, 2026 05:06
51bcb32 to
c676a1f
Compare
Contributor
Author
|
大佬们有没有好思路修复这个（ |
LFRon
force-pushed
the
fix/IME
branch
3 times, most recently
from
August 13, 2026 13:00
49e9b4a to
502ecd5
Compare
|
TAG Bot New tag: 0.8.18 |
LFRon
force-pushed
the
fix/IME
branch
5 times, most recently
from
August 21, 2026 09:24
de1839c to
c363b5c
Compare
|
TAG Bot New tag: 0.9.0 |
LFRon
force-pushed
the
fix/IME
branch
2 times, most recently
from
August 21, 2026 13:21
67685a6 to
5f999e7
Compare
|
TAG Bot New tag: 0.9.1 |
LFRon
force-pushed
the
fix/IME
branch
5 times, most recently
from
September 9, 2026 01:08
d6a2f80 to
e95dbde
Compare
LFRon
force-pushed
the
fix/IME
branch
5 times, most recently
from
September 10, 2026 11:32
9d1ef55 to
6135a3f
Compare
|
TAG Bot New tag: 0.10.0 |
What this fixes --------------- In WPS Office (and other XEmbed-based X11 apps) the input method is dead in the document editing area while it keeps working in the home/search frame. The editor is not a plain Qt child widget: it is an XEmbed plug window on a separate X client connection, reparented inside the Qt shell top-level. To route text into it the shell legitimately issues XSetInputFocus onto that subwindow, exactly what a real X11 window manager allows. Root cause ---------- xwm_handle_focus_in() guards against cross-application focus stealing: when a FocusIn arrives for a window xwm does not manage and whose pid does not match, it snaps input focus back to the previously tracked top-level. XEmbed plug windows are never xwm surfaces (xwm only tracks managed top-levels), so every legitimate in-client focus move into the plug is misread as a steal and yanked back to the shell. The embedded editor never keeps real X input focus, so input-method activation gated on real X focus (XIM/XIC set-focus) never fires: the input method looks dead even though plain X keys still reach the window. The fix ------- Before refocusing, check whether the window that just gained X input focus is a subwindow of the currently focused surface (bounded recursive XQueryTree, depth 8). That is an in-application focus move inside the client's own hierarchy -- what a bare X server and KWin leave alone -- so accept it silently instead of grabbing focus back. Genuine cross-application stealing still falls through to the existing refocus path. Scope: only windows inside the focused top-level's own subtree are exempted; the same-pid (Steam-type) special case, override-redirect handling, the pointer-detail filter and the focus-serial race guard are untouched.
Combined input-method fix for treeland sessions: the Wayland input-method stack in waylib, popup-grab bookkeeping in treeland, and the session environment that X11-side input methods depend on. Wayland input-method stack (waylib): - Route input-method keys through a dedicated WSeat keyboard filter instead of a synthetic wlr_seat_keyboard_grab. The IM grab object and xdg-popup / drag grabs competed for one seat grab slot, and a displaced popup grab left text-input focus, IM activation and keyboard delivery out of sync (folder rename in dde-file-manager broke; XWayland windows stopped receiving keys after popup close). Physical key/modifier events now go to the active input-method keyboard endpoint while it is active, excluding the IM's own virtual keyboards and active drags; popup and drag keep their own wlroots grabs untouched. - Activation stays strictly text-input driven, but while focus crosses surfaces without an alive enabled text input (terminals, XWayland windows, the momentary null focus of every window switch) it is held on the anchor instead of tearing down and re-creating the fcitx5 grab and virtual keyboard on each switch. Only an authoritative end (client disable / deactivate request, text-input or surface destruction, IM disconnect) deactivates. - Commits never follow the anchor: a commit is delivered only to the text input exactly matching current keyboard focus. When the focused surface has no text input, the commit is typed through the input method's own virtual keyboard (latin/symbol keysyms; CJK needs an xwayland-side text-input bridge, out of scope here). - Text-input enablement follows the protocols again: a compositor-driven enter/leave is a notification, not a disablement. For text-input-v1 the client activate record is persistent (cleared only by the client's own deactivate or the surface's destruction, enter/leave kept paired), so focus returning to an activated surface re-arms it deterministically. For text-input-v2 the leave no longer emits disabled(); revocation flows only through the client disable request or enabled-surface destruction, and every new enter is preceded by the obsolete leave. - Attach the IM keyboard endpoint to the keyboard group device when it is created (fcitx5 recreates its virtual keyboard right before grab requests), take keyboard-focus enter payloads from the group, restore the group keyboard when a virtual keyboard dies, guard Qt repeat handling against invalid keyboards/disabled rates, and re-run instead of dropping re-entrant focus reconciliations. - Popup focus tracking (seatsurfacemanager) validates exact wlr_xdg_popup_grab membership, tracks replacement and end events separately, restores the concrete pre-popup focus only while the tracked popup still owns focus, and dismisses the concrete popup instead of ending an arbitrary seat grab. - Categorized transition logs (input-method / text-input / popup-focus) carry object and state identifiers only, never key codes, surrounding text, preedit or committed user input. XWayland session environment (src/systemd-socket.cpp, misc/systemd/.../treeland-xwayland.service.in): - Publish DISPLAY and XAUTHORITY through systemd1.SetEnvironment in addition to UpdateActivationEnvironment. Transient session units (How apps and fcitx5 are started via StartTransientUnit) inherit the *manager* environment, not the activation one, so X-side input methods were blind to the XWayland display in treeland sessions; dde-session performs this same call on KWin, which is why it only worked there. UnsetEnvironment and ExecStop now clear XAUTHORITY alongside DISPLAY. - Gate unit readiness on the compositor's ActivateWayland business reply: a successful D-Bus call returning false means the compositor is registered but not yet ready for this session socket (login handover). Retried in a bounded ~20s window, then degraded to the historic publish-anyway path so the session can never hang; this stops advertising WAYLAND_DISPLAY and autostarting input methods against a socket nobody serves, where they stayed permanently broken. Stacking robustness (src/surface/surfacewrapper.cpp): - SurfaceWrapper::stackAfter() falls back to the sub-chain head (validated as a sibling by the entry guard) when its deepest stacked member lives in a different QQuickItem container, as X11 transient children may: QQuickItem::stackAfter() silently rejects non-siblings and aborted the raise with the stacking bookkeeping left out of sync. Together with the vendored wlroots XEmbed focus exemption committed separately, the input method now works in native Wayland clients (folder rename and others, including across popups and window switches) and in XWayland clients (WPS Office document editing included).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
该问题修复的是由于设置了QT_IM_MODULES, XMODIFIERS等环境变量后, 在treeland运行一段时间后一定会出现的几个问题:
该PR同时修复了上述问题
Summary by Sourcery
Restore reliable input-method input delivery by coordinating popup grabs, keyboard filtering, focus recovery, and text-input activation across changing application surfaces.
Bug Fixes:
Enhancements: