Added checks if verbosity level is enabled before to_string.

Replaced Logrecorder with stringstream directly and added as a member to Logger, to reuse it fore the entire lifetime of the application.

Added doc strings.

Added constructors to LogRecord.

Author: larshg

common/include/pcl/console/print.h

@@ -54,11 +54,12 @@
 // PCL_ERROR_STREAM("Error: an Eigen vector: " << std::endl << Eigen::Vector3f(1.0, 2.0, 3.0) << std::endl);
 // NOLINTBEGIN(bugprone-macro-parentheses)
 #define PCL_LOG_STREAM(LEVEL, ARGS) \
-  if(pcl::console::isVerbosityLevelEnabled(pcl::console::LEVEL)) \
+  if (pcl::console::isVerbosityLevelEnabled(pcl::console::LEVEL)) \
   { \
-    pcl::console::LogRecord entry{pcl::console::LEVEL, ""}; \
-    pcl::console::LogRecorder rec(entry.message); \
-    rec << ARGS; \
+    auto& strstream = pcl::console::Logger::getInstance().getStringStream(); \
+    strstream.clear(); \
+    strstream << ARGS; \
+    pcl::console::LogRecord entry{pcl::console::LEVEL, strstream.str()}; \
     pcl::console::Logger::getInstance().print(entry); \
   }
 // NOLINTEND(bugprone-macro-parentheses)
@@ -132,41 +133,27 @@ namespace pcl
       L_VERBOSE
     };
 
+    /** \brief Structure to hold a log record
+     * Used by the Logger class
+    */
     struct LogRecord {
-      VERBOSITY_LEVEL level;
-      std::string message;
-    };
+      LogRecord() = default;
 
-    class LogRecorder {
-    public:
-      LogRecorder(std::string& string) : strstream(string) { }
+      LogRecord(VERBOSITY_LEVEL lvl, const std::string& str)
+      : level(lvl), message(str) {};
 
-      template <class T>
-      LogRecorder&
-      operator<<(const T& x)
-      {
-        strstream << x;
-
-        return *this;
-      }
+      LogRecord(VERBOSITY_LEVEL lvl, std::string&& str)
+      : level(lvl), message(std::move(str))
+      {};
 
-      LogRecorder&
-      operator<<(std::ostream& (std::ostream&))
-      {
-        strstream << std::endl;
-        return *this;
-      }
+      LogRecord(const LogRecord& other) = default;
 
-      std::string
-      to_string() const
-      {
-        return strstream.str();
-      }
+      ~LogRecord() = default;
 
-      std::stringstream strstream;
+      VERBOSITY_LEVEL level;
+      std::string message;
     };
 
-
     /** set the verbosity level */
     PCL_EXPORTS void 
     setVerbosityLevel (VERBOSITY_LEVEL level);
@@ -217,12 +204,21 @@ namespace pcl
     PCL_EXPORTS void 
     reset_text_color (FILE *stream);
 
-    
+    /**
+     * @brief Logger used to log messages with different verbosity levels
+     * Can be used to redirect log messages to custom outputs by setting a callback
+     */
     class PCL_EXPORTS Logger {
     public:
       static Logger&
       getInstance();
 
+      std::stringstream&
+      getStringStream()
+      {
+        return strstream;
+      }
+
       template <typename Functor>
       void
       setCallback(Functor&& callback)
@@ -249,13 +245,10 @@ namespace pcl
       print_value(const LogRecord& logEntry);
 
       void
-      print_color(FILE* stream,
-                  int attr,
-                  int fg,
-                  const LogRecord& logEntry);
-
+      print_color(FILE* stream, int attr, int fg, const LogRecord& logEntry);
 
     private:
+      std::stringstream strstream;
       std::function<void(const LogRecord&)> logcallback;
     };
 
@@ -288,7 +281,7 @@ namespace pcl
       while (true) {
         formatted.reset(new char[n]); /* Wrap the plain char array into the unique_ptr */
         va_start(ap, fmt_str);
-        final_n = vsnprintf(&formatted[0], n, fmt_str.c_str(), ap);
+        final_n = vsnprintf(formatted.get(), n, fmt_str.c_str(), ap);
         va_end(ap);
         if (final_n < 0 || final_n >= n)
           n += abs(final_n - n + 1);
@@ -429,8 +422,10 @@ namespace pcl
     PCL_EXPORTS void
     print(VERBOSITY_LEVEL level, FILE* stream, const std::string format, Args&&...args)
     {
-      const auto str = to_string(format, std::forward<Args>(args)...);
+      if (!pcl::console::isVerbosityLevelEnabled(level))
+        return;
 
+      const auto str = to_string(format, std::forward<Args>(args)...);
       LogRecord logEntry{level, str};
       Logger::getInstance().print(stream, logEntry);
     }
@@ -445,8 +440,10 @@ namespace pcl
     void
     print(VERBOSITY_LEVEL level, const std::string format, Args&&... args)
     {
-      const auto str = to_string(format, std::forward<Args>(args)...);
+      if (!pcl::console::isVerbosityLevelEnabled(level))
+        return;
 
+      const auto str = to_string(format, std::forward<Args>(args)...);
       LogRecord logEntry{level, str};
       Logger::getInstance().print(logEntry);
     }

common/src/print.cpp

@@ -300,6 +300,9 @@ pcl::console::Logger::print(const LogRecord& logEntry)
 void
 pcl::console::Logger::print_highlight(FILE* stream, const LogRecord& logEntry)
 {
+  if (!pcl::console::isVerbosityLevelEnabled(logEntry.level))
+    return;
+
   if (logcallback)
     logcallback(logEntry);
   else {
@@ -320,6 +323,9 @@ pcl::console::Logger::print_highlight(const LogRecord& logEntry)
 void
 pcl::console::Logger::print_value(FILE* stream, const LogRecord& logEntry)
 {
+  if (!pcl::console::isVerbosityLevelEnabled(logEntry.level))
+    return;
+
   if (logcallback)
     logcallback(logEntry);
   else {
@@ -341,6 +347,9 @@ void
 pcl::console::Logger::print_color(
     FILE* stream, int attr, int fg, const LogRecord& logEntry)
 {
+  if (!pcl::console::isVerbosityLevelEnabled(logEntry.level))
+    return;
+
   if (logcallback)
     logcallback(logEntry);
   else {