/usr/include/mia-2.2/mia/core/msgstream.hh is in libmia-2.2-dev 2.2.7-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 | /* -*- mia-c++ -*-
*
* This file is part of MIA - a toolbox for medical image analysis
* Copyright (c) Leipzig, Madrid 1999-2015 Gert Wollny
*
* MIA is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with MIA; if not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef CVERB_HH
#define CVERB_HH 1
//#pragma interface
#include <vector>
#include <cassert>
#include <ostream>
#include <boost/call_traits.hpp>
#include <boost/ref.hpp>
#include <miaconfig.h>
#include <mia/core/defines.hh>
#include <mia/core/dictmap.hh>
#include <mia/core/svector.hh>
NS_MIA_BEGIN
#ifndef VSTREAM_DOMAIN
#define VSTREAM_DOMAIN "**"
#endif
/**
\ingroup logging
\brief A output stream to enable certain levels of verbosity
This class impelemtns a std::ostream like class to output messages during run-time,
supporting various levels of verbosity. The class is implemened as a singleton.
On initialization it is set to use std::cerr as output stream, but this can be replaced
by any type implementing the std::ostream interface.
\remark if -DNDEBUG is set, the levels \a debug and \a trace are not compiled in - i.e.
the corresponding output operators are replaced by dummy functions that should be
optimized away.
*/
class EXPORT_CORE vstream {
public:
/**
Output verbosity level threshhold, ml_trace is the lowest threshhold and
ml_fatal the highest. Output is written, when the output threshold is above or equal
to the one set within the output stream.
*/
enum Level {
ml_trace, /**< write trace of function calls and higher, disabled with -DNDEBUG */
ml_debug, /**< write debugging information and higher, disabled with -DNDEBUG */
ml_info, /**< write additional info about the data processed and higher */
ml_message,/**< write process status messages and higher*/
ml_warning,/**< write warnings and higher*/
ml_fail, /**< write failture messages (for tests) and higher */
ml_error, /**< write non-fatal error messages and higher */
ml_fatal, /**< write only fatal error messages */
ml_undefined /**< stopper */
};
/** initialise a stream that writes only messages above a certain
verbosity level
*/
static vstream& instance();
/** set the verbosity output level
\param l
*/
void set_verbosity(Level l);
/// \returns the curent verbosity level
vstream::Level get_level() const;
/**
sets the output stream
\param os
\returns the old output stream
*/
std::ostream& set_stream(std::ostream& os);
/// write pending output
void flush();
/** \param l verbosity level
\returns true if cverb will show the given verbosity level
*/
bool shows(Level l)const;
/// \returns true if the output level is equal or below "debug"
bool show_debug() const;
/** a special handling to set the output level "inline"
\param l the level of the following messages
*/
vstream& operator << (Level const l);
/** general output routine; output is only given, if the data verbosity level is
set higher or equal to the stream verbosity level.
\param text the text to be written to the stream
\returns a reference to this object
*/
template <class T>
vstream& operator << (const T& text) {
if (m_message_level >= m_output_level)
*m_output << text;
return *this;
}
/** A funny construct to enable std::endl to work on this stream
idea of Dave Brondsema:
http://gcc.gnu.org/bugzilla/show_bug.cgi?id=8567
*/
vstream & operator<<(std::ostream& (*f)(std::ostream&));
/**
Set the output target with which the stream should be initialized
if std::cerr is not to be used.
*/
static void set_output_target(std::ostream* os);
/**
Transparent conversion operator to an std::ostream.
*/
operator std::ostream& () {
return *m_output;
}
private:
vstream(std::ostream& output, Level l);
static std::ostream* m_output_target;
static __thread std::ostream* m_output;
Level m_output_level;
static __thread Level m_message_level;
};
/**
\ingroup logging
\brief Dictonary for the verbosity of the logging as used by --verbose comand line option
*/
extern EXPORT_CORE const TDictMap<vstream::Level> g_verbose_dict;
/**
\ingroup logging
* @param verbose: verbose state
*
* Set the cverb ostream in a verbose/non verbose mode depending on the
* verbose parameter. Currently set_verbose() can be called only one time. If
* this function is never called the default state of cverb is non-verbose mode
*/
void set_verbose(bool verbose);
inline bool vstream::shows(Level l)const
{
return l >= m_output_level;
}
class EXPORT_CORE CTrace {
public:
CTrace(const char *domain):
m_domain(domain),
m_fill(m_depth, ' ') {
vstream::instance() << vstream::ml_trace
<< m_fill << "enter " << m_domain << "\n";
++m_depth;
};
~CTrace() {
vstream::instance() << vstream::ml_trace
<< m_fill << "leave " << m_domain << "\n";
--m_depth;
}
private:
const char *m_domain;
std::string m_fill;
// should be thread local, or at least protected by a mutex
static __thread size_t m_depth;
};
#ifndef ENABLE_DEBUG_MESSAGES
#define TRACE(DOMAIN)
#define TRACE_FUNCTION
#define FUNCTION_NOT_TESTED
class CDebugSink {
public:
template <class T>
CDebugSink& operator << (const T& MIA_PARAM_UNUSED(val)) {
return *this;
}
CDebugSink & operator<<(std::ostream& (* /*f*/)(std::ostream&)) {
return *this;
}
};
inline CDebugSink& cvdebug()
{
static CDebugSink sink;
vstream::instance() << vstream::ml_debug;
return sink;
}
#else
/**
\ingroup logging
\brief Short for debug output in non-debug build output send to this will be ignored.
*/
inline vstream& cvdebug()
{
vstream::instance() << vstream::ml_debug << VSTREAM_DOMAIN << ":";
return vstream::instance();
}
/// a macro to trace scopes in a debug built
#define TRACE(DOMAIN) ::mia::CTrace _xxx_trace(DOMAIN)
/// a macro to trace functions ina a debug build
#define TRACE_FUNCTION ::mia::CTrace _xxx_trace(__PRETTY_FUNCTION__)
/// a macro to indicate that there are no tests for a function
#define FUNCTION_NOT_TESTED ::mia::cvwarn() << __PRETTY_FUNCTION__ << ":not tested\n"
#endif
/**
\ingroup logging
\brief \a informal output that may be of interest to understand problems with a program
and are of higher priority then debugging output.
*/
inline vstream& cvinfo()
{
vstream::instance() << vstream::ml_info << VSTREAM_DOMAIN << ":";
return vstream::instance();
}
inline bool vstream::show_debug() const
{
return shows(ml_debug);
}
/// \returns the curent verbosity level
inline vstream::Level vstream::get_level() const
{
return m_output_level;
}
inline void vstream::flush()
{
m_output->flush();
}
// some inlines
/**
\ingroup logging
\brief direct output to this stream adapter to print out \a fatalities in the code
*/
inline vstream& cvfatal()
{
vstream::instance() << vstream::ml_fatal << VSTREAM_DOMAIN << ":";
return vstream::instance();
}
/**
\ingroup logging
\brief direct output to this stream adapter to print out \a failtures in tests beyond BOOST_FAIL
*/
inline vstream& cvfail()
{
vstream::instance() << vstream::ml_fail << VSTREAM_DOMAIN << ":";
return vstream::instance();
}
/**
\ingroup logging
\brief send errors to this stream adapter
*/
inline vstream& cverr()
{
vstream::instance() << vstream::ml_error << VSTREAM_DOMAIN << ":";
return vstream::instance();
}
/**
\ingroup logging
\brief send \a warnings to this stream adapter
*/
inline vstream& cvwarn()
{
vstream::instance() << vstream::ml_warning << VSTREAM_DOMAIN << ":";
return vstream::instance();
}
/**
\ingroup logging
\brief send \a messages to this stream adapter
*/
inline vstream& cvmsg()
{
vstream::instance() << vstream::ml_message << VSTREAM_DOMAIN << ":";
return vstream::instance();
}
/**
\ingroup logging
\brief define a shortcut to the raw output stream
*/
#define cverb ::mia::vstream::instance()
/**
\ingroup logging
\brief implements the direct streaming of std::vectors.
*/
template <typename T>
vstream& operator << (vstream& os, const std::vector<T>& v) {
os << "[";
for (auto i =v.begin(); i != v.end(); ++i)
os << *i << ", ";
os << "]";
return os;
}
NS_MIA_END
#endif /* !CVERB_HH */
|