3 Copyright 2000, 2001, 2002, 2003, 2004 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/readline.h"
24 #include "readline/tilde.h"
25 #include "completer.h"
26 #include "target.h" /* For baud_rate, remote_debug and remote_timeout */
27 #include "gdb_wait.h" /* For shell escape implementation */
28 #include "gdb_regex.h" /* Used by apropos_command */
29 #include "gdb_string.h"
30 #include "gdb_vfork.h"
32 #include "expression.h"
36 #include "filenames.h" /* for DOSish file names */
44 #include "cli/cli-decode.h"
45 #include "cli/cli-script.h"
46 #include "cli/cli-setshow.h"
47 #include "cli/cli-cmds.h"
50 #include "tui/tui.h" /* For tui_active et.al. */
53 #ifndef GDBINIT_FILENAME
54 #define GDBINIT_FILENAME ".gdbinit"
57 /* Prototypes for local command functions */
59 static void complete_command (char *, int);
61 static void echo_command (char *, int);
63 static void pwd_command (char *, int);
65 static void show_version (char *, int);
67 static void help_command (char *, int);
69 static void show_command (char *, int);
71 static void info_command (char *, int);
73 static void show_debug (char *, int);
75 static void set_debug (char *, int);
77 static void show_user (char *, int);
79 static void make_command (char *, int);
81 static void shell_escape (char *, int);
83 static void edit_command (char *, int);
85 static void list_command (char *, int);
87 void apropos_command (char *, int);
89 /* Prototypes for local utility functions */
91 static void ambiguous_line_spec (struct symtabs_and_lines
*);
93 /* Limit the call depth of user-defined commands */
94 int max_user_call_depth
;
96 /* Define all cmd_list_elements. */
98 /* Chain containing all defined commands. */
100 struct cmd_list_element
*cmdlist
;
102 /* Chain containing all defined info subcommands. */
104 struct cmd_list_element
*infolist
;
106 /* Chain containing all defined enable subcommands. */
108 struct cmd_list_element
*enablelist
;
110 /* Chain containing all defined disable subcommands. */
112 struct cmd_list_element
*disablelist
;
114 /* Chain containing all defined toggle subcommands. */
116 struct cmd_list_element
*togglelist
;
118 /* Chain containing all defined stop subcommands. */
120 struct cmd_list_element
*stoplist
;
122 /* Chain containing all defined delete subcommands. */
124 struct cmd_list_element
*deletelist
;
126 /* Chain containing all defined "enable breakpoint" subcommands. */
128 struct cmd_list_element
*enablebreaklist
;
130 /* Chain containing all defined set subcommands */
132 struct cmd_list_element
*setlist
;
134 /* Chain containing all defined unset subcommands */
136 struct cmd_list_element
*unsetlist
;
138 /* Chain containing all defined show subcommands. */
140 struct cmd_list_element
*showlist
;
142 /* Chain containing all defined \"set history\". */
144 struct cmd_list_element
*sethistlist
;
146 /* Chain containing all defined \"show history\". */
148 struct cmd_list_element
*showhistlist
;
150 /* Chain containing all defined \"unset history\". */
152 struct cmd_list_element
*unsethistlist
;
154 /* Chain containing all defined maintenance subcommands. */
156 struct cmd_list_element
*maintenancelist
;
158 /* Chain containing all defined "maintenance info" subcommands. */
160 struct cmd_list_element
*maintenanceinfolist
;
162 /* Chain containing all defined "maintenance print" subcommands. */
164 struct cmd_list_element
*maintenanceprintlist
;
166 struct cmd_list_element
*setprintlist
;
168 struct cmd_list_element
*showprintlist
;
170 struct cmd_list_element
*setdebuglist
;
172 struct cmd_list_element
*showdebuglist
;
174 struct cmd_list_element
*setchecklist
;
176 struct cmd_list_element
*showchecklist
;
178 /* Utility used everywhere when at least one argument is needed and
182 error_no_arg (char *why
)
184 error ("Argument required (%s).", why
);
187 /* The "info" command is defined as a prefix, with allow_unknown = 0.
188 Therefore, its own definition is called only for "info" with no args. */
191 info_command (char *arg
, int from_tty
)
193 printf_unfiltered ("\"info\" must be followed by the name of an info command.\n");
194 help_list (infolist
, "info ", -1, gdb_stdout
);
197 /* The "show" command with no arguments shows all the settings. */
200 show_command (char *arg
, int from_tty
)
202 cmd_show_list (showlist
, from_tty
, "");
205 /* 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. */
226 complete_command (char *arg
, int from_tty
)
230 char **completions
, *point
, *arg_prefix
;
236 argpoint
= strlen (arg
);
238 /* complete_line assumes that its first argument is somewhere within,
239 and except for filenames at the beginning of, the word to be completed.
240 The following crude imitation of readline's word-breaking tries to
242 point
= arg
+ argpoint
;
245 if (strchr (rl_completer_word_break_characters
, point
[-1]) != 0)
250 arg_prefix
= alloca (point
- arg
+ 1);
251 memcpy (arg_prefix
, arg
, point
- arg
);
252 arg_prefix
[point
- arg
] = 0;
254 completions
= complete_line (point
, arg
, argpoint
);
260 for (size
= 0; completions
[size
]; ++size
)
262 qsort (completions
, size
, sizeof (char *), compare_strings
);
264 /* We do extra processing here since we only want to print each
270 printf_unfiltered ("%s%s\n", arg_prefix
, completions
[item
]);
271 next_item
= item
+ 1;
272 while (next_item
< size
273 && ! strcmp (completions
[item
], completions
[next_item
]))
275 xfree (completions
[next_item
]);
279 xfree (completions
[item
]);
288 is_complete_command (struct cmd_list_element
*c
)
290 return cmd_cfunc_eq (c
, complete_command
);
294 show_version (char *args
, int from_tty
)
297 print_gdb_version (gdb_stdout
);
298 printf_filtered ("\n");
302 /* Handle the quit command. */
305 quit_command (char *args
, int from_tty
)
307 if (!quit_confirm ())
308 error ("Not confirmed.");
309 quit_force (args
, from_tty
);
313 pwd_command (char *args
, int from_tty
)
316 error ("The \"pwd\" command does not take an argument: %s", args
);
317 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
319 if (strcmp (gdb_dirbuf
, current_directory
) != 0)
320 printf_unfiltered ("Working directory %s\n (canonically %s).\n",
321 current_directory
, gdb_dirbuf
);
323 printf_unfiltered ("Working directory %s.\n", current_directory
);
327 cd_command (char *dir
, int from_tty
)
330 /* Found something other than leading repetitions of "/..". */
334 /* If the new directory is absolute, repeat is a no-op; if relative,
335 repeat might be useful but is more likely to be a mistake. */
339 error_no_arg ("new working directory");
341 dir
= tilde_expand (dir
);
342 make_cleanup (xfree
, dir
);
345 perror_with_name (dir
);
347 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
348 /* There's too much mess with DOSish names like "d:", "d:.",
349 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
350 simply get the canonicalized name of the current directory. */
351 dir
= getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
355 if (IS_DIR_SEPARATOR (dir
[len
- 1]))
357 /* Remove the trailing slash unless this is a root directory
358 (including a drive letter on non-Unix systems). */
359 if (!(len
== 1) /* "/" */
360 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
361 && !(len
== 3 && dir
[1] == ':') /* "d:/" */
367 dir
= savestring (dir
, len
);
368 if (IS_ABSOLUTE_PATH (dir
))
369 current_directory
= dir
;
372 if (IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1]))
373 current_directory
= concat (current_directory
, dir
, NULL
);
375 current_directory
= concat (current_directory
, SLASH_STRING
, dir
, NULL
);
379 /* Now simplify any occurrences of `.' and `..' in the pathname. */
382 for (p
= current_directory
; *p
;)
384 if (IS_DIR_SEPARATOR (p
[0]) && p
[1] == '.'
385 && (p
[2] == 0 || IS_DIR_SEPARATOR (p
[2])))
387 else if (IS_DIR_SEPARATOR (p
[0]) && p
[1] == '.' && p
[2] == '.'
388 && (p
[3] == 0 || IS_DIR_SEPARATOR (p
[3])))
392 /* Search backwards for the directory just before the "/.."
393 and obliterate it and the "/..". */
395 while (q
!= current_directory
&& !IS_DIR_SEPARATOR (q
[-1]))
398 if (q
== current_directory
)
399 /* current_directory is
400 a relative pathname ("can't happen"--leave it alone). */
404 strcpy (q
- 1, p
+ 3);
409 /* We are dealing with leading repetitions of "/..", for example
410 "/../..", which is the Mach super-root. */
420 forget_cached_source_info ();
423 pwd_command ((char *) 0, 1);
427 source_command (char *args
, int from_tty
)
430 struct cleanup
*old_cleanups
;
435 error ("source command requires pathname of file to source.");
438 file
= tilde_expand (file
);
439 old_cleanups
= make_cleanup (xfree
, file
);
441 stream
= fopen (file
, FOPEN_RT
);
445 perror_with_name (file
);
450 script_from_file (stream
, file
);
452 do_cleanups (old_cleanups
);
456 echo_command (char *text
, int from_tty
)
462 while ((c
= *p
++) != '\0')
466 /* \ at end of argument is used after spaces
467 so they won't be lost. */
471 c
= parse_escape (&p
);
473 printf_filtered ("%c", c
);
476 printf_filtered ("%c", c
);
479 /* Force this output to appear now. */
481 gdb_flush (gdb_stdout
);
485 shell_escape (char *arg
, int from_tty
)
488 /* If ARG is NULL, they want an inferior shell, but `system' just
489 reports if the shell is available when passed a NULL arg. */
490 int rc
= system (arg
? arg
: "");
493 arg
= "inferior shell";
497 fprintf_unfiltered (gdb_stderr
, "Cannot execute %s: %s\n", arg
,
498 safe_strerror (errno
));
499 gdb_flush (gdb_stderr
);
503 fprintf_unfiltered (gdb_stderr
, "%s exited with status %d\n", arg
, rc
);
504 gdb_flush (gdb_stderr
);
507 /* Make sure to return to the directory GDB thinks it is, in case the
508 shell command we just ran changed it. */
509 chdir (current_directory
);
511 #else /* Can fork. */
514 if ((pid
= vfork ()) == 0)
516 char *p
, *user_shell
;
518 if ((user_shell
= (char *) getenv ("SHELL")) == NULL
)
519 user_shell
= "/bin/sh";
521 /* Get the name of the shell for arg0 */
522 if ((p
= strrchr (user_shell
, '/')) == NULL
)
525 p
++; /* Get past '/' */
528 execl (user_shell
, p
, (char *) 0);
530 execl (user_shell
, p
, "-c", arg
, (char *) 0);
532 fprintf_unfiltered (gdb_stderr
, "Cannot execute %s: %s\n", user_shell
,
533 safe_strerror (errno
));
534 gdb_flush (gdb_stderr
);
539 while ((rc
= wait (&status
)) != pid
&& rc
!= -1)
542 error ("Fork failed");
543 #endif /* Can fork. */
547 edit_command (char *arg
, int from_tty
)
549 struct symtabs_and_lines sals
;
550 struct symtab_and_line sal
;
558 /* Pull in the current default source line if necessary */
561 set_default_source_symtab_and_line ();
562 sal
= get_current_source_symtab_and_line ();
565 /* bare "edit" edits file with present line. */
570 error ("No default source file yet.");
571 sal
.line
+= get_lines_to_list () / 2;
576 /* Now should only be one argument -- decode it in SAL */
579 sals
= decode_line_1 (&arg1
, 0, 0, 0, 0, 0);
581 if (! sals
.nelts
) return; /* C++ */
582 if (sals
.nelts
> 1) {
583 ambiguous_line_spec (&sals
);
592 error ("Junk at end of line specification.");
594 /* if line was specified by address,
595 first print exactly which line, and which file.
596 In this case, sal.symtab == 0 means address is outside
597 of all known source files, not that user failed to give a filename. */
601 /* FIXME-32x64--assumes sal.pc fits in long. */
602 error ("No source file for address %s.",
603 hex_string ((unsigned long) sal
.pc
));
604 sym
= find_pc_function (sal
.pc
);
607 print_address_numeric (sal
.pc
, 1, gdb_stdout
);
608 printf_filtered (" is in ");
609 fputs_filtered (SYMBOL_PRINT_NAME (sym
), gdb_stdout
);
610 printf_filtered (" (%s:%d).\n", sal
.symtab
->filename
, sal
.line
);
614 print_address_numeric (sal
.pc
, 1, gdb_stdout
);
615 printf_filtered (" is at %s:%d.\n",
616 sal
.symtab
->filename
, sal
.line
);
620 /* If what was given does not imply a symtab, it must be an undebuggable
621 symbol which means no source code. */
624 error ("No line number known for %s.", arg
);
627 if ((editor
= (char *) getenv ("EDITOR")) == NULL
)
630 /* Approximate base-10 log of line to 1 unit for digit count */
631 for(log10
=32, m
=0x80000000; !(sal
.line
& m
) && log10
>0; log10
--, m
=m
>>1);
632 log10
= 1 + (int)((log10
+ (0 == ((m
-1) & sal
.line
)))/3.32192809);
634 cmdlen
= strlen(editor
) + 1
635 + (NULL
== sal
.symtab
->dirname
? 0 : strlen(sal
.symtab
->dirname
) + 1)
636 + (NULL
== sal
.symtab
->filename
? 0 : strlen(sal
.symtab
->filename
)+ 1)
640 sprintf(p
,"%s +%d %s%s",editor
,sal
.line
,
641 (NULL
== sal
.symtab
->dirname
? "./" :
642 (NULL
!= sal
.symtab
->filename
&& *(sal
.symtab
->filename
) != '/') ?
643 sal
.symtab
->dirname
: ""),
644 (NULL
== sal
.symtab
->filename
? "unknown" : sal
.symtab
->filename
)
646 shell_escape(p
, from_tty
);
652 list_command (char *arg
, int from_tty
)
654 struct symtabs_and_lines sals
, sals_end
;
655 struct symtab_and_line sal
, sal_end
, cursal
;
664 /* Pull in the current default source line if necessary */
665 if (arg
== 0 || arg
[0] == '+' || arg
[0] == '-')
667 set_default_source_symtab_and_line ();
668 cursal
= get_current_source_symtab_and_line ();
671 /* "l" or "l +" lists next ten lines. */
673 if (arg
== 0 || strcmp (arg
, "+") == 0)
675 print_source_lines (cursal
.symtab
, cursal
.line
,
676 cursal
.line
+ get_lines_to_list (), 0);
680 /* "l -" lists previous ten lines, the ones before the ten just listed. */
681 if (strcmp (arg
, "-") == 0)
683 print_source_lines (cursal
.symtab
,
684 max (get_first_line_listed () - get_lines_to_list (), 1),
685 get_first_line_listed (), 0);
689 /* Now if there is only one argument, decode it in SAL
691 If there are two arguments, decode them in SAL and SAL_END
692 and clear NO_END; however, if one of the arguments is blank,
693 set DUMMY_BEG or DUMMY_END to record that fact. */
695 if (!have_full_symbols () && !have_partial_symbols ())
696 error ("No symbol table is loaded. Use the \"file\" command.");
703 sals
= decode_line_1 (&arg1
, 0, 0, 0, 0, 0);
709 ambiguous_line_spec (&sals
);
718 /* Record whether the BEG arg is all digits. */
720 for (p
= arg
; p
!= arg1
&& *p
>= '0' && *p
<= '9'; p
++);
721 linenum_beg
= (p
== arg1
);
723 while (*arg1
== ' ' || *arg1
== '\t')
729 while (*arg1
== ' ' || *arg1
== '\t')
736 sals_end
= decode_line_1 (&arg1
, 0, 0, 0, 0, 0);
738 sals_end
= decode_line_1 (&arg1
, 0, sal
.symtab
, sal
.line
, 0, 0);
739 if (sals_end
.nelts
== 0)
741 if (sals_end
.nelts
> 1)
743 ambiguous_line_spec (&sals_end
);
744 xfree (sals_end
.sals
);
747 sal_end
= sals_end
.sals
[0];
748 xfree (sals_end
.sals
);
753 error ("Junk at end of line specification.");
755 if (!no_end
&& !dummy_beg
&& !dummy_end
756 && sal
.symtab
!= sal_end
.symtab
)
757 error ("Specified start and end are in different files.");
758 if (dummy_beg
&& dummy_end
)
759 error ("Two empty args do not say what lines to list.");
761 /* if line was specified by address,
762 first print exactly which line, and which file.
763 In this case, sal.symtab == 0 means address is outside
764 of all known source files, not that user failed to give a filename. */
768 /* FIXME-32x64--assumes sal.pc fits in long. */
769 error ("No source file for address %s.",
770 hex_string ((unsigned long) sal
.pc
));
771 sym
= find_pc_function (sal
.pc
);
774 print_address_numeric (sal
.pc
, 1, gdb_stdout
);
775 printf_filtered (" is in ");
776 fputs_filtered (SYMBOL_PRINT_NAME (sym
), gdb_stdout
);
777 printf_filtered (" (%s:%d).\n", sal
.symtab
->filename
, sal
.line
);
781 print_address_numeric (sal
.pc
, 1, gdb_stdout
);
782 printf_filtered (" is at %s:%d.\n",
783 sal
.symtab
->filename
, sal
.line
);
787 /* If line was not specified by just a line number,
788 and it does not imply a symtab, it must be an undebuggable symbol
789 which means no source code. */
791 if (!linenum_beg
&& sal
.symtab
== 0)
792 error ("No line number known for %s.", arg
);
794 /* If this command is repeated with RET,
795 turn it into the no-arg variant. */
800 if (dummy_beg
&& sal_end
.symtab
== 0)
801 error ("No default source file yet. Do \"help list\".");
803 print_source_lines (sal_end
.symtab
,
804 max (sal_end
.line
- (get_lines_to_list () - 1), 1),
805 sal_end
.line
+ 1, 0);
806 else if (sal
.symtab
== 0)
807 error ("No default source file yet. Do \"help list\".");
810 int first_line
= sal
.line
- get_lines_to_list () / 2;
812 if (first_line
< 1) first_line
= 1;
814 print_source_lines (sal
.symtab
,
816 first_line
+ get_lines_to_list (),
820 print_source_lines (sal
.symtab
, sal
.line
,
822 ? sal
.line
+ get_lines_to_list ()
827 /* Dump a specified section of assembly code. With no command line
828 arguments, this command will dump the assembly code for the
829 function surrounding the pc value in the selected frame. With one
830 argument, it will dump the assembly code surrounding that pc value.
831 Two arguments are interpeted as bounds within which to dump
835 disassemble_command (char *arg
, int from_tty
)
839 CORE_ADDR pc
, pc_masked
;
848 if (!deprecated_selected_frame
)
849 error ("No frame selected.\n");
851 pc
= get_frame_pc (deprecated_selected_frame
);
852 if (find_pc_partial_function (pc
, &name
, &low
, &high
) == 0)
853 error ("No function contains program counter for selected frame.\n");
855 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
858 /* FIXME: cagney/2004-02-07: This should be an observer. */
859 low
= tui_get_low_disassembly_address (low
, pc
);
861 low
+= DEPRECATED_FUNCTION_START_OFFSET
;
863 else if (!(space_index
= (char *) strchr (arg
, ' ')))
866 pc
= parse_and_eval_address (arg
);
867 if (find_pc_partial_function (pc
, &name
, &low
, &high
) == 0)
868 error ("No function contains specified address.\n");
870 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
873 /* FIXME: cagney/2004-02-07: This should be an observer. */
874 low
= tui_get_low_disassembly_address (low
, pc
);
876 low
+= DEPRECATED_FUNCTION_START_OFFSET
;
882 low
= parse_and_eval_address (arg
);
883 high
= parse_and_eval_address (space_index
+ 1);
887 if (!tui_is_window_visible (DISASSEM_WIN
))
890 printf_filtered ("Dump of assembler code ");
893 printf_filtered ("for function %s:\n", name
);
897 printf_filtered ("from ");
898 print_address_numeric (low
, 1, gdb_stdout
);
899 printf_filtered (" to ");
900 print_address_numeric (high
, 1, gdb_stdout
);
901 printf_filtered (":\n");
904 /* Dump the specified range. */
905 gdb_disassembly (uiout
, 0, 0, 0, -1, low
, high
);
907 printf_filtered ("End of assembler dump.\n");
908 gdb_flush (gdb_stdout
);
913 tui_show_assembly (low
);
919 make_command (char *arg
, int from_tty
)
927 p
= xmalloc (sizeof ("make ") + strlen (arg
));
929 strcpy (p
+ sizeof ("make ") - 1, arg
);
932 shell_escape (p
, from_tty
);
936 show_user (char *args
, int from_tty
)
938 struct cmd_list_element
*c
;
939 extern struct cmd_list_element
*cmdlist
;
943 c
= lookup_cmd (&args
, cmdlist
, "", 0, 1);
944 if (c
->class != class_user
)
945 error ("Not a user command.");
946 show_user_1 (c
, gdb_stdout
);
950 for (c
= cmdlist
; c
; c
= c
->next
)
952 if (c
->class == class_user
)
953 show_user_1 (c
, gdb_stdout
);
958 /* Search through names of commands and documentations for a certain
962 apropos_command (char *searchstr
, int from_tty
)
964 extern struct cmd_list_element
*cmdlist
; /*This is the main command list*/
966 char *pattern_fastmap
;
967 char errorbuffer
[512];
968 pattern_fastmap
= xcalloc (256, sizeof (char));
969 if (searchstr
== NULL
)
970 error("REGEXP string is empty");
972 if (regcomp(&pattern
,searchstr
,REG_ICASE
) == 0)
974 pattern
.fastmap
=pattern_fastmap
;
975 re_compile_fastmap(&pattern
);
976 apropos_cmd (gdb_stdout
,cmdlist
,&pattern
,"");
980 regerror(regcomp(&pattern
,searchstr
,REG_ICASE
),NULL
,errorbuffer
,512);
981 error("Error in regular expression:%s",errorbuffer
);
983 xfree (pattern_fastmap
);
986 /* Print a list of files and line numbers which a user may choose from
987 in order to list a function which was specified ambiguously (as with
988 `list classname::overloadedfuncname', for example). The vector in
989 SALS provides the filenames and line numbers. */
992 ambiguous_line_spec (struct symtabs_and_lines
*sals
)
996 for (i
= 0; i
< sals
->nelts
; ++i
)
997 printf_filtered ("file: \"%s\", line number: %d\n",
998 sals
->sals
[i
].symtab
->filename
, sals
->sals
[i
].line
);
1002 set_debug (char *arg
, int from_tty
)
1004 printf_unfiltered ("\"set debug\" must be followed by the name of a print subcommand.\n");
1005 help_list (setdebuglist
, "set debug ", -1, gdb_stdout
);
1009 show_debug (char *args
, int from_tty
)
1011 cmd_show_list (showdebuglist
, from_tty
, "");
1015 init_cmd_lists (void)
1017 max_user_call_depth
= 1024;
1026 enablebreaklist
= NULL
;
1031 showhistlist
= NULL
;
1032 unsethistlist
= NULL
;
1033 maintenancelist
= NULL
;
1034 maintenanceinfolist
= NULL
;
1035 maintenanceprintlist
= NULL
;
1036 setprintlist
= NULL
;
1037 showprintlist
= NULL
;
1038 setchecklist
= NULL
;
1039 showchecklist
= NULL
;
1044 init_cli_cmds (void)
1046 struct cmd_list_element
*c
;
1048 /* Define the classes of commands.
1049 They will appear in the help list in the reverse of this order. */
1051 add_cmd ("internals", class_maintenance
, NULL
,
1052 "Maintenance commands.\n\
1053 Some gdb commands are provided just for use by gdb maintainers.\n\
1054 These commands are subject to frequent change, and may not be as\n\
1055 well documented as user commands.",
1057 add_cmd ("obscure", class_obscure
, NULL
, "Obscure features.", &cmdlist
);
1058 add_cmd ("aliases", class_alias
, NULL
, "Aliases of other commands.", &cmdlist
);
1059 add_cmd ("user-defined", class_user
, NULL
, "User-defined commands.\n\
1060 The commands in this class are those defined by the user.\n\
1061 Use the \"define\" command to define a command.", &cmdlist
);
1062 add_cmd ("support", class_support
, NULL
, "Support facilities.", &cmdlist
);
1064 add_cmd ("status", class_info
, NULL
, "Status inquiries.", &cmdlist
);
1065 add_cmd ("files", class_files
, NULL
, "Specifying and examining files.", &cmdlist
);
1066 add_cmd ("breakpoints", class_breakpoint
, NULL
, "Making program stop at certain points.", &cmdlist
);
1067 add_cmd ("data", class_vars
, NULL
, "Examining data.", &cmdlist
);
1068 add_cmd ("stack", class_stack
, NULL
, "Examining the stack.\n\
1069 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1070 counting from zero for the innermost (currently executing) frame.\n\n\
1071 At any time gdb identifies one frame as the \"selected\" frame.\n\
1072 Variable lookups are done with respect to the selected frame.\n\
1073 When the program being debugged stops, gdb selects the innermost frame.\n\
1074 The commands below can be used to select other frames by number or address.",
1076 add_cmd ("running", class_run
, NULL
, "Running the program.", &cmdlist
);
1078 /* Define general commands. */
1080 add_com ("pwd", class_files
, pwd_command
,
1081 "Print working directory. This is used for your program as well.");
1082 c
= add_cmd ("cd", class_files
, cd_command
,
1083 "Set working directory to DIR for debugger and program being debugged.\n\
1084 The change does not take effect for the program being debugged\n\
1085 until the next time it is started.", &cmdlist
);
1086 set_cmd_completer (c
, filename_completer
);
1088 add_com ("echo", class_support
, echo_command
,
1089 "Print a constant string. Give string as argument.\n\
1090 C escape sequences may be used in the argument.\n\
1091 No newline is added at the end of the argument;\n\
1092 use \"\\n\" if you want a newline to be printed.\n\
1093 Since leading and trailing whitespace are ignored in command arguments,\n\
1094 if you want to print some you must use \"\\\" before leading whitespace\n\
1095 to be printed or after trailing whitespace.");
1096 add_com ("document", class_support
, document_command
,
1097 "Document a user-defined command.\n\
1098 Give command name as argument. Give documentation on following lines.\n\
1099 End with a line of just \"end\".");
1100 add_com ("define", class_support
, define_command
,
1101 "Define a new command name. Command name is argument.\n\
1102 Definition appears on following lines, one command per line.\n\
1103 End with a line of just \"end\".\n\
1104 Use the \"document\" command to give documentation for the new command.\n\
1105 Commands defined in this way may have up to ten arguments.");
1107 c
= add_cmd ("source", class_support
, source_command
,
1108 "Read commands from a file named FILE.\n\
1109 Note that the file \"" GDBINIT_FILENAME
"\" is read automatically in this way\n\
1110 when gdb is started.", &cmdlist
);
1111 set_cmd_completer (c
, filename_completer
);
1113 add_com ("quit", class_support
, quit_command
, "Exit gdb.");
1114 c
= add_com ("help", class_support
, help_command
, "Print list of commands.");
1115 set_cmd_completer (c
, command_completer
);
1116 add_com_alias ("q", "quit", class_support
, 1);
1117 add_com_alias ("h", "help", class_support
, 1);
1119 c
= add_set_cmd ("verbose", class_support
, var_boolean
, (char *) &info_verbose
,
1122 deprecated_add_show_from_set (c
, &showlist
);
1123 set_cmd_sfunc (c
, set_verbose
);
1124 set_verbose (NULL
, 0, c
);
1126 add_prefix_cmd ("history", class_support
, set_history
,
1127 "Generic command for setting command history parameters.",
1128 &sethistlist
, "set history ", 0, &setlist
);
1129 add_prefix_cmd ("history", class_support
, show_history
,
1130 "Generic command for showing command history parameters.",
1131 &showhistlist
, "show history ", 0, &showlist
);
1133 deprecated_add_show_from_set
1134 (add_set_cmd ("expansion", no_class
, var_boolean
, (char *) &history_expansion_p
,
1135 "Set history expansion on command input.\n\
1136 Without an argument, history expansion is enabled.", &sethistlist
),
1139 add_prefix_cmd ("info", class_info
, info_command
,
1140 "Generic command for showing things about the program being debugged.",
1141 &infolist
, "info ", 0, &cmdlist
);
1142 add_com_alias ("i", "info", class_info
, 1);
1144 add_com ("complete", class_obscure
, complete_command
,
1145 "List the completions for the rest of the line as a command.");
1147 add_prefix_cmd ("show", class_info
, show_command
,
1148 "Generic command for showing things about the debugger.",
1149 &showlist
, "show ", 0, &cmdlist
);
1150 /* Another way to get at the same thing. */
1151 add_info ("set", show_command
, "Show all GDB settings.");
1153 add_cmd ("commands", no_class
, show_commands
,
1154 "Show the history of commands you typed.\n\
1155 You can supply a command number to start with, or a `+' to start after\n\
1156 the previous command number shown.",
1159 add_cmd ("version", no_class
, show_version
,
1160 "Show what version of GDB this is.", &showlist
);
1162 add_com ("while", class_support
, while_command
,
1163 "Execute nested commands WHILE the conditional expression is non zero.\n\
1164 The conditional expression must follow the word `while' and must in turn be\n\
1165 followed by a new line. The nested commands must be entered one per line,\n\
1166 and should be terminated by the word `end'.");
1168 add_com ("if", class_support
, if_command
,
1169 "Execute nested commands once IF the conditional expression is non zero.\n\
1170 The conditional expression must follow the word `if' and must in turn be\n\
1171 followed by a new line. The nested commands must be entered one per line,\n\
1172 and should be terminated by the word 'else' or `end'. If an else clause\n\
1173 is used, the same rules apply to its nested commands as to the first ones.");
1175 /* If target is open when baud changes, it doesn't take effect until the
1176 next open (I think, not sure). */
1177 deprecated_add_show_from_set
1178 (add_set_cmd ("remotebaud", no_class
,
1179 var_zinteger
, (char *) &baud_rate
,
1180 "Set baud rate for remote serial I/O.\n\
1181 This value is used to set the speed of the serial port when debugging\n\
1182 using remote targets.", &setlist
),
1185 c
= add_set_cmd ("remotedebug", no_class
, var_zinteger
,
1186 (char *) &remote_debug
,
1187 "Set debugging of remote protocol.\n\
1188 When enabled, each packet sent or received with the remote target\n\
1189 is displayed.", &setlist
);
1190 deprecate_cmd (c
, "set debug remote");
1191 deprecate_cmd (deprecated_add_show_from_set (c
, &showlist
),
1192 "show debug remote");
1194 deprecated_add_show_from_set
1195 (add_set_cmd ("remote", no_class
, var_zinteger
,
1196 (char *) &remote_debug
,
1197 "Set debugging of remote protocol.\n\
1198 When enabled, each packet sent or received with the remote target\n\
1199 is displayed.", &setdebuglist
),
1202 deprecated_add_show_from_set
1203 (add_set_cmd ("remotetimeout", no_class
, var_integer
, (char *) &remote_timeout
,
1204 "Set timeout limit to wait for target to respond.\n\
1205 This value is used to set the time limit for gdb to wait for a response\n\
1206 from the target.", &setlist
),
1209 add_prefix_cmd ("debug", no_class
, set_debug
,
1210 "Generic command for setting gdb debugging flags",
1211 &setdebuglist
, "set debug ", 0, &setlist
);
1213 add_prefix_cmd ("debug", no_class
, show_debug
,
1214 "Generic command for showing gdb debugging flags",
1215 &showdebuglist
, "show debug ", 0, &showlist
);
1217 c
= add_com ("shell", class_support
, shell_escape
,
1218 "Execute the rest of the line as a shell command.\n\
1219 With no arguments, run an inferior shell.");
1220 set_cmd_completer (c
, filename_completer
);
1222 c
= add_com ("edit", class_files
, edit_command
,
1223 concat ("Edit specified file or function.\n\
1224 With no argument, edits file containing most recent line listed.\n\
1226 Editing targets can be specified in these ways:\n\
1227 FILE:LINENUM, to edit at that line in that file,\n\
1228 FUNCTION, to edit at the beginning of that function,\n\
1229 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1230 *ADDRESS, to edit at the line containing that address.\n\
1231 Uses EDITOR environment variable contents as editor (or ex as default).",NULL
));
1233 c
->completer
= location_completer
;
1235 add_com ("list", class_files
, list_command
,
1236 concat ("List specified function or line.\n\
1237 With no argument, lists ten more lines after or around previous listing.\n\
1238 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1239 One argument specifies a line, and ten lines are listed around that line.\n\
1240 Two arguments with comma between specify starting and ending lines to list.\n\
1242 Lines can be specified in these ways:\n\
1243 LINENUM, to list around that line in current file,\n\
1244 FILE:LINENUM, to list around that line in that file,\n\
1245 FUNCTION, to list around beginning of that function,\n\
1246 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1247 *ADDRESS, to list around the line containing that address.\n\
1248 With two args if one is empty it stands for ten lines away from the other arg.", NULL
));
1251 add_com_alias ("l", "list", class_files
, 1);
1253 add_com_alias ("v", "list", class_files
, 1);
1256 add_com_alias ("file", "list", class_files
, 1);
1258 c
= add_com ("disassemble", class_vars
, disassemble_command
,
1259 "Disassemble a specified section of memory.\n\
1260 Default is the function surrounding the pc of the selected frame.\n\
1261 With a single argument, the function surrounding that address is dumped.\n\
1262 Two arguments are taken as a range of memory to dump.");
1263 set_cmd_completer (c
, location_completer
);
1265 add_com_alias ("va", "disassemble", class_xdb
, 0);
1267 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1268 be a really useful feature. Unfortunately, the below wont do
1269 this. Instead it adds support for the form ``(gdb) ! ls''
1270 (i.e. the space is required). If the ``!'' command below is
1271 added the complains about no ``!'' command would be replaced by
1272 complains about how the ``!'' command is broken :-) */
1274 add_com_alias ("!", "shell", class_support
, 0);
1276 c
= add_com ("make", class_support
, make_command
,
1277 "Run the ``make'' program using the rest of the line as arguments.");
1278 set_cmd_completer (c
, filename_completer
);
1279 add_cmd ("user", no_class
, show_user
,
1280 "Show definitions of user defined commands.\n\
1281 Argument is the name of the user defined command.\n\
1282 With no argument, show definitions of all user defined commands.", &showlist
);
1283 add_com ("apropos", class_support
, apropos_command
, "Search for commands matching a REGEXP");
1285 deprecated_add_show_from_set
1286 (add_set_cmd ("max-user-call-depth", no_class
, var_integer
,
1287 (char *) &max_user_call_depth
,
1288 "Set the max call depth for user-defined commands.\n",