qdmr/libdmrconf/logger_8hh_source.html

 #ifndef LOGGER_HH

 #define LOGGER_HH


 #include <QFile>

 #include <QTextStream>

 #include <QList>


 #define logDebug() LogMessage(LogMessage::DEBUG, __FILE__, __LINE__)

 #define logInfo()  LogMessage(LogMessage::INFO, __FILE__, __LINE__)

 #define logWarn()  LogMessage(LogMessage::WARNING, __FILE__, __LINE__)

 #define logError() LogMessage(LogMessage::ERROR, __FILE__, __LINE__)

 #ifdef __cpp_lib_stacktrace

 #include <stacktrace>

 #define logFatal() LogMessage(LogMessage::FATAL, __FILE__, __LINE__) << \

   QString::fromStdString(std::to_string(std::stacktrace::current()))

 #else

 #define logFatal() LogMessage(LogMessage::FATAL, __FILE__, __LINE__)

 #endif


 class LogMessage: public QTextStream

 {

 public:

   typedef enum {

     DEBUG,

     INFO,

     WARNING,

     ERROR,

     FATAL

   } Level;


 public:

   LogMessage(Level level, const QString &file, int line, const QString &message="");

   LogMessage(const LogMessage &other);

   virtual ~LogMessage();


   Level level() const;

   const QString &file() const;

   int line() const;

   const QString &message() const;


 protected:

   Level _level;

   QString _file;

   int _line;

   QString _message;

 };


 class LogHandler: public QObject

 {

   Q_OBJECT


 public:

   explicit LogHandler(QObject *parent=nullptr);

   virtual ~LogHandler();

   virtual void handle(const LogMessage &message) = 0;

 };


 class Logger: public QObject

 {

   Q_OBJECT


 protected:

   Logger();


 public:

   virtual ~Logger();


   void log(const LogMessage &msg);

   void addHandler(LogHandler *handler);

   void remHandler(LogHandler *handler);


 protected slots:

   void onHandlerDeleted(QObject *obj);


 public:

   static Logger &get();


 protected:

   static Logger *_instance;

   QList<LogHandler *> _handler;

 };


 class StreamLogHandler: public LogHandler

 {

   Q_OBJECT


 public:

   StreamLogHandler(QTextStream &stream, LogMessage::Level minLevel=LogMessage::DEBUG, bool color=false, QObject *parent=nullptr);


   LogMessage::Level minLevel() const;

   void setMinLevel(LogMessage::Level minLevel);


   void handle(const LogMessage &message);


 protected:

   QTextStream &_stream;

   LogMessage::Level _minLevel;

   bool _color;

 };


 class FileLogHandler: public LogHandler

 {

   Q_OBJECT


 public:

   FileLogHandler(const QString &file, LogMessage::Level minLevel=LogMessage::DEBUG, QObject *parent=nullptr);


   virtual ~FileLogHandler();


   LogMessage::Level minLevel() const;

   void setMinLevel(LogMessage::Level minLevel);


   void handle(const LogMessage &message);


 protected:

   QFile _file;

   QTextStream _stream;

   LogMessage::Level _minLevel;

 };


 #endif // LOGGER_HH

FileLogHandler
A log-handler that dumps log-messages into files.
Definition: logger.hh:163

FileLogHandler::setMinLevel
void setMinLevel(LogMessage::Level minLevel)
Resets the minimum log level.
Definition: logger.cc:218

FileLogHandler::minLevel
LogMessage::Level minLevel() const
Returns the minimum log level.
Definition: logger.cc:213

FileLogHandler::_file
QFile _file
The file to log into.
Definition: logger.hh:185

FileLogHandler::handle
void handle(const LogMessage &message)
Callback to handle log messages.
Definition: logger.cc:223

FileLogHandler::_stream
QTextStream _stream
A reference to the text stream to log into.
Definition: logger.hh:187

FileLogHandler::FileLogHandler
FileLogHandler(const QString &file, LogMessage::Level minLevel=LogMessage::DEBUG, QObject *parent=nullptr)
Constructor.
Definition: logger.cc:181

FileLogHandler::_minLevel
LogMessage::Level _minLevel
The minimum log level.
Definition: logger.hh:189

FileLogHandler::~FileLogHandler
virtual ~FileLogHandler()
Destructor, closes log file.
Definition: logger.cc:205

LogHandler
Interface for all log message handler.
Definition: logger.hh:79

LogHandler::handle
virtual void handle(const LogMessage &message)=0
Callback to handle log messages.

LogHandler::LogHandler
LogHandler(QObject *parent=nullptr)
Constructor.
Definition: logger.cc:52

LogHandler::~LogHandler
virtual ~LogHandler()
Destructor.
Definition: logger.cc:58

LogMessage
Implements a log-message.
Definition: logger.hh:32

LogMessage::_level
Level _level
The log level.
Definition: logger.hh:66

LogMessage::_file
QString _file
The source file.
Definition: logger.hh:68

LogMessage::_line
int _line
The source line.
Definition: logger.hh:70

LogMessage::Level
Level
Possible log-levels.
Definition: logger.hh:35

LogMessage::DEBUG
@ DEBUG
Level for debug messages. Will not be shown to the user unless requested.
Definition: logger.hh:36

LogMessage::FATAL
@ FATAL
Level for fatal error messages.
Definition: logger.hh:40

LogMessage::INFO
@ INFO
Level for informative messages. Will not be shown to the user unless requested.
Definition: logger.hh:37

LogMessage::ERROR
@ ERROR
Level for error messages.
Definition: logger.hh:39

LogMessage::WARNING
@ WARNING
Level for warning messages.
Definition: logger.hh:38

LogMessage::~LogMessage
virtual ~LogMessage()
Destructor.
Definition: logger.cc:24

LogMessage::_message
QString _message
The log message content.
Definition: logger.hh:72

LogMessage::message
const QString & message() const
Returns the log message content.
Definition: logger.cc:44

LogMessage::level
Level level() const
Returns the level of the log message.
Definition: logger.cc:29

LogMessage::line
int line() const
Returns the source line.
Definition: logger.cc:39

LogMessage::file
const QString & file() const
Returns the source file.
Definition: logger.cc:34

LogMessage::LogMessage
LogMessage(Level level, const QString &file, int line, const QString &message="")
Constructor.
Definition: logger.cc:10

Logger
Singleton class to process log messages.
Definition: logger.hh:95

Logger::_handler
QList< LogHandler * > _handler
The list of registered log-handler.
Definition: logger.hh:125

Logger::_instance
static Logger * _instance
The singleton instance.
Definition: logger.hh:123

Logger::onHandlerDeleted
void onHandlerDeleted(QObject *obj)
Internal callback to handle deleted handler objects.
Definition: logger.cc:106

Logger::addHandler
void addHandler(LogHandler *handler)
Adds a log-handler to the logger.
Definition: logger.cc:86

Logger::get
static Logger & get()
Factory method to get the singleton instance.
Definition: logger.cc:111

Logger::Logger
Logger()
Hidden constructor.
Definition: logger.cc:68

Logger::remHandler
void remHandler(LogHandler *handler)
Removes a log-handler from the logger.
Definition: logger.cc:97

Logger::~Logger
virtual ~Logger()
Destructor.
Definition: logger.cc:74

Logger::log
void log(const LogMessage &msg)
Logs a message.
Definition: logger.cc:79

StreamLogHandler
A log-handler that dumps log-messages into a QTextStream.
Definition: logger.hh:132

StreamLogHandler::minLevel
LogMessage::Level minLevel() const
Returns the minimum log level.
Definition: logger.cc:129

StreamLogHandler::handle
void handle(const LogMessage &message)
Callback to handle log messages.
Definition: logger.cc:139

StreamLogHandler::_minLevel
LogMessage::Level _minLevel
The minimum log level.
Definition: logger.hh:154

StreamLogHandler::_stream
QTextStream & _stream
A reference to the text stream to log into.
Definition: logger.hh:152

StreamLogHandler::setMinLevel
void setMinLevel(LogMessage::Level minLevel)
Resets the minimum log level.
Definition: logger.cc:134

StreamLogHandler::StreamLogHandler
StreamLogHandler(QTextStream &stream, LogMessage::Level minLevel=LogMessage::DEBUG, bool color=false, QObject *parent=nullptr)
Constructor.
Definition: logger.cc:122

StreamLogHandler::_color
bool _color
If true, write messages using console colors.
Definition: logger.hh:156