gdb/tui/tui-source.c

   1 /* TUI display source window.
   2
   3    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2007, 2008, 2009,
   4    2010 Free Software Foundation, Inc.
   5
   6    Contributed by Hewlett-Packard Company.
   7
   8    This file is part of GDB.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  22
  23 #include "defs.h"
  24 #include <ctype.h>
  25 #include "symtab.h"
  26 #include "frame.h"
  27 #include "breakpoint.h"
  28 #include "source.h"
  29 #include "symtab.h"
  30 #include "objfiles.h"
  31
  32 #include "tui/tui.h"
  33 #include "tui/tui-data.h"
  34 #include "tui/tui-stack.h"
  35 #include "tui/tui-winsource.h"
  36 #include "tui/tui-source.h"
  37
  38 #include "gdb_string.h"
  39 #include "gdb_curses.h"
  40
  41 /* Function to display source in the source window.  */
  42 enum tui_status
  43 tui_set_source_content (struct symtab *s,
  44                         int line_no,
  45                         int noerror)
  46 {
  47   enum tui_status ret = TUI_FAILURE;
  48
  49   if (s != (struct symtab *) NULL && s->filename != (char *) NULL)
  50     {
  51       FILE *stream;
  52       int i, desc, c, line_width, nlines;
  53       char *src_line = 0;
  54
  55       if ((ret = tui_alloc_source_buffer (TUI_SRC_WIN)) == TUI_SUCCESS)
  56         {
  57           line_width = TUI_SRC_WIN->generic.width - 1;
  58           /* Take hilite (window border) into account, when
  59              calculating the number of lines.  */
  60           nlines = (line_no + (TUI_SRC_WIN->generic.height - 2)) - line_no;
  61           desc = open_source_file (s);
  62           if (desc < 0)
  63             {
  64               if (!noerror)
  65                 {
  66                   char *name = alloca (strlen (s->filename) + 100);
  67
  68                   sprintf (name, "%s:%d", s->filename, line_no);
  69                   print_sys_errmsg (name, errno);
  70                 }
  71               ret = TUI_FAILURE;
  72             }
  73           else
  74             {
  75               if (s->line_charpos == 0)
  76                 find_source_lines (s, desc);
  77
  78               if (line_no < 1 || line_no > s->nlines)
  79                 {
  80                   close (desc);
  81                   printf_unfiltered (
  82                           "Line number %d out of range; %s has %d lines.\n",
  83                                       line_no, s->filename, s->nlines);
  84                 }
  85               else if (lseek (desc, s->line_charpos[line_no - 1], 0) < 0)
  86                 {
  87                   close (desc);
  88                   perror_with_name (s->filename);
  89                 }
  90               else
  91                 {
  92                   int offset, cur_line_no, cur_line, cur_len, threshold;
  93                   struct tui_gen_win_info *locator = tui_locator_win_info_ptr ();
  94                   struct tui_source_info *src = &TUI_SRC_WIN->detail.source_info;
  95
  96                   if (TUI_SRC_WIN->generic.title)
  97                     xfree (TUI_SRC_WIN->generic.title);
  98                   TUI_SRC_WIN->generic.title = xstrdup (s->filename);
  99
 100                   if (src->filename)
 101                     xfree (src->filename);
 102                   src->filename = xstrdup (s->filename);
 103
 104                   /* Determine the threshold for the length of the
 105                      line and the offset to start the display.  */
 106                   offset = src->horizontal_offset;
 107                   threshold = (line_width - 1) + offset;
 108                   stream = fdopen (desc, FOPEN_RT);
 109                   clearerr (stream);
 110                   cur_line = 0;
 111                   src->gdbarch = get_objfile_arch (s->objfile);
 112                   src->start_line_or_addr.loa = LOA_LINE;
 113                   cur_line_no = src->start_line_or_addr.u.line_no = line_no;
 114                   if (offset > 0)
 115                     src_line = (char *) xmalloc (
 116                                            (threshold + 1) * sizeof (char));
 117                   while (cur_line < nlines)
 118                     {
 119                       struct tui_win_element *element = (struct tui_win_element *)
 120                         TUI_SRC_WIN->generic.content[cur_line];
 121
 122                       /* Get the first character in the line.  */
 123                       c = fgetc (stream);
 124
 125                       if (offset == 0)
 126                         src_line = ((struct tui_win_element *)
 127                                    TUI_SRC_WIN->generic.content[
 128                                         cur_line])->which_element.source.line;
 129                       /* Init the line with the line number.  */
 130                       sprintf (src_line, "%-6d", cur_line_no);
 131                       cur_len = strlen (src_line);
 132                       i = cur_len -
 133                         ((cur_len / tui_default_tab_len ()) * tui_default_tab_len ());
 134                       while (i < tui_default_tab_len ())
 135                         {
 136                           src_line[cur_len] = ' ';
 137                           i++;
 138                           cur_len++;
 139                         }
 140                       src_line[cur_len] = (char) 0;
 141
 142                       /* Set whether element is the execution point
 143                          and whether there is a break point on it.  */
 144                       element->which_element.source.line_or_addr.loa =
 145                         LOA_LINE;
 146                       element->which_element.source.line_or_addr.u.line_no =
 147                         cur_line_no;
 148                       element->which_element.source.is_exec_point =
 149                         (strcmp (((struct tui_win_element *)
 150                                   locator->content[0])->which_element.locator.file_name,
 151                                  s->filename) == 0
 152                          && cur_line_no == ((struct tui_win_element *)
 153                                             locator->content[0])->which_element.locator.line_no);
 154                       if (c != EOF)
 155                         {
 156                           i = strlen (src_line) - 1;
 157                           do
 158                             {
 159                               if ((c != '\n') && (c != '\r')
 160                                   && (++i < threshold))
 161                                 {
 162                                   if (c < 040 && c != '\t')
 163                                     {
 164                                       src_line[i++] = '^';
 165                                       src_line[i] = c + 0100;
 166                                     }
 167                                   else if (c == 0177)
 168                                     {
 169                                       src_line[i++] = '^';
 170                                       src_line[i] = '?';
 171                                     }
 172                                   else
 173                                     { /* Store the charcter in the
 174                                          line buffer.  If it is a tab,
 175                                          then translate to the correct
 176                                          number of chars so we don't
 177                                          overwrite our buffer.  */
 178                                       if (c == '\t')
 179                                         {
 180                                           int j, max_tab_len = tui_default_tab_len ();
 181
 182                                           for (j = i - ((i / max_tab_len) * max_tab_len);
 183                                                j < max_tab_len
 184                                                  && i < threshold;
 185                                                i++, j++)
 186                                             src_line[i] = ' ';
 187                                           i--;
 188                                         }
 189                                       else
 190                                         src_line[i] = c;
 191                                     }
 192                                   src_line[i + 1] = 0;
 193                                 }
 194                               else
 195                                 { /* If we have not reached EOL, then
 196                                      eat chars until we do.  */
 197                                   while (c != EOF && c != '\n' && c != '\r')
 198                                     c = fgetc (stream);
 199                                   /* Handle non-'\n' end-of-line.  */
 200                                   if (c == '\r'
 201                                       && (c = fgetc (stream)) != '\n'
 202                                       && c != EOF)
 203                                     {
 204                                        ungetc (c, stream);
 205                                        c = '\r';
 206                                     }
 207
 208                                 }
 209                             }
 210                           while (c != EOF && c != '\n' && c != '\r'
 211                                  && i < threshold
 212                                  && (c = fgetc (stream)));
 213                         }
 214                       /* Now copy the line taking the offset into
 215                          account.  */
 216                       if (strlen (src_line) > offset)
 217                         strcpy (((struct tui_win_element *) TUI_SRC_WIN->generic.content[
 218                                         cur_line])->which_element.source.line,
 219                                 &src_line[offset]);
 220                       else
 221                         ((struct tui_win_element *)
 222                          TUI_SRC_WIN->generic.content[
 223                           cur_line])->which_element.source.line[0] = (char) 0;
 224                       cur_line++;
 225                       cur_line_no++;
 226                     }
 227                   if (offset > 0)
 228                     xfree (src_line);
 229                   fclose (stream);
 230                   TUI_SRC_WIN->generic.content_size = nlines;
 231                   ret = TUI_SUCCESS;
 232                 }
 233             }
 234         }
 235     }
 236   return ret;
 237 }
 238
 239
 240 /* elz: This function sets the contents of the source window to empty
 241    except for a line in the middle with a warning message about the
 242    source not being available.  This function is called by
 243    tui_erase_source_contents(), which in turn is invoked when the
 244    source files cannot be accessed.  */
 245
 246 void
 247 tui_set_source_content_nil (struct tui_win_info *win_info,
 248                             char *warning_string)
 249 {
 250   int line_width;
 251   int n_lines;
 252   int curr_line = 0;
 253
 254   line_width = win_info->generic.width - 1;
 255   n_lines = win_info->generic.height - 2;
 256
 257   /* Set to empty each line in the window, except for the one which
 258      contains the message.  */
 259   while (curr_line < win_info->generic.content_size)
 260     {
 261       /* Set the information related to each displayed line to null:
 262          i.e. the line number is 0, there is no bp, it is not where
 263          the program is stopped.  */
 264
 265       struct tui_win_element *element =
 266         (struct tui_win_element *) win_info->generic.content[curr_line];
 267
 268       element->which_element.source.line_or_addr.loa = LOA_LINE;
 269       element->which_element.source.line_or_addr.u.line_no = 0;
 270       element->which_element.source.is_exec_point = FALSE;
 271       element->which_element.source.has_break = FALSE;
 272
 273       /* Set the contents of the line to blank.  */
 274       element->which_element.source.line[0] = (char) 0;
 275
 276       /* If the current line is in the middle of the screen, then we
 277          want to display the 'no source available' message in it.
 278          Note: the 'weird' arithmetic with the line width and height
 279          comes from the function tui_erase_source_content().  We need
 280          to keep the screen and the window's actual contents in
 281          synch.  */
 282
 283       if (curr_line == (n_lines / 2 + 1))
 284         {
 285           int i;
 286           int xpos;
 287           int warning_length = strlen (warning_string);
 288           char *src_line;
 289
 290           src_line = element->which_element.source.line;
 291
 292           if (warning_length >= ((line_width - 1) / 2))
 293             xpos = 1;
 294           else
 295             xpos = (line_width - 1) / 2 - warning_length;
 296
 297           for (i = 0; i < xpos; i++)
 298             src_line[i] = ' ';
 299
 300           sprintf (src_line + i, "%s", warning_string);
 301
 302           for (i = xpos + warning_length; i < line_width; i++)
 303             src_line[i] = ' ';
 304
 305           src_line[i] = '\n';
 306
 307         }                       /* end if */
 308
 309       curr_line++;
 310
 311     }                           /* end while */
 312 }
 313
 314
 315 /* Function to display source in the source window.  This function
 316    initializes the horizontal scroll to 0.  */
 317 void
 318 tui_show_symtab_source (struct gdbarch *gdbarch, struct symtab *s,
 319                         struct tui_line_or_address line,
 320                         int noerror)
 321 {
 322   TUI_SRC_WIN->detail.source_info.horizontal_offset = 0;
 323   tui_update_source_window_as_is (TUI_SRC_WIN, gdbarch, s, line, noerror);
 324 }
 325
 326
 327 /* Answer whether the source is currently displayed in the source
 328    window.  */
 329 int
 330 tui_source_is_displayed (char *fname)
 331 {
 332   return (TUI_SRC_WIN->generic.content_in_use
 333           && (strcmp (((struct tui_win_element *) (tui_locator_win_info_ptr ())->
 334                        content[0])->which_element.locator.file_name, fname) == 0));
 335 }
 336
 337
 338 /* Scroll the source forward or backward vertically.  */
 339 void
 340 tui_vertical_source_scroll (enum tui_scroll_direction scroll_direction,
 341                             int num_to_scroll)
 342 {
 343   if (TUI_SRC_WIN->generic.content != NULL)
 344     {
 345       struct tui_line_or_address l;
 346       struct symtab *s;
 347       tui_win_content content = (tui_win_content) TUI_SRC_WIN->generic.content;
 348       struct symtab_and_line cursal = get_current_source_symtab_and_line ();
 349
 350       if (cursal.symtab == (struct symtab *) NULL)
 351         s = find_pc_symtab (get_frame_pc (get_selected_frame (NULL)));
 352       else
 353         s = cursal.symtab;
 354
 355       l.loa = LOA_LINE;
 356       if (scroll_direction == FORWARD_SCROLL)
 357         {
 358           l.u.line_no = content[0]->which_element.source.line_or_addr.u.line_no
 359             + num_to_scroll;
 360           if (l.u.line_no > s->nlines)
 361             /* line = s->nlines - win_info->generic.content_size + 1; */
 362             /* elz: fix for dts 23398.  */
 363             l.u.line_no = content[0]->which_element.source.line_or_addr.u.line_no;
 364         }
 365       else
 366         {
 367           l.u.line_no = content[0]->which_element.source.line_or_addr.u.line_no
 368             - num_to_scroll;
 369           if (l.u.line_no <= 0)
 370             l.u.line_no = 1;
 371         }
 372
 373       print_source_lines (s, l.u.line_no, l.u.line_no + 1, 0);
 374     }
 375 }