git.maemo.org Git - modest/blob - src/modest-debug.h

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef __MODEST_DEBUG_H__
  31 #define __MODEST_DEBUG_H__
  32
  33 #include "modest-runtime.h"
  34
  35 /* some debugging macros */
  36
  37 /**
  38  * MODEST_RUNTIME_VERIFY_OBJECT_LAST_REF:
  39  * @OBJ: some (GObject) ptr
  40  * @NAME: name of @OBJ
  41  *
  42  * macro to check whether @obj holds only one more ref (ie. after the
  43  * next unref it will die)
  44  *
  45  * not, a g_warning will be issued on stderr. NOTE: this is only active
  46  * when MODEST_DEBUG contains "debug-objects".
  47  *
  48  ***/
  49 #define MODEST_DEBUG_VERIFY_OBJECT_LAST_REF(OBJ,name)                                                  \
  50         do {                                                                                           \
  51                 if (modest_runtime_get_debug_flags() & MODEST_RUNTIME_DEBUG_OBJECTS)                   \
  52                         if (G_IS_OBJECT(OBJ) && G_OBJECT(OBJ)->ref_count != 1)                         \
  53                                 g_warning ("%s:%d: %s ("                                               \
  54                                            #OBJ ") still holds a ref count of %d",                     \
  55                                            __FILE__,__LINE__,name, G_OBJECT(OBJ)->ref_count);          \
  56         } while (0)
  57
  58
  59
  60
  61 /**
  62  * MODEST_DEBUG_BLOCK:
  63  * @BLOCK: some block of code
  64  *
  65  * macro to which run its argument (block) only when MODEST_DEBUG contains "debug-code"
  66  *
  67  ***/
  68 #define MODEST_DEBUG_BLOCK(BLOCK)                                                                      \
  69         do {                                                                                           \
  70                 if (modest_runtime_get_debug_flags() & MODEST_RUNTIME_DEBUG_CODE)   {                  \
  71                         BLOCK                                                                          \
  72                 }                                                                                      \
  73         } while (0)
  74
  75
  76 /**
  77  * MODEST_DEBUG_NOT_IMPLEMENTED:
  78  * @WIN: the parent GtkWindow, or NULL
  79  *
  80  * give a not-implemented-yet warning popup or g_warning
  81  *
  82  ***/
  83 #define MODEST_DEBUG_NOT_IMPLEMENTED(WIN)    \
  84         do {                                   \
  85                 if (gtk_main_level() > 0) {    \
  86                         GtkWidget *popup;      \
  87                         popup = gtk_message_dialog_new (WIN,\
  88                                                         GTK_DIALOG_MODAL|GTK_DIALOG_DESTROY_WITH_PARENT,\
  89                                                         GTK_MESSAGE_WARNING, \
  90                                                         GTK_BUTTONS_OK, \
  91                                                         "Not yet implemented");\
  92                         gtk_dialog_run (GTK_DIALOG(popup));             \
  93                         gtk_widget_destroy (popup);                     \
  94                 } else                                                  \
  95                         g_warning ("%s:%d: Not yet implemented",__FILE__,__LINE__); \
  96         } while (0)                                                     \
  97
  98
  99 #endif /*__MODEST_DEBUG_H__*/