1 /* TUI display source/assembly window.
3 Copyright (C) 1998-2021 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"
31 #include "safe-ctype.h"
34 #include "tui/tui-data.h"
35 #include "tui/tui-io.h"
36 #include "tui/tui-stack.h"
37 #include "tui/tui-win.h"
38 #include "tui/tui-wingeneral.h"
39 #include "tui/tui-winsource.h"
40 #include "tui/tui-source.h"
41 #include "tui/tui-disasm.h"
42 #include "tui/tui-location.h"
43 #include "gdb_curses.h"
45 /* Function to display the "main" routine. */
49 auto adapter
= tui_source_windows ();
50 if (adapter
.begin () != adapter
.end ())
52 struct gdbarch
*gdbarch
;
55 tui_get_begin_asm_address (&gdbarch
, &addr
);
56 if (addr
!= (CORE_ADDR
) 0)
60 tui_update_source_windows_with_addr (gdbarch
, addr
);
61 s
= find_pc_line_symtab (addr
);
62 tui_location
.set_location (s
);
67 /* See tui-winsource.h. */
70 tui_copy_source_line (const char **ptr
, int *length
)
72 const char *lineptr
= *ptr
;
74 /* Init the line with the line number. */
84 if (c
== '\033' && skip_ansi_escape (lineptr
, &skip_bytes
))
86 /* We always have to preserve escapes. */
87 result
.append (lineptr
, lineptr
+ skip_bytes
);
88 lineptr
+= skip_bytes
;
97 auto process_tab
= [&] ()
99 int max_tab_len
= tui_tab_width
;
102 for (int j
= column
% max_tab_len
;
105 result
.push_back (' ');
108 if (c
== '\n' || c
== '\r' || c
== '\0')
114 else if (ISCNTRL (c
))
116 result
.push_back ('^');
117 result
.push_back (c
+ 0100);
122 result
.push_back ('^');
123 result
.push_back ('?');
127 result
.push_back (c
);
129 while (c
!= '\0' && c
!= '\n' && c
!= '\r');
131 if (c
== '\r' && *lineptr
== '\n')
135 if (length
!= nullptr)
142 tui_source_window_base::style_changed ()
144 if (tui_active
&& is_visible ())
148 /* Function to display source in the source window. This function
149 initializes the horizontal scroll to 0. */
151 tui_source_window_base::update_source_window
152 (struct gdbarch
*gdbarch
,
153 const struct symtab_and_line
&sal
)
155 m_horizontal_offset
= 0;
156 update_source_window_as_is (gdbarch
, sal
);
160 /* Function to display source in the source/asm window. This function
161 shows the source as specified by the horizontal offset. */
163 tui_source_window_base::update_source_window_as_is
164 (struct gdbarch
*gdbarch
,
165 const struct symtab_and_line
&sal
)
167 bool ret
= set_contents (gdbarch
, sal
);
170 erase_source_content ();
173 update_breakpoint_info (nullptr, false);
174 show_source_content ();
180 /* Function to ensure that the source and/or disassemly windows
181 reflect the input address. */
183 tui_update_source_windows_with_addr (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
185 struct symtab_and_line sal
{};
187 sal
= find_pc_line (addr
, 0);
189 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
190 win_info
->update_source_window (gdbarch
, sal
);
193 /* Function to ensure that the source and/or disassembly windows
194 reflect the symtab and line. */
196 tui_update_source_windows_with_line (struct symtab_and_line sal
)
198 struct gdbarch
*gdbarch
= nullptr;
199 if (sal
.symtab
!= nullptr)
201 find_line_pc (sal
.symtab
, sal
.line
, &sal
.pc
);
202 gdbarch
= SYMTAB_OBJFILE (sal
.symtab
)->arch ();
205 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
206 win_info
->update_source_window (gdbarch
, sal
);
210 tui_source_window_base::do_erase_source_content (const char *str
)
213 int half_width
= (width
- 2) / 2;
218 werase (handle
.get ());
219 check_and_display_highlight_if_needed ();
221 if (strlen (str
) >= half_width
)
224 x_pos
= half_width
- strlen (str
);
225 mvwaddstr (handle
.get (),
235 /* Redraw the complete line of a source or disassembly window. */
237 tui_source_window_base::show_source_line (int lineno
)
239 struct tui_source_element
*line
;
241 line
= &m_content
[lineno
];
242 if (line
->is_exec_point
)
243 tui_set_reverse_mode (m_pad
.get (), true);
245 wmove (m_pad
.get (), lineno
, 0);
246 tui_puts (line
->line
.c_str (), m_pad
.get ());
247 if (line
->is_exec_point
)
248 tui_set_reverse_mode (m_pad
.get (), false);
251 /* See tui-winsource.h. */
254 tui_source_window_base::refresh_window ()
256 /* tui_win_info::refresh_window would draw the empty background window to
257 the screen, potentially creating a flicker. */
258 wnoutrefresh (handle
.get ());
260 int pad_width
= std::max (m_max_length
, width
);
261 int left_margin
= 1 + TUI_EXECINFO_SIZE
+ extra_margin ();
262 int view_width
= width
- left_margin
- 1;
263 int pad_x
= std::min (pad_width
- view_width
, m_horizontal_offset
);
264 /* Ensure that an equal number of scrolls will work if the user
265 scrolled beyond where we clip. */
266 m_horizontal_offset
= pad_x
;
267 prefresh (m_pad
.get (), 0, pad_x
, y
+ 1, x
+ left_margin
,
268 y
+ m_content
.size (), x
+ left_margin
+ view_width
- 1);
272 tui_source_window_base::show_source_content ()
274 gdb_assert (!m_content
.empty ());
276 check_and_display_highlight_if_needed ();
278 int pad_width
= std::max (m_max_length
, width
);
279 if (m_pad
== nullptr || pad_width
> getmaxx (m_pad
.get ())
280 || m_content
.size () > getmaxy (m_pad
.get ()))
281 m_pad
.reset (newpad (m_content
.size (), pad_width
));
283 werase (m_pad
.get ());
284 for (int lineno
= 0; lineno
< m_content
.size (); lineno
++)
285 show_source_line (lineno
);
290 tui_source_window_base::tui_source_window_base ()
292 m_start_line_or_addr
.loa
= LOA_ADDRESS
;
293 m_start_line_or_addr
.u
.addr
= 0;
295 gdb::observers::source_styling_changed
.attach
296 (std::bind (&tui_source_window::style_changed
, this),
297 m_observable
, "tui-winsource");
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 (!m_content
.empty ())
319 struct symtab_and_line cursal
320 = get_current_source_symtab_and_line ();
322 if (m_start_line_or_addr
.loa
== LOA_LINE
)
323 cursal
.line
= m_start_line_or_addr
.u
.line_no
;
325 cursal
.pc
= m_start_line_or_addr
.u
.addr
;
326 update_source_window (m_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
));
336 if (this != TUI_SRC_WIN
)
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
{};
351 if (this == TUI_SRC_WIN
)
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 (m_start_line_or_addr
.loa
== LOA_LINE
)
366 sal
.line
= m_start_line_or_addr
.u
.line_no
;
368 sal
.pc
= m_start_line_or_addr
.u
.addr
;
370 update_source_window_as_is (m_gdbarch
, sal
);
373 /* Scroll the source forward or backward horizontally. */
376 tui_source_window_base::do_scroll_horizontal (int num_to_scroll
)
378 if (!m_content
.empty ())
380 int offset
= m_horizontal_offset
+ num_to_scroll
;
383 m_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
< m_content
.size ())
402 struct tui_line_or_address content_loa
=
403 m_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
!= m_content
[i
].is_exec_point
)
414 m_content
[i
].is_exec_point
= new_state
;
422 /* See tui-winsource.h. */
425 tui_update_all_breakpoint_info (struct breakpoint
*being_deleted
)
427 for (tui_source_window_base
*win
: tui_source_windows ())
429 if (win
->update_breakpoint_info (being_deleted
, false))
430 win
->update_exec_info ();
435 /* Scan the source window and the breakpoints to update the break_mode
436 information for each line.
438 Returns true if something changed and the execution window must be
442 tui_source_window_base::update_breakpoint_info
443 (struct breakpoint
*being_deleted
, bool current_only
)
446 bool need_refresh
= false;
448 for (i
= 0; i
< m_content
.size (); i
++)
450 struct tui_source_element
*line
;
452 line
= &m_content
[i
];
453 if (current_only
&& !line
->is_exec_point
)
456 /* Scan each breakpoint to see if the current line has something to
457 do with it. Identify enable/disabled breakpoints as well as
458 those that we already hit. */
459 tui_bp_flags mode
= 0;
460 iterate_over_breakpoints ([&] (breakpoint
*bp
) -> bool
462 struct bp_location
*loc
;
464 if (bp
== being_deleted
)
467 for (loc
= bp
->loc
; loc
!= NULL
; loc
= loc
->next
)
469 if (location_matches_p (loc
, i
))
471 if (bp
->enable_state
== bp_disabled
)
472 mode
|= TUI_BP_DISABLED
;
474 mode
|= TUI_BP_ENABLED
;
478 mode
|= TUI_BP_CONDITIONAL
;
479 if (bp
->type
== bp_hardware_breakpoint
)
480 mode
|= TUI_BP_HARDWARE
;
485 if (line
->break_mode
!= mode
)
487 line
->break_mode
= mode
;
494 /* Function to initialize the content of the execution info window,
495 based upon the input window which is either the source or
496 disassembly window. */
498 tui_source_window_base::update_exec_info ()
500 update_breakpoint_info (nullptr, true);
501 for (int i
= 0; i
< m_content
.size (); i
++)
503 struct tui_source_element
*src_element
= &m_content
[i
];
504 char element
[TUI_EXECINFO_SIZE
] = " ";
506 /* Now update the exec info content based upon the state
507 of each line as indicated by the source content. */
508 tui_bp_flags mode
= src_element
->break_mode
;
509 if (mode
& TUI_BP_HIT
)
510 element
[TUI_BP_HIT_POS
] = (mode
& TUI_BP_HARDWARE
) ? 'H' : 'B';
511 else if (mode
& (TUI_BP_ENABLED
| TUI_BP_DISABLED
))
512 element
[TUI_BP_HIT_POS
] = (mode
& TUI_BP_HARDWARE
) ? 'h' : 'b';
514 if (mode
& TUI_BP_ENABLED
)
515 element
[TUI_BP_BREAK_POS
] = '+';
516 else if (mode
& TUI_BP_DISABLED
)
517 element
[TUI_BP_BREAK_POS
] = '-';
519 if (src_element
->is_exec_point
)
520 element
[TUI_EXEC_POS
] = '>';
522 mvwaddstr (handle
.get (), i
+ 1, 1, element
);
524 show_line_number (i
);