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),
93 SCROLLING = (1 << 25),
100 /** A function to convert symbolic string names on debug levels
101 to their numerical value.
103 Type value(std::string const & val);
105 /** Display the tags and descriptions of the current debug level
108 void showLevel(std::ostream & os, Type level);
110 /** show all the possible tags that can be used for debugging */
111 void showTags(std::ostream & os);
116 inline void operator|=(Debug::Type & d1, Debug::Type d2)
118 d1 = static_cast<Debug::Type>(d1 | d2);
125 LyXErr(): enabled_(true) {}
126 /// Disable the stream completely
128 /// Enable the stream after a possible call of disable()
131 bool enabled() const { return enabled_; }
132 /// Returns true if t is part of the current debug level.
133 bool debugging(Debug::Type t = Debug::ANY) const;
137 void setStream(std::ostream & os) { stream_ = &os; }
139 std::ostream & stream() { return *stream_; }
140 /// Sets the debug level to t.
141 void level(Debug::Type t) { dt = t; }
142 /// Returns the current debug level.
143 Debug::Type level() const { return dt; }
145 operator std::ostream &() { return *stream_; }
147 /// The current debug level
149 /// Is the stream enabled?
152 std::ostream * stream_;
155 namespace support { class FileName; }
157 LyXErr & operator<<(LyXErr &, void const *);
158 LyXErr & operator<<(LyXErr &, char const *);
159 LyXErr & operator<<(LyXErr &, char);
160 LyXErr & operator<<(LyXErr &, int);
161 LyXErr & operator<<(LyXErr &, unsigned int);
162 LyXErr & operator<<(LyXErr &, long);
163 LyXErr & operator<<(LyXErr &, unsigned long);
164 LyXErr & operator<<(LyXErr &, double);
165 LyXErr & operator<<(LyXErr &, std::string const &);
166 LyXErr & operator<<(LyXErr &, docstring const &);
167 LyXErr & operator<<(LyXErr &, support::FileName const &);
168 LyXErr & operator<<(LyXErr &, std::ostream &(*)(std::ostream &));
169 LyXErr & operator<<(LyXErr &, std::ios_base &(*)(std::ios_base &));
171 extern LyXErr lyxerr;
175 #if USE_BOOST_CURRENT_FUNCTION
176 # include <boost/current_function.hpp>
177 # define CURRENT_POSITION BOOST_CURRENT_FUNCTION ": "
179 # define CURRENT_POSITION __FILE__ << "(" << __LINE__ << "): "
182 #define LYXERR(type, msg) \
184 if (!lyx::lyxerr.debugging(type)) {} \
185 else { lyx::lyxerr << CURRENT_POSITION << msg; lyx::lyxerr.endl(); } \
188 #define LYXERR0(msg) \
190 lyx::lyxerr << CURRENT_POSITION << msg; lyx::lyxerr.endl(); \