blob: 1cc1d6f7252440cdf1bf5c53c910211692c21358 (
plain)
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
|
#ifndef AUDIOGRAPHER_DEBUGGABLE_H
#define AUDIOGRAPHER_DEBUGGABLE_H
#ifndef DEFAULT_DEBUG_LEVEL
#define DEFAULT_DEBUG_LEVEL DebugNone
#endif
#include <iostream>
#include "audiographer/visibility.h"
namespace AudioGrapher
{
/// Compile time defined debug level
enum LIBAUDIOGRAPHER_API DebugLevel
{
DebugNone, ///< Disabled
DebugObject, ///< Object level stuff, ctors, initalizers etc.
DebugFlags, ///< Debug ProcessContext flags only on process cycle level
DebugProcess, ///< Process cycle level stuff
DebugVerbose, ///< Lots of output, not on sample level
DebugSample ///< Sample level stuff
};
/** Class that allows optimizing out debugging code during compile time.
* Usage: to take all advantage of this class you should wrap all
* debugging statemets like this:
* \code
* if (debug_level (SomeDebugLevel) && other_optional_conditionals) {
* debug_stream() << "Debug output" << std::endl;
* }
* \endcode
*
* The order of the conditionals in the if-clause is important.
* The checks specified in \a other_optional_conditionals are only
* optimized out if \a debug_level() is placed before it with a
* logical and (short-circuiting).
*/
template<DebugLevel L = DEFAULT_DEBUG_LEVEL>
class /*LIBAUDIOGRAPHER_API*/ Debuggable
{
protected:
Debuggable(std::ostream & debug_stream = std::cerr)
: stream (debug_stream) {}
bool debug_level (DebugLevel level) {
#ifndef NDEBUG
(void) level; /* stop pedantic gcc complaints about unused parameter */
return false;
#else
return L >= level;
#endif
}
std::ostream & debug_stream() { return stream; }
private:
std::ostream & stream;
};
} // namespace
#endif // AUDIOGRAPHER_DEBUGGABLE_H
|
