1 /* TUI data manipulation routines.
3 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2006, 2007
4 Free Software Foundation, Inc.
6 Contributed by Hewlett-Packard Company.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 #include "tui/tui-data.h"
27 #include "tui/tui-wingeneral.h"
29 #include "gdb_string.h"
30 #include "gdb_curses.h"
32 /****************************
33 ** GLOBAL DECLARATIONS
34 ****************************/
35 struct tui_win_info *(tui_win_list[MAX_MAJOR_WINDOWS]);
37 /***************************
39 ****************************/
40 static enum tui_layout_type current_layout = UNDEFINED_LAYOUT;
41 static int term_height, term_width;
42 static struct tui_gen_win_info _locator;
43 static struct tui_gen_win_info exec_info[2];
44 static struct tui_win_info *src_win_list[2];
45 static struct tui_list source_windows = {src_win_list, 0};
46 static int default_tab_len = DEFAULT_TAB_LEN;
47 static struct tui_win_info *win_with_focus = (struct tui_win_info *) NULL;
48 static struct tui_layout_def layout_def = {
49 SRC_WIN, /* DISPLAY_MODE */
51 TUI_UNDEFINED_REGS, /* REGS_DISPLAY_TYPE */
52 TUI_SFLOAT_REGS}; /* FLOAT_REGS_DISPLAY_TYPE */
54 static int win_resized = FALSE;
57 /*********************************
58 ** Static function forward decls
59 **********************************/
60 static void free_content (tui_win_content,
63 static void free_content_elements (tui_win_content,
69 /*********************************
71 **********************************/
74 tui_win_is_source_type (enum tui_win_type win_type)
76 return (win_type == SRC_WIN || win_type == DISASSEM_WIN);
80 tui_win_is_auxillary (enum tui_win_type win_type)
82 return (win_type > MAX_MAJOR_WINDOWS);
86 tui_win_has_locator (struct tui_win_info *win_info)
88 return (win_info != NULL
89 && win_info->detail.source_info.has_locator);
93 tui_set_win_highlight (struct tui_win_info *win_info,
97 win_info->is_highlighted = highlight;
100 /******************************************
101 ** ACCESSORS & MUTATORS FOR PRIVATE DATA
102 ******************************************/
104 /* Answer a whether the terminal window has been resized or not. */
106 tui_win_resized (void)
112 /* Set a whether the terminal window has been resized or not. */
114 tui_set_win_resized_to (int resized)
116 win_resized = resized;
120 /* Answer a pointer to the current layout definition. */
121 struct tui_layout_def *
122 tui_layout_def (void)
128 /* Answer the window with the logical focus. */
129 struct tui_win_info *
130 tui_win_with_focus (void)
132 return win_with_focus;
136 /* Set the window that has the logical focus. */
138 tui_set_win_with_focus (struct tui_win_info *win_info)
140 win_with_focus = win_info;
144 /* Answer the length in chars, of tabs. */
146 tui_default_tab_len (void)
148 return default_tab_len;
152 /* Set the length in chars, of tabs. */
154 tui_set_default_tab_len (int len)
156 default_tab_len = len;
160 /* Accessor for the current source window. Usually there is only one
161 source window (either source or disassembly), but both can be
162 displayed at the same time. */
164 tui_source_windows (void)
166 return &source_windows;
170 /* Clear the list of source windows. Usually there is only one source
171 window (either source or disassembly), but both can be displayed at
174 tui_clear_source_windows (void)
176 source_windows.list[0] = NULL;
177 source_windows.list[1] = NULL;
178 source_windows.count = 0;
182 /* Clear the pertinant detail in the source windows. */
184 tui_clear_source_windows_detail (void)
188 for (i = 0; i < (tui_source_windows ())->count; i++)
189 tui_clear_win_detail ((tui_source_windows ())->list[i]);
193 /* Add a window to the list of source windows. Usually there is only
194 one source window (either source or disassembly), but both can be
195 displayed at the same time. */
197 tui_add_to_source_windows (struct tui_win_info *win_info)
199 if (source_windows.count < 2)
200 source_windows.list[source_windows.count++] = (void *) win_info;
204 /* Clear the pertinant detail in the windows. */
206 tui_clear_win_detail (struct tui_win_info *win_info)
208 if (win_info != NULL)
210 switch (win_info->generic.type)
214 win_info->detail.source_info.start_line_or_addr.loa = LOA_ADDRESS;
215 win_info->detail.source_info.start_line_or_addr.u.addr = 0;
216 win_info->detail.source_info.horizontal_offset = 0;
219 win_info->detail.command_info.cur_line =
220 win_info->detail.command_info.curch = 0;
223 win_info->detail.data_display_info.data_content =
224 (tui_win_content) NULL;
225 win_info->detail.data_display_info.data_content_count = 0;
226 win_info->detail.data_display_info.regs_content =
227 (tui_win_content) NULL;
228 win_info->detail.data_display_info.regs_content_count = 0;
229 win_info->detail.data_display_info.regs_display_type =
231 win_info->detail.data_display_info.regs_column_count = 1;
232 win_info->detail.data_display_info.display_regs = FALSE;
241 /* Accessor for the source execution info ptr. */
242 struct tui_gen_win_info *
243 tui_source_exec_info_win_ptr (void)
245 return &exec_info[0];
249 /* Accessor for the disassem execution info ptr. */
250 struct tui_gen_win_info *
251 tui_disassem_exec_info_win_ptr (void)
253 return &exec_info[1];
257 /* Accessor for the locator win info. Answers a pointer to the static
258 locator win info struct. */
259 struct tui_gen_win_info *
260 tui_locator_win_info_ptr (void)
266 /* Accessor for the term_height. */
268 tui_term_height (void)
274 /* Mutator for the term height. */
276 tui_set_term_height_to (int h)
282 /* Accessor for the term_width. */
284 tui_term_width (void)
290 /* Mutator for the term_width. */
292 tui_set_term_width_to (int w)
298 /* Accessor for the current layout. */
300 tui_current_layout (void)
302 return current_layout;
306 /* Mutator for the current layout. */
308 tui_set_current_layout_to (enum tui_layout_type new_layout)
310 current_layout = new_layout;
314 /* Set the origin of the window. */
316 set_gen_win_origin (struct tui_gen_win_info *win_info,
319 win_info->origin.x = x;
320 win_info->origin.y = y;
324 /*****************************
325 ** OTHER PUBLIC FUNCTIONS
326 *****************************/
329 /* Answer the next window in the list, cycling back to the top if
331 struct tui_win_info *
332 tui_next_win (struct tui_win_info *cur_win)
334 enum tui_win_type type = cur_win->generic.type;
335 struct tui_win_info *next_win = (struct tui_win_info *) NULL;
337 if (cur_win->generic.type == CMD_WIN)
340 type = cur_win->generic.type + 1;
341 while (type != cur_win->generic.type && (next_win == NULL))
343 if (tui_win_list[type]
344 && tui_win_list[type]->generic.is_visible)
345 next_win = tui_win_list[type];
359 /* Answer the prev window in the list, cycling back to the bottom if
361 struct tui_win_info *
362 tui_prev_win (struct tui_win_info *cur_win)
364 enum tui_win_type type = cur_win->generic.type;
365 struct tui_win_info *prev = (struct tui_win_info *) NULL;
367 if (cur_win->generic.type == SRC_WIN)
370 type = cur_win->generic.type - 1;
371 while (type != cur_win->generic.type && (prev == NULL))
373 if (tui_win_list[type]
374 && tui_win_list[type]->generic.is_visible)
375 prev = tui_win_list[type];
389 /* Answer the window represented by name. */
390 struct tui_win_info *
391 tui_partial_win_by_name (char *name)
393 struct tui_win_info *win_info = (struct tui_win_info *) NULL;
395 if (name != (char *) NULL)
399 while (i < MAX_MAJOR_WINDOWS && win_info == NULL)
401 if (tui_win_list[i] != 0)
403 char *cur_name = tui_win_name (&tui_win_list[i]->generic);
404 if (strlen (name) <= strlen (cur_name)
405 && strncmp (name, cur_name, strlen (name)) == 0)
406 win_info = tui_win_list[i];
416 /* Answer the name of the window. */
418 tui_win_name (struct tui_gen_win_info *win_info)
420 char *name = (char *) NULL;
422 switch (win_info->type)
431 name = DISASSEM_NAME;
446 tui_initialize_static_data (void)
448 tui_init_generic_part (tui_source_exec_info_win_ptr ());
449 tui_init_generic_part (tui_disassem_exec_info_win_ptr ());
450 tui_init_generic_part (tui_locator_win_info_ptr ());
454 struct tui_gen_win_info *
455 tui_alloc_generic_win_info (void)
457 struct tui_gen_win_info *win;
459 if ((win = XMALLOC (struct tui_gen_win_info)) != NULL)
460 tui_init_generic_part (win);
467 tui_init_generic_part (struct tui_gen_win_info *win)
473 win->viewport_height =
475 win->last_visible_line = 0;
476 win->handle = (WINDOW *) NULL;
478 win->content_in_use =
479 win->is_visible = FALSE;
484 /* init_content_element().
487 init_content_element (struct tui_win_element *element,
488 enum tui_win_type type)
490 element->highlight = FALSE;
495 element->which_element.source.line = (char *) NULL;
496 element->which_element.source.line_or_addr.loa = LOA_LINE;
497 element->which_element.source.line_or_addr.u.line_no = 0;
498 element->which_element.source.is_exec_point = FALSE;
499 element->which_element.source.has_break = FALSE;
502 tui_init_generic_part (&element->which_element.data_window);
503 element->which_element.data_window.type = DATA_ITEM_WIN;
504 ((struct tui_gen_win_info *) & element->which_element.data_window)->content =
505 (void **) tui_alloc_content (1, DATA_ITEM_WIN);
506 ((struct tui_gen_win_info *)
507 & element->which_element.data_window)->content_size = 1;
510 element->which_element.command.line = (char *) NULL;
513 element->which_element.data.name = (char *) NULL;
514 element->which_element.data.type = TUI_REGISTER;
515 element->which_element.data.item_no = UNDEFINED_ITEM;
516 element->which_element.data.value = NULL;
517 element->which_element.data.highlight = FALSE;
518 element->which_element.data.content = (char*) NULL;
521 element->which_element.locator.file_name[0] =
522 element->which_element.locator.proc_name[0] = (char) 0;
523 element->which_element.locator.line_no = 0;
524 element->which_element.locator.addr = 0;
527 memset(element->which_element.simple_string, ' ',
528 sizeof(element->which_element.simple_string));
536 init_win_info (struct tui_win_info *win_info)
538 tui_init_generic_part (&win_info->generic);
539 win_info->can_highlight =
540 win_info->is_highlighted = FALSE;
541 switch (win_info->generic.type)
545 win_info->detail.source_info.execution_info = (struct tui_gen_win_info *) NULL;
546 win_info->detail.source_info.has_locator = FALSE;
547 win_info->detail.source_info.horizontal_offset = 0;
548 win_info->detail.source_info.start_line_or_addr.loa = LOA_ADDRESS;
549 win_info->detail.source_info.start_line_or_addr.u.addr = 0;
550 win_info->detail.source_info.filename = 0;
553 win_info->detail.data_display_info.data_content = (tui_win_content) NULL;
554 win_info->detail.data_display_info.data_content_count = 0;
555 win_info->detail.data_display_info.regs_content = (tui_win_content) NULL;
556 win_info->detail.data_display_info.regs_content_count = 0;
557 win_info->detail.data_display_info.regs_display_type =
559 win_info->detail.data_display_info.regs_column_count = 1;
560 win_info->detail.data_display_info.display_regs = FALSE;
561 win_info->detail.data_display_info.current_group = 0;
564 win_info->detail.command_info.cur_line = 0;
565 win_info->detail.command_info.curch = 0;
568 win_info->detail.opaque = NULL;
574 struct tui_win_info *
575 tui_alloc_win_info (enum tui_win_type type)
577 struct tui_win_info *win_info;
579 win_info = XMALLOC (struct tui_win_info);
580 if (win_info != NULL)
582 win_info->generic.type = type;
583 init_win_info (win_info);
590 /* Allocates the content and elements in a block. */
592 tui_alloc_content (int num_elements, enum tui_win_type type)
594 tui_win_content content;
595 char *element_block_ptr;
598 content = xmalloc (sizeof (struct tui_win_element *) *num_elements);
602 * All windows, except the data window, can allocate the
603 * elements in a chunk. The data window cannot because items
604 * can be added/removed from the data display by the user at any
607 if (type != DATA_WIN)
610 xmalloc (sizeof (struct tui_win_element) * num_elements);
611 if (element_block_ptr != NULL)
613 for (i = 0; i < num_elements; i++)
615 content[i] = (struct tui_win_element *) element_block_ptr;
616 init_content_element (content[i], type);
617 element_block_ptr += sizeof (struct tui_win_element);
623 content = (tui_win_content) NULL;
632 /* Adds the input number of elements to the windows's content. If no
633 content has been allocated yet, alloc_content() is called to do
634 this. The index of the first element added is returned, unless
635 there is a memory allocation error, in which case, (-1) is
638 tui_add_content_elements (struct tui_gen_win_info *win_info,
641 struct tui_win_element *element_ptr;
644 if (win_info->content == NULL)
646 win_info->content = (void **) tui_alloc_content (num_elements, win_info->type);
650 index_start = win_info->content_size;
651 if (win_info->content != NULL)
653 for (i = index_start; (i < num_elements + index_start); i++)
655 if ((element_ptr = XMALLOC (struct tui_win_element)) != NULL)
657 win_info->content[i] = (void *) element_ptr;
658 init_content_element (element_ptr, win_info->type);
659 win_info->content_size++;
661 else /* Things must be really hosed now! We ran out of
671 /* Delete all curses windows associated with win_info, leaving
672 everything else intact. */
674 tui_del_window (struct tui_win_info *win_info)
676 struct tui_gen_win_info *generic_win;
678 switch (win_info->generic.type)
682 generic_win = tui_locator_win_info_ptr ();
683 if (generic_win != (struct tui_gen_win_info *) NULL)
685 tui_delete_win (generic_win->handle);
686 generic_win->handle = (WINDOW *) NULL;
687 generic_win->is_visible = FALSE;
689 if (win_info->detail.source_info.filename)
691 xfree (win_info->detail.source_info.filename);
692 win_info->detail.source_info.filename = 0;
694 generic_win = win_info->detail.source_info.execution_info;
695 if (generic_win != (struct tui_gen_win_info *) NULL)
697 tui_delete_win (generic_win->handle);
698 generic_win->handle = (WINDOW *) NULL;
699 generic_win->is_visible = FALSE;
703 if (win_info->generic.content != NULL)
705 tui_del_data_windows (win_info->detail.data_display_info.regs_content,
706 win_info->detail.data_display_info.regs_content_count);
707 tui_del_data_windows (win_info->detail.data_display_info.data_content,
708 win_info->detail.data_display_info.data_content_count);
714 if (win_info->generic.handle != (WINDOW *) NULL)
716 tui_delete_win (win_info->generic.handle);
717 win_info->generic.handle = (WINDOW *) NULL;
718 win_info->generic.is_visible = FALSE;
724 tui_free_window (struct tui_win_info *win_info)
726 struct tui_gen_win_info *generic_win;
728 switch (win_info->generic.type)
732 generic_win = tui_locator_win_info_ptr ();
733 if (generic_win != (struct tui_gen_win_info *) NULL)
735 tui_delete_win (generic_win->handle);
736 generic_win->handle = (WINDOW *) NULL;
738 tui_free_win_content (generic_win);
739 if (win_info->detail.source_info.filename)
741 xfree (win_info->detail.source_info.filename);
742 win_info->detail.source_info.filename = 0;
744 generic_win = win_info->detail.source_info.execution_info;
745 if (generic_win != (struct tui_gen_win_info *) NULL)
747 tui_delete_win (generic_win->handle);
748 generic_win->handle = (WINDOW *) NULL;
749 tui_free_win_content (generic_win);
753 if (win_info->generic.content != NULL)
755 tui_free_data_content (win_info->detail.data_display_info.regs_content,
756 win_info->detail.data_display_info.regs_content_count);
757 win_info->detail.data_display_info.regs_content =
758 (tui_win_content) NULL;
759 win_info->detail.data_display_info.regs_content_count = 0;
760 tui_free_data_content (win_info->detail.data_display_info.data_content,
761 win_info->detail.data_display_info.data_content_count);
762 win_info->detail.data_display_info.data_content =
763 (tui_win_content) NULL;
764 win_info->detail.data_display_info.data_content_count = 0;
765 win_info->detail.data_display_info.regs_display_type =
767 win_info->detail.data_display_info.regs_column_count = 1;
768 win_info->detail.data_display_info.display_regs = FALSE;
769 win_info->generic.content = NULL;
770 win_info->generic.content_size = 0;
776 if (win_info->generic.handle != (WINDOW *) NULL)
778 tui_delete_win (win_info->generic.handle);
779 win_info->generic.handle = (WINDOW *) NULL;
780 tui_free_win_content (&win_info->generic);
782 if (win_info->generic.title)
783 xfree (win_info->generic.title);
789 tui_free_all_source_wins_content (void)
793 for (i = 0; i < (tui_source_windows ())->count; i++)
795 struct tui_win_info *win_info = (tui_source_windows ())->list[i];
797 if (win_info != NULL)
799 tui_free_win_content (&(win_info->generic));
800 tui_free_win_content (win_info->detail.source_info.execution_info);
807 tui_free_win_content (struct tui_gen_win_info *win_info)
809 if (win_info->content != NULL)
811 free_content ((tui_win_content) win_info->content,
812 win_info->content_size,
814 win_info->content = NULL;
816 win_info->content_size = 0;
821 tui_del_data_windows (tui_win_content content,
826 /* Remember that data window content elements are of type struct
827 tui_gen_win_info *, each of which whose single element is a data
829 for (i = 0; i < content_size; i++)
831 struct tui_gen_win_info *generic_win = &content[i]->which_element.data_window;
833 if (generic_win != (struct tui_gen_win_info *) NULL)
835 tui_delete_win (generic_win->handle);
836 generic_win->handle = (WINDOW *) NULL;
837 generic_win->is_visible = FALSE;
844 tui_free_data_content (tui_win_content content,
849 /* Remember that data window content elements are of type struct
850 tui_gen_win_info *, each of which whose single element is a data
852 for (i = 0; i < content_size; i++)
854 struct tui_gen_win_info *generic_win = &content[i]->which_element.data_window;
856 if (generic_win != (struct tui_gen_win_info *) NULL)
858 tui_delete_win (generic_win->handle);
859 generic_win->handle = (WINDOW *) NULL;
860 tui_free_win_content (generic_win);
863 free_content (content,
869 /**********************************
870 ** LOCAL STATIC FUNCTIONS **
871 **********************************/
875 free_content (tui_win_content content,
877 enum tui_win_type win_type)
879 if (content != (tui_win_content) NULL)
881 free_content_elements (content, content_size, win_type);
887 /* free_content_elements().
890 free_content_elements (tui_win_content content,
892 enum tui_win_type type)
894 if (content != (tui_win_content) NULL)
898 if (type == SRC_WIN || type == DISASSEM_WIN)
900 /* Free whole source block. */
901 xfree (content[0]->which_element.source.line);
905 for (i = 0; i < content_size; i++)
907 struct tui_win_element *element;
909 element = content[i];
910 if (element != (struct tui_win_element *) NULL)
918 /* Note that data elements are not allocated in
919 a single block, but individually, as
921 if (element->which_element.data.type != TUI_REGISTER)
922 xfree ((void *)element->which_element.data.name);
923 xfree (element->which_element.data.value);
924 xfree (element->which_element.data.content);
928 xfree (element->which_element.command.line);
936 if (type != DATA_WIN && type != DATA_ITEM_WIN)
937 xfree (content[0]); /* Free the element block. */