[Mac] Refactor bookmark pulsing into BookmarkBubbleObserverCocoa.

chrome/browser/ui/cocoa/bookmarks/bookmark_bar_controller.h

 // 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.
 
 #ifndef CHROME_BROWSER_UI_COCOA_BOOKMARKS_BOOKMARK_BAR_CONTROLLER_H_
 #define CHROME_BROWSER_UI_COCOA_BOOKMARKS_BOOKMARK_BAR_CONTROLLER_H_
 
 #import <Cocoa/Cocoa.h>
 #include <map>
 
 #import "base/mac/cocoa_protocols.h"
 #include "base/mac/scoped_nsobject.h"
 #include "base/memory/scoped_ptr.h"
 #include "chrome/browser/ui/cocoa/bookmarks/bookmark_bar_bridge.h"
 #import "chrome/browser/ui/cocoa/bookmarks/bookmark_bar_constants.h"
 #import "chrome/browser/ui/cocoa/bookmarks/bookmark_bar_state.h"
 #import "chrome/browser/ui/cocoa/bookmarks/bookmark_bar_toolbar_view.h"
 #import "chrome/browser/ui/cocoa/bookmarks/bookmark_button.h"
 #import "chrome/browser/ui/cocoa/has_weak_browser_pointer.h"
 #include "chrome/browser/ui/cocoa/tabs/tab_strip_model_observer_bridge.h"
 #include "ui/base/window_open_disposition.h"
 
 @class BookmarkBarController;
 @class BookmarkBarFolderController;
 @class BookmarkBarView;
 @class BookmarkButtonCell;
+@class BookmarkContextMenuCocoaController;

[tapted, 2015/08/25 01:13:20]

is this used here?

[jackhou1, 2015/08/25 04:32:29]

Yup, I was just rearranging to fix the order.

 @class BookmarkFolderTarget;
-@class BookmarkContextMenuCocoaController;
+class BookmarkModelObserverForCocoa;
 class Browser;
 class GURL;
 namespace ui {
 class ThemeProvider;
 }
 
 namespace bookmarks {
 
 class BookmarkModel;
 class BookmarkNode;
@@ skipping 240 matching lines @@
   // YES if there is a possible drop about to happen in the bar.
   BOOL hasInsertionPos_;
 
   // The x point on the bar where the left edge of the new item will end
   // up if it is dropped.
   CGFloat insertionPos_;
 
   // Controller responsible for all bookmark context menus.
   base::scoped_nsobject<BookmarkContextMenuCocoaController>
       contextMenuController_;
+
+  // Weak pointer to the pulsed button for the currently pulsing node. We need
+  // to store this as it may not be possible to determine the pulsing button if
+  // the pulsing node is deleted. Nil if there is no pulsing node.
+  BookmarkButton* pulsingButton_;

[tapted, 2015/08/25 01:13:20]

(maybe move this to be a member of BookmarkModelObserverForCocoa)

But also I don't think it should be weak -- typically weak pointers to NSObject
are only chosen over scoped_nsobject if the latter would create a cycle.

[jackhou1, 2015/08/25 04:32:29]

I don't think this fits well in BookmarkModelObserverForCocoa (not to be
confused with BookmarkBubbleObserverCocoa). Also it would expose pulsing logic
to something outside of BookmarkBarController, which I was hoping wouldn't be
necessary. At the moment BookmarkBarController just exposes two methods.

[tapted, 2015/08/25 05:46:34]

Acknowledged.

+
+  // Specifically watch the currently pulsing node. This lets us stop pulsing
+  // when anything happens to the node. Null if there is no pulsing node.
+  scoped_ptr<BookmarkModelObserverForCocoa> pulsingBookmarkObserver_;
 }
 
 @property(readonly, nonatomic) BookmarkBar::State currentState;
 @property(readonly, nonatomic) BookmarkBar::State lastState;
 @property(readonly, nonatomic) BOOL isAnimationRunning;
 @property(assign, nonatomic) id<BookmarkBarControllerDelegate> delegate;
 @property(assign, nonatomic) BOOL stateAnimationsEnabled;
 @property(assign, nonatomic) BOOL innerContentAnimationsEnabled;
 
 // Initializes the bookmark bar controller with the given browser
 // profile and delegates.
 - (id)initWithBrowser:(Browser*)browser
          initialWidth:(CGFloat)initialWidth
              delegate:(id<BookmarkBarControllerDelegate>)delegate
        resizeDelegate:(id<ViewResizer>)resizeDelegate;
 
 // The Browser corresponding to this BookmarkBarController.
 - (Browser*)browser;
 
 // The controller for all bookmark bar context menus.
 - (BookmarkContextMenuCocoaController*)menuController;
 
+// Pulses the given bookmark node, or the closest parent node that is visible.
+- (void)startPulsingBookmarkNode:(const bookmarks::BookmarkNode*)node;
+
+// Stops pulsing any bookmark nodes.
+- (void)stopPulsingBookmarkNode;
+
 // Updates the bookmark bar (from its current, possibly in-transition) state to
 // the new state.
 - (void)updateState:(BookmarkBar::State)newState
          changeType:(BookmarkBar::AnimateChangeType)changeType;
 
 // Update the visible state of the bookmark bar.
 - (void)updateVisibility;
 
 // Update the visible state of the extra buttons on the bookmark bar: the
 // apps shortcut, the managed bookmarks folder, and the supervised bookmarks
@@ skipping 103 matching lines @@
 - (BookmarkButton*)buttonForDroppingOnAtPoint:(NSPoint)point;
 - (BOOL)isEventAnExitEvent:(NSEvent*)event;
 - (BOOL)shrinkOrHideView:(NSView*)view forMaxX:(CGFloat)maxViewX;
 - (void)unhighlightBookmark:(const bookmarks::BookmarkNode*)node;
 
 // The following are for testing purposes only and are not used internally.
 - (NSMenu *)menuForFolderNode:(const bookmarks::BookmarkNode*)node;
 @end
 
 #endif  // CHROME_BROWSER_UI_COCOA_BOOKMARKS_BOOKMARK_BAR_CONTROLLER_H_