RDLog.h

Go to the documentation of this file.

//
// Copyright (C)  2005-2022 Greg Landrum and other RDKit contributors
//
//  @@ All Rights Reserved @@
//  This file is part of the RDKit.
//  The contents are covered by the terms of the BSD license
//  which is included in the file license.txt, found at the root
//  of the RDKit source tree.
//
 
#include <RDGeneral/export.h>
#ifndef RDLOG_H_29JUNE2005
#define RDLOG_H_29JUNE2005
 
#include "BoostStartInclude.h"
#include <boost/iostreams/tee.hpp>
#include <boost/iostreams/stream.hpp>
#include "BoostEndInclude.h"
#include <fstream>
#include <sstream>
#include <vector>
#include <cstdint>
 
namespace boost {
namespace logging {
 
typedef boost::iostreams::tee_device<std::ostream, std::ostream> RDTee;
typedef boost::iostreams::stream<RDTee> RDTeeStream;
 
class RDKIT_RDGENERAL_EXPORT rdLogger {
 public:
  std::ostream *dp_dest;
  bool df_owner;
  bool df_enabled;
 
  std::ofstream *dp_teeHelperStream;
  RDTee *tee;
  RDTeeStream *teestream;
 
  rdLogger(std::ostream *dest, bool owner = false)
      : dp_dest(dest),
        df_owner(owner),
        df_enabled(true),
        dp_teeHelperStream(nullptr),
        tee(nullptr),
        teestream(nullptr) {}
 
  //! Sets a stream to tee the output to.
  void SetTee(std::ostream &stream) {
    if (dp_dest) {
      ClearTee();
      tee = new RDTee(*dp_dest, stream);
      teestream = new RDTeeStream(*tee);
    }
  }
 
  //! Sets a filename to tee the output to.
  void SetTee(const char *filename) {
    if (dp_dest) {
      auto s = new std::ofstream(filename);
      SetTee(*s);
      dp_teeHelperStream = s;
    }
  }
 
  //! Sets a filename to tee the output to.
  void SetTee(const std::string &filename) { return SetTee(filename.c_str()); }
 
  //! Remove our tee if it's set.
  void ClearTee() {
    if (dp_dest) {
      delete teestream;
      delete tee;
      tee = nullptr;
      teestream = nullptr;
      if (dp_teeHelperStream) {
        dp_teeHelperStream->close();
        delete dp_teeHelperStream;
        dp_teeHelperStream = nullptr;
      }
    }
  }
  ~rdLogger() {
    if (dp_dest) {
      dp_dest->flush();
      ClearTee();
      if (df_owner) {
        delete dp_dest;
      }
      dp_dest = nullptr;
    }
  }
 
 private:
  // disable copy ctor and assignment
  rdLogger(const rdLogger &);
  rdLogger &operator=(const rdLogger &);
};
RDKIT_RDGENERAL_EXPORT void enable_logs(const char *arg);
RDKIT_RDGENERAL_EXPORT void enable_logs(const std::string &arg);
RDKIT_RDGENERAL_EXPORT void disable_logs(const char *arg);
RDKIT_RDGENERAL_EXPORT void disable_logs(const std::string &arg);
RDKIT_RDGENERAL_EXPORT std::string log_status();
}  // namespace logging
}  // namespace boost
namespace RDLog {
RDKIT_RDGENERAL_EXPORT std::ostream &toStream(std::ostream &);
}
#define BOOST_LOG(__arg__)                                      \
  if ((__arg__) && (__arg__->dp_dest) && (__arg__->df_enabled)) \
  RDLog::toStream((__arg__->teestream) ? *(__arg__->teestream)  \
                                       : *(__arg__->dp_dest))
 
using RDLogger = std::shared_ptr<boost::logging::rdLogger>;
 
RDKIT_RDGENERAL_EXPORT extern RDLogger rdAppLog;
RDKIT_RDGENERAL_EXPORT extern RDLogger rdDebugLog;
RDKIT_RDGENERAL_EXPORT extern RDLogger rdInfoLog;
RDKIT_RDGENERAL_EXPORT extern RDLogger rdErrorLog;
RDKIT_RDGENERAL_EXPORT extern RDLogger rdWarningLog;
RDKIT_RDGENERAL_EXPORT extern RDLogger rdStatusLog;
 
namespace RDLog {
RDKIT_RDGENERAL_EXPORT void InitLogs();
 
using RDLoggerList = std::vector<RDLogger>;
class RDKIT_RDGENERAL_EXPORT LogStateSetter : public boost::noncopyable {
 public:
  //! enables only the logs in the list, the current state will be restored when
  //! this object is destroyed
  LogStateSetter(RDLoggerList toEnable);
  //! disables all logs, the current state will be restored when this object is
  //! destroyed
  LogStateSetter();
  ~LogStateSetter();
 
 private:
  std::uint64_t d_origState = 0;
};
 
//! RAII class to capture messages from a given \c RDLogger.
//!
//! The log is enabled when this object is constructed and its original enabled
//! state is restored when this object is destroyed. The stream destination is
//! also restored on destruction. Nesting is supported: inner captures shadow
//! outer ones.
//!
//! \b Example:
//! \code
//!   RDLog::CaptureLog capture{rdErrorLog};
//!   functionThatMayFail();
//!   std::string errs = capture.messages();
//! \endcode
class RDKIT_RDGENERAL_EXPORT CaptureLog : public boost::noncopyable {
 public:
  explicit CaptureLog(RDLogger log);
  ~CaptureLog();
 
  //! Returns all messages captured since construction.
  std::string messages() const;
 
 private:
  RDLogger d_log;
  std::stringstream d_messages;
  std::ostream *d_savedDest = nullptr;
  boost::logging::RDTeeStream *d_savedTeestream = nullptr;
  bool d_logWasEnabled = true;
};
 
//! Convenience subclass of \c CaptureLog that captures \c rdErrorLog.
class RDKIT_RDGENERAL_EXPORT CaptureErrorLog : public CaptureLog {
 public:
  CaptureErrorLog() : CaptureLog(rdErrorLog) {}
};
 
inline void deprecationWarning(const std::string &message) {
  BOOST_LOG(rdWarningLog) << "DEPRECATION WARNING: " << message << std::endl;
}
 
}  // namespace RDLog
#endif