1 /* List lines of source files for GDB, the GNU debugger.
2 Copyright (C) 1986-2018 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include "arch-utils.h"
22 #include "expression.h"
29 #include "filestuff.h"
31 #include <sys/types.h>
35 #include "gdb_regex.h"
41 #include "filenames.h" /* for DOSish file names */
42 #include "completer.h"
44 #include "readline/readline.h"
45 #include "common/enum-flags.h"
48 #define OPEN_MODE (O_RDONLY | O_BINARY)
49 #define FDOPEN_MODE FOPEN_RB
51 /* Prototypes for local functions. */
53 static int get_filename_and_charpos (struct symtab
*, char **);
55 /* Path of directories to search for source files.
56 Same format as the PATH environment variable's value. */
60 /* Support for source path substitution commands. */
62 struct substitute_path_rule
66 struct substitute_path_rule
*next
;
69 static struct substitute_path_rule
*substitute_path_rules
= NULL
;
71 /* Symtab of default file for listing lines of. */
73 static struct symtab
*current_source_symtab
;
75 /* Default next line to list. */
77 static int current_source_line
;
79 static struct program_space
*current_source_pspace
;
81 /* Default number of lines to print with commands like "list".
82 This is based on guessing how many long (i.e. more than chars_per_line
83 characters) lines there will be. To be completely correct, "list"
84 and friends should be rewritten to count characters and see where
85 things are wrapping, but that would be a fair amount of work. */
87 static int lines_to_list
= 10;
89 show_lines_to_list (struct ui_file
*file
, int from_tty
,
90 struct cmd_list_element
*c
, const char *value
)
92 fprintf_filtered (file
,
93 _("Number of source lines gdb "
94 "will list by default is %s.\n"),
98 /* Possible values of 'set filename-display'. */
99 static const char filename_display_basename
[] = "basename";
100 static const char filename_display_relative
[] = "relative";
101 static const char filename_display_absolute
[] = "absolute";
103 static const char *const filename_display_kind_names
[] = {
104 filename_display_basename
,
105 filename_display_relative
,
106 filename_display_absolute
,
110 static const char *filename_display_string
= filename_display_relative
;
113 show_filename_display_string (struct ui_file
*file
, int from_tty
,
114 struct cmd_list_element
*c
, const char *value
)
116 fprintf_filtered (file
, _("Filenames are displayed as \"%s\".\n"), value
);
119 /* Line number of last line printed. Default for various commands.
120 current_source_line is usually, but not always, the same as this. */
122 static int last_line_listed
;
124 /* First line number listed by last listing command. If 0, then no
125 source lines have yet been listed since the last time the current
126 source line was changed. */
128 static int first_line_listed
;
130 /* Saves the name of the last source file visited and a possible error code.
131 Used to prevent repeating annoying "No such file or directories" msgs. */
133 static struct symtab
*last_source_visited
= NULL
;
134 static int last_source_error
= 0;
136 /* Return the first line listed by print_source_lines.
137 Used by command interpreters to request listing from
141 get_first_line_listed (void)
143 return first_line_listed
;
146 /* Clear line listed range. This makes the next "list" center the
147 printed source lines around the current source line. */
150 clear_lines_listed_range (void)
152 first_line_listed
= 0;
153 last_line_listed
= 0;
156 /* Return the default number of lines to print with commands like the
157 cli "list". The caller of print_source_lines must use this to
158 calculate the end line and use it in the call to print_source_lines
159 as it does not automatically use this value. */
162 get_lines_to_list (void)
164 return lines_to_list
;
167 /* Return the current source file for listing and next line to list.
168 NOTE: The returned sal pc and end fields are not valid. */
170 struct symtab_and_line
171 get_current_source_symtab_and_line (void)
173 symtab_and_line cursal
;
175 cursal
.pspace
= current_source_pspace
;
176 cursal
.symtab
= current_source_symtab
;
177 cursal
.line
= current_source_line
;
184 /* If the current source file for listing is not set, try and get a default.
185 Usually called before get_current_source_symtab_and_line() is called.
186 It may err out if a default cannot be determined.
187 We must be cautious about where it is called, as it can recurse as the
188 process of determining a new default may call the caller!
189 Use get_current_source_symtab_and_line only to get whatever
190 we have without erroring out or trying to get a default. */
193 set_default_source_symtab_and_line (void)
195 if (!have_full_symbols () && !have_partial_symbols ())
196 error (_("No symbol table is loaded. Use the \"file\" command."));
198 /* Pull in a current source symtab if necessary. */
199 if (current_source_symtab
== 0)
200 select_source_symtab (0);
203 /* Return the current default file for listing and next line to list
204 (the returned sal pc and end fields are not valid.)
205 and set the current default to whatever is in SAL.
206 NOTE: The returned sal pc and end fields are not valid. */
208 struct symtab_and_line
209 set_current_source_symtab_and_line (const symtab_and_line
&sal
)
211 symtab_and_line cursal
;
213 cursal
.pspace
= current_source_pspace
;
214 cursal
.symtab
= current_source_symtab
;
215 cursal
.line
= current_source_line
;
219 current_source_pspace
= sal
.pspace
;
220 current_source_symtab
= sal
.symtab
;
221 current_source_line
= sal
.line
;
223 /* Force the next "list" to center around the current line. */
224 clear_lines_listed_range ();
229 /* Reset any information stored about a default file and line to print. */
232 clear_current_source_symtab_and_line (void)
234 current_source_symtab
= 0;
235 current_source_line
= 0;
238 /* Set the source file default for the "list" command to be S.
240 If S is NULL, and we don't have a default, find one. This
241 should only be called when the user actually tries to use the
242 default, since we produce an error if we can't find a reasonable
243 default. Also, since this can cause symbols to be read, doing it
244 before we need to would make things slower than necessary. */
247 select_source_symtab (struct symtab
*s
)
250 struct compunit_symtab
*cu
;
254 current_source_symtab
= s
;
255 current_source_line
= 1;
256 current_source_pspace
= SYMTAB_PSPACE (s
);
260 if (current_source_symtab
)
263 /* Make the default place to list be the function `main'
265 if (lookup_symbol (main_name (), 0, VAR_DOMAIN
, 0).symbol
)
267 std::vector
<symtab_and_line
> sals
268 = decode_line_with_current_source (main_name (),
269 DECODE_LINE_FUNFIRSTLINE
);
270 const symtab_and_line
&sal
= sals
[0];
271 current_source_pspace
= sal
.pspace
;
272 current_source_symtab
= sal
.symtab
;
273 current_source_line
= std::max (sal
.line
- (lines_to_list
- 1), 1);
274 if (current_source_symtab
)
278 /* Alright; find the last file in the symtab list (ignoring .h's
279 and namespace symtabs). */
281 current_source_line
= 1;
283 ALL_FILETABS (ofp
, cu
, s
)
285 const char *name
= s
->filename
;
286 int len
= strlen (name
);
288 if (!(len
> 2 && (strcmp (&name
[len
- 2], ".h") == 0
289 || strcmp (name
, "<<C++-namespaces>>") == 0)))
291 current_source_pspace
= current_program_space
;
292 current_source_symtab
= s
;
296 if (current_source_symtab
)
302 s
= ofp
->sf
->qf
->find_last_source_symtab (ofp
);
304 current_source_symtab
= s
;
306 if (current_source_symtab
)
309 error (_("Can't find a default source file"));
312 /* Handler for "set directories path-list" command.
313 "set dir mumble" doesn't prepend paths, it resets the entire
314 path list. The theory is that set(show(dir)) should be a no-op. */
317 set_directories_command (const char *args
,
318 int from_tty
, struct cmd_list_element
*c
)
320 /* This is the value that was set.
321 It needs to be processed to maintain $cdir:$cwd and remove dups. */
322 char *set_path
= source_path
;
324 /* We preserve the invariant that $cdir:$cwd begins life at the end of
325 the list by calling init_source_path. If they appear earlier in
326 SET_PATH then mod_path will move them appropriately.
327 mod_path will also remove duplicates. */
329 if (*set_path
!= '\0')
330 mod_path (set_path
, &source_path
);
335 /* Print the list of source directories.
336 This is used by the "ld" command, so it has the signature of a command
340 show_directories_1 (char *ignore
, int from_tty
)
342 puts_filtered ("Source directories searched: ");
343 puts_filtered (source_path
);
344 puts_filtered ("\n");
347 /* Handler for "show directories" command. */
350 show_directories_command (struct ui_file
*file
, int from_tty
,
351 struct cmd_list_element
*c
, const char *value
)
353 show_directories_1 (NULL
, from_tty
);
356 /* Forget line positions and file names for the symtabs in a
357 particular objfile. */
360 forget_cached_source_info_for_objfile (struct objfile
*objfile
)
362 struct compunit_symtab
*cu
;
365 ALL_OBJFILE_FILETABS (objfile
, cu
, s
)
367 if (s
->line_charpos
!= NULL
)
369 xfree (s
->line_charpos
);
370 s
->line_charpos
= NULL
;
372 if (s
->fullname
!= NULL
)
380 objfile
->sf
->qf
->forget_cached_source_info (objfile
);
383 /* Forget what we learned about line positions in source files, and
384 which directories contain them; must check again now since files
385 may be found in a different directory now. */
388 forget_cached_source_info (void)
390 struct program_space
*pspace
;
391 struct objfile
*objfile
;
394 ALL_PSPACE_OBJFILES (pspace
, objfile
)
396 forget_cached_source_info_for_objfile (objfile
);
399 last_source_visited
= NULL
;
403 init_source_path (void)
407 xsnprintf (buf
, sizeof (buf
), "$cdir%c$cwd", DIRNAME_SEPARATOR
);
408 source_path
= xstrdup (buf
);
409 forget_cached_source_info ();
412 /* Add zero or more directories to the front of the source path. */
415 directory_command (const char *dirname
, int from_tty
)
418 /* FIXME, this goes to "delete dir"... */
421 if (!from_tty
|| query (_("Reinitialize source path to empty? ")))
429 mod_path (dirname
, &source_path
);
430 forget_cached_source_info ();
433 show_directories_1 ((char *) 0, from_tty
);
436 /* Add a path given with the -d command line switch.
437 This will not be quoted so we must not treat spaces as separators. */
440 directory_switch (const char *dirname
, int from_tty
)
442 add_path (dirname
, &source_path
, 0);
445 /* Add zero or more directories to the front of an arbitrary path. */
448 mod_path (const char *dirname
, char **which_path
)
450 add_path (dirname
, which_path
, 1);
453 /* Workhorse of mod_path. Takes an extra argument to determine
454 if dirname should be parsed for separators that indicate multiple
455 directories. This allows for interfaces that pre-parse the dirname
456 and allow specification of traditional separator characters such
460 add_path (const char *dirname
, char **which_path
, int parse_separators
)
462 char *old
= *which_path
;
464 VEC (char_ptr
) *dir_vec
= NULL
;
465 struct cleanup
*back_to
;
472 if (parse_separators
)
474 /* This will properly parse the space and tab separators
475 and any quotes that may exist. */
476 gdb_argv
argv (dirname
);
478 for (char *arg
: argv
)
479 dirnames_to_char_ptr_vec_append (&dir_vec
, arg
);
482 VEC_safe_push (char_ptr
, dir_vec
, xstrdup (dirname
));
483 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
485 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, name
); ++ix
)
490 /* Spaces and tabs will have been removed by buildargv().
491 NAME is the start of the directory.
492 P is the '\0' following the end. */
493 p
= name
+ strlen (name
);
495 while (!(IS_DIR_SEPARATOR (*name
) && p
<= name
+ 1) /* "/" */
496 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
497 /* On MS-DOS and MS-Windows, h:\ is different from h: */
498 && !(p
== name
+ 3 && name
[1] == ':') /* "d:/" */
500 && IS_DIR_SEPARATOR (p
[-1]))
501 /* Sigh. "foo/" => "foo" */
505 while (p
> name
&& p
[-1] == '.')
509 /* "." => getwd (). */
510 name
= current_directory
;
513 else if (p
> name
+ 1 && IS_DIR_SEPARATOR (p
[-2]))
523 /* "...foo/." => "...foo". */
534 name
= tilde_expand (name
);
535 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
536 else if (IS_ABSOLUTE_PATH (name
) && p
== name
+ 2) /* "d:" => "d:." */
537 name
= concat (name
, ".", (char *)NULL
);
539 else if (!IS_ABSOLUTE_PATH (name
) && name
[0] != '$')
540 name
= concat (current_directory
, SLASH_STRING
, name
, (char *)NULL
);
542 name
= savestring (name
, p
- name
);
543 make_cleanup (xfree
, name
);
545 /* Unless it's a variable, check existence. */
548 /* These are warnings, not errors, since we don't want a
549 non-existent directory in a .gdbinit file to stop processing
550 of the .gdbinit file.
552 Whether they get added to the path is more debatable. Current
553 answer is yes, in case the user wants to go make the directory
554 or whatever. If the directory continues to not exist/not be
555 a directory/etc, then having them in the path should be
557 if (stat (name
, &st
) < 0)
559 int save_errno
= errno
;
561 fprintf_unfiltered (gdb_stderr
, "Warning: ");
562 print_sys_errmsg (name
, save_errno
);
564 else if ((st
.st_mode
& S_IFMT
) != S_IFDIR
)
565 warning (_("%s is not a directory."), name
);
570 unsigned int len
= strlen (name
);
576 /* FIXME: we should use realpath() or its work-alike
577 before comparing. Then all the code above which
578 removes excess slashes and dots could simply go away. */
579 if (!filename_ncmp (p
, name
, len
)
580 && (p
[len
] == '\0' || p
[len
] == DIRNAME_SEPARATOR
))
582 /* Found it in the search path, remove old copy. */
585 /* Back over leading separator. */
588 if (prefix
> p
- *which_path
)
590 /* Same dir twice in one cmd. */
593 /* Copy from next '\0' or ':'. */
594 memmove (p
, &p
[len
+ 1], strlen (&p
[len
+ 1]) + 1);
596 p
= strchr (p
, DIRNAME_SEPARATOR
);
603 tinybuf
[0] = DIRNAME_SEPARATOR
;
606 /* If we have already tacked on a name(s) in this command,
607 be sure they stay on the front as we tack on some
615 temp
= concat (old
, tinybuf
, name
, (char *)NULL
);
617 *which_path
= concat (temp
, "", &old
[prefix
], (char *) NULL
);
618 prefix
= strlen (temp
);
623 *which_path
= concat (name
, (old
[0] ? tinybuf
: old
),
625 prefix
= strlen (name
);
634 do_cleanups (back_to
);
639 info_source_command (const char *ignore
, int from_tty
)
641 struct symtab
*s
= current_source_symtab
;
642 struct compunit_symtab
*cust
;
646 printf_filtered (_("No current source file.\n"));
650 cust
= SYMTAB_COMPUNIT (s
);
651 printf_filtered (_("Current source file is %s\n"), s
->filename
);
652 if (SYMTAB_DIRNAME (s
) != NULL
)
653 printf_filtered (_("Compilation directory is %s\n"), SYMTAB_DIRNAME (s
));
655 printf_filtered (_("Located in %s\n"), s
->fullname
);
657 printf_filtered (_("Contains %d line%s.\n"), s
->nlines
,
658 s
->nlines
== 1 ? "" : "s");
660 printf_filtered (_("Source language is %s.\n"), language_str (s
->language
));
661 printf_filtered (_("Producer is %s.\n"),
662 COMPUNIT_PRODUCER (cust
) != NULL
663 ? COMPUNIT_PRODUCER (cust
) : _("unknown"));
664 printf_filtered (_("Compiled with %s debugging format.\n"),
665 COMPUNIT_DEBUGFORMAT (cust
));
666 printf_filtered (_("%s preprocessor macro info.\n"),
667 COMPUNIT_MACRO_TABLE (cust
) != NULL
668 ? "Includes" : "Does not include");
672 /* Return True if the file NAME exists and is a regular file.
673 If the result is false then *ERRNO_PTR is set to a useful value assuming
674 we're expecting a regular file. */
677 is_regular_file (const char *name
, int *errno_ptr
)
680 const int status
= stat (name
, &st
);
682 /* Stat should never fail except when the file does not exist.
683 If stat fails, analyze the source of error and return True
684 unless the file does not exist, to avoid returning false results
685 on obscure systems where stat does not work as expected. */
695 if (S_ISREG (st
.st_mode
))
698 if (S_ISDIR (st
.st_mode
))
705 /* Open a file named STRING, searching path PATH (dir names sep by some char)
706 using mode MODE in the calls to open. You cannot use this function to
707 create files (O_CREAT).
709 OPTS specifies the function behaviour in specific cases.
711 If OPF_TRY_CWD_FIRST, try to open ./STRING before searching PATH.
712 (ie pretend the first element of PATH is "."). This also indicates
713 that, unless OPF_SEARCH_IN_PATH is also specified, a slash in STRING
714 disables searching of the path (this is so that "exec-file ./foo" or
715 "symbol-file ./foo" insures that you get that particular version of
716 foo or an error message).
718 If OPTS has OPF_SEARCH_IN_PATH set, absolute names will also be
719 searched in path (we usually want this for source files but not for
722 If FILENAME_OPENED is non-null, set it to a newly allocated string naming
723 the actual file opened (this string will always start with a "/"). We
724 have to take special pains to avoid doubling the "/" between the directory
725 and the file, sigh! Emacs gets confuzzed by this when we print the
728 If OPTS has OPF_RETURN_REALPATH set return FILENAME_OPENED resolved by
729 gdb_realpath. Even without OPF_RETURN_REALPATH this function still returns
730 filename starting with "/". If FILENAME_OPENED is NULL this option has no
733 If a file is found, return the descriptor.
734 Otherwise, return -1, with errno set for the last name we tried to open. */
736 /* >>>> This should only allow files of certain types,
737 >>>> eg executable, non-directory. */
739 openp (const char *path
, int opts
, const char *string
,
740 int mode
, char **filename_opened
)
745 VEC (char_ptr
) *dir_vec
;
746 struct cleanup
*back_to
;
749 /* The errno set for the last name we tried to open (and
753 /* The open syscall MODE parameter is not specified. */
754 gdb_assert ((mode
& O_CREAT
) == 0);
755 gdb_assert (string
!= NULL
);
757 /* A file with an empty name cannot possibly exist. Report a failure
758 without further checking.
760 This is an optimization which also defends us against buggy
761 implementations of the "stat" function. For instance, we have
762 noticed that a MinGW debugger built on Windows XP 32bits crashes
763 when the debugger is started with an empty argument. */
764 if (string
[0] == '\0')
775 if ((opts
& OPF_TRY_CWD_FIRST
) || IS_ABSOLUTE_PATH (string
))
777 int i
, reg_file_errno
;
779 if (is_regular_file (string
, ®_file_errno
))
781 filename
= (char *) alloca (strlen (string
) + 1);
782 strcpy (filename
, string
);
783 fd
= gdb_open_cloexec (filename
, mode
, 0);
792 last_errno
= reg_file_errno
;
795 if (!(opts
& OPF_SEARCH_IN_PATH
))
796 for (i
= 0; string
[i
]; i
++)
797 if (IS_DIR_SEPARATOR (string
[i
]))
801 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
802 if (HAS_DRIVE_SPEC (string
))
803 string
= STRIP_DRIVE_SPEC (string
);
805 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
806 while (IS_DIR_SEPARATOR(string
[0]))
810 while (string
[0] == '.' && IS_DIR_SEPARATOR (string
[1]))
813 alloclen
= strlen (path
) + strlen (string
) + 2;
814 filename
= (char *) alloca (alloclen
);
818 dir_vec
= dirnames_to_char_ptr_vec (path
);
819 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
821 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, dir
); ++ix
)
823 size_t len
= strlen (dir
);
826 if (strcmp (dir
, "$cwd") == 0)
828 /* Name is $cwd -- insert current directory name instead. */
831 /* First, realloc the filename buffer if too short. */
832 len
= strlen (current_directory
);
833 newlen
= len
+ strlen (string
) + 2;
834 if (newlen
> alloclen
)
837 filename
= (char *) alloca (alloclen
);
839 strcpy (filename
, current_directory
);
841 else if (strchr(dir
, '~'))
843 /* See whether we need to expand the tilde. */
846 gdb::unique_xmalloc_ptr
<char> tilde_expanded (tilde_expand (dir
));
848 /* First, realloc the filename buffer if too short. */
849 len
= strlen (tilde_expanded
.get ());
850 newlen
= len
+ strlen (string
) + 2;
851 if (newlen
> alloclen
)
854 filename
= (char *) alloca (alloclen
);
856 strcpy (filename
, tilde_expanded
.get ());
860 /* Normal file name in path -- just use it. */
861 strcpy (filename
, dir
);
863 /* Don't search $cdir. It's also a magic path like $cwd, but we
864 don't have enough information to expand it. The user *could*
865 have an actual directory named '$cdir' but handling that would
866 be confusing, it would mean different things in different
867 contexts. If the user really has '$cdir' one can use './$cdir'.
868 We can get $cdir when loading scripts. When loading source files
869 $cdir must have already been expanded to the correct value. */
870 if (strcmp (dir
, "$cdir") == 0)
874 /* Remove trailing slashes. */
875 while (len
> 0 && IS_DIR_SEPARATOR (filename
[len
- 1]))
878 strcat (filename
+ len
, SLASH_STRING
);
879 strcat (filename
, string
);
881 if (is_regular_file (filename
, ®_file_errno
))
883 fd
= gdb_open_cloexec (filename
, mode
, 0);
889 last_errno
= reg_file_errno
;
892 do_cleanups (back_to
);
897 /* If a file was opened, canonicalize its filename. */
899 *filename_opened
= NULL
;
900 else if ((opts
& OPF_RETURN_REALPATH
) != 0)
901 *filename_opened
= gdb_realpath (filename
).release ();
903 *filename_opened
= gdb_abspath (filename
).release ();
911 /* This is essentially a convenience, for clients that want the behaviour
912 of openp, using source_path, but that really don't want the file to be
913 opened but want instead just to know what the full pathname is (as
914 qualified against source_path).
916 The current working directory is searched first.
918 If the file was found, this function returns 1, and FULL_PATHNAME is
919 set to the fully-qualified pathname.
921 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
923 source_full_path_of (const char *filename
, char **full_pathname
)
927 fd
= openp (source_path
,
928 OPF_TRY_CWD_FIRST
| OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
,
929 filename
, O_RDONLY
, full_pathname
);
932 *full_pathname
= NULL
;
940 /* Return non-zero if RULE matches PATH, that is if the rule can be
944 substitute_path_rule_matches (const struct substitute_path_rule
*rule
,
947 const int from_len
= strlen (rule
->from
);
948 const int path_len
= strlen (path
);
950 if (path_len
< from_len
)
953 /* The substitution rules are anchored at the start of the path,
954 so the path should start with rule->from. */
956 if (filename_ncmp (path
, rule
->from
, from_len
) != 0)
959 /* Make sure that the region in the path that matches the substitution
960 rule is immediately followed by a directory separator (or the end of
961 string character). */
963 if (path
[from_len
] != '\0' && !IS_DIR_SEPARATOR (path
[from_len
]))
969 /* Find the substitute-path rule that applies to PATH and return it.
970 Return NULL if no rule applies. */
972 static struct substitute_path_rule
*
973 get_substitute_path_rule (const char *path
)
975 struct substitute_path_rule
*rule
= substitute_path_rules
;
977 while (rule
!= NULL
&& !substitute_path_rule_matches (rule
, path
))
983 /* If the user specified a source path substitution rule that applies
984 to PATH, then apply it and return the new path.
986 Return NULL if no substitution rule was specified by the user,
987 or if no rule applied to the given PATH. */
989 gdb::unique_xmalloc_ptr
<char>
990 rewrite_source_path (const char *path
)
992 const struct substitute_path_rule
*rule
= get_substitute_path_rule (path
);
999 from_len
= strlen (rule
->from
);
1001 /* Compute the rewritten path and return it. */
1004 (char *) xmalloc (strlen (path
) + 1 + strlen (rule
->to
) - from_len
);
1005 strcpy (new_path
, rule
->to
);
1006 strcat (new_path
, path
+ from_len
);
1008 return gdb::unique_xmalloc_ptr
<char> (new_path
);
1012 find_and_open_source (const char *filename
,
1013 const char *dirname
,
1016 char *path
= source_path
;
1020 /* Quick way out if we already know its full name. */
1024 /* The user may have requested that source paths be rewritten
1025 according to substitution rules he provided. If a substitution
1026 rule applies to this path, then apply it. */
1027 char *rewritten_fullname
= rewrite_source_path (*fullname
).release ();
1029 if (rewritten_fullname
!= NULL
)
1032 *fullname
= rewritten_fullname
;
1035 result
= gdb_open_cloexec (*fullname
, OPEN_MODE
, 0);
1038 char *lpath
= gdb_realpath (*fullname
).release ();
1045 /* Didn't work -- free old one, try again. */
1050 gdb::unique_xmalloc_ptr
<char> rewritten_dirname
;
1051 if (dirname
!= NULL
)
1053 /* If necessary, rewrite the compilation directory name according
1054 to the source path substitution rules specified by the user. */
1056 rewritten_dirname
= rewrite_source_path (dirname
);
1058 if (rewritten_dirname
!= NULL
)
1059 dirname
= rewritten_dirname
.get ();
1061 /* Replace a path entry of $cdir with the compilation directory
1064 /* We cast strstr's result in case an ANSIhole has made it const,
1065 which produces a "required warning" when assigned to a nonconst. */
1066 p
= (char *) strstr (source_path
, "$cdir");
1067 if (p
&& (p
== path
|| p
[-1] == DIRNAME_SEPARATOR
)
1068 && (p
[cdir_len
] == DIRNAME_SEPARATOR
|| p
[cdir_len
] == '\0'))
1073 alloca (strlen (source_path
) + 1 + strlen (dirname
) + 1);
1074 len
= p
- source_path
;
1075 strncpy (path
, source_path
, len
); /* Before $cdir */
1076 strcpy (path
+ len
, dirname
); /* new stuff */
1077 strcat (path
+ len
, source_path
+ len
+ cdir_len
); /* After
1082 gdb::unique_xmalloc_ptr
<char> rewritten_filename
;
1083 if (IS_ABSOLUTE_PATH (filename
))
1085 /* If filename is absolute path, try the source path
1086 substitution on it. */
1087 rewritten_filename
= rewrite_source_path (filename
);
1089 if (rewritten_filename
!= NULL
)
1090 filename
= rewritten_filename
.get ();
1093 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, filename
,
1094 OPEN_MODE
, fullname
);
1097 /* Didn't work. Try using just the basename. */
1098 p
= lbasename (filename
);
1100 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, p
,
1101 OPEN_MODE
, fullname
);
1107 /* Open a source file given a symtab S. Returns a file descriptor or
1108 negative number for error.
1110 This function is a convience function to find_and_open_source. */
1113 open_source_file (struct symtab
*s
)
1118 return find_and_open_source (s
->filename
, SYMTAB_DIRNAME (s
), &s
->fullname
);
1121 /* Finds the fullname that a symtab represents.
1123 This functions finds the fullname and saves it in s->fullname.
1124 It will also return the value.
1126 If this function fails to find the file that this symtab represents,
1127 the expected fullname is used. Therefore the files does not have to
1131 symtab_to_fullname (struct symtab
*s
)
1133 /* Use cached copy if we have it.
1134 We rely on forget_cached_source_info being called appropriately
1135 to handle cases like the file being moved. */
1136 if (s
->fullname
== NULL
)
1138 int fd
= find_and_open_source (s
->filename
, SYMTAB_DIRNAME (s
),
1145 gdb::unique_xmalloc_ptr
<char> fullname
;
1147 /* rewrite_source_path would be applied by find_and_open_source, we
1148 should report the pathname where GDB tried to find the file. */
1150 if (SYMTAB_DIRNAME (s
) == NULL
|| IS_ABSOLUTE_PATH (s
->filename
))
1151 fullname
.reset (xstrdup (s
->filename
));
1153 fullname
.reset (concat (SYMTAB_DIRNAME (s
), SLASH_STRING
,
1154 s
->filename
, (char *) NULL
));
1156 s
->fullname
= rewrite_source_path (fullname
.get ()).release ();
1157 if (s
->fullname
== NULL
)
1158 s
->fullname
= fullname
.release ();
1165 /* See commentary in source.h. */
1168 symtab_to_filename_for_display (struct symtab
*symtab
)
1170 if (filename_display_string
== filename_display_basename
)
1171 return lbasename (symtab
->filename
);
1172 else if (filename_display_string
== filename_display_absolute
)
1173 return symtab_to_fullname (symtab
);
1174 else if (filename_display_string
== filename_display_relative
)
1175 return symtab
->filename
;
1177 internal_error (__FILE__
, __LINE__
, _("invalid filename_display_string"));
1180 /* Create and initialize the table S->line_charpos that records
1181 the positions of the lines in the source file, which is assumed
1182 to be open on descriptor DESC.
1183 All set S->nlines to the number of such lines. */
1186 find_source_lines (struct symtab
*s
, int desc
)
1191 int lines_allocated
= 1000;
1197 line_charpos
= XNEWVEC (int, lines_allocated
);
1198 if (fstat (desc
, &st
) < 0)
1199 perror_with_name (symtab_to_filename_for_display (s
));
1201 if (SYMTAB_OBJFILE (s
) != NULL
&& SYMTAB_OBJFILE (s
)->obfd
!= NULL
)
1202 mtime
= SYMTAB_OBJFILE (s
)->mtime
;
1204 mtime
= exec_bfd_mtime
;
1206 if (mtime
&& mtime
< st
.st_mtime
)
1207 warning (_("Source file is more recent than executable."));
1210 /* st_size might be a large type, but we only support source files whose
1211 size fits in an int. */
1212 size
= (int) st
.st_size
;
1214 /* Use the heap, not the stack, because this may be pretty large,
1215 and we may run into various kinds of limits on stack size. */
1216 gdb::def_vector
<char> data (size
);
1218 /* Reassign `size' to result of read for systems where \r\n -> \n. */
1219 size
= myread (desc
, data
.data (), size
);
1221 perror_with_name (symtab_to_filename_for_display (s
));
1224 line_charpos
[0] = 0;
1229 /* A newline at the end does not start a new line. */
1232 if (nlines
== lines_allocated
)
1234 lines_allocated
*= 2;
1236 (int *) xrealloc ((char *) line_charpos
,
1237 sizeof (int) * lines_allocated
);
1239 line_charpos
[nlines
++] = p
- data
.data ();
1246 (int *) xrealloc ((char *) line_charpos
, nlines
* sizeof (int));
1252 /* Get full pathname and line number positions for a symtab.
1253 Return nonzero if line numbers may have changed.
1254 Set *FULLNAME to actual name of the file as found by `openp',
1255 or to 0 if the file is not found. */
1258 get_filename_and_charpos (struct symtab
*s
, char **fullname
)
1260 int desc
, linenums_changed
= 0;
1261 struct cleanup
*cleanups
;
1263 desc
= open_source_file (s
);
1270 cleanups
= make_cleanup_close (desc
);
1272 *fullname
= s
->fullname
;
1273 if (s
->line_charpos
== 0)
1274 linenums_changed
= 1;
1275 if (linenums_changed
)
1276 find_source_lines (s
, desc
);
1277 do_cleanups (cleanups
);
1278 return linenums_changed
;
1281 /* Print text describing the full name of the source file S
1282 and the line number LINE and its corresponding character position.
1283 The text starts with two Ctrl-z so that the Emacs-GDB interface
1286 MID_STATEMENT is nonzero if the PC is not at the beginning of that line.
1288 Return 1 if successful, 0 if could not find the file. */
1291 identify_source_line (struct symtab
*s
, int line
, int mid_statement
,
1294 if (s
->line_charpos
== 0)
1295 get_filename_and_charpos (s
, (char **) NULL
);
1296 if (s
->fullname
== 0)
1298 if (line
> s
->nlines
)
1299 /* Don't index off the end of the line_charpos array. */
1301 annotate_source (s
->fullname
, line
, s
->line_charpos
[line
- 1],
1302 mid_statement
, get_objfile_arch (SYMTAB_OBJFILE (s
)), pc
);
1304 current_source_line
= line
;
1305 current_source_symtab
= s
;
1306 clear_lines_listed_range ();
1311 /* Print source lines from the file of symtab S,
1312 starting with line number LINE and stopping before line number STOPLINE. */
1315 print_source_lines_base (struct symtab
*s
, int line
, int stopline
,
1316 print_source_lines_flags flags
)
1321 int nlines
= stopline
- line
;
1322 struct ui_out
*uiout
= current_uiout
;
1324 /* Regardless of whether we can open the file, set current_source_symtab. */
1325 current_source_symtab
= s
;
1326 current_source_line
= line
;
1327 first_line_listed
= line
;
1329 /* If printing of source lines is disabled, just print file and line
1331 if (uiout
->test_flags (ui_source_list
))
1333 /* Only prints "No such file or directory" once. */
1334 if ((s
!= last_source_visited
) || (!last_source_error
))
1336 last_source_visited
= s
;
1337 desc
= open_source_file (s
);
1341 desc
= last_source_error
;
1342 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1347 desc
= last_source_error
;
1348 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1352 if (desc
< 0 || noprint
)
1354 last_source_error
= desc
;
1356 if (!(flags
& PRINT_SOURCE_LINES_NOERROR
))
1358 const char *filename
= symtab_to_filename_for_display (s
);
1359 int len
= strlen (filename
) + 100;
1360 char *name
= (char *) alloca (len
);
1362 xsnprintf (name
, len
, "%d\t%s", line
, filename
);
1363 print_sys_errmsg (name
, errno
);
1367 uiout
->field_int ("line", line
);
1368 uiout
->text ("\tin ");
1370 /* CLI expects only the "file" field. TUI expects only the
1371 "fullname" field (and TUI does break if "file" is printed).
1372 MI expects both fields. ui_source_list is set only for CLI,
1374 if (uiout
->is_mi_like_p () || uiout
->test_flags (ui_source_list
))
1375 uiout
->field_string ("file", symtab_to_filename_for_display (s
));
1376 if (uiout
->is_mi_like_p () || !uiout
->test_flags (ui_source_list
))
1378 const char *s_fullname
= symtab_to_fullname (s
);
1379 char *local_fullname
;
1381 /* ui_out_field_string may free S_FULLNAME by calling
1382 open_source_file for it again. See e.g.,
1383 tui_field_string->tui_show_source. */
1384 local_fullname
= (char *) alloca (strlen (s_fullname
) + 1);
1385 strcpy (local_fullname
, s_fullname
);
1387 uiout
->field_string ("fullname", local_fullname
);
1396 last_source_error
= 0;
1398 if (s
->line_charpos
== 0)
1399 find_source_lines (s
, desc
);
1401 if (line
< 1 || line
> s
->nlines
)
1404 error (_("Line number %d out of range; %s has %d lines."),
1405 line
, symtab_to_filename_for_display (s
), s
->nlines
);
1408 if (lseek (desc
, s
->line_charpos
[line
- 1], 0) < 0)
1411 perror_with_name (symtab_to_filename_for_display (s
));
1414 gdb_file_up
stream (fdopen (desc
, FDOPEN_MODE
));
1415 clearerr (stream
.get ());
1417 while (nlines
-- > 0)
1421 c
= fgetc (stream
.get ());
1424 last_line_listed
= current_source_line
;
1425 if (flags
& PRINT_SOURCE_LINES_FILENAME
)
1427 uiout
->text (symtab_to_filename_for_display (s
));
1430 xsnprintf (buf
, sizeof (buf
), "%d\t", current_source_line
++);
1434 if (c
< 040 && c
!= '\t' && c
!= '\n' && c
!= '\r')
1436 xsnprintf (buf
, sizeof (buf
), "^%c", c
+ 0100);
1443 /* Skip a \r character, but only before a \n. */
1444 int c1
= fgetc (stream
.get ());
1447 printf_filtered ("^%c", c
+ 0100);
1449 ungetc (c1
, stream
.get ());
1453 xsnprintf (buf
, sizeof (buf
), "%c", c
);
1457 while (c
!= '\n' && (c
= fgetc (stream
.get ())) >= 0);
1461 /* Show source lines from the file of symtab S, starting with line
1462 number LINE and stopping before line number STOPLINE. If this is
1463 not the command line version, then the source is shown in the source
1464 window otherwise it is simply printed. */
1467 print_source_lines (struct symtab
*s
, int line
, int stopline
,
1468 print_source_lines_flags flags
)
1470 print_source_lines_base (s
, line
, stopline
, flags
);
1473 /* Print info on range of pc's in a specified line. */
1476 info_line_command (const char *arg
, int from_tty
)
1478 CORE_ADDR start_pc
, end_pc
;
1480 std::vector
<symtab_and_line
> decoded_sals
;
1481 symtab_and_line curr_sal
;
1482 gdb::array_view
<symtab_and_line
> sals
;
1486 curr_sal
.symtab
= current_source_symtab
;
1487 curr_sal
.pspace
= current_program_space
;
1488 if (last_line_listed
!= 0)
1489 curr_sal
.line
= last_line_listed
;
1491 curr_sal
.line
= current_source_line
;
1497 decoded_sals
= decode_line_with_last_displayed (arg
,
1498 DECODE_LINE_LIST_MODE
);
1499 sals
= decoded_sals
;
1504 /* C++ More than one line may have been specified, as when the user
1505 specifies an overloaded function name. Print info on them all. */
1506 for (const auto &sal
: sals
)
1508 if (sal
.pspace
!= current_program_space
)
1511 if (sal
.symtab
== 0)
1513 struct gdbarch
*gdbarch
= get_current_arch ();
1515 printf_filtered (_("No line number information available"));
1518 /* This is useful for "info line *0x7f34". If we can't tell the
1519 user about a source line, at least let them have the symbolic
1521 printf_filtered (" for address ");
1523 print_address (gdbarch
, sal
.pc
, gdb_stdout
);
1526 printf_filtered (".");
1527 printf_filtered ("\n");
1529 else if (sal
.line
> 0
1530 && find_line_pc_range (sal
, &start_pc
, &end_pc
))
1532 struct gdbarch
*gdbarch
1533 = get_objfile_arch (SYMTAB_OBJFILE (sal
.symtab
));
1535 if (start_pc
== end_pc
)
1537 printf_filtered ("Line %d of \"%s\"",
1539 symtab_to_filename_for_display (sal
.symtab
));
1541 printf_filtered (" is at address ");
1542 print_address (gdbarch
, start_pc
, gdb_stdout
);
1544 printf_filtered (" but contains no code.\n");
1548 printf_filtered ("Line %d of \"%s\"",
1550 symtab_to_filename_for_display (sal
.symtab
));
1552 printf_filtered (" starts at address ");
1553 print_address (gdbarch
, start_pc
, gdb_stdout
);
1555 printf_filtered (" and ends at ");
1556 print_address (gdbarch
, end_pc
, gdb_stdout
);
1557 printf_filtered (".\n");
1560 /* x/i should display this line's code. */
1561 set_next_address (gdbarch
, start_pc
);
1563 /* Repeating "info line" should do the following line. */
1564 last_line_listed
= sal
.line
+ 1;
1566 /* If this is the only line, show the source code. If it could
1567 not find the file, don't do anything special. */
1568 if (annotation_level
&& sals
.size () == 1)
1569 identify_source_line (sal
.symtab
, sal
.line
, 0, start_pc
);
1572 /* Is there any case in which we get here, and have an address
1573 which the user would want to see? If we have debugging symbols
1574 and no line numbers? */
1575 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1576 sal
.line
, symtab_to_filename_for_display (sal
.symtab
));
1580 /* Commands to search the source file for a regexp. */
1583 forward_search_command (const char *regex
, int from_tty
)
1589 struct cleanup
*cleanups
;
1591 line
= last_line_listed
+ 1;
1593 msg
= (char *) re_comp (regex
);
1595 error (("%s"), msg
);
1597 if (current_source_symtab
== 0)
1598 select_source_symtab (0);
1600 desc
= open_source_file (current_source_symtab
);
1602 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1603 cleanups
= make_cleanup_close (desc
);
1605 if (current_source_symtab
->line_charpos
== 0)
1606 find_source_lines (current_source_symtab
, desc
);
1608 if (line
< 1 || line
> current_source_symtab
->nlines
)
1609 error (_("Expression not found"));
1611 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1612 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1614 discard_cleanups (cleanups
);
1615 gdb_file_up
stream (fdopen (desc
, FDOPEN_MODE
));
1616 clearerr (stream
.get ());
1619 static char *buf
= NULL
;
1621 int cursize
, newsize
;
1624 buf
= (char *) xmalloc (cursize
);
1627 c
= fgetc (stream
.get ());
1633 if (p
- buf
== cursize
)
1635 newsize
= cursize
+ cursize
/ 2;
1636 buf
= (char *) xrealloc (buf
, newsize
);
1641 while (c
!= '\n' && (c
= fgetc (stream
.get ())) >= 0);
1643 /* Remove the \r, if any, at the end of the line, otherwise
1644 regular expressions that end with $ or \n won't work. */
1645 if (p
- buf
> 1 && p
[-2] == '\r')
1651 /* We now have a source line in buf, null terminate and match. */
1653 if (re_exec (buf
) > 0)
1656 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1657 set_internalvar_integer (lookup_internalvar ("_"), line
);
1658 current_source_line
= std::max (line
- lines_to_list
/ 2, 1);
1664 printf_filtered (_("Expression not found\n"));
1668 reverse_search_command (const char *regex
, int from_tty
)
1674 struct cleanup
*cleanups
;
1676 line
= last_line_listed
- 1;
1678 msg
= (char *) re_comp (regex
);
1680 error (("%s"), msg
);
1682 if (current_source_symtab
== 0)
1683 select_source_symtab (0);
1685 desc
= open_source_file (current_source_symtab
);
1687 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1688 cleanups
= make_cleanup_close (desc
);
1690 if (current_source_symtab
->line_charpos
== 0)
1691 find_source_lines (current_source_symtab
, desc
);
1693 if (line
< 1 || line
> current_source_symtab
->nlines
)
1694 error (_("Expression not found"));
1696 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1697 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1699 discard_cleanups (cleanups
);
1700 gdb_file_up
stream (fdopen (desc
, FDOPEN_MODE
));
1701 clearerr (stream
.get ());
1704 /* FIXME!!! We walk right off the end of buf if we get a long line!!! */
1705 char buf
[4096]; /* Should be reasonable??? */
1708 c
= fgetc (stream
.get ());
1715 while (c
!= '\n' && (c
= fgetc (stream
.get ())) >= 0);
1717 /* Remove the \r, if any, at the end of the line, otherwise
1718 regular expressions that end with $ or \n won't work. */
1719 if (p
- buf
> 1 && p
[-2] == '\r')
1725 /* We now have a source line in buf; null terminate and match. */
1727 if (re_exec (buf
) > 0)
1730 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1731 set_internalvar_integer (lookup_internalvar ("_"), line
);
1732 current_source_line
= std::max (line
- lines_to_list
/ 2, 1);
1736 if (fseek (stream
.get (),
1737 current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1739 const char *filename
;
1741 filename
= symtab_to_filename_for_display (current_source_symtab
);
1742 perror_with_name (filename
);
1746 printf_filtered (_("Expression not found\n"));
1750 /* If the last character of PATH is a directory separator, then strip it. */
1753 strip_trailing_directory_separator (char *path
)
1755 const int last
= strlen (path
) - 1;
1758 return; /* No stripping is needed if PATH is the empty string. */
1760 if (IS_DIR_SEPARATOR (path
[last
]))
1764 /* Return the path substitution rule that matches FROM.
1765 Return NULL if no rule matches. */
1767 static struct substitute_path_rule
*
1768 find_substitute_path_rule (const char *from
)
1770 struct substitute_path_rule
*rule
= substitute_path_rules
;
1772 while (rule
!= NULL
)
1774 if (FILENAME_CMP (rule
->from
, from
) == 0)
1782 /* Add a new substitute-path rule at the end of the current list of rules.
1783 The new rule will replace FROM into TO. */
1786 add_substitute_path_rule (char *from
, char *to
)
1788 struct substitute_path_rule
*rule
;
1789 struct substitute_path_rule
*new_rule
= XNEW (struct substitute_path_rule
);
1791 new_rule
->from
= xstrdup (from
);
1792 new_rule
->to
= xstrdup (to
);
1793 new_rule
->next
= NULL
;
1795 /* If the list of rules are empty, then insert the new rule
1796 at the head of the list. */
1798 if (substitute_path_rules
== NULL
)
1800 substitute_path_rules
= new_rule
;
1804 /* Otherwise, skip to the last rule in our list and then append
1807 rule
= substitute_path_rules
;
1808 while (rule
->next
!= NULL
)
1811 rule
->next
= new_rule
;
1814 /* Remove the given source path substitution rule from the current list
1815 of rules. The memory allocated for that rule is also deallocated. */
1818 delete_substitute_path_rule (struct substitute_path_rule
*rule
)
1820 if (rule
== substitute_path_rules
)
1821 substitute_path_rules
= rule
->next
;
1824 struct substitute_path_rule
*prev
= substitute_path_rules
;
1826 while (prev
!= NULL
&& prev
->next
!= rule
)
1829 gdb_assert (prev
!= NULL
);
1831 prev
->next
= rule
->next
;
1839 /* Implement the "show substitute-path" command. */
1842 show_substitute_path_command (const char *args
, int from_tty
)
1844 struct substitute_path_rule
*rule
= substitute_path_rules
;
1847 gdb_argv
argv (args
);
1849 /* We expect zero or one argument. */
1851 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1852 error (_("Too many arguments in command"));
1854 if (argv
!= NULL
&& argv
[0] != NULL
)
1857 /* Print the substitution rules. */
1861 (_("Source path substitution rule matching `%s':\n"), from
);
1863 printf_filtered (_("List of all source path substitution rules:\n"));
1865 while (rule
!= NULL
)
1867 if (from
== NULL
|| substitute_path_rule_matches (rule
, from
) != 0)
1868 printf_filtered (" `%s' -> `%s'.\n", rule
->from
, rule
->to
);
1873 /* Implement the "unset substitute-path" command. */
1876 unset_substitute_path_command (const char *args
, int from_tty
)
1878 struct substitute_path_rule
*rule
= substitute_path_rules
;
1879 gdb_argv
argv (args
);
1883 /* This function takes either 0 or 1 argument. */
1885 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1886 error (_("Incorrect usage, too many arguments in command"));
1888 if (argv
!= NULL
&& argv
[0] != NULL
)
1891 /* If the user asked for all the rules to be deleted, ask him
1892 to confirm and give him a chance to abort before the action
1896 && !query (_("Delete all source path substitution rules? ")))
1897 error (_("Canceled"));
1899 /* Delete the rule matching the argument. No argument means that
1900 all rules should be deleted. */
1902 while (rule
!= NULL
)
1904 struct substitute_path_rule
*next
= rule
->next
;
1906 if (from
== NULL
|| FILENAME_CMP (from
, rule
->from
) == 0)
1908 delete_substitute_path_rule (rule
);
1915 /* If the user asked for a specific rule to be deleted but
1916 we could not find it, then report an error. */
1918 if (from
!= NULL
&& !rule_found
)
1919 error (_("No substitution rule defined for `%s'"), from
);
1921 forget_cached_source_info ();
1924 /* Add a new source path substitution rule. */
1927 set_substitute_path_command (const char *args
, int from_tty
)
1929 struct substitute_path_rule
*rule
;
1931 gdb_argv
argv (args
);
1933 if (argv
== NULL
|| argv
[0] == NULL
|| argv
[1] == NULL
)
1934 error (_("Incorrect usage, too few arguments in command"));
1936 if (argv
[2] != NULL
)
1937 error (_("Incorrect usage, too many arguments in command"));
1939 if (*(argv
[0]) == '\0')
1940 error (_("First argument must be at least one character long"));
1942 /* Strip any trailing directory separator character in either FROM
1943 or TO. The substitution rule already implicitly contains them. */
1944 strip_trailing_directory_separator (argv
[0]);
1945 strip_trailing_directory_separator (argv
[1]);
1947 /* If a rule with the same "from" was previously defined, then
1948 delete it. This new rule replaces it. */
1950 rule
= find_substitute_path_rule (argv
[0]);
1952 delete_substitute_path_rule (rule
);
1954 /* Insert the new substitution rule. */
1956 add_substitute_path_rule (argv
[0], argv
[1]);
1957 forget_cached_source_info ();
1962 _initialize_source (void)
1964 struct cmd_list_element
*c
;
1966 current_source_symtab
= 0;
1967 init_source_path ();
1969 /* The intention is to use POSIX Basic Regular Expressions.
1970 Always use the GNU regex routine for consistency across all hosts.
1971 Our current GNU regex.c does not have all the POSIX features, so this is
1972 just an approximation. */
1973 re_set_syntax (RE_SYNTAX_GREP
);
1975 c
= add_cmd ("directory", class_files
, directory_command
, _("\
1976 Add directory DIR to beginning of search path for source files.\n\
1977 Forget cached info on source file locations and line positions.\n\
1978 DIR can also be $cwd for the current working directory, or $cdir for the\n\
1979 directory in which the source file was compiled into object code.\n\
1980 With no argument, reset the search path to $cdir:$cwd, the default."),
1984 add_com_alias ("use", "directory", class_files
, 0);
1986 set_cmd_completer (c
, filename_completer
);
1988 add_setshow_optional_filename_cmd ("directories",
1992 Set the search path for finding source files."),
1994 Show the search path for finding source files."),
1996 $cwd in the path means the current working directory.\n\
1997 $cdir in the path means the compilation directory of the source file.\n\
1998 GDB ensures the search path always ends with $cdir:$cwd by\n\
1999 appending these directories if necessary.\n\
2000 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
2001 set_directories_command
,
2002 show_directories_command
,
2003 &setlist
, &showlist
);
2005 add_info ("source", info_source_command
,
2006 _("Information about the current source file."));
2008 add_info ("line", info_line_command
, _("\
2009 Core addresses of the code for a source line.\n\
2010 Line can be specified as\n\
2011 LINENUM, to list around that line in current file,\n\
2012 FILE:LINENUM, to list around that line in that file,\n\
2013 FUNCTION, to list around beginning of that function,\n\
2014 FILE:FUNCTION, to distinguish among like-named static functions.\n\
2015 Default is to describe the last source line that was listed.\n\n\
2016 This sets the default address for \"x\" to the line's first instruction\n\
2017 so that \"x/i\" suffices to start examining the machine code.\n\
2018 The address is also stored as the value of \"$_\"."));
2020 add_com ("forward-search", class_files
, forward_search_command
, _("\
2021 Search for regular expression (see regex(3)) from last line listed.\n\
2022 The matching line number is also stored as the value of \"$_\"."));
2023 add_com_alias ("search", "forward-search", class_files
, 0);
2024 add_com_alias ("fo", "forward-search", class_files
, 1);
2026 add_com ("reverse-search", class_files
, reverse_search_command
, _("\
2027 Search backward for regular expression (see regex(3)) from last line listed.\n\
2028 The matching line number is also stored as the value of \"$_\"."));
2029 add_com_alias ("rev", "reverse-search", class_files
, 1);
2031 add_setshow_integer_cmd ("listsize", class_support
, &lines_to_list
, _("\
2032 Set number of source lines gdb will list by default."), _("\
2033 Show number of source lines gdb will list by default."), _("\
2034 Use this to choose how many source lines the \"list\" displays (unless\n\
2035 the \"list\" argument explicitly specifies some other number).\n\
2036 A value of \"unlimited\", or zero, means there's no limit."),
2039 &setlist
, &showlist
);
2041 add_cmd ("substitute-path", class_files
, set_substitute_path_command
,
2043 Usage: set substitute-path FROM TO\n\
2044 Add a substitution rule replacing FROM into TO in source file names.\n\
2045 If a substitution rule was previously set for FROM, the old rule\n\
2046 is replaced by the new one."),
2049 add_cmd ("substitute-path", class_files
, unset_substitute_path_command
,
2051 Usage: unset substitute-path [FROM]\n\
2052 Delete the rule for substituting FROM in source file names. If FROM\n\
2053 is not specified, all substituting rules are deleted.\n\
2054 If the debugger cannot find a rule for FROM, it will display a warning."),
2057 add_cmd ("substitute-path", class_files
, show_substitute_path_command
,
2059 Usage: show substitute-path [FROM]\n\
2060 Print the rule for substituting FROM in source file names. If FROM\n\
2061 is not specified, print all substitution rules."),
2064 add_setshow_enum_cmd ("filename-display", class_files
,
2065 filename_display_kind_names
,
2066 &filename_display_string
, _("\
2067 Set how to display filenames."), _("\
2068 Show how to display filenames."), _("\
2069 filename-display can be:\n\
2070 basename - display only basename of a filename\n\
2071 relative - display a filename relative to the compilation directory\n\
2072 absolute - display an absolute filename\n\
2073 By default, relative filenames are displayed."),
2075 show_filename_display_string
,
2076 &setlist
, &showlist
);