1 /* List lines of source files for GDB, the GNU debugger.
2 Copyright (C) 1986-2015 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 "filestuff.h"
31 #include <sys/types.h>
35 #include "gdb_regex.h"
41 #include "filenames.h" /* for DOSish file names */
42 #include "completer.h"
44 #include "readline/readline.h"
46 #define OPEN_MODE (O_RDONLY | O_BINARY)
47 #define FDOPEN_MODE FOPEN_RB
49 /* Prototypes for exported functions. */
51 void _initialize_source (void);
53 /* Prototypes for local functions. */
55 static int get_filename_and_charpos (struct symtab
*, char **);
57 static void reverse_search_command (char *, int);
59 static void forward_search_command (char *, int);
61 static void line_info (char *, int);
63 static void source_info (char *, int);
65 /* Path of directories to search for source files.
66 Same format as the PATH environment variable's value. */
70 /* Support for source path substitution commands. */
72 struct substitute_path_rule
76 struct substitute_path_rule
*next
;
79 static struct substitute_path_rule
*substitute_path_rules
= NULL
;
81 /* Symtab of default file for listing lines of. */
83 static struct symtab
*current_source_symtab
;
85 /* Default next line to list. */
87 static int current_source_line
;
89 static struct program_space
*current_source_pspace
;
91 /* Default number of lines to print with commands like "list".
92 This is based on guessing how many long (i.e. more than chars_per_line
93 characters) lines there will be. To be completely correct, "list"
94 and friends should be rewritten to count characters and see where
95 things are wrapping, but that would be a fair amount of work. */
97 int lines_to_list
= 10;
99 show_lines_to_list (struct ui_file
*file
, int from_tty
,
100 struct cmd_list_element
*c
, const char *value
)
102 fprintf_filtered (file
,
103 _("Number of source lines gdb "
104 "will list by default is %s.\n"),
108 /* Possible values of 'set filename-display'. */
109 static const char filename_display_basename
[] = "basename";
110 static const char filename_display_relative
[] = "relative";
111 static const char filename_display_absolute
[] = "absolute";
113 static const char *const filename_display_kind_names
[] = {
114 filename_display_basename
,
115 filename_display_relative
,
116 filename_display_absolute
,
120 static const char *filename_display_string
= filename_display_relative
;
123 show_filename_display_string (struct ui_file
*file
, int from_tty
,
124 struct cmd_list_element
*c
, const char *value
)
126 fprintf_filtered (file
, _("Filenames are displayed as \"%s\".\n"), value
);
129 /* Line number of last line printed. Default for various commands.
130 current_source_line is usually, but not always, the same as this. */
132 static int last_line_listed
;
134 /* First line number listed by last listing command. If 0, then no
135 source lines have yet been listed since the last time the current
136 source line was changed. */
138 static int first_line_listed
;
140 /* Saves the name of the last source file visited and a possible error code.
141 Used to prevent repeating annoying "No such file or directories" msgs. */
143 static struct symtab
*last_source_visited
= NULL
;
144 static int last_source_error
= 0;
146 /* Return the first line listed by print_source_lines.
147 Used by command interpreters to request listing from
151 get_first_line_listed (void)
153 return first_line_listed
;
156 /* Clear line listed range. This makes the next "list" center the
157 printed source lines around the current source line. */
160 clear_lines_listed_range (void)
162 first_line_listed
= 0;
163 last_line_listed
= 0;
166 /* Return the default number of lines to print with commands like the
167 cli "list". The caller of print_source_lines must use this to
168 calculate the end line and use it in the call to print_source_lines
169 as it does not automatically use this value. */
172 get_lines_to_list (void)
174 return lines_to_list
;
177 /* Return the current source file for listing and next line to list.
178 NOTE: The returned sal pc and end fields are not valid. */
180 struct symtab_and_line
181 get_current_source_symtab_and_line (void)
183 struct symtab_and_line cursal
= { 0 };
185 cursal
.pspace
= current_source_pspace
;
186 cursal
.symtab
= current_source_symtab
;
187 cursal
.line
= current_source_line
;
194 /* If the current source file for listing is not set, try and get a default.
195 Usually called before get_current_source_symtab_and_line() is called.
196 It may err out if a default cannot be determined.
197 We must be cautious about where it is called, as it can recurse as the
198 process of determining a new default may call the caller!
199 Use get_current_source_symtab_and_line only to get whatever
200 we have without erroring out or trying to get a default. */
203 set_default_source_symtab_and_line (void)
205 if (!have_full_symbols () && !have_partial_symbols ())
206 error (_("No symbol table is loaded. Use the \"file\" command."));
208 /* Pull in a current source symtab if necessary. */
209 if (current_source_symtab
== 0)
210 select_source_symtab (0);
213 /* Return the current default file for listing and next line to list
214 (the returned sal pc and end fields are not valid.)
215 and set the current default to whatever is in SAL.
216 NOTE: The returned sal pc and end fields are not valid. */
218 struct symtab_and_line
219 set_current_source_symtab_and_line (const struct symtab_and_line
*sal
)
221 struct symtab_and_line cursal
= { 0 };
223 cursal
.pspace
= current_source_pspace
;
224 cursal
.symtab
= current_source_symtab
;
225 cursal
.line
= current_source_line
;
229 current_source_pspace
= sal
->pspace
;
230 current_source_symtab
= sal
->symtab
;
231 current_source_line
= sal
->line
;
233 /* Force the next "list" to center around the current line. */
234 clear_lines_listed_range ();
239 /* Reset any information stored about a default file and line to print. */
242 clear_current_source_symtab_and_line (void)
244 current_source_symtab
= 0;
245 current_source_line
= 0;
248 /* Set the source file default for the "list" command to be S.
250 If S is NULL, and we don't have a default, find one. This
251 should only be called when the user actually tries to use the
252 default, since we produce an error if we can't find a reasonable
253 default. Also, since this can cause symbols to be read, doing it
254 before we need to would make things slower than necessary. */
257 select_source_symtab (struct symtab
*s
)
259 struct symtabs_and_lines sals
;
260 struct symtab_and_line sal
;
262 struct compunit_symtab
*cu
;
266 current_source_symtab
= s
;
267 current_source_line
= 1;
268 current_source_pspace
= SYMTAB_PSPACE (s
);
272 if (current_source_symtab
)
275 /* Make the default place to list be the function `main'
277 if (lookup_symbol (main_name (), 0, VAR_DOMAIN
, 0))
279 sals
= decode_line_with_current_source (main_name (),
280 DECODE_LINE_FUNFIRSTLINE
);
283 current_source_pspace
= sal
.pspace
;
284 current_source_symtab
= sal
.symtab
;
285 current_source_line
= max (sal
.line
- (lines_to_list
- 1), 1);
286 if (current_source_symtab
)
290 /* Alright; find the last file in the symtab list (ignoring .h's
291 and namespace symtabs). */
293 current_source_line
= 1;
295 ALL_FILETABS (ofp
, cu
, s
)
297 const char *name
= s
->filename
;
298 int len
= strlen (name
);
300 if (!(len
> 2 && (strcmp (&name
[len
- 2], ".h") == 0
301 || strcmp (name
, "<<C++-namespaces>>") == 0)))
303 current_source_pspace
= current_program_space
;
304 current_source_symtab
= s
;
308 if (current_source_symtab
)
314 s
= ofp
->sf
->qf
->find_last_source_symtab (ofp
);
316 current_source_symtab
= s
;
318 if (current_source_symtab
)
321 error (_("Can't find a default source file"));
324 /* Handler for "set directories path-list" command.
325 "set dir mumble" doesn't prepend paths, it resets the entire
326 path list. The theory is that set(show(dir)) should be a no-op. */
329 set_directories_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
331 /* This is the value that was set.
332 It needs to be processed to maintain $cdir:$cwd and remove dups. */
333 char *set_path
= source_path
;
335 /* We preserve the invariant that $cdir:$cwd begins life at the end of
336 the list by calling init_source_path. If they appear earlier in
337 SET_PATH then mod_path will move them appropriately.
338 mod_path will also remove duplicates. */
340 if (*set_path
!= '\0')
341 mod_path (set_path
, &source_path
);
346 /* Print the list of source directories.
347 This is used by the "ld" command, so it has the signature of a command
351 show_directories_1 (char *ignore
, int from_tty
)
353 puts_filtered ("Source directories searched: ");
354 puts_filtered (source_path
);
355 puts_filtered ("\n");
358 /* Handler for "show directories" command. */
361 show_directories_command (struct ui_file
*file
, int from_tty
,
362 struct cmd_list_element
*c
, const char *value
)
364 show_directories_1 (NULL
, from_tty
);
367 /* Forget line positions and file names for the symtabs in a
368 particular objfile. */
371 forget_cached_source_info_for_objfile (struct objfile
*objfile
)
373 struct compunit_symtab
*cu
;
376 ALL_OBJFILE_FILETABS (objfile
, cu
, s
)
378 if (s
->line_charpos
!= NULL
)
380 xfree (s
->line_charpos
);
381 s
->line_charpos
= NULL
;
383 if (s
->fullname
!= NULL
)
391 objfile
->sf
->qf
->forget_cached_source_info (objfile
);
394 /* Forget what we learned about line positions in source files, and
395 which directories contain them; must check again now since files
396 may be found in a different directory now. */
399 forget_cached_source_info (void)
401 struct program_space
*pspace
;
402 struct objfile
*objfile
;
405 ALL_PSPACE_OBJFILES (pspace
, objfile
)
407 forget_cached_source_info_for_objfile (objfile
);
410 last_source_visited
= NULL
;
414 init_source_path (void)
418 xsnprintf (buf
, sizeof (buf
), "$cdir%c$cwd", DIRNAME_SEPARATOR
);
419 source_path
= xstrdup (buf
);
420 forget_cached_source_info ();
423 /* Add zero or more directories to the front of the source path. */
426 directory_command (char *dirname
, int from_tty
)
429 /* FIXME, this goes to "delete dir"... */
432 if (!from_tty
|| query (_("Reinitialize source path to empty? ")))
440 mod_path (dirname
, &source_path
);
441 forget_cached_source_info ();
444 show_directories_1 ((char *) 0, from_tty
);
447 /* Add a path given with the -d command line switch.
448 This will not be quoted so we must not treat spaces as separators. */
451 directory_switch (char *dirname
, int from_tty
)
453 add_path (dirname
, &source_path
, 0);
456 /* Add zero or more directories to the front of an arbitrary path. */
459 mod_path (char *dirname
, char **which_path
)
461 add_path (dirname
, which_path
, 1);
464 /* Workhorse of mod_path. Takes an extra argument to determine
465 if dirname should be parsed for separators that indicate multiple
466 directories. This allows for interfaces that pre-parse the dirname
467 and allow specification of traditional separator characters such
471 add_path (char *dirname
, char **which_path
, int parse_separators
)
473 char *old
= *which_path
;
475 VEC (char_ptr
) *dir_vec
= NULL
;
476 struct cleanup
*back_to
;
483 if (parse_separators
)
485 char **argv
, **argvp
;
487 /* This will properly parse the space and tab separators
488 and any quotes that may exist. */
489 argv
= gdb_buildargv (dirname
);
491 for (argvp
= argv
; *argvp
; argvp
++)
492 dirnames_to_char_ptr_vec_append (&dir_vec
, *argvp
);
497 VEC_safe_push (char_ptr
, dir_vec
, xstrdup (dirname
));
498 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
500 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, name
); ++ix
)
505 /* Spaces and tabs will have been removed by buildargv().
506 NAME is the start of the directory.
507 P is the '\0' following the end. */
508 p
= name
+ strlen (name
);
510 while (!(IS_DIR_SEPARATOR (*name
) && p
<= name
+ 1) /* "/" */
511 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
512 /* On MS-DOS and MS-Windows, h:\ is different from h: */
513 && !(p
== name
+ 3 && name
[1] == ':') /* "d:/" */
515 && IS_DIR_SEPARATOR (p
[-1]))
516 /* Sigh. "foo/" => "foo" */
520 while (p
> name
&& p
[-1] == '.')
524 /* "." => getwd (). */
525 name
= current_directory
;
528 else if (p
> name
+ 1 && IS_DIR_SEPARATOR (p
[-2]))
538 /* "...foo/." => "...foo". */
549 name
= tilde_expand (name
);
550 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
551 else if (IS_ABSOLUTE_PATH (name
) && p
== name
+ 2) /* "d:" => "d:." */
552 name
= concat (name
, ".", (char *)NULL
);
554 else if (!IS_ABSOLUTE_PATH (name
) && name
[0] != '$')
555 name
= concat (current_directory
, SLASH_STRING
, name
, (char *)NULL
);
557 name
= savestring (name
, p
- name
);
558 make_cleanup (xfree
, name
);
560 /* Unless it's a variable, check existence. */
563 /* These are warnings, not errors, since we don't want a
564 non-existent directory in a .gdbinit file to stop processing
565 of the .gdbinit file.
567 Whether they get added to the path is more debatable. Current
568 answer is yes, in case the user wants to go make the directory
569 or whatever. If the directory continues to not exist/not be
570 a directory/etc, then having them in the path should be
572 if (stat (name
, &st
) < 0)
574 int save_errno
= errno
;
576 fprintf_unfiltered (gdb_stderr
, "Warning: ");
577 print_sys_errmsg (name
, save_errno
);
579 else if ((st
.st_mode
& S_IFMT
) != S_IFDIR
)
580 warning (_("%s is not a directory."), name
);
585 unsigned int len
= strlen (name
);
591 /* FIXME: we should use realpath() or its work-alike
592 before comparing. Then all the code above which
593 removes excess slashes and dots could simply go away. */
594 if (!filename_ncmp (p
, name
, len
)
595 && (p
[len
] == '\0' || p
[len
] == DIRNAME_SEPARATOR
))
597 /* Found it in the search path, remove old copy. */
600 /* Back over leading separator. */
603 if (prefix
> p
- *which_path
)
605 /* Same dir twice in one cmd. */
608 /* Copy from next '\0' or ':'. */
609 memmove (p
, &p
[len
+ 1], strlen (&p
[len
+ 1]) + 1);
611 p
= strchr (p
, DIRNAME_SEPARATOR
);
618 tinybuf
[0] = DIRNAME_SEPARATOR
;
621 /* If we have already tacked on a name(s) in this command,
622 be sure they stay on the front as we tack on some
630 temp
= concat (old
, tinybuf
, name
, (char *)NULL
);
632 *which_path
= concat (temp
, "", &old
[prefix
], (char *) NULL
);
633 prefix
= strlen (temp
);
638 *which_path
= concat (name
, (old
[0] ? tinybuf
: old
),
640 prefix
= strlen (name
);
649 do_cleanups (back_to
);
654 source_info (char *ignore
, int from_tty
)
656 struct symtab
*s
= current_source_symtab
;
657 struct compunit_symtab
*cust
;
661 printf_filtered (_("No current source file.\n"));
665 cust
= SYMTAB_COMPUNIT (s
);
666 printf_filtered (_("Current source file is %s\n"), s
->filename
);
667 if (SYMTAB_DIRNAME (s
) != NULL
)
668 printf_filtered (_("Compilation directory is %s\n"), SYMTAB_DIRNAME (s
));
670 printf_filtered (_("Located in %s\n"), s
->fullname
);
672 printf_filtered (_("Contains %d line%s.\n"), s
->nlines
,
673 s
->nlines
== 1 ? "" : "s");
675 printf_filtered (_("Source language is %s.\n"), language_str (s
->language
));
676 printf_filtered (_("Producer is %s.\n"),
677 COMPUNIT_PRODUCER (cust
) != NULL
678 ? COMPUNIT_PRODUCER (cust
) : _("unknown"));
679 printf_filtered (_("Compiled with %s debugging format.\n"),
680 COMPUNIT_DEBUGFORMAT (cust
));
681 printf_filtered (_("%s preprocessor macro info.\n"),
682 COMPUNIT_MACRO_TABLE (cust
) != NULL
683 ? "Includes" : "Does not include");
687 /* Return True if the file NAME exists and is a regular file. */
689 is_regular_file (const char *name
)
692 const int status
= stat (name
, &st
);
694 /* Stat should never fail except when the file does not exist.
695 If stat fails, analyze the source of error and return True
696 unless the file does not exist, to avoid returning false results
697 on obscure systems where stat does not work as expected. */
700 return (errno
!= ENOENT
);
702 return S_ISREG (st
.st_mode
);
705 /* Open a file named STRING, searching path PATH (dir names sep by some char)
706 using mode MODE in the calls to open. You cannot use this function to
707 create files (O_CREAT).
709 OPTS specifies the function behaviour in specific cases.
711 If OPF_TRY_CWD_FIRST, try to open ./STRING before searching PATH.
712 (ie pretend the first element of PATH is "."). This also indicates
713 that, unless OPF_SEARCH_IN_PATH is also specified, a slash in STRING
714 disables searching of the path (this is so that "exec-file ./foo" or
715 "symbol-file ./foo" insures that you get that particular version of
716 foo or an error message).
718 If OPTS has OPF_SEARCH_IN_PATH set, absolute names will also be
719 searched in path (we usually want this for source files but not for
722 If FILENAME_OPENED is non-null, set it to a newly allocated string naming
723 the actual file opened (this string will always start with a "/"). We
724 have to take special pains to avoid doubling the "/" between the directory
725 and the file, sigh! Emacs gets confuzzed by this when we print the
728 If OPTS has OPF_RETURN_REALPATH set return FILENAME_OPENED resolved by
729 gdb_realpath. Even without OPF_RETURN_REALPATH this function still returns
730 filename starting with "/". If FILENAME_OPENED is NULL this option has no
733 If a file is found, return the descriptor.
734 Otherwise, return -1, with errno set for the last name we tried to open. */
736 /* >>>> This should only allow files of certain types,
737 >>>> eg executable, non-directory. */
739 openp (const char *path
, int opts
, const char *string
,
740 int mode
, char **filename_opened
)
745 VEC (char_ptr
) *dir_vec
;
746 struct cleanup
*back_to
;
750 /* The open syscall MODE parameter is not specified. */
751 gdb_assert ((mode
& O_CREAT
) == 0);
752 gdb_assert (string
!= NULL
);
754 /* A file with an empty name cannot possibly exist. Report a failure
755 without further checking.
757 This is an optimization which also defends us against buggy
758 implementations of the "stat" function. For instance, we have
759 noticed that a MinGW debugger built on Windows XP 32bits crashes
760 when the debugger is started with an empty argument. */
761 if (string
[0] == '\0')
772 if ((opts
& OPF_TRY_CWD_FIRST
) || IS_ABSOLUTE_PATH (string
))
776 if (is_regular_file (string
))
778 filename
= alloca (strlen (string
) + 1);
779 strcpy (filename
, string
);
780 fd
= gdb_open_cloexec (filename
, mode
, 0);
790 if (!(opts
& OPF_SEARCH_IN_PATH
))
791 for (i
= 0; string
[i
]; i
++)
792 if (IS_DIR_SEPARATOR (string
[i
]))
796 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
797 if (HAS_DRIVE_SPEC (string
))
798 string
= STRIP_DRIVE_SPEC (string
);
800 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
801 while (IS_DIR_SEPARATOR(string
[0]))
805 while (string
[0] == '.' && IS_DIR_SEPARATOR (string
[1]))
808 alloclen
= strlen (path
) + strlen (string
) + 2;
809 filename
= alloca (alloclen
);
812 dir_vec
= dirnames_to_char_ptr_vec (path
);
813 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
815 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, dir
); ++ix
)
817 size_t len
= strlen (dir
);
819 if (strcmp (dir
, "$cwd") == 0)
821 /* Name is $cwd -- insert current directory name instead. */
824 /* First, realloc the filename buffer if too short. */
825 len
= strlen (current_directory
);
826 newlen
= len
+ strlen (string
) + 2;
827 if (newlen
> alloclen
)
830 filename
= alloca (alloclen
);
832 strcpy (filename
, current_directory
);
834 else if (strchr(dir
, '~'))
836 /* See whether we need to expand the tilde. */
838 char *tilde_expanded
;
840 tilde_expanded
= tilde_expand (dir
);
842 /* First, realloc the filename buffer if too short. */
843 len
= strlen (tilde_expanded
);
844 newlen
= len
+ strlen (string
) + 2;
845 if (newlen
> alloclen
)
848 filename
= alloca (alloclen
);
850 strcpy (filename
, tilde_expanded
);
851 xfree (tilde_expanded
);
855 /* Normal file name in path -- just use it. */
856 strcpy (filename
, dir
);
858 /* Don't search $cdir. It's also a magic path like $cwd, but we
859 don't have enough information to expand it. The user *could*
860 have an actual directory named '$cdir' but handling that would
861 be confusing, it would mean different things in different
862 contexts. If the user really has '$cdir' one can use './$cdir'.
863 We can get $cdir when loading scripts. When loading source files
864 $cdir must have already been expanded to the correct value. */
865 if (strcmp (dir
, "$cdir") == 0)
869 /* Remove trailing slashes. */
870 while (len
> 0 && IS_DIR_SEPARATOR (filename
[len
- 1]))
873 strcat (filename
+ len
, SLASH_STRING
);
874 strcat (filename
, string
);
876 if (is_regular_file (filename
))
878 fd
= gdb_open_cloexec (filename
, mode
, 0);
884 do_cleanups (back_to
);
889 /* If a file was opened, canonicalize its filename. */
891 *filename_opened
= NULL
;
892 else if ((opts
& OPF_RETURN_REALPATH
) != 0)
893 *filename_opened
= gdb_realpath (filename
);
895 *filename_opened
= gdb_abspath (filename
);
902 /* This is essentially a convenience, for clients that want the behaviour
903 of openp, using source_path, but that really don't want the file to be
904 opened but want instead just to know what the full pathname is (as
905 qualified against source_path).
907 The current working directory is searched first.
909 If the file was found, this function returns 1, and FULL_PATHNAME is
910 set to the fully-qualified pathname.
912 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
914 source_full_path_of (const char *filename
, char **full_pathname
)
918 fd
= openp (source_path
,
919 OPF_TRY_CWD_FIRST
| OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
,
920 filename
, O_RDONLY
, full_pathname
);
923 *full_pathname
= NULL
;
931 /* Return non-zero if RULE matches PATH, that is if the rule can be
935 substitute_path_rule_matches (const struct substitute_path_rule
*rule
,
938 const int from_len
= strlen (rule
->from
);
939 const int path_len
= strlen (path
);
941 if (path_len
< from_len
)
944 /* The substitution rules are anchored at the start of the path,
945 so the path should start with rule->from. */
947 if (filename_ncmp (path
, rule
->from
, from_len
) != 0)
950 /* Make sure that the region in the path that matches the substitution
951 rule is immediately followed by a directory separator (or the end of
952 string character). */
954 if (path
[from_len
] != '\0' && !IS_DIR_SEPARATOR (path
[from_len
]))
960 /* Find the substitute-path rule that applies to PATH and return it.
961 Return NULL if no rule applies. */
963 static struct substitute_path_rule
*
964 get_substitute_path_rule (const char *path
)
966 struct substitute_path_rule
*rule
= substitute_path_rules
;
968 while (rule
!= NULL
&& !substitute_path_rule_matches (rule
, path
))
974 /* If the user specified a source path substitution rule that applies
975 to PATH, then apply it and return the new path. This new path must
976 be deallocated afterwards.
978 Return NULL if no substitution rule was specified by the user,
979 or if no rule applied to the given PATH. */
982 rewrite_source_path (const char *path
)
984 const struct substitute_path_rule
*rule
= get_substitute_path_rule (path
);
991 from_len
= strlen (rule
->from
);
993 /* Compute the rewritten path and return it. */
996 (char *) xmalloc (strlen (path
) + 1 + strlen (rule
->to
) - from_len
);
997 strcpy (new_path
, rule
->to
);
998 strcat (new_path
, path
+ from_len
);
1004 find_and_open_source (const char *filename
,
1005 const char *dirname
,
1008 char *path
= source_path
;
1011 struct cleanup
*cleanup
;
1013 /* Quick way out if we already know its full name. */
1017 /* The user may have requested that source paths be rewritten
1018 according to substitution rules he provided. If a substitution
1019 rule applies to this path, then apply it. */
1020 char *rewritten_fullname
= rewrite_source_path (*fullname
);
1022 if (rewritten_fullname
!= NULL
)
1025 *fullname
= rewritten_fullname
;
1028 result
= gdb_open_cloexec (*fullname
, OPEN_MODE
, 0);
1031 char *lpath
= gdb_realpath (*fullname
);
1038 /* Didn't work -- free old one, try again. */
1043 cleanup
= make_cleanup (null_cleanup
, NULL
);
1045 if (dirname
!= NULL
)
1047 /* If necessary, rewrite the compilation directory name according
1048 to the source path substitution rules specified by the user. */
1050 char *rewritten_dirname
= rewrite_source_path (dirname
);
1052 if (rewritten_dirname
!= NULL
)
1054 make_cleanup (xfree
, rewritten_dirname
);
1055 dirname
= rewritten_dirname
;
1058 /* Replace a path entry of $cdir with the compilation directory
1061 /* We cast strstr's result in case an ANSIhole has made it const,
1062 which produces a "required warning" when assigned to a nonconst. */
1063 p
= (char *) strstr (source_path
, "$cdir");
1064 if (p
&& (p
== path
|| p
[-1] == DIRNAME_SEPARATOR
)
1065 && (p
[cdir_len
] == DIRNAME_SEPARATOR
|| p
[cdir_len
] == '\0'))
1070 alloca (strlen (source_path
) + 1 + strlen (dirname
) + 1);
1071 len
= p
- source_path
;
1072 strncpy (path
, source_path
, len
); /* Before $cdir */
1073 strcpy (path
+ len
, dirname
); /* new stuff */
1074 strcat (path
+ len
, source_path
+ len
+ cdir_len
); /* After
1079 if (IS_ABSOLUTE_PATH (filename
))
1081 /* If filename is absolute path, try the source path
1082 substitution on it. */
1083 char *rewritten_filename
= rewrite_source_path (filename
);
1085 if (rewritten_filename
!= NULL
)
1087 make_cleanup (xfree
, rewritten_filename
);
1088 filename
= rewritten_filename
;
1092 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, filename
,
1093 OPEN_MODE
, fullname
);
1096 /* Didn't work. Try using just the basename. */
1097 p
= lbasename (filename
);
1099 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, p
,
1100 OPEN_MODE
, fullname
);
1103 do_cleanups (cleanup
);
1107 /* Open a source file given a symtab S. Returns a file descriptor or
1108 negative number for error.
1110 This function is a convience function to find_and_open_source. */
1113 open_source_file (struct symtab
*s
)
1118 return find_and_open_source (s
->filename
, SYMTAB_DIRNAME (s
), &s
->fullname
);
1121 /* Finds the fullname that a symtab represents.
1123 This functions finds the fullname and saves it in s->fullname.
1124 It will also return the value.
1126 If this function fails to find the file that this symtab represents,
1127 the expected fullname is used. Therefore the files does not have to
1131 symtab_to_fullname (struct symtab
*s
)
1133 /* Use cached copy if we have it.
1134 We rely on forget_cached_source_info being called appropriately
1135 to handle cases like the file being moved. */
1136 if (s
->fullname
== NULL
)
1138 int fd
= find_and_open_source (s
->filename
, SYMTAB_DIRNAME (s
),
1146 struct cleanup
*back_to
;
1148 /* rewrite_source_path would be applied by find_and_open_source, we
1149 should report the pathname where GDB tried to find the file. */
1151 if (SYMTAB_DIRNAME (s
) == NULL
|| IS_ABSOLUTE_PATH (s
->filename
))
1152 fullname
= xstrdup (s
->filename
);
1154 fullname
= concat (SYMTAB_DIRNAME (s
), SLASH_STRING
, s
->filename
,
1157 back_to
= make_cleanup (xfree
, fullname
);
1158 s
->fullname
= rewrite_source_path (fullname
);
1159 if (s
->fullname
== NULL
)
1160 s
->fullname
= xstrdup (fullname
);
1161 do_cleanups (back_to
);
1168 /* See commentary in source.h. */
1171 symtab_to_filename_for_display (struct symtab
*symtab
)
1173 if (filename_display_string
== filename_display_basename
)
1174 return lbasename (symtab
->filename
);
1175 else if (filename_display_string
== filename_display_absolute
)
1176 return symtab_to_fullname (symtab
);
1177 else if (filename_display_string
== filename_display_relative
)
1178 return symtab
->filename
;
1180 internal_error (__FILE__
, __LINE__
, _("invalid filename_display_string"));
1183 /* Create and initialize the table S->line_charpos that records
1184 the positions of the lines in the source file, which is assumed
1185 to be open on descriptor DESC.
1186 All set S->nlines to the number of such lines. */
1189 find_source_lines (struct symtab
*s
, int desc
)
1192 char *data
, *p
, *end
;
1194 int lines_allocated
= 1000;
1200 line_charpos
= (int *) xmalloc (lines_allocated
* sizeof (int));
1201 if (fstat (desc
, &st
) < 0)
1202 perror_with_name (symtab_to_filename_for_display (s
));
1204 if (SYMTAB_OBJFILE (s
) != NULL
&& SYMTAB_OBJFILE (s
)->obfd
!= NULL
)
1205 mtime
= SYMTAB_OBJFILE (s
)->mtime
;
1207 mtime
= exec_bfd_mtime
;
1209 if (mtime
&& mtime
< st
.st_mtime
)
1210 warning (_("Source file is more recent than executable."));
1213 struct cleanup
*old_cleanups
;
1215 /* st_size might be a large type, but we only support source files whose
1216 size fits in an int. */
1217 size
= (int) st
.st_size
;
1219 /* Use malloc, not alloca, because this may be pretty large, and we may
1220 run into various kinds of limits on stack size. */
1221 data
= (char *) xmalloc (size
);
1222 old_cleanups
= make_cleanup (xfree
, data
);
1224 /* Reassign `size' to result of read for systems where \r\n -> \n. */
1225 size
= myread (desc
, data
, size
);
1227 perror_with_name (symtab_to_filename_for_display (s
));
1230 line_charpos
[0] = 0;
1235 /* A newline at the end does not start a new line. */
1238 if (nlines
== lines_allocated
)
1240 lines_allocated
*= 2;
1242 (int *) xrealloc ((char *) line_charpos
,
1243 sizeof (int) * lines_allocated
);
1245 line_charpos
[nlines
++] = p
- data
;
1248 do_cleanups (old_cleanups
);
1253 (int *) xrealloc ((char *) line_charpos
, nlines
* sizeof (int));
1259 /* Get full pathname and line number positions for a symtab.
1260 Return nonzero if line numbers may have changed.
1261 Set *FULLNAME to actual name of the file as found by `openp',
1262 or to 0 if the file is not found. */
1265 get_filename_and_charpos (struct symtab
*s
, char **fullname
)
1267 int desc
, linenums_changed
= 0;
1268 struct cleanup
*cleanups
;
1270 desc
= open_source_file (s
);
1277 cleanups
= make_cleanup_close (desc
);
1279 *fullname
= s
->fullname
;
1280 if (s
->line_charpos
== 0)
1281 linenums_changed
= 1;
1282 if (linenums_changed
)
1283 find_source_lines (s
, desc
);
1284 do_cleanups (cleanups
);
1285 return linenums_changed
;
1288 /* Print text describing the full name of the source file S
1289 and the line number LINE and its corresponding character position.
1290 The text starts with two Ctrl-z so that the Emacs-GDB interface
1293 MID_STATEMENT is nonzero if the PC is not at the beginning of that line.
1295 Return 1 if successful, 0 if could not find the file. */
1298 identify_source_line (struct symtab
*s
, int line
, int mid_statement
,
1301 if (s
->line_charpos
== 0)
1302 get_filename_and_charpos (s
, (char **) NULL
);
1303 if (s
->fullname
== 0)
1305 if (line
> s
->nlines
)
1306 /* Don't index off the end of the line_charpos array. */
1308 annotate_source (s
->fullname
, line
, s
->line_charpos
[line
- 1],
1309 mid_statement
, get_objfile_arch (SYMTAB_OBJFILE (s
)), pc
);
1311 current_source_line
= line
;
1312 current_source_symtab
= s
;
1313 clear_lines_listed_range ();
1318 /* Print source lines from the file of symtab S,
1319 starting with line number LINE and stopping before line number STOPLINE. */
1322 print_source_lines_base (struct symtab
*s
, int line
, int stopline
,
1323 enum print_source_lines_flags flags
)
1329 int nlines
= stopline
- line
;
1330 struct cleanup
*cleanup
;
1331 struct ui_out
*uiout
= current_uiout
;
1333 /* Regardless of whether we can open the file, set current_source_symtab. */
1334 current_source_symtab
= s
;
1335 current_source_line
= line
;
1336 first_line_listed
= line
;
1338 /* If printing of source lines is disabled, just print file and line
1340 if (ui_out_test_flags (uiout
, ui_source_list
))
1342 /* Only prints "No such file or directory" once. */
1343 if ((s
!= last_source_visited
) || (!last_source_error
))
1345 last_source_visited
= s
;
1346 desc
= open_source_file (s
);
1350 desc
= last_source_error
;
1351 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1356 desc
= last_source_error
;
1357 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1361 if (desc
< 0 || noprint
)
1363 last_source_error
= desc
;
1365 if (!(flags
& PRINT_SOURCE_LINES_NOERROR
))
1367 const char *filename
= symtab_to_filename_for_display (s
);
1368 int len
= strlen (filename
) + 100;
1369 char *name
= alloca (len
);
1371 xsnprintf (name
, len
, "%d\t%s", line
, filename
);
1372 print_sys_errmsg (name
, errno
);
1376 ui_out_field_int (uiout
, "line", line
);
1377 ui_out_text (uiout
, "\tin ");
1379 /* CLI expects only the "file" field. TUI expects only the
1380 "fullname" field (and TUI does break if "file" is printed).
1381 MI expects both fields. ui_source_list is set only for CLI,
1383 if (ui_out_is_mi_like_p (uiout
)
1384 || ui_out_test_flags (uiout
, ui_source_list
))
1385 ui_out_field_string (uiout
, "file",
1386 symtab_to_filename_for_display (s
));
1387 if (ui_out_is_mi_like_p (uiout
)
1388 || !ui_out_test_flags (uiout
, ui_source_list
))
1390 const char *s_fullname
= symtab_to_fullname (s
);
1391 char *local_fullname
;
1393 /* ui_out_field_string may free S_FULLNAME by calling
1394 open_source_file for it again. See e.g.,
1395 tui_field_string->tui_show_source. */
1396 local_fullname
= alloca (strlen (s_fullname
) + 1);
1397 strcpy (local_fullname
, s_fullname
);
1399 ui_out_field_string (uiout
, "fullname", local_fullname
);
1402 ui_out_text (uiout
, "\n");
1408 last_source_error
= 0;
1410 if (s
->line_charpos
== 0)
1411 find_source_lines (s
, desc
);
1413 if (line
< 1 || line
> s
->nlines
)
1416 error (_("Line number %d out of range; %s has %d lines."),
1417 line
, symtab_to_filename_for_display (s
), s
->nlines
);
1420 if (lseek (desc
, s
->line_charpos
[line
- 1], 0) < 0)
1423 perror_with_name (symtab_to_filename_for_display (s
));
1426 stream
= fdopen (desc
, FDOPEN_MODE
);
1428 cleanup
= make_cleanup_fclose (stream
);
1430 while (nlines
-- > 0)
1437 last_line_listed
= current_source_line
;
1438 if (flags
& PRINT_SOURCE_LINES_FILENAME
)
1440 ui_out_text (uiout
, symtab_to_filename_for_display (s
));
1441 ui_out_text (uiout
, ":");
1443 xsnprintf (buf
, sizeof (buf
), "%d\t", current_source_line
++);
1444 ui_out_text (uiout
, buf
);
1447 if (c
< 040 && c
!= '\t' && c
!= '\n' && c
!= '\r')
1449 xsnprintf (buf
, sizeof (buf
), "^%c", c
+ 0100);
1450 ui_out_text (uiout
, buf
);
1453 ui_out_text (uiout
, "^?");
1456 /* Skip a \r character, but only before a \n. */
1457 int c1
= fgetc (stream
);
1460 printf_filtered ("^%c", c
+ 0100);
1462 ungetc (c1
, stream
);
1466 xsnprintf (buf
, sizeof (buf
), "%c", c
);
1467 ui_out_text (uiout
, buf
);
1470 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1473 do_cleanups (cleanup
);
1476 /* Show source lines from the file of symtab S, starting with line
1477 number LINE and stopping before line number STOPLINE. If this is
1478 not the command line version, then the source is shown in the source
1479 window otherwise it is simply printed. */
1482 print_source_lines (struct symtab
*s
, int line
, int stopline
,
1483 enum print_source_lines_flags flags
)
1485 print_source_lines_base (s
, line
, stopline
, flags
);
1488 /* Print info on range of pc's in a specified line. */
1491 line_info (char *arg
, int from_tty
)
1493 struct symtabs_and_lines sals
;
1494 struct symtab_and_line sal
;
1495 CORE_ADDR start_pc
, end_pc
;
1497 struct cleanup
*cleanups
;
1499 init_sal (&sal
); /* initialize to zeroes */
1503 sal
.symtab
= current_source_symtab
;
1504 sal
.pspace
= current_program_space
;
1505 if (last_line_listed
!= 0)
1506 sal
.line
= last_line_listed
;
1508 sal
.line
= current_source_line
;
1511 sals
.sals
= (struct symtab_and_line
*)
1512 xmalloc (sizeof (struct symtab_and_line
));
1517 sals
= decode_line_with_last_displayed (arg
, DECODE_LINE_LIST_MODE
);
1522 cleanups
= make_cleanup (xfree
, sals
.sals
);
1524 /* C++ More than one line may have been specified, as when the user
1525 specifies an overloaded function name. Print info on them all. */
1526 for (i
= 0; i
< sals
.nelts
; i
++)
1529 if (sal
.pspace
!= current_program_space
)
1532 if (sal
.symtab
== 0)
1534 struct gdbarch
*gdbarch
= get_current_arch ();
1536 printf_filtered (_("No line number information available"));
1539 /* This is useful for "info line *0x7f34". If we can't tell the
1540 user about a source line, at least let them have the symbolic
1542 printf_filtered (" for address ");
1544 print_address (gdbarch
, sal
.pc
, gdb_stdout
);
1547 printf_filtered (".");
1548 printf_filtered ("\n");
1550 else if (sal
.line
> 0
1551 && find_line_pc_range (sal
, &start_pc
, &end_pc
))
1553 struct gdbarch
*gdbarch
1554 = get_objfile_arch (SYMTAB_OBJFILE (sal
.symtab
));
1556 if (start_pc
== end_pc
)
1558 printf_filtered ("Line %d of \"%s\"",
1560 symtab_to_filename_for_display (sal
.symtab
));
1562 printf_filtered (" is at address ");
1563 print_address (gdbarch
, start_pc
, gdb_stdout
);
1565 printf_filtered (" but contains no code.\n");
1569 printf_filtered ("Line %d of \"%s\"",
1571 symtab_to_filename_for_display (sal
.symtab
));
1573 printf_filtered (" starts at address ");
1574 print_address (gdbarch
, start_pc
, gdb_stdout
);
1576 printf_filtered (" and ends at ");
1577 print_address (gdbarch
, end_pc
, gdb_stdout
);
1578 printf_filtered (".\n");
1581 /* x/i should display this line's code. */
1582 set_next_address (gdbarch
, start_pc
);
1584 /* Repeating "info line" should do the following line. */
1585 last_line_listed
= sal
.line
+ 1;
1587 /* If this is the only line, show the source code. If it could
1588 not find the file, don't do anything special. */
1589 if (annotation_level
&& sals
.nelts
== 1)
1590 identify_source_line (sal
.symtab
, sal
.line
, 0, start_pc
);
1593 /* Is there any case in which we get here, and have an address
1594 which the user would want to see? If we have debugging symbols
1595 and no line numbers? */
1596 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1597 sal
.line
, symtab_to_filename_for_display (sal
.symtab
));
1599 do_cleanups (cleanups
);
1602 /* Commands to search the source file for a regexp. */
1605 forward_search_command (char *regex
, int from_tty
)
1612 struct cleanup
*cleanups
;
1614 line
= last_line_listed
+ 1;
1616 msg
= (char *) re_comp (regex
);
1618 error (("%s"), msg
);
1620 if (current_source_symtab
== 0)
1621 select_source_symtab (0);
1623 desc
= open_source_file (current_source_symtab
);
1625 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1626 cleanups
= make_cleanup_close (desc
);
1628 if (current_source_symtab
->line_charpos
== 0)
1629 find_source_lines (current_source_symtab
, desc
);
1631 if (line
< 1 || line
> current_source_symtab
->nlines
)
1632 error (_("Expression not found"));
1634 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1635 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1637 discard_cleanups (cleanups
);
1638 stream
= fdopen (desc
, FDOPEN_MODE
);
1640 cleanups
= make_cleanup_fclose (stream
);
1643 static char *buf
= NULL
;
1645 int cursize
, newsize
;
1648 buf
= xmalloc (cursize
);
1657 if (p
- buf
== cursize
)
1659 newsize
= cursize
+ cursize
/ 2;
1660 buf
= xrealloc (buf
, newsize
);
1665 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1667 /* Remove the \r, if any, at the end of the line, otherwise
1668 regular expressions that end with $ or \n won't work. */
1669 if (p
- buf
> 1 && p
[-2] == '\r')
1675 /* We now have a source line in buf, null terminate and match. */
1677 if (re_exec (buf
) > 0)
1680 do_cleanups (cleanups
);
1681 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1682 set_internalvar_integer (lookup_internalvar ("_"), line
);
1683 current_source_line
= max (line
- lines_to_list
/ 2, 1);
1689 printf_filtered (_("Expression not found\n"));
1690 do_cleanups (cleanups
);
1694 reverse_search_command (char *regex
, int from_tty
)
1701 struct cleanup
*cleanups
;
1703 line
= last_line_listed
- 1;
1705 msg
= (char *) re_comp (regex
);
1707 error (("%s"), msg
);
1709 if (current_source_symtab
== 0)
1710 select_source_symtab (0);
1712 desc
= open_source_file (current_source_symtab
);
1714 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1715 cleanups
= make_cleanup_close (desc
);
1717 if (current_source_symtab
->line_charpos
== 0)
1718 find_source_lines (current_source_symtab
, desc
);
1720 if (line
< 1 || line
> current_source_symtab
->nlines
)
1721 error (_("Expression not found"));
1723 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1724 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1726 discard_cleanups (cleanups
);
1727 stream
= fdopen (desc
, FDOPEN_MODE
);
1729 cleanups
= make_cleanup_fclose (stream
);
1732 /* FIXME!!! We walk right off the end of buf if we get a long line!!! */
1733 char buf
[4096]; /* Should be reasonable??? */
1743 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1745 /* Remove the \r, if any, at the end of the line, otherwise
1746 regular expressions that end with $ or \n won't work. */
1747 if (p
- buf
> 1 && p
[-2] == '\r')
1753 /* We now have a source line in buf; null terminate and match. */
1755 if (re_exec (buf
) > 0)
1758 do_cleanups (cleanups
);
1759 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1760 set_internalvar_integer (lookup_internalvar ("_"), line
);
1761 current_source_line
= max (line
- lines_to_list
/ 2, 1);
1765 if (fseek (stream
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1767 const char *filename
;
1769 do_cleanups (cleanups
);
1770 filename
= symtab_to_filename_for_display (current_source_symtab
);
1771 perror_with_name (filename
);
1775 printf_filtered (_("Expression not found\n"));
1776 do_cleanups (cleanups
);
1780 /* If the last character of PATH is a directory separator, then strip it. */
1783 strip_trailing_directory_separator (char *path
)
1785 const int last
= strlen (path
) - 1;
1788 return; /* No stripping is needed if PATH is the empty string. */
1790 if (IS_DIR_SEPARATOR (path
[last
]))
1794 /* Return the path substitution rule that matches FROM.
1795 Return NULL if no rule matches. */
1797 static struct substitute_path_rule
*
1798 find_substitute_path_rule (const char *from
)
1800 struct substitute_path_rule
*rule
= substitute_path_rules
;
1802 while (rule
!= NULL
)
1804 if (FILENAME_CMP (rule
->from
, from
) == 0)
1812 /* Add a new substitute-path rule at the end of the current list of rules.
1813 The new rule will replace FROM into TO. */
1816 add_substitute_path_rule (char *from
, char *to
)
1818 struct substitute_path_rule
*rule
;
1819 struct substitute_path_rule
*new_rule
;
1821 new_rule
= xmalloc (sizeof (struct substitute_path_rule
));
1822 new_rule
->from
= xstrdup (from
);
1823 new_rule
->to
= xstrdup (to
);
1824 new_rule
->next
= NULL
;
1826 /* If the list of rules are empty, then insert the new rule
1827 at the head of the list. */
1829 if (substitute_path_rules
== NULL
)
1831 substitute_path_rules
= new_rule
;
1835 /* Otherwise, skip to the last rule in our list and then append
1838 rule
= substitute_path_rules
;
1839 while (rule
->next
!= NULL
)
1842 rule
->next
= new_rule
;
1845 /* Remove the given source path substitution rule from the current list
1846 of rules. The memory allocated for that rule is also deallocated. */
1849 delete_substitute_path_rule (struct substitute_path_rule
*rule
)
1851 if (rule
== substitute_path_rules
)
1852 substitute_path_rules
= rule
->next
;
1855 struct substitute_path_rule
*prev
= substitute_path_rules
;
1857 while (prev
!= NULL
&& prev
->next
!= rule
)
1860 gdb_assert (prev
!= NULL
);
1862 prev
->next
= rule
->next
;
1870 /* Implement the "show substitute-path" command. */
1873 show_substitute_path_command (char *args
, int from_tty
)
1875 struct substitute_path_rule
*rule
= substitute_path_rules
;
1878 struct cleanup
*cleanup
;
1880 argv
= gdb_buildargv (args
);
1881 cleanup
= make_cleanup_freeargv (argv
);
1883 /* We expect zero or one argument. */
1885 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1886 error (_("Too many arguments in command"));
1888 if (argv
!= NULL
&& argv
[0] != NULL
)
1891 /* Print the substitution rules. */
1895 (_("Source path substitution rule matching `%s':\n"), from
);
1897 printf_filtered (_("List of all source path substitution rules:\n"));
1899 while (rule
!= NULL
)
1901 if (from
== NULL
|| substitute_path_rule_matches (rule
, from
) != 0)
1902 printf_filtered (" `%s' -> `%s'.\n", rule
->from
, rule
->to
);
1906 do_cleanups (cleanup
);
1909 /* Implement the "unset substitute-path" command. */
1912 unset_substitute_path_command (char *args
, int from_tty
)
1914 struct substitute_path_rule
*rule
= substitute_path_rules
;
1915 char **argv
= gdb_buildargv (args
);
1918 struct cleanup
*cleanup
;
1920 /* This function takes either 0 or 1 argument. */
1922 cleanup
= make_cleanup_freeargv (argv
);
1923 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1924 error (_("Incorrect usage, too many arguments in command"));
1926 if (argv
!= NULL
&& argv
[0] != NULL
)
1929 /* If the user asked for all the rules to be deleted, ask him
1930 to confirm and give him a chance to abort before the action
1934 && !query (_("Delete all source path substitution rules? ")))
1935 error (_("Canceled"));
1937 /* Delete the rule matching the argument. No argument means that
1938 all rules should be deleted. */
1940 while (rule
!= NULL
)
1942 struct substitute_path_rule
*next
= rule
->next
;
1944 if (from
== NULL
|| FILENAME_CMP (from
, rule
->from
) == 0)
1946 delete_substitute_path_rule (rule
);
1953 /* If the user asked for a specific rule to be deleted but
1954 we could not find it, then report an error. */
1956 if (from
!= NULL
&& !rule_found
)
1957 error (_("No substitution rule defined for `%s'"), from
);
1959 forget_cached_source_info ();
1961 do_cleanups (cleanup
);
1964 /* Add a new source path substitution rule. */
1967 set_substitute_path_command (char *args
, int from_tty
)
1970 struct substitute_path_rule
*rule
;
1971 struct cleanup
*cleanup
;
1973 argv
= gdb_buildargv (args
);
1974 cleanup
= make_cleanup_freeargv (argv
);
1976 if (argv
== NULL
|| argv
[0] == NULL
|| argv
[1] == NULL
)
1977 error (_("Incorrect usage, too few arguments in command"));
1979 if (argv
[2] != NULL
)
1980 error (_("Incorrect usage, too many arguments in command"));
1982 if (*(argv
[0]) == '\0')
1983 error (_("First argument must be at least one character long"));
1985 /* Strip any trailing directory separator character in either FROM
1986 or TO. The substitution rule already implicitly contains them. */
1987 strip_trailing_directory_separator (argv
[0]);
1988 strip_trailing_directory_separator (argv
[1]);
1990 /* If a rule with the same "from" was previously defined, then
1991 delete it. This new rule replaces it. */
1993 rule
= find_substitute_path_rule (argv
[0]);
1995 delete_substitute_path_rule (rule
);
1997 /* Insert the new substitution rule. */
1999 add_substitute_path_rule (argv
[0], argv
[1]);
2000 forget_cached_source_info ();
2002 do_cleanups (cleanup
);
2007 _initialize_source (void)
2009 struct cmd_list_element
*c
;
2011 current_source_symtab
= 0;
2012 init_source_path ();
2014 /* The intention is to use POSIX Basic Regular Expressions.
2015 Always use the GNU regex routine for consistency across all hosts.
2016 Our current GNU regex.c does not have all the POSIX features, so this is
2017 just an approximation. */
2018 re_set_syntax (RE_SYNTAX_GREP
);
2020 c
= add_cmd ("directory", class_files
, directory_command
, _("\
2021 Add directory DIR to beginning of search path for source files.\n\
2022 Forget cached info on source file locations and line positions.\n\
2023 DIR can also be $cwd for the current working directory, or $cdir for the\n\
2024 directory in which the source file was compiled into object code.\n\
2025 With no argument, reset the search path to $cdir:$cwd, the default."),
2029 add_com_alias ("use", "directory", class_files
, 0);
2031 set_cmd_completer (c
, filename_completer
);
2033 add_setshow_optional_filename_cmd ("directories",
2037 Set the search path for finding source files."),
2039 Show the search path for finding source files."),
2041 $cwd in the path means the current working directory.\n\
2042 $cdir in the path means the compilation directory of the source file.\n\
2043 GDB ensures the search path always ends with $cdir:$cwd by\n\
2044 appending these directories if necessary.\n\
2045 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
2046 set_directories_command
,
2047 show_directories_command
,
2048 &setlist
, &showlist
);
2050 add_info ("source", source_info
,
2051 _("Information about the current source file."));
2053 add_info ("line", line_info
, _("\
2054 Core addresses of the code for a source line.\n\
2055 Line can be specified as\n\
2056 LINENUM, to list around that line in current file,\n\
2057 FILE:LINENUM, to list around that line in that file,\n\
2058 FUNCTION, to list around beginning of that function,\n\
2059 FILE:FUNCTION, to distinguish among like-named static functions.\n\
2060 Default is to describe the last source line that was listed.\n\n\
2061 This sets the default address for \"x\" to the line's first instruction\n\
2062 so that \"x/i\" suffices to start examining the machine code.\n\
2063 The address is also stored as the value of \"$_\"."));
2065 add_com ("forward-search", class_files
, forward_search_command
, _("\
2066 Search for regular expression (see regex(3)) from last line listed.\n\
2067 The matching line number is also stored as the value of \"$_\"."));
2068 add_com_alias ("search", "forward-search", class_files
, 0);
2069 add_com_alias ("fo", "forward-search", class_files
, 1);
2071 add_com ("reverse-search", class_files
, reverse_search_command
, _("\
2072 Search backward for regular expression (see regex(3)) from last line listed.\n\
2073 The matching line number is also stored as the value of \"$_\"."));
2074 add_com_alias ("rev", "reverse-search", class_files
, 1);
2076 add_setshow_integer_cmd ("listsize", class_support
, &lines_to_list
, _("\
2077 Set number of source lines gdb will list by default."), _("\
2078 Show number of source lines gdb will list by default."), _("\
2079 Use this to choose how many source lines the \"list\" displays (unless\n\
2080 the \"list\" argument explicitly specifies some other number).\n\
2081 A value of \"unlimited\", or zero, means there's no limit."),
2084 &setlist
, &showlist
);
2086 add_cmd ("substitute-path", class_files
, set_substitute_path_command
,
2088 Usage: set substitute-path FROM TO\n\
2089 Add a substitution rule replacing FROM into TO in source file names.\n\
2090 If a substitution rule was previously set for FROM, the old rule\n\
2091 is replaced by the new one."),
2094 add_cmd ("substitute-path", class_files
, unset_substitute_path_command
,
2096 Usage: unset substitute-path [FROM]\n\
2097 Delete the rule for substituting FROM in source file names. If FROM\n\
2098 is not specified, all substituting rules are deleted.\n\
2099 If the debugger cannot find a rule for FROM, it will display a warning."),
2102 add_cmd ("substitute-path", class_files
, show_substitute_path_command
,
2104 Usage: show substitute-path [FROM]\n\
2105 Print the rule for substituting FROM in source file names. If FROM\n\
2106 is not specified, print all substitution rules."),
2109 add_setshow_enum_cmd ("filename-display", class_files
,
2110 filename_display_kind_names
,
2111 &filename_display_string
, _("\
2112 Set how to display filenames."), _("\
2113 Show how to display filenames."), _("\
2114 filename-display can be:\n\
2115 basename - display only basename of a filename\n\
2116 relative - display a filename relative to the compilation directory\n\
2117 absolute - display an absolute filename\n\
2118 By default, relative filenames are displayed."),
2120 show_filename_display_string
,
2121 &setlist
, &showlist
);