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 unsigned char __wine_dbg_get_channel_flags( struct __wine_debug_channel *channel );
156 extern int __wine_dbg_set_channel_flags( struct __wine_debug_channel *channel,
157 unsigned char set, unsigned char clear );
158 extern void __wine_dbg_set_functions( const struct __wine_debug_functions *new_funcs,
159 struct __wine_debug_functions *old_funcs, size_t size );
160
161 /*
162 * Exported definitions and macros
163 */
164
165 /* These functions return a printable version of a string, including
166 quotes. The string will be valid for some time, but not indefinitely
167 as strings are re-used. */
168 extern const char *wine_dbgstr_an( const char * s, int n );
169 extern const char *wine_dbgstr_wn( const WCHAR *s, int n );
170 extern const char *wine_dbg_sprintf( const char *format, ... ) __WINE_PRINTF_ATTR(1,2);
171
172 extern int wine_dbg_printf( const char *format, ... ) __WINE_PRINTF_ATTR(1,2);
173 extern int wine_dbg_log( enum __wine_debug_class cls, struct __wine_debug_channel *ch, const char *func,
174 const char *format, ... ) __WINE_PRINTF_ATTR(4,5);
175
176 static inline const char *wine_dbgstr_a( const char *s )
177 {
178 return wine_dbgstr_an( s, -1 );
179 }
180
181 static inline const char *wine_dbgstr_w( const WCHAR *s )
182 {
183 return wine_dbgstr_wn( s, -1 );
184 }
185
186 static inline const char *wine_dbgstr_guid( const GUID *id )
187 {
188 if (!id) return "(null)";
189 if (!((ULONG_PTR)id >> 16)) return wine_dbg_sprintf( "<guid-0x%04hx>", (WORD)(ULONG_PTR)id );
190 return wine_dbg_sprintf( "{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
191 id->Data1, id->Data2, id->Data3,
192 id->Data4[0], id->Data4[1], id->Data4[2], id->Data4[3],
193 id->Data4[4], id->Data4[5], id->Data4[6], id->Data4[7] );
194 }
195
196 static inline const char *wine_dbgstr_point( const POINT *pt )
197 {
198 if (!pt) return "(null)";
199 return wine_dbg_sprintf( "(%d,%d)", pt->x, pt->y );
200 }
201
202 static inline const char *wine_dbgstr_size( const SIZE *size )
203 {
204 if (!size) return "(null)";
205 return wine_dbg_sprintf( "(%d,%d)", size->cx, size->cy );
206 }
207
208 static inline const char *wine_dbgstr_rect( const RECT *rect )
209 {
210 if (!rect) return "(null)";
211 return wine_dbg_sprintf( "(%d,%d)-(%d,%d)", rect->left, rect->top,
212 rect->right, rect->bottom );
213 }
214
215 static inline const char *wine_dbgstr_longlong( ULONGLONG ll )
216 {
217 if (sizeof(ll) > sizeof(unsigned long) && ll >> 32)
218 return wine_dbg_sprintf( "%lx%08lx", (unsigned long)(ll >> 32), (unsigned long)ll );
219 else return wine_dbg_sprintf( "%lx", (unsigned long)ll );
220 }
221
222 #ifndef WINE_TRACE
223 #define WINE_TRACE __WINE_DPRINTF(_TRACE,__wine_dbch___default)
224 #define WINE_TRACE_(ch) __WINE_DPRINTF(_TRACE,&__wine_dbch_##ch)
225 #endif
226 #define WINE_TRACE_ON(ch) __WINE_IS_DEBUG_ON(_TRACE,&__wine_dbch_##ch)
227
228 #ifndef WINE_WARN
229 #define WINE_WARN __WINE_DPRINTF(_WARN,__wine_dbch___default)
230 #define WINE_WARN_(ch) __WINE_DPRINTF(_WARN,&__wine_dbch_##ch)
231 #endif
232 #define WINE_WARN_ON(ch) __WINE_IS_DEBUG_ON(_WARN,&__wine_dbch_##ch)
233
234 #ifndef WINE_FIXME
235 #define WINE_FIXME __WINE_DPRINTF(_FIXME,__wine_dbch___default)
236 #define WINE_FIXME_(ch) __WINE_DPRINTF(_FIXME,&__wine_dbch_##ch)
237 #endif
238 #define WINE_FIXME_ON(ch) __WINE_IS_DEBUG_ON(_FIXME,&__wine_dbch_##ch)
239
240 #define WINE_ERR __WINE_DPRINTF(_ERR,__wine_dbch___default)
241 #define WINE_ERR_(ch) __WINE_DPRINTF(_ERR,&__wine_dbch_##ch)
242 #define WINE_ERR_ON(ch) __WINE_IS_DEBUG_ON(_ERR,&__wine_dbch_##ch)
243
244 #define WINE_DECLARE_DEBUG_CHANNEL(ch) \
245 static struct __wine_debug_channel __wine_dbch_##ch = { ~0, #ch }
246 #define WINE_DEFAULT_DEBUG_CHANNEL(ch) \
247 static struct __wine_debug_channel __wine_dbch_##ch = { ~0, #ch }; \
248 static struct __wine_debug_channel * const __wine_dbch___default = &__wine_dbch_##ch
249
250 #define WINE_DPRINTF wine_dbg_printf
251 #define WINE_MESSAGE wine_dbg_printf
252
253 #ifdef __WINESRC__
254 /* Wine uses shorter names that are very likely to conflict with other software */
255
256 static inline const char *debugstr_an( const char * s, int n ) { return wine_dbgstr_an( s, n ); }
257 static inline const char *debugstr_wn( const WCHAR *s, int n ) { return wine_dbgstr_wn( s, n ); }
258 static inline const char *debugstr_guid( const struct _GUID *id ) { return wine_dbgstr_guid(id); }
259 static inline const char *debugstr_a( const char *s ) { return wine_dbgstr_an( s, -1 ); }
260 static inline const char *debugstr_w( const WCHAR *s ) { return wine_dbgstr_wn( s, -1 ); }
261
262 #define TRACE WINE_TRACE
263 #define TRACE_(ch) WINE_TRACE_(ch)
264 #define TRACE_ON(ch) WINE_TRACE_ON(ch)
265
266 #define WARN WINE_WARN
267 #define WARN_(ch) WINE_WARN_(ch)
268 #define WARN_ON(ch) WINE_WARN_ON(ch)
269
270 #define FIXME WINE_FIXME
271 #define FIXME_(ch) WINE_FIXME_(ch)
272 #define FIXME_ON(ch) WINE_FIXME_ON(ch)
273
274 #undef ERR /* Solaris got an 'ERR' define in <sys/reg.h> */
275 #define ERR WINE_ERR
276 #define ERR_(ch) WINE_ERR_(ch)
277 #define ERR_ON(ch) WINE_ERR_ON(ch)
278
279 #define DPRINTF WINE_DPRINTF
280 #define MESSAGE WINE_MESSAGE
281
282 #endif /* __WINESRC__ */
283
284 #ifdef __cplusplus
285 }
286 #endif
287
288 #endif /* __WINE_WINE_DEBUG_H */
289
This page was automatically generated by the
LXR engine.
Visit the LXR main site for more
information.