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 /* See tui-winsource.h.  */
  69
  70 std::string
  71 tui_copy_source_line (const char **ptr, int line_no, int first_col,
  72                       int line_width, int ndigits)
  73 {
  74   const char *lineptr = *ptr;
  75
  76   /* Init the line with the line number.  */
  77   std::string result;
  78
  79   if (line_no > 0)
  80     {
  81       if (ndigits > 0)
  82         result = string_printf ("%*d ", ndigits, line_no);
  83       else
  84         {
  85           result = string_printf ("%-6d", line_no);
  86           int len = result.size ();
  87           len = len - ((len / tui_tab_width) * tui_tab_width);
  88           result.append (len, ' ');
  89         }
  90     }
  91
  92   int column = 0;
  93   char c;
  94   do
  95     {
  96       int skip_bytes;
  97
  98       c = *lineptr;
  99       if (c == '\033' && skip_ansi_escape (lineptr, &skip_bytes))
 100         {
 101           /* We always have to preserve escapes.  */
 102           result.append (lineptr, lineptr + skip_bytes);
 103           lineptr += skip_bytes;
 104           continue;
 105         }
 106
 107       ++lineptr;
 108       ++column;
 109
 110       auto process_tab = [&] ()
 111         {
 112           int max_tab_len = tui_tab_width;
 113
 114           --column;
 115           for (int j = column % max_tab_len;
 116                j < max_tab_len && column < first_col + line_width;
 117                column++, j++)
 118             if (column >= first_col)
 119               result.push_back (' ');
 120         };
 121
 122       /* We have to process all the text in order to pick up all the
 123          escapes.  */
 124       if (column <= first_col || column > first_col + line_width)
 125         {
 126           if (c == '\t')
 127             process_tab ();
 128           continue;
 129         }
 130
 131       if (c == '\n' || c == '\r' || c == '\0')
 132         {
 133           /* Nothing.  */
 134         }
 135       else if (c < 040 && c != '\t')
 136         {
 137           result.push_back ('^');
 138           result.push_back (c + 0100);
 139         }
 140       else if (c == 0177)
 141         {
 142           result.push_back ('^');
 143           result.push_back ('?');
 144         }
 145       else if (c == '\t')
 146         process_tab ();
 147       else
 148         result.push_back (c);
 149     }
 150   while (c != '\0' && c != '\n' && c != '\r');
 151
 152   if (c == '\r' && *lineptr == '\n')
 153     ++lineptr;
 154   *ptr = lineptr;
 155
 156   return result;
 157 }
 158
 159 void
 160 tui_source_window_base::style_changed ()
 161 {
 162   if (tui_active && is_visible ())
 163     refill ();
 164 }
 165
 166 /* Function to display source in the source window.  This function
 167    initializes the horizontal scroll to 0.  */
 168 void
 169 tui_source_window_base::update_source_window
 170   (struct gdbarch *gdbarch,
 171    struct symtab *s,
 172    struct tui_line_or_address line_or_addr)
 173 {
 174   horizontal_offset = 0;
 175   update_source_window_as_is (gdbarch, s, line_or_addr);
 176 }
 177
 178
 179 /* Function to display source in the source/asm window.  This function
 180    shows the source as specified by the horizontal offset.  */
 181 void
 182 tui_source_window_base::update_source_window_as_is
 183   (struct gdbarch *gdbarch,
 184    struct symtab *s,
 185    struct tui_line_or_address line_or_addr)
 186 {
 187   enum tui_status ret
 188     = set_contents (gdbarch, s, line_or_addr);
 189
 190   if (ret == TUI_FAILURE)
 191     erase_source_content ();
 192   else
 193     {
 194       update_breakpoint_info (nullptr, false);
 195       show_source_content ();
 196       update_exec_info ();
 197       if (type == SRC_WIN)
 198         {
 199           symtab_and_line sal;
 200
 201           sal.line = line_or_addr.u.line_no + (content.size () - 2);
 202           sal.symtab = s;
 203           sal.pspace = SYMTAB_PSPACE (s);
 204           set_current_source_symtab_and_line (sal);
 205           /* If the focus was in the asm win, put it in the src win if
 206              we don't have a split layout.  */
 207           if (tui_win_with_focus () == TUI_DISASM_WIN
 208               && tui_current_layout () != SRC_DISASSEM_COMMAND)
 209             tui_set_win_focus_to (this);
 210         }
 211     }
 212 }
 213
 214
 215 /* Function to ensure that the source and/or disassemly windows
 216    reflect the input address.  */
 217 void
 218 tui_update_source_windows_with_addr (struct gdbarch *gdbarch, CORE_ADDR addr)
 219 {
 220   if (addr != 0)
 221     {
 222       struct symtab_and_line sal;
 223       struct tui_line_or_address l;
 224
 225       switch (tui_current_layout ())
 226         {
 227         case DISASSEM_COMMAND:
 228         case DISASSEM_DATA_COMMAND:
 229           tui_show_disassem (gdbarch, addr);
 230           break;
 231         case SRC_DISASSEM_COMMAND:
 232           tui_show_disassem_and_update_source (gdbarch, addr);
 233           break;
 234         default:
 235           sal = find_pc_line (addr, 0);
 236           l.loa = LOA_LINE;
 237           l.u.line_no = sal.line;
 238           TUI_SRC_WIN->show_symtab_source (gdbarch, sal.symtab, l);
 239           break;
 240         }
 241     }
 242   else
 243     {
 244       for (struct tui_source_window_base *win_info : tui_source_windows ())
 245         win_info->erase_source_content ();
 246     }
 247 }
 248
 249 /* Function to ensure that the source and/or disassemly windows
 250    reflect the input address.  */
 251 void
 252 tui_update_source_windows_with_line (struct symtab *s, int line)
 253 {
 254   struct gdbarch *gdbarch;
 255   CORE_ADDR pc;
 256   struct tui_line_or_address l;
 257
 258   if (!s)
 259     return;
 260
 261   gdbarch = get_objfile_arch (SYMTAB_OBJFILE (s));
 262
 263   switch (tui_current_layout ())
 264     {
 265     case DISASSEM_COMMAND:
 266     case DISASSEM_DATA_COMMAND:
 267       find_line_pc (s, line, &pc);
 268       tui_update_source_windows_with_addr (gdbarch, pc);
 269       break;
 270     default:
 271       l.loa = LOA_LINE;
 272       l.u.line_no = line;
 273       TUI_SRC_WIN->show_symtab_source (gdbarch, s, l);
 274       if (tui_current_layout () == SRC_DISASSEM_COMMAND)
 275         {
 276           find_line_pc (s, line, &pc);
 277           tui_show_disassem (gdbarch, pc);
 278         }
 279       break;
 280     }
 281 }
 282
 283 void
 284 tui_source_window_base::do_erase_source_content (const char *str)
 285 {
 286   int x_pos;
 287   int half_width = (width - 2) / 2;
 288
 289   content.clear ();
 290   if (handle != NULL)
 291     {
 292       werase (handle.get ());
 293       check_and_display_highlight_if_needed ();
 294
 295       if (strlen (str) >= half_width)
 296         x_pos = 1;
 297       else
 298         x_pos = half_width - strlen (str);
 299       mvwaddstr (handle.get (),
 300                  (height / 2),
 301                  x_pos,
 302                  (char *) str);
 303
 304       refresh_window ();
 305     }
 306 }
 307
 308
 309 /* Redraw the complete line of a source or disassembly window.  */
 310 static void
 311 tui_show_source_line (struct tui_source_window_base *win_info, int lineno)
 312 {
 313   struct tui_source_element *line;
 314   int x;
 315
 316   line = &win_info->content[lineno - 1];
 317   if (line->is_exec_point)
 318     tui_set_reverse_mode (win_info->handle.get (), true);
 319
 320   wmove (win_info->handle.get (), lineno, TUI_EXECINFO_SIZE);
 321   tui_puts (line->line.c_str (), win_info->handle.get ());
 322   if (line->is_exec_point)
 323     tui_set_reverse_mode (win_info->handle.get (), false);
 324
 325   /* Clear to end of line but stop before the border.  */
 326   x = getcurx (win_info->handle.get ());
 327   while (x + 1 < win_info->width)
 328     {
 329       waddch (win_info->handle.get (), ' ');
 330       x = getcurx (win_info->handle.get ());
 331     }
 332 }
 333
 334 void
 335 tui_source_window_base::show_source_content ()
 336 {
 337   gdb_assert (!content.empty ());
 338
 339   for (int lineno = 1; lineno <= content.size (); lineno++)
 340     tui_show_source_line (this, lineno);
 341
 342   check_and_display_highlight_if_needed ();
 343   refresh_window ();
 344 }
 345
 346 tui_source_window_base::tui_source_window_base (enum tui_win_type type)
 347   : tui_win_info (type)
 348 {
 349   gdb_assert (type == SRC_WIN || type == DISASSEM_WIN);
 350   start_line_or_addr.loa = LOA_ADDRESS;
 351   start_line_or_addr.u.addr = 0;
 352
 353   gdb::observers::source_styling_changed.attach
 354     (std::bind (&tui_source_window::style_changed, this),
 355      m_observable);
 356 }
 357
 358 tui_source_window_base::~tui_source_window_base ()
 359 {
 360   gdb::observers::source_styling_changed.detach (m_observable);
 361 }
 362
 363 /* See tui-data.h.  */
 364
 365 void
 366 tui_source_window_base::update_tab_width ()
 367 {
 368   werase (handle.get ());
 369   rerender ();
 370 }
 371
 372 void
 373 tui_source_window_base::rerender ()
 374 {
 375   if (!content.empty ())
 376     {
 377       struct tui_line_or_address line_or_addr;
 378       struct symtab_and_line cursal
 379         = get_current_source_symtab_and_line ();
 380
 381       line_or_addr = start_line_or_addr;
 382       update_source_window (gdbarch, cursal.symtab, line_or_addr);
 383     }
 384   else if (deprecated_safe_get_selected_frame () != NULL)
 385     {
 386       struct tui_line_or_address line;
 387       struct symtab_and_line cursal
 388         = get_current_source_symtab_and_line ();
 389       struct frame_info *frame = deprecated_safe_get_selected_frame ();
 390       struct gdbarch *gdbarch = get_frame_arch (frame);
 391
 392       struct symtab *s = find_pc_line_symtab (get_frame_pc (frame));
 393       if (type == SRC_WIN)
 394         {
 395           line.loa = LOA_LINE;
 396           line.u.line_no = cursal.line;
 397         }
 398       else
 399         {
 400           line.loa = LOA_ADDRESS;
 401           find_line_pc (s, cursal.line, &line.u.addr);
 402         }
 403       update_source_window (gdbarch, s, line);
 404     }
 405   else
 406     erase_source_content ();
 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   update_source_window_as_is (gdbarch, s, content[0].line_or_addr);
 425 }
 426
 427 /* Scroll the source forward or backward horizontally.  */
 428
 429 void
 430 tui_source_window_base::do_scroll_horizontal (int num_to_scroll)
 431 {
 432   if (!content.empty ())
 433     {
 434       int offset = horizontal_offset + num_to_scroll;
 435       if (offset < 0)
 436         offset = 0;
 437       horizontal_offset = offset;
 438       refill ();
 439     }
 440 }
 441
 442
 443 /* Set or clear the is_exec_point flag in the line whose line is
 444    line_no.  */
 445
 446 void
 447 tui_source_window_base::set_is_exec_point_at (struct tui_line_or_address l)
 448 {
 449   bool changed = false;
 450   int i;
 451
 452   i = 0;
 453   while (i < content.size ())
 454     {
 455       bool new_state;
 456       struct tui_line_or_address content_loa =
 457         content[i].line_or_addr;
 458
 459       gdb_assert (l.loa == LOA_ADDRESS || l.loa == LOA_LINE);
 460       gdb_assert (content_loa.loa == LOA_LINE
 461                   || content_loa.loa == LOA_ADDRESS);
 462       if (content_loa.loa == l.loa
 463           && ((l.loa == LOA_LINE && content_loa.u.line_no == l.u.line_no)
 464               || (l.loa == LOA_ADDRESS && content_loa.u.addr == l.u.addr)))
 465         new_state = true;
 466       else
 467         new_state = false;
 468       if (new_state != content[i].is_exec_point)
 469         {
 470           changed = true;
 471           content[i].is_exec_point = new_state;
 472           tui_show_source_line (this, i + 1);
 473         }
 474       i++;
 475     }
 476   if (changed)
 477     refill ();
 478 }
 479
 480 /* See tui-winsource.h.  */
 481
 482 void
 483 tui_update_all_breakpoint_info (struct breakpoint *being_deleted)
 484 {
 485   for (tui_source_window_base *win : tui_source_windows ())
 486     {
 487       if (win->update_breakpoint_info (being_deleted, false))
 488         win->update_exec_info ();
 489     }
 490 }
 491
 492
 493 /* Scan the source window and the breakpoints to update the break_mode
 494    information for each line.
 495
 496    Returns true if something changed and the execution window must be
 497    refreshed.  */
 498
 499 bool
 500 tui_source_window_base::update_breakpoint_info
 501   (struct breakpoint *being_deleted, bool current_only)
 502 {
 503   int i;
 504   bool need_refresh = false;
 505
 506   for (i = 0; i < content.size (); i++)
 507     {
 508       struct tui_source_element *line;
 509
 510       line = &content[i];
 511       if (current_only && !line->is_exec_point)
 512          continue;
 513
 514       /* Scan each breakpoint to see if the current line has something to
 515          do with it.  Identify enable/disabled breakpoints as well as
 516          those that we already hit.  */
 517       tui_bp_flags mode = 0;
 518       iterate_over_breakpoints ([&] (breakpoint *bp) -> bool
 519         {
 520           struct bp_location *loc;
 521
 522           gdb_assert (line->line_or_addr.loa == LOA_LINE
 523                       || line->line_or_addr.loa == LOA_ADDRESS);
 524
 525           if (bp == being_deleted)
 526             return false;
 527
 528           for (loc = bp->loc; loc != NULL; loc = loc->next)
 529             {
 530               if (location_matches_p (loc, i))
 531                 {
 532                   if (bp->enable_state == bp_disabled)
 533                     mode |= TUI_BP_DISABLED;
 534                   else
 535                     mode |= TUI_BP_ENABLED;
 536                   if (bp->hit_count)
 537                     mode |= TUI_BP_HIT;
 538                   if (bp->loc->cond)
 539                     mode |= TUI_BP_CONDITIONAL;
 540                   if (bp->type == bp_hardware_breakpoint)
 541                     mode |= TUI_BP_HARDWARE;
 542                 }
 543             }
 544           return false;
 545         });
 546       if (line->break_mode != mode)
 547         {
 548           line->break_mode = mode;
 549           need_refresh = true;
 550         }
 551     }
 552   return need_refresh;
 553 }
 554
 555 /* Function to initialize the content of the execution info window,
 556    based upon the input window which is either the source or
 557    disassembly window.  */
 558 void
 559 tui_source_window_base::update_exec_info ()
 560 {
 561   update_breakpoint_info (nullptr, true);
 562   for (int i = 0; i < content.size (); i++)
 563     {
 564       struct tui_source_element *src_element = &content[i];
 565       char element[TUI_EXECINFO_SIZE] = "   ";
 566
 567       /* Now update the exec info content based upon the state
 568          of each line as indicated by the source content.  */
 569       tui_bp_flags mode = src_element->break_mode;
 570       if (mode & TUI_BP_HIT)
 571         element[TUI_BP_HIT_POS] = (mode & TUI_BP_HARDWARE) ? 'H' : 'B';
 572       else if (mode & (TUI_BP_ENABLED | TUI_BP_DISABLED))
 573         element[TUI_BP_HIT_POS] = (mode & TUI_BP_HARDWARE) ? 'h' : 'b';
 574
 575       if (mode & TUI_BP_ENABLED)
 576         element[TUI_BP_BREAK_POS] = '+';
 577       else if (mode & TUI_BP_DISABLED)
 578         element[TUI_BP_BREAK_POS] = '-';
 579
 580       if (src_element->is_exec_point)
 581         element[TUI_EXEC_POS] = '>';
 582
 583       mvwaddstr (handle.get (), i + 1, 1, element);
 584     }
 585   refresh_window ();
 586 }