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                 UNDO       = (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                 ///     selection
 101                 SELECTION  = (1 << 29),
 102                 ///
 103                 DEBUG      = (1 << 31),
 104                 ///
 105                 ANY = 0xffffffff
 106         };
 107
 108         /** A function to convert symbolic string names on debug levels
 109             to their numerical value.
 110         */
 111         Type value(std::string const & val);
 112
 113         /** Display the tags and descriptions of the current debug level
 114             of ds
 115         */
 116         void showLevel(std::ostream & os, Type level);
 117
 118         /** show all the possible tags that can be used for debugging */
 119         void showTags(std::ostream & os);
 120
 121 } // namespace Debug
 122
 123
 124 inline void operator|=(Debug::Type & d1, Debug::Type d2)
 125 {
 126         d1 = static_cast<Debug::Type>(d1 | d2);
 127 }
 128
 129
 130 class LyXErr
 131 {
 132 public:
 133         LyXErr(): enabled_(true) {}
 134         /// Disable the stream completely
 135         void disable();
 136         /// Enable the stream after a possible call of disable()
 137         void enable();
 138         ///
 139         bool enabled() const { return enabled_; }
 140         /// Returns true if t is part of the current debug level.
 141         bool debugging(Debug::Type t = Debug::ANY) const;
 142         /// Ends output
 143         void endl();
 144         /// Sets stream
 145         void setStream(std::ostream & os) { stream_ = &os; }
 146         /// Sets stream
 147         std::ostream & stream() { return *stream_; }
 148         /// Sets the debug level to t.
 149         void level(Debug::Type t) { dt = t; }
 150         /// Returns the current debug level.
 151         Debug::Type level() const { return dt; }
 152         /// Returns stream
 153         operator std::ostream &() { return *stream_; }
 154 private:
 155         /// The current debug level
 156         Debug::Type dt;
 157         /// Is the stream enabled?
 158         bool enabled_;
 159         /// The real stream
 160         std::ostream * stream_;
 161 };
 162
 163 namespace support { class FileName; }
 164
 165 LyXErr & operator<<(LyXErr &, void const *);
 166 LyXErr & operator<<(LyXErr &, char const *);
 167 LyXErr & operator<<(LyXErr &, char);
 168 LyXErr & operator<<(LyXErr &, int);
 169 LyXErr & operator<<(LyXErr &, unsigned int);
 170 LyXErr & operator<<(LyXErr &, long);
 171 LyXErr & operator<<(LyXErr &, unsigned long);
 172 LyXErr & operator<<(LyXErr &, double);
 173 LyXErr & operator<<(LyXErr &, std::string const &);
 174 LyXErr & operator<<(LyXErr &, docstring const &);
 175 LyXErr & operator<<(LyXErr &, support::FileName const &);
 176 LyXErr & operator<<(LyXErr &, std::ostream &(*)(std::ostream &));
 177 LyXErr & operator<<(LyXErr &, std::ios_base &(*)(std::ios_base &));
 178
 179 extern LyXErr lyxerr;
 180
 181 } // namespace lyx
 182
 183 #if USE_BOOST_CURRENT_FUNCTION
 184 #       include <boost/current_function.hpp>
 185 #       define CURRENT_POSITION BOOST_CURRENT_FUNCTION ": "
 186 #else
 187 # define CURRENT_POSITION __FILE__ << "(" << __LINE__ << "): "
 188 #endif
 189
 190 #define LYXERR(type, msg) \
 191         do { \
 192                 if (!lyx::lyxerr.debugging(type)) {} \
 193                 else { lyx::lyxerr << CURRENT_POSITION << msg; lyx::lyxerr.endl(); } \
 194         } while (0)
 195
 196 #define LYXERR0(msg) \
 197         do { \
 198                 lyx::lyxerr << CURRENT_POSITION << msg; lyx::lyxerr.endl(); \
 199         } while (0)
 200
 201
 202 #endif