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 auto adapter
= tui_source_windows ();
48 if (adapter
.begin () != adapter
.end ())
50 struct gdbarch
*gdbarch
;
53 tui_get_begin_asm_address (&gdbarch
, &addr
);
54 if (addr
!= (CORE_ADDR
) 0)
58 tui_update_source_windows_with_addr (gdbarch
, addr
);
59 s
= find_pc_line_symtab (addr
);
61 tui_update_locator_fullname (symtab_to_fullname (s
));
63 tui_update_locator_fullname ("??");
68 /* See tui-winsource.h. */
71 tui_copy_source_line (const char **ptr
, int line_no
, int first_col
,
72 int line_width
, int ndigits
)
74 const char *lineptr
= *ptr
;
76 /* Init the line with the line number. */
82 result
= string_printf ("%*d ", ndigits
, line_no
);
85 result
= string_printf ("%-6d", line_no
);
86 int len
= result
.size ();
87 len
= len
- ((len
/ tui_tab_width
) * tui_tab_width
);
88 result
.append (len
, ' ');
99 if (c
== '\033' && skip_ansi_escape (lineptr
, &skip_bytes
))
101 /* We always have to preserve escapes. */
102 result
.append (lineptr
, lineptr
+ skip_bytes
);
103 lineptr
+= skip_bytes
;
110 auto process_tab
= [&] ()
112 int max_tab_len
= tui_tab_width
;
115 for (int j
= column
% max_tab_len
;
116 j
< max_tab_len
&& column
< first_col
+ line_width
;
118 if (column
>= first_col
)
119 result
.push_back (' ');
122 /* We have to process all the text in order to pick up all the
124 if (column
<= first_col
|| column
> first_col
+ line_width
)
131 if (c
== '\n' || c
== '\r' || c
== '\0')
135 else if (c
< 040 && c
!= '\t')
137 result
.push_back ('^');
138 result
.push_back (c
+ 0100);
142 result
.push_back ('^');
143 result
.push_back ('?');
148 result
.push_back (c
);
150 while (c
!= '\0' && c
!= '\n' && c
!= '\r');
152 if (c
== '\r' && *lineptr
== '\n')
160 tui_source_window_base::style_changed ()
162 if (tui_active
&& is_visible ())
166 /* Function to display source in the source window. This function
167 initializes the horizontal scroll to 0. */
169 tui_source_window_base::update_source_window
170 (struct gdbarch
*gdbarch
,
172 struct tui_line_or_address line_or_addr
)
174 horizontal_offset
= 0;
175 update_source_window_as_is (gdbarch
, s
, line_or_addr
);
179 /* Function to display source in the source/asm window. This function
180 shows the source as specified by the horizontal offset. */
182 tui_source_window_base::update_source_window_as_is
183 (struct gdbarch
*gdbarch
,
185 struct tui_line_or_address line_or_addr
)
188 = set_contents (gdbarch
, s
, line_or_addr
);
190 if (ret
== TUI_FAILURE
)
191 erase_source_content ();
194 update_breakpoint_info (nullptr, false);
195 show_source_content ();
201 sal
.line
= line_or_addr
.u
.line_no
+ (content
.size () - 2);
203 sal
.pspace
= SYMTAB_PSPACE (s
);
204 set_current_source_symtab_and_line (sal
);
205 /* If the focus was in the asm win, put it in the src win if
206 we don't have a split layout. */
207 if (tui_win_with_focus () == TUI_DISASM_WIN
208 && tui_current_layout () != SRC_DISASSEM_COMMAND
)
209 tui_set_win_focus_to (this);
215 /* Function to ensure that the source and/or disassemly windows
216 reflect the input address. */
218 tui_update_source_windows_with_addr (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
222 struct symtab_and_line sal
;
223 struct tui_line_or_address l
;
225 switch (tui_current_layout ())
227 case DISASSEM_COMMAND
:
228 case DISASSEM_DATA_COMMAND
:
229 tui_show_disassem (gdbarch
, addr
);
231 case SRC_DISASSEM_COMMAND
:
232 tui_show_disassem_and_update_source (gdbarch
, addr
);
235 sal
= find_pc_line (addr
, 0);
237 l
.u
.line_no
= sal
.line
;
238 TUI_SRC_WIN
->show_symtab_source (gdbarch
, sal
.symtab
, l
);
244 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
245 win_info
->erase_source_content ();
249 /* Function to ensure that the source and/or disassemly windows
250 reflect the input address. */
252 tui_update_source_windows_with_line (struct symtab
*s
, int line
)
254 struct gdbarch
*gdbarch
;
256 struct tui_line_or_address l
;
261 gdbarch
= get_objfile_arch (SYMTAB_OBJFILE (s
));
263 switch (tui_current_layout ())
265 case DISASSEM_COMMAND
:
266 case DISASSEM_DATA_COMMAND
:
267 find_line_pc (s
, line
, &pc
);
268 tui_update_source_windows_with_addr (gdbarch
, pc
);
273 TUI_SRC_WIN
->show_symtab_source (gdbarch
, s
, l
);
274 if (tui_current_layout () == SRC_DISASSEM_COMMAND
)
276 find_line_pc (s
, line
, &pc
);
277 tui_show_disassem (gdbarch
, pc
);
284 tui_source_window_base::do_erase_source_content (const char *str
)
287 int half_width
= (width
- 2) / 2;
292 werase (handle
.get ());
293 check_and_display_highlight_if_needed ();
295 if (strlen (str
) >= half_width
)
298 x_pos
= half_width
- strlen (str
);
299 mvwaddstr (handle
.get (),
309 /* Redraw the complete line of a source or disassembly window. */
311 tui_show_source_line (struct tui_source_window_base
*win_info
, int lineno
)
313 struct tui_source_element
*line
;
316 line
= &win_info
->content
[lineno
- 1];
317 if (line
->is_exec_point
)
318 tui_set_reverse_mode (win_info
->handle
.get (), true);
320 wmove (win_info
->handle
.get (), lineno
, TUI_EXECINFO_SIZE
);
321 tui_puts (line
->line
.c_str (), win_info
->handle
.get ());
322 if (line
->is_exec_point
)
323 tui_set_reverse_mode (win_info
->handle
.get (), false);
325 /* Clear to end of line but stop before the border. */
326 x
= getcurx (win_info
->handle
.get ());
327 while (x
+ 1 < win_info
->width
)
329 waddch (win_info
->handle
.get (), ' ');
330 x
= getcurx (win_info
->handle
.get ());
335 tui_source_window_base::show_source_content ()
337 gdb_assert (!content
.empty ());
339 for (int lineno
= 1; lineno
<= content
.size (); lineno
++)
340 tui_show_source_line (this, lineno
);
342 check_and_display_highlight_if_needed ();
346 tui_source_window_base::tui_source_window_base (enum tui_win_type type
)
347 : tui_win_info (type
)
349 gdb_assert (type
== SRC_WIN
|| type
== DISASSEM_WIN
);
350 start_line_or_addr
.loa
= LOA_ADDRESS
;
351 start_line_or_addr
.u
.addr
= 0;
353 gdb::observers::source_styling_changed
.attach
354 (std::bind (&tui_source_window::style_changed
, this),
358 tui_source_window_base::~tui_source_window_base ()
360 gdb::observers::source_styling_changed
.detach (m_observable
);
363 /* See tui-data.h. */
366 tui_source_window_base::update_tab_width ()
368 werase (handle
.get ());
373 tui_source_window_base::rerender ()
375 if (!content
.empty ())
377 struct tui_line_or_address line_or_addr
;
378 struct symtab_and_line cursal
379 = get_current_source_symtab_and_line ();
381 line_or_addr
= start_line_or_addr
;
382 update_source_window (gdbarch
, cursal
.symtab
, line_or_addr
);
384 else if (deprecated_safe_get_selected_frame () != NULL
)
386 struct tui_line_or_address line
;
387 struct symtab_and_line cursal
388 = get_current_source_symtab_and_line ();
389 struct frame_info
*frame
= deprecated_safe_get_selected_frame ();
390 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
392 struct symtab
*s
= find_pc_line_symtab (get_frame_pc (frame
));
396 line
.u
.line_no
= cursal
.line
;
400 line
.loa
= LOA_ADDRESS
;
401 find_line_pc (s
, cursal
.line
, &line
.u
.addr
);
403 update_source_window (gdbarch
, s
, line
);
406 erase_source_content ();
409 /* See tui-data.h. */
412 tui_source_window_base::refill ()
418 symtab_and_line cursal
= get_current_source_symtab_and_line ();
419 s
= (cursal
.symtab
== NULL
420 ? find_pc_line_symtab (get_frame_pc (get_selected_frame (NULL
)))
424 update_source_window_as_is (gdbarch
, s
, content
[0].line_or_addr
);
427 /* Scroll the source forward or backward horizontally. */
430 tui_source_window_base::do_scroll_horizontal (int num_to_scroll
)
432 if (!content
.empty ())
434 int offset
= horizontal_offset
+ num_to_scroll
;
437 horizontal_offset
= offset
;
443 /* Set or clear the is_exec_point flag in the line whose line is
447 tui_source_window_base::set_is_exec_point_at (struct tui_line_or_address l
)
449 bool changed
= false;
453 while (i
< content
.size ())
456 struct tui_line_or_address content_loa
=
457 content
[i
].line_or_addr
;
459 gdb_assert (l
.loa
== LOA_ADDRESS
|| l
.loa
== LOA_LINE
);
460 gdb_assert (content_loa
.loa
== LOA_LINE
461 || content_loa
.loa
== LOA_ADDRESS
);
462 if (content_loa
.loa
== l
.loa
463 && ((l
.loa
== LOA_LINE
&& content_loa
.u
.line_no
== l
.u
.line_no
)
464 || (l
.loa
== LOA_ADDRESS
&& content_loa
.u
.addr
== l
.u
.addr
)))
468 if (new_state
!= content
[i
].is_exec_point
)
471 content
[i
].is_exec_point
= new_state
;
472 tui_show_source_line (this, i
+ 1);
480 /* See tui-winsource.h. */
483 tui_update_all_breakpoint_info (struct breakpoint
*being_deleted
)
485 for (tui_source_window_base
*win
: tui_source_windows ())
487 if (win
->update_breakpoint_info (being_deleted
, false))
488 win
->update_exec_info ();
493 /* Scan the source window and the breakpoints to update the break_mode
494 information for each line.
496 Returns true if something changed and the execution window must be
500 tui_source_window_base::update_breakpoint_info
501 (struct breakpoint
*being_deleted
, bool current_only
)
504 bool need_refresh
= false;
506 for (i
= 0; i
< content
.size (); i
++)
508 struct tui_source_element
*line
;
511 if (current_only
&& !line
->is_exec_point
)
514 /* Scan each breakpoint to see if the current line has something to
515 do with it. Identify enable/disabled breakpoints as well as
516 those that we already hit. */
517 tui_bp_flags mode
= 0;
518 iterate_over_breakpoints ([&] (breakpoint
*bp
) -> bool
520 struct bp_location
*loc
;
522 gdb_assert (line
->line_or_addr
.loa
== LOA_LINE
523 || line
->line_or_addr
.loa
== LOA_ADDRESS
);
525 if (bp
== being_deleted
)
528 for (loc
= bp
->loc
; loc
!= NULL
; loc
= loc
->next
)
530 if (location_matches_p (loc
, i
))
532 if (bp
->enable_state
== bp_disabled
)
533 mode
|= TUI_BP_DISABLED
;
535 mode
|= TUI_BP_ENABLED
;
539 mode
|= TUI_BP_CONDITIONAL
;
540 if (bp
->type
== bp_hardware_breakpoint
)
541 mode
|= TUI_BP_HARDWARE
;
546 if (line
->break_mode
!= mode
)
548 line
->break_mode
= mode
;
555 /* Function to initialize the content of the execution info window,
556 based upon the input window which is either the source or
557 disassembly window. */
559 tui_source_window_base::update_exec_info ()
561 update_breakpoint_info (nullptr, true);
562 for (int i
= 0; i
< content
.size (); i
++)
564 struct tui_source_element
*src_element
= &content
[i
];
565 char element
[TUI_EXECINFO_SIZE
] = " ";
567 /* Now update the exec info content based upon the state
568 of each line as indicated by the source content. */
569 tui_bp_flags mode
= src_element
->break_mode
;
570 if (mode
& TUI_BP_HIT
)
571 element
[TUI_BP_HIT_POS
] = (mode
& TUI_BP_HARDWARE
) ? 'H' : 'B';
572 else if (mode
& (TUI_BP_ENABLED
| TUI_BP_DISABLED
))
573 element
[TUI_BP_HIT_POS
] = (mode
& TUI_BP_HARDWARE
) ? 'h' : 'b';
575 if (mode
& TUI_BP_ENABLED
)
576 element
[TUI_BP_BREAK_POS
] = '+';
577 else if (mode
& TUI_BP_DISABLED
)
578 element
[TUI_BP_BREAK_POS
] = '-';
580 if (src_element
->is_exec_point
)
581 element
[TUI_EXEC_POS
] = '>';
583 mvwaddstr (handle
.get (), i
+ 1, 1, element
);