[Mac] Fix for fullscreen toolbar

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.
 };
 }  // namespace fullscreen_mac
 
 // Provides a controller to fullscreen toolbar for a single browser
 // window.  This class handles running animations, showing and hiding the
 // floating dropdown bar, and managing the tracking area associated with the
 // dropdown.  This class does not directly manage any views -- the
 // BrowserWindowController is responsible for positioning and z-ordering views.
 //
 // Tracking areas are disabled while animations are running.  If
 // |overlayFrameChanged:| is called while an animation is running, the
 // controller saves the new frame and installs the appropriate tracking area
 // when the animation finishes.  This is largely done for ease of
 // implementation; it is easier to check the mouse location at each animation
 // step than it is to manage a constantly-changing tracking area.
+//
+
+// The |toolbarFraction_| is usually set by |setMenuBarRevealProgress:|, which
+// is called by MenuBarRevealHandler(). This makes the toolbar show/hide in
+// sync with the menubar. However, there's an edge case that appears when the
+// sliding style is set to OMNIBOX_TABS_HIDDEN. If the user interacts with the
+// bottom half of the toolbar, the menubar will disappear and take the toolbar
+// with it. This prevents users from interacting properly with the omnibox and
+// bookmarks bar.
+//
+// To prevent the toolbar from disappearing when the user is still interacting
+// with it, we lock its visibility so that the toolbar will remain, even after
+// the menubar had disappeared. The tracking area is then used to check if the
+// user is still interacting with the toolbar. Once we receive a mouse exit
+// event, we release the visibility lock so that the toolbar can hidden by the
+// menubar (if it's still there) or via a DropdownAnimation (if the menubar is
+// gone).
+
+// TODO (spqchan): Write tests for this class. See crbug.com/640064.
 @interface FullscreenToolbarController : NSObject<NSAnimationDelegate> {
  @private
   // Our parent controller.
   BrowserWindowController* browserController_;  // weak
 
   // Whether or not we are in fullscreen mode.
   BOOL inFullscreenMode_;
 
+  // The content view for the window.  This is nil when not in fullscreen mode.
+  NSView* contentView_;  // weak
+
+  // The frame for the tracking area. The value is the toolbar overlay's frame
+  // with additional height added at the bottom.
+  NSRect trackingAreaFrame_;
+
+  // The tracking area associated with the toolbar overlay bar. This tracking
+  // area is used to keep the toolbar active if the menubar had animated out
+  // but the mouse is still on the toolbar.
+  base::scoped_nsobject<CrTrackingArea> trackingArea_;
+
   // Pointer to the currently running animation.  Is nil if no animation is
   // running.
   base::scoped_nsobject<DropdownAnimation> currentAnimation_;
 
   // Timer for scheduled hiding of the toolbar when it had been revealed for
   // tabstrip changes.
   base::scoped_nsobject<NSTimer> hideTimer_;
 
   // Tracks the currently requested system fullscreen mode, used to show or
   // hide the menubar.  This should be |kFullScreenModeNormal| when the window
@@ skipping 24 matching lines @@
   BOOL revealToolbarForTabStripChanges_;
 }
 
 @property(nonatomic, assign) fullscreen_mac::SlidingStyle slidingStyle;
 @property(nonatomic, assign) CGFloat toolbarFraction;
 
 // Designated initializer.
 - (id)initWithBrowserController:(BrowserWindowController*)controller
                           style:(fullscreen_mac::SlidingStyle)style;
 
-// Informs the controller that the browser has entered or exited presentation
+// 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)setupFullscreenToolbarWithDropdown:(BOOL)showDropdown;
+- (void)setupFullscreenToolbarForContentView:(NSView*)contentView
+                                showDropdown:(BOOL)showDropdown;
 - (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;
 
 // 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;
 
 // Returns YES if the mouse is on the window's screen. This is used to check
 // if the menubar events belong to window's screen since the menubar would
 // only be revealed if the mouse is there.
 - (BOOL)isMouseOnScreen;
 
-// Returns true if the browser is in the process of entering/exiting
+// Sets |trackingAreaFrame_| from the given overlay frame.
+- (void)setTrackingAreaFromOverlayFrame:(NSRect)frame;
+
+// Returns YES if the browser is in the process of entering/exiting
 // fullscreen.
 - (BOOL)isFullscreenTransitionInProgress;
 
+// Returns YES if the browser in in fullscreen.
+- (BOOL)isInFullscreen;
+
 @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;
 
 // Updates the local state that reflects the fraction of the toolbar area that
 // is showing. This function has the side effect of changing the AppKit
-// Fullscreen option for whether the menu bar is shown.
+// Fullscreen option for whether the menu bar is shown. If the toolbar
+// visibility is locked, the fraction will be updated to 1.0;
 - (void)changeToolbarFraction:(CGFloat)fraction;
 
 @end
 
 #endif  // CHROME_BROWSER_UI_COCOA_FULLSCREEN_TOOLBAR_CONTROLLER_H_