1 /* List lines of source files for GDB, the GNU debugger.
2 Copyright (C) 1986-2018 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"
45 #include "common/enum-flags.h"
47 #include "common/pathstuff.h"
49 #define OPEN_MODE (O_RDONLY | O_BINARY)
50 #define FDOPEN_MODE FOPEN_RB
52 /* Prototypes for local functions. */
54 static int get_filename_and_charpos (struct symtab
*, char **);
56 /* Path of directories to search for source files.
57 Same format as the PATH environment variable's value. */
61 /* Support for source path substitution commands. */
63 struct substitute_path_rule
67 struct substitute_path_rule
*next
;
70 static struct substitute_path_rule
*substitute_path_rules
= NULL
;
72 /* Symtab of default file for listing lines of. */
74 static struct symtab
*current_source_symtab
;
76 /* Default next line to list. */
78 static int current_source_line
;
80 static struct program_space
*current_source_pspace
;
82 /* Default number of lines to print with commands like "list".
83 This is based on guessing how many long (i.e. more than chars_per_line
84 characters) lines there will be. To be completely correct, "list"
85 and friends should be rewritten to count characters and see where
86 things are wrapping, but that would be a fair amount of work. */
88 static int lines_to_list
= 10;
90 show_lines_to_list (struct ui_file
*file
, int from_tty
,
91 struct cmd_list_element
*c
, const char *value
)
93 fprintf_filtered (file
,
94 _("Number of source lines gdb "
95 "will list by default is %s.\n"),
99 /* Possible values of 'set filename-display'. */
100 static const char filename_display_basename
[] = "basename";
101 static const char filename_display_relative
[] = "relative";
102 static const char filename_display_absolute
[] = "absolute";
104 static const char *const filename_display_kind_names
[] = {
105 filename_display_basename
,
106 filename_display_relative
,
107 filename_display_absolute
,
111 static const char *filename_display_string
= filename_display_relative
;
114 show_filename_display_string (struct ui_file
*file
, int from_tty
,
115 struct cmd_list_element
*c
, const char *value
)
117 fprintf_filtered (file
, _("Filenames are displayed as \"%s\".\n"), value
);
120 /* Line number of last line printed. Default for various commands.
121 current_source_line is usually, but not always, the same as this. */
123 static int last_line_listed
;
125 /* First line number listed by last listing command. If 0, then no
126 source lines have yet been listed since the last time the current
127 source line was changed. */
129 static int first_line_listed
;
131 /* Saves the name of the last source file visited and a possible error code.
132 Used to prevent repeating annoying "No such file or directories" msgs. */
134 static struct symtab
*last_source_visited
= NULL
;
135 static int last_source_error
= 0;
137 /* Return the first line listed by print_source_lines.
138 Used by command interpreters to request listing from
142 get_first_line_listed (void)
144 return first_line_listed
;
147 /* Clear line listed range. This makes the next "list" center the
148 printed source lines around the current source line. */
151 clear_lines_listed_range (void)
153 first_line_listed
= 0;
154 last_line_listed
= 0;
157 /* Return the default number of lines to print with commands like the
158 cli "list". The caller of print_source_lines must use this to
159 calculate the end line and use it in the call to print_source_lines
160 as it does not automatically use this value. */
163 get_lines_to_list (void)
165 return lines_to_list
;
168 /* Return the current source file for listing and next line to list.
169 NOTE: The returned sal pc and end fields are not valid. */
171 struct symtab_and_line
172 get_current_source_symtab_and_line (void)
174 symtab_and_line cursal
;
176 cursal
.pspace
= current_source_pspace
;
177 cursal
.symtab
= current_source_symtab
;
178 cursal
.line
= current_source_line
;
185 /* If the current source file for listing is not set, try and get a default.
186 Usually called before get_current_source_symtab_and_line() is called.
187 It may err out if a default cannot be determined.
188 We must be cautious about where it is called, as it can recurse as the
189 process of determining a new default may call the caller!
190 Use get_current_source_symtab_and_line only to get whatever
191 we have without erroring out or trying to get a default. */
194 set_default_source_symtab_and_line (void)
196 if (!have_full_symbols () && !have_partial_symbols ())
197 error (_("No symbol table is loaded. Use the \"file\" command."));
199 /* Pull in a current source symtab if necessary. */
200 if (current_source_symtab
== 0)
201 select_source_symtab (0);
204 /* Return the current default file for listing and next line to list
205 (the returned sal pc and end fields are not valid.)
206 and set the current default to whatever is in SAL.
207 NOTE: The returned sal pc and end fields are not valid. */
209 struct symtab_and_line
210 set_current_source_symtab_and_line (const symtab_and_line
&sal
)
212 symtab_and_line cursal
;
214 cursal
.pspace
= current_source_pspace
;
215 cursal
.symtab
= current_source_symtab
;
216 cursal
.line
= current_source_line
;
220 current_source_pspace
= sal
.pspace
;
221 current_source_symtab
= sal
.symtab
;
222 current_source_line
= sal
.line
;
224 /* Force the next "list" to center around the current line. */
225 clear_lines_listed_range ();
230 /* Reset any information stored about a default file and line to print. */
233 clear_current_source_symtab_and_line (void)
235 current_source_symtab
= 0;
236 current_source_line
= 0;
239 /* Set the source file default for the "list" command to be S.
241 If S is NULL, and we don't have a default, find one. This
242 should only be called when the user actually tries to use the
243 default, since we produce an error if we can't find a reasonable
244 default. Also, since this can cause symbols to be read, doing it
245 before we need to would make things slower than necessary. */
248 select_source_symtab (struct symtab
*s
)
251 struct compunit_symtab
*cu
;
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).symbol
)
268 std::vector
<symtab_and_line
> sals
269 = decode_line_with_current_source (main_name (),
270 DECODE_LINE_FUNFIRSTLINE
);
271 const symtab_and_line
&sal
= sals
[0];
272 current_source_pspace
= sal
.pspace
;
273 current_source_symtab
= sal
.symtab
;
274 current_source_line
= std::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;
284 ALL_FILETABS (ofp
, cu
, s
)
286 const char *name
= s
->filename
;
287 int len
= strlen (name
);
289 if (!(len
> 2 && (strcmp (&name
[len
- 2], ".h") == 0
290 || strcmp (name
, "<<C++-namespaces>>") == 0)))
292 current_source_pspace
= current_program_space
;
293 current_source_symtab
= s
;
297 if (current_source_symtab
)
303 s
= ofp
->sf
->qf
->find_last_source_symtab (ofp
);
305 current_source_symtab
= s
;
307 if (current_source_symtab
)
310 error (_("Can't find a default source file"));
313 /* Handler for "set directories path-list" command.
314 "set dir mumble" doesn't prepend paths, it resets the entire
315 path list. The theory is that set(show(dir)) should be a no-op. */
318 set_directories_command (const char *args
,
319 int from_tty
, struct cmd_list_element
*c
)
321 /* This is the value that was set.
322 It needs to be processed to maintain $cdir:$cwd and remove dups. */
323 char *set_path
= source_path
;
325 /* We preserve the invariant that $cdir:$cwd begins life at the end of
326 the list by calling init_source_path. If they appear earlier in
327 SET_PATH then mod_path will move them appropriately.
328 mod_path will also remove duplicates. */
330 if (*set_path
!= '\0')
331 mod_path (set_path
, &source_path
);
336 /* Print the list of source directories.
337 This is used by the "ld" command, so it has the signature of a command
341 show_directories_1 (char *ignore
, int from_tty
)
343 puts_filtered ("Source directories searched: ");
344 puts_filtered (source_path
);
345 puts_filtered ("\n");
348 /* Handler for "show directories" command. */
351 show_directories_command (struct ui_file
*file
, int from_tty
,
352 struct cmd_list_element
*c
, const char *value
)
354 show_directories_1 (NULL
, from_tty
);
357 /* Forget line positions and file names for the symtabs in a
358 particular objfile. */
361 forget_cached_source_info_for_objfile (struct objfile
*objfile
)
363 struct compunit_symtab
*cu
;
366 ALL_OBJFILE_FILETABS (objfile
, cu
, s
)
368 if (s
->line_charpos
!= NULL
)
370 xfree (s
->line_charpos
);
371 s
->line_charpos
= NULL
;
373 if (s
->fullname
!= NULL
)
381 objfile
->sf
->qf
->forget_cached_source_info (objfile
);
384 /* Forget what we learned about line positions in source files, and
385 which directories contain them; must check again now since files
386 may be found in a different directory now. */
389 forget_cached_source_info (void)
391 struct program_space
*pspace
;
392 struct objfile
*objfile
;
395 ALL_PSPACE_OBJFILES (pspace
, objfile
)
397 forget_cached_source_info_for_objfile (objfile
);
400 last_source_visited
= NULL
;
404 init_source_path (void)
408 xsnprintf (buf
, sizeof (buf
), "$cdir%c$cwd", DIRNAME_SEPARATOR
);
409 source_path
= xstrdup (buf
);
410 forget_cached_source_info ();
413 /* Add zero or more directories to the front of the source path. */
416 directory_command (const char *dirname
, int from_tty
)
419 /* FIXME, this goes to "delete dir"... */
422 if (!from_tty
|| query (_("Reinitialize source path to empty? ")))
430 mod_path (dirname
, &source_path
);
431 forget_cached_source_info ();
434 show_directories_1 ((char *) 0, from_tty
);
437 /* Add a path given with the -d command line switch.
438 This will not be quoted so we must not treat spaces as separators. */
441 directory_switch (const char *dirname
, int from_tty
)
443 add_path (dirname
, &source_path
, 0);
446 /* Add zero or more directories to the front of an arbitrary path. */
449 mod_path (const char *dirname
, char **which_path
)
451 add_path (dirname
, which_path
, 1);
454 /* Workhorse of mod_path. Takes an extra argument to determine
455 if dirname should be parsed for separators that indicate multiple
456 directories. This allows for interfaces that pre-parse the dirname
457 and allow specification of traditional separator characters such
461 add_path (const char *dirname
, char **which_path
, int parse_separators
)
463 char *old
= *which_path
;
465 VEC (char_ptr
) *dir_vec
= NULL
;
466 struct cleanup
*back_to
;
473 if (parse_separators
)
475 /* This will properly parse the space and tab separators
476 and any quotes that may exist. */
477 gdb_argv
argv (dirname
);
479 for (char *arg
: argv
)
480 dirnames_to_char_ptr_vec_append (&dir_vec
, arg
);
483 VEC_safe_push (char_ptr
, dir_vec
, xstrdup (dirname
));
484 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
486 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, name
); ++ix
)
491 /* Spaces and tabs will have been removed by buildargv().
492 NAME is the start of the directory.
493 P is the '\0' following the end. */
494 p
= name
+ strlen (name
);
496 while (!(IS_DIR_SEPARATOR (*name
) && p
<= name
+ 1) /* "/" */
497 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
498 /* On MS-DOS and MS-Windows, h:\ is different from h: */
499 && !(p
== name
+ 3 && name
[1] == ':') /* "d:/" */
501 && IS_DIR_SEPARATOR (p
[-1]))
502 /* Sigh. "foo/" => "foo" */
506 while (p
> name
&& p
[-1] == '.')
510 /* "." => getwd (). */
511 name
= current_directory
;
514 else if (p
> name
+ 1 && IS_DIR_SEPARATOR (p
[-2]))
524 /* "...foo/." => "...foo". */
535 name
= tilde_expand (name
);
536 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
537 else if (IS_ABSOLUTE_PATH (name
) && p
== name
+ 2) /* "d:" => "d:." */
538 name
= concat (name
, ".", (char *)NULL
);
540 else if (!IS_ABSOLUTE_PATH (name
) && name
[0] != '$')
541 name
= concat (current_directory
, SLASH_STRING
, name
, (char *)NULL
);
543 name
= savestring (name
, p
- name
);
544 make_cleanup (xfree
, name
);
546 /* Unless it's a variable, check existence. */
549 /* These are warnings, not errors, since we don't want a
550 non-existent directory in a .gdbinit file to stop processing
551 of the .gdbinit file.
553 Whether they get added to the path is more debatable. Current
554 answer is yes, in case the user wants to go make the directory
555 or whatever. If the directory continues to not exist/not be
556 a directory/etc, then having them in the path should be
558 if (stat (name
, &st
) < 0)
560 int save_errno
= errno
;
562 fprintf_unfiltered (gdb_stderr
, "Warning: ");
563 print_sys_errmsg (name
, save_errno
);
565 else if ((st
.st_mode
& S_IFMT
) != S_IFDIR
)
566 warning (_("%s is not a directory."), name
);
571 unsigned int len
= strlen (name
);
577 /* FIXME: we should use realpath() or its work-alike
578 before comparing. Then all the code above which
579 removes excess slashes and dots could simply go away. */
580 if (!filename_ncmp (p
, name
, len
)
581 && (p
[len
] == '\0' || p
[len
] == DIRNAME_SEPARATOR
))
583 /* Found it in the search path, remove old copy. */
586 /* Back over leading separator. */
589 if (prefix
> p
- *which_path
)
591 /* Same dir twice in one cmd. */
594 /* Copy from next '\0' or ':'. */
595 memmove (p
, &p
[len
+ 1], strlen (&p
[len
+ 1]) + 1);
597 p
= strchr (p
, DIRNAME_SEPARATOR
);
604 tinybuf
[0] = DIRNAME_SEPARATOR
;
607 /* If we have already tacked on a name(s) in this command,
608 be sure they stay on the front as we tack on some
616 temp
= concat (old
, tinybuf
, name
, (char *)NULL
);
618 *which_path
= concat (temp
, "", &old
[prefix
], (char *) NULL
);
619 prefix
= strlen (temp
);
624 *which_path
= concat (name
, (old
[0] ? tinybuf
: old
),
626 prefix
= strlen (name
);
635 do_cleanups (back_to
);
640 info_source_command (const char *ignore
, int from_tty
)
642 struct symtab
*s
= current_source_symtab
;
643 struct compunit_symtab
*cust
;
647 printf_filtered (_("No current source file.\n"));
651 cust
= SYMTAB_COMPUNIT (s
);
652 printf_filtered (_("Current source file is %s\n"), s
->filename
);
653 if (SYMTAB_DIRNAME (s
) != NULL
)
654 printf_filtered (_("Compilation directory is %s\n"), SYMTAB_DIRNAME (s
));
656 printf_filtered (_("Located in %s\n"), s
->fullname
);
658 printf_filtered (_("Contains %d line%s.\n"), s
->nlines
,
659 s
->nlines
== 1 ? "" : "s");
661 printf_filtered (_("Source language is %s.\n"), language_str (s
->language
));
662 printf_filtered (_("Producer is %s.\n"),
663 COMPUNIT_PRODUCER (cust
) != NULL
664 ? COMPUNIT_PRODUCER (cust
) : _("unknown"));
665 printf_filtered (_("Compiled with %s debugging format.\n"),
666 COMPUNIT_DEBUGFORMAT (cust
));
667 printf_filtered (_("%s preprocessor macro info.\n"),
668 COMPUNIT_MACRO_TABLE (cust
) != NULL
669 ? "Includes" : "Does not include");
673 /* Return True if the file NAME exists and is a regular file.
674 If the result is false then *ERRNO_PTR is set to a useful value assuming
675 we're expecting a regular file. */
678 is_regular_file (const char *name
, int *errno_ptr
)
681 const int status
= stat (name
, &st
);
683 /* Stat should never fail except when the file does not exist.
684 If stat fails, analyze the source of error and return True
685 unless the file does not exist, to avoid returning false results
686 on obscure systems where stat does not work as expected. */
696 if (S_ISREG (st
.st_mode
))
699 if (S_ISDIR (st
.st_mode
))
706 /* Open a file named STRING, searching path PATH (dir names sep by some char)
707 using mode MODE in the calls to open. You cannot use this function to
708 create files (O_CREAT).
710 OPTS specifies the function behaviour in specific cases.
712 If OPF_TRY_CWD_FIRST, try to open ./STRING before searching PATH.
713 (ie pretend the first element of PATH is "."). This also indicates
714 that, unless OPF_SEARCH_IN_PATH is also specified, a slash in STRING
715 disables searching of the path (this is so that "exec-file ./foo" or
716 "symbol-file ./foo" insures that you get that particular version of
717 foo or an error message).
719 If OPTS has OPF_SEARCH_IN_PATH set, absolute names will also be
720 searched in path (we usually want this for source files but not for
723 If FILENAME_OPENED is non-null, set it to a newly allocated string naming
724 the actual file opened (this string will always start with a "/"). We
725 have to take special pains to avoid doubling the "/" between the directory
726 and the file, sigh! Emacs gets confuzzed by this when we print the
729 If OPTS has OPF_RETURN_REALPATH set return FILENAME_OPENED resolved by
730 gdb_realpath. Even without OPF_RETURN_REALPATH this function still returns
731 filename starting with "/". If FILENAME_OPENED is NULL this option has no
734 If a file is found, return the descriptor.
735 Otherwise, return -1, with errno set for the last name we tried to open. */
737 /* >>>> This should only allow files of certain types,
738 >>>> eg executable, non-directory. */
740 openp (const char *path
, openp_flags opts
, const char *string
,
741 int mode
, gdb::unique_xmalloc_ptr
<char> *filename_opened
)
746 VEC (char_ptr
) *dir_vec
;
747 struct cleanup
*back_to
;
750 /* The errno set for the last name we tried to open (and
754 /* The open syscall MODE parameter is not specified. */
755 gdb_assert ((mode
& O_CREAT
) == 0);
756 gdb_assert (string
!= NULL
);
758 /* A file with an empty name cannot possibly exist. Report a failure
759 without further checking.
761 This is an optimization which also defends us against buggy
762 implementations of the "stat" function. For instance, we have
763 noticed that a MinGW debugger built on Windows XP 32bits crashes
764 when the debugger is started with an empty argument. */
765 if (string
[0] == '\0')
776 if ((opts
& OPF_TRY_CWD_FIRST
) || IS_ABSOLUTE_PATH (string
))
778 int i
, reg_file_errno
;
780 if (is_regular_file (string
, ®_file_errno
))
782 filename
= (char *) alloca (strlen (string
) + 1);
783 strcpy (filename
, string
);
784 fd
= gdb_open_cloexec (filename
, mode
, 0);
793 last_errno
= reg_file_errno
;
796 if (!(opts
& OPF_SEARCH_IN_PATH
))
797 for (i
= 0; string
[i
]; i
++)
798 if (IS_DIR_SEPARATOR (string
[i
]))
802 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
803 if (HAS_DRIVE_SPEC (string
))
804 string
= STRIP_DRIVE_SPEC (string
);
806 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
807 while (IS_DIR_SEPARATOR(string
[0]))
811 while (string
[0] == '.' && IS_DIR_SEPARATOR (string
[1]))
814 alloclen
= strlen (path
) + strlen (string
) + 2;
815 filename
= (char *) alloca (alloclen
);
819 dir_vec
= dirnames_to_char_ptr_vec (path
);
820 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
822 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, dir
); ++ix
)
824 size_t len
= strlen (dir
);
827 if (strcmp (dir
, "$cwd") == 0)
829 /* Name is $cwd -- insert current directory name instead. */
832 /* First, realloc the filename buffer if too short. */
833 len
= strlen (current_directory
);
834 newlen
= len
+ strlen (string
) + 2;
835 if (newlen
> alloclen
)
838 filename
= (char *) alloca (alloclen
);
840 strcpy (filename
, current_directory
);
842 else if (strchr(dir
, '~'))
844 /* See whether we need to expand the tilde. */
847 gdb::unique_xmalloc_ptr
<char> tilde_expanded (tilde_expand (dir
));
849 /* First, realloc the filename buffer if too short. */
850 len
= strlen (tilde_expanded
.get ());
851 newlen
= len
+ strlen (string
) + 2;
852 if (newlen
> alloclen
)
855 filename
= (char *) alloca (alloclen
);
857 strcpy (filename
, tilde_expanded
.get ());
861 /* Normal file name in path -- just use it. */
862 strcpy (filename
, dir
);
864 /* Don't search $cdir. It's also a magic path like $cwd, but we
865 don't have enough information to expand it. The user *could*
866 have an actual directory named '$cdir' but handling that would
867 be confusing, it would mean different things in different
868 contexts. If the user really has '$cdir' one can use './$cdir'.
869 We can get $cdir when loading scripts. When loading source files
870 $cdir must have already been expanded to the correct value. */
871 if (strcmp (dir
, "$cdir") == 0)
875 /* Remove trailing slashes. */
876 while (len
> 0 && IS_DIR_SEPARATOR (filename
[len
- 1]))
879 strcat (filename
+ len
, SLASH_STRING
);
880 strcat (filename
, string
);
882 if (is_regular_file (filename
, ®_file_errno
))
884 fd
= gdb_open_cloexec (filename
, mode
, 0);
890 last_errno
= reg_file_errno
;
893 do_cleanups (back_to
);
898 /* If a file was opened, canonicalize its filename. */
900 filename_opened
->reset (NULL
);
901 else if ((opts
& OPF_RETURN_REALPATH
) != 0)
902 *filename_opened
= gdb_realpath (filename
);
904 *filename_opened
= gdb_abspath (filename
);
912 /* This is essentially a convenience, for clients that want the behaviour
913 of openp, using source_path, but that really don't want the file to be
914 opened but want instead just to know what the full pathname is (as
915 qualified against source_path).
917 The current working directory is searched first.
919 If the file was found, this function returns 1, and FULL_PATHNAME is
920 set to the fully-qualified pathname.
922 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
924 source_full_path_of (const char *filename
,
925 gdb::unique_xmalloc_ptr
<char> *full_pathname
)
929 fd
= openp (source_path
,
930 OPF_TRY_CWD_FIRST
| OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
,
931 filename
, O_RDONLY
, full_pathname
);
934 full_pathname
->reset (NULL
);
942 /* Return non-zero if RULE matches PATH, that is if the rule can be
946 substitute_path_rule_matches (const struct substitute_path_rule
*rule
,
949 const int from_len
= strlen (rule
->from
);
950 const int path_len
= strlen (path
);
952 if (path_len
< from_len
)
955 /* The substitution rules are anchored at the start of the path,
956 so the path should start with rule->from. */
958 if (filename_ncmp (path
, rule
->from
, from_len
) != 0)
961 /* Make sure that the region in the path that matches the substitution
962 rule is immediately followed by a directory separator (or the end of
963 string character). */
965 if (path
[from_len
] != '\0' && !IS_DIR_SEPARATOR (path
[from_len
]))
971 /* Find the substitute-path rule that applies to PATH and return it.
972 Return NULL if no rule applies. */
974 static struct substitute_path_rule
*
975 get_substitute_path_rule (const char *path
)
977 struct substitute_path_rule
*rule
= substitute_path_rules
;
979 while (rule
!= NULL
&& !substitute_path_rule_matches (rule
, path
))
985 /* If the user specified a source path substitution rule that applies
986 to PATH, then apply it and return the new path.
988 Return NULL if no substitution rule was specified by the user,
989 or if no rule applied to the given PATH. */
991 gdb::unique_xmalloc_ptr
<char>
992 rewrite_source_path (const char *path
)
994 const struct substitute_path_rule
*rule
= get_substitute_path_rule (path
);
1001 from_len
= strlen (rule
->from
);
1003 /* Compute the rewritten path and return it. */
1006 (char *) xmalloc (strlen (path
) + 1 + strlen (rule
->to
) - from_len
);
1007 strcpy (new_path
, rule
->to
);
1008 strcat (new_path
, path
+ from_len
);
1010 return gdb::unique_xmalloc_ptr
<char> (new_path
);
1014 find_and_open_source (const char *filename
,
1015 const char *dirname
,
1016 gdb::unique_xmalloc_ptr
<char> *fullname
)
1018 char *path
= source_path
;
1022 /* Quick way out if we already know its full name. */
1026 /* The user may have requested that source paths be rewritten
1027 according to substitution rules he provided. If a substitution
1028 rule applies to this path, then apply it. */
1029 gdb::unique_xmalloc_ptr
<char> rewritten_fullname
1030 = rewrite_source_path (fullname
->get ());
1032 if (rewritten_fullname
!= NULL
)
1033 *fullname
= std::move (rewritten_fullname
);
1035 result
= gdb_open_cloexec (fullname
->get (), OPEN_MODE
, 0);
1038 *fullname
= gdb_realpath (fullname
->get ());
1042 /* Didn't work -- free old one, try again. */
1043 fullname
->reset (NULL
);
1046 gdb::unique_xmalloc_ptr
<char> rewritten_dirname
;
1047 if (dirname
!= NULL
)
1049 /* If necessary, rewrite the compilation directory name according
1050 to the source path substitution rules specified by the user. */
1052 rewritten_dirname
= rewrite_source_path (dirname
);
1054 if (rewritten_dirname
!= NULL
)
1055 dirname
= rewritten_dirname
.get ();
1057 /* Replace a path entry of $cdir with the compilation directory
1060 /* We cast strstr's result in case an ANSIhole has made it const,
1061 which produces a "required warning" when assigned to a nonconst. */
1062 p
= (char *) strstr (source_path
, "$cdir");
1063 if (p
&& (p
== path
|| p
[-1] == DIRNAME_SEPARATOR
)
1064 && (p
[cdir_len
] == DIRNAME_SEPARATOR
|| p
[cdir_len
] == '\0'))
1069 alloca (strlen (source_path
) + 1 + strlen (dirname
) + 1);
1070 len
= p
- source_path
;
1071 strncpy (path
, source_path
, len
); /* Before $cdir */
1072 strcpy (path
+ len
, dirname
); /* new stuff */
1073 strcat (path
+ len
, source_path
+ len
+ cdir_len
); /* After
1078 gdb::unique_xmalloc_ptr
<char> rewritten_filename
;
1079 if (IS_ABSOLUTE_PATH (filename
))
1081 /* If filename is absolute path, try the source path
1082 substitution on it. */
1083 rewritten_filename
= rewrite_source_path (filename
);
1085 if (rewritten_filename
!= NULL
)
1086 filename
= rewritten_filename
.get ();
1089 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, filename
,
1090 OPEN_MODE
, fullname
);
1093 /* Didn't work. Try using just the basename. */
1094 p
= lbasename (filename
);
1096 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, p
,
1097 OPEN_MODE
, fullname
);
1103 /* Open a source file given a symtab S. Returns a file descriptor or
1104 negative number for error.
1106 This function is a convience function to find_and_open_source. */
1109 open_source_file (struct symtab
*s
)
1114 gdb::unique_xmalloc_ptr
<char> fullname
;
1115 int fd
= find_and_open_source (s
->filename
, SYMTAB_DIRNAME (s
), &fullname
);
1116 s
->fullname
= fullname
.release ();
1120 /* Finds the fullname that a symtab represents.
1122 This functions finds the fullname and saves it in s->fullname.
1123 It will also return the value.
1125 If this function fails to find the file that this symtab represents,
1126 the expected fullname is used. Therefore the files does not have to
1130 symtab_to_fullname (struct symtab
*s
)
1132 /* Use cached copy if we have it.
1133 We rely on forget_cached_source_info being called appropriately
1134 to handle cases like the file being moved. */
1135 if (s
->fullname
== NULL
)
1137 int fd
= open_source_file (s
);
1143 gdb::unique_xmalloc_ptr
<char> fullname
;
1145 /* rewrite_source_path would be applied by find_and_open_source, we
1146 should report the pathname where GDB tried to find the file. */
1148 if (SYMTAB_DIRNAME (s
) == NULL
|| IS_ABSOLUTE_PATH (s
->filename
))
1149 fullname
.reset (xstrdup (s
->filename
));
1151 fullname
.reset (concat (SYMTAB_DIRNAME (s
), SLASH_STRING
,
1152 s
->filename
, (char *) NULL
));
1154 s
->fullname
= rewrite_source_path (fullname
.get ()).release ();
1155 if (s
->fullname
== NULL
)
1156 s
->fullname
= fullname
.release ();
1163 /* See commentary in source.h. */
1166 symtab_to_filename_for_display (struct symtab
*symtab
)
1168 if (filename_display_string
== filename_display_basename
)
1169 return lbasename (symtab
->filename
);
1170 else if (filename_display_string
== filename_display_absolute
)
1171 return symtab_to_fullname (symtab
);
1172 else if (filename_display_string
== filename_display_relative
)
1173 return symtab
->filename
;
1175 internal_error (__FILE__
, __LINE__
, _("invalid filename_display_string"));
1178 /* Create and initialize the table S->line_charpos that records
1179 the positions of the lines in the source file, which is assumed
1180 to be open on descriptor DESC.
1181 All set S->nlines to the number of such lines. */
1184 find_source_lines (struct symtab
*s
, int desc
)
1189 int lines_allocated
= 1000;
1195 line_charpos
= XNEWVEC (int, lines_allocated
);
1196 if (fstat (desc
, &st
) < 0)
1197 perror_with_name (symtab_to_filename_for_display (s
));
1199 if (SYMTAB_OBJFILE (s
) != NULL
&& SYMTAB_OBJFILE (s
)->obfd
!= NULL
)
1200 mtime
= SYMTAB_OBJFILE (s
)->mtime
;
1202 mtime
= exec_bfd_mtime
;
1204 if (mtime
&& mtime
< st
.st_mtime
)
1205 warning (_("Source file is more recent than executable."));
1208 /* st_size might be a large type, but we only support source files whose
1209 size fits in an int. */
1210 size
= (int) st
.st_size
;
1212 /* Use the heap, not the stack, because this may be pretty large,
1213 and we may run into various kinds of limits on stack size. */
1214 gdb::def_vector
<char> data (size
);
1216 /* Reassign `size' to result of read for systems where \r\n -> \n. */
1217 size
= myread (desc
, data
.data (), size
);
1219 perror_with_name (symtab_to_filename_for_display (s
));
1220 end
= data
.data () + size
;
1222 line_charpos
[0] = 0;
1227 /* A newline at the end does not start a new line. */
1230 if (nlines
== lines_allocated
)
1232 lines_allocated
*= 2;
1234 (int *) xrealloc ((char *) line_charpos
,
1235 sizeof (int) * lines_allocated
);
1237 line_charpos
[nlines
++] = p
- data
.data ();
1244 (int *) xrealloc ((char *) line_charpos
, nlines
* sizeof (int));
1250 /* Get full pathname and line number positions for a symtab.
1251 Return nonzero if line numbers may have changed.
1252 Set *FULLNAME to actual name of the file as found by `openp',
1253 or to 0 if the file is not found. */
1256 get_filename_and_charpos (struct symtab
*s
, char **fullname
)
1258 int desc
, linenums_changed
= 0;
1259 struct cleanup
*cleanups
;
1261 desc
= open_source_file (s
);
1268 cleanups
= make_cleanup_close (desc
);
1270 *fullname
= s
->fullname
;
1271 if (s
->line_charpos
== 0)
1272 linenums_changed
= 1;
1273 if (linenums_changed
)
1274 find_source_lines (s
, desc
);
1275 do_cleanups (cleanups
);
1276 return linenums_changed
;
1279 /* Print text describing the full name of the source file S
1280 and the line number LINE and its corresponding character position.
1281 The text starts with two Ctrl-z so that the Emacs-GDB interface
1284 MID_STATEMENT is nonzero if the PC is not at the beginning of that line.
1286 Return 1 if successful, 0 if could not find the file. */
1289 identify_source_line (struct symtab
*s
, int line
, int mid_statement
,
1292 if (s
->line_charpos
== 0)
1293 get_filename_and_charpos (s
, (char **) NULL
);
1294 if (s
->fullname
== 0)
1296 if (line
> s
->nlines
)
1297 /* Don't index off the end of the line_charpos array. */
1299 annotate_source (s
->fullname
, line
, s
->line_charpos
[line
- 1],
1300 mid_statement
, get_objfile_arch (SYMTAB_OBJFILE (s
)), pc
);
1302 current_source_line
= line
;
1303 current_source_symtab
= s
;
1304 clear_lines_listed_range ();
1309 /* Print source lines from the file of symtab S,
1310 starting with line number LINE and stopping before line number STOPLINE. */
1313 print_source_lines_base (struct symtab
*s
, int line
, int stopline
,
1314 print_source_lines_flags flags
)
1319 int nlines
= stopline
- line
;
1320 struct ui_out
*uiout
= current_uiout
;
1322 /* Regardless of whether we can open the file, set current_source_symtab. */
1323 current_source_symtab
= s
;
1324 current_source_line
= line
;
1325 first_line_listed
= line
;
1327 /* If printing of source lines is disabled, just print file and line
1329 if (uiout
->test_flags (ui_source_list
))
1331 /* Only prints "No such file or directory" once. */
1332 if ((s
!= last_source_visited
) || (!last_source_error
))
1334 last_source_visited
= s
;
1335 desc
= open_source_file (s
);
1339 desc
= last_source_error
;
1340 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1345 desc
= last_source_error
;
1346 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1350 if (desc
< 0 || noprint
)
1352 last_source_error
= desc
;
1354 if (!(flags
& PRINT_SOURCE_LINES_NOERROR
))
1356 const char *filename
= symtab_to_filename_for_display (s
);
1357 int len
= strlen (filename
) + 100;
1358 char *name
= (char *) alloca (len
);
1360 xsnprintf (name
, len
, "%d\t%s", line
, filename
);
1361 print_sys_errmsg (name
, errno
);
1365 uiout
->field_int ("line", line
);
1366 uiout
->text ("\tin ");
1368 /* CLI expects only the "file" field. TUI expects only the
1369 "fullname" field (and TUI does break if "file" is printed).
1370 MI expects both fields. ui_source_list is set only for CLI,
1372 if (uiout
->is_mi_like_p () || uiout
->test_flags (ui_source_list
))
1373 uiout
->field_string ("file", symtab_to_filename_for_display (s
));
1374 if (uiout
->is_mi_like_p () || !uiout
->test_flags (ui_source_list
))
1376 const char *s_fullname
= symtab_to_fullname (s
);
1377 char *local_fullname
;
1379 /* ui_out_field_string may free S_FULLNAME by calling
1380 open_source_file for it again. See e.g.,
1381 tui_field_string->tui_show_source. */
1382 local_fullname
= (char *) alloca (strlen (s_fullname
) + 1);
1383 strcpy (local_fullname
, s_fullname
);
1385 uiout
->field_string ("fullname", local_fullname
);
1394 last_source_error
= 0;
1396 if (s
->line_charpos
== 0)
1397 find_source_lines (s
, desc
);
1399 if (line
< 1 || line
> s
->nlines
)
1402 error (_("Line number %d out of range; %s has %d lines."),
1403 line
, symtab_to_filename_for_display (s
), s
->nlines
);
1406 if (lseek (desc
, s
->line_charpos
[line
- 1], 0) < 0)
1409 perror_with_name (symtab_to_filename_for_display (s
));
1412 gdb_file_up
stream (fdopen (desc
, FDOPEN_MODE
));
1413 clearerr (stream
.get ());
1415 while (nlines
-- > 0)
1419 c
= fgetc (stream
.get ());
1422 last_line_listed
= current_source_line
;
1423 if (flags
& PRINT_SOURCE_LINES_FILENAME
)
1425 uiout
->text (symtab_to_filename_for_display (s
));
1428 xsnprintf (buf
, sizeof (buf
), "%d\t", current_source_line
++);
1432 if (c
< 040 && c
!= '\t' && c
!= '\n' && c
!= '\r')
1434 xsnprintf (buf
, sizeof (buf
), "^%c", c
+ 0100);
1441 /* Skip a \r character, but only before a \n. */
1442 int c1
= fgetc (stream
.get ());
1445 printf_filtered ("^%c", c
+ 0100);
1447 ungetc (c1
, stream
.get ());
1451 xsnprintf (buf
, sizeof (buf
), "%c", c
);
1455 while (c
!= '\n' && (c
= fgetc (stream
.get ())) >= 0);
1459 /* Show source lines from the file of symtab S, starting with line
1460 number LINE and stopping before line number STOPLINE. If this is
1461 not the command line version, then the source is shown in the source
1462 window otherwise it is simply printed. */
1465 print_source_lines (struct symtab
*s
, int line
, int stopline
,
1466 print_source_lines_flags flags
)
1468 print_source_lines_base (s
, line
, stopline
, flags
);
1471 /* Print info on range of pc's in a specified line. */
1474 info_line_command (const char *arg
, int from_tty
)
1476 CORE_ADDR start_pc
, end_pc
;
1478 std::vector
<symtab_and_line
> decoded_sals
;
1479 symtab_and_line curr_sal
;
1480 gdb::array_view
<symtab_and_line
> sals
;
1484 curr_sal
.symtab
= current_source_symtab
;
1485 curr_sal
.pspace
= current_program_space
;
1486 if (last_line_listed
!= 0)
1487 curr_sal
.line
= last_line_listed
;
1489 curr_sal
.line
= current_source_line
;
1495 decoded_sals
= decode_line_with_last_displayed (arg
,
1496 DECODE_LINE_LIST_MODE
);
1497 sals
= decoded_sals
;
1502 /* C++ More than one line may have been specified, as when the user
1503 specifies an overloaded function name. Print info on them all. */
1504 for (const auto &sal
: sals
)
1506 if (sal
.pspace
!= current_program_space
)
1509 if (sal
.symtab
== 0)
1511 struct gdbarch
*gdbarch
= get_current_arch ();
1513 printf_filtered (_("No line number information available"));
1516 /* This is useful for "info line *0x7f34". If we can't tell the
1517 user about a source line, at least let them have the symbolic
1519 printf_filtered (" for address ");
1521 print_address (gdbarch
, sal
.pc
, gdb_stdout
);
1524 printf_filtered (".");
1525 printf_filtered ("\n");
1527 else if (sal
.line
> 0
1528 && find_line_pc_range (sal
, &start_pc
, &end_pc
))
1530 struct gdbarch
*gdbarch
1531 = get_objfile_arch (SYMTAB_OBJFILE (sal
.symtab
));
1533 if (start_pc
== end_pc
)
1535 printf_filtered ("Line %d of \"%s\"",
1537 symtab_to_filename_for_display (sal
.symtab
));
1539 printf_filtered (" is at address ");
1540 print_address (gdbarch
, start_pc
, gdb_stdout
);
1542 printf_filtered (" but contains no code.\n");
1546 printf_filtered ("Line %d of \"%s\"",
1548 symtab_to_filename_for_display (sal
.symtab
));
1550 printf_filtered (" starts at address ");
1551 print_address (gdbarch
, start_pc
, gdb_stdout
);
1553 printf_filtered (" and ends at ");
1554 print_address (gdbarch
, end_pc
, gdb_stdout
);
1555 printf_filtered (".\n");
1558 /* x/i should display this line's code. */
1559 set_next_address (gdbarch
, start_pc
);
1561 /* Repeating "info line" should do the following line. */
1562 last_line_listed
= sal
.line
+ 1;
1564 /* If this is the only line, show the source code. If it could
1565 not find the file, don't do anything special. */
1566 if (annotation_level
&& sals
.size () == 1)
1567 identify_source_line (sal
.symtab
, sal
.line
, 0, start_pc
);
1570 /* Is there any case in which we get here, and have an address
1571 which the user would want to see? If we have debugging symbols
1572 and no line numbers? */
1573 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1574 sal
.line
, symtab_to_filename_for_display (sal
.symtab
));
1578 /* Commands to search the source file for a regexp. */
1581 forward_search_command (const char *regex
, int from_tty
)
1587 struct cleanup
*cleanups
;
1589 line
= last_line_listed
+ 1;
1591 msg
= (char *) re_comp (regex
);
1593 error (("%s"), msg
);
1595 if (current_source_symtab
== 0)
1596 select_source_symtab (0);
1598 desc
= open_source_file (current_source_symtab
);
1600 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1601 cleanups
= make_cleanup_close (desc
);
1603 if (current_source_symtab
->line_charpos
== 0)
1604 find_source_lines (current_source_symtab
, desc
);
1606 if (line
< 1 || line
> current_source_symtab
->nlines
)
1607 error (_("Expression not found"));
1609 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1610 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1612 discard_cleanups (cleanups
);
1613 gdb_file_up
stream (fdopen (desc
, FDOPEN_MODE
));
1614 clearerr (stream
.get ());
1617 static char *buf
= NULL
;
1619 int cursize
, newsize
;
1622 buf
= (char *) xmalloc (cursize
);
1625 c
= fgetc (stream
.get ());
1631 if (p
- buf
== cursize
)
1633 newsize
= cursize
+ cursize
/ 2;
1634 buf
= (char *) xrealloc (buf
, newsize
);
1639 while (c
!= '\n' && (c
= fgetc (stream
.get ())) >= 0);
1641 /* Remove the \r, if any, at the end of the line, otherwise
1642 regular expressions that end with $ or \n won't work. */
1643 if (p
- buf
> 1 && p
[-2] == '\r')
1649 /* We now have a source line in buf, null terminate and match. */
1651 if (re_exec (buf
) > 0)
1654 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1655 set_internalvar_integer (lookup_internalvar ("_"), line
);
1656 current_source_line
= std::max (line
- lines_to_list
/ 2, 1);
1662 printf_filtered (_("Expression not found\n"));
1666 reverse_search_command (const char *regex
, int from_tty
)
1672 struct cleanup
*cleanups
;
1674 line
= last_line_listed
- 1;
1676 msg
= (char *) re_comp (regex
);
1678 error (("%s"), msg
);
1680 if (current_source_symtab
== 0)
1681 select_source_symtab (0);
1683 desc
= open_source_file (current_source_symtab
);
1685 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1686 cleanups
= make_cleanup_close (desc
);
1688 if (current_source_symtab
->line_charpos
== 0)
1689 find_source_lines (current_source_symtab
, desc
);
1691 if (line
< 1 || line
> current_source_symtab
->nlines
)
1692 error (_("Expression not found"));
1694 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1695 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1697 discard_cleanups (cleanups
);
1698 gdb_file_up
stream (fdopen (desc
, FDOPEN_MODE
));
1699 clearerr (stream
.get ());
1702 /* FIXME!!! We walk right off the end of buf if we get a long line!!! */
1703 char buf
[4096]; /* Should be reasonable??? */
1706 c
= fgetc (stream
.get ());
1713 while (c
!= '\n' && (c
= fgetc (stream
.get ())) >= 0);
1715 /* Remove the \r, if any, at the end of the line, otherwise
1716 regular expressions that end with $ or \n won't work. */
1717 if (p
- buf
> 1 && p
[-2] == '\r')
1723 /* We now have a source line in buf; null terminate and match. */
1725 if (re_exec (buf
) > 0)
1728 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1729 set_internalvar_integer (lookup_internalvar ("_"), line
);
1730 current_source_line
= std::max (line
- lines_to_list
/ 2, 1);
1734 if (fseek (stream
.get (),
1735 current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1737 const char *filename
;
1739 filename
= symtab_to_filename_for_display (current_source_symtab
);
1740 perror_with_name (filename
);
1744 printf_filtered (_("Expression not found\n"));
1748 /* If the last character of PATH is a directory separator, then strip it. */
1751 strip_trailing_directory_separator (char *path
)
1753 const int last
= strlen (path
) - 1;
1756 return; /* No stripping is needed if PATH is the empty string. */
1758 if (IS_DIR_SEPARATOR (path
[last
]))
1762 /* Return the path substitution rule that matches FROM.
1763 Return NULL if no rule matches. */
1765 static struct substitute_path_rule
*
1766 find_substitute_path_rule (const char *from
)
1768 struct substitute_path_rule
*rule
= substitute_path_rules
;
1770 while (rule
!= NULL
)
1772 if (FILENAME_CMP (rule
->from
, from
) == 0)
1780 /* Add a new substitute-path rule at the end of the current list of rules.
1781 The new rule will replace FROM into TO. */
1784 add_substitute_path_rule (char *from
, char *to
)
1786 struct substitute_path_rule
*rule
;
1787 struct substitute_path_rule
*new_rule
= XNEW (struct substitute_path_rule
);
1789 new_rule
->from
= xstrdup (from
);
1790 new_rule
->to
= xstrdup (to
);
1791 new_rule
->next
= NULL
;
1793 /* If the list of rules are empty, then insert the new rule
1794 at the head of the list. */
1796 if (substitute_path_rules
== NULL
)
1798 substitute_path_rules
= new_rule
;
1802 /* Otherwise, skip to the last rule in our list and then append
1805 rule
= substitute_path_rules
;
1806 while (rule
->next
!= NULL
)
1809 rule
->next
= new_rule
;
1812 /* Remove the given source path substitution rule from the current list
1813 of rules. The memory allocated for that rule is also deallocated. */
1816 delete_substitute_path_rule (struct substitute_path_rule
*rule
)
1818 if (rule
== substitute_path_rules
)
1819 substitute_path_rules
= rule
->next
;
1822 struct substitute_path_rule
*prev
= substitute_path_rules
;
1824 while (prev
!= NULL
&& prev
->next
!= rule
)
1827 gdb_assert (prev
!= NULL
);
1829 prev
->next
= rule
->next
;
1837 /* Implement the "show substitute-path" command. */
1840 show_substitute_path_command (const char *args
, int from_tty
)
1842 struct substitute_path_rule
*rule
= substitute_path_rules
;
1845 gdb_argv
argv (args
);
1847 /* We expect zero or one argument. */
1849 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1850 error (_("Too many arguments in command"));
1852 if (argv
!= NULL
&& argv
[0] != NULL
)
1855 /* Print the substitution rules. */
1859 (_("Source path substitution rule matching `%s':\n"), from
);
1861 printf_filtered (_("List of all source path substitution rules:\n"));
1863 while (rule
!= NULL
)
1865 if (from
== NULL
|| substitute_path_rule_matches (rule
, from
) != 0)
1866 printf_filtered (" `%s' -> `%s'.\n", rule
->from
, rule
->to
);
1871 /* Implement the "unset substitute-path" command. */
1874 unset_substitute_path_command (const char *args
, int from_tty
)
1876 struct substitute_path_rule
*rule
= substitute_path_rules
;
1877 gdb_argv
argv (args
);
1881 /* This function takes either 0 or 1 argument. */
1883 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1884 error (_("Incorrect usage, too many arguments in command"));
1886 if (argv
!= NULL
&& argv
[0] != NULL
)
1889 /* If the user asked for all the rules to be deleted, ask him
1890 to confirm and give him a chance to abort before the action
1894 && !query (_("Delete all source path substitution rules? ")))
1895 error (_("Canceled"));
1897 /* Delete the rule matching the argument. No argument means that
1898 all rules should be deleted. */
1900 while (rule
!= NULL
)
1902 struct substitute_path_rule
*next
= rule
->next
;
1904 if (from
== NULL
|| FILENAME_CMP (from
, rule
->from
) == 0)
1906 delete_substitute_path_rule (rule
);
1913 /* If the user asked for a specific rule to be deleted but
1914 we could not find it, then report an error. */
1916 if (from
!= NULL
&& !rule_found
)
1917 error (_("No substitution rule defined for `%s'"), from
);
1919 forget_cached_source_info ();
1922 /* Add a new source path substitution rule. */
1925 set_substitute_path_command (const char *args
, int from_tty
)
1927 struct substitute_path_rule
*rule
;
1929 gdb_argv
argv (args
);
1931 if (argv
== NULL
|| argv
[0] == NULL
|| argv
[1] == NULL
)
1932 error (_("Incorrect usage, too few arguments in command"));
1934 if (argv
[2] != NULL
)
1935 error (_("Incorrect usage, too many arguments in command"));
1937 if (*(argv
[0]) == '\0')
1938 error (_("First argument must be at least one character long"));
1940 /* Strip any trailing directory separator character in either FROM
1941 or TO. The substitution rule already implicitly contains them. */
1942 strip_trailing_directory_separator (argv
[0]);
1943 strip_trailing_directory_separator (argv
[1]);
1945 /* If a rule with the same "from" was previously defined, then
1946 delete it. This new rule replaces it. */
1948 rule
= find_substitute_path_rule (argv
[0]);
1950 delete_substitute_path_rule (rule
);
1952 /* Insert the new substitution rule. */
1954 add_substitute_path_rule (argv
[0], argv
[1]);
1955 forget_cached_source_info ();
1960 _initialize_source (void)
1962 struct cmd_list_element
*c
;
1964 current_source_symtab
= 0;
1965 init_source_path ();
1967 /* The intention is to use POSIX Basic Regular Expressions.
1968 Always use the GNU regex routine for consistency across all hosts.
1969 Our current GNU regex.c does not have all the POSIX features, so this is
1970 just an approximation. */
1971 re_set_syntax (RE_SYNTAX_GREP
);
1973 c
= add_cmd ("directory", class_files
, directory_command
, _("\
1974 Add directory DIR to beginning of search path for source files.\n\
1975 Forget cached info on source file locations and line positions.\n\
1976 DIR can also be $cwd for the current working directory, or $cdir for the\n\
1977 directory in which the source file was compiled into object code.\n\
1978 With no argument, reset the search path to $cdir:$cwd, the default."),
1982 add_com_alias ("use", "directory", class_files
, 0);
1984 set_cmd_completer (c
, filename_completer
);
1986 add_setshow_optional_filename_cmd ("directories",
1990 Set the search path for finding source files."),
1992 Show the search path for finding source files."),
1994 $cwd in the path means the current working directory.\n\
1995 $cdir in the path means the compilation directory of the source file.\n\
1996 GDB ensures the search path always ends with $cdir:$cwd by\n\
1997 appending these directories if necessary.\n\
1998 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
1999 set_directories_command
,
2000 show_directories_command
,
2001 &setlist
, &showlist
);
2003 add_info ("source", info_source_command
,
2004 _("Information about the current source file."));
2006 add_info ("line", info_line_command
, _("\
2007 Core addresses of the code for a source line.\n\
2008 Line can be specified as\n\
2009 LINENUM, to list around that line in current file,\n\
2010 FILE:LINENUM, to list around that line in that file,\n\
2011 FUNCTION, to list around beginning of that function,\n\
2012 FILE:FUNCTION, to distinguish among like-named static functions.\n\
2013 Default is to describe the last source line that was listed.\n\n\
2014 This sets the default address for \"x\" to the line's first instruction\n\
2015 so that \"x/i\" suffices to start examining the machine code.\n\
2016 The address is also stored as the value of \"$_\"."));
2018 add_com ("forward-search", class_files
, forward_search_command
, _("\
2019 Search for regular expression (see regex(3)) from last line listed.\n\
2020 The matching line number is also stored as the value of \"$_\"."));
2021 add_com_alias ("search", "forward-search", class_files
, 0);
2022 add_com_alias ("fo", "forward-search", class_files
, 1);
2024 add_com ("reverse-search", class_files
, reverse_search_command
, _("\
2025 Search backward for regular expression (see regex(3)) from last line listed.\n\
2026 The matching line number is also stored as the value of \"$_\"."));
2027 add_com_alias ("rev", "reverse-search", class_files
, 1);
2029 add_setshow_integer_cmd ("listsize", class_support
, &lines_to_list
, _("\
2030 Set number of source lines gdb will list by default."), _("\
2031 Show number of source lines gdb will list by default."), _("\
2032 Use this to choose how many source lines the \"list\" displays (unless\n\
2033 the \"list\" argument explicitly specifies some other number).\n\
2034 A value of \"unlimited\", or zero, means there's no limit."),
2037 &setlist
, &showlist
);
2039 add_cmd ("substitute-path", class_files
, set_substitute_path_command
,
2041 Usage: set substitute-path FROM TO\n\
2042 Add a substitution rule replacing FROM into TO in source file names.\n\
2043 If a substitution rule was previously set for FROM, the old rule\n\
2044 is replaced by the new one."),
2047 add_cmd ("substitute-path", class_files
, unset_substitute_path_command
,
2049 Usage: unset substitute-path [FROM]\n\
2050 Delete the rule for substituting FROM in source file names. If FROM\n\
2051 is not specified, all substituting rules are deleted.\n\
2052 If the debugger cannot find a rule for FROM, it will display a warning."),
2055 add_cmd ("substitute-path", class_files
, show_substitute_path_command
,
2057 Usage: show substitute-path [FROM]\n\
2058 Print the rule for substituting FROM in source file names. If FROM\n\
2059 is not specified, print all substitution rules."),
2062 add_setshow_enum_cmd ("filename-display", class_files
,
2063 filename_display_kind_names
,
2064 &filename_display_string
, _("\
2065 Set how to display filenames."), _("\
2066 Show how to display filenames."), _("\
2067 filename-display can be:\n\
2068 basename - display only basename of a filename\n\
2069 relative - display a filename relative to the compilation directory\n\
2070 absolute - display an absolute filename\n\
2071 By default, relative filenames are displayed."),
2073 show_filename_display_string
,
2074 &setlist
, &showlist
);