Alternate NTP: Don't hide bookmark bar on instant

chrome/browser/ui/cocoa/browser_window_controller_private.mm

 // Copyright (c) 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 "chrome/browser/ui/cocoa/browser_window_controller_private.h"
 
 #include <cmath>
 
 #include "base/command_line.h"
 #import "base/memory/scoped_nsobject.h"
@@ skipping 14 matching lines @@
 #import "chrome/browser/ui/cocoa/fullscreen_window.h"
 #import "chrome/browser/ui/cocoa/infobars/infobar_container_controller.h"
 #import "chrome/browser/ui/cocoa/nsview_additions.h"
 #import "chrome/browser/ui/cocoa/presentation_mode_controller.h"
 #import "chrome/browser/ui/cocoa/status_bubble_mac.h"
 #import "chrome/browser/ui/cocoa/tab_contents/previewable_contents_controller.h"
 #import "chrome/browser/ui/cocoa/tabs/tab_strip_controller.h"
 #import "chrome/browser/ui/cocoa/tabs/tab_strip_view.h"
 #import "chrome/browser/ui/cocoa/toolbar/toolbar_controller.h"
 #include "chrome/browser/ui/fullscreen/fullscreen_controller.h"
+#include "chrome/browser/ui/search/search_model.h"
 #include "chrome/browser/ui/search/search_ui.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/pref_names.h"
 #include "content/public/browser/render_widget_host_view.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/browser/web_contents_view.h"
 #import "ui/base/cocoa/focus_tracker.h"
 #include "ui/base/ui_base_types.h"
 
 using content::RenderWidgetHostView;
@@ skipping 124 matching lines @@
   NSView* contentView = [window contentView];
   NSRect contentBounds = [contentView bounds];
   CGFloat minX = NSMinX(contentBounds);
   CGFloat minY = NSMinY(contentBounds);
   CGFloat width = NSWidth(contentBounds);
 
   // Suppress title drawing if necessary.
   if ([window respondsToSelector:@selector(setShouldHideTitle:)])
     [(id)window setShouldHideTitle:![self hasTitleBar]];
 
+  // Update z-order. The code below depends on this.
+  [self updateSubviewZOrder];
+
   BOOL inPresentationMode = [self inPresentationMode];
   CGFloat floatingBarHeight = [self floatingBarHeight];
   // In presentation mode, |yOffset| accounts for the sliding position of the
   // floating bar and the extra offset needed to dodge the menu bar.
   CGFloat yOffset = inPresentationMode ?
       (std::floor((1 - floatingBarShownFraction_) * floatingBarHeight) -
           [presentationModeController_ floatingBarVerticalOffset]) : 0;
   CGFloat maxY = NSMaxY(contentBounds) + yOffset;
 
   if ([self hasTabStrip]) {
     // If we need to lay out the top tab strip, replace |maxY| with a higher
     // value, and then lay out the tab strip.
     NSRect windowFrame = [contentView convertRect:[window frame] fromView:nil];
     maxY = NSHeight(windowFrame) + yOffset;
     maxY = [self layoutTabStripAtMaxY:maxY
                                 width:width
                            fullscreen:[self isFullscreen]];
   }
 
   // Sanity-check |maxY|.
   DCHECK_GE(maxY, minY);
   DCHECK_LE(maxY, NSMaxY(contentBounds) + yOffset);
 
   // Place the toolbar at the top of the reserved area.
   maxY = [self layoutToolbarAtMinX:minX maxY:maxY width:width];
+  CGFloat toolbarBottomY = maxY;
 
   // If we're not displaying the bookmark bar below the infobar, then it goes
   // immediately below the toolbar.
   BOOL placeBookmarkBarBelowInfoBar = [self placeBookmarkBarBelowInfoBar];
   if (!placeBookmarkBarBelowInfoBar)
     maxY = [self layoutTopBookmarkBarAtMinX:minX maxY:maxY width:width];
 
   // The floating bar backing view doesn't actually add any height.
   NSRect floatingBarBackingRect =
       NSMakeRect(minX, maxY, width, floatingBarHeight);
@@ skipping 21 matching lines @@
   // Place the bookmark bar.
   if (placeBookmarkBarBelowInfoBar) {
     if ([bookmarkBarController_ shouldShowAtBottomWhenDetached]) {
       [self layoutBottomBookmarkBarInContentFrame:
           NSMakeRect(minX, minY, width, maxY - minY)];
     } else {
       maxY = [self layoutTopBookmarkBarAtMinX:minX maxY:maxY width:width];
     }
   }
 
-  // Finally, the content area takes up all of the remaining space.
-  NSRect contentAreaRect = NSMakeRect(minX, minY, width, maxY - minY);
+  // In presentation mode the content area takes up all the remaining space
+  // (from the bottom of the infobar down). In normal mode the content area
+  // takes up the space between the bottom of the toolbar down.
+  CGFloat contentAreaTop = 0;
+  if (inPresentationMode) {
+    toolbarToWebContentsOffset_ = 0;
+    contentAreaTop = maxY;
+  } else {
+    toolbarToWebContentsOffset_ = toolbarBottomY - maxY;
+    contentAreaTop = toolbarBottomY;
+  }
+  [self updateContentOffsets];
+
+  NSRect contentAreaRect = NSMakeRect(minX, minY, width, contentAreaTop - minY);
   [self layoutTabContentArea:contentAreaRect];
 
   // Normally, we don't need to tell the toolbar whether or not to show the
   // divider, but things break down during animation.
-  [toolbarController_
-      setDividerOpacity:[bookmarkBarController_ toolbarDividerOpacity]];
+  [toolbarController_ setDividerOpacity:[self toolbarDividerOpacity]];
 }
 
 - (CGFloat)floatingBarHeight {
   if (![self inPresentationMode])
     return 0;
 
   CGFloat totalHeight = [presentationModeController_ floatingBarVerticalOffset];
 
   if ([self hasTabStrip])
     totalHeight += NSHeight([[self tabStripView] frame]);
@@ skipping 155 matching lines @@
 }
 
 - (void)layoutFloatingBarBackingView:(NSRect)frame
                     presentationMode:(BOOL)presentationMode {
   // Only display when in presentation mode.
   if (presentationMode) {
     // For certain window types such as app windows (e.g., the dev tools
     // window), there's no actual overlay. (Displaying one would result in an
     // overly sliding in only under the menu, which gives an ugly effect.)
     if (floatingBarBackingView_.get()) {
-      BOOL aboveBookmarkBar = [self placeBookmarkBarBelowInfoBar];
-
-      // Insert it into the view hierarchy if necessary.
-      if (![floatingBarBackingView_ superview] ||
-          aboveBookmarkBar != floatingBarAboveBookmarkBar_) {
-        NSView* contentView = [[self window] contentView];
-        // z-order gets messed up unless we explicitly remove the floatingbar
-        // view and re-add it.
-        [floatingBarBackingView_ removeFromSuperview];
-        [contentView addSubview:floatingBarBackingView_
-                     positioned:(aboveBookmarkBar ?
-                                     NSWindowAbove : NSWindowBelow)
-                     relativeTo:[bookmarkBarController_ view]];
-        floatingBarAboveBookmarkBar_ = aboveBookmarkBar;
-      }
-
       // Set its frame.
       [floatingBarBackingView_ setFrame:frame];
     }
 
     // But we want the logic to work as usual (for show/hide/etc. purposes).
     [presentationModeController_ overlayFrameChanged:frame];
   } else {
     // Okay to call even if |floatingBarBackingView_| is nil.
     if ([floatingBarBackingView_ superview])
       [floatingBarBackingView_ removeFromSuperview];
@@ skipping 267 matching lines @@
 - (void)adjustUIForPresentationMode:(BOOL)fullscreen {
   // Create the floating bar backing view if necessary.
   if (fullscreen && !floatingBarBackingView_.get() &&
       ([self hasTabStrip] || [self hasToolbar] || [self hasLocationBar])) {
     floatingBarBackingView_.reset(
         [[FloatingBarBackingView alloc] initWithFrame:NSZeroRect]);
     [floatingBarBackingView_ setAutoresizingMask:(NSViewWidthSizable |
                                                   NSViewMinYMargin)];
   }
 
-  // Adjust the infobar container. In fullscreen, it needs to be below all
-  // top chrome elements so it only sits atop the web contents. When in normal
-  // mode, it needs to draw over the bookmark bar and part of the toolbar.
-  [[infoBarContainerController_ view] removeFromSuperview];
-  NSView* infoBarDest = [[self window] contentView];
-  [infoBarDest addSubview:[infoBarContainerController_ view]
-               positioned:fullscreen ? NSWindowBelow : NSWindowAbove
-               relativeTo:fullscreen ? nil
-                                     : [toolbarController_ view]];
+  // Force the bookmark bar zorder to update.
+  [[bookmarkBarController_ view] removeFromSuperview];
+  [self updateSubviewZOrder];
 }
 
 - (void)showFullscreenExitBubbleIfNecessary {
   // This method is called in response to
   // |-updateFullscreenExitBubbleURL:bubbleType:|. If on Lion the system is
   // transitioning, do not show the bubble because it will cause visual jank
   // <http://crbug.com/130649>. This will be called again as part of
   // |-windowDidEnterFullScreen:|, so arrange to do that work then instead.
   if (enteringFullscreen_)
     return;
@@ skipping 116 matching lines @@
 
 - (void)disableBarVisibilityUpdates {
   // Early escape if there's nothing to do.
   if (!barVisibilityUpdatesEnabled_)
     return;
 
   barVisibilityUpdatesEnabled_ = NO;
   [presentationModeController_ cancelAnimationAndTimers];
 }
 
+- (CGFloat)toolbarDividerOpacity {
+  if ([self isShowingInstantResults])
+    return 1;
+  return [bookmarkBarController_ toolbarDividerOpacity];
+}
+
+- (BOOL)isShowingInstantResults {
+  if (!browser_->search_model()->mode().is_search_suggestions())
+    return NO;
+
+  // If the search suggestions are already being displayed in the preview
+  // contents then return YES.
+  if ([previewableContentsController_ isShowingPreview])
+    return YES;
+
+  // Search suggestions might be shown directly in the web contents in some
+  // cases.
+  return browser_->search_model()->mode().origin ==
+      chrome::search::Mode::ORIGIN_SEARCH;
+}
+
+- (void)updateContentOffsets {
+  // Normally the preview contents is used to show instant results which must
+  // obscure the bookmark bar. This is achived by setting the offset to 0

[kuan, 2013/01/17 18:25:51]

nit: s/achived/achieved/

[sail, 2013/01/17 18:54:55]

Done.

+  // so that it overlaps the bookmark bar. The only exception is when the
+  // preview contents is showing the NTP which must sit below the bookmark bar.
+  CGFloat previewOffset = 0;
+  if (browser_->search_model()->mode().is_ntp())
+    previewOffset = toolbarToWebContentsOffset_;
+  [previewableContentsController_ setPreviewOffset:previewOffset];
+
+  // Normally the tab contents sits below the bookmark bar. This is achived by

[kuan, 2013/01/17 18:25:51]

nit: s/sits/sit/, s/achived/achieved/

[sail, 2013/01/17 18:54:55]

Done.

+  // setting the offset to the height of the bookmark bar. The only exception
+  // is on the search results page where the instant results are shown inside
+  // the page and not in the preview contents are usual.

[kuan, 2013/01/17 18:25:51]

nit: s/are/as/

[sail, 2013/01/17 18:54:55]

Done.

+  CGFloat tabContentsOffset = toolbarToWebContentsOffset_;
+  if (browser_->search_model()->mode().is_search_suggestions() &&
+      browser_->search_model()->mode().origin ==
+          chrome::search::Mode::ORIGIN_SEARCH) {
+    tabContentsOffset = 0;
+  }
+  [previewableContentsController_ setActiveContainerOffset:tabContentsOffset];
+
+  // Prevent the fast resize view from drawing white over the bookmark bar.
+  [[self tabContentArea] setContentOffset:toolbarToWebContentsOffset_];
+}
+
+- (void)updateSubviewZOrder {
+  NSView* contentView = [[self window] contentView];
+  NSView* toolbarView = [toolbarController_ view];
+
+  if ([self inPresentationMode]) {
+    // Toolbar is above tab contents so that it can slide down from top of
+    // screen.
+    [contentView cr_ensureSubview:toolbarView
+                     isPositioned:NSWindowAbove
+                       relativeTo:[self tabContentArea]];
+  } else {
+    // Toolbar is below tab contents so that the infobar arrow can appear above
+    // it.  Unlike other views the toolbar never

[dhollowa, 2013/01/17 17:47:58]

nit: looks like comment got cut off before finishing.

[sail, 2013/01/17 18:17:12]

Done.

+    [contentView cr_ensureSubview:toolbarView
+                     isPositioned:NSWindowBelow
+                       relativeTo:[self tabContentArea]];
+  }
+
+  // The bookmark bar is always below the toolbar. In normal mode this means
+  // that it is below tab contents. This allows instant results to be above
+  // the bookmark bar.
+  [contentView cr_ensureSubview:[bookmarkBarController_ view]
+                   isPositioned:NSWindowBelow
+                     relativeTo:toolbarView];
+
+  if ([self inPresentationMode]) {
+    // In presentation mode the infobar is below all other views.
+    [contentView cr_ensureSubview:[infoBarContainerController_ view]
+                     isPositioned:NSWindowBelow
+                       relativeTo:[self tabContentArea]];
+  } else {
+    // Above the toolbar but still below tab contents. Similar to the bookmark
+    // bar, this allows instnat results to be above the info bar.

[kuan, 2013/01/17 18:25:51]

nit: s/instnat/instant/

[sail, 2013/01/17 18:54:55]

Done.

+    [contentView cr_ensureSubview:[infoBarContainerController_ view]
+                     isPositioned:NSWindowAbove
+                       relativeTo:toolbarView];
+  }
+
+  // The find bar is above everything except instant search results.
+  if (findBarCocoaController_) {
+    NSView* relativeView = nil;
+    if ([self inPresentationMode])
+      relativeView =  toolbarView;
+    else if ([self isShowingInstantResults])
+      relativeView = [infoBarContainerController_ view];
+    else
+      relativeView = [self tabContentArea];
+    [contentView cr_ensureSubview:[findBarCocoaController_ view]
+                     isPositioned:NSWindowAbove
+                       relativeTo:relativeView];
+  }
+
+  if (floatingBarBackingView_) {
+    if ([self placeBookmarkBarBelowInfoBar]) {
+      [contentView cr_ensureSubview:floatingBarBackingView_
+                       isPositioned:NSWindowAbove
+                         relativeTo:[bookmarkBarController_ view]];
+    } else {
+      [contentView cr_ensureSubview:floatingBarBackingView_
+                       isPositioned:NSWindowBelow
+                         relativeTo:[bookmarkBarController_ view]];
+    }
+  }
+}
+
 @end  // @implementation BrowserWindowController(Private)