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