fix: correct CapsLock state tracking in waylandim v2#1595
Merged
Conversation
Use XKB_STATE_MODS_EFFECTIVE instead of DEPRESSED|LATCHED to include locked modifiers (CapsLock, NumLock) in the modifier state mask. This fixes rime getting stuck in English mode after toggling CapsLock off.
📝 WalkthroughWalkthrough
ChangesWayland IM modifier serialization
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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
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.
Environment
Reproduction
Root Cause
WaylandIMInputContextV2::modifiersCallbackserializes the modifier state usingXKB_STATE_MODS_DEPRESSED | XKB_STATE_MODS_LATCHED. These flags only query held-down (Depressed) and latched (Latch) modifiers, omitting locked modifiers — the category CapsLock belongs to.Wayland correctly reports
mods_lockedchanges, andxkb_state_update_mask()correctly updates the internal XKB state. However,xkb_state_serialize_mods()reads back only Depressed | Latched, somodifiers_never containsKeyState::CapsLock. The engine receives key events with uppercase keysyms but no CapsLock modifier in the key states, confusing its internal state machine.Fix
Replace
XKB_STATE_MODS_DEPRESSED | XKB_STATE_MODS_LATCHEDwithXKB_STATE_MODS_EFFECTIVE.EFFECTIVEincludes all three modifier categories (Depressed | Latched | Locked), correctly reflecting CapsLock transitions inmodifiers_.Summary by CodeRabbit