1 /* List lines of source files for GDB, the GNU debugger.
2 Copyright (C) 1986-2013 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 "gdb_assert.h"
30 #include "filestuff.h"
32 #include <sys/types.h>
33 #include "gdb_string.h"
37 #include "gdb_regex.h"
43 #include "filenames.h" /* for DOSish file names */
44 #include "completer.h"
46 #include "readline/readline.h"
48 #define OPEN_MODE (O_RDONLY | O_BINARY)
49 #define FDOPEN_MODE FOPEN_RB
51 /* Prototypes for exported functions. */
53 void _initialize_source (void);
55 /* Prototypes for local functions. */
57 static int get_filename_and_charpos (struct symtab
*, char **);
59 static void reverse_search_command (char *, int);
61 static void forward_search_command (char *, int);
63 static void line_info (char *, int);
65 static void source_info (char *, int);
67 /* Path of directories to search for source files.
68 Same format as the PATH environment variable's value. */
72 /* Support for source path substitution commands. */
74 struct substitute_path_rule
78 struct substitute_path_rule
*next
;
81 static struct substitute_path_rule
*substitute_path_rules
= NULL
;
83 /* Symtab of default file for listing lines of. */
85 static struct symtab
*current_source_symtab
;
87 /* Default next line to list. */
89 static int current_source_line
;
91 static struct program_space
*current_source_pspace
;
93 /* Default number of lines to print with commands like "list".
94 This is based on guessing how many long (i.e. more than chars_per_line
95 characters) lines there will be. To be completely correct, "list"
96 and friends should be rewritten to count characters and see where
97 things are wrapping, but that would be a fair amount of work. */
99 int lines_to_list
= 10;
101 show_lines_to_list (struct ui_file
*file
, int from_tty
,
102 struct cmd_list_element
*c
, const char *value
)
104 fprintf_filtered (file
,
105 _("Number of source lines gdb "
106 "will list by default is %s.\n"),
110 /* Possible values of 'set filename-display'. */
111 static const char filename_display_basename
[] = "basename";
112 static const char filename_display_relative
[] = "relative";
113 static const char filename_display_absolute
[] = "absolute";
115 static const char *const filename_display_kind_names
[] = {
116 filename_display_basename
,
117 filename_display_relative
,
118 filename_display_absolute
,
122 static const char *filename_display_string
= filename_display_relative
;
125 show_filename_display_string (struct ui_file
*file
, int from_tty
,
126 struct cmd_list_element
*c
, const char *value
)
128 fprintf_filtered (file
, _("Filenames are displayed as \"%s\".\n"), value
);
131 /* Line number of last line printed. Default for various commands.
132 current_source_line is usually, but not always, the same as this. */
134 static int last_line_listed
;
136 /* First line number listed by last listing command. */
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 /* 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 struct symtab_and_line cursal
= { 0 };
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 struct symtab_and_line
*sal
)
211 struct symtab_and_line cursal
= { 0 };
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
;
226 /* Reset any information stored about a default file and line to print. */
229 clear_current_source_symtab_and_line (void)
231 current_source_symtab
= 0;
232 current_source_line
= 0;
235 /* Set the source file default for the "list" command to be S.
237 If S is NULL, and we don't have a default, find one. This
238 should only be called when the user actually tries to use the
239 default, since we produce an error if we can't find a reasonable
240 default. Also, since this can cause symbols to be read, doing it
241 before we need to would make things slower than necessary. */
244 select_source_symtab (struct symtab
*s
)
246 struct symtabs_and_lines sals
;
247 struct symtab_and_line sal
;
252 current_source_symtab
= s
;
253 current_source_line
= 1;
254 current_source_pspace
= SYMTAB_PSPACE (s
);
258 if (current_source_symtab
)
261 /* Make the default place to list be the function `main'
263 if (lookup_symbol (main_name (), 0, VAR_DOMAIN
, 0))
265 sals
= decode_line_with_current_source (main_name (),
266 DECODE_LINE_FUNFIRSTLINE
);
269 current_source_pspace
= sal
.pspace
;
270 current_source_symtab
= sal
.symtab
;
271 current_source_line
= max (sal
.line
- (lines_to_list
- 1), 1);
272 if (current_source_symtab
)
276 /* Alright; find the last file in the symtab list (ignoring .h's
277 and namespace symtabs). */
279 current_source_line
= 1;
283 for (s
= ofp
->symtabs
; s
; s
= s
->next
)
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
;
297 if (current_source_symtab
)
303 s
= ofp
->sf
->qf
->find_last_source_symtab (ofp
);
305 current_source_symtab
= s
;
307 if (current_source_symtab
)
310 error (_("Can't find a default source file"));
313 /* Handler for "set directories path-list" command.
314 "set dir mumble" doesn't prepend paths, it resets the entire
315 path list. The theory is that set(show(dir)) should be a no-op. */
318 set_directories_command (char *args
, 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
)
364 ALL_OBJFILE_SYMTABS (objfile
, s
)
366 if (s
->line_charpos
!= NULL
)
368 xfree (s
->line_charpos
);
369 s
->line_charpos
= NULL
;
371 if (s
->fullname
!= NULL
)
379 objfile
->sf
->qf
->forget_cached_source_info (objfile
);
382 /* Forget what we learned about line positions in source files, and
383 which directories contain them; must check again now since files
384 may be found in a different directory now. */
387 forget_cached_source_info (void)
389 struct program_space
*pspace
;
390 struct objfile
*objfile
;
393 ALL_PSPACE_OBJFILES (pspace
, objfile
)
395 forget_cached_source_info_for_objfile (objfile
);
398 last_source_visited
= NULL
;
402 init_source_path (void)
406 xsnprintf (buf
, sizeof (buf
), "$cdir%c$cwd", DIRNAME_SEPARATOR
);
407 source_path
= xstrdup (buf
);
408 forget_cached_source_info ();
411 /* Add zero or more directories to the front of the source path. */
414 directory_command (char *dirname
, int from_tty
)
417 /* FIXME, this goes to "delete dir"... */
420 if (!from_tty
|| query (_("Reinitialize source path to empty? ")))
428 mod_path (dirname
, &source_path
);
429 forget_cached_source_info ();
432 show_directories_1 ((char *) 0, from_tty
);
435 /* Add a path given with the -d command line switch.
436 This will not be quoted so we must not treat spaces as separators. */
439 directory_switch (char *dirname
, int from_tty
)
441 add_path (dirname
, &source_path
, 0);
444 /* Add zero or more directories to the front of an arbitrary path. */
447 mod_path (char *dirname
, char **which_path
)
449 add_path (dirname
, which_path
, 1);
452 /* Workhorse of mod_path. Takes an extra argument to determine
453 if dirname should be parsed for separators that indicate multiple
454 directories. This allows for interfaces that pre-parse the dirname
455 and allow specification of traditional separator characters such
459 add_path (char *dirname
, char **which_path
, int parse_separators
)
461 char *old
= *which_path
;
463 VEC (char_ptr
) *dir_vec
= NULL
;
464 struct cleanup
*back_to
;
471 if (parse_separators
)
473 char **argv
, **argvp
;
475 /* This will properly parse the space and tab separators
476 and any quotes that may exist. */
477 argv
= gdb_buildargv (dirname
);
479 for (argvp
= argv
; *argvp
; argvp
++)
480 dirnames_to_char_ptr_vec_append (&dir_vec
, *argvp
);
485 VEC_safe_push (char_ptr
, dir_vec
, xstrdup (dirname
));
486 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
488 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, name
); ++ix
)
493 /* Spaces and tabs will have been removed by buildargv().
494 NAME is the start of the directory.
495 P is the '\0' following the end. */
496 p
= name
+ strlen (name
);
498 while (!(IS_DIR_SEPARATOR (*name
) && p
<= name
+ 1) /* "/" */
499 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
500 /* On MS-DOS and MS-Windows, h:\ is different from h: */
501 && !(p
== name
+ 3 && name
[1] == ':') /* "d:/" */
503 && IS_DIR_SEPARATOR (p
[-1]))
504 /* Sigh. "foo/" => "foo" */
508 while (p
> name
&& p
[-1] == '.')
512 /* "." => getwd (). */
513 name
= current_directory
;
516 else if (p
> name
+ 1 && IS_DIR_SEPARATOR (p
[-2]))
526 /* "...foo/." => "...foo". */
537 name
= tilde_expand (name
);
538 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
539 else if (IS_ABSOLUTE_PATH (name
) && p
== name
+ 2) /* "d:" => "d:." */
540 name
= concat (name
, ".", (char *)NULL
);
542 else if (!IS_ABSOLUTE_PATH (name
) && name
[0] != '$')
543 name
= concat (current_directory
, SLASH_STRING
, name
, (char *)NULL
);
545 name
= savestring (name
, p
- name
);
546 make_cleanup (xfree
, name
);
548 /* Unless it's a variable, check existence. */
551 /* These are warnings, not errors, since we don't want a
552 non-existent directory in a .gdbinit file to stop processing
553 of the .gdbinit file.
555 Whether they get added to the path is more debatable. Current
556 answer is yes, in case the user wants to go make the directory
557 or whatever. If the directory continues to not exist/not be
558 a directory/etc, then having them in the path should be
560 if (stat (name
, &st
) < 0)
562 int save_errno
= errno
;
564 fprintf_unfiltered (gdb_stderr
, "Warning: ");
565 print_sys_errmsg (name
, save_errno
);
567 else if ((st
.st_mode
& S_IFMT
) != S_IFDIR
)
568 warning (_("%s is not a directory."), name
);
573 unsigned int len
= strlen (name
);
577 /* FIXME: we should use realpath() or its work-alike
578 before comparing. Then all the code above which
579 removes excess slashes and dots could simply go away. */
580 if (!filename_cmp (p
, name
))
582 /* Found it in the search path, remove old copy. */
584 p
--; /* Back over leading separator. */
585 if (prefix
> p
- *which_path
)
586 goto skip_dup
; /* Same dir twice in one cmd. */
587 memmove (p
, &p
[len
+ 1], strlen (&p
[len
+ 1]) + 1); /* Copy from next \0 or : */
590 tinybuf
[0] = DIRNAME_SEPARATOR
;
593 /* If we have already tacked on a name(s) in this command,
594 be sure they stay on the front as we tack on some
602 temp
= concat (old
, tinybuf
, name
, (char *)NULL
);
604 *which_path
= concat (temp
, "", &old
[prefix
], (char *) NULL
);
605 prefix
= strlen (temp
);
610 *which_path
= concat (name
, (old
[0] ? tinybuf
: old
),
612 prefix
= strlen (name
);
621 do_cleanups (back_to
);
626 source_info (char *ignore
, int from_tty
)
628 struct symtab
*s
= current_source_symtab
;
632 printf_filtered (_("No current source file.\n"));
635 printf_filtered (_("Current source file is %s\n"), s
->filename
);
637 printf_filtered (_("Compilation directory is %s\n"), s
->dirname
);
639 printf_filtered (_("Located in %s\n"), s
->fullname
);
641 printf_filtered (_("Contains %d line%s.\n"), s
->nlines
,
642 s
->nlines
== 1 ? "" : "s");
644 printf_filtered (_("Source language is %s.\n"), language_str (s
->language
));
645 printf_filtered (_("Compiled with %s debugging format.\n"), s
->debugformat
);
646 printf_filtered (_("%s preprocessor macro info.\n"),
647 s
->macro_table
? "Includes" : "Does not include");
651 /* Return True if the file NAME exists and is a regular file. */
653 is_regular_file (const char *name
)
656 const int status
= stat (name
, &st
);
658 /* Stat should never fail except when the file does not exist.
659 If stat fails, analyze the source of error and return True
660 unless the file does not exist, to avoid returning false results
661 on obscure systems where stat does not work as expected. */
664 return (errno
!= ENOENT
);
666 return S_ISREG (st
.st_mode
);
669 /* Open a file named STRING, searching path PATH (dir names sep by some char)
670 using mode MODE in the calls to open. You cannot use this function to
671 create files (O_CREAT).
673 OPTS specifies the function behaviour in specific cases.
675 If OPF_TRY_CWD_FIRST, try to open ./STRING before searching PATH.
676 (ie pretend the first element of PATH is "."). This also indicates
677 that, unless OPF_SEARCH_IN_PATH is also specified, a slash in STRING
678 disables searching of the path (this is so that "exec-file ./foo" or
679 "symbol-file ./foo" insures that you get that particular version of
680 foo or an error message).
682 If OPTS has OPF_SEARCH_IN_PATH set, absolute names will also be
683 searched in path (we usually want this for source files but not for
686 If FILENAME_OPENED is non-null, set it to a newly allocated string naming
687 the actual file opened (this string will always start with a "/"). We
688 have to take special pains to avoid doubling the "/" between the directory
689 and the file, sigh! Emacs gets confuzzed by this when we print the
692 If OPTS does not have OPF_DISABLE_REALPATH set return FILENAME_OPENED
693 resolved by gdb_realpath. Even with OPF_DISABLE_REALPATH this function
694 still returns filename starting with "/". If FILENAME_OPENED is NULL
695 this option has no effect.
697 If a file is found, return the descriptor.
698 Otherwise, return -1, with errno set for the last name we tried to open. */
700 /* >>>> This should only allow files of certain types,
701 >>>> eg executable, non-directory. */
703 openp (const char *path
, int opts
, const char *string
,
704 int mode
, char **filename_opened
)
709 VEC (char_ptr
) *dir_vec
;
710 struct cleanup
*back_to
;
714 /* The open syscall MODE parameter is not specified. */
715 gdb_assert ((mode
& O_CREAT
) == 0);
716 gdb_assert (string
!= NULL
);
718 /* A file with an empty name cannot possibly exist. Report a failure
719 without further checking.
721 This is an optimization which also defends us against buggy
722 implementations of the "stat" function. For instance, we have
723 noticed that a MinGW debugger built on Windows XP 32bits crashes
724 when the debugger is started with an empty argument. */
725 if (string
[0] == '\0')
736 if ((opts
& OPF_TRY_CWD_FIRST
) || IS_ABSOLUTE_PATH (string
))
740 if (is_regular_file (string
))
742 filename
= alloca (strlen (string
) + 1);
743 strcpy (filename
, string
);
744 fd
= gdb_open_cloexec (filename
, mode
, 0);
754 if (!(opts
& OPF_SEARCH_IN_PATH
))
755 for (i
= 0; string
[i
]; i
++)
756 if (IS_DIR_SEPARATOR (string
[i
]))
760 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
761 if (HAS_DRIVE_SPEC (string
))
762 string
= STRIP_DRIVE_SPEC (string
);
764 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
765 while (IS_DIR_SEPARATOR(string
[0]))
769 while (string
[0] == '.' && IS_DIR_SEPARATOR (string
[1]))
772 alloclen
= strlen (path
) + strlen (string
) + 2;
773 filename
= alloca (alloclen
);
776 dir_vec
= dirnames_to_char_ptr_vec (path
);
777 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
779 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, dir
); ++ix
)
781 size_t len
= strlen (dir
);
783 if (strcmp (dir
, "$cwd") == 0)
785 /* Name is $cwd -- insert current directory name instead. */
788 /* First, realloc the filename buffer if too short. */
789 len
= strlen (current_directory
);
790 newlen
= len
+ strlen (string
) + 2;
791 if (newlen
> alloclen
)
794 filename
= alloca (alloclen
);
796 strcpy (filename
, current_directory
);
798 else if (strchr(dir
, '~'))
800 /* See whether we need to expand the tilde. */
802 char *tilde_expanded
;
804 tilde_expanded
= tilde_expand (dir
);
806 /* First, realloc the filename buffer if too short. */
807 len
= strlen (tilde_expanded
);
808 newlen
= len
+ strlen (string
) + 2;
809 if (newlen
> alloclen
)
812 filename
= alloca (alloclen
);
814 strcpy (filename
, tilde_expanded
);
815 xfree (tilde_expanded
);
819 /* Normal file name in path -- just use it. */
820 strcpy (filename
, dir
);
822 /* Don't search $cdir. It's also a magic path like $cwd, but we
823 don't have enough information to expand it. The user *could*
824 have an actual directory named '$cdir' but handling that would
825 be confusing, it would mean different things in different
826 contexts. If the user really has '$cdir' one can use './$cdir'.
827 We can get $cdir when loading scripts. When loading source files
828 $cdir must have already been expanded to the correct value. */
829 if (strcmp (dir
, "$cdir") == 0)
833 /* Remove trailing slashes. */
834 while (len
> 0 && IS_DIR_SEPARATOR (filename
[len
- 1]))
837 strcat (filename
+ len
, SLASH_STRING
);
838 strcat (filename
, string
);
840 if (is_regular_file (filename
))
842 fd
= gdb_open_cloexec (filename
, mode
, 0);
848 do_cleanups (back_to
);
853 /* If a file was opened, canonicalize its filename. */
855 *filename_opened
= NULL
;
858 char *(*realpath_fptr
) (const char *);
860 realpath_fptr
= ((opts
& OPF_DISABLE_REALPATH
) != 0
861 ? xstrdup
: gdb_realpath
);
863 if (IS_ABSOLUTE_PATH (filename
))
864 *filename_opened
= realpath_fptr (filename
);
867 /* Beware the // my son, the Emacs barfs, the botch that catch... */
869 char *f
= concat (current_directory
,
870 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
872 filename
, (char *)NULL
);
874 *filename_opened
= realpath_fptr (f
);
884 /* This is essentially a convenience, for clients that want the behaviour
885 of openp, using source_path, but that really don't want the file to be
886 opened but want instead just to know what the full pathname is (as
887 qualified against source_path).
889 The current working directory is searched first.
891 If the file was found, this function returns 1, and FULL_PATHNAME is
892 set to the fully-qualified pathname.
894 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
896 source_full_path_of (const char *filename
, char **full_pathname
)
900 fd
= openp (source_path
, OPF_TRY_CWD_FIRST
| OPF_SEARCH_IN_PATH
, filename
,
901 O_RDONLY
, full_pathname
);
904 *full_pathname
= NULL
;
912 /* Return non-zero if RULE matches PATH, that is if the rule can be
916 substitute_path_rule_matches (const struct substitute_path_rule
*rule
,
919 const int from_len
= strlen (rule
->from
);
920 const int path_len
= strlen (path
);
923 if (path_len
< from_len
)
926 /* The substitution rules are anchored at the start of the path,
927 so the path should start with rule->from. There is no filename
928 comparison routine, so we need to extract the first FROM_LEN
929 characters from PATH first and use that to do the comparison. */
931 path_start
= alloca (from_len
+ 1);
932 strncpy (path_start
, path
, from_len
);
933 path_start
[from_len
] = '\0';
935 if (FILENAME_CMP (path_start
, rule
->from
) != 0)
938 /* Make sure that the region in the path that matches the substitution
939 rule is immediately followed by a directory separator (or the end of
940 string character). */
942 if (path
[from_len
] != '\0' && !IS_DIR_SEPARATOR (path
[from_len
]))
948 /* Find the substitute-path rule that applies to PATH and return it.
949 Return NULL if no rule applies. */
951 static struct substitute_path_rule
*
952 get_substitute_path_rule (const char *path
)
954 struct substitute_path_rule
*rule
= substitute_path_rules
;
956 while (rule
!= NULL
&& !substitute_path_rule_matches (rule
, path
))
962 /* If the user specified a source path substitution rule that applies
963 to PATH, then apply it and return the new path. This new path must
964 be deallocated afterwards.
966 Return NULL if no substitution rule was specified by the user,
967 or if no rule applied to the given PATH. */
970 rewrite_source_path (const char *path
)
972 const struct substitute_path_rule
*rule
= get_substitute_path_rule (path
);
979 from_len
= strlen (rule
->from
);
981 /* Compute the rewritten path and return it. */
984 (char *) xmalloc (strlen (path
) + 1 + strlen (rule
->to
) - from_len
);
985 strcpy (new_path
, rule
->to
);
986 strcat (new_path
, path
+ from_len
);
992 find_and_open_source (const char *filename
,
996 char *path
= source_path
;
999 struct cleanup
*cleanup
;
1001 /* Quick way out if we already know its full name. */
1005 /* The user may have requested that source paths be rewritten
1006 according to substitution rules he provided. If a substitution
1007 rule applies to this path, then apply it. */
1008 char *rewritten_fullname
= rewrite_source_path (*fullname
);
1010 if (rewritten_fullname
!= NULL
)
1013 *fullname
= rewritten_fullname
;
1016 result
= gdb_open_cloexec (*fullname
, OPEN_MODE
, 0);
1019 char *lpath
= gdb_realpath (*fullname
);
1026 /* Didn't work -- free old one, try again. */
1031 cleanup
= make_cleanup (null_cleanup
, NULL
);
1033 if (dirname
!= NULL
)
1035 /* If necessary, rewrite the compilation directory name according
1036 to the source path substitution rules specified by the user. */
1038 char *rewritten_dirname
= rewrite_source_path (dirname
);
1040 if (rewritten_dirname
!= NULL
)
1042 make_cleanup (xfree
, rewritten_dirname
);
1043 dirname
= rewritten_dirname
;
1046 /* Replace a path entry of $cdir with the compilation directory
1049 /* We cast strstr's result in case an ANSIhole has made it const,
1050 which produces a "required warning" when assigned to a nonconst. */
1051 p
= (char *) strstr (source_path
, "$cdir");
1052 if (p
&& (p
== path
|| p
[-1] == DIRNAME_SEPARATOR
)
1053 && (p
[cdir_len
] == DIRNAME_SEPARATOR
|| p
[cdir_len
] == '\0'))
1058 alloca (strlen (source_path
) + 1 + strlen (dirname
) + 1);
1059 len
= p
- source_path
;
1060 strncpy (path
, source_path
, len
); /* Before $cdir */
1061 strcpy (path
+ len
, dirname
); /* new stuff */
1062 strcat (path
+ len
, source_path
+ len
+ cdir_len
); /* After
1067 if (IS_ABSOLUTE_PATH (filename
))
1069 /* If filename is absolute path, try the source path
1070 substitution on it. */
1071 char *rewritten_filename
= rewrite_source_path (filename
);
1073 if (rewritten_filename
!= NULL
)
1075 make_cleanup (xfree
, rewritten_filename
);
1076 filename
= rewritten_filename
;
1080 result
= openp (path
, OPF_SEARCH_IN_PATH
, filename
, OPEN_MODE
, fullname
);
1083 /* Didn't work. Try using just the basename. */
1084 p
= lbasename (filename
);
1086 result
= openp (path
, OPF_SEARCH_IN_PATH
, p
, OPEN_MODE
, fullname
);
1089 do_cleanups (cleanup
);
1093 /* Open a source file given a symtab S. Returns a file descriptor or
1094 negative number for error.
1096 This function is a convience function to find_and_open_source. */
1099 open_source_file (struct symtab
*s
)
1104 return find_and_open_source (s
->filename
, s
->dirname
, &s
->fullname
);
1107 /* Finds the fullname that a symtab represents.
1109 This functions finds the fullname and saves it in s->fullname.
1110 It will also return the value.
1112 If this function fails to find the file that this symtab represents,
1113 the expected fullname is used. Therefore the files does not have to
1117 symtab_to_fullname (struct symtab
*s
)
1119 /* Use cached copy if we have it.
1120 We rely on forget_cached_source_info being called appropriately
1121 to handle cases like the file being moved. */
1122 if (s
->fullname
== NULL
)
1124 int fd
= find_and_open_source (s
->filename
, s
->dirname
, &s
->fullname
);
1131 struct cleanup
*back_to
;
1133 /* rewrite_source_path would be applied by find_and_open_source, we
1134 should report the pathname where GDB tried to find the file. */
1136 if (s
->dirname
== NULL
|| IS_ABSOLUTE_PATH (s
->filename
))
1137 fullname
= xstrdup (s
->filename
);
1139 fullname
= concat (s
->dirname
, SLASH_STRING
, s
->filename
, NULL
);
1141 back_to
= make_cleanup (xfree
, fullname
);
1142 s
->fullname
= rewrite_source_path (fullname
);
1143 if (s
->fullname
== NULL
)
1144 s
->fullname
= xstrdup (fullname
);
1145 do_cleanups (back_to
);
1152 /* See commentary in source.h. */
1155 symtab_to_filename_for_display (struct symtab
*symtab
)
1157 if (filename_display_string
== filename_display_basename
)
1158 return lbasename (symtab
->filename
);
1159 else if (filename_display_string
== filename_display_absolute
)
1160 return symtab_to_fullname (symtab
);
1161 else if (filename_display_string
== filename_display_relative
)
1162 return symtab
->filename
;
1164 internal_error (__FILE__
, __LINE__
, _("invalid filename_display_string"));
1167 /* Create and initialize the table S->line_charpos that records
1168 the positions of the lines in the source file, which is assumed
1169 to be open on descriptor DESC.
1170 All set S->nlines to the number of such lines. */
1173 find_source_lines (struct symtab
*s
, int desc
)
1176 char *data
, *p
, *end
;
1178 int lines_allocated
= 1000;
1184 line_charpos
= (int *) xmalloc (lines_allocated
* sizeof (int));
1185 if (fstat (desc
, &st
) < 0)
1186 perror_with_name (symtab_to_filename_for_display (s
));
1188 if (s
->objfile
&& s
->objfile
->obfd
)
1189 mtime
= s
->objfile
->mtime
;
1191 mtime
= exec_bfd_mtime
;
1193 if (mtime
&& mtime
< st
.st_mtime
)
1194 warning (_("Source file is more recent than executable."));
1197 struct cleanup
*old_cleanups
;
1199 /* st_size might be a large type, but we only support source files whose
1200 size fits in an int. */
1201 size
= (int) st
.st_size
;
1203 /* Use malloc, not alloca, because this may be pretty large, and we may
1204 run into various kinds of limits on stack size. */
1205 data
= (char *) xmalloc (size
);
1206 old_cleanups
= make_cleanup (xfree
, data
);
1208 /* Reassign `size' to result of read for systems where \r\n -> \n. */
1209 size
= myread (desc
, data
, size
);
1211 perror_with_name (symtab_to_filename_for_display (s
));
1214 line_charpos
[0] = 0;
1219 /* A newline at the end does not start a new line. */
1222 if (nlines
== lines_allocated
)
1224 lines_allocated
*= 2;
1226 (int *) xrealloc ((char *) line_charpos
,
1227 sizeof (int) * lines_allocated
);
1229 line_charpos
[nlines
++] = p
- data
;
1232 do_cleanups (old_cleanups
);
1237 (int *) xrealloc ((char *) line_charpos
, nlines
* sizeof (int));
1243 /* Get full pathname and line number positions for a symtab.
1244 Return nonzero if line numbers may have changed.
1245 Set *FULLNAME to actual name of the file as found by `openp',
1246 or to 0 if the file is not found. */
1249 get_filename_and_charpos (struct symtab
*s
, char **fullname
)
1251 int desc
, linenums_changed
= 0;
1252 struct cleanup
*cleanups
;
1254 desc
= open_source_file (s
);
1261 cleanups
= make_cleanup_close (desc
);
1263 *fullname
= s
->fullname
;
1264 if (s
->line_charpos
== 0)
1265 linenums_changed
= 1;
1266 if (linenums_changed
)
1267 find_source_lines (s
, desc
);
1268 do_cleanups (cleanups
);
1269 return linenums_changed
;
1272 /* Print text describing the full name of the source file S
1273 and the line number LINE and its corresponding character position.
1274 The text starts with two Ctrl-z so that the Emacs-GDB interface
1277 MID_STATEMENT is nonzero if the PC is not at the beginning of that line.
1279 Return 1 if successful, 0 if could not find the file. */
1282 identify_source_line (struct symtab
*s
, int line
, int mid_statement
,
1285 if (s
->line_charpos
== 0)
1286 get_filename_and_charpos (s
, (char **) NULL
);
1287 if (s
->fullname
== 0)
1289 if (line
> s
->nlines
)
1290 /* Don't index off the end of the line_charpos array. */
1292 annotate_source (s
->fullname
, line
, s
->line_charpos
[line
- 1],
1293 mid_statement
, get_objfile_arch (s
->objfile
), pc
);
1295 current_source_line
= line
;
1296 first_line_listed
= line
;
1297 last_line_listed
= line
;
1298 current_source_symtab
= s
;
1303 /* Print source lines from the file of symtab S,
1304 starting with line number LINE and stopping before line number STOPLINE. */
1307 print_source_lines_base (struct symtab
*s
, int line
, int stopline
,
1308 enum print_source_lines_flags flags
)
1314 int nlines
= stopline
- line
;
1315 struct cleanup
*cleanup
;
1316 struct ui_out
*uiout
= current_uiout
;
1318 /* Regardless of whether we can open the file, set current_source_symtab. */
1319 current_source_symtab
= s
;
1320 current_source_line
= line
;
1321 first_line_listed
= line
;
1323 /* If printing of source lines is disabled, just print file and line
1325 if (ui_out_test_flags (uiout
, ui_source_list
))
1327 /* Only prints "No such file or directory" once. */
1328 if ((s
!= last_source_visited
) || (!last_source_error
))
1330 last_source_visited
= s
;
1331 desc
= open_source_file (s
);
1335 desc
= last_source_error
;
1336 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1341 desc
= last_source_error
;
1342 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1346 if (desc
< 0 || noprint
)
1348 last_source_error
= desc
;
1350 if (!(flags
& PRINT_SOURCE_LINES_NOERROR
))
1352 const char *filename
= symtab_to_filename_for_display (s
);
1353 int len
= strlen (filename
) + 100;
1354 char *name
= alloca (len
);
1356 xsnprintf (name
, len
, "%d\t%s", line
, filename
);
1357 print_sys_errmsg (name
, errno
);
1361 ui_out_field_int (uiout
, "line", line
);
1362 ui_out_text (uiout
, "\tin ");
1364 /* CLI expects only the "file" field. TUI expects only the
1365 "fullname" field (and TUI does break if "file" is printed).
1366 MI expects both fields. ui_source_list is set only for CLI,
1368 if (ui_out_is_mi_like_p (uiout
)
1369 || ui_out_test_flags (uiout
, ui_source_list
))
1370 ui_out_field_string (uiout
, "file",
1371 symtab_to_filename_for_display (s
));
1372 if (ui_out_is_mi_like_p (uiout
)
1373 || !ui_out_test_flags (uiout
, ui_source_list
))
1375 const char *s_fullname
= symtab_to_fullname (s
);
1376 char *local_fullname
;
1378 /* ui_out_field_string may free S_FULLNAME by calling
1379 open_source_file for it again. See e.g.,
1380 tui_field_string->tui_show_source. */
1381 local_fullname
= alloca (strlen (s_fullname
) + 1);
1382 strcpy (local_fullname
, s_fullname
);
1384 ui_out_field_string (uiout
, "fullname", local_fullname
);
1387 ui_out_text (uiout
, "\n");
1393 last_source_error
= 0;
1395 if (s
->line_charpos
== 0)
1396 find_source_lines (s
, desc
);
1398 if (line
< 1 || line
> s
->nlines
)
1401 error (_("Line number %d out of range; %s has %d lines."),
1402 line
, symtab_to_filename_for_display (s
), s
->nlines
);
1405 if (lseek (desc
, s
->line_charpos
[line
- 1], 0) < 0)
1408 perror_with_name (symtab_to_filename_for_display (s
));
1411 stream
= fdopen (desc
, FDOPEN_MODE
);
1413 cleanup
= make_cleanup_fclose (stream
);
1415 while (nlines
-- > 0)
1422 last_line_listed
= current_source_line
;
1423 if (flags
& PRINT_SOURCE_LINES_FILENAME
)
1425 ui_out_text (uiout
, symtab_to_filename_for_display (s
));
1426 ui_out_text (uiout
, ":");
1428 xsnprintf (buf
, sizeof (buf
), "%d\t", current_source_line
++);
1429 ui_out_text (uiout
, buf
);
1432 if (c
< 040 && c
!= '\t' && c
!= '\n' && c
!= '\r')
1434 xsnprintf (buf
, sizeof (buf
), "^%c", c
+ 0100);
1435 ui_out_text (uiout
, buf
);
1438 ui_out_text (uiout
, "^?");
1441 /* Skip a \r character, but only before a \n. */
1442 int c1
= fgetc (stream
);
1445 printf_filtered ("^%c", c
+ 0100);
1447 ungetc (c1
, stream
);
1451 xsnprintf (buf
, sizeof (buf
), "%c", c
);
1452 ui_out_text (uiout
, buf
);
1455 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1458 do_cleanups (cleanup
);
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 enum 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 line_info (char *arg
, int from_tty
)
1478 struct symtabs_and_lines sals
;
1479 struct symtab_and_line sal
;
1480 CORE_ADDR start_pc
, end_pc
;
1482 struct cleanup
*cleanups
;
1484 init_sal (&sal
); /* initialize to zeroes */
1488 sal
.symtab
= current_source_symtab
;
1489 sal
.pspace
= current_program_space
;
1490 sal
.line
= last_line_listed
;
1492 sals
.sals
= (struct symtab_and_line
*)
1493 xmalloc (sizeof (struct symtab_and_line
));
1498 sals
= decode_line_with_last_displayed (arg
, DECODE_LINE_LIST_MODE
);
1503 cleanups
= make_cleanup (xfree
, sals
.sals
);
1505 /* C++ More than one line may have been specified, as when the user
1506 specifies an overloaded function name. Print info on them all. */
1507 for (i
= 0; i
< sals
.nelts
; i
++)
1510 if (sal
.pspace
!= current_program_space
)
1513 if (sal
.symtab
== 0)
1515 struct gdbarch
*gdbarch
= get_current_arch ();
1517 printf_filtered (_("No line number information available"));
1520 /* This is useful for "info line *0x7f34". If we can't tell the
1521 user about a source line, at least let them have the symbolic
1523 printf_filtered (" for address ");
1525 print_address (gdbarch
, sal
.pc
, gdb_stdout
);
1528 printf_filtered (".");
1529 printf_filtered ("\n");
1531 else if (sal
.line
> 0
1532 && find_line_pc_range (sal
, &start_pc
, &end_pc
))
1534 struct gdbarch
*gdbarch
= get_objfile_arch (sal
.symtab
->objfile
);
1536 if (start_pc
== end_pc
)
1538 printf_filtered ("Line %d of \"%s\"",
1540 symtab_to_filename_for_display (sal
.symtab
));
1542 printf_filtered (" is at address ");
1543 print_address (gdbarch
, start_pc
, gdb_stdout
);
1545 printf_filtered (" but contains no code.\n");
1549 printf_filtered ("Line %d of \"%s\"",
1551 symtab_to_filename_for_display (sal
.symtab
));
1553 printf_filtered (" starts at address ");
1554 print_address (gdbarch
, start_pc
, gdb_stdout
);
1556 printf_filtered (" and ends at ");
1557 print_address (gdbarch
, end_pc
, gdb_stdout
);
1558 printf_filtered (".\n");
1561 /* x/i should display this line's code. */
1562 set_next_address (gdbarch
, start_pc
);
1564 /* Repeating "info line" should do the following line. */
1565 last_line_listed
= sal
.line
+ 1;
1567 /* If this is the only line, show the source code. If it could
1568 not find the file, don't do anything special. */
1569 if (annotation_level
&& sals
.nelts
== 1)
1570 identify_source_line (sal
.symtab
, sal
.line
, 0, start_pc
);
1573 /* Is there any case in which we get here, and have an address
1574 which the user would want to see? If we have debugging symbols
1575 and no line numbers? */
1576 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1577 sal
.line
, symtab_to_filename_for_display (sal
.symtab
));
1579 do_cleanups (cleanups
);
1582 /* Commands to search the source file for a regexp. */
1585 forward_search_command (char *regex
, int from_tty
)
1592 struct cleanup
*cleanups
;
1594 line
= last_line_listed
+ 1;
1596 msg
= (char *) re_comp (regex
);
1598 error (("%s"), msg
);
1600 if (current_source_symtab
== 0)
1601 select_source_symtab (0);
1603 desc
= open_source_file (current_source_symtab
);
1605 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1606 cleanups
= make_cleanup_close (desc
);
1608 if (current_source_symtab
->line_charpos
== 0)
1609 find_source_lines (current_source_symtab
, desc
);
1611 if (line
< 1 || line
> current_source_symtab
->nlines
)
1612 error (_("Expression not found"));
1614 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1615 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1617 discard_cleanups (cleanups
);
1618 stream
= fdopen (desc
, FDOPEN_MODE
);
1620 cleanups
= make_cleanup_fclose (stream
);
1623 static char *buf
= NULL
;
1625 int cursize
, newsize
;
1628 buf
= xmalloc (cursize
);
1637 if (p
- buf
== cursize
)
1639 newsize
= cursize
+ cursize
/ 2;
1640 buf
= xrealloc (buf
, newsize
);
1645 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1647 /* Remove the \r, if any, at the end of the line, otherwise
1648 regular expressions that end with $ or \n won't work. */
1649 if (p
- buf
> 1 && p
[-2] == '\r')
1655 /* We now have a source line in buf, null terminate and match. */
1657 if (re_exec (buf
) > 0)
1660 do_cleanups (cleanups
);
1661 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1662 set_internalvar_integer (lookup_internalvar ("_"), line
);
1663 current_source_line
= max (line
- lines_to_list
/ 2, 1);
1669 printf_filtered (_("Expression not found\n"));
1670 do_cleanups (cleanups
);
1674 reverse_search_command (char *regex
, int from_tty
)
1681 struct cleanup
*cleanups
;
1683 line
= last_line_listed
- 1;
1685 msg
= (char *) re_comp (regex
);
1687 error (("%s"), msg
);
1689 if (current_source_symtab
== 0)
1690 select_source_symtab (0);
1692 desc
= open_source_file (current_source_symtab
);
1694 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1695 cleanups
= make_cleanup_close (desc
);
1697 if (current_source_symtab
->line_charpos
== 0)
1698 find_source_lines (current_source_symtab
, desc
);
1700 if (line
< 1 || line
> current_source_symtab
->nlines
)
1701 error (_("Expression not found"));
1703 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1704 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1706 discard_cleanups (cleanups
);
1707 stream
= fdopen (desc
, FDOPEN_MODE
);
1709 cleanups
= make_cleanup_fclose (stream
);
1712 /* FIXME!!! We walk right off the end of buf if we get a long line!!! */
1713 char buf
[4096]; /* Should be reasonable??? */
1723 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1725 /* Remove the \r, if any, at the end of the line, otherwise
1726 regular expressions that end with $ or \n won't work. */
1727 if (p
- buf
> 1 && p
[-2] == '\r')
1733 /* We now have a source line in buf; null terminate and match. */
1735 if (re_exec (buf
) > 0)
1738 do_cleanups (cleanups
);
1739 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1740 set_internalvar_integer (lookup_internalvar ("_"), line
);
1741 current_source_line
= max (line
- lines_to_list
/ 2, 1);
1745 if (fseek (stream
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1747 const char *filename
;
1749 do_cleanups (cleanups
);
1750 filename
= symtab_to_filename_for_display (current_source_symtab
);
1751 perror_with_name (filename
);
1755 printf_filtered (_("Expression not found\n"));
1756 do_cleanups (cleanups
);
1760 /* If the last character of PATH is a directory separator, then strip it. */
1763 strip_trailing_directory_separator (char *path
)
1765 const int last
= strlen (path
) - 1;
1768 return; /* No stripping is needed if PATH is the empty string. */
1770 if (IS_DIR_SEPARATOR (path
[last
]))
1774 /* Return the path substitution rule that matches FROM.
1775 Return NULL if no rule matches. */
1777 static struct substitute_path_rule
*
1778 find_substitute_path_rule (const char *from
)
1780 struct substitute_path_rule
*rule
= substitute_path_rules
;
1782 while (rule
!= NULL
)
1784 if (FILENAME_CMP (rule
->from
, from
) == 0)
1792 /* Add a new substitute-path rule at the end of the current list of rules.
1793 The new rule will replace FROM into TO. */
1796 add_substitute_path_rule (char *from
, char *to
)
1798 struct substitute_path_rule
*rule
;
1799 struct substitute_path_rule
*new_rule
;
1801 new_rule
= xmalloc (sizeof (struct substitute_path_rule
));
1802 new_rule
->from
= xstrdup (from
);
1803 new_rule
->to
= xstrdup (to
);
1804 new_rule
->next
= NULL
;
1806 /* If the list of rules are empty, then insert the new rule
1807 at the head of the list. */
1809 if (substitute_path_rules
== NULL
)
1811 substitute_path_rules
= new_rule
;
1815 /* Otherwise, skip to the last rule in our list and then append
1818 rule
= substitute_path_rules
;
1819 while (rule
->next
!= NULL
)
1822 rule
->next
= new_rule
;
1825 /* Remove the given source path substitution rule from the current list
1826 of rules. The memory allocated for that rule is also deallocated. */
1829 delete_substitute_path_rule (struct substitute_path_rule
*rule
)
1831 if (rule
== substitute_path_rules
)
1832 substitute_path_rules
= rule
->next
;
1835 struct substitute_path_rule
*prev
= substitute_path_rules
;
1837 while (prev
!= NULL
&& prev
->next
!= rule
)
1840 gdb_assert (prev
!= NULL
);
1842 prev
->next
= rule
->next
;
1850 /* Implement the "show substitute-path" command. */
1853 show_substitute_path_command (char *args
, int from_tty
)
1855 struct substitute_path_rule
*rule
= substitute_path_rules
;
1858 struct cleanup
*cleanup
;
1860 argv
= gdb_buildargv (args
);
1861 cleanup
= make_cleanup_freeargv (argv
);
1863 /* We expect zero or one argument. */
1865 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1866 error (_("Too many arguments in command"));
1868 if (argv
!= NULL
&& argv
[0] != NULL
)
1871 /* Print the substitution rules. */
1875 (_("Source path substitution rule matching `%s':\n"), from
);
1877 printf_filtered (_("List of all source path substitution rules:\n"));
1879 while (rule
!= NULL
)
1881 if (from
== NULL
|| FILENAME_CMP (rule
->from
, from
) == 0)
1882 printf_filtered (" `%s' -> `%s'.\n", rule
->from
, rule
->to
);
1886 do_cleanups (cleanup
);
1889 /* Implement the "unset substitute-path" command. */
1892 unset_substitute_path_command (char *args
, int from_tty
)
1894 struct substitute_path_rule
*rule
= substitute_path_rules
;
1895 char **argv
= gdb_buildargv (args
);
1898 struct cleanup
*cleanup
;
1900 /* This function takes either 0 or 1 argument. */
1902 cleanup
= make_cleanup_freeargv (argv
);
1903 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1904 error (_("Incorrect usage, too many arguments in command"));
1906 if (argv
!= NULL
&& argv
[0] != NULL
)
1909 /* If the user asked for all the rules to be deleted, ask him
1910 to confirm and give him a chance to abort before the action
1914 && !query (_("Delete all source path substitution rules? ")))
1915 error (_("Canceled"));
1917 /* Delete the rule matching the argument. No argument means that
1918 all rules should be deleted. */
1920 while (rule
!= NULL
)
1922 struct substitute_path_rule
*next
= rule
->next
;
1924 if (from
== NULL
|| FILENAME_CMP (from
, rule
->from
) == 0)
1926 delete_substitute_path_rule (rule
);
1933 /* If the user asked for a specific rule to be deleted but
1934 we could not find it, then report an error. */
1936 if (from
!= NULL
&& !rule_found
)
1937 error (_("No substitution rule defined for `%s'"), from
);
1939 forget_cached_source_info ();
1941 do_cleanups (cleanup
);
1944 /* Add a new source path substitution rule. */
1947 set_substitute_path_command (char *args
, int from_tty
)
1950 struct substitute_path_rule
*rule
;
1951 struct cleanup
*cleanup
;
1953 argv
= gdb_buildargv (args
);
1954 cleanup
= make_cleanup_freeargv (argv
);
1956 if (argv
== NULL
|| argv
[0] == NULL
|| argv
[1] == NULL
)
1957 error (_("Incorrect usage, too few arguments in command"));
1959 if (argv
[2] != NULL
)
1960 error (_("Incorrect usage, too many arguments in command"));
1962 if (*(argv
[0]) == '\0')
1963 error (_("First argument must be at least one character long"));
1965 /* Strip any trailing directory separator character in either FROM
1966 or TO. The substitution rule already implicitly contains them. */
1967 strip_trailing_directory_separator (argv
[0]);
1968 strip_trailing_directory_separator (argv
[1]);
1970 /* If a rule with the same "from" was previously defined, then
1971 delete it. This new rule replaces it. */
1973 rule
= find_substitute_path_rule (argv
[0]);
1975 delete_substitute_path_rule (rule
);
1977 /* Insert the new substitution rule. */
1979 add_substitute_path_rule (argv
[0], argv
[1]);
1980 forget_cached_source_info ();
1982 do_cleanups (cleanup
);
1987 _initialize_source (void)
1989 struct cmd_list_element
*c
;
1991 current_source_symtab
= 0;
1992 init_source_path ();
1994 /* The intention is to use POSIX Basic Regular Expressions.
1995 Always use the GNU regex routine for consistency across all hosts.
1996 Our current GNU regex.c does not have all the POSIX features, so this is
1997 just an approximation. */
1998 re_set_syntax (RE_SYNTAX_GREP
);
2000 c
= add_cmd ("directory", class_files
, directory_command
, _("\
2001 Add directory DIR to beginning of search path for source files.\n\
2002 Forget cached info on source file locations and line positions.\n\
2003 DIR can also be $cwd for the current working directory, or $cdir for the\n\
2004 directory in which the source file was compiled into object code.\n\
2005 With no argument, reset the search path to $cdir:$cwd, the default."),
2009 add_com_alias ("use", "directory", class_files
, 0);
2011 set_cmd_completer (c
, filename_completer
);
2013 add_setshow_optional_filename_cmd ("directories",
2017 Set the search path for finding source files."),
2019 Show the search path for finding source files."),
2021 $cwd in the path means the current working directory.\n\
2022 $cdir in the path means the compilation directory of the source file.\n\
2023 GDB ensures the search path always ends with $cdir:$cwd by\n\
2024 appending these directories if necessary.\n\
2025 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
2026 set_directories_command
,
2027 show_directories_command
,
2028 &setlist
, &showlist
);
2032 add_com_alias ("D", "directory", class_files
, 0);
2033 add_cmd ("ld", no_class
, show_directories_1
, _("\
2034 Current search path for finding source files.\n\
2035 $cwd in the path means the current working directory.\n\
2036 $cdir in the path means the compilation directory of the source file."),
2040 add_info ("source", source_info
,
2041 _("Information about the current source file."));
2043 add_info ("line", line_info
, _("\
2044 Core addresses of the code for a source line.\n\
2045 Line can be specified as\n\
2046 LINENUM, to list around that line in current file,\n\
2047 FILE:LINENUM, to list around that line in that file,\n\
2048 FUNCTION, to list around beginning of that function,\n\
2049 FILE:FUNCTION, to distinguish among like-named static functions.\n\
2050 Default is to describe the last source line that was listed.\n\n\
2051 This sets the default address for \"x\" to the line's first instruction\n\
2052 so that \"x/i\" suffices to start examining the machine code.\n\
2053 The address is also stored as the value of \"$_\"."));
2055 add_com ("forward-search", class_files
, forward_search_command
, _("\
2056 Search for regular expression (see regex(3)) from last line listed.\n\
2057 The matching line number is also stored as the value of \"$_\"."));
2058 add_com_alias ("search", "forward-search", class_files
, 0);
2059 add_com_alias ("fo", "forward-search", class_files
, 1);
2061 add_com ("reverse-search", class_files
, reverse_search_command
, _("\
2062 Search backward for regular expression (see regex(3)) from last line listed.\n\
2063 The matching line number is also stored as the value of \"$_\"."));
2064 add_com_alias ("rev", "reverse-search", class_files
, 1);
2068 add_com_alias ("/", "forward-search", class_files
, 0);
2069 add_com_alias ("?", "reverse-search", class_files
, 0);
2072 add_setshow_integer_cmd ("listsize", class_support
, &lines_to_list
, _("\
2073 Set number of source lines gdb will list by default."), _("\
2074 Show number of source lines gdb will list by default."), _("\
2075 Use this to choose how many source lines the \"list\" displays (unless\n\
2076 the \"list\" argument explicitly specifies some other number).\n\
2077 A value of \"unlimited\", or zero, means there's no limit."),
2080 &setlist
, &showlist
);
2082 add_cmd ("substitute-path", class_files
, set_substitute_path_command
,
2084 Usage: set substitute-path FROM TO\n\
2085 Add a substitution rule replacing FROM into TO in source file names.\n\
2086 If a substitution rule was previously set for FROM, the old rule\n\
2087 is replaced by the new one."),
2090 add_cmd ("substitute-path", class_files
, unset_substitute_path_command
,
2092 Usage: unset substitute-path [FROM]\n\
2093 Delete the rule for substituting FROM in source file names. If FROM\n\
2094 is not specified, all substituting rules are deleted.\n\
2095 If the debugger cannot find a rule for FROM, it will display a warning."),
2098 add_cmd ("substitute-path", class_files
, show_substitute_path_command
,
2100 Usage: show substitute-path [FROM]\n\
2101 Print the rule for substituting FROM in source file names. If FROM\n\
2102 is not specified, print all substitution rules."),
2105 add_setshow_enum_cmd ("filename-display", class_files
,
2106 filename_display_kind_names
,
2107 &filename_display_string
, _("\
2108 Set how to display filenames."), _("\
2109 Show how to display filenames."), _("\
2110 filename-display can be:\n\
2111 basename - display only basename of a filename\n\
2112 relative - display a filename relative to the compilation directory\n\
2113 absolute - display an absolute filename\n\
2114 By default, relative filenames are displayed."),
2116 show_filename_display_string
,
2117 &setlist
, &showlist
);