MLogging.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ISF_FASTCALOSIMEVENT_MLogging_h
#define ISF_FASTCALOSIMEVENT_MLogging_h
 
#include <TNamed.h> //for ClassDef
#include "CxxUtils/checker_macros.h"
 
#if defined(__FastCaloSimStandAlone__)
#include <iomanip>
#include <iostream>
namespace MSG {
enum Level {
  NIL = 0,
  VERBOSE,
  DEBUG,
  INFO,
  WARNING,
  ERROR,
  FATAL,
  ALWAYS,
  NUM_LEVELS
}; // enum Level
} // end namespace MSG
 
// Macro for use outside classes.
// Use this in standalone functions or static methods.
#define ATH_MSG_NOCLASS(logger_name, x)                                        \
  do {                                                                         \
    logger_name.msg() << logger_name.startMsg(MSG::ALWAYS, __FILE__, __LINE__) \
                      << x << std::endl;                                       \
  } while (0)
#else // not __FastCaloSimStandAlone__ We get some things from AthenaKernal.
// STL includes
#include <iosfwd>
#include <string>
#include <atomic>
 
// framework includes
#include "GaudiKernel/MsgStream.h"
#include "Gaudi/Property.h"
#include "AthenaBaseComps/AthMsgStreamMacros.h"
#include "AthenaKernel/getMessageSvc.h"
 
#include <boost/thread/tss.hpp>
 
// Macro for use outside classes.
// Use this in standalone functions or static methods.
// Differs, becuase it must call doOutput
#define ATH_MSG_NOCLASS(logger_name, x)                                        \
  do {                                                                         \
    logger_name.msg(MSG::ALWAYS) << x << std::endl;                            \
    logger_name.msg().doOutput();                                              \
  } while (0)
#endif // end not __FastCaloSimStandAlone__
 
// Declare the class accessories in a namespace
// namespace ISF_FCS {
//__attribute__((unused)) static const char *LevelNames[MSG::NUM_LEVELS] = {
//    "NIL", "VERBOSE", "DEBUG", "INFO", "WARNING", "ERROR", "FATAL", "ALWAYS"};
//} // end namespace ISF_FCS
 
// Declare the class in a namespace
namespace ISF_FCS {
 
// Define Athena like message macros such that they work stand alone
#if defined(__FastCaloSimStandAlone__)
 
// We can define a number of macros here to replace standard ATH_MSG
// macros. This can only be done outside Athena or the compiler complains.
typedef std::ostream MsgStream;
 
#define ATH_MSG_LVL(enum_lvl, x)                                               \
  do {                                                                         \
    if (this->msgLvl(enum_lvl))                                                \
      this->msg() << this->startMsg(enum_lvl, __FILE__, __LINE__) << x         \
                  << std::endl;                                                \
  } while (0)
 
#define ATH_MSG_LVL_NOCHK(enum_lvl, x)                                         \
  do {                                                                         \
    this->msg() << this->startMsg(enum_lvl, __FILE__, __LINE__) << x           \
                << std::endl;                                                  \
  } while (0)
 
#define ATH_MSG_VERBOSE(x) ATH_MSG_LVL(MSG::VERBOSE, x)
#define ATH_MSG_DEBUG(x) ATH_MSG_LVL(MSG::DEBUG, x)
#define ATH_MSG_INFO(x) ATH_MSG_LVL_NOCHK(MSG::INFO, x)
#define ATH_MSG_WARNING(x) ATH_MSG_LVL_NOCHK(MSG::WARNING, x)
#define ATH_MSG_ERROR(x) ATH_MSG_LVL_NOCHK(MSG::ERROR, x)
#define ATH_MSG_FATAL(x) ATH_MSG_LVL_NOCHK(MSG::FATAL, x)
 
// Set up a stream that can be used like: ATH_MSG(INFO) << "hello" <<
// END_MSG(INFO); It needs to only write the left columns once, until it is fed
// another END_MSG
 
// Provide a stream
#define ATH_MSG(lvl) this->stream(MSG::lvl, __FILE__, __LINE__)
// Add a new line if the level is in use, and end any stream
#define END_MSG(lvl) this->streamerEndLine(MSG::lvl)
// Force a new line, and end any stream
#define endmsg this->streamerEndLine(MSG::INFO)
 
class MLogging {
 
public:
  MLogging(){};
  MLogging(const MLogging &other) : m_level(other.m_level){};
  MLogging &operator=(MLogging other) {
    m_level = other.m_level;
    return *this;
  };

  virtual ~MLogging(){};

  MSG::Level level() const { return m_level; }
  virtual void setLevel(int level);

  static std::string startMsg(MSG::Level lvl, const std::string& file, int line);

  MsgStream &msg() const { return *m_msg; }
  MsgStream &msg(const MSG::Level lvl) const;
  MsgStream &stream(MSG::Level lvl, std::string file, int line) const;
  bool msgLvl(const MSG::Level lvl) const;

  void print(MSG::Level lvl, std::string file, int line,
             std::string message) const;

  std::string streamerEndLine(MSG::Level lvl) const;
 
private:
  bool streamerInLine() const { return m_streamer_in_line; }
  void streamerInLine(bool is_in_line) const;
  bool streamerNeedStart(MSG::Level lvl, std::string file) const;
 
  MSG::Level m_level = MSG::INFO; 
 
  MsgStream *m_msg = &std::cout;             
  MsgStream m_null_msg = MsgStream(nullptr); 
  MsgStream *m_null_msg_ptr = &m_null_msg;   
 
  mutable bool m_streamer_in_line = false;          
  mutable MSG::Level m_streamer_has_lvl = MSG::NIL; 
  mutable std::string m_streamer_from_file = "";    
 
  // Version number 0 to tell ROOT not to store this.
  ClassDef(MLogging, 0)
};
 
#else // end __FastCaloSimStandAlone__
// For inside Athena
 
#define END_MSG(lvl) endmsg
 
// Note that we also cannot use AthMessaging as a base class as this
// creates problems when storing these objects in ROOT files (ATLASSIM-5854).
class MLogging {
 
public:
  MLogging(const std::string &name = "ISF_FastCaloSimEvent");

  // in the AthMessaging, these were disabled, but I dont' see why.
  MLogging(const MLogging &rhs);
  MLogging &operator=(const MLogging &rhs);

  virtual ~MLogging();

  bool msgLvl(const MSG::Level lvl) const;

  MsgStream &msg() const;

  MsgStream &msg(const MSG::Level lvl) const;

  // This isn't in AthMessaging, but it's useful
  MSG::Level level() const { return msg().level(); }
  virtual void setLevel(MSG::Level lvl);

  // This isn't in AthMessaging, but it's useful outside classes
  static std::string startMsg(MSG::Level lvl, const std::string& file, int line);
 
private:
  std::string m_nm; 

  inline static boost::thread_specific_ptr<MsgStream> m_msg_tls
      ATLAS_THREAD_SAFE; 
 
  ClassDef(MLogging, 0)
};
 
// Inline methods:
 
inline bool MLogging::msgLvl(const MSG::Level lvl) const {
  if (msg().level() <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}
 
inline MsgStream &MLogging::msg() const {
  MsgStream *ms = m_msg_tls.get();
  if (!ms) {
    ms = new MsgStream(Athena::getMessageSvc(), m_nm);
    m_msg_tls.reset(ms);
  }
  return *ms;
}
 
inline MsgStream &MLogging::msg(const MSG::Level lvl) const {
  return msg() << lvl;
}
 
#endif // end not __FastCaloSimStandAlone__
 
} // namespace ISF_FCS
 
#endif // End header guard