5 * FIXME: It would be nice if, in lyx::use_gui mode, instead of
6 * outputting to the console, we would pipe all messages onto a file
7 * and visualise the contents dynamically in a Qt window if needed.
9 * This file is part of LyX, the document processor.
10 * Licence details can be found in the file COPYING.
12 * \author Lars Gullik Bjønnes
13 * \author Jean-Marc Lasgouttes
15 * Full author contact details are available in file CREDITS.
21 #include "support/strfwd.h"
28 template<typename CharT, typename Traits> class basic_streambuf;
29 typedef basic_streambuf<char, char_traits<char> > streambuf;
36 /// This is all the different debug levels that we have.
51 PARSER = (1 << 4), // 16
53 LYXRC = (1 << 5), // 32
55 KBMAP = (1 << 6), // 64
57 LATEX = (1 << 7), // 128
59 MATHED = (1 << 8), // 256 // Alejandro, please use this.
61 FONT = (1 << 9), // 512
63 TCLASS = (1 << 10), // 1024
65 LYXVC = (1 << 11), // 2048
67 LYXSERVER = (1 << 12), // 4096
69 ROFF = (1 << 13), // 8192
71 ACTION = (1 << 14), // 16384
83 INSETTEXT = (1 << 20),
98 /** A function to convert symbolic string names on debug levels
99 to their numerical value.
101 Type value(std::string const & val);
103 /** Display the tags and descriptions of the current debug level
106 void showLevel(std::ostream & os, Type level);
108 /** show all the possible tags that can be used for debugging */
109 void showTags(std::ostream & os);
114 inline void operator|=(Debug::Type & d1, Debug::Type d2)
116 d1 = static_cast<Debug::Type>(d1 | d2);
123 /// Disable the stream completely
125 /// Enable the stream after a possible call of disable()
127 /// Returns true if t is part of the current debug level.
128 bool debugging(Debug::Type t = Debug::ANY) const;
132 void setStream(std::ostream & os) { stream_ = &os; }
134 std::ostream & stream() { return *stream_; }
135 /// Sets the debug level to t.
136 void level(Debug::Type t) { dt = t; }
137 /// Returns the current debug level.
138 Debug::Type level() const { return dt; }
140 operator std::ostream &() { return *stream_; }
142 /// The current debug level
144 /// Is the stream enabled?
147 std::ostream * stream_;
150 namespace support { class FileName; }
152 LyXErr & operator<<(LyXErr &, void const *);
153 LyXErr & operator<<(LyXErr &, char const *);
154 LyXErr & operator<<(LyXErr &, char);
155 LyXErr & operator<<(LyXErr &, int);
156 LyXErr & operator<<(LyXErr &, unsigned int);
157 LyXErr & operator<<(LyXErr &, long);
158 LyXErr & operator<<(LyXErr &, unsigned long);
159 LyXErr & operator<<(LyXErr &, double);
160 LyXErr & operator<<(LyXErr &, std::string const &);
161 LyXErr & operator<<(LyXErr &, docstring const &);
162 LyXErr & operator<<(LyXErr &, support::FileName const &);
163 LyXErr & operator<<(LyXErr &, std::ostream &(*)(std::ostream &));
164 LyXErr & operator<<(LyXErr &, std::ios_base &(*)(std::ios_base &));
166 extern LyXErr lyxerr;
170 #if USE_BOOST_CURRENT_FUNCTION
171 # include <boost/current_function.hpp>
172 # define CURRENT_POSITION BOOST_CURRENT_FUNCTION ": "
174 # define CURRENT_POSITION __FILE__ << "(" << __LINE__ << "): "
177 #define LYXERR(type, msg) \
179 if (!lyx::lyxerr.debugging(type)) {} \
180 else { lyx::lyxerr << CURRENT_POSITION << msg; lyx::lyxerr.endl(); } \
183 #define LYXERR0(msg) LYXERR(lyx::Debug::ANY, msg)