Skip to content

fix(macOS): re-enable event tap after macOS disables it #332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
duyhnynh wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(macOS): re-enable event tap after macOS disables it #332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions Sources/OpenKey/macOS/ModernKey/OpenKey.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@
CGKeyCode _keycode;
CGEventFlags _flag, _lastFlag = 0, _privateFlag;
CGEventTapProxy _proxy;

//defined in OpenKeyManager.m
extern void OpenKeyReEnableEventTap(void);

Uint16 _newCharString[MAX_UNICODE_STRING];
Uint16 _newCharSize;
Expand Down Expand Up @@ -599,6 +602,14 @@ CGKeyCode ConvertEventToKeyboadLayoutCompatKeyCode(CGEventRef keyEvent, CGKeyCod
* MAIN Callback.
*/
CGEventRef OpenKeyCallback(CGEventTapProxy proxy, CGEventType type, CGEventRef event, void *refcon) {
//macOS turns the tap off if this callback misses its deadline (heavy system load)
//or after certain user input, and tells us through these two pseudo event types.
//Without re-enabling here, OpenKey silently stops converting until it is relaunched.
if (type == kCGEventTapDisabledByTimeout || type == kCGEventTapDisabledByUserInput) {
OpenKeyReEnableEventTap();
return event;
}

//dont handle my event
if (CGEventGetIntegerValueField(event, kCGEventSourceStateID) == CGEventSourceGetSourceStateID(myEventSource)) {
return event;
Expand Down
8 changes: 8 additions & 0 deletions Sources/OpenKey/macOS/ModernKey/OpenKeyManager.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,14 @@ +(BOOL)initEventTap {
return YES;
}

// Called from OpenKeyCallback when macOS reports that it turned our tap off.
// Only this file owns `eventTap`, so re-enabling has to happen here.
void OpenKeyReEnableEventTap(void) {
if (eventTap) {
CGEventTapEnable(eventTap, true);
}
}

+(BOOL)stopEventTap {
if (_isInited) { //release all object
CFRunLoopRemoveSource(CFRunLoopGetCurrent(), runLoopSource, kCFRunLoopCommonModes);
Expand Down