senf/Utils/Logger/StringTarget.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief StringTarget public header */
  30
  31 #ifndef HH_SENF_Utils_Logger_StringTarget_
  32 #define HH_SENF_Utils_Logger_StringTarget_ 1
  33
  34 // Custom includes
  35 #include <sstream>
  36 #include "IOStreamTarget.hh"
  37
  38 //#include "StringTarget.mpp"
  39 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  40
  41 namespace senf {
  42 namespace log {
  43
  44     /** \brief Store %log messages in a string buffer
  45
  46         This target is mostly useful for debug purposes.
  47
  48         \ingroup targets
  49       */
  50     class StringTarget
  51         : private boost::base_from_member<std::stringstream>,
  52           public IOStreamTarget
  53     {
  54         typedef boost::base_from_member<std::stringstream> stream_base;
  55     public:
  56         //-////////////////////////////////////////////////////////////////////////
  57         // Types
  58
  59         //-////////////////////////////////////////////////////////////////////////
  60         ///\name Structors and default members
  61         //\{
  62
  63         StringTarget();
  64
  65         //\}
  66         //-////////////////////////////////////////////////////////////////////////
  67
  68         std::string str() const;        ///< Get log messages accumulated so far
  69         void clear();                   ///< Clear buffer
  70
  71     protected:
  72
  73     private:
  74
  75     };
  76
  77 }}
  78
  79 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  80 //#include "StringTarget.cci"
  81 //#include "StringTarget.ct"
  82 #include "StringTarget.cti"
  83 #endif
  84
  85 \f
  86 // Local Variables:
  87 // mode: c++
  88 // fill-column: 100
  89 // comment-column: 40
  90 // c-file-style: "senf"
  91 // indent-tabs-mode: nil
  92 // ispell-local-dictionary: "american"
  93 // compile-command: "scons -u test"
  94 // End: