summaryrefslogtreecommitdiffstats
path: root/gfx/src/gfxCrashReporterUtils.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /gfx/src/gfxCrashReporterUtils.h
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'gfx/src/gfxCrashReporterUtils.h')
-rw-r--r--gfx/src/gfxCrashReporterUtils.h56
1 files changed, 56 insertions, 0 deletions
diff --git a/gfx/src/gfxCrashReporterUtils.h b/gfx/src/gfxCrashReporterUtils.h
new file mode 100644
index 0000000000..30b670df61
--- /dev/null
+++ b/gfx/src/gfxCrashReporterUtils.h
@@ -0,0 +1,56 @@
+/* -*- 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 gfxCrashReporterUtils_h__
+#define gfxCrashReporterUtils_h__
+
+#include "nsString.h"
+
+namespace mozilla {
+
+/** \class ScopedGfxFeatureReporter
+ *
+ * On creation, adds "FeatureName?" to AppNotes
+ * On destruction, adds "FeatureName-", or "FeatureName+" if you called
+ * SetSuccessful().
+ *
+ * Any such string is added at most once to AppNotes, and is subsequently
+ * skipped.
+ *
+ * This ScopedGfxFeatureReporter class is designed to be fool-proof to use in
+ * functions that have many exit points. We don't want to encourage having
+ * function with many exit points. It just happens that our graphics features
+ * initialization functions are like that.
+ */
+class ScopedGfxFeatureReporter {
+ public:
+ explicit ScopedGfxFeatureReporter(const char* aFeature, bool aForce = false)
+ : mFeature(aFeature), mStatusChar('-'), mStatusNumber(0) {
+ WriteAppNote(aForce ? '!' : '?', 0);
+ }
+ ~ScopedGfxFeatureReporter() { WriteAppNote(mStatusChar, mStatusNumber); }
+ void SetSuccessful() { mStatusChar = '+'; }
+ void SetSuccessful(int32_t aNumber) {
+ mStatusChar = '+';
+ mStatusNumber = aNumber;
+ }
+
+ static void AppNote(const nsACString& aMessage);
+
+ class AppNoteWritingRunnable;
+
+ protected:
+ const char* mFeature;
+ char mStatusChar;
+ int32_t mStatusNumber;
+
+ private:
+ void WriteAppNote(char statusChar, int32_t statusNumber);
+};
+
+} // end namespace mozilla
+
+#endif // gfxCrashReporterUtils_h__