logger.h

Go to the documentation of this file.

 
/**************************************************************************
 *   Copyright (C) 2013 David S. Register                                  *
 *   Copyright (C) 2022 - 2024 Alec Leamas                                 *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, see <https://www.gnu.org/licenses/>. *
 ***************************************************************************/
 
#ifndef LOGGER_H
#define LOGGER_H
 
#include <chrono>
#include <fstream>
#include <ostream>
#include <sstream>
#include <string>
 
#include <wx/log.h>
 
#define DO_LOG_MESSAGE(level, fmt, ...)                                  \
  {                                                                      \
    if (level <= wxLog::GetLogLevel()) {                                 \
      Logger::logMessage(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__); \
    }                                                                    \
  }
 
#define _LOG(level)                 \
  if (level > wxLog::GetLogLevel()) \
    ;                               \
  else                              \
    Logger().get(level, __FILE__, __LINE__)
 
#define TRACE_LOG _LOG(wxLOG_Trace)
#define DEBUG_LOG _LOG(wxLOG_Debug)
#define INFO_LOG _LOG(wxLOG_Info)
#define MESSAGE_LOG _LOG(wxLOG_Message)
#define WARNING_LOG _LOG(wxLOG_Warning)
#define ERROR_LOG _LOG(wxLOG_Error)
 
#define LOG_TRACE(fmt, ...) DO_LOG_MESSAGE(wxLOG_Trace, fmt, ##__VA_ARGS__);
#define LOG_DEBUG(fmt, ...) DO_LOG_MESSAGE(wxLOG_Debug, fmt, ##__VA_ARGS__);
#define LOG_INFO(fmt, ...) DO_LOG_MESSAGE(wxLOG_Info, fmt, ##__VA_ARGS__);
#define LOG_MESSAGE(fmt, ...) DO_LOG_MESSAGE(wxLOG_Message, fmt, ##__VA_ARGS__);
#define LOG_WARNING(fmt, ...) DO_LOG_MESSAGE(wxLOG_Warning, fmt, ##__VA_ARGS__);
#define LOG_ERROR(fmt, ...) DO_LOG_MESSAGE(wxLOG_Error, fmt, ##__VA_ARGS__);
 
class OcpnLog : public wxLog {
public:
  static const wxLogLevel LOG_BADLEVEL;
 
  OcpnLog(const char* path);
 
  virtual ~OcpnLog();
 
  void Flush() override;
 
  void DoLogRecord(wxLogLevel level, const wxString& msg,
                   const wxLogRecordInfo& info) override;
 
  static wxLogLevel str2level(const char* string);
  static std::string level2str(wxLogLevel level);
 
protected:
  std::ofstream log;
};
 
class Logger {
public:
  Logger();
  ~Logger();
 
  void logRecord(wxLogLevel level, const char* msg, const wxLogRecordInfo info);
 
  std::ostream& get(wxLogLevel level, const char* path, int line);
 
  static void logMessage(wxLogLevel level, const char* path, int line,
                         const char* fmt, ...);
 
protected:
  std::stringstream os;
  wxLogRecordInfo info;
  wxLogLevel level;
};
 
class CountedLogFilter {
public:
  CountedLogFilter(unsigned n, wxLogLevel level = wxLOG_Message)
      : m_count(n), m_level(level), m_not_logged(0) {}
 
  void Log(const std::string& message);
 
private:
  const unsigned m_count;
  const wxLogLevel m_level;
  unsigned m_not_logged;
};
 
class TimedLogFilter {
public:
  TimedLogFilter(const std::chrono::seconds& interval,
                 wxLogLevel level = wxLOG_Message)
      : m_interval(interval), m_level(level), m_not_logged(0) {}
 
  void Log(const std::string& message);
 
private:
  const std::chrono::seconds m_interval;
  const wxLogLevel m_level;
  std::chrono::time_point<std::chrono::steady_clock> m_last_logged;
  unsigned m_not_logged;
};
 
#endif  // LOGGER_H