summaryrefslogtreecommitdiffstats
path: root/xpcom/base/AppShutdown.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
commit2aa4a82499d4becd2284cdb482213d541b8804dd (patch)
treeb80bf8bf13c3766139fbacc530efd0dd9d54394c /xpcom/base/AppShutdown.h
parentInitial commit. (diff)
downloadfirefox-2aa4a82499d4becd2284cdb482213d541b8804dd.tar.xz
firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.zip
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'xpcom/base/AppShutdown.h')
-rw-r--r--xpcom/base/AppShutdown.h76
1 files changed, 76 insertions, 0 deletions
diff --git a/xpcom/base/AppShutdown.h b/xpcom/base/AppShutdown.h
new file mode 100644
index 0000000000..4a480b6323
--- /dev/null
+++ b/xpcom/base/AppShutdown.h
@@ -0,0 +1,76 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef AppShutdown_h
+#define AppShutdown_h
+
+#include "ShutdownPhase.h"
+
+namespace mozilla {
+
+enum class AppShutdownMode {
+ Normal,
+ Restart,
+};
+
+class AppShutdown {
+ public:
+ static bool IsShuttingDown();
+
+ /**
+ * Returns the current exit code that the process will be terminated with.
+ */
+ static int GetExitCode();
+
+ /**
+ * Save environment variables that we might need if the app initiates a
+ * restart later in its lifecycle.
+ */
+ static void SaveEnvVarsForPotentialRestart();
+
+ /**
+ * Init the shutdown with the requested shutdown mode and exit code.
+ */
+ static void Init(AppShutdownMode aMode, int aExitCode);
+
+ /**
+ * Confirm that we are in fact going to be shutting down.
+ */
+ static void OnShutdownConfirmed();
+
+ /**
+ * If we've attempted to initiate a restart, this call will set up the
+ * necessary environment variables and launch the new process.
+ */
+ static void MaybeDoRestart();
+
+ /**
+ * This will perform a fast shutdown via _exit(0) or similar if the user's
+ * prefs are configured to do so at this phase.
+ */
+ static void MaybeFastShutdown(ShutdownPhase aPhase);
+
+ /**
+ * The _exit() call is not a safe way to terminate your own process on
+ * Windows, because _exit runs DLL detach callbacks which run static
+ * destructors for xul.dll.
+ *
+ * This method terminates the current process without those issues.
+ *
+ * Optionally a custom exit code can be supplied.
+ */
+ static void DoImmediateExit(int aExitCode = 0);
+
+ /**
+ * True if the application is currently attempting to shut down in order to
+ * restart.
+ */
+ static bool IsRestarting();
+};
+
+} // namespace mozilla
+
+#endif // AppShutdown_h