source: trunk/include/win/debugtools.h@ 8810

Last change on this file since 8810 was 8810, checked in by sandervl, 23 years ago

fix for MESSAGE and DPRINTF debug logging macros (release build)

File size: 8.5 KB
Line 
1
2#ifndef __WINE_DEBUGTOOLS_H
3#define __WINE_DEBUGTOOLS_H
4
5#ifdef __WIN32OS2__
6#include <odinwrap.h>
7#include <odin.h>
8
9#ifndef __MISC_H__
10
11#ifdef DEBUG
12#ifdef PRIVATE_LOGGING
13 //To use private dll logging, define PRIVATE_LOGGING and
14 //add Open/ClosePrivateLogFiles (see below) functions to the dll
15 //to open close the private logfile. The logfile handle should
16 //be stored in the _privateLogFile variable
17 //dprintf can be called like this:
18 //dprintf((LOG, "PE file : %s", szFileName));
19 #define LOG (void*)_privateLogFile
20 #define dprintf(a) WritePrivateLog a
21 #define dprintfGlobal(a) WriteLog a
22#else
23 #define dprintf(a) WriteLog a
24#endif
25 #define eprintf(a) WriteLog a ; WriteLogError a
26 #define dassert(a, b) if(!(a)) WriteLogError b
27 #define dbgCheckObj(a) a->checkObject()
28
29#ifdef DEBUG_ENABLELOG_LEVEL2
30#ifdef PRIVATE_LOGGING
31 #define dprintf2(a) WritePrivateLog a
32#else
33 #define dprintf2(a) WriteLog a
34#endif
35#else
36 #define dprintf2(a)
37#endif
38
39#else
40 #define dprintfGlobal(a)
41 #define dprintf(a)
42 #define dprintf2(a)
43 #define eprintf(a)
44 #define dassert(a, b)
45 #define dbgCheckObj(a)
46#endif
47
48int SYSTEM WriteLog(char *tekst, ...);
49int SYSTEM WritePrivateLog(void *logfile, char *tekst, ...);
50int SYSTEM WriteLogError(char *tekst, ...);
51
52void SYSTEM DecreaseLogCount();
53void SYSTEM IncreaseLogCount();
54
55#endif //__MISC_H__
56
57#endif
58
59#ifdef __WINE__ /* Debugging interface is internal to Wine */
60
61#include <stdio.h>
62#include "config.h"
63#include "debugstr.h"
64
65#define DEBUG_RUNTIME
66
67/* Internal definitions (do not use these directly) */
68
69enum __DEBUG_CLASS { __DBCL_FIXME, __DBCL_ERR, __DBCL_WARN, __DBCL_TRACE, __DBCL_COUNT };
70
71extern char __debug_msg_enabled[][__DBCL_COUNT];
72
73extern const char * const debug_cl_name[__DBCL_COUNT];
74extern const char * const debug_ch_name[];
75
76#define __GET_DEBUGGING(dbcl,dbch) (__debug_msg_enabled[(dbch)][(dbcl)])
77#define __SET_DEBUGGING(dbcl,dbch,on) (__debug_msg_enabled[(dbch)][(dbcl)] = (on))
78
79#define __DPRINTF(dbcl,dbch) \
80 (!__GET_DEBUGGING(dbcl,dbch) || \
81 (dprintf(("%s:%s:%s ", debug_cl_name[(dbcl)], debug_ch_name[(dbch)], __line__)),0)) \
82 ? 0 : WriteLog
83
84#define __DUMMY_DPRINTF 1 ? (void)0 : (void)((int (*)(char *, ...)) NULL)
85
86
87/* Exported definitions and macros */
88
89/* use configure to allow user to compile out debugging messages */
90#ifndef NO_TRACE_MSGS
91#define TRACE __DPRINTF(__DBCL_TRACE,*DBCH_DEFAULT)
92#define TRACE_(ch) __DPRINTF(__DBCL_TRACE,dbch_##ch)
93#define TRACE_ON(ch) __GET_DEBUGGING(__DBCL_TRACE,dbch_##ch)
94#else
95#define TRACE __DUMMY_DPRINTF
96#define TRACE_(ch) __DUMMY_DPRINTF
97#define TRACE_ON(ch) 0
98#endif /* NO_TRACE_MSGS */
99
100#ifndef NO_DEBUG_MSGS
101#define WARN __DPRINTF(__DBCL_WARN,*DBCH_DEFAULT)
102#define WARN_(ch) __DPRINTF(__DBCL_WARN,dbch_##ch)
103#define WARN_ON(ch) __GET_DEBUGGING(__DBCL_WARN,dbch_##ch)
104#define FIXME __DPRINTF(__DBCL_FIXME,*DBCH_DEFAULT)
105#define FIXME_(ch) __DPRINTF(__DBCL_FIXME,dbch_##ch)
106#define FIXME_ON(ch) __GET_DEBUGGING(__DBCL_FIXME,dbch_##ch)
107#else
108#define WARN __DUMMY_DPRINTF
109#define WARN_(ch) __DUMMY_DPRINTF
110#define WARN_ON(ch) 0
111#define FIXME __DUMMY_DPRINTF
112#define FIXME_(ch) __DUMMY_DPRINTF
113#define FIXME_ON(ch) 0
114#endif /* NO_DEBUG_MSGS */
115
116/* define error macro regardless of what is configured */
117/* Solaris got an 'ERR' define in <sys/reg.h> */
118#undef ERR
119#define ERR __DPRINTF(__DBCL_ERR,*DBCH_DEFAULT)
120#define ERR_(ch) __DPRINTF(__DBCL_ERR,dbch_##ch)
121#define ERR_ON(ch) __GET_DEBUGGING(__DBCL_ERR,dbch_##ch)
122
123#define DECLARE_DEBUG_CHANNEL(ch) \
124 extern const int dbch_##ch;
125#define DEFAULT_DEBUG_CHANNEL(ch) \
126 static const int *const DBCH_DEFAULT = &dbch_##ch;
127
128#define WINE_DECLARE_DEBUG_CHANNEL(ch) DECLARE_DEBUG_CHANNEL(ch)
129#define WINE_DEFAULT_DEBUG_CHANNEL(ch) DEFAULT_DEBUG_CHANNEL(ch)
130
131#define DPRINTF dbg_printf
132#define MESSAGE dbg_printf
133
134#endif /* __WINE__ */
135
136#ifdef __WIN32OS2__
137# undef DECLARE_DEBUG_CHANNEL
138# define DECLARE_DEBUG_CHANNEL ODINDEBUGCHANNEL
139# undef DEFAULT_DEBUG_CHANNEL
140# define DEFAULT_DEBUG_CHANNEL ODINDEBUGCHANNEL1
141# undef TRACE
142# undef TRACE_
143# undef TRACE_ON
144# define TRACE_ON(ch) 0
145# undef FIXME
146# undef FIXME_
147# undef FIXME_ON
148# define FIXME_ON(ch) 0
149# undef WARN
150# undef WARN_
151# undef WARN_ON
152# define WARN_ON(ch) 0
153# undef ERR
154# undef ERR_
155# undef ERR_ON
156# define ERR_ON(ch) 0
157# undef DPRINTF
158# undef MESSAGE
159#ifdef DEBUG
160# define TRACE WriteLog
161# define TRACE_(ch) WriteLog
162# define FIXME WriteLog
163# define FIXME_(ch) WriteLog
164# define WARN WriteLog
165# define WARN_(ch) WriteLog
166# define ERR_(ch) WriteLog
167# define ERR WriteLog
168# define DPRINTF WriteLog
169# define MESSAGE WriteLog
170#else
171# define TRACE 1 ? (void)0 : (void)((int (*)(char *, ...)) NULL)
172# define TRACE_(ch) 1 ? (void)0 : (void)((int (*)(char *, ...)) NULL)
173# define FIXME 1 ? (void)0 : (void)((int (*)(char *, ...)) NULL)
174# define FIXME_(ch) 1 ? (void)0 : (void)((int (*)(char *, ...)) NULL)
175# define WARN 1 ? (void)0 : (void)((int (*)(char *, ...)) NULL)
176# define WARN_(ch) 1 ? (void)0 : (void)((int (*)(char *, ...)) NULL)
177# define ERR_(ch) 1 ? (void)0 : (void)((int (*)(char *, ...)) NULL)
178# define ERR 1 ? (void)0 : (void)((int (*)(char *, ...)) NULL)
179# define DPRINTF 1 ? (void)0 : (void)((int (*)(char *, ...)) NULL)
180# define MESSAGE 1 ? (void)0 : (void)((int (*)(char *, ...)) NULL)
181#endif
182#undef __GET_DEBUGGING
183#define __GET_DEBUGGING(dbcl,dbch)
184#undef __SET_DEBUGGING
185#define __SET_DEBUGGING(dbcl,dbch,on)
186
187#undef DPRINTF
188#define DPRINTF WriteLog
189#undef MESSAGE
190#define MESSAGE WriteLog
191
192#endif
193
194#ifdef DEBUG
195#ifdef __cplusplus
196extern "C" {
197#endif
198
199//LPCSTR debugstr_guid1( void *id );
200////#define debugstr_guid(a) debugstr_guid1((void *)a)
201//#define debugstr_guid(a) 0
202
203#ifndef GUID_DEFINED
204#define GUID_DEFINED
205typedef struct _GUID
206{
207 unsigned long Data1;
208 unsigned short Data2;
209 unsigned short Data3;
210 unsigned char Data4[8];
211} GUID;
212#endif
213
214static char *debugstr_guid( const GUID *id )
215{
216 static char temp[64];
217 char *str;
218
219 if (!id) return "(null)";
220 if (!HIWORD(id))
221 {
222 sprintf( temp, "<guid-0x%04x>", LOWORD(id) );
223 }
224 else
225 {
226 sprintf( temp, "{%08lx-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
227 id->Data1, id->Data2, id->Data3,
228 id->Data4[0], id->Data4[1], id->Data4[2], id->Data4[3],
229 id->Data4[4], id->Data4[5], id->Data4[6], id->Data4[7] );
230 }
231 return temp;
232}
233
234#ifdef __cplusplus
235}
236#endif
237
238static LPCSTR debugstr_an (LPCSTR src, int n)
239{
240 LPSTR dst;
241 static char res[128];
242
243 if (!HIWORD(src))
244 {
245 if (!src) return "(null)";
246 sprintf(res, "#%04x", LOWORD(src) );
247 return res;
248 }
249 if (n > sizeof(res)) return "(null)";
250
251 if (n < 0) n = 0;
252 dst = res;
253 *dst++ = '"';
254 while (n-- > 0 && *src)
255 {
256 BYTE c = *src++;
257 switch (c)
258 {
259 case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
260 case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
261 case '\t': *dst++ = '\\'; *dst++ = 't'; break;
262 case '"': *dst++ = '\\'; *dst++ = '"'; break;
263 case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
264 default:
265 if (c >= ' ' && c <= 126)
266 *dst++ = c;
267 else
268 {
269 *dst++ = '\\';
270 *dst++ = '0' + ((c >> 6) & 7);
271 *dst++ = '0' + ((c >> 3) & 7);
272 *dst++ = '0' + ((c >> 0) & 7);
273 }
274 }
275 }
276 *dst++ = '"';
277 if (*src)
278 {
279 *dst++ = '.';
280 *dst++ = '.';
281 *dst++ = '.';
282 }
283 *dst++ = '\0';
284 return res;
285}
286
287/* ---------------------------------------------------------------------- */
288
289static LPCSTR debugstr_wn (LPCWSTR src, int n)
290{
291 LPSTR dst;
292 static char res[128];
293
294 if (!HIWORD(src))
295 {
296 if (!src) return "(null)";
297 sprintf(res, "#%04x", LOWORD(src) );
298 return res;
299 }
300 if (n > sizeof(res)) return "(null)";
301 if (n < 0) n = 0;
302
303 dst = res;
304 *dst++ = 'L';
305 *dst++ = '"';
306 while (n-- > 0 && *src)
307 {
308 WORD c = *src++;
309 switch (c)
310 {
311 case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
312 case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
313 case '\t': *dst++ = '\\'; *dst++ = 't'; break;
314 case '"': *dst++ = '\\'; *dst++ = '"'; break;
315 case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
316 default:
317 if (c >= ' ' && c <= 126)
318 *dst++ = (char)c;
319 else
320 {
321 *dst++ = '\\';
322 sprintf(dst,"%04x",c);
323 dst+=4;
324 }
325 }
326 }
327 *dst++ = '"';
328 if (*src)
329 {
330 *dst++ = '.';
331 *dst++ = '.';
332 *dst++ = '.';
333 }
334 *dst++ = '\0';
335 return res;
336}
337#else
338#define debugstr_guid(a) 0
339#endif
340
341#endif /* __WINE_DEBUGTOOLS_H */
Note: See TracBrowser for help on using the repository browser.