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