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;
377 struct continuation_arg
*arg1
;
378 struct continuation_arg
*arg2
;
379 long time_at_cmd_start
= 0;
381 long space_at_cmd_start
= 0;
383 extern int display_time
;
384 extern int display_space
;
386 if (target_can_async_p ())
388 time_at_cmd_start
= get_run_time ();
393 char *lim
= (char *) sbrk (0);
394 space_at_cmd_start
= lim
- lim_at_start
;
401 /* Force cleanup of any alloca areas if using C alloca instead of
405 /* This can happen when command_line_input hits end of file. */
409 target_log_command (p
);
411 while (*p
== ' ' || *p
== '\t')
418 /* If trace-commands is set then this will print this command. */
419 print_command_trace (p
);
421 c
= lookup_cmd (&p
, cmdlist
, "", 0, 1);
423 /* If the target is running, we allow only a limited set of
425 if (target_can_async_p () && target_executing
&& !get_cmd_async_ok (c
))
426 error (_("Cannot execute this command while the target is running."));
428 /* Pass null arg rather than an empty one. */
431 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
432 while the is_complete_command(cfunc) test is just plain
433 bogus. They should both be replaced by a test of the form
434 c->strip_trailing_white_space_p. */
435 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
436 can't be replaced with func. This is because it is the
437 cfunc, and not the func, that has the value that the
438 is_complete_command hack is testing for. */
439 /* Clear off trailing whitespace, except for set and complete
442 && c
->type
!= set_cmd
443 && !is_complete_command (c
))
445 p
= arg
+ strlen (arg
) - 1;
446 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
451 /* If this command has been pre-hooked, run the hook first. */
452 execute_cmd_pre_hook (c
);
454 if (c
->flags
& DEPRECATED_WARN_USER
)
455 deprecated_cmd_warning (&line
);
457 if (c
->class == class_user
)
458 execute_user_command (c
, arg
);
459 else if (c
->type
== set_cmd
|| c
->type
== show_cmd
)
460 do_setshow_command (arg
, from_tty
& caution
, c
);
461 else if (!cmd_func_p (c
))
462 error (_("That is not a command, just a help topic."));
463 else if (deprecated_call_command_hook
)
464 deprecated_call_command_hook (c
, arg
, from_tty
& caution
);
466 cmd_func (c
, arg
, from_tty
& caution
);
468 /* If this command has been post-hooked, run the hook last. */
469 execute_cmd_post_hook (c
);
473 /* Tell the user if the language has changed (except first time). */
474 if (current_language
!= expected_language
)
476 if (language_mode
== language_mode_auto
)
478 language_info (1); /* Print what changed. */
483 /* Warn the user if the working language does not match the
484 language of the current frame. Only warn the user if we are
485 actually running the program, i.e. there is a stack. */
486 /* FIXME: This should be cacheing the frame and only running when
487 the frame changes. */
489 if (!target_executing
&& target_has_stack
)
491 flang
= get_frame_language ();
493 && flang
!= language_unknown
494 && flang
!= current_language
->la_language
)
496 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
502 /* Read commands from `instream' and execute them
503 until end of file or error reading instream. */
508 struct cleanup
*old_chain
;
510 int stdin_is_tty
= ISATTY (stdin
);
511 long time_at_cmd_start
;
513 long space_at_cmd_start
= 0;
515 extern int display_time
;
516 extern int display_space
;
518 while (instream
&& !feof (instream
))
520 if (window_hook
&& instream
== stdin
)
521 (*window_hook
) (instream
, get_prompt ());
524 if (instream
== stdin
&& stdin_is_tty
)
525 reinitialize_more_filter ();
526 old_chain
= make_cleanup (null_cleanup
, 0);
528 /* Get a command-line. This calls the readline package. */
529 command
= command_line_input (instream
== stdin
?
530 get_prompt () : (char *) NULL
,
531 instream
== stdin
, "prompt");
535 time_at_cmd_start
= get_run_time ();
540 char *lim
= (char *) sbrk (0);
541 space_at_cmd_start
= lim
- lim_at_start
;
545 execute_command (command
, instream
== stdin
);
546 /* Do any commands attached to breakpoint we stopped at. */
547 bpstat_do_actions (&stop_bpstat
);
548 do_cleanups (old_chain
);
552 long cmd_time
= get_run_time () - time_at_cmd_start
;
554 printf_unfiltered (_("Command execution time: %ld.%06ld\n"),
555 cmd_time
/ 1000000, cmd_time
% 1000000);
561 char *lim
= (char *) sbrk (0);
562 long space_now
= lim
- lim_at_start
;
563 long space_diff
= space_now
- space_at_cmd_start
;
565 printf_unfiltered (_("Space used: %ld (%s%ld for this command)\n"),
567 (space_diff
>= 0 ? "+" : ""),
574 /* Commands call this if they do not want to be repeated by null lines. */
582 /* If we aren't reading from standard input, we are saving the last
583 thing read from stdin in line and don't want to delete it. Null lines
584 won't repeat here in any case. */
585 if (instream
== stdin
)
589 /* Read a line from the stream "instream" without command line editing.
591 It prints PROMPT_ARG once at the start.
592 Action is compatible with "readline", e.g. space for the result is
593 malloc'd and should be freed by the caller.
595 A NULL return means end of file. */
597 gdb_readline (char *prompt_arg
)
602 int result_size
= 80;
606 /* Don't use a _filtered function here. It causes the assumed
607 character position to be off, since the newline we read from
608 the user is not accounted for. */
609 fputs_unfiltered (prompt_arg
, gdb_stdout
);
610 gdb_flush (gdb_stdout
);
613 result
= (char *) xmalloc (result_size
);
617 /* Read from stdin if we are executing a user defined command.
618 This is the right thing for prompt_for_continue, at least. */
619 c
= fgetc (instream
? instream
: stdin
);
624 /* The last line does not end with a newline. Return it, and
625 if we are called again fgetc will still return EOF and
626 we'll return NULL then. */
634 if (input_index
> 0 && result
[input_index
- 1] == '\r')
639 result
[input_index
++] = c
;
640 while (input_index
>= result_size
)
643 result
= (char *) xrealloc (result
, result_size
);
647 result
[input_index
++] = '\0';
651 /* Variables which control command line editing and history
652 substitution. These variables are given default values at the end
654 static int command_editing_p
;
656 /* NOTE 1999-04-29: This variable will be static again, once we modify
657 gdb to use the event loop as the default command loop and we merge
658 event-top.c into this file, top.c */
660 /* static */ int history_expansion_p
;
662 static int write_history_p
;
664 show_write_history_p (struct ui_file
*file
, int from_tty
,
665 struct cmd_list_element
*c
, const char *value
)
667 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
671 static int history_size
;
673 show_history_size (struct ui_file
*file
, int from_tty
,
674 struct cmd_list_element
*c
, const char *value
)
676 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
680 static char *history_filename
;
682 show_history_filename (struct ui_file
*file
, int from_tty
,
683 struct cmd_list_element
*c
, const char *value
)
685 fprintf_filtered (file
, _("\
686 The filename in which to record the command history is \"%s\".\n"),
690 /* This is like readline(), but it has some gdb-specific behavior.
691 gdb may want readline in both the synchronous and async modes during
692 a single gdb invocation. At the ordinary top-level prompt we might
693 be using the async readline. That means we can't use
694 rl_pre_input_hook, since it doesn't work properly in async mode.
695 However, for a secondary prompt (" >", such as occurs during a
696 `define'), gdb wants a synchronous response.
698 We used to call readline() directly, running it in synchronous
699 mode. But mixing modes this way is not supported, and as of
700 readline 5.x it no longer works; the arrow keys come unbound during
701 the synchronous call. So we make a nested call into the event
702 loop. That's what gdb_readline_wrapper is for. */
704 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
705 rely on gdb_readline_wrapper_result, which might still be NULL if
706 the user types Control-D for EOF. */
707 static int gdb_readline_wrapper_done
;
709 /* The result of the current call to gdb_readline_wrapper, once a newline
711 static char *gdb_readline_wrapper_result
;
713 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
714 to be called after the newline is processed (which will redisplay
715 the prompt). But in gdb_readline_wrapper we will not get a new
716 prompt until the next call, or until we return to the event loop.
717 So we disable this hook around the newline and restore it before we
719 static void (*saved_after_char_processing_hook
) (void);
721 /* This function is called when readline has seen a complete line of
725 gdb_readline_wrapper_line (char *line
)
727 gdb_assert (!gdb_readline_wrapper_done
);
728 gdb_readline_wrapper_result
= line
;
729 gdb_readline_wrapper_done
= 1;
731 /* Prevent operate-and-get-next from acting too early. */
732 saved_after_char_processing_hook
= after_char_processing_hook
;
733 after_char_processing_hook
= NULL
;
735 /* Prevent parts of the prompt from being redisplayed if annotations
736 are enabled, and readline's state getting out of sync. */
737 if (async_command_editing_p
)
738 rl_callback_handler_remove ();
741 struct gdb_readline_wrapper_cleanup
743 void (*handler_orig
) (char *);
744 int already_prompted_orig
;
748 gdb_readline_wrapper_cleanup (void *arg
)
750 struct gdb_readline_wrapper_cleanup
*cleanup
= arg
;
752 rl_already_prompted
= cleanup
->already_prompted_orig
;
754 gdb_assert (input_handler
== gdb_readline_wrapper_line
);
755 input_handler
= cleanup
->handler_orig
;
756 gdb_readline_wrapper_result
= NULL
;
757 gdb_readline_wrapper_done
= 0;
759 after_char_processing_hook
= saved_after_char_processing_hook
;
760 saved_after_char_processing_hook
= NULL
;
766 gdb_readline_wrapper (char *prompt
)
768 struct cleanup
*back_to
;
769 struct gdb_readline_wrapper_cleanup
*cleanup
;
772 cleanup
= xmalloc (sizeof (*cleanup
));
773 cleanup
->handler_orig
= input_handler
;
774 input_handler
= gdb_readline_wrapper_line
;
776 cleanup
->already_prompted_orig
= rl_already_prompted
;
778 back_to
= make_cleanup (gdb_readline_wrapper_cleanup
, cleanup
);
780 /* Display our prompt and prevent double prompt display. */
781 display_gdb_prompt (prompt
);
782 rl_already_prompted
= 1;
784 if (after_char_processing_hook
)
785 (*after_char_processing_hook
) ();
786 gdb_assert (after_char_processing_hook
== NULL
);
788 /* gdb_do_one_event argument is unused. */
789 while (gdb_do_one_event (NULL
) >= 0)
790 if (gdb_readline_wrapper_done
)
793 retval
= gdb_readline_wrapper_result
;
794 do_cleanups (back_to
);
803 #if STOP_SIGNAL == SIGTSTP
804 signal (SIGTSTP
, SIG_DFL
);
810 sigprocmask (SIG_SETMASK
, &zero
, 0);
812 #elif HAVE_SIGSETMASK
815 kill (getpid (), SIGTSTP
);
816 signal (SIGTSTP
, stop_sig
);
818 signal (STOP_SIGNAL
, stop_sig
);
820 printf_unfiltered ("%s", get_prompt ());
821 gdb_flush (gdb_stdout
);
823 /* Forget about any previous command -- null line now will do nothing. */
826 #endif /* STOP_SIGNAL */
828 /* Initialize signal handlers. */
830 float_handler (int signo
)
832 /* This message is based on ANSI C, section 4.7. Note that integer
833 divide by zero causes this, so "float" is a misnomer. */
834 signal (SIGFPE
, float_handler
);
835 error (_("Erroneous arithmetic operation."));
839 do_nothing (int signo
)
841 /* Under System V the default disposition of a signal is reinstated after
842 the signal is caught and delivered to an application process. On such
843 systems one must restore the replacement signal handler if one wishes
844 to continue handling the signal in one's program. On BSD systems this
845 is not needed but it is harmless, and it simplifies the code to just do
846 it unconditionally. */
847 signal (signo
, do_nothing
);
850 /* The current saved history number from operate-and-get-next.
851 This is -1 if not valid. */
852 static int operate_saved_history
= -1;
854 /* This is put on the appropriate hook and helps operate-and-get-next
857 gdb_rl_operate_and_get_next_completion (void)
859 int delta
= where_history () - operate_saved_history
;
860 /* The `key' argument to rl_get_previous_history is ignored. */
861 rl_get_previous_history (delta
, 0);
862 operate_saved_history
= -1;
864 /* readline doesn't automatically update the display for us. */
867 after_char_processing_hook
= NULL
;
868 rl_pre_input_hook
= NULL
;
871 /* This is a gdb-local readline command handler. It accepts the
872 current command line (like RET does) and, if this command was taken
873 from the history, arranges for the next command in the history to
874 appear on the command line when the prompt returns.
875 We ignore the arguments. */
877 gdb_rl_operate_and_get_next (int count
, int key
)
881 /* Use the async hook. */
882 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
884 /* Find the current line, and find the next line to use. */
885 where
= where_history();
887 /* FIXME: kettenis/20020817: max_input_history is renamed into
888 history_max_entries in readline-4.2. When we do a new readline
889 import, we should probably change it here too, even though
890 readline maintains backwards compatibility for now by still
891 defining max_input_history. */
892 if ((history_is_stifled () && (history_length
>= max_input_history
)) ||
893 (where
>= history_length
- 1))
894 operate_saved_history
= where
;
896 operate_saved_history
= where
+ 1;
898 return rl_newline (1, key
);
901 /* Read one line from the command input stream `instream'
902 into the local static buffer `linebuffer' (whose current length
904 The buffer is made bigger as necessary.
905 Returns the address of the start of the line.
907 NULL is returned for end of file.
909 *If* the instream == stdin & stdin is a terminal, the line read
910 is copied into the file line saver (global var char *line,
911 length linesize) so that it can be duplicated.
913 This routine either uses fancy command line editing or
914 simple input as the user has requested. */
917 command_line_input (char *prompt_arg
, int repeat
, char *annotation_suffix
)
919 static char *linebuffer
= 0;
920 static unsigned linelength
= 0;
924 char *local_prompt
= prompt_arg
;
928 /* The annotation suffix must be non-NULL. */
929 if (annotation_suffix
== NULL
)
930 annotation_suffix
= "";
932 if (annotation_level
> 1 && instream
== stdin
)
934 local_prompt
= alloca ((prompt_arg
== NULL
? 0 : strlen (prompt_arg
))
935 + strlen (annotation_suffix
) + 40);
936 if (prompt_arg
== NULL
)
937 local_prompt
[0] = '\0';
939 strcpy (local_prompt
, prompt_arg
);
940 strcat (local_prompt
, "\n\032\032");
941 strcat (local_prompt
, annotation_suffix
);
942 strcat (local_prompt
, "\n");
948 linebuffer
= (char *) xmalloc (linelength
);
953 /* Control-C quits instantly if typed while in this loop
954 since it should not wait until the user types a newline. */
958 signal (STOP_SIGNAL
, handle_stop_sig
);
963 /* Make sure that all output has been output. Some machines may let
964 you get away with leaving out some of the gdb_flush, but not all. */
966 gdb_flush (gdb_stdout
);
967 gdb_flush (gdb_stderr
);
969 if (source_file_name
!= NULL
)
970 ++source_line_number
;
972 if (annotation_level
> 1 && instream
== stdin
)
974 puts_unfiltered ("\n\032\032pre-");
975 puts_unfiltered (annotation_suffix
);
976 puts_unfiltered ("\n");
979 /* Don't use fancy stuff if not talking to stdin. */
980 if (deprecated_readline_hook
&& input_from_terminal_p ())
982 rl
= (*deprecated_readline_hook
) (local_prompt
);
984 else if (command_editing_p
&& input_from_terminal_p ())
986 rl
= gdb_readline_wrapper (local_prompt
);
990 rl
= gdb_readline (local_prompt
);
993 if (annotation_level
> 1 && instream
== stdin
)
995 puts_unfiltered ("\n\032\032post-");
996 puts_unfiltered (annotation_suffix
);
997 puts_unfiltered ("\n");
1000 if (!rl
|| rl
== (char *) EOF
)
1005 if (strlen (rl
) + 1 + (p
- linebuffer
) > linelength
)
1007 linelength
= strlen (rl
) + 1 + (p
- linebuffer
);
1008 nline
= (char *) xrealloc (linebuffer
, linelength
);
1009 p
+= nline
- linebuffer
;
1013 /* Copy line. Don't copy null at end. (Leaves line alone
1014 if this was just a newline) */
1018 xfree (rl
); /* Allocated in readline. */
1020 if (p
== linebuffer
|| *(p
- 1) != '\\')
1023 p
--; /* Put on top of '\'. */
1024 local_prompt
= (char *) 0;
1029 signal (STOP_SIGNAL
, SIG_DFL
);
1036 #define SERVER_COMMAND_LENGTH 7
1038 (p
- linebuffer
> SERVER_COMMAND_LENGTH
)
1039 && strncmp (linebuffer
, "server ", SERVER_COMMAND_LENGTH
) == 0;
1042 /* Note that we don't set `line'. Between this and the check in
1043 dont_repeat, this insures that repeating will still do the
1046 return linebuffer
+ SERVER_COMMAND_LENGTH
;
1049 /* Do history expansion if that is wished. */
1050 if (history_expansion_p
&& instream
== stdin
1051 && ISATTY (instream
))
1053 char *history_value
;
1056 *p
= '\0'; /* Insert null now. */
1057 expanded
= history_expand (linebuffer
, &history_value
);
1060 /* Print the changes. */
1061 printf_unfiltered ("%s\n", history_value
);
1063 /* If there was an error, call this function again. */
1066 xfree (history_value
);
1067 return command_line_input (prompt_arg
, repeat
, annotation_suffix
);
1069 if (strlen (history_value
) > linelength
)
1071 linelength
= strlen (history_value
) + 1;
1072 linebuffer
= (char *) xrealloc (linebuffer
, linelength
);
1074 strcpy (linebuffer
, history_value
);
1075 p
= linebuffer
+ strlen (linebuffer
);
1077 xfree (history_value
);
1080 /* If we just got an empty line, and that is supposed
1081 to repeat the previous command, return the value in the
1083 if (repeat
&& p
== linebuffer
)
1085 for (p1
= linebuffer
; *p1
== ' ' || *p1
== '\t'; p1
++);
1091 /* Add line to history if appropriate. */
1092 if (instream
== stdin
1093 && ISATTY (stdin
) && *linebuffer
)
1094 add_history (linebuffer
);
1096 /* Note: lines consisting solely of comments are added to the command
1097 history. This is useful when you type a command, and then
1098 realize you don't want to execute it quite yet. You can comment
1099 out the command and then later fetch it from the value history
1100 and remove the '#'. The kill ring is probably better, but some
1101 people are in the habit of commenting things out. */
1103 *p1
= '\0'; /* Found a comment. */
1105 /* Save into global buffer if appropriate. */
1108 if (linelength
> linesize
)
1110 line
= xrealloc (line
, linelength
);
1111 linesize
= linelength
;
1113 strcpy (line
, linebuffer
);
1120 /* Print the GDB banner. */
1122 print_gdb_version (struct ui_file
*stream
)
1124 /* From GNU coding standards, first line is meant to be easy for a
1125 program to parse, and is just canonical program name and version
1126 number, which starts after last space. */
1128 fprintf_filtered (stream
, "GNU gdb %s\n", version
);
1130 /* Second line is a copyright notice. */
1132 fprintf_filtered (stream
, "Copyright (C) 2008 Free Software Foundation, Inc.\n");
1134 /* Following the copyright is a brief statement that the program is
1135 free software, that users are free to copy and change it on
1136 certain conditions, that it is covered by the GNU GPL, and that
1137 there is no warranty. */
1139 fprintf_filtered (stream
, "\
1140 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n\
1141 This is free software: you are free to change and redistribute it.\n\
1142 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1143 and \"show warranty\" for details.\n");
1145 /* After the required info we print the configuration information. */
1147 fprintf_filtered (stream
, "This GDB was configured as \"");
1148 if (strcmp (host_name
, target_name
) != 0)
1150 fprintf_filtered (stream
, "--host=%s --target=%s", host_name
, target_name
);
1154 fprintf_filtered (stream
, "%s", host_name
);
1156 fprintf_filtered (stream
, "\".");
1159 /* get_prompt: access method for the GDB prompt string. */
1168 set_prompt (char *s
)
1170 /* ??rehrauer: I don't know why this fails, since it looks as though
1171 assignments to prompt are wrapped in calls to savestring...
1175 PROMPT (0) = savestring (s
, strlen (s
));
1179 /* If necessary, make the user confirm that we should quit. Return
1180 non-zero if we should quit, zero if we shouldn't. */
1185 if (! ptid_equal (inferior_ptid
, null_ptid
) && target_has_execution
)
1189 /* This is something of a hack. But there's no reliable way to
1190 see if a GUI is running. The `use_windows' variable doesn't
1192 if (deprecated_init_ui_hook
)
1193 s
= "A debugging session is active.\nDo you still want to close the debugger?";
1194 else if (attach_flag
)
1195 s
= "The program is running. Quit anyway (and detach it)? ";
1197 s
= "The program is running. Quit anyway (and kill it)? ";
1199 if (!query ("%s", s
))
1206 /* Helper routine for quit_force that requires error handling. */
1215 quit_target (void *arg
)
1217 struct qt_args
*qt
= (struct qt_args
*)arg
;
1219 if (! ptid_equal (inferior_ptid
, null_ptid
) && target_has_execution
)
1222 target_detach (qt
->args
, qt
->from_tty
);
1227 /* UDI wants this, to kill the TIP. */
1228 target_close (¤t_target
, 1);
1230 /* Save the history information if it is appropriate to do so. */
1231 if (write_history_p
&& history_filename
)
1232 write_history (history_filename
);
1234 do_final_cleanups (ALL_CLEANUPS
); /* Do any final cleanups before exiting */
1239 /* Quit without asking for confirmation. */
1242 quit_force (char *args
, int from_tty
)
1247 /* An optional expression may be used to cause gdb to terminate with the
1248 value of that expression. */
1251 struct value
*val
= parse_and_eval (args
);
1253 exit_code
= (int) value_as_long (val
);
1255 else if (return_child_result
)
1256 exit_code
= return_child_result_value
;
1259 qt
.from_tty
= from_tty
;
1261 /* We want to handle any quit errors and exit regardless. */
1262 catch_errors (quit_target
, &qt
,
1263 "Quitting: ", RETURN_MASK_ALL
);
1268 /* Returns whether GDB is running on a terminal and input is
1269 currently coming from that terminal. */
1272 input_from_terminal_p (void)
1274 if (gdb_has_a_terminal () && instream
== stdin
)
1277 /* If INSTREAM is unset, and we are not in a user command, we
1278 must be in Insight. That's like having a terminal, for our
1280 if (instream
== NULL
&& !in_user_command
)
1287 dont_repeat_command (char *ignored
, int from_tty
)
1289 *line
= 0; /* Can't call dont_repeat here because we're not
1290 necessarily reading from stdin. */
1293 /* Functions to manipulate command line editing control variables. */
1295 /* Number of commands to print in each call to show_commands. */
1296 #define Hist_print 10
1298 show_commands (char *args
, int from_tty
)
1300 /* Index for history commands. Relative to history_base. */
1303 /* Number of the history entry which we are planning to display next.
1304 Relative to history_base. */
1307 /* The first command in the history which doesn't exist (i.e. one more
1308 than the number of the last command). Relative to history_base. */
1311 /* Print out some of the commands from the command history. */
1312 /* First determine the length of the history list. */
1313 hist_len
= history_size
;
1314 for (offset
= 0; offset
< history_size
; offset
++)
1316 if (!history_get (history_base
+ offset
))
1325 if (args
[0] == '+' && args
[1] == '\0')
1326 /* "info editing +" should print from the stored position. */
1329 /* "info editing <exp>" should print around command number <exp>. */
1330 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1332 /* "show commands" means print the last Hist_print commands. */
1335 num
= hist_len
- Hist_print
;
1341 /* If there are at least Hist_print commands, we want to display the last
1342 Hist_print rather than, say, the last 6. */
1343 if (hist_len
- num
< Hist_print
)
1345 num
= hist_len
- Hist_print
;
1350 for (offset
= num
; offset
< num
+ Hist_print
&& offset
< hist_len
; offset
++)
1352 printf_filtered ("%5d %s\n", history_base
+ offset
,
1353 (history_get (history_base
+ offset
))->line
);
1356 /* The next command we want to display is the next one that we haven't
1360 /* If the user repeats this command with return, it should do what
1361 "show commands +" does. This is unnecessary if arg is null,
1362 because "show commands +" is not useful after "show commands". */
1363 if (from_tty
&& args
)
1370 /* Called by do_setshow_command. */
1372 set_history_size_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1374 if (history_size
== INT_MAX
)
1375 unstifle_history ();
1376 else if (history_size
>= 0)
1377 stifle_history (history_size
);
1380 history_size
= INT_MAX
;
1381 error (_("History size must be non-negative"));
1386 set_history (char *args
, int from_tty
)
1388 printf_unfiltered (_("\"set history\" must be followed by the name of a history subcommand.\n"));
1389 help_list (sethistlist
, "set history ", -1, gdb_stdout
);
1393 show_history (char *args
, int from_tty
)
1395 cmd_show_list (showhistlist
, from_tty
, "");
1398 int info_verbose
= 0; /* Default verbose msgs off */
1400 /* Called by do_setshow_command. An elaborate joke. */
1402 set_verbose (char *args
, int from_tty
, struct cmd_list_element
*c
)
1404 char *cmdname
= "verbose";
1405 struct cmd_list_element
*showcmd
;
1407 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1411 c
->doc
= "Set verbose printing of informational messages.";
1412 showcmd
->doc
= "Show verbose printing of informational messages.";
1416 c
->doc
= "Set verbosity.";
1417 showcmd
->doc
= "Show verbosity.";
1421 /* Init the history buffer. Note that we are called after the init file(s)
1422 * have been read so that the user can change the history file via his
1423 * .gdbinit file (for instance). The GDBHISTFILE environment variable
1424 * overrides all of this.
1432 tmpenv
= getenv ("HISTSIZE");
1434 history_size
= atoi (tmpenv
);
1435 else if (!history_size
)
1438 stifle_history (history_size
);
1440 tmpenv
= getenv ("GDBHISTFILE");
1442 history_filename
= savestring (tmpenv
, strlen (tmpenv
));
1443 else if (!history_filename
)
1445 /* We include the current directory so that if the user changes
1446 directories the file written will be the same as the one
1449 /* No leading dots in file names are allowed on MSDOS. */
1450 history_filename
= concat (current_directory
, "/_gdb_history",
1453 history_filename
= concat (current_directory
, "/.gdb_history",
1457 read_history (history_filename
);
1461 show_new_async_prompt (struct ui_file
*file
, int from_tty
,
1462 struct cmd_list_element
*c
, const char *value
)
1464 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1468 show_async_command_editing_p (struct ui_file
*file
, int from_tty
,
1469 struct cmd_list_element
*c
, const char *value
)
1471 fprintf_filtered (file
, _("\
1472 Editing of command lines as they are typed is %s.\n"),
1477 show_annotation_level (struct ui_file
*file
, int from_tty
,
1478 struct cmd_list_element
*c
, const char *value
)
1480 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
1484 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
1485 struct cmd_list_element
*c
, const char *value
)
1487 fprintf_filtered (file
, _("\
1488 Notification of completion for asynchronous execution commands is %s.\n"),
1494 struct cmd_list_element
*c
;
1496 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1497 whatever the DEFAULT_PROMPT is. */
1498 the_prompts
.top
= 0;
1500 PROMPT (0) = savestring (DEFAULT_PROMPT
, strlen (DEFAULT_PROMPT
));
1502 /* Set things up for annotation_level > 1, if the user ever decides
1504 async_annotation_suffix
= "prompt";
1505 /* Set the variable associated with the setshow prompt command. */
1506 new_async_prompt
= savestring (PROMPT (0), strlen (PROMPT (0)));
1508 /* If gdb was started with --annotate=2, this is equivalent to the
1509 user entering the command 'set annotate 2' at the gdb prompt, so
1510 we need to do extra processing. */
1511 if (annotation_level
> 1)
1512 set_async_annotation_level (NULL
, 0, NULL
);
1514 /* Set the important stuff up for command editing. */
1515 command_editing_p
= 1;
1516 history_expansion_p
= 0;
1517 write_history_p
= 0;
1519 /* Setup important stuff for command line editing. */
1520 rl_completion_entry_function
= readline_line_completion_function
;
1521 rl_completer_word_break_characters
= default_word_break_characters ();
1522 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
1523 rl_readline_name
= "gdb";
1524 rl_terminal_name
= getenv ("TERM");
1526 /* The name for this defun comes from Bash, where it originated.
1527 15 is Control-o, the same binding this function has in Bash. */
1528 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
1530 add_setshow_string_cmd ("prompt", class_support
,
1531 &new_async_prompt
, _("\
1532 Set gdb's prompt"), _("\
1533 Show gdb's prompt"), NULL
,
1535 show_new_async_prompt
,
1536 &setlist
, &showlist
);
1538 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
1539 Don't repeat this command.\n\
1540 Primarily used inside of user-defined commands that should not be repeated when\n\
1543 add_setshow_boolean_cmd ("editing", class_support
,
1544 &async_command_editing_p
, _("\
1545 Set editing of command lines as they are typed."), _("\
1546 Show editing of command lines as they are typed."), _("\
1547 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1548 Without an argument, command line editing is enabled. To edit, use\n\
1549 EMACS-like or VI-like commands like control-P or ESC."),
1550 set_async_editing_command
,
1551 show_async_command_editing_p
,
1552 &setlist
, &showlist
);
1554 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
1555 Set saving of the history record on exit."), _("\
1556 Show saving of the history record on exit."), _("\
1557 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1558 Without an argument, saving is enabled."),
1560 show_write_history_p
,
1561 &sethistlist
, &showhistlist
);
1563 add_setshow_integer_cmd ("size", no_class
, &history_size
, _("\
1564 Set the size of the command history,"), _("\
1565 Show the size of the command history,"), _("\
1566 ie. the number of previous commands to keep a record of."),
1567 set_history_size_command
,
1569 &sethistlist
, &showhistlist
);
1571 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
1572 Set the filename in which to record the command history"), _("\
1573 Show the filename in which to record the command history"), _("\
1574 (the list of previous commands of which a record is kept)."),
1576 show_history_filename
,
1577 &sethistlist
, &showhistlist
);
1579 add_setshow_boolean_cmd ("confirm", class_support
, &caution
, _("\
1580 Set whether to confirm potentially dangerous operations."), _("\
1581 Show whether to confirm potentially dangerous operations."), NULL
,
1584 &setlist
, &showlist
);
1586 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
1587 Set annotation_level."), _("\
1588 Show annotation_level."), _("\
1589 0 == normal; 1 == fullname (for use when running under emacs)\n\
1590 2 == output annotated suitably for use by programs that control GDB."),
1591 set_async_annotation_level
,
1592 show_annotation_level
,
1593 &setlist
, &showlist
);
1595 add_setshow_boolean_cmd ("exec-done-display", class_support
,
1596 &exec_done_display_p
, _("\
1597 Set notification of completion for asynchronous execution commands."), _("\
1598 Show notification of completion for asynchronous execution commands."), _("\
1599 Use \"on\" to enable the notification, and \"off\" to disable it."),
1601 show_exec_done_display_p
,
1602 &setlist
, &showlist
);
1606 gdb_init (char *argv0
)
1608 if (pre_init_ui_hook
)
1609 pre_init_ui_hook ();
1611 /* Run the init function of each source file */
1613 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
1614 current_directory
= gdb_dirbuf
;
1617 /* Make sure we return to the original directory upon exit, come
1618 what may, since the OS doesn't do that for us. */
1619 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
1622 init_cmd_lists (); /* This needs to be done first */
1623 initialize_targets (); /* Setup target_terminal macros for utils.c */
1624 initialize_utils (); /* Make errors and warnings possible */
1625 initialize_all_files ();
1626 initialize_current_architecture ();
1628 init_main (); /* But that omits this file! Do it now */
1630 initialize_stdin_serial ();
1632 async_init_signals ();
1634 /* We need a default language for parsing expressions, so simple things like
1635 "set width 0" won't fail if no language is explicitly set in a config file
1636 or implicitly set by reading an executable during startup. */
1637 set_language (language_c
);
1638 expected_language
= current_language
; /* don't warn about the change. */
1640 /* Allow another UI to initialize. If the UI fails to initialize,
1641 and it wants GDB to revert to the CLI, it should clear
1642 deprecated_init_ui_hook. */
1643 if (deprecated_init_ui_hook
)
1644 deprecated_init_ui_hook (argv0
);