MaCh3Logger.h File Reference

KS: Based on this https://github.com/gabime/spdlog/blob/a2b4262090fd3f005c2315dcb5be2f0f1774a005/include/spdlog/spdlog.h#L284. More...

#include <iostream>
#include <sstream>
#include <functional>
#include <string>
#include <exception>
#include "Manager/Core.h"
#include "spdlog/spdlog.h"

Include dependency graph for MaCh3Logger.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	MACH3LOG_TRACE   SPDLOG_TRACE
#define	MACH3LOG_DEBUG   SPDLOG_DEBUG
#define	MACH3LOG_INFO   SPDLOG_INFO
#define	MACH3LOG_WARN   SPDLOG_WARN
#define	MACH3LOG_ERROR   SPDLOG_ERROR
#define	MACH3LOG_CRITICAL   SPDLOG_CRITICAL
#define	MACH3LOG_OFF   SPDLOG_OFF

Functions
void	SetMaCh3LoggerFormat ()
	Set messaging format of the logger.
template<typename Func , typename LogFunc , typename... Args>
void	LoggerPrint (const std::string &LibName, LogFunc logFunction, Func &&func, Args &&... args)
	KS: This is bit convoluted but this is to allow redirecting cout and errors from external library into MaCh3 logger format.

Detailed Description

KS: Based on this https://github.com/gabime/spdlog/blob/a2b4262090fd3f005c2315dcb5be2f0f1774a005/include/spdlog/spdlog.h#L284.

Definition in file MaCh3Logger.h.

Macro Definition Documentation

MACH3LOG_CRITICAL

#define MACH3LOG_CRITICAL   SPDLOG_CRITICAL

Definition at line 26 of file MaCh3Logger.h.

MACH3LOG_DEBUG

#define MACH3LOG_DEBUG   SPDLOG_DEBUG

Definition at line 22 of file MaCh3Logger.h.

MACH3LOG_ERROR

#define MACH3LOG_ERROR   SPDLOG_ERROR

Definition at line 25 of file MaCh3Logger.h.

MACH3LOG_INFO

#define MACH3LOG_INFO   SPDLOG_INFO

Definition at line 23 of file MaCh3Logger.h.

MACH3LOG_OFF

#define MACH3LOG_OFF   SPDLOG_OFF

Definition at line 27 of file MaCh3Logger.h.

MACH3LOG_TRACE

#define MACH3LOG_TRACE   SPDLOG_TRACE

Definition at line 21 of file MaCh3Logger.h.

MACH3LOG_WARN

#define MACH3LOG_WARN   SPDLOG_WARN

Definition at line 24 of file MaCh3Logger.h.

Function Documentation

LoggerPrint()

template<typename Func , typename LogFunc , typename... Args>

void LoggerPrint	(	const std::string &	LibName,
		LogFunc	logFunction,
		Func &&	func,
		Args &&...	args
	)

KS: This is bit convoluted but this is to allow redirecting cout and errors from external library into MaCh3 logger format.

Template Parameters

Func	The type of the function to be called, which outputs to stdout and stderr.
LogFunc	The type of the logging function, typically a lambda that formats and logs messages.
Args	The types of the arguments to be passed to func.

Parameters

LibName	The name of the library or component from which the log message originates.
logFunction	The lambda function responsible for formatting and logging messages. It should accept a single const std::string& parameter.
func	The function to be called, whose output needs to be captured and logged.
args	The arguments to be passed to func. void ExampleFunc(int x, const std::string& str) { std::cout << "Output from exampleFunc: " << x << ", " << str << "\n"; std::cerr << "Error from exampleFunc: " << x << ", " << str << "\n"; } int main() { LoggerPrint("ExampleLib", [](const std::string& message) { MACH3LOG_INFO("{}", message); }, static_cast<void(*)(int, const std::string&)>(ExampleFunc), 666, "Number of the BEAST"); return 0; }

Note

second argument is lambda fucniton whih convers mach3 so template works, it is bit faff... This approach allows seamless integration of func into an existing logging mechanism without modifying func itself

Definition at line 67 of file MaCh3Logger.h.

{
  // Create a stringstream to capture the output
  std::stringstream sss_cout;
  std::stringstream sss_cerr;
  
  // Save the original stream buffers
  std::streambuf* coutBuf = nullptr;
  std::streambuf* cerrBuf = nullptr;
 
  // This should be rare but in case buffers no longer exist ignore
  if (std::cout.rdbuf() && std::cerr.rdbuf()) {
    coutBuf = std::cout.rdbuf();  // Save original cout buffer
    cerrBuf = std::cerr.rdbuf();  // Save original cerr buffer
 
    // Redirect std::cout and std::cerr to the stringstream buffer
    std::cout.rdbuf(sss_cout.rdbuf());
    std::cerr.rdbuf(sss_cerr.rdbuf());
  }
 
  try {
    // Call the provided function
    func(std::forward<Args>(args)...);
 
    // Restore the original stream buffers
    if (coutBuf) std::cout.rdbuf(coutBuf);
    if (cerrBuf) std::cerr.rdbuf(cerrBuf);
 
    std::string line;
    while (std::getline(sss_cout, line))
    {
      auto formatted_message = fmt::format("[{}] {}", LibName, line);
      logFunction(formatted_message);
    }
    while (std::getline(sss_cerr, line))
    {
      auto formatted_message = fmt::format("[{}] {}", LibName, line);
      logFunction(formatted_message);
    }
  } catch (std::runtime_error &err) {
    // Restore the original buffers in case of an exception
    std::cout.rdbuf(coutBuf);
    std::cerr.rdbuf(cerrBuf);
 
    std::cout << "\nConsole cout output:" << std::endl;
    std::cout << sss_cout.rdbuf()->str() << std::endl;
 
    std::cout << "\nConsole cerr output:" << std::endl;
    std::cout << sss_cerr.rdbuf()->str() << std::endl;
    throw;
  }
}

SetMaCh3LoggerFormat()

void SetMaCh3LoggerFormat ( )

inline

Set messaging format of the logger.

Definition at line 30 of file MaCh3Logger.h.

{
  //KS: %H for hour, %M for minute, %S for second, [%s:%#] for class and line
  //For documentation see https://github.com/gabime/spdlog/wiki/3.-Custom-formatting
  #ifdef DEBUG
  //spdlog::set_pattern("[%H:%M:%S][%s:%#][%^%l%$] %v");
  spdlog::set_pattern("[%s:%#][%^%l%$] %v");
  #else
  //spdlog::set_pattern("[%H:%M:%S][%s][%^%l%$] %v");
  spdlog::set_pattern("[%s][%^%l%$] %v");
  #endif
}