dlls/dmloader/debug.h

   1 /* Debug and Helper Functions
   2  *
   3  * Copyright (C) 2003-2004 Rok Mandeljc
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
  18  */
  19
  20 #ifndef __WINE_DMLOADER_DEBUG_H
  21 #define __WINE_DMLOADER_DEBUG_H
  22
  23 /* used for generic dumping (copied from ddraw) */
  24 typedef struct {
  25     DWORD val;
  26     const char* name;
  27 } flag_info;
  28
  29 typedef struct {
  30     const GUID *guid;
  31     const char* name;
  32 } guid_info;
  33
  34 /* used for initialising structs */
  35 #define DM_STRUCT_INIT(x)                               \
  36         do {                                                            \
  37                 memset((x), 0, sizeof(*(x)));   \
  38                 (x)->dwSize = sizeof(*x);               \
  39         } while (0)
  40
  41 #define FE(x) { x, #x }
  42 #define GE(x) { &x, #x }
  43
  44 /* check whether the given DWORD is even (return 0) or odd (return 1) */
  45 extern int even_or_odd (DWORD number);
  46 /* check whether chunkID is valid dmobject form chunk */
  47 extern BOOL IS_VALID_DMFORM (FOURCC chunkID);
  48 /* translate STREAM_SEEK flag to string */
  49 extern const char *resolve_STREAM_SEEK (DWORD flag);
  50 /* FOURCC to string conversion for debug messages */
  51 extern const char *debugstr_fourcc (DWORD fourcc);
  52 /* DMUS_VERSION struct to string conversion for debug messages */
  53 extern const char *debugstr_dmversion (LPDMUS_VERSION version);
  54 /* FILETIME struct to string conversion for debug messages */
  55 extern const char *debugstr_filetime (LPFILETIME time);
  56 /* returns name of given GUID */
  57 extern const char *debugstr_dmguid (const GUID *id);
  58 /* returns name of given error code */
  59 extern const char *debugstr_dmreturn (DWORD code);
  60 /* generic flags-dumping function */
  61 extern const char *debugstr_flags (DWORD flags, const flag_info* names, size_t num_names);
  62
  63 extern const char *debugstr_DMUS_OBJ_FLAGS (DWORD flagmask);
  64 extern const char *debugstr_DMUS_CONTAINER_FLAGS (DWORD flagmask);
  65 extern const char *debugstr_DMUS_CONTAINED_OBJF_FLAGS (DWORD flagmask);
  66 /* dump whole DMUS_OBJECTDESC struct */
  67 extern const char *debugstr_DMUS_OBJECTDESC (LPDMUS_OBJECTDESC pDesc);
  68 extern const char *debugstr_DMUS_IO_CONTAINER_HEADER (LPDMUS_IO_CONTAINER_HEADER pHeader);
  69 extern const char *debugstr_DMUS_IO_CONTAINED_OBJECT_HEADER (LPDMUS_IO_CONTAINED_OBJECT_HEADER pHeader);
  70
  71 #endif /* __WINE_DMLOADER_DEBUG_H */