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