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
  34 //#include "IOStreamTarget.mpp"
  35 ///////////////////////////////hh.p////////////////////////////////////////
  36
  37 namespace senf {
  38 namespace log {
  39
  40     /** \brief Write %log messages to arbitrary std::ostream
  41
  42         This target will write %log messages to an arbitrary std::ostream in the format
  43         \verbatim <date> [<level>][<area>] <message> \endverbatim
  44
  45         The \e area will be omitted if it is \c senf::log::DefaultArea.
  46
  47         \warning The class keeps a reference to the passed stream.
  48
  49         \ingroup targets
  50       */
  51     class IOStreamTarget
  52         : public Target
  53     {
  54     public:
  55         ///////////////////////////////////////////////////////////////////////////
  56         ///\name Structors and default members
  57         ///@{
  58
  59         explicit IOStreamTarget(std::ostream & os);
  60
  61         ///@}
  62         ///////////////////////////////////////////////////////////////////////////
  63
  64         void showTime(bool flag = true); ///< Enable or disable output of time field
  65         void showStream(bool flag = true); ///< Enable or disable output of stream field
  66         void showLevel(bool flag = true); ///< Enable or disable output of log level
  67         void showArea(bool flag = true); ///< Enable or disable output of log area
  68
  69         void timeFormat(std::string const & format);
  70                                         ///< Set time format
  71                                         /**< The date formatting is set using the Boost.DateTime
  72                                              date_facet, e.g.
  73                                              \code
  74                                                  target.timeFormat("%Y%m%d %H:%M:%S");
  75                                              \endcode
  76                                              If the \c timeFormat is set to the empty string, the
  77                                              time is written out as unformatted ClockService value.
  78
  79                                              By default, the date-time will be written in extended
  80                                              ISO format.
  81                                              \param[in] format Date/Time format string */
  82
  83         void tag(std::string const & tag);
  84
  85     protected:
  86         void v_write(time_type timestamp, std::string const & stream,
  87                      std::string const & area, unsigned level,
  88                      std::string const & message);
  89
  90     private:
  91         std::ostream & stream_;
  92
  93         std::string tag_;
  94         std::stringstream datestream_;
  95         bool noformat_;
  96         bool showTime_;
  97         bool showStream_;
  98         bool showLevel_;
  99         bool showArea_;
 100
 101         time_type timeBase_;
 102     };
 103
 104 }}
 105
 106 ///////////////////////////////hh.e////////////////////////////////////////
 107 #include "IOStreamTarget.cci"
 108 //#include "IOStreamTarget.ct"
 109 //#include "IOStreamTarget.cti"
 110 #endif
 111
 112 \f
 113 // Local Variables:
 114 // mode: c++
 115 // fill-column: 100
 116 // comment-column: 40
 117 // c-file-style: "senf"
 118 // indent-tabs-mode: nil
 119 // ispell-local-dictionary: "american"
 120 // compile-command: "scons -u test"
 121 // End: