3 Copyright 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
23 #include <readline/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"
48 #ifndef GDBINIT_FILENAME
49 #define GDBINIT_FILENAME ".gdbinit"
52 /* Prototypes for local command functions */
54 static void complete_command (char *, int);
56 static void echo_command (char *, int);
58 static void pwd_command (char *, int);
60 static void show_version (char *, int);
62 static void validate_comname (char *);
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 "enable breakpoint" subcommands. */
125 struct cmd_list_element
*enablebreaklist
;
127 /* Chain containing all defined set subcommands */
129 struct cmd_list_element
*setlist
;
131 /* Chain containing all defined unset subcommands */
133 struct cmd_list_element
*unsetlist
;
135 /* Chain containing all defined show subcommands. */
137 struct cmd_list_element
*showlist
;
139 /* Chain containing all defined \"set history\". */
141 struct cmd_list_element
*sethistlist
;
143 /* Chain containing all defined \"show history\". */
145 struct cmd_list_element
*showhistlist
;
147 /* Chain containing all defined \"unset history\". */
149 struct cmd_list_element
*unsethistlist
;
151 /* Chain containing all defined maintenance subcommands. */
153 struct cmd_list_element
*maintenancelist
;
155 /* Chain containing all defined "maintenance info" subcommands. */
157 struct cmd_list_element
*maintenanceinfolist
;
159 /* Chain containing all defined "maintenance print" subcommands. */
161 struct cmd_list_element
*maintenanceprintlist
;
163 struct cmd_list_element
*setprintlist
;
165 struct cmd_list_element
*showprintlist
;
167 struct cmd_list_element
*setdebuglist
;
169 struct cmd_list_element
*showdebuglist
;
171 struct cmd_list_element
*setchecklist
;
173 struct cmd_list_element
*showchecklist
;
175 /* Utility used everywhere when at least one argument is needed and
179 error_no_arg (char *why
)
181 error ("Argument required (%s).", why
);
184 /* The "info" command is defined as a prefix, with allow_unknown = 0.
185 Therefore, its own definition is called only for "info" with no args. */
189 info_command (char *arg
, int from_tty
)
191 printf_unfiltered ("\"info\" must be followed by the name of an info command.\n");
192 help_list (infolist
, "info ", -1, gdb_stdout
);
195 /* The "show" command with no arguments shows all the settings. */
199 show_command (char *arg
, int from_tty
)
201 cmd_show_list (showlist
, from_tty
, "");
204 /* Provide documentation on command or list given by COMMAND. FROM_TTY
209 help_command (char *command
, int from_tty
)
211 help_cmd (command
, gdb_stdout
);
214 /* String compare function for qsort. */
216 compare_strings (const void *arg1
, const void *arg2
)
218 const char **s1
= (const char **) arg1
;
219 const char **s2
= (const char **) arg2
;
220 return strcmp (*s1
, *s2
);
223 /* The "complete" command is used by Emacs to implement completion. */
227 complete_command (char *arg
, int from_tty
)
237 argpoint
= strlen (arg
);
239 completions
= complete_line (arg
, arg
, argpoint
);
245 for (size
= 0; completions
[size
]; ++size
)
247 qsort (completions
, size
, sizeof (char *), compare_strings
);
249 /* We do extra processing here since we only want to print each
255 printf_unfiltered ("%s\n", completions
[item
]);
256 next_item
= item
+ 1;
257 while (next_item
< size
258 && ! strcmp (completions
[item
], completions
[next_item
]))
260 xfree (completions
[next_item
]);
264 xfree (completions
[item
]);
273 is_complete_command (struct cmd_list_element
*c
)
275 return cmd_cfunc_eq (c
, complete_command
);
280 show_version (char *args
, int from_tty
)
283 print_gdb_version (gdb_stdout
);
284 printf_filtered ("\n");
288 /* Handle the quit command. */
291 quit_command (char *args
, int from_tty
)
293 if (!quit_confirm ())
294 error ("Not confirmed.");
295 quit_force (args
, from_tty
);
300 pwd_command (char *args
, int from_tty
)
303 error ("The \"pwd\" command does not take an argument: %s", args
);
304 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
306 if (!STREQ (gdb_dirbuf
, current_directory
))
307 printf_unfiltered ("Working directory %s\n (canonically %s).\n",
308 current_directory
, gdb_dirbuf
);
310 printf_unfiltered ("Working directory %s.\n", current_directory
);
314 cd_command (char *dir
, int from_tty
)
317 /* Found something other than leading repetitions of "/..". */
321 /* If the new directory is absolute, repeat is a no-op; if relative,
322 repeat might be useful but is more likely to be a mistake. */
326 error_no_arg ("new working directory");
328 dir
= tilde_expand (dir
);
329 make_cleanup (xfree
, dir
);
332 perror_with_name (dir
);
334 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
335 /* There's too much mess with DOSish names like "d:", "d:.",
336 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
337 simply get the canonicalized name of the current directory. */
338 dir
= getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
342 if (IS_DIR_SEPARATOR (dir
[len
- 1]))
344 /* Remove the trailing slash unless this is a root directory
345 (including a drive letter on non-Unix systems). */
346 if (!(len
== 1) /* "/" */
347 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
348 && !(len
== 3 && dir
[1] == ':') /* "d:/" */
354 dir
= savestring (dir
, len
);
355 if (IS_ABSOLUTE_PATH (dir
))
356 current_directory
= dir
;
359 if (IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1]))
360 current_directory
= concat (current_directory
, dir
, NULL
);
362 current_directory
= concat (current_directory
, SLASH_STRING
, dir
, NULL
);
366 /* Now simplify any occurrences of `.' and `..' in the pathname. */
369 for (p
= current_directory
; *p
;)
371 if (IS_DIR_SEPARATOR (p
[0]) && p
[1] == '.'
372 && (p
[2] == 0 || IS_DIR_SEPARATOR (p
[2])))
374 else if (IS_DIR_SEPARATOR (p
[0]) && p
[1] == '.' && p
[2] == '.'
375 && (p
[3] == 0 || IS_DIR_SEPARATOR (p
[3])))
379 /* Search backwards for the directory just before the "/.."
380 and obliterate it and the "/..". */
382 while (q
!= current_directory
&& !IS_DIR_SEPARATOR (q
[-1]))
385 if (q
== current_directory
)
386 /* current_directory is
387 a relative pathname ("can't happen"--leave it alone). */
391 strcpy (q
- 1, p
+ 3);
396 /* We are dealing with leading repetitions of "/..", for example
397 "/../..", which is the Mach super-root. */
407 forget_cached_source_info ();
410 pwd_command ((char *) 0, 1);
414 source_command (char *args
, int from_tty
)
417 struct cleanup
*old_cleanups
;
422 error ("source command requires pathname of file to source.");
425 file
= tilde_expand (file
);
426 old_cleanups
= make_cleanup (xfree
, file
);
428 stream
= fopen (file
, FOPEN_RT
);
432 perror_with_name (file
);
437 script_from_file (stream
, file
);
439 do_cleanups (old_cleanups
);
444 echo_command (char *text
, int from_tty
)
450 while ((c
= *p
++) != '\0')
454 /* \ at end of argument is used after spaces
455 so they won't be lost. */
459 c
= parse_escape (&p
);
461 printf_filtered ("%c", c
);
464 printf_filtered ("%c", c
);
467 /* Force this output to appear now. */
469 gdb_flush (gdb_stdout
);
474 shell_escape (char *arg
, int from_tty
)
477 /* If ARG is NULL, they want an inferior shell, but `system' just
478 reports if the shell is available when passed a NULL arg. */
479 int rc
= system (arg
? arg
: "");
482 arg
= "inferior shell";
486 fprintf_unfiltered (gdb_stderr
, "Cannot execute %s: %s\n", arg
,
487 safe_strerror (errno
));
488 gdb_flush (gdb_stderr
);
492 fprintf_unfiltered (gdb_stderr
, "%s exited with status %d\n", arg
, rc
);
493 gdb_flush (gdb_stderr
);
496 /* Make sure to return to the directory GDB thinks it is, in case the
497 shell command we just ran changed it. */
498 chdir (current_directory
);
500 #else /* Can fork. */
503 if ((pid
= vfork ()) == 0)
505 char *p
, *user_shell
;
507 if ((user_shell
= (char *) getenv ("SHELL")) == NULL
)
508 user_shell
= "/bin/sh";
510 /* Get the name of the shell for arg0 */
511 if ((p
= strrchr (user_shell
, '/')) == NULL
)
514 p
++; /* Get past '/' */
517 execl (user_shell
, p
, 0);
519 execl (user_shell
, p
, "-c", arg
, 0);
521 fprintf_unfiltered (gdb_stderr
, "Cannot execute %s: %s\n", user_shell
,
522 safe_strerror (errno
));
523 gdb_flush (gdb_stderr
);
528 while ((rc
= wait (&status
)) != pid
&& rc
!= -1)
531 error ("Fork failed");
532 #endif /* Can fork. */
536 edit_command (char *arg
, int from_tty
)
538 struct symtabs_and_lines sals
;
539 struct symtab_and_line sal
;
547 /* Pull in the current default source line if necessary */
550 set_default_source_symtab_and_line ();
551 sal
= get_current_source_symtab_and_line ();
554 /* bare "edit" edits file with present line. */
559 error ("No default source file yet.");
560 sal
.line
+= get_lines_to_list () / 2;
565 /* Now should only be one argument -- decode it in SAL */
568 sals
= decode_line_1 (&arg1
, 0, 0, 0, 0);
570 if (! sals
.nelts
) return; /* C++ */
571 if (sals
.nelts
> 1) {
572 ambiguous_line_spec (&sals
);
581 error ("Junk at end of line specification.");
583 /* if line was specified by address,
584 first print exactly which line, and which file.
585 In this case, sal.symtab == 0 means address is outside
586 of all known source files, not that user failed to give a filename. */
590 /* FIXME-32x64--assumes sal.pc fits in long. */
591 error ("No source file for address %s.",
592 local_hex_string((unsigned long) sal
.pc
));
593 sym
= find_pc_function (sal
.pc
);
596 print_address_numeric (sal
.pc
, 1, gdb_stdout
);
597 printf_filtered (" is in ");
598 fputs_filtered (SYMBOL_PRINT_NAME (sym
), gdb_stdout
);
599 printf_filtered (" (%s:%d).\n", sal
.symtab
->filename
, sal
.line
);
603 print_address_numeric (sal
.pc
, 1, gdb_stdout
);
604 printf_filtered (" is at %s:%d.\n",
605 sal
.symtab
->filename
, sal
.line
);
609 /* If what was given does not imply a symtab, it must be an undebuggable
610 symbol which means no source code. */
613 error ("No line number known for %s.", arg
);
616 if ((editor
= (char *) getenv ("EDITOR")) == NULL
)
619 /* Approximate base-10 log of line to 1 unit for digit count */
620 for(log10
=32, m
=0x80000000; !(sal
.line
& m
) && log10
>0; log10
--, m
=m
>>1);
621 log10
= 1 + (int)((log10
+ (0 == ((m
-1) & sal
.line
)))/3.32192809);
623 cmdlen
= strlen(editor
) + 1
624 + (NULL
== sal
.symtab
->dirname
? 0 : strlen(sal
.symtab
->dirname
) + 1)
625 + (NULL
== sal
.symtab
->filename
? 0 : strlen(sal
.symtab
->filename
)+ 1)
629 sprintf(p
,"%s +%d %s%s",editor
,sal
.line
,
630 (NULL
== sal
.symtab
->dirname
? "./" :
631 (NULL
!= sal
.symtab
->filename
&& *(sal
.symtab
->filename
) != '/') ?
632 sal
.symtab
->dirname
: ""),
633 (NULL
== sal
.symtab
->filename
? "unknown" : sal
.symtab
->filename
)
635 shell_escape(p
, from_tty
);
641 list_command (char *arg
, int from_tty
)
643 struct symtabs_and_lines sals
, sals_end
;
644 struct symtab_and_line sal
, sal_end
, cursal
;
653 /* Pull in the current default source line if necessary */
654 if (arg
== 0 || arg
[0] == '+' || arg
[0] == '-')
656 set_default_source_symtab_and_line ();
657 cursal
= get_current_source_symtab_and_line ();
660 /* "l" or "l +" lists next ten lines. */
662 if (arg
== 0 || STREQ (arg
, "+"))
664 print_source_lines (cursal
.symtab
, cursal
.line
,
665 cursal
.line
+ get_lines_to_list (), 0);
669 /* "l -" lists previous ten lines, the ones before the ten just listed. */
670 if (STREQ (arg
, "-"))
672 print_source_lines (cursal
.symtab
,
673 max (get_first_line_listed () - get_lines_to_list (), 1),
674 get_first_line_listed (), 0);
678 /* Now if there is only one argument, decode it in SAL
680 If there are two arguments, decode them in SAL and SAL_END
681 and clear NO_END; however, if one of the arguments is blank,
682 set DUMMY_BEG or DUMMY_END to record that fact. */
684 if (!have_full_symbols () && !have_partial_symbols ())
685 error ("No symbol table is loaded. Use the \"file\" command.");
692 sals
= decode_line_1 (&arg1
, 0, 0, 0, 0);
698 ambiguous_line_spec (&sals
);
707 /* Record whether the BEG arg is all digits. */
709 for (p
= arg
; p
!= arg1
&& *p
>= '0' && *p
<= '9'; p
++);
710 linenum_beg
= (p
== arg1
);
712 while (*arg1
== ' ' || *arg1
== '\t')
718 while (*arg1
== ' ' || *arg1
== '\t')
725 sals_end
= decode_line_1 (&arg1
, 0, 0, 0, 0);
727 sals_end
= decode_line_1 (&arg1
, 0, sal
.symtab
, sal
.line
, 0);
728 if (sals_end
.nelts
== 0)
730 if (sals_end
.nelts
> 1)
732 ambiguous_line_spec (&sals_end
);
733 xfree (sals_end
.sals
);
736 sal_end
= sals_end
.sals
[0];
737 xfree (sals_end
.sals
);
742 error ("Junk at end of line specification.");
744 if (!no_end
&& !dummy_beg
&& !dummy_end
745 && sal
.symtab
!= sal_end
.symtab
)
746 error ("Specified start and end are in different files.");
747 if (dummy_beg
&& dummy_end
)
748 error ("Two empty args do not say what lines to list.");
750 /* if line was specified by address,
751 first print exactly which line, and which file.
752 In this case, sal.symtab == 0 means address is outside
753 of all known source files, not that user failed to give a filename. */
757 /* FIXME-32x64--assumes sal.pc fits in long. */
758 error ("No source file for address %s.",
759 local_hex_string ((unsigned long) sal
.pc
));
760 sym
= find_pc_function (sal
.pc
);
763 print_address_numeric (sal
.pc
, 1, gdb_stdout
);
764 printf_filtered (" is in ");
765 fputs_filtered (SYMBOL_PRINT_NAME (sym
), gdb_stdout
);
766 printf_filtered (" (%s:%d).\n", sal
.symtab
->filename
, sal
.line
);
770 print_address_numeric (sal
.pc
, 1, gdb_stdout
);
771 printf_filtered (" is at %s:%d.\n",
772 sal
.symtab
->filename
, sal
.line
);
776 /* If line was not specified by just a line number,
777 and it does not imply a symtab, it must be an undebuggable symbol
778 which means no source code. */
780 if (!linenum_beg
&& sal
.symtab
== 0)
781 error ("No line number known for %s.", arg
);
783 /* If this command is repeated with RET,
784 turn it into the no-arg variant. */
789 if (dummy_beg
&& sal_end
.symtab
== 0)
790 error ("No default source file yet. Do \"help list\".");
792 print_source_lines (sal_end
.symtab
,
793 max (sal_end
.line
- (get_lines_to_list () - 1), 1),
794 sal_end
.line
+ 1, 0);
795 else if (sal
.symtab
== 0)
796 error ("No default source file yet. Do \"help list\".");
799 int first_line
= sal
.line
- get_lines_to_list () / 2;
801 if (first_line
< 1) first_line
= 1;
803 print_source_lines (sal
.symtab
,
805 first_line
+ get_lines_to_list (),
809 print_source_lines (sal
.symtab
, sal
.line
,
811 ? sal
.line
+ get_lines_to_list ()
816 /* Dump a specified section of assembly code. With no command line
817 arguments, this command will dump the assembly code for the
818 function surrounding the pc value in the selected frame. With one
819 argument, it will dump the assembly code surrounding that pc value.
820 Two arguments are interpeted as bounds within which to dump
825 disassemble_command (char *arg
, int from_tty
)
829 CORE_ADDR pc
, pc_masked
;
838 if (!deprecated_selected_frame
)
839 error ("No frame selected.\n");
841 pc
= get_frame_pc (deprecated_selected_frame
);
842 if (find_pc_partial_function (pc
, &name
, &low
, &high
) == 0)
843 error ("No function contains program counter for selected frame.\n");
845 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
848 low
= tuiGetLowDisassemblyAddress (low
, pc
);
850 low
+= FUNCTION_START_OFFSET
;
852 else if (!(space_index
= (char *) strchr (arg
, ' ')))
855 pc
= parse_and_eval_address (arg
);
856 if (find_pc_partial_function (pc
, &name
, &low
, &high
) == 0)
857 error ("No function contains specified address.\n");
859 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
862 low
= tuiGetLowDisassemblyAddress (low
, pc
);
864 low
+= FUNCTION_START_OFFSET
;
870 low
= parse_and_eval_address (arg
);
871 high
= parse_and_eval_address (space_index
+ 1);
875 if (!tui_is_window_visible (DISASSEM_WIN
))
878 printf_filtered ("Dump of assembler code ");
881 printf_filtered ("for function %s:\n", name
);
885 printf_filtered ("from ");
886 print_address_numeric (low
, 1, gdb_stdout
);
887 printf_filtered (" to ");
888 print_address_numeric (high
, 1, gdb_stdout
);
889 printf_filtered (":\n");
892 /* Dump the specified range. */
893 gdb_disassembly (uiout
, 0, 0, 0, -1, low
, high
);
895 printf_filtered ("End of assembler dump.\n");
896 gdb_flush (gdb_stdout
);
901 tui_show_assembly (low
);
907 make_command (char *arg
, int from_tty
)
915 p
= xmalloc (sizeof ("make ") + strlen (arg
));
917 strcpy (p
+ sizeof ("make ") - 1, arg
);
920 shell_escape (p
, from_tty
);
925 show_user (char *args
, int from_tty
)
927 struct cmd_list_element
*c
;
928 extern struct cmd_list_element
*cmdlist
;
932 c
= lookup_cmd (&args
, cmdlist
, "", 0, 1);
933 if (c
->class != class_user
)
934 error ("Not a user command.");
935 show_user_1 (c
, gdb_stdout
);
939 for (c
= cmdlist
; c
; c
= c
->next
)
941 if (c
->class == class_user
)
942 show_user_1 (c
, gdb_stdout
);
947 /* Search through names of commands and documentations for a certain
951 apropos_command (char *searchstr
, int from_tty
)
953 extern struct cmd_list_element
*cmdlist
; /*This is the main command list*/
955 char *pattern_fastmap
;
956 char errorbuffer
[512];
957 pattern_fastmap
= xcalloc (256, sizeof (char));
958 if (searchstr
== NULL
)
959 error("REGEXP string is empty");
961 if (regcomp(&pattern
,searchstr
,REG_ICASE
) == 0)
963 pattern
.fastmap
=pattern_fastmap
;
964 re_compile_fastmap(&pattern
);
965 apropos_cmd (gdb_stdout
,cmdlist
,&pattern
,"");
969 regerror(regcomp(&pattern
,searchstr
,REG_ICASE
),NULL
,errorbuffer
,512);
970 error("Error in regular expression:%s",errorbuffer
);
972 xfree (pattern_fastmap
);
975 /* Print a list of files and line numbers which a user may choose from
976 in order to list a function which was specified ambiguously (as with
977 `list classname::overloadedfuncname', for example). The vector in
978 SALS provides the filenames and line numbers. */
981 ambiguous_line_spec (struct symtabs_and_lines
*sals
)
985 for (i
= 0; i
< sals
->nelts
; ++i
)
986 printf_filtered ("file: \"%s\", line number: %d\n",
987 sals
->sals
[i
].symtab
->filename
, sals
->sals
[i
].line
);
991 set_debug (char *arg
, int from_tty
)
993 printf_unfiltered ("\"set debug\" must be followed by the name of a print subcommand.\n");
994 help_list (setdebuglist
, "set debug ", -1, gdb_stdout
);
998 show_debug (char *args
, int from_tty
)
1000 cmd_show_list (showdebuglist
, from_tty
, "");
1004 init_cmd_lists (void)
1006 max_user_call_depth
= 1024;
1015 enablebreaklist
= NULL
;
1020 showhistlist
= NULL
;
1021 unsethistlist
= NULL
;
1022 maintenancelist
= NULL
;
1023 maintenanceinfolist
= NULL
;
1024 maintenanceprintlist
= NULL
;
1025 setprintlist
= NULL
;
1026 showprintlist
= NULL
;
1027 setchecklist
= NULL
;
1028 showchecklist
= NULL
;
1033 init_cli_cmds (void)
1035 struct cmd_list_element
*c
;
1037 /* Define the classes of commands.
1038 They will appear in the help list in the reverse of this order. */
1040 add_cmd ("internals", class_maintenance
, NULL
,
1041 "Maintenance commands.\n\
1042 Some gdb commands are provided just for use by gdb maintainers.\n\
1043 These commands are subject to frequent change, and may not be as\n\
1044 well documented as user commands.",
1046 add_cmd ("obscure", class_obscure
, NULL
, "Obscure features.", &cmdlist
);
1047 add_cmd ("aliases", class_alias
, NULL
, "Aliases of other commands.", &cmdlist
);
1048 add_cmd ("user-defined", class_user
, NULL
, "User-defined commands.\n\
1049 The commands in this class are those defined by the user.\n\
1050 Use the \"define\" command to define a command.", &cmdlist
);
1051 add_cmd ("support", class_support
, NULL
, "Support facilities.", &cmdlist
);
1053 add_cmd ("status", class_info
, NULL
, "Status inquiries.", &cmdlist
);
1054 add_cmd ("files", class_files
, NULL
, "Specifying and examining files.", &cmdlist
);
1055 add_cmd ("breakpoints", class_breakpoint
, NULL
, "Making program stop at certain points.", &cmdlist
);
1056 add_cmd ("data", class_vars
, NULL
, "Examining data.", &cmdlist
);
1057 add_cmd ("stack", class_stack
, NULL
, "Examining the stack.\n\
1058 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1059 counting from zero for the innermost (currently executing) frame.\n\n\
1060 At any time gdb identifies one frame as the \"selected\" frame.\n\
1061 Variable lookups are done with respect to the selected frame.\n\
1062 When the program being debugged stops, gdb selects the innermost frame.\n\
1063 The commands below can be used to select other frames by number or address.",
1065 add_cmd ("running", class_run
, NULL
, "Running the program.", &cmdlist
);
1067 /* Define general commands. */
1069 add_com ("pwd", class_files
, pwd_command
,
1070 "Print working directory. This is used for your program as well.");
1071 c
= add_cmd ("cd", class_files
, cd_command
,
1072 "Set working directory to DIR for debugger and program being debugged.\n\
1073 The change does not take effect for the program being debugged\n\
1074 until the next time it is started.", &cmdlist
);
1075 set_cmd_completer (c
, filename_completer
);
1077 add_com ("echo", class_support
, echo_command
,
1078 "Print a constant string. Give string as argument.\n\
1079 C escape sequences may be used in the argument.\n\
1080 No newline is added at the end of the argument;\n\
1081 use \"\\n\" if you want a newline to be printed.\n\
1082 Since leading and trailing whitespace are ignored in command arguments,\n\
1083 if you want to print some you must use \"\\\" before leading whitespace\n\
1084 to be printed or after trailing whitespace.");
1085 add_com ("document", class_support
, document_command
,
1086 "Document a user-defined command.\n\
1087 Give command name as argument. Give documentation on following lines.\n\
1088 End with a line of just \"end\".");
1089 add_com ("define", class_support
, define_command
,
1090 "Define a new command name. Command name is argument.\n\
1091 Definition appears on following lines, one command per line.\n\
1092 End with a line of just \"end\".\n\
1093 Use the \"document\" command to give documentation for the new command.\n\
1094 Commands defined in this way may have up to ten arguments.");
1096 c
= add_cmd ("source", class_support
, source_command
,
1097 "Read commands from a file named FILE.\n\
1098 Note that the file \"" GDBINIT_FILENAME
"\" is read automatically in this way\n\
1099 when gdb is started.", &cmdlist
);
1100 set_cmd_completer (c
, filename_completer
);
1102 add_com ("quit", class_support
, quit_command
, "Exit gdb.");
1103 c
= add_com ("help", class_support
, help_command
, "Print list of commands.");
1104 set_cmd_completer (c
, command_completer
);
1105 add_com_alias ("q", "quit", class_support
, 1);
1106 add_com_alias ("h", "help", class_support
, 1);
1108 c
= add_set_cmd ("verbose", class_support
, var_boolean
, (char *) &info_verbose
,
1111 add_show_from_set (c
, &showlist
);
1112 set_cmd_sfunc (c
, set_verbose
);
1113 set_verbose (NULL
, 0, c
);
1115 add_prefix_cmd ("history", class_support
, set_history
,
1116 "Generic command for setting command history parameters.",
1117 &sethistlist
, "set history ", 0, &setlist
);
1118 add_prefix_cmd ("history", class_support
, show_history
,
1119 "Generic command for showing command history parameters.",
1120 &showhistlist
, "show history ", 0, &showlist
);
1123 (add_set_cmd ("expansion", no_class
, var_boolean
, (char *) &history_expansion_p
,
1124 "Set history expansion on command input.\n\
1125 Without an argument, history expansion is enabled.", &sethistlist
),
1128 add_prefix_cmd ("info", class_info
, info_command
,
1129 "Generic command for showing things about the program being debugged.",
1130 &infolist
, "info ", 0, &cmdlist
);
1131 add_com_alias ("i", "info", class_info
, 1);
1133 add_com ("complete", class_obscure
, complete_command
,
1134 "List the completions for the rest of the line as a command.");
1136 add_prefix_cmd ("show", class_info
, show_command
,
1137 "Generic command for showing things about the debugger.",
1138 &showlist
, "show ", 0, &cmdlist
);
1139 /* Another way to get at the same thing. */
1140 add_info ("set", show_command
, "Show all GDB settings.");
1142 add_cmd ("commands", no_class
, show_commands
,
1143 "Show the history of commands you typed.\n\
1144 You can supply a command number to start with, or a `+' to start after\n\
1145 the previous command number shown.",
1148 add_cmd ("version", no_class
, show_version
,
1149 "Show what version of GDB this is.", &showlist
);
1151 add_com ("while", class_support
, while_command
,
1152 "Execute nested commands WHILE the conditional expression is non zero.\n\
1153 The conditional expression must follow the word `while' and must in turn be\n\
1154 followed by a new line. The nested commands must be entered one per line,\n\
1155 and should be terminated by the word `end'.");
1157 add_com ("if", class_support
, if_command
,
1158 "Execute nested commands once IF the conditional expression is non zero.\n\
1159 The conditional expression must follow the word `if' and must in turn be\n\
1160 followed by a new line. The nested commands must be entered one per line,\n\
1161 and should be terminated by the word 'else' or `end'. If an else clause\n\
1162 is used, the same rules apply to its nested commands as to the first ones.");
1164 /* If target is open when baud changes, it doesn't take effect until the
1165 next open (I think, not sure). */
1166 add_show_from_set (add_set_cmd ("remotebaud", no_class
,
1167 var_zinteger
, (char *) &baud_rate
,
1168 "Set baud rate for remote serial I/O.\n\
1169 This value is used to set the speed of the serial port when debugging\n\
1170 using remote targets.", &setlist
),
1173 c
= add_set_cmd ("remotedebug", no_class
, var_zinteger
,
1174 (char *) &remote_debug
,
1175 "Set debugging of remote protocol.\n\
1176 When enabled, each packet sent or received with the remote target\n\
1177 is displayed.", &setlist
);
1178 deprecate_cmd (c
, "set debug remote");
1179 deprecate_cmd (add_show_from_set (c
, &showlist
), "show debug remote");
1181 add_show_from_set (add_set_cmd ("remote", no_class
, var_zinteger
,
1182 (char *) &remote_debug
,
1183 "Set debugging of remote protocol.\n\
1184 When enabled, each packet sent or received with the remote target\n\
1185 is displayed.", &setdebuglist
),
1189 add_set_cmd ("remotetimeout", no_class
, var_integer
, (char *) &remote_timeout
,
1190 "Set timeout limit to wait for target to respond.\n\
1191 This value is used to set the time limit for gdb to wait for a response\n\
1192 from the target.", &setlist
),
1195 add_prefix_cmd ("debug", no_class
, set_debug
,
1196 "Generic command for setting gdb debugging flags",
1197 &setdebuglist
, "set debug ", 0, &setlist
);
1199 add_prefix_cmd ("debug", no_class
, show_debug
,
1200 "Generic command for showing gdb debugging flags",
1201 &showdebuglist
, "show debug ", 0, &showlist
);
1203 c
= add_com ("shell", class_support
, shell_escape
,
1204 "Execute the rest of the line as a shell command.\n\
1205 With no arguments, run an inferior shell.");
1206 set_cmd_completer (c
, filename_completer
);
1208 c
= add_com ("edit", class_files
, edit_command
,
1209 concat ("Edit specified file or function.\n\
1210 With no argument, edits file containing most recent line listed.\n\
1212 Editing targets can be specified in these ways:\n\
1213 FILE:LINENUM, to edit at that line in that file,\n\
1214 FUNCTION, to edit at the beginning of that function,\n\
1215 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1216 *ADDRESS, to edit at the line containing that address.\n\
1217 Uses EDITOR environment variable contents as editor (or ex as default).",NULL
));
1219 c
->completer
= location_completer
;
1221 add_com ("list", class_files
, list_command
,
1222 concat ("List specified function or line.\n\
1223 With no argument, lists ten more lines after or around previous listing.\n\
1224 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1225 One argument specifies a line, and ten lines are listed around that line.\n\
1226 Two arguments with comma between specify starting and ending lines to list.\n\
1228 Lines can be specified in these ways:\n\
1229 LINENUM, to list around that line in current file,\n\
1230 FILE:LINENUM, to list around that line in that file,\n\
1231 FUNCTION, to list around beginning of that function,\n\
1232 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1233 *ADDRESS, to list around the line containing that address.\n\
1234 With two args if one is empty it stands for ten lines away from the other arg.", NULL
));
1237 add_com_alias ("l", "list", class_files
, 1);
1239 add_com_alias ("v", "list", class_files
, 1);
1242 add_com_alias ("file", "list", class_files
, 1);
1244 c
= add_com ("disassemble", class_vars
, disassemble_command
,
1245 "Disassemble a specified section of memory.\n\
1246 Default is the function surrounding the pc of the selected frame.\n\
1247 With a single argument, the function surrounding that address is dumped.\n\
1248 Two arguments are taken as a range of memory to dump.");
1249 set_cmd_completer (c
, location_completer
);
1251 add_com_alias ("va", "disassemble", class_xdb
, 0);
1253 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1254 be a really useful feature. Unfortunately, the below wont do
1255 this. Instead it adds support for the form ``(gdb) ! ls''
1256 (i.e. the space is required). If the ``!'' command below is
1257 added the complains about no ``!'' command would be replaced by
1258 complains about how the ``!'' command is broken :-) */
1260 add_com_alias ("!", "shell", class_support
, 0);
1262 c
= add_com ("make", class_support
, make_command
,
1263 "Run the ``make'' program using the rest of the line as arguments.");
1264 set_cmd_completer (c
, filename_completer
);
1265 add_cmd ("user", no_class
, show_user
,
1266 "Show definitions of user defined commands.\n\
1267 Argument is the name of the user defined command.\n\
1268 With no argument, show definitions of all user defined commands.", &showlist
);
1269 add_com ("apropos", class_support
, apropos_command
, "Search for commands matching a REGEXP");
1272 add_set_cmd ("max-user-call-depth", no_class
, var_integer
,
1273 (char *) &max_user_call_depth
,
1274 "Set the max call depth for user-defined commands.\n",