gdb/tui/tui-regs.h

   1 /* TUI display registers in window.
   2
   3    Copyright (C) 1998-2019 Free Software Foundation, Inc.
   4
   5    Contributed by Hewlett-Packard Company.
   6
   7    This file is part of GDB.
   8
   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.
  13
  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.
  18
  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/>.  */
  21
  22 #ifndef TUI_TUI_REGS_H
  23 #define TUI_TUI_REGS_H
  24
  25 #include "tui/tui-data.h"
  26
  27 /* A data item window.  */
  28
  29 struct tui_data_item_window : public tui_gen_win_info
  30 {
  31   tui_data_item_window ()
  32     : tui_gen_win_info (DATA_ITEM_WIN)
  33   {
  34   }
  35
  36   const char *name = nullptr;
  37   /* The register number, or data display number.  */
  38   int item_no = -1;
  39   bool highlight = false;
  40   gdb::unique_xmalloc_ptr<char> content;
  41 };
  42
  43 /* The TUI registers window.  */
  44 struct tui_data_window : public tui_win_info
  45 {
  46   tui_data_window ()
  47     : tui_win_info (DATA_WIN)
  48   {
  49   }
  50
  51   DISABLE_COPY_AND_ASSIGN (tui_data_window);
  52
  53   void refresh_all () override;
  54
  55   void refresh_window () override;
  56
  57   const char *name () const override
  58   {
  59     return DATA_NAME;
  60   }
  61
  62   /* Windows that are used to display registers.  */
  63   std::vector<std::unique_ptr<tui_data_item_window>> regs_content;
  64   int regs_column_count = 0;
  65   /* Should regs be displayed at all?  */
  66   bool display_regs = false;
  67   struct reggroup *current_group = nullptr;
  68
  69   /* Answer the number of the last line in the regs display.  If there
  70      are no registers (-1) is returned.  */
  71   int last_regs_line_no () const;
  72
  73   /* Answer the line number that the register element at element_no is
  74      on.  If element_no is greater than the number of register
  75      elements there are, -1 is returned.  */
  76   int line_from_reg_element_no (int element_no) const;
  77
  78   /* Answer the index of the first element in line_no.  If line_no is
  79      past the register area (-1) is returned.  */
  80   int first_reg_element_no_inline (int line_no) const;
  81
  82   /* Displays the data that is in the data window's content.  It does
  83      not set the content.  */
  84   void display_all_data ();
  85
  86   /* Delete all the item windows in the data window.  This is usually
  87      done when the data window is scrolled.  */
  88   void delete_data_content_windows ();
  89
  90   void erase_data_content (const char *prompt);
  91
  92   /* Display the registers in the content from 'start_element_no'
  93      until the end of the register content or the end of the display
  94      height.  No checking for displaying past the end of the registers
  95      is done here.  */
  96   void display_registers_from (int start_element_no);
  97
  98   /* Display the registers starting at line line_no in the data
  99      window.  Answers the line number that the display actually
 100      started from.  If nothing is displayed (-1) is returned.  */
 101   int display_registers_from_line (int line_no);
 102
 103   void check_register_values (struct frame_info *frame);
 104
 105   void show_registers (struct reggroup *group);
 106
 107 protected:
 108
 109   void do_scroll_vertical (int num_to_scroll) override;
 110   void do_scroll_horizontal (int num_to_scroll) override
 111   {
 112   }
 113
 114   /* Return the index of the first element displayed.  If none are
 115      displayed, then return -1.  */
 116   int first_data_item_displayed ();
 117
 118   /* Display the registers in the content from 'start_element_no' on
 119      'start_line_no' until the end of the register content or the end
 120      of the display height.  This function checks that we won't
 121      display off the end of the register display.  */
 122   void display_reg_element_at_line (int start_element_no, int start_line_no);
 123
 124   void rerender () override;
 125
 126   void show_register_group (struct reggroup *group,
 127                             struct frame_info *frame,
 128                             int refresh_values_only);
 129 };
 130
 131 #endif /* TUI_TUI_REGS_H */