1 /* TUI display source/assembly window.
3 Copyright (C) 1998-2020 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
);
60 tui_update_locator_fullname (s
);
65 /* See tui-winsource.h. */
68 tui_copy_source_line (const char **ptr
, int line_no
, int first_col
,
69 int line_width
, int ndigits
)
71 const char *lineptr
= *ptr
;
73 /* Init the line with the line number. */
79 result
= string_printf ("%*d ", ndigits
, line_no
);
82 result
= string_printf ("%-6d", line_no
);
83 int len
= result
.size ();
84 len
= len
- ((len
/ tui_tab_width
) * tui_tab_width
);
85 result
.append (len
, ' ');
96 if (c
== '\033' && skip_ansi_escape (lineptr
, &skip_bytes
))
98 /* We always have to preserve escapes. */
99 result
.append (lineptr
, lineptr
+ skip_bytes
);
100 lineptr
+= skip_bytes
;
109 auto process_tab
= [&] ()
111 int max_tab_len
= tui_tab_width
;
114 for (int j
= column
% max_tab_len
;
115 j
< max_tab_len
&& column
< first_col
+ line_width
;
117 if (column
>= first_col
)
118 result
.push_back (' ');
121 /* We have to process all the text in order to pick up all the
123 if (column
<= first_col
|| column
> first_col
+ line_width
)
130 if (c
== '\n' || c
== '\r' || c
== '\0')
134 else if (c
< 040 && c
!= '\t')
136 result
.push_back ('^');
137 result
.push_back (c
+ 0100);
141 result
.push_back ('^');
142 result
.push_back ('?');
147 result
.push_back (c
);
149 while (c
!= '\0' && c
!= '\n' && c
!= '\r');
151 if (c
== '\r' && *lineptr
== '\n')
159 tui_source_window_base::style_changed ()
161 if (tui_active
&& is_visible ())
165 /* Function to display source in the source window. This function
166 initializes the horizontal scroll to 0. */
168 tui_source_window_base::update_source_window
169 (struct gdbarch
*gdbarch
,
170 const struct symtab_and_line
&sal
)
172 horizontal_offset
= 0;
173 update_source_window_as_is (gdbarch
, sal
);
177 /* Function to display source in the source/asm window. This function
178 shows the source as specified by the horizontal offset. */
180 tui_source_window_base::update_source_window_as_is
181 (struct gdbarch
*gdbarch
,
182 const struct symtab_and_line
&sal
)
184 bool ret
= set_contents (gdbarch
, sal
);
187 erase_source_content ();
190 update_breakpoint_info (nullptr, false);
191 show_source_content ();
197 /* Function to ensure that the source and/or disassemly windows
198 reflect the input address. */
200 tui_update_source_windows_with_addr (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
202 struct symtab_and_line sal
{};
204 sal
= find_pc_line (addr
, 0);
206 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
207 win_info
->update_source_window (gdbarch
, sal
);
210 /* Function to ensure that the source and/or disassembly windows
211 reflect the symtab and line. */
213 tui_update_source_windows_with_line (struct symtab_and_line sal
)
218 find_line_pc (sal
.symtab
, sal
.line
, &sal
.pc
);
219 struct gdbarch
*gdbarch
= get_objfile_arch (SYMTAB_OBJFILE (sal
.symtab
));
221 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
222 win_info
->update_source_window (gdbarch
, sal
);
226 tui_source_window_base::do_erase_source_content (const char *str
)
229 int half_width
= (width
- 2) / 2;
234 werase (handle
.get ());
235 check_and_display_highlight_if_needed ();
237 if (strlen (str
) >= half_width
)
240 x_pos
= half_width
- strlen (str
);
241 mvwaddstr (handle
.get (),
251 /* Redraw the complete line of a source or disassembly window. */
253 tui_show_source_line (struct tui_source_window_base
*win_info
, int lineno
)
255 struct tui_source_element
*line
;
258 line
= &win_info
->content
[lineno
- 1];
259 if (line
->is_exec_point
)
260 tui_set_reverse_mode (win_info
->handle
.get (), true);
262 wmove (win_info
->handle
.get (), lineno
, TUI_EXECINFO_SIZE
);
263 tui_puts (line
->line
.c_str (), win_info
->handle
.get ());
264 if (line
->is_exec_point
)
265 tui_set_reverse_mode (win_info
->handle
.get (), false);
267 /* Clear to end of line but stop before the border. */
268 x
= getcurx (win_info
->handle
.get ());
269 while (x
+ 1 < win_info
->width
)
271 waddch (win_info
->handle
.get (), ' ');
272 x
= getcurx (win_info
->handle
.get ());
277 tui_source_window_base::show_source_content ()
279 gdb_assert (!content
.empty ());
281 for (int lineno
= 1; lineno
<= content
.size (); lineno
++)
282 tui_show_source_line (this, lineno
);
284 check_and_display_highlight_if_needed ();
288 tui_source_window_base::tui_source_window_base (enum tui_win_type type
)
289 : tui_win_info (type
)
291 gdb_assert (type
== SRC_WIN
|| type
== DISASSEM_WIN
);
292 start_line_or_addr
.loa
= LOA_ADDRESS
;
293 start_line_or_addr
.u
.addr
= 0;
295 gdb::observers::source_styling_changed
.attach
296 (std::bind (&tui_source_window::style_changed
, this),
300 tui_source_window_base::~tui_source_window_base ()
302 gdb::observers::source_styling_changed
.detach (m_observable
);
305 /* See tui-data.h. */
308 tui_source_window_base::update_tab_width ()
310 werase (handle
.get ());
315 tui_source_window_base::rerender ()
317 if (!content
.empty ())
319 struct symtab_and_line cursal
320 = get_current_source_symtab_and_line ();
322 if (start_line_or_addr
.loa
== LOA_LINE
)
323 cursal
.line
= start_line_or_addr
.u
.line_no
;
325 cursal
.pc
= start_line_or_addr
.u
.addr
;
326 update_source_window (gdbarch
, cursal
);
328 else if (deprecated_safe_get_selected_frame () != NULL
)
330 struct symtab_and_line cursal
331 = get_current_source_symtab_and_line ();
332 struct frame_info
*frame
= deprecated_safe_get_selected_frame ();
333 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
335 struct symtab
*s
= find_pc_line_symtab (get_frame_pc (frame
));
337 find_line_pc (s
, cursal
.line
, &cursal
.pc
);
338 update_source_window (gdbarch
, cursal
);
341 erase_source_content ();
344 /* See tui-data.h. */
347 tui_source_window_base::refill ()
349 symtab_and_line sal
{};
353 sal
= get_current_source_symtab_and_line ();
354 if (sal
.symtab
== NULL
)
356 struct frame_info
*fi
= deprecated_safe_get_selected_frame ();
358 sal
= find_pc_line (get_frame_pc (fi
), 0);
362 if (sal
.pspace
== nullptr)
363 sal
.pspace
= current_program_space
;
365 if (start_line_or_addr
.loa
== LOA_LINE
)
366 sal
.line
= start_line_or_addr
.u
.line_no
;
368 sal
.pc
= start_line_or_addr
.u
.addr
;
370 update_source_window_as_is (gdbarch
, sal
);
373 /* Scroll the source forward or backward horizontally. */
376 tui_source_window_base::do_scroll_horizontal (int num_to_scroll
)
378 if (!content
.empty ())
380 int offset
= horizontal_offset
+ num_to_scroll
;
383 horizontal_offset
= offset
;
389 /* Set or clear the is_exec_point flag in the line whose line is
393 tui_source_window_base::set_is_exec_point_at (struct tui_line_or_address l
)
395 bool changed
= false;
399 while (i
< content
.size ())
402 struct tui_line_or_address content_loa
=
403 content
[i
].line_or_addr
;
405 if (content_loa
.loa
== l
.loa
406 && ((l
.loa
== LOA_LINE
&& content_loa
.u
.line_no
== l
.u
.line_no
)
407 || (l
.loa
== LOA_ADDRESS
&& content_loa
.u
.addr
== l
.u
.addr
)))
411 if (new_state
!= content
[i
].is_exec_point
)
414 content
[i
].is_exec_point
= new_state
;
415 tui_show_source_line (this, i
+ 1);
423 /* See tui-winsource.h. */
426 tui_update_all_breakpoint_info (struct breakpoint
*being_deleted
)
428 for (tui_source_window_base
*win
: tui_source_windows ())
430 if (win
->update_breakpoint_info (being_deleted
, false))
431 win
->update_exec_info ();
436 /* Scan the source window and the breakpoints to update the break_mode
437 information for each line.
439 Returns true if something changed and the execution window must be
443 tui_source_window_base::update_breakpoint_info
444 (struct breakpoint
*being_deleted
, bool current_only
)
447 bool need_refresh
= false;
449 for (i
= 0; i
< content
.size (); i
++)
451 struct tui_source_element
*line
;
454 if (current_only
&& !line
->is_exec_point
)
457 /* Scan each breakpoint to see if the current line has something to
458 do with it. Identify enable/disabled breakpoints as well as
459 those that we already hit. */
460 tui_bp_flags mode
= 0;
461 iterate_over_breakpoints ([&] (breakpoint
*bp
) -> bool
463 struct bp_location
*loc
;
465 if (bp
== being_deleted
)
468 for (loc
= bp
->loc
; loc
!= NULL
; loc
= loc
->next
)
470 if (location_matches_p (loc
, i
))
472 if (bp
->enable_state
== bp_disabled
)
473 mode
|= TUI_BP_DISABLED
;
475 mode
|= TUI_BP_ENABLED
;
479 mode
|= TUI_BP_CONDITIONAL
;
480 if (bp
->type
== bp_hardware_breakpoint
)
481 mode
|= TUI_BP_HARDWARE
;
486 if (line
->break_mode
!= mode
)
488 line
->break_mode
= mode
;
495 /* Function to initialize the content of the execution info window,
496 based upon the input window which is either the source or
497 disassembly window. */
499 tui_source_window_base::update_exec_info ()
501 update_breakpoint_info (nullptr, true);
502 for (int i
= 0; i
< content
.size (); i
++)
504 struct tui_source_element
*src_element
= &content
[i
];
505 char element
[TUI_EXECINFO_SIZE
] = " ";
507 /* Now update the exec info content based upon the state
508 of each line as indicated by the source content. */
509 tui_bp_flags mode
= src_element
->break_mode
;
510 if (mode
& TUI_BP_HIT
)
511 element
[TUI_BP_HIT_POS
] = (mode
& TUI_BP_HARDWARE
) ? 'H' : 'B';
512 else if (mode
& (TUI_BP_ENABLED
| TUI_BP_DISABLED
))
513 element
[TUI_BP_HIT_POS
] = (mode
& TUI_BP_HARDWARE
) ? 'h' : 'b';
515 if (mode
& TUI_BP_ENABLED
)
516 element
[TUI_BP_BREAK_POS
] = '+';
517 else if (mode
& TUI_BP_DISABLED
)
518 element
[TUI_BP_BREAK_POS
] = '-';
520 if (src_element
->is_exec_point
)
521 element
[TUI_EXEC_POS
] = '>';
523 mvwaddstr (handle
.get (), i
+ 1, 1, element
);