[Mac] Fullscreen Toolbar Bar Visibility Edge Cases

chrome/browser/ui/cocoa/fullscreen_toolbar_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_FULLSCREEN_TOOLBAR_CONTROLLER_H_
 #define CHROME_BROWSER_UI_COCOA_FULLSCREEN_TOOLBAR_CONTROLLER_H_
 
 #include <Carbon/Carbon.h>
 #import <Cocoa/Cocoa.h>
 
 #include "base/mac/mac_util.h"
 #include "chrome/browser/ui/cocoa/location_bar/location_bar_view_mac.h"
 
 @class BrowserWindowController;
 @class CrTrackingArea;
 @class DropdownAnimation;
 
-namespace fullscreen_mac {
-enum SlidingStyle {
-  OMNIBOX_TABS_PRESENT = 0,  // Tab strip and omnibox both visible.
-  OMNIBOX_TABS_HIDDEN,       // Tab strip and omnibox both hidden.
-  OMNIBOX_TABS_NONE,         // Tab strip and omnibox both hidden and never
-                             // shown.
+enum class FullscreenSlidingStyle {
+  OMNIBOX_TABS_PRESENT,  // Tab strip and omnibox both visible.
+  OMNIBOX_TABS_HIDDEN,   // Tab strip and omnibox both hidden.
+  OMNIBOX_TABS_NONE,     // Tab strip and omnibox both hidden and never
+                         // shown.
 };
-}  // namespace fullscreen_mac
+
+// State of the menubar in the window's screen.
+enum class FullscreenMenubarState {
+  SHOWN,    // Menubar is fully shown.
+  HIDDEN,   // Menubar is fully hidden.
+  SHOWING,  // Menubar is animating in.
+  HIDING,   // Menubar is animating out.
+};
 
 // Provides a controller to fullscreen toolbar for a single browser
 // window.  This class handles running animations, showing and hiding the
 // fullscreen toolbar, and managing the tracking area associated with the
 // toolbar.  This class does not directly manage any views -- the
 // BrowserWindowController is responsible for positioning and z-ordering views.
 //
 
 // TODO (spqchan): Write tests for this class. See crbug.com/640064.
 @interface FullscreenToolbarController : NSObject<NSAnimationDelegate> {
@@ skipping 29 matching lines @@
   // is not main or not fullscreen, |kFullScreenModeHideAll| while the overlay
   // is hidden, and |kFullScreenModeHideDock| while the overlay is shown.  If
   // the window is not on the primary screen, this should always be
   // |kFullScreenModeNormal|.  This value can get out of sync with the correct
   // state if we miss a notification (which can happen when a window is closed).
   // Used to track the current state and make sure we properly restore the menu
   // bar when this controller is destroyed.
   base::mac::FullScreenMode systemFullscreenMode_;
 
   // Whether the omnibox is hidden in fullscreen.
-  fullscreen_mac::SlidingStyle slidingStyle_;
+  FullscreenSlidingStyle slidingStyle_;
 
   // The fraction of the AppKit Menubar that is showing. Ranges from 0 to 1.
   // Only used in AppKit Fullscreen.
   CGFloat menubarFraction_;
 
-  // The toolbar fraction set by the menu progress.
-  CGFloat toolbarFractionFromMenuProgress_;
+  // The state of the menubar in fullscreen.
+  FullscreenMenubarState menubarState_;
 
   // A Carbon event handler that tracks the revealed fraction of the menu bar.
   EventHandlerRef menuBarTrackingHandler_;
 
   // True when the toolbar is dropped to show tabstrip changes.
   BOOL isRevealingToolbarForTabStripChanges_;
 
   // True when the toolbar should be animated back out via a DropdownAnimation.
-  // This is set and unset in hideTimer:. It's set to YES before it calls
-  // animateToolbarVisibility: and then set to NO after the animation has
-  // started.
+  // This is set and unset in hideTimer: and mouseExited:. It's set to YES
+  // before it calls animateToolbarVisibility: and then set to NO after the
+  // animation has started.
   BOOL shouldAnimateToolbarOut_;
+
+  // True when the toolbar is animating in/out for changes in the toolbar
+  // visibility locks.
+  BOOL isLockingBarVisibility_;
+  BOOL isReleasingBarVisibility_;
 }
 
-@property(nonatomic, assign) fullscreen_mac::SlidingStyle slidingStyle;
+@property(nonatomic, assign) FullscreenSlidingStyle slidingStyle;
 
 // Designated initializer.
 - (id)initWithBrowserController:(BrowserWindowController*)controller
-                          style:(fullscreen_mac::SlidingStyle)style;
+                          style:(FullscreenSlidingStyle)style;
 
 // Informs the controller that the browser has entered or exited fullscreen
 // mode. |-setupFullscreenToolbarForContentView:showDropdown:| should be called
 // after the window is setup, just before it is shown. |-exitFullscreenMode|
 // should be called before any views are moved back to the non-fullscreen
 // window.  If |-setupFullscreenToolbarForContentView:showDropdown:| is called,
 // it must be balanced with a call to |-exitFullscreenMode| before the
 // controller is released.
 - (void)setupFullscreenToolbarForContentView:(NSView*)contentView;
 - (void)exitFullscreenMode;
 
 // Returns the amount by which the floating bar should be offset downwards (to
 // avoid the menu) and by which the overlay view should be enlarged vertically.
 // Generally, this is > 0 when the window is on the primary screen and 0
 // otherwise.
 - (CGFloat)floatingBarVerticalOffset;
 
+// Shows/hides the toolbar with animation to reflect changes for the toolbar
+// visibility locks. lockBarVisibilityWithAnimation: should only be called when
+// the lock state goes from unlocked to locked. Likewise,
+// releaseBarVisibilityWithAnimation: should only be called whenthe lock state
+// goes from locked to unlocked.
+- (void)lockBarVisibilityWithAnimation:(BOOL)animate;
+- (void)releaseBarVisibilityWithAnimation:(BOOL)animate;
+
 // Informs the controller that the overlay should be shown/hidden, possibly
 // with animation.
 - (void)ensureOverlayShownWithAnimation:(BOOL)animate;
 - (void)ensureOverlayHiddenWithAnimation:(BOOL)animate;
 
 // Cancels any running animation and timers.
 - (void)cancelAnimationAndTimer;
 
 // Animates the toolbar dropping down to show changes to the tab strip.
 - (void)revealToolbarForTabStripChanges;
@@ skipping 33 matching lines @@
 @interface FullscreenToolbarController (ExposedForTesting)
 // Adjusts the AppKit Fullscreen options of the application.
 - (void)setSystemFullscreenModeTo:(base::mac::FullScreenMode)mode;
 
 // Callback for menu bar animations.
 - (void)setMenuBarRevealProgress:(CGFloat)progress;
 
 @end
 
 #endif  // CHROME_BROWSER_UI_COCOA_FULLSCREEN_TOOLBAR_CONTROLLER_H_