Hardware Keyboard: macOS

ci/licenses_golden/licenses_flutter

@@ -1105,9 +1105,15 @@ FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterBacki
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterBackingStore.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterBackingStoreData.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterBackingStoreData.mm
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterChannelKeyResponder.h
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterChannelKeyResponder.mm
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterChannelKeyResponderUnittests.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterDartProject.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterDartProject_Internal.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterEmbedderExternalTextureUnittests.mm
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterEmbedderKeyResponder.h
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterEmbedderKeyResponder.mm
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterEmbedderKeyResponderUnittests.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterEngine.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterEngineTest.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterEngine_Internal.h
@@ -1122,8 +1128,11 @@ FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterGLCom
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterGLCompositorUnittests.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterIOSurfaceHolder.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterIOSurfaceHolder.mm
-FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterIntermediateKeyResponder.h
-FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterIntermediateKeyResponder.mm
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterKeyPrimaryResponder.h
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterKeySecondaryResponder.h
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterKeyboardManager.h
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterKeyboardManager.mm
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterKeyboardManagerUnittests.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterMacOSExternalTexture.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterMetalRenderer.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterMetalRenderer.mm
@@ -1158,6 +1167,8 @@ FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterViewC
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterViewControllerTestUtils.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterViewControllerTestUtils.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterViewController_Internal.h
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/KeyCodeMap.mm
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/KeyCodeMap_internal.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/MacOSGLContextSwitch.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/MacOSGLContextSwitch.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/fixtures/flutter_desktop_test.dart

shell/platform/darwin/macos/BUILD.gn

@@ -59,8 +59,12 @@ source_set("flutter_framework_source") {
     "framework/Source/FlutterBackingStore.mm",
     "framework/Source/FlutterBackingStoreData.h",
     "framework/Source/FlutterBackingStoreData.mm",
+    "framework/Source/FlutterChannelKeyResponder.h",
+    "framework/Source/FlutterChannelKeyResponder.mm",
     "framework/Source/FlutterDartProject.mm",
     "framework/Source/FlutterDartProject_Internal.h",
+    "framework/Source/FlutterEmbedderKeyResponder.h",
+    "framework/Source/FlutterEmbedderKeyResponder.mm",
     "framework/Source/FlutterEngine.mm",
     "framework/Source/FlutterEngine_Internal.h",
     "framework/Source/FlutterExternalTextureGL.h",
@@ -73,8 +77,10 @@ source_set("flutter_framework_source") {
     "framework/Source/FlutterGLCompositor.mm",
     "framework/Source/FlutterIOSurfaceHolder.h",
     "framework/Source/FlutterIOSurfaceHolder.mm",
-    "framework/Source/FlutterIntermediateKeyResponder.h",
-    "framework/Source/FlutterIntermediateKeyResponder.mm",
+    "framework/Source/FlutterKeyPrimaryResponder.h",
+    "framework/Source/FlutterKeySecondaryResponder.h",
+    "framework/Source/FlutterKeyboardManager.h",
+    "framework/Source/FlutterKeyboardManager.mm",
     "framework/Source/FlutterMacOSExternalTexture.h",
     "framework/Source/FlutterMacOSExternalTexture.h",
     "framework/Source/FlutterMetalRenderer.h",
@@ -102,6 +108,7 @@ source_set("flutter_framework_source") {
     "framework/Source/FlutterView.mm",
     "framework/Source/FlutterViewController.mm",
     "framework/Source/FlutterViewController_Internal.h",
+    "framework/Source/KeyCodeMap.mm",
     "framework/Source/MacOSGLContextSwitch.h",
     "framework/Source/MacOSGLContextSwitch.mm",
   ]
@@ -158,9 +165,12 @@ executable("flutter_desktop_darwin_unittests") {
   testonly = true
 
   sources = [
+    "framework/Source/FlutterChannelKeyResponderUnittests.mm",
     "framework/Source/FlutterEmbedderExternalTextureUnittests.mm",
+    "framework/Source/FlutterEmbedderKeyResponderUnittests.mm",
     "framework/Source/FlutterEngineTest.mm",
     "framework/Source/FlutterGLCompositorUnittests.mm",
+    "framework/Source/FlutterKeyboardManagerUnittests.mm",
     "framework/Source/FlutterMetalRendererTest.mm",
     "framework/Source/FlutterMetalSurfaceManagerTest.mm",
     "framework/Source/FlutterOpenGLRendererTest.mm",

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

@@ -0,0 +1,24 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#import "flutter/shell/platform/darwin/macos/framework/Source/FlutterKeyPrimaryResponder.h"
+
+#import <Cocoa/Cocoa.h>
+
+#import "flutter/shell/platform/darwin/common/framework/Headers/FlutterChannels.h"
+
+/**
+ * A primary responder of |FlutterKeyboardManager| that handles events by
+ * sending the raw information through the method channel.
+ *
+ * This class corresponds to the RawKeyboard API in the framework.
+ */
+@interface FlutterChannelKeyResponder : NSObject <FlutterKeyPrimaryResponder>
+
+/**
+ * Create an instance by specifying the method channel to use.
+ */
+- (nonnull instancetype)initWithChannel:(nonnull FlutterBasicMessageChannel*)channel;
+
+@end

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

@@ -0,0 +1,86 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#import <objc/message.h>
+
+#import "FlutterChannelKeyResponder.h"
+#import "KeyCodeMap_internal.h"
+#import "flutter/shell/platform/darwin/common/framework/Headers/FlutterCodecs.h"
+#import "flutter/shell/platform/darwin/macos/framework/Source/FlutterViewController_Internal.h"
+#import "flutter/shell/platform/embedder/embedder.h"
+
+@interface FlutterChannelKeyResponder ()
+
+/**
+ * The channel used to communicate with Flutter.
+ */
+@property(nonatomic) FlutterBasicMessageChannel* channel;
+
+/**
+ * The |NSEvent.modifierFlags| of the last event received.
+ *
+ * Used to determine whether a FlagsChanged event should count as a keydown or
+ * a keyup event.
+ */
+@property(nonatomic) uint64_t previouslyPressedFlags;
+
+@end
+
+@implementation FlutterChannelKeyResponder
+
+- (nonnull instancetype)initWithChannel:(nonnull FlutterBasicMessageChannel*)channel {
+  self = [super init];
+  if (self != nil) {
+    _channel = channel;
+    _previouslyPressedFlags = 0;
+  }
+  return self;
+}
+
+- (void)handleEvent:(NSEvent*)event callback:(FlutterAsyncKeyCallback)callback {
+  NSString* type;
+  switch (event.type) {
+    case NSEventTypeKeyDown:
+      type = @"keydown";
+      break;
+    case NSEventTypeKeyUp:
+      type = @"keyup";
+      break;
+    case NSEventTypeFlagsChanged:
+      if (event.modifierFlags < _previouslyPressedFlags) {
+        type = @"keyup";
+      } else {
+        type = @"keydown";
+      }
+      break;
+    default:
+      NSAssert(false, @"Unexpected key event type (got %lu).", event.type);
+  }
+  _previouslyPressedFlags = event.modifierFlags;
+  NSMutableDictionary* keyMessage = [@{
+    @"keymap" : @"macos",
+    @"type" : type,
+    @"keyCode" : @(event.keyCode),
+    @"modifiers" : @(event.modifierFlags),
+  } mutableCopy];
+  // Calling these methods on any other type of event
+  // (e.g NSEventTypeFlagsChanged) will raise an exception.
+  if (event.type == NSEventTypeKeyDown || event.type == NSEventTypeKeyUp) {
+    keyMessage[@"characters"] = event.characters;
+    keyMessage[@"charactersIgnoringModifiers"] = event.charactersIgnoringModifiers;
+  }
+  [_channel sendMessage:keyMessage
+                  reply:^(id reply) {
+                    if (!reply) {
+                      return callback(true);
+                    }
+                    // Only propagate the event to other responders if the framework didn't handle
+                    // it.
+                    callback([[reply valueForKey:@"handled"] boolValue]);
+                  }];
+}
+
+#pragma mark - Private
+
+@end