ThreadStream.cpp

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 ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#include "icl_core_logging/ThreadStream.h"

#include <icl_core/internal_raw_debug.h>
#include <icl_core/os_lxrt.h>
#include "icl_core_logging/logging_ns.h"
#include "icl_core_logging/LogStream.h"
#include "icl_core_logging/LogOutputStream.h"

#include <stdarg.h>
#include <string.h>

#if defined _SYSTEM_POSIX_
# include "icl_core_logging/stream_operators_impl_posix.h"
#elif defined _SYSTEM_WIN32_
// No special implementation here because ThreadId is an unsigned long
// on Win32 platforms.
#else
# error "No ::icl_core::logging namespace implementation defined for this platform."
#endif

#if defined ICL_CORE_QT_SUPPORT
#include <QtCore/QString>
#endif

namespace icl_core {
namespace logging {

void ThreadStream::setClassname(const char *classname)
{
  strncpy(m_classname, classname, cDEFAULT_LOG_SIZE);
}

void ThreadStream::setFilename(const char *filename)
{
  strncpy(m_filename, filename, cDEFAULT_LOG_SIZE);
}

void ThreadStream::setObjectname(const char *objectname)
{
  strncpy(m_objectname, objectname, cDEFAULT_LOG_SIZE);
}

void ThreadStream::setFunction(const char *function)
{
  strncpy(m_function, function, cDEFAULT_LOG_SIZE);
}

void ThreadStream::setLine(size_t line)
{
  m_line = line;
}

void ThreadStream::setLineLogLevel(icl_core::logging::LogLevel line_log_level)
{
  m_line_log_level = line_log_level;
}

void ThreadStream::write(const char *source, size_t number_of_bytes, size_t protected_buffer_size)
{
  // Protect the last byte in the thread stream's buffer!
  size_t writable_length = cDEFAULT_LOG_SIZE - m_write_index - 1;
  if (number_of_bytes + protected_buffer_size > writable_length)
  {
    if (writable_length > protected_buffer_size)
    {
      number_of_bytes = writable_length - protected_buffer_size;
    }
    else
    {
      number_of_bytes = 0;
    }
  }
  memcpy(&m_data[m_write_index], source, number_of_bytes);

  m_write_index += number_of_bytes;
}

void ThreadStream::printf(const char *fmt, ...)
{
  // Protect the last byte in the thread stream's buffer!
  size_t writable_length = cDEFAULT_LOG_SIZE - m_write_index - 1;

  va_list argptr;
  va_start(argptr, fmt);
  int32_t bytes_printed = vsnprintf(&m_data[m_write_index], writable_length, fmt, argptr);
  va_end(argptr);

  if (bytes_printed >= 0)
  {
    if (size_t(bytes_printed) > writable_length)
    {
      m_write_index += writable_length;
    }
    else
    {
      m_write_index += bytes_printed;
    }
  }

  flush();
}

void ThreadStream::flush()
{
  m_data[m_write_index] = '\0';
  if (m_parent->m_mutex.wait())
  {
    for (std::set<LogOutputStream*>::const_iterator iter = m_parent->m_output_stream_list.begin();
         iter != m_parent->m_output_stream_list.end();
         ++iter)
    {
      (*iter)->push(m_line_log_level, m_parent->nameCStr(), m_filename, m_line,
                    m_classname, m_objectname, m_function, m_data);
    }

    m_parent->releaseThreadStream(this);

    m_parent->m_mutex.post();
  }
  else
  {
    PRINTF("ThreadStream(%s)::Flush: mutex lock failed\n", m_parent->nameCStr());
  }
  m_write_index = 0;
}

ThreadStream::ThreadStream(LogStream *parent)
  : m_parent(parent),
    m_level(parent->m_initial_level),
    m_line_log_level(parent->m_initial_level),
    m_line(0),
    m_write_index(0)
{
  memset(m_classname, 0, cDEFAULT_LOG_SIZE + 1);
  memset(m_function, 0, cDEFAULT_LOG_SIZE + 1);
  memset(m_data, 0, cDEFAULT_LOG_SIZE + 1);
}


ThreadStream& operator << (ThreadStream& stream, uint8_t value)
{
  char local_buffer[8];
  size_t length = os::snprintf(local_buffer, 8, "%hu", static_cast<uint8_t>(value));
  stream.write(local_buffer, length);
  return stream;
}

ThreadStream& operator << (ThreadStream& stream, uint16_t value)
{
  char local_buffer[8];
  size_t length = os::snprintf(local_buffer, 8, "%hu", value);
  stream.write(local_buffer, length);
  return stream;
}

ThreadStream& operator << (ThreadStream& stream, uint32_t value)
{
  char local_buffer[13];
  size_t length = os::snprintf(local_buffer, 13, "%u", value);
  stream.write(local_buffer, length);
  return stream;
}

#if __WORDSIZE != 64
ThreadStream& operator << (ThreadStream& stream, unsigned long value)
{
  char local_buffer[13];
  size_t length = os::snprintf(local_buffer, 13, "%lu", value);
  stream.write(local_buffer, length);
  return stream;
}
#endif

ThreadStream& operator << (ThreadStream& stream, uint64_t value)
{
  char local_buffer[23];
  size_t length = os::snprintf(local_buffer, 23, "%llu", value);
  stream.write(local_buffer, length);
  return stream;
}

ThreadStream& operator << (ThreadStream& stream, int8_t value)
{
  char local_buffer[8];
  size_t length = os::snprintf(local_buffer, 8, "%hd", static_cast<int16_t>(value));
  stream.write(local_buffer, length);
  return stream;
}

ThreadStream& operator << (ThreadStream& stream, int16_t value)
{
  char local_buffer[8];
  size_t length = os::snprintf(local_buffer, 8, "%hd", value);
  stream.write(local_buffer, length);
  return stream;
}

ThreadStream& operator << (ThreadStream& stream, int32_t value)
{
  char local_buffer[13];
  size_t length = os::snprintf(local_buffer, 13, "%d", value);
  stream.write(local_buffer, length);
  return stream;
}

#if __WORDSIZE != 64
ThreadStream& operator << (ThreadStream& stream, long value)
{
  char local_buffer[13];
  size_t length = os::snprintf(local_buffer, 13, "%ld", value);
  stream.write(local_buffer, length);
  return stream;
}
#endif

ThreadStream& operator << (ThreadStream& stream, int64_t value)
{
  char local_buffer[23];
  size_t length = os::snprintf(local_buffer, 23, "%lld", value);
  stream.write(local_buffer, length);
  return stream;
}

#ifdef _SYSTEM_DARWIN_
ThreadStream& operator << (ThreadStream& stream, size_t value)
{
  char local_buffer[23];
  size_t length = os::snprintf(local_buffer, 23, "%zu", value);
  stream.write(local_buffer, length);
  return stream;
}
#endif

ThreadStream& operator << (ThreadStream& stream, const char *text)
{
  stream.write(text, strlen(text));
  return stream;
}

ThreadStream& operator << (ThreadStream& stream, const std::string& text)
{
  stream.write(text.c_str(), text.size());
  return stream;
}

ThreadStream& operator << (ThreadStream& stream, double value)
{
  char local_buffer[100];
  size_t length = os::snprintf(local_buffer, 100, "%f", value);
  stream.write(local_buffer, length);
  return stream;
}

ThreadStream& operator << (ThreadStream& stream, bool value)
{
  if (value)
  {
    stream.write("True", 4);
  }
  else
  {
    stream.write("False", 5);
  }
  return stream;
}

ThreadStream& operator << (ThreadStream& stream, void * value)
{
  char local_buffer[25];
  size_t length = os::snprintf(local_buffer, 25, "%p", value);
  stream.write(local_buffer, length);
  return stream;
}

#ifndef _SYSTEM_WIN32_
ThreadStream& operator << (ThreadStream& stream, const ThreadId& thread_id)
{
  return ICL_CORE_LOGGING_IMPL_NS::operator << (stream, thread_id);
}
#endif

#if defined ICL_CORE_QT_SUPPORT
ThreadStream& operator << (ThreadStream& stream, const QString& value)
{
  return operator << (stream, value.toLatin1().constData());
}
#endif


#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  void ThreadStream::ChangeLevel(icl_core::logging::LogLevel level)
  {
    changeLevel(level);
  }

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

  void ThreadStream::SetClassname(const char *classname)
  {
    setClassname(classname);
  }

  void ThreadStream::SetObjectname(const char *objectname)
  {
    setObjectname(objectname);
  }

  void ThreadStream::SetFilename(const char *filename)
  {
    setFilename(filename);
  }

  void ThreadStream::SetFunction(const char *function)
  {
    setFunction(function);
  }

  void ThreadStream::SetLine(size_t line)
  {
    setLine(line);
  }

  void ThreadStream::SetLineLogLevel(icl_core::logging::LogLevel line_log_level)
  {
    setLineLogLevel(line_log_level);
  }

  void ThreadStream::Write(const char *buffer, size_t number_of_bytes,
                           size_t protected_buffer_size)
  {
    write(buffer, number_of_bytes, protected_buffer_size);
  }

  void ThreadStream::Printf(const char *fmt, ...)
  {
    // Protect the last byte in the thread stream's buffer!
    size_t writable_length = cDEFAULT_LOG_SIZE - m_write_index - 1;

    va_list argptr;
    va_start(argptr, fmt);
    int32_t bytes_printed = vsnprintf(&m_data[m_write_index], writable_length, fmt, argptr);
    va_end(argptr);

    if (bytes_printed >= 0)
    {
      if (size_t(bytes_printed) > writable_length)
      {
        m_write_index += writable_length;
      }
      else
      {
        m_write_index += bytes_printed;
      }
    }

    flush();
  }

  void ThreadStream::Flush()
  {
    flush();
  }

#endif

}
}