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
);
453 make_cleanup (xfree
, full_pathname
);
455 /* Use the full path name, if it is found. */
456 if (full_pathname
!= NULL
&& fd
!= -1)
458 file
= full_pathname
;
464 perror_with_name (file
);
467 do_cleanups (old_cleanups
);
472 stream
= fdopen (fd
, FOPEN_RT
);
473 script_from_file (stream
, file
);
475 do_cleanups (old_cleanups
);
478 /* Return the source_verbose global variable to its previous state
479 on exit from the source command, by whatever means. */
481 source_verbose_cleanup (void *old_value
)
483 source_verbose
= *(int *)old_value
;
488 source_command (char *args
, int from_tty
)
490 struct cleanup
*old_cleanups
;
492 int *old_source_verbose
= xmalloc (sizeof(int));
494 *old_source_verbose
= source_verbose
;
495 old_cleanups
= make_cleanup (source_verbose_cleanup
, old_source_verbose
);
497 /* -v causes the source command to run in verbose mode.
498 We still have to be able to handle filenames with spaces in a
499 backward compatible way, so buildargv is not appropriate. */
503 /* Make sure leading white space does not break the comparisons. */
504 while (isspace(args
[0]))
507 /* Is -v the first thing in the string? */
508 if (args
[0] == '-' && args
[1] == 'v' && isspace (args
[2]))
512 /* Trim -v and whitespace from the filename. */
514 while (isspace (file
[0]))
519 source_script (file
, from_tty
);
524 echo_command (char *text
, int from_tty
)
530 while ((c
= *p
++) != '\0')
534 /* \ at end of argument is used after spaces
535 so they won't be lost. */
539 c
= parse_escape (&p
);
541 printf_filtered ("%c", c
);
544 printf_filtered ("%c", c
);
547 /* Force this output to appear now. */
549 gdb_flush (gdb_stdout
);
553 shell_escape (char *arg
, int from_tty
)
555 #if defined(CANT_FORK) || \
556 (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
557 /* If ARG is NULL, they want an inferior shell, but `system' just
558 reports if the shell is available when passed a NULL arg. */
559 int rc
= system (arg
? arg
: "");
562 arg
= "inferior shell";
566 fprintf_unfiltered (gdb_stderr
, "Cannot execute %s: %s\n", arg
,
567 safe_strerror (errno
));
568 gdb_flush (gdb_stderr
);
572 fprintf_unfiltered (gdb_stderr
, "%s exited with status %d\n", arg
, rc
);
573 gdb_flush (gdb_stderr
);
576 /* Make sure to return to the directory GDB thinks it is, in case the
577 shell command we just ran changed it. */
578 chdir (current_directory
);
580 #else /* Can fork. */
583 if ((pid
= vfork ()) == 0)
585 char *p
, *user_shell
;
587 if ((user_shell
= (char *) getenv ("SHELL")) == NULL
)
588 user_shell
= "/bin/sh";
590 /* Get the name of the shell for arg0 */
591 if ((p
= strrchr (user_shell
, '/')) == NULL
)
594 p
++; /* Get past '/' */
597 execl (user_shell
, p
, (char *) 0);
599 execl (user_shell
, p
, "-c", arg
, (char *) 0);
601 fprintf_unfiltered (gdb_stderr
, "Cannot execute %s: %s\n", user_shell
,
602 safe_strerror (errno
));
603 gdb_flush (gdb_stderr
);
608 while ((rc
= wait (&status
)) != pid
&& rc
!= -1)
611 error (_("Fork failed"));
612 #endif /* Can fork. */
616 edit_command (char *arg
, int from_tty
)
618 struct symtabs_and_lines sals
;
619 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);
655 ambiguous_line_spec (&sals
);
664 error (_("Junk at end of line specification."));
666 /* If line was specified by address,
667 first print exactly which line, and which file.
668 In this case, sal.symtab == 0 means address is outside
669 of all known source files, not that user failed to give a filename. */
673 /* FIXME-32x64--assumes sal.pc fits in long. */
674 error (_("No source file for address %s."),
675 hex_string ((unsigned long) sal
.pc
));
676 sym
= find_pc_function (sal
.pc
);
678 printf_filtered ("%s is in %s (%s:%d).\n", paddress (sal
.pc
),
679 SYMBOL_PRINT_NAME (sym
), sal
.symtab
->filename
,
682 printf_filtered ("%s is at %s:%d.\n", paddress (sal
.pc
),
683 sal
.symtab
->filename
, sal
.line
);
686 /* If what was given does not imply a symtab, it must be an undebuggable
687 symbol which means no source code. */
690 error (_("No line number known for %s."), arg
);
693 if ((editor
= (char *) getenv ("EDITOR")) == NULL
)
696 /* If we don't already know the full absolute file name of the
697 source file, find it now. */
698 if (!sal
.symtab
->fullname
)
700 fn
= symtab_to_fullname (sal
.symtab
);
705 fn
= sal
.symtab
->fullname
;
707 /* Quote the file name, in case it has whitespace or other special
709 p
= xstrprintf ("%s +%d \"%s\"", editor
, sal
.line
, fn
);
710 shell_escape (p
, from_tty
);
715 list_command (char *arg
, int from_tty
)
717 struct symtabs_and_lines sals
, sals_end
;
718 struct symtab_and_line sal
= { 0 };
719 struct symtab_and_line sal_end
= { 0 };
720 struct symtab_and_line cursal
= { 0 };
729 /* Pull in the current default source line if necessary */
730 if (arg
== 0 || arg
[0] == '+' || arg
[0] == '-')
732 set_default_source_symtab_and_line ();
733 cursal
= get_current_source_symtab_and_line ();
736 /* "l" or "l +" lists next ten lines. */
738 if (arg
== 0 || strcmp (arg
, "+") == 0)
740 print_source_lines (cursal
.symtab
, cursal
.line
,
741 cursal
.line
+ get_lines_to_list (), 0);
745 /* "l -" lists previous ten lines, the ones before the ten just listed. */
746 if (strcmp (arg
, "-") == 0)
748 print_source_lines (cursal
.symtab
,
749 max (get_first_line_listed () - get_lines_to_list (), 1),
750 get_first_line_listed (), 0);
754 /* Now if there is only one argument, decode it in SAL
756 If there are two arguments, decode them in SAL and SAL_END
757 and clear NO_END; however, if one of the arguments is blank,
758 set DUMMY_BEG or DUMMY_END to record that fact. */
760 if (!have_full_symbols () && !have_partial_symbols ())
761 error (_("No symbol table is loaded. Use the \"file\" command."));
768 sals
= decode_line_1 (&arg1
, 0, 0, 0, 0, 0);
774 ambiguous_line_spec (&sals
);
783 /* Record whether the BEG arg is all digits. */
785 for (p
= arg
; p
!= arg1
&& *p
>= '0' && *p
<= '9'; p
++);
786 linenum_beg
= (p
== arg1
);
788 while (*arg1
== ' ' || *arg1
== '\t')
794 while (*arg1
== ' ' || *arg1
== '\t')
801 sals_end
= decode_line_1 (&arg1
, 0, 0, 0, 0, 0);
803 sals_end
= decode_line_1 (&arg1
, 0, sal
.symtab
, sal
.line
, 0, 0);
804 if (sals_end
.nelts
== 0)
806 if (sals_end
.nelts
> 1)
808 ambiguous_line_spec (&sals_end
);
809 xfree (sals_end
.sals
);
812 sal_end
= sals_end
.sals
[0];
813 xfree (sals_end
.sals
);
818 error (_("Junk at end of line specification."));
820 if (!no_end
&& !dummy_beg
&& !dummy_end
821 && sal
.symtab
!= sal_end
.symtab
)
822 error (_("Specified start and end are in different files."));
823 if (dummy_beg
&& dummy_end
)
824 error (_("Two empty args do not say what lines to list."));
826 /* if line was specified by address,
827 first print exactly which line, and which file.
828 In this case, sal.symtab == 0 means address is outside
829 of all known source files, not that user failed to give a filename. */
833 /* FIXME-32x64--assumes sal.pc fits in long. */
834 error (_("No source file for address %s."),
835 hex_string ((unsigned long) sal
.pc
));
836 sym
= find_pc_function (sal
.pc
);
838 printf_filtered ("%s is in %s (%s:%d).\n",
839 paddress (sal
.pc
), SYMBOL_PRINT_NAME (sym
),
840 sal
.symtab
->filename
, sal
.line
);
842 printf_filtered ("%s is at %s:%d.\n", paddress (sal
.pc
),
843 sal
.symtab
->filename
, sal
.line
);
846 /* If line was not specified by just a line number,
847 and it does not imply a symtab, it must be an undebuggable symbol
848 which means no source code. */
850 if (!linenum_beg
&& sal
.symtab
== 0)
851 error (_("No line number known for %s."), arg
);
853 /* If this command is repeated with RET,
854 turn it into the no-arg variant. */
859 if (dummy_beg
&& sal_end
.symtab
== 0)
860 error (_("No default source file yet. Do \"help list\"."));
862 print_source_lines (sal_end
.symtab
,
863 max (sal_end
.line
- (get_lines_to_list () - 1), 1),
864 sal_end
.line
+ 1, 0);
865 else if (sal
.symtab
== 0)
866 error (_("No default source file yet. Do \"help list\"."));
869 int first_line
= sal
.line
- get_lines_to_list () / 2;
871 if (first_line
< 1) first_line
= 1;
873 print_source_lines (sal
.symtab
,
875 first_line
+ get_lines_to_list (),
879 print_source_lines (sal
.symtab
, sal
.line
,
881 ? sal
.line
+ get_lines_to_list ()
886 /* Subroutine of disassemble_command to simplify it.
887 Perform the disassembly.
888 NAME is the name of the function if known, or NULL.
889 [LOW,HIGH) are the range of addresses to disassemble.
890 MIXED is non-zero to print source with the assembler. */
893 print_disassembly (const char *name
, CORE_ADDR low
, CORE_ADDR high
, int mixed
)
896 if (!tui_is_window_visible (DISASSEM_WIN
))
899 printf_filtered ("Dump of assembler code ");
901 printf_filtered ("for function %s:\n", name
);
903 printf_filtered ("from %s to %s:\n", paddress (low
), paddress (high
));
905 /* Dump the specified range. */
906 gdb_disassembly (uiout
, 0, 0, mixed
, -1, low
, high
);
908 printf_filtered ("End of assembler dump.\n");
909 gdb_flush (gdb_stdout
);
914 tui_show_assembly (low
);
919 /* Subroutine of disassemble_command to simplify it.
920 Print a disassembly of the current function.
921 MIXED is non-zero to print source with the assembler. */
924 disassemble_current_function (int mixed
)
926 CORE_ADDR low
, high
, pc
;
929 pc
= get_frame_pc (get_selected_frame (_("No frame selected.")));
930 if (find_pc_partial_function (pc
, &name
, &low
, &high
) == 0)
931 error (_("No function contains program counter for selected frame."));
933 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
936 /* FIXME: cagney/2004-02-07: This should be an observer. */
937 low
= tui_get_low_disassembly_address (low
, pc
);
939 low
+= gdbarch_deprecated_function_start_offset (current_gdbarch
);
941 print_disassembly (name
, low
, high
, mixed
);
944 /* Dump a specified section of assembly code.
948 - dump the assembly code for the function of the current pc
949 disassemble [/m] addr
950 - dump the assembly code for the function at ADDR
951 disassemble [/m] low high
952 - dump the assembly code in the range [LOW,HIGH)
954 A /m modifier will include source code with the assembly. */
957 disassemble_command (char *arg
, int from_tty
)
961 CORE_ADDR pc
, pc_masked
;
963 int mixed_source_and_assembly
;
966 mixed_source_and_assembly
= 0;
968 if (arg
&& *arg
== '/')
973 error (_("Missing modifier."));
975 while (*arg
&& ! isspace (*arg
))
980 mixed_source_and_assembly
= 1;
983 error (_("Invalid disassembly modifier."));
987 while (isspace (*arg
))
993 disassemble_current_function (mixed_source_and_assembly
);
997 /* FIXME: 'twould be nice to allow spaces in the expression for the first
998 arg. Allow comma separater too? */
1000 if (!(space_index
= (char *) strchr (arg
, ' ')))
1003 pc
= parse_and_eval_address (arg
);
1004 if (find_pc_partial_function (pc
, &name
, &low
, &high
) == 0)
1005 error (_("No function contains specified address."));
1007 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1010 /* FIXME: cagney/2004-02-07: This should be an observer. */
1011 low
= tui_get_low_disassembly_address (low
, pc
);
1013 low
+= gdbarch_deprecated_function_start_offset (current_gdbarch
);
1017 /* Two arguments. */
1018 *space_index
= '\0';
1019 low
= parse_and_eval_address (arg
);
1020 high
= parse_and_eval_address (space_index
+ 1);
1023 print_disassembly (name
, low
, high
, mixed_source_and_assembly
);
1027 make_command (char *arg
, int from_tty
)
1035 p
= xmalloc (sizeof ("make ") + strlen (arg
));
1036 strcpy (p
, "make ");
1037 strcpy (p
+ sizeof ("make ") - 1, arg
);
1040 shell_escape (p
, from_tty
);
1044 show_user (char *args
, int from_tty
)
1046 struct cmd_list_element
*c
;
1047 extern struct cmd_list_element
*cmdlist
;
1051 c
= lookup_cmd (&args
, cmdlist
, "", 0, 1);
1052 if (c
->class != class_user
)
1053 error (_("Not a user command."));
1054 show_user_1 (c
, gdb_stdout
);
1058 for (c
= cmdlist
; c
; c
= c
->next
)
1060 if (c
->class == class_user
)
1061 show_user_1 (c
, gdb_stdout
);
1066 /* Search through names of commands and documentations for a certain
1070 apropos_command (char *searchstr
, int from_tty
)
1072 extern struct cmd_list_element
*cmdlist
; /*This is the main command list*/
1074 char *pattern_fastmap
;
1075 char errorbuffer
[512];
1076 pattern_fastmap
= xcalloc (256, sizeof (char));
1077 if (searchstr
== NULL
)
1078 error (_("REGEXP string is empty"));
1080 if (regcomp(&pattern
,searchstr
,REG_ICASE
) == 0)
1082 pattern
.fastmap
=pattern_fastmap
;
1083 re_compile_fastmap(&pattern
);
1084 apropos_cmd (gdb_stdout
,cmdlist
,&pattern
,"");
1088 regerror(regcomp(&pattern
,searchstr
,REG_ICASE
),NULL
,errorbuffer
,512);
1089 error (_("Error in regular expression:%s"),errorbuffer
);
1091 xfree (pattern_fastmap
);
1094 /* Print a list of files and line numbers which a user may choose from
1095 in order to list a function which was specified ambiguously (as with
1096 `list classname::overloadedfuncname', for example). The vector in
1097 SALS provides the filenames and line numbers. */
1100 ambiguous_line_spec (struct symtabs_and_lines
*sals
)
1104 for (i
= 0; i
< sals
->nelts
; ++i
)
1105 printf_filtered (_("file: \"%s\", line number: %d\n"),
1106 sals
->sals
[i
].symtab
->filename
, sals
->sals
[i
].line
);
1110 set_debug (char *arg
, int from_tty
)
1112 printf_unfiltered (_("\"set debug\" must be followed by the name of a print subcommand.\n"));
1113 help_list (setdebuglist
, "set debug ", -1, gdb_stdout
);
1117 show_debug (char *args
, int from_tty
)
1119 cmd_show_list (showdebuglist
, from_tty
, "");
1123 init_cmd_lists (void)
1125 max_user_call_depth
= 1024;
1135 enablebreaklist
= NULL
;
1140 showhistlist
= NULL
;
1141 unsethistlist
= NULL
;
1142 maintenancelist
= NULL
;
1143 maintenanceinfolist
= NULL
;
1144 maintenanceprintlist
= NULL
;
1145 setprintlist
= NULL
;
1146 showprintlist
= NULL
;
1147 setchecklist
= NULL
;
1148 showchecklist
= NULL
;
1152 show_info_verbose (struct ui_file
*file
, int from_tty
,
1153 struct cmd_list_element
*c
,
1157 fprintf_filtered (file
, _("\
1158 Verbose printing of informational messages is %s.\n"), value
);
1160 fprintf_filtered (file
, _("Verbosity is %s.\n"), value
);
1164 show_history_expansion_p (struct ui_file
*file
, int from_tty
,
1165 struct cmd_list_element
*c
, const char *value
)
1167 fprintf_filtered (file
, _("History expansion on command input is %s.\n"),
1172 show_baud_rate (struct ui_file
*file
, int from_tty
,
1173 struct cmd_list_element
*c
, const char *value
)
1175 fprintf_filtered (file
, _("Baud rate for remote serial I/O is %s.\n"),
1180 show_remote_debug (struct ui_file
*file
, int from_tty
,
1181 struct cmd_list_element
*c
, const char *value
)
1183 fprintf_filtered (file
, _("Debugging of remote protocol is %s.\n"),
1188 show_remote_timeout (struct ui_file
*file
, int from_tty
,
1189 struct cmd_list_element
*c
, const char *value
)
1191 fprintf_filtered (file
, _("\
1192 Timeout limit to wait for target to respond is %s.\n"),
1197 show_max_user_call_depth (struct ui_file
*file
, int from_tty
,
1198 struct cmd_list_element
*c
, const char *value
)
1200 fprintf_filtered (file
, _("\
1201 The max call depth for user-defined commands is %s.\n"),
1207 init_cli_cmds (void)
1209 struct cmd_list_element
*c
;
1210 char *source_help_text
;
1212 /* Define the classes of commands.
1213 They will appear in the help list in the reverse of this order. */
1215 add_cmd ("internals", class_maintenance
, NULL
, _("\
1216 Maintenance commands.\n\
1217 Some gdb commands are provided just for use by gdb maintainers.\n\
1218 These commands are subject to frequent change, and may not be as\n\
1219 well documented as user commands."),
1221 add_cmd ("obscure", class_obscure
, NULL
, _("Obscure features."), &cmdlist
);
1222 add_cmd ("aliases", class_alias
, NULL
, _("Aliases of other commands."), &cmdlist
);
1223 add_cmd ("user-defined", class_user
, NULL
, _("\
1224 User-defined commands.\n\
1225 The commands in this class are those defined by the user.\n\
1226 Use the \"define\" command to define a command."), &cmdlist
);
1227 add_cmd ("support", class_support
, NULL
, _("Support facilities."), &cmdlist
);
1229 add_cmd ("status", class_info
, NULL
, _("Status inquiries."), &cmdlist
);
1230 add_cmd ("files", class_files
, NULL
, _("Specifying and examining files."),
1232 add_cmd ("breakpoints", class_breakpoint
, NULL
,
1233 _("Making program stop at certain points."), &cmdlist
);
1234 add_cmd ("data", class_vars
, NULL
, _("Examining data."), &cmdlist
);
1235 add_cmd ("stack", class_stack
, NULL
, _("\
1236 Examining the stack.\n\
1237 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1238 counting from zero for the innermost (currently executing) frame.\n\n\
1239 At any time gdb identifies one frame as the \"selected\" frame.\n\
1240 Variable lookups are done with respect to the selected frame.\n\
1241 When the program being debugged stops, gdb selects the innermost frame.\n\
1242 The commands below can be used to select other frames by number or address."),
1244 add_cmd ("running", class_run
, NULL
, _("Running the program."), &cmdlist
);
1246 /* Define general commands. */
1248 c
= add_com ("pwd", class_files
, pwd_command
, _("\
1249 Print working directory. This is used for your program as well."));
1250 set_cmd_no_selected_thread_ok (c
);
1252 c
= add_cmd ("cd", class_files
, cd_command
, _("\
1253 Set working directory to DIR for debugger and program being debugged.\n\
1254 The change does not take effect for the program being debugged\n\
1255 until the next time it is started."), &cmdlist
);
1256 set_cmd_completer (c
, filename_completer
);
1258 add_com ("echo", class_support
, echo_command
, _("\
1259 Print a constant string. Give string as argument.\n\
1260 C escape sequences may be used in the argument.\n\
1261 No newline is added at the end of the argument;\n\
1262 use \"\\n\" if you want a newline to be printed.\n\
1263 Since leading and trailing whitespace are ignored in command arguments,\n\
1264 if you want to print some you must use \"\\\" before leading whitespace\n\
1265 to be printed or after trailing whitespace."));
1266 add_com ("document", class_support
, document_command
, _("\
1267 Document a user-defined command.\n\
1268 Give command name as argument. Give documentation on following lines.\n\
1269 End with a line of just \"end\"."));
1270 add_com ("define", class_support
, define_command
, _("\
1271 Define a new command name. Command name is argument.\n\
1272 Definition appears on following lines, one command per line.\n\
1273 End with a line of just \"end\".\n\
1274 Use the \"document\" command to give documentation for the new command.\n\
1275 Commands defined in this way may have up to ten arguments."));
1277 source_help_text
= xstrprintf (_("\
1278 Read commands from a file named FILE.\n\
1279 Optional -v switch (before the filename) causes each command in\n\
1280 FILE to be echoed as it is executed.\n\
1281 Note that the file \"%s\" is read automatically in this way\n\
1282 when GDB is started."), gdbinit
);
1283 c
= add_cmd ("source", class_support
, source_command
,
1284 source_help_text
, &cmdlist
);
1285 set_cmd_completer (c
, filename_completer
);
1287 add_com ("quit", class_support
, quit_command
, _("Exit gdb."));
1288 c
= add_com ("help", class_support
, help_command
,
1289 _("Print list of commands."));
1290 set_cmd_completer (c
, command_completer
);
1291 set_cmd_no_selected_thread_ok (c
);
1292 add_com_alias ("q", "quit", class_support
, 1);
1293 add_com_alias ("h", "help", class_support
, 1);
1295 add_setshow_boolean_cmd ("verbose", class_support
, &info_verbose
, _("\
1296 Set verbosity."), _("\
1297 Show verbosity."), NULL
,
1300 &setlist
, &showlist
);
1302 add_prefix_cmd ("history", class_support
, set_history
,
1303 _("Generic command for setting command history parameters."),
1304 &sethistlist
, "set history ", 0, &setlist
);
1305 add_prefix_cmd ("history", class_support
, show_history
,
1306 _("Generic command for showing command history parameters."),
1307 &showhistlist
, "show history ", 0, &showlist
);
1309 add_setshow_boolean_cmd ("expansion", no_class
, &history_expansion_p
, _("\
1310 Set history expansion on command input."), _("\
1311 Show history expansion on command input."), _("\
1312 Without an argument, history expansion is enabled."),
1314 show_history_expansion_p
,
1315 &sethistlist
, &showhistlist
);
1317 c
= add_prefix_cmd ("info", class_info
, info_command
, _("\
1318 Generic command for showing things about the program being debugged."),
1319 &infolist
, "info ", 0, &cmdlist
);
1320 set_cmd_no_selected_thread_ok (c
);
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 c
= add_prefix_cmd ("show", class_info
, show_command
, _("\
1327 Generic command for showing things about the debugger."),
1328 &showlist
, "show ", 0, &cmdlist
);
1329 set_cmd_no_selected_thread_ok (c
);
1330 /* Another way to get at the same thing. */
1331 add_info ("set", show_command
, _("Show all GDB settings."));
1333 add_cmd ("commands", no_class
, show_commands
, _("\
1334 Show the history of commands you typed.\n\
1335 You can supply a command number to start with, or a `+' to start after\n\
1336 the previous command number shown."),
1339 add_cmd ("version", no_class
, show_version
,
1340 _("Show what version of GDB this is."), &showlist
);
1342 add_com ("while", class_support
, while_command
, _("\
1343 Execute nested commands WHILE the conditional expression is non zero.\n\
1344 The conditional expression must follow the word `while' and must in turn be\n\
1345 followed by a new line. The nested commands must be entered one per line,\n\
1346 and should be terminated by the word `end'."));
1348 add_com ("if", class_support
, if_command
, _("\
1349 Execute nested commands once IF the conditional expression is non zero.\n\
1350 The conditional expression must follow the word `if' and must in turn be\n\
1351 followed by a new line. The nested commands must be entered one per line,\n\
1352 and should be terminated by the word 'else' or `end'. If an else clause\n\
1353 is used, the same rules apply to its nested commands as to the first ones."));
1355 /* If target is open when baud changes, it doesn't take effect until the
1356 next open (I think, not sure). */
1357 add_setshow_zinteger_cmd ("remotebaud", no_class
, &baud_rate
, _("\
1358 Set baud rate for remote serial I/O."), _("\
1359 Show baud rate for remote serial I/O."), _("\
1360 This value is used to set the speed of the serial port when debugging\n\
1361 using remote targets."),
1364 &setlist
, &showlist
);
1366 add_setshow_zinteger_cmd ("remote", no_class
, &remote_debug
, _("\
1367 Set debugging of remote protocol."), _("\
1368 Show debugging of remote protocol."), _("\
1369 When enabled, each packet sent or received with the remote target\n\
1373 &setdebuglist
, &showdebuglist
);
1375 add_setshow_integer_cmd ("remotetimeout", no_class
, &remote_timeout
, _("\
1376 Set timeout limit to wait for target to respond."), _("\
1377 Show timeout limit to wait for target to respond."), _("\
1378 This value is used to set the time limit for gdb to wait for a response\n\
1381 show_remote_timeout
,
1382 &setlist
, &showlist
);
1384 add_prefix_cmd ("debug", no_class
, set_debug
,
1385 _("Generic command for setting gdb debugging flags"),
1386 &setdebuglist
, "set debug ", 0, &setlist
);
1388 add_prefix_cmd ("debug", no_class
, show_debug
,
1389 _("Generic command for showing gdb debugging flags"),
1390 &showdebuglist
, "show debug ", 0, &showlist
);
1392 c
= add_com ("shell", class_support
, shell_escape
, _("\
1393 Execute the rest of the line as a shell command.\n\
1394 With no arguments, run an inferior shell."));
1395 set_cmd_completer (c
, filename_completer
);
1397 c
= add_com ("edit", class_files
, edit_command
, _("\
1398 Edit specified file or function.\n\
1399 With no argument, edits file containing most recent line listed.\n\
1400 Editing targets can be specified in these ways:\n\
1401 FILE:LINENUM, to edit at that line in that file,\n\
1402 FUNCTION, to edit at the beginning of that function,\n\
1403 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1404 *ADDRESS, to edit at the line containing that address.\n\
1405 Uses EDITOR environment variable contents as editor (or ex as default)."));
1407 c
->completer
= location_completer
;
1409 add_com ("list", class_files
, list_command
, _("\
1410 List specified function or line.\n\
1411 With no argument, lists ten more lines after or around previous listing.\n\
1412 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1413 One argument specifies a line, and ten lines are listed around that line.\n\
1414 Two arguments with comma between specify starting and ending lines to list.\n\
1415 Lines can be specified in these ways:\n\
1416 LINENUM, to list around that line in current file,\n\
1417 FILE:LINENUM, to list around that line in that file,\n\
1418 FUNCTION, to list around beginning of that function,\n\
1419 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1420 *ADDRESS, to list around the line containing that address.\n\
1421 With two args if one is empty it stands for ten lines away from the other arg."));
1424 add_com_alias ("l", "list", class_files
, 1);
1426 add_com_alias ("v", "list", class_files
, 1);
1429 add_com_alias ("file", "list", class_files
, 1);
1431 c
= add_com ("disassemble", class_vars
, disassemble_command
, _("\
1432 Disassemble a specified section of memory.\n\
1433 Default is the function surrounding the pc of the selected frame.\n\
1434 With a /m modifier, source lines are included (if available).\n\
1435 With a single argument, the function surrounding that address is dumped.\n\
1436 Two arguments are taken as a range of memory to dump."));
1437 set_cmd_completer (c
, location_completer
);
1439 add_com_alias ("va", "disassemble", class_xdb
, 0);
1441 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1442 be a really useful feature. Unfortunately, the below wont do
1443 this. Instead it adds support for the form ``(gdb) ! ls''
1444 (i.e. the space is required). If the ``!'' command below is
1445 added the complains about no ``!'' command would be replaced by
1446 complains about how the ``!'' command is broken :-) */
1448 add_com_alias ("!", "shell", class_support
, 0);
1450 c
= add_com ("make", class_support
, make_command
, _("\
1451 Run the ``make'' program using the rest of the line as arguments."));
1452 set_cmd_completer (c
, filename_completer
);
1453 add_cmd ("user", no_class
, show_user
, _("\
1454 Show definitions of user defined commands.\n\
1455 Argument is the name of the user defined command.\n\
1456 With no argument, show definitions of all user defined commands."), &showlist
);
1457 add_com ("apropos", class_support
, apropos_command
,
1458 _("Search for commands matching a REGEXP"));
1460 add_setshow_integer_cmd ("max-user-call-depth", no_class
,
1461 &max_user_call_depth
, _("\
1462 Set the max call depth for user-defined commands."), _("\
1463 Show the max call depth for user-defined commands."), NULL
,
1465 show_max_user_call_depth
,
1466 &setlist
, &showlist
);
1468 add_setshow_boolean_cmd ("trace-commands", no_class
, &trace_commands
, _("\
1469 Set tracing of GDB CLI commands."), _("\
1470 Show state of GDB CLI command tracing."), _("\
1471 When 'on', each command is displayed as it is executed."),
1474 &setlist
, &showlist
);