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