Replaces HeaderDefinition struct with an object.

ios/chrome/browser/ui/browser_view_controller.mm

 // Copyright 2012 The Chromium 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 "ios/chrome/browser/ui/browser_view_controller.h"
 
 #import <AssetsLibrary/AssetsLibrary.h>
 #import <MobileCoreServices/MobileCoreServices.h>
 #import <PassKit/PassKit.h>
 #import <Photos/Photos.h>
 #import <QuartzCore/QuartzCore.h>
 
 #include <stdint.h>
 #include <cmath>
 #include <memory>
 
 #include "base/base64.h"
 #include "base/command_line.h"
 #include "base/files/file_path.h"
 #include "base/format_macros.h"
 #include "base/i18n/rtl.h"
 #include "base/ios/block_types.h"
 #include "base/ios/ios_util.h"
 #include "base/logging.h"
 #include "base/mac/bind_objc_block.h"
 #include "base/mac/bundle_locations.h"
 #include "base/mac/foundation_util.h"
-#import "base/mac/scoped_nsobject.h"
 #include "base/macros.h"
 #include "base/memory/ptr_util.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/metrics/user_metrics.h"
 #include "base/metrics/user_metrics_action.h"
 #include "base/strings/sys_string_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/threading/sequenced_worker_pool.h"
 #include "components/bookmarks/browser/base_bookmark_model_observer.h"
 #include "components/bookmarks/browser/bookmark_model.h"
@@ skipping 224 matching lines @@
 
 enum HeaderBehaviour {
   // The header moves completely out of the screen.
   Hideable = 0,
   // This header stays on screen and doesn't overlap with the content.
   Visible,
   // This header stay on screen and covers part of the content.
   Overlap
 };
 
-struct HeaderDefinition {
-  // The header view.
-  base::scoped_nsobject<UIView> view;
-  // How to place the view, and its behaviour when the headers move.
-  HeaderBehaviour behaviour;
-  // Reduces the height of a header to adjust for shadows.
-  CGFloat heightAdjustement;
-  // Nudges that particular header up by this number of points.
-  CGFloat inset;
-};
-
 const CGFloat kIPadFindBarOverlap = 11;
 
 bool IsURLAllowedInIncognito(const GURL& url) {
   // Most URLs are allowed in incognito; the following are exceptions.
   if (!url.SchemeIs(kChromeUIScheme))
     return true;
   std::string url_host = url.host();
   return url_host != kChromeUIHistoryHost &&
          url_host != kChromeUIHistoryFrameHost;
 }
 
 // Temporary key to use when storing native controllers vended to tabs before
 // they are added to the tab model.
 NSString* const kNativeControllerTemporaryKey = @"NativeControllerTemporaryKey";
 
 }  // namespace
 
+#pragma mark - HeaderDefinition helper
+
+@interface HeaderDefinition : NSObject
+
+// The header view.
+@property(nonatomic, strong) UIView* view;
+// How to place the view, and its behaviour when the headers move.
+@property(nonatomic, assign) HeaderBehaviour behaviour;
+// Reduces the height of a header to adjust for shadows.
+@property(nonatomic, assign) CGFloat heightAdjustement;
+// Nudges that particular header up by this number of points.
+@property(nonatomic, assign) CGFloat inset;
+
+- (instancetype)initWithView:(UIView*)view
+             headerBehaviour:(HeaderBehaviour)behaviour
+            heightAdjustment:(CGFloat)heightAdjustment
+                       inset:(CGFloat)inset;
+
++ (instancetype)definitionWithView:(UIView*)view
+                   headerBehaviour:(HeaderBehaviour)behaviour
+                  heightAdjustment:(CGFloat)heightAdjustment
+                             inset:(CGFloat)inset;
+
+@end
+
+@implementation HeaderDefinition
+@synthesize view = _view;
+@synthesize behaviour = _behaviour;
+@synthesize heightAdjustement = _heightAdjustement;
+@synthesize inset = _inset;
+
++ (instancetype)definitionWithView:(UIView*)view
+                   headerBehaviour:(HeaderBehaviour)behaviour
+                  heightAdjustment:(CGFloat)heightAdjustment
+                             inset:(CGFloat)inset {
+  return [[self alloc] initWithView:view
+                    headerBehaviour:behaviour
+                   heightAdjustment:heightAdjustment
+                              inset:inset];
+}
+
+- (instancetype)initWithView:(UIView*)view
+             headerBehaviour:(HeaderBehaviour)behaviour
+            heightAdjustment:(CGFloat)heightAdjustment
+                       inset:(CGFloat)inset {
+  self = [super init];
+  if (self) {
+    _view = view;
+    _behaviour = behaviour;
+    _heightAdjustement = heightAdjustment;
+    _inset = inset;
+  }
+  return self;
+}
+
+@end
+
+#pragma mark - BVC
+
 @interface BrowserViewController ()<AppRatingPromptDelegate,
                                     ContextualSearchControllerDelegate,
                                     ContextualSearchPanelMotionObserver,
                                     CRWNativeContentProvider,
                                     CRWWebStateDelegate,
                                     DialogPresenterDelegate,
                                     FullScreenControllerDelegate,
                                     KeyCommandsPlumbing,
                                     MFMailComposeViewControllerDelegate,
                                     NewTabPageControllerObserver,
@@ skipping 214 matching lines @@
 @property(nonatomic, readonly) BOOL shouldShowVoiceSearchBar;
 // Coordinator for displaying a modal overlay with activity indicator to prevent
 // the user from interacting with the browser view.
 @property(nonatomic, strong)
     ActivityOverlayCoordinator* activityOverlayCoordinator;
 
 // The user agent type used to load the currently visible page. User agent type
 // is NONE if there is no visible page or visible page is a native page.
 @property(nonatomic, assign, readonly) web::UserAgentType userAgentType;
 
+// Returns the header views, all the chrome on top of the page, including the
+// ones that cannot be scrolled off screen by full screen.
+@property(nonatomic, strong, readonly) NSArray<HeaderDefinition*>* headerViews;
+
 // BVC initialization:
 // If the BVC is initialized with a valid browser state & tab model immediately,
 // the path is straightforward: functionality is enabled, and the UI is built
 // when -viewDidLoad is called.
 // If the BVC is initialized without a browser state or tab model, the tab model
 // and browser state may or may not be provided before -viewDidLoad is called.
 // In most cases, they will not, to improve startup performance.
 // In order to handle this, initialization of various aspects of BVC have been
 // broken out into the following functions, which have expectations (enforced
 // with DCHECKs) regarding |_browserState|, |_model|, and [self isViewLoaded].
@@ skipping 181 matching lines @@
 - (CGFloat)voiceSearchOverlayYOffsetForTab:(Tab*)tab;
 // Lazily instantiates |_voiceSearchController|.
 - (void)ensureVoiceSearchControllerCreated;
 // Lazily instantiates |_voiceSearchBar| and adds it to the view.
 - (void)ensureVoiceSearchBarCreated;
 // Shows/hides the voice search bar.
 - (void)updateVoiceSearchBarVisibilityAnimated:(BOOL)animated;
 // The LogoAnimationControllerOwner to be used for the next logo transition
 // animation.
 - (id<LogoAnimationControllerOwner>)currentLogoAnimationControllerOwner;
-// Returns the header views, all the chrome on top of the page, including the
-// ones that cannot be scrolled off screen by full screen.
-- (const std::vector<HeaderDefinition>)headerViews;
 // Returns the footer view if one exists (e.g. the voice search bar).
 - (UIView*)footerView;
 // Returns the height of the header view for the tab model's current tab.
 - (CGFloat)headerHeight;
 // Sets the frame for the headers.
-- (void)setFramesForHeaders:(const std::vector<HeaderDefinition>)headers
+- (void)setFramesForHeaders:(NSArray<HeaderDefinition*>*)headers
                    atOffset:(CGFloat)headerOffset;
 // Returns the y coordinate for the footer's frame when animating the footer
 // in/out of fullscreen.
 - (CGFloat)footerYForHeaderOffset:(CGFloat)headerOffset;
 // Called when the animation for setting the header view's offset is finished.
 // |completed| should indicate if the animation finished completely or was
 // interrupted. |offset| should indicate the header offset after the animation.
 // |dragged| should indicate if the header moved due to the user dragging.
 - (void)fullScreenController:(FullScreenController*)controller
     headerAnimationCompleted:(BOOL)completed
@@ skipping 1885 matching lines @@
 }
 
 #pragma mark - FullScreenControllerDelegate methods
 
 - (CGFloat)headerOffset {
   if (IsIPadIdiom())
     return StatusBarHeight();
   return 0.0;
 }
 
-- (const std::vector<HeaderDefinition>)headerViews {
-  std::vector<HeaderDefinition> results;
+- (NSArray<HeaderDefinition*>*)headerViews {
+  NSMutableArray<HeaderDefinition*>* results = [[NSMutableArray alloc] init];
   if (![self isViewLoaded])
     return results;
 
   if (!IsIPadIdiom()) {
     if ([_toolbarController view]) {
-      HeaderDefinition header = {
-          base::scoped_nsobject<UIView>([_toolbarController view]), Hideable,
-          [ToolbarController toolbarDropShadowHeight], 0.0,
-      };
-      results.push_back(header);
+      [results addObject:[HeaderDefinition
+                             definitionWithView:[_toolbarController view]
+                                headerBehaviour:Hideable
+                               heightAdjustment:[ToolbarController
+                                                    toolbarDropShadowHeight]
+                                          inset:0.0]];
     }
   } else {
     if ([_tabStripController view]) {
-      HeaderDefinition header = {
-          base::scoped_nsobject<UIView>([_tabStripController view]), Hideable,
-          0.0, 0.0,
-      };
-      results.push_back(header);
+      [results addObject:[HeaderDefinition
+                             definitionWithView:[_tabStripController view]
+                                headerBehaviour:Hideable
+                               heightAdjustment:0.0
+                                          inset:0.0]];
     }
     if ([_toolbarController view]) {
-      HeaderDefinition header = {
-          base::scoped_nsobject<UIView>([_toolbarController view]), Hideable,
-          [ToolbarController toolbarDropShadowHeight], 0.0,
-      };
-      results.push_back(header);
+      [results addObject:[HeaderDefinition
+                             definitionWithView:[_toolbarController view]
+                                headerBehaviour:Hideable
+                               heightAdjustment:[ToolbarController
+                                                    toolbarDropShadowHeight]
+                                          inset:0.0]];
     }
     if ([_findBarController view]) {
-      HeaderDefinition header = {
-          base::scoped_nsobject<UIView>([_findBarController view]), Overlap,
-          0.0, kIPadFindBarOverlap,
-      };
-      results.push_back(header);
+      [results addObject:[HeaderDefinition
+                             definitionWithView:[_findBarController view]
+                                headerBehaviour:Overlap
+                               heightAdjustment:0.0
+                                          inset:kIPadFindBarOverlap]];
     }
   }
-  return results;
+  return [results copy];
 }
 
 - (UIView*)footerView {
   return _voiceSearchBar;
 }
 
 - (CGFloat)headerHeight {
   return [self headerHeightForTab:[_model currentTab]];
 }
 
 - (CGFloat)headerHeightForTab:(Tab*)tab {
   id nativeController = [self nativeControllerForTab:tab];
   if ([nativeController conformsToProtocol:@protocol(ToolbarOwner)] &&
       [nativeController respondsToSelector:@selector(toolbarHeight)] &&
       [nativeController toolbarHeight] > 0.0 && !IsIPadIdiom()) {
     // On iPhone, don't add any header height for ToolbarOwner native
     // controllers when they're displaying their own toolbar.
     return 0;
   }
 
-  const std::vector<HeaderDefinition> views = [self headerViews];
+  NSArray<HeaderDefinition*>* views = [self headerViews];
 
   CGFloat height = [self headerOffset];
-  for (const auto& header : views) {
+  for (HeaderDefinition* header in views) {
     if (header.view && header.behaviour == Hideable) {
       height += CGRectGetHeight([header.view frame]) -
                 header.heightAdjustement - header.inset;
     }
   }
 
   return height - StatusBarHeight();
 }
 
 - (BOOL)isTabWithIDCurrent:(NSString*)sessionID {
   return self.visible && [sessionID isEqualToString:[_model currentTab].tabId];
 }
 
 - (CGFloat)currentHeaderOffset {
-  const std::vector<HeaderDefinition> headers = [self headerViews];
-  if (!headers.size())
+  NSArray<HeaderDefinition*>* headers = [self headerViews];
+  if (!headers.count)
     return 0.0;
 
   // Prerender tab does not have a toolbar, return |headerHeight| as promised by
   // API documentation.
   if ([[[self tabModel] currentTab] isPrerenderTab])
     return [self headerHeight];
 
   UIView* topHeader = headers[0].view;
   return -(topHeader.frame.origin.y - [self headerOffset]);
 }
 
 - (CGFloat)footerYForHeaderOffset:(CGFloat)headerOffset {
   UIView* footer = [self footerView];
   CGFloat headerHeight = [self headerHeight];
   if (!footer || headerHeight == 0)
     return 0.0;
 
   CGFloat footerHeight = CGRectGetHeight(footer.frame);
   CGFloat offset = headerOffset * footerHeight / headerHeight;
   return std::ceil(CGRectGetHeight(self.view.bounds) - footerHeight + offset);
 }
 
 - (void)fullScreenController:(FullScreenController*)controller
     headerAnimationCompleted:(BOOL)completed
                       offset:(CGFloat)offset {
   if (completed)
     [controller setToolbarInsetsForHeaderOffset:offset];
 }
 
-- (void)setFramesForHeaders:(const std::vector<HeaderDefinition>)headers
+- (void)setFramesForHeaders:(NSArray<HeaderDefinition*>*)headers
                    atOffset:(CGFloat)headerOffset {
   CGFloat height = [self headerOffset];
-  for (const auto& header : headers) {
+  for (HeaderDefinition* header in headers) {
     CGRect frame = [header.view frame];
     frame.origin.y = height - headerOffset - header.inset;
     [header.view setFrame:frame];
     if (header.behaviour != Overlap)
       height += CGRectGetHeight(frame);
   }
 }
 
 - (void)fullScreenController:(FullScreenController*)fullScreenController
     drawHeaderViewFromOffset:(CGFloat)headerOffset
                      animate:(BOOL)animate {
   if ([_sideSwipeController inSwipe])
     return;
 
   CGRect footerFrame = CGRectZero;
   UIView* footer = nil;
   // Only animate the voice search bar if the tab is a voice search results tab.
   if ([_model currentTab].isVoiceSearchResultsTab) {
     footer = [self footerView];
     footerFrame = footer.frame;
     footerFrame.origin.y = [self footerYForHeaderOffset:headerOffset];
   }
 
-  const std::vector<HeaderDefinition> headers = [self headerViews];
+  NSArray<HeaderDefinition*>* headers = [self headerViews];
   void (^block)(void) = ^{
     [self setFramesForHeaders:headers atOffset:headerOffset];
     footer.frame = footerFrame;
   };
   void (^completion)(BOOL) = ^(BOOL finished) {
     [self fullScreenController:fullScreenController
         headerAnimationCompleted:finished
                           offset:headerOffset];
   };
   if (animate) {
@@ skipping 19 matching lines @@
 
   CGRect footerFrame;
   UIView* footer = nil;
   // Only animate the voice search bar if the tab is a voice search results tab.
   if ([_model currentTab].isVoiceSearchResultsTab) {
     footer = [self footerView];
     footerFrame = footer.frame;
     footerFrame.origin.y = [self footerYForHeaderOffset:headerOffset];
   }
 
-  const std::vector<HeaderDefinition> headers = [self headerViews];
+  NSArray<HeaderDefinition*>* headers = [self headerViews];
   void (^block)(void) = ^{
     [self setFramesForHeaders:headers atOffset:headerOffset];
     footer.frame = footerFrame;
     webViewProxy.scrollViewProxy.contentOffset = CGPointMake(
         webViewProxy.scrollViewProxy.contentOffset.x, contentOffset);
     if (changeTopContentPadding)
       webViewProxy.topContentPadding = contentOffset;
   };
   void (^completion)(BOOL) = ^(BOOL finished) {
     [self fullScreenController:fullScreenController
@@ skipping 2291 matching lines @@
 
 - (UIView*)voiceSearchButton {
   return _voiceSearchButton;
 }
 
 - (id<LogoAnimationControllerOwner>)logoAnimationControllerOwner {
   return [self currentLogoAnimationControllerOwner];
 }
 
 @end