src/debug.h

   1 /*
   2  * Copyright (C) 2008 - 2016 The Geeqie Team
   3  *
   4  * Authors: Vladimir Nadvornik, Laurent Monin
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21 #ifndef _DEBUG_H
  22 #define _DEBUG_H
  23
  24 #include <glib.h>
  25
  26 #define DOMAIN_DEBUG "debug"
  27 #define DOMAIN_INFO  "info"
  28
  29 void log_domain_printf(const gchar *domain, const gchar *format, ...) G_GNUC_PRINTF(2, 3);
  30 void log_domain_print_debug(const gchar *domain, const gchar *file_name, const gchar *function_name,
  31                                                         int line_number, const gchar *format, ...) G_GNUC_PRINTF(5, 6);
  32 void log_print_file_data_dump(const gchar *file, const gchar *function_name, gint line_number);
  33 void log_print_backtrace(const gchar *file, const gchar *function_name, gint line_number);
  34
  35 #define log_printf(...) log_domain_printf(DOMAIN_INFO, __VA_ARGS__)
  36
  37 #ifdef DEBUG
  38
  39 #define DEBUG_LEVEL_MIN 0
  40 #define DEBUG_LEVEL_MAX 4
  41
  42 void set_regexp(const gchar *regexp);
  43 gchar *get_regexp();
  44 gint get_debug_level();
  45 void set_debug_level(gint new_level);
  46 void debug_level_add(gint delta);
  47 gint required_debug_level(gint level);
  48 const gchar *get_exec_time();
  49 void init_exec_time();
  50
  51 #define DEBUG_N(n, ...) do \
  52                                 { \
  53                                 gint debug_level = get_debug_level(); \
  54                                 if (debug_level >= (n))         \
  55                                         {               \
  56                                         if (debug_level != 1) \
  57                                                 { \
  58                                                 log_domain_print_debug(DOMAIN_DEBUG, __FILE__, __func__, __LINE__, __VA_ARGS__); \
  59                                                 } \
  60                                         else \
  61                                                 { \
  62                                                 log_domain_printf(DOMAIN_DEBUG, __VA_ARGS__); \
  63                                                 } \
  64                                         } \
  65                                 } while (0)
  66
  67 /**
  68  * @brief For use with the GTKInspector (>GTK 3.14)
  69  *
  70  * To simplify finding where objects are declared
  71  * Sample command line call:
  72  * GTK_DEBUG=interactive src/geeqie
  73  */
  74 #define DEBUG_NAME(widget) do \
  75                                 { \
  76                                 gtk_widget_set_name(GTK_WIDGET(widget), g_strdup_printf("%s:%d", __FILE__, __LINE__)); \
  77                                 } while(0)
  78
  79 #define DEBUG_BT() do \
  80                                 { \
  81                                 log_print_backtrace(__FILE__, __func__, __LINE__); \
  82                                 } while(0)
  83
  84 #define DEBUG_FD() do \
  85                                 { \
  86                                 log_print_file_data_dump(__FILE__, __func__, __LINE__); \
  87                                 } while(0)
  88 #else /* DEBUG */
  89
  90 #define get_regexp() (0)
  91 #define set_regexp(regexp) do { } while(0)
  92 #define get_debug_level() (0)
  93 #define set_debug_level(new_level) do { } while(0)
  94 #define debug_level_add(delta) do { } while(0)
  95 #define required_debug_level(level) (0)
  96 #define get_exec_time() ""
  97 #define init_exec_time() do { } while(0)
  98
  99 #define DEBUG_N(n, ...)  do { } while(0)
 100
 101 #define DEBUG_NAME(widget) do { } while(0)
 102 #define DEBUG_BT() do { } while(0)
 103 #define DEBUG_FD() do { } while(0)
 104
 105 #endif /* DEBUG */
 106
 107 #define DEBUG_0(...) DEBUG_N(0, __VA_ARGS__)
 108 #define DEBUG_1(...) DEBUG_N(1, __VA_ARGS__)
 109 #define DEBUG_2(...) DEBUG_N(2, __VA_ARGS__)
 110 #define DEBUG_3(...) DEBUG_N(3, __VA_ARGS__)
 111 #define DEBUG_4(...) DEBUG_N(4, __VA_ARGS__)
 112
 113
 114 #endif /* _DEBUG_H */
 115 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */