/*---------------------------------------------------------*\ | LogManager.h | | | | Manages log file and output to the console | | | | This file is part of the OpenRGB project | | SPDX-License-Identifier: GPL-2.0-or-later | \*---------------------------------------------------------*/ #ifndef LOGMANAGER_H #define LOGMANAGER_H #include #include #include #include #include #include #include "filesystem.h" /*-------------------------------------------------*\ | Common LOG strings | | This may need to be in it's own .h file | \*-------------------------------------------------*/ #define SMBUS_CHECK_DEVICE_MESSAGE_EN "[%s] Bus %02d is a motherboard and the subvendor matches the one for %s, looking for a device at 0x%02X" #define SMBUS_CHECK_DEVICE_FAILURE_EN "[%s] Bus %02d is not a motherboard or the subvendor does not match the one for %s, skipping detection" #define GPU_DETECT_MESSAGE "[%s] Found a device match at Bus %02d for Device 0x%04X and SubDevice 0x%04X: %s" using json = nlohmann::json; enum { LL_FATAL, // Critical unrecoverable errors that cause a generalized crash of a module or of the entire app LL_ERROR, // Local errors that abort an operation LL_WARNING, // Local errors that may cause an operation to have an undefined behavior or may have dangerous/unforeseen consequences LL_INFO, // Initialization messages, significant actions and follow-up information LL_VERBOSE, // Tracing of commands and performed actions, usually for debug purposes, comments on the higher priority messages LL_DEBUG, // Deep tracing, "printf-style debugging" alternative, for debug purposes. Such messages should be put all over the code instead of comments LL_TRACE, LL_DIALOG // Log messages to be shown in a GUI dialog box }; struct LogMessage { std::string buffer; unsigned int level; const char* filename; int line; std::chrono::duration counted_second; // int timestamp or float time_offset? TBD }; typedef std::shared_ptr PLogMessage; typedef void(*LogDialogShowCallback)(void*, PLogMessage); class LogManager { private: LogManager(); LogManager(const LogManager&) = delete; LogManager(LogManager&&) = delete; ~LogManager(); std::recursive_mutex entry_mutex; std::mutex section_mutex; std::ofstream log_stream; std::vector dialog_show_callbacks; std::vector dialog_show_callback_args; // A temporary log message storage to hold them until the stream opens std::vector temp_messages; // A log message storage that will be displayed in the app std::vector all_messages; // A flag that marks if the message source file name and line number should be printed on screen bool print_source = false; // Logfile max level unsigned int loglevel = LL_INFO; // Verbosity (stdout) max level unsigned int verbosity = LL_WARNING; //Clock from LogManager creation std::chrono::time_point base_clock; // A non-guarded append() void _append(const char* filename, int line, unsigned int level, const char* fmt, va_list va); // A non-guarded flush() void _flush(); void rotate_logs(const filesystem::path& folder, const filesystem::path& templ, int max_count); public: static LogManager* get(); void configure(json config, const filesystem::path & defaultDir); void flush(); void append(const char* filename, int line, unsigned int level, const char* fmt, ...); void setLoglevel(unsigned int); void setVerbosity(unsigned int); void setPrintSource(bool); void RegisterDialogShowCallback(LogDialogShowCallback callback, void* receiver); void UnregisterDialogShowCallback(LogDialogShowCallback callback, void* receiver); unsigned int getLoglevel(); unsigned int getVerbosity() {return verbosity;} void clearMessages(); std::vector messages(); bool log_console_enabled; bool log_file_enabled; static const char* log_codes[]; }; #define LogAppend(level, ...) LogManager::get()->append(__FILE__, __LINE__, level, __VA_ARGS__) #define LOG_FATAL(...) LogAppend(LL_FATAL, __VA_ARGS__) #define LOG_ERROR(...) LogAppend(LL_ERROR, __VA_ARGS__) #define LOG_WARNING(...) LogAppend(LL_WARNING, __VA_ARGS__) #define LOG_INFO(...) LogAppend(LL_INFO, __VA_ARGS__) #define LOG_VERBOSE(...) LogAppend(LL_VERBOSE, __VA_ARGS__) #define LOG_DEBUG(...) LogAppend(LL_DEBUG, __VA_ARGS__) #define LOG_TRACE(...) LogAppend(LL_TRACE, __VA_ARGS__) #define LOG_DIALOG(...) LogAppend(LL_DIALOG, __VA_ARGS__) #endif // LOGMANAGER_H