[Mac] Refactor Cocoa fullscreen code

chrome/browser/ui/cocoa/browser_window_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_BROWSER_WINDOW_CONTROLLER_H_
 #define CHROME_BROWSER_UI_COCOA_BROWSER_WINDOW_CONTROLLER_H_
 
 // A class acting as the Objective-C controller for the Browser
 // object. Handles interactions between Cocoa and the cross-platform
 // code. Each window has a single toolbar and, by virtue of being a
@@ skipping 31 matching lines @@
 class ExclusiveAccessController;
 class ExclusiveAccessContext;
 @class FindBarCocoaController;
 @class FullscreenModeController;
 @class FullscreenWindow;
 class FullscreenLowPowerCoordinatorCocoa;
 @class InfoBarContainerController;
 class LocationBarViewMac;
 @class OverlayableContentsController;
 class PermissionBubbleCocoa;
-@class PresentationModeController;
+@class FullscreenToolbarController;
 class StatusBubbleMac;
 @class TabStripController;
 @class TabStripView;
 @class ToolbarController;
 @class TranslateBubbleController;
 
 namespace content {
 class WebContents;
 }
 
@@ skipping 15 matching lines @@
   std::unique_ptr<BrowserWindowCocoa> windowShim_;
   base::scoped_nsobject<ToolbarController> toolbarController_;
   base::scoped_nsobject<TabStripController> tabStripController_;
   base::scoped_nsobject<FindBarCocoaController> findBarCocoaController_;
   base::scoped_nsobject<InfoBarContainerController> infoBarContainerController_;
   base::scoped_nsobject<DownloadShelfController> downloadShelfController_;
   base::scoped_nsobject<BookmarkBarController> bookmarkBarController_;
   base::scoped_nsobject<DevToolsController> devToolsController_;
   base::scoped_nsobject<OverlayableContentsController>
       overlayableContentsController_;
-  base::scoped_nsobject<PresentationModeController> presentationModeController_;
+  base::scoped_nsobject<FullscreenToolbarController>
+      fullscreenToolbarController_;
   std::unique_ptr<ExclusiveAccessController> exclusiveAccessController_;
   base::scoped_nsobject<BrowserWindowFullscreenTransition>
       fullscreenTransition_;
   std::unique_ptr<FullscreenLowPowerCoordinatorCocoa>
       fullscreenLowPowerCoordinator_;
 
   // Strong. StatusBubble is a special case of a strong reference that
   // we don't wrap in a scoped_ptr because it is acting the same
   // as an NSWindowController in that it wraps a window that must
   // be shut down before our destructors are called.
@@ skipping 71 matching lines @@
   // True if AppKit has finished exiting fullscreen before the exit animation
   // is completed. This flag is used to ensure that |windowDidExitFullscreen|
   // is called after the exit fullscreen animation is complete.
   BOOL appKitDidExitFullscreen_;
 
   // The size of the original (non-fullscreen) window.  This is saved just
   // before entering fullscreen mode and is only valid when |-isFullscreen|
   // returns YES.
   NSRect savedRegularWindowFrame_;
 
-  // The proportion of the floating bar which is shown (in presentation mode).
+  // The proportion of the floating bar which is shown.
   CGFloat floatingBarShownFraction_;
 
   // Various UI elements/events may want to ensure that the floating bar is
   // visible (in presentation mode), e.g., because of where the mouse is or
   // where keyboard focus is. Whenever an object requires bar visibility, it has
   // itself added to |barVisibilityLocks_|. When it no longer requires bar
   // visibility, it has itself removed.
   base::scoped_nsobject<NSMutableSet> barVisibilityLocks_;
 
   // Bar visibility locks and releases only result (when appropriate) in changes
@@ skipping 203 matching lines @@
 - (void)setAlertState:(TabAlertState)alertState;
 
 // Returns current alert state, determined by the alert state of tabs, set by
 // UpdateAlertState.
 - (TabAlertState)alertState;
 
 @end  // @interface BrowserWindowController
 
 
 // Methods having to do with the window type (normal/popup/app, and whether the
-// window has various features; fullscreen and presentation mode methods are
-// separate).
+// window has various features.
 @interface BrowserWindowController(WindowType)
 
 // Determines whether this controller's window supports a given feature (i.e.,
 // whether a given feature is or can be shown in the window).
 // TODO(viettrungluu): |feature| is really should be |Browser::Feature|, but I
 // don't want to include browser.h (and you can't forward declare enums).
 - (BOOL)supportsWindowFeature:(int)feature;
 
 // Called to check whether or not this window has a normal title bar (YES if it
 // does, NO otherwise). (E.g., normal browser windows do not, pop-ups do.)
@@ skipping 30 matching lines @@
 // Fullscreen terminology:
 //
 // ----------------------------------------------------------------------------
 // There are 2 APIs that cause the window to get resized, and possibly move
 // spaces.
 //
 // + AppKitFullscreen API: AppKit touts a feature known as "fullscreen". This
 // involves moving the current window to a different space, and resizing the
 // window to take up the entire size of the screen.
 //
-// + Immersive fullscreen: An alternative to AppKitFullscreen API. Uses on 10.6
-// (before AppKitFullscreen API was available), and on certain HTML/Flash
-// content. This is a method defined by Chrome.
+// + Immersive fullscreen: An alternative to AppKitFullscreen API. Uses on 10.9
+//  on certain HTML/Flash content. This is a method defined by Chrome.
 //
 // The Immersive fullscreen API can be called after the AppKitFullscreen API.
 // Calling the AppKitFullscreen API while immersive fullscreen API has been
 // invoked causes all fullscreen modes to exit.
 //
 // ----------------------------------------------------------------------------
 // There are 3 "styles" of omnibox sliding.
 // + OMNIBOX_TABS_PRESENT: Both the omnibox and the tabstrip are present.
 // Moving the cursor to the top causes the menubar to appear, and everything
 // else to slide down.
 // + OMNIBOX_TABS_HIDDEN: Both tabstrip and omnibox are hidden. Moving cursor
 // to top shows tabstrip, omnibox, and menu bar.
 // + OMNIBOX_TABS_NONE: Both tabstrip and omnibox are hidden. Moving cursor
 // to top causes the menubar to appear, but not the tabstrip and omnibox.
 //
 // The omnibox sliding styles are used in conjunction with the fullscreen APIs.
 // There is exactly 1 sliding style active at a time. The sliding is mangaged
-// by the presentationModeController_. (poorly named).
+// by the fullscreenToolbarController_.
 //
 // ----------------------------------------------------------------------------
 // There are several "fullscreen modes" bantered around. Technically, any
 // fullscreen API can be combined with any sliding style.
 //
 // + System fullscreen***deprecated***: This term is confusing. Don't use it.
 // It either refers to the AppKitFullscreen API, or the behavior that users
 // expect to see when they click the fullscreen button, or some Chrome specific
 // implementation that uses the AppKitFullscreen API.
 //
 // + Canonical Fullscreen: When a user clicks on the fullscreen button, they
 // expect a fullscreen behavior similar to other AppKit apps.
-//  - AppKitFullscreen API + OMNIBOX_TABS_PRESENT.
+//  - AppKitFullscreen API + OMNIBOX_TABS_PRESENT/OMNIBOX_TABS_HIDDEN.
 //  - The button click directly invokes the AppKitFullscreen API. This class
 //  get a callback, and calls adjustUIForOmniboxFullscreen.
 //  - There is a menu item that is intended to invoke the same behavior. When
 //  the user clicks the menu item, or use its hotkey, this class invokes the
 //  AppKitFullscreen API.
 //
-// + Presentation Mode:
-//  - OMNIBOX_TABS_HIDDEN, typically with AppKitFullscreen API, but can
-//  also be with Immersive fullscreen API.
-//  - This class sets a flag, indicating that it wants Presentation Mode
-//  instead of Canonical Fullscreen. Then it invokes the AppKitFullscreen API.
-//
-// + HTML5 fullscreen. <-- Currently uses AppKitFullscreen API. This should
-// eventually migrate to the Immersive Fullscreen API.
+// + HTML5 fullscreen. Uses AppKitFullscreen in 10.10+, otherwise Immersive.
 //
 // There are more fullscreen styles on OSX than other OSes. However, all OSes
 // share the same cross-platform code for entering fullscreen
 // (FullscreenController). It is important for OSX fullscreen logic to track
 // how the user triggered fullscreen mode.
 // There are currently 5 possible mechanisms:
 //   - User clicks the AppKit Fullscreen button.
 //     -- This invokes -[BrowserWindowController windowWillEnterFullscreen:]
 //   - User selects the menu item "Enter Full Screen".
 //     -- This invokes FullscreenController::ToggleFullscreenModeInternal(
-//        BROWSER_WITH_CHROME)
-//   - User selects the menu item "Enter Presentation Mode".
-//     -- This invokes FullscreenController::ToggleFullscreenModeInternal(
 //        BROWSER)
-//     -- The corresponding URL will be empty.
 //   - User requests fullscreen via an extension.
 //     -- This invokes FullscreenController::ToggleFullscreenModeInternal(
 //        BROWSER)
 //     -- The corresponding URL will be the url of the extension.
 //   - User requests fullscreen via Flash or JavaScript apis.
 //     -- This invokes FullscreenController::ToggleFullscreenModeInternal(
 //        BROWSER)
 //     -- browser_->fullscreen_controller()->
 //        IsWindowFullscreenForTabOrPending() returns true.
 //     -- The corresponding URL will be the url of the web page.
 
-// Methods having to do with fullscreen and presentation mode.
+// Methods having to do with fullscreen mode.
 @interface BrowserWindowController(Fullscreen)
 
-// Toggles fullscreen mode.  Meant to be called by Lion windows when they enter
-// or exit Lion fullscreen mode.  Must not be called on Snow Leopard or earlier.
-- (void)handleLionToggleFullscreen;
-
 // Enters Browser AppKit Fullscreen.
 - (void)enterBrowserFullscreen;
 
 // Updates the UI for tab fullscreen by adding or removing the tab strip and
 // toolbar from the current window. The window must already be in fullscreen.
 - (void)updateUIForTabFullscreen:
     (ExclusiveAccessContext::TabFullscreenState)state;
 
 // Exits extension fullscreen if we're currently in the mode. Returns YES
 // if we exited fullscreen.
@@ skipping 21 matching lines @@
 - (void)enterWebContentFullscreen;
 
 // Exits the current fullscreen mode.
 - (void)exitAnyFullscreen;
 
 // Called by BrowserWindowFullscreenTransition when the exit animation is
 // finished.
 - (void)exitFullscreenAnimationFinished;
 
 // Resizes the fullscreen window to fit the screen it's currently on.  Called by
-// the PresentationModeController when there is a change in monitor placement or
-// resolution.
+// the FullscreenToolbarController when there is a change in monitor placement
+// or resolution.
 - (void)resizeFullscreenWindow;
 
 // Query/lock/release the requirement that the tab strip/toolbar/attached
 // bookmark bar bar cluster is visible (e.g., when one of its elements has
 // focus). This is required for the floating bar in presentation mode, but
 // should also be called when not in presentation mode; see the comments for
 // |barVisibilityLocks_| for more details. Double locks/releases by the same
 // owner are ignored. If |animate:| is YES, then an animation may be performed,
 // possibly after a small delay if |delay:| is YES. If |animate:| is NO,
 // |delay:| will be ignored. In the case of multiple calls, later calls have
@@ skipping 52 matching lines @@
 // Gets the rect, in window base coordinates, that the omnibox popup should be
 // positioned relative to.
 - (NSRect)omniboxPopupAnchorRect;
 
 // Returns the flag |blockLayoutSubviews_|.
 - (BOOL)isLayoutSubviewsBlocked;
 
 // Returns the active tab contents controller's |blockFullscreenResize_| flag.
 - (BOOL)isActiveTabContentsControllerResizeBlocked;
 
-// Returns the presentation mode controller.
-- (PresentationModeController*)presentationModeController;
+// Returns the fullscreen toolbar controller.
+- (FullscreenToolbarController*)fullscreenToolbarController;
 
-// Sets the presentation mode controller.
-- (void)setPresentationModeController:(PresentationModeController*)controller;
+// Sets the fullscreen toolbar controller.
+- (void)setFullscreenToolbarController:(FullscreenToolbarController*)controller;
 
 @end  // @interface BrowserWindowController (TestingAPI)
 
 
 #endif  // CHROME_BROWSER_UI_COCOA_BROWSER_WINDOW_CONTROLLER_H_