4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
6 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
24 \brief Config public header */
32 //#include "Config.mpp"
34 ///////////////////////////////hh.p////////////////////////////////////////
36 /** \defgroup config Configuration
38 The logger infrastructure provides for very fine-grained configuration of log messages. There
39 are two parts to this configuration: compile-time configuration and runtime configuration.
41 <em>Compile-time</em> configuration selects, which log statements will even be compiled. If
42 logging for a certain combination of stream, area and level is disabled at compile time, no code
43 will be generated for any such disabled log statement. This type of configuration is done using
46 <em>Runtime</em> configuration on the other hand deals with routing all those messages, which
47 are enabled at compile time to the logging targets. If a message is not routed, it will be
48 discarded. This allows to additionally disable messages at run-time.
50 \fixme Restructure compile-time configuration: Only allow stream based configuration using
51 SENF_LOG_CONF. For more complex configuration, accept a macro SENF_LOG_CONFFILE which, if
52 defined, must define the path of a file to be included. Area specific configuration must be
53 done in this include file. The area must be complete (not only a predeclaration) at that
65 /** \brief Compile time configuration
67 This define symbol sets the compile time logger configuration. This symbol should normally
68 be set on the compiler command line:
70 g++ ... -DSENF_LOG_CONF="(( (senf)(log)(Debug),(_),DISABLED ))
71 (( (senf)(log)(Debug),(foo)(SomeClass),(VERBOSE) ))
72 (( (foo)(Transactions),(_),NOTICE ))" ...
74 (As this option can get quite long, you might want to use the '-imacros' option instead)
76 The formal syntax of this option is:
80 <tr><td>conf</td> <td>::= \e element \e element* \n</td></tr>
81 <tr><td>element</td> <td>::= <tt>((</tt> \e stream <tt>,</tt> \e optional_area <tt>,</tt> \e level <tt>))</tt> \n</td></tr>
82 <tr><td>stream</td> <td>::= \e scope_seq \n</td></tr>
83 <tr><td>optional_area</td><td>::= <tt>(_)</tt> | \e scope_seq \n</td></tr>
84 <tr><td>level</td> <td>::= \c VERBOSE | \c NOTICE | \c MESSAGE | \c IMPORTANT | \c CRITICAL | \c DISABLED \n</td></tr>
85 <tr><td>scope_seq</td> <td>::= \e scope \e scope \e scope* \n</td></tr>
86 <tr><td>scope</td> <td>::= <tt>(</tt> \e name <tt>)</tt> \n</td></tr>
87 <tr><td>name</td> <td>::= arbitrary C++ identifier</td></tr>
90 \ref SENF_LOG_CONF is a Boost.Preprocessor style sequence of 3-tuples. Each tuple applies to
91 a specific stream which is defined by the first tuple element \e stream.
93 The next tuple element, \e optional_area optionally restricts the entry to match only the
96 The last tuple element \e level defines the compile time log level. Messages with a level
97 below this are discarded at compile time.
99 Both \e stream and \e optional_area are given as a \e scope_seq. A scope sequence is a fully
100 qualified C++ identifier placed into a sequence: <tt>foo::bar::baz</tt> is represented by
101 <tt>(foo)(bar)(baz)</tt>.
103 # define SENF_LOG_CONF
107 /** \brief Check, if logging is enabled for stream/area/level tuple
109 This is a template meta-function which will check, whether logging to the given combination
110 of parameters \a Stream, \a Area and \a Level is compile-time enabled. The logging might
111 still be disabled at runtime.
113 if (senf::log::Enabled<senf::log::Debug,
114 senf::log::DefaultArea,
115 senf::log::VERBOSE>::value) {
120 Since the \e value member is a compile time constant, the compiler will completely optimize
121 away this block of code when logging is disabled.
123 template <class Stream, class Area, class Level>
126 static const bool value = (
127 (Level::value == NONE::value ? Stream::defaultLevel::value : Level::value)
128 >= detail::Config<Stream,Area>::compileLimit::value );
135 ///////////////////////////////hh.e////////////////////////////////////////
136 //#include "Config.cci"
137 //#include "Config.ct"
138 //#include "Config.cti"
145 // comment-column: 40
146 // c-file-style: "senf"
147 // indent-tabs-mode: nil
148 // ispell-local-dictionary: "american"
149 // compile-command: "scons -u test"