#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub(crate) struct InputSerials {
latest: Option<u32>,
keyboard_bound: bool,
keyboard_focus: bool,
}
#[cfg_attr(
not(feature = "clipboard"),
allow(dead_code, reason = "setting the selection is the clipboard's")
)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)]
pub(crate) enum SerialError {
#[error("no window of this application has keyboard focus")]
NotFocused,
#[error("this application has received no input yet")]
NoInput,
}
impl InputSerials {
pub(crate) fn record(&mut self, serial: u32) {
self.latest = Some(match self.latest {
Some(current) if !is_newer(serial, current) => current,
_ => serial,
});
}
pub(crate) fn set_keyboard_bound(&mut self, bound: bool) {
self.keyboard_bound = bound;
if !bound {
self.keyboard_focus = false;
}
}
pub(crate) fn keyboard_enter(&mut self, serial: u32) {
self.keyboard_focus = true;
self.record(serial);
}
pub(crate) fn keyboard_leave(&mut self) {
self.keyboard_focus = false;
}
#[cfg(all(test, feature = "clipboard"))]
pub(crate) fn has_keyboard_focus(&self) -> bool {
self.keyboard_focus
}
#[cfg_attr(
not(feature = "clipboard"),
allow(dead_code, reason = "setting the selection is the clipboard's")
)]
pub(crate) fn for_selection(&self) -> Result<u32, SerialError> {
if self.keyboard_bound && !self.keyboard_focus {
return Err(SerialError::NotFocused);
}
self.latest.ok_or(SerialError::NoInput)
}
}
fn is_newer(candidate: u32, current: u32) -> bool {
let ahead = candidate.wrapping_sub(current);
ahead != 0 && ahead < u32::MAX / 2
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn no_serial_before_any_input() {
let serials = InputSerials::default();
assert_eq!(serials.for_selection(), Err(SerialError::NoInput));
}
#[test]
fn the_newest_serial_wins() {
let mut serials = InputSerials::default();
serials.record(10);
serials.record(42);
serials.record(17); assert_eq!(serials.for_selection(), Ok(42));
}
#[test]
fn serials_compare_across_the_wrap() {
let mut serials = InputSerials::default();
serials.record(u32::MAX - 1);
serials.record(3); assert_eq!(serials.for_selection(), Ok(3));
serials.record(u32::MAX - 5); assert_eq!(serials.for_selection(), Ok(3));
}
#[test]
fn a_bound_keyboard_without_focus_refuses() {
let mut serials = InputSerials::default();
serials.set_keyboard_bound(true);
serials.record(5);
assert_eq!(serials.for_selection(), Err(SerialError::NotFocused));
serials.keyboard_enter(6);
assert_eq!(serials.for_selection(), Ok(6));
serials.keyboard_leave();
assert_eq!(serials.for_selection(), Err(SerialError::NotFocused));
}
#[test]
fn a_key_after_the_enter_is_the_serial_used() {
let mut serials = InputSerials::default();
serials.set_keyboard_bound(true);
serials.keyboard_enter(100);
serials.record(101); serials.record(102); assert_eq!(serials.for_selection(), Ok(102));
}
#[test]
fn a_seat_without_keyboard_uses_pointer_serials_alone() {
let mut serials = InputSerials::default();
serials.record(9); assert_eq!(serials.for_selection(), Ok(9));
}
#[test]
fn losing_the_keyboard_forgets_its_focus() {
let mut serials = InputSerials::default();
serials.set_keyboard_bound(true);
serials.keyboard_enter(1);
serials.set_keyboard_bound(false);
assert_eq!(serials.for_selection(), Ok(1));
}
}