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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
use accessibility_sys::{
AXError, AXObserverRef, AXUIElementCreateApplication, AXUIElementRef,
kAXErrorNotificationAlreadyRegistered, kAXErrorSuccess,
};
use core::ptr::NonNull;
use log::{debug, error, info, warn};
use notify::event::{DataChange, ModifyKind};
use notify::{EventKind, FsEventWatcher, RecommendedWatcher, RecursiveMode, Watcher};
use objc2::rc::{Retained, autoreleasepool};
use objc2::{AllocAnyThread, DefinedClass, define_class, msg_send, sel};
use objc2_app_kit::{
NSApplication, NSApplicationActivationPolicy, NSEvent, NSEventType, NSRunningApplication,
NSTouch, NSTouchPhase, NSWorkspace, NSWorkspaceApplicationKey,
};
use objc2_core_foundation::{
CFMachPort, CFRetained, CFRunLoop, CFString, kCFRunLoopCommonModes, kCFRunLoopDefaultMode,
};
use objc2_core_graphics::{
CGDirectDisplayID, CGDisplayChangeSummaryFlags, CGDisplayRegisterReconfigurationCallback,
CGDisplayRemoveReconfigurationCallback, CGError, CGEvent, CGEventField, CGEventFlags,
CGEventTapLocation, CGEventTapOptions, CGEventTapPlacement, CGEventTapProxy, CGEventType,
};
use objc2_foundation::{
NSDictionary, NSDistributedNotificationCenter, NSKeyValueChangeNewKey, NSNotification,
NSNotificationCenter, NSNumber, NSObject, NSSet, NSString,
};
use std::env;
use std::ffi::c_void;
use std::io::ErrorKind;
use std::path::PathBuf;
use std::ptr::null_mut;
use std::sync::atomic::AtomicBool;
use std::sync::{Arc, LazyLock};
use std::time::Duration;
use stdext::function_name;
use crate::config::Config;
use crate::errors::{Error, Result};
use crate::events::{Event, EventSender};
use crate::process::Process;
use crate::skylight::OSStatus;
use crate::util::{AXUIWrapper, Cleanuper, add_run_loop, remove_run_loop};
pub type Pid = i32;
pub type CFStringRef = *const CFString;
type AXObserverCallback = unsafe extern "C" fn(
observer: AXObserverRef,
element: AXUIElementRef,
notification: CFStringRef,
refcon: *mut c_void,
);
unsafe extern "C" {
/// Creates an `AXObserver` for a given application process ID and a callback function.
///
/// # Arguments
///
/// * `application` - The process ID (Pid) of the application to observe.
/// * `callback` - The `AXObserverCallback` function to be invoked when notifications occur.
/// * `out_observer` - A mutable reference to an `AXObserverRef` where the created observer will be stored.
///
/// # Returns
///
/// An `AXError` indicating success or failure.
pub fn AXObserverCreate(
application: Pid,
callback: AXObserverCallback,
out_observer: &mut AXObserverRef,
) -> AXError;
/// Adds a notification to an `AXObserver` for a specific UI element.
///
/// # Arguments
///
/// * `observer` - The `AXObserverRef`.
/// * `element` - The `AXUIElementRef` to observe.
/// * `notification` - A reference to a `CFString` representing the notification name.
/// * `refcon` - A raw pointer to user-defined context data.
///
/// # Returns
///
/// An `AXError` indicating success or failure, including `kAXErrorNotificationAlreadyRegistered`.
pub fn AXObserverAddNotification(
observer: AXObserverRef,
element: AXUIElementRef,
notification: &CFString,
refcon: *mut c_void,
) -> AXError;
/// Removes a notification from an `AXObserver` for a specific UI element.
///
/// # Arguments
///
/// * `observer` - The `AXObserverRef`.
/// * `element` - The `AXUIElementRef` from which to remove the notification.
/// * `notification` - A reference to a `CFString` representing the notification name.
///
/// # Returns
///
/// An `AXError` indicating success or failure.
pub fn AXObserverRemoveNotification(
observer: AXObserverRef,
element: AXUIElementRef,
notification: &CFString,
) -> AXError;
}
#[derive(Clone, Copy, Debug, Default, Hash, PartialEq, Eq)]
#[repr(C)]
pub struct ProcessSerialNumber {
pub high: u32,
pub low: u32,
}
type ProcessCallbackFn = extern "C-unwind" fn(
this: *mut c_void,
event: *const ProcessEvent,
context: *const c_void,
) -> OSStatus;
unsafe extern "C" {
/// Retrieves the application event target.
///
/// # Returns
///
/// A raw pointer to an `EventTargetRef` for the application.
///
/// # Original signature
/// extern `EventTargetRef` GetApplicationEventTarget(void)
fn GetApplicationEventTarget() -> *const ProcessEventTarget;
/// Installs an event handler for a specific event target and event types.
///
/// # Arguments
///
/// * `target` - The `EventTargetRef` to install the handler on.
/// * `handler` - The `ProcessCallbackFn` to be called when events match.
/// * `event_len` - The number of event types in `events`.
/// * `events` - A raw pointer to an array of `EventTypeSpec` defining the events to handle.
/// * `user_data` - A raw pointer to user-defined data to pass to the handler.
/// * `handler_ref` - A mutable raw pointer to an `EventHandlerRef` where the installed handler
/// reference will be stored.
///
/// # Returns
///
/// An `OSStatus` indicating success or failure.
///
/// # Original signature
/// extern `OSStatus`
/// `InstallEventHandler`(
/// `EventTargetRef` inTarget,
/// `EventHandlerUPP` inHandler,
/// `ItemCount` inNumTypes,
/// const `EventTypeSpec` * inList,
/// void * inUserData,
/// `EventHandlerRef` * outRef)
fn InstallEventHandler(
target: *const ProcessEventTarget,
handler: ProcessCallbackFn,
event_len: u32,
events: *const EventTypeSpec,
user_data: *const c_void,
handler_ref: *mut *const ProcessEventHandler,
) -> OSStatus;
/// Removes a previously installed event handler.
///
/// # Arguments
///
/// * `handler_ref` - A raw pointer to the `EventHandlerRef` to remove.
///
/// # Returns
///
/// An `OSStatus` indicating success or failure.
///
/// # Original signature
fn RemoveEventHandler(handler_ref: *const ProcessEventHandler) -> OSStatus;
/// Gets a piece of data from the given event, if it exists.
///
/// # Discussion
/// The Carbon Event Manager will automatically use `AppleEvent` coercion handlers to convert
/// the data in the event into the desired type, if possible. You may also pass `typeWildCard`
/// to request that the data be returned in its original format.
///
/// # Mac OS X threading
/// Not thread safe.
///
/// # Arguments
///
/// * `inEvent` - The event to get the parameter from.
/// * `inName` - The symbolic name of the parameter.
/// * `inDesiredType` - The desired type of the parameter.
/// * `outActualType` - The actual type of the parameter, or `NULL`.
/// * `inBufferSize` - The size of the output buffer specified by `outData`. Pass zero and
/// `NULL` for `outData` if data is not desired. * `outActualSize` - The actual size of the
/// data, or `NULL`.
/// * `outData` - The pointer to the buffer which will receive the parameter data, or `NULL`.
///
/// # Returns
///
/// An operating system result code (`OSStatus`).
///
/// # Original signature
/// extern `OSStatus`
/// `GetEventParameter`(
/// `EventRef` inEvent,
/// `EventParamName` inName,
/// `EventParamType` inDesiredType,
/// `EventParamType` * outActualType, /* can be NULL */
/// `ByteCount` inBufferSize,
/// `ByteCount` * outActualSize, /* can be NULL */
/// void * outData) /* can be NULL */
fn GetEventParameter(
event: *const ProcessEvent,
param_name: u32,
param_type: u32,
actual_type: *mut u32,
size: u32,
actual_size: *mut u32,
data: *mut c_void,
) -> OSStatus;
/// Returns the kind of the given event (e.g., mousedown).
///
/// # Discussion
/// Event kinds overlap between event classes (e.g., `kEventMouseDown` and `kEventAppActivated`
/// have the same value). The combination of class and kind determines an event signature.
///
/// # Mac OS X threading
/// Thread safe.
///
/// # Arguments
///
/// * `inEvent` - The event in question.
///
/// # Returns
///
/// The kind of the event (`UInt32`).
///
/// # Original signature
/// extern `UInt32` GetEventKind(EventRef inEvent)
fn GetEventKind(event: *const ProcessEvent) -> u32;
/// Retrieves the next available process's serial number.
///
/// # Arguments
///
/// * `psn` - A mutable pointer to a `ProcessSerialNumber` structure. On the first call, pass a
/// PSN with `kNoProcess` for `highLongOfPSN` and `lowLongOfPSN`. On subsequent calls, pass
/// the PSN returned by the previous call.
///
/// # Returns
///
/// An `OSStatus` code. `noErr` (0) if a process was found, otherwise an error code.
///
/// # Original signature
/// GetNextProcess(ProcessSerialNumber * pPSN)
fn GetNextProcess(psn: *mut ProcessSerialNumber) -> OSStatus;
}
/*
* EventTypeSpec
*
* Discussion:
* This structure is used to specify an event. Typically, a static
* array of EventTypeSpecs are passed into functions such as
* InstallEventHandler, as well as routines such as
* FlushEventsMatchingListFromQueue.
*/
// struct EventTypeSpec {
// OSType eventClass;
// UInt32 eventKind;
// };
#[repr(C)]
struct EventTypeSpec {
event_class: u32,
event_kind: u32,
}
#[repr(C)]
struct ProcessEventHandler {
_opaque: [u8; 0],
}
#[repr(C)]
struct ProcessEventTarget {
_opaque: [u8; 0],
}
#[repr(C)]
struct ProcessEvent {
_opaque: [u8; 0],
}
#[repr(C)]
struct ProcessHandler {
events: EventSender,
cleanup: Option<Cleanuper>,
observer: Retained<WorkspaceObserver>,
}
#[repr(C)]
#[allow(dead_code)]
enum ProcessEventApp {
Activated = 1,
Deactivated = 2,
Quit = 3,
LaunchNotification = 4,
Launched = 5,
Terminated = 6,
FrontSwitched = 7,
FocusMenuBar = 8,
FocusNextDocumentWindow = 9,
FocusNextFloatingWindow = 10,
FocusToolbar = 11,
FocusDrawer = 12,
GetDockTileMenu = 20,
UpdateDockTile = 21,
IsEventInInstantMouser = 104,
Hidden = 107,
Shown = 108,
SystemUIModeChanged = 109,
AvailableWindowBoundsChanged = 110,
ActiveWindowChanged = 111,
}
impl ProcessHandler {
/// Creates a new `ProcessHandler` instance.
///
/// # Arguments
///
/// * `events` - An `EventSender` to send process-related events.
/// * `observer` - A `Retained<WorkspaceObserver>` to pass to `ApplicationLaunched` events.
///
/// # Returns
///
/// A new `ProcessHandler`.
fn new(events: EventSender, observer: Retained<WorkspaceObserver>) -> Self {
ProcessHandler {
events,
cleanup: None,
observer,
}
}
/// Starts the process handler by registering a C-callback with the underlying private API.
/// It also sends initial `ApplicationLaunched` events for already running processes.
fn start(&mut self) {
const APPL_CLASS: &str = "appl";
const PROCESS_EVENT_LAUNCHED: u32 = 5;
const PROCESS_EVENT_TERMINATED: u32 = 6;
const PROCESS_EVENT_FRONTSWITCHED: u32 = 7;
info!("{}: Registering process_handler", function_name!());
// Fake launch the existing processes.
let mut psn = ProcessSerialNumber::default();
while 0 == unsafe { GetNextProcess(&raw mut psn) } {
self.process_handler(psn, ProcessEventApp::Launched);
}
let target = unsafe { GetApplicationEventTarget() };
let event_class = u32::from_be_bytes(APPL_CLASS.as_bytes().try_into().unwrap());
let events = [
EventTypeSpec {
event_class,
event_kind: PROCESS_EVENT_LAUNCHED,
},
EventTypeSpec {
event_class,
event_kind: PROCESS_EVENT_TERMINATED,
},
EventTypeSpec {
event_class,
event_kind: PROCESS_EVENT_FRONTSWITCHED,
},
];
let mut handler: *const ProcessEventHandler = std::ptr::null();
let result = unsafe {
InstallEventHandler(
target,
Self::callback,
3,
events.as_ptr(),
NonNull::new_unchecked(self).as_ptr().cast(),
&raw mut handler,
)
};
debug!(
"{}: Registered process_handler (result = {result}): {handler:x?}",
function_name!()
);
self.cleanup = Some(Cleanuper::new(Box::new(move || unsafe {
info!(
"{}: Unregistering process_handler: {handler:?}",
function_name!()
);
RemoveEventHandler(handler);
})));
}
/// The C-callback function invoked by the private process handling API. It dispatches to the `process_handler` method.
/// This function is declared as `extern "C-unwind"`.
///
/// # Arguments
///
/// * `_` - Unused callback info parameter.
/// * `event` - A raw pointer to the `ProcessEvent`.
/// * `this` - A raw pointer to the `ProcessHandler` instance.
///
/// # Returns
///
/// An `OSStatus`.
extern "C-unwind" fn callback(
_: *mut c_void,
event: *const ProcessEvent,
this: *const c_void,
) -> OSStatus {
match NonNull::new(this.cast_mut())
.map(|this| unsafe { this.cast::<ProcessHandler>().as_mut() })
{
Some(this) => {
const PARAM: &str = "psn "; // kEventParamProcessID and typeProcessSerialNumber
let param_name = u32::from_be_bytes(PARAM.as_bytes().try_into().unwrap());
let param_type = param_name; // Uses the same FourCharCode as param_name
let mut psn = ProcessSerialNumber::default();
let res = unsafe {
GetEventParameter(
event,
param_name,
param_type,
std::ptr::null_mut(),
std::mem::size_of::<ProcessSerialNumber>()
.try_into()
.unwrap(),
std::ptr::null_mut(),
NonNull::from(&mut psn).as_ptr().cast(),
)
};
if res == 0 {
let decoded: ProcessEventApp =
unsafe { std::mem::transmute(GetEventKind(event)) };
this.process_handler(psn, decoded);
}
}
_ => error!("Zero passed to Process Handler."),
}
0
}
/// Handles various process events received from the C callback. It sends corresponding `Event`s via `events`.
///
/// # Arguments
///
/// * `psn` - The `ProcessSerialNumber` of the process involved in the event.
/// * `event` - The `ProcessEventApp` indicating the type of event.
fn process_handler(&mut self, psn: ProcessSerialNumber, event: ProcessEventApp) {
let _ = match event {
ProcessEventApp::Launched => self.events.send(Event::ApplicationLaunched {
psn,
observer: self.observer.clone(),
}),
ProcessEventApp::Terminated => self.events.send(Event::ApplicationTerminated { psn }),
ProcessEventApp::FrontSwitched => {
self.events.send(Event::ApplicationFrontSwitched { psn })
}
_ => {
error!(
"{}: Unknown process event: {}",
function_name!(),
event as u32
);
Ok(())
}
}
.inspect_err(|err| error!("{}: error sending event: {err}", function_name!()));
}
}
struct InputHandler {
events: EventSender,
config: Config,
cleanup: Option<Cleanuper>,
finger_position: Option<Retained<NSSet<NSTouch>>>,
tap_port: Option<CFRetained<CFMachPort>>,
}
impl InputHandler {
/// Creates a new `InputHandler` instance.
///
/// # Arguments
///
/// * `events` - An `EventSender` to send input-related events.
/// * `config` - The `Config` object for looking up keybindings.
///
/// # Returns
///
/// A new `InputHandler`.
fn new(events: EventSender, config: Config) -> Self {
InputHandler {
events,
config,
cleanup: None,
finger_position: None,
tap_port: None,
}
}
/// Starts the input handler by creating and enabling a `CGEventTap`. It also sets up a cleanup hook.
///
/// # Returns
///
/// `Ok(())` if the event tap is created and started successfully, otherwise `Err(Error)`.
fn start(&mut self) -> Result<()> {
let mouse_event_mask = (1 << CGEventType::MouseMoved.0)
| (1 << CGEventType::LeftMouseDown.0)
| (1 << CGEventType::LeftMouseUp.0)
| (1 << CGEventType::LeftMouseDragged.0)
| (1 << CGEventType::RightMouseDown.0)
| (1 << CGEventType::RightMouseUp.0)
| (1 << CGEventType::RightMouseDragged.0)
| (1 << NSEventType::Gesture.0)
| (1 << CGEventType::KeyDown.0);
unsafe {
let this = NonNull::new_unchecked(self).as_ptr();
self.tap_port = CGEvent::tap_create(
CGEventTapLocation::HIDEventTap,
CGEventTapPlacement::HeadInsertEventTap,
CGEventTapOptions::Default,
mouse_event_mask,
Some(Self::callback),
this.cast(),
);
if self.tap_port.is_none() {
return Err(Error::new(
ErrorKind::PermissionDenied,
format!("{}: Can not create EventTap.", function_name!()),
));
}
let (run_loop_source, main_loop) =
CFMachPort::new_run_loop_source(None, self.tap_port.as_deref(), 0)
.zip(CFRunLoop::main())
.ok_or(Error::new(
ErrorKind::PermissionDenied,
format!("{}: Unable to create run loop source", function_name!()),
))?;
CFRunLoop::add_source(&main_loop, Some(&run_loop_source), kCFRunLoopCommonModes);
let port = self.tap_port.clone().unwrap();
self.cleanup = Some(Cleanuper::new(Box::new(move || {
info!("{}: Unregistering event_handler", function_name!());
CFRunLoop::remove_source(&main_loop, Some(&run_loop_source), kCFRunLoopCommonModes);
CFMachPort::invalidate(&port);
CGEvent::tap_enable(&port, false);
})));
}
Ok(())
}
/// The C-callback function for the `CGEventTap`. It dispatches to the `input_handler` method.
/// This function is declared as `extern "C-unwind"`.
///
/// # Arguments
///
/// * `_` - The `CGEventTapProxy` (unused).
/// * `event_type` - The `CGEventType` of the event.
/// * `event_ref` - A mutable `NonNull` pointer to the `CGEvent`.
/// * `this` - A raw pointer to the `InputHandler` instance.
///
/// # Returns
///
/// A raw mutable pointer to `CGEvent`. Returns `null_mut()` if the event is intercepted.
extern "C-unwind" fn callback(
_: CGEventTapProxy,
event_type: CGEventType,
mut event_ref: NonNull<CGEvent>,
this: *mut c_void,
) -> *mut CGEvent {
match NonNull::new(this).map(|this| unsafe { this.cast::<InputHandler>().as_mut() }) {
Some(this) => {
let intercept = this.input_handler(event_type, unsafe { event_ref.as_ref() });
if intercept {
return null_mut();
}
}
_ => error!("Zero passed to Event Handler."),
}
unsafe { event_ref.as_mut() }
}
/// Handles various input events received from the `CGEventTap` callback. It sends corresponding `Event`s.
///
/// # Arguments
///
/// * `event_type` - The `CGEventType` of the event.
/// * `event` - A reference to the `CGEvent`.
///
/// # Returns
///
/// `true` if the event should be intercepted (not passed further), `false` otherwise.
fn input_handler(&mut self, event_type: CGEventType, event: &CGEvent) -> bool {
let result = match event_type {
CGEventType::TapDisabledByTimeout | CGEventType::TapDisabledByUserInput => {
info!("{}: Tap Disabled", function_name!());
if let Some(port) = &self.tap_port {
CGEvent::tap_enable(port, true);
}
Ok(())
}
CGEventType::LeftMouseDown | CGEventType::RightMouseDown => {
let point = CGEvent::location(Some(event));
self.events.send(Event::MouseDown { point })
}
CGEventType::LeftMouseUp | CGEventType::RightMouseUp => {
let point = CGEvent::location(Some(event));
self.events.send(Event::MouseUp { point })
}
CGEventType::LeftMouseDragged | CGEventType::RightMouseDragged => {
let point = CGEvent::location(Some(event));
self.events.send(Event::MouseDragged { point })
}
CGEventType::MouseMoved => {
let point = CGEvent::location(Some(event));
self.events.send(Event::MouseMoved { point })
}
CGEventType::KeyDown => {
let keycode =
CGEvent::integer_value_field(Some(event), CGEventField::KeyboardEventKeycode);
let eventflags = CGEvent::flags(Some(event));
// handle_keypress can intercept the event, so it may return true.
return self.handle_keypress(keycode, eventflags);
}
_ => self.handle_swipe(event),
};
if let Err(err) = result {
error!("{}: error sending event: {err}", function_name!());
// The socket is dead, so no use trying to send to it.
// Trigger cleanup destructor, unregistering the handler.
self.cleanup = None;
}
// Do not intercept this event, let it fall through.
false
}
/// Handles swipe gesture events.
/// It calculates the delta of the swipe and sends a `Swipe` event.
///
/// # Arguments
///
/// * `event` - A reference to the `CGEvent`.
///
/// # Returns
///
/// `Ok(())` if the event is processed successfully, otherwise `Err(Error)`.
fn handle_swipe(&mut self, event: &CGEvent) -> Result<()> {
const GESTURE_MINIMAL_FINGERS: usize = 3;
let Some(ns_event) = NSEvent::eventWithCGEvent(event) else {
return Err(Error::new(
ErrorKind::InvalidInput,
format!(
"{}: Unable to convert {event:?} to NSEvent.",
function_name!()
),
));
};
if ns_event.r#type() != NSEventType::Gesture {
return Ok(());
}
let fingers = ns_event.allTouches();
if fingers.len() < GESTURE_MINIMAL_FINGERS {
return Ok(());
}
if fingers.iter().all(|f| f.phase() != NSTouchPhase::Began)
&& let Some(prev) = &self.finger_position
{
let deltas = prev
.iter()
.zip(&fingers)
.map(|(p, c)| p.normalizedPosition().x - c.normalizedPosition().x)
.collect::<Vec<_>>();
_ = self.events.send(Event::Swipe { deltas });
}
self.finger_position = Some(fingers);
Ok(())
}
/// Handles key press events. It determines the modifier mask and attempts to find a matching keybinding in the configuration.
/// If a binding is found, it sends a `Command` event and intercepts the key press.
///
/// # Arguments
///
/// * `keycode` - The key code of the pressed key.
/// * `eventflags` - The `CGEventFlags` representing active modifiers.
///
/// # Returns
///
/// `true` if the key press was handled and should be intercepted, `false` otherwise.
fn handle_keypress(&self, keycode: i64, eventflags: CGEventFlags) -> bool {
const MODIFIER_MASKS: [[u64; 3]; 4] = [
// Normal key, left, right.
[0x0008_0000, 0x0000_0020, 0x0000_0040], // Alt
[0x0002_0000, 0x0000_0002, 0x0000_0004], // Shift
[0x0010_0000, 0x0000_0008, 0x0000_0010], // Command
[0x0004_0000, 0x0000_0001, 0x0000_2000], // Control
];
let mask = MODIFIER_MASKS
.iter()
.enumerate()
.filter_map(|(bitshift, modifier)| {
modifier
.iter()
.any(|mask| *mask == (eventflags.0 & mask))
.then_some(1 << bitshift)
})
.reduce(|acc, mask| acc + mask)
.unwrap_or(0);
let keycode = keycode.try_into().ok();
keycode
.and_then(|keycode| self.config.find_keybind(keycode, mask))
.and_then(|command| {
self.events
.send(Event::Command { command })
.inspect_err(|err| error!("{}: Error sending command: {err}", function_name!()))
.ok()
})
.is_some()
}
}
#[derive(Debug, Clone)]
pub struct Ivars {
events: EventSender,
}
define_class!(
// SAFETY:
// - The superclass NSObject does not have any subclassing requirements.
// - `Observer` does not implement `Drop`.
#[unsafe(super(NSObject))]
// If we were implementing delegate methods like `NSApplicationDelegate`,
// we would specify the object to only be usable on the main thread:
// #[thread_kind = MainThreadOnly]
#[name = "Observer"]
#[ivars = Ivars]
#[derive(Debug)]
pub struct WorkspaceObserver;
impl WorkspaceObserver {
/// Called when the active display changes.
///
/// # Arguments
///
/// * `_` - The notification object (unused).
#[unsafe(method(activeDisplayDidChange:))]
fn display_changed(&self, _: &NSNotification) {
_ = self.ivars().events.send(Event::DisplayChanged);
}
/// Called when the active space changes.
///
/// # Arguments
///
/// * `_` - The notification object (unused).
#[unsafe(method(activeSpaceDidChange:))]
fn space_changed(&self, _: &NSNotification) {
_ = self.ivars().events.send(Event::SpaceChanged);
}
/// Called when an application is hidden.
///
/// # Arguments
///
/// * `notification` - The notification object containing application info.
#[unsafe(method(didHideApplication:))]
fn application_hidden(&self, notification: &NSObject) {
// pid_t pid = [[notification.userInfo objectForKey:NSWorkspaceApplicationKey] processIdentifier];
let pid = unsafe {
let user_info: &NSDictionary = msg_send![notification, userInfo];
let app: &NSRunningApplication = msg_send![user_info, objectForKey: NSWorkspaceApplicationKey];
app.processIdentifier()
};
let msg = Event::ApplicationHidden{ pid };
_ = self.ivars().events.send(msg);
}
/// Called when an application is unhidden.
///
/// # Arguments
///
/// * `notification` - The notification object containing application info.
#[unsafe(method(didUnhideApplication:))]
fn application_unhidden(&self, notification: &NSObject) {
// pid_t pid = [[notification.userInfo objectForKey:NSWorkspaceApplicationKey] processIdentifier];
let pid = unsafe {
let user_info: &NSDictionary = msg_send![notification, userInfo];
let app: &NSRunningApplication = msg_send![user_info, objectForKey: NSWorkspaceApplicationKey];
app.processIdentifier()
};
let msg = Event::ApplicationVisible{ pid };
_ = self.ivars().events.send(msg);
}
/// Called when the system wakes from sleep.
///
/// # Arguments
///
/// * `notification` - The notification object.
#[unsafe(method(didWake:))]
fn system_woke(&self, notification: &NSObject) {
let msg = Event::SystemWoke{
msg: format!("WorkspaceObserver: {notification:?}"),
};
_ = self.ivars().events.send(msg);
}
/// Called when the menu bar hiding state changes.
///
/// # Arguments
///
/// * `notification` - The notification object.
#[unsafe(method(didChangeMenuBarHiding:))]
fn menubar_hidden(&self, notification: &NSObject) {
let msg = Event::MenuBarHiddenChanged{
msg: format!("WorkspaceObserver: {notification:?}"),
};
_ = self.ivars().events.send(msg);
}
/// Called when the Dock restarts.
///
/// # Arguments
///
/// * `notification` - The notification object.
#[unsafe(method(didRestartDock:))]
fn dock_restarted(&self, notification: &NSObject) {
let msg = Event::DockDidRestart{
msg: format!("WorkspaceObserver: {notification:?}"),
};
_ = self.ivars().events.send(msg);
}
/// Called when Dock preferences change.
///
/// # Arguments
///
/// * `notification` - The notification object.
#[unsafe(method(didChangeDockPref:))]
fn dock_pref_changed(&self, notification: &NSObject) {
let msg = Event::DockDidChangePref{
msg: format!("WorkspaceObserver: {notification:?}"),
};
_ = self.ivars().events.send(msg);
}
/// Called when a key-value observed property changes for a process.
///
/// # Arguments
///
/// * `key_path` - The key path of the changed property.
/// * `_object` - The object being observed (unused).
/// * `change` - A dictionary containing details of the change.
/// * `context` - The context pointer, expected to be a `*mut Process`.
#[unsafe(method(observeValueForKeyPath:ofObject:change:context:))]
fn observe_value_for_keypath(
&self,
key_path: &NSString,
_object: &NSObject,
change: &NSDictionary,
context: *mut c_void,
) {
let Some(process) = NonNull::new(context).map(|ptr| unsafe { ptr.cast::<Process>().as_mut() }) else {
warn!("{}: null pointer passed as context", function_name!());
return;
};
let result = unsafe { change.objectForKey(NSKeyValueChangeNewKey) };
let policy = result.and_then(|result| result.downcast_ref::<NSNumber>().map(NSNumber::intValue));
match key_path.to_string().as_ref() {
"finishedLaunching" => {
if policy.is_some_and(|value| value != 1) {
return;
}
process.unobserve_finished_launching();
}
"activationPolicy" => {
if policy.is_some_and(|value| i32::try_from(process.policy.0).is_ok_and(|policy| value == policy)) {
return;
}
process.policy = NSApplicationActivationPolicy(policy.unwrap() as isize);
process.unobserve_activation_policy();
}
err => {
warn!("{}: unknown key path {err:?}", function_name!());
return;
}
}
let msg = Event::ApplicationLaunched {
psn: process.psn,
observer: process.observer.clone(),
};
_= self.ivars().events.send(msg);
debug!(
"{}: got {key_path:?} for {}",
function_name!(),
process.name
);
}
}
);
impl WorkspaceObserver {
/// Creates a new `WorkspaceObserver` instance.
///
/// # Arguments
///
/// * `events` - An `EventSender` to send workspace-related events.
///
/// # Returns
///
/// A `Retained<Self>` containing the new `WorkspaceObserver` instance.
fn new(events: EventSender) -> Retained<Self> {
// Initialize instance variables.
let this = Self::alloc().set_ivars(Ivars { events });
// Call `NSObject`'s `init` method.
unsafe { msg_send![super(this), init] }
}
/// Starts observing workspace notifications by registering selectors with `NSWorkspace` and `NSDistributedNotificationCenter`.
fn start(&self) {
let methods = [
(
sel!(activeDisplayDidChange:),
"NSWorkspaceActiveDisplayDidChangeNotification",
),
(
sel!(activeSpaceDidChange:),
"NSWorkspaceActiveSpaceDidChangeNotification",
),
(
sel!(didHideApplication:),
"NSWorkspaceDidHideApplicationNotification",
),
(
sel!(didUnhideApplication:),
"NSWorkspaceDidUnhideApplicationNotification",
),
(sel!(didWake:), "NSWorkspaceDidWakeNotification"),
];
let shared_ws = NSWorkspace::sharedWorkspace();
let notification_center = shared_ws.notificationCenter();
for (sel, name) in &methods {
debug!("{}: registering {} with {name}", function_name!(), *sel);
let notification_type = NSString::from_str(name);
unsafe {
notification_center.addObserver_selector_name_object(
self,
*sel,
Some(¬ification_type),
None,
);
};
}
let methods = [
(
sel!(didChangeMenuBarHiding:),
"AppleInterfaceMenuBarHidingChangedNotification",
),
(sel!(didChangeDockPref:), "com.apple.dock.prefchanged"),
];
let distributed_notification_center = NSDistributedNotificationCenter::defaultCenter();
for (sel, name) in &methods {
debug!("{}: registering {} with {name}", function_name!(), *sel);
let notification_type = NSString::from_str(name);
unsafe {
distributed_notification_center.addObserver_selector_name_object(
self,
*sel,
Some(¬ification_type),
None,
);
};
}
let methods = [(
sel!(didRestartDock:),
"NSApplicationDockDidRestartNotification",
)];
let default_center = NSNotificationCenter::defaultCenter();
for (sel, name) in &methods {
debug!("{}: registering {} with {name}", function_name!(), *sel);
let notification_type = NSString::from_str(name);
unsafe {
default_center.addObserver_selector_name_object(
self,
*sel,
Some(¬ification_type),
None,
);
};
}
}
}
impl Drop for WorkspaceObserver {
/// Deregisters all previously registered notification callbacks when the `WorkspaceObserver` is dropped.
fn drop(&mut self) {
info!("{}: deregistering callbacks.", function_name!());
unsafe {
NSWorkspace::sharedWorkspace()
.notificationCenter()
.removeObserver(self);
NSNotificationCenter::defaultCenter().removeObserver(self);
NSDistributedNotificationCenter::defaultCenter().removeObserver(self);
}
}
}
#[derive(Debug)]
struct MissionControlHandler {
events: EventSender,
element: Option<CFRetained<AXUIWrapper>>,
observer: Option<CFRetained<AXUIWrapper>>,
}
impl MissionControlHandler {
/// Creates a new `MissionControlHandler` instance.
///
/// # Arguments
///
/// * `events` - An `EventSender` to send Mission Control related events.
///
/// # Returns
///
/// A new `MissionControlHandler`.
fn new(events: EventSender) -> Self {
Self {
events,
element: None,
observer: None,
}
}
const EVENTS: [&str; 4] = [
"AXExposeShowAllWindows",
"AXExposeShowFrontWindows",
"AXExposeShowDesktop",
"AXExposeExit",
];
/// Handles Mission Control accessibility notifications. It translates the notification string into a corresponding `Event`.
///
/// # Arguments
///
/// * `_observer` - The `AXObserverRef` (unused).
/// * `_element` - The `AXUIElementRef` (unused).
/// * `notification` - The name of the Mission Control notification as a string.
fn mission_control_handler(
&self,
_observer: AXObserverRef,
_element: AXUIElementRef,
notification: &str,
) {
let event = match notification {
"AXExposeShowAllWindows" => Event::MissionControlShowAllWindows,
"AXExposeShowFrontWindows" => Event::MissionControlShowFrontWindows,
"AXExposeShowDesktop" => Event::MissionControlShowDesktop,
"AXExposeExit" => Event::MissionControlExit,
_ => {
warn!(
"{}: Unknown mission control event: {notification}",
function_name!()
);
return;
}
};
_ = self
.events
.send(event)
.inspect_err(|err| error!("{}: error sending event: {err}", function_name!()));
}
/// Retrieves the process ID (Pid) of the Dock application.
///
/// # Returns
///
/// `Ok(Pid)` with the Dock's process ID if found, otherwise `Err(Error)`.
fn dock_pid() -> Result<Pid> {
let dock = NSString::from_str("com.apple.dock");
let array = NSRunningApplication::runningApplicationsWithBundleIdentifier(&dock);
array
.iter()
.next()
.map(|running| running.processIdentifier())
.ok_or(Error::new(
ErrorKind::NotFound,
format!("{}: can not find dock.", function_name!()),
))
}
/// Starts observing Mission Control accessibility notifications from the Dock process.
/// It creates an `AXObserver` and adds it to the run loop.
///
/// # Returns
///
/// `Ok(())` if observation is started successfully, otherwise `Err(Error)`.
fn observe(&mut self) -> Result<()> {
let pid = MissionControlHandler::dock_pid()?;
let element = AXUIWrapper::from_retained(unsafe { AXUIElementCreateApplication(pid) })?;
let observer = unsafe {
let mut observer_ref: AXObserverRef = null_mut();
if kAXErrorSuccess == AXObserverCreate(pid, Self::callback, &mut observer_ref) {
AXUIWrapper::from_retained(observer_ref)?
} else {
return Err(Error::new(
ErrorKind::PermissionDenied,
format!("{}: error creating observer.", function_name!()),
));
}
};
for name in &Self::EVENTS {
debug!(
"{}: {name:?} {:?}",
function_name!(),
observer.as_ptr::<AXObserverRef>()
);
let notification = CFString::from_static_str(name);
match unsafe {
AXObserverAddNotification(
observer.as_ptr(),
element.as_ptr(),
¬ification,
NonNull::new_unchecked(self).as_ptr().cast(),
)
} {
accessibility_sys::kAXErrorSuccess
| accessibility_sys::kAXErrorNotificationAlreadyRegistered => (),
result => error!(
"{}: error registering {name} for application {pid}: {result}",
function_name!(),
),
}
}
unsafe { add_run_loop(&observer, kCFRunLoopDefaultMode)? };
self.observer = observer.into();
self.element = element.into();
Ok(())
}
/// Stops observing Mission Control accessibility notifications and cleans up resources.
fn unobserve(&mut self) {
if let Some((observer, element)) = self.observer.take().zip(self.element.as_ref()) {
for name in &Self::EVENTS {
debug!(
"{}: {name:?} {:?}",
function_name!(),
observer.as_ptr::<AXObserverRef>()
);
let notification = CFString::from_static_str(name);
let result = unsafe {
AXObserverRemoveNotification(observer.as_ptr(), element.as_ptr(), ¬ification)
};
if result != kAXErrorSuccess && result != kAXErrorNotificationAlreadyRegistered {
error!("{}: error unregistering {name}: {result}", function_name!());
}
}
remove_run_loop(&observer);
drop(observer);
} else {
warn!(
"{}: unobserving without observe or element",
function_name!()
);
}
}
/// The static callback function for the Mission Control `AXObserver`. It dispatches to the `mission_control_handler` method.
///
/// # Arguments
///
/// * `observer` - The `AXObserverRef`.
/// * `element` - The `AXUIElementRef`.
/// * `notification` - The raw `CFStringRef` representing the notification name.
/// * `context` - A raw pointer to the `MissionControlHandler` instance.
extern "C" fn callback(
observer: AXObserverRef,
element: AXUIElementRef,
notification: CFStringRef,
context: *mut c_void,
) {
let Some(notification) = NonNull::new(notification.cast_mut()) else {
error!("{}: nullptr 'notification' passed.", function_name!());
return;
};
match NonNull::new(context)
.map(|this| unsafe { this.cast::<MissionControlHandler>().as_ref() })
{
Some(this) => {
let notification = unsafe { notification.as_ref() }.to_string();
this.mission_control_handler(observer, element, ¬ification);
}
_ => error!("Zero passed to MissionControlHandler."),
}
}
}
impl Drop for MissionControlHandler {
/// Unobserves Mission Control notifications when the `MissionControlHandler` is dropped.
fn drop(&mut self) {
self.unobserve();
}
}
struct DisplayHandler {
events: EventSender,
cleanup: Option<Cleanuper>,
}
impl DisplayHandler {
/// Creates a new `DisplayHandler` instance.
///
/// # Arguments
///
/// * `events` - An `EventSender` to send display-related events.
///
/// # Returns
///
/// A new `DisplayHandler`.
fn new(events: EventSender) -> Self {
Self {
events,
cleanup: None,
}
}
/// Starts the display handler by registering a callback for display reconfiguration events.
///
/// # Returns
///
/// `Ok(())` if the callback is registered successfully, otherwise `Err(Error)`.
fn start(&mut self) -> Result<()> {
info!("{}: Registering display handler", function_name!());
let this = unsafe { NonNull::new_unchecked(self).as_ptr() };
let result =
unsafe { CGDisplayRegisterReconfigurationCallback(Some(Self::callback), this.cast()) };
if result != CGError::Success {
return Err(Error::new(
ErrorKind::PermissionDenied,
format!(
"{}: registering display handler callback: {result:?}",
function_name!()
),
));
}
self.cleanup = Some(Cleanuper::new(Box::new(move || unsafe {
info!("{}: Unregistering display handler", function_name!());
CGDisplayRemoveReconfigurationCallback(Some(Self::callback), this.cast());
})));
Ok(())
}
/// The C-callback function for `CGDisplayReconfigurationCallback`. It dispatches to the `display_handler` method.
/// This function is declared as `extern "C-unwind"`.
///
/// # Arguments
///
/// * `display_id` - The `CGDirectDisplayID` of the display that changed.
/// * `flags` - The `CGDisplayChangeSummaryFlags` indicating the type of change.
/// * `context` - A raw pointer to the `DisplayHandler` instance.
extern "C-unwind" fn callback(
display_id: CGDirectDisplayID,
flags: CGDisplayChangeSummaryFlags,
context: *mut c_void,
) {
match NonNull::new(context).map(|this| unsafe { this.cast::<DisplayHandler>().as_mut() }) {
Some(this) => this.display_handler(display_id, flags),
_ => error!("Zero passed to Display Handler."),
}
}
/// Handles display change events and sends corresponding `Event`s (e.g., `DisplayAdded`, `DisplayRemoved`).
///
/// # Arguments
///
/// * `display_id` - The `CGDirectDisplayID` of the display that changed.
/// * `flags` - The `CGDisplayChangeSummaryFlags` indicating the type of change.
fn display_handler(
&mut self,
display_id: CGDirectDisplayID,
flags: CGDisplayChangeSummaryFlags,
) {
debug!("display_handler: display change {display_id:?}");
let event = if flags.contains(CGDisplayChangeSummaryFlags::AddFlag) {
Event::DisplayAdded { display_id }
} else if flags.contains(CGDisplayChangeSummaryFlags::RemoveFlag) {
Event::DisplayRemoved { display_id }
} else if flags.contains(CGDisplayChangeSummaryFlags::MovedFlag) {
Event::DisplayMoved { display_id }
} else if flags.contains(CGDisplayChangeSummaryFlags::DesktopShapeChangedFlag) {
Event::DisplayResized { display_id }
} else if flags.contains(CGDisplayChangeSummaryFlags::BeginConfigurationFlag) {
Event::DisplayConfigured { display_id }
} else {
warn!("{}: unknown flag {flags:?}.", function_name!());
return;
};
_ = self
.events
.send(event)
.inspect_err(|err| warn!("{}: error sending event: {err}", function_name!()));
}
}
struct ConfigHandler {
events: EventSender,
config: Config,
}
impl ConfigHandler {
/// Sends a `ConfigRefresh` event with the current configuration to the event handler.
///
/// # Returns
///
/// `Ok(())` if the event is sent successfully, otherwise `Err(Error)`.
fn announce_fresh_config(&self) -> Result<()> {
self.events.send(Event::ConfigRefresh {
config: self.config.clone(),
})?;
Ok(())
}
}
impl notify::EventHandler for ConfigHandler {
/// Handles file system events for the configuration file. When the content changes, it reloads the configuration.
///
/// # Arguments
///
/// * `event` - The result of a file system event.
fn handle_event(&mut self, event: notify::Result<notify::Event>) {
if let Ok(notify::Event {
kind: EventKind::Modify(ModifyKind::Data(DataChange::Content)),
paths: _,
attrs: _,
}) = event
{
info!("Reloading configuration file...");
_ = self
.config
.reload_config(CONFIGURATION_FILE.as_path())
.inspect_err(|err| {
error!("{}: error reloading config: {err}", function_name!());
});
_ = self.announce_fresh_config().inspect_err(|err| {
error!("{}: error announcing fresh config: {err}", function_name!());
});
}
}
}
/// Sets up a file system watcher for the configuration file.
///
/// # Arguments
///
/// * `events` - An `EventSender` to send `ConfigRefresh` events.
/// * `config` - The initial `Config` object.
///
/// # Returns
///
/// `Ok(FsEventWatcher)` if the watcher is set up successfully, otherwise `Err(Error)`.
fn setup_config_watcher(events: EventSender, config: Config) -> Result<FsEventWatcher> {
let setup = notify::Config::default().with_poll_interval(Duration::from_secs(3));
let config_handler = ConfigHandler { events, config };
config_handler.announce_fresh_config()?;
let watcher = RecommendedWatcher::new(config_handler, setup).and_then(|mut watcher| {
watcher.watch(CONFIGURATION_FILE.as_path(), RecursiveMode::NonRecursive)?;
Ok(watcher)
})?;
Ok(watcher)
}
pub static CONFIGURATION_FILE: LazyLock<PathBuf> = LazyLock::new(|| {
if let Ok(path_str) = env::var("PANERU_CONFIG") {
let path = PathBuf::from(path_str);
if path.exists() {
return path;
}
warn!(
"{}: $PANERU_CONFIG is set to {}, but the file does not exist. Falling back to default locations.",
function_name!(),
path.display()
);
}
let standard_paths = [
env::var("HOME")
.ok()
.map(|h| PathBuf::from(h).join(".paneru")),
env::var("HOME")
.ok()
.map(|h| PathBuf::from(h).join(".paneru.toml")),
env::var("XDG_CONFIG_HOME")
.ok()
.map(|x| PathBuf::from(x).join("paneru/paneru.toml")),
];
standard_paths
.into_iter()
.flatten()
.find(|path| path.exists())
.unwrap_or_else(|| {
panic!(
"{}: Configuration file not found. Tried: $PANERU_CONFIG, $HOME/.paneru, $HOME/.paneru.toml, $XDG_CONFIG_HOME/paneru/paneru.toml",
function_name!()
)
})
});
pub struct PlatformCallbacks {
events: EventSender,
process_handler: ProcessHandler,
event_handler: InputHandler,
workspace_observer: Retained<WorkspaceObserver>,
mission_control_observer: MissionControlHandler,
display_handler: DisplayHandler,
_config_watcher: FsEventWatcher,
}
impl PlatformCallbacks {
/// Creates a new `PlatformCallbacks` instance, initializing various handlers and watchers.
///
/// # Arguments
///
/// * `events` - An `EventSender` to be used by all platform callbacks.
///
/// # Returns
///
/// `Ok(std::pin::Pin<Box<Self>>)` if the instance is created successfully, otherwise `Err(Error)`.
pub fn new(events: EventSender) -> Result<std::pin::Pin<Box<Self>>> {
let config = Config::new(CONFIGURATION_FILE.as_path())?;
let workspace_observer = WorkspaceObserver::new(events.clone());
Ok(Box::pin(PlatformCallbacks {
process_handler: ProcessHandler::new(events.clone(), workspace_observer.clone()),
event_handler: InputHandler::new(events.clone(), config.clone()),
workspace_observer,
mission_control_observer: MissionControlHandler::new(events.clone()),
display_handler: DisplayHandler::new(events.clone()),
_config_watcher: setup_config_watcher(events.clone(), config)?,
events,
}))
}
/// Sets up and starts all platform-specific handlers, including input, display, Mission Control, workspace, and process handlers.
/// It also sends a `ProcessesLoaded` event.
///
/// # Returns
///
/// `Ok(())` if all handlers are set up successfully, otherwise `Err(Error)`.
pub fn setup_handlers(&mut self) -> Result<()> {
// This is required to receive some Cocoa notifications into Carbon code, like
// NSWorkspaceActiveSpaceDidChangeNotification and
// NSWorkspaceActiveDisplayDidChangeNotification
// Found on: https://stackoverflow.com/questions/68893386/unable-to-receive-nsworkspaceactivespacedidchangenotification-specifically-but
if !NSApplication::load() {
return Err(Error::new(
ErrorKind::Unsupported,
format!(
"{}: Can not startup Cocoa runloop from Carbon code.",
function_name!()
),
));
}
self.event_handler.start()?;
self.display_handler.start()?;
self.mission_control_observer.observe()?;
self.workspace_observer.start();
self.process_handler.start();
self.events.send(Event::ProcessesLoaded)
}
/// Runs the main event loop for platform callbacks. It continuously processes events until the `quit` signal is set.
///
/// # Arguments
///
/// * `quit` - An `Arc<AtomicBool>` used to signal the run loop to exit.
pub fn run(&mut self, quit: &Arc<AtomicBool>) {
info!("{}: Starting run loop...", function_name!());
loop {
if quit.load(std::sync::atomic::Ordering::Relaxed) {
break;
}
autoreleasepool(|_| unsafe {
CFRunLoop::run_in_mode(kCFRunLoopDefaultMode, 3.0, false);
});
}
_ = self.events.send(Event::Exit);
info!("{}: Run loop finished.", function_name!());
}
}