libraryoptions.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_CORE
#include <promeki/namespace.h>
#include <promeki/variantdatabase.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class LibraryOptions : public VariantDatabase<"LibraryOptions"> {
        public:
                using Base = VariantDatabase<"LibraryOptions">;
 
                using Base::Base;
 
                // ============================================================
                // Crash handling
                // ============================================================
 
                PROMEKI_DECLARE_ID(CrashHandler, VariantSpec()
                                                         .setType(DataTypeBool)
                                                         .setDefault(true)
                                                         .setDescription("Install crash signal handlers."));
 
                PROMEKI_DECLARE_ID(CoreDumps, VariantSpec()
                                                      .setType(DataTypeBool)
                                                      .setDefault(false)
                                                      .setDescription("Enable core dumps via RLIMIT_CORE."));
 
                PROMEKI_DECLARE_ID(CrashLogDir, VariantSpec()
                                                        .setType(DataTypeString)
                                                        .setDefault(String())
                                                        .setDescription("Crash log directory (empty = system temp)."));
 
                PROMEKI_DECLARE_ID(CaptureEnvironment,
                                   VariantSpec()
                                           .setType(DataTypeBool)
                                           .setDefault(true)
                                           .setDescription("Include environment variables in crash reports."));
 
                PROMEKI_DECLARE_ID(CrashStackTraceTimeout,
                                   VariantSpec()
                                           .setType(DataTypeInt32)
                                           .setDefault(10)
                                           .setDescription("Seconds before crash stack-trace symbolization "
                                                           "times out (0 disables)."));
 
                // ============================================================
                // Filesystem
                // ============================================================
 
                PROMEKI_DECLARE_ID(TempDir, VariantSpec()
                                                    .setType(DataTypeString)
                                                    .setDefault(String())
                                                    .setDescription("Override for Dir::temp() (empty = OS default)."));
 
                PROMEKI_DECLARE_ID(IpcDir,
                                   VariantSpec()
                                           .setType(DataTypeString)
                                           .setDefault(String())
                                           .setDescription("Override for Dir::ipc() (empty = platform default)."));
 
                PROMEKI_DECLARE_ID(ModelsDir,
                                   VariantSpec()
                                           .setType(DataTypeString)
                                           .setDefault(String())
                                           .setDescription("Override for Dir::models() (empty = platform default)."));
 
                // ============================================================
                // Logging
                // ============================================================
 
                PROMEKI_DECLARE_ID(LogToStderr,
                                   VariantSpec()
                                           .setType(DataTypeBool)
                                           .setDefault(true)
                                           .setDescription("Route Logger console output to stderr (else stdout)."));
 
                // ============================================================
                // Termination signal handling
                // ============================================================
 
                PROMEKI_DECLARE_ID(TerminationSignalHandler,
                                   VariantSpec()
                                           .setType(DataTypeBool)
                                           .setDefault(true)
                                           .setDescription("Install termination signal handlers (Ctrl-C/kill)."));
 
                PROMEKI_DECLARE_ID(SignalDoubleTapExit,
                                   VariantSpec()
                                           .setType(DataTypeBool)
                                           .setDefault(true)
                                           .setDescription("Force-exit on second termination signal delivery."));
 
                static LibraryOptions &instance();
 
                void loadFromEnvironment();
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_CORE