1 /* TUI display locator.
3 Copyright (C) 1998-2015 Free Software Foundation, Inc.
5 Contributed by Hewlett-Packard Company.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "breakpoint.h"
30 #include "gdb-demangle.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 full_name portion of the locator. */
48 static void tui_set_locator_fullname (const char *fullname
);
50 /* Update the locator, with the provided arguments. */
51 static int 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 xsnprintf (line_buf
, sizeof (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_arch (fi
), get_frame_pc (fi
),
222 stream
, demangle
, "");
223 p
= tui_file_get_strbuf (stream
);
225 /* Use simple heuristics to isolate the function name. The symbol
226 can be demangled and we can have function parameters. Remove
227 them because the status line is too short to display them. */
230 strncpy (name
, p
, sizeof (name
) - 1);
231 name
[sizeof (name
) - 1] = 0;
232 p
= strchr (name
, '(');
234 p
= strchr (name
, '>');
237 p
= strchr (name
, '+');
240 ui_file_delete (stream
);
245 tui_show_locator_content (void)
248 struct tui_gen_win_info
*locator
;
250 locator
= tui_locator_win_info_ptr ();
252 if (locator
!= NULL
&& locator
->handle
!= (WINDOW
*) NULL
)
254 struct tui_win_element
*element
;
256 element
= locator
->content
[0];
258 string
= tui_make_status_line (&element
->which_element
.locator
);
259 wmove (locator
->handle
, 0, 0);
260 /* We ignore the return value from wstandout and wstandend, casting
261 them to void in order to avoid a compiler warning. The warning
262 itself was introduced by a patch to ncurses 5.7 dated 2009-08-29,
263 changing these macro to expand to code that causes the compiler
264 to generate an unused-value warning. */
265 (void) wstandout (locator
->handle
);
266 waddstr (locator
->handle
, string
);
267 wclrtoeol (locator
->handle
);
268 (void) wstandend (locator
->handle
);
269 tui_refresh_win (locator
);
270 wmove (locator
->handle
, 0, 0);
272 locator
->content_in_use
= TRUE
;
277 /* Set the filename portion of the locator. */
279 tui_set_locator_fullname (const char *fullname
)
281 struct tui_gen_win_info
*locator
= tui_locator_win_info_ptr ();
282 struct tui_locator_element
*element
;
284 if (locator
->content
[0] == NULL
)
286 tui_set_locator_info (NULL
, fullname
, NULL
, 0, 0);
290 element
= &locator
->content
[0]->which_element
.locator
;
291 element
->full_name
[0] = 0;
292 strcat_to_buf (element
->full_name
, MAX_LOCATOR_ELEMENT_LEN
, fullname
);
295 /* Update the locator, with the provided arguments.
297 Returns 1 if any of the locator's fields were actually changed,
301 tui_set_locator_info (struct gdbarch
*gdbarch
,
302 const char *fullname
,
303 const char *procname
,
307 struct tui_gen_win_info
*locator
= tui_locator_win_info_ptr ();
308 struct tui_locator_element
*element
;
309 int locator_changed_p
= 0;
311 /* Allocate the locator content if necessary. */
312 if (locator
->content_size
<= 0)
314 locator
->content
= tui_alloc_content (1, LOCATOR_WIN
);
315 locator
->content_size
= 1;
316 locator_changed_p
= 1;
319 if (procname
== NULL
)
322 if (fullname
== NULL
)
325 element
= &locator
->content
[0]->which_element
.locator
;
327 locator_changed_p
|= strncmp (element
->proc_name
, procname
,
328 MAX_LOCATOR_ELEMENT_LEN
) != 0;
329 locator_changed_p
|= lineno
!= element
->line_no
;
330 locator_changed_p
|= addr
!= element
->addr
;
331 locator_changed_p
|= gdbarch
!= element
->gdbarch
;
332 locator_changed_p
|= strncmp (element
->full_name
, fullname
,
333 MAX_LOCATOR_ELEMENT_LEN
) != 0;
335 element
->proc_name
[0] = (char) 0;
336 strcat_to_buf (element
->proc_name
, MAX_LOCATOR_ELEMENT_LEN
, procname
);
337 element
->line_no
= lineno
;
338 element
->addr
= addr
;
339 element
->gdbarch
= gdbarch
;
340 tui_set_locator_fullname (fullname
);
342 return locator_changed_p
;
345 /* Update only the full_name portion of the locator. */
347 tui_update_locator_fullname (const char *fullname
)
349 tui_set_locator_fullname (fullname
);
350 tui_show_locator_content ();
353 /* Function to print the frame information for the TUI. The windows are
354 refreshed only if frame information has changed since the last refresh.
356 Return 1 if frame information has changed (and windows subsequently
357 refreshed), 0 otherwise. */
360 tui_show_frame_info (struct frame_info
*fi
)
362 struct tui_win_info
*win_info
;
363 int locator_changed_p
;
370 struct tui_gen_win_info
*locator
= tui_locator_win_info_ptr ();
371 int source_already_displayed
;
372 struct symtab_and_line sal
;
375 find_frame_sal (fi
, &sal
);
377 source_already_displayed
= sal
.symtab
!= 0
378 && tui_source_is_displayed (symtab_to_fullname (sal
.symtab
));
380 if (get_frame_pc_if_available (fi
, &pc
))
382 = tui_set_locator_info (get_frame_arch (fi
),
384 ? "??" : symtab_to_fullname (sal
.symtab
)),
385 tui_get_function_from_frame (fi
),
390 = tui_set_locator_info (get_frame_arch (fi
),
391 "??", _("<unavailable>"), sal
.line
, 0);
393 /* If the locator information has not changed, then frame information has
394 not changed. If frame information has not changed, then the windows'
395 contents will not change. So don't bother refreshing the windows. */
396 if (!locator_changed_p
)
399 tui_show_locator_content ();
401 for (i
= 0; i
< (tui_source_windows ())->count
; i
++)
403 union tui_which_element
*item
;
405 win_info
= (tui_source_windows ())->list
[i
];
407 item
= &locator
->content
[0]->which_element
;
408 if (win_info
== TUI_SRC_WIN
)
410 start_line
= (item
->locator
.line_no
-
411 (win_info
->generic
.viewport_height
/ 2)) + 1;
417 if (find_pc_partial_function (get_frame_pc (fi
),
418 (const char **) NULL
,
419 &low
, (CORE_ADDR
) 0) == 0)
421 /* There is no symbol available for current PC. There is no
422 safe way how to "disassemble backwards". */
423 low
= get_frame_pc (fi
);
426 low
= tui_get_low_disassembly_address (get_frame_arch (fi
),
427 low
, get_frame_pc (fi
));
430 if (win_info
== TUI_SRC_WIN
)
432 struct tui_line_or_address l
;
435 l
.u
.line_no
= start_line
;
436 if (!(source_already_displayed
437 && tui_line_is_displayed (item
->locator
.line_no
,
439 tui_update_source_window (win_info
, get_frame_arch (fi
),
440 sal
.symtab
, l
, TRUE
);
443 l
.u
.line_no
= item
->locator
.line_no
;
444 tui_set_is_exec_point_at (l
, win_info
);
449 if (win_info
== TUI_DISASM_WIN
)
451 struct tui_line_or_address a
;
455 if (!tui_addr_is_displayed (item
->locator
.addr
,
457 tui_update_source_window (win_info
, get_frame_arch (fi
),
458 sal
.symtab
, a
, TRUE
);
461 a
.u
.addr
= item
->locator
.addr
;
462 tui_set_is_exec_point_at (a
, win_info
);
466 tui_update_exec_info (win_info
);
474 = tui_set_locator_info (NULL
, NULL
, NULL
, 0, (CORE_ADDR
) 0);
476 if (!locator_changed_p
)
479 tui_show_locator_content ();
480 for (i
= 0; i
< (tui_source_windows ())->count
; i
++)
482 win_info
= (tui_source_windows ())->list
[i
];
483 tui_clear_source_content (win_info
, EMPTY_SOURCE_PROMPT
);
484 tui_update_exec_info (win_info
);
491 /* Function to initialize gdb commands, for tui window stack
494 /* Provide a prototype to silence -Wmissing-prototypes. */
495 extern initialize_file_ftype _initialize_tui_stack
;
498 _initialize_tui_stack (void)
500 add_com ("update", class_tui
, tui_update_command
,
501 _("Update the source window and locator to "
502 "display the current execution point.\n"));
505 /* Command to update the display with the current execution point. */
507 tui_update_command (char *arg
, int from_tty
)
509 char cmd
[sizeof("frame 0")];
511 strcpy (cmd
, "frame 0");
512 execute_command (cmd
, from_tty
);