[WIP] [macos] Wireup platform views on macOS

* The plan is to only support platform views when using Metal rendering
backend.

* This PR is based on the work done in: flutter#22905

Author: iskakaushik

ci/licenses_golden/licenses_flutter

@@ -1281,6 +1281,13 @@ FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterOpenG
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformNodeDelegateMac.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformNodeDelegateMac.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformNodeDelegateMacTest.mm
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformViewController.h
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformViewController.mm
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformViewControllerTest.mm
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformViewController_Internal.h
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformViewMock.h
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformViewMock.mm
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformViews.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterRenderer.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterRenderingBackend.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterRenderingBackend.mm

shell/platform/darwin/macos/BUILD.gn

@@ -40,6 +40,7 @@ _flutter_framework_headers = [
   "framework/Headers/FlutterDartProject.h",
   "framework/Headers/FlutterEngine.h",
   "framework/Headers/FlutterMacOS.h",
+  "framework/Headers/FlutterPlatformViews.h",
   "framework/Headers/FlutterPluginMacOS.h",
   "framework/Headers/FlutterPluginRegistrarMacOS.h",
   "framework/Headers/FlutterViewController.h",
@@ -95,6 +96,8 @@ source_set("flutter_framework_source") {
     "framework/Source/FlutterOpenGLRenderer.mm",
     "framework/Source/FlutterPlatformNodeDelegateMac.h",
     "framework/Source/FlutterPlatformNodeDelegateMac.mm",
+    "framework/Source/FlutterPlatformViewController.mm",
+    "framework/Source/FlutterPlatformViewController_Internal.h",
     "framework/Source/FlutterRenderer.h",
     "framework/Source/FlutterRenderingBackend.h",
     "framework/Source/FlutterRenderingBackend.mm",
@@ -186,6 +189,9 @@ executable("flutter_desktop_darwin_unittests") {
     "framework/Source/FlutterMetalSurfaceManagerTest.mm",
     "framework/Source/FlutterOpenGLRendererTest.mm",
     "framework/Source/FlutterPlatformNodeDelegateMacTest.mm",
+    "framework/Source/FlutterPlatformViewControllerTest.mm",
+    "framework/Source/FlutterPlatformViewMock.h",
+    "framework/Source/FlutterPlatformViewMock.mm",
     "framework/Source/FlutterTextInputPluginTest.mm",
     "framework/Source/FlutterTextInputSemanticsObjectTest.mm",
     "framework/Source/FlutterViewControllerTest.mm",

shell/platform/darwin/macos/framework/Headers/FlutterPlatformViews.h

@@ -0,0 +1,62 @@
+// 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.
+
+#ifndef FLUTTER_FLUTTERPLATFORMVIEWS_H_
+#define FLUTTER_FLUTTERPLATFORMVIEWS_H_
+
+#import <AppKit/AppKit.h>
+
+#import "FlutterCodecs.h"
+#import "FlutterMacros.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * Wraps a `NSView` for embedding in the Flutter hierarchy
+ */
+@protocol FlutterPlatformView <NSObject>
+/**
+ * Returns a reference to the `NSView` that is wrapped by this `FlutterPlatformView`.
+ *
+ * It is recommended to return a cached view instance in this method.
+ * Constructing and returning a new NSView instance in this method might cause undefined behavior.
+ *
+ * TODO(richardjcai): Prevent [FlutterPlatformView view] to be called multiple times
+ * in a single frame.
+ */
+- (NSView*)view;
+@end
+
+@protocol FlutterPlatformViewFactory <NSObject>
+
+/**
+ * Create a `FlutterPlatformView`.
+ *
+ * Implemented by MacOS code that expose a `FlutterPlatformView` for embedding in a Flutter app.
+ *
+ * The implementation of this method should create a new `FlutterPlatformView` and return it.
+ *
+ * @param frame The rectangle for the newly created `FlutterPlatformView` measured in points.
+ * @param viewId A unique identifier for this `FlutterPlatformView`.
+ * @param args Parameters for creating the `FlutterPlatformView` sent from the Dart side of the
+ * Flutter app. If `createArgsCodec` is not implemented, or if no creation arguments were sent from
+ * the Dart code, this will be null. Otherwise this will be the value sent from the Dart code as
+ * decoded by `createArgsCodec`.
+ */
+- (NSObject<FlutterPlatformView>*)createWithFrame:(CGRect)frame
+                                   viewIdentifier:(int64_t)viewId
+                                        arguments:(id _Nullable)args;
+
+/**
+ * Returns the `FlutterMessageCodec` for decoding the args parameter of `createWithFrame`.
+ *
+ * Only needs to be implemented if `createWithFrame` needs an arguments parameter.
+ */
+@optional
+- (NSObject<FlutterMessageCodec>*)createArgsCodec;
+@end
+
+NS_ASSUME_NONNULL_END
+
+#endif  // FLUTTER_FLUTTERPLATFORMVIEWS_H_

shell/platform/darwin/macos/framework/Headers/FlutterPluginRegistrarMacOS.h

@@ -7,6 +7,7 @@
 #import "FlutterBinaryMessenger.h"
 #import "FlutterChannels.h"
 #import "FlutterMacros.h"
+#import "FlutterPlatformViews.h"
 #import "FlutterPluginMacOS.h"
 #import "FlutterTexture.h"
 
@@ -48,6 +49,18 @@ FLUTTER_DARWIN_EXPORT
 - (void)addMethodCallDelegate:(nonnull id<FlutterPlugin>)delegate
                       channel:(nonnull FlutterMethodChannel*)channel;
 
+/**
+ * Registers a `FlutterPlatformViewFactory` for creation of platform views.
+ *
+ * Plugins expose `UIView` for embedding in Flutter apps by registering a view factory.
+ *
+ * @param factory The view factory that will be registered.
+ * @param factoryId A unique identifier for the factory, the Dart code of the Flutter app can use
+ *   this identifier to request creation of a `UIView` by the registered factory.
+ */
+- (void)registerViewFactory:(nonnull NSObject<FlutterPlatformViewFactory>*)factory
+                     withId:(nonnull NSString*)factoryId;
+
 @end
 
 /**

shell/platform/darwin/macos/framework/Headers/FlutterViewController.h

@@ -6,6 +6,7 @@
 
 #import "FlutterEngine.h"
 #import "FlutterMacros.h"
+#import "FlutterPlatformViews.h"
 #import "FlutterPluginRegistrarMacOS.h"
 
 /**

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

@@ -15,9 +15,10 @@
 #import "flutter/shell/platform/darwin/macos/framework/Source/FlutterMetalCompositor.h"
 #import "flutter/shell/platform/darwin/macos/framework/Source/FlutterMetalRenderer.h"
 #import "flutter/shell/platform/darwin/macos/framework/Source/FlutterOpenGLRenderer.h"
+#import "flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformViewController_Internal.h"
 #import "flutter/shell/platform/darwin/macos/framework/Source/FlutterRenderingBackend.h"
 #import "flutter/shell/platform/darwin/macos/framework/Source/FlutterViewController_Internal.h"
-#include "flutter/shell/platform/embedder/embedder.h"
+#import "flutter/shell/platform/embedder/embedder.h"
 
 /**
  * Constructs and returns a FlutterLocale struct corresponding to |locale|, which must outlive
@@ -95,6 +96,16 @@ - (void)postMainThreadTask:(FlutterTask)task targetTimeInNanoseconds:(uint64_t)t
  */
 - (void)loadAOTData:(NSString*)assetsDir;
 
+/**
+ * Creates and returns a FlutterCompositor* to be used by the embedder.
+ */
+- (FlutterCompositor*)createFlutterCompositor;
+
+/**
+ * Create a platform view channel and setup a method call handler.
+ */
+- (void)setupPlatformViewChannel;
+
 @end
 
 #pragma mark -
@@ -145,6 +156,13 @@ - (void)addMethodCallDelegate:(nonnull id<FlutterPlugin>)delegate
   }];
 }
 
+- (void)registerViewFactory:(nonnull NSObject<FlutterPlatformViewFactory>*)factory
+                     withId:(nonnull NSString*)factoryId {
+  NSLog(@"registering a view with id: %@, controller = %@", factoryId,
+        [_flutterEngine platformViewController]);
+  [[_flutterEngine platformViewController] registerViewFactory:factory withId:factoryId];
+}
+
 @end
 
 // Callbacks provided to the engine. See the called methods for documentation.
@@ -186,6 +204,13 @@ @implementation FlutterEngine {
 
   // FlutterCompositor is copied and used in embedder.cc.
   FlutterCompositor _compositor;
+
+  // A method channel for platform view functionality.
+  FlutterMethodChannel* _platformViewsChannel;
+
+  // Used to support creation and deletion of platform views and
+  // registering platform view factories.
+  FlutterPlatformViewController* _platformViewController;
 }
 
 - (instancetype)initWithName:(NSString*)labelPrefix project:(FlutterDartProject*)project {
@@ -219,6 +244,10 @@ - (instancetype)initWithName:(NSString*)labelPrefix
                              name:NSCurrentLocaleDidChangeNotification
                            object:nil];
 
+  // TODO find the right place for this.
+  _platformViewController = [[FlutterPlatformViewController alloc] init];
+  [self setupPlatformViewChannel];
+
   return self;
 }
 
@@ -383,8 +412,8 @@ - (FlutterCompositor*)createFlutterCompositor {
 
   if ([FlutterRenderingBackend renderUsingMetal]) {
     FlutterMetalRenderer* metalRenderer = reinterpret_cast<FlutterMetalRenderer*>(_renderer);
-    _macOSCompositor =
-        std::make_unique<flutter::FlutterMetalCompositor>(_viewController, metalRenderer.device);
+    _macOSCompositor = std::make_unique<flutter::FlutterMetalCompositor>(
+        _viewController, _platformViewController, metalRenderer.device);
     _macOSCompositor->SetPresentCallback([weakSelf](bool has_flutter_content) {
       if (has_flutter_content) {
         FlutterMetalRenderer* metalRenderer =
@@ -541,6 +570,11 @@ - (void)dispatchSemanticsAction:(FlutterSemanticsAction)action
   _embedderAPI.DispatchSemanticsAction(_engine, target, action, data.GetMapping(), data.GetSize());
 }
 
+- (FlutterPlatformViewController*)platformViewController {
+  NSLog(@"returning pvc: %@", _platformViewController);
+  return _platformViewController;
+}
+
 #pragma mark - Private methods
 
 - (void)sendUserLocales {
@@ -630,6 +664,18 @@ - (void)shutDownEngine {
   _engine = nullptr;
 }
 
+- (void)setupPlatformViewChannel {
+  _platformViewsChannel =
+      [FlutterMethodChannel methodChannelWithName:@"flutter/platform_views"
+                                  binaryMessenger:self.binaryMessenger
+                                            codec:[FlutterStandardMethodCodec sharedInstance]];
+
+  __weak FlutterEngine* weakSelf = self;
+  [_platformViewsChannel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
+    [[weakSelf platformViewController] handleMethodCall:call result:result];
+  }];
+}
+
 #pragma mark - FlutterBinaryMessenger
 
 - (void)sendOnChannel:(nonnull NSString*)channel message:(nullable NSData*)message {
@@ -784,11 +830,13 @@ - (void)updateSemanticsCustomActions:(const FlutterSemanticsCustomAction*)action
 - (void)postMainThreadTask:(FlutterTask)task targetTimeInNanoseconds:(uint64_t)targetTime {
   const auto engine_time = _embedderAPI.GetCurrentTime();
 
-  __weak FlutterEngine* weak_self = self;
+  // TODO refactor to a helper method:
+  // see: https://github.com/flutter/engine/pull/22905/files#r553438414
+  __weak FlutterEngine* weakSelf = self;
   auto worker = ^{
-    FlutterEngine* strong_self = weak_self;
-    if (strong_self && strong_self->_engine) {
-      auto result = _embedderAPI.RunTask(strong_self->_engine, &task);
+    FlutterEngine* strongSelf = weakSelf;
+    if (strongSelf && strongSelf->_engine) {
+      auto result = _embedderAPI.RunTask(strongSelf->_engine, &task);
       if (result != kSuccess) {
         NSLog(@"Could not post a task to the Flutter engine.");
       }

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

@@ -10,6 +10,7 @@
 
 #include "flutter/shell/platform/common/accessibility_bridge.h"
 #import "flutter/shell/platform/darwin/macos/framework/Source/FlutterCompositor.h"
+#import "flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformViewController_Internal.h"
 #import "flutter/shell/platform/darwin/macos/framework/Source/FlutterRenderer.h"
 
 @interface FlutterEngine ()
@@ -70,6 +71,8 @@
  */
 - (BOOL)unregisterTextureWithID:(int64_t)textureID;
 
+- (nonnull FlutterPlatformViewController*)platformViewController;
+
 // Accessibility API.
 
 /**

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

@@ -5,25 +5,28 @@
 #import <Foundation/Foundation.h>
 
 #import "flutter/shell/platform/darwin/macos/framework/Source/FlutterGLCompositor.h"
+#import "flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformViewController_Internal.h"
 #import "flutter/shell/platform/darwin/macos/framework/Source/FlutterViewControllerTestUtils.h"
 #import "flutter/testing/testing.h"
 
 namespace flutter::testing {
 
 TEST(FlutterGLCompositorTest, TestPresent) {
-  id mockViewController = CreateMockViewController(nil);
+  // id mockViewController = CreateMockViewController(nil);
+  // FlutterPlatformViewController* platformViewController =
+  //     [[FlutterPlatformViewController alloc] init];
 
-  std::unique_ptr<flutter::FlutterGLCompositor> macos_compositor =
-      std::make_unique<FlutterGLCompositor>(mockViewController, nullptr);
+  // std::unique_ptr<flutter::FlutterGLCompositor> macos_compositor =
+  //     std::make_unique<FlutterGLCompositor>(mockViewController, platformViewController);
 
-  bool flag = false;
-  macos_compositor->SetPresentCallback([f = &flag](bool has_flutter_content) {
-    *f = true;
-    return true;
-  });
+  // bool flag = false;
+  // macos_compositor->SetPresentCallback([f = &flag](bool has_flutter_content) {
+  //   *f = true;
+  //   return true;
+  // });
 
-  ASSERT_TRUE(macos_compositor->Present(nil, 0));
-  ASSERT_TRUE(flag);
+  // ASSERT_TRUE(macos_compositor->Present(nil, 0));
+  // ASSERT_TRUE(flag);
 }
 
 }  // namespace flutter::testing

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

@@ -7,13 +7,16 @@
 
 #include "flutter/fml/macros.h"
 #include "flutter/shell/platform/darwin/macos/framework/Source/FlutterCompositor.h"
+#import "flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformViewController_Internal.h"
 
 namespace flutter {
 
 class FlutterMetalCompositor : public FlutterCompositor {
  public:
-  explicit FlutterMetalCompositor(FlutterViewController* view_controller,
-                                  id<MTLDevice> mtl_device);
+  explicit FlutterMetalCompositor(
+      FlutterViewController* view_controller,
+      FlutterPlatformViewController* platform_views_controller,
+      id<MTLDevice> mtl_device);
 
   virtual ~FlutterMetalCompositor() = default;
 
@@ -42,7 +45,10 @@ class FlutterMetalCompositor : public FlutterCompositor {
   bool Present(const FlutterLayer** layers, size_t layers_count) override;
 
  private:
+  void PresentPlatformView(const FlutterLayer* layer, size_t layer_position);
+
   const id<MTLDevice> mtl_device_;
+  const FlutterPlatformViewController* platform_views_controller_;
 
   FML_DISALLOW_COPY_AND_ASSIGN(FlutterMetalCompositor);
 };