1 /* TUI display registers in window.
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/>. */
23 #include "arch-utils.h"
25 #include "tui/tui-data.h"
33 #include "tui/tui-layout.h"
34 #include "tui/tui-win.h"
35 #include "tui/tui-wingeneral.h"
36 #include "tui/tui-file.h"
37 #include "tui/tui-regs.h"
38 #include "tui/tui-io.h"
39 #include "reggroups.h"
41 #include "completer.h"
43 #include "gdb_curses.h"
45 static void tui_display_register (struct tui_data_item_window
*data
);
47 /* Get the register from the frame and return a printable
48 representation of it. */
50 static gdb::unique_xmalloc_ptr
<char>
51 tui_register_format (struct frame_info
*frame
, int regnum
)
53 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
57 scoped_restore save_pagination
58 = make_scoped_restore (&pagination_enabled
, 0);
59 scoped_restore save_stdout
60 = make_scoped_restore (&gdb_stdout
, &stream
);
62 gdbarch_print_registers_info (gdbarch
, &stream
, frame
, regnum
, 1);
64 /* Remove the possible \n. */
65 std::string
&str
= stream
.string ();
66 if (!str
.empty () && str
.back () == '\n')
67 str
.resize (str
.size () - 1);
69 /* Expand tabs into spaces, since ncurses on MS-Windows doesn't. */
70 return tui_expand_tabs (str
.c_str ());
73 /* Get the register value from the given frame and format it for the
74 display. When changep is set, check if the new register value has
75 changed with respect to the previous call. */
77 tui_get_register (struct frame_info
*frame
,
78 struct tui_data_item_window
*data
,
79 int regnum
, bool *changedp
)
83 if (target_has_registers
)
85 gdb::unique_xmalloc_ptr
<char> new_content
86 = tui_register_format (frame
, regnum
);
89 && strcmp (data
->content
.get (), new_content
.get ()) != 0)
92 data
->content
= std::move (new_content
);
99 tui_data_window::last_regs_line_no () const
101 int num_lines
= (-1);
103 if (!regs_content
.empty ())
105 num_lines
= regs_content
.size () / regs_column_count
;
106 if (regs_content
.size () % regs_column_count
)
112 /* See tui-regs.h. */
115 tui_data_window::line_from_reg_element_no (int element_no
) const
117 if (element_no
< regs_content
.size ())
124 if (element_no
< regs_column_count
* i
)
136 /* See tui-regs.h. */
139 tui_data_window::first_reg_element_no_inline (int line_no
) const
141 if (line_no
* regs_column_count
<= regs_content
.size ())
142 return ((line_no
+ 1) * regs_column_count
) - regs_column_count
;
147 /* Show the registers of the given group in the data window
148 and refresh the window. */
150 tui_data_window::show_registers (struct reggroup
*group
)
153 group
= general_reggroup
;
155 /* Say that registers should be displayed, even if there is a
159 if (target_has_registers
&& target_has_stack
&& target_has_memory
)
161 show_register_group (group
, get_selected_frame (NULL
),
162 group
== current_group
);
164 /* Clear all notation of changed values. */
165 for (auto &&data_item_win
: regs_content
)
166 data_item_win
.highlight
= false;
167 current_group
= group
;
173 erase_data_content (_("[ Register Values Unavailable ]"));
178 /* Set the data window to display the registers of the register group
179 using the given frame. Values are refreshed only when
180 refresh_values_only is TRUE. */
183 tui_data_window::show_register_group (struct reggroup
*group
,
184 struct frame_info
*frame
,
185 int refresh_values_only
)
187 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
191 /* Make a new title showing which group we display. */
193 title
= xstrprintf ("Register group: %s", reggroup_name (group
));
195 /* See how many registers must be displayed. */
197 for (regnum
= 0; regnum
< gdbarch_num_cooked_regs (gdbarch
); regnum
++)
201 /* Must be in the group. */
202 if (!gdbarch_register_reggroup_p (gdbarch
, regnum
, group
))
205 /* If the register name is empty, it is undefined for this
206 processor, so don't display anything. */
207 name
= gdbarch_register_name (gdbarch
, regnum
);
208 if (name
== 0 || *name
== '\0')
214 regs_content
.resize (nr_regs
);
216 /* Now set the register names and values. */
218 for (regnum
= 0; regnum
< gdbarch_num_cooked_regs (gdbarch
); regnum
++)
220 struct tui_data_item_window
*data_item_win
;
223 /* Must be in the group. */
224 if (!gdbarch_register_reggroup_p (gdbarch
, regnum
, group
))
227 /* If the register name is empty, it is undefined for this
228 processor, so don't display anything. */
229 name
= gdbarch_register_name (gdbarch
, regnum
);
230 if (name
== 0 || *name
== '\0')
233 data_item_win
= ®s_content
[pos
];
236 if (!refresh_values_only
)
238 data_item_win
->item_no
= regnum
;
239 data_item_win
->name
= name
;
240 data_item_win
->highlight
= false;
242 tui_get_register (frame
, data_item_win
, regnum
, 0);
248 /* See tui-regs.h. */
251 tui_data_window::display_registers_from (int start_element_no
)
253 if (!regs_content
.empty ())
255 int j
, item_win_width
, cur_y
;
258 for (auto &&data_item_win
: regs_content
)
264 p
= data_item_win
.content
.get ();
271 item_win_width
= max_len
+ 1;
272 int i
= start_element_no
;
274 regs_column_count
= (width
- 2) / item_win_width
;
275 if (regs_column_count
== 0)
276 regs_column_count
= 1;
277 item_win_width
= (width
- 2) / regs_column_count
;
279 /* Now create each data "sub" window, and write the display into
282 while (i
< regs_content
.size ()
283 && cur_y
<= viewport_height
)
286 j
< regs_column_count
&& i
< regs_content
.size ();
289 struct tui_data_item_window
*data_item_win
;
291 /* Create the window if necessary. */
292 data_item_win
= ®s_content
[i
];
293 if (data_item_win
->handle
!= NULL
294 && (data_item_win
->height
!= 1
295 || data_item_win
->width
!= item_win_width
296 || data_item_win
->origin
.x
!= (item_win_width
* j
) + 1
297 || data_item_win
->origin
.y
!= cur_y
))
299 tui_delete_win (data_item_win
->handle
);
300 data_item_win
->handle
= 0;
303 if (data_item_win
->handle
== NULL
)
305 data_item_win
->height
= 1;
306 data_item_win
->width
= item_win_width
;
307 data_item_win
->origin
.x
= (item_win_width
* j
) + 1;
308 data_item_win
->origin
.y
= cur_y
;
309 tui_make_window (data_item_win
);
310 scrollok (data_item_win
->handle
, FALSE
);
312 touchwin (data_item_win
->handle
);
314 /* Get the printable representation of the register
316 tui_display_register (data_item_win
);
317 i
++; /* Next register. */
319 cur_y
++; /* Next row. */
324 /* See tui-regs.h. */
327 tui_data_window::display_reg_element_at_line (int start_element_no
,
330 if (!regs_content
.empty ())
332 int element_no
= start_element_no
;
334 if (start_element_no
!= 0 && start_line_no
!= 0)
336 int last_line_no
, first_line_on_last_page
;
338 last_line_no
= last_regs_line_no ();
339 first_line_on_last_page
= last_line_no
- (height
- 2);
340 if (first_line_on_last_page
< 0)
341 first_line_on_last_page
= 0;
343 /* If the element_no causes us to scroll past the end of the
344 registers, adjust what element to really start the
346 if (start_line_no
> first_line_on_last_page
)
347 element_no
= first_reg_element_no_inline (first_line_on_last_page
);
349 display_registers_from (element_no
);
353 /* See tui-regs.h. */
356 tui_data_window::display_registers_from_line (int line_no
)
358 check_and_display_highlight_if_needed ();
359 if (!regs_content
.empty ())
367 /* Make sure that we don't display off the end of the
369 if (line_no
>= last_regs_line_no ())
371 line_no
= line_from_reg_element_no (regs_content
.size () - 1);
377 element_no
= first_reg_element_no_inline (line_no
);
378 if (element_no
< regs_content
.size ())
379 display_reg_element_at_line (element_no
, line_no
);
386 return (-1); /* Nothing was displayed. */
390 /* Answer the index first element displayed. If none are displayed,
393 tui_data_window::first_data_item_displayed ()
395 for (int i
= 0; i
< regs_content
.size (); i
++)
397 struct tui_gen_win_info
*data_item_win
;
399 data_item_win
= ®s_content
[i
];
400 if (data_item_win
->is_visible ())
407 /* See tui-regs.h. */
410 tui_data_window::delete_data_content_windows ()
412 for (auto &&win
: regs_content
)
414 tui_delete_win (win
.handle
);
421 tui_data_window::erase_data_content (const char *prompt
)
424 check_and_display_highlight_if_needed ();
427 int half_width
= (width
- 2) / 2;
430 if (strlen (prompt
) >= half_width
)
433 x_pos
= half_width
- strlen (prompt
);
434 mvwaddstr (handle
, (height
/ 2), x_pos
, (char *) prompt
);
439 /* See tui-regs.h. */
442 tui_data_window::display_all_data ()
444 if (regs_content
.empty ())
445 erase_data_content (NO_DATA_STRING
);
448 erase_data_content (NULL
);
449 delete_data_content_windows ();
450 check_and_display_highlight_if_needed ();
451 display_registers_from (0);
456 /* Function to redisplay the contents of the data window. */
458 tui_data_window::refresh_all ()
460 erase_data_content (NULL
);
461 if (!regs_content
.empty ())
463 int first_element
= first_data_item_displayed ();
465 if (first_element
>= 0) /* Re-use existing windows. */
467 int first_line
= (-1);
469 if (first_element
< regs_content
.size ())
470 first_line
= line_from_reg_element_no (first_element
);
474 erase_data_content (NULL
);
475 display_registers_from_line (first_line
);
482 /* Scroll the data window vertically forward or backward. */
484 tui_data_window::do_scroll_vertical (int num_to_scroll
)
486 int first_element_no
;
487 int first_line
= (-1);
489 first_element_no
= first_data_item_displayed ();
490 if (first_element_no
< regs_content
.size ())
491 first_line
= line_from_reg_element_no (first_element_no
);
493 { /* Calculate the first line from the element number which is in
494 the general data content. */
499 first_line
+= num_to_scroll
;
500 erase_data_content (NULL
);
501 delete_data_content_windows ();
502 display_registers_from_line (first_line
);
506 /* See tui-regs.h. */
509 tui_data_window::rerender ()
511 /* Delete all data item windows. */
512 for (auto &&win
: regs_content
)
514 tui_delete_win (win
.handle
);
520 /* See tui-regs.h. */
523 tui_data_window::refresh_window ()
525 tui_gen_win_info::refresh_window ();
526 for (auto &&win
: regs_content
)
527 win
.refresh_window ();
530 /* This function check all displayed registers for changes in values,
531 given a particular frame. If the values have changed, they are
532 updated with the new value and highlighted. */
534 tui_data_window::check_register_values (struct frame_info
*frame
)
536 if (regs_content
.empty () && display_regs
)
537 show_registers (current_group
);
540 for (auto &&data_item_win
: regs_content
)
544 was_hilighted
= data_item_win
.highlight
;
546 tui_get_register (frame
, &data_item_win
,
547 data_item_win
.item_no
,
548 &data_item_win
.highlight
);
550 if (data_item_win
.highlight
|| was_hilighted
)
551 tui_display_register (&data_item_win
);
556 /* Display a register in a window. If hilite is TRUE, then the value
557 will be displayed in reverse video. */
559 tui_display_register (struct tui_data_item_window
*data
)
561 if (data
->handle
!= NULL
)
566 /* We ignore the return value, casting it to void in order to avoid
567 a compiler warning. The warning itself was introduced by a patch
568 to ncurses 5.7 dated 2009-08-29, changing this macro to expand
569 to code that causes the compiler to generate an unused-value
571 (void) wstandout (data
->handle
);
573 wmove (data
->handle
, 0, 0);
574 for (i
= 1; i
< data
->width
; i
++)
575 waddch (data
->handle
, ' ');
576 wmove (data
->handle
, 0, 0);
578 waddstr (data
->handle
, data
->content
.get ());
581 /* We ignore the return value, casting it to void in order to avoid
582 a compiler warning. The warning itself was introduced by a patch
583 to ncurses 5.7 dated 2009-08-29, changing this macro to expand
584 to code that causes the compiler to generate an unused-value
586 (void) wstandend (data
->handle
);
587 data
->refresh_window ();
591 /* Helper for "tui reg next", wraps a call to REGGROUP_NEXT, but adds wrap
592 around behaviour. Returns the next register group, or NULL if the
593 register window is not currently being displayed. */
595 static struct reggroup
*
596 tui_reg_next (struct reggroup
*current_group
, struct gdbarch
*gdbarch
)
598 struct reggroup
*group
= NULL
;
600 if (current_group
!= NULL
)
602 group
= reggroup_next (gdbarch
, current_group
);
604 group
= reggroup_next (gdbarch
, NULL
);
609 /* Helper for "tui reg prev", wraps a call to REGGROUP_PREV, but adds wrap
610 around behaviour. Returns the previous register group, or NULL if the
611 register window is not currently being displayed. */
613 static struct reggroup
*
614 tui_reg_prev (struct reggroup
*current_group
, struct gdbarch
*gdbarch
)
616 struct reggroup
*group
= NULL
;
618 if (current_group
!= NULL
)
620 group
= reggroup_prev (gdbarch
, current_group
);
622 group
= reggroup_prev (gdbarch
, NULL
);
627 /* A helper function to display the register window in the appropriate
633 enum tui_layout_type cur_layout
= tui_current_layout ();
634 enum tui_layout_type new_layout
;
635 if (cur_layout
== SRC_COMMAND
|| cur_layout
== SRC_DATA_COMMAND
)
636 new_layout
= SRC_DATA_COMMAND
;
638 new_layout
= DISASSEM_DATA_COMMAND
;
639 tui_set_layout (new_layout
);
642 /* Implement the 'tui reg' command. Changes the register group displayed
643 in the tui register window. Displays the tui register window if it is
644 not already on display. */
647 tui_reg_command (const char *args
, int from_tty
)
649 struct gdbarch
*gdbarch
= get_current_arch ();
653 struct reggroup
*group
, *match
= NULL
;
654 size_t len
= strlen (args
);
656 /* Make sure the curses mode is enabled. */
659 /* Make sure the register window is visible. If not, select an
660 appropriate layout. We need to do this before trying to run the
661 'next' or 'prev' commands. */
662 if (TUI_DATA_WIN
== NULL
|| !TUI_DATA_WIN
->is_visible ())
665 struct reggroup
*current_group
= TUI_DATA_WIN
->current_group
;
666 if (strncmp (args
, "next", len
) == 0)
667 match
= tui_reg_next (current_group
, gdbarch
);
668 else if (strncmp (args
, "prev", len
) == 0)
669 match
= tui_reg_prev (current_group
, gdbarch
);
671 /* This loop matches on the initial part of a register group
672 name. If this initial part in ARGS matches only one register
673 group then the switch is made. */
674 for (group
= reggroup_next (gdbarch
, NULL
);
676 group
= reggroup_next (gdbarch
, group
))
678 if (strncmp (reggroup_name (group
), args
, len
) == 0)
681 error (_("ambiguous register group name '%s'"), args
);
687 error (_("unknown register group '%s'"), args
);
689 TUI_DATA_WIN
->show_registers (match
);
693 struct reggroup
*group
;
696 printf_unfiltered (_("\"tui reg\" must be followed by the name of "
697 "either a register group,\nor one of 'next' "
698 "or 'prev'. Known register groups are:\n"));
700 for (first
= 1, group
= reggroup_next (gdbarch
, NULL
);
702 first
= 0, group
= reggroup_next (gdbarch
, group
))
705 printf_unfiltered (", ");
706 printf_unfiltered ("%s", reggroup_name (group
));
709 printf_unfiltered ("\n");
713 /* Complete names of register groups, and add the special "prev" and "next"
717 tui_reggroup_completer (struct cmd_list_element
*ignore
,
718 completion_tracker
&tracker
,
719 const char *text
, const char *word
)
721 static const char *extra
[] = { "next", "prev", NULL
};
722 size_t len
= strlen (word
);
725 reggroup_completer (ignore
, tracker
, text
, word
);
727 /* XXXX use complete_on_enum instead? */
728 for (tmp
= extra
; *tmp
!= NULL
; ++tmp
)
730 if (strncmp (word
, *tmp
, len
) == 0)
731 tracker
.add_completion (make_unique_xstrdup (*tmp
));
736 _initialize_tui_regs (void)
738 struct cmd_list_element
**tuicmd
, *cmd
;
740 tuicmd
= tui_get_cmd_list ();
742 cmd
= add_cmd ("reg", class_tui
, tui_reg_command
, _("\
743 TUI command to control the register window."), tuicmd
);
744 set_cmd_completer (cmd
, tui_reggroup_completer
);