gdb/tui/tui-regs.h

   1 /* TUI display registers in window.
   2
   3    Copyright (C) 1998-2020 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 () = default;
  32
  33   DISABLE_COPY_AND_ASSIGN (tui_data_item_window);
  34
  35   tui_data_item_window (tui_data_item_window &&) = default;
  36
  37   void rerender () override;
  38
  39   void refresh_window () override;
  40
  41   int max_height () const override
  42   {
  43     return 1;
  44   }
  45
  46   int min_height () const override
  47   {
  48     return 1;
  49   }
  50
  51   const char *name = nullptr;
  52   /* The register number, or data display number.  */
  53   int item_no = -1;
  54   bool highlight = false;
  55   gdb::unique_xmalloc_ptr<char> content;
  56 };
  57
  58 /* The TUI registers window.  */
  59 struct tui_data_window : public tui_win_info
  60 {
  61   tui_data_window () = default;
  62
  63   DISABLE_COPY_AND_ASSIGN (tui_data_window);
  64
  65   void refresh_window () override;
  66
  67   void no_refresh () override;
  68
  69   const char *name () const override
  70   {
  71     return DATA_NAME;
  72   }
  73
  74   void check_register_values (struct frame_info *frame);
  75
  76   void show_registers (struct reggroup *group);
  77
  78   struct reggroup *get_current_group () const
  79   {
  80     return m_current_group;
  81   }
  82
  83 protected:
  84
  85   void do_scroll_vertical (int num_to_scroll) override;
  86   void do_scroll_horizontal (int num_to_scroll) override
  87   {
  88   }
  89
  90   void rerender () override;
  91
  92 private:
  93
  94   /* Display the registers in the content from 'start_element_no'
  95      until the end of the register content or the end of the display
  96      height.  No checking for displaying past the end of the registers
  97      is done here.  */
  98   void display_registers_from (int start_element_no);
  99
 100   /* Display the registers starting at line line_no in the data
 101      window.  Answers the line number that the display actually
 102      started from.  If nothing is displayed (-1) is returned.  */
 103   int display_registers_from_line (int line_no);
 104
 105   /* Return the index of the first element displayed.  If none are
 106      displayed, then return -1.  */
 107   int first_data_item_displayed ();
 108
 109   /* Display the registers in the content from 'start_element_no' on
 110      'start_line_no' until the end of the register content or the end
 111      of the display height.  This function checks that we won't
 112      display off the end of the register display.  */
 113   void display_reg_element_at_line (int start_element_no, int start_line_no);
 114
 115   void show_register_group (struct reggroup *group,
 116                             struct frame_info *frame,
 117                             bool refresh_values_only);
 118
 119   /* Answer the number of the last line in the regs display.  If there
 120      are no registers (-1) is returned.  */
 121   int last_regs_line_no () const;
 122
 123   /* Answer the line number that the register element at element_no is
 124      on.  If element_no is greater than the number of register
 125      elements there are, -1 is returned.  */
 126   int line_from_reg_element_no (int element_no) const;
 127
 128   /* Answer the index of the first element in line_no.  If line_no is
 129      past the register area (-1) is returned.  */
 130   int first_reg_element_no_inline (int line_no) const;
 131
 132   /* Delete all the item windows in the data window.  This is usually
 133      done when the data window is scrolled.  */
 134   void delete_data_content_windows ();
 135
 136   void erase_data_content (const char *prompt);
 137
 138   /* Windows that are used to display registers.  */
 139   std::vector<tui_data_item_window> m_regs_content;
 140   int m_regs_column_count = 0;
 141   struct reggroup *m_current_group = nullptr;
 142 };
 143
 144 #endif /* TUI_TUI_REGS_H */