Log.h

Go to the documentation of this file.

/*
   For more information, please see: http://software.sci.utah.edu

   The MIT License

   Copyright (c) 2012 Scientific Computing and Imaging Institute,
   University of Utah.

   
   Permission is hereby granted, free of charge, to any person obtaining a
   copy of this software and associated documentation files (the "Software"),
   to deal in the Software without restriction, including without limitation
   the rights to use, copy, modify, merge, publish, distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included
   in all copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
   DEALINGS IN THE SOFTWARE.
*/
/// @todo Documentation Core/Logging/Log.h

#ifndef CORE_LOGGING_LOG_H
#define CORE_LOGGING_LOG_H 

#include <string>
#include <Core/Logging/LoggerFwd.h>
#ifndef Q_MOC_RUN
#include <boost/lexical_cast.hpp>
#endif
#include <Core/Logging/share.h>

namespace SCIRun 
{
  namespace Core
  {
    namespace Logging
    {
      //Copied from http://jonblack.org/2013/01/27/wrapping-a-logging-framework-in-cpp/

      /// Logging levels used by pix. Follows the same as for syslog, taken from
      /// RFC 5424. Comments added for ease of reading.
      /// @see http://en.wikipedia.org/wiki/Syslog.
      enum LogLevel
      {
        EMERG,  // System is unusable (e.g. multiple parts down)
        ALERT,  // System is unusable (e.g. single part down)
        CRIT,   // Failure in non-primary system (e.g. backup site down)
        ERROR_LOG,  // Non-urgent failures; relay to developers
        WARN,   // Not an error, but indicates error will occur if nothing done.
        NOTICE, // Events that are unusual, but not error conditions.
        INFO,   // Normal operational messages. No action required.
        DEBUG_LOG,  // Information useful during development for debugging.
        NOTSET
      };

      class SCISHARE Log /*final*/
      {
      public:
        static Log& get();
        static Log& get(const std::string& name);

        class SCISHARE Stream
        {
        public:
          explicit Stream(class LogStreamImpl* impl);
          SCISHARE friend Stream& operator<<(Stream& log, const std::string& msg);
          void stream(const std::string& msg);
          void stream(double x);
          void flush();
        private:
          boost::shared_ptr<class LogStreamImpl> impl_;
        };

        void log(LogLevel level, const std::string& msg);

        SCISHARE friend Stream& operator<<(Log& log, LogLevel level);

        void setVerbose(bool v);
        bool verbose() const;
        void flush();

      private:
        Log();
        explicit Log(const std::string& name);
        Log(const Log&)/* =delete*/;
        Log(Log&&)/* =delete*/;
        Log& operator=(const Log&)/* =delete*/;
        Log& operator=(Log&&)/* =delete*/;

      private:
        friend class Stream;
        boost::shared_ptr<class LogImpl> impl_;
      };

      SCISHARE Log::Stream& operator<<(Log& log, LogLevel level);
      SCISHARE Log::Stream& operator<<(Log::Stream& log, const std::string& msg);
      SCISHARE Log::Stream& operator<<(Log::Stream& log, double x);

      template <typename T>
      Log::Stream& operator<<(Log::Stream& log, const T& t)
      {
        return log << boost::lexical_cast<std::string>(t);
      }

      SCISHARE Log::Stream& operator<<(Log::Stream& log, std::ostream&(*func)(std::ostream&));
    }
  }
}

/// @todo: log4cpp crashes on Mac more easily, just macro these out on that platform for now.
#ifdef _WIN32
#define LOG_DEBUG(str) SCIRun::Core::Logging::Log::get() << SCIRun::Core::Logging::DEBUG_LOG << str << std::endl
#else
#define LOG_DEBUG(str)
#endif

#define LOG_DEBUG_TO(log, str) log << SCIRun::Core::Logging::DEBUG_LOG << str << std::endl

#endif