gdb/tui/tui-winsource.c

   1 /* TUI display source/assembly window.
   2
   3    Copyright (C) 1998-2019 Free Software Foundation, Inc.
   4
   5    Contributed by Hewlett-Packard Company.
   6
   7    This file is part of GDB.
   8
   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.
  13
  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.
  18
  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/>.  */
  21
  22 #include "defs.h"
  23 #include <ctype.h>
  24 #include "symtab.h"
  25 #include "frame.h"
  26 #include "breakpoint.h"
  27 #include "value.h"
  28 #include "source.h"
  29 #include "objfiles.h"
  30 #include "filenames.h"
  31
  32 #include "tui/tui.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"
  42
  43 /* Function to display the "main" routine.  */
  44 void
  45 tui_display_main ()
  46 {
  47   auto adapter = tui_source_windows ();
  48   if (adapter.begin () != adapter.end ())
  49     {
  50       struct gdbarch *gdbarch;
  51       CORE_ADDR addr;
  52
  53       tui_get_begin_asm_address (&gdbarch, &addr);
  54       if (addr != (CORE_ADDR) 0)
  55         {
  56           struct symtab *s;
  57
  58           tui_update_source_windows_with_addr (gdbarch, addr);
  59           s = find_pc_line_symtab (addr);
  60           if (s != NULL)
  61              tui_update_locator_fullname (symtab_to_fullname (s));
  62           else
  63              tui_update_locator_fullname ("??");
  64         }
  65     }
  66 }
  67
  68
  69
  70 /* Function to display source in the source window.  This function
  71    initializes the horizontal scroll to 0.  */
  72 void
  73 tui_source_window_base::update_source_window
  74   (struct gdbarch *gdbarch,
  75    struct symtab *s,
  76    struct tui_line_or_address line_or_addr)
  77 {
  78   horizontal_offset = 0;
  79   update_source_window_as_is (gdbarch, s, line_or_addr);
  80 }
  81
  82
  83 /* Function to display source in the source/asm window.  This function
  84    shows the source as specified by the horizontal offset.  */
  85 void
  86 tui_source_window_base::update_source_window_as_is
  87   (struct gdbarch *gdbarch,
  88    struct symtab *s,
  89    struct tui_line_or_address line_or_addr)
  90 {
  91   enum tui_status ret
  92     = set_contents (gdbarch, s, line_or_addr);
  93
  94   if (ret == TUI_FAILURE)
  95     erase_source_content ();
  96   else
  97     {
  98       update_breakpoint_info (nullptr, false);
  99       show_source_content ();
 100       update_exec_info ();
 101       if (type == SRC_WIN)
 102         {
 103           symtab_and_line sal;
 104
 105           sal.line = line_or_addr.u.line_no + (content.size () - 2);
 106           sal.symtab = s;
 107           sal.pspace = SYMTAB_PSPACE (s);
 108           set_current_source_symtab_and_line (sal);
 109           /* If the focus was in the asm win, put it in the src win if
 110              we don't have a split layout.  */
 111           if (tui_win_with_focus () == TUI_DISASM_WIN
 112               && tui_current_layout () != SRC_DISASSEM_COMMAND)
 113             tui_set_win_focus_to (this);
 114         }
 115     }
 116 }
 117
 118
 119 /* Function to ensure that the source and/or disassemly windows
 120    reflect the input address.  */
 121 void
 122 tui_update_source_windows_with_addr (struct gdbarch *gdbarch, CORE_ADDR addr)
 123 {
 124   if (addr != 0)
 125     {
 126       struct symtab_and_line sal;
 127       struct tui_line_or_address l;
 128
 129       switch (tui_current_layout ())
 130         {
 131         case DISASSEM_COMMAND:
 132         case DISASSEM_DATA_COMMAND:
 133           tui_show_disassem (gdbarch, addr);
 134           break;
 135         case SRC_DISASSEM_COMMAND:
 136           tui_show_disassem_and_update_source (gdbarch, addr);
 137           break;
 138         default:
 139           sal = find_pc_line (addr, 0);
 140           l.loa = LOA_LINE;
 141           l.u.line_no = sal.line;
 142           TUI_SRC_WIN->show_symtab_source (gdbarch, sal.symtab, l);
 143           break;
 144         }
 145     }
 146   else
 147     {
 148       for (struct tui_source_window_base *win_info : tui_source_windows ())
 149         win_info->erase_source_content ();
 150     }
 151 }
 152
 153 /* Function to ensure that the source and/or disassemly windows
 154    reflect the input address.  */
 155 void
 156 tui_update_source_windows_with_line (struct symtab *s, int line)
 157 {
 158   struct gdbarch *gdbarch;
 159   CORE_ADDR pc;
 160   struct tui_line_or_address l;
 161
 162   if (!s)
 163     return;
 164
 165   gdbarch = get_objfile_arch (SYMTAB_OBJFILE (s));
 166
 167   switch (tui_current_layout ())
 168     {
 169     case DISASSEM_COMMAND:
 170     case DISASSEM_DATA_COMMAND:
 171       find_line_pc (s, line, &pc);
 172       tui_update_source_windows_with_addr (gdbarch, pc);
 173       break;
 174     default:
 175       l.loa = LOA_LINE;
 176       l.u.line_no = line;
 177       TUI_SRC_WIN->show_symtab_source (gdbarch, s, l);
 178       if (tui_current_layout () == SRC_DISASSEM_COMMAND)
 179         {
 180           find_line_pc (s, line, &pc);
 181           tui_show_disassem (gdbarch, pc);
 182         }
 183       break;
 184     }
 185 }
 186
 187 void
 188 tui_source_window_base::do_erase_source_content (const char *str)
 189 {
 190   int x_pos;
 191   int half_width = (width - 2) / 2;
 192
 193   content.clear ();
 194   if (handle != NULL)
 195     {
 196       werase (handle.get ());
 197       check_and_display_highlight_if_needed ();
 198
 199       if (strlen (str) >= half_width)
 200         x_pos = 1;
 201       else
 202         x_pos = half_width - strlen (str);
 203       mvwaddstr (handle.get (),
 204                  (height / 2),
 205                  x_pos,
 206                  (char *) str);
 207
 208       refresh_window ();
 209     }
 210 }
 211
 212
 213 /* Redraw the complete line of a source or disassembly window.  */
 214 static void
 215 tui_show_source_line (struct tui_source_window_base *win_info, int lineno)
 216 {
 217   struct tui_source_element *line;
 218   int x;
 219
 220   line = &win_info->content[lineno - 1];
 221   if (line->is_exec_point)
 222     tui_set_reverse_mode (win_info->handle.get (), true);
 223
 224   wmove (win_info->handle.get (), lineno, TUI_EXECINFO_SIZE);
 225   tui_puts (line->line.get (), win_info->handle.get ());
 226   if (line->is_exec_point)
 227     tui_set_reverse_mode (win_info->handle.get (), false);
 228
 229   /* Clear to end of line but stop before the border.  */
 230   x = getcurx (win_info->handle.get ());
 231   while (x + 1 < win_info->width)
 232     {
 233       waddch (win_info->handle.get (), ' ');
 234       x = getcurx (win_info->handle.get ());
 235     }
 236 }
 237
 238 void
 239 tui_source_window_base::show_source_content ()
 240 {
 241   gdb_assert (!content.empty ());
 242
 243   for (int lineno = 1; lineno <= content.size (); lineno++)
 244     tui_show_source_line (this, lineno);
 245
 246   check_and_display_highlight_if_needed ();
 247   refresh_window ();
 248 }
 249
 250 tui_source_window_base::tui_source_window_base (enum tui_win_type type)
 251   : tui_win_info (type)
 252 {
 253   gdb_assert (type == SRC_WIN || type == DISASSEM_WIN);
 254   start_line_or_addr.loa = LOA_ADDRESS;
 255   start_line_or_addr.u.addr = 0;
 256 }
 257
 258
 259 /* See tui-data.h.  */
 260
 261 void
 262 tui_source_window_base::update_tab_width ()
 263 {
 264   werase (handle.get ());
 265   rerender ();
 266 }
 267
 268 void
 269 tui_source_window_base::rerender ()
 270 {
 271   if (!content.empty ())
 272     {
 273       struct tui_line_or_address line_or_addr;
 274       struct symtab_and_line cursal
 275         = get_current_source_symtab_and_line ();
 276
 277       line_or_addr = start_line_or_addr;
 278       update_source_window (gdbarch, cursal.symtab, line_or_addr);
 279     }
 280   else if (deprecated_safe_get_selected_frame () != NULL)
 281     {
 282       struct tui_line_or_address line;
 283       struct symtab_and_line cursal
 284         = get_current_source_symtab_and_line ();
 285       struct frame_info *frame = deprecated_safe_get_selected_frame ();
 286       struct gdbarch *gdbarch = get_frame_arch (frame);
 287
 288       struct symtab *s = find_pc_line_symtab (get_frame_pc (frame));
 289       if (type == SRC_WIN)
 290         {
 291           line.loa = LOA_LINE;
 292           line.u.line_no = cursal.line;
 293         }
 294       else
 295         {
 296           line.loa = LOA_ADDRESS;
 297           find_line_pc (s, cursal.line, &line.u.addr);
 298         }
 299       update_source_window (gdbarch, s, line);
 300     }
 301   else
 302     erase_source_content ();
 303 }
 304
 305 /* See tui-data.h.  */
 306
 307 void
 308 tui_source_window_base::refill ()
 309 {
 310   symtab *s = nullptr;
 311
 312   if (type == SRC_WIN)
 313     {
 314       symtab_and_line cursal = get_current_source_symtab_and_line ();
 315       s = (cursal.symtab == NULL
 316            ? find_pc_line_symtab (get_frame_pc (get_selected_frame (NULL)))
 317            : cursal.symtab);
 318     }
 319
 320   update_source_window_as_is (gdbarch, s, content[0].line_or_addr);
 321 }
 322
 323 /* Scroll the source forward or backward horizontally.  */
 324
 325 void
 326 tui_source_window_base::do_scroll_horizontal (int num_to_scroll)
 327 {
 328   if (!content.empty ())
 329     {
 330       int offset = horizontal_offset + num_to_scroll;
 331       if (offset < 0)
 332         offset = 0;
 333       horizontal_offset = offset;
 334       refill ();
 335     }
 336 }
 337
 338
 339 /* Set or clear the is_exec_point flag in the line whose line is
 340    line_no.  */
 341
 342 void
 343 tui_source_window_base::set_is_exec_point_at (struct tui_line_or_address l)
 344 {
 345   bool changed = false;
 346   int i;
 347
 348   i = 0;
 349   while (i < content.size ())
 350     {
 351       bool new_state;
 352       struct tui_line_or_address content_loa =
 353         content[i].line_or_addr;
 354
 355       gdb_assert (l.loa == LOA_ADDRESS || l.loa == LOA_LINE);
 356       gdb_assert (content_loa.loa == LOA_LINE
 357                   || content_loa.loa == LOA_ADDRESS);
 358       if (content_loa.loa == l.loa
 359           && ((l.loa == LOA_LINE && content_loa.u.line_no == l.u.line_no)
 360               || (l.loa == LOA_ADDRESS && content_loa.u.addr == l.u.addr)))
 361         new_state = true;
 362       else
 363         new_state = false;
 364       if (new_state != content[i].is_exec_point)
 365         {
 366           changed = true;
 367           content[i].is_exec_point = new_state;
 368           tui_show_source_line (this, i + 1);
 369         }
 370       i++;
 371     }
 372   if (changed)
 373     refill ();
 374 }
 375
 376 /* See tui-winsource.h.  */
 377
 378 void
 379 tui_update_all_breakpoint_info (struct breakpoint *being_deleted)
 380 {
 381   for (tui_source_window_base *win : tui_source_windows ())
 382     {
 383       if (win->update_breakpoint_info (being_deleted, false))
 384         win->update_exec_info ();
 385     }
 386 }
 387
 388
 389 /* Scan the source window and the breakpoints to update the break_mode
 390    information for each line.
 391
 392    Returns true if something changed and the execution window must be
 393    refreshed.  */
 394
 395 bool
 396 tui_source_window_base::update_breakpoint_info
 397   (struct breakpoint *being_deleted, bool current_only)
 398 {
 399   int i;
 400   bool need_refresh = false;
 401
 402   for (i = 0; i < content.size (); i++)
 403     {
 404       struct tui_source_element *line;
 405
 406       line = &content[i];
 407       if (current_only && !line->is_exec_point)
 408          continue;
 409
 410       /* Scan each breakpoint to see if the current line has something to
 411          do with it.  Identify enable/disabled breakpoints as well as
 412          those that we already hit.  */
 413       tui_bp_flags mode = 0;
 414       iterate_over_breakpoints ([&] (breakpoint *bp) -> bool
 415         {
 416           struct bp_location *loc;
 417
 418           gdb_assert (line->line_or_addr.loa == LOA_LINE
 419                       || line->line_or_addr.loa == LOA_ADDRESS);
 420
 421           if (bp == being_deleted)
 422             return false;
 423
 424           for (loc = bp->loc; loc != NULL; loc = loc->next)
 425             {
 426               if (location_matches_p (loc, i))
 427                 {
 428                   if (bp->enable_state == bp_disabled)
 429                     mode |= TUI_BP_DISABLED;
 430                   else
 431                     mode |= TUI_BP_ENABLED;
 432                   if (bp->hit_count)
 433                     mode |= TUI_BP_HIT;
 434                   if (bp->loc->cond)
 435                     mode |= TUI_BP_CONDITIONAL;
 436                   if (bp->type == bp_hardware_breakpoint)
 437                     mode |= TUI_BP_HARDWARE;
 438                 }
 439             }
 440           return false;
 441         });
 442       if (line->break_mode != mode)
 443         {
 444           line->break_mode = mode;
 445           need_refresh = true;
 446         }
 447     }
 448   return need_refresh;
 449 }
 450
 451 /* Function to initialize the content of the execution info window,
 452    based upon the input window which is either the source or
 453    disassembly window.  */
 454 void
 455 tui_source_window_base::update_exec_info ()
 456 {
 457   update_breakpoint_info (nullptr, true);
 458   for (int i = 0; i < content.size (); i++)
 459     {
 460       struct tui_source_element *src_element = &content[i];
 461       char element[TUI_EXECINFO_SIZE] = "   ";
 462
 463       /* Now update the exec info content based upon the state
 464          of each line as indicated by the source content.  */
 465       tui_bp_flags mode = src_element->break_mode;
 466       if (mode & TUI_BP_HIT)
 467         element[TUI_BP_HIT_POS] = (mode & TUI_BP_HARDWARE) ? 'H' : 'B';
 468       else if (mode & (TUI_BP_ENABLED | TUI_BP_DISABLED))
 469         element[TUI_BP_HIT_POS] = (mode & TUI_BP_HARDWARE) ? 'h' : 'b';
 470
 471       if (mode & TUI_BP_ENABLED)
 472         element[TUI_BP_BREAK_POS] = '+';
 473       else if (mode & TUI_BP_DISABLED)
 474         element[TUI_BP_BREAK_POS] = '-';
 475
 476       if (src_element->is_exec_point)
 477         element[TUI_EXEC_POS] = '>';
 478
 479       mvwaddstr (handle.get (), i + 1, 1, element);
 480     }
 481   refresh_window ();
 482 }