wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-11-23 06:54:45 +03:00
Code Issues Projects Releases Wiki Activity

x11: always trust key event modifiers over xkd modifiers

Browse Source 
in discussion: https://github.com/ibus/ibus/issues/2600#issuecomment-1904322441
the summary is that the StateNotify event which is used to update
the xkd modifier state is sourced directly from the X server and
doesn't account for any state maintained by the IME.

The key press and release events do include the correct state,
so we should always prefer to use the modifiers from those events
on X11.

Under wayland, we continue to use the kbd state.

refs: https://github.com/ibus/ibus/issues/2600
refs: https://github.com/wez/wezterm/pull/4151
This commit is contained in:
Wez Furlong 2024-01-23 14:26:53 -07:00
parent c0b61d1c6d
commit 045e92be1b
No known key found for this signature in database
GPG Key ID: 7A7F66A31EC9B387
1 changed files with 9 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
window/src/os/x11/keyboard.rs
View File

@ -163,7 +163,8 @@ impl KeyboardWithFallback {
events: &mut WindowEventSender,
) -> Option<WindowKeyEvent> {
let want_repeat = self.selected.wayland_key_repeats(code);
self.process_key_event_impl(code + 8, Modifiers::default(), pressed, events, want_repeat)
let raw_modifiers = self.get_key_modifiers();
self.process_key_event_impl(code + 8, raw_modifiers, pressed, events, want_repeat)
}
/// Compute the Modifier mask equivalent from the button mask
@ -215,32 +216,22 @@ impl KeyboardWithFallback {
);
}
// for X11 we always pass down raw_modifiers from the incoming
// key event to use in preference to whatever is computed by XKB.
// The reason is that the update_state() call triggered by the XServer
// doesn't know about state managed by the IME, so we cannot trust
// that the modifiers are right.
// <https://github.com/ibus/ibus/issues/2600#issuecomment-1904322441>
fn process_key_event_impl(
&self,
xcode: xkb::Keycode,
modifiers_from_event: Modifiers,
raw_modifiers: Modifiers,
pressed: bool,
events: &mut WindowEventSender,
want_repeat: bool,
) -> Option<WindowKeyEvent> {
let phys_code = self.selected.phys_code_map.borrow().get(&xcode).copied();
let modifiers_from_state = self.get_key_modifiers();
// When XKB doesn't have modifiers in its state but there are modifiers
// given in the X event, use the values from the X event.
//
// This can happen (FIXME: WHY) for example when Espanso
// (a text expander/injector) simulate inputs.
//
// This also happens intermittently for wez on an Ubuntu system where
// the XServer clears the mask state seemingly at the wrong time via
// a call into process_xkb_event that zeroes out all the modifier states.
let raw_modifiers = if modifiers_from_state.is_empty() {
modifiers_from_event
} else {
modifiers_from_state
};
let leds = self.get_led_status();
let xsym = self.selected.state.borrow().key_get_one_sym(xcode);