1 /* TUI display locator.
3 Copyright (C) 1998-2020 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 #define PROC_PREFIX "In: "
43 #define LINE_PREFIX "L"
44 #define PC_PREFIX "PC: "
46 /* Strings to display in the TUI status line. */
47 #define SINGLE_KEY "(SingleKey)"
49 /* Minimum/Maximum length of some fields displayed in the TUI status
51 #define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
53 #define MIN_PROC_WIDTH 12
54 #define MAX_TARGET_WIDTH 10
55 #define MAX_PID_WIDTH 19
57 static struct tui_locator_window _locator
;
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)
70 tui_locator_window::make_status_line () const
80 std::string pid_name_holder
;
81 if (inferior_ptid
== null_ptid
)
82 pid_name
= "No process";
85 pid_name_holder
= target_pid_to_str (inferior_ptid
);
86 pid_name
= pid_name_holder
.c_str ();
89 target_width
= strlen (target_shortname
);
90 if (target_width
> MAX_TARGET_WIDTH
)
91 target_width
= MAX_TARGET_WIDTH
;
93 pid_width
= strlen (pid_name
);
94 if (pid_width
> MAX_PID_WIDTH
)
95 pid_width
= MAX_PID_WIDTH
;
99 /* Translate line number and obtain its size. */
101 xsnprintf (line_buf
, sizeof (line_buf
), "%d", line_no
);
103 strcpy (line_buf
, "??");
104 line_width
= strlen (line_buf
);
105 if (line_width
< MIN_LINE_WIDTH
)
106 line_width
= MIN_LINE_WIDTH
;
108 /* Translate PC address. */
109 std::string
pc_out (gdbarch
110 ? paddress (gdbarch
, addr
)
112 const char *pc_buf
= pc_out
.c_str ();
113 int pc_width
= pc_out
.size ();
115 /* First determine the amount of proc name width we have available.
116 The +1 are for a space separator between fields.
117 The -1 are to take into account the \0 counted by sizeof. */
118 proc_width
= (status_size
121 - (sizeof (PROC_PREFIX
) - 1 + 1)
122 - (sizeof (LINE_PREFIX
) - 1 + line_width
+ 1)
123 - (sizeof (PC_PREFIX
) - 1 + pc_width
+ 1)
124 - (tui_current_key_mode
== TUI_SINGLE_KEY_MODE
125 ? (sizeof (SINGLE_KEY
) - 1 + 1)
128 /* If there is no room to print the function name, try by removing
130 if (proc_width
< MIN_PROC_WIDTH
)
132 proc_width
+= target_width
+ 1;
134 if (proc_width
< MIN_PROC_WIDTH
)
136 proc_width
+= pid_width
+ 1;
138 if (proc_width
<= MIN_PROC_WIDTH
)
140 proc_width
+= pc_width
+ sizeof (PC_PREFIX
) - 1 + 1;
144 proc_width
+= line_width
+ sizeof (LINE_PREFIX
) - 1 + 1;
153 /* Now create the locator line from the string version of the
157 if (target_width
> 0)
158 string
.printf ("%*.*s ", -target_width
, target_width
, target_shortname
);
160 string
.printf ("%*.*s ", -pid_width
, pid_width
, pid_name
);
162 /* Show whether we are in SingleKey mode. */
163 if (tui_current_key_mode
== TUI_SINGLE_KEY_MODE
)
165 string
.puts (SINGLE_KEY
);
169 /* Procedure/class name. */
172 if (proc_name
.size () > proc_width
)
173 string
.printf ("%s%*.*s* ", PROC_PREFIX
,
174 1 - proc_width
, proc_width
- 1, proc_name
.c_str ());
176 string
.printf ("%s%*.*s ", PROC_PREFIX
,
177 -proc_width
, proc_width
, proc_name
.c_str ());
181 string
.printf ("%s%*.*s ", LINE_PREFIX
,
182 -line_width
, line_width
, line_buf
);
185 string
.puts (PC_PREFIX
);
186 string
.puts (pc_buf
);
189 if (string
.size () < status_size
)
190 string
.puts (n_spaces (status_size
- string
.size ()));
191 else if (string
.size () > status_size
)
192 string
.string ().erase (status_size
, string
.size ());
194 return std::move (string
.string ());
197 /* Get a printable name for the function at the address. The symbol
198 name is demangled if demangling is turned on. Returns a pointer to
199 a static area holding the result. */
201 tui_get_function_from_frame (struct frame_info
*fi
)
203 static char name
[256];
206 print_address_symbolic (get_frame_arch (fi
), get_frame_pc (fi
),
207 &stream
, demangle
, "");
209 /* Use simple heuristics to isolate the function name. The symbol
210 can be demangled and we can have function parameters. Remove
211 them because the status line is too short to display them. */
212 const char *d
= stream
.c_str ();
215 strncpy (name
, d
, sizeof (name
) - 1);
216 name
[sizeof (name
) - 1] = 0;
218 char *p
= strchr (name
, '(');
220 p
= strchr (name
, '>');
223 p
= strchr (name
, '+');
230 tui_locator_window::rerender ()
234 std::string string
= make_status_line ();
235 scrollok (handle
.get (), FALSE
);
236 wmove (handle
.get (), 0, 0);
237 /* We ignore the return value from wstandout and wstandend, casting
238 them to void in order to avoid a compiler warning. The warning
239 itself was introduced by a patch to ncurses 5.7 dated 2009-08-29,
240 changing these macro to expand to code that causes the compiler
241 to generate an unused-value warning. */
242 (void) wstandout (handle
.get ());
243 waddstr (handle
.get (), string
.c_str ());
244 wclrtoeol (handle
.get ());
245 (void) wstandend (handle
.get ());
247 wmove (handle
.get (), 0, 0);
251 /* See tui-stack.h. */
254 tui_locator_window::set_locator_fullname (const char *fullname
)
256 full_name
= fullname
;
260 /* See tui-stack.h. */
263 tui_locator_window::set_locator_info (struct gdbarch
*gdbarch_in
,
264 const struct symtab_and_line
&sal
,
265 const char *procname
)
267 bool locator_changed_p
= false;
269 gdb_assert (procname
!= NULL
);
271 const char *fullname
= (sal
.symtab
== nullptr
273 : symtab_to_fullname (sal
.symtab
));
275 locator_changed_p
|= proc_name
!= procname
;
276 locator_changed_p
|= sal
.line
!= line_no
;
277 locator_changed_p
|= sal
.pc
!= addr
;
278 locator_changed_p
|= gdbarch_in
!= gdbarch
;
279 locator_changed_p
|= full_name
!= fullname
;
281 proc_name
= procname
;
284 gdbarch
= gdbarch_in
;
285 set_locator_fullname (fullname
);
287 return locator_changed_p
;
290 /* Update only the full_name portion of the locator. */
292 tui_update_locator_fullname (struct symtab
*symtab
)
294 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
296 const char *fullname
;
297 if (symtab
!= nullptr)
298 fullname
= symtab_to_fullname (symtab
);
301 locator
->set_locator_fullname (fullname
);
304 /* Function to print the frame information for the TUI. The windows are
305 refreshed only if frame information has changed since the last refresh.
307 Return true if frame information has changed (and windows
308 subsequently refreshed), false otherwise. */
311 tui_show_frame_info (struct frame_info
*fi
)
313 bool locator_changed_p
;
314 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
318 symtab_and_line sal
= find_frame_sal (fi
);
320 const char *func_name
;
321 /* find_frame_sal does not always set PC, but we want to ensure
322 that it is available in the SAL. */
323 if (get_frame_pc_if_available (fi
, &sal
.pc
))
324 func_name
= tui_get_function_from_frame (fi
);
326 func_name
= _("<unavailable>");
328 locator_changed_p
= locator
->set_locator_info (get_frame_arch (fi
),
331 /* If the locator information has not changed, then frame information has
332 not changed. If frame information has not changed, then the windows'
333 contents will not change. So don't bother refreshing the windows. */
334 if (!locator_changed_p
)
337 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
339 win_info
->maybe_update (fi
, sal
);
340 win_info
->update_exec_info ();
345 symtab_and_line sal
{};
347 locator_changed_p
= locator
->set_locator_info (NULL
, sal
, "");
349 if (!locator_changed_p
)
352 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
353 win_info
->erase_source_content ();
360 tui_show_locator_content ()
362 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
363 locator
->rerender ();
366 /* Command to update the display with the current execution point. */
368 tui_update_command (const char *arg
, int from_tty
)
370 execute_command ("frame 0", from_tty
);
373 /* Function to initialize gdb commands, for tui window stack
376 void _initialize_tui_stack ();
378 _initialize_tui_stack ()
380 add_com ("update", class_tui
, tui_update_command
,
381 _("Update the source window and locator to "
382 "display the current execution point.\n\