[Mac] Refactor the Fullscreen Toolbar Visibility Locks

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 FullscreenMenubarTracker;
 class FullscreenToolbarAnimationController;
 @class FullscreenToolbarMouseTracker;
+@class FullscreenToolbarVisibilityLockController;
 
 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.
 };
 
 // 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 {
  @private
   // Our parent controller.
   BrowserWindowController* browserController_;  // weak
 
   // Whether or not we are in fullscreen mode.
   BOOL inFullscreenMode_;
 
   // Updates the fullscreen toolbar layout for changes in the menubar. This
   // object is only set when the browser is in fullscreen mode.
   base::scoped_nsobject<FullscreenMenubarTracker> menubarTracker_;
 
+  // Maintains the toolbar's visibility locks for the
+  // OMNIBOX_TABS_HIDDEN style.
+  base::scoped_nsobject<FullscreenToolbarVisibilityLockController>
+      visibilityLockController_;
+
   // Manages the toolbar animations for the OMNIBOX_TABS_HIDDEN style.
   std::unique_ptr<FullscreenToolbarAnimationController> animationController_;
 
   // Mouse tracker to track the user's interactions with the toolbar. This
   // object is only set when the browser is in fullscreen mode.
   base::scoped_nsobject<FullscreenToolbarMouseTracker> mouseTracker_;
 
   // Tracks the currently requested system fullscreen mode, used to show or
   // hide the menubar.  This should be |kFullScreenModeNormal| when the window
   // is not main or not fullscreen, |kFullScreenModeHideAll| while the overlay
@@ skipping 18 matching lines @@
 // 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)enterFullscreenMode;
 - (void)exitFullscreenMode;
 
-// 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;
 
 // In any fullscreen mode, the y offset to use for the content at the top of
 // the screen (tab strip, omnibox, bookmark bar, etc).
 // Ranges from 0 to -22.
 - (CGFloat)menubarOffset;
@@ skipping 21 matching lines @@
 
 // Returns YES if the browser in in fullscreen.
 - (BOOL)isInFullscreen;
 
 // Updates the toolbar by updating the layout, menubar and dock.
 - (void)updateToolbar;
 
 // Returns |browserController_|.
 - (BrowserWindowController*)browserWindowController;
 
+// Returns the object in |visibilityLockController_|;
+- (FullscreenToolbarVisibilityLockController*)visibilityLockController;
+
 @end
 
 // Private methods exposed for testing.
 @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_