senf/Utils/Logger/LogFormat.cc

   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 non-inline non-template implementation */
  25
  26 #include "LogFormat.hh"
  27 //#include "LogFormat.ih"
  28
  29 // Custom includes
  30 #include <errno.h>
  31 #include <unistd.h>
  32 #include <locale>
  33 #include <boost/date_time/posix_time/posix_time.hpp>
  34 #include "../../Scheduler/ClockService.hh"
  35 #include "../Console/Console.hh"
  36
  37 //#include "LogFormat.mpp"
  38 #define prefix_
  39 ///////////////////////////////cc.p////////////////////////////////////////
  40
  41 prefix_ senf::log::detail::LogFormat::LogFormat()
  42     : tag_ (detail::getDefaultTag()), noformat_ (false), showTime_ (true),
  43       showStream_ (false), showLevel_ (true), showArea_ (true), timeBase_ (-1)
  44 {
  45     timeFormat("%Y-%m-%d %H:%M:%S.%f-0000");
  46 }
  47
  48 prefix_ senf::log::detail::LogFormat::LogFormat(console::ScopedDirectory<> & dir)
  49     : tag_ (detail::getDefaultTag()), noformat_ (false), showTime_ (true),
  50       showStream_ (false), showLevel_ (true), showArea_ (true), timeBase_ (-1)
  51 {
  52     namespace kw = senf::console::kw;
  53
  54     timeFormat("%Y-%m-%d %H:%M:%S.%f-0000");
  55
  56     dir.add("showTime", senf::membind(&LogFormat::showTime, this))
  57         .arg("flag","whether to display the time in log messages",
  58              kw::default_value = true)
  59         .doc("Set time display in log messages. If time display is enabled, see the 'timeFormat'\n"
  60              "command to set the time format.");
  61     dir.add("showStream", senf::membind(&LogFormat::showStream, this))
  62         .arg("flag","whether to display the stream in log messages",
  63              kw::default_value = true)
  64         .doc("Set strean display in log messages.");
  65     dir.add("showLevel", senf::membind(&LogFormat::showLevel, this))
  66         .arg("flag","whether to display the log level in log messages",
  67              kw::default_value = true)
  68         .doc("Set log level display in log messages.");
  69     dir.add("showArea", senf::membind(&LogFormat::showArea, this))
  70         .arg("flag","whether to display the area in log messages",
  71              kw::default_value = true)
  72         .doc("Set area display in log messages.");
  73     dir.add("timeFormat", senf::membind(&LogFormat::timeFormat, this))
  74         .arg("format","time format")
  75         .doc("Set time format. The time format is specified using a format string. This format\n"
  76              "string follows the strftime format.\n"
  77              "\n"
  78              "As additional option, the format string may be set to the empty string. In this\n"
  79              "case the time will be displayed as 'second.nanosecond' value. IN this case, the\n"
  80              "time is displayed relative to the first message after changing the format.");
  81     dir.add("tag", senf::membind(&LogFormat::tag, this))
  82         .arg("tag","log message tag prefix")
  83         .doc("Every log message is optionally prefixed with a tag value. This value defaults to\n"
  84              "the executable name and pid.");
  85     dir.add("format", senf::membind(&LogFormat::consoleFormat, this))
  86         .doc("Show the current log message format.");
  87 }
  88
  89 prefix_ void senf::log::detail::LogFormat::consoleFormat(std::ostream & os)
  90 {
  91     if (showTime_)                                           os << "showTime ";
  92     if (showStream_)                                         os << "showStream ";
  93     if (showLevel_)                                          os << "showLevel ";
  94     if (showArea_)                                           os << "showArea ";
  95     if (showTime_ || showStream_ || showLevel_ || showArea_) os << "\n";
  96     else                                                     os << "(all flags disabled)\n";
  97
  98     os << "timeFormat \"" << timeFormat_ << "\"\n";
  99     os << "tag \""        << tag_        << "\"\n";
 100 }
 101
 102 prefix_ void senf::log::detail::LogFormat::timeFormat(std::string const & format)
 103 {
 104     timeFormat_ = format;
 105     if (format.empty()) {
 106         noformat_ = true;
 107         timeBase_ = -1;
 108     } else {
 109         noformat_ = false;
 110         std::locale const & loc (datestream_.getloc());
 111         datestream_.imbue( std::locale(
 112                                loc, new boost::posix_time::time_facet(format.c_str())) );
 113     }
 114 }
 115
 116 prefix_ std::string senf::log::detail::LogFormat::prefix(time_type timestamp,
 117                                                          std::string const & stream,
 118                                                          std::string const & area,
 119                                                          unsigned level)
 120 {
 121     datestream_.str("");
 122
 123     if (showTime_) {
 124         if (noformat_) {
 125             if (timeBase_ == -1) timeBase_ = timestamp;
 126             time_type delta (timestamp - timeBase_);
 127             datestream_ << std::setfill('0') << std::setw(10)
 128                         << (delta / 1000000000ll) << '.'
 129                         << std::setfill('0') << std::setw(9)
 130                         << (delta % 1000000000ll);
 131         }
 132         else
 133             datestream_ << senf::ClockService::abstime(timestamp);
 134         datestream_ << ' ';
 135     }
 136     if (!tag_.empty())
 137         datestream_ << tag_ << ": ";
 138     if (showStream_)
 139         datestream_ << '[' << stream << "] ";
 140     if (showLevel_)
 141         datestream_ << '[' << LEVELNAMES[level] << "] ";
 142     if (showArea_ && area != "senf::log::DefaultArea")
 143         datestream_ << '[' << area << "] ";
 144
 145     return datestream_.str();
 146 }
 147
 148 ///////////////////////////////////////////////////////////////////////////
 149
 150 prefix_ void senf::log::detail::quoteNonPrintable(std::string & s)
 151 {
 152     for (std::string::iterator i (s.begin()); i != s.end(); ++i)
 153         if (*i < ' ' && *i != '\n')
 154             *i = '?';
 155 }
 156
 157 prefix_ std::string senf::log::detail::getDefaultTag()
 158 {
 159     std::stringstream ss;
 160     ss << ::program_invocation_short_name << '[' << ::getpid() << ']';
 161     return ss.str();
 162 }
 163
 164 ///////////////////////////////cc.e////////////////////////////////////////
 165 #undef prefix_
 166 //#include "LogFormat.mpp"
 167
 168 \f
 169 // Local Variables:
 170 // mode: c++
 171 // fill-column: 100
 172 // comment-column: 40
 173 // c-file-style: "senf"
 174 // indent-tabs-mode: nil
 175 // ispell-local-dictionary: "american"
 176 // compile-command: "scons -u test"
 177 // End: