improved exception handling
[wine] / debugger / info.c
1 /*
2  * Wine debugger utility routines
3  *
4  * Copyright 1993 Eric Youngdale
5  * Copyright 1995 Alexandre Julliard
6  */
7
8 #include "config.h"
9 #include <stdio.h>
10 #include <stdlib.h>
11 #include <string.h>
12 #include "winbase.h"
13 #include "wingdi.h"
14 #include "winuser.h"
15 #include "toolhelp.h"
16 #include "debugger.h"
17 #include "expr.h"
18
19 /***********************************************************************
20  *           DEBUG_PrintBasic
21  *
22  * Implementation of the 'print' command.
23  */
24 void DEBUG_PrintBasic( const DBG_VALUE* value, int count, char format )
25 {
26   char        * default_format;
27   long long int res;
28
29   assert(value->cookie == DV_TARGET || value->cookie == DV_HOST);
30   if( value->type == NULL ) 
31     {
32       fprintf(stderr, "Unable to evaluate expression\n");
33       return;
34     }
35   
36   default_format = NULL;
37   res = DEBUG_GetExprValue(value, &default_format);
38
39   switch(format)
40     {
41     case 'x':
42       if (value->addr.seg) 
43         {
44           DEBUG_nchar += fprintf( stderr, "0x%04lx", (long unsigned int) res );
45         }
46       else 
47         {
48           DEBUG_nchar += fprintf( stderr, "0x%08lx", (long unsigned int) res );
49         }
50       break;
51       
52     case 'd':
53       DEBUG_nchar += fprintf( stderr, "%ld\n", (long int) res );
54       break;
55       
56     case 'c':
57       DEBUG_nchar += fprintf( stderr, "%d = '%c'",
58                               (char)(res & 0xff), (char)(res & 0xff) );
59       break;
60       
61     case 'i':
62     case 's':
63     case 'w':
64     case 'b':
65       fprintf( stderr, "Format specifier '%c' is meaningless in 'print' command\n", format );
66     case 0:
67       if( default_format != NULL )
68         {
69           if (strstr(default_format, "%S") == NULL)
70             {
71                DEBUG_nchar += fprintf( stderr, default_format, res );
72             } 
73           else
74             {
75                char*    ptr;
76                int      state = 0;
77
78                /* FIXME: simplistic implementation for default_format being
79                 * foo%Sbar => will print foo, then string then bar
80                 */
81                for (ptr = default_format; *ptr; ptr++) 
82                {
83                   fprintf(stderr, "[%c]", *ptr);
84
85                   if (*ptr == '%') state++;
86                   else if (state == 1) 
87                     {
88                        if (*ptr == 'S') 
89                          {
90                             char        ch;
91                             char*       str = (char*)(long)res;
92
93                             for (; DEBUG_READ_MEM(str, &ch, 1) && ch; str++) {
94                                fputc(ch, stderr);
95                                DEBUG_nchar++;
96                             }
97                          }
98                        else 
99                          {
100                             /* shouldn't happen */
101                             fputc('%', stderr);
102                             fputc(*ptr, stderr);
103                             DEBUG_nchar += 2;
104                          }
105                        state = 0;
106                     }
107                   else
108                     {
109                        fputc(*ptr, stderr);
110                        DEBUG_nchar++;
111                     }
112                }
113             } 
114         }
115       break;
116     }
117 }
118
119
120 /***********************************************************************
121  *           DEBUG_PrintAddress
122  *
123  * Print an 16- or 32-bit address, with the nearest symbol if any.
124  */
125 struct symbol_info
126 DEBUG_PrintAddress( const DBG_ADDR *addr, int addrlen, int flag )
127 {
128     struct symbol_info rtn;
129
130     const char *name = DEBUG_FindNearestSymbol( addr, flag, &rtn.sym, 0, 
131                                                 &rtn.list );
132
133     if (addr->seg) fprintf( stderr, "0x%04lx:", addr->seg&0xFFFF );
134     if (addrlen == 16) fprintf( stderr, "0x%04lx", addr->off );
135     else fprintf( stderr, "0x%08lx", addr->off );
136     if (name) fprintf( stderr, " (%s)", name );
137     return rtn;
138 }
139 /***********************************************************************
140  *           DEBUG_PrintAddressAndArgs
141  *
142  * Print an 16- or 32-bit address, with the nearest symbol if any.
143  * Similar to DEBUG_PrintAddress, but we print the arguments to
144  * each function (if known).  This is useful in a backtrace.
145  */
146 struct symbol_info
147 DEBUG_PrintAddressAndArgs( const DBG_ADDR *addr, int addrlen, 
148                            unsigned int ebp, int flag )
149 {
150     struct symbol_info rtn;
151
152     const char *name = DEBUG_FindNearestSymbol( addr, flag, &rtn.sym, ebp, 
153                                                 &rtn.list );
154
155     if (addr->seg) fprintf( stderr, "0x%04lx:", addr->seg );
156     if (addrlen == 16) fprintf( stderr, "0x%04lx", addr->off );
157     else fprintf( stderr, "0x%08lx", addr->off );
158     if (name) fprintf( stderr, " (%s)", name );
159
160     return rtn;
161 }
162
163
164 /***********************************************************************
165  *           DEBUG_Help
166  *
167  * Implementation of the 'help' command.
168  */
169 void DEBUG_Help(void)
170 {
171     int i = 0;
172     static const char * const helptext[] =
173 {
174 "The commands accepted by the Wine debugger are a reasonable",
175 "subset of the commands that gdb accepts.",
176 "The commands currently are:",
177 "  help                                   quit",
178 "  break [*<addr>]                        delete break bpnum",
179 "  disable bpnum                          enable bpnum",
180 "  condition <bpnum> [<expr>]             pass",
181 "  bt                                     cont [N]",
182 "  step [N]                               next [N]",
183 "  stepi [N]                              nexti [N]",
184 "  x <addr>                               print <expr>",
185 "  set <reg> = <expr>                     set *<addr> = <expr>",
186 "  up                                     down",
187 "  list <lines>                           disassemble [<addr>][,<addr>]",
188 "  frame <n>                              finish",
189 "  show dir                               dir <path>",
190 "  display <expr>                         undisplay <disnum>",
191 "  delete display <disnum>                debugmsg <class>[-+]<type>\n",
192 "  mode [16,32]                           walk [wnd,class,queue,module,",
193 "  whatis                                       process,modref <pid>]",
194 "  info (see 'help info' for options)\n",
195
196 "The 'x' command accepts repeat counts and formats (including 'i') in the",
197 "same way that gdb does.\n",
198
199 " The following are examples of legal expressions:",
200 " $eax     $eax+0x3   0x1000   ($eip + 256)  *$eax   *($esp + 3)",
201 " Also, a nm format symbol table can be read from a file using the",
202 " symbolfile command.  Symbols can also be defined individually with",
203 " the define command.",
204 "",
205 NULL
206 };
207
208     while(helptext[i]) fprintf(stderr,"%s\n", helptext[i++]);
209 }
210
211
212 /***********************************************************************
213  *           DEBUG_HelpInfo
214  *
215  * Implementation of the 'help info' command.
216  */
217 void DEBUG_HelpInfo(void)
218 {
219     int i = 0;
220     static const char * const infotext[] =
221 {
222 "The info commands allow you to get assorted bits of interesting stuff",
223 "to be displayed.  The options are:",
224 "  info break           Dumps information about breakpoints",
225 "  info display         Shows auto-display expressions in use",
226 "  info locals          Displays values of all local vars for current frame",
227 "  info maps            Dumps all virtual memory mappings",
228 "  info module <handle> Displays internal module state",
229 "  info queue <handle>  Displays internal queue state",
230 "  info reg             Displays values in all registers at top of stack",
231 "  info segments        Dumps information about all known segments",
232 "  info share           Dumps information about shared libraries",
233 "  info stack           Dumps information about top of stack",
234 "  info wnd <handle>    Displays internal window state",
235 "",
236 NULL
237 };
238
239     while(infotext[i]) fprintf(stderr,"%s\n", infotext[i++]);
240 }
241
242 /* FIXME: merge InfoClass and InfoClass2 */
243 void DEBUG_InfoClass(const char* name)
244 {
245    WNDCLASSEXA  wca;
246
247    if (!GetClassInfoExA(0, name, &wca)) {
248       fprintf(stderr, "Cannot find class '%s'\n", name);
249       return;
250    }
251
252    fprintf(stderr,  "Class '%s':\n", name);
253    fprintf(stderr,  
254            "style=%08x  wndProc=%08lx\n"
255            "inst=%04x  icon=%04x  cursor=%04x  bkgnd=%04x\n"
256            "clsExtra=%d  winExtra=%d\n",
257            wca.style, (DWORD)wca.lpfnWndProc, wca.hInstance,
258            wca.hIcon, wca.hCursor, wca.hbrBackground,
259            wca.cbClsExtra, wca.cbWndExtra);
260
261    /* FIXME: 
262     * + print #windows (or even list of windows...)
263     * + print extra bytes => this requires a window handle on this very class...
264     */
265 }
266
267 static  void DEBUG_InfoClass2(HWND hWnd, const char* name)
268 {
269    WNDCLASSEXA  wca;
270
271    if (!GetClassInfoExA(GetWindowLongA(hWnd, GWL_HINSTANCE), name, &wca)) {
272       fprintf(stderr, "Cannot find class '%s'\n", name);
273       return;
274    }
275
276    fprintf(stderr,  "Class '%s':\n", name);
277    fprintf(stderr,  
278            "style=%08x  wndProc=%08lx\n"
279            "inst=%04x  icon=%04x  cursor=%04x  bkgnd=%04x\n"
280            "clsExtra=%d  winExtra=%d\n",
281            wca.style, (DWORD)wca.lpfnWndProc, wca.hInstance,
282            wca.hIcon, wca.hCursor, wca.hbrBackground,
283            wca.cbClsExtra, wca.cbWndExtra);
284
285    if (wca.cbClsExtra) {
286       int               i;
287       WORD              w;
288
289       fprintf(stderr,  "Extra bytes:" );
290       for (i = 0; i < wca.cbClsExtra / 2; i++) {
291          w = GetClassWord(hWnd, i * 2);
292          /* FIXME: depends on i386 endian-ity */
293          fprintf(stderr,  " %02x", HIBYTE(w));
294          fprintf(stderr,  " %02x", LOBYTE(w));
295       }
296       fprintf(stderr,  "\n" );
297     }
298     fprintf(stderr,  "\n" );
299 }
300
301 struct class_walker {
302    ATOM*        table;
303    int          used;
304    int          alloc;
305 };
306
307 static  void DEBUG_WalkClassesHelper(HWND hWnd, struct class_walker* cw)
308 {
309    char clsName[128];
310    int  i;
311    ATOM atom;
312    HWND child;
313
314    if (!GetClassNameA(hWnd, clsName, sizeof(clsName)))
315       return;
316    if ((atom = FindAtomA(clsName)) == 0)
317       return;
318
319    for (i = 0; i < cw->used; i++) {
320       if (cw->table[i] == atom)
321          break;
322    }
323    if (i == cw->used) {
324       if (cw->used >= cw->alloc) {
325          cw->alloc += 16;
326          cw->table = DBG_realloc(cw->table, cw->alloc * sizeof(ATOM));
327       }
328       cw->table[cw->used++] = atom;
329       DEBUG_InfoClass2(hWnd, clsName);
330    }
331    do {
332       if ((child = GetWindow(hWnd, GW_CHILD)) != 0)
333          DEBUG_WalkClassesHelper(child, cw);
334    } while ((hWnd = GetWindow(hWnd, GW_HWNDNEXT)) != 0);
335 }
336
337 void DEBUG_WalkClasses(void)
338 {
339    struct class_walker cw;
340
341    cw.table = NULL;
342    cw.used = cw.alloc = 0;
343    DEBUG_WalkClassesHelper(GetDesktopWindow(), &cw);
344    DBG_free(cw.table);
345 }
346
347 void DEBUG_DumpQueue(DWORD q)
348 {
349    fprintf(stderr, "No longer doing info queue '0x%08lx'\n", q);
350 }
351
352 void DEBUG_WalkQueues(void)
353 {
354    fprintf(stderr, "No longer walking queues list\n");
355 }
356
357 void DEBUG_InfoWindow(HWND hWnd)
358 {
359    char clsName[128];
360    char wndName[128];
361    RECT clientRect;
362    RECT windowRect;
363    int  i;
364    WORD w;
365
366    if (!GetClassNameA(hWnd, clsName, sizeof(clsName)))
367        strcpy(clsName, "-- Unknown --");
368    if (!GetWindowTextA(hWnd, wndName, sizeof(wndName)))
369       strcpy(wndName, "-- Empty --");
370    if (!GetClientRect(hWnd, &clientRect))
371       SetRectEmpty(&clientRect);
372    if (!GetWindowRect(hWnd, &windowRect))
373       SetRectEmpty(&windowRect);
374
375    /* FIXME missing fields: hmemTaskQ, hrgnUpdate, dce, flags, pProp, scroll */
376    fprintf(stderr,
377            "next=0x%04x  child=0x%04x  parent=0x%04x  owner=0x%04x  class='%s'\n"
378            "inst=%08lx  active=%04x  idmenu=%08lx\n"
379            "style=%08lx  exstyle=%08lx  wndproc=%08lx  text='%s'\n"
380            "client=%d,%d-%d,%d  window=%d,%d-%d,%d sysmenu=%04x\n",
381            GetWindow(hWnd, GW_HWNDNEXT), 
382            GetWindow(hWnd, GW_CHILD),
383            GetParent(hWnd), 
384            GetWindow(hWnd, GW_OWNER),
385            clsName,
386            GetWindowLongA(hWnd, GWL_HINSTANCE), 
387            GetLastActivePopup(hWnd),
388            GetWindowLongA(hWnd, GWL_ID),
389            GetWindowLongA(hWnd, GWL_STYLE),
390            GetWindowLongA(hWnd, GWL_EXSTYLE),
391            GetWindowLongA(hWnd, GWL_WNDPROC),
392            wndName, 
393            clientRect.left, clientRect.top, clientRect.right, clientRect.bottom, 
394            windowRect.left, windowRect.top, windowRect.right, windowRect.bottom, 
395            GetSystemMenu(hWnd, FALSE));
396
397     if (GetClassLongA(hWnd, GCL_CBWNDEXTRA)) {
398         fprintf(stderr,  "Extra bytes:" );
399         for (i = 0; i < GetClassLongA(hWnd, GCL_CBWNDEXTRA) / 2; i++) {
400            w = GetWindowWord(hWnd, i * 2);
401            /* FIXME: depends on i386 endian-ity */
402            fprintf(stderr,  " %02x", HIBYTE(w));
403            fprintf(stderr,  " %02x", LOBYTE(w));
404         }
405         fprintf(stderr, "\n");
406     }
407     fprintf(stderr, "\n");
408 }
409
410 void DEBUG_WalkWindows(HWND hWnd, int indent)
411 {
412    char clsName[128];
413    char wndName[128];
414    HWND child;
415
416    if (!IsWindow(hWnd))
417       hWnd = GetDesktopWindow();
418
419     if (!indent)  /* first time around */
420        fprintf(stderr,  
421                "%-16.16s %-17.17s %-8.8s %s\n",
422                "hwnd", "Class Name", " Style", " WndProc Text");
423
424     do {
425        if (!GetClassNameA(hWnd, clsName, sizeof(clsName)))
426           strcpy(clsName, "-- Unknown --");
427        if (!GetWindowTextA(hWnd, wndName, sizeof(wndName)))
428           strcpy(wndName, "-- Empty --");
429        
430        /* FIXME: missing hmemTaskQ */
431        fprintf(stderr, "%*s%04x%*s", indent, "", hWnd, 13-indent,"");
432        fprintf(stderr, "%-17.17s %08lx %08lx %.14s\n",
433                clsName, GetWindowLongA(hWnd, GWL_STYLE),
434                GetWindowLongA(hWnd, GWL_WNDPROC), wndName);
435
436        if ((child = GetWindow(hWnd, GW_CHILD)) != 0)
437           DEBUG_WalkWindows(child, indent + 1 );
438     } while ((hWnd = GetWindow(hWnd, GW_HWNDNEXT)) != 0);
439 }
440
441 void DEBUG_WalkProcess(void)
442 {
443    fprintf(stderr, "No longer walking processes list\n");
444 }
445
446 void DEBUG_WalkModref(DWORD p)
447 {
448    fprintf(stderr, "No longer walking module references list\n");
449 }
450
451 void DEBUG_InfoSegments(DWORD start, int length)
452 {
453     char        flags[3];
454     DWORD       i;
455     LDT_ENTRY   le;
456
457     if (length == -1) length = (8192 - start);
458
459     for (i = start; i < start + length; i++)
460     {
461        if (!GetThreadSelectorEntry(DEBUG_CurrThread->handle, (i << 3)|7, &le))
462           continue;
463
464         if (le.HighWord.Bits.Type & 0x08) 
465         {
466             flags[0] = (le.HighWord.Bits.Type & 0x2) ? 'r' : '-';
467             flags[1] = '-';
468             flags[2] = 'x';
469         }
470         else
471         {
472             flags[0] = 'r';
473             flags[1] = (le.HighWord.Bits.Type & 0x2) ? 'w' : '-';
474             flags[2] = '-';
475         }
476         fprintf(stderr, 
477                 "%04lx: sel=%04lx base=%08x limit=%08x %d-bit %c%c%c\n",
478                 i, (i<<3)|7, 
479                 (le.HighWord.Bits.BaseHi << 24) + 
480                     (le.HighWord.Bits.BaseMid << 16) + le.BaseLow,
481                 ((le.HighWord.Bits.LimitHi << 8) + le.LimitLow) << 
482                     (le.HighWord.Bits.Granularity ? 12 : 0),
483                 le.HighWord.Bits.Default_Big ? 32 : 16,
484                 flags[0], flags[1], flags[2] );
485     }
486 }
487
488 void DEBUG_InfoVirtual(void)
489 {
490    fprintf(stderr, "No longer providing virtual mapping information\n");
491 }