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               return NULL;
  80
  81             case PT_DRIVE:
  82             case PT_DRIVE1:
  83             case PT_DRIVE2:
  84             case PT_DRIVE3:
  85               return (LPSTR)&(pdata->u.drive.szDriveName);
  86
  87             case PT_FOLDER:
  88             case PT_FOLDER1:
  89             case PT_VALUE:
  90             case PT_IESPECIAL1:
  91             case PT_RAS_FOLDER:
  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_RAS_FOLDER:
 119             case PT_IESPECIAL2:
 120               return (LPSTR)(pdata->u.file.szNames + strlen (pdata->u.file.szNames) + 1);
 121
 122             case PT_WORKGRP:
 123               return (LPSTR)(pdata->u.network.szNames + strlen (pdata->u.network.szNames) + 1);
 124           }
 125         }
 126         return NULL;
 127 }
 128
 129 static
 130 IID* _dbg_ILGetGUIDPointer(LPCITEMIDLIST pidl)
 131 {
 132         LPPIDLDATA pdata =_ILGetDataPointer(pidl);
 133
 134         if (pdata)
 135         {
 136           switch (pdata->type)
 137           {
 138             case PT_SHELLEXT:
 139             case PT_GUID:
 140               return &(pdata->u.guid.guid);
 141           }
 142         }
 143         return NULL;
 144 }
 145
 146 static
 147 DWORD _dbg_ILSimpleGetText (LPCITEMIDLIST pidl, LPSTR szOut, UINT uOutSize)
 148 {
 149         DWORD           dwReturn=0;
 150         LPSTR           szSrc;
 151         GUID const *    riid;
 152         char szTemp[MAX_PATH];
 153
 154         if (!pidl) return 0;
 155
 156         if (szOut)
 157           *szOut = 0;
 158
 159         if (_dbg_ILIsDesktop(pidl))
 160         {
 161          /* desktop */
 162           if (szOut) strncpy(szOut, "Desktop", uOutSize);
 163           dwReturn = strlen ("Desktop");
 164         }
 165         else if (( szSrc = _dbg_ILGetTextPointer(pidl) ))
 166         {
 167           /* filesystem */
 168           if (szOut) strncpy(szOut, szSrc, uOutSize);
 169           dwReturn = strlen(szSrc);
 170         }
 171         else if (( riid = _dbg_ILGetGUIDPointer(pidl) ))
 172         {
 173           if (szOut)
 174             sprintf( szOut, "{%08lx-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
 175                  riid->Data1, riid->Data2, riid->Data3,
 176                  riid->Data4[0], riid->Data4[1], riid->Data4[2], riid->Data4[3],
 177                  riid->Data4[4], riid->Data4[5], riid->Data4[6], riid->Data4[7] );
 178           dwReturn = strlen (szTemp);
 179         }
 180         return dwReturn;
 181 }
 182
 183
 184
 185
 186 void pdump (LPCITEMIDLIST pidl)
 187 {
 188         LPCITEMIDLIST pidltemp = pidl;
 189
 190         if (!TRACE_ON(pidl)) return;
 191
 192         if (! pidltemp)
 193         {
 194           MESSAGE ("-------- pidl=NULL (Desktop)\n");
 195         }
 196         else
 197         {
 198           MESSAGE ("-------- pidl=%p\n", pidl);
 199           if (pidltemp->mkid.cb)
 200           {
 201             do
 202             {
 203               DWORD dwAttrib = 0;
 204               LPPIDLDATA pData   = _dbg_ILGetDataPointer(pidltemp);
 205               DWORD type         = pData->type;
 206               LPSTR szLongName   = _dbg_ILGetTextPointer(pidltemp);
 207               LPSTR szShortName  = _dbg_ILGetSTextPointer(pidltemp);
 208               char szName[MAX_PATH];
 209
 210               _dbg_ILSimpleGetText(pidltemp, szName, MAX_PATH);
 211               if( PT_FOLDER == type || PT_VALUE == type)
 212                 dwAttrib = pData->u.file.uFileAttribs;
 213
 214               MESSAGE ("[%p] size=%04u type=%lx attr=0x%08lx name=\"%s\" (%s,%s)\n",
 215                        pidltemp, pidltemp->mkid.cb,type,dwAttrib,szName,debugstr_a(szLongName), debugstr_a(szShortName));
 216
 217               pidltemp = _dbg_ILGetNext(pidltemp);
 218
 219             } while (pidltemp->mkid.cb);
 220           }
 221           else
 222           {
 223             MESSAGE ("empty pidl (Desktop)\n");
 224           }
 225           pcheck(pidl);
 226         }
 227 }
 228 #define BYTES_PRINTED 32
 229 BOOL pcheck (LPCITEMIDLIST pidl)
 230 {
 231         DWORD type, ret=TRUE;
 232         LPCITEMIDLIST pidltemp = pidl;
 233
 234         if (pidltemp && pidltemp->mkid.cb)
 235         { do
 236           { type   = _dbg_ILGetDataPointer(pidltemp)->type;
 237             switch (type)
 238             { case PT_CPLAPPLET:
 239               case PT_GUID:
 240               case PT_SHELLEXT:
 241               case PT_DRIVE:
 242               case PT_DRIVE1:
 243               case PT_DRIVE2:
 244               case PT_DRIVE3:
 245               case PT_FOLDER:
 246               case PT_VALUE:
 247               case PT_FOLDER1:
 248               case PT_WORKGRP:
 249               case PT_COMP:
 250               case PT_NETPROVIDER:
 251               case PT_NETWORK:
 252               case PT_IESPECIAL1:
 253               case PT_RAS_FOLDER:
 254               case PT_IESPECIAL2:
 255               case PT_SHARE:
 256                 break;
 257               default:
 258               {
 259                 char szTemp[BYTES_PRINTED*4 + 1];
 260                 int i;
 261                 unsigned char c;
 262
 263                 memset(szTemp, ' ', BYTES_PRINTED*4 + 1);
 264                 for ( i = 0; (i<pidltemp->mkid.cb) && (i<BYTES_PRINTED); i++)
 265                 {
 266                   c = ((unsigned char *)pidltemp)[i];
 267
 268                   szTemp[i*3+0] = ((c>>4)>9)? (c>>4)+55 : (c>>4)+48;
 269                   szTemp[i*3+1] = ((0x0F&c)>9)? (0x0F&c)+55 : (0x0F&c)+48;
 270                   szTemp[i*3+2] = ' ';
 271                   szTemp[i+BYTES_PRINTED*3]  =  (c>=0x20 && c <=0x80) ? c : '.';
 272                 }
 273                 szTemp[BYTES_PRINTED*4] = 0x00;
 274                 ERR("unknown IDLIST %p [%p] size=%u type=%lx\n%s\n",pidl, pidltemp, pidltemp->mkid.cb,type, szTemp);
 275                 ret = FALSE;
 276               }
 277             }
 278             pidltemp = _dbg_ILGetNext(pidltemp);
 279           } while (pidltemp->mkid.cb);
 280         }
 281         return ret;
 282 }
 283
 284 static char shdebugstr_buf1[100];
 285 static char shdebugstr_buf2[100];
 286 static char * shdebugstr_buf = shdebugstr_buf1;
 287
 288 static struct {
 289         REFIID  riid;
 290         char    *name;
 291 } InterfaceDesc[] = {
 292         {&IID_IUnknown,                 "IID_IUnknown"},
 293         {&IID_IClassFactory,            "IID_IClassFactory"},
 294         {&IID_IShellView,               "IID_IShellView"},
 295         {&IID_IOleCommandTarget,        "IID_IOleCommandTarget"},
 296         {&IID_IDropTarget,              "IID_IDropTarget"},
 297         {&IID_IDropSource,              "IID_IDropSource"},
 298         {&IID_IViewObject,              "IID_IViewObject"},
 299         {&IID_IContextMenu,             "IID_IContextMenu"},
 300         {&IID_IShellExtInit,            "IID_IShellExtInit"},
 301         {&IID_IShellFolder,             "IID_IShellFolder"},
 302         {&IID_IShellFolder2,            "IID_IShellFolder2"},
 303         {&IID_IPersist,                 "IID_IPersist"},
 304         {&IID_IPersistFolder,           "IID_IPersistFolder"},
 305         {&IID_IPersistFolder2,          "IID_IPersistFolder2"},
 306         {&IID_IPersistFolder3,          "IID_IPersistFolder3"},
 307         {&IID_IExtractIconA,            "IID_IExtractIconA"},
 308         {&IID_IExtractIconW,            "IID_IExtractIconW"},
 309         {&IID_IDataObject,              "IID_IDataObject"},
 310         {&IID_IAutoComplete,            "IID_IAutoComplete"},
 311         {&IID_IAutoComplete2,           "IID_IAutoComplete2"},
 312         {NULL,NULL}};
 313
 314 const char * shdebugstr_guid( const struct _GUID *id )
 315 {
 316         int i;
 317         char* name = NULL;
 318         char clsidbuf[100];
 319
 320         shdebugstr_buf = (shdebugstr_buf == shdebugstr_buf1) ? shdebugstr_buf2 : shdebugstr_buf1;
 321
 322         if (!id) {
 323           strcpy (shdebugstr_buf, "(null)");
 324         } else {
 325             for (i=0;InterfaceDesc[i].riid && !name;i++) {
 326                 if (IsEqualIID(InterfaceDesc[i].riid, id)) name = InterfaceDesc[i].name;
 327             }
 328             if (!name) {
 329                 if (HCR_GetClassNameA(id, clsidbuf, 100))
 330                     name = clsidbuf;
 331             }
 332
 333             sprintf( shdebugstr_buf, "\n\t{%08lx-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x} (%s)",
 334                  id->Data1, id->Data2, id->Data3,
 335                  id->Data4[0], id->Data4[1], id->Data4[2], id->Data4[3],
 336                  id->Data4[4], id->Data4[5], id->Data4[6], id->Data4[7], name ? name : "unknown" );
 337         }
 338         return shdebugstr_buf;
 339 }