logger.h

Go to the documentation of this file.

//
// Copyright (c) 2013 by Ben Morgan <bmorgan.warwick@gmail.com>
// Copyright (c) 2013 by The University of Warwick
// Copyright (c) 2016-2018 by François Mauger <mauger@lpccaen.inp3.fr>
// Copyright (c) 2016-2018 by Université de Caen Normandie
//
// This file is part of datatools.
//
// datatools is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// datatools is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with datatools.  If not, see <http://www.gnu.org/licenses/>.

#ifndef DATATOOLS_LOGGER_H
#define DATATOOLS_LOGGER_H

// Standard Library:
#include <iostream>

// Third Party:
// - Boost:
#include "boost/current_function.hpp"

// This project:
#ifndef Q_MOC_RUN
#include <datatools/reflection_interface.h>
#endif // Q_MOC_RUN

namespace datatools {

  // Forward declarations:
  class properties;
  class object_configuration_description;

  struct logger {

    enum priority {
      PRIO_ALWAYS   = -1, 
      PRIO_UNDEFINED = 0, 
      PRIO_FATAL,         
      PRIO_CRITICAL,      
      PRIO_ERROR,         
      PRIO_WARNING,       
      PRIO_NOTICE,        
      PRIO_INFORMATION,   
      PRIO_DEBUG,         
      PRIO_TRACE          
    };

    static priority get_priority(const std::string& name);

    static std::string get_priority_label(priority p_);

    static bool is_undefined(priority p_);

    static bool is_fatal(priority p_);

    static bool is_critical(priority p_);

    static bool is_error(priority p_);

    static bool is_warning(priority p_);

    static bool is_notice(priority p_);

    static bool is_information(priority p_);

    static bool is_debug(priority p_);

    static bool is_trace(priority p_);

    static priority extract_logging_configuration(const datatools::properties & config_,
                                                  priority default_prio_ = datatools::logger::PRIO_FATAL,
                                                  bool throw_on_error_ = true);

    static void declare_ocd_logging_configuration(datatools::object_configuration_description &,
                                                  const std::string & default_value_ = "fatal",
                                                  const std::string & prefix_ = "",
                                                  const std::string & from_ = "");

  };

} // namespace datatools

#ifndef Q_MOC_RUN
// Activate reflection layer for the 'datatools::logger::priority' enum:
DR_TYPE_INIT(::datatools::logger) // mandatory to access the embedded enum
DR_TYPE_INIT(::datatools::logger::priority)
#endif // Q_MOC_RUN

#include <datatools/detail/logger_macros.h>

#endif // DATATOOLS_LOGGER_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --