comments

Author: chunhtai

shell/platform/darwin/macos/framework/Source/AccessibilityBridgeMacDelegate.h

@@ -64,7 +64,7 @@ class AccessibilityBridgeMacDelegate : public AccessibilityBridge::Accessibility
 
   //---------------------------------------------------------------------------
   /// @brief      Whether the given event is in current pending events.
-  /// @param[in]  event_type        The event you would like to look up.
+  /// @param[in]  event_type        The event to look up.
   bool HasPendingEvent(ui::AXEventGenerator::Event event) const;
 
   //---------------------------------------------------------------------------

shell/platform/darwin/macos/framework/Source/AccessibilityBridgeMacDelegate.mm

@@ -15,7 +15,6 @@
 inline constexpr int32_t kRootNode = 0;
 
 // Native mac notifications fired. These notifications are not publicly documented.
-// We have to define them ourselves.
 static NSString* const AccessibilityLoadCompleteNotification = @"AXLoadComplete";
 static NSString* const AccessibilityInvalidStatusChangedNotification = @"AXInvalidStatusChanged";
 static NSString* const AccessibilityLiveRegionCreatedNotification = @"AXLiveRegionCreated";
@@ -29,7 +28,7 @@
 void AccessibilityBridgeMacDelegate::OnAccessibilityEvent(
     ui::AXEventGenerator::TargetedEvent targeted_event) {
   if (!flutter_engine_.viewController.viewLoaded || !flutter_engine_.viewController.view.window) {
-    // We don't need to send accessibility events if the there is no view or window.
+    // Don't need to send accessibility events if the there is no view or window.
     return;
   }
   ui::AXNode* ax_node = targeted_event.node;
@@ -67,16 +66,16 @@
             .user_info = nil,
         });
       } else if (ax_node.data().role == ax::mojom::Role::kTextFieldWithComboBox) {
-        // Even though the selected item in the combo box has changed, we don't
-        // want to post a focus change because this will take the focus out of
+        // Even though the selected item in the combo box has changed, don't
+        // post a focus change because this will take the focus out of
         // the combo box where the user might be typing.
         events.push_back({
             .name = NSAccessibilitySelectedChildrenChangedNotification,
             .target = native_node,
             .user_info = nil,
         });
       }
-      // In all other cases we should post
+      // In all other cases this delegate should post
       // |NSAccessibilityFocusedUIElementChangedNotification|, but this is
       // handled elsewhere.
       break;
@@ -125,7 +124,7 @@
       id focused = mac_platform_node_delegate->GetFocus();
       if ([focused isKindOfClass:[FlutterTextField class]]) {
         // If it is a text field, the selection notifications are handled by
-        // the FlutterTextField directly. We only need to make sure it is the
+        // the FlutterTextField directly. Only need to make sure it is the
         // first responder.
         FlutterTextField* native_text_field = (FlutterTextField*)focused;
         if (native_text_field == mac_platform_node_delegate->GetFocus()) {
@@ -167,7 +166,7 @@
     case ui::AXEventGenerator::Event::VALUE_CHANGED: {
       if (ax_node.data().role == ax::mojom::Role::kTextField) {
         // If it is a text field, the value change notifications are handled by
-        // the FlutterTextField directly. We only need to make sure it is the
+        // the FlutterTextField directly. Only need to make sure it is the
         // first responder.
         FlutterTextField* native_text_field =
             (FlutterTextField*)mac_platform_node_delegate->GetNativeViewAccessible();

shell/platform/darwin/macos/framework/Source/FlutterCompositor.h

@@ -25,8 +25,8 @@ class FlutterCompositor {
   // Creates a BackingStore and saves updates the backing_store_out
   // data with the new BackingStore data.
   // If the backing store is being requested for the first time
-  // for a given frame, we do not create a new backing store but
-  // rather return the backing store associated with the
+  // for a given frame, this compositor do not create a new backing
+  // store but rather return the backing store associated with the
   // FlutterView's FlutterSurfaceManager.
   //
   // Any additional state allocated for the backing store and

shell/platform/darwin/macos/framework/Source/FlutterEmbedderKeyResponder.mm

@@ -198,10 +198,10 @@ static NSUInteger computeModifierFlagOfInterestMask() {
     // which is used for the "Apple logo" character (Option-Shift-K on a US
     // keyboard.)
     //
-    // We hereby assume that non-printable function keys are defined from
+    // Assume that non-printable function keys are defined from
     // 0xF700 upwards, and printable private keys are defined from 0xF8FF
-    // downwards. We want to keep the printable private keys, therefore we only
-    // filter out 0xF700-0xF7FF.
+    // downwards. This function filter out 0xF700-0xF7FF in order to keep
+    // the printable private keys.
     return nullptr;
   }
   return [characters UTF8String];
@@ -215,8 +215,8 @@ static NSUInteger computeModifierFlagOfInterestMask() {
  * The embedder functions only accept C-functions as callbacks, as well as an
  * arbitrary user_data. In order to send an instance method of
  * |FlutterEmbedderKeyResponder.handleResponse| to the engine's |SendKeyEvent|,
- * we wrap the invocation into a C-function |HandleResponse| and invocation
- * context |FlutterKeyPendingResponse|.
+ * the embedder wrap the invocation into a C-function |HandleResponse| and
+ * invocation context |FlutterKeyPendingResponse|.
  *
  * When this object is sent to the engine's |SendKeyEvent| as |user_data|, it
  * must be attached with |__bridge_retained|. When this object is parsed
@@ -544,7 +544,8 @@ - (void)sendCapsLockTapWithTimestamp:(NSTimeInterval)timestamp
   // MacOS sends a down *or* an up when CapsLock is tapped, alternatively on
   // even taps and odd taps. A CapsLock down or CapsLock up should always be
   // converted to a down *and* an up, and the up should always be a synthesized
-  // event, since we will never know when the button is released.
+  // event, since the FlutterEmbedderKeyResponder will never know when the
+  // button is released.
   FlutterKeyEvent flutterEvent = {
       .struct_size = sizeof(FlutterKeyEvent),
       .timestamp = GetFlutterTimestampFrom(timestamp),

shell/platform/darwin/macos/framework/Source/FlutterEngine.mm

@@ -454,8 +454,7 @@ - (void)setSemanticsEnabled:(BOOL)enabled {
     return;
   }
   _semanticsEnabled = enabled;
-  // We need to remove the accessibility children from flutter view
-  // before we reset the bridge.
+  // Remove the accessibility children from flutter view before reseting the bridge.
   if (!_semanticsEnabled && self.viewController.viewLoaded) {
     self.viewController.flutterView.accessibilityChildren = nil;
   }

shell/platform/darwin/macos/framework/Source/FlutterGLCompositor.h

@@ -27,8 +27,8 @@ class FlutterGLCompositor : public FlutterCompositor {
   // Creates a BackingStore and saves updates the backing_store_out
   // data with the new BackingStore data.
   // If the backing store is being requested for the first time
-  // for a given frame, we do not create a new backing store but
-  // rather return the backing store associated with the
+  // for a given frame, this compositor do not create a new backing
+  // store but rather return the backing store associated with the
   // FlutterView's FlutterSurfaceManager.
   //
   // Any additional state allocated for the backing store and

shell/platform/darwin/macos/framework/Source/FlutterKeyboardManager.mm

@@ -46,7 +46,7 @@ - (void)addSecondaryResponder:(nonnull id<FlutterKeySecondaryResponder>)responde
 }
 
 - (void)handleEvent:(nonnull NSEvent*)event {
-  // Be sure to add a handling method in propagateKeyEvent if you allow more
+  // Be sure to add a handling method in propagateKeyEvent when allowing more
   // event types here.
   if (event.type != NSEventTypeKeyDown && event.type != NSEventTypeKeyUp &&
       event.type != NSEventTypeFlagsChanged) {

shell/platform/darwin/macos/framework/Source/FlutterMetalCompositor.h

@@ -21,8 +21,8 @@ class FlutterMetalCompositor : public FlutterCompositor {
   // backing store.
   //
   // If the backing store is being requested for the first time
-  // for a given frame, we do not create a new backing store but
-  // rather return the backing store associated with the
+  // for a given frame, this compositor do not create a new backing
+  // store but rather return the backing store associated with the
   // FlutterView's FlutterSurfaceManager.
   //
   // Any additional state allocated for the backing store and

shell/platform/darwin/macos/framework/Source/FlutterPlatformNodeDelegateMac.mm

@@ -99,8 +99,8 @@
       NSMakeRect(local_bounds.x(), local_bounds.y(), local_bounds.width(), local_bounds.height());
   // The macOS XY coordinates start at bottom-left and increase toward top-right,
   // which is different from the Flutter's XY coordinates that start at top-left
-  // increasing to bottom-right. Therefore, We need to flip the y coordinate when
-  // we convert from flutter coordinates to macOS coordinates.
+  // increasing to bottom-right. Therefore, this method need to flip the y coordinate when
+  // it converts the bounds from flutter coordinates to macOS coordinates.
   ns_local_bounds.origin.y = -ns_local_bounds.origin.y - ns_local_bounds.size.height;
 
   NSCAssert(engine_, @"Flutter engine should not be deallocated");
@@ -119,7 +119,7 @@
 gfx::RectF FlutterPlatformNodeDelegateMac::ConvertBoundsFromScreenToGlobal(
     const gfx::RectF& screen_bounds) const {
   // The VoiceOver seems to only accept bounds that are relative to primary screen.
-  // Thus, we use [[NSScreen screens] firstObject] instead of [NSScreen mainScreen].
+  // Thus, this method uses [[NSScreen screens] firstObject] instead of [NSScreen mainScreen].
   NSScreen* screen = [[NSScreen screens] firstObject];
   NSRect primary_screen_bounds = [screen frame];
   // The screen is flipped against y axis.

shell/platform/darwin/macos/framework/Source/FlutterPlatformNodeDelegateMacTest.mm

@@ -280,9 +280,9 @@
   double pixelRatio = view.bounds.size.width == 0 ? 1 : scaledSize.width / view.bounds.size.width;
 
   double expectedFrameSize = rectSize * transformFactor / pixelRatio;
-  EXPECT_EQ(NSEqualRects(native_text_field.frame, NSMakeRect(0, 600 - expectedFrameSize,
-                                                             expectedFrameSize, expectedFrameSize)),
-            YES);
+  EXPECT_EQ(
+      NSEqualRects(native_text_field.frame, NSMakeRect(0, 0, expectedFrameSize, expectedFrameSize)),
+      YES);
   // The text of TextInputPlugin only starts syncing editing state to the
   // native text field when it becomes the first responder.
   [native_text_field becomeFirstResponder];

shell/platform/darwin/macos/framework/Source/FlutterResizeSynchronizer.h

@@ -30,7 +30,7 @@
  * Flow during window resize
  *
  * 1. Platform thread calls [synchronizer beginResize:notify:]
- *    This will hold the platform thread until we're ready to display contents.
+ *    This will hold the platform thread until the raster thread is ready to display contents.
  * 2. Raster thread calls [synchronizer shouldEnsureSurfaceForSize:] with target size
  *    This will return false for any size other than target size
  * 3. Raster thread calls [synchronizer requestCommit]
@@ -45,8 +45,8 @@
  *    This will invoke [delegate flush:] on raster thread and
  *    [delegate commit:] on platform thread. The requestCommit call will be blocked
  *    until this is done. This is necessary to ensure that rasterizer won't start
- *    rasterizing next frame before we flipped the surface, which must be performed
- *    on platform thread
+ *    rasterizing next frame before the FlutterSurfaceManager flipped the surface,
+ *    which must be performed on platform thread.
  */
 @interface FlutterResizeSynchronizer : NSObject
 

shell/platform/darwin/macos/framework/Source/FlutterResizeSynchronizer.mm

@@ -17,8 +17,8 @@ @interface FlutterResizeSynchronizer () {
   // Used to block [requestCommit].
   std::condition_variable _condBlockRequestCommit;
 
-  // Whether a frame was received; We don't block platform thread during resize
-  // until we know that framework is running and producing frames
+  // Whether a frame was received; the synchronizer don't block platform thread during resize
+  // until it knows that framework is running and producing frames
   BOOL _receivedFirstFrame;
 
   // If NO, requestCommit calls are ignored until shouldEnsureSurfaceForSize is called with

shell/platform/darwin/macos/framework/Source/FlutterTextInputPlugin.mm

@@ -177,14 +177,14 @@ - (instancetype)initWithViewController:(FlutterViewController*)viewController {
                                            binaryMessenger:viewController.engine.binaryMessenger
                                                      codec:[FlutterJSONMethodCodec sharedInstance]];
     _shown = FALSE;
-    // NSTextView does not support _weak reference, so we have to
-    // use __unsafe_unretained and manage the reference ourselves.
+    // NSTextView does not support _weak reference, so this class have to
+    // use __unsafe_unretained and manage the reference by itself.
     //
-    // Since we will nil the handler in dealloc. the weakSelf should
+    // Since the dealloc removes the handler, the pointer should
     // be valid if the handler is ever called.
-    __unsafe_unretained FlutterTextInputPlugin* weakSelf = self;
+    __unsafe_unretained FlutterTextInputPlugin* unsafeSelf = self;
     [_channel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
-      [weakSelf handleMethodCall:call result:result];
+      [unsafeSelf handleMethodCall:call result:result];
     }];
     _textInputContext = [[NSTextInputContext alloc] initWithClient:self];
     _previouslyPressedFlags = 0;
@@ -200,7 +200,7 @@ - (instancetype)initWithViewController:(FlutterViewController*)viewController {
 }
 
 - (BOOL)isFirstResponder {
-  if (!self.flutterViewController.viewLoaded || !self.flutterViewController.view.window) {
+  if (!self.flutterViewController.viewLoaded) {
     return false;
   }
   return [self.flutterViewController.view.window firstResponder] == self;
@@ -356,7 +356,7 @@ - (void)updateTextAndSelection {
   int extend = _activeModel->selection().extent();
   NSRange selection = NSMakeRange(MIN(start, extend), ABS(start - extend));
   // There may be a native text field client if VoiceOver is on.
-  // In this case, we have to update text and selection through
+  // In this case, this plugin have to update text and selection through
   // the client in order for VoiceOver to announce the text editing
   // properly.
   if (_client) {
@@ -411,14 +411,6 @@ - (void)flagsChanged:(NSEvent*)event {
   [self.flutterViewController flagsChanged:event];
 }
 
-- (void)mouseEntered:(NSEvent*)event {
-  [self.flutterViewController mouseEntered:event];
-}
-
-- (void)mouseExited:(NSEvent*)event {
-  [self.flutterViewController mouseExited:event];
-}
-
 - (void)mouseDown:(NSEvent*)event {
   [self.flutterViewController mouseDown:event];
 }
@@ -474,7 +466,7 @@ - (void)insertText:(id)string replacementRange:(NSRange)range {
   if (range.location != NSNotFound) {
     // The selected range can actually have negative numbers, since it can start
     // at the end of the range if the user selected the text going backwards.
-    // NSRange uses NSUIntegers, however, so we have to cast them to know if the
+    // NSRange uses NSUIntegers, however, so they have to be casted to know if the
     // selection is reversed or not.
     long signedLength = static_cast<long>(range.length);
     long location = range.location;

shell/platform/darwin/macos/framework/Source/FlutterTextInputPluginTest.mm

@@ -228,9 +228,8 @@ - (bool)testFirstRectForCharacterRange {
   FlutterTextPlatformNode textPlatformNode(&delegate, engine);
 
   FlutterTextFieldMock* mockTextField =
-      [[FlutterTextFieldMock alloc] initWithPlatformNode:&textPlatformNode
-                                         withFieldEditor:viewController.textInputPlugin];
-
+      [[FlutterTextFieldMock alloc] initWithPlatformNode:&textPlatformNode];
+  [mockTextField setFieldEditor:viewController.textInputPlugin];
   [viewController.view addSubview:mockTextField];
   [mockTextField becomeFirstResponder];
 

shell/platform/darwin/macos/framework/Source/FlutterTextInputSemanticsObject.h

@@ -31,9 +31,11 @@ class FlutterTextPlatformNode : public ui::AXPlatformNodeBase {
   ~FlutterTextPlatformNode() override;
 
   //------------------------------------------------------------------------------
-  /// @brief Gets the bounds of this platform node relative to the NSWindow. This
-  ///        is used by the FlutterTextField to get its frame rect.
-  NSRect GetWindowFrame();
+  /// @brief Gets the frame of this platform node relative to the view of
+  ///        FlutterViewController. This is used by the FlutterTextField to get its
+  ///        frame rect because the FlutterTextField is a subview of the
+  ///        FlutterViewController.view.
+  NSRect GetFrameRelativeToControllerView();
 
   // |ui::AXPlatformNodeBase|
   gfx::NativeViewAccessible GetNativeViewAccessible() override;
@@ -73,9 +75,18 @@ class FlutterTextPlatformNode : public ui::AXPlatformNodeBase {
 
 /**
  * Initializes a FlutterTextField.
+ *
+ * The plugin will be stored as an __unsafe_unretained pointer, and the FlutterTextField expects
+ * the point is valid during its lifetime.
+ */
+- (instancetype)initWithPlatformNode:(flutter::FlutterTextPlatformNode*)node;
+
+/**
+ * Assign the field editor for this FlutterTextField. The plugin will be stored as an
+ * __unsafe_unretained pointer, and the FlutterTextField expects the pointer is valid
+ * during its lifetime.
  */
-- (instancetype)initWithPlatformNode:(flutter::FlutterTextPlatformNode*)node
-                     withFieldEditor:(FlutterTextInputPlugin*)plugin;
+- (void)setFieldEditor:(FlutterTextInputPlugin*)plugin;
 
 /**
  * Updates the string value and the selection of this text field.