1 /* TUI display locator.
3 Copyright (C) 1998-2019 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 (const 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_window
*loc
)
66 char line_buf
[50], *pname
;
75 std::string pid_name_holder
;
76 if (inferior_ptid
== null_ptid
)
77 pid_name
= "No process";
80 pid_name_holder
= target_pid_to_str (inferior_ptid
);
81 pid_name
= pid_name_holder
.c_str ();
84 target_width
= strlen (target_shortname
);
85 if (target_width
> MAX_TARGET_WIDTH
)
86 target_width
= MAX_TARGET_WIDTH
;
88 pid_width
= strlen (pid_name
);
89 if (pid_width
> MAX_PID_WIDTH
)
90 pid_width
= MAX_PID_WIDTH
;
92 status_size
= tui_term_width ();
93 string
= (char *) xmalloc (status_size
+ 1);
94 buf
= (char*) alloca (status_size
+ 1);
96 /* Translate line number and obtain its size. */
98 xsnprintf (line_buf
, sizeof (line_buf
), "%d", loc
->line_no
);
100 strcpy (line_buf
, "??");
101 line_width
= strlen (line_buf
);
102 if (line_width
< MIN_LINE_WIDTH
)
103 line_width
= MIN_LINE_WIDTH
;
105 /* Translate PC address. */
108 fputs_filtered (loc
->gdbarch
? paddress (loc
->gdbarch
, loc
->addr
) : "??",
111 const char *pc_buf
= pc_out
.c_str ();
112 int pc_width
= pc_out
.size ();
114 /* First determine the amount of proc name width we have available.
115 The +1 are for a space separator between fields.
116 The -1 are to take into account the \0 counted by sizeof. */
117 proc_width
= (status_size
120 - (sizeof (PROC_PREFIX
) - 1 + 1)
121 - (sizeof (LINE_PREFIX
) - 1 + line_width
+ 1)
122 - (sizeof (PC_PREFIX
) - 1 + pc_width
+ 1)
123 - (tui_current_key_mode
== TUI_SINGLE_KEY_MODE
124 ? (sizeof (SINGLE_KEY
) - 1 + 1)
127 /* If there is no room to print the function name, try by removing
129 if (proc_width
< MIN_PROC_WIDTH
)
131 proc_width
+= target_width
+ 1;
133 if (proc_width
< MIN_PROC_WIDTH
)
135 proc_width
+= pid_width
+ 1;
137 if (proc_width
<= MIN_PROC_WIDTH
)
139 proc_width
+= pc_width
+ sizeof (PC_PREFIX
) - 1 + 1;
143 proc_width
+= line_width
+ sizeof (LINE_PREFIX
) - 1 + 1;
152 /* Now convert elements to string form. */
153 pname
= loc
->proc_name
;
155 /* Now create the locator line from the string version of the
156 elements. We could use sprintf() here but that wouldn't ensure
157 that we don't overrun the size of the allocated buffer.
158 strcat_to_buf() will. */
161 if (target_width
> 0)
163 sprintf (buf
, "%*.*s ",
164 -target_width
, target_width
, target_shortname
);
165 strcat_to_buf (string
, status_size
, buf
);
169 sprintf (buf
, "%*.*s ",
170 -pid_width
, pid_width
, pid_name
);
171 strcat_to_buf (string
, status_size
, buf
);
174 /* Show whether we are in SingleKey mode. */
175 if (tui_current_key_mode
== TUI_SINGLE_KEY_MODE
)
177 strcat_to_buf (string
, status_size
, SINGLE_KEY
);
178 strcat_to_buf (string
, status_size
, " ");
181 /* Procedure/class name. */
184 if (strlen (pname
) > proc_width
)
185 sprintf (buf
, "%s%*.*s* ", PROC_PREFIX
,
186 1 - proc_width
, proc_width
- 1, pname
);
188 sprintf (buf
, "%s%*.*s ", PROC_PREFIX
,
189 -proc_width
, proc_width
, pname
);
190 strcat_to_buf (string
, status_size
, buf
);
195 sprintf (buf
, "%s%*.*s ", LINE_PREFIX
,
196 -line_width
, line_width
, line_buf
);
197 strcat_to_buf (string
, status_size
, buf
);
201 strcat_to_buf (string
, status_size
, PC_PREFIX
);
202 strcat_to_buf (string
, status_size
, pc_buf
);
206 for (i
= strlen (string
); i
< status_size
; i
++)
208 string
[status_size
] = (char) 0;
213 /* Get a printable name for the function at the address. The symbol
214 name is demangled if demangling is turned on. Returns a pointer to
215 a static area holding the result. */
217 tui_get_function_from_frame (struct frame_info
*fi
)
219 static char name
[256];
222 print_address_symbolic (get_frame_arch (fi
), get_frame_pc (fi
),
223 &stream
, demangle
, "");
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. */
228 const char *d
= stream
.c_str ();
231 strncpy (name
, d
, sizeof (name
) - 1);
232 name
[sizeof (name
) - 1] = 0;
234 char *p
= strchr (name
, '(');
236 p
= strchr (name
, '>');
239 p
= strchr (name
, '+');
246 tui_show_locator_content (void)
249 struct tui_locator_window
*locator
;
251 locator
= tui_locator_win_info_ptr ();
253 if (locator
!= NULL
&& locator
->handle
!= NULL
)
255 string
= tui_make_status_line (locator
);
256 wmove (locator
->handle
, 0, 0);
257 /* We ignore the return value from wstandout and wstandend, casting
258 them to void in order to avoid a compiler warning. The warning
259 itself was introduced by a patch to ncurses 5.7 dated 2009-08-29,
260 changing these macro to expand to code that causes the compiler
261 to generate an unused-value warning. */
262 (void) wstandout (locator
->handle
);
263 waddstr (locator
->handle
, string
);
264 wclrtoeol (locator
->handle
);
265 (void) wstandend (locator
->handle
);
266 locator
->refresh_window ();
267 wmove (locator
->handle
, 0, 0);
269 locator
->content_in_use
= TRUE
;
274 /* Set the filename portion of the locator. */
276 tui_set_locator_fullname (const char *fullname
)
278 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
280 locator
->full_name
[0] = 0;
281 strcat_to_buf (locator
->full_name
, MAX_LOCATOR_ELEMENT_LEN
, fullname
);
284 /* Update the locator, with the provided arguments.
286 Returns 1 if any of the locator's fields were actually changed,
290 tui_set_locator_info (struct gdbarch
*gdbarch
,
291 const char *fullname
,
292 const char *procname
,
296 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
297 int locator_changed_p
= 0;
299 if (procname
== NULL
)
302 if (fullname
== NULL
)
305 locator_changed_p
|= strncmp (locator
->proc_name
, procname
,
306 MAX_LOCATOR_ELEMENT_LEN
) != 0;
307 locator_changed_p
|= lineno
!= locator
->line_no
;
308 locator_changed_p
|= addr
!= locator
->addr
;
309 locator_changed_p
|= gdbarch
!= locator
->gdbarch
;
310 locator_changed_p
|= strncmp (locator
->full_name
, fullname
,
311 MAX_LOCATOR_ELEMENT_LEN
) != 0;
313 locator
->proc_name
[0] = (char) 0;
314 strcat_to_buf (locator
->proc_name
, MAX_LOCATOR_ELEMENT_LEN
, procname
);
315 locator
->line_no
= lineno
;
316 locator
->addr
= addr
;
317 locator
->gdbarch
= gdbarch
;
318 tui_set_locator_fullname (fullname
);
320 return locator_changed_p
;
323 /* Update only the full_name portion of the locator. */
325 tui_update_locator_fullname (const char *fullname
)
327 tui_set_locator_fullname (fullname
);
328 tui_show_locator_content ();
331 /* Function to print the frame information for the TUI. The windows are
332 refreshed only if frame information has changed since the last refresh.
334 Return 1 if frame information has changed (and windows subsequently
335 refreshed), 0 otherwise. */
338 tui_show_frame_info (struct frame_info
*fi
)
340 int locator_changed_p
;
346 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
347 int source_already_displayed
;
350 symtab_and_line sal
= find_frame_sal (fi
);
352 source_already_displayed
= sal
.symtab
!= 0
353 && tui_source_is_displayed (symtab_to_fullname (sal
.symtab
));
355 if (get_frame_pc_if_available (fi
, &pc
))
357 = tui_set_locator_info (get_frame_arch (fi
),
359 ? "??" : symtab_to_fullname (sal
.symtab
)),
360 tui_get_function_from_frame (fi
),
365 = tui_set_locator_info (get_frame_arch (fi
),
366 "??", _("<unavailable>"), sal
.line
, 0);
368 /* If the locator information has not changed, then frame information has
369 not changed. If frame information has not changed, then the windows'
370 contents will not change. So don't bother refreshing the windows. */
371 if (!locator_changed_p
)
374 tui_show_locator_content ();
376 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
378 if (win_info
== TUI_SRC_WIN
)
380 start_line
= (locator
->line_no
-
381 (win_info
->viewport_height
/ 2)) + 1;
387 if (find_pc_partial_function (get_frame_pc (fi
),
388 NULL
, &low
, NULL
) == 0)
390 /* There is no symbol available for current PC. There is no
391 safe way how to "disassemble backwards". */
392 low
= get_frame_pc (fi
);
395 low
= tui_get_low_disassembly_address (get_frame_arch (fi
),
396 low
, get_frame_pc (fi
));
399 if (win_info
== TUI_SRC_WIN
)
401 struct tui_line_or_address l
;
404 l
.u
.line_no
= start_line
;
405 if (!(source_already_displayed
406 && tui_line_is_displayed (locator
->line_no
,
408 tui_update_source_window (win_info
, get_frame_arch (fi
),
409 sal
.symtab
, l
, TRUE
);
412 l
.u
.line_no
= locator
->line_no
;
413 win_info
->set_is_exec_point_at (l
);
418 if (win_info
== TUI_DISASM_WIN
)
420 struct tui_line_or_address a
;
424 if (!tui_addr_is_displayed (locator
->addr
,
426 tui_update_source_window (win_info
, get_frame_arch (fi
),
427 sal
.symtab
, a
, TRUE
);
430 a
.u
.addr
= locator
->addr
;
431 win_info
->set_is_exec_point_at (a
);
435 tui_update_exec_info (win_info
);
443 = tui_set_locator_info (NULL
, NULL
, NULL
, 0, (CORE_ADDR
) 0);
445 if (!locator_changed_p
)
448 tui_show_locator_content ();
449 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
451 tui_clear_source_content (win_info
, EMPTY_SOURCE_PROMPT
);
452 tui_update_exec_info (win_info
);
459 /* Function to initialize gdb commands, for tui window stack
463 _initialize_tui_stack (void)
465 add_com ("update", class_tui
, tui_update_command
,
466 _("Update the source window and locator to "
467 "display the current execution point."));
470 /* Command to update the display with the current execution point. */
472 tui_update_command (const char *arg
, int from_tty
)
474 execute_command ("frame 0", from_tty
);