src/support/debug.cpp

   1 /**
   2  * \file debug.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author Jean-Marc Lasgouttes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "support/convert.h"
  15 #include "support/debug.h"
  16 #include "support/gettext.h"
  17 #include "support/lstrings.h"
  18 #include "support/FileName.h"
  19
  20 #include <iostream>
  21 #include <iomanip>
  22
  23 using namespace std;
  24 using namespace lyx::support;
  25
  26 namespace lyx {
  27
  28 namespace {
  29
  30 struct ErrorItem {
  31         Debug::Type level;
  32         char const * name;
  33         char const * desc;
  34 };
  35
  36
  37 ErrorItem errorTags[] = {
  38         { Debug::NONE,      "none",      N_("No debugging message")},
  39         { Debug::INFO,      "info",      N_("General information")},
  40         { Debug::INIT,      "init",      N_("Program initialisation")},
  41         { Debug::KEY,       "key",       N_("Keyboard events handling")},
  42         { Debug::GUI,       "gui",       N_("GUI handling")},
  43         { Debug::PARSER,    "parser",    N_("Lyxlex grammar parser")},
  44         { Debug::LYXRC,     "lyxrc",     N_("Configuration files reading")},
  45         { Debug::KBMAP,     "kbmap",     N_("Custom keyboard definition")},
  46         { Debug::LATEX,     "latex",     N_("LaTeX generation/execution")},
  47         { Debug::MATHED,    "mathed",    N_("Math editor")},
  48         { Debug::FONT,      "font",      N_("Font handling")},
  49         { Debug::TCLASS,    "tclass",    N_("Textclass files reading")},
  50         { Debug::LYXVC,     "lyxvc",     N_("Version control")},
  51         { Debug::LYXSERVER, "lyxserver", N_("External control interface")},
  52         { Debug::ROFF,      "roff",      N_("Keep *roff temporary files")},
  53         { Debug::ACTION,    "action",    N_("User commands")},
  54         { Debug::LYXLEX,    "lyxlex",    N_("The LyX Lexxer")},
  55         { Debug::DEPEND,    "depend",    N_("Dependency information")},
  56         { Debug::INSETS,    "insets",    N_("LyX Insets")},
  57         { Debug::FILES,     "files",     N_("Files used by LyX")},
  58         { Debug::WORKAREA,  "workarea",  N_("Workarea events")},
  59         { Debug::INSETTEXT, "insettext", N_("Insettext/tabular messages")},
  60         { Debug::GRAPHICS,  "graphics",  N_("Graphics conversion and loading")},
  61         { Debug::CHANGES,   "changes",   N_("Change tracking")},
  62         { Debug::EXTERNAL,  "external",  N_("External template/inset messages")},
  63         { Debug::PAINTING,  "painting",  N_("RowPainter profiling")},
  64         { Debug::SCROLLING, "scrolling", N_("scrolling debugging")},
  65         { Debug::MACROS,    "macros",    N_("Math macros")},
  66         { Debug::RTL,       "rtl",       N_("RTL/Bidi")},
  67         { Debug::DEBUG,     "debug",     N_("Developers' general debug messages")},
  68         { Debug::ANY,       "any",       N_("All debugging messages")}
  69 };
  70
  71
  72 int const numErrorTags = sizeof(errorTags)/sizeof(errorTags[0]);
  73
  74 } // namespace anon
  75
  76
  77 Debug::Type Debug::value(string const & val)
  78 {
  79         Type l = Debug::NONE;
  80         string v = val;
  81         while (!v.empty()) {
  82                 size_t const st = v.find(',');
  83                 string const tmp = ascii_lowercase(v.substr(0, st));
  84                 if (tmp.empty())
  85                         break;
  86                 // Is it a number?
  87                 if (isStrInt(tmp))
  88                         l |= static_cast<Type>(convert<int>(tmp));
  89                 else
  90                 // Search for an explicit name
  91                 for (int i = 0 ; i < numErrorTags ; ++i)
  92                         if (tmp == errorTags[i].name) {
  93                                 l |= errorTags[i].level;
  94                                 break;
  95                         }
  96                 if (st == string::npos)
  97                 break;
  98                 v.erase(0, st + 1);
  99         }
 100         return l;
 101 }
 102
 103
 104 void Debug::showLevel(ostream & os, Debug::Type level)
 105 {
 106         // Show what features are traced
 107         for (int i = 0; i != numErrorTags; ++i) {
 108                 if (errorTags[i].level != Debug::ANY
 109                     && errorTags[i].level != Debug::NONE
 110                     && errorTags[i].level & level) {
 111                         // avoid to_utf8(_(...)) re-entrance problem
 112                         docstring const s = _(errorTags[i].desc);
 113                         os << to_utf8(bformat(_("Debugging `%1$s' (%2$s)"),
 114                                         from_utf8(errorTags[i].name), s))
 115                            << '\n';
 116                 }
 117         }
 118         os.flush();
 119 }
 120
 121
 122 void Debug::showTags(ostream & os)
 123 {
 124         for (int i = 0; i != numErrorTags ; ++i)
 125                 os << setw(10) << static_cast<unsigned int>(errorTags[i].level)
 126                    << setw(13) << errorTags[i].name
 127                    << "  " << to_utf8(_(errorTags[i].desc)) << '\n';
 128         os.flush();
 129 }
 130
 131
 132 void LyXErr::disable()
 133 {
 134         enabled_ = false;
 135 }
 136
 137
 138 void LyXErr::enable()
 139 {
 140         enabled_ = true;
 141 }
 142
 143
 144 bool LyXErr::debugging(Debug::Type t) const
 145 {
 146         return (dt & t);
 147 }
 148
 149
 150 void LyXErr::endl()
 151 {
 152         if (enabled_)
 153                 stream() << std::endl;
 154 }
 155
 156
 157 LyXErr & operator<<(LyXErr & l, void const * t)
 158 { if (l.enabled()) l.stream() << t; return l; }
 159 LyXErr & operator<<(LyXErr & l, char const * t)
 160 { if (l.enabled()) l.stream() << t; return l; }
 161 LyXErr & operator<<(LyXErr & l, char t)
 162 { if (l.enabled()) l.stream() << t; return l; }
 163 LyXErr & operator<<(LyXErr & l, int t)
 164 { if (l.enabled()) l.stream() << t; return l; }
 165 LyXErr & operator<<(LyXErr & l, unsigned int t)
 166 { if (l.enabled()) l.stream() << t; return l; }
 167 LyXErr & operator<<(LyXErr & l, long t)
 168 { if (l.enabled()) l.stream() << t; return l; }
 169 LyXErr & operator<<(LyXErr & l, unsigned long t)
 170 { if (l.enabled()) l.stream() << t; return l; }
 171 LyXErr & operator<<(LyXErr & l, double t)
 172 { if (l.enabled()) l.stream() << t; return l; }
 173 LyXErr & operator<<(LyXErr & l, string const & t)
 174 { if (l.enabled()) l.stream() << t; return l; }
 175 LyXErr & operator<<(LyXErr & l, docstring const & t)
 176 { if (l.enabled()) l.stream() << to_utf8(t); return l; }
 177 LyXErr & operator<<(LyXErr & l, FileName const & t)
 178 { if (l.enabled()) l.stream() << t; return l; }
 179 LyXErr & operator<<(LyXErr & l, ostream &(*t)(ostream &))
 180 { if (l.enabled()) l.stream() << t; return l; }
 181 LyXErr & operator<<(LyXErr & l, ios_base &(*t)(ios_base &))
 182 { if (l.enabled()) l.stream() << t; return l; }
 183
 184
 185 // The global instance
 186 LyXErr lyxerr;
 187
 188 } // namespace lyx