gdb/tui/tui-source.c

   1 /* TUI display source window.
   2
   3    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2007
   4    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 2 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, write to the Free Software
  22    Foundation, Inc., 51 Franklin Street, Fifth Floor,
  23    Boston, MA 02110-1301, USA.  */
  24
  25 #include "defs.h"
  26 #include <ctype.h>
  27 #include "symtab.h"
  28 #include "frame.h"
  29 #include "breakpoint.h"
  30 #include "source.h"
  31 #include "symtab.h"
  32
  33 #include "tui/tui.h"
  34 #include "tui/tui-data.h"
  35 #include "tui/tui-stack.h"
  36 #include "tui/tui-winsource.h"
  37 #include "tui/tui-source.h"
  38
  39 #include "gdb_string.h"
  40 #include "gdb_curses.h"
  41
  42 /* Function to display source in the source window.  */
  43 enum tui_status
  44 tui_set_source_content (struct symtab *s,
  45                         int line_no,
  46                         int noerror)
  47 {
  48   enum tui_status ret = TUI_FAILURE;
  49
  50   if (s != (struct symtab *) NULL && s->filename != (char *) NULL)
  51     {
  52       FILE *stream;
  53       int i, desc, c, line_width, nlines;
  54       char *src_line = 0;
  55
  56       if ((ret = tui_alloc_source_buffer (TUI_SRC_WIN)) == TUI_SUCCESS)
  57         {
  58           line_width = TUI_SRC_WIN->generic.width - 1;
  59           /* Take hilite (window border) into account, when
  60              calculating the number of lines.  */
  61           nlines = (line_no + (TUI_SRC_WIN->generic.height - 2)) - line_no;
  62           desc = open_source_file (s);
  63           if (desc < 0)
  64             {
  65               if (!noerror)
  66                 {
  67                   char *name = alloca (strlen (s->filename) + 100);
  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->start_line_or_addr.loa = LOA_LINE;
 112                   cur_line_no = src->start_line_or_addr.u.line_no = line_no;
 113                   if (offset > 0)
 114                     src_line = (char *) xmalloc (
 115                                            (threshold + 1) * sizeof (char));
 116                   while (cur_line < nlines)
 117                     {
 118                       struct tui_win_element *element = (struct tui_win_element *)
 119                       TUI_SRC_WIN->generic.content[cur_line];
 120
 121                       /* Get the first character in the line.  */
 122                       c = fgetc (stream);
 123
 124                       if (offset == 0)
 125                         src_line = ((struct tui_win_element *)
 126                                    TUI_SRC_WIN->generic.content[
 127                                         cur_line])->which_element.source.line;
 128                       /* Init the line with the line number.  */
 129                       sprintf (src_line, "%-6d", cur_line_no);
 130                       cur_len = strlen (src_line);
 131                       i = cur_len -
 132                         ((cur_len / tui_default_tab_len ()) * tui_default_tab_len ());
 133                       while (i < tui_default_tab_len ())
 134                         {
 135                           src_line[cur_len] = ' ';
 136                           i++;
 137                           cur_len++;
 138                         }
 139                       src_line[cur_len] = (char) 0;
 140
 141                       /* Set whether element is the execution point
 142                          and whether there is a break point on it.  */
 143                       element->which_element.source.line_or_addr.loa =
 144                         LOA_LINE;
 145                       element->which_element.source.line_or_addr.u.line_no =
 146                         cur_line_no;
 147                       element->which_element.source.is_exec_point =
 148                         (strcmp (((struct tui_win_element *)
 149                         locator->content[0])->which_element.locator.file_name,
 150                                  s->filename) == 0
 151                          && cur_line_no == ((struct tui_win_element *)
 152                          locator->content[0])->which_element.locator.line_no);
 153                       if (c != EOF)
 154                         {
 155                           i = strlen (src_line) - 1;
 156                           do
 157                             {
 158                               if ((c != '\n') &&
 159                                   (c != '\r') && (++i < threshold))
 160                                 {
 161                                   if (c < 040 && c != '\t')
 162                                     {
 163                                       src_line[i++] = '^';
 164                                       src_line[i] = c + 0100;
 165                                     }
 166                                   else if (c == 0177)
 167                                     {
 168                                       src_line[i++] = '^';
 169                                       src_line[i] = '?';
 170                                     }
 171                                   else
 172                                     { /* Store the charcter in the
 173                                          line buffer.  If it is a tab,
 174                                          then translate to the correct
 175                                          number of chars so we don't
 176                                          overwrite our buffer.  */
 177                                       if (c == '\t')
 178                                         {
 179                                           int j, max_tab_len = tui_default_tab_len ();
 180
 181                                           for (j = i - (
 182                                                (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' && c != EOF)
 202                                     {
 203                                        ungetc (c, stream);
 204                                        c = '\r';
 205                                     }
 206
 207                                 }
 208                             }
 209                           while (c != EOF && c != '\n' && c != '\r' &&
 210                                  i < threshold && (c = fgetc (stream)));
 211                         }
 212                       /* Now copy the line taking the offset into
 213                          account.  */
 214                       if (strlen (src_line) > offset)
 215                         strcpy (((struct tui_win_element *) TUI_SRC_WIN->generic.content[
 216                                         cur_line])->which_element.source.line,
 217                                 &src_line[offset]);
 218                       else
 219                         ((struct tui_win_element *)
 220                          TUI_SRC_WIN->generic.content[
 221                           cur_line])->which_element.source.line[0] = (char) 0;
 222                       cur_line++;
 223                       cur_line_no++;
 224                     }
 225                   if (offset > 0)
 226                     xfree (src_line);
 227                   fclose (stream);
 228                   TUI_SRC_WIN->generic.content_size = nlines;
 229                   ret = TUI_SUCCESS;
 230                 }
 231             }
 232         }
 233     }
 234   return ret;
 235 }
 236
 237
 238 /* elz: This function sets the contents of the source window to empty
 239    except for a line in the middle with a warning message about the
 240    source not being available.  This function is called by
 241    tui_erase_source_contents(), which in turn is invoked when the
 242    source files cannot be accessed.  */
 243
 244 void
 245 tui_set_source_content_nil (struct tui_win_info *win_info,
 246                             char *warning_string)
 247 {
 248   int line_width;
 249   int n_lines;
 250   int curr_line = 0;
 251
 252   line_width = win_info->generic.width - 1;
 253   n_lines = win_info->generic.height - 2;
 254
 255   /* Set to empty each line in the window, except for the one which
 256      contains the message.  */
 257   while (curr_line < win_info->generic.content_size)
 258     {
 259       /* Set the information related to each displayed line to null:
 260          i.e. the line number is 0, there is no bp, it is not where
 261          the program is stopped.  */
 262
 263       struct tui_win_element *element =
 264         (struct tui_win_element *) win_info->generic.content[curr_line];
 265       element->which_element.source.line_or_addr.loa = LOA_LINE;
 266       element->which_element.source.line_or_addr.u.line_no = 0;
 267       element->which_element.source.is_exec_point = FALSE;
 268       element->which_element.source.has_break = FALSE;
 269
 270       /* Set the contents of the line to blank.  */
 271       element->which_element.source.line[0] = (char) 0;
 272
 273       /* If the current line is in the middle of the screen, then we
 274          want to display the 'no source available' message in it.
 275          Note: the 'weird' arithmetic with the line width and height
 276          comes from the function tui_erase_source_content().  We need
 277          to keep the screen and the window's actual contents in
 278          synch.  */
 279
 280       if (curr_line == (n_lines / 2 + 1))
 281         {
 282           int i;
 283           int xpos;
 284           int warning_length = strlen (warning_string);
 285           char *src_line;
 286
 287           src_line = element->which_element.source.line;
 288
 289           if (warning_length >= ((line_width - 1) / 2))
 290             xpos = 1;
 291           else
 292             xpos = (line_width - 1) / 2 - warning_length;
 293
 294           for (i = 0; i < xpos; i++)
 295             src_line[i] = ' ';
 296
 297           sprintf (src_line + i, "%s", warning_string);
 298
 299           for (i = xpos + warning_length; i < line_width; i++)
 300             src_line[i] = ' ';
 301
 302           src_line[i] = '\n';
 303
 304         }                       /* end if */
 305
 306       curr_line++;
 307
 308     }                           /* end while */
 309 }
 310
 311
 312 /* Function to display source in the source window.  This function
 313    initializes the horizontal scroll to 0.  */
 314 void
 315 tui_show_symtab_source (struct symtab *s,
 316                         struct tui_line_or_address line,
 317                         int noerror)
 318 {
 319   TUI_SRC_WIN->detail.source_info.horizontal_offset = 0;
 320   tui_update_source_window_as_is (TUI_SRC_WIN, s, line, noerror);
 321 }
 322
 323
 324 /* Answer whether the source is currently displayed in the source
 325    window.  */
 326 int
 327 tui_source_is_displayed (char *fname)
 328 {
 329   return (TUI_SRC_WIN->generic.content_in_use &&
 330           (strcmp (((struct tui_win_element *) (tui_locator_win_info_ptr ())->
 331                   content[0])->which_element.locator.file_name, fname) == 0));
 332 }
 333
 334
 335 /* Scroll the source forward or backward vertically.  */
 336 void
 337 tui_vertical_source_scroll (enum tui_scroll_direction scroll_direction,
 338                             int num_to_scroll)
 339 {
 340   if (TUI_SRC_WIN->generic.content != NULL)
 341     {
 342       struct tui_line_or_address l;
 343       struct symtab *s;
 344       tui_win_content content = (tui_win_content) TUI_SRC_WIN->generic.content;
 345       struct symtab_and_line cursal = get_current_source_symtab_and_line ();
 346
 347       if (cursal.symtab == (struct symtab *) NULL)
 348         s = find_pc_symtab (get_frame_pc (get_selected_frame (NULL)));
 349       else
 350         s = cursal.symtab;
 351
 352       l.loa = LOA_LINE;
 353       if (scroll_direction == FORWARD_SCROLL)
 354         {
 355           l.u.line_no = content[0]->which_element.source.line_or_addr.u.line_no
 356             + num_to_scroll;
 357           if (l.u.line_no > s->nlines)
 358             /* line = s->nlines - win_info->generic.content_size + 1; */
 359             /* elz: fix for dts 23398.  */
 360             l.u.line_no = content[0]->which_element.source.line_or_addr.u.line_no;
 361         }
 362       else
 363         {
 364           l.u.line_no = content[0]->which_element.source.line_or_addr.u.line_no
 365             - num_to_scroll;
 366           if (l.u.line_no <= 0)
 367             l.u.line_no = 1;
 368         }
 369
 370       print_source_lines (s, l.u.line_no, l.u.line_no + 1, 0);
 371     }
 372 }