1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
4 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
5 2008 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "call-cmds.h"
25 #include "cli/cli-cmds.h"
26 #include "cli/cli-script.h"
27 #include "cli/cli-setshow.h"
28 #include "cli/cli-decode.h"
31 #include "exceptions.h"
34 #include "breakpoint.h"
36 #include "expression.h"
39 #include "terminal.h" /* For job_control. */
41 #include "completer.h"
46 #include "gdb_assert.h"
48 #include "event-loop.h"
50 /* readline include files */
51 #include "readline/readline.h"
52 #include "readline/history.h"
54 /* readline defines this. */
57 #include <sys/types.h>
59 #include "event-top.h"
60 #include "gdb_string.h"
66 /* Default command line prompt. This is overriden in some configs. */
68 #ifndef DEFAULT_PROMPT
69 #define DEFAULT_PROMPT "(gdb) "
72 /* Initialization file name for gdb. This is overridden in some configs. */
76 # define PATH_MAX FILENAME_MAX
82 #ifndef GDBINIT_FILENAME
83 #define GDBINIT_FILENAME ".gdbinit"
85 char gdbinit
[PATH_MAX
+ 1] = GDBINIT_FILENAME
;
87 int inhibit_gdbinit
= 0;
89 /* If nonzero, and GDB has been configured to be able to use windows,
90 attempt to open them upon startup. */
94 extern char lang_frame_mismatch_warn
[]; /* language.c */
96 /* Flag for whether we want all the "from_tty" gubbish printed. */
98 int caution
= 1; /* Default is yes, sigh. */
100 show_caution (struct ui_file
*file
, int from_tty
,
101 struct cmd_list_element
*c
, const char *value
)
103 fprintf_filtered (file
, _("\
104 Whether to confirm potentially dangerous operations is %s.\n"),
108 /* stdio stream that command input is being read from. Set to stdin normally.
109 Set by source_command to the file we are sourcing. Set to NULL if we are
110 executing a user-defined command or interacting via a GUI. */
114 /* Flag to indicate whether a user defined command is currently running. */
118 /* Current working directory. */
120 char *current_directory
;
122 /* The directory name is actually stored here (usually). */
123 char gdb_dirbuf
[1024];
125 /* Function to call before reading a command, if nonzero.
126 The function receives two args: an input stream,
127 and a prompt string. */
129 void (*window_hook
) (FILE *, char *);
134 /* gdb prints this when reading a command interactively */
135 static char *gdb_prompt_string
; /* the global prompt string */
137 /* Buffer used for reading command lines, and the size
138 allocated for it so far. */
143 /* Nonzero if the current command is modified by "server ". This
144 affects things like recording into the command history, commands
145 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
146 whatever) can issue its own commands and also send along commands
147 from the user, and have the user not notice that the user interface
148 is issuing commands too. */
151 /* Baud rate specified for talking to serial target systems. Default
152 is left as -1, so targets can choose their own defaults. */
153 /* FIXME: This means that "show remotebaud" and gr_files_info can print -1
154 or (unsigned int)-1. This is a Bad User Interface. */
158 /* Timeout limit for response from target. */
160 /* The default value has been changed many times over the years. It
161 was originally 5 seconds. But that was thought to be a long time
162 to sit and wait, so it was changed to 2 seconds. That was thought
163 to be plenty unless the connection was going through some terminal
164 server or multiplexer or other form of hairy serial connection.
166 In mid-1996, remote_timeout was moved from remote.c to top.c and
167 it began being used in other remote-* targets. It appears that the
168 default was changed to 20 seconds at that time, perhaps because the
169 Renesas E7000 ICE didn't always respond in a timely manner.
171 But if 5 seconds is a long time to sit and wait for retransmissions,
172 20 seconds is far worse. This demonstrates the difficulty of using
173 a single variable for all protocol timeouts.
175 As remote.c is used much more than remote-e7000.c, it was changed
176 back to 2 seconds in 1999. */
178 int remote_timeout
= 2;
180 /* Non-zero tells remote* modules to output debugging info. */
182 int remote_debug
= 0;
184 /* Non-zero means the target is running. Note: this is different from
185 saying that there is an active target and we are stopped at a
186 breakpoint, for instance. This is a real indicator whether the
187 target is off and running, which gdb is doing something else. */
188 int target_executing
= 0;
190 /* Sbrk location on entry to main. Used for statistics only. */
195 /* Signal to catch ^Z typed while reading a command: SIGTSTP or SIGCONT. */
199 #define STOP_SIGNAL SIGTSTP
200 static void stop_sig (int);
204 /* Hooks for alternate command interfaces. */
206 /* Called after most modules have been initialized, but before taking users
209 If the UI fails to initialize and it wants GDB to continue
210 using the default UI, then it should clear this hook before returning. */
212 void (*deprecated_init_ui_hook
) (char *argv0
);
214 /* This hook is called from within gdb's many mini-event loops which could
215 steal control from a real user interface's event loop. It returns
216 non-zero if the user is requesting a detach, zero otherwise. */
218 int (*deprecated_ui_loop_hook
) (int);
220 /* Called instead of command_loop at top level. Can be invoked via
221 throw_exception(). */
223 void (*deprecated_command_loop_hook
) (void);
226 /* Called from print_frame_info to list the line we stopped in. */
228 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
, int line
,
229 int stopline
, int noerror
);
230 /* Replaces most of query. */
232 int (*deprecated_query_hook
) (const char *, va_list);
234 /* Replaces most of warning. */
236 void (*deprecated_warning_hook
) (const char *, va_list);
238 /* These three functions support getting lines of text from the user.
239 They are used in sequence. First deprecated_readline_begin_hook is
240 called with a text string that might be (for example) a message for
241 the user to type in a sequence of commands to be executed at a
242 breakpoint. If this function calls back to a GUI, it might take
243 this opportunity to pop up a text interaction window with this
244 message. Next, deprecated_readline_hook is called with a prompt
245 that is emitted prior to collecting the user input. It can be
246 called multiple times. Finally, deprecated_readline_end_hook is
247 called to notify the GUI that we are done with the interaction
248 window and it can close it. */
250 void (*deprecated_readline_begin_hook
) (char *, ...);
251 char *(*deprecated_readline_hook
) (char *);
252 void (*deprecated_readline_end_hook
) (void);
254 /* Called as appropriate to notify the interface of the specified breakpoint
257 void (*deprecated_create_breakpoint_hook
) (struct breakpoint
* bpt
);
258 void (*deprecated_delete_breakpoint_hook
) (struct breakpoint
* bpt
);
259 void (*deprecated_modify_breakpoint_hook
) (struct breakpoint
* bpt
);
261 /* Called as appropriate to notify the interface that we have attached
262 to or detached from an already running process. */
264 void (*deprecated_attach_hook
) (void);
265 void (*deprecated_detach_hook
) (void);
267 /* Called during long calculations to allow GUI to repair window damage, and to
268 check for stop buttons, etc... */
270 void (*deprecated_interactive_hook
) (void);
272 /* Tell the GUI someone changed the register REGNO. -1 means
273 that the caller does not know which register changed or
274 that several registers have changed (see value_assign). */
275 void (*deprecated_register_changed_hook
) (int regno
);
277 /* Tell the GUI someone changed LEN bytes of memory at ADDR */
278 void (*deprecated_memory_changed_hook
) (CORE_ADDR addr
, int len
);
280 /* Called when going to wait for the target. Usually allows the GUI to run
281 while waiting for target events. */
283 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
284 struct target_waitstatus
* status
);
286 /* Used by UI as a wrapper around command execution. May do various things
287 like enabling/disabling buttons, etc... */
289 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
, char *cmd
,
292 /* Called after a `set' command has finished. Is only run if the
293 `set' command succeeded. */
295 void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
297 /* Called when the current thread changes. Argument is thread id. */
299 void (*deprecated_context_hook
) (int id
);
301 /* Takes control from error (). Typically used to prevent longjmps out of the
302 middle of the GUI. Usually used in conjunction with a catch routine. */
304 void (*deprecated_error_hook
) (void);
306 /* Handler for SIGHUP. */
309 /* NOTE 1999-04-29: This function will be static again, once we modify
310 gdb to use the event loop as the default command loop and we merge
311 event-top.c into this file, top.c */
315 caution
= 0; /* Throw caution to the wind -- we're exiting.
316 This prevents asking the user dumb questions. */
317 quit_command ((char *) 0, 0);
320 #endif /* defined SIGHUP */
322 /* Line number we are currently in in a file which is being sourced. */
323 /* NOTE 1999-04-29: This variable will be static again, once we modify
324 gdb to use the event loop as the default command loop and we merge
325 event-top.c into this file, top.c */
326 /* static */ int source_line_number
;
328 /* Name of the file we are sourcing. */
329 /* NOTE 1999-04-29: This variable will be static again, once we modify
330 gdb to use the event loop as the default command loop and we merge
331 event-top.c into this file, top.c */
332 /* static */ char *source_file_name
;
334 /* Clean up on error during a "source" command (or execution of a
335 user-defined command). */
338 do_restore_instream_cleanup (void *stream
)
340 /* Restore the previous input stream. */
344 /* Read commands from STREAM. */
346 read_command_file (FILE *stream
)
348 struct cleanup
*cleanups
;
350 cleanups
= make_cleanup (do_restore_instream_cleanup
, instream
);
353 do_cleanups (cleanups
);
356 void (*pre_init_ui_hook
) (void);
360 do_chdir_cleanup (void *old_dir
)
367 /* Execute the line P as a command.
368 Pass FROM_TTY as second argument to the defining function. */
371 execute_command (char *p
, int from_tty
)
373 struct cmd_list_element
*c
;
375 static int warned
= 0;
380 /* Force cleanup of any alloca areas if using C alloca instead of
384 /* This can happen when command_line_input hits end of file. */
388 target_log_command (p
);
390 while (*p
== ' ' || *p
== '\t')
397 /* If trace-commands is set then this will print this command. */
398 print_command_trace (p
);
400 c
= lookup_cmd (&p
, cmdlist
, "", 0, 1);
402 /* If the target is running, we allow only a limited set of
404 if (target_can_async_p () && target_executing
)
405 if (strcmp (c
->name
, "help") != 0
406 && strcmp (c
->name
, "pwd") != 0
407 && strcmp (c
->name
, "show") != 0
408 && strcmp (c
->name
, "info") != 0
409 && strcmp (c
->name
, "interrupt") != 0)
410 error (_("Cannot execute this command while the target is running."));
412 /* Pass null arg rather than an empty one. */
415 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
416 while the is_complete_command(cfunc) test is just plain
417 bogus. They should both be replaced by a test of the form
418 c->strip_trailing_white_space_p. */
419 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
420 can't be replaced with func. This is because it is the
421 cfunc, and not the func, that has the value that the
422 is_complete_command hack is testing for. */
423 /* Clear off trailing whitespace, except for set and complete
426 && c
->type
!= set_cmd
427 && !is_complete_command (c
))
429 p
= arg
+ strlen (arg
) - 1;
430 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
435 /* If this command has been pre-hooked, run the hook first. */
436 execute_cmd_pre_hook (c
);
438 if (c
->flags
& DEPRECATED_WARN_USER
)
439 deprecated_cmd_warning (&line
);
441 if (c
->class == class_user
)
442 execute_user_command (c
, arg
);
443 else if (c
->type
== set_cmd
|| c
->type
== show_cmd
)
444 do_setshow_command (arg
, from_tty
& caution
, c
);
445 else if (!cmd_func_p (c
))
446 error (_("That is not a command, just a help topic."));
447 else if (deprecated_call_command_hook
)
448 deprecated_call_command_hook (c
, arg
, from_tty
& caution
);
450 cmd_func (c
, arg
, from_tty
& caution
);
452 /* If this command has been post-hooked, run the hook last. */
453 execute_cmd_post_hook (c
);
457 /* Tell the user if the language has changed (except first time). */
458 if (current_language
!= expected_language
)
460 if (language_mode
== language_mode_auto
)
462 language_info (1); /* Print what changed. */
467 /* Warn the user if the working language does not match the
468 language of the current frame. Only warn the user if we are
469 actually running the program, i.e. there is a stack. */
470 /* FIXME: This should be cacheing the frame and only running when
471 the frame changes. */
473 if (target_has_stack
)
475 flang
= get_frame_language ();
477 && flang
!= language_unknown
478 && flang
!= current_language
->la_language
)
480 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
486 /* Read commands from `instream' and execute them
487 until end of file or error reading instream. */
492 struct cleanup
*old_chain
;
494 int stdin_is_tty
= ISATTY (stdin
);
495 long time_at_cmd_start
;
497 long space_at_cmd_start
= 0;
499 extern int display_time
;
500 extern int display_space
;
502 while (instream
&& !feof (instream
))
504 if (window_hook
&& instream
== stdin
)
505 (*window_hook
) (instream
, get_prompt ());
508 if (instream
== stdin
&& stdin_is_tty
)
509 reinitialize_more_filter ();
510 old_chain
= make_cleanup (null_cleanup
, 0);
512 /* Get a command-line. This calls the readline package. */
513 command
= command_line_input (instream
== stdin
?
514 get_prompt () : (char *) NULL
,
515 instream
== stdin
, "prompt");
519 time_at_cmd_start
= get_run_time ();
524 char *lim
= (char *) sbrk (0);
525 space_at_cmd_start
= lim
- lim_at_start
;
529 execute_command (command
, instream
== stdin
);
530 /* Do any commands attached to breakpoint we stopped at. */
531 bpstat_do_actions (&stop_bpstat
);
532 do_cleanups (old_chain
);
536 long cmd_time
= get_run_time () - time_at_cmd_start
;
538 printf_unfiltered (_("Command execution time: %ld.%06ld\n"),
539 cmd_time
/ 1000000, cmd_time
% 1000000);
545 char *lim
= (char *) sbrk (0);
546 long space_now
= lim
- lim_at_start
;
547 long space_diff
= space_now
- space_at_cmd_start
;
549 printf_unfiltered (_("Space used: %ld (%s%ld for this command)\n"),
551 (space_diff
>= 0 ? "+" : ""),
558 /* Read commands from `instream' and execute them until end of file or
559 error reading instream. This command loop doesnt care about any
560 such things as displaying time and space usage. If the user asks
561 for those, they won't work. */
563 simplified_command_loop (char *(*read_input_func
) (char *),
564 void (*execute_command_func
) (char *, int))
566 struct cleanup
*old_chain
;
568 int stdin_is_tty
= ISATTY (stdin
);
570 while (instream
&& !feof (instream
))
573 if (instream
== stdin
&& stdin_is_tty
)
574 reinitialize_more_filter ();
575 old_chain
= make_cleanup (null_cleanup
, 0);
577 /* Get a command-line. */
578 command
= (*read_input_func
) (instream
== stdin
?
579 get_prompt () : (char *) NULL
);
584 (*execute_command_func
) (command
, instream
== stdin
);
586 /* Do any commands attached to breakpoint we stopped at. */
587 bpstat_do_actions (&stop_bpstat
);
589 do_cleanups (old_chain
);
593 /* Commands call this if they do not want to be repeated by null lines. */
601 /* If we aren't reading from standard input, we are saving the last
602 thing read from stdin in line and don't want to delete it. Null lines
603 won't repeat here in any case. */
604 if (instream
== stdin
)
608 /* Read a line from the stream "instream" without command line editing.
610 It prints PROMPT_ARG once at the start.
611 Action is compatible with "readline", e.g. space for the result is
612 malloc'd and should be freed by the caller.
614 A NULL return means end of file. */
616 gdb_readline (char *prompt_arg
)
621 int result_size
= 80;
625 /* Don't use a _filtered function here. It causes the assumed
626 character position to be off, since the newline we read from
627 the user is not accounted for. */
628 fputs_unfiltered (prompt_arg
, gdb_stdout
);
629 gdb_flush (gdb_stdout
);
632 result
= (char *) xmalloc (result_size
);
636 /* Read from stdin if we are executing a user defined command.
637 This is the right thing for prompt_for_continue, at least. */
638 c
= fgetc (instream
? instream
: stdin
);
643 /* The last line does not end with a newline. Return it, and
644 if we are called again fgetc will still return EOF and
645 we'll return NULL then. */
653 if (input_index
> 0 && result
[input_index
- 1] == '\r')
658 result
[input_index
++] = c
;
659 while (input_index
>= result_size
)
662 result
= (char *) xrealloc (result
, result_size
);
666 result
[input_index
++] = '\0';
670 /* Variables which control command line editing and history
671 substitution. These variables are given default values at the end
673 static int command_editing_p
;
675 /* NOTE 1999-04-29: This variable will be static again, once we modify
676 gdb to use the event loop as the default command loop and we merge
677 event-top.c into this file, top.c */
679 /* static */ int history_expansion_p
;
681 static int write_history_p
;
683 show_write_history_p (struct ui_file
*file
, int from_tty
,
684 struct cmd_list_element
*c
, const char *value
)
686 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
690 static int history_size
;
692 show_history_size (struct ui_file
*file
, int from_tty
,
693 struct cmd_list_element
*c
, const char *value
)
695 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
699 static char *history_filename
;
701 show_history_filename (struct ui_file
*file
, int from_tty
,
702 struct cmd_list_element
*c
, const char *value
)
704 fprintf_filtered (file
, _("\
705 The filename in which to record the command history is \"%s\".\n"),
709 /* This is like readline(), but it has some gdb-specific behavior.
710 gdb may want readline in both the synchronous and async modes during
711 a single gdb invocation. At the ordinary top-level prompt we might
712 be using the async readline. That means we can't use
713 rl_pre_input_hook, since it doesn't work properly in async mode.
714 However, for a secondary prompt (" >", such as occurs during a
715 `define'), gdb wants a synchronous response.
717 We used to call readline() directly, running it in synchronous
718 mode. But mixing modes this way is not supported, and as of
719 readline 5.x it no longer works; the arrow keys come unbound during
720 the synchronous call. So we make a nested call into the event
721 loop. That's what gdb_readline_wrapper is for. */
723 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
724 rely on gdb_readline_wrapper_result, which might still be NULL if
725 the user types Control-D for EOF. */
726 static int gdb_readline_wrapper_done
;
728 /* The result of the current call to gdb_readline_wrapper, once a newline
730 static char *gdb_readline_wrapper_result
;
732 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
733 to be called after the newline is processed (which will redisplay
734 the prompt). But in gdb_readline_wrapper we will not get a new
735 prompt until the next call, or until we return to the event loop.
736 So we disable this hook around the newline and restore it before we
738 static void (*saved_after_char_processing_hook
) (void);
740 /* This function is called when readline has seen a complete line of
744 gdb_readline_wrapper_line (char *line
)
746 gdb_assert (!gdb_readline_wrapper_done
);
747 gdb_readline_wrapper_result
= line
;
748 gdb_readline_wrapper_done
= 1;
750 /* Prevent operate-and-get-next from acting too early. */
751 saved_after_char_processing_hook
= after_char_processing_hook
;
752 after_char_processing_hook
= NULL
;
754 /* Prevent parts of the prompt from being redisplayed if annotations
755 are enabled, and readline's state getting out of sync. */
756 if (async_command_editing_p
)
757 rl_callback_handler_remove ();
760 struct gdb_readline_wrapper_cleanup
762 void (*handler_orig
) (char *);
763 int already_prompted_orig
;
767 gdb_readline_wrapper_cleanup (void *arg
)
769 struct gdb_readline_wrapper_cleanup
*cleanup
= arg
;
771 rl_already_prompted
= cleanup
->already_prompted_orig
;
773 gdb_assert (input_handler
== gdb_readline_wrapper_line
);
774 input_handler
= cleanup
->handler_orig
;
775 gdb_readline_wrapper_result
= NULL
;
776 gdb_readline_wrapper_done
= 0;
778 after_char_processing_hook
= saved_after_char_processing_hook
;
779 saved_after_char_processing_hook
= NULL
;
785 gdb_readline_wrapper (char *prompt
)
787 struct cleanup
*back_to
;
788 struct gdb_readline_wrapper_cleanup
*cleanup
;
791 cleanup
= xmalloc (sizeof (*cleanup
));
792 cleanup
->handler_orig
= input_handler
;
793 input_handler
= gdb_readline_wrapper_line
;
795 cleanup
->already_prompted_orig
= rl_already_prompted
;
797 back_to
= make_cleanup (gdb_readline_wrapper_cleanup
, cleanup
);
799 /* Display our prompt and prevent double prompt display. */
800 display_gdb_prompt (prompt
);
801 rl_already_prompted
= 1;
803 if (after_char_processing_hook
)
804 (*after_char_processing_hook
) ();
805 gdb_assert (after_char_processing_hook
== NULL
);
807 /* gdb_do_one_event argument is unused. */
808 while (gdb_do_one_event (NULL
) >= 0)
809 if (gdb_readline_wrapper_done
)
812 retval
= gdb_readline_wrapper_result
;
813 do_cleanups (back_to
);
822 #if STOP_SIGNAL == SIGTSTP
823 signal (SIGTSTP
, SIG_DFL
);
829 sigprocmask (SIG_SETMASK
, &zero
, 0);
831 #elif HAVE_SIGSETMASK
834 kill (getpid (), SIGTSTP
);
835 signal (SIGTSTP
, stop_sig
);
837 signal (STOP_SIGNAL
, stop_sig
);
839 printf_unfiltered ("%s", get_prompt ());
840 gdb_flush (gdb_stdout
);
842 /* Forget about any previous command -- null line now will do nothing. */
845 #endif /* STOP_SIGNAL */
847 /* Initialize signal handlers. */
849 float_handler (int signo
)
851 /* This message is based on ANSI C, section 4.7. Note that integer
852 divide by zero causes this, so "float" is a misnomer. */
853 signal (SIGFPE
, float_handler
);
854 error (_("Erroneous arithmetic operation."));
858 do_nothing (int signo
)
860 /* Under System V the default disposition of a signal is reinstated after
861 the signal is caught and delivered to an application process. On such
862 systems one must restore the replacement signal handler if one wishes
863 to continue handling the signal in one's program. On BSD systems this
864 is not needed but it is harmless, and it simplifies the code to just do
865 it unconditionally. */
866 signal (signo
, do_nothing
);
869 /* The current saved history number from operate-and-get-next.
870 This is -1 if not valid. */
871 static int operate_saved_history
= -1;
873 /* This is put on the appropriate hook and helps operate-and-get-next
876 gdb_rl_operate_and_get_next_completion (void)
878 int delta
= where_history () - operate_saved_history
;
879 /* The `key' argument to rl_get_previous_history is ignored. */
880 rl_get_previous_history (delta
, 0);
881 operate_saved_history
= -1;
883 /* readline doesn't automatically update the display for us. */
886 after_char_processing_hook
= NULL
;
887 rl_pre_input_hook
= NULL
;
890 /* This is a gdb-local readline command handler. It accepts the
891 current command line (like RET does) and, if this command was taken
892 from the history, arranges for the next command in the history to
893 appear on the command line when the prompt returns.
894 We ignore the arguments. */
896 gdb_rl_operate_and_get_next (int count
, int key
)
900 /* Use the async hook. */
901 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
903 /* Find the current line, and find the next line to use. */
904 where
= where_history();
906 /* FIXME: kettenis/20020817: max_input_history is renamed into
907 history_max_entries in readline-4.2. When we do a new readline
908 import, we should probably change it here too, even though
909 readline maintains backwards compatibility for now by still
910 defining max_input_history. */
911 if ((history_is_stifled () && (history_length
>= max_input_history
)) ||
912 (where
>= history_length
- 1))
913 operate_saved_history
= where
;
915 operate_saved_history
= where
+ 1;
917 return rl_newline (1, key
);
920 /* Read one line from the command input stream `instream'
921 into the local static buffer `linebuffer' (whose current length
923 The buffer is made bigger as necessary.
924 Returns the address of the start of the line.
926 NULL is returned for end of file.
928 *If* the instream == stdin & stdin is a terminal, the line read
929 is copied into the file line saver (global var char *line,
930 length linesize) so that it can be duplicated.
932 This routine either uses fancy command line editing or
933 simple input as the user has requested. */
936 command_line_input (char *prompt_arg
, int repeat
, char *annotation_suffix
)
938 static char *linebuffer
= 0;
939 static unsigned linelength
= 0;
943 char *local_prompt
= prompt_arg
;
947 /* The annotation suffix must be non-NULL. */
948 if (annotation_suffix
== NULL
)
949 annotation_suffix
= "";
951 if (annotation_level
> 1 && instream
== stdin
)
953 local_prompt
= alloca ((prompt_arg
== NULL
? 0 : strlen (prompt_arg
))
954 + strlen (annotation_suffix
) + 40);
955 if (prompt_arg
== NULL
)
956 local_prompt
[0] = '\0';
958 strcpy (local_prompt
, prompt_arg
);
959 strcat (local_prompt
, "\n\032\032");
960 strcat (local_prompt
, annotation_suffix
);
961 strcat (local_prompt
, "\n");
967 linebuffer
= (char *) xmalloc (linelength
);
972 /* Control-C quits instantly if typed while in this loop
973 since it should not wait until the user types a newline. */
977 signal (STOP_SIGNAL
, handle_stop_sig
);
982 /* Make sure that all output has been output. Some machines may let
983 you get away with leaving out some of the gdb_flush, but not all. */
985 gdb_flush (gdb_stdout
);
986 gdb_flush (gdb_stderr
);
988 if (source_file_name
!= NULL
)
989 ++source_line_number
;
991 if (annotation_level
> 1 && instream
== stdin
)
993 puts_unfiltered ("\n\032\032pre-");
994 puts_unfiltered (annotation_suffix
);
995 puts_unfiltered ("\n");
998 /* Don't use fancy stuff if not talking to stdin. */
999 if (deprecated_readline_hook
&& input_from_terminal_p ())
1001 rl
= (*deprecated_readline_hook
) (local_prompt
);
1003 else if (command_editing_p
&& input_from_terminal_p ())
1005 rl
= gdb_readline_wrapper (local_prompt
);
1009 rl
= gdb_readline (local_prompt
);
1012 if (annotation_level
> 1 && instream
== stdin
)
1014 puts_unfiltered ("\n\032\032post-");
1015 puts_unfiltered (annotation_suffix
);
1016 puts_unfiltered ("\n");
1019 if (!rl
|| rl
== (char *) EOF
)
1024 if (strlen (rl
) + 1 + (p
- linebuffer
) > linelength
)
1026 linelength
= strlen (rl
) + 1 + (p
- linebuffer
);
1027 nline
= (char *) xrealloc (linebuffer
, linelength
);
1028 p
+= nline
- linebuffer
;
1032 /* Copy line. Don't copy null at end. (Leaves line alone
1033 if this was just a newline) */
1037 xfree (rl
); /* Allocated in readline. */
1039 if (p
== linebuffer
|| *(p
- 1) != '\\')
1042 p
--; /* Put on top of '\'. */
1043 local_prompt
= (char *) 0;
1048 signal (STOP_SIGNAL
, SIG_DFL
);
1055 #define SERVER_COMMAND_LENGTH 7
1057 (p
- linebuffer
> SERVER_COMMAND_LENGTH
)
1058 && strncmp (linebuffer
, "server ", SERVER_COMMAND_LENGTH
) == 0;
1061 /* Note that we don't set `line'. Between this and the check in
1062 dont_repeat, this insures that repeating will still do the
1065 return linebuffer
+ SERVER_COMMAND_LENGTH
;
1068 /* Do history expansion if that is wished. */
1069 if (history_expansion_p
&& instream
== stdin
1070 && ISATTY (instream
))
1072 char *history_value
;
1075 *p
= '\0'; /* Insert null now. */
1076 expanded
= history_expand (linebuffer
, &history_value
);
1079 /* Print the changes. */
1080 printf_unfiltered ("%s\n", history_value
);
1082 /* If there was an error, call this function again. */
1085 xfree (history_value
);
1086 return command_line_input (prompt_arg
, repeat
, annotation_suffix
);
1088 if (strlen (history_value
) > linelength
)
1090 linelength
= strlen (history_value
) + 1;
1091 linebuffer
= (char *) xrealloc (linebuffer
, linelength
);
1093 strcpy (linebuffer
, history_value
);
1094 p
= linebuffer
+ strlen (linebuffer
);
1096 xfree (history_value
);
1099 /* If we just got an empty line, and that is supposed
1100 to repeat the previous command, return the value in the
1102 if (repeat
&& p
== linebuffer
)
1104 for (p1
= linebuffer
; *p1
== ' ' || *p1
== '\t'; p1
++);
1110 /* Add line to history if appropriate. */
1111 if (instream
== stdin
1112 && ISATTY (stdin
) && *linebuffer
)
1113 add_history (linebuffer
);
1115 /* Note: lines consisting solely of comments are added to the command
1116 history. This is useful when you type a command, and then
1117 realize you don't want to execute it quite yet. You can comment
1118 out the command and then later fetch it from the value history
1119 and remove the '#'. The kill ring is probably better, but some
1120 people are in the habit of commenting things out. */
1122 *p1
= '\0'; /* Found a comment. */
1124 /* Save into global buffer if appropriate. */
1127 if (linelength
> linesize
)
1129 line
= xrealloc (line
, linelength
);
1130 linesize
= linelength
;
1132 strcpy (line
, linebuffer
);
1139 /* Print the GDB banner. */
1141 print_gdb_version (struct ui_file
*stream
)
1143 /* From GNU coding standards, first line is meant to be easy for a
1144 program to parse, and is just canonical program name and version
1145 number, which starts after last space. */
1147 fprintf_filtered (stream
, "GNU gdb %s\n", version
);
1149 /* Second line is a copyright notice. */
1151 fprintf_filtered (stream
, "Copyright (C) 2008 Free Software Foundation, Inc.\n");
1153 /* Following the copyright is a brief statement that the program is
1154 free software, that users are free to copy and change it on
1155 certain conditions, that it is covered by the GNU GPL, and that
1156 there is no warranty. */
1158 fprintf_filtered (stream
, "\
1159 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n\
1160 This is free software: you are free to change and redistribute it.\n\
1161 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1162 and \"show warranty\" for details.\n");
1164 /* After the required info we print the configuration information. */
1166 fprintf_filtered (stream
, "This GDB was configured as \"");
1167 if (strcmp (host_name
, target_name
) != 0)
1169 fprintf_filtered (stream
, "--host=%s --target=%s", host_name
, target_name
);
1173 fprintf_filtered (stream
, "%s", host_name
);
1175 fprintf_filtered (stream
, "\".");
1178 /* get_prompt: access method for the GDB prompt string. */
1187 set_prompt (char *s
)
1189 /* ??rehrauer: I don't know why this fails, since it looks as though
1190 assignments to prompt are wrapped in calls to savestring...
1194 PROMPT (0) = savestring (s
, strlen (s
));
1198 /* If necessary, make the user confirm that we should quit. Return
1199 non-zero if we should quit, zero if we shouldn't. */
1204 if (! ptid_equal (inferior_ptid
, null_ptid
) && target_has_execution
)
1208 /* This is something of a hack. But there's no reliable way to
1209 see if a GUI is running. The `use_windows' variable doesn't
1211 if (deprecated_init_ui_hook
)
1212 s
= "A debugging session is active.\nDo you still want to close the debugger?";
1213 else if (attach_flag
)
1214 s
= "The program is running. Quit anyway (and detach it)? ";
1216 s
= "The program is running. Exit anyway? ";
1218 if (!query ("%s", s
))
1225 /* Helper routine for quit_force that requires error handling. */
1234 quit_target (void *arg
)
1236 struct qt_args
*qt
= (struct qt_args
*)arg
;
1238 if (! ptid_equal (inferior_ptid
, null_ptid
) && target_has_execution
)
1241 target_detach (qt
->args
, qt
->from_tty
);
1246 /* UDI wants this, to kill the TIP. */
1247 target_close (¤t_target
, 1);
1249 /* Save the history information if it is appropriate to do so. */
1250 if (write_history_p
&& history_filename
)
1251 write_history (history_filename
);
1253 do_final_cleanups (ALL_CLEANUPS
); /* Do any final cleanups before exiting */
1258 /* Quit without asking for confirmation. */
1261 quit_force (char *args
, int from_tty
)
1266 /* An optional expression may be used to cause gdb to terminate with the
1267 value of that expression. */
1270 struct value
*val
= parse_and_eval (args
);
1272 exit_code
= (int) value_as_long (val
);
1274 else if (return_child_result
)
1275 exit_code
= return_child_result_value
;
1278 qt
.from_tty
= from_tty
;
1280 /* We want to handle any quit errors and exit regardless. */
1281 catch_errors (quit_target
, &qt
,
1282 "Quitting: ", RETURN_MASK_ALL
);
1287 /* Returns whether GDB is running on a terminal and input is
1288 currently coming from that terminal. */
1291 input_from_terminal_p (void)
1293 if (gdb_has_a_terminal () && instream
== stdin
)
1296 /* If INSTREAM is unset, and we are not in a user command, we
1297 must be in Insight. That's like having a terminal, for our
1299 if (instream
== NULL
&& !in_user_command
)
1306 dont_repeat_command (char *ignored
, int from_tty
)
1308 *line
= 0; /* Can't call dont_repeat here because we're not
1309 necessarily reading from stdin. */
1312 /* Functions to manipulate command line editing control variables. */
1314 /* Number of commands to print in each call to show_commands. */
1315 #define Hist_print 10
1317 show_commands (char *args
, int from_tty
)
1319 /* Index for history commands. Relative to history_base. */
1322 /* Number of the history entry which we are planning to display next.
1323 Relative to history_base. */
1326 /* The first command in the history which doesn't exist (i.e. one more
1327 than the number of the last command). Relative to history_base. */
1330 /* Print out some of the commands from the command history. */
1331 /* First determine the length of the history list. */
1332 hist_len
= history_size
;
1333 for (offset
= 0; offset
< history_size
; offset
++)
1335 if (!history_get (history_base
+ offset
))
1344 if (args
[0] == '+' && args
[1] == '\0')
1345 /* "info editing +" should print from the stored position. */
1348 /* "info editing <exp>" should print around command number <exp>. */
1349 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1351 /* "show commands" means print the last Hist_print commands. */
1354 num
= hist_len
- Hist_print
;
1360 /* If there are at least Hist_print commands, we want to display the last
1361 Hist_print rather than, say, the last 6. */
1362 if (hist_len
- num
< Hist_print
)
1364 num
= hist_len
- Hist_print
;
1369 for (offset
= num
; offset
< num
+ Hist_print
&& offset
< hist_len
; offset
++)
1371 printf_filtered ("%5d %s\n", history_base
+ offset
,
1372 (history_get (history_base
+ offset
))->line
);
1375 /* The next command we want to display is the next one that we haven't
1379 /* If the user repeats this command with return, it should do what
1380 "show commands +" does. This is unnecessary if arg is null,
1381 because "show commands +" is not useful after "show commands". */
1382 if (from_tty
&& args
)
1389 /* Called by do_setshow_command. */
1391 set_history_size_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1393 if (history_size
== INT_MAX
)
1394 unstifle_history ();
1395 else if (history_size
>= 0)
1396 stifle_history (history_size
);
1399 history_size
= INT_MAX
;
1400 error (_("History size must be non-negative"));
1405 set_history (char *args
, int from_tty
)
1407 printf_unfiltered (_("\"set history\" must be followed by the name of a history subcommand.\n"));
1408 help_list (sethistlist
, "set history ", -1, gdb_stdout
);
1412 show_history (char *args
, int from_tty
)
1414 cmd_show_list (showhistlist
, from_tty
, "");
1417 int info_verbose
= 0; /* Default verbose msgs off */
1419 /* Called by do_setshow_command. An elaborate joke. */
1421 set_verbose (char *args
, int from_tty
, struct cmd_list_element
*c
)
1423 char *cmdname
= "verbose";
1424 struct cmd_list_element
*showcmd
;
1426 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1430 c
->doc
= "Set verbose printing of informational messages.";
1431 showcmd
->doc
= "Show verbose printing of informational messages.";
1435 c
->doc
= "Set verbosity.";
1436 showcmd
->doc
= "Show verbosity.";
1440 /* Init the history buffer. Note that we are called after the init file(s)
1441 * have been read so that the user can change the history file via his
1442 * .gdbinit file (for instance). The GDBHISTFILE environment variable
1443 * overrides all of this.
1451 tmpenv
= getenv ("HISTSIZE");
1453 history_size
= atoi (tmpenv
);
1454 else if (!history_size
)
1457 stifle_history (history_size
);
1459 tmpenv
= getenv ("GDBHISTFILE");
1461 history_filename
= savestring (tmpenv
, strlen (tmpenv
));
1462 else if (!history_filename
)
1464 /* We include the current directory so that if the user changes
1465 directories the file written will be the same as the one
1468 /* No leading dots in file names are allowed on MSDOS. */
1469 history_filename
= concat (current_directory
, "/_gdb_history",
1472 history_filename
= concat (current_directory
, "/.gdb_history",
1476 read_history (history_filename
);
1480 show_new_async_prompt (struct ui_file
*file
, int from_tty
,
1481 struct cmd_list_element
*c
, const char *value
)
1483 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1487 show_async_command_editing_p (struct ui_file
*file
, int from_tty
,
1488 struct cmd_list_element
*c
, const char *value
)
1490 fprintf_filtered (file
, _("\
1491 Editing of command lines as they are typed is %s.\n"),
1496 show_annotation_level (struct ui_file
*file
, int from_tty
,
1497 struct cmd_list_element
*c
, const char *value
)
1499 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
1503 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
1504 struct cmd_list_element
*c
, const char *value
)
1506 fprintf_filtered (file
, _("\
1507 Notification of completion for asynchronous execution commands is %s.\n"),
1513 struct cmd_list_element
*c
;
1515 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1516 whatever the DEFAULT_PROMPT is. */
1517 the_prompts
.top
= 0;
1519 PROMPT (0) = savestring (DEFAULT_PROMPT
, strlen (DEFAULT_PROMPT
));
1521 /* Set things up for annotation_level > 1, if the user ever decides
1523 async_annotation_suffix
= "prompt";
1524 /* Set the variable associated with the setshow prompt command. */
1525 new_async_prompt
= savestring (PROMPT (0), strlen (PROMPT (0)));
1527 /* If gdb was started with --annotate=2, this is equivalent to the
1528 user entering the command 'set annotate 2' at the gdb prompt, so
1529 we need to do extra processing. */
1530 if (annotation_level
> 1)
1531 set_async_annotation_level (NULL
, 0, NULL
);
1533 /* Set the important stuff up for command editing. */
1534 command_editing_p
= 1;
1535 history_expansion_p
= 0;
1536 write_history_p
= 0;
1538 /* Setup important stuff for command line editing. */
1539 rl_completion_entry_function
= readline_line_completion_function
;
1540 rl_completer_word_break_characters
= default_word_break_characters ();
1541 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
1542 rl_readline_name
= "gdb";
1543 rl_terminal_name
= getenv ("TERM");
1545 /* The name for this defun comes from Bash, where it originated.
1546 15 is Control-o, the same binding this function has in Bash. */
1547 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
1549 add_setshow_string_cmd ("prompt", class_support
,
1550 &new_async_prompt
, _("\
1551 Set gdb's prompt"), _("\
1552 Show gdb's prompt"), NULL
,
1554 show_new_async_prompt
,
1555 &setlist
, &showlist
);
1557 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
1558 Don't repeat this command.\n\
1559 Primarily used inside of user-defined commands that should not be repeated when\n\
1562 add_setshow_boolean_cmd ("editing", class_support
,
1563 &async_command_editing_p
, _("\
1564 Set editing of command lines as they are typed."), _("\
1565 Show editing of command lines as they are typed."), _("\
1566 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1567 Without an argument, command line editing is enabled. To edit, use\n\
1568 EMACS-like or VI-like commands like control-P or ESC."),
1569 set_async_editing_command
,
1570 show_async_command_editing_p
,
1571 &setlist
, &showlist
);
1573 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
1574 Set saving of the history record on exit."), _("\
1575 Show saving of the history record on exit."), _("\
1576 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1577 Without an argument, saving is enabled."),
1579 show_write_history_p
,
1580 &sethistlist
, &showhistlist
);
1582 add_setshow_integer_cmd ("size", no_class
, &history_size
, _("\
1583 Set the size of the command history,"), _("\
1584 Show the size of the command history,"), _("\
1585 ie. the number of previous commands to keep a record of."),
1586 set_history_size_command
,
1588 &sethistlist
, &showhistlist
);
1590 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
1591 Set the filename in which to record the command history"), _("\
1592 Show the filename in which to record the command history"), _("\
1593 (the list of previous commands of which a record is kept)."),
1595 show_history_filename
,
1596 &sethistlist
, &showhistlist
);
1598 add_setshow_boolean_cmd ("confirm", class_support
, &caution
, _("\
1599 Set whether to confirm potentially dangerous operations."), _("\
1600 Show whether to confirm potentially dangerous operations."), NULL
,
1603 &setlist
, &showlist
);
1605 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
1606 Set annotation_level."), _("\
1607 Show annotation_level."), _("\
1608 0 == normal; 1 == fullname (for use when running under emacs)\n\
1609 2 == output annotated suitably for use by programs that control GDB."),
1610 set_async_annotation_level
,
1611 show_annotation_level
,
1612 &setlist
, &showlist
);
1614 add_setshow_boolean_cmd ("exec-done-display", class_support
,
1615 &exec_done_display_p
, _("\
1616 Set notification of completion for asynchronous execution commands."), _("\
1617 Show notification of completion for asynchronous execution commands."), _("\
1618 Use \"on\" to enable the notification, and \"off\" to disable it."),
1620 show_exec_done_display_p
,
1621 &setlist
, &showlist
);
1625 gdb_init (char *argv0
)
1627 if (pre_init_ui_hook
)
1628 pre_init_ui_hook ();
1630 /* Run the init function of each source file */
1632 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
1633 current_directory
= gdb_dirbuf
;
1636 /* Make sure we return to the original directory upon exit, come
1637 what may, since the OS doesn't do that for us. */
1638 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
1641 init_cmd_lists (); /* This needs to be done first */
1642 initialize_targets (); /* Setup target_terminal macros for utils.c */
1643 initialize_utils (); /* Make errors and warnings possible */
1644 initialize_all_files ();
1645 initialize_current_architecture ();
1647 init_main (); /* But that omits this file! Do it now */
1649 initialize_stdin_serial ();
1651 async_init_signals ();
1653 /* We need a default language for parsing expressions, so simple things like
1654 "set width 0" won't fail if no language is explicitly set in a config file
1655 or implicitly set by reading an executable during startup. */
1656 set_language (language_c
);
1657 expected_language
= current_language
; /* don't warn about the change. */
1659 /* Allow another UI to initialize. If the UI fails to initialize,
1660 and it wants GDB to revert to the CLI, it should clear
1661 deprecated_init_ui_hook. */
1662 if (deprecated_init_ui_hook
)
1663 deprecated_init_ui_hook (argv0
);