itkLoggerBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkLoggerBase_h
#define itkLoggerBase_h
 
#include "itkMultipleLogOutput.h"
#include "itkRealTimeClock.h"
#include "ITKCommonExport.h"
#ifdef DEBUG
#  undef DEBUG // HDF5 publicly exports this define when built in debug mode
// That messes up the DEBUG enumeration in PriorityLevelEnum.
#endif
 
namespace itk
{
/*** \class LoggerBaseEnums
 * \brief Contains all enum classes used by LoggerBase class.
 * \ingroup ITKCommon
 */
class LoggerBaseEnums
{
public:
  enum class PriorityLevel : uint8_t
  {
    MUSTFLUSH = 0,
    FATAL,
    CRITICAL,
    WARNING,
    INFO,
    DEBUG,
    NOTSET
  };

  enum class TimeStampFormat : uint8_t
  {
    REALVALUE = 0,
    HUMANREADABLE = 1
  };
};
 
// Define how to print enumeration
extern ITKCommon_EXPORT std::ostream &
                        operator<<(std::ostream & out, const LoggerBaseEnums::PriorityLevel value);
extern ITKCommon_EXPORT std::ostream &
                        operator<<(std::ostream & out, const LoggerBaseEnums::TimeStampFormat value);

 
class ITKCommon_EXPORT LoggerBase : public Object
{
public:
  using Self = LoggerBase;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(LoggerBase);
 
  using OutputType = MultipleLogOutput::OutputType;
 
  using PriorityLevelEnum = LoggerBaseEnums::PriorityLevel;
#if !defined(ITK_LEGACY_REMOVE)
  // We need to expose the enum values at the class level
  // for backwards compatibility
  static constexpr PriorityLevelEnum MUSTFLUSH = PriorityLevelEnum::MUSTFLUSH;
  static constexpr PriorityLevelEnum FATAL = PriorityLevelEnum::FATAL;
  static constexpr PriorityLevelEnum CRITICAL = PriorityLevelEnum::CRITICAL;
  static constexpr PriorityLevelEnum WARNING = PriorityLevelEnum::WARNING;
  static constexpr PriorityLevelEnum INFO = PriorityLevelEnum::INFO;
  static constexpr PriorityLevelEnum DEBUG = PriorityLevelEnum::DEBUG;
  static constexpr PriorityLevelEnum NOTSET = PriorityLevelEnum::NOTSET;
#endif
 
  itkSetStringMacro(Name);
  itkGetStringMacro(Name);
 
  using TimeStampFormatEnum = LoggerBaseEnums::TimeStampFormat;
#if !defined(ITK_LEGACY_REMOVE)
  // We need to expose the enum values at the class level
  // for backwards compatibility
  static constexpr TimeStampFormatEnum REALVALUE = TimeStampFormatEnum::REALVALUE;
  static constexpr TimeStampFormatEnum HUMANREADABLE = TimeStampFormatEnum::HUMANREADABLE;
#endif

  itkSetEnumMacro(TimeStampFormat, TimeStampFormatEnum);
  itkGetConstReferenceMacro(TimeStampFormat, TimeStampFormatEnum);

  itkSetStringMacro(HumanReadableFormat);
  itkGetStringMacro(HumanReadableFormat);

  virtual std::string
  BuildFormattedEntry(PriorityLevelEnum level, const std::string & content);

  virtual void
  SetPriorityLevel(PriorityLevelEnum level)
  {
    m_PriorityLevel = level;
  }

  virtual PriorityLevelEnum
  GetPriorityLevel() const
  {
    return m_PriorityLevel;
  }
 
  virtual void
  SetLevelForFlushing(PriorityLevelEnum level)
  {
    m_LevelForFlushing = level;
  }
 
  virtual PriorityLevelEnum
  GetLevelForFlushing() const
  {
    return m_LevelForFlushing;
  }

  virtual void
  AddLogOutput(OutputType * output);
 
  virtual void
  Write(PriorityLevelEnum level, const std::string & content);

  void
  Debug(const std::string & message)
  {
    this->Write(LoggerBase::PriorityLevelEnum::DEBUG, message);
  }
 
  void
  Info(const std::string & message)
  {
    this->Write(LoggerBase::PriorityLevelEnum::INFO, message);
  }
 
  void
  Warning(const std::string & message)
  {
    this->Write(LoggerBase::PriorityLevelEnum::WARNING, message);
  }
 
  void
  Critical(const std::string & message)
  {
    this->Write(LoggerBase::PriorityLevelEnum::CRITICAL, message);
  }
 
  void
  Error(const std::string & message)
  {
    this->Write(LoggerBase::PriorityLevelEnum::CRITICAL, message);
  }
 
  void
  Fatal(const std::string & message)
  {
    this->Write(LoggerBase::PriorityLevelEnum::FATAL, message);
  }
 
  virtual void
  Flush();
 
protected:
  virtual void
  PrivateFlush();

  LoggerBase();

  ~LoggerBase() override;

  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
protected:
  PriorityLevelEnum m_PriorityLevel{};
 
  PriorityLevelEnum m_LevelForFlushing{};
 
  MultipleLogOutput::Pointer m_Output{};
 
  RealTimeClock::Pointer m_Clock{};
 
  TimeStampFormatEnum m_TimeStampFormat{};
 
  std::string m_HumanReadableFormat{};
 
private:
  std::string m_Name{};
}; // class LoggerBase
} // namespace itk
 
#endif // itkLoggerBase_h