logger.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*********************************************************************************/
 
#pragma once
 
//! \file logger.h
//! \brief Provides logging functionality with various severity levels and channels
 
#include "vreUtil/export.h"
 
#include <vlutil/vlPrint.h>
 
//! \brief Macro to extract just the filename from a full path
//!
//! This macro extracts the filename from the full path in __FILE__
//! Returns the filename without the directory path
#define __FILENAME__ (strrchr(__FILE__, '\\') ? strrchr(__FILE__, '\\') + 1 : __FILE__)
 
//! \brief Generates a timestamp string for log messages
//!
//! \return A formatted timestamp string for use in log messages
std::string UTIL_DLL logTimestamp();
 
//! \brief Logs a fatal error message
//!
//! \param channel The logging channel/category to use
//! \param function The function name where the log originated
//! \return An output stream to write the message to
UTIL_DLL DtOutputStream& DtVreFatal(const std::string& channel, const std::string& function);
 
//! \brief Logs a warning message
//!
//! \param channel The logging channel/category to use
//! \param function The function name where the log originated
//! \return An output stream to write the message to
UTIL_DLL DtOutputStream& DtVreWarn(const std::string& channel, const std::string& function);
 
//! \brief Logs an informational message
//!
//! \param channel The logging channel/category to use
//! \param function The function name where the log originated
//! \return An output stream to write the message to
UTIL_DLL DtOutputStream& DtVreInfo(const std::string& channel, const std::string& function);
 
//! \brief Logs a verbose message (more detailed than info)
//!
//! \param channel The logging channel/category to use
//! \param function The function name where the log originated
//! \return An output stream to write the message to
UTIL_DLL DtOutputStream& DtVreVerbose(const std::string& channel, const std::string& function);
 
//! \brief Logs a debug message
//!
//! \param channel The logging channel/category to use
//! \param function The function name where the log originated
//! \return An output stream to write the message to
UTIL_DLL DtOutputStream& DtVreDebug(const std::string& channel, const std::string& function);
 
//! \brief Macro to log a fatal message to log files
//!
//! \param channel The logging channel/category to use
#define LOG_FATAL(channel) DtVreFatal(channel, __FUNCTION__)
 
//! \brief Macro to log a warning message to log files
//!
//! \param channel The logging channel/category to use
#define LOG_WARN(channel) DtVreWarn(channel, __FUNCTION__)
 
//! \brief Macro to log an informational message to log files
//!
//! \param channel The logging channel/category to use
#define LOG_INFO(channel) DtVreInfo(channel, __FUNCTION__)
 
//! \brief Macro to log a verbose message to log files
//!
//! \param channel The logging channel/category to use
#define LOG_VERBOSE(channel) DtVreVerbose(channel, __FUNCTION__)
 
//! \brief Macro to log a debug message to log files
//!
//! \param channel The logging channel/category to use
#define LOG_DEBUG(channel) DtVreDebug(channel, __FUNCTION__)
 
//! \brief Macro to log a fatal message to an entity's object console
//!
//! \param channel The logging channel/category to use
#define OBJCON_FATAL(channel)                                                                                          \
   entity()->objectConsoleError() << "FATAL[" << channel << "] " << logTimestamp() << " " << __FUNCTION__ << ": "
 
//! \brief Macro to log a warning message to an entity's object console
//!
//! \param channel The logging channel/category to use
#define OBJCON_WARN(channel)                                                                                           \
   entity()->objectConsoleWarn() << "WARN[" << channel << "] " << logTimestamp() << " " << __FUNCTION__ << ": "
 
//! \brief Macro to log an informational message to an entity's object console
//!
//! \param channel The logging channel/category to use
#define OBJCON_INFO(channel)                                                                                           \
   entity()->objectConsoleInfo() << "INFO[" << channel << "] " << logTimestamp() << " " << __FUNCTION__ << ": "
 
//! \brief Macro to log a verbose message to an entity's object console
//!
//! \param channel The logging channel/category to use
#define OBJCON_VERBOSE(channel)                                                                                        \
   entity()->objectConsoleVerbose() << "VERBOSE[" << channel << "] " << logTimestamp() << " " << __FUNCTION__ << ": "
 
//! \brief Macro to log a debug message to an entity's object console
//!
//! \param channel The logging channel/category to use
#define OBJCON_DEBUG(channel)                                                                                          \
   entity()->objectConsoleDebug() << "DEBUG[" << channel << "] " << logTimestamp() << " " << __FUNCTION__ << ": "