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       win_info->content_in_use = false;
 215       tui_erase_source_content (win_info);
 216       for (i = 0; i < win_info->content.size (); i++)
 217         {
 218           struct tui_source_element *element = &win_info->content[i];
 219
 220           element->break_mode = 0;
 221           element->is_exec_point = false;
 222         }
 223     }
 224 }
 225
 226
 227 void
 228 tui_erase_source_content (struct tui_source_window_base *win_info)
 229 {
 230   int x_pos;
 231   int half_width = (win_info->width - 2) / 2;
 232
 233   if (win_info->handle != NULL)
 234     {
 235       werase (win_info->handle);
 236       tui_check_and_display_highlight_if_needed (win_info);
 237
 238       const char *no_src_str;
 239
 240       if (win_info->type == SRC_WIN)
 241         no_src_str = NO_SRC_STRING;
 242       else
 243         no_src_str = NO_DISASSEM_STRING;
 244       if (strlen (no_src_str) >= half_width)
 245         x_pos = 1;
 246       else
 247         x_pos = half_width - strlen (no_src_str);
 248       mvwaddstr (win_info->handle,
 249                  (win_info->height / 2),
 250                  x_pos,
 251                  (char *) no_src_str);
 252
 253       win_info->content.clear ();
 254       win_info->refresh_window ();
 255     }
 256 }
 257
 258
 259 /* Redraw the complete line of a source or disassembly window.  */
 260 static void
 261 tui_show_source_line (struct tui_source_window_base *win_info, int lineno)
 262 {
 263   struct tui_source_element *line;
 264   int x;
 265
 266   line = &win_info->content[lineno - 1];
 267   if (line->is_exec_point)
 268     tui_set_reverse_mode (win_info->handle, true);
 269
 270   wmove (win_info->handle, lineno, 1);
 271   tui_puts (line->line,
 272             win_info->handle);
 273   if (line->is_exec_point)
 274     tui_set_reverse_mode (win_info->handle, false);
 275
 276   /* Clear to end of line but stop before the border.  */
 277   x = getcurx (win_info->handle);
 278   while (x + 1 < win_info->width)
 279     {
 280       waddch (win_info->handle, ' ');
 281       x = getcurx (win_info->handle);
 282     }
 283 }
 284
 285 void
 286 tui_show_source_content (struct tui_source_window_base *win_info)
 287 {
 288   if (!win_info->content.empty ())
 289     {
 290       int lineno;
 291
 292       for (lineno = 1; lineno <= win_info->content.size (); lineno++)
 293         tui_show_source_line (win_info, lineno);
 294     }
 295   else
 296     tui_erase_source_content (win_info);
 297
 298   tui_check_and_display_highlight_if_needed (win_info);
 299   win_info->refresh_window ();
 300   win_info->content_in_use = true;
 301 }
 302
 303 /* See tui-data.h.  */
 304
 305 void
 306 tui_source_window_base::refill ()
 307 {
 308   symtab *s = nullptr;
 309
 310   if (type == SRC_WIN)
 311     {
 312       symtab_and_line cursal = get_current_source_symtab_and_line ();
 313       s = (cursal.symtab == NULL
 314            ? find_pc_line_symtab (get_frame_pc (get_selected_frame (NULL)))
 315            : cursal.symtab);
 316     }
 317
 318   tui_update_source_window_as_is (this, gdbarch, s,
 319                                   content[0].line_or_addr,
 320                                   FALSE);
 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 (tui_update_breakpoint_info (win, being_deleted, false))
 384         {
 385           tui_update_exec_info (win);
 386         }
 387     }
 388 }
 389
 390
 391 /* Scan the source window and the breakpoints to update the break_mode
 392    information for each line.
 393
 394    Returns true if something changed and the execution window must be
 395    refreshed.  */
 396
 397 bool
 398 tui_update_breakpoint_info (struct tui_source_window_base *win,
 399                             struct breakpoint *being_deleted,
 400                             bool current_only)
 401 {
 402   int i;
 403   bool need_refresh = false;
 404
 405   for (i = 0; i < win->content.size (); i++)
 406     {
 407       struct breakpoint *bp;
 408       extern struct breakpoint *breakpoint_chain;
 409       struct tui_source_element *line;
 410
 411       line = &win->content[i];
 412       if (current_only && !line->is_exec_point)
 413          continue;
 414
 415       /* Scan each breakpoint to see if the current line has something to
 416          do with it.  Identify enable/disabled breakpoints as well as
 417          those that we already hit.  */
 418       tui_bp_flags mode = 0;
 419       for (bp = breakpoint_chain;
 420            bp != NULL;
 421            bp = bp->next)
 422         {
 423           struct bp_location *loc;
 424
 425           gdb_assert (line->line_or_addr.loa == LOA_LINE
 426                       || line->line_or_addr.loa == LOA_ADDRESS);
 427
 428           if (bp == being_deleted)
 429             continue;
 430
 431           for (loc = bp->loc; loc != NULL; loc = loc->next)
 432             {
 433               if (win->location_matches_p (loc, i))
 434                 {
 435                   if (bp->enable_state == bp_disabled)
 436                     mode |= TUI_BP_DISABLED;
 437                   else
 438                     mode |= TUI_BP_ENABLED;
 439                   if (bp->hit_count)
 440                     mode |= TUI_BP_HIT;
 441                   if (bp->loc->cond)
 442                     mode |= TUI_BP_CONDITIONAL;
 443                   if (bp->type == bp_hardware_breakpoint)
 444                     mode |= TUI_BP_HARDWARE;
 445                 }
 446             }
 447         }
 448       if (line->break_mode != mode)
 449         {
 450           line->break_mode = mode;
 451           need_refresh = true;
 452         }
 453     }
 454   return need_refresh;
 455 }
 456
 457 /* See tui-data.h.  */
 458
 459 tui_exec_info_content *
 460 tui_exec_info_window::maybe_allocate_content (int n_elements)
 461 {
 462   if (m_content == nullptr)
 463     m_content = XNEWVEC (tui_exec_info_content, n_elements);
 464   return m_content;
 465 }
 466
 467
 468 /* Function to initialize the content of the execution info window,
 469    based upon the input window which is either the source or
 470    disassembly window.  */
 471 void
 472 tui_set_exec_info_content (struct tui_source_window_base *win_info)
 473 {
 474   if (win_info->execution_info != NULL)
 475     {
 476       tui_exec_info_content *content
 477         = win_info->execution_info->maybe_allocate_content (win_info->height);
 478
 479       tui_update_breakpoint_info (win_info, nullptr, true);
 480       for (int i = 0; i < win_info->content.size (); i++)
 481         {
 482           tui_exec_info_content &element = content[i];
 483           struct tui_source_element *src_element;
 484           tui_bp_flags mode;
 485
 486           src_element = &win_info->content[i];
 487
 488           memset (element, ' ', sizeof (tui_exec_info_content));
 489           element[TUI_EXECINFO_SIZE - 1] = 0;
 490
 491           /* Now update the exec info content based upon the state
 492              of each line as indicated by the source content.  */
 493           mode = src_element->break_mode;
 494           if (mode & TUI_BP_HIT)
 495             element[TUI_BP_HIT_POS] = (mode & TUI_BP_HARDWARE) ? 'H' : 'B';
 496           else if (mode & (TUI_BP_ENABLED | TUI_BP_DISABLED))
 497             element[TUI_BP_HIT_POS] = (mode & TUI_BP_HARDWARE) ? 'h' : 'b';
 498
 499           if (mode & TUI_BP_ENABLED)
 500             element[TUI_BP_BREAK_POS] = '+';
 501           else if (mode & TUI_BP_DISABLED)
 502             element[TUI_BP_BREAK_POS] = '-';
 503
 504           if (src_element->is_exec_point)
 505             element[TUI_EXEC_POS] = '>';
 506         }
 507     }
 508 }
 509
 510
 511 void
 512 tui_show_exec_info_content (struct tui_source_window_base *win_info)
 513 {
 514   struct tui_exec_info_window *exec_info = win_info->execution_info;
 515   const tui_exec_info_content *content = exec_info->get_content ();
 516
 517   werase (exec_info->handle);
 518   exec_info->refresh_window ();
 519   for (int cur_line = 1; cur_line <= win_info->content.size (); cur_line++)
 520     mvwaddstr (exec_info->handle,
 521                cur_line,
 522                0,
 523                content[cur_line - 1]);
 524   exec_info->refresh_window ();
 525 }
 526
 527
 528 void
 529 tui_erase_exec_info_content (struct tui_source_window_base *win_info)
 530 {
 531   struct tui_gen_win_info *exec_info = win_info->execution_info;
 532
 533   werase (exec_info->handle);
 534   exec_info->refresh_window ();
 535 }
 536
 537 void
 538 tui_clear_exec_info_content (struct tui_source_window_base *win_info)
 539 {
 540   tui_erase_exec_info_content (win_info);
 541 }
 542
 543 /* Function to update the execution info window.  */
 544 void
 545 tui_update_exec_info (struct tui_source_window_base *win_info)
 546 {
 547   tui_set_exec_info_content (win_info);
 548   tui_show_exec_info_content (win_info);
 549 }
 550
 551 void
 552 tui_alloc_source_buffer (struct tui_source_window_base *win_info)
 553 {
 554   int i, line_width, max_lines;
 555
 556   /* The window width/height includes the highlight box.  Determine actual
 557      content dimensions, including string null-terminators.  */
 558   max_lines = win_info->height - 2;
 559   line_width = win_info->width - 2 + 1;
 560
 561   /* Allocate the buffer for the source lines.  */
 562   win_info->content.resize (max_lines);
 563   for (i = 0; i < max_lines; i++)
 564     {
 565       if (win_info->content[i].line == nullptr)
 566         win_info->content[i].line = (char *) xmalloc (line_width);
 567     }
 568 }
 569
 570
 571 /* Answer whether a particular line number or address is displayed
 572    in the current source window.  */
 573 int
 574 tui_line_is_displayed (int line,
 575                        struct tui_source_window_base *win_info,
 576                        int check_threshold)
 577 {
 578   int is_displayed = FALSE;
 579   int i, threshold;
 580
 581   if (check_threshold)
 582     threshold = SCROLL_THRESHOLD;
 583   else
 584     threshold = 0;
 585   i = 0;
 586   while (i < win_info->content.size () - threshold
 587          && !is_displayed)
 588     {
 589       is_displayed
 590         = win_info->content[i].line_or_addr.loa == LOA_LINE
 591           && win_info->content[i].line_or_addr.u.line_no == line;
 592       i++;
 593     }
 594
 595   return is_displayed;
 596 }
 597
 598
 599 /* Answer whether a particular line number or address is displayed
 600    in the current source window.  */
 601 int
 602 tui_addr_is_displayed (CORE_ADDR addr,
 603                        struct tui_source_window_base *win_info,
 604                        int check_threshold)
 605 {
 606   int is_displayed = FALSE;
 607   int i, threshold;
 608
 609   if (check_threshold)
 610     threshold = SCROLL_THRESHOLD;
 611   else
 612     threshold = 0;
 613   i = 0;
 614   while (i < win_info->content.size () - threshold
 615          && !is_displayed)
 616     {
 617       is_displayed
 618         = win_info->content[i].line_or_addr.loa == LOA_ADDRESS
 619           && win_info->content[i].line_or_addr.u.addr == addr;
 620       i++;
 621     }
 622
 623   return is_displayed;
 624 }
 625
 626
 627 /*****************************************
 628 ** STATIC LOCAL FUNCTIONS               **
 629 ******************************************/