browser_shutdown.h 3.43 KB
Newer Older
1
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 3
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
initial.commit's avatar
initial.commit committed
4

5 6
#ifndef CHROME_BROWSER_BROWSER_SHUTDOWN_H_
#define CHROME_BROWSER_BROWSER_SHUTDOWN_H_
initial.commit's avatar
initial.commit committed
7

8 9
#include "build/build_config.h"

10
class PrefRegistrySimple;
initial.commit's avatar
initial.commit committed
11 12 13

namespace browser_shutdown {

14 15 16 17 18 19 20 21 22 23 24 25 26 27
// Shutdown flags
enum Flags {
  NO_FLAGS = 0,

  // If |RESTART_LAST_SESSION| is set, the browser will attempt to restart in
  // in the last session after the shutdown.
  RESTART_LAST_SESSION = 1 << 0,

  // Makes a panned restart happen in the background. The browser will just come
  // up in the system tray but not open a new window after restarting. This flag
  // has no effect if |RESTART_LAST_SESSION| is not set.
  RESTART_IN_BACKGROUND = 1 << 1
};

initial.commit's avatar
initial.commit committed
28 29 30 31 32 33 34 35 36 37 38
enum ShutdownType {
  // an uninitialized value
  NOT_VALID = 0,
  // the last browser window was closed
  WINDOW_CLOSE,
  // user clicked on the Exit menu item
  BROWSER_EXIT,
  // windows is logging off or shutting down
  END_SESSION
};

hashimoto's avatar
hashimoto committed
39 40
constexpr int kNumShutdownTypes = END_SESSION + 1;

41
void RegisterPrefs(PrefRegistrySimple* registry);
initial.commit's avatar
initial.commit committed
42 43 44 45 46

// Called when the browser starts shutting down so that we can measure shutdown
// time.
void OnShutdownStarting(ShutdownType type);

47 48 49
// Get the current shutdown type.
ShutdownType GetShutdownType();

50
#if !defined(OS_ANDROID)
51 52 53 54 55 56
// Performs the shutdown tasks that need to be done before
// BrowserProcess and the various threads go away.
//
// Returns true if the session should be restarted.
bool ShutdownPreThreadsStop();

hashimoto's avatar
hashimoto committed
57 58 59 60
// Records the shutdown related prefs, and returns true if the browser should be
// restarted on exit.
bool RecordShutdownInfoPrefs();

61 62 63
// Performs the remaining shutdown tasks after all threads but the
// main thread have been stopped.  This includes deleting g_browser_process.
//
64 65
// See |browser_shutdown::Flags| for the possible flag values and their effects.
void ShutdownPostThreadsStop(int shutdown_flags);
66
#endif
initial.commit's avatar
initial.commit committed
67 68 69 70

// Called at startup to create a histogram from our previous shutdown time.
void ReadLastShutdownInfo();

71 72 73 74 75 76 77 78 79
// There are various situations where the browser process should continue to
// run after the last browser window has closed - the Mac always continues
// running until the user explicitly quits, and on Windows/Linux the application
// should not shutdown when the last browser window closes if there are any
// BackgroundContents running.
// When the user explicitly chooses to shutdown the app (via the "Exit" or
// "Quit" menu items) BrowserList will call SetTryingToQuit() to tell itself to
// initiate a shutdown when the last window closes.
// If the quit is aborted, then the flag should be reset.
80

81 82 83 84 85 86
// This is a low-level mutator; in general, don't call SetTryingToQuit(true),
// except from appropriate places in BrowserList. To quit, use usual means,
// e.g., using |chrome_browser_application_mac::Terminate()| on the Mac, or
// |BrowserList::CloseAllWindowsAndExit()| on other platforms. To stop quitting,
// use |chrome_browser_application_mac::CancelTerminate()| on the Mac; other
// platforms can call SetTryingToQuit(false) directly.
87 88 89 90 91
void SetTryingToQuit(bool quitting);

// General accessor.
bool IsTryingToQuit();

92 93 94 95 96
// Starts to collect shutdown traces. On ChromeOS this will start immediately
// on AttemptUserExit() and all other systems will start once all tabs are
// closed.
void StartShutdownTracing();

initial.commit's avatar
initial.commit committed
97 98
}  // namespace browser_shutdown

99
#endif  // CHROME_BROWSER_BROWSER_SHUTDOWN_H_