Merge remote-tracking branch 'origin/main' into fix-ios-escape

Author: dkwingsmt

DEPS

@@ -27,7 +27,7 @@ vars = {
   'skia_git': 'https://skia.googlesource.com',
   # OCMock is for testing only so there is no google clone
   'ocmock_git': 'https://github.com/erikdoe/ocmock.git',
-  'skia_revision': '45600771c27b166134b351b44783907061d1f966',
+  'skia_revision': 'b950ac6d45b04d93ae9d9e10df81d0b08cfd73e2',
 
   # WARNING: DO NOT EDIT canvaskit_cipd_instance MANUALLY
   # See `lib/web_ui/README.md` for how to roll CanvasKit to a new version.
@@ -45,7 +45,7 @@ vars = {
   # Dart is: https://github.com/dart-lang/sdk/blob/main/DEPS.
   # You can use //tools/dart/create_updated_flutter_deps.py to produce
   # updated revision list of existing dependencies.
-  'dart_revision': '384160690d758ac57ff3a1f024c27027feb3ea1c',
+  'dart_revision': '29d4cf8934769f9dc21f1a04b4256c86634e524e',
 
   # WARNING: DO NOT EDIT MANUALLY
   # The lines between blank lines above and below are generated by a script. See create_updated_flutter_deps.py
@@ -212,7 +212,7 @@ deps = {
    Var('dart_git') + '/dart_style.git@d7b73536a8079331c888b7da539b80e6825270ea',
 
   'src/third_party/dart/third_party/pkg/dartdoc':
-   Var('dart_git') + '/dartdoc.git@21f9341eb6623a46fc56fc3705e878371991aebb',
+   Var('dart_git') + '/dartdoc.git@61dea6b8307392ee6dfe8fd952716b07f5243b1d',
 
   'src/third_party/dart/third_party/pkg/ffi':
    Var('dart_git') + '/ffi.git@18b2b549d55009ff594600b04705ff6161681e07',

ci/licenses_golden/licenses_skia

@@ -1,4 +1,4 @@
-Signature: 0f32c358198338fad7d8ba6dd4da1ad2
+Signature: 0eb7a0af1ab30145b26246e7ee92ef4b
 
 UNUSED LICENSES:
 

ci/licenses_golden/licenses_third_party

@@ -1,4 +1,4 @@
-Signature: 820f0af8efdd11587ea6129d4e87aa44
+Signature: 08f72272a0292f5602b2dbf25e46fa64
 
 UNUSED LICENSES:
 

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

@@ -76,6 +76,35 @@ typedef NS_ENUM(NSUInteger, FlutterTextAffinity) {
   return flutter::TextRange([base unsignedLongValue], [extent unsignedLongValue]);
 }
 
+@interface NSEvent (KeyEquivalentMarker)
+
+// Internally marks that the event was received through performKeyEquivalent:.
+// When text editing is active, keyboard events that have modifier keys pressed
+// are received through performKeyEquivalent: instead of keyDown:. If such event
+// is passed to TextInputContext but doesn't result in a text editing action it
+// needs to be forwarded by FlutterKeyboardManager to the next responder.
+- (void)markAsKeyEquivalent;
+
+// Returns YES if the event is marked as a key equivalent.
+- (BOOL)isKeyEquivalent;
+
+@end
+
+@implementation NSEvent (KeyEquivalentMarker)
+
+// This field doesn't need a value because only its address is used as a unique identifier.
+static char markerKey;
+
+- (void)markAsKeyEquivalent {
+  objc_setAssociatedObject(self, &markerKey, @true, OBJC_ASSOCIATION_RETAIN);
+}
+
+- (BOOL)isKeyEquivalent {
+  return [objc_getAssociatedObject(self, &markerKey) boolValue] == YES;
+}
+
+@end
+
 /**
  * Private properties of FlutterTextInputPlugin.
  */
@@ -130,6 +159,13 @@ @interface FlutterTextInputPlugin ()
  */
 @property(nonatomic, nonnull) NSString* inputAction;
 
+/**
+ * Set to true if the last event fed to the input context produced a text editing command
+ * or text output. It is reset to false at the beginning of every key event, and is only
+ * used while processing this event.
+ */
+@property(nonatomic) BOOL eventProducedOutput;
+
 /**
  * Whether to enable the sending of text input updates from the engine to the
  * framework as TextEditingDeltas rather than as one TextEditingValue.
@@ -482,7 +518,17 @@ - (BOOL)handleKeyEvent:(NSEvent*)event {
     return NO;
   }
 
-  return [_textInputContext handleEvent:event];
+  _eventProducedOutput = NO;
+  BOOL res = [_textInputContext handleEvent:event];
+  // NSTextInputContext#handleEvent returns YES if the context handles the event. One of the reasons
+  // the event is handled is because it's a key equivalent. But a key equivalent might produce a
+  // text command (indicated by calling doCommandBySelector) or might not (for example, Cmd+Q). In
+  // the latter case, this command somehow has not been executed yet and Flutter must dispatch it to
+  // the next responder. See https://github.com/flutter/flutter/issues/106354 .
+  if (event.isKeyEquivalent && !_eventProducedOutput) {
+    return NO;
+  }
+  return res;
 }
 
 #pragma mark -
@@ -509,6 +555,7 @@ - (BOOL)performKeyEquivalent:(NSEvent*)event {
     // send the event back to [keyboardManager handleEvent:].
     return NO;
   }
+  [event markAsKeyEquivalent];
   [self.flutterViewController keyDown:event];
   return YES;
 }
@@ -573,6 +620,8 @@ - (void)insertText:(id)string replacementRange:(NSRange)range {
     return;
   }
 
+  _eventProducedOutput |= true;
+
   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.
@@ -612,6 +661,7 @@ - (void)insertText:(id)string replacementRange:(NSRange)range {
 }
 
 - (void)doCommandBySelector:(SEL)selector {
+  _eventProducedOutput |= selector != NSSelectorFromString(@"noop:");
   if ([self respondsToSelector:selector]) {
     // Note: The more obvious [self performSelector...] doesn't give ARC enough information to
     // handle retain semantics properly. See https://stackoverflow.com/questions/7017281/ for more

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

@@ -920,6 +920,82 @@ - (bool)testPerformKeyEquivalent {
   return true;
 }
 
+- (bool)unhandledKeyEquivalent {
+  id engineMock = OCMClassMock([FlutterEngine class]);
+  id binaryMessengerMock = OCMProtocolMock(@protocol(FlutterBinaryMessenger));
+  OCMStub(  // NOLINT(google-objc-avoid-throwing-exception)
+      [engineMock binaryMessenger])
+      .andReturn(binaryMessengerMock);
+
+  FlutterViewController* viewController = [[FlutterViewController alloc] initWithEngine:engineMock
+                                                                                nibName:@""
+                                                                                 bundle:nil];
+
+  FlutterTextInputPlugin* plugin =
+      [[FlutterTextInputPlugin alloc] initWithViewController:viewController];
+
+  [plugin handleMethodCall:[FlutterMethodCall
+                               methodCallWithMethodName:@"TextInput.setClient"
+                                              arguments:@[
+                                                @(1), @{
+                                                  @"inputAction" : @"action",
+                                                  @"enableDeltaModel" : @"true",
+                                                  @"inputType" : @{@"name" : @"inputName"},
+                                                }
+                                              ]]
+                    result:^(id){
+                    }];
+
+  [plugin handleMethodCall:[FlutterMethodCall methodCallWithMethodName:@"TextInput.show"
+                                                             arguments:@[]]
+                    result:^(id){
+                    }];
+
+  // CTRL+H (delete backwards)
+  NSEvent* event = [NSEvent keyEventWithType:NSEventTypeKeyDown
+                                    location:NSZeroPoint
+                               modifierFlags:0x40101
+                                   timestamp:0
+                                windowNumber:0
+                                     context:nil
+                                  characters:@""
+                 charactersIgnoringModifiers:@"h"
+                                   isARepeat:NO
+                                     keyCode:0x4];
+
+  // Plugin should mark the event as key equivalent.
+  [plugin performKeyEquivalent:event];
+
+  // Simulate KeyboardManager sending unhandled event to plugin. This must return
+  // true because it is a known editing command.
+  if ([plugin handleKeyEvent:event] != true) {
+    return false;
+  }
+
+  // CMD+W
+  event = [NSEvent keyEventWithType:NSEventTypeKeyDown
+                           location:NSZeroPoint
+                      modifierFlags:0x100108
+                          timestamp:0
+                       windowNumber:0
+                            context:nil
+                         characters:@"w"
+        charactersIgnoringModifiers:@"w"
+                          isARepeat:NO
+                            keyCode:0x13];
+
+  // Plugin should mark the event as key equivalent.
+  [plugin performKeyEquivalent:event];
+
+  // This is not a valid editing command, plugin must return false so that
+  // KeyboardManager sends the event to next responder.
+  if ([plugin handleKeyEvent:event] != false) {
+    return false;
+  }
+
+  return true;
+}
+
 - (bool)testLocalTextAndSelectionUpdateAfterDelta {
   id engineMock = OCMClassMock([FlutterEngine class]);
   id binaryMessengerMock = OCMProtocolMock(@protocol(FlutterBinaryMessenger));
@@ -1040,6 +1116,10 @@ - (bool)testLocalTextAndSelectionUpdateAfterDelta {
   ASSERT_TRUE([[FlutterInputPluginTestObjc alloc] testPerformKeyEquivalent]);
 }
 
+TEST(FlutterTextInputPluginTest, UnhandledKeyEquivalent) {
+  ASSERT_TRUE([[FlutterInputPluginTestObjc alloc] unhandledKeyEquivalent]);
+}
+
 TEST(FlutterTextInputPluginTest, CanWorkWithFlutterTextField) {
   FlutterEngine* engine = CreateTestEngine();
   NSString* fixtures = @(testing::GetFixturesPath());