8 #include <Carbon/Carbon.h>
9 #import <objc/message.h>
11 #include "flutter/common/constants.h"
12 #include "flutter/fml/platform/darwin/cf_utils.h"
22 #include "flutter/shell/platform/embedder/embedder.h"
24 #pragma mark - Static types and data.
30 static constexpr int32_t kMousePointerDeviceId = 0;
31 static constexpr int32_t kPointerPanZoomDeviceId = 1;
36 static constexpr
double kTrackpadTouchInertiaCancelWindowMs = 0.050;
69 bool flutter_state_is_added =
false;
74 bool flutter_state_is_down =
false;
83 bool has_pending_exit =
false;
88 bool flutter_state_is_pan_zoom_started =
false;
93 NSEventPhase pan_gesture_phase = NSEventPhaseNone;
98 NSEventPhase scale_gesture_phase = NSEventPhaseNone;
103 NSEventPhase rotate_gesture_phase = NSEventPhaseNone;
108 NSTimeInterval last_scroll_momentum_changed_time = 0;
113 void GestureReset() {
118 flutter_state_is_pan_zoom_started =
false;
119 pan_gesture_phase = NSEventPhaseNone;
120 scale_gesture_phase = NSEventPhaseNone;
121 rotate_gesture_phase = NSEventPhaseNone;
128 flutter_state_is_added =
false;
129 flutter_state_is_down =
false;
130 has_pending_exit =
false;
137 #pragma mark - Private interface declaration.
154 - (void)setBackgroundColor:(NSColor*)color;
166 @property(nonatomic) NSTrackingArea* trackingArea;
171 @property(nonatomic) MouseState mouseState;
176 @property(nonatomic)
id keyUpMonitor;
181 - (BOOL)launchEngine;
187 - (void)configureTrackingArea;
194 - (void)dispatchMouseEvent:(nonnull NSEvent*)event;
199 - (void)dispatchGestureEvent:(nonnull NSEvent*)event;
204 - (void)dispatchMouseEvent:(nonnull NSEvent*)event phase:(FlutterPointerPhase)phase;
208 #pragma mark - FlutterViewWrapper implementation.
215 - (instancetype)initWithFlutterView:(
FlutterView*)view
217 self = [
super initWithFrame:NSZeroRect];
221 view.autoresizingMask = NSViewWidthSizable | NSViewHeightSizable;
222 [
self addSubview:view];
227 - (void)setBackgroundColor:(NSColor*)color {
228 [_flutterView setBackgroundColor:color];
231 - (BOOL)performKeyEquivalent:(NSEvent*)event {
238 if (
self.window.firstResponder != _flutterView || [
_controller isDispatchingKeyEvent:event]) {
239 return [
super performKeyEquivalent:event];
241 [_flutterView keyDown:event];
245 - (NSArray*)accessibilityChildren {
246 return @[ _flutterView ];
251 - (void)mouseDown:(NSEvent*)event {
252 if (@available(macOS 13.3.1, *)) {
253 [
super mouseDown:event];
265 [
self.nextResponder mouseDown:event];
271 - (void)mouseUp:(NSEvent*)event {
272 if (@available(macOS 13.3.1, *)) {
273 [
super mouseUp:event];
285 [
self.nextResponder mouseUp:event];
291 #pragma mark - FlutterViewController implementation.
297 std::shared_ptr<flutter::AccessibilityBridgeMac>
_bridge;
301 @synthesize viewIdentifier = _viewIdentifier;
303 @dynamic accessibilityBridge;
309 if (_engine.textInputPlugin.currentViewController ==
self) {
310 return _engine.textInputPlugin;
322 project:controller->_project
323 allowHeadlessExecution:NO];
325 NSCAssert(controller.
engine == nil,
326 @"The FlutterViewController is unexpectedly attached to "
327 @"engine %@ before initialization.",
329 [engine addViewController:controller];
331 NSCAssert(controller.
engine != nil,
332 @"The FlutterViewController unexpectedly stays unattached after initialization. "
333 @"In unit tests, this is likely because either the FlutterViewController or "
334 @"the FlutterEngine is mocked. Please subclass these classes instead.",
336 controller->_mouseTrackingMode = kFlutterMouseTrackingModeInKeyWindow;
337 [controller notifySemanticsEnabledChanged];
340 - (instancetype)initWithCoder:(NSCoder*)coder {
341 self = [
super initWithCoder:coder];
342 NSAssert(
self,
@"Super init cannot be nil");
344 CommonInit(
self, nil);
348 - (instancetype)initWithNibName:(NSString*)nibNameOrNil bundle:(NSBundle*)nibBundleOrNil {
349 self = [
super initWithNibName:nibNameOrNil bundle:nibBundleOrNil];
350 NSAssert(
self,
@"Super init cannot be nil");
352 CommonInit(
self, nil);
357 self = [
super initWithNibName:nil bundle:nil];
358 NSAssert(
self,
@"Super init cannot be nil");
361 CommonInit(
self, nil);
365 - (instancetype)initWithEngine:(nonnull
FlutterEngine*)engine
366 nibName:(nullable NSString*)nibName
367 bundle:(nullable NSBundle*)nibBundle {
368 NSAssert(engine != nil,
@"Engine is required");
370 self = [
super initWithNibName:nibName bundle:nibBundle];
372 CommonInit(
self, engine);
378 - (BOOL)isDispatchingKeyEvent:(NSEvent*)event {
379 return [_engine.keyboardManager isDispatchingKeyEvent:event];
384 id<MTLDevice> device = _engine.renderer.device;
385 id<MTLCommandQueue> commandQueue = _engine.renderer.commandQueue;
386 if (!device || !commandQueue) {
387 NSLog(
@"Unable to create FlutterView; no MTLDevice or MTLCommandQueue available.");
390 flutterView = [
self createFlutterViewWithMTLDevice:device commandQueue:commandQueue];
391 if (_backgroundColor != nil) {
396 self.view = wrapperView;
397 _flutterView = flutterView;
400 - (void)viewDidLoad {
401 [
self configureTrackingArea];
402 [
self.view setAllowedTouchTypes:NSTouchTypeMaskIndirect];
403 [
self.view setWantsRestingTouches:YES];
404 [_engine viewControllerViewDidLoad:self];
407 - (void)viewWillAppear {
408 [
super viewWillAppear];
409 if (!_engine.running) {
412 [
self listenForMetaModifiedKeyUpEvents];
415 - (void)viewWillDisappear {
418 [NSEvent removeMonitor:_keyUpMonitor];
423 if ([
self attached]) {
424 [_engine removeViewController:self];
426 [
self.flutterView shutDown];
433 #pragma mark - Public methods
435 - (void)setMouseTrackingMode:(FlutterMouseTrackingMode)mode {
436 if (_mouseTrackingMode == mode) {
439 _mouseTrackingMode = mode;
440 [
self configureTrackingArea];
443 - (void)setBackgroundColor:(NSColor*)color {
444 _backgroundColor = color;
445 [_flutterView setBackgroundColor:_backgroundColor];
449 NSAssert([
self attached],
@"This view controller is not attached.");
450 return _viewIdentifier;
453 - (void)onPreEngineRestart {
456 - (void)notifySemanticsEnabledChanged {
457 BOOL mySemanticsEnabled = !!
_bridge;
458 BOOL newSemanticsEnabled = _engine.semanticsEnabled;
459 if (newSemanticsEnabled == mySemanticsEnabled) {
462 if (newSemanticsEnabled) {
463 _bridge = [
self createAccessibilityBridgeWithEngine:_engine];
466 _flutterView.accessibilityChildren = nil;
469 NSAssert(newSemanticsEnabled == !!
_bridge,
@"Failed to update semantics for the view.");
472 - (std::weak_ptr<flutter::AccessibilityBridgeMac>)accessibilityBridge {
478 NSAssert(_engine == nil,
@"Already attached to an engine %@.", _engine);
480 _viewIdentifier = viewIdentifier;
483 - (void)detachFromEngine {
484 NSAssert(_engine != nil,
@"Not attached to any engine.");
489 return _engine != nil;
492 - (void)updateSemantics:(const FlutterSemanticsUpdate2*)update {
495 if (!_engine.semanticsEnabled) {
498 for (
size_t i = 0; i < update->node_count; i++) {
499 const FlutterSemanticsNode2* node = update->nodes[i];
500 _bridge->AddFlutterSemanticsNodeUpdate(*node);
503 for (
size_t i = 0; i < update->custom_action_count; i++) {
504 const FlutterSemanticsCustomAction2* action = update->custom_actions[i];
505 _bridge->AddFlutterSemanticsCustomActionUpdate(*action);
511 if (!
self.viewLoaded) {
515 auto root =
_bridge->GetFlutterPlatformNodeDelegateFromID(0).lock();
517 if ([
self.flutterView.accessibilityChildren count] == 0) {
518 NSAccessibilityElement* native_root = root->GetNativeViewAccessible();
519 self.flutterView.accessibilityChildren = @[ native_root ];
522 self.flutterView.accessibilityChildren = nil;
526 #pragma mark - Private methods
528 - (BOOL)launchEngine {
529 if (![_engine runWithEntrypoint:nil]) {
539 - (void)listenForMetaModifiedKeyUpEvents {
540 if (_keyUpMonitor != nil) {
546 _keyUpMonitor = [NSEvent
547 addLocalMonitorForEventsMatchingMask:NSEventMaskKeyUp
548 handler:^NSEvent*(NSEvent* event) {
551 NSResponder* firstResponder = [[event window] firstResponder];
552 if (weakSelf.viewLoaded && weakSelf.flutterView &&
553 (firstResponder == weakSelf.flutterView ||
554 firstResponder == weakSelf.activeTextInputPlugin) &&
555 ([event modifierFlags] & NSEventModifierFlagCommand) &&
556 ([event type] == NSEventTypeKeyUp)) {
557 [weakSelf keyUp:event];
563 - (void)configureTrackingArea {
564 if (!
self.viewLoaded) {
569 if (_mouseTrackingMode != kFlutterMouseTrackingModeNone &&
self.flutterView) {
570 NSTrackingAreaOptions options = NSTrackingMouseEnteredAndExited | NSTrackingMouseMoved |
571 NSTrackingInVisibleRect | NSTrackingEnabledDuringMouseDrag;
572 switch (_mouseTrackingMode) {
573 case kFlutterMouseTrackingModeInKeyWindow:
574 options |= NSTrackingActiveInKeyWindow;
576 case kFlutterMouseTrackingModeInActiveApp:
577 options |= NSTrackingActiveInActiveApp;
579 case kFlutterMouseTrackingModeAlways:
580 options |= NSTrackingActiveAlways;
583 NSLog(
@"Error: Unrecognized mouse tracking mode: %ld", _mouseTrackingMode);
586 _trackingArea = [[NSTrackingArea alloc] initWithRect:NSZeroRect
590 [
self.flutterView addTrackingArea:_trackingArea];
591 }
else if (_trackingArea) {
592 [
self.flutterView removeTrackingArea:_trackingArea];
597 - (void)dispatchMouseEvent:(nonnull NSEvent*)event {
598 FlutterPointerPhase phase = _mouseState.buttons == 0
599 ? (_mouseState.flutter_state_is_down ? kUp : kHover)
600 : (_mouseState.flutter_state_is_down ? kMove : kDown);
601 [
self dispatchMouseEvent:event phase:phase];
604 - (void)dispatchGestureEvent:(nonnull NSEvent*)event {
605 if (event.phase == NSEventPhaseBegan || event.phase == NSEventPhaseMayBegin) {
606 [
self dispatchMouseEvent:event phase:kPanZoomStart];
607 }
else if (event.phase == NSEventPhaseChanged) {
608 [
self dispatchMouseEvent:event phase:kPanZoomUpdate];
609 }
else if (event.phase == NSEventPhaseEnded || event.phase == NSEventPhaseCancelled) {
610 [
self dispatchMouseEvent:event phase:kPanZoomEnd];
611 }
else if (event.phase == NSEventPhaseNone && event.momentumPhase == NSEventPhaseNone) {
612 [
self dispatchMouseEvent:event phase:kHover];
617 if (event.momentumPhase == NSEventPhaseChanged) {
618 _mouseState.last_scroll_momentum_changed_time =
event.timestamp;
621 NSAssert(event.momentumPhase != NSEventPhaseNone,
622 @"Received gesture event with unexpected phase");
626 - (void)dispatchMouseEvent:(NSEvent*)event phase:(FlutterPointerPhase)phase {
627 NSAssert(
self.viewLoaded,
@"View must be loaded before it handles the mouse event");
631 if (_mouseState.flutter_state_is_added && phase == kAdd) {
637 if (phase == kPanZoomStart || phase == kPanZoomEnd) {
638 if (event.type == NSEventTypeScrollWheel) {
639 _mouseState.pan_gesture_phase =
event.phase;
640 }
else if (event.type == NSEventTypeMagnify) {
641 _mouseState.scale_gesture_phase =
event.phase;
642 }
else if (event.type == NSEventTypeRotate) {
643 _mouseState.rotate_gesture_phase =
event.phase;
646 if (phase == kPanZoomStart) {
647 if (event.type == NSEventTypeScrollWheel) {
649 _mouseState.last_scroll_momentum_changed_time = 0;
651 if (_mouseState.flutter_state_is_pan_zoom_started) {
655 _mouseState.flutter_state_is_pan_zoom_started =
true;
657 if (phase == kPanZoomEnd) {
658 if (!_mouseState.flutter_state_is_pan_zoom_started) {
662 NSAssert(event.phase == NSEventPhaseCancelled,
663 @"Received gesture event with unexpected phase");
667 NSEventPhase all_gestures_fields = _mouseState.pan_gesture_phase |
668 _mouseState.scale_gesture_phase |
669 _mouseState.rotate_gesture_phase;
670 NSEventPhase active_mask = NSEventPhaseBegan | NSEventPhaseChanged;
671 if ((all_gestures_fields & active_mask) != 0) {
679 if (!_mouseState.flutter_state_is_added && phase != kAdd) {
681 NSEvent* addEvent = [NSEvent enterExitEventWithType:NSEventTypeMouseEntered
682 location:event.locationInWindow
684 timestamp:event.timestamp
685 windowNumber:event.windowNumber
690 [
self dispatchMouseEvent:addEvent phase:kAdd];
693 NSPoint locationInView = [
self.flutterView convertPoint:event.locationInWindow fromView:nil];
694 NSPoint locationInBackingCoordinates = [
self.flutterView convertPointToBacking:locationInView];
695 int32_t device = kMousePointerDeviceId;
696 FlutterPointerDeviceKind deviceKind = kFlutterPointerDeviceKindMouse;
697 if (phase == kPanZoomStart || phase == kPanZoomUpdate || phase == kPanZoomEnd) {
698 device = kPointerPanZoomDeviceId;
699 deviceKind = kFlutterPointerDeviceKindTrackpad;
701 FlutterPointerEvent flutterEvent = {
702 .struct_size =
sizeof(flutterEvent),
704 .timestamp =
static_cast<size_t>(event.timestamp * USEC_PER_SEC),
705 .x = locationInBackingCoordinates.x,
706 .y = -locationInBackingCoordinates.y,
708 .device_kind = deviceKind,
710 .buttons = phase == kAdd ? 0 : _mouseState.buttons,
711 .view_id = static_cast<FlutterViewIdentifier>(_viewIdentifier),
714 if (phase == kPanZoomUpdate) {
715 if (event.type == NSEventTypeScrollWheel) {
716 _mouseState.delta_x += event.scrollingDeltaX * self.flutterView.layer.contentsScale;
717 _mouseState.delta_y += event.scrollingDeltaY * self.flutterView.layer.contentsScale;
718 }
else if (event.type == NSEventTypeMagnify) {
719 _mouseState.scale += event.magnification;
720 }
else if (event.type == NSEventTypeRotate) {
721 _mouseState.rotation += event.rotation * (-M_PI / 180.0);
723 flutterEvent.pan_x = _mouseState.delta_x;
724 flutterEvent.pan_y = _mouseState.delta_y;
726 flutterEvent.scale = pow(2.0, _mouseState.scale);
727 flutterEvent.rotation = _mouseState.rotation;
728 }
else if (phase == kPanZoomEnd) {
729 _mouseState.GestureReset();
730 }
else if (phase != kPanZoomStart && event.type == NSEventTypeScrollWheel) {
731 flutterEvent.signal_kind = kFlutterPointerSignalKindScroll;
733 double pixelsPerLine = 1.0;
734 if (!event.hasPreciseScrollingDeltas) {
740 pixelsPerLine = 40.0;
742 double scaleFactor =
self.flutterView.layer.contentsScale;
751 double scaledDeltaX = -event.scrollingDeltaX * pixelsPerLine * scaleFactor;
752 double scaledDeltaY = -event.scrollingDeltaY * pixelsPerLine * scaleFactor;
753 if (event.modifierFlags & NSShiftKeyMask) {
754 flutterEvent.scroll_delta_x = scaledDeltaY;
755 flutterEvent.scroll_delta_y = scaledDeltaX;
757 flutterEvent.scroll_delta_x = scaledDeltaX;
758 flutterEvent.scroll_delta_y = scaledDeltaY;
762 [_engine.keyboardManager syncModifiersIfNeeded:event.modifierFlags timestamp:event.timestamp];
763 [_engine sendPointerEvent:flutterEvent];
766 if (phase == kDown) {
767 _mouseState.flutter_state_is_down =
true;
768 }
else if (phase == kUp) {
769 _mouseState.flutter_state_is_down =
false;
770 if (_mouseState.has_pending_exit) {
771 [
self dispatchMouseEvent:event phase:kRemove];
772 _mouseState.has_pending_exit =
false;
774 }
else if (phase == kAdd) {
775 _mouseState.flutter_state_is_added =
true;
776 }
else if (phase == kRemove) {
781 - (void)onAccessibilityStatusChanged:(BOOL)enabled {
782 if (!enabled &&
self.viewLoaded && [
self.activeTextInputPlugin isFirstResponder]) {
787 [
self.view addSubview:self.activeTextInputPlugin];
791 - (std::shared_ptr<flutter::AccessibilityBridgeMac>)createAccessibilityBridgeWithEngine:
793 return std::make_shared<flutter::AccessibilityBridgeMac>(engine,
self);
796 - (nonnull
FlutterView*)createFlutterViewWithMTLDevice:(
id<MTLDevice>)device
797 commandQueue:(
id<MTLCommandQueue>)commandQueue {
798 return [[
FlutterView alloc] initWithMTLDevice:device
799 commandQueue:commandQueue
801 viewIdentifier:_viewIdentifier];
804 - (NSString*)lookupKeyForAsset:(NSString*)asset {
808 - (NSString*)lookupKeyForAsset:(NSString*)asset fromPackage:(NSString*)package {
812 #pragma mark - FlutterViewDelegate
817 - (void)viewDidReshape:(NSView*)view {
818 FML_DCHECK(view == _flutterView);
819 [_engine updateWindowMetricsForViewController:self];
822 - (BOOL)viewShouldAcceptFirstResponder:(NSView*)view {
823 FML_DCHECK(view == _flutterView);
827 return !
self.activeTextInputPlugin.isFirstResponder;
830 #pragma mark - FlutterPluginRegistry
833 return [_engine registrarForPlugin:pluginName];
836 - (NSObject*)valuePublishedByPlugin:(NSString*)pluginKey {
837 return [_engine valuePublishedByPlugin:pluginKey];
840 #pragma mark - FlutterKeyboardViewDelegate
842 - (BOOL)onTextInputKeyEvent:(nonnull NSEvent*)event {
843 return [
self.activeTextInputPlugin handleKeyEvent:event];
846 #pragma mark - NSResponder
848 - (BOOL)acceptsFirstResponder {
852 - (void)keyDown:(NSEvent*)event {
853 [_engine.keyboardManager handleEvent:event withContext:self];
856 - (void)keyUp:(NSEvent*)event {
857 [_engine.keyboardManager handleEvent:event withContext:self];
860 - (void)flagsChanged:(NSEvent*)event {
861 [_engine.keyboardManager handleEvent:event withContext:self];
864 - (void)mouseEntered:(NSEvent*)event {
865 if (_mouseState.has_pending_exit) {
866 _mouseState.has_pending_exit =
false;
868 [
self dispatchMouseEvent:event phase:kAdd];
872 - (void)mouseExited:(NSEvent*)event {
873 if (_mouseState.buttons != 0) {
874 _mouseState.has_pending_exit =
true;
877 [
self dispatchMouseEvent:event phase:kRemove];
880 - (void)mouseDown:(NSEvent*)event {
881 _mouseState.buttons |= kFlutterPointerButtonMousePrimary;
882 [
self dispatchMouseEvent:event];
885 - (void)mouseUp:(NSEvent*)event {
886 _mouseState.buttons &= ~static_cast<uint64_t>(kFlutterPointerButtonMousePrimary);
887 [
self dispatchMouseEvent:event];
890 - (void)mouseDragged:(NSEvent*)event {
891 [
self dispatchMouseEvent:event];
894 - (void)rightMouseDown:(NSEvent*)event {
895 _mouseState.buttons |= kFlutterPointerButtonMouseSecondary;
896 [
self dispatchMouseEvent:event];
899 - (void)rightMouseUp:(NSEvent*)event {
900 _mouseState.buttons &= ~static_cast<uint64_t>(kFlutterPointerButtonMouseSecondary);
901 [
self dispatchMouseEvent:event];
904 - (void)rightMouseDragged:(NSEvent*)event {
905 [
self dispatchMouseEvent:event];
908 - (void)otherMouseDown:(NSEvent*)event {
909 _mouseState.buttons |= (1 <<
event.buttonNumber);
910 [
self dispatchMouseEvent:event];
913 - (void)otherMouseUp:(NSEvent*)event {
914 _mouseState.buttons &= ~static_cast<uint64_t>(1 << event.buttonNumber);
915 [
self dispatchMouseEvent:event];
918 - (void)otherMouseDragged:(NSEvent*)event {
919 [
self dispatchMouseEvent:event];
922 - (void)mouseMoved:(NSEvent*)event {
923 [
self dispatchMouseEvent:event];
926 - (void)scrollWheel:(NSEvent*)event {
927 [
self dispatchGestureEvent:event];
930 - (void)magnifyWithEvent:(NSEvent*)event {
931 [
self dispatchGestureEvent:event];
934 - (void)rotateWithEvent:(NSEvent*)event {
935 [
self dispatchGestureEvent:event];
938 - (void)swipeWithEvent:(NSEvent*)event {
942 - (void)touchesBeganWithEvent:(NSEvent*)event {
943 NSTouch* touch =
event.allTouches.anyObject;
945 if ((event.timestamp - _mouseState.last_scroll_momentum_changed_time) <
946 kTrackpadTouchInertiaCancelWindowMs) {
949 NSPoint locationInView = [
self.flutterView convertPoint:event.locationInWindow fromView:nil];
950 NSPoint locationInBackingCoordinates =
951 [
self.flutterView convertPointToBacking:locationInView];
952 FlutterPointerEvent flutterEvent = {
953 .struct_size =
sizeof(flutterEvent),
954 .timestamp =
static_cast<size_t>(event.timestamp * USEC_PER_SEC),
955 .x = locationInBackingCoordinates.x,
956 .y = -locationInBackingCoordinates.y,
957 .device = kPointerPanZoomDeviceId,
958 .signal_kind = kFlutterPointerSignalKindScrollInertiaCancel,
959 .device_kind = kFlutterPointerDeviceKindTrackpad,
963 [_engine sendPointerEvent:flutterEvent];
965 _mouseState.last_scroll_momentum_changed_time = 0;
FlutterDartProject * _project
int64_t FlutterViewIdentifier
__weak FlutterViewController * _controller
std::shared_ptr< flutter::AccessibilityBridgeMac > _bridge
NSString * lookupKeyForAsset:fromPackage:(NSString *asset,[fromPackage] NSString *package)
NSString * lookupKeyForAsset:(NSString *asset)
FlutterViewIdentifier viewIdentifier
void setBackgroundColor:(nonnull NSColor *color)