Move unload handling off Browser onto its own class, UnloadController.

chrome/browser/ui/browser.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_BROWSER_H_
 #define CHROME_BROWSER_UI_BROWSER_H_
 #pragma once
 
 #include <map>
 #include <set>
@@ skipping 50 matching lines @@
 class PrefService;
 class Profile;
 class SkBitmap;
 class StatusBubble;
 class TabNavigation;
 class TabStripModel;
 struct WebApplicationInfo;
 
 namespace chrome {
 class BrowserCommandController;
+class UnloadController;
 namespace search {
 class SearchDelegate;
 class SearchModel;
 }
 }
 
 namespace content {
 class NavigationController;
 class SessionStorageNamespace;
 }
@@ skipping 218 matching lines @@
   string16 GetWindowTitleForCurrentTab() const;
 
   // Prepares a title string for display (removes embedded newlines, etc).
   static void FormatTitleForDisplay(string16* title);
 
   // OnBeforeUnload handling //////////////////////////////////////////////////
 
   // Gives beforeunload handlers the chance to cancel the close.
   bool ShouldCloseWindow();
 
-  bool IsAttemptingToCloseBrowser() const {
-    return is_attempting_to_close_browser_;
-  }
+  bool IsAttemptingToCloseBrowser() const;
 
   // Invoked when the window containing us is closing. Performs the necessary
   // cleanup.
   void OnWindowClosing();
 
   // OnWindowActivationChanged handling ///////////////////////////////////////
 
   // Invoked when the window containing us is activated.
   void OnWindowActivated();
 
@@ skipping 467 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);
 
-  // OnBeforeUnload handling //////////////////////////////////////////////////
-
-  typedef std::set<content::WebContents*> 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;
-
-  // Clears all the state associated with processing tabs' beforeunload/unload
-  // events since the user cancelled closing the window.
-  void CancelWindowClose();
-
-  // Removes |web_contents| from the passed |set|.
-  // Returns whether the tab was in the set in the first place.
-  // TODO(beng): this method needs a better name!
-  bool RemoveFromSet(UnloadListenerSet* set,
-                     content::WebContents* web_contents);
-
-  // Cleans up state appropriately when we are trying to close the browser and
-  // the tab has finished firing its unload handler. We also use this in the
-  // cases where a tab crashes or hangs even if the beforeunload/unload haven't
-  // successfully fired. If |process_now| is true |ProcessPendingTabs| is
-  // invoked immediately, otherwise it is invoked after a delay (PostTask).
-  //
-  // Typically you'll want to pass in true for |process_now|. Passing in true
-  // may result in deleting |tab|. If you know that shouldn't happen (because of
-  // the state of the stack), pass in false.
-  void ClearUnloadState(content::WebContents* web_contents, bool process_now);
-
   // In-progress download termination handling /////////////////////////////////
 
   // Called when the window is closing to check if potential in-progress
   // downloads should prevent it from closing.
   // Returns true if the window can close, false otherwise.
   bool CanCloseWithInProgressDownloads();
 
   // Assorted utility functions ///////////////////////////////////////////////
 
   // Sets the delegate of all the parts of the TabContents that
@@ skipping 88 matching lines @@
 
   // Maps from WebContents to pending UI updates that need to be processed.
   // We don't update things like the URL or tab title right away to avoid
   // flickering and extra painting.
   // See ScheduleUIUpdate and ProcessPendingUIUpdates.
   UpdateMap scheduled_updates_;
 
   // The following factory is used for chrome update coalescing.
   base::WeakPtrFactory<Browser> chrome_updater_factory_;
 
-  // OnBeforeUnload handling //////////////////////////////////////////////////
-
-  // Tracks tabs that need there beforeunload event fired before we can
-  // close the browser. Only gets populated when we try to close the browser.
-  UnloadListenerSet tabs_needing_before_unload_fired_;
-
-  // Tracks tabs that need there unload event fired before we can
-  // close the browser. Only gets populated when we try to close the browser.
-  UnloadListenerSet tabs_needing_unload_fired_;
-
-  // Whether we are processing the beforeunload and unload events of each tab
-  // in preparation for closing the browser.
-  bool is_attempting_to_close_browser_;
-
   // In-progress download termination handling /////////////////////////////////
 
   enum CancelDownloadConfirmationState {
     NOT_PROMPTED,          // We have not asked the user.
     WAITING_FOR_RESPONSE,  // We have asked the user and have not received a
                            // reponse yet.
     RESPONSE_RECEIVED      // The user was prompted and made a decision already.
   };
 
   // State used to figure-out whether we should prompt the user for confirmation
   // when the browser is closed with in-progress downloads.
   CancelDownloadConfirmationState cancel_download_confirmation_state_;
 
   /////////////////////////////////////////////////////////////////////////////
 
   // Override values for the bounds of the window and its maximized or minimized
   // state.
   // These are supplied by callers that don't want to use the default values.
   // The default values are typically loaded from local state (last session),
   // obtained from the last window of the same type, or obtained from the
   // shell shortcut's startup info.
   gfx::Rect override_bounds_;
   ui::WindowShowState initial_show_state_;
 
   // Tracks when this browser is being created by session restore.
   bool is_session_restore_;
 
+  scoped_ptr<chrome::UnloadController> unload_controller_;
+
   // The following factory is used to close the frame at a later time.
   base::WeakPtrFactory<Browser> weak_factory_;
 
   // The Find Bar. This may be NULL if there is no Find Bar, and if it is
   // non-NULL, it may or may not be visible.
   scoped_ptr<FindBarController> find_bar_controller_;
 
   // Dialog box used for opening and saving files.
   scoped_refptr<SelectFileDialog> select_file_dialog_;
 
@@ skipping 33 matching lines @@
   bool window_has_shown_;
 
   // Currently open color chooser. Non-NULL after OpenColorChooser is called and
   // before DidEndColorChooser is called.
   scoped_ptr<content::ColorChooser> color_chooser_;
 
   DISALLOW_COPY_AND_ASSIGN(Browser);
 };
 
 #endif  // CHROME_BROWSER_UI_BROWSER_H_