Add comments describing tui_ui_out and its fields, cleanup a bit
[deliverable/binutils-gdb.git] / gdb / tui / tui-regs.c
index feb11babd04295e4299fa2cd08e8eef91efcbfe5..91b40f5d072d69a62a68c65f94bc9d5a008a16f6 100644 (file)
@@ -1,6 +1,6 @@
 /* TUI display registers in window.
 
-   Copyright (C) 1998-2015 Free Software Foundation, Inc.
+   Copyright (C) 1998-2019 Free Software Foundation, Inc.
 
    Contributed by Hewlett-Packard Company.
 
@@ -39,6 +39,7 @@
 #include "tui/tui-io.h"
 #include "reggroups.h"
 #include "valprint.h"
+#include "completer.h"
 
 #include "gdb_curses.h"
 
@@ -139,7 +140,7 @@ tui_show_registers (struct reggroup *group)
   /* Make sure the register window is visible.  If not, select an
      appropriate layout.  */
   if (TUI_DATA_WIN == NULL || !TUI_DATA_WIN->generic.is_visible)
-    tui_set_layout_for_display_command (DATA_NAME);
+    tui_set_layout_by_name (DATA_NAME);
 
   display_info = &TUI_DATA_WIN->detail.data_display_info;
   if (group == 0)
@@ -171,7 +172,7 @@ tui_show_registers (struct reggroup *group)
 
          data_item_win = &display_info->regs_content[i]
             ->which_element.data_window;
-          win = (struct tui_win_element *) data_item_win->content[0];
+          win = data_item_win->content[0];
           win->which_element.data.highlight = FALSE;
        }
       display_info->current_group = group;
@@ -205,10 +206,7 @@ tui_show_register_group (struct reggroup *group,
 
   /* See how many registers must be displayed.  */
   nr_regs = 0;
-  for (regnum = 0;
-       regnum < gdbarch_num_regs (gdbarch)
-               + gdbarch_num_pseudo_regs (gdbarch);
-       regnum++)
+  for (regnum = 0; regnum < gdbarch_num_cooked_regs (gdbarch); regnum++)
     {
       const char *name;
 
@@ -243,20 +241,16 @@ tui_show_register_group (struct reggroup *group,
     {
       if (!refresh_values_only || allocated_here)
        {
-         TUI_DATA_WIN->generic.content = (void*) NULL;
+         TUI_DATA_WIN->generic.content = NULL;
          TUI_DATA_WIN->generic.content_size = 0;
          tui_add_content_elements (&TUI_DATA_WIN->generic, nr_regs);
-         display_info->regs_content
-            = (tui_win_content) TUI_DATA_WIN->generic.content;
+         display_info->regs_content = TUI_DATA_WIN->generic.content;
          display_info->regs_content_count = nr_regs;
        }
 
       /* Now set the register names and values.  */
       pos = 0;
-      for (regnum = 0;
-          regnum < gdbarch_num_regs (gdbarch)
-                   + gdbarch_num_pseudo_regs (gdbarch);
-          regnum++)
+      for (regnum = 0; regnum < gdbarch_num_cooked_regs (gdbarch); regnum++)
         {
          struct tui_gen_win_info *data_item_win;
           struct tui_data_element *data;
@@ -274,8 +268,7 @@ tui_show_register_group (struct reggroup *group,
 
          data_item_win =
             &display_info->regs_content[pos]->which_element.data_window;
-          data = &((struct tui_win_element *)
-                  data_item_win->content[0])->which_element.data;
+          data = &data_item_win->content[0]->which_element.data;
           if (data)
             {
               if (!refresh_values_only)
@@ -322,8 +315,7 @@ tui_display_registers_from (int start_element_no)
 
           data_item_win
            = &display_info->regs_content[i]->which_element.data_window;
-          data = &((struct tui_win_element *)
-                   data_item_win->content[0])->which_element.data;
+          data = &data_item_win->content[0]->which_element.data;
           len = 0;
           p = data->content;
           if (p != 0)
@@ -365,8 +357,7 @@ tui_display_registers_from (int start_element_no)
              /* Create the window if necessary.  */
              data_item_win = &display_info->regs_content[i]
                 ->which_element.data_window;
-             data_element_ptr = &((struct tui_win_element *)
-                                  data_item_win->content[0])->which_element.data;
+             data_element_ptr = &data_item_win->content[0]->which_element.data;
               if (data_item_win->handle != (WINDOW*) NULL
                   && (data_item_win->height != 1
                       || data_item_win->width != item_win_width
@@ -508,8 +499,7 @@ tui_check_register_values (struct frame_info *frame)
 
              data_item_win_ptr = &display_info->regs_content[i]->
                 which_element.data_window;
-             data = &((struct tui_win_element *)
-                       data_item_win_ptr->content[0])->which_element.data;
+             data = &data_item_win_ptr->content[0]->which_element.data;
              was_hilighted = data->highlight;
 
               tui_get_register (frame, data,
@@ -560,80 +550,146 @@ tui_display_register (struct tui_data_element *data,
     }
 }
 
-static void
-tui_reg_next_command (char *arg, int from_tty)
+/* Helper for "tui reg next", wraps a call to REGGROUP_NEXT, but adds wrap
+   around behaviour.  Returns the next register group, or NULL if the
+   register window is not currently being displayed.  */
+
+static struct reggroup *
+tui_reg_next (struct gdbarch *gdbarch)
 {
-  struct gdbarch *gdbarch = get_current_arch ();
+  struct reggroup *group = NULL;
 
-  if (TUI_DATA_WIN != 0)
+  if (TUI_DATA_WIN != NULL)
     {
-      struct reggroup *group
-        = TUI_DATA_WIN->detail.data_display_info.current_group;
-
+      group = TUI_DATA_WIN->detail.data_display_info.current_group;
       group = reggroup_next (gdbarch, group);
-      if (group == 0)
-        group = reggroup_next (gdbarch, 0);
-
-      if (group)
-        tui_show_registers (group);
+      if (group == NULL)
+        group = reggroup_next (gdbarch, NULL);
     }
+  return group;
 }
 
-static void
-tui_reg_float_command (char *arg, int from_tty)
-{
-  tui_show_registers (float_reggroup);
-}
+/* Helper for "tui reg prev", wraps a call to REGGROUP_PREV, but adds wrap
+   around behaviour.  Returns the previous register group, or NULL if the
+   register window is not currently being displayed.  */
 
-static void
-tui_reg_general_command (char *arg, int from_tty)
+static struct reggroup *
+tui_reg_prev (struct gdbarch *gdbarch)
 {
-  tui_show_registers (general_reggroup);
+  struct reggroup *group = NULL;
+
+  if (TUI_DATA_WIN != NULL)
+    {
+      group = TUI_DATA_WIN->detail.data_display_info.current_group;
+      group = reggroup_prev (gdbarch, group);
+      if (group == NULL)
+       group = reggroup_prev (gdbarch, NULL);
+    }
+  return group;
 }
 
+/* Implement the 'tui reg' command.  Changes the register group displayed
+   in the tui register window.  Displays the tui register window if it is
+   not already on display.  */
+
 static void
-tui_reg_system_command (char *arg, int from_tty)
+tui_reg_command (const char *args, int from_tty)
 {
-  tui_show_registers (system_reggroup);
+  struct gdbarch *gdbarch = get_current_arch ();
+
+  if (args != NULL)
+    {
+      struct reggroup *group, *match = NULL;
+      size_t len = strlen (args);
+
+      /* Make sure the curses mode is enabled.  */
+      tui_enable ();
+
+      /* Make sure the register window is visible.  If not, select an
+        appropriate layout.  We need to do this before trying to run the
+        'next' or 'prev' commands.  */
+      if (TUI_DATA_WIN == NULL || !TUI_DATA_WIN->generic.is_visible)
+       tui_set_layout_by_name (DATA_NAME);
+
+      if (strncmp (args, "next", len) == 0)
+       match = tui_reg_next (gdbarch);
+      else if (strncmp (args, "prev", len) == 0)
+       match = tui_reg_prev (gdbarch);
+
+      /* This loop matches on the initial part of a register group
+        name.  If this initial part in ARGS matches only one register
+        group then the switch is made.  */
+      for (group = reggroup_next (gdbarch, NULL);
+          group != NULL;
+          group = reggroup_next (gdbarch, group))
+       {
+         if (strncmp (reggroup_name (group), args, len) == 0)
+           {
+             if (match != NULL)
+               error (_("ambiguous register group name '%s'"), args);
+             match = group;
+           }
+       }
+
+      if (match == NULL)
+       error (_("unknown register group '%s'"), args);
+
+      tui_show_registers (match);
+    }
+  else
+    {
+      struct reggroup *group;
+      int first;
+
+      printf_unfiltered (_("\"tui reg\" must be followed by the name of "
+                          "either a register group,\nor one of 'next' "
+                          "or 'prev'.  Known register groups are:\n"));
+
+      for (first = 1, group = reggroup_next (gdbarch, NULL);
+          group != NULL;
+          first = 0, group = reggroup_next (gdbarch, group))
+       {
+         if (!first)
+           printf_unfiltered (", ");
+         printf_unfiltered ("%s", reggroup_name (group));
+       }
+
+      printf_unfiltered ("\n");
+    }
 }
 
-static struct cmd_list_element *tuireglist;
+/* Complete names of register groups, and add the special "prev" and "next"
+   names.  */
 
 static void
-tui_reg_command (char *args, int from_tty)
+tui_reggroup_completer (struct cmd_list_element *ignore,
+                       completion_tracker &tracker,
+                       const char *text, const char *word)
 {
-  printf_unfiltered (_("\"tui reg\" must be followed by the name of a "
-                     "tui reg command.\n"));
-  help_list (tuireglist, "tui reg ", all_commands, gdb_stdout);
-}
+  static const char *extra[] = { "next", "prev", NULL };
+  size_t len = strlen (word);
+  const char **tmp;
 
-/* Provide a prototype to silence -Wmissing-prototypes.  */
-extern initialize_file_ftype _initialize_tui_regs;
+  reggroup_completer (ignore, tracker, text, word);
+
+  /* XXXX use complete_on_enum instead?  */
+  for (tmp = extra; *tmp != NULL; ++tmp)
+    {
+      if (strncmp (word, *tmp, len) == 0)
+       tracker.add_completion (gdb::unique_xmalloc_ptr<char> (xstrdup (*tmp)));
+    }
+}
 
 void
 _initialize_tui_regs (void)
 {
-  struct cmd_list_element **tuicmd;
+  struct cmd_list_element **tuicmd, *cmd;
 
   tuicmd = tui_get_cmd_list ();
 
-  add_prefix_cmd ("reg", class_tui, tui_reg_command,
-                  _("TUI commands to control the register window."),
-                  &tuireglist, "tui reg ", 0,
-                  tuicmd);
-
-  add_cmd ("float", class_tui, tui_reg_float_command,
-           _("Display only floating point registers."),
-           &tuireglist);
-  add_cmd ("general", class_tui, tui_reg_general_command,
-           _("Display only general registers."),
-           &tuireglist);
-  add_cmd ("system", class_tui, tui_reg_system_command,
-           _("Display only system registers."),
-           &tuireglist);
-  add_cmd ("next", class_tui, tui_reg_next_command,
-           _("Display next register group."),
-           &tuireglist);
+  cmd = add_cmd ("reg", class_tui, tui_reg_command, _("\
+TUI command to control the register window."), tuicmd);
+  set_cmd_completer (cmd, tui_reggroup_completer);
 }
 
 
@@ -641,14 +697,6 @@ _initialize_tui_regs (void)
 ** STATIC LOCAL FUNCTIONS                 **
 ******************************************/
 
-static void
-tui_restore_gdbout (void *ui)
-{
-  ui_file_delete (gdb_stdout);
-  gdb_stdout = (struct ui_file*) ui;
-  pagination_enabled = 1;
-}
-
 /* Get the register from the frame and return a printable
    representation of it.  */
 
@@ -656,33 +704,23 @@ static char *
 tui_register_format (struct frame_info *frame, int regnum)
 {
   struct gdbarch *gdbarch = get_frame_arch (frame);
-  struct ui_file *stream;
-  struct ui_file *old_stdout;
-  struct cleanup *cleanups;
-  char *p, *s;
-  char *ret;
-
-  pagination_enabled = 0;
-  old_stdout = gdb_stdout;
-  stream = tui_sfileopen (256);
-  gdb_stdout = stream;
-  cleanups = make_cleanup (tui_restore_gdbout, (void*) old_stdout);
-  gdbarch_print_registers_info (gdbarch, stream, frame, regnum, 1);
-
-  /* Save formatted output in the buffer.  */
-  p = tui_file_get_strbuf (stream);
 
-  /* Remove the possible \n.  */
-  s = strrchr (p, '\n');
-  if (s && s[1] == 0)
-    *s = 0;
+  string_file stream;
 
-  /* Expand tabs into spaces, since ncurses on MS-Windows doesn't.  */
-  ret = tui_expand_tabs (p, 0);
+  scoped_restore save_pagination
+    = make_scoped_restore (&pagination_enabled, 0);
+  scoped_restore save_stdout
+    = make_scoped_restore (&gdb_stdout, &stream);
 
-  do_cleanups (cleanups);
+  gdbarch_print_registers_info (gdbarch, &stream, frame, regnum, 1);
 
-  return ret;
+  /* Remove the possible \n.  */
+  std::string &str = stream.string ();
+  if (!str.empty () && str.back () == '\n')
+    str.resize (str.size () - 1);
+
+  /* Expand tabs into spaces, since ncurses on MS-Windows doesn't.  */
+  return tui_expand_tabs (str.c_str (), 0);
 }
 
 /* Get the register value from the given frame and format it for the
This page took 0.027889 seconds and 4 git commands to generate.