3 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2007
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. */
56 /* Prototypes for local command functions */
58 static void complete_command (char *, int);
60 static void echo_command (char *, int);
62 static void pwd_command (char *, int);
64 static void show_version (char *, int);
66 static void help_command (char *, int);
68 static void show_command (char *, int);
70 static void info_command (char *, int);
72 static void show_debug (char *, int);
74 static void set_debug (char *, int);
76 static void show_user (char *, int);
78 static void make_command (char *, int);
80 static void shell_escape (char *, int);
82 static void edit_command (char *, int);
84 static void list_command (char *, int);
86 void apropos_command (char *, int);
88 /* Prototypes for local utility functions */
90 static void ambiguous_line_spec (struct symtabs_and_lines *);
92 /* Limit the call depth of user-defined commands */
93 int max_user_call_depth;
95 /* Define all cmd_list_elements. */
97 /* Chain containing all defined commands. */
99 struct cmd_list_element *cmdlist;
101 /* Chain containing all defined info subcommands. */
103 struct cmd_list_element *infolist;
105 /* Chain containing all defined enable subcommands. */
107 struct cmd_list_element *enablelist;
109 /* Chain containing all defined disable subcommands. */
111 struct cmd_list_element *disablelist;
113 /* Chain containing all defined toggle subcommands. */
115 struct cmd_list_element *togglelist;
117 /* Chain containing all defined stop subcommands. */
119 struct cmd_list_element *stoplist;
121 /* Chain containing all defined delete subcommands. */
123 struct cmd_list_element *deletelist;
125 /* Chain containing all defined detach subcommands. */
127 struct cmd_list_element *detachlist;
129 /* Chain containing all defined "enable breakpoint" subcommands. */
131 struct cmd_list_element *enablebreaklist;
133 /* Chain containing all defined set subcommands */
135 struct cmd_list_element *setlist;
137 /* Chain containing all defined unset subcommands */
139 struct cmd_list_element *unsetlist;
141 /* Chain containing all defined show subcommands. */
143 struct cmd_list_element *showlist;
145 /* Chain containing all defined \"set history\". */
147 struct cmd_list_element *sethistlist;
149 /* Chain containing all defined \"show history\". */
151 struct cmd_list_element *showhistlist;
153 /* Chain containing all defined \"unset history\". */
155 struct cmd_list_element *unsethistlist;
157 /* Chain containing all defined maintenance subcommands. */
159 struct cmd_list_element *maintenancelist;
161 /* Chain containing all defined "maintenance info" subcommands. */
163 struct cmd_list_element *maintenanceinfolist;
165 /* Chain containing all defined "maintenance print" subcommands. */
167 struct cmd_list_element *maintenanceprintlist;
169 struct cmd_list_element *setprintlist;
171 struct cmd_list_element *showprintlist;
173 struct cmd_list_element *setdebuglist;
175 struct cmd_list_element *showdebuglist;
177 struct cmd_list_element *setchecklist;
179 struct cmd_list_element *showchecklist;
181 /* Command tracing state. */
183 int source_verbose = 0;
184 int trace_commands = 0;
186 /* Utility used everywhere when at least one argument is needed and
190 error_no_arg (char *why)
192 error (_("Argument required (%s)."), why);
195 /* The "info" command is defined as a prefix, with allow_unknown = 0.
196 Therefore, its own definition is called only for "info" with no args. */
199 info_command (char *arg, int from_tty)
201 printf_unfiltered (_("\"info\" must be followed by the name of an info command.\n"));
202 help_list (infolist, "info ", -1, gdb_stdout);
205 /* The "show" command with no arguments shows all the settings. */
208 show_command (char *arg, int from_tty)
210 cmd_show_list (showlist, from_tty, "");
213 /* Provide documentation on command or list given by COMMAND. FROM_TTY
217 help_command (char *command, int from_tty)
219 help_cmd (command, gdb_stdout);
222 /* String compare function for qsort. */
224 compare_strings (const void *arg1, const void *arg2)
226 const char **s1 = (const char **) arg1;
227 const char **s2 = (const char **) arg2;
228 return strcmp (*s1, *s2);
231 /* The "complete" command is used by Emacs to implement completion. */
234 complete_command (char *arg, int from_tty)
238 char **completions, *point, *arg_prefix;
244 argpoint = strlen (arg);
246 /* complete_line assumes that its first argument is somewhere within,
247 and except for filenames at the beginning of, the word to be completed.
248 The following crude imitation of readline's word-breaking tries to
250 point = arg + argpoint;
253 if (strchr (rl_completer_word_break_characters, point[-1]) != 0)
258 arg_prefix = alloca (point - arg + 1);
259 memcpy (arg_prefix, arg, point - arg);
260 arg_prefix[point - arg] = 0;
262 completions = complete_line (point, arg, argpoint);
268 for (size = 0; completions[size]; ++size)
270 qsort (completions, size, sizeof (char *), compare_strings);
272 /* We do extra processing here since we only want to print each
278 printf_unfiltered ("%s%s\n", arg_prefix, completions[item]);
279 next_item = item + 1;
280 while (next_item < size
281 && ! strcmp (completions[item], completions[next_item]))
283 xfree (completions[next_item]);
287 xfree (completions[item]);
296 is_complete_command (struct cmd_list_element *c)
298 return cmd_cfunc_eq (c, complete_command);
302 show_version (char *args, int from_tty)
305 print_gdb_version (gdb_stdout);
306 printf_filtered ("\n");
310 /* Handle the quit command. */
313 quit_command (char *args, int from_tty)
315 if (!quit_confirm ())
316 error (_("Not confirmed."));
317 quit_force (args, from_tty);
321 pwd_command (char *args, int from_tty)
324 error (_("The \"pwd\" command does not take an argument: %s"), args);
325 getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
327 if (strcmp (gdb_dirbuf, current_directory) != 0)
328 printf_unfiltered (_("Working directory %s\n (canonically %s).\n"),
329 current_directory, gdb_dirbuf);
331 printf_unfiltered (_("Working directory %s.\n"), current_directory);
335 cd_command (char *dir, int from_tty)
338 /* Found something other than leading repetitions of "/..". */
342 /* If the new directory is absolute, repeat is a no-op; if relative,
343 repeat might be useful but is more likely to be a mistake. */
347 error_no_arg (_("new working directory"));
349 dir = tilde_expand (dir);
350 make_cleanup (xfree, dir);
353 perror_with_name (dir);
355 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
356 /* There's too much mess with DOSish names like "d:", "d:.",
357 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
358 simply get the canonicalized name of the current directory. */
359 dir = getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
363 if (IS_DIR_SEPARATOR (dir[len - 1]))
365 /* Remove the trailing slash unless this is a root directory
366 (including a drive letter on non-Unix systems). */
367 if (!(len == 1) /* "/" */
368 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
369 && !(len == 3 && dir[1] == ':') /* "d:/" */
375 dir = savestring (dir, len);
376 if (IS_ABSOLUTE_PATH (dir))
377 current_directory = dir;
380 if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
381 current_directory = concat (current_directory, dir, (char *)NULL);
383 current_directory = concat (current_directory, SLASH_STRING,
388 /* Now simplify any occurrences of `.' and `..' in the pathname. */
391 for (p = current_directory; *p;)
393 if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
394 && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
396 else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
397 && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
401 /* Search backwards for the directory just before the "/.."
402 and obliterate it and the "/..". */
404 while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
407 if (q == current_directory)
408 /* current_directory is
409 a relative pathname ("can't happen"--leave it alone). */
413 strcpy (q - 1, p + 3);
418 /* We are dealing with leading repetitions of "/..", for example
419 "/../..", which is the Mach super-root. */
429 forget_cached_source_info ();
432 pwd_command ((char *) 0, 1);
436 source_script (char *file, int from_tty)
439 struct cleanup *old_cleanups;
440 char *full_pathname = NULL;
443 if (file == NULL || *file == 0)
445 error (_("source command requires file name of file to source."));
448 file = tilde_expand (file);
449 old_cleanups = make_cleanup (xfree, file);
451 /* Search for and open 'file' on the search path used for source
452 files. Put the full location in 'full_pathname'. */
453 fd = openp (source_path, OPF_TRY_CWD_FIRST,
454 file, O_RDONLY, 0, &full_pathname);
456 /* Use the full path name, if it is found. */
457 if (full_pathname != NULL && fd != -1)
459 file = full_pathname;
465 perror_with_name (file);
470 stream = fdopen (fd, FOPEN_RT);
471 script_from_file (stream, file);
473 do_cleanups (old_cleanups);
476 /* Return the source_verbose global variable to its previous state
477 on exit from the source command, by whatever means. */
479 source_verbose_cleanup (void *old_value)
481 source_verbose = *(int *)old_value;
486 source_command (char *args, int from_tty)
488 struct cleanup *old_cleanups;
490 int *old_source_verbose = xmalloc (sizeof(int));
492 *old_source_verbose = source_verbose;
493 old_cleanups = make_cleanup (source_verbose_cleanup, old_source_verbose);
495 /* -v causes the source command to run in verbose mode.
496 We still have to be able to handle filenames with spaces in a
497 backward compatible way, so buildargv is not appropriate. */
501 /* Make sure leading white space does not break the comparisons. */
502 while (isspace(args[0]))
505 /* Is -v the first thing in the string? */
506 if (args[0] == '-' && args[1] == 'v' && isspace (args[2]))
510 /* Trim -v and whitespace from the filename. */
512 while (isspace (file[0]))
517 source_script (file, from_tty);
522 echo_command (char *text, int from_tty)
528 while ((c = *p++) != '\0')
532 /* \ at end of argument is used after spaces
533 so they won't be lost. */
537 c = parse_escape (&p);
539 printf_filtered ("%c", c);
542 printf_filtered ("%c", c);
545 /* Force this output to appear now. */
547 gdb_flush (gdb_stdout);
551 shell_escape (char *arg, int from_tty)
553 #if defined(CANT_FORK) || \
554 (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
555 /* If ARG is NULL, they want an inferior shell, but `system' just
556 reports if the shell is available when passed a NULL arg. */
557 int rc = system (arg ? arg : "");
560 arg = "inferior shell";
564 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
565 safe_strerror (errno));
566 gdb_flush (gdb_stderr);
570 fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
571 gdb_flush (gdb_stderr);
574 /* Make sure to return to the directory GDB thinks it is, in case the
575 shell command we just ran changed it. */
576 chdir (current_directory);
578 #else /* Can fork. */
581 if ((pid = vfork ()) == 0)
583 char *p, *user_shell;
585 if ((user_shell = (char *) getenv ("SHELL")) == NULL)
586 user_shell = "/bin/sh";
588 /* Get the name of the shell for arg0 */
589 if ((p = strrchr (user_shell, '/')) == NULL)
592 p++; /* Get past '/' */
595 execl (user_shell, p, (char *) 0);
597 execl (user_shell, p, "-c", arg, (char *) 0);
599 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
600 safe_strerror (errno));
601 gdb_flush (gdb_stderr);
606 while ((rc = wait (&status)) != pid && rc != -1)
609 error (_("Fork failed"));
610 #endif /* Can fork. */
614 edit_command (char *arg, int from_tty)
616 struct symtabs_and_lines sals;
617 struct symtab_and_line sal;
625 /* Pull in the current default source line if necessary */
628 set_default_source_symtab_and_line ();
629 sal = get_current_source_symtab_and_line ();
632 /* bare "edit" edits file with present line. */
637 error (_("No default source file yet."));
638 sal.line += get_lines_to_list () / 2;
643 /* Now should only be one argument -- decode it in SAL */
646 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
648 if (! sals.nelts) return; /* C++ */
649 if (sals.nelts > 1) {
650 ambiguous_line_spec (&sals);
659 error (_("Junk at end of line specification."));
661 /* if line was specified by address,
662 first print exactly which line, and which file.
663 In this case, sal.symtab == 0 means address is outside
664 of all known source files, not that user failed to give a filename. */
668 /* FIXME-32x64--assumes sal.pc fits in long. */
669 error (_("No source file for address %s."),
670 hex_string ((unsigned long) sal.pc));
671 sym = find_pc_function (sal.pc);
674 deprecated_print_address_numeric (sal.pc, 1, gdb_stdout);
675 printf_filtered (" is in ");
676 fputs_filtered (SYMBOL_PRINT_NAME (sym), gdb_stdout);
677 printf_filtered (" (%s:%d).\n", sal.symtab->filename, sal.line);
681 deprecated_print_address_numeric (sal.pc, 1, gdb_stdout);
682 printf_filtered (" is at %s:%d.\n",
683 sal.symtab->filename, sal.line);
687 /* If what was given does not imply a symtab, it must be an undebuggable
688 symbol which means no source code. */
691 error (_("No line number known for %s."), arg);
694 if ((editor = (char *) getenv ("EDITOR")) == NULL)
697 /* Approximate base-10 log of line to 1 unit for digit count */
698 for(log10=32, m=0x80000000; !(sal.line & m) && log10>0; log10--, m=m>>1);
699 log10 = 1 + (int)((log10 + (0 == ((m-1) & sal.line)))/3.32192809);
701 /* If we don't already know the full absolute file name of the
702 source file, find it now. */
703 if (!sal.symtab->fullname)
705 fn = symtab_to_fullname (sal.symtab);
710 fn = sal.symtab->fullname;
712 /* Quote the file name, in case it has whitespace or other special
714 p = xstrprintf ("%s +%d \"%s\"", editor, sal.line, fn);
715 shell_escape(p, from_tty);
720 list_command (char *arg, int from_tty)
722 struct symtabs_and_lines sals, sals_end;
723 struct symtab_and_line sal = { 0 };
724 struct symtab_and_line sal_end = { 0 };
725 struct symtab_and_line cursal = { 0 };
734 /* Pull in the current default source line if necessary */
735 if (arg == 0 || arg[0] == '+' || arg[0] == '-')
737 set_default_source_symtab_and_line ();
738 cursal = get_current_source_symtab_and_line ();
741 /* "l" or "l +" lists next ten lines. */
743 if (arg == 0 || strcmp (arg, "+") == 0)
745 print_source_lines (cursal.symtab, cursal.line,
746 cursal.line + get_lines_to_list (), 0);
750 /* "l -" lists previous ten lines, the ones before the ten just listed. */
751 if (strcmp (arg, "-") == 0)
753 print_source_lines (cursal.symtab,
754 max (get_first_line_listed () - get_lines_to_list (), 1),
755 get_first_line_listed (), 0);
759 /* Now if there is only one argument, decode it in SAL
761 If there are two arguments, decode them in SAL and SAL_END
762 and clear NO_END; however, if one of the arguments is blank,
763 set DUMMY_BEG or DUMMY_END to record that fact. */
765 if (!have_full_symbols () && !have_partial_symbols ())
766 error (_("No symbol table is loaded. Use the \"file\" command."));
773 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
779 ambiguous_line_spec (&sals);
788 /* Record whether the BEG arg is all digits. */
790 for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
791 linenum_beg = (p == arg1);
793 while (*arg1 == ' ' || *arg1 == '\t')
799 while (*arg1 == ' ' || *arg1 == '\t')
806 sals_end = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
808 sals_end = decode_line_1 (&arg1, 0, sal.symtab, sal.line, 0, 0);
809 if (sals_end.nelts == 0)
811 if (sals_end.nelts > 1)
813 ambiguous_line_spec (&sals_end);
814 xfree (sals_end.sals);
817 sal_end = sals_end.sals[0];
818 xfree (sals_end.sals);
823 error (_("Junk at end of line specification."));
825 if (!no_end && !dummy_beg && !dummy_end
826 && sal.symtab != sal_end.symtab)
827 error (_("Specified start and end are in different files."));
828 if (dummy_beg && dummy_end)
829 error (_("Two empty args do not say what lines to list."));
831 /* if line was specified by address,
832 first print exactly which line, and which file.
833 In this case, sal.symtab == 0 means address is outside
834 of all known source files, not that user failed to give a filename. */
838 /* FIXME-32x64--assumes sal.pc fits in long. */
839 error (_("No source file for address %s."),
840 hex_string ((unsigned long) sal.pc));
841 sym = find_pc_function (sal.pc);
844 deprecated_print_address_numeric (sal.pc, 1, gdb_stdout);
845 printf_filtered (" is in ");
846 fputs_filtered (SYMBOL_PRINT_NAME (sym), gdb_stdout);
847 printf_filtered (" (%s:%d).\n", sal.symtab->filename, sal.line);
851 deprecated_print_address_numeric (sal.pc, 1, gdb_stdout);
852 printf_filtered (" is at %s:%d.\n",
853 sal.symtab->filename, sal.line);
857 /* If line was not specified by just a line number,
858 and it does not imply a symtab, it must be an undebuggable symbol
859 which means no source code. */
861 if (!linenum_beg && sal.symtab == 0)
862 error (_("No line number known for %s."), arg);
864 /* If this command is repeated with RET,
865 turn it into the no-arg variant. */
870 if (dummy_beg && sal_end.symtab == 0)
871 error (_("No default source file yet. Do \"help list\"."));
873 print_source_lines (sal_end.symtab,
874 max (sal_end.line - (get_lines_to_list () - 1), 1),
875 sal_end.line + 1, 0);
876 else if (sal.symtab == 0)
877 error (_("No default source file yet. Do \"help list\"."));
880 int first_line = sal.line - get_lines_to_list () / 2;
882 if (first_line < 1) first_line = 1;
884 print_source_lines (sal.symtab,
886 first_line + get_lines_to_list (),
890 print_source_lines (sal.symtab, sal.line,
892 ? sal.line + get_lines_to_list ()
897 /* Dump a specified section of assembly code. With no command line
898 arguments, this command will dump the assembly code for the
899 function surrounding the pc value in the selected frame. With one
900 argument, it will dump the assembly code surrounding that pc value.
901 Two arguments are interpeted as bounds within which to dump
905 disassemble_command (char *arg, int from_tty)
909 CORE_ADDR pc, pc_masked;
918 pc = get_frame_pc (get_selected_frame (_("No frame selected.")));
919 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
920 error (_("No function contains program counter for selected frame."));
922 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
925 /* FIXME: cagney/2004-02-07: This should be an observer. */
926 low = tui_get_low_disassembly_address (low, pc);
928 low += DEPRECATED_FUNCTION_START_OFFSET;
930 else if (!(space_index = (char *) strchr (arg, ' ')))
933 pc = parse_and_eval_address (arg);
934 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
935 error (_("No function contains specified address."));
937 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
940 /* FIXME: cagney/2004-02-07: This should be an observer. */
941 low = tui_get_low_disassembly_address (low, pc);
943 low += DEPRECATED_FUNCTION_START_OFFSET;
949 low = parse_and_eval_address (arg);
950 high = parse_and_eval_address (space_index + 1);
954 if (!tui_is_window_visible (DISASSEM_WIN))
957 printf_filtered ("Dump of assembler code ");
960 printf_filtered ("for function %s:\n", name);
964 printf_filtered ("from ");
965 deprecated_print_address_numeric (low, 1, gdb_stdout);
966 printf_filtered (" to ");
967 deprecated_print_address_numeric (high, 1, gdb_stdout);
968 printf_filtered (":\n");
971 /* Dump the specified range. */
972 gdb_disassembly (uiout, 0, 0, 0, -1, low, high);
974 printf_filtered ("End of assembler dump.\n");
975 gdb_flush (gdb_stdout);
980 tui_show_assembly (low);
986 make_command (char *arg, int from_tty)
994 p = xmalloc (sizeof ("make ") + strlen (arg));
996 strcpy (p + sizeof ("make ") - 1, arg);
999 shell_escape (p, from_tty);
1003 show_user (char *args, int from_tty)
1005 struct cmd_list_element *c;
1006 extern struct cmd_list_element *cmdlist;
1010 c = lookup_cmd (&args, cmdlist, "", 0, 1);
1011 if (c->class != class_user)
1012 error (_("Not a user command."));
1013 show_user_1 (c, gdb_stdout);
1017 for (c = cmdlist; c; c = c->next)
1019 if (c->class == class_user)
1020 show_user_1 (c, gdb_stdout);
1025 /* Search through names of commands and documentations for a certain
1029 apropos_command (char *searchstr, int from_tty)
1031 extern struct cmd_list_element *cmdlist; /*This is the main command list*/
1033 char *pattern_fastmap;
1034 char errorbuffer[512];
1035 pattern_fastmap = xcalloc (256, sizeof (char));
1036 if (searchstr == NULL)
1037 error (_("REGEXP string is empty"));
1039 if (regcomp(&pattern,searchstr,REG_ICASE) == 0)
1041 pattern.fastmap=pattern_fastmap;
1042 re_compile_fastmap(&pattern);
1043 apropos_cmd (gdb_stdout,cmdlist,&pattern,"");
1047 regerror(regcomp(&pattern,searchstr,REG_ICASE),NULL,errorbuffer,512);
1048 error (_("Error in regular expression:%s"),errorbuffer);
1050 xfree (pattern_fastmap);
1053 /* Print a list of files and line numbers which a user may choose from
1054 in order to list a function which was specified ambiguously (as with
1055 `list classname::overloadedfuncname', for example). The vector in
1056 SALS provides the filenames and line numbers. */
1059 ambiguous_line_spec (struct symtabs_and_lines *sals)
1063 for (i = 0; i < sals->nelts; ++i)
1064 printf_filtered (_("file: \"%s\", line number: %d\n"),
1065 sals->sals[i].symtab->filename, sals->sals[i].line);
1069 set_debug (char *arg, int from_tty)
1071 printf_unfiltered (_("\"set debug\" must be followed by the name of a print subcommand.\n"));
1072 help_list (setdebuglist, "set debug ", -1, gdb_stdout);
1076 show_debug (char *args, int from_tty)
1078 cmd_show_list (showdebuglist, from_tty, "");
1082 init_cmd_lists (void)
1084 max_user_call_depth = 1024;
1094 enablebreaklist = NULL;
1099 showhistlist = NULL;
1100 unsethistlist = NULL;
1101 maintenancelist = NULL;
1102 maintenanceinfolist = NULL;
1103 maintenanceprintlist = NULL;
1104 setprintlist = NULL;
1105 showprintlist = NULL;
1106 setchecklist = NULL;
1107 showchecklist = NULL;
1111 show_info_verbose (struct ui_file *file, int from_tty,
1112 struct cmd_list_element *c,
1116 fprintf_filtered (file, _("\
1117 Verbose printing of informational messages is %s.\n"), value);
1119 fprintf_filtered (file, _("Verbosity is %s.\n"), value);
1123 show_history_expansion_p (struct ui_file *file, int from_tty,
1124 struct cmd_list_element *c, const char *value)
1126 fprintf_filtered (file, _("History expansion on command input is %s.\n"),
1131 show_baud_rate (struct ui_file *file, int from_tty,
1132 struct cmd_list_element *c, const char *value)
1134 fprintf_filtered (file, _("Baud rate for remote serial I/O is %s.\n"),
1139 show_remote_debug (struct ui_file *file, int from_tty,
1140 struct cmd_list_element *c, const char *value)
1142 fprintf_filtered (file, _("Debugging of remote protocol is %s.\n"),
1147 show_remote_timeout (struct ui_file *file, int from_tty,
1148 struct cmd_list_element *c, const char *value)
1150 fprintf_filtered (file, _("\
1151 Timeout limit to wait for target to respond is %s.\n"),
1156 show_max_user_call_depth (struct ui_file *file, int from_tty,
1157 struct cmd_list_element *c, const char *value)
1159 fprintf_filtered (file, _("\
1160 The max call depth for user-defined commands is %s.\n"),
1166 init_cli_cmds (void)
1168 struct cmd_list_element *c;
1169 char *source_help_text;
1171 /* Define the classes of commands.
1172 They will appear in the help list in the reverse of this order. */
1174 add_cmd ("internals", class_maintenance, NULL, _("\
1175 Maintenance commands.\n\
1176 Some gdb commands are provided just for use by gdb maintainers.\n\
1177 These commands are subject to frequent change, and may not be as\n\
1178 well documented as user commands."),
1180 add_cmd ("obscure", class_obscure, NULL, _("Obscure features."), &cmdlist);
1181 add_cmd ("aliases", class_alias, NULL, _("Aliases of other commands."), &cmdlist);
1182 add_cmd ("user-defined", class_user, NULL, _("\
1183 User-defined commands.\n\
1184 The commands in this class are those defined by the user.\n\
1185 Use the \"define\" command to define a command."), &cmdlist);
1186 add_cmd ("support", class_support, NULL, _("Support facilities."), &cmdlist);
1188 add_cmd ("status", class_info, NULL, _("Status inquiries."), &cmdlist);
1189 add_cmd ("files", class_files, NULL, _("Specifying and examining files."),
1191 add_cmd ("breakpoints", class_breakpoint, NULL,
1192 _("Making program stop at certain points."), &cmdlist);
1193 add_cmd ("data", class_vars, NULL, _("Examining data."), &cmdlist);
1194 add_cmd ("stack", class_stack, NULL, _("\
1195 Examining the stack.\n\
1196 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1197 counting from zero for the innermost (currently executing) frame.\n\n\
1198 At any time gdb identifies one frame as the \"selected\" frame.\n\
1199 Variable lookups are done with respect to the selected frame.\n\
1200 When the program being debugged stops, gdb selects the innermost frame.\n\
1201 The commands below can be used to select other frames by number or address."),
1203 add_cmd ("running", class_run, NULL, _("Running the program."), &cmdlist);
1205 /* Define general commands. */
1207 add_com ("pwd", class_files, pwd_command, _("\
1208 Print working directory. This is used for your program as well."));
1209 c = add_cmd ("cd", class_files, cd_command, _("\
1210 Set working directory to DIR for debugger and program being debugged.\n\
1211 The change does not take effect for the program being debugged\n\
1212 until the next time it is started."), &cmdlist);
1213 set_cmd_completer (c, filename_completer);
1215 add_com ("echo", class_support, echo_command, _("\
1216 Print a constant string. Give string as argument.\n\
1217 C escape sequences may be used in the argument.\n\
1218 No newline is added at the end of the argument;\n\
1219 use \"\\n\" if you want a newline to be printed.\n\
1220 Since leading and trailing whitespace are ignored in command arguments,\n\
1221 if you want to print some you must use \"\\\" before leading whitespace\n\
1222 to be printed or after trailing whitespace."));
1223 add_com ("document", class_support, document_command, _("\
1224 Document a user-defined command.\n\
1225 Give command name as argument. Give documentation on following lines.\n\
1226 End with a line of just \"end\"."));
1227 add_com ("define", class_support, define_command, _("\
1228 Define a new command name. Command name is argument.\n\
1229 Definition appears on following lines, one command per line.\n\
1230 End with a line of just \"end\".\n\
1231 Use the \"document\" command to give documentation for the new command.\n\
1232 Commands defined in this way may have up to ten arguments."));
1234 source_help_text = xstrprintf (_("\
1235 Read commands from a file named FILE.\n\
1236 Optional -v switch (before the filename) causes each command in\n\
1237 FILE to be echoed as it is executed.\n\
1238 Note that the file \"%s\" is read automatically in this way\n\
1239 when GDB is started."), gdbinit);
1240 c = add_cmd ("source", class_support, source_command,
1241 source_help_text, &cmdlist);
1242 set_cmd_completer (c, filename_completer);
1244 add_com ("quit", class_support, quit_command, _("Exit gdb."));
1245 c = add_com ("help", class_support, help_command,
1246 _("Print list of commands."));
1247 set_cmd_completer (c, command_completer);
1248 add_com_alias ("q", "quit", class_support, 1);
1249 add_com_alias ("h", "help", class_support, 1);
1251 add_setshow_boolean_cmd ("verbose", class_support, &info_verbose, _("\
1252 Set verbosity."), _("\
1253 Show verbosity."), NULL,
1256 &setlist, &showlist);
1258 add_prefix_cmd ("history", class_support, set_history,
1259 _("Generic command for setting command history parameters."),
1260 &sethistlist, "set history ", 0, &setlist);
1261 add_prefix_cmd ("history", class_support, show_history,
1262 _("Generic command for showing command history parameters."),
1263 &showhistlist, "show history ", 0, &showlist);
1265 add_setshow_boolean_cmd ("expansion", no_class, &history_expansion_p, _("\
1266 Set history expansion on command input."), _("\
1267 Show history expansion on command input."), _("\
1268 Without an argument, history expansion is enabled."),
1270 show_history_expansion_p,
1271 &sethistlist, &showhistlist);
1273 add_prefix_cmd ("info", class_info, info_command, _("\
1274 Generic command for showing things about the program being debugged."),
1275 &infolist, "info ", 0, &cmdlist);
1276 add_com_alias ("i", "info", class_info, 1);
1278 add_com ("complete", class_obscure, complete_command,
1279 _("List the completions for the rest of the line as a command."));
1281 add_prefix_cmd ("show", class_info, show_command,
1282 _("Generic command for showing things about the debugger."),
1283 &showlist, "show ", 0, &cmdlist);
1284 /* Another way to get at the same thing. */
1285 add_info ("set", show_command, _("Show all GDB settings."));
1287 add_cmd ("commands", no_class, show_commands, _("\
1288 Show the history of commands you typed.\n\
1289 You can supply a command number to start with, or a `+' to start after\n\
1290 the previous command number shown."),
1293 add_cmd ("version", no_class, show_version,
1294 _("Show what version of GDB this is."), &showlist);
1296 add_com ("while", class_support, while_command, _("\
1297 Execute nested commands WHILE the conditional expression is non zero.\n\
1298 The conditional expression must follow the word `while' and must in turn be\n\
1299 followed by a new line. The nested commands must be entered one per line,\n\
1300 and should be terminated by the word `end'."));
1302 add_com ("if", class_support, if_command, _("\
1303 Execute nested commands once IF the conditional expression is non zero.\n\
1304 The conditional expression must follow the word `if' and must in turn be\n\
1305 followed by a new line. The nested commands must be entered one per line,\n\
1306 and should be terminated by the word 'else' or `end'. If an else clause\n\
1307 is used, the same rules apply to its nested commands as to the first ones."));
1309 /* If target is open when baud changes, it doesn't take effect until the
1310 next open (I think, not sure). */
1311 add_setshow_zinteger_cmd ("remotebaud", no_class, &baud_rate, _("\
1312 Set baud rate for remote serial I/O."), _("\
1313 Show baud rate for remote serial I/O."), _("\
1314 This value is used to set the speed of the serial port when debugging\n\
1315 using remote targets."),
1318 &setlist, &showlist);
1320 add_setshow_zinteger_cmd ("remote", no_class, &remote_debug, _("\
1321 Set debugging of remote protocol."), _("\
1322 Show debugging of remote protocol."), _("\
1323 When enabled, each packet sent or received with the remote target\n\
1327 &setdebuglist, &showdebuglist);
1329 add_setshow_integer_cmd ("remotetimeout", no_class, &remote_timeout, _("\
1330 Set timeout limit to wait for target to respond."), _("\
1331 Show timeout limit to wait for target to respond."), _("\
1332 This value is used to set the time limit for gdb to wait for a response\n\
1335 show_remote_timeout,
1336 &setlist, &showlist);
1338 add_prefix_cmd ("debug", no_class, set_debug,
1339 _("Generic command for setting gdb debugging flags"),
1340 &setdebuglist, "set debug ", 0, &setlist);
1342 add_prefix_cmd ("debug", no_class, show_debug,
1343 _("Generic command for showing gdb debugging flags"),
1344 &showdebuglist, "show debug ", 0, &showlist);
1346 c = add_com ("shell", class_support, shell_escape, _("\
1347 Execute the rest of the line as a shell command.\n\
1348 With no arguments, run an inferior shell."));
1349 set_cmd_completer (c, filename_completer);
1351 c = add_com ("edit", class_files, edit_command, _("\
1352 Edit specified file or function.\n\
1353 With no argument, edits file containing most recent line listed.\n\
1354 Editing targets can be specified in these ways:\n\
1355 FILE:LINENUM, to edit at that line in that file,\n\
1356 FUNCTION, to edit at the beginning of that function,\n\
1357 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1358 *ADDRESS, to edit at the line containing that address.\n\
1359 Uses EDITOR environment variable contents as editor (or ex as default)."));
1361 c->completer = location_completer;
1363 add_com ("list", class_files, list_command, _("\
1364 List specified function or line.\n\
1365 With no argument, lists ten more lines after or around previous listing.\n\
1366 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1367 One argument specifies a line, and ten lines are listed around that line.\n\
1368 Two arguments with comma between specify starting and ending lines to list.\n\
1369 Lines can be specified in these ways:\n\
1370 LINENUM, to list around that line in current file,\n\
1371 FILE:LINENUM, to list around that line in that file,\n\
1372 FUNCTION, to list around beginning of that function,\n\
1373 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1374 *ADDRESS, to list around the line containing that address.\n\
1375 With two args if one is empty it stands for ten lines away from the other arg."));
1378 add_com_alias ("l", "list", class_files, 1);
1380 add_com_alias ("v", "list", class_files, 1);
1383 add_com_alias ("file", "list", class_files, 1);
1385 c = add_com ("disassemble", class_vars, disassemble_command, _("\
1386 Disassemble a specified section of memory.\n\
1387 Default is the function surrounding the pc of the selected frame.\n\
1388 With a single argument, the function surrounding that address is dumped.\n\
1389 Two arguments are taken as a range of memory to dump."));
1390 set_cmd_completer (c, location_completer);
1392 add_com_alias ("va", "disassemble", class_xdb, 0);
1394 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1395 be a really useful feature. Unfortunately, the below wont do
1396 this. Instead it adds support for the form ``(gdb) ! ls''
1397 (i.e. the space is required). If the ``!'' command below is
1398 added the complains about no ``!'' command would be replaced by
1399 complains about how the ``!'' command is broken :-) */
1401 add_com_alias ("!", "shell", class_support, 0);
1403 c = add_com ("make", class_support, make_command, _("\
1404 Run the ``make'' program using the rest of the line as arguments."));
1405 set_cmd_completer (c, filename_completer);
1406 add_cmd ("user", no_class, show_user, _("\
1407 Show definitions of user defined commands.\n\
1408 Argument is the name of the user defined command.\n\
1409 With no argument, show definitions of all user defined commands."), &showlist);
1410 add_com ("apropos", class_support, apropos_command,
1411 _("Search for commands matching a REGEXP"));
1413 add_setshow_integer_cmd ("max-user-call-depth", no_class,
1414 &max_user_call_depth, _("\
1415 Set the max call depth for user-defined commands."), _("\
1416 Show the max call depth for user-defined commands."), NULL,
1418 show_max_user_call_depth,
1419 &setlist, &showlist);
1421 add_setshow_boolean_cmd ("trace-commands", no_class, &trace_commands, _("\
1422 Set tracing of GDB CLI commands."), _("\
1423 Show state of GDB CLI command tracing."), _("\
1424 When 'on', each command is displayed as it is executed."),
1427 &setlist, &showlist);