spdlog implementation hiding (#498)

this change aims to hide logging internals from client code, in order to make it easier to extend and take more control over the logging process in the future. 

As a bonus side effect, the generated code is much tighter (net delta around 2.5% on the resulting executable which includes lots of thirdparty code) and should take less time to compile and link.

Client usage via macros is pretty much unchanged. The main exposure client code had to spdlog internals before was the use of custom loggers per subsystem, where it would be common to have `spdlog::logger` references to keep a reference to a logger within a class. This is now replaced by `zen::LoggerRef` which currently simply encapsulates an actual `spdlog::logger` instance, but this is intended to be an implementation detail which will change in the future.

The way the change works is that we now handle any formatting of log messages in the zencore logging subsystem instead of relying on `spdlog` to manage this. We use the `fmt` library to do the formatting which means the client usage is identical to using `spdlog`. The formatted message is then forwarded onto any sinks etc which are still implememted via `spdlog`.

1 files changed, 11 insertions, 10 deletions

diff --git a/src/zenutil/logging.cpp b/src/zenutil/logging.cpp
index 4d8dcbca6..512c7901c 100644
--- a/src/zenutil/logging.cpp
+++ b/src/zenutil/logging.cpp
@@ -7,6 +7,7 @@ ZEN_THIRD_PARTY_INCLUDES_START
 #include <spdlog/async_logger.h>
 #include <spdlog/sinks/ansicolor_sink.h>
 #include <spdlog/sinks/msvc_sink.h>
+#include <spdlog/spdlog.h>
 ZEN_THIRD_PARTY_INCLUDES_END
 
 #include <zencore/compactbinary.h>
@@ -58,10 +59,10 @@ BeginInitializeLogging(const LoggingOptions& LogOptions)
 	{
 		const int QueueSize	  = 8192;
 		const int ThreadCount = 1;
-		spdlog::init_thread_pool(QueueSize, ThreadCount);
+		spdlog::init_thread_pool(QueueSize, ThreadCount, [&] { SetCurrentThreadName("spdlog_async"); });
 
-		auto AsyncLogger = spdlog::create_async<spdlog::sinks::ansicolor_stdout_sink_mt>("main");
-		zen::logging::SetDefault(AsyncLogger);
+		auto AsyncSink = spdlog::create_async<spdlog::sinks::ansicolor_stdout_sink_mt>("main");
+		zen::logging::SetDefault("main");
 	}
 
 	// Sinks
@@ -87,8 +88,8 @@ BeginInitializeLogging(const LoggingOptions& LogOptions)
 
 	// Default
 
-	auto& DefaultLogger = zen::logging::Default();
-	auto& Sinks			= DefaultLogger.sinks();
+	LoggerRef DefaultLogger = zen::logging::Default();
+	auto&	  Sinks			= DefaultLogger.SpdLogger->sinks();
 
 	Sinks.clear();
 
@@ -124,11 +125,11 @@ BeginInitializeLogging(const LoggingOptions& LogOptions)
 			return;
 		}
 		// Bypass zen logging wrapping to reduce potential other error sources
-		if (auto ErrLogger = zen::logging::ErrorLog(); ErrLogger != nullptr)
+		if (auto ErrLogger = zen::logging::ErrorLog())
 		{
 			try
 			{
-				ErrLogger->log(spdlog::level::err, msg);
+				ErrLogger.SpdLogger->log(spdlog::level::err, msg);
 			}
 			catch (const std::exception&)
 			{
@@ -137,7 +138,7 @@ BeginInitializeLogging(const LoggingOptions& LogOptions)
 		}
 		try
 		{
-			Log().error(msg);
+			Log().SpdLogger->error(msg);
 		}
 		catch (const std::exception&)
 		{
@@ -192,8 +193,8 @@ ShutdownLogging()
 {
 	g_FileSink.reset();
 
-	auto& DefaultLogger = zen::logging::Default();
-	DefaultLogger.info("log ending at {}", zen::DateTime::Now().ToIso8601());
+	auto DefaultLogger = zen::logging::Default();
+	ZEN_LOG_INFO(DefaultLogger, "log ending at {}", zen::DateTime::Now().ToIso8601());
 	zen::logging::ShutdownLogging();
 }