-
Notifications
You must be signed in to change notification settings - Fork 28
Expand file tree
/
Copy pathsuppression.rs
More file actions
3266 lines (3096 loc) · 115 KB
/
Copy pathsuppression.rs
File metadata and controls
3266 lines (3096 loc) · 115 KB
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
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
use std::collections::{HashMap, HashSet, VecDeque};
use std::ffi::c_void;
use std::ptr;
use std::sync::atomic::{AtomicBool, AtomicPtr, AtomicU64, Ordering};
use std::sync::mpsc::{self, Receiver, Sender, SyncSender};
use std::sync::{Arc, Mutex};
use std::thread::{self, JoinHandle};
use std::time::Duration;
use color_eyre::eyre::{Result, eyre};
#[cfg(test)]
use crate::app_settings::HotkeyBinding;
use crate::app_settings::{HOTKEY_MODIFIERS_MASK, RuntimeHotkey, RuntimeHotkeys};
use crate::audio::CaptureInstant;
use crate::dictation::MINIMUM_HOLD_DURATION;
const DOUBLE_TAP_WINDOW: Duration = MINIMUM_HOLD_DURATION;
const ESCAPE_KEY_CODE: u16 = 53;
const EVENT_LEFT_MOUSE_DOWN: u32 = 1;
const EVENT_RIGHT_MOUSE_DOWN: u32 = 3;
const EVENT_KEY_DOWN: u32 = 10;
const EVENT_KEY_UP: u32 = 11;
const EVENT_FLAGS_CHANGED: u32 = 12;
const EVENT_OTHER_MOUSE_DOWN: u32 = 25;
const EVENT_TAP_DISABLED_BY_TIMEOUT: u32 = u32::MAX - 1;
const EVENT_TAP_DISABLED_BY_USER_INPUT: u32 = u32::MAX;
const KEYBOARD_EVENT_KEYCODE: u32 = 9;
const EVENT_SOURCE_USER_DATA: u32 = 42;
// Assistive keyboards inject downstream of HID; observe them alongside hardware input.
const ANNOTATED_SESSION_EVENT_TAP: u32 = 2;
const HEAD_INSERT_EVENT_TAP: u32 = 0;
const DEFAULT_EVENT_TAP: u32 = 0;
const LISTEN_ONLY_EVENT_TAP: u32 = 1;
#[cfg(test)]
const OPTION_KEY_MASK: u64 = 1 << 19;
#[cfg(test)]
const SHIFT_KEY_MASK: u64 = 1 << 17;
#[cfg(test)]
const CONTROL_KEY_MASK: u64 = 1 << 18;
const HID_SYSTEM_STATE: u32 = 1;
const COMBINED_SESSION_STATE: u32 = 0;
const STALE_KEY_NEUTRAL_DURATION: Duration = Duration::from_millis(100);
type EventRef = *mut c_void;
type EventTapCallback = unsafe extern "C" fn(
proxy: *mut c_void,
event_type: u32,
event: EventRef,
user_info: *mut c_void,
) -> EventRef;
#[link(name = "ApplicationServices", kind = "framework")]
unsafe extern "C" {
fn CGEventSourceFlagsState(state_id: u32) -> u64;
fn CGEventSourceKeyState(state_id: u32, key: u16) -> bool;
fn CGEventTapCreate(
tap: u32,
place: u32,
options: u32,
events_of_interest: u64,
callback: EventTapCallback,
user_info: *mut c_void,
) -> *mut c_void;
fn CGEventTapEnable(tap: *mut c_void, enable: bool);
fn CGEventGetFlags(event: EventRef) -> u64;
fn CGEventGetTimestamp(event: EventRef) -> u64;
fn CGEventGetIntegerValueField(event: EventRef, field: u32) -> i64;
}
#[link(name = "CoreFoundation", kind = "framework")]
unsafe extern "C" {
fn CFMachPortCreateRunLoopSource(
allocator: *const c_void,
port: *mut c_void,
order: isize,
) -> *mut c_void;
fn CFRunLoopAddSource(run_loop: *mut c_void, source: *mut c_void, mode: *const c_void);
fn CFRunLoopRemoveSource(run_loop: *mut c_void, source: *mut c_void, mode: *const c_void);
fn CFRunLoopGetCurrent() -> *mut c_void;
fn CFRunLoopRun();
fn CFRunLoopStop(run_loop: *mut c_void);
fn CFRelease(value: *const c_void);
static kCFRunLoopCommonModes: *const c_void;
}
#[derive(Clone, Copy, Debug)]
pub enum InputEvent {
Flags(u64),
Key { code: u16, down: bool, flags: u64 },
MouseDown,
TapDisabled,
}
impl InputEvent {
pub fn is_escape_down(self) -> bool {
matches!(
self,
Self::Key {
code: ESCAPE_KEY_CODE,
down: true,
..
}
)
}
}
pub fn physical_modifier_flags() -> u64 {
// SAFETY: HID state is a process-independent CoreGraphics query.
unsafe { CGEventSourceFlagsState(HID_SYSTEM_STATE) }
}
#[derive(Clone, Copy, Debug)]
pub struct ObservedInputEvent {
sequence: u64,
pub event: InputEvent,
pub capture_at: CaptureInstant,
}
#[derive(Clone, Default)]
pub struct PendingInputEvents(Arc<Mutex<VecDeque<(u64, CaptureInstant)>>>);
impl PendingInputEvents {
#[cfg(test)]
pub fn with_pending_for_test(at: CaptureInstant) -> (Self, impl FnOnce()) {
let pending = Self::default();
pending.push(0, at);
let acknowledge = pending.clone();
(pending, move || acknowledge.acknowledge(0))
}
pub fn oldest(&self) -> Option<CaptureInstant> {
self.0
.lock()
.unwrap_or_else(|error| error.into_inner())
.front()
.map(|(_, at)| *at)
}
fn push(&self, sequence: u64, at: CaptureInstant) {
self.0
.lock()
.unwrap_or_else(|error| error.into_inner())
.push_back((sequence, at));
}
fn acknowledge(&self, sequence: u64) {
let mut pending = self.0.lock().unwrap_or_else(|error| error.into_inner());
if pending.front().is_some_and(|(next, _)| *next == sequence) {
pending.pop_front();
}
}
}
pub struct InputMonitor {
pub events: Receiver<ObservedInputEvent>,
pub activity: InputActivity,
pending: PendingInputEvents,
escape_cancels: Arc<AtomicBool>,
run_loop: Arc<AtomicPtr<c_void>>,
worker: Option<JoinHandle<()>>,
}
pub struct PendingInputAcknowledgement<'a> {
pending: &'a PendingInputEvents,
sequence: u64,
}
impl Drop for PendingInputAcknowledgement<'_> {
fn drop(&mut self) {
self.pending.acknowledge(self.sequence);
}
}
#[derive(Clone, Default)]
pub struct InputActivity(Arc<AtomicU64>);
impl InputActivity {
pub fn revision(&self) -> u64 {
self.0.load(Ordering::Acquire)
}
pub fn invalidate(&self) {
self.0.fetch_add(1, Ordering::AcqRel);
}
fn observe(&self, input: InputEvent, suppressed: bool) {
if !suppressed
&& matches!(
input,
InputEvent::Key { down: true, .. } | InputEvent::MouseDown
)
{
self.invalidate();
}
}
}
impl InputMonitor {
pub fn start() -> Result<Self> {
let (sender, events) = mpsc::channel::<ObservedInputEvent>();
let (ready_sender, ready_receiver) = mpsc::sync_channel(1);
let activity = InputActivity::default();
let tap_activity = activity.clone();
let run_loop = Arc::new(AtomicPtr::new(ptr::null_mut()));
let tap_run_loop = run_loop.clone();
let escape_cancels = Arc::new(AtomicBool::new(false));
let tap_escape_cancels = escape_cancels.clone();
let paste_key_code = crate::keyboard::key_code_for('v').unwrap_or(9);
let pending = PendingInputEvents::default();
let tap_pending = pending.clone();
tracing::info!(
paste_key_code,
"resolved paste key for active keyboard layout"
);
let worker = thread::spawn(move || {
run_event_tap(
sender,
tap_activity,
tap_escape_cancels,
tap_pending,
tap_run_loop,
ready_sender,
)
});
ready_receiver
.recv_timeout(Duration::from_secs(2))
.map_err(|_| eyre!("timed out starting the keyboard event tap"))??;
Ok(Self {
events,
activity,
pending,
escape_cancels,
run_loop,
worker: Some(worker),
})
}
pub fn set_escape_cancels(&self, enabled: bool) {
self.escape_cancels.store(enabled, Ordering::Release);
}
pub fn pending_events(&self) -> PendingInputEvents {
self.pending.clone()
}
pub fn acknowledge_after(&self, event: ObservedInputEvent) -> PendingInputAcknowledgement<'_> {
PendingInputAcknowledgement {
pending: &self.pending,
sequence: event.sequence,
}
}
}
impl Drop for InputMonitor {
fn drop(&mut self) {
let run_loop = self.run_loop.load(Ordering::Acquire);
if !run_loop.is_null() {
// SAFETY: Core Foundation run loops may be stopped from any thread.
unsafe { CFRunLoopStop(run_loop) };
}
if let Some(worker) = self.worker.take() {
let _ = worker.join();
}
}
}
struct EventTapContext {
sender: Sender<ObservedInputEvent>,
activity: InputActivity,
escape_cancels: Arc<AtomicBool>,
key_tap: AtomicPtr<c_void>,
observation_tap: AtomicPtr<c_void>,
shortcut_suppression: Mutex<ShortcutSuppression>,
pending: PendingInputEvents,
next_sequence: AtomicU64,
}
fn run_event_tap(
sender: Sender<ObservedInputEvent>,
activity: InputActivity,
escape_cancels: Arc<AtomicBool>,
pending: PendingInputEvents,
run_loop: Arc<AtomicPtr<c_void>>,
ready: SyncSender<Result<()>>,
) {
let context = Box::into_raw(Box::new(EventTapContext {
sender,
activity,
escape_cancels,
key_tap: AtomicPtr::new(ptr::null_mut()),
observation_tap: AtomicPtr::new(ptr::null_mut()),
shortcut_suppression: Mutex::new(ShortcutSuppression::default()),
pending,
next_sequence: AtomicU64::new(0),
}));
let key_mask = [EVENT_KEY_DOWN, EVENT_KEY_UP]
.into_iter()
.fold(0, |mask, event| mask | 1_u64 << event);
let observation_mask = [
EVENT_LEFT_MOUSE_DOWN,
EVENT_RIGHT_MOUSE_DOWN,
EVENT_FLAGS_CHANGED,
EVENT_OTHER_MOUSE_DOWN,
]
.into_iter()
.fold(0, |mask, event| mask | 1_u64 << event);
// SAFETY: The callback context remains allocated until this run loop stops.
let key_tap = unsafe {
CGEventTapCreate(
ANNOTATED_SESSION_EVENT_TAP,
HEAD_INSERT_EVENT_TAP,
DEFAULT_EVENT_TAP,
key_mask,
event_callback,
context.cast(),
)
};
if key_tap.is_null() {
// SAFETY: No callback can run because tap creation failed.
unsafe { drop(Box::from_raw(context)) };
let _ = ready.send(Err(eyre!(
"could not create keyboard event tap; grant Input Monitoring and Accessibility permissions"
)));
return;
}
// A modifying tap disrupts Finder's Option-driven alternate menu items even when it returns
// flagsChanged events unchanged. Observe modifiers and mouse clicks with a passive tap.
let observation_tap = unsafe {
CGEventTapCreate(
ANNOTATED_SESSION_EVENT_TAP,
HEAD_INSERT_EVENT_TAP,
LISTEN_ONLY_EVENT_TAP,
observation_mask,
event_callback,
context.cast(),
)
};
if observation_tap.is_null() {
// SAFETY: The observation tap was not created, so no callback can use the context.
unsafe {
CGEventTapEnable(key_tap, false);
CFRelease(key_tap.cast_const());
drop(Box::from_raw(context));
}
let _ = ready.send(Err(eyre!("could not create input observation event tap")));
return;
}
// SAFETY: `context` remains owned by this event-tap thread.
unsafe {
(*context).key_tap.store(key_tap, Ordering::Release);
(*context)
.observation_tap
.store(observation_tap, Ordering::Release);
}
// SAFETY: Both taps are valid CFMachPorts returned above.
let key_source = unsafe { CFMachPortCreateRunLoopSource(ptr::null(), key_tap, 0) };
let observation_source =
unsafe { CFMachPortCreateRunLoopSource(ptr::null(), observation_tap, 0) };
if key_source.is_null() || observation_source.is_null() {
// SAFETY: Neither source has been attached to the run loop yet.
unsafe {
if !key_source.is_null() {
CFRelease(key_source.cast_const());
}
if !observation_source.is_null() {
CFRelease(observation_source.cast_const());
}
CGEventTapEnable(key_tap, false);
CGEventTapEnable(observation_tap, false);
CFRelease(key_tap.cast_const());
CFRelease(observation_tap.cast_const());
drop(Box::from_raw(context));
}
let _ = ready.send(Err(eyre!("could not create input run-loop sources")));
return;
}
// SAFETY: This is the dedicated event-tap thread's current run loop.
let current_run_loop = unsafe { CFRunLoopGetCurrent() };
run_loop.store(current_run_loop, Ordering::Release);
// SAFETY: All values belong to this thread and remain alive while the run loop runs.
unsafe {
CFRunLoopAddSource(current_run_loop, key_source, kCFRunLoopCommonModes);
CFRunLoopAddSource(current_run_loop, observation_source, kCFRunLoopCommonModes);
CGEventTapEnable(key_tap, true);
CGEventTapEnable(observation_tap, true);
}
let _ = ready.send(Ok(()));
// SAFETY: This dedicated thread exists solely to dispatch the event tap.
unsafe { CFRunLoopRun() };
// SAFETY: Disable the tap before releasing its callback context.
unsafe {
CGEventTapEnable(key_tap, false);
CGEventTapEnable(observation_tap, false);
CFRunLoopRemoveSource(current_run_loop, key_source, kCFRunLoopCommonModes);
CFRunLoopRemoveSource(current_run_loop, observation_source, kCFRunLoopCommonModes);
}
run_loop.store(ptr::null_mut(), Ordering::Release);
// SAFETY: The source is detached and the tap is disabled, so no callback can use context.
unsafe {
CFRelease(key_source.cast_const());
CFRelease(observation_source.cast_const());
CFRelease(key_tap.cast_const());
CFRelease(observation_tap.cast_const());
drop(Box::from_raw(context));
}
}
unsafe extern "C" fn event_callback(
_proxy: *mut c_void,
event_type: u32,
event: EventRef,
user_info: *mut c_void,
) -> EventRef {
if user_info.is_null() {
return event;
}
// SAFETY: `user_info` points to the context allocated by `run_event_tap`.
let context = unsafe { &*(user_info.cast::<EventTapContext>()) };
if matches!(
event_type,
EVENT_TAP_DISABLED_BY_TIMEOUT | EVENT_TAP_DISABLED_BY_USER_INPUT
) {
for tap in [&context.key_tap, &context.observation_tap] {
let tap = tap.load(Ordering::Acquire);
if !tap.is_null() {
// SAFETY: `tap` is a CFMachPort returned by `CGEventTapCreate`.
unsafe { CGEventTapEnable(tap, true) };
}
}
send_input(context, InputEvent::TapDisabled, CaptureInstant::ZERO);
return event;
}
if event.is_null() {
return event;
}
// SAFETY: CoreGraphics supplied a valid event to this callback.
if unsafe { CGEventGetIntegerValueField(event, EVENT_SOURCE_USER_DATA) }
== crate::keyboard::SYNTHETIC_EVENT_MARKER
{
return event;
}
let input = match event_type {
EVENT_FLAGS_CHANGED => {
// SAFETY: CoreGraphics supplied a valid event to this callback.
InputEvent::Flags(unsafe { CGEventGetFlags(event) })
}
EVENT_KEY_DOWN | EVENT_KEY_UP => InputEvent::Key {
// SAFETY: CoreGraphics supplied a valid keyboard event.
code: unsafe { CGEventGetIntegerValueField(event, KEYBOARD_EVENT_KEYCODE) as u16 },
down: event_type == EVENT_KEY_DOWN,
// SAFETY: CoreGraphics supplied a valid event.
flags: unsafe { CGEventGetFlags(event) },
},
EVENT_LEFT_MOUSE_DOWN | EVENT_RIGHT_MOUSE_DOWN | EVENT_OTHER_MOUSE_DOWN => {
InputEvent::MouseDown
}
_ => return event,
};
// Both taps are annotated-session taps: their timestamps are nanoseconds.
// Physical HID events used raw Mach ticks on the tested Apple Silicon system.
// SAFETY: CoreGraphics supplied a valid event to this callback.
let capture_at = CaptureInstant::from_nanos(unsafe { CGEventGetTimestamp(event) });
if crate::app_settings::hotkey_capture_active() {
context.activity.observe(input, false);
context
.shortcut_suppression
.lock()
.unwrap_or_else(|error| error.into_inner())
.reset();
return event;
}
let delivered = send_input(context, input, capture_at);
let mut suppression = context
.shortcut_suppression
.lock()
.unwrap_or_else(|error| error.into_inner());
let suppress =
suppression.process_escape(
input,
delivered,
context.escape_cancels.load(Ordering::Acquire),
) || suppression.process_all(input, crate::app_settings::runtime_hotkeys(), delivered);
context.activity.observe(input, suppress);
if suppress { ptr::null_mut() } else { event }
}
fn send_input(context: &EventTapContext, event: InputEvent, capture_at: CaptureInstant) -> bool {
let sequence = context.next_sequence.fetch_add(1, Ordering::Relaxed);
context.pending.push(sequence, capture_at);
match context.sender.send(ObservedInputEvent {
sequence,
event,
capture_at,
}) {
Ok(()) => true,
Err(_) => {
context.pending.acknowledge(sequence);
// SAFETY: The callback runs on the event-tap thread's run loop.
unsafe { CFRunLoopStop(CFRunLoopGetCurrent()) };
false
}
}
}
#[derive(Default)]
struct ShortcutSuppression {
// Repeats and releases keep the original press's suppression decision.
key_presses: HashMap<u16, bool>,
escape_pressed: bool,
}
impl ShortcutSuppression {
fn reset(&mut self) {
self.key_presses.clear();
self.escape_pressed = false;
}
fn process_all(&mut self, input: InputEvent, hotkeys: RuntimeHotkeys, delivered: bool) -> bool {
let bindings = [
Some(hotkeys.dictation),
hotkeys.edit,
hotkeys.paste_last,
hotkeys.paste_meeting,
];
match input {
InputEvent::Key {
code,
down: true,
flags,
} => *self.key_presses.entry(code).or_insert_with(|| {
delivered
&& bindings
.iter()
.flatten()
.any(|hotkey| hotkey.matches_key_press(code, flags))
}),
InputEvent::Key {
code, down: false, ..
} => self.key_presses.remove(&code).unwrap_or(false),
_ => false,
}
}
#[cfg(test)]
fn process(
&mut self,
input: InputEvent,
paste_key_code: u16,
hotkey: RuntimeHotkey,
delivered: bool,
) -> bool {
let mut paste_last = HotkeyBinding::paste_last_default().runtime();
paste_last.key_code = Some(paste_key_code);
let mut paste_meeting = HotkeyBinding::paste_meeting_default().runtime();
paste_meeting.key_code = Some(paste_key_code);
self.process_all(
input,
RuntimeHotkeys {
dictation: hotkey,
edit: None,
paste_last: Some(paste_last),
paste_meeting: Some(paste_meeting),
},
delivered,
)
}
fn process_escape(&mut self, input: InputEvent, delivered: bool, escape_cancels: bool) -> bool {
match input {
InputEvent::Key {
code: ESCAPE_KEY_CODE,
down: true,
..
} if delivered && escape_cancels => {
self.escape_pressed = true;
true
}
InputEvent::Key {
code: ESCAPE_KEY_CODE,
down: false,
..
} if std::mem::take(&mut self.escape_pressed) => true,
_ => false,
}
}
}
fn paste_action(input: InputEvent, hotkeys: RuntimeHotkeys) -> Option<HotkeyAction> {
let InputEvent::Key {
code,
down: true,
flags,
} = input
else {
return None;
};
hotkeys
.paste_last
.filter(|binding| binding.matches_key_press(code, flags))
.map(|_| HotkeyAction::PasteLast)
.or_else(|| {
hotkeys
.paste_meeting
.filter(|binding| binding.matches_key_press(code, flags))
.map(|_| HotkeyAction::PasteMeeting)
})
}
#[cfg(test)]
fn paste_action_with_meetings(
input: InputEvent,
paste_key_code: u16,
meetings_enabled: bool,
) -> Option<HotkeyAction> {
let mut hotkeys = RuntimeHotkeys::default();
if let Some(binding) = &mut hotkeys.paste_last {
binding.key_code = Some(paste_key_code);
}
hotkeys.paste_meeting = meetings_enabled.then(|| {
let mut binding = HotkeyBinding::paste_meeting_default().runtime();
binding.key_code = Some(paste_key_code);
binding
});
paste_action(input, hotkeys)
}
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum HotkeyAction {
Start,
Finish,
Discard,
Cancel,
PasteLast,
PasteMeeting,
}
#[derive(Debug)]
enum State {
Idle,
FirstTapPressed,
AwaitingSecondTap {
released_at: CaptureInstant,
},
SecondTapPressed {
first_released_at: CaptureInstant,
},
Recording {
started_at: CaptureInstant,
previous_release: Option<CaptureInstant>,
},
Locked,
Dirty,
}
pub struct DictationHotkey {
state: State,
pressed_keys: HashSet<u16>,
double_tap_enabled: bool,
double_tap_only: bool,
last_release_at: Option<CaptureInstant>,
binding: RuntimeHotkey,
paste_actions_enabled: bool,
ignore_before: Option<CaptureInstant>,
stale_keys_neutral_since: Option<CaptureInstant>,
recovery_ignore_through: Option<CaptureInstant>,
recovery_updated_keys: HashSet<u16>,
// Fn evidence comes only from modifier events; None marks a blind period.
// The timestamp prevents delayed events from restoring invalidated evidence.
function_modifier: (CaptureInstant, Option<bool>),
}
impl DictationHotkey {
pub fn new(now: CaptureInstant, double_tap_enabled: bool, binding: RuntimeHotkey) -> Self {
Self::with_binding(
trigger_is_physically_down(binding),
now,
double_tap_enabled,
binding,
)
}
pub fn new_without_paste(now: CaptureInstant, binding: RuntimeHotkey) -> Self {
let mut hotkey =
Self::with_binding(trigger_is_physically_down(binding), now, false, binding);
hotkey.paste_actions_enabled = false;
hotkey
}
fn with_binding(
trigger_down: bool,
now: CaptureInstant,
double_tap_enabled: bool,
binding: RuntimeHotkey,
) -> Self {
Self {
state: if trigger_down {
State::Recording {
started_at: now,
previous_release: None,
}
} else {
State::Idle
},
pressed_keys: HashSet::new(),
double_tap_enabled,
double_tap_only: false,
last_release_at: None,
binding,
paste_actions_enabled: true,
ignore_before: None,
stale_keys_neutral_since: None,
recovery_ignore_through: None,
recovery_updated_keys: HashSet::new(),
function_modifier: (CaptureInstant::ZERO, None),
}
}
pub fn is_recording(&self) -> bool {
matches!(self.state, State::Recording { .. } | State::Locked)
}
pub fn suppresses_recognition(&self) -> bool {
!matches!(self.state, State::Idle)
}
pub fn set_double_tap_enabled(&mut self, enabled: bool) {
self.double_tap_enabled = enabled;
if !enabled {
self.last_release_at = None;
if let State::Recording {
previous_release, ..
} = &mut self.state
{
*previous_release = None;
}
}
}
pub fn set_double_tap_only(&mut self, enabled: bool) {
self.double_tap_only =
enabled && self.binding.key_code.is_some() && self.double_tap_enabled;
// Active captures still need their release or Escape to reach the audio owner.
if !self.double_tap_only
&& matches!(
self.state,
State::FirstTapPressed
| State::AwaitingSecondTap { .. }
| State::SecondTapPressed { .. }
)
{
self.state = State::Idle;
}
}
pub fn set_binding(&mut self, binding: RuntimeHotkey) {
if matches!(self.state, State::Idle) && self.binding != binding {
self.binding = binding;
self.last_release_at = None;
}
}
pub fn suspend(&mut self) -> Option<HotkeyAction> {
let was_recording = self.is_recording();
self.function_modifier = (CaptureInstant::now(), None);
self.state = State::Idle;
self.pressed_keys.clear();
self.last_release_at = None;
self.stale_keys_neutral_since = None;
was_recording.then_some(HotkeyAction::Cancel)
}
pub fn disarm_pending_gesture(&mut self) {
if !self.is_recording() {
if matches!(
self.state,
State::FirstTapPressed
| State::AwaitingSecondTap { .. }
| State::SecondTapPressed { .. }
) {
self.state = State::Idle;
}
self.last_release_at = None;
self.stale_keys_neutral_since = None;
}
}
pub fn wait_for_release(&mut self) {
// A settings transition is not a new press; preserve held-key suppression.
let now = CaptureInstant::now();
// SAFETY: These are read-only queries of the documented HID system state.
let flags = unsafe { CGEventSourceFlagsState(HID_SYSTEM_STATE) };
let key_down = self
.binding
.key_code
.is_some_and(|code| unsafe { CGEventSourceKeyState(HID_SYSTEM_STATE, code) });
self.wait_for_release_with_state(now, flags, key_down);
}
pub fn suppress_until_release(&mut self) {
self.state = State::Dirty;
self.last_release_at = None;
self.stale_keys_neutral_since = None;
}
// Call only after draining input. Polling repairs bookkeeping, never capture boundaries.
pub fn recover_stale_keys(&mut self) {
self.recover_stale_keys_with(
CaptureInstant::now,
// Match the annotated-session tap, including assistive keyboard input.
|| unsafe { CGEventSourceFlagsState(COMBINED_SESSION_STATE) },
|code| unsafe { CGEventSourceKeyState(COMBINED_SESSION_STATE, code) },
);
}
fn recover_stale_keys_with(
&mut self,
now: impl FnOnce() -> CaptureInstant,
mut flags: impl FnMut() -> u64,
mut key_down: impl FnMut(u16) -> bool,
) {
if !matches!(self.state, State::Idle | State::Dirty)
|| (matches!(self.state, State::Idle) && self.pressed_keys.is_empty())
{
self.stale_keys_neutral_since = None;
return;
}
// A missing modifier release can leave Dirty with no ordinary keys tracked.
// Avoid a full scan when a tracked key is still physically held.
// Arrow key metadata can leave SecondaryFn set after release. Only ignore
// it when modifier-change events independently say Fn is not held.
let modifiers_mask = if self.function_modifier.1 == Some(false) {
HOTKEY_MODIFIERS_MASK & !crate::app_settings::FUNCTION_KEY_MASK
} else {
HOTKEY_MODIFIERS_MASK
};
if flags() & modifiers_mask != 0
|| (!self.pressed_keys.is_empty()
&& self.pressed_keys.iter().all(|&code| key_down(code)))
|| (0..128).any(&mut key_down)
|| flags() & modifiers_mask != 0
{
self.stale_keys_neutral_since = None;
return;
}
let sampled_through = now();
let Some(neutral_since) = self.stale_keys_neutral_since else {
self.stale_keys_neutral_since = Some(sampled_through);
return;
};
if sampled_through.duration_since(neutral_since) < STALE_KEY_NEUTRAL_DURATION {
return;
}
tracing::warn!(
key_count = self.pressed_keys.len(),
"resynchronized stale input tracking after neutral keyboard"
);
self.pressed_keys.clear();
self.last_release_at = None;
self.state = State::Idle;
self.stale_keys_neutral_since = None;
self.recovery_ignore_through = Some(sampled_through);
self.recovery_updated_keys.clear();
}
fn wait_for_release_with_state(&mut self, now: CaptureInstant, flags: u64, key_down: bool) {
self.suspend();
self.ignore_before = Some(now);
if key_down && let Some(code) = self.binding.key_code {
self.pressed_keys.insert(code);
}
if flags & HOTKEY_MODIFIERS_MASK != 0 || !self.pressed_keys.is_empty() {
self.state = State::Dirty;
}
}
// Suspended shortcut matching must still observe releases of previously held keys.
pub fn track_key_state(&mut self, event: InputEvent, at: CaptureInstant) -> Option<bool> {
self.stale_keys_neutral_since = None;
if let InputEvent::Flags(flags) = event
&& at >= self.function_modifier.0
{
self.function_modifier = (
at,
Some(flags & crate::app_settings::FUNCTION_KEY_MASK != 0),
);
} else if matches!(event, InputEvent::TapDisabled) {
self.function_modifier = (CaptureInstant::now(), None);
}
if let InputEvent::Key { code, .. } = event
&& let Some(fence) = self.recovery_ignore_through
{
// A delayed pre-recovery release must not erase a newer press of that key.
if at <= fence && self.recovery_updated_keys.contains(&code) {
return None;
}
if at > fence {
self.recovery_updated_keys.insert(code);
}
}
Some(match event {
InputEvent::Key { code, down, .. } => {
if down {
self.pressed_keys.insert(code)
} else {
self.pressed_keys.remove(&code);
false
}
}
InputEvent::Flags(_) | InputEvent::MouseDown | InputEvent::TapDisabled => false,
})
}
pub fn process(&mut self, event: InputEvent, now: CaptureInstant) -> Option<HotkeyAction> {
self.stale_keys_neutral_since = None;
if matches!(event, InputEvent::TapDisabled) {
let was_recording = self.is_recording();
self.function_modifier = (CaptureInstant::now(), None);
self.state = State::Dirty;
self.last_release_at = None;
return was_recording.then_some(HotkeyAction::Cancel);
}
// Queued edges from before an opt-in transition cannot start a new capture.
if self
.ignore_before
.is_some_and(|changed_at| now < changed_at)
{
return None;
}
let fresh_key_down = self.track_key_state(event, now)?;
if self
.recovery_ignore_through
.is_some_and(|sampled_through| now <= sampled_through)
{
// A key can go down during the non-atomic scan. Retain its edge but
// require a later neutral event before accepting another gesture.
// An old neutral release cannot invalidate the recovery's neutral sample.
let neutral = matches!(
event,
InputEvent::Flags(flags) | InputEvent::Key { flags, .. }
if flags & HOTKEY_MODIFIERS_MASK == 0 && self.pressed_keys.is_empty()
);
if !neutral && matches!(self.state, State::Idle | State::Dirty) {
self.state = State::Dirty;
}
return None;
}
if self.paste_actions_enabled
&& fresh_key_down
&& let Some(action) = paste_action(event, crate::app_settings::runtime_hotkeys())
{
self.state = State::Dirty;
self.last_release_at = None;
return Some(action);
}
if matches!(
event,
InputEvent::Key {
code: ESCAPE_KEY_CODE,
down: true,
..
}
) && self.is_recording()
{
self.state = State::Dirty;
self.last_release_at = None;
return Some(HotkeyAction::Cancel);
}
let trigger_pressed = self.trigger_pressed(event, fresh_key_down);
let flags = match event {
InputEvent::Flags(flags) | InputEvent::Key { flags, .. } => Some(flags),
InputEvent::MouseDown | InputEvent::TapDisabled => None,
};
let trigger_down = flags.is_some_and(|flags| {
self.binding.required_modifiers_down(flags)
&& self
.binding
.key_code
.is_none_or(|code| self.pressed_keys.contains(&code))
});
let trigger_released = flags.is_some() && !trigger_down;
let unrelated_key_down = matches!(
event,
InputEvent::Key {
code,
down: true,
..
} if self.binding.key_code != Some(code)
);
let extra_modifiers = flags.is_some_and(|flags| {
self.binding.required_modifiers_down(flags) && !self.binding.exact_modifiers(flags)
});
match self.state {
State::Idle if self.double_tap_only && trigger_pressed => {