3 Copyright 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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. */
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"
32 #include "expression.h"
36 #include "filenames.h" /* for DOSish file names */
44 #include "cli/cli-decode.h"
45 #include "cli/cli-script.h"
46 #include "cli/cli-setshow.h"
47 #include "cli/cli-cmds.h"
50 #include "tui/tui.h" /* For tui_active et.al. */
53 #ifndef GDBINIT_FILENAME
54 #define GDBINIT_FILENAME ".gdbinit"
57 /* Prototypes for local command functions */
59 static void complete_command (char *, int);
61 static void echo_command (char *, int);
63 static void pwd_command (char *, int);
65 static void show_version (char *, int);
67 static void help_command (char *, int);
69 static void show_command (char *, int);
71 static void info_command (char *, int);
73 static void show_debug (char *, int);
75 static void set_debug (char *, int);
77 static void show_user (char *, int);
79 static void make_command (char *, int);
81 static void shell_escape (char *, int);
83 static void edit_command (char *, int);
85 static void list_command (char *, int);
87 void apropos_command (char *, int);
89 /* Prototypes for local utility functions */
91 static void ambiguous_line_spec (struct symtabs_and_lines *);
93 /* Limit the call depth of user-defined commands */
94 int max_user_call_depth;
96 /* Define all cmd_list_elements. */
98 /* Chain containing all defined commands. */
100 struct cmd_list_element *cmdlist;
102 /* Chain containing all defined info subcommands. */
104 struct cmd_list_element *infolist;
106 /* Chain containing all defined enable subcommands. */
108 struct cmd_list_element *enablelist;
110 /* Chain containing all defined disable subcommands. */
112 struct cmd_list_element *disablelist;
114 /* Chain containing all defined toggle subcommands. */
116 struct cmd_list_element *togglelist;
118 /* Chain containing all defined stop subcommands. */
120 struct cmd_list_element *stoplist;
122 /* Chain containing all defined delete subcommands. */
124 struct cmd_list_element *deletelist;
126 /* Chain containing all defined "enable breakpoint" subcommands. */
128 struct cmd_list_element *enablebreaklist;
130 /* Chain containing all defined set subcommands */
132 struct cmd_list_element *setlist;
134 /* Chain containing all defined unset subcommands */
136 struct cmd_list_element *unsetlist;
138 /* Chain containing all defined show subcommands. */
140 struct cmd_list_element *showlist;
142 /* Chain containing all defined \"set history\". */
144 struct cmd_list_element *sethistlist;
146 /* Chain containing all defined \"show history\". */
148 struct cmd_list_element *showhistlist;
150 /* Chain containing all defined \"unset history\". */
152 struct cmd_list_element *unsethistlist;
154 /* Chain containing all defined maintenance subcommands. */
156 struct cmd_list_element *maintenancelist;
158 /* Chain containing all defined "maintenance info" subcommands. */
160 struct cmd_list_element *maintenanceinfolist;
162 /* Chain containing all defined "maintenance print" subcommands. */
164 struct cmd_list_element *maintenanceprintlist;
166 struct cmd_list_element *setprintlist;
168 struct cmd_list_element *showprintlist;
170 struct cmd_list_element *setdebuglist;
172 struct cmd_list_element *showdebuglist;
174 struct cmd_list_element *setchecklist;
176 struct cmd_list_element *showchecklist;
178 /* Utility used everywhere when at least one argument is needed and
182 error_no_arg (char *why)
184 error (_("Argument required (%s)."), why);
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. */
191 info_command (char *arg, int from_tty)
193 printf_unfiltered (_("\"info\" must be followed by the name of an info command.\n"));
194 help_list (infolist, "info ", -1, gdb_stdout);
197 /* The "show" command with no arguments shows all the settings. */
200 show_command (char *arg, int from_tty)
202 cmd_show_list (showlist, from_tty, "");
205 /* Provide documentation on command or list given by COMMAND. FROM_TTY
209 help_command (char *command, int from_tty)
211 help_cmd (command, gdb_stdout);
214 /* String compare function for qsort. */
216 compare_strings (const void *arg1, const void *arg2)
218 const char **s1 = (const char **) arg1;
219 const char **s2 = (const char **) arg2;
220 return strcmp (*s1, *s2);
223 /* The "complete" command is used by Emacs to implement completion. */
226 complete_command (char *arg, int from_tty)
230 char **completions, *point, *arg_prefix;
236 argpoint = strlen (arg);
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
242 point = arg + argpoint;
245 if (strchr (rl_completer_word_break_characters, point[-1]) != 0)
250 arg_prefix = alloca (point - arg + 1);
251 memcpy (arg_prefix, arg, point - arg);
252 arg_prefix[point - arg] = 0;
254 completions = complete_line (point, arg, argpoint);
260 for (size = 0; completions[size]; ++size)
262 qsort (completions, size, sizeof (char *), compare_strings);
264 /* We do extra processing here since we only want to print each
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]))
275 xfree (completions[next_item]);
279 xfree (completions[item]);
288 is_complete_command (struct cmd_list_element *c)
290 return cmd_cfunc_eq (c, complete_command);
294 show_version (char *args, int from_tty)
297 print_gdb_version (gdb_stdout);
298 printf_filtered ("\n");
302 /* Handle the quit command. */
305 quit_command (char *args, int from_tty)
307 if (!quit_confirm ())
308 error (_("Not confirmed."));
309 quit_force (args, from_tty);
313 pwd_command (char *args, int from_tty)
316 error (_("The \"pwd\" command does not take an argument: %s"), args);
317 getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
319 if (strcmp (gdb_dirbuf, current_directory) != 0)
320 printf_unfiltered (_("Working directory %s\n (canonically %s).\n"),
321 current_directory, gdb_dirbuf);
323 printf_unfiltered (_("Working directory %s.\n"), current_directory);
327 cd_command (char *dir, int from_tty)
330 /* Found something other than leading repetitions of "/..". */
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. */
339 error_no_arg (_("new working directory"));
341 dir = tilde_expand (dir);
342 make_cleanup (xfree, dir);
345 perror_with_name (dir);
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));
355 if (IS_DIR_SEPARATOR (dir[len - 1]))
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:/" */
367 dir = savestring (dir, len);
368 if (IS_ABSOLUTE_PATH (dir))
369 current_directory = dir;
372 if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
373 current_directory = concat (current_directory, dir, NULL);
375 current_directory = concat (current_directory, SLASH_STRING, dir, NULL);
379 /* Now simplify any occurrences of `.' and `..' in the pathname. */
382 for (p = current_directory; *p;)
384 if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
385 && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
387 else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
388 && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
392 /* Search backwards for the directory just before the "/.."
393 and obliterate it and the "/..". */
395 while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
398 if (q == current_directory)
399 /* current_directory is
400 a relative pathname ("can't happen"--leave it alone). */
404 strcpy (q - 1, p + 3);
409 /* We are dealing with leading repetitions of "/..", for example
410 "/../..", which is the Mach super-root. */
420 forget_cached_source_info ();
423 pwd_command ((char *) 0, 1);
427 source_command (char *args, int from_tty)
430 struct cleanup *old_cleanups;
435 error (_("source command requires pathname of file to source."));
438 file = tilde_expand (file);
439 old_cleanups = make_cleanup (xfree, file);
441 stream = fopen (file, FOPEN_RT);
445 perror_with_name (file);
450 script_from_file (stream, file);
452 do_cleanups (old_cleanups);
456 echo_command (char *text, int from_tty)
462 while ((c = *p++) != '\0')
466 /* \ at end of argument is used after spaces
467 so they won't be lost. */
471 c = parse_escape (&p);
473 printf_filtered ("%c", c);
476 printf_filtered ("%c", c);
479 /* Force this output to appear now. */
481 gdb_flush (gdb_stdout);
485 shell_escape (char *arg, int from_tty)
487 #if defined(CANT_FORK) || \
488 (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
489 /* If ARG is NULL, they want an inferior shell, but `system' just
490 reports if the shell is available when passed a NULL arg. */
491 int rc = system (arg ? arg : "");
494 arg = "inferior shell";
498 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
499 safe_strerror (errno));
500 gdb_flush (gdb_stderr);
504 fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
505 gdb_flush (gdb_stderr);
508 /* Make sure to return to the directory GDB thinks it is, in case the
509 shell command we just ran changed it. */
510 chdir (current_directory);
512 #else /* Can fork. */
515 if ((pid = vfork ()) == 0)
517 char *p, *user_shell;
519 if ((user_shell = (char *) getenv ("SHELL")) == NULL)
520 user_shell = "/bin/sh";
522 /* Get the name of the shell for arg0 */
523 if ((p = strrchr (user_shell, '/')) == NULL)
526 p++; /* Get past '/' */
529 execl (user_shell, p, (char *) 0);
531 execl (user_shell, p, "-c", arg, (char *) 0);
533 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
534 safe_strerror (errno));
535 gdb_flush (gdb_stderr);
540 while ((rc = wait (&status)) != pid && rc != -1)
543 error (_("Fork failed"));
544 #endif /* Can fork. */
548 edit_command (char *arg, int from_tty)
550 struct symtabs_and_lines sals;
551 struct symtab_and_line sal;
559 /* Pull in the current default source line if necessary */
562 set_default_source_symtab_and_line ();
563 sal = get_current_source_symtab_and_line ();
566 /* bare "edit" edits file with present line. */
571 error (_("No default source file yet."));
572 sal.line += get_lines_to_list () / 2;
577 /* Now should only be one argument -- decode it in SAL */
580 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
582 if (! sals.nelts) return; /* C++ */
583 if (sals.nelts > 1) {
584 ambiguous_line_spec (&sals);
593 error (_("Junk at end of line specification."));
595 /* if line was specified by address,
596 first print exactly which line, and which file.
597 In this case, sal.symtab == 0 means address is outside
598 of all known source files, not that user failed to give a filename. */
602 /* FIXME-32x64--assumes sal.pc fits in long. */
603 error (_("No source file for address %s."),
604 hex_string ((unsigned long) sal.pc));
605 sym = find_pc_function (sal.pc);
608 deprecated_print_address_numeric (sal.pc, 1, gdb_stdout);
609 printf_filtered (" is in ");
610 fputs_filtered (SYMBOL_PRINT_NAME (sym), gdb_stdout);
611 printf_filtered (" (%s:%d).\n", sal.symtab->filename, sal.line);
615 deprecated_print_address_numeric (sal.pc, 1, gdb_stdout);
616 printf_filtered (" is at %s:%d.\n",
617 sal.symtab->filename, sal.line);
621 /* If what was given does not imply a symtab, it must be an undebuggable
622 symbol which means no source code. */
625 error (_("No line number known for %s."), arg);
628 if ((editor = (char *) getenv ("EDITOR")) == NULL)
631 /* Approximate base-10 log of line to 1 unit for digit count */
632 for(log10=32, m=0x80000000; !(sal.line & m) && log10>0; log10--, m=m>>1);
633 log10 = 1 + (int)((log10 + (0 == ((m-1) & sal.line)))/3.32192809);
635 /* If we don't already know the full absolute file name of the
636 source file, find it now. */
637 if (!sal.symtab->fullname)
639 fn = symtab_to_fullname (sal.symtab);
644 fn = sal.symtab->fullname;
646 /* Quote the file name, in case it has whitespace or other special
648 p = xstrprintf ("%s +%d \"%s\"", editor, sal.line, fn);
649 shell_escape(p, from_tty);
654 list_command (char *arg, int from_tty)
656 struct symtabs_and_lines sals, sals_end;
657 struct symtab_and_line sal, sal_end, 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;
1104 /* Define the classes of commands.
1105 They will appear in the help list in the reverse of this order. */
1107 add_cmd ("internals", class_maintenance, NULL, _("\
1108 Maintenance commands.\n\
1109 Some gdb commands are provided just for use by gdb maintainers.\n\
1110 These commands are subject to frequent change, and may not be as\n\
1111 well documented as user commands."),
1113 add_cmd ("obscure", class_obscure, NULL, _("Obscure features."), &cmdlist);
1114 add_cmd ("aliases", class_alias, NULL, _("Aliases of other commands."), &cmdlist);
1115 add_cmd ("user-defined", class_user, NULL, _("\
1116 User-defined commands.\n\
1117 The commands in this class are those defined by the user.\n\
1118 Use the \"define\" command to define a command."), &cmdlist);
1119 add_cmd ("support", class_support, NULL, _("Support facilities."), &cmdlist);
1121 add_cmd ("status", class_info, NULL, _("Status inquiries."), &cmdlist);
1122 add_cmd ("files", class_files, NULL, _("Specifying and examining files."),
1124 add_cmd ("breakpoints", class_breakpoint, NULL,
1125 _("Making program stop at certain points."), &cmdlist);
1126 add_cmd ("data", class_vars, NULL, _("Examining data."), &cmdlist);
1127 add_cmd ("stack", class_stack, NULL, _("\
1128 Examining the stack.\n\
1129 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1130 counting from zero for the innermost (currently executing) frame.\n\n\
1131 At any time gdb identifies one frame as the \"selected\" frame.\n\
1132 Variable lookups are done with respect to the selected frame.\n\
1133 When the program being debugged stops, gdb selects the innermost frame.\n\
1134 The commands below can be used to select other frames by number or address."),
1136 add_cmd ("running", class_run, NULL, _("Running the program."), &cmdlist);
1138 /* Define general commands. */
1140 add_com ("pwd", class_files, pwd_command, _("\
1141 Print working directory. This is used for your program as well."));
1142 c = add_cmd ("cd", class_files, cd_command, _("\
1143 Set working directory to DIR for debugger and program being debugged.\n\
1144 The change does not take effect for the program being debugged\n\
1145 until the next time it is started."), &cmdlist);
1146 set_cmd_completer (c, filename_completer);
1148 add_com ("echo", class_support, echo_command, _("\
1149 Print a constant string. Give string as argument.\n\
1150 C escape sequences may be used in the argument.\n\
1151 No newline is added at the end of the argument;\n\
1152 use \"\\n\" if you want a newline to be printed.\n\
1153 Since leading and trailing whitespace are ignored in command arguments,\n\
1154 if you want to print some you must use \"\\\" before leading whitespace\n\
1155 to be printed or after trailing whitespace."));
1156 add_com ("document", class_support, document_command, _("\
1157 Document a user-defined command.\n\
1158 Give command name as argument. Give documentation on following lines.\n\
1159 End with a line of just \"end\"."));
1160 add_com ("define", class_support, define_command, _("\
1161 Define a new command name. Command name is argument.\n\
1162 Definition appears on following lines, one command per line.\n\
1163 End with a line of just \"end\".\n\
1164 Use the \"document\" command to give documentation for the new command.\n\
1165 Commands defined in this way may have up to ten arguments."));
1167 c = add_cmd ("source", class_support, source_command, _("\
1168 Read commands from a file named FILE.\n\
1169 Note that the file \"" GDBINIT_FILENAME "\" is read automatically in this way\n\
1170 when gdb is started."), &cmdlist);
1171 set_cmd_completer (c, filename_completer);
1173 add_com ("quit", class_support, quit_command, _("Exit gdb."));
1174 c = add_com ("help", class_support, help_command,
1175 _("Print list of commands."));
1176 set_cmd_completer (c, command_completer);
1177 add_com_alias ("q", "quit", class_support, 1);
1178 add_com_alias ("h", "help", class_support, 1);
1180 add_setshow_boolean_cmd ("verbose", class_support, &info_verbose, _("\
1181 Set verbosity."), _("\
1182 Show verbosity."), NULL,
1185 &setlist, &showlist);
1187 add_prefix_cmd ("history", class_support, set_history,
1188 _("Generic command for setting command history parameters."),
1189 &sethistlist, "set history ", 0, &setlist);
1190 add_prefix_cmd ("history", class_support, show_history,
1191 _("Generic command for showing command history parameters."),
1192 &showhistlist, "show history ", 0, &showlist);
1194 add_setshow_boolean_cmd ("expansion", no_class, &history_expansion_p, _("\
1195 Set history expansion on command input."), _("\
1196 Show history expansion on command input."), _("\
1197 Without an argument, history expansion is enabled."),
1199 show_history_expansion_p,
1200 &sethistlist, &showhistlist);
1202 add_prefix_cmd ("info", class_info, info_command, _("\
1203 Generic command for showing things about the program being debugged."),
1204 &infolist, "info ", 0, &cmdlist);
1205 add_com_alias ("i", "info", class_info, 1);
1207 add_com ("complete", class_obscure, complete_command,
1208 _("List the completions for the rest of the line as a command."));
1210 add_prefix_cmd ("show", class_info, show_command,
1211 _("Generic command for showing things about the debugger."),
1212 &showlist, "show ", 0, &cmdlist);
1213 /* Another way to get at the same thing. */
1214 add_info ("set", show_command, _("Show all GDB settings."));
1216 add_cmd ("commands", no_class, show_commands, _("\
1217 Show the history of commands you typed.\n\
1218 You can supply a command number to start with, or a `+' to start after\n\
1219 the previous command number shown."),
1222 add_cmd ("version", no_class, show_version,
1223 _("Show what version of GDB this is."), &showlist);
1225 add_com ("while", class_support, while_command, _("\
1226 Execute nested commands WHILE the conditional expression is non zero.\n\
1227 The conditional expression must follow the word `while' and must in turn be\n\
1228 followed by a new line. The nested commands must be entered one per line,\n\
1229 and should be terminated by the word `end'."));
1231 add_com ("if", class_support, if_command, _("\
1232 Execute nested commands once IF the conditional expression is non zero.\n\
1233 The conditional expression must follow the word `if' and must in turn be\n\
1234 followed by a new line. The nested commands must be entered one per line,\n\
1235 and should be terminated by the word 'else' or `end'. If an else clause\n\
1236 is used, the same rules apply to its nested commands as to the first ones."));
1238 /* If target is open when baud changes, it doesn't take effect until the
1239 next open (I think, not sure). */
1240 add_setshow_zinteger_cmd ("remotebaud", no_class, &baud_rate, _("\
1241 Set baud rate for remote serial I/O."), _("\
1242 Show baud rate for remote serial I/O."), _("\
1243 This value is used to set the speed of the serial port when debugging\n\
1244 using remote targets."),
1247 &setlist, &showlist);
1249 add_setshow_zinteger_cmd ("remote", no_class, &remote_debug, _("\
1250 Set debugging of remote protocol."), _("\
1251 Show debugging of remote protocol."), _("\
1252 When enabled, each packet sent or received with the remote target\n\
1256 &setdebuglist, &showdebuglist);
1258 add_setshow_integer_cmd ("remotetimeout", no_class, &remote_timeout, _("\
1259 Set timeout limit to wait for target to respond."), _("\
1260 Show timeout limit to wait for target to respond."), _("\
1261 This value is used to set the time limit for gdb to wait for a response\n\
1264 show_remote_timeout,
1265 &setlist, &showlist);
1267 add_prefix_cmd ("debug", no_class, set_debug,
1268 _("Generic command for setting gdb debugging flags"),
1269 &setdebuglist, "set debug ", 0, &setlist);
1271 add_prefix_cmd ("debug", no_class, show_debug,
1272 _("Generic command for showing gdb debugging flags"),
1273 &showdebuglist, "show debug ", 0, &showlist);
1275 c = add_com ("shell", class_support, shell_escape, _("\
1276 Execute the rest of the line as a shell command.\n\
1277 With no arguments, run an inferior shell."));
1278 set_cmd_completer (c, filename_completer);
1280 c = add_com ("edit", class_files, edit_command, _("\
1281 Edit specified file or function.\n\
1282 With no argument, edits file containing most recent line listed.\n\
1283 Editing targets can be specified in these ways:\n\
1284 FILE:LINENUM, to edit at that line in that file,\n\
1285 FUNCTION, to edit at the beginning of that function,\n\
1286 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1287 *ADDRESS, to edit at the line containing that address.\n\
1288 Uses EDITOR environment variable contents as editor (or ex as default)."));
1290 c->completer = location_completer;
1292 add_com ("list", class_files, list_command, _("\
1293 List specified function or line.\n\
1294 With no argument, lists ten more lines after or around previous listing.\n\
1295 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1296 One argument specifies a line, and ten lines are listed around that line.\n\
1297 Two arguments with comma between specify starting and ending lines to list.\n\
1298 Lines can be specified in these ways:\n\
1299 LINENUM, to list around that line in current file,\n\
1300 FILE:LINENUM, to list around that line in that file,\n\
1301 FUNCTION, to list around beginning of that function,\n\
1302 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1303 *ADDRESS, to list around the line containing that address.\n\
1304 With two args if one is empty it stands for ten lines away from the other arg."));
1307 add_com_alias ("l", "list", class_files, 1);
1309 add_com_alias ("v", "list", class_files, 1);
1312 add_com_alias ("file", "list", class_files, 1);
1314 c = add_com ("disassemble", class_vars, disassemble_command, _("\
1315 Disassemble a specified section of memory.\n\
1316 Default is the function surrounding the pc of the selected frame.\n\
1317 With a single argument, the function surrounding that address is dumped.\n\
1318 Two arguments are taken as a range of memory to dump."));
1319 set_cmd_completer (c, location_completer);
1321 add_com_alias ("va", "disassemble", class_xdb, 0);
1323 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1324 be a really useful feature. Unfortunately, the below wont do
1325 this. Instead it adds support for the form ``(gdb) ! ls''
1326 (i.e. the space is required). If the ``!'' command below is
1327 added the complains about no ``!'' command would be replaced by
1328 complains about how the ``!'' command is broken :-) */
1330 add_com_alias ("!", "shell", class_support, 0);
1332 c = add_com ("make", class_support, make_command, _("\
1333 Run the ``make'' program using the rest of the line as arguments."));
1334 set_cmd_completer (c, filename_completer);
1335 add_cmd ("user", no_class, show_user, _("\
1336 Show definitions of user defined commands.\n\
1337 Argument is the name of the user defined command.\n\
1338 With no argument, show definitions of all user defined commands."), &showlist);
1339 add_com ("apropos", class_support, apropos_command,
1340 _("Search for commands matching a REGEXP"));
1342 add_setshow_integer_cmd ("max-user-call-depth", no_class,
1343 &max_user_call_depth, _("\
1344 Set the max call depth for user-defined commands."), _("\
1345 Show the max call depth for user-defined commands."), NULL,
1347 show_max_user_call_depth,
1348 &setlist, &showlist);