Add clean logs support + dependent MR

Description

Add some mechanisms to add log support to Vivy.

• A LogSink is an object that will collect all the logs and emit them to a file, stderr, or in a Qt widget
• A Logger is the object used to create log message and submit them to the sink
• A LogMessage is a message, a line of log. You should not create it yourself, but use the macros or defined methods. They are submitted on destruction, so don't try things like auto msg = VIVY_LOG_WARN(appLog); msg << "toto"; unless you know what you are doing. If you don't pay attention, you might get log messages in a different order than what you originally wanted.

Example

Here is a small demo:

// Custom sink
VIVY_DCL_LOG_SINK(logSink) // Declare a Sink
std::shared_ptr<Logger> scriptLog = VIVY_GET_LOGGER(mySink, SCRIPT); // Custom logger
VIVY_LOG_WARN(scriptLog) << "This is" << ' ' << "very usefull!"; // Use the custom logger

// With the vivyApp's sink
class Object {
    // Add a logger to the sink and add log methods to the object
    VIVY_APP_LOGGABLE_OBJECT(Object, logger)

public:
    // ...
};

TODO List

• Create and use the API
• The simple stderr dispatcher
• The VivyConsoleDispatcher -> a dock widget with the MainWindow, like the console with VSCode or Eclipse
• Create the LogDispatcherThread -> flush at regular intervals the LogSink

Also merge dependent MR with this one to uniformize the logging process

src/Lib/Log.hh

@@ -2,7 +2,10 @@
 
 #include "Utils.hh"
 
-#define VIVY_GET_LOGGER(sink, cat)      std::make_shared<Logger>(sink.get(), cat)
+// Create a logger with a category
+#define VIVY_GET_LOGGER(sink, cat) std::make_shared<Logger>(sink.get(), cat)
+
+// Log something in a logger
 #define VIVY_LOG_WITH_LEVEL(log, level) log->logEvent(__FILE__, __func__, __LINE__, level)
 #define VIVY_LOG_WARN(log)              VIVY_LOG_WITH_LEVEL(log, LogLevel::Warning)
 #define VIVY_LOG_DEBUG(log)             VIVY_LOG_WITH_LEVEL(log, LogLevel::Debug)
@@ -10,13 +13,21 @@
 #define VIVY_LOG_ERR(log)               VIVY_LOG_WITH_LEVEL(log, LogLevel::Error)
 #define VIVY_LOG_FATAL(log)             VIVY_LOG_WITH_LEVEL(log, LogLevel::Critical)
 
+// Declare a sink, with the utility function/method `flushLogSink`. This is
+// intended to be used in an object to not polluate namespaces.
 #define VIVY_DCL_LOG_SINK(sink)                          \
     std::shared_ptr<LogSink> sink{ LogSink::newSink() }; \
     void flushLogSink() const noexcept { sink->flush(); }
 
+// Declare a dispatch for a sink with no arguments in the constructor.
 #define VIVY_DCL_LOG_DISPATCH(sink, name, dispatch) \
     std::shared_ptr<dispatch> name{ sink->newDispatcher<dispatch>() };
 
+// Declare a dispatch for a sink with arguments in the constructor.
+#define VIVY_DCL_LOG_DISPATCH_WITH(sink, name, dispatch, ...) \
+    std::shared_ptr<dispatch> name{ sink->newDispatcher<dispatch>(__VA_ARGS__) };
+
+// Install logger for the object.
 #define VIVY_LOGGABLE_OBJECT(sink, name, logger)                             \
     std::shared_ptr<Logger> logger{ VIVY_GET_LOGGER(sink, name) };           \
     LogMessage logFatal() const noexcept { return VIVY_LOG_FATAL(logger); }  \
@@ -90,10 +101,11 @@ public:
     void recieveLogMessage(const Logger *const, LogMessage &&) noexcept;
     void flush() noexcept;
 
-    template <Derived<LogSinkDispatcher> DispatcherType>
-    std::shared_ptr<DispatcherType> newDispatcher() noexcept
+    template <Derived<LogSinkDispatcher> DispatcherType, typename... Args>
+    std::shared_ptr<DispatcherType> newDispatcher(Args &&...args) noexcept
     {
-        std::shared_ptr<DispatcherType> dispatch = std::make_shared<DispatcherType>();
+        std::shared_ptr<DispatcherType> dispatch =
+            std::make_shared<DispatcherType>(std::forward<Args>(args)...);
         registerLogDispatcher(dispatch);
         return dispatch;
     }