1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876
use std::{
convert::TryInto,
env,
fmt::Debug,
marker::PhantomData,
num::NonZeroU32,
sync::{
atomic::{AtomicBool, Ordering},
Arc, Mutex,
},
time::Duration,
};
#[doc(inline)]
pub use xkeysym::{KeyCode, Keysym};
#[cfg(feature = "calloop")]
use calloop::timer::{TimeoutAction, Timer};
use wayland_client::{
protocol::{wl_keyboard, wl_seat, wl_surface},
Connection, Dispatch, Proxy, QueueHandle, WEnum,
};
use xkbcommon::xkb;
#[cfg(feature = "calloop")]
use repeat::{RepeatData, RepeatedKey};
use super::{Capability, SeatError, SeatHandler, SeatState};
#[cfg(feature = "calloop")]
pub mod repeat;
/// Error when creating a keyboard.
#[must_use]
#[derive(Debug, thiserror::Error)]
pub enum KeyboardError {
/// Seat error.
#[error(transparent)]
Seat(#[from] SeatError),
/// The specified keymap (RMLVO) is not valid.
#[error("invalid keymap was specified")]
InvalidKeymap,
}
impl SeatState {
/// Creates a keyboard from a seat.
///
/// This keyboard implementation uses libxkbcommon for the keymap.
///
/// Typically the compositor will provide a keymap, but you may specify your own keymap using the `rmlvo`
/// field.
///
/// ## Errors
///
/// This will return [`SeatError::UnsupportedCapability`] if the seat does not support a keyboard.
pub fn get_keyboard<D, T: 'static>(
&mut self,
qh: &QueueHandle<D>,
seat: &wl_seat::WlSeat,
rmlvo: Option<RMLVO>,
) -> Result<wl_keyboard::WlKeyboard, KeyboardError>
where
D: Dispatch<wl_keyboard::WlKeyboard, KeyboardData<T>>
+ SeatHandler
+ KeyboardHandler
+ 'static,
{
let udata = match rmlvo {
Some(rmlvo) => KeyboardData::from_rmlvo(seat.clone(), rmlvo)?,
None => KeyboardData::new(seat.clone()),
};
self.get_keyboard_with_data(qh, seat, udata)
}
/// Creates a keyboard from a seat.
///
/// This keyboard implementation uses libxkbcommon for the keymap.
///
/// Typically the compositor will provide a keymap, but you may specify your own keymap using the `rmlvo`
/// field.
///
/// ## Errors
///
/// This will return [`SeatError::UnsupportedCapability`] if the seat does not support a keyboard.
pub fn get_keyboard_with_data<D, U>(
&mut self,
qh: &QueueHandle<D>,
seat: &wl_seat::WlSeat,
udata: U,
) -> Result<wl_keyboard::WlKeyboard, KeyboardError>
where
D: Dispatch<wl_keyboard::WlKeyboard, U> + SeatHandler + KeyboardHandler + 'static,
U: KeyboardDataExt + 'static,
{
let inner =
self.seats.iter().find(|inner| &inner.seat == seat).ok_or(SeatError::DeadObject)?;
if !inner.data.has_keyboard.load(Ordering::SeqCst) {
return Err(SeatError::UnsupportedCapability(Capability::Keyboard).into());
}
Ok(seat.get_keyboard(qh, udata))
}
}
/// Wrapper around a libxkbcommon keymap
#[allow(missing_debug_implementations)]
pub struct Keymap<'a>(&'a xkb::Keymap);
impl<'a> Keymap<'a> {
/// Get keymap as string in text format. The keymap should always be valid.
pub fn as_string(&self) -> String {
self.0.get_as_string(xkb::KEYMAP_FORMAT_TEXT_V1)
}
}
/// Handler trait for keyboard input.
///
/// The functions defined in this trait are called as keyboard events are received from the compositor.
pub trait KeyboardHandler: Sized {
/// The keyboard has entered a surface.
///
/// When called, you may assume the specified surface has keyboard focus.
///
/// When a keyboard enters a surface, the `raw` and `keysym` fields indicate which keys are currently
/// pressed.
#[allow(clippy::too_many_arguments)]
fn enter(
&mut self,
conn: &Connection,
qh: &QueueHandle<Self>,
keyboard: &wl_keyboard::WlKeyboard,
surface: &wl_surface::WlSurface,
serial: u32,
raw: &[u32],
keysyms: &[Keysym],
);
/// The keyboard has left a surface.
///
/// When called, keyboard focus leaves the specified surface.
///
/// All currently held down keys are released when this event occurs.
fn leave(
&mut self,
conn: &Connection,
qh: &QueueHandle<Self>,
keyboard: &wl_keyboard::WlKeyboard,
surface: &wl_surface::WlSurface,
serial: u32,
);
/// A key has been pressed on the keyboard.
///
/// The key will repeat if there is no other press event afterwards or the key is released.
fn press_key(
&mut self,
conn: &Connection,
qh: &QueueHandle<Self>,
keyboard: &wl_keyboard::WlKeyboard,
serial: u32,
event: KeyEvent,
);
/// A key has been released.
///
/// This stops the key from being repeated if the key is the last key which was pressed.
fn release_key(
&mut self,
conn: &Connection,
qh: &QueueHandle<Self>,
keyboard: &wl_keyboard::WlKeyboard,
serial: u32,
event: KeyEvent,
);
/// Keyboard modifiers have been updated.
///
/// This happens when one of the modifier keys, such as "Shift", "Control" or "Alt" is pressed or
/// released.
#[allow(clippy::too_many_arguments)]
fn update_modifiers(
&mut self,
conn: &Connection,
qh: &QueueHandle<Self>,
keyboard: &wl_keyboard::WlKeyboard,
serial: u32,
modifiers: Modifiers,
raw_modifiers: RawModifiers,
layout: u32,
);
/// The keyboard has updated the rate and delay between repeating key inputs.
///
/// This function does nothing by default but is provided if a repeat mechanism outside of calloop is\
/// used.
fn update_repeat_info(
&mut self,
_conn: &Connection,
_qh: &QueueHandle<Self>,
_keyboard: &wl_keyboard::WlKeyboard,
_info: RepeatInfo,
) {
}
/// Keyboard keymap has been updated.
///
/// `keymap.as_string()` can be used get the keymap as a string. It cannot be exposed directly
/// as an `xkbcommon::xkb::Keymap` due to the fact xkbcommon uses non-thread-safe reference
/// counting. But can be used to create an independent `Keymap`.
///
/// This is called after the default handler for keymap changes and does nothing by default.
fn update_keymap(
&mut self,
_conn: &Connection,
_qh: &QueueHandle<Self>,
_keyboard: &wl_keyboard::WlKeyboard,
_keymap: Keymap<'_>,
) {
}
}
/// The rate at which a pressed key is repeated.
#[derive(Debug, Clone, Copy)]
pub enum RepeatInfo {
/// Keys will be repeated at the specified rate and delay.
Repeat {
/// The number of repetitions per second that should occur.
rate: NonZeroU32,
/// Delay (in milliseconds) between a key press and the start of repetition.
delay: u32,
},
/// Keys should not be repeated.
Disable,
}
/// Data associated with a key press or release event.
#[derive(Debug, Clone)]
pub struct KeyEvent {
/// Time at which the keypress occurred.
pub time: u32,
/// The raw value of the key.
pub raw_code: u32,
/// The interpreted symbol of the key.
///
/// This corresponds to one of the assoiated values on the [`Keysym`] type.
pub keysym: Keysym,
/// UTF-8 interpretation of the entered text.
///
/// This will always be [`None`] on release events.
pub utf8: Option<String>,
}
/// State of keyboard modifiers, in raw form sent by compositor.
#[derive(Debug, Clone, Copy, Default)]
pub struct RawModifiers {
pub depressed: u32,
pub latched: u32,
pub locked: u32,
}
/// The state of keyboard modifiers
///
/// Each field of this indicates whether a specified modifier is active.
///
/// Depending on the modifier, the modifier key may currently be pressed or toggled.
#[derive(Debug, Clone, Copy, Default)]
pub struct Modifiers {
/// The "control" key
pub ctrl: bool,
/// The "alt" key
pub alt: bool,
/// The "shift" key
pub shift: bool,
/// The "Caps lock" key
pub caps_lock: bool,
/// The "logo" key
///
/// Also known as the "windows" or "super" key on a keyboard.
#[doc(alias = "windows")]
#[doc(alias = "super")]
pub logo: bool,
/// The "Num lock" key
pub num_lock: bool,
}
/// The RMLVO description of a keymap
///
/// All fields are optional, and the system default
/// will be used if set to `None`.
#[derive(Debug)]
#[allow(clippy::upper_case_acronyms)]
pub struct RMLVO {
/// The rules file to use
pub rules: Option<String>,
/// The keyboard model by which to interpret keycodes and LEDs
pub model: Option<String>,
/// A comma separated list of layouts (languages) to include in the keymap
pub layout: Option<String>,
/// A comma separated list of variants, one per layout, which may modify or
/// augment the respective layout in various ways
pub variant: Option<String>,
/// A comma separated list of options, through which the user specifies
/// non-layout related preferences, like which key combinations are
/// used for switching layouts, or which key is the Compose key.
pub options: Option<String>,
}
pub struct KeyboardData<T> {
seat: wl_seat::WlSeat,
first_event: AtomicBool,
xkb_context: Mutex<xkb::Context>,
/// If the user manually specified the RMLVO to use.
user_specified_rmlvo: bool,
xkb_state: Mutex<Option<xkb::State>>,
xkb_compose: Mutex<Option<xkb::compose::State>>,
#[cfg(feature = "calloop")]
repeat_data: Arc<Mutex<Option<RepeatData<T>>>>,
focus: Mutex<Option<wl_surface::WlSurface>>,
_phantom_data: PhantomData<T>,
}
impl<T> Debug for KeyboardData<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("KeyboardData").finish_non_exhaustive()
}
}
#[macro_export]
macro_rules! delegate_keyboard {
($(@<$( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? ),+>)? $ty: ty) => {
$crate::reexports::client::delegate_dispatch!($(@< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)? $ty:
[
$crate::reexports::client::protocol::wl_keyboard::WlKeyboard: $crate::seat::keyboard::KeyboardData<$ty>
] => $crate::seat::SeatState
);
};
($(@<$( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? ),+>)? $ty: ty, keyboard: [$($udata:ty),* $(,)?]) => {
$crate::reexports::client::delegate_dispatch!($(@< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)? $ty:
[
$(
$crate::reexports::client::protocol::wl_keyboard::WlKeyboard: $udata,
)*
] => $crate::seat::SeatState
);
};
}
// SAFETY: The state does not share state with any other rust types.
unsafe impl<T> Send for KeyboardData<T> {}
// SAFETY: The state is guarded by a mutex since libxkbcommon has no internal synchronization.
unsafe impl<T> Sync for KeyboardData<T> {}
impl<T> KeyboardData<T> {
pub fn new(seat: wl_seat::WlSeat) -> Self {
let xkb_context = xkb::Context::new(xkb::CONTEXT_NO_FLAGS);
let udata = KeyboardData {
seat,
first_event: AtomicBool::new(false),
xkb_context: Mutex::new(xkb_context),
xkb_state: Mutex::new(None),
user_specified_rmlvo: false,
xkb_compose: Mutex::new(None),
#[cfg(feature = "calloop")]
repeat_data: Arc::new(Mutex::new(None)),
focus: Mutex::new(None),
_phantom_data: PhantomData,
};
udata.init_compose();
udata
}
pub fn seat(&self) -> &wl_seat::WlSeat {
&self.seat
}
pub fn from_rmlvo(seat: wl_seat::WlSeat, rmlvo: RMLVO) -> Result<Self, KeyboardError> {
let xkb_context = xkb::Context::new(xkb::CONTEXT_NO_FLAGS);
let keymap = xkb::Keymap::new_from_names(
&xkb_context,
&rmlvo.rules.unwrap_or_default(),
&rmlvo.model.unwrap_or_default(),
&rmlvo.layout.unwrap_or_default(),
&rmlvo.variant.unwrap_or_default(),
rmlvo.options,
xkb::COMPILE_NO_FLAGS,
);
if keymap.is_none() {
return Err(KeyboardError::InvalidKeymap);
}
let xkb_state = Some(xkb::State::new(&keymap.unwrap()));
let udata = KeyboardData {
seat,
first_event: AtomicBool::new(false),
xkb_context: Mutex::new(xkb_context),
xkb_state: Mutex::new(xkb_state),
user_specified_rmlvo: true,
xkb_compose: Mutex::new(None),
#[cfg(feature = "calloop")]
repeat_data: Arc::new(Mutex::new(None)),
focus: Mutex::new(None),
_phantom_data: PhantomData,
};
udata.init_compose();
Ok(udata)
}
fn init_compose(&self) {
let xkb_context = self.xkb_context.lock().unwrap();
if let Some(locale) = env::var_os("LC_ALL")
.and_then(|v| if v.is_empty() { None } else { Some(v) })
.or_else(|| env::var_os("LC_CTYPE"))
.and_then(|v| if v.is_empty() { None } else { Some(v) })
.or_else(|| env::var_os("LANG"))
.and_then(|v| if v.is_empty() { None } else { Some(v) })
.unwrap_or_else(|| "C".into())
.to_str()
{
// TODO: Pending new release of xkbcommon to use new_from_locale with OsStr
if let Ok(table) = xkb::compose::Table::new_from_locale(
&xkb_context,
locale.as_ref(),
xkb::compose::COMPILE_NO_FLAGS,
) {
let compose_state =
xkb::compose::State::new(&table, xkb::compose::COMPILE_NO_FLAGS);
*self.xkb_compose.lock().unwrap() = Some(compose_state);
}
}
}
fn update_modifiers(&self) -> Modifiers {
let guard = self.xkb_state.lock().unwrap();
let state = guard.as_ref().unwrap();
Modifiers {
ctrl: state.mod_name_is_active(xkb::MOD_NAME_CTRL, xkb::STATE_MODS_EFFECTIVE),
alt: state.mod_name_is_active(xkb::MOD_NAME_ALT, xkb::STATE_MODS_EFFECTIVE),
shift: state.mod_name_is_active(xkb::MOD_NAME_SHIFT, xkb::STATE_MODS_EFFECTIVE),
caps_lock: state.mod_name_is_active(xkb::MOD_NAME_CAPS, xkb::STATE_MODS_EFFECTIVE),
logo: state.mod_name_is_active(xkb::MOD_NAME_LOGO, xkb::STATE_MODS_EFFECTIVE),
num_lock: state.mod_name_is_active(xkb::MOD_NAME_NUM, xkb::STATE_MODS_EFFECTIVE),
}
}
}
pub trait KeyboardDataExt: Send + Sync {
type State: 'static;
fn keyboard_data(&self) -> &KeyboardData<Self::State>;
fn keyboard_data_mut(&mut self) -> &mut KeyboardData<Self::State>;
}
impl<T: 'static> KeyboardDataExt for KeyboardData<T> {
/// The type of the user defined state
type State = T;
fn keyboard_data(&self) -> &KeyboardData<T> {
self
}
fn keyboard_data_mut(&mut self) -> &mut KeyboardData<T> {
self
}
}
impl<D, U> Dispatch<wl_keyboard::WlKeyboard, U, D> for SeatState
where
D: Dispatch<wl_keyboard::WlKeyboard, U> + KeyboardHandler,
U: KeyboardDataExt,
{
fn event(
data: &mut D,
keyboard: &wl_keyboard::WlKeyboard,
event: wl_keyboard::Event,
udata: &U,
conn: &Connection,
qh: &QueueHandle<D>,
) {
let udata = udata.keyboard_data();
// The compositor has no way to tell clients if the seat is not version 4 or above.
// In this case, send a synthetic repeat info event using the default repeat values used by the X
// server.
if keyboard.version() < 4 && udata.first_event.load(Ordering::SeqCst) {
udata.first_event.store(true, Ordering::SeqCst);
data.update_repeat_info(
conn,
qh,
keyboard,
RepeatInfo::Repeat { rate: NonZeroU32::new(200).unwrap(), delay: 200 },
);
}
match event {
wl_keyboard::Event::Keymap { format, fd, size } => {
match format {
WEnum::Value(format) => match format {
wl_keyboard::KeymapFormat::NoKeymap => {
log::warn!(target: "sctk", "non-xkb compatible keymap");
}
wl_keyboard::KeymapFormat::XkbV1 => {
if udata.user_specified_rmlvo {
// state is locked, ignore keymap updates
return;
}
let context = udata.xkb_context.lock().unwrap();
// 0.5.0-beta.0 does not mark this function as unsafe but upstream rightly makes
// this function unsafe.
//
// Version 7 of wl_keyboard requires the file descriptor to be mapped using
// MAP_PRIVATE. xkbcommon-rs does mmap the file descriptor properly.
//
// SAFETY:
// - wayland-client guarantees we have received a valid file descriptor.
#[allow(unused_unsafe)] // Upstream release will change this
match unsafe {
xkb::Keymap::new_from_fd(
&context,
fd,
size as usize,
xkb::KEYMAP_FORMAT_TEXT_V1,
xkb::COMPILE_NO_FLAGS,
)
} {
Ok(Some(keymap)) => {
let state = xkb::State::new(&keymap);
{
let mut state_guard = udata.xkb_state.lock().unwrap();
*state_guard = Some(state);
}
data.update_keymap(conn, qh, keyboard, Keymap(&keymap));
}
Ok(None) => {
log::error!(target: "sctk", "invalid keymap");
}
Err(err) => {
log::error!(target: "sctk", "{}", err);
}
}
}
_ => unreachable!(),
},
WEnum::Unknown(value) => {
log::warn!(target: "sctk", "unknown keymap format 0x{:x}", value)
}
}
}
wl_keyboard::Event::Enter { serial, surface, keys } => {
let state_guard = udata.xkb_state.lock().unwrap();
if let Some(guard) = state_guard.as_ref() {
// Keysyms are encoded as an array of u32
let raw = keys
.chunks_exact(4)
.flat_map(TryInto::<[u8; 4]>::try_into)
.map(u32::from_le_bytes)
.collect::<Vec<_>>();
let keysyms = raw
.iter()
.copied()
// We must add 8 to the keycode for any functions we pass the raw keycode into per
// wl_keyboard protocol.
.map(|raw| guard.key_get_one_sym(KeyCode::new(raw + 8)))
.collect::<Vec<_>>();
// Drop guard before calling user code.
drop(state_guard);
data.enter(
conn,
qh,
keyboard,
&surface,
serial,
&raw,
bytemuck::cast_slice(&keysyms),
);
}
*udata.focus.lock().unwrap() = Some(surface);
}
wl_keyboard::Event::Leave { serial, surface } => {
// We can send this event without any other checks in the protocol will guarantee a leave is
// sent before entering a new surface.
#[cfg(feature = "calloop")]
{
if let Some(repeat_data) = udata.repeat_data.lock().unwrap().as_mut() {
repeat_data.current_repeat.take();
}
}
data.leave(conn, qh, keyboard, &surface, serial);
*udata.focus.lock().unwrap() = None;
}
wl_keyboard::Event::Key { serial, time, key, state } => match state {
WEnum::Value(state) => {
let state_guard = udata.xkb_state.lock().unwrap();
if let Some(guard) = state_guard.as_ref() {
// We must add 8 to the keycode for any functions we pass the raw keycode into per
// wl_keyboard protocol.
let keycode = KeyCode::new(key + 8);
let keysym = guard.key_get_one_sym(keycode);
let utf8 = if state == wl_keyboard::KeyState::Pressed {
let mut compose = udata.xkb_compose.lock().unwrap();
match compose.as_mut() {
Some(compose) => match compose.feed(keysym) {
xkb::FeedResult::Ignored => None,
xkb::FeedResult::Accepted => match compose.status() {
xkb::Status::Composed => compose.utf8(),
xkb::Status::Nothing => Some(guard.key_get_utf8(keycode)),
_ => None,
},
},
// No compose
None => Some(guard.key_get_utf8(keycode)),
}
} else {
None
};
// Drop guard before calling user code.
drop(state_guard);
let event = KeyEvent { time, raw_code: key, keysym, utf8 };
match state {
wl_keyboard::KeyState::Released => {
#[cfg(feature = "calloop")]
{
if let Some(repeat_data) =
udata.repeat_data.lock().unwrap().as_mut()
{
if Some(event.raw_code)
== repeat_data
.current_repeat
.as_ref()
.map(|r| r.key.raw_code)
{
repeat_data.current_repeat = None;
}
}
}
data.release_key(conn, qh, keyboard, serial, event);
}
wl_keyboard::KeyState::Pressed => {
#[cfg(feature = "calloop")]
{
if let Some(repeat_data) =
udata.repeat_data.lock().unwrap().as_mut()
{
let loop_handle = &mut repeat_data.loop_handle;
let state_guard = udata.xkb_state.lock().unwrap();
let key_repeats = state_guard
.as_ref()
.map(|guard| {
guard
.get_keymap()
.key_repeats(KeyCode::new(event.raw_code + 8))
})
.unwrap_or_default();
if key_repeats {
// Cancel the previous timer / repeat.
if let Some(token) = repeat_data.repeat_token.take() {
loop_handle.remove(token);
}
let surface =
match udata.focus.lock().unwrap().as_ref().cloned()
{
Some(surface) => surface,
None => {
log::warn!(
"wl_keyboard::key with no focused surface");
return;
}
};
// Update the current repeat key.
repeat_data.current_repeat.replace(RepeatedKey {
key: event.clone(),
is_first: true,
surface,
});
let (delay, rate) = match repeat_data.repeat_info {
RepeatInfo::Disable => return,
RepeatInfo::Repeat { delay, rate } => (delay, rate),
};
let gap = Duration::from_micros(
1_000_000 / rate.get() as u64,
);
let timer = Timer::from_duration(
Duration::from_millis(delay as u64),
);
let repeat_data2 = udata.repeat_data.clone();
// Start the timer.
let kbd = keyboard.clone();
if let Ok(token) = loop_handle.insert_source(
timer,
move |_, _, state| {
let mut repeat_data =
repeat_data2.lock().unwrap();
let repeat_data = match repeat_data.as_mut() {
Some(repeat_data) => repeat_data,
None => return TimeoutAction::Drop,
};
let callback = &mut repeat_data.callback;
let key = &mut repeat_data.current_repeat;
if key.is_none() {
return TimeoutAction::Drop;
}
let key = key.as_mut().unwrap();
// If surface was closed while focused, no `Leave`
// event occurred.
if !key.surface.is_alive() {
return TimeoutAction::Drop;
}
key.key.time += if key.is_first {
key.is_first = false;
delay
} else {
gap.as_millis() as u32
};
callback(state, &kbd, key.key.clone());
TimeoutAction::ToDuration(gap)
},
) {
repeat_data.repeat_token = Some(token);
}
}
}
}
data.press_key(conn, qh, keyboard, serial, event);
}
_ => unreachable!(),
}
};
}
WEnum::Unknown(unknown) => {
log::warn!(target: "sctk", "{}: compositor sends invalid key state: {:x}", keyboard.id(), unknown);
}
},
wl_keyboard::Event::Modifiers {
serial,
mods_depressed,
mods_latched,
mods_locked,
group,
} => {
let mut guard = udata.xkb_state.lock().unwrap();
let state = match guard.as_mut() {
Some(state) => state,
None => return,
};
// Apply the new xkb state with the new modifiers.
let _ = state.update_mask(mods_depressed, mods_latched, mods_locked, 0, 0, group);
// Update the currently repeating key if any.
#[cfg(feature = "calloop")]
if let Some(repeat_data) = udata.repeat_data.lock().unwrap().as_mut() {
if let Some(mut event) = repeat_data.current_repeat.take() {
// Apply new modifiers to get new utf8.
event.key.utf8 = {
let mut compose = udata.xkb_compose.lock().unwrap();
match compose.as_mut() {
Some(compose) => match compose.feed(event.key.keysym) {
xkb::FeedResult::Ignored => None,
xkb::FeedResult::Accepted => match compose.status() {
xkb::Status::Composed => compose.utf8(),
xkb::Status::Nothing => Some(
state
.key_get_utf8(KeyCode::new(event.key.raw_code + 8)),
),
_ => None,
},
},
// No compose.
None => {
Some(state.key_get_utf8(KeyCode::new(event.key.raw_code + 8)))
}
}
};
// Update the stored event.
repeat_data.current_repeat = Some(event);
}
}
// Drop guard before calling user code.
drop(guard);
let raw_modifiers = RawModifiers {
depressed: mods_depressed,
latched: mods_latched,
locked: mods_locked,
};
// Always issue the modifiers update for the user.
let modifiers = udata.update_modifiers();
data.update_modifiers(conn, qh, keyboard, serial, modifiers, raw_modifiers, group);
}
wl_keyboard::Event::RepeatInfo { rate, delay } => {
let info = if rate != 0 {
RepeatInfo::Repeat {
rate: NonZeroU32::new(rate as u32).unwrap(),
delay: delay as u32,
}
} else {
RepeatInfo::Disable
};
#[cfg(feature = "calloop")]
{
if let Some(repeat_data) = udata.repeat_data.lock().unwrap().as_mut() {
repeat_data.repeat_info = info;
}
}
data.update_repeat_info(conn, qh, keyboard, info);
}
_ => unreachable!(),
}
}
}