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 (struct gdbarch
*gdbarch
,
54 int lineno
, CORE_ADDR addr
);
56 static void tui_update_command (char *, int);
59 /* Create the status line to display as much information as we can on
60 this single line: target name, process number, current function,
61 current line, current PC, SingleKey mode. */
63 tui_make_status_line (struct tui_locator_element
*loc
)
66 char line_buf
[50], *pname
;
76 struct ui_file
*pc_out
;
78 if (ptid_equal (inferior_ptid
, null_ptid
))
79 pid_name
= "No process";
81 pid_name
= target_pid_to_str (inferior_ptid
);
83 target_width
= strlen (target_shortname
);
84 if (target_width
> MAX_TARGET_WIDTH
)
85 target_width
= MAX_TARGET_WIDTH
;
87 pid_width
= strlen (pid_name
);
88 if (pid_width
> MAX_PID_WIDTH
)
89 pid_width
= MAX_PID_WIDTH
;
91 status_size
= tui_term_width ();
92 string
= (char *) xmalloc (status_size
+ 1);
93 buf
= (char*) alloca (status_size
+ 1);
95 /* Translate line number and obtain its size. */
97 sprintf (line_buf
, "%d", loc
->line_no
);
99 strcpy (line_buf
, "??");
100 line_width
= strlen (line_buf
);
101 if (line_width
< MIN_LINE_WIDTH
)
102 line_width
= MIN_LINE_WIDTH
;
104 /* Translate PC address. */
105 pc_out
= tui_sfileopen (128);
106 fputs_filtered (loc
->gdbarch
? paddress (loc
->gdbarch
, loc
->addr
) : "??",
108 pc_buf
= tui_file_get_strbuf (pc_out
);
109 pc_width
= strlen (pc_buf
);
111 /* First determine the amount of proc name width we have available.
112 The +1 are for a space separator between fields.
113 The -1 are to take into account the \0 counted by sizeof. */
114 proc_width
= (status_size
117 - (sizeof (PROC_PREFIX
) - 1 + 1)
118 - (sizeof (LINE_PREFIX
) - 1 + line_width
+ 1)
119 - (sizeof (PC_PREFIX
) - 1 + pc_width
+ 1)
120 - (tui_current_key_mode
== TUI_SINGLE_KEY_MODE
121 ? (sizeof (SINGLE_KEY
) - 1 + 1)
124 /* If there is no room to print the function name, try by removing
126 if (proc_width
< MIN_PROC_WIDTH
)
128 proc_width
+= target_width
+ 1;
130 if (proc_width
< MIN_PROC_WIDTH
)
132 proc_width
+= pid_width
+ 1;
134 if (proc_width
<= MIN_PROC_WIDTH
)
136 proc_width
+= pc_width
+ sizeof (PC_PREFIX
) - 1 + 1;
140 proc_width
+= line_width
+ sizeof (LINE_PREFIX
) - 1 + 1;
149 /* Now convert elements to string form. */
150 pname
= loc
->proc_name
;
152 /* Now create the locator line from the string version of the
153 elements. We could use sprintf() here but that wouldn't ensure
154 that we don't overrun the size of the allocated buffer.
155 strcat_to_buf() will. */
158 if (target_width
> 0)
160 sprintf (buf
, "%*.*s ",
161 -target_width
, target_width
, target_shortname
);
162 strcat_to_buf (string
, status_size
, buf
);
166 sprintf (buf
, "%*.*s ",
167 -pid_width
, pid_width
, pid_name
);
168 strcat_to_buf (string
, status_size
, buf
);
171 /* Show whether we are in SingleKey mode. */
172 if (tui_current_key_mode
== TUI_SINGLE_KEY_MODE
)
174 strcat_to_buf (string
, status_size
, SINGLE_KEY
);
175 strcat_to_buf (string
, status_size
, " ");
178 /* Procedure/class name. */
181 if (strlen (pname
) > proc_width
)
182 sprintf (buf
, "%s%*.*s* ", PROC_PREFIX
,
183 1 - proc_width
, proc_width
- 1, pname
);
185 sprintf (buf
, "%s%*.*s ", PROC_PREFIX
,
186 -proc_width
, proc_width
, pname
);
187 strcat_to_buf (string
, status_size
, buf
);
192 sprintf (buf
, "%s%*.*s ", LINE_PREFIX
,
193 -line_width
, line_width
, line_buf
);
194 strcat_to_buf (string
, status_size
, buf
);
198 strcat_to_buf (string
, status_size
, PC_PREFIX
);
199 strcat_to_buf (string
, status_size
, pc_buf
);
203 for (i
= strlen (string
); i
< status_size
; i
++)
205 string
[status_size
] = (char) 0;
207 ui_file_delete (pc_out
);
211 /* Get a printable name for the function at the address. The symbol
212 name is demangled if demangling is turned on. Returns a pointer to
213 a static area holding the result. */
215 tui_get_function_from_frame (struct frame_info
*fi
)
217 static char name
[256];
218 struct ui_file
*stream
= tui_sfileopen (256);
221 print_address_symbolic (get_frame_pc (fi
), stream
, demangle
, "");
222 p
= tui_file_get_strbuf (stream
);
224 /* Use simple heuristics to isolate the function name. The symbol
225 can be demangled and we can have function parameters. Remove
226 them because the status line is too short to display them. */
229 strncpy (name
, p
, sizeof (name
));
230 p
= strchr (name
, '(');
232 p
= strchr (name
, '>');
235 p
= strchr (name
, '+');
238 ui_file_delete (stream
);
243 tui_show_locator_content (void)
246 struct tui_gen_win_info
*locator
;
248 locator
= tui_locator_win_info_ptr ();
250 if (locator
!= NULL
&& locator
->handle
!= (WINDOW
*) NULL
)
252 struct tui_win_element
*element
;
254 element
= (struct tui_win_element
*) locator
->content
[0];
256 string
= tui_make_status_line (&element
->which_element
.locator
);
257 wmove (locator
->handle
, 0, 0);
258 wstandout (locator
->handle
);
259 waddstr (locator
->handle
, string
);
260 wclrtoeol (locator
->handle
);
261 wstandend (locator
->handle
);
262 tui_refresh_win (locator
);
263 wmove (locator
->handle
, 0, 0);
265 locator
->content_in_use
= TRUE
;
270 /* Set the filename portion of the locator. */
272 tui_set_locator_filename (const char *filename
)
274 struct tui_gen_win_info
*locator
= tui_locator_win_info_ptr ();
275 struct tui_locator_element
*element
;
277 if (locator
->content
[0] == NULL
)
279 tui_set_locator_info (NULL
, filename
, NULL
, 0, 0);
283 element
= &((struct tui_win_element
*) locator
->content
[0])->which_element
.locator
;
284 element
->file_name
[0] = 0;
285 strcat_to_buf (element
->file_name
, MAX_LOCATOR_ELEMENT_LEN
, filename
);
288 /* Update the locator, with the provided arguments. */
290 tui_set_locator_info (struct gdbarch
*gdbarch
,
291 const char *filename
,
292 const char *procname
,
296 struct tui_gen_win_info
*locator
= tui_locator_win_info_ptr ();
297 struct tui_locator_element
*element
;
299 /* Allocate the locator content if necessary. */
300 if (locator
->content_size
<= 0)
302 locator
->content
= (void **) tui_alloc_content (1, locator
->type
);
303 locator
->content_size
= 1;
306 element
= &((struct tui_win_element
*) locator
->content
[0])->which_element
.locator
;
307 element
->proc_name
[0] = (char) 0;
308 strcat_to_buf (element
->proc_name
, MAX_LOCATOR_ELEMENT_LEN
, procname
);
309 element
->line_no
= lineno
;
310 element
->addr
= addr
;
311 element
->gdbarch
= gdbarch
;
312 tui_set_locator_filename (filename
);
315 /* Update only the filename portion of the locator. */
317 tui_update_locator_filename (const char *filename
)
319 tui_set_locator_filename (filename
);
320 tui_show_locator_content ();
323 /* Function to print the frame information for the TUI. */
325 tui_show_frame_info (struct frame_info
*fi
)
327 struct tui_win_info
*win_info
;
334 struct tui_gen_win_info
*locator
= tui_locator_win_info_ptr ();
335 int source_already_displayed
;
336 struct symtab_and_line sal
;
338 find_frame_sal (fi
, &sal
);
340 source_already_displayed
= sal
.symtab
!= 0
341 && tui_source_is_displayed (sal
.symtab
->filename
);
342 tui_set_locator_info (get_frame_arch (fi
),
343 sal
.symtab
== 0 ? "??" : sal
.symtab
->filename
,
344 tui_get_function_from_frame (fi
),
347 tui_show_locator_content ();
349 for (i
= 0; i
< (tui_source_windows ())->count
; i
++)
351 union tui_which_element
*item
;
352 win_info
= (tui_source_windows ())->list
[i
];
354 item
= &((struct tui_win_element
*) locator
->content
[0])->which_element
;
355 if (win_info
== TUI_SRC_WIN
)
357 start_line
= (item
->locator
.line_no
-
358 (win_info
->generic
.viewport_height
/ 2)) + 1;
364 if (find_pc_partial_function (get_frame_pc (fi
), (char **) NULL
,
365 &low
, (CORE_ADDR
) 0) == 0)
366 error (_("No function contains program counter for selected frame."));
368 low
= tui_get_low_disassembly_address (get_frame_arch (fi
),
369 low
, get_frame_pc (fi
));
372 if (win_info
== TUI_SRC_WIN
)
374 struct tui_line_or_address l
;
376 l
.u
.line_no
= start_line
;
377 if (!(source_already_displayed
378 && tui_line_is_displayed (item
->locator
.line_no
, win_info
, TRUE
)))
379 tui_update_source_window (win_info
, get_frame_arch (fi
),
380 sal
.symtab
, l
, TRUE
);
383 l
.u
.line_no
= item
->locator
.line_no
;
384 tui_set_is_exec_point_at (l
, win_info
);
389 if (win_info
== TUI_DISASM_WIN
)
391 struct tui_line_or_address a
;
394 if (!tui_addr_is_displayed (item
->locator
.addr
, win_info
, TRUE
))
395 tui_update_source_window (win_info
, get_frame_arch (fi
),
396 sal
.symtab
, a
, TRUE
);
399 a
.u
.addr
= item
->locator
.addr
;
400 tui_set_is_exec_point_at (a
, win_info
);
404 tui_update_exec_info (win_info
);
409 tui_set_locator_info (NULL
, NULL
, NULL
, 0, (CORE_ADDR
) 0);
410 tui_show_locator_content ();
411 for (i
= 0; i
< (tui_source_windows ())->count
; i
++)
413 win_info
= (tui_source_windows ())->list
[i
];
414 tui_clear_source_content (win_info
, EMPTY_SOURCE_PROMPT
);
415 tui_update_exec_info (win_info
);
420 /* Function to initialize gdb commands, for tui window stack
423 /* Provide a prototype to silence -Wmissing-prototypes. */
424 extern initialize_file_ftype _initialize_tui_stack
;
427 _initialize_tui_stack (void)
429 add_com ("update", class_tui
, tui_update_command
, _("\
430 Update the source window and locator to display the current execution point.\n"));
433 /* Command to update the display with the current execution point. */
435 tui_update_command (char *arg
, int from_tty
)
437 char cmd
[sizeof("frame 0")];
439 strcpy (cmd
, "frame 0");
440 execute_command (cmd
, from_tty
);