3 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009
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 if (! getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
)))
324 error (_("Error finding name of working directory: %s"),
325 safe_strerror (errno
));
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
);
455 make_cleanup (xfree
, full_pathname
);
457 /* Use the full path name, if it is found. */
458 if (full_pathname
!= NULL
&& fd
!= -1)
460 file
= full_pathname
;
466 perror_with_name (file
);
469 do_cleanups (old_cleanups
);
474 stream
= fdopen (fd
, FOPEN_RT
);
475 script_from_file (stream
, file
);
477 do_cleanups (old_cleanups
);
480 /* Return the source_verbose global variable to its previous state
481 on exit from the source command, by whatever means. */
483 source_verbose_cleanup (void *old_value
)
485 source_verbose
= *(int *)old_value
;
490 source_command (char *args
, int from_tty
)
492 struct cleanup
*old_cleanups
;
494 int *old_source_verbose
= xmalloc (sizeof(int));
496 *old_source_verbose
= source_verbose
;
497 old_cleanups
= make_cleanup (source_verbose_cleanup
, old_source_verbose
);
499 /* -v causes the source command to run in verbose mode.
500 We still have to be able to handle filenames with spaces in a
501 backward compatible way, so buildargv is not appropriate. */
505 /* Make sure leading white space does not break the comparisons. */
506 while (isspace(args
[0]))
509 /* Is -v the first thing in the string? */
510 if (args
[0] == '-' && args
[1] == 'v' && isspace (args
[2]))
514 /* Trim -v and whitespace from the filename. */
516 while (isspace (file
[0]))
521 source_script (file
, from_tty
);
526 echo_command (char *text
, int from_tty
)
532 while ((c
= *p
++) != '\0')
536 /* \ at end of argument is used after spaces
537 so they won't be lost. */
541 c
= parse_escape (&p
);
543 printf_filtered ("%c", c
);
546 printf_filtered ("%c", c
);
549 /* Force this output to appear now. */
551 gdb_flush (gdb_stdout
);
555 shell_escape (char *arg
, int from_tty
)
557 #if defined(CANT_FORK) || \
558 (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
559 /* If ARG is NULL, they want an inferior shell, but `system' just
560 reports if the shell is available when passed a NULL arg. */
561 int rc
= system (arg
? arg
: "");
564 arg
= "inferior shell";
568 fprintf_unfiltered (gdb_stderr
, "Cannot execute %s: %s\n", arg
,
569 safe_strerror (errno
));
570 gdb_flush (gdb_stderr
);
574 fprintf_unfiltered (gdb_stderr
, "%s exited with status %d\n", arg
, rc
);
575 gdb_flush (gdb_stderr
);
578 /* Make sure to return to the directory GDB thinks it is, in case the
579 shell command we just ran changed it. */
580 chdir (current_directory
);
582 #else /* Can fork. */
585 if ((pid
= vfork ()) == 0)
587 char *p
, *user_shell
;
589 if ((user_shell
= (char *) getenv ("SHELL")) == NULL
)
590 user_shell
= "/bin/sh";
592 /* Get the name of the shell for arg0 */
593 if ((p
= strrchr (user_shell
, '/')) == NULL
)
596 p
++; /* Get past '/' */
599 execl (user_shell
, p
, (char *) 0);
601 execl (user_shell
, p
, "-c", arg
, (char *) 0);
603 fprintf_unfiltered (gdb_stderr
, "Cannot execute %s: %s\n", user_shell
,
604 safe_strerror (errno
));
605 gdb_flush (gdb_stderr
);
610 while ((rc
= wait (&status
)) != pid
&& rc
!= -1)
613 error (_("Fork failed"));
614 #endif /* Can fork. */
618 edit_command (char *arg
, int from_tty
)
620 struct symtabs_and_lines sals
;
621 struct symtab_and_line sal
;
627 /* Pull in the current default source line if necessary. */
630 set_default_source_symtab_and_line ();
631 sal
= get_current_source_symtab_and_line ();
634 /* bare "edit" edits file with present line. */
639 error (_("No default source file yet."));
640 sal
.line
+= get_lines_to_list () / 2;
645 /* Now should only be one argument -- decode it in SAL. */
648 sals
= decode_line_1 (&arg1
, 0, 0, 0, 0, 0);
657 ambiguous_line_spec (&sals
);
666 error (_("Junk at end of line specification."));
668 /* If line was specified by address,
669 first print exactly which line, and which file.
670 In this case, sal.symtab == 0 means address is outside
671 of all known source files, not that user failed to give a filename. */
675 /* FIXME-32x64--assumes sal.pc fits in long. */
676 error (_("No source file for address %s."),
677 hex_string ((unsigned long) sal
.pc
));
678 sym
= find_pc_function (sal
.pc
);
680 printf_filtered ("%s is in %s (%s:%d).\n", paddress (sal
.pc
),
681 SYMBOL_PRINT_NAME (sym
), sal
.symtab
->filename
,
684 printf_filtered ("%s is at %s:%d.\n", paddress (sal
.pc
),
685 sal
.symtab
->filename
, sal
.line
);
688 /* If what was given does not imply a symtab, it must be an undebuggable
689 symbol which means no source code. */
692 error (_("No line number known for %s."), arg
);
695 if ((editor
= (char *) getenv ("EDITOR")) == NULL
)
698 /* If we don't already know the full absolute file name of the
699 source file, find it now. */
700 if (!sal
.symtab
->fullname
)
702 fn
= symtab_to_fullname (sal
.symtab
);
707 fn
= sal
.symtab
->fullname
;
709 /* Quote the file name, in case it has whitespace or other special
711 p
= xstrprintf ("%s +%d \"%s\"", editor
, sal
.line
, fn
);
712 shell_escape (p
, from_tty
);
717 list_command (char *arg
, int from_tty
)
719 struct symtabs_and_lines sals
, sals_end
;
720 struct symtab_and_line sal
= { 0 };
721 struct symtab_and_line sal_end
= { 0 };
722 struct symtab_and_line cursal
= { 0 };
731 /* Pull in the current default source line if necessary */
732 if (arg
== 0 || arg
[0] == '+' || arg
[0] == '-')
734 set_default_source_symtab_and_line ();
735 cursal
= get_current_source_symtab_and_line ();
738 /* "l" or "l +" lists next ten lines. */
740 if (arg
== 0 || strcmp (arg
, "+") == 0)
742 print_source_lines (cursal
.symtab
, cursal
.line
,
743 cursal
.line
+ get_lines_to_list (), 0);
747 /* "l -" lists previous ten lines, the ones before the ten just listed. */
748 if (strcmp (arg
, "-") == 0)
750 print_source_lines (cursal
.symtab
,
751 max (get_first_line_listed () - get_lines_to_list (), 1),
752 get_first_line_listed (), 0);
756 /* Now if there is only one argument, decode it in SAL
758 If there are two arguments, decode them in SAL and SAL_END
759 and clear NO_END; however, if one of the arguments is blank,
760 set DUMMY_BEG or DUMMY_END to record that fact. */
762 if (!have_full_symbols () && !have_partial_symbols ())
763 error (_("No symbol table is loaded. Use the \"file\" command."));
770 sals
= decode_line_1 (&arg1
, 0, 0, 0, 0, 0);
776 ambiguous_line_spec (&sals
);
785 /* Record whether the BEG arg is all digits. */
787 for (p
= arg
; p
!= arg1
&& *p
>= '0' && *p
<= '9'; p
++);
788 linenum_beg
= (p
== arg1
);
790 while (*arg1
== ' ' || *arg1
== '\t')
796 while (*arg1
== ' ' || *arg1
== '\t')
803 sals_end
= decode_line_1 (&arg1
, 0, 0, 0, 0, 0);
805 sals_end
= decode_line_1 (&arg1
, 0, sal
.symtab
, sal
.line
, 0, 0);
806 if (sals_end
.nelts
== 0)
808 if (sals_end
.nelts
> 1)
810 ambiguous_line_spec (&sals_end
);
811 xfree (sals_end
.sals
);
814 sal_end
= sals_end
.sals
[0];
815 xfree (sals_end
.sals
);
820 error (_("Junk at end of line specification."));
822 if (!no_end
&& !dummy_beg
&& !dummy_end
823 && sal
.symtab
!= sal_end
.symtab
)
824 error (_("Specified start and end are in different files."));
825 if (dummy_beg
&& dummy_end
)
826 error (_("Two empty args do not say what lines to list."));
828 /* if line was specified by address,
829 first print exactly which line, and which file.
830 In this case, sal.symtab == 0 means address is outside
831 of all known source files, not that user failed to give a filename. */
835 /* FIXME-32x64--assumes sal.pc fits in long. */
836 error (_("No source file for address %s."),
837 hex_string ((unsigned long) sal
.pc
));
838 sym
= find_pc_function (sal
.pc
);
840 printf_filtered ("%s is in %s (%s:%d).\n",
841 paddress (sal
.pc
), SYMBOL_PRINT_NAME (sym
),
842 sal
.symtab
->filename
, sal
.line
);
844 printf_filtered ("%s is at %s:%d.\n", paddress (sal
.pc
),
845 sal
.symtab
->filename
, sal
.line
);
848 /* If line was not specified by just a line number,
849 and it does not imply a symtab, it must be an undebuggable symbol
850 which means no source code. */
852 if (!linenum_beg
&& sal
.symtab
== 0)
853 error (_("No line number known for %s."), arg
);
855 /* If this command is repeated with RET,
856 turn it into the no-arg variant. */
861 if (dummy_beg
&& sal_end
.symtab
== 0)
862 error (_("No default source file yet. Do \"help list\"."));
864 print_source_lines (sal_end
.symtab
,
865 max (sal_end
.line
- (get_lines_to_list () - 1), 1),
866 sal_end
.line
+ 1, 0);
867 else if (sal
.symtab
== 0)
868 error (_("No default source file yet. Do \"help list\"."));
871 int first_line
= sal
.line
- get_lines_to_list () / 2;
873 if (first_line
< 1) first_line
= 1;
875 print_source_lines (sal
.symtab
,
877 first_line
+ get_lines_to_list (),
881 print_source_lines (sal
.symtab
, sal
.line
,
883 ? sal
.line
+ get_lines_to_list ()
888 /* Subroutine of disassemble_command to simplify it.
889 Perform the disassembly.
890 NAME is the name of the function if known, or NULL.
891 [LOW,HIGH) are the range of addresses to disassemble.
892 MIXED is non-zero to print source with the assembler. */
895 print_disassembly (const char *name
, CORE_ADDR low
, CORE_ADDR high
, int mixed
)
898 if (!tui_is_window_visible (DISASSEM_WIN
))
901 printf_filtered ("Dump of assembler code ");
903 printf_filtered ("for function %s:\n", name
);
905 printf_filtered ("from %s to %s:\n", paddress (low
), paddress (high
));
907 /* Dump the specified range. */
908 gdb_disassembly (uiout
, 0, mixed
, -1, low
, high
);
910 printf_filtered ("End of assembler dump.\n");
911 gdb_flush (gdb_stdout
);
916 tui_show_assembly (low
);
921 /* Subroutine of disassemble_command to simplify it.
922 Print a disassembly of the current function.
923 MIXED is non-zero to print source with the assembler. */
926 disassemble_current_function (int mixed
)
928 CORE_ADDR low
, high
, pc
;
931 pc
= get_frame_pc (get_selected_frame (_("No frame selected.")));
932 if (find_pc_partial_function (pc
, &name
, &low
, &high
) == 0)
933 error (_("No function contains program counter for selected frame."));
935 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
938 /* FIXME: cagney/2004-02-07: This should be an observer. */
939 low
= tui_get_low_disassembly_address (low
, pc
);
941 low
+= gdbarch_deprecated_function_start_offset (current_gdbarch
);
943 print_disassembly (name
, low
, high
, mixed
);
946 /* Dump a specified section of assembly code.
950 - dump the assembly code for the function of the current pc
951 disassemble [/m] addr
952 - dump the assembly code for the function at ADDR
953 disassemble [/m] low high
954 - dump the assembly code in the range [LOW,HIGH)
956 A /m modifier will include source code with the assembly. */
959 disassemble_command (char *arg
, int from_tty
)
963 CORE_ADDR pc
, pc_masked
;
965 int mixed_source_and_assembly
;
968 mixed_source_and_assembly
= 0;
970 if (arg
&& *arg
== '/')
975 error (_("Missing modifier."));
977 while (*arg
&& ! isspace (*arg
))
982 mixed_source_and_assembly
= 1;
985 error (_("Invalid disassembly modifier."));
989 while (isspace (*arg
))
995 disassemble_current_function (mixed_source_and_assembly
);
999 /* FIXME: 'twould be nice to allow spaces in the expression for the first
1000 arg. Allow comma separater too? */
1002 if (!(space_index
= (char *) strchr (arg
, ' ')))
1005 pc
= parse_and_eval_address (arg
);
1006 if (find_pc_partial_function (pc
, &name
, &low
, &high
) == 0)
1007 error (_("No function contains specified address."));
1009 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1012 /* FIXME: cagney/2004-02-07: This should be an observer. */
1013 low
= tui_get_low_disassembly_address (low
, pc
);
1015 low
+= gdbarch_deprecated_function_start_offset (current_gdbarch
);
1019 /* Two arguments. */
1020 *space_index
= '\0';
1021 low
= parse_and_eval_address (arg
);
1022 high
= parse_and_eval_address (space_index
+ 1);
1025 print_disassembly (name
, low
, high
, mixed_source_and_assembly
);
1029 make_command (char *arg
, int from_tty
)
1037 p
= xmalloc (sizeof ("make ") + strlen (arg
));
1038 strcpy (p
, "make ");
1039 strcpy (p
+ sizeof ("make ") - 1, arg
);
1042 shell_escape (p
, from_tty
);
1046 show_user (char *args
, int from_tty
)
1048 struct cmd_list_element
*c
;
1049 extern struct cmd_list_element
*cmdlist
;
1053 char *comname
= args
;
1054 c
= lookup_cmd (&comname
, cmdlist
, "", 0, 1);
1055 if (c
->class != class_user
)
1056 error (_("Not a user command."));
1057 show_user_1 (c
, "", args
, gdb_stdout
);
1061 for (c
= cmdlist
; c
; c
= c
->next
)
1063 if (c
->class == class_user
|| c
->prefixlist
!= NULL
)
1064 show_user_1 (c
, "", c
->name
, gdb_stdout
);
1069 /* Search through names of commands and documentations for a certain
1073 apropos_command (char *searchstr
, int from_tty
)
1075 extern struct cmd_list_element
*cmdlist
; /*This is the main command list*/
1077 char *pattern_fastmap
;
1078 char errorbuffer
[512];
1079 pattern_fastmap
= xcalloc (256, sizeof (char));
1080 if (searchstr
== NULL
)
1081 error (_("REGEXP string is empty"));
1083 if (regcomp(&pattern
,searchstr
,REG_ICASE
) == 0)
1085 pattern
.fastmap
=pattern_fastmap
;
1086 re_compile_fastmap(&pattern
);
1087 apropos_cmd (gdb_stdout
,cmdlist
,&pattern
,"");
1091 regerror(regcomp(&pattern
,searchstr
,REG_ICASE
),NULL
,errorbuffer
,512);
1092 error (_("Error in regular expression:%s"),errorbuffer
);
1094 xfree (pattern_fastmap
);
1097 /* Print a list of files and line numbers which a user may choose from
1098 in order to list a function which was specified ambiguously (as with
1099 `list classname::overloadedfuncname', for example). The vector in
1100 SALS provides the filenames and line numbers. */
1103 ambiguous_line_spec (struct symtabs_and_lines
*sals
)
1107 for (i
= 0; i
< sals
->nelts
; ++i
)
1108 printf_filtered (_("file: \"%s\", line number: %d\n"),
1109 sals
->sals
[i
].symtab
->filename
, sals
->sals
[i
].line
);
1113 set_debug (char *arg
, int from_tty
)
1115 printf_unfiltered (_("\"set debug\" must be followed by the name of a debug subcommand.\n"));
1116 help_list (setdebuglist
, "set debug ", -1, gdb_stdout
);
1120 show_debug (char *args
, int from_tty
)
1122 cmd_show_list (showdebuglist
, from_tty
, "");
1126 init_cmd_lists (void)
1128 max_user_call_depth
= 1024;
1138 enablebreaklist
= NULL
;
1143 showhistlist
= NULL
;
1144 unsethistlist
= NULL
;
1145 maintenancelist
= NULL
;
1146 maintenanceinfolist
= NULL
;
1147 maintenanceprintlist
= NULL
;
1148 setprintlist
= NULL
;
1149 showprintlist
= NULL
;
1150 setchecklist
= NULL
;
1151 showchecklist
= NULL
;
1155 show_info_verbose (struct ui_file
*file
, int from_tty
,
1156 struct cmd_list_element
*c
,
1160 fprintf_filtered (file
, _("\
1161 Verbose printing of informational messages is %s.\n"), value
);
1163 fprintf_filtered (file
, _("Verbosity is %s.\n"), value
);
1167 show_history_expansion_p (struct ui_file
*file
, int from_tty
,
1168 struct cmd_list_element
*c
, const char *value
)
1170 fprintf_filtered (file
, _("History expansion on command input is %s.\n"),
1175 show_baud_rate (struct ui_file
*file
, int from_tty
,
1176 struct cmd_list_element
*c
, const char *value
)
1178 fprintf_filtered (file
, _("Baud rate for remote serial I/O is %s.\n"),
1183 show_remote_debug (struct ui_file
*file
, int from_tty
,
1184 struct cmd_list_element
*c
, const char *value
)
1186 fprintf_filtered (file
, _("Debugging of remote protocol is %s.\n"),
1191 show_remote_timeout (struct ui_file
*file
, int from_tty
,
1192 struct cmd_list_element
*c
, const char *value
)
1194 fprintf_filtered (file
, _("\
1195 Timeout limit to wait for target to respond is %s.\n"),
1200 show_max_user_call_depth (struct ui_file
*file
, int from_tty
,
1201 struct cmd_list_element
*c
, const char *value
)
1203 fprintf_filtered (file
, _("\
1204 The max call depth for user-defined commands is %s.\n"),
1210 init_cli_cmds (void)
1212 struct cmd_list_element
*c
;
1213 char *source_help_text
;
1215 /* Define the classes of commands.
1216 They will appear in the help list in the reverse of this order. */
1218 add_cmd ("internals", class_maintenance
, NULL
, _("\
1219 Maintenance commands.\n\
1220 Some gdb commands are provided just for use by gdb maintainers.\n\
1221 These commands are subject to frequent change, and may not be as\n\
1222 well documented as user commands."),
1224 add_cmd ("obscure", class_obscure
, NULL
, _("Obscure features."), &cmdlist
);
1225 add_cmd ("aliases", class_alias
, NULL
, _("Aliases of other commands."), &cmdlist
);
1226 add_cmd ("user-defined", class_user
, NULL
, _("\
1227 User-defined commands.\n\
1228 The commands in this class are those defined by the user.\n\
1229 Use the \"define\" command to define a command."), &cmdlist
);
1230 add_cmd ("support", class_support
, NULL
, _("Support facilities."), &cmdlist
);
1232 add_cmd ("status", class_info
, NULL
, _("Status inquiries."), &cmdlist
);
1233 add_cmd ("files", class_files
, NULL
, _("Specifying and examining files."),
1235 add_cmd ("breakpoints", class_breakpoint
, NULL
,
1236 _("Making program stop at certain points."), &cmdlist
);
1237 add_cmd ("data", class_vars
, NULL
, _("Examining data."), &cmdlist
);
1238 add_cmd ("stack", class_stack
, NULL
, _("\
1239 Examining the stack.\n\
1240 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1241 counting from zero for the innermost (currently executing) frame.\n\n\
1242 At any time gdb identifies one frame as the \"selected\" frame.\n\
1243 Variable lookups are done with respect to the selected frame.\n\
1244 When the program being debugged stops, gdb selects the innermost frame.\n\
1245 The commands below can be used to select other frames by number or address."),
1247 add_cmd ("running", class_run
, NULL
, _("Running the program."), &cmdlist
);
1249 /* Define general commands. */
1251 add_com ("pwd", class_files
, pwd_command
, _("\
1252 Print working directory. This is used for your program as well."));
1254 c
= add_cmd ("cd", class_files
, cd_command
, _("\
1255 Set working directory to DIR for debugger and program being debugged.\n\
1256 The change does not take effect for the program being debugged\n\
1257 until the next time it is started."), &cmdlist
);
1258 set_cmd_completer (c
, filename_completer
);
1260 add_com ("echo", class_support
, echo_command
, _("\
1261 Print a constant string. Give string as argument.\n\
1262 C escape sequences may be used in the argument.\n\
1263 No newline is added at the end of the argument;\n\
1264 use \"\\n\" if you want a newline to be printed.\n\
1265 Since leading and trailing whitespace are ignored in command arguments,\n\
1266 if you want to print some you must use \"\\\" before leading whitespace\n\
1267 to be printed or after trailing whitespace."));
1268 add_com ("document", class_support
, document_command
, _("\
1269 Document a user-defined command.\n\
1270 Give command name as argument. Give documentation on following lines.\n\
1271 End with a line of just \"end\"."));
1272 add_com ("define", class_support
, define_command
, _("\
1273 Define a new command name. Command name is argument.\n\
1274 Definition appears on following lines, one command per line.\n\
1275 End with a line of just \"end\".\n\
1276 Use the \"document\" command to give documentation for the new command.\n\
1277 Commands defined in this way may have up to ten arguments."));
1279 source_help_text
= xstrprintf (_("\
1280 Read commands from a file named FILE.\n\
1281 Optional -v switch (before the filename) causes each command in\n\
1282 FILE to be echoed as it is executed.\n\
1283 Note that the file \"%s\" is read automatically in this way\n\
1284 when GDB is started."), gdbinit
);
1285 c
= add_cmd ("source", class_support
, source_command
,
1286 source_help_text
, &cmdlist
);
1287 set_cmd_completer (c
, filename_completer
);
1289 add_com ("quit", class_support
, quit_command
, _("Exit gdb."));
1290 c
= add_com ("help", class_support
, help_command
,
1291 _("Print list of commands."));
1292 set_cmd_completer (c
, command_completer
);
1293 add_com_alias ("q", "quit", class_support
, 1);
1294 add_com_alias ("h", "help", class_support
, 1);
1296 add_setshow_boolean_cmd ("verbose", class_support
, &info_verbose
, _("\
1297 Set verbosity."), _("\
1298 Show verbosity."), NULL
,
1301 &setlist
, &showlist
);
1303 add_prefix_cmd ("history", class_support
, set_history
,
1304 _("Generic command for setting command history parameters."),
1305 &sethistlist
, "set history ", 0, &setlist
);
1306 add_prefix_cmd ("history", class_support
, show_history
,
1307 _("Generic command for showing command history parameters."),
1308 &showhistlist
, "show history ", 0, &showlist
);
1310 add_setshow_boolean_cmd ("expansion", no_class
, &history_expansion_p
, _("\
1311 Set history expansion on command input."), _("\
1312 Show history expansion on command input."), _("\
1313 Without an argument, history expansion is enabled."),
1315 show_history_expansion_p
,
1316 &sethistlist
, &showhistlist
);
1318 add_prefix_cmd ("info", class_info
, info_command
, _("\
1319 Generic command for showing things about the program being debugged."),
1320 &infolist
, "info ", 0, &cmdlist
);
1321 add_com_alias ("i", "info", class_info
, 1);
1323 add_com ("complete", class_obscure
, complete_command
,
1324 _("List the completions for the rest of the line as a command."));
1326 add_prefix_cmd ("show", class_info
, show_command
, _("\
1327 Generic command for showing things about the debugger."),
1328 &showlist
, "show ", 0, &cmdlist
);
1329 /* Another way to get at the same thing. */
1330 add_info ("set", show_command
, _("Show all GDB settings."));
1332 add_cmd ("commands", no_class
, show_commands
, _("\
1333 Show the history of commands you typed.\n\
1334 You can supply a command number to start with, or a `+' to start after\n\
1335 the previous command number shown."),
1338 add_cmd ("version", no_class
, show_version
,
1339 _("Show what version of GDB this is."), &showlist
);
1341 add_com ("while", class_support
, while_command
, _("\
1342 Execute nested commands WHILE the conditional expression is non zero.\n\
1343 The conditional expression must follow the word `while' and must in turn be\n\
1344 followed by a new line. The nested commands must be entered one per line,\n\
1345 and should be terminated by the word `end'."));
1347 add_com ("if", class_support
, if_command
, _("\
1348 Execute nested commands once IF the conditional expression is non zero.\n\
1349 The conditional expression must follow the word `if' and must in turn be\n\
1350 followed by a new line. The nested commands must be entered one per line,\n\
1351 and should be terminated by the word 'else' or `end'. If an else clause\n\
1352 is used, the same rules apply to its nested commands as to the first ones."));
1354 /* If target is open when baud changes, it doesn't take effect until the
1355 next open (I think, not sure). */
1356 add_setshow_zinteger_cmd ("remotebaud", no_class
, &baud_rate
, _("\
1357 Set baud rate for remote serial I/O."), _("\
1358 Show baud rate for remote serial I/O."), _("\
1359 This value is used to set the speed of the serial port when debugging\n\
1360 using remote targets."),
1363 &setlist
, &showlist
);
1365 add_setshow_zinteger_cmd ("remote", no_class
, &remote_debug
, _("\
1366 Set debugging of remote protocol."), _("\
1367 Show debugging of remote protocol."), _("\
1368 When enabled, each packet sent or received with the remote target\n\
1372 &setdebuglist
, &showdebuglist
);
1374 add_setshow_integer_cmd ("remotetimeout", no_class
, &remote_timeout
, _("\
1375 Set timeout limit to wait for target to respond."), _("\
1376 Show timeout limit to wait for target to respond."), _("\
1377 This value is used to set the time limit for gdb to wait for a response\n\
1380 show_remote_timeout
,
1381 &setlist
, &showlist
);
1383 add_prefix_cmd ("debug", no_class
, set_debug
,
1384 _("Generic command for setting gdb debugging flags"),
1385 &setdebuglist
, "set debug ", 0, &setlist
);
1387 add_prefix_cmd ("debug", no_class
, show_debug
,
1388 _("Generic command for showing gdb debugging flags"),
1389 &showdebuglist
, "show debug ", 0, &showlist
);
1391 c
= add_com ("shell", class_support
, shell_escape
, _("\
1392 Execute the rest of the line as a shell command.\n\
1393 With no arguments, run an inferior shell."));
1394 set_cmd_completer (c
, filename_completer
);
1396 c
= add_com ("edit", class_files
, edit_command
, _("\
1397 Edit specified file or function.\n\
1398 With no argument, edits file containing most recent line listed.\n\
1399 Editing targets can be specified in these ways:\n\
1400 FILE:LINENUM, to edit at that line in that file,\n\
1401 FUNCTION, to edit at the beginning of that function,\n\
1402 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1403 *ADDRESS, to edit at the line containing that address.\n\
1404 Uses EDITOR environment variable contents as editor (or ex as default)."));
1406 c
->completer
= location_completer
;
1408 add_com ("list", class_files
, list_command
, _("\
1409 List specified function or line.\n\
1410 With no argument, lists ten more lines after or around previous listing.\n\
1411 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1412 One argument specifies a line, and ten lines are listed around that line.\n\
1413 Two arguments with comma between specify starting and ending lines to list.\n\
1414 Lines can be specified in these ways:\n\
1415 LINENUM, to list around that line in current file,\n\
1416 FILE:LINENUM, to list around that line in that file,\n\
1417 FUNCTION, to list around beginning of that function,\n\
1418 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1419 *ADDRESS, to list around the line containing that address.\n\
1420 With two args if one is empty it stands for ten lines away from the other arg."));
1423 add_com_alias ("l", "list", class_files
, 1);
1425 add_com_alias ("v", "list", class_files
, 1);
1428 add_com_alias ("file", "list", class_files
, 1);
1430 c
= add_com ("disassemble", class_vars
, disassemble_command
, _("\
1431 Disassemble a specified section of memory.\n\
1432 Default is the function surrounding the pc of the selected frame.\n\
1433 With a /m modifier, source lines are included (if available).\n\
1434 With a single argument, the function surrounding that address is dumped.\n\
1435 Two arguments are taken as a range of memory to dump."));
1436 set_cmd_completer (c
, location_completer
);
1438 add_com_alias ("va", "disassemble", class_xdb
, 0);
1440 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1441 be a really useful feature. Unfortunately, the below wont do
1442 this. Instead it adds support for the form ``(gdb) ! ls''
1443 (i.e. the space is required). If the ``!'' command below is
1444 added the complains about no ``!'' command would be replaced by
1445 complains about how the ``!'' command is broken :-) */
1447 add_com_alias ("!", "shell", class_support
, 0);
1449 c
= add_com ("make", class_support
, make_command
, _("\
1450 Run the ``make'' program using the rest of the line as arguments."));
1451 set_cmd_completer (c
, filename_completer
);
1452 add_cmd ("user", no_class
, show_user
, _("\
1453 Show definitions of user defined commands.\n\
1454 Argument is the name of the user defined command.\n\
1455 With no argument, show definitions of all user defined commands."), &showlist
);
1456 add_com ("apropos", class_support
, apropos_command
,
1457 _("Search for commands matching a REGEXP"));
1459 add_setshow_integer_cmd ("max-user-call-depth", no_class
,
1460 &max_user_call_depth
, _("\
1461 Set the max call depth for user-defined commands."), _("\
1462 Show the max call depth for user-defined commands."), NULL
,
1464 show_max_user_call_depth
,
1465 &setlist
, &showlist
);
1467 add_setshow_boolean_cmd ("trace-commands", no_class
, &trace_commands
, _("\
1468 Set tracing of GDB CLI commands."), _("\
1469 Show state of GDB CLI command tracing."), _("\
1470 When 'on', each command is displayed as it is executed."),
1473 &setlist
, &showlist
);