LogStream.h

Go to the documentation of this file.

// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#ifndef ICL_CORE_LOGGING_LOG_STREAM_H_INCLUDED
#define ICL_CORE_LOGGING_LOG_STREAM_H_INCLUDED


#include <list>
#include <map>
#include <set>
#include <string>

#include "icl_core/BaseTypes.h"
#include "icl_core/Noncopyable.h"
#include "icl_core/os_thread.h"
#include "icl_core_logging/ImportExport.h"
#include "icl_core_logging/LogLevel.h"
#include "icl_core_logging/Semaphore.h"

namespace icl_core {
namespace logging {

class LogOutputStream;
class LogStream;
class ThreadStream;

typedef std::set<LogStream*> LogStreamSet;

class ICL_CORE_LOGGING_IMPORT_EXPORT LogStream : private icl_core::Noncopyable
{
  friend class LoggingManager;
  friend class ThreadStream;

public:
  LogStream(const icl_core::String& name, icl_core::logging::LogLevel initial_level = cDEFAULT_LOG_LEVEL);

  ~LogStream();

  icl_core::String name() const { return m_name; }
  const char *nameCStr() const { return m_name.c_str(); }

  void setActive(bool active = true) { m_active = active; }

  icl_core::logging::LogLevel initialLogLevel() const { return m_initial_level; }

  bool isActive() const { return m_active; }

  icl_core::logging::LogLevel getLogLevel() const;

  void addOutputStream(LogOutputStream *new_stream);

  void removeOutputStream(LogOutputStream *stream);

  icl_core::logging::ThreadStream& threadStream(icl_core::logging::LogLevel log_level);

  void printConfiguration() const;

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String Name() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE const char *NameCStr() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void SetActive(bool active = true) ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::logging::LogLevel InitialLogLevel() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool IsActive() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE_USE(LogStream::getLogLevel)
  icl_core::logging::LogLevel LogLevel() const ICL_CORE_GCC_DEPRECATE_STYLE_USE(LogStream::getLogLevel);

  ICL_CORE_VC_DEPRECATE_STYLE void AddOutputStream(LogOutputStream *new_stream) ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void RemoveOutputStream(LogOutputStream *stream) ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void PrintConfiguration() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE
    icl_core::logging::ThreadStream& ThreadStream(icl_core::logging::LogLevel log_level)
    ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

private:
  void releaseThreadStream(icl_core::logging::ThreadStream *thread_stream);

  icl_core::logging::LogLevel m_initial_level;

  struct ThreadStreamInfo
  {
    ThreadStreamInfo(ThreadId thread_id,
                     icl_core::logging::LogLevel log_level,
                     icl_core::logging::ThreadStream *thread_stream)
      : thread_id(thread_id),
        log_level(log_level),
        thread_stream(thread_stream)
    { }

    ThreadId thread_id;
    icl_core::logging::LogLevel log_level;
    icl_core::logging::ThreadStream *thread_stream;
  };
  typedef std::list<ThreadStreamInfo> ThreadStreamMap;
  ThreadStreamMap m_thread_stream_map;

  icl_core::String m_name;
  bool m_active;
  std::set<LogOutputStream*> m_output_stream_list;

  // Safe access to the output stream list.
  Semaphore m_mutex;

  static ThreadId m_empty_thread_id;
};

}
}

#endif