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-windata.h"
36 #include "tui/tui-wingeneral.h"
37 #include "tui/tui-file.h"
38 #include "tui/tui-regs.h"
39 #include "tui/tui-io.h"
40 #include "reggroups.h"
42 #include "completer.h"
44 #include "gdb_curses.h"
47 /*****************************************
48 ** STATIC LOCAL FUNCTIONS FORWARD DECLS **
49 ******************************************/
51 tui_display_register (struct tui_data_element
*data
,
52 struct tui_gen_win_info
*win_info
);
54 static enum tui_status
tui_show_register_group (struct reggroup
*group
,
55 struct frame_info
*frame
,
56 int refresh_values_only
);
58 static enum tui_status
tui_get_register (struct frame_info
*frame
,
59 struct tui_data_element
*data
,
60 int regnum
, int *changedp
);
64 /*****************************************
65 ** PUBLIC FUNCTIONS **
66 ******************************************/
68 /* Answer the number of the last line in the regs display. If there
69 are no registers (-1) is returned. */
71 tui_last_regs_line_no (void)
75 if (TUI_DATA_WIN
->detail
.data_display_info
.regs_content_count
> 0)
77 num_lines
= (TUI_DATA_WIN
->detail
.data_display_info
.regs_content_count
/
78 TUI_DATA_WIN
->detail
.data_display_info
.regs_column_count
);
79 if (TUI_DATA_WIN
->detail
.data_display_info
.regs_content_count
%
80 TUI_DATA_WIN
->detail
.data_display_info
.regs_column_count
)
87 /* Answer the line number that the register element at element_no is
88 on. If element_no is greater than the number of register elements
89 there are, -1 is returned. */
91 tui_line_from_reg_element_no (int element_no
)
93 if (element_no
< TUI_DATA_WIN
->detail
.data_display_info
.regs_content_count
)
101 (TUI_DATA_WIN
->detail
.data_display_info
.regs_column_count
* i
))
114 /* Answer the index of the first element in line_no. If line_no is
115 past the register area (-1) is returned. */
117 tui_first_reg_element_no_inline (int line_no
)
119 if ((line_no
* TUI_DATA_WIN
->detail
.data_display_info
.regs_column_count
)
120 <= TUI_DATA_WIN
->detail
.data_display_info
.regs_content_count
)
121 return ((line_no
+ 1) *
122 TUI_DATA_WIN
->detail
.data_display_info
.regs_column_count
) -
123 TUI_DATA_WIN
->detail
.data_display_info
.regs_column_count
;
129 /* Show the registers of the given group in the data window
130 and refresh the window. */
132 tui_show_registers (struct reggroup
*group
)
134 enum tui_status ret
= TUI_FAILURE
;
135 struct tui_data_info
*display_info
;
137 /* Make sure the curses mode is enabled. */
140 /* Make sure the register window is visible. If not, select an
141 appropriate layout. */
142 if (TUI_DATA_WIN
== NULL
|| !TUI_DATA_WIN
->generic
.is_visible
)
143 tui_set_layout_by_name (DATA_NAME
);
145 display_info
= &TUI_DATA_WIN
->detail
.data_display_info
;
147 group
= general_reggroup
;
149 /* Say that registers should be displayed, even if there is a
151 display_info
->display_regs
= TRUE
;
153 if (target_has_registers
&& target_has_stack
&& target_has_memory
)
155 ret
= tui_show_register_group (group
, get_selected_frame (NULL
),
156 group
== display_info
->current_group
);
158 if (ret
== TUI_FAILURE
)
160 display_info
->current_group
= 0;
161 tui_erase_data_content (NO_REGS_STRING
);
167 /* Clear all notation of changed values. */
168 for (i
= 0; i
< display_info
->regs_content_count
; i
++)
170 struct tui_gen_win_info
*data_item_win
;
171 struct tui_win_element
*win
;
173 data_item_win
= &display_info
->regs_content
[i
]
174 ->which_element
.data_window
;
175 win
= data_item_win
->content
[0];
176 win
->which_element
.data
.highlight
= FALSE
;
178 display_info
->current_group
= group
;
179 tui_display_all_data ();
184 /* Set the data window to display the registers of the register group
185 using the given frame. Values are refreshed only when
186 refresh_values_only is TRUE. */
188 static enum tui_status
189 tui_show_register_group (struct reggroup
*group
,
190 struct frame_info
*frame
,
191 int refresh_values_only
)
193 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
194 enum tui_status ret
= TUI_FAILURE
;
196 int allocated_here
= FALSE
;
199 struct tui_data_info
*display_info
= &TUI_DATA_WIN
->detail
.data_display_info
;
201 /* Make a new title showing which group we display. */
202 snprintf (title
, sizeof (title
) - 1, "Register group: %s",
203 reggroup_name (group
));
204 xfree (TUI_DATA_WIN
->generic
.title
);
205 TUI_DATA_WIN
->generic
.title
= xstrdup (title
);
207 /* See how many registers must be displayed. */
209 for (regnum
= 0; regnum
< gdbarch_num_cooked_regs (gdbarch
); regnum
++)
213 /* Must be in the group. */
214 if (!gdbarch_register_reggroup_p (gdbarch
, regnum
, group
))
217 /* If the register name is empty, it is undefined for this
218 processor, so don't display anything. */
219 name
= gdbarch_register_name (gdbarch
, regnum
);
220 if (name
== 0 || *name
== '\0')
226 if (display_info
->regs_content_count
> 0 && !refresh_values_only
)
228 tui_free_data_content (display_info
->regs_content
,
229 display_info
->regs_content_count
);
230 display_info
->regs_content_count
= 0;
233 if (display_info
->regs_content_count
<= 0)
235 display_info
->regs_content
= tui_alloc_content (nr_regs
, DATA_WIN
);
236 allocated_here
= TRUE
;
237 refresh_values_only
= FALSE
;
240 if (display_info
->regs_content
!= NULL
)
242 if (!refresh_values_only
|| allocated_here
)
244 TUI_DATA_WIN
->generic
.content
= NULL
;
245 TUI_DATA_WIN
->generic
.content_size
= 0;
246 tui_add_content_elements (&TUI_DATA_WIN
->generic
, nr_regs
);
247 display_info
->regs_content
= TUI_DATA_WIN
->generic
.content
;
248 display_info
->regs_content_count
= nr_regs
;
251 /* Now set the register names and values. */
253 for (regnum
= 0; regnum
< gdbarch_num_cooked_regs (gdbarch
); regnum
++)
255 struct tui_gen_win_info
*data_item_win
;
256 struct tui_data_element
*data
;
259 /* Must be in the group. */
260 if (!gdbarch_register_reggroup_p (gdbarch
, regnum
, group
))
263 /* If the register name is empty, it is undefined for this
264 processor, so don't display anything. */
265 name
= gdbarch_register_name (gdbarch
, regnum
);
266 if (name
== 0 || *name
== '\0')
270 &display_info
->regs_content
[pos
]->which_element
.data_window
;
271 data
= &data_item_win
->content
[0]->which_element
.data
;
274 if (!refresh_values_only
)
276 data
->item_no
= regnum
;
278 data
->highlight
= FALSE
;
280 tui_get_register (frame
, data
, regnum
, 0);
285 TUI_DATA_WIN
->generic
.content_size
=
286 display_info
->regs_content_count
+ display_info
->data_content_count
;
293 /* Function to display the registers in the content from
294 'start_element_no' until the end of the register content or the end
295 of the display height. No checking for displaying past the end of
296 the registers is done here. */
298 tui_display_registers_from (int start_element_no
)
300 struct tui_data_info
*display_info
= &TUI_DATA_WIN
->detail
.data_display_info
;
302 if (display_info
->regs_content
!= NULL
303 && display_info
->regs_content_count
> 0)
305 int i
= start_element_no
;
306 int j
, item_win_width
, cur_y
;
309 for (i
= 0; i
< display_info
->regs_content_count
; i
++)
311 struct tui_data_element
*data
;
312 struct tui_gen_win_info
*data_item_win
;
317 = &display_info
->regs_content
[i
]->which_element
.data_window
;
318 data
= &data_item_win
->content
[0]->which_element
.data
;
325 len
= 8 * ((len
/ 8) + 1);
333 item_win_width
= max_len
+ 1;
334 i
= start_element_no
;
336 display_info
->regs_column_count
=
337 (TUI_DATA_WIN
->generic
.width
- 2) / item_win_width
;
338 if (display_info
->regs_column_count
== 0)
339 display_info
->regs_column_count
= 1;
341 (TUI_DATA_WIN
->generic
.width
- 2) / display_info
->regs_column_count
;
343 /* Now create each data "sub" window, and write the display into
346 while (i
< display_info
->regs_content_count
347 && cur_y
<= TUI_DATA_WIN
->generic
.viewport_height
)
350 j
< display_info
->regs_column_count
351 && i
< display_info
->regs_content_count
;
354 struct tui_gen_win_info
*data_item_win
;
355 struct tui_data_element
*data_element_ptr
;
357 /* Create the window if necessary. */
358 data_item_win
= &display_info
->regs_content
[i
]
359 ->which_element
.data_window
;
360 data_element_ptr
= &data_item_win
->content
[0]->which_element
.data
;
361 if (data_item_win
->handle
!= NULL
362 && (data_item_win
->height
!= 1
363 || data_item_win
->width
!= item_win_width
364 || data_item_win
->origin
.x
!= (item_win_width
* j
) + 1
365 || data_item_win
->origin
.y
!= cur_y
))
367 tui_delete_win (data_item_win
->handle
);
368 data_item_win
->handle
= 0;
371 if (data_item_win
->handle
== NULL
)
373 data_item_win
->height
= 1;
374 data_item_win
->width
= item_win_width
;
375 data_item_win
->origin
.x
= (item_win_width
* j
) + 1;
376 data_item_win
->origin
.y
= cur_y
;
377 tui_make_window (data_item_win
, DONT_BOX_WINDOW
);
378 scrollok (data_item_win
->handle
, FALSE
);
380 touchwin (data_item_win
->handle
);
382 /* Get the printable representation of the register
384 tui_display_register (data_element_ptr
, data_item_win
);
385 i
++; /* Next register. */
387 cur_y
++; /* Next row. */
393 /* Function to display the registers in the content from
394 'start_element_no' on 'start_line_no' until the end of the register
395 content or the end of the display height. This function checks
396 that we won't display off the end of the register display. */
398 tui_display_reg_element_at_line (int start_element_no
,
401 if (TUI_DATA_WIN
->detail
.data_display_info
.regs_content
!= NULL
402 && TUI_DATA_WIN
->detail
.data_display_info
.regs_content_count
> 0)
404 int element_no
= start_element_no
;
406 if (start_element_no
!= 0 && start_line_no
!= 0)
408 int last_line_no
, first_line_on_last_page
;
410 last_line_no
= tui_last_regs_line_no ();
411 first_line_on_last_page
412 = last_line_no
- (TUI_DATA_WIN
->generic
.height
- 2);
413 if (first_line_on_last_page
< 0)
414 first_line_on_last_page
= 0;
416 /* If there is no other data displayed except registers, and
417 the element_no causes us to scroll past the end of the
418 registers, adjust what element to really start the
420 if (TUI_DATA_WIN
->detail
.data_display_info
.data_content_count
<= 0
421 && start_line_no
> first_line_on_last_page
)
423 = tui_first_reg_element_no_inline (first_line_on_last_page
);
425 tui_display_registers_from (element_no
);
431 /* Function to display the registers starting at line line_no in the
432 data window. Answers the line number that the display actually
433 started from. If nothing is displayed (-1) is returned. */
435 tui_display_registers_from_line (int line_no
,
438 if (TUI_DATA_WIN
->detail
.data_display_info
.regs_content_count
> 0)
440 int line
, element_no
;
444 else if (force_display
)
445 { /* If we must display regs (force_display is true), then
446 make sure that we don't display off the end of the
448 if (line_no
>= tui_last_regs_line_no ())
450 if ((line
= tui_line_from_reg_element_no (
451 TUI_DATA_WIN
->detail
.data_display_info
.regs_content_count
- 1)) < 0)
460 element_no
= tui_first_reg_element_no_inline (line
);
462 < TUI_DATA_WIN
->detail
.data_display_info
.regs_content_count
)
463 tui_display_reg_element_at_line (element_no
, line
);
470 return (-1); /* Nothing was displayed. */
474 /* This function check all displayed registers for changes in values,
475 given a particular frame. If the values have changed, they are
476 updated with the new value and highlighted. */
478 tui_check_register_values (struct frame_info
*frame
)
480 if (TUI_DATA_WIN
!= NULL
481 && TUI_DATA_WIN
->generic
.is_visible
)
483 struct tui_data_info
*display_info
484 = &TUI_DATA_WIN
->detail
.data_display_info
;
486 if (display_info
->regs_content_count
<= 0
487 && display_info
->display_regs
)
488 tui_show_registers (display_info
->current_group
);
493 for (i
= 0; (i
< display_info
->regs_content_count
); i
++)
495 struct tui_data_element
*data
;
496 struct tui_gen_win_info
*data_item_win_ptr
;
499 data_item_win_ptr
= &display_info
->regs_content
[i
]->
500 which_element
.data_window
;
501 data
= &data_item_win_ptr
->content
[0]->which_element
.data
;
502 was_hilighted
= data
->highlight
;
504 tui_get_register (frame
, data
,
505 data
->item_no
, &data
->highlight
);
507 if (data
->highlight
|| was_hilighted
)
509 tui_display_register (data
, data_item_win_ptr
);
516 /* Display a register in a window. If hilite is TRUE, then the value
517 will be displayed in reverse video. */
519 tui_display_register (struct tui_data_element
*data
,
520 struct tui_gen_win_info
*win_info
)
522 if (win_info
->handle
!= NULL
)
527 /* We ignore the return value, casting it to void in order to avoid
528 a compiler warning. The warning itself was introduced by a patch
529 to ncurses 5.7 dated 2009-08-29, changing this macro to expand
530 to code that causes the compiler to generate an unused-value
532 (void) wstandout (win_info
->handle
);
534 wmove (win_info
->handle
, 0, 0);
535 for (i
= 1; i
< win_info
->width
; i
++)
536 waddch (win_info
->handle
, ' ');
537 wmove (win_info
->handle
, 0, 0);
539 waddstr (win_info
->handle
, data
->content
);
542 /* We ignore the return value, casting it to void in order to avoid
543 a compiler warning. The warning itself was introduced by a patch
544 to ncurses 5.7 dated 2009-08-29, changing this macro to expand
545 to code that causes the compiler to generate an unused-value
547 (void) wstandend (win_info
->handle
);
548 tui_refresh_win (win_info
);
552 /* Helper for "tui reg next", wraps a call to REGGROUP_NEXT, but adds wrap
553 around behaviour. Returns the next register group, or NULL if the
554 register window is not currently being displayed. */
556 static struct reggroup
*
557 tui_reg_next (struct gdbarch
*gdbarch
)
559 struct reggroup
*group
= NULL
;
561 if (TUI_DATA_WIN
!= NULL
)
563 group
= TUI_DATA_WIN
->detail
.data_display_info
.current_group
;
564 group
= reggroup_next (gdbarch
, group
);
566 group
= reggroup_next (gdbarch
, NULL
);
571 /* Helper for "tui reg prev", wraps a call to REGGROUP_PREV, but adds wrap
572 around behaviour. Returns the previous register group, or NULL if the
573 register window is not currently being displayed. */
575 static struct reggroup
*
576 tui_reg_prev (struct gdbarch
*gdbarch
)
578 struct reggroup
*group
= NULL
;
580 if (TUI_DATA_WIN
!= NULL
)
582 group
= TUI_DATA_WIN
->detail
.data_display_info
.current_group
;
583 group
= reggroup_prev (gdbarch
, group
);
585 group
= reggroup_prev (gdbarch
, NULL
);
590 /* Implement the 'tui reg' command. Changes the register group displayed
591 in the tui register window. Displays the tui register window if it is
592 not already on display. */
595 tui_reg_command (const char *args
, int from_tty
)
597 struct gdbarch
*gdbarch
= get_current_arch ();
601 struct reggroup
*group
, *match
= NULL
;
602 size_t len
= strlen (args
);
604 /* Make sure the curses mode is enabled. */
607 /* Make sure the register window is visible. If not, select an
608 appropriate layout. We need to do this before trying to run the
609 'next' or 'prev' commands. */
610 if (TUI_DATA_WIN
== NULL
|| !TUI_DATA_WIN
->generic
.is_visible
)
611 tui_set_layout_by_name (DATA_NAME
);
613 if (strncmp (args
, "next", len
) == 0)
614 match
= tui_reg_next (gdbarch
);
615 else if (strncmp (args
, "prev", len
) == 0)
616 match
= tui_reg_prev (gdbarch
);
618 /* This loop matches on the initial part of a register group
619 name. If this initial part in ARGS matches only one register
620 group then the switch is made. */
621 for (group
= reggroup_next (gdbarch
, NULL
);
623 group
= reggroup_next (gdbarch
, group
))
625 if (strncmp (reggroup_name (group
), args
, len
) == 0)
628 error (_("ambiguous register group name '%s'"), args
);
634 error (_("unknown register group '%s'"), args
);
636 tui_show_registers (match
);
640 struct reggroup
*group
;
643 printf_unfiltered (_("\"tui reg\" must be followed by the name of "
644 "either a register group,\nor one of 'next' "
645 "or 'prev'. Known register groups are:\n"));
647 for (first
= 1, group
= reggroup_next (gdbarch
, NULL
);
649 first
= 0, group
= reggroup_next (gdbarch
, group
))
652 printf_unfiltered (", ");
653 printf_unfiltered ("%s", reggroup_name (group
));
656 printf_unfiltered ("\n");
660 /* Complete names of register groups, and add the special "prev" and "next"
664 tui_reggroup_completer (struct cmd_list_element
*ignore
,
665 completion_tracker
&tracker
,
666 const char *text
, const char *word
)
668 static const char *extra
[] = { "next", "prev", NULL
};
669 size_t len
= strlen (word
);
672 reggroup_completer (ignore
, tracker
, text
, word
);
674 /* XXXX use complete_on_enum instead? */
675 for (tmp
= extra
; *tmp
!= NULL
; ++tmp
)
677 if (strncmp (word
, *tmp
, len
) == 0)
678 tracker
.add_completion (make_unique_xstrdup (*tmp
));
683 _initialize_tui_regs (void)
685 struct cmd_list_element
**tuicmd
, *cmd
;
687 tuicmd
= tui_get_cmd_list ();
689 cmd
= add_cmd ("reg", class_tui
, tui_reg_command
, _("\
690 TUI command to control the register window."), tuicmd
);
691 set_cmd_completer (cmd
, tui_reggroup_completer
);
695 /*****************************************
696 ** STATIC LOCAL FUNCTIONS **
697 ******************************************/
699 /* Get the register from the frame and return a printable
700 representation of it. */
703 tui_register_format (struct frame_info
*frame
, int regnum
)
705 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
709 scoped_restore save_pagination
710 = make_scoped_restore (&pagination_enabled
, 0);
711 scoped_restore save_stdout
712 = make_scoped_restore (&gdb_stdout
, &stream
);
714 gdbarch_print_registers_info (gdbarch
, &stream
, frame
, regnum
, 1);
716 /* Remove the possible \n. */
717 std::string
&str
= stream
.string ();
718 if (!str
.empty () && str
.back () == '\n')
719 str
.resize (str
.size () - 1);
721 /* Expand tabs into spaces, since ncurses on MS-Windows doesn't. */
722 return tui_expand_tabs (str
.c_str (), 0);
725 /* Get the register value from the given frame and format it for the
726 display. When changep is set, check if the new register value has
727 changed with respect to the previous call. */
728 static enum tui_status
729 tui_get_register (struct frame_info
*frame
,
730 struct tui_data_element
*data
,
731 int regnum
, int *changedp
)
733 enum tui_status ret
= TUI_FAILURE
;
737 if (target_has_registers
)
739 char *prev_content
= data
->content
;
741 data
->content
= tui_register_format (frame
, regnum
);
744 && strcmp (prev_content
, data
->content
) != 0)
747 xfree (prev_content
);