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   if (!tui_source_windows ().empty ())
  48     {
  49       struct gdbarch *gdbarch;
  50       CORE_ADDR addr;
  51
  52       tui_get_begin_asm_address (&gdbarch, &addr);
  53       if (addr != (CORE_ADDR) 0)
  54         {
  55           struct symtab *s;
  56
  57           tui_update_source_windows_with_addr (gdbarch, addr);
  58           s = find_pc_line_symtab (addr);
  59           if (s != NULL)
  60              tui_update_locator_fullname (symtab_to_fullname (s));
  61           else
  62              tui_update_locator_fullname ("??");
  63         }
  64     }
  65 }
  66
  67
  68
  69 /* Function to display source in the source window.  This function
  70    initializes the horizontal scroll to 0.  */
  71 void
  72 tui_update_source_window (struct tui_source_window_base *win_info,
  73                           struct gdbarch *gdbarch,
  74                           struct symtab *s,
  75                           struct tui_line_or_address line_or_addr,
  76                           int noerror)
  77 {
  78   win_info->horizontal_offset = 0;
  79   tui_update_source_window_as_is (win_info, gdbarch, s, line_or_addr, noerror);
  80
  81   return;
  82 }
  83
  84
  85 /* Function to display source in the source/asm window.  This function
  86    shows the source as specified by the horizontal offset.  */
  87 void
  88 tui_update_source_window_as_is (struct tui_source_window_base *win_info,
  89                                 struct gdbarch *gdbarch,
  90                                 struct symtab *s,
  91                                 struct tui_line_or_address line_or_addr,
  92                                 int noerror)
  93 {
  94   enum tui_status ret;
  95
  96   if (win_info->type == SRC_WIN)
  97     ret = tui_set_source_content (win_info, s, line_or_addr.u.line_no,
  98                                   noerror);
  99   else
 100     ret = tui_set_disassem_content (win_info, gdbarch, line_or_addr.u.addr);
 101
 102   if (ret == TUI_FAILURE)
 103     {
 104       tui_clear_source_content (win_info);
 105       tui_clear_exec_info_content (win_info);
 106     }
 107   else
 108     {
 109       tui_update_breakpoint_info (win_info, nullptr, false);
 110       tui_show_source_content (win_info);
 111       tui_update_exec_info (win_info);
 112       if (win_info->type == SRC_WIN)
 113         {
 114           symtab_and_line sal;
 115
 116           sal.line = line_or_addr.u.line_no +
 117             (win_info->content.size () - 2);
 118           sal.symtab = s;
 119           sal.pspace = SYMTAB_PSPACE (s);
 120           set_current_source_symtab_and_line (sal);
 121           /* If the focus was in the asm win, put it in the src win if
 122              we don't have a split layout.  */
 123           if (tui_win_with_focus () == TUI_DISASM_WIN
 124               && tui_current_layout () != SRC_DISASSEM_COMMAND)
 125             tui_set_win_focus_to (win_info);
 126         }
 127     }
 128
 129
 130   return;
 131 }
 132
 133
 134 /* Function to ensure that the source and/or disassemly windows
 135    reflect the input address.  */
 136 void
 137 tui_update_source_windows_with_addr (struct gdbarch *gdbarch, CORE_ADDR addr)
 138 {
 139   if (addr != 0)
 140     {
 141       struct symtab_and_line sal;
 142       struct tui_line_or_address l;
 143
 144       switch (tui_current_layout ())
 145         {
 146         case DISASSEM_COMMAND:
 147         case DISASSEM_DATA_COMMAND:
 148           tui_show_disassem (gdbarch, addr);
 149           break;
 150         case SRC_DISASSEM_COMMAND:
 151           tui_show_disassem_and_update_source (gdbarch, addr);
 152           break;
 153         default:
 154           sal = find_pc_line (addr, 0);
 155           l.loa = LOA_LINE;
 156           l.u.line_no = sal.line;
 157           tui_show_symtab_source (TUI_SRC_WIN, gdbarch, sal.symtab, l, FALSE);
 158           break;
 159         }
 160     }
 161   else
 162     {
 163       for (struct tui_source_window_base *win_info : tui_source_windows ())
 164         {
 165           tui_clear_source_content (win_info);
 166           tui_clear_exec_info_content (win_info);
 167         }
 168     }
 169 }
 170
 171 /* Function to ensure that the source and/or disassemly windows
 172    reflect the input address.  */
 173 void
 174 tui_update_source_windows_with_line (struct symtab *s, int line)
 175 {
 176   struct gdbarch *gdbarch;
 177   CORE_ADDR pc;
 178   struct tui_line_or_address l;
 179
 180   if (!s)
 181     return;
 182
 183   gdbarch = get_objfile_arch (SYMTAB_OBJFILE (s));
 184
 185   switch (tui_current_layout ())
 186     {
 187     case DISASSEM_COMMAND:
 188     case DISASSEM_DATA_COMMAND:
 189       find_line_pc (s, line, &pc);
 190       tui_update_source_windows_with_addr (gdbarch, pc);
 191       break;
 192     default:
 193       l.loa = LOA_LINE;
 194       l.u.line_no = line;
 195       tui_show_symtab_source (TUI_SRC_WIN, gdbarch, s, l, FALSE);
 196       if (tui_current_layout () == SRC_DISASSEM_COMMAND)
 197         {
 198           find_line_pc (s, line, &pc);
 199           tui_show_disassem (gdbarch, pc);
 200         }
 201       break;
 202     }
 203
 204   return;
 205 }
 206
 207 void
 208 tui_clear_source_content (struct tui_source_window_base *win_info)
 209 {
 210   if (win_info != NULL)
 211     {
 212       int i;
 213
 214       tui_erase_source_content (win_info);
 215       for (i = 0; i < win_info->content.size (); i++)
 216         {
 217           struct tui_source_element *element = &win_info->content[i];
 218
 219           element->break_mode = 0;
 220           element->is_exec_point = false;
 221         }
 222     }
 223 }
 224
 225
 226 void
 227 tui_erase_source_content (struct tui_source_window_base *win_info)
 228 {
 229   int x_pos;
 230   int half_width = (win_info->width - 2) / 2;
 231
 232   if (win_info->handle != NULL)
 233     {
 234       werase (win_info->handle);
 235       tui_check_and_display_highlight_if_needed (win_info);
 236
 237       const char *no_src_str;
 238
 239       if (win_info->type == SRC_WIN)
 240         no_src_str = NO_SRC_STRING;
 241       else
 242         no_src_str = NO_DISASSEM_STRING;
 243       if (strlen (no_src_str) >= half_width)
 244         x_pos = 1;
 245       else
 246         x_pos = half_width - strlen (no_src_str);
 247       mvwaddstr (win_info->handle,
 248                  (win_info->height / 2),
 249                  x_pos,
 250                  (char *) no_src_str);
 251
 252       win_info->content.clear ();
 253       win_info->refresh_window ();
 254     }
 255 }
 256
 257
 258 /* Redraw the complete line of a source or disassembly window.  */
 259 static void
 260 tui_show_source_line (struct tui_source_window_base *win_info, int lineno)
 261 {
 262   struct tui_source_element *line;
 263   int x;
 264
 265   line = &win_info->content[lineno - 1];
 266   if (line->is_exec_point)
 267     tui_set_reverse_mode (win_info->handle, true);
 268
 269   wmove (win_info->handle, lineno, 1);
 270   tui_puts (line->line,
 271             win_info->handle);
 272   if (line->is_exec_point)
 273     tui_set_reverse_mode (win_info->handle, false);
 274
 275   /* Clear to end of line but stop before the border.  */
 276   x = getcurx (win_info->handle);
 277   while (x + 1 < win_info->width)
 278     {
 279       waddch (win_info->handle, ' ');
 280       x = getcurx (win_info->handle);
 281     }
 282 }
 283
 284 void
 285 tui_show_source_content (struct tui_source_window_base *win_info)
 286 {
 287   if (!win_info->content.empty ())
 288     {
 289       int lineno;
 290
 291       for (lineno = 1; lineno <= win_info->content.size (); lineno++)
 292         tui_show_source_line (win_info, lineno);
 293     }
 294   else
 295     tui_erase_source_content (win_info);
 296
 297   tui_check_and_display_highlight_if_needed (win_info);
 298   win_info->refresh_window ();
 299 }
 300
 301 /* See tui-data.h.  */
 302
 303 void
 304 tui_source_window_base::refill ()
 305 {
 306   symtab *s = nullptr;
 307
 308   if (type == SRC_WIN)
 309     {
 310       symtab_and_line cursal = get_current_source_symtab_and_line ();
 311       s = (cursal.symtab == NULL
 312            ? find_pc_line_symtab (get_frame_pc (get_selected_frame (NULL)))
 313            : cursal.symtab);
 314     }
 315
 316   tui_update_source_window_as_is (this, gdbarch, s,
 317                                   content[0].line_or_addr,
 318                                   FALSE);
 319 }
 320
 321 /* Scroll the source forward or backward horizontally.  */
 322
 323 void
 324 tui_source_window_base::do_scroll_horizontal (int num_to_scroll)
 325 {
 326   if (!content.empty ())
 327     {
 328       int offset = horizontal_offset + num_to_scroll;
 329       if (offset < 0)
 330         offset = 0;
 331       horizontal_offset = offset;
 332       refill ();
 333     }
 334 }
 335
 336
 337 /* Set or clear the is_exec_point flag in the line whose line is
 338    line_no.  */
 339
 340 void
 341 tui_source_window_base::set_is_exec_point_at (struct tui_line_or_address l)
 342 {
 343   bool changed = false;
 344   int i;
 345
 346   i = 0;
 347   while (i < content.size ())
 348     {
 349       bool new_state;
 350       struct tui_line_or_address content_loa =
 351         content[i].line_or_addr;
 352
 353       gdb_assert (l.loa == LOA_ADDRESS || l.loa == LOA_LINE);
 354       gdb_assert (content_loa.loa == LOA_LINE
 355                   || content_loa.loa == LOA_ADDRESS);
 356       if (content_loa.loa == l.loa
 357           && ((l.loa == LOA_LINE && content_loa.u.line_no == l.u.line_no)
 358               || (l.loa == LOA_ADDRESS && content_loa.u.addr == l.u.addr)))
 359         new_state = true;
 360       else
 361         new_state = false;
 362       if (new_state != content[i].is_exec_point)
 363         {
 364           changed = true;
 365           content[i].is_exec_point = new_state;
 366           tui_show_source_line (this, i + 1);
 367         }
 368       i++;
 369     }
 370   if (changed)
 371     refill ();
 372 }
 373
 374 /* See tui-winsource.h.  */
 375
 376 void
 377 tui_update_all_breakpoint_info (struct breakpoint *being_deleted)
 378 {
 379   for (tui_source_window_base *win : tui_source_windows ())
 380     {
 381       if (tui_update_breakpoint_info (win, being_deleted, false))
 382         {
 383           tui_update_exec_info (win);
 384         }
 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_update_breakpoint_info (struct tui_source_window_base *win,
 397                             struct breakpoint *being_deleted,
 398                             bool current_only)
 399 {
 400   int i;
 401   bool need_refresh = false;
 402
 403   for (i = 0; i < win->content.size (); i++)
 404     {
 405       struct breakpoint *bp;
 406       extern struct breakpoint *breakpoint_chain;
 407       struct tui_source_element *line;
 408
 409       line = &win->content[i];
 410       if (current_only && !line->is_exec_point)
 411          continue;
 412
 413       /* Scan each breakpoint to see if the current line has something to
 414          do with it.  Identify enable/disabled breakpoints as well as
 415          those that we already hit.  */
 416       tui_bp_flags mode = 0;
 417       for (bp = breakpoint_chain;
 418            bp != NULL;
 419            bp = bp->next)
 420         {
 421           struct bp_location *loc;
 422
 423           gdb_assert (line->line_or_addr.loa == LOA_LINE
 424                       || line->line_or_addr.loa == LOA_ADDRESS);
 425
 426           if (bp == being_deleted)
 427             continue;
 428
 429           for (loc = bp->loc; loc != NULL; loc = loc->next)
 430             {
 431               if (win->location_matches_p (loc, i))
 432                 {
 433                   if (bp->enable_state == bp_disabled)
 434                     mode |= TUI_BP_DISABLED;
 435                   else
 436                     mode |= TUI_BP_ENABLED;
 437                   if (bp->hit_count)
 438                     mode |= TUI_BP_HIT;
 439                   if (bp->loc->cond)
 440                     mode |= TUI_BP_CONDITIONAL;
 441                   if (bp->type == bp_hardware_breakpoint)
 442                     mode |= TUI_BP_HARDWARE;
 443                 }
 444             }
 445         }
 446       if (line->break_mode != mode)
 447         {
 448           line->break_mode = mode;
 449           need_refresh = true;
 450         }
 451     }
 452   return need_refresh;
 453 }
 454
 455 /* See tui-data.h.  */
 456
 457 tui_exec_info_content *
 458 tui_exec_info_window::maybe_allocate_content (int n_elements)
 459 {
 460   if (m_content == nullptr)
 461     m_content = XNEWVEC (tui_exec_info_content, n_elements);
 462   return m_content;
 463 }
 464
 465
 466 /* Function to initialize the content of the execution info window,
 467    based upon the input window which is either the source or
 468    disassembly window.  */
 469 void
 470 tui_set_exec_info_content (struct tui_source_window_base *win_info)
 471 {
 472   if (win_info->execution_info != NULL)
 473     {
 474       tui_exec_info_content *content
 475         = win_info->execution_info->maybe_allocate_content (win_info->height);
 476
 477       tui_update_breakpoint_info (win_info, nullptr, true);
 478       for (int i = 0; i < win_info->content.size (); i++)
 479         {
 480           tui_exec_info_content &element = content[i];
 481           struct tui_source_element *src_element;
 482           tui_bp_flags mode;
 483
 484           src_element = &win_info->content[i];
 485
 486           memset (element, ' ', sizeof (tui_exec_info_content));
 487           element[TUI_EXECINFO_SIZE - 1] = 0;
 488
 489           /* Now update the exec info content based upon the state
 490              of each line as indicated by the source content.  */
 491           mode = src_element->break_mode;
 492           if (mode & TUI_BP_HIT)
 493             element[TUI_BP_HIT_POS] = (mode & TUI_BP_HARDWARE) ? 'H' : 'B';
 494           else if (mode & (TUI_BP_ENABLED | TUI_BP_DISABLED))
 495             element[TUI_BP_HIT_POS] = (mode & TUI_BP_HARDWARE) ? 'h' : 'b';
 496
 497           if (mode & TUI_BP_ENABLED)
 498             element[TUI_BP_BREAK_POS] = '+';
 499           else if (mode & TUI_BP_DISABLED)
 500             element[TUI_BP_BREAK_POS] = '-';
 501
 502           if (src_element->is_exec_point)
 503             element[TUI_EXEC_POS] = '>';
 504         }
 505     }
 506 }
 507
 508
 509 void
 510 tui_show_exec_info_content (struct tui_source_window_base *win_info)
 511 {
 512   struct tui_exec_info_window *exec_info = win_info->execution_info;
 513   const tui_exec_info_content *content = exec_info->get_content ();
 514
 515   werase (exec_info->handle);
 516   exec_info->refresh_window ();
 517   for (int cur_line = 1; cur_line <= win_info->content.size (); cur_line++)
 518     mvwaddstr (exec_info->handle,
 519                cur_line,
 520                0,
 521                content[cur_line - 1]);
 522   exec_info->refresh_window ();
 523 }
 524
 525
 526 void
 527 tui_erase_exec_info_content (struct tui_source_window_base *win_info)
 528 {
 529   struct tui_gen_win_info *exec_info = win_info->execution_info;
 530
 531   werase (exec_info->handle);
 532   exec_info->refresh_window ();
 533 }
 534
 535 void
 536 tui_clear_exec_info_content (struct tui_source_window_base *win_info)
 537 {
 538   tui_erase_exec_info_content (win_info);
 539 }
 540
 541 /* Function to update the execution info window.  */
 542 void
 543 tui_update_exec_info (struct tui_source_window_base *win_info)
 544 {
 545   tui_set_exec_info_content (win_info);
 546   tui_show_exec_info_content (win_info);
 547 }
 548
 549 void
 550 tui_alloc_source_buffer (struct tui_source_window_base *win_info)
 551 {
 552   int i, line_width, max_lines;
 553
 554   /* The window width/height includes the highlight box.  Determine actual
 555      content dimensions, including string null-terminators.  */
 556   max_lines = win_info->height - 2;
 557   line_width = win_info->width - 2 + 1;
 558
 559   /* Allocate the buffer for the source lines.  */
 560   win_info->content.resize (max_lines);
 561   for (i = 0; i < max_lines; i++)
 562     {
 563       if (win_info->content[i].line == nullptr)
 564         win_info->content[i].line = (char *) xmalloc (line_width);
 565     }
 566 }
 567
 568
 569 /* Answer whether a particular line number or address is displayed
 570    in the current source window.  */
 571 int
 572 tui_line_is_displayed (int line,
 573                        struct tui_source_window_base *win_info,
 574                        int check_threshold)
 575 {
 576   int is_displayed = FALSE;
 577   int i, threshold;
 578
 579   if (check_threshold)
 580     threshold = SCROLL_THRESHOLD;
 581   else
 582     threshold = 0;
 583   i = 0;
 584   while (i < win_info->content.size () - threshold
 585          && !is_displayed)
 586     {
 587       is_displayed
 588         = win_info->content[i].line_or_addr.loa == LOA_LINE
 589           && win_info->content[i].line_or_addr.u.line_no == line;
 590       i++;
 591     }
 592
 593   return is_displayed;
 594 }
 595
 596
 597 /* Answer whether a particular line number or address is displayed
 598    in the current source window.  */
 599 int
 600 tui_addr_is_displayed (CORE_ADDR addr,
 601                        struct tui_source_window_base *win_info,
 602                        int check_threshold)
 603 {
 604   int is_displayed = FALSE;
 605   int i, threshold;
 606
 607   if (check_threshold)
 608     threshold = SCROLL_THRESHOLD;
 609   else
 610     threshold = 0;
 611   i = 0;
 612   while (i < win_info->content.size () - threshold
 613          && !is_displayed)
 614     {
 615       is_displayed
 616         = win_info->content[i].line_or_addr.loa == LOA_ADDRESS
 617           && win_info->content[i].line_or_addr.u.addr == addr;
 618       i++;
 619     }
 620
 621   return is_displayed;
 622 }
 623
 624
 625 /*****************************************
 626 ** STATIC LOCAL FUNCTIONS               **
 627 ******************************************/