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 "gdb_curses.h"
44 /* Function to display the "main" routine. */
48 auto adapter
= tui_source_windows ();
49 if (adapter
.begin () != adapter
.end ())
51 struct gdbarch
*gdbarch
;
54 tui_get_begin_asm_address (&gdbarch
, &addr
);
55 if (addr
!= (CORE_ADDR
) 0)
59 tui_update_source_windows_with_addr (gdbarch
, addr
);
60 s
= find_pc_line_symtab (addr
);
61 tui_update_locator_fullname (s
);
66 /* See tui-winsource.h. */
69 tui_copy_source_line (const char **ptr
, int *length
)
71 const char *lineptr
= *ptr
;
73 /* Init the line with the line number. */
83 if (c
== '\033' && skip_ansi_escape (lineptr
, &skip_bytes
))
85 /* We always have to preserve escapes. */
86 result
.append (lineptr
, lineptr
+ skip_bytes
);
87 lineptr
+= skip_bytes
;
96 auto process_tab
= [&] ()
98 int max_tab_len
= tui_tab_width
;
101 for (int j
= column
% max_tab_len
;
104 result
.push_back (' ');
107 if (c
== '\n' || c
== '\r' || c
== '\0')
113 else if (ISCNTRL (c
))
115 result
.push_back ('^');
116 result
.push_back (c
+ 0100);
121 result
.push_back ('^');
122 result
.push_back ('?');
126 result
.push_back (c
);
128 while (c
!= '\0' && c
!= '\n' && c
!= '\r');
130 if (c
== '\r' && *lineptr
== '\n')
134 if (length
!= nullptr)
141 tui_source_window_base::style_changed ()
143 if (tui_active
&& is_visible ())
147 /* Function to display source in the source window. This function
148 initializes the horizontal scroll to 0. */
150 tui_source_window_base::update_source_window
151 (struct gdbarch
*gdbarch
,
152 const struct symtab_and_line
&sal
)
154 m_horizontal_offset
= 0;
155 update_source_window_as_is (gdbarch
, sal
);
159 /* Function to display source in the source/asm window. This function
160 shows the source as specified by the horizontal offset. */
162 tui_source_window_base::update_source_window_as_is
163 (struct gdbarch
*gdbarch
,
164 const struct symtab_and_line
&sal
)
166 bool ret
= set_contents (gdbarch
, sal
);
169 erase_source_content ();
172 update_breakpoint_info (nullptr, false);
173 show_source_content ();
179 /* Function to ensure that the source and/or disassemly windows
180 reflect the input address. */
182 tui_update_source_windows_with_addr (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
184 struct symtab_and_line sal
{};
186 sal
= find_pc_line (addr
, 0);
188 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
189 win_info
->update_source_window (gdbarch
, sal
);
192 /* Function to ensure that the source and/or disassembly windows
193 reflect the symtab and line. */
195 tui_update_source_windows_with_line (struct symtab_and_line sal
)
197 struct gdbarch
*gdbarch
= nullptr;
198 if (sal
.symtab
!= nullptr)
200 find_line_pc (sal
.symtab
, sal
.line
, &sal
.pc
);
201 gdbarch
= SYMTAB_OBJFILE (sal
.symtab
)->arch ();
204 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
205 win_info
->update_source_window (gdbarch
, sal
);
209 tui_source_window_base::do_erase_source_content (const char *str
)
212 int half_width
= (width
- 2) / 2;
217 werase (handle
.get ());
218 check_and_display_highlight_if_needed ();
220 if (strlen (str
) >= half_width
)
223 x_pos
= half_width
- strlen (str
);
224 mvwaddstr (handle
.get (),
234 /* Redraw the complete line of a source or disassembly window. */
236 tui_source_window_base::show_source_line (int lineno
)
238 struct tui_source_element
*line
;
240 line
= &m_content
[lineno
];
241 if (line
->is_exec_point
)
242 tui_set_reverse_mode (m_pad
.get (), true);
244 wmove (m_pad
.get (), lineno
, 0);
245 tui_puts (line
->line
.c_str (), m_pad
.get ());
246 if (line
->is_exec_point
)
247 tui_set_reverse_mode (m_pad
.get (), false);
250 /* See tui-winsource.h. */
253 tui_source_window_base::refresh_window ()
255 tui_win_info::refresh_window ();
257 int pad_width
= std::max (m_max_length
, width
);
258 int left_margin
= 1 + TUI_EXECINFO_SIZE
+ extra_margin ();
259 int view_width
= width
- left_margin
- 1;
260 int pad_x
= std::min (pad_width
- view_width
, m_horizontal_offset
);
261 /* Ensure that an equal number of scrolls will work if the user
262 scrolled beyond where we clip. */
263 m_horizontal_offset
= pad_x
;
264 prefresh (m_pad
.get (), 0, pad_x
, y
+ 1, x
+ left_margin
,
265 y
+ m_content
.size (), x
+ left_margin
+ view_width
- 1);
269 tui_source_window_base::show_source_content ()
271 gdb_assert (!m_content
.empty ());
273 check_and_display_highlight_if_needed ();
275 int pad_width
= std::max (m_max_length
, width
);
276 if (m_pad
== nullptr || pad_width
> getmaxx (m_pad
.get ())
277 || m_content
.size () > getmaxy (m_pad
.get ()))
278 m_pad
.reset (newpad (m_content
.size (), pad_width
));
280 werase (m_pad
.get ());
281 for (int lineno
= 0; lineno
< m_content
.size (); lineno
++)
282 show_source_line (lineno
);
287 tui_source_window_base::tui_source_window_base ()
289 m_start_line_or_addr
.loa
= LOA_ADDRESS
;
290 m_start_line_or_addr
.u
.addr
= 0;
292 gdb::observers::source_styling_changed
.attach
293 (std::bind (&tui_source_window::style_changed
, this),
297 tui_source_window_base::~tui_source_window_base ()
299 gdb::observers::source_styling_changed
.detach (m_observable
);
302 /* See tui-data.h. */
305 tui_source_window_base::update_tab_width ()
307 werase (handle
.get ());
312 tui_source_window_base::rerender ()
314 if (!m_content
.empty ())
316 struct symtab_and_line cursal
317 = get_current_source_symtab_and_line ();
319 if (m_start_line_or_addr
.loa
== LOA_LINE
)
320 cursal
.line
= m_start_line_or_addr
.u
.line_no
;
322 cursal
.pc
= m_start_line_or_addr
.u
.addr
;
323 update_source_window (m_gdbarch
, cursal
);
325 else if (deprecated_safe_get_selected_frame () != NULL
)
327 struct symtab_and_line cursal
328 = get_current_source_symtab_and_line ();
329 struct frame_info
*frame
= deprecated_safe_get_selected_frame ();
330 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
332 struct symtab
*s
= find_pc_line_symtab (get_frame_pc (frame
));
333 if (this != TUI_SRC_WIN
)
334 find_line_pc (s
, cursal
.line
, &cursal
.pc
);
335 update_source_window (gdbarch
, cursal
);
338 erase_source_content ();
341 /* See tui-data.h. */
344 tui_source_window_base::refill ()
346 symtab_and_line sal
{};
348 if (this == TUI_SRC_WIN
)
350 sal
= get_current_source_symtab_and_line ();
351 if (sal
.symtab
== NULL
)
353 struct frame_info
*fi
= deprecated_safe_get_selected_frame ();
355 sal
= find_pc_line (get_frame_pc (fi
), 0);
359 if (sal
.pspace
== nullptr)
360 sal
.pspace
= current_program_space
;
362 if (m_start_line_or_addr
.loa
== LOA_LINE
)
363 sal
.line
= m_start_line_or_addr
.u
.line_no
;
365 sal
.pc
= m_start_line_or_addr
.u
.addr
;
367 update_source_window_as_is (m_gdbarch
, sal
);
370 /* Scroll the source forward or backward horizontally. */
373 tui_source_window_base::do_scroll_horizontal (int num_to_scroll
)
375 if (!m_content
.empty ())
377 int offset
= m_horizontal_offset
+ num_to_scroll
;
380 m_horizontal_offset
= offset
;
386 /* Set or clear the is_exec_point flag in the line whose line is
390 tui_source_window_base::set_is_exec_point_at (struct tui_line_or_address l
)
392 bool changed
= false;
396 while (i
< m_content
.size ())
399 struct tui_line_or_address content_loa
=
400 m_content
[i
].line_or_addr
;
402 if (content_loa
.loa
== l
.loa
403 && ((l
.loa
== LOA_LINE
&& content_loa
.u
.line_no
== l
.u
.line_no
)
404 || (l
.loa
== LOA_ADDRESS
&& content_loa
.u
.addr
== l
.u
.addr
)))
408 if (new_state
!= m_content
[i
].is_exec_point
)
411 m_content
[i
].is_exec_point
= new_state
;
419 /* See tui-winsource.h. */
422 tui_update_all_breakpoint_info (struct breakpoint
*being_deleted
)
424 for (tui_source_window_base
*win
: tui_source_windows ())
426 if (win
->update_breakpoint_info (being_deleted
, false))
427 win
->update_exec_info ();
432 /* Scan the source window and the breakpoints to update the break_mode
433 information for each line.
435 Returns true if something changed and the execution window must be
439 tui_source_window_base::update_breakpoint_info
440 (struct breakpoint
*being_deleted
, bool current_only
)
443 bool need_refresh
= false;
445 for (i
= 0; i
< m_content
.size (); i
++)
447 struct tui_source_element
*line
;
449 line
= &m_content
[i
];
450 if (current_only
&& !line
->is_exec_point
)
453 /* Scan each breakpoint to see if the current line has something to
454 do with it. Identify enable/disabled breakpoints as well as
455 those that we already hit. */
456 tui_bp_flags mode
= 0;
457 iterate_over_breakpoints ([&] (breakpoint
*bp
) -> bool
459 struct bp_location
*loc
;
461 if (bp
== being_deleted
)
464 for (loc
= bp
->loc
; loc
!= NULL
; loc
= loc
->next
)
466 if (location_matches_p (loc
, i
))
468 if (bp
->enable_state
== bp_disabled
)
469 mode
|= TUI_BP_DISABLED
;
471 mode
|= TUI_BP_ENABLED
;
475 mode
|= TUI_BP_CONDITIONAL
;
476 if (bp
->type
== bp_hardware_breakpoint
)
477 mode
|= TUI_BP_HARDWARE
;
482 if (line
->break_mode
!= mode
)
484 line
->break_mode
= mode
;
491 /* Function to initialize the content of the execution info window,
492 based upon the input window which is either the source or
493 disassembly window. */
495 tui_source_window_base::update_exec_info ()
497 update_breakpoint_info (nullptr, true);
498 for (int i
= 0; i
< m_content
.size (); i
++)
500 struct tui_source_element
*src_element
= &m_content
[i
];
501 char element
[TUI_EXECINFO_SIZE
] = " ";
503 /* Now update the exec info content based upon the state
504 of each line as indicated by the source content. */
505 tui_bp_flags mode
= src_element
->break_mode
;
506 if (mode
& TUI_BP_HIT
)
507 element
[TUI_BP_HIT_POS
] = (mode
& TUI_BP_HARDWARE
) ? 'H' : 'B';
508 else if (mode
& (TUI_BP_ENABLED
| TUI_BP_DISABLED
))
509 element
[TUI_BP_HIT_POS
] = (mode
& TUI_BP_HARDWARE
) ? 'h' : 'b';
511 if (mode
& TUI_BP_ENABLED
)
512 element
[TUI_BP_BREAK_POS
] = '+';
513 else if (mode
& TUI_BP_DISABLED
)
514 element
[TUI_BP_BREAK_POS
] = '-';
516 if (src_element
->is_exec_point
)
517 element
[TUI_EXEC_POS
] = '>';
519 mvwaddstr (handle
.get (), i
+ 1, 1, element
);
521 show_line_number (i
);