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