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     win_info->erase_source_content ();
 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         win_info->erase_source_content ();
 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_source_window_base::do_erase_source_content (const char *str)
 196 {
 197   int x_pos;
 198   int half_width = (width - 2) / 2;
 199
 200   content.clear ();
 201   if (handle != NULL)
 202     {
 203       werase (handle);
 204       check_and_display_highlight_if_needed ();
 205
 206       if (strlen (str) >= half_width)
 207         x_pos = 1;
 208       else
 209         x_pos = half_width - strlen (str);
 210       mvwaddstr (handle,
 211                  (height / 2),
 212                  x_pos,
 213                  (char *) str);
 214
 215       refresh_window ();
 216
 217       werase (execution_info->handle);
 218       execution_info->refresh_window ();
 219     }
 220 }
 221
 222
 223 /* Redraw the complete line of a source or disassembly window.  */
 224 static void
 225 tui_show_source_line (struct tui_source_window_base *win_info, int lineno)
 226 {
 227   struct tui_source_element *line;
 228   int x;
 229
 230   line = &win_info->content[lineno - 1];
 231   if (line->is_exec_point)
 232     tui_set_reverse_mode (win_info->handle, true);
 233
 234   wmove (win_info->handle, lineno, 1);
 235   tui_puts (line->line,
 236             win_info->handle);
 237   if (line->is_exec_point)
 238     tui_set_reverse_mode (win_info->handle, false);
 239
 240   /* Clear to end of line but stop before the border.  */
 241   x = getcurx (win_info->handle);
 242   while (x + 1 < win_info->width)
 243     {
 244       waddch (win_info->handle, ' ');
 245       x = getcurx (win_info->handle);
 246     }
 247 }
 248
 249 void
 250 tui_source_window_base::show_source_content ()
 251 {
 252   if (!content.empty ())
 253     {
 254       int lineno;
 255
 256       for (lineno = 1; lineno <= content.size (); lineno++)
 257         tui_show_source_line (this, lineno);
 258     }
 259   else
 260     erase_source_content ();
 261
 262   check_and_display_highlight_if_needed ();
 263   refresh_window ();
 264 }
 265
 266 /* See tui-data.h.  */
 267
 268 void
 269 tui_source_window_base::clear_detail ()
 270 {
 271   gdbarch = NULL;
 272   start_line_or_addr.loa = LOA_ADDRESS;
 273   start_line_or_addr.u.addr = 0;
 274   horizontal_offset = 0;
 275 }
 276
 277 tui_source_window_base::tui_source_window_base (enum tui_win_type type)
 278   : tui_win_info (type),
 279     execution_info (new tui_exec_info_window ())
 280 {
 281   gdb_assert (type == SRC_WIN || type == DISASSEM_WIN);
 282   start_line_or_addr.loa = LOA_ADDRESS;
 283   start_line_or_addr.u.addr = 0;
 284 }
 285
 286
 287 tui_source_window_base::~tui_source_window_base ()
 288 {
 289   xfree (fullname);
 290   delete execution_info;
 291 }
 292
 293 void
 294 tui_source_window_base::reset (int height, int width,
 295                                int origin_x, int origin_y)
 296 {
 297   tui_gen_win_info::reset (height, width - 3,
 298                            origin_x + 3, origin_y);
 299   execution_info->reset (height, 3, origin_x, origin_y);
 300 }
 301
 302 /* See tui-data.h.  */
 303
 304 void
 305 tui_source_window_base::refresh_all ()
 306 {
 307   show_source_content ();
 308   check_and_display_highlight_if_needed ();
 309   update_exec_info ();
 310 }
 311
 312 /* See tui-data.h.  */
 313
 314 void
 315 tui_source_window_base::update_tab_width ()
 316 {
 317   /* We don't really change the height of any windows, but
 318      calling these 2 functions causes a complete regeneration
 319      and redisplay of the window's contents, which will take
 320      the new tab width into account.  */
 321   make_invisible_and_set_new_height (height);
 322   make_visible_with_new_height ();
 323 }
 324
 325 /* See tui-data.h.  */
 326
 327 void
 328 tui_source_window_base::set_new_height (int height)
 329 {
 330   execution_info->make_visible (false);
 331   execution_info->height = height;
 332   execution_info->origin.y = origin.y;
 333   if (height > 1)
 334     execution_info->viewport_height = height - 1;
 335   else
 336     execution_info->viewport_height = height;
 337   execution_info->viewport_height--;
 338
 339   if (m_has_locator)
 340     {
 341       tui_locator_window *gen_win_info = tui_locator_win_info_ptr ();
 342       gen_win_info->make_visible (false);
 343       gen_win_info->origin.y = origin.y + height;
 344     }
 345 }
 346
 347 /* See tui-data.h.  */
 348
 349 void
 350 tui_source_window_base::do_make_visible_with_new_height ()
 351 {
 352   execution_info->make_visible (true);
 353   if (!content.empty ())
 354     {
 355       struct tui_line_or_address line_or_addr;
 356       struct symtab_and_line cursal
 357         = get_current_source_symtab_and_line ();
 358
 359       line_or_addr = start_line_or_addr;
 360       tui_update_source_window (this, gdbarch,
 361                                 cursal.symtab, line_or_addr, TRUE);
 362     }
 363   else if (deprecated_safe_get_selected_frame () != NULL)
 364     {
 365       struct tui_line_or_address line;
 366       struct symtab_and_line cursal
 367         = get_current_source_symtab_and_line ();
 368       struct frame_info *frame = deprecated_safe_get_selected_frame ();
 369       struct gdbarch *gdbarch = get_frame_arch (frame);
 370
 371       struct symtab *s = find_pc_line_symtab (get_frame_pc (frame));
 372       if (type == SRC_WIN)
 373         {
 374           line.loa = LOA_LINE;
 375           line.u.line_no = cursal.line;
 376         }
 377       else
 378         {
 379           line.loa = LOA_ADDRESS;
 380           find_line_pc (s, cursal.line, &line.u.addr);
 381         }
 382       tui_update_source_window (this, gdbarch, s, line, TRUE);
 383     }
 384   if (m_has_locator)
 385     {
 386       tui_locator_win_info_ptr ()->make_visible (true);
 387       tui_show_locator_content ();
 388     }
 389 }
 390
 391 /* See tui-data.h.  */
 392
 393 void
 394 tui_source_window_base::make_visible (bool visible)
 395 {
 396   execution_info->make_visible (visible);
 397   tui_win_info::make_visible (visible);
 398 }
 399
 400 /* See tui-data.h.  */
 401
 402 void
 403 tui_source_window_base::refresh_window ()
 404 {
 405   execution_info->refresh_window ();
 406   tui_win_info::refresh_window ();
 407 }
 408
 409 /* See tui-data.h.  */
 410
 411 void
 412 tui_source_window_base::refill ()
 413 {
 414   symtab *s = nullptr;
 415
 416   if (type == SRC_WIN)
 417     {
 418       symtab_and_line cursal = get_current_source_symtab_and_line ();
 419       s = (cursal.symtab == NULL
 420            ? find_pc_line_symtab (get_frame_pc (get_selected_frame (NULL)))
 421            : cursal.symtab);
 422     }
 423
 424   tui_update_source_window_as_is (this, gdbarch, s,
 425                                   content[0].line_or_addr,
 426                                   FALSE);
 427 }
 428
 429 /* Scroll the source forward or backward horizontally.  */
 430
 431 void
 432 tui_source_window_base::do_scroll_horizontal (int num_to_scroll)
 433 {
 434   if (!content.empty ())
 435     {
 436       int offset = horizontal_offset + num_to_scroll;
 437       if (offset < 0)
 438         offset = 0;
 439       horizontal_offset = offset;
 440       refill ();
 441     }
 442 }
 443
 444
 445 /* Set or clear the is_exec_point flag in the line whose line is
 446    line_no.  */
 447
 448 void
 449 tui_source_window_base::set_is_exec_point_at (struct tui_line_or_address l)
 450 {
 451   bool changed = false;
 452   int i;
 453
 454   i = 0;
 455   while (i < content.size ())
 456     {
 457       bool new_state;
 458       struct tui_line_or_address content_loa =
 459         content[i].line_or_addr;
 460
 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)))
 467         new_state = true;
 468       else
 469         new_state = false;
 470       if (new_state != content[i].is_exec_point)
 471         {
 472           changed = true;
 473           content[i].is_exec_point = new_state;
 474           tui_show_source_line (this, i + 1);
 475         }
 476       i++;
 477     }
 478   if (changed)
 479     refill ();
 480 }
 481
 482 /* See tui-winsource.h.  */
 483
 484 void
 485 tui_update_all_breakpoint_info (struct breakpoint *being_deleted)
 486 {
 487   for (tui_source_window_base *win : tui_source_windows ())
 488     {
 489       if (tui_update_breakpoint_info (win, being_deleted, false))
 490         {
 491           win->update_exec_info ();
 492         }
 493     }
 494 }
 495
 496
 497 /* Scan the source window and the breakpoints to update the break_mode
 498    information for each line.
 499
 500    Returns true if something changed and the execution window must be
 501    refreshed.  */
 502
 503 bool
 504 tui_update_breakpoint_info (struct tui_source_window_base *win,
 505                             struct breakpoint *being_deleted,
 506                             bool current_only)
 507 {
 508   int i;
 509   bool need_refresh = false;
 510
 511   for (i = 0; i < win->content.size (); i++)
 512     {
 513       struct breakpoint *bp;
 514       extern struct breakpoint *breakpoint_chain;
 515       struct tui_source_element *line;
 516
 517       line = &win->content[i];
 518       if (current_only && !line->is_exec_point)
 519          continue;
 520
 521       /* Scan each breakpoint to see if the current line has something to
 522          do with it.  Identify enable/disabled breakpoints as well as
 523          those that we already hit.  */
 524       tui_bp_flags mode = 0;
 525       for (bp = breakpoint_chain;
 526            bp != NULL;
 527            bp = bp->next)
 528         {
 529           struct bp_location *loc;
 530
 531           gdb_assert (line->line_or_addr.loa == LOA_LINE
 532                       || line->line_or_addr.loa == LOA_ADDRESS);
 533
 534           if (bp == being_deleted)
 535             continue;
 536
 537           for (loc = bp->loc; loc != NULL; loc = loc->next)
 538             {
 539               if (win->location_matches_p (loc, i))
 540                 {
 541                   if (bp->enable_state == bp_disabled)
 542                     mode |= TUI_BP_DISABLED;
 543                   else
 544                     mode |= TUI_BP_ENABLED;
 545                   if (bp->hit_count)
 546                     mode |= TUI_BP_HIT;
 547                   if (bp->loc->cond)
 548                     mode |= TUI_BP_CONDITIONAL;
 549                   if (bp->type == bp_hardware_breakpoint)
 550                     mode |= TUI_BP_HARDWARE;
 551                 }
 552             }
 553         }
 554       if (line->break_mode != mode)
 555         {
 556           line->break_mode = mode;
 557           need_refresh = true;
 558         }
 559     }
 560   return need_refresh;
 561 }
 562
 563 /* Function to initialize the content of the execution info window,
 564    based upon the input window which is either the source or
 565    disassembly window.  */
 566 void
 567 tui_source_window_base::update_exec_info ()
 568 {
 569   werase (execution_info->handle);
 570   tui_update_breakpoint_info (this, nullptr, true);
 571   for (int i = 0; i < content.size (); i++)
 572     {
 573       struct tui_source_element *src_element = &content[i];
 574       char element[TUI_EXECINFO_SIZE] = "   ";
 575
 576       /* Now update the exec info content based upon the state
 577          of each line as indicated by the source content.  */
 578       tui_bp_flags mode = src_element->break_mode;
 579       if (mode & TUI_BP_HIT)
 580         element[TUI_BP_HIT_POS] = (mode & TUI_BP_HARDWARE) ? 'H' : 'B';
 581       else if (mode & (TUI_BP_ENABLED | TUI_BP_DISABLED))
 582         element[TUI_BP_HIT_POS] = (mode & TUI_BP_HARDWARE) ? 'h' : 'b';
 583
 584       if (mode & TUI_BP_ENABLED)
 585         element[TUI_BP_BREAK_POS] = '+';
 586       else if (mode & TUI_BP_DISABLED)
 587         element[TUI_BP_BREAK_POS] = '-';
 588
 589       if (src_element->is_exec_point)
 590         element[TUI_EXEC_POS] = '>';
 591
 592       mvwaddstr (execution_info->handle, i + 1, 0, element);
 593     }
 594   execution_info->refresh_window ();
 595 }