3 Copyright 2000, 2001, 2002 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 "completer.h"
24 #include "target.h" /* For baud_rate, remote_debug and remote_timeout */
25 #include "gdb_wait.h" /* For shell escape implementation */
26 #include "gdb_regex.h" /* Used by apropos_command */
27 #include "filenames.h" /* for DOSish file names */
32 #include "cli/cli-decode.h"
33 #include "cli/cli-script.h"
34 #include "cli/cli-setshow.h"
35 #include "cli/cli-cmds.h"
37 #ifndef GDBINIT_FILENAME
38 #define GDBINIT_FILENAME ".gdbinit"
43 extern void dont_repeat (void);
45 extern void set_verbose (char *, int, struct cmd_list_element
*);
47 extern void show_history (char *, int);
49 extern void set_history (char *, int);
51 extern void show_commands (char *, int);
53 /* Prototypes for local functions */
55 static void complete_command (char *, int);
57 static void echo_command (char *, int);
59 static void pwd_command (char *, int);
61 static void show_version (char *, int);
63 static void validate_comname (char *);
65 static void help_command (char *, int);
67 static void show_command (char *, int);
69 static void info_command (char *, int);
71 static void show_debug (char *, int);
73 static void set_debug (char *, int);
75 static void show_user (char *, int);
77 static void make_command (char *, int);
79 static void shell_escape (char *, int);
81 void apropos_command (char *, int);
83 /* Define all cmd_list_elements. */
85 /* Chain containing all defined commands. */
87 struct cmd_list_element
*cmdlist
;
89 /* Chain containing all defined info subcommands. */
91 struct cmd_list_element
*infolist
;
93 /* Chain containing all defined enable subcommands. */
95 struct cmd_list_element
*enablelist
;
97 /* Chain containing all defined disable subcommands. */
99 struct cmd_list_element
*disablelist
;
101 /* Chain containing all defined toggle subcommands. */
103 struct cmd_list_element
*togglelist
;
105 /* Chain containing all defined stop subcommands. */
107 struct cmd_list_element
*stoplist
;
109 /* Chain containing all defined delete subcommands. */
111 struct cmd_list_element
*deletelist
;
113 /* Chain containing all defined "enable breakpoint" subcommands. */
115 struct cmd_list_element
*enablebreaklist
;
117 /* Chain containing all defined set subcommands */
119 struct cmd_list_element
*setlist
;
121 /* Chain containing all defined unset subcommands */
123 struct cmd_list_element
*unsetlist
;
125 /* Chain containing all defined show subcommands. */
127 struct cmd_list_element
*showlist
;
129 /* Chain containing all defined \"set history\". */
131 struct cmd_list_element
*sethistlist
;
133 /* Chain containing all defined \"show history\". */
135 struct cmd_list_element
*showhistlist
;
137 /* Chain containing all defined \"unset history\". */
139 struct cmd_list_element
*unsethistlist
;
141 /* Chain containing all defined maintenance subcommands. */
143 struct cmd_list_element
*maintenancelist
;
145 /* Chain containing all defined "maintenance info" subcommands. */
147 struct cmd_list_element
*maintenanceinfolist
;
149 /* Chain containing all defined "maintenance print" subcommands. */
151 struct cmd_list_element
*maintenanceprintlist
;
153 struct cmd_list_element
*setprintlist
;
155 struct cmd_list_element
*showprintlist
;
157 struct cmd_list_element
*setdebuglist
;
159 struct cmd_list_element
*showdebuglist
;
161 struct cmd_list_element
*setchecklist
;
163 struct cmd_list_element
*showchecklist
;
165 /* Utility used everywhere when at least one argument is needed and
169 error_no_arg (char *why
)
171 error ("Argument required (%s).", why
);
174 /* The "info" command is defined as a prefix, with allow_unknown = 0.
175 Therefore, its own definition is called only for "info" with no args. */
179 info_command (char *arg
, int from_tty
)
181 printf_unfiltered ("\"info\" must be followed by the name of an info command.\n");
182 help_list (infolist
, "info ", -1, gdb_stdout
);
185 /* The "show" command with no arguments shows all the settings. */
189 show_command (char *arg
, int from_tty
)
191 cmd_show_list (showlist
, from_tty
, "");
194 /* Provide documentation on command or list given by COMMAND. FROM_TTY
199 help_command (char *command
, int from_tty
)
201 help_cmd (command
, gdb_stdout
);
204 /* The "complete" command is used by Emacs to implement completion. */
208 complete_command (char *arg
, int from_tty
)
218 argpoint
= strlen (arg
);
220 for (completion
= line_completion_function (arg
, i
= 0, arg
, argpoint
);
222 completion
= line_completion_function (arg
, ++i
, arg
, argpoint
))
224 printf_unfiltered ("%s\n", completion
);
229 int is_complete_command (void (*func
) (char *args
, int from_tty
))
231 return func
== complete_command
;
236 show_version (char *args
, int from_tty
)
239 print_gdb_version (gdb_stdout
);
240 printf_filtered ("\n");
244 /* Handle the quit command. */
247 quit_command (char *args
, int from_tty
)
249 if (!quit_confirm ())
250 error ("Not confirmed.");
251 quit_force (args
, from_tty
);
256 pwd_command (char *args
, int from_tty
)
259 error ("The \"pwd\" command does not take an argument: %s", args
);
260 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
262 if (!STREQ (gdb_dirbuf
, current_directory
))
263 printf_unfiltered ("Working directory %s\n (canonically %s).\n",
264 current_directory
, gdb_dirbuf
);
266 printf_unfiltered ("Working directory %s.\n", current_directory
);
270 cd_command (char *dir
, int from_tty
)
273 /* Found something other than leading repetitions of "/..". */
277 /* If the new directory is absolute, repeat is a no-op; if relative,
278 repeat might be useful but is more likely to be a mistake. */
282 error_no_arg ("new working directory");
284 dir
= tilde_expand (dir
);
285 make_cleanup (xfree
, dir
);
288 perror_with_name (dir
);
290 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
291 /* There's too much mess with DOSish names like "d:", "d:.",
292 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
293 simply get the canonicalized name of the current directory. */
294 dir
= getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
298 if (IS_DIR_SEPARATOR (dir
[len
- 1]))
300 /* Remove the trailing slash unless this is a root directory
301 (including a drive letter on non-Unix systems). */
302 if (!(len
== 1) /* "/" */
303 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
304 && !(len
== 3 && dir
[1] == ':') /* "d:/" */
310 dir
= savestring (dir
, len
);
311 if (IS_ABSOLUTE_PATH (dir
))
312 current_directory
= dir
;
315 if (IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1]))
316 current_directory
= concat (current_directory
, dir
, NULL
);
318 current_directory
= concat (current_directory
, SLASH_STRING
, dir
, NULL
);
322 /* Now simplify any occurrences of `.' and `..' in the pathname. */
325 for (p
= current_directory
; *p
;)
327 if (IS_DIR_SEPARATOR (p
[0]) && p
[1] == '.'
328 && (p
[2] == 0 || IS_DIR_SEPARATOR (p
[2])))
330 else if (IS_DIR_SEPARATOR (p
[0]) && p
[1] == '.' && p
[2] == '.'
331 && (p
[3] == 0 || IS_DIR_SEPARATOR (p
[3])))
335 /* Search backwards for the directory just before the "/.."
336 and obliterate it and the "/..". */
338 while (q
!= current_directory
&& !IS_DIR_SEPARATOR (q
[-1]))
341 if (q
== current_directory
)
342 /* current_directory is
343 a relative pathname ("can't happen"--leave it alone). */
347 strcpy (q
- 1, p
+ 3);
352 /* We are dealing with leading repetitions of "/..", for example
353 "/../..", which is the Mach super-root. */
363 forget_cached_source_info ();
366 pwd_command ((char *) 0, 1);
370 source_command (char *args
, int from_tty
)
373 struct cleanup
*old_cleanups
;
378 error ("source command requires pathname of file to source.");
381 file
= tilde_expand (file
);
382 old_cleanups
= make_cleanup (xfree
, file
);
384 stream
= fopen (file
, FOPEN_RT
);
388 perror_with_name (file
);
393 script_from_file (stream
, file
);
395 do_cleanups (old_cleanups
);
400 echo_command (char *text
, int from_tty
)
406 while ((c
= *p
++) != '\0')
410 /* \ at end of argument is used after spaces
411 so they won't be lost. */
415 c
= parse_escape (&p
);
417 printf_filtered ("%c", c
);
420 printf_filtered ("%c", c
);
423 /* Force this output to appear now. */
425 gdb_flush (gdb_stdout
);
430 shell_escape (char *arg
, int from_tty
)
433 /* If ARG is NULL, they want an inferior shell, but `system' just
434 reports if the shell is available when passed a NULL arg. */
435 int rc
= system (arg
? arg
: "");
438 arg
= "inferior shell";
442 fprintf_unfiltered (gdb_stderr
, "Cannot execute %s: %s\n", arg
,
443 safe_strerror (errno
));
444 gdb_flush (gdb_stderr
);
448 fprintf_unfiltered (gdb_stderr
, "%s exited with status %d\n", arg
, rc
);
449 gdb_flush (gdb_stderr
);
452 /* Make sure to return to the directory GDB thinks it is, in case the
453 shell command we just ran changed it. */
454 chdir (current_directory
);
456 #else /* Can fork. */
458 char *p
, *user_shell
;
460 if ((user_shell
= (char *) getenv ("SHELL")) == NULL
)
461 user_shell
= "/bin/sh";
463 /* Get the name of the shell for arg0 */
464 if ((p
= strrchr (user_shell
, '/')) == NULL
)
467 p
++; /* Get past '/' */
469 if ((pid
= fork ()) == 0)
472 execl (user_shell
, p
, 0);
474 execl (user_shell
, p
, "-c", arg
, 0);
476 fprintf_unfiltered (gdb_stderr
, "Cannot execute %s: %s\n", user_shell
,
477 safe_strerror (errno
));
478 gdb_flush (gdb_stderr
);
483 while ((rc
= wait (&status
)) != pid
&& rc
!= -1)
486 error ("Fork failed");
487 #endif /* Can fork. */
491 make_command (char *arg
, int from_tty
)
499 p
= xmalloc (sizeof ("make ") + strlen (arg
));
501 strcpy (p
+ sizeof ("make ") - 1, arg
);
504 shell_escape (p
, from_tty
);
509 show_user (char *args
, int from_tty
)
511 struct cmd_list_element
*c
;
512 extern struct cmd_list_element
*cmdlist
;
516 c
= lookup_cmd (&args
, cmdlist
, "", 0, 1);
517 if (c
->class != class_user
)
518 error ("Not a user command.");
519 show_user_1 (c
, gdb_stdout
);
523 for (c
= cmdlist
; c
; c
= c
->next
)
525 if (c
->class == class_user
)
526 show_user_1 (c
, gdb_stdout
);
531 /* Search through names of commands and documentations for a certain
535 apropos_command (char *searchstr
, int from_tty
)
537 extern struct cmd_list_element
*cmdlist
; /*This is the main command list*/
539 char *pattern_fastmap
;
540 char errorbuffer
[512];
541 pattern_fastmap
= xcalloc (256, sizeof (char));
542 if (searchstr
== NULL
)
543 error("REGEXP string is empty");
545 if (regcomp(&pattern
,searchstr
,REG_ICASE
) == 0)
547 pattern
.fastmap
=pattern_fastmap
;
548 re_compile_fastmap(&pattern
);
549 apropos_cmd (gdb_stdout
,cmdlist
,&pattern
,"");
553 regerror(regcomp(&pattern
,searchstr
,REG_ICASE
),NULL
,errorbuffer
,512);
554 error("Error in regular expression:%s",errorbuffer
);
556 xfree (pattern_fastmap
);
560 set_debug (char *arg
, int from_tty
)
562 printf_unfiltered ("\"set debug\" must be followed by the name of a print subcommand.\n");
563 help_list (setdebuglist
, "set debug ", -1, gdb_stdout
);
567 show_debug (char *args
, int from_tty
)
569 cmd_show_list (showdebuglist
, from_tty
, "");
573 init_cmd_lists (void)
582 enablebreaklist
= NULL
;
588 unsethistlist
= NULL
;
589 maintenancelist
= NULL
;
590 maintenanceinfolist
= NULL
;
591 maintenanceprintlist
= NULL
;
593 showprintlist
= NULL
;
595 showchecklist
= NULL
;
602 struct cmd_list_element
*c
;
604 /* Define the classes of commands.
605 They will appear in the help list in the reverse of this order. */
607 add_cmd ("internals", class_maintenance
, NULL
,
608 "Maintenance commands.\n\
609 Some gdb commands are provided just for use by gdb maintainers.\n\
610 These commands are subject to frequent change, and may not be as\n\
611 well documented as user commands.",
613 add_cmd ("obscure", class_obscure
, NULL
, "Obscure features.", &cmdlist
);
614 add_cmd ("aliases", class_alias
, NULL
, "Aliases of other commands.", &cmdlist
);
615 add_cmd ("user-defined", class_user
, NULL
, "User-defined commands.\n\
616 The commands in this class are those defined by the user.\n\
617 Use the \"define\" command to define a command.", &cmdlist
);
618 add_cmd ("support", class_support
, NULL
, "Support facilities.", &cmdlist
);
620 add_cmd ("status", class_info
, NULL
, "Status inquiries.", &cmdlist
);
621 add_cmd ("files", class_files
, NULL
, "Specifying and examining files.", &cmdlist
);
622 add_cmd ("breakpoints", class_breakpoint
, NULL
, "Making program stop at certain points.", &cmdlist
);
623 add_cmd ("data", class_vars
, NULL
, "Examining data.", &cmdlist
);
624 add_cmd ("stack", class_stack
, NULL
, "Examining the stack.\n\
625 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
626 counting from zero for the innermost (currently executing) frame.\n\n\
627 At any time gdb identifies one frame as the \"selected\" frame.\n\
628 Variable lookups are done with respect to the selected frame.\n\
629 When the program being debugged stops, gdb selects the innermost frame.\n\
630 The commands below can be used to select other frames by number or address.",
632 add_cmd ("running", class_run
, NULL
, "Running the program.", &cmdlist
);
634 /* Define general commands. */
636 add_com ("pwd", class_files
, pwd_command
,
637 "Print working directory. This is used for your program as well.");
638 c
= add_cmd ("cd", class_files
, cd_command
,
639 "Set working directory to DIR for debugger and program being debugged.\n\
640 The change does not take effect for the program being debugged\n\
641 until the next time it is started.", &cmdlist
);
642 c
->completer
= filename_completer
;
644 add_com ("echo", class_support
, echo_command
,
645 "Print a constant string. Give string as argument.\n\
646 C escape sequences may be used in the argument.\n\
647 No newline is added at the end of the argument;\n\
648 use \"\\n\" if you want a newline to be printed.\n\
649 Since leading and trailing whitespace are ignored in command arguments,\n\
650 if you want to print some you must use \"\\\" before leading whitespace\n\
651 to be printed or after trailing whitespace.");
652 add_com ("document", class_support
, document_command
,
653 "Document a user-defined command.\n\
654 Give command name as argument. Give documentation on following lines.\n\
655 End with a line of just \"end\".");
656 add_com ("define", class_support
, define_command
,
657 "Define a new command name. Command name is argument.\n\
658 Definition appears on following lines, one command per line.\n\
659 End with a line of just \"end\".\n\
660 Use the \"document\" command to give documentation for the new command.\n\
661 Commands defined in this way may have up to ten arguments.");
663 c
= add_cmd ("source", class_support
, source_command
,
664 "Read commands from a file named FILE.\n\
665 Note that the file \"" GDBINIT_FILENAME
"\" is read automatically in this way\n\
666 when gdb is started.", &cmdlist
);
667 c
->completer
= filename_completer
;
669 add_com ("quit", class_support
, quit_command
, "Exit gdb.");
670 c
= add_com ("help", class_support
, help_command
, "Print list of commands.");
671 c
->completer
= command_completer
;
672 add_com_alias ("q", "quit", class_support
, 1);
673 add_com_alias ("h", "help", class_support
, 1);
675 c
= add_set_cmd ("verbose", class_support
, var_boolean
, (char *) &info_verbose
,
678 add_show_from_set (c
, &showlist
);
679 c
->function
.sfunc
= set_verbose
;
680 set_verbose (NULL
, 0, c
);
682 add_prefix_cmd ("history", class_support
, set_history
,
683 "Generic command for setting command history parameters.",
684 &sethistlist
, "set history ", 0, &setlist
);
685 add_prefix_cmd ("history", class_support
, show_history
,
686 "Generic command for showing command history parameters.",
687 &showhistlist
, "show history ", 0, &showlist
);
690 (add_set_cmd ("expansion", no_class
, var_boolean
, (char *) &history_expansion_p
,
691 "Set history expansion on command input.\n\
692 Without an argument, history expansion is enabled.", &sethistlist
),
695 add_prefix_cmd ("info", class_info
, info_command
,
696 "Generic command for showing things about the program being debugged.",
697 &infolist
, "info ", 0, &cmdlist
);
698 add_com_alias ("i", "info", class_info
, 1);
700 add_com ("complete", class_obscure
, complete_command
,
701 "List the completions for the rest of the line as a command.");
703 add_prefix_cmd ("show", class_info
, show_command
,
704 "Generic command for showing things about the debugger.",
705 &showlist
, "show ", 0, &cmdlist
);
706 /* Another way to get at the same thing. */
707 add_info ("set", show_command
, "Show all GDB settings.");
709 add_cmd ("commands", no_class
, show_commands
,
710 "Show the history of commands you typed.\n\
711 You can supply a command number to start with, or a `+' to start after\n\
712 the previous command number shown.",
715 add_cmd ("version", no_class
, show_version
,
716 "Show what version of GDB this is.", &showlist
);
718 add_com ("while", class_support
, while_command
,
719 "Execute nested commands WHILE the conditional expression is non zero.\n\
720 The conditional expression must follow the word `while' and must in turn be\n\
721 followed by a new line. The nested commands must be entered one per line,\n\
722 and should be terminated by the word `end'.");
724 add_com ("if", class_support
, if_command
,
725 "Execute nested commands once IF the conditional expression is non zero.\n\
726 The conditional expression must follow the word `if' and must in turn be\n\
727 followed by a new line. The nested commands must be entered one per line,\n\
728 and should be terminated by the word 'else' or `end'. If an else clause\n\
729 is used, the same rules apply to its nested commands as to the first ones.");
731 /* If target is open when baud changes, it doesn't take effect until the
732 next open (I think, not sure). */
733 add_show_from_set (add_set_cmd ("remotebaud", no_class
,
734 var_zinteger
, (char *) &baud_rate
,
735 "Set baud rate for remote serial I/O.\n\
736 This value is used to set the speed of the serial port when debugging\n\
737 using remote targets.", &setlist
),
740 c
= add_set_cmd ("remotedebug", no_class
, var_zinteger
,
741 (char *) &remote_debug
,
742 "Set debugging of remote protocol.\n\
743 When enabled, each packet sent or received with the remote target\n\
744 is displayed.", &setlist
);
745 deprecate_cmd (c
, "set debug remote");
746 deprecate_cmd (add_show_from_set (c
, &showlist
), "show debug remote");
748 add_show_from_set (add_set_cmd ("remote", no_class
, var_zinteger
,
749 (char *) &remote_debug
,
750 "Set debugging of remote protocol.\n\
751 When enabled, each packet sent or received with the remote target\n\
752 is displayed.", &setdebuglist
),
756 add_set_cmd ("remotetimeout", no_class
, var_integer
, (char *) &remote_timeout
,
757 "Set timeout limit to wait for target to respond.\n\
758 This value is used to set the time limit for gdb to wait for a response\n\
759 from the target.", &setlist
),
762 add_prefix_cmd ("debug", no_class
, set_debug
,
763 "Generic command for setting gdb debugging flags",
764 &setdebuglist
, "set debug ", 0, &setlist
);
766 add_prefix_cmd ("debug", no_class
, show_debug
,
767 "Generic command for showing gdb debugging flags",
768 &showdebuglist
, "show debug ", 0, &showlist
);
770 c
= add_com ("shell", class_support
, shell_escape
,
771 "Execute the rest of the line as a shell command. \n\
772 With no arguments, run an inferior shell.");
773 c
->completer
= filename_completer
;
775 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
776 be a really useful feature. Unfortunately, the below wont do
777 this. Instead it adds support for the form ``(gdb) ! ls''
778 (i.e. the space is required). If the ``!'' command below is
779 added the complains about no ``!'' command would be replaced by
780 complains about how the ``!'' command is broken :-) */
782 add_com_alias ("!", "shell", class_support
, 0);
784 c
= add_com ("make", class_support
, make_command
,
785 "Run the ``make'' program using the rest of the line as arguments.");
786 c
->completer
= filename_completer
;
787 add_cmd ("user", no_class
, show_user
,
788 "Show definitions of user defined commands.\n\
789 Argument is the name of the user defined command.\n\
790 With no argument, show definitions of all user defined commands.", &showlist
);
791 add_com ("apropos", class_support
, apropos_command
, "Search for commands matching a REGEXP");
This page took 0.047512 seconds and 4 git commands to generate.