Add FLEPluginRegistry for macOS (flutter#8611)

stuartmorgan · web-flow · commit 523a9a9adde9 · 2019-04-17T10:53:59.000-07:00
Creates a minimal FLEPluginRegistry protocol, which is a subset of the
FlutterPluginRegistry.

This is a small step toward eventually merging the APIs, but allows
changing the example project structure to better reflect what a future
template will look like.
diff --git a/shell/platform/darwin/macos/framework/Headers/FLEPluginRegistrar.h b/shell/platform/darwin/macos/framework/Headers/FLEPluginRegistrar.h
@@ -16,6 +16,9 @@
 #import "FlutterMacros.h"
 #endif
 
+// TODO: Merge this file and FLEPlugin.h with FlutterPlugin.h, sharing all but
+// the platform-specific methods.
+
 /**
  * The protocol for an object managing registration for a plugin. It provides access to application
  * context, as as allowing registering for callbacks for handling various conditions.
@@ -46,3 +49,30 @@ FLUTTER_EXPORT
                       channel:(nonnull FlutterMethodChannel*)channel;
 
 @end
+
+/**
+ * A registry of Flutter macOS plugins.
+ *
+ * Plugins are identified by unique string keys, typically the name of the
+ * plugin's main class.
+ *
+ * Plugins typically need contextual information and the ability to register
+ * callbacks for various application events. To keep the API of the registry
+ * focused, these facilities are not provided directly by the registry, but by
+ * a `FlutterPluginRegistrar`, created by the registry in exchange for the unique
+ * key of the plugin.
+ *
+ * There is no implied connection between the registry and the registrar.
+ * Specifically, callbacks registered by the plugin via the registrar may be
+ * relayed directly to the underlying iOS application objects.
+ */
+@protocol FLEPluginRegistry <NSObject>
+
+/**
+ * Returns a registrar for registering a plugin.
+ *
+ * @param pluginKey The unique key identifying the plugin.
+ */
+- (nonnull id<FLEPluginRegistrar>)registrarForPlugin:(nonnull NSString*)pluginKey;
+
+@end
diff --git a/shell/platform/darwin/macos/framework/Headers/FLEViewController.h b/shell/platform/darwin/macos/framework/Headers/FLEViewController.h
@@ -35,8 +35,10 @@ typedef NS_ENUM(NSInteger, FlutterMouseTrackingMode) {
  * Flutter engine in non-interactive mode, or with a drawable Flutter canvas.
  */
 FLUTTER_EXPORT
-@interface FLEViewController
-    : NSViewController <FlutterBinaryMessenger, FLEPluginRegistrar, FLEReshapeListener>
+@interface FLEViewController : NSViewController <FlutterBinaryMessenger,
+                                                 FLEPluginRegistrar,
+                                                 FLEPluginRegistry,
+                                                 FLEReshapeListener>
 
 /**
  * The view this controller manages when launched in interactive mode (headless set to false). Must
@@ -73,9 +75,4 @@ FLUTTER_EXPORT
 - (BOOL)launchHeadlessEngineWithAssetsPath:(nonnull NSURL*)assets
                       commandLineArguments:(nullable NSArray<NSString*>*)arguments;
 
-/**
- * Returns the FLEPluginRegistrar that should be used to register the plugin with the given name.
- */
-- (nonnull id<FLEPluginRegistrar>)registrarForPlugin:(nonnull NSString*)pluginName;
-
 @end
diff --git a/shell/platform/darwin/macos/framework/Source/FLEViewController.mm b/shell/platform/darwin/macos/framework/Source/FLEViewController.mm
@@ -251,13 +251,6 @@ - (BOOL)launchHeadlessEngineWithAssetsPath:(NSURL*)assets
                              commandLineArguments:arguments];
 }
 
-- (id<FLEPluginRegistrar>)registrarForPlugin:(NSString*)pluginName {
-  // Currently, the view controller acts as the registrar for all plugins, so the
-  // name is ignored. It is part of the API to reduce churn in the future when
-  // aligning more closely with the Flutter registrar system.
-  return self;
-}
-
 #pragma mark - Framework-internal methods
 
 - (void)addKeyResponder:(NSResponder*)responder {
@@ -529,6 +522,14 @@ - (void)addMethodCallDelegate:(nonnull id<FLEPlugin>)delegate
   }];
 }
 
+#pragma mark - FLEPluginRegistry
+
+- (id<FLEPluginRegistrar>)registrarForPlugin:(NSString*)pluginName {
+  // Currently, the view controller acts as the registrar for all plugins, so the
+  // name is ignored.
+  return self;
+}
+
 #pragma mark - NSResponder
 
 - (BOOL)acceptsFirstResponder {
