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 for (struct program_space
*pspace
: program_spaces
)
425 for (objfile
*objfile
: pspace
->objfiles ())
427 forget_cached_source_info_for_objfile (objfile
);
430 g_source_cache
.clear ();
431 last_source_visited
= NULL
;
435 init_source_path (void)
439 xsnprintf (buf
, sizeof (buf
), "$cdir%c$cwd", DIRNAME_SEPARATOR
);
440 source_path
= xstrdup (buf
);
441 forget_cached_source_info ();
444 /* Add zero or more directories to the front of the source path. */
447 directory_command (const char *dirname
, int from_tty
)
449 bool value_changed
= false;
451 /* FIXME, this goes to "delete dir"... */
454 if (!from_tty
|| query (_("Reinitialize source path to empty? ")))
458 value_changed
= true;
463 mod_path (dirname
, &source_path
);
464 forget_cached_source_info ();
465 value_changed
= true;
469 gdb::observers::command_param_changed
.notify ("directories", source_path
);
471 show_directories_1 ((char *) 0, from_tty
);
475 /* Add a path given with the -d command line switch.
476 This will not be quoted so we must not treat spaces as separators. */
479 directory_switch (const char *dirname
, int from_tty
)
481 add_path (dirname
, &source_path
, 0);
484 /* Add zero or more directories to the front of an arbitrary path. */
487 mod_path (const char *dirname
, char **which_path
)
489 add_path (dirname
, which_path
, 1);
492 /* Workhorse of mod_path. Takes an extra argument to determine
493 if dirname should be parsed for separators that indicate multiple
494 directories. This allows for interfaces that pre-parse the dirname
495 and allow specification of traditional separator characters such
499 add_path (const char *dirname
, char **which_path
, int parse_separators
)
501 char *old
= *which_path
;
503 std::vector
<gdb::unique_xmalloc_ptr
<char>> dir_vec
;
508 if (parse_separators
)
510 /* This will properly parse the space and tab separators
511 and any quotes that may exist. */
512 gdb_argv
argv (dirname
);
514 for (char *arg
: argv
)
515 dirnames_to_char_ptr_vec_append (&dir_vec
, arg
);
518 dir_vec
.emplace_back (xstrdup (dirname
));
520 for (const gdb::unique_xmalloc_ptr
<char> &name_up
: dir_vec
)
522 char *name
= name_up
.get ();
525 gdb::unique_xmalloc_ptr
<char> new_name_holder
;
527 /* Spaces and tabs will have been removed by buildargv().
528 NAME is the start of the directory.
529 P is the '\0' following the end. */
530 p
= name
+ strlen (name
);
532 while (!(IS_DIR_SEPARATOR (*name
) && p
<= name
+ 1) /* "/" */
533 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
534 /* On MS-DOS and MS-Windows, h:\ is different from h: */
535 && !(p
== name
+ 3 && name
[1] == ':') /* "d:/" */
537 && IS_DIR_SEPARATOR (p
[-1]))
538 /* Sigh. "foo/" => "foo" */
542 while (p
> name
&& p
[-1] == '.')
546 /* "." => getwd (). */
547 name
= current_directory
;
550 else if (p
> name
+ 1 && IS_DIR_SEPARATOR (p
[-2]))
560 /* "...foo/." => "...foo". */
571 new_name_holder
.reset (tilde_expand (name
));
572 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
573 else if (IS_ABSOLUTE_PATH (name
) && p
== name
+ 2) /* "d:" => "d:." */
574 new_name_holder
.reset (concat (name
, ".", (char *) NULL
));
576 else if (!IS_ABSOLUTE_PATH (name
) && name
[0] != '$')
577 new_name_holder
= gdb_abspath (name
);
579 new_name_holder
.reset (savestring (name
, p
- name
));
580 name
= new_name_holder
.get ();
582 /* Unless it's a variable, check existence. */
585 /* These are warnings, not errors, since we don't want a
586 non-existent directory in a .gdbinit file to stop processing
587 of the .gdbinit file.
589 Whether they get added to the path is more debatable. Current
590 answer is yes, in case the user wants to go make the directory
591 or whatever. If the directory continues to not exist/not be
592 a directory/etc, then having them in the path should be
594 if (stat (name
, &st
) < 0)
596 int save_errno
= errno
;
598 fprintf_unfiltered (gdb_stderr
, "Warning: ");
599 print_sys_errmsg (name
, save_errno
);
601 else if ((st
.st_mode
& S_IFMT
) != S_IFDIR
)
602 warning (_("%s is not a directory."), name
);
607 unsigned int len
= strlen (name
);
613 /* FIXME: we should use realpath() or its work-alike
614 before comparing. Then all the code above which
615 removes excess slashes and dots could simply go away. */
616 if (!filename_ncmp (p
, name
, len
)
617 && (p
[len
] == '\0' || p
[len
] == DIRNAME_SEPARATOR
))
619 /* Found it in the search path, remove old copy. */
622 /* Back over leading separator. */
625 if (prefix
> p
- *which_path
)
627 /* Same dir twice in one cmd. */
630 /* Copy from next '\0' or ':'. */
631 memmove (p
, &p
[len
+ 1], strlen (&p
[len
+ 1]) + 1);
633 p
= strchr (p
, DIRNAME_SEPARATOR
);
640 tinybuf
[0] = DIRNAME_SEPARATOR
;
643 /* If we have already tacked on a name(s) in this command,
644 be sure they stay on the front as we tack on some
652 temp
= concat (old
, tinybuf
, name
, (char *)NULL
);
654 *which_path
= concat (temp
, "", &old
[prefix
], (char *) NULL
);
655 prefix
= strlen (temp
);
660 *which_path
= concat (name
, (old
[0] ? tinybuf
: old
),
662 prefix
= strlen (name
);
674 info_source_command (const char *ignore
, int from_tty
)
676 current_source_location
*loc
677 = get_source_location (current_program_space
);
678 struct symtab
*s
= loc
->symtab ();
679 struct compunit_symtab
*cust
;
683 printf_filtered (_("No current source file.\n"));
687 cust
= SYMTAB_COMPUNIT (s
);
688 printf_filtered (_("Current source file is %s\n"), s
->filename
);
689 if (SYMTAB_DIRNAME (s
) != NULL
)
690 printf_filtered (_("Compilation directory is %s\n"), SYMTAB_DIRNAME (s
));
692 printf_filtered (_("Located in %s\n"), s
->fullname
);
693 const std::vector
<off_t
> *offsets
;
694 if (g_source_cache
.get_line_charpos (s
, &offsets
))
695 printf_filtered (_("Contains %d line%s.\n"), (int) offsets
->size (),
696 offsets
->size () == 1 ? "" : "s");
698 printf_filtered (_("Source language is %s.\n"), language_str (s
->language
));
699 printf_filtered (_("Producer is %s.\n"),
700 COMPUNIT_PRODUCER (cust
) != NULL
701 ? COMPUNIT_PRODUCER (cust
) : _("unknown"));
702 printf_filtered (_("Compiled with %s debugging format.\n"),
703 COMPUNIT_DEBUGFORMAT (cust
));
704 printf_filtered (_("%s preprocessor macro info.\n"),
705 COMPUNIT_MACRO_TABLE (cust
) != NULL
706 ? "Includes" : "Does not include");
710 /* Helper function to remove characters from the start of PATH so that
711 PATH can then be appended to a directory name. We remove leading drive
712 letters (for dos) as well as leading '/' characters and './'
716 prepare_path_for_appending (const char *path
)
718 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
719 if (HAS_DRIVE_SPEC (path
))
720 path
= STRIP_DRIVE_SPEC (path
);
722 const char *old_path
;
727 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
728 while (IS_DIR_SEPARATOR(path
[0]))
732 while (path
[0] == '.' && IS_DIR_SEPARATOR (path
[1]))
735 while (old_path
!= path
);
740 /* Open a file named STRING, searching path PATH (dir names sep by some char)
741 using mode MODE in the calls to open. You cannot use this function to
742 create files (O_CREAT).
744 OPTS specifies the function behaviour in specific cases.
746 If OPF_TRY_CWD_FIRST, try to open ./STRING before searching PATH.
747 (ie pretend the first element of PATH is "."). This also indicates
748 that, unless OPF_SEARCH_IN_PATH is also specified, a slash in STRING
749 disables searching of the path (this is so that "exec-file ./foo" or
750 "symbol-file ./foo" insures that you get that particular version of
751 foo or an error message).
753 If OPTS has OPF_SEARCH_IN_PATH set, absolute names will also be
754 searched in path (we usually want this for source files but not for
757 If FILENAME_OPENED is non-null, set it to a newly allocated string naming
758 the actual file opened (this string will always start with a "/"). We
759 have to take special pains to avoid doubling the "/" between the directory
760 and the file, sigh! Emacs gets confuzzed by this when we print the
763 If OPTS has OPF_RETURN_REALPATH set return FILENAME_OPENED resolved by
764 gdb_realpath. Even without OPF_RETURN_REALPATH this function still returns
765 filename starting with "/". If FILENAME_OPENED is NULL this option has no
768 If a file is found, return the descriptor.
769 Otherwise, return -1, with errno set for the last name we tried to open. */
771 /* >>>> This should only allow files of certain types,
772 >>>> eg executable, non-directory. */
774 openp (const char *path
, openp_flags opts
, const char *string
,
775 int mode
, gdb::unique_xmalloc_ptr
<char> *filename_opened
)
780 /* The errno set for the last name we tried to open (and
783 std::vector
<gdb::unique_xmalloc_ptr
<char>> dir_vec
;
785 /* The open syscall MODE parameter is not specified. */
786 gdb_assert ((mode
& O_CREAT
) == 0);
787 gdb_assert (string
!= NULL
);
789 /* A file with an empty name cannot possibly exist. Report a failure
790 without further checking.
792 This is an optimization which also defends us against buggy
793 implementations of the "stat" function. For instance, we have
794 noticed that a MinGW debugger built on Windows XP 32bits crashes
795 when the debugger is started with an empty argument. */
796 if (string
[0] == '\0')
807 if ((opts
& OPF_TRY_CWD_FIRST
) || IS_ABSOLUTE_PATH (string
))
809 int i
, reg_file_errno
;
811 if (is_regular_file (string
, ®_file_errno
))
813 filename
= (char *) alloca (strlen (string
) + 1);
814 strcpy (filename
, string
);
815 fd
= gdb_open_cloexec (filename
, mode
, 0);
824 last_errno
= reg_file_errno
;
827 if (!(opts
& OPF_SEARCH_IN_PATH
))
828 for (i
= 0; string
[i
]; i
++)
829 if (IS_DIR_SEPARATOR (string
[i
]))
833 /* Remove characters from the start of PATH that we don't need when PATH
834 is appended to a directory name. */
835 string
= prepare_path_for_appending (string
);
837 alloclen
= strlen (path
) + strlen (string
) + 2;
838 filename
= (char *) alloca (alloclen
);
842 dir_vec
= dirnames_to_char_ptr_vec (path
);
844 for (const gdb::unique_xmalloc_ptr
<char> &dir_up
: dir_vec
)
846 char *dir
= dir_up
.get ();
847 size_t len
= strlen (dir
);
850 if (strcmp (dir
, "$cwd") == 0)
852 /* Name is $cwd -- insert current directory name instead. */
855 /* First, realloc the filename buffer if too short. */
856 len
= strlen (current_directory
);
857 newlen
= len
+ strlen (string
) + 2;
858 if (newlen
> alloclen
)
861 filename
= (char *) alloca (alloclen
);
863 strcpy (filename
, current_directory
);
865 else if (strchr(dir
, '~'))
867 /* See whether we need to expand the tilde. */
870 gdb::unique_xmalloc_ptr
<char> tilde_expanded (tilde_expand (dir
));
872 /* First, realloc the filename buffer if too short. */
873 len
= strlen (tilde_expanded
.get ());
874 newlen
= len
+ strlen (string
) + 2;
875 if (newlen
> alloclen
)
878 filename
= (char *) alloca (alloclen
);
880 strcpy (filename
, tilde_expanded
.get ());
884 /* Normal file name in path -- just use it. */
885 strcpy (filename
, dir
);
887 /* Don't search $cdir. It's also a magic path like $cwd, but we
888 don't have enough information to expand it. The user *could*
889 have an actual directory named '$cdir' but handling that would
890 be confusing, it would mean different things in different
891 contexts. If the user really has '$cdir' one can use './$cdir'.
892 We can get $cdir when loading scripts. When loading source files
893 $cdir must have already been expanded to the correct value. */
894 if (strcmp (dir
, "$cdir") == 0)
898 /* Remove trailing slashes. */
899 while (len
> 0 && IS_DIR_SEPARATOR (filename
[len
- 1]))
902 strcat (filename
+ len
, SLASH_STRING
);
903 strcat (filename
, string
);
905 if (is_regular_file (filename
, ®_file_errno
))
907 fd
= gdb_open_cloexec (filename
, mode
, 0);
913 last_errno
= reg_file_errno
;
919 /* If a file was opened, canonicalize its filename. */
921 filename_opened
->reset (NULL
);
922 else if ((opts
& OPF_RETURN_REALPATH
) != 0)
923 *filename_opened
= gdb_realpath (filename
);
925 *filename_opened
= gdb_abspath (filename
);
933 /* This is essentially a convenience, for clients that want the behaviour
934 of openp, using source_path, but that really don't want the file to be
935 opened but want instead just to know what the full pathname is (as
936 qualified against source_path).
938 The current working directory is searched first.
940 If the file was found, this function returns 1, and FULL_PATHNAME is
941 set to the fully-qualified pathname.
943 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
945 source_full_path_of (const char *filename
,
946 gdb::unique_xmalloc_ptr
<char> *full_pathname
)
950 fd
= openp (source_path
,
951 OPF_TRY_CWD_FIRST
| OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
,
952 filename
, O_RDONLY
, full_pathname
);
955 full_pathname
->reset (NULL
);
963 /* Return non-zero if RULE matches PATH, that is if the rule can be
967 substitute_path_rule_matches (const struct substitute_path_rule
*rule
,
970 const int from_len
= strlen (rule
->from
);
971 const int path_len
= strlen (path
);
973 if (path_len
< from_len
)
976 /* The substitution rules are anchored at the start of the path,
977 so the path should start with rule->from. */
979 if (filename_ncmp (path
, rule
->from
, from_len
) != 0)
982 /* Make sure that the region in the path that matches the substitution
983 rule is immediately followed by a directory separator (or the end of
984 string character). */
986 if (path
[from_len
] != '\0' && !IS_DIR_SEPARATOR (path
[from_len
]))
992 /* Find the substitute-path rule that applies to PATH and return it.
993 Return NULL if no rule applies. */
995 static struct substitute_path_rule
*
996 get_substitute_path_rule (const char *path
)
998 struct substitute_path_rule
*rule
= substitute_path_rules
;
1000 while (rule
!= NULL
&& !substitute_path_rule_matches (rule
, path
))
1006 /* If the user specified a source path substitution rule that applies
1007 to PATH, then apply it and return the new path.
1009 Return NULL if no substitution rule was specified by the user,
1010 or if no rule applied to the given PATH. */
1012 gdb::unique_xmalloc_ptr
<char>
1013 rewrite_source_path (const char *path
)
1015 const struct substitute_path_rule
*rule
= get_substitute_path_rule (path
);
1022 from_len
= strlen (rule
->from
);
1024 /* Compute the rewritten path and return it. */
1027 (char *) xmalloc (strlen (path
) + 1 + strlen (rule
->to
) - from_len
);
1028 strcpy (new_path
, rule
->to
);
1029 strcat (new_path
, path
+ from_len
);
1031 return gdb::unique_xmalloc_ptr
<char> (new_path
);
1037 find_and_open_source (const char *filename
,
1038 const char *dirname
,
1039 gdb::unique_xmalloc_ptr
<char> *fullname
)
1041 char *path
= source_path
;
1045 /* Quick way out if we already know its full name. */
1049 /* The user may have requested that source paths be rewritten
1050 according to substitution rules he provided. If a substitution
1051 rule applies to this path, then apply it. */
1052 gdb::unique_xmalloc_ptr
<char> rewritten_fullname
1053 = rewrite_source_path (fullname
->get ());
1055 if (rewritten_fullname
!= NULL
)
1056 *fullname
= std::move (rewritten_fullname
);
1058 result
= gdb_open_cloexec (fullname
->get (), OPEN_MODE
, 0);
1061 *fullname
= gdb_realpath (fullname
->get ());
1062 return scoped_fd (result
);
1065 /* Didn't work -- free old one, try again. */
1066 fullname
->reset (NULL
);
1069 gdb::unique_xmalloc_ptr
<char> rewritten_dirname
;
1070 if (dirname
!= NULL
)
1072 /* If necessary, rewrite the compilation directory name according
1073 to the source path substitution rules specified by the user. */
1075 rewritten_dirname
= rewrite_source_path (dirname
);
1077 if (rewritten_dirname
!= NULL
)
1078 dirname
= rewritten_dirname
.get ();
1080 /* Replace a path entry of $cdir with the compilation directory
1083 p
= strstr (source_path
, "$cdir");
1084 if (p
&& (p
== path
|| p
[-1] == DIRNAME_SEPARATOR
)
1085 && (p
[cdir_len
] == DIRNAME_SEPARATOR
|| p
[cdir_len
] == '\0'))
1090 alloca (strlen (source_path
) + 1 + strlen (dirname
) + 1);
1091 len
= p
- source_path
;
1092 strncpy (path
, source_path
, len
); /* Before $cdir */
1093 strcpy (path
+ len
, dirname
); /* new stuff */
1094 strcat (path
+ len
, source_path
+ len
+ cdir_len
); /* After
1099 gdb::unique_xmalloc_ptr
<char> rewritten_filename
1100 = rewrite_source_path (filename
);
1102 if (rewritten_filename
!= NULL
)
1103 filename
= rewritten_filename
.get ();
1105 /* Try to locate file using filename. */
1106 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, filename
,
1107 OPEN_MODE
, fullname
);
1108 if (result
< 0 && dirname
!= NULL
)
1110 /* Remove characters from the start of PATH that we don't need when
1111 PATH is appended to a directory name. */
1112 const char *filename_start
= prepare_path_for_appending (filename
);
1114 /* Try to locate file using compilation dir + filename. This is
1115 helpful if part of the compilation directory was removed,
1116 e.g. using gcc's -fdebug-prefix-map, and we have added the missing
1117 prefix to source_path. */
1118 std::string
cdir_filename (dirname
);
1120 /* Remove any trailing directory separators. */
1121 while (IS_DIR_SEPARATOR (cdir_filename
.back ()))
1122 cdir_filename
.pop_back ();
1124 /* Add our own directory separator. */
1125 cdir_filename
.append (SLASH_STRING
);
1126 cdir_filename
.append (filename_start
);
1128 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
,
1129 cdir_filename
.c_str (), OPEN_MODE
, fullname
);
1133 /* Didn't work. Try using just the basename. */
1134 p
= lbasename (filename
);
1136 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, p
,
1137 OPEN_MODE
, fullname
);
1140 return scoped_fd (result
);
1143 /* Open a source file given a symtab S. Returns a file descriptor or
1144 negative number for error.
1146 This function is a convenience function to find_and_open_source. */
1149 open_source_file (struct symtab
*s
)
1152 return scoped_fd (-1);
1154 gdb::unique_xmalloc_ptr
<char> fullname (s
->fullname
);
1156 scoped_fd fd
= find_and_open_source (s
->filename
, SYMTAB_DIRNAME (s
),
1161 if (SYMTAB_COMPUNIT (s
) != nullptr)
1163 const objfile
*ofp
= COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (s
));
1165 std::string srcpath
;
1166 if (IS_ABSOLUTE_PATH (s
->filename
))
1167 srcpath
= s
->filename
;
1168 else if (SYMTAB_DIRNAME (s
) != nullptr)
1170 srcpath
= SYMTAB_DIRNAME (s
);
1171 srcpath
+= SLASH_STRING
;
1172 srcpath
+= s
->filename
;
1175 const struct bfd_build_id
*build_id
= build_id_bfd_get (ofp
->obfd
);
1177 /* Query debuginfod for the source file. */
1178 if (build_id
!= nullptr && !srcpath
.empty ())
1179 fd
= debuginfod_source_query (build_id
->data
,
1186 s
->fullname
= fullname
.release ();
1190 /* Finds the fullname that a symtab represents.
1192 This functions finds the fullname and saves it in s->fullname.
1193 It will also return the value.
1195 If this function fails to find the file that this symtab represents,
1196 the expected fullname is used. Therefore the files does not have to
1200 symtab_to_fullname (struct symtab
*s
)
1202 /* Use cached copy if we have it.
1203 We rely on forget_cached_source_info being called appropriately
1204 to handle cases like the file being moved. */
1205 if (s
->fullname
== NULL
)
1207 scoped_fd fd
= open_source_file (s
);
1211 gdb::unique_xmalloc_ptr
<char> fullname
;
1213 /* rewrite_source_path would be applied by find_and_open_source, we
1214 should report the pathname where GDB tried to find the file. */
1216 if (SYMTAB_DIRNAME (s
) == NULL
|| IS_ABSOLUTE_PATH (s
->filename
))
1217 fullname
.reset (xstrdup (s
->filename
));
1219 fullname
.reset (concat (SYMTAB_DIRNAME (s
), SLASH_STRING
,
1220 s
->filename
, (char *) NULL
));
1222 s
->fullname
= rewrite_source_path (fullname
.get ()).release ();
1223 if (s
->fullname
== NULL
)
1224 s
->fullname
= fullname
.release ();
1231 /* See commentary in source.h. */
1234 symtab_to_filename_for_display (struct symtab
*symtab
)
1236 if (filename_display_string
== filename_display_basename
)
1237 return lbasename (symtab
->filename
);
1238 else if (filename_display_string
== filename_display_absolute
)
1239 return symtab_to_fullname (symtab
);
1240 else if (filename_display_string
== filename_display_relative
)
1241 return symtab
->filename
;
1243 internal_error (__FILE__
, __LINE__
, _("invalid filename_display_string"));
1248 /* Print source lines from the file of symtab S,
1249 starting with line number LINE and stopping before line number STOPLINE. */
1252 print_source_lines_base (struct symtab
*s
, int line
, int stopline
,
1253 print_source_lines_flags flags
)
1255 bool noprint
= false;
1256 int nlines
= stopline
- line
;
1257 struct ui_out
*uiout
= current_uiout
;
1259 /* Regardless of whether we can open the file, set current_source_symtab. */
1260 current_source_location
*loc
1261 = get_source_location (current_program_space
);
1264 first_line_listed
= line
;
1265 last_line_listed
= line
;
1267 /* If printing of source lines is disabled, just print file and line
1269 if (uiout
->test_flags (ui_source_list
))
1271 /* Only prints "No such file or directory" once. */
1272 if (s
== last_source_visited
)
1274 if (last_source_error
)
1276 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1282 last_source_visited
= s
;
1283 scoped_fd desc
= open_source_file (s
);
1284 last_source_error
= desc
.get () < 0;
1285 if (last_source_error
)
1291 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1297 if (!(flags
& PRINT_SOURCE_LINES_NOERROR
))
1299 const char *filename
= symtab_to_filename_for_display (s
);
1300 int len
= strlen (filename
) + 100;
1301 char *name
= (char *) alloca (len
);
1303 xsnprintf (name
, len
, "%d\t%s", line
, filename
);
1304 print_sys_errmsg (name
, errno
);
1308 uiout
->field_signed ("line", line
);
1309 uiout
->text ("\tin ");
1311 /* CLI expects only the "file" field. TUI expects only the
1312 "fullname" field (and TUI does break if "file" is printed).
1313 MI expects both fields. ui_source_list is set only for CLI,
1315 if (uiout
->is_mi_like_p () || uiout
->test_flags (ui_source_list
))
1316 uiout
->field_string ("file", symtab_to_filename_for_display (s
),
1317 file_name_style
.style ());
1318 if (uiout
->is_mi_like_p () || !uiout
->test_flags (ui_source_list
))
1320 const char *s_fullname
= symtab_to_fullname (s
);
1321 char *local_fullname
;
1323 /* ui_out_field_string may free S_FULLNAME by calling
1324 open_source_file for it again. See e.g.,
1325 tui_field_string->tui_show_source. */
1326 local_fullname
= (char *) alloca (strlen (s_fullname
) + 1);
1327 strcpy (local_fullname
, s_fullname
);
1329 uiout
->field_string ("fullname", local_fullname
);
1338 /* If the user requested a sequence of lines that seems to go backward
1339 (from high to low line numbers) then we don't print anything. */
1340 if (stopline
<= line
)
1344 if (!g_source_cache
.get_source_lines (s
, line
, stopline
- 1, &lines
))
1346 const std::vector
<off_t
> *offsets
= nullptr;
1347 g_source_cache
.get_line_charpos (s
, &offsets
);
1348 error (_("Line number %d out of range; %s has %d lines."),
1349 line
, symtab_to_filename_for_display (s
),
1350 offsets
== nullptr ? 0 : (int) offsets
->size ());
1353 const char *iter
= lines
.c_str ();
1354 int new_lineno
= loc
->line ();
1355 while (nlines
-- > 0 && *iter
!= '\0')
1359 last_line_listed
= loc
->line ();
1360 if (flags
& PRINT_SOURCE_LINES_FILENAME
)
1362 uiout
->text (symtab_to_filename_for_display (s
));
1365 xsnprintf (buf
, sizeof (buf
), "%d\t", new_lineno
++);
1368 while (*iter
!= '\0')
1370 /* Find a run of characters that can be emitted at once.
1371 This is done so that escape sequences are kept
1373 const char *start
= iter
;
1379 if (c
== '\033' && skip_ansi_escape (iter
, &skip_bytes
))
1381 else if (c
>= 0 && c
< 040 && c
!= '\t')
1390 std::string
text (start
, iter
);
1391 uiout
->text (text
.c_str ());
1395 /* Treat either \r or \r\n as a single newline. */
1401 else if (*iter
== '\n')
1406 else if (*iter
> 0 && *iter
< 040)
1408 xsnprintf (buf
, sizeof (buf
), "^%c", *iter
+ 0100);
1412 else if (*iter
== 0177)
1421 loc
->set (loc
->symtab (), new_lineno
);
1428 print_source_lines (struct symtab
*s
, int line
, int stopline
,
1429 print_source_lines_flags flags
)
1431 print_source_lines_base (s
, line
, stopline
, flags
);
1437 print_source_lines (struct symtab
*s
, source_lines_range line_range
,
1438 print_source_lines_flags flags
)
1440 print_source_lines_base (s
, line_range
.startline (),
1441 line_range
.stopline (), flags
);
1446 /* Print info on range of pc's in a specified line. */
1449 info_line_command (const char *arg
, int from_tty
)
1451 CORE_ADDR start_pc
, end_pc
;
1453 std::vector
<symtab_and_line
> decoded_sals
;
1454 symtab_and_line curr_sal
;
1455 gdb::array_view
<symtab_and_line
> sals
;
1459 current_source_location
*loc
1460 = get_source_location (current_program_space
);
1461 curr_sal
.symtab
= loc
->symtab ();
1462 curr_sal
.pspace
= current_program_space
;
1463 if (last_line_listed
!= 0)
1464 curr_sal
.line
= last_line_listed
;
1466 curr_sal
.line
= loc
->line ();
1472 decoded_sals
= decode_line_with_last_displayed (arg
,
1473 DECODE_LINE_LIST_MODE
);
1474 sals
= decoded_sals
;
1479 /* C++ More than one line may have been specified, as when the user
1480 specifies an overloaded function name. Print info on them all. */
1481 for (const auto &sal
: sals
)
1483 if (sal
.pspace
!= current_program_space
)
1486 if (sal
.symtab
== 0)
1488 struct gdbarch
*gdbarch
= get_current_arch ();
1490 printf_filtered (_("No line number information available"));
1493 /* This is useful for "info line *0x7f34". If we can't tell the
1494 user about a source line, at least let them have the symbolic
1496 printf_filtered (" for address ");
1498 print_address (gdbarch
, sal
.pc
, gdb_stdout
);
1501 printf_filtered (".");
1502 printf_filtered ("\n");
1504 else if (sal
.line
> 0
1505 && find_line_pc_range (sal
, &start_pc
, &end_pc
))
1507 struct gdbarch
*gdbarch
= SYMTAB_OBJFILE (sal
.symtab
)->arch ();
1509 if (start_pc
== end_pc
)
1511 printf_filtered ("Line %d of \"%s\"",
1513 symtab_to_filename_for_display (sal
.symtab
));
1515 printf_filtered (" is at address ");
1516 print_address (gdbarch
, start_pc
, gdb_stdout
);
1518 printf_filtered (" but contains no code.\n");
1522 printf_filtered ("Line %d of \"%s\"",
1524 symtab_to_filename_for_display (sal
.symtab
));
1526 printf_filtered (" starts at address ");
1527 print_address (gdbarch
, start_pc
, gdb_stdout
);
1529 printf_filtered (" and ends at ");
1530 print_address (gdbarch
, end_pc
, gdb_stdout
);
1531 printf_filtered (".\n");
1534 /* x/i should display this line's code. */
1535 set_next_address (gdbarch
, start_pc
);
1537 /* Repeating "info line" should do the following line. */
1538 last_line_listed
= sal
.line
+ 1;
1540 /* If this is the only line, show the source code. If it could
1541 not find the file, don't do anything special. */
1542 if (annotation_level
> 0 && sals
.size () == 1)
1543 annotate_source_line (sal
.symtab
, sal
.line
, 0, start_pc
);
1546 /* Is there any case in which we get here, and have an address
1547 which the user would want to see? If we have debugging symbols
1548 and no line numbers? */
1549 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1550 sal
.line
, symtab_to_filename_for_display (sal
.symtab
));
1554 /* Commands to search the source file for a regexp. */
1556 /* Helper for forward_search_command/reverse_search_command. FORWARD
1557 indicates direction: true for forward, false for
1558 backward/reverse. */
1561 search_command_helper (const char *regex
, int from_tty
, bool forward
)
1563 const char *msg
= re_comp (regex
);
1565 error (("%s"), msg
);
1567 current_source_location
*loc
1568 = get_source_location (current_program_space
);
1569 if (loc
->symtab () == nullptr)
1570 select_source_symtab (0);
1572 scoped_fd
desc (open_source_file (loc
->symtab ()));
1573 if (desc
.get () < 0)
1574 perror_with_name (symtab_to_filename_for_display (loc
->symtab ()));
1577 ? last_line_listed
+ 1
1578 : last_line_listed
- 1);
1580 const std::vector
<off_t
> *offsets
;
1582 || !g_source_cache
.get_line_charpos (loc
->symtab (), &offsets
)
1583 || line
> offsets
->size ())
1584 error (_("Expression not found"));
1586 if (lseek (desc
.get (), (*offsets
)[line
- 1], 0) < 0)
1587 perror_with_name (symtab_to_filename_for_display (loc
->symtab ()));
1589 gdb_file_up stream
= desc
.to_file (FDOPEN_MODE
);
1590 clearerr (stream
.get ());
1592 gdb::def_vector
<char> buf
;
1599 int c
= fgetc (stream
.get ());
1606 while (c
!= '\n' && (c
= fgetc (stream
.get ())) >= 0);
1608 /* Remove the \r, if any, at the end of the line, otherwise
1609 regular expressions that end with $ or \n won't work. */
1610 size_t sz
= buf
.size ();
1611 if (sz
>= 2 && buf
[sz
- 2] == '\r')
1614 buf
.resize (sz
- 1);
1617 /* We now have a source line in buf, null terminate and match. */
1618 buf
.push_back ('\0');
1619 if (re_exec (buf
.data ()) > 0)
1622 print_source_lines (loc
->symtab (), line
, line
+ 1, 0);
1623 set_internalvar_integer (lookup_internalvar ("_"), line
);
1624 loc
->set (loc
->symtab (), std::max (line
- lines_to_list
/ 2, 1));
1635 if (fseek (stream
.get (), (*offsets
)[line
- 1], 0) < 0)
1637 const char *filename
1638 = symtab_to_filename_for_display (loc
->symtab ());
1639 perror_with_name (filename
);
1644 printf_filtered (_("Expression not found\n"));
1648 forward_search_command (const char *regex
, int from_tty
)
1650 search_command_helper (regex
, from_tty
, true);
1654 reverse_search_command (const char *regex
, int from_tty
)
1656 search_command_helper (regex
, from_tty
, false);
1659 /* If the last character of PATH is a directory separator, then strip it. */
1662 strip_trailing_directory_separator (char *path
)
1664 const int last
= strlen (path
) - 1;
1667 return; /* No stripping is needed if PATH is the empty string. */
1669 if (IS_DIR_SEPARATOR (path
[last
]))
1673 /* Return the path substitution rule that matches FROM.
1674 Return NULL if no rule matches. */
1676 static struct substitute_path_rule
*
1677 find_substitute_path_rule (const char *from
)
1679 struct substitute_path_rule
*rule
= substitute_path_rules
;
1681 while (rule
!= NULL
)
1683 if (FILENAME_CMP (rule
->from
, from
) == 0)
1691 /* Add a new substitute-path rule at the end of the current list of rules.
1692 The new rule will replace FROM into TO. */
1695 add_substitute_path_rule (char *from
, char *to
)
1697 struct substitute_path_rule
*rule
;
1698 struct substitute_path_rule
*new_rule
= XNEW (struct substitute_path_rule
);
1700 new_rule
->from
= xstrdup (from
);
1701 new_rule
->to
= xstrdup (to
);
1702 new_rule
->next
= NULL
;
1704 /* If the list of rules are empty, then insert the new rule
1705 at the head of the list. */
1707 if (substitute_path_rules
== NULL
)
1709 substitute_path_rules
= new_rule
;
1713 /* Otherwise, skip to the last rule in our list and then append
1716 rule
= substitute_path_rules
;
1717 while (rule
->next
!= NULL
)
1720 rule
->next
= new_rule
;
1723 /* Remove the given source path substitution rule from the current list
1724 of rules. The memory allocated for that rule is also deallocated. */
1727 delete_substitute_path_rule (struct substitute_path_rule
*rule
)
1729 if (rule
== substitute_path_rules
)
1730 substitute_path_rules
= rule
->next
;
1733 struct substitute_path_rule
*prev
= substitute_path_rules
;
1735 while (prev
!= NULL
&& prev
->next
!= rule
)
1738 gdb_assert (prev
!= NULL
);
1740 prev
->next
= rule
->next
;
1748 /* Implement the "show substitute-path" command. */
1751 show_substitute_path_command (const char *args
, int from_tty
)
1753 struct substitute_path_rule
*rule
= substitute_path_rules
;
1756 gdb_argv
argv (args
);
1758 /* We expect zero or one argument. */
1760 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1761 error (_("Too many arguments in command"));
1763 if (argv
!= NULL
&& argv
[0] != NULL
)
1766 /* Print the substitution rules. */
1770 (_("Source path substitution rule matching `%s':\n"), from
);
1772 printf_filtered (_("List of all source path substitution rules:\n"));
1774 while (rule
!= NULL
)
1776 if (from
== NULL
|| substitute_path_rule_matches (rule
, from
) != 0)
1777 printf_filtered (" `%s' -> `%s'.\n", rule
->from
, rule
->to
);
1782 /* Implement the "unset substitute-path" command. */
1785 unset_substitute_path_command (const char *args
, int from_tty
)
1787 struct substitute_path_rule
*rule
= substitute_path_rules
;
1788 gdb_argv
argv (args
);
1792 /* This function takes either 0 or 1 argument. */
1794 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1795 error (_("Incorrect usage, too many arguments in command"));
1797 if (argv
!= NULL
&& argv
[0] != NULL
)
1800 /* If the user asked for all the rules to be deleted, ask him
1801 to confirm and give him a chance to abort before the action
1805 && !query (_("Delete all source path substitution rules? ")))
1806 error (_("Canceled"));
1808 /* Delete the rule matching the argument. No argument means that
1809 all rules should be deleted. */
1811 while (rule
!= NULL
)
1813 struct substitute_path_rule
*next
= rule
->next
;
1815 if (from
== NULL
|| FILENAME_CMP (from
, rule
->from
) == 0)
1817 delete_substitute_path_rule (rule
);
1824 /* If the user asked for a specific rule to be deleted but
1825 we could not find it, then report an error. */
1827 if (from
!= NULL
&& !rule_found
)
1828 error (_("No substitution rule defined for `%s'"), from
);
1830 forget_cached_source_info ();
1833 /* Add a new source path substitution rule. */
1836 set_substitute_path_command (const char *args
, int from_tty
)
1838 struct substitute_path_rule
*rule
;
1840 gdb_argv
argv (args
);
1842 if (argv
== NULL
|| argv
[0] == NULL
|| argv
[1] == NULL
)
1843 error (_("Incorrect usage, too few arguments in command"));
1845 if (argv
[2] != NULL
)
1846 error (_("Incorrect usage, too many arguments in command"));
1848 if (*(argv
[0]) == '\0')
1849 error (_("First argument must be at least one character long"));
1851 /* Strip any trailing directory separator character in either FROM
1852 or TO. The substitution rule already implicitly contains them. */
1853 strip_trailing_directory_separator (argv
[0]);
1854 strip_trailing_directory_separator (argv
[1]);
1856 /* If a rule with the same "from" was previously defined, then
1857 delete it. This new rule replaces it. */
1859 rule
= find_substitute_path_rule (argv
[0]);
1861 delete_substitute_path_rule (rule
);
1863 /* Insert the new substitution rule. */
1865 add_substitute_path_rule (argv
[0], argv
[1]);
1866 forget_cached_source_info ();
1871 source_lines_range::source_lines_range (int startline
,
1872 source_lines_range::direction dir
)
1874 if (dir
== source_lines_range::FORWARD
)
1876 LONGEST end
= static_cast <LONGEST
> (startline
) + get_lines_to_list ();
1881 m_startline
= startline
;
1882 m_stopline
= static_cast <int> (end
);
1886 LONGEST start
= static_cast <LONGEST
> (startline
) - get_lines_to_list ();
1891 m_startline
= static_cast <int> (start
);
1892 m_stopline
= startline
;
1897 void _initialize_source ();
1899 _initialize_source ()
1901 struct cmd_list_element
*c
;
1903 init_source_path ();
1905 /* The intention is to use POSIX Basic Regular Expressions.
1906 Always use the GNU regex routine for consistency across all hosts.
1907 Our current GNU regex.c does not have all the POSIX features, so this is
1908 just an approximation. */
1909 re_set_syntax (RE_SYNTAX_GREP
);
1911 c
= add_cmd ("directory", class_files
, directory_command
, _("\
1912 Add directory DIR to beginning of search path for source files.\n\
1913 Forget cached info on source file locations and line positions.\n\
1914 DIR can also be $cwd for the current working directory, or $cdir for the\n\
1915 directory in which the source file was compiled into object code.\n\
1916 With no argument, reset the search path to $cdir:$cwd, the default."),
1920 add_com_alias ("use", "directory", class_files
, 0);
1922 set_cmd_completer (c
, filename_completer
);
1924 add_setshow_optional_filename_cmd ("directories",
1928 Set the search path for finding source files."),
1930 Show the search path for finding source files."),
1932 $cwd in the path means the current working directory.\n\
1933 $cdir in the path means the compilation directory of the source file.\n\
1934 GDB ensures the search path always ends with $cdir:$cwd by\n\
1935 appending these directories if necessary.\n\
1936 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
1937 set_directories_command
,
1938 show_directories_command
,
1939 &setlist
, &showlist
);
1941 add_info ("source", info_source_command
,
1942 _("Information about the current source file."));
1944 add_info ("line", info_line_command
, _("\
1945 Core addresses of the code for a source line.\n\
1946 Line can be specified as\n\
1947 LINENUM, to list around that line in current file,\n\
1948 FILE:LINENUM, to list around that line in that file,\n\
1949 FUNCTION, to list around beginning of that function,\n\
1950 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1951 Default is to describe the last source line that was listed.\n\n\
1952 This sets the default address for \"x\" to the line's first instruction\n\
1953 so that \"x/i\" suffices to start examining the machine code.\n\
1954 The address is also stored as the value of \"$_\"."));
1956 add_com ("forward-search", class_files
, forward_search_command
, _("\
1957 Search for regular expression (see regex(3)) from last line listed.\n\
1958 The matching line number is also stored as the value of \"$_\"."));
1959 add_com_alias ("search", "forward-search", class_files
, 0);
1960 add_com_alias ("fo", "forward-search", class_files
, 1);
1962 add_com ("reverse-search", class_files
, reverse_search_command
, _("\
1963 Search backward for regular expression (see regex(3)) from last line listed.\n\
1964 The matching line number is also stored as the value of \"$_\"."));
1965 add_com_alias ("rev", "reverse-search", class_files
, 1);
1967 add_setshow_integer_cmd ("listsize", class_support
, &lines_to_list
, _("\
1968 Set number of source lines gdb will list by default."), _("\
1969 Show number of source lines gdb will list by default."), _("\
1970 Use this to choose how many source lines the \"list\" displays (unless\n\
1971 the \"list\" argument explicitly specifies some other number).\n\
1972 A value of \"unlimited\", or zero, means there's no limit."),
1975 &setlist
, &showlist
);
1977 add_cmd ("substitute-path", class_files
, set_substitute_path_command
,
1979 Add a substitution rule to rewrite the source directories.\n\
1980 Usage: set substitute-path FROM TO\n\
1981 The rule is applied only if the directory name starts with FROM\n\
1982 directly followed by a directory separator.\n\
1983 If a substitution rule was previously set for FROM, the old rule\n\
1984 is replaced by the new one."),
1987 add_cmd ("substitute-path", class_files
, unset_substitute_path_command
,
1989 Delete one or all substitution rules rewriting the source directories.\n\
1990 Usage: unset substitute-path [FROM]\n\
1991 Delete the rule for substituting FROM in source directories. If FROM\n\
1992 is not specified, all substituting rules are deleted.\n\
1993 If the debugger cannot find a rule for FROM, it will display a warning."),
1996 add_cmd ("substitute-path", class_files
, show_substitute_path_command
,
1998 Show one or all substitution rules rewriting the source directories.\n\
1999 Usage: show substitute-path [FROM]\n\
2000 Print the rule for substituting FROM in source directories. If FROM\n\
2001 is not specified, print all substitution rules."),
2004 add_setshow_enum_cmd ("filename-display", class_files
,
2005 filename_display_kind_names
,
2006 &filename_display_string
, _("\
2007 Set how to display filenames."), _("\
2008 Show how to display filenames."), _("\
2009 filename-display can be:\n\
2010 basename - display only basename of a filename\n\
2011 relative - display a filename relative to the compilation directory\n\
2012 absolute - display an absolute filename\n\
2013 By default, relative filenames are displayed."),
2015 show_filename_display_string
,
2016 &setlist
, &showlist
);