1 /* TUI data manipulation routines.
3 Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
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 2 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, write to the Free Software
22 Foundation, Inc., 59 Temple Place - Suite 330,
23 Boston, MA 02111-1307, USA. */
28 #include "tui/tui-data.h"
29 #include "tui/tui-wingeneral.h"
31 #include "gdb_string.h"
32 #include "gdb_curses.h"
34 /****************************
35 ** GLOBAL DECLARATIONS
36 ****************************/
37 struct tui_win_info *(tui_win_list[MAX_MAJOR_WINDOWS]);
39 /***************************
41 ****************************/
42 static enum tui_layout_type current_layout = UNDEFINED_LAYOUT;
43 static int term_height, term_width;
44 static struct tui_gen_win_info _locator;
45 static struct tui_gen_win_info exec_info[2];
46 static struct tui_win_info * src_win_list[2];
47 static struct tui_list source_windows = {(void **) src_win_list, 0};
48 static int default_tab_len = DEFAULT_TAB_LEN;
49 static struct tui_win_info * win_with_focus = (struct tui_win_info *) NULL;
50 static struct tui_layout_def layout_def =
51 {SRC_WIN, /* DISPLAY_MODE */
53 TUI_UNDEFINED_REGS, /* REGS_DISPLAY_TYPE */
54 TUI_SFLOAT_REGS}; /* FLOAT_REGS_DISPLAY_TYPE */
55 static int win_resized = FALSE;
58 /*********************************
59 ** Static function forward decls
60 **********************************/
61 static void free_content (tui_win_content, int, enum tui_win_type);
62 static void free_content_elements (tui_win_content, int, enum tui_win_type);
66 /*********************************
68 **********************************/
71 tui_win_is_source_type (enum tui_win_type win_type)
73 return (win_type == SRC_WIN || win_type == DISASSEM_WIN);
77 tui_win_is_auxillary (enum tui_win_type win_type)
79 return (win_type > MAX_MAJOR_WINDOWS);
83 tui_win_has_locator (struct tui_win_info *win_info)
85 return (win_info != NULL \
86 && win_info->detail.source_info.has_locator);
90 tui_set_win_highlight (struct tui_win_info *win_info, int highlight)
93 win_info->is_highlighted = highlight;
96 /******************************************
97 ** ACCESSORS & MUTATORS FOR PRIVATE DATA
98 ******************************************/
100 /* Answer a whether the terminal window has been resized or not. */
102 tui_win_resized (void)
108 /* Set a whether the terminal window has been resized or not. */
110 tui_set_win_resized_to (int resized)
112 win_resized = resized;
116 /* Answer a pointer to the current layout definition. */
117 struct tui_layout_def *
118 tui_layout_def (void)
124 /* Answer the window with the logical focus. */
125 struct tui_win_info *
126 tui_win_with_focus (void)
128 return win_with_focus;
132 /* Set the window that has the logical focus. */
134 tui_set_win_with_focus (struct tui_win_info * win_info)
136 win_with_focus = win_info;
140 /* Answer the length in chars, of tabs. */
142 tui_default_tab_len (void)
144 return default_tab_len;
148 /* Set the length in chars, of tabs. */
150 tui_set_default_tab_len (int len)
152 default_tab_len = len;
156 /* Accessor for the current source window. Usually there is only one
157 source window (either source or disassembly), but both can be
158 displayed at the same time. */
160 tui_source_windows (void)
162 return &source_windows;
166 /* Clear the list of source windows. Usually there is only one source
167 window (either source or disassembly), but both can be displayed at
170 tui_clear_source_windows (void)
172 source_windows.list[0] = NULL;
173 source_windows.list[1] = NULL;
174 source_windows.count = 0;
178 /* Clear the pertinant detail in the source windows. */
180 tui_clear_source_windows_detail (void)
184 for (i = 0; i < (tui_source_windows ())->count; i++)
185 tui_clear_win_detail ((struct tui_win_info *) (tui_source_windows ())->list[i]);
189 /* Add a window to the list of source windows. Usually there is only
190 one source window (either source or disassembly), but both can be
191 displayed at the same time. */
193 tui_add_to_source_windows (struct tui_win_info * win_info)
195 if (source_windows.count < 2)
196 source_windows.list[source_windows.count++] = (void *) win_info;
200 /* Clear the pertinant detail in the windows. */
202 tui_clear_win_detail (struct tui_win_info * win_info)
204 if (win_info != NULL)
206 switch (win_info->generic.type)
210 win_info->detail.source_info.start_line_or_addr.addr = 0;
211 win_info->detail.source_info.horizontal_offset = 0;
214 win_info->detail.command_info.cur_line =
215 win_info->detail.command_info.curch = 0;
218 win_info->detail.data_display_info.data_content =
219 (tui_win_content) NULL;
220 win_info->detail.data_display_info.data_content_count = 0;
221 win_info->detail.data_display_info.regs_content =
222 (tui_win_content) NULL;
223 win_info->detail.data_display_info.regs_content_count = 0;
224 win_info->detail.data_display_info.regs_display_type =
226 win_info->detail.data_display_info.regs_column_count = 1;
227 win_info->detail.data_display_info.display_regs = FALSE;
236 /* Accessor for the source execution info ptr. */
237 struct tui_gen_win_info *
238 tui_source_exec_info_win_ptr (void)
240 return &exec_info[0];
244 /* Accessor for the disassem execution info ptr. */
245 struct tui_gen_win_info *
246 tui_disassem_exec_info_win_ptr (void)
248 return &exec_info[1];
252 /* Accessor for the locator win info. Answers a pointer to the static
253 locator win info struct. */
254 struct tui_gen_win_info *
255 tui_locator_win_info_ptr (void)
261 /* Accessor for the term_height. */
263 tui_term_height (void)
269 /* Mutator for the term height. */
271 tui_set_term_height_to (int h)
277 /* Accessor for the term_width. */
279 tui_term_width (void)
285 /* Mutator for the term_width. */
287 tui_set_term_width_to (int w)
293 /* Accessor for the current layout. */
295 tui_current_layout (void)
297 return current_layout;
301 /* Mutator for the current layout. */
303 tui_set_current_layout_to (enum tui_layout_type new_layout)
305 current_layout = new_layout;
309 /* Set the origin of the window. */
311 set_gen_win_origin (struct tui_gen_win_info * win_info, int x, int y)
313 win_info->origin.x = x;
314 win_info->origin.y = y;
318 /*****************************
319 ** OTHER PUBLIC FUNCTIONS
320 *****************************/
323 /* Answer the next window in the list, cycling back to the top if
325 struct tui_win_info *
326 tui_next_win (struct tui_win_info * cur_win)
328 enum tui_win_type type = cur_win->generic.type;
329 struct tui_win_info * next_win = (struct tui_win_info *) NULL;
331 if (cur_win->generic.type == CMD_WIN)
334 type = cur_win->generic.type + 1;
335 while (type != cur_win->generic.type && (next_win == NULL))
337 if (tui_win_list[type] && tui_win_list[type]->generic.is_visible)
338 next_win = tui_win_list[type];
352 /* Answer the prev window in the list, cycling back to the bottom if
354 struct tui_win_info *
355 tui_prev_win (struct tui_win_info * cur_win)
357 enum tui_win_type type = cur_win->generic.type;
358 struct tui_win_info * prev = (struct tui_win_info *) NULL;
360 if (cur_win->generic.type == SRC_WIN)
363 type = cur_win->generic.type - 1;
364 while (type != cur_win->generic.type && (prev == NULL))
366 if (tui_win_list[type]->generic.is_visible)
367 prev = tui_win_list[type];
381 /* Answer the window represented by name. */
382 struct tui_win_info *
383 tui_partial_win_by_name (char *name)
385 struct tui_win_info * win_info = (struct tui_win_info *) NULL;
387 if (name != (char *) NULL)
391 while (i < MAX_MAJOR_WINDOWS && win_info == NULL)
393 if (tui_win_list[i] != 0)
395 char *cur_name = tui_win_name (&tui_win_list[i]->generic);
396 if (strlen (name) <= strlen (cur_name) &&
397 strncmp (name, cur_name, strlen (name)) == 0)
398 win_info = tui_win_list[i];
408 /* Answer the name of the window. */
410 tui_win_name (struct tui_gen_win_info * win_info)
412 char *name = (char *) NULL;
414 switch (win_info->type)
423 name = DISASSEM_NAME;
438 tui_initialize_static_data (void)
440 tui_init_generic_part (tui_source_exec_info_win_ptr ());
441 tui_init_generic_part (tui_disassem_exec_info_win_ptr ());
442 tui_init_generic_part (tui_locator_win_info_ptr ());
446 struct tui_gen_win_info *
447 tui_alloc_generic_win_info (void)
449 struct tui_gen_win_info * win;
451 if ((win = (struct tui_gen_win_info *) xmalloc (
452 sizeof (struct tui_gen_win_info *))) != (struct tui_gen_win_info *) NULL)
453 tui_init_generic_part (win);
460 tui_init_generic_part (struct tui_gen_win_info * win)
466 win->viewport_height =
468 win->last_visible_line = 0;
469 win->handle = (WINDOW *) NULL;
471 win->content_in_use =
472 win->is_visible = FALSE;
478 ** init_content_element().
481 init_content_element (struct tui_win_element * element, enum tui_win_type type)
483 element->highlight = FALSE;
488 element->which_element.source.line = (char *) NULL;
489 element->which_element.source.line_or_addr.line_no = 0;
490 element->which_element.source.is_exec_point = FALSE;
491 element->which_element.source.has_break = FALSE;
494 tui_init_generic_part (&element->which_element.data_window);
495 element->which_element.data_window.type = DATA_ITEM_WIN;
496 ((struct tui_gen_win_info *) & element->which_element.data_window)->content =
497 (void **) tui_alloc_content (1, DATA_ITEM_WIN);
498 ((struct tui_gen_win_info *)
499 & element->which_element.data_window)->content_size = 1;
502 element->which_element.command.line = (char *) NULL;
505 element->which_element.data.name = (char *) NULL;
506 element->which_element.data.type = TUI_REGISTER;
507 element->which_element.data.item_no = UNDEFINED_ITEM;
508 element->which_element.data.value = NULL;
509 element->which_element.data.highlight = FALSE;
510 element->which_element.data.content = (char*) NULL;
513 element->which_element.locator.file_name[0] =
514 element->which_element.locator.proc_name[0] = (char) 0;
515 element->which_element.locator.line_no = 0;
516 element->which_element.locator.addr = 0;
519 memset(element->which_element.simple_string, ' ',
520 sizeof(element->which_element.simple_string));
528 init_win_info (struct tui_win_info * win_info)
530 tui_init_generic_part (&win_info->generic);
531 win_info->can_highlight =
532 win_info->is_highlighted = FALSE;
533 switch (win_info->generic.type)
537 win_info->detail.source_info.execution_info = (struct tui_gen_win_info *) NULL;
538 win_info->detail.source_info.has_locator = FALSE;
539 win_info->detail.source_info.horizontal_offset = 0;
540 win_info->detail.source_info.start_line_or_addr.addr = 0;
541 win_info->detail.source_info.filename = 0;
544 win_info->detail.data_display_info.data_content = (tui_win_content) NULL;
545 win_info->detail.data_display_info.data_content_count = 0;
546 win_info->detail.data_display_info.regs_content = (tui_win_content) NULL;
547 win_info->detail.data_display_info.regs_content_count = 0;
548 win_info->detail.data_display_info.regs_display_type =
550 win_info->detail.data_display_info.regs_column_count = 1;
551 win_info->detail.data_display_info.display_regs = FALSE;
552 win_info->detail.data_display_info.current_group = 0;
555 win_info->detail.command_info.cur_line = 0;
556 win_info->detail.command_info.curch = 0;
559 win_info->detail.opaque = NULL;
565 struct tui_win_info *
566 tui_alloc_win_info (enum tui_win_type type)
568 struct tui_win_info * win_info = (struct tui_win_info *) NULL;
570 win_info = (struct tui_win_info *) xmalloc (sizeof (struct tui_win_info));
571 if ((win_info != NULL))
573 win_info->generic.type = type;
574 init_win_info (win_info);
581 /* Allocates the content and elements in a block. */
583 tui_alloc_content (int num_elements, enum tui_win_type type)
585 tui_win_content content = (tui_win_content) NULL;
586 char *element_block_ptr = (char *) NULL;
589 if ((content = (tui_win_content)
590 xmalloc (sizeof (struct tui_win_element *) * num_elements)) != (tui_win_content) NULL)
592 ** All windows, except the data window, can allocate the elements
593 ** in a chunk. The data window cannot because items can be
594 ** added/removed from the data display by the user at any time.
596 if (type != DATA_WIN)
598 if ((element_block_ptr = (char *)
599 xmalloc (sizeof (struct tui_win_element) * num_elements)) != (char *) NULL)
601 for (i = 0; i < num_elements; i++)
603 content[i] = (struct tui_win_element *) element_block_ptr;
604 init_content_element (content[i], type);
605 element_block_ptr += sizeof (struct tui_win_element);
611 content = (tui_win_content) NULL;
620 /* Adds the input number of elements to the windows's content. If no
621 content has been allocated yet, alloc_content() is called to do
622 this. The index of the first element added is returned, unless
623 there is a memory allocation error, in which case, (-1) is
626 tui_add_content_elements (struct tui_gen_win_info * win_info, int num_elements)
628 struct tui_win_element * element_ptr;
631 if (win_info->content == NULL)
633 win_info->content = (void **) tui_alloc_content (num_elements, win_info->type);
637 index_start = win_info->content_size;
638 if (win_info->content != NULL)
640 for (i = index_start; (i < num_elements + index_start); i++)
642 if ((element_ptr = (struct tui_win_element *)
643 xmalloc (sizeof (struct tui_win_element))) != (struct tui_win_element *) NULL)
645 win_info->content[i] = (void *) element_ptr;
646 init_content_element (element_ptr, win_info->type);
647 win_info->content_size++;
649 else /* things must be really hosed now! We ran out of memory!? */
658 /* Delete all curses windows associated with win_info, leaving everything
661 tui_del_window (struct tui_win_info * win_info)
663 struct tui_gen_win_info * generic_win;
665 switch (win_info->generic.type)
669 generic_win = tui_locator_win_info_ptr ();
670 if (generic_win != (struct tui_gen_win_info *) NULL)
672 tui_delete_win (generic_win->handle);
673 generic_win->handle = (WINDOW *) NULL;
674 generic_win->is_visible = FALSE;
676 if (win_info->detail.source_info.filename)
678 xfree (win_info->detail.source_info.filename);
679 win_info->detail.source_info.filename = 0;
681 generic_win = win_info->detail.source_info.execution_info;
682 if (generic_win != (struct tui_gen_win_info *) NULL)
684 tui_delete_win (generic_win->handle);
685 generic_win->handle = (WINDOW *) NULL;
686 generic_win->is_visible = FALSE;
690 if (win_info->generic.content != NULL)
692 tui_del_data_windows (win_info->detail.data_display_info.regs_content,
693 win_info->detail.data_display_info.regs_content_count);
694 tui_del_data_windows (win_info->detail.data_display_info.data_content,
695 win_info->detail.data_display_info.data_content_count);
701 if (win_info->generic.handle != (WINDOW *) NULL)
703 tui_delete_win (win_info->generic.handle);
704 win_info->generic.handle = (WINDOW *) NULL;
705 win_info->generic.is_visible = FALSE;
711 tui_free_window (struct tui_win_info * win_info)
713 struct tui_gen_win_info * generic_win;
715 switch (win_info->generic.type)
719 generic_win = tui_locator_win_info_ptr ();
720 if (generic_win != (struct tui_gen_win_info *) NULL)
722 tui_delete_win (generic_win->handle);
723 generic_win->handle = (WINDOW *) NULL;
725 tui_free_win_content (generic_win);
726 if (win_info->detail.source_info.filename)
728 xfree (win_info->detail.source_info.filename);
729 win_info->detail.source_info.filename = 0;
731 generic_win = win_info->detail.source_info.execution_info;
732 if (generic_win != (struct tui_gen_win_info *) NULL)
734 tui_delete_win (generic_win->handle);
735 generic_win->handle = (WINDOW *) NULL;
736 tui_free_win_content (generic_win);
740 if (win_info->generic.content != NULL)
742 tui_free_data_content (win_info->detail.data_display_info.regs_content,
743 win_info->detail.data_display_info.regs_content_count);
744 win_info->detail.data_display_info.regs_content =
745 (tui_win_content) NULL;
746 win_info->detail.data_display_info.regs_content_count = 0;
747 tui_free_data_content (win_info->detail.data_display_info.data_content,
748 win_info->detail.data_display_info.data_content_count);
749 win_info->detail.data_display_info.data_content =
750 (tui_win_content) NULL;
751 win_info->detail.data_display_info.data_content_count = 0;
752 win_info->detail.data_display_info.regs_display_type =
754 win_info->detail.data_display_info.regs_column_count = 1;
755 win_info->detail.data_display_info.display_regs = FALSE;
756 win_info->generic.content = NULL;
757 win_info->generic.content_size = 0;
763 if (win_info->generic.handle != (WINDOW *) NULL)
765 tui_delete_win (win_info->generic.handle);
766 win_info->generic.handle = (WINDOW *) NULL;
767 tui_free_win_content (&win_info->generic);
769 if (win_info->generic.title)
770 xfree (win_info->generic.title);
776 tui_free_all_source_wins_content (void)
780 for (i = 0; i < (tui_source_windows ())->count; i++)
782 struct tui_win_info * win_info = (struct tui_win_info *) (tui_source_windows ())->list[i];
784 if (win_info != NULL)
786 tui_free_win_content (&(win_info->generic));
787 tui_free_win_content (win_info->detail.source_info.execution_info);
794 tui_free_win_content (struct tui_gen_win_info * win_info)
796 if (win_info->content != NULL)
798 free_content ((tui_win_content) win_info->content,
799 win_info->content_size,
801 win_info->content = NULL;
803 win_info->content_size = 0;
808 tui_del_data_windows (tui_win_content content, int content_size)
813 ** Remember that data window content elements are of type struct tui_gen_win_info *,
814 ** each of which whose single element is a data element.
816 for (i = 0; i < content_size; i++)
818 struct tui_gen_win_info * generic_win = &content[i]->which_element.data_window;
820 if (generic_win != (struct tui_gen_win_info *) NULL)
822 tui_delete_win (generic_win->handle);
823 generic_win->handle = (WINDOW *) NULL;
824 generic_win->is_visible = FALSE;
831 tui_free_data_content (tui_win_content content, int content_size)
836 ** Remember that data window content elements are of type struct tui_gen_win_info *,
837 ** each of which whose single element is a data element.
839 for (i = 0; i < content_size; i++)
841 struct tui_gen_win_info * generic_win = &content[i]->which_element.data_window;
843 if (generic_win != (struct tui_gen_win_info *) NULL)
845 tui_delete_win (generic_win->handle);
846 generic_win->handle = (WINDOW *) NULL;
847 tui_free_win_content (generic_win);
850 free_content (content,
856 /**********************************
857 ** LOCAL STATIC FUNCTIONS **
858 **********************************/
862 free_content (tui_win_content content, int content_size, enum tui_win_type win_type)
864 if (content != (tui_win_content) NULL)
866 free_content_elements (content, content_size, win_type);
873 ** free_content_elements().
876 free_content_elements (tui_win_content content, int content_size, enum tui_win_type type)
878 if (content != (tui_win_content) NULL)
882 if (type == SRC_WIN || type == DISASSEM_WIN)
884 /* free whole source block */
885 xfree (content[0]->which_element.source.line);
889 for (i = 0; i < content_size; i++)
891 struct tui_win_element * element;
893 element = content[i];
894 if (element != (struct tui_win_element *) NULL)
903 ** Note that data elements are not allocated
904 ** in a single block, but individually, as needed.
906 if (element->which_element.data.type != TUI_REGISTER)
907 xfree ((void *)element->which_element.data.name);
908 xfree (element->which_element.data.value);
909 xfree (element->which_element.data.content);
913 xfree (element->which_element.command.line);
921 if (type != DATA_WIN && type != DATA_ITEM_WIN)
922 xfree (content[0]); /* free the element block */