1 /* List lines of source files for GDB, the GNU debugger.
2 Copyright (C) 1986-2021 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 if (sal
.symtab
== NULL
)
310 /* We couldn't find the location of `main', possibly due to missing
311 line number info, fall back to line 1 in the corresponding file. */
312 loc
->set (symbol_symtab (bsym
.symbol
), 1);
314 loc
->set (sal
.symtab
, std::max (sal
.line
- (lines_to_list
- 1), 1));
318 /* Alright; find the last file in the symtab list (ignoring .h's
319 and namespace symtabs). */
321 struct symtab
*new_symtab
= nullptr;
323 for (objfile
*ofp
: current_program_space
->objfiles ())
325 for (compunit_symtab
*cu
: ofp
->compunits ())
327 for (symtab
*symtab
: compunit_filetabs (cu
))
329 const char *name
= symtab
->filename
;
330 int len
= strlen (name
);
332 if (!(len
> 2 && (strcmp (&name
[len
- 2], ".h") == 0
333 || strcmp (name
, "<<C++-namespaces>>") == 0)))
339 loc
->set (new_symtab
, 1);
340 if (new_symtab
!= nullptr)
343 for (objfile
*objfile
: current_program_space
->objfiles ())
346 s
= objfile
->sf
->qf
->find_last_source_symtab (objfile
);
350 if (new_symtab
!= nullptr)
352 loc
->set (new_symtab
,1);
356 error (_("Can't find a default source file"));
359 /* Handler for "set directories path-list" command.
360 "set dir mumble" doesn't prepend paths, it resets the entire
361 path list. The theory is that set(show(dir)) should be a no-op. */
364 set_directories_command (const char *args
,
365 int from_tty
, struct cmd_list_element
*c
)
367 /* This is the value that was set.
368 It needs to be processed to maintain $cdir:$cwd and remove dups. */
369 char *set_path
= source_path
;
371 /* We preserve the invariant that $cdir:$cwd begins life at the end of
372 the list by calling init_source_path. If they appear earlier in
373 SET_PATH then mod_path will move them appropriately.
374 mod_path will also remove duplicates. */
376 if (*set_path
!= '\0')
377 mod_path (set_path
, &source_path
);
382 /* Print the list of source directories.
383 This is used by the "ld" command, so it has the signature of a command
387 show_directories_1 (char *ignore
, int from_tty
)
389 puts_filtered ("Source directories searched: ");
390 puts_filtered (source_path
);
391 puts_filtered ("\n");
394 /* Handler for "show directories" command. */
397 show_directories_command (struct ui_file
*file
, int from_tty
,
398 struct cmd_list_element
*c
, const char *value
)
400 show_directories_1 (NULL
, from_tty
);
406 forget_cached_source_info_for_objfile (struct objfile
*objfile
)
408 for (compunit_symtab
*cu
: objfile
->compunits ())
410 for (symtab
*s
: compunit_filetabs (cu
))
412 if (s
->fullname
!= NULL
)
421 objfile
->sf
->qf
->forget_cached_source_info (objfile
);
427 forget_cached_source_info (void)
429 for (struct program_space
*pspace
: program_spaces
)
430 for (objfile
*objfile
: pspace
->objfiles ())
432 forget_cached_source_info_for_objfile (objfile
);
435 g_source_cache
.clear ();
436 last_source_visited
= NULL
;
440 init_source_path (void)
444 xsnprintf (buf
, sizeof (buf
), "$cdir%c$cwd", DIRNAME_SEPARATOR
);
445 source_path
= xstrdup (buf
);
446 forget_cached_source_info ();
449 /* Add zero or more directories to the front of the source path. */
452 directory_command (const char *dirname
, int from_tty
)
454 bool value_changed
= false;
456 /* FIXME, this goes to "delete dir"... */
459 if (!from_tty
|| query (_("Reinitialize source path to empty? ")))
463 value_changed
= true;
468 mod_path (dirname
, &source_path
);
469 forget_cached_source_info ();
470 value_changed
= true;
474 gdb::observers::command_param_changed
.notify ("directories", source_path
);
476 show_directories_1 ((char *) 0, from_tty
);
480 /* Add a path given with the -d command line switch.
481 This will not be quoted so we must not treat spaces as separators. */
484 directory_switch (const char *dirname
, int from_tty
)
486 add_path (dirname
, &source_path
, 0);
489 /* Add zero or more directories to the front of an arbitrary path. */
492 mod_path (const char *dirname
, char **which_path
)
494 add_path (dirname
, which_path
, 1);
497 /* Workhorse of mod_path. Takes an extra argument to determine
498 if dirname should be parsed for separators that indicate multiple
499 directories. This allows for interfaces that pre-parse the dirname
500 and allow specification of traditional separator characters such
504 add_path (const char *dirname
, char **which_path
, int parse_separators
)
506 char *old
= *which_path
;
508 std::vector
<gdb::unique_xmalloc_ptr
<char>> dir_vec
;
513 if (parse_separators
)
515 /* This will properly parse the space and tab separators
516 and any quotes that may exist. */
517 gdb_argv
argv (dirname
);
519 for (char *arg
: argv
)
520 dirnames_to_char_ptr_vec_append (&dir_vec
, arg
);
523 dir_vec
.emplace_back (xstrdup (dirname
));
525 for (const gdb::unique_xmalloc_ptr
<char> &name_up
: dir_vec
)
527 char *name
= name_up
.get ();
530 gdb::unique_xmalloc_ptr
<char> new_name_holder
;
532 /* Spaces and tabs will have been removed by buildargv().
533 NAME is the start of the directory.
534 P is the '\0' following the end. */
535 p
= name
+ strlen (name
);
537 while (!(IS_DIR_SEPARATOR (*name
) && p
<= name
+ 1) /* "/" */
538 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
539 /* On MS-DOS and MS-Windows, h:\ is different from h: */
540 && !(p
== name
+ 3 && name
[1] == ':') /* "d:/" */
542 && IS_DIR_SEPARATOR (p
[-1]))
543 /* Sigh. "foo/" => "foo" */
547 while (p
> name
&& p
[-1] == '.')
551 /* "." => getwd (). */
552 name
= current_directory
;
555 else if (p
> name
+ 1 && IS_DIR_SEPARATOR (p
[-2]))
565 /* "...foo/." => "...foo". */
578 new_name_holder
.reset (tilde_expand (name
));
579 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
580 else if (IS_ABSOLUTE_PATH (name
) && p
== name
+ 2) /* "d:" => "d:." */
581 new_name_holder
.reset (concat (name
, ".", (char *) NULL
));
583 else if (!IS_ABSOLUTE_PATH (name
) && name
[0] != '$')
584 new_name_holder
= gdb_abspath (name
);
586 new_name_holder
.reset (savestring (name
, p
- name
));
587 name
= new_name_holder
.get ();
589 /* Unless it's a variable, check existence. */
592 /* These are warnings, not errors, since we don't want a
593 non-existent directory in a .gdbinit file to stop processing
594 of the .gdbinit file.
596 Whether they get added to the path is more debatable. Current
597 answer is yes, in case the user wants to go make the directory
598 or whatever. If the directory continues to not exist/not be
599 a directory/etc, then having them in the path should be
601 if (stat (name
, &st
) < 0)
603 int save_errno
= errno
;
605 fprintf_unfiltered (gdb_stderr
, "Warning: ");
606 print_sys_errmsg (name
, save_errno
);
608 else if ((st
.st_mode
& S_IFMT
) != S_IFDIR
)
609 warning (_("%s is not a directory."), name
);
614 unsigned int len
= strlen (name
);
620 /* FIXME: we should use realpath() or its work-alike
621 before comparing. Then all the code above which
622 removes excess slashes and dots could simply go away. */
623 if (!filename_ncmp (p
, name
, len
)
624 && (p
[len
] == '\0' || p
[len
] == DIRNAME_SEPARATOR
))
626 /* Found it in the search path, remove old copy. */
629 /* Back over leading separator. */
632 if (prefix
> p
- *which_path
)
634 /* Same dir twice in one cmd. */
637 /* Copy from next '\0' or ':'. */
638 memmove (p
, &p
[len
+ 1], strlen (&p
[len
+ 1]) + 1);
640 p
= strchr (p
, DIRNAME_SEPARATOR
);
647 tinybuf
[0] = DIRNAME_SEPARATOR
;
650 /* If we have already tacked on a name(s) in this command,
651 be sure they stay on the front as we tack on some
659 temp
= concat (old
, tinybuf
, name
, (char *)NULL
);
661 *which_path
= concat (temp
, "", &old
[prefix
], (char *) NULL
);
662 prefix
= strlen (temp
);
667 *which_path
= concat (name
, (old
[0] ? tinybuf
: old
),
669 prefix
= strlen (name
);
681 info_source_command (const char *ignore
, int from_tty
)
683 current_source_location
*loc
684 = get_source_location (current_program_space
);
685 struct symtab
*s
= loc
->symtab ();
686 struct compunit_symtab
*cust
;
690 printf_filtered (_("No current source file.\n"));
694 cust
= SYMTAB_COMPUNIT (s
);
695 printf_filtered (_("Current source file is %s\n"), s
->filename
);
696 if (SYMTAB_DIRNAME (s
) != NULL
)
697 printf_filtered (_("Compilation directory is %s\n"), SYMTAB_DIRNAME (s
));
699 printf_filtered (_("Located in %s\n"), s
->fullname
);
700 const std::vector
<off_t
> *offsets
;
701 if (g_source_cache
.get_line_charpos (s
, &offsets
))
702 printf_filtered (_("Contains %d line%s.\n"), (int) offsets
->size (),
703 offsets
->size () == 1 ? "" : "s");
705 printf_filtered (_("Source language is %s.\n"), language_str (s
->language
));
706 printf_filtered (_("Producer is %s.\n"),
707 COMPUNIT_PRODUCER (cust
) != NULL
708 ? COMPUNIT_PRODUCER (cust
) : _("unknown"));
709 printf_filtered (_("Compiled with %s debugging format.\n"),
710 COMPUNIT_DEBUGFORMAT (cust
));
711 printf_filtered (_("%s preprocessor macro info.\n"),
712 COMPUNIT_MACRO_TABLE (cust
) != NULL
713 ? "Includes" : "Does not include");
717 /* Helper function to remove characters from the start of PATH so that
718 PATH can then be appended to a directory name. We remove leading drive
719 letters (for dos) as well as leading '/' characters and './'
723 prepare_path_for_appending (const char *path
)
725 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
726 if (HAS_DRIVE_SPEC (path
))
727 path
= STRIP_DRIVE_SPEC (path
);
729 const char *old_path
;
734 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
735 while (IS_DIR_SEPARATOR(path
[0]))
739 while (path
[0] == '.' && IS_DIR_SEPARATOR (path
[1]))
742 while (old_path
!= path
);
747 /* Open a file named STRING, searching path PATH (dir names sep by some char)
748 using mode MODE in the calls to open. You cannot use this function to
749 create files (O_CREAT).
751 OPTS specifies the function behaviour in specific cases.
753 If OPF_TRY_CWD_FIRST, try to open ./STRING before searching PATH.
754 (ie pretend the first element of PATH is "."). This also indicates
755 that, unless OPF_SEARCH_IN_PATH is also specified, a slash in STRING
756 disables searching of the path (this is so that "exec-file ./foo" or
757 "symbol-file ./foo" insures that you get that particular version of
758 foo or an error message).
760 If OPTS has OPF_SEARCH_IN_PATH set, absolute names will also be
761 searched in path (we usually want this for source files but not for
764 If FILENAME_OPENED is non-null, set it to a newly allocated string naming
765 the actual file opened (this string will always start with a "/"). We
766 have to take special pains to avoid doubling the "/" between the directory
767 and the file, sigh! Emacs gets confuzzed by this when we print the
770 If OPTS has OPF_RETURN_REALPATH set return FILENAME_OPENED resolved by
771 gdb_realpath. Even without OPF_RETURN_REALPATH this function still returns
772 filename starting with "/". If FILENAME_OPENED is NULL this option has no
775 If a file is found, return the descriptor.
776 Otherwise, return -1, with errno set for the last name we tried to open. */
778 /* >>>> This should only allow files of certain types,
779 >>>> eg executable, non-directory. */
781 openp (const char *path
, openp_flags opts
, const char *string
,
782 int mode
, gdb::unique_xmalloc_ptr
<char> *filename_opened
)
787 /* The errno set for the last name we tried to open (and
790 std::vector
<gdb::unique_xmalloc_ptr
<char>> dir_vec
;
792 /* The open syscall MODE parameter is not specified. */
793 gdb_assert ((mode
& O_CREAT
) == 0);
794 gdb_assert (string
!= NULL
);
796 /* A file with an empty name cannot possibly exist. Report a failure
797 without further checking.
799 This is an optimization which also defends us against buggy
800 implementations of the "stat" function. For instance, we have
801 noticed that a MinGW debugger built on Windows XP 32bits crashes
802 when the debugger is started with an empty argument. */
803 if (string
[0] == '\0')
814 if ((opts
& OPF_TRY_CWD_FIRST
) || IS_ABSOLUTE_PATH (string
))
816 int i
, reg_file_errno
;
818 if (is_regular_file (string
, ®_file_errno
))
820 filename
= (char *) alloca (strlen (string
) + 1);
821 strcpy (filename
, string
);
822 fd
= gdb_open_cloexec (filename
, mode
, 0);
831 last_errno
= reg_file_errno
;
834 if (!(opts
& OPF_SEARCH_IN_PATH
))
835 for (i
= 0; string
[i
]; i
++)
836 if (IS_DIR_SEPARATOR (string
[i
]))
840 /* Remove characters from the start of PATH that we don't need when PATH
841 is appended to a directory name. */
842 string
= prepare_path_for_appending (string
);
844 alloclen
= strlen (path
) + strlen (string
) + 2;
845 filename
= (char *) alloca (alloclen
);
849 dir_vec
= dirnames_to_char_ptr_vec (path
);
851 for (const gdb::unique_xmalloc_ptr
<char> &dir_up
: dir_vec
)
853 char *dir
= dir_up
.get ();
854 size_t len
= strlen (dir
);
857 if (strcmp (dir
, "$cwd") == 0)
859 /* Name is $cwd -- insert current directory name instead. */
862 /* First, realloc the filename buffer if too short. */
863 len
= strlen (current_directory
);
864 newlen
= len
+ strlen (string
) + 2;
865 if (newlen
> alloclen
)
868 filename
= (char *) alloca (alloclen
);
870 strcpy (filename
, current_directory
);
872 else if (strchr(dir
, '~'))
874 /* See whether we need to expand the tilde. */
877 gdb::unique_xmalloc_ptr
<char> tilde_expanded (tilde_expand (dir
));
879 /* First, realloc the filename buffer if too short. */
880 len
= strlen (tilde_expanded
.get ());
881 newlen
= len
+ strlen (string
) + 2;
882 if (newlen
> alloclen
)
885 filename
= (char *) alloca (alloclen
);
887 strcpy (filename
, tilde_expanded
.get ());
891 /* Normal file name in path -- just use it. */
892 strcpy (filename
, dir
);
894 /* Don't search $cdir. It's also a magic path like $cwd, but we
895 don't have enough information to expand it. The user *could*
896 have an actual directory named '$cdir' but handling that would
897 be confusing, it would mean different things in different
898 contexts. If the user really has '$cdir' one can use './$cdir'.
899 We can get $cdir when loading scripts. When loading source files
900 $cdir must have already been expanded to the correct value. */
901 if (strcmp (dir
, "$cdir") == 0)
905 /* Remove trailing slashes. */
906 while (len
> 0 && IS_DIR_SEPARATOR (filename
[len
- 1]))
909 strcat (filename
+ len
, SLASH_STRING
);
910 strcat (filename
, string
);
912 if (is_regular_file (filename
, ®_file_errno
))
914 fd
= gdb_open_cloexec (filename
, mode
, 0);
920 last_errno
= reg_file_errno
;
926 /* If a file was opened, canonicalize its filename. */
928 filename_opened
->reset (NULL
);
929 else if ((opts
& OPF_RETURN_REALPATH
) != 0)
930 *filename_opened
= gdb_realpath (filename
);
932 *filename_opened
= gdb_abspath (filename
);
940 /* This is essentially a convenience, for clients that want the behaviour
941 of openp, using source_path, but that really don't want the file to be
942 opened but want instead just to know what the full pathname is (as
943 qualified against source_path).
945 The current working directory is searched first.
947 If the file was found, this function returns 1, and FULL_PATHNAME is
948 set to the fully-qualified pathname.
950 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
952 source_full_path_of (const char *filename
,
953 gdb::unique_xmalloc_ptr
<char> *full_pathname
)
957 fd
= openp (source_path
,
958 OPF_TRY_CWD_FIRST
| OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
,
959 filename
, O_RDONLY
, full_pathname
);
962 full_pathname
->reset (NULL
);
970 /* Return non-zero if RULE matches PATH, that is if the rule can be
974 substitute_path_rule_matches (const struct substitute_path_rule
*rule
,
977 const int from_len
= strlen (rule
->from
);
978 const int path_len
= strlen (path
);
980 if (path_len
< from_len
)
983 /* The substitution rules are anchored at the start of the path,
984 so the path should start with rule->from. */
986 if (filename_ncmp (path
, rule
->from
, from_len
) != 0)
989 /* Make sure that the region in the path that matches the substitution
990 rule is immediately followed by a directory separator (or the end of
991 string character). */
993 if (path
[from_len
] != '\0' && !IS_DIR_SEPARATOR (path
[from_len
]))
999 /* Find the substitute-path rule that applies to PATH and return it.
1000 Return NULL if no rule applies. */
1002 static struct substitute_path_rule
*
1003 get_substitute_path_rule (const char *path
)
1005 struct substitute_path_rule
*rule
= substitute_path_rules
;
1007 while (rule
!= NULL
&& !substitute_path_rule_matches (rule
, path
))
1013 /* If the user specified a source path substitution rule that applies
1014 to PATH, then apply it and return the new path.
1016 Return NULL if no substitution rule was specified by the user,
1017 or if no rule applied to the given PATH. */
1019 gdb::unique_xmalloc_ptr
<char>
1020 rewrite_source_path (const char *path
)
1022 const struct substitute_path_rule
*rule
= get_substitute_path_rule (path
);
1029 from_len
= strlen (rule
->from
);
1031 /* Compute the rewritten path and return it. */
1034 (char *) xmalloc (strlen (path
) + 1 + strlen (rule
->to
) - from_len
);
1035 strcpy (new_path
, rule
->to
);
1036 strcat (new_path
, path
+ from_len
);
1038 return gdb::unique_xmalloc_ptr
<char> (new_path
);
1044 find_and_open_source (const char *filename
,
1045 const char *dirname
,
1046 gdb::unique_xmalloc_ptr
<char> *fullname
)
1048 char *path
= source_path
;
1052 /* Quick way out if we already know its full name. */
1056 /* The user may have requested that source paths be rewritten
1057 according to substitution rules he provided. If a substitution
1058 rule applies to this path, then apply it. */
1059 gdb::unique_xmalloc_ptr
<char> rewritten_fullname
1060 = rewrite_source_path (fullname
->get ());
1062 if (rewritten_fullname
!= NULL
)
1063 *fullname
= std::move (rewritten_fullname
);
1065 result
= gdb_open_cloexec (fullname
->get (), OPEN_MODE
, 0);
1068 *fullname
= gdb_realpath (fullname
->get ());
1069 return scoped_fd (result
);
1072 /* Didn't work -- free old one, try again. */
1073 fullname
->reset (NULL
);
1076 gdb::unique_xmalloc_ptr
<char> rewritten_dirname
;
1077 if (dirname
!= NULL
)
1079 /* If necessary, rewrite the compilation directory name according
1080 to the source path substitution rules specified by the user. */
1082 rewritten_dirname
= rewrite_source_path (dirname
);
1084 if (rewritten_dirname
!= NULL
)
1085 dirname
= rewritten_dirname
.get ();
1087 /* Replace a path entry of $cdir with the compilation directory
1090 p
= strstr (source_path
, "$cdir");
1091 if (p
&& (p
== path
|| p
[-1] == DIRNAME_SEPARATOR
)
1092 && (p
[cdir_len
] == DIRNAME_SEPARATOR
|| p
[cdir_len
] == '\0'))
1097 alloca (strlen (source_path
) + 1 + strlen (dirname
) + 1);
1098 len
= p
- source_path
;
1099 strncpy (path
, source_path
, len
); /* Before $cdir */
1100 strcpy (path
+ len
, dirname
); /* new stuff */
1101 strcat (path
+ len
, source_path
+ len
+ cdir_len
); /* After
1106 gdb::unique_xmalloc_ptr
<char> rewritten_filename
1107 = rewrite_source_path (filename
);
1109 if (rewritten_filename
!= NULL
)
1110 filename
= rewritten_filename
.get ();
1112 /* Try to locate file using filename. */
1113 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, filename
,
1114 OPEN_MODE
, fullname
);
1115 if (result
< 0 && dirname
!= NULL
)
1117 /* Remove characters from the start of PATH that we don't need when
1118 PATH is appended to a directory name. */
1119 const char *filename_start
= prepare_path_for_appending (filename
);
1121 /* Try to locate file using compilation dir + filename. This is
1122 helpful if part of the compilation directory was removed,
1123 e.g. using gcc's -fdebug-prefix-map, and we have added the missing
1124 prefix to source_path. */
1125 std::string
cdir_filename (dirname
);
1127 /* Remove any trailing directory separators. */
1128 while (IS_DIR_SEPARATOR (cdir_filename
.back ()))
1129 cdir_filename
.pop_back ();
1131 /* Add our own directory separator. */
1132 cdir_filename
.append (SLASH_STRING
);
1133 cdir_filename
.append (filename_start
);
1135 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
,
1136 cdir_filename
.c_str (), OPEN_MODE
, fullname
);
1140 /* Didn't work. Try using just the basename. */
1141 p
= lbasename (filename
);
1143 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, p
,
1144 OPEN_MODE
, fullname
);
1147 return scoped_fd (result
);
1150 /* Open a source file given a symtab S. Returns a file descriptor or
1151 negative number for error.
1153 This function is a convenience function to find_and_open_source. */
1156 open_source_file (struct symtab
*s
)
1159 return scoped_fd (-1);
1161 gdb::unique_xmalloc_ptr
<char> fullname (s
->fullname
);
1163 scoped_fd fd
= find_and_open_source (s
->filename
, SYMTAB_DIRNAME (s
),
1168 if (SYMTAB_COMPUNIT (s
) != nullptr)
1170 const objfile
*ofp
= COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (s
));
1172 std::string srcpath
;
1173 if (IS_ABSOLUTE_PATH (s
->filename
))
1174 srcpath
= s
->filename
;
1175 else if (SYMTAB_DIRNAME (s
) != nullptr)
1177 srcpath
= SYMTAB_DIRNAME (s
);
1178 srcpath
+= SLASH_STRING
;
1179 srcpath
+= s
->filename
;
1182 const struct bfd_build_id
*build_id
= build_id_bfd_get (ofp
->obfd
);
1184 /* Query debuginfod for the source file. */
1185 if (build_id
!= nullptr && !srcpath
.empty ())
1186 fd
= debuginfod_source_query (build_id
->data
,
1193 s
->fullname
= fullname
.release ();
1197 /* Finds the fullname that a symtab represents.
1199 This functions finds the fullname and saves it in s->fullname.
1200 It will also return the value.
1202 If this function fails to find the file that this symtab represents,
1203 the expected fullname is used. Therefore the files does not have to
1207 symtab_to_fullname (struct symtab
*s
)
1209 /* Use cached copy if we have it.
1210 We rely on forget_cached_source_info being called appropriately
1211 to handle cases like the file being moved. */
1212 if (s
->fullname
== NULL
)
1214 scoped_fd fd
= open_source_file (s
);
1218 gdb::unique_xmalloc_ptr
<char> fullname
;
1220 /* rewrite_source_path would be applied by find_and_open_source, we
1221 should report the pathname where GDB tried to find the file. */
1223 if (SYMTAB_DIRNAME (s
) == NULL
|| IS_ABSOLUTE_PATH (s
->filename
))
1224 fullname
.reset (xstrdup (s
->filename
));
1226 fullname
.reset (concat (SYMTAB_DIRNAME (s
), SLASH_STRING
,
1227 s
->filename
, (char *) NULL
));
1229 s
->fullname
= rewrite_source_path (fullname
.get ()).release ();
1230 if (s
->fullname
== NULL
)
1231 s
->fullname
= fullname
.release ();
1238 /* See commentary in source.h. */
1241 symtab_to_filename_for_display (struct symtab
*symtab
)
1243 if (filename_display_string
== filename_display_basename
)
1244 return lbasename (symtab
->filename
);
1245 else if (filename_display_string
== filename_display_absolute
)
1246 return symtab_to_fullname (symtab
);
1247 else if (filename_display_string
== filename_display_relative
)
1248 return symtab
->filename
;
1250 internal_error (__FILE__
, __LINE__
, _("invalid filename_display_string"));
1255 /* Print source lines from the file of symtab S,
1256 starting with line number LINE and stopping before line number STOPLINE. */
1259 print_source_lines_base (struct symtab
*s
, int line
, int stopline
,
1260 print_source_lines_flags flags
)
1262 bool noprint
= false;
1263 int nlines
= stopline
- line
;
1264 struct ui_out
*uiout
= current_uiout
;
1266 /* Regardless of whether we can open the file, set current_source_symtab. */
1267 current_source_location
*loc
1268 = get_source_location (current_program_space
);
1271 first_line_listed
= line
;
1272 last_line_listed
= line
;
1274 /* If printing of source lines is disabled, just print file and line
1276 if (uiout
->test_flags (ui_source_list
))
1278 /* Only prints "No such file or directory" once. */
1279 if (s
== last_source_visited
)
1281 if (last_source_error
)
1283 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1289 last_source_visited
= s
;
1290 scoped_fd desc
= open_source_file (s
);
1291 last_source_error
= desc
.get () < 0;
1292 if (last_source_error
)
1298 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1304 if (!(flags
& PRINT_SOURCE_LINES_NOERROR
))
1306 const char *filename
= symtab_to_filename_for_display (s
);
1307 int len
= strlen (filename
) + 100;
1308 char *name
= (char *) alloca (len
);
1310 xsnprintf (name
, len
, "%d\t%s", line
, filename
);
1311 print_sys_errmsg (name
, errno
);
1315 uiout
->field_signed ("line", line
);
1316 uiout
->text ("\tin ");
1318 /* CLI expects only the "file" field. TUI expects only the
1319 "fullname" field (and TUI does break if "file" is printed).
1320 MI expects both fields. ui_source_list is set only for CLI,
1322 if (uiout
->is_mi_like_p () || uiout
->test_flags (ui_source_list
))
1323 uiout
->field_string ("file", symtab_to_filename_for_display (s
),
1324 file_name_style
.style ());
1325 if (uiout
->is_mi_like_p () || !uiout
->test_flags (ui_source_list
))
1327 const char *s_fullname
= symtab_to_fullname (s
);
1328 char *local_fullname
;
1330 /* ui_out_field_string may free S_FULLNAME by calling
1331 open_source_file for it again. See e.g.,
1332 tui_field_string->tui_show_source. */
1333 local_fullname
= (char *) alloca (strlen (s_fullname
) + 1);
1334 strcpy (local_fullname
, s_fullname
);
1336 uiout
->field_string ("fullname", local_fullname
);
1345 /* If the user requested a sequence of lines that seems to go backward
1346 (from high to low line numbers) then we don't print anything. */
1347 if (stopline
<= line
)
1351 if (!g_source_cache
.get_source_lines (s
, line
, stopline
- 1, &lines
))
1353 const std::vector
<off_t
> *offsets
= nullptr;
1354 g_source_cache
.get_line_charpos (s
, &offsets
);
1355 error (_("Line number %d out of range; %s has %d lines."),
1356 line
, symtab_to_filename_for_display (s
),
1357 offsets
== nullptr ? 0 : (int) offsets
->size ());
1360 const char *iter
= lines
.c_str ();
1361 int new_lineno
= loc
->line ();
1362 while (nlines
-- > 0 && *iter
!= '\0')
1366 last_line_listed
= loc
->line ();
1367 if (flags
& PRINT_SOURCE_LINES_FILENAME
)
1369 uiout
->text (symtab_to_filename_for_display (s
));
1372 xsnprintf (buf
, sizeof (buf
), "%d\t", new_lineno
++);
1375 while (*iter
!= '\0')
1377 /* Find a run of characters that can be emitted at once.
1378 This is done so that escape sequences are kept
1380 const char *start
= iter
;
1386 if (c
== '\033' && skip_ansi_escape (iter
, &skip_bytes
))
1388 else if (c
>= 0 && c
< 040 && c
!= '\t')
1397 std::string
text (start
, iter
);
1398 uiout
->text (text
.c_str ());
1402 /* Treat either \r or \r\n as a single newline. */
1408 else if (*iter
== '\n')
1413 else if (*iter
> 0 && *iter
< 040)
1415 xsnprintf (buf
, sizeof (buf
), "^%c", *iter
+ 0100);
1419 else if (*iter
== 0177)
1428 loc
->set (loc
->symtab (), new_lineno
);
1435 print_source_lines (struct symtab
*s
, int line
, int stopline
,
1436 print_source_lines_flags flags
)
1438 print_source_lines_base (s
, line
, stopline
, flags
);
1444 print_source_lines (struct symtab
*s
, source_lines_range line_range
,
1445 print_source_lines_flags flags
)
1447 print_source_lines_base (s
, line_range
.startline (),
1448 line_range
.stopline (), flags
);
1453 /* Print info on range of pc's in a specified line. */
1456 info_line_command (const char *arg
, int from_tty
)
1458 CORE_ADDR start_pc
, end_pc
;
1460 std::vector
<symtab_and_line
> decoded_sals
;
1461 symtab_and_line curr_sal
;
1462 gdb::array_view
<symtab_and_line
> sals
;
1466 current_source_location
*loc
1467 = get_source_location (current_program_space
);
1468 curr_sal
.symtab
= loc
->symtab ();
1469 curr_sal
.pspace
= current_program_space
;
1470 if (last_line_listed
!= 0)
1471 curr_sal
.line
= last_line_listed
;
1473 curr_sal
.line
= loc
->line ();
1479 decoded_sals
= decode_line_with_last_displayed (arg
,
1480 DECODE_LINE_LIST_MODE
);
1481 sals
= decoded_sals
;
1486 /* C++ More than one line may have been specified, as when the user
1487 specifies an overloaded function name. Print info on them all. */
1488 for (const auto &sal
: sals
)
1490 if (sal
.pspace
!= current_program_space
)
1493 if (sal
.symtab
== 0)
1495 struct gdbarch
*gdbarch
= get_current_arch ();
1497 printf_filtered (_("No line number information available"));
1500 /* This is useful for "info line *0x7f34". If we can't tell the
1501 user about a source line, at least let them have the symbolic
1503 printf_filtered (" for address ");
1505 print_address (gdbarch
, sal
.pc
, gdb_stdout
);
1508 printf_filtered (".");
1509 printf_filtered ("\n");
1511 else if (sal
.line
> 0
1512 && find_line_pc_range (sal
, &start_pc
, &end_pc
))
1514 struct gdbarch
*gdbarch
= SYMTAB_OBJFILE (sal
.symtab
)->arch ();
1516 if (start_pc
== end_pc
)
1518 printf_filtered ("Line %d of \"%s\"",
1520 symtab_to_filename_for_display (sal
.symtab
));
1522 printf_filtered (" is at address ");
1523 print_address (gdbarch
, start_pc
, gdb_stdout
);
1525 printf_filtered (" but contains no code.\n");
1529 printf_filtered ("Line %d of \"%s\"",
1531 symtab_to_filename_for_display (sal
.symtab
));
1533 printf_filtered (" starts at address ");
1534 print_address (gdbarch
, start_pc
, gdb_stdout
);
1536 printf_filtered (" and ends at ");
1537 print_address (gdbarch
, end_pc
, gdb_stdout
);
1538 printf_filtered (".\n");
1541 /* x/i should display this line's code. */
1542 set_next_address (gdbarch
, start_pc
);
1544 /* Repeating "info line" should do the following line. */
1545 last_line_listed
= sal
.line
+ 1;
1547 /* If this is the only line, show the source code. If it could
1548 not find the file, don't do anything special. */
1549 if (annotation_level
> 0 && sals
.size () == 1)
1550 annotate_source_line (sal
.symtab
, sal
.line
, 0, start_pc
);
1553 /* Is there any case in which we get here, and have an address
1554 which the user would want to see? If we have debugging symbols
1555 and no line numbers? */
1556 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1557 sal
.line
, symtab_to_filename_for_display (sal
.symtab
));
1561 /* Commands to search the source file for a regexp. */
1563 /* Helper for forward_search_command/reverse_search_command. FORWARD
1564 indicates direction: true for forward, false for
1565 backward/reverse. */
1568 search_command_helper (const char *regex
, int from_tty
, bool forward
)
1570 const char *msg
= re_comp (regex
);
1572 error (("%s"), msg
);
1574 current_source_location
*loc
1575 = get_source_location (current_program_space
);
1576 if (loc
->symtab () == nullptr)
1577 select_source_symtab (0);
1579 scoped_fd
desc (open_source_file (loc
->symtab ()));
1580 if (desc
.get () < 0)
1581 perror_with_name (symtab_to_filename_for_display (loc
->symtab ()));
1584 ? last_line_listed
+ 1
1585 : last_line_listed
- 1);
1587 const std::vector
<off_t
> *offsets
;
1589 || !g_source_cache
.get_line_charpos (loc
->symtab (), &offsets
)
1590 || line
> offsets
->size ())
1591 error (_("Expression not found"));
1593 if (lseek (desc
.get (), (*offsets
)[line
- 1], 0) < 0)
1594 perror_with_name (symtab_to_filename_for_display (loc
->symtab ()));
1596 gdb_file_up stream
= desc
.to_file (FDOPEN_MODE
);
1597 clearerr (stream
.get ());
1599 gdb::def_vector
<char> buf
;
1606 int c
= fgetc (stream
.get ());
1613 while (c
!= '\n' && (c
= fgetc (stream
.get ())) >= 0);
1615 /* Remove the \r, if any, at the end of the line, otherwise
1616 regular expressions that end with $ or \n won't work. */
1617 size_t sz
= buf
.size ();
1618 if (sz
>= 2 && buf
[sz
- 2] == '\r')
1621 buf
.resize (sz
- 1);
1624 /* We now have a source line in buf, null terminate and match. */
1625 buf
.push_back ('\0');
1626 if (re_exec (buf
.data ()) > 0)
1629 print_source_lines (loc
->symtab (), line
, line
+ 1, 0);
1630 set_internalvar_integer (lookup_internalvar ("_"), line
);
1631 loc
->set (loc
->symtab (), std::max (line
- lines_to_list
/ 2, 1));
1642 if (fseek (stream
.get (), (*offsets
)[line
- 1], 0) < 0)
1644 const char *filename
1645 = symtab_to_filename_for_display (loc
->symtab ());
1646 perror_with_name (filename
);
1651 printf_filtered (_("Expression not found\n"));
1655 forward_search_command (const char *regex
, int from_tty
)
1657 search_command_helper (regex
, from_tty
, true);
1661 reverse_search_command (const char *regex
, int from_tty
)
1663 search_command_helper (regex
, from_tty
, false);
1666 /* If the last character of PATH is a directory separator, then strip it. */
1669 strip_trailing_directory_separator (char *path
)
1671 const int last
= strlen (path
) - 1;
1674 return; /* No stripping is needed if PATH is the empty string. */
1676 if (IS_DIR_SEPARATOR (path
[last
]))
1680 /* Return the path substitution rule that matches FROM.
1681 Return NULL if no rule matches. */
1683 static struct substitute_path_rule
*
1684 find_substitute_path_rule (const char *from
)
1686 struct substitute_path_rule
*rule
= substitute_path_rules
;
1688 while (rule
!= NULL
)
1690 if (FILENAME_CMP (rule
->from
, from
) == 0)
1698 /* Add a new substitute-path rule at the end of the current list of rules.
1699 The new rule will replace FROM into TO. */
1702 add_substitute_path_rule (char *from
, char *to
)
1704 struct substitute_path_rule
*rule
;
1705 struct substitute_path_rule
*new_rule
= XNEW (struct substitute_path_rule
);
1707 new_rule
->from
= xstrdup (from
);
1708 new_rule
->to
= xstrdup (to
);
1709 new_rule
->next
= NULL
;
1711 /* If the list of rules are empty, then insert the new rule
1712 at the head of the list. */
1714 if (substitute_path_rules
== NULL
)
1716 substitute_path_rules
= new_rule
;
1720 /* Otherwise, skip to the last rule in our list and then append
1723 rule
= substitute_path_rules
;
1724 while (rule
->next
!= NULL
)
1727 rule
->next
= new_rule
;
1730 /* Remove the given source path substitution rule from the current list
1731 of rules. The memory allocated for that rule is also deallocated. */
1734 delete_substitute_path_rule (struct substitute_path_rule
*rule
)
1736 if (rule
== substitute_path_rules
)
1737 substitute_path_rules
= rule
->next
;
1740 struct substitute_path_rule
*prev
= substitute_path_rules
;
1742 while (prev
!= NULL
&& prev
->next
!= rule
)
1745 gdb_assert (prev
!= NULL
);
1747 prev
->next
= rule
->next
;
1755 /* Implement the "show substitute-path" command. */
1758 show_substitute_path_command (const char *args
, int from_tty
)
1760 struct substitute_path_rule
*rule
= substitute_path_rules
;
1763 gdb_argv
argv (args
);
1765 /* We expect zero or one argument. */
1767 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1768 error (_("Too many arguments in command"));
1770 if (argv
!= NULL
&& argv
[0] != NULL
)
1773 /* Print the substitution rules. */
1777 (_("Source path substitution rule matching `%s':\n"), from
);
1779 printf_filtered (_("List of all source path substitution rules:\n"));
1781 while (rule
!= NULL
)
1783 if (from
== NULL
|| substitute_path_rule_matches (rule
, from
) != 0)
1784 printf_filtered (" `%s' -> `%s'.\n", rule
->from
, rule
->to
);
1789 /* Implement the "unset substitute-path" command. */
1792 unset_substitute_path_command (const char *args
, int from_tty
)
1794 struct substitute_path_rule
*rule
= substitute_path_rules
;
1795 gdb_argv
argv (args
);
1799 /* This function takes either 0 or 1 argument. */
1801 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1802 error (_("Incorrect usage, too many arguments in command"));
1804 if (argv
!= NULL
&& argv
[0] != NULL
)
1807 /* If the user asked for all the rules to be deleted, ask him
1808 to confirm and give him a chance to abort before the action
1812 && !query (_("Delete all source path substitution rules? ")))
1813 error (_("Canceled"));
1815 /* Delete the rule matching the argument. No argument means that
1816 all rules should be deleted. */
1818 while (rule
!= NULL
)
1820 struct substitute_path_rule
*next
= rule
->next
;
1822 if (from
== NULL
|| FILENAME_CMP (from
, rule
->from
) == 0)
1824 delete_substitute_path_rule (rule
);
1831 /* If the user asked for a specific rule to be deleted but
1832 we could not find it, then report an error. */
1834 if (from
!= NULL
&& !rule_found
)
1835 error (_("No substitution rule defined for `%s'"), from
);
1837 forget_cached_source_info ();
1840 /* Add a new source path substitution rule. */
1843 set_substitute_path_command (const char *args
, int from_tty
)
1845 struct substitute_path_rule
*rule
;
1847 gdb_argv
argv (args
);
1849 if (argv
== NULL
|| argv
[0] == NULL
|| argv
[1] == NULL
)
1850 error (_("Incorrect usage, too few arguments in command"));
1852 if (argv
[2] != NULL
)
1853 error (_("Incorrect usage, too many arguments in command"));
1855 if (*(argv
[0]) == '\0')
1856 error (_("First argument must be at least one character long"));
1858 /* Strip any trailing directory separator character in either FROM
1859 or TO. The substitution rule already implicitly contains them. */
1860 strip_trailing_directory_separator (argv
[0]);
1861 strip_trailing_directory_separator (argv
[1]);
1863 /* If a rule with the same "from" was previously defined, then
1864 delete it. This new rule replaces it. */
1866 rule
= find_substitute_path_rule (argv
[0]);
1868 delete_substitute_path_rule (rule
);
1870 /* Insert the new substitution rule. */
1872 add_substitute_path_rule (argv
[0], argv
[1]);
1873 forget_cached_source_info ();
1878 source_lines_range::source_lines_range (int startline
,
1879 source_lines_range::direction dir
)
1881 if (dir
== source_lines_range::FORWARD
)
1883 LONGEST end
= static_cast <LONGEST
> (startline
) + get_lines_to_list ();
1888 m_startline
= startline
;
1889 m_stopline
= static_cast <int> (end
);
1893 LONGEST start
= static_cast <LONGEST
> (startline
) - get_lines_to_list ();
1898 m_startline
= static_cast <int> (start
);
1899 m_stopline
= startline
;
1904 void _initialize_source ();
1906 _initialize_source ()
1908 struct cmd_list_element
*c
;
1910 init_source_path ();
1912 /* The intention is to use POSIX Basic Regular Expressions.
1913 Always use the GNU regex routine for consistency across all hosts.
1914 Our current GNU regex.c does not have all the POSIX features, so this is
1915 just an approximation. */
1916 re_set_syntax (RE_SYNTAX_GREP
);
1918 c
= add_cmd ("directory", class_files
, directory_command
, _("\
1919 Add directory DIR to beginning of search path for source files.\n\
1920 Forget cached info on source file locations and line positions.\n\
1921 DIR can also be $cwd for the current working directory, or $cdir for the\n\
1922 directory in which the source file was compiled into object code.\n\
1923 With no argument, reset the search path to $cdir:$cwd, the default."),
1927 add_com_alias ("use", "directory", class_files
, 0);
1929 set_cmd_completer (c
, filename_completer
);
1931 add_setshow_optional_filename_cmd ("directories",
1935 Set the search path for finding source files."),
1937 Show the search path for finding source files."),
1939 $cwd in the path means the current working directory.\n\
1940 $cdir in the path means the compilation directory of the source file.\n\
1941 GDB ensures the search path always ends with $cdir:$cwd by\n\
1942 appending these directories if necessary.\n\
1943 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
1944 set_directories_command
,
1945 show_directories_command
,
1946 &setlist
, &showlist
);
1948 add_info ("source", info_source_command
,
1949 _("Information about the current source file."));
1951 add_info ("line", info_line_command
, _("\
1952 Core addresses of the code for a source line.\n\
1953 Line can be specified as\n\
1954 LINENUM, to list around that line in current file,\n\
1955 FILE:LINENUM, to list around that line in that file,\n\
1956 FUNCTION, to list around beginning of that function,\n\
1957 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1958 Default is to describe the last source line that was listed.\n\n\
1959 This sets the default address for \"x\" to the line's first instruction\n\
1960 so that \"x/i\" suffices to start examining the machine code.\n\
1961 The address is also stored as the value of \"$_\"."));
1963 add_com ("forward-search", class_files
, forward_search_command
, _("\
1964 Search for regular expression (see regex(3)) from last line listed.\n\
1965 The matching line number is also stored as the value of \"$_\"."));
1966 add_com_alias ("search", "forward-search", class_files
, 0);
1967 add_com_alias ("fo", "forward-search", class_files
, 1);
1969 add_com ("reverse-search", class_files
, reverse_search_command
, _("\
1970 Search backward for regular expression (see regex(3)) from last line listed.\n\
1971 The matching line number is also stored as the value of \"$_\"."));
1972 add_com_alias ("rev", "reverse-search", class_files
, 1);
1974 add_setshow_integer_cmd ("listsize", class_support
, &lines_to_list
, _("\
1975 Set number of source lines gdb will list by default."), _("\
1976 Show number of source lines gdb will list by default."), _("\
1977 Use this to choose how many source lines the \"list\" displays (unless\n\
1978 the \"list\" argument explicitly specifies some other number).\n\
1979 A value of \"unlimited\", or zero, means there's no limit."),
1982 &setlist
, &showlist
);
1984 add_cmd ("substitute-path", class_files
, set_substitute_path_command
,
1986 Add a substitution rule to rewrite the source directories.\n\
1987 Usage: set substitute-path FROM TO\n\
1988 The rule is applied only if the directory name starts with FROM\n\
1989 directly followed by a directory separator.\n\
1990 If a substitution rule was previously set for FROM, the old rule\n\
1991 is replaced by the new one."),
1994 add_cmd ("substitute-path", class_files
, unset_substitute_path_command
,
1996 Delete one or all substitution rules rewriting the source directories.\n\
1997 Usage: unset substitute-path [FROM]\n\
1998 Delete the rule for substituting FROM in source directories. If FROM\n\
1999 is not specified, all substituting rules are deleted.\n\
2000 If the debugger cannot find a rule for FROM, it will display a warning."),
2003 add_cmd ("substitute-path", class_files
, show_substitute_path_command
,
2005 Show one or all substitution rules rewriting the source directories.\n\
2006 Usage: show substitute-path [FROM]\n\
2007 Print the rule for substituting FROM in source directories. If FROM\n\
2008 is not specified, print all substitution rules."),
2011 add_setshow_enum_cmd ("filename-display", class_files
,
2012 filename_display_kind_names
,
2013 &filename_display_string
, _("\
2014 Set how to display filenames."), _("\
2015 Show how to display filenames."), _("\
2016 filename-display can be:\n\
2017 basename - display only basename of a filename\n\
2018 relative - display a filename relative to the compilation directory\n\
2019 absolute - display an absolute filename\n\
2020 By default, relative filenames are displayed."),
2022 show_filename_display_string
,
2023 &setlist
, &showlist
);