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 <stdint.h>
  24
  25 #include <sstream>
  26
  27 #include "pbd/libpbd_visibility.h"
  28
  29 namespace PBD {
  30
  31         LIBPBD_API extern uint64_t debug_bits;
  32         LIBPBD_API uint64_t new_debug_bit (const char* name);
  33         LIBPBD_API void debug_print (const char* prefix, std::string str);
  34         LIBPBD_API void set_debug_bits (uint64_t bits);
  35         LIBPBD_API int parse_debug_options (const char* str);
  36         LIBPBD_API void list_debug_options ();
  37
  38         namespace DEBUG {
  39
  40                 /* this namespace is so that we can write DEBUG::bit_name */
  41
  42                 LIBPBD_API extern uint64_t Stateful;
  43                 LIBPBD_API extern uint64_t Properties;
  44                 LIBPBD_API extern uint64_t FileManager;
  45                 LIBPBD_API extern uint64_t Pool;
  46                 LIBPBD_API extern uint64_t EventLoop;
  47                 LIBPBD_API extern uint64_t AbstractUI;
  48                 extern uint64_t FileUtils;
  49         }
  50 }
  51
  52 #ifndef NDEBUG
  53 #define DEBUG_TRACE(bits,str) if ((bits) & PBD::debug_bits) { PBD::debug_print (# bits, str); }
  54 #define DEBUG_STR_DECL(id) std::stringstream __debug_str ## id;
  55 #define DEBUG_STR(id) __debug_str ## id
  56 #define DEBUG_STR_APPEND(id,s) __debug_str ## id << s;
  57 #define DEBUG_ENABLED(bits) ((bits) & PBD::debug_bits)
  58 #define DEBUG_THREAD_SELF 0
  59 #else
  60 #define DEBUG_TRACE(bits,fmt,...) /*empty*/
  61 #define DEBUG_STR(a) /* empty */
  62 #define DEBUG_STR_APPEND(a,b) /* empty */
  63 #define DEBUG_ENABLED(b) (0)
  64 #ifdef PTW32_VERSION
  65 #define DEBUG_THREAD_SELF pthread_self().p
  66 #else
  67 #define DEBUG_THREAD_SELF pthread_self()
  68 #endif
  69 #endif
  70 #endif /* __libpbd_debug_h__ */
  71