1 /* TUI display locator.
3 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2006, 2007, 2008,
4 2009 Free Software Foundation, Inc.
6 Contributed by Hewlett-Packard Company.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
25 #include "breakpoint.h"
31 #include "gdb_string.h"
33 #include "tui/tui-data.h"
34 #include "tui/tui-stack.h"
35 #include "tui/tui-wingeneral.h"
36 #include "tui/tui-source.h"
37 #include "tui/tui-winsource.h"
38 #include "tui/tui-file.h"
40 #include "gdb_curses.h"
42 /* Get a printable name for the function at the address.
43 The symbol name is demangled if demangling is turned on.
44 Returns a pointer to a static area holding the result. */
45 static char *tui_get_function_from_frame (struct frame_info *fi);
47 /* Set the filename portion of the locator. */
48 static void tui_set_locator_filename (const char *filename);
50 /* Update the locator, with the provided arguments. */
51 static void tui_set_locator_info (const char *filename,
53 int lineno, CORE_ADDR addr);
55 static void tui_update_command (char *, int);
58 /* Create the status line to display as much information as we can on
59 this single line: target name, process number, current function,
60 current line, current PC, SingleKey mode. */
62 tui_make_status_line (struct tui_locator_element *loc)
65 char line_buf[50], *pname;
75 struct ui_file *pc_out;
77 if (ptid_equal (inferior_ptid, null_ptid))
78 pid_name = "No process";
80 pid_name = target_pid_to_str (inferior_ptid);
82 target_width = strlen (target_shortname);
83 if (target_width > MAX_TARGET_WIDTH)
84 target_width = MAX_TARGET_WIDTH;
86 pid_width = strlen (pid_name);
87 if (pid_width > MAX_PID_WIDTH)
88 pid_width = MAX_PID_WIDTH;
90 status_size = tui_term_width ();
91 string = (char *) xmalloc (status_size + 1);
92 buf = (char*) alloca (status_size + 1);
94 /* Translate line number and obtain its size. */
96 sprintf (line_buf, "%d", loc->line_no);
98 strcpy (line_buf, "??");
99 line_width = strlen (line_buf);
100 if (line_width < MIN_LINE_WIDTH)
101 line_width = MIN_LINE_WIDTH;
103 /* Translate PC address. */
104 pc_out = tui_sfileopen (128);
105 fputs_filtered (paddress (loc->addr), pc_out);
106 pc_buf = tui_file_get_strbuf (pc_out);
107 pc_width = strlen (pc_buf);
109 /* First determine the amount of proc name width we have available.
110 The +1 are for a space separator between fields.
111 The -1 are to take into account the \0 counted by sizeof. */
112 proc_width = (status_size
115 - (sizeof (PROC_PREFIX) - 1 + 1)
116 - (sizeof (LINE_PREFIX) - 1 + line_width + 1)
117 - (sizeof (PC_PREFIX) - 1 + pc_width + 1)
118 - (tui_current_key_mode == TUI_SINGLE_KEY_MODE
119 ? (sizeof (SINGLE_KEY) - 1 + 1)
122 /* If there is no room to print the function name, try by removing
124 if (proc_width < MIN_PROC_WIDTH)
126 proc_width += target_width + 1;
128 if (proc_width < MIN_PROC_WIDTH)
130 proc_width += pid_width + 1;
132 if (proc_width <= MIN_PROC_WIDTH)
134 proc_width += pc_width + sizeof (PC_PREFIX) - 1 + 1;
138 proc_width += line_width + sizeof (LINE_PREFIX) - 1 + 1;
147 /* Now convert elements to string form. */
148 pname = loc->proc_name;
150 /* Now create the locator line from the string version of the
151 elements. We could use sprintf() here but that wouldn't ensure
152 that we don't overrun the size of the allocated buffer.
153 strcat_to_buf() will. */
156 if (target_width > 0)
158 sprintf (buf, "%*.*s ",
159 -target_width, target_width, target_shortname);
160 strcat_to_buf (string, status_size, buf);
164 sprintf (buf, "%*.*s ",
165 -pid_width, pid_width, pid_name);
166 strcat_to_buf (string, status_size, buf);
169 /* Show whether we are in SingleKey mode. */
170 if (tui_current_key_mode == TUI_SINGLE_KEY_MODE)
172 strcat_to_buf (string, status_size, SINGLE_KEY);
173 strcat_to_buf (string, status_size, " ");
176 /* Procedure/class name. */
179 if (strlen (pname) > proc_width)
180 sprintf (buf, "%s%*.*s* ", PROC_PREFIX,
181 1 - proc_width, proc_width - 1, pname);
183 sprintf (buf, "%s%*.*s ", PROC_PREFIX,
184 -proc_width, proc_width, pname);
185 strcat_to_buf (string, status_size, buf);
190 sprintf (buf, "%s%*.*s ", LINE_PREFIX,
191 -line_width, line_width, line_buf);
192 strcat_to_buf (string, status_size, buf);
196 strcat_to_buf (string, status_size, PC_PREFIX);
197 strcat_to_buf (string, status_size, pc_buf);
201 for (i = strlen (string); i < status_size; i++)
203 string[status_size] = (char) 0;
205 ui_file_delete (pc_out);
209 /* Get a printable name for the function at the address. The symbol
210 name is demangled if demangling is turned on. Returns a pointer to
211 a static area holding the result. */
213 tui_get_function_from_frame (struct frame_info *fi)
215 static char name[256];
216 struct ui_file *stream = tui_sfileopen (256);
219 print_address_symbolic (get_frame_pc (fi), stream, demangle, "");
220 p = tui_file_get_strbuf (stream);
222 /* Use simple heuristics to isolate the function name. The symbol
223 can be demangled and we can have function parameters. Remove
224 them because the status line is too short to display them. */
227 strncpy (name, p, sizeof (name));
228 p = strchr (name, '(');
230 p = strchr (name, '>');
233 p = strchr (name, '+');
236 ui_file_delete (stream);
241 tui_show_locator_content (void)
244 struct tui_gen_win_info *locator;
246 locator = tui_locator_win_info_ptr ();
248 if (locator != NULL && locator->handle != (WINDOW *) NULL)
250 struct tui_win_element *element;
252 element = (struct tui_win_element *) locator->content[0];
254 string = tui_make_status_line (&element->which_element.locator);
255 wmove (locator->handle, 0, 0);
256 wstandout (locator->handle);
257 waddstr (locator->handle, string);
258 wclrtoeol (locator->handle);
259 wstandend (locator->handle);
260 tui_refresh_win (locator);
261 wmove (locator->handle, 0, 0);
263 locator->content_in_use = TRUE;
268 /* Set the filename portion of the locator. */
270 tui_set_locator_filename (const char *filename)
272 struct tui_gen_win_info *locator = tui_locator_win_info_ptr ();
273 struct tui_locator_element *element;
275 if (locator->content[0] == NULL)
277 tui_set_locator_info (filename, NULL, 0, 0);
281 element = &((struct tui_win_element *) locator->content[0])->which_element.locator;
282 element->file_name[0] = 0;
283 strcat_to_buf (element->file_name, MAX_LOCATOR_ELEMENT_LEN, filename);
286 /* Update the locator, with the provided arguments. */
288 tui_set_locator_info (const char *filename,
289 const char *procname,
293 struct tui_gen_win_info *locator = tui_locator_win_info_ptr ();
294 struct tui_locator_element *element;
296 /* Allocate the locator content if necessary. */
297 if (locator->content_size <= 0)
299 locator->content = (void **) tui_alloc_content (1, locator->type);
300 locator->content_size = 1;
303 element = &((struct tui_win_element *) locator->content[0])->which_element.locator;
304 element->proc_name[0] = (char) 0;
305 strcat_to_buf (element->proc_name, MAX_LOCATOR_ELEMENT_LEN, procname);
306 element->line_no = lineno;
307 element->addr = addr;
308 tui_set_locator_filename (filename);
311 /* Update only the filename portion of the locator. */
313 tui_update_locator_filename (const char *filename)
315 tui_set_locator_filename (filename);
316 tui_show_locator_content ();
319 /* Function to print the frame information for the TUI. */
321 tui_show_frame_info (struct frame_info *fi)
323 struct tui_win_info *win_info;
330 struct tui_gen_win_info *locator = tui_locator_win_info_ptr ();
331 int source_already_displayed;
332 struct symtab_and_line sal;
334 find_frame_sal (fi, &sal);
336 source_already_displayed = sal.symtab != 0
337 && tui_source_is_displayed (sal.symtab->filename);
338 tui_set_locator_info (sal.symtab == 0 ? "??" : sal.symtab->filename,
339 tui_get_function_from_frame (fi),
342 tui_show_locator_content ();
344 for (i = 0; i < (tui_source_windows ())->count; i++)
346 union tui_which_element *item;
347 win_info = (tui_source_windows ())->list[i];
349 item = &((struct tui_win_element *) locator->content[0])->which_element;
350 if (win_info == TUI_SRC_WIN)
352 start_line = (item->locator.line_no -
353 (win_info->generic.viewport_height / 2)) + 1;
359 if (find_pc_partial_function (get_frame_pc (fi), (char **) NULL,
360 &low, (CORE_ADDR) 0) == 0)
361 error (_("No function contains program counter for selected frame."));
363 low = tui_get_low_disassembly_address (low, get_frame_pc (fi));
366 if (win_info == TUI_SRC_WIN)
368 struct tui_line_or_address l;
370 l.u.line_no = start_line;
371 if (!(source_already_displayed
372 && tui_line_is_displayed (item->locator.line_no, win_info, TRUE)))
373 tui_update_source_window (win_info, sal.symtab, l, TRUE);
376 l.u.line_no = item->locator.line_no;
377 tui_set_is_exec_point_at (l, win_info);
382 if (win_info == TUI_DISASM_WIN)
384 struct tui_line_or_address a;
387 if (!tui_addr_is_displayed (item->locator.addr, win_info, TRUE))
388 tui_update_source_window (win_info, sal.symtab, a, TRUE);
391 a.u.addr = item->locator.addr;
392 tui_set_is_exec_point_at (a, win_info);
396 tui_update_exec_info (win_info);
401 tui_set_locator_info (NULL, NULL, 0, (CORE_ADDR) 0);
402 tui_show_locator_content ();
403 for (i = 0; i < (tui_source_windows ())->count; i++)
405 win_info = (tui_source_windows ())->list[i];
406 tui_clear_source_content (win_info, EMPTY_SOURCE_PROMPT);
407 tui_update_exec_info (win_info);
412 /* Function to initialize gdb commands, for tui window stack
415 _initialize_tui_stack (void)
417 add_com ("update", class_tui, tui_update_command, _("\
418 Update the source window and locator to display the current execution point.\n"));
421 /* Command to update the display with the current execution point. */
423 tui_update_command (char *arg, int from_tty)
425 char cmd[sizeof("frame 0")];
427 strcpy (cmd, "frame 0");
428 execute_command (cmd, from_tty);