1 /* List lines of source files for GDB, the GNU debugger.
2 Copyright (C) 1986-2013 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include "arch-utils.h"
22 #include "expression.h"
29 #include "gdb_assert.h"
30 #include "filestuff.h"
32 #include <sys/types.h>
33 #include "gdb_string.h"
37 #include "gdb_regex.h"
43 #include "filenames.h" /* for DOSish file names */
44 #include "completer.h"
46 #include "readline/readline.h"
51 #define OPEN_MODE (O_RDONLY | O_BINARY)
52 #define FDOPEN_MODE FOPEN_RB
54 /* Prototypes for exported functions. */
56 void _initialize_source (void);
58 /* Prototypes for local functions. */
60 static int get_filename_and_charpos (struct symtab
*, char **);
62 static void reverse_search_command (char *, int);
64 static void forward_search_command (char *, int);
66 static void line_info (char *, int);
68 static void source_info (char *, int);
70 /* Path of directories to search for source files.
71 Same format as the PATH environment variable's value. */
75 /* Support for source path substitution commands. */
77 struct substitute_path_rule
81 struct substitute_path_rule
*next
;
84 static struct substitute_path_rule
*substitute_path_rules
= NULL
;
86 /* Symtab of default file for listing lines of. */
88 static struct symtab
*current_source_symtab
;
90 /* Default next line to list. */
92 static int current_source_line
;
94 static struct program_space
*current_source_pspace
;
96 /* Default number of lines to print with commands like "list".
97 This is based on guessing how many long (i.e. more than chars_per_line
98 characters) lines there will be. To be completely correct, "list"
99 and friends should be rewritten to count characters and see where
100 things are wrapping, but that would be a fair amount of work. */
102 int lines_to_list
= 10;
104 show_lines_to_list (struct ui_file
*file
, int from_tty
,
105 struct cmd_list_element
*c
, const char *value
)
107 fprintf_filtered (file
,
108 _("Number of source lines gdb "
109 "will list by default is %s.\n"),
113 /* Possible values of 'set filename-display'. */
114 static const char filename_display_basename
[] = "basename";
115 static const char filename_display_relative
[] = "relative";
116 static const char filename_display_absolute
[] = "absolute";
118 static const char *const filename_display_kind_names
[] = {
119 filename_display_basename
,
120 filename_display_relative
,
121 filename_display_absolute
,
125 static const char *filename_display_string
= filename_display_relative
;
128 show_filename_display_string (struct ui_file
*file
, int from_tty
,
129 struct cmd_list_element
*c
, const char *value
)
131 fprintf_filtered (file
, _("Filenames are displayed as \"%s\".\n"), value
);
134 /* Line number of last line printed. Default for various commands.
135 current_source_line is usually, but not always, the same as this. */
137 static int last_line_listed
;
139 /* First line number listed by last listing command. */
141 static int first_line_listed
;
143 /* Saves the name of the last source file visited and a possible error code.
144 Used to prevent repeating annoying "No such file or directories" msgs. */
146 static struct symtab
*last_source_visited
= NULL
;
147 static int last_source_error
= 0;
149 /* Return the first line listed by print_source_lines.
150 Used by command interpreters to request listing from
154 get_first_line_listed (void)
156 return first_line_listed
;
159 /* Return the default number of lines to print with commands like the
160 cli "list". The caller of print_source_lines must use this to
161 calculate the end line and use it in the call to print_source_lines
162 as it does not automatically use this value. */
165 get_lines_to_list (void)
167 return lines_to_list
;
170 /* Return the current source file for listing and next line to list.
171 NOTE: The returned sal pc and end fields are not valid. */
173 struct symtab_and_line
174 get_current_source_symtab_and_line (void)
176 struct symtab_and_line cursal
= { 0 };
178 cursal
.pspace
= current_source_pspace
;
179 cursal
.symtab
= current_source_symtab
;
180 cursal
.line
= current_source_line
;
187 /* If the current source file for listing is not set, try and get a default.
188 Usually called before get_current_source_symtab_and_line() is called.
189 It may err out if a default cannot be determined.
190 We must be cautious about where it is called, as it can recurse as the
191 process of determining a new default may call the caller!
192 Use get_current_source_symtab_and_line only to get whatever
193 we have without erroring out or trying to get a default. */
196 set_default_source_symtab_and_line (void)
198 if (!have_full_symbols () && !have_partial_symbols ())
199 error (_("No symbol table is loaded. Use the \"file\" command."));
201 /* Pull in a current source symtab if necessary. */
202 if (current_source_symtab
== 0)
203 select_source_symtab (0);
206 /* Return the current default file for listing and next line to list
207 (the returned sal pc and end fields are not valid.)
208 and set the current default to whatever is in SAL.
209 NOTE: The returned sal pc and end fields are not valid. */
211 struct symtab_and_line
212 set_current_source_symtab_and_line (const struct symtab_and_line
*sal
)
214 struct symtab_and_line cursal
= { 0 };
216 cursal
.pspace
= current_source_pspace
;
217 cursal
.symtab
= current_source_symtab
;
218 cursal
.line
= current_source_line
;
222 current_source_pspace
= sal
->pspace
;
223 current_source_symtab
= sal
->symtab
;
224 current_source_line
= sal
->line
;
229 /* Reset any information stored about a default file and line to print. */
232 clear_current_source_symtab_and_line (void)
234 current_source_symtab
= 0;
235 current_source_line
= 0;
238 /* Set the source file default for the "list" command to be S.
240 If S is NULL, and we don't have a default, find one. This
241 should only be called when the user actually tries to use the
242 default, since we produce an error if we can't find a reasonable
243 default. Also, since this can cause symbols to be read, doing it
244 before we need to would make things slower than necessary. */
247 select_source_symtab (struct symtab
*s
)
249 struct symtabs_and_lines sals
;
250 struct symtab_and_line sal
;
255 current_source_symtab
= s
;
256 current_source_line
= 1;
257 current_source_pspace
= SYMTAB_PSPACE (s
);
261 if (current_source_symtab
)
264 /* Make the default place to list be the function `main'
266 if (lookup_symbol (main_name (), 0, VAR_DOMAIN
, 0))
268 sals
= decode_line_with_current_source (main_name (),
269 DECODE_LINE_FUNFIRSTLINE
);
272 current_source_pspace
= sal
.pspace
;
273 current_source_symtab
= sal
.symtab
;
274 current_source_line
= max (sal
.line
- (lines_to_list
- 1), 1);
275 if (current_source_symtab
)
279 /* Alright; find the last file in the symtab list (ignoring .h's
280 and namespace symtabs). */
282 current_source_line
= 1;
286 for (s
= ofp
->symtabs
; s
; s
= s
->next
)
288 const char *name
= s
->filename
;
289 int len
= strlen (name
);
291 if (!(len
> 2 && (strcmp (&name
[len
- 2], ".h") == 0
292 || strcmp (name
, "<<C++-namespaces>>") == 0)))
294 current_source_pspace
= current_program_space
;
295 current_source_symtab
= s
;
300 if (current_source_symtab
)
306 s
= ofp
->sf
->qf
->find_last_source_symtab (ofp
);
308 current_source_symtab
= s
;
310 if (current_source_symtab
)
313 error (_("Can't find a default source file"));
316 /* Handler for "set directories path-list" command.
317 "set dir mumble" doesn't prepend paths, it resets the entire
318 path list. The theory is that set(show(dir)) should be a no-op. */
321 set_directories_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
323 /* This is the value that was set.
324 It needs to be processed to maintain $cdir:$cwd and remove dups. */
325 char *set_path
= source_path
;
327 /* We preserve the invariant that $cdir:$cwd begins life at the end of
328 the list by calling init_source_path. If they appear earlier in
329 SET_PATH then mod_path will move them appropriately.
330 mod_path will also remove duplicates. */
332 if (*set_path
!= '\0')
333 mod_path (set_path
, &source_path
);
338 /* Print the list of source directories.
339 This is used by the "ld" command, so it has the signature of a command
343 show_directories_1 (char *ignore
, int from_tty
)
345 puts_filtered ("Source directories searched: ");
346 puts_filtered (source_path
);
347 puts_filtered ("\n");
350 /* Handler for "show directories" command. */
353 show_directories_command (struct ui_file
*file
, int from_tty
,
354 struct cmd_list_element
*c
, const char *value
)
356 show_directories_1 (NULL
, from_tty
);
359 /* Forget line positions and file names for the symtabs in a
360 particular objfile. */
363 forget_cached_source_info_for_objfile (struct objfile
*objfile
)
367 ALL_OBJFILE_SYMTABS (objfile
, s
)
369 if (s
->line_charpos
!= NULL
)
371 xfree (s
->line_charpos
);
372 s
->line_charpos
= NULL
;
374 if (s
->fullname
!= NULL
)
382 objfile
->sf
->qf
->forget_cached_source_info (objfile
);
385 /* Forget what we learned about line positions in source files, and
386 which directories contain them; must check again now since files
387 may be found in a different directory now. */
390 forget_cached_source_info (void)
392 struct program_space
*pspace
;
393 struct objfile
*objfile
;
396 ALL_PSPACE_OBJFILES (pspace
, objfile
)
398 forget_cached_source_info_for_objfile (objfile
);
401 last_source_visited
= NULL
;
405 init_source_path (void)
409 xsnprintf (buf
, sizeof (buf
), "$cdir%c$cwd", DIRNAME_SEPARATOR
);
410 source_path
= xstrdup (buf
);
411 forget_cached_source_info ();
414 /* Add zero or more directories to the front of the source path. */
417 directory_command (char *dirname
, int from_tty
)
420 /* FIXME, this goes to "delete dir"... */
423 if (!from_tty
|| query (_("Reinitialize source path to empty? ")))
431 mod_path (dirname
, &source_path
);
432 forget_cached_source_info ();
435 show_directories_1 ((char *) 0, from_tty
);
438 /* Add a path given with the -d command line switch.
439 This will not be quoted so we must not treat spaces as separators. */
442 directory_switch (char *dirname
, int from_tty
)
444 add_path (dirname
, &source_path
, 0);
447 /* Add zero or more directories to the front of an arbitrary path. */
450 mod_path (char *dirname
, char **which_path
)
452 add_path (dirname
, which_path
, 1);
455 /* Workhorse of mod_path. Takes an extra argument to determine
456 if dirname should be parsed for separators that indicate multiple
457 directories. This allows for interfaces that pre-parse the dirname
458 and allow specification of traditional separator characters such
462 add_path (char *dirname
, char **which_path
, int parse_separators
)
464 char *old
= *which_path
;
466 VEC (char_ptr
) *dir_vec
= NULL
;
467 struct cleanup
*back_to
;
474 if (parse_separators
)
476 char **argv
, **argvp
;
478 /* This will properly parse the space and tab separators
479 and any quotes that may exist. */
480 argv
= gdb_buildargv (dirname
);
482 for (argvp
= argv
; *argvp
; argvp
++)
483 dirnames_to_char_ptr_vec_append (&dir_vec
, *argvp
);
488 VEC_safe_push (char_ptr
, dir_vec
, xstrdup (dirname
));
489 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
491 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, name
); ++ix
)
496 /* Spaces and tabs will have been removed by buildargv().
497 NAME is the start of the directory.
498 P is the '\0' following the end. */
499 p
= name
+ strlen (name
);
501 while (!(IS_DIR_SEPARATOR (*name
) && p
<= name
+ 1) /* "/" */
502 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
503 /* On MS-DOS and MS-Windows, h:\ is different from h: */
504 && !(p
== name
+ 3 && name
[1] == ':') /* "d:/" */
506 && IS_DIR_SEPARATOR (p
[-1]))
507 /* Sigh. "foo/" => "foo" */
511 while (p
> name
&& p
[-1] == '.')
515 /* "." => getwd (). */
516 name
= current_directory
;
519 else if (p
> name
+ 1 && IS_DIR_SEPARATOR (p
[-2]))
529 /* "...foo/." => "...foo". */
540 name
= tilde_expand (name
);
541 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
542 else if (IS_ABSOLUTE_PATH (name
) && p
== name
+ 2) /* "d:" => "d:." */
543 name
= concat (name
, ".", (char *)NULL
);
545 else if (!IS_ABSOLUTE_PATH (name
) && name
[0] != '$')
546 name
= concat (current_directory
, SLASH_STRING
, name
, (char *)NULL
);
548 name
= savestring (name
, p
- name
);
549 make_cleanup (xfree
, name
);
551 /* Unless it's a variable, check existence. */
554 /* These are warnings, not errors, since we don't want a
555 non-existent directory in a .gdbinit file to stop processing
556 of the .gdbinit file.
558 Whether they get added to the path is more debatable. Current
559 answer is yes, in case the user wants to go make the directory
560 or whatever. If the directory continues to not exist/not be
561 a directory/etc, then having them in the path should be
563 if (stat (name
, &st
) < 0)
565 int save_errno
= errno
;
567 fprintf_unfiltered (gdb_stderr
, "Warning: ");
568 print_sys_errmsg (name
, save_errno
);
570 else if ((st
.st_mode
& S_IFMT
) != S_IFDIR
)
571 warning (_("%s is not a directory."), name
);
576 unsigned int len
= strlen (name
);
580 /* FIXME: we should use realpath() or its work-alike
581 before comparing. Then all the code above which
582 removes excess slashes and dots could simply go away. */
583 if (!filename_cmp (p
, name
))
585 /* Found it in the search path, remove old copy. */
587 p
--; /* Back over leading separator. */
588 if (prefix
> p
- *which_path
)
589 goto skip_dup
; /* Same dir twice in one cmd. */
590 memmove (p
, &p
[len
+ 1], strlen (&p
[len
+ 1]) + 1); /* Copy from next \0 or : */
593 tinybuf
[0] = DIRNAME_SEPARATOR
;
596 /* If we have already tacked on a name(s) in this command,
597 be sure they stay on the front as we tack on some
605 temp
= concat (old
, tinybuf
, name
, (char *)NULL
);
607 *which_path
= concat (temp
, "", &old
[prefix
], (char *) NULL
);
608 prefix
= strlen (temp
);
613 *which_path
= concat (name
, (old
[0] ? tinybuf
: old
),
615 prefix
= strlen (name
);
624 do_cleanups (back_to
);
629 source_info (char *ignore
, int from_tty
)
631 struct symtab
*s
= current_source_symtab
;
635 printf_filtered (_("No current source file.\n"));
638 printf_filtered (_("Current source file is %s\n"), s
->filename
);
640 printf_filtered (_("Compilation directory is %s\n"), s
->dirname
);
642 printf_filtered (_("Located in %s\n"), s
->fullname
);
644 printf_filtered (_("Contains %d line%s.\n"), s
->nlines
,
645 s
->nlines
== 1 ? "" : "s");
647 printf_filtered (_("Source language is %s.\n"), language_str (s
->language
));
648 printf_filtered (_("Compiled with %s debugging format.\n"), s
->debugformat
);
649 printf_filtered (_("%s preprocessor macro info.\n"),
650 s
->macro_table
? "Includes" : "Does not include");
654 /* Return True if the file NAME exists and is a regular file. */
656 is_regular_file (const char *name
)
659 const int status
= stat (name
, &st
);
661 /* Stat should never fail except when the file does not exist.
662 If stat fails, analyze the source of error and return True
663 unless the file does not exist, to avoid returning false results
664 on obscure systems where stat does not work as expected. */
667 return (errno
!= ENOENT
);
669 return S_ISREG (st
.st_mode
);
672 /* Open a file named STRING, searching path PATH (dir names sep by some char)
673 using mode MODE in the calls to open. You cannot use this function to
674 create files (O_CREAT).
676 OPTS specifies the function behaviour in specific cases.
678 If OPF_TRY_CWD_FIRST, try to open ./STRING before searching PATH.
679 (ie pretend the first element of PATH is "."). This also indicates
680 that a slash in STRING disables searching of the path (this is
681 so that "exec-file ./foo" or "symbol-file ./foo" insures that you
682 get that particular version of foo or an error message).
684 If OPTS has OPF_SEARCH_IN_PATH set, absolute names will also be
685 searched in path (we usually want this for source files but not for
688 If FILENAME_OPENED is non-null, set it to a newly allocated string naming
689 the actual file opened (this string will always start with a "/"). We
690 have to take special pains to avoid doubling the "/" between the directory
691 and the file, sigh! Emacs gets confuzzed by this when we print the
694 If a file is found, return the descriptor.
695 Otherwise, return -1, with errno set for the last name we tried to open. */
697 /* >>>> This should only allow files of certain types,
698 >>>> eg executable, non-directory. */
700 openp (const char *path
, int opts
, const char *string
,
701 int mode
, char **filename_opened
)
706 VEC (char_ptr
) *dir_vec
;
707 struct cleanup
*back_to
;
711 /* The open syscall MODE parameter is not specified. */
712 gdb_assert ((mode
& O_CREAT
) == 0);
713 gdb_assert (string
!= NULL
);
715 /* A file with an empty name cannot possibly exist. Report a failure
716 without further checking.
718 This is an optimization which also defends us against buggy
719 implementations of the "stat" function. For instance, we have
720 noticed that a MinGW debugger built on Windows XP 32bits crashes
721 when the debugger is started with an empty argument. */
722 if (string
[0] == '\0')
733 if ((opts
& OPF_TRY_CWD_FIRST
) || IS_ABSOLUTE_PATH (string
))
737 if (is_regular_file (string
))
739 filename
= alloca (strlen (string
) + 1);
740 strcpy (filename
, string
);
741 fd
= gdb_open_cloexec (filename
, mode
, 0);
751 if (!(opts
& OPF_SEARCH_IN_PATH
))
752 for (i
= 0; string
[i
]; i
++)
753 if (IS_DIR_SEPARATOR (string
[i
]))
757 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
758 if (HAS_DRIVE_SPEC (string
))
759 string
= STRIP_DRIVE_SPEC (string
);
761 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
762 while (IS_DIR_SEPARATOR(string
[0]))
766 while (string
[0] == '.' && IS_DIR_SEPARATOR (string
[1]))
769 alloclen
= strlen (path
) + strlen (string
) + 2;
770 filename
= alloca (alloclen
);
773 dir_vec
= dirnames_to_char_ptr_vec (path
);
774 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
776 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, dir
); ++ix
)
778 size_t len
= strlen (dir
);
780 if (strcmp (dir
, "$cwd") == 0)
782 /* Name is $cwd -- insert current directory name instead. */
785 /* First, realloc the filename buffer if too short. */
786 len
= strlen (current_directory
);
787 newlen
= len
+ strlen (string
) + 2;
788 if (newlen
> alloclen
)
791 filename
= alloca (alloclen
);
793 strcpy (filename
, current_directory
);
795 else if (strchr(dir
, '~'))
797 /* See whether we need to expand the tilde. */
799 char *tilde_expanded
;
801 tilde_expanded
= tilde_expand (dir
);
803 /* First, realloc the filename buffer if too short. */
804 len
= strlen (tilde_expanded
);
805 newlen
= len
+ strlen (string
) + 2;
806 if (newlen
> alloclen
)
809 filename
= alloca (alloclen
);
811 strcpy (filename
, tilde_expanded
);
812 xfree (tilde_expanded
);
816 /* Normal file name in path -- just use it. */
817 strcpy (filename
, dir
);
819 /* Don't search $cdir. It's also a magic path like $cwd, but we
820 don't have enough information to expand it. The user *could*
821 have an actual directory named '$cdir' but handling that would
822 be confusing, it would mean different things in different
823 contexts. If the user really has '$cdir' one can use './$cdir'.
824 We can get $cdir when loading scripts. When loading source files
825 $cdir must have already been expanded to the correct value. */
826 if (strcmp (dir
, "$cdir") == 0)
830 /* Remove trailing slashes. */
831 while (len
> 0 && IS_DIR_SEPARATOR (filename
[len
- 1]))
834 strcat (filename
+ len
, SLASH_STRING
);
835 strcat (filename
, string
);
837 if (is_regular_file (filename
))
839 fd
= gdb_open_cloexec (filename
, mode
, 0);
845 do_cleanups (back_to
);
850 /* If a file was opened, canonicalize its filename. */
852 *filename_opened
= NULL
;
853 else if (IS_ABSOLUTE_PATH (filename
))
854 *filename_opened
= gdb_realpath (filename
);
857 /* Beware the // my son, the Emacs barfs, the botch that catch... */
859 char *f
= concat (current_directory
,
860 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
862 filename
, (char *)NULL
);
864 *filename_opened
= gdb_realpath (f
);
873 /* This is essentially a convenience, for clients that want the behaviour
874 of openp, using source_path, but that really don't want the file to be
875 opened but want instead just to know what the full pathname is (as
876 qualified against source_path).
878 The current working directory is searched first.
880 If the file was found, this function returns 1, and FULL_PATHNAME is
881 set to the fully-qualified pathname.
883 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
885 source_full_path_of (const char *filename
, char **full_pathname
)
889 fd
= openp (source_path
, OPF_TRY_CWD_FIRST
| OPF_SEARCH_IN_PATH
, filename
,
890 O_RDONLY
, full_pathname
);
893 *full_pathname
= NULL
;
901 /* Return non-zero if RULE matches PATH, that is if the rule can be
905 substitute_path_rule_matches (const struct substitute_path_rule
*rule
,
908 const int from_len
= strlen (rule
->from
);
909 const int path_len
= strlen (path
);
912 if (path_len
< from_len
)
915 /* The substitution rules are anchored at the start of the path,
916 so the path should start with rule->from. There is no filename
917 comparison routine, so we need to extract the first FROM_LEN
918 characters from PATH first and use that to do the comparison. */
920 path_start
= alloca (from_len
+ 1);
921 strncpy (path_start
, path
, from_len
);
922 path_start
[from_len
] = '\0';
924 if (FILENAME_CMP (path_start
, rule
->from
) != 0)
927 /* Make sure that the region in the path that matches the substitution
928 rule is immediately followed by a directory separator (or the end of
929 string character). */
931 if (path
[from_len
] != '\0' && !IS_DIR_SEPARATOR (path
[from_len
]))
937 /* Find the substitute-path rule that applies to PATH and return it.
938 Return NULL if no rule applies. */
940 static struct substitute_path_rule
*
941 get_substitute_path_rule (const char *path
)
943 struct substitute_path_rule
*rule
= substitute_path_rules
;
945 while (rule
!= NULL
&& !substitute_path_rule_matches (rule
, path
))
951 /* If the user specified a source path substitution rule that applies
952 to PATH, then apply it and return the new path. This new path must
953 be deallocated afterwards.
955 Return NULL if no substitution rule was specified by the user,
956 or if no rule applied to the given PATH. */
959 rewrite_source_path (const char *path
)
961 const struct substitute_path_rule
*rule
= get_substitute_path_rule (path
);
968 from_len
= strlen (rule
->from
);
970 /* Compute the rewritten path and return it. */
973 (char *) xmalloc (strlen (path
) + 1 + strlen (rule
->to
) - from_len
);
974 strcpy (new_path
, rule
->to
);
975 strcat (new_path
, path
+ from_len
);
981 find_and_open_source (const char *filename
,
985 char *path
= source_path
;
988 struct cleanup
*cleanup
;
990 /* Quick way out if we already know its full name. */
994 /* The user may have requested that source paths be rewritten
995 according to substitution rules he provided. If a substitution
996 rule applies to this path, then apply it. */
997 char *rewritten_fullname
= rewrite_source_path (*fullname
);
999 if (rewritten_fullname
!= NULL
)
1002 *fullname
= rewritten_fullname
;
1005 result
= gdb_open_cloexec (*fullname
, OPEN_MODE
, 0);
1008 char *lpath
= gdb_realpath (*fullname
);
1015 /* Didn't work -- free old one, try again. */
1020 cleanup
= make_cleanup (null_cleanup
, NULL
);
1022 if (dirname
!= NULL
)
1024 /* If necessary, rewrite the compilation directory name according
1025 to the source path substitution rules specified by the user. */
1027 char *rewritten_dirname
= rewrite_source_path (dirname
);
1029 if (rewritten_dirname
!= NULL
)
1031 make_cleanup (xfree
, rewritten_dirname
);
1032 dirname
= rewritten_dirname
;
1035 /* Replace a path entry of $cdir with the compilation directory
1038 /* We cast strstr's result in case an ANSIhole has made it const,
1039 which produces a "required warning" when assigned to a nonconst. */
1040 p
= (char *) strstr (source_path
, "$cdir");
1041 if (p
&& (p
== path
|| p
[-1] == DIRNAME_SEPARATOR
)
1042 && (p
[cdir_len
] == DIRNAME_SEPARATOR
|| p
[cdir_len
] == '\0'))
1047 alloca (strlen (source_path
) + 1 + strlen (dirname
) + 1);
1048 len
= p
- source_path
;
1049 strncpy (path
, source_path
, len
); /* Before $cdir */
1050 strcpy (path
+ len
, dirname
); /* new stuff */
1051 strcat (path
+ len
, source_path
+ len
+ cdir_len
); /* After
1056 if (IS_ABSOLUTE_PATH (filename
))
1058 /* If filename is absolute path, try the source path
1059 substitution on it. */
1060 char *rewritten_filename
= rewrite_source_path (filename
);
1062 if (rewritten_filename
!= NULL
)
1064 make_cleanup (xfree
, rewritten_filename
);
1065 filename
= rewritten_filename
;
1069 result
= openp (path
, OPF_SEARCH_IN_PATH
, filename
, OPEN_MODE
, fullname
);
1072 /* Didn't work. Try using just the basename. */
1073 p
= lbasename (filename
);
1075 result
= openp (path
, OPF_SEARCH_IN_PATH
, p
, OPEN_MODE
, fullname
);
1078 do_cleanups (cleanup
);
1082 /* Open a source file given a symtab S. Returns a file descriptor or
1083 negative number for error.
1085 This function is a convience function to find_and_open_source. */
1088 open_source_file (struct symtab
*s
)
1093 return find_and_open_source (s
->filename
, s
->dirname
, &s
->fullname
);
1096 /* Finds the fullname that a symtab represents.
1098 This functions finds the fullname and saves it in s->fullname.
1099 It will also return the value.
1101 If this function fails to find the file that this symtab represents,
1102 the expected fullname is used. Therefore the files does not have to
1106 symtab_to_fullname (struct symtab
*s
)
1108 /* Use cached copy if we have it.
1109 We rely on forget_cached_source_info being called appropriately
1110 to handle cases like the file being moved. */
1111 if (s
->fullname
== NULL
)
1113 int fd
= find_and_open_source (s
->filename
, s
->dirname
, &s
->fullname
);
1120 struct cleanup
*back_to
;
1122 /* rewrite_source_path would be applied by find_and_open_source, we
1123 should report the pathname where GDB tried to find the file. */
1125 if (s
->dirname
== NULL
|| IS_ABSOLUTE_PATH (s
->filename
))
1126 fullname
= xstrdup (s
->filename
);
1128 fullname
= concat (s
->dirname
, SLASH_STRING
, s
->filename
, NULL
);
1130 back_to
= make_cleanup (xfree
, fullname
);
1131 s
->fullname
= rewrite_source_path (fullname
);
1132 if (s
->fullname
== NULL
)
1133 s
->fullname
= xstrdup (fullname
);
1134 do_cleanups (back_to
);
1141 /* See commentary in source.h. */
1144 symtab_to_filename_for_display (struct symtab
*symtab
)
1146 if (filename_display_string
== filename_display_basename
)
1147 return lbasename (symtab
->filename
);
1148 else if (filename_display_string
== filename_display_absolute
)
1149 return symtab_to_fullname (symtab
);
1150 else if (filename_display_string
== filename_display_relative
)
1151 return symtab
->filename
;
1153 internal_error (__FILE__
, __LINE__
, _("invalid filename_display_string"));
1156 /* Create and initialize the table S->line_charpos that records
1157 the positions of the lines in the source file, which is assumed
1158 to be open on descriptor DESC.
1159 All set S->nlines to the number of such lines. */
1162 find_source_lines (struct symtab
*s
, int desc
)
1165 char *data
, *p
, *end
;
1167 int lines_allocated
= 1000;
1173 line_charpos
= (int *) xmalloc (lines_allocated
* sizeof (int));
1174 if (fstat (desc
, &st
) < 0)
1175 perror_with_name (symtab_to_filename_for_display (s
));
1177 if (s
->objfile
&& s
->objfile
->obfd
)
1178 mtime
= s
->objfile
->mtime
;
1180 mtime
= exec_bfd_mtime
;
1182 if (mtime
&& mtime
< st
.st_mtime
)
1183 warning (_("Source file is more recent than executable."));
1186 struct cleanup
*old_cleanups
;
1188 /* st_size might be a large type, but we only support source files whose
1189 size fits in an int. */
1190 size
= (int) st
.st_size
;
1192 /* Use malloc, not alloca, because this may be pretty large, and we may
1193 run into various kinds of limits on stack size. */
1194 data
= (char *) xmalloc (size
);
1195 old_cleanups
= make_cleanup (xfree
, data
);
1197 /* Reassign `size' to result of read for systems where \r\n -> \n. */
1198 size
= myread (desc
, data
, size
);
1200 perror_with_name (symtab_to_filename_for_display (s
));
1203 line_charpos
[0] = 0;
1208 /* A newline at the end does not start a new line. */
1211 if (nlines
== lines_allocated
)
1213 lines_allocated
*= 2;
1215 (int *) xrealloc ((char *) line_charpos
,
1216 sizeof (int) * lines_allocated
);
1218 line_charpos
[nlines
++] = p
- data
;
1221 do_cleanups (old_cleanups
);
1226 (int *) xrealloc ((char *) line_charpos
, nlines
* sizeof (int));
1232 /* Get full pathname and line number positions for a symtab.
1233 Return nonzero if line numbers may have changed.
1234 Set *FULLNAME to actual name of the file as found by `openp',
1235 or to 0 if the file is not found. */
1238 get_filename_and_charpos (struct symtab
*s
, char **fullname
)
1240 int desc
, linenums_changed
= 0;
1241 struct cleanup
*cleanups
;
1243 desc
= open_source_file (s
);
1250 cleanups
= make_cleanup_close (desc
);
1252 *fullname
= s
->fullname
;
1253 if (s
->line_charpos
== 0)
1254 linenums_changed
= 1;
1255 if (linenums_changed
)
1256 find_source_lines (s
, desc
);
1257 do_cleanups (cleanups
);
1258 return linenums_changed
;
1261 /* Print text describing the full name of the source file S
1262 and the line number LINE and its corresponding character position.
1263 The text starts with two Ctrl-z so that the Emacs-GDB interface
1266 MID_STATEMENT is nonzero if the PC is not at the beginning of that line.
1268 Return 1 if successful, 0 if could not find the file. */
1271 identify_source_line (struct symtab
*s
, int line
, int mid_statement
,
1274 if (s
->line_charpos
== 0)
1275 get_filename_and_charpos (s
, (char **) NULL
);
1276 if (s
->fullname
== 0)
1278 if (line
> s
->nlines
)
1279 /* Don't index off the end of the line_charpos array. */
1281 annotate_source (s
->fullname
, line
, s
->line_charpos
[line
- 1],
1282 mid_statement
, get_objfile_arch (s
->objfile
), pc
);
1284 current_source_line
= line
;
1285 first_line_listed
= line
;
1286 last_line_listed
= line
;
1287 current_source_symtab
= s
;
1292 /* Print source lines from the file of symtab S,
1293 starting with line number LINE and stopping before line number STOPLINE. */
1296 print_source_lines_base (struct symtab
*s
, int line
, int stopline
,
1297 enum print_source_lines_flags flags
)
1303 int nlines
= stopline
- line
;
1304 struct cleanup
*cleanup
;
1305 struct ui_out
*uiout
= current_uiout
;
1307 /* Regardless of whether we can open the file, set current_source_symtab. */
1308 current_source_symtab
= s
;
1309 current_source_line
= line
;
1310 first_line_listed
= line
;
1312 /* If printing of source lines is disabled, just print file and line
1314 if (ui_out_test_flags (uiout
, ui_source_list
))
1316 /* Only prints "No such file or directory" once. */
1317 if ((s
!= last_source_visited
) || (!last_source_error
))
1319 last_source_visited
= s
;
1320 desc
= open_source_file (s
);
1324 desc
= last_source_error
;
1325 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1330 desc
= last_source_error
;
1331 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1335 if (desc
< 0 || noprint
)
1337 last_source_error
= desc
;
1339 if (!(flags
& PRINT_SOURCE_LINES_NOERROR
))
1341 const char *filename
= symtab_to_filename_for_display (s
);
1342 int len
= strlen (filename
) + 100;
1343 char *name
= alloca (len
);
1345 xsnprintf (name
, len
, "%d\t%s", line
, filename
);
1346 print_sys_errmsg (name
, errno
);
1350 ui_out_field_int (uiout
, "line", line
);
1351 ui_out_text (uiout
, "\tin ");
1353 /* CLI expects only the "file" field. TUI expects only the
1354 "fullname" field (and TUI does break if "file" is printed).
1355 MI expects both fields. ui_source_list is set only for CLI,
1357 if (ui_out_is_mi_like_p (uiout
)
1358 || ui_out_test_flags (uiout
, ui_source_list
))
1359 ui_out_field_string (uiout
, "file",
1360 symtab_to_filename_for_display (s
));
1361 if (ui_out_is_mi_like_p (uiout
)
1362 || !ui_out_test_flags (uiout
, ui_source_list
))
1364 const char *s_fullname
= symtab_to_fullname (s
);
1365 char *local_fullname
;
1367 /* ui_out_field_string may free S_FULLNAME by calling
1368 open_source_file for it again. See e.g.,
1369 tui_field_string->tui_show_source. */
1370 local_fullname
= alloca (strlen (s_fullname
) + 1);
1371 strcpy (local_fullname
, s_fullname
);
1373 ui_out_field_string (uiout
, "fullname", local_fullname
);
1376 ui_out_text (uiout
, "\n");
1382 last_source_error
= 0;
1384 if (s
->line_charpos
== 0)
1385 find_source_lines (s
, desc
);
1387 if (line
< 1 || line
> s
->nlines
)
1390 error (_("Line number %d out of range; %s has %d lines."),
1391 line
, symtab_to_filename_for_display (s
), s
->nlines
);
1394 if (lseek (desc
, s
->line_charpos
[line
- 1], 0) < 0)
1397 perror_with_name (symtab_to_filename_for_display (s
));
1400 stream
= fdopen (desc
, FDOPEN_MODE
);
1402 cleanup
= make_cleanup_fclose (stream
);
1404 while (nlines
-- > 0)
1411 last_line_listed
= current_source_line
;
1412 if (flags
& PRINT_SOURCE_LINES_FILENAME
)
1414 ui_out_text (uiout
, symtab_to_filename_for_display (s
));
1415 ui_out_text (uiout
, ":");
1417 xsnprintf (buf
, sizeof (buf
), "%d\t", current_source_line
++);
1418 ui_out_text (uiout
, buf
);
1421 if (c
< 040 && c
!= '\t' && c
!= '\n' && c
!= '\r')
1423 xsnprintf (buf
, sizeof (buf
), "^%c", c
+ 0100);
1424 ui_out_text (uiout
, buf
);
1427 ui_out_text (uiout
, "^?");
1430 /* Skip a \r character, but only before a \n. */
1431 int c1
= fgetc (stream
);
1434 printf_filtered ("^%c", c
+ 0100);
1436 ungetc (c1
, stream
);
1440 xsnprintf (buf
, sizeof (buf
), "%c", c
);
1441 ui_out_text (uiout
, buf
);
1444 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1447 do_cleanups (cleanup
);
1450 /* Show source lines from the file of symtab S, starting with line
1451 number LINE and stopping before line number STOPLINE. If this is
1452 not the command line version, then the source is shown in the source
1453 window otherwise it is simply printed. */
1456 print_source_lines (struct symtab
*s
, int line
, int stopline
,
1457 enum print_source_lines_flags flags
)
1459 print_source_lines_base (s
, line
, stopline
, flags
);
1462 /* Print info on range of pc's in a specified line. */
1465 line_info (char *arg
, int from_tty
)
1467 struct symtabs_and_lines sals
;
1468 struct symtab_and_line sal
;
1469 CORE_ADDR start_pc
, end_pc
;
1471 struct cleanup
*cleanups
;
1473 init_sal (&sal
); /* initialize to zeroes */
1477 sal
.symtab
= current_source_symtab
;
1478 sal
.pspace
= current_program_space
;
1479 sal
.line
= last_line_listed
;
1481 sals
.sals
= (struct symtab_and_line
*)
1482 xmalloc (sizeof (struct symtab_and_line
));
1487 sals
= decode_line_with_last_displayed (arg
, DECODE_LINE_LIST_MODE
);
1492 cleanups
= make_cleanup (xfree
, sals
.sals
);
1494 /* C++ More than one line may have been specified, as when the user
1495 specifies an overloaded function name. Print info on them all. */
1496 for (i
= 0; i
< sals
.nelts
; i
++)
1499 if (sal
.pspace
!= current_program_space
)
1502 if (sal
.symtab
== 0)
1504 struct gdbarch
*gdbarch
= get_current_arch ();
1506 printf_filtered (_("No line number information available"));
1509 /* This is useful for "info line *0x7f34". If we can't tell the
1510 user about a source line, at least let them have the symbolic
1512 printf_filtered (" for address ");
1514 print_address (gdbarch
, sal
.pc
, gdb_stdout
);
1517 printf_filtered (".");
1518 printf_filtered ("\n");
1520 else if (sal
.line
> 0
1521 && find_line_pc_range (sal
, &start_pc
, &end_pc
))
1523 struct gdbarch
*gdbarch
= get_objfile_arch (sal
.symtab
->objfile
);
1525 if (start_pc
== end_pc
)
1527 printf_filtered ("Line %d of \"%s\"",
1529 symtab_to_filename_for_display (sal
.symtab
));
1531 printf_filtered (" is at address ");
1532 print_address (gdbarch
, start_pc
, gdb_stdout
);
1534 printf_filtered (" but contains no code.\n");
1538 printf_filtered ("Line %d of \"%s\"",
1540 symtab_to_filename_for_display (sal
.symtab
));
1542 printf_filtered (" starts at address ");
1543 print_address (gdbarch
, start_pc
, gdb_stdout
);
1545 printf_filtered (" and ends at ");
1546 print_address (gdbarch
, end_pc
, gdb_stdout
);
1547 printf_filtered (".\n");
1550 /* x/i should display this line's code. */
1551 set_next_address (gdbarch
, start_pc
);
1553 /* Repeating "info line" should do the following line. */
1554 last_line_listed
= sal
.line
+ 1;
1556 /* If this is the only line, show the source code. If it could
1557 not find the file, don't do anything special. */
1558 if (annotation_level
&& sals
.nelts
== 1)
1559 identify_source_line (sal
.symtab
, sal
.line
, 0, start_pc
);
1562 /* Is there any case in which we get here, and have an address
1563 which the user would want to see? If we have debugging symbols
1564 and no line numbers? */
1565 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1566 sal
.line
, symtab_to_filename_for_display (sal
.symtab
));
1568 do_cleanups (cleanups
);
1571 /* Commands to search the source file for a regexp. */
1574 forward_search_command (char *regex
, int from_tty
)
1581 struct cleanup
*cleanups
;
1583 line
= last_line_listed
+ 1;
1585 msg
= (char *) re_comp (regex
);
1587 error (("%s"), msg
);
1589 if (current_source_symtab
== 0)
1590 select_source_symtab (0);
1592 desc
= open_source_file (current_source_symtab
);
1594 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1595 cleanups
= make_cleanup_close (desc
);
1597 if (current_source_symtab
->line_charpos
== 0)
1598 find_source_lines (current_source_symtab
, desc
);
1600 if (line
< 1 || line
> current_source_symtab
->nlines
)
1601 error (_("Expression not found"));
1603 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1604 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1606 discard_cleanups (cleanups
);
1607 stream
= fdopen (desc
, FDOPEN_MODE
);
1609 cleanups
= make_cleanup_fclose (stream
);
1612 static char *buf
= NULL
;
1614 int cursize
, newsize
;
1617 buf
= xmalloc (cursize
);
1626 if (p
- buf
== cursize
)
1628 newsize
= cursize
+ cursize
/ 2;
1629 buf
= xrealloc (buf
, newsize
);
1634 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1636 /* Remove the \r, if any, at the end of the line, otherwise
1637 regular expressions that end with $ or \n won't work. */
1638 if (p
- buf
> 1 && p
[-2] == '\r')
1644 /* We now have a source line in buf, null terminate and match. */
1646 if (re_exec (buf
) > 0)
1649 do_cleanups (cleanups
);
1650 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1651 set_internalvar_integer (lookup_internalvar ("_"), line
);
1652 current_source_line
= max (line
- lines_to_list
/ 2, 1);
1658 printf_filtered (_("Expression not found\n"));
1659 do_cleanups (cleanups
);
1663 reverse_search_command (char *regex
, int from_tty
)
1670 struct cleanup
*cleanups
;
1672 line
= last_line_listed
- 1;
1674 msg
= (char *) re_comp (regex
);
1676 error (("%s"), msg
);
1678 if (current_source_symtab
== 0)
1679 select_source_symtab (0);
1681 desc
= open_source_file (current_source_symtab
);
1683 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1684 cleanups
= make_cleanup_close (desc
);
1686 if (current_source_symtab
->line_charpos
== 0)
1687 find_source_lines (current_source_symtab
, desc
);
1689 if (line
< 1 || line
> current_source_symtab
->nlines
)
1690 error (_("Expression not found"));
1692 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1693 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1695 discard_cleanups (cleanups
);
1696 stream
= fdopen (desc
, FDOPEN_MODE
);
1698 cleanups
= make_cleanup_fclose (stream
);
1701 /* FIXME!!! We walk right off the end of buf if we get a long line!!! */
1702 char buf
[4096]; /* Should be reasonable??? */
1712 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1714 /* Remove the \r, if any, at the end of the line, otherwise
1715 regular expressions that end with $ or \n won't work. */
1716 if (p
- buf
> 1 && p
[-2] == '\r')
1722 /* We now have a source line in buf; null terminate and match. */
1724 if (re_exec (buf
) > 0)
1727 do_cleanups (cleanups
);
1728 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1729 set_internalvar_integer (lookup_internalvar ("_"), line
);
1730 current_source_line
= max (line
- lines_to_list
/ 2, 1);
1734 if (fseek (stream
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1736 const char *filename
;
1738 do_cleanups (cleanups
);
1739 filename
= symtab_to_filename_for_display (current_source_symtab
);
1740 perror_with_name (filename
);
1744 printf_filtered (_("Expression not found\n"));
1745 do_cleanups (cleanups
);
1749 /* If the last character of PATH is a directory separator, then strip it. */
1752 strip_trailing_directory_separator (char *path
)
1754 const int last
= strlen (path
) - 1;
1757 return; /* No stripping is needed if PATH is the empty string. */
1759 if (IS_DIR_SEPARATOR (path
[last
]))
1763 /* Return the path substitution rule that matches FROM.
1764 Return NULL if no rule matches. */
1766 static struct substitute_path_rule
*
1767 find_substitute_path_rule (const char *from
)
1769 struct substitute_path_rule
*rule
= substitute_path_rules
;
1771 while (rule
!= NULL
)
1773 if (FILENAME_CMP (rule
->from
, from
) == 0)
1781 /* Add a new substitute-path rule at the end of the current list of rules.
1782 The new rule will replace FROM into TO. */
1785 add_substitute_path_rule (char *from
, char *to
)
1787 struct substitute_path_rule
*rule
;
1788 struct substitute_path_rule
*new_rule
;
1790 new_rule
= xmalloc (sizeof (struct substitute_path_rule
));
1791 new_rule
->from
= xstrdup (from
);
1792 new_rule
->to
= xstrdup (to
);
1793 new_rule
->next
= NULL
;
1795 /* If the list of rules are empty, then insert the new rule
1796 at the head of the list. */
1798 if (substitute_path_rules
== NULL
)
1800 substitute_path_rules
= new_rule
;
1804 /* Otherwise, skip to the last rule in our list and then append
1807 rule
= substitute_path_rules
;
1808 while (rule
->next
!= NULL
)
1811 rule
->next
= new_rule
;
1814 /* Remove the given source path substitution rule from the current list
1815 of rules. The memory allocated for that rule is also deallocated. */
1818 delete_substitute_path_rule (struct substitute_path_rule
*rule
)
1820 if (rule
== substitute_path_rules
)
1821 substitute_path_rules
= rule
->next
;
1824 struct substitute_path_rule
*prev
= substitute_path_rules
;
1826 while (prev
!= NULL
&& prev
->next
!= rule
)
1829 gdb_assert (prev
!= NULL
);
1831 prev
->next
= rule
->next
;
1839 /* Implement the "show substitute-path" command. */
1842 show_substitute_path_command (char *args
, int from_tty
)
1844 struct substitute_path_rule
*rule
= substitute_path_rules
;
1847 struct cleanup
*cleanup
;
1849 argv
= gdb_buildargv (args
);
1850 cleanup
= make_cleanup_freeargv (argv
);
1852 /* We expect zero or one argument. */
1854 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1855 error (_("Too many arguments in command"));
1857 if (argv
!= NULL
&& argv
[0] != NULL
)
1860 /* Print the substitution rules. */
1864 (_("Source path substitution rule matching `%s':\n"), from
);
1866 printf_filtered (_("List of all source path substitution rules:\n"));
1868 while (rule
!= NULL
)
1870 if (from
== NULL
|| FILENAME_CMP (rule
->from
, from
) == 0)
1871 printf_filtered (" `%s' -> `%s'.\n", rule
->from
, rule
->to
);
1875 do_cleanups (cleanup
);
1878 /* Implement the "unset substitute-path" command. */
1881 unset_substitute_path_command (char *args
, int from_tty
)
1883 struct substitute_path_rule
*rule
= substitute_path_rules
;
1884 char **argv
= gdb_buildargv (args
);
1887 struct cleanup
*cleanup
;
1889 /* This function takes either 0 or 1 argument. */
1891 cleanup
= make_cleanup_freeargv (argv
);
1892 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1893 error (_("Incorrect usage, too many arguments in command"));
1895 if (argv
!= NULL
&& argv
[0] != NULL
)
1898 /* If the user asked for all the rules to be deleted, ask him
1899 to confirm and give him a chance to abort before the action
1903 && !query (_("Delete all source path substitution rules? ")))
1904 error (_("Canceled"));
1906 /* Delete the rule matching the argument. No argument means that
1907 all rules should be deleted. */
1909 while (rule
!= NULL
)
1911 struct substitute_path_rule
*next
= rule
->next
;
1913 if (from
== NULL
|| FILENAME_CMP (from
, rule
->from
) == 0)
1915 delete_substitute_path_rule (rule
);
1922 /* If the user asked for a specific rule to be deleted but
1923 we could not find it, then report an error. */
1925 if (from
!= NULL
&& !rule_found
)
1926 error (_("No substitution rule defined for `%s'"), from
);
1928 forget_cached_source_info ();
1930 do_cleanups (cleanup
);
1933 /* Add a new source path substitution rule. */
1936 set_substitute_path_command (char *args
, int from_tty
)
1939 struct substitute_path_rule
*rule
;
1940 struct cleanup
*cleanup
;
1942 argv
= gdb_buildargv (args
);
1943 cleanup
= make_cleanup_freeargv (argv
);
1945 if (argv
== NULL
|| argv
[0] == NULL
|| argv
[1] == NULL
)
1946 error (_("Incorrect usage, too few arguments in command"));
1948 if (argv
[2] != NULL
)
1949 error (_("Incorrect usage, too many arguments in command"));
1951 if (*(argv
[0]) == '\0')
1952 error (_("First argument must be at least one character long"));
1954 /* Strip any trailing directory separator character in either FROM
1955 or TO. The substitution rule already implicitly contains them. */
1956 strip_trailing_directory_separator (argv
[0]);
1957 strip_trailing_directory_separator (argv
[1]);
1959 /* If a rule with the same "from" was previously defined, then
1960 delete it. This new rule replaces it. */
1962 rule
= find_substitute_path_rule (argv
[0]);
1964 delete_substitute_path_rule (rule
);
1966 /* Insert the new substitution rule. */
1968 add_substitute_path_rule (argv
[0], argv
[1]);
1969 forget_cached_source_info ();
1971 do_cleanups (cleanup
);
1976 _initialize_source (void)
1978 struct cmd_list_element
*c
;
1980 current_source_symtab
= 0;
1981 init_source_path ();
1983 /* The intention is to use POSIX Basic Regular Expressions.
1984 Always use the GNU regex routine for consistency across all hosts.
1985 Our current GNU regex.c does not have all the POSIX features, so this is
1986 just an approximation. */
1987 re_set_syntax (RE_SYNTAX_GREP
);
1989 c
= add_cmd ("directory", class_files
, directory_command
, _("\
1990 Add directory DIR to beginning of search path for source files.\n\
1991 Forget cached info on source file locations and line positions.\n\
1992 DIR can also be $cwd for the current working directory, or $cdir for the\n\
1993 directory in which the source file was compiled into object code.\n\
1994 With no argument, reset the search path to $cdir:$cwd, the default."),
1998 add_com_alias ("use", "directory", class_files
, 0);
2000 set_cmd_completer (c
, filename_completer
);
2002 add_setshow_optional_filename_cmd ("directories",
2006 Set the search path for finding source files."),
2008 Show the search path for finding source files."),
2010 $cwd in the path means the current working directory.\n\
2011 $cdir in the path means the compilation directory of the source file.\n\
2012 GDB ensures the search path always ends with $cdir:$cwd by\n\
2013 appending these directories if necessary.\n\
2014 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
2015 set_directories_command
,
2016 show_directories_command
,
2017 &setlist
, &showlist
);
2021 add_com_alias ("D", "directory", class_files
, 0);
2022 add_cmd ("ld", no_class
, show_directories_1
, _("\
2023 Current search path for finding source files.\n\
2024 $cwd in the path means the current working directory.\n\
2025 $cdir in the path means the compilation directory of the source file."),
2029 add_info ("source", source_info
,
2030 _("Information about the current source file."));
2032 add_info ("line", line_info
, _("\
2033 Core addresses of the code for a source line.\n\
2034 Line can be specified as\n\
2035 LINENUM, to list around that line in current file,\n\
2036 FILE:LINENUM, to list around that line in that file,\n\
2037 FUNCTION, to list around beginning of that function,\n\
2038 FILE:FUNCTION, to distinguish among like-named static functions.\n\
2039 Default is to describe the last source line that was listed.\n\n\
2040 This sets the default address for \"x\" to the line's first instruction\n\
2041 so that \"x/i\" suffices to start examining the machine code.\n\
2042 The address is also stored as the value of \"$_\"."));
2044 add_com ("forward-search", class_files
, forward_search_command
, _("\
2045 Search for regular expression (see regex(3)) from last line listed.\n\
2046 The matching line number is also stored as the value of \"$_\"."));
2047 add_com_alias ("search", "forward-search", class_files
, 0);
2048 add_com_alias ("fo", "forward-search", class_files
, 1);
2050 add_com ("reverse-search", class_files
, reverse_search_command
, _("\
2051 Search backward for regular expression (see regex(3)) from last line listed.\n\
2052 The matching line number is also stored as the value of \"$_\"."));
2053 add_com_alias ("rev", "reverse-search", class_files
, 1);
2057 add_com_alias ("/", "forward-search", class_files
, 0);
2058 add_com_alias ("?", "reverse-search", class_files
, 0);
2061 add_setshow_integer_cmd ("listsize", class_support
, &lines_to_list
, _("\
2062 Set number of source lines gdb will list by default."), _("\
2063 Show number of source lines gdb will list by default."), _("\
2064 Use this to choose how many source lines the \"list\" displays (unless\n\
2065 the \"list\" argument explicitly specifies some other number).\n\
2066 A value of \"unlimited\", or zero, means there's no limit."),
2069 &setlist
, &showlist
);
2071 add_cmd ("substitute-path", class_files
, set_substitute_path_command
,
2073 Usage: set substitute-path FROM TO\n\
2074 Add a substitution rule replacing FROM into TO in source file names.\n\
2075 If a substitution rule was previously set for FROM, the old rule\n\
2076 is replaced by the new one."),
2079 add_cmd ("substitute-path", class_files
, unset_substitute_path_command
,
2081 Usage: unset substitute-path [FROM]\n\
2082 Delete the rule for substituting FROM in source file names. If FROM\n\
2083 is not specified, all substituting rules are deleted.\n\
2084 If the debugger cannot find a rule for FROM, it will display a warning."),
2087 add_cmd ("substitute-path", class_files
, show_substitute_path_command
,
2089 Usage: show substitute-path [FROM]\n\
2090 Print the rule for substituting FROM in source file names. If FROM\n\
2091 is not specified, print all substitution rules."),
2094 add_setshow_enum_cmd ("filename-display", class_files
,
2095 filename_display_kind_names
,
2096 &filename_display_string
, _("\
2097 Set how to display filenames."), _("\
2098 Show how to display filenames."), _("\
2099 filename-display can be:\n\
2100 basename - display only basename of a filename\n\
2101 relative - display a filename relative to the compilation directory\n\
2102 absolute - display an absolute filename\n\
2103 By default, relative filenames are displayed."),
2105 show_filename_display_string
,
2106 &setlist
, &showlist
);