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
= 0;
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
&& !get_cmd_async_ok (c
))
462 error (_("Cannot execute this command while the target is running."));
464 /* Pass null arg rather than an empty one. */
467 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
468 while the is_complete_command(cfunc) test is just plain
469 bogus. They should both be replaced by a test of the form
470 c->strip_trailing_white_space_p. */
471 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
472 can't be replaced with func. This is because it is the
473 cfunc, and not the func, that has the value that the
474 is_complete_command hack is testing for. */
475 /* Clear off trailing whitespace, except for set and complete
478 && c
->type
!= set_cmd
479 && !is_complete_command (c
))
481 p
= arg
+ strlen (arg
) - 1;
482 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
487 /* If this command has been pre-hooked, run the hook first. */
488 execute_cmd_pre_hook (c
);
490 if (c
->flags
& DEPRECATED_WARN_USER
)
491 deprecated_cmd_warning (&line
);
493 if (c
->class == class_user
)
494 execute_user_command (c
, arg
);
495 else if (c
->type
== set_cmd
|| c
->type
== show_cmd
)
496 do_setshow_command (arg
, from_tty
& caution
, c
);
497 else if (!cmd_func_p (c
))
498 error (_("That is not a command, just a help topic."));
499 else if (deprecated_call_command_hook
)
500 deprecated_call_command_hook (c
, arg
, from_tty
& caution
);
502 cmd_func (c
, arg
, from_tty
& caution
);
504 /* If this command has been post-hooked, run the hook last. */
505 execute_cmd_post_hook (c
);
509 /* Tell the user if the language has changed (except first time). */
510 if (current_language
!= expected_language
)
512 if (language_mode
== language_mode_auto
)
514 language_info (1); /* Print what changed. */
519 /* Warn the user if the working language does not match the
520 language of the current frame. Only warn the user if we are
521 actually running the program, i.e. there is a stack. */
522 /* FIXME: This should be cacheing the frame and only running when
523 the frame changes. */
525 if (!target_executing
&& target_has_stack
)
527 flang
= get_frame_language ();
529 && flang
!= language_unknown
530 && flang
!= current_language
->la_language
)
532 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
537 /* Set things up for this function to be compete later, once the
538 execution has completed, if we are doing an execution command,
539 otherwise, just go ahead and finish. */
540 if (target_can_async_p () && target_executing
)
543 (struct continuation_arg
*) xmalloc (sizeof (struct continuation_arg
));
545 (struct continuation_arg
*) xmalloc (sizeof (struct continuation_arg
));
548 arg1
->data
.longint
= time_at_cmd_start
;
550 arg2
->data
.longint
= space_at_cmd_start
;
552 add_continuation (command_line_handler_continuation
, arg1
);
556 /* Read commands from `instream' and execute them
557 until end of file or error reading instream. */
562 struct cleanup
*old_chain
;
564 int stdin_is_tty
= ISATTY (stdin
);
565 long time_at_cmd_start
;
567 long space_at_cmd_start
= 0;
569 extern int display_time
;
570 extern int display_space
;
572 while (instream
&& !feof (instream
))
574 if (window_hook
&& instream
== stdin
)
575 (*window_hook
) (instream
, get_prompt ());
578 if (instream
== stdin
&& stdin_is_tty
)
579 reinitialize_more_filter ();
580 old_chain
= make_cleanup (null_cleanup
, 0);
582 /* Get a command-line. This calls the readline package. */
583 command
= command_line_input (instream
== stdin
?
584 get_prompt () : (char *) NULL
,
585 instream
== stdin
, "prompt");
589 time_at_cmd_start
= get_run_time ();
594 char *lim
= (char *) sbrk (0);
595 space_at_cmd_start
= lim
- lim_at_start
;
599 execute_command (command
, instream
== stdin
);
600 /* Do any commands attached to breakpoint we stopped at. */
601 bpstat_do_actions (&stop_bpstat
);
602 do_cleanups (old_chain
);
606 long cmd_time
= get_run_time () - time_at_cmd_start
;
608 printf_unfiltered (_("Command execution time: %ld.%06ld\n"),
609 cmd_time
/ 1000000, cmd_time
% 1000000);
615 char *lim
= (char *) sbrk (0);
616 long space_now
= lim
- lim_at_start
;
617 long space_diff
= space_now
- space_at_cmd_start
;
619 printf_unfiltered (_("Space used: %ld (%s%ld for this command)\n"),
621 (space_diff
>= 0 ? "+" : ""),
628 /* Commands call this if they do not want to be repeated by null lines. */
636 /* If we aren't reading from standard input, we are saving the last
637 thing read from stdin in line and don't want to delete it. Null lines
638 won't repeat here in any case. */
639 if (instream
== stdin
)
643 /* Read a line from the stream "instream" without command line editing.
645 It prints PROMPT_ARG once at the start.
646 Action is compatible with "readline", e.g. space for the result is
647 malloc'd and should be freed by the caller.
649 A NULL return means end of file. */
651 gdb_readline (char *prompt_arg
)
656 int result_size
= 80;
660 /* Don't use a _filtered function here. It causes the assumed
661 character position to be off, since the newline we read from
662 the user is not accounted for. */
663 fputs_unfiltered (prompt_arg
, gdb_stdout
);
664 gdb_flush (gdb_stdout
);
667 result
= (char *) xmalloc (result_size
);
671 /* Read from stdin if we are executing a user defined command.
672 This is the right thing for prompt_for_continue, at least. */
673 c
= fgetc (instream
? instream
: stdin
);
678 /* The last line does not end with a newline. Return it, and
679 if we are called again fgetc will still return EOF and
680 we'll return NULL then. */
688 if (input_index
> 0 && result
[input_index
- 1] == '\r')
693 result
[input_index
++] = c
;
694 while (input_index
>= result_size
)
697 result
= (char *) xrealloc (result
, result_size
);
701 result
[input_index
++] = '\0';
705 /* Variables which control command line editing and history
706 substitution. These variables are given default values at the end
708 static int command_editing_p
;
710 /* NOTE 1999-04-29: This variable will be static again, once we modify
711 gdb to use the event loop as the default command loop and we merge
712 event-top.c into this file, top.c */
714 /* static */ int history_expansion_p
;
716 static int write_history_p
;
718 show_write_history_p (struct ui_file
*file
, int from_tty
,
719 struct cmd_list_element
*c
, const char *value
)
721 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
725 static int history_size
;
727 show_history_size (struct ui_file
*file
, int from_tty
,
728 struct cmd_list_element
*c
, const char *value
)
730 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
734 static char *history_filename
;
736 show_history_filename (struct ui_file
*file
, int from_tty
,
737 struct cmd_list_element
*c
, const char *value
)
739 fprintf_filtered (file
, _("\
740 The filename in which to record the command history is \"%s\".\n"),
744 /* This is like readline(), but it has some gdb-specific behavior.
745 gdb may want readline in both the synchronous and async modes during
746 a single gdb invocation. At the ordinary top-level prompt we might
747 be using the async readline. That means we can't use
748 rl_pre_input_hook, since it doesn't work properly in async mode.
749 However, for a secondary prompt (" >", such as occurs during a
750 `define'), gdb wants a synchronous response.
752 We used to call readline() directly, running it in synchronous
753 mode. But mixing modes this way is not supported, and as of
754 readline 5.x it no longer works; the arrow keys come unbound during
755 the synchronous call. So we make a nested call into the event
756 loop. That's what gdb_readline_wrapper is for. */
758 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
759 rely on gdb_readline_wrapper_result, which might still be NULL if
760 the user types Control-D for EOF. */
761 static int gdb_readline_wrapper_done
;
763 /* The result of the current call to gdb_readline_wrapper, once a newline
765 static char *gdb_readline_wrapper_result
;
767 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
768 to be called after the newline is processed (which will redisplay
769 the prompt). But in gdb_readline_wrapper we will not get a new
770 prompt until the next call, or until we return to the event loop.
771 So we disable this hook around the newline and restore it before we
773 static void (*saved_after_char_processing_hook
) (void);
775 /* This function is called when readline has seen a complete line of
779 gdb_readline_wrapper_line (char *line
)
781 gdb_assert (!gdb_readline_wrapper_done
);
782 gdb_readline_wrapper_result
= line
;
783 gdb_readline_wrapper_done
= 1;
785 /* Prevent operate-and-get-next from acting too early. */
786 saved_after_char_processing_hook
= after_char_processing_hook
;
787 after_char_processing_hook
= NULL
;
789 /* Prevent parts of the prompt from being redisplayed if annotations
790 are enabled, and readline's state getting out of sync. */
791 if (async_command_editing_p
)
792 rl_callback_handler_remove ();
795 struct gdb_readline_wrapper_cleanup
797 void (*handler_orig
) (char *);
798 int already_prompted_orig
;
802 gdb_readline_wrapper_cleanup (void *arg
)
804 struct gdb_readline_wrapper_cleanup
*cleanup
= arg
;
806 rl_already_prompted
= cleanup
->already_prompted_orig
;
808 gdb_assert (input_handler
== gdb_readline_wrapper_line
);
809 input_handler
= cleanup
->handler_orig
;
810 gdb_readline_wrapper_result
= NULL
;
811 gdb_readline_wrapper_done
= 0;
813 after_char_processing_hook
= saved_after_char_processing_hook
;
814 saved_after_char_processing_hook
= NULL
;
820 gdb_readline_wrapper (char *prompt
)
822 struct cleanup
*back_to
;
823 struct gdb_readline_wrapper_cleanup
*cleanup
;
826 cleanup
= xmalloc (sizeof (*cleanup
));
827 cleanup
->handler_orig
= input_handler
;
828 input_handler
= gdb_readline_wrapper_line
;
830 cleanup
->already_prompted_orig
= rl_already_prompted
;
832 back_to
= make_cleanup (gdb_readline_wrapper_cleanup
, cleanup
);
834 /* Display our prompt and prevent double prompt display. */
835 display_gdb_prompt (prompt
);
836 rl_already_prompted
= 1;
838 if (after_char_processing_hook
)
839 (*after_char_processing_hook
) ();
840 gdb_assert (after_char_processing_hook
== NULL
);
842 /* gdb_do_one_event argument is unused. */
843 while (gdb_do_one_event (NULL
) >= 0)
844 if (gdb_readline_wrapper_done
)
847 retval
= gdb_readline_wrapper_result
;
848 do_cleanups (back_to
);
857 #if STOP_SIGNAL == SIGTSTP
858 signal (SIGTSTP
, SIG_DFL
);
864 sigprocmask (SIG_SETMASK
, &zero
, 0);
866 #elif HAVE_SIGSETMASK
869 kill (getpid (), SIGTSTP
);
870 signal (SIGTSTP
, stop_sig
);
872 signal (STOP_SIGNAL
, stop_sig
);
874 printf_unfiltered ("%s", get_prompt ());
875 gdb_flush (gdb_stdout
);
877 /* Forget about any previous command -- null line now will do nothing. */
880 #endif /* STOP_SIGNAL */
882 /* Initialize signal handlers. */
884 float_handler (int signo
)
886 /* This message is based on ANSI C, section 4.7. Note that integer
887 divide by zero causes this, so "float" is a misnomer. */
888 signal (SIGFPE
, float_handler
);
889 error (_("Erroneous arithmetic operation."));
893 do_nothing (int signo
)
895 /* Under System V the default disposition of a signal is reinstated after
896 the signal is caught and delivered to an application process. On such
897 systems one must restore the replacement signal handler if one wishes
898 to continue handling the signal in one's program. On BSD systems this
899 is not needed but it is harmless, and it simplifies the code to just do
900 it unconditionally. */
901 signal (signo
, do_nothing
);
904 /* The current saved history number from operate-and-get-next.
905 This is -1 if not valid. */
906 static int operate_saved_history
= -1;
908 /* This is put on the appropriate hook and helps operate-and-get-next
911 gdb_rl_operate_and_get_next_completion (void)
913 int delta
= where_history () - operate_saved_history
;
914 /* The `key' argument to rl_get_previous_history is ignored. */
915 rl_get_previous_history (delta
, 0);
916 operate_saved_history
= -1;
918 /* readline doesn't automatically update the display for us. */
921 after_char_processing_hook
= NULL
;
922 rl_pre_input_hook
= NULL
;
925 /* This is a gdb-local readline command handler. It accepts the
926 current command line (like RET does) and, if this command was taken
927 from the history, arranges for the next command in the history to
928 appear on the command line when the prompt returns.
929 We ignore the arguments. */
931 gdb_rl_operate_and_get_next (int count
, int key
)
935 /* Use the async hook. */
936 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
938 /* Find the current line, and find the next line to use. */
939 where
= where_history();
941 /* FIXME: kettenis/20020817: max_input_history is renamed into
942 history_max_entries in readline-4.2. When we do a new readline
943 import, we should probably change it here too, even though
944 readline maintains backwards compatibility for now by still
945 defining max_input_history. */
946 if ((history_is_stifled () && (history_length
>= max_input_history
)) ||
947 (where
>= history_length
- 1))
948 operate_saved_history
= where
;
950 operate_saved_history
= where
+ 1;
952 return rl_newline (1, key
);
955 /* Read one line from the command input stream `instream'
956 into the local static buffer `linebuffer' (whose current length
958 The buffer is made bigger as necessary.
959 Returns the address of the start of the line.
961 NULL is returned for end of file.
963 *If* the instream == stdin & stdin is a terminal, the line read
964 is copied into the file line saver (global var char *line,
965 length linesize) so that it can be duplicated.
967 This routine either uses fancy command line editing or
968 simple input as the user has requested. */
971 command_line_input (char *prompt_arg
, int repeat
, char *annotation_suffix
)
973 static char *linebuffer
= 0;
974 static unsigned linelength
= 0;
978 char *local_prompt
= prompt_arg
;
982 /* The annotation suffix must be non-NULL. */
983 if (annotation_suffix
== NULL
)
984 annotation_suffix
= "";
986 if (annotation_level
> 1 && instream
== stdin
)
988 local_prompt
= alloca ((prompt_arg
== NULL
? 0 : strlen (prompt_arg
))
989 + strlen (annotation_suffix
) + 40);
990 if (prompt_arg
== NULL
)
991 local_prompt
[0] = '\0';
993 strcpy (local_prompt
, prompt_arg
);
994 strcat (local_prompt
, "\n\032\032");
995 strcat (local_prompt
, annotation_suffix
);
996 strcat (local_prompt
, "\n");
1002 linebuffer
= (char *) xmalloc (linelength
);
1007 /* Control-C quits instantly if typed while in this loop
1008 since it should not wait until the user types a newline. */
1012 signal (STOP_SIGNAL
, handle_stop_sig
);
1017 /* Make sure that all output has been output. Some machines may let
1018 you get away with leaving out some of the gdb_flush, but not all. */
1020 gdb_flush (gdb_stdout
);
1021 gdb_flush (gdb_stderr
);
1023 if (source_file_name
!= NULL
)
1024 ++source_line_number
;
1026 if (annotation_level
> 1 && instream
== stdin
)
1028 puts_unfiltered ("\n\032\032pre-");
1029 puts_unfiltered (annotation_suffix
);
1030 puts_unfiltered ("\n");
1033 /* Don't use fancy stuff if not talking to stdin. */
1034 if (deprecated_readline_hook
&& input_from_terminal_p ())
1036 rl
= (*deprecated_readline_hook
) (local_prompt
);
1038 else if (command_editing_p
&& input_from_terminal_p ())
1040 rl
= gdb_readline_wrapper (local_prompt
);
1044 rl
= gdb_readline (local_prompt
);
1047 if (annotation_level
> 1 && instream
== stdin
)
1049 puts_unfiltered ("\n\032\032post-");
1050 puts_unfiltered (annotation_suffix
);
1051 puts_unfiltered ("\n");
1054 if (!rl
|| rl
== (char *) EOF
)
1059 if (strlen (rl
) + 1 + (p
- linebuffer
) > linelength
)
1061 linelength
= strlen (rl
) + 1 + (p
- linebuffer
);
1062 nline
= (char *) xrealloc (linebuffer
, linelength
);
1063 p
+= nline
- linebuffer
;
1067 /* Copy line. Don't copy null at end. (Leaves line alone
1068 if this was just a newline) */
1072 xfree (rl
); /* Allocated in readline. */
1074 if (p
== linebuffer
|| *(p
- 1) != '\\')
1077 p
--; /* Put on top of '\'. */
1078 local_prompt
= (char *) 0;
1083 signal (STOP_SIGNAL
, SIG_DFL
);
1090 #define SERVER_COMMAND_LENGTH 7
1092 (p
- linebuffer
> SERVER_COMMAND_LENGTH
)
1093 && strncmp (linebuffer
, "server ", SERVER_COMMAND_LENGTH
) == 0;
1096 /* Note that we don't set `line'. Between this and the check in
1097 dont_repeat, this insures that repeating will still do the
1100 return linebuffer
+ SERVER_COMMAND_LENGTH
;
1103 /* Do history expansion if that is wished. */
1104 if (history_expansion_p
&& instream
== stdin
1105 && ISATTY (instream
))
1107 char *history_value
;
1110 *p
= '\0'; /* Insert null now. */
1111 expanded
= history_expand (linebuffer
, &history_value
);
1114 /* Print the changes. */
1115 printf_unfiltered ("%s\n", history_value
);
1117 /* If there was an error, call this function again. */
1120 xfree (history_value
);
1121 return command_line_input (prompt_arg
, repeat
, annotation_suffix
);
1123 if (strlen (history_value
) > linelength
)
1125 linelength
= strlen (history_value
) + 1;
1126 linebuffer
= (char *) xrealloc (linebuffer
, linelength
);
1128 strcpy (linebuffer
, history_value
);
1129 p
= linebuffer
+ strlen (linebuffer
);
1131 xfree (history_value
);
1134 /* If we just got an empty line, and that is supposed
1135 to repeat the previous command, return the value in the
1137 if (repeat
&& p
== linebuffer
)
1139 for (p1
= linebuffer
; *p1
== ' ' || *p1
== '\t'; p1
++);
1145 /* Add line to history if appropriate. */
1146 if (instream
== stdin
1147 && ISATTY (stdin
) && *linebuffer
)
1148 add_history (linebuffer
);
1150 /* Note: lines consisting solely of comments are added to the command
1151 history. This is useful when you type a command, and then
1152 realize you don't want to execute it quite yet. You can comment
1153 out the command and then later fetch it from the value history
1154 and remove the '#'. The kill ring is probably better, but some
1155 people are in the habit of commenting things out. */
1157 *p1
= '\0'; /* Found a comment. */
1159 /* Save into global buffer if appropriate. */
1162 if (linelength
> linesize
)
1164 line
= xrealloc (line
, linelength
);
1165 linesize
= linelength
;
1167 strcpy (line
, linebuffer
);
1174 /* Print the GDB banner. */
1176 print_gdb_version (struct ui_file
*stream
)
1178 /* From GNU coding standards, first line is meant to be easy for a
1179 program to parse, and is just canonical program name and version
1180 number, which starts after last space. */
1182 fprintf_filtered (stream
, "GNU gdb %s\n", version
);
1184 /* Second line is a copyright notice. */
1186 fprintf_filtered (stream
, "Copyright (C) 2008 Free Software Foundation, Inc.\n");
1188 /* Following the copyright is a brief statement that the program is
1189 free software, that users are free to copy and change it on
1190 certain conditions, that it is covered by the GNU GPL, and that
1191 there is no warranty. */
1193 fprintf_filtered (stream
, "\
1194 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n\
1195 This is free software: you are free to change and redistribute it.\n\
1196 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1197 and \"show warranty\" for details.\n");
1199 /* After the required info we print the configuration information. */
1201 fprintf_filtered (stream
, "This GDB was configured as \"");
1202 if (strcmp (host_name
, target_name
) != 0)
1204 fprintf_filtered (stream
, "--host=%s --target=%s", host_name
, target_name
);
1208 fprintf_filtered (stream
, "%s", host_name
);
1210 fprintf_filtered (stream
, "\".");
1213 /* get_prompt: access method for the GDB prompt string. */
1222 set_prompt (char *s
)
1224 /* ??rehrauer: I don't know why this fails, since it looks as though
1225 assignments to prompt are wrapped in calls to savestring...
1229 PROMPT (0) = savestring (s
, strlen (s
));
1233 /* If necessary, make the user confirm that we should quit. Return
1234 non-zero if we should quit, zero if we shouldn't. */
1239 if (! ptid_equal (inferior_ptid
, null_ptid
) && target_has_execution
)
1243 /* This is something of a hack. But there's no reliable way to
1244 see if a GUI is running. The `use_windows' variable doesn't
1246 if (deprecated_init_ui_hook
)
1247 s
= "A debugging session is active.\nDo you still want to close the debugger?";
1248 else if (attach_flag
)
1249 s
= "The program is running. Quit anyway (and detach it)? ";
1251 s
= "The program is running. Quit anyway (and kill it)? ";
1253 if (!query ("%s", s
))
1260 /* Helper routine for quit_force that requires error handling. */
1269 quit_target (void *arg
)
1271 struct qt_args
*qt
= (struct qt_args
*)arg
;
1273 if (! ptid_equal (inferior_ptid
, null_ptid
) && target_has_execution
)
1276 target_detach (qt
->args
, qt
->from_tty
);
1281 /* UDI wants this, to kill the TIP. */
1282 target_close (¤t_target
, 1);
1284 /* Save the history information if it is appropriate to do so. */
1285 if (write_history_p
&& history_filename
)
1286 write_history (history_filename
);
1288 do_final_cleanups (ALL_CLEANUPS
); /* Do any final cleanups before exiting */
1293 /* Quit without asking for confirmation. */
1296 quit_force (char *args
, int from_tty
)
1301 /* An optional expression may be used to cause gdb to terminate with the
1302 value of that expression. */
1305 struct value
*val
= parse_and_eval (args
);
1307 exit_code
= (int) value_as_long (val
);
1309 else if (return_child_result
)
1310 exit_code
= return_child_result_value
;
1313 qt
.from_tty
= from_tty
;
1315 /* We want to handle any quit errors and exit regardless. */
1316 catch_errors (quit_target
, &qt
,
1317 "Quitting: ", RETURN_MASK_ALL
);
1322 /* Returns whether GDB is running on a terminal and input is
1323 currently coming from that terminal. */
1326 input_from_terminal_p (void)
1328 if (gdb_has_a_terminal () && instream
== stdin
)
1331 /* If INSTREAM is unset, and we are not in a user command, we
1332 must be in Insight. That's like having a terminal, for our
1334 if (instream
== NULL
&& !in_user_command
)
1341 dont_repeat_command (char *ignored
, int from_tty
)
1343 *line
= 0; /* Can't call dont_repeat here because we're not
1344 necessarily reading from stdin. */
1347 /* Functions to manipulate command line editing control variables. */
1349 /* Number of commands to print in each call to show_commands. */
1350 #define Hist_print 10
1352 show_commands (char *args
, int from_tty
)
1354 /* Index for history commands. Relative to history_base. */
1357 /* Number of the history entry which we are planning to display next.
1358 Relative to history_base. */
1361 /* The first command in the history which doesn't exist (i.e. one more
1362 than the number of the last command). Relative to history_base. */
1365 /* Print out some of the commands from the command history. */
1366 /* First determine the length of the history list. */
1367 hist_len
= history_size
;
1368 for (offset
= 0; offset
< history_size
; offset
++)
1370 if (!history_get (history_base
+ offset
))
1379 if (args
[0] == '+' && args
[1] == '\0')
1380 /* "info editing +" should print from the stored position. */
1383 /* "info editing <exp>" should print around command number <exp>. */
1384 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1386 /* "show commands" means print the last Hist_print commands. */
1389 num
= hist_len
- Hist_print
;
1395 /* If there are at least Hist_print commands, we want to display the last
1396 Hist_print rather than, say, the last 6. */
1397 if (hist_len
- num
< Hist_print
)
1399 num
= hist_len
- Hist_print
;
1404 for (offset
= num
; offset
< num
+ Hist_print
&& offset
< hist_len
; offset
++)
1406 printf_filtered ("%5d %s\n", history_base
+ offset
,
1407 (history_get (history_base
+ offset
))->line
);
1410 /* The next command we want to display is the next one that we haven't
1414 /* If the user repeats this command with return, it should do what
1415 "show commands +" does. This is unnecessary if arg is null,
1416 because "show commands +" is not useful after "show commands". */
1417 if (from_tty
&& args
)
1424 /* Called by do_setshow_command. */
1426 set_history_size_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1428 if (history_size
== INT_MAX
)
1429 unstifle_history ();
1430 else if (history_size
>= 0)
1431 stifle_history (history_size
);
1434 history_size
= INT_MAX
;
1435 error (_("History size must be non-negative"));
1440 set_history (char *args
, int from_tty
)
1442 printf_unfiltered (_("\"set history\" must be followed by the name of a history subcommand.\n"));
1443 help_list (sethistlist
, "set history ", -1, gdb_stdout
);
1447 show_history (char *args
, int from_tty
)
1449 cmd_show_list (showhistlist
, from_tty
, "");
1452 int info_verbose
= 0; /* Default verbose msgs off */
1454 /* Called by do_setshow_command. An elaborate joke. */
1456 set_verbose (char *args
, int from_tty
, struct cmd_list_element
*c
)
1458 char *cmdname
= "verbose";
1459 struct cmd_list_element
*showcmd
;
1461 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1465 c
->doc
= "Set verbose printing of informational messages.";
1466 showcmd
->doc
= "Show verbose printing of informational messages.";
1470 c
->doc
= "Set verbosity.";
1471 showcmd
->doc
= "Show verbosity.";
1475 /* Init the history buffer. Note that we are called after the init file(s)
1476 * have been read so that the user can change the history file via his
1477 * .gdbinit file (for instance). The GDBHISTFILE environment variable
1478 * overrides all of this.
1486 tmpenv
= getenv ("HISTSIZE");
1488 history_size
= atoi (tmpenv
);
1489 else if (!history_size
)
1492 stifle_history (history_size
);
1494 tmpenv
= getenv ("GDBHISTFILE");
1496 history_filename
= savestring (tmpenv
, strlen (tmpenv
));
1497 else if (!history_filename
)
1499 /* We include the current directory so that if the user changes
1500 directories the file written will be the same as the one
1503 /* No leading dots in file names are allowed on MSDOS. */
1504 history_filename
= concat (current_directory
, "/_gdb_history",
1507 history_filename
= concat (current_directory
, "/.gdb_history",
1511 read_history (history_filename
);
1515 show_new_async_prompt (struct ui_file
*file
, int from_tty
,
1516 struct cmd_list_element
*c
, const char *value
)
1518 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1522 show_async_command_editing_p (struct ui_file
*file
, int from_tty
,
1523 struct cmd_list_element
*c
, const char *value
)
1525 fprintf_filtered (file
, _("\
1526 Editing of command lines as they are typed is %s.\n"),
1531 show_annotation_level (struct ui_file
*file
, int from_tty
,
1532 struct cmd_list_element
*c
, const char *value
)
1534 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
1538 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
1539 struct cmd_list_element
*c
, const char *value
)
1541 fprintf_filtered (file
, _("\
1542 Notification of completion for asynchronous execution commands is %s.\n"),
1548 struct cmd_list_element
*c
;
1550 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1551 whatever the DEFAULT_PROMPT is. */
1552 the_prompts
.top
= 0;
1554 PROMPT (0) = savestring (DEFAULT_PROMPT
, strlen (DEFAULT_PROMPT
));
1556 /* Set things up for annotation_level > 1, if the user ever decides
1558 async_annotation_suffix
= "prompt";
1559 /* Set the variable associated with the setshow prompt command. */
1560 new_async_prompt
= savestring (PROMPT (0), strlen (PROMPT (0)));
1562 /* If gdb was started with --annotate=2, this is equivalent to the
1563 user entering the command 'set annotate 2' at the gdb prompt, so
1564 we need to do extra processing. */
1565 if (annotation_level
> 1)
1566 set_async_annotation_level (NULL
, 0, NULL
);
1568 /* Set the important stuff up for command editing. */
1569 command_editing_p
= 1;
1570 history_expansion_p
= 0;
1571 write_history_p
= 0;
1573 /* Setup important stuff for command line editing. */
1574 rl_completion_entry_function
= readline_line_completion_function
;
1575 rl_completer_word_break_characters
= default_word_break_characters ();
1576 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
1577 rl_readline_name
= "gdb";
1578 rl_terminal_name
= getenv ("TERM");
1580 /* The name for this defun comes from Bash, where it originated.
1581 15 is Control-o, the same binding this function has in Bash. */
1582 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
1584 add_setshow_string_cmd ("prompt", class_support
,
1585 &new_async_prompt
, _("\
1586 Set gdb's prompt"), _("\
1587 Show gdb's prompt"), NULL
,
1589 show_new_async_prompt
,
1590 &setlist
, &showlist
);
1592 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
1593 Don't repeat this command.\n\
1594 Primarily used inside of user-defined commands that should not be repeated when\n\
1597 add_setshow_boolean_cmd ("editing", class_support
,
1598 &async_command_editing_p
, _("\
1599 Set editing of command lines as they are typed."), _("\
1600 Show editing of command lines as they are typed."), _("\
1601 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1602 Without an argument, command line editing is enabled. To edit, use\n\
1603 EMACS-like or VI-like commands like control-P or ESC."),
1604 set_async_editing_command
,
1605 show_async_command_editing_p
,
1606 &setlist
, &showlist
);
1608 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
1609 Set saving of the history record on exit."), _("\
1610 Show saving of the history record on exit."), _("\
1611 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1612 Without an argument, saving is enabled."),
1614 show_write_history_p
,
1615 &sethistlist
, &showhistlist
);
1617 add_setshow_integer_cmd ("size", no_class
, &history_size
, _("\
1618 Set the size of the command history,"), _("\
1619 Show the size of the command history,"), _("\
1620 ie. the number of previous commands to keep a record of."),
1621 set_history_size_command
,
1623 &sethistlist
, &showhistlist
);
1625 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
1626 Set the filename in which to record the command history"), _("\
1627 Show the filename in which to record the command history"), _("\
1628 (the list of previous commands of which a record is kept)."),
1630 show_history_filename
,
1631 &sethistlist
, &showhistlist
);
1633 add_setshow_boolean_cmd ("confirm", class_support
, &caution
, _("\
1634 Set whether to confirm potentially dangerous operations."), _("\
1635 Show whether to confirm potentially dangerous operations."), NULL
,
1638 &setlist
, &showlist
);
1640 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
1641 Set annotation_level."), _("\
1642 Show annotation_level."), _("\
1643 0 == normal; 1 == fullname (for use when running under emacs)\n\
1644 2 == output annotated suitably for use by programs that control GDB."),
1645 set_async_annotation_level
,
1646 show_annotation_level
,
1647 &setlist
, &showlist
);
1649 add_setshow_boolean_cmd ("exec-done-display", class_support
,
1650 &exec_done_display_p
, _("\
1651 Set notification of completion for asynchronous execution commands."), _("\
1652 Show notification of completion for asynchronous execution commands."), _("\
1653 Use \"on\" to enable the notification, and \"off\" to disable it."),
1655 show_exec_done_display_p
,
1656 &setlist
, &showlist
);
1660 gdb_init (char *argv0
)
1662 if (pre_init_ui_hook
)
1663 pre_init_ui_hook ();
1665 /* Run the init function of each source file */
1667 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
1668 current_directory
= gdb_dirbuf
;
1671 /* Make sure we return to the original directory upon exit, come
1672 what may, since the OS doesn't do that for us. */
1673 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
1676 init_cmd_lists (); /* This needs to be done first */
1677 initialize_targets (); /* Setup target_terminal macros for utils.c */
1678 initialize_utils (); /* Make errors and warnings possible */
1679 initialize_all_files ();
1680 initialize_current_architecture ();
1682 init_main (); /* But that omits this file! Do it now */
1684 initialize_stdin_serial ();
1686 async_init_signals ();
1688 /* We need a default language for parsing expressions, so simple things like
1689 "set width 0" won't fail if no language is explicitly set in a config file
1690 or implicitly set by reading an executable during startup. */
1691 set_language (language_c
);
1692 expected_language
= current_language
; /* don't warn about the change. */
1694 /* Allow another UI to initialize. If the UI fails to initialize,
1695 and it wants GDB to revert to the CLI, it should clear
1696 deprecated_init_ui_hook. */
1697 if (deprecated_init_ui_hook
)
1698 deprecated_init_ui_hook (argv0
);