git.oblomov.eu Git - wine/blob - dlls/shell32/debughlp.c

   1 /*
   2  * Helper functions for debugging
   3  *
   4  * Copyright 1998, 2002 Juergen Schmied
   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #include <ctype.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <stdio.h>
  25 #include "windef.h"
  26 #include "wingdi.h"
  27 #include "pidl.h"
  28 #include "shlguid.h"
  29 #include "shldisp.h"
  30 #include "wine/debug.h"
  31 #include "debughlp.h"
  32 #include "docobj.h"
  33 #include "shell32_main.h"
  34
  35
  36 WINE_DEFAULT_DEBUG_CHANNEL(pidl);
  37
  38 static
  39 LPITEMIDLIST _dbg_ILGetNext(LPCITEMIDLIST pidl)
  40 {
  41         WORD len;
  42
  43         if(pidl)
  44         {
  45           len =  pidl->mkid.cb;
  46           if (len)
  47           {
  48             return (LPITEMIDLIST) (((LPBYTE)pidl)+len);
  49           }
  50         }
  51         return NULL;
  52 }
  53
  54 static
  55 BOOL _dbg_ILIsDesktop(LPCITEMIDLIST pidl)
  56 {
  57         return ( !pidl || (pidl && pidl->mkid.cb == 0x00) );
  58 }
  59
  60 static
  61 LPPIDLDATA _dbg_ILGetDataPointer(LPCITEMIDLIST pidl)
  62 {
  63         if(pidl && pidl->mkid.cb != 0x00)
  64           return (LPPIDLDATA) &(pidl->mkid.abID);
  65         return NULL;
  66 }
  67
  68 static
  69 LPSTR _dbg_ILGetTextPointer(LPCITEMIDLIST pidl)
  70 {
  71         LPPIDLDATA pdata =_dbg_ILGetDataPointer(pidl);
  72
  73         if (pdata)
  74         {
  75           switch (pdata->type)
  76           {
  77             case PT_GUID:
  78             case PT_SHELLEXT:
  79             case PT_YAGUID:
  80               return NULL;
  81
  82             case PT_DRIVE:
  83             case PT_DRIVE1:
  84             case PT_DRIVE2:
  85             case PT_DRIVE3:
  86               return (LPSTR)&(pdata->u.drive.szDriveName);
  87
  88             case PT_FOLDER:
  89             case PT_FOLDER1:
  90             case PT_VALUE:
  91             case PT_IESPECIAL1:
  92             case PT_IESPECIAL2:
  93               return (LPSTR)&(pdata->u.file.szNames);
  94
  95             case PT_WORKGRP:
  96             case PT_COMP:
  97             case PT_NETWORK:
  98             case PT_NETPROVIDER:
  99             case PT_SHARE:
 100               return (LPSTR)&(pdata->u.network.szNames);
 101           }
 102         }
 103         return NULL;
 104 }
 105
 106 static
 107 LPSTR _dbg_ILGetSTextPointer(LPCITEMIDLIST pidl)
 108 {
 109         LPPIDLDATA pdata =_dbg_ILGetDataPointer(pidl);
 110
 111         if (pdata)
 112         {
 113           switch (pdata->type)
 114           {
 115             case PT_FOLDER:
 116             case PT_VALUE:
 117             case PT_IESPECIAL1:
 118             case PT_IESPECIAL2:
 119               return (LPSTR)(pdata->u.file.szNames + strlen (pdata->u.file.szNames) + 1);
 120
 121             case PT_WORKGRP:
 122               return (LPSTR)(pdata->u.network.szNames + strlen (pdata->u.network.szNames) + 1);
 123           }
 124         }
 125         return NULL;
 126 }
 127
 128 static
 129 IID* _dbg_ILGetGUIDPointer(LPCITEMIDLIST pidl)
 130 {
 131         LPPIDLDATA pdata =_ILGetDataPointer(pidl);
 132
 133         if (pdata)
 134         {
 135           switch (pdata->type)
 136           {
 137             case PT_SHELLEXT:
 138             case PT_GUID:
 139               return &(pdata->u.guid.guid);
 140           }
 141         }
 142         return NULL;
 143 }
 144
 145 static
 146 DWORD _dbg_ILSimpleGetText (LPCITEMIDLIST pidl, LPSTR szOut, UINT uOutSize)
 147 {
 148         DWORD           dwReturn=0;
 149         LPSTR           szSrc;
 150         GUID const *    riid;
 151         char szTemp[MAX_PATH];
 152
 153         if (!pidl) return 0;
 154
 155         if (szOut)
 156           *szOut = 0;
 157
 158         if (_dbg_ILIsDesktop(pidl))
 159         {
 160          /* desktop */
 161           if (szOut) strncpy(szOut, "Desktop", uOutSize);
 162           dwReturn = strlen ("Desktop");
 163         }
 164         else if (( szSrc = _dbg_ILGetTextPointer(pidl) ))
 165         {
 166           /* filesystem */
 167           if (szOut) strncpy(szOut, szSrc, uOutSize);
 168           dwReturn = strlen(szSrc);
 169         }
 170         else if (( riid = _dbg_ILGetGUIDPointer(pidl) ))
 171         {
 172           if (szOut)
 173             sprintf( szOut, "{%08lx-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
 174                  riid->Data1, riid->Data2, riid->Data3,
 175                  riid->Data4[0], riid->Data4[1], riid->Data4[2], riid->Data4[3],
 176                  riid->Data4[4], riid->Data4[5], riid->Data4[6], riid->Data4[7] );
 177           dwReturn = strlen (szTemp);
 178         }
 179         return dwReturn;
 180 }
 181
 182
 183
 184
 185 void pdump (LPCITEMIDLIST pidl)
 186 {
 187         LPCITEMIDLIST pidltemp = pidl;
 188
 189         if (!TRACE_ON(pidl)) return;
 190
 191         if (! pidltemp)
 192         {
 193           MESSAGE ("-------- pidl=NULL (Desktop)\n");
 194         }
 195         else
 196         {
 197           MESSAGE ("-------- pidl=%p\n", pidl);
 198           if (pidltemp->mkid.cb)
 199           {
 200             do
 201             {
 202               DWORD dwAttrib = 0;
 203               LPPIDLDATA pData   = _dbg_ILGetDataPointer(pidltemp);
 204               DWORD type         = pData->type;
 205               LPSTR szLongName   = _dbg_ILGetTextPointer(pidltemp);
 206               LPSTR szShortName  = _dbg_ILGetSTextPointer(pidltemp);
 207               char szName[MAX_PATH];
 208
 209               _dbg_ILSimpleGetText(pidltemp, szName, MAX_PATH);
 210               if( PT_FOLDER == type || PT_VALUE == type)
 211                 dwAttrib = pData->u.file.uFileAttribs;
 212
 213               MESSAGE ("[%p] size=%04u type=%lx attr=0x%08lx name=\"%s\" (%s,%s)\n",
 214                        pidltemp, pidltemp->mkid.cb,type,dwAttrib,szName,debugstr_a(szLongName), debugstr_a(szShortName));
 215
 216               pidltemp = _dbg_ILGetNext(pidltemp);
 217
 218             } while (pidltemp && pidltemp->mkid.cb);
 219           }
 220           else
 221           {
 222             MESSAGE ("empty pidl (Desktop)\n");
 223           }
 224           pcheck(pidl);
 225         }
 226 }
 227
 228 static void dump_pidl_hex( LPCITEMIDLIST pidl )
 229 {
 230     const unsigned char *p = (const unsigned char *)pidl;
 231     const int max_bytes = 0x80, max_line = 0x10;
 232     char szHex[max_line*3+1], szAscii[max_line+1];
 233     int i, n;
 234
 235     n = pidl->mkid.cb;
 236     if( n>max_bytes )
 237         n = max_bytes;
 238     for( i=0; i<n; i++ )
 239     {
 240         sprintf( &szHex[ (i%max_line)*3 ], "%02X ", p[i] );
 241         szAscii[ (i%max_line) ] = isprint( p[i] ) ? p[i] : '.';
 242
 243         /* print out at the end of each line and when we're finished */
 244         if( i!=(n-1) && (i%max_line) != (max_line-1) )
 245             continue;
 246         szAscii[ (i%max_line)+1 ] = 0;
 247         DPRINTF("%-*s   %s\n", max_line*3, szHex, szAscii );
 248     }
 249 }
 250
 251 BOOL pcheck( LPCITEMIDLIST pidl )
 252 {
 253     DWORD type;
 254     LPCITEMIDLIST pidltemp = pidl;
 255
 256     while( pidltemp && pidltemp->mkid.cb )
 257     {
 258         type = _dbg_ILGetDataPointer(pidltemp)->type;
 259         switch( type )
 260         {
 261         case PT_CPLAPPLET:
 262         case PT_GUID:
 263         case PT_SHELLEXT:
 264         case PT_DRIVE:
 265         case PT_DRIVE1:
 266         case PT_DRIVE2:
 267         case PT_DRIVE3:
 268         case PT_FOLDER:
 269         case PT_VALUE:
 270         case PT_FOLDER1:
 271         case PT_WORKGRP:
 272         case PT_COMP:
 273         case PT_NETPROVIDER:
 274         case PT_NETWORK:
 275         case PT_IESPECIAL1:
 276         case PT_YAGUID:
 277         case PT_IESPECIAL2:
 278         case PT_SHARE:
 279             break;
 280         default:
 281             ERR("unknown IDLIST %p [%p] size=%u type=%lx\n",
 282                 pidl, pidltemp, pidltemp->mkid.cb,type );
 283             dump_pidl_hex( pidltemp );
 284             return FALSE;
 285         }
 286         pidltemp = _dbg_ILGetNext(pidltemp);
 287     }
 288     return TRUE;
 289 }
 290
 291 static char shdebugstr_buf1[100];
 292 static char shdebugstr_buf2[100];
 293 static char * shdebugstr_buf = shdebugstr_buf1;
 294
 295 static struct {
 296         REFIID  riid;
 297         char    *name;
 298 } InterfaceDesc[] = {
 299         {&IID_IUnknown,                 "IID_IUnknown"},
 300         {&IID_IClassFactory,            "IID_IClassFactory"},
 301         {&IID_IShellView,               "IID_IShellView"},
 302         {&IID_IOleCommandTarget,        "IID_IOleCommandTarget"},
 303         {&IID_IDropTarget,              "IID_IDropTarget"},
 304         {&IID_IDropSource,              "IID_IDropSource"},
 305         {&IID_IViewObject,              "IID_IViewObject"},
 306         {&IID_IContextMenu,             "IID_IContextMenu"},
 307         {&IID_IShellExtInit,            "IID_IShellExtInit"},
 308         {&IID_IShellFolder,             "IID_IShellFolder"},
 309         {&IID_IShellFolder2,            "IID_IShellFolder2"},
 310         {&IID_IPersist,                 "IID_IPersist"},
 311         {&IID_IPersistFolder,           "IID_IPersistFolder"},
 312         {&IID_IPersistFolder2,          "IID_IPersistFolder2"},
 313         {&IID_IPersistFolder3,          "IID_IPersistFolder3"},
 314         {&IID_IExtractIconA,            "IID_IExtractIconA"},
 315         {&IID_IExtractIconW,            "IID_IExtractIconW"},
 316         {&IID_IDataObject,              "IID_IDataObject"},
 317         {&IID_IAutoComplete,            "IID_IAutoComplete"},
 318         {&IID_IAutoComplete2,           "IID_IAutoComplete2"},
 319         {NULL,NULL}};
 320
 321 const char * shdebugstr_guid( const struct _GUID *id )
 322 {
 323         int i;
 324         char* name = NULL;
 325         char clsidbuf[100];
 326
 327         shdebugstr_buf = (shdebugstr_buf == shdebugstr_buf1) ? shdebugstr_buf2 : shdebugstr_buf1;
 328
 329         if (!id) {
 330           strcpy (shdebugstr_buf, "(null)");
 331         } else {
 332             for (i=0;InterfaceDesc[i].riid && !name;i++) {
 333                 if (IsEqualIID(InterfaceDesc[i].riid, id)) name = InterfaceDesc[i].name;
 334             }
 335             if (!name) {
 336                 if (HCR_GetClassNameA(id, clsidbuf, 100))
 337                     name = clsidbuf;
 338             }
 339
 340             sprintf( shdebugstr_buf, "\n\t{%08lx-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x} (%s)",
 341                  id->Data1, id->Data2, id->Data3,
 342                  id->Data4[0], id->Data4[1], id->Data4[2], id->Data4[3],
 343                  id->Data4[4], id->Data4[5], id->Data4[6], id->Data4[7], name ? name : "unknown" );
 344         }
 345         return shdebugstr_buf;
 346 }