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 "filestuff.h"
31 #include <sys/types.h>
35 #include "gdb_regex.h"
41 #include "filenames.h" /* for DOSish file names */
42 #include "completer.h"
44 #include "readline/readline.h"
46 #define OPEN_MODE (O_RDONLY | O_BINARY)
47 #define FDOPEN_MODE FOPEN_RB
49 /* Prototypes for exported functions. */
51 void _initialize_source (void);
53 /* Prototypes for local functions. */
55 static int get_filename_and_charpos (struct symtab
*, char **);
57 static void reverse_search_command (char *, int);
59 static void forward_search_command (char *, int);
61 static void line_info (char *, int);
63 static void source_info (char *, int);
65 /* Path of directories to search for source files.
66 Same format as the PATH environment variable's value. */
70 /* Support for source path substitution commands. */
72 struct substitute_path_rule
76 struct substitute_path_rule
*next
;
79 static struct substitute_path_rule
*substitute_path_rules
= NULL
;
81 /* Symtab of default file for listing lines of. */
83 static struct symtab
*current_source_symtab
;
85 /* Default next line to list. */
87 static int current_source_line
;
89 static struct program_space
*current_source_pspace
;
91 /* Default number of lines to print with commands like "list".
92 This is based on guessing how many long (i.e. more than chars_per_line
93 characters) lines there will be. To be completely correct, "list"
94 and friends should be rewritten to count characters and see where
95 things are wrapping, but that would be a fair amount of work. */
97 int lines_to_list
= 10;
99 show_lines_to_list (struct ui_file
*file
, int from_tty
,
100 struct cmd_list_element
*c
, const char *value
)
102 fprintf_filtered (file
,
103 _("Number of source lines gdb "
104 "will list by default is %s.\n"),
108 /* Possible values of 'set filename-display'. */
109 static const char filename_display_basename
[] = "basename";
110 static const char filename_display_relative
[] = "relative";
111 static const char filename_display_absolute
[] = "absolute";
113 static const char *const filename_display_kind_names
[] = {
114 filename_display_basename
,
115 filename_display_relative
,
116 filename_display_absolute
,
120 static const char *filename_display_string
= filename_display_relative
;
123 show_filename_display_string (struct ui_file
*file
, int from_tty
,
124 struct cmd_list_element
*c
, const char *value
)
126 fprintf_filtered (file
, _("Filenames are displayed as \"%s\".\n"), value
);
129 /* Line number of last line printed. Default for various commands.
130 current_source_line is usually, but not always, the same as this. */
132 static int last_line_listed
;
134 /* First line number listed by last listing command. If 0, then no
135 source lines have yet been listed since the last time the current
136 source line was changed. */
138 static int first_line_listed
;
140 /* Saves the name of the last source file visited and a possible error code.
141 Used to prevent repeating annoying "No such file or directories" msgs. */
143 static struct symtab
*last_source_visited
= NULL
;
144 static int last_source_error
= 0;
146 /* Return the first line listed by print_source_lines.
147 Used by command interpreters to request listing from
151 get_first_line_listed (void)
153 return first_line_listed
;
156 /* Clear line listed range. This makes the next "list" center the
157 printed source lines around the current source line. */
160 clear_lines_listed_range (void)
162 first_line_listed
= 0;
163 last_line_listed
= 0;
166 /* Return the default number of lines to print with commands like the
167 cli "list". The caller of print_source_lines must use this to
168 calculate the end line and use it in the call to print_source_lines
169 as it does not automatically use this value. */
172 get_lines_to_list (void)
174 return lines_to_list
;
177 /* Return the current source file for listing and next line to list.
178 NOTE: The returned sal pc and end fields are not valid. */
180 struct symtab_and_line
181 get_current_source_symtab_and_line (void)
183 struct symtab_and_line cursal
= { 0 };
185 cursal
.pspace
= current_source_pspace
;
186 cursal
.symtab
= current_source_symtab
;
187 cursal
.line
= current_source_line
;
194 /* If the current source file for listing is not set, try and get a default.
195 Usually called before get_current_source_symtab_and_line() is called.
196 It may err out if a default cannot be determined.
197 We must be cautious about where it is called, as it can recurse as the
198 process of determining a new default may call the caller!
199 Use get_current_source_symtab_and_line only to get whatever
200 we have without erroring out or trying to get a default. */
203 set_default_source_symtab_and_line (void)
205 if (!have_full_symbols () && !have_partial_symbols ())
206 error (_("No symbol table is loaded. Use the \"file\" command."));
208 /* Pull in a current source symtab if necessary. */
209 if (current_source_symtab
== 0)
210 select_source_symtab (0);
213 /* Return the current default file for listing and next line to list
214 (the returned sal pc and end fields are not valid.)
215 and set the current default to whatever is in SAL.
216 NOTE: The returned sal pc and end fields are not valid. */
218 struct symtab_and_line
219 set_current_source_symtab_and_line (const struct symtab_and_line
*sal
)
221 struct symtab_and_line cursal
= { 0 };
223 cursal
.pspace
= current_source_pspace
;
224 cursal
.symtab
= current_source_symtab
;
225 cursal
.line
= current_source_line
;
229 current_source_pspace
= sal
->pspace
;
230 current_source_symtab
= sal
->symtab
;
231 current_source_line
= sal
->line
;
233 /* Force the next "list" to center around the current line. */
234 clear_lines_listed_range ();
239 /* Reset any information stored about a default file and line to print. */
242 clear_current_source_symtab_and_line (void)
244 current_source_symtab
= 0;
245 current_source_line
= 0;
248 /* Set the source file default for the "list" command to be S.
250 If S is NULL, and we don't have a default, find one. This
251 should only be called when the user actually tries to use the
252 default, since we produce an error if we can't find a reasonable
253 default. Also, since this can cause symbols to be read, doing it
254 before we need to would make things slower than necessary. */
257 select_source_symtab (struct symtab
*s
)
259 struct symtabs_and_lines sals
;
260 struct symtab_and_line sal
;
265 current_source_symtab
= s
;
266 current_source_line
= 1;
267 current_source_pspace
= SYMTAB_PSPACE (s
);
271 if (current_source_symtab
)
274 /* Make the default place to list be the function `main'
276 if (lookup_symbol (main_name (), 0, VAR_DOMAIN
, 0))
278 sals
= decode_line_with_current_source (main_name (),
279 DECODE_LINE_FUNFIRSTLINE
);
282 current_source_pspace
= sal
.pspace
;
283 current_source_symtab
= sal
.symtab
;
284 current_source_line
= max (sal
.line
- (lines_to_list
- 1), 1);
285 if (current_source_symtab
)
289 /* Alright; find the last file in the symtab list (ignoring .h's
290 and namespace symtabs). */
292 current_source_line
= 1;
296 const char *name
= s
->filename
;
297 int len
= strlen (name
);
299 if (!(len
> 2 && (strcmp (&name
[len
- 2], ".h") == 0
300 || strcmp (name
, "<<C++-namespaces>>") == 0)))
302 current_source_pspace
= current_program_space
;
303 current_source_symtab
= s
;
307 if (current_source_symtab
)
313 s
= ofp
->sf
->qf
->find_last_source_symtab (ofp
);
315 current_source_symtab
= s
;
317 if (current_source_symtab
)
320 error (_("Can't find a default source file"));
323 /* Handler for "set directories path-list" command.
324 "set dir mumble" doesn't prepend paths, it resets the entire
325 path list. The theory is that set(show(dir)) should be a no-op. */
328 set_directories_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
330 /* This is the value that was set.
331 It needs to be processed to maintain $cdir:$cwd and remove dups. */
332 char *set_path
= source_path
;
334 /* We preserve the invariant that $cdir:$cwd begins life at the end of
335 the list by calling init_source_path. If they appear earlier in
336 SET_PATH then mod_path will move them appropriately.
337 mod_path will also remove duplicates. */
339 if (*set_path
!= '\0')
340 mod_path (set_path
, &source_path
);
345 /* Print the list of source directories.
346 This is used by the "ld" command, so it has the signature of a command
350 show_directories_1 (char *ignore
, int from_tty
)
352 puts_filtered ("Source directories searched: ");
353 puts_filtered (source_path
);
354 puts_filtered ("\n");
357 /* Handler for "show directories" command. */
360 show_directories_command (struct ui_file
*file
, int from_tty
,
361 struct cmd_list_element
*c
, const char *value
)
363 show_directories_1 (NULL
, from_tty
);
366 /* Forget line positions and file names for the symtabs in a
367 particular objfile. */
370 forget_cached_source_info_for_objfile (struct objfile
*objfile
)
374 ALL_OBJFILE_SYMTABS (objfile
, s
)
376 if (s
->line_charpos
!= NULL
)
378 xfree (s
->line_charpos
);
379 s
->line_charpos
= NULL
;
381 if (s
->fullname
!= NULL
)
389 objfile
->sf
->qf
->forget_cached_source_info (objfile
);
392 /* Forget what we learned about line positions in source files, and
393 which directories contain them; must check again now since files
394 may be found in a different directory now. */
397 forget_cached_source_info (void)
399 struct program_space
*pspace
;
400 struct objfile
*objfile
;
403 ALL_PSPACE_OBJFILES (pspace
, objfile
)
405 forget_cached_source_info_for_objfile (objfile
);
408 last_source_visited
= NULL
;
412 init_source_path (void)
416 xsnprintf (buf
, sizeof (buf
), "$cdir%c$cwd", DIRNAME_SEPARATOR
);
417 source_path
= xstrdup (buf
);
418 forget_cached_source_info ();
421 /* Add zero or more directories to the front of the source path. */
424 directory_command (char *dirname
, int from_tty
)
427 /* FIXME, this goes to "delete dir"... */
430 if (!from_tty
|| query (_("Reinitialize source path to empty? ")))
438 mod_path (dirname
, &source_path
);
439 forget_cached_source_info ();
442 show_directories_1 ((char *) 0, from_tty
);
445 /* Add a path given with the -d command line switch.
446 This will not be quoted so we must not treat spaces as separators. */
449 directory_switch (char *dirname
, int from_tty
)
451 add_path (dirname
, &source_path
, 0);
454 /* Add zero or more directories to the front of an arbitrary path. */
457 mod_path (char *dirname
, char **which_path
)
459 add_path (dirname
, which_path
, 1);
462 /* Workhorse of mod_path. Takes an extra argument to determine
463 if dirname should be parsed for separators that indicate multiple
464 directories. This allows for interfaces that pre-parse the dirname
465 and allow specification of traditional separator characters such
469 add_path (char *dirname
, char **which_path
, int parse_separators
)
471 char *old
= *which_path
;
473 VEC (char_ptr
) *dir_vec
= NULL
;
474 struct cleanup
*back_to
;
481 if (parse_separators
)
483 char **argv
, **argvp
;
485 /* This will properly parse the space and tab separators
486 and any quotes that may exist. */
487 argv
= gdb_buildargv (dirname
);
489 for (argvp
= argv
; *argvp
; argvp
++)
490 dirnames_to_char_ptr_vec_append (&dir_vec
, *argvp
);
495 VEC_safe_push (char_ptr
, dir_vec
, xstrdup (dirname
));
496 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
498 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, name
); ++ix
)
503 /* Spaces and tabs will have been removed by buildargv().
504 NAME is the start of the directory.
505 P is the '\0' following the end. */
506 p
= name
+ strlen (name
);
508 while (!(IS_DIR_SEPARATOR (*name
) && p
<= name
+ 1) /* "/" */
509 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
510 /* On MS-DOS and MS-Windows, h:\ is different from h: */
511 && !(p
== name
+ 3 && name
[1] == ':') /* "d:/" */
513 && IS_DIR_SEPARATOR (p
[-1]))
514 /* Sigh. "foo/" => "foo" */
518 while (p
> name
&& p
[-1] == '.')
522 /* "." => getwd (). */
523 name
= current_directory
;
526 else if (p
> name
+ 1 && IS_DIR_SEPARATOR (p
[-2]))
536 /* "...foo/." => "...foo". */
547 name
= tilde_expand (name
);
548 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
549 else if (IS_ABSOLUTE_PATH (name
) && p
== name
+ 2) /* "d:" => "d:." */
550 name
= concat (name
, ".", (char *)NULL
);
552 else if (!IS_ABSOLUTE_PATH (name
) && name
[0] != '$')
553 name
= concat (current_directory
, SLASH_STRING
, name
, (char *)NULL
);
555 name
= savestring (name
, p
- name
);
556 make_cleanup (xfree
, name
);
558 /* Unless it's a variable, check existence. */
561 /* These are warnings, not errors, since we don't want a
562 non-existent directory in a .gdbinit file to stop processing
563 of the .gdbinit file.
565 Whether they get added to the path is more debatable. Current
566 answer is yes, in case the user wants to go make the directory
567 or whatever. If the directory continues to not exist/not be
568 a directory/etc, then having them in the path should be
570 if (stat (name
, &st
) < 0)
572 int save_errno
= errno
;
574 fprintf_unfiltered (gdb_stderr
, "Warning: ");
575 print_sys_errmsg (name
, save_errno
);
577 else if ((st
.st_mode
& S_IFMT
) != S_IFDIR
)
578 warning (_("%s is not a directory."), name
);
583 unsigned int len
= strlen (name
);
589 /* FIXME: we should use realpath() or its work-alike
590 before comparing. Then all the code above which
591 removes excess slashes and dots could simply go away. */
592 if (!filename_ncmp (p
, name
, len
)
593 && (p
[len
] == '\0' || p
[len
] == DIRNAME_SEPARATOR
))
595 /* Found it in the search path, remove old copy. */
598 /* Back over leading separator. */
601 if (prefix
> p
- *which_path
)
603 /* Same dir twice in one cmd. */
606 /* Copy from next '\0' or ':'. */
607 memmove (p
, &p
[len
+ 1], strlen (&p
[len
+ 1]) + 1);
609 p
= strchr (p
, DIRNAME_SEPARATOR
);
616 tinybuf
[0] = DIRNAME_SEPARATOR
;
619 /* If we have already tacked on a name(s) in this command,
620 be sure they stay on the front as we tack on some
628 temp
= concat (old
, tinybuf
, name
, (char *)NULL
);
630 *which_path
= concat (temp
, "", &old
[prefix
], (char *) NULL
);
631 prefix
= strlen (temp
);
636 *which_path
= concat (name
, (old
[0] ? tinybuf
: old
),
638 prefix
= strlen (name
);
647 do_cleanups (back_to
);
652 source_info (char *ignore
, int from_tty
)
654 struct symtab
*s
= current_source_symtab
;
658 printf_filtered (_("No current source file.\n"));
661 printf_filtered (_("Current source file is %s\n"), s
->filename
);
663 printf_filtered (_("Compilation directory is %s\n"), s
->dirname
);
665 printf_filtered (_("Located in %s\n"), s
->fullname
);
667 printf_filtered (_("Contains %d line%s.\n"), s
->nlines
,
668 s
->nlines
== 1 ? "" : "s");
670 printf_filtered (_("Source language is %s.\n"), language_str (s
->language
));
671 printf_filtered (_("Compiled with %s debugging format.\n"), s
->debugformat
);
672 printf_filtered (_("%s preprocessor macro info.\n"),
673 s
->macro_table
? "Includes" : "Does not include");
677 /* Return True if the file NAME exists and is a regular file. */
679 is_regular_file (const char *name
)
682 const int status
= stat (name
, &st
);
684 /* Stat should never fail except when the file does not exist.
685 If stat fails, analyze the source of error and return True
686 unless the file does not exist, to avoid returning false results
687 on obscure systems where stat does not work as expected. */
690 return (errno
!= ENOENT
);
692 return S_ISREG (st
.st_mode
);
695 /* Open a file named STRING, searching path PATH (dir names sep by some char)
696 using mode MODE in the calls to open. You cannot use this function to
697 create files (O_CREAT).
699 OPTS specifies the function behaviour in specific cases.
701 If OPF_TRY_CWD_FIRST, try to open ./STRING before searching PATH.
702 (ie pretend the first element of PATH is "."). This also indicates
703 that, unless OPF_SEARCH_IN_PATH is also specified, a slash in STRING
704 disables searching of the path (this is so that "exec-file ./foo" or
705 "symbol-file ./foo" insures that you get that particular version of
706 foo or an error message).
708 If OPTS has OPF_SEARCH_IN_PATH set, absolute names will also be
709 searched in path (we usually want this for source files but not for
712 If FILENAME_OPENED is non-null, set it to a newly allocated string naming
713 the actual file opened (this string will always start with a "/"). We
714 have to take special pains to avoid doubling the "/" between the directory
715 and the file, sigh! Emacs gets confuzzed by this when we print the
718 If OPTS has OPF_RETURN_REALPATH set return FILENAME_OPENED resolved by
719 gdb_realpath. Even without OPF_RETURN_REALPATH this function still returns
720 filename starting with "/". If FILENAME_OPENED is NULL this option has no
723 If a file is found, return the descriptor.
724 Otherwise, return -1, with errno set for the last name we tried to open. */
726 /* >>>> This should only allow files of certain types,
727 >>>> eg executable, non-directory. */
729 openp (const char *path
, int opts
, const char *string
,
730 int mode
, char **filename_opened
)
735 VEC (char_ptr
) *dir_vec
;
736 struct cleanup
*back_to
;
740 /* The open syscall MODE parameter is not specified. */
741 gdb_assert ((mode
& O_CREAT
) == 0);
742 gdb_assert (string
!= NULL
);
744 /* A file with an empty name cannot possibly exist. Report a failure
745 without further checking.
747 This is an optimization which also defends us against buggy
748 implementations of the "stat" function. For instance, we have
749 noticed that a MinGW debugger built on Windows XP 32bits crashes
750 when the debugger is started with an empty argument. */
751 if (string
[0] == '\0')
762 if ((opts
& OPF_TRY_CWD_FIRST
) || IS_ABSOLUTE_PATH (string
))
766 if (is_regular_file (string
))
768 filename
= alloca (strlen (string
) + 1);
769 strcpy (filename
, string
);
770 fd
= gdb_open_cloexec (filename
, mode
, 0);
780 if (!(opts
& OPF_SEARCH_IN_PATH
))
781 for (i
= 0; string
[i
]; i
++)
782 if (IS_DIR_SEPARATOR (string
[i
]))
786 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
787 if (HAS_DRIVE_SPEC (string
))
788 string
= STRIP_DRIVE_SPEC (string
);
790 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
791 while (IS_DIR_SEPARATOR(string
[0]))
795 while (string
[0] == '.' && IS_DIR_SEPARATOR (string
[1]))
798 alloclen
= strlen (path
) + strlen (string
) + 2;
799 filename
= alloca (alloclen
);
802 dir_vec
= dirnames_to_char_ptr_vec (path
);
803 back_to
= make_cleanup_free_char_ptr_vec (dir_vec
);
805 for (ix
= 0; VEC_iterate (char_ptr
, dir_vec
, ix
, dir
); ++ix
)
807 size_t len
= strlen (dir
);
809 if (strcmp (dir
, "$cwd") == 0)
811 /* Name is $cwd -- insert current directory name instead. */
814 /* First, realloc the filename buffer if too short. */
815 len
= strlen (current_directory
);
816 newlen
= len
+ strlen (string
) + 2;
817 if (newlen
> alloclen
)
820 filename
= alloca (alloclen
);
822 strcpy (filename
, current_directory
);
824 else if (strchr(dir
, '~'))
826 /* See whether we need to expand the tilde. */
828 char *tilde_expanded
;
830 tilde_expanded
= tilde_expand (dir
);
832 /* First, realloc the filename buffer if too short. */
833 len
= strlen (tilde_expanded
);
834 newlen
= len
+ strlen (string
) + 2;
835 if (newlen
> alloclen
)
838 filename
= alloca (alloclen
);
840 strcpy (filename
, tilde_expanded
);
841 xfree (tilde_expanded
);
845 /* Normal file name in path -- just use it. */
846 strcpy (filename
, dir
);
848 /* Don't search $cdir. It's also a magic path like $cwd, but we
849 don't have enough information to expand it. The user *could*
850 have an actual directory named '$cdir' but handling that would
851 be confusing, it would mean different things in different
852 contexts. If the user really has '$cdir' one can use './$cdir'.
853 We can get $cdir when loading scripts. When loading source files
854 $cdir must have already been expanded to the correct value. */
855 if (strcmp (dir
, "$cdir") == 0)
859 /* Remove trailing slashes. */
860 while (len
> 0 && IS_DIR_SEPARATOR (filename
[len
- 1]))
863 strcat (filename
+ len
, SLASH_STRING
);
864 strcat (filename
, string
);
866 if (is_regular_file (filename
))
868 fd
= gdb_open_cloexec (filename
, mode
, 0);
874 do_cleanups (back_to
);
879 /* If a file was opened, canonicalize its filename. */
881 *filename_opened
= NULL
;
882 else if ((opts
& OPF_RETURN_REALPATH
) != 0)
883 *filename_opened
= gdb_realpath (filename
);
885 *filename_opened
= gdb_abspath (filename
);
892 /* This is essentially a convenience, for clients that want the behaviour
893 of openp, using source_path, but that really don't want the file to be
894 opened but want instead just to know what the full pathname is (as
895 qualified against source_path).
897 The current working directory is searched first.
899 If the file was found, this function returns 1, and FULL_PATHNAME is
900 set to the fully-qualified pathname.
902 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
904 source_full_path_of (const char *filename
, char **full_pathname
)
908 fd
= openp (source_path
,
909 OPF_TRY_CWD_FIRST
| OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
,
910 filename
, O_RDONLY
, full_pathname
);
913 *full_pathname
= NULL
;
921 /* Return non-zero if RULE matches PATH, that is if the rule can be
925 substitute_path_rule_matches (const struct substitute_path_rule
*rule
,
928 const int from_len
= strlen (rule
->from
);
929 const int path_len
= strlen (path
);
931 if (path_len
< from_len
)
934 /* The substitution rules are anchored at the start of the path,
935 so the path should start with rule->from. */
937 if (filename_ncmp (path
, rule
->from
, from_len
) != 0)
940 /* Make sure that the region in the path that matches the substitution
941 rule is immediately followed by a directory separator (or the end of
942 string character). */
944 if (path
[from_len
] != '\0' && !IS_DIR_SEPARATOR (path
[from_len
]))
950 /* Find the substitute-path rule that applies to PATH and return it.
951 Return NULL if no rule applies. */
953 static struct substitute_path_rule
*
954 get_substitute_path_rule (const char *path
)
956 struct substitute_path_rule
*rule
= substitute_path_rules
;
958 while (rule
!= NULL
&& !substitute_path_rule_matches (rule
, path
))
964 /* If the user specified a source path substitution rule that applies
965 to PATH, then apply it and return the new path. This new path must
966 be deallocated afterwards.
968 Return NULL if no substitution rule was specified by the user,
969 or if no rule applied to the given PATH. */
972 rewrite_source_path (const char *path
)
974 const struct substitute_path_rule
*rule
= get_substitute_path_rule (path
);
981 from_len
= strlen (rule
->from
);
983 /* Compute the rewritten path and return it. */
986 (char *) xmalloc (strlen (path
) + 1 + strlen (rule
->to
) - from_len
);
987 strcpy (new_path
, rule
->to
);
988 strcat (new_path
, path
+ from_len
);
994 find_and_open_source (const char *filename
,
998 char *path
= source_path
;
1001 struct cleanup
*cleanup
;
1003 /* Quick way out if we already know its full name. */
1007 /* The user may have requested that source paths be rewritten
1008 according to substitution rules he provided. If a substitution
1009 rule applies to this path, then apply it. */
1010 char *rewritten_fullname
= rewrite_source_path (*fullname
);
1012 if (rewritten_fullname
!= NULL
)
1015 *fullname
= rewritten_fullname
;
1018 result
= gdb_open_cloexec (*fullname
, OPEN_MODE
, 0);
1021 char *lpath
= gdb_realpath (*fullname
);
1028 /* Didn't work -- free old one, try again. */
1033 cleanup
= make_cleanup (null_cleanup
, NULL
);
1035 if (dirname
!= NULL
)
1037 /* If necessary, rewrite the compilation directory name according
1038 to the source path substitution rules specified by the user. */
1040 char *rewritten_dirname
= rewrite_source_path (dirname
);
1042 if (rewritten_dirname
!= NULL
)
1044 make_cleanup (xfree
, rewritten_dirname
);
1045 dirname
= rewritten_dirname
;
1048 /* Replace a path entry of $cdir with the compilation directory
1051 /* We cast strstr's result in case an ANSIhole has made it const,
1052 which produces a "required warning" when assigned to a nonconst. */
1053 p
= (char *) strstr (source_path
, "$cdir");
1054 if (p
&& (p
== path
|| p
[-1] == DIRNAME_SEPARATOR
)
1055 && (p
[cdir_len
] == DIRNAME_SEPARATOR
|| p
[cdir_len
] == '\0'))
1060 alloca (strlen (source_path
) + 1 + strlen (dirname
) + 1);
1061 len
= p
- source_path
;
1062 strncpy (path
, source_path
, len
); /* Before $cdir */
1063 strcpy (path
+ len
, dirname
); /* new stuff */
1064 strcat (path
+ len
, source_path
+ len
+ cdir_len
); /* After
1069 if (IS_ABSOLUTE_PATH (filename
))
1071 /* If filename is absolute path, try the source path
1072 substitution on it. */
1073 char *rewritten_filename
= rewrite_source_path (filename
);
1075 if (rewritten_filename
!= NULL
)
1077 make_cleanup (xfree
, rewritten_filename
);
1078 filename
= rewritten_filename
;
1082 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, filename
,
1083 OPEN_MODE
, fullname
);
1086 /* Didn't work. Try using just the basename. */
1087 p
= lbasename (filename
);
1089 result
= openp (path
, OPF_SEARCH_IN_PATH
| OPF_RETURN_REALPATH
, p
,
1090 OPEN_MODE
, fullname
);
1093 do_cleanups (cleanup
);
1097 /* Open a source file given a symtab S. Returns a file descriptor or
1098 negative number for error.
1100 This function is a convience function to find_and_open_source. */
1103 open_source_file (struct symtab
*s
)
1108 return find_and_open_source (s
->filename
, s
->dirname
, &s
->fullname
);
1111 /* Finds the fullname that a symtab represents.
1113 This functions finds the fullname and saves it in s->fullname.
1114 It will also return the value.
1116 If this function fails to find the file that this symtab represents,
1117 the expected fullname is used. Therefore the files does not have to
1121 symtab_to_fullname (struct symtab
*s
)
1123 /* Use cached copy if we have it.
1124 We rely on forget_cached_source_info being called appropriately
1125 to handle cases like the file being moved. */
1126 if (s
->fullname
== NULL
)
1128 int fd
= find_and_open_source (s
->filename
, s
->dirname
, &s
->fullname
);
1135 struct cleanup
*back_to
;
1137 /* rewrite_source_path would be applied by find_and_open_source, we
1138 should report the pathname where GDB tried to find the file. */
1140 if (s
->dirname
== NULL
|| IS_ABSOLUTE_PATH (s
->filename
))
1141 fullname
= xstrdup (s
->filename
);
1143 fullname
= concat (s
->dirname
, SLASH_STRING
, s
->filename
, NULL
);
1145 back_to
= make_cleanup (xfree
, fullname
);
1146 s
->fullname
= rewrite_source_path (fullname
);
1147 if (s
->fullname
== NULL
)
1148 s
->fullname
= xstrdup (fullname
);
1149 do_cleanups (back_to
);
1156 /* See commentary in source.h. */
1159 symtab_to_filename_for_display (struct symtab
*symtab
)
1161 if (filename_display_string
== filename_display_basename
)
1162 return lbasename (symtab
->filename
);
1163 else if (filename_display_string
== filename_display_absolute
)
1164 return symtab_to_fullname (symtab
);
1165 else if (filename_display_string
== filename_display_relative
)
1166 return symtab
->filename
;
1168 internal_error (__FILE__
, __LINE__
, _("invalid filename_display_string"));
1171 /* Create and initialize the table S->line_charpos that records
1172 the positions of the lines in the source file, which is assumed
1173 to be open on descriptor DESC.
1174 All set S->nlines to the number of such lines. */
1177 find_source_lines (struct symtab
*s
, int desc
)
1180 char *data
, *p
, *end
;
1182 int lines_allocated
= 1000;
1188 line_charpos
= (int *) xmalloc (lines_allocated
* sizeof (int));
1189 if (fstat (desc
, &st
) < 0)
1190 perror_with_name (symtab_to_filename_for_display (s
));
1192 if (s
->objfile
&& s
->objfile
->obfd
)
1193 mtime
= s
->objfile
->mtime
;
1195 mtime
= exec_bfd_mtime
;
1197 if (mtime
&& mtime
< st
.st_mtime
)
1198 warning (_("Source file is more recent than executable."));
1201 struct cleanup
*old_cleanups
;
1203 /* st_size might be a large type, but we only support source files whose
1204 size fits in an int. */
1205 size
= (int) st
.st_size
;
1207 /* Use malloc, not alloca, because this may be pretty large, and we may
1208 run into various kinds of limits on stack size. */
1209 data
= (char *) xmalloc (size
);
1210 old_cleanups
= make_cleanup (xfree
, data
);
1212 /* Reassign `size' to result of read for systems where \r\n -> \n. */
1213 size
= myread (desc
, data
, size
);
1215 perror_with_name (symtab_to_filename_for_display (s
));
1218 line_charpos
[0] = 0;
1223 /* A newline at the end does not start a new line. */
1226 if (nlines
== lines_allocated
)
1228 lines_allocated
*= 2;
1230 (int *) xrealloc ((char *) line_charpos
,
1231 sizeof (int) * lines_allocated
);
1233 line_charpos
[nlines
++] = p
- data
;
1236 do_cleanups (old_cleanups
);
1241 (int *) xrealloc ((char *) line_charpos
, nlines
* sizeof (int));
1247 /* Get full pathname and line number positions for a symtab.
1248 Return nonzero if line numbers may have changed.
1249 Set *FULLNAME to actual name of the file as found by `openp',
1250 or to 0 if the file is not found. */
1253 get_filename_and_charpos (struct symtab
*s
, char **fullname
)
1255 int desc
, linenums_changed
= 0;
1256 struct cleanup
*cleanups
;
1258 desc
= open_source_file (s
);
1265 cleanups
= make_cleanup_close (desc
);
1267 *fullname
= s
->fullname
;
1268 if (s
->line_charpos
== 0)
1269 linenums_changed
= 1;
1270 if (linenums_changed
)
1271 find_source_lines (s
, desc
);
1272 do_cleanups (cleanups
);
1273 return linenums_changed
;
1276 /* Print text describing the full name of the source file S
1277 and the line number LINE and its corresponding character position.
1278 The text starts with two Ctrl-z so that the Emacs-GDB interface
1281 MID_STATEMENT is nonzero if the PC is not at the beginning of that line.
1283 Return 1 if successful, 0 if could not find the file. */
1286 identify_source_line (struct symtab
*s
, int line
, int mid_statement
,
1289 if (s
->line_charpos
== 0)
1290 get_filename_and_charpos (s
, (char **) NULL
);
1291 if (s
->fullname
== 0)
1293 if (line
> s
->nlines
)
1294 /* Don't index off the end of the line_charpos array. */
1296 annotate_source (s
->fullname
, line
, s
->line_charpos
[line
- 1],
1297 mid_statement
, get_objfile_arch (s
->objfile
), pc
);
1299 current_source_line
= line
;
1300 current_source_symtab
= s
;
1301 clear_lines_listed_range ();
1306 /* Print source lines from the file of symtab S,
1307 starting with line number LINE and stopping before line number STOPLINE. */
1310 print_source_lines_base (struct symtab
*s
, int line
, int stopline
,
1311 enum print_source_lines_flags flags
)
1317 int nlines
= stopline
- line
;
1318 struct cleanup
*cleanup
;
1319 struct ui_out
*uiout
= current_uiout
;
1321 /* Regardless of whether we can open the file, set current_source_symtab. */
1322 current_source_symtab
= s
;
1323 current_source_line
= line
;
1324 first_line_listed
= line
;
1326 /* If printing of source lines is disabled, just print file and line
1328 if (ui_out_test_flags (uiout
, ui_source_list
))
1330 /* Only prints "No such file or directory" once. */
1331 if ((s
!= last_source_visited
) || (!last_source_error
))
1333 last_source_visited
= s
;
1334 desc
= open_source_file (s
);
1338 desc
= last_source_error
;
1339 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1344 desc
= last_source_error
;
1345 flags
|= PRINT_SOURCE_LINES_NOERROR
;
1349 if (desc
< 0 || noprint
)
1351 last_source_error
= desc
;
1353 if (!(flags
& PRINT_SOURCE_LINES_NOERROR
))
1355 const char *filename
= symtab_to_filename_for_display (s
);
1356 int len
= strlen (filename
) + 100;
1357 char *name
= alloca (len
);
1359 xsnprintf (name
, len
, "%d\t%s", line
, filename
);
1360 print_sys_errmsg (name
, errno
);
1364 ui_out_field_int (uiout
, "line", line
);
1365 ui_out_text (uiout
, "\tin ");
1367 /* CLI expects only the "file" field. TUI expects only the
1368 "fullname" field (and TUI does break if "file" is printed).
1369 MI expects both fields. ui_source_list is set only for CLI,
1371 if (ui_out_is_mi_like_p (uiout
)
1372 || ui_out_test_flags (uiout
, ui_source_list
))
1373 ui_out_field_string (uiout
, "file",
1374 symtab_to_filename_for_display (s
));
1375 if (ui_out_is_mi_like_p (uiout
)
1376 || !ui_out_test_flags (uiout
, ui_source_list
))
1378 const char *s_fullname
= symtab_to_fullname (s
);
1379 char *local_fullname
;
1381 /* ui_out_field_string may free S_FULLNAME by calling
1382 open_source_file for it again. See e.g.,
1383 tui_field_string->tui_show_source. */
1384 local_fullname
= alloca (strlen (s_fullname
) + 1);
1385 strcpy (local_fullname
, s_fullname
);
1387 ui_out_field_string (uiout
, "fullname", local_fullname
);
1390 ui_out_text (uiout
, "\n");
1396 last_source_error
= 0;
1398 if (s
->line_charpos
== 0)
1399 find_source_lines (s
, desc
);
1401 if (line
< 1 || line
> s
->nlines
)
1404 error (_("Line number %d out of range; %s has %d lines."),
1405 line
, symtab_to_filename_for_display (s
), s
->nlines
);
1408 if (lseek (desc
, s
->line_charpos
[line
- 1], 0) < 0)
1411 perror_with_name (symtab_to_filename_for_display (s
));
1414 stream
= fdopen (desc
, FDOPEN_MODE
);
1416 cleanup
= make_cleanup_fclose (stream
);
1418 while (nlines
-- > 0)
1425 last_line_listed
= current_source_line
;
1426 if (flags
& PRINT_SOURCE_LINES_FILENAME
)
1428 ui_out_text (uiout
, symtab_to_filename_for_display (s
));
1429 ui_out_text (uiout
, ":");
1431 xsnprintf (buf
, sizeof (buf
), "%d\t", current_source_line
++);
1432 ui_out_text (uiout
, buf
);
1435 if (c
< 040 && c
!= '\t' && c
!= '\n' && c
!= '\r')
1437 xsnprintf (buf
, sizeof (buf
), "^%c", c
+ 0100);
1438 ui_out_text (uiout
, buf
);
1441 ui_out_text (uiout
, "^?");
1444 /* Skip a \r character, but only before a \n. */
1445 int c1
= fgetc (stream
);
1448 printf_filtered ("^%c", c
+ 0100);
1450 ungetc (c1
, stream
);
1454 xsnprintf (buf
, sizeof (buf
), "%c", c
);
1455 ui_out_text (uiout
, buf
);
1458 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1461 do_cleanups (cleanup
);
1464 /* Show source lines from the file of symtab S, starting with line
1465 number LINE and stopping before line number STOPLINE. If this is
1466 not the command line version, then the source is shown in the source
1467 window otherwise it is simply printed. */
1470 print_source_lines (struct symtab
*s
, int line
, int stopline
,
1471 enum print_source_lines_flags flags
)
1473 print_source_lines_base (s
, line
, stopline
, flags
);
1476 /* Print info on range of pc's in a specified line. */
1479 line_info (char *arg
, int from_tty
)
1481 struct symtabs_and_lines sals
;
1482 struct symtab_and_line sal
;
1483 CORE_ADDR start_pc
, end_pc
;
1485 struct cleanup
*cleanups
;
1487 init_sal (&sal
); /* initialize to zeroes */
1491 sal
.symtab
= current_source_symtab
;
1492 sal
.pspace
= current_program_space
;
1493 if (last_line_listed
!= 0)
1494 sal
.line
= last_line_listed
;
1496 sal
.line
= current_source_line
;
1499 sals
.sals
= (struct symtab_and_line
*)
1500 xmalloc (sizeof (struct symtab_and_line
));
1505 sals
= decode_line_with_last_displayed (arg
, DECODE_LINE_LIST_MODE
);
1510 cleanups
= make_cleanup (xfree
, sals
.sals
);
1512 /* C++ More than one line may have been specified, as when the user
1513 specifies an overloaded function name. Print info on them all. */
1514 for (i
= 0; i
< sals
.nelts
; i
++)
1517 if (sal
.pspace
!= current_program_space
)
1520 if (sal
.symtab
== 0)
1522 struct gdbarch
*gdbarch
= get_current_arch ();
1524 printf_filtered (_("No line number information available"));
1527 /* This is useful for "info line *0x7f34". If we can't tell the
1528 user about a source line, at least let them have the symbolic
1530 printf_filtered (" for address ");
1532 print_address (gdbarch
, sal
.pc
, gdb_stdout
);
1535 printf_filtered (".");
1536 printf_filtered ("\n");
1538 else if (sal
.line
> 0
1539 && find_line_pc_range (sal
, &start_pc
, &end_pc
))
1541 struct gdbarch
*gdbarch
= get_objfile_arch (sal
.symtab
->objfile
);
1543 if (start_pc
== end_pc
)
1545 printf_filtered ("Line %d of \"%s\"",
1547 symtab_to_filename_for_display (sal
.symtab
));
1549 printf_filtered (" is at address ");
1550 print_address (gdbarch
, start_pc
, gdb_stdout
);
1552 printf_filtered (" but contains no code.\n");
1556 printf_filtered ("Line %d of \"%s\"",
1558 symtab_to_filename_for_display (sal
.symtab
));
1560 printf_filtered (" starts at address ");
1561 print_address (gdbarch
, start_pc
, gdb_stdout
);
1563 printf_filtered (" and ends at ");
1564 print_address (gdbarch
, end_pc
, gdb_stdout
);
1565 printf_filtered (".\n");
1568 /* x/i should display this line's code. */
1569 set_next_address (gdbarch
, start_pc
);
1571 /* Repeating "info line" should do the following line. */
1572 last_line_listed
= sal
.line
+ 1;
1574 /* If this is the only line, show the source code. If it could
1575 not find the file, don't do anything special. */
1576 if (annotation_level
&& sals
.nelts
== 1)
1577 identify_source_line (sal
.symtab
, sal
.line
, 0, start_pc
);
1580 /* Is there any case in which we get here, and have an address
1581 which the user would want to see? If we have debugging symbols
1582 and no line numbers? */
1583 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1584 sal
.line
, symtab_to_filename_for_display (sal
.symtab
));
1586 do_cleanups (cleanups
);
1589 /* Commands to search the source file for a regexp. */
1592 forward_search_command (char *regex
, int from_tty
)
1599 struct cleanup
*cleanups
;
1601 line
= last_line_listed
+ 1;
1603 msg
= (char *) re_comp (regex
);
1605 error (("%s"), msg
);
1607 if (current_source_symtab
== 0)
1608 select_source_symtab (0);
1610 desc
= open_source_file (current_source_symtab
);
1612 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1613 cleanups
= make_cleanup_close (desc
);
1615 if (current_source_symtab
->line_charpos
== 0)
1616 find_source_lines (current_source_symtab
, desc
);
1618 if (line
< 1 || line
> current_source_symtab
->nlines
)
1619 error (_("Expression not found"));
1621 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1622 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1624 discard_cleanups (cleanups
);
1625 stream
= fdopen (desc
, FDOPEN_MODE
);
1627 cleanups
= make_cleanup_fclose (stream
);
1630 static char *buf
= NULL
;
1632 int cursize
, newsize
;
1635 buf
= xmalloc (cursize
);
1644 if (p
- buf
== cursize
)
1646 newsize
= cursize
+ cursize
/ 2;
1647 buf
= xrealloc (buf
, newsize
);
1652 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1654 /* Remove the \r, if any, at the end of the line, otherwise
1655 regular expressions that end with $ or \n won't work. */
1656 if (p
- buf
> 1 && p
[-2] == '\r')
1662 /* We now have a source line in buf, null terminate and match. */
1664 if (re_exec (buf
) > 0)
1667 do_cleanups (cleanups
);
1668 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1669 set_internalvar_integer (lookup_internalvar ("_"), line
);
1670 current_source_line
= max (line
- lines_to_list
/ 2, 1);
1676 printf_filtered (_("Expression not found\n"));
1677 do_cleanups (cleanups
);
1681 reverse_search_command (char *regex
, int from_tty
)
1688 struct cleanup
*cleanups
;
1690 line
= last_line_listed
- 1;
1692 msg
= (char *) re_comp (regex
);
1694 error (("%s"), msg
);
1696 if (current_source_symtab
== 0)
1697 select_source_symtab (0);
1699 desc
= open_source_file (current_source_symtab
);
1701 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1702 cleanups
= make_cleanup_close (desc
);
1704 if (current_source_symtab
->line_charpos
== 0)
1705 find_source_lines (current_source_symtab
, desc
);
1707 if (line
< 1 || line
> current_source_symtab
->nlines
)
1708 error (_("Expression not found"));
1710 if (lseek (desc
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1711 perror_with_name (symtab_to_filename_for_display (current_source_symtab
));
1713 discard_cleanups (cleanups
);
1714 stream
= fdopen (desc
, FDOPEN_MODE
);
1716 cleanups
= make_cleanup_fclose (stream
);
1719 /* FIXME!!! We walk right off the end of buf if we get a long line!!! */
1720 char buf
[4096]; /* Should be reasonable??? */
1730 while (c
!= '\n' && (c
= fgetc (stream
)) >= 0);
1732 /* Remove the \r, if any, at the end of the line, otherwise
1733 regular expressions that end with $ or \n won't work. */
1734 if (p
- buf
> 1 && p
[-2] == '\r')
1740 /* We now have a source line in buf; null terminate and match. */
1742 if (re_exec (buf
) > 0)
1745 do_cleanups (cleanups
);
1746 print_source_lines (current_source_symtab
, line
, line
+ 1, 0);
1747 set_internalvar_integer (lookup_internalvar ("_"), line
);
1748 current_source_line
= max (line
- lines_to_list
/ 2, 1);
1752 if (fseek (stream
, current_source_symtab
->line_charpos
[line
- 1], 0) < 0)
1754 const char *filename
;
1756 do_cleanups (cleanups
);
1757 filename
= symtab_to_filename_for_display (current_source_symtab
);
1758 perror_with_name (filename
);
1762 printf_filtered (_("Expression not found\n"));
1763 do_cleanups (cleanups
);
1767 /* If the last character of PATH is a directory separator, then strip it. */
1770 strip_trailing_directory_separator (char *path
)
1772 const int last
= strlen (path
) - 1;
1775 return; /* No stripping is needed if PATH is the empty string. */
1777 if (IS_DIR_SEPARATOR (path
[last
]))
1781 /* Return the path substitution rule that matches FROM.
1782 Return NULL if no rule matches. */
1784 static struct substitute_path_rule
*
1785 find_substitute_path_rule (const char *from
)
1787 struct substitute_path_rule
*rule
= substitute_path_rules
;
1789 while (rule
!= NULL
)
1791 if (FILENAME_CMP (rule
->from
, from
) == 0)
1799 /* Add a new substitute-path rule at the end of the current list of rules.
1800 The new rule will replace FROM into TO. */
1803 add_substitute_path_rule (char *from
, char *to
)
1805 struct substitute_path_rule
*rule
;
1806 struct substitute_path_rule
*new_rule
;
1808 new_rule
= xmalloc (sizeof (struct substitute_path_rule
));
1809 new_rule
->from
= xstrdup (from
);
1810 new_rule
->to
= xstrdup (to
);
1811 new_rule
->next
= NULL
;
1813 /* If the list of rules are empty, then insert the new rule
1814 at the head of the list. */
1816 if (substitute_path_rules
== NULL
)
1818 substitute_path_rules
= new_rule
;
1822 /* Otherwise, skip to the last rule in our list and then append
1825 rule
= substitute_path_rules
;
1826 while (rule
->next
!= NULL
)
1829 rule
->next
= new_rule
;
1832 /* Remove the given source path substitution rule from the current list
1833 of rules. The memory allocated for that rule is also deallocated. */
1836 delete_substitute_path_rule (struct substitute_path_rule
*rule
)
1838 if (rule
== substitute_path_rules
)
1839 substitute_path_rules
= rule
->next
;
1842 struct substitute_path_rule
*prev
= substitute_path_rules
;
1844 while (prev
!= NULL
&& prev
->next
!= rule
)
1847 gdb_assert (prev
!= NULL
);
1849 prev
->next
= rule
->next
;
1857 /* Implement the "show substitute-path" command. */
1860 show_substitute_path_command (char *args
, int from_tty
)
1862 struct substitute_path_rule
*rule
= substitute_path_rules
;
1865 struct cleanup
*cleanup
;
1867 argv
= gdb_buildargv (args
);
1868 cleanup
= make_cleanup_freeargv (argv
);
1870 /* We expect zero or one argument. */
1872 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1873 error (_("Too many arguments in command"));
1875 if (argv
!= NULL
&& argv
[0] != NULL
)
1878 /* Print the substitution rules. */
1882 (_("Source path substitution rule matching `%s':\n"), from
);
1884 printf_filtered (_("List of all source path substitution rules:\n"));
1886 while (rule
!= NULL
)
1888 if (from
== NULL
|| substitute_path_rule_matches (rule
, from
) != 0)
1889 printf_filtered (" `%s' -> `%s'.\n", rule
->from
, rule
->to
);
1893 do_cleanups (cleanup
);
1896 /* Implement the "unset substitute-path" command. */
1899 unset_substitute_path_command (char *args
, int from_tty
)
1901 struct substitute_path_rule
*rule
= substitute_path_rules
;
1902 char **argv
= gdb_buildargv (args
);
1905 struct cleanup
*cleanup
;
1907 /* This function takes either 0 or 1 argument. */
1909 cleanup
= make_cleanup_freeargv (argv
);
1910 if (argv
!= NULL
&& argv
[0] != NULL
&& argv
[1] != NULL
)
1911 error (_("Incorrect usage, too many arguments in command"));
1913 if (argv
!= NULL
&& argv
[0] != NULL
)
1916 /* If the user asked for all the rules to be deleted, ask him
1917 to confirm and give him a chance to abort before the action
1921 && !query (_("Delete all source path substitution rules? ")))
1922 error (_("Canceled"));
1924 /* Delete the rule matching the argument. No argument means that
1925 all rules should be deleted. */
1927 while (rule
!= NULL
)
1929 struct substitute_path_rule
*next
= rule
->next
;
1931 if (from
== NULL
|| FILENAME_CMP (from
, rule
->from
) == 0)
1933 delete_substitute_path_rule (rule
);
1940 /* If the user asked for a specific rule to be deleted but
1941 we could not find it, then report an error. */
1943 if (from
!= NULL
&& !rule_found
)
1944 error (_("No substitution rule defined for `%s'"), from
);
1946 forget_cached_source_info ();
1948 do_cleanups (cleanup
);
1951 /* Add a new source path substitution rule. */
1954 set_substitute_path_command (char *args
, int from_tty
)
1957 struct substitute_path_rule
*rule
;
1958 struct cleanup
*cleanup
;
1960 argv
= gdb_buildargv (args
);
1961 cleanup
= make_cleanup_freeargv (argv
);
1963 if (argv
== NULL
|| argv
[0] == NULL
|| argv
[1] == NULL
)
1964 error (_("Incorrect usage, too few arguments in command"));
1966 if (argv
[2] != NULL
)
1967 error (_("Incorrect usage, too many arguments in command"));
1969 if (*(argv
[0]) == '\0')
1970 error (_("First argument must be at least one character long"));
1972 /* Strip any trailing directory separator character in either FROM
1973 or TO. The substitution rule already implicitly contains them. */
1974 strip_trailing_directory_separator (argv
[0]);
1975 strip_trailing_directory_separator (argv
[1]);
1977 /* If a rule with the same "from" was previously defined, then
1978 delete it. This new rule replaces it. */
1980 rule
= find_substitute_path_rule (argv
[0]);
1982 delete_substitute_path_rule (rule
);
1984 /* Insert the new substitution rule. */
1986 add_substitute_path_rule (argv
[0], argv
[1]);
1987 forget_cached_source_info ();
1989 do_cleanups (cleanup
);
1994 _initialize_source (void)
1996 struct cmd_list_element
*c
;
1998 current_source_symtab
= 0;
1999 init_source_path ();
2001 /* The intention is to use POSIX Basic Regular Expressions.
2002 Always use the GNU regex routine for consistency across all hosts.
2003 Our current GNU regex.c does not have all the POSIX features, so this is
2004 just an approximation. */
2005 re_set_syntax (RE_SYNTAX_GREP
);
2007 c
= add_cmd ("directory", class_files
, directory_command
, _("\
2008 Add directory DIR to beginning of search path for source files.\n\
2009 Forget cached info on source file locations and line positions.\n\
2010 DIR can also be $cwd for the current working directory, or $cdir for the\n\
2011 directory in which the source file was compiled into object code.\n\
2012 With no argument, reset the search path to $cdir:$cwd, the default."),
2016 add_com_alias ("use", "directory", class_files
, 0);
2018 set_cmd_completer (c
, filename_completer
);
2020 add_setshow_optional_filename_cmd ("directories",
2024 Set the search path for finding source files."),
2026 Show the search path for finding source files."),
2028 $cwd in the path means the current working directory.\n\
2029 $cdir in the path means the compilation directory of the source file.\n\
2030 GDB ensures the search path always ends with $cdir:$cwd by\n\
2031 appending these directories if necessary.\n\
2032 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
2033 set_directories_command
,
2034 show_directories_command
,
2035 &setlist
, &showlist
);
2039 add_com_alias ("D", "directory", class_files
, 0);
2040 add_cmd ("ld", no_class
, show_directories_1
, _("\
2041 Current search path for finding source files.\n\
2042 $cwd in the path means the current working directory.\n\
2043 $cdir in the path means the compilation directory of the source file."),
2047 add_info ("source", source_info
,
2048 _("Information about the current source file."));
2050 add_info ("line", line_info
, _("\
2051 Core addresses of the code for a source line.\n\
2052 Line can be specified as\n\
2053 LINENUM, to list around that line in current file,\n\
2054 FILE:LINENUM, to list around that line in that file,\n\
2055 FUNCTION, to list around beginning of that function,\n\
2056 FILE:FUNCTION, to distinguish among like-named static functions.\n\
2057 Default is to describe the last source line that was listed.\n\n\
2058 This sets the default address for \"x\" to the line's first instruction\n\
2059 so that \"x/i\" suffices to start examining the machine code.\n\
2060 The address is also stored as the value of \"$_\"."));
2062 add_com ("forward-search", class_files
, forward_search_command
, _("\
2063 Search for regular expression (see regex(3)) from last line listed.\n\
2064 The matching line number is also stored as the value of \"$_\"."));
2065 add_com_alias ("search", "forward-search", class_files
, 0);
2066 add_com_alias ("fo", "forward-search", class_files
, 1);
2068 add_com ("reverse-search", class_files
, reverse_search_command
, _("\
2069 Search backward for regular expression (see regex(3)) from last line listed.\n\
2070 The matching line number is also stored as the value of \"$_\"."));
2071 add_com_alias ("rev", "reverse-search", class_files
, 1);
2075 add_com_alias ("/", "forward-search", class_files
, 0);
2076 add_com_alias ("?", "reverse-search", class_files
, 0);
2079 add_setshow_integer_cmd ("listsize", class_support
, &lines_to_list
, _("\
2080 Set number of source lines gdb will list by default."), _("\
2081 Show number of source lines gdb will list by default."), _("\
2082 Use this to choose how many source lines the \"list\" displays (unless\n\
2083 the \"list\" argument explicitly specifies some other number).\n\
2084 A value of \"unlimited\", or zero, means there's no limit."),
2087 &setlist
, &showlist
);
2089 add_cmd ("substitute-path", class_files
, set_substitute_path_command
,
2091 Usage: set substitute-path FROM TO\n\
2092 Add a substitution rule replacing FROM into TO in source file names.\n\
2093 If a substitution rule was previously set for FROM, the old rule\n\
2094 is replaced by the new one."),
2097 add_cmd ("substitute-path", class_files
, unset_substitute_path_command
,
2099 Usage: unset substitute-path [FROM]\n\
2100 Delete the rule for substituting FROM in source file names. If FROM\n\
2101 is not specified, all substituting rules are deleted.\n\
2102 If the debugger cannot find a rule for FROM, it will display a warning."),
2105 add_cmd ("substitute-path", class_files
, show_substitute_path_command
,
2107 Usage: show substitute-path [FROM]\n\
2108 Print the rule for substituting FROM in source file names. If FROM\n\
2109 is not specified, print all substitution rules."),
2112 add_setshow_enum_cmd ("filename-display", class_files
,
2113 filename_display_kind_names
,
2114 &filename_display_string
, _("\
2115 Set how to display filenames."), _("\
2116 Show how to display filenames."), _("\
2117 filename-display can be:\n\
2118 basename - display only basename of a filename\n\
2119 relative - display a filename relative to the compilation directory\n\
2120 absolute - display an absolute filename\n\
2121 By default, relative filenames are displayed."),
2123 show_filename_display_string
,
2124 &setlist
, &showlist
);