Logger.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidKernel/DllConfig.h"
#include "MantidKernel/ThreadSafeLogStream.h"
 
#include <Poco/Message.h>
#include <array>
#include <iosfwd>
#include <memory>
#include <string>
 
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
namespace Poco {
class Logger;
}
 
namespace Mantid {
namespace Kernel {
 
class MANTID_KERNEL_DLL Logger {
public:
  // Our logger's priority types are the same as POCO's Message's types.
  using Priority = Poco::Message::Priority;
 
  static const std::array<std::string, 9> PriorityNames;
 
  Logger(const std::string &name);
  void setName(const std::string &name);
 
  void fatal(const std::string &msg);
  void error(const std::string &msg);
  void warning(const std::string &msg);
  void notice(const std::string &msg);
  void information(const std::string &msg);
  void debug(const std::string &msg);
  void accumulate(const std::string &msg);
  void flush();
  void flush(Priority);
  void flushDebug();
  void flushInformation();
  void flushNotice();
  void flushWarning();
  void flushError();
  void flushFatal();
  void purge();
 
  std::ostream &fatal();
  std::ostream &error();
  std::ostream &warning();
  std::ostream &notice();
  std::ostream &information();
  std::ostream &debug();
 
  void log(const std::string &message, const Priority &priority);
 
  std::ostream &getLogStream(const Priority &priority);
 
  void dump(const std::string &msg, const void *buffer, std::size_t length);
 
  void setLevel(int level);
 
  void setLevelOffset(int level);
 
  int getLevelOffset() const;
 
  int getLevel() const;
 
  std::string getLevelName() const;
 
  void setLevel(const std::string &level);
 
  bool getEnabled() const;
 
  void setEnabled(const bool enabled);
 
  bool is(int level) const;
 
  bool isDebug() const;
 
  static void setLevelForAll(const int level);
  static void setLevelForAll(const std::string &level);
 
  static void shutdown();
 
private:
  // Disable default constructor
  Logger();
  Logger(const Logger &);
  Logger &operator=(const Logger &);
 
  Priority applyLevelOffset(Priority proposedLevel);
 
  Poco::Logger *m_log;
  std::unique_ptr<ThreadSafeLogStream> m_logStream;
 
  int m_levelOffset;
  bool m_enabled;
};
 
} // namespace Kernel
} // namespace Mantid