1 /* List lines of source files for GDB, the GNU debugger.
2 Copyright (C) 1986-2014 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>
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. If 0, then no
137 source lines have yet been listed since the last time the current
138 source line was changed. */
140 static int first_line_listed
;
142 /* Saves the name of the last source file visited and a possible error code.
143 Used to prevent repeating annoying "No such file or directories" msgs. */
145 static struct symtab
*last_source_visited
= NULL
;
146 static int last_source_error
= 0;
148 /* Return the first line listed by print_source_lines.
149 Used by command interpreters to request listing from
153 get_first_line_listed (void)
155 return first_line_listed
;
158 /* Clear line listed range. This makes the next "list" center the
159 printed source lines around the current source line. */
162 clear_lines_listed_range (void)
164 first_line_listed
= 0;
165 last_line_listed
= 0;
168 /* Return the default number of lines to print with commands like the
169 cli "list". The caller of print_source_lines must use this to
170 calculate the end line and use it in the call to print_source_lines
171 as it does not automatically use this value. */
174 get_lines_to_list (void)
176 return lines_to_list
;
179 /* Return the current source file for listing and next line to list.
180 NOTE: The returned sal pc and end fields are not valid. */
182 struct symtab_and_line
183 get_current_source_symtab_and_line (void)
185 struct symtab_and_line cursal
= { 0 };
187 cursal
.pspace
= current_source_pspace
;
188 cursal
.symtab
= current_source_symtab
;
189 cursal
.line
= current_source_line
;
196 /* If the current source file for listing is not set, try and get a default.
197 Usually called before get_current_source_symtab_and_line() is called.
198 It may err out if a default cannot be determined.
199 We must be cautious about where it is called, as it can recurse as the
200 process of determining a new default may call the caller!
201 Use get_current_source_symtab_and_line only to get whatever
202 we have without erroring out or trying to get a default. */
205 set_default_source_symtab_and_line (void)
207 if (!have_full_symbols () && !have_partial_symbols ())
208 error (_("No symbol table is loaded. Use the \"file\" command."));
210 /* Pull in a current source symtab if necessary. */
211 if (current_source_symtab
== 0)
212 select_source_symtab (0);
215 /* Return the current default file for listing and next line to list
216 (the returned sal pc and end fields are not valid.)
217 and set the current default to whatever is in SAL.
218 NOTE: The returned sal pc and end fields are not valid. */
220 struct symtab_and_line
221 set_current_source_symtab_and_line (const struct symtab_and_line
*sal
)
223 struct symtab_and_line cursal
= { 0 };
225 cursal
.pspace
= current_source_pspace
;
226 cursal
.symtab
= current_source_symtab
;
227 cursal
.line
= current_source_line
;
231 current_source_pspace
= sal
->pspace
;
232 current_source_symtab
= sal
->symtab
;
233 current_source_line
= sal
->line
;
235 /* Force the next "list" to center around the current line. */
236 clear_lines_listed_range ();
241 /* Reset any information stored about a default file and line to print. */
244 clear_current_source_symtab_and_line (void)
246 current_source_symtab
= 0;
247 current_source_line
= 0;
250 /* Set the source file default for the "list" command to be S.
252 If S is NULL, and we don't have a default, find one. This
253 should only be called when the user actually tries to use the
254 default, since we produce an error if we can't find a reasonable
255 default. Also, since this can cause symbols to be read, doing it
256 before we need to would make things slower than necessary. */
259 select_source_symtab (struct symtab
*s
)
261 struct symtabs_and_lines sals
;
262 struct symtab_and_line sal
;
267 current_source_symtab
= s
;
268 current_source_line
= 1;
269 current_source_pspace
= SYMTAB_PSPACE (s
);
273 if (current_source_symtab
)
276 /* Make the default place to list be the function `main'
278 if (lookup_symbol (main_name (), 0, VAR_DOMAIN
, 0))
280 sals
= decode_line_with_current_source (main_name (),
281 DECODE_LINE_FUNFIRSTLINE
);
284 current_source_pspace
= sal
.pspace
;
285 current_source_symtab
= sal
.symtab
;
286 current_source_line
= max (sal
.line
- (lines_to_list
- 1), 1);
287 if (current_source_symtab
)
291 /* Alright; find the last file in the symtab list (ignoring .h's
292 and namespace symtabs). */
294 current_source_line
= 1;
298 for (s
= ofp
->symtabs
; s
; s
= s
->next
)
300 const char *name
= s
->filename
;
301 int len
= strlen (name
);
303 if (!(len
> 2 && (strcmp (&name
[len
- 2], ".h") == 0
304 || strcmp (name
, "<<C++-namespaces>>") == 0)))
306 current_source_pspace
= current_program_space
;
307 current_source_symtab
= s
;
312 if (current_source_symtab
)
318 s
= ofp
->sf
->qf
->find_last_source_symtab (ofp
);
320 current_source_symtab
= s
;
322 if (current_source_symtab
)
325 error (_("Can't find a default source file"));
328 /* Handler for "set directories path-list" command.
329 "set dir mumble" doesn't prepend paths, it resets the entire
330 path list. The theory is that set(show(dir)) should be a no-op. */
333 set_directories_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
335 /* This is the value that was set.
336 It needs to be processed to maintain $cdir:$cwd and remove dups. */
337 char *set_path
= source_path
;
339 /* We preserve the invariant that $cdir:$cwd begins life at the end of
340 the list by calling init_source_path. If they appear earlier in
341 SET_PATH then mod_path will move them appropriately.
342 mod_path will also remove duplicates. */
344 if (*set_path
!= '\0')
345 mod_path (set_path
, &source_path
);
350 /* Print the list of source directories.
351 This is used by the "ld" command, so it has the signature of a command
355 show_directories_1 (char *ignore
, int from_tty
)
357 puts_filtered ("Source directories searched: ");
358 puts_filtered (source_path
);
359 puts_filtered ("\n");
362 /* Handler for "show directories" command. */
365 show_directories_command (struct ui_file
*file
, int from_tty
,
366 struct cmd_list_element
*c
, const char *value
)
368 show_directories_1 (NULL
, from_tty
);
371 /* Forget line positions and file names for the symtabs in a
372 particular objfile. */
375 forget_cached_source_info_for_objfile (struct objfile
*objfile
)
379 ALL_OBJFILE_SYMTABS (objfile
, s
)
381 if (s
->line_charpos
!= NULL
)
383 xfree (s
->line_charpos
);
384 s
->line_charpos
= NULL
;
386 if (s
->fullname
!= NULL
)
394 objfile
->sf
->qf
->forget_cached_source_info (objfile
);
397 /* Forget what we learned about line positions in source files, and
398 which directories contain them; must check again now since files
399 may be found in a different directory now. */
402 forget_cached_source_info (void)
404 struct program_space
*pspace
;
405 struct objfile
*objfile
;
408 ALL_PSPACE_OBJFILES (pspace
, objfile
)
410 forget_cached_source_info_for_objfile (objfile
);
413 last_source_visited
= NULL
;
417 init_source_path (void)
421 xsnprintf (buf
, sizeof (buf
), "$cdir%c$cwd", DIRNAME_SEPARATOR
);
422 source_path
= xstrdup (buf
);
423 forget_cached_source_info ();
426 /* Add zero or more directories to the front of the source path. */
429 directory_command (char *dirname
, int from_tty
)
432 /* FIXME, this goes to "delete dir"... */
435 if (!from_tty
|| query (_("Reinitialize source path to empty? ")))
443 mod_path (dirname
, &source_path
);
444 forget_cached_source_info ();
447 show_directories_1 ((char *) 0, from_tty
);
450 /* Add a path given with the -d command line switch.
451 This will not be quoted so we must not treat spaces as separators. */
454 directory_switch (char *dirname
, int from_tty
)
456 add_path (dirname
, &source_path
, 0);
459 /* Add zero or more directories to the front of an arbitrary path. */
462 mod_path (char *dirname
, char **which_path
)
464 add_path (dirname
, which_path
, 1);
467 /* Workhorse of mod_path. Takes an extra argument to determine
468 if dirname should be parsed for separators that indicate multiple
469 directories. This allows for interfaces that pre-parse the dirname
470 and allow specification of traditional separator characters such
474 add_path (char *dirname
, char **which_path
, int parse_separators
)
476 char *old
= *which_path
;
478 VEC (char_ptr
) *dir_vec
= NULL
;
479 struct cleanup
*back_to
;
486 if (parse_separators
)
488 char **argv
, **argvp
;
490 /* This will properly parse the space and tab separators
491 and any quotes that may exist. */
492 argv
= gdb_buildargv (dirname
);
494 for (argvp
= argv
; *argvp
; argvp
++)
495 dirnames_to_char_ptr_vec_append (&dir_vec
, *argvp
);
500 VEC_safe_push (char_ptr
, dir_vec
, xstrdup (dirname
));
501 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
503 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, name
); ++ix
)
508 /* Spaces and tabs will have been removed by buildargv().
509 NAME is the start of the directory.
510 P is the '\0' following the end. */
511 p
= name
+ strlen (name
);
513 while (!(IS_DIR_SEPARATOR (*name
) && p
<= name
+ 1) /* "/" */
514 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
515 /* On MS-DOS and MS-Windows, h:\ is different from h: */
516 && !(p
== name
+ 3 && name
[1] == ':') /* "d:/" */
518 && IS_DIR_SEPARATOR (p
[-1]))
519 /* Sigh. "foo/" => "foo" */
523 while (p
> name
&& p
[-1] == '.')
527 /* "." => getwd (). */
528 name
= current_directory
;
531 else if (p
> name
+ 1 && IS_DIR_SEPARATOR (p
[-2]))
541 /* "...foo/." => "...foo". */
552 name
= tilde_expand (name
);
553 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
554 else if (IS_ABSOLUTE_PATH (name
) && p
== name
+ 2) /* "d:" => "d:." */
555 name
= concat (name
, ".", (char *)NULL
);
557 else if (!IS_ABSOLUTE_PATH (name
) && name
[0] != '$')
558 name
= concat (current_directory
, SLASH_STRING
, name
, (char *)NULL
);
560 name
= savestring (name
, p
- name
);
561 make_cleanup (xfree
, name
);
563 /* Unless it's a variable, check existence. */
566 /* These are warnings, not errors, since we don't want a
567 non-existent directory in a .gdbinit file to stop processing
568 of the .gdbinit file.
570 Whether they get added to the path is more debatable. Current
571 answer is yes, in case the user wants to go make the directory
572 or whatever. If the directory continues to not exist/not be
573 a directory/etc, then having them in the path should be
575 if (stat (name
, &st
) < 0)
577 int save_errno
= errno
;
579 fprintf_unfiltered (gdb_stderr
, "Warning: ");
580 print_sys_errmsg (name
, save_errno
);
582 else if ((st
.st_mode
& S_IFMT
) != S_IFDIR
)
583 warning (_("%s is not a directory."), name
);
588 unsigned int len
= strlen (name
);
594 /* FIXME: we should use realpath() or its work-alike
595 before comparing. Then all the code above which
596 removes excess slashes and dots could simply go away. */
597 if (!filename_ncmp (p
, name
, len
)
598 && (p
[len
] == '\0' || p
[len
] == DIRNAME_SEPARATOR
))
600 /* Found it in the search path, remove old copy. */
603 /* Back over leading separator. */
606 if (prefix
> p
- *which_path
)
608 /* Same dir twice in one cmd. */
611 /* Copy from next '\0' or ':'. */
612 memmove (p
, &p
[len
+ 1], strlen (&p
[len
+ 1]) + 1);
614 p
= strchr (p
, DIRNAME_SEPARATOR
);
621 tinybuf
[0] = DIRNAME_SEPARATOR
;
624 /* If we have already tacked on a name(s) in this command,
625 be sure they stay on the front as we tack on some
633 temp
= concat (old
, tinybuf
, name
, (char *)NULL
);
635 *which_path
= concat (temp
, "", &old
[prefix
], (char *) NULL
);
636 prefix
= strlen (temp
);
641 *which_path
= concat (name
, (old
[0] ? tinybuf
: old
),
643 prefix
= strlen (name
);
652 do_cleanups (back_to
);
657 source_info (char *ignore
, int from_tty
)
659 struct symtab
*s
= current_source_symtab
;
663 printf_filtered (_("No current source file.\n"));
666 printf_filtered (_("Current source file is %s\n"), s
->filename
);
668 printf_filtered (_("Compilation directory is %s\n"), s
->dirname
);
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 (_("Compiled with %s debugging format.\n"), s
->debugformat
);
677 printf_filtered (_("%s preprocessor macro info.\n"),
678 s
->macro_table
? "Includes" : "Does not include");
682 /* Return True if the file NAME exists and is a regular file. */
684 is_regular_file (const char *name
)
687 const int status
= stat (name
, &st
);
689 /* Stat should never fail except when the file does not exist.
690 If stat fails, analyze the source of error and return True
691 unless the file does not exist, to avoid returning false results
692 on obscure systems where stat does not work as expected. */
695 return (errno
!= ENOENT
);
697 return S_ISREG (st
.st_mode
);
700 /* Open a file named STRING, searching path PATH (dir names sep by some char)
701 using mode MODE in the calls to open. You cannot use this function to
702 create files (O_CREAT).
704 OPTS specifies the function behaviour in specific cases.
706 If OPF_TRY_CWD_FIRST, try to open ./STRING before searching PATH.
707 (ie pretend the first element of PATH is "."). This also indicates
708 that, unless OPF_SEARCH_IN_PATH is also specified, a slash in STRING
709 disables searching of the path (this is so that "exec-file ./foo" or
710 "symbol-file ./foo" insures that you get that particular version of
711 foo or an error message).
713 If OPTS has OPF_SEARCH_IN_PATH set, absolute names will also be
714 searched in path (we usually want this for source files but not for
717 If FILENAME_OPENED is non-null, set it to a newly allocated string naming
718 the actual file opened (this string will always start with a "/"). We
719 have to take special pains to avoid doubling the "/" between the directory
720 and the file, sigh! Emacs gets confuzzed by this when we print the
723 If OPTS has OPF_RETURN_REALPATH set return FILENAME_OPENED resolved by
724 gdb_realpath. Even without OPF_RETURN_REALPATH this function still returns
725 filename starting with "/". If FILENAME_OPENED is NULL this option has no
728 If a file is found, return the descriptor.
729 Otherwise, return -1, with errno set for the last name we tried to open. */
731 /* >>>> This should only allow files of certain types,
732 >>>> eg executable, non-directory. */
734 openp (const char *path
, int opts
, const char *string
,
735 int mode
, char **filename_opened
)
740 VEC (char_ptr
) *dir_vec
;
741 struct cleanup
*back_to
;
745 /* The open syscall MODE parameter is not specified. */
746 gdb_assert ((mode
& O_CREAT
) == 0);
747 gdb_assert (string
!= NULL
);
749 /* A file with an empty name cannot possibly exist. Report a failure
750 without further checking.
752 This is an optimization which also defends us against buggy
753 implementations of the "stat" function. For instance, we have
754 noticed that a MinGW debugger built on Windows XP 32bits crashes
755 when the debugger is started with an empty argument. */
756 if (string
[0] == '\0')
767 if ((opts
& OPF_TRY_CWD_FIRST
) || IS_ABSOLUTE_PATH (string
))
771 if (is_regular_file (string
))
773 filename
= alloca (strlen (string
) + 1);
774 strcpy (filename
, string
);
775 fd
= gdb_open_cloexec (filename
, mode
, 0);
785 if (!(opts
& OPF_SEARCH_IN_PATH
))
786 for (i
= 0; string
[i
]; i
++)
787 if (IS_DIR_SEPARATOR (string
[i
]))
791 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
792 if (HAS_DRIVE_SPEC (string
))
793 string
= STRIP_DRIVE_SPEC (string
);
795 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
796 while (IS_DIR_SEPARATOR(string
[0]))
800 while (string
[0] == '.' && IS_DIR_SEPARATOR (string
[1]))
803 alloclen
= strlen (path
) + strlen (string
) + 2;
804 filename
= alloca (alloclen
);
807 dir_vec
= dirnames_to_char_ptr_vec (path
);
808 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
810 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, dir
); ++ix
)
812 size_t len
= strlen (dir
);
814 if (strcmp (dir
, "$cwd") == 0)
816 /* Name is $cwd -- insert current directory name instead. */
819 /* First, realloc the filename buffer if too short. */
820 len
= strlen (current_directory
);
821 newlen
= len
+ strlen (string
) + 2;
822 if (newlen
> alloclen
)
825 filename
= alloca (alloclen
);
827 strcpy (filename
, current_directory
);
829 else if (strchr(dir
, '~'))
831 /* See whether we need to expand the tilde. */
833 char *tilde_expanded
;
835 tilde_expanded
= tilde_expand (dir
);
837 /* First, realloc the filename buffer if too short. */
838 len
= strlen (tilde_expanded
);
839 newlen
= len
+ strlen (string
) + 2;
840 if (newlen
> alloclen
)
843 filename
= alloca (alloclen
);
845 strcpy (filename
, tilde_expanded
);
846 xfree (tilde_expanded
);
850 /* Normal file name in path -- just use it. */
851 strcpy (filename
, dir
);
853 /* Don't search $cdir. It's also a magic path like $cwd, but we
854 don't have enough information to expand it. The user *could*
855 have an actual directory named '$cdir' but handling that would
856 be confusing, it would mean different things in different
857 contexts. If the user really has '$cdir' one can use './$cdir'.
858 We can get $cdir when loading scripts. When loading source files
859 $cdir must have already been expanded to the correct value. */
860 if (strcmp (dir
, "$cdir") == 0)
864 /* Remove trailing slashes. */
865 while (len
> 0 && IS_DIR_SEPARATOR (filename
[len
- 1]))
868 strcat (filename
+ len
, SLASH_STRING
);
869 strcat (filename
, string
);
871 if (is_regular_file (filename
))
873 fd
= gdb_open_cloexec (filename
, mode
, 0);
879 do_cleanups (back_to
);
884 /* If a file was opened, canonicalize its filename. */
886 *filename_opened
= NULL
;
887 else if ((opts
& OPF_RETURN_REALPATH
) != 0)
888 *filename_opened
= gdb_realpath (filename
);
890 *filename_opened
= gdb_abspath (filename
);
897 /* This is essentially a convenience, for clients that want the behaviour
898 of openp, using source_path, but that really don't want the file to be
899 opened but want instead just to know what the full pathname is (as
900 qualified against source_path).
902 The current working directory is searched first.
904 If the file was found, this function returns 1, and FULL_PATHNAME is
905 set to the fully-qualified pathname.
907 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
909 source_full_path_of (const char *filename
, char **full_pathname
)
913 fd
= openp (source_path
,
914 OPF_TRY_CWD_FIRST
| OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
,
915 filename
, O_RDONLY
, full_pathname
);
918 *full_pathname
= NULL
;
926 /* Return non-zero if RULE matches PATH, that is if the rule can be
930 substitute_path_rule_matches (const struct substitute_path_rule
*rule
,
933 const int from_len
= strlen (rule
->from
);
934 const int path_len
= strlen (path
);
937 if (path_len
< from_len
)
940 /* The substitution rules are anchored at the start of the path,
941 so the path should start with rule->from. There is no filename
942 comparison routine, so we need to extract the first FROM_LEN
943 characters from PATH first and use that to do the comparison. */
945 path_start
= alloca (from_len
+ 1);
946 strncpy (path_start
, path
, from_len
);
947 path_start
[from_len
] = '\0';
949 if (FILENAME_CMP (path_start
, rule
->from
) != 0)
952 /* Make sure that the region in the path that matches the substitution
953 rule is immediately followed by a directory separator (or the end of
954 string character). */
956 if (path
[from_len
] != '\0' && !IS_DIR_SEPARATOR (path
[from_len
]))
962 /* Find the substitute-path rule that applies to PATH and return it.
963 Return NULL if no rule applies. */
965 static struct substitute_path_rule
*
966 get_substitute_path_rule (const char *path
)
968 struct substitute_path_rule
*rule
= substitute_path_rules
;
970 while (rule
!= NULL
&& !substitute_path_rule_matches (rule
, path
))
976 /* If the user specified a source path substitution rule that applies
977 to PATH, then apply it and return the new path. This new path must
978 be deallocated afterwards.
980 Return NULL if no substitution rule was specified by the user,
981 or if no rule applied to the given PATH. */
984 rewrite_source_path (const char *path
)
986 const struct substitute_path_rule
*rule
= get_substitute_path_rule (path
);
993 from_len
= strlen (rule
->from
);
995 /* Compute the rewritten path and return it. */
998 (char *) xmalloc (strlen (path
) + 1 + strlen (rule
->to
) - from_len
);
999 strcpy (new_path
, rule
->to
);
1000 strcat (new_path
, path
+ from_len
);
1006 find_and_open_source (const char *filename
,
1007 const char *dirname
,
1010 char *path
= source_path
;
1013 struct cleanup
*cleanup
;
1015 /* Quick way out if we already know its full name. */
1019 /* The user may have requested that source paths be rewritten
1020 according to substitution rules he provided. If a substitution
1021 rule applies to this path, then apply it. */
1022 char *rewritten_fullname
= rewrite_source_path (*fullname
);
1024 if (rewritten_fullname
!= NULL
)
1027 *fullname
= rewritten_fullname
;
1030 result
= gdb_open_cloexec (*fullname
, OPEN_MODE
, 0);
1033 char *lpath
= gdb_realpath (*fullname
);
1040 /* Didn't work -- free old one, try again. */
1045 cleanup
= make_cleanup (null_cleanup
, NULL
);
1047 if (dirname
!= NULL
)
1049 /* If necessary, rewrite the compilation directory name according
1050 to the source path substitution rules specified by the user. */
1052 char *rewritten_dirname
= rewrite_source_path (dirname
);
1054 if (rewritten_dirname
!= NULL
)
1056 make_cleanup (xfree
, rewritten_dirname
);
1057 dirname
= rewritten_dirname
;
1060 /* Replace a path entry of $cdir with the compilation directory
1063 /* We cast strstr's result in case an ANSIhole has made it const,
1064 which produces a "required warning" when assigned to a nonconst. */
1065 p
= (char *) strstr (source_path
, "$cdir");
1066 if (p
&& (p
== path
|| p
[-1] == DIRNAME_SEPARATOR
)
1067 && (p
[cdir_len
] == DIRNAME_SEPARATOR
|| p
[cdir_len
] == '\0'))
1072 alloca (strlen (source_path
) + 1 + strlen (dirname
) + 1);
1073 len
= p
- source_path
;
1074 strncpy (path
, source_path
, len
); /* Before $cdir */
1075 strcpy (path
+ len
, dirname
); /* new stuff */
1076 strcat (path
+ len
, source_path
+ len
+ cdir_len
); /* After
1081 if (IS_ABSOLUTE_PATH (filename
))
1083 /* If filename is absolute path, try the source path
1084 substitution on it. */
1085 char *rewritten_filename
= rewrite_source_path (filename
);
1087 if (rewritten_filename
!= NULL
)
1089 make_cleanup (xfree
, rewritten_filename
);
1090 filename
= rewritten_filename
;
1094 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, filename
,
1095 OPEN_MODE
, fullname
);
1098 /* Didn't work. Try using just the basename. */
1099 p
= lbasename (filename
);
1101 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, p
,
1102 OPEN_MODE
, fullname
);
1105 do_cleanups (cleanup
);
1109 /* Open a source file given a symtab S. Returns a file descriptor or
1110 negative number for error.
1112 This function is a convience function to find_and_open_source. */
1115 open_source_file (struct symtab
*s
)
1120 return find_and_open_source (s
->filename
, s
->dirname
, &s
->fullname
);
1123 /* Finds the fullname that a symtab represents.
1125 This functions finds the fullname and saves it in s->fullname.
1126 It will also return the value.
1128 If this function fails to find the file that this symtab represents,
1129 the expected fullname is used. Therefore the files does not have to
1133 symtab_to_fullname (struct symtab
*s
)
1135 /* Use cached copy if we have it.
1136 We rely on forget_cached_source_info being called appropriately
1137 to handle cases like the file being moved. */
1138 if (s
->fullname
== NULL
)
1140 int fd
= find_and_open_source (s
->filename
, s
->dirname
, &s
->fullname
);
1147 struct cleanup
*back_to
;
1149 /* rewrite_source_path would be applied by find_and_open_source, we
1150 should report the pathname where GDB tried to find the file. */
1152 if (s
->dirname
== NULL
|| IS_ABSOLUTE_PATH (s
->filename
))
1153 fullname
= xstrdup (s
->filename
);
1155 fullname
= concat (s
->dirname
, SLASH_STRING
, s
->filename
, NULL
);
1157 back_to
= make_cleanup (xfree
, fullname
);
1158 s
->fullname
= rewrite_source_path (fullname
);
1159 if (s
->fullname
== NULL
)
1160 s
->fullname
= xstrdup (fullname
);
1161 do_cleanups (back_to
);
1168 /* See commentary in source.h. */
1171 symtab_to_filename_for_display (struct symtab
*symtab
)
1173 if (filename_display_string
== filename_display_basename
)
1174 return lbasename (symtab
->filename
);
1175 else if (filename_display_string
== filename_display_absolute
)
1176 return symtab_to_fullname (symtab
);
1177 else if (filename_display_string
== filename_display_relative
)
1178 return symtab
->filename
;
1180 internal_error (__FILE__
, __LINE__
, _("invalid filename_display_string"));
1183 /* Create and initialize the table S->line_charpos that records
1184 the positions of the lines in the source file, which is assumed
1185 to be open on descriptor DESC.
1186 All set S->nlines to the number of such lines. */
1189 find_source_lines (struct symtab
*s
, int desc
)
1192 char *data
, *p
, *end
;
1194 int lines_allocated
= 1000;
1200 line_charpos
= (int *) xmalloc (lines_allocated
* sizeof (int));
1201 if (fstat (desc
, &st
) < 0)
1202 perror_with_name (symtab_to_filename_for_display (s
));
1204 if (s
->objfile
&& s
->objfile
->obfd
)
1205 mtime
= s
->objfile
->mtime
;
1207 mtime
= exec_bfd_mtime
;
1209 if (mtime
&& mtime
< st
.st_mtime
)
1210 warning (_("Source file is more recent than executable."));
1213 struct cleanup
*old_cleanups
;
1215 /* st_size might be a large type, but we only support source files whose
1216 size fits in an int. */
1217 size
= (int) st
.st_size
;
1219 /* Use malloc, not alloca, because this may be pretty large, and we may
1220 run into various kinds of limits on stack size. */
1221 data
= (char *) xmalloc (size
);
1222 old_cleanups
= make_cleanup (xfree
, data
);
1224 /* Reassign `size' to result of read for systems where \r\n -> \n. */
1225 size
= myread (desc
, data
, size
);
1227 perror_with_name (symtab_to_filename_for_display (s
));
1230 line_charpos
[0] = 0;
1235 /* A newline at the end does not start a new line. */
1238 if (nlines
== lines_allocated
)
1240 lines_allocated
*= 2;
1242 (int *) xrealloc ((char *) line_charpos
,
1243 sizeof (int) * lines_allocated
);
1245 line_charpos
[nlines
++] = p
- data
;
1248 do_cleanups (old_cleanups
);
1253 (int *) xrealloc ((char *) line_charpos
, nlines
* sizeof (int));
1259 /* Get full pathname and line number positions for a symtab.
1260 Return nonzero if line numbers may have changed.
1261 Set *FULLNAME to actual name of the file as found by `openp',
1262 or to 0 if the file is not found. */
1265 get_filename_and_charpos (struct symtab
*s
, char **fullname
)
1267 int desc
, linenums_changed
= 0;
1268 struct cleanup
*cleanups
;
1270 desc
= open_source_file (s
);
1277 cleanups
= make_cleanup_close (desc
);
1279 *fullname
= s
->fullname
;
1280 if (s
->line_charpos
== 0)
1281 linenums_changed
= 1;
1282 if (linenums_changed
)
1283 find_source_lines (s
, desc
);
1284 do_cleanups (cleanups
);
1285 return linenums_changed
;
1288 /* Print text describing the full name of the source file S
1289 and the line number LINE and its corresponding character position.
1290 The text starts with two Ctrl-z so that the Emacs-GDB interface
1293 MID_STATEMENT is nonzero if the PC is not at the beginning of that line.
1295 Return 1 if successful, 0 if could not find the file. */
1298 identify_source_line (struct symtab
*s
, int line
, int mid_statement
,
1301 if (s
->line_charpos
== 0)
1302 get_filename_and_charpos (s
, (char **) NULL
);
1303 if (s
->fullname
== 0)
1305 if (line
> s
->nlines
)
1306 /* Don't index off the end of the line_charpos array. */
1308 annotate_source (s
->fullname
, line
, s
->line_charpos
[line
- 1],
1309 mid_statement
, get_objfile_arch (s
->objfile
), pc
);
1311 current_source_line
= line
;
1312 current_source_symtab
= s
;
1313 clear_lines_listed_range ();
1318 /* Print source lines from the file of symtab S,
1319 starting with line number LINE and stopping before line number STOPLINE. */
1322 print_source_lines_base (struct symtab
*s
, int line
, int stopline
,
1323 enum print_source_lines_flags flags
)
1329 int nlines
= stopline
- line
;
1330 struct cleanup
*cleanup
;
1331 struct ui_out
*uiout
= current_uiout
;
1333 /* Regardless of whether we can open the file, set current_source_symtab. */
1334 current_source_symtab
= s
;
1335 current_source_line
= line
;
1336 first_line_listed
= line
;
1338 /* If printing of source lines is disabled, just print file and line
1340 if (ui_out_test_flags (uiout
, ui_source_list
))
1342 /* Only prints "No such file or directory" once. */
1343 if ((s
!= last_source_visited
) || (!last_source_error
))
1345 last_source_visited
= s
;
1346 desc
= open_source_file (s
);
1350 desc
= last_source_error
;
1351 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1356 desc
= last_source_error
;
1357 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1361 if (desc
< 0 || noprint
)
1363 last_source_error
= desc
;
1365 if (!(flags
& PRINT_SOURCE_LINES_NOERROR
))
1367 const char *filename
= symtab_to_filename_for_display (s
);
1368 int len
= strlen (filename
) + 100;
1369 char *name
= alloca (len
);
1371 xsnprintf (name
, len
, "%d\t%s", line
, filename
);
1372 print_sys_errmsg (name
, errno
);
1376 ui_out_field_int (uiout
, "line", line
);
1377 ui_out_text (uiout
, "\tin ");
1379 /* CLI expects only the "file" field. TUI expects only the
1380 "fullname" field (and TUI does break if "file" is printed).
1381 MI expects both fields. ui_source_list is set only for CLI,
1383 if (ui_out_is_mi_like_p (uiout
)
1384 || ui_out_test_flags (uiout
, ui_source_list
))
1385 ui_out_field_string (uiout
, "file",
1386 symtab_to_filename_for_display (s
));
1387 if (ui_out_is_mi_like_p (uiout
)
1388 || !ui_out_test_flags (uiout
, ui_source_list
))
1390 const char *s_fullname
= symtab_to_fullname (s
);
1391 char *local_fullname
;
1393 /* ui_out_field_string may free S_FULLNAME by calling
1394 open_source_file for it again. See e.g.,
1395 tui_field_string->tui_show_source. */
1396 local_fullname
= alloca (strlen (s_fullname
) + 1);
1397 strcpy (local_fullname
, s_fullname
);
1399 ui_out_field_string (uiout
, "fullname", local_fullname
);
1402 ui_out_text (uiout
, "\n");
1408 last_source_error
= 0;
1410 if (s
->line_charpos
== 0)
1411 find_source_lines (s
, desc
);
1413 if (line
< 1 || line
> s
->nlines
)
1416 error (_("Line number %d out of range; %s has %d lines."),
1417 line
, symtab_to_filename_for_display (s
), s
->nlines
);
1420 if (lseek (desc
, s
->line_charpos
[line
- 1], 0) < 0)
1423 perror_with_name (symtab_to_filename_for_display (s
));
1426 stream
= fdopen (desc
, FDOPEN_MODE
);
1428 cleanup
= make_cleanup_fclose (stream
);
1430 while (nlines
-- > 0)
1437 last_line_listed
= current_source_line
;
1438 if (flags
& PRINT_SOURCE_LINES_FILENAME
)
1440 ui_out_text (uiout
, symtab_to_filename_for_display (s
));
1441 ui_out_text (uiout
, ":");
1443 xsnprintf (buf
, sizeof (buf
), "%d\t", current_source_line
++);
1444 ui_out_text (uiout
, buf
);
1447 if (c
< 040 && c
!= '\t' && c
!= '\n' && c
!= '\r')
1449 xsnprintf (buf
, sizeof (buf
), "^%c", c
+ 0100);
1450 ui_out_text (uiout
, buf
);
1453 ui_out_text (uiout
, "^?");
1456 /* Skip a \r character, but only before a \n. */
1457 int c1
= fgetc (stream
);
1460 printf_filtered ("^%c", c
+ 0100);
1462 ungetc (c1
, stream
);
1466 xsnprintf (buf
, sizeof (buf
), "%c", c
);
1467 ui_out_text (uiout
, buf
);
1470 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1473 do_cleanups (cleanup
);
1476 /* Show source lines from the file of symtab S, starting with line
1477 number LINE and stopping before line number STOPLINE. If this is
1478 not the command line version, then the source is shown in the source
1479 window otherwise it is simply printed. */
1482 print_source_lines (struct symtab
*s
, int line
, int stopline
,
1483 enum print_source_lines_flags flags
)
1485 print_source_lines_base (s
, line
, stopline
, flags
);
1488 /* Print info on range of pc's in a specified line. */
1491 line_info (char *arg
, int from_tty
)
1493 struct symtabs_and_lines sals
;
1494 struct symtab_and_line sal
;
1495 CORE_ADDR start_pc
, end_pc
;
1497 struct cleanup
*cleanups
;
1499 init_sal (&sal
); /* initialize to zeroes */
1503 sal
.symtab
= current_source_symtab
;
1504 sal
.pspace
= current_program_space
;
1505 if (last_line_listed
!= 0)
1506 sal
.line
= last_line_listed
;
1508 sal
.line
= current_source_line
;
1511 sals
.sals
= (struct symtab_and_line
*)
1512 xmalloc (sizeof (struct symtab_and_line
));
1517 sals
= decode_line_with_last_displayed (arg
, DECODE_LINE_LIST_MODE
);
1522 cleanups
= make_cleanup (xfree
, sals
.sals
);
1524 /* C++ More than one line may have been specified, as when the user
1525 specifies an overloaded function name. Print info on them all. */
1526 for (i
= 0; i
< sals
.nelts
; i
++)
1529 if (sal
.pspace
!= current_program_space
)
1532 if (sal
.symtab
== 0)
1534 struct gdbarch
*gdbarch
= get_current_arch ();
1536 printf_filtered (_("No line number information available"));
1539 /* This is useful for "info line *0x7f34". If we can't tell the
1540 user about a source line, at least let them have the symbolic
1542 printf_filtered (" for address ");
1544 print_address (gdbarch
, sal
.pc
, gdb_stdout
);
1547 printf_filtered (".");
1548 printf_filtered ("\n");
1550 else if (sal
.line
> 0
1551 && find_line_pc_range (sal
, &start_pc
, &end_pc
))
1553 struct gdbarch
*gdbarch
= get_objfile_arch (sal
.symtab
->objfile
);
1555 if (start_pc
== end_pc
)
1557 printf_filtered ("Line %d of \"%s\"",
1559 symtab_to_filename_for_display (sal
.symtab
));
1561 printf_filtered (" is at address ");
1562 print_address (gdbarch
, start_pc
, gdb_stdout
);
1564 printf_filtered (" but contains no code.\n");
1568 printf_filtered ("Line %d of \"%s\"",
1570 symtab_to_filename_for_display (sal
.symtab
));
1572 printf_filtered (" starts at address ");
1573 print_address (gdbarch
, start_pc
, gdb_stdout
);
1575 printf_filtered (" and ends at ");
1576 print_address (gdbarch
, end_pc
, gdb_stdout
);
1577 printf_filtered (".\n");
1580 /* x/i should display this line's code. */
1581 set_next_address (gdbarch
, start_pc
);
1583 /* Repeating "info line" should do the following line. */
1584 last_line_listed
= sal
.line
+ 1;
1586 /* If this is the only line, show the source code. If it could
1587 not find the file, don't do anything special. */
1588 if (annotation_level
&& sals
.nelts
== 1)
1589 identify_source_line (sal
.symtab
, sal
.line
, 0, start_pc
);
1592 /* Is there any case in which we get here, and have an address
1593 which the user would want to see? If we have debugging symbols
1594 and no line numbers? */
1595 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1596 sal
.line
, symtab_to_filename_for_display (sal
.symtab
));
1598 do_cleanups (cleanups
);
1601 /* Commands to search the source file for a regexp. */
1604 forward_search_command (char *regex
, int from_tty
)
1611 struct cleanup
*cleanups
;
1613 line
= last_line_listed
+ 1;
1615 msg
= (char *) re_comp (regex
);
1617 error (("%s"), msg
);
1619 if (current_source_symtab
== 0)
1620 select_source_symtab (0);
1622 desc
= open_source_file (current_source_symtab
);
1624 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1625 cleanups
= make_cleanup_close (desc
);
1627 if (current_source_symtab
->line_charpos
== 0)
1628 find_source_lines (current_source_symtab
, desc
);
1630 if (line
< 1 || line
> current_source_symtab
->nlines
)
1631 error (_("Expression not found"));
1633 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1634 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1636 discard_cleanups (cleanups
);
1637 stream
= fdopen (desc
, FDOPEN_MODE
);
1639 cleanups
= make_cleanup_fclose (stream
);
1642 static char *buf
= NULL
;
1644 int cursize
, newsize
;
1647 buf
= xmalloc (cursize
);
1656 if (p
- buf
== cursize
)
1658 newsize
= cursize
+ cursize
/ 2;
1659 buf
= xrealloc (buf
, newsize
);
1664 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1666 /* Remove the \r, if any, at the end of the line, otherwise
1667 regular expressions that end with $ or \n won't work. */
1668 if (p
- buf
> 1 && p
[-2] == '\r')
1674 /* We now have a source line in buf, null terminate and match. */
1676 if (re_exec (buf
) > 0)
1679 do_cleanups (cleanups
);
1680 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1681 set_internalvar_integer (lookup_internalvar ("_"), line
);
1682 current_source_line
= max (line
- lines_to_list
/ 2, 1);
1688 printf_filtered (_("Expression not found\n"));
1689 do_cleanups (cleanups
);
1693 reverse_search_command (char *regex
, int from_tty
)
1700 struct cleanup
*cleanups
;
1702 line
= last_line_listed
- 1;
1704 msg
= (char *) re_comp (regex
);
1706 error (("%s"), msg
);
1708 if (current_source_symtab
== 0)
1709 select_source_symtab (0);
1711 desc
= open_source_file (current_source_symtab
);
1713 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1714 cleanups
= make_cleanup_close (desc
);
1716 if (current_source_symtab
->line_charpos
== 0)
1717 find_source_lines (current_source_symtab
, desc
);
1719 if (line
< 1 || line
> current_source_symtab
->nlines
)
1720 error (_("Expression not found"));
1722 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1723 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1725 discard_cleanups (cleanups
);
1726 stream
= fdopen (desc
, FDOPEN_MODE
);
1728 cleanups
= make_cleanup_fclose (stream
);
1731 /* FIXME!!! We walk right off the end of buf if we get a long line!!! */
1732 char buf
[4096]; /* Should be reasonable??? */
1742 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1744 /* Remove the \r, if any, at the end of the line, otherwise
1745 regular expressions that end with $ or \n won't work. */
1746 if (p
- buf
> 1 && p
[-2] == '\r')
1752 /* We now have a source line in buf; null terminate and match. */
1754 if (re_exec (buf
) > 0)
1757 do_cleanups (cleanups
);
1758 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1759 set_internalvar_integer (lookup_internalvar ("_"), line
);
1760 current_source_line
= max (line
- lines_to_list
/ 2, 1);
1764 if (fseek (stream
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1766 const char *filename
;
1768 do_cleanups (cleanups
);
1769 filename
= symtab_to_filename_for_display (current_source_symtab
);
1770 perror_with_name (filename
);
1774 printf_filtered (_("Expression not found\n"));
1775 do_cleanups (cleanups
);
1779 /* If the last character of PATH is a directory separator, then strip it. */
1782 strip_trailing_directory_separator (char *path
)
1784 const int last
= strlen (path
) - 1;
1787 return; /* No stripping is needed if PATH is the empty string. */
1789 if (IS_DIR_SEPARATOR (path
[last
]))
1793 /* Return the path substitution rule that matches FROM.
1794 Return NULL if no rule matches. */
1796 static struct substitute_path_rule
*
1797 find_substitute_path_rule (const char *from
)
1799 struct substitute_path_rule
*rule
= substitute_path_rules
;
1801 while (rule
!= NULL
)
1803 if (FILENAME_CMP (rule
->from
, from
) == 0)
1811 /* Add a new substitute-path rule at the end of the current list of rules.
1812 The new rule will replace FROM into TO. */
1815 add_substitute_path_rule (char *from
, char *to
)
1817 struct substitute_path_rule
*rule
;
1818 struct substitute_path_rule
*new_rule
;
1820 new_rule
= xmalloc (sizeof (struct substitute_path_rule
));
1821 new_rule
->from
= xstrdup (from
);
1822 new_rule
->to
= xstrdup (to
);
1823 new_rule
->next
= NULL
;
1825 /* If the list of rules are empty, then insert the new rule
1826 at the head of the list. */
1828 if (substitute_path_rules
== NULL
)
1830 substitute_path_rules
= new_rule
;
1834 /* Otherwise, skip to the last rule in our list and then append
1837 rule
= substitute_path_rules
;
1838 while (rule
->next
!= NULL
)
1841 rule
->next
= new_rule
;
1844 /* Remove the given source path substitution rule from the current list
1845 of rules. The memory allocated for that rule is also deallocated. */
1848 delete_substitute_path_rule (struct substitute_path_rule
*rule
)
1850 if (rule
== substitute_path_rules
)
1851 substitute_path_rules
= rule
->next
;
1854 struct substitute_path_rule
*prev
= substitute_path_rules
;
1856 while (prev
!= NULL
&& prev
->next
!= rule
)
1859 gdb_assert (prev
!= NULL
);
1861 prev
->next
= rule
->next
;
1869 /* Implement the "show substitute-path" command. */
1872 show_substitute_path_command (char *args
, int from_tty
)
1874 struct substitute_path_rule
*rule
= substitute_path_rules
;
1877 struct cleanup
*cleanup
;
1879 argv
= gdb_buildargv (args
);
1880 cleanup
= make_cleanup_freeargv (argv
);
1882 /* We expect zero or one argument. */
1884 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1885 error (_("Too many arguments in command"));
1887 if (argv
!= NULL
&& argv
[0] != NULL
)
1890 /* Print the substitution rules. */
1894 (_("Source path substitution rule matching `%s':\n"), from
);
1896 printf_filtered (_("List of all source path substitution rules:\n"));
1898 while (rule
!= NULL
)
1900 if (from
== NULL
|| FILENAME_CMP (rule
->from
, from
) == 0)
1901 printf_filtered (" `%s' -> `%s'.\n", rule
->from
, rule
->to
);
1905 do_cleanups (cleanup
);
1908 /* Implement the "unset substitute-path" command. */
1911 unset_substitute_path_command (char *args
, int from_tty
)
1913 struct substitute_path_rule
*rule
= substitute_path_rules
;
1914 char **argv
= gdb_buildargv (args
);
1917 struct cleanup
*cleanup
;
1919 /* This function takes either 0 or 1 argument. */
1921 cleanup
= make_cleanup_freeargv (argv
);
1922 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1923 error (_("Incorrect usage, too many arguments in command"));
1925 if (argv
!= NULL
&& argv
[0] != NULL
)
1928 /* If the user asked for all the rules to be deleted, ask him
1929 to confirm and give him a chance to abort before the action
1933 && !query (_("Delete all source path substitution rules? ")))
1934 error (_("Canceled"));
1936 /* Delete the rule matching the argument. No argument means that
1937 all rules should be deleted. */
1939 while (rule
!= NULL
)
1941 struct substitute_path_rule
*next
= rule
->next
;
1943 if (from
== NULL
|| FILENAME_CMP (from
, rule
->from
) == 0)
1945 delete_substitute_path_rule (rule
);
1952 /* If the user asked for a specific rule to be deleted but
1953 we could not find it, then report an error. */
1955 if (from
!= NULL
&& !rule_found
)
1956 error (_("No substitution rule defined for `%s'"), from
);
1958 forget_cached_source_info ();
1960 do_cleanups (cleanup
);
1963 /* Add a new source path substitution rule. */
1966 set_substitute_path_command (char *args
, int from_tty
)
1969 struct substitute_path_rule
*rule
;
1970 struct cleanup
*cleanup
;
1972 argv
= gdb_buildargv (args
);
1973 cleanup
= make_cleanup_freeargv (argv
);
1975 if (argv
== NULL
|| argv
[0] == NULL
|| argv
[1] == NULL
)
1976 error (_("Incorrect usage, too few arguments in command"));
1978 if (argv
[2] != NULL
)
1979 error (_("Incorrect usage, too many arguments in command"));
1981 if (*(argv
[0]) == '\0')
1982 error (_("First argument must be at least one character long"));
1984 /* Strip any trailing directory separator character in either FROM
1985 or TO. The substitution rule already implicitly contains them. */
1986 strip_trailing_directory_separator (argv
[0]);
1987 strip_trailing_directory_separator (argv
[1]);
1989 /* If a rule with the same "from" was previously defined, then
1990 delete it. This new rule replaces it. */
1992 rule
= find_substitute_path_rule (argv
[0]);
1994 delete_substitute_path_rule (rule
);
1996 /* Insert the new substitution rule. */
1998 add_substitute_path_rule (argv
[0], argv
[1]);
1999 forget_cached_source_info ();
2001 do_cleanups (cleanup
);
2006 _initialize_source (void)
2008 struct cmd_list_element
*c
;
2010 current_source_symtab
= 0;
2011 init_source_path ();
2013 /* The intention is to use POSIX Basic Regular Expressions.
2014 Always use the GNU regex routine for consistency across all hosts.
2015 Our current GNU regex.c does not have all the POSIX features, so this is
2016 just an approximation. */
2017 re_set_syntax (RE_SYNTAX_GREP
);
2019 c
= add_cmd ("directory", class_files
, directory_command
, _("\
2020 Add directory DIR to beginning of search path for source files.\n\
2021 Forget cached info on source file locations and line positions.\n\
2022 DIR can also be $cwd for the current working directory, or $cdir for the\n\
2023 directory in which the source file was compiled into object code.\n\
2024 With no argument, reset the search path to $cdir:$cwd, the default."),
2028 add_com_alias ("use", "directory", class_files
, 0);
2030 set_cmd_completer (c
, filename_completer
);
2032 add_setshow_optional_filename_cmd ("directories",
2036 Set the search path for finding source files."),
2038 Show the search path for finding source files."),
2040 $cwd in the path means the current working directory.\n\
2041 $cdir in the path means the compilation directory of the source file.\n\
2042 GDB ensures the search path always ends with $cdir:$cwd by\n\
2043 appending these directories if necessary.\n\
2044 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
2045 set_directories_command
,
2046 show_directories_command
,
2047 &setlist
, &showlist
);
2051 add_com_alias ("D", "directory", class_files
, 0);
2052 add_cmd ("ld", no_class
, show_directories_1
, _("\
2053 Current search path for finding source files.\n\
2054 $cwd in the path means the current working directory.\n\
2055 $cdir in the path means the compilation directory of the source file."),
2059 add_info ("source", source_info
,
2060 _("Information about the current source file."));
2062 add_info ("line", line_info
, _("\
2063 Core addresses of the code for a source line.\n\
2064 Line can be specified as\n\
2065 LINENUM, to list around that line in current file,\n\
2066 FILE:LINENUM, to list around that line in that file,\n\
2067 FUNCTION, to list around beginning of that function,\n\
2068 FILE:FUNCTION, to distinguish among like-named static functions.\n\
2069 Default is to describe the last source line that was listed.\n\n\
2070 This sets the default address for \"x\" to the line's first instruction\n\
2071 so that \"x/i\" suffices to start examining the machine code.\n\
2072 The address is also stored as the value of \"$_\"."));
2074 add_com ("forward-search", class_files
, forward_search_command
, _("\
2075 Search for regular expression (see regex(3)) from last line listed.\n\
2076 The matching line number is also stored as the value of \"$_\"."));
2077 add_com_alias ("search", "forward-search", class_files
, 0);
2078 add_com_alias ("fo", "forward-search", class_files
, 1);
2080 add_com ("reverse-search", class_files
, reverse_search_command
, _("\
2081 Search backward for regular expression (see regex(3)) from last line listed.\n\
2082 The matching line number is also stored as the value of \"$_\"."));
2083 add_com_alias ("rev", "reverse-search", class_files
, 1);
2087 add_com_alias ("/", "forward-search", class_files
, 0);
2088 add_com_alias ("?", "reverse-search", class_files
, 0);
2091 add_setshow_integer_cmd ("listsize", class_support
, &lines_to_list
, _("\
2092 Set number of source lines gdb will list by default."), _("\
2093 Show number of source lines gdb will list by default."), _("\
2094 Use this to choose how many source lines the \"list\" displays (unless\n\
2095 the \"list\" argument explicitly specifies some other number).\n\
2096 A value of \"unlimited\", or zero, means there's no limit."),
2099 &setlist
, &showlist
);
2101 add_cmd ("substitute-path", class_files
, set_substitute_path_command
,
2103 Usage: set substitute-path FROM TO\n\
2104 Add a substitution rule replacing FROM into TO in source file names.\n\
2105 If a substitution rule was previously set for FROM, the old rule\n\
2106 is replaced by the new one."),
2109 add_cmd ("substitute-path", class_files
, unset_substitute_path_command
,
2111 Usage: unset substitute-path [FROM]\n\
2112 Delete the rule for substituting FROM in source file names. If FROM\n\
2113 is not specified, all substituting rules are deleted.\n\
2114 If the debugger cannot find a rule for FROM, it will display a warning."),
2117 add_cmd ("substitute-path", class_files
, show_substitute_path_command
,
2119 Usage: show substitute-path [FROM]\n\
2120 Print the rule for substituting FROM in source file names. If FROM\n\
2121 is not specified, print all substitution rules."),
2124 add_setshow_enum_cmd ("filename-display", class_files
,
2125 filename_display_kind_names
,
2126 &filename_display_string
, _("\
2127 Set how to display filenames."), _("\
2128 Show how to display filenames."), _("\
2129 filename-display can be:\n\
2130 basename - display only basename of a filename\n\
2131 relative - display a filename relative to the compilation directory\n\
2132 absolute - display an absolute filename\n\
2133 By default, relative filenames are displayed."),
2135 show_filename_display_string
,
2136 &setlist
, &showlist
);