385@property(nonatomic) NSMutableDictionary<NSNumber*, FlutterAsyncKeyCallback>* pendingResponses;
397- (void)synchronizeModifiers:(NSUInteger)currentFlags
398 ignoringFlags:(NSUInteger)ignoringFlags
399 timestamp:(NSTimeInterval)timestamp
408- (void)updateKey:(uint64_t)physicalKey asPressed:(uint64_t)logicalKey;
432- (void)sendCapsLockTapWithTimestamp:(NSTimeInterval)timestamp
433 synthesizeDown:(
bool)synthesizeDown
439- (void)sendModifierEventOfType:(
BOOL)isDownEvent
440 timestamp:(NSTimeInterval)timestamp
441 keyCode:(
unsigned short)keyCode
442 synthesized:(
bool)synthesized
458- (void)handleCapsLockEvent:(nonnull NSEvent*)event
469- (void)handleResponse:(
BOOL)handled forId:(uint64_t)responseId;
480 _sendEvent = sendEvent;
481 _pressingRecords = [NSMutableDictionary dictionary];
482 _pendingResponses = [NSMutableDictionary dictionary];
484 _lastModifierFlagsOfInterest = 0;
485 _modifierFlagOfInterestMask = computeModifierFlagOfInterestMask();
493 NSAssert(
callback != nil,
@"The callback must not be nil.");
496 switch (
event.type) {
497 case NSEventTypeKeyDown:
498 [
self handleDownEvent:event callback:guardedCallback];
500 case NSEventTypeKeyUp:
501 [
self handleUpEvent:event callback:guardedCallback];
503 case NSEventTypeFlagsChanged:
504 [
self handleFlagEvent:event callback:guardedCallback];
507 NSAssert(
false,
@"Unexpected key event type: |%@|.", @(
event.type));
509 NSAssert(guardedCallback.
handled,
@"The callback is returned without being handled.");
518 .synthesized =
false,
520 _sendEvent(flutterEvent,
nullptr,
nullptr);
522 NSAssert(_lastModifierFlagsOfInterest == (
event.modifierFlags & _modifierFlagOfInterestMask),
523 @"The modifier flags are not properly updated: recorded 0x%lx, event with mask 0x%lx",
524 _lastModifierFlagsOfInterest,
event.modifierFlags & _modifierFlagOfInterestMask);
527#pragma mark - Private
529- (void)synchronizeModifiers:(NSUInteger)currentFlags
530 ignoringFlags:(NSUInteger)ignoringFlags
531 timestamp:(NSTimeInterval)timestamp
533 const NSUInteger updatingMask = _modifierFlagOfInterestMask & ~ignoringFlags;
534 const NSUInteger currentFlagsOfInterest = currentFlags & updatingMask;
535 const NSUInteger lastFlagsOfInterest = _lastModifierFlagsOfInterest & updatingMask;
536 NSUInteger flagDifference = currentFlagsOfInterest ^ lastFlagsOfInterest;
537 if (flagDifference & NSEventModifierFlagCapsLock) {
538 [
self sendCapsLockTapWithTimestamp:timestamp synthesizeDown:true callback:guard];
539 flagDifference = flagDifference & ~NSEventModifierFlagCapsLock;
542 const NSUInteger currentFlag = lowestSetBit(flagDifference);
543 if (currentFlag == 0) {
546 flagDifference = flagDifference & ~currentFlag;
547 NSNumber* keyCode = [flutter::modifierFlagToKeyCode objectForKey:@(currentFlag)];
548 NSAssert(keyCode != nil,
@"Invalid modifier flag 0x%lx", currentFlag);
549 if (keyCode == nil) {
552 BOOL isDownEvent = (currentFlagsOfInterest & currentFlag) != 0;
553 [
self sendModifierEventOfType:isDownEvent
555 keyCode:[keyCode unsignedShortValue]
559 _lastModifierFlagsOfInterest =
560 (_lastModifierFlagsOfInterest & ~updatingMask) | currentFlagsOfInterest;
563- (void)updateKey:(uint64_t)physicalKey asPressed:(uint64_t)logicalKey {
564 if (logicalKey == 0) {
565 [_pressingRecords removeObjectForKey:@(physicalKey)];
567 _pressingRecords[@(physicalKey)] = @(logicalKey);
574 uint64_t responseId = _responseId;
578 _sendEvent(
event, HandleResponse, pending);
584 _sendEvent(
event,
nullptr,
nullptr);
588- (void)sendCapsLockTapWithTimestamp:(NSTimeInterval)timestamp
589 synthesizeDown:(
bool)synthesizeDown
598 .timestamp = GetFlutterTimestampFrom(timestamp),
603 .synthesized = synthesizeDown,
605 if (!synthesizeDown) {
606 [
self sendPrimaryFlutterEvent:flutterEvent callback:callback];
608 [
self sendSynthesizedFlutterEvent:flutterEvent guard:callback];
613 [
self sendSynthesizedFlutterEvent:flutterEvent guard:callback];
616- (void)sendModifierEventOfType:(
BOOL)isDownEvent
617 timestamp:(NSTimeInterval)timestamp
618 keyCode:(
unsigned short)keyCode
619 synthesized:(
bool)synthesized
621 uint64_t physicalKey = GetPhysicalKeyForKeyCode(keyCode);
622 uint64_t logicalKey = GetLogicalKeyForModifier(keyCode, physicalKey);
623 if (physicalKey == 0 || logicalKey == 0) {
624 NSLog(
@"Unrecognized modifier key: keyCode 0x%hx, physical key 0x%llx", keyCode, physicalKey);
630 .timestamp = GetFlutterTimestampFrom(timestamp),
632 .physical = physicalKey,
633 .logical = logicalKey,
635 .synthesized = synthesized,
637 [
self updateKey:physicalKey asPressed:isDownEvent ? logicalKey : 0];
639 [
self sendPrimaryFlutterEvent:flutterEvent callback:callback];
641 [
self sendSynthesizedFlutterEvent:flutterEvent guard:callback];
646 uint64_t physicalKey = GetPhysicalKeyForKeyCode(
event.keyCode);
647 NSNumber* logicalKeyFromMap =
self.layoutMap[@(event.keyCode)];
648 uint64_t logicalKey = logicalKeyFromMap != nil ? [logicalKeyFromMap unsignedLongLongValue]
649 : GetLogicalKeyForEvent(
event, physicalKey);
650 [
self synchronizeModifiers:event.modifierFlags
652 timestamp:event.timestamp
655 bool isARepeat =
event.isARepeat;
656 NSNumber* pressedLogicalKey = _pressingRecords[@(physicalKey)];
657 if (pressedLogicalKey != nil && !isARepeat) {
666 .timestamp = GetFlutterTimestampFrom(
event.timestamp),
668 .physical = physicalKey,
669 .logical = [pressedLogicalKey unsignedLongLongValue],
673 [
self sendSynthesizedFlutterEvent:flutterEvent guard:callback];
674 pressedLogicalKey = nil;
677 if (pressedLogicalKey == nil) {
678 [
self updateKey:physicalKey asPressed:logicalKey];
683 .timestamp = GetFlutterTimestampFrom(
event.timestamp),
685 .physical = physicalKey,
686 .logical = pressedLogicalKey == nil ? logicalKey : [pressedLogicalKey unsignedLongLongValue],
687 .character = getEventString(
event.characters),
688 .synthesized =
false,
690 [
self sendPrimaryFlutterEvent:flutterEvent callback:callback];
694 NSAssert(!
event.isARepeat,
@"Unexpected repeated Up event: keyCode %d, char %@, charIM %@",
696 [
self synchronizeModifiers:event.modifierFlags
698 timestamp:event.timestamp
701 uint64_t physicalKey = GetPhysicalKeyForKeyCode(
event.keyCode);
702 NSNumber* pressedLogicalKey = _pressingRecords[@(physicalKey)];
703 if (pressedLogicalKey == nil) {
711 [
self updateKey:physicalKey asPressed:0];
715 .timestamp = GetFlutterTimestampFrom(
event.timestamp),
717 .physical = physicalKey,
718 .logical = [pressedLogicalKey unsignedLongLongValue],
720 .synthesized =
false,
722 [
self sendPrimaryFlutterEvent:flutterEvent callback:callback];
726 [
self synchronizeModifiers:event.modifierFlags
727 ignoringFlags:NSEventModifierFlagCapsLock
728 timestamp:event.timestamp
730 if ((_lastModifierFlagsOfInterest & NSEventModifierFlagCapsLock) !=
731 (
event.modifierFlags & NSEventModifierFlagCapsLock)) {
732 [
self sendCapsLockTapWithTimestamp:event.timestamp synthesizeDown:false callback:callback];
733 _lastModifierFlagsOfInterest = _lastModifierFlagsOfInterest ^ NSEventModifierFlagCapsLock;
741 NSUInteger targetModifierFlag =
742 targetModifierFlagObj == nil ? 0 : [targetModifierFlagObj unsignedLongValue];
743 uint64_t targetKey = GetPhysicalKeyForKeyCode(
event.keyCode);
745 return [
self handleCapsLockEvent:event callback:callback];
748 [
self synchronizeModifiers:event.modifierFlags
749 ignoringFlags:targetModifierFlag
750 timestamp:event.timestamp
753 NSNumber* pressedLogicalKey = [_pressingRecords objectForKey:@(targetKey)];
754 BOOL lastTargetPressed = pressedLogicalKey != nil;
755 NSAssert(targetModifierFlagObj == nil ||
756 (_lastModifierFlagsOfInterest & targetModifierFlag) != 0 == lastTargetPressed,
757 @"Desynchronized state between lastModifierFlagsOfInterest (0x%lx) on bit 0x%lx "
758 @"for keyCode 0x%hx, whose pressing state is %@.",
759 _lastModifierFlagsOfInterest, targetModifierFlag,
event.keyCode,
761 ? [NSString stringWithFormat:
@"0x%llx", [pressedLogicalKey unsignedLongLongValue]]
764 BOOL shouldBePressed = (
event.modifierFlags & targetModifierFlag) != 0;
765 if (lastTargetPressed == shouldBePressed) {
769 _lastModifierFlagsOfInterest = _lastModifierFlagsOfInterest ^ targetModifierFlag;
770 [
self sendModifierEventOfType:shouldBePressed
771 timestamp:event.timestamp
772 keyCode:event.keyCode
777- (void)handleResponse:(
BOOL)handled forId:(uint64_t)responseId {
780 [_pendingResponses removeObjectForKey:@(responseId)];
783- (void)syncModifiersIfNeeded:(NSEventModifierFlags)modifierFlags
784 timestamp:(NSTimeInterval)timestamp {
790 [
self synchronizeModifiers:modifierFlags
793 guard:guardedCallback];
797 return [NSDictionary dictionaryWithDictionary:_pressingRecords];