winedbg: Add Dutch translations.
[wine] / programs / winedbg / source.c
1 /*
2  * File source.c - source file handling for internal debugger.
3  *
4  * Copyright (C) 1997, Eric Youngdale.
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #include "config.h"
22 #include <stdio.h>
23 #include <stdlib.h>
24
25 #include "debugger.h"
26
27 struct open_file_list
28 {
29     char*                       path;
30     char*                       real_path;
31     struct open_file_list*      next;
32     unsigned int                size;
33     signed int                  nlines;
34     unsigned int*               linelist;
35 };
36
37 void source_show_path(void)
38 {
39     const char* ptr;
40     const char* next;
41
42     dbg_printf("Search list:\n");
43     for (ptr = dbg_curr_process->search_path; ptr; ptr = next)
44     {
45         next = strchr(ptr, ';');
46         if (next)
47             dbg_printf("\t%.*s\n", next++ - ptr, ptr);
48         else
49             dbg_printf("\t%s\n", ptr);
50     }
51     dbg_printf("\n");
52 }
53
54 void source_add_path(const char* path)
55 {
56     char*       new;
57     unsigned    size;
58
59     size = strlen(path) + 1;
60     if (dbg_curr_process->search_path)
61     {
62         unsigned pos = strlen(dbg_curr_process->search_path) + 1;
63         new = HeapReAlloc(GetProcessHeap(), 0, dbg_curr_process->search_path, pos + size);
64         if (!new) return;
65         new[pos - 1] = ';';
66         strcpy(&new[pos], path);
67     }
68     else
69     {
70         new = HeapAlloc(GetProcessHeap(), 0, size);
71         if (!new) return;
72         strcpy(new, path);
73     }
74     dbg_curr_process->search_path = new;
75 }
76
77 void source_nuke_path(struct dbg_process* p)
78 {
79     HeapFree(GetProcessHeap(), 0, p->search_path);
80     p->search_path = NULL;
81 }
82
83 static  void*   source_map_file(const char* name, HANDLE* hMap, unsigned* size)
84 {
85     HANDLE              hFile;
86
87     hFile = CreateFile(name, GENERIC_READ, FILE_SHARE_READ, NULL,
88                        OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
89     if (hFile == INVALID_HANDLE_VALUE) return (void*)-1;
90     if (size != NULL && (*size = GetFileSize(hFile, NULL)) == -1) return (void*)-1;
91     *hMap = CreateFileMapping(hFile, NULL, PAGE_READONLY, 0, 0, NULL);
92     CloseHandle(hFile);
93     if (!*hMap) return (void*)-1;
94     return MapViewOfFile(*hMap, FILE_MAP_READ, 0, 0, 0);
95 }
96
97 static void     source_unmap_file(void* addr, HANDLE hMap)
98 {
99     UnmapViewOfFile(addr);
100     CloseHandle(hMap);
101 }
102
103 static struct open_file_list* source_search_open_file(const char* name)
104 {
105     struct open_file_list*      ol;
106
107     for (ol = dbg_curr_process->source_ofiles; ol; ol = ol->next)
108     {
109         if (strcmp(ol->path, name) == 0) break;
110     }
111     return ol;
112 }
113
114 static BOOL     source_locate_file(const char* srcfile, char* path)
115 {
116     BOOL        found = FALSE;
117
118     if (GetFileAttributes(srcfile) != INVALID_FILE_ATTRIBUTES)
119     {
120         strcpy(path, srcfile);
121         found = TRUE;
122     }
123     else if (dbg_curr_process->search_path)
124     {
125         const char* spath;
126
127         spath = srcfile;
128         while (!found)
129         {
130             while (*spath && *spath != '/' && *spath != '\\') spath++;
131             if (!*spath) break;
132             spath++;
133             found = SearchPathA(dbg_curr_process->search_path, spath, NULL, MAX_PATH, path, NULL);
134         }
135     }
136     return found;
137 }
138
139 static struct open_file_list* source_add_file(const char* name, const char* realpath)
140 {
141     struct open_file_list*      ol;
142     size_t                      sz, nlen;
143
144     sz = sizeof(*ol);
145     nlen = strlen(name) + 1;
146     if (realpath) sz += strlen(realpath) + 1;
147     ol = HeapAlloc(GetProcessHeap(), 0, sz + nlen);
148     if (!ol) return NULL;
149     strcpy(ol->path = (char*)(ol + 1), name);
150     if (realpath)
151         strcpy(ol->real_path = ol->path + nlen, realpath);
152     else
153         ol->real_path = NULL;
154     ol->next = dbg_curr_process->source_ofiles;
155     ol->nlines = 0;
156     ol->linelist = NULL;
157     ol->size = 0;
158     return dbg_curr_process->source_ofiles = ol;
159 }
160
161 static int source_display(const char* sourcefile, int start, int end)
162 {
163     char*                       addr;
164     int                         i;
165     struct open_file_list*      ol;
166     int                         nlines;
167     const char*                 basename = NULL;
168     char*                       pnt;
169     int                         rtn;
170     HANDLE                      hMap;
171     char                        tmppath[MAX_PATH];
172
173     /*
174      * First see whether we have the file open already.  If so, then
175      * use that, otherwise we have to try and open it.
176      */
177     ol = source_search_open_file(sourcefile);
178
179     if (ol == NULL)
180     {
181         /*
182          * Try again, stripping the path from the opened file.
183          */
184         basename = strrchr(sourcefile, '\\');
185         if (!basename) basename = strrchr(sourcefile, '/');
186         if (!basename) basename = sourcefile;
187         else basename++;
188
189         ol = source_search_open_file(basename);
190     }
191
192     if (ol == NULL)
193     {
194         /*
195          * Crapola.  We need to try and open the file.
196          */
197         if (!source_locate_file(sourcefile, tmppath))
198         {
199             if (dbg_interactiveP)
200             {
201                 char zbuf[256];
202                 /*
203                  * Still couldn't find it.  Ask user for path to add.
204                  */
205                 snprintf(zbuf, sizeof(zbuf), "Enter path to file '%s': ", sourcefile);
206                 input_read_line(zbuf, tmppath, sizeof(tmppath));
207
208                 if (tmppath[strlen(tmppath) - 1] != '/')
209                 {
210                     strcat(tmppath, "/");
211                 }
212                 /*
213                  * Now append the base file name.
214                  */
215                 strcat(tmppath, basename);
216             }
217             else tmppath[0] = '\0';
218
219             if (GetFileAttributes(tmppath) == INVALID_FILE_ATTRIBUTES)
220             {
221                 /*
222                  * OK, I guess the user doesn't really want to see it
223                  * after all.
224                  */
225                 ol = source_add_file(sourcefile, NULL);
226                 dbg_printf("Unable to open file '%s'\n", tmppath);
227                 return FALSE;
228             }
229         }
230         /*
231          * Create header for file.
232          */
233         ol = source_add_file(sourcefile, tmppath);
234
235         addr = source_map_file(tmppath, &hMap, &ol->size);
236         if (addr == (char*)-1) return FALSE;
237         /*
238          * Now build up the line number mapping table.
239          */
240         ol->nlines = 1;
241         pnt = addr;
242         while (pnt < addr + ol->size)
243         {
244             if (*pnt++ == '\n') ol->nlines++;
245         }
246
247         ol->nlines++;
248         ol->linelist = HeapAlloc(GetProcessHeap(), 0, ol->nlines * sizeof(unsigned int));
249
250         nlines = 0;
251         pnt = addr;
252         ol->linelist[nlines++] = 0;
253         while (pnt < addr + ol->size)
254         {
255             if (*pnt++ == '\n') ol->linelist[nlines++] = pnt - addr;
256         }
257         ol->linelist[nlines++] = pnt - addr;
258
259     }
260     else
261     {
262         addr = source_map_file(ol->real_path, &hMap, NULL);
263         if (addr == (char*)-1) return FALSE;
264     }
265     /*
266      * All we need to do is to display the source lines here.
267      */
268     rtn = FALSE;
269     for (i = start - 1; i <= end - 1; i++)
270     {
271         char    buffer[1024];
272
273         if (i < 0 || i >= ol->nlines - 1) continue;
274
275         rtn = TRUE;
276         memset(&buffer, 0, sizeof(buffer));
277         if (ol->linelist[i+1] != ol->linelist[i])
278         {
279             memcpy(&buffer, addr + ol->linelist[i],
280                    (ol->linelist[i+1] - ol->linelist[i]) - 1);
281         }
282         dbg_printf("%d\t%s\n", i + 1, buffer);
283     }
284
285     source_unmap_file(addr, hMap);
286     return rtn;
287 }
288
289 void source_list(IMAGEHLP_LINE* src1, IMAGEHLP_LINE* src2, int delta)
290 {
291     int         end;
292     int         start;
293     const char* sourcefile;
294
295     /*
296      * We need to see what source file we need.  Hopefully we only have
297      * one specified, otherwise we might as well punt.
298      */
299     if (src1 && src2 && src1->FileName && src2->FileName &&
300         strcmp(src1->FileName, src2->FileName) != 0)
301     {
302         dbg_printf("Ambiguous source file specification.\n");
303         return;
304     }
305
306     sourcefile = NULL;
307     if (src1 && src1->FileName) sourcefile = src1->FileName;
308     if (!sourcefile && src2 && src2->FileName) sourcefile = src2->FileName;
309     if (!sourcefile) sourcefile = dbg_curr_process->source_current_file;
310
311     /*
312      * Now figure out the line number range to be listed.
313      */
314     start = end = -1;
315
316     if (src1) start = src1->LineNumber;
317     if (src2) end   = src2->LineNumber;
318     if (start == -1 && end == -1)
319     {
320         if (delta < 0)
321         {
322             end = dbg_curr_process->source_start_line;
323             start = end + delta;
324         }
325         else
326         {
327             start = dbg_curr_process->source_end_line;
328             end = start + delta;
329         }
330     }
331     else if (start == -1) start = end + delta;
332     else if (end == -1)   end = start + delta;
333
334     /*
335      * Now call this function to do the dirty work.
336      */
337     source_display(sourcefile, start, end);
338
339     if (sourcefile != dbg_curr_process->source_current_file)
340         strcpy(dbg_curr_process->source_current_file, sourcefile);
341     dbg_curr_process->source_start_line = start;
342     dbg_curr_process->source_end_line = end;
343 }
344
345 void source_list_from_addr(const ADDRESS64* addr, int nlines)
346 {
347     IMAGEHLP_LINE       il;
348     ADDRESS64           la;
349     DWORD               disp;
350
351     if (!addr)
352     {
353         memory_get_current_pc(&la);
354         addr = &la;
355     }
356
357     il.SizeOfStruct = sizeof(il);
358     if (SymGetLineFromAddr(dbg_curr_process->handle,
359                            (unsigned long)memory_to_linear_addr(addr),
360                            &disp, &il))
361         source_list(&il, NULL, nlines);
362 }
363
364 void source_free_files(struct dbg_process* p)
365 {
366     struct open_file_list*      ofile;
367     struct open_file_list*      ofile_next;
368
369     for (ofile = p->source_ofiles; ofile; ofile = ofile_next)
370     {
371         ofile_next = ofile->next;
372         HeapFree(GetProcessHeap(), 0, ofile->linelist);
373         HeapFree(GetProcessHeap(), 0, ofile);
374     }
375 }