Utils/Logger/Log.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   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 Log public header */
  25
  26 #ifndef HH_Log_
  27 #define HH_Log_ 1
  28
  29 // Custom includes
  30 #include <boost/preprocessor/seq/size.hpp>
  31 #include <boost/preprocessor/dec.hpp>
  32 #include <boost/preprocessor/seq/elem.hpp>
  33 #include <boost/preprocessor/seq/pop_back.hpp>
  34 #include "Parameters.hh"
  35
  36 //#include "Log.mpp"
  37 #include "Log.ih"
  38 ///////////////////////////////hh.p////////////////////////////////////////
  39
  40 /** \defgroup logging Logging commands
  41
  42     The logging library provides several commands to create log messages. All these macro commands
  43     take a variable number of arguments. Since this is not supported in a usable way by the C++
  44     preprocessor, the arguments are encoded into a <a
  45     href="http://www.boost.org/libs/preprocessor/doc/index.html">Boost.Preprocessor</a> like
  46     sequence:
  47
  48     \code
  49     SENF_LOG( (senf::log::Debug)(senf::log::NOTICE)(FroblizerArea)("The log message") );
  50     \endcode
  51
  52     For each log message, the following information is needed:
  53     \li The <em>log stream</em>,
  54     \li the <em>log area</em>,
  55     \li the <em>log level</em>,
  56     \li and the log message itself
  57
  58     These parameters may be specified <i>in arbitrary order</i> and even multiple times in the
  59     parameter sequence. If some argument type occurs multiple times, the last occurrence wins. If
  60     any one of the parameters is not specified, it's current default value will be used.
  61
  62     This current default value is set using \ref SENF_LOG_DEFAULT_STREAM, \ref SENF_LOG_DEFAULT_AREA
  63     and \ref SENF_LOG_DEFAULT_LEVEL respectively. These macros set the default stream, area and/or
  64     level of the current scope. The logging library defines the global defaults for these values to
  65     be \c senf::log::Debug (\e stream), senf::log::DefaultArea (\e area), and senf::log::NONE (\e
  66     level).
  67
  68     The log level senf::log::NONE is special. If the log level is set to this value, the log level
  69     will be set from the stream provided default value.
  70
  71     All these parameters must be <em>compile time constants</em> (they are all types, so it's
  72     difficult form them to be something else).
  73  */
  74
  75 ///\ingroup logging
  76 ///\{
  77
  78 ///\name Generating log messages
  79 ///\{
  80
  81 /** \brief Write log message
  82
  83     This macro will write it's last argument to the log stream. The last argument must be an
  84     expression which will be placed after a streaming \c operator<< (like
  85     <i>some-log-stream</i> \c << <i>last-macro-arg</i>).
  86     \code
  87     SENF_LOG((parameters...)("log message " << args << ...));
  88     \endcode
  89
  90     \hideinitializer
  91  */
  92 #define SENF_LOG(args)                                                                            \
  93     SENF_LOG_BLOCK_( SENF_LOG_MERGE_PARAMETERS(BOOST_PP_SEQ_POP_BACK(args)),                      \
  94                      { log << BOOST_PP_SEQ_ELEM(BOOST_PP_DEC(BOOST_PP_SEQ_SIZE(args)),args); })
  95
  96 /** \brief Write log message (template context)
  97
  98     This macro is used like \ref SENF_LOG() if called from a template context
  99
 100     \hideinitializer
 101  */
 102 #define SENF_LOG_TPL(args)                                                                        \
 103     SENF_LOG_BLOCK_( SENF_LOG_MERGE_PARAMETERS_TPL(BOOST_PP_SEQ_POP_BACK(args)),                  \
 104                      { log << BOOST_PP_SEQ_ELEM(BOOST_PP_DEC(BOOST_PP_SEQ_SIZE(args)),args); })
 105
 106 /** \brief Enable block based on logging parameters
 107
 108     This macro is like SENF_LOG, however instead of writing a simple message, this macro allows
 109     to specify a complete block of code to be executed if the log message is enabled.
 110     \code
 111     SENF_LOG_BLOCK((parameters...)({
 112        // arbitrary code using 'log' for logging
 113        log << "log message";
 114     }));
 115     \endcode
 116
 117     \hideinitializer
 118  */
 119 #define SENF_LOG_BLOCK(args)                                                                      \
 120     SENF_LOG_BLOCK_( SENF_LOG_MERGE_PARAMETERS(BOOST_PP_SEQ_POP_BACK(args)),                      \
 121                      BOOST_PP_SEQ_ELEM(BOOST_PP_DEC(BOOST_PP_SEQ_SIZE(args)),args))
 122
 123 /** \brief Write log message (template context)
 124
 125     This macro is used like \ref SENF_LOG_BLOCK() if called from a template context
 126
 127     \hideinitializer
 128  */
 129 #define SENF_LOG_BLOCK_TPL(args)                                                                  \
 130     SENF_LOG_BLOCK_( SENF_LOG_MERGE_PARAMETERS_TPL(BOOST_PP_SEQ_POP_BACK(args)),                  \
 131                      BOOST_PP_SEQ_ELEM(BOOST_PP_DEC(BOOST_PP_SEQ_SIZE(args)),args))
 132
 133 ///\}
 134 ///\}
 135
 136 ///////////////////////////////hh.e////////////////////////////////////////
 137 //#include "Log.cci"
 138 //#include "Log.ct"
 139 //#include "Log.cti"
 140 #endif
 141
 142 \f
 143 // Local Variables:
 144 // mode: c++
 145 // fill-column: 100
 146 // comment-column: 40
 147 // c-file-style: "senf"
 148 // indent-tabs-mode: nil
 149 // ispell-local-dictionary: "american"
 150 // compile-command: "scons -u test"
 151 // End: