libs/pbd/pbd/debug.h

Go to the documentation of this file.

/*
 * Copyright (C) 2010-2011 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2010-2015 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2013-2015 John Emmas <john@creativepost.co.uk>
 * Copyright (C) 2014-2015 Tim Mayberry <mojofunk@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <bitset>
#include <stdint.h>
 
#include <sstream>
 
#include "pbd/libpbd_visibility.h"
#include "pbd/timing.h"
 
/* check for PTW32_VERSION */
#ifdef COMPILER_MSVC
#include <ardourext/pthread.h>
#else
#include <pthread.h>
#endif
 
namespace PBD {
 
        typedef std::bitset<256> DebugBits;
 
        LIBPBD_API extern DebugBits debug_bits;
        LIBPBD_API DebugBits new_debug_bit (const char* name);
        LIBPBD_API void debug_print (const char* prefix, std::string str);
        LIBPBD_API void debug_only_print (const char* prefix, std::string str);
        LIBPBD_API void set_debug_bits (DebugBits bits);
        LIBPBD_API int parse_debug_options (const char* str);
        LIBPBD_API void list_debug_options ();
 
        namespace DEBUG {
 
                /* this namespace is so that we can write DEBUG::bit_name */
 
                LIBPBD_API extern DebugBits Stateful;
                LIBPBD_API extern DebugBits Properties;
                LIBPBD_API extern DebugBits FileManager;
                LIBPBD_API extern DebugBits Pool;
                LIBPBD_API extern DebugBits EventLoop;
                LIBPBD_API extern DebugBits AbstractUI;
                LIBPBD_API extern DebugBits Configuration;
                LIBPBD_API extern DebugBits FileUtils;
                LIBPBD_API extern DebugBits UndoHistory;
                LIBPBD_API extern DebugBits Timing;
                LIBPBD_API extern DebugBits Threads;
                LIBPBD_API extern DebugBits ThreadName;
                LIBPBD_API extern DebugBits Locale;
                LIBPBD_API extern DebugBits StringConvert;
                LIBPBD_API extern DebugBits DebugTimestamps;
                LIBPBD_API extern DebugBits DebugLogToGUI;
 
                /* See notes in ../debug.cc on why these are defined here */
 
                LIBPBD_API extern DebugBits WavesMIDI;
                LIBPBD_API extern DebugBits WavesAudio;
        }
}
 
#ifndef NDEBUG
 
#define DEBUG_TRACE(bits,str) if (((bits) & PBD::debug_bits).any()) { PBD::debug_print (# bits, str); }
#define DEBUG_STR_DECL(id) std::stringstream __debug_str ## id;
#define DEBUG_STR(id) __debug_str ## id
#define DEBUG_STR_APPEND(id,s) __debug_str ## id << s;
#define DEBUG_ENABLED(bits) (((bits) & PBD::debug_bits).any())
#ifdef PTW32_VERSION
#define DEBUG_THREAD_SELF pthread_self().p
#define DEBUG_THREAD_PRINT(t) t.p
#else
#define DEBUG_THREAD_SELF pthread_self()
#define DEBUG_THREAD_PRINT(t) t
#endif
 
#define DEBUG_TIMING_START(bits,td) if (DEBUG_ENABLED (bits)) { td.start_timing (); }
#define DEBUG_TIMING_ADD_ELAPSED(bits,td) if (DEBUG_ENABLED (bits)) { td.add_elapsed (); }
#define DEBUG_TIMING_RESET(bits,td) if (DEBUG_ENABLED (bits)) { td.reset (); }
 
#define DEBUG_RESULT(type,var,...) type var = __VA_ARGS__
#define DEBUG_RESULT_CAST(type,var,cast_expr,...) type var = cast_expr __VA_ARGS__
#define DEBUG_ASSIGN(var,expr) var = expr
 
#else
 
 
#define DEBUG_TRACE(bits,fmt,...) /*empty*/
#define DEBUG_STR(a) /* empty */
#define DEBUG_STR_APPEND(a,b) /* empty */
#define DEBUG_ENABLED(b) (0)
#define DEBUG_THREAD_SELF 0
 
#define DEBUG_TIMING_START(bits,td) /*empty*/
#define DEBUG_TIMING_ADD_ELAPSED(bits,td) /*empty*/
#define DEBUG_TIMING_RESET(bits,td) /*empty*/
 
#define DEBUG_RESULT(type,var,...) __VA_ARGS__
#define DEBUG_RESULT_CAST(type,var,cast_expr,...) __VA_ARGS__
#define DEBUG_ASSIGN(var,expr)
#endif