Remove struct tui_source_info
[external/binutils.git] / gdb / tui / tui-data.h
1 /* TUI data manipulation routines.
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_DATA_H
23 #define TUI_TUI_DATA_H
24
25 #include "tui/tui.h"    /* For enum tui_win_type.  */
26 #include "gdb_curses.h" /* For WINDOW.  */
27
28 /* This is a point definition.  */
29 struct tui_point
30 {
31   int x, y;
32 };
33
34 struct tui_win_element;
35
36 /* This describes the content of the window.  */
37 typedef struct tui_win_element **tui_win_content;
38
39 /* Generic window information.  */
40 struct tui_gen_win_info
41 {
42   WINDOW *handle;           /* Window handle.  */
43   enum tui_win_type type;   /* Type of window.  */
44   int width;                /* Window width.  */
45   int height;               /* Window height.  */
46   struct tui_point origin;  /* Origin of window.  */
47   tui_win_content content;  /* Content of window.  */
48   int content_size;         /* Size of content (# of elements).  */
49   int content_in_use;       /* Can it be used, or is it already used?  */
50   int viewport_height;      /* Viewport height.  */
51   int last_visible_line;    /* Index of last visible line.  */
52   int is_visible;           /* Whether the window is visible or not.  */
53   char *title;              /* Window title to display.  */
54 };
55
56 /* Constant definitions.  */
57 #define DEFAULT_TAB_LEN         8
58 #define NO_SRC_STRING           "[ No Source Available ]"
59 #define NO_DISASSEM_STRING      "[ No Assembly Available ]"
60 #define NO_REGS_STRING          "[ Register Values Unavailable ]"
61 #define NO_DATA_STRING          "[ No Data Values Displayed ]"
62 #define MAX_CONTENT_COUNT       100
63 #define SRC_NAME                "src"
64 #define CMD_NAME                "cmd"
65 #define DATA_NAME               "regs"
66 #define DISASSEM_NAME           "asm"
67 #define TUI_NULL_STR            ""
68 #define DEFAULT_HISTORY_COUNT   25
69 #define BOX_WINDOW              TRUE
70 #define DONT_BOX_WINDOW         FALSE
71 #define HILITE                  TRUE
72 #define NO_HILITE               FALSE
73 #define WITH_LOCATOR            TRUE
74 #define NO_LOCATOR              FALSE
75 #define EMPTY_SOURCE_PROMPT     TRUE
76 #define NO_EMPTY_SOURCE_PROMPT  FALSE
77 #define UNDEFINED_ITEM          -1
78 #define MIN_WIN_HEIGHT          3
79 #define MIN_CMD_WIN_HEIGHT      3
80
81 /* Strings to display in the TUI status line.  */
82 #define PROC_PREFIX             "In: "
83 #define LINE_PREFIX             "L"
84 #define PC_PREFIX               "PC: "
85 #define SINGLE_KEY              "(SingleKey)"
86
87 /* Minimum/Maximum length of some fields displayed in the TUI status
88    line.  */
89 #define MIN_LINE_WIDTH     4    /* Use at least 4 digits for line
90                                    numbers.  */
91 #define MIN_PROC_WIDTH    12
92 #define MAX_TARGET_WIDTH  10
93 #define MAX_PID_WIDTH     19
94
95 /* Scroll direction enum.  */
96 enum tui_scroll_direction
97 {
98   FORWARD_SCROLL,
99   BACKWARD_SCROLL,
100   LEFT_SCROLL,
101   RIGHT_SCROLL
102 };
103
104
105 /* The kinds of layouts available.  */
106 enum tui_layout_type
107 {
108   SRC_COMMAND,
109   DISASSEM_COMMAND,
110   SRC_DISASSEM_COMMAND,
111   SRC_DATA_COMMAND,
112   DISASSEM_DATA_COMMAND,
113   UNDEFINED_LAYOUT
114 };
115
116 /* Basic data types that can be displayed in the data window.  */
117 enum tui_data_type
118 {
119   TUI_REGISTER,
120   TUI_SCALAR,
121   TUI_COMPLEX,
122   TUI_STRUCT
123 };
124
125 enum tui_line_or_address_kind
126 {
127   LOA_LINE,
128   LOA_ADDRESS
129 };
130
131 /* Structure describing source line or line address.  */
132 struct tui_line_or_address
133 {
134   enum tui_line_or_address_kind loa;
135   union
136     {
137       int line_no;
138       CORE_ADDR addr;
139     } u;
140 };
141
142 /* Current Layout definition.  */
143 struct tui_layout_def
144 {
145   enum tui_win_type display_mode;
146   int split;
147 };
148
149 /* Elements in the Source/Disassembly Window.  */
150 struct tui_source_element
151 {
152   char *line;
153   struct tui_line_or_address line_or_addr;
154   int is_exec_point;
155   int has_break;
156 };
157
158
159 /* Elements in the data display window content.  */
160 struct tui_data_element
161 {
162   const char *name;
163   int item_no;          /* The register number, or data display
164                            number.  */
165   enum tui_data_type type;
166   void *value;
167   int highlight;
168   char *content;
169 };
170
171
172 /* Elements in the command window content.  */
173 struct tui_command_element
174 {
175   char *line;
176 };
177
178 #ifdef PATH_MAX
179 # define MAX_LOCATOR_ELEMENT_LEN        PATH_MAX
180 #else
181 # define MAX_LOCATOR_ELEMENT_LEN        1024
182 #endif
183
184 /* Elements in the locator window content.  */
185 struct tui_locator_element
186 {
187   /* Resolved absolute filename as returned by symtab_to_fullname.  */
188   char full_name[MAX_LOCATOR_ELEMENT_LEN];
189   char proc_name[MAX_LOCATOR_ELEMENT_LEN];
190   int line_no;
191   CORE_ADDR addr;
192   /* Architecture associated with code at this location.  */
193   struct gdbarch *gdbarch;
194 };
195
196 /* Flags to tell what kind of breakpoint is at current line.  */
197 #define TUI_BP_ENABLED      0x01
198 #define TUI_BP_DISABLED     0x02
199 #define TUI_BP_HIT          0x04
200 #define TUI_BP_CONDITIONAL  0x08
201 #define TUI_BP_HARDWARE     0x10
202
203 /* Position of breakpoint markers in the exec info string.  */
204 #define TUI_BP_HIT_POS      0
205 #define TUI_BP_BREAK_POS    1
206 #define TUI_EXEC_POS        2
207 #define TUI_EXECINFO_SIZE   4
208
209 typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
210
211 /* An content element in a window.  */
212 union tui_which_element
213 {
214   struct tui_source_element source;     /* The source elements.  */
215   struct tui_gen_win_info data_window;  /* Data display elements.  */
216   struct tui_data_element data;         /* Elements of data_window.  */
217   struct tui_command_element command;   /* Command elements.  */
218   struct tui_locator_element locator;   /* Locator elements.  */
219   tui_exec_info_content simple_string;  /* Simple char based elements.  */
220 };
221
222 struct tui_win_element
223 {
224   union tui_which_element which_element;
225 };
226
227 /* This struct defines the specific information about a data display
228    window.  */
229 struct tui_data_info
230 {
231   tui_win_content data_content; /* Start of data display content.  */
232   int data_content_count;
233   tui_win_content regs_content; /* Start of regs display content.  */
234   int regs_content_count;
235   int regs_column_count;
236   int display_regs;             /* Should regs be displayed at all?  */
237   struct reggroup *current_group;
238 };
239
240
241 struct tui_command_info
242 {
243   int start_line;
244 };
245
246
247 /* This defines information about each logical window.  */
248 struct tui_win_info
249 {
250 protected:
251
252   explicit tui_win_info (enum tui_win_type type);
253   DISABLE_COPY_AND_ASSIGN (tui_win_info);
254
255   /* Scroll the contents vertically.  This is only called via
256      forward_scroll and backward_scroll.  */
257   virtual void do_scroll_vertical (enum tui_scroll_direction,
258                                    int num_to_scroll) = 0;
259
260   /* Scroll the contents horizontally.  This is only called via
261      left_scroll and right_scroll.  */
262   virtual void do_scroll_horizontal (enum tui_scroll_direction,
263                                      int num_to_scroll) = 0;
264
265 public:
266
267   virtual ~tui_win_info ();
268
269   /* Clear the pertinent detail in the window.  */
270   virtual void clear_detail () = 0;
271
272   /* Return true if this window has the locator.  */
273   virtual bool has_locator () const
274   {
275     return false;
276   }
277
278   /* Methods to scroll the contents of this window.  Note that they
279      are named with "_scroll" coming at the end because the more
280      obvious "scroll_forward" is defined as a macro in term.h.  */
281   void forward_scroll (int num_to_scroll);
282   void backward_scroll (int num_to_scroll);
283   void left_scroll (int num_to_scroll);
284   void right_scroll (int num_to_scroll);
285
286   struct tui_gen_win_info generic;      /* General window information.  */
287   union
288   {
289     struct tui_data_info data_display_info;
290     struct tui_command_info command_info;
291   }
292   detail;
293
294   /* Can this window ever be highlighted?  */
295   int can_highlight = 0;
296
297   /* Is this window highlighted?  */
298   int is_highlighted = 0;
299 };
300
301 /* The base class for all source-like windows, namely the source and
302    disassembly windows.  */
303
304 struct tui_source_window_base : public tui_win_info
305 {
306 protected:
307   explicit tui_source_window_base (enum tui_win_type type);
308   ~tui_source_window_base () override;
309   DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
310
311   void do_scroll_horizontal (enum tui_scroll_direction,
312                              int num_to_scroll) override;
313
314 public:
315
316   void clear_detail () override;
317
318   /* Return true if this window has the locator.  */
319   bool has_locator () const override
320   {
321     return m_has_locator;
322   }
323
324   /* Does the locator belong to this window?  */
325   bool m_has_locator = false;
326   /* Execution information window.  */
327   struct tui_gen_win_info *execution_info = nullptr;
328   /* Used for horizontal scroll.  */
329   int horizontal_offset = 0;
330   struct tui_line_or_address start_line_or_addr;
331
332   /* It is the resolved form as returned by symtab_to_fullname.  */
333   char *fullname = nullptr;
334
335   /* Architecture associated with code at this location.  */
336   struct gdbarch *gdbarch = nullptr;
337 };
338
339 /* A TUI source window.  */
340
341 struct tui_source_window : public tui_source_window_base
342 {
343   tui_source_window ()
344     : tui_source_window_base (SRC_WIN)
345   {
346   }
347
348   DISABLE_COPY_AND_ASSIGN (tui_source_window);
349
350 protected:
351
352   void do_scroll_vertical (enum tui_scroll_direction,
353                            int num_to_scroll) override;
354 };
355
356 /* A TUI disassembly window.  */
357
358 struct tui_disasm_window : public tui_source_window_base
359 {
360   tui_disasm_window ()
361     : tui_source_window_base (DISASSEM_WIN)
362   {
363   }
364
365   DISABLE_COPY_AND_ASSIGN (tui_disasm_window);
366
367 protected:
368
369   void do_scroll_vertical (enum tui_scroll_direction,
370                            int num_to_scroll) override;
371 };
372
373 struct tui_data_window : public tui_win_info
374 {
375   tui_data_window ();
376   ~tui_data_window () override;
377   DISABLE_COPY_AND_ASSIGN (tui_data_window);
378
379   void clear_detail () override;
380
381 protected:
382
383   void do_scroll_vertical (enum tui_scroll_direction,
384                            int num_to_scroll) override;
385   void do_scroll_horizontal (enum tui_scroll_direction,
386                              int num_to_scroll) override
387   {
388   }
389 };
390
391 struct tui_cmd_window : public tui_win_info
392 {
393   tui_cmd_window ();
394   DISABLE_COPY_AND_ASSIGN (tui_cmd_window);
395
396   void clear_detail () override;
397
398 protected:
399
400   void do_scroll_vertical (enum tui_scroll_direction,
401                            int num_to_scroll) override
402   {
403   }
404
405   void do_scroll_horizontal (enum tui_scroll_direction,
406                              int num_to_scroll) override
407   {
408   }
409 };
410
411 extern int tui_win_is_source_type (enum tui_win_type win_type);
412 extern int tui_win_is_auxillary (enum tui_win_type win_type);
413 extern void tui_set_win_highlight (struct tui_win_info *win_info,
414                                    int highlight);
415
416
417 /* Global Data.  */
418 extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
419
420 #define TUI_SRC_WIN     ((tui_source_window_base *) tui_win_list[SRC_WIN])
421 #define TUI_DISASM_WIN  ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
422 #define TUI_DATA_WIN    tui_win_list[DATA_WIN]
423 #define TUI_CMD_WIN     tui_win_list[CMD_WIN]
424
425 /* Data Manipulation Functions.  */
426 extern void tui_initialize_static_data (void);
427 extern struct tui_gen_win_info *tui_alloc_generic_win_info (void);
428 extern struct tui_win_info *tui_alloc_win_info (enum tui_win_type);
429 extern void tui_init_generic_part (struct tui_gen_win_info *);
430 extern tui_win_content tui_alloc_content (int, enum tui_win_type);
431 extern int tui_add_content_elements (struct tui_gen_win_info *, 
432                                      int);
433 extern void tui_free_win_content (struct tui_gen_win_info *);
434 extern void tui_free_data_content (tui_win_content, int);
435 extern void tui_free_all_source_wins_content (void);
436 extern struct tui_win_info *tui_partial_win_by_name (const char *);
437 extern const char *tui_win_name (const struct tui_gen_win_info *);
438 extern enum tui_layout_type tui_current_layout (void);
439 extern void tui_set_current_layout_to (enum tui_layout_type);
440 extern int tui_term_height (void);
441 extern void tui_set_term_height_to (int);
442 extern int tui_term_width (void);
443 extern void tui_set_term_width_to (int);
444 extern struct tui_gen_win_info *tui_locator_win_info_ptr (void);
445 extern struct tui_gen_win_info *tui_source_exec_info_win_ptr (void);
446 extern struct tui_gen_win_info *tui_disassem_exec_info_win_ptr (void);
447 extern std::vector<tui_win_info *> &tui_source_windows ();
448 extern void tui_clear_source_windows (void);
449 extern void tui_clear_source_windows_detail (void);
450 extern void tui_add_to_source_windows (struct tui_win_info *);
451 extern struct tui_win_info *tui_win_with_focus (void);
452 extern void tui_set_win_with_focus (struct tui_win_info *);
453 extern struct tui_layout_def *tui_layout_def (void);
454 extern int tui_win_resized (void);
455 extern void tui_set_win_resized_to (int);
456
457 extern struct tui_win_info *tui_next_win (struct tui_win_info *);
458 extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
459
460 extern void tui_add_to_source_windows (struct tui_win_info *);
461
462 extern unsigned int tui_tab_width;
463
464 #endif /* TUI_TUI_DATA_H */