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