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 /* Do any commands attached to breakpoint we stopped at. Only if we
368 are always running synchronously. Or if we have just executed a
369 command that doesn't start the target. */
371 command_line_handler_continuation (struct continuation_arg
*arg
)
373 extern int display_time
;
374 extern int display_space
;
376 long time_at_cmd_start
= arg
->data
.longint
;
377 long space_at_cmd_start
= arg
->next
->data
.longint
;
379 bpstat_do_actions (&stop_bpstat
);
383 long cmd_time
= get_run_time () - time_at_cmd_start
;
385 printf_unfiltered (_("Command execution time: %ld.%06ld\n"),
386 cmd_time
/ 1000000, cmd_time
% 1000000);
391 char *lim
= (char *) sbrk (0);
392 long space_now
= lim
- lim_at_start
;
393 long space_diff
= space_now
- space_at_cmd_start
;
395 printf_unfiltered (_("Space used: %ld (%c%ld for this command)\n"),
397 (space_diff
>= 0 ? '+' : '-'),
403 /* Execute the line P as a command.
404 Pass FROM_TTY as second argument to the defining function. */
407 execute_command (char *p
, int from_tty
)
409 struct cmd_list_element
*c
;
411 static int warned
= 0;
413 struct continuation_arg
*arg1
;
414 struct continuation_arg
*arg2
;
415 long time_at_cmd_start
;
417 long space_at_cmd_start
= 0;
419 extern int display_time
;
420 extern int display_space
;
422 if (target_can_async_p ())
424 time_at_cmd_start
= get_run_time ();
429 char *lim
= (char *) sbrk (0);
430 space_at_cmd_start
= lim
- lim_at_start
;
437 /* Force cleanup of any alloca areas if using C alloca instead of
441 /* This can happen when command_line_input hits end of file. */
445 target_log_command (p
);
447 while (*p
== ' ' || *p
== '\t')
454 /* If trace-commands is set then this will print this command. */
455 print_command_trace (p
);
457 c
= lookup_cmd (&p
, cmdlist
, "", 0, 1);
459 /* If the target is running, we allow only a limited set of
461 if (target_can_async_p () && target_executing
)
462 if (strcmp (c
->name
, "help") != 0
463 && strcmp (c
->name
, "pwd") != 0
464 && strcmp (c
->name
, "show") != 0
465 && strcmp (c
->name
, "info") != 0
466 && strcmp (c
->name
, "interrupt") != 0)
467 error (_("Cannot execute this command while the target is running."));
469 /* Pass null arg rather than an empty one. */
472 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
473 while the is_complete_command(cfunc) test is just plain
474 bogus. They should both be replaced by a test of the form
475 c->strip_trailing_white_space_p. */
476 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
477 can't be replaced with func. This is because it is the
478 cfunc, and not the func, that has the value that the
479 is_complete_command hack is testing for. */
480 /* Clear off trailing whitespace, except for set and complete
483 && c
->type
!= set_cmd
484 && !is_complete_command (c
))
486 p
= arg
+ strlen (arg
) - 1;
487 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
492 /* If this command has been pre-hooked, run the hook first. */
493 execute_cmd_pre_hook (c
);
495 if (c
->flags
& DEPRECATED_WARN_USER
)
496 deprecated_cmd_warning (&line
);
498 if (c
->class == class_user
)
499 execute_user_command (c
, arg
);
500 else if (c
->type
== set_cmd
|| c
->type
== show_cmd
)
501 do_setshow_command (arg
, from_tty
& caution
, c
);
502 else if (!cmd_func_p (c
))
503 error (_("That is not a command, just a help topic."));
504 else if (deprecated_call_command_hook
)
505 deprecated_call_command_hook (c
, arg
, from_tty
& caution
);
507 cmd_func (c
, arg
, from_tty
& caution
);
509 /* If this command has been post-hooked, run the hook last. */
510 execute_cmd_post_hook (c
);
514 /* Tell the user if the language has changed (except first time). */
515 if (current_language
!= expected_language
)
517 if (language_mode
== language_mode_auto
)
519 language_info (1); /* Print what changed. */
524 /* Warn the user if the working language does not match the
525 language of the current frame. Only warn the user if we are
526 actually running the program, i.e. there is a stack. */
527 /* FIXME: This should be cacheing the frame and only running when
528 the frame changes. */
530 if (!target_executing
&& target_has_stack
)
532 flang
= get_frame_language ();
534 && flang
!= language_unknown
535 && flang
!= current_language
->la_language
)
537 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
542 /* Set things up for this function to be compete later, once the
543 execution has completed, if we are doing an execution command,
544 otherwise, just go ahead and finish. */
545 if (target_can_async_p () && target_executing
)
548 (struct continuation_arg
*) xmalloc (sizeof (struct continuation_arg
));
550 (struct continuation_arg
*) xmalloc (sizeof (struct continuation_arg
));
553 arg1
->data
.longint
= time_at_cmd_start
;
555 arg2
->data
.longint
= space_at_cmd_start
;
557 add_continuation (command_line_handler_continuation
, arg1
);
561 /* Read commands from `instream' and execute them
562 until end of file or error reading instream. */
567 struct cleanup
*old_chain
;
569 int stdin_is_tty
= ISATTY (stdin
);
570 long time_at_cmd_start
;
572 long space_at_cmd_start
= 0;
574 extern int display_time
;
575 extern int display_space
;
577 while (instream
&& !feof (instream
))
579 if (window_hook
&& instream
== stdin
)
580 (*window_hook
) (instream
, get_prompt ());
583 if (instream
== stdin
&& stdin_is_tty
)
584 reinitialize_more_filter ();
585 old_chain
= make_cleanup (null_cleanup
, 0);
587 /* Get a command-line. This calls the readline package. */
588 command
= command_line_input (instream
== stdin
?
589 get_prompt () : (char *) NULL
,
590 instream
== stdin
, "prompt");
594 time_at_cmd_start
= get_run_time ();
599 char *lim
= (char *) sbrk (0);
600 space_at_cmd_start
= lim
- lim_at_start
;
604 execute_command (command
, instream
== stdin
);
605 /* Do any commands attached to breakpoint we stopped at. */
606 bpstat_do_actions (&stop_bpstat
);
607 do_cleanups (old_chain
);
611 long cmd_time
= get_run_time () - time_at_cmd_start
;
613 printf_unfiltered (_("Command execution time: %ld.%06ld\n"),
614 cmd_time
/ 1000000, cmd_time
% 1000000);
620 char *lim
= (char *) sbrk (0);
621 long space_now
= lim
- lim_at_start
;
622 long space_diff
= space_now
- space_at_cmd_start
;
624 printf_unfiltered (_("Space used: %ld (%s%ld for this command)\n"),
626 (space_diff
>= 0 ? "+" : ""),
633 /* Commands call this if they do not want to be repeated by null lines. */
641 /* If we aren't reading from standard input, we are saving the last
642 thing read from stdin in line and don't want to delete it. Null lines
643 won't repeat here in any case. */
644 if (instream
== stdin
)
648 /* Read a line from the stream "instream" without command line editing.
650 It prints PROMPT_ARG once at the start.
651 Action is compatible with "readline", e.g. space for the result is
652 malloc'd and should be freed by the caller.
654 A NULL return means end of file. */
656 gdb_readline (char *prompt_arg
)
661 int result_size
= 80;
665 /* Don't use a _filtered function here. It causes the assumed
666 character position to be off, since the newline we read from
667 the user is not accounted for. */
668 fputs_unfiltered (prompt_arg
, gdb_stdout
);
669 gdb_flush (gdb_stdout
);
672 result
= (char *) xmalloc (result_size
);
676 /* Read from stdin if we are executing a user defined command.
677 This is the right thing for prompt_for_continue, at least. */
678 c
= fgetc (instream
? instream
: stdin
);
683 /* The last line does not end with a newline. Return it, and
684 if we are called again fgetc will still return EOF and
685 we'll return NULL then. */
693 if (input_index
> 0 && result
[input_index
- 1] == '\r')
698 result
[input_index
++] = c
;
699 while (input_index
>= result_size
)
702 result
= (char *) xrealloc (result
, result_size
);
706 result
[input_index
++] = '\0';
710 /* Variables which control command line editing and history
711 substitution. These variables are given default values at the end
713 static int command_editing_p
;
715 /* NOTE 1999-04-29: This variable will be static again, once we modify
716 gdb to use the event loop as the default command loop and we merge
717 event-top.c into this file, top.c */
719 /* static */ int history_expansion_p
;
721 static int write_history_p
;
723 show_write_history_p (struct ui_file
*file
, int from_tty
,
724 struct cmd_list_element
*c
, const char *value
)
726 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
730 static int history_size
;
732 show_history_size (struct ui_file
*file
, int from_tty
,
733 struct cmd_list_element
*c
, const char *value
)
735 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
739 static char *history_filename
;
741 show_history_filename (struct ui_file
*file
, int from_tty
,
742 struct cmd_list_element
*c
, const char *value
)
744 fprintf_filtered (file
, _("\
745 The filename in which to record the command history is \"%s\".\n"),
749 /* This is like readline(), but it has some gdb-specific behavior.
750 gdb may want readline in both the synchronous and async modes during
751 a single gdb invocation. At the ordinary top-level prompt we might
752 be using the async readline. That means we can't use
753 rl_pre_input_hook, since it doesn't work properly in async mode.
754 However, for a secondary prompt (" >", such as occurs during a
755 `define'), gdb wants a synchronous response.
757 We used to call readline() directly, running it in synchronous
758 mode. But mixing modes this way is not supported, and as of
759 readline 5.x it no longer works; the arrow keys come unbound during
760 the synchronous call. So we make a nested call into the event
761 loop. That's what gdb_readline_wrapper is for. */
763 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
764 rely on gdb_readline_wrapper_result, which might still be NULL if
765 the user types Control-D for EOF. */
766 static int gdb_readline_wrapper_done
;
768 /* The result of the current call to gdb_readline_wrapper, once a newline
770 static char *gdb_readline_wrapper_result
;
772 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
773 to be called after the newline is processed (which will redisplay
774 the prompt). But in gdb_readline_wrapper we will not get a new
775 prompt until the next call, or until we return to the event loop.
776 So we disable this hook around the newline and restore it before we
778 static void (*saved_after_char_processing_hook
) (void);
780 /* This function is called when readline has seen a complete line of
784 gdb_readline_wrapper_line (char *line
)
786 gdb_assert (!gdb_readline_wrapper_done
);
787 gdb_readline_wrapper_result
= line
;
788 gdb_readline_wrapper_done
= 1;
790 /* Prevent operate-and-get-next from acting too early. */
791 saved_after_char_processing_hook
= after_char_processing_hook
;
792 after_char_processing_hook
= NULL
;
794 /* Prevent parts of the prompt from being redisplayed if annotations
795 are enabled, and readline's state getting out of sync. */
796 if (async_command_editing_p
)
797 rl_callback_handler_remove ();
800 struct gdb_readline_wrapper_cleanup
802 void (*handler_orig
) (char *);
803 int already_prompted_orig
;
807 gdb_readline_wrapper_cleanup (void *arg
)
809 struct gdb_readline_wrapper_cleanup
*cleanup
= arg
;
811 rl_already_prompted
= cleanup
->already_prompted_orig
;
813 gdb_assert (input_handler
== gdb_readline_wrapper_line
);
814 input_handler
= cleanup
->handler_orig
;
815 gdb_readline_wrapper_result
= NULL
;
816 gdb_readline_wrapper_done
= 0;
818 after_char_processing_hook
= saved_after_char_processing_hook
;
819 saved_after_char_processing_hook
= NULL
;
825 gdb_readline_wrapper (char *prompt
)
827 struct cleanup
*back_to
;
828 struct gdb_readline_wrapper_cleanup
*cleanup
;
831 cleanup
= xmalloc (sizeof (*cleanup
));
832 cleanup
->handler_orig
= input_handler
;
833 input_handler
= gdb_readline_wrapper_line
;
835 cleanup
->already_prompted_orig
= rl_already_prompted
;
837 back_to
= make_cleanup (gdb_readline_wrapper_cleanup
, cleanup
);
839 /* Display our prompt and prevent double prompt display. */
840 display_gdb_prompt (prompt
);
841 rl_already_prompted
= 1;
843 if (after_char_processing_hook
)
844 (*after_char_processing_hook
) ();
845 gdb_assert (after_char_processing_hook
== NULL
);
847 /* gdb_do_one_event argument is unused. */
848 while (gdb_do_one_event (NULL
) >= 0)
849 if (gdb_readline_wrapper_done
)
852 retval
= gdb_readline_wrapper_result
;
853 do_cleanups (back_to
);
862 #if STOP_SIGNAL == SIGTSTP
863 signal (SIGTSTP
, SIG_DFL
);
869 sigprocmask (SIG_SETMASK
, &zero
, 0);
871 #elif HAVE_SIGSETMASK
874 kill (getpid (), SIGTSTP
);
875 signal (SIGTSTP
, stop_sig
);
877 signal (STOP_SIGNAL
, stop_sig
);
879 printf_unfiltered ("%s", get_prompt ());
880 gdb_flush (gdb_stdout
);
882 /* Forget about any previous command -- null line now will do nothing. */
885 #endif /* STOP_SIGNAL */
887 /* Initialize signal handlers. */
889 float_handler (int signo
)
891 /* This message is based on ANSI C, section 4.7. Note that integer
892 divide by zero causes this, so "float" is a misnomer. */
893 signal (SIGFPE
, float_handler
);
894 error (_("Erroneous arithmetic operation."));
898 do_nothing (int signo
)
900 /* Under System V the default disposition of a signal is reinstated after
901 the signal is caught and delivered to an application process. On such
902 systems one must restore the replacement signal handler if one wishes
903 to continue handling the signal in one's program. On BSD systems this
904 is not needed but it is harmless, and it simplifies the code to just do
905 it unconditionally. */
906 signal (signo
, do_nothing
);
909 /* The current saved history number from operate-and-get-next.
910 This is -1 if not valid. */
911 static int operate_saved_history
= -1;
913 /* This is put on the appropriate hook and helps operate-and-get-next
916 gdb_rl_operate_and_get_next_completion (void)
918 int delta
= where_history () - operate_saved_history
;
919 /* The `key' argument to rl_get_previous_history is ignored. */
920 rl_get_previous_history (delta
, 0);
921 operate_saved_history
= -1;
923 /* readline doesn't automatically update the display for us. */
926 after_char_processing_hook
= NULL
;
927 rl_pre_input_hook
= NULL
;
930 /* This is a gdb-local readline command handler. It accepts the
931 current command line (like RET does) and, if this command was taken
932 from the history, arranges for the next command in the history to
933 appear on the command line when the prompt returns.
934 We ignore the arguments. */
936 gdb_rl_operate_and_get_next (int count
, int key
)
940 /* Use the async hook. */
941 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
943 /* Find the current line, and find the next line to use. */
944 where
= where_history();
946 /* FIXME: kettenis/20020817: max_input_history is renamed into
947 history_max_entries in readline-4.2. When we do a new readline
948 import, we should probably change it here too, even though
949 readline maintains backwards compatibility for now by still
950 defining max_input_history. */
951 if ((history_is_stifled () && (history_length
>= max_input_history
)) ||
952 (where
>= history_length
- 1))
953 operate_saved_history
= where
;
955 operate_saved_history
= where
+ 1;
957 return rl_newline (1, key
);
960 /* Read one line from the command input stream `instream'
961 into the local static buffer `linebuffer' (whose current length
963 The buffer is made bigger as necessary.
964 Returns the address of the start of the line.
966 NULL is returned for end of file.
968 *If* the instream == stdin & stdin is a terminal, the line read
969 is copied into the file line saver (global var char *line,
970 length linesize) so that it can be duplicated.
972 This routine either uses fancy command line editing or
973 simple input as the user has requested. */
976 command_line_input (char *prompt_arg
, int repeat
, char *annotation_suffix
)
978 static char *linebuffer
= 0;
979 static unsigned linelength
= 0;
983 char *local_prompt
= prompt_arg
;
987 /* The annotation suffix must be non-NULL. */
988 if (annotation_suffix
== NULL
)
989 annotation_suffix
= "";
991 if (annotation_level
> 1 && instream
== stdin
)
993 local_prompt
= alloca ((prompt_arg
== NULL
? 0 : strlen (prompt_arg
))
994 + strlen (annotation_suffix
) + 40);
995 if (prompt_arg
== NULL
)
996 local_prompt
[0] = '\0';
998 strcpy (local_prompt
, prompt_arg
);
999 strcat (local_prompt
, "\n\032\032");
1000 strcat (local_prompt
, annotation_suffix
);
1001 strcat (local_prompt
, "\n");
1004 if (linebuffer
== 0)
1007 linebuffer
= (char *) xmalloc (linelength
);
1012 /* Control-C quits instantly if typed while in this loop
1013 since it should not wait until the user types a newline. */
1017 signal (STOP_SIGNAL
, handle_stop_sig
);
1022 /* Make sure that all output has been output. Some machines may let
1023 you get away with leaving out some of the gdb_flush, but not all. */
1025 gdb_flush (gdb_stdout
);
1026 gdb_flush (gdb_stderr
);
1028 if (source_file_name
!= NULL
)
1029 ++source_line_number
;
1031 if (annotation_level
> 1 && instream
== stdin
)
1033 puts_unfiltered ("\n\032\032pre-");
1034 puts_unfiltered (annotation_suffix
);
1035 puts_unfiltered ("\n");
1038 /* Don't use fancy stuff if not talking to stdin. */
1039 if (deprecated_readline_hook
&& input_from_terminal_p ())
1041 rl
= (*deprecated_readline_hook
) (local_prompt
);
1043 else if (command_editing_p
&& input_from_terminal_p ())
1045 rl
= gdb_readline_wrapper (local_prompt
);
1049 rl
= gdb_readline (local_prompt
);
1052 if (annotation_level
> 1 && instream
== stdin
)
1054 puts_unfiltered ("\n\032\032post-");
1055 puts_unfiltered (annotation_suffix
);
1056 puts_unfiltered ("\n");
1059 if (!rl
|| rl
== (char *) EOF
)
1064 if (strlen (rl
) + 1 + (p
- linebuffer
) > linelength
)
1066 linelength
= strlen (rl
) + 1 + (p
- linebuffer
);
1067 nline
= (char *) xrealloc (linebuffer
, linelength
);
1068 p
+= nline
- linebuffer
;
1072 /* Copy line. Don't copy null at end. (Leaves line alone
1073 if this was just a newline) */
1077 xfree (rl
); /* Allocated in readline. */
1079 if (p
== linebuffer
|| *(p
- 1) != '\\')
1082 p
--; /* Put on top of '\'. */
1083 local_prompt
= (char *) 0;
1088 signal (STOP_SIGNAL
, SIG_DFL
);
1095 #define SERVER_COMMAND_LENGTH 7
1097 (p
- linebuffer
> SERVER_COMMAND_LENGTH
)
1098 && strncmp (linebuffer
, "server ", SERVER_COMMAND_LENGTH
) == 0;
1101 /* Note that we don't set `line'. Between this and the check in
1102 dont_repeat, this insures that repeating will still do the
1105 return linebuffer
+ SERVER_COMMAND_LENGTH
;
1108 /* Do history expansion if that is wished. */
1109 if (history_expansion_p
&& instream
== stdin
1110 && ISATTY (instream
))
1112 char *history_value
;
1115 *p
= '\0'; /* Insert null now. */
1116 expanded
= history_expand (linebuffer
, &history_value
);
1119 /* Print the changes. */
1120 printf_unfiltered ("%s\n", history_value
);
1122 /* If there was an error, call this function again. */
1125 xfree (history_value
);
1126 return command_line_input (prompt_arg
, repeat
, annotation_suffix
);
1128 if (strlen (history_value
) > linelength
)
1130 linelength
= strlen (history_value
) + 1;
1131 linebuffer
= (char *) xrealloc (linebuffer
, linelength
);
1133 strcpy (linebuffer
, history_value
);
1134 p
= linebuffer
+ strlen (linebuffer
);
1136 xfree (history_value
);
1139 /* If we just got an empty line, and that is supposed
1140 to repeat the previous command, return the value in the
1142 if (repeat
&& p
== linebuffer
)
1144 for (p1
= linebuffer
; *p1
== ' ' || *p1
== '\t'; p1
++);
1150 /* Add line to history if appropriate. */
1151 if (instream
== stdin
1152 && ISATTY (stdin
) && *linebuffer
)
1153 add_history (linebuffer
);
1155 /* Note: lines consisting solely of comments are added to the command
1156 history. This is useful when you type a command, and then
1157 realize you don't want to execute it quite yet. You can comment
1158 out the command and then later fetch it from the value history
1159 and remove the '#'. The kill ring is probably better, but some
1160 people are in the habit of commenting things out. */
1162 *p1
= '\0'; /* Found a comment. */
1164 /* Save into global buffer if appropriate. */
1167 if (linelength
> linesize
)
1169 line
= xrealloc (line
, linelength
);
1170 linesize
= linelength
;
1172 strcpy (line
, linebuffer
);
1179 /* Print the GDB banner. */
1181 print_gdb_version (struct ui_file
*stream
)
1183 /* From GNU coding standards, first line is meant to be easy for a
1184 program to parse, and is just canonical program name and version
1185 number, which starts after last space. */
1187 fprintf_filtered (stream
, "GNU gdb %s\n", version
);
1189 /* Second line is a copyright notice. */
1191 fprintf_filtered (stream
, "Copyright (C) 2008 Free Software Foundation, Inc.\n");
1193 /* Following the copyright is a brief statement that the program is
1194 free software, that users are free to copy and change it on
1195 certain conditions, that it is covered by the GNU GPL, and that
1196 there is no warranty. */
1198 fprintf_filtered (stream
, "\
1199 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n\
1200 This is free software: you are free to change and redistribute it.\n\
1201 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1202 and \"show warranty\" for details.\n");
1204 /* After the required info we print the configuration information. */
1206 fprintf_filtered (stream
, "This GDB was configured as \"");
1207 if (strcmp (host_name
, target_name
) != 0)
1209 fprintf_filtered (stream
, "--host=%s --target=%s", host_name
, target_name
);
1213 fprintf_filtered (stream
, "%s", host_name
);
1215 fprintf_filtered (stream
, "\".");
1218 /* get_prompt: access method for the GDB prompt string. */
1227 set_prompt (char *s
)
1229 /* ??rehrauer: I don't know why this fails, since it looks as though
1230 assignments to prompt are wrapped in calls to savestring...
1234 PROMPT (0) = savestring (s
, strlen (s
));
1238 /* If necessary, make the user confirm that we should quit. Return
1239 non-zero if we should quit, zero if we shouldn't. */
1244 if (! ptid_equal (inferior_ptid
, null_ptid
) && target_has_execution
)
1248 /* This is something of a hack. But there's no reliable way to
1249 see if a GUI is running. The `use_windows' variable doesn't
1251 if (deprecated_init_ui_hook
)
1252 s
= "A debugging session is active.\nDo you still want to close the debugger?";
1253 else if (attach_flag
)
1254 s
= "The program is running. Quit anyway (and detach it)? ";
1256 s
= "The program is running. Exit anyway? ";
1258 if (!query ("%s", s
))
1265 /* Helper routine for quit_force that requires error handling. */
1274 quit_target (void *arg
)
1276 struct qt_args
*qt
= (struct qt_args
*)arg
;
1278 if (! ptid_equal (inferior_ptid
, null_ptid
) && target_has_execution
)
1281 target_detach (qt
->args
, qt
->from_tty
);
1286 /* UDI wants this, to kill the TIP. */
1287 target_close (¤t_target
, 1);
1289 /* Save the history information if it is appropriate to do so. */
1290 if (write_history_p
&& history_filename
)
1291 write_history (history_filename
);
1293 do_final_cleanups (ALL_CLEANUPS
); /* Do any final cleanups before exiting */
1298 /* Quit without asking for confirmation. */
1301 quit_force (char *args
, int from_tty
)
1306 /* An optional expression may be used to cause gdb to terminate with the
1307 value of that expression. */
1310 struct value
*val
= parse_and_eval (args
);
1312 exit_code
= (int) value_as_long (val
);
1314 else if (return_child_result
)
1315 exit_code
= return_child_result_value
;
1318 qt
.from_tty
= from_tty
;
1320 /* We want to handle any quit errors and exit regardless. */
1321 catch_errors (quit_target
, &qt
,
1322 "Quitting: ", RETURN_MASK_ALL
);
1327 /* Returns whether GDB is running on a terminal and input is
1328 currently coming from that terminal. */
1331 input_from_terminal_p (void)
1333 if (gdb_has_a_terminal () && instream
== stdin
)
1336 /* If INSTREAM is unset, and we are not in a user command, we
1337 must be in Insight. That's like having a terminal, for our
1339 if (instream
== NULL
&& !in_user_command
)
1346 dont_repeat_command (char *ignored
, int from_tty
)
1348 *line
= 0; /* Can't call dont_repeat here because we're not
1349 necessarily reading from stdin. */
1352 /* Functions to manipulate command line editing control variables. */
1354 /* Number of commands to print in each call to show_commands. */
1355 #define Hist_print 10
1357 show_commands (char *args
, int from_tty
)
1359 /* Index for history commands. Relative to history_base. */
1362 /* Number of the history entry which we are planning to display next.
1363 Relative to history_base. */
1366 /* The first command in the history which doesn't exist (i.e. one more
1367 than the number of the last command). Relative to history_base. */
1370 /* Print out some of the commands from the command history. */
1371 /* First determine the length of the history list. */
1372 hist_len
= history_size
;
1373 for (offset
= 0; offset
< history_size
; offset
++)
1375 if (!history_get (history_base
+ offset
))
1384 if (args
[0] == '+' && args
[1] == '\0')
1385 /* "info editing +" should print from the stored position. */
1388 /* "info editing <exp>" should print around command number <exp>. */
1389 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1391 /* "show commands" means print the last Hist_print commands. */
1394 num
= hist_len
- Hist_print
;
1400 /* If there are at least Hist_print commands, we want to display the last
1401 Hist_print rather than, say, the last 6. */
1402 if (hist_len
- num
< Hist_print
)
1404 num
= hist_len
- Hist_print
;
1409 for (offset
= num
; offset
< num
+ Hist_print
&& offset
< hist_len
; offset
++)
1411 printf_filtered ("%5d %s\n", history_base
+ offset
,
1412 (history_get (history_base
+ offset
))->line
);
1415 /* The next command we want to display is the next one that we haven't
1419 /* If the user repeats this command with return, it should do what
1420 "show commands +" does. This is unnecessary if arg is null,
1421 because "show commands +" is not useful after "show commands". */
1422 if (from_tty
&& args
)
1429 /* Called by do_setshow_command. */
1431 set_history_size_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1433 if (history_size
== INT_MAX
)
1434 unstifle_history ();
1435 else if (history_size
>= 0)
1436 stifle_history (history_size
);
1439 history_size
= INT_MAX
;
1440 error (_("History size must be non-negative"));
1445 set_history (char *args
, int from_tty
)
1447 printf_unfiltered (_("\"set history\" must be followed by the name of a history subcommand.\n"));
1448 help_list (sethistlist
, "set history ", -1, gdb_stdout
);
1452 show_history (char *args
, int from_tty
)
1454 cmd_show_list (showhistlist
, from_tty
, "");
1457 int info_verbose
= 0; /* Default verbose msgs off */
1459 /* Called by do_setshow_command. An elaborate joke. */
1461 set_verbose (char *args
, int from_tty
, struct cmd_list_element
*c
)
1463 char *cmdname
= "verbose";
1464 struct cmd_list_element
*showcmd
;
1466 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1470 c
->doc
= "Set verbose printing of informational messages.";
1471 showcmd
->doc
= "Show verbose printing of informational messages.";
1475 c
->doc
= "Set verbosity.";
1476 showcmd
->doc
= "Show verbosity.";
1480 /* Init the history buffer. Note that we are called after the init file(s)
1481 * have been read so that the user can change the history file via his
1482 * .gdbinit file (for instance). The GDBHISTFILE environment variable
1483 * overrides all of this.
1491 tmpenv
= getenv ("HISTSIZE");
1493 history_size
= atoi (tmpenv
);
1494 else if (!history_size
)
1497 stifle_history (history_size
);
1499 tmpenv
= getenv ("GDBHISTFILE");
1501 history_filename
= savestring (tmpenv
, strlen (tmpenv
));
1502 else if (!history_filename
)
1504 /* We include the current directory so that if the user changes
1505 directories the file written will be the same as the one
1508 /* No leading dots in file names are allowed on MSDOS. */
1509 history_filename
= concat (current_directory
, "/_gdb_history",
1512 history_filename
= concat (current_directory
, "/.gdb_history",
1516 read_history (history_filename
);
1520 show_new_async_prompt (struct ui_file
*file
, int from_tty
,
1521 struct cmd_list_element
*c
, const char *value
)
1523 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1527 show_async_command_editing_p (struct ui_file
*file
, int from_tty
,
1528 struct cmd_list_element
*c
, const char *value
)
1530 fprintf_filtered (file
, _("\
1531 Editing of command lines as they are typed is %s.\n"),
1536 show_annotation_level (struct ui_file
*file
, int from_tty
,
1537 struct cmd_list_element
*c
, const char *value
)
1539 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
1543 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
1544 struct cmd_list_element
*c
, const char *value
)
1546 fprintf_filtered (file
, _("\
1547 Notification of completion for asynchronous execution commands is %s.\n"),
1553 struct cmd_list_element
*c
;
1555 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1556 whatever the DEFAULT_PROMPT is. */
1557 the_prompts
.top
= 0;
1559 PROMPT (0) = savestring (DEFAULT_PROMPT
, strlen (DEFAULT_PROMPT
));
1561 /* Set things up for annotation_level > 1, if the user ever decides
1563 async_annotation_suffix
= "prompt";
1564 /* Set the variable associated with the setshow prompt command. */
1565 new_async_prompt
= savestring (PROMPT (0), strlen (PROMPT (0)));
1567 /* If gdb was started with --annotate=2, this is equivalent to the
1568 user entering the command 'set annotate 2' at the gdb prompt, so
1569 we need to do extra processing. */
1570 if (annotation_level
> 1)
1571 set_async_annotation_level (NULL
, 0, NULL
);
1573 /* Set the important stuff up for command editing. */
1574 command_editing_p
= 1;
1575 history_expansion_p
= 0;
1576 write_history_p
= 0;
1578 /* Setup important stuff for command line editing. */
1579 rl_completion_entry_function
= readline_line_completion_function
;
1580 rl_completer_word_break_characters
= default_word_break_characters ();
1581 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
1582 rl_readline_name
= "gdb";
1583 rl_terminal_name
= getenv ("TERM");
1585 /* The name for this defun comes from Bash, where it originated.
1586 15 is Control-o, the same binding this function has in Bash. */
1587 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
1589 add_setshow_string_cmd ("prompt", class_support
,
1590 &new_async_prompt
, _("\
1591 Set gdb's prompt"), _("\
1592 Show gdb's prompt"), NULL
,
1594 show_new_async_prompt
,
1595 &setlist
, &showlist
);
1597 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
1598 Don't repeat this command.\n\
1599 Primarily used inside of user-defined commands that should not be repeated when\n\
1602 add_setshow_boolean_cmd ("editing", class_support
,
1603 &async_command_editing_p
, _("\
1604 Set editing of command lines as they are typed."), _("\
1605 Show editing of command lines as they are typed."), _("\
1606 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1607 Without an argument, command line editing is enabled. To edit, use\n\
1608 EMACS-like or VI-like commands like control-P or ESC."),
1609 set_async_editing_command
,
1610 show_async_command_editing_p
,
1611 &setlist
, &showlist
);
1613 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
1614 Set saving of the history record on exit."), _("\
1615 Show saving of the history record on exit."), _("\
1616 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1617 Without an argument, saving is enabled."),
1619 show_write_history_p
,
1620 &sethistlist
, &showhistlist
);
1622 add_setshow_integer_cmd ("size", no_class
, &history_size
, _("\
1623 Set the size of the command history,"), _("\
1624 Show the size of the command history,"), _("\
1625 ie. the number of previous commands to keep a record of."),
1626 set_history_size_command
,
1628 &sethistlist
, &showhistlist
);
1630 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
1631 Set the filename in which to record the command history"), _("\
1632 Show the filename in which to record the command history"), _("\
1633 (the list of previous commands of which a record is kept)."),
1635 show_history_filename
,
1636 &sethistlist
, &showhistlist
);
1638 add_setshow_boolean_cmd ("confirm", class_support
, &caution
, _("\
1639 Set whether to confirm potentially dangerous operations."), _("\
1640 Show whether to confirm potentially dangerous operations."), NULL
,
1643 &setlist
, &showlist
);
1645 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
1646 Set annotation_level."), _("\
1647 Show annotation_level."), _("\
1648 0 == normal; 1 == fullname (for use when running under emacs)\n\
1649 2 == output annotated suitably for use by programs that control GDB."),
1650 set_async_annotation_level
,
1651 show_annotation_level
,
1652 &setlist
, &showlist
);
1654 add_setshow_boolean_cmd ("exec-done-display", class_support
,
1655 &exec_done_display_p
, _("\
1656 Set notification of completion for asynchronous execution commands."), _("\
1657 Show notification of completion for asynchronous execution commands."), _("\
1658 Use \"on\" to enable the notification, and \"off\" to disable it."),
1660 show_exec_done_display_p
,
1661 &setlist
, &showlist
);
1665 gdb_init (char *argv0
)
1667 if (pre_init_ui_hook
)
1668 pre_init_ui_hook ();
1670 /* Run the init function of each source file */
1672 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
1673 current_directory
= gdb_dirbuf
;
1676 /* Make sure we return to the original directory upon exit, come
1677 what may, since the OS doesn't do that for us. */
1678 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
1681 init_cmd_lists (); /* This needs to be done first */
1682 initialize_targets (); /* Setup target_terminal macros for utils.c */
1683 initialize_utils (); /* Make errors and warnings possible */
1684 initialize_all_files ();
1685 initialize_current_architecture ();
1687 init_main (); /* But that omits this file! Do it now */
1689 initialize_stdin_serial ();
1691 async_init_signals ();
1693 /* We need a default language for parsing expressions, so simple things like
1694 "set width 0" won't fail if no language is explicitly set in a config file
1695 or implicitly set by reading an executable during startup. */
1696 set_language (language_c
);
1697 expected_language
= current_language
; /* don't warn about the change. */
1699 /* Allow another UI to initialize. If the UI fails to initialize,
1700 and it wants GDB to revert to the CLI, it should clear
1701 deprecated_init_ui_hook. */
1702 if (deprecated_init_ui_hook
)
1703 deprecated_init_ui_hook (argv0
);