senf/Utils/Logger/StringTarget.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief StringTarget public header */
  25
  26 #ifndef HH_SENF_Utils_Logger_StringTarget_
  27 #define HH_SENF_Utils_Logger_StringTarget_ 1
  28
  29 // Custom includes
  30 #include <sstream>
  31 #include "IOStreamTarget.hh"
  32
  33 //#include "StringTarget.mpp"
  34 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  35
  36 namespace senf {
  37 namespace log {
  38
  39     /** \brief Store %log messages in a string buffer
  40
  41         This target is mostly useful for debug purposes.
  42
  43         \ingroup targets
  44       */
  45     class StringTarget
  46         : private boost::base_from_member<std::stringstream>,
  47           public IOStreamTarget
  48     {
  49         typedef boost::base_from_member<std::stringstream> stream_base;
  50     public:
  51         //-////////////////////////////////////////////////////////////////////////
  52         // Types
  53
  54         //-////////////////////////////////////////////////////////////////////////
  55         ///\name Structors and default members
  56         //\{
  57
  58         StringTarget();
  59
  60         //\}
  61         //-////////////////////////////////////////////////////////////////////////
  62
  63         std::string str() const;        ///< Get log messages accumulated so far
  64         void clear();                   ///< Clear buffer
  65
  66     protected:
  67
  68     private:
  69
  70     };
  71
  72 }}
  73
  74 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  75 //#include "StringTarget.cci"
  76 //#include "StringTarget.ct"
  77 #include "StringTarget.cti"
  78 #endif
  79
  80 \f
  81 // Local Variables:
  82 // mode: c++
  83 // fill-column: 100
  84 // comment-column: 40
  85 // c-file-style: "senf"
  86 // indent-tabs-mode: nil
  87 // ispell-local-dictionary: "american"
  88 // compile-command: "scons -u test"
  89 // End: