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