src/support/debug.h

   1 // -*- C++ -*-
   2 /**
   3  * \file debug.h
   4  *
   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.
   8  *
   9  * This file is part of LyX, the document processor.
  10  * Licence details can be found in the file COPYING.
  11  *
  12  * \author Lars Gullik Bjønnes
  13  * \author Jean-Marc Lasgouttes
  14  *
  15  * Full author contact details are available in file CREDITS.
  16  */
  17
  18 #ifndef LYXDEBUG_H
  19 #define LYXDEBUG_H
  20
  21 #include "support/strfwd.h"
  22
  23
  24 namespace std {
  25
  26 class ios_base;
  27
  28 template<typename CharT, typename Traits> class basic_streambuf;
  29 typedef basic_streambuf<char, char_traits<char> > streambuf;
  30
  31 }
  32
  33
  34 namespace lyx {
  35
  36 ///  This is all the different debug levels that we have.
  37 namespace Debug {
  38         ///
  39         enum Type {
  40                 ///
  41                 NONE = 0,
  42                 ///
  43                 INFO       = (1 << 0),   // 1
  44                 ///
  45                 INIT       = (1 << 1),   // 2
  46                 ///
  47                 KEY        = (1 << 2),   // 4
  48                 ///
  49                 GUI        = (1 << 3),   // 8
  50                 ///
  51                 PARSER     = (1 << 4),   // 16
  52                 ///
  53                 LYXRC      = (1 << 5),   // 32
  54                 ///
  55                 KBMAP      = (1 << 6),   // 64
  56                 ///
  57                 LATEX      = (1 << 7),   // 128
  58                 ///
  59                 MATHED     = (1 << 8),   // 256 // Alejandro, please use this.
  60                 ///
  61                 FONT       = (1 << 9),   // 512
  62                 ///
  63                 TCLASS     = (1 << 10),  // 1024
  64                 ///
  65                 LYXVC      = (1 << 11),  // 2048
  66                 ///
  67                 LYXSERVER  = (1 << 12),  // 4096
  68                 ///
  69                 ROFF       = (1 << 13),  // 8192
  70                 ///
  71                 ACTION     = (1 << 14),   // 16384
  72                 ///
  73                 LYXLEX     = (1 << 15),
  74                 ///
  75                 DEPEND     = (1 << 16),
  76                 ///
  77                 INSETS     = (1 << 17),
  78                 ///
  79                 FILES      = (1 << 18),
  80                 ///
  81                 WORKAREA   = (1 << 19),
  82                 ///
  83                 INSETTEXT  = (1 << 20),
  84                 ///
  85                 GRAPHICS   = (1 << 21),
  86                 /// change tracking
  87                 CHANGES    = (1 << 22),
  88                 ///
  89                 EXTERNAL   = (1 << 23),
  90                 ///
  91                 PAINTING   = (1 << 24),
  92                 ///
  93                 SCROLLING  = (1 << 25),
  94                 ///
  95                 MACROS     = (1 << 26),
  96                 ///     rtl-related
  97                 RTL        = (1 << 27),
  98                 ///     locale related
  99                 LOCALE        = (1 << 28),
 100                 ///
 101                 DEBUG      = (1 << 31),
 102                 ///
 103                 ANY = 0xffffffff
 104         };
 105
 106         /** A function to convert symbolic string names on debug levels
 107             to their numerical value.
 108         */
 109         Type value(std::string const & val);
 110
 111         /** Display the tags and descriptions of the current debug level
 112             of ds
 113         */
 114         void showLevel(std::ostream & os, Type level);
 115
 116         /** show all the possible tags that can be used for debugging */
 117         void showTags(std::ostream & os);
 118
 119 } // namespace Debug
 120
 121
 122 inline void operator|=(Debug::Type & d1, Debug::Type d2)
 123 {
 124         d1 = static_cast<Debug::Type>(d1 | d2);
 125 }
 126
 127
 128 class LyXErr
 129 {
 130 public:
 131         LyXErr(): enabled_(true) {}
 132         /// Disable the stream completely
 133         void disable();
 134         /// Enable the stream after a possible call of disable()
 135         void enable();
 136         ///
 137         bool enabled() const { return enabled_; }
 138         /// Returns true if t is part of the current debug level.
 139         bool debugging(Debug::Type t = Debug::ANY) const;
 140         /// Ends output
 141         void endl();
 142         /// Sets stream
 143         void setStream(std::ostream & os) { stream_ = &os; }
 144         /// Sets stream
 145         std::ostream & stream() { return *stream_; }
 146         /// Sets the debug level to t.
 147         void level(Debug::Type t) { dt = t; }
 148         /// Returns the current debug level.
 149         Debug::Type level() const { return dt; }
 150         /// Returns stream
 151         operator std::ostream &() { return *stream_; }
 152 private:
 153         /// The current debug level
 154         Debug::Type dt;
 155         /// Is the stream enabled?
 156         bool enabled_;
 157         /// The real stream
 158         std::ostream * stream_;
 159 };
 160
 161 namespace support { class FileName; }
 162
 163 LyXErr & operator<<(LyXErr &, void const *);
 164 LyXErr & operator<<(LyXErr &, char const *);
 165 LyXErr & operator<<(LyXErr &, char);
 166 LyXErr & operator<<(LyXErr &, int);
 167 LyXErr & operator<<(LyXErr &, unsigned int);
 168 LyXErr & operator<<(LyXErr &, long);
 169 LyXErr & operator<<(LyXErr &, unsigned long);
 170 LyXErr & operator<<(LyXErr &, double);
 171 LyXErr & operator<<(LyXErr &, std::string const &);
 172 LyXErr & operator<<(LyXErr &, docstring const &);
 173 LyXErr & operator<<(LyXErr &, support::FileName const &);
 174 LyXErr & operator<<(LyXErr &, std::ostream &(*)(std::ostream &));
 175 LyXErr & operator<<(LyXErr &, std::ios_base &(*)(std::ios_base &));
 176
 177 extern LyXErr lyxerr;
 178
 179 } // namespace lyx
 180
 181 #if USE_BOOST_CURRENT_FUNCTION
 182 #       include <boost/current_function.hpp>
 183 #       define CURRENT_POSITION BOOST_CURRENT_FUNCTION ": "
 184 #else
 185 # define CURRENT_POSITION __FILE__ << "(" << __LINE__ << "): "
 186 #endif
 187
 188 #define LYXERR(type, msg) \
 189         do { \
 190                 if (!lyx::lyxerr.debugging(type)) {} \
 191                 else { lyx::lyxerr << CURRENT_POSITION << msg; lyx::lyxerr.endl(); } \
 192         } while (0)
 193
 194 #define LYXERR0(msg) \
 195         do { \
 196                 lyx::lyxerr << CURRENT_POSITION << msg; lyx::lyxerr.endl(); \
 197         } while (0)
 198
 199
 200 #endif