debug.h File Reference

#include <stdarg.h>
#include <stdio.h>
#include <windef.h>
#include <guiddef.h>

Include dependency graph for debug.h:

Go to the source code of this file.

Classes
struct	__wine_debug_channel
struct	__wine_debug_functions

Macros
#define	__RELFILE__   __FILE__
#define	UNIMPLEMENTED   WINE_FIXME("%s is UNIMPLEMENTED!\n", __FUNCTION__)
#define	__WINE_GET_DEBUGGING_TRACE(dbch)   ((dbch)->flags & (1 << __WINE_DBCL_TRACE))
#define	__WINE_GET_DEBUGGING_WARN(dbch)   ((dbch)->flags & (1 << __WINE_DBCL_WARN))
#define	__WINE_GET_DEBUGGING_FIXME(dbch)   ((dbch)->flags & (1 << __WINE_DBCL_FIXME))
#define	__WINE_GET_DEBUGGING_ERR(dbch)   ((dbch)->flags & (1 << __WINE_DBCL_ERR))
#define	__WINE_GET_DEBUGGING(dbcl, dbch)   __WINE_GET_DEBUGGING##dbcl(dbch)
#define	__WINE_IS_DEBUG_ON(dbcl, dbch)   (__WINE_GET_DEBUGGING##dbcl(dbch) && (__wine_dbg_get_channel_flags(dbch) & (1 << __WINE_DBCL##dbcl)))
#define	__WINE_DPRINTF(dbcl, dbch)
#define	__WINE_PRINTF_ATTR(fmt, args)
#define	WINE_TRACE   __WINE_DPRINTF(_TRACE,__wine_dbch___default)
#define	WINE_TRACE_(ch)   __WINE_DPRINTF(_TRACE,&__wine_dbch_##ch)
#define	WINE_TRACE_ON(ch)   __WINE_IS_DEBUG_ON(_TRACE,&__wine_dbch_##ch)
#define	WINE_WARN   __WINE_DPRINTF(_WARN,__wine_dbch___default)
#define	WINE_WARN_(ch)   __WINE_DPRINTF(_WARN,&__wine_dbch_##ch)
#define	WINE_WARN_ON(ch)   __WINE_IS_DEBUG_ON(_WARN,&__wine_dbch_##ch)
#define	WINE_FIXME   __WINE_DPRINTF(_FIXME,__wine_dbch___default)
#define	WINE_FIXME_(ch)   __WINE_DPRINTF(_FIXME,&__wine_dbch_##ch)
#define	WINE_FIXME_ON(ch)   __WINE_IS_DEBUG_ON(_FIXME,&__wine_dbch_##ch)
#define	WINE_ERR   __WINE_DPRINTF(_ERR,__wine_dbch___default)
#define	WINE_ERR_(ch)   __WINE_DPRINTF(_ERR,&__wine_dbch_##ch)
#define	WINE_ERR_ON(ch)   __WINE_IS_DEBUG_ON(_ERR,&__wine_dbch_##ch)
#define	WINE_DECLARE_DEBUG_CHANNEL(ch)   static struct __wine_debug_channel __wine_dbch_##ch = { (unsigned char)~0, #ch }
#define	WINE_DEFAULT_DEBUG_CHANNEL(ch)
#define	WINE_DPRINTF   wine_dbg_printf
#define	WINE_MESSAGE   wine_dbg_printf
#define	TRACE   WINE_TRACE
#define	TRACE_(ch)   WINE_TRACE_(ch)
#define	TRACE_ON(ch)   WINE_TRACE_ON(ch)
#define	WARN   WINE_WARN
#define	WARN_(ch)   WINE_WARN_(ch)
#define	WARN_ON(ch)   WINE_WARN_ON(ch)
#define	FIXME   WINE_FIXME
#define	FIXME_(ch)   WINE_FIXME_(ch)
#define	FIXME_ON(ch)   WINE_FIXME_ON(ch)
#define	ERR   WINE_ERR
#define	ERR_(ch)   WINE_ERR_(ch)
#define	ERR_ON(ch)   WINE_ERR_ON(ch)
#define	DPRINTF   WINE_DPRINTF
#define	MESSAGE   WINE_MESSAGE

Enumerations
enum	__wine_debug_class {   __WINE_DBCL_FIXME = 0, __WINE_DBCL_ERR = 1, __WINE_DBCL_WARN = 2, __WINE_DBCL_TRACE = 3,   __WINE_DBCL_INIT = 0x7 }

Functions
unsigned char	__wine_dbg_get_channel_flags (struct __wine_debug_channel *channel)
int	__wine_dbg_set_channel_flags (struct __wine_debug_channel *channel, unsigned char set, unsigned char clear)
void	__wine_dbg_set_functions (const struct __wine_debug_functions *new_funcs, struct __wine_debug_functions *old_funcs, size_t size)
const char *	wine_dbgstr_an (const char *s, int n)
const char *	wine_dbgstr_wn (const WCHAR *s, int n)
const char *	wine_dbg_sprintf (const char *format,...) __WINE_PRINTF_ATTR(1
const char int	wine_dbg_printf (const char *format,...) __WINE_PRINTF_ATTR(1
const char int int	wine_dbg_log (enum __wine_debug_class cls, struct __wine_debug_channel *ch, const char *func, const char *format,...) __WINE_PRINTF_ATTR(4
const char int int int	ros_dbg_log (enum __wine_debug_class cls, struct __wine_debug_channel *ch, const char *file, const char *func, const int line, const char *format,...) __WINE_PRINTF_ATTR(6
const char int int int static __inline const char *	wine_dbgstr_a (const char *s)
static __inline const char *	wine_dbgstr_w (const WCHAR *s)
static __inline const char *	wine_dbgstr_guid (const GUID *id)
static __inline const char *	wine_dbgstr_point (const POINT *pt)
static __inline const char *	wine_dbgstr_size (const SIZE *size)
static __inline const char *	wine_dbgstr_rect (const RECT *rect)
static __inline const char *	wine_dbgstr_longlong (ULONGLONG ll)
static __inline const char *	debugstr_an (const char *s, int n)
static __inline const char *	debugstr_wn (const WCHAR *s, int n)
static __inline const char *	debugstr_guid (const struct _GUID *id)
static __inline const char *	debugstr_a (const char *s)
static __inline const char *	debugstr_w (const WCHAR *s)

Macro Definition Documentation

__RELFILE__

#define __RELFILE__   __FILE__

Definition at line 32 of file debug.h.

__WINE_DPRINTF

#define __WINE_DPRINTF	(		dbcl,
			dbch
	)

Value:

(!__WINE_GET_DEBUGGING(dbcl,(dbch)) || \
     (ros_dbg_log(__WINE_DBCL##dbcl,(dbch),__RELFILE__,__FUNCTION__,__LINE__,"") == -1)) ? \
     (void)0 : (void)wine_dbg_printf

Definition at line 143 of file debug.h.

__WINE_GET_DEBUGGING

#define __WINE_GET_DEBUGGING	(		dbcl,
			dbch
	)		__WINE_GET_DEBUGGING##dbcl(dbch)

Definition at line 85 of file debug.h.

__WINE_GET_DEBUGGING_ERR

#define __WINE_GET_DEBUGGING_ERR

(

dbch

)

((dbch)->flags & (1 << __WINE_DBCL_ERR))

Definition at line 83 of file debug.h.

__WINE_GET_DEBUGGING_FIXME

#define __WINE_GET_DEBUGGING_FIXME

(

dbch

)

((dbch)->flags & (1 << __WINE_DBCL_FIXME))

Definition at line 76 of file debug.h.

__WINE_GET_DEBUGGING_TRACE

#define __WINE_GET_DEBUGGING_TRACE

(

dbch

)

((dbch)->flags & (1 << __WINE_DBCL_TRACE))

Definition at line 69 of file debug.h.

__WINE_GET_DEBUGGING_WARN

#define __WINE_GET_DEBUGGING_WARN

(

dbch

)

((dbch)->flags & (1 << __WINE_DBCL_WARN))

Definition at line 75 of file debug.h.

__WINE_IS_DEBUG_ON

#define __WINE_IS_DEBUG_ON	(		dbcl,
			dbch
	)		(__WINE_GET_DEBUGGING##dbcl(dbch) && (__wine_dbg_get_channel_flags(dbch) & (1 << __WINE_DBCL##dbcl)))

Definition at line 87 of file debug.h.

__WINE_PRINTF_ATTR

#define __WINE_PRINTF_ATTR	(		fmt,
			args
	)

Definition at line 148 of file debug.h.

DPRINTF

#define DPRINTF   WINE_DPRINTF

Definition at line 414 of file debug.h.

ERR

#define ERR   WINE_ERR

Definition at line 410 of file debug.h.

ERR_

#define ERR_

(

ch

)

WINE_ERR_(ch)

Definition at line 411 of file debug.h.

ERR_ON

#define ERR_ON

(

ch

)

WINE_ERR_ON(ch)

Definition at line 412 of file debug.h.

FIXME

#define FIXME   WINE_FIXME

Definition at line 405 of file debug.h.

FIXME_

#define FIXME_

(

ch

)

WINE_FIXME_(ch)

Definition at line 406 of file debug.h.

FIXME_ON

#define FIXME_ON

(

ch

)

WINE_FIXME_ON(ch)

Definition at line 407 of file debug.h.

MESSAGE

#define MESSAGE   WINE_MESSAGE

Definition at line 415 of file debug.h.

TRACE

#define TRACE   WINE_TRACE

Definition at line 397 of file debug.h.

TRACE_

#define TRACE_

(

ch

)

WINE_TRACE_(ch)

Definition at line 398 of file debug.h.

TRACE_ON

#define TRACE_ON

(

ch

)

WINE_TRACE_ON(ch)

Definition at line 399 of file debug.h.

UNIMPLEMENTED

#define UNIMPLEMENTED   WINE_FIXME("%s is UNIMPLEMENTED!\n", __FUNCTION__)

Definition at line 66 of file debug.h.

WARN

#define WARN   WINE_WARN

Definition at line 401 of file debug.h.

WARN_

#define WARN_

(

ch

)

WINE_WARN_(ch)

Definition at line 402 of file debug.h.

WARN_ON

#define WARN_ON

(

ch

)

WINE_WARN_ON(ch)

Definition at line 403 of file debug.h.

WINE_DECLARE_DEBUG_CHANNEL

#define WINE_DECLARE_DEBUG_CHANNEL

(

ch

)

static struct __wine_debug_channel __wine_dbch_##ch = { (unsigned char)~0, #ch }

Definition at line 375 of file debug.h.

WINE_DEFAULT_DEBUG_CHANNEL

#define WINE_DEFAULT_DEBUG_CHANNEL

(

ch

)

Value:

static struct __wine_debug_channel __wine_dbch_##ch = { (unsigned char)~0, #ch }; \
    static struct __wine_debug_channel * const __wine_dbch___default = &__wine_dbch_##ch

Definition at line 377 of file debug.h.

WINE_DPRINTF

#define WINE_DPRINTF   wine_dbg_printf

Definition at line 381 of file debug.h.

WINE_ERR

#define WINE_ERR   __WINE_DPRINTF(_ERR,__wine_dbch___default)

Definition at line 371 of file debug.h.

WINE_ERR_

#define WINE_ERR_

(

ch

)

__WINE_DPRINTF(_ERR,&__wine_dbch_##ch)

Definition at line 372 of file debug.h.

WINE_ERR_ON

#define WINE_ERR_ON

(

ch

)

__WINE_IS_DEBUG_ON(_ERR,&__wine_dbch_##ch)

Definition at line 373 of file debug.h.

WINE_FIXME

#define WINE_FIXME   __WINE_DPRINTF(_FIXME,__wine_dbch___default)

Definition at line 366 of file debug.h.

WINE_FIXME_

#define WINE_FIXME_

(

ch

)

__WINE_DPRINTF(_FIXME,&__wine_dbch_##ch)

Definition at line 367 of file debug.h.

WINE_FIXME_ON

#define WINE_FIXME_ON

(

ch

)

__WINE_IS_DEBUG_ON(_FIXME,&__wine_dbch_##ch)

Definition at line 369 of file debug.h.

WINE_MESSAGE

#define WINE_MESSAGE   wine_dbg_printf

Definition at line 382 of file debug.h.

WINE_TRACE

#define WINE_TRACE   __WINE_DPRINTF(_TRACE,__wine_dbch___default)

Definition at line 354 of file debug.h.

WINE_TRACE_

#define WINE_TRACE_

(

ch

)

__WINE_DPRINTF(_TRACE,&__wine_dbch_##ch)

Definition at line 355 of file debug.h.

WINE_TRACE_ON

#define WINE_TRACE_ON

(

ch

)

__WINE_IS_DEBUG_ON(_TRACE,&__wine_dbch_##ch)

Definition at line 357 of file debug.h.

WINE_WARN

#define WINE_WARN   __WINE_DPRINTF(_WARN,__wine_dbch___default)

Definition at line 360 of file debug.h.

WINE_WARN_

#define WINE_WARN_

(

ch

)

__WINE_DPRINTF(_WARN,&__wine_dbch_##ch)

Definition at line 361 of file debug.h.

WINE_WARN_ON

#define WINE_WARN_ON

(

ch

)

__WINE_IS_DEBUG_ON(_WARN,&__wine_dbch_##ch)

Definition at line 363 of file debug.h.

Enumeration Type Documentation

__wine_debug_class

enum __wine_debug_class

Enumerator
__WINE_DBCL_FIXME
__WINE_DBCL_ERR
__WINE_DBCL_WARN
__WINE_DBCL_TRACE
__WINE_DBCL_INIT

Definition at line 49 of file debug.h.

{
    __WINE_DBCL_FIXME = 0, /* 0x1 */
    __WINE_DBCL_ERR   = 1, /* 0x2 */
    __WINE_DBCL_WARN  = 2, /* 0x4 */
    __WINE_DBCL_TRACE = 3, /* 0x8 */

    /* lazy init flag */
    __WINE_DBCL_INIT = 0x7
};

Function Documentation

__wine_dbg_get_channel_flags()

unsigned char __wine_dbg_get_channel_flags

(

struct __wine_debug_channel *

channel

)

Definition at line 83 of file debug.c.

{
    if (nb_debug_options == -1) debug_init();

    if (nb_debug_options)
    {
        struct __wine_debug_channel *opt = bsearch( channel->name, debug_options, nb_debug_options,
                                                    sizeof(debug_options[0]), cmp_name );
        if (opt) return opt->flags;
    }
    /* no option for this channel */
    if (channel->flags & (1 << __WINE_DBCL_INIT)) channel->flags = default_flags;
    return default_flags;
}

Referenced by ros_dbg_log(), and wine_dbg_log().

__wine_dbg_set_channel_flags()

int __wine_dbg_set_channel_flags	(	struct __wine_debug_channel *	channel,
		unsigned char	set,
		unsigned char	clear
	)

Definition at line 99 of file debug.c.

{
    if (nb_debug_options == -1) debug_init();

    if (nb_debug_options)
    {
        struct __wine_debug_channel *opt = bsearch( channel->name, debug_options, nb_debug_options,
                                                    sizeof(debug_options[0]), cmp_name );
        if (opt)
        {
            opt->flags = (opt->flags & ~clear) | set;
            return 1;
        }
    }
    return 0;
}

__wine_dbg_set_functions()

void __wine_dbg_set_functions	(	const struct __wine_debug_functions *	new_funcs,
		struct __wine_debug_functions *	old_funcs,
		size_t	size
	)

Definition at line 551 of file debug.c.

{
    if (old_funcs) memcpy( old_funcs, &funcs, min(sizeof(funcs),size) );
    if (new_funcs) memcpy( &funcs, new_funcs, min(sizeof(funcs),size) );
}

debugstr_a()

static __inline const char* debugstr_a ( const char *  s )

static

Definition at line 389 of file debug.h.

{ return wine_dbgstr_an( s, -1 ); }

debugstr_an()

static __inline const char* debugstr_an ( const char *  s, int  n  )

static

Definition at line 386 of file debug.h.

{ return wine_dbgstr_an( s, n ); }

debugstr_guid()

static __inline const char* debugstr_guid ( const struct _GUID *  id )

static

Definition at line 388 of file debug.h.

{ return wine_dbgstr_guid(id); }

debugstr_w()

static __inline const char* debugstr_w ( const WCHAR *  s )

static

Definition at line 390 of file debug.h.

{ return wine_dbgstr_wn( s, -1 ); }

debugstr_wn()

static __inline const char* debugstr_wn ( const WCHAR *  s, int  n  )

static

Definition at line 387 of file debug.h.

{ return wine_dbgstr_wn( s, n ); }

ros_dbg_log()

const char int int int ros_dbg_log	(	enum __wine_debug_class	cls,
		struct __wine_debug_channel *	ch,
		const char *	file,
		const char *	func,
		const int	line,
		const char *	format,
			...
	)

wine_dbg_log()

const char int int wine_dbg_log	(	enum __wine_debug_class	cls,
		struct __wine_debug_channel *	ch,
		const char *	func,
		const char *	format,
			...
	)

wine_dbg_printf()

const char int wine_dbg_printf	(	const char *	format,
			...
	)

Referenced by dump_template().

wine_dbg_sprintf()

const char* wine_dbg_sprintf	(	const char *	format,
			...
	)

Definition at line 296 of file compat.c.

{
    static const int max_size = 200;
    static char buffer[256];
    char *ret;
    int len;
    va_list valist;

    va_start(valist, format);
    ret = buffer;
    len = vsnprintf( ret, max_size, format, valist );
    if (len == -1 || len >= max_size) ret[max_size-1] = 0;
    va_end(valist);
    return ret;
}

Referenced by wine_dbgstr_guid(), wine_dbgstr_longlong(), wine_dbgstr_point(), wine_dbgstr_rect(), and wine_dbgstr_size().

wine_dbgstr_a()

const char int int int static __inline const char* wine_dbgstr_a ( const char *  s )

static

Definition at line 187 of file debug.h.

{
    return wine_dbgstr_an( s, -1 );
}

Referenced by AddERExcludedApplicationA(), D3DXCreateCubeTextureFromFileA(), D3DXCreateCubeTextureFromFileExA(), D3DXSaveSurfaceToFileA(), D3DXSaveTextureToFileA(), device_load_logo(), gl_error(), gl_problem(), gl_warning(), pdb_parse_cmd_string(), pdb_virtual_unwind(), test_try_transform(), and TWAIN_UserSelect().

wine_dbgstr_an()

const char* wine_dbgstr_an	(	const char *	s,
		int	n
	)

Definition at line 313 of file compat.c.

{
    static const char hex[16] = "0123456789abcdef";
    char *dst, *res;
    size_t size;
    static char buffer[256];

    if (!((ULONG_PTR)str >> 16))
    {
        if (!str) return "(null)";
        res = buffer;
        sprintf( res, "#%04x", LOWORD(str) );
        return res;
    }
    if (n == -1) n = strlen(str);
    if (n < 0) n = 0;
    size = 10 + min( 300, n * 4 );
    dst = res = buffer;
    *dst++ = '"';
    while (n-- > 0 && dst <= res + size - 9)
    {
        unsigned char c = *str++;
        switch (c)
        {
        case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
        case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
        case '\t': *dst++ = '\\'; *dst++ = 't'; break;
        case '"':  *dst++ = '\\'; *dst++ = '"'; break;
        case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
        default:
            if (c >= ' ' && c <= 126)
                *dst++ = c;
            else
            {
                *dst++ = '\\';
                *dst++ = 'x';
                *dst++ = hex[(c >> 4) & 0x0f];
                *dst++ = hex[c & 0x0f];
            }
        }
    }
    *dst++ = '"';
    if (n > 0)
    {
        *dst++ = '.';
        *dst++ = '.';
        *dst++ = '.';
    }
    *dst++ = 0;
    return res;
}

Referenced by debugstr_a(), debugstr_an(), and wine_dbgstr_a().

wine_dbgstr_guid()

static __inline const char* wine_dbgstr_guid ( const GUID *  id )

static

Definition at line 197 of file debug.h.

{
    if (!id) return "(null)";
    if (!((ULONG_PTR)id >> 16)) return wine_dbg_sprintf( "<guid-0x%04lx>", (ULONG_PTR)id & 0xffff );
    return wine_dbg_sprintf( "{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
                             id->Data1, id->Data2, id->Data3,
                             id->Data4[0], id->Data4[1], id->Data4[2], id->Data4[3],
                             id->Data4[4], id->Data4[5], id->Data4[6], id->Data4[7] );
}

Referenced by debugstr_guid().

wine_dbgstr_longlong()

static __inline const char* wine_dbgstr_longlong ( ULONGLONG  ll )

static

Definition at line 226 of file debug.h.

{
    if (/*sizeof(ll) > sizeof(unsigned long) &&*/ ll >> 32) /* ULONGLONG is always > long in ReactOS */
        return wine_dbg_sprintf( "%lx%08lx", (unsigned long)(ll >> 32), (unsigned long)ll );
    else return wine_dbg_sprintf( "%lx", (unsigned long)ll );
}

wine_dbgstr_point()

static __inline const char* wine_dbgstr_point ( const POINT *  pt )

static

Definition at line 207 of file debug.h.

{
    if (!pt) return "(null)";
    return wine_dbg_sprintf( "(%ld,%ld)", pt->x, pt->y );
}

wine_dbgstr_rect()

static __inline const char* wine_dbgstr_rect ( const RECT *  rect )

static

Definition at line 219 of file debug.h.

{
    if (!rect) return "(null)";
    return wine_dbg_sprintf( "(%ld,%ld)-(%ld,%ld)", rect->left, rect->top,
                             rect->right, rect->bottom );
}

wine_dbgstr_size()

static __inline const char* wine_dbgstr_size ( const SIZE *  size )

static

Definition at line 213 of file debug.h.

{
    if (!size) return "(null)";
    return wine_dbg_sprintf( "(%ld,%ld)", size->cx, size->cy );
}

wine_dbgstr_w()

static __inline const char* wine_dbgstr_w ( const WCHAR *  s )

static

Definition at line 192 of file debug.h.

{
    return wine_dbgstr_wn( s, -1 );
}

wine_dbgstr_wn()

const char* wine_dbgstr_wn	(	const WCHAR *	s,
		int	n
	)

Definition at line 367 of file compat.c.

{
    char *dst, *res;
    size_t size;
    static char buffer[256];

    if (!((ULONG_PTR)str >> 16))
    {
        if (!str) return "(null)";
        res = buffer;
        sprintf( res, "#%04x", LOWORD(str) );
        return res;
    }
    if (n == -1)
    {
        const WCHAR *end = str;
        while (*end) end++;
        n = end - str;
    }
    if (n < 0) n = 0;
    size = 12 + min( 300, n * 5 );
    dst = res = buffer;
    *dst++ = 'L';
    *dst++ = '"';
    while (n-- > 0 && dst <= res + size - 10)
    {
        WCHAR c = *str++;
        switch (c)
        {
        case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
        case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
        case '\t': *dst++ = '\\'; *dst++ = 't'; break;
        case '"':  *dst++ = '\\'; *dst++ = '"'; break;
        case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
        default:
            if (c >= ' ' && c <= 126)
                *dst++ = c;
            else
            {
                *dst++ = '\\';
                sprintf(dst,"%04x",c);
                dst+=4;
            }
        }
    }
    *dst++ = '"';
    if (n > 0)
    {
        *dst++ = '.';
        *dst++ = '.';
        *dst++ = '.';
    }
    *dst++ = 0;
    return res;
}

Referenced by debugstr_w(), debugstr_wn(), and wine_dbgstr_w().