3 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005
4 Free Software Foundation, Inc.
6 This file is part of GDB.
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.
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.
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. */
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"
33 #include "expression.h"
37 #include "filenames.h" /* for DOSish file names */
45 #include "cli/cli-decode.h"
46 #include "cli/cli-script.h"
47 #include "cli/cli-setshow.h"
48 #include "cli/cli-cmds.h"
51 #include "tui/tui.h" /* For tui_active et.al. */
54 /* Prototypes for local command functions */
56 static void complete_command (char *, int);
58 static void echo_command (char *, int);
60 static void pwd_command (char *, int);
62 static void show_version (char *, int);
64 static void help_command (char *, int);
66 static void show_command (char *, int);
68 static void info_command (char *, int);
70 static void show_debug (char *, int);
72 static void set_debug (char *, int);
74 static void show_user (char *, int);
76 static void make_command (char *, int);
78 static void shell_escape (char *, int);
80 static void edit_command (char *, int);
82 static void list_command (char *, int);
84 void apropos_command (char *, int);
86 /* Prototypes for local utility functions */
88 static void ambiguous_line_spec (struct symtabs_and_lines *);
90 /* Limit the call depth of user-defined commands */
91 int max_user_call_depth;
93 /* Define all cmd_list_elements. */
95 /* Chain containing all defined commands. */
97 struct cmd_list_element *cmdlist;
99 /* Chain containing all defined info subcommands. */
101 struct cmd_list_element *infolist;
103 /* Chain containing all defined enable subcommands. */
105 struct cmd_list_element *enablelist;
107 /* Chain containing all defined disable subcommands. */
109 struct cmd_list_element *disablelist;
111 /* Chain containing all defined toggle subcommands. */
113 struct cmd_list_element *togglelist;
115 /* Chain containing all defined stop subcommands. */
117 struct cmd_list_element *stoplist;
119 /* Chain containing all defined delete subcommands. */
121 struct cmd_list_element *deletelist;
123 /* Chain containing all defined "enable breakpoint" subcommands. */
125 struct cmd_list_element *enablebreaklist;
127 /* Chain containing all defined set subcommands */
129 struct cmd_list_element *setlist;
131 /* Chain containing all defined unset subcommands */
133 struct cmd_list_element *unsetlist;
135 /* Chain containing all defined show subcommands. */
137 struct cmd_list_element *showlist;
139 /* Chain containing all defined \"set history\". */
141 struct cmd_list_element *sethistlist;
143 /* Chain containing all defined \"show history\". */
145 struct cmd_list_element *showhistlist;
147 /* Chain containing all defined \"unset history\". */
149 struct cmd_list_element *unsethistlist;
151 /* Chain containing all defined maintenance subcommands. */
153 struct cmd_list_element *maintenancelist;
155 /* Chain containing all defined "maintenance info" subcommands. */
157 struct cmd_list_element *maintenanceinfolist;
159 /* Chain containing all defined "maintenance print" subcommands. */
161 struct cmd_list_element *maintenanceprintlist;
163 struct cmd_list_element *setprintlist;
165 struct cmd_list_element *showprintlist;
167 struct cmd_list_element *setdebuglist;
169 struct cmd_list_element *showdebuglist;
171 struct cmd_list_element *setchecklist;
173 struct cmd_list_element *showchecklist;
175 /* Utility used everywhere when at least one argument is needed and
179 error_no_arg (char *why)
181 error (_("Argument required (%s)."), why);
184 /* The "info" command is defined as a prefix, with allow_unknown = 0.
185 Therefore, its own definition is called only for "info" with no args. */
188 info_command (char *arg, int from_tty)
190 printf_unfiltered (_("\"info\" must be followed by the name of an info command.\n"));
191 help_list (infolist, "info ", -1, gdb_stdout);
194 /* The "show" command with no arguments shows all the settings. */
197 show_command (char *arg, int from_tty)
199 cmd_show_list (showlist, from_tty, "");
202 /* Provide documentation on command or list given by COMMAND. FROM_TTY
206 help_command (char *command, int from_tty)
208 help_cmd (command, gdb_stdout);
211 /* String compare function for qsort. */
213 compare_strings (const void *arg1, const void *arg2)
215 const char **s1 = (const char **) arg1;
216 const char **s2 = (const char **) arg2;
217 return strcmp (*s1, *s2);
220 /* The "complete" command is used by Emacs to implement completion. */
223 complete_command (char *arg, int from_tty)
227 char **completions, *point, *arg_prefix;
233 argpoint = strlen (arg);
235 /* complete_line assumes that its first argument is somewhere within,
236 and except for filenames at the beginning of, the word to be completed.
237 The following crude imitation of readline's word-breaking tries to
239 point = arg + argpoint;
242 if (strchr (rl_completer_word_break_characters, point[-1]) != 0)
247 arg_prefix = alloca (point - arg + 1);
248 memcpy (arg_prefix, arg, point - arg);
249 arg_prefix[point - arg] = 0;
251 completions = complete_line (point, arg, argpoint);
257 for (size = 0; completions[size]; ++size)
259 qsort (completions, size, sizeof (char *), compare_strings);
261 /* We do extra processing here since we only want to print each
267 printf_unfiltered ("%s%s\n", arg_prefix, completions[item]);
268 next_item = item + 1;
269 while (next_item < size
270 && ! strcmp (completions[item], completions[next_item]))
272 xfree (completions[next_item]);
276 xfree (completions[item]);
285 is_complete_command (struct cmd_list_element *c)
287 return cmd_cfunc_eq (c, complete_command);
291 show_version (char *args, int from_tty)
294 print_gdb_version (gdb_stdout);
295 printf_filtered ("\n");
299 /* Handle the quit command. */
302 quit_command (char *args, int from_tty)
304 if (!quit_confirm ())
305 error (_("Not confirmed."));
306 quit_force (args, from_tty);
310 pwd_command (char *args, int from_tty)
313 error (_("The \"pwd\" command does not take an argument: %s"), args);
314 getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
316 if (strcmp (gdb_dirbuf, current_directory) != 0)
317 printf_unfiltered (_("Working directory %s\n (canonically %s).\n"),
318 current_directory, gdb_dirbuf);
320 printf_unfiltered (_("Working directory %s.\n"), current_directory);
324 cd_command (char *dir, int from_tty)
327 /* Found something other than leading repetitions of "/..". */
331 /* If the new directory is absolute, repeat is a no-op; if relative,
332 repeat might be useful but is more likely to be a mistake. */
336 error_no_arg (_("new working directory"));
338 dir = tilde_expand (dir);
339 make_cleanup (xfree, dir);
342 perror_with_name (dir);
344 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
345 /* There's too much mess with DOSish names like "d:", "d:.",
346 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
347 simply get the canonicalized name of the current directory. */
348 dir = getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
352 if (IS_DIR_SEPARATOR (dir[len - 1]))
354 /* Remove the trailing slash unless this is a root directory
355 (including a drive letter on non-Unix systems). */
356 if (!(len == 1) /* "/" */
357 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
358 && !(len == 3 && dir[1] == ':') /* "d:/" */
364 dir = savestring (dir, len);
365 if (IS_ABSOLUTE_PATH (dir))
366 current_directory = dir;
369 if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
370 current_directory = concat (current_directory, dir, (char *)NULL);
372 current_directory = concat (current_directory, SLASH_STRING,
377 /* Now simplify any occurrences of `.' and `..' in the pathname. */
380 for (p = current_directory; *p;)
382 if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
383 && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
385 else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
386 && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
390 /* Search backwards for the directory just before the "/.."
391 and obliterate it and the "/..". */
393 while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
396 if (q == current_directory)
397 /* current_directory is
398 a relative pathname ("can't happen"--leave it alone). */
402 strcpy (q - 1, p + 3);
407 /* We are dealing with leading repetitions of "/..", for example
408 "/../..", which is the Mach super-root. */
418 forget_cached_source_info ();
421 pwd_command ((char *) 0, 1);
425 source_command (char *args, int from_tty)
428 struct cleanup *old_cleanups;
433 error (_("source command requires pathname of file to source."));
436 file = tilde_expand (file);
437 old_cleanups = make_cleanup (xfree, file);
439 stream = fopen (file, FOPEN_RT);
443 perror_with_name (file);
448 script_from_file (stream, file);
450 do_cleanups (old_cleanups);
454 echo_command (char *text, int from_tty)
460 while ((c = *p++) != '\0')
464 /* \ at end of argument is used after spaces
465 so they won't be lost. */
469 c = parse_escape (&p);
471 printf_filtered ("%c", c);
474 printf_filtered ("%c", c);
477 /* Force this output to appear now. */
479 gdb_flush (gdb_stdout);
483 shell_escape (char *arg, int from_tty)
485 #if defined(CANT_FORK) || \
486 (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_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 : "");
492 arg = "inferior shell";
496 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
497 safe_strerror (errno));
498 gdb_flush (gdb_stderr);
502 fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
503 gdb_flush (gdb_stderr);
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);
510 #else /* Can fork. */
513 if ((pid = vfork ()) == 0)
515 char *p, *user_shell;
517 if ((user_shell = (char *) getenv ("SHELL")) == NULL)
518 user_shell = "/bin/sh";
520 /* Get the name of the shell for arg0 */
521 if ((p = strrchr (user_shell, '/')) == NULL)
524 p++; /* Get past '/' */
527 execl (user_shell, p, (char *) 0);
529 execl (user_shell, p, "-c", arg, (char *) 0);
531 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
532 safe_strerror (errno));
533 gdb_flush (gdb_stderr);
538 while ((rc = wait (&status)) != pid && rc != -1)
541 error (_("Fork failed"));
542 #endif /* Can fork. */
546 edit_command (char *arg, int from_tty)
548 struct symtabs_and_lines sals;
549 struct symtab_and_line sal;
557 /* Pull in the current default source line if necessary */
560 set_default_source_symtab_and_line ();
561 sal = get_current_source_symtab_and_line ();
564 /* bare "edit" edits file with present line. */
569 error (_("No default source file yet."));
570 sal.line += get_lines_to_list () / 2;
575 /* Now should only be one argument -- decode it in SAL */
578 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
580 if (! sals.nelts) return; /* C++ */
581 if (sals.nelts > 1) {
582 ambiguous_line_spec (&sals);
591 error (_("Junk at end of line specification."));
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. */
600 /* FIXME-32x64--assumes sal.pc fits in long. */
601 error (_("No source file for address %s."),
602 hex_string ((unsigned long) sal.pc));
603 sym = find_pc_function (sal.pc);
606 deprecated_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);
613 deprecated_print_address_numeric (sal.pc, 1, gdb_stdout);
614 printf_filtered (" is at %s:%d.\n",
615 sal.symtab->filename, sal.line);
619 /* If what was given does not imply a symtab, it must be an undebuggable
620 symbol which means no source code. */
623 error (_("No line number known for %s."), arg);
626 if ((editor = (char *) getenv ("EDITOR")) == NULL)
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);
633 /* If we don't already know the full absolute file name of the
634 source file, find it now. */
635 if (!sal.symtab->fullname)
637 fn = symtab_to_fullname (sal.symtab);
642 fn = sal.symtab->fullname;
644 /* Quote the file name, in case it has whitespace or other special
646 p = xstrprintf ("%s +%d \"%s\"", editor, sal.line, fn);
647 shell_escape(p, from_tty);
652 list_command (char *arg, int from_tty)
654 struct symtabs_and_lines sals, sals_end;
655 struct symtab_and_line sal = { };
656 struct symtab_and_line sal_end = { };
657 struct symtab_and_line cursal = { };
666 /* Pull in the current default source line if necessary */
667 if (arg == 0 || arg[0] == '+' || arg[0] == '-')
669 set_default_source_symtab_and_line ();
670 cursal = get_current_source_symtab_and_line ();
673 /* "l" or "l +" lists next ten lines. */
675 if (arg == 0 || strcmp (arg, "+") == 0)
677 print_source_lines (cursal.symtab, cursal.line,
678 cursal.line + get_lines_to_list (), 0);
682 /* "l -" lists previous ten lines, the ones before the ten just listed. */
683 if (strcmp (arg, "-") == 0)
685 print_source_lines (cursal.symtab,
686 max (get_first_line_listed () - get_lines_to_list (), 1),
687 get_first_line_listed (), 0);
691 /* Now if there is only one argument, decode it in SAL
693 If there are two arguments, decode them in SAL and SAL_END
694 and clear NO_END; however, if one of the arguments is blank,
695 set DUMMY_BEG or DUMMY_END to record that fact. */
697 if (!have_full_symbols () && !have_partial_symbols ())
698 error (_("No symbol table is loaded. Use the \"file\" command."));
705 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
711 ambiguous_line_spec (&sals);
720 /* Record whether the BEG arg is all digits. */
722 for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
723 linenum_beg = (p == arg1);
725 while (*arg1 == ' ' || *arg1 == '\t')
731 while (*arg1 == ' ' || *arg1 == '\t')
738 sals_end = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
740 sals_end = decode_line_1 (&arg1, 0, sal.symtab, sal.line, 0, 0);
741 if (sals_end.nelts == 0)
743 if (sals_end.nelts > 1)
745 ambiguous_line_spec (&sals_end);
746 xfree (sals_end.sals);
749 sal_end = sals_end.sals[0];
750 xfree (sals_end.sals);
755 error (_("Junk at end of line specification."));
757 if (!no_end && !dummy_beg && !dummy_end
758 && sal.symtab != sal_end.symtab)
759 error (_("Specified start and end are in different files."));
760 if (dummy_beg && dummy_end)
761 error (_("Two empty args do not say what lines to list."));
763 /* if line was specified by address,
764 first print exactly which line, and which file.
765 In this case, sal.symtab == 0 means address is outside
766 of all known source files, not that user failed to give a filename. */
770 /* FIXME-32x64--assumes sal.pc fits in long. */
771 error (_("No source file for address %s."),
772 hex_string ((unsigned long) sal.pc));
773 sym = find_pc_function (sal.pc);
776 deprecated_print_address_numeric (sal.pc, 1, gdb_stdout);
777 printf_filtered (" is in ");
778 fputs_filtered (SYMBOL_PRINT_NAME (sym), gdb_stdout);
779 printf_filtered (" (%s:%d).\n", sal.symtab->filename, sal.line);
783 deprecated_print_address_numeric (sal.pc, 1, gdb_stdout);
784 printf_filtered (" is at %s:%d.\n",
785 sal.symtab->filename, sal.line);
789 /* If line was not specified by just a line number,
790 and it does not imply a symtab, it must be an undebuggable symbol
791 which means no source code. */
793 if (!linenum_beg && sal.symtab == 0)
794 error (_("No line number known for %s."), arg);
796 /* If this command is repeated with RET,
797 turn it into the no-arg variant. */
802 if (dummy_beg && sal_end.symtab == 0)
803 error (_("No default source file yet. Do \"help list\"."));
805 print_source_lines (sal_end.symtab,
806 max (sal_end.line - (get_lines_to_list () - 1), 1),
807 sal_end.line + 1, 0);
808 else if (sal.symtab == 0)
809 error (_("No default source file yet. Do \"help list\"."));
812 int first_line = sal.line - get_lines_to_list () / 2;
814 if (first_line < 1) first_line = 1;
816 print_source_lines (sal.symtab,
818 first_line + get_lines_to_list (),
822 print_source_lines (sal.symtab, sal.line,
824 ? sal.line + get_lines_to_list ()
829 /* Dump a specified section of assembly code. With no command line
830 arguments, this command will dump the assembly code for the
831 function surrounding the pc value in the selected frame. With one
832 argument, it will dump the assembly code surrounding that pc value.
833 Two arguments are interpeted as bounds within which to dump
837 disassemble_command (char *arg, int from_tty)
841 CORE_ADDR pc, pc_masked;
850 if (!deprecated_selected_frame)
851 error (_("No frame selected."));
853 pc = get_frame_pc (deprecated_selected_frame);
854 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
855 error (_("No function contains program counter for selected frame."));
857 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
860 /* FIXME: cagney/2004-02-07: This should be an observer. */
861 low = tui_get_low_disassembly_address (low, pc);
863 low += DEPRECATED_FUNCTION_START_OFFSET;
865 else if (!(space_index = (char *) strchr (arg, ' ')))
868 pc = parse_and_eval_address (arg);
869 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
870 error (_("No function contains specified address."));
872 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
875 /* FIXME: cagney/2004-02-07: This should be an observer. */
876 low = tui_get_low_disassembly_address (low, pc);
878 low += DEPRECATED_FUNCTION_START_OFFSET;
884 low = parse_and_eval_address (arg);
885 high = parse_and_eval_address (space_index + 1);
889 if (!tui_is_window_visible (DISASSEM_WIN))
892 printf_filtered ("Dump of assembler code ");
895 printf_filtered ("for function %s:\n", name);
899 printf_filtered ("from ");
900 deprecated_print_address_numeric (low, 1, gdb_stdout);
901 printf_filtered (" to ");
902 deprecated_print_address_numeric (high, 1, gdb_stdout);
903 printf_filtered (":\n");
906 /* Dump the specified range. */
907 gdb_disassembly (uiout, 0, 0, 0, -1, low, high);
909 printf_filtered ("End of assembler dump.\n");
910 gdb_flush (gdb_stdout);
915 tui_show_assembly (low);
921 make_command (char *arg, int from_tty)
929 p = xmalloc (sizeof ("make ") + strlen (arg));
931 strcpy (p + sizeof ("make ") - 1, arg);
934 shell_escape (p, from_tty);
938 show_user (char *args, int from_tty)
940 struct cmd_list_element *c;
941 extern struct cmd_list_element *cmdlist;
945 c = lookup_cmd (&args, cmdlist, "", 0, 1);
946 if (c->class != class_user)
947 error (_("Not a user command."));
948 show_user_1 (c, gdb_stdout);
952 for (c = cmdlist; c; c = c->next)
954 if (c->class == class_user)
955 show_user_1 (c, gdb_stdout);
960 /* Search through names of commands and documentations for a certain
964 apropos_command (char *searchstr, int from_tty)
966 extern struct cmd_list_element *cmdlist; /*This is the main command list*/
968 char *pattern_fastmap;
969 char errorbuffer[512];
970 pattern_fastmap = xcalloc (256, sizeof (char));
971 if (searchstr == NULL)
972 error (_("REGEXP string is empty"));
974 if (regcomp(&pattern,searchstr,REG_ICASE) == 0)
976 pattern.fastmap=pattern_fastmap;
977 re_compile_fastmap(&pattern);
978 apropos_cmd (gdb_stdout,cmdlist,&pattern,"");
982 regerror(regcomp(&pattern,searchstr,REG_ICASE),NULL,errorbuffer,512);
983 error (_("Error in regular expression:%s"),errorbuffer);
985 xfree (pattern_fastmap);
988 /* Print a list of files and line numbers which a user may choose from
989 in order to list a function which was specified ambiguously (as with
990 `list classname::overloadedfuncname', for example). The vector in
991 SALS provides the filenames and line numbers. */
994 ambiguous_line_spec (struct symtabs_and_lines *sals)
998 for (i = 0; i < sals->nelts; ++i)
999 printf_filtered (_("file: \"%s\", line number: %d\n"),
1000 sals->sals[i].symtab->filename, sals->sals[i].line);
1004 set_debug (char *arg, int from_tty)
1006 printf_unfiltered (_("\"set debug\" must be followed by the name of a print subcommand.\n"));
1007 help_list (setdebuglist, "set debug ", -1, gdb_stdout);
1011 show_debug (char *args, int from_tty)
1013 cmd_show_list (showdebuglist, from_tty, "");
1017 init_cmd_lists (void)
1019 max_user_call_depth = 1024;
1028 enablebreaklist = NULL;
1033 showhistlist = NULL;
1034 unsethistlist = NULL;
1035 maintenancelist = NULL;
1036 maintenanceinfolist = NULL;
1037 maintenanceprintlist = NULL;
1038 setprintlist = NULL;
1039 showprintlist = NULL;
1040 setchecklist = NULL;
1041 showchecklist = NULL;
1045 show_info_verbose (struct ui_file *file, int from_tty,
1046 struct cmd_list_element *c,
1050 fprintf_filtered (file, _("\
1051 Verbose printing of informational messages is %s.\n"), value);
1053 fprintf_filtered (file, _("Verbosity is %s.\n"), value);
1057 show_history_expansion_p (struct ui_file *file, int from_tty,
1058 struct cmd_list_element *c, const char *value)
1060 fprintf_filtered (file, _("History expansion on command input is %s.\n"),
1065 show_baud_rate (struct ui_file *file, int from_tty,
1066 struct cmd_list_element *c, const char *value)
1068 fprintf_filtered (file, _("Baud rate for remote serial I/O is %s.\n"),
1073 show_remote_debug (struct ui_file *file, int from_tty,
1074 struct cmd_list_element *c, const char *value)
1076 fprintf_filtered (file, _("Debugging of remote protocol is %s.\n"),
1081 show_remote_timeout (struct ui_file *file, int from_tty,
1082 struct cmd_list_element *c, const char *value)
1084 fprintf_filtered (file, _("\
1085 Timeout limit to wait for target to respond is %s.\n"),
1090 show_max_user_call_depth (struct ui_file *file, int from_tty,
1091 struct cmd_list_element *c, const char *value)
1093 fprintf_filtered (file, _("\
1094 The max call depth for user-defined commands is %s.\n"),
1100 init_cli_cmds (void)
1102 struct cmd_list_element *c;
1103 char *source_help_text;
1105 /* Define the classes of commands.
1106 They will appear in the help list in the reverse of this order. */
1108 add_cmd ("internals", class_maintenance, NULL, _("\
1109 Maintenance commands.\n\
1110 Some gdb commands are provided just for use by gdb maintainers.\n\
1111 These commands are subject to frequent change, and may not be as\n\
1112 well documented as user commands."),
1114 add_cmd ("obscure", class_obscure, NULL, _("Obscure features."), &cmdlist);
1115 add_cmd ("aliases", class_alias, NULL, _("Aliases of other commands."), &cmdlist);
1116 add_cmd ("user-defined", class_user, NULL, _("\
1117 User-defined commands.\n\
1118 The commands in this class are those defined by the user.\n\
1119 Use the \"define\" command to define a command."), &cmdlist);
1120 add_cmd ("support", class_support, NULL, _("Support facilities."), &cmdlist);
1122 add_cmd ("status", class_info, NULL, _("Status inquiries."), &cmdlist);
1123 add_cmd ("files", class_files, NULL, _("Specifying and examining files."),
1125 add_cmd ("breakpoints", class_breakpoint, NULL,
1126 _("Making program stop at certain points."), &cmdlist);
1127 add_cmd ("data", class_vars, NULL, _("Examining data."), &cmdlist);
1128 add_cmd ("stack", class_stack, NULL, _("\
1129 Examining the stack.\n\
1130 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1131 counting from zero for the innermost (currently executing) frame.\n\n\
1132 At any time gdb identifies one frame as the \"selected\" frame.\n\
1133 Variable lookups are done with respect to the selected frame.\n\
1134 When the program being debugged stops, gdb selects the innermost frame.\n\
1135 The commands below can be used to select other frames by number or address."),
1137 add_cmd ("running", class_run, NULL, _("Running the program."), &cmdlist);
1139 /* Define general commands. */
1141 add_com ("pwd", class_files, pwd_command, _("\
1142 Print working directory. This is used for your program as well."));
1143 c = add_cmd ("cd", class_files, cd_command, _("\
1144 Set working directory to DIR for debugger and program being debugged.\n\
1145 The change does not take effect for the program being debugged\n\
1146 until the next time it is started."), &cmdlist);
1147 set_cmd_completer (c, filename_completer);
1149 add_com ("echo", class_support, echo_command, _("\
1150 Print a constant string. Give string as argument.\n\
1151 C escape sequences may be used in the argument.\n\
1152 No newline is added at the end of the argument;\n\
1153 use \"\\n\" if you want a newline to be printed.\n\
1154 Since leading and trailing whitespace are ignored in command arguments,\n\
1155 if you want to print some you must use \"\\\" before leading whitespace\n\
1156 to be printed or after trailing whitespace."));
1157 add_com ("document", class_support, document_command, _("\
1158 Document a user-defined command.\n\
1159 Give command name as argument. Give documentation on following lines.\n\
1160 End with a line of just \"end\"."));
1161 add_com ("define", class_support, define_command, _("\
1162 Define a new command name. Command name is argument.\n\
1163 Definition appears on following lines, one command per line.\n\
1164 End with a line of just \"end\".\n\
1165 Use the \"document\" command to give documentation for the new command.\n\
1166 Commands defined in this way may have up to ten arguments."));
1168 source_help_text = xstrprintf (_("\
1169 Read commands from a file named FILE.\n\
1170 Note that the file \"%s\" is read automatically in this way\n\
1171 when gdb is started."), gdbinit);
1172 c = add_cmd ("source", class_support, source_command,
1173 source_help_text, &cmdlist);
1174 set_cmd_completer (c, filename_completer);
1176 add_com ("quit", class_support, quit_command, _("Exit gdb."));
1177 c = add_com ("help", class_support, help_command,
1178 _("Print list of commands."));
1179 set_cmd_completer (c, command_completer);
1180 add_com_alias ("q", "quit", class_support, 1);
1181 add_com_alias ("h", "help", class_support, 1);
1183 add_setshow_boolean_cmd ("verbose", class_support, &info_verbose, _("\
1184 Set verbosity."), _("\
1185 Show verbosity."), NULL,
1188 &setlist, &showlist);
1190 add_prefix_cmd ("history", class_support, set_history,
1191 _("Generic command for setting command history parameters."),
1192 &sethistlist, "set history ", 0, &setlist);
1193 add_prefix_cmd ("history", class_support, show_history,
1194 _("Generic command for showing command history parameters."),
1195 &showhistlist, "show history ", 0, &showlist);
1197 add_setshow_boolean_cmd ("expansion", no_class, &history_expansion_p, _("\
1198 Set history expansion on command input."), _("\
1199 Show history expansion on command input."), _("\
1200 Without an argument, history expansion is enabled."),
1202 show_history_expansion_p,
1203 &sethistlist, &showhistlist);
1205 add_prefix_cmd ("info", class_info, info_command, _("\
1206 Generic command for showing things about the program being debugged."),
1207 &infolist, "info ", 0, &cmdlist);
1208 add_com_alias ("i", "info", class_info, 1);
1210 add_com ("complete", class_obscure, complete_command,
1211 _("List the completions for the rest of the line as a command."));
1213 add_prefix_cmd ("show", class_info, show_command,
1214 _("Generic command for showing things about the debugger."),
1215 &showlist, "show ", 0, &cmdlist);
1216 /* Another way to get at the same thing. */
1217 add_info ("set", show_command, _("Show all GDB settings."));
1219 add_cmd ("commands", no_class, show_commands, _("\
1220 Show the history of commands you typed.\n\
1221 You can supply a command number to start with, or a `+' to start after\n\
1222 the previous command number shown."),
1225 add_cmd ("version", no_class, show_version,
1226 _("Show what version of GDB this is."), &showlist);
1228 add_com ("while", class_support, while_command, _("\
1229 Execute nested commands WHILE the conditional expression is non zero.\n\
1230 The conditional expression must follow the word `while' and must in turn be\n\
1231 followed by a new line. The nested commands must be entered one per line,\n\
1232 and should be terminated by the word `end'."));
1234 add_com ("if", class_support, if_command, _("\
1235 Execute nested commands once IF the conditional expression is non zero.\n\
1236 The conditional expression must follow the word `if' and must in turn be\n\
1237 followed by a new line. The nested commands must be entered one per line,\n\
1238 and should be terminated by the word 'else' or `end'. If an else clause\n\
1239 is used, the same rules apply to its nested commands as to the first ones."));
1241 /* If target is open when baud changes, it doesn't take effect until the
1242 next open (I think, not sure). */
1243 add_setshow_zinteger_cmd ("remotebaud", no_class, &baud_rate, _("\
1244 Set baud rate for remote serial I/O."), _("\
1245 Show baud rate for remote serial I/O."), _("\
1246 This value is used to set the speed of the serial port when debugging\n\
1247 using remote targets."),
1250 &setlist, &showlist);
1252 add_setshow_zinteger_cmd ("remote", no_class, &remote_debug, _("\
1253 Set debugging of remote protocol."), _("\
1254 Show debugging of remote protocol."), _("\
1255 When enabled, each packet sent or received with the remote target\n\
1259 &setdebuglist, &showdebuglist);
1261 add_setshow_integer_cmd ("remotetimeout", no_class, &remote_timeout, _("\
1262 Set timeout limit to wait for target to respond."), _("\
1263 Show timeout limit to wait for target to respond."), _("\
1264 This value is used to set the time limit for gdb to wait for a response\n\
1267 show_remote_timeout,
1268 &setlist, &showlist);
1270 add_prefix_cmd ("debug", no_class, set_debug,
1271 _("Generic command for setting gdb debugging flags"),
1272 &setdebuglist, "set debug ", 0, &setlist);
1274 add_prefix_cmd ("debug", no_class, show_debug,
1275 _("Generic command for showing gdb debugging flags"),
1276 &showdebuglist, "show debug ", 0, &showlist);
1278 c = add_com ("shell", class_support, shell_escape, _("\
1279 Execute the rest of the line as a shell command.\n\
1280 With no arguments, run an inferior shell."));
1281 set_cmd_completer (c, filename_completer);
1283 c = add_com ("edit", class_files, edit_command, _("\
1284 Edit specified file or function.\n\
1285 With no argument, edits file containing most recent line listed.\n\
1286 Editing targets can be specified in these ways:\n\
1287 FILE:LINENUM, to edit at that line in that file,\n\
1288 FUNCTION, to edit at the beginning of that function,\n\
1289 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1290 *ADDRESS, to edit at the line containing that address.\n\
1291 Uses EDITOR environment variable contents as editor (or ex as default)."));
1293 c->completer = location_completer;
1295 add_com ("list", class_files, list_command, _("\
1296 List specified function or line.\n\
1297 With no argument, lists ten more lines after or around previous listing.\n\
1298 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1299 One argument specifies a line, and ten lines are listed around that line.\n\
1300 Two arguments with comma between specify starting and ending lines to list.\n\
1301 Lines can be specified in these ways:\n\
1302 LINENUM, to list around that line in current file,\n\
1303 FILE:LINENUM, to list around that line in that file,\n\
1304 FUNCTION, to list around beginning of that function,\n\
1305 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1306 *ADDRESS, to list around the line containing that address.\n\
1307 With two args if one is empty it stands for ten lines away from the other arg."));
1310 add_com_alias ("l", "list", class_files, 1);
1312 add_com_alias ("v", "list", class_files, 1);
1315 add_com_alias ("file", "list", class_files, 1);
1317 c = add_com ("disassemble", class_vars, disassemble_command, _("\
1318 Disassemble a specified section of memory.\n\
1319 Default is the function surrounding the pc of the selected frame.\n\
1320 With a single argument, the function surrounding that address is dumped.\n\
1321 Two arguments are taken as a range of memory to dump."));
1322 set_cmd_completer (c, location_completer);
1324 add_com_alias ("va", "disassemble", class_xdb, 0);
1326 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1327 be a really useful feature. Unfortunately, the below wont do
1328 this. Instead it adds support for the form ``(gdb) ! ls''
1329 (i.e. the space is required). If the ``!'' command below is
1330 added the complains about no ``!'' command would be replaced by
1331 complains about how the ``!'' command is broken :-) */
1333 add_com_alias ("!", "shell", class_support, 0);
1335 c = add_com ("make", class_support, make_command, _("\
1336 Run the ``make'' program using the rest of the line as arguments."));
1337 set_cmd_completer (c, filename_completer);
1338 add_cmd ("user", no_class, show_user, _("\
1339 Show definitions of user defined commands.\n\
1340 Argument is the name of the user defined command.\n\
1341 With no argument, show definitions of all user defined commands."), &showlist);
1342 add_com ("apropos", class_support, apropos_command,
1343 _("Search for commands matching a REGEXP"));
1345 add_setshow_integer_cmd ("max-user-call-depth", no_class,
1346 &max_user_call_depth, _("\
1347 Set the max call depth for user-defined commands."), _("\
1348 Show the max call depth for user-defined commands."), NULL,
1350 show_max_user_call_depth,
1351 &setlist, &showlist);