chrome/browser/lifetime/application_lifetime.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_LIFETIME_APPLICATION_LIFETIME_H_
   6 #define CHROME_BROWSER_LIFETIME_APPLICATION_LIFETIME_H_
   7
   8 #include "base/compiler_specific.h"
   9
  10 class Browser;
  11
  12 namespace chrome {
  13
  14 // Starts a user initiated exit process. Called from Browser::Exit.
  15 // On platforms other than ChromeOS, this is equivalent to
  16 // CloseAllBrowsers() On ChromeOS, this tells session manager
  17 // that chrome is signing out, which lets session manager send
  18 // SIGTERM to start actual exit process.
  19 void AttemptUserExit();
  20
  21 // Starts to collect shutdown traces. On ChromeOS this will start immediately
  22 // on AttemptUserExit() and all other systems will start once all tabs are
  23 // closed.
  24 void StartShutdownTracing();
  25
  26 // Starts a user initiated restart process. On platforms other than
  27 // chromeos, this sets a restart bit in the preference so that
  28 // chrome will be restarted at the end of shutdown process. On
  29 // ChromeOS, this simply exits the chrome, which lets sesssion
  30 // manager re-launch the browser with restore last session flag.
  31 void AttemptRestart();
  32
  33 #if defined(OS_WIN)
  34 enum AshExecutionStatus {
  35   ASH_KEEP_RUNNING,
  36   ASH_TERMINATE,
  37 };
  38
  39 // Helper function to activate the desktop from Ash mode. The
  40 // |ash_execution_status| parameter indicates if we should exit Ash after
  41 // activating desktop.
  42 void ActivateDesktopHelper(AshExecutionStatus ash_execution_status);
  43
  44 // Windows 7/8 specific: Like AttemptRestart but if chrome is running
  45 // in desktop mode it starts in metro mode and vice-versa. The switching like
  46 // the restarting is controlled by a preference.
  47 void AttemptRestartToDesktopMode();
  48 // Launches Chrome into Windows 8 metro mode on Windows 8. On Windows 7 it
  49 // launches Chrome into Windows ASH.
  50 void AttemptRestartToMetroMode();
  51 #endif
  52
  53 // Attempt to exit by closing all browsers.  This is equivalent to
  54 // CloseAllBrowsers() on platforms where the application exits
  55 // when no more windows are remaining. On other platforms (the Mac),
  56 // this will additionally exit the application if all browsers are
  57 // successfully closed.
  58 //  Note that he exit process may be interrupted by download or
  59 // unload handler, and the browser may or may not exit.
  60 void AttemptExit();
  61
  62 #if defined(OS_CHROMEOS)
  63 // Shutdown chrome cleanly without blocking. This is called
  64 // when SIGTERM is received on Chrome OS, and always sets
  65 // exit-cleanly bit and exits the browser, even if there is
  66 // ongoing downloads or a page with onbeforeunload handler.
  67 //
  68 // If you need to exit or restart in your code on ChromeOS,
  69 // use AttemptExit or AttemptRestart respectively.
  70 void ExitCleanly();
  71 #endif
  72
  73 // Closes all browsers and if successful, quits.
  74 void CloseAllBrowsersAndQuit();
  75
  76 // Closes all browsers. If the session is ending the windows are closed
  77 // directly. Otherwise the windows are closed by way of posting a WM_CLOSE
  78 // message. This will quit the application if there is nothing other than
  79 // browser windows keeping it alive or the application is quitting.
  80 void CloseAllBrowsers();
  81
  82 // Begins shutdown of the application when the desktop session is ending.
  83 void SessionEnding();
  84
  85 // Tells the BrowserList to keep the application alive after the last Browser
  86 // closes. This is implemented as a count, so callers should pair their calls
  87 // to IncrementKeepAliveCount() with matching calls to DecrementKeepAliveCount()
  88 // when they no
  89 // longer need to keep the application running.
  90 void IncrementKeepAliveCount();
  91
  92 // Stops keeping the application alive after the last Browser is closed.
  93 // Should match a previous call to IncrementKeepAliveCount().
  94 void DecrementKeepAliveCount();
  95
  96 // Returns true if application will continue running after the last Browser
  97 // closes.
  98 bool WillKeepAlive();
  99
 100 // Emits APP_TERMINATING notification. It is guaranteed that the
 101 // notification is sent only once.
 102 void NotifyAppTerminating();
 103
 104 // Send out notifications.
 105 // For ChromeOS, also request session manager to end the session.
 106 void NotifyAndTerminate(bool fast_path);
 107
 108 // Called once the application is exiting.
 109 void OnAppExiting();
 110
 111 // Called once the application is exiting to do any platform specific
 112 // processing required.
 113 void HandleAppExitingForPlatform();
 114
 115 // Returns true if we can start the shutdown sequence for the browser, i.e. the
 116 // last browser window is being closed.
 117 bool ShouldStartShutdown(Browser* browser);
 118
 119 // Disable browser shutdown for unit tests.
 120 void DisableShutdownForTesting(bool disable_shutdown_for_testing);
 121
 122 }  // namespace chrome
 123
 124 #endif  // CHROME_BROWSER_LIFETIME_APPLICATION_LIFETIME_H_