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