/usr/include/ql/utilities/tracing.hpp is in libquantlib0-dev 1.4-2+b1.
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 | /* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2005 StatPro Italia srl
This file is part of QuantLib, a free-software/open-source library
for financial quantitative analysts and developers - http://quantlib.org/
QuantLib is free software: you can redistribute it and/or modify it
under the terms of the QuantLib license. You should have received a
copy of the license along with this program; if not, please email
<quantlib-dev@lists.sf.net>. The license is also available online at
<http://quantlib.org/license.shtml>.
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 license for more details.
*/
/*! \file tracing.hpp
\brief tracing facilities
*/
#ifndef quantlib_tracing_hpp
#define quantlib_tracing_hpp
#include <ql/types.hpp>
#include <ql/errors.hpp>
#include <ql/patterns/singleton.hpp>
#include <boost/current_function.hpp>
#include <iosfwd>
namespace QuantLib {
/*! \example tracing_example.cpp
This code exemplifies how to insert trace statements to follow
the flow of program execution. When compiler under gcc 3.3 and
run, the following program will output the following trace:
\code
trace[1]: Entering int main()
trace[2]: Entering int foo(int)
trace[3]: Entering int Foo::bar(int)
trace[3]: i = 21
trace[3]: At line 16 in tracing_example.cpp
trace[3]: Wrong answer
trace[3]: i = 42
trace[3]: Exiting int Foo::bar(int)
trace[3]: Entering int Foo::bar(int)
trace[3]: i = 42
trace[3]: At line 13 in tracing_example.cpp
trace[3]: Right answer, but no question
trace[3]: i = 42
trace[3]: Exiting int Foo::bar(int)
trace[2]: Exiting int foo(int)
trace[1]: Exiting int main()
\endcode
Of course, a word of warning must be added: adding so much
tracing to your code might degrade its readability, at least
until we devise an Emacs macro to hide trace statements with a
couple of keystrokes.
*/
namespace detail {
class Tracing : public Singleton<Tracing> {
friend class QuantLib::Singleton<Tracing>;
private:
Tracing();
public:
void enable() {
#if defined(QL_ENABLE_TRACING)
enabled_ = true;
#else
QL_FAIL("tracing support not available");
#endif
}
void disable() { enabled_ = false; }
void setStream(std::ostream& stream) { out_ = &stream; }
bool enabled() const { return enabled_; }
std::ostream& stream() { return *out_; }
Integer depth() const { return depth_; }
void down() { depth_++; }
void up() { depth_--; }
private:
std::ostream* out_;
bool enabled_;
Integer depth_;
};
}
}
/*! \addtogroup macros
@{
*/
/*! \defgroup debugMacros Debugging macros
For debugging purposes, macros can be used to output information
about the code being executed.
@{
*/
/*! \def QL_TRACE_ENABLE
\brief enable tracing
The statement
\code
QL_TRACE_ENABLE;
\endcode
can be used to enable tracing. Such statement might be
ignored; refer to QL_TRACE for details.
*/
/*! \def QL_TRACE_DISABLE
\brief disable tracing
The statement
\code
QL_TRACE_DISABLE;
\endcode
can be used to disable tracing. Such statement might be
ignored; refer to QL_TRACE for details.
*/
/*! \def QL_TRACE_ON
\brief set tracing stream
The statement
\code
QL_TRACE_ON(stream);
\endcode
can be used to set the stream where tracing messages are
output. Such statement might be ignored; refer to QL_TRACE for
details.
*/
/*! \def QL_TRACE
\brief output tracing information
The statement
\code
QL_TRACE(message);
\endcode
can be used to output a trace of the code being executed. If
tracing was disabled during configuration, such statements are
removed by the preprocessor for maximum performance; if it was
enabled, whether and where the message is output depends on the
current settings.
*/
/*! \def QL_TRACE_ENTER_FUNCTION
\brief output tracing information
The statement
\code
QL_TRACE_ENTER_FUNCTION;
\endcode
can be used at the beginning of a function to trace the fact that
the program execution is entering such function. It should be
paired with a corresponding QL_TRACE_EXIT_FUNCTION macro. Such
statement might be ignored; refer to QL_TRACE for details. Also,
function information might not be available depending on the
compiler.
*/
/*! \def QL_TRACE_EXIT_FUNCTION
\brief output tracing information
The statement
\code
QL_TRACE_EXIT_FUNCTION;
\endcode
can be used before returning from a function to trace the fact
that the program execution is exiting such function. It should be
paired with a corresponding QL_TRACE_ENTER_FUNCTION macro. Such
statement might be ignored; refer to QL_TRACE for details. Also,
function information might not be available depending on the
compiler.
*/
/*! \def QL_TRACE_LOCATION
\brief output tracing information
The statement
\code
QL_TRACE_LOCATION;
\endcode
can be used to trace the current file and line. Such statement
might be ignored; refer to QL_TRACE for details.
*/
/*! \def QL_TRACE_VARIABLE
\brief output tracing information
The statement
\code
QL_TRACE_VARIABLE(variable);
\endcode
can be used to trace the current value of a variable. Such
statement might be ignored; refer to QL_TRACE for details. Also,
the variable type must allow sending it to an output stream.
*/
/*! @} */
/*! @} */
#if defined(QL_ENABLE_TRACING)
#define QL_DEFAULT_TRACER QuantLib::detail::Tracing::instance()
#define QL_TRACE_ENABLE \
QL_DEFAULT_TRACER.enable()
#define QL_TRACE_DISABLE \
QL_DEFAULT_TRACER.disable()
#define QL_TRACE_ON(out) \
QL_DEFAULT_TRACER.setStream(out)
#define QL_TRACE(message) \
if (QL_DEFAULT_TRACER.enabled()) \
try { \
QL_DEFAULT_TRACER.stream() << "trace[" << QL_DEFAULT_TRACER.depth() \
<< "]: " << message << std::endl; \
} catch (...) {} \
else
#define QL_TRACE_ENTER_FUNCTION \
if (QL_DEFAULT_TRACER.enabled()) \
try { \
QL_DEFAULT_TRACER.down(); \
QL_DEFAULT_TRACER.stream() << "trace[" << QL_DEFAULT_TRACER.depth() \
<< "]: " \
<< "Entering " << BOOST_CURRENT_FUNCTION \
<< std::endl; \
} catch (...) {} \
else
#define QL_TRACE_EXIT_FUNCTION \
if (QL_DEFAULT_TRACER.enabled()) \
try { \
QL_DEFAULT_TRACER.stream() << "trace[" << QL_DEFAULT_TRACER.depth() \
<< "]: " \
<< "Exiting " << BOOST_CURRENT_FUNCTION \
<< std::endl; \
QL_DEFAULT_TRACER.up(); \
} catch (...) { QL_DEFAULT_TRACER.up(); } \
else
#define QL_TRACE_LOCATION \
QL_TRACE("At line " << __LINE__ << " in " << __FILE__)
#define QL_TRACE_VARIABLE(variable) \
QL_TRACE(#variable << " = " << variable)
#else
#define QL_DEFAULT_TRACER
#define QL_TRACE_ENABLE
#define QL_TRACE_DISABLE
#define QL_TRACE_ON(out)
#define QL_TRACE(message)
#define QL_TRACE_ENTER_FUNCTION
#define QL_TRACE_EXIT_FUNCTION
#define QL_TRACE_LOCATION
#define QL_TRACE_VARIABLE(variable)
#endif
#endif
|