3 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008
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 3 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, see <http://www.gnu.org/licenses/>. */
22 #include "readline/readline.h"
23 #include "readline/tilde.h"
24 #include "completer.h"
25 #include "target.h" /* For baud_rate, remote_debug and remote_timeout */
26 #include "gdb_wait.h" /* For shell escape implementation */
27 #include "gdb_regex.h" /* Used by apropos_command */
28 #include "gdb_string.h"
29 #include "gdb_vfork.h"
31 #include "expression.h"
35 #include "filenames.h" /* for DOSish file names */
43 #include "cli/cli-decode.h"
44 #include "cli/cli-script.h"
45 #include "cli/cli-setshow.h"
46 #include "cli/cli-cmds.h"
49 #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 detach subcommands. */
125 struct cmd_list_element *detachlist;
127 /* Chain containing all defined "enable breakpoint" subcommands. */
129 struct cmd_list_element *enablebreaklist;
131 /* Chain containing all defined set subcommands */
133 struct cmd_list_element *setlist;
135 /* Chain containing all defined unset subcommands */
137 struct cmd_list_element *unsetlist;
139 /* Chain containing all defined show subcommands. */
141 struct cmd_list_element *showlist;
143 /* Chain containing all defined \"set history\". */
145 struct cmd_list_element *sethistlist;
147 /* Chain containing all defined \"show history\". */
149 struct cmd_list_element *showhistlist;
151 /* Chain containing all defined \"unset history\". */
153 struct cmd_list_element *unsethistlist;
155 /* Chain containing all defined maintenance subcommands. */
157 struct cmd_list_element *maintenancelist;
159 /* Chain containing all defined "maintenance info" subcommands. */
161 struct cmd_list_element *maintenanceinfolist;
163 /* Chain containing all defined "maintenance print" subcommands. */
165 struct cmd_list_element *maintenanceprintlist;
167 struct cmd_list_element *setprintlist;
169 struct cmd_list_element *showprintlist;
171 struct cmd_list_element *setdebuglist;
173 struct cmd_list_element *showdebuglist;
175 struct cmd_list_element *setchecklist;
177 struct cmd_list_element *showchecklist;
179 /* Command tracing state. */
181 int source_verbose = 0;
182 int trace_commands = 0;
184 /* Utility used everywhere when at least one argument is needed and
188 error_no_arg (char *why)
190 error (_("Argument required (%s)."), why);
193 /* The "info" command is defined as a prefix, with allow_unknown = 0.
194 Therefore, its own definition is called only for "info" with no args. */
197 info_command (char *arg, int from_tty)
199 printf_unfiltered (_("\"info\" must be followed by the name of an info command.\n"));
200 help_list (infolist, "info ", -1, gdb_stdout);
203 /* The "show" command with no arguments shows all the settings. */
206 show_command (char *arg, int from_tty)
208 cmd_show_list (showlist, from_tty, "");
211 /* Provide documentation on command or list given by COMMAND. FROM_TTY
215 help_command (char *command, int from_tty)
217 help_cmd (command, gdb_stdout);
220 /* String compare function for qsort. */
222 compare_strings (const void *arg1, const void *arg2)
224 const char **s1 = (const char **) arg1;
225 const char **s2 = (const char **) arg2;
226 return strcmp (*s1, *s2);
229 /* The "complete" command is used by Emacs to implement completion. */
232 complete_command (char *arg, int from_tty)
236 char **completions, *point, *arg_prefix;
242 argpoint = strlen (arg);
244 /* complete_line assumes that its first argument is somewhere within,
245 and except for filenames at the beginning of, the word to be completed.
246 The following crude imitation of readline's word-breaking tries to
248 point = arg + argpoint;
251 if (strchr (rl_completer_word_break_characters, point[-1]) != 0)
256 arg_prefix = alloca (point - arg + 1);
257 memcpy (arg_prefix, arg, point - arg);
258 arg_prefix[point - arg] = 0;
260 completions = complete_line (point, arg, argpoint);
266 for (size = 0; completions[size]; ++size)
268 qsort (completions, size, sizeof (char *), compare_strings);
270 /* We do extra processing here since we only want to print each
276 printf_unfiltered ("%s%s\n", arg_prefix, completions[item]);
277 next_item = item + 1;
278 while (next_item < size
279 && ! strcmp (completions[item], completions[next_item]))
281 xfree (completions[next_item]);
285 xfree (completions[item]);
294 is_complete_command (struct cmd_list_element *c)
296 return cmd_cfunc_eq (c, complete_command);
300 show_version (char *args, int from_tty)
303 print_gdb_version (gdb_stdout);
304 printf_filtered ("\n");
308 /* Handle the quit command. */
311 quit_command (char *args, int from_tty)
313 if (!quit_confirm ())
314 error (_("Not confirmed."));
315 quit_force (args, from_tty);
319 pwd_command (char *args, int from_tty)
322 error (_("The \"pwd\" command does not take an argument: %s"), args);
323 getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
325 if (strcmp (gdb_dirbuf, current_directory) != 0)
326 printf_unfiltered (_("Working directory %s\n (canonically %s).\n"),
327 current_directory, gdb_dirbuf);
329 printf_unfiltered (_("Working directory %s.\n"), current_directory);
333 cd_command (char *dir, int from_tty)
336 /* Found something other than leading repetitions of "/..". */
340 /* If the new directory is absolute, repeat is a no-op; if relative,
341 repeat might be useful but is more likely to be a mistake. */
345 error_no_arg (_("new working directory"));
347 dir = tilde_expand (dir);
348 make_cleanup (xfree, dir);
351 perror_with_name (dir);
353 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
354 /* There's too much mess with DOSish names like "d:", "d:.",
355 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
356 simply get the canonicalized name of the current directory. */
357 dir = getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
361 if (IS_DIR_SEPARATOR (dir[len - 1]))
363 /* Remove the trailing slash unless this is a root directory
364 (including a drive letter on non-Unix systems). */
365 if (!(len == 1) /* "/" */
366 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
367 && !(len == 3 && dir[1] == ':') /* "d:/" */
373 dir = savestring (dir, len);
374 if (IS_ABSOLUTE_PATH (dir))
375 current_directory = dir;
378 if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
379 current_directory = concat (current_directory, dir, (char *)NULL);
381 current_directory = concat (current_directory, SLASH_STRING,
386 /* Now simplify any occurrences of `.' and `..' in the pathname. */
389 for (p = current_directory; *p;)
391 if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
392 && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
394 else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
395 && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
399 /* Search backwards for the directory just before the "/.."
400 and obliterate it and the "/..". */
402 while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
405 if (q == current_directory)
406 /* current_directory is
407 a relative pathname ("can't happen"--leave it alone). */
411 strcpy (q - 1, p + 3);
416 /* We are dealing with leading repetitions of "/..", for example
417 "/../..", which is the Mach super-root. */
427 forget_cached_source_info ();
430 pwd_command ((char *) 0, 1);
434 source_script (char *file, int from_tty)
437 struct cleanup *old_cleanups;
438 char *full_pathname = NULL;
441 if (file == NULL || *file == 0)
443 error (_("source command requires file name of file to source."));
446 file = tilde_expand (file);
447 old_cleanups = make_cleanup (xfree, file);
449 /* Search for and open 'file' on the search path used for source
450 files. Put the full location in 'full_pathname'. */
451 fd = openp (source_path, OPF_TRY_CWD_FIRST,
452 file, O_RDONLY, 0, &full_pathname);
454 /* Use the full path name, if it is found. */
455 if (full_pathname != NULL && fd != -1)
457 file = full_pathname;
463 perror_with_name (file);
468 stream = fdopen (fd, FOPEN_RT);
469 script_from_file (stream, file);
471 do_cleanups (old_cleanups);
474 /* Return the source_verbose global variable to its previous state
475 on exit from the source command, by whatever means. */
477 source_verbose_cleanup (void *old_value)
479 source_verbose = *(int *)old_value;
484 source_command (char *args, int from_tty)
486 struct cleanup *old_cleanups;
488 int *old_source_verbose = xmalloc (sizeof(int));
490 *old_source_verbose = source_verbose;
491 old_cleanups = make_cleanup (source_verbose_cleanup, old_source_verbose);
493 /* -v causes the source command to run in verbose mode.
494 We still have to be able to handle filenames with spaces in a
495 backward compatible way, so buildargv is not appropriate. */
499 /* Make sure leading white space does not break the comparisons. */
500 while (isspace(args[0]))
503 /* Is -v the first thing in the string? */
504 if (args[0] == '-' && args[1] == 'v' && isspace (args[2]))
508 /* Trim -v and whitespace from the filename. */
510 while (isspace (file[0]))
515 source_script (file, from_tty);
520 echo_command (char *text, int from_tty)
526 while ((c = *p++) != '\0')
530 /* \ at end of argument is used after spaces
531 so they won't be lost. */
535 c = parse_escape (&p);
537 printf_filtered ("%c", c);
540 printf_filtered ("%c", c);
543 /* Force this output to appear now. */
545 gdb_flush (gdb_stdout);
549 shell_escape (char *arg, int from_tty)
551 #if defined(CANT_FORK) || \
552 (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
553 /* If ARG is NULL, they want an inferior shell, but `system' just
554 reports if the shell is available when passed a NULL arg. */
555 int rc = system (arg ? arg : "");
558 arg = "inferior shell";
562 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
563 safe_strerror (errno));
564 gdb_flush (gdb_stderr);
568 fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
569 gdb_flush (gdb_stderr);
572 /* Make sure to return to the directory GDB thinks it is, in case the
573 shell command we just ran changed it. */
574 chdir (current_directory);
576 #else /* Can fork. */
579 if ((pid = vfork ()) == 0)
581 char *p, *user_shell;
583 if ((user_shell = (char *) getenv ("SHELL")) == NULL)
584 user_shell = "/bin/sh";
586 /* Get the name of the shell for arg0 */
587 if ((p = strrchr (user_shell, '/')) == NULL)
590 p++; /* Get past '/' */
593 execl (user_shell, p, (char *) 0);
595 execl (user_shell, p, "-c", arg, (char *) 0);
597 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
598 safe_strerror (errno));
599 gdb_flush (gdb_stderr);
604 while ((rc = wait (&status)) != pid && rc != -1)
607 error (_("Fork failed"));
608 #endif /* Can fork. */
612 edit_command (char *arg, int from_tty)
614 struct symtabs_and_lines sals;
615 struct symtab_and_line sal;
623 /* Pull in the current default source line if necessary */
626 set_default_source_symtab_and_line ();
627 sal = get_current_source_symtab_and_line ();
630 /* bare "edit" edits file with present line. */
635 error (_("No default source file yet."));
636 sal.line += get_lines_to_list () / 2;
641 /* Now should only be one argument -- decode it in SAL */
644 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
646 if (! sals.nelts) return; /* C++ */
647 if (sals.nelts > 1) {
648 ambiguous_line_spec (&sals);
657 error (_("Junk at end of line specification."));
659 /* if line was specified by address,
660 first print exactly which line, and which file.
661 In this case, sal.symtab == 0 means address is outside
662 of all known source files, not that user failed to give a filename. */
666 /* FIXME-32x64--assumes sal.pc fits in long. */
667 error (_("No source file for address %s."),
668 hex_string ((unsigned long) sal.pc));
669 sym = find_pc_function (sal.pc);
672 deprecated_print_address_numeric (sal.pc, 1, gdb_stdout);
673 printf_filtered (" is in ");
674 fputs_filtered (SYMBOL_PRINT_NAME (sym), gdb_stdout);
675 printf_filtered (" (%s:%d).\n", sal.symtab->filename, sal.line);
679 deprecated_print_address_numeric (sal.pc, 1, gdb_stdout);
680 printf_filtered (" is at %s:%d.\n",
681 sal.symtab->filename, sal.line);
685 /* If what was given does not imply a symtab, it must be an undebuggable
686 symbol which means no source code. */
689 error (_("No line number known for %s."), arg);
692 if ((editor = (char *) getenv ("EDITOR")) == NULL)
695 /* Approximate base-10 log of line to 1 unit for digit count */
696 for(log10=32, m=0x80000000; !(sal.line & m) && log10>0; log10--, m=m>>1);
697 log10 = 1 + (int)((log10 + (0 == ((m-1) & sal.line)))/3.32192809);
699 /* If we don't already know the full absolute file name of the
700 source file, find it now. */
701 if (!sal.symtab->fullname)
703 fn = symtab_to_fullname (sal.symtab);
708 fn = sal.symtab->fullname;
710 /* Quote the file name, in case it has whitespace or other special
712 p = xstrprintf ("%s +%d \"%s\"", editor, sal.line, fn);
713 shell_escape(p, from_tty);
718 list_command (char *arg, int from_tty)
720 struct symtabs_and_lines sals, sals_end;
721 struct symtab_and_line sal = { 0 };
722 struct symtab_and_line sal_end = { 0 };
723 struct symtab_and_line cursal = { 0 };
732 /* Pull in the current default source line if necessary */
733 if (arg == 0 || arg[0] == '+' || arg[0] == '-')
735 set_default_source_symtab_and_line ();
736 cursal = get_current_source_symtab_and_line ();
739 /* "l" or "l +" lists next ten lines. */
741 if (arg == 0 || strcmp (arg, "+") == 0)
743 print_source_lines (cursal.symtab, cursal.line,
744 cursal.line + get_lines_to_list (), 0);
748 /* "l -" lists previous ten lines, the ones before the ten just listed. */
749 if (strcmp (arg, "-") == 0)
751 print_source_lines (cursal.symtab,
752 max (get_first_line_listed () - get_lines_to_list (), 1),
753 get_first_line_listed (), 0);
757 /* Now if there is only one argument, decode it in SAL
759 If there are two arguments, decode them in SAL and SAL_END
760 and clear NO_END; however, if one of the arguments is blank,
761 set DUMMY_BEG or DUMMY_END to record that fact. */
763 if (!have_full_symbols () && !have_partial_symbols ())
764 error (_("No symbol table is loaded. Use the \"file\" command."));
771 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
777 ambiguous_line_spec (&sals);
786 /* Record whether the BEG arg is all digits. */
788 for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
789 linenum_beg = (p == arg1);
791 while (*arg1 == ' ' || *arg1 == '\t')
797 while (*arg1 == ' ' || *arg1 == '\t')
804 sals_end = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
806 sals_end = decode_line_1 (&arg1, 0, sal.symtab, sal.line, 0, 0);
807 if (sals_end.nelts == 0)
809 if (sals_end.nelts > 1)
811 ambiguous_line_spec (&sals_end);
812 xfree (sals_end.sals);
815 sal_end = sals_end.sals[0];
816 xfree (sals_end.sals);
821 error (_("Junk at end of line specification."));
823 if (!no_end && !dummy_beg && !dummy_end
824 && sal.symtab != sal_end.symtab)
825 error (_("Specified start and end are in different files."));
826 if (dummy_beg && dummy_end)
827 error (_("Two empty args do not say what lines to list."));
829 /* if line was specified by address,
830 first print exactly which line, and which file.
831 In this case, sal.symtab == 0 means address is outside
832 of all known source files, not that user failed to give a filename. */
836 /* FIXME-32x64--assumes sal.pc fits in long. */
837 error (_("No source file for address %s."),
838 hex_string ((unsigned long) sal.pc));
839 sym = find_pc_function (sal.pc);
842 deprecated_print_address_numeric (sal.pc, 1, gdb_stdout);
843 printf_filtered (" is in ");
844 fputs_filtered (SYMBOL_PRINT_NAME (sym), gdb_stdout);
845 printf_filtered (" (%s:%d).\n", sal.symtab->filename, sal.line);
849 deprecated_print_address_numeric (sal.pc, 1, gdb_stdout);
850 printf_filtered (" is at %s:%d.\n",
851 sal.symtab->filename, sal.line);
855 /* If line was not specified by just a line number,
856 and it does not imply a symtab, it must be an undebuggable symbol
857 which means no source code. */
859 if (!linenum_beg && sal.symtab == 0)
860 error (_("No line number known for %s."), arg);
862 /* If this command is repeated with RET,
863 turn it into the no-arg variant. */
868 if (dummy_beg && sal_end.symtab == 0)
869 error (_("No default source file yet. Do \"help list\"."));
871 print_source_lines (sal_end.symtab,
872 max (sal_end.line - (get_lines_to_list () - 1), 1),
873 sal_end.line + 1, 0);
874 else if (sal.symtab == 0)
875 error (_("No default source file yet. Do \"help list\"."));
878 int first_line = sal.line - get_lines_to_list () / 2;
880 if (first_line < 1) first_line = 1;
882 print_source_lines (sal.symtab,
884 first_line + get_lines_to_list (),
888 print_source_lines (sal.symtab, sal.line,
890 ? sal.line + get_lines_to_list ()
895 /* Subroutine of disassemble_command to simplify it.
896 Perform the disassembly.
897 NAME is the name of the function if known, or NULL.
898 [LOW,HIGH) are the range of addresses to disassemble.
899 MIXED is non-zero to print source with the assembler. */
902 print_disassembly (const char *name, CORE_ADDR low, CORE_ADDR high, int mixed)
905 if (!tui_is_window_visible (DISASSEM_WIN))
908 printf_filtered ("Dump of assembler code ");
910 printf_filtered ("for function %s:\n", name);
912 printf_filtered ("from %s to %s:\n", paddress (low), paddress (high));
914 /* Dump the specified range. */
915 gdb_disassembly (uiout, 0, 0, mixed, -1, low, high);
917 printf_filtered ("End of assembler dump.\n");
918 gdb_flush (gdb_stdout);
923 tui_show_assembly (low);
928 /* Subroutine of disassemble_command to simplify it.
929 Print a disassembly of the current function.
930 MIXED is non-zero to print source with the assembler. */
933 disassemble_current_function (int mixed)
935 CORE_ADDR low, high, pc;
938 pc = get_frame_pc (get_selected_frame (_("No frame selected.")));
939 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
940 error (_("No function contains program counter for selected frame."));
942 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
945 /* FIXME: cagney/2004-02-07: This should be an observer. */
946 low = tui_get_low_disassembly_address (low, pc);
948 low += gdbarch_deprecated_function_start_offset (current_gdbarch);
950 print_disassembly (name, low, high, mixed);
953 /* Dump a specified section of assembly code.
957 - dump the assembly code for the function of the current pc
958 disassemble [/m] addr
959 - dump the assembly code for the function at ADDR
960 disassemble [/m] low high
961 - dump the assembly code in the range [LOW,HIGH)
963 A /m modifier will include source code with the assembly. */
966 disassemble_command (char *arg, int from_tty)
970 CORE_ADDR pc, pc_masked;
972 int mixed_source_and_assembly;
975 mixed_source_and_assembly = 0;
977 if (arg && *arg == '/')
982 error (_("Missing modifier."));
984 while (*arg && ! isspace (*arg))
989 mixed_source_and_assembly = 1;
992 error (_("Invalid disassembly modifier."));
996 while (isspace (*arg))
1000 if (! arg || ! *arg)
1002 disassemble_current_function (mixed_source_and_assembly);
1006 /* FIXME: 'twould be nice to allow spaces in the expression for the first
1007 arg. Allow comma separater too? */
1009 if (!(space_index = (char *) strchr (arg, ' ')))
1012 pc = parse_and_eval_address (arg);
1013 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
1014 error (_("No function contains specified address."));
1016 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1019 /* FIXME: cagney/2004-02-07: This should be an observer. */
1020 low = tui_get_low_disassembly_address (low, pc);
1022 low += gdbarch_deprecated_function_start_offset (current_gdbarch);
1026 /* Two arguments. */
1027 *space_index = '\0';
1028 low = parse_and_eval_address (arg);
1029 high = parse_and_eval_address (space_index + 1);
1032 print_disassembly (name, low, high, mixed_source_and_assembly);
1036 make_command (char *arg, int from_tty)
1044 p = xmalloc (sizeof ("make ") + strlen (arg));
1045 strcpy (p, "make ");
1046 strcpy (p + sizeof ("make ") - 1, arg);
1049 shell_escape (p, from_tty);
1053 show_user (char *args, int from_tty)
1055 struct cmd_list_element *c;
1056 extern struct cmd_list_element *cmdlist;
1060 c = lookup_cmd (&args, cmdlist, "", 0, 1);
1061 if (c->class != class_user)
1062 error (_("Not a user command."));
1063 show_user_1 (c, gdb_stdout);
1067 for (c = cmdlist; c; c = c->next)
1069 if (c->class == class_user)
1070 show_user_1 (c, gdb_stdout);
1075 /* Search through names of commands and documentations for a certain
1079 apropos_command (char *searchstr, int from_tty)
1081 extern struct cmd_list_element *cmdlist; /*This is the main command list*/
1083 char *pattern_fastmap;
1084 char errorbuffer[512];
1085 pattern_fastmap = xcalloc (256, sizeof (char));
1086 if (searchstr == NULL)
1087 error (_("REGEXP string is empty"));
1089 if (regcomp(&pattern,searchstr,REG_ICASE) == 0)
1091 pattern.fastmap=pattern_fastmap;
1092 re_compile_fastmap(&pattern);
1093 apropos_cmd (gdb_stdout,cmdlist,&pattern,"");
1097 regerror(regcomp(&pattern,searchstr,REG_ICASE),NULL,errorbuffer,512);
1098 error (_("Error in regular expression:%s"),errorbuffer);
1100 xfree (pattern_fastmap);
1103 /* Print a list of files and line numbers which a user may choose from
1104 in order to list a function which was specified ambiguously (as with
1105 `list classname::overloadedfuncname', for example). The vector in
1106 SALS provides the filenames and line numbers. */
1109 ambiguous_line_spec (struct symtabs_and_lines *sals)
1113 for (i = 0; i < sals->nelts; ++i)
1114 printf_filtered (_("file: \"%s\", line number: %d\n"),
1115 sals->sals[i].symtab->filename, sals->sals[i].line);
1119 set_debug (char *arg, int from_tty)
1121 printf_unfiltered (_("\"set debug\" must be followed by the name of a print subcommand.\n"));
1122 help_list (setdebuglist, "set debug ", -1, gdb_stdout);
1126 show_debug (char *args, int from_tty)
1128 cmd_show_list (showdebuglist, from_tty, "");
1132 init_cmd_lists (void)
1134 max_user_call_depth = 1024;
1144 enablebreaklist = NULL;
1149 showhistlist = NULL;
1150 unsethistlist = NULL;
1151 maintenancelist = NULL;
1152 maintenanceinfolist = NULL;
1153 maintenanceprintlist = NULL;
1154 setprintlist = NULL;
1155 showprintlist = NULL;
1156 setchecklist = NULL;
1157 showchecklist = NULL;
1161 show_info_verbose (struct ui_file *file, int from_tty,
1162 struct cmd_list_element *c,
1166 fprintf_filtered (file, _("\
1167 Verbose printing of informational messages is %s.\n"), value);
1169 fprintf_filtered (file, _("Verbosity is %s.\n"), value);
1173 show_history_expansion_p (struct ui_file *file, int from_tty,
1174 struct cmd_list_element *c, const char *value)
1176 fprintf_filtered (file, _("History expansion on command input is %s.\n"),
1181 show_baud_rate (struct ui_file *file, int from_tty,
1182 struct cmd_list_element *c, const char *value)
1184 fprintf_filtered (file, _("Baud rate for remote serial I/O is %s.\n"),
1189 show_remote_debug (struct ui_file *file, int from_tty,
1190 struct cmd_list_element *c, const char *value)
1192 fprintf_filtered (file, _("Debugging of remote protocol is %s.\n"),
1197 show_remote_timeout (struct ui_file *file, int from_tty,
1198 struct cmd_list_element *c, const char *value)
1200 fprintf_filtered (file, _("\
1201 Timeout limit to wait for target to respond is %s.\n"),
1206 show_max_user_call_depth (struct ui_file *file, int from_tty,
1207 struct cmd_list_element *c, const char *value)
1209 fprintf_filtered (file, _("\
1210 The max call depth for user-defined commands is %s.\n"),
1216 init_cli_cmds (void)
1218 struct cmd_list_element *c;
1219 char *source_help_text;
1221 /* Define the classes of commands.
1222 They will appear in the help list in the reverse of this order. */
1224 add_cmd ("internals", class_maintenance, NULL, _("\
1225 Maintenance commands.\n\
1226 Some gdb commands are provided just for use by gdb maintainers.\n\
1227 These commands are subject to frequent change, and may not be as\n\
1228 well documented as user commands."),
1230 add_cmd ("obscure", class_obscure, NULL, _("Obscure features."), &cmdlist);
1231 add_cmd ("aliases", class_alias, NULL, _("Aliases of other commands."), &cmdlist);
1232 add_cmd ("user-defined", class_user, NULL, _("\
1233 User-defined commands.\n\
1234 The commands in this class are those defined by the user.\n\
1235 Use the \"define\" command to define a command."), &cmdlist);
1236 add_cmd ("support", class_support, NULL, _("Support facilities."), &cmdlist);
1238 add_cmd ("status", class_info, NULL, _("Status inquiries."), &cmdlist);
1239 add_cmd ("files", class_files, NULL, _("Specifying and examining files."),
1241 add_cmd ("breakpoints", class_breakpoint, NULL,
1242 _("Making program stop at certain points."), &cmdlist);
1243 add_cmd ("data", class_vars, NULL, _("Examining data."), &cmdlist);
1244 add_cmd ("stack", class_stack, NULL, _("\
1245 Examining the stack.\n\
1246 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1247 counting from zero for the innermost (currently executing) frame.\n\n\
1248 At any time gdb identifies one frame as the \"selected\" frame.\n\
1249 Variable lookups are done with respect to the selected frame.\n\
1250 When the program being debugged stops, gdb selects the innermost frame.\n\
1251 The commands below can be used to select other frames by number or address."),
1253 add_cmd ("running", class_run, NULL, _("Running the program."), &cmdlist);
1255 /* Define general commands. */
1257 c = add_com ("pwd", class_files, pwd_command, _("\
1258 Print working directory. This is used for your program as well."));
1259 set_cmd_async_ok (c);
1260 c = add_cmd ("cd", class_files, cd_command, _("\
1261 Set working directory to DIR for debugger and program being debugged.\n\
1262 The change does not take effect for the program being debugged\n\
1263 until the next time it is started."), &cmdlist);
1264 set_cmd_completer (c, filename_completer);
1266 add_com ("echo", class_support, echo_command, _("\
1267 Print a constant string. Give string as argument.\n\
1268 C escape sequences may be used in the argument.\n\
1269 No newline is added at the end of the argument;\n\
1270 use \"\\n\" if you want a newline to be printed.\n\
1271 Since leading and trailing whitespace are ignored in command arguments,\n\
1272 if you want to print some you must use \"\\\" before leading whitespace\n\
1273 to be printed or after trailing whitespace."));
1274 add_com ("document", class_support, document_command, _("\
1275 Document a user-defined command.\n\
1276 Give command name as argument. Give documentation on following lines.\n\
1277 End with a line of just \"end\"."));
1278 add_com ("define", class_support, define_command, _("\
1279 Define a new command name. Command name is argument.\n\
1280 Definition appears on following lines, one command per line.\n\
1281 End with a line of just \"end\".\n\
1282 Use the \"document\" command to give documentation for the new command.\n\
1283 Commands defined in this way may have up to ten arguments."));
1285 source_help_text = xstrprintf (_("\
1286 Read commands from a file named FILE.\n\
1287 Optional -v switch (before the filename) causes each command in\n\
1288 FILE to be echoed as it is executed.\n\
1289 Note that the file \"%s\" is read automatically in this way\n\
1290 when GDB is started."), gdbinit);
1291 c = add_cmd ("source", class_support, source_command,
1292 source_help_text, &cmdlist);
1293 set_cmd_completer (c, filename_completer);
1295 add_com ("quit", class_support, quit_command, _("Exit gdb."));
1296 c = add_com ("help", class_support, help_command,
1297 _("Print list of commands."));
1298 set_cmd_completer (c, command_completer);
1299 set_cmd_async_ok (c);
1300 add_com_alias ("q", "quit", class_support, 1);
1301 add_com_alias ("h", "help", class_support, 1);
1303 add_setshow_boolean_cmd ("verbose", class_support, &info_verbose, _("\
1304 Set verbosity."), _("\
1305 Show verbosity."), NULL,
1308 &setlist, &showlist);
1310 add_prefix_cmd ("history", class_support, set_history,
1311 _("Generic command for setting command history parameters."),
1312 &sethistlist, "set history ", 0, &setlist);
1313 add_prefix_cmd ("history", class_support, show_history,
1314 _("Generic command for showing command history parameters."),
1315 &showhistlist, "show history ", 0, &showlist);
1317 add_setshow_boolean_cmd ("expansion", no_class, &history_expansion_p, _("\
1318 Set history expansion on command input."), _("\
1319 Show history expansion on command input."), _("\
1320 Without an argument, history expansion is enabled."),
1322 show_history_expansion_p,
1323 &sethistlist, &showhistlist);
1325 c = add_prefix_cmd ("info", class_info, info_command, _("\
1326 Generic command for showing things about the program being debugged."),
1327 &infolist, "info ", 0, &cmdlist);
1328 set_cmd_async_ok (c);
1329 add_com_alias ("i", "info", class_info, 1);
1331 add_com ("complete", class_obscure, complete_command,
1332 _("List the completions for the rest of the line as a command."));
1334 c = add_prefix_cmd ("show", class_info, show_command, _("\
1335 Generic command for showing things about the debugger."),
1336 &showlist, "show ", 0, &cmdlist);
1337 set_cmd_async_ok (c);
1338 /* Another way to get at the same thing. */
1339 add_info ("set", show_command, _("Show all GDB settings."));
1341 add_cmd ("commands", no_class, show_commands, _("\
1342 Show the history of commands you typed.\n\
1343 You can supply a command number to start with, or a `+' to start after\n\
1344 the previous command number shown."),
1347 add_cmd ("version", no_class, show_version,
1348 _("Show what version of GDB this is."), &showlist);
1350 add_com ("while", class_support, while_command, _("\
1351 Execute nested commands WHILE the conditional expression is non zero.\n\
1352 The conditional expression must follow the word `while' and must in turn be\n\
1353 followed by a new line. The nested commands must be entered one per line,\n\
1354 and should be terminated by the word `end'."));
1356 add_com ("if", class_support, if_command, _("\
1357 Execute nested commands once IF the conditional expression is non zero.\n\
1358 The conditional expression must follow the word `if' and must in turn be\n\
1359 followed by a new line. The nested commands must be entered one per line,\n\
1360 and should be terminated by the word 'else' or `end'. If an else clause\n\
1361 is used, the same rules apply to its nested commands as to the first ones."));
1363 /* If target is open when baud changes, it doesn't take effect until the
1364 next open (I think, not sure). */
1365 add_setshow_zinteger_cmd ("remotebaud", no_class, &baud_rate, _("\
1366 Set baud rate for remote serial I/O."), _("\
1367 Show baud rate for remote serial I/O."), _("\
1368 This value is used to set the speed of the serial port when debugging\n\
1369 using remote targets."),
1372 &setlist, &showlist);
1374 add_setshow_zinteger_cmd ("remote", no_class, &remote_debug, _("\
1375 Set debugging of remote protocol."), _("\
1376 Show debugging of remote protocol."), _("\
1377 When enabled, each packet sent or received with the remote target\n\
1381 &setdebuglist, &showdebuglist);
1383 add_setshow_integer_cmd ("remotetimeout", no_class, &remote_timeout, _("\
1384 Set timeout limit to wait for target to respond."), _("\
1385 Show timeout limit to wait for target to respond."), _("\
1386 This value is used to set the time limit for gdb to wait for a response\n\
1389 show_remote_timeout,
1390 &setlist, &showlist);
1392 add_prefix_cmd ("debug", no_class, set_debug,
1393 _("Generic command for setting gdb debugging flags"),
1394 &setdebuglist, "set debug ", 0, &setlist);
1396 add_prefix_cmd ("debug", no_class, show_debug,
1397 _("Generic command for showing gdb debugging flags"),
1398 &showdebuglist, "show debug ", 0, &showlist);
1400 c = add_com ("shell", class_support, shell_escape, _("\
1401 Execute the rest of the line as a shell command.\n\
1402 With no arguments, run an inferior shell."));
1403 set_cmd_completer (c, filename_completer);
1405 c = add_com ("edit", class_files, edit_command, _("\
1406 Edit specified file or function.\n\
1407 With no argument, edits file containing most recent line listed.\n\
1408 Editing targets can be specified in these ways:\n\
1409 FILE:LINENUM, to edit at that line in that file,\n\
1410 FUNCTION, to edit at the beginning of that function,\n\
1411 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1412 *ADDRESS, to edit at the line containing that address.\n\
1413 Uses EDITOR environment variable contents as editor (or ex as default)."));
1415 c->completer = location_completer;
1417 add_com ("list", class_files, list_command, _("\
1418 List specified function or line.\n\
1419 With no argument, lists ten more lines after or around previous listing.\n\
1420 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1421 One argument specifies a line, and ten lines are listed around that line.\n\
1422 Two arguments with comma between specify starting and ending lines to list.\n\
1423 Lines can be specified in these ways:\n\
1424 LINENUM, to list around that line in current file,\n\
1425 FILE:LINENUM, to list around that line in that file,\n\
1426 FUNCTION, to list around beginning of that function,\n\
1427 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1428 *ADDRESS, to list around the line containing that address.\n\
1429 With two args if one is empty it stands for ten lines away from the other arg."));
1432 add_com_alias ("l", "list", class_files, 1);
1434 add_com_alias ("v", "list", class_files, 1);
1437 add_com_alias ("file", "list", class_files, 1);
1439 c = add_com ("disassemble", class_vars, disassemble_command, _("\
1440 Disassemble a specified section of memory.\n\
1441 Default is the function surrounding the pc of the selected frame.\n\
1442 With a /m modifier, source lines are included (if available).\n\
1443 With a single argument, the function surrounding that address is dumped.\n\
1444 Two arguments are taken as a range of memory to dump."));
1445 set_cmd_completer (c, location_completer);
1447 add_com_alias ("va", "disassemble", class_xdb, 0);
1449 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1450 be a really useful feature. Unfortunately, the below wont do
1451 this. Instead it adds support for the form ``(gdb) ! ls''
1452 (i.e. the space is required). If the ``!'' command below is
1453 added the complains about no ``!'' command would be replaced by
1454 complains about how the ``!'' command is broken :-) */
1456 add_com_alias ("!", "shell", class_support, 0);
1458 c = add_com ("make", class_support, make_command, _("\
1459 Run the ``make'' program using the rest of the line as arguments."));
1460 set_cmd_completer (c, filename_completer);
1461 add_cmd ("user", no_class, show_user, _("\
1462 Show definitions of user defined commands.\n\
1463 Argument is the name of the user defined command.\n\
1464 With no argument, show definitions of all user defined commands."), &showlist);
1465 add_com ("apropos", class_support, apropos_command,
1466 _("Search for commands matching a REGEXP"));
1468 add_setshow_integer_cmd ("max-user-call-depth", no_class,
1469 &max_user_call_depth, _("\
1470 Set the max call depth for user-defined commands."), _("\
1471 Show the max call depth for user-defined commands."), NULL,
1473 show_max_user_call_depth,
1474 &setlist, &showlist);
1476 add_setshow_boolean_cmd ("trace-commands", no_class, &trace_commands, _("\
1477 Set tracing of GDB CLI commands."), _("\
1478 Show state of GDB CLI command tracing."), _("\
1479 When 'on', each command is displayed as it is executed."),
1482 &setlist, &showlist);