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