Quickly close tabs/window with long-running unload handlers.

chrome/browser/ui/unload_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_UNLOAD_CONTROLLER_H_
 #define CHROME_BROWSER_UI_UNLOAD_CONTROLLER_H_
 
 #include <set>
 
+#include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "chrome/browser/ui/tabs/tab_strip_model_observer.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 
 class Browser;
 class TabContents;
 class TabStripModel;
 
 namespace content {
 class NotificationSource;
 class NotifictaionDetails;
 class WebContents;
 }
 
 namespace chrome {
+class UnloadDetachedHandler;
 
+// UnloadController manages closing tabs and windows -- especially in
+// regards to beforeunload handlers (proceed/cancel dialogs) and
+// unload handlers (no user interaction).
+//
+// Typical flow of closing a tab:
+//  1. Browser calls |CanCloseContents()|.
+//     If true, browser calls contents::CloseWebContents().
+//  2. WebContents notifies us via its delegate and BeforeUnloadFired()
+//     that the beforeunload handler was run. If the user allowed the
+//     close to continue, we hand-off running the unload handler to
+//     UnloadDetachedHandler which decides if the tab can be unloaded
+//     in the background. If it can, the tab is removed from the tab
+//     strip at this point.
+//
+// Typical flow of closing a window:
+//  1. Browser calls |ShouldCloseWindow()|.
+//     If beforeunload/unload handlers need to run, |UnloadController| returns
+//     false and calls |ProcessPendingTabs()| (private method).
+//  2. For each tab with a beforeunload/unload handler, |ProcessPendingTabs()|
+//        calls |web_contents->OnCloseStarted()|
+//        and   |web_contents->GetRenderViewHost()->FirePageBeforeUnload()|.
+//  3. |UnloadController| waits for any tabs from the "closing a tab" flow above
+//     to finish detached unloads.
+//  4. For each tab with a beforeunload/unload handler, |ProcessPendingTabs()|
+//        calls |web_contents->GetRenderViewHost()->ClosePage()|.
+//  5. |ProcessPendingTabs()| calls |browser_->OnWindowClosing()|.
+//
 class UnloadController : public content::NotificationObserver,
                          public TabStripModelObserver {
  public:
   explicit UnloadController(Browser* browser);
   virtual ~UnloadController();
 
   // Returns true if |contents| can be cleanly closed. When |browser_| is being
   // closed, this function will return false to indicate |contents| should not
   // be cleanly closed, since the fast shutdown path will just kill its
   // renderer.
@@ skipping 70 matching lines @@
   //
   // 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);
 
   Browser* browser_;
 
   content::NotificationRegistrar registrar_;
 
-  // Tracks tabs that need there beforeunload event fired before we can
+  // Tracks tabs that need their 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
+  // Tracks tabs that need their 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. UnloadController owns this state
   // rather than Browser because unload handlers are the only reason that a
   // Browser window isn't just immediately closed.
   bool is_attempting_to_close_browser_;
 
+  // Allow unload handlers to run without holding up the UI.
+  scoped_ptr<UnloadDetachedHandler> unload_detached_handler_;
+
   base::WeakPtrFactory<UnloadController> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(UnloadController);
 };
 
 }  // namespace chrome
 
 #endif  // CHROME_BROWSER_UI_UNLOAD_CONTROLLER_H_