Log.h

Go to the documentation of this file.

/*
 * Deskflow -- mouse and keyboard sharing utility
 * SPDX-FileCopyrightText: (C) 2026 Deskflow Developers.
 * SPDX-FileCopyrightText: (C) 2012 - 2016 Synergy App Ltd
 * SPDX-FileCopyrightText: (C) 2002 Chris Schoeneman
 * SPDX-License-Identifier: GPL-2.0-only WITH LicenseRef-OpenSSL-Exception
 */
 
#pragma once
 
#include "common/LogLevel.h"
 
#include <list>
#include <mutex>
 
#include <QString>
 
#define CLOG (Log::getInstance())
#define BYE "\nTry `%s --help' for more information."
 
class ILogOutputter;
class Thread;


class Log
{
public:
  explicit Log(bool singleton = true);
  explicit Log(Log *src);
  Log(Log const &) = delete;
  Log(Log &&) = delete;
  ~Log();
 
  Log &operator=(Log const &) = delete;
  Log &operator=(Log &&) = delete;




  void insert(ILogOutputter *adoptedOutputter, bool alwaysAtHead = false);


  void remove(ILogOutputter *orphaned);


  void pop_front(bool alwaysAtHead = false);


  bool setFilter(const QString &name);

  void setFilter(LogLevel::Level);




  void print(const char *file, int line, const char *format, ...);

  LogLevel::Level getFilter() const;

  static Log *getInstance();

  LogLevel::Level getConsoleMaxLevel() const
  {
    return LogLevel::Level::Verbose;
  }

 
private:
  void output(LogLevel::Level priority, const char *msg);
 
private:
  using OutputterList = std::list<ILogOutputter *>;
 
  static Log *s_log;
 
  mutable std::mutex m_mutex;
  OutputterList m_outputters;
  OutputterList m_alwaysOutputters;
  LogLevel::Level m_maxPriority;
};


 
#if defined(NOLOGGING)
#define LOG(_a1)
#define LOGC(_a1, _a2)
#define CLOG_TRACE
#elif defined(NDEBUG)
#define LOG(_a1) CLOG->print _a1
#define LOGC(_a1, _a2)                                                                                                 \
  if (_a1)                                                                                                             \
  CLOG->print _a2
#define CLOG_TRACE nullptr, 0,
#else
#define LOG(_a1) CLOG->print _a1
#define LOGC(_a1, _a2)                                                                                                 \
  if (_a1)                                                                                                             \
  CLOG->print _a2
#define CLOG_TRACE __FILE__, __LINE__,
#endif
 
// the CLOG_* defines are line and file plus %z and an octal number (060=0,
// 071=9), but the limitation is that once we run out of numbers at either
// end, then we resort to using non-numerical chars. this still works (since
// to deduce the number we subtract octal \060, so '/' is -1, and ':' is 10
 
// Priority tag used as the first three bytes of a format string. Log::print
// reads fmt[2] - '0' to recover the level, so the escape must be ASCII '0'-'9'.
#define CLOG_TAG_PRINT "%z\057" // char is '/'
#define CLOG_TAG_CRIT "%z\060"  // char is '0'
#define CLOG_TAG_ERR "%z\061"
#define CLOG_TAG_WARN "%z\062"
#define CLOG_TAG_INFO "%z\063"
#define CLOG_TAG_DEBUG "%z\064"
#define CLOG_TAG_VERBOSE "%z\065"
 
#define CLOG_PRINT CLOG_TRACE CLOG_TAG_PRINT
#define CLOG_CRIT CLOG_TRACE CLOG_TAG_CRIT
#define CLOG_ERR CLOG_TRACE CLOG_TAG_ERR
#define CLOG_WARN CLOG_TRACE CLOG_TAG_WARN
#define CLOG_INFO CLOG_TRACE CLOG_TAG_INFO
#define CLOG_DEBUG CLOG_TRACE CLOG_TAG_DEBUG
#define CLOG_VERBOSE CLOG_TRACE CLOG_TAG_VERBOSE
 
#define LOG_PRINT(...) LOG((CLOG_PRINT __VA_ARGS__))
#define LOG_CRIT(...) LOG((CLOG_CRIT __VA_ARGS__))
#define LOG_ERR(...) LOG((CLOG_ERR __VA_ARGS__))
#define LOG_WARN(...) LOG((CLOG_WARN __VA_ARGS__))
#define LOG_INFO(...) LOG((CLOG_INFO __VA_ARGS__))
#define LOG_DEBUG(...) LOG((CLOG_DEBUG __VA_ARGS__))
#define LOG_VERBOSE(...) LOG((CLOG_VERBOSE __VA_ARGS__))