Mac: Add a shortcut to open the Apps page from the bookmark bar.

chrome/browser/ui/cocoa/bookmarks/bookmark_bar_controller.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/bookmarks/bookmark_bar_controller.h"
 
 #include "base/mac/bundle_locations.h"
 #include "base/mac/mac_util.h"
 #include "base/metrics/histogram.h"
 #include "base/prefs/pref_service.h"
@@ skipping 196 matching lines @@
 // Determine the nature of the bookmark bar contents based on the number of
 // buttons showing. If too many then show the off-the-side list, if none
 // then show the no items label.
 - (void)reconfigureBookmarkBar;
 
 - (void)addNode:(const BookmarkNode*)child toMenu:(NSMenu*)menu;
 - (void)addFolderNode:(const BookmarkNode*)node toMenu:(NSMenu*)menu;
 - (void)tagEmptyMenu:(NSMenu*)menu;
 - (void)clearMenuTagMap;
 - (int)preferredHeight;
-- (void)addNonBookmarkButtonsToView;

[Alexei Svitkine (slow), 2013/03/11 14:31:04]

Nit: Can you add all the new private methods you're introducing to this section?

[beaudoin, 2013/03/11 21:02:14]

This section misses quite a few of the private methods already in there. The
order seems also a bit off. Do you want me to thoroughly clean it up? (The order
is also off in the .h for public methods.) If yes, I'd suggest doing it in a
follow-up CL.

Done.

 - (void)addButtonsToView;
 - (void)centerNoItemsLabel;
 - (void)watchForExitEvent:(BOOL)watch;
 - (void)resetAllButtonPositionsWithAnimation:(BOOL)animate;
 
 @end
 
 @implementation BookmarkBarController
 
 @synthesize currentState = currentState_;
@@ skipping 56 matching lines @@
   return contextMenuController_.get();
 }
 
 - (void)pulseBookmarkNotification:(NSNotification*)notification {
   NSDictionary* dict = [notification userInfo];
   const BookmarkNode* node = NULL;
   NSValue *value = [dict objectForKey:bookmark_button::kBookmarkKey];
   DCHECK(value);
   if (value)
     node = static_cast<const BookmarkNode*>([value pointerValue]);
-  NSNumber* number = [dict
-                       objectForKey:bookmark_button::kBookmarkPulseFlagKey];
+  NSNumber* number = [dict objectForKey:bookmark_button::kBookmarkPulseFlagKey];
   DCHECK(number);
   BOOL doPulse = number ? [number boolValue] : NO;
 
   // 3 cases:
   // button on the bar: flash it
   // button in "other bookmarks" folder: flash other bookmarks
   // button in "off the side" folder: flash the chevron
   for (BookmarkButton* button in [self buttons]) {
     if ([button bookmarkNode] == node) {
       [button setIsContinuousPulsing:doPulse];
@@ skipping 85 matching lines @@
            name:kWillEnterFullscreenNotification
          object:nil];
   [[NSNotificationCenter defaultCenter]
     addObserver:self
        selector:@selector(willEnterOrLeaveFullscreen:)
            name:kWillLeaveFullscreenNotification
          object:nil];
 
   // Don't pass ourself along (as 'self') until our init is completely
   // done.  Thus, this call is (almost) last.
-  bridge_.reset(new BookmarkBarBridge(self, bookmarkModel_));
+  bridge_.reset(new BookmarkBarBridge(browser_->profile(), self,
+                                      bookmarkModel_));
 }
 
 // Called by our main view (a BookmarkBarView) when it gets moved to a
 // window.  We perform operations which need to know the relevant
 // window (e.g. watch for a window close) so they can't be performed
 // earlier (such as in awakeFromNib).
 - (void)viewDidMoveToWindow {
   NSNotificationCenter* defaultCenter = [NSNotificationCenter defaultCenter];
 
   // Remove any existing notifications before registering for new ones.
@@ skipping 59 matching lines @@
   [buttonView_ setFrame:buttonViewFrame];
 }
 
 // We don't change a preference; we only change visibility. Preference changing
 // (global state) is handled in |BrowserWindowCocoa::ToggleBookmarkBar()|. We
 // simply update based on what we're told.
 - (void)updateVisibility {
   [self showBookmarkBarWithAnimation:NO];
 }
 
+- (void)updateAppsPageShortcutButtonVisibility {
+  [self setAppsPageShortcutButtonVisibility];
+  [self reconfigureBookmarkBar];
+}
+
 - (void)updateHiddenState {
   BOOL oldHidden = [[self view] isHidden];
   BOOL newHidden = ![self isVisible];
   if (oldHidden != newHidden)
     [[self view] setHidden:newHidden];
 }
 
 - (void)setBookmarkBarEnabled:(BOOL)enabled {
   if (enabled != barIsEnabled_) {
     barIsEnabled_ = enabled;
@@ skipping 212 matching lines @@
   DCHECK([[self view] isKindOfClass:[AnimatableView class]]);
   return (AnimatableView*)[self view];
 }
 
 - (bookmark_utils::BookmarkLaunchLocation)bookmarkLaunchLocation {
   return currentState_ == BookmarkBar::DETACHED ?
       bookmark_utils::LAUNCH_DETACHED_BAR :
       bookmark_utils::LAUNCH_ATTACHED_BAR;
 }
 
-// Position the off-the-side chevron to the left of the otherBookmarks button,
-// unless it's hidden in which case it's right aligned on top of it.
-- (void)positionOffTheSideButton {
-  NSRect frame = [offTheSideButton_ frame];
+// Position the right-side buttons including the off-the-side chevron.
+- (void)positionRightSideButtons {
+  int maxX = NSMaxX([[self buttonView] bounds]) -
+      bookmarks::kBookmarkHorizontalPadding;
+  int right = maxX;
+
+  int ignored = 0;
+  NSRect frame = [self frameForBookmarkButtonFromCell:
+      [appsPageShortcutButton_ cell] xOffset:&ignored];
+  if (![appsPageShortcutButton_ isHidden]) {
+    right -= NSWidth(frame);
+    frame.origin.x = right;
+  } else {
+    frame.origin.x = maxX - NSWidth(frame);
+  }
+  [appsPageShortcutButton_ setFrame:frame];
+
+  frame = [self frameForBookmarkButtonFromCell:
+      [otherBookmarksButton_ cell] xOffset:&ignored];
+  if (![otherBookmarksButton_ isHidden]) {
+    right -= NSWidth(frame);
+    frame.origin.x = right;
+  } else {
+    frame.origin.x = maxX - NSWidth(frame);
+  }
+  [otherBookmarksButton_ setFrame:frame];
+
+  frame = [offTheSideButton_ frame];
   frame.size.height = bookmarks::kBookmarkFolderButtonHeight;
-  if (otherBookmarksButton_.get() && ![otherBookmarksButton_ isHidden]) {
-    frame.origin.x = ([otherBookmarksButton_ frame].origin.x -
-                      (frame.size.width +
-                       bookmarks::kBookmarkHorizontalPadding));
-  } else {
-    frame.origin.x = (NSMaxX([otherBookmarksButton_ frame]) - frame.size.width);
-  }
+  right -= frame.size.width;
+  frame.origin.x = right;
   [offTheSideButton_ setFrame:frame];
 }
 
 // Configure the off-the-side button (e.g. specify the node range,
 // check if we should enable or disable it, etc).
 - (void)configureOffTheSideButtonContentsAndVisibility {
   // If deleting a button while off-the-side is open, buttons may be
   // promoted from off-the-side to the bar.  Accomodate.
   if (folderController_ &&
       ([folderController_ parentButton] == offTheSideButton_)) {
@@ skipping 340 matching lines @@
   } else {
     // Make the button do something
     [button setTarget:self];
     [button setAction:@selector(openBookmark:)];
     if (node->is_url())
       [button setToolTip:[BookmarkMenuCocoaController tooltipForNode:node]];
   }
   return [[button.get() retain] autorelease];
 }
 
-// Add non-bookmark buttons to the view.  This includes the chevron
-// and the "other bookmarks" button.  Technically "other bookmarks" is
-// a bookmark button but it is treated specially.  Only needs to be
-// called when these buttons are new or when the bookmark bar is
-// cleared (e.g. on a loaded: call).  Unlike addButtonsToView below,
-// we don't need to add/remove these dynamically in response to window
-// resize.
-- (void)addNonBookmarkButtonsToView {
-  [buttonView_ addSubview:otherBookmarksButton_.get()];
-  [buttonView_ addSubview:offTheSideButton_];
-}
-
 // Add bookmark buttons to the view only if they are completely
 // visible and don't overlap the "other bookmarks".  Remove buttons
 // which are clipped.  Called when building the bookmark bar the first time.
 - (void)addButtonsToView {
   displayedButtonCount_ = 0;
   NSMutableArray* buttons = [self buttons];
   for (NSButton* button in buttons) {
     if (NSMaxX([button frame]) > (NSMinX([offTheSideButton_ frame]) -
                                   bookmarks::kBookmarkHorizontalPadding))
       break;
@@ skipping 12 matching lines @@
 // whether it ended up visible.
 - (BOOL)setOtherBookmarksButtonVisibility {
   if (!otherBookmarksButton_.get())
     return NO;
 
   BOOL visible = ![otherBookmarksButton_ bookmarkNode]->empty();
   [otherBookmarksButton_ setHidden:!visible];
   return visible;
 }
 
-// Create the button for "Other Bookmarks" on the right of the bar.
+// Shows or hides the Apps button as appropriate, and returns whether it ended
+// up visible.
+- (BOOL)setAppsPageShortcutButtonVisibility {
+  if (!appsPageShortcutButton_.get())
+    return NO;
+
+  BOOL visible = bookmarkModel_->IsLoaded() &&
+      chrome::search::IsInstantExtendedAPIEnabled() &&
+      browser_->profile()->GetPrefs()->GetBoolean(
+          prefs::kShowAppsShortcutInBookmarkBar);
+  [appsPageShortcutButton_ setHidden:!visible];
+  return visible;
+}
+
+// Creates a bookmark bar button that does not correspond to a regular bookmark
+// or folder. It is used by the "Other Bookmarks" and the "Apps" buttons.
+- (BookmarkButton*)createCustomBookmarkButtonForCell:(NSCell*)cell {

[Alexei Svitkine (slow), 2013/03/11 14:31:04]

Nit: This doesn't actually follow the Cocoa create naming convention (caller
doesn't get a retained object), so name it instead
-customBookmarkButtonForCell:. 

[beaudoin, 2013/03/11 21:02:14]

Done.

+  BookmarkButton* button = [[BookmarkButton alloc] init];
+  [[button draggableButton] setDraggable:NO];
+  [[button draggableButton] setActsOnMouseDown:YES];
+  // Peg at right; keep same height as bar.
+  [button setAutoresizingMask:(NSViewMinXMargin)];
+  [button setCell:cell];
+  [button setDelegate:self];
+  [button setTarget:self];
+  // Make sure this button, like all other BookmarkButtons, lives
+  // until the end of the current event loop.
+  [[button retain] autorelease];
+  return button;
+}
+
+// Creates the button for "Other Bookmarks", but does not position it.
 - (void)createOtherBookmarksButton {
   // Can't create this until the model is loaded, but only need to
   // create it once.
   if (otherBookmarksButton_.get()) {
     [self setOtherBookmarksButtonVisibility];
     return;
   }
 
-  // TODO(jrg): remove duplicate code
   NSCell* cell = [self cellForBookmarkNode:bookmarkModel_->other_node()];
-  int ignored = 0;
-  NSRect frame = [self frameForBookmarkButtonFromCell:cell xOffset:&ignored];
-  frame.origin.x = [[self buttonView] bounds].size.width - frame.size.width;
-  frame.origin.x -= bookmarks::kBookmarkHorizontalPadding;
-  BookmarkButton* button = [[BookmarkButton alloc] initWithFrame:frame];
-  [[button draggableButton] setDraggable:NO];
-  [[button draggableButton] setActsOnMouseDown:YES];
-  otherBookmarksButton_.reset(button);
-  view_id_util::SetID(button, VIEW_ID_OTHER_BOOKMARKS);
-
-  // Make sure this button, like all other BookmarkButtons, lives
-  // until the end of the current event loop.
-  [[button retain] autorelease];
-
-  // Peg at right; keep same height as bar.
-  [button setAutoresizingMask:(NSViewMinXMargin)];
-  [button setCell:cell];
-  [button setDelegate:self];
-  [button setTarget:self];
-  [button setAction:@selector(openBookmarkFolderFromButton:)];
-  [buttonView_ addSubview:button];
+  otherBookmarksButton_.reset([self createCustomBookmarkButtonForCell:cell]);
+  [otherBookmarksButton_ setAction:@selector(openBookmarkFolderFromButton:)];
+  view_id_util::SetID(otherBookmarksButton_.get(), VIEW_ID_OTHER_BOOKMARKS);
+  [buttonView_ addSubview:otherBookmarksButton_.get()];
 
   [self setOtherBookmarksButtonVisibility];
+}
 
-  // Now that it's here, move the chevron over.
-  [self positionOffTheSideButton];
+// Creates the button for "Apps", but does not position it.
+- (void)createAppsPageShortcutButton {
+  // Can't create this until the model is loaded, but only need to
+  // create it once.
+  if (appsPageShortcutButton_.get()) {
+    [self setAppsPageShortcutButtonVisibility];
+    return;
+  }
+
+  ResourceBundle& rb = ResourceBundle::GetSharedInstance();
+  NSString* text = l10n_util::GetNSString(IDS_BOOKMARK_BAR_APPS_SHORTCUT_NAME);
+  NSImage* image = rb.GetNativeImageNamed(IDR_WEBSTORE_ICON_16).ToNSImage();
+  NSCell* cell = [self cellForCustomButton:text
+                                 withImage:image];
+  appsPageShortcutButton_.reset([self createCustomBookmarkButtonForCell:cell]);
+  [appsPageShortcutButton_ setAction:@selector(openAppsPage:)];
+  NSString* tooltip =
+      l10n_util::GetNSString(IDS_BOOKMARK_BAR_APPS_SHORTCUT_TOOLTIP);
+  [appsPageShortcutButton_ setToolTip:tooltip];
+  [buttonView_ addSubview:appsPageShortcutButton_.get()];
+
+  [self setAppsPageShortcutButtonVisibility];
+}
+
+- (IBAction)openAppsPage:(id)sender {

[Alexei Svitkine (slow), 2013/03/11 14:31:04]

Nit: This doesn't need to be an IBAction, change the return value to void.

[beaudoin, 2013/03/11 21:02:14]

Done.

+  chrome::ShowAppLauncherPage(browser_);
+  bookmark_utils::RecordAppsPageOpen([self bookmarkLaunchLocation]);
 }
 
 // To avoid problems with sync, changes that may impact the current
 // bookmark (e.g. deletion) make sure context menus are closed.  This
 // prevents deleting a node which no longer exists.
 - (void)cancelMenuTracking {
   [contextMenuController_ cancelTracking];
 }
 
 - (void)moveToState:(BookmarkBar::State)nextState
@@ skipping 85 matching lines @@
 }
 
 // Delegate method for |AnimatableView| (a superclass of
 // |BookmarkBarToolbarView|).
 - (void)animationDidEnd:(NSAnimation*)animation {
   [self finalizeState];
 }
 
 - (void)reconfigureBookmarkBar {
   [self redistributeButtonsOnBarAsNeeded];
-  [self positionOffTheSideButton];
+  [self positionRightSideButtons];
   [self configureOffTheSideButtonContentsAndVisibility];
   [self centerNoItemsLabel];
 }
 
 // Determine if the given |view| can completely fit within the constraint of
 // maximum x, given by |maxViewX|, and, if not, narrow the view up to a minimum
 // width. If the minimum width is not achievable then hide the view. Return YES
 // if the view was hidden.
 - (BOOL)shrinkOrHideView:(NSView*)view forMaxX:(CGFloat)maxViewX {
   BOOL wasHidden = NO;
@@ skipping 80 matching lines @@
 
 // Calculates the final position of the last button in the bar.
 // We can't just use [[self buttons] lastObject] frame] because the button
 // may be animating currently.
 - (NSRect)finalRectOfLastButton {
   return [self finalRectOfButton:[[self buttons] lastObject]];
 }
 
 - (CGFloat)buttonViewMaxXWithOffTheSideButtonIsVisible:(BOOL)visible {
   CGFloat maxViewX = NSMaxX([buttonView_ bounds]);
-  // If necessary, pull in the width to account for the Other Bookmarks button.
-  if ([self setOtherBookmarksButtonVisibility]) {
-    maxViewX = [otherBookmarksButton_.get() frame].origin.x -
+  // If necessary, pull in the width to account for the Other Bookmarks or Apps
+  // button.
+  const BOOL otherButtonVisible = [self setOtherBookmarksButtonVisibility];
+  const BOOL appsButtonVisible = [self setAppsPageShortcutButtonVisibility];
+  if (otherButtonVisible || appsButtonVisible) {
+    BookmarkButton* leftMostRightAlignedButton = otherButtonVisible ?
+        otherBookmarksButton_.get() : appsPageShortcutButton_.get();
+    maxViewX = [leftMostRightAlignedButton frame].origin.x -
                bookmarks::kBookmarkRightMargin;
   }
 
-  [self positionOffTheSideButton];
+  [self positionRightSideButtons];
   // If we're already overflowing, then we need to account for the chevron.
   if (visible) {
     maxViewX =
         [offTheSideButton_ frame].origin.x - bookmarks::kBookmarkRightMargin;
   }
 
   return maxViewX;
 }
 
 - (void)redistributeButtonsOnBarAsNeeded {
   const BookmarkNode* node = bookmarkModel_->bookmark_bar_node();
   NSInteger barCount = node->child_count();
 
   // Determine the current maximum extent of the visible buttons.
-  [self positionOffTheSideButton];
+  [self positionRightSideButtons];
   CGFloat maxViewX = [self buttonViewMaxXWithOffTheSideButtonIsVisible:
       (barCount > displayedButtonCount_)];
 
   // As a result of pasting or dragging, the bar may now have more buttons
   // than will fit so remove any which overflow.  They will be shown in
   // the off-the-side folder.
   while (displayedButtonCount_ > 0) {
     BookmarkButton* button = [buttons_ lastObject];
     if (NSMaxX([self finalRectOfLastButton]) < maxViewX)
       break;
@@ skipping 90 matching lines @@
   [pboard setString:@"" forType:NSStringPboardType];
 }
 
 // Return an autoreleased NSCell suitable for a bookmark button.
 // TODO(jrg): move much of the cell config into the BookmarkButtonCell class.
 - (BookmarkButtonCell*)cellForBookmarkNode:(const BookmarkNode*)node {
   NSImage* image = node ? [self faviconForNode:node] : nil;
   BookmarkButtonCell* cell =
       [BookmarkButtonCell buttonCellForNode:node
                              menuController:contextMenuController_
-                                   cellText:nil
-                                  cellImage:image];
+                                       text:nil
+                                      image:image];
   [cell setTag:kStandardButtonTypeWithLimitedClickFeedback];
 
   // Note: a quirk of setting a cell's text color is that it won't work
+  // until the cell is associated with a button, so we can't theme the cell yet.
+
+  return cell;
+}
+
+// Return an autoreleased NSCell suitable for a special button displayed on the
+// bookmark bar that is not attached to any bookmark node.
+// TODO(jrg): move much of the cell config into the BookmarkButtonCell class.
+- (BookmarkButtonCell*)cellForCustomButton:(NSString*)text

[Alexei Svitkine (slow), 2013/03/11 14:31:04]

Nit: rename to -cellForCustomButtonWithText:image:

[beaudoin, 2013/03/11 21:02:14]

Done.

+                                 withImage:(NSImage*)image {
+  BookmarkButtonCell* cell =
+      [BookmarkButtonCell buttonCellWithMenuController:contextMenuController_
+                                                  text:text
+                                                 image:image];
+  [cell setTag:kStandardButtonTypeWithLimitedClickFeedback];
+
+  // Note: a quirk of setting a cell's text color is that it won't work
   // until the cell is associated with a button, so we can't theme the cell yet.
 
   return cell;
 }
 
 // Returns a frame appropriate for the given bookmark cell, suitable
 // for creating an NSButton that will contain it.  |xOffset| is the X
 // offset for the frame; it is increased to be an appropriate X offset
 // for the next button.
 - (NSRect)frameForBookmarkButtonFromCell:(NSCell*)cell
@@ skipping 69 matching lines @@
   if (!themeProvider)
     return;
   NSColor* color =
       themeProvider->GetNSColor(ThemeProperties::COLOR_BOOKMARK_TEXT,
                                 true);
   for (BookmarkButton* button in buttons_.get()) {
     BookmarkButtonCell* cell = [button cell];
     [cell setTextColor:color];
   }
   [[otherBookmarksButton_ cell] setTextColor:color];
+  [[appsPageShortcutButton_ cell] setTextColor:color];
 }
 
 // Return YES if the event indicates an exit from the bookmark bar
 // folder menus.  E.g. "click outside" of the area we are watching.
 // At this time we are watching the area that includes all popup
 // bookmark folder windows.
 - (BOOL)isEventAnExitEvent:(NSEvent*)event {
   NSWindow* eventWindow = [event window];
   NSWindow* myWindow = [[self view] window];
   switch ([event type]) {
@@ skipping 285 matching lines @@
   // See: http://crbug.com/36614
   if (folderController_)
     [self closeAllBookmarkFolders];
 
   // Brute force nuke and build.
   savedFrameWidth_ = NSWidth([[self view] frame]);
   const BookmarkNode* node = model->bookmark_bar_node();
   [self clearBookmarkBar];
   [self addNodesToButtonList:node];
   [self createOtherBookmarksButton];
+  [self createAppsPageShortcutButton];
   [self updateTheme:[[[self view] window] themeProvider]];
-  [self positionOffTheSideButton];
-  [self addNonBookmarkButtonsToView];
+  [self positionRightSideButtons];
   [self addButtonsToView];
   [self configureOffTheSideButtonContentsAndVisibility];
   [self reconfigureBookmarkBar];
 }
 
 - (void)beingDeleted:(BookmarkModel*)model {
   // The browser may be being torn down; little is safe to do.  As an
   // example, it may not be safe to clear the pasteboard.
   // http://crbug.com/38665
 }
@@ skipping 627 matching lines @@
 - (id<BookmarkButtonControllerProtocol>)controllerForNode:
     (const BookmarkNode*)node {
   // See if it's in the bar, then if it is in the hierarchy of visible
   // folder menus.
   if (bookmarkModel_->bookmark_bar_node() == node)
     return self;
   return [folderController_ controllerForNode:node];
 }
 
 @end