Split out fullscreen logic from Browser into FullscreenController.

chrome/browser/ui/browser.h

 // Copyright (c) 2011 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_BROWSER_H_
 #define CHROME_BROWSER_UI_BROWSER_H_
 #pragma once
 
 #include <map>
 #include <set>
@@ skipping 16 matching lines @@
 #include "chrome/browser/sessions/tab_restore_service_observer.h"
 #include "chrome/browser/sync/profile_sync_service_observer.h"
 #include "chrome/browser/tabs/tab_handler.h"
 #include "chrome/browser/tabs/tab_strip_model_delegate.h"  // TODO(beng): remove
 #include "chrome/browser/tabs/tab_strip_model_observer.h"  // TODO(beng): remove
 #include "chrome/browser/ui/blocked_content/blocked_content_tab_helper_delegate.h"
 #include "chrome/browser/ui/bookmarks/bookmark_bar.h"
 #include "chrome/browser/ui/bookmarks/bookmark_tab_helper_delegate.h"
 #include "chrome/browser/ui/browser_navigator.h"
 #include "chrome/browser/ui/constrained_window_tab_helper_delegate.h"
+#include "chrome/browser/ui/fullscreen_controller.h"
 #include "chrome/browser/ui/fullscreen_exit_bubble_type.h"
 #include "chrome/browser/ui/search_engines/search_engine_tab_helper_delegate.h"
 #include "chrome/browser/ui/select_file_dialog.h"
 #include "chrome/browser/ui/tab_contents/tab_contents_wrapper_delegate.h"
 #include "chrome/browser/ui/toolbar/toolbar_model.h"
 #include "chrome/common/content_settings.h"
 #include "chrome/common/content_settings_types.h"
 #include "chrome/common/extensions/extension_constants.h"
 #include "content/browser/tab_contents/page_navigator.h"
 #include "content/browser/tab_contents/tab_contents_delegate.h"
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/common/page_transition_types.h"
 #include "content/public/common/page_zoom.h"
 #include "ui/base/ui_base_types.h"
 #include "ui/gfx/rect.h"
 
 class BrowserSyncedWindowDelegate;
 class BrowserTabRestoreServiceDelegate;
 class BrowserWindow;
 class Extension;
 class FindBarController;
+class FullscreenController;
 class HtmlDialogUIDelegate;
 class InstantController;
 class InstantUnloadHandler;
 class PrefService;
 class Profile;
 class SessionStorageNamespace;
 class SkBitmap;
 class StatusBubble;
 class TabNavigation;
 class TabStripModel;
@@ skipping 147 matching lines @@
   // this Browser.
   InstantController* instant() const { return instant_.get(); }
 
 #if defined(UNIT_TEST)
   // Sets the BrowserWindow. This is intended for testing and generally not
   // useful outside of testing. Use CreateBrowserWindow outside of testing, or
   // the static convenience methods that create a BrowserWindow for you.
   void set_window(BrowserWindow* window) {
     DCHECK(!window_);
     window_ = window;
+    fullscreen_controller_ = new FullscreenController(window_, profile_, this);
   }
 #endif
 
   // |window()| will return NULL if called before |CreateBrowserWindow()|
   // is done.
   BrowserWindow* window() const { return window_; }
   ToolbarModel* toolbar_model() { return &toolbar_model_; }
   const SessionID& session_id() const { return session_id_; }
   CommandUpdater* command_updater() { return &command_updater_; }
   bool block_command_execution() const { return block_command_execution_; }
@@ skipping 257 matching lines @@
   void ShowSingletonTabOverwritingNTP(const browser::NavigateParams& params);
 
   // Creates a NavigateParams struct for a singleton tab navigation.
   browser::NavigateParams GetSingletonTabNavigateParams(const GURL& url);
 
   // Invoked when the fullscreen state of the window changes.
   // BrowserWindow::EnterFullscreen invokes this after the window has become
   // fullscreen.
   void WindowFullscreenStateChanged();
 
-  // Sends a notification that the fullscreen state has changed.
-  void NotifyFullscreenChange();
-
   // Assorted browser commands ////////////////////////////////////////////////
 
   // NOTE: Within each of the following sections, the IDs are ordered roughly by
   // how they appear in the GUI/menus (left to right, top to bottom, etc.).
 
   // Navigation commands
   bool CanGoBack() const;
   void GoBack(WindowOpenDisposition disposition);
   bool CanGoForward() const;
   void GoForward(WindowOpenDisposition disposition);
@@ skipping 316 matching lines @@
                         int from_index,
                         int to_index);
   virtual void TabReplacedAt(TabStripModel* tab_strip_model,
                              TabContentsWrapper* old_contents,
                              TabContentsWrapper* new_contents,
                              int index);
   virtual void TabPinnedStateChanged(TabContentsWrapper* contents, int index);
   virtual void TabStripEmpty();
 
   // Fullscreen permission infobar callbacks.
+  // TODO(koz): Remove this and have callers call FullscreenController directly.

[Peter Kasting, 2011/11/21 19:17:46]

This is probably also what we should do for ToggleFullscreenMode(),
TogglePresentationMode(), IsFullscreenForTab(), the mouse-lock-related methods,
and any other fullscreen methods on this class -- just provide an accessor to
the fullscreen controller and no other passthrough methods.

   void OnAcceptFullscreenPermission(const GURL& url,
                                     FullscreenExitBubbleType bubble_type);
   void OnDenyFullscreenPermission(FullscreenExitBubbleType bubble_type);
-  ContentSetting GetFullscreenSetting(const GURL& url);
-  ContentSetting GetMouseLockSetting(const GURL& url);
 
   // Figure out if there are tabs that have beforeunload handlers.
   bool TabsNeedBeforeUnloadFired();
 
   bool is_type_tabbed() const { return type_ == TYPE_TABBED; }
   bool is_type_popup() const { return type_ == TYPE_POPUP; }
   bool is_type_panel() const { return type_ == TYPE_PANEL; }
 
   bool is_app() const;
   bool is_devtools() const;
 
   // True when the current tab is in fullscreen mode, requested by
   // webkitRequestFullScreen.
-  bool is_fullscreen_for_tab() const { return fullscreened_tab_ != NULL; }
+  bool IsFullscreenForTab() const;
 
   // Called each time the browser window is shown.
   void OnWindowDidShow();
 
  protected:
   // Wrapper for the factory method in BrowserWindow. This allows subclasses to
   // set their own window.
   virtual BrowserWindow* CreateBrowserWindow();
 
  private:
@@ skipping 37 matching lines @@
     // Change is the result of the bookmark bar pref changing.
     BOOKMARK_BAR_STATE_CHANGE_PREF_CHANGE,
 
     // Change is the result of a state change in the active tab.
     BOOKMARK_BAR_STATE_CHANGE_TAB_STATE,
 
     // Change is the result of window toggling in/out of fullscreen mode.
     BOOKMARK_BAR_STATE_CHANGE_TOGGLE_FULLSCREEN,
   };
 
-  enum MouseLockState {
-    MOUSELOCK_NOT_REQUESTED,
-    // The page requests to lock the mouse and the user hasn't responded to the
-    // request.
-    MOUSELOCK_REQUESTED,
-    // Mouse lock has been allowed by the user.
-    MOUSELOCK_ACCEPTED
-  };
-
   // Overridden from TabContentsDelegate:
   // Deprecated. Please use two-argument variant.
   // TODO(adriansc): Remove this method once refactoring changed all call sites.
   virtual TabContents* OpenURLFromTab(
       TabContents* source,
       const GURL& url,
       const GURL& referrer,
       WindowOpenDisposition disposition,
       content::PageTransition transition) OVERRIDE;
   virtual TabContents* OpenURLFromTab(TabContents* source,
@@ skipping 231 matching lines @@
   // this to return NULL if called before the toolbar has initialized.
   // TODO(beng): remove this.
   StatusBubble* GetStatusBubble();
 
   // Session restore functions ////////////////////////////////////////////////
 
   // Notifies the history database of the index for all tabs whose index is
   // >= index.
   void SyncHistoryWithTabs(int index);
 
-  // Tab fullscreen functions /////////////////////////////////////////////////
-
-  // There are two different kinds of fullscreen mode - "tab fullscreen" and
-  // "browser fullscreen". "Tab fullscreen" refers to when a tab enters
-  // fullscreen mode via the JS fullscreen API, and "browser fullscreen"
-  // refers to the user putting the browser itself into fullscreen mode from
-  // the UI. The difference is that tab fullscreen has implications for how
-  // the contents of the tab render (eg: a video element may grow to consume
-  // the whole tab), whereas browser fullscreen mode doesn't. Therefore if a
-  // user forces an exit from fullscreen, we need to notify the tab so it can
-  // stop rendering in its fullscreen mode.
-
-  // Make the current tab exit fullscreen mode if it is in it.
-  void ExitTabbedFullscreenModeIfNecessary();
-
-  // Notifies the tab that it has been forced out of fullscreen mode if
-  // necessary.
-  void NotifyTabOfFullscreenExitIfNecessary();
-
   // OnBeforeUnload handling //////////////////////////////////////////////////
 
   typedef std::set<TabContents*> UnloadListenerSet;
 
   // Processes the next tab that needs it's beforeunload/unload event fired.
   void ProcessPendingTabs();
 
   // Whether we've completed firing all the tabs' beforeunload/unload events.
   bool HasCompletedUnloadProcessing() const;
 
@@ skipping 99 matching lines @@
   void OpenBookmarkManagerWithHash(const std::string& action, int64 node_id);
 
   // Make the current tab exit fullscreen mode. If the browser was fullscreen
   // because of that (as opposed to the user clicking the fullscreen button)
   // then take the browser out of fullscreen mode as well.
   void ExitTabbedFullscreenMode();
 
   // Notifies the tab that it has been forced out of fullscreen mode.
   void NotifyTabOfFullscreenExit();
 
-  // Determines what should be shown in the fullscreen exit bubble.
-  FullscreenExitBubbleType GetFullscreenExitBubbleType() const;
-
-  // Updates the content of the fullscreen exit bubble.
-  void UpdateFullscreenExitBubbleContent();
-
   // Data members /////////////////////////////////////////////////////////////
 
   content::NotificationRegistrar registrar_;
 
   PrefChangeRegistrar profile_pref_registrar_;
 
   PrefChangeRegistrar local_pref_registrar_;
 
   // This Browser's type.
   const Type type_;
@@ skipping 120 matching lines @@
   scoped_ptr<BrowserTabRestoreServiceDelegate> tab_restore_service_delegate_;
 
   // Helper which implements the SyncedWindowDelegate interface.
   scoped_ptr<BrowserSyncedWindowDelegate> synced_window_delegate_;
 
   scoped_ptr<InstantController> instant_;
   scoped_ptr<InstantUnloadHandler> instant_unload_handler_;
 
   BookmarkBar::State bookmark_bar_state_;
 
-  // If there is currently a tab in fullscreen mode (entered via
-  // webkitRequestFullScreen), this is its wrapper.
-  TabContentsWrapper* fullscreened_tab_;
-
-  // True if the current tab entered fullscreen mode via webkitRequestFullScreen
-  bool tab_caused_fullscreen_;
-  // True if tab fullscreen has been allowed, either by settings or by user
-  // clicking the allow button on the fullscreen infobar.
-  bool tab_fullscreen_accepted_;
-
-  MouseLockState mouse_lock_state_;
+  scoped_refptr<FullscreenController> fullscreen_controller_;

[Peter Kasting, 2011/11/21 19:17:46]

Why is this a refcounted object?  It seems like a standard scoped_ptr would be
fine.

 
   // True if the browser window has been shown at least once.
   bool window_has_shown_;
 
   DISALLOW_COPY_AND_ASSIGN(Browser);
 };
 
 #endif  // CHROME_BROWSER_UI_BROWSER_H_