argos_log.h

Go to the documentation of this file.

 
#ifndef ARGOSLOG_H
#define ARGOSLOG_H
 
#include <argos3/core/config.h>
#include <iomanip>
#include <string>
#include <iostream>
#include <fstream>
#include <cstdio>
#include <cstring>
#include <cstdlib>
 
#ifdef ARGOS_THREADSAFE_LOG
#include <pthread.h>
#include <sstream>
#include <map>
#include <vector>
#endif
 
namespace argos {
   class CARGOSLogger;
}
 
#include <argos3/core/utility/logging/argos_colored_text.h>
 
namespace argos {
 
   /****************************************/
   /****************************************/
 
   extern size_t DEBUG_INDENTATION;
 
#define DEBUG(MSG, ...) { fprintf(stderr, "[DEBUG] "); for(size_t ARGOS_I = 0; ARGOS_I < DEBUG_INDENTATION; ++ARGOS_I) fprintf(stderr, "  "); fprintf(stderr, MSG, ##__VA_ARGS__); }
 
#define DEBUG_FUNCTION_ENTER { ++DEBUG_INDENTATION; DEBUG("%s - START\n", __PRETTY_FUNCTION__ ); }
 
#define DEBUG_FUNCTION_EXIT { DEBUG("%s - END\n", __PRETTY_FUNCTION__ ); --DEBUG_INDENTATION; }
 
#define TRACE(LINE) LINE; DEBUG(#LINE "\n");
 
   /****************************************/
   /****************************************/
 
   class CARGoSLog {
 
   private:
 
      std::ostream& m_cStream;
 
      SLogColor m_sLogColor;
 
      bool m_bColoredOutput;
 
#ifdef ARGOS_THREADSAFE_LOG
      std::map<pthread_t, size_t> m_mapStreamOrder;
 
      std::vector<std::stringstream*> m_vecStreams;
 
      pthread_mutex_t m_tMutex;
#endif
 
   public:
 
      CARGoSLog(std::ostream& c_stream,
                const SLogColor& s_log_color,
                bool b_colored_output_enabled = true) :
         m_cStream(c_stream),
         m_sLogColor(s_log_color),
         m_bColoredOutput(b_colored_output_enabled) {
#ifdef ARGOS_THREADSAFE_LOG
         pthread_mutex_init(&m_tMutex, NULL);
         AddThreadSafeBuffer();
#endif
      }
 
      ~CARGoSLog() {
#ifdef ARGOS_THREADSAFE_LOG
         pthread_mutex_destroy(&m_tMutex);
         while(!m_vecStreams.empty()) {
            delete m_vecStreams.back();
            m_vecStreams.pop_back();
         }
#endif
         if(m_bColoredOutput) {
            reset(m_cStream);
         }
      }
 
      inline void EnableColoredOutput() {
         m_bColoredOutput = true;
      }
 
      inline void DisableColoredOutput() {
         m_bColoredOutput = false;
      }
 
      inline bool IsColoredOutput() const {
         return m_bColoredOutput;
      }
 
      inline std::ostream& GetStream() {
         return m_cStream;
      }
 
      inline void RedirectToFile(const std::string& str_fname) {
         m_cStream.rdbuf(std::ofstream(str_fname.c_str(), std::ios::out | std::ios::trunc).rdbuf());
      }
 
#ifdef ARGOS_THREADSAFE_LOG
      inline void Flush() {
         pthread_mutex_lock(&m_tMutex);
         for(size_t i = 0; i < m_vecStreams.size(); ++i) {
            m_cStream << m_vecStreams[i]->str();
            m_vecStreams[i]->str("");
         }
         pthread_mutex_unlock(&m_tMutex);
      }
 
      inline void AddThreadSafeBuffer() {
         pthread_mutex_lock(&m_tMutex);
         m_mapStreamOrder.insert(std::make_pair<pthread_t, size_t>(pthread_self(), m_vecStreams.size()));
         m_vecStreams.push_back(new std::stringstream);
         pthread_mutex_unlock(&m_tMutex);
      }
#else
      void Flush() {}
#endif
      
      inline CARGoSLog& operator<<(std::ostream& (*c_stream)(std::ostream&)) {
#ifdef ARGOS_THREADSAFE_LOG
         *(m_vecStreams[m_mapStreamOrder.find(pthread_self())->second]) << c_stream;
#else
         m_cStream << c_stream;
#endif
         return *this;
      }
 
      template <typename T> CARGoSLog& operator<<(const T t_msg) {
         if(m_bColoredOutput) {
#ifdef ARGOS_THREADSAFE_LOG
            *(m_vecStreams[m_mapStreamOrder.find(pthread_self())->second]) << m_sLogColor << t_msg << reset;
#else
            m_cStream << m_sLogColor << t_msg << reset;
#endif
         }
         else {
#ifdef ARGOS_THREADSAFE_LOG
            *(m_vecStreams[m_mapStreamOrder.find(pthread_self())->second]) << t_msg;
#else
            m_cStream << m_sLogColor << t_msg << reset;
#endif
         }
         return *this;
      }
 
   };
 
   extern CARGoSLog LOG;
   extern CARGoSLog LOGERR;
 
}
 
   /****************************************/
   /****************************************/
 
#define RLOG    LOG    << "[" << GetId() << "] "
#define RLOGERR LOGERR << "[" << GetId() << "] "
 
   /****************************************/
   /****************************************/
 
#endif