include/wine/debug.h

3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/*
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Wine debugging interface
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Copyright 1999 Patrik Stridvall
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * This library is free software; you can redistribute it and/or
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * modify it under the terms of the GNU Lesser General Public
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * License as published by the Free Software Foundation; either
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * version 2.1 of the License, or (at your option) any later version.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * This library is distributed in the hope that it will be useful,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * but WITHOUT ANY WARRANTY; without even the implied warranty of
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Lesser General Public License for more details.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * You should have received a copy of the GNU Lesser General Public
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * License along with this library; if not, write to the Free Software
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/*
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Oracle LGPL Disclaimer: For the avoidance of doubt, except that if any license choice
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * other than GPL or LGPL is available it will apply instead, Oracle elects to use only
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * the Lesser General Public License version 2.1 (LGPLv2) at this time for any software where
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * a choice of LGPL license versions is made available with the language indicating
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * that LGPLv2 or any later version may be used, or where a choice of which version
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * of the LGPL is applied is otherwise unspecified.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifndef __WINE_WINE_DEBUG_H
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define __WINE_WINE_DEBUG_H
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#include <windows.h>
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifndef GUID_DEFINED
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#include <guiddef.h>
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef __WINE_WINE_TEST_H
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#error This file should not be used in Wine tests
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef VBOX_WINE_WITH_IPRT
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# include <iprt/assert.h>
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#else
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define AssertBreakpoint() do { } while (0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define Assert(_expr) do { } while (0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# ifdef DEBUG_misha
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#  include <iprt/cdefs.h>
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef __cplusplus
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncextern "C" {
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstruct _GUID;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync//#ifdef DEBUG
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync//# define VBOX_WINE_DEBUG
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync//#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef VBOX_WINE_DEBUG
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# ifndef VBOX_WINE_DEBUG_DEFINES
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncextern DWORD g_VBoxVDbgBreakOnD3DErr;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# else
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#  ifdef DEBUG_misha
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#   define _ERR_BREAK_DEFAULT 1
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#  else
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#   define _ERR_BREAK_DEFAULT 0
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#  endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncDWORD g_VBoxVDbgBreakOnD3DErr = _ERR_BREAK_DEFAULT;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define _ERR_BREAK() Assert(0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define _ERR_ASSERT(_e) Assert((_e))
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define _ERR_CHECK_BREAK(_t) do { \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync        if (g_VBoxVDbgBreakOn##_t) { _ERR_BREAK(); } \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    } while (0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define _ERR_CHECK_ASSERT(_t, _e) do { \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync        if (g_VBoxVDbgBreakOn##_t) { _ERR_ASSERT(_e); } \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    } while (0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define ERR_D3D() _ERR_CHECK_BREAK(D3DErr)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define ASSERT_D3D(_e) _ERR_CHECK_ASSERT(D3DErr, _e)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#else
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define ERR_D3D() ERR("Error!");
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define ASSERT_D3D(_e) do { \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync        if (!(_e)) \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync        { \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync            ERR("Error: Assertion failure expr (%s)", #_e); \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync        } \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    } while (0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif /* #ifdef VBOX_WINE_DEBUG */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef inline
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#undef inline
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define inline __inline
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/*
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Internal definitions (do not use these directly)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncenum __wine_debug_class
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    __WINE_DBCL_FIXME,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    __WINE_DBCL_ERR,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    __WINE_DBCL_WARN,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    __WINE_DBCL_TRACE,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    __WINE_DBCL_INIT = 7  /* lazy init flag */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync};
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstruct __wine_debug_channel
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    unsigned char flags;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    char name[15];
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync};
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifndef WINE_NO_TRACE_MSGS
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define __WINE_GET_DEBUGGING_TRACE(dbch) ((dbch)->flags & (1 << __WINE_DBCL_TRACE))
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#else
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define __WINE_GET_DEBUGGING_TRACE(dbch) 0
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifndef WINE_NO_DEBUG_MSGS
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define __WINE_GET_DEBUGGING_WARN(dbch)  ((dbch)->flags & (1 << __WINE_DBCL_WARN))
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# if 0// && defined(DEBUG_misha)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#  define __WINE_GET_DEBUGGING_FIXME(dbch) (RT_BREAKPOINT(), ((dbch)->flags & (1 << __WINE_DBCL_FIXME)))
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# else
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#  define __WINE_GET_DEBUGGING_FIXME(dbch) ((dbch)->flags & (1 << __WINE_DBCL_FIXME))
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#else
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define __WINE_GET_DEBUGGING_WARN(dbch)  0
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# if 0 && defined(DEBUG_misha)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#  define __WINE_GET_DEBUGGING_FIXME(dbch) (RT_BREAKPOINT(), 0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# else
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#  define __WINE_GET_DEBUGGING_FIXME(dbch) 0
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/* define error macro regardless of what is configured */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#if defined(DEBUG_misha)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define __WINE_GET_DEBUGGING_ERR(dbch)  (RT_BREAKPOINT(), ((dbch)->flags & (1 << __WINE_DBCL_ERR)))
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#else
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define __WINE_GET_DEBUGGING_ERR(dbch)  ((dbch)->flags & (1 << __WINE_DBCL_ERR))
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define __WINE_GET_DEBUGGING(dbcl,dbch)  __WINE_GET_DEBUGGING##dbcl(dbch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define __WINE_IS_DEBUG_ON(dbcl,dbch) \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync  (__WINE_GET_DEBUGGING##dbcl(dbch) && (__wine_dbg_get_channel_flags(dbch) & (1 << __WINE_DBCL##dbcl)))
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef __GNUC__
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define __WINE_DPRINTF(dbcl,dbch) \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync  do { if(__WINE_GET_DEBUGGING(dbcl,(dbch))) { \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync       struct __wine_debug_channel * const __dbch = (dbch); \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync       const enum __wine_debug_class __dbcl = __WINE_DBCL##dbcl; \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync       __WINE_DBG_LOG
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define __WINE_DBG_LOG(args...) \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    wine_dbg_log( __dbcl, __dbch, __FUNCTION__, args); } } while(0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define __WINE_PRINTF_ATTR(fmt,args) __attribute__((format (printf,fmt,args)))
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef WINE_NO_TRACE_MSGS
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_TRACE(args...) do { } while(0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_TRACE_(ch) WINE_TRACE
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef WINE_NO_DEBUG_MSGS
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_WARN(args...) do { } while(0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_WARN_(ch) WINE_WARN
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_FIXME(args...) do { } while(0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_FIXME_(ch) WINE_FIXME
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#elif defined(__SUNPRO_C)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define __WINE_DPRINTF(dbcl,dbch) \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync  do { if(__WINE_GET_DEBUGGING(dbcl,(dbch))) { \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync       struct __wine_debug_channel * const __dbch = (dbch); \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync       const enum __WINE_DEBUG_CLASS __dbcl = __WINE_DBCL##dbcl; \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync       __WINE_DBG_LOG
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define __WINE_DBG_LOG(...) \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync   wine_dbg_log( __dbcl, __dbch, __func__, __VA_ARGS__); } } while(0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define __WINE_PRINTF_ATTR(fmt,args)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef WINE_NO_TRACE_MSGS
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_TRACE(...) do { } while(0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_TRACE_(ch) WINE_TRACE
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef WINE_NO_DEBUG_MSGS
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_WARN(...) do { } while(0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_WARN_(ch) WINE_WARN
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_FIXME(...) do { } while(0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_FIXME_(ch) WINE_FIXME
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#else  /* !__GNUC__ && !__SUNPRO_C */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define __WINE_DPRINTF(dbcl,dbch) \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    (!__WINE_GET_DEBUGGING(dbcl,(dbch)) || \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync     (wine_dbg_log(__WINE_DBCL##dbcl,(dbch),__FILE__,"%d: ",__LINE__) == -1)) ? \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync     (void)0 : (void)wine_dbg_printf
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define __WINE_PRINTF_ATTR(fmt, args)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif  /* !__GNUC__ && !__SUNPRO_C */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstruct __wine_debug_functions
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    char * (*get_temp_buffer)( size_t n );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    void   (*release_temp_buffer)( char *buffer, size_t n );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    const char * (*dbgstr_an)( const char * s, int n );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    const char * (*dbgstr_wn)( const WCHAR *s, int n );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    int (*dbg_vprintf)( const char *format, va_list args );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    int (*dbg_vlog)( enum __wine_debug_class cls, struct __wine_debug_channel *channel,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync                     const char *function, const char *format, va_list args );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync};
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncextern unsigned char __wine_dbg_get_channel_flags( struct __wine_debug_channel *channel );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncextern int __wine_dbg_set_channel_flags( struct __wine_debug_channel *channel,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync                                         unsigned char set, unsigned char clear );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncextern void __wine_dbg_set_functions( const struct __wine_debug_functions *new_funcs,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync                                      struct __wine_debug_functions *old_funcs, size_t size );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/*
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Exported definitions and macros
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/* These functions return a printable version of a string, including
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync   quotes.  The string will be valid for some time, but not indefinitely
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync   as strings are re-used.  */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncextern const char *wine_dbgstr_an( const char * s, int n );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncextern const char *wine_dbgstr_wn( const WCHAR *s, int n );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncextern const char *wine_dbg_sprintf( const char *format, ... ) __WINE_PRINTF_ATTR(1,2);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncextern int wine_dbg_printf( const char *format, ... ) __WINE_PRINTF_ATTR(1,2);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncextern int wine_dbg_log( enum __wine_debug_class cls, struct __wine_debug_channel *ch, const char *func,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync                         const char *format, ... ) __WINE_PRINTF_ATTR(4,5);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstatic inline const char *wine_dbgstr_a( const char *s )
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    return wine_dbgstr_an( s, -1 );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync}
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstatic inline const char *wine_dbgstr_w( const WCHAR *s )
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    return wine_dbgstr_wn( s, -1 );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync}
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstatic inline const char *wine_dbgstr_guid( const GUID *id )
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    if (!id) return "(null)";
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    if (!((ULONG_PTR)id >> 16)) return wine_dbg_sprintf( "<guid-0x%04hx>", (WORD)(ULONG_PTR)id );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    return wine_dbg_sprintf( "{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync                             id->Data1, id->Data2, id->Data3,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync                             id->Data4[0], id->Data4[1], id->Data4[2], id->Data4[3],
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync                             id->Data4[4], id->Data4[5], id->Data4[6], id->Data4[7] );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync}
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstatic inline const char *wine_dbgstr_point( const POINT *pt )
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    if (!pt) return "(null)";
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    return wine_dbg_sprintf( "(%d,%d)", pt->x, pt->y );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync}
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstatic inline const char *wine_dbgstr_size( const SIZE *size )
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    if (!size) return "(null)";
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    return wine_dbg_sprintf( "(%d,%d)", size->cx, size->cy );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync}
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstatic inline const char *wine_dbgstr_rect( const RECT *rect )
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    if (!rect) return "(null)";
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    return wine_dbg_sprintf( "(%d,%d)-(%d,%d)", rect->left, rect->top,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync                             rect->right, rect->bottom );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync}
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstatic inline const char *wine_dbgstr_longlong( ULONGLONG ll )
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    if (sizeof(ll) > sizeof(unsigned long) && ll >> 32)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync        return wine_dbg_sprintf( "%lx%08lx", (unsigned long)(ll >> 32), (unsigned long)ll );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    else return wine_dbg_sprintf( "%lx", (unsigned long)ll );
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync}
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifndef WINE_TRACE
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_TRACE                 __WINE_DPRINTF(_TRACE,__wine_dbch___default)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_TRACE_(ch)            __WINE_DPRINTF(_TRACE,&__wine_dbch_##ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_TRACE_ON(ch)          __WINE_IS_DEBUG_ON(_TRACE,&__wine_dbch_##ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifndef WINE_WARN
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_WARN                  __WINE_DPRINTF(_WARN,__wine_dbch___default)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_WARN_(ch)             __WINE_DPRINTF(_WARN,&__wine_dbch_##ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_WARN_ON(ch)           __WINE_IS_DEBUG_ON(_WARN,&__wine_dbch_##ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifndef WINE_FIXME
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_FIXME                 __WINE_DPRINTF(_FIXME,__wine_dbch___default)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_FIXME_(ch)            __WINE_DPRINTF(_FIXME,&__wine_dbch_##ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_FIXME_ON(ch)          __WINE_IS_DEBUG_ON(_FIXME,&__wine_dbch_##ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_ERR                   __WINE_DPRINTF(_ERR,__wine_dbch___default)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_ERR_(ch)              __WINE_DPRINTF(_ERR,&__wine_dbch_##ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_ERR_ON(ch)            __WINE_IS_DEBUG_ON(_ERR,&__wine_dbch_##ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_DECLARE_DEBUG_CHANNEL(ch) \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    static struct __wine_debug_channel __wine_dbch_##ch = { ~0, #ch }
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_DEFAULT_DEBUG_CHANNEL(ch) \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    static struct __wine_debug_channel __wine_dbch_##ch = { ~0, #ch }; \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    static struct __wine_debug_channel * const __wine_dbch___default = &__wine_dbch_##ch
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_DPRINTF               wine_dbg_printf
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WINE_MESSAGE               wine_dbg_printf
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef __WINESRC__
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/* Wine uses shorter names that are very likely to conflict with other software */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstatic inline const char *debugstr_an( const char * s, int n ) { return wine_dbgstr_an( s, n ); }
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstatic inline const char *debugstr_wn( const WCHAR *s, int n ) { return wine_dbgstr_wn( s, n ); }
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstatic inline const char *debugstr_guid( const struct _GUID *id ) { return wine_dbgstr_guid(id); }
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstatic inline const char *debugstr_a( const char *s )  { return wine_dbgstr_an( s, -1 ); }
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncstatic inline const char *debugstr_w( const WCHAR *s ) { return wine_dbgstr_wn( s, -1 ); }
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define TRACE                      WINE_TRACE
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define TRACE_(ch)                 WINE_TRACE_(ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define TRACE_ON(ch)               WINE_TRACE_ON(ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WARN                       WINE_WARN
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WARN_(ch)                  WINE_WARN_(ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define WARN_ON(ch)                WINE_WARN_ON(ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define FIXME                      WINE_FIXME
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define FIXME_(ch)                 WINE_FIXME_(ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define FIXME_ON(ch)               WINE_FIXME_ON(ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#undef ERR  /* Solaris got an 'ERR' define in <sys/reg.h> */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define ERR                        WINE_ERR
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define ERR_(ch)                   WINE_ERR_(ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define ERR_ON(ch)                 WINE_ERR_ON(ch)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define DPRINTF                    WINE_DPRINTF
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define MESSAGE                    WINE_MESSAGE
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif /* __WINESRC__ */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef __cplusplus
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync}
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#if 0//def DEBUG_misha
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define VBOXWINEDBG_SHADERS
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#if defined(VBOXWINEDBG_SHADERS) || defined(VBOX_WINE_WITH_PROFILE)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#include <stdio.h>
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#include <stdarg.h>
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncvoid vboxWDbgPrintF(char * szString, ...);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef VBOXWINEDBG_SHADERS
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define WDLOG(_m) do {\
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync        vboxWDbgPrintF _m ; \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync    } while (0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#else
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define WDLOG(_m) do { } while (0)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif  /* __WINE_WINE_DEBUG_H */