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