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 != (tui_win_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 != (tui_win_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 != (WINDOW*) 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 == (WINDOW *) 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
402 != (tui_win_content) NULL
403 && TUI_DATA_WIN->detail.data_display_info.regs_content_count > 0)
405 int element_no = start_element_no;
407 if (start_element_no != 0 && start_line_no != 0)
409 int last_line_no, first_line_on_last_page;
411 last_line_no = tui_last_regs_line_no ();
412 first_line_on_last_page
413 = last_line_no - (TUI_DATA_WIN->generic.height - 2);
414 if (first_line_on_last_page < 0)
415 first_line_on_last_page = 0;
417 /* If there is no other data displayed except registers, and
418 the element_no causes us to scroll past the end of the
419 registers, adjust what element to really start the
421 if (TUI_DATA_WIN->detail.data_display_info.data_content_count <= 0
422 && start_line_no > first_line_on_last_page)
424 = tui_first_reg_element_no_inline (first_line_on_last_page);
426 tui_display_registers_from (element_no);
432 /* Function to display the registers starting at line line_no in the
433 data window. Answers the line number that the display actually
434 started from. If nothing is displayed (-1) is returned. */
436 tui_display_registers_from_line (int line_no,
439 if (TUI_DATA_WIN->detail.data_display_info.regs_content_count > 0)
441 int line, element_no;
445 else if (force_display)
446 { /* If we must display regs (force_display is true), then
447 make sure that we don't display off the end of the
449 if (line_no >= tui_last_regs_line_no ())
451 if ((line = tui_line_from_reg_element_no (
452 TUI_DATA_WIN->detail.data_display_info.regs_content_count - 1)) < 0)
461 element_no = tui_first_reg_element_no_inline (line);
463 < TUI_DATA_WIN->detail.data_display_info.regs_content_count)
464 tui_display_reg_element_at_line (element_no, line);
471 return (-1); /* Nothing was displayed. */
475 /* This function check all displayed registers for changes in values,
476 given a particular frame. If the values have changed, they are
477 updated with the new value and highlighted. */
479 tui_check_register_values (struct frame_info *frame)
481 if (TUI_DATA_WIN != NULL
482 && TUI_DATA_WIN->generic.is_visible)
484 struct tui_data_info *display_info
485 = &TUI_DATA_WIN->detail.data_display_info;
487 if (display_info->regs_content_count <= 0
488 && display_info->display_regs)
489 tui_show_registers (display_info->current_group);
494 for (i = 0; (i < display_info->regs_content_count); i++)
496 struct tui_data_element *data;
497 struct tui_gen_win_info *data_item_win_ptr;
500 data_item_win_ptr = &display_info->regs_content[i]->
501 which_element.data_window;
502 data = &data_item_win_ptr->content[0]->which_element.data;
503 was_hilighted = data->highlight;
505 tui_get_register (frame, data,
506 data->item_no, &data->highlight);
508 if (data->highlight || was_hilighted)
510 tui_display_register (data, data_item_win_ptr);
517 /* Display a register in a window. If hilite is TRUE, then the value
518 will be displayed in reverse video. */
520 tui_display_register (struct tui_data_element *data,
521 struct tui_gen_win_info *win_info)
523 if (win_info->handle != (WINDOW *) NULL)
528 /* We ignore the return value, casting it to void in order to avoid
529 a compiler warning. The warning itself was introduced by a patch
530 to ncurses 5.7 dated 2009-08-29, changing this macro to expand
531 to code that causes the compiler to generate an unused-value
533 (void) wstandout (win_info->handle);
535 wmove (win_info->handle, 0, 0);
536 for (i = 1; i < win_info->width; i++)
537 waddch (win_info->handle, ' ');
538 wmove (win_info->handle, 0, 0);
540 waddstr (win_info->handle, data->content);
543 /* We ignore the return value, casting it to void in order to avoid
544 a compiler warning. The warning itself was introduced by a patch
545 to ncurses 5.7 dated 2009-08-29, changing this macro to expand
546 to code that causes the compiler to generate an unused-value
548 (void) wstandend (win_info->handle);
549 tui_refresh_win (win_info);
553 /* Helper for "tui reg next", wraps a call to REGGROUP_NEXT, but adds wrap
554 around behaviour. Returns the next register group, or NULL if the
555 register window is not currently being displayed. */
557 static struct reggroup *
558 tui_reg_next (struct gdbarch *gdbarch)
560 struct reggroup *group = NULL;
562 if (TUI_DATA_WIN != NULL)
564 group = TUI_DATA_WIN->detail.data_display_info.current_group;
565 group = reggroup_next (gdbarch, group);
567 group = reggroup_next (gdbarch, NULL);
572 /* Helper for "tui reg prev", wraps a call to REGGROUP_PREV, but adds wrap
573 around behaviour. Returns the previous register group, or NULL if the
574 register window is not currently being displayed. */
576 static struct reggroup *
577 tui_reg_prev (struct gdbarch *gdbarch)
579 struct reggroup *group = NULL;
581 if (TUI_DATA_WIN != NULL)
583 group = TUI_DATA_WIN->detail.data_display_info.current_group;
584 group = reggroup_prev (gdbarch, group);
586 group = reggroup_prev (gdbarch, NULL);
591 /* Implement the 'tui reg' command. Changes the register group displayed
592 in the tui register window. Displays the tui register window if it is
593 not already on display. */
596 tui_reg_command (const char *args, int from_tty)
598 struct gdbarch *gdbarch = get_current_arch ();
602 struct reggroup *group, *match = NULL;
603 size_t len = strlen (args);
605 /* Make sure the curses mode is enabled. */
608 /* Make sure the register window is visible. If not, select an
609 appropriate layout. We need to do this before trying to run the
610 'next' or 'prev' commands. */
611 if (TUI_DATA_WIN == NULL || !TUI_DATA_WIN->generic.is_visible)
612 tui_set_layout_by_name (DATA_NAME);
614 if (strncmp (args, "next", len) == 0)
615 match = tui_reg_next (gdbarch);
616 else if (strncmp (args, "prev", len) == 0)
617 match = tui_reg_prev (gdbarch);
619 /* This loop matches on the initial part of a register group
620 name. If this initial part in ARGS matches only one register
621 group then the switch is made. */
622 for (group = reggroup_next (gdbarch, NULL);
624 group = reggroup_next (gdbarch, group))
626 if (strncmp (reggroup_name (group), args, len) == 0)
629 error (_("ambiguous register group name '%s'"), args);
635 error (_("unknown register group '%s'"), args);
637 tui_show_registers (match);
641 struct reggroup *group;
644 printf_unfiltered (_("\"tui reg\" must be followed by the name of "
645 "either a register group,\nor one of 'next' "
646 "or 'prev'. Known register groups are:\n"));
648 for (first = 1, group = reggroup_next (gdbarch, NULL);
650 first = 0, group = reggroup_next (gdbarch, group))
653 printf_unfiltered (", ");
654 printf_unfiltered ("%s", reggroup_name (group));
657 printf_unfiltered ("\n");
661 /* Complete names of register groups, and add the special "prev" and "next"
665 tui_reggroup_completer (struct cmd_list_element *ignore,
666 completion_tracker &tracker,
667 const char *text, const char *word)
669 static const char *extra[] = { "next", "prev", NULL };
670 size_t len = strlen (word);
673 reggroup_completer (ignore, tracker, text, word);
675 /* XXXX use complete_on_enum instead? */
676 for (tmp = extra; *tmp != NULL; ++tmp)
678 if (strncmp (word, *tmp, len) == 0)
679 tracker.add_completion (gdb::unique_xmalloc_ptr<char> (xstrdup (*tmp)));
684 _initialize_tui_regs (void)
686 struct cmd_list_element **tuicmd, *cmd;
688 tuicmd = tui_get_cmd_list ();
690 cmd = add_cmd ("reg", class_tui, tui_reg_command, _("\
691 TUI command to control the register window."), tuicmd);
692 set_cmd_completer (cmd, tui_reggroup_completer);
696 /*****************************************
697 ** STATIC LOCAL FUNCTIONS **
698 ******************************************/
700 /* Get the register from the frame and return a printable
701 representation of it. */
704 tui_register_format (struct frame_info *frame, int regnum)
706 struct gdbarch *gdbarch = get_frame_arch (frame);
710 scoped_restore save_pagination
711 = make_scoped_restore (&pagination_enabled, 0);
712 scoped_restore save_stdout
713 = make_scoped_restore (&gdb_stdout, &stream);
715 gdbarch_print_registers_info (gdbarch, &stream, frame, regnum, 1);
717 /* Remove the possible \n. */
718 std::string &str = stream.string ();
719 if (!str.empty () && str.back () == '\n')
720 str.resize (str.size () - 1);
722 /* Expand tabs into spaces, since ncurses on MS-Windows doesn't. */
723 return tui_expand_tabs (str.c_str (), 0);
726 /* Get the register value from the given frame and format it for the
727 display. When changep is set, check if the new register value has
728 changed with respect to the previous call. */
729 static enum tui_status
730 tui_get_register (struct frame_info *frame,
731 struct tui_data_element *data,
732 int regnum, int *changedp)
734 enum tui_status ret = TUI_FAILURE;
738 if (target_has_registers)
740 char *prev_content = data->content;
742 data->content = tui_register_format (frame, regnum);
745 && strcmp (prev_content, data->content) != 0)
748 xfree (prev_content);