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