1 /* List lines of source files for GDB, the GNU debugger.
2 Copyright (C) 1986-2020 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 "gdbsupport/filestuff.h"
31 #include <sys/types.h>
34 #include "gdb_regex.h"
40 #include "filenames.h" /* for DOSish file names */
41 #include "completer.h"
43 #include "readline/tilde.h"
44 #include "gdbsupport/enum-flags.h"
45 #include "gdbsupport/scoped_fd.h"
47 #include "gdbsupport/pathstuff.h"
48 #include "source-cache.h"
49 #include "cli/cli-style.h"
50 #include "observable.h"
52 #include "debuginfod-support.h"
54 #define OPEN_MODE (O_RDONLY | O_BINARY)
55 #define FDOPEN_MODE FOPEN_RB
57 /* Path of directories to search for source files.
58 Same format as the PATH environment variable's value. */
62 /* Support for source path substitution commands. */
64 struct substitute_path_rule
68 struct substitute_path_rule
*next
;
71 static struct substitute_path_rule
*substitute_path_rules
= NULL
;
73 /* An instance of this is attached to each program space. */
75 struct current_source_location
79 current_source_location () = default;
82 void set (struct symtab
*s
, int l
)
86 gdb::observers::current_source_symtab_and_line_changed
.notify ();
90 struct symtab
*symtab () const
95 /* Get the line number. */
103 /* Symtab of default file for listing lines of. */
105 struct symtab
*m_symtab
= nullptr;
107 /* Default next line to list. */
112 static program_space_key
<current_source_location
> current_source_key
;
114 /* Default number of lines to print with commands like "list".
115 This is based on guessing how many long (i.e. more than chars_per_line
116 characters) lines there will be. To be completely correct, "list"
117 and friends should be rewritten to count characters and see where
118 things are wrapping, but that would be a fair amount of work. */
120 static int lines_to_list
= 10;
122 show_lines_to_list (struct ui_file
*file
, int from_tty
,
123 struct cmd_list_element
*c
, const char *value
)
125 fprintf_filtered (file
,
126 _("Number of source lines gdb "
127 "will list by default is %s.\n"),
131 /* Possible values of 'set filename-display'. */
132 static const char filename_display_basename
[] = "basename";
133 static const char filename_display_relative
[] = "relative";
134 static const char filename_display_absolute
[] = "absolute";
136 static const char *const filename_display_kind_names
[] = {
137 filename_display_basename
,
138 filename_display_relative
,
139 filename_display_absolute
,
143 static const char *filename_display_string
= filename_display_relative
;
146 show_filename_display_string (struct ui_file
*file
, int from_tty
,
147 struct cmd_list_element
*c
, const char *value
)
149 fprintf_filtered (file
, _("Filenames are displayed as \"%s\".\n"), value
);
152 /* Line number of last line printed. Default for various commands.
153 current_source_line is usually, but not always, the same as this. */
155 static int last_line_listed
;
157 /* First line number listed by last listing command. If 0, then no
158 source lines have yet been listed since the last time the current
159 source line was changed. */
161 static int first_line_listed
;
163 /* Saves the name of the last source file visited and a possible error code.
164 Used to prevent repeating annoying "No such file or directories" msgs. */
166 static struct symtab
*last_source_visited
= NULL
;
167 static bool last_source_error
= false;
169 /* Return the first line listed by print_source_lines.
170 Used by command interpreters to request listing from
174 get_first_line_listed (void)
176 return first_line_listed
;
179 /* Clear line listed range. This makes the next "list" center the
180 printed source lines around the current source line. */
183 clear_lines_listed_range (void)
185 first_line_listed
= 0;
186 last_line_listed
= 0;
189 /* Return the default number of lines to print with commands like the
190 cli "list". The caller of print_source_lines must use this to
191 calculate the end line and use it in the call to print_source_lines
192 as it does not automatically use this value. */
195 get_lines_to_list (void)
197 return lines_to_list
;
200 /* A helper to return the current source location object for PSPACE,
201 creating it if it does not exist. */
203 static current_source_location
*
204 get_source_location (program_space
*pspace
)
206 current_source_location
*loc
207 = current_source_key
.get (pspace
);
209 loc
= current_source_key
.emplace (pspace
);
213 /* Return the current source file for listing and next line to list.
214 NOTE: The returned sal pc and end fields are not valid. */
216 struct symtab_and_line
217 get_current_source_symtab_and_line (void)
219 symtab_and_line cursal
;
220 current_source_location
*loc
= get_source_location (current_program_space
);
222 cursal
.pspace
= current_program_space
;
223 cursal
.symtab
= loc
->symtab ();
224 cursal
.line
= loc
->line ();
231 /* If the current source file for listing is not set, try and get a default.
232 Usually called before get_current_source_symtab_and_line() is called.
233 It may err out if a default cannot be determined.
234 We must be cautious about where it is called, as it can recurse as the
235 process of determining a new default may call the caller!
236 Use get_current_source_symtab_and_line only to get whatever
237 we have without erroring out or trying to get a default. */
240 set_default_source_symtab_and_line (void)
242 if (!have_full_symbols () && !have_partial_symbols ())
243 error (_("No symbol table is loaded. Use the \"file\" command."));
245 /* Pull in a current source symtab if necessary. */
246 current_source_location
*loc
= get_source_location (current_program_space
);
247 if (loc
->symtab () == nullptr)
248 select_source_symtab (0);
251 /* Return the current default file for listing and next line to list
252 (the returned sal pc and end fields are not valid.)
253 and set the current default to whatever is in SAL.
254 NOTE: The returned sal pc and end fields are not valid. */
256 struct symtab_and_line
257 set_current_source_symtab_and_line (const symtab_and_line
&sal
)
259 symtab_and_line cursal
;
261 current_source_location
*loc
= get_source_location (sal
.pspace
);
263 cursal
.pspace
= sal
.pspace
;
264 cursal
.symtab
= loc
->symtab ();
265 cursal
.line
= loc
->line ();
269 loc
->set (sal
.symtab
, sal
.line
);
271 /* Force the next "list" to center around the current line. */
272 clear_lines_listed_range ();
277 /* Reset any information stored about a default file and line to print. */
280 clear_current_source_symtab_and_line (void)
282 current_source_location
*loc
= get_source_location (current_program_space
);
283 loc
->set (nullptr, 0);
289 select_source_symtab (struct symtab
*s
)
293 current_source_location
*loc
294 = get_source_location (SYMTAB_PSPACE (s
));
299 current_source_location
*loc
= get_source_location (current_program_space
);
300 if (loc
->symtab () != nullptr)
303 /* Make the default place to list be the function `main'
305 block_symbol bsym
= lookup_symbol (main_name (), 0, VAR_DOMAIN
, 0);
306 if (bsym
.symbol
!= nullptr && SYMBOL_CLASS (bsym
.symbol
) == LOC_BLOCK
)
308 symtab_and_line sal
= find_function_start_sal (bsym
.symbol
, true);
309 loc
->set (sal
.symtab
, std::max (sal
.line
- (lines_to_list
- 1), 1));
313 /* Alright; find the last file in the symtab list (ignoring .h's
314 and namespace symtabs). */
316 struct symtab
*new_symtab
= nullptr;
318 for (objfile
*ofp
: current_program_space
->objfiles ())
320 for (compunit_symtab
*cu
: ofp
->compunits ())
322 for (symtab
*symtab
: compunit_filetabs (cu
))
324 const char *name
= symtab
->filename
;
325 int len
= strlen (name
);
327 if (!(len
> 2 && (strcmp (&name
[len
- 2], ".h") == 0
328 || strcmp (name
, "<<C++-namespaces>>") == 0)))
334 loc
->set (new_symtab
, 1);
335 if (new_symtab
!= nullptr)
338 for (objfile
*objfile
: current_program_space
->objfiles ())
341 s
= objfile
->sf
->qf
->find_last_source_symtab (objfile
);
345 if (new_symtab
!= nullptr)
347 loc
->set (new_symtab
,1);
351 error (_("Can't find a default source file"));
354 /* Handler for "set directories path-list" command.
355 "set dir mumble" doesn't prepend paths, it resets the entire
356 path list. The theory is that set(show(dir)) should be a no-op. */
359 set_directories_command (const char *args
,
360 int from_tty
, struct cmd_list_element
*c
)
362 /* This is the value that was set.
363 It needs to be processed to maintain $cdir:$cwd and remove dups. */
364 char *set_path
= source_path
;
366 /* We preserve the invariant that $cdir:$cwd begins life at the end of
367 the list by calling init_source_path. If they appear earlier in
368 SET_PATH then mod_path will move them appropriately.
369 mod_path will also remove duplicates. */
371 if (*set_path
!= '\0')
372 mod_path (set_path
, &source_path
);
377 /* Print the list of source directories.
378 This is used by the "ld" command, so it has the signature of a command
382 show_directories_1 (char *ignore
, int from_tty
)
384 puts_filtered ("Source directories searched: ");
385 puts_filtered (source_path
);
386 puts_filtered ("\n");
389 /* Handler for "show directories" command. */
392 show_directories_command (struct ui_file
*file
, int from_tty
,
393 struct cmd_list_element
*c
, const char *value
)
395 show_directories_1 (NULL
, from_tty
);
401 forget_cached_source_info_for_objfile (struct objfile
*objfile
)
403 for (compunit_symtab
*cu
: objfile
->compunits ())
405 for (symtab
*s
: compunit_filetabs (cu
))
407 if (s
->fullname
!= NULL
)
416 objfile
->sf
->qf
->forget_cached_source_info (objfile
);
422 forget_cached_source_info (void)
424 struct program_space
*pspace
;
427 for (objfile
*objfile
: pspace
->objfiles ())
429 forget_cached_source_info_for_objfile (objfile
);
432 g_source_cache
.clear ();
433 last_source_visited
= NULL
;
437 init_source_path (void)
441 xsnprintf (buf
, sizeof (buf
), "$cdir%c$cwd", DIRNAME_SEPARATOR
);
442 source_path
= xstrdup (buf
);
443 forget_cached_source_info ();
446 /* Add zero or more directories to the front of the source path. */
449 directory_command (const char *dirname
, int from_tty
)
452 /* FIXME, this goes to "delete dir"... */
455 if (!from_tty
|| query (_("Reinitialize source path to empty? ")))
463 mod_path (dirname
, &source_path
);
464 forget_cached_source_info ();
467 show_directories_1 ((char *) 0, from_tty
);
470 /* Add a path given with the -d command line switch.
471 This will not be quoted so we must not treat spaces as separators. */
474 directory_switch (const char *dirname
, int from_tty
)
476 add_path (dirname
, &source_path
, 0);
479 /* Add zero or more directories to the front of an arbitrary path. */
482 mod_path (const char *dirname
, char **which_path
)
484 add_path (dirname
, which_path
, 1);
487 /* Workhorse of mod_path. Takes an extra argument to determine
488 if dirname should be parsed for separators that indicate multiple
489 directories. This allows for interfaces that pre-parse the dirname
490 and allow specification of traditional separator characters such
494 add_path (const char *dirname
, char **which_path
, int parse_separators
)
496 char *old
= *which_path
;
498 std::vector
<gdb::unique_xmalloc_ptr
<char>> dir_vec
;
503 if (parse_separators
)
505 /* This will properly parse the space and tab separators
506 and any quotes that may exist. */
507 gdb_argv
argv (dirname
);
509 for (char *arg
: argv
)
510 dirnames_to_char_ptr_vec_append (&dir_vec
, arg
);
513 dir_vec
.emplace_back (xstrdup (dirname
));
515 for (const gdb::unique_xmalloc_ptr
<char> &name_up
: dir_vec
)
517 char *name
= name_up
.get ();
520 gdb::unique_xmalloc_ptr
<char> new_name_holder
;
522 /* Spaces and tabs will have been removed by buildargv().
523 NAME is the start of the directory.
524 P is the '\0' following the end. */
525 p
= name
+ strlen (name
);
527 while (!(IS_DIR_SEPARATOR (*name
) && p
<= name
+ 1) /* "/" */
528 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
529 /* On MS-DOS and MS-Windows, h:\ is different from h: */
530 && !(p
== name
+ 3 && name
[1] == ':') /* "d:/" */
532 && IS_DIR_SEPARATOR (p
[-1]))
533 /* Sigh. "foo/" => "foo" */
537 while (p
> name
&& p
[-1] == '.')
541 /* "." => getwd (). */
542 name
= current_directory
;
545 else if (p
> name
+ 1 && IS_DIR_SEPARATOR (p
[-2]))
555 /* "...foo/." => "...foo". */
566 new_name_holder
.reset (tilde_expand (name
));
567 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
568 else if (IS_ABSOLUTE_PATH (name
) && p
== name
+ 2) /* "d:" => "d:." */
569 new_name_holder
.reset (concat (name
, ".", (char *) NULL
));
571 else if (!IS_ABSOLUTE_PATH (name
) && name
[0] != '$')
572 new_name_holder
= gdb_abspath (name
);
574 new_name_holder
.reset (savestring (name
, p
- name
));
575 name
= new_name_holder
.get ();
577 /* Unless it's a variable, check existence. */
580 /* These are warnings, not errors, since we don't want a
581 non-existent directory in a .gdbinit file to stop processing
582 of the .gdbinit file.
584 Whether they get added to the path is more debatable. Current
585 answer is yes, in case the user wants to go make the directory
586 or whatever. If the directory continues to not exist/not be
587 a directory/etc, then having them in the path should be
589 if (stat (name
, &st
) < 0)
591 int save_errno
= errno
;
593 fprintf_unfiltered (gdb_stderr
, "Warning: ");
594 print_sys_errmsg (name
, save_errno
);
596 else if ((st
.st_mode
& S_IFMT
) != S_IFDIR
)
597 warning (_("%s is not a directory."), name
);
602 unsigned int len
= strlen (name
);
608 /* FIXME: we should use realpath() or its work-alike
609 before comparing. Then all the code above which
610 removes excess slashes and dots could simply go away. */
611 if (!filename_ncmp (p
, name
, len
)
612 && (p
[len
] == '\0' || p
[len
] == DIRNAME_SEPARATOR
))
614 /* Found it in the search path, remove old copy. */
617 /* Back over leading separator. */
620 if (prefix
> p
- *which_path
)
622 /* Same dir twice in one cmd. */
625 /* Copy from next '\0' or ':'. */
626 memmove (p
, &p
[len
+ 1], strlen (&p
[len
+ 1]) + 1);
628 p
= strchr (p
, DIRNAME_SEPARATOR
);
635 tinybuf
[0] = DIRNAME_SEPARATOR
;
638 /* If we have already tacked on a name(s) in this command,
639 be sure they stay on the front as we tack on some
647 temp
= concat (old
, tinybuf
, name
, (char *)NULL
);
649 *which_path
= concat (temp
, "", &old
[prefix
], (char *) NULL
);
650 prefix
= strlen (temp
);
655 *which_path
= concat (name
, (old
[0] ? tinybuf
: old
),
657 prefix
= strlen (name
);
669 info_source_command (const char *ignore
, int from_tty
)
671 current_source_location
*loc
672 = get_source_location (current_program_space
);
673 struct symtab
*s
= loc
->symtab ();
674 struct compunit_symtab
*cust
;
678 printf_filtered (_("No current source file.\n"));
682 cust
= SYMTAB_COMPUNIT (s
);
683 printf_filtered (_("Current source file is %s\n"), s
->filename
);
684 if (SYMTAB_DIRNAME (s
) != NULL
)
685 printf_filtered (_("Compilation directory is %s\n"), SYMTAB_DIRNAME (s
));
687 printf_filtered (_("Located in %s\n"), s
->fullname
);
688 const std::vector
<off_t
> *offsets
;
689 if (g_source_cache
.get_line_charpos (s
, &offsets
))
690 printf_filtered (_("Contains %d line%s.\n"), (int) offsets
->size (),
691 offsets
->size () == 1 ? "" : "s");
693 printf_filtered (_("Source language is %s.\n"), language_str (s
->language
));
694 printf_filtered (_("Producer is %s.\n"),
695 COMPUNIT_PRODUCER (cust
) != NULL
696 ? COMPUNIT_PRODUCER (cust
) : _("unknown"));
697 printf_filtered (_("Compiled with %s debugging format.\n"),
698 COMPUNIT_DEBUGFORMAT (cust
));
699 printf_filtered (_("%s preprocessor macro info.\n"),
700 COMPUNIT_MACRO_TABLE (cust
) != NULL
701 ? "Includes" : "Does not include");
705 /* Helper function to remove characters from the start of PATH so that
706 PATH can then be appended to a directory name. We remove leading drive
707 letters (for dos) as well as leading '/' characters and './'
711 prepare_path_for_appending (const char *path
)
713 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
714 if (HAS_DRIVE_SPEC (path
))
715 path
= STRIP_DRIVE_SPEC (path
);
717 const char *old_path
;
722 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
723 while (IS_DIR_SEPARATOR(path
[0]))
727 while (path
[0] == '.' && IS_DIR_SEPARATOR (path
[1]))
730 while (old_path
!= path
);
735 /* Open a file named STRING, searching path PATH (dir names sep by some char)
736 using mode MODE in the calls to open. You cannot use this function to
737 create files (O_CREAT).
739 OPTS specifies the function behaviour in specific cases.
741 If OPF_TRY_CWD_FIRST, try to open ./STRING before searching PATH.
742 (ie pretend the first element of PATH is "."). This also indicates
743 that, unless OPF_SEARCH_IN_PATH is also specified, a slash in STRING
744 disables searching of the path (this is so that "exec-file ./foo" or
745 "symbol-file ./foo" insures that you get that particular version of
746 foo or an error message).
748 If OPTS has OPF_SEARCH_IN_PATH set, absolute names will also be
749 searched in path (we usually want this for source files but not for
752 If FILENAME_OPENED is non-null, set it to a newly allocated string naming
753 the actual file opened (this string will always start with a "/"). We
754 have to take special pains to avoid doubling the "/" between the directory
755 and the file, sigh! Emacs gets confuzzed by this when we print the
758 If OPTS has OPF_RETURN_REALPATH set return FILENAME_OPENED resolved by
759 gdb_realpath. Even without OPF_RETURN_REALPATH this function still returns
760 filename starting with "/". If FILENAME_OPENED is NULL this option has no
763 If a file is found, return the descriptor.
764 Otherwise, return -1, with errno set for the last name we tried to open. */
766 /* >>>> This should only allow files of certain types,
767 >>>> eg executable, non-directory. */
769 openp (const char *path
, openp_flags opts
, const char *string
,
770 int mode
, gdb::unique_xmalloc_ptr
<char> *filename_opened
)
775 /* The errno set for the last name we tried to open (and
778 std::vector
<gdb::unique_xmalloc_ptr
<char>> dir_vec
;
780 /* The open syscall MODE parameter is not specified. */
781 gdb_assert ((mode
& O_CREAT
) == 0);
782 gdb_assert (string
!= NULL
);
784 /* A file with an empty name cannot possibly exist. Report a failure
785 without further checking.
787 This is an optimization which also defends us against buggy
788 implementations of the "stat" function. For instance, we have
789 noticed that a MinGW debugger built on Windows XP 32bits crashes
790 when the debugger is started with an empty argument. */
791 if (string
[0] == '\0')
802 if ((opts
& OPF_TRY_CWD_FIRST
) || IS_ABSOLUTE_PATH (string
))
804 int i
, reg_file_errno
;
806 if (is_regular_file (string
, ®_file_errno
))
808 filename
= (char *) alloca (strlen (string
) + 1);
809 strcpy (filename
, string
);
810 fd
= gdb_open_cloexec (filename
, mode
, 0);
819 last_errno
= reg_file_errno
;
822 if (!(opts
& OPF_SEARCH_IN_PATH
))
823 for (i
= 0; string
[i
]; i
++)
824 if (IS_DIR_SEPARATOR (string
[i
]))
828 /* Remove characters from the start of PATH that we don't need when PATH
829 is appended to a directory name. */
830 string
= prepare_path_for_appending (string
);
832 alloclen
= strlen (path
) + strlen (string
) + 2;
833 filename
= (char *) alloca (alloclen
);
837 dir_vec
= dirnames_to_char_ptr_vec (path
);
839 for (const gdb::unique_xmalloc_ptr
<char> &dir_up
: dir_vec
)
841 char *dir
= dir_up
.get ();
842 size_t len
= strlen (dir
);
845 if (strcmp (dir
, "$cwd") == 0)
847 /* Name is $cwd -- insert current directory name instead. */
850 /* First, realloc the filename buffer if too short. */
851 len
= strlen (current_directory
);
852 newlen
= len
+ strlen (string
) + 2;
853 if (newlen
> alloclen
)
856 filename
= (char *) alloca (alloclen
);
858 strcpy (filename
, current_directory
);
860 else if (strchr(dir
, '~'))
862 /* See whether we need to expand the tilde. */
865 gdb::unique_xmalloc_ptr
<char> tilde_expanded (tilde_expand (dir
));
867 /* First, realloc the filename buffer if too short. */
868 len
= strlen (tilde_expanded
.get ());
869 newlen
= len
+ strlen (string
) + 2;
870 if (newlen
> alloclen
)
873 filename
= (char *) alloca (alloclen
);
875 strcpy (filename
, tilde_expanded
.get ());
879 /* Normal file name in path -- just use it. */
880 strcpy (filename
, dir
);
882 /* Don't search $cdir. It's also a magic path like $cwd, but we
883 don't have enough information to expand it. The user *could*
884 have an actual directory named '$cdir' but handling that would
885 be confusing, it would mean different things in different
886 contexts. If the user really has '$cdir' one can use './$cdir'.
887 We can get $cdir when loading scripts. When loading source files
888 $cdir must have already been expanded to the correct value. */
889 if (strcmp (dir
, "$cdir") == 0)
893 /* Remove trailing slashes. */
894 while (len
> 0 && IS_DIR_SEPARATOR (filename
[len
- 1]))
897 strcat (filename
+ len
, SLASH_STRING
);
898 strcat (filename
, string
);
900 if (is_regular_file (filename
, ®_file_errno
))
902 fd
= gdb_open_cloexec (filename
, mode
, 0);
908 last_errno
= reg_file_errno
;
914 /* If a file was opened, canonicalize its filename. */
916 filename_opened
->reset (NULL
);
917 else if ((opts
& OPF_RETURN_REALPATH
) != 0)
918 *filename_opened
= gdb_realpath (filename
);
920 *filename_opened
= gdb_abspath (filename
);
928 /* This is essentially a convenience, for clients that want the behaviour
929 of openp, using source_path, but that really don't want the file to be
930 opened but want instead just to know what the full pathname is (as
931 qualified against source_path).
933 The current working directory is searched first.
935 If the file was found, this function returns 1, and FULL_PATHNAME is
936 set to the fully-qualified pathname.
938 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
940 source_full_path_of (const char *filename
,
941 gdb::unique_xmalloc_ptr
<char> *full_pathname
)
945 fd
= openp (source_path
,
946 OPF_TRY_CWD_FIRST
| OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
,
947 filename
, O_RDONLY
, full_pathname
);
950 full_pathname
->reset (NULL
);
958 /* Return non-zero if RULE matches PATH, that is if the rule can be
962 substitute_path_rule_matches (const struct substitute_path_rule
*rule
,
965 const int from_len
= strlen (rule
->from
);
966 const int path_len
= strlen (path
);
968 if (path_len
< from_len
)
971 /* The substitution rules are anchored at the start of the path,
972 so the path should start with rule->from. */
974 if (filename_ncmp (path
, rule
->from
, from_len
) != 0)
977 /* Make sure that the region in the path that matches the substitution
978 rule is immediately followed by a directory separator (or the end of
979 string character). */
981 if (path
[from_len
] != '\0' && !IS_DIR_SEPARATOR (path
[from_len
]))
987 /* Find the substitute-path rule that applies to PATH and return it.
988 Return NULL if no rule applies. */
990 static struct substitute_path_rule
*
991 get_substitute_path_rule (const char *path
)
993 struct substitute_path_rule
*rule
= substitute_path_rules
;
995 while (rule
!= NULL
&& !substitute_path_rule_matches (rule
, path
))
1001 /* If the user specified a source path substitution rule that applies
1002 to PATH, then apply it and return the new path.
1004 Return NULL if no substitution rule was specified by the user,
1005 or if no rule applied to the given PATH. */
1007 gdb::unique_xmalloc_ptr
<char>
1008 rewrite_source_path (const char *path
)
1010 const struct substitute_path_rule
*rule
= get_substitute_path_rule (path
);
1017 from_len
= strlen (rule
->from
);
1019 /* Compute the rewritten path and return it. */
1022 (char *) xmalloc (strlen (path
) + 1 + strlen (rule
->to
) - from_len
);
1023 strcpy (new_path
, rule
->to
);
1024 strcat (new_path
, path
+ from_len
);
1026 return gdb::unique_xmalloc_ptr
<char> (new_path
);
1032 find_and_open_source (const char *filename
,
1033 const char *dirname
,
1034 gdb::unique_xmalloc_ptr
<char> *fullname
)
1036 char *path
= source_path
;
1040 /* Quick way out if we already know its full name. */
1044 /* The user may have requested that source paths be rewritten
1045 according to substitution rules he provided. If a substitution
1046 rule applies to this path, then apply it. */
1047 gdb::unique_xmalloc_ptr
<char> rewritten_fullname
1048 = rewrite_source_path (fullname
->get ());
1050 if (rewritten_fullname
!= NULL
)
1051 *fullname
= std::move (rewritten_fullname
);
1053 result
= gdb_open_cloexec (fullname
->get (), OPEN_MODE
, 0);
1056 *fullname
= gdb_realpath (fullname
->get ());
1057 return scoped_fd (result
);
1060 /* Didn't work -- free old one, try again. */
1061 fullname
->reset (NULL
);
1064 gdb::unique_xmalloc_ptr
<char> rewritten_dirname
;
1065 if (dirname
!= NULL
)
1067 /* If necessary, rewrite the compilation directory name according
1068 to the source path substitution rules specified by the user. */
1070 rewritten_dirname
= rewrite_source_path (dirname
);
1072 if (rewritten_dirname
!= NULL
)
1073 dirname
= rewritten_dirname
.get ();
1075 /* Replace a path entry of $cdir with the compilation directory
1078 p
= strstr (source_path
, "$cdir");
1079 if (p
&& (p
== path
|| p
[-1] == DIRNAME_SEPARATOR
)
1080 && (p
[cdir_len
] == DIRNAME_SEPARATOR
|| p
[cdir_len
] == '\0'))
1085 alloca (strlen (source_path
) + 1 + strlen (dirname
) + 1);
1086 len
= p
- source_path
;
1087 strncpy (path
, source_path
, len
); /* Before $cdir */
1088 strcpy (path
+ len
, dirname
); /* new stuff */
1089 strcat (path
+ len
, source_path
+ len
+ cdir_len
); /* After
1094 gdb::unique_xmalloc_ptr
<char> rewritten_filename
1095 = rewrite_source_path (filename
);
1097 if (rewritten_filename
!= NULL
)
1098 filename
= rewritten_filename
.get ();
1100 /* Try to locate file using filename. */
1101 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, filename
,
1102 OPEN_MODE
, fullname
);
1103 if (result
< 0 && dirname
!= NULL
)
1105 /* Remove characters from the start of PATH that we don't need when
1106 PATH is appended to a directory name. */
1107 const char *filename_start
= prepare_path_for_appending (filename
);
1109 /* Try to locate file using compilation dir + filename. This is
1110 helpful if part of the compilation directory was removed,
1111 e.g. using gcc's -fdebug-prefix-map, and we have added the missing
1112 prefix to source_path. */
1113 std::string
cdir_filename (dirname
);
1115 /* Remove any trailing directory separators. */
1116 while (IS_DIR_SEPARATOR (cdir_filename
.back ()))
1117 cdir_filename
.pop_back ();
1119 /* Add our own directory separator. */
1120 cdir_filename
.append (SLASH_STRING
);
1121 cdir_filename
.append (filename_start
);
1123 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
,
1124 cdir_filename
.c_str (), OPEN_MODE
, fullname
);
1128 /* Didn't work. Try using just the basename. */
1129 p
= lbasename (filename
);
1131 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, p
,
1132 OPEN_MODE
, fullname
);
1135 return scoped_fd (result
);
1138 /* Open a source file given a symtab S. Returns a file descriptor or
1139 negative number for error.
1141 This function is a convenience function to find_and_open_source. */
1144 open_source_file (struct symtab
*s
)
1147 return scoped_fd (-1);
1149 gdb::unique_xmalloc_ptr
<char> fullname (s
->fullname
);
1151 scoped_fd fd
= find_and_open_source (s
->filename
, SYMTAB_DIRNAME (s
),
1156 if (SYMTAB_COMPUNIT (s
) != nullptr)
1158 const objfile
*ofp
= COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (s
));
1160 std::string srcpath
;
1161 if (IS_ABSOLUTE_PATH (s
->filename
))
1162 srcpath
= s
->filename
;
1163 else if (SYMTAB_DIRNAME (s
) != nullptr)
1165 srcpath
= SYMTAB_DIRNAME (s
);
1166 srcpath
+= SLASH_STRING
;
1167 srcpath
+= s
->filename
;
1170 const struct bfd_build_id
*build_id
= build_id_bfd_get (ofp
->obfd
);
1172 /* Query debuginfod for the source file. */
1173 if (build_id
!= nullptr && !srcpath
.empty ())
1174 fd
= debuginfod_source_query (build_id
->data
,
1181 s
->fullname
= fullname
.release ();
1185 /* Finds the fullname that a symtab represents.
1187 This functions finds the fullname and saves it in s->fullname.
1188 It will also return the value.
1190 If this function fails to find the file that this symtab represents,
1191 the expected fullname is used. Therefore the files does not have to
1195 symtab_to_fullname (struct symtab
*s
)
1197 /* Use cached copy if we have it.
1198 We rely on forget_cached_source_info being called appropriately
1199 to handle cases like the file being moved. */
1200 if (s
->fullname
== NULL
)
1202 scoped_fd fd
= open_source_file (s
);
1206 gdb::unique_xmalloc_ptr
<char> fullname
;
1208 /* rewrite_source_path would be applied by find_and_open_source, we
1209 should report the pathname where GDB tried to find the file. */
1211 if (SYMTAB_DIRNAME (s
) == NULL
|| IS_ABSOLUTE_PATH (s
->filename
))
1212 fullname
.reset (xstrdup (s
->filename
));
1214 fullname
.reset (concat (SYMTAB_DIRNAME (s
), SLASH_STRING
,
1215 s
->filename
, (char *) NULL
));
1217 s
->fullname
= rewrite_source_path (fullname
.get ()).release ();
1218 if (s
->fullname
== NULL
)
1219 s
->fullname
= fullname
.release ();
1226 /* See commentary in source.h. */
1229 symtab_to_filename_for_display (struct symtab
*symtab
)
1231 if (filename_display_string
== filename_display_basename
)
1232 return lbasename (symtab
->filename
);
1233 else if (filename_display_string
== filename_display_absolute
)
1234 return symtab_to_fullname (symtab
);
1235 else if (filename_display_string
== filename_display_relative
)
1236 return symtab
->filename
;
1238 internal_error (__FILE__
, __LINE__
, _("invalid filename_display_string"));
1243 /* Print source lines from the file of symtab S,
1244 starting with line number LINE and stopping before line number STOPLINE. */
1247 print_source_lines_base (struct symtab
*s
, int line
, int stopline
,
1248 print_source_lines_flags flags
)
1250 bool noprint
= false;
1251 int nlines
= stopline
- line
;
1252 struct ui_out
*uiout
= current_uiout
;
1254 /* Regardless of whether we can open the file, set current_source_symtab. */
1255 current_source_location
*loc
1256 = get_source_location (current_program_space
);
1259 first_line_listed
= line
;
1260 last_line_listed
= line
;
1262 /* If printing of source lines is disabled, just print file and line
1264 if (uiout
->test_flags (ui_source_list
))
1266 /* Only prints "No such file or directory" once. */
1267 if (s
== last_source_visited
)
1269 if (last_source_error
)
1271 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1277 last_source_visited
= s
;
1278 scoped_fd desc
= open_source_file (s
);
1279 last_source_error
= desc
.get () < 0;
1280 if (last_source_error
)
1286 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1292 if (!(flags
& PRINT_SOURCE_LINES_NOERROR
))
1294 const char *filename
= symtab_to_filename_for_display (s
);
1295 int len
= strlen (filename
) + 100;
1296 char *name
= (char *) alloca (len
);
1298 xsnprintf (name
, len
, "%d\t%s", line
, filename
);
1299 print_sys_errmsg (name
, errno
);
1303 uiout
->field_signed ("line", line
);
1304 uiout
->text ("\tin ");
1306 /* CLI expects only the "file" field. TUI expects only the
1307 "fullname" field (and TUI does break if "file" is printed).
1308 MI expects both fields. ui_source_list is set only for CLI,
1310 if (uiout
->is_mi_like_p () || uiout
->test_flags (ui_source_list
))
1311 uiout
->field_string ("file", symtab_to_filename_for_display (s
),
1312 file_name_style
.style ());
1313 if (uiout
->is_mi_like_p () || !uiout
->test_flags (ui_source_list
))
1315 const char *s_fullname
= symtab_to_fullname (s
);
1316 char *local_fullname
;
1318 /* ui_out_field_string may free S_FULLNAME by calling
1319 open_source_file for it again. See e.g.,
1320 tui_field_string->tui_show_source. */
1321 local_fullname
= (char *) alloca (strlen (s_fullname
) + 1);
1322 strcpy (local_fullname
, s_fullname
);
1324 uiout
->field_string ("fullname", local_fullname
);
1333 /* If the user requested a sequence of lines that seems to go backward
1334 (from high to low line numbers) then we don't print anything. */
1335 if (stopline
<= line
)
1339 if (!g_source_cache
.get_source_lines (s
, line
, stopline
- 1, &lines
))
1341 const std::vector
<off_t
> *offsets
= nullptr;
1342 g_source_cache
.get_line_charpos (s
, &offsets
);
1343 error (_("Line number %d out of range; %s has %d lines."),
1344 line
, symtab_to_filename_for_display (s
),
1345 offsets
== nullptr ? 0 : (int) offsets
->size ());
1348 const char *iter
= lines
.c_str ();
1349 int new_lineno
= loc
->line ();
1350 while (nlines
-- > 0 && *iter
!= '\0')
1354 last_line_listed
= loc
->line ();
1355 if (flags
& PRINT_SOURCE_LINES_FILENAME
)
1357 uiout
->text (symtab_to_filename_for_display (s
));
1360 xsnprintf (buf
, sizeof (buf
), "%d\t", new_lineno
++);
1363 while (*iter
!= '\0')
1365 /* Find a run of characters that can be emitted at once.
1366 This is done so that escape sequences are kept
1368 const char *start
= iter
;
1374 if (c
== '\033' && skip_ansi_escape (iter
, &skip_bytes
))
1376 else if (c
>= 0 && c
< 040 && c
!= '\t')
1385 std::string
text (start
, iter
);
1386 uiout
->text (text
.c_str ());
1390 /* Treat either \r or \r\n as a single newline. */
1396 else if (*iter
== '\n')
1401 else if (*iter
> 0 && *iter
< 040)
1403 xsnprintf (buf
, sizeof (buf
), "^%c", *iter
+ 0100);
1407 else if (*iter
== 0177)
1416 loc
->set (loc
->symtab (), new_lineno
);
1423 print_source_lines (struct symtab
*s
, int line
, int stopline
,
1424 print_source_lines_flags flags
)
1426 print_source_lines_base (s
, line
, stopline
, flags
);
1432 print_source_lines (struct symtab
*s
, source_lines_range line_range
,
1433 print_source_lines_flags flags
)
1435 print_source_lines_base (s
, line_range
.startline (),
1436 line_range
.stopline (), flags
);
1441 /* Print info on range of pc's in a specified line. */
1444 info_line_command (const char *arg
, int from_tty
)
1446 CORE_ADDR start_pc
, end_pc
;
1448 std::vector
<symtab_and_line
> decoded_sals
;
1449 symtab_and_line curr_sal
;
1450 gdb::array_view
<symtab_and_line
> sals
;
1454 current_source_location
*loc
1455 = get_source_location (current_program_space
);
1456 curr_sal
.symtab
= loc
->symtab ();
1457 curr_sal
.pspace
= current_program_space
;
1458 if (last_line_listed
!= 0)
1459 curr_sal
.line
= last_line_listed
;
1461 curr_sal
.line
= loc
->line ();
1467 decoded_sals
= decode_line_with_last_displayed (arg
,
1468 DECODE_LINE_LIST_MODE
);
1469 sals
= decoded_sals
;
1474 /* C++ More than one line may have been specified, as when the user
1475 specifies an overloaded function name. Print info on them all. */
1476 for (const auto &sal
: sals
)
1478 if (sal
.pspace
!= current_program_space
)
1481 if (sal
.symtab
== 0)
1483 struct gdbarch
*gdbarch
= get_current_arch ();
1485 printf_filtered (_("No line number information available"));
1488 /* This is useful for "info line *0x7f34". If we can't tell the
1489 user about a source line, at least let them have the symbolic
1491 printf_filtered (" for address ");
1493 print_address (gdbarch
, sal
.pc
, gdb_stdout
);
1496 printf_filtered (".");
1497 printf_filtered ("\n");
1499 else if (sal
.line
> 0
1500 && find_line_pc_range (sal
, &start_pc
, &end_pc
))
1502 struct gdbarch
*gdbarch
= SYMTAB_OBJFILE (sal
.symtab
)->arch ();
1504 if (start_pc
== end_pc
)
1506 printf_filtered ("Line %d of \"%s\"",
1508 symtab_to_filename_for_display (sal
.symtab
));
1510 printf_filtered (" is at address ");
1511 print_address (gdbarch
, start_pc
, gdb_stdout
);
1513 printf_filtered (" but contains no code.\n");
1517 printf_filtered ("Line %d of \"%s\"",
1519 symtab_to_filename_for_display (sal
.symtab
));
1521 printf_filtered (" starts at address ");
1522 print_address (gdbarch
, start_pc
, gdb_stdout
);
1524 printf_filtered (" and ends at ");
1525 print_address (gdbarch
, end_pc
, gdb_stdout
);
1526 printf_filtered (".\n");
1529 /* x/i should display this line's code. */
1530 set_next_address (gdbarch
, start_pc
);
1532 /* Repeating "info line" should do the following line. */
1533 last_line_listed
= sal
.line
+ 1;
1535 /* If this is the only line, show the source code. If it could
1536 not find the file, don't do anything special. */
1537 if (sals
.size () == 1)
1538 annotate_source_line (sal
.symtab
, sal
.line
, 0, start_pc
);
1541 /* Is there any case in which we get here, and have an address
1542 which the user would want to see? If we have debugging symbols
1543 and no line numbers? */
1544 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1545 sal
.line
, symtab_to_filename_for_display (sal
.symtab
));
1549 /* Commands to search the source file for a regexp. */
1551 /* Helper for forward_search_command/reverse_search_command. FORWARD
1552 indicates direction: true for forward, false for
1553 backward/reverse. */
1556 search_command_helper (const char *regex
, int from_tty
, bool forward
)
1558 const char *msg
= re_comp (regex
);
1560 error (("%s"), msg
);
1562 current_source_location
*loc
1563 = get_source_location (current_program_space
);
1564 if (loc
->symtab () == nullptr)
1565 select_source_symtab (0);
1567 scoped_fd
desc (open_source_file (loc
->symtab ()));
1568 if (desc
.get () < 0)
1569 perror_with_name (symtab_to_filename_for_display (loc
->symtab ()));
1572 ? last_line_listed
+ 1
1573 : last_line_listed
- 1);
1575 const std::vector
<off_t
> *offsets
;
1577 || !g_source_cache
.get_line_charpos (loc
->symtab (), &offsets
)
1578 || line
> offsets
->size ())
1579 error (_("Expression not found"));
1581 if (lseek (desc
.get (), (*offsets
)[line
- 1], 0) < 0)
1582 perror_with_name (symtab_to_filename_for_display (loc
->symtab ()));
1584 gdb_file_up stream
= desc
.to_file (FDOPEN_MODE
);
1585 clearerr (stream
.get ());
1587 gdb::def_vector
<char> buf
;
1594 int c
= fgetc (stream
.get ());
1601 while (c
!= '\n' && (c
= fgetc (stream
.get ())) >= 0);
1603 /* Remove the \r, if any, at the end of the line, otherwise
1604 regular expressions that end with $ or \n won't work. */
1605 size_t sz
= buf
.size ();
1606 if (sz
>= 2 && buf
[sz
- 2] == '\r')
1609 buf
.resize (sz
- 1);
1612 /* We now have a source line in buf, null terminate and match. */
1613 buf
.push_back ('\0');
1614 if (re_exec (buf
.data ()) > 0)
1617 print_source_lines (loc
->symtab (), line
, line
+ 1, 0);
1618 set_internalvar_integer (lookup_internalvar ("_"), line
);
1619 loc
->set (loc
->symtab (), std::max (line
- lines_to_list
/ 2, 1));
1630 if (fseek (stream
.get (), (*offsets
)[line
- 1], 0) < 0)
1632 const char *filename
1633 = symtab_to_filename_for_display (loc
->symtab ());
1634 perror_with_name (filename
);
1639 printf_filtered (_("Expression not found\n"));
1643 forward_search_command (const char *regex
, int from_tty
)
1645 search_command_helper (regex
, from_tty
, true);
1649 reverse_search_command (const char *regex
, int from_tty
)
1651 search_command_helper (regex
, from_tty
, false);
1654 /* If the last character of PATH is a directory separator, then strip it. */
1657 strip_trailing_directory_separator (char *path
)
1659 const int last
= strlen (path
) - 1;
1662 return; /* No stripping is needed if PATH is the empty string. */
1664 if (IS_DIR_SEPARATOR (path
[last
]))
1668 /* Return the path substitution rule that matches FROM.
1669 Return NULL if no rule matches. */
1671 static struct substitute_path_rule
*
1672 find_substitute_path_rule (const char *from
)
1674 struct substitute_path_rule
*rule
= substitute_path_rules
;
1676 while (rule
!= NULL
)
1678 if (FILENAME_CMP (rule
->from
, from
) == 0)
1686 /* Add a new substitute-path rule at the end of the current list of rules.
1687 The new rule will replace FROM into TO. */
1690 add_substitute_path_rule (char *from
, char *to
)
1692 struct substitute_path_rule
*rule
;
1693 struct substitute_path_rule
*new_rule
= XNEW (struct substitute_path_rule
);
1695 new_rule
->from
= xstrdup (from
);
1696 new_rule
->to
= xstrdup (to
);
1697 new_rule
->next
= NULL
;
1699 /* If the list of rules are empty, then insert the new rule
1700 at the head of the list. */
1702 if (substitute_path_rules
== NULL
)
1704 substitute_path_rules
= new_rule
;
1708 /* Otherwise, skip to the last rule in our list and then append
1711 rule
= substitute_path_rules
;
1712 while (rule
->next
!= NULL
)
1715 rule
->next
= new_rule
;
1718 /* Remove the given source path substitution rule from the current list
1719 of rules. The memory allocated for that rule is also deallocated. */
1722 delete_substitute_path_rule (struct substitute_path_rule
*rule
)
1724 if (rule
== substitute_path_rules
)
1725 substitute_path_rules
= rule
->next
;
1728 struct substitute_path_rule
*prev
= substitute_path_rules
;
1730 while (prev
!= NULL
&& prev
->next
!= rule
)
1733 gdb_assert (prev
!= NULL
);
1735 prev
->next
= rule
->next
;
1743 /* Implement the "show substitute-path" command. */
1746 show_substitute_path_command (const char *args
, int from_tty
)
1748 struct substitute_path_rule
*rule
= substitute_path_rules
;
1751 gdb_argv
argv (args
);
1753 /* We expect zero or one argument. */
1755 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1756 error (_("Too many arguments in command"));
1758 if (argv
!= NULL
&& argv
[0] != NULL
)
1761 /* Print the substitution rules. */
1765 (_("Source path substitution rule matching `%s':\n"), from
);
1767 printf_filtered (_("List of all source path substitution rules:\n"));
1769 while (rule
!= NULL
)
1771 if (from
== NULL
|| substitute_path_rule_matches (rule
, from
) != 0)
1772 printf_filtered (" `%s' -> `%s'.\n", rule
->from
, rule
->to
);
1777 /* Implement the "unset substitute-path" command. */
1780 unset_substitute_path_command (const char *args
, int from_tty
)
1782 struct substitute_path_rule
*rule
= substitute_path_rules
;
1783 gdb_argv
argv (args
);
1787 /* This function takes either 0 or 1 argument. */
1789 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1790 error (_("Incorrect usage, too many arguments in command"));
1792 if (argv
!= NULL
&& argv
[0] != NULL
)
1795 /* If the user asked for all the rules to be deleted, ask him
1796 to confirm and give him a chance to abort before the action
1800 && !query (_("Delete all source path substitution rules? ")))
1801 error (_("Canceled"));
1803 /* Delete the rule matching the argument. No argument means that
1804 all rules should be deleted. */
1806 while (rule
!= NULL
)
1808 struct substitute_path_rule
*next
= rule
->next
;
1810 if (from
== NULL
|| FILENAME_CMP (from
, rule
->from
) == 0)
1812 delete_substitute_path_rule (rule
);
1819 /* If the user asked for a specific rule to be deleted but
1820 we could not find it, then report an error. */
1822 if (from
!= NULL
&& !rule_found
)
1823 error (_("No substitution rule defined for `%s'"), from
);
1825 forget_cached_source_info ();
1828 /* Add a new source path substitution rule. */
1831 set_substitute_path_command (const char *args
, int from_tty
)
1833 struct substitute_path_rule
*rule
;
1835 gdb_argv
argv (args
);
1837 if (argv
== NULL
|| argv
[0] == NULL
|| argv
[1] == NULL
)
1838 error (_("Incorrect usage, too few arguments in command"));
1840 if (argv
[2] != NULL
)
1841 error (_("Incorrect usage, too many arguments in command"));
1843 if (*(argv
[0]) == '\0')
1844 error (_("First argument must be at least one character long"));
1846 /* Strip any trailing directory separator character in either FROM
1847 or TO. The substitution rule already implicitly contains them. */
1848 strip_trailing_directory_separator (argv
[0]);
1849 strip_trailing_directory_separator (argv
[1]);
1851 /* If a rule with the same "from" was previously defined, then
1852 delete it. This new rule replaces it. */
1854 rule
= find_substitute_path_rule (argv
[0]);
1856 delete_substitute_path_rule (rule
);
1858 /* Insert the new substitution rule. */
1860 add_substitute_path_rule (argv
[0], argv
[1]);
1861 forget_cached_source_info ();
1866 source_lines_range::source_lines_range (int startline
,
1867 source_lines_range::direction dir
)
1869 if (dir
== source_lines_range::FORWARD
)
1871 LONGEST end
= static_cast <LONGEST
> (startline
) + get_lines_to_list ();
1876 m_startline
= startline
;
1877 m_stopline
= static_cast <int> (end
);
1881 LONGEST start
= static_cast <LONGEST
> (startline
) - get_lines_to_list ();
1886 m_startline
= static_cast <int> (start
);
1887 m_stopline
= startline
;
1892 void _initialize_source ();
1894 _initialize_source ()
1896 struct cmd_list_element
*c
;
1898 init_source_path ();
1900 /* The intention is to use POSIX Basic Regular Expressions.
1901 Always use the GNU regex routine for consistency across all hosts.
1902 Our current GNU regex.c does not have all the POSIX features, so this is
1903 just an approximation. */
1904 re_set_syntax (RE_SYNTAX_GREP
);
1906 c
= add_cmd ("directory", class_files
, directory_command
, _("\
1907 Add directory DIR to beginning of search path for source files.\n\
1908 Forget cached info on source file locations and line positions.\n\
1909 DIR can also be $cwd for the current working directory, or $cdir for the\n\
1910 directory in which the source file was compiled into object code.\n\
1911 With no argument, reset the search path to $cdir:$cwd, the default."),
1915 add_com_alias ("use", "directory", class_files
, 0);
1917 set_cmd_completer (c
, filename_completer
);
1919 add_setshow_optional_filename_cmd ("directories",
1923 Set the search path for finding source files."),
1925 Show the search path for finding source files."),
1927 $cwd in the path means the current working directory.\n\
1928 $cdir in the path means the compilation directory of the source file.\n\
1929 GDB ensures the search path always ends with $cdir:$cwd by\n\
1930 appending these directories if necessary.\n\
1931 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
1932 set_directories_command
,
1933 show_directories_command
,
1934 &setlist
, &showlist
);
1936 add_info ("source", info_source_command
,
1937 _("Information about the current source file."));
1939 add_info ("line", info_line_command
, _("\
1940 Core addresses of the code for a source line.\n\
1941 Line can be specified as\n\
1942 LINENUM, to list around that line in current file,\n\
1943 FILE:LINENUM, to list around that line in that file,\n\
1944 FUNCTION, to list around beginning of that function,\n\
1945 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1946 Default is to describe the last source line that was listed.\n\n\
1947 This sets the default address for \"x\" to the line's first instruction\n\
1948 so that \"x/i\" suffices to start examining the machine code.\n\
1949 The address is also stored as the value of \"$_\"."));
1951 add_com ("forward-search", class_files
, forward_search_command
, _("\
1952 Search for regular expression (see regex(3)) from last line listed.\n\
1953 The matching line number is also stored as the value of \"$_\"."));
1954 add_com_alias ("search", "forward-search", class_files
, 0);
1955 add_com_alias ("fo", "forward-search", class_files
, 1);
1957 add_com ("reverse-search", class_files
, reverse_search_command
, _("\
1958 Search backward for regular expression (see regex(3)) from last line listed.\n\
1959 The matching line number is also stored as the value of \"$_\"."));
1960 add_com_alias ("rev", "reverse-search", class_files
, 1);
1962 add_setshow_integer_cmd ("listsize", class_support
, &lines_to_list
, _("\
1963 Set number of source lines gdb will list by default."), _("\
1964 Show number of source lines gdb will list by default."), _("\
1965 Use this to choose how many source lines the \"list\" displays (unless\n\
1966 the \"list\" argument explicitly specifies some other number).\n\
1967 A value of \"unlimited\", or zero, means there's no limit."),
1970 &setlist
, &showlist
);
1972 add_cmd ("substitute-path", class_files
, set_substitute_path_command
,
1974 Add a substitution rule to rewrite the source directories.\n\
1975 Usage: set substitute-path FROM TO\n\
1976 The rule is applied only if the directory name starts with FROM\n\
1977 directly followed by a directory separator.\n\
1978 If a substitution rule was previously set for FROM, the old rule\n\
1979 is replaced by the new one."),
1982 add_cmd ("substitute-path", class_files
, unset_substitute_path_command
,
1984 Delete one or all substitution rules rewriting the source directories.\n\
1985 Usage: unset substitute-path [FROM]\n\
1986 Delete the rule for substituting FROM in source directories. If FROM\n\
1987 is not specified, all substituting rules are deleted.\n\
1988 If the debugger cannot find a rule for FROM, it will display a warning."),
1991 add_cmd ("substitute-path", class_files
, show_substitute_path_command
,
1993 Show one or all substitution rules rewriting the source directories.\n\
1994 Usage: show substitute-path [FROM]\n\
1995 Print the rule for substituting FROM in source directories. If FROM\n\
1996 is not specified, print all substitution rules."),
1999 add_setshow_enum_cmd ("filename-display", class_files
,
2000 filename_display_kind_names
,
2001 &filename_display_string
, _("\
2002 Set how to display filenames."), _("\
2003 Show how to display filenames."), _("\
2004 filename-display can be:\n\
2005 basename - display only basename of a filename\n\
2006 relative - display a filename relative to the compilation directory\n\
2007 absolute - display an absolute filename\n\
2008 By default, relative filenames are displayed."),
2010 show_filename_display_string
,
2011 &setlist
, &showlist
);