Windowed mode mouse lock addded to fullscreen controller.

chrome/browser/ui/fullscreen_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_FULLSCREEN_CONTROLLER_H_
 #define CHROME_BROWSER_UI_FULLSCREEN_CONTROLLER_H_
 #pragma once
 
 #include "base/basictypes.h"
 #include "base/memory/ref_counted.h"
@@ skipping 74 matching lines @@
     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
   };
 
   virtual ~FullscreenController();
 
-  // Notifies the tab that it has been forced out of fullscreen mode if
-  // necessary.
-  void NotifyTabOfFullscreenExitIfNecessary();
+  // Notifies the tab that it has been forced out of fullscreen and mouse lock
+  // mode if necessary.
+  void NotifyTabOfExitIfNecessary();
+
   // Make the current tab exit fullscreen mode if it is in it.
   void ExitTabbedFullscreenModeIfNecessary();
   void UpdateFullscreenExitBubbleContent();
   void NotifyFullscreenChange();
+  void NotifyMouseLockChange();
   ContentSetting GetFullscreenSetting(const GURL& url) const;
   ContentSetting GetMouseLockSetting(const GURL& url) const;
 
 #if defined(OS_MACOSX)
   void TogglePresentationModeInternal(bool for_tab);
 #endif
   // TODO(koz): Change |for_tab| to an enum.
   void ToggleFullscreenModeInternal(bool for_tab);
 
   BrowserWindow* window_;
   Profile* profile_;
   Browser* browser_;
 
   // If there is currently a tab in fullscreen mode (entered via
   // webkitRequestFullScreen), this is its wrapper.
   TabContentsWrapper* fullscreened_tab_;
 
   // The URL of the extension which trigerred "browser fullscreen" mode.
   GURL extension_caused_fullscreen_;
 
   // 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_;
 
+  bool in_or_entering_fullscreen_;

[yzshen1, 2012/04/30 19:32:40]

[something to consider/discuss]
As the state gets more and more complex[1], I am thinking it may be good to have
a method, say, ValidateState() to check that all these variables are in a
consistent state. (For example, fullscreened_tab_ is never non-NULL when
in_or_entering_fullscreen_ is false.) It will serve as documentation of the
relation between these variables. And we can use it with DCHECK so it won't run
in release build.

=======================
[1] It took me a while to recall why (fullscreened_tab_ != NULL) is not the same
as in_or_entering_fullscreen_.

[scheib, 2012/05/01 03:27:07]

ValidateState() is an interesting idea. It would also be pretty complex I think.
I've been expanding the browser tests (before this patch, and in this patch) to
do more scrutinizing of state.

For this variable, I've renamed it to toggled_into_fullscreen_, and added a
comment pointing out it is also used for browser fullscreen.

+
+  // Wrapper for current tab with mouse lock.
+  TabContentsWrapper* mouse_lock_tab_;

[yzshen1, 2012/04/30 19:32:40]

Maybe add comment that |mouse_lock_tab_| is not NULL <==>
!MOUSELOCK_NOT_REQUESTED.

[scheib, 2012/05/01 03:27:07]

Done.

+
   MouseLockState mouse_lock_state_;
 
   DISALLOW_COPY_AND_ASSIGN(FullscreenController);
 };
 
 #endif  // CHROME_BROWSER_UI_FULLSCREEN_CONTROLLER_H_