1 /* List lines of source files for GDB, the GNU debugger.
2 Copyright (C) 1986-2019 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 "common/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/readline.h"
44 #include "common/enum-flags.h"
45 #include "common/scoped_fd.h"
47 #include "common/pathstuff.h"
48 #include "source-cache.h"
50 #define OPEN_MODE (O_RDONLY | O_BINARY)
51 #define FDOPEN_MODE FOPEN_RB
53 /* Path of directories to search for source files.
54 Same format as the PATH environment variable's value. */
58 /* Support for source path substitution commands. */
60 struct substitute_path_rule
64 struct substitute_path_rule
*next
;
67 static struct substitute_path_rule
*substitute_path_rules
= NULL
;
69 /* Symtab of default file for listing lines of. */
71 static struct symtab
*current_source_symtab
;
73 /* Default next line to list. */
75 static int current_source_line
;
77 static struct program_space
*current_source_pspace
;
79 /* Default number of lines to print with commands like "list".
80 This is based on guessing how many long (i.e. more than chars_per_line
81 characters) lines there will be. To be completely correct, "list"
82 and friends should be rewritten to count characters and see where
83 things are wrapping, but that would be a fair amount of work. */
85 static int lines_to_list
= 10;
87 show_lines_to_list (struct ui_file
*file
, int from_tty
,
88 struct cmd_list_element
*c
, const char *value
)
90 fprintf_filtered (file
,
91 _("Number of source lines gdb "
92 "will list by default is %s.\n"),
96 /* Possible values of 'set filename-display'. */
97 static const char filename_display_basename
[] = "basename";
98 static const char filename_display_relative
[] = "relative";
99 static const char filename_display_absolute
[] = "absolute";
101 static const char *const filename_display_kind_names
[] = {
102 filename_display_basename
,
103 filename_display_relative
,
104 filename_display_absolute
,
108 static const char *filename_display_string
= filename_display_relative
;
111 show_filename_display_string (struct ui_file
*file
, int from_tty
,
112 struct cmd_list_element
*c
, const char *value
)
114 fprintf_filtered (file
, _("Filenames are displayed as \"%s\".\n"), value
);
117 /* Line number of last line printed. Default for various commands.
118 current_source_line is usually, but not always, the same as this. */
120 static int last_line_listed
;
122 /* First line number listed by last listing command. If 0, then no
123 source lines have yet been listed since the last time the current
124 source line was changed. */
126 static int first_line_listed
;
128 /* Saves the name of the last source file visited and a possible error code.
129 Used to prevent repeating annoying "No such file or directories" msgs. */
131 static struct symtab
*last_source_visited
= NULL
;
132 static int last_source_error
= 0;
134 /* Return the first line listed by print_source_lines.
135 Used by command interpreters to request listing from
139 get_first_line_listed (void)
141 return first_line_listed
;
144 /* Clear line listed range. This makes the next "list" center the
145 printed source lines around the current source line. */
148 clear_lines_listed_range (void)
150 first_line_listed
= 0;
151 last_line_listed
= 0;
154 /* Return the default number of lines to print with commands like the
155 cli "list". The caller of print_source_lines must use this to
156 calculate the end line and use it in the call to print_source_lines
157 as it does not automatically use this value. */
160 get_lines_to_list (void)
162 return lines_to_list
;
165 /* Return the current source file for listing and next line to list.
166 NOTE: The returned sal pc and end fields are not valid. */
168 struct symtab_and_line
169 get_current_source_symtab_and_line (void)
171 symtab_and_line cursal
;
173 cursal
.pspace
= current_source_pspace
;
174 cursal
.symtab
= current_source_symtab
;
175 cursal
.line
= current_source_line
;
182 /* If the current source file for listing is not set, try and get a default.
183 Usually called before get_current_source_symtab_and_line() is called.
184 It may err out if a default cannot be determined.
185 We must be cautious about where it is called, as it can recurse as the
186 process of determining a new default may call the caller!
187 Use get_current_source_symtab_and_line only to get whatever
188 we have without erroring out or trying to get a default. */
191 set_default_source_symtab_and_line (void)
193 if (!have_full_symbols () && !have_partial_symbols ())
194 error (_("No symbol table is loaded. Use the \"file\" command."));
196 /* Pull in a current source symtab if necessary. */
197 if (current_source_symtab
== 0)
198 select_source_symtab (0);
201 /* Return the current default file for listing and next line to list
202 (the returned sal pc and end fields are not valid.)
203 and set the current default to whatever is in SAL.
204 NOTE: The returned sal pc and end fields are not valid. */
206 struct symtab_and_line
207 set_current_source_symtab_and_line (const symtab_and_line
&sal
)
209 symtab_and_line cursal
;
211 cursal
.pspace
= current_source_pspace
;
212 cursal
.symtab
= current_source_symtab
;
213 cursal
.line
= current_source_line
;
217 current_source_pspace
= sal
.pspace
;
218 current_source_symtab
= sal
.symtab
;
219 current_source_line
= sal
.line
;
221 /* Force the next "list" to center around the current line. */
222 clear_lines_listed_range ();
227 /* Reset any information stored about a default file and line to print. */
230 clear_current_source_symtab_and_line (void)
232 current_source_symtab
= 0;
233 current_source_line
= 0;
239 select_source_symtab (struct symtab
*s
)
243 current_source_symtab
= s
;
244 current_source_line
= 1;
245 current_source_pspace
= SYMTAB_PSPACE (s
);
249 if (current_source_symtab
)
252 /* Make the default place to list be the function `main'
254 if (lookup_symbol (main_name (), 0, VAR_DOMAIN
, 0).symbol
)
256 std::vector
<symtab_and_line
> sals
257 = decode_line_with_current_source (main_name (),
258 DECODE_LINE_FUNFIRSTLINE
);
259 const symtab_and_line
&sal
= sals
[0];
260 current_source_pspace
= sal
.pspace
;
261 current_source_symtab
= sal
.symtab
;
262 current_source_line
= std::max (sal
.line
- (lines_to_list
- 1), 1);
263 if (current_source_symtab
)
267 /* Alright; find the last file in the symtab list (ignoring .h's
268 and namespace symtabs). */
270 current_source_line
= 1;
272 for (objfile
*ofp
: current_program_space
->objfiles ())
274 for (compunit_symtab
*cu
: ofp
->compunits ())
276 for (symtab
*symtab
: compunit_filetabs (cu
))
278 const char *name
= symtab
->filename
;
279 int len
= strlen (name
);
281 if (!(len
> 2 && (strcmp (&name
[len
- 2], ".h") == 0
282 || strcmp (name
, "<<C++-namespaces>>") == 0)))
284 current_source_pspace
= current_program_space
;
285 current_source_symtab
= symtab
;
291 if (current_source_symtab
)
294 for (objfile
*objfile
: current_program_space
->objfiles ())
297 s
= objfile
->sf
->qf
->find_last_source_symtab (objfile
);
299 current_source_symtab
= s
;
301 if (current_source_symtab
)
304 error (_("Can't find a default source file"));
307 /* Handler for "set directories path-list" command.
308 "set dir mumble" doesn't prepend paths, it resets the entire
309 path list. The theory is that set(show(dir)) should be a no-op. */
312 set_directories_command (const char *args
,
313 int from_tty
, struct cmd_list_element
*c
)
315 /* This is the value that was set.
316 It needs to be processed to maintain $cdir:$cwd and remove dups. */
317 char *set_path
= source_path
;
319 /* We preserve the invariant that $cdir:$cwd begins life at the end of
320 the list by calling init_source_path. If they appear earlier in
321 SET_PATH then mod_path will move them appropriately.
322 mod_path will also remove duplicates. */
324 if (*set_path
!= '\0')
325 mod_path (set_path
, &source_path
);
330 /* Print the list of source directories.
331 This is used by the "ld" command, so it has the signature of a command
335 show_directories_1 (char *ignore
, int from_tty
)
337 puts_filtered ("Source directories searched: ");
338 puts_filtered (source_path
);
339 puts_filtered ("\n");
342 /* Handler for "show directories" command. */
345 show_directories_command (struct ui_file
*file
, int from_tty
,
346 struct cmd_list_element
*c
, const char *value
)
348 show_directories_1 (NULL
, from_tty
);
354 forget_cached_source_info_for_objfile (struct objfile
*objfile
)
356 for (compunit_symtab
*cu
: objfile
->compunits ())
358 for (symtab
*s
: compunit_filetabs (cu
))
360 if (s
->line_charpos
!= NULL
)
362 xfree (s
->line_charpos
);
363 s
->line_charpos
= NULL
;
365 if (s
->fullname
!= NULL
)
374 objfile
->sf
->qf
->forget_cached_source_info (objfile
);
380 forget_cached_source_info (void)
382 struct program_space
*pspace
;
385 for (objfile
*objfile
: pspace
->objfiles ())
387 forget_cached_source_info_for_objfile (objfile
);
390 g_source_cache
.clear ();
391 last_source_visited
= NULL
;
395 init_source_path (void)
399 xsnprintf (buf
, sizeof (buf
), "$cdir%c$cwd", DIRNAME_SEPARATOR
);
400 source_path
= xstrdup (buf
);
401 forget_cached_source_info ();
404 /* Add zero or more directories to the front of the source path. */
407 directory_command (const char *dirname
, int from_tty
)
410 /* FIXME, this goes to "delete dir"... */
413 if (!from_tty
|| query (_("Reinitialize source path to empty? ")))
421 mod_path (dirname
, &source_path
);
422 forget_cached_source_info ();
425 show_directories_1 ((char *) 0, from_tty
);
428 /* Add a path given with the -d command line switch.
429 This will not be quoted so we must not treat spaces as separators. */
432 directory_switch (const char *dirname
, int from_tty
)
434 add_path (dirname
, &source_path
, 0);
437 /* Add zero or more directories to the front of an arbitrary path. */
440 mod_path (const char *dirname
, char **which_path
)
442 add_path (dirname
, which_path
, 1);
445 /* Workhorse of mod_path. Takes an extra argument to determine
446 if dirname should be parsed for separators that indicate multiple
447 directories. This allows for interfaces that pre-parse the dirname
448 and allow specification of traditional separator characters such
452 add_path (const char *dirname
, char **which_path
, int parse_separators
)
454 char *old
= *which_path
;
456 std::vector
<gdb::unique_xmalloc_ptr
<char>> dir_vec
;
461 if (parse_separators
)
463 /* This will properly parse the space and tab separators
464 and any quotes that may exist. */
465 gdb_argv
argv (dirname
);
467 for (char *arg
: argv
)
468 dirnames_to_char_ptr_vec_append (&dir_vec
, arg
);
471 dir_vec
.emplace_back (xstrdup (dirname
));
473 for (const gdb::unique_xmalloc_ptr
<char> &name_up
: dir_vec
)
475 char *name
= name_up
.get ();
478 gdb::unique_xmalloc_ptr
<char> new_name_holder
;
480 /* Spaces and tabs will have been removed by buildargv().
481 NAME is the start of the directory.
482 P is the '\0' following the end. */
483 p
= name
+ strlen (name
);
485 while (!(IS_DIR_SEPARATOR (*name
) && p
<= name
+ 1) /* "/" */
486 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
487 /* On MS-DOS and MS-Windows, h:\ is different from h: */
488 && !(p
== name
+ 3 && name
[1] == ':') /* "d:/" */
490 && IS_DIR_SEPARATOR (p
[-1]))
491 /* Sigh. "foo/" => "foo" */
495 while (p
> name
&& p
[-1] == '.')
499 /* "." => getwd (). */
500 name
= current_directory
;
503 else if (p
> name
+ 1 && IS_DIR_SEPARATOR (p
[-2]))
513 /* "...foo/." => "...foo". */
524 new_name_holder
.reset (tilde_expand (name
));
525 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
526 else if (IS_ABSOLUTE_PATH (name
) && p
== name
+ 2) /* "d:" => "d:." */
527 new_name_holder
.reset (concat (name
, ".", (char *) NULL
));
529 else if (!IS_ABSOLUTE_PATH (name
) && name
[0] != '$')
530 new_name_holder
.reset (concat (current_directory
, SLASH_STRING
, name
,
533 new_name_holder
.reset (savestring (name
, p
- name
));
534 name
= new_name_holder
.get ();
536 /* Unless it's a variable, check existence. */
539 /* These are warnings, not errors, since we don't want a
540 non-existent directory in a .gdbinit file to stop processing
541 of the .gdbinit file.
543 Whether they get added to the path is more debatable. Current
544 answer is yes, in case the user wants to go make the directory
545 or whatever. If the directory continues to not exist/not be
546 a directory/etc, then having them in the path should be
548 if (stat (name
, &st
) < 0)
550 int save_errno
= errno
;
552 fprintf_unfiltered (gdb_stderr
, "Warning: ");
553 print_sys_errmsg (name
, save_errno
);
555 else if ((st
.st_mode
& S_IFMT
) != S_IFDIR
)
556 warning (_("%s is not a directory."), name
);
561 unsigned int len
= strlen (name
);
567 /* FIXME: we should use realpath() or its work-alike
568 before comparing. Then all the code above which
569 removes excess slashes and dots could simply go away. */
570 if (!filename_ncmp (p
, name
, len
)
571 && (p
[len
] == '\0' || p
[len
] == DIRNAME_SEPARATOR
))
573 /* Found it in the search path, remove old copy. */
576 /* Back over leading separator. */
579 if (prefix
> p
- *which_path
)
581 /* Same dir twice in one cmd. */
584 /* Copy from next '\0' or ':'. */
585 memmove (p
, &p
[len
+ 1], strlen (&p
[len
+ 1]) + 1);
587 p
= strchr (p
, DIRNAME_SEPARATOR
);
594 tinybuf
[0] = DIRNAME_SEPARATOR
;
597 /* If we have already tacked on a name(s) in this command,
598 be sure they stay on the front as we tack on some
606 temp
= concat (old
, tinybuf
, name
, (char *)NULL
);
608 *which_path
= concat (temp
, "", &old
[prefix
], (char *) NULL
);
609 prefix
= strlen (temp
);
614 *which_path
= concat (name
, (old
[0] ? tinybuf
: old
),
616 prefix
= strlen (name
);
628 info_source_command (const char *ignore
, int from_tty
)
630 struct symtab
*s
= current_source_symtab
;
631 struct compunit_symtab
*cust
;
635 printf_filtered (_("No current source file.\n"));
639 cust
= SYMTAB_COMPUNIT (s
);
640 printf_filtered (_("Current source file is %s\n"), s
->filename
);
641 if (SYMTAB_DIRNAME (s
) != NULL
)
642 printf_filtered (_("Compilation directory is %s\n"), SYMTAB_DIRNAME (s
));
644 printf_filtered (_("Located in %s\n"), s
->fullname
);
646 printf_filtered (_("Contains %d line%s.\n"), s
->nlines
,
647 s
->nlines
== 1 ? "" : "s");
649 printf_filtered (_("Source language is %s.\n"), language_str (s
->language
));
650 printf_filtered (_("Producer is %s.\n"),
651 COMPUNIT_PRODUCER (cust
) != NULL
652 ? COMPUNIT_PRODUCER (cust
) : _("unknown"));
653 printf_filtered (_("Compiled with %s debugging format.\n"),
654 COMPUNIT_DEBUGFORMAT (cust
));
655 printf_filtered (_("%s preprocessor macro info.\n"),
656 COMPUNIT_MACRO_TABLE (cust
) != NULL
657 ? "Includes" : "Does not include");
661 /* Open a file named STRING, searching path PATH (dir names sep by some char)
662 using mode MODE in the calls to open. You cannot use this function to
663 create files (O_CREAT).
665 OPTS specifies the function behaviour in specific cases.
667 If OPF_TRY_CWD_FIRST, try to open ./STRING before searching PATH.
668 (ie pretend the first element of PATH is "."). This also indicates
669 that, unless OPF_SEARCH_IN_PATH is also specified, a slash in STRING
670 disables searching of the path (this is so that "exec-file ./foo" or
671 "symbol-file ./foo" insures that you get that particular version of
672 foo or an error message).
674 If OPTS has OPF_SEARCH_IN_PATH set, absolute names will also be
675 searched in path (we usually want this for source files but not for
678 If FILENAME_OPENED is non-null, set it to a newly allocated string naming
679 the actual file opened (this string will always start with a "/"). We
680 have to take special pains to avoid doubling the "/" between the directory
681 and the file, sigh! Emacs gets confuzzed by this when we print the
684 If OPTS has OPF_RETURN_REALPATH set return FILENAME_OPENED resolved by
685 gdb_realpath. Even without OPF_RETURN_REALPATH this function still returns
686 filename starting with "/". If FILENAME_OPENED is NULL this option has no
689 If a file is found, return the descriptor.
690 Otherwise, return -1, with errno set for the last name we tried to open. */
692 /* >>>> This should only allow files of certain types,
693 >>>> eg executable, non-directory. */
695 openp (const char *path
, openp_flags opts
, const char *string
,
696 int mode
, gdb::unique_xmalloc_ptr
<char> *filename_opened
)
701 /* The errno set for the last name we tried to open (and
704 std::vector
<gdb::unique_xmalloc_ptr
<char>> dir_vec
;
706 /* The open syscall MODE parameter is not specified. */
707 gdb_assert ((mode
& O_CREAT
) == 0);
708 gdb_assert (string
!= NULL
);
710 /* A file with an empty name cannot possibly exist. Report a failure
711 without further checking.
713 This is an optimization which also defends us against buggy
714 implementations of the "stat" function. For instance, we have
715 noticed that a MinGW debugger built on Windows XP 32bits crashes
716 when the debugger is started with an empty argument. */
717 if (string
[0] == '\0')
728 if ((opts
& OPF_TRY_CWD_FIRST
) || IS_ABSOLUTE_PATH (string
))
730 int i
, reg_file_errno
;
732 if (is_regular_file (string
, ®_file_errno
))
734 filename
= (char *) alloca (strlen (string
) + 1);
735 strcpy (filename
, string
);
736 fd
= gdb_open_cloexec (filename
, mode
, 0);
745 last_errno
= reg_file_errno
;
748 if (!(opts
& OPF_SEARCH_IN_PATH
))
749 for (i
= 0; string
[i
]; i
++)
750 if (IS_DIR_SEPARATOR (string
[i
]))
754 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
755 if (HAS_DRIVE_SPEC (string
))
756 string
= STRIP_DRIVE_SPEC (string
);
758 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
759 while (IS_DIR_SEPARATOR(string
[0]))
763 while (string
[0] == '.' && IS_DIR_SEPARATOR (string
[1]))
766 alloclen
= strlen (path
) + strlen (string
) + 2;
767 filename
= (char *) alloca (alloclen
);
771 dir_vec
= dirnames_to_char_ptr_vec (path
);
773 for (const gdb::unique_xmalloc_ptr
<char> &dir_up
: dir_vec
)
775 char *dir
= dir_up
.get ();
776 size_t len
= strlen (dir
);
779 if (strcmp (dir
, "$cwd") == 0)
781 /* Name is $cwd -- insert current directory name instead. */
784 /* First, realloc the filename buffer if too short. */
785 len
= strlen (current_directory
);
786 newlen
= len
+ strlen (string
) + 2;
787 if (newlen
> alloclen
)
790 filename
= (char *) alloca (alloclen
);
792 strcpy (filename
, current_directory
);
794 else if (strchr(dir
, '~'))
796 /* See whether we need to expand the tilde. */
799 gdb::unique_xmalloc_ptr
<char> tilde_expanded (tilde_expand (dir
));
801 /* First, realloc the filename buffer if too short. */
802 len
= strlen (tilde_expanded
.get ());
803 newlen
= len
+ strlen (string
) + 2;
804 if (newlen
> alloclen
)
807 filename
= (char *) alloca (alloclen
);
809 strcpy (filename
, tilde_expanded
.get ());
813 /* Normal file name in path -- just use it. */
814 strcpy (filename
, dir
);
816 /* Don't search $cdir. It's also a magic path like $cwd, but we
817 don't have enough information to expand it. The user *could*
818 have an actual directory named '$cdir' but handling that would
819 be confusing, it would mean different things in different
820 contexts. If the user really has '$cdir' one can use './$cdir'.
821 We can get $cdir when loading scripts. When loading source files
822 $cdir must have already been expanded to the correct value. */
823 if (strcmp (dir
, "$cdir") == 0)
827 /* Remove trailing slashes. */
828 while (len
> 0 && IS_DIR_SEPARATOR (filename
[len
- 1]))
831 strcat (filename
+ len
, SLASH_STRING
);
832 strcat (filename
, string
);
834 if (is_regular_file (filename
, ®_file_errno
))
836 fd
= gdb_open_cloexec (filename
, mode
, 0);
842 last_errno
= reg_file_errno
;
848 /* If a file was opened, canonicalize its filename. */
850 filename_opened
->reset (NULL
);
851 else if ((opts
& OPF_RETURN_REALPATH
) != 0)
852 *filename_opened
= gdb_realpath (filename
);
854 *filename_opened
= gdb_abspath (filename
);
862 /* This is essentially a convenience, for clients that want the behaviour
863 of openp, using source_path, but that really don't want the file to be
864 opened but want instead just to know what the full pathname is (as
865 qualified against source_path).
867 The current working directory is searched first.
869 If the file was found, this function returns 1, and FULL_PATHNAME is
870 set to the fully-qualified pathname.
872 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
874 source_full_path_of (const char *filename
,
875 gdb::unique_xmalloc_ptr
<char> *full_pathname
)
879 fd
= openp (source_path
,
880 OPF_TRY_CWD_FIRST
| OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
,
881 filename
, O_RDONLY
, full_pathname
);
884 full_pathname
->reset (NULL
);
892 /* Return non-zero if RULE matches PATH, that is if the rule can be
896 substitute_path_rule_matches (const struct substitute_path_rule
*rule
,
899 const int from_len
= strlen (rule
->from
);
900 const int path_len
= strlen (path
);
902 if (path_len
< from_len
)
905 /* The substitution rules are anchored at the start of the path,
906 so the path should start with rule->from. */
908 if (filename_ncmp (path
, rule
->from
, from_len
) != 0)
911 /* Make sure that the region in the path that matches the substitution
912 rule is immediately followed by a directory separator (or the end of
913 string character). */
915 if (path
[from_len
] != '\0' && !IS_DIR_SEPARATOR (path
[from_len
]))
921 /* Find the substitute-path rule that applies to PATH and return it.
922 Return NULL if no rule applies. */
924 static struct substitute_path_rule
*
925 get_substitute_path_rule (const char *path
)
927 struct substitute_path_rule
*rule
= substitute_path_rules
;
929 while (rule
!= NULL
&& !substitute_path_rule_matches (rule
, path
))
935 /* If the user specified a source path substitution rule that applies
936 to PATH, then apply it and return the new path.
938 Return NULL if no substitution rule was specified by the user,
939 or if no rule applied to the given PATH. */
941 gdb::unique_xmalloc_ptr
<char>
942 rewrite_source_path (const char *path
)
944 const struct substitute_path_rule
*rule
= get_substitute_path_rule (path
);
951 from_len
= strlen (rule
->from
);
953 /* Compute the rewritten path and return it. */
956 (char *) xmalloc (strlen (path
) + 1 + strlen (rule
->to
) - from_len
);
957 strcpy (new_path
, rule
->to
);
958 strcat (new_path
, path
+ from_len
);
960 return gdb::unique_xmalloc_ptr
<char> (new_path
);
966 find_and_open_source (const char *filename
,
968 gdb::unique_xmalloc_ptr
<char> *fullname
)
970 char *path
= source_path
;
974 /* Quick way out if we already know its full name. */
978 /* The user may have requested that source paths be rewritten
979 according to substitution rules he provided. If a substitution
980 rule applies to this path, then apply it. */
981 gdb::unique_xmalloc_ptr
<char> rewritten_fullname
982 = rewrite_source_path (fullname
->get ());
984 if (rewritten_fullname
!= NULL
)
985 *fullname
= std::move (rewritten_fullname
);
987 result
= gdb_open_cloexec (fullname
->get (), OPEN_MODE
, 0);
990 *fullname
= gdb_realpath (fullname
->get ());
991 return scoped_fd (result
);
994 /* Didn't work -- free old one, try again. */
995 fullname
->reset (NULL
);
998 gdb::unique_xmalloc_ptr
<char> rewritten_dirname
;
1001 /* If necessary, rewrite the compilation directory name according
1002 to the source path substitution rules specified by the user. */
1004 rewritten_dirname
= rewrite_source_path (dirname
);
1006 if (rewritten_dirname
!= NULL
)
1007 dirname
= rewritten_dirname
.get ();
1009 /* Replace a path entry of $cdir with the compilation directory
1012 p
= strstr (source_path
, "$cdir");
1013 if (p
&& (p
== path
|| p
[-1] == DIRNAME_SEPARATOR
)
1014 && (p
[cdir_len
] == DIRNAME_SEPARATOR
|| p
[cdir_len
] == '\0'))
1019 alloca (strlen (source_path
) + 1 + strlen (dirname
) + 1);
1020 len
= p
- source_path
;
1021 strncpy (path
, source_path
, len
); /* Before $cdir */
1022 strcpy (path
+ len
, dirname
); /* new stuff */
1023 strcat (path
+ len
, source_path
+ len
+ cdir_len
); /* After
1028 gdb::unique_xmalloc_ptr
<char> rewritten_filename
;
1029 if (IS_ABSOLUTE_PATH (filename
))
1031 /* If filename is absolute path, try the source path
1032 substitution on it. */
1033 rewritten_filename
= rewrite_source_path (filename
);
1035 if (rewritten_filename
!= NULL
)
1036 filename
= rewritten_filename
.get ();
1039 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, filename
,
1040 OPEN_MODE
, fullname
);
1043 /* Didn't work. Try using just the basename. */
1044 p
= lbasename (filename
);
1046 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, p
,
1047 OPEN_MODE
, fullname
);
1050 return scoped_fd (result
);
1053 /* Open a source file given a symtab S. Returns a file descriptor or
1054 negative number for error.
1056 This function is a convience function to find_and_open_source. */
1059 open_source_file (struct symtab
*s
)
1062 return scoped_fd (-1);
1064 gdb::unique_xmalloc_ptr
<char> fullname (s
->fullname
);
1066 scoped_fd fd
= find_and_open_source (s
->filename
, SYMTAB_DIRNAME (s
),
1068 s
->fullname
= fullname
.release ();
1072 /* Finds the fullname that a symtab represents.
1074 This functions finds the fullname and saves it in s->fullname.
1075 It will also return the value.
1077 If this function fails to find the file that this symtab represents,
1078 the expected fullname is used. Therefore the files does not have to
1082 symtab_to_fullname (struct symtab
*s
)
1084 /* Use cached copy if we have it.
1085 We rely on forget_cached_source_info being called appropriately
1086 to handle cases like the file being moved. */
1087 if (s
->fullname
== NULL
)
1089 scoped_fd fd
= open_source_file (s
);
1093 gdb::unique_xmalloc_ptr
<char> fullname
;
1095 /* rewrite_source_path would be applied by find_and_open_source, we
1096 should report the pathname where GDB tried to find the file. */
1098 if (SYMTAB_DIRNAME (s
) == NULL
|| IS_ABSOLUTE_PATH (s
->filename
))
1099 fullname
.reset (xstrdup (s
->filename
));
1101 fullname
.reset (concat (SYMTAB_DIRNAME (s
), SLASH_STRING
,
1102 s
->filename
, (char *) NULL
));
1104 s
->fullname
= rewrite_source_path (fullname
.get ()).release ();
1105 if (s
->fullname
== NULL
)
1106 s
->fullname
= fullname
.release ();
1113 /* See commentary in source.h. */
1116 symtab_to_filename_for_display (struct symtab
*symtab
)
1118 if (filename_display_string
== filename_display_basename
)
1119 return lbasename (symtab
->filename
);
1120 else if (filename_display_string
== filename_display_absolute
)
1121 return symtab_to_fullname (symtab
);
1122 else if (filename_display_string
== filename_display_relative
)
1123 return symtab
->filename
;
1125 internal_error (__FILE__
, __LINE__
, _("invalid filename_display_string"));
1128 /* Create and initialize the table S->line_charpos that records
1129 the positions of the lines in the source file, which is assumed
1130 to be open on descriptor DESC.
1131 All set S->nlines to the number of such lines. */
1134 find_source_lines (struct symtab
*s
, int desc
)
1139 int lines_allocated
= 1000;
1145 line_charpos
= XNEWVEC (int, lines_allocated
);
1146 if (fstat (desc
, &st
) < 0)
1147 perror_with_name (symtab_to_filename_for_display (s
));
1149 if (SYMTAB_OBJFILE (s
) != NULL
&& SYMTAB_OBJFILE (s
)->obfd
!= NULL
)
1150 mtime
= SYMTAB_OBJFILE (s
)->mtime
;
1152 mtime
= exec_bfd_mtime
;
1154 if (mtime
&& mtime
< st
.st_mtime
)
1155 warning (_("Source file is more recent than executable."));
1158 /* st_size might be a large type, but we only support source files whose
1159 size fits in an int. */
1160 size
= (int) st
.st_size
;
1162 /* Use the heap, not the stack, because this may be pretty large,
1163 and we may run into various kinds of limits on stack size. */
1164 gdb::def_vector
<char> data (size
);
1166 /* Reassign `size' to result of read for systems where \r\n -> \n. */
1167 size
= myread (desc
, data
.data (), size
);
1169 perror_with_name (symtab_to_filename_for_display (s
));
1170 end
= data
.data () + size
;
1172 line_charpos
[0] = 0;
1177 /* A newline at the end does not start a new line. */
1180 if (nlines
== lines_allocated
)
1182 lines_allocated
*= 2;
1184 (int *) xrealloc ((char *) line_charpos
,
1185 sizeof (int) * lines_allocated
);
1187 line_charpos
[nlines
++] = p
- data
.data ();
1194 (int *) xrealloc ((char *) line_charpos
, nlines
* sizeof (int));
1200 /* Get full pathname and line number positions for a symtab.
1201 Set *FULLNAME to actual name of the file as found by `openp',
1202 or to 0 if the file is not found. */
1205 get_filename_and_charpos (struct symtab
*s
, char **fullname
)
1207 scoped_fd desc
= open_source_file (s
);
1208 if (desc
.get () < 0)
1215 *fullname
= s
->fullname
;
1216 if (s
->line_charpos
== 0)
1217 find_source_lines (s
, desc
.get ());
1223 identify_source_line (struct symtab
*s
, int line
, int mid_statement
,
1226 if (s
->line_charpos
== 0)
1227 get_filename_and_charpos (s
, (char **) NULL
);
1228 if (s
->fullname
== 0)
1230 if (line
> s
->nlines
)
1231 /* Don't index off the end of the line_charpos array. */
1233 annotate_source (s
->fullname
, line
, s
->line_charpos
[line
- 1],
1234 mid_statement
, get_objfile_arch (SYMTAB_OBJFILE (s
)), pc
);
1236 current_source_line
= line
;
1237 current_source_symtab
= s
;
1238 clear_lines_listed_range ();
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
)
1252 int nlines
= stopline
- line
;
1253 struct ui_out
*uiout
= current_uiout
;
1255 /* Regardless of whether we can open the file, set current_source_symtab. */
1256 current_source_symtab
= s
;
1257 current_source_line
= line
;
1258 first_line_listed
= line
;
1260 /* If printing of source lines is disabled, just print file and line
1262 if (uiout
->test_flags (ui_source_list
))
1264 /* Only prints "No such file or directory" once. */
1265 if ((s
!= last_source_visited
) || (!last_source_error
))
1267 last_source_visited
= s
;
1268 desc
= open_source_file (s
);
1269 if (desc
.get () < 0)
1271 last_source_error
= desc
.get ();
1277 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1283 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1289 if (!(flags
& PRINT_SOURCE_LINES_NOERROR
))
1291 const char *filename
= symtab_to_filename_for_display (s
);
1292 int len
= strlen (filename
) + 100;
1293 char *name
= (char *) alloca (len
);
1295 xsnprintf (name
, len
, "%d\t%s", line
, filename
);
1296 print_sys_errmsg (name
, errno
);
1300 uiout
->field_int ("line", line
);
1301 uiout
->text ("\tin ");
1303 /* CLI expects only the "file" field. TUI expects only the
1304 "fullname" field (and TUI does break if "file" is printed).
1305 MI expects both fields. ui_source_list is set only for CLI,
1307 if (uiout
->is_mi_like_p () || uiout
->test_flags (ui_source_list
))
1308 uiout
->field_string ("file", symtab_to_filename_for_display (s
),
1309 ui_out_style_kind::FILE);
1310 if (uiout
->is_mi_like_p () || !uiout
->test_flags (ui_source_list
))
1312 const char *s_fullname
= symtab_to_fullname (s
);
1313 char *local_fullname
;
1315 /* ui_out_field_string may free S_FULLNAME by calling
1316 open_source_file for it again. See e.g.,
1317 tui_field_string->tui_show_source. */
1318 local_fullname
= (char *) alloca (strlen (s_fullname
) + 1);
1319 strcpy (local_fullname
, s_fullname
);
1321 uiout
->field_string ("fullname", local_fullname
);
1330 last_source_error
= 0;
1332 /* If the user requested a sequence of lines that seems to go backward
1333 (from high to low line numbers) then we don't print anything. */
1334 if (stopline
<= line
)
1338 if (!g_source_cache
.get_source_lines (s
, line
, stopline
- 1, &lines
))
1339 error (_("Line number %d out of range; %s has %d lines."),
1340 line
, symtab_to_filename_for_display (s
), s
->nlines
);
1342 const char *iter
= lines
.c_str ();
1343 while (nlines
-- > 0 && *iter
!= '\0')
1347 last_line_listed
= current_source_line
;
1348 if (flags
& PRINT_SOURCE_LINES_FILENAME
)
1350 uiout
->text (symtab_to_filename_for_display (s
));
1353 xsnprintf (buf
, sizeof (buf
), "%d\t", current_source_line
++);
1356 while (*iter
!= '\0')
1358 /* Find a run of characters that can be emitted at once.
1359 This is done so that escape sequences are kept
1361 const char *start
= iter
;
1367 if (c
== '\033' && skip_ansi_escape (iter
, &skip_bytes
))
1369 else if (c
>= 0 && c
< 040 && c
!= '\t')
1378 std::string
text (start
, iter
);
1379 uiout
->text (text
.c_str ());
1383 /* Treat either \r or \r\n as a single newline. */
1389 else if (*iter
== '\n')
1394 else if (*iter
> 0 && *iter
< 040)
1396 xsnprintf (buf
, sizeof (buf
), "^%c", *iter
+ 0100);
1400 else if (*iter
== 0177)
1414 print_source_lines (struct symtab
*s
, int line
, int stopline
,
1415 print_source_lines_flags flags
)
1417 print_source_lines_base (s
, line
, stopline
, flags
);
1423 print_source_lines (struct symtab
*s
, source_lines_range line_range
,
1424 print_source_lines_flags flags
)
1426 print_source_lines_base (s
, line_range
.startline (),
1427 line_range
.stopline (), flags
);
1432 /* Print info on range of pc's in a specified line. */
1435 info_line_command (const char *arg
, int from_tty
)
1437 CORE_ADDR start_pc
, end_pc
;
1439 std::vector
<symtab_and_line
> decoded_sals
;
1440 symtab_and_line curr_sal
;
1441 gdb::array_view
<symtab_and_line
> sals
;
1445 curr_sal
.symtab
= current_source_symtab
;
1446 curr_sal
.pspace
= current_program_space
;
1447 if (last_line_listed
!= 0)
1448 curr_sal
.line
= last_line_listed
;
1450 curr_sal
.line
= current_source_line
;
1456 decoded_sals
= decode_line_with_last_displayed (arg
,
1457 DECODE_LINE_LIST_MODE
);
1458 sals
= decoded_sals
;
1463 /* C++ More than one line may have been specified, as when the user
1464 specifies an overloaded function name. Print info on them all. */
1465 for (const auto &sal
: sals
)
1467 if (sal
.pspace
!= current_program_space
)
1470 if (sal
.symtab
== 0)
1472 struct gdbarch
*gdbarch
= get_current_arch ();
1474 printf_filtered (_("No line number information available"));
1477 /* This is useful for "info line *0x7f34". If we can't tell the
1478 user about a source line, at least let them have the symbolic
1480 printf_filtered (" for address ");
1482 print_address (gdbarch
, sal
.pc
, gdb_stdout
);
1485 printf_filtered (".");
1486 printf_filtered ("\n");
1488 else if (sal
.line
> 0
1489 && find_line_pc_range (sal
, &start_pc
, &end_pc
))
1491 struct gdbarch
*gdbarch
1492 = get_objfile_arch (SYMTAB_OBJFILE (sal
.symtab
));
1494 if (start_pc
== end_pc
)
1496 printf_filtered ("Line %d of \"%s\"",
1498 symtab_to_filename_for_display (sal
.symtab
));
1500 printf_filtered (" is at address ");
1501 print_address (gdbarch
, start_pc
, gdb_stdout
);
1503 printf_filtered (" but contains no code.\n");
1507 printf_filtered ("Line %d of \"%s\"",
1509 symtab_to_filename_for_display (sal
.symtab
));
1511 printf_filtered (" starts at address ");
1512 print_address (gdbarch
, start_pc
, gdb_stdout
);
1514 printf_filtered (" and ends at ");
1515 print_address (gdbarch
, end_pc
, gdb_stdout
);
1516 printf_filtered (".\n");
1519 /* x/i should display this line's code. */
1520 set_next_address (gdbarch
, start_pc
);
1522 /* Repeating "info line" should do the following line. */
1523 last_line_listed
= sal
.line
+ 1;
1525 /* If this is the only line, show the source code. If it could
1526 not find the file, don't do anything special. */
1527 if (annotation_level
&& sals
.size () == 1)
1528 identify_source_line (sal
.symtab
, sal
.line
, 0, start_pc
);
1531 /* Is there any case in which we get here, and have an address
1532 which the user would want to see? If we have debugging symbols
1533 and no line numbers? */
1534 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1535 sal
.line
, symtab_to_filename_for_display (sal
.symtab
));
1539 /* Commands to search the source file for a regexp. */
1541 /* Helper for forward_search_command/reverse_search_command. FORWARD
1542 indicates direction: true for forward, false for
1543 backward/reverse. */
1546 search_command_helper (const char *regex
, int from_tty
, bool forward
)
1548 const char *msg
= re_comp (regex
);
1550 error (("%s"), msg
);
1552 if (current_source_symtab
== 0)
1553 select_source_symtab (0);
1555 scoped_fd desc
= open_source_file (current_source_symtab
);
1556 if (desc
.get () < 0)
1557 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1559 if (current_source_symtab
->line_charpos
== 0)
1560 find_source_lines (current_source_symtab
, desc
.get ());
1563 ? last_line_listed
+ 1
1564 : last_line_listed
- 1);
1566 if (line
< 1 || line
> current_source_symtab
->nlines
)
1567 error (_("Expression not found"));
1569 if (lseek (desc
.get (), current_source_symtab
->line_charpos
[line
- 1], 0)
1571 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1573 gdb_file_up stream
= desc
.to_file (FDOPEN_MODE
);
1574 clearerr (stream
.get ());
1576 gdb::def_vector
<char> buf
;
1583 int c
= fgetc (stream
.get ());
1590 while (c
!= '\n' && (c
= fgetc (stream
.get ())) >= 0);
1592 /* Remove the \r, if any, at the end of the line, otherwise
1593 regular expressions that end with $ or \n won't work. */
1594 size_t sz
= buf
.size ();
1595 if (sz
>= 2 && buf
[sz
- 2] == '\r')
1598 buf
.resize (sz
- 1);
1601 /* We now have a source line in buf, null terminate and match. */
1602 buf
.push_back ('\0');
1603 if (re_exec (buf
.data ()) > 0)
1606 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1607 set_internalvar_integer (lookup_internalvar ("_"), line
);
1608 current_source_line
= std::max (line
- lines_to_list
/ 2, 1);
1619 if (fseek (stream
.get (),
1620 current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1622 const char *filename
1623 = symtab_to_filename_for_display (current_source_symtab
);
1624 perror_with_name (filename
);
1629 printf_filtered (_("Expression not found\n"));
1633 forward_search_command (const char *regex
, int from_tty
)
1635 search_command_helper (regex
, from_tty
, true);
1639 reverse_search_command (const char *regex
, int from_tty
)
1641 search_command_helper (regex
, from_tty
, false);
1644 /* If the last character of PATH is a directory separator, then strip it. */
1647 strip_trailing_directory_separator (char *path
)
1649 const int last
= strlen (path
) - 1;
1652 return; /* No stripping is needed if PATH is the empty string. */
1654 if (IS_DIR_SEPARATOR (path
[last
]))
1658 /* Return the path substitution rule that matches FROM.
1659 Return NULL if no rule matches. */
1661 static struct substitute_path_rule
*
1662 find_substitute_path_rule (const char *from
)
1664 struct substitute_path_rule
*rule
= substitute_path_rules
;
1666 while (rule
!= NULL
)
1668 if (FILENAME_CMP (rule
->from
, from
) == 0)
1676 /* Add a new substitute-path rule at the end of the current list of rules.
1677 The new rule will replace FROM into TO. */
1680 add_substitute_path_rule (char *from
, char *to
)
1682 struct substitute_path_rule
*rule
;
1683 struct substitute_path_rule
*new_rule
= XNEW (struct substitute_path_rule
);
1685 new_rule
->from
= xstrdup (from
);
1686 new_rule
->to
= xstrdup (to
);
1687 new_rule
->next
= NULL
;
1689 /* If the list of rules are empty, then insert the new rule
1690 at the head of the list. */
1692 if (substitute_path_rules
== NULL
)
1694 substitute_path_rules
= new_rule
;
1698 /* Otherwise, skip to the last rule in our list and then append
1701 rule
= substitute_path_rules
;
1702 while (rule
->next
!= NULL
)
1705 rule
->next
= new_rule
;
1708 /* Remove the given source path substitution rule from the current list
1709 of rules. The memory allocated for that rule is also deallocated. */
1712 delete_substitute_path_rule (struct substitute_path_rule
*rule
)
1714 if (rule
== substitute_path_rules
)
1715 substitute_path_rules
= rule
->next
;
1718 struct substitute_path_rule
*prev
= substitute_path_rules
;
1720 while (prev
!= NULL
&& prev
->next
!= rule
)
1723 gdb_assert (prev
!= NULL
);
1725 prev
->next
= rule
->next
;
1733 /* Implement the "show substitute-path" command. */
1736 show_substitute_path_command (const char *args
, int from_tty
)
1738 struct substitute_path_rule
*rule
= substitute_path_rules
;
1741 gdb_argv
argv (args
);
1743 /* We expect zero or one argument. */
1745 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1746 error (_("Too many arguments in command"));
1748 if (argv
!= NULL
&& argv
[0] != NULL
)
1751 /* Print the substitution rules. */
1755 (_("Source path substitution rule matching `%s':\n"), from
);
1757 printf_filtered (_("List of all source path substitution rules:\n"));
1759 while (rule
!= NULL
)
1761 if (from
== NULL
|| substitute_path_rule_matches (rule
, from
) != 0)
1762 printf_filtered (" `%s' -> `%s'.\n", rule
->from
, rule
->to
);
1767 /* Implement the "unset substitute-path" command. */
1770 unset_substitute_path_command (const char *args
, int from_tty
)
1772 struct substitute_path_rule
*rule
= substitute_path_rules
;
1773 gdb_argv
argv (args
);
1777 /* This function takes either 0 or 1 argument. */
1779 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1780 error (_("Incorrect usage, too many arguments in command"));
1782 if (argv
!= NULL
&& argv
[0] != NULL
)
1785 /* If the user asked for all the rules to be deleted, ask him
1786 to confirm and give him a chance to abort before the action
1790 && !query (_("Delete all source path substitution rules? ")))
1791 error (_("Canceled"));
1793 /* Delete the rule matching the argument. No argument means that
1794 all rules should be deleted. */
1796 while (rule
!= NULL
)
1798 struct substitute_path_rule
*next
= rule
->next
;
1800 if (from
== NULL
|| FILENAME_CMP (from
, rule
->from
) == 0)
1802 delete_substitute_path_rule (rule
);
1809 /* If the user asked for a specific rule to be deleted but
1810 we could not find it, then report an error. */
1812 if (from
!= NULL
&& !rule_found
)
1813 error (_("No substitution rule defined for `%s'"), from
);
1815 forget_cached_source_info ();
1818 /* Add a new source path substitution rule. */
1821 set_substitute_path_command (const char *args
, int from_tty
)
1823 struct substitute_path_rule
*rule
;
1825 gdb_argv
argv (args
);
1827 if (argv
== NULL
|| argv
[0] == NULL
|| argv
[1] == NULL
)
1828 error (_("Incorrect usage, too few arguments in command"));
1830 if (argv
[2] != NULL
)
1831 error (_("Incorrect usage, too many arguments in command"));
1833 if (*(argv
[0]) == '\0')
1834 error (_("First argument must be at least one character long"));
1836 /* Strip any trailing directory separator character in either FROM
1837 or TO. The substitution rule already implicitly contains them. */
1838 strip_trailing_directory_separator (argv
[0]);
1839 strip_trailing_directory_separator (argv
[1]);
1841 /* If a rule with the same "from" was previously defined, then
1842 delete it. This new rule replaces it. */
1844 rule
= find_substitute_path_rule (argv
[0]);
1846 delete_substitute_path_rule (rule
);
1848 /* Insert the new substitution rule. */
1850 add_substitute_path_rule (argv
[0], argv
[1]);
1851 forget_cached_source_info ();
1856 source_lines_range::source_lines_range (int startline
,
1857 source_lines_range::direction dir
)
1859 if (dir
== source_lines_range::FORWARD
)
1861 LONGEST end
= static_cast <LONGEST
> (startline
) + get_lines_to_list ();
1866 m_startline
= startline
;
1867 m_stopline
= static_cast <int> (end
);
1871 LONGEST start
= static_cast <LONGEST
> (startline
) - get_lines_to_list ();
1876 m_startline
= static_cast <int> (start
);
1877 m_stopline
= startline
;
1883 _initialize_source (void)
1885 struct cmd_list_element
*c
;
1887 current_source_symtab
= 0;
1888 init_source_path ();
1890 /* The intention is to use POSIX Basic Regular Expressions.
1891 Always use the GNU regex routine for consistency across all hosts.
1892 Our current GNU regex.c does not have all the POSIX features, so this is
1893 just an approximation. */
1894 re_set_syntax (RE_SYNTAX_GREP
);
1896 c
= add_cmd ("directory", class_files
, directory_command
, _("\
1897 Add directory DIR to beginning of search path for source files.\n\
1898 Forget cached info on source file locations and line positions.\n\
1899 DIR can also be $cwd for the current working directory, or $cdir for the\n\
1900 directory in which the source file was compiled into object code.\n\
1901 With no argument, reset the search path to $cdir:$cwd, the default."),
1905 add_com_alias ("use", "directory", class_files
, 0);
1907 set_cmd_completer (c
, filename_completer
);
1909 add_setshow_optional_filename_cmd ("directories",
1913 Set the search path for finding source files."),
1915 Show the search path for finding source files."),
1917 $cwd in the path means the current working directory.\n\
1918 $cdir in the path means the compilation directory of the source file.\n\
1919 GDB ensures the search path always ends with $cdir:$cwd by\n\
1920 appending these directories if necessary.\n\
1921 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
1922 set_directories_command
,
1923 show_directories_command
,
1924 &setlist
, &showlist
);
1926 add_info ("source", info_source_command
,
1927 _("Information about the current source file."));
1929 add_info ("line", info_line_command
, _("\
1930 Core addresses of the code for a source line.\n\
1931 Line can be specified as\n\
1932 LINENUM, to list around that line in current file,\n\
1933 FILE:LINENUM, to list around that line in that file,\n\
1934 FUNCTION, to list around beginning of that function,\n\
1935 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1936 Default is to describe the last source line that was listed.\n\n\
1937 This sets the default address for \"x\" to the line's first instruction\n\
1938 so that \"x/i\" suffices to start examining the machine code.\n\
1939 The address is also stored as the value of \"$_\"."));
1941 add_com ("forward-search", class_files
, forward_search_command
, _("\
1942 Search for regular expression (see regex(3)) from last line listed.\n\
1943 The matching line number is also stored as the value of \"$_\"."));
1944 add_com_alias ("search", "forward-search", class_files
, 0);
1945 add_com_alias ("fo", "forward-search", class_files
, 1);
1947 add_com ("reverse-search", class_files
, reverse_search_command
, _("\
1948 Search backward for regular expression (see regex(3)) from last line listed.\n\
1949 The matching line number is also stored as the value of \"$_\"."));
1950 add_com_alias ("rev", "reverse-search", class_files
, 1);
1952 add_setshow_integer_cmd ("listsize", class_support
, &lines_to_list
, _("\
1953 Set number of source lines gdb will list by default."), _("\
1954 Show number of source lines gdb will list by default."), _("\
1955 Use this to choose how many source lines the \"list\" displays (unless\n\
1956 the \"list\" argument explicitly specifies some other number).\n\
1957 A value of \"unlimited\", or zero, means there's no limit."),
1960 &setlist
, &showlist
);
1962 add_cmd ("substitute-path", class_files
, set_substitute_path_command
,
1964 Usage: set substitute-path FROM TO\n\
1965 Add a substitution rule replacing FROM into TO in source file names.\n\
1966 If a substitution rule was previously set for FROM, the old rule\n\
1967 is replaced by the new one."),
1970 add_cmd ("substitute-path", class_files
, unset_substitute_path_command
,
1972 Usage: unset substitute-path [FROM]\n\
1973 Delete the rule for substituting FROM in source file names. If FROM\n\
1974 is not specified, all substituting rules are deleted.\n\
1975 If the debugger cannot find a rule for FROM, it will display a warning."),
1978 add_cmd ("substitute-path", class_files
, show_substitute_path_command
,
1980 Usage: show substitute-path [FROM]\n\
1981 Print the rule for substituting FROM in source file names. If FROM\n\
1982 is not specified, print all substitution rules."),
1985 add_setshow_enum_cmd ("filename-display", class_files
,
1986 filename_display_kind_names
,
1987 &filename_display_string
, _("\
1988 Set how to display filenames."), _("\
1989 Show how to display filenames."), _("\
1990 filename-display can be:\n\
1991 basename - display only basename of a filename\n\
1992 relative - display a filename relative to the compilation directory\n\
1993 absolute - display an absolute filename\n\
1994 By default, relative filenames are displayed."),
1996 show_filename_display_string
,
1997 &setlist
, &showlist
);