smart_keymap/key/mod.rs
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
use core::fmt::Debug;
use serde::Deserialize;
use crate::input;
/// Chorded keys. (Chording functionality).
pub mod chorded;
/// HID Keyboard keys.
pub mod keyboard;
/// Layered keys. (Layering functionality).
pub mod layered;
/// Tap-Hold keys.
pub mod tap_hold;
/// "Composite" keys; an aggregate type used for a common context and event.
pub mod composite;
/// The maximum number of key events that are emitted [Key] or [PressedKeyState].
pub const MAX_KEY_EVENTS: usize = 3;
/// Events emitted when a [Key] is pressed.
#[derive(Debug, PartialEq, Eq)]
pub struct PressedKeyEvents<E, const M: usize = { MAX_KEY_EVENTS }>(
heapless::Vec<ScheduledEvent<E>, M>,
);
impl<E: Copy + Debug> PressedKeyEvents<E> {
/// Constructs a [PressedKeyEvents] with no events scheduled.
pub fn no_events() -> Self {
PressedKeyEvents(None.into_iter().collect())
}
/// Constructs a [PressedKeyEvents] with an immediate [Event].
pub fn event(event: Event<E>) -> Self {
PressedKeyEvents(Some(ScheduledEvent::immediate(event)).into_iter().collect())
}
/// Constructs a [PressedKeyEvents] with an [Event] scheduled after a delay.
pub fn scheduled_event(sch_event: ScheduledEvent<E>) -> Self {
PressedKeyEvents(Some(sch_event).into_iter().collect())
}
/// Adds an event with the schedule to the [PressedKeyEvents].
pub fn schedule_event(&mut self, delay: u16, event: Event<E>) {
self.0.push(ScheduledEvent::after(delay, event)).unwrap();
}
/// Adds events from the other [PressedKeyEvents] to the [PressedKeyEvents].
pub fn extend(&mut self, other: PressedKeyEvents<E>) {
other.0.into_iter().for_each(|ev| self.0.push(ev).unwrap());
}
/// Adds an event from to the [PressedKeyEvents].
pub fn add_event(&mut self, ev: ScheduledEvent<E>) {
self.0.push(ev).unwrap();
}
/// Maps over the PressedKeyEvents.
pub fn map_events<F>(&self, f: fn(E) -> F) -> PressedKeyEvents<F> {
PressedKeyEvents(
self.0
.as_slice()
.iter()
.map(|sch_ev| sch_ev.map_scheduled_event(f))
.collect(),
)
}
/// Maps the PressedKeyEvents to a new type.
pub fn into_events<F>(&self) -> PressedKeyEvents<F>
where
E: Into<F>,
{
PressedKeyEvents(
self.0
.as_slice()
.iter()
.map(|sch_ev| sch_ev.map_scheduled_event(|ev| ev.into()))
.collect(),
)
}
}
impl<E: Debug, const M: usize> IntoIterator for PressedKeyEvents<E, M> {
type Item = ScheduledEvent<E>;
type IntoIter = <heapless::Vec<ScheduledEvent<E>, M> as IntoIterator>::IntoIter;
fn into_iter(self) -> Self::IntoIter {
self.0.into_iter()
}
}
/// The interface for `Key` behaviour.
///
/// A `Key` has an associated [Context], `Event`, and [PressedKeyState].
///
/// The generic `PK` is used as the type of the `PressedKey` that the `Key`
/// produces.
/// (e.g. [layered::LayeredKey]'s pressed key state passes-through to
/// the keys of its layers).
pub trait Key: Debug {
/// The associated [Context] is used to provide state that
/// may affect behaviour when pressing the key.
/// (e.g. the behaviour of [layered::LayeredKey] depends on which
/// layers are active in [layered::Context]).
type Context: Copy;
/// The associated `Event` is to be handled by the associated [Context],
/// and any active [PressedKey]s.
type Event: Copy + Debug + PartialEq;
/// The associated [PressedKeyState] implements functionality
/// for the pressed key.
/// (e.g. [tap_hold::PressedKeyState] implements behaviour resolving
/// the pressed tap hold key as either 'tap' or 'hold').
type PressedKey: PressedKey<Context = Self::Context, Event = Self::Event>;
/// [Key::new_pressed_key] produces a pressed key value, and may
/// yield some [ScheduledEvent]s.
/// (e.g. [tap_hold::Key] schedules a [tap_hold::Event::TapHoldTimeout]
/// so that holding the key resolves as a hold).
fn new_pressed_key(
&self,
context: Self::Context,
keymap_index: u16,
) -> (Self::PressedKey, PressedKeyEvents<Self::Event>);
}
/// Used to provide state that may affect behaviour when pressing the key.
///
/// e.g. the behaviour of [layered::LayeredKey] depends on which
/// layers are active in [layered::Context].
pub trait Context: Clone + Copy {
/// The type of `Event` the context handles.
type Event;
/// Used to update the [Context]'s state.
fn handle_event(&mut self, event: Event<Self::Event>);
}
impl Context for () {
type Event = ();
fn handle_event(&mut self, _event: Event<Self::Event>) {}
}
/// Bool flags for each of the modifier keys (left ctrl, etc.).
#[derive(Deserialize, Default, Clone, Copy, PartialEq, Eq)]
pub struct KeyboardModifiers {
#[serde(default)]
left_ctrl: bool,
#[serde(default)]
left_shift: bool,
#[serde(default)]
left_alt: bool,
#[serde(default)]
left_gui: bool,
#[serde(default)]
right_ctrl: bool,
#[serde(default)]
right_shift: bool,
#[serde(default)]
right_alt: bool,
#[serde(default)]
right_gui: bool,
}
impl core::fmt::Debug for KeyboardModifiers {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
let mut ds = f.debug_struct("KeyboardModifiers");
if self.left_ctrl {
ds.field("left_ctrl", &true);
}
if self.left_shift {
ds.field("left_shift", &true);
}
if self.left_alt {
ds.field("left_alt", &true);
}
if self.left_gui {
ds.field("left_gui", &true);
}
if self.right_ctrl {
ds.field("right_ctrl", &true);
}
if self.right_shift {
ds.field("right_shift", &true);
}
if self.right_alt {
ds.field("right_alt", &true);
}
if self.right_gui {
ds.field("right_gui", &true);
}
ds.finish_non_exhaustive()
}
}
impl KeyboardModifiers {
/// Constructs with modifiers defaulting to false.
pub const fn new() -> Self {
KeyboardModifiers {
left_ctrl: false,
left_shift: false,
left_alt: false,
left_gui: false,
right_ctrl: false,
right_shift: false,
right_alt: false,
right_gui: false,
}
}
/// Constructs with the given key_code.
///
/// Returns None if the key_code is not a modifier key code.
pub const fn from_key_code(key_code: u8) -> Option<Self> {
match key_code {
0xE0 => Some(Self::LEFT_CTRL),
0xE1 => Some(Self::LEFT_SHIFT),
0xE2 => Some(Self::LEFT_ALT),
0xE3 => Some(Self::LEFT_GUI),
0xE4 => Some(Self::RIGHT_CTRL),
0xE5 => Some(Self::RIGHT_SHIFT),
0xE6 => Some(Self::RIGHT_ALT),
0xE7 => Some(Self::RIGHT_GUI),
_ => None,
}
}
/// Const for left ctrl.
pub const LEFT_CTRL: KeyboardModifiers = KeyboardModifiers {
left_ctrl: true,
..KeyboardModifiers::new()
};
/// Const for left shift.
pub const LEFT_SHIFT: KeyboardModifiers = KeyboardModifiers {
left_shift: true,
..KeyboardModifiers::new()
};
/// Const for left alt.
pub const LEFT_ALT: KeyboardModifiers = KeyboardModifiers {
left_alt: true,
..KeyboardModifiers::new()
};
/// Const for left gui.
pub const LEFT_GUI: KeyboardModifiers = KeyboardModifiers {
left_gui: true,
..KeyboardModifiers::new()
};
/// Const for right ctrl.
pub const RIGHT_CTRL: KeyboardModifiers = KeyboardModifiers {
right_ctrl: true,
..KeyboardModifiers::new()
};
/// Const for right shift.
pub const RIGHT_SHIFT: KeyboardModifiers = KeyboardModifiers {
right_shift: true,
..KeyboardModifiers::new()
};
/// Const for right alt.
pub const RIGHT_ALT: KeyboardModifiers = KeyboardModifiers {
right_alt: true,
..KeyboardModifiers::new()
};
/// Const for right gui.
pub const RIGHT_GUI: KeyboardModifiers = KeyboardModifiers {
right_gui: true,
..KeyboardModifiers::new()
};
/// Predicate for whether the key code is a modifier key code.
pub const fn is_modifier_key_code(key_code: u8) -> bool {
match key_code {
0xE0..=0xE7 => true,
_ => false,
}
}
/// Constructs a Vec of key codes from the modifiers.
pub fn as_key_codes(&self) -> heapless::Vec<u8, 8> {
let mut key_codes = heapless::Vec::new();
if self.left_ctrl {
key_codes.push(0xE0).unwrap();
}
if self.left_shift {
key_codes.push(0xE1).unwrap();
}
if self.left_alt {
key_codes.push(0xE2).unwrap();
}
if self.left_gui {
key_codes.push(0xE3).unwrap();
}
if self.right_ctrl {
key_codes.push(0xE4).unwrap();
}
if self.right_shift {
key_codes.push(0xE5).unwrap();
}
if self.right_alt {
key_codes.push(0xE6).unwrap();
}
if self.right_gui {
key_codes.push(0xE7).unwrap();
}
key_codes
}
/// Constructs the byte for the modifiers of an HID keyboard report.
pub fn as_byte(&self) -> u8 {
self.as_key_codes()
.iter()
.fold(0u8, |acc, &kc| acc | (1 << (kc - 0xE0)))
}
/// Union of two KeyboardModifiers, taking "or" of each modifier.
pub const fn union(&self, other: &KeyboardModifiers) -> KeyboardModifiers {
KeyboardModifiers {
left_ctrl: self.left_ctrl || other.left_ctrl,
left_shift: self.left_shift || other.left_shift,
left_alt: self.left_alt || other.left_alt,
left_gui: self.left_gui || other.left_gui,
right_ctrl: self.right_ctrl || other.right_ctrl,
right_shift: self.right_shift || other.right_shift,
right_alt: self.right_alt || other.right_alt,
right_gui: self.right_gui || other.right_gui,
}
}
}
/// Struct for the output from [PressedKey].
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct KeyOutput {
key_code: u8,
key_modifiers: KeyboardModifiers,
}
impl KeyOutput {
/// Constructs a [KeyOutput] from a key code.
pub fn from_key_code(key_code: u8) -> Self {
if let Some(key_modifiers) = KeyboardModifiers::from_key_code(key_code) {
KeyOutput {
key_code: 0x00,
key_modifiers,
}
} else {
KeyOutput {
key_code,
key_modifiers: KeyboardModifiers::new(),
}
}
}
/// Constructs a [KeyOutput] from a key code with the given keyboard modifiers.
pub fn from_key_code_with_modifiers(key_code: u8, key_modifiers: KeyboardModifiers) -> Self {
let KeyOutput {
key_code,
key_modifiers: km,
} = Self::from_key_code(key_code);
KeyOutput {
key_code,
key_modifiers: km.union(&key_modifiers),
}
}
/// Constructs a [KeyOutput] for just the given keyboard modifiers.
pub fn from_key_modifiers(key_modifiers: KeyboardModifiers) -> Self {
KeyOutput {
key_code: 0x00,
key_modifiers,
}
}
/// Returns the key code value.
pub fn key_code(&self) -> u8 {
self.key_code
}
/// Returns the keyboard modifiers of the key output.
pub fn key_modifiers(&self) -> KeyboardModifiers {
self.key_modifiers
}
}
/// Whether the key output is pending or resolved.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum KeyOutputState {
/// The key state is pending.
Pending,
/// The key has output.
Resolved(Option<KeyOutput>),
}
impl KeyOutputState {
/// Constructs a [KeyOutputState] with a resolved key output.
pub fn resolved(key_output: KeyOutput) -> Self {
KeyOutputState::Resolved(Some(key_output))
}
/// Constructs a [KeyOutputState] indicating the key is resolved with no output.
pub fn no_output() -> Self {
KeyOutputState::Resolved(None)
}
/// Constructs a [KeyOutputState] indicating the key state is pending.
pub fn pending() -> Self {
KeyOutputState::Pending
}
/// Predicate for whether the key output is resolved.
pub fn is_resolved(&self) -> bool {
matches!(self, KeyOutputState::Resolved(_))
}
/// Returns the key output as an Option.
pub fn to_option(&self) -> Option<KeyOutput> {
match self {
KeyOutputState::Resolved(key_output) => *key_output,
_ => None,
}
}
}
/// [PressedKeyState] for a stateful pressed key value.
pub trait PressedKey: Debug {
/// The type of `Context` the pressed key handles.
type Context;
/// The type of `Event` the pressed key handles.
type Event;
/// Used to update the [PressedKey]'s state, and possibly yield event(s).
fn handle_event(
&mut self,
context: Self::Context,
event: Event<Self::Event>,
) -> PressedKeyEvents<Self::Event>;
/// Output for the pressed key.
fn key_output(&self) -> KeyOutputState;
}
/// Implements functionality for the pressed key.
///
/// e.g. [tap_hold::PressedKeyState] implements behaviour resolving
/// the pressed tap hold key as either 'tap' or 'hold'.
pub trait PressedKeyState<K>: Debug {
/// The type of `Context` the pressed key state handles.
type Context;
/// The type of `Event` the pressed key state handles.
type Event;
/// Used to update the [PressedKeyState]'s state, and possibly yield event(s).
fn handle_event_for(
&mut self,
context: Self::Context,
keymap_index: u16,
key: &K,
event: Event<Self::Event>,
) -> PressedKeyEvents<Self::Event>;
/// Output for the pressed key state.
fn key_output(&self, key: &K) -> KeyOutputState;
}
/// Errors for [TryFrom] implementations.
#[allow(unused)]
pub enum EventError {
/// Error when mapping isn't possible.
///
/// e.g. trying to map variants of [composite::Event] to [tap_hold::Event].
UnmappableEvent,
}
/// Convenience alias for a [Result] with an [EventError].
type EventResult<T> = Result<T, EventError>;
/// Events which are either input, or for a particular [Key::Event].
///
/// It's useful for [Key] implementations to use [Event] with [Key::Event],
/// and map [Key::Event] to and partially from [composite::Event].
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Event<T> {
/// Keymap input events, such as physical key presses.
Input(input::Event),
/// [Key] implementation specific events.
Key {
/// The keymap index the event was generated from.
keymap_index: u16,
/// A [Key::Event] event.
key_event: T,
},
}
impl<T: Copy> Event<T> {
/// Constructs an [Event] from an [Key::Event].
pub fn key_event(keymap_index: u16, key_event: T) -> Self {
Event::Key {
keymap_index,
key_event,
}
}
/// Maps the Event into a new type.
pub fn map_key_event<U>(&self, f: fn(T) -> U) -> Event<U> {
match self {
Event::Input(event) => Event::Input(*event),
Event::Key {
key_event,
keymap_index,
} => Event::Key {
key_event: f(*key_event),
keymap_index: *keymap_index,
},
}
}
/// Maps the Event into a new type.
pub fn into_key_event<U>(&self) -> Event<U>
where
T: Into<U>,
{
self.map_key_event(|ke| ke.into())
}
/// Maps the Event into a new type.
pub fn try_into_key_event<U, E>(&self, f: fn(T) -> Result<U, E>) -> EventResult<Event<U>> {
match self {
Event::Input(event) => Ok(Event::Input(*event)),
Event::Key {
key_event,
keymap_index,
} => f(*key_event)
.map(|key_event| Event::Key {
key_event,
keymap_index: *keymap_index,
})
.map_err(|_| EventError::UnmappableEvent),
}
}
}
impl<T> From<input::Event> for Event<T> {
fn from(event: input::Event) -> Self {
Event::Input(event)
}
}
/// Schedule for a [ScheduledEvent].
#[allow(unused)]
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd, Eq, Ord)]
pub enum Schedule {
/// Immediately.
Immediate,
/// After a given number of `tick`s.
After(u16),
}
/// Schedules a given `T` with [Event], for some [Schedule].
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ScheduledEvent<T> {
/// Whether to handle the event immediately, or after some delay.
pub schedule: Schedule,
/// The event.
pub event: Event<T>,
}
impl<T: Copy> ScheduledEvent<T> {
/// Constructs a [ScheduledEvent] with [Schedule::Immediate].
#[allow(unused)]
pub fn immediate(event: Event<T>) -> Self {
ScheduledEvent {
schedule: Schedule::Immediate,
event,
}
}
/// Constructs a [ScheduledEvent] with [Schedule::After].
pub fn after(delay: u16, event: Event<T>) -> Self {
ScheduledEvent {
schedule: Schedule::After(delay),
event,
}
}
/// Maps the Event of the ScheduledEvent into a new type.
pub fn map_scheduled_event<U>(&self, f: fn(T) -> U) -> ScheduledEvent<U> {
ScheduledEvent {
event: self.event.map_key_event(f),
schedule: self.schedule,
}
}
/// Maps the ScheduledEvent into a new type.
pub fn into_scheduled_event<U>(&self) -> ScheduledEvent<U>
where
T: Into<U>,
{
self.map_scheduled_event(|e| e.into())
}
}