debugMacros man page

debugMacros — Debugging macros

Macros

#define QL_TRACE_ENABLE
enable tracing
#define QL_TRACE_DISABLE
disable tracing
#define QL_TRACE_ON(out)
set tracing stream
#define QL_TRACE(message)
output tracing information
#define QL_TRACE_ENTER_FUNCTION
output tracing information
#define QL_TRACE_EXIT_FUNCTION
output tracing information
#define QL_TRACE_LOCATION
output tracing information
#define QL_TRACE_VARIABLE(variable)
output tracing information

Detailed Description

For debugging purposes, macros can be used to output information about the code being executed.

Macro Definition Documentation

#define QL_TRACE_ENABLE

enable tracing The statement

QL_TRACE_ENABLE;

can be used to enable tracing. Such statement might be ignored; refer to QL_TRACE for details.

Examples: tracing_example.cpp.

#define QL_TRACE_DISABLE

disable tracing The statement

QL_TRACE_DISABLE;

can be used to disable tracing. Such statement might be ignored; refer to QL_TRACE for details.

#define QL_TRACE_ON(out)

set tracing stream The statement

QL_TRACE_ON(stream);

can be used to set the stream where tracing messages are output. Such statement might be ignored; refer to QL_TRACE for details.

#define QL_TRACE(message)

output tracing information The statement

QL_TRACE(message);

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.

Examples: tracing_example.cpp.

#define QL_TRACE_ENTER_FUNCTION

output tracing information The statement

QL_TRACE_ENTER_FUNCTION;

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.

Examples: tracing_example.cpp.

#define QL_TRACE_EXIT_FUNCTION

output tracing information The statement

QL_TRACE_EXIT_FUNCTION;

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.

Examples: tracing_example.cpp.

#define QL_TRACE_LOCATION

output tracing information The statement

QL_TRACE_LOCATION;

can be used to trace the current file and line. Such statement might be ignored; refer to QL_TRACE for details.

Examples: tracing_example.cpp.

#define QL_TRACE_VARIABLE(variable)

output tracing information The statement

QL_TRACE_VARIABLE(variable);

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.

Examples: tracing_example.cpp.

Author

Generated automatically by Doxygen for QuantLib from the source code.

Referenced By

QL_TRACE(3), QL_TRACE_DISABLE(3), QL_TRACE_ENABLE(3), QL_TRACE_ENTER_FUNCTION(3), QL_TRACE_EXIT_FUNCTION(3), QL_TRACE_LOCATION(3), QL_TRACE_ON(3) and QL_TRACE_VARIABLE(3) are aliases of debugMacros(3).

Fri Sep 23 2016 Version 1.8.1 QuantLib