Remove command from tui_which_element
[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   explicit tui_gen_win_info (enum tui_win_type t)
43     : type (t)
44   {
45   }
46
47   virtual ~tui_gen_win_info ();
48
49   /* Call to refresh this window.  */
50   virtual void refresh_window ();
51
52   /* Make this window visible or invisible.  */
53   virtual void make_visible (bool visible);
54
55   /* Return the name of this type of window.  */
56   virtual const char *name () const
57   {
58     return "";
59   }
60
61   /* Reset this window.  WIN_TYPE must match the existing type of this
62      window (it is only passed for self-test purposes).  The other
63      parameters are used to set the window's size and position.  */
64   void reset (enum tui_win_type win_type,
65               int height, int width,
66               int origin_x, int origin_y);
67
68   /* Window handle.  */
69   WINDOW *handle = nullptr;
70   /* Type of window.  */
71   enum tui_win_type type;
72   /* Window width.  */
73   int width = 0;
74   /* Window height.  */
75   int height = 0;
76   /* Origin of window.  */
77   struct tui_point origin = {0, 0};
78   /* Content of window.  */
79   tui_win_content content = nullptr;
80   /* Size of content (# of elements).  */
81   int content_size = 0;
82   /* Can it be used, or is it already used?  */
83   int content_in_use = FALSE;
84   /* Viewport height.  */
85   int viewport_height = 0;
86   /* Index of last visible line.  */
87   int last_visible_line = 0;
88   /* Whether the window is visible or not.  */
89   bool is_visible = false;
90   /* Window title to display.  */
91   char *title = nullptr;
92 };
93
94 /* Whether or not a window should be drawn with a box.  */
95 enum tui_box
96 {
97   DONT_BOX_WINDOW = 0,
98   BOX_WINDOW
99 };
100
101 /* Constant definitions.  */
102 #define DEFAULT_TAB_LEN         8
103 #define NO_SRC_STRING           "[ No Source Available ]"
104 #define NO_DISASSEM_STRING      "[ No Assembly Available ]"
105 #define NO_REGS_STRING          "[ Register Values Unavailable ]"
106 #define NO_DATA_STRING          "[ No Data Values Displayed ]"
107 #define MAX_CONTENT_COUNT       100
108 #define SRC_NAME                "src"
109 #define CMD_NAME                "cmd"
110 #define DATA_NAME               "regs"
111 #define DISASSEM_NAME           "asm"
112 #define TUI_NULL_STR            ""
113 #define DEFAULT_HISTORY_COUNT   25
114 #define HILITE                  TRUE
115 #define NO_HILITE               FALSE
116 #define WITH_LOCATOR            TRUE
117 #define NO_LOCATOR              FALSE
118 #define EMPTY_SOURCE_PROMPT     TRUE
119 #define NO_EMPTY_SOURCE_PROMPT  FALSE
120 #define UNDEFINED_ITEM          -1
121 #define MIN_WIN_HEIGHT          3
122 #define MIN_CMD_WIN_HEIGHT      3
123
124 /* Strings to display in the TUI status line.  */
125 #define PROC_PREFIX             "In: "
126 #define LINE_PREFIX             "L"
127 #define PC_PREFIX               "PC: "
128 #define SINGLE_KEY              "(SingleKey)"
129
130 /* Minimum/Maximum length of some fields displayed in the TUI status
131    line.  */
132 #define MIN_LINE_WIDTH     4    /* Use at least 4 digits for line
133                                    numbers.  */
134 #define MIN_PROC_WIDTH    12
135 #define MAX_TARGET_WIDTH  10
136 #define MAX_PID_WIDTH     19
137
138 /* The kinds of layouts available.  */
139 enum tui_layout_type
140 {
141   SRC_COMMAND,
142   DISASSEM_COMMAND,
143   SRC_DISASSEM_COMMAND,
144   SRC_DATA_COMMAND,
145   DISASSEM_DATA_COMMAND,
146   UNDEFINED_LAYOUT
147 };
148
149 /* Basic data types that can be displayed in the data window.  */
150 enum tui_data_type
151 {
152   TUI_REGISTER,
153   TUI_SCALAR,
154   TUI_COMPLEX,
155   TUI_STRUCT
156 };
157
158 enum tui_line_or_address_kind
159 {
160   LOA_LINE,
161   LOA_ADDRESS
162 };
163
164 /* Structure describing source line or line address.  */
165 struct tui_line_or_address
166 {
167   enum tui_line_or_address_kind loa;
168   union
169     {
170       int line_no;
171       CORE_ADDR addr;
172     } u;
173 };
174
175 /* Current Layout definition.  */
176 struct tui_layout_def
177 {
178   enum tui_win_type display_mode;
179 };
180
181 /* Elements in the Source/Disassembly Window.  */
182 struct tui_source_element
183 {
184   char *line;
185   struct tui_line_or_address line_or_addr;
186   int is_exec_point;
187   int has_break;
188 };
189
190
191 /* Elements in the data display window content.  */
192 struct tui_data_element
193 {
194   const char *name;
195   int item_no;          /* The register number, or data display
196                            number.  */
197   enum tui_data_type type;
198   void *value;
199   int highlight;
200   char *content;
201 };
202
203
204 #ifdef PATH_MAX
205 # define MAX_LOCATOR_ELEMENT_LEN        PATH_MAX
206 #else
207 # define MAX_LOCATOR_ELEMENT_LEN        1024
208 #endif
209
210 /* Flags to tell what kind of breakpoint is at current line.  */
211 #define TUI_BP_ENABLED      0x01
212 #define TUI_BP_DISABLED     0x02
213 #define TUI_BP_HIT          0x04
214 #define TUI_BP_CONDITIONAL  0x08
215 #define TUI_BP_HARDWARE     0x10
216
217 /* Position of breakpoint markers in the exec info string.  */
218 #define TUI_BP_HIT_POS      0
219 #define TUI_BP_BREAK_POS    1
220 #define TUI_EXEC_POS        2
221 #define TUI_EXECINFO_SIZE   4
222
223 typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
224
225 /* An content element in a window.  */
226 union tui_which_element
227 {
228   struct tui_source_element source;     /* The source elements.  */
229   struct tui_gen_win_info *data_window; /* Data display elements.  */
230   struct tui_data_element data;         /* Elements of data_window.  */
231 };
232
233 struct tui_win_element
234 {
235   union tui_which_element which_element;
236 };
237
238 /* Execution info window class.  */
239
240 struct tui_exec_info_window : public tui_gen_win_info
241 {
242   tui_exec_info_window ()
243     : tui_gen_win_info (EXEC_INFO_WIN)
244   {
245   }
246
247   ~tui_exec_info_window () override
248   {
249     xfree (m_content);
250   }
251
252   /* Get or allocate contents.  */
253   tui_exec_info_content *maybe_allocate_content (int n_elements);
254
255   /* Return the contents.  */
256   const tui_exec_info_content *get_content () const
257   {
258     return m_content;
259   }
260
261 private:
262
263   tui_exec_info_content *m_content = nullptr;
264 };
265
266 /* Locator window class.  */
267
268 struct tui_locator_window : public tui_gen_win_info
269 {
270   tui_locator_window ()
271     : tui_gen_win_info (LOCATOR_WIN)
272   {
273     full_name[0] = 0;
274     proc_name[0] = 0;
275   }
276
277   char full_name[MAX_LOCATOR_ELEMENT_LEN];
278   char proc_name[MAX_LOCATOR_ELEMENT_LEN];
279   int line_no = 0;
280   CORE_ADDR addr = 0;
281   /* Architecture associated with code at this location.  */
282   struct gdbarch *gdbarch = nullptr;
283 };
284
285 /* This defines information about each logical window.  */
286 struct tui_win_info : public tui_gen_win_info
287 {
288 protected:
289
290   explicit tui_win_info (enum tui_win_type type);
291   DISABLE_COPY_AND_ASSIGN (tui_win_info);
292
293   /* Scroll the contents vertically.  This is only called via
294      forward_scroll and backward_scroll.  */
295   virtual void do_scroll_vertical (int num_to_scroll) = 0;
296
297   /* Scroll the contents horizontally.  This is only called via
298      left_scroll and right_scroll.  */
299   virtual void do_scroll_horizontal (int num_to_scroll) = 0;
300
301   /* Called after make_visible_with_new_height sets the new height.
302      Should update the window.  */
303   virtual void do_make_visible_with_new_height () = 0;
304
305 public:
306
307   ~tui_win_info () override
308   {
309   }
310
311   /* Clear the pertinent detail in the window.  */
312   virtual void clear_detail () = 0;
313
314   /* Return true if this window has the locator.  */
315   virtual bool has_locator () const
316   {
317     return false;
318   }
319
320   /* Refresh this window and any associated windows.  */
321   virtual void refresh ();
322
323   /* Called after all the TUI windows are refreshed, to let this
324      window have a chance to update itself further.  */
325   virtual void refresh_all ()
326   {
327   }
328
329   /* Called after a TUI window is given a new height; this updates any
330      related auxiliary windows.  */
331   virtual void set_new_height (int height)
332   {
333   }
334
335   /* Compute the maximum height of this window.  */
336   virtual int max_height () const;
337
338   /* Called after the tab width has been changed.  */
339   virtual void update_tab_width ()
340   {
341   }
342
343   /* Make the window visible after the height has been changed.  */
344   void make_visible_with_new_height ();
345
346   /* Set whether this window is highglighted.  */
347   void set_highlight (bool highlight)
348   {
349     is_highlighted = highlight;
350   }
351
352   /* Methods to scroll the contents of this window.  Note that they
353      are named with "_scroll" coming at the end because the more
354      obvious "scroll_forward" is defined as a macro in term.h.  */
355   void forward_scroll (int num_to_scroll);
356   void backward_scroll (int num_to_scroll);
357   void left_scroll (int num_to_scroll);
358   void right_scroll (int num_to_scroll);
359
360   /* Can this window ever be highlighted?  */
361   bool can_highlight = true;
362
363   /* Is this window highlighted?  */
364   bool is_highlighted = false;
365 };
366
367 /* The base class for all source-like windows, namely the source and
368    disassembly windows.  */
369
370 struct tui_source_window_base : public tui_win_info
371 {
372 protected:
373   explicit tui_source_window_base (enum tui_win_type type);
374   ~tui_source_window_base () override;
375   DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
376
377   void do_scroll_horizontal (int num_to_scroll) override;
378   void do_make_visible_with_new_height () override;
379
380 public:
381
382   void clear_detail () override;
383
384   /* Return true if this window has the locator.  */
385   bool has_locator () const override
386   {
387     return m_has_locator;
388   }
389
390   void make_visible (bool visible) override;
391   void refresh () override;
392   void refresh_all () override;
393
394   /* Refill the source window's source cache and update it.  If this
395      is a disassembly window, then just update it.  */
396   void refill ();
397
398   /* Set the location of the execution point.  */
399   void set_is_exec_point_at (struct tui_line_or_address l);
400
401   void set_new_height (int height) override;
402
403   void update_tab_width () override;
404
405   /* Does the locator belong to this window?  */
406   bool m_has_locator = false;
407   /* Execution information window.  */
408   struct tui_exec_info_window *execution_info = nullptr;
409   /* Used for horizontal scroll.  */
410   int horizontal_offset = 0;
411   struct tui_line_or_address start_line_or_addr;
412
413   /* It is the resolved form as returned by symtab_to_fullname.  */
414   char *fullname = nullptr;
415
416   /* Architecture associated with code at this location.  */
417   struct gdbarch *gdbarch = nullptr;
418 };
419
420 /* A TUI source window.  */
421
422 struct tui_source_window : public tui_source_window_base
423 {
424   tui_source_window ()
425     : tui_source_window_base (SRC_WIN)
426   {
427   }
428
429   DISABLE_COPY_AND_ASSIGN (tui_source_window);
430
431   const char *name () const override
432   {
433     return SRC_NAME;
434   }
435
436 protected:
437
438   void do_scroll_vertical (int num_to_scroll) override;
439 };
440
441 /* A TUI disassembly window.  */
442
443 struct tui_disasm_window : public tui_source_window_base
444 {
445   tui_disasm_window ()
446     : tui_source_window_base (DISASSEM_WIN)
447   {
448   }
449
450   DISABLE_COPY_AND_ASSIGN (tui_disasm_window);
451
452   const char *name () const override
453   {
454     return DISASSEM_NAME;
455   }
456
457 protected:
458
459   void do_scroll_vertical (int num_to_scroll) override;
460 };
461
462 struct tui_data_window : public tui_win_info
463 {
464   tui_data_window ()
465     : tui_win_info (DATA_WIN)
466   {
467   }
468
469   ~tui_data_window () override;
470   DISABLE_COPY_AND_ASSIGN (tui_data_window);
471
472   void clear_detail () override;
473   void refresh_all () override;
474
475   void set_new_height (int height) override;
476
477   void refresh_window () override;
478
479   const char *name () const override
480   {
481     return DATA_NAME;
482   }
483
484   /* Start of data display content.  */
485   tui_win_content data_content = NULL;
486   int data_content_count = 0;
487   /* Start of regs display content.  */
488   tui_win_content regs_content = NULL;
489   int regs_content_count = 0;
490   int regs_column_count = 0;
491   /* Should regs be displayed at all?  */
492   bool display_regs = false;
493   struct reggroup *current_group = nullptr;
494
495 protected:
496
497   void do_scroll_vertical (int num_to_scroll) override;
498   void do_scroll_horizontal (int num_to_scroll) override
499   {
500   }
501   void do_make_visible_with_new_height () override;
502 };
503
504 struct tui_cmd_window : public tui_win_info
505 {
506   tui_cmd_window ()
507     : tui_win_info (CMD_WIN)
508   {
509     can_highlight = false;
510   }
511
512   DISABLE_COPY_AND_ASSIGN (tui_cmd_window);
513
514   void clear_detail () override;
515
516   void make_visible (bool visible) override
517   {
518   }
519
520   int max_height () const override;
521
522   void refresh_window () override
523   {
524   }
525
526   const char *name () const override
527   {
528     return CMD_NAME;
529   }
530
531   int start_line = 0;
532
533 protected:
534
535   void do_scroll_vertical (int num_to_scroll) override
536   {
537   }
538
539   void do_scroll_horizontal (int num_to_scroll) override
540   {
541   }
542
543   void do_make_visible_with_new_height () override;
544 };
545
546 extern int tui_win_is_auxillary (enum tui_win_type win_type);
547
548
549 /* Global Data.  */
550 extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
551
552 #define TUI_SRC_WIN     ((tui_source_window_base *) tui_win_list[SRC_WIN])
553 #define TUI_DISASM_WIN  ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
554 #define TUI_DATA_WIN    ((tui_data_window *) tui_win_list[DATA_WIN])
555 #define TUI_CMD_WIN     ((tui_cmd_window *) tui_win_list[CMD_WIN])
556
557 /* Data Manipulation Functions.  */
558 extern void tui_initialize_static_data (void);
559 extern void tui_init_generic_part (struct tui_gen_win_info *);
560 extern tui_win_content tui_alloc_content (int, enum tui_win_type);
561 extern int tui_add_content_elements (struct tui_gen_win_info *, 
562                                      int);
563 extern void tui_free_win_content (struct tui_gen_win_info *);
564 extern void tui_free_data_content (tui_win_content, int);
565 extern void tui_free_all_source_wins_content (void);
566 extern struct tui_win_info *tui_partial_win_by_name (const char *);
567 extern enum tui_layout_type tui_current_layout (void);
568 extern void tui_set_current_layout_to (enum tui_layout_type);
569 extern int tui_term_height (void);
570 extern void tui_set_term_height_to (int);
571 extern int tui_term_width (void);
572 extern void tui_set_term_width_to (int);
573 extern struct tui_locator_window *tui_locator_win_info_ptr (void);
574 extern std::vector<tui_source_window_base *> &tui_source_windows ();
575 extern void tui_clear_source_windows (void);
576 extern void tui_clear_source_windows_detail (void);
577 extern void tui_add_to_source_windows (struct tui_source_window_base *);
578 extern struct tui_win_info *tui_win_with_focus (void);
579 extern void tui_set_win_with_focus (struct tui_win_info *);
580 extern struct tui_layout_def *tui_layout_def (void);
581 extern int tui_win_resized (void);
582 extern void tui_set_win_resized_to (int);
583
584 extern struct tui_win_info *tui_next_win (struct tui_win_info *);
585 extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
586
587 extern unsigned int tui_tab_width;
588
589 #endif /* TUI_TUI_DATA_H */