xref: /dragonfly/contrib/gdb-7/gdb/tui/tui-source.c (revision e65bc1c3)
1 /* TUI display source window.
2 
3    Copyright (C) 1998-2004, 2007-2012 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 "source.h"
28 #include "symtab.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-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
94 		    = tui_locator_win_info_ptr ();
95                   struct tui_source_info *src
96 		    = &TUI_SRC_WIN->detail.source_info;
97 
98                   if (TUI_SRC_WIN->generic.title)
99                     xfree (TUI_SRC_WIN->generic.title);
100                   TUI_SRC_WIN->generic.title = xstrdup (s->filename);
101 
102                   if (src->filename)
103                     xfree (src->filename);
104                   src->filename = xstrdup (s->filename);
105 
106 		  /* Determine the threshold for the length of the
107                      line and the offset to start the display.  */
108 		  offset = src->horizontal_offset;
109 		  threshold = (line_width - 1) + offset;
110 		  stream = fdopen (desc, FOPEN_RT);
111 		  clearerr (stream);
112 		  cur_line = 0;
113 		  src->gdbarch = get_objfile_arch (s->objfile);
114 		  src->start_line_or_addr.loa = LOA_LINE;
115 		  cur_line_no = src->start_line_or_addr.u.line_no = line_no;
116 		  if (offset > 0)
117 		    src_line = (char *) xmalloc (
118 					   (threshold + 1) * sizeof (char));
119 		  while (cur_line < nlines)
120 		    {
121 		      struct tui_win_element *element
122 			= (struct tui_win_element *)
123 			TUI_SRC_WIN->generic.content[cur_line];
124 
125 		      /* Get the first character in the line.  */
126 		      c = fgetc (stream);
127 
128 		      if (offset == 0)
129 			src_line = ((struct tui_win_element *)
130 				   TUI_SRC_WIN->generic.content[
131 					cur_line])->which_element.source.line;
132 		      /* Init the line with the line number.  */
133 		      sprintf (src_line, "%-6d", cur_line_no);
134 		      cur_len = strlen (src_line);
135 		      i = cur_len - ((cur_len / tui_default_tab_len ())
136 				     * tui_default_tab_len ());
137 		      while (i < tui_default_tab_len ())
138 			{
139 			  src_line[cur_len] = ' ';
140 			  i++;
141 			  cur_len++;
142 			}
143 		      src_line[cur_len] = (char) 0;
144 
145 		      /* Set whether element is the execution point
146 		         and whether there is a break point on it.  */
147 		      element->which_element.source.line_or_addr.loa =
148 			LOA_LINE;
149 		      element->which_element.source.line_or_addr.u.line_no =
150 			cur_line_no;
151 		      element->which_element.source.is_exec_point =
152 			(filename_cmp (((struct tui_win_element *)
153 				       locator->content[0])->which_element.locator.file_name,
154 				       s->filename) == 0
155 			 && cur_line_no == ((struct tui_win_element *)
156 					    locator->content[0])->which_element.locator.line_no);
157 		      if (c != EOF)
158 			{
159 			  i = strlen (src_line) - 1;
160 			  do
161 			    {
162 			      if ((c != '\n') && (c != '\r')
163 				  && (++i < threshold))
164 				{
165 				  if (c < 040 && c != '\t')
166 				    {
167 				      src_line[i++] = '^';
168 				      src_line[i] = c + 0100;
169 				    }
170 				  else if (c == 0177)
171 				    {
172 				      src_line[i++] = '^';
173 				      src_line[i] = '?';
174 				    }
175 				  else
176 				    { /* Store the charcter in the
177 					 line buffer.  If it is a tab,
178 					 then translate to the correct
179 					 number of chars so we don't
180 					 overwrite our buffer.  */
181 				      if (c == '\t')
182 					{
183 					  int j, max_tab_len
184 					    = tui_default_tab_len ();
185 
186 					  for (j = i - ((i / max_tab_len)
187 							* max_tab_len);
188 					       j < max_tab_len
189 						 && i < threshold;
190 					       i++, j++)
191 					    src_line[i] = ' ';
192 					  i--;
193 					}
194 				      else
195 					src_line[i] = c;
196 				    }
197 				  src_line[i + 1] = 0;
198 				}
199 			      else
200 				{ /* If we have not reached EOL, then
201 				     eat chars until we do.  */
202 				  while (c != EOF && c != '\n' && c != '\r')
203 				    c = fgetc (stream);
204 				  /* Handle non-'\n' end-of-line.  */
205 				  if (c == '\r'
206 				      && (c = fgetc (stream)) != '\n'
207 				      && c != EOF)
208 				    {
209 				       ungetc (c, stream);
210 				       c = '\r';
211 				    }
212 
213 				}
214 			    }
215 			  while (c != EOF && c != '\n' && c != '\r'
216 				 && i < threshold
217 				 && (c = fgetc (stream)));
218 			}
219 		      /* Now copy the line taking the offset into
220 			 account.  */
221 		      if (strlen (src_line) > offset)
222 			strcpy (((struct tui_win_element *)
223 				 TUI_SRC_WIN->generic.content[cur_line])->which_element.source.line,
224 				&src_line[offset]);
225 		      else
226 			((struct tui_win_element *)
227 			 TUI_SRC_WIN->generic.content[
228 			  cur_line])->which_element.source.line[0] = (char) 0;
229 		      cur_line++;
230 		      cur_line_no++;
231 		    }
232 		  if (offset > 0)
233 		    xfree (src_line);
234 		  fclose (stream);
235 		  TUI_SRC_WIN->generic.content_size = nlines;
236 		  ret = TUI_SUCCESS;
237 		}
238 	    }
239 	}
240     }
241   return ret;
242 }
243 
244 
245 /* elz: This function sets the contents of the source window to empty
246    except for a line in the middle with a warning message about the
247    source not being available.  This function is called by
248    tui_erase_source_contents(), which in turn is invoked when the
249    source files cannot be accessed.  */
250 
251 void
252 tui_set_source_content_nil (struct tui_win_info *win_info,
253 			    char *warning_string)
254 {
255   int line_width;
256   int n_lines;
257   int curr_line = 0;
258 
259   line_width = win_info->generic.width - 1;
260   n_lines = win_info->generic.height - 2;
261 
262   /* Set to empty each line in the window, except for the one which
263      contains the message.  */
264   while (curr_line < win_info->generic.content_size)
265     {
266       /* Set the information related to each displayed line to null:
267          i.e. the line number is 0, there is no bp, it is not where
268          the program is stopped.  */
269 
270       struct tui_win_element *element =
271 	(struct tui_win_element *) win_info->generic.content[curr_line];
272 
273       element->which_element.source.line_or_addr.loa = LOA_LINE;
274       element->which_element.source.line_or_addr.u.line_no = 0;
275       element->which_element.source.is_exec_point = FALSE;
276       element->which_element.source.has_break = FALSE;
277 
278       /* Set the contents of the line to blank.  */
279       element->which_element.source.line[0] = (char) 0;
280 
281       /* If the current line is in the middle of the screen, then we
282          want to display the 'no source available' message in it.
283          Note: the 'weird' arithmetic with the line width and height
284          comes from the function tui_erase_source_content().  We need
285          to keep the screen and the window's actual contents in
286          synch.  */
287 
288       if (curr_line == (n_lines / 2 + 1))
289 	{
290 	  int i;
291 	  int xpos;
292 	  int warning_length = strlen (warning_string);
293 	  char *src_line;
294 
295 	  src_line = element->which_element.source.line;
296 
297 	  if (warning_length >= ((line_width - 1) / 2))
298 	    xpos = 1;
299 	  else
300 	    xpos = (line_width - 1) / 2 - warning_length;
301 
302 	  for (i = 0; i < xpos; i++)
303 	    src_line[i] = ' ';
304 
305 	  sprintf (src_line + i, "%s", warning_string);
306 
307 	  for (i = xpos + warning_length; i < line_width; i++)
308 	    src_line[i] = ' ';
309 
310 	  src_line[i] = '\n';
311 
312 	}			/* end if */
313 
314       curr_line++;
315 
316     }				/* end while */
317 }
318 
319 
320 /* Function to display source in the source window.  This function
321    initializes the horizontal scroll to 0.  */
322 void
323 tui_show_symtab_source (struct gdbarch *gdbarch, struct symtab *s,
324 			struct tui_line_or_address line,
325 			int noerror)
326 {
327   TUI_SRC_WIN->detail.source_info.horizontal_offset = 0;
328   tui_update_source_window_as_is (TUI_SRC_WIN, gdbarch, s, line, noerror);
329 }
330 
331 
332 /* Answer whether the source is currently displayed in the source
333    window.  */
334 int
335 tui_source_is_displayed (char *fname)
336 {
337   return (TUI_SRC_WIN->generic.content_in_use
338 	  && (filename_cmp (((struct tui_win_element *)
339 			     (tui_locator_win_info_ptr ())->
340 			     content[0])->which_element.locator.file_name,
341 			    fname) == 0));
342 }
343 
344 
345 /* Scroll the source forward or backward vertically.  */
346 void
347 tui_vertical_source_scroll (enum tui_scroll_direction scroll_direction,
348 			    int num_to_scroll)
349 {
350   if (TUI_SRC_WIN->generic.content != NULL)
351     {
352       struct tui_line_or_address l;
353       struct symtab *s;
354       tui_win_content content = (tui_win_content) TUI_SRC_WIN->generic.content;
355       struct symtab_and_line cursal = get_current_source_symtab_and_line ();
356 
357       if (cursal.symtab == (struct symtab *) NULL)
358 	s = find_pc_symtab (get_frame_pc (get_selected_frame (NULL)));
359       else
360 	s = cursal.symtab;
361 
362       l.loa = LOA_LINE;
363       if (scroll_direction == FORWARD_SCROLL)
364 	{
365 	  l.u.line_no = content[0]->which_element.source.line_or_addr.u.line_no
366 	    + num_to_scroll;
367 	  if (l.u.line_no > s->nlines)
368 	    /* line = s->nlines - win_info->generic.content_size + 1; */
369 	    /* elz: fix for dts 23398.  */
370 	    l.u.line_no
371 	      = content[0]->which_element.source.line_or_addr.u.line_no;
372 	}
373       else
374 	{
375 	  l.u.line_no = content[0]->which_element.source.line_or_addr.u.line_no
376 	    - num_to_scroll;
377 	  if (l.u.line_no <= 0)
378 	    l.u.line_no = 1;
379 	}
380 
381       print_source_lines (s, l.u.line_no, l.u.line_no + 1, 0);
382     }
383 }
384