fixes #2112 - shift modifier becomes locked

repeated events on wayland improperly updated the xkb state
for modifiers. if we're processing a repeat event do not update the
state.

Author: james-lawrence

druid-shell/src/backend/shared/xkb/mod.rs

@@ -191,29 +191,30 @@ impl State {
         }
     }
 
-    pub fn key_event(&mut self, scancode: u32, state: KeyState) -> KeyEvent {
+    pub fn key_event(&mut self, scancode: u32, state: KeyState, repeat: bool) -> KeyEvent {
         let code = u16::try_from(scancode)
             .map(hardware_keycode_to_code)
             .unwrap_or(Code::Unidentified);
         let key = self.get_logical_key(scancode);
         // TODO this is lazy - really should use xkb i.e. augment the get_logical_key method.
         let location = code_to_location(code);
 
-        let repeat = false;
         // TODO not sure how to get this
         let is_composing = false;
 
         let mut mods = Modifiers::empty();
         // Update xkb's state (e.g. return capitals if we've pressed shift)
         unsafe {
-            xkb_state_update_key(
-                self.state,
-                scancode,
-                match state {
-                    KeyState::Down => XKB_KEY_DOWN,
-                    KeyState::Up => XKB_KEY_UP,
-                },
-            );
+            if !repeat {
+                xkb_state_update_key(
+                    self.state,
+                    scancode,
+                    match state {
+                        KeyState::Down => XKB_KEY_DOWN,
+                        KeyState::Up => XKB_KEY_UP,
+                    },
+                );
+            }
             // compiler will unroll this loop
             // FIXME(msrv): remove .iter().cloned() when msrv is >= 1.53
             for (idx, mod_) in [

druid-shell/src/backend/wayland/keyboard.rs

@@ -113,14 +113,12 @@ impl Keyboard {
             _ => panic!("unrecognised key event"),
         };
 
-        let mut event = self
-            .xkb_state
-            .borrow_mut()
-            .as_mut()
-            .unwrap()
-            .key_event(keystroke.key, keystate);
+        let mut event = self.xkb_state.borrow_mut().as_mut().unwrap().key_event(
+            keystroke.key,
+            keystate,
+            keystroke.repeat,
+        );
         event.mods = self.xkb_mods.get();
-        event.repeat = keystroke.repeat;
 
         if let Err(cause) = keystroke.queue.send(event) {
             tracing::error!("failed to send druid key event: {:?}", cause);
@@ -355,10 +353,7 @@ impl Manager {
     }
 
     // TODO turn struct into a calloop event source.
-    pub(super) fn events<'a>(
-        &self,
-        handle: &'a calloop::LoopHandle<std::sync::Arc<Data>>,
-    ) {
+    pub(super) fn events<'a>(&self, handle: &'a calloop::LoopHandle<std::sync::Arc<Data>>) {
         let rx = self.inner.apprx.borrow_mut().take().unwrap();
         handle
             .insert_source(rx, {

druid-shell/src/backend/wayland/window.rs

@@ -19,11 +19,7 @@ use wayland_protocols::xdg_shell::client::xdg_positioner;
 use wayland_protocols::xdg_shell::client::xdg_surface;
 
 use super::application::{self, Timer};
-use super::{
-    error::Error,
-    menu::Menu,
-    outputs, surfaces,
-};
+use super::{error::Error, menu::Menu, outputs, surfaces};
 
 use crate::{
     dialog::FileDialogOptions,

druid-shell/src/backend/x11/application.rs

@@ -544,9 +544,11 @@ impl Application {
                     .context("KEY_PRESS - failed to get window")?;
                 let hw_keycode = ev.detail;
                 let mut state = borrow_mut!(self.state)?;
-                let key_event = state
-                    .xkb_state
-                    .key_event(hw_keycode as _, keyboard_types::KeyState::Down);
+                let key_event = state.xkb_state.key_event(
+                    hw_keycode as _,
+                    keyboard_types::KeyState::Down,
+                    false,
+                );
 
                 w.handle_key_event(key_event);
             }
@@ -556,9 +558,10 @@ impl Application {
                     .context("KEY_PRESS - failed to get window")?;
                 let hw_keycode = ev.detail;
                 let mut state = borrow_mut!(self.state)?;
-                let key_event = state
-                    .xkb_state
-                    .key_event(hw_keycode as _, keyboard_types::KeyState::Up);
+                let key_event =
+                    state
+                        .xkb_state
+                        .key_event(hw_keycode as _, keyboard_types::KeyState::Up, false);
 
                 w.handle_key_event(key_event);
             }