Mac: Animate the bookmark bar showing/hiding.

chrome/browser/cocoa/browser_window_controller.mm

 // Copyright (c) 2009 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.
 
 #include <Carbon/Carbon.h>
 
 #include "app/l10n_util_mac.h"
 #include "base/mac_util.h"
 #include "base/scoped_nsdisable_screen_updates.h"
 #import "base/scoped_nsobject.h"
@@ skipping 24 matching lines @@
 #import "chrome/browser/cocoa/fullscreen_window.h"
 #import "chrome/browser/cocoa/infobar_container_controller.h"
 #import "chrome/browser/cocoa/status_bubble_mac.h"
 #import "chrome/browser/cocoa/tab_strip_model_observer_bridge.h"
 #import "chrome/browser/cocoa/tab_strip_view.h"
 #import "chrome/browser/cocoa/tab_strip_controller.h"
 #import "chrome/browser/cocoa/tab_view.h"
 #import "chrome/browser/cocoa/toolbar_controller.h"
 #import "chrome/browser/browser_theme_provider.h"
 #include "chrome/browser/sync/sync_status_ui_helper.h"
+#include "chrome/common/pref_names.h"
 #include "chrome/common/pref_service.h"
 #import "chrome/browser/cocoa/background_gradient_view.h"
 #include "grit/generated_resources.h"
 #include "grit/theme_resources.h"
 #import "third_party/GTM/AppKit/GTMTheme.h"
 
 @interface GTMTheme (BrowserThemeProviderInitialization)
 + (GTMTheme*)themeWithBrowserThemeProvider:(BrowserThemeProvider*)provider
                             isOffTheRecord:(BOOL)offTheRecord;
 @end
@@ skipping 22 matching lines @@
 - (NSRect)window:(NSWindow*)window
 willPositionSheet:(NSWindow*)sheet
        usingRect:(NSRect)defaultSheetRect;
 
 // Assign a theme to the window.
 - (void)setTheme;
 
 // Repositions the windows subviews.
 - (void)layoutSubviews;
 
+// Should we show the normal bookmark bar?
+- (BOOL)shouldShowBookmarkBar;
+
+// Is the current page one for which the bookmark should be shown detached *if*
+// the normal bookmark bar is not shown?
+- (BOOL)shouldShowDetachedBookmarkBar;
+
 @end
 
 
 @implementation BrowserWindowController
 
 // Load the browser window nib and do any Cocoa-specific initialization.
 // Takes ownership of |browser|. Note that the nib also sets this controller
 // up as the window's delegate.
 - (id)initWithBrowser:(Browser*)browser {
   return [self initWithBrowser:browser takeOwnership:YES];
@@ skipping 72 matching lines @@
         browser_->SupportsWindowFeature(Browser::FEATURE_TITLEBAR)) {
       [toolbarController_ setHasToolbar:NO];
     }
     [[[self window] contentView] addSubview:[toolbarController_ view]];
 
     // Create a sub-controller for the bookmark bar.
     bookmarkBarController_.reset(
         [[BookmarkBarController alloc]
             initWithBrowser:browser_.get()
                initialWidth:NSWidth([[[self window] contentView] frame])
-           compressDelegate:toolbarController_.get()
+                   delegate:self
              resizeDelegate:self]);
 
     // Add bookmark bar to the view hierarchy.  This also triggers the
     // nib load.  The bookmark bar is defined (in the nib) to be
     // bottom-aligned to it's parent view (among other things), so
     // position and resize properties don't need to be set.
     [[[self window] contentView] addSubview:[bookmarkBarController_ view]
                                  positioned:NSWindowBelow
                                  relativeTo:[toolbarController_ view]];
 
     // Disable the bookmark bar if this window doesn't support them.
     if (!browser_->SupportsWindowFeature(Browser::FEATURE_BOOKMARKBAR)) {
       [bookmarkBarController_ setBookmarkBarEnabled:NO];
     }
 
-    // We don't want to try and show the bar before it gets placed in
-    // it's parent view, so this step shoudn't be inside the bookmark
-    // bar controller's awakeFromNib.
-    [bookmarkBarController_ showIfNeeded];
+    // We don't want to try and show the bar before it gets placed in its parent
+    // view, so this step shoudn't be inside the bookmark bar controller's
+    // |-awakeFromNib|.
+    [self updateBookmarkBarVisibilityWithAnimation:NO];
 
     if (browser_->SupportsWindowFeature(Browser::FEATURE_EXTENSIONSHELF)) {
       // Create the extension shelf.
       extensionShelfController_.reset([[ExtensionShelfController alloc]
                                         initWithBrowser:browser_.get()
                                          resizeDelegate:self]);
       [[[self window] contentView] addSubview:[extensionShelfController_ view]];
       [extensionShelfController_ wasInsertedIntoWindow];
     }
 
@@ skipping 258 matching lines @@
   // We should only ever be called for one of the following four views.
   // |downloadShelfController_| may be nil. If we are asked to size the bookmark
   // bar directly, its superview must be this controller's content view.
   DCHECK(view);
   DCHECK(view == [toolbarController_ view] ||
          view == [infoBarContainerController_ view] ||
          view == [extensionShelfController_ view] ||
          view == [downloadShelfController_ view] ||
          view == [bookmarkBarController_ view]);
 
-  // Change the height of the view and call layoutViews.  We set the height here
-  // without regard to where the view is on the screen or whether it needs to
-  // "grow up" or "grow down."  The below call to layoutSubviews will position
-  // each view correctly.
+  // Change the height of the view and call |-layoutSubViews|. We set the height
+  // here without regard to where the view is on the screen or whether it needs
+  // to "grow up" or "grow down."  The below call to |-layoutSubviews| will
+  // position each view correctly.
   NSRect frame = [view frame];
   if (frame.size.height == height)
     return;
 
   frame.size.height = height;
   // TODO(rohitrao): Determine if calling setFrame: twice is bad.
   [view setFrame:frame];
   [self layoutSubviews];
 }
 
@@ skipping 436 matching lines @@
 }
 
 - (void)showNewTabButton:(BOOL)show {
   [tabStripController_ showNewTabButton:show];
 }
 
 - (BOOL)isBookmarkBarVisible {
   return [bookmarkBarController_ isVisible];
 }
 
-- (void)updateBookmarkBarVisibility {
-  [bookmarkBarController_ updateVisibility];
+- (void)updateBookmarkBarVisibilityWithAnimation:(BOOL)animate {
+  [bookmarkBarController_
+      updateAndShowNormalBar:[self shouldShowBookmarkBar]
+             showDetachedBar:[self shouldShowDetachedBookmarkBar]
+               withAnimation:animate];
 }
 
 - (BOOL)isDownloadShelfVisible {
   return downloadShelfController_ != nil &&
       [downloadShelfController_ isVisible];
 }
 
 - (DownloadShelfController*)downloadShelf {
   if (!downloadShelfController_.get()) {
     downloadShelfController_.reset([[DownloadShelfController alloc]
@@ skipping 126 matching lines @@
 
   // Update all the UI bits.
   windowShim_->UpdateTitleBar();
 
 #if 0
 // TODO(pinkerton):Update as more things become window-specific
   toolbar_->SetProfile(newContents->profile());
   UpdateToolbar(newContents, true);
   UpdateUIForContents(newContents);
 #endif
+
+  // Update the bookmark bar.
+  [self updateBookmarkBarVisibilityWithAnimation:NO];
 }
 
 - (void)tabChangedWithContents:(TabContents*)contents
                        atIndex:(NSInteger)index
                    loadingOnly:(BOOL)loading {
   if (index == browser_->tabstrip_model()->selected_index()) {
     // Update titles if this is the currently selected tab.
     windowShim_->UpdateTitleBar();
   }
+
+  // Update the bookmark bar.
+  [self updateBookmarkBarVisibilityWithAnimation:NO];
 }
 
 - (void)userChangedTheme {
   [self setTheme];
   NSNotificationCenter* defaultCenter = [NSNotificationCenter defaultCenter];
   [defaultCenter postNotificationName:kGTMThemeDidChangeNotification
                                object:theme_];
   // TODO(dmaclach): Instead of redrawing the whole window, views that care
   // about the active window state should be registering for notifications.
   [[self window] setViewsNeedDisplay:YES];
@@ skipping 88 matching lines @@
 
 // Delegate method called when window is resized.
 - (void)windowDidResize:(NSNotification*)notification {
   // Resize (and possibly move) the status bubble. Note that we may get called
   // when the status bubble does not exist.
   if (statusBubble_) {
     statusBubble_->UpdateSizeAndPosition();
   }
 }
 
+// (Needed for |BookmarkBarControllerDelegate| protocol.)
+- (void)bookmarkBar:(BookmarkBarController*)controller
+ didChangeFromState:(bookmarks::VisualState)oldState
+            toState:(bookmarks::VisualState)newState {
+  [toolbarController_
+      setHeightCompression:[controller getDesiredToolbarHeightCompression]];
+  [toolbarController_ setShowsDivider:[controller shouldToolbarShowDivider]];
+
+  // TODO(viettrungluu): anything else?
+}
+
+// (Needed for |BookmarkBarControllerDelegate| protocol.)
+- (void)bookmarkBar:(BookmarkBarController*)controller
+willAnimateFromState:(bookmarks::VisualState)oldState
+            toState:(bookmarks::VisualState)newState {
+  [toolbarController_
+      setHeightCompression:[controller getDesiredToolbarHeightCompression]];
+  [toolbarController_ setShowsDivider:[controller shouldToolbarShowDivider]];
+
+  // TODO(viettrungluu): anything else?
+}
+
 @end
 
 @implementation BrowserWindowController (Private)
 
 // If the browser is in incognito mode, install the image view to decorate
 // the window at the upper right. Use the same base y coordinate as the
 // tab strip.
 - (void)installIncognitoBadge {
   if (!browser_->profile()->IsOffTheRecord())
     return;
@@ skipping 66 matching lines @@
   windowPreferences->SetBoolean(L"always_on_top", false);
   windowPreferences->SetInteger(L"work_area_left", workArea.x());
   windowPreferences->SetInteger(L"work_area_top", workArea.y());
   windowPreferences->SetInteger(L"work_area_right", workArea.right());
   windowPreferences->SetInteger(L"work_area_bottom", workArea.bottom());
 }
 
 - (NSRect)window:(NSWindow*)window
 willPositionSheet:(NSWindow*)sheet
        usingRect:(NSRect)defaultSheetRect {
-  // Any sheet should come from right above the apparent content area, or
-  // equivalently right below the apparent toolbar.
-  NSRect toolbarFrame = [[toolbarController_ view] frame];
-  defaultSheetRect.origin.y = toolbarFrame.origin.y;
-
-  // Position as follows:
-  //  - On a normal (non-NTP) page, position the sheet under the bookmark bar if
-  //    it's visible. Else put it immediately below the normal toolbar.
-  //  - On the NTP, if the bookmark bar is enabled ("always visible"), then it
-  //    looks like a normal bookmark bar, so position the sheet under it; if it
-  //    isn't enabled, the bookmark bar will look as if it's a part of the
-  //    content area, so just put it immediately below the toolbar.
-  if ([bookmarkBarController_ isVisible] &&
-      (![bookmarkBarController_ isNewTabPage] ||
-        [bookmarkBarController_ isAlwaysVisible])) {
-    NSRect bookmarkBarFrame = [[bookmarkBarController_ view] frame];
-    defaultSheetRect.origin.y -= bookmarkBarFrame.size.height;
+  // Position the sheet as follows:
+  //  - If the bookmark bar is hidden or shown as a bubble (on the NTP when the
+  //    bookmark bar is disabled), position the sheet immediately below the
+  //    normal toolbar.
+  //  - If the bookmark bar is shown (attached to the normal toolbar), position
+  //    the sheet below the bookmark bar.
+  //  - If the bookmark bar is currently animating, position the sheet according
+  //    to where the bar will be when the animation ends.
+  switch ([bookmarkBarController_ visualState]) {
+    case bookmarks::kShowingState: {
+      NSRect bookmarkBarFrame = [[bookmarkBarController_ view] frame];
+      defaultSheetRect.origin.y = bookmarkBarFrame.origin.y;
+      break;
+    }
+    case bookmarks::kHiddenState:
+    case bookmarks::kDetachedState: {
+      NSRect toolbarFrame = [[toolbarController_ view] frame];
+      defaultSheetRect.origin.y = toolbarFrame.origin.y;
+      break;
+    }
+    default:
+    case bookmarks::kInvalidState:
+      NOTREACHED();
   }
-
   return defaultSheetRect;
 }
 
 // Undocumented method for multi-touch gestures in 10.5. Future OS's will
 // likely add a public API, but the worst that will happen is that this will
 // turn into dead code and just won't get called.
 - (void)swipeWithEvent:(NSEvent*)event {
   // Map forwards and backwards to history; left is positive, right is negative.
   unsigned int command = 0;
   if ([event deltaX] > 0.5)
@@ skipping 60 matching lines @@
   NSRect toolbarFrame = [toolbarView frame];
   if (![self isFullscreen]) {
     // The toolbar is present in the window, so we make room for it.
     toolbarFrame.origin.x = 0;
     toolbarFrame.origin.y = maxY - NSHeight(toolbarFrame);
     toolbarFrame.size.width = NSWidth(contentFrame);
     maxY -= NSHeight(toolbarFrame);
   }
   [toolbarView setFrame:toolbarFrame];
 
-  if ([bookmarkBarController_ isAlwaysVisible]) {
+  bookmarks::VisualState bookmarkBarState =
+      [bookmarkBarController_ visualState];
+  bookmarks::VisualState lastBookmarkBarState =
+      [bookmarkBarController_ lastVisualState];
+
+  // If the bookmark bar is showing, or animating between showing and hidden,
+  // place the bookmark bar immediately below the toolbar.
+  // TODO(viettrungluu): Improve/abstract this when I implement other
+  // animations.
+  if ((bookmarkBarState == bookmarks::kShowingState) ||
+      (bookmarkBarState == bookmarks::kHiddenState &&
+       lastBookmarkBarState == bookmarks::kShowingState)) {
     NSView* bookmarkBarView = [bookmarkBarController_ view];
     [bookmarkBarView setHidden:NO];
     NSRect bookmarkBarFrame = [bookmarkBarView frame];
     bookmarkBarFrame.origin.y = maxY - NSHeight(bookmarkBarFrame);
     bookmarkBarFrame.size.width = NSWidth(contentFrame);
     [bookmarkBarView setFrame:bookmarkBarFrame];
     maxY -= NSHeight(bookmarkBarFrame);
   }
 
   // Place the infobar container in place below the toolbar.
   NSView* infoBarView = [infoBarContainerController_ view];
   NSRect infoBarFrame = [infoBarView frame];
   infoBarFrame.origin.y = maxY - NSHeight(infoBarFrame);
   infoBarFrame.size.width = NSWidth(contentFrame);
   [infoBarView setFrame:infoBarFrame];
   maxY -= NSHeight(infoBarFrame);
 
-  if (![bookmarkBarController_ isAlwaysVisible] &&
-      [bookmarkBarController_ isVisible]) {
+  // If the bookmark bar is detached, place it at the bottom of the stack.
+  if (bookmarkBarState == bookmarks::kDetachedState) {
     NSView* bookmarkBarView = [bookmarkBarController_ view];
     [bookmarkBarView setHidden:NO];
     NSRect bookmarkBarFrame = [bookmarkBarView frame];
     bookmarkBarFrame.origin.y = maxY - NSHeight(bookmarkBarFrame);
     bookmarkBarFrame.size.width = NSWidth(contentFrame);
     [bookmarkBarView setFrame:bookmarkBarFrame];
     maxY -= NSHeight(bookmarkBarFrame);
   }
 
-  if (![bookmarkBarController_ isVisible]) {
-    // If the bookmark bar is not visible in either mode, we need to hide it
-    // otherwise it'll render over other elements.
-    [[bookmarkBarController_ view] setHidden:YES];
-  }
-
   // Place the extension shelf at the bottom of the view, if it exists.
   if (extensionShelfController_.get()) {
     NSView* extensionView = [extensionShelfController_ view];
     NSRect extensionFrame = [extensionView frame];
     extensionFrame.origin.y = minY;
     extensionFrame.size.width = NSWidth(contentFrame);
     [extensionView setFrame:extensionFrame];
     minY += NSHeight(extensionFrame);
   }
 
@@ skipping 14 matching lines @@
   tabContentFrame.size.height = maxY - minY;
   tabContentFrame.size.width = NSWidth(contentFrame);
   [tabContentView setFrame:tabContentFrame];
 
   // Position the find bar relative to the infobar container.
   [findBarCocoaController_
     positionFindBarView:[infoBarContainerController_ view]];
 
   verticalOffsetForStatusBubble_ = minY;
 
-  // The bottom of the visible toolbar stack is the one that shows the
-  // divider stroke. If the bookmark bar is visible and not in new tab page
-  // mode, it is the bottom visible toolbar and so it must, otherwise the
-  // main toolbar is.
-  BOOL bookmarkToolbarShowsDivider = [bookmarkBarController_ isAlwaysVisible];
-  [[toolbarController_ backgroundGradientView]
-      setShowsDivider:!bookmarkToolbarShowsDivider];
-  [[bookmarkBarController_ backgroundGradientView]
-      setShowsDivider:bookmarkToolbarShowsDivider];
+  // Normally, we don't need to tell the toolbar whether or not to show the
+  // divider, but things break down during animation.
+  [toolbarController_
+      setShowsDivider:[bookmarkBarController_ shouldToolbarShowDivider]];
+}
+
+- (BOOL)shouldShowBookmarkBar {
+  DCHECK(browser_.get());
+  return browser_->profile()->GetPrefs()->GetBoolean(prefs::kShowBookmarkBar) ?
+      YES : NO;
+}
+
+- (BOOL)shouldShowDetachedBookmarkBar {
+  DCHECK(browser_.get());
+  TabContents* contents = browser_->GetSelectedTabContents();
+  return (contents && contents->ShouldShowBookmarkBar()) ? YES : NO;
 }
 
 @end
 
 @implementation GTMTheme (BrowserThemeProviderInitialization)
 + (GTMTheme*)themeWithBrowserThemeProvider:(BrowserThemeProvider*)provider
                             isOffTheRecord:(BOOL)isOffTheRecord {
   // First check if it's in the cache.
   // TODO(pinkerton): This might be a good candidate for a singleton.
   typedef std::pair<std::string, BOOL> ThemeKey;
@@ skipping 137 matching lines @@
   if (frameOverlayInactiveImage) {
     [theme setValue:frameOverlayInactiveImage
        forAttribute:@"overlay"
               style:GTMThemeStyleWindow
               state:GTMThemeStateInactiveWindow];
   }
 
   return theme;
 }
 @end