Cut the ScopeGuard alias now that we have auto

[folly.git] / folly / init / Init.h

diff --git a/folly/init/Init.h b/folly/init/Init.h
index 3a120ba10ce73793fd8c194bfd75de2686a33d4f..c4280cead64014649009dedbd8884f8b62c63b89 100644 (file)
--- a/folly/init/Init.h
+++ b/folly/init/Init.h
@@ -16,6 +16,8 @@
 
 #pragma once
 
+#include <folly/CPortability.h>
+
 /*
  * Calls common init functions in the necessary order
  * Among other things, this ensures that folly::Singletons are initialized
@@ -30,4 +32,23 @@ namespace folly {
 
 void init(int* argc, char*** argv, bool removeFlags = true);
 
+/*
+ * An RAII object to be constructed at the beginning of main() and destructed
+ * implicitly at the end of main().
+ *
+ * The constructor performs the same setup as folly::init(), including
+ * initializing singletons managed by folly::Singleton.
+ *
+ * The destructor destroys all singletons managed by folly::Singleton, yielding
+ * better shutdown behavior when performed at the end of main(). In particular,
+ * this guarantees that all singletons managed by folly::Singleton are destroyed
+ * before all Meyers singletons are destroyed.
+ */
+class Init {
+ public:
+  // Force ctor & dtor out of line for better stack traces even with LTO.
+  FOLLY_NOINLINE Init(int* argc, char*** argv, bool removeFlags = true);
+  FOLLY_NOINLINE ~Init();
+};
+
 } // namespace folly