Remove debugging prints

Author: gspencergoog

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

@@ -24,19 +24,13 @@ NS_ASSUME_NONNULL_BEGIN
 @optional
 /**
  * Called when the |FlutterAppDelegate| gets the applicationWillFinishLaunching
- * notification. This only notifies that the notification occurred, it doesn't
- * allow a response. Only the application can respond to the notification by
- * overriding that handler in the |FlutterAppDelegate| subclass of the
- * application.
+ * notification.
  */
 - (void)handleWillFinishLaunching:(NSNotification*)notification;
 
 /**
  * Called when the |FlutterAppDelegate| gets the applicationDidFinishLaunching
- * notification. This only notifies that the notification occurred, it doesn't
- * allow a response. Only the application can respond to the notification by
- * overriding that handler in the |FlutterAppDelegate| subclass of the
- * application.
+ * notification.
  */
 - (void)handleDidFinishLaunching:(NSNotification*)notification;
 

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

@@ -9,9 +9,6 @@
 #import "FlutterCodecs.h"
 #import "FlutterMacros.h"
 
-// TODO: Merge this file and the iOS version with FlutterPluginRegistrar.h and
-// with the iOS FlutterPlugin.h, sharing all but the platform-specific methods.
-
 NS_ASSUME_NONNULL_BEGIN
 
 @protocol FlutterPluginRegistrar;

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

@@ -42,25 +42,30 @@ - (void)applicationWillFinishLaunching:(NSNotification*)notification {
   [_lifecycleRegistrar handleWillFinishLaunching:notification];
 }
 
-#define DISTRIBUTE_NOTIFICATION(SELECTOR)                        \
+// Using a macro to avoid errors where the selectors don't match.
+#ifdef FORWARD_NOTIFICATION
+#error FORWARD_NOTIFICATION ALREADY DEFINED!
+#endif
+#define FORWARD_NOTIFICATION(SELECTOR)                           \
   -(void)application##SELECTOR : (NSNotification*)notification { \
     [[self lifecycleRegistrar] handle##SELECTOR:notification];   \
   }
 
-DISTRIBUTE_NOTIFICATION(DidFinishLaunching)
-DISTRIBUTE_NOTIFICATION(WillBecomeActive)
-DISTRIBUTE_NOTIFICATION(DidBecomeActive)
-DISTRIBUTE_NOTIFICATION(WillResignActive)
-DISTRIBUTE_NOTIFICATION(DidResignActive)
-DISTRIBUTE_NOTIFICATION(WillTerminate)
-DISTRIBUTE_NOTIFICATION(WillHide)
-DISTRIBUTE_NOTIFICATION(DidHide)
-DISTRIBUTE_NOTIFICATION(WillUnhide)
-DISTRIBUTE_NOTIFICATION(DidUnhide)
-DISTRIBUTE_NOTIFICATION(DidChangeScreenParameters)
-DISTRIBUTE_NOTIFICATION(DidChangeOcclusionState)
-
-#undef DISTRIBUTE_NOTIFICATION
+// WillFinishLaunching is handled manually above.
+FORWARD_NOTIFICATION(DidFinishLaunching)
+FORWARD_NOTIFICATION(WillBecomeActive)
+FORWARD_NOTIFICATION(DidBecomeActive)
+FORWARD_NOTIFICATION(WillResignActive)
+FORWARD_NOTIFICATION(DidResignActive)
+FORWARD_NOTIFICATION(WillTerminate)
+FORWARD_NOTIFICATION(WillHide)
+FORWARD_NOTIFICATION(DidHide)
+FORWARD_NOTIFICATION(WillUnhide)
+FORWARD_NOTIFICATION(DidUnhide)
+FORWARD_NOTIFICATION(DidChangeScreenParameters)
+FORWARD_NOTIFICATION(DidChangeOcclusionState)
+
+#undef FORWARD_NOTIFICATION
 
 #pragma mark - Delegate handling
 

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

@@ -35,28 +35,31 @@ - (void)addObserverFor:(NSString*)name selector:(SEL)selector {
 - (instancetype)init {
   if (self = [super init]) {
     _notificationUnsubscribers = [[NSMutableArray alloc] init];
-    [self addObserverFor:NSApplicationWillFinishLaunchingNotification
-                selector:@selector(handleWillFinishLaunching:)];
-    [self addObserverFor:NSApplicationDidFinishLaunchingNotification
-                selector:@selector(handleDidFinishLaunching:)];
-    [self addObserverFor:NSApplicationWillBecomeActiveNotification
-                selector:@selector(handleWillBecomeActive:)];
-    [self addObserverFor:NSApplicationDidBecomeActiveNotification
-                selector:@selector(handleDidBecomeActive:)];
-    [self addObserverFor:NSApplicationWillResignActiveNotification
-                selector:@selector(handleWillResignActive:)];
-    [self addObserverFor:NSApplicationDidResignActiveNotification
-                selector:@selector(handleDidResignActive:)];
-    [self addObserverFor:NSApplicationWillTerminateNotification
-                selector:@selector(handleWillTerminate:)];
-    [self addObserverFor:NSApplicationWillHideNotification selector:@selector(handleWillHide:)];
-    [self addObserverFor:NSApplicationDidHideNotification selector:@selector(handleDidHide:)];
-    [self addObserverFor:NSApplicationWillUnhideNotification selector:@selector(handleWillUnhide:)];
-    [self addObserverFor:NSApplicationDidUnhideNotification selector:@selector(handleDidUnhide:)];
-    [self addObserverFor:NSApplicationDidChangeOcclusionStateNotification
-                selector:@selector(handleDidChangeOcclusionState:)];
-    [self addObserverFor:NSApplicationDidChangeScreenParametersNotification
-                selector:@selector(handleDidChangeScreenParameters:)];
+
+// Using a macro to avoid errors where the notification doesn't match the
+// selector.
+#ifdef OBSERVE_NOTIFICATION
+#error OBSERVE_NOTIFICATION ALREADY DEFINED!
+#endif
+#define OBSERVE_NOTIFICATION(SELECTOR) \
+  [self addObserverFor:NSApplication##SELECTOR##Notification selector:@selector(handle##SELECTOR:)]
+
+    OBSERVE_NOTIFICATION(WillFinishLaunching);
+    OBSERVE_NOTIFICATION(DidFinishLaunching);
+    OBSERVE_NOTIFICATION(WillBecomeActive);
+    OBSERVE_NOTIFICATION(DidBecomeActive);
+    OBSERVE_NOTIFICATION(WillResignActive);
+    OBSERVE_NOTIFICATION(DidResignActive);
+    OBSERVE_NOTIFICATION(WillTerminate);
+    OBSERVE_NOTIFICATION(WillHide);
+    OBSERVE_NOTIFICATION(DidHide);
+    OBSERVE_NOTIFICATION(WillUnhide);
+    OBSERVE_NOTIFICATION(DidUnhide);
+    OBSERVE_NOTIFICATION(DidChangeScreenParameters);
+    OBSERVE_NOTIFICATION(DidChangeOcclusionState);
+
+#undef OBSERVE_NOTIFICATION
+
     _delegates = [NSPointerArray weakObjectsPointerArray];
   }
   return self;
@@ -103,32 +106,34 @@ - (void)removeDelegate:(NSObject<FlutterAppLifecycleDelegate>*)delegate {
 
 // This isn't done via performSelector because that can cause leaks due
 // to the selector not being known.
+#ifdef DISTRIBUTE_NOTIFICATION
+#error DISTRIBUTE_NOTIFICATION ALREADY DEFINED!
+#endif
 #define DISTRIBUTE_NOTIFICATION(SELECTOR)                                  \
   -(void)SELECTOR : (NSNotification*)notification {                        \
-    NSLog(@"Received " #SELECTOR " notification.");                        \
     for (NSObject<FlutterAppLifecycleDelegate> * delegate in _delegates) { \
       if (!delegate) {                                                     \
         continue;                                                          \
       }                                                                    \
-      if ([delegate respondsToSelector:@selector(SELECTOR:)]) {            \
-        [delegate SELECTOR:notification];                                  \
+      if ([delegate respondsToSelector:@selector(handle##SELECTOR:)]) {    \
+        [delegate handle##SELECTOR:notification];                          \
       }                                                                    \
     }                                                                      \
   }
 
-DISTRIBUTE_NOTIFICATION(handleWillFinishLaunching)
-DISTRIBUTE_NOTIFICATION(handleDidFinishLaunching)
-DISTRIBUTE_NOTIFICATION(handleWillBecomeActive)
-DISTRIBUTE_NOTIFICATION(handleDidBecomeActive)
-DISTRIBUTE_NOTIFICATION(handleWillResignActive)
-DISTRIBUTE_NOTIFICATION(handleDidResignActive)
-DISTRIBUTE_NOTIFICATION(handleWillTerminate)
-DISTRIBUTE_NOTIFICATION(handleWillHide)
-DISTRIBUTE_NOTIFICATION(handleWillUnhide)
-DISTRIBUTE_NOTIFICATION(handleDidHide)
-DISTRIBUTE_NOTIFICATION(handleDidUnhide)
-DISTRIBUTE_NOTIFICATION(handleDidChangeScreenParameters)
-DISTRIBUTE_NOTIFICATION(handleDidChangeOcclusionState)
+DISTRIBUTE_NOTIFICATION(WillFinishLaunching)
+DISTRIBUTE_NOTIFICATION(DidFinishLaunching)
+DISTRIBUTE_NOTIFICATION(WillBecomeActive)
+DISTRIBUTE_NOTIFICATION(DidBecomeActive)
+DISTRIBUTE_NOTIFICATION(WillResignActive)
+DISTRIBUTE_NOTIFICATION(DidResignActive)
+DISTRIBUTE_NOTIFICATION(WillTerminate)
+DISTRIBUTE_NOTIFICATION(WillHide)
+DISTRIBUTE_NOTIFICATION(WillUnhide)
+DISTRIBUTE_NOTIFICATION(DidHide)
+DISTRIBUTE_NOTIFICATION(DidUnhide)
+DISTRIBUTE_NOTIFICATION(DidChangeScreenParameters)
+DISTRIBUTE_NOTIFICATION(DidChangeOcclusionState)
 
 #undef DISTRIBUTE_NOTIFICATION
 

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

@@ -29,6 +29,10 @@
 
 NSString* const kFlutterPlatformChannel = @"flutter/platform";
 NSString* const kFlutterSettingsChannel = @"flutter/settings";
+NSString* const kFlutterLifecycleChannel = @"flutter/lifecycle";
+
+// The size of the channel buffer for the lifecycle channel.
+NSUInteger const kLifecycleChannelBufferSize = 1000;
 
 /**
  * Constructs and returns a FlutterLocale struct corresponding to |locale|, which must outlive
@@ -52,27 +56,6 @@ static FlutterLocale FlutterLocaleFromNSLocale(NSLocale* locale) {
 /// Clipboard plain text format.
 constexpr char kTextPlainFormat[] = "text/plain";
 
-namespace {
-
-std::string LifecycleStateToString(FlutterEngineLifecycleState state) {
-  switch (state) {
-    case kFlutterEngineLifecycleStateDetached:
-      return "AppLifecycleState.detached";
-    case kFlutterEngineLifecycleStateInitializing:
-      return "AppLifecycleState.initializing";
-    case kFlutterEngineLifecycleStateResumed:
-      return "AppLifecycleState.resumed";
-    case kFlutterEngineLifecycleStateInactive:
-      return "AppLifecycleState.inactive";
-    case kFlutterEngineLifecycleStateHidden:
-      return "AppLifecycleState.hidden";
-    case kFlutterEngineLifecycleStatePaused:
-      return "AppLifecycleState.paused";
-  }
-}
-
-}  // namespace
-
 #pragma mark -
 
 // Records an active handler of the messenger (FlutterEngine) that listens to
@@ -448,6 +431,11 @@ - (instancetype)initWithName:(NSString*)labelPrefix
 }
 
 - (void)dealloc {
+  FlutterAppDelegate* appDelegate =
+      (FlutterAppDelegate*)[[FlutterApplication sharedApplication] delegate];
+  if (appDelegate != nil) {
+    [appDelegate removeApplicationLifecycleDelegate:self];
+  }
   @synchronized(_isResponseValid) {
     [_isResponseValid removeAllObjects];
     [_isResponseValid addObject:@NO];
@@ -564,6 +552,14 @@ - (BOOL)runWithEntrypoint:(NSString*)entrypoint {
     [self updateWindowMetricsForViewController:nextViewController];
   }
 
+  // Send a message to the lifecycle channel to bump up the channel buffer size
+  // so that any lifecycle messages sent before the framework is listening
+  // eventually get delivered.
+  [[FlutterBasicMessageChannel messageChannelWithName:kFlutterLifecycleChannel
+                                      binaryMessenger:self.binaryMessenger
+                                                codec:[FlutterStandardMessageCodec sharedInstance]]
+      resizeChannelBuffer:kLifecycleChannelBufferSize];
+
   [self updateDisplayConfig];
   // Send the initial user settings such as brightness and text scale factor
   // to the engine.
@@ -1066,6 +1062,8 @@ - (void)setApplicationState:(FlutterEngineLifecycleState)state {
       kFlutterEngineLifecycleStateResumed,  kFlutterEngineLifecycleStateInactive,
       kFlutterEngineLifecycleStateHidden,   kFlutterEngineLifecycleStatePaused,
   };
+  // Make sure that the given state exists in the state_order.
+  assert(std::find(state_order.begin(), state_order.end(), state) != state_order.end());
 
   FlutterEngineLifecycleState previousState = _embedderAPI.GetLifecycleState(_engine);
   // Make sure that when we transition between states, it follows the allowed
@@ -1082,22 +1080,15 @@ - (void)setApplicationState:(FlutterEngineLifecycleState)state {
     }
   }
 
-  NSLog(@"Moving to state %s from %s", LifecycleStateToString(state).c_str(),
-        LifecycleStateToString(previousState).c_str());
   for (std::vector<FlutterEngineLifecycleState>::size_type i = 0; i < state_changes.size(); i++) {
-    NSLog(@"Sending application state change to %s",
-          LifecycleStateToString(state_changes[i]).c_str());
     _embedderAPI.SetLifecycleState(_engine,
                                    static_cast<FlutterEngineLifecycleState>(state_changes[i]));
   }
 }
 
 /**
  * Called when the |FlutterAppDelegate| gets the applicationWillFinishLaunching
- * notification. This only notifies that the notification occurred, it doesn't
- * allow a response. Only the application can respond to the notification by
- * overriding that handler in the |FlutterAppDelegate| subclass of the
- * application.
+ * notification.
  */
 - (void)handleWillFinishLaunching:(NSNotification*)notification {
   [self setApplicationState:kFlutterEngineLifecycleStateInitializing];
@@ -1136,15 +1127,13 @@ - (void)handleWillResignActive:(NSNotification*)notification {
 - (void)handleDidChangeOcclusionState:(NSNotification*)notification API_AVAILABLE(macos(10.9)) {
   NSApplicationOcclusionState occlusionState = [NSApp occlusionState];
   if (occlusionState & NSApplicationOcclusionStateVisible) {
-    NSLog(@"Changing occlusion state to visible");
     _visible = YES;
     if (_active) {
       [self setApplicationState:kFlutterEngineLifecycleStateResumed];
     } else {
       [self setApplicationState:kFlutterEngineLifecycleStateInactive];
     }
   } else {
-    NSLog(@"Changing occlusion state to invisible");
     _visible = NO;
     [self setApplicationState:kFlutterEngineLifecycleStateHidden];
   }

shell/platform/embedder/embedder.cc

@@ -2959,6 +2959,9 @@ std::string LifecycleStateToString(FlutterEngineLifecycleState state) {
       return "AppLifecycleState.hidden";
     case kFlutterEngineLifecycleStatePaused:
       return "AppLifecycleState.paused";
+    default:
+      assert(false && "Lifecycle state not recognized");
+      break;
   }
 }
 

shell/platform/embedder/embedder.h

@@ -1958,7 +1958,7 @@ typedef struct {
 /// allowed state machine:
 ///
 ///             +-----------+        +--------------+       +-----------+
-///             | detached  |<------>| initializing |<----->|  resumed  |
+///             | detached  |------->| initializing |------>|  resumed  |
 ///             +-----------+        +--------------+       +-----------+
 ///                  ^                                              ^
 ///                  |                                              |
@@ -1969,25 +1969,29 @@ typedef struct {
 ///
 /// The states and their meanings are as follows:
 ///
-/// detached: The initial state of the state machine. On Android, also the final
-///           state of the state machine. Other platforms do not enter this
-///           state again after leaving it.
+/// detached: The initial state of the state machine. On Android and iOS,
+///           also the final state of the state machine when all views are
+///           detached. Other platforms do not enter this state again after
+///           initially leaving it.
 ///
-/// initializing: The state entered once the engine is running, but  before
+/// initializing: The state entered once the engine is running, but before
 ///               drawing the first frame.
 ///
 /// resumed: The nominal "running" state of the application. The
 ///          application is visible, has input focus, and is running.
 ///
-/// inactive: At least some of the application is visible, but it
-///           does not have input focus.
+/// inactive: At least one view of the application is visible, but none
+///           have input focus. The application is otherwise running
+///           normally.
 ///
-/// hidden: No part of the application is visible, and it does not have input
-///         focus.
+/// hidden: All views of an application are hidden, either because the
+///         application is being stopped (on iOS and Android), or because
+///         it is being minimized or on a desktop that is no longer visible
+///         (on desktop), or on a tab that is no longer visible (on web).
 ///
-/// paused: The application is not running, and can be detached or resumed at
-///         any time. This state is typically only entered into on iOS and
-///         Android.
+/// paused: The application is not running, and can be detached or started
+///         again at any time. This state is typically only entered into on
+///         iOS and Android.
 typedef enum {
   kFlutterEngineLifecycleStateDetached = 0x0,
   kFlutterEngineLifecycleStateInitializing = 0x1,