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 /* String compare function for qsort. */
206 compare_strings (const void *arg1, const void *arg2)
208 const char **s1 = (const char **) arg1;
209 const char **s2 = (const char **) arg2;
210 return strcmp (*s1, *s2);
213 /* The "complete" command is used by Emacs to implement completion. */
217 complete_command (char *arg, int from_tty)
227 argpoint = strlen (arg);
229 completions = complete_line (arg, arg, argpoint);
235 for (size = 0; completions[size]; ++size)
237 qsort (completions, size, sizeof (char *), compare_strings);
239 /* We do extra processing here since we only want to print each
245 printf_unfiltered ("%s\n", completions[item]);
246 next_item = item + 1;
247 while (next_item < size
248 && ! strcmp (completions[item], completions[next_item]))
250 xfree (completions[next_item]);
254 xfree (completions[item]);
263 is_complete_command (struct cmd_list_element *c)
265 return cmd_cfunc_eq (c, complete_command);
270 show_version (char *args, int from_tty)
273 print_gdb_version (gdb_stdout);
274 printf_filtered ("\n");
278 /* Handle the quit command. */
281 quit_command (char *args, int from_tty)
283 if (!quit_confirm ())
284 error ("Not confirmed.");
285 quit_force (args, from_tty);
290 pwd_command (char *args, int from_tty)
293 error ("The \"pwd\" command does not take an argument: %s", args);
294 getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
296 if (!STREQ (gdb_dirbuf, current_directory))
297 printf_unfiltered ("Working directory %s\n (canonically %s).\n",
298 current_directory, gdb_dirbuf);
300 printf_unfiltered ("Working directory %s.\n", current_directory);
304 cd_command (char *dir, int from_tty)
307 /* Found something other than leading repetitions of "/..". */
311 /* If the new directory is absolute, repeat is a no-op; if relative,
312 repeat might be useful but is more likely to be a mistake. */
316 error_no_arg ("new working directory");
318 dir = tilde_expand (dir);
319 make_cleanup (xfree, dir);
322 perror_with_name (dir);
324 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
325 /* There's too much mess with DOSish names like "d:", "d:.",
326 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
327 simply get the canonicalized name of the current directory. */
328 dir = getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
332 if (IS_DIR_SEPARATOR (dir[len - 1]))
334 /* Remove the trailing slash unless this is a root directory
335 (including a drive letter on non-Unix systems). */
336 if (!(len == 1) /* "/" */
337 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
338 && !(len == 3 && dir[1] == ':') /* "d:/" */
344 dir = savestring (dir, len);
345 if (IS_ABSOLUTE_PATH (dir))
346 current_directory = dir;
349 if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
350 current_directory = concat (current_directory, dir, NULL);
352 current_directory = concat (current_directory, SLASH_STRING, dir, NULL);
356 /* Now simplify any occurrences of `.' and `..' in the pathname. */
359 for (p = current_directory; *p;)
361 if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
362 && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
364 else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
365 && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
369 /* Search backwards for the directory just before the "/.."
370 and obliterate it and the "/..". */
372 while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
375 if (q == current_directory)
376 /* current_directory is
377 a relative pathname ("can't happen"--leave it alone). */
381 strcpy (q - 1, p + 3);
386 /* We are dealing with leading repetitions of "/..", for example
387 "/../..", which is the Mach super-root. */
397 forget_cached_source_info ();
400 pwd_command ((char *) 0, 1);
404 source_command (char *args, int from_tty)
407 struct cleanup *old_cleanups;
412 error ("source command requires pathname of file to source.");
415 file = tilde_expand (file);
416 old_cleanups = make_cleanup (xfree, file);
418 stream = fopen (file, FOPEN_RT);
422 perror_with_name (file);
427 script_from_file (stream, file);
429 do_cleanups (old_cleanups);
434 echo_command (char *text, int from_tty)
440 while ((c = *p++) != '\0')
444 /* \ at end of argument is used after spaces
445 so they won't be lost. */
449 c = parse_escape (&p);
451 printf_filtered ("%c", c);
454 printf_filtered ("%c", c);
457 /* Force this output to appear now. */
459 gdb_flush (gdb_stdout);
464 shell_escape (char *arg, int from_tty)
467 /* If ARG is NULL, they want an inferior shell, but `system' just
468 reports if the shell is available when passed a NULL arg. */
469 int rc = system (arg ? arg : "");
472 arg = "inferior shell";
476 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
477 safe_strerror (errno));
478 gdb_flush (gdb_stderr);
482 fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
483 gdb_flush (gdb_stderr);
486 /* Make sure to return to the directory GDB thinks it is, in case the
487 shell command we just ran changed it. */
488 chdir (current_directory);
490 #else /* Can fork. */
492 char *p, *user_shell;
494 if ((user_shell = (char *) getenv ("SHELL")) == NULL)
495 user_shell = "/bin/sh";
497 /* Get the name of the shell for arg0 */
498 if ((p = strrchr (user_shell, '/')) == NULL)
501 p++; /* Get past '/' */
503 if ((pid = fork ()) == 0)
506 execl (user_shell, p, 0);
508 execl (user_shell, p, "-c", arg, 0);
510 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
511 safe_strerror (errno));
512 gdb_flush (gdb_stderr);
517 while ((rc = wait (&status)) != pid && rc != -1)
520 error ("Fork failed");
521 #endif /* Can fork. */
525 make_command (char *arg, int from_tty)
533 p = xmalloc (sizeof ("make ") + strlen (arg));
535 strcpy (p + sizeof ("make ") - 1, arg);
538 shell_escape (p, from_tty);
543 show_user (char *args, int from_tty)
545 struct cmd_list_element *c;
546 extern struct cmd_list_element *cmdlist;
550 c = lookup_cmd (&args, cmdlist, "", 0, 1);
551 if (c->class != class_user)
552 error ("Not a user command.");
553 show_user_1 (c, gdb_stdout);
557 for (c = cmdlist; c; c = c->next)
559 if (c->class == class_user)
560 show_user_1 (c, gdb_stdout);
565 /* Search through names of commands and documentations for a certain
569 apropos_command (char *searchstr, int from_tty)
571 extern struct cmd_list_element *cmdlist; /*This is the main command list*/
573 char *pattern_fastmap;
574 char errorbuffer[512];
575 pattern_fastmap = xcalloc (256, sizeof (char));
576 if (searchstr == NULL)
577 error("REGEXP string is empty");
579 if (regcomp(&pattern,searchstr,REG_ICASE) == 0)
581 pattern.fastmap=pattern_fastmap;
582 re_compile_fastmap(&pattern);
583 apropos_cmd (gdb_stdout,cmdlist,&pattern,"");
587 regerror(regcomp(&pattern,searchstr,REG_ICASE),NULL,errorbuffer,512);
588 error("Error in regular expression:%s",errorbuffer);
590 xfree (pattern_fastmap);
594 set_debug (char *arg, int from_tty)
596 printf_unfiltered ("\"set debug\" must be followed by the name of a print subcommand.\n");
597 help_list (setdebuglist, "set debug ", -1, gdb_stdout);
601 show_debug (char *args, int from_tty)
603 cmd_show_list (showdebuglist, from_tty, "");
607 init_cmd_lists (void)
616 enablebreaklist = NULL;
622 unsethistlist = NULL;
623 maintenancelist = NULL;
624 maintenanceinfolist = NULL;
625 maintenanceprintlist = NULL;
627 showprintlist = NULL;
629 showchecklist = NULL;
636 struct cmd_list_element *c;
638 /* Define the classes of commands.
639 They will appear in the help list in the reverse of this order. */
641 add_cmd ("internals", class_maintenance, NULL,
642 "Maintenance commands.\n\
643 Some gdb commands are provided just for use by gdb maintainers.\n\
644 These commands are subject to frequent change, and may not be as\n\
645 well documented as user commands.",
647 add_cmd ("obscure", class_obscure, NULL, "Obscure features.", &cmdlist);
648 add_cmd ("aliases", class_alias, NULL, "Aliases of other commands.", &cmdlist);
649 add_cmd ("user-defined", class_user, NULL, "User-defined commands.\n\
650 The commands in this class are those defined by the user.\n\
651 Use the \"define\" command to define a command.", &cmdlist);
652 add_cmd ("support", class_support, NULL, "Support facilities.", &cmdlist);
654 add_cmd ("status", class_info, NULL, "Status inquiries.", &cmdlist);
655 add_cmd ("files", class_files, NULL, "Specifying and examining files.", &cmdlist);
656 add_cmd ("breakpoints", class_breakpoint, NULL, "Making program stop at certain points.", &cmdlist);
657 add_cmd ("data", class_vars, NULL, "Examining data.", &cmdlist);
658 add_cmd ("stack", class_stack, NULL, "Examining the stack.\n\
659 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
660 counting from zero for the innermost (currently executing) frame.\n\n\
661 At any time gdb identifies one frame as the \"selected\" frame.\n\
662 Variable lookups are done with respect to the selected frame.\n\
663 When the program being debugged stops, gdb selects the innermost frame.\n\
664 The commands below can be used to select other frames by number or address.",
666 add_cmd ("running", class_run, NULL, "Running the program.", &cmdlist);
668 /* Define general commands. */
670 add_com ("pwd", class_files, pwd_command,
671 "Print working directory. This is used for your program as well.");
672 c = add_cmd ("cd", class_files, cd_command,
673 "Set working directory to DIR for debugger and program being debugged.\n\
674 The change does not take effect for the program being debugged\n\
675 until the next time it is started.", &cmdlist);
676 c->completer = filename_completer;
678 add_com ("echo", class_support, echo_command,
679 "Print a constant string. Give string as argument.\n\
680 C escape sequences may be used in the argument.\n\
681 No newline is added at the end of the argument;\n\
682 use \"\\n\" if you want a newline to be printed.\n\
683 Since leading and trailing whitespace are ignored in command arguments,\n\
684 if you want to print some you must use \"\\\" before leading whitespace\n\
685 to be printed or after trailing whitespace.");
686 add_com ("document", class_support, document_command,
687 "Document a user-defined command.\n\
688 Give command name as argument. Give documentation on following lines.\n\
689 End with a line of just \"end\".");
690 add_com ("define", class_support, define_command,
691 "Define a new command name. Command name is argument.\n\
692 Definition appears on following lines, one command per line.\n\
693 End with a line of just \"end\".\n\
694 Use the \"document\" command to give documentation for the new command.\n\
695 Commands defined in this way may have up to ten arguments.");
697 c = add_cmd ("source", class_support, source_command,
698 "Read commands from a file named FILE.\n\
699 Note that the file \"" GDBINIT_FILENAME "\" is read automatically in this way\n\
700 when gdb is started.", &cmdlist);
701 c->completer = filename_completer;
703 add_com ("quit", class_support, quit_command, "Exit gdb.");
704 c = add_com ("help", class_support, help_command, "Print list of commands.");
705 c->completer = command_completer;
706 add_com_alias ("q", "quit", class_support, 1);
707 add_com_alias ("h", "help", class_support, 1);
709 c = add_set_cmd ("verbose", class_support, var_boolean, (char *) &info_verbose,
712 add_show_from_set (c, &showlist);
713 set_cmd_sfunc (c, set_verbose);
714 set_verbose (NULL, 0, c);
716 add_prefix_cmd ("history", class_support, set_history,
717 "Generic command for setting command history parameters.",
718 &sethistlist, "set history ", 0, &setlist);
719 add_prefix_cmd ("history", class_support, show_history,
720 "Generic command for showing command history parameters.",
721 &showhistlist, "show history ", 0, &showlist);
724 (add_set_cmd ("expansion", no_class, var_boolean, (char *) &history_expansion_p,
725 "Set history expansion on command input.\n\
726 Without an argument, history expansion is enabled.", &sethistlist),
729 add_prefix_cmd ("info", class_info, info_command,
730 "Generic command for showing things about the program being debugged.",
731 &infolist, "info ", 0, &cmdlist);
732 add_com_alias ("i", "info", class_info, 1);
734 add_com ("complete", class_obscure, complete_command,
735 "List the completions for the rest of the line as a command.");
737 add_prefix_cmd ("show", class_info, show_command,
738 "Generic command for showing things about the debugger.",
739 &showlist, "show ", 0, &cmdlist);
740 /* Another way to get at the same thing. */
741 add_info ("set", show_command, "Show all GDB settings.");
743 add_cmd ("commands", no_class, show_commands,
744 "Show the history of commands you typed.\n\
745 You can supply a command number to start with, or a `+' to start after\n\
746 the previous command number shown.",
749 add_cmd ("version", no_class, show_version,
750 "Show what version of GDB this is.", &showlist);
752 add_com ("while", class_support, while_command,
753 "Execute nested commands WHILE the conditional expression is non zero.\n\
754 The conditional expression must follow the word `while' and must in turn be\n\
755 followed by a new line. The nested commands must be entered one per line,\n\
756 and should be terminated by the word `end'.");
758 add_com ("if", class_support, if_command,
759 "Execute nested commands once IF the conditional expression is non zero.\n\
760 The conditional expression must follow the word `if' and must in turn be\n\
761 followed by a new line. The nested commands must be entered one per line,\n\
762 and should be terminated by the word 'else' or `end'. If an else clause\n\
763 is used, the same rules apply to its nested commands as to the first ones.");
765 /* If target is open when baud changes, it doesn't take effect until the
766 next open (I think, not sure). */
767 add_show_from_set (add_set_cmd ("remotebaud", no_class,
768 var_zinteger, (char *) &baud_rate,
769 "Set baud rate for remote serial I/O.\n\
770 This value is used to set the speed of the serial port when debugging\n\
771 using remote targets.", &setlist),
774 c = add_set_cmd ("remotedebug", no_class, var_zinteger,
775 (char *) &remote_debug,
776 "Set debugging of remote protocol.\n\
777 When enabled, each packet sent or received with the remote target\n\
778 is displayed.", &setlist);
779 deprecate_cmd (c, "set debug remote");
780 deprecate_cmd (add_show_from_set (c, &showlist), "show debug remote");
782 add_show_from_set (add_set_cmd ("remote", no_class, var_zinteger,
783 (char *) &remote_debug,
784 "Set debugging of remote protocol.\n\
785 When enabled, each packet sent or received with the remote target\n\
786 is displayed.", &setdebuglist),
790 add_set_cmd ("remotetimeout", no_class, var_integer, (char *) &remote_timeout,
791 "Set timeout limit to wait for target to respond.\n\
792 This value is used to set the time limit for gdb to wait for a response\n\
793 from the target.", &setlist),
796 add_prefix_cmd ("debug", no_class, set_debug,
797 "Generic command for setting gdb debugging flags",
798 &setdebuglist, "set debug ", 0, &setlist);
800 add_prefix_cmd ("debug", no_class, show_debug,
801 "Generic command for showing gdb debugging flags",
802 &showdebuglist, "show debug ", 0, &showlist);
804 c = add_com ("shell", class_support, shell_escape,
805 "Execute the rest of the line as a shell command. \n\
806 With no arguments, run an inferior shell.");
807 c->completer = filename_completer;
809 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
810 be a really useful feature. Unfortunately, the below wont do
811 this. Instead it adds support for the form ``(gdb) ! ls''
812 (i.e. the space is required). If the ``!'' command below is
813 added the complains about no ``!'' command would be replaced by
814 complains about how the ``!'' command is broken :-) */
816 add_com_alias ("!", "shell", class_support, 0);
818 c = add_com ("make", class_support, make_command,
819 "Run the ``make'' program using the rest of the line as arguments.");
820 c->completer = filename_completer;
821 add_cmd ("user", no_class, show_user,
822 "Show definitions of user defined commands.\n\
823 Argument is the name of the user defined command.\n\
824 With no argument, show definitions of all user defined commands.", &showlist);
825 add_com ("apropos", class_support, apropos_command, "Search for commands matching a REGEXP");