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