1 /* List lines of source files for GDB, the GNU debugger.
2 Copyright (C) 1986-2018 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include "arch-utils.h"
22 #include "expression.h"
29 #include "filestuff.h"
31 #include <sys/types.h>
34 #include "gdb_regex.h"
40 #include "filenames.h" /* for DOSish file names */
41 #include "completer.h"
43 #include "readline/readline.h"
44 #include "common/enum-flags.h"
46 #include "common/pathstuff.h"
48 #define OPEN_MODE (O_RDONLY | O_BINARY)
49 #define FDOPEN_MODE FOPEN_RB
51 /* Prototypes for local functions. */
53 static int get_filename_and_charpos (struct symtab *, char **);
55 /* Path of directories to search for source files.
56 Same format as the PATH environment variable's value. */
60 /* Support for source path substitution commands. */
62 struct substitute_path_rule
66 struct substitute_path_rule *next;
69 static struct substitute_path_rule *substitute_path_rules = NULL;
71 /* Symtab of default file for listing lines of. */
73 static struct symtab *current_source_symtab;
75 /* Default next line to list. */
77 static int current_source_line;
79 static struct program_space *current_source_pspace;
81 /* Default number of lines to print with commands like "list".
82 This is based on guessing how many long (i.e. more than chars_per_line
83 characters) lines there will be. To be completely correct, "list"
84 and friends should be rewritten to count characters and see where
85 things are wrapping, but that would be a fair amount of work. */
87 static int lines_to_list = 10;
89 show_lines_to_list (struct ui_file *file, int from_tty,
90 struct cmd_list_element *c, const char *value)
92 fprintf_filtered (file,
93 _("Number of source lines gdb "
94 "will list by default is %s.\n"),
98 /* Possible values of 'set filename-display'. */
99 static const char filename_display_basename[] = "basename";
100 static const char filename_display_relative[] = "relative";
101 static const char filename_display_absolute[] = "absolute";
103 static const char *const filename_display_kind_names[] = {
104 filename_display_basename,
105 filename_display_relative,
106 filename_display_absolute,
110 static const char *filename_display_string = filename_display_relative;
113 show_filename_display_string (struct ui_file *file, int from_tty,
114 struct cmd_list_element *c, const char *value)
116 fprintf_filtered (file, _("Filenames are displayed as \"%s\".\n"), value);
119 /* Line number of last line printed. Default for various commands.
120 current_source_line is usually, but not always, the same as this. */
122 static int last_line_listed;
124 /* First line number listed by last listing command. If 0, then no
125 source lines have yet been listed since the last time the current
126 source line was changed. */
128 static int first_line_listed;
130 /* Saves the name of the last source file visited and a possible error code.
131 Used to prevent repeating annoying "No such file or directories" msgs. */
133 static struct symtab *last_source_visited = NULL;
134 static int last_source_error = 0;
136 /* Return the first line listed by print_source_lines.
137 Used by command interpreters to request listing from
141 get_first_line_listed (void)
143 return first_line_listed;
146 /* Clear line listed range. This makes the next "list" center the
147 printed source lines around the current source line. */
150 clear_lines_listed_range (void)
152 first_line_listed = 0;
153 last_line_listed = 0;
156 /* Return the default number of lines to print with commands like the
157 cli "list". The caller of print_source_lines must use this to
158 calculate the end line and use it in the call to print_source_lines
159 as it does not automatically use this value. */
162 get_lines_to_list (void)
164 return lines_to_list;
167 /* Return the current source file for listing and next line to list.
168 NOTE: The returned sal pc and end fields are not valid. */
170 struct symtab_and_line
171 get_current_source_symtab_and_line (void)
173 symtab_and_line cursal;
175 cursal.pspace = current_source_pspace;
176 cursal.symtab = current_source_symtab;
177 cursal.line = current_source_line;
184 /* If the current source file for listing is not set, try and get a default.
185 Usually called before get_current_source_symtab_and_line() is called.
186 It may err out if a default cannot be determined.
187 We must be cautious about where it is called, as it can recurse as the
188 process of determining a new default may call the caller!
189 Use get_current_source_symtab_and_line only to get whatever
190 we have without erroring out or trying to get a default. */
193 set_default_source_symtab_and_line (void)
195 if (!have_full_symbols () && !have_partial_symbols ())
196 error (_("No symbol table is loaded. Use the \"file\" command."));
198 /* Pull in a current source symtab if necessary. */
199 if (current_source_symtab == 0)
200 select_source_symtab (0);
203 /* Return the current default file for listing and next line to list
204 (the returned sal pc and end fields are not valid.)
205 and set the current default to whatever is in SAL.
206 NOTE: The returned sal pc and end fields are not valid. */
208 struct symtab_and_line
209 set_current_source_symtab_and_line (const symtab_and_line &sal)
211 symtab_and_line cursal;
213 cursal.pspace = current_source_pspace;
214 cursal.symtab = current_source_symtab;
215 cursal.line = current_source_line;
219 current_source_pspace = sal.pspace;
220 current_source_symtab = sal.symtab;
221 current_source_line = sal.line;
223 /* Force the next "list" to center around the current line. */
224 clear_lines_listed_range ();
229 /* Reset any information stored about a default file and line to print. */
232 clear_current_source_symtab_and_line (void)
234 current_source_symtab = 0;
235 current_source_line = 0;
238 /* Set the source file default for the "list" command to be S.
240 If S is NULL, and we don't have a default, find one. This
241 should only be called when the user actually tries to use the
242 default, since we produce an error if we can't find a reasonable
243 default. Also, since this can cause symbols to be read, doing it
244 before we need to would make things slower than necessary. */
247 select_source_symtab (struct symtab *s)
250 struct compunit_symtab *cu;
254 current_source_symtab = s;
255 current_source_line = 1;
256 current_source_pspace = SYMTAB_PSPACE (s);
260 if (current_source_symtab)
263 /* Make the default place to list be the function `main'
265 if (lookup_symbol (main_name (), 0, VAR_DOMAIN, 0).symbol)
267 std::vector<symtab_and_line> sals
268 = decode_line_with_current_source (main_name (),
269 DECODE_LINE_FUNFIRSTLINE);
270 const symtab_and_line &sal = sals[0];
271 current_source_pspace = sal.pspace;
272 current_source_symtab = sal.symtab;
273 current_source_line = std::max (sal.line - (lines_to_list - 1), 1);
274 if (current_source_symtab)
278 /* Alright; find the last file in the symtab list (ignoring .h's
279 and namespace symtabs). */
281 current_source_line = 1;
283 ALL_FILETABS (ofp, cu, s)
285 const char *name = s->filename;
286 int len = strlen (name);
288 if (!(len > 2 && (strcmp (&name[len - 2], ".h") == 0
289 || strcmp (name, "<<C++-namespaces>>") == 0)))
291 current_source_pspace = current_program_space;
292 current_source_symtab = s;
296 if (current_source_symtab)
302 s = ofp->sf->qf->find_last_source_symtab (ofp);
304 current_source_symtab = s;
306 if (current_source_symtab)
309 error (_("Can't find a default source file"));
312 /* Handler for "set directories path-list" command.
313 "set dir mumble" doesn't prepend paths, it resets the entire
314 path list. The theory is that set(show(dir)) should be a no-op. */
317 set_directories_command (const char *args,
318 int from_tty, struct cmd_list_element *c)
320 /* This is the value that was set.
321 It needs to be processed to maintain $cdir:$cwd and remove dups. */
322 char *set_path = source_path;
324 /* We preserve the invariant that $cdir:$cwd begins life at the end of
325 the list by calling init_source_path. If they appear earlier in
326 SET_PATH then mod_path will move them appropriately.
327 mod_path will also remove duplicates. */
329 if (*set_path != '\0')
330 mod_path (set_path, &source_path);
335 /* Print the list of source directories.
336 This is used by the "ld" command, so it has the signature of a command
340 show_directories_1 (char *ignore, int from_tty)
342 puts_filtered ("Source directories searched: ");
343 puts_filtered (source_path);
344 puts_filtered ("\n");
347 /* Handler for "show directories" command. */
350 show_directories_command (struct ui_file *file, int from_tty,
351 struct cmd_list_element *c, const char *value)
353 show_directories_1 (NULL, from_tty);
356 /* Forget line positions and file names for the symtabs in a
357 particular objfile. */
360 forget_cached_source_info_for_objfile (struct objfile *objfile)
362 struct compunit_symtab *cu;
365 ALL_OBJFILE_FILETABS (objfile, cu, s)
367 if (s->line_charpos != NULL)
369 xfree (s->line_charpos);
370 s->line_charpos = NULL;
372 if (s->fullname != NULL)
380 objfile->sf->qf->forget_cached_source_info (objfile);
383 /* Forget what we learned about line positions in source files, and
384 which directories contain them; must check again now since files
385 may be found in a different directory now. */
388 forget_cached_source_info (void)
390 struct program_space *pspace;
391 struct objfile *objfile;
394 ALL_PSPACE_OBJFILES (pspace, objfile)
396 forget_cached_source_info_for_objfile (objfile);
399 last_source_visited = NULL;
403 init_source_path (void)
407 xsnprintf (buf, sizeof (buf), "$cdir%c$cwd", DIRNAME_SEPARATOR);
408 source_path = xstrdup (buf);
409 forget_cached_source_info ();
412 /* Add zero or more directories to the front of the source path. */
415 directory_command (const char *dirname, int from_tty)
418 /* FIXME, this goes to "delete dir"... */
421 if (!from_tty || query (_("Reinitialize source path to empty? ")))
429 mod_path (dirname, &source_path);
430 forget_cached_source_info ();
433 show_directories_1 ((char *) 0, from_tty);
436 /* Add a path given with the -d command line switch.
437 This will not be quoted so we must not treat spaces as separators. */
440 directory_switch (const char *dirname, int from_tty)
442 add_path (dirname, &source_path, 0);
445 /* Add zero or more directories to the front of an arbitrary path. */
448 mod_path (const char *dirname, char **which_path)
450 add_path (dirname, which_path, 1);
453 /* Workhorse of mod_path. Takes an extra argument to determine
454 if dirname should be parsed for separators that indicate multiple
455 directories. This allows for interfaces that pre-parse the dirname
456 and allow specification of traditional separator characters such
460 add_path (const char *dirname, char **which_path, int parse_separators)
462 char *old = *which_path;
464 VEC (char_ptr) *dir_vec = NULL;
465 struct cleanup *back_to;
472 if (parse_separators)
474 /* This will properly parse the space and tab separators
475 and any quotes that may exist. */
476 gdb_argv argv (dirname);
478 for (char *arg : argv)
479 dirnames_to_char_ptr_vec_append (&dir_vec, arg);
482 VEC_safe_push (char_ptr, dir_vec, xstrdup (dirname));
483 back_to = make_cleanup_free_char_ptr_vec (dir_vec);
485 for (ix = 0; VEC_iterate (char_ptr, dir_vec, ix, name); ++ix)
490 /* Spaces and tabs will have been removed by buildargv().
491 NAME is the start of the directory.
492 P is the '\0' following the end. */
493 p = name + strlen (name);
495 while (!(IS_DIR_SEPARATOR (*name) && p <= name + 1) /* "/" */
496 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
497 /* On MS-DOS and MS-Windows, h:\ is different from h: */
498 && !(p == name + 3 && name[1] == ':') /* "d:/" */
500 && IS_DIR_SEPARATOR (p[-1]))
501 /* Sigh. "foo/" => "foo" */
505 while (p > name && p[-1] == '.')
509 /* "." => getwd (). */
510 name = current_directory;
513 else if (p > name + 1 && IS_DIR_SEPARATOR (p[-2]))
523 /* "...foo/." => "...foo". */
534 name = tilde_expand (name);
535 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
536 else if (IS_ABSOLUTE_PATH (name) && p == name + 2) /* "d:" => "d:." */
537 name = concat (name, ".", (char *)NULL);
539 else if (!IS_ABSOLUTE_PATH (name) && name[0] != '$')
540 name = concat (current_directory, SLASH_STRING, name, (char *)NULL);
542 name = savestring (name, p - name);
543 make_cleanup (xfree, name);
545 /* Unless it's a variable, check existence. */
548 /* These are warnings, not errors, since we don't want a
549 non-existent directory in a .gdbinit file to stop processing
550 of the .gdbinit file.
552 Whether they get added to the path is more debatable. Current
553 answer is yes, in case the user wants to go make the directory
554 or whatever. If the directory continues to not exist/not be
555 a directory/etc, then having them in the path should be
557 if (stat (name, &st) < 0)
559 int save_errno = errno;
561 fprintf_unfiltered (gdb_stderr, "Warning: ");
562 print_sys_errmsg (name, save_errno);
564 else if ((st.st_mode & S_IFMT) != S_IFDIR)
565 warning (_("%s is not a directory."), name);
570 unsigned int len = strlen (name);
576 /* FIXME: we should use realpath() or its work-alike
577 before comparing. Then all the code above which
578 removes excess slashes and dots could simply go away. */
579 if (!filename_ncmp (p, name, len)
580 && (p[len] == '\0' || p[len] == DIRNAME_SEPARATOR))
582 /* Found it in the search path, remove old copy. */
585 /* Back over leading separator. */
588 if (prefix > p - *which_path)
590 /* Same dir twice in one cmd. */
593 /* Copy from next '\0' or ':'. */
594 memmove (p, &p[len + 1], strlen (&p[len + 1]) + 1);
596 p = strchr (p, DIRNAME_SEPARATOR);
603 tinybuf[0] = DIRNAME_SEPARATOR;
606 /* If we have already tacked on a name(s) in this command,
607 be sure they stay on the front as we tack on some
615 temp = concat (old, tinybuf, name, (char *)NULL);
617 *which_path = concat (temp, "", &old[prefix], (char *) NULL);
618 prefix = strlen (temp);
623 *which_path = concat (name, (old[0] ? tinybuf : old),
625 prefix = strlen (name);
634 do_cleanups (back_to);
639 info_source_command (const char *ignore, int from_tty)
641 struct symtab *s = current_source_symtab;
642 struct compunit_symtab *cust;
646 printf_filtered (_("No current source file.\n"));
650 cust = SYMTAB_COMPUNIT (s);
651 printf_filtered (_("Current source file is %s\n"), s->filename);
652 if (SYMTAB_DIRNAME (s) != NULL)
653 printf_filtered (_("Compilation directory is %s\n"), SYMTAB_DIRNAME (s));
655 printf_filtered (_("Located in %s\n"), s->fullname);
657 printf_filtered (_("Contains %d line%s.\n"), s->nlines,
658 s->nlines == 1 ? "" : "s");
660 printf_filtered (_("Source language is %s.\n"), language_str (s->language));
661 printf_filtered (_("Producer is %s.\n"),
662 COMPUNIT_PRODUCER (cust) != NULL
663 ? COMPUNIT_PRODUCER (cust) : _("unknown"));
664 printf_filtered (_("Compiled with %s debugging format.\n"),
665 COMPUNIT_DEBUGFORMAT (cust));
666 printf_filtered (_("%s preprocessor macro info.\n"),
667 COMPUNIT_MACRO_TABLE (cust) != NULL
668 ? "Includes" : "Does not include");
672 /* Open a file named STRING, searching path PATH (dir names sep by some char)
673 using mode MODE in the calls to open. You cannot use this function to
674 create files (O_CREAT).
676 OPTS specifies the function behaviour in specific cases.
678 If OPF_TRY_CWD_FIRST, try to open ./STRING before searching PATH.
679 (ie pretend the first element of PATH is "."). This also indicates
680 that, unless OPF_SEARCH_IN_PATH is also specified, a slash in STRING
681 disables searching of the path (this is so that "exec-file ./foo" or
682 "symbol-file ./foo" insures that you get that particular version of
683 foo or an error message).
685 If OPTS has OPF_SEARCH_IN_PATH set, absolute names will also be
686 searched in path (we usually want this for source files but not for
689 If FILENAME_OPENED is non-null, set it to a newly allocated string naming
690 the actual file opened (this string will always start with a "/"). We
691 have to take special pains to avoid doubling the "/" between the directory
692 and the file, sigh! Emacs gets confuzzed by this when we print the
695 If OPTS has OPF_RETURN_REALPATH set return FILENAME_OPENED resolved by
696 gdb_realpath. Even without OPF_RETURN_REALPATH this function still returns
697 filename starting with "/". If FILENAME_OPENED is NULL this option has no
700 If a file is found, return the descriptor.
701 Otherwise, return -1, with errno set for the last name we tried to open. */
703 /* >>>> This should only allow files of certain types,
704 >>>> eg executable, non-directory. */
706 openp (const char *path, openp_flags opts, const char *string,
707 int mode, gdb::unique_xmalloc_ptr<char> *filename_opened)
712 VEC (char_ptr) *dir_vec;
713 struct cleanup *back_to;
716 /* The errno set for the last name we tried to open (and
720 /* The open syscall MODE parameter is not specified. */
721 gdb_assert ((mode & O_CREAT) == 0);
722 gdb_assert (string != NULL);
724 /* A file with an empty name cannot possibly exist. Report a failure
725 without further checking.
727 This is an optimization which also defends us against buggy
728 implementations of the "stat" function. For instance, we have
729 noticed that a MinGW debugger built on Windows XP 32bits crashes
730 when the debugger is started with an empty argument. */
731 if (string[0] == '\0')
742 if ((opts & OPF_TRY_CWD_FIRST) || IS_ABSOLUTE_PATH (string))
744 int i, reg_file_errno;
746 if (is_regular_file (string, ®_file_errno))
748 filename = (char *) alloca (strlen (string) + 1);
749 strcpy (filename, string);
750 fd = gdb_open_cloexec (filename, mode, 0);
759 last_errno = reg_file_errno;
762 if (!(opts & OPF_SEARCH_IN_PATH))
763 for (i = 0; string[i]; i++)
764 if (IS_DIR_SEPARATOR (string[i]))
768 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
769 if (HAS_DRIVE_SPEC (string))
770 string = STRIP_DRIVE_SPEC (string);
772 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
773 while (IS_DIR_SEPARATOR(string[0]))
777 while (string[0] == '.' && IS_DIR_SEPARATOR (string[1]))
780 alloclen = strlen (path) + strlen (string) + 2;
781 filename = (char *) alloca (alloclen);
785 dir_vec = dirnames_to_char_ptr_vec (path);
786 back_to = make_cleanup_free_char_ptr_vec (dir_vec);
788 for (ix = 0; VEC_iterate (char_ptr, dir_vec, ix, dir); ++ix)
790 size_t len = strlen (dir);
793 if (strcmp (dir, "$cwd") == 0)
795 /* Name is $cwd -- insert current directory name instead. */
798 /* First, realloc the filename buffer if too short. */
799 len = strlen (current_directory);
800 newlen = len + strlen (string) + 2;
801 if (newlen > alloclen)
804 filename = (char *) alloca (alloclen);
806 strcpy (filename, current_directory);
808 else if (strchr(dir, '~'))
810 /* See whether we need to expand the tilde. */
813 gdb::unique_xmalloc_ptr<char> tilde_expanded (tilde_expand (dir));
815 /* First, realloc the filename buffer if too short. */
816 len = strlen (tilde_expanded.get ());
817 newlen = len + strlen (string) + 2;
818 if (newlen > alloclen)
821 filename = (char *) alloca (alloclen);
823 strcpy (filename, tilde_expanded.get ());
827 /* Normal file name in path -- just use it. */
828 strcpy (filename, dir);
830 /* Don't search $cdir. It's also a magic path like $cwd, but we
831 don't have enough information to expand it. The user *could*
832 have an actual directory named '$cdir' but handling that would
833 be confusing, it would mean different things in different
834 contexts. If the user really has '$cdir' one can use './$cdir'.
835 We can get $cdir when loading scripts. When loading source files
836 $cdir must have already been expanded to the correct value. */
837 if (strcmp (dir, "$cdir") == 0)
841 /* Remove trailing slashes. */
842 while (len > 0 && IS_DIR_SEPARATOR (filename[len - 1]))
845 strcat (filename + len, SLASH_STRING);
846 strcat (filename, string);
848 if (is_regular_file (filename, ®_file_errno))
850 fd = gdb_open_cloexec (filename, mode, 0);
856 last_errno = reg_file_errno;
859 do_cleanups (back_to);
864 /* If a file was opened, canonicalize its filename. */
866 filename_opened->reset (NULL);
867 else if ((opts & OPF_RETURN_REALPATH) != 0)
868 *filename_opened = gdb_realpath (filename);
870 *filename_opened = gdb_abspath (filename);
878 /* This is essentially a convenience, for clients that want the behaviour
879 of openp, using source_path, but that really don't want the file to be
880 opened but want instead just to know what the full pathname is (as
881 qualified against source_path).
883 The current working directory is searched first.
885 If the file was found, this function returns 1, and FULL_PATHNAME is
886 set to the fully-qualified pathname.
888 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
890 source_full_path_of (const char *filename,
891 gdb::unique_xmalloc_ptr<char> *full_pathname)
895 fd = openp (source_path,
896 OPF_TRY_CWD_FIRST | OPF_SEARCH_IN_PATH | OPF_RETURN_REALPATH,
897 filename, O_RDONLY, full_pathname);
900 full_pathname->reset (NULL);
908 /* Return non-zero if RULE matches PATH, that is if the rule can be
912 substitute_path_rule_matches (const struct substitute_path_rule *rule,
915 const int from_len = strlen (rule->from);
916 const int path_len = strlen (path);
918 if (path_len < from_len)
921 /* The substitution rules are anchored at the start of the path,
922 so the path should start with rule->from. */
924 if (filename_ncmp (path, rule->from, from_len) != 0)
927 /* Make sure that the region in the path that matches the substitution
928 rule is immediately followed by a directory separator (or the end of
929 string character). */
931 if (path[from_len] != '\0' && !IS_DIR_SEPARATOR (path[from_len]))
937 /* Find the substitute-path rule that applies to PATH and return it.
938 Return NULL if no rule applies. */
940 static struct substitute_path_rule *
941 get_substitute_path_rule (const char *path)
943 struct substitute_path_rule *rule = substitute_path_rules;
945 while (rule != NULL && !substitute_path_rule_matches (rule, path))
951 /* If the user specified a source path substitution rule that applies
952 to PATH, then apply it and return the new path.
954 Return NULL if no substitution rule was specified by the user,
955 or if no rule applied to the given PATH. */
957 gdb::unique_xmalloc_ptr<char>
958 rewrite_source_path (const char *path)
960 const struct substitute_path_rule *rule = get_substitute_path_rule (path);
967 from_len = strlen (rule->from);
969 /* Compute the rewritten path and return it. */
972 (char *) xmalloc (strlen (path) + 1 + strlen (rule->to) - from_len);
973 strcpy (new_path, rule->to);
974 strcat (new_path, path + from_len);
976 return gdb::unique_xmalloc_ptr<char> (new_path);
980 find_and_open_source (const char *filename,
982 gdb::unique_xmalloc_ptr<char> *fullname)
984 char *path = source_path;
988 /* Quick way out if we already know its full name. */
992 /* The user may have requested that source paths be rewritten
993 according to substitution rules he provided. If a substitution
994 rule applies to this path, then apply it. */
995 gdb::unique_xmalloc_ptr<char> rewritten_fullname
996 = rewrite_source_path (fullname->get ());
998 if (rewritten_fullname != NULL)
999 *fullname = std::move (rewritten_fullname);
1001 result = gdb_open_cloexec (fullname->get (), OPEN_MODE, 0);
1004 *fullname = gdb_realpath (fullname->get ());
1008 /* Didn't work -- free old one, try again. */
1009 fullname->reset (NULL);
1012 gdb::unique_xmalloc_ptr<char> rewritten_dirname;
1013 if (dirname != NULL)
1015 /* If necessary, rewrite the compilation directory name according
1016 to the source path substitution rules specified by the user. */
1018 rewritten_dirname = rewrite_source_path (dirname);
1020 if (rewritten_dirname != NULL)
1021 dirname = rewritten_dirname.get ();
1023 /* Replace a path entry of $cdir with the compilation directory
1026 /* We cast strstr's result in case an ANSIhole has made it const,
1027 which produces a "required warning" when assigned to a nonconst. */
1028 p = (char *) strstr (source_path, "$cdir");
1029 if (p && (p == path || p[-1] == DIRNAME_SEPARATOR)
1030 && (p[cdir_len] == DIRNAME_SEPARATOR || p[cdir_len] == '\0'))
1035 alloca (strlen (source_path) + 1 + strlen (dirname) + 1);
1036 len = p - source_path;
1037 strncpy (path, source_path, len); /* Before $cdir */
1038 strcpy (path + len, dirname); /* new stuff */
1039 strcat (path + len, source_path + len + cdir_len); /* After
1044 gdb::unique_xmalloc_ptr<char> rewritten_filename;
1045 if (IS_ABSOLUTE_PATH (filename))
1047 /* If filename is absolute path, try the source path
1048 substitution on it. */
1049 rewritten_filename = rewrite_source_path (filename);
1051 if (rewritten_filename != NULL)
1052 filename = rewritten_filename.get ();
1055 result = openp (path, OPF_SEARCH_IN_PATH | OPF_RETURN_REALPATH, filename,
1056 OPEN_MODE, fullname);
1059 /* Didn't work. Try using just the basename. */
1060 p = lbasename (filename);
1062 result = openp (path, OPF_SEARCH_IN_PATH | OPF_RETURN_REALPATH, p,
1063 OPEN_MODE, fullname);
1069 /* Open a source file given a symtab S. Returns a file descriptor or
1070 negative number for error.
1072 This function is a convience function to find_and_open_source. */
1075 open_source_file (struct symtab *s)
1080 gdb::unique_xmalloc_ptr<char> fullname;
1081 int fd = find_and_open_source (s->filename, SYMTAB_DIRNAME (s), &fullname);
1082 s->fullname = fullname.release ();
1086 /* Finds the fullname that a symtab represents.
1088 This functions finds the fullname and saves it in s->fullname.
1089 It will also return the value.
1091 If this function fails to find the file that this symtab represents,
1092 the expected fullname is used. Therefore the files does not have to
1096 symtab_to_fullname (struct symtab *s)
1098 /* Use cached copy if we have it.
1099 We rely on forget_cached_source_info being called appropriately
1100 to handle cases like the file being moved. */
1101 if (s->fullname == NULL)
1103 int fd = open_source_file (s);
1109 gdb::unique_xmalloc_ptr<char> fullname;
1111 /* rewrite_source_path would be applied by find_and_open_source, we
1112 should report the pathname where GDB tried to find the file. */
1114 if (SYMTAB_DIRNAME (s) == NULL || IS_ABSOLUTE_PATH (s->filename))
1115 fullname.reset (xstrdup (s->filename));
1117 fullname.reset (concat (SYMTAB_DIRNAME (s), SLASH_STRING,
1118 s->filename, (char *) NULL));
1120 s->fullname = rewrite_source_path (fullname.get ()).release ();
1121 if (s->fullname == NULL)
1122 s->fullname = fullname.release ();
1129 /* See commentary in source.h. */
1132 symtab_to_filename_for_display (struct symtab *symtab)
1134 if (filename_display_string == filename_display_basename)
1135 return lbasename (symtab->filename);
1136 else if (filename_display_string == filename_display_absolute)
1137 return symtab_to_fullname (symtab);
1138 else if (filename_display_string == filename_display_relative)
1139 return symtab->filename;
1141 internal_error (__FILE__, __LINE__, _("invalid filename_display_string"));
1144 /* Create and initialize the table S->line_charpos that records
1145 the positions of the lines in the source file, which is assumed
1146 to be open on descriptor DESC.
1147 All set S->nlines to the number of such lines. */
1150 find_source_lines (struct symtab *s, int desc)
1155 int lines_allocated = 1000;
1161 line_charpos = XNEWVEC (int, lines_allocated);
1162 if (fstat (desc, &st) < 0)
1163 perror_with_name (symtab_to_filename_for_display (s));
1165 if (SYMTAB_OBJFILE (s) != NULL && SYMTAB_OBJFILE (s)->obfd != NULL)
1166 mtime = SYMTAB_OBJFILE (s)->mtime;
1168 mtime = exec_bfd_mtime;
1170 if (mtime && mtime < st.st_mtime)
1171 warning (_("Source file is more recent than executable."));
1174 /* st_size might be a large type, but we only support source files whose
1175 size fits in an int. */
1176 size = (int) st.st_size;
1178 /* Use the heap, not the stack, because this may be pretty large,
1179 and we may run into various kinds of limits on stack size. */
1180 gdb::def_vector<char> data (size);
1182 /* Reassign `size' to result of read for systems where \r\n -> \n. */
1183 size = myread (desc, data.data (), size);
1185 perror_with_name (symtab_to_filename_for_display (s));
1186 end = data.data () + size;
1188 line_charpos[0] = 0;
1193 /* A newline at the end does not start a new line. */
1196 if (nlines == lines_allocated)
1198 lines_allocated *= 2;
1200 (int *) xrealloc ((char *) line_charpos,
1201 sizeof (int) * lines_allocated);
1203 line_charpos[nlines++] = p - data.data ();
1210 (int *) xrealloc ((char *) line_charpos, nlines * sizeof (int));
1216 /* Get full pathname and line number positions for a symtab.
1217 Return nonzero if line numbers may have changed.
1218 Set *FULLNAME to actual name of the file as found by `openp',
1219 or to 0 if the file is not found. */
1222 get_filename_and_charpos (struct symtab *s, char **fullname)
1224 int desc, linenums_changed = 0;
1225 struct cleanup *cleanups;
1227 desc = open_source_file (s);
1234 cleanups = make_cleanup_close (desc);
1236 *fullname = s->fullname;
1237 if (s->line_charpos == 0)
1238 linenums_changed = 1;
1239 if (linenums_changed)
1240 find_source_lines (s, desc);
1241 do_cleanups (cleanups);
1242 return linenums_changed;
1245 /* Print text describing the full name of the source file S
1246 and the line number LINE and its corresponding character position.
1247 The text starts with two Ctrl-z so that the Emacs-GDB interface
1250 MID_STATEMENT is nonzero if the PC is not at the beginning of that line.
1252 Return 1 if successful, 0 if could not find the file. */
1255 identify_source_line (struct symtab *s, int line, int mid_statement,
1258 if (s->line_charpos == 0)
1259 get_filename_and_charpos (s, (char **) NULL);
1260 if (s->fullname == 0)
1262 if (line > s->nlines)
1263 /* Don't index off the end of the line_charpos array. */
1265 annotate_source (s->fullname, line, s->line_charpos[line - 1],
1266 mid_statement, get_objfile_arch (SYMTAB_OBJFILE (s)), pc);
1268 current_source_line = line;
1269 current_source_symtab = s;
1270 clear_lines_listed_range ();
1275 /* Print source lines from the file of symtab S,
1276 starting with line number LINE and stopping before line number STOPLINE. */
1279 print_source_lines_base (struct symtab *s, int line, int stopline,
1280 print_source_lines_flags flags)
1285 int nlines = stopline - line;
1286 struct ui_out *uiout = current_uiout;
1288 /* Regardless of whether we can open the file, set current_source_symtab. */
1289 current_source_symtab = s;
1290 current_source_line = line;
1291 first_line_listed = line;
1293 /* If printing of source lines is disabled, just print file and line
1295 if (uiout->test_flags (ui_source_list))
1297 /* Only prints "No such file or directory" once. */
1298 if ((s != last_source_visited) || (!last_source_error))
1300 last_source_visited = s;
1301 desc = open_source_file (s);
1305 desc = last_source_error;
1306 flags |= PRINT_SOURCE_LINES_NOERROR;
1311 desc = last_source_error;
1312 flags |= PRINT_SOURCE_LINES_NOERROR;
1316 if (desc < 0 || noprint)
1318 last_source_error = desc;
1320 if (!(flags & PRINT_SOURCE_LINES_NOERROR))
1322 const char *filename = symtab_to_filename_for_display (s);
1323 int len = strlen (filename) + 100;
1324 char *name = (char *) alloca (len);
1326 xsnprintf (name, len, "%d\t%s", line, filename);
1327 print_sys_errmsg (name, errno);
1331 uiout->field_int ("line", line);
1332 uiout->text ("\tin ");
1334 /* CLI expects only the "file" field. TUI expects only the
1335 "fullname" field (and TUI does break if "file" is printed).
1336 MI expects both fields. ui_source_list is set only for CLI,
1338 if (uiout->is_mi_like_p () || uiout->test_flags (ui_source_list))
1339 uiout->field_string ("file", symtab_to_filename_for_display (s));
1340 if (uiout->is_mi_like_p () || !uiout->test_flags (ui_source_list))
1342 const char *s_fullname = symtab_to_fullname (s);
1343 char *local_fullname;
1345 /* ui_out_field_string may free S_FULLNAME by calling
1346 open_source_file for it again. See e.g.,
1347 tui_field_string->tui_show_source. */
1348 local_fullname = (char *) alloca (strlen (s_fullname) + 1);
1349 strcpy (local_fullname, s_fullname);
1351 uiout->field_string ("fullname", local_fullname);
1360 last_source_error = 0;
1362 if (s->line_charpos == 0)
1363 find_source_lines (s, desc);
1365 if (line < 1 || line > s->nlines)
1368 error (_("Line number %d out of range; %s has %d lines."),
1369 line, symtab_to_filename_for_display (s), s->nlines);
1372 if (lseek (desc, s->line_charpos[line - 1], 0) < 0)
1375 perror_with_name (symtab_to_filename_for_display (s));
1378 gdb_file_up stream (fdopen (desc, FDOPEN_MODE));
1379 clearerr (stream.get ());
1381 while (nlines-- > 0)
1385 c = fgetc (stream.get ());
1388 last_line_listed = current_source_line;
1389 if (flags & PRINT_SOURCE_LINES_FILENAME)
1391 uiout->text (symtab_to_filename_for_display (s));
1394 xsnprintf (buf, sizeof (buf), "%d\t", current_source_line++);
1398 if (c < 040 && c != '\t' && c != '\n' && c != '\r')
1400 xsnprintf (buf, sizeof (buf), "^%c", c + 0100);
1407 /* Skip a \r character, but only before a \n. */
1408 int c1 = fgetc (stream.get ());
1411 printf_filtered ("^%c", c + 0100);
1413 ungetc (c1, stream.get ());
1417 xsnprintf (buf, sizeof (buf), "%c", c);
1421 while (c != '\n' && (c = fgetc (stream.get ())) >= 0);
1425 /* Show source lines from the file of symtab S, starting with line
1426 number LINE and stopping before line number STOPLINE. If this is
1427 not the command line version, then the source is shown in the source
1428 window otherwise it is simply printed. */
1431 print_source_lines (struct symtab *s, int line, int stopline,
1432 print_source_lines_flags flags)
1434 print_source_lines_base (s, line, stopline, flags);
1437 /* Print info on range of pc's in a specified line. */
1440 info_line_command (const char *arg, int from_tty)
1442 CORE_ADDR start_pc, end_pc;
1444 std::vector<symtab_and_line> decoded_sals;
1445 symtab_and_line curr_sal;
1446 gdb::array_view<symtab_and_line> sals;
1450 curr_sal.symtab = current_source_symtab;
1451 curr_sal.pspace = current_program_space;
1452 if (last_line_listed != 0)
1453 curr_sal.line = last_line_listed;
1455 curr_sal.line = current_source_line;
1461 decoded_sals = decode_line_with_last_displayed (arg,
1462 DECODE_LINE_LIST_MODE);
1463 sals = decoded_sals;
1468 /* C++ More than one line may have been specified, as when the user
1469 specifies an overloaded function name. Print info on them all. */
1470 for (const auto &sal : sals)
1472 if (sal.pspace != current_program_space)
1475 if (sal.symtab == 0)
1477 struct gdbarch *gdbarch = get_current_arch ();
1479 printf_filtered (_("No line number information available"));
1482 /* This is useful for "info line *0x7f34". If we can't tell the
1483 user about a source line, at least let them have the symbolic
1485 printf_filtered (" for address ");
1487 print_address (gdbarch, sal.pc, gdb_stdout);
1490 printf_filtered (".");
1491 printf_filtered ("\n");
1493 else if (sal.line > 0
1494 && find_line_pc_range (sal, &start_pc, &end_pc))
1496 struct gdbarch *gdbarch
1497 = get_objfile_arch (SYMTAB_OBJFILE (sal.symtab));
1499 if (start_pc == end_pc)
1501 printf_filtered ("Line %d of \"%s\"",
1503 symtab_to_filename_for_display (sal.symtab));
1505 printf_filtered (" is at address ");
1506 print_address (gdbarch, start_pc, gdb_stdout);
1508 printf_filtered (" but contains no code.\n");
1512 printf_filtered ("Line %d of \"%s\"",
1514 symtab_to_filename_for_display (sal.symtab));
1516 printf_filtered (" starts at address ");
1517 print_address (gdbarch, start_pc, gdb_stdout);
1519 printf_filtered (" and ends at ");
1520 print_address (gdbarch, end_pc, gdb_stdout);
1521 printf_filtered (".\n");
1524 /* x/i should display this line's code. */
1525 set_next_address (gdbarch, start_pc);
1527 /* Repeating "info line" should do the following line. */
1528 last_line_listed = sal.line + 1;
1530 /* If this is the only line, show the source code. If it could
1531 not find the file, don't do anything special. */
1532 if (annotation_level && sals.size () == 1)
1533 identify_source_line (sal.symtab, sal.line, 0, start_pc);
1536 /* Is there any case in which we get here, and have an address
1537 which the user would want to see? If we have debugging symbols
1538 and no line numbers? */
1539 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1540 sal.line, symtab_to_filename_for_display (sal.symtab));
1544 /* Commands to search the source file for a regexp. */
1547 forward_search_command (const char *regex, int from_tty)
1553 struct cleanup *cleanups;
1555 line = last_line_listed + 1;
1557 msg = (char *) re_comp (regex);
1559 error (("%s"), msg);
1561 if (current_source_symtab == 0)
1562 select_source_symtab (0);
1564 desc = open_source_file (current_source_symtab);
1566 perror_with_name (symtab_to_filename_for_display (current_source_symtab));
1567 cleanups = make_cleanup_close (desc);
1569 if (current_source_symtab->line_charpos == 0)
1570 find_source_lines (current_source_symtab, desc);
1572 if (line < 1 || line > current_source_symtab->nlines)
1573 error (_("Expression not found"));
1575 if (lseek (desc, current_source_symtab->line_charpos[line - 1], 0) < 0)
1576 perror_with_name (symtab_to_filename_for_display (current_source_symtab));
1578 discard_cleanups (cleanups);
1579 gdb_file_up stream (fdopen (desc, FDOPEN_MODE));
1580 clearerr (stream.get ());
1583 static char *buf = NULL;
1585 int cursize, newsize;
1588 buf = (char *) xmalloc (cursize);
1591 c = fgetc (stream.get ());
1597 if (p - buf == cursize)
1599 newsize = cursize + cursize / 2;
1600 buf = (char *) xrealloc (buf, newsize);
1605 while (c != '\n' && (c = fgetc (stream.get ())) >= 0);
1607 /* Remove the \r, if any, at the end of the line, otherwise
1608 regular expressions that end with $ or \n won't work. */
1609 if (p - buf > 1 && p[-2] == '\r')
1615 /* We now have a source line in buf, null terminate and match. */
1617 if (re_exec (buf) > 0)
1620 print_source_lines (current_source_symtab, line, line + 1, 0);
1621 set_internalvar_integer (lookup_internalvar ("_"), line);
1622 current_source_line = std::max (line - lines_to_list / 2, 1);
1628 printf_filtered (_("Expression not found\n"));
1632 reverse_search_command (const char *regex, int from_tty)
1638 struct cleanup *cleanups;
1640 line = last_line_listed - 1;
1642 msg = (char *) re_comp (regex);
1644 error (("%s"), msg);
1646 if (current_source_symtab == 0)
1647 select_source_symtab (0);
1649 desc = open_source_file (current_source_symtab);
1651 perror_with_name (symtab_to_filename_for_display (current_source_symtab));
1652 cleanups = make_cleanup_close (desc);
1654 if (current_source_symtab->line_charpos == 0)
1655 find_source_lines (current_source_symtab, desc);
1657 if (line < 1 || line > current_source_symtab->nlines)
1658 error (_("Expression not found"));
1660 if (lseek (desc, current_source_symtab->line_charpos[line - 1], 0) < 0)
1661 perror_with_name (symtab_to_filename_for_display (current_source_symtab));
1663 discard_cleanups (cleanups);
1664 gdb_file_up stream (fdopen (desc, FDOPEN_MODE));
1665 clearerr (stream.get ());
1668 /* FIXME!!! We walk right off the end of buf if we get a long line!!! */
1669 char buf[4096]; /* Should be reasonable??? */
1672 c = fgetc (stream.get ());
1679 while (c != '\n' && (c = fgetc (stream.get ())) >= 0);
1681 /* Remove the \r, if any, at the end of the line, otherwise
1682 regular expressions that end with $ or \n won't work. */
1683 if (p - buf > 1 && p[-2] == '\r')
1689 /* We now have a source line in buf; null terminate and match. */
1691 if (re_exec (buf) > 0)
1694 print_source_lines (current_source_symtab, line, line + 1, 0);
1695 set_internalvar_integer (lookup_internalvar ("_"), line);
1696 current_source_line = std::max (line - lines_to_list / 2, 1);
1700 if (fseek (stream.get (),
1701 current_source_symtab->line_charpos[line - 1], 0) < 0)
1703 const char *filename;
1705 filename = symtab_to_filename_for_display (current_source_symtab);
1706 perror_with_name (filename);
1710 printf_filtered (_("Expression not found\n"));
1714 /* If the last character of PATH is a directory separator, then strip it. */
1717 strip_trailing_directory_separator (char *path)
1719 const int last = strlen (path) - 1;
1722 return; /* No stripping is needed if PATH is the empty string. */
1724 if (IS_DIR_SEPARATOR (path[last]))
1728 /* Return the path substitution rule that matches FROM.
1729 Return NULL if no rule matches. */
1731 static struct substitute_path_rule *
1732 find_substitute_path_rule (const char *from)
1734 struct substitute_path_rule *rule = substitute_path_rules;
1736 while (rule != NULL)
1738 if (FILENAME_CMP (rule->from, from) == 0)
1746 /* Add a new substitute-path rule at the end of the current list of rules.
1747 The new rule will replace FROM into TO. */
1750 add_substitute_path_rule (char *from, char *to)
1752 struct substitute_path_rule *rule;
1753 struct substitute_path_rule *new_rule = XNEW (struct substitute_path_rule);
1755 new_rule->from = xstrdup (from);
1756 new_rule->to = xstrdup (to);
1757 new_rule->next = NULL;
1759 /* If the list of rules are empty, then insert the new rule
1760 at the head of the list. */
1762 if (substitute_path_rules == NULL)
1764 substitute_path_rules = new_rule;
1768 /* Otherwise, skip to the last rule in our list and then append
1771 rule = substitute_path_rules;
1772 while (rule->next != NULL)
1775 rule->next = new_rule;
1778 /* Remove the given source path substitution rule from the current list
1779 of rules. The memory allocated for that rule is also deallocated. */
1782 delete_substitute_path_rule (struct substitute_path_rule *rule)
1784 if (rule == substitute_path_rules)
1785 substitute_path_rules = rule->next;
1788 struct substitute_path_rule *prev = substitute_path_rules;
1790 while (prev != NULL && prev->next != rule)
1793 gdb_assert (prev != NULL);
1795 prev->next = rule->next;
1803 /* Implement the "show substitute-path" command. */
1806 show_substitute_path_command (const char *args, int from_tty)
1808 struct substitute_path_rule *rule = substitute_path_rules;
1811 gdb_argv argv (args);
1813 /* We expect zero or one argument. */
1815 if (argv != NULL && argv[0] != NULL && argv[1] != NULL)
1816 error (_("Too many arguments in command"));
1818 if (argv != NULL && argv[0] != NULL)
1821 /* Print the substitution rules. */
1825 (_("Source path substitution rule matching `%s':\n"), from);
1827 printf_filtered (_("List of all source path substitution rules:\n"));
1829 while (rule != NULL)
1831 if (from == NULL || substitute_path_rule_matches (rule, from) != 0)
1832 printf_filtered (" `%s' -> `%s'.\n", rule->from, rule->to);
1837 /* Implement the "unset substitute-path" command. */
1840 unset_substitute_path_command (const char *args, int from_tty)
1842 struct substitute_path_rule *rule = substitute_path_rules;
1843 gdb_argv argv (args);
1847 /* This function takes either 0 or 1 argument. */
1849 if (argv != NULL && argv[0] != NULL && argv[1] != NULL)
1850 error (_("Incorrect usage, too many arguments in command"));
1852 if (argv != NULL && argv[0] != NULL)
1855 /* If the user asked for all the rules to be deleted, ask him
1856 to confirm and give him a chance to abort before the action
1860 && !query (_("Delete all source path substitution rules? ")))
1861 error (_("Canceled"));
1863 /* Delete the rule matching the argument. No argument means that
1864 all rules should be deleted. */
1866 while (rule != NULL)
1868 struct substitute_path_rule *next = rule->next;
1870 if (from == NULL || FILENAME_CMP (from, rule->from) == 0)
1872 delete_substitute_path_rule (rule);
1879 /* If the user asked for a specific rule to be deleted but
1880 we could not find it, then report an error. */
1882 if (from != NULL && !rule_found)
1883 error (_("No substitution rule defined for `%s'"), from);
1885 forget_cached_source_info ();
1888 /* Add a new source path substitution rule. */
1891 set_substitute_path_command (const char *args, int from_tty)
1893 struct substitute_path_rule *rule;
1895 gdb_argv argv (args);
1897 if (argv == NULL || argv[0] == NULL || argv [1] == NULL)
1898 error (_("Incorrect usage, too few arguments in command"));
1900 if (argv[2] != NULL)
1901 error (_("Incorrect usage, too many arguments in command"));
1903 if (*(argv[0]) == '\0')
1904 error (_("First argument must be at least one character long"));
1906 /* Strip any trailing directory separator character in either FROM
1907 or TO. The substitution rule already implicitly contains them. */
1908 strip_trailing_directory_separator (argv[0]);
1909 strip_trailing_directory_separator (argv[1]);
1911 /* If a rule with the same "from" was previously defined, then
1912 delete it. This new rule replaces it. */
1914 rule = find_substitute_path_rule (argv[0]);
1916 delete_substitute_path_rule (rule);
1918 /* Insert the new substitution rule. */
1920 add_substitute_path_rule (argv[0], argv[1]);
1921 forget_cached_source_info ();
1926 _initialize_source (void)
1928 struct cmd_list_element *c;
1930 current_source_symtab = 0;
1931 init_source_path ();
1933 /* The intention is to use POSIX Basic Regular Expressions.
1934 Always use the GNU regex routine for consistency across all hosts.
1935 Our current GNU regex.c does not have all the POSIX features, so this is
1936 just an approximation. */
1937 re_set_syntax (RE_SYNTAX_GREP);
1939 c = add_cmd ("directory", class_files, directory_command, _("\
1940 Add directory DIR to beginning of search path for source files.\n\
1941 Forget cached info on source file locations and line positions.\n\
1942 DIR can also be $cwd for the current working directory, or $cdir for the\n\
1943 directory in which the source file was compiled into object code.\n\
1944 With no argument, reset the search path to $cdir:$cwd, the default."),
1948 add_com_alias ("use", "directory", class_files, 0);
1950 set_cmd_completer (c, filename_completer);
1952 add_setshow_optional_filename_cmd ("directories",
1956 Set the search path for finding source files."),
1958 Show the search path for finding source files."),
1960 $cwd in the path means the current working directory.\n\
1961 $cdir in the path means the compilation directory of the source file.\n\
1962 GDB ensures the search path always ends with $cdir:$cwd by\n\
1963 appending these directories if necessary.\n\
1964 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
1965 set_directories_command,
1966 show_directories_command,
1967 &setlist, &showlist);
1969 add_info ("source", info_source_command,
1970 _("Information about the current source file."));
1972 add_info ("line", info_line_command, _("\
1973 Core addresses of the code for a source line.\n\
1974 Line can be specified as\n\
1975 LINENUM, to list around that line in current file,\n\
1976 FILE:LINENUM, to list around that line in that file,\n\
1977 FUNCTION, to list around beginning of that function,\n\
1978 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1979 Default is to describe the last source line that was listed.\n\n\
1980 This sets the default address for \"x\" to the line's first instruction\n\
1981 so that \"x/i\" suffices to start examining the machine code.\n\
1982 The address is also stored as the value of \"$_\"."));
1984 add_com ("forward-search", class_files, forward_search_command, _("\
1985 Search for regular expression (see regex(3)) from last line listed.\n\
1986 The matching line number is also stored as the value of \"$_\"."));
1987 add_com_alias ("search", "forward-search", class_files, 0);
1988 add_com_alias ("fo", "forward-search", class_files, 1);
1990 add_com ("reverse-search", class_files, reverse_search_command, _("\
1991 Search backward for regular expression (see regex(3)) from last line listed.\n\
1992 The matching line number is also stored as the value of \"$_\"."));
1993 add_com_alias ("rev", "reverse-search", class_files, 1);
1995 add_setshow_integer_cmd ("listsize", class_support, &lines_to_list, _("\
1996 Set number of source lines gdb will list by default."), _("\
1997 Show number of source lines gdb will list by default."), _("\
1998 Use this to choose how many source lines the \"list\" displays (unless\n\
1999 the \"list\" argument explicitly specifies some other number).\n\
2000 A value of \"unlimited\", or zero, means there's no limit."),
2003 &setlist, &showlist);
2005 add_cmd ("substitute-path", class_files, set_substitute_path_command,
2007 Usage: set substitute-path FROM TO\n\
2008 Add a substitution rule replacing FROM into TO in source file names.\n\
2009 If a substitution rule was previously set for FROM, the old rule\n\
2010 is replaced by the new one."),
2013 add_cmd ("substitute-path", class_files, unset_substitute_path_command,
2015 Usage: unset substitute-path [FROM]\n\
2016 Delete the rule for substituting FROM in source file names. If FROM\n\
2017 is not specified, all substituting rules are deleted.\n\
2018 If the debugger cannot find a rule for FROM, it will display a warning."),
2021 add_cmd ("substitute-path", class_files, show_substitute_path_command,
2023 Usage: show substitute-path [FROM]\n\
2024 Print the rule for substituting FROM in source file names. If FROM\n\
2025 is not specified, print all substitution rules."),
2028 add_setshow_enum_cmd ("filename-display", class_files,
2029 filename_display_kind_names,
2030 &filename_display_string, _("\
2031 Set how to display filenames."), _("\
2032 Show how to display filenames."), _("\
2033 filename-display can be:\n\
2034 basename - display only basename of a filename\n\
2035 relative - display a filename relative to the compilation directory\n\
2036 absolute - display an absolute filename\n\
2037 By default, relative filenames are displayed."),
2039 show_filename_display_string,
2040 &setlist, &showlist);