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