1 /* List lines of source files for GDB, the GNU debugger.
2 Copyright (C) 1986-2015 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"
46 #define OPEN_MODE (O_RDONLY | O_BINARY)
47 #define FDOPEN_MODE FOPEN_RB
49 /* Prototypes for exported functions. */
51 void _initialize_source (void);
53 /* Prototypes for local functions. */
55 static int get_filename_and_charpos (struct symtab
*, char **);
57 static void reverse_search_command (char *, int);
59 static void forward_search_command (char *, int);
61 static void line_info (char *, int);
63 static void source_info (char *, int);
65 /* Path of directories to search for source files.
66 Same format as the PATH environment variable's value. */
70 /* Support for source path substitution commands. */
72 struct substitute_path_rule
76 struct substitute_path_rule
*next
;
79 static struct substitute_path_rule
*substitute_path_rules
= NULL
;
81 /* Symtab of default file for listing lines of. */
83 static struct symtab
*current_source_symtab
;
85 /* Default next line to list. */
87 static int current_source_line
;
89 static struct program_space
*current_source_pspace
;
91 /* Default number of lines to print with commands like "list".
92 This is based on guessing how many long (i.e. more than chars_per_line
93 characters) lines there will be. To be completely correct, "list"
94 and friends should be rewritten to count characters and see where
95 things are wrapping, but that would be a fair amount of work. */
97 int lines_to_list
= 10;
99 show_lines_to_list (struct ui_file
*file
, int from_tty
,
100 struct cmd_list_element
*c
, const char *value
)
102 fprintf_filtered (file
,
103 _("Number of source lines gdb "
104 "will list by default is %s.\n"),
108 /* Possible values of 'set filename-display'. */
109 static const char filename_display_basename
[] = "basename";
110 static const char filename_display_relative
[] = "relative";
111 static const char filename_display_absolute
[] = "absolute";
113 static const char *const filename_display_kind_names
[] = {
114 filename_display_basename
,
115 filename_display_relative
,
116 filename_display_absolute
,
120 static const char *filename_display_string
= filename_display_relative
;
123 show_filename_display_string (struct ui_file
*file
, int from_tty
,
124 struct cmd_list_element
*c
, const char *value
)
126 fprintf_filtered (file
, _("Filenames are displayed as \"%s\".\n"), value
);
129 /* Line number of last line printed. Default for various commands.
130 current_source_line is usually, but not always, the same as this. */
132 static int last_line_listed
;
134 /* First line number listed by last listing command. If 0, then no
135 source lines have yet been listed since the last time the current
136 source line was changed. */
138 static int first_line_listed
;
140 /* Saves the name of the last source file visited and a possible error code.
141 Used to prevent repeating annoying "No such file or directories" msgs. */
143 static struct symtab
*last_source_visited
= NULL
;
144 static int last_source_error
= 0;
146 /* Return the first line listed by print_source_lines.
147 Used by command interpreters to request listing from
151 get_first_line_listed (void)
153 return first_line_listed
;
156 /* Clear line listed range. This makes the next "list" center the
157 printed source lines around the current source line. */
160 clear_lines_listed_range (void)
162 first_line_listed
= 0;
163 last_line_listed
= 0;
166 /* Return the default number of lines to print with commands like the
167 cli "list". The caller of print_source_lines must use this to
168 calculate the end line and use it in the call to print_source_lines
169 as it does not automatically use this value. */
172 get_lines_to_list (void)
174 return lines_to_list
;
177 /* Return the current source file for listing and next line to list.
178 NOTE: The returned sal pc and end fields are not valid. */
180 struct symtab_and_line
181 get_current_source_symtab_and_line (void)
183 struct symtab_and_line cursal
= { 0 };
185 cursal
.pspace
= current_source_pspace
;
186 cursal
.symtab
= current_source_symtab
;
187 cursal
.line
= current_source_line
;
194 /* If the current source file for listing is not set, try and get a default.
195 Usually called before get_current_source_symtab_and_line() is called.
196 It may err out if a default cannot be determined.
197 We must be cautious about where it is called, as it can recurse as the
198 process of determining a new default may call the caller!
199 Use get_current_source_symtab_and_line only to get whatever
200 we have without erroring out or trying to get a default. */
203 set_default_source_symtab_and_line (void)
205 if (!have_full_symbols () && !have_partial_symbols ())
206 error (_("No symbol table is loaded. Use the \"file\" command."));
208 /* Pull in a current source symtab if necessary. */
209 if (current_source_symtab
== 0)
210 select_source_symtab (0);
213 /* Return the current default file for listing and next line to list
214 (the returned sal pc and end fields are not valid.)
215 and set the current default to whatever is in SAL.
216 NOTE: The returned sal pc and end fields are not valid. */
218 struct symtab_and_line
219 set_current_source_symtab_and_line (const struct symtab_and_line
*sal
)
221 struct symtab_and_line cursal
= { 0 };
223 cursal
.pspace
= current_source_pspace
;
224 cursal
.symtab
= current_source_symtab
;
225 cursal
.line
= current_source_line
;
229 current_source_pspace
= sal
->pspace
;
230 current_source_symtab
= sal
->symtab
;
231 current_source_line
= sal
->line
;
233 /* Force the next "list" to center around the current line. */
234 clear_lines_listed_range ();
239 /* Reset any information stored about a default file and line to print. */
242 clear_current_source_symtab_and_line (void)
244 current_source_symtab
= 0;
245 current_source_line
= 0;
248 /* Set the source file default for the "list" command to be S.
250 If S is NULL, and we don't have a default, find one. This
251 should only be called when the user actually tries to use the
252 default, since we produce an error if we can't find a reasonable
253 default. Also, since this can cause symbols to be read, doing it
254 before we need to would make things slower than necessary. */
257 select_source_symtab (struct symtab
*s
)
259 struct symtabs_and_lines sals
;
260 struct symtab_and_line sal
;
262 struct compunit_symtab
*cu
;
266 current_source_symtab
= s
;
267 current_source_line
= 1;
268 current_source_pspace
= SYMTAB_PSPACE (s
);
272 if (current_source_symtab
)
275 /* Make the default place to list be the function `main'
277 if (lookup_symbol (main_name (), 0, VAR_DOMAIN
, 0).symbol
)
279 sals
= decode_line_with_current_source (main_name (),
280 DECODE_LINE_FUNFIRSTLINE
);
283 current_source_pspace
= sal
.pspace
;
284 current_source_symtab
= sal
.symtab
;
285 current_source_line
= max (sal
.line
- (lines_to_list
- 1), 1);
286 if (current_source_symtab
)
290 /* Alright; find the last file in the symtab list (ignoring .h's
291 and namespace symtabs). */
293 current_source_line
= 1;
295 ALL_FILETABS (ofp
, cu
, s
)
297 const char *name
= s
->filename
;
298 int len
= strlen (name
);
300 if (!(len
> 2 && (strcmp (&name
[len
- 2], ".h") == 0
301 || strcmp (name
, "<<C++-namespaces>>") == 0)))
303 current_source_pspace
= current_program_space
;
304 current_source_symtab
= s
;
308 if (current_source_symtab
)
314 s
= ofp
->sf
->qf
->find_last_source_symtab (ofp
);
316 current_source_symtab
= s
;
318 if (current_source_symtab
)
321 error (_("Can't find a default source file"));
324 /* Handler for "set directories path-list" command.
325 "set dir mumble" doesn't prepend paths, it resets the entire
326 path list. The theory is that set(show(dir)) should be a no-op. */
329 set_directories_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
331 /* This is the value that was set.
332 It needs to be processed to maintain $cdir:$cwd and remove dups. */
333 char *set_path
= source_path
;
335 /* We preserve the invariant that $cdir:$cwd begins life at the end of
336 the list by calling init_source_path. If they appear earlier in
337 SET_PATH then mod_path will move them appropriately.
338 mod_path will also remove duplicates. */
340 if (*set_path
!= '\0')
341 mod_path (set_path
, &source_path
);
346 /* Print the list of source directories.
347 This is used by the "ld" command, so it has the signature of a command
351 show_directories_1 (char *ignore
, int from_tty
)
353 puts_filtered ("Source directories searched: ");
354 puts_filtered (source_path
);
355 puts_filtered ("\n");
358 /* Handler for "show directories" command. */
361 show_directories_command (struct ui_file
*file
, int from_tty
,
362 struct cmd_list_element
*c
, const char *value
)
364 show_directories_1 (NULL
, from_tty
);
367 /* Forget line positions and file names for the symtabs in a
368 particular objfile. */
371 forget_cached_source_info_for_objfile (struct objfile
*objfile
)
373 struct compunit_symtab
*cu
;
376 ALL_OBJFILE_FILETABS (objfile
, cu
, s
)
378 if (s
->line_charpos
!= NULL
)
380 xfree (s
->line_charpos
);
381 s
->line_charpos
= NULL
;
383 if (s
->fullname
!= NULL
)
391 objfile
->sf
->qf
->forget_cached_source_info (objfile
);
394 /* Forget what we learned about line positions in source files, and
395 which directories contain them; must check again now since files
396 may be found in a different directory now. */
399 forget_cached_source_info (void)
401 struct program_space
*pspace
;
402 struct objfile
*objfile
;
405 ALL_PSPACE_OBJFILES (pspace
, objfile
)
407 forget_cached_source_info_for_objfile (objfile
);
410 last_source_visited
= NULL
;
414 init_source_path (void)
418 xsnprintf (buf
, sizeof (buf
), "$cdir%c$cwd", DIRNAME_SEPARATOR
);
419 source_path
= xstrdup (buf
);
420 forget_cached_source_info ();
423 /* Add zero or more directories to the front of the source path. */
426 directory_command (char *dirname
, int from_tty
)
429 /* FIXME, this goes to "delete dir"... */
432 if (!from_tty
|| query (_("Reinitialize source path to empty? ")))
440 mod_path (dirname
, &source_path
);
441 forget_cached_source_info ();
444 show_directories_1 ((char *) 0, from_tty
);
447 /* Add a path given with the -d command line switch.
448 This will not be quoted so we must not treat spaces as separators. */
451 directory_switch (char *dirname
, int from_tty
)
453 add_path (dirname
, &source_path
, 0);
456 /* Add zero or more directories to the front of an arbitrary path. */
459 mod_path (char *dirname
, char **which_path
)
461 add_path (dirname
, which_path
, 1);
464 /* Workhorse of mod_path. Takes an extra argument to determine
465 if dirname should be parsed for separators that indicate multiple
466 directories. This allows for interfaces that pre-parse the dirname
467 and allow specification of traditional separator characters such
471 add_path (char *dirname
, char **which_path
, int parse_separators
)
473 char *old
= *which_path
;
475 VEC (char_ptr
) *dir_vec
= NULL
;
476 struct cleanup
*back_to
;
483 if (parse_separators
)
485 char **argv
, **argvp
;
487 /* This will properly parse the space and tab separators
488 and any quotes that may exist. */
489 argv
= gdb_buildargv (dirname
);
491 for (argvp
= argv
; *argvp
; argvp
++)
492 dirnames_to_char_ptr_vec_append (&dir_vec
, *argvp
);
497 VEC_safe_push (char_ptr
, dir_vec
, xstrdup (dirname
));
498 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
500 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, name
); ++ix
)
505 /* Spaces and tabs will have been removed by buildargv().
506 NAME is the start of the directory.
507 P is the '\0' following the end. */
508 p
= name
+ strlen (name
);
510 while (!(IS_DIR_SEPARATOR (*name
) && p
<= name
+ 1) /* "/" */
511 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
512 /* On MS-DOS and MS-Windows, h:\ is different from h: */
513 && !(p
== name
+ 3 && name
[1] == ':') /* "d:/" */
515 && IS_DIR_SEPARATOR (p
[-1]))
516 /* Sigh. "foo/" => "foo" */
520 while (p
> name
&& p
[-1] == '.')
524 /* "." => getwd (). */
525 name
= current_directory
;
528 else if (p
> name
+ 1 && IS_DIR_SEPARATOR (p
[-2]))
538 /* "...foo/." => "...foo". */
549 name
= tilde_expand (name
);
550 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
551 else if (IS_ABSOLUTE_PATH (name
) && p
== name
+ 2) /* "d:" => "d:." */
552 name
= concat (name
, ".", (char *)NULL
);
554 else if (!IS_ABSOLUTE_PATH (name
) && name
[0] != '$')
555 name
= concat (current_directory
, SLASH_STRING
, name
, (char *)NULL
);
557 name
= savestring (name
, p
- name
);
558 make_cleanup (xfree
, name
);
560 /* Unless it's a variable, check existence. */
563 /* These are warnings, not errors, since we don't want a
564 non-existent directory in a .gdbinit file to stop processing
565 of the .gdbinit file.
567 Whether they get added to the path is more debatable. Current
568 answer is yes, in case the user wants to go make the directory
569 or whatever. If the directory continues to not exist/not be
570 a directory/etc, then having them in the path should be
572 if (stat (name
, &st
) < 0)
574 int save_errno
= errno
;
576 fprintf_unfiltered (gdb_stderr
, "Warning: ");
577 print_sys_errmsg (name
, save_errno
);
579 else if ((st
.st_mode
& S_IFMT
) != S_IFDIR
)
580 warning (_("%s is not a directory."), name
);
585 unsigned int len
= strlen (name
);
591 /* FIXME: we should use realpath() or its work-alike
592 before comparing. Then all the code above which
593 removes excess slashes and dots could simply go away. */
594 if (!filename_ncmp (p
, name
, len
)
595 && (p
[len
] == '\0' || p
[len
] == DIRNAME_SEPARATOR
))
597 /* Found it in the search path, remove old copy. */
600 /* Back over leading separator. */
603 if (prefix
> p
- *which_path
)
605 /* Same dir twice in one cmd. */
608 /* Copy from next '\0' or ':'. */
609 memmove (p
, &p
[len
+ 1], strlen (&p
[len
+ 1]) + 1);
611 p
= strchr (p
, DIRNAME_SEPARATOR
);
618 tinybuf
[0] = DIRNAME_SEPARATOR
;
621 /* If we have already tacked on a name(s) in this command,
622 be sure they stay on the front as we tack on some
630 temp
= concat (old
, tinybuf
, name
, (char *)NULL
);
632 *which_path
= concat (temp
, "", &old
[prefix
], (char *) NULL
);
633 prefix
= strlen (temp
);
638 *which_path
= concat (name
, (old
[0] ? tinybuf
: old
),
640 prefix
= strlen (name
);
649 do_cleanups (back_to
);
654 source_info (char *ignore
, int from_tty
)
656 struct symtab
*s
= current_source_symtab
;
657 struct compunit_symtab
*cust
;
661 printf_filtered (_("No current source file.\n"));
665 cust
= SYMTAB_COMPUNIT (s
);
666 printf_filtered (_("Current source file is %s\n"), s
->filename
);
667 if (SYMTAB_DIRNAME (s
) != NULL
)
668 printf_filtered (_("Compilation directory is %s\n"), SYMTAB_DIRNAME (s
));
670 printf_filtered (_("Located in %s\n"), s
->fullname
);
672 printf_filtered (_("Contains %d line%s.\n"), s
->nlines
,
673 s
->nlines
== 1 ? "" : "s");
675 printf_filtered (_("Source language is %s.\n"), language_str (s
->language
));
676 printf_filtered (_("Producer is %s.\n"),
677 COMPUNIT_PRODUCER (cust
) != NULL
678 ? COMPUNIT_PRODUCER (cust
) : _("unknown"));
679 printf_filtered (_("Compiled with %s debugging format.\n"),
680 COMPUNIT_DEBUGFORMAT (cust
));
681 printf_filtered (_("%s preprocessor macro info.\n"),
682 COMPUNIT_MACRO_TABLE (cust
) != NULL
683 ? "Includes" : "Does not include");
687 /* Return True if the file NAME exists and is a regular file. */
689 is_regular_file (const char *name
)
692 const int status
= stat (name
, &st
);
694 /* Stat should never fail except when the file does not exist.
695 If stat fails, analyze the source of error and return True
696 unless the file does not exist, to avoid returning false results
697 on obscure systems where stat does not work as expected. */
700 return (errno
!= ENOENT
);
702 return S_ISREG (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
))
779 if (is_regular_file (string
))
781 filename
= (char *) alloca (strlen (string
) + 1);
782 strcpy (filename
, string
);
783 fd
= gdb_open_cloexec (filename
, mode
, 0);
794 if (!(opts
& OPF_SEARCH_IN_PATH
))
795 for (i
= 0; string
[i
]; i
++)
796 if (IS_DIR_SEPARATOR (string
[i
]))
800 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
801 if (HAS_DRIVE_SPEC (string
))
802 string
= STRIP_DRIVE_SPEC (string
);
804 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
805 while (IS_DIR_SEPARATOR(string
[0]))
809 while (string
[0] == '.' && IS_DIR_SEPARATOR (string
[1]))
812 alloclen
= strlen (path
) + strlen (string
) + 2;
813 filename
= (char *) alloca (alloclen
);
817 dir_vec
= dirnames_to_char_ptr_vec (path
);
818 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
820 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, dir
); ++ix
)
822 size_t len
= strlen (dir
);
824 if (strcmp (dir
, "$cwd") == 0)
826 /* Name is $cwd -- insert current directory name instead. */
829 /* First, realloc the filename buffer if too short. */
830 len
= strlen (current_directory
);
831 newlen
= len
+ strlen (string
) + 2;
832 if (newlen
> alloclen
)
835 filename
= (char *) alloca (alloclen
);
837 strcpy (filename
, current_directory
);
839 else if (strchr(dir
, '~'))
841 /* See whether we need to expand the tilde. */
843 char *tilde_expanded
;
845 tilde_expanded
= tilde_expand (dir
);
847 /* First, realloc the filename buffer if too short. */
848 len
= strlen (tilde_expanded
);
849 newlen
= len
+ strlen (string
) + 2;
850 if (newlen
> alloclen
)
853 filename
= (char *) alloca (alloclen
);
855 strcpy (filename
, tilde_expanded
);
856 xfree (tilde_expanded
);
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
))
883 fd
= gdb_open_cloexec (filename
, mode
, 0);
890 do_cleanups (back_to
);
895 /* If a file was opened, canonicalize its filename. */
897 *filename_opened
= NULL
;
898 else if ((opts
& OPF_RETURN_REALPATH
) != 0)
899 *filename_opened
= gdb_realpath (filename
);
901 *filename_opened
= gdb_abspath (filename
);
909 /* This is essentially a convenience, for clients that want the behaviour
910 of openp, using source_path, but that really don't want the file to be
911 opened but want instead just to know what the full pathname is (as
912 qualified against source_path).
914 The current working directory is searched first.
916 If the file was found, this function returns 1, and FULL_PATHNAME is
917 set to the fully-qualified pathname.
919 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
921 source_full_path_of (const char *filename
, char **full_pathname
)
925 fd
= openp (source_path
,
926 OPF_TRY_CWD_FIRST
| OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
,
927 filename
, O_RDONLY
, full_pathname
);
930 *full_pathname
= NULL
;
938 /* Return non-zero if RULE matches PATH, that is if the rule can be
942 substitute_path_rule_matches (const struct substitute_path_rule
*rule
,
945 const int from_len
= strlen (rule
->from
);
946 const int path_len
= strlen (path
);
948 if (path_len
< from_len
)
951 /* The substitution rules are anchored at the start of the path,
952 so the path should start with rule->from. */
954 if (filename_ncmp (path
, rule
->from
, from_len
) != 0)
957 /* Make sure that the region in the path that matches the substitution
958 rule is immediately followed by a directory separator (or the end of
959 string character). */
961 if (path
[from_len
] != '\0' && !IS_DIR_SEPARATOR (path
[from_len
]))
967 /* Find the substitute-path rule that applies to PATH and return it.
968 Return NULL if no rule applies. */
970 static struct substitute_path_rule
*
971 get_substitute_path_rule (const char *path
)
973 struct substitute_path_rule
*rule
= substitute_path_rules
;
975 while (rule
!= NULL
&& !substitute_path_rule_matches (rule
, path
))
981 /* If the user specified a source path substitution rule that applies
982 to PATH, then apply it and return the new path. This new path must
983 be deallocated afterwards.
985 Return NULL if no substitution rule was specified by the user,
986 or if no rule applied to the given PATH. */
989 rewrite_source_path (const char *path
)
991 const struct substitute_path_rule
*rule
= get_substitute_path_rule (path
);
998 from_len
= strlen (rule
->from
);
1000 /* Compute the rewritten path and return it. */
1003 (char *) xmalloc (strlen (path
) + 1 + strlen (rule
->to
) - from_len
);
1004 strcpy (new_path
, rule
->to
);
1005 strcat (new_path
, path
+ from_len
);
1011 find_and_open_source (const char *filename
,
1012 const char *dirname
,
1015 char *path
= source_path
;
1018 struct cleanup
*cleanup
;
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
);
1029 if (rewritten_fullname
!= NULL
)
1032 *fullname
= rewritten_fullname
;
1035 result
= gdb_open_cloexec (*fullname
, OPEN_MODE
, 0);
1038 char *lpath
= gdb_realpath (*fullname
);
1045 /* Didn't work -- free old one, try again. */
1050 cleanup
= make_cleanup (null_cleanup
, NULL
);
1052 if (dirname
!= NULL
)
1054 /* If necessary, rewrite the compilation directory name according
1055 to the source path substitution rules specified by the user. */
1057 char *rewritten_dirname
= rewrite_source_path (dirname
);
1059 if (rewritten_dirname
!= NULL
)
1061 make_cleanup (xfree
, rewritten_dirname
);
1062 dirname
= rewritten_dirname
;
1065 /* Replace a path entry of $cdir with the compilation directory
1068 /* We cast strstr's result in case an ANSIhole has made it const,
1069 which produces a "required warning" when assigned to a nonconst. */
1070 p
= (char *) strstr (source_path
, "$cdir");
1071 if (p
&& (p
== path
|| p
[-1] == DIRNAME_SEPARATOR
)
1072 && (p
[cdir_len
] == DIRNAME_SEPARATOR
|| p
[cdir_len
] == '\0'))
1077 alloca (strlen (source_path
) + 1 + strlen (dirname
) + 1);
1078 len
= p
- source_path
;
1079 strncpy (path
, source_path
, len
); /* Before $cdir */
1080 strcpy (path
+ len
, dirname
); /* new stuff */
1081 strcat (path
+ len
, source_path
+ len
+ cdir_len
); /* After
1086 if (IS_ABSOLUTE_PATH (filename
))
1088 /* If filename is absolute path, try the source path
1089 substitution on it. */
1090 char *rewritten_filename
= rewrite_source_path (filename
);
1092 if (rewritten_filename
!= NULL
)
1094 make_cleanup (xfree
, rewritten_filename
);
1095 filename
= rewritten_filename
;
1099 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, filename
,
1100 OPEN_MODE
, fullname
);
1103 /* Didn't work. Try using just the basename. */
1104 p
= lbasename (filename
);
1106 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, p
,
1107 OPEN_MODE
, fullname
);
1110 do_cleanups (cleanup
);
1114 /* Open a source file given a symtab S. Returns a file descriptor or
1115 negative number for error.
1117 This function is a convience function to find_and_open_source. */
1120 open_source_file (struct symtab
*s
)
1125 return find_and_open_source (s
->filename
, SYMTAB_DIRNAME (s
), &s
->fullname
);
1128 /* Finds the fullname that a symtab represents.
1130 This functions finds the fullname and saves it in s->fullname.
1131 It will also return the value.
1133 If this function fails to find the file that this symtab represents,
1134 the expected fullname is used. Therefore the files does not have to
1138 symtab_to_fullname (struct symtab
*s
)
1140 /* Use cached copy if we have it.
1141 We rely on forget_cached_source_info being called appropriately
1142 to handle cases like the file being moved. */
1143 if (s
->fullname
== NULL
)
1145 int fd
= find_and_open_source (s
->filename
, SYMTAB_DIRNAME (s
),
1153 struct cleanup
*back_to
;
1155 /* rewrite_source_path would be applied by find_and_open_source, we
1156 should report the pathname where GDB tried to find the file. */
1158 if (SYMTAB_DIRNAME (s
) == NULL
|| IS_ABSOLUTE_PATH (s
->filename
))
1159 fullname
= xstrdup (s
->filename
);
1161 fullname
= concat (SYMTAB_DIRNAME (s
), SLASH_STRING
, s
->filename
,
1164 back_to
= make_cleanup (xfree
, fullname
);
1165 s
->fullname
= rewrite_source_path (fullname
);
1166 if (s
->fullname
== NULL
)
1167 s
->fullname
= xstrdup (fullname
);
1168 do_cleanups (back_to
);
1175 /* See commentary in source.h. */
1178 symtab_to_filename_for_display (struct symtab
*symtab
)
1180 if (filename_display_string
== filename_display_basename
)
1181 return lbasename (symtab
->filename
);
1182 else if (filename_display_string
== filename_display_absolute
)
1183 return symtab_to_fullname (symtab
);
1184 else if (filename_display_string
== filename_display_relative
)
1185 return symtab
->filename
;
1187 internal_error (__FILE__
, __LINE__
, _("invalid filename_display_string"));
1190 /* Create and initialize the table S->line_charpos that records
1191 the positions of the lines in the source file, which is assumed
1192 to be open on descriptor DESC.
1193 All set S->nlines to the number of such lines. */
1196 find_source_lines (struct symtab
*s
, int desc
)
1199 char *data
, *p
, *end
;
1201 int lines_allocated
= 1000;
1207 line_charpos
= XNEWVEC (int, lines_allocated
);
1208 if (fstat (desc
, &st
) < 0)
1209 perror_with_name (symtab_to_filename_for_display (s
));
1211 if (SYMTAB_OBJFILE (s
) != NULL
&& SYMTAB_OBJFILE (s
)->obfd
!= NULL
)
1212 mtime
= SYMTAB_OBJFILE (s
)->mtime
;
1214 mtime
= exec_bfd_mtime
;
1216 if (mtime
&& mtime
< st
.st_mtime
)
1217 warning (_("Source file is more recent than executable."));
1220 struct cleanup
*old_cleanups
;
1222 /* st_size might be a large type, but we only support source files whose
1223 size fits in an int. */
1224 size
= (int) st
.st_size
;
1226 /* Use malloc, not alloca, because this may be pretty large, and we may
1227 run into various kinds of limits on stack size. */
1228 data
= (char *) xmalloc (size
);
1229 old_cleanups
= make_cleanup (xfree
, data
);
1231 /* Reassign `size' to result of read for systems where \r\n -> \n. */
1232 size
= myread (desc
, data
, size
);
1234 perror_with_name (symtab_to_filename_for_display (s
));
1237 line_charpos
[0] = 0;
1242 /* A newline at the end does not start a new line. */
1245 if (nlines
== lines_allocated
)
1247 lines_allocated
*= 2;
1249 (int *) xrealloc ((char *) line_charpos
,
1250 sizeof (int) * lines_allocated
);
1252 line_charpos
[nlines
++] = p
- data
;
1255 do_cleanups (old_cleanups
);
1260 (int *) xrealloc ((char *) line_charpos
, nlines
* sizeof (int));
1266 /* Get full pathname and line number positions for a symtab.
1267 Return nonzero if line numbers may have changed.
1268 Set *FULLNAME to actual name of the file as found by `openp',
1269 or to 0 if the file is not found. */
1272 get_filename_and_charpos (struct symtab
*s
, char **fullname
)
1274 int desc
, linenums_changed
= 0;
1275 struct cleanup
*cleanups
;
1277 desc
= open_source_file (s
);
1284 cleanups
= make_cleanup_close (desc
);
1286 *fullname
= s
->fullname
;
1287 if (s
->line_charpos
== 0)
1288 linenums_changed
= 1;
1289 if (linenums_changed
)
1290 find_source_lines (s
, desc
);
1291 do_cleanups (cleanups
);
1292 return linenums_changed
;
1295 /* Print text describing the full name of the source file S
1296 and the line number LINE and its corresponding character position.
1297 The text starts with two Ctrl-z so that the Emacs-GDB interface
1300 MID_STATEMENT is nonzero if the PC is not at the beginning of that line.
1302 Return 1 if successful, 0 if could not find the file. */
1305 identify_source_line (struct symtab
*s
, int line
, int mid_statement
,
1308 if (s
->line_charpos
== 0)
1309 get_filename_and_charpos (s
, (char **) NULL
);
1310 if (s
->fullname
== 0)
1312 if (line
> s
->nlines
)
1313 /* Don't index off the end of the line_charpos array. */
1315 annotate_source (s
->fullname
, line
, s
->line_charpos
[line
- 1],
1316 mid_statement
, get_objfile_arch (SYMTAB_OBJFILE (s
)), pc
);
1318 current_source_line
= line
;
1319 current_source_symtab
= s
;
1320 clear_lines_listed_range ();
1325 /* Print source lines from the file of symtab S,
1326 starting with line number LINE and stopping before line number STOPLINE. */
1329 print_source_lines_base (struct symtab
*s
, int line
, int stopline
,
1330 enum print_source_lines_flags flags
)
1336 int nlines
= stopline
- line
;
1337 struct cleanup
*cleanup
;
1338 struct ui_out
*uiout
= current_uiout
;
1340 /* Regardless of whether we can open the file, set current_source_symtab. */
1341 current_source_symtab
= s
;
1342 current_source_line
= line
;
1343 first_line_listed
= line
;
1345 /* If printing of source lines is disabled, just print file and line
1347 if (ui_out_test_flags (uiout
, ui_source_list
))
1349 /* Only prints "No such file or directory" once. */
1350 if ((s
!= last_source_visited
) || (!last_source_error
))
1352 last_source_visited
= s
;
1353 desc
= open_source_file (s
);
1357 desc
= last_source_error
;
1358 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1363 desc
= last_source_error
;
1364 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1368 if (desc
< 0 || noprint
)
1370 last_source_error
= desc
;
1372 if (!(flags
& PRINT_SOURCE_LINES_NOERROR
))
1374 const char *filename
= symtab_to_filename_for_display (s
);
1375 int len
= strlen (filename
) + 100;
1376 char *name
= (char *) alloca (len
);
1378 xsnprintf (name
, len
, "%d\t%s", line
, filename
);
1379 print_sys_errmsg (name
, errno
);
1383 ui_out_field_int (uiout
, "line", line
);
1384 ui_out_text (uiout
, "\tin ");
1386 /* CLI expects only the "file" field. TUI expects only the
1387 "fullname" field (and TUI does break if "file" is printed).
1388 MI expects both fields. ui_source_list is set only for CLI,
1390 if (ui_out_is_mi_like_p (uiout
)
1391 || ui_out_test_flags (uiout
, ui_source_list
))
1392 ui_out_field_string (uiout
, "file",
1393 symtab_to_filename_for_display (s
));
1394 if (ui_out_is_mi_like_p (uiout
)
1395 || !ui_out_test_flags (uiout
, ui_source_list
))
1397 const char *s_fullname
= symtab_to_fullname (s
);
1398 char *local_fullname
;
1400 /* ui_out_field_string may free S_FULLNAME by calling
1401 open_source_file for it again. See e.g.,
1402 tui_field_string->tui_show_source. */
1403 local_fullname
= (char *) alloca (strlen (s_fullname
) + 1);
1404 strcpy (local_fullname
, s_fullname
);
1406 ui_out_field_string (uiout
, "fullname", local_fullname
);
1409 ui_out_text (uiout
, "\n");
1415 last_source_error
= 0;
1417 if (s
->line_charpos
== 0)
1418 find_source_lines (s
, desc
);
1420 if (line
< 1 || line
> s
->nlines
)
1423 error (_("Line number %d out of range; %s has %d lines."),
1424 line
, symtab_to_filename_for_display (s
), s
->nlines
);
1427 if (lseek (desc
, s
->line_charpos
[line
- 1], 0) < 0)
1430 perror_with_name (symtab_to_filename_for_display (s
));
1433 stream
= fdopen (desc
, FDOPEN_MODE
);
1435 cleanup
= make_cleanup_fclose (stream
);
1437 while (nlines
-- > 0)
1444 last_line_listed
= current_source_line
;
1445 if (flags
& PRINT_SOURCE_LINES_FILENAME
)
1447 ui_out_text (uiout
, symtab_to_filename_for_display (s
));
1448 ui_out_text (uiout
, ":");
1450 xsnprintf (buf
, sizeof (buf
), "%d\t", current_source_line
++);
1451 ui_out_text (uiout
, buf
);
1454 if (c
< 040 && c
!= '\t' && c
!= '\n' && c
!= '\r')
1456 xsnprintf (buf
, sizeof (buf
), "^%c", c
+ 0100);
1457 ui_out_text (uiout
, buf
);
1460 ui_out_text (uiout
, "^?");
1463 /* Skip a \r character, but only before a \n. */
1464 int c1
= fgetc (stream
);
1467 printf_filtered ("^%c", c
+ 0100);
1469 ungetc (c1
, stream
);
1473 xsnprintf (buf
, sizeof (buf
), "%c", c
);
1474 ui_out_text (uiout
, buf
);
1477 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1480 do_cleanups (cleanup
);
1483 /* Show source lines from the file of symtab S, starting with line
1484 number LINE and stopping before line number STOPLINE. If this is
1485 not the command line version, then the source is shown in the source
1486 window otherwise it is simply printed. */
1489 print_source_lines (struct symtab
*s
, int line
, int stopline
,
1490 enum print_source_lines_flags flags
)
1492 print_source_lines_base (s
, line
, stopline
, flags
);
1495 /* Print info on range of pc's in a specified line. */
1498 line_info (char *arg
, int from_tty
)
1500 struct symtabs_and_lines sals
;
1501 struct symtab_and_line sal
;
1502 CORE_ADDR start_pc
, end_pc
;
1504 struct cleanup
*cleanups
;
1506 init_sal (&sal
); /* initialize to zeroes */
1510 sal
.symtab
= current_source_symtab
;
1511 sal
.pspace
= current_program_space
;
1512 if (last_line_listed
!= 0)
1513 sal
.line
= last_line_listed
;
1515 sal
.line
= current_source_line
;
1518 sals
.sals
= XNEW (struct symtab_and_line
);
1523 sals
= decode_line_with_last_displayed (arg
, DECODE_LINE_LIST_MODE
);
1528 cleanups
= make_cleanup (xfree
, sals
.sals
);
1530 /* C++ More than one line may have been specified, as when the user
1531 specifies an overloaded function name. Print info on them all. */
1532 for (i
= 0; i
< sals
.nelts
; i
++)
1535 if (sal
.pspace
!= current_program_space
)
1538 if (sal
.symtab
== 0)
1540 struct gdbarch
*gdbarch
= get_current_arch ();
1542 printf_filtered (_("No line number information available"));
1545 /* This is useful for "info line *0x7f34". If we can't tell the
1546 user about a source line, at least let them have the symbolic
1548 printf_filtered (" for address ");
1550 print_address (gdbarch
, sal
.pc
, gdb_stdout
);
1553 printf_filtered (".");
1554 printf_filtered ("\n");
1556 else if (sal
.line
> 0
1557 && find_line_pc_range (sal
, &start_pc
, &end_pc
))
1559 struct gdbarch
*gdbarch
1560 = get_objfile_arch (SYMTAB_OBJFILE (sal
.symtab
));
1562 if (start_pc
== end_pc
)
1564 printf_filtered ("Line %d of \"%s\"",
1566 symtab_to_filename_for_display (sal
.symtab
));
1568 printf_filtered (" is at address ");
1569 print_address (gdbarch
, start_pc
, gdb_stdout
);
1571 printf_filtered (" but contains no code.\n");
1575 printf_filtered ("Line %d of \"%s\"",
1577 symtab_to_filename_for_display (sal
.symtab
));
1579 printf_filtered (" starts at address ");
1580 print_address (gdbarch
, start_pc
, gdb_stdout
);
1582 printf_filtered (" and ends at ");
1583 print_address (gdbarch
, end_pc
, gdb_stdout
);
1584 printf_filtered (".\n");
1587 /* x/i should display this line's code. */
1588 set_next_address (gdbarch
, start_pc
);
1590 /* Repeating "info line" should do the following line. */
1591 last_line_listed
= sal
.line
+ 1;
1593 /* If this is the only line, show the source code. If it could
1594 not find the file, don't do anything special. */
1595 if (annotation_level
&& sals
.nelts
== 1)
1596 identify_source_line (sal
.symtab
, sal
.line
, 0, start_pc
);
1599 /* Is there any case in which we get here, and have an address
1600 which the user would want to see? If we have debugging symbols
1601 and no line numbers? */
1602 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1603 sal
.line
, symtab_to_filename_for_display (sal
.symtab
));
1605 do_cleanups (cleanups
);
1608 /* Commands to search the source file for a regexp. */
1611 forward_search_command (char *regex
, int from_tty
)
1618 struct cleanup
*cleanups
;
1620 line
= last_line_listed
+ 1;
1622 msg
= (char *) re_comp (regex
);
1624 error (("%s"), msg
);
1626 if (current_source_symtab
== 0)
1627 select_source_symtab (0);
1629 desc
= open_source_file (current_source_symtab
);
1631 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1632 cleanups
= make_cleanup_close (desc
);
1634 if (current_source_symtab
->line_charpos
== 0)
1635 find_source_lines (current_source_symtab
, desc
);
1637 if (line
< 1 || line
> current_source_symtab
->nlines
)
1638 error (_("Expression not found"));
1640 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1641 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1643 discard_cleanups (cleanups
);
1644 stream
= fdopen (desc
, FDOPEN_MODE
);
1646 cleanups
= make_cleanup_fclose (stream
);
1649 static char *buf
= NULL
;
1651 int cursize
, newsize
;
1654 buf
= (char *) xmalloc (cursize
);
1663 if (p
- buf
== cursize
)
1665 newsize
= cursize
+ cursize
/ 2;
1666 buf
= (char *) xrealloc (buf
, newsize
);
1671 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1673 /* Remove the \r, if any, at the end of the line, otherwise
1674 regular expressions that end with $ or \n won't work. */
1675 if (p
- buf
> 1 && p
[-2] == '\r')
1681 /* We now have a source line in buf, null terminate and match. */
1683 if (re_exec (buf
) > 0)
1686 do_cleanups (cleanups
);
1687 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1688 set_internalvar_integer (lookup_internalvar ("_"), line
);
1689 current_source_line
= max (line
- lines_to_list
/ 2, 1);
1695 printf_filtered (_("Expression not found\n"));
1696 do_cleanups (cleanups
);
1700 reverse_search_command (char *regex
, int from_tty
)
1707 struct cleanup
*cleanups
;
1709 line
= last_line_listed
- 1;
1711 msg
= (char *) re_comp (regex
);
1713 error (("%s"), msg
);
1715 if (current_source_symtab
== 0)
1716 select_source_symtab (0);
1718 desc
= open_source_file (current_source_symtab
);
1720 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1721 cleanups
= make_cleanup_close (desc
);
1723 if (current_source_symtab
->line_charpos
== 0)
1724 find_source_lines (current_source_symtab
, desc
);
1726 if (line
< 1 || line
> current_source_symtab
->nlines
)
1727 error (_("Expression not found"));
1729 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1730 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1732 discard_cleanups (cleanups
);
1733 stream
= fdopen (desc
, FDOPEN_MODE
);
1735 cleanups
= make_cleanup_fclose (stream
);
1738 /* FIXME!!! We walk right off the end of buf if we get a long line!!! */
1739 char buf
[4096]; /* Should be reasonable??? */
1749 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1751 /* Remove the \r, if any, at the end of the line, otherwise
1752 regular expressions that end with $ or \n won't work. */
1753 if (p
- buf
> 1 && p
[-2] == '\r')
1759 /* We now have a source line in buf; null terminate and match. */
1761 if (re_exec (buf
) > 0)
1764 do_cleanups (cleanups
);
1765 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1766 set_internalvar_integer (lookup_internalvar ("_"), line
);
1767 current_source_line
= max (line
- lines_to_list
/ 2, 1);
1771 if (fseek (stream
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1773 const char *filename
;
1775 do_cleanups (cleanups
);
1776 filename
= symtab_to_filename_for_display (current_source_symtab
);
1777 perror_with_name (filename
);
1781 printf_filtered (_("Expression not found\n"));
1782 do_cleanups (cleanups
);
1786 /* If the last character of PATH is a directory separator, then strip it. */
1789 strip_trailing_directory_separator (char *path
)
1791 const int last
= strlen (path
) - 1;
1794 return; /* No stripping is needed if PATH is the empty string. */
1796 if (IS_DIR_SEPARATOR (path
[last
]))
1800 /* Return the path substitution rule that matches FROM.
1801 Return NULL if no rule matches. */
1803 static struct substitute_path_rule
*
1804 find_substitute_path_rule (const char *from
)
1806 struct substitute_path_rule
*rule
= substitute_path_rules
;
1808 while (rule
!= NULL
)
1810 if (FILENAME_CMP (rule
->from
, from
) == 0)
1818 /* Add a new substitute-path rule at the end of the current list of rules.
1819 The new rule will replace FROM into TO. */
1822 add_substitute_path_rule (char *from
, char *to
)
1824 struct substitute_path_rule
*rule
;
1825 struct substitute_path_rule
*new_rule
= XNEW (struct substitute_path_rule
);
1827 new_rule
->from
= xstrdup (from
);
1828 new_rule
->to
= xstrdup (to
);
1829 new_rule
->next
= NULL
;
1831 /* If the list of rules are empty, then insert the new rule
1832 at the head of the list. */
1834 if (substitute_path_rules
== NULL
)
1836 substitute_path_rules
= new_rule
;
1840 /* Otherwise, skip to the last rule in our list and then append
1843 rule
= substitute_path_rules
;
1844 while (rule
->next
!= NULL
)
1847 rule
->next
= new_rule
;
1850 /* Remove the given source path substitution rule from the current list
1851 of rules. The memory allocated for that rule is also deallocated. */
1854 delete_substitute_path_rule (struct substitute_path_rule
*rule
)
1856 if (rule
== substitute_path_rules
)
1857 substitute_path_rules
= rule
->next
;
1860 struct substitute_path_rule
*prev
= substitute_path_rules
;
1862 while (prev
!= NULL
&& prev
->next
!= rule
)
1865 gdb_assert (prev
!= NULL
);
1867 prev
->next
= rule
->next
;
1875 /* Implement the "show substitute-path" command. */
1878 show_substitute_path_command (char *args
, int from_tty
)
1880 struct substitute_path_rule
*rule
= substitute_path_rules
;
1883 struct cleanup
*cleanup
;
1885 argv
= gdb_buildargv (args
);
1886 cleanup
= make_cleanup_freeargv (argv
);
1888 /* We expect zero or one argument. */
1890 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1891 error (_("Too many arguments in command"));
1893 if (argv
!= NULL
&& argv
[0] != NULL
)
1896 /* Print the substitution rules. */
1900 (_("Source path substitution rule matching `%s':\n"), from
);
1902 printf_filtered (_("List of all source path substitution rules:\n"));
1904 while (rule
!= NULL
)
1906 if (from
== NULL
|| substitute_path_rule_matches (rule
, from
) != 0)
1907 printf_filtered (" `%s' -> `%s'.\n", rule
->from
, rule
->to
);
1911 do_cleanups (cleanup
);
1914 /* Implement the "unset substitute-path" command. */
1917 unset_substitute_path_command (char *args
, int from_tty
)
1919 struct substitute_path_rule
*rule
= substitute_path_rules
;
1920 char **argv
= gdb_buildargv (args
);
1923 struct cleanup
*cleanup
;
1925 /* This function takes either 0 or 1 argument. */
1927 cleanup
= make_cleanup_freeargv (argv
);
1928 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1929 error (_("Incorrect usage, too many arguments in command"));
1931 if (argv
!= NULL
&& argv
[0] != NULL
)
1934 /* If the user asked for all the rules to be deleted, ask him
1935 to confirm and give him a chance to abort before the action
1939 && !query (_("Delete all source path substitution rules? ")))
1940 error (_("Canceled"));
1942 /* Delete the rule matching the argument. No argument means that
1943 all rules should be deleted. */
1945 while (rule
!= NULL
)
1947 struct substitute_path_rule
*next
= rule
->next
;
1949 if (from
== NULL
|| FILENAME_CMP (from
, rule
->from
) == 0)
1951 delete_substitute_path_rule (rule
);
1958 /* If the user asked for a specific rule to be deleted but
1959 we could not find it, then report an error. */
1961 if (from
!= NULL
&& !rule_found
)
1962 error (_("No substitution rule defined for `%s'"), from
);
1964 forget_cached_source_info ();
1966 do_cleanups (cleanup
);
1969 /* Add a new source path substitution rule. */
1972 set_substitute_path_command (char *args
, int from_tty
)
1975 struct substitute_path_rule
*rule
;
1976 struct cleanup
*cleanup
;
1978 argv
= gdb_buildargv (args
);
1979 cleanup
= make_cleanup_freeargv (argv
);
1981 if (argv
== NULL
|| argv
[0] == NULL
|| argv
[1] == NULL
)
1982 error (_("Incorrect usage, too few arguments in command"));
1984 if (argv
[2] != NULL
)
1985 error (_("Incorrect usage, too many arguments in command"));
1987 if (*(argv
[0]) == '\0')
1988 error (_("First argument must be at least one character long"));
1990 /* Strip any trailing directory separator character in either FROM
1991 or TO. The substitution rule already implicitly contains them. */
1992 strip_trailing_directory_separator (argv
[0]);
1993 strip_trailing_directory_separator (argv
[1]);
1995 /* If a rule with the same "from" was previously defined, then
1996 delete it. This new rule replaces it. */
1998 rule
= find_substitute_path_rule (argv
[0]);
2000 delete_substitute_path_rule (rule
);
2002 /* Insert the new substitution rule. */
2004 add_substitute_path_rule (argv
[0], argv
[1]);
2005 forget_cached_source_info ();
2007 do_cleanups (cleanup
);
2012 _initialize_source (void)
2014 struct cmd_list_element
*c
;
2016 current_source_symtab
= 0;
2017 init_source_path ();
2019 /* The intention is to use POSIX Basic Regular Expressions.
2020 Always use the GNU regex routine for consistency across all hosts.
2021 Our current GNU regex.c does not have all the POSIX features, so this is
2022 just an approximation. */
2023 re_set_syntax (RE_SYNTAX_GREP
);
2025 c
= add_cmd ("directory", class_files
, directory_command
, _("\
2026 Add directory DIR to beginning of search path for source files.\n\
2027 Forget cached info on source file locations and line positions.\n\
2028 DIR can also be $cwd for the current working directory, or $cdir for the\n\
2029 directory in which the source file was compiled into object code.\n\
2030 With no argument, reset the search path to $cdir:$cwd, the default."),
2034 add_com_alias ("use", "directory", class_files
, 0);
2036 set_cmd_completer (c
, filename_completer
);
2038 add_setshow_optional_filename_cmd ("directories",
2042 Set the search path for finding source files."),
2044 Show the search path for finding source files."),
2046 $cwd in the path means the current working directory.\n\
2047 $cdir in the path means the compilation directory of the source file.\n\
2048 GDB ensures the search path always ends with $cdir:$cwd by\n\
2049 appending these directories if necessary.\n\
2050 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
2051 set_directories_command
,
2052 show_directories_command
,
2053 &setlist
, &showlist
);
2055 add_info ("source", source_info
,
2056 _("Information about the current source file."));
2058 add_info ("line", line_info
, _("\
2059 Core addresses of the code for a source line.\n\
2060 Line can be specified as\n\
2061 LINENUM, to list around that line in current file,\n\
2062 FILE:LINENUM, to list around that line in that file,\n\
2063 FUNCTION, to list around beginning of that function,\n\
2064 FILE:FUNCTION, to distinguish among like-named static functions.\n\
2065 Default is to describe the last source line that was listed.\n\n\
2066 This sets the default address for \"x\" to the line's first instruction\n\
2067 so that \"x/i\" suffices to start examining the machine code.\n\
2068 The address is also stored as the value of \"$_\"."));
2070 add_com ("forward-search", class_files
, forward_search_command
, _("\
2071 Search for regular expression (see regex(3)) from last line listed.\n\
2072 The matching line number is also stored as the value of \"$_\"."));
2073 add_com_alias ("search", "forward-search", class_files
, 0);
2074 add_com_alias ("fo", "forward-search", class_files
, 1);
2076 add_com ("reverse-search", class_files
, reverse_search_command
, _("\
2077 Search backward for regular expression (see regex(3)) from last line listed.\n\
2078 The matching line number is also stored as the value of \"$_\"."));
2079 add_com_alias ("rev", "reverse-search", class_files
, 1);
2081 add_setshow_integer_cmd ("listsize", class_support
, &lines_to_list
, _("\
2082 Set number of source lines gdb will list by default."), _("\
2083 Show number of source lines gdb will list by default."), _("\
2084 Use this to choose how many source lines the \"list\" displays (unless\n\
2085 the \"list\" argument explicitly specifies some other number).\n\
2086 A value of \"unlimited\", or zero, means there's no limit."),
2089 &setlist
, &showlist
);
2091 add_cmd ("substitute-path", class_files
, set_substitute_path_command
,
2093 Usage: set substitute-path FROM TO\n\
2094 Add a substitution rule replacing FROM into TO in source file names.\n\
2095 If a substitution rule was previously set for FROM, the old rule\n\
2096 is replaced by the new one."),
2099 add_cmd ("substitute-path", class_files
, unset_substitute_path_command
,
2101 Usage: unset substitute-path [FROM]\n\
2102 Delete the rule for substituting FROM in source file names. If FROM\n\
2103 is not specified, all substituting rules are deleted.\n\
2104 If the debugger cannot find a rule for FROM, it will display a warning."),
2107 add_cmd ("substitute-path", class_files
, show_substitute_path_command
,
2109 Usage: show substitute-path [FROM]\n\
2110 Print the rule for substituting FROM in source file names. If FROM\n\
2111 is not specified, print all substitution rules."),
2114 add_setshow_enum_cmd ("filename-display", class_files
,
2115 filename_display_kind_names
,
2116 &filename_display_string
, _("\
2117 Set how to display filenames."), _("\
2118 Show how to display filenames."), _("\
2119 filename-display can be:\n\
2120 basename - display only basename of a filename\n\
2121 relative - display a filename relative to the compilation directory\n\
2122 absolute - display an absolute filename\n\
2123 By default, relative filenames are displayed."),
2125 show_filename_display_string
,
2126 &setlist
, &showlist
);