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