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