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
;
112 auto process_tab
= [&] ()
114 int max_tab_len
= tui_tab_width
;
117 for (int j
= column
% max_tab_len
;
118 j
< max_tab_len
&& column
< first_col
+ line_width
;
120 if (column
>= first_col
)
121 result
.push_back (' ');
124 /* We have to process all the text in order to pick up all the
126 if (column
<= first_col
|| column
> first_col
+ line_width
)
133 if (c
== '\n' || c
== '\r' || c
== '\0')
137 else if (c
< 040 && c
!= '\t')
139 result
.push_back ('^');
140 result
.push_back (c
+ 0100);
144 result
.push_back ('^');
145 result
.push_back ('?');
150 result
.push_back (c
);
152 while (c
!= '\0' && c
!= '\n' && c
!= '\r');
154 if (c
== '\r' && *lineptr
== '\n')
162 tui_source_window_base::style_changed ()
164 if (tui_active
&& is_visible ())
168 /* Function to display source in the source window. This function
169 initializes the horizontal scroll to 0. */
171 tui_source_window_base::update_source_window
172 (struct gdbarch
*gdbarch
,
174 struct tui_line_or_address line_or_addr
)
176 horizontal_offset
= 0;
177 update_source_window_as_is (gdbarch
, s
, line_or_addr
);
181 /* Function to display source in the source/asm window. This function
182 shows the source as specified by the horizontal offset. */
184 tui_source_window_base::update_source_window_as_is
185 (struct gdbarch
*gdbarch
,
187 struct tui_line_or_address line_or_addr
)
190 = set_contents (gdbarch
, s
, line_or_addr
);
192 if (ret
== TUI_FAILURE
)
193 erase_source_content ();
196 update_breakpoint_info (nullptr, false);
197 show_source_content ();
203 sal
.line
= line_or_addr
.u
.line_no
+ (content
.size () - 2);
205 sal
.pspace
= SYMTAB_PSPACE (s
);
206 set_current_source_symtab_and_line (sal
);
207 /* If the focus was in the asm win, put it in the src win if
208 we don't have a split layout. */
209 if (tui_win_with_focus () == TUI_DISASM_WIN
210 && tui_current_layout () != SRC_DISASSEM_COMMAND
)
211 tui_set_win_focus_to (this);
217 /* Function to ensure that the source and/or disassemly windows
218 reflect the input address. */
220 tui_update_source_windows_with_addr (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
224 struct symtab_and_line sal
;
225 struct tui_line_or_address l
;
227 switch (tui_current_layout ())
229 case DISASSEM_COMMAND
:
230 case DISASSEM_DATA_COMMAND
:
231 tui_show_disassem (gdbarch
, addr
);
233 case SRC_DISASSEM_COMMAND
:
234 tui_show_disassem_and_update_source (gdbarch
, addr
);
237 sal
= find_pc_line (addr
, 0);
239 l
.u
.line_no
= sal
.line
;
240 TUI_SRC_WIN
->show_symtab_source (gdbarch
, sal
.symtab
, l
);
246 for (struct tui_source_window_base
*win_info
: tui_source_windows ())
247 win_info
->erase_source_content ();
251 /* Function to ensure that the source and/or disassemly windows
252 reflect the input address. */
254 tui_update_source_windows_with_line (struct symtab
*s
, int line
)
256 struct gdbarch
*gdbarch
;
258 struct tui_line_or_address l
;
263 gdbarch
= get_objfile_arch (SYMTAB_OBJFILE (s
));
265 switch (tui_current_layout ())
267 case DISASSEM_COMMAND
:
268 case DISASSEM_DATA_COMMAND
:
269 find_line_pc (s
, line
, &pc
);
270 tui_update_source_windows_with_addr (gdbarch
, pc
);
275 TUI_SRC_WIN
->show_symtab_source (gdbarch
, s
, l
);
276 if (tui_current_layout () == SRC_DISASSEM_COMMAND
)
278 find_line_pc (s
, line
, &pc
);
279 tui_show_disassem (gdbarch
, pc
);
286 tui_source_window_base::do_erase_source_content (const char *str
)
289 int half_width
= (width
- 2) / 2;
294 werase (handle
.get ());
295 check_and_display_highlight_if_needed ();
297 if (strlen (str
) >= half_width
)
300 x_pos
= half_width
- strlen (str
);
301 mvwaddstr (handle
.get (),
311 /* Redraw the complete line of a source or disassembly window. */
313 tui_show_source_line (struct tui_source_window_base
*win_info
, int lineno
)
315 struct tui_source_element
*line
;
318 line
= &win_info
->content
[lineno
- 1];
319 if (line
->is_exec_point
)
320 tui_set_reverse_mode (win_info
->handle
.get (), true);
322 wmove (win_info
->handle
.get (), lineno
, TUI_EXECINFO_SIZE
);
323 tui_puts (line
->line
.c_str (), win_info
->handle
.get ());
324 if (line
->is_exec_point
)
325 tui_set_reverse_mode (win_info
->handle
.get (), false);
327 /* Clear to end of line but stop before the border. */
328 x
= getcurx (win_info
->handle
.get ());
329 while (x
+ 1 < win_info
->width
)
331 waddch (win_info
->handle
.get (), ' ');
332 x
= getcurx (win_info
->handle
.get ());
337 tui_source_window_base::show_source_content ()
339 gdb_assert (!content
.empty ());
341 for (int lineno
= 1; lineno
<= content
.size (); lineno
++)
342 tui_show_source_line (this, lineno
);
344 check_and_display_highlight_if_needed ();
348 tui_source_window_base::tui_source_window_base (enum tui_win_type type
)
349 : tui_win_info (type
)
351 gdb_assert (type
== SRC_WIN
|| type
== DISASSEM_WIN
);
352 start_line_or_addr
.loa
= LOA_ADDRESS
;
353 start_line_or_addr
.u
.addr
= 0;
355 gdb::observers::source_styling_changed
.attach
356 (std::bind (&tui_source_window::style_changed
, this),
360 tui_source_window_base::~tui_source_window_base ()
362 gdb::observers::source_styling_changed
.detach (m_observable
);
365 /* See tui-data.h. */
368 tui_source_window_base::update_tab_width ()
370 werase (handle
.get ());
375 tui_source_window_base::rerender ()
377 if (!content
.empty ())
379 struct tui_line_or_address line_or_addr
;
380 struct symtab_and_line cursal
381 = get_current_source_symtab_and_line ();
383 line_or_addr
= start_line_or_addr
;
384 update_source_window (gdbarch
, cursal
.symtab
, line_or_addr
);
386 else if (deprecated_safe_get_selected_frame () != NULL
)
388 struct tui_line_or_address line
;
389 struct symtab_and_line cursal
390 = get_current_source_symtab_and_line ();
391 struct frame_info
*frame
= deprecated_safe_get_selected_frame ();
392 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
394 struct symtab
*s
= find_pc_line_symtab (get_frame_pc (frame
));
398 line
.u
.line_no
= cursal
.line
;
402 line
.loa
= LOA_ADDRESS
;
403 find_line_pc (s
, cursal
.line
, &line
.u
.addr
);
405 update_source_window (gdbarch
, s
, line
);
408 erase_source_content ();
411 /* See tui-data.h. */
414 tui_source_window_base::refill ()
420 symtab_and_line cursal
= get_current_source_symtab_and_line ();
421 s
= (cursal
.symtab
== NULL
422 ? find_pc_line_symtab (get_frame_pc (get_selected_frame (NULL
)))
426 update_source_window_as_is (gdbarch
, s
, content
[0].line_or_addr
);
429 /* Scroll the source forward or backward horizontally. */
432 tui_source_window_base::do_scroll_horizontal (int num_to_scroll
)
434 if (!content
.empty ())
436 int offset
= horizontal_offset
+ num_to_scroll
;
439 horizontal_offset
= offset
;
445 /* Set or clear the is_exec_point flag in the line whose line is
449 tui_source_window_base::set_is_exec_point_at (struct tui_line_or_address l
)
451 bool changed
= false;
455 while (i
< content
.size ())
458 struct tui_line_or_address content_loa
=
459 content
[i
].line_or_addr
;
461 gdb_assert (l
.loa
== LOA_ADDRESS
|| l
.loa
== LOA_LINE
);
462 gdb_assert (content_loa
.loa
== LOA_LINE
463 || content_loa
.loa
== LOA_ADDRESS
);
464 if (content_loa
.loa
== l
.loa
465 && ((l
.loa
== LOA_LINE
&& content_loa
.u
.line_no
== l
.u
.line_no
)
466 || (l
.loa
== LOA_ADDRESS
&& content_loa
.u
.addr
== l
.u
.addr
)))
470 if (new_state
!= content
[i
].is_exec_point
)
473 content
[i
].is_exec_point
= new_state
;
474 tui_show_source_line (this, i
+ 1);
482 /* See tui-winsource.h. */
485 tui_update_all_breakpoint_info (struct breakpoint
*being_deleted
)
487 for (tui_source_window_base
*win
: tui_source_windows ())
489 if (win
->update_breakpoint_info (being_deleted
, false))
490 win
->update_exec_info ();
495 /* Scan the source window and the breakpoints to update the break_mode
496 information for each line.
498 Returns true if something changed and the execution window must be
502 tui_source_window_base::update_breakpoint_info
503 (struct breakpoint
*being_deleted
, bool current_only
)
506 bool need_refresh
= false;
508 for (i
= 0; i
< content
.size (); i
++)
510 struct tui_source_element
*line
;
513 if (current_only
&& !line
->is_exec_point
)
516 /* Scan each breakpoint to see if the current line has something to
517 do with it. Identify enable/disabled breakpoints as well as
518 those that we already hit. */
519 tui_bp_flags mode
= 0;
520 iterate_over_breakpoints ([&] (breakpoint
*bp
) -> bool
522 struct bp_location
*loc
;
524 gdb_assert (line
->line_or_addr
.loa
== LOA_LINE
525 || line
->line_or_addr
.loa
== LOA_ADDRESS
);
527 if (bp
== being_deleted
)
530 for (loc
= bp
->loc
; loc
!= NULL
; loc
= loc
->next
)
532 if (location_matches_p (loc
, i
))
534 if (bp
->enable_state
== bp_disabled
)
535 mode
|= TUI_BP_DISABLED
;
537 mode
|= TUI_BP_ENABLED
;
541 mode
|= TUI_BP_CONDITIONAL
;
542 if (bp
->type
== bp_hardware_breakpoint
)
543 mode
|= TUI_BP_HARDWARE
;
548 if (line
->break_mode
!= mode
)
550 line
->break_mode
= mode
;
557 /* Function to initialize the content of the execution info window,
558 based upon the input window which is either the source or
559 disassembly window. */
561 tui_source_window_base::update_exec_info ()
563 update_breakpoint_info (nullptr, true);
564 for (int i
= 0; i
< content
.size (); i
++)
566 struct tui_source_element
*src_element
= &content
[i
];
567 char element
[TUI_EXECINFO_SIZE
] = " ";
569 /* Now update the exec info content based upon the state
570 of each line as indicated by the source content. */
571 tui_bp_flags mode
= src_element
->break_mode
;
572 if (mode
& TUI_BP_HIT
)
573 element
[TUI_BP_HIT_POS
] = (mode
& TUI_BP_HARDWARE
) ? 'H' : 'B';
574 else if (mode
& (TUI_BP_ENABLED
| TUI_BP_DISABLED
))
575 element
[TUI_BP_HIT_POS
] = (mode
& TUI_BP_HARDWARE
) ? 'h' : 'b';
577 if (mode
& TUI_BP_ENABLED
)
578 element
[TUI_BP_BREAK_POS
] = '+';
579 else if (mode
& TUI_BP_DISABLED
)
580 element
[TUI_BP_BREAK_POS
] = '-';
582 if (src_element
->is_exec_point
)
583 element
[TUI_EXEC_POS
] = '>';
585 mvwaddstr (handle
.get (), i
+ 1, 1, element
);