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     sgDebugClass m_class;
  38     sgDebugPriority m_priority;
  39     vector_cstring m_buffer;
  40     unsigned int m_stamp;
  41     unsigned int m_maxLength;
  42 };
  43
  44 BufferedLogCallback::BufferedLogCallback(sgDebugClass c, sgDebugPriority p) :
  45     d(new BufferedLogCallbackPrivate)
  46 {
  47     d->m_class = c;
  48     d->m_priority = p;
  49     d->m_stamp = 0;
  50     d->m_maxLength = 0xffff;
  51 }
  52
  53 BufferedLogCallback::~BufferedLogCallback()
  54 {
  55     BOOST_FOREACH(unsigned char* msg, d->m_buffer) {
  56         free(msg);
  57     }
  58 }
  59
  60 void BufferedLogCallback::operator()(sgDebugClass c, sgDebugPriority p,
  61         const char* file, int line, const std::string& aMessage)
  62 {
  63     SG_UNUSED(file);
  64     SG_UNUSED(line);
  65
  66     if ((c & d->m_class) == 0 || p < d->m_priority) return;
  67
  68     vector_cstring::value_type msg;
  69     if (aMessage.size() >= d->m_maxLength) {
  70         msg = (vector_cstring::value_type) malloc(d->m_maxLength);
  71         strncpy((char*) msg, aMessage.c_str(), d->m_maxLength - 1);
  72         msg[d->m_maxLength - 1] = 0; // add final NULL byte
  73     } else {
  74         msg = (vector_cstring::value_type) strdup(aMessage.c_str());
  75     }
  76
  77     SGGuard<SGMutex> g(d->m_mutex);
  78     d->m_buffer.push_back(msg);
  79     d->m_stamp++;
  80 }
  81
  82 unsigned int BufferedLogCallback::stamp() const
  83 {
  84     return d->m_stamp;
  85 }
  86
  87 unsigned int BufferedLogCallback::threadsafeCopy(vector_cstring& aOutput)
  88 {
  89     SGGuard<SGMutex> g(d->m_mutex);
  90     size_t sz = d->m_buffer.size();
  91     aOutput.resize(sz);
  92     memcpy(aOutput.data(), d->m_buffer.data(), sz * sizeof(vector_cstring::value_type));
  93     return d->m_stamp;
  94 }
  95
  96 void BufferedLogCallback::truncateAt(unsigned int t)
  97 {
  98     d->m_maxLength = t;
  99 }
 100
 101 } // of namespace simgear