Fix "open all" on a folder node to open only 'marks in that folder,...

chrome/browser/cocoa/bookmark_bar_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 "app/l10n_util_mac.h"
 #include "app/resource_bundle.h"
 #include "base/mac_util.h"
 #include "base/sys_string_conversions.h"
 #include "chrome/browser/bookmarks/bookmark_editor.h"
 #include "chrome/browser/bookmarks/bookmark_model.h"
 #include "chrome/browser/browser.h"
 #include "chrome/browser/browser_list.h"
 #import "chrome/browser/cocoa/background_gradient_view.h"
 #import "chrome/browser/cocoa/bookmark_bar_bridge.h"
 #import "chrome/browser/cocoa/bookmark_bar_constants.h"
 #import "chrome/browser/cocoa/bookmark_bar_controller.h"
 #import "chrome/browser/cocoa/bookmark_bar_toolbar_view.h"
 #import "chrome/browser/cocoa/bookmark_bar_view.h"
 #import "chrome/browser/cocoa/bookmark_button_cell.h"
 #import "chrome/browser/cocoa/bookmark_editor_controller.h"
 #import "chrome/browser/cocoa/bookmark_name_folder_controller.h"
+#import "chrome/browser/cocoa/bookmark_menu.h"
 #import "chrome/browser/cocoa/bookmark_menu_cocoa_controller.h"
 #import "chrome/browser/cocoa/event_utils.h"
 #import "chrome/browser/cocoa/menu_button.h"
 #import "chrome/browser/cocoa/toolbar_controller.h"
 #import "chrome/browser/cocoa/view_resizer.h"
 #include "chrome/browser/metrics/user_metrics.h"
 #include "chrome/browser/profile.h"
 #include "chrome/browser/tab_contents/tab_contents.h"
 #include "chrome/browser/tab_contents/tab_contents_view.h"
 #include "chrome/common/pref_names.h"
@@ skipping 79 matching lines @@
 // NSButton ignores them.
 @interface BookmarkButton : NSButton
 @end
 
 @implementation BookmarkButton
 - (void)otherMouseUp:(NSEvent*) event {
   [self performClick:self];
 }
 @end
 
+
 @interface BookmarkBarController(Private)
 // Determines the appropriate state for the given situation.
 + (bookmarks::VisualState)visualStateToShowNormalBar:(BOOL)showNormalBar
                                      showDetachedBar:(BOOL)showDetachedBar;
 
 // Moves to the given next state (from the current state), possibly animating.
 // If |animate| is NO, it will stop any running animation and jump to the given
 // state. If YES, it may either (depending on implementation) jump to the end of
 // the current animation and begin the next one, or stop the current animation
 // mid-flight and animate to the next state.
@@ skipping 19 matching lines @@
 - (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;
 - (void)addButtonsToView;
 - (void)resizeButtons;
 - (void)centerNoItemsLabel;
 - (NSImage*)getFavIconForNode:(const BookmarkNode*)node;
+- (void)setNodeForBarMenu;
 @end
 
 @implementation BookmarkBarController
 
 @synthesize visualState = visualState_;
 @synthesize lastVisualState = lastVisualState_;
 @synthesize delegate = delegate_;
 
 - (id)initWithBrowser:(Browser*)browser
          initialWidth:(float)initialWidth
@@ skipping 38 matching lines @@
   // We default to NOT open, which means height=0.
   DCHECK([[self view] isHidden]);  // Hidden so it's OK to change.
 
   // Set our initial height to zero, since that is what the superview
   // expects.  We will resize ourselves open later if needed.
   [[self view] setFrame:NSMakeRect(0, 0, initialWidth_, 0)];
 
   // We are enabled by default.
   barIsEnabled_ = YES;
 
-  // 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_));
-
   DCHECK([offTheSideButton_ attachedMenu]);
 
   // To make life happier when the bookmark bar is floating, the chevron is a
   // child of the button view.
   [offTheSideButton_ removeFromSuperview];
   [buttonView_ addSubview:offTheSideButton_];
 
+  // Copy the bar menu so we know if it's from the bar or a folder.
+  // Then we set its represented item to be the bookmark bar.
+  buttonFolderContextMenu_.reset([[[self view] menu] copy]);
+
   // When resized we may need to add new buttons, or remove them (if
   // no longer visible), or add/remove the "off the side" menu.
   [[self view] setPostsFrameChangedNotifications:YES];
   [[NSNotificationCenter defaultCenter]
       addObserver:self
          selector:@selector(frameDidChange)
              name:NSViewFrameDidChangeNotification
            object:[self view]];
+
+  // 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_));
 }
 
 // (Private) Method is the same as [self view], but is provided to be explicit.
 - (BackgroundGradientView*)backgroundGradientView {
   DCHECK([[self view] isKindOfClass:[BackgroundGradientView class]]);
   return (BackgroundGradientView*)[self view];
 }
 
 // (Private) Method is the same as [self view], but is provided to be explicit.
 - (AnimatableView*)animatableView {
@@ skipping 215 matching lines @@
 - (int)currentTabContentsHeight {
   return browser_->GetSelectedTabContents() ?
       browser_->GetSelectedTabContents()->view()->GetContainerSize().height() :
       0;
 }
 
 - (ThemeProvider*)themeProvider {
   return browser_->profile()->GetThemeProvider();
 }
 
-// Return nil if menuItem has no delegate.
-- (BookmarkNode*)nodeFromMenuItem:(id)menuItem {
-  NSCell* cell = reinterpret_cast<NSCell*>([[menuItem menu] delegate]);
-  if (!cell)
-    return nil;
-  BookmarkNode* node = static_cast<BookmarkNode*>(
-      [[cell representedObject] pointerValue]);
-  return node;
-}
-
 - (BookmarkNode*)nodeFromButton:(id)button {
   NSCell* cell = [button cell];
   BookmarkNode* node = static_cast<BookmarkNode*>(
       [[cell representedObject] pointerValue]);
   DCHECK(node);
   return node;
 }
 
-// At this time, the only items which ever get disabled are the "Open All
-// Bookmarks" options.
-- (BOOL)validateUserInterfaceItem:(id<NSValidatedUserInterfaceItem>)item {
+// Enable or disable items.  We are the menu delegate for both the bar
+// and for bookmark folder buttons.
+- (BOOL)validateUserInterfaceItem:(id)item {
+  if (![item isKindOfClass:[NSMenuItem class]])
+    return YES;
+
+  BookmarkNode* node = [self nodeFromMenuItem:item];
+
+  // If this is the bar menu, we only have things to do if there are
+  // buttons.  If this is a folder button menu, we only have things to
+  // do if the folder has items.
+  NSMenu* menu = [item menu];
+  BOOL thingsToDo = NO;
+  if (menu == [[self view] menu]) {
+    thingsToDo = [buttons_ count] ? YES : NO;
+  } else {
+    if (node && node->is_folder() && node->GetChildCount()) {
+      thingsToDo = YES;
+    }
+  }
+
+  // Disable openAll* if we have nothing to do.
   SEL action = [item action];
-  if (((action == @selector(openAllBookmarks:)) ||
+  if ((!thingsToDo) &&
+      ((action == @selector(openAllBookmarks:)) ||
        (action == @selector(openAllBookmarksNewWindow:)) ||
-       (action == @selector(openAllBookmarksIncognitoWindow:))) &&
-      (![buttons_ count])) {
+       (action == @selector(openAllBookmarksIncognitoWindow:)))) {
     return NO;
   }
+
+  if ((action == @selector(editBookmark:)) ||
+      (action == @selector(deleteBookmark:))) {
+    // Don't allow edit/delete of the bar node, or of "Other Bookmarks"
+    if ((node == nil) ||
+        (node == bookmarkModel_->other_node()) ||
+        (node == bookmarkModel_->GetBookmarkBarNode())) {
+      return NO;
+    }
+  }
+
+  // Enabled by default.
   return YES;
 }
 
 // Actually open the URL.  This is the last chance for a unit test to
 // override.
 - (void)openURL:(GURL)url disposition:(WindowOpenDisposition)disposition {
   BrowserList::GetLastActive()->OpenURL(url, GURL(), disposition,
                                         PageTransition::AUTO_BOOKMARK);
 }
 
@@ skipping 206 matching lines @@
       [self openURL:child->GetURL() disposition:disposition];
       // We revert to a basic disposition in case the initial
       // disposition opened a new window.
       disposition = NEW_BACKGROUND_TAB;
     } else {
       [self openBookmarkNodesRecursive:child disposition:disposition];
     }
   }
 }
 
+// Return the BookmarkNode associated with the given NSMenuItem.
+- (BookmarkNode*)nodeFromMenuItem:(id)sender {
+  BookmarkMenu* menu = (BookmarkMenu*)[sender menu];
+  if ([menu isKindOfClass:[BookmarkMenu class]])
+    return const_cast<BookmarkNode*>([menu node]);
+  return NULL;
+}
+
 - (IBAction)openAllBookmarks:(id)sender {
-  // TODO(jrg):
-  // Is there an easier way to get a non-const root node for the bookmark bar?
-  // I can't iterate over them unless it's non-const.
-  BookmarkNode* node = const_cast<BookmarkNode*>(
-    bookmarkModel_->GetBookmarkBarNode());
+  BookmarkNode* node = [self nodeFromMenuItem:sender];
   [self openBookmarkNodesRecursive:node disposition:NEW_FOREGROUND_TAB];
   UserMetrics::RecordAction(L"OpenAllBookmarks", browser_->profile());
 }
 
 - (IBAction)openAllBookmarksNewWindow:(id)sender {
-  BookmarkNode* node = const_cast<BookmarkNode*>(
-    bookmarkModel_->GetBookmarkBarNode());
+  BookmarkNode* node = [self nodeFromMenuItem:sender];
   [self openBookmarkNodesRecursive:node disposition:NEW_WINDOW];
   UserMetrics::RecordAction(L"OpenAllBookmarksNewWindow", browser_->profile());
 }
 
 - (IBAction)openAllBookmarksIncognitoWindow:(id)sender {
-  BookmarkNode* node = const_cast<BookmarkNode*>(
-    bookmarkModel_->GetBookmarkBarNode());
+  BookmarkNode* node = [self nodeFromMenuItem:sender];
   [self openBookmarkNodesRecursive:node disposition:OFF_THE_RECORD];
   UserMetrics::RecordAction(L"OpenAllBookmarksIncognitoWindow", browser_->profile());
 }
 
 // May be called from the bar or from a folder button.
 // If called from a button, that button becomes the parent.
 - (IBAction)addPage:(id)sender {
   const BookmarkNode* parent = [self nodeFromMenuItem:sender];
   if (!parent)
     parent = bookmarkModel_->GetBookmarkBarNode();
@@ skipping 32 matching lines @@
 - (NSCell*)cellForBookmarkNode:(const BookmarkNode*)node {
   NSString* title = base::SysWideToNSString(node->GetTitle());
   BookmarkButtonCell* cell =
       [[[BookmarkButtonCell alloc] initTextCell:nil] autorelease];
   DCHECK(cell);
   [cell setRepresentedObject:[NSValue valueWithPointer:node]];
 
   NSImage* image = [self getFavIconForNode:node];
   [cell setBookmarkCellText:title image:image];
   if (node->is_folder())
-    [cell setMenu:[[self view] menu]];
+    [cell setMenu:buttonFolderContextMenu_];
   else
     [cell setMenu:buttonContextMenu_];
   return cell;
 }
 
 // Return an appropriate width for the given bookmark button cell.
 // The "+2" is needed because, sometimes, Cocoa is off by a tad.
 // Example: for a bookmark named "Moma" or "SFGate", it is one pixel
 // too small.  For "FBL" it is 2 pixels too small.
 // For a bookmark named "SFGateFooWoo", it is just fine.
@@ skipping 199 matching lines @@
   // Else brute force nuke and build.
   const BookmarkNode* node = model->GetBookmarkBarNode();
   [self clearBookmarkBar];
   [self addNodesToButtonList:node];
   [self createOtherBookmarksButton];
   [self resizeButtons];
   [self positionOffTheSideButton];
   [self addNonBookmarkButtonsToView];
   [self addButtonsToView];
   [self showOrHideOffTheSideButton];
+  [self setNodeForBarMenu];
+}
+
+// Now that the model is loaded, set the bookmark bar root as the node
+// represented by the bookmark bar (default, background) menu.
+- (void)setNodeForBarMenu {
+  const BookmarkNode* node = bookmarkModel_->GetBookmarkBarNode();
+  BookmarkMenu* menu = static_cast<BookmarkMenu*>([[self view] menu]);
+  [menu setRepresentedObject:[NSValue valueWithPointer:node]];
 }
 
 - (void)beingDeleted:(BookmarkModel*)model {
   [self clearBookmarkBar];
 }
 
 // TODO(jrg): for now this is brute force.
 - (void)nodeMoved:(BookmarkModel*)model
         oldParent:(const BookmarkNode*)oldParent oldIndex:(int)oldIndex
         newParent:(const BookmarkNode*)newParent newIndex:(int)newIndex {
@@ skipping 168 matching lines @@
   [[self animatableView] stopAnimation];
 }
 
 // Delegate method for |AnimatableView| (a superclass of
 // |BookmarkBarToolbarView|).
 - (void)animationDidEnd:(NSAnimation*)animation {
   [self finalizeVisualState];
 }
 
 @end