Add some more casts (1/2)
[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
543 static void
544 source_script_from_stream (FILE *stream, const char *file)
545 {
546   if (script_ext_mode != script_ext_off)
547     {
548       const struct extension_language_defn *extlang
549         = get_ext_lang_of_file (file);
550
551       if (extlang != NULL)
552         {
553           if (ext_lang_present_p (extlang))
554             {
555               script_sourcer_func *sourcer
556                 = ext_lang_script_sourcer (extlang);
557
558               gdb_assert (sourcer != NULL);
559               sourcer (extlang, stream, file);
560               return;
561             }
562           else if (script_ext_mode == script_ext_soft)
563             {
564               /* Assume the file is a gdb script.
565                  This is handled below.  */
566             }
567           else
568             throw_ext_lang_unsupported (extlang);
569         }
570     }
571
572   script_from_file (stream, file);
573 }
574
575 /* Worker to perform the "source" command.
576    Load script FILE.
577    If SEARCH_PATH is non-zero, and the file isn't found in cwd,
578    search for it in the source search path.  */
579
580 static void
581 source_script_with_search (const char *file, int from_tty, int search_path)
582 {
583   FILE *stream;
584   char *full_path;
585   struct cleanup *old_cleanups;
586
587   if (file == NULL || *file == 0)
588     error (_("source command requires file name of file to source."));
589
590   if (!find_and_open_script (file, search_path, &stream, &full_path))
591     {
592       /* The script wasn't found, or was otherwise inaccessible.
593          If the source command was invoked interactively, throw an
594          error.  Otherwise (e.g. if it was invoked by a script),
595          just emit a warning, rather than cause an error.  */
596       if (from_tty)
597         perror_with_name (file);
598       else
599         {
600           perror_warning_with_name (file);
601           return;
602         }
603     }
604
605   old_cleanups = make_cleanup (xfree, full_path);
606   make_cleanup_fclose (stream);
607   /* The python support reopens the file, so we need to pass full_path here
608      in case the file was found on the search path.  It's useful to do this
609      anyway so that error messages show the actual file used.  But only do
610      this if we (may have) used search_path, as printing the full path in
611      errors for the non-search case can be more noise than signal.  */
612   source_script_from_stream (stream, search_path ? full_path : file);
613   do_cleanups (old_cleanups);
614 }
615
616 /* Wrapper around source_script_with_search to export it to main.c
617    for use in loading .gdbinit scripts.  */
618
619 void
620 source_script (const char *file, int from_tty)
621 {
622   source_script_with_search (file, from_tty, 0);
623 }
624
625 /* Return the source_verbose global variable to its previous state
626    on exit from the source command, by whatever means.  */
627 static void
628 source_verbose_cleanup (void *old_value)
629 {
630   source_verbose = *(int *)old_value;
631   xfree (old_value);
632 }
633
634 static void
635 source_command (char *args, int from_tty)
636 {
637   struct cleanup *old_cleanups;
638   char *file = args;
639   int *old_source_verbose = XNEW (int);
640   int search_path = 0;
641
642   *old_source_verbose = source_verbose;
643   old_cleanups = make_cleanup (source_verbose_cleanup, 
644                                old_source_verbose);
645
646   /* -v causes the source command to run in verbose mode.
647      -s causes the file to be searched in the source search path,
648      even if the file name contains a '/'.
649      We still have to be able to handle filenames with spaces in a
650      backward compatible way, so buildargv is not appropriate.  */
651
652   if (args)
653     {
654       while (args[0] != '\0')
655         {
656           /* Make sure leading white space does not break the
657              comparisons.  */
658           args = skip_spaces (args);
659
660           if (args[0] != '-')
661             break;
662
663           if (args[1] == 'v' && isspace (args[2]))
664             {
665               source_verbose = 1;
666
667               /* Skip passed -v.  */
668               args = &args[3];
669             }
670           else if (args[1] == 's' && isspace (args[2]))
671             {
672               search_path = 1;
673
674               /* Skip passed -s.  */
675               args = &args[3];
676             }
677           else
678             break;
679         }
680
681       file = skip_spaces (args);
682     }
683
684   source_script_with_search (file, from_tty, search_path);
685
686   do_cleanups (old_cleanups);
687 }
688
689
690 static void
691 echo_command (char *text, int from_tty)
692 {
693   const char *p = text;
694   int c;
695
696   if (text)
697     while ((c = *p++) != '\0')
698       {
699         if (c == '\\')
700           {
701             /* \ at end of argument is used after spaces
702                so they won't be lost.  */
703             if (*p == 0)
704               return;
705
706             c = parse_escape (get_current_arch (), &p);
707             if (c >= 0)
708               printf_filtered ("%c", c);
709           }
710         else
711           printf_filtered ("%c", c);
712       }
713
714   /* Force this output to appear now.  */
715   wrap_here ("");
716   gdb_flush (gdb_stdout);
717 }
718
719 static void
720 shell_escape (char *arg, int from_tty)
721 {
722 #if defined(CANT_FORK) || \
723       (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
724   /* If ARG is NULL, they want an inferior shell, but `system' just
725      reports if the shell is available when passed a NULL arg.  */
726   int rc = system (arg ? arg : "");
727
728   if (!arg)
729     arg = "inferior shell";
730
731   if (rc == -1)
732     {
733       fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
734                           safe_strerror (errno));
735       gdb_flush (gdb_stderr);
736     }
737   else if (rc)
738     {
739       fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
740       gdb_flush (gdb_stderr);
741     }
742 #ifdef GLOBAL_CURDIR
743   /* Make sure to return to the directory GDB thinks it is, in case
744      the shell command we just ran changed it.  */
745   chdir (current_directory);
746 #endif
747 #else /* Can fork.  */
748   int status, pid;
749
750   if ((pid = vfork ()) == 0)
751     {
752       const char *p, *user_shell;
753
754       close_most_fds ();
755
756       if ((user_shell = (char *) getenv ("SHELL")) == NULL)
757         user_shell = "/bin/sh";
758
759       /* Get the name of the shell for arg0.  */
760       p = lbasename (user_shell);
761
762       if (!arg)
763         execl (user_shell, p, (char *) 0);
764       else
765         execl (user_shell, p, "-c", arg, (char *) 0);
766
767       fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
768                           safe_strerror (errno));
769       gdb_flush (gdb_stderr);
770       _exit (0177);
771     }
772
773   if (pid != -1)
774     waitpid (pid, &status, 0);
775   else
776     error (_("Fork failed"));
777 #endif /* Can fork.  */
778 }
779
780 static void
781 edit_command (char *arg, int from_tty)
782 {
783   struct symtabs_and_lines sals;
784   struct symtab_and_line sal;
785   struct symbol *sym;
786   char *editor;
787   char *p;
788   const char *fn;
789
790   /* Pull in the current default source line if necessary.  */
791   if (arg == 0)
792     {
793       set_default_source_symtab_and_line ();
794       sal = get_current_source_symtab_and_line ();
795     }
796
797   /* Bare "edit" edits file with present line.  */
798
799   if (arg == 0)
800     {
801       if (sal.symtab == 0)
802         error (_("No default source file yet."));
803       sal.line += get_lines_to_list () / 2;
804     }
805   else
806     {
807       struct cleanup *cleanup;
808       struct event_location *location;
809       char *arg1;
810
811       /* Now should only be one argument -- decode it in SAL.  */
812       arg1 = arg;
813       location = string_to_event_location (&arg1, current_language);
814       cleanup = make_cleanup_delete_event_location (location);
815       sals = decode_line_1 (location, DECODE_LINE_LIST_MODE, 0, 0);
816
817       filter_sals (&sals);
818       if (! sals.nelts)
819         {
820           /*  C++  */
821           do_cleanups (cleanup);
822           return;
823         }
824       if (sals.nelts > 1)
825         {
826           ambiguous_line_spec (&sals);
827           xfree (sals.sals);
828           do_cleanups (cleanup);
829           return;
830         }
831
832       sal = sals.sals[0];
833       xfree (sals.sals);
834
835       if (*arg1)
836         error (_("Junk at end of line specification."));
837
838       /* If line was specified by address, first print exactly which
839          line, and which file.  In this case, sal.symtab == 0 means
840          address is outside of all known source files, not that user
841          failed to give a filename.  */
842       if (*arg == '*')
843         {
844           struct gdbarch *gdbarch;
845
846           if (sal.symtab == 0)
847             error (_("No source file for address %s."),
848                    paddress (get_current_arch (), sal.pc));
849
850           gdbarch = get_objfile_arch (SYMTAB_OBJFILE (sal.symtab));
851           sym = find_pc_function (sal.pc);
852           if (sym)
853             printf_filtered ("%s is in %s (%s:%d).\n",
854                              paddress (gdbarch, sal.pc),
855                              SYMBOL_PRINT_NAME (sym),
856                              symtab_to_filename_for_display (sal.symtab),
857                              sal.line);
858           else
859             printf_filtered ("%s is at %s:%d.\n",
860                              paddress (gdbarch, sal.pc),
861                              symtab_to_filename_for_display (sal.symtab),
862                              sal.line);
863         }
864
865       /* If what was given does not imply a symtab, it must be an
866          undebuggable symbol which means no source code.  */
867
868       if (sal.symtab == 0)
869         error (_("No line number known for %s."), arg);
870       do_cleanups (cleanup);
871     }
872
873   if ((editor = (char *) getenv ("EDITOR")) == NULL)
874       editor = "/bin/ex";
875
876   fn = symtab_to_fullname (sal.symtab);
877
878   /* Quote the file name, in case it has whitespace or other special
879      characters.  */
880   p = xstrprintf ("%s +%d \"%s\"", editor, sal.line, fn);
881   shell_escape (p, from_tty);
882   xfree (p);
883 }
884
885 static void
886 list_command (char *arg, int from_tty)
887 {
888   struct symtabs_and_lines sals, sals_end;
889   struct symtab_and_line sal = { 0 };
890   struct symtab_and_line sal_end = { 0 };
891   struct symtab_and_line cursal = { 0 };
892   struct symbol *sym;
893   char *arg1;
894   int no_end = 1;
895   int dummy_end = 0;
896   int dummy_beg = 0;
897   int linenum_beg = 0;
898   char *p;
899   struct cleanup *cleanup;
900
901   cleanup = make_cleanup (null_cleanup, NULL);
902
903   /* Pull in the current default source line if necessary.  */
904   if (arg == 0 || arg[0] == '+' || arg[0] == '-')
905     {
906       set_default_source_symtab_and_line ();
907       cursal = get_current_source_symtab_and_line ();
908
909       /* If this is the first "list" since we've set the current
910          source line, center the listing around that line.  */
911       if (get_first_line_listed () == 0)
912         {
913           int first;
914
915           first = max (cursal.line - get_lines_to_list () / 2, 1);
916
917           /* A small special case --- if listing backwards, and we
918              should list only one line, list the preceding line,
919              instead of the exact line we've just shown after e.g.,
920              stopping for a breakpoint.  */
921           if (arg != NULL && arg[0] == '-'
922               && get_lines_to_list () == 1 && first > 1)
923             first -= 1;
924
925           print_source_lines (cursal.symtab, first,
926                               first + get_lines_to_list (), 0);
927           return;
928         }
929     }
930
931   /* "l" or "l +" lists next ten lines.  */
932
933   if (arg == 0 || strcmp (arg, "+") == 0)
934     {
935       print_source_lines (cursal.symtab, cursal.line,
936                           cursal.line + get_lines_to_list (), 0);
937       return;
938     }
939
940   /* "l -" lists previous ten lines, the ones before the ten just
941      listed.  */
942   if (strcmp (arg, "-") == 0)
943     {
944       print_source_lines (cursal.symtab,
945                           max (get_first_line_listed () 
946                                - get_lines_to_list (), 1),
947                           get_first_line_listed (), 0);
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   arg1 = arg;
961   if (*arg1 == ',')
962     dummy_beg = 1;
963   else
964     {
965       struct event_location *location;
966
967       location = string_to_event_location (&arg1, current_language);
968       make_cleanup_delete_event_location (location);
969       sals = decode_line_1 (location, DECODE_LINE_LIST_MODE, 0, 0);
970
971       filter_sals (&sals);
972       if (!sals.nelts)
973         {
974           /*  C++  */
975           do_cleanups (cleanup);
976           return;
977         }
978       if (sals.nelts > 1)
979         {
980           ambiguous_line_spec (&sals);
981           xfree (sals.sals);
982           do_cleanups (cleanup);
983           return;
984         }
985
986       sal = sals.sals[0];
987       xfree (sals.sals);
988     }
989
990   /* Record whether the BEG arg is all digits.  */
991
992   for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
993   linenum_beg = (p == arg1);
994
995   while (*arg1 == ' ' || *arg1 == '\t')
996     arg1++;
997   if (*arg1 == ',')
998     {
999       no_end = 0;
1000       arg1++;
1001       while (*arg1 == ' ' || *arg1 == '\t')
1002         arg1++;
1003       if (*arg1 == 0)
1004         dummy_end = 1;
1005       else
1006         {
1007           struct event_location *location;
1008
1009           location = string_to_event_location (&arg1, current_language);
1010           make_cleanup_delete_event_location (location);
1011           if (dummy_beg)
1012             sals_end = decode_line_1 (location,
1013                                       DECODE_LINE_LIST_MODE, 0, 0);
1014           else
1015             sals_end = decode_line_1 (location, DECODE_LINE_LIST_MODE,
1016                                       sal.symtab, sal.line);
1017
1018           filter_sals (&sals_end);
1019           if (sals_end.nelts == 0)
1020             {
1021               do_cleanups (cleanup);
1022               return;
1023             }
1024           if (sals_end.nelts > 1)
1025             {
1026               ambiguous_line_spec (&sals_end);
1027               xfree (sals_end.sals);
1028               do_cleanups (cleanup);
1029               return;
1030             }
1031           sal_end = sals_end.sals[0];
1032           xfree (sals_end.sals);
1033         }
1034     }
1035
1036   if (*arg1)
1037     error (_("Junk at end of line specification."));
1038
1039   if (!no_end && !dummy_beg && !dummy_end
1040       && sal.symtab != sal_end.symtab)
1041     error (_("Specified start and end are in different files."));
1042   if (dummy_beg && dummy_end)
1043     error (_("Two empty args do not say what lines to list."));
1044
1045   /* If line was specified by address,
1046      first print exactly which line, and which file.
1047
1048      In this case, sal.symtab == 0 means address is outside of all
1049      known source files, not that user failed to give a filename.  */
1050   if (*arg == '*')
1051     {
1052       struct gdbarch *gdbarch;
1053
1054       if (sal.symtab == 0)
1055         error (_("No source file for address %s."),
1056                paddress (get_current_arch (), sal.pc));
1057
1058       gdbarch = get_objfile_arch (SYMTAB_OBJFILE (sal.symtab));
1059       sym = find_pc_function (sal.pc);
1060       if (sym)
1061         printf_filtered ("%s is in %s (%s:%d).\n",
1062                          paddress (gdbarch, sal.pc),
1063                          SYMBOL_PRINT_NAME (sym),
1064                          symtab_to_filename_for_display (sal.symtab), sal.line);
1065       else
1066         printf_filtered ("%s is at %s:%d.\n",
1067                          paddress (gdbarch, sal.pc),
1068                          symtab_to_filename_for_display (sal.symtab), sal.line);
1069     }
1070
1071   /* If line was not specified by just a line number, and it does not
1072      imply a symtab, it must be an undebuggable symbol which means no
1073      source code.  */
1074
1075   if (!linenum_beg && sal.symtab == 0)
1076     error (_("No line number known for %s."), arg);
1077
1078   /* If this command is repeated with RET,
1079      turn it into the no-arg variant.  */
1080
1081   if (from_tty)
1082     *arg = 0;
1083
1084   if (dummy_beg && sal_end.symtab == 0)
1085     error (_("No default source file yet.  Do \"help list\"."));
1086   if (dummy_beg)
1087     print_source_lines (sal_end.symtab,
1088                         max (sal_end.line - (get_lines_to_list () - 1), 1),
1089                         sal_end.line + 1, 0);
1090   else if (sal.symtab == 0)
1091     error (_("No default source file yet.  Do \"help list\"."));
1092   else if (no_end)
1093     {
1094       int first_line = sal.line - get_lines_to_list () / 2;
1095
1096       if (first_line < 1) first_line = 1;
1097
1098       print_source_lines (sal.symtab,
1099                           first_line,
1100                           first_line + get_lines_to_list (),
1101                           0);
1102     }
1103   else
1104     print_source_lines (sal.symtab, sal.line,
1105                         (dummy_end
1106                          ? sal.line + get_lines_to_list ()
1107                          : sal_end.line + 1),
1108                         0);
1109   do_cleanups (cleanup);
1110 }
1111
1112 /* Subroutine of disassemble_command to simplify it.
1113    Perform the disassembly.
1114    NAME is the name of the function if known, or NULL.
1115    [LOW,HIGH) are the range of addresses to disassemble.
1116    MIXED is non-zero to print source with the assembler.  */
1117
1118 static void
1119 print_disassembly (struct gdbarch *gdbarch, const char *name,
1120                    CORE_ADDR low, CORE_ADDR high, int flags)
1121 {
1122 #if defined(TUI)
1123   if (!tui_is_window_visible (DISASSEM_WIN))
1124 #endif
1125     {
1126       printf_filtered ("Dump of assembler code ");
1127       if (name != NULL)
1128         printf_filtered ("for function %s:\n", name);
1129       else
1130         printf_filtered ("from %s to %s:\n",
1131                          paddress (gdbarch, low), paddress (gdbarch, high));
1132
1133       /* Dump the specified range.  */
1134       gdb_disassembly (gdbarch, current_uiout, 0, flags, -1, low, high);
1135
1136       printf_filtered ("End of assembler dump.\n");
1137       gdb_flush (gdb_stdout);
1138     }
1139 #if defined(TUI)
1140   else
1141     {
1142       tui_show_assembly (gdbarch, low);
1143     }
1144 #endif
1145 }
1146
1147 /* Subroutine of disassemble_command to simplify it.
1148    Print a disassembly of the current function according to FLAGS.  */
1149
1150 static void
1151 disassemble_current_function (int flags)
1152 {
1153   struct frame_info *frame;
1154   struct gdbarch *gdbarch;
1155   CORE_ADDR low, high, pc;
1156   const char *name;
1157
1158   frame = get_selected_frame (_("No frame selected."));
1159   gdbarch = get_frame_arch (frame);
1160   pc = get_frame_address_in_block (frame);
1161   if (find_pc_partial_function (pc, &name, &low, &high) == 0)
1162     error (_("No function contains program counter for selected frame."));
1163 #if defined(TUI)
1164   /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1165      `tui_version'.  */
1166   if (tui_active)
1167     /* FIXME: cagney/2004-02-07: This should be an observer.  */
1168     low = tui_get_low_disassembly_address (gdbarch, low, pc);
1169 #endif
1170   low += gdbarch_deprecated_function_start_offset (gdbarch);
1171
1172   print_disassembly (gdbarch, name, low, high, flags);
1173 }
1174
1175 /* Dump a specified section of assembly code.
1176
1177    Usage:
1178      disassemble [/mrs]
1179        - dump the assembly code for the function of the current pc
1180      disassemble [/mrs] addr
1181        - dump the assembly code for the function at ADDR
1182      disassemble [/mrs] low,high
1183      disassemble [/mrs] low,+length
1184        - dump the assembly code in the range [LOW,HIGH), or [LOW,LOW+length)
1185
1186    A /m modifier will include source code with the assembly in a
1187    "source centric" view.  This view lists only the file of the first insn,
1188    even if other source files are involved (e.g., inlined functions), and
1189    the output is in source order, even with optimized code.  This view is
1190    considered deprecated as it hasn't been useful in practice.
1191
1192    A /r modifier will include raw instructions in hex with the assembly.
1193
1194    A /s modifier will include source code with the assembly, like /m, with
1195    two important differences:
1196    1) The output is still in pc address order.
1197    2) File names and contents for all relevant source files are displayed.  */
1198
1199 static void
1200 disassemble_command (char *arg, int from_tty)
1201 {
1202   struct gdbarch *gdbarch = get_current_arch ();
1203   CORE_ADDR low, high;
1204   const char *name;
1205   CORE_ADDR pc;
1206   int flags;
1207   const char *p;
1208
1209   p = arg;
1210   name = NULL;
1211   flags = 0;
1212
1213   if (p && *p == '/')
1214     {
1215       ++p;
1216
1217       if (*p == '\0')
1218         error (_("Missing modifier."));
1219
1220       while (*p && ! isspace (*p))
1221         {
1222           switch (*p++)
1223             {
1224             case 'm':
1225               flags |= DISASSEMBLY_SOURCE_DEPRECATED;
1226               break;
1227             case 'r':
1228               flags |= DISASSEMBLY_RAW_INSN;
1229               break;
1230             case 's':
1231               flags |= DISASSEMBLY_SOURCE;
1232               break;
1233             default:
1234               error (_("Invalid disassembly modifier."));
1235             }
1236         }
1237
1238       p = skip_spaces_const (p);
1239     }
1240
1241   if ((flags & (DISASSEMBLY_SOURCE_DEPRECATED | DISASSEMBLY_SOURCE))
1242       == (DISASSEMBLY_SOURCE_DEPRECATED | DISASSEMBLY_SOURCE))
1243     error (_("Cannot specify both /m and /s."));
1244
1245   if (! p || ! *p)
1246     {
1247       flags |= DISASSEMBLY_OMIT_FNAME;
1248       disassemble_current_function (flags);
1249       return;
1250     }
1251
1252   pc = value_as_address (parse_to_comma_and_eval (&p));
1253   if (p[0] == ',')
1254     ++p;
1255   if (p[0] == '\0')
1256     {
1257       /* One argument.  */
1258       if (find_pc_partial_function (pc, &name, &low, &high) == 0)
1259         error (_("No function contains specified address."));
1260 #if defined(TUI)
1261       /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1262          `tui_version'.  */
1263       if (tui_active)
1264         /* FIXME: cagney/2004-02-07: This should be an observer.  */
1265         low = tui_get_low_disassembly_address (gdbarch, low, pc);
1266 #endif
1267       low += gdbarch_deprecated_function_start_offset (gdbarch);
1268       flags |= DISASSEMBLY_OMIT_FNAME;
1269     }
1270   else
1271     {
1272       /* Two arguments.  */
1273       int incl_flag = 0;
1274       low = pc;
1275       p = skip_spaces_const (p);
1276       if (p[0] == '+')
1277         {
1278           ++p;
1279           incl_flag = 1;
1280         }
1281       high = parse_and_eval_address (p);
1282       if (incl_flag)
1283         high += low;
1284     }
1285
1286   print_disassembly (gdbarch, name, low, high, flags);
1287 }
1288
1289 static void
1290 make_command (char *arg, int from_tty)
1291 {
1292   char *p;
1293
1294   if (arg == 0)
1295     p = "make";
1296   else
1297     {
1298       p = (char *) xmalloc (sizeof ("make ") + strlen (arg));
1299       strcpy (p, "make ");
1300       strcpy (p + sizeof ("make ") - 1, arg);
1301     }
1302
1303   shell_escape (p, from_tty);
1304 }
1305
1306 static void
1307 show_user (char *args, int from_tty)
1308 {
1309   struct cmd_list_element *c;
1310   extern struct cmd_list_element *cmdlist;
1311
1312   if (args)
1313     {
1314       const char *comname = args;
1315
1316       c = lookup_cmd (&comname, cmdlist, "", 0, 1);
1317       if (!cli_user_command_p (c))
1318         error (_("Not a user command."));
1319       show_user_1 (c, "", args, gdb_stdout);
1320     }
1321   else
1322     {
1323       for (c = cmdlist; c; c = c->next)
1324         {
1325           if (cli_user_command_p (c) || c->prefixlist != NULL)
1326             show_user_1 (c, "", c->name, gdb_stdout);
1327         }
1328     }
1329 }
1330
1331 /* Search through names of commands and documentations for a certain
1332    regular expression.  */
1333
1334 static void 
1335 apropos_command (char *searchstr, int from_tty)
1336 {
1337   regex_t pattern;
1338   int code;
1339
1340   if (searchstr == NULL)
1341     error (_("REGEXP string is empty"));
1342
1343   code = regcomp (&pattern, searchstr, REG_ICASE);
1344   if (code == 0)
1345     {
1346       struct cleanup *cleanups;
1347
1348       cleanups = make_regfree_cleanup (&pattern);
1349       apropos_cmd (gdb_stdout, cmdlist, &pattern, "");
1350       do_cleanups (cleanups);
1351     }
1352   else
1353     {
1354       char *err = get_regcomp_error (code, &pattern);
1355
1356       make_cleanup (xfree, err);
1357       error (_("Error in regular expression: %s"), err);
1358     }
1359 }
1360
1361 /* Subroutine of alias_command to simplify it.
1362    Return the first N elements of ARGV flattened back to a string
1363    with a space separating each element.
1364    ARGV may not be NULL.
1365    This does not take care of quoting elements in case they contain spaces
1366    on purpose.  */
1367
1368 static dyn_string_t
1369 argv_to_dyn_string (char **argv, int n)
1370 {
1371   int i;
1372   dyn_string_t result = dyn_string_new (10);
1373
1374   gdb_assert (argv != NULL);
1375   gdb_assert (n >= 0 && n <= countargv (argv));
1376
1377   for (i = 0; i < n; ++i)
1378     {
1379       if (i > 0)
1380         dyn_string_append_char (result, ' ');
1381       dyn_string_append_cstr (result, argv[i]);
1382     }
1383
1384   return result;
1385 }
1386
1387 /* Subroutine of alias_command to simplify it.
1388    Return TRUE if COMMAND exists, unambiguously.  Otherwise FALSE.  */
1389
1390 static int
1391 valid_command_p (const char *command)
1392 {
1393   struct cmd_list_element *c;
1394
1395   c = lookup_cmd_1 (& command, cmdlist, NULL, 1);
1396
1397   if (c == NULL || c == (struct cmd_list_element *) -1)
1398     return FALSE;
1399
1400   /* This is the slightly tricky part.
1401      lookup_cmd_1 will return a pointer to the last part of COMMAND
1402      to match, leaving COMMAND pointing at the remainder.  */
1403   while (*command == ' ' || *command == '\t')
1404     ++command;
1405   return *command == '\0';
1406 }
1407
1408 /* Make an alias of an existing command.  */
1409
1410 static void
1411 alias_command (char *args, int from_tty)
1412 {
1413   int i, alias_argc, command_argc;
1414   int abbrev_flag = 0;
1415   char *args2, *equals, *alias, *command;
1416   char **alias_argv, **command_argv;
1417   dyn_string_t alias_dyn_string, command_dyn_string;
1418   struct cleanup *cleanup;
1419   static const char usage[] = N_("Usage: alias [-a] [--] ALIAS = COMMAND");
1420
1421   if (args == NULL || strchr (args, '=') == NULL)
1422     error (_(usage));
1423
1424   args2 = xstrdup (args);
1425   cleanup = make_cleanup (xfree, args2);
1426   equals = strchr (args2, '=');
1427   *equals = '\0';
1428   alias_argv = gdb_buildargv (args2);
1429   make_cleanup_freeargv (alias_argv);
1430   command_argv = gdb_buildargv (equals + 1);
1431   make_cleanup_freeargv (command_argv);
1432
1433   for (i = 0; alias_argv[i] != NULL; )
1434     {
1435       if (strcmp (alias_argv[i], "-a") == 0)
1436         {
1437           ++alias_argv;
1438           abbrev_flag = 1;
1439         }
1440       else if (strcmp (alias_argv[i], "--") == 0)
1441         {
1442           ++alias_argv;
1443           break;
1444         }
1445       else
1446         break;
1447     }
1448
1449   if (alias_argv[0] == NULL || command_argv[0] == NULL
1450       || *alias_argv[0] == '\0' || *command_argv[0] == '\0')
1451     error (_(usage));
1452
1453   for (i = 0; alias_argv[i] != NULL; ++i)
1454     {
1455       if (! valid_user_defined_cmd_name_p (alias_argv[i]))
1456         {
1457           if (i == 0)
1458             error (_("Invalid command name: %s"), alias_argv[i]);
1459           else
1460             error (_("Invalid command element name: %s"), alias_argv[i]);
1461         }
1462     }
1463
1464   alias_argc = countargv (alias_argv);
1465   command_argc = countargv (command_argv);
1466
1467   /* COMMAND must exist.
1468      Reconstruct the command to remove any extraneous spaces,
1469      for better error messages.  */
1470   command_dyn_string = argv_to_dyn_string (command_argv, command_argc);
1471   make_cleanup_dyn_string_delete (command_dyn_string);
1472   command = dyn_string_buf (command_dyn_string);
1473   if (! valid_command_p (command))
1474     error (_("Invalid command to alias to: %s"), command);
1475
1476   /* ALIAS must not exist.  */
1477   alias_dyn_string = argv_to_dyn_string (alias_argv, alias_argc);
1478   make_cleanup_dyn_string_delete (alias_dyn_string);
1479   alias = dyn_string_buf (alias_dyn_string);
1480   if (valid_command_p (alias))
1481     error (_("Alias already exists: %s"), alias);
1482
1483   /* If ALIAS is one word, it is an alias for the entire COMMAND.
1484      Example: alias spe = set print elements
1485
1486      Otherwise ALIAS and COMMAND must have the same number of words,
1487      and every word except the last must match; and the last word of
1488      ALIAS is made an alias of the last word of COMMAND.
1489      Example: alias set print elms = set pr elem
1490      Note that unambiguous abbreviations are allowed.  */
1491
1492   if (alias_argc == 1)
1493     {
1494       /* add_cmd requires *we* allocate space for name, hence the xstrdup.  */
1495       add_com_alias (xstrdup (alias_argv[0]), command, class_alias,
1496                      abbrev_flag);
1497     }
1498   else
1499     {
1500       dyn_string_t alias_prefix_dyn_string, command_prefix_dyn_string;
1501       const char *alias_prefix, *command_prefix;
1502       struct cmd_list_element *c_alias, *c_command;
1503
1504       if (alias_argc != command_argc)
1505         error (_("Mismatched command length between ALIAS and COMMAND."));
1506
1507       /* Create copies of ALIAS and COMMAND without the last word,
1508          and use that to verify the leading elements match.  */
1509       alias_prefix_dyn_string =
1510         argv_to_dyn_string (alias_argv, alias_argc - 1);
1511       make_cleanup_dyn_string_delete (alias_prefix_dyn_string);
1512       command_prefix_dyn_string =
1513         argv_to_dyn_string (alias_argv, command_argc - 1);
1514       make_cleanup_dyn_string_delete (command_prefix_dyn_string);
1515       alias_prefix = dyn_string_buf (alias_prefix_dyn_string);
1516       command_prefix = dyn_string_buf (command_prefix_dyn_string);
1517
1518       c_command = lookup_cmd_1 (& command_prefix, cmdlist, NULL, 1);
1519       /* We've already tried to look up COMMAND.  */
1520       gdb_assert (c_command != NULL
1521                   && c_command != (struct cmd_list_element *) -1);
1522       gdb_assert (c_command->prefixlist != NULL);
1523       c_alias = lookup_cmd_1 (& alias_prefix, cmdlist, NULL, 1);
1524       if (c_alias != c_command)
1525         error (_("ALIAS and COMMAND prefixes do not match."));
1526
1527       /* add_cmd requires *we* allocate space for name, hence the xstrdup.  */
1528       add_alias_cmd (xstrdup (alias_argv[alias_argc - 1]),
1529                      command_argv[command_argc - 1],
1530                      class_alias, abbrev_flag, c_command->prefixlist);
1531     }
1532
1533   do_cleanups (cleanup);
1534 }
1535 \f
1536 /* Print a list of files and line numbers which a user may choose from
1537    in order to list a function which was specified ambiguously (as
1538    with `list classname::overloadedfuncname', for example).  The
1539    vector in SALS provides the filenames and line numbers.  */
1540
1541 static void
1542 ambiguous_line_spec (struct symtabs_and_lines *sals)
1543 {
1544   int i;
1545
1546   for (i = 0; i < sals->nelts; ++i)
1547     printf_filtered (_("file: \"%s\", line number: %d\n"),
1548                      symtab_to_filename_for_display (sals->sals[i].symtab),
1549                      sals->sals[i].line);
1550 }
1551
1552 /* Sort function for filter_sals.  */
1553
1554 static int
1555 compare_symtabs (const void *a, const void *b)
1556 {
1557   const struct symtab_and_line *sala = (const struct symtab_and_line *) a;
1558   const struct symtab_and_line *salb = (const struct symtab_and_line *) b;
1559   const char *dira = SYMTAB_DIRNAME (sala->symtab);
1560   const char *dirb = SYMTAB_DIRNAME (salb->symtab);
1561   int r;
1562
1563   if (dira == NULL)
1564     {
1565       if (dirb != NULL)
1566         return -1;
1567     }
1568   else if (dirb == NULL)
1569     {
1570       if (dira != NULL)
1571         return 1;
1572     }
1573   else
1574     {
1575       r = filename_cmp (dira, dirb);
1576       if (r)
1577         return r;
1578     }
1579
1580   r = filename_cmp (sala->symtab->filename, salb->symtab->filename);
1581   if (r)
1582     return r;
1583
1584   if (sala->line < salb->line)
1585     return -1;
1586   return sala->line == salb->line ? 0 : 1;
1587 }
1588
1589 /* Remove any SALs that do not match the current program space, or
1590    which appear to be "file:line" duplicates.  */
1591
1592 static void
1593 filter_sals (struct symtabs_and_lines *sals)
1594 {
1595   int i, out, prev;
1596
1597   out = 0;
1598   for (i = 0; i < sals->nelts; ++i)
1599     {
1600       if (sals->sals[i].pspace == current_program_space
1601           && sals->sals[i].symtab != NULL)
1602         {
1603           sals->sals[out] = sals->sals[i];
1604           ++out;
1605         }
1606     }
1607   sals->nelts = out;
1608
1609   qsort (sals->sals, sals->nelts, sizeof (struct symtab_and_line),
1610          compare_symtabs);
1611
1612   out = 1;
1613   prev = 0;
1614   for (i = 1; i < sals->nelts; ++i)
1615     {
1616       if (compare_symtabs (&sals->sals[prev], &sals->sals[i]))
1617         {
1618           /* Symtabs differ.  */
1619           sals->sals[out] = sals->sals[i];
1620           prev = out;
1621           ++out;
1622         }
1623     }
1624
1625   if (sals->nelts == 0)
1626     {
1627       xfree (sals->sals);
1628       sals->sals = NULL;
1629     }
1630   else
1631     sals->nelts = out;
1632 }
1633
1634 static void
1635 set_debug (char *arg, int from_tty)
1636 {
1637   printf_unfiltered (_("\"set debug\" must be followed by "
1638                        "the name of a debug subcommand.\n"));
1639   help_list (setdebuglist, "set debug ", all_commands, gdb_stdout);
1640 }
1641
1642 static void
1643 show_debug (char *args, int from_tty)
1644 {
1645   cmd_show_list (showdebuglist, from_tty, "");
1646 }
1647
1648 void
1649 init_cmd_lists (void)
1650 {
1651   max_user_call_depth = 1024;
1652 }
1653
1654 static void
1655 show_info_verbose (struct ui_file *file, int from_tty,
1656                    struct cmd_list_element *c,
1657                    const char *value)
1658 {
1659   if (info_verbose)
1660     fprintf_filtered (file,
1661                       _("Verbose printing of informational messages is %s.\n"),
1662                       value);
1663   else
1664     fprintf_filtered (file, _("Verbosity is %s.\n"), value);
1665 }
1666
1667 static void
1668 show_history_expansion_p (struct ui_file *file, int from_tty,
1669                           struct cmd_list_element *c, const char *value)
1670 {
1671   fprintf_filtered (file, _("History expansion on command input is %s.\n"),
1672                     value);
1673 }
1674
1675 static void
1676 show_remote_debug (struct ui_file *file, int from_tty,
1677                    struct cmd_list_element *c, const char *value)
1678 {
1679   fprintf_filtered (file, _("Debugging of remote protocol is %s.\n"),
1680                     value);
1681 }
1682
1683 static void
1684 show_remote_timeout (struct ui_file *file, int from_tty,
1685                      struct cmd_list_element *c, const char *value)
1686 {
1687   fprintf_filtered (file,
1688                     _("Timeout limit to wait for target to respond is %s.\n"),
1689                     value);
1690 }
1691
1692 static void
1693 show_max_user_call_depth (struct ui_file *file, int from_tty,
1694                           struct cmd_list_element *c, const char *value)
1695 {
1696   fprintf_filtered (file,
1697                     _("The max call depth for user-defined commands is %s.\n"),
1698                     value);
1699 }
1700
1701 \f
1702
1703 initialize_file_ftype _initialize_cli_cmds;
1704
1705 void
1706 _initialize_cli_cmds (void)
1707 {
1708   struct cmd_list_element *c;
1709
1710   /* Define the classes of commands.
1711      They will appear in the help list in alphabetical order.  */
1712
1713   add_cmd ("internals", class_maintenance, NULL, _("\
1714 Maintenance commands.\n\
1715 Some gdb commands are provided just for use by gdb maintainers.\n\
1716 These commands are subject to frequent change, and may not be as\n\
1717 well documented as user commands."),
1718            &cmdlist);
1719   add_cmd ("obscure", class_obscure, NULL, _("Obscure features."), &cmdlist);
1720   add_cmd ("aliases", class_alias, NULL,
1721            _("Aliases of other commands."), &cmdlist);
1722   add_cmd ("user-defined", class_user, NULL, _("\
1723 User-defined commands.\n\
1724 The commands in this class are those defined by the user.\n\
1725 Use the \"define\" command to define a command."), &cmdlist);
1726   add_cmd ("support", class_support, NULL, _("Support facilities."), &cmdlist);
1727   if (!dbx_commands)
1728     add_cmd ("status", class_info, NULL, _("Status inquiries."), &cmdlist);
1729   add_cmd ("files", class_files, NULL, _("Specifying and examining files."),
1730            &cmdlist);
1731   add_cmd ("breakpoints", class_breakpoint, NULL,
1732            _("Making program stop at certain points."), &cmdlist);
1733   add_cmd ("data", class_vars, NULL, _("Examining data."), &cmdlist);
1734   add_cmd ("stack", class_stack, NULL, _("\
1735 Examining the stack.\n\
1736 The stack is made up of stack frames.  Gdb assigns numbers to stack frames\n\
1737 counting from zero for the innermost (currently executing) frame.\n\n\
1738 At any time gdb identifies one frame as the \"selected\" frame.\n\
1739 Variable lookups are done with respect to the selected frame.\n\
1740 When the program being debugged stops, gdb selects the innermost frame.\n\
1741 The commands below can be used to select other frames by number or address."),
1742            &cmdlist);
1743   add_cmd ("running", class_run, NULL, _("Running the program."), &cmdlist);
1744
1745   /* Define general commands.  */
1746
1747   add_com ("pwd", class_files, pwd_command, _("\
1748 Print working directory.  This is used for your program as well."));
1749
1750   c = add_cmd ("cd", class_files, cd_command, _("\
1751 Set working directory to DIR for debugger and program being debugged.\n\
1752 The change does not take effect for the program being debugged\n\
1753 until the next time it is started."), &cmdlist);
1754   set_cmd_completer (c, filename_completer);
1755
1756   add_com ("echo", class_support, echo_command, _("\
1757 Print a constant string.  Give string as argument.\n\
1758 C escape sequences may be used in the argument.\n\
1759 No newline is added at the end of the argument;\n\
1760 use \"\\n\" if you want a newline to be printed.\n\
1761 Since leading and trailing whitespace are ignored in command arguments,\n\
1762 if you want to print some you must use \"\\\" before leading whitespace\n\
1763 to be printed or after trailing whitespace."));
1764
1765   add_setshow_enum_cmd ("script-extension", class_support,
1766                         script_ext_enums, &script_ext_mode, _("\
1767 Set mode for script filename extension recognition."), _("\
1768 Show mode for script filename extension recognition."), _("\
1769 off  == no filename extension recognition (all sourced files are GDB scripts)\n\
1770 soft == evaluate script according to filename extension, fallback to GDB script"
1771   "\n\
1772 strict == evaluate script according to filename extension, error if not supported"
1773   ),
1774                         NULL,
1775                         show_script_ext_mode,
1776                         &setlist, &showlist);
1777
1778   add_com ("quit", class_support, quit_command, _("\
1779 Exit gdb.\n\
1780 Usage: quit [EXPR]\n\
1781 The optional expression EXPR, if present, is evaluated and the result\n\
1782 used as GDB's exit code.  The default is zero."));
1783   c = add_com ("help", class_support, help_command,
1784                _("Print list of commands."));
1785   set_cmd_completer (c, command_completer);
1786   add_com_alias ("q", "quit", class_support, 1);
1787   add_com_alias ("h", "help", class_support, 1);
1788
1789   add_setshow_boolean_cmd ("verbose", class_support, &info_verbose, _("\
1790 Set verbosity."), _("\
1791 Show verbosity."), NULL,
1792                            set_verbose,
1793                            show_info_verbose,
1794                            &setlist, &showlist);
1795
1796   add_prefix_cmd ("history", class_support, set_history,
1797                   _("Generic command for setting command history parameters."),
1798                   &sethistlist, "set history ", 0, &setlist);
1799   add_prefix_cmd ("history", class_support, show_history,
1800                   _("Generic command for showing command history parameters."),
1801                   &showhistlist, "show history ", 0, &showlist);
1802
1803   add_setshow_boolean_cmd ("expansion", no_class, &history_expansion_p, _("\
1804 Set history expansion on command input."), _("\
1805 Show history expansion on command input."), _("\
1806 Without an argument, history expansion is enabled."),
1807                            NULL,
1808                            show_history_expansion_p,
1809                            &sethistlist, &showhistlist);
1810
1811   add_prefix_cmd ("info", class_info, info_command, _("\
1812 Generic command for showing things about the program being debugged."),
1813                   &infolist, "info ", 0, &cmdlist);
1814   add_com_alias ("i", "info", class_info, 1);
1815   add_com_alias ("inf", "info", class_info, 1);
1816
1817   add_com ("complete", class_obscure, complete_command,
1818            _("List the completions for the rest of the line as a command."));
1819
1820   add_prefix_cmd ("show", class_info, show_command, _("\
1821 Generic command for showing things about the debugger."),
1822                   &showlist, "show ", 0, &cmdlist);
1823   /* Another way to get at the same thing.  */
1824   add_info ("set", show_command, _("Show all GDB settings."));
1825
1826   add_cmd ("commands", no_set_class, show_commands, _("\
1827 Show the history of commands you typed.\n\
1828 You can supply a command number to start with, or a `+' to start after\n\
1829 the previous command number shown."),
1830            &showlist);
1831
1832   add_cmd ("version", no_set_class, show_version,
1833            _("Show what version of GDB this is."), &showlist);
1834
1835   add_cmd ("configuration", no_set_class, show_configuration,
1836            _("Show how GDB was configured at build time."), &showlist);
1837
1838   add_setshow_zinteger_cmd ("remote", no_class, &remote_debug, _("\
1839 Set debugging of remote protocol."), _("\
1840 Show debugging of remote protocol."), _("\
1841 When enabled, each packet sent or received with the remote target\n\
1842 is displayed."),
1843                             NULL,
1844                             show_remote_debug,
1845                             &setdebuglist, &showdebuglist);
1846
1847   add_setshow_zuinteger_unlimited_cmd ("remotetimeout", no_class,
1848                                        &remote_timeout, _("\
1849 Set timeout limit to wait for target to respond."), _("\
1850 Show timeout limit to wait for target to respond."), _("\
1851 This value is used to set the time limit for gdb to wait for a response\n\
1852 from the target."),
1853                                        NULL,
1854                                        show_remote_timeout,
1855                                        &setlist, &showlist);
1856
1857   add_prefix_cmd ("debug", no_class, set_debug,
1858                   _("Generic command for setting gdb debugging flags"),
1859                   &setdebuglist, "set debug ", 0, &setlist);
1860
1861   add_prefix_cmd ("debug", no_class, show_debug,
1862                   _("Generic command for showing gdb debugging flags"),
1863                   &showdebuglist, "show debug ", 0, &showlist);
1864
1865   c = add_com ("shell", class_support, shell_escape, _("\
1866 Execute the rest of the line as a shell command.\n\
1867 With no arguments, run an inferior shell."));
1868   set_cmd_completer (c, filename_completer);
1869
1870   c = add_com ("edit", class_files, edit_command, _("\
1871 Edit specified file or function.\n\
1872 With no argument, edits file containing most recent line listed.\n\
1873 Editing targets can be specified in these ways:\n\
1874   FILE:LINENUM, to edit at that line in that file,\n\
1875   FUNCTION, to edit at the beginning of that function,\n\
1876   FILE:FUNCTION, to distinguish among like-named static functions.\n\
1877   *ADDRESS, to edit at the line containing that address.\n\
1878 Uses EDITOR environment variable contents as editor (or ex as default)."));
1879
1880   c->completer = location_completer;
1881
1882   add_com ("list", class_files, list_command, _("\
1883 List specified function or line.\n\
1884 With no argument, lists ten more lines after or around previous listing.\n\
1885 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1886 One argument specifies a line, and ten lines are listed around that line.\n\
1887 Two arguments with comma between specify starting and ending lines to list.\n\
1888 Lines can be specified in these ways:\n\
1889   LINENUM, to list around that line in current file,\n\
1890   FILE:LINENUM, to list around that line in that file,\n\
1891   FUNCTION, to list around beginning of that function,\n\
1892   FILE:FUNCTION, to distinguish among like-named static functions.\n\
1893   *ADDRESS, to list around the line containing that address.\n\
1894 With two args if one is empty it stands for ten lines away from \
1895 the other arg."));
1896
1897   add_com_alias ("l", "list", class_files, 1);
1898
1899   if (dbx_commands)
1900     add_com_alias ("file", "list", class_files, 1);
1901
1902   c = add_com ("disassemble", class_vars, disassemble_command, _("\
1903 Disassemble a specified section of memory.\n\
1904 Default is the function surrounding the pc of the selected frame.\n\
1905 \n\
1906 With a /m modifier, source lines are included (if available).\n\
1907 This view is \"source centric\": the output is in source line order,\n\
1908 regardless of any optimization that is present.  Only the main source file\n\
1909 is displayed, not those of, e.g., any inlined functions.\n\
1910 This modifier hasn't proved useful in practice and is deprecated\n\
1911 in favor of /s.\n\
1912 \n\
1913 With a /s modifier, source lines are included (if available).\n\
1914 This differs from /m in two important respects:\n\
1915 - the output is still in pc address order, and\n\
1916 - file names and contents for all relevant source files are displayed.\n\
1917 \n\
1918 With a /r modifier, raw instructions in hex are included.\n\
1919 \n\
1920 With a single argument, the function surrounding that address is dumped.\n\
1921 Two arguments (separated by a comma) are taken as a range of memory to dump,\n\
1922   in the form of \"start,end\", or \"start,+length\".\n\
1923 \n\
1924 Note that the address is interpreted as an expression, not as a location\n\
1925 like in the \"break\" command.\n\
1926 So, for example, if you want to disassemble function bar in file foo.c\n\
1927 you must type \"disassemble 'foo.c'::bar\" and not \"disassemble foo.c:bar\"."));
1928   set_cmd_completer (c, location_completer);
1929
1930   add_com_alias ("!", "shell", class_support, 0);
1931
1932   c = add_com ("make", class_support, make_command, _("\
1933 Run the ``make'' program using the rest of the line as arguments."));
1934   set_cmd_completer (c, filename_completer);
1935   add_cmd ("user", no_class, show_user, _("\
1936 Show definitions of non-python/scheme user defined commands.\n\
1937 Argument is the name of the user defined command.\n\
1938 With no argument, show definitions of all user defined commands."), &showlist);
1939   add_com ("apropos", class_support, apropos_command,
1940            _("Search for commands matching a REGEXP"));
1941
1942   add_setshow_uinteger_cmd ("max-user-call-depth", no_class,
1943                            &max_user_call_depth, _("\
1944 Set the max call depth for non-python/scheme user-defined commands."), _("\
1945 Show the max call depth for non-python/scheme user-defined commands."), NULL,
1946                             NULL,
1947                             show_max_user_call_depth,
1948                             &setlist, &showlist);
1949
1950   add_setshow_boolean_cmd ("trace-commands", no_class, &trace_commands, _("\
1951 Set tracing of GDB CLI commands."), _("\
1952 Show state of GDB CLI command tracing."), _("\
1953 When 'on', each command is displayed as it is executed."),
1954                            NULL,
1955                            NULL,
1956                            &setlist, &showlist);
1957
1958   c = add_com ("alias", class_support, alias_command, _("\
1959 Define a new command that is an alias of an existing command.\n\
1960 Usage: alias [-a] [--] ALIAS = COMMAND\n\
1961 ALIAS is the name of the alias command to create.\n\
1962 COMMAND is the command being aliased to.\n\
1963 If \"-a\" is specified, the command is an abbreviation,\n\
1964 and will not appear in help command list output.\n\
1965 \n\
1966 Examples:\n\
1967 Make \"spe\" an alias of \"set print elements\":\n\
1968   alias spe = set print elements\n\
1969 Make \"elms\" an alias of \"elements\" in the \"set print\" command:\n\
1970   alias -a set print elms = set print elements"));
1971 }
1972
1973 void
1974 init_cli_cmds (void)
1975 {
1976   struct cmd_list_element *c;
1977   char *source_help_text;
1978
1979   source_help_text = xstrprintf (_("\
1980 Read commands from a file named FILE.\n\
1981 \n\
1982 Usage: source [-s] [-v] FILE\n\
1983 -s: search for the script in the source search path,\n\
1984     even if FILE contains directories.\n\
1985 -v: each command in FILE is echoed as it is executed.\n\
1986 \n\
1987 Note that the file \"%s\" is read automatically in this way\n\
1988 when GDB is started."), gdbinit);
1989   c = add_cmd ("source", class_support, source_command,
1990                source_help_text, &cmdlist);
1991   set_cmd_completer (c, filename_completer);
1992 }