LogStream.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2022.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow, Stephan Aiche, Andreas Bertsch$
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/CONCEPT/Macros.h>
#include <OpenMS/DATASTRUCTURES/String.h>

#include <sstream>
#include <iostream>
#include <list>
#include <vector>
#include <ctime>
#include <map>

namespace OpenMS
{
  class Colorizer;

  namespace Logger
  {
    // forward declarations
    class LogStream;
    class LogStreamNotifier;

    class OPENMS_DLLAPI LogStreamBuf :
      public std::streambuf
    {

      friend class LogStream;

public:


      static const time_t MAX_TIME;
      static const std::string UNKNOWN_LOG_LEVEL;




      LogStreamBuf(const std::string& log_level = UNKNOWN_LOG_LEVEL, Colorizer* col = nullptr);

      ~LogStreamBuf() override;




      int sync() override;

      int overflow(int c = -1) override;




      void setLevel(std::string level);


      std::string getLevel();

      struct OPENMS_DLLAPI StreamStruct
      {
        std::ostream * stream;
        std::string         prefix;
        LogStreamNotifier * target;

        StreamStruct() :
          stream(nullptr),
          target(nullptr)
        {}

        ~StreamStruct()
        {}

      };

      void clearCache();

protected:

      void distribute_(const std::string& outstring);

      std::string expandPrefix_(const std::string & prefix, time_t time) const;

      char * pbuf_ = nullptr;
      std::string             level_;
      std::list<StreamStruct> stream_list_;
      std::string             incomplete_line_;
      Colorizer* colorizer_ = nullptr; 


      struct LogCacheStruct
      {
        Size timestamp;
        int counter;
      };

      Size log_cache_counter_ = 0;

      std::map<std::string, LogCacheStruct> log_cache_;
      std::map<Size, std::string> log_time_cache_;

      bool isInCache_(std::string const & line);

      std::string addToCache_(std::string const & line);

      Size getNextLogCounter_();

      int syncLF_();
    };

    class OPENMS_DLLAPI LogStreamNotifier
    {
public:

      LogStreamNotifier();

      virtual ~LogStreamNotifier();

      virtual void logNotify();

      void registerAt(LogStream & log_stream);

      void unregister();

protected:
      std::stringstream stream_;

      LogStream * registered_at_;
    };


    class OPENMS_DLLAPI LogStream :
      public std::ostream
    {
public:



      LogStream(LogStreamBuf * buf = nullptr, bool delete_buf = true, std::ostream * stream = nullptr);

      ~LogStream() override;



      LogStreamBuf * rdbuf();

      LogStreamBuf * operator->();




      void setLevel(std::string level);


      std::string getLevel();



      void insert(std::ostream & s);

      void remove(std::ostream & s);

      void insertNotification(std::ostream & s,
                              LogStreamNotifier & target);

      void setPrefix(const std::ostream & s, const std::string & prefix);


      void setPrefix(const std::string & prefix);

      void flush();
private:

      typedef std::list<LogStreamBuf::StreamStruct>::iterator StreamIterator;

      StreamIterator findStream_(const std::ostream & stream);
      bool hasStream_(std::ostream & stream);
      bool bound_() const;

      bool delete_buffer_;

    }; //LogStream

  } // namespace Logger

#define OPENMS_LOG_FATAL_ERROR \
  OPENMS_THREAD_CRITICAL(LOGSTREAM) \
  OpenMS_Log_fatal << __FILE__ << "(" << __LINE__ << "): "

#define OPENMS_LOG_ERROR \
  OPENMS_THREAD_CRITICAL(LOGSTREAM) \
  OpenMS_Log_error

#define OPENMS_LOG_WARN \
  OPENMS_THREAD_CRITICAL(LOGSTREAM) \
  OpenMS_Log_warn

#define OPENMS_LOG_INFO \
  OPENMS_THREAD_CRITICAL(LOGSTREAM) \
  OpenMS_Log_info

#define OPENMS_LOG_DEBUG \
  OPENMS_THREAD_CRITICAL(LOGSTREAM) \
  OpenMS_Log_debug << [](){ constexpr const char* x = (past_last_slash(__FILE__)); return x; }() << "(" << __LINE__ << "): "

#define OPENMS_LOG_DEBUG_NOFILE \
  OPENMS_THREAD_CRITICAL(LOGSTREAM) \
  OpenMS_Log_debug

  OPENMS_DLLAPI extern Logger::LogStream OpenMS_Log_fatal; 
  OPENMS_DLLAPI extern Logger::LogStream OpenMS_Log_error; 
  OPENMS_DLLAPI extern Logger::LogStream OpenMS_Log_warn;  
  OPENMS_DLLAPI extern Logger::LogStream OpenMS_Log_info;  
  OPENMS_DLLAPI extern Logger::LogStream OpenMS_Log_debug; 

} // namespace OpenMS