1 /* TUI display source/assembly window.
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/>. */
26 #include "breakpoint.h"
30 #include "filenames.h"
33 #include "tui/tui-data.h"
34 #include "tui/tui-io.h"
35 #include "tui/tui-stack.h"
36 #include "tui/tui-win.h"
37 #include "tui/tui-wingeneral.h"
38 #include "tui/tui-winsource.h"
39 #include "tui/tui-source.h"
40 #include "tui/tui-disasm.h"
41 #include "gdb_curses.h"
43 /* Function to display the "main" routine. */
47 if (!tui_source_windows ().empty ())
49 struct gdbarch
*gdbarch
;
52 tui_get_begin_asm_address (&gdbarch
, &addr
);
53 if (addr
!= (CORE_ADDR
) 0)
57 tui_update_source_windows_with_addr (gdbarch
, addr
);
58 s
= find_pc_line_symtab (addr
);
60 tui_update_locator_fullname (symtab_to_fullname (s
));
62 tui_update_locator_fullname ("??");
69 /* Function to display source in the source window. This function
70 initializes the horizontal scroll to 0. */
72 tui_update_source_window (struct tui_source_window_base
*win_info
,
73 struct gdbarch
*gdbarch
,
75 struct tui_line_or_address line_or_addr
,
78 win_info
->horizontal_offset
= 0;
79 tui_update_source_window_as_is (win_info
, gdbarch
, s
, line_or_addr
, noerror
);
85 /* Function to display source in the source/asm window. This function
86 shows the source as specified by the horizontal offset. */
88 tui_update_source_window_as_is (struct tui_source_window_base
*win_info
,
89 struct gdbarch
*gdbarch
,
91 struct tui_line_or_address line_or_addr
,
96 if (win_info
->type
== SRC_WIN
)
97 ret
= tui_set_source_content (win_info
, s
, line_or_addr
.u
.line_no
,
100 ret
= tui_set_disassem_content (win_info
, gdbarch
, line_or_addr
.u
.addr
);
102 if (ret
== TUI_FAILURE
)
104 tui_clear_source_content (win_info
);
105 tui_clear_exec_info_content (win_info
);
109 tui_update_breakpoint_info (win_info
, nullptr, false);
110 tui_show_source_content (win_info
);
111 tui_update_exec_info (win_info
);
112 if (win_info
->type
== SRC_WIN
)
116 sal
.line
= line_or_addr
.u
.line_no
+
117 (win_info
->content
.size () - 2);
119 sal
.pspace
= SYMTAB_PSPACE (s
);
120 set_current_source_symtab_and_line (sal
);
121 /* If the focus was in the asm win, put it in the src win if
122 we don't have a split layout. */
123 if (tui_win_with_focus () == TUI_DISASM_WIN
124 && tui_current_layout () != SRC_DISASSEM_COMMAND
)
125 tui_set_win_focus_to (win_info
);
134 /* Function to ensure that the source and/or disassemly windows
135 reflect the input address. */
137 tui_update_source_windows_with_addr (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
141 struct symtab_and_line sal
;
142 struct tui_line_or_address l
;
144 switch (tui_current_layout ())
146 case DISASSEM_COMMAND
:
147 case DISASSEM_DATA_COMMAND
:
148 tui_show_disassem (gdbarch
, addr
);
150 case SRC_DISASSEM_COMMAND
:
151 tui_show_disassem_and_update_source (gdbarch
, addr
);
154 sal
= find_pc_line (addr
, 0);
156 l
.u
.line_no
= sal
.line
;
157 tui_show_symtab_source (TUI_SRC_WIN
, gdbarch
, sal
.symtab
, l
, FALSE
);
163 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
165 tui_clear_source_content (win_info
);
166 tui_clear_exec_info_content (win_info
);
171 /* Function to ensure that the source and/or disassemly windows
172 reflect the input address. */
174 tui_update_source_windows_with_line (struct symtab
*s
, int line
)
176 struct gdbarch
*gdbarch
;
178 struct tui_line_or_address l
;
183 gdbarch
= get_objfile_arch (SYMTAB_OBJFILE (s
));
185 switch (tui_current_layout ())
187 case DISASSEM_COMMAND
:
188 case DISASSEM_DATA_COMMAND
:
189 find_line_pc (s
, line
, &pc
);
190 tui_update_source_windows_with_addr (gdbarch
, pc
);
195 tui_show_symtab_source (TUI_SRC_WIN
, gdbarch
, s
, l
, FALSE
);
196 if (tui_current_layout () == SRC_DISASSEM_COMMAND
)
198 find_line_pc (s
, line
, &pc
);
199 tui_show_disassem (gdbarch
, pc
);
208 tui_clear_source_content (struct tui_source_window_base
*win_info
)
210 if (win_info
!= NULL
)
214 tui_erase_source_content (win_info
);
215 for (i
= 0; i
< win_info
->content
.size (); i
++)
217 struct tui_source_element
*element
= &win_info
->content
[i
];
219 element
->break_mode
= 0;
220 element
->is_exec_point
= false;
227 tui_erase_source_content (struct tui_source_window_base
*win_info
)
230 int half_width
= (win_info
->width
- 2) / 2;
232 if (win_info
->handle
!= NULL
)
234 werase (win_info
->handle
);
235 tui_check_and_display_highlight_if_needed (win_info
);
237 const char *no_src_str
;
239 if (win_info
->type
== SRC_WIN
)
240 no_src_str
= NO_SRC_STRING
;
242 no_src_str
= NO_DISASSEM_STRING
;
243 if (strlen (no_src_str
) >= half_width
)
246 x_pos
= half_width
- strlen (no_src_str
);
247 mvwaddstr (win_info
->handle
,
248 (win_info
->height
/ 2),
250 (char *) no_src_str
);
252 win_info
->content
.clear ();
253 win_info
->refresh_window ();
258 /* Redraw the complete line of a source or disassembly window. */
260 tui_show_source_line (struct tui_source_window_base
*win_info
, int lineno
)
262 struct tui_source_element
*line
;
265 line
= &win_info
->content
[lineno
- 1];
266 if (line
->is_exec_point
)
267 tui_set_reverse_mode (win_info
->handle
, true);
269 wmove (win_info
->handle
, lineno
, 1);
270 tui_puts (line
->line
,
272 if (line
->is_exec_point
)
273 tui_set_reverse_mode (win_info
->handle
, false);
275 /* Clear to end of line but stop before the border. */
276 x
= getcurx (win_info
->handle
);
277 while (x
+ 1 < win_info
->width
)
279 waddch (win_info
->handle
, ' ');
280 x
= getcurx (win_info
->handle
);
285 tui_show_source_content (struct tui_source_window_base
*win_info
)
287 if (!win_info
->content
.empty ())
291 for (lineno
= 1; lineno
<= win_info
->content
.size (); lineno
++)
292 tui_show_source_line (win_info
, lineno
);
295 tui_erase_source_content (win_info
);
297 tui_check_and_display_highlight_if_needed (win_info
);
298 win_info
->refresh_window ();
301 /* See tui-data.h. */
304 tui_source_window_base::clear_detail ()
307 start_line_or_addr
.loa
= LOA_ADDRESS
;
308 start_line_or_addr
.u
.addr
= 0;
309 horizontal_offset
= 0;
312 tui_source_window_base::tui_source_window_base (enum tui_win_type type
)
313 : tui_win_info (type
),
314 execution_info (new tui_exec_info_window ())
316 gdb_assert (type
== SRC_WIN
|| type
== DISASSEM_WIN
);
317 start_line_or_addr
.loa
= LOA_ADDRESS
;
318 start_line_or_addr
.u
.addr
= 0;
322 tui_source_window_base::~tui_source_window_base ()
325 delete execution_info
;
329 tui_source_window_base::reset (int height
, int width
,
330 int origin_x
, int origin_y
)
332 tui_gen_win_info::reset (height
, width
- 3,
333 origin_x
+ 3, origin_y
);
334 execution_info
->reset (height
, 3, origin_x
, origin_y
);
337 /* See tui-data.h. */
340 tui_source_window_base::refresh_all ()
342 tui_show_source_content (this);
343 tui_check_and_display_highlight_if_needed (this);
344 tui_erase_exec_info_content (this);
345 tui_update_exec_info (this);
348 /* See tui-data.h. */
351 tui_source_window_base::update_tab_width ()
353 /* We don't really change the height of any windows, but
354 calling these 2 functions causes a complete regeneration
355 and redisplay of the window's contents, which will take
356 the new tab width into account. */
357 make_invisible_and_set_new_height (height
);
358 make_visible_with_new_height ();
361 /* See tui-data.h. */
364 tui_source_window_base::set_new_height (int height
)
366 execution_info
->make_visible (false);
367 execution_info
->height
= height
;
368 execution_info
->origin
.y
= origin
.y
;
370 execution_info
->viewport_height
= height
- 1;
372 execution_info
->viewport_height
= height
;
373 execution_info
->viewport_height
--;
377 tui_locator_window
*gen_win_info
= tui_locator_win_info_ptr ();
378 gen_win_info
->make_visible (false);
379 gen_win_info
->origin
.y
= origin
.y
+ height
;
383 /* See tui-data.h. */
386 tui_source_window_base::do_make_visible_with_new_height ()
388 execution_info
->make_visible (true);
389 if (!content
.empty ())
391 struct tui_line_or_address line_or_addr
;
392 struct symtab_and_line cursal
393 = get_current_source_symtab_and_line ();
395 line_or_addr
= start_line_or_addr
;
396 tui_update_source_window (this, gdbarch
,
397 cursal
.symtab
, line_or_addr
, TRUE
);
399 else if (deprecated_safe_get_selected_frame () != NULL
)
401 struct tui_line_or_address line
;
402 struct symtab_and_line cursal
403 = get_current_source_symtab_and_line ();
404 struct frame_info
*frame
= deprecated_safe_get_selected_frame ();
405 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
407 struct symtab
*s
= find_pc_line_symtab (get_frame_pc (frame
));
411 line
.u
.line_no
= cursal
.line
;
415 line
.loa
= LOA_ADDRESS
;
416 find_line_pc (s
, cursal
.line
, &line
.u
.addr
);
418 tui_update_source_window (this, gdbarch
, s
, line
, TRUE
);
422 tui_locator_win_info_ptr ()->make_visible (true);
423 tui_show_locator_content ();
427 /* See tui-data.h. */
430 tui_source_window_base::make_visible (bool visible
)
432 execution_info
->make_visible (visible
);
433 tui_win_info::make_visible (visible
);
436 /* See tui-data.h. */
439 tui_source_window_base::refresh_window ()
441 execution_info
->refresh_window ();
442 tui_win_info::refresh_window ();
445 /* See tui-data.h. */
448 tui_source_window_base::refill ()
454 symtab_and_line cursal
= get_current_source_symtab_and_line ();
455 s
= (cursal
.symtab
== NULL
456 ? find_pc_line_symtab (get_frame_pc (get_selected_frame (NULL
)))
460 tui_update_source_window_as_is (this, gdbarch
, s
,
461 content
[0].line_or_addr
,
465 /* Scroll the source forward or backward horizontally. */
468 tui_source_window_base::do_scroll_horizontal (int num_to_scroll
)
470 if (!content
.empty ())
472 int offset
= horizontal_offset
+ num_to_scroll
;
475 horizontal_offset
= offset
;
481 /* Set or clear the is_exec_point flag in the line whose line is
485 tui_source_window_base::set_is_exec_point_at (struct tui_line_or_address l
)
487 bool changed
= false;
491 while (i
< content
.size ())
494 struct tui_line_or_address content_loa
=
495 content
[i
].line_or_addr
;
497 gdb_assert (l
.loa
== LOA_ADDRESS
|| l
.loa
== LOA_LINE
);
498 gdb_assert (content_loa
.loa
== LOA_LINE
499 || content_loa
.loa
== LOA_ADDRESS
);
500 if (content_loa
.loa
== l
.loa
501 && ((l
.loa
== LOA_LINE
&& content_loa
.u
.line_no
== l
.u
.line_no
)
502 || (l
.loa
== LOA_ADDRESS
&& content_loa
.u
.addr
== l
.u
.addr
)))
506 if (new_state
!= content
[i
].is_exec_point
)
509 content
[i
].is_exec_point
= new_state
;
510 tui_show_source_line (this, i
+ 1);
518 /* See tui-winsource.h. */
521 tui_update_all_breakpoint_info (struct breakpoint
*being_deleted
)
523 for (tui_source_window_base
*win
: tui_source_windows ())
525 if (tui_update_breakpoint_info (win
, being_deleted
, false))
527 tui_update_exec_info (win
);
533 /* Scan the source window and the breakpoints to update the break_mode
534 information for each line.
536 Returns true if something changed and the execution window must be
540 tui_update_breakpoint_info (struct tui_source_window_base
*win
,
541 struct breakpoint
*being_deleted
,
545 bool need_refresh
= false;
547 for (i
= 0; i
< win
->content
.size (); i
++)
549 struct breakpoint
*bp
;
550 extern struct breakpoint
*breakpoint_chain
;
551 struct tui_source_element
*line
;
553 line
= &win
->content
[i
];
554 if (current_only
&& !line
->is_exec_point
)
557 /* Scan each breakpoint to see if the current line has something to
558 do with it. Identify enable/disabled breakpoints as well as
559 those that we already hit. */
560 tui_bp_flags mode
= 0;
561 for (bp
= breakpoint_chain
;
565 struct bp_location
*loc
;
567 gdb_assert (line
->line_or_addr
.loa
== LOA_LINE
568 || line
->line_or_addr
.loa
== LOA_ADDRESS
);
570 if (bp
== being_deleted
)
573 for (loc
= bp
->loc
; loc
!= NULL
; loc
= loc
->next
)
575 if (win
->location_matches_p (loc
, i
))
577 if (bp
->enable_state
== bp_disabled
)
578 mode
|= TUI_BP_DISABLED
;
580 mode
|= TUI_BP_ENABLED
;
584 mode
|= TUI_BP_CONDITIONAL
;
585 if (bp
->type
== bp_hardware_breakpoint
)
586 mode
|= TUI_BP_HARDWARE
;
590 if (line
->break_mode
!= mode
)
592 line
->break_mode
= mode
;
599 /* See tui-data.h. */
601 tui_exec_info_content
*
602 tui_exec_info_window::maybe_allocate_content (int n_elements
)
604 if (m_content
== nullptr)
605 m_content
= XNEWVEC (tui_exec_info_content
, n_elements
);
610 /* Function to initialize the content of the execution info window,
611 based upon the input window which is either the source or
612 disassembly window. */
614 tui_set_exec_info_content (struct tui_source_window_base
*win_info
)
616 tui_exec_info_content
*content
617 = win_info
->execution_info
->maybe_allocate_content (win_info
->height
);
619 tui_update_breakpoint_info (win_info
, nullptr, true);
620 for (int i
= 0; i
< win_info
->content
.size (); i
++)
622 tui_exec_info_content
&element
= content
[i
];
623 struct tui_source_element
*src_element
;
626 src_element
= &win_info
->content
[i
];
628 memset (element
, ' ', sizeof (tui_exec_info_content
));
629 element
[TUI_EXECINFO_SIZE
- 1] = 0;
631 /* Now update the exec info content based upon the state
632 of each line as indicated by the source content. */
633 mode
= src_element
->break_mode
;
634 if (mode
& TUI_BP_HIT
)
635 element
[TUI_BP_HIT_POS
] = (mode
& TUI_BP_HARDWARE
) ? 'H' : 'B';
636 else if (mode
& (TUI_BP_ENABLED
| TUI_BP_DISABLED
))
637 element
[TUI_BP_HIT_POS
] = (mode
& TUI_BP_HARDWARE
) ? 'h' : 'b';
639 if (mode
& TUI_BP_ENABLED
)
640 element
[TUI_BP_BREAK_POS
] = '+';
641 else if (mode
& TUI_BP_DISABLED
)
642 element
[TUI_BP_BREAK_POS
] = '-';
644 if (src_element
->is_exec_point
)
645 element
[TUI_EXEC_POS
] = '>';
651 tui_show_exec_info_content (struct tui_source_window_base
*win_info
)
653 struct tui_exec_info_window
*exec_info
= win_info
->execution_info
;
654 const tui_exec_info_content
*content
= exec_info
->get_content ();
656 werase (exec_info
->handle
);
657 for (int cur_line
= 1; cur_line
<= win_info
->content
.size (); cur_line
++)
658 mvwaddstr (exec_info
->handle
,
661 content
[cur_line
- 1]);
662 exec_info
->refresh_window ();
667 tui_erase_exec_info_content (struct tui_source_window_base
*win_info
)
669 struct tui_gen_win_info
*exec_info
= win_info
->execution_info
;
671 werase (exec_info
->handle
);
672 exec_info
->refresh_window ();
676 tui_clear_exec_info_content (struct tui_source_window_base
*win_info
)
678 tui_erase_exec_info_content (win_info
);
681 /* Function to update the execution info window. */
683 tui_update_exec_info (struct tui_source_window_base
*win_info
)
685 tui_set_exec_info_content (win_info
);
686 tui_show_exec_info_content (win_info
);
690 tui_alloc_source_buffer (struct tui_source_window_base
*win_info
)
692 int i
, line_width
, max_lines
;
694 /* The window width/height includes the highlight box. Determine actual
695 content dimensions, including string null-terminators. */
696 max_lines
= win_info
->height
- 2;
697 line_width
= win_info
->width
- 2 + 1;
699 /* Allocate the buffer for the source lines. */
700 win_info
->content
.resize (max_lines
);
701 for (i
= 0; i
< max_lines
; i
++)
703 if (win_info
->content
[i
].line
== nullptr)
704 win_info
->content
[i
].line
= (char *) xmalloc (line_width
);
709 /* Answer whether a particular line number or address is displayed
710 in the current source window. */
712 tui_line_is_displayed (int line
,
713 struct tui_source_window_base
*win_info
,
716 int is_displayed
= FALSE
;
720 threshold
= SCROLL_THRESHOLD
;
724 while (i
< win_info
->content
.size () - threshold
728 = win_info
->content
[i
].line_or_addr
.loa
== LOA_LINE
729 && win_info
->content
[i
].line_or_addr
.u
.line_no
== line
;
737 /* Answer whether a particular line number or address is displayed
738 in the current source window. */
740 tui_addr_is_displayed (CORE_ADDR addr
,
741 struct tui_source_window_base
*win_info
,
744 int is_displayed
= FALSE
;
748 threshold
= SCROLL_THRESHOLD
;
752 while (i
< win_info
->content
.size () - threshold
756 = win_info
->content
[i
].line_or_addr
.loa
== LOA_ADDRESS
757 && win_info
->content
[i
].line_or_addr
.u
.addr
== addr
;