* cli/cli-cmds.c (edit_command): Remove unused variables. Delete
[platform/upstream/binutils.git] / gdb / cli / cli-cmds.c
1 /* GDB CLI commands.
2
3    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008
4    Free Software Foundation, Inc.
5
6    This file is part of GDB.
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
20
21 #include "defs.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_string.h"
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
40 #include "ui-out.h"
41
42 #include "top.h"
43 #include "cli/cli-decode.h"
44 #include "cli/cli-script.h"
45 #include "cli/cli-setshow.h"
46 #include "cli/cli-cmds.h"
47
48 #ifdef TUI
49 #include "tui/tui.h"            /* For tui_active et.al.   */
50 #endif
51
52 #include <fcntl.h>
53
54 /* Prototypes for local command functions */
55
56 static void complete_command (char *, int);
57
58 static void echo_command (char *, int);
59
60 static void pwd_command (char *, int);
61
62 static void show_version (char *, int);
63
64 static void help_command (char *, int);
65
66 static void show_command (char *, int);
67
68 static void info_command (char *, int);
69
70 static void show_debug (char *, int);
71
72 static void set_debug (char *, int);
73
74 static void show_user (char *, int);
75
76 static void make_command (char *, int);
77
78 static void shell_escape (char *, int);
79
80 static void edit_command (char *, int);
81
82 static void list_command (char *, int);
83
84 void apropos_command (char *, int);
85
86 /* Prototypes for local utility functions */
87
88 static void ambiguous_line_spec (struct symtabs_and_lines *);
89 \f
90 /* Limit the call depth of user-defined commands */
91 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 toggle subcommands. */
112
113 struct cmd_list_element *togglelist;
114
115 /* Chain containing all defined stop subcommands. */
116
117 struct cmd_list_element *stoplist;
118
119 /* Chain containing all defined delete subcommands. */
120
121 struct cmd_list_element *deletelist;
122
123 /* Chain containing all defined detach subcommands. */
124
125 struct cmd_list_element *detachlist;
126
127 /* Chain containing all defined "enable breakpoint" subcommands. */
128
129 struct cmd_list_element *enablebreaklist;
130
131 /* Chain containing all defined set subcommands */
132
133 struct cmd_list_element *setlist;
134
135 /* Chain containing all defined unset subcommands */
136
137 struct cmd_list_element *unsetlist;
138
139 /* Chain containing all defined show subcommands.  */
140
141 struct cmd_list_element *showlist;
142
143 /* Chain containing all defined \"set history\".  */
144
145 struct cmd_list_element *sethistlist;
146
147 /* Chain containing all defined \"show history\".  */
148
149 struct cmd_list_element *showhistlist;
150
151 /* Chain containing all defined \"unset history\".  */
152
153 struct cmd_list_element *unsethistlist;
154
155 /* Chain containing all defined maintenance subcommands. */
156
157 struct cmd_list_element *maintenancelist;
158
159 /* Chain containing all defined "maintenance info" subcommands. */
160
161 struct cmd_list_element *maintenanceinfolist;
162
163 /* Chain containing all defined "maintenance print" subcommands. */
164
165 struct cmd_list_element *maintenanceprintlist;
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 /* Utility used everywhere when at least one argument is needed and
185    none is supplied. */
186
187 void
188 error_no_arg (char *why)
189 {
190   error (_("Argument required (%s)."), why);
191 }
192
193 /* The "info" command is defined as a prefix, with allow_unknown = 0.
194    Therefore, its own definition is called only for "info" with no args.  */
195
196 static void
197 info_command (char *arg, int from_tty)
198 {
199   printf_unfiltered (_("\"info\" must be followed by the name of an info command.\n"));
200   help_list (infolist, "info ", -1, gdb_stdout);
201 }
202
203 /* The "show" command with no arguments shows all the settings.  */
204
205 static void
206 show_command (char *arg, int from_tty)
207 {
208   cmd_show_list (showlist, from_tty, "");
209 }
210 \f
211 /* Provide documentation on command or list given by COMMAND.  FROM_TTY
212    is ignored.  */
213
214 static void
215 help_command (char *command, int from_tty)
216 {
217   help_cmd (command, gdb_stdout);
218 }
219 \f
220 /* String compare function for qsort.  */
221 static int
222 compare_strings (const void *arg1, const void *arg2)
223 {
224   const char **s1 = (const char **) arg1;
225   const char **s2 = (const char **) arg2;
226   return strcmp (*s1, *s2);
227 }
228
229 /* The "complete" command is used by Emacs to implement completion.  */
230
231 static void
232 complete_command (char *arg, int from_tty)
233 {
234   int i;
235   int argpoint;
236   char **completions, *point, *arg_prefix;
237
238   dont_repeat ();
239
240   if (arg == NULL)
241     arg = "";
242   argpoint = strlen (arg);
243
244   /* complete_line assumes that its first argument is somewhere within,
245      and except for filenames at the beginning of, the word to be completed.
246      The following crude imitation of readline's word-breaking tries to
247      accomodate this.  */
248   point = arg + argpoint;
249   while (point > arg)
250     {
251       if (strchr (rl_completer_word_break_characters, point[-1]) != 0)
252         break;
253       point--;
254     }
255
256   arg_prefix = alloca (point - arg + 1);
257   memcpy (arg_prefix, arg, point - arg);
258   arg_prefix[point - arg] = 0;
259
260   completions = complete_line (point, arg, argpoint);
261
262   if (completions)
263     {
264       int item, size;
265
266       for (size = 0; completions[size]; ++size)
267         ;
268       qsort (completions, size, sizeof (char *), compare_strings);
269
270       /* We do extra processing here since we only want to print each
271          unique item once.  */
272       item = 0;
273       while (item < size)
274         {
275           int next_item;
276           printf_unfiltered ("%s%s\n", arg_prefix, completions[item]);
277           next_item = item + 1;
278           while (next_item < size
279                  && ! strcmp (completions[item], completions[next_item]))
280             {
281               xfree (completions[next_item]);
282               ++next_item;
283             }
284
285           xfree (completions[item]);
286           item = next_item;
287         }
288
289       xfree (completions);
290     }
291 }
292
293 int
294 is_complete_command (struct cmd_list_element *c)
295 {
296   return cmd_cfunc_eq (c, complete_command);
297 }
298
299 static void
300 show_version (char *args, int from_tty)
301 {
302   immediate_quit++;
303   print_gdb_version (gdb_stdout);
304   printf_filtered ("\n");
305   immediate_quit--;
306 }
307
308 /* Handle the quit command.  */
309
310 void
311 quit_command (char *args, int from_tty)
312 {
313   if (!quit_confirm ())
314     error (_("Not confirmed."));
315   quit_force (args, from_tty);
316 }
317
318 static void
319 pwd_command (char *args, int from_tty)
320 {
321   if (args)
322     error (_("The \"pwd\" command does not take an argument: %s"), args);
323   getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
324
325   if (strcmp (gdb_dirbuf, current_directory) != 0)
326     printf_unfiltered (_("Working directory %s\n (canonically %s).\n"),
327                        current_directory, gdb_dirbuf);
328   else
329     printf_unfiltered (_("Working directory %s.\n"), current_directory);
330 }
331
332 void
333 cd_command (char *dir, int from_tty)
334 {
335   int len;
336   /* Found something other than leading repetitions of "/..".  */
337   int found_real_path;
338   char *p;
339
340   /* If the new directory is absolute, repeat is a no-op; if relative,
341      repeat might be useful but is more likely to be a mistake.  */
342   dont_repeat ();
343
344   if (dir == 0)
345     error_no_arg (_("new working directory"));
346
347   dir = tilde_expand (dir);
348   make_cleanup (xfree, dir);
349
350   if (chdir (dir) < 0)
351     perror_with_name (dir);
352
353 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
354   /* There's too much mess with DOSish names like "d:", "d:.",
355      "d:./foo" etc.  Instead of having lots of special #ifdef'ed code,
356      simply get the canonicalized name of the current directory.  */
357   dir = getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
358 #endif
359
360   len = strlen (dir);
361   if (IS_DIR_SEPARATOR (dir[len - 1]))
362     {
363       /* Remove the trailing slash unless this is a root directory
364          (including a drive letter on non-Unix systems).  */
365       if (!(len == 1)           /* "/" */
366 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
367           && !(len == 3 && dir[1] == ':') /* "d:/" */
368 #endif
369           )
370         len--;
371     }
372
373   dir = savestring (dir, len);
374   if (IS_ABSOLUTE_PATH (dir))
375     current_directory = dir;
376   else
377     {
378       if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
379         current_directory = concat (current_directory, dir, (char *)NULL);
380       else
381         current_directory = concat (current_directory, SLASH_STRING,
382                                     dir, (char *)NULL);
383       xfree (dir);
384     }
385
386   /* Now simplify any occurrences of `.' and `..' in the pathname.  */
387
388   found_real_path = 0;
389   for (p = current_directory; *p;)
390     {
391       if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
392           && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
393         strcpy (p, p + 2);
394       else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
395                && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
396         {
397           if (found_real_path)
398             {
399               /* Search backwards for the directory just before the "/.."
400                  and obliterate it and the "/..".  */
401               char *q = p;
402               while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
403                 --q;
404
405               if (q == current_directory)
406                 /* current_directory is
407                    a relative pathname ("can't happen"--leave it alone).  */
408                 ++p;
409               else
410                 {
411                   strcpy (q - 1, p + 3);
412                   p = q - 1;
413                 }
414             }
415           else
416             /* We are dealing with leading repetitions of "/..", for example
417                "/../..", which is the Mach super-root.  */
418             p += 3;
419         }
420       else
421         {
422           found_real_path = 1;
423           ++p;
424         }
425     }
426
427   forget_cached_source_info ();
428
429   if (from_tty)
430     pwd_command ((char *) 0, 1);
431 }
432 \f
433 void
434 source_script (char *file, int from_tty)
435 {
436   FILE *stream;
437   struct cleanup *old_cleanups;
438   char *full_pathname = NULL;
439   int fd;
440
441   if (file == NULL || *file == 0)
442     {
443       error (_("source command requires file name of file to source."));
444     }
445
446   file = tilde_expand (file);
447   old_cleanups = make_cleanup (xfree, file);
448
449   /* Search for and open 'file' on the search path used for source
450      files.  Put the full location in 'full_pathname'.  */
451   fd = openp (source_path, OPF_TRY_CWD_FIRST,
452               file, O_RDONLY, 0, &full_pathname);
453
454   /* Use the full path name, if it is found.  */
455   if (full_pathname != NULL && fd != -1)
456     {
457       file = full_pathname;
458     }
459
460   if (fd == -1)
461     {
462       if (from_tty)
463         perror_with_name (file);
464       else
465         return;
466     }
467
468   stream = fdopen (fd, FOPEN_RT);
469   script_from_file (stream, file);
470
471   do_cleanups (old_cleanups);
472 }
473
474 /* Return the source_verbose global variable to its previous state
475    on exit from the source command, by whatever means.  */
476 static void
477 source_verbose_cleanup (void *old_value)
478 {
479   source_verbose = *(int *)old_value;
480   xfree (old_value);
481 }
482
483 static void
484 source_command (char *args, int from_tty)
485 {
486   struct cleanup *old_cleanups;
487   char *file = args;
488   int *old_source_verbose = xmalloc (sizeof(int));
489
490   *old_source_verbose = source_verbose;
491   old_cleanups = make_cleanup (source_verbose_cleanup, old_source_verbose);
492
493   /* -v causes the source command to run in verbose mode.
494      We still have to be able to handle filenames with spaces in a
495      backward compatible way, so buildargv is not appropriate.  */
496
497   if (args)
498     {
499       /* Make sure leading white space does not break the comparisons.  */
500       while (isspace(args[0]))
501         args++;
502
503       /* Is -v the first thing in the string?  */
504       if (args[0] == '-' && args[1] == 'v' && isspace (args[2]))
505         {
506           source_verbose = 1;
507
508           /* Trim -v and whitespace from the filename.  */
509           file = &args[3];
510           while (isspace (file[0]))
511             file++;
512         }
513     }
514
515   source_script (file, from_tty);
516 }
517
518
519 static void
520 echo_command (char *text, int from_tty)
521 {
522   char *p = text;
523   int c;
524
525   if (text)
526     while ((c = *p++) != '\0')
527       {
528         if (c == '\\')
529           {
530             /* \ at end of argument is used after spaces
531                so they won't be lost.  */
532             if (*p == 0)
533               return;
534
535             c = parse_escape (&p);
536             if (c >= 0)
537               printf_filtered ("%c", c);
538           }
539         else
540           printf_filtered ("%c", c);
541       }
542
543   /* Force this output to appear now.  */
544   wrap_here ("");
545   gdb_flush (gdb_stdout);
546 }
547
548 static void
549 shell_escape (char *arg, int from_tty)
550 {
551 #if defined(CANT_FORK) || \
552       (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
553   /* If ARG is NULL, they want an inferior shell, but `system' just
554      reports if the shell is available when passed a NULL arg.  */
555   int rc = system (arg ? arg : "");
556
557   if (!arg)
558     arg = "inferior shell";
559
560   if (rc == -1)
561     {
562       fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
563                           safe_strerror (errno));
564       gdb_flush (gdb_stderr);
565     }
566   else if (rc)
567     {
568       fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
569       gdb_flush (gdb_stderr);
570     }
571 #ifdef GLOBAL_CURDIR
572   /* Make sure to return to the directory GDB thinks it is, in case the
573      shell command we just ran changed it.  */
574   chdir (current_directory);
575 #endif
576 #else /* Can fork.  */
577   int rc, status, pid;
578
579   if ((pid = vfork ()) == 0)
580     {
581       char *p, *user_shell;
582
583       if ((user_shell = (char *) getenv ("SHELL")) == NULL)
584         user_shell = "/bin/sh";
585
586       /* Get the name of the shell for arg0 */
587       if ((p = strrchr (user_shell, '/')) == NULL)
588         p = user_shell;
589       else
590         p++;                    /* Get past '/' */
591
592       if (!arg)
593         execl (user_shell, p, (char *) 0);
594       else
595         execl (user_shell, p, "-c", arg, (char *) 0);
596
597       fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
598                           safe_strerror (errno));
599       gdb_flush (gdb_stderr);
600       _exit (0177);
601     }
602
603   if (pid != -1)
604     while ((rc = wait (&status)) != pid && rc != -1)
605       ;
606   else
607     error (_("Fork failed"));
608 #endif /* Can fork.  */
609 }
610
611 static void
612 edit_command (char *arg, int from_tty)
613 {
614   struct symtabs_and_lines sals;
615   struct symtab_and_line sal;
616   struct symbol *sym;
617   char *arg1;
618   char *editor;
619   char *p, *fn;
620
621   /* Pull in the current default source line if necessary.  */
622   if (arg == 0)
623     {
624       set_default_source_symtab_and_line ();
625       sal = get_current_source_symtab_and_line ();
626     }
627
628   /* bare "edit" edits file with present line.  */
629
630   if (arg == 0)
631     {
632       if (sal.symtab == 0)
633         error (_("No default source file yet."));
634       sal.line += get_lines_to_list () / 2;
635     }
636   else
637     {
638
639       /* Now should only be one argument -- decode it in SAL.  */
640
641       arg1 = arg;
642       sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
643
644       if (! sals.nelts)
645         {
646           /*  C++  */
647           return;
648         }
649       if (sals.nelts > 1)
650         {
651           ambiguous_line_spec (&sals);
652           xfree (sals.sals);
653           return;
654         }
655
656       sal = sals.sals[0];
657       xfree (sals.sals);
658
659       if (*arg1)
660         error (_("Junk at end of line specification."));
661
662       /* If line was specified by address,
663          first print exactly which line, and which file.
664          In this case, sal.symtab == 0 means address is outside
665          of all known source files, not that user failed to give a filename.  */
666       if (*arg == '*')
667         {
668           if (sal.symtab == 0)
669             /* FIXME-32x64--assumes sal.pc fits in long.  */
670             error (_("No source file for address %s."),
671                    hex_string ((unsigned long) sal.pc));
672           sym = find_pc_function (sal.pc);
673           if (sym)
674             printf_filtered ("%s is in %s (%s:%d).\n", paddress (sal.pc),
675                              SYMBOL_PRINT_NAME (sym), sal.symtab->filename,
676                              sal.line);
677           else
678             printf_filtered ("%s is at %s:%d.\n", paddress (sal.pc),
679                              sal.symtab->filename, sal.line);
680         }
681
682       /* If what was given does not imply a symtab, it must be an undebuggable
683          symbol which means no source code.  */
684
685       if (sal.symtab == 0)
686         error (_("No line number known for %s."), arg);
687     }
688
689   if ((editor = (char *) getenv ("EDITOR")) == NULL)
690       editor = "/bin/ex";
691
692   /* If we don't already know the full absolute file name of the
693      source file, find it now.  */
694   if (!sal.symtab->fullname)
695     {
696       fn = symtab_to_fullname (sal.symtab);
697       if (!fn)
698         fn = "unknown";
699     }
700   else
701     fn = sal.symtab->fullname;
702
703   /* Quote the file name, in case it has whitespace or other special
704      characters.  */
705   p = xstrprintf ("%s +%d \"%s\"", editor, sal.line, fn);
706   shell_escape (p, from_tty);
707   xfree (p);
708 }
709
710 static void
711 list_command (char *arg, int from_tty)
712 {
713   struct symtabs_and_lines sals, sals_end;
714   struct symtab_and_line sal = { 0 };
715   struct symtab_and_line sal_end = { 0 };
716   struct symtab_and_line cursal = { 0 };
717   struct symbol *sym;
718   char *arg1;
719   int no_end = 1;
720   int dummy_end = 0;
721   int dummy_beg = 0;
722   int linenum_beg = 0;
723   char *p;
724
725   /* Pull in the current default source line if necessary */
726   if (arg == 0 || arg[0] == '+' || arg[0] == '-')
727     {
728       set_default_source_symtab_and_line ();
729       cursal = get_current_source_symtab_and_line ();
730     }
731
732   /* "l" or "l +" lists next ten lines.  */
733
734   if (arg == 0 || strcmp (arg, "+") == 0)
735     {
736       print_source_lines (cursal.symtab, cursal.line,
737                           cursal.line + get_lines_to_list (), 0);
738       return;
739     }
740
741   /* "l -" lists previous ten lines, the ones before the ten just listed.  */
742   if (strcmp (arg, "-") == 0)
743     {
744       print_source_lines (cursal.symtab,
745                           max (get_first_line_listed () - get_lines_to_list (), 1),
746                           get_first_line_listed (), 0);
747       return;
748     }
749
750   /* Now if there is only one argument, decode it in SAL
751      and set NO_END.
752      If there are two arguments, decode them in SAL and SAL_END
753      and clear NO_END; however, if one of the arguments is blank,
754      set DUMMY_BEG or DUMMY_END to record that fact.  */
755
756   if (!have_full_symbols () && !have_partial_symbols ())
757     error (_("No symbol table is loaded.  Use the \"file\" command."));
758
759   arg1 = arg;
760   if (*arg1 == ',')
761     dummy_beg = 1;
762   else
763     {
764       sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
765
766       if (!sals.nelts)
767         return;                 /*  C++  */
768       if (sals.nelts > 1)
769         {
770           ambiguous_line_spec (&sals);
771           xfree (sals.sals);
772           return;
773         }
774
775       sal = sals.sals[0];
776       xfree (sals.sals);
777     }
778
779   /* Record whether the BEG arg is all digits.  */
780
781   for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
782   linenum_beg = (p == arg1);
783
784   while (*arg1 == ' ' || *arg1 == '\t')
785     arg1++;
786   if (*arg1 == ',')
787     {
788       no_end = 0;
789       arg1++;
790       while (*arg1 == ' ' || *arg1 == '\t')
791         arg1++;
792       if (*arg1 == 0)
793         dummy_end = 1;
794       else
795         {
796           if (dummy_beg)
797             sals_end = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
798           else
799             sals_end = decode_line_1 (&arg1, 0, sal.symtab, sal.line, 0, 0);
800           if (sals_end.nelts == 0)
801             return;
802           if (sals_end.nelts > 1)
803             {
804               ambiguous_line_spec (&sals_end);
805               xfree (sals_end.sals);
806               return;
807             }
808           sal_end = sals_end.sals[0];
809           xfree (sals_end.sals);
810         }
811     }
812
813   if (*arg1)
814     error (_("Junk at end of line specification."));
815
816   if (!no_end && !dummy_beg && !dummy_end
817       && sal.symtab != sal_end.symtab)
818     error (_("Specified start and end are in different files."));
819   if (dummy_beg && dummy_end)
820     error (_("Two empty args do not say what lines to list."));
821
822   /* if line was specified by address,
823      first print exactly which line, and which file.
824      In this case, sal.symtab == 0 means address is outside
825      of all known source files, not that user failed to give a filename.  */
826   if (*arg == '*')
827     {
828       if (sal.symtab == 0)
829         /* FIXME-32x64--assumes sal.pc fits in long.  */
830         error (_("No source file for address %s."),
831                hex_string ((unsigned long) sal.pc));
832       sym = find_pc_function (sal.pc);
833       if (sym)
834         printf_filtered ("%s is in %s (%s:%d).\n",
835                          paddress (sal.pc), SYMBOL_PRINT_NAME (sym),
836                          sal.symtab->filename, sal.line);
837       else
838         printf_filtered ("%s is at %s:%d.\n", paddress (sal.pc),
839                          sal.symtab->filename, sal.line);
840     }
841
842   /* If line was not specified by just a line number,
843      and it does not imply a symtab, it must be an undebuggable symbol
844      which means no source code.  */
845
846   if (!linenum_beg && sal.symtab == 0)
847     error (_("No line number known for %s."), arg);
848
849   /* If this command is repeated with RET,
850      turn it into the no-arg variant.  */
851
852   if (from_tty)
853     *arg = 0;
854
855   if (dummy_beg && sal_end.symtab == 0)
856     error (_("No default source file yet.  Do \"help list\"."));
857   if (dummy_beg)
858     print_source_lines (sal_end.symtab,
859                         max (sal_end.line - (get_lines_to_list () - 1), 1),
860                         sal_end.line + 1, 0);
861   else if (sal.symtab == 0)
862     error (_("No default source file yet.  Do \"help list\"."));
863   else if (no_end)
864     {
865       int first_line = sal.line - get_lines_to_list () / 2;
866
867       if (first_line < 1) first_line = 1;
868
869       print_source_lines (sal.symtab,
870                           first_line,
871                           first_line + get_lines_to_list (),
872                           0);
873     }
874   else
875     print_source_lines (sal.symtab, sal.line,
876                         (dummy_end
877                          ? sal.line + get_lines_to_list ()
878                          : sal_end.line + 1),
879                         0);
880 }
881
882 /* Subroutine of disassemble_command to simplify it.
883    Perform the disassembly.
884    NAME is the name of the function if known, or NULL.
885    [LOW,HIGH) are the range of addresses to disassemble.
886    MIXED is non-zero to print source with the assembler.  */
887
888 static void
889 print_disassembly (const char *name, CORE_ADDR low, CORE_ADDR high, int mixed)
890 {
891 #if defined(TUI)
892   if (!tui_is_window_visible (DISASSEM_WIN))
893 #endif
894     {
895       printf_filtered ("Dump of assembler code ");
896       if (name != NULL)
897         printf_filtered ("for function %s:\n", name);
898       else
899         printf_filtered ("from %s to %s:\n", paddress (low), paddress (high));
900
901       /* Dump the specified range.  */
902       gdb_disassembly (uiout, 0, 0, mixed, -1, low, high);
903
904       printf_filtered ("End of assembler dump.\n");
905       gdb_flush (gdb_stdout);
906     }
907 #if defined(TUI)
908   else
909     {
910       tui_show_assembly (low);
911     }
912 #endif
913 }
914
915 /* Subroutine of disassemble_command to simplify it.
916    Print a disassembly of the current function.
917    MIXED is non-zero to print source with the assembler.  */
918
919 static void
920 disassemble_current_function (int mixed)
921 {
922   CORE_ADDR low, high, pc;
923   char *name;
924
925   pc = get_frame_pc (get_selected_frame (_("No frame selected.")));
926   if (find_pc_partial_function (pc, &name, &low, &high) == 0)
927     error (_("No function contains program counter for selected frame."));
928 #if defined(TUI)
929   /* NOTE: cagney/2003-02-13 The `tui_active' was previously
930      `tui_version'.  */
931   if (tui_active)
932     /* FIXME: cagney/2004-02-07: This should be an observer.  */
933     low = tui_get_low_disassembly_address (low, pc);
934 #endif
935   low += gdbarch_deprecated_function_start_offset (current_gdbarch);
936
937   print_disassembly (name, low, high, mixed);
938 }
939
940 /* Dump a specified section of assembly code.
941
942    Usage:
943      disassemble [/m]
944        - dump the assembly code for the function of the current pc
945      disassemble [/m] addr
946        - dump the assembly code for the function at ADDR
947      disassemble [/m] low high
948        - dump the assembly code in the range [LOW,HIGH)
949
950    A /m modifier will include source code with the assembly.  */
951
952 static void
953 disassemble_command (char *arg, int from_tty)
954 {
955   CORE_ADDR low, high;
956   char *name;
957   CORE_ADDR pc, pc_masked;
958   char *space_index;
959   int mixed_source_and_assembly;
960
961   name = NULL;
962   mixed_source_and_assembly = 0;
963
964   if (arg && *arg == '/')
965     {
966       ++arg;
967
968       if (*arg == '\0')
969         error (_("Missing modifier."));
970
971       while (*arg && ! isspace (*arg))
972         {
973           switch (*arg++)
974             {
975             case 'm':
976               mixed_source_and_assembly = 1;
977               break;
978             default:
979               error (_("Invalid disassembly modifier."));
980             }
981         }
982
983       while (isspace (*arg))
984         ++arg;
985     }
986
987   if (! arg || ! *arg)
988     {
989       disassemble_current_function (mixed_source_and_assembly);
990       return;
991     }
992
993   /* FIXME: 'twould be nice to allow spaces in the expression for the first
994      arg.  Allow comma separater too?  */
995
996   if (!(space_index = (char *) strchr (arg, ' ')))
997     {
998       /* One argument.  */
999       pc = parse_and_eval_address (arg);
1000       if (find_pc_partial_function (pc, &name, &low, &high) == 0)
1001         error (_("No function contains specified address."));
1002 #if defined(TUI)
1003       /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1004          `tui_version'.  */
1005       if (tui_active)
1006         /* FIXME: cagney/2004-02-07: This should be an observer.  */
1007         low = tui_get_low_disassembly_address (low, pc);
1008 #endif
1009       low += gdbarch_deprecated_function_start_offset (current_gdbarch);
1010     }
1011   else
1012     {
1013       /* Two arguments.  */
1014       *space_index = '\0';
1015       low = parse_and_eval_address (arg);
1016       high = parse_and_eval_address (space_index + 1);
1017     }
1018
1019   print_disassembly (name, low, high, mixed_source_and_assembly);
1020 }
1021
1022 static void
1023 make_command (char *arg, int from_tty)
1024 {
1025   char *p;
1026
1027   if (arg == 0)
1028     p = "make";
1029   else
1030     {
1031       p = xmalloc (sizeof ("make ") + strlen (arg));
1032       strcpy (p, "make ");
1033       strcpy (p + sizeof ("make ") - 1, arg);
1034     }
1035
1036   shell_escape (p, from_tty);
1037 }
1038
1039 static void
1040 show_user (char *args, int from_tty)
1041 {
1042   struct cmd_list_element *c;
1043   extern struct cmd_list_element *cmdlist;
1044
1045   if (args)
1046     {
1047       c = lookup_cmd (&args, cmdlist, "", 0, 1);
1048       if (c->class != class_user)
1049         error (_("Not a user command."));
1050       show_user_1 (c, gdb_stdout);
1051     }
1052   else
1053     {
1054       for (c = cmdlist; c; c = c->next)
1055         {
1056           if (c->class == class_user)
1057             show_user_1 (c, gdb_stdout);
1058         }
1059     }
1060 }
1061
1062 /* Search through names of commands and documentations for a certain
1063    regular expression.
1064 */
1065 void 
1066 apropos_command (char *searchstr, int from_tty)
1067 {
1068   extern struct cmd_list_element *cmdlist; /*This is the main command list*/
1069   regex_t pattern;
1070   char *pattern_fastmap;
1071   char errorbuffer[512];
1072   pattern_fastmap = xcalloc (256, sizeof (char));
1073   if (searchstr == NULL)
1074       error (_("REGEXP string is empty"));
1075
1076   if (regcomp(&pattern,searchstr,REG_ICASE) == 0)
1077     {
1078       pattern.fastmap=pattern_fastmap;
1079       re_compile_fastmap(&pattern);
1080       apropos_cmd (gdb_stdout,cmdlist,&pattern,"");
1081     }
1082   else
1083     {
1084       regerror(regcomp(&pattern,searchstr,REG_ICASE),NULL,errorbuffer,512);
1085       error (_("Error in regular expression:%s"),errorbuffer);
1086     }
1087   xfree (pattern_fastmap);
1088 }
1089 \f
1090 /* Print a list of files and line numbers which a user may choose from
1091    in order to list a function which was specified ambiguously (as with
1092    `list classname::overloadedfuncname', for example).  The vector in
1093    SALS provides the filenames and line numbers.  */
1094
1095 static void
1096 ambiguous_line_spec (struct symtabs_and_lines *sals)
1097 {
1098   int i;
1099
1100   for (i = 0; i < sals->nelts; ++i)
1101     printf_filtered (_("file: \"%s\", line number: %d\n"),
1102                      sals->sals[i].symtab->filename, sals->sals[i].line);
1103 }
1104
1105 static void
1106 set_debug (char *arg, int from_tty)
1107 {
1108   printf_unfiltered (_("\"set debug\" must be followed by the name of a print subcommand.\n"));
1109   help_list (setdebuglist, "set debug ", -1, gdb_stdout);
1110 }
1111
1112 static void
1113 show_debug (char *args, int from_tty)
1114 {
1115   cmd_show_list (showdebuglist, from_tty, "");
1116 }
1117
1118 void
1119 init_cmd_lists (void)
1120 {
1121   max_user_call_depth = 1024;
1122
1123   cmdlist = NULL;
1124   infolist = NULL;
1125   enablelist = NULL;
1126   disablelist = NULL;
1127   togglelist = NULL;
1128   stoplist = NULL;
1129   deletelist = NULL;
1130   detachlist = NULL;
1131   enablebreaklist = NULL;
1132   setlist = NULL;
1133   unsetlist = NULL;
1134   showlist = NULL;
1135   sethistlist = NULL;
1136   showhistlist = NULL;
1137   unsethistlist = NULL;
1138   maintenancelist = NULL;
1139   maintenanceinfolist = NULL;
1140   maintenanceprintlist = NULL;
1141   setprintlist = NULL;
1142   showprintlist = NULL;
1143   setchecklist = NULL;
1144   showchecklist = NULL;
1145 }
1146
1147 static void
1148 show_info_verbose (struct ui_file *file, int from_tty,
1149                    struct cmd_list_element *c,
1150                    const char *value)
1151 {
1152   if (info_verbose)
1153     fprintf_filtered (file, _("\
1154 Verbose printing of informational messages is %s.\n"), value);
1155   else
1156     fprintf_filtered (file, _("Verbosity is %s.\n"), value);
1157 }
1158
1159 static void
1160 show_history_expansion_p (struct ui_file *file, int from_tty,
1161                           struct cmd_list_element *c, const char *value)
1162 {
1163   fprintf_filtered (file, _("History expansion on command input is %s.\n"),
1164                     value);
1165 }
1166
1167 static void
1168 show_baud_rate (struct ui_file *file, int from_tty,
1169                 struct cmd_list_element *c, const char *value)
1170 {
1171   fprintf_filtered (file, _("Baud rate for remote serial I/O is %s.\n"),
1172                     value);
1173 }
1174
1175 static void
1176 show_remote_debug (struct ui_file *file, int from_tty,
1177                    struct cmd_list_element *c, const char *value)
1178 {
1179   fprintf_filtered (file, _("Debugging of remote protocol is %s.\n"),
1180                     value);
1181 }
1182
1183 static void
1184 show_remote_timeout (struct ui_file *file, int from_tty,
1185                      struct cmd_list_element *c, const char *value)
1186 {
1187   fprintf_filtered (file, _("\
1188 Timeout limit to wait for target to respond is %s.\n"),
1189                     value);
1190 }
1191
1192 static void
1193 show_max_user_call_depth (struct ui_file *file, int from_tty,
1194                           struct cmd_list_element *c, const char *value)
1195 {
1196   fprintf_filtered (file, _("\
1197 The max call depth for user-defined commands is %s.\n"),
1198                     value);
1199 }
1200
1201 \f
1202 void
1203 init_cli_cmds (void)
1204 {
1205   struct cmd_list_element *c;
1206   char *source_help_text;
1207
1208   /* Define the classes of commands.
1209      They will appear in the help list in the reverse of this order.  */
1210
1211   add_cmd ("internals", class_maintenance, NULL, _("\
1212 Maintenance commands.\n\
1213 Some gdb commands are provided just for use by gdb maintainers.\n\
1214 These commands are subject to frequent change, and may not be as\n\
1215 well documented as user commands."),
1216            &cmdlist);
1217   add_cmd ("obscure", class_obscure, NULL, _("Obscure features."), &cmdlist);
1218   add_cmd ("aliases", class_alias, NULL, _("Aliases of other commands."), &cmdlist);
1219   add_cmd ("user-defined", class_user, NULL, _("\
1220 User-defined commands.\n\
1221 The commands in this class are those defined by the user.\n\
1222 Use the \"define\" command to define a command."), &cmdlist);
1223   add_cmd ("support", class_support, NULL, _("Support facilities."), &cmdlist);
1224   if (!dbx_commands)
1225     add_cmd ("status", class_info, NULL, _("Status inquiries."), &cmdlist);
1226   add_cmd ("files", class_files, NULL, _("Specifying and examining files."),
1227            &cmdlist);
1228   add_cmd ("breakpoints", class_breakpoint, NULL,
1229            _("Making program stop at certain points."), &cmdlist);
1230   add_cmd ("data", class_vars, NULL, _("Examining data."), &cmdlist);
1231   add_cmd ("stack", class_stack, NULL, _("\
1232 Examining the stack.\n\
1233 The stack is made up of stack frames.  Gdb assigns numbers to stack frames\n\
1234 counting from zero for the innermost (currently executing) frame.\n\n\
1235 At any time gdb identifies one frame as the \"selected\" frame.\n\
1236 Variable lookups are done with respect to the selected frame.\n\
1237 When the program being debugged stops, gdb selects the innermost frame.\n\
1238 The commands below can be used to select other frames by number or address."),
1239            &cmdlist);
1240   add_cmd ("running", class_run, NULL, _("Running the program."), &cmdlist);
1241
1242   /* Define general commands. */
1243
1244   c = add_com ("pwd", class_files, pwd_command, _("\
1245 Print working directory.  This is used for your program as well."));
1246   set_cmd_no_selected_thread_ok (c);
1247
1248   c = add_cmd ("cd", class_files, cd_command, _("\
1249 Set working directory to DIR for debugger and program being debugged.\n\
1250 The change does not take effect for the program being debugged\n\
1251 until the next time it is started."), &cmdlist);
1252   set_cmd_completer (c, filename_completer);
1253
1254   add_com ("echo", class_support, echo_command, _("\
1255 Print a constant string.  Give string as argument.\n\
1256 C escape sequences may be used in the argument.\n\
1257 No newline is added at the end of the argument;\n\
1258 use \"\\n\" if you want a newline to be printed.\n\
1259 Since leading and trailing whitespace are ignored in command arguments,\n\
1260 if you want to print some you must use \"\\\" before leading whitespace\n\
1261 to be printed or after trailing whitespace."));
1262   add_com ("document", class_support, document_command, _("\
1263 Document a user-defined command.\n\
1264 Give command name as argument.  Give documentation on following lines.\n\
1265 End with a line of just \"end\"."));
1266   add_com ("define", class_support, define_command, _("\
1267 Define a new command name.  Command name is argument.\n\
1268 Definition appears on following lines, one command per line.\n\
1269 End with a line of just \"end\".\n\
1270 Use the \"document\" command to give documentation for the new command.\n\
1271 Commands defined in this way may have up to ten arguments."));
1272
1273   source_help_text = xstrprintf (_("\
1274 Read commands from a file named FILE.\n\
1275 Optional -v switch (before the filename) causes each command in\n\
1276 FILE to be echoed as it is executed.\n\
1277 Note that the file \"%s\" is read automatically in this way\n\
1278 when GDB is started."), gdbinit);
1279   c = add_cmd ("source", class_support, source_command,
1280                source_help_text, &cmdlist);
1281   set_cmd_completer (c, filename_completer);
1282
1283   add_com ("quit", class_support, quit_command, _("Exit gdb."));
1284   c = add_com ("help", class_support, help_command,
1285                _("Print list of commands."));
1286   set_cmd_completer (c, command_completer);
1287   set_cmd_no_selected_thread_ok (c);
1288   add_com_alias ("q", "quit", class_support, 1);
1289   add_com_alias ("h", "help", class_support, 1);
1290
1291   add_setshow_boolean_cmd ("verbose", class_support, &info_verbose, _("\
1292 Set verbosity."), _("\
1293 Show verbosity."), NULL,
1294                            set_verbose,
1295                            show_info_verbose,
1296                            &setlist, &showlist);
1297
1298   add_prefix_cmd ("history", class_support, set_history,
1299                   _("Generic command for setting command history parameters."),
1300                   &sethistlist, "set history ", 0, &setlist);
1301   add_prefix_cmd ("history", class_support, show_history,
1302                   _("Generic command for showing command history parameters."),
1303                   &showhistlist, "show history ", 0, &showlist);
1304
1305   add_setshow_boolean_cmd ("expansion", no_class, &history_expansion_p, _("\
1306 Set history expansion on command input."), _("\
1307 Show history expansion on command input."), _("\
1308 Without an argument, history expansion is enabled."),
1309                            NULL,
1310                            show_history_expansion_p,
1311                            &sethistlist, &showhistlist);
1312
1313   c = add_prefix_cmd ("info", class_info, info_command, _("\
1314 Generic command for showing things about the program being debugged."),
1315                       &infolist, "info ", 0, &cmdlist);
1316   set_cmd_no_selected_thread_ok (c);
1317   add_com_alias ("i", "info", class_info, 1);
1318
1319   add_com ("complete", class_obscure, complete_command,
1320            _("List the completions for the rest of the line as a command."));
1321
1322   c = add_prefix_cmd ("show", class_info, show_command, _("\
1323 Generic command for showing things about the debugger."),
1324                       &showlist, "show ", 0, &cmdlist);
1325   set_cmd_no_selected_thread_ok (c);
1326   /* Another way to get at the same thing.  */
1327   add_info ("set", show_command, _("Show all GDB settings."));
1328
1329   add_cmd ("commands", no_class, show_commands, _("\
1330 Show the history of commands you typed.\n\
1331 You can supply a command number to start with, or a `+' to start after\n\
1332 the previous command number shown."),
1333            &showlist);
1334
1335   add_cmd ("version", no_class, show_version,
1336            _("Show what version of GDB this is."), &showlist);
1337
1338   add_com ("while", class_support, while_command, _("\
1339 Execute nested commands WHILE the conditional expression is non zero.\n\
1340 The conditional expression must follow the word `while' and must in turn be\n\
1341 followed by a new line.  The nested commands must be entered one per line,\n\
1342 and should be terminated by the word `end'."));
1343
1344   add_com ("if", class_support, if_command, _("\
1345 Execute nested commands once IF the conditional expression is non zero.\n\
1346 The conditional expression must follow the word `if' and must in turn be\n\
1347 followed by a new line.  The nested commands must be entered one per line,\n\
1348 and should be terminated by the word 'else' or `end'.  If an else clause\n\
1349 is used, the same rules apply to its nested commands as to the first ones."));
1350
1351   /* If target is open when baud changes, it doesn't take effect until the
1352      next open (I think, not sure).  */
1353   add_setshow_zinteger_cmd ("remotebaud", no_class, &baud_rate, _("\
1354 Set baud rate for remote serial I/O."), _("\
1355 Show baud rate for remote serial I/O."), _("\
1356 This value is used to set the speed of the serial port when debugging\n\
1357 using remote targets."),
1358                             NULL,
1359                             show_baud_rate,
1360                             &setlist, &showlist);
1361
1362   add_setshow_zinteger_cmd ("remote", no_class, &remote_debug, _("\
1363 Set debugging of remote protocol."), _("\
1364 Show debugging of remote protocol."), _("\
1365 When enabled, each packet sent or received with the remote target\n\
1366 is displayed."),
1367                             NULL,
1368                             show_remote_debug,
1369                             &setdebuglist, &showdebuglist);
1370
1371   add_setshow_integer_cmd ("remotetimeout", no_class, &remote_timeout, _("\
1372 Set timeout limit to wait for target to respond."), _("\
1373 Show timeout limit to wait for target to respond."), _("\
1374 This value is used to set the time limit for gdb to wait for a response\n\
1375 from the target."),
1376                            NULL,
1377                            show_remote_timeout,
1378                            &setlist, &showlist);
1379
1380   add_prefix_cmd ("debug", no_class, set_debug,
1381                   _("Generic command for setting gdb debugging flags"),
1382                   &setdebuglist, "set debug ", 0, &setlist);
1383
1384   add_prefix_cmd ("debug", no_class, show_debug,
1385                   _("Generic command for showing gdb debugging flags"),
1386                   &showdebuglist, "show debug ", 0, &showlist);
1387
1388   c = add_com ("shell", class_support, shell_escape, _("\
1389 Execute the rest of the line as a shell command.\n\
1390 With no arguments, run an inferior shell."));
1391   set_cmd_completer (c, filename_completer);
1392
1393   c = add_com ("edit", class_files, edit_command, _("\
1394 Edit specified file or function.\n\
1395 With no argument, edits file containing most recent line listed.\n\
1396 Editing targets can be specified in these ways:\n\
1397   FILE:LINENUM, to edit at that line in that file,\n\
1398   FUNCTION, to edit at the beginning of that function,\n\
1399   FILE:FUNCTION, to distinguish among like-named static functions.\n\
1400   *ADDRESS, to edit at the line containing that address.\n\
1401 Uses EDITOR environment variable contents as editor (or ex as default)."));
1402
1403   c->completer = location_completer;
1404
1405   add_com ("list", class_files, list_command, _("\
1406 List specified function or line.\n\
1407 With no argument, lists ten more lines after or around previous listing.\n\
1408 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1409 One argument specifies a line, and ten lines are listed around that line.\n\
1410 Two arguments with comma between specify starting and ending lines to list.\n\
1411 Lines can be specified in these ways:\n\
1412   LINENUM, to list around that line in current file,\n\
1413   FILE:LINENUM, to list around that line in that file,\n\
1414   FUNCTION, to list around beginning of that function,\n\
1415   FILE:FUNCTION, to distinguish among like-named static functions.\n\
1416   *ADDRESS, to list around the line containing that address.\n\
1417 With two args if one is empty it stands for ten lines away from the other arg."));
1418
1419   if (!xdb_commands)
1420     add_com_alias ("l", "list", class_files, 1);
1421   else
1422     add_com_alias ("v", "list", class_files, 1);
1423
1424   if (dbx_commands)
1425     add_com_alias ("file", "list", class_files, 1);
1426
1427   c = add_com ("disassemble", class_vars, disassemble_command, _("\
1428 Disassemble a specified section of memory.\n\
1429 Default is the function surrounding the pc of the selected frame.\n\
1430 With a /m modifier, source lines are included (if available).\n\
1431 With a single argument, the function surrounding that address is dumped.\n\
1432 Two arguments are taken as a range of memory to dump."));
1433   set_cmd_completer (c, location_completer);
1434   if (xdb_commands)
1435     add_com_alias ("va", "disassemble", class_xdb, 0);
1436
1437   /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1438      be a really useful feature.  Unfortunately, the below wont do
1439      this.  Instead it adds support for the form ``(gdb) ! ls''
1440      (i.e. the space is required).  If the ``!'' command below is
1441      added the complains about no ``!'' command would be replaced by
1442      complains about how the ``!'' command is broken :-) */
1443   if (xdb_commands)
1444     add_com_alias ("!", "shell", class_support, 0);
1445
1446   c = add_com ("make", class_support, make_command, _("\
1447 Run the ``make'' program using the rest of the line as arguments."));
1448   set_cmd_completer (c, filename_completer);
1449   add_cmd ("user", no_class, show_user, _("\
1450 Show definitions of user defined commands.\n\
1451 Argument is the name of the user defined command.\n\
1452 With no argument, show definitions of all user defined commands."), &showlist);
1453   add_com ("apropos", class_support, apropos_command,
1454            _("Search for commands matching a REGEXP"));
1455
1456   add_setshow_integer_cmd ("max-user-call-depth", no_class,
1457                            &max_user_call_depth, _("\
1458 Set the max call depth for user-defined commands."), _("\
1459 Show the max call depth for user-defined commands."), NULL,
1460                            NULL,
1461                            show_max_user_call_depth,
1462                            &setlist, &showlist);
1463
1464   add_setshow_boolean_cmd ("trace-commands", no_class, &trace_commands, _("\
1465 Set tracing of GDB CLI commands."), _("\
1466 Show state of GDB CLI command tracing."), _("\
1467 When 'on', each command is displayed as it is executed."),
1468                            NULL,
1469                            NULL,
1470                            &setlist, &showlist);
1471 }