include/wine/debug.h

   1 /*
   2  * Wine debugging interface
   3  *
   4  * Copyright 1999 Patrik Stridvall
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library 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 GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #ifndef __WINE_WINE_DEBUG_H
  22 #define __WINE_WINE_DEBUG_H
  23
  24 #include <stdarg.h>
  25 #include <windef.h>
  26 #ifndef GUID_DEFINED
  27 #include <guiddef.h>
  28 #endif
  29
  30 #ifdef __WINE_WINE_TEST_H
  31 #error This file should not be used in Wine tests
  32 #endif
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 struct _GUID;
  39
  40 /*
  41  * Internal definitions (do not use these directly)
  42  */
  43
  44 enum __wine_debug_class
  45 {
  46     __WINE_DBCL_FIXME,
  47     __WINE_DBCL_ERR,
  48     __WINE_DBCL_WARN,
  49     __WINE_DBCL_TRACE,
  50
  51     __WINE_DBCL_INIT = 7  /* lazy init flag */
  52 };
  53
  54 struct __wine_debug_channel
  55 {
  56     unsigned char flags;
  57     char name[15];
  58 };
  59
  60 #ifndef WINE_NO_TRACE_MSGS
  61 # define __WINE_GET_DEBUGGING_TRACE(dbch) ((dbch)->flags & (1 << __WINE_DBCL_TRACE))
  62 #else
  63 # define __WINE_GET_DEBUGGING_TRACE(dbch) 0
  64 #endif
  65
  66 #ifndef WINE_NO_DEBUG_MSGS
  67 # define __WINE_GET_DEBUGGING_WARN(dbch)  ((dbch)->flags & (1 << __WINE_DBCL_WARN))
  68 # define __WINE_GET_DEBUGGING_FIXME(dbch) ((dbch)->flags & (1 << __WINE_DBCL_FIXME))
  69 #else
  70 # define __WINE_GET_DEBUGGING_WARN(dbch)  0
  71 # define __WINE_GET_DEBUGGING_FIXME(dbch) 0
  72 #endif
  73
  74 /* define error macro regardless of what is configured */
  75 #define __WINE_GET_DEBUGGING_ERR(dbch)  ((dbch)->flags & (1 << __WINE_DBCL_ERR))
  76
  77 #define __WINE_GET_DEBUGGING(dbcl,dbch)  __WINE_GET_DEBUGGING##dbcl(dbch)
  78
  79 #define __WINE_IS_DEBUG_ON(dbcl,dbch) \
  80   (__WINE_GET_DEBUGGING##dbcl(dbch) && (__wine_dbg_get_channel_flags(dbch) & (1 << __WINE_DBCL##dbcl)))
  81
  82 #ifdef __GNUC__
  83
  84 #define __WINE_DPRINTF(dbcl,dbch) \
  85   do { if(__WINE_GET_DEBUGGING(dbcl,(dbch))) { \
  86        struct __wine_debug_channel * const __dbch = (dbch); \
  87        const enum __wine_debug_class __dbcl = __WINE_DBCL##dbcl; \
  88        __WINE_DBG_LOG
  89
  90 #define __WINE_DBG_LOG(args...) \
  91     wine_dbg_log( __dbcl, __dbch, __FUNCTION__, args); } } while(0)
  92
  93 #define __WINE_PRINTF_ATTR(fmt,args) __attribute__((format (printf,fmt,args)))
  94
  95
  96 #ifdef WINE_NO_TRACE_MSGS
  97 #define WINE_TRACE(args...) do { } while(0)
  98 #define WINE_TRACE_(ch) WINE_TRACE
  99 #endif
 100
 101 #ifdef WINE_NO_DEBUG_MSGS
 102 #define WINE_WARN(args...) do { } while(0)
 103 #define WINE_WARN_(ch) WINE_WARN
 104 #define WINE_FIXME(args...) do { } while(0)
 105 #define WINE_FIXME_(ch) WINE_FIXME
 106 #endif
 107
 108 #elif defined(__SUNPRO_C)
 109
 110 #define __WINE_DPRINTF(dbcl,dbch) \
 111   do { if(__WINE_GET_DEBUGGING(dbcl,(dbch))) { \
 112        struct __wine_debug_channel * const __dbch = (dbch); \
 113        const enum __WINE_DEBUG_CLASS __dbcl = __WINE_DBCL##dbcl; \
 114        __WINE_DBG_LOG
 115
 116 #define __WINE_DBG_LOG(...) \
 117    wine_dbg_log( __dbcl, __dbch, __func__, __VA_ARGS__); } } while(0)
 118
 119 #define __WINE_PRINTF_ATTR(fmt,args)
 120
 121 #ifdef WINE_NO_TRACE_MSGS
 122 #define WINE_TRACE(...) do { } while(0)
 123 #define WINE_TRACE_(ch) WINE_TRACE
 124 #endif
 125
 126 #ifdef WINE_NO_DEBUG_MSGS
 127 #define WINE_WARN(...) do { } while(0)
 128 #define WINE_WARN_(ch) WINE_WARN
 129 #define WINE_FIXME(...) do { } while(0)
 130 #define WINE_FIXME_(ch) WINE_FIXME
 131 #endif
 132
 133 #else  /* !__GNUC__ && !__SUNPRO_C */
 134
 135 #define __WINE_DPRINTF(dbcl,dbch) \
 136     (!__WINE_GET_DEBUGGING(dbcl,(dbch)) || \
 137      (wine_dbg_log(__WINE_DBCL##dbcl,(dbch),__FILE__,"%d: ",__LINE__) == -1)) ? \
 138      (void)0 : (void)wine_dbg_printf
 139
 140 #define __WINE_PRINTF_ATTR(fmt, args)
 141
 142 #endif  /* !__GNUC__ && !__SUNPRO_C */
 143
 144 struct __wine_debug_functions
 145 {
 146     char * (*get_temp_buffer)( size_t n );
 147     void   (*release_temp_buffer)( char *buffer, size_t n );
 148     const char * (*dbgstr_an)( const char * s, int n );
 149     const char * (*dbgstr_wn)( const WCHAR *s, int n );
 150     int (*dbg_vprintf)( const char *format, va_list args );
 151     int (*dbg_vlog)( enum __wine_debug_class cls, struct __wine_debug_channel *channel,
 152                      const char *function, const char *format, va_list args );
 153 };
 154
 155 extern void __wine_dbg_toggle_block(void);
 156 extern unsigned char __wine_dbg_get_channel_flags( struct __wine_debug_channel *channel );
 157 extern int __wine_dbg_set_channel_flags( struct __wine_debug_channel *channel,
 158                                          unsigned char set, unsigned char clear );
 159 extern void __wine_dbg_set_functions( const struct __wine_debug_functions *new_funcs,
 160                                       struct __wine_debug_functions *old_funcs, size_t size );
 161
 162 /*
 163  * Exported definitions and macros
 164  */
 165
 166 /* These functions return a printable version of a string, including
 167    quotes.  The string will be valid for some time, but not indefinitely
 168    as strings are re-used.  */
 169 extern const char *wine_dbgstr_an( const char * s, int n );
 170 extern const char *wine_dbgstr_wn( const WCHAR *s, int n );
 171 extern const char *wine_dbg_sprintf( const char *format, ... ) __WINE_PRINTF_ATTR(1,2);
 172
 173 extern int wine_dbg_printf( const char *format, ... ) __WINE_PRINTF_ATTR(1,2);
 174 extern int wine_dbg_log( enum __wine_debug_class cls, struct __wine_debug_channel *ch, const char *func,
 175                          const char *format, ... ) __WINE_PRINTF_ATTR(4,5);
 176
 177 static inline const char *wine_dbgstr_a( const char *s )
 178 {
 179     return wine_dbgstr_an( s, -1 );
 180 }
 181
 182 static inline const char *wine_dbgstr_w( const WCHAR *s )
 183 {
 184     return wine_dbgstr_wn( s, -1 );
 185 }
 186
 187 static inline const char *wine_dbgstr_guid( const GUID *id )
 188 {
 189     if (!id) return "(null)";
 190     if (!((ULONG_PTR)id >> 16)) return wine_dbg_sprintf( "<guid-0x%04hx>", (WORD)(ULONG_PTR)id );
 191     return wine_dbg_sprintf( "{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
 192                              id->Data1, id->Data2, id->Data3,
 193                              id->Data4[0], id->Data4[1], id->Data4[2], id->Data4[3],
 194                              id->Data4[4], id->Data4[5], id->Data4[6], id->Data4[7] );
 195 }
 196
 197 static inline const char *wine_dbgstr_point( const POINT *pt )
 198 {
 199     if (!pt) return "(null)";
 200     return wine_dbg_sprintf( "(%d,%d)", pt->x, pt->y );
 201 }
 202
 203 static inline const char *wine_dbgstr_size( const SIZE *size )
 204 {
 205     if (!size) return "(null)";
 206     return wine_dbg_sprintf( "(%d,%d)", size->cx, size->cy );
 207 }
 208
 209 static inline const char *wine_dbgstr_rect( const RECT *rect )
 210 {
 211     if (!rect) return "(null)";
 212     return wine_dbg_sprintf( "(%d,%d)-(%d,%d)", rect->left, rect->top,
 213                              rect->right, rect->bottom );
 214 }
 215
 216 static inline const char *wine_dbgstr_longlong( ULONGLONG ll )
 217 {
 218     if (sizeof(ll) > sizeof(unsigned long) && ll >> 32)
 219         return wine_dbg_sprintf( "%lx%08lx", (unsigned long)(ll >> 32), (unsigned long)ll );
 220     else return wine_dbg_sprintf( "%lx", (unsigned long)ll );
 221 }
 222
 223 #ifndef WINE_TRACE
 224 #define WINE_TRACE                 __WINE_DPRINTF(_TRACE,__wine_dbch___default)
 225 #define WINE_TRACE_(ch)            __WINE_DPRINTF(_TRACE,&__wine_dbch_##ch)
 226 #endif
 227 #define WINE_TRACE_ON(ch)          __WINE_IS_DEBUG_ON(_TRACE,&__wine_dbch_##ch)
 228
 229 #ifndef WINE_WARN
 230 #define WINE_WARN                  __WINE_DPRINTF(_WARN,__wine_dbch___default)
 231 #define WINE_WARN_(ch)             __WINE_DPRINTF(_WARN,&__wine_dbch_##ch)
 232 #endif
 233 #define WINE_WARN_ON(ch)           __WINE_IS_DEBUG_ON(_WARN,&__wine_dbch_##ch)
 234
 235 #ifndef WINE_FIXME
 236 #define WINE_FIXME                 __WINE_DPRINTF(_FIXME,__wine_dbch___default)
 237 #define WINE_FIXME_(ch)            __WINE_DPRINTF(_FIXME,&__wine_dbch_##ch)
 238 #endif
 239 #define WINE_FIXME_ON(ch)          __WINE_IS_DEBUG_ON(_FIXME,&__wine_dbch_##ch)
 240
 241 #define WINE_ERR                   __WINE_DPRINTF(_ERR,__wine_dbch___default)
 242 #define WINE_ERR_(ch)              __WINE_DPRINTF(_ERR,&__wine_dbch_##ch)
 243 #define WINE_ERR_ON(ch)            __WINE_IS_DEBUG_ON(_ERR,&__wine_dbch_##ch)
 244
 245 #define WINE_DECLARE_DEBUG_CHANNEL(ch) \
 246     static struct __wine_debug_channel __wine_dbch_##ch = { ~0, #ch }
 247 #define WINE_DEFAULT_DEBUG_CHANNEL(ch) \
 248     static struct __wine_debug_channel __wine_dbch_##ch = { ~0, #ch }; \
 249     static struct __wine_debug_channel * const __wine_dbch___default = &__wine_dbch_##ch
 250
 251 #define WINE_DPRINTF               wine_dbg_printf
 252 #define WINE_MESSAGE               wine_dbg_printf
 253
 254 #ifdef __WINESRC__
 255 /* Wine uses shorter names that are very likely to conflict with other software */
 256
 257 static inline const char *debugstr_an( const char * s, int n ) { return wine_dbgstr_an( s, n ); }
 258 static inline const char *debugstr_wn( const WCHAR *s, int n ) { return wine_dbgstr_wn( s, n ); }
 259 static inline const char *debugstr_guid( const struct _GUID *id ) { return wine_dbgstr_guid(id); }
 260 static inline const char *debugstr_a( const char *s )  { return wine_dbgstr_an( s, -1 ); }
 261 static inline const char *debugstr_w( const WCHAR *s ) { return wine_dbgstr_wn( s, -1 ); }
 262
 263 #define TRACE                      WINE_TRACE
 264 #define TRACE_(ch)                 WINE_TRACE_(ch)
 265 #define TRACE_ON(ch)               WINE_TRACE_ON(ch)
 266
 267 #define WARN                       WINE_WARN
 268 #define WARN_(ch)                  WINE_WARN_(ch)
 269 #define WARN_ON(ch)                WINE_WARN_ON(ch)
 270
 271 #define FIXME                      WINE_FIXME
 272 #define FIXME_(ch)                 WINE_FIXME_(ch)
 273 #define FIXME_ON(ch)               WINE_FIXME_ON(ch)
 274
 275 #undef ERR  /* Solaris got an 'ERR' define in <sys/reg.h> */
 276 #define ERR                        WINE_ERR
 277 #define ERR_(ch)                   WINE_ERR_(ch)
 278 #define ERR_ON(ch)                 WINE_ERR_ON(ch)
 279
 280 #define DPRINTF                    WINE_DPRINTF
 281 #define MESSAGE                    WINE_MESSAGE
 282
 283 #endif /* __WINESRC__ */
 284
 285 #ifdef __cplusplus
 286 }
 287 #endif
 288
 289 #endif  /* __WINE_WINE_DEBUG_H */