3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
10 * Full author contact details are available in file CREDITS.
15 #include "support/debug.h"
17 #include "support/convert.h"
18 #include "support/FileName.h"
19 #include "support/gettext.h"
20 #include "support/lstrings.h"
21 #include "support/ProgressInterface.h"
28 using namespace lyx::support;
34 struct DebugErrorItem {
41 DebugErrorItem errorTags[] = {
42 { Debug::NONE, "none", N_("No debugging messages")},
43 { Debug::INFO, "info", N_("General information")},
44 { Debug::INIT, "init", N_("Program initialisation")},
45 { Debug::KEY, "key", N_("Keyboard events handling")},
46 { Debug::GUI, "gui", N_("GUI handling")},
47 { Debug::PARSER, "parser", N_("Lyxlex grammar parser")},
48 { Debug::LYXRC, "lyxrc", N_("Configuration files reading")},
49 { Debug::KBMAP, "kbmap", N_("Custom keyboard definition")},
50 { Debug::LATEX, "latex", N_("LaTeX generation/execution")},
51 { Debug::MATHED, "mathed", N_("Math editor")},
52 { Debug::FONT, "font", N_("Font handling")},
53 { Debug::TCLASS, "tclass", N_("Textclass files reading")},
54 { Debug::LYXVC, "lyxvc", N_("Version control")},
55 { Debug::LYXSERVER, "lyxserver", N_("External control interface")},
56 { Debug::UNDO, "undo", N_("Undo/Redo mechanism")},
57 { Debug::ACTION, "action", N_("User commands")},
58 { Debug::LYXLEX, "lyxlex", N_("The LyX Lexer")},
59 { Debug::DEPEND, "depend", N_("Dependency information")},
60 { Debug::INSETS, "insets", N_("LyX Insets")},
61 { Debug::FILES, "files", N_("Files used by LyX")},
62 { Debug::WORKAREA, "workarea", N_("Workarea events")},
63 { Debug::CLIPBOARD, "clipboard", N_("Clipboard handling")},
64 { Debug::GRAPHICS, "graphics", N_("Graphics conversion and loading")},
65 { Debug::CHANGES, "changes", N_("Change tracking")},
66 { Debug::EXTERNAL, "external", N_("External template/inset messages")},
67 { Debug::PAINTING, "painting", N_("RowPainter profiling")},
68 { Debug::SCROLLING, "scrolling", N_("Scrolling debugging")},
69 { Debug::MACROS, "macros", N_("Math macros")},
70 { Debug::RTL, "rtl", N_("RTL/Bidi")},
71 { Debug::LOCALE, "locale", N_("Locale/Internationalisation")},
72 { Debug::SELECTION, "selection", N_("Selection copy/paste mechanism")},
73 { Debug::FIND, "find", N_("Find and replace mechanism")},
74 { Debug::DEBUG, "debug", N_("Developers' general debug messages")},
75 { Debug::ANY, "any", N_("All debugging messages")}
79 int const numErrorTags = sizeof(errorTags)/sizeof(errorTags[0]);
84 int Debug::levelCount()
90 Debug::Type Debug::value(int idx)
92 if (idx > 0 && idx < numErrorTags)
93 return errorTags[idx].level;
98 string const Debug::description(Debug::Type val)
100 for (int i = 0 ; i < numErrorTags ; ++i) {
101 if (errorTags[i].level == val)
102 return errorTags[i].desc;
104 return "unknown level";
108 string const Debug::name(Debug::Type val)
110 for (int i = 0 ; i < numErrorTags ; ++i) {
111 if (errorTags[i].level == val)
112 return errorTags[i].name;
114 return "unknown level";
118 Debug::Type Debug::value(string const & val)
120 Type l = Debug::NONE;
123 size_t const st = v.find(',');
124 string const tmp = ascii_lowercase(v.substr(0, st));
129 l |= static_cast<Type>(convert<int>(tmp));
131 // Search for an explicit name
132 for (int i = 0 ; i < numErrorTags ; ++i)
133 if (tmp == errorTags[i].name) {
134 l |= errorTags[i].level;
137 if (st == string::npos)
145 void Debug::showLevel(ostream & os, Debug::Type level)
147 // Show what features are traced
148 for (int i = 0; i < numErrorTags; ++i) {
149 if (errorTags[i].level != Debug::ANY
150 && errorTags[i].level != Debug::NONE
151 && errorTags[i].level & level) {
152 // avoid to_utf8(_(...)) re-entrance problem
153 docstring const s = _(errorTags[i].desc);
154 os << to_utf8(bformat(_("Debugging `%1$s' (%2$s)"),
155 from_utf8(errorTags[i].name), s))
163 void Debug::showTags(ostream & os)
165 for (int i = 0; i != numErrorTags ; ++i)
166 os << setw(10) << static_cast<unsigned int>(errorTags[i].level)
167 << setw(13) << errorTags[i].name
168 << " " << to_utf8(_(errorTags[i].desc)) << '\n';
173 void LyXErr::disable()
179 void LyXErr::enable()
185 bool LyXErr::debugging(Debug::Type t) const
194 stream() << std::endl;
196 secondStream() << std::endl;
201 char const * LyXErr::stripName(char const * n)
203 string const name = n;
204 // find the last occurrence of /src/ in name
205 size_t pos = name.rfind("/src/");
206 if (pos == string::npos)
207 pos = name.rfind("\\src\\");
208 if (pos == string::npos)
215 // It seems not possible to instantiate operator template out of class body
217 LyXErr & toStream(LyXErr & l, T t)
221 if (l.secondEnabled()) {
222 l.secondStream() << t;
223 ProgressInterface::instance()->lyxerrFlush();
230 LyXErr & operator<<(LyXErr & l, void const * t)
231 { return toStream(l, t); }
232 LyXErr & operator<<(LyXErr & l, char const * t)
233 { return toStream(l, t); }
234 LyXErr & operator<<(LyXErr & l, char t)
235 { return toStream(l, t); }
236 LyXErr & operator<<(LyXErr & l, int t)
237 { return toStream(l, t); }
238 LyXErr & operator<<(LyXErr & l, unsigned int t)
239 { return toStream(l, t); }
240 LyXErr & operator<<(LyXErr & l, long t)
241 { return toStream(l, t); }
242 LyXErr & operator<<(LyXErr & l, unsigned long t)
243 { return toStream(l, t); }
244 #ifdef HAVE_LONG_LONG_INT
245 LyXErr & operator<<(LyXErr & l, long long t)
246 { return toStream(l, t); }
247 LyXErr & operator<<(LyXErr & l, unsigned long long t)
248 { return toStream(l, t); }
250 LyXErr & operator<<(LyXErr & l, double t)
251 { return toStream(l, t); }
252 LyXErr & operator<<(LyXErr & l, string const & t)
253 { return toStream(l, t); }
254 LyXErr & operator<<(LyXErr & l, docstring const & t)
255 { return toStream(l, to_utf8(t)); }
256 LyXErr & operator<<(LyXErr & l, FileName const & t)
257 { return toStream(l, t); }
258 LyXErr & operator<<(LyXErr & l, ostream &(*t)(ostream &))
259 { return toStream(l, t); }
260 LyXErr & operator<<(LyXErr & l, ios_base &(*t)(ios_base &))
261 { return toStream(l, t); }
264 // The global instance