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