xref: /netbsd-src/external/gpl3/gdb.old/dist/gdb/cli/cli-cmds.c (revision 82d56013d7b633d116a93943de88e08335357a7c)
1 /* GDB CLI commands.
2 
3    Copyright (C) 2000-2019 Free Software Foundation, Inc.
4 
5    This file is part of GDB.
6 
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11 
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16 
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19 
20 #include "defs.h"
21 #include "arch-utils.h"
22 #include "readline/readline.h"
23 #include "readline/tilde.h"
24 #include "completer.h"
25 #include "target.h"	/* For baud_rate, remote_debug and remote_timeout.  */
26 #include "common/gdb_wait.h"	/* For shell escape implementation.  */
27 #include "gdb_regex.h"	/* Used by apropos_command.  */
28 #include "gdb_vfork.h"
29 #include "linespec.h"
30 #include "expression.h"
31 #include "frame.h"
32 #include "value.h"
33 #include "language.h"
34 #include "filenames.h"	/* For DOSish file names.  */
35 #include "objfiles.h"
36 #include "source.h"
37 #include "disasm.h"
38 #include "tracepoint.h"
39 #include "common/filestuff.h"
40 #include "location.h"
41 #include "block.h"
42 
43 #include "ui-out.h"
44 
45 #include "top.h"
46 #include "cli/cli-decode.h"
47 #include "cli/cli-script.h"
48 #include "cli/cli-setshow.h"
49 #include "cli/cli-cmds.h"
50 #include "cli/cli-utils.h"
51 
52 #include "extension.h"
53 #include "common/pathstuff.h"
54 
55 #ifdef TUI
56 #include "tui/tui.h"	/* For tui_active et.al.  */
57 #endif
58 
59 #include <fcntl.h>
60 #include <algorithm>
61 #include <string>
62 
63 /* Prototypes for local utility functions */
64 
65 static void print_sal_location (const symtab_and_line &sal);
66 
67 static void ambiguous_line_spec (gdb::array_view<const symtab_and_line> sals,
68 				 const char *format, ...)
69   ATTRIBUTE_PRINTF (2, 3);
70 
71 static void filter_sals (std::vector<symtab_and_line> &);
72 
73 
74 /* Limit the call depth of user-defined commands */
75 unsigned int max_user_call_depth;
76 
77 /* Define all cmd_list_elements.  */
78 
79 /* Chain containing all defined commands.  */
80 
81 struct cmd_list_element *cmdlist;
82 
83 /* Chain containing all defined info subcommands.  */
84 
85 struct cmd_list_element *infolist;
86 
87 /* Chain containing all defined enable subcommands.  */
88 
89 struct cmd_list_element *enablelist;
90 
91 /* Chain containing all defined disable subcommands.  */
92 
93 struct cmd_list_element *disablelist;
94 
95 /* Chain containing all defined stop subcommands.  */
96 
97 struct cmd_list_element *stoplist;
98 
99 /* Chain containing all defined delete subcommands.  */
100 
101 struct cmd_list_element *deletelist;
102 
103 /* Chain containing all defined detach subcommands.  */
104 
105 struct cmd_list_element *detachlist;
106 
107 /* Chain containing all defined kill subcommands.  */
108 
109 struct cmd_list_element *killlist;
110 
111 /* Chain containing all defined set subcommands */
112 
113 struct cmd_list_element *setlist;
114 
115 /* Chain containing all defined unset subcommands */
116 
117 struct cmd_list_element *unsetlist;
118 
119 /* Chain containing all defined show subcommands.  */
120 
121 struct cmd_list_element *showlist;
122 
123 /* Chain containing all defined \"set history\".  */
124 
125 struct cmd_list_element *sethistlist;
126 
127 /* Chain containing all defined \"show history\".  */
128 
129 struct cmd_list_element *showhistlist;
130 
131 /* Chain containing all defined \"unset history\".  */
132 
133 struct cmd_list_element *unsethistlist;
134 
135 /* Chain containing all defined maintenance subcommands.  */
136 
137 struct cmd_list_element *maintenancelist;
138 
139 /* Chain containing all defined "maintenance info" subcommands.  */
140 
141 struct cmd_list_element *maintenanceinfolist;
142 
143 /* Chain containing all defined "maintenance print" subcommands.  */
144 
145 struct cmd_list_element *maintenanceprintlist;
146 
147 /* Chain containing all defined "maintenance check" subcommands.  */
148 
149 struct cmd_list_element *maintenancechecklist;
150 
151 struct cmd_list_element *setprintlist;
152 
153 struct cmd_list_element *showprintlist;
154 
155 struct cmd_list_element *setdebuglist;
156 
157 struct cmd_list_element *showdebuglist;
158 
159 struct cmd_list_element *setchecklist;
160 
161 struct cmd_list_element *showchecklist;
162 
163 /* Command tracing state.  */
164 
165 int source_verbose = 0;
166 int trace_commands = 0;
167 
168 /* 'script-extension' option support.  */
169 
170 static const char script_ext_off[] = "off";
171 static const char script_ext_soft[] = "soft";
172 static const char script_ext_strict[] = "strict";
173 
174 static const char *const script_ext_enums[] = {
175   script_ext_off,
176   script_ext_soft,
177   script_ext_strict,
178   NULL
179 };
180 
181 static const char *script_ext_mode = script_ext_soft;
182 
183 /* Utility used everywhere when at least one argument is needed and
184    none is supplied.  */
185 
186 void
187 error_no_arg (const char *why)
188 {
189   error (_("Argument required (%s)."), why);
190 }
191 
192 /* The "info" command is defined as a prefix, with allow_unknown = 0.
193    Therefore, its own definition is called only for "info" with no
194    args.  */
195 
196 static void
197 info_command (const char *arg, int from_tty)
198 {
199   printf_unfiltered (_("\"info\" must be followed by "
200 		       "the name of an info command.\n"));
201   help_list (infolist, "info ", all_commands, gdb_stdout);
202 }
203 
204 /* The "show" command with no arguments shows all the settings.  */
205 
206 static void
207 show_command (const char *arg, int from_tty)
208 {
209   cmd_show_list (showlist, from_tty, "");
210 }
211 
212 
213 /* Provide documentation on command or list given by COMMAND.  FROM_TTY
214    is ignored.  */
215 
216 static void
217 help_command (const char *command, int from_tty)
218 {
219   help_cmd (command, gdb_stdout);
220 }
221 
222 
223 /* Note: The "complete" command is used by Emacs to implement completion.
224    [Is that why this function writes output with *_unfiltered?]  */
225 
226 static void
227 complete_command (const char *arg, int from_tty)
228 {
229   dont_repeat ();
230 
231   if (max_completions == 0)
232     {
233       /* Only print this for non-mi frontends.  An MI frontend may not
234 	 be able to handle this.  */
235       if (!current_uiout->is_mi_like_p ())
236 	{
237 	  printf_unfiltered (_("max-completions is zero,"
238 			       " completion is disabled.\n"));
239 	}
240       return;
241     }
242 
243   if (arg == NULL)
244     arg = "";
245 
246   completion_tracker tracker_handle_brkchars;
247   completion_tracker tracker_handle_completions;
248   completion_tracker *tracker;
249 
250   int quote_char = '\0';
251   const char *word;
252 
253   TRY
254     {
255       word = completion_find_completion_word (tracker_handle_brkchars,
256 					      arg, &quote_char);
257 
258       /* Completers that provide a custom word point in the
259 	 handle_brkchars phase also compute their completions then.
260 	 Completers that leave the completion word handling to readline
261 	 must be called twice.  */
262       if (tracker_handle_brkchars.use_custom_word_point ())
263 	tracker = &tracker_handle_brkchars;
264       else
265 	{
266 	  complete_line (tracker_handle_completions, word, arg, strlen (arg));
267 	  tracker = &tracker_handle_completions;
268 	}
269     }
270   CATCH (ex, RETURN_MASK_ALL)
271     {
272       return;
273     }
274   END_CATCH
275 
276   std::string arg_prefix (arg, word - arg);
277 
278   completion_result result
279     = tracker->build_completion_result (word, word - arg, strlen (arg));
280 
281   if (result.number_matches != 0)
282     {
283       if (result.number_matches == 1)
284 	printf_unfiltered ("%s%s\n", arg_prefix.c_str (), result.match_list[0]);
285       else
286 	{
287 	  result.sort_match_list ();
288 
289 	  for (size_t i = 0; i < result.number_matches; i++)
290 	    {
291 	      printf_unfiltered ("%s%s",
292 				 arg_prefix.c_str (),
293 				 result.match_list[i + 1]);
294 	      if (quote_char)
295 		printf_unfiltered ("%c", quote_char);
296 	      printf_unfiltered ("\n");
297 	    }
298 	}
299 
300       if (result.number_matches == max_completions)
301 	{
302 	  /* ARG_PREFIX and WORD are included in the output so that emacs
303 	     will include the message in the output.  */
304 	  printf_unfiltered (_("%s%s %s\n"),
305 			     arg_prefix.c_str (), word,
306 			     get_max_completions_reached_message ());
307 	}
308     }
309 }
310 
311 int
312 is_complete_command (struct cmd_list_element *c)
313 {
314   return cmd_cfunc_eq (c, complete_command);
315 }
316 
317 static void
318 show_version (const char *args, int from_tty)
319 {
320   print_gdb_version (gdb_stdout, true);
321   printf_filtered ("\n");
322 }
323 
324 static void
325 show_configuration (const char *args, int from_tty)
326 {
327   print_gdb_configuration (gdb_stdout);
328 }
329 
330 /* Handle the quit command.  */
331 
332 void
333 quit_command (const char *args, int from_tty)
334 {
335   int exit_code = 0;
336 
337   /* An optional expression may be used to cause gdb to terminate with
338      the value of that expression.  */
339   if (args)
340     {
341       struct value *val = parse_and_eval (args);
342 
343       exit_code = (int) value_as_long (val);
344     }
345 
346   if (!quit_confirm ())
347     error (_("Not confirmed."));
348 
349   query_if_trace_running (from_tty);
350 
351   quit_force (args ? &exit_code : NULL, from_tty);
352 }
353 
354 static void
355 pwd_command (const char *args, int from_tty)
356 {
357   if (args)
358     error (_("The \"pwd\" command does not take an argument: %s"), args);
359 
360   gdb::unique_xmalloc_ptr<char> cwd (getcwd (NULL, 0));
361 
362   if (cwd == NULL)
363     error (_("Error finding name of working directory: %s"),
364            safe_strerror (errno));
365 
366   if (strcmp (cwd.get (), current_directory) != 0)
367     printf_unfiltered (_("Working directory %s\n (canonically %s).\n"),
368 		       current_directory, cwd.get ());
369   else
370     printf_unfiltered (_("Working directory %s.\n"), current_directory);
371 }
372 
373 void
374 cd_command (const char *dir, int from_tty)
375 {
376   int len;
377   /* Found something other than leading repetitions of "/..".  */
378   int found_real_path;
379   char *p;
380 
381   /* If the new directory is absolute, repeat is a no-op; if relative,
382      repeat might be useful but is more likely to be a mistake.  */
383   dont_repeat ();
384 
385   gdb::unique_xmalloc_ptr<char> dir_holder
386     (tilde_expand (dir != NULL ? dir : "~"));
387   dir = dir_holder.get ();
388 
389   if (chdir (dir) < 0)
390     perror_with_name (dir);
391 
392 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
393   /* There's too much mess with DOSish names like "d:", "d:.",
394      "d:./foo" etc.  Instead of having lots of special #ifdef'ed code,
395      simply get the canonicalized name of the current directory.  */
396   gdb::unique_xmalloc_ptr<char> cwd (getcwd (NULL, 0));
397   dir = cwd.get ();
398 #endif
399 
400   len = strlen (dir);
401   if (IS_DIR_SEPARATOR (dir[len - 1]))
402     {
403       /* Remove the trailing slash unless this is a root directory
404          (including a drive letter on non-Unix systems).  */
405       if (!(len == 1)		/* "/" */
406 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
407 	  && !(len == 3 && dir[1] == ':') /* "d:/" */
408 #endif
409 	  )
410 	len--;
411     }
412 
413   dir_holder.reset (savestring (dir, len));
414   if (IS_ABSOLUTE_PATH (dir_holder.get ()))
415     {
416       xfree (current_directory);
417       current_directory = dir_holder.release ();
418     }
419   else
420     {
421       if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
422 	current_directory = concat (current_directory, dir_holder.get (),
423 				    (char *) NULL);
424       else
425 	current_directory = concat (current_directory, SLASH_STRING,
426 				    dir_holder.get (), (char *) NULL);
427     }
428 
429   /* Now simplify any occurrences of `.' and `..' in the pathname.  */
430 
431   found_real_path = 0;
432   for (p = current_directory; *p;)
433     {
434       if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
435 	  && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
436 	memmove (p, p + 2, strlen (p + 2) + 1);
437       else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
438 	       && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
439 	{
440 	  if (found_real_path)
441 	    {
442 	      /* Search backwards for the directory just before the "/.."
443 	         and obliterate it and the "/..".  */
444 	      char *q = p;
445 
446 	      while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
447 		--q;
448 
449 	      if (q == current_directory)
450 		/* current_directory is
451 		   a relative pathname ("can't happen"--leave it alone).  */
452 		++p;
453 	      else
454 		{
455 		  memmove (q - 1, p + 3, strlen (p + 3) + 1);
456 		  p = q - 1;
457 		}
458 	    }
459 	  else
460 	    /* We are dealing with leading repetitions of "/..", for
461 	       example "/../..", which is the Mach super-root.  */
462 	    p += 3;
463 	}
464       else
465 	{
466 	  found_real_path = 1;
467 	  ++p;
468 	}
469     }
470 
471   forget_cached_source_info ();
472 
473   if (from_tty)
474     pwd_command ((char *) 0, 1);
475 }
476 
477 /* Show the current value of the 'script-extension' option.  */
478 
479 static void
480 show_script_ext_mode (struct ui_file *file, int from_tty,
481 		     struct cmd_list_element *c, const char *value)
482 {
483   fprintf_filtered (file,
484 		    _("Script filename extension recognition is \"%s\".\n"),
485 		    value);
486 }
487 
488 /* Try to open SCRIPT_FILE.
489    If successful, the full path name is stored in *FULL_PATHP,
490    and the stream is returned.
491    If not successful, return NULL; errno is set for the last file
492    we tried to open.
493 
494    If SEARCH_PATH is non-zero, and the file isn't found in cwd,
495    search for it in the source search path.  */
496 
497 gdb::optional<open_script>
498 find_and_open_script (const char *script_file, int search_path)
499 {
500   int fd;
501   openp_flags search_flags = OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH;
502   gdb::optional<open_script> opened;
503 
504   gdb::unique_xmalloc_ptr<char> file (tilde_expand (script_file));
505 
506   if (search_path)
507     search_flags |= OPF_SEARCH_IN_PATH;
508 
509   /* Search for and open 'file' on the search path used for source
510      files.  Put the full location in *FULL_PATHP.  */
511   gdb::unique_xmalloc_ptr<char> full_path;
512   fd = openp (source_path, search_flags,
513 	      file.get (), O_RDONLY, &full_path);
514 
515   if (fd == -1)
516     return opened;
517 
518   FILE *result = fdopen (fd, FOPEN_RT);
519   if (result == NULL)
520     {
521       int save_errno = errno;
522 
523       close (fd);
524       errno = save_errno;
525     }
526   else
527     opened.emplace (gdb_file_up (result), std::move (full_path));
528 
529   return opened;
530 }
531 
532 /* Load script FILE, which has already been opened as STREAM.
533    FILE_TO_OPEN is the form of FILE to use if one needs to open the file.
534    This is provided as FILE may have been found via the source search path.
535    An important thing to note here is that FILE may be a symlink to a file
536    with a different or non-existing suffix, and thus one cannot infer the
537    extension language from FILE_TO_OPEN.  */
538 
539 static void
540 source_script_from_stream (FILE *stream, const char *file,
541 			   const char *file_to_open)
542 {
543   if (script_ext_mode != script_ext_off)
544     {
545       const struct extension_language_defn *extlang
546 	= get_ext_lang_of_file (file);
547 
548       if (extlang != NULL)
549 	{
550 	  if (ext_lang_present_p (extlang))
551 	    {
552 	      script_sourcer_func *sourcer
553 		= ext_lang_script_sourcer (extlang);
554 
555 	      gdb_assert (sourcer != NULL);
556 	      sourcer (extlang, stream, file_to_open);
557 	      return;
558 	    }
559 	  else if (script_ext_mode == script_ext_soft)
560 	    {
561 	      /* Assume the file is a gdb script.
562 		 This is handled below.  */
563 	    }
564 	  else
565 	    throw_ext_lang_unsupported (extlang);
566 	}
567     }
568 
569   script_from_file (stream, file);
570 }
571 
572 /* Worker to perform the "source" command.
573    Load script FILE.
574    If SEARCH_PATH is non-zero, and the file isn't found in cwd,
575    search for it in the source search path.  */
576 
577 static void
578 source_script_with_search (const char *file, int from_tty, int search_path)
579 {
580 
581   if (file == NULL || *file == 0)
582     error (_("source command requires file name of file to source."));
583 
584   gdb::optional<open_script> opened = find_and_open_script (file, search_path);
585   if (!opened)
586     {
587       /* The script wasn't found, or was otherwise inaccessible.
588          If the source command was invoked interactively, throw an
589 	 error.  Otherwise (e.g. if it was invoked by a script),
590 	 just emit a warning, rather than cause an error.  */
591       if (from_tty)
592 	perror_with_name (file);
593       else
594 	{
595 	  perror_warning_with_name (file);
596 	  return;
597 	}
598     }
599 
600   /* The python support reopens the file, so we need to pass full_path here
601      in case the file was found on the search path.  It's useful to do this
602      anyway so that error messages show the actual file used.  But only do
603      this if we (may have) used search_path, as printing the full path in
604      errors for the non-search case can be more noise than signal.  */
605   source_script_from_stream (opened->stream.get (), file,
606 			     search_path ? opened->full_path.get () : file);
607 }
608 
609 /* Wrapper around source_script_with_search to export it to main.c
610    for use in loading .gdbinit scripts.  */
611 
612 void
613 source_script (const char *file, int from_tty)
614 {
615   source_script_with_search (file, from_tty, 0);
616 }
617 
618 static void
619 source_command (const char *args, int from_tty)
620 {
621   const char *file = args;
622   int search_path = 0;
623 
624   scoped_restore save_source_verbose = make_scoped_restore (&source_verbose);
625 
626   /* -v causes the source command to run in verbose mode.
627      -s causes the file to be searched in the source search path,
628      even if the file name contains a '/'.
629      We still have to be able to handle filenames with spaces in a
630      backward compatible way, so buildargv is not appropriate.  */
631 
632   if (args)
633     {
634       while (args[0] != '\0')
635 	{
636 	  /* Make sure leading white space does not break the
637 	     comparisons.  */
638 	  args = skip_spaces (args);
639 
640 	  if (args[0] != '-')
641 	    break;
642 
643 	  if (args[1] == 'v' && isspace (args[2]))
644 	    {
645 	      source_verbose = 1;
646 
647 	      /* Skip passed -v.  */
648 	      args = &args[3];
649 	    }
650 	  else if (args[1] == 's' && isspace (args[2]))
651 	    {
652 	      search_path = 1;
653 
654 	      /* Skip passed -s.  */
655 	      args = &args[3];
656 	    }
657 	  else
658 	    break;
659 	}
660 
661       file = skip_spaces (args);
662     }
663 
664   source_script_with_search (file, from_tty, search_path);
665 }
666 
667 
668 static void
669 echo_command (const char *text, int from_tty)
670 {
671   const char *p = text;
672   int c;
673 
674   if (text)
675     while ((c = *p++) != '\0')
676       {
677 	if (c == '\\')
678 	  {
679 	    /* \ at end of argument is used after spaces
680 	       so they won't be lost.  */
681 	    if (*p == 0)
682 	      return;
683 
684 	    c = parse_escape (get_current_arch (), &p);
685 	    if (c >= 0)
686 	      printf_filtered ("%c", c);
687 	  }
688 	else
689 	  printf_filtered ("%c", c);
690       }
691 
692   reset_terminal_style (gdb_stdout);
693 
694   /* Force this output to appear now.  */
695   wrap_here ("");
696   gdb_flush (gdb_stdout);
697 }
698 
699 static void
700 shell_escape (const char *arg, int from_tty)
701 {
702 #if defined(CANT_FORK) || \
703       (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
704   /* If ARG is NULL, they want an inferior shell, but `system' just
705      reports if the shell is available when passed a NULL arg.  */
706   int rc = system (arg ? arg : "");
707 
708   if (!arg)
709     arg = "inferior shell";
710 
711   if (rc == -1)
712     {
713       fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
714 			  safe_strerror (errno));
715       gdb_flush (gdb_stderr);
716     }
717   else if (rc)
718     {
719       fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
720       gdb_flush (gdb_stderr);
721     }
722 #ifdef GLOBAL_CURDIR
723   /* Make sure to return to the directory GDB thinks it is, in case
724      the shell command we just ran changed it.  */
725   chdir (current_directory);
726 #endif
727 #else /* Can fork.  */
728   int status, pid;
729 
730   if ((pid = vfork ()) == 0)
731     {
732       const char *p, *user_shell = get_shell ();
733 
734       close_most_fds ();
735 
736       /* Get the name of the shell for arg0.  */
737       p = lbasename (user_shell);
738 
739       if (!arg)
740 	execl (user_shell, p, (char *) 0);
741       else
742 	execl (user_shell, p, "-c", arg, (char *) 0);
743 
744       fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
745 			  safe_strerror (errno));
746       gdb_flush (gdb_stderr);
747       _exit (0177);
748     }
749 
750   if (pid != -1)
751     waitpid (pid, &status, 0);
752   else
753     error (_("Fork failed"));
754 #endif /* Can fork.  */
755 }
756 
757 /* Implementation of the "shell" command.  */
758 
759 static void
760 shell_command (const char *arg, int from_tty)
761 {
762   shell_escape (arg, from_tty);
763 }
764 
765 static void
766 edit_command (const char *arg, int from_tty)
767 {
768   struct symtab_and_line sal;
769   struct symbol *sym;
770   const char *editor;
771   char *p;
772   const char *fn;
773 
774   /* Pull in the current default source line if necessary.  */
775   if (arg == 0)
776     {
777       set_default_source_symtab_and_line ();
778       sal = get_current_source_symtab_and_line ();
779     }
780 
781   /* Bare "edit" edits file with present line.  */
782 
783   if (arg == 0)
784     {
785       if (sal.symtab == 0)
786 	error (_("No default source file yet."));
787       sal.line += get_lines_to_list () / 2;
788     }
789   else
790     {
791       const char *arg1;
792 
793       /* Now should only be one argument -- decode it in SAL.  */
794       arg1 = arg;
795       event_location_up location = string_to_event_location (&arg1,
796 							     current_language);
797       std::vector<symtab_and_line> sals = decode_line_1 (location.get (),
798 							 DECODE_LINE_LIST_MODE,
799 							 NULL, NULL, 0);
800 
801       filter_sals (sals);
802       if (sals.empty ())
803 	{
804 	  /*  C++  */
805 	  return;
806 	}
807       if (sals.size () > 1)
808 	{
809 	  ambiguous_line_spec (sals,
810 			       _("Specified line is ambiguous:\n"));
811 	  return;
812 	}
813 
814       sal = sals[0];
815 
816       if (*arg1)
817         error (_("Junk at end of line specification."));
818 
819       /* If line was specified by address, first print exactly which
820          line, and which file.  In this case, sal.symtab == 0 means
821          address is outside of all known source files, not that user
822          failed to give a filename.  */
823       if (*arg == '*')
824         {
825 	  struct gdbarch *gdbarch;
826 
827           if (sal.symtab == 0)
828 	    error (_("No source file for address %s."),
829 		   paddress (get_current_arch (), sal.pc));
830 
831 	  gdbarch = get_objfile_arch (SYMTAB_OBJFILE (sal.symtab));
832           sym = find_pc_function (sal.pc);
833           if (sym)
834 	    printf_filtered ("%s is in %s (%s:%d).\n",
835 			     paddress (gdbarch, sal.pc),
836 			     SYMBOL_PRINT_NAME (sym),
837 			     symtab_to_filename_for_display (sal.symtab),
838 			     sal.line);
839           else
840 	    printf_filtered ("%s is at %s:%d.\n",
841 			     paddress (gdbarch, sal.pc),
842 			     symtab_to_filename_for_display (sal.symtab),
843 			     sal.line);
844         }
845 
846       /* If what was given does not imply a symtab, it must be an
847          undebuggable symbol which means no source code.  */
848 
849       if (sal.symtab == 0)
850         error (_("No line number known for %s."), arg);
851     }
852 
853   if ((editor = getenv ("EDITOR")) == NULL)
854     editor = "/bin/ex";
855 
856   fn = symtab_to_fullname (sal.symtab);
857 
858   /* Quote the file name, in case it has whitespace or other special
859      characters.  */
860   p = xstrprintf ("%s +%d \"%s\"", editor, sal.line, fn);
861   shell_escape (p, from_tty);
862   xfree (p);
863 }
864 
865 static void
866 list_command (const char *arg, int from_tty)
867 {
868   struct symbol *sym;
869   const char *arg1;
870   int no_end = 1;
871   int dummy_end = 0;
872   int dummy_beg = 0;
873   int linenum_beg = 0;
874   const char *p;
875 
876   /* Pull in the current default source line if necessary.  */
877   if (arg == NULL || ((arg[0] == '+' || arg[0] == '-') && arg[1] == '\0'))
878     {
879       set_default_source_symtab_and_line ();
880       symtab_and_line cursal = get_current_source_symtab_and_line ();
881 
882       /* If this is the first "list" since we've set the current
883 	 source line, center the listing around that line.  */
884       if (get_first_line_listed () == 0)
885 	{
886 	  int first;
887 
888 	  first = std::max (cursal.line - get_lines_to_list () / 2, 1);
889 
890 	  /* A small special case --- if listing backwards, and we
891 	     should list only one line, list the preceding line,
892 	     instead of the exact line we've just shown after e.g.,
893 	     stopping for a breakpoint.  */
894 	  if (arg != NULL && arg[0] == '-'
895 	      && get_lines_to_list () == 1 && first > 1)
896 	    first -= 1;
897 
898 	  print_source_lines (cursal.symtab, source_lines_range (first), 0);
899 	}
900 
901       /* "l" or "l +" lists next ten lines.  */
902       else if (arg == NULL || arg[0] == '+')
903 	print_source_lines (cursal.symtab,
904 			    source_lines_range (cursal.line), 0);
905 
906       /* "l -" lists previous ten lines, the ones before the ten just
907 	 listed.  */
908       else if (arg[0] == '-')
909 	{
910 	  if (get_first_line_listed () == 1)
911 	    error (_("Already at the start of %s."),
912 		   symtab_to_filename_for_display (cursal.symtab));
913 	  source_lines_range range (get_first_line_listed (),
914 				    source_lines_range::BACKWARD);
915 	  print_source_lines (cursal.symtab, range, 0);
916 	}
917 
918       return;
919     }
920 
921   /* Now if there is only one argument, decode it in SAL
922      and set NO_END.
923      If there are two arguments, decode them in SAL and SAL_END
924      and clear NO_END; however, if one of the arguments is blank,
925      set DUMMY_BEG or DUMMY_END to record that fact.  */
926 
927   if (!have_full_symbols () && !have_partial_symbols ())
928     error (_("No symbol table is loaded.  Use the \"file\" command."));
929 
930   std::vector<symtab_and_line> sals;
931   symtab_and_line sal, sal_end;
932 
933   arg1 = arg;
934   if (*arg1 == ',')
935     dummy_beg = 1;
936   else
937     {
938       event_location_up location = string_to_event_location (&arg1,
939 							     current_language);
940       sals = decode_line_1 (location.get (), DECODE_LINE_LIST_MODE,
941 			    NULL, NULL, 0);
942       filter_sals (sals);
943       if (sals.empty ())
944 	{
945 	  /*  C++  */
946 	  return;
947 	}
948 
949       sal = sals[0];
950     }
951 
952   /* Record whether the BEG arg is all digits.  */
953 
954   for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
955   linenum_beg = (p == arg1);
956 
957   /* Save the range of the first argument, in case we need to let the
958      user know it was ambiguous.  */
959   const char *beg = arg;
960   size_t beg_len = arg1 - beg;
961 
962   while (*arg1 == ' ' || *arg1 == '\t')
963     arg1++;
964   if (*arg1 == ',')
965     {
966       no_end = 0;
967       if (sals.size () > 1)
968 	{
969 	  ambiguous_line_spec (sals,
970 			       _("Specified first line '%.*s' is ambiguous:\n"),
971 			       (int) beg_len, beg);
972 	  return;
973 	}
974       arg1++;
975       while (*arg1 == ' ' || *arg1 == '\t')
976 	arg1++;
977       if (*arg1 == 0)
978 	dummy_end = 1;
979       else
980 	{
981 	  /* Save the last argument, in case we need to let the user
982 	     know it was ambiguous.  */
983 	  const char *end_arg = arg1;
984 
985 	  event_location_up location
986 	    = string_to_event_location (&arg1, current_language);
987 
988 	  std::vector<symtab_and_line> sals_end
989 	    = (dummy_beg
990 	       ? decode_line_1 (location.get (), DECODE_LINE_LIST_MODE,
991 				NULL, NULL, 0)
992 	       : decode_line_1 (location.get (), DECODE_LINE_LIST_MODE,
993 				NULL, sal.symtab, sal.line));
994 
995 	  filter_sals (sals_end);
996 	  if (sals_end.empty ())
997 	    return;
998 	  if (sals_end.size () > 1)
999 	    {
1000 	      ambiguous_line_spec (sals_end,
1001 				   _("Specified last line '%s' is ambiguous:\n"),
1002 				   end_arg);
1003 	      return;
1004 	    }
1005 	  sal_end = sals_end[0];
1006 	}
1007     }
1008 
1009   if (*arg1)
1010     error (_("Junk at end of line specification."));
1011 
1012   if (!no_end && !dummy_beg && !dummy_end
1013       && sal.symtab != sal_end.symtab)
1014     error (_("Specified first and last lines are in different files."));
1015   if (dummy_beg && dummy_end)
1016     error (_("Two empty args do not say what lines to list."));
1017 
1018   /* If line was specified by address,
1019      first print exactly which line, and which file.
1020 
1021      In this case, sal.symtab == 0 means address is outside of all
1022      known source files, not that user failed to give a filename.  */
1023   if (*arg == '*')
1024     {
1025       struct gdbarch *gdbarch;
1026 
1027       if (sal.symtab == 0)
1028 	error (_("No source file for address %s."),
1029 	       paddress (get_current_arch (), sal.pc));
1030 
1031       gdbarch = get_objfile_arch (SYMTAB_OBJFILE (sal.symtab));
1032       sym = find_pc_function (sal.pc);
1033       if (sym)
1034 	printf_filtered ("%s is in %s (%s:%d).\n",
1035 			 paddress (gdbarch, sal.pc),
1036 			 SYMBOL_PRINT_NAME (sym),
1037 			 symtab_to_filename_for_display (sal.symtab), sal.line);
1038       else
1039 	printf_filtered ("%s is at %s:%d.\n",
1040 			 paddress (gdbarch, sal.pc),
1041 			 symtab_to_filename_for_display (sal.symtab), sal.line);
1042     }
1043 
1044   /* If line was not specified by just a line number, and it does not
1045      imply a symtab, it must be an undebuggable symbol which means no
1046      source code.  */
1047 
1048   if (!linenum_beg && sal.symtab == 0)
1049     error (_("No line number known for %s."), arg);
1050 
1051   /* If this command is repeated with RET,
1052      turn it into the no-arg variant.  */
1053 
1054   if (from_tty)
1055     set_repeat_arguments ("");
1056 
1057   if (dummy_beg && sal_end.symtab == 0)
1058     error (_("No default source file yet.  Do \"help list\"."));
1059   if (dummy_beg)
1060     {
1061       source_lines_range range (sal_end.line + 1,
1062 				source_lines_range::BACKWARD);
1063       print_source_lines (sal_end.symtab, range, 0);
1064     }
1065   else if (sal.symtab == 0)
1066     error (_("No default source file yet.  Do \"help list\"."));
1067   else if (no_end)
1068     {
1069       for (int i = 0; i < sals.size (); i++)
1070 	{
1071 	  sal = sals[i];
1072 	  int first_line = sal.line - get_lines_to_list () / 2;
1073 	  if (first_line < 1)
1074 	    first_line = 1;
1075 	  if (sals.size () > 1)
1076 	    print_sal_location (sal);
1077 	  print_source_lines (sal.symtab, source_lines_range (first_line), 0);
1078 	}
1079     }
1080   else if (dummy_end)
1081     print_source_lines (sal.symtab, source_lines_range (sal.line), 0);
1082   else
1083     print_source_lines (sal.symtab,
1084 			source_lines_range (sal.line, (sal_end.line + 1)),
1085 			0);
1086 }
1087 
1088 /* Subroutine of disassemble_command to simplify it.
1089    Perform the disassembly.
1090    NAME is the name of the function if known, or NULL.
1091    [LOW,HIGH) are the range of addresses to disassemble.
1092    BLOCK is the block to disassemble; it needs to be provided
1093    when non-contiguous blocks are disassembled; otherwise
1094    it can be NULL.
1095    MIXED is non-zero to print source with the assembler.  */
1096 
1097 static void
1098 print_disassembly (struct gdbarch *gdbarch, const char *name,
1099 		   CORE_ADDR low, CORE_ADDR high,
1100 		   const struct block *block,
1101 		   gdb_disassembly_flags flags)
1102 {
1103 #if defined(TUI)
1104   if (!tui_is_window_visible (DISASSEM_WIN))
1105 #endif
1106     {
1107       printf_filtered ("Dump of assembler code ");
1108       if (name != NULL)
1109 	printf_filtered ("for function %s:\n", name);
1110       if (block == nullptr || BLOCK_CONTIGUOUS_P (block))
1111         {
1112 	  if (name == NULL)
1113 	    printf_filtered ("from %s to %s:\n",
1114 			     paddress (gdbarch, low), paddress (gdbarch, high));
1115 
1116 	  /* Dump the specified range.  */
1117 	  gdb_disassembly (gdbarch, current_uiout, flags, -1, low, high);
1118 	}
1119       else
1120         {
1121 	  for (int i = 0; i < BLOCK_NRANGES (block); i++)
1122 	    {
1123 	      CORE_ADDR range_low = BLOCK_RANGE_START (block, i);
1124 	      CORE_ADDR range_high = BLOCK_RANGE_END (block, i);
1125 	      printf_filtered (_("Address range %s to %s:\n"),
1126 			       paddress (gdbarch, range_low),
1127 			       paddress (gdbarch, range_high));
1128 	      gdb_disassembly (gdbarch, current_uiout, flags, -1,
1129 			       range_low, range_high);
1130 	    }
1131 	}
1132       printf_filtered ("End of assembler dump.\n");
1133       gdb_flush (gdb_stdout);
1134     }
1135 #if defined(TUI)
1136   else
1137     {
1138       tui_show_assembly (gdbarch, low);
1139     }
1140 #endif
1141 }
1142 
1143 /* Subroutine of disassemble_command to simplify it.
1144    Print a disassembly of the current function according to FLAGS.  */
1145 
1146 static void
1147 disassemble_current_function (gdb_disassembly_flags flags)
1148 {
1149   struct frame_info *frame;
1150   struct gdbarch *gdbarch;
1151   CORE_ADDR low, high, pc;
1152   const char *name;
1153   const struct block *block;
1154 
1155   frame = get_selected_frame (_("No frame selected."));
1156   gdbarch = get_frame_arch (frame);
1157   pc = get_frame_address_in_block (frame);
1158   if (find_pc_partial_function (pc, &name, &low, &high, &block) == 0)
1159     error (_("No function contains program counter for selected frame."));
1160 #if defined(TUI)
1161   /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1162      `tui_version'.  */
1163   if (tui_active)
1164     /* FIXME: cagney/2004-02-07: This should be an observer.  */
1165     low = tui_get_low_disassembly_address (gdbarch, low, pc);
1166 #endif
1167   low += gdbarch_deprecated_function_start_offset (gdbarch);
1168 
1169   print_disassembly (gdbarch, name, low, high, block, flags);
1170 }
1171 
1172 /* Dump a specified section of assembly code.
1173 
1174    Usage:
1175      disassemble [/mrs]
1176        - dump the assembly code for the function of the current pc
1177      disassemble [/mrs] addr
1178        - dump the assembly code for the function at ADDR
1179      disassemble [/mrs] low,high
1180      disassemble [/mrs] low,+length
1181        - dump the assembly code in the range [LOW,HIGH), or [LOW,LOW+length)
1182 
1183    A /m modifier will include source code with the assembly in a
1184    "source centric" view.  This view lists only the file of the first insn,
1185    even if other source files are involved (e.g., inlined functions), and
1186    the output is in source order, even with optimized code.  This view is
1187    considered deprecated as it hasn't been useful in practice.
1188 
1189    A /r modifier will include raw instructions in hex with the assembly.
1190 
1191    A /s modifier will include source code with the assembly, like /m, with
1192    two important differences:
1193    1) The output is still in pc address order.
1194    2) File names and contents for all relevant source files are displayed.  */
1195 
1196 static void
1197 disassemble_command (const char *arg, int from_tty)
1198 {
1199   struct gdbarch *gdbarch = get_current_arch ();
1200   CORE_ADDR low, high;
1201   const char *name;
1202   CORE_ADDR pc;
1203   gdb_disassembly_flags flags;
1204   const char *p;
1205   const struct block *block = nullptr;
1206 
1207   p = arg;
1208   name = NULL;
1209   flags = 0;
1210 
1211   if (p && *p == '/')
1212     {
1213       ++p;
1214 
1215       if (*p == '\0')
1216 	error (_("Missing modifier."));
1217 
1218       while (*p && ! isspace (*p))
1219 	{
1220 	  switch (*p++)
1221 	    {
1222 	    case 'm':
1223 	      flags |= DISASSEMBLY_SOURCE_DEPRECATED;
1224 	      break;
1225 	    case 'r':
1226 	      flags |= DISASSEMBLY_RAW_INSN;
1227 	      break;
1228 	    case 's':
1229 	      flags |= DISASSEMBLY_SOURCE;
1230 	      break;
1231 	    default:
1232 	      error (_("Invalid disassembly modifier."));
1233 	    }
1234 	}
1235 
1236       p = skip_spaces (p);
1237     }
1238 
1239   if ((flags & (DISASSEMBLY_SOURCE_DEPRECATED | DISASSEMBLY_SOURCE))
1240       == (DISASSEMBLY_SOURCE_DEPRECATED | DISASSEMBLY_SOURCE))
1241     error (_("Cannot specify both /m and /s."));
1242 
1243   if (! p || ! *p)
1244     {
1245       flags |= DISASSEMBLY_OMIT_FNAME;
1246       disassemble_current_function (flags);
1247       return;
1248     }
1249 
1250   pc = value_as_address (parse_to_comma_and_eval (&p));
1251   if (p[0] == ',')
1252     ++p;
1253   if (p[0] == '\0')
1254     {
1255       /* One argument.  */
1256       if (find_pc_partial_function (pc, &name, &low, &high, &block) == 0)
1257 	error (_("No function contains specified address."));
1258 #if defined(TUI)
1259       /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1260 	 `tui_version'.  */
1261       if (tui_active)
1262 	/* FIXME: cagney/2004-02-07: This should be an observer.  */
1263 	low = tui_get_low_disassembly_address (gdbarch, low, pc);
1264 #endif
1265       low += gdbarch_deprecated_function_start_offset (gdbarch);
1266       flags |= DISASSEMBLY_OMIT_FNAME;
1267     }
1268   else
1269     {
1270       /* Two arguments.  */
1271       int incl_flag = 0;
1272       low = pc;
1273       p = skip_spaces (p);
1274       if (p[0] == '+')
1275 	{
1276 	  ++p;
1277 	  incl_flag = 1;
1278 	}
1279       high = parse_and_eval_address (p);
1280       if (incl_flag)
1281 	high += low;
1282     }
1283 
1284   print_disassembly (gdbarch, name, low, high, block, flags);
1285 }
1286 
1287 static void
1288 make_command (const char *arg, int from_tty)
1289 {
1290   if (arg == 0)
1291     shell_escape ("make", from_tty);
1292   else
1293     {
1294       std::string cmd = std::string ("make ") + arg;
1295 
1296       shell_escape (cmd.c_str (), from_tty);
1297     }
1298 }
1299 
1300 static void
1301 show_user (const char *args, int from_tty)
1302 {
1303   struct cmd_list_element *c;
1304   extern struct cmd_list_element *cmdlist;
1305 
1306   if (args)
1307     {
1308       const char *comname = args;
1309 
1310       c = lookup_cmd (&comname, cmdlist, "", 0, 1);
1311       if (!cli_user_command_p (c))
1312 	error (_("Not a user command."));
1313       show_user_1 (c, "", args, gdb_stdout);
1314     }
1315   else
1316     {
1317       for (c = cmdlist; c; c = c->next)
1318 	{
1319 	  if (cli_user_command_p (c) || c->prefixlist != NULL)
1320 	    show_user_1 (c, "", c->name, gdb_stdout);
1321 	}
1322     }
1323 }
1324 
1325 /* Search through names of commands and documentations for a certain
1326    regular expression.  */
1327 
1328 static void
1329 apropos_command (const char *searchstr, int from_tty)
1330 {
1331   if (searchstr == NULL)
1332     error (_("REGEXP string is empty"));
1333 
1334   compiled_regex pattern (searchstr, REG_ICASE,
1335 			  _("Error in regular expression"));
1336 
1337   apropos_cmd (gdb_stdout, cmdlist, pattern, "");
1338 }
1339 
1340 /* Subroutine of alias_command to simplify it.
1341    Return the first N elements of ARGV flattened back to a string
1342    with a space separating each element.
1343    ARGV may not be NULL.
1344    This does not take care of quoting elements in case they contain spaces
1345    on purpose.  */
1346 
1347 static std::string
1348 argv_to_string (char **argv, int n)
1349 {
1350   int i;
1351   std::string result;
1352 
1353   gdb_assert (argv != NULL);
1354   gdb_assert (n >= 0 && n <= countargv (argv));
1355 
1356   for (i = 0; i < n; ++i)
1357     {
1358       if (i > 0)
1359 	result += " ";
1360       result += argv[i];
1361     }
1362 
1363   return result;
1364 }
1365 
1366 /* Subroutine of alias_command to simplify it.
1367    Return TRUE if COMMAND exists, unambiguously.  Otherwise FALSE.  */
1368 
1369 static int
1370 valid_command_p (const char *command)
1371 {
1372   struct cmd_list_element *c;
1373 
1374   c = lookup_cmd_1 (& command, cmdlist, NULL, 1);
1375 
1376   if (c == NULL || c == (struct cmd_list_element *) -1)
1377     return FALSE;
1378 
1379   /* This is the slightly tricky part.
1380      lookup_cmd_1 will return a pointer to the last part of COMMAND
1381      to match, leaving COMMAND pointing at the remainder.  */
1382   while (*command == ' ' || *command == '\t')
1383     ++command;
1384   return *command == '\0';
1385 }
1386 
1387 /* Called when "alias" was incorrectly used.  */
1388 
1389 static void
1390 alias_usage_error (void)
1391 {
1392   error (_("Usage: alias [-a] [--] ALIAS = COMMAND"));
1393 }
1394 
1395 /* Make an alias of an existing command.  */
1396 
1397 static void
1398 alias_command (const char *args, int from_tty)
1399 {
1400   int i, alias_argc, command_argc;
1401   int abbrev_flag = 0;
1402   const char *equals;
1403   const char *alias, *command;
1404 
1405   if (args == NULL || strchr (args, '=') == NULL)
1406     alias_usage_error ();
1407 
1408   equals = strchr (args, '=');
1409   std::string args2 (args, equals - args);
1410 
1411   gdb_argv built_alias_argv (args2.c_str ());
1412   gdb_argv command_argv (equals + 1);
1413 
1414   char **alias_argv = built_alias_argv.get ();
1415   while (alias_argv[0] != NULL)
1416     {
1417       if (strcmp (alias_argv[0], "-a") == 0)
1418 	{
1419 	  ++alias_argv;
1420 	  abbrev_flag = 1;
1421 	}
1422       else if (strcmp (alias_argv[0], "--") == 0)
1423 	{
1424 	  ++alias_argv;
1425 	  break;
1426 	}
1427       else
1428 	break;
1429     }
1430 
1431   if (alias_argv[0] == NULL || command_argv[0] == NULL
1432       || *alias_argv[0] == '\0' || *command_argv[0] == '\0')
1433     alias_usage_error ();
1434 
1435   for (i = 0; alias_argv[i] != NULL; ++i)
1436     {
1437       if (! valid_user_defined_cmd_name_p (alias_argv[i]))
1438 	{
1439 	  if (i == 0)
1440 	    error (_("Invalid command name: %s"), alias_argv[i]);
1441 	  else
1442 	    error (_("Invalid command element name: %s"), alias_argv[i]);
1443 	}
1444     }
1445 
1446   alias_argc = countargv (alias_argv);
1447   command_argc = command_argv.count ();
1448 
1449   /* COMMAND must exist.
1450      Reconstruct the command to remove any extraneous spaces,
1451      for better error messages.  */
1452   std::string command_string (argv_to_string (command_argv.get (),
1453 					      command_argc));
1454   command = command_string.c_str ();
1455   if (! valid_command_p (command))
1456     error (_("Invalid command to alias to: %s"), command);
1457 
1458   /* ALIAS must not exist.  */
1459   std::string alias_string (argv_to_string (alias_argv, alias_argc));
1460   alias = alias_string.c_str ();
1461   if (valid_command_p (alias))
1462     error (_("Alias already exists: %s"), alias);
1463 
1464   /* If ALIAS is one word, it is an alias for the entire COMMAND.
1465      Example: alias spe = set print elements
1466 
1467      Otherwise ALIAS and COMMAND must have the same number of words,
1468      and every word except the last must match; and the last word of
1469      ALIAS is made an alias of the last word of COMMAND.
1470      Example: alias set print elms = set pr elem
1471      Note that unambiguous abbreviations are allowed.  */
1472 
1473   if (alias_argc == 1)
1474     {
1475       /* add_cmd requires *we* allocate space for name, hence the xstrdup.  */
1476       add_com_alias (xstrdup (alias_argv[0]), command, class_alias,
1477 		     abbrev_flag);
1478     }
1479   else
1480     {
1481       const char *alias_prefix, *command_prefix;
1482       struct cmd_list_element *c_alias, *c_command;
1483 
1484       if (alias_argc != command_argc)
1485 	error (_("Mismatched command length between ALIAS and COMMAND."));
1486 
1487       /* Create copies of ALIAS and COMMAND without the last word,
1488 	 and use that to verify the leading elements match.  */
1489       std::string alias_prefix_string (argv_to_string (alias_argv,
1490 						       alias_argc - 1));
1491       std::string command_prefix_string (argv_to_string (alias_argv,
1492 							 command_argc - 1));
1493       alias_prefix = alias_prefix_string.c_str ();
1494       command_prefix = command_prefix_string.c_str ();
1495 
1496       c_command = lookup_cmd_1 (& command_prefix, cmdlist, NULL, 1);
1497       /* We've already tried to look up COMMAND.  */
1498       gdb_assert (c_command != NULL
1499 		  && c_command != (struct cmd_list_element *) -1);
1500       gdb_assert (c_command->prefixlist != NULL);
1501       c_alias = lookup_cmd_1 (& alias_prefix, cmdlist, NULL, 1);
1502       if (c_alias != c_command)
1503 	error (_("ALIAS and COMMAND prefixes do not match."));
1504 
1505       /* add_cmd requires *we* allocate space for name, hence the xstrdup.  */
1506       add_alias_cmd (xstrdup (alias_argv[alias_argc - 1]),
1507 		     command_argv[command_argc - 1],
1508 		     class_alias, abbrev_flag, c_command->prefixlist);
1509     }
1510 }
1511 
1512 /* Print the file / line number / symbol name of the location
1513    specified by SAL.  */
1514 
1515 static void
1516 print_sal_location (const symtab_and_line &sal)
1517 {
1518   scoped_restore_current_program_space restore_pspace;
1519   set_current_program_space (sal.pspace);
1520 
1521   const char *sym_name = NULL;
1522   if (sal.symbol != NULL)
1523     sym_name = SYMBOL_PRINT_NAME (sal.symbol);
1524   printf_filtered (_("file: \"%s\", line number: %d, symbol: \"%s\"\n"),
1525 		   symtab_to_filename_for_display (sal.symtab),
1526 		   sal.line, sym_name != NULL ? sym_name : "???");
1527 }
1528 
1529 /* Print a list of files and line numbers which a user may choose from
1530    in order to list a function which was specified ambiguously (as
1531    with `list classname::overloadedfuncname', for example).  The SALS
1532    array provides the filenames and line numbers.  FORMAT is a
1533    printf-style format string used to tell the user what was
1534    ambiguous.  */
1535 
1536 static void
1537 ambiguous_line_spec (gdb::array_view<const symtab_and_line> sals,
1538 		     const char *format, ...)
1539 {
1540   va_list ap;
1541   va_start (ap, format);
1542   vprintf_filtered (format, ap);
1543   va_end (ap);
1544 
1545   for (const auto &sal : sals)
1546     print_sal_location (sal);
1547 }
1548 
1549 /* Comparison function for filter_sals.  Returns a qsort-style
1550    result.  */
1551 
1552 static int
1553 cmp_symtabs (const symtab_and_line &sala, const symtab_and_line &salb)
1554 {
1555   const char *dira = SYMTAB_DIRNAME (sala.symtab);
1556   const char *dirb = SYMTAB_DIRNAME (salb.symtab);
1557   int r;
1558 
1559   if (dira == NULL)
1560     {
1561       if (dirb != NULL)
1562 	return -1;
1563     }
1564   else if (dirb == NULL)
1565     {
1566       if (dira != NULL)
1567 	return 1;
1568     }
1569   else
1570     {
1571       r = filename_cmp (dira, dirb);
1572       if (r)
1573 	return r;
1574     }
1575 
1576   r = filename_cmp (sala.symtab->filename, salb.symtab->filename);
1577   if (r)
1578     return r;
1579 
1580   if (sala.line < salb.line)
1581     return -1;
1582   return sala.line == salb.line ? 0 : 1;
1583 }
1584 
1585 /* Remove any SALs that do not match the current program space, or
1586    which appear to be "file:line" duplicates.  */
1587 
1588 static void
1589 filter_sals (std::vector<symtab_and_line> &sals)
1590 {
1591   /* Remove SALs that do not match.  */
1592   auto from = std::remove_if (sals.begin (), sals.end (),
1593 			      [&] (const symtab_and_line &sal)
1594     { return (sal.pspace != current_program_space || sal.symtab == NULL); });
1595 
1596   /* Remove dups.  */
1597   std::sort (sals.begin (), from,
1598 	     [] (const symtab_and_line &sala, const symtab_and_line &salb)
1599    { return cmp_symtabs (sala, salb) < 0; });
1600 
1601   from = std::unique (sals.begin (), from,
1602 		      [&] (const symtab_and_line &sala,
1603 			   const symtab_and_line &salb)
1604     { return cmp_symtabs (sala, salb) == 0; });
1605 
1606   sals.erase (from, sals.end ());
1607 }
1608 
1609 static void
1610 set_debug (const char *arg, int from_tty)
1611 {
1612   printf_unfiltered (_("\"set debug\" must be followed by "
1613 		       "the name of a debug subcommand.\n"));
1614   help_list (setdebuglist, "set debug ", all_commands, gdb_stdout);
1615 }
1616 
1617 static void
1618 show_debug (const char *args, int from_tty)
1619 {
1620   cmd_show_list (showdebuglist, from_tty, "");
1621 }
1622 
1623 void
1624 init_cmd_lists (void)
1625 {
1626   max_user_call_depth = 1024;
1627 }
1628 
1629 static void
1630 show_info_verbose (struct ui_file *file, int from_tty,
1631 		   struct cmd_list_element *c,
1632 		   const char *value)
1633 {
1634   if (info_verbose)
1635     fprintf_filtered (file,
1636 		      _("Verbose printing of informational messages is %s.\n"),
1637 		      value);
1638   else
1639     fprintf_filtered (file, _("Verbosity is %s.\n"), value);
1640 }
1641 
1642 static void
1643 show_history_expansion_p (struct ui_file *file, int from_tty,
1644 			  struct cmd_list_element *c, const char *value)
1645 {
1646   fprintf_filtered (file, _("History expansion on command input is %s.\n"),
1647 		    value);
1648 }
1649 
1650 static void
1651 show_remote_debug (struct ui_file *file, int from_tty,
1652 		   struct cmd_list_element *c, const char *value)
1653 {
1654   fprintf_filtered (file, _("Debugging of remote protocol is %s.\n"),
1655 		    value);
1656 }
1657 
1658 static void
1659 show_remote_timeout (struct ui_file *file, int from_tty,
1660 		     struct cmd_list_element *c, const char *value)
1661 {
1662   fprintf_filtered (file,
1663 		    _("Timeout limit to wait for target to respond is %s.\n"),
1664 		    value);
1665 }
1666 
1667 static void
1668 show_max_user_call_depth (struct ui_file *file, int from_tty,
1669 			  struct cmd_list_element *c, const char *value)
1670 {
1671   fprintf_filtered (file,
1672 		    _("The max call depth for user-defined commands is %s.\n"),
1673 		    value);
1674 }
1675 
1676 void
1677 _initialize_cli_cmds (void)
1678 {
1679   struct cmd_list_element *c;
1680 
1681   /* Define the classes of commands.
1682      They will appear in the help list in alphabetical order.  */
1683 
1684   add_cmd ("internals", class_maintenance, _("\
1685 Maintenance commands.\n\
1686 Some gdb commands are provided just for use by gdb maintainers.\n\
1687 These commands are subject to frequent change, and may not be as\n\
1688 well documented as user commands."),
1689 	   &cmdlist);
1690   add_cmd ("obscure", class_obscure, _("Obscure features."), &cmdlist);
1691   add_cmd ("aliases", class_alias,
1692 	   _("Aliases of other commands."), &cmdlist);
1693   add_cmd ("user-defined", class_user, _("\
1694 User-defined commands.\n\
1695 The commands in this class are those defined by the user.\n\
1696 Use the \"define\" command to define a command."), &cmdlist);
1697   add_cmd ("support", class_support, _("Support facilities."), &cmdlist);
1698   if (!dbx_commands)
1699     add_cmd ("status", class_info, _("Status inquiries."), &cmdlist);
1700   add_cmd ("files", class_files, _("Specifying and examining files."),
1701 	   &cmdlist);
1702   add_cmd ("breakpoints", class_breakpoint,
1703 	   _("Making program stop at certain points."), &cmdlist);
1704   add_cmd ("data", class_vars, _("Examining data."), &cmdlist);
1705   add_cmd ("stack", class_stack, _("\
1706 Examining the stack.\n\
1707 The stack is made up of stack frames.  Gdb assigns numbers to stack frames\n\
1708 counting from zero for the innermost (currently executing) frame.\n\n\
1709 At any time gdb identifies one frame as the \"selected\" frame.\n\
1710 Variable lookups are done with respect to the selected frame.\n\
1711 When the program being debugged stops, gdb selects the innermost frame.\n\
1712 The commands below can be used to select other frames by number or address."),
1713 	   &cmdlist);
1714   add_cmd ("running", class_run, _("Running the program."), &cmdlist);
1715 
1716   /* Define general commands.  */
1717 
1718   add_com ("pwd", class_files, pwd_command, _("\
1719 Print working directory.  This is used for your program as well."));
1720 
1721   c = add_cmd ("cd", class_files, cd_command, _("\
1722 Set working directory to DIR for debugger.\n\
1723 The debugger's current working directory specifies where scripts and other\n\
1724 files that can be loaded by GDB are located.\n\
1725 In order to change the inferior's current working directory, the recommended\n\
1726 way is to use the \"set cwd\" command."), &cmdlist);
1727   set_cmd_completer (c, filename_completer);
1728 
1729   add_com ("echo", class_support, echo_command, _("\
1730 Print a constant string.  Give string as argument.\n\
1731 C escape sequences may be used in the argument.\n\
1732 No newline is added at the end of the argument;\n\
1733 use \"\\n\" if you want a newline to be printed.\n\
1734 Since leading and trailing whitespace are ignored in command arguments,\n\
1735 if you want to print some you must use \"\\\" before leading whitespace\n\
1736 to be printed or after trailing whitespace."));
1737 
1738   add_setshow_enum_cmd ("script-extension", class_support,
1739 			script_ext_enums, &script_ext_mode, _("\
1740 Set mode for script filename extension recognition."), _("\
1741 Show mode for script filename extension recognition."), _("\
1742 off  == no filename extension recognition (all sourced files are GDB scripts)\n\
1743 soft == evaluate script according to filename extension, fallback to GDB script"
1744   "\n\
1745 strict == evaluate script according to filename extension, error if not supported"
1746   ),
1747 			NULL,
1748 			show_script_ext_mode,
1749 			&setlist, &showlist);
1750 
1751   add_com ("quit", class_support, quit_command, _("\
1752 Exit gdb.\n\
1753 Usage: quit [EXPR]\n\
1754 The optional expression EXPR, if present, is evaluated and the result\n\
1755 used as GDB's exit code.  The default is zero."));
1756   c = add_com ("help", class_support, help_command,
1757 	       _("Print list of commands."));
1758   set_cmd_completer (c, command_completer);
1759   add_com_alias ("q", "quit", class_support, 1);
1760   add_com_alias ("h", "help", class_support, 1);
1761 
1762   add_setshow_boolean_cmd ("verbose", class_support, &info_verbose, _("\
1763 Set verbosity."), _("\
1764 Show verbosity."), NULL,
1765 			   set_verbose,
1766 			   show_info_verbose,
1767 			   &setlist, &showlist);
1768 
1769   add_prefix_cmd ("history", class_support, set_history,
1770 		  _("Generic command for setting command history parameters."),
1771 		  &sethistlist, "set history ", 0, &setlist);
1772   add_prefix_cmd ("history", class_support, show_history,
1773 		  _("Generic command for showing command history parameters."),
1774 		  &showhistlist, "show history ", 0, &showlist);
1775 
1776   add_setshow_boolean_cmd ("expansion", no_class, &history_expansion_p, _("\
1777 Set history expansion on command input."), _("\
1778 Show history expansion on command input."), _("\
1779 Without an argument, history expansion is enabled."),
1780 			   NULL,
1781 			   show_history_expansion_p,
1782 			   &sethistlist, &showhistlist);
1783 
1784   add_prefix_cmd ("info", class_info, info_command, _("\
1785 Generic command for showing things about the program being debugged."),
1786 		  &infolist, "info ", 0, &cmdlist);
1787   add_com_alias ("i", "info", class_info, 1);
1788   add_com_alias ("inf", "info", class_info, 1);
1789 
1790   add_com ("complete", class_obscure, complete_command,
1791 	   _("List the completions for the rest of the line as a command."));
1792 
1793   add_prefix_cmd ("show", class_info, show_command, _("\
1794 Generic command for showing things about the debugger."),
1795 		  &showlist, "show ", 0, &cmdlist);
1796   /* Another way to get at the same thing.  */
1797   add_info ("set", show_command, _("Show all GDB settings."));
1798 
1799   add_cmd ("commands", no_set_class, show_commands, _("\
1800 Show the history of commands you typed.\n\
1801 You can supply a command number to start with, or a `+' to start after\n\
1802 the previous command number shown."),
1803 	   &showlist);
1804 
1805   add_cmd ("version", no_set_class, show_version,
1806 	   _("Show what version of GDB this is."), &showlist);
1807 
1808   add_cmd ("configuration", no_set_class, show_configuration,
1809 	   _("Show how GDB was configured at build time."), &showlist);
1810 
1811   add_setshow_zinteger_cmd ("remote", no_class, &remote_debug, _("\
1812 Set debugging of remote protocol."), _("\
1813 Show debugging of remote protocol."), _("\
1814 When enabled, each packet sent or received with the remote target\n\
1815 is displayed."),
1816 			    NULL,
1817 			    show_remote_debug,
1818 			    &setdebuglist, &showdebuglist);
1819 
1820   add_setshow_zuinteger_unlimited_cmd ("remotetimeout", no_class,
1821 				       &remote_timeout, _("\
1822 Set timeout limit to wait for target to respond."), _("\
1823 Show timeout limit to wait for target to respond."), _("\
1824 This value is used to set the time limit for gdb to wait for a response\n\
1825 from the target."),
1826 				       NULL,
1827 				       show_remote_timeout,
1828 				       &setlist, &showlist);
1829 
1830   add_prefix_cmd ("debug", no_class, set_debug,
1831 		  _("Generic command for setting gdb debugging flags"),
1832 		  &setdebuglist, "set debug ", 0, &setlist);
1833 
1834   add_prefix_cmd ("debug", no_class, show_debug,
1835 		  _("Generic command for showing gdb debugging flags"),
1836 		  &showdebuglist, "show debug ", 0, &showlist);
1837 
1838   c = add_com ("shell", class_support, shell_command, _("\
1839 Execute the rest of the line as a shell command.\n\
1840 With no arguments, run an inferior shell."));
1841   set_cmd_completer (c, filename_completer);
1842 
1843   c = add_com ("edit", class_files, edit_command, _("\
1844 Edit specified file or function.\n\
1845 With no argument, edits file containing most recent line listed.\n\
1846 Editing targets can be specified in these ways:\n\
1847   FILE:LINENUM, to edit at that line in that file,\n\
1848   FUNCTION, to edit at the beginning of that function,\n\
1849   FILE:FUNCTION, to distinguish among like-named static functions.\n\
1850   *ADDRESS, to edit at the line containing that address.\n\
1851 Uses EDITOR environment variable contents as editor (or ex as default)."));
1852 
1853   c->completer = location_completer;
1854 
1855   add_com ("list", class_files, list_command, _("\
1856 List specified function or line.\n\
1857 With no argument, lists ten more lines after or around previous listing.\n\
1858 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1859 One argument specifies a line, and ten lines are listed around that line.\n\
1860 Two arguments with comma between specify starting and ending lines to list.\n\
1861 Lines can be specified in these ways:\n\
1862   LINENUM, to list around that line in current file,\n\
1863   FILE:LINENUM, to list around that line in that file,\n\
1864   FUNCTION, to list around beginning of that function,\n\
1865   FILE:FUNCTION, to distinguish among like-named static functions.\n\
1866   *ADDRESS, to list around the line containing that address.\n\
1867 With two args, if one is empty, it stands for ten lines away from\n\
1868 the other arg.\n\
1869 \n\
1870 By default, when a single location is given, display ten lines.\n\
1871 This can be changed using \"set listsize\", and the current value\n\
1872 can be shown using \"show listsize\"."));
1873 
1874   add_com_alias ("l", "list", class_files, 1);
1875 
1876   if (dbx_commands)
1877     add_com_alias ("file", "list", class_files, 1);
1878 
1879   c = add_com ("disassemble", class_vars, disassemble_command, _("\
1880 Disassemble a specified section of memory.\n\
1881 Default is the function surrounding the pc of the selected frame.\n\
1882 \n\
1883 With a /m modifier, source lines are included (if available).\n\
1884 This view is \"source centric\": the output is in source line order,\n\
1885 regardless of any optimization that is present.  Only the main source file\n\
1886 is displayed, not those of, e.g., any inlined functions.\n\
1887 This modifier hasn't proved useful in practice and is deprecated\n\
1888 in favor of /s.\n\
1889 \n\
1890 With a /s modifier, source lines are included (if available).\n\
1891 This differs from /m in two important respects:\n\
1892 - the output is still in pc address order, and\n\
1893 - file names and contents for all relevant source files are displayed.\n\
1894 \n\
1895 With a /r modifier, raw instructions in hex are included.\n\
1896 \n\
1897 With a single argument, the function surrounding that address is dumped.\n\
1898 Two arguments (separated by a comma) are taken as a range of memory to dump,\n\
1899   in the form of \"start,end\", or \"start,+length\".\n\
1900 \n\
1901 Note that the address is interpreted as an expression, not as a location\n\
1902 like in the \"break\" command.\n\
1903 So, for example, if you want to disassemble function bar in file foo.c\n\
1904 you must type \"disassemble 'foo.c'::bar\" and not \"disassemble foo.c:bar\"."));
1905   set_cmd_completer (c, location_completer);
1906 
1907   add_com_alias ("!", "shell", class_support, 0);
1908 
1909   c = add_com ("make", class_support, make_command, _("\
1910 Run the ``make'' program using the rest of the line as arguments."));
1911   set_cmd_completer (c, filename_completer);
1912   add_cmd ("user", no_class, show_user, _("\
1913 Show definitions of non-python/scheme user defined commands.\n\
1914 Argument is the name of the user defined command.\n\
1915 With no argument, show definitions of all user defined commands."), &showlist);
1916   add_com ("apropos", class_support, apropos_command,
1917 	   _("Search for commands matching a REGEXP"));
1918 
1919   add_setshow_uinteger_cmd ("max-user-call-depth", no_class,
1920 			   &max_user_call_depth, _("\
1921 Set the max call depth for non-python/scheme user-defined commands."), _("\
1922 Show the max call depth for non-python/scheme user-defined commands."), NULL,
1923 			    NULL,
1924 			    show_max_user_call_depth,
1925 			    &setlist, &showlist);
1926 
1927   add_setshow_boolean_cmd ("trace-commands", no_class, &trace_commands, _("\
1928 Set tracing of GDB CLI commands."), _("\
1929 Show state of GDB CLI command tracing."), _("\
1930 When 'on', each command is displayed as it is executed."),
1931 			   NULL,
1932 			   NULL,
1933 			   &setlist, &showlist);
1934 
1935   c = add_com ("alias", class_support, alias_command, _("\
1936 Define a new command that is an alias of an existing command.\n\
1937 Usage: alias [-a] [--] ALIAS = COMMAND\n\
1938 ALIAS is the name of the alias command to create.\n\
1939 COMMAND is the command being aliased to.\n\
1940 If \"-a\" is specified, the command is an abbreviation,\n\
1941 and will not appear in help command list output.\n\
1942 \n\
1943 Examples:\n\
1944 Make \"spe\" an alias of \"set print elements\":\n\
1945   alias spe = set print elements\n\
1946 Make \"elms\" an alias of \"elements\" in the \"set print\" command:\n\
1947   alias -a set print elms = set print elements"));
1948 }
1949 
1950 void
1951 init_cli_cmds (void)
1952 {
1953   struct cmd_list_element *c;
1954   char *source_help_text;
1955 
1956   source_help_text = xstrprintf (_("\
1957 Read commands from a file named FILE.\n\
1958 \n\
1959 Usage: source [-s] [-v] FILE\n\
1960 -s: search for the script in the source search path,\n\
1961     even if FILE contains directories.\n\
1962 -v: each command in FILE is echoed as it is executed.\n\
1963 \n\
1964 Note that the file \"%s\" is read automatically in this way\n\
1965 when GDB is started."), gdbinit);
1966   c = add_cmd ("source", class_support, source_command,
1967 	       source_help_text, &cmdlist);
1968   set_cmd_completer (c, filename_completer);
1969 }
1970