fix: use change_keymap to allow WM handle keycode with the correct keymap

Author: Bot-wxt1221

examples/minimal.rs

@@ -184,6 +184,7 @@ pub fn run_winit() -> Result<(), Box<dyn std::error::Error>> {
                             //
                             FilterResult::Forward
                         },
+                        false,
                     );
                 }
                 InputEvent::PointerMotionAbsolute { .. } => {

examples/seat.rs

@@ -72,6 +72,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
                     FilterResult::Forward
                 }
             },
+            false,
         );
 
         keyboard.set_focus(&mut state, Option::<WlSurface>::None, 0.into());

src/desktop/wayland/popup/grab.rs

@@ -447,6 +447,7 @@ where
         modifiers: Option<ModifiersState>,
         serial: Serial,
         time: u32,
+        ignore_keymap: bool,
     ) {
         // Check if the grab changed and update the focus
         // If the grab has ended this will return the root
@@ -459,7 +460,7 @@ where
             handle.unset_grab(self, data, serial, false);
         }
 
-        handle.input(data, keycode, state, modifiers, serial, time)
+        handle.input(data, keycode, state, modifiers, serial, time, ignore_keymap)
     }
 
     fn set_focus(

src/input/keyboard/mod.rs

@@ -606,6 +606,7 @@ pub trait KeyboardGrab<D: SeatHandler>: Downcast {
         modifiers: Option<ModifiersState>,
         serial: Serial,
         time: u32,
+        ignore_keymap: bool,
     );
 
     /// A focus change was requested.
@@ -934,7 +935,8 @@ impl<D: SeatHandler + 'static> KeyboardHandle<D> {
     /// Handle a keystroke
     ///
     /// All keystrokes from the input backend should be fed _in order_ to this method of the
-    /// keyboard handler. It will internally track the state of the keymap.
+    /// keyboard handler. It will internally track the state of the keymap. But you could ignore
+    /// it by setting ignore_keymap true.
     ///
     /// The `filter` argument is expected to be a closure which will peek at the generated input
     /// as interpreted by the keymap before it is forwarded to the focused client. If this closure
@@ -953,6 +955,7 @@ impl<D: SeatHandler + 'static> KeyboardHandle<D> {
         serial: Serial,
         time: u32,
         filter: F,
+        ignore_keymap: bool,
     ) -> Option<T>
     where
         F: FnOnce(&mut D, &ModifiersState, KeysymHandle<'_>) -> FilterResult<T>,
@@ -964,7 +967,7 @@ impl<D: SeatHandler + 'static> KeyboardHandle<D> {
             return Some(val);
         }
 
-        self.input_forward(data, keycode, state, serial, time, mods_changed);
+        self.input_forward(data, keycode, state, serial, time, mods_changed, ignore_keymap);
         None
     }
 
@@ -1018,6 +1021,7 @@ impl<D: SeatHandler + 'static> KeyboardHandle<D> {
         serial: Serial,
         time: u32,
         mods_changed: bool,
+        ignore_keymap: bool,
     ) {
         let mut guard = self.arc.internal.lock().unwrap();
         match state {
@@ -1033,7 +1037,16 @@ impl<D: SeatHandler + 'static> KeyboardHandle<D> {
         let seat = self.get_seat(data);
         let modifiers = mods_changed.then_some(guard.mods_state);
         guard.with_grab(data, &seat, |data, handle, grab| {
-            grab.input(data, handle, keycode, state, modifiers, serial, time);
+            grab.input(
+                data,
+                handle,
+                keycode,
+                state,
+                modifiers,
+                serial,
+                time,
+                ignore_keymap,
+            );
         });
         if guard.focus.is_some() {
             trace!("Input forwarded to client");
@@ -1270,6 +1283,7 @@ impl<D: SeatHandler + 'static> KeyboardInnerHandle<'_, D> {
         modifiers: Option<ModifiersState>,
         serial: Serial,
         time: u32,
+        ignore_keymap: bool,
     ) {
         let (focus, _) = match self.inner.focus.as_mut() {
             Some(focus) => focus,
@@ -1278,10 +1292,12 @@ impl<D: SeatHandler + 'static> KeyboardInnerHandle<'_, D> {
 
         // Ensure keymap is up to date.
         #[cfg(feature = "wayland_frontend")]
-        if let Some(keyboard_handle) = self.seat.get_keyboard() {
-            let keymap_file = keyboard_handle.arc.keymap.lock().unwrap();
-            let mods = self.inner.mods_state;
-            keyboard_handle.send_keymap(data, &Some(focus), &keymap_file, mods);
+        if !ignore_keymap {
+            if let Some(keyboard_handle) = self.seat.get_keyboard() {
+                let keymap_file = keyboard_handle.arc.keymap.lock().unwrap();
+                let mods = self.inner.mods_state;
+                keyboard_handle.send_keymap(data, &Some(focus), &keymap_file, mods);
+            }
         }
 
         // key event must be sent before modifiers event for libxkbcommon
@@ -1381,8 +1397,9 @@ impl<D: SeatHandler + 'static> KeyboardGrab<D> for DefaultGrab {
         modifiers: Option<ModifiersState>,
         serial: Serial,
         time: u32,
+        ignore_keymap: bool,
     ) {
-        handle.input(data, keycode, state, modifiers, serial, time)
+        handle.input(data, keycode, state, modifiers, serial, time, ignore_keymap)
     }
 
     fn set_focus(

src/wayland/input_method/input_method_keyboard_grab.rs

@@ -49,6 +49,7 @@ where
         modifiers: Option<ModifiersState>,
         serial: Serial,
         time: u32,
+        _ignore_keymap: bool,
     ) {
         let inner = self.inner.lock().unwrap();
         let keyboard = inner.grab.as_ref().unwrap();

src/wayland/virtual_keyboard/mod.rs

@@ -51,6 +51,7 @@
 //! #     fn client_compositor_state<'a>(&self, client: &'a Client) -> &'a CompositorClientState { unimplemented!() }
 //! #     fn commit(&mut self, surface: &WlSurface) {}
 //! # }
+//! // Set ignore_keymap true while using KeyboardHandle::input
 //! impl VirtualKeyboardHandler for State {
 //!    fn on_keyboard_event(
 //!     &mut self,

src/wayland/xwayland_keyboard_grab.rs

@@ -113,14 +113,15 @@ impl<D: XWaylandKeyboardGrabHandler + 'static> KeyboardGrab<D> for XWaylandKeybo
         modifiers: Option<keyboard::ModifiersState>,
         serial: Serial,
         time: u32,
+        ignore_keymap: bool,
     ) {
         handle.set_focus(data, self.start_data.focus.clone(), serial);
 
         if !self.grab.is_alive() {
             handle.unset_grab(self, data, serial, false);
         }
 
-        handle.input(data, keycode, state, modifiers, serial, time)
+        handle.input(data, keycode, state, modifiers, serial, time, ignore_keymap)
     }
 
     fn set_focus(