simgear/debug/BufferedLogCallback.cxx

   1 /** \file BufferedLogCallback.cxx
   2  * Buffer certain log messages permanently for later retrieval and display
   3  */
   4
   5 // Copyright (C) 2013  James Turner  zakalawe@mac.com
   6 //
   7 // This library is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU Library General Public
   9 // License as published by the Free Software Foundation; either
  10 // version 2 of the License, or (at your option) any later version.
  11 //
  12 // This library is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // Library General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21
  22 #include <simgear/debug/BufferedLogCallback.hxx>
  23
  24 #include <boost/foreach.hpp>
  25
  26 #include <simgear/sg_inlines.h>
  27 #include <simgear/threads/SGThread.hxx>
  28 #include <simgear/threads/SGGuard.hxx>
  29
  30 namespace simgear
  31 {
  32
  33 class BufferedLogCallback::BufferedLogCallbackPrivate
  34 {
  35 public:
  36     SGMutex m_mutex;
  37     vector_cstring m_buffer;
  38     unsigned int m_stamp;
  39     unsigned int m_maxLength;
  40 };
  41
  42 BufferedLogCallback::BufferedLogCallback(sgDebugClass c, sgDebugPriority p) :
  43         simgear::LogCallback(c,p),
  44     d(new BufferedLogCallbackPrivate)
  45 {
  46     d->m_stamp = 0;
  47     d->m_maxLength = 0xffff;
  48 }
  49
  50 BufferedLogCallback::~BufferedLogCallback()
  51 {
  52     BOOST_FOREACH(unsigned char* msg, d->m_buffer) {
  53         free(msg);
  54     }
  55 }
  56
  57 void BufferedLogCallback::operator()(sgDebugClass c, sgDebugPriority p,
  58         const char* file, int line, const std::string& aMessage)
  59 {
  60     SG_UNUSED(file);
  61     SG_UNUSED(line);
  62
  63     if (!shouldLog(c, p)) return;
  64
  65     vector_cstring::value_type msg;
  66     if (aMessage.size() >= d->m_maxLength) {
  67         msg = (vector_cstring::value_type) malloc(d->m_maxLength);
  68         strncpy((char*) msg, aMessage.c_str(), d->m_maxLength - 1);
  69         msg[d->m_maxLength - 1] = 0; // add final NULL byte
  70     } else {
  71         msg = (vector_cstring::value_type) strdup(aMessage.c_str());
  72     }
  73
  74     SGGuard<SGMutex> g(d->m_mutex);
  75     d->m_buffer.push_back(msg);
  76     d->m_stamp++;
  77 }
  78
  79 unsigned int BufferedLogCallback::stamp() const
  80 {
  81     return d->m_stamp;
  82 }
  83
  84 unsigned int BufferedLogCallback::threadsafeCopy(vector_cstring& aOutput)
  85 {
  86     SGGuard<SGMutex> g(d->m_mutex);
  87     size_t sz = d->m_buffer.size();
  88     aOutput.resize(sz);
  89     memcpy(aOutput.data(), d->m_buffer.data(), sz * sizeof(vector_cstring::value_type));
  90     return d->m_stamp;
  91 }
  92
  93 void BufferedLogCallback::truncateAt(unsigned int t)
  94 {
  95     d->m_maxLength = t;
  96 }
  97
  98 } // of namespace simgear