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