[ios] Update SnapshotGeneratorDelegate

This CL renames SnapshotGeneratorDelegate protocol methods to be
unique to SnapshotGenerator.

Bug: 904992
Change-Id: I6357931f782a7d533a74a0b438751b4d5a78aab4
Reviewed-on: https://chromium-review.googlesource.com/c/1345128
Commit-Queue: edchin <edchin@chromium.org>
Reviewed-by: Justin Cohen <justincohen@chromium.org>
Reviewed-by: edchin <edchin@chromium.org>
Reviewed-by: Kurt Horimoto <kkhorimoto@chromium.org>
Cr-Commit-Position: refs/heads/master@{#611847}

ios/chrome/browser/snapshots/fake_snapshot_generator_delegate.mm

@@ -12,27 +12,33 @@
 
 @synthesize view = _view;
 
-- (BOOL)canTakeSnapshotForWebState:(web::WebState*)webState {
+- (BOOL)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+    canTakeSnapshotForWebState:(web::WebState*)webState {
   return YES;
 }
 
-- (UIEdgeInsets)snapshotEdgeInsetsForWebState:(web::WebState*)webState {
+- (UIEdgeInsets)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+    snapshotEdgeInsetsForWebState:(web::WebState*)webState {
   return UIEdgeInsetsZero;
 }
 
-- (NSArray<SnapshotOverlay*>*)snapshotOverlaysForWebState:
-    (web::WebState*)webState {
+- (NSArray<SnapshotOverlay*>*)snapshotGenerator:
+                                  (SnapshotGenerator*)snapshotGenerator
+                    snapshotOverlaysForWebState:(web::WebState*)webState {
   return nil;
 }
 
-- (void)willUpdateSnapshotForWebState:(web::WebState*)webState {
+- (void)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+    willUpdateSnapshotForWebState:(web::WebState*)webState {
 }
 
-- (void)didUpdateSnapshotForWebState:(web::WebState*)webState
-                           withImage:(UIImage*)snapshot {
+- (void)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+    didUpdateSnapshotForWebState:(web::WebState*)webState
+                       withImage:(UIImage*)snapshot {
 }
 
-- (UIView*)viewForWebState:(web::WebState*)webState {
+- (UIView*)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+         baseViewForWebState:(web::WebState*)webState {
   return self.view;
 }
 

ios/chrome/browser/snapshots/snapshot_generator.mm

@@ -220,7 +220,8 @@ BOOL ViewHierarchyContainsWKWebView(UIView* view) {
 
 - (void)updateWebViewSnapshotWithCompletion:(void (^)(UIImage*))completion {
   DCHECK(_webState);
-  UIView* snapshotView = [self.delegate viewForWebState:_webState];
+  UIView* snapshotView = [self.delegate snapshotGenerator:self
+                                      baseViewForWebState:_webState];
   CGRect snapshotFrame = [self snapshotFrameVisibleFrameOnly:YES];
   snapshotFrame =
       [_webState->GetView() convertRect:snapshotFrame fromView:snapshotView];
@@ -238,8 +239,8 @@ BOOL ViewHierarchyContainsWKWebView(UIView* view) {
       << ": snapshotFrame.size.width=" << size.width;
   DCHECK(std::isnormal(size.height) && (size.height > 0))
       << ": snapshotFrame.size.height=" << size.height;
-  NSArray<SnapshotOverlay*>* overlays =
-      [_delegate snapshotOverlaysForWebState:_webState];
+  NSArray<SnapshotOverlay*>* overlays = [_delegate snapshotGenerator:self
+                                         snapshotOverlaysForWebState:_webState];
   UIImage* snapshot =
       [_coalescingSnapshotContext cachedSnapshotWithOverlays:overlays
                                             visibleFrameOnly:YES];
@@ -253,7 +254,7 @@ BOOL ViewHierarchyContainsWKWebView(UIView* view) {
     return;
   }
 
-  [_delegate willUpdateSnapshotForWebState:_webState];
+  [_delegate snapshotGenerator:self willUpdateSnapshotForWebState:_webState];
   __weak SnapshotGenerator* weakSelf = self;
   _webState->TakeSnapshot(
       snapshotFrame, base::BindOnce(^(gfx::Image image) {
@@ -274,7 +275,9 @@ BOOL ViewHierarchyContainsWKWebView(UIView* view) {
         [_coalescingSnapshotContext setCachedSnapshot:snapshot
                                          withOverlays:overlays
                                      visibleFrameOnly:YES];
-        [_delegate didUpdateSnapshotForWebState:_webState withImage:snapshot];
+        [_delegate snapshotGenerator:self
+            didUpdateSnapshotForWebState:_webState
+                               withImage:snapshot];
         if (completion)
           completion(snapshot);
       }));
@@ -287,7 +290,8 @@ BOOL ViewHierarchyContainsWKWebView(UIView* view) {
     return nil;
 
   NSArray<SnapshotOverlay*>* overlays =
-      shouldAddOverlay ? [_delegate snapshotOverlaysForWebState:_webState]
+      shouldAddOverlay ? [_delegate snapshotGenerator:self
+                             snapshotOverlaysForWebState:_webState]
                        : nil;
   UIImage* snapshot =
       [_coalescingSnapshotContext cachedSnapshotWithOverlays:overlays
@@ -296,14 +300,17 @@ BOOL ViewHierarchyContainsWKWebView(UIView* view) {
   if (snapshot)
     return snapshot;
 
-  [_delegate willUpdateSnapshotForWebState:_webState];
-  UIView* view = [_delegate viewForWebState:_webState];
+  [_delegate snapshotGenerator:self willUpdateSnapshotForWebState:_webState];
+  UIView* view = [_delegate snapshotGenerator:self
+                          baseViewForWebState:_webState];
   snapshot =
       [self generateSnapshotForView:view withRect:frame overlays:overlays];
   [_coalescingSnapshotContext setCachedSnapshot:snapshot
                                    withOverlays:overlays
                                visibleFrameOnly:visibleFrameOnly];
-  [_delegate didUpdateSnapshotForWebState:_webState withImage:snapshot];
+  [_delegate snapshotGenerator:self
+      didUpdateSnapshotForWebState:_webState
+                         withImage:snapshot];
   return snapshot;
 }
 
@@ -338,14 +345,17 @@ BOOL ViewHierarchyContainsWKWebView(UIView* view) {
 
   // Do not generate a snapshot if the delegate says the WebState view is
   // not ready (this generally mean a placeholder is displayed).
-  if (_delegate && ![_delegate canTakeSnapshotForWebState:_webState])
+  if (_delegate && ![_delegate snapshotGenerator:self
+                       canTakeSnapshotForWebState:_webState])
     return CGRectZero;
 
-  UIView* view = [_delegate viewForWebState:_webState];
+  UIView* view = [_delegate snapshotGenerator:self
+                          baseViewForWebState:_webState];
   CGRect frame = [view bounds];
   UIEdgeInsets headerInsets = UIEdgeInsetsZero;
   if (visibleFrameOnly) {
-    headerInsets = [_delegate snapshotEdgeInsetsForWebState:_webState];
+    headerInsets = [_delegate snapshotGenerator:self
+                  snapshotEdgeInsetsForWebState:_webState];
   } else if (base::FeatureList::IsEnabled(
                  web::features::kBrowserContainerFullscreen)) {
     headerInsets = UIEdgeInsetsMake(StatusBarHeight(), 0, 0, 0);

ios/chrome/browser/snapshots/snapshot_generator_delegate.h

@@ -18,33 +18,39 @@ class WebState;
 @protocol SnapshotGeneratorDelegate
 
 // Returns whether it is possible to capture a snapshot for |webState|.
-- (BOOL)canTakeSnapshotForWebState:(web::WebState*)webState;
+- (BOOL)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+    canTakeSnapshotForWebState:(web::WebState*)webState;
 
 // Returns the edge insets to use to crop the snapshot for |webState| during
 // generation. If the snapshot should not be cropped, then UIEdgeInsetsZero
 // can be returned.  The returned insets should be in the coordinate system of
-// the view returned by |-viewForWebState:|.
-- (UIEdgeInsets)snapshotEdgeInsetsForWebState:(web::WebState*)webState;
+// the view returned by |-baseViewForWebState:|.
+- (UIEdgeInsets)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+    snapshotEdgeInsetsForWebState:(web::WebState*)webState;
 
 // Returns the list of SnapshotOverlays that should be rendered over the
 // page when generating the snapshot for |webState|. If no overlays should
 // be rendered, the list may be nil or empty.
-- (NSArray<SnapshotOverlay*>*)snapshotOverlaysForWebState:
-    (web::WebState*)webState;
+- (NSArray<SnapshotOverlay*>*)snapshotGenerator:
+                                  (SnapshotGenerator*)snapshotGenerator
+                    snapshotOverlaysForWebState:(web::WebState*)webState;
 
 // Invoked before capturing a snapshot for |webState|. The delegate can remove
 // subviews from the hierarchy or take other actions to ensure the snapshot
 // is correclty captured.
-- (void)willUpdateSnapshotForWebState:(web::WebState*)webState;
+- (void)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+    willUpdateSnapshotForWebState:(web::WebState*)webState;
 
 // Invoked after capturing a snapshot for |webState|. The delegate can insert
 // subviews that were removed during -willUpdateSnapshotForWebState: or take
 // other actions necessary after a snapshot has been captured.
-- (void)didUpdateSnapshotForWebState:(web::WebState*)webState
-                           withImage:(UIImage*)snapshot;
+- (void)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+    didUpdateSnapshotForWebState:(web::WebState*)webState
+                       withImage:(UIImage*)snapshot;
 
 // Returns the base view to be snapshotted.
-- (UIView*)viewForWebState:(web::WebState*)webState;
+- (UIView*)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+         baseViewForWebState:(web::WebState*)webState;
 
 @end
 

ios/chrome/browser/snapshots/snapshot_tab_helper_unittest.mm

@@ -49,11 +49,13 @@ using ui::test::uiimage_utils::UIImageWithSizeAndSolidColor;
 
 #pragma mark - SnapshotGeneratorDelegate
 
-- (BOOL)canTakeSnapshotForWebState:(web::WebState*)webState {
+- (BOOL)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+    canTakeSnapshotForWebState:(web::WebState*)webState {
   return !_canTakeSnapshot;
 }
 
-- (void)willUpdateSnapshotForWebState:(web::WebState*)webState {
+- (void)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+    willUpdateSnapshotForWebState:(web::WebState*)webState {
   ++_snapshotTakenCount;
 }
 

ios/chrome/browser/ui/browser_view_controller.mm

@@ -2939,7 +2939,8 @@ applicationCommandEndpoint:(id<ApplicationCommands>)applicationCommandEndpoint
 
 #pragma mark - SnapshotGeneratorDelegate methods
 
-- (BOOL)canTakeSnapshotForWebState:(web::WebState*)webState {
+- (BOOL)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+    canTakeSnapshotForWebState:(web::WebState*)webState {
   DCHECK(webState);
   PagePlaceholderTabHelper* pagePlaceholderTabHelper =
       PagePlaceholderTabHelper::FromWebState(webState);
@@ -2947,7 +2948,8 @@ applicationCommandEndpoint:(id<ApplicationCommands>)applicationCommandEndpoint
          !pagePlaceholderTabHelper->will_add_placeholder_for_next_navigation();
 }
 
-- (UIEdgeInsets)snapshotEdgeInsetsForWebState:(web::WebState*)webState {
+- (UIEdgeInsets)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+    snapshotEdgeInsetsForWebState:(web::WebState*)webState {
   DCHECK(webState);
   // The NTP's snapshot should be inset |headerHeight| from the top to remove
   // the fake NTP toolbar from the snapshot.
@@ -2974,8 +2976,9 @@ applicationCommandEndpoint:(id<ApplicationCommands>)applicationCommandEndpoint
   return insets;
 }
 
-- (NSArray<SnapshotOverlay*>*)snapshotOverlaysForWebState:
-    (web::WebState*)webState {
+- (NSArray<SnapshotOverlay*>*)snapshotGenerator:
+                                  (SnapshotGenerator*)snapshotGenerator
+                    snapshotOverlaysForWebState:(web::WebState*)webState {
   DCHECK(webState);
   Tab* tab = LegacyTabHelper::GetTabForWebState(webState);
   DCHECK([self.tabModel indexOfTab:tab] != NSNotFound);
@@ -3017,7 +3020,8 @@ applicationCommandEndpoint:(id<ApplicationCommands>)applicationCommandEndpoint
   return overlays;
 }
 
-- (void)willUpdateSnapshotForWebState:(web::WebState*)webState {
+- (void)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+    willUpdateSnapshotForWebState:(web::WebState*)webState {
   DCHECK(webState);
   Tab* tab = LegacyTabHelper::GetTabForWebState(webState);
   DCHECK([self.tabModel indexOfTab:tab] != NSNotFound);
@@ -3028,15 +3032,17 @@ applicationCommandEndpoint:(id<ApplicationCommands>)applicationCommandEndpoint
   [tab willUpdateSnapshot];
 }
 
-- (void)didUpdateSnapshotForWebState:(web::WebState*)webState
-                           withImage:(UIImage*)snapshot {
+- (void)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+    didUpdateSnapshotForWebState:(web::WebState*)webState
+                       withImage:(UIImage*)snapshot {
   DCHECK(webState);
   Tab* tab = LegacyTabHelper::GetTabForWebState(webState);
   DCHECK([self.tabModel indexOfTab:tab] != NSNotFound);
   [self.tabModel notifyTabSnapshotChanged:tab withImage:snapshot];
 }
 
-- (UIView*)viewForWebState:(web::WebState*)webState {
+- (UIView*)snapshotGenerator:(SnapshotGenerator*)snapshotGenerator
+         baseViewForWebState:(web::WebState*)webState {
   NewTabPageTabHelper* NTPHelper = NewTabPageTabHelper::FromWebState(webState);
   if (NTPHelper && NTPHelper->IsActive()) {
     return _ntpCoordinatorsForWebStates[webState].viewController.view;
@@ -4577,9 +4583,10 @@ applicationCommandEndpoint:(id<ApplicationCommands>)applicationCommandEndpoint
     // Add animations only if the tab strip isn't shown.
     UIView* snapshotView = [self.view snapshotViewAfterScreenUpdates:NO];
 
+    // TODO(crbug.com/904992): Do not repurpose SnapshotGeneratorDelegate.
     SwipeView* swipeView = [[SwipeView alloc]
         initWithFrame:self.contentArea.frame
-            topMargin:[self
+            topMargin:[self snapshotGenerator:nil
                           snapshotEdgeInsetsForWebState:webStateBeingActivated]
                           .top];
 

ios/chrome/browser/ui/side_swipe/side_swipe_controller.mm

@@ -506,9 +506,11 @@ const NSUInteger kIpadGreySwipeTabCount = 8;
     CGRect frame = [[swipeDelegate_ sideSwipeContentView] frame];
 
     // Add horizontal stack view controller.
+    // TODO(crbug.com/904992): Do not use SnapshotGeneratorDelegate from
+    // SideSwipeController.
     CGFloat headerHeight =
-        [self.snapshotDelegate
-            snapshotEdgeInsetsForWebState:currentTab.webState]
+        [self.snapshotDelegate snapshotGenerator:nil
+                   snapshotEdgeInsetsForWebState:currentTab.webState]
             .top;
 
     if (tabSideSwipeView_) {