[Extensions Toolbar] Move some popup logic to be platform-agnostic

chrome/browser/ui/cocoa/extensions/browser_action_button.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/extensions/browser_action_button.h"
 
 #include <algorithm>
 #include <cmath>
 
 #include "base/logging.h"
 #include "base/memory/weak_ptr.h"
 #include "base/strings/sys_string_conversions.h"
-#include "chrome/browser/extensions/extension_context_menu_model.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_window.h"
 #import "chrome/browser/ui/cocoa/browser_window_controller.h"
 #import "chrome/browser/ui/cocoa/extensions/browser_actions_controller.h"
 #import "chrome/browser/ui/cocoa/themed_window.h"
 #import "chrome/browser/ui/cocoa/toolbar/toolbar_action_view_delegate_cocoa.h"
 #import "chrome/browser/ui/cocoa/toolbar/toolbar_controller.h"
 #import "chrome/browser/ui/cocoa/wrench_menu/wrench_menu_controller.h"
-#include "chrome/browser/ui/extensions/extension_action_view_controller.h"
 #include "chrome/browser/ui/toolbar/toolbar_action_view_controller.h"
 #include "grit/theme_resources.h"
 #include "skia/ext/skia_utils_mac.h"
 #import "third_party/google_toolbox_for_mac/src/AppKit/GTMNSAnimation+Duration.h"
 #import "ui/base/cocoa/menu_controller.h"
 #include "ui/gfx/canvas_skia_paint.h"
 #include "ui/gfx/geometry/rect.h"
 #include "ui/gfx/image/image.h"
 #include "ui/gfx/scoped_ns_graphics_context_save_gstate_mac.h"
 
 NSString* const kBrowserActionButtonDraggingNotification =
     @"BrowserActionButtonDraggingNotification";
 NSString* const kBrowserActionButtonDragEndNotification =
     @"BrowserActionButtonDragEndNotification";
 
 static const CGFloat kBrowserActionBadgeOriginYOffset = 5;
 static const CGFloat kAnimationDuration = 0.2;
 static const CGFloat kMinimumDragDistance = 5;
 
+@interface BrowserActionButton (Private)

[Avi (use Gerrit), 2015/01/29 02:59:26]

You can use a class extension by dropping the contents of the ().

[Devlin, 2015/01/29 17:42:08]

Ooh, class extensions vs categories.  Nifty.

Thanks for the tip, and done. :)

+- (void)endDrag;
+- (void)updateHighlightedState;
+@end
+
 // A class to bridge the ToolbarActionViewController and the
 // BrowserActionButton.
 class ToolbarActionViewDelegateBridge : public ToolbarActionViewDelegateCocoa {
  public:
   ToolbarActionViewDelegateBridge(BrowserActionButton* owner,
                                   BrowserActionsController* controller,
                                   ToolbarActionViewController* viewController);
   ~ToolbarActionViewDelegateBridge() override;
 
   // Shows the context menu for the owning action.
   void ShowContextMenu();
 
+  bool user_shown_popup_visible() const { return user_shown_popup_visible_; }
+
  private:
   // ToolbarActionViewDelegateCocoa:
   ToolbarActionViewController* GetPreferredPopupViewController() override;
   content::WebContents* GetCurrentWebContents() const override;
   void UpdateState() override;
+  void OnPopupShown(bool by_user) override;
+  void OnPopupClosed() override;
   NSPoint GetPopupPoint() override;
 
   // A helper method to implement showing the context menu.
   void DoShowContextMenu();
 
   // The owning button. Weak.
   BrowserActionButton* owner_;
 
   // The BrowserActionsController that owns the button. Weak.
   BrowserActionsController* controller_;
 
   // The ToolbarActionViewController for which this is the delegate. Weak.
   ToolbarActionViewController* viewController_;
 
+  // Whether or not a popup is visible from a user action.
+  bool user_shown_popup_visible_;
+
   base::WeakPtrFactory<ToolbarActionViewDelegateBridge> weakFactory_;
 
   DISALLOW_COPY_AND_ASSIGN(ToolbarActionViewDelegateBridge);
 };
 
 ToolbarActionViewDelegateBridge::ToolbarActionViewDelegateBridge(
     BrowserActionButton* owner,
     BrowserActionsController* controller,
     ToolbarActionViewController* viewController)
     : owner_(owner),
       controller_(controller),
       viewController_(viewController),
+      user_shown_popup_visible_(false),
       weakFactory_(this) {
   viewController_->SetDelegate(this);
 }
 
 ToolbarActionViewDelegateBridge::~ToolbarActionViewDelegateBridge() {
   viewController_->SetDelegate(nullptr);
 }
 
 void ToolbarActionViewDelegateBridge::ShowContextMenu() {
   // We should only be showing the context menu in this way if we're doing so
@@ skipping 25 matching lines @@
 
 content::WebContents* ToolbarActionViewDelegateBridge::GetCurrentWebContents()
     const {
   return [controller_ currentWebContents];
 }
 
 void ToolbarActionViewDelegateBridge::UpdateState() {
   [owner_ updateState];
 }
 
+void ToolbarActionViewDelegateBridge::OnPopupShown(bool by_user) {
+  if (by_user)
+    user_shown_popup_visible_ = true;
+  [owner_ updateHighlightedState];
+}
+
+void ToolbarActionViewDelegateBridge::OnPopupClosed() {
+  user_shown_popup_visible_ = false;
+  [owner_ updateHighlightedState];
+}
+
 NSPoint ToolbarActionViewDelegateBridge::GetPopupPoint() {
   return [controller_ popupPointForId:[owner_ viewController]->GetId()];
 }
 
 void ToolbarActionViewDelegateBridge::DoShowContextMenu() {
   NSButton* wrenchButton =
       [[[BrowserWindowController browserWindowControllerForWindow:
           [controller_ browser]->window()->GetNativeWindow()]
               toolbarController] wrenchButton];
   // The point the menu shows matches that of the normal wrench menu - that is,
@@ skipping 10 matching lines @@
                                atLocation:menuPoint
                                    inView:wrenchButton];
   [[wrenchButton cell] setHighlighted:NO];
 }
 
 @interface BrowserActionCell (Internals)
 - (void)drawBadgeWithinFrame:(NSRect)frame
               forWebContents:(content::WebContents*)webContents;
 @end
 
-@interface BrowserActionButton (Private)
-- (void)endDrag;
-@end
-
 @implementation BrowserActionButton
 
 @synthesize isBeingDragged = isBeingDragged_;
 
 + (Class)cellClass {
   return [BrowserActionCell class];
 }
 
 - (id)initWithFrame:(NSRect)frame
      viewController:(ToolbarActionViewController*)viewController
@@ skipping 71 matching lines @@
   // etc). When the mouse leaves, we get no indication (no mouseUp), so we can't
   // even handle that case - and are left in the middle of a drag. Instead, we
   // have to simply disable dragging.
   //
   // NOTE(devlin): If we use a greedy event loop that consumes all incoming
   // events (i.e. using [NSWindow nextEventMatchingMask]), we can make this
   // work. The downside to that is that all other events are lost. Disable this
   // for now, and revisit it at a later date.
   if (NSPointInRect(location, [self bounds]) &&
       ![browserActionsController_ isOverflow]) {
-    [[self cell] setHighlighted:YES];
     dragCouldStart_ = YES;
     dragStartPoint_ = [self convertPoint:[theEvent locationInWindow]
                                 fromView:nil];
+    [self updateHighlightedState];
   }
 }
 
 - (void)mouseDragged:(NSEvent*)theEvent {
   if (!dragCouldStart_)
     return;
 
   NSPoint eventPoint = [theEvent locationInWindow];
   if (!isBeingDragged_) {
     // Don't initiate a drag until it moves at least kMinimumDragDistance.
@@ skipping 51 matching lines @@
     // Only perform the click if we didn't drag the button.
     [self performClick:self];
   } else {
     // Make sure an ESC to end a drag doesn't trigger 2 endDrags.
     if (isBeingDragged_) {
       [self endDrag];
     } else {
       [super mouseUp:theEvent];
     }
   }
+  [self updateHighlightedState];
 }
 
 - (void)endDrag {
   isBeingDragged_ = NO;
   [[NSNotificationCenter defaultCenter]
       postNotificationName:kBrowserActionButtonDragEndNotification object:self];
-  [[self cell] setHighlighted:NO];
+}
+
+- (void)updateHighlightedState {
+  // The button's cell is highlighted if either the popup is showing by a user
+  // action, or the user is about to drag the button, unless the button is
+  // overflowed (in which case it is never highlighted).
+  if ([self superview] && ![browserActionsController_ isOverflow]) {
+    BOOL highlighted = viewControllerDelegate_->user_shown_popup_visible() ||
+        dragCouldStart_;
+    [[self cell] setHighlighted:highlighted];
+  }
 }
 
 - (void)setFrame:(NSRect)frameRect animate:(BOOL)animate {
   if (!animate) {
     [self setFrame:frameRect];
   } else {
     if ([moveAnimation_ isAnimating])
       [moveAnimation_ stopAnimation];
 
     NSDictionary* animationDictionary = @{
@@ skipping 150 matching lines @@
 - (ui::ThemeProvider*)themeProviderForWindow:(NSWindow*)window {
   ui::ThemeProvider* themeProvider = [window themeProvider];
   if (!themeProvider)
     themeProvider =
         [[browserActionsController_ browser]->window()->GetNativeWindow()
             themeProvider];
   return themeProvider;
 }
 
 @end