From 5f94202520e24851fc1af86ec4f59062ab8e84d3 Mon Sep 17 00:00:00 2001 From: Boris Faure Date: Sun, 9 Jul 2023 15:42:50 +0200 Subject: [PATCH] sequences: be able to filter/restore some key presses --- src/action.rs | 6 +- src/layout.rs | 269 +++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 272 insertions(+), 3 deletions(-) diff --git a/src/action.rs b/src/action.rs index c9e0d24..1995b8b 100644 --- a/src/action.rs +++ b/src/action.rs @@ -7,7 +7,7 @@ use core::fmt::Debug; /// The different types of actions we support for key sequences/macros #[non_exhaustive] #[derive(Debug, Clone, Copy, Eq, PartialEq)] -pub enum SequenceEvent { +pub enum SequenceEvent { /// No operation action: just do nothing (a placeholder). NoOp, /// A keypress/keydown @@ -24,6 +24,10 @@ pub enum SequenceEvent { /// Cancels the running sequence and can be used to mark the end of a sequence /// instead of using a number of Release() events Complete, + /// If those keys are pressed, release them + Filter(&'static &'static [K]), + /// Restore keys if they were previously Filter-ed + Restore, } /// Behavior configuration of HoldTap. diff --git a/src/layout.rs b/src/layout.rs index 8274b6a..8345624 100644 --- a/src/layout.rs +++ b/src/layout.rs @@ -49,6 +49,7 @@ pub use keyberon_macros::*; use crate::action::{Action, HoldTapAction, HoldTapConfig, SequenceEvent}; use crate::key_code::KeyCode; use arraydeque::ArrayDeque; +use core::convert::TryFrom; use heapless::Vec; use State::*; @@ -326,7 +327,38 @@ impl<'a> Iterator for StackedIter<'a> { } #[derive(Debug, Copy, Clone)] -struct SequenceState { +/// Enum to save a state that represents a key pressed +enum SavedKeyCodeState { + /// Key pressed + NormalKey { keycode: K, coord: (u8, u8) }, + /// Fake key event for sequences + FakeKey { keycode: K }, +} + +impl From> for State { + /// Convert a [`SavedKeyCodeState`] into a [`State`] + fn from(saved: SavedKeyCodeState) -> Self { + match saved { + SavedKeyCodeState::NormalKey { keycode, coord } => Self::NormalKey { keycode, coord }, + SavedKeyCodeState::FakeKey { keycode } => Self::FakeKey { keycode }, + } + } +} + +impl TryFrom> for SavedKeyCodeState { + type Error = &'static str; + /// Try to convert a [`State`] into a [`SavedKeyCodeState`] + fn try_from(state: State) -> Result { + match state { + NormalKey { keycode, coord } => Ok(Self::NormalKey { keycode, coord }), + FakeKey { keycode } => Ok(Self::FakeKey { keycode }), + _ => Err("Unsupported State conversion to SavedKeyCodeState"), + } + } +} + +#[derive(Debug, Copy, Clone)] +struct SequenceState { /// Current event being processed cur_event: Option>, /// Remaining events to process @@ -335,6 +367,8 @@ struct SequenceState { delay: u32, /// Keycode of a key that should be released at the next tick tapped: Option, + /// Keys filtered that can be restored later + to_restore: [Option>; 64], } impl Default for SequenceState { @@ -344,6 +378,23 @@ impl Default for SequenceState { remaining_events: &[], delay: 0, tapped: None, + to_restore: [None; 64], + } + } +} +impl SequenceState { + fn add_to_restore(&mut self, s: State) { + for e in self.to_restore.iter_mut() { + if e.is_none() { + match s { + NormalKey { .. } | FakeKey { .. } => { + let saved = SavedKeyCodeState::::try_from(s); + *e = Some(saved.unwrap()); + } + _ => {} + } + return; + } } } } @@ -517,7 +568,36 @@ impl {} // We'll never get here + Some(SequenceEvent::Filter(keys)) => { + self.states = self + .states + .iter() + .filter_map(|s| match s.keycode() { + Some(k) => { + if keys.contains(&k) { + seq.add_to_restore(*s); + None + } else { + Some(*s) + } + } + _ => Some(*s), + }) + .collect() + } + Some(SequenceEvent::Restore) => seq + .to_restore + .iter() + .filter_map(|s| { + if let Some(saved) = s { + let _ = self.states.push((*saved).into()); + } + None + }) + .collect(), + _ => { + panic!("invalid sequence"); + } } } if !seq.remaining_events.is_empty() || seq.tapped.is_some() { @@ -1645,4 +1725,189 @@ mod test { // finished assert_keys(&[], layout.keycodes()); } + + #[test] + fn sequences_unshift() { + static LAYERS: Layers<8, 1, 1> = [[[ + k(LShift), + k(RShift), + k(A), + k(B), + k(C), + Sequence( + &[ + SequenceEvent::Press(A), + SequenceEvent::Release(A), + SequenceEvent::Press(RShift), + SequenceEvent::Press(B), + SequenceEvent::Release(B), + SequenceEvent::Release(RShift), + SequenceEvent::Press(C), + SequenceEvent::Release(C), + ] + .as_slice(), + ), + Sequence( + &[ + SequenceEvent::Tap(A), + SequenceEvent::Press(RShift), + SequenceEvent::Tap(B), + SequenceEvent::Release(RShift), + SequenceEvent::Tap(C), + ] + .as_slice(), + ), + Sequence( + &[ + SequenceEvent::Tap(A), + SequenceEvent::Filter(&[LShift, RShift].as_slice()), + SequenceEvent::Tap(B), + SequenceEvent::Restore, + SequenceEvent::Tap(C), + ] + .as_slice(), + ), + /* TODO: sequence with explicit Shift */ + ]]]; + let mut layout = Layout::new(&LAYERS); + + // Test a sequence that contains Shift + assert_eq!(CustomEvent::NoEvent, layout.tick()); + assert_keys(&[], layout.keycodes()); + layout.event(Press(0, 2)); // A + assert_eq!(CustomEvent::NoEvent, layout.tick()); + assert_keys(&[A], layout.keycodes()); + layout.event(Release(0, 2)); // A + assert_eq!(CustomEvent::NoEvent, layout.tick()); + assert_keys(&[], layout.keycodes()); + layout.event(Press(0, 1)); // RShift + assert_eq!(CustomEvent::NoEvent, layout.tick()); + assert_keys(&[RShift], layout.keycodes()); + layout.event(Press(0, 3)); // B + assert_eq!(CustomEvent::NoEvent, layout.tick()); + assert_keys(&[B, RShift], layout.keycodes()); + layout.event(Release(0, 3)); // B + assert_eq!(CustomEvent::NoEvent, layout.tick()); + assert_keys(&[RShift], layout.keycodes()); + layout.event(Release(0, 1)); // RShift + assert_eq!(CustomEvent::NoEvent, layout.tick()); + assert_keys(&[], layout.keycodes()); + layout.event(Press(0, 4)); // C + assert_eq!(CustomEvent::NoEvent, layout.tick()); + assert_keys(&[C], layout.keycodes()); + layout.event(Release(0, 4)); // C + assert_eq!(CustomEvent::NoEvent, layout.tick()); + assert_keys(&[], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); + assert_keys(&[], layout.keycodes()); + + // Test a sequence that contains Shift + layout.event(Press(0, 5)); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Sequence detected & added + assert_keys(&[], layout.keycodes()); + layout.event(Release(0, 5)); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // To Process Press(A) + assert_keys(&[A], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Release(A) + assert_keys(&[], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Press(RShift) + assert_keys(&[RShift], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Press(B) + assert_keys(&[RShift, B], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Release(B) + assert_keys(&[RShift], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Release(RShift) + assert_keys(&[], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Tap(C) + assert_keys(&[C], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Release(C) + assert_keys(&[], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Sequence is + // finished + assert_keys(&[], layout.keycodes()); + + // Test a sequence that contains Shift with Tap + layout.event(Press(0, 6)); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Sequence detected & added + assert_keys(&[], layout.keycodes()); + layout.event(Release(0, 6)); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // To Process Tap(A) + assert_keys(&[A], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Release(A) + assert_keys(&[], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Press(RShift) + assert_keys(&[RShift], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Tap(B) + assert_keys(&[RShift, B], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Release(B) + assert_keys(&[RShift], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Release(RShift) + assert_keys(&[], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Tap(C) + assert_keys(&[C], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Release(C) + assert_keys(&[], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Sequence is + // finished + assert_keys(&[], layout.keycodes()); + + // Test a sequence with Unshift/Restore while Shift has not been + // pressed + layout.event(Press(0, 7)); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Sequence detected & added + assert_keys(&[], layout.keycodes()); + layout.event(Release(0, 7)); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // To Process Tap(A) + assert_keys(&[A], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Release(A) + assert_keys(&[], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Unshift + assert_keys(&[], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Tap(B) + assert_keys(&[B], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Release(B) + assert_keys(&[], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // RestoreShift + assert_keys(&[], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Tap(C) + assert_keys(&[C], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Release(C) + assert_keys(&[], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Sequence is + // finished + assert_keys(&[], layout.keycodes()); + + // Test a sequence with Unshift/Restore while RShift has been pressed + + layout.event(Press(0, 1)); // RShift + assert_eq!(CustomEvent::NoEvent, layout.tick()); + assert_keys(&[RShift], layout.keycodes()); + + layout.event(Press(0, 7)); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Sequence detected & added + assert_keys(&[RShift], layout.keycodes()); + layout.event(Release(0, 7)); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // To Process Tap(A) + assert_keys(&[RShift, A], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Release(A) + assert_keys(&[RShift], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Unshift + assert_keys(&[], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Tap(B) + assert_keys(&[B], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Release(B) + assert_keys(&[], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // RestoreShift + assert_keys(&[RShift], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Tap(C) + assert_keys(&[RShift, C], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Release(C) + assert_keys(&[RShift], layout.keycodes()); + assert_eq!(CustomEvent::NoEvent, layout.tick()); // Sequence is + // finished + assert_keys(&[RShift], layout.keycodes()); + layout.event(Release(0, 1)); // RShift + assert_eq!(CustomEvent::NoEvent, layout.tick()); + assert_keys(&[], layout.keycodes()); + } }