synclog.hpp

Go to the documentation of this file.

#ifndef UPnPsdk_SYNCLOG_HPP
#define UPnPsdk_SYNCLOG_HPP
// Copyright (C) 2024+ GPL 3 and higher by Ingo Höft, <Ingo@Hoeft-online.de>
// Redistribution only with this Copyright remark. Last modified: 2025-05-04
#include <cmake_vars.hpp>
#include <UPnPsdk/global.hpp>
#include <UPnPsdk/pthread.hpp>
#include <string>
#include <iostream>
#ifndef __APPLE__
#include <syncstream>
#endif
 
namespace UPnPsdk {
 
// clang-format off
 
// Usage: SYNC(std::cout) << "Message\n";
// Usage: SYNC(std::cerr) << "Error\n";
#ifdef __APPLE__
  #define SYNC(s) (s)
#else
  #define SYNC(s) std::osyncstream((s))
#endif
 
 
// Trace messages
// --------------
#ifdef UPnPsdk_WITH_TRACE
  #define TRACE(s) SYNC(std::cerr)<<"TRACE["<<(static_cast<const char*>(__FILE__) + CMAKE_SOURCE_PATH_LENGTH)<<":"<<__LINE__<<"] "<<(s)<<"\n";
  #define TRACE2(a, b) SYNC(std::cerr)<<"TRACE["<<(static_cast<const char*>(__FILE__) + CMAKE_SOURCE_PATH_LENGTH)<<":"<<__LINE__<<"] "<<(a)<<(b)<<"\n";
#else // no UPnPsdk_WITH_TRACE
  #define TRACE(s)
  #define TRACE2(a, b)
#endif
 
 
// Debug output messages with some that can be enabled during runtime.
// -------------------------------------------------------------------
// __func__ is defined for POSIX so we have it there for the
// function signature to output for information. On MSC_VER it is named
// __FUNCTION__. __PRETTY_FUNCTION__ is also available.
#if defined(_MSC_VER) || defined(__APPLE__)
#define __func__ __FUNCTION__
#define PTHREAD_SELF UPnPsdk::pthread_self()
// or more verbose: #define __PRETTY_FUNCTION__ __FUNCSIG__
#else
#define PTHREAD_SELF ::pthread_self()
#endif
 
// This is intended to be used as:
// throw(UPnPsdk_LOGEXCEPT("MSG1nnn") "exception message.\n");
#define UPnPsdk_LOGEXCEPT(m) "UPnPsdk "+std::string(m)+" EXCEPT[#"+std::to_string(PTHREAD_SELF)+" "+::std::string(__func__)+"()] "
#define UPnPsdk_LOGWHAT "UPnPsdk ["+::std::string(__func__)+"] WHAT "
 
// Next line mainly used for Unit Tests to catch the right output channel.
inline constexpr int log_fileno{2}; // 1 = stdout, 2 = stderr, conforming to next line
#define UPnPsdk_LOG(m) SYNC(std::cerr)<<"UPnPsdk "<<(m)
 
// Critical messages are always output.
#define UPnPsdk_LOGCRIT(m) UPnPsdk_LOG(m)<<" CRIT  [#"<<PTHREAD_SELF<<" "<<__func__<<"()] "
// Messages only with debug enabled.
#define UPnPsdk_LOGERR(m) if(UPnPsdk::g_dbug) UPnPsdk_LOG(m)<<" ERROR [#"<<PTHREAD_SELF<<" "<<__func__<<"()] "
#define UPnPsdk_LOGCATCH(m) if(UPnPsdk::g_dbug) UPnPsdk_LOG(m)<<" CATCH [#"<<PTHREAD_SELF<<" "<<__func__<<"()] "
#define UPnPsdk_LOGINFO(m) if(UPnPsdk::g_dbug) UPnPsdk_LOG(m)<<" INFO  [#"<<PTHREAD_SELF<<" "<<__func__<<"()] "
 
// clang-format on
} // namespace UPnPsdk
 
#endif // UPnPsdk_SYNCLOG_HPP