1 /* GDB CLI commands.
2 
3    Copyright 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
4 
5    This file is part of GDB.
6 
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11 
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16 
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 59 Temple Place - Suite 330,
20    Boston, MA 02111-1307, USA.  */
21 
22 #include "defs.h"
23 #include "readline/readline.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 #ifndef GDBINIT_FILENAME
53 #define GDBINIT_FILENAME        ".gdbinit"
54 #endif
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 
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 
177 /* Utility used everywhere when at least one argument is needed and
178    none is supplied. */
179 
180 void
error_no_arg(char * why)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
info_command(char * arg,int from_tty)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
show_command(char * arg,int from_tty)199 show_command (char *arg, int from_tty)
200 {
201   cmd_show_list (showlist, from_tty, "");
202 }
203 
204 /* Provide documentation on command or list given by COMMAND.  FROM_TTY
205    is ignored.  */
206 
207 static void
help_command(char * command,int from_tty)208 help_command (char *command, int from_tty)
209 {
210   help_cmd (command, gdb_stdout);
211 }
212 
213 /* String compare function for qsort.  */
214 static int
compare_strings(const void * arg1,const void * arg2)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
complete_command(char * arg,int from_tty)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
is_complete_command(struct cmd_list_element * c)287 is_complete_command (struct cmd_list_element *c)
288 {
289   return cmd_cfunc_eq (c, complete_command);
290 }
291 
292 static void
show_version(char * args,int from_tty)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
quit_command(char * args,int from_tty)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
pwd_command(char * args,int from_tty)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
cd_command(char * dir,int from_tty)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, NULL);
373       else
374 	current_directory = concat (current_directory, SLASH_STRING, dir, NULL);
375       xfree (dir);
376     }
377 
378   /* Now simplify any occurrences of `.' and `..' in the pathname.  */
379 
380   found_real_path = 0;
381   for (p = current_directory; *p;)
382     {
383       if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
384 	  && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
385 	strcpy (p, p + 2);
386       else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
387 	       && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
388 	{
389 	  if (found_real_path)
390 	    {
391 	      /* Search backwards for the directory just before the "/.."
392 	         and obliterate it and the "/..".  */
393 	      char *q = p;
394 	      while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
395 		--q;
396 
397 	      if (q == current_directory)
398 		/* current_directory is
399 		   a relative pathname ("can't happen"--leave it alone).  */
400 		++p;
401 	      else
402 		{
403 		  strcpy (q - 1, p + 3);
404 		  p = q - 1;
405 		}
406 	    }
407 	  else
408 	    /* We are dealing with leading repetitions of "/..", for example
409 	       "/../..", which is the Mach super-root.  */
410 	    p += 3;
411 	}
412       else
413 	{
414 	  found_real_path = 1;
415 	  ++p;
416 	}
417     }
418 
419   forget_cached_source_info ();
420 
421   if (from_tty)
422     pwd_command ((char *) 0, 1);
423 }
424 
425 void
source_command(char * args,int from_tty)426 source_command (char *args, int from_tty)
427 {
428   FILE *stream;
429   struct cleanup *old_cleanups;
430   char *file = args;
431 
432   if (file == NULL)
433     {
434       error ("source command requires pathname of file to source.");
435     }
436 
437   file = tilde_expand (file);
438   old_cleanups = make_cleanup (xfree, file);
439 
440   stream = fopen (file, FOPEN_RT);
441   if (!stream)
442     {
443       if (from_tty)
444 	perror_with_name (file);
445       else
446 	return;
447     }
448 
449   script_from_file (stream, file);
450 
451   do_cleanups (old_cleanups);
452 }
453 
454 static void
echo_command(char * text,int from_tty)455 echo_command (char *text, int from_tty)
456 {
457   char *p = text;
458   int c;
459 
460   if (text)
461     while ((c = *p++) != '\0')
462       {
463 	if (c == '\\')
464 	  {
465 	    /* \ at end of argument is used after spaces
466 	       so they won't be lost.  */
467 	    if (*p == 0)
468 	      return;
469 
470 	    c = parse_escape (&p);
471 	    if (c >= 0)
472 	      printf_filtered ("%c", c);
473 	  }
474 	else
475 	  printf_filtered ("%c", c);
476       }
477 
478   /* Force this output to appear now.  */
479   wrap_here ("");
480   gdb_flush (gdb_stdout);
481 }
482 
483 static void
shell_escape(char * arg,int from_tty)484 shell_escape (char *arg, int from_tty)
485 {
486 #ifdef CANT_FORK
487   /* If ARG is NULL, they want an inferior shell, but `system' just
488      reports if the shell is available when passed a NULL arg.  */
489   int rc = system (arg ? arg : "");
490 
491   if (!arg)
492     arg = "inferior shell";
493 
494   if (rc == -1)
495     {
496       fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
497 			  safe_strerror (errno));
498       gdb_flush (gdb_stderr);
499     }
500   else if (rc)
501     {
502       fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
503       gdb_flush (gdb_stderr);
504     }
505 #ifdef GLOBAL_CURDIR
506   /* Make sure to return to the directory GDB thinks it is, in case the
507      shell command we just ran changed it.  */
508   chdir (current_directory);
509 #endif
510 #else /* Can fork.  */
511   int rc, status, pid;
512 
513   if ((pid = vfork ()) == 0)
514     {
515       char *p, *user_shell;
516 
517       if ((user_shell = (char *) getenv ("SHELL")) == NULL)
518 	user_shell = "/bin/sh";
519 
520       /* Get the name of the shell for arg0 */
521       if ((p = strrchr (user_shell, '/')) == NULL)
522 	p = user_shell;
523       else
524 	p++;			/* Get past '/' */
525 
526       if (!arg)
527 	execl (user_shell, p, (char *) 0);
528       else
529 	execl (user_shell, p, "-c", arg, (char *) 0);
530 
531       fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
532 			  safe_strerror (errno));
533       gdb_flush (gdb_stderr);
534       _exit (0177);
535     }
536 
537   if (pid != -1)
538     while ((rc = wait (&status)) != pid && rc != -1)
539       ;
540   else
541     error ("Fork failed");
542 #endif /* Can fork.  */
543 }
544 
545 static void
edit_command(char * arg,int from_tty)546 edit_command (char *arg, int from_tty)
547 {
548   struct symtabs_and_lines sals;
549   struct symtab_and_line sal;
550   struct symbol *sym;
551   char *arg1;
552   int cmdlen, log10;
553   unsigned m;
554   char *editor;
555   char *p;
556 
557   /* Pull in the current default source line if necessary */
558   if (arg == 0)
559     {
560       set_default_source_symtab_and_line ();
561       sal = get_current_source_symtab_and_line ();
562     }
563 
564   /* bare "edit" edits file with present line.  */
565 
566   if (arg == 0)
567     {
568       if (sal.symtab == 0)
569 	error ("No default source file yet.");
570       sal.line += get_lines_to_list () / 2;
571     }
572   else
573     {
574 
575       /* Now should only be one argument -- decode it in SAL */
576 
577       arg1 = arg;
578       sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
579 
580       if (! sals.nelts) return;  /*  C++  */
581       if (sals.nelts > 1) {
582         ambiguous_line_spec (&sals);
583         xfree (sals.sals);
584         return;
585       }
586 
587       sal = sals.sals[0];
588       xfree (sals.sals);
589 
590       if (*arg1)
591         error ("Junk at end of line specification.");
592 
593       /* if line was specified by address,
594          first print exactly which line, and which file.
595          In this case, sal.symtab == 0 means address is outside
596          of all known source files, not that user failed to give a filename.  */
597       if (*arg == '*')
598         {
599           if (sal.symtab == 0)
600 	    /* FIXME-32x64--assumes sal.pc fits in long.  */
601 	    error ("No source file for address %s.",
602 		   local_hex_string((unsigned long) sal.pc));
603           sym = find_pc_function (sal.pc);
604           if (sym)
605 	    {
606 	      print_address_numeric (sal.pc, 1, gdb_stdout);
607 	      printf_filtered (" is in ");
608 	      fputs_filtered (SYMBOL_PRINT_NAME (sym), gdb_stdout);
609 	      printf_filtered (" (%s:%d).\n", sal.symtab->filename, sal.line);
610 	    }
611           else
612 	    {
613 	      print_address_numeric (sal.pc, 1, gdb_stdout);
614 	      printf_filtered (" is at %s:%d.\n",
615 			       sal.symtab->filename, sal.line);
616 	    }
617         }
618 
619       /* If what was given does not imply a symtab, it must be an undebuggable
620          symbol which means no source code.  */
621 
622       if (sal.symtab == 0)
623         error ("No line number known for %s.", arg);
624     }
625 
626   if ((editor = (char *) getenv ("EDITOR")) == NULL)
627       editor = "/bin/ex";
628 
629   /* Approximate base-10 log of line to 1 unit for digit count */
630   for(log10=32, m=0x80000000; !(sal.line & m) && log10>0; log10--, m=m>>1);
631   log10 = 1 + (int)((log10 + (0 == ((m-1) & sal.line)))/3.32192809);
632 
633   cmdlen = strlen(editor) + 1
634          + (NULL == sal.symtab->dirname ? 0 : strlen(sal.symtab->dirname) + 1)
635 	 + (NULL == sal.symtab->filename? 0 : strlen(sal.symtab->filename)+ 1)
636 	 + log10 + 2;
637 
638   p = xmalloc(cmdlen);
639   sprintf(p,"%s +%d %s%s",editor,sal.line,
640      (NULL == sal.symtab->dirname ? "./" :
641         (NULL != sal.symtab->filename && *(sal.symtab->filename) != '/') ?
642 	   sal.symtab->dirname : ""),
643      (NULL == sal.symtab->filename ? "unknown" : sal.symtab->filename)
644   );
645   shell_escape(p, from_tty);
646 
647   xfree(p);
648 }
649 
650 static void
list_command(char * arg,int from_tty)651 list_command (char *arg, int from_tty)
652 {
653   struct symtabs_and_lines sals, sals_end;
654   struct symtab_and_line sal, sal_end, cursal;
655   struct symbol *sym;
656   char *arg1;
657   int no_end = 1;
658   int dummy_end = 0;
659   int dummy_beg = 0;
660   int linenum_beg = 0;
661   char *p;
662 
663   /* Pull in the current default source line if necessary */
664   if (arg == 0 || arg[0] == '+' || arg[0] == '-')
665     {
666       set_default_source_symtab_and_line ();
667       cursal = get_current_source_symtab_and_line ();
668     }
669 
670   /* "l" or "l +" lists next ten lines.  */
671 
672   if (arg == 0 || strcmp (arg, "+") == 0)
673     {
674       print_source_lines (cursal.symtab, cursal.line,
675 			  cursal.line + get_lines_to_list (), 0);
676       return;
677     }
678 
679   /* "l -" lists previous ten lines, the ones before the ten just listed.  */
680   if (strcmp (arg, "-") == 0)
681     {
682       print_source_lines (cursal.symtab,
683 			  max (get_first_line_listed () - get_lines_to_list (), 1),
684 			  get_first_line_listed (), 0);
685       return;
686     }
687 
688   /* Now if there is only one argument, decode it in SAL
689      and set NO_END.
690      If there are two arguments, decode them in SAL and SAL_END
691      and clear NO_END; however, if one of the arguments is blank,
692      set DUMMY_BEG or DUMMY_END to record that fact.  */
693 
694   if (!have_full_symbols () && !have_partial_symbols ())
695     error ("No symbol table is loaded.  Use the \"file\" command.");
696 
697   arg1 = arg;
698   if (*arg1 == ',')
699     dummy_beg = 1;
700   else
701     {
702       sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
703 
704       if (!sals.nelts)
705 	return;			/*  C++  */
706       if (sals.nelts > 1)
707 	{
708 	  ambiguous_line_spec (&sals);
709 	  xfree (sals.sals);
710 	  return;
711 	}
712 
713       sal = sals.sals[0];
714       xfree (sals.sals);
715     }
716 
717   /* Record whether the BEG arg is all digits.  */
718 
719   for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
720   linenum_beg = (p == arg1);
721 
722   while (*arg1 == ' ' || *arg1 == '\t')
723     arg1++;
724   if (*arg1 == ',')
725     {
726       no_end = 0;
727       arg1++;
728       while (*arg1 == ' ' || *arg1 == '\t')
729 	arg1++;
730       if (*arg1 == 0)
731 	dummy_end = 1;
732       else
733 	{
734 	  if (dummy_beg)
735 	    sals_end = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
736 	  else
737 	    sals_end = decode_line_1 (&arg1, 0, sal.symtab, sal.line, 0, 0);
738 	  if (sals_end.nelts == 0)
739 	    return;
740 	  if (sals_end.nelts > 1)
741 	    {
742 	      ambiguous_line_spec (&sals_end);
743 	      xfree (sals_end.sals);
744 	      return;
745 	    }
746 	  sal_end = sals_end.sals[0];
747 	  xfree (sals_end.sals);
748 	}
749     }
750 
751   if (*arg1)
752     error ("Junk at end of line specification.");
753 
754   if (!no_end && !dummy_beg && !dummy_end
755       && sal.symtab != sal_end.symtab)
756     error ("Specified start and end are in different files.");
757   if (dummy_beg && dummy_end)
758     error ("Two empty args do not say what lines to list.");
759 
760   /* if line was specified by address,
761      first print exactly which line, and which file.
762      In this case, sal.symtab == 0 means address is outside
763      of all known source files, not that user failed to give a filename.  */
764   if (*arg == '*')
765     {
766       if (sal.symtab == 0)
767 	/* FIXME-32x64--assumes sal.pc fits in long.  */
768 	error ("No source file for address %s.",
769 	       local_hex_string ((unsigned long) sal.pc));
770       sym = find_pc_function (sal.pc);
771       if (sym)
772 	{
773 	  print_address_numeric (sal.pc, 1, gdb_stdout);
774 	  printf_filtered (" is in ");
775 	  fputs_filtered (SYMBOL_PRINT_NAME (sym), gdb_stdout);
776 	  printf_filtered (" (%s:%d).\n", sal.symtab->filename, sal.line);
777 	}
778       else
779 	{
780 	  print_address_numeric (sal.pc, 1, gdb_stdout);
781 	  printf_filtered (" is at %s:%d.\n",
782 			   sal.symtab->filename, sal.line);
783 	}
784     }
785 
786   /* If line was not specified by just a line number,
787      and it does not imply a symtab, it must be an undebuggable symbol
788      which means no source code.  */
789 
790   if (!linenum_beg && sal.symtab == 0)
791     error ("No line number known for %s.", arg);
792 
793   /* If this command is repeated with RET,
794      turn it into the no-arg variant.  */
795 
796   if (from_tty)
797     *arg = 0;
798 
799   if (dummy_beg && sal_end.symtab == 0)
800     error ("No default source file yet.  Do \"help list\".");
801   if (dummy_beg)
802     print_source_lines (sal_end.symtab,
803 			max (sal_end.line - (get_lines_to_list () - 1), 1),
804 			sal_end.line + 1, 0);
805   else if (sal.symtab == 0)
806     error ("No default source file yet.  Do \"help list\".");
807   else if (no_end)
808     {
809       int first_line = sal.line - get_lines_to_list () / 2;
810 
811       if (first_line < 1) first_line = 1;
812 
813       print_source_lines (sal.symtab,
814 		          first_line,
815 			  first_line + get_lines_to_list (),
816 			  0);
817     }
818   else
819     print_source_lines (sal.symtab, sal.line,
820 			(dummy_end
821 			 ? sal.line + get_lines_to_list ()
822 			 : sal_end.line + 1),
823 			0);
824 }
825 
826 /* Dump a specified section of assembly code.  With no command line
827    arguments, this command will dump the assembly code for the
828    function surrounding the pc value in the selected frame.  With one
829    argument, it will dump the assembly code surrounding that pc value.
830    Two arguments are interpeted as bounds within which to dump
831    assembly.  */
832 
833 static void
disassemble_command(char * arg,int from_tty)834 disassemble_command (char *arg, int from_tty)
835 {
836   CORE_ADDR low, high;
837   char *name;
838   CORE_ADDR pc, pc_masked;
839   char *space_index;
840 #if 0
841   asection *section;
842 #endif
843 
844   name = NULL;
845   if (!arg)
846     {
847       if (!deprecated_selected_frame)
848 	error ("No frame selected.\n");
849 
850       pc = get_frame_pc (deprecated_selected_frame);
851       if (find_pc_partial_function (pc, &name, &low, &high) == 0)
852 	error ("No function contains program counter for selected frame.\n");
853 #if defined(TUI)
854       /* NOTE: cagney/2003-02-13 The `tui_active' was previously
855 	 `tui_version'.  */
856       if (tui_active)
857 	/* FIXME: cagney/2004-02-07: This should be an observer.  */
858 	low = tui_get_low_disassembly_address (low, pc);
859 #endif
860       low += FUNCTION_START_OFFSET;
861     }
862   else if (!(space_index = (char *) strchr (arg, ' ')))
863     {
864       /* One argument.  */
865       pc = parse_and_eval_address (arg);
866       if (find_pc_partial_function (pc, &name, &low, &high) == 0)
867 	error ("No function contains specified address.\n");
868 #if defined(TUI)
869       /* NOTE: cagney/2003-02-13 The `tui_active' was previously
870 	 `tui_version'.  */
871       if (tui_active)
872 	/* FIXME: cagney/2004-02-07: This should be an observer.  */
873 	low = tui_get_low_disassembly_address (low, pc);
874 #endif
875       low += FUNCTION_START_OFFSET;
876     }
877   else
878     {
879       /* Two arguments.  */
880       *space_index = '\0';
881       low = parse_and_eval_address (arg);
882       high = parse_and_eval_address (space_index + 1);
883     }
884 
885 #if defined(TUI)
886   if (!tui_is_window_visible (DISASSEM_WIN))
887 #endif
888     {
889       printf_filtered ("Dump of assembler code ");
890       if (name != NULL)
891 	{
892 	  printf_filtered ("for function %s:\n", name);
893 	}
894       else
895 	{
896 	  printf_filtered ("from ");
897 	  print_address_numeric (low, 1, gdb_stdout);
898 	  printf_filtered (" to ");
899 	  print_address_numeric (high, 1, gdb_stdout);
900 	  printf_filtered (":\n");
901 	}
902 
903       /* Dump the specified range.  */
904       gdb_disassembly (uiout, 0, 0, 0, -1, low, high);
905 
906       printf_filtered ("End of assembler dump.\n");
907       gdb_flush (gdb_stdout);
908     }
909 #if defined(TUI)
910   else
911     {
912       tui_show_assembly (low);
913     }
914 #endif
915 }
916 
917 static void
make_command(char * arg,int from_tty)918 make_command (char *arg, int from_tty)
919 {
920   char *p;
921 
922   if (arg == 0)
923     p = "make";
924   else
925     {
926       p = xmalloc (sizeof ("make ") + strlen (arg));
927       strcpy (p, "make ");
928       strcpy (p + sizeof ("make ") - 1, arg);
929     }
930 
931   shell_escape (p, from_tty);
932 }
933 
934 static void
show_user(char * args,int from_tty)935 show_user (char *args, int from_tty)
936 {
937   struct cmd_list_element *c;
938   extern struct cmd_list_element *cmdlist;
939 
940   if (args)
941     {
942       c = lookup_cmd (&args, cmdlist, "", 0, 1);
943       if (c->class != class_user)
944 	error ("Not a user command.");
945       show_user_1 (c, gdb_stdout);
946     }
947   else
948     {
949       for (c = cmdlist; c; c = c->next)
950 	{
951 	  if (c->class == class_user)
952 	    show_user_1 (c, gdb_stdout);
953 	}
954     }
955 }
956 
957 /* Search through names of commands and documentations for a certain
958    regular expression.
959 */
960 void
apropos_command(char * searchstr,int from_tty)961 apropos_command (char *searchstr, int from_tty)
962 {
963   extern struct cmd_list_element *cmdlist; /*This is the main command list*/
964   regex_t pattern;
965   char *pattern_fastmap;
966   char errorbuffer[512];
967   pattern_fastmap = xcalloc (256, sizeof (char));
968   if (searchstr == NULL)
969       error("REGEXP string is empty");
970 
971   if (regcomp(&pattern,searchstr,REG_ICASE) == 0)
972     {
973       pattern.fastmap=pattern_fastmap;
974       re_compile_fastmap(&pattern);
975       apropos_cmd (gdb_stdout,cmdlist,&pattern,"");
976     }
977   else
978     {
979       regerror(regcomp(&pattern,searchstr,REG_ICASE),NULL,errorbuffer,512);
980       error("Error in regular expression:%s",errorbuffer);
981     }
982   xfree (pattern_fastmap);
983 }
984 
985 /* Print a list of files and line numbers which a user may choose from
986    in order to list a function which was specified ambiguously (as with
987    `list classname::overloadedfuncname', for example).  The vector in
988    SALS provides the filenames and line numbers.  */
989 
990 static void
ambiguous_line_spec(struct symtabs_and_lines * sals)991 ambiguous_line_spec (struct symtabs_and_lines *sals)
992 {
993   int i;
994 
995   for (i = 0; i < sals->nelts; ++i)
996     printf_filtered ("file: \"%s\", line number: %d\n",
997 		     sals->sals[i].symtab->filename, sals->sals[i].line);
998 }
999 
1000 static void
set_debug(char * arg,int from_tty)1001 set_debug (char *arg, int from_tty)
1002 {
1003   printf_unfiltered ("\"set debug\" must be followed by the name of a print subcommand.\n");
1004   help_list (setdebuglist, "set debug ", -1, gdb_stdout);
1005 }
1006 
1007 static void
show_debug(char * args,int from_tty)1008 show_debug (char *args, int from_tty)
1009 {
1010   cmd_show_list (showdebuglist, from_tty, "");
1011 }
1012 
1013 void
init_cmd_lists(void)1014 init_cmd_lists (void)
1015 {
1016   max_user_call_depth = 1024;
1017 
1018   cmdlist = NULL;
1019   infolist = NULL;
1020   enablelist = NULL;
1021   disablelist = NULL;
1022   togglelist = NULL;
1023   stoplist = NULL;
1024   deletelist = NULL;
1025   enablebreaklist = NULL;
1026   setlist = NULL;
1027   unsetlist = NULL;
1028   showlist = NULL;
1029   sethistlist = NULL;
1030   showhistlist = NULL;
1031   unsethistlist = NULL;
1032   maintenancelist = NULL;
1033   maintenanceinfolist = NULL;
1034   maintenanceprintlist = NULL;
1035   setprintlist = NULL;
1036   showprintlist = NULL;
1037   setchecklist = NULL;
1038   showchecklist = NULL;
1039 }
1040 
1041 
1042 void
init_cli_cmds(void)1043 init_cli_cmds (void)
1044 {
1045   struct cmd_list_element *c;
1046 
1047   /* Define the classes of commands.
1048      They will appear in the help list in the reverse of this order.  */
1049 
1050   add_cmd ("internals", class_maintenance, NULL,
1051 	   "Maintenance commands.\n\
1052 Some gdb commands are provided just for use by gdb maintainers.\n\
1053 These commands are subject to frequent change, and may not be as\n\
1054 well documented as user commands.",
1055 	   &cmdlist);
1056   add_cmd ("obscure", class_obscure, NULL, "Obscure features.", &cmdlist);
1057   add_cmd ("aliases", class_alias, NULL, "Aliases of other commands.", &cmdlist);
1058   add_cmd ("user-defined", class_user, NULL, "User-defined commands.\n\
1059 The commands in this class are those defined by the user.\n\
1060 Use the \"define\" command to define a command.", &cmdlist);
1061   add_cmd ("support", class_support, NULL, "Support facilities.", &cmdlist);
1062   if (!dbx_commands)
1063     add_cmd ("status", class_info, NULL, "Status inquiries.", &cmdlist);
1064   add_cmd ("files", class_files, NULL, "Specifying and examining files.", &cmdlist);
1065   add_cmd ("breakpoints", class_breakpoint, NULL, "Making program stop at certain points.", &cmdlist);
1066   add_cmd ("data", class_vars, NULL, "Examining data.", &cmdlist);
1067   add_cmd ("stack", class_stack, NULL, "Examining the stack.\n\
1068 The stack is made up of stack frames.  Gdb assigns numbers to stack frames\n\
1069 counting from zero for the innermost (currently executing) frame.\n\n\
1070 At any time gdb identifies one frame as the \"selected\" frame.\n\
1071 Variable lookups are done with respect to the selected frame.\n\
1072 When the program being debugged stops, gdb selects the innermost frame.\n\
1073 The commands below can be used to select other frames by number or address.",
1074 	   &cmdlist);
1075   add_cmd ("running", class_run, NULL, "Running the program.", &cmdlist);
1076 
1077   /* Define general commands. */
1078 
1079   add_com ("pwd", class_files, pwd_command,
1080 	"Print working directory.  This is used for your program as well.");
1081   c = add_cmd ("cd", class_files, cd_command,
1082 	       "Set working directory to DIR for debugger and program being debugged.\n\
1083 The change does not take effect for the program being debugged\n\
1084 until the next time it is started.", &cmdlist);
1085   set_cmd_completer (c, filename_completer);
1086 
1087   add_com ("echo", class_support, echo_command,
1088 	   "Print a constant string.  Give string as argument.\n\
1089 C escape sequences may be used in the argument.\n\
1090 No newline is added at the end of the argument;\n\
1091 use \"\\n\" if you want a newline to be printed.\n\
1092 Since leading and trailing whitespace are ignored in command arguments,\n\
1093 if you want to print some you must use \"\\\" before leading whitespace\n\
1094 to be printed or after trailing whitespace.");
1095   add_com ("document", class_support, document_command,
1096 	   "Document a user-defined command.\n\
1097 Give command name as argument.  Give documentation on following lines.\n\
1098 End with a line of just \"end\".");
1099   add_com ("define", class_support, define_command,
1100 	   "Define a new command name.  Command name is argument.\n\
1101 Definition appears on following lines, one command per line.\n\
1102 End with a line of just \"end\".\n\
1103 Use the \"document\" command to give documentation for the new command.\n\
1104 Commands defined in this way may have up to ten arguments.");
1105 
1106   c = add_cmd ("source", class_support, source_command,
1107 	       "Read commands from a file named FILE.\n\
1108 Note that the file \"" GDBINIT_FILENAME "\" is read automatically in this way\n\
1109 when gdb is started.", &cmdlist);
1110   set_cmd_completer (c, filename_completer);
1111 
1112   add_com ("quit", class_support, quit_command, "Exit gdb.");
1113   c = add_com ("help", class_support, help_command, "Print list of commands.");
1114   set_cmd_completer (c, command_completer);
1115   add_com_alias ("q", "quit", class_support, 1);
1116   add_com_alias ("h", "help", class_support, 1);
1117 
1118   c = add_set_cmd ("verbose", class_support, var_boolean, (char *) &info_verbose,
1119 		   "Set ",
1120 		   &setlist),
1121     add_show_from_set (c, &showlist);
1122   set_cmd_sfunc (c, set_verbose);
1123   set_verbose (NULL, 0, c);
1124 
1125   add_prefix_cmd ("history", class_support, set_history,
1126 		  "Generic command for setting command history parameters.",
1127 		  &sethistlist, "set history ", 0, &setlist);
1128   add_prefix_cmd ("history", class_support, show_history,
1129 		  "Generic command for showing command history parameters.",
1130 		  &showhistlist, "show history ", 0, &showlist);
1131 
1132   add_show_from_set
1133     (add_set_cmd ("expansion", no_class, var_boolean, (char *) &history_expansion_p,
1134 		  "Set history expansion on command input.\n\
1135 Without an argument, history expansion is enabled.", &sethistlist),
1136      &showhistlist);
1137 
1138   add_prefix_cmd ("info", class_info, info_command,
1139      "Generic command for showing things about the program being debugged.",
1140 		  &infolist, "info ", 0, &cmdlist);
1141   add_com_alias ("i", "info", class_info, 1);
1142 
1143   add_com ("complete", class_obscure, complete_command,
1144 	   "List the completions for the rest of the line as a command.");
1145 
1146   add_prefix_cmd ("show", class_info, show_command,
1147 		  "Generic command for showing things about the debugger.",
1148 		  &showlist, "show ", 0, &cmdlist);
1149   /* Another way to get at the same thing.  */
1150   add_info ("set", show_command, "Show all GDB settings.");
1151 
1152   add_cmd ("commands", no_class, show_commands,
1153 	   "Show the history of commands you typed.\n\
1154 You can supply a command number to start with, or a `+' to start after\n\
1155 the previous command number shown.",
1156 	   &showlist);
1157 
1158   add_cmd ("version", no_class, show_version,
1159 	   "Show what version of GDB this is.", &showlist);
1160 
1161   add_com ("while", class_support, while_command,
1162 	   "Execute nested commands WHILE the conditional expression is non zero.\n\
1163 The conditional expression must follow the word `while' and must in turn be\n\
1164 followed by a new line.  The nested commands must be entered one per line,\n\
1165 and should be terminated by the word `end'.");
1166 
1167   add_com ("if", class_support, if_command,
1168 	   "Execute nested commands once IF the conditional expression is non zero.\n\
1169 The conditional expression must follow the word `if' and must in turn be\n\
1170 followed by a new line.  The nested commands must be entered one per line,\n\
1171 and should be terminated by the word 'else' or `end'.  If an else clause\n\
1172 is used, the same rules apply to its nested commands as to the first ones.");
1173 
1174   /* If target is open when baud changes, it doesn't take effect until the
1175      next open (I think, not sure).  */
1176   add_show_from_set (add_set_cmd ("remotebaud", no_class,
1177 				  var_zinteger, (char *) &baud_rate,
1178 				  "Set baud rate for remote serial I/O.\n\
1179 This value is used to set the speed of the serial port when debugging\n\
1180 using remote targets.", &setlist),
1181 		     &showlist);
1182 
1183   c = add_set_cmd ("remotedebug", no_class, var_zinteger,
1184 		   (char *) &remote_debug,
1185 		   "Set debugging of remote protocol.\n\
1186 When enabled, each packet sent or received with the remote target\n\
1187 is displayed.", &setlist);
1188   deprecate_cmd (c, "set debug remote");
1189   deprecate_cmd (add_show_from_set (c, &showlist), "show debug remote");
1190 
1191   add_show_from_set (add_set_cmd ("remote", no_class, var_zinteger,
1192 				  (char *) &remote_debug,
1193 				  "Set debugging of remote protocol.\n\
1194 When enabled, each packet sent or received with the remote target\n\
1195 is displayed.", &setdebuglist),
1196 		     &showdebuglist);
1197 
1198   add_show_from_set (
1199 		      add_set_cmd ("remotetimeout", no_class, var_integer, (char *) &remote_timeout,
1200 				   "Set timeout limit to wait for target to respond.\n\
1201 This value is used to set the time limit for gdb to wait for a response\n\
1202 from the target.", &setlist),
1203 		      &showlist);
1204 
1205   add_prefix_cmd ("debug", no_class, set_debug,
1206 		  "Generic command for setting gdb debugging flags",
1207 		  &setdebuglist, "set debug ", 0, &setlist);
1208 
1209   add_prefix_cmd ("debug", no_class, show_debug,
1210 		  "Generic command for showing gdb debugging flags",
1211 		  &showdebuglist, "show debug ", 0, &showlist);
1212 
1213   c = add_com ("shell", class_support, shell_escape,
1214 	       "Execute the rest of the line as a shell command.\n\
1215 With no arguments, run an inferior shell.");
1216   set_cmd_completer (c, filename_completer);
1217 
1218   c = add_com ("edit", class_files, edit_command,
1219            concat ("Edit specified file or function.\n\
1220 With no argument, edits file containing most recent line listed.\n\
1221 ", "\
1222 Editing targets can be specified in these ways:\n\
1223   FILE:LINENUM, to edit at that line in that file,\n\
1224   FUNCTION, to edit at the beginning of that function,\n\
1225   FILE:FUNCTION, to distinguish among like-named static functions.\n\
1226   *ADDRESS, to edit at the line containing that address.\n\
1227 Uses EDITOR environment variable contents as editor (or ex as default).",NULL));
1228 
1229   c->completer = location_completer;
1230 
1231   add_com ("list", class_files, list_command,
1232 	   concat ("List specified function or line.\n\
1233 With no argument, lists ten more lines after or around previous listing.\n\
1234 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1235 One argument specifies a line, and ten lines are listed around that line.\n\
1236 Two arguments with comma between specify starting and ending lines to list.\n\
1237 ", "\
1238 Lines can be specified in these ways:\n\
1239   LINENUM, to list around that line in current file,\n\
1240   FILE:LINENUM, to list around that line in that file,\n\
1241   FUNCTION, to list around beginning of that function,\n\
1242   FILE:FUNCTION, to distinguish among like-named static functions.\n\
1243   *ADDRESS, to list around the line containing that address.\n\
1244 With two args if one is empty it stands for ten lines away from the other arg.", NULL));
1245 
1246   if (!xdb_commands)
1247     add_com_alias ("l", "list", class_files, 1);
1248   else
1249     add_com_alias ("v", "list", class_files, 1);
1250 
1251   if (dbx_commands)
1252     add_com_alias ("file", "list", class_files, 1);
1253 
1254   c = add_com ("disassemble", class_vars, disassemble_command,
1255 	       "Disassemble a specified section of memory.\n\
1256 Default is the function surrounding the pc of the selected frame.\n\
1257 With a single argument, the function surrounding that address is dumped.\n\
1258 Two arguments are taken as a range of memory to dump.");
1259   set_cmd_completer (c, location_completer);
1260   if (xdb_commands)
1261     add_com_alias ("va", "disassemble", class_xdb, 0);
1262 
1263   /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1264      be a really useful feature.  Unfortunately, the below wont do
1265      this.  Instead it adds support for the form ``(gdb) ! ls''
1266      (i.e. the space is required).  If the ``!'' command below is
1267      added the complains about no ``!'' command would be replaced by
1268      complains about how the ``!'' command is broken :-) */
1269   if (xdb_commands)
1270     add_com_alias ("!", "shell", class_support, 0);
1271 
1272   c = add_com ("make", class_support, make_command,
1273           "Run the ``make'' program using the rest of the line as arguments.");
1274   set_cmd_completer (c, filename_completer);
1275   add_cmd ("user", no_class, show_user,
1276 	   "Show definitions of user defined commands.\n\
1277 Argument is the name of the user defined command.\n\
1278 With no argument, show definitions of all user defined commands.", &showlist);
1279   add_com ("apropos", class_support, apropos_command, "Search for commands matching a REGEXP");
1280 
1281   add_show_from_set (
1282 		      add_set_cmd ("max-user-call-depth", no_class, var_integer,
1283 				   (char *) &max_user_call_depth,
1284 				   "Set the max call depth for user-defined commands.\n",
1285 				   &setlist),
1286 		      &showlist);
1287 }
1288