ThreadStream.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_THREAD_STREAM_H_INCLUDED
#define ICL_CORE_LOGGING_THREAD_STREAM_H_INCLUDED

#include <list>
#include <set>

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

#ifdef _IC_BUILDER_DEPRECATED_STYLE_
# include "icl_core/Deprecate.h"
#endif

#if defined ICL_CORE_QT_SUPPORT
class QString;
#endif

#ifdef _IC_BUILDER_EIGEN_
#include <Eigen/Core>
#endif

namespace icl_core {
namespace logging {

class LogStream;

class ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream
{
  friend class LogStream;
public:
  void changeLevel(icl_core::logging::LogLevel level) { m_level = level; }

  icl_core::logging::LogLevel getLogLevel() const { return m_level; }

  void setClassname(const char *classname);

  void setObjectname(const char *objectname);

  void setFilename(const char *filename);

  void setFunction(const char *function);

  void setLine(size_t line);

  void setLineLogLevel(icl_core::logging::LogLevel line_log_level);

  void write(const char *buffer, size_t number_of_bytes, size_t protected_buffer_size=1);

  void printf(const char *fmt, ...);

  void flush();

  typedef ThreadStream& (*ThreadStreamFunc)(ThreadStream&);

  ThreadStream& operator << (ThreadStreamFunc func)
  {
    return (*func)(*this);
  }

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE void ChangeLevel(icl_core::logging::LogLevel level)
    ICL_CORE_GCC_DEPRECATE_STYLE;

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

  ICL_CORE_VC_DEPRECATE_STYLE void SetClassname(const char *classname)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void SetObjectname(const char *objectname)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void SetFilename(const char *filename)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void SetFunction(const char *function)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void SetLine(size_t line)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void SetLineLogLevel(icl_core::logging::LogLevel line_log_level)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void Write(const char *buffer, size_t number_of_bytes,
                                         size_t protected_buffer_size=1)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void Printf(const char *fmt, ...) ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void Flush() ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

private:
  ThreadStream(LogStream *parent);

  ~ThreadStream()
  { }

  LogStream *m_parent;
  icl_core::logging::LogLevel m_level;

  icl_core::logging::LogLevel m_line_log_level;
  char m_filename[cDEFAULT_LOG_SIZE + 1];
  size_t m_line;
  char m_classname[cDEFAULT_LOG_SIZE + 1];
  char m_objectname[cDEFAULT_LOG_SIZE + 1];
  char m_function[cDEFAULT_LOG_SIZE + 1];
  char m_data[cDEFAULT_LOG_SIZE + 1];
  size_t m_write_index;
  //char *m_write_pointer;
};

inline ThreadStream& flush(ThreadStream& stream)
{
  stream.flush();
  return stream;
}

inline ThreadStream& endl(ThreadStream& stream)
{
  stream.write("\n", 1, 0);
  return stream << flush;
}

ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, uint8_t value);
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, uint16_t value);
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, uint32_t value);
#if __WORDSIZE != 64
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, unsigned long value);
#endif
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, uint64_t value);
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, int8_t value);
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, int16_t value);
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, int32_t value);
#if __WORDSIZE != 64
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, long value);
#endif
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, int64_t value);
#ifdef _SYSTEM_DARWIN_
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, size_t value);
#endif
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, const char *text);
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, const std::string& text);
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, double value);
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, bool value);
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, void * value);

#ifndef _SYSTEM_WIN32_
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, const ThreadId& value);
#endif

#if defined ICL_CORE_QT_SUPPORT
ICL_CORE_LOGGING_IMPORT_EXPORT ThreadStream& operator << (ThreadStream& stream, const QString& value);
#endif

#ifdef _IC_BUILDER_EIGEN_
template <typename TScalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
icl_core::logging::ThreadStream&
operator << (icl_core::logging::ThreadStream& stream,
             const Eigen::Matrix<TScalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>& matrix)
{
  stream << "[";
  for (int col = 0; col < matrix.cols(); ++col)
  {
    for (int row = 0; row < matrix.rows(); ++row)
    {
      stream << " " << matrix(row, col);
    }
    if (col < matrix.cols() - 1)
    {
      stream << " ;";
    }
  }
  stream << " ]";
  return stream;
}
#endif

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

inline ThreadStream& Flush(ThreadStream& stream) ICL_CORE_GCC_DEPRECATE_STYLE;
ICL_CORE_VC_DEPRECATE_STYLE inline ThreadStream& Flush(ThreadStream& stream)
{
  stream.flush();
  return stream;
}

inline ThreadStream& Endl(ThreadStream& stream) ICL_CORE_GCC_DEPRECATE_STYLE;
ICL_CORE_VC_DEPRECATE_STYLE inline ThreadStream& Endl(ThreadStream& stream)
{
  stream.write("\n", 1, 0);
  return stream << flush;
}
#endif

}
}

#endif