1 /* TUI display registers in window.
3 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2007
4 Free Software Foundation, Inc.
6 Contributed by Hewlett-Packard Company.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 Boston, MA 02110-1301, USA. */
27 #include "tui/tui-data.h"
35 #include "gdb_string.h"
36 #include "tui/tui-layout.h"
37 #include "tui/tui-win.h"
38 #include "tui/tui-windata.h"
39 #include "tui/tui-wingeneral.h"
40 #include "tui/tui-file.h"
41 #include "reggroups.h"
43 #include "gdb_curses.h"
46 /*****************************************
47 ** STATIC LOCAL FUNCTIONS FORWARD DECLS **
48 ******************************************/
50 tui_display_register (struct tui_data_element *data,
51 struct tui_gen_win_info *win_info);
53 static enum tui_status
54 tui_show_register_group (struct gdbarch *gdbarch, struct reggroup *group,
55 struct frame_info *frame, int refresh_values_only);
57 static enum tui_status
58 tui_get_register (struct gdbarch *gdbarch, struct frame_info *frame,
59 struct tui_data_element *data, int regnum, int *changedp);
60 static void tui_register_format
61 (struct gdbarch *, struct frame_info *, struct tui_data_element*, int);
62 static void tui_scroll_regs_forward_command (char *, int);
63 static void tui_scroll_regs_backward_command (char *, int);
67 /*****************************************
68 ** PUBLIC FUNCTIONS **
69 ******************************************/
71 /* Answer the number of the last line in the regs display. If there
72 are no registers (-1) is returned. */
74 tui_last_regs_line_no (void)
78 if (TUI_DATA_WIN->detail.data_display_info.regs_content_count > 0)
80 num_lines = (TUI_DATA_WIN->detail.data_display_info.regs_content_count /
81 TUI_DATA_WIN->detail.data_display_info.regs_column_count);
82 if (TUI_DATA_WIN->detail.data_display_info.regs_content_count %
83 TUI_DATA_WIN->detail.data_display_info.regs_column_count)
90 /* Answer the line number that the register element at element_no is
91 on. If element_no is greater than the number of register elements
92 there are, -1 is returned. */
94 tui_line_from_reg_element_no (int element_no)
96 if (element_no < TUI_DATA_WIN->detail.data_display_info.regs_content_count)
104 (TUI_DATA_WIN->detail.data_display_info.regs_column_count * i))
117 /* Answer the index of the first element in line_no. If line_no is past
118 the register area (-1) is returned. */
120 tui_first_reg_element_no_inline (int line_no)
122 if ((line_no * TUI_DATA_WIN->detail.data_display_info.regs_column_count)
123 <= TUI_DATA_WIN->detail.data_display_info.regs_content_count)
124 return ((line_no + 1) *
125 TUI_DATA_WIN->detail.data_display_info.regs_column_count) -
126 TUI_DATA_WIN->detail.data_display_info.regs_column_count;
132 /* Answer the index of the last element in line_no. If line_no is
133 past the register area (-1) is returned. */
135 tui_last_reg_element_no_in_line (int line_no)
137 if ((line_no * TUI_DATA_WIN->detail.data_display_info.regs_column_count) <=
138 TUI_DATA_WIN->detail.data_display_info.regs_content_count)
139 return ((line_no + 1) *
140 TUI_DATA_WIN->detail.data_display_info.regs_column_count) - 1;
145 /* Show the registers of the given group in the data window
146 and refresh the window. */
148 tui_show_registers (struct reggroup *group)
150 enum tui_status ret = TUI_FAILURE;
151 struct tui_data_info *display_info;
153 /* Make sure the curses mode is enabled. */
156 /* Make sure the register window is visible. If not, select an
157 appropriate layout. */
158 if (TUI_DATA_WIN == NULL || !TUI_DATA_WIN->generic.is_visible)
159 tui_set_layout_for_display_command (DATA_NAME);
161 display_info = &TUI_DATA_WIN->detail.data_display_info;
163 group = general_reggroup;
165 /* Say that registers should be displayed, even if there is a problem. */
166 display_info->display_regs = TRUE;
168 if (target_has_registers && target_has_stack && target_has_memory)
170 ret = tui_show_register_group (current_gdbarch, group,
171 get_current_frame (),
172 group == display_info->current_group);
174 if (ret == TUI_FAILURE)
176 display_info->current_group = 0;
177 tui_erase_data_content (NO_REGS_STRING);
183 /* Clear all notation of changed values */
184 for (i = 0; i < display_info->regs_content_count; i++)
186 struct tui_gen_win_info *data_item_win;
187 struct tui_win_element *win;
189 data_item_win = &display_info->regs_content[i]
190 ->which_element.data_window;
191 win = (struct tui_win_element *) data_item_win->content[0];
192 win->which_element.data.highlight = FALSE;
194 display_info->current_group = group;
195 tui_display_all_data ();
200 /* Set the data window to display the registers of the register group
201 using the given frame. Values are refreshed only when refresh_values_only
204 static enum tui_status
205 tui_show_register_group (struct gdbarch *gdbarch, struct reggroup *group,
206 struct frame_info *frame, int refresh_values_only)
208 enum tui_status ret = TUI_FAILURE;
210 int allocated_here = FALSE;
213 struct tui_data_info *display_info = &TUI_DATA_WIN->detail.data_display_info;
215 /* Make a new title showing which group we display. */
216 snprintf (title, sizeof (title) - 1, "Register group: %s",
217 reggroup_name (group));
218 xfree (TUI_DATA_WIN->generic.title);
219 TUI_DATA_WIN->generic.title = xstrdup (title);
221 /* See how many registers must be displayed. */
224 regnum < gdbarch_num_regs (current_gdbarch)
225 + gdbarch_num_pseudo_regs (current_gdbarch);
228 /* Must be in the group and have a name. */
229 if (gdbarch_register_reggroup_p (gdbarch, regnum, group)
230 && gdbarch_register_name (gdbarch, regnum) != 0)
234 if (display_info->regs_content_count > 0 && !refresh_values_only)
236 tui_free_data_content (display_info->regs_content,
237 display_info->regs_content_count);
238 display_info->regs_content_count = 0;
241 if (display_info->regs_content_count <= 0)
243 display_info->regs_content = tui_alloc_content (nr_regs, DATA_WIN);
244 allocated_here = TRUE;
245 refresh_values_only = FALSE;
248 if (display_info->regs_content != (tui_win_content) NULL)
250 if (!refresh_values_only || allocated_here)
252 TUI_DATA_WIN->generic.content = (void*) NULL;
253 TUI_DATA_WIN->generic.content_size = 0;
254 tui_add_content_elements (&TUI_DATA_WIN->generic, nr_regs);
255 display_info->regs_content
256 = (tui_win_content) TUI_DATA_WIN->generic.content;
257 display_info->regs_content_count = nr_regs;
260 /* Now set the register names and values */
263 regnum < gdbarch_num_regs (current_gdbarch)
264 + gdbarch_num_pseudo_regs (current_gdbarch);
267 struct tui_gen_win_info *data_item_win;
268 struct tui_data_element *data;
271 if (!gdbarch_register_reggroup_p (gdbarch, regnum, group))
274 name = gdbarch_register_name (gdbarch, regnum);
279 &display_info->regs_content[pos]->which_element.data_window;
281 &((struct tui_win_element *) data_item_win->content[0])->which_element.data;
284 if (!refresh_values_only)
286 data->item_no = regnum;
288 data->highlight = FALSE;
290 if (data->value == (void*) NULL)
291 data->value = (void*) xmalloc (MAX_REGISTER_SIZE);
293 tui_get_register (gdbarch, frame, data, regnum, 0);
298 TUI_DATA_WIN->generic.content_size =
299 display_info->regs_content_count + display_info->data_content_count;
306 /* Function to display the registers in the content from
307 'start_element_no' until the end of the register content or the end
308 of the display height. No checking for displaying past the end of
309 the registers is done here. */
311 tui_display_registers_from (int start_element_no)
313 struct tui_data_info *display_info = &TUI_DATA_WIN->detail.data_display_info;
315 if (display_info->regs_content != (tui_win_content) NULL &&
316 display_info->regs_content_count > 0)
318 int i = start_element_no;
319 int j, value_chars_wide, item_win_width, cur_y;
322 for (i = 0; i < display_info->regs_content_count; i++)
324 struct tui_data_element *data;
325 struct tui_gen_win_info *data_item_win;
329 data_item_win = &display_info->regs_content[i]->which_element.data_window;
330 data = &((struct tui_win_element *)
331 data_item_win->content[0])->which_element.data;
338 len = 8 * ((len / 8) + 1);
346 item_win_width = max_len + 1;
347 i = start_element_no;
349 display_info->regs_column_count =
350 (TUI_DATA_WIN->generic.width - 2) / item_win_width;
351 if (display_info->regs_column_count == 0)
352 display_info->regs_column_count = 1;
354 (TUI_DATA_WIN->generic.width - 2) / display_info->regs_column_count;
357 ** Now create each data "sub" window, and write the display into it.
360 while (i < display_info->regs_content_count &&
361 cur_y <= TUI_DATA_WIN->generic.viewport_height)
364 (j < display_info->regs_column_count &&
365 i < display_info->regs_content_count); j++)
367 struct tui_gen_win_info * data_item_win;
368 struct tui_data_element * data_element_ptr;
370 /* create the window if necessary */
371 data_item_win = &display_info->regs_content[i]
372 ->which_element.data_window;
373 data_element_ptr = &((struct tui_win_element *)
374 data_item_win->content[0])->which_element.data;
375 if (data_item_win->handle != (WINDOW*) NULL
376 && (data_item_win->height != 1
377 || data_item_win->width != item_win_width
378 || data_item_win->origin.x != (item_win_width * j) + 1
379 || data_item_win->origin.y != cur_y))
381 tui_delete_win (data_item_win->handle);
382 data_item_win->handle = 0;
385 if (data_item_win->handle == (WINDOW *) NULL)
387 data_item_win->height = 1;
388 data_item_win->width = item_win_width;
389 data_item_win->origin.x = (item_win_width * j) + 1;
390 data_item_win->origin.y = cur_y;
391 tui_make_window (data_item_win, DONT_BOX_WINDOW);
392 scrollok (data_item_win->handle, FALSE);
394 touchwin (data_item_win->handle);
396 /* Get the printable representation of the register
398 tui_display_register (data_element_ptr, data_item_win);
399 i++; /* next register */
401 cur_y++; /* next row; */
407 /* Function to display the registers in the content from
408 'start_element_no' on 'start_line_no' until the end of the register
409 content or the end of the display height. This function checks
410 that we won't display off the end of the register display. */
412 tui_display_reg_element_at_line (int start_element_no, int start_line_no)
414 if (TUI_DATA_WIN->detail.data_display_info.regs_content != (tui_win_content) NULL &&
415 TUI_DATA_WIN->detail.data_display_info.regs_content_count > 0)
417 int element_no = start_element_no;
419 if (start_element_no != 0 && start_line_no != 0)
421 int last_line_no, first_line_on_last_page;
423 last_line_no = tui_last_regs_line_no ();
424 first_line_on_last_page = last_line_no - (TUI_DATA_WIN->generic.height - 2);
425 if (first_line_on_last_page < 0)
426 first_line_on_last_page = 0;
428 ** If there is no other data displayed except registers,
429 ** and the element_no causes us to scroll past the end of the
430 ** registers, adjust what element to really start the display at.
432 if (TUI_DATA_WIN->detail.data_display_info.data_content_count <= 0 &&
433 start_line_no > first_line_on_last_page)
434 element_no = tui_first_reg_element_no_inline (first_line_on_last_page);
436 tui_display_registers_from (element_no);
442 /* Function to display the registers starting at line line_no in the
443 data window. Answers the line number that the display actually
444 started from. If nothing is displayed (-1) is returned. */
446 tui_display_registers_from_line (int line_no, int force_display)
448 if (TUI_DATA_WIN->detail.data_display_info.regs_content_count > 0)
450 int line, element_no;
454 else if (force_display)
456 ** If we must display regs (force_display is true), then make
457 ** sure that we don't display off the end of the registers.
459 if (line_no >= tui_last_regs_line_no ())
461 if ((line = tui_line_from_reg_element_no (
462 TUI_DATA_WIN->detail.data_display_info.regs_content_count - 1)) < 0)
471 element_no = tui_first_reg_element_no_inline (line);
472 if (element_no < TUI_DATA_WIN->detail.data_display_info.regs_content_count)
473 tui_display_reg_element_at_line (element_no, line);
480 return (-1); /* nothing was displayed */
484 /* This function check all displayed registers for changes in values,
485 given a particular frame. If the values have changed, they are
486 updated with the new value and highlighted. */
488 tui_check_register_values (struct frame_info *frame)
490 if (TUI_DATA_WIN != NULL && TUI_DATA_WIN->generic.is_visible)
492 struct tui_data_info *display_info
493 = &TUI_DATA_WIN->detail.data_display_info;
495 if (display_info->regs_content_count <= 0 && display_info->display_regs)
496 tui_show_registers (display_info->current_group);
501 for (i = 0; (i < display_info->regs_content_count); i++)
503 struct tui_data_element *data;
504 struct tui_gen_win_info *data_item_win_ptr;
507 data_item_win_ptr = &display_info->regs_content[i]->
508 which_element.data_window;
509 data = &((struct tui_win_element *)
510 data_item_win_ptr->content[0])->which_element.data;
511 was_hilighted = data->highlight;
513 tui_get_register (current_gdbarch, frame, data,
514 data->item_no, &data->highlight);
516 if (data->highlight || was_hilighted)
518 tui_display_register (data, data_item_win_ptr);
525 /* Display a register in a window. If hilite is TRUE,
526 then the value will be displayed in reverse video */
528 tui_display_register (struct tui_data_element *data,
529 struct tui_gen_win_info *win_info)
531 if (win_info->handle != (WINDOW *) NULL)
536 wstandout (win_info->handle);
538 wmove (win_info->handle, 0, 0);
539 for (i = 1; i < win_info->width; i++)
540 waddch (win_info->handle, ' ');
541 wmove (win_info->handle, 0, 0);
543 waddstr (win_info->handle, data->content);
546 wstandend (win_info->handle);
547 tui_refresh_win (win_info);
552 tui_reg_next_command (char *arg, int from_tty)
554 if (TUI_DATA_WIN != 0)
556 struct reggroup *group
557 = TUI_DATA_WIN->detail.data_display_info.current_group;
559 group = reggroup_next (current_gdbarch, group);
561 group = reggroup_next (current_gdbarch, 0);
564 tui_show_registers (group);
569 tui_reg_float_command (char *arg, int from_tty)
571 tui_show_registers (float_reggroup);
575 tui_reg_general_command (char *arg, int from_tty)
577 tui_show_registers (general_reggroup);
581 tui_reg_system_command (char *arg, int from_tty)
583 tui_show_registers (system_reggroup);
586 static struct cmd_list_element *tuireglist;
589 tui_reg_command (char *args, int from_tty)
591 printf_unfiltered (_("\"tui reg\" must be followed by the name of a "
592 "tui reg command.\n"));
593 help_list (tuireglist, "tui reg ", -1, gdb_stdout);
597 _initialize_tui_regs (void)
599 struct cmd_list_element **tuicmd;
601 tuicmd = tui_get_cmd_list ();
603 add_prefix_cmd ("reg", class_tui, tui_reg_command,
604 _("TUI commands to control the register window."),
605 &tuireglist, "tui reg ", 0,
608 add_cmd ("float", class_tui, tui_reg_float_command,
609 _("Display only floating point registers."),
611 add_cmd ("general", class_tui, tui_reg_general_command,
612 _("Display only general registers."),
614 add_cmd ("system", class_tui, tui_reg_system_command,
615 _("Display only system registers."),
617 add_cmd ("next", class_tui, tui_reg_next_command,
618 _("Display next register group."),
623 add_com ("fr", class_tui, tui_reg_float_command,
624 _("Display only floating point registers\n"));
625 add_com ("gr", class_tui, tui_reg_general_command,
626 _("Display only general registers\n"));
627 add_com ("sr", class_tui, tui_reg_system_command,
628 _("Display only special registers\n"));
629 add_com ("+r", class_tui, tui_scroll_regs_forward_command,
630 _("Scroll the registers window forward\n"));
631 add_com ("-r", class_tui, tui_scroll_regs_backward_command,
632 _("Scroll the register window backward\n"));
637 /*****************************************
638 ** STATIC LOCAL FUNCTIONS **
639 ******************************************/
641 extern int pagination_enabled;
644 tui_restore_gdbout (void *ui)
646 ui_file_delete (gdb_stdout);
647 gdb_stdout = (struct ui_file*) ui;
648 pagination_enabled = 1;
651 /* Get the register from the frame and make a printable representation
652 of it in the data element. */
654 tui_register_format (struct gdbarch *gdbarch, struct frame_info *frame,
655 struct tui_data_element *data_element, int regnum)
657 struct ui_file *stream;
658 struct ui_file *old_stdout;
660 struct cleanup *cleanups;
663 struct type *type = register_type (gdbarch, regnum);
665 name = gdbarch_register_name (gdbarch, regnum);
671 pagination_enabled = 0;
672 old_stdout = gdb_stdout;
673 stream = tui_sfileopen (256);
675 cleanups = make_cleanup (tui_restore_gdbout, (void*) old_stdout);
676 if (TYPE_VECTOR (type) != 0 && 0)
678 gdb_byte buf[MAX_REGISTER_SIZE];
681 len = register_size (current_gdbarch, regnum);
682 fprintf_filtered (stream, "%-14s ", name);
683 get_frame_register (frame, regnum, buf);
684 print_scalar_formatted (buf, type, 'f', len, stream);
688 gdbarch_print_registers_info (current_gdbarch, stream,
692 /* Save formatted output in the buffer. */
693 p = tui_file_get_strbuf (stream);
695 /* Remove the possible \n. */
696 s = strrchr (p, '\n');
700 xfree (data_element->content);
701 data_element->content = xstrdup (p);
702 do_cleanups (cleanups);
705 /* Get the register value from the given frame and format it for
706 the display. When changep is set, check if the new register value
707 has changed with respect to the previous call. */
708 static enum tui_status
709 tui_get_register (struct gdbarch *gdbarch, struct frame_info *frame,
710 struct tui_data_element *data, int regnum, int *changedp)
712 enum tui_status ret = TUI_FAILURE;
716 if (target_has_registers)
718 gdb_byte buf[MAX_REGISTER_SIZE];
719 get_frame_register (frame, regnum, buf);
723 int size = register_size (gdbarch, regnum);
724 char *old = (char*) data->value;
727 for (i = 0; i < size; i++)
728 if (buf[i] != old[i])
735 /* Reformat the data content if the value changed. */
736 if (changedp == 0 || *changedp == TRUE)
737 tui_register_format (gdbarch, frame, data, regnum);
745 tui_scroll_regs_forward_command (char *arg, int from_tty)
747 tui_scroll (FORWARD_SCROLL, TUI_DATA_WIN, 1);
752 tui_scroll_regs_backward_command (char *arg, int from_tty)
754 tui_scroll (BACKWARD_SCROLL, TUI_DATA_WIN, 1);