Added some more tests.
[wine] / 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
30
31 WINE_DEFAULT_DEBUG_CHANNEL(pidl);
32
33 LPITEMIDLIST  _dbg_ILGetNext(LPITEMIDLIST pidl)
34 {
35         WORD len;
36
37         if(pidl)
38         {
39           len =  pidl->mkid.cb;
40           if (len)
41           {
42             pidl = (LPITEMIDLIST) (((LPBYTE)pidl)+len);
43             return pidl;
44           }
45         }
46         return NULL;
47 }
48
49 BOOL _dbg_ILIsDesktop(LPCITEMIDLIST pidl)
50 {
51         return ( !pidl || (pidl && pidl->mkid.cb == 0x00) );
52 }
53
54 LPPIDLDATA _dbg_ILGetDataPointer(LPITEMIDLIST pidl)
55 {
56         if(pidl && pidl->mkid.cb != 0x00)
57           return (LPPIDLDATA) &(pidl->mkid.abID);
58         return NULL;
59 }
60
61 LPSTR _dbg_ILGetTextPointer(LPCITEMIDLIST pidl)
62 {
63         LPPIDLDATA pdata =_dbg_ILGetDataPointer(pidl);
64
65         if (pdata)
66         {
67           switch (pdata->type)
68           {
69             case PT_MYCOMP:
70             case PT_SPECIAL:
71               return NULL;
72
73             case PT_DRIVE:
74             case PT_DRIVE1:
75             case PT_DRIVE2:
76             case PT_DRIVE3:
77               return (LPSTR)&(pdata->u.drive.szDriveName);
78
79             case PT_FOLDER:
80             case PT_FOLDER1:
81             case PT_VALUE:
82             case PT_IESPECIAL1:
83             case PT_IESPECIAL2:
84               return (LPSTR)&(pdata->u.file.szNames);
85
86             case PT_WORKGRP:
87             case PT_COMP:
88             case PT_NETWORK:
89             case PT_SHARE:
90               return (LPSTR)&(pdata->u.network.szNames);
91           }
92         }
93         return NULL;
94 }
95
96 LPSTR _dbg_ILGetSTextPointer(LPCITEMIDLIST pidl)
97 {
98         LPPIDLDATA pdata =_dbg_ILGetDataPointer(pidl);
99
100         if (pdata)
101         {
102           switch (pdata->type)
103           {
104             case PT_FOLDER:
105             case PT_VALUE:
106             case PT_IESPECIAL1:
107             case PT_IESPECIAL2:
108               return (LPSTR)(pdata->u.file.szNames + strlen (pdata->u.file.szNames) + 1);
109
110             case PT_WORKGRP:
111               return (LPSTR)(pdata->u.network.szNames + strlen (pdata->u.network.szNames) + 1);
112           }
113         }
114         return NULL;
115 }
116
117 REFIID _dbg_ILGetGUIDPointer(LPCITEMIDLIST pidl)
118 {
119         LPPIDLDATA pdata =_ILGetDataPointer(pidl);
120
121         if (pdata)
122         {
123           switch (pdata->type)
124           {
125             case PT_SPECIAL:
126             case PT_MYCOMP:
127               return (REFIID) &(pdata->u.mycomp.guid);
128
129             default:
130                 TRACE("Unknown pidl type 0x%04x\n", pdata->type);
131                 break;
132           }
133         }
134         return NULL;
135 }
136
137 DWORD _dbg_ILSimpleGetText (LPCITEMIDLIST pidl, LPSTR szOut, UINT uOutSize)
138 {
139         DWORD           dwReturn=0; 
140         LPSTR           szSrc;
141         GUID const *    riid;
142         char szTemp[MAX_PATH];
143         
144         if (!pidl) return 0;
145
146         if (szOut)
147           *szOut = 0;
148
149         if (_dbg_ILIsDesktop(pidl))                                     
150         {
151          /* desktop */
152           if (szOut) strncpy(szOut, "Desktop", uOutSize);
153           dwReturn = strlen ("Desktop");
154         }
155         else if (( szSrc = _dbg_ILGetTextPointer(pidl) ))
156         {
157           /* filesystem */
158           if (szOut) strncpy(szOut, szSrc, uOutSize);
159           dwReturn = strlen(szSrc);
160         }
161         else if (( riid = _dbg_ILGetGUIDPointer(pidl) ))
162         {
163           if (szOut)
164             sprintf( szOut, "{%08lx-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
165                  riid->Data1, riid->Data2, riid->Data3,
166                  riid->Data4[0], riid->Data4[1], riid->Data4[2], riid->Data4[3],
167                  riid->Data4[4], riid->Data4[5], riid->Data4[6], riid->Data4[7] );
168           dwReturn = strlen (szTemp);
169         }
170         else
171         {
172           ERR("-- no text\n");
173         }
174         return dwReturn;
175 }
176
177
178
179
180 void pdump (LPCITEMIDLIST pidl)
181 {
182         LPITEMIDLIST pidltemp = pidl;
183
184         if (!TRACE_ON(pidl)) return;
185
186         if (! pidltemp)
187         {
188           MESSAGE ("-------- pidl=NULL (Desktop)\n");
189         }
190         else
191         {
192           MESSAGE ("-------- pidl=%p\n", pidl);
193           if (pidltemp->mkid.cb)
194           { 
195             do
196             {
197               DWORD dwAttrib = 0;
198               LPPIDLDATA pData   = _dbg_ILGetDataPointer(pidltemp);
199               DWORD type         = pData->type;
200               LPSTR szLongName   = _dbg_ILGetTextPointer(pidltemp);
201               LPSTR szShortName  = _dbg_ILGetSTextPointer(pidltemp);
202               char szName[MAX_PATH];
203
204               _dbg_ILSimpleGetText(pidltemp, szName, MAX_PATH);
205               if( PT_FOLDER == type)
206                 dwAttrib = pData->u.folder.uFileAttribs;
207               else if( PT_VALUE == type)
208                 dwAttrib = pData->u.file.uFileAttribs;
209
210               MESSAGE ("-- pidl=%p size=%u type=%lx attr=0x%08lx name=%s (%s,%s)\n",
211                        pidltemp, pidltemp->mkid.cb,type,dwAttrib,szName,debugstr_a(szLongName), debugstr_a(szShortName));
212
213               pidltemp = _dbg_ILGetNext(pidltemp);
214
215             } while (pidltemp->mkid.cb);
216           }
217           else
218           {
219             MESSAGE ("empty pidl (Desktop)\n");
220           }
221           pcheck(pidl);
222         }
223 }
224 #define BYTES_PRINTED 32
225 BOOL pcheck (LPCITEMIDLIST pidl)
226 {
227         DWORD type, ret=TRUE;
228         LPITEMIDLIST pidltemp = pidl;
229
230         if (pidltemp && pidltemp->mkid.cb)
231         { do
232           { type   = _dbg_ILGetDataPointer(pidltemp)->type;
233             switch (type)
234             { case PT_DESKTOP:
235               case PT_MYCOMP:
236               case PT_SPECIAL:
237               case PT_DRIVE:
238               case PT_DRIVE1:
239               case PT_DRIVE2:
240               case PT_DRIVE3:
241               case PT_FOLDER:
242               case PT_VALUE:
243               case PT_FOLDER1:
244               case PT_WORKGRP:
245               case PT_COMP:
246               case PT_NETWORK:
247               case PT_IESPECIAL1:
248               case PT_IESPECIAL2:
249               case PT_SHARE:
250                 break;
251               default:
252               {
253                 char szTemp[BYTES_PRINTED*4 + 1];
254                 int i;
255                 unsigned char c;
256
257                 memset(szTemp, ' ', BYTES_PRINTED*4 + 1);
258                 for ( i = 0; (i<pidltemp->mkid.cb) && (i<BYTES_PRINTED); i++)
259                 {
260                   c = ((unsigned char *)pidltemp)[i];
261
262                   szTemp[i*3+0] = ((c>>4)>9)? (c>>4)+55 : (c>>4)+48;
263                   szTemp[i*3+1] = ((0x0F&c)>9)? (0x0F&c)+55 : (0x0F&c)+48;
264                   szTemp[i*3+2] = ' ';
265                   szTemp[i+BYTES_PRINTED*3]  =  (c>=0x20 && c <=0x80) ? c : '.';
266                 }
267                 szTemp[BYTES_PRINTED*4] = 0x00;
268                 ERR("unknown IDLIST type size=%u type=%lx\n%s\n",pidltemp->mkid.cb,type, szTemp);
269                 ret = FALSE;
270               }
271             }
272             pidltemp = _dbg_ILGetNext(pidltemp);
273           } while (pidltemp->mkid.cb);
274         }
275         return ret;
276 }