senf/Utils/Logger/LogFormat.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2009
   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 LogFormat public header */
  25
  26 #ifndef HH_SENF_Utils_Logger_LogFormat_
  27 #define HH_SENF_Utils_Logger_LogFormat_ 1
  28
  29 // Custom includes
  30 #include <sstream>
  31 #include "TimeSource.hh"
  32 #include <senf/Utils/Console/LazyDirectory.hh>
  33
  34 //#include "LogFormat.mpp"
  35 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  36
  37 namespace senf {
  38 namespace log {
  39 namespace detail {
  40
  41     class LogFormat
  42     {
  43     public:
  44         LogFormat();
  45         explicit LogFormat(console::ScopedDirectory<> & dir);
  46
  47         void showTime(bool flag = true); ///< Enable or disable output of time field
  48         void showStream(bool flag = true); ///< Enable or disable output of stream field
  49         void showLevel(bool flag = true); ///< Enable or disable output of log level
  50         void showArea(bool flag = true); ///< Enable or disable output of log area
  51
  52         void timeFormat(std::string const & format);
  53                                         ///< Set time format
  54                                         /**< The date formatting is set using the Boost.DateTime
  55                                              date_facet, e.g.
  56                                              \code
  57                                                  target.timeFormat("%Y%m%d %H:%M:%S");
  58                                              \endcode
  59                                              If the \c timeFormat is set to the empty string, the
  60                                              time is written out as unformatted ClockService value.
  61
  62                                              By default, the date-time will be written in extended
  63                                              ISO format.
  64                                              \param[in] format Date/Time format string */
  65
  66         void tag(std::string const & tag); ///< Set tag (log line prefix)
  67
  68     protected:
  69         std::string prefix(time_type timestamp, std::string const & stream,
  70                            std::string const & area, unsigned level);
  71         bool isPlainFormat() const;
  72         void consoleFormat(std::ostream & os);
  73
  74     private:
  75
  76         std::string tag_;
  77         std::string timeFormat_;
  78         std::stringstream datestream_;
  79         bool noformat_;
  80         bool showTime_;
  81         bool showStream_;
  82         bool showLevel_;
  83         bool showArea_;
  84         time_type timeBase_;
  85     };
  86
  87     void quoteNonPrintable(std::string & s);
  88     std::string getDefaultTag();
  89
  90 }}}
  91
  92 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  93 #include "LogFormat.cci"
  94 //#include "LogFormat.ct"
  95 //#include "LogFormat.cti"
  96 #endif
  97
  98 \f
  99 // Local Variables:
 100 // mode: c++
 101 // fill-column: 100
 102 // comment-column: 40
 103 // c-file-style: "senf"
 104 // indent-tabs-mode: nil
 105 // ispell-local-dictionary: "american"
 106 // compile-command: "scons -u test"
 107 // End: