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 static struct tui_locator_window _locator
;
44 /* Get a printable name for the function at the address.
45 The symbol name is demangled if demangling is turned on.
46 Returns a pointer to a static area holding the result. */
47 static char *tui_get_function_from_frame (struct frame_info
*fi
);
49 /* Set the full_name portion of the locator. */
50 static void tui_set_locator_fullname (const char *fullname
);
52 /* Update the locator, with the provided arguments. */
53 static int tui_set_locator_info (struct gdbarch
*gdbarch
,
56 int lineno
, CORE_ADDR addr
);
58 static void tui_update_command (const char *, int);
61 /* Accessor for the locator win info. Answers a pointer to the static
62 locator win info struct. */
63 struct tui_locator_window
*
64 tui_locator_win_info_ptr (void)
69 /* Create the status line to display as much information as we can on
70 this single line: target name, process number, current function,
71 current line, current PC, SingleKey mode. */
73 tui_make_status_line (struct tui_locator_window
*loc
)
76 char line_buf
[50], *pname
;
85 std::string pid_name_holder
;
86 if (inferior_ptid
== null_ptid
)
87 pid_name
= "No process";
90 pid_name_holder
= target_pid_to_str (inferior_ptid
);
91 pid_name
= pid_name_holder
.c_str ();
94 target_width
= strlen (target_shortname
);
95 if (target_width
> MAX_TARGET_WIDTH
)
96 target_width
= MAX_TARGET_WIDTH
;
98 pid_width
= strlen (pid_name
);
99 if (pid_width
> MAX_PID_WIDTH
)
100 pid_width
= MAX_PID_WIDTH
;
102 status_size
= tui_term_width ();
103 string
= (char *) xmalloc (status_size
+ 1);
104 buf
= (char*) alloca (status_size
+ 1);
106 /* Translate line number and obtain its size. */
107 if (loc
->line_no
> 0)
108 xsnprintf (line_buf
, sizeof (line_buf
), "%d", loc
->line_no
);
110 strcpy (line_buf
, "??");
111 line_width
= strlen (line_buf
);
112 if (line_width
< MIN_LINE_WIDTH
)
113 line_width
= MIN_LINE_WIDTH
;
115 /* Translate PC address. */
116 std::string
pc_out (loc
->gdbarch
117 ? paddress (loc
->gdbarch
, loc
->addr
)
119 const char *pc_buf
= pc_out
.c_str ();
120 int pc_width
= pc_out
.size ();
122 /* First determine the amount of proc name width we have available.
123 The +1 are for a space separator between fields.
124 The -1 are to take into account the \0 counted by sizeof. */
125 proc_width
= (status_size
128 - (sizeof (PROC_PREFIX
) - 1 + 1)
129 - (sizeof (LINE_PREFIX
) - 1 + line_width
+ 1)
130 - (sizeof (PC_PREFIX
) - 1 + pc_width
+ 1)
131 - (tui_current_key_mode
== TUI_SINGLE_KEY_MODE
132 ? (sizeof (SINGLE_KEY
) - 1 + 1)
135 /* If there is no room to print the function name, try by removing
137 if (proc_width
< MIN_PROC_WIDTH
)
139 proc_width
+= target_width
+ 1;
141 if (proc_width
< MIN_PROC_WIDTH
)
143 proc_width
+= pid_width
+ 1;
145 if (proc_width
<= MIN_PROC_WIDTH
)
147 proc_width
+= pc_width
+ sizeof (PC_PREFIX
) - 1 + 1;
151 proc_width
+= line_width
+ sizeof (LINE_PREFIX
) - 1 + 1;
160 /* Now convert elements to string form. */
161 pname
= loc
->proc_name
;
163 /* Now create the locator line from the string version of the
164 elements. We could use sprintf() here but that wouldn't ensure
165 that we don't overrun the size of the allocated buffer.
166 strcat_to_buf() will. */
169 if (target_width
> 0)
171 sprintf (buf
, "%*.*s ",
172 -target_width
, target_width
, target_shortname
);
173 strcat_to_buf (string
, status_size
, buf
);
177 sprintf (buf
, "%*.*s ",
178 -pid_width
, pid_width
, pid_name
);
179 strcat_to_buf (string
, status_size
, buf
);
182 /* Show whether we are in SingleKey mode. */
183 if (tui_current_key_mode
== TUI_SINGLE_KEY_MODE
)
185 strcat_to_buf (string
, status_size
, SINGLE_KEY
);
186 strcat_to_buf (string
, status_size
, " ");
189 /* Procedure/class name. */
192 if (strlen (pname
) > proc_width
)
193 sprintf (buf
, "%s%*.*s* ", PROC_PREFIX
,
194 1 - proc_width
, proc_width
- 1, pname
);
196 sprintf (buf
, "%s%*.*s ", PROC_PREFIX
,
197 -proc_width
, proc_width
, pname
);
198 strcat_to_buf (string
, status_size
, buf
);
203 sprintf (buf
, "%s%*.*s ", LINE_PREFIX
,
204 -line_width
, line_width
, line_buf
);
205 strcat_to_buf (string
, status_size
, buf
);
209 strcat_to_buf (string
, status_size
, PC_PREFIX
);
210 strcat_to_buf (string
, status_size
, pc_buf
);
214 for (i
= strlen (string
); i
< status_size
; i
++)
216 string
[status_size
] = (char) 0;
221 /* Get a printable name for the function at the address. The symbol
222 name is demangled if demangling is turned on. Returns a pointer to
223 a static area holding the result. */
225 tui_get_function_from_frame (struct frame_info
*fi
)
227 static char name
[256];
230 print_address_symbolic (get_frame_arch (fi
), get_frame_pc (fi
),
231 &stream
, demangle
, "");
233 /* Use simple heuristics to isolate the function name. The symbol
234 can be demangled and we can have function parameters. Remove
235 them because the status line is too short to display them. */
236 const char *d
= stream
.c_str ();
239 strncpy (name
, d
, sizeof (name
) - 1);
240 name
[sizeof (name
) - 1] = 0;
242 char *p
= strchr (name
, '(');
244 p
= strchr (name
, '>');
247 p
= strchr (name
, '+');
254 tui_show_locator_content (void)
257 struct tui_locator_window
*locator
;
259 locator
= tui_locator_win_info_ptr ();
261 if (locator
!= NULL
&& locator
->handle
!= NULL
)
263 string
= tui_make_status_line (locator
);
264 wmove (locator
->handle
, 0, 0);
265 /* We ignore the return value from wstandout and wstandend, casting
266 them to void in order to avoid a compiler warning. The warning
267 itself was introduced by a patch to ncurses 5.7 dated 2009-08-29,
268 changing these macro to expand to code that causes the compiler
269 to generate an unused-value warning. */
270 (void) wstandout (locator
->handle
);
271 waddstr (locator
->handle
, string
);
272 wclrtoeol (locator
->handle
);
273 (void) wstandend (locator
->handle
);
274 locator
->refresh_window ();
275 wmove (locator
->handle
, 0, 0);
281 tui_locator_window::rerender ()
283 tui_show_locator_content ();
286 /* Set the filename portion of the locator. */
288 tui_set_locator_fullname (const char *fullname
)
290 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
292 locator
->full_name
[0] = 0;
293 strcat_to_buf (locator
->full_name
, MAX_LOCATOR_ELEMENT_LEN
, fullname
);
296 /* Update the locator, with the provided arguments.
298 Returns 1 if any of the locator's fields were actually changed,
302 tui_set_locator_info (struct gdbarch
*gdbarch
,
303 const char *fullname
,
304 const char *procname
,
308 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
309 int locator_changed_p
= 0;
311 if (procname
== NULL
)
314 if (fullname
== NULL
)
317 locator_changed_p
|= strncmp (locator
->proc_name
, procname
,
318 MAX_LOCATOR_ELEMENT_LEN
) != 0;
319 locator_changed_p
|= lineno
!= locator
->line_no
;
320 locator_changed_p
|= addr
!= locator
->addr
;
321 locator_changed_p
|= gdbarch
!= locator
->gdbarch
;
322 locator_changed_p
|= strncmp (locator
->full_name
, fullname
,
323 MAX_LOCATOR_ELEMENT_LEN
) != 0;
325 locator
->proc_name
[0] = (char) 0;
326 strcat_to_buf (locator
->proc_name
, MAX_LOCATOR_ELEMENT_LEN
, procname
);
327 locator
->line_no
= lineno
;
328 locator
->addr
= addr
;
329 locator
->gdbarch
= gdbarch
;
330 tui_set_locator_fullname (fullname
);
332 return locator_changed_p
;
335 /* Update only the full_name portion of the locator. */
337 tui_update_locator_fullname (const char *fullname
)
339 tui_set_locator_fullname (fullname
);
340 tui_show_locator_content ();
343 /* Function to print the frame information for the TUI. The windows are
344 refreshed only if frame information has changed since the last refresh.
346 Return 1 if frame information has changed (and windows subsequently
347 refreshed), 0 otherwise. */
350 tui_show_frame_info (struct frame_info
*fi
)
352 int locator_changed_p
;
356 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
359 symtab_and_line sal
= find_frame_sal (fi
);
361 const char *fullname
= nullptr;
362 if (sal
.symtab
!= nullptr)
363 fullname
= symtab_to_fullname (sal
.symtab
);
365 if (get_frame_pc_if_available (fi
, &pc
))
367 = tui_set_locator_info (get_frame_arch (fi
),
370 tui_get_function_from_frame (fi
),
375 = tui_set_locator_info (get_frame_arch (fi
),
376 "??", _("<unavailable>"), sal
.line
, 0);
378 /* If the locator information has not changed, then frame information has
379 not changed. If frame information has not changed, then the windows'
380 contents will not change. So don't bother refreshing the windows. */
381 if (!locator_changed_p
)
384 tui_show_locator_content ();
385 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
387 win_info
->maybe_update (fi
, sal
, locator
->line_no
, locator
->addr
);
388 win_info
->update_exec_info ();
396 = tui_set_locator_info (NULL
, NULL
, NULL
, 0, (CORE_ADDR
) 0);
398 if (!locator_changed_p
)
401 tui_show_locator_content ();
402 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
404 win_info
->erase_source_content ();
405 win_info
->update_exec_info ();
412 /* Function to initialize gdb commands, for tui window stack
416 _initialize_tui_stack (void)
418 add_com ("update", class_tui
, tui_update_command
,
419 _("Update the source window and locator to "
420 "display the current execution point."));
423 /* Command to update the display with the current execution point. */
425 tui_update_command (const char *arg
, int from_tty
)
427 execute_command ("frame 0", from_tty
);