senf/Utils/Logger/IOStreamTarget.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 IOStreamTarget public header */
  25
  26 #ifndef HH_SENF_Utils_Logger_IOStreamTarget_
  27 #define HH_SENF_Utils_Logger_IOStreamTarget_ 1
  28
  29 // Custom includes
  30 #include <boost/utility.hpp>
  31 #include <boost/scoped_ptr.hpp>
  32 #include "Target.hh"
  33 #include "LogFormat.hh"
  34
  35 //#include "IOStreamTarget.mpp"
  36 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  37
  38 namespace senf {
  39 namespace log {
  40
  41     /** \brief Write %log messages to arbitrary std::ostream
  42
  43         This target will write %log messages to an arbitrary std::ostream in the format
  44         \verbatim <date> [<level>][<area>] <message> \endverbatim
  45
  46         The \e area will be omitted if it is \c senf::log::DefaultArea.
  47
  48         \warning The class keeps a reference to the passed stream.
  49
  50         \ingroup targets
  51       */
  52     class IOStreamTarget
  53         : public Target, private detail::LogFormat
  54     {
  55     public:
  56         //-////////////////////////////////////////////////////////////////////////
  57         ///\name Structors and default members
  58         //\{
  59
  60         IOStreamTarget(std::string const & name, std::ostream & os);
  61
  62         //\}
  63         //-////////////////////////////////////////////////////////////////////////
  64
  65         using detail::LogFormat::showTime;
  66         using detail::LogFormat::showStream;
  67         using detail::LogFormat::showLevel;
  68         using detail::LogFormat::showArea;
  69         using detail::LogFormat::timeFormat;
  70         using detail::LogFormat::tag;
  71
  72     protected:
  73         void v_write(time_type timestamp, std::string const & stream,
  74                      std::string const & area, unsigned level,
  75                      std::string const & message);
  76
  77     private:
  78         std::ostream & stream_;
  79
  80     };
  81
  82 }}
  83
  84 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  85 #include "IOStreamTarget.cci"
  86 //#include "IOStreamTarget.ct"
  87 //#include "IOStreamTarget.cti"
  88 #endif
  89
  90 \f
  91 // Local Variables:
  92 // mode: c++
  93 // fill-column: 100
  94 // comment-column: 40
  95 // c-file-style: "senf"
  96 // indent-tabs-mode: nil
  97 // ispell-local-dictionary: "american"
  98 // compile-command: "scons -u test"
  99 // End: