refactor logging: make log header-only, rename log_msg to logf, make thread-safe

Author: pageldev

CMakeLists.txt

@@ -49,7 +49,6 @@ set(SOURCES
     src/Junction.cpp
     src/Lane.cpp
     src/LaneSection.cpp
-    src/Log.cpp
     src/Mesh.cpp
     src/OpenDriveMap.cpp
     src/RefLine.cpp

include/Log.h

@@ -1,6 +1,9 @@
 #pragma once
+#include "Utils.hpp"
 
-#include <functional>
+#include <atomic>
+#include <cstdio>
+#include <string>
 
 namespace odr
 {
@@ -12,11 +15,45 @@ enum LogLevel
     Error = 2
 };
 
-const char* log_level_to_string(const LogLevel level);
+inline const char* log_level_to_string(const LogLevel level)
+{
+    switch (level)
+    {
+    case LogLevel::Info:
+        return "INFO";
+    case LogLevel::Warn:
+        return "WARN";
+    case LogLevel::Error:
+        return "ERROR";
+    default:
+        return "UNKNOWN";
+    }
+}
+
+using LogFunction = void (*)(LogLevel, const char*);
 
-using LogFunction = std::function<void(const LogLevel level, const char* message)>;
+inline void default_log_function(LogLevel lvl, const char* msg)
+{
+    std::fprintf(stderr, "[%s] %s\n", log_level_to_string(lvl), msg);
+}
 
-void set_log_callback(LogFunction log_function);
-void log_msg(const LogLevel level, const char* format, ...);
+inline std::atomic<LogFunction> g_log_function{&default_log_function};
+
+inline void set_log_callback(LogFunction log_function)
+{
+    g_log_function.store(log_function, std::memory_order_relaxed);
+}
+
+inline void log(LogLevel lvl, const char* msg)
+{
+    g_log_function.load(std::memory_order_relaxed)(lvl, msg);
+}
+
+template<class... Args>
+inline void logf(LogLevel lvl, const char* fmt, Args&&... args)
+{
+    std::string s = string_format(fmt, std::forward<Args>(args)...);
+    log(lvl, s.c_str());
+}
 
-} // namespace odr
+} // namespace odr

include/Utils.hpp

@@ -16,14 +16,14 @@
 #define ODR_CHECK(expr, msg)                                                                                                                         \
     {                                                                                                                                                \
         if (!(expr))                                                                                                                                 \
-            log_msg(LogLevel::Warn, "[%s] check failed: %s", __FUNCTION__, msg);                                                                     \
+            logf(LogLevel::Warn, "[%s] check failed: %s", __FUNCTION__, msg);                                                                     \
     }
 
 #define ODR_CHECK_AND_REPAIR(check_expr, msg, repair_expr)                                                                                           \
     {                                                                                                                                                \
         if (!(check_expr))                                                                                                                           \
         {                                                                                                                                            \
-            log_msg(LogLevel::Warn, "[%s] check failed: %s", __FUNCTION__, msg);                                                                     \
+            logf(LogLevel::Warn, "[%s] check failed: %s", __FUNCTION__, msg);                                                                     \
             repair_expr;                                                                                                                             \
         }                                                                                                                                            \
     }

src/Log.cpp

@@ -68,7 +68,7 @@ OpenDriveMap::OpenDriveMap(const std::string& xodr_file,
 {
     this->xml_parse_result = this->xml_doc.load_file(xodr_file.c_str());
     if (!this->xml_parse_result)
-        log_msg(LogLevel::Error, "%s", this->xml_parse_result.description());
+        logf(LogLevel::Error, "%s", this->xml_parse_result.description());
 
     const pugi::xml_node odr_node = this->xml_doc.child("OpenDRIVE");
 
@@ -305,7 +305,7 @@ OpenDriveMap::OpenDriveMap(const std::string& xodr_file,
             }
             else
             {
-                log_msg(LogLevel::Error, "Could not parse %s", geometry_type.c_str());
+                logf(LogLevel::Error, "Could not parse %s", geometry_type.c_str());
                 continue;
             }
 
@@ -370,7 +370,7 @@ OpenDriveMap::OpenDriveMap(const std::string& xodr_file,
             /* check for lateralProfile shape - not implemented yet */
             if (road_node.child("lateralProfile").child("shape"))
             {
-                log_msg(LogLevel::Error, "Lateral Profile Shape not supported");
+                logf(LogLevel::Error, "Lateral Profile Shape not supported");
             }
         }