3 // Created by Lars Gullik Bjønnes
4 // Copyright 1999 Lars Gullik Bjønnes (larsbj@lyx.org)
5 // Released into the public domain.
7 // Implemented and tested on g++ 2.7.2.3
9 // Primarily developed for use in the LyX Project http://www.lyx.org/
10 // but should be adaptable to any project.
17 #ifdef TEST_DEBUGSTREAM
32 static const type ANY = type(INFO | WARN | CRIT);
34 /** A function to convert symbolic string names on debug levels
35 to their numerical value.
37 static Debug::type value(string const & val) {
38 if (val == "NONE") return Debug::NONE;
39 if (val == "INFO") return Debug::INFO;
40 if (val == "WARN") return Debug::WARN;
41 if (val == "CRIT") return Debug::CRIT;
48 /** DebugStream is a ostream intended for debug output. It has also support
49 for a logfile. Debug output is output to cerr and if the logfile is set,
54 debug.level(Debug::INFO);
55 debug.debug(Debug::WARN) << "WARN\n";
56 debug[Debug::INFO] << "INFO\n";
63 If you want to have debug output from time critical code you should
65 if (debug.debugging(Debug::INFO)) {
66 debug << "...debug output...\n";
69 To give debug info even if no debug (NONE) is requested:
70 debug << "... always output ...\n";
72 To give debug output regardless of what debug level is set (!NONE):
73 debug.debug() << "...on debug output...\n";
74 debug[Debug::ANY] << "...on debug output...\n";
76 To give debug output when a specific debug level is set (INFO):
77 debug.debug(Debug::INFO) << "...info...\n";
78 debug[Debug::INFO] << "...info...\n";
80 To give debug output when either on of debug levels is set (INFO or CRIT):
81 debug.debug(Debug::type(Debug::INFO | Debug::CRIT)) << "...info/crit...\n";
82 debug[Debug::type(Debug::INFO | Debug::CRIT)] << "...info/crit...\n";
85 class DebugStream : public std::ostream {
87 /// Constructor, sets the debug level to t.
88 explicit DebugStream(Debug::type t = Debug::NONE);
90 /// Constructor, sets the log file to f, and the debug level to t.
92 DebugStream(char const * f, Debug::type t = Debug::NONE);
95 virtual ~DebugStream();
97 /// Sets the debug level to t.
98 void level(Debug::type t) {
99 dt = Debug::type(t & Debug::ANY);
102 /// Returns the current debug level.
103 Debug::type level() const {
107 /// Adds t to the current debug level.
108 void addLevel(Debug::type t) {
109 dt = Debug::type(dt | t);
112 /// Deletes t from the current debug level.
113 void delLevel(Debug::type t) {
114 dt = Debug::type(dt & ~t);
117 /// Sets the debugstreams' logfile to f.
118 void logFile(char const * f);
120 /// Returns true if t is part of the current debug level.
121 bool debugging(Debug::type t = Debug::ANY) const
123 if (dt & t) return true;
128 /** Returns the no-op stream if t is not part of the
129 current debug level otherwise the real debug stream
132 std::ostream & debug(Debug::type t = Debug::ANY) {
133 if (dt & t) return *this;
138 /** This is an operator to give a more convenient use:
139 dbgstream[Debug::INFO] << "Info!\n";
141 std::ostream & operator[](Debug::type t) {
145 /// The current debug level
147 /// The no-op stream.
148 std::ostream nullstream;
149 struct debugstream_internal;
150 debugstream_internal * internal;