1 /* TUI data manipulation routines.
3 Copyright (C) 1998-2019 Free Software Foundation, Inc.
5 Contributed by Hewlett-Packard Company.
7 This file is part of GDB.
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.
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.
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/>. */
25 #include "tui/tui-data.h"
26 #include "tui/tui-wingeneral.h"
27 #include "gdb_curses.h"
29 /****************************
30 ** GLOBAL DECLARATIONS
31 ****************************/
32 struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
34 /***************************
36 ****************************/
37 static enum tui_layout_type current_layout = UNDEFINED_LAYOUT;
38 static int term_height, term_width;
39 static struct tui_gen_win_info _locator;
40 static struct tui_gen_win_info exec_info[2];
41 static std::vector<tui_win_info *> source_windows;
42 static struct tui_win_info *win_with_focus = NULL;
43 static struct tui_layout_def layout_def = {
44 SRC_WIN, /* DISPLAY_MODE */
47 static int win_resized = FALSE;
50 /*********************************
51 ** Static function forward decls
52 **********************************/
53 static void free_content (tui_win_content,
56 static void free_content_elements (tui_win_content,
62 /*********************************
64 **********************************/
67 tui_win_is_source_type (enum tui_win_type win_type)
69 return (win_type == SRC_WIN || win_type == DISASSEM_WIN);
73 tui_win_is_auxillary (enum tui_win_type win_type)
75 return (win_type > MAX_MAJOR_WINDOWS);
79 tui_win_has_locator (struct tui_win_info *win_info)
81 return (win_info != NULL
82 && win_info->detail.source_info.has_locator);
86 tui_set_win_highlight (struct tui_win_info *win_info,
90 win_info->is_highlighted = highlight;
93 /******************************************
94 ** ACCESSORS & MUTATORS FOR PRIVATE DATA
95 ******************************************/
97 /* Answer a whether the terminal window has been resized or not. */
99 tui_win_resized (void)
105 /* Set a whether the terminal window has been resized or not. */
107 tui_set_win_resized_to (int resized)
109 win_resized = resized;
113 /* Answer a pointer to the current layout definition. */
114 struct tui_layout_def *
115 tui_layout_def (void)
121 /* Answer the window with the logical focus. */
122 struct tui_win_info *
123 tui_win_with_focus (void)
125 return win_with_focus;
129 /* Set the window that has the logical focus. */
131 tui_set_win_with_focus (struct tui_win_info *win_info)
133 win_with_focus = win_info;
137 /* Accessor for the current source window. Usually there is only one
138 source window (either source or disassembly), but both can be
139 displayed at the same time. */
140 std::vector<tui_win_info *> &
141 tui_source_windows ()
143 return source_windows;
147 /* Clear the list of source windows. Usually there is only one source
148 window (either source or disassembly), but both can be displayed at
151 tui_clear_source_windows ()
153 source_windows.clear ();
157 /* Clear the pertinant detail in the source windows. */
159 tui_clear_source_windows_detail ()
161 for (tui_win_info *win : tui_source_windows ())
162 tui_clear_win_detail (win);
166 /* Add a window to the list of source windows. Usually there is only
167 one source window (either source or disassembly), but both can be
168 displayed at the same time. */
170 tui_add_to_source_windows (struct tui_win_info *win_info)
172 if (source_windows.size () < 2)
173 source_windows.push_back (win_info);
176 /* See tui-data.h. */
179 tui_source_window_base::clear_detail ()
181 detail.source_info.gdbarch = NULL;
182 detail.source_info.start_line_or_addr.loa = LOA_ADDRESS;
183 detail.source_info.start_line_or_addr.u.addr = 0;
184 detail.source_info.horizontal_offset = 0;
187 /* See tui-data.h. */
190 tui_cmd_window::clear_detail ()
192 wmove (generic.handle, 0, 0);
195 /* See tui-data.h. */
198 tui_data_window::clear_detail ()
200 detail.data_display_info.data_content = NULL;
201 detail.data_display_info.data_content_count = 0;
202 detail.data_display_info.regs_content = NULL;
203 detail.data_display_info.regs_content_count = 0;
204 detail.data_display_info.regs_column_count = 1;
205 detail.data_display_info.display_regs = FALSE;
208 /* Clear the pertinant detail in the windows. */
210 tui_clear_win_detail (struct tui_win_info *win_info)
212 if (win_info != NULL)
213 win_info->clear_detail ();
217 /* Accessor for the source execution info ptr. */
218 struct tui_gen_win_info *
219 tui_source_exec_info_win_ptr (void)
221 return &exec_info[0];
225 /* Accessor for the disassem execution info ptr. */
226 struct tui_gen_win_info *
227 tui_disassem_exec_info_win_ptr (void)
229 return &exec_info[1];
233 /* Accessor for the locator win info. Answers a pointer to the static
234 locator win info struct. */
235 struct tui_gen_win_info *
236 tui_locator_win_info_ptr (void)
242 /* Accessor for the term_height. */
244 tui_term_height (void)
250 /* Mutator for the term height. */
252 tui_set_term_height_to (int h)
258 /* Accessor for the term_width. */
260 tui_term_width (void)
266 /* Mutator for the term_width. */
268 tui_set_term_width_to (int w)
274 /* Accessor for the current layout. */
276 tui_current_layout (void)
278 return current_layout;
282 /* Mutator for the current layout. */
284 tui_set_current_layout_to (enum tui_layout_type new_layout)
286 current_layout = new_layout;
290 /*****************************
291 ** OTHER PUBLIC FUNCTIONS
292 *****************************/
295 /* Answer the next window in the list, cycling back to the top if
297 struct tui_win_info *
298 tui_next_win (struct tui_win_info *cur_win)
300 int type = cur_win->generic.type;
301 struct tui_win_info *next_win = NULL;
303 if (cur_win->generic.type == CMD_WIN)
306 type = cur_win->generic.type + 1;
307 while (type != cur_win->generic.type && (next_win == NULL))
309 if (tui_win_list[type]
310 && tui_win_list[type]->generic.is_visible)
311 next_win = tui_win_list[type];
325 /* Answer the prev window in the list, cycling back to the bottom if
327 struct tui_win_info *
328 tui_prev_win (struct tui_win_info *cur_win)
330 int type = cur_win->generic.type;
331 struct tui_win_info *prev = NULL;
333 if (cur_win->generic.type == SRC_WIN)
336 type = cur_win->generic.type - 1;
337 while (type != cur_win->generic.type && (prev == NULL))
339 if (tui_win_list[type]
340 && tui_win_list[type]->generic.is_visible)
341 prev = tui_win_list[type];
355 /* Answer the window represented by name. */
356 struct tui_win_info *
357 tui_partial_win_by_name (const char *name)
359 struct tui_win_info *win_info = NULL;
365 while (i < MAX_MAJOR_WINDOWS && win_info == NULL)
367 if (tui_win_list[i] != 0)
369 const char *cur_name =
370 tui_win_name (&tui_win_list[i]->generic);
372 if (strlen (name) <= strlen (cur_name)
373 && startswith (cur_name, name))
374 win_info = tui_win_list[i];
384 /* Answer the name of the window. */
386 tui_win_name (const struct tui_gen_win_info *win_info)
388 const char *name = NULL;
390 switch (win_info->type)
399 name = DISASSEM_NAME;
414 tui_initialize_static_data (void)
416 tui_init_generic_part (tui_source_exec_info_win_ptr ());
417 tui_init_generic_part (tui_disassem_exec_info_win_ptr ());
418 tui_init_generic_part (tui_locator_win_info_ptr ());
422 struct tui_gen_win_info *
423 tui_alloc_generic_win_info (void)
425 struct tui_gen_win_info *win = XNEW (struct tui_gen_win_info);
427 tui_init_generic_part (win);
434 tui_init_generic_part (struct tui_gen_win_info *win)
440 win->viewport_height =
442 win->last_visible_line = 0;
445 win->content_in_use =
446 win->is_visible = FALSE;
451 /* init_content_element().
454 init_content_element (struct tui_win_element *element,
455 enum tui_win_type type)
461 element->which_element.source.line = NULL;
462 element->which_element.source.line_or_addr.loa = LOA_LINE;
463 element->which_element.source.line_or_addr.u.line_no = 0;
464 element->which_element.source.is_exec_point = FALSE;
465 element->which_element.source.has_break = FALSE;
468 tui_init_generic_part (&element->which_element.data_window);
469 element->which_element.data_window.type = DATA_ITEM_WIN;
470 element->which_element.data_window.content =
471 tui_alloc_content (1, DATA_ITEM_WIN);
472 element->which_element.data_window.content_size = 1;
475 element->which_element.command.line = NULL;
478 element->which_element.data.name = NULL;
479 element->which_element.data.type = TUI_REGISTER;
480 element->which_element.data.item_no = UNDEFINED_ITEM;
481 element->which_element.data.value = NULL;
482 element->which_element.data.highlight = FALSE;
483 element->which_element.data.content = NULL;
486 element->which_element.locator.full_name[0] =
487 element->which_element.locator.proc_name[0] = (char) 0;
488 element->which_element.locator.line_no = 0;
489 element->which_element.locator.addr = 0;
492 memset(element->which_element.simple_string, ' ',
493 sizeof(element->which_element.simple_string));
500 tui_win_info::tui_win_info (enum tui_win_type type)
503 tui_init_generic_part (&generic);
506 tui_source_window_base::tui_source_window_base (enum tui_win_type type)
507 : tui_win_info (type)
509 gdb_assert (type == SRC_WIN || type == DISASSEM_WIN);
510 detail.source_info.execution_info = NULL;
511 detail.source_info.has_locator = FALSE;
512 detail.source_info.horizontal_offset = 0;
513 detail.source_info.gdbarch = NULL;
514 detail.source_info.start_line_or_addr.loa = LOA_ADDRESS;
515 detail.source_info.start_line_or_addr.u.addr = 0;
516 detail.source_info.fullname = NULL;
519 tui_data_window::tui_data_window ()
520 : tui_win_info (DATA_WIN)
522 detail.data_display_info.data_content = (tui_win_content) NULL;
523 detail.data_display_info.data_content_count = 0;
524 detail.data_display_info.regs_content = (tui_win_content) NULL;
525 detail.data_display_info.regs_content_count = 0;
526 detail.data_display_info.regs_column_count = 1;
527 detail.data_display_info.display_regs = FALSE;
528 detail.data_display_info.current_group = 0;
531 tui_cmd_window::tui_cmd_window ()
532 : tui_win_info (CMD_WIN)
536 struct tui_win_info *
537 tui_alloc_win_info (enum tui_win_type type)
542 return new tui_source_window ();
545 return new tui_disasm_window ();
548 return new tui_data_window ();
551 return new tui_cmd_window ();
554 gdb_assert_not_reached (_("Unhandled window type"));
558 /* Allocates the content and elements in a block. */
560 tui_alloc_content (int num_elements, enum tui_win_type type)
562 tui_win_content content;
563 struct tui_win_element *element_block_ptr;
566 content = XNEWVEC (struct tui_win_element *, num_elements);
569 * All windows, except the data window, can allocate the
570 * elements in a chunk. The data window cannot because items
571 * can be added/removed from the data display by the user at any
574 if (type != DATA_WIN)
576 element_block_ptr = XNEWVEC (struct tui_win_element, num_elements);
577 for (i = 0; i < num_elements; i++)
579 content[i] = element_block_ptr;
580 init_content_element (content[i], type);
589 /* Adds the input number of elements to the windows's content. If no
590 content has been allocated yet, alloc_content() is called to do
591 this. The index of the first element added is returned, unless
592 there is a memory allocation error, in which case, (-1) is
595 tui_add_content_elements (struct tui_gen_win_info *win_info,
598 struct tui_win_element *element_ptr;
601 if (win_info->content == NULL)
603 win_info->content = tui_alloc_content (num_elements, win_info->type);
607 index_start = win_info->content_size;
608 if (win_info->content != NULL)
610 for (i = index_start; (i < num_elements + index_start); i++)
612 element_ptr = XNEW (struct tui_win_element);
613 win_info->content[i] = element_ptr;
614 init_content_element (element_ptr, win_info->type);
615 win_info->content_size++;
622 tui_source_window_base::~tui_source_window_base ()
624 if (detail.source_info.fullname)
626 xfree (detail.source_info.fullname);
627 detail.source_info.fullname = NULL;
629 struct tui_gen_win_info *generic_win = detail.source_info.execution_info;
630 if (generic_win != NULL)
632 tui_delete_win (generic_win->handle);
633 generic_win->handle = NULL;
634 tui_free_win_content (generic_win);
638 tui_data_window::~tui_data_window ()
640 if (generic.content != NULL)
642 tui_free_data_content (detail.data_display_info.regs_content,
643 detail.data_display_info.regs_content_count);
644 detail.data_display_info.regs_content = NULL;
645 detail.data_display_info.regs_content_count = 0;
646 tui_free_data_content (detail.data_display_info.data_content,
647 detail.data_display_info.data_content_count);
648 detail.data_display_info.data_content = NULL;
649 detail.data_display_info.data_content_count = 0;
650 detail.data_display_info.regs_column_count = 1;
651 detail.data_display_info.display_regs = FALSE;
652 generic.content = NULL;
653 generic.content_size = 0;
657 tui_win_info::~tui_win_info ()
659 if (generic.handle != NULL)
661 tui_delete_win (generic.handle);
662 generic.handle = NULL;
663 tui_free_win_content (&generic);
666 xfree (generic.title);
671 tui_free_all_source_wins_content ()
673 for (tui_win_info *win_info : tui_source_windows ())
675 tui_free_win_content (&(win_info->generic));
676 tui_free_win_content (win_info->detail.source_info.execution_info);
682 tui_free_win_content (struct tui_gen_win_info *win_info)
684 if (win_info->content != NULL)
686 free_content (win_info->content,
687 win_info->content_size,
689 win_info->content = NULL;
691 win_info->content_size = 0;
696 tui_free_data_content (tui_win_content content,
701 /* Remember that data window content elements are of type struct
702 tui_gen_win_info *, each of which whose single element is a data
704 for (i = 0; i < content_size; i++)
706 struct tui_gen_win_info *generic_win
707 = &content[i]->which_element.data_window;
709 if (generic_win != NULL)
711 tui_delete_win (generic_win->handle);
712 generic_win->handle = NULL;
713 tui_free_win_content (generic_win);
716 free_content (content,
722 /**********************************
723 ** LOCAL STATIC FUNCTIONS **
724 **********************************/
728 free_content (tui_win_content content,
730 enum tui_win_type win_type)
734 free_content_elements (content, content_size, win_type);
740 /* free_content_elements().
743 free_content_elements (tui_win_content content,
745 enum tui_win_type type)
751 if (type == DISASSEM_WIN)
753 /* Free whole source block. */
754 xfree (content[0]->which_element.source.line);
758 for (i = 0; i < content_size; i++)
760 struct tui_win_element *element;
762 element = content[i];
768 xfree (element->which_element.source.line);
774 /* Note that data elements are not allocated in
775 a single block, but individually, as
777 if (element->which_element.data.type != TUI_REGISTER)
778 xfree ((void *)element->which_element.data.name);
779 xfree (element->which_element.data.value);
780 xfree (element->which_element.data.content);
784 xfree (element->which_element.command.line);
792 if (type != DATA_WIN && type != DATA_ITEM_WIN)
793 xfree (content[0]); /* Free the element block. */