libs/pbd/pbd/debug.h

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __libpbd_debug_h__
  21 #define __libpbd_debug_h__
  22
  23 #include <bitset>
  24 #include <stdint.h>
  25
  26 #include <sstream>
  27
  28 #include "pbd/libpbd_visibility.h"
  29 #include "pbd/timing.h"
  30
  31 #if defined(COMPILER_MSVC) && !defined(PTW32_VERSION)
  32 #include <ardourext/pthread.h> // Gets us 'PTW32_VERSION'
  33 #endif
  34
  35 namespace PBD {
  36
  37         typedef std::bitset<128> DebugBits;
  38
  39         LIBPBD_API extern DebugBits debug_bits;
  40         LIBPBD_API DebugBits new_debug_bit (const char* name);
  41         LIBPBD_API void debug_print (const char* prefix, std::string str);
  42         LIBPBD_API void set_debug_bits (DebugBits bits);
  43         LIBPBD_API int parse_debug_options (const char* str);
  44         LIBPBD_API void list_debug_options ();
  45
  46         namespace DEBUG {
  47
  48                 /* this namespace is so that we can write DEBUG::bit_name */
  49
  50                 LIBPBD_API extern DebugBits Stateful;
  51                 LIBPBD_API extern DebugBits Properties;
  52                 LIBPBD_API extern DebugBits FileManager;
  53                 LIBPBD_API extern DebugBits Pool;
  54                 LIBPBD_API extern DebugBits EventLoop;
  55                 LIBPBD_API extern DebugBits AbstractUI;
  56                 LIBPBD_API extern DebugBits Configuration;
  57                 LIBPBD_API extern DebugBits FileUtils;
  58                 LIBPBD_API extern DebugBits UndoHistory;
  59                 LIBPBD_API extern DebugBits Timing;
  60                 LIBPBD_API extern DebugBits Threads;
  61                 LIBPBD_API extern DebugBits Locale;
  62
  63                 /* See notes in ../debug.cc on why these are defined here */
  64
  65                 LIBPBD_API extern DebugBits WavesMIDI;
  66                 LIBPBD_API extern DebugBits WavesAudio;
  67         }
  68 }
  69
  70 #ifndef NDEBUG
  71 #define DEBUG_TRACE(bits,str) if (((bits) & PBD::debug_bits).any()) { PBD::debug_print (# bits, str); }
  72 #define DEBUG_STR_DECL(id) std::stringstream __debug_str ## id;
  73 #define DEBUG_STR(id) __debug_str ## id
  74 #define DEBUG_STR_APPEND(id,s) __debug_str ## id << s;
  75 #define DEBUG_ENABLED(bits) (((bits) & PBD::debug_bits).any())
  76 #ifdef PTW32_VERSION
  77 #define DEBUG_THREAD_SELF pthread_self().p
  78 #else
  79 #define DEBUG_THREAD_SELF pthread_self()
  80 #endif
  81
  82 #define DEBUG_TIMING_START(bits,td) if (DEBUG_ENABLED (bits)) { td.start_timing (); }
  83 #define DEBUG_TIMING_ADD_ELAPSED(bits,td) if (DEBUG_ENABLED (bits)) { td.add_elapsed (); }
  84 #define DEBUG_TIMING_RESET(bits,td) if (DEBUG_ENABLED (bits)) { td.reset (); }
  85
  86 #else
  87 #define DEBUG_TRACE(bits,fmt,...) /*empty*/
  88 #define DEBUG_STR(a) /* empty */
  89 #define DEBUG_STR_APPEND(a,b) /* empty */
  90 #define DEBUG_ENABLED(b) (0)
  91 #define DEBUG_THREAD_SELF 0
  92
  93 #define DEBUG_TIMING_START(bits,td) /*empty*/
  94 #define DEBUG_TIMING_ADD_ELAPSED(bits,td) /*empty*/
  95 #define DEBUG_TIMING_RESET(bits,td) /*empty*/
  96
  97 #endif
  98 #endif /* __libpbd_debug_h__ */
  99