[Mac] DownloadShelf should be notified when autoclosing.

chrome/browser/ui/cocoa/download/download_shelf_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/download/download_shelf_controller.h"
 
 #include "base/mac/bundle_locations.h"
 #include "base/mac/mac_util.h"
 #include "base/sys_string_conversions.h"
 #include "chrome/browser/download/download_util.h"
@@ skipping 53 matching lines @@
 // Amount of time between when the mouse is moved off the shelf and the shelf is
 // autoclosed, in seconds.
 const NSTimeInterval kAutoCloseDelaySeconds = 5;
 
 // The size of the x button by default.
 const NSSize kHoverCloseButtonDefaultSize = { 18, 18 };
 
 }  // namespace
 
 @interface DownloadShelfController(Private)
-- (void)showDownloadShelf:(BOOL)enable;
+- (void)viewFrameDidChange:(NSNotification*)notification;
 - (void)layoutItems:(BOOL)skipFirst;
 - (void)closed;
-- (BOOL)canAutoClose;
-
-- (void)viewFrameDidChange:(NSNotification*)notification;
-
+- (void)maybeAutoCloseAfterDelay;
+- (void)autoClose;
 - (void)installTrackingArea;
 - (void)cancelAutoCloseAndRemoveTrackingArea;
-
 - (void)willEnterFullscreen;
 - (void)willLeaveFullscreen;
 - (void)updateCloseButton;
 @end
 
 
 @implementation DownloadShelfController
 
 - (id)initWithBrowser:(Browser*)browser
        resizeDelegate:(id<ViewResizer>)resizeDelegate {
@@ skipping 49 matching lines @@
 
 - (void)dealloc {
   [[NSNotificationCenter defaultCenter] removeObserver:self];
   [self cancelAutoCloseAndRemoveTrackingArea];
 
   // The controllers will unregister themselves as observers when they are
   // deallocated. No need to do that here.
   [super dealloc];
 }
 
-// Called after the frame's rect has changed; usually when the height is
-// animated.
-- (void)viewFrameDidChange:(NSNotification*)notification {

[asanka, 2013/03/22 20:11:01]

Methods were re-ordered to match declaration order.

[Nico, 2013/03/22 20:24:11]

Can you land that part as a separate CL? That would make review much easier.

(Also, I think chromium-dev consensus on this topic is that the damage done to
`git blame` output is not worth the gain in orderliness, so maybe just revert
the shuffling altogether. But if you really want to do it, please do it in a
different CL and then rebase this CL on top of the shuffling. I'll stamp the
shuffle CL within minutes, so this shouldn't slow things down much.)

[asanka, 2013/03/22 21:22:13]

I undid the re-ordering. I see the point about messing up `git blame`, so I'm
inclined to leave the ordering as-is for now.

-  // Anchor subviews at the top of |view|, so that it looks like the shelf
-  // is sliding out.
-  CGFloat newShelfHeight = NSHeight([[self view] frame]);
-  if (newShelfHeight == currentShelfHeight_)
-    return;
-
-  for (NSView* view in [[self view] subviews]) {
-    NSRect frame = [view frame];
-    frame.origin.y -= currentShelfHeight_ - newShelfHeight;
-    [view setFrame:frame];
-  }
-  currentShelfHeight_ = newShelfHeight;
-}
-
-- (AnimatableView*)animatableView {
-  return static_cast<AnimatableView*>([self view]);
-}
-
-- (void)showDownloadsTab:(id)sender {
+- (IBAction)showDownloadsTab:(id)sender {
   chrome::ShowDownloads(bridge_->browser());
 }
 
-- (void)remove:(DownloadItemController*)download {
-  // Look for the download in our controller array and remove it. This will
-  // explicity release it so that it removes itself as an Observer of the
-  // DownloadItem. We don't want to wait for autorelease since the DownloadItem
-  // we are observing will likely be gone by then.
-  [[NSNotificationCenter defaultCenter] removeObserver:download];
-
-  // TODO(dmaclach): Remove -- http://crbug.com/25845
-  [[download view] removeFromSuperview];
-
-  [downloadItemControllers_ removeObject:download];
-
-  [self layoutItems];
-
-  // Check to see if we have any downloads remaining and if not, hide the shelf.
-  if (![downloadItemControllers_ count])
-    [self showDownloadShelf:NO];
+- (IBAction)handleClose:(id)sender {
+  bridge_->Close(DownloadShelf::USER_ACTION);
 }
 
-- (void)downloadWasOpened:(DownloadItemController*)item_controller {
-  // This should only be called on the main thead.
-  DCHECK([NSThread isMainThread]);
-
-  if ([self canAutoClose])
-    [self installTrackingArea];
-}
-
-// We need to explicitly release our download controllers here since they need
-// to remove themselves as observers before the remaining shutdown happens.
-- (void)exiting {
-  [[self animatableView] stopAnimation];
-  [self cancelAutoCloseAndRemoveTrackingArea];
-  downloadItemControllers_.reset();
-}
-
-// Show or hide the bar based on the value of |enable|. Handles animating the
-// resize of the content view.
-- (void)showDownloadShelf:(BOOL)enable {
-  if ([self isVisible] == enable)
+- (void)showDownloadShelf:(BOOL)show
+             isUserAction:(BOOL)isUserAction {
+  if ([self isVisible] == show)
     return;
 
+  if (!show) {
+    [self cancelAutoCloseAndRemoveTrackingArea];
+    int numInProgress = 0;
+    for (NSUInteger i = 0; i < [downloadItemControllers_ count]; ++i) {
+      if ([[downloadItemControllers_ objectAtIndex:i]download]->IsInProgress())
+        ++numInProgress;
+    }
+    download_util::RecordShelfClose(
+        [downloadItemControllers_ count], numInProgress, !isUserAction);
+  }
   // Animate the shelf out, but not in.
   // TODO(rohitrao): We do not animate on the way in because Cocoa is already
   // doing a lot of work to set up the download arrow animation.  I've chosen to
   // do no animation over janky animation.  Find a way to make animating in
   // smoother.
   AnimatableView* view = [self animatableView];
-  if (enable)
+  if (show)
     [view setHeight:maxShelfHeight_];
   else
     [view animateToNewHeight:0 duration:kDownloadShelfCloseDuration];
 
-  barIsVisible_ = enable;
+  barIsVisible_ = show;
   [self updateCloseButton];
 }
 
-- (DownloadShelf*)bridge {
-  return bridge_.get();
-}
-
-- (BOOL)isVisible {
-  return barIsVisible_;
-}
-
-- (void)show:(id)sender {
-  [self showDownloadShelf:YES];
-}
-
-- (void)hide:(id)sender {
-  [self cancelAutoCloseAndRemoveTrackingArea];
-
-  // If |sender| isn't nil, then we're being closed from the UI by the user and
-  // we need to tell our shelf implementation to close. Otherwise, we're being
-  // closed programmatically by our shelf implementation.
-  bool auto_closed = (sender == nil);
-
-  int numInProgress = 0;
-  for (NSUInteger i = 0; i < [downloadItemControllers_ count]; ++i) {
-    if ([[downloadItemControllers_ objectAtIndex:i]download]->IsInProgress())
-      ++numInProgress;
-  }
-  download_util::RecordShelfClose(
-      [downloadItemControllers_ count], numInProgress, auto_closed);
-  if (auto_closed)
-    [self showDownloadShelf:NO];
-  else
-    bridge_->Close();
-}
-
-- (void)animationDidEnd:(NSAnimation*)animation {
-  if (![self isVisible])
-    [self closed];
-}
-
-- (float)height {
-  return maxShelfHeight_;
-}
-
-// If |skipFirst| is true, the frame of the leftmost item is not set.
-- (void)layoutItems:(BOOL)skipFirst {
-  CGFloat currentX = 0;
-  for (DownloadItemController* itemController
-      in downloadItemControllers_.get()) {
-    NSRect frame = [[itemController view] frame];
-    frame.origin.x = currentX;
-    frame.size.width = [itemController preferredSize].width;
-    if (!skipFirst)
-      [[[itemController view] animator] setFrame:frame];
-    currentX += frame.size.width + kDownloadItemPadding;
-    skipFirst = NO;
-  }
-}
-
 - (void)layoutItems {
   [self layoutItems:NO];
 }
 
 - (void)addDownloadItem:(DownloadItem*)downloadItem {
   DCHECK([NSThread isMainThread]);
   [self cancelAutoCloseAndRemoveTrackingArea];
 
   // Insert new item at the left.
   scoped_nsobject<DownloadItemController> controller(
@@ skipping 42 matching lines @@
     // there's no point in animating the removal.
     [self remove:[downloadItemControllers_ lastObject]];
   }
 
   // Finally, move the remaining items to the right. Skip the first item when
   // laying out the items, so that the longer animation duration we set up above
   // is not overwritten.
   [self layoutItems:YES];
 }
 
+- (void)remove:(DownloadItemController*)download {
+  // Look for the download in our controller array and remove it. This will
+  // explicity release it so that it removes itself as an Observer of the
+  // DownloadItem. We don't want to wait for autorelease since the DownloadItem
+  // we are observing will likely be gone by then.
+  [[NSNotificationCenter defaultCenter] removeObserver:download];
+
+  // TODO(dmaclach): Remove -- http://crbug.com/25845
+  [[download view] removeFromSuperview];
+
+  [downloadItemControllers_ removeObject:download];
+  [self layoutItems];
+
+  // If there are no more downloads or if all the remaining downloads have been
+  // opened, we can close the shelf.
+  [self maybeAutoCloseAfterDelay];
+}
+
+- (void)downloadWasOpened:(DownloadItemController*)item_controller {
+  // This should only be called on the main thead.
+  DCHECK([NSThread isMainThread]);
+  [self maybeAutoCloseAfterDelay];
+}
+
+// We need to explicitly release our download controllers here since they need
+// to remove themselves as observers before the remaining shutdown happens.
+- (void)exiting {
+  [[self animatableView] stopAnimation];
+  [self cancelAutoCloseAndRemoveTrackingArea];
+  downloadItemControllers_.reset();
+}
+
+- (AnimatableView*)animatableView {
+  return static_cast<AnimatableView*>([self view]);
+}
+
+- (DownloadShelf*)bridge {
+  return bridge_.get();
+}
+
+- (BOOL)isVisible {
+  return barIsVisible_;
+}
+
+- (float)height {
+  return maxShelfHeight_;
+}
+
+// Called after the frame's rect has changed; usually when the height is
+// animated.
+- (void)viewFrameDidChange:(NSNotification*)notification {
+  // Anchor subviews at the top of |view|, so that it looks like the shelf
+  // is sliding out.
+  CGFloat newShelfHeight = NSHeight([[self view] frame]);
+  if (newShelfHeight == currentShelfHeight_)
+    return;
+
+  for (NSView* view in [[self view] subviews]) {
+    NSRect frame = [view frame];
+    frame.origin.y -= currentShelfHeight_ - newShelfHeight;
+    [view setFrame:frame];
+  }
+  currentShelfHeight_ = newShelfHeight;
+}
+
+- (void)animationDidEnd:(NSAnimation*)animation {
+  if (![self isVisible])
+    [self closed];
+}
+
+// If |skipFirst| is true, the frame of the leftmost item is not set.
+- (void)layoutItems:(BOOL)skipFirst {
+  CGFloat currentX = 0;
+  for (DownloadItemController* itemController
+      in downloadItemControllers_.get()) {
+    NSRect frame = [[itemController view] frame];
+    frame.origin.x = currentX;
+    frame.size.width = [itemController preferredSize].width;
+    if (!skipFirst)
+      [[[itemController view] animator] setFrame:frame];
+    currentX += frame.size.width + kDownloadItemPadding;
+    skipFirst = NO;
+  }
+}
+
 - (void)closed {
   // Don't remove completed downloads if the shelf is just being auto-hidden
   // rather than explicitly closed by the user.
   if (bridge_->is_hidden())
     return;
   NSUInteger i = 0;
   while (i < [downloadItemControllers_ count]) {
     DownloadItemController* itemController =
         [downloadItemControllers_ objectAtIndex:i];
     DownloadItem* download = [itemController download];
@@ skipping 13 matching lines @@
 
 - (void)mouseEntered:(NSEvent*)event {
   // If the mouse re-enters the download shelf, cancel the auto-close.  Further
   // mouse exits should not trigger autoclose, so also remove the tracking area.
   [self cancelAutoCloseAndRemoveTrackingArea];
 }
 
 - (void)mouseExited:(NSEvent*)event {
   // Cancel any previous hide requests, just to be safe.
   [NSObject cancelPreviousPerformRequestsWithTarget:self
-                                           selector:@selector(hide:)
-                                             object:self];
+                                           selector:@selector(autoClose)
+                                             object:nil];
 
   // Schedule an autoclose after a delay.  If the mouse is moved back into the
   // view, or if an item is added to the shelf, the timer will be canceled.
-  [self performSelector:@selector(hide:)
-             withObject:self
+  [self performSelector:@selector(autoClose)
+             withObject:nil
              afterDelay:kAutoCloseDelaySeconds];
 }
 
-- (BOOL)canAutoClose {
+- (void)maybeAutoCloseAfterDelay {
+  // We can close the shelf automatically if all the downloads on the shelf have
+  // been opened.
   for (NSUInteger i = 0; i < [downloadItemControllers_ count]; ++i) {
     DownloadItemController* itemController =
         [downloadItemControllers_ objectAtIndex:i];
     if (![itemController download]->GetOpened())
-      return NO;
+      return;
   }
-  return YES;
+
+  if ([self isVisible] && [downloadItemControllers_ count] > 0) {
+    // If the shelf is visible and has download items remaining on it, close the
+    // shelf after the user moves the mouse out of the download shelf.
+    [self installTrackingArea];
+  } else {
+    // We notify the DownloadShelf of our intention to close even if the shelf
+    // is currently hidden. If the shelf was temporarily hidden (e.g. because
+    // the browser window entered fullscreen mode), then this prevents the shelf
+    // from being shown again when the browser exits fullscreen mode.
+    [self autoClose];
+  }
+}
+
+- (void)autoClose {
+  bridge_->Close(DownloadShelf::AUTOMATIC);
 }
 
 - (void)installTrackingArea {
   // Install the tracking area to listen for mouseExited messages and trigger
   // the shelf autoclose.
   if (trackingArea_.get())
     return;
 
   trackingArea_.reset([[NSTrackingArea alloc]
                         initWithRect:[[self view] bounds]
                              options:NSTrackingMouseEnteredAndExited |
                                      NSTrackingActiveAlways
                                owner:self
                             userInfo:nil]);
   [[self view] addTrackingArea:trackingArea_];
 }
 
 - (void)cancelAutoCloseAndRemoveTrackingArea {
   [NSObject cancelPreviousPerformRequestsWithTarget:self
-                                           selector:@selector(hide:)
-                                             object:self];
+                                           selector:@selector(autoClose)
+                                             object:nil];
 
   if (trackingArea_.get()) {
     [[self view] removeTrackingArea:trackingArea_];
     trackingArea_.reset(nil);
   }
 }
 
 - (void)willEnterFullscreen {
   isFullscreen_ = YES;
   [self updateCloseButton];
@@ skipping 24 matching lines @@
   }
 
   // Set the tracking off to create a new tracking area for the control.
   // When changing the bounds/frame on a HoverButton, the tracking isn't updated
   // correctly, it needs to be turned off and back on.
   [hoverCloseButton_ setTrackingEnabled:NO];
   [hoverCloseButton_ setFrame:bounds];
   [hoverCloseButton_ setTrackingEnabled:YES];
 }
 @end