[Mac] Fullscreen Toolbar Edge Cases

chrome/browser/ui/cocoa/fullscreen_toolbar_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/fullscreen_toolbar_controller.h"
 
 #include <algorithm>
 
 #include "base/command_line.h"
 #import "base/mac/mac_util.h"
@@ skipping 173 matching lines @@
 @implementation FullscreenToolbarController
 
 @synthesize slidingStyle = slidingStyle_;
 
 - (id)initWithBrowserController:(BrowserWindowController*)controller
                           style:(fullscreen_mac::SlidingStyle)style {
   if ((self = [super init])) {
     browserController_ = controller;
     systemFullscreenMode_ = base::mac::kFullScreenModeNormal;
     slidingStyle_ = style;
+    menubarState_ = fullscreen_mac::MENUBAR_HIDDEN;
   }
 
   // Install the Carbon event handler for the menubar show, hide and
   // undocumented reveal event.
   EventTypeSpec eventSpecs[3];
 
   eventSpecs[0].eventClass = kEventClassMenu;
   eventSpecs[0].eventKind = kMenuBarRevealEventKind;
 
   eventSpecs[1].eventClass = kEventClassMenu;
@@ skipping 56 matching lines @@
 }
 
 - (void)windowDidResignMain:(NSNotification*)notification {
   [self updateMenuBarAndDockVisibility];
 }
 
 - (CGFloat)floatingBarVerticalOffset {
   return kFloatingBarVerticalOffset;
 }
 
+- (void)lockBarVisibilityWithAnimation:(BOOL)animate {
+  isLockingBarVisibility_ = YES;
+  [self ensureOverlayShownWithAnimation:animate];
+  isLockingBarVisibility_ = NO;
+}
+
+- (void)releaseBarVisibilityWithAnimation:(BOOL)animate {
+  isReleasingBarVisibility_ = YES;
+  [self ensureOverlayHiddenWithAnimation:animate];
+  isReleasingBarVisibility_ = NO;
+}
+
 - (void)ensureOverlayShownWithAnimation:(BOOL)animate {
   if (!inFullscreenMode_)
     return;
 
   if (base::CommandLine::ForCurrentProcess()->HasSwitch(switches::kKioskMode))
     return;
 
   if (self.slidingStyle != fullscreen_mac::OMNIBOX_TABS_HIDDEN)
     return;
 
   [self cancelHideTimer];
   [self animateToolbarVisibility:YES];
 }
 
 - (void)ensureOverlayHiddenWithAnimation:(BOOL)animate {
   if (!inFullscreenMode_)
     return;
 
   if (self.slidingStyle != fullscreen_mac::OMNIBOX_TABS_HIDDEN)
     return;
 
+  if ([browserController_ isBarVisibilityLockedForOwner:nil])
+    return;
+
+  if ([self mouseInsideTrackingArea] ||
+      menubarState_ == fullscreen_mac::MENUBAR_SHOWN) {
+    return;
+  }
+
   [self cancelHideTimer];
   [self animateToolbarVisibility:NO];
 }
 
 - (void)cancelAnimationAndTimer {
   [self cancelHideTimer];
   [currentAnimation_ stopAnimation];
   currentAnimation_.reset();
 }
 
@@ skipping 23 matching lines @@
 }
 
 - (void)mouseEntered:(NSEvent*)event {
   // Empty implementation. Required for CrTrackingArea.
 }
 
 - (void)mouseExited:(NSEvent*)event {
   DCHECK(inFullscreenMode_);
   DCHECK_EQ([event trackingArea], trackingArea_.get());
 
+  if ([browserController_ isBarVisibilityLockedForOwner:nil])
+    return;
+
   // If the menubar is gone, animate the toolbar out.
-  if (IsCGFloatEqual(menubarFraction_, kHideFraction))
+  if (menubarState_ == fullscreen_mac::MENUBAR_HIDDEN)
     [self ensureOverlayHiddenWithAnimation:YES];
 
   [self removeTrackingAreaIfNecessary];
 }
 
 - (void)updateToolbar {
   [browserController_ layoutSubviews];
 
   // In AppKit fullscreen, moving the mouse to the top of the screen toggles
   // menu visibility. Replicate the same effect for immersive fullscreen.
@@ skipping 15 matching lines @@
 - (CGFloat)menubarOffset {
   if ([browserController_ isInAppKitFullscreen])
     return -std::floor(menubarFraction_ * [self floatingBarVerticalOffset]);
 
   return [self shouldShowMenubarInImmersiveFullscreen]
              ? -[self floatingBarVerticalOffset]
              : 0;
 }
 
 - (CGFloat)toolbarFraction {
-  if ([browserController_ isBarVisibilityLockedForOwner:nil])
-    return kShowFraction;
-
   if (base::CommandLine::ForCurrentProcess()->HasSwitch(switches::kKioskMode))
     return kHideFraction;
 
   switch (slidingStyle_) {
     case fullscreen_mac::OMNIBOX_TABS_PRESENT:
       return kShowFraction;
     case fullscreen_mac::OMNIBOX_TABS_NONE:
       return kHideFraction;
     case fullscreen_mac::OMNIBOX_TABS_HIDDEN:
+      if (menubarState_ == fullscreen_mac::MENUBAR_SHOWN  ||
+          menubarState_ == fullscreen_mac::MENUBAR_SHOWING) {
+        return toolbarFractionFromMenuProgress_;
+      }
+
+      if (isLockingBarVisibility_)
+        return kHideFraction;
+      else if (isReleasingBarVisibility_)
+        return kShowFraction;
+      else if ([browserController_ isBarVisibilityLockedForOwner:nil])
+        return kShowFraction;
+
       if (currentAnimation_.get())
         return [currentAnimation_ toolbarFraction];
 
       if (hideTimer_.get() || shouldAnimateToolbarOut_)
         return kShowFraction;
 
       return toolbarFractionFromMenuProgress_;

[erikchen, 2016/09/07 21:58:49]

I think that there is a logic error here. If the user moves the mouse to the top
of the screen, the menubar and toolbar show, toolbarFractionFromMenuProgress_
gets set to 1. The user moves the mouse onto the toolbar, which causes the
menubar to disappear, but toolbarFractionFromMenuProgress_ stays at 1. Now the
user moves the mouse off of the toolbar. During the disappearing animation, we
return an appropriate fraction. Once the animation finishes, the logic falls
through to this line, which returns 1, when we want it to return 0.

I think that if you add another condition:

if (tracking area && [self mouseInsideTrackingArea])
  return kShowFraction

Then you can get rid of toolbarFractionFromMenuProgress_ and use menuProgress_
everywhere.

[spqchan, 2016/09/08 01:49:41]

Done.

   }
 }
 
 - (BOOL)isFullscreenTransitionInProgress {
   return [browserController_ isFullscreenTransitionInProgress];
 }
 
 - (BOOL)isInFullscreen {
   return inFullscreenMode_;
 }
@@ skipping 35 matching lines @@
   [self animationDidStop:animation];
   [self setupTrackingArea];
 }
 
 - (void)setMenuBarRevealProgress:(CGFloat)progress {
   // If the menubarFraction increases, check if we are in the right screen
   // so that the toolbar is not revealed on the wrong screen.
   if (![self isMouseOnScreen] && progress > menubarFraction_)
     return;
 
+  if (IsCGFloatEqual(progress, kShowFraction))
+    menubarState_ = fullscreen_mac::MENUBAR_SHOWN;
+  else if (IsCGFloatEqual(progress, kHideFraction))
+    menubarState_ = fullscreen_mac::MENUBAR_HIDDEN;
+  else if (progress < menubarFraction_)
+    menubarState_ = fullscreen_mac::MENUBAR_HIDING;
+  else if (progress > menubarFraction_)
+    menubarState_ = fullscreen_mac::MENUBAR_SHOWING;
+
   menubarFraction_ = progress;
 
-  if (self.slidingStyle == fullscreen_mac::OMNIBOX_TABS_HIDDEN) {
-    if (IsCGFloatEqual(menubarFraction_, kShowFraction))
+  if (slidingStyle_ == fullscreen_mac::OMNIBOX_TABS_HIDDEN) {
+    if (menubarState_ == fullscreen_mac::MENUBAR_SHOWN)
       [self setupTrackingArea];
 
-    // If the menubar is disappearing from the screen, check if the mouse
-    // is still interacting with the toolbar. If it is, don't set
+    // If the menubar is in the process of hiding from the screen, check if
+    // the user is still interacting with the toolbar. If not, don't set
     // |toolbarFractionFromMenuProgress_| so that the the toolbar will remain
     // on the screen.
-    BOOL isMenuBarDisappearing =
-        menubarFraction_ < toolbarFractionFromMenuProgress_;
-    if (!(isMenuBarDisappearing && [self mouseInsideTrackingArea]))
+    BOOL isMenubarGoneOrDisappear =
+        menubarState_ == fullscreen_mac::MENUBAR_HIDING ||
+        menubarState_ == fullscreen_mac::MENUBAR_HIDDEN;
+    BOOL isToolbarFocused =
+        [self mouseInsideTrackingArea] ||
+        [browserController_ isBarVisibilityLockedForOwner:nil];
+    if (!(isMenubarGoneOrDisappear && isToolbarFocused))
       toolbarFractionFromMenuProgress_ = progress;
   }
 
   // If an animation is not running, then -layoutSubviews will not be called
   // for each tick of the menu bar reveal. Do that manually.
   // TODO(erikchen): The animation is janky. layoutSubviews need a refactor so
   // that it calls setFrameOffset: instead of setFrame: if the frame's size has
   // not changed.
   if (!currentAnimation_.get())
     [browserController_ layoutSubviews];
@@ skipping 132 matching lines @@
 
   // No more calls back up to the BWC.
   browserController_ = nil;
 }
 
 - (BOOL)shouldShowMenubarInImmersiveFullscreen {
   return [self doesScreenHaveMenuBar] && [self toolbarFraction] > 0.99;
 }
 
 @end