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, int error)
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;
382 bpstat_do_actions (&stop_bpstat);
386 long cmd_time = get_run_time () - time_at_cmd_start;
388 printf_unfiltered (_("Command execution time: %ld.%06ld\n"),
389 cmd_time / 1000000, cmd_time % 1000000);
394 char *lim = (char *) sbrk (0);
395 long space_now = lim - lim_at_start;
396 long space_diff = space_now - space_at_cmd_start;
398 printf_unfiltered (_("Space used: %ld (%c%ld for this command)\n"),
400 (space_diff >= 0 ? '+' : '-'),
406 /* Execute the line P as a command.
407 Pass FROM_TTY as second argument to the defining function. */
410 execute_command (char *p, int from_tty)
412 struct cmd_list_element *c;
414 static int warned = 0;
416 struct continuation_arg *arg1;
417 struct continuation_arg *arg2;
418 long time_at_cmd_start = 0;
420 long space_at_cmd_start = 0;
422 extern int display_time;
423 extern int display_space;
425 if (target_can_async_p ())
427 time_at_cmd_start = get_run_time ();
432 char *lim = (char *) sbrk (0);
433 space_at_cmd_start = lim - lim_at_start;
440 /* Force cleanup of any alloca areas if using C alloca instead of
444 /* This can happen when command_line_input hits end of file. */
448 target_log_command (p);
450 while (*p == ' ' || *p == '\t')
457 /* If trace-commands is set then this will print this command. */
458 print_command_trace (p);
460 c = lookup_cmd (&p, cmdlist, "", 0, 1);
462 /* If the target is running, we allow only a limited set of
464 if (target_can_async_p () && target_executing && !get_cmd_async_ok (c))
465 error (_("Cannot execute this command while the target is running."));
467 /* Pass null arg rather than an empty one. */
470 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
471 while the is_complete_command(cfunc) test is just plain
472 bogus. They should both be replaced by a test of the form
473 c->strip_trailing_white_space_p. */
474 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
475 can't be replaced with func. This is because it is the
476 cfunc, and not the func, that has the value that the
477 is_complete_command hack is testing for. */
478 /* Clear off trailing whitespace, except for set and complete
481 && c->type != set_cmd
482 && !is_complete_command (c))
484 p = arg + strlen (arg) - 1;
485 while (p >= arg && (*p == ' ' || *p == '\t'))
490 /* If this command has been pre-hooked, run the hook first. */
491 execute_cmd_pre_hook (c);
493 if (c->flags & DEPRECATED_WARN_USER)
494 deprecated_cmd_warning (&line);
496 if (c->class == class_user)
497 execute_user_command (c, arg);
498 else if (c->type == set_cmd || c->type == show_cmd)
499 do_setshow_command (arg, from_tty & caution, c);
500 else if (!cmd_func_p (c))
501 error (_("That is not a command, just a help topic."));
502 else if (deprecated_call_command_hook)
503 deprecated_call_command_hook (c, arg, from_tty & caution);
505 cmd_func (c, arg, from_tty & caution);
507 /* If this command has been post-hooked, run the hook last. */
508 execute_cmd_post_hook (c);
512 /* Tell the user if the language has changed (except first time). */
513 if (current_language != expected_language)
515 if (language_mode == language_mode_auto)
517 language_info (1); /* Print what changed. */
522 /* Warn the user if the working language does not match the
523 language of the current frame. Only warn the user if we are
524 actually running the program, i.e. there is a stack. */
525 /* FIXME: This should be cacheing the frame and only running when
526 the frame changes. */
528 if (!target_executing && target_has_stack)
530 flang = get_frame_language ();
532 && flang != language_unknown
533 && flang != current_language->la_language)
535 printf_filtered ("%s\n", lang_frame_mismatch_warn);
540 /* Set things up for this function to be compete later, once the
541 execution has completed, if we are doing an execution command,
542 otherwise, just go ahead and finish. */
543 if (target_can_async_p () && target_executing)
546 (struct continuation_arg *) xmalloc (sizeof (struct continuation_arg));
548 (struct continuation_arg *) xmalloc (sizeof (struct continuation_arg));
551 arg1->data.longint = time_at_cmd_start;
553 arg2->data.longint = space_at_cmd_start;
555 add_continuation (command_line_handler_continuation, arg1);
559 /* Read commands from `instream' and execute them
560 until end of file or error reading instream. */
565 struct cleanup *old_chain;
567 int stdin_is_tty = ISATTY (stdin);
568 long time_at_cmd_start;
570 long space_at_cmd_start = 0;
572 extern int display_time;
573 extern int display_space;
575 while (instream && !feof (instream))
577 if (window_hook && instream == stdin)
578 (*window_hook) (instream, get_prompt ());
581 if (instream == stdin && stdin_is_tty)
582 reinitialize_more_filter ();
583 old_chain = make_cleanup (null_cleanup, 0);
585 /* Get a command-line. This calls the readline package. */
586 command = command_line_input (instream == stdin ?
587 get_prompt () : (char *) NULL,
588 instream == stdin, "prompt");
592 time_at_cmd_start = get_run_time ();
597 char *lim = (char *) sbrk (0);
598 space_at_cmd_start = lim - lim_at_start;
602 execute_command (command, instream == stdin);
603 /* Do any commands attached to breakpoint we stopped at. */
604 bpstat_do_actions (&stop_bpstat);
605 do_cleanups (old_chain);
609 long cmd_time = get_run_time () - time_at_cmd_start;
611 printf_unfiltered (_("Command execution time: %ld.%06ld\n"),
612 cmd_time / 1000000, cmd_time % 1000000);
618 char *lim = (char *) sbrk (0);
619 long space_now = lim - lim_at_start;
620 long space_diff = space_now - space_at_cmd_start;
622 printf_unfiltered (_("Space used: %ld (%s%ld for this command)\n"),
624 (space_diff >= 0 ? "+" : ""),
631 /* Commands call this if they do not want to be repeated by null lines. */
639 /* If we aren't reading from standard input, we are saving the last
640 thing read from stdin in line and don't want to delete it. Null lines
641 won't repeat here in any case. */
642 if (instream == stdin)
646 /* Read a line from the stream "instream" without command line editing.
648 It prints PROMPT_ARG once at the start.
649 Action is compatible with "readline", e.g. space for the result is
650 malloc'd and should be freed by the caller.
652 A NULL return means end of file. */
654 gdb_readline (char *prompt_arg)
659 int result_size = 80;
663 /* Don't use a _filtered function here. It causes the assumed
664 character position to be off, since the newline we read from
665 the user is not accounted for. */
666 fputs_unfiltered (prompt_arg, gdb_stdout);
667 gdb_flush (gdb_stdout);
670 result = (char *) xmalloc (result_size);
674 /* Read from stdin if we are executing a user defined command.
675 This is the right thing for prompt_for_continue, at least. */
676 c = fgetc (instream ? instream : stdin);
681 /* The last line does not end with a newline. Return it, and
682 if we are called again fgetc will still return EOF and
683 we'll return NULL then. */
691 if (input_index > 0 && result[input_index - 1] == '\r')
696 result[input_index++] = c;
697 while (input_index >= result_size)
700 result = (char *) xrealloc (result, result_size);
704 result[input_index++] = '\0';
708 /* Variables which control command line editing and history
709 substitution. These variables are given default values at the end
711 static int command_editing_p;
713 /* NOTE 1999-04-29: This variable will be static again, once we modify
714 gdb to use the event loop as the default command loop and we merge
715 event-top.c into this file, top.c */
717 /* static */ int history_expansion_p;
719 static int write_history_p;
721 show_write_history_p (struct ui_file *file, int from_tty,
722 struct cmd_list_element *c, const char *value)
724 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
728 static int history_size;
730 show_history_size (struct ui_file *file, int from_tty,
731 struct cmd_list_element *c, const char *value)
733 fprintf_filtered (file, _("The size of the command history is %s.\n"),
737 static char *history_filename;
739 show_history_filename (struct ui_file *file, int from_tty,
740 struct cmd_list_element *c, const char *value)
742 fprintf_filtered (file, _("\
743 The filename in which to record the command history is \"%s\".\n"),
747 /* This is like readline(), but it has some gdb-specific behavior.
748 gdb may want readline in both the synchronous and async modes during
749 a single gdb invocation. At the ordinary top-level prompt we might
750 be using the async readline. That means we can't use
751 rl_pre_input_hook, since it doesn't work properly in async mode.
752 However, for a secondary prompt (" >", such as occurs during a
753 `define'), gdb wants a synchronous response.
755 We used to call readline() directly, running it in synchronous
756 mode. But mixing modes this way is not supported, and as of
757 readline 5.x it no longer works; the arrow keys come unbound during
758 the synchronous call. So we make a nested call into the event
759 loop. That's what gdb_readline_wrapper is for. */
761 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
762 rely on gdb_readline_wrapper_result, which might still be NULL if
763 the user types Control-D for EOF. */
764 static int gdb_readline_wrapper_done;
766 /* The result of the current call to gdb_readline_wrapper, once a newline
768 static char *gdb_readline_wrapper_result;
770 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
771 to be called after the newline is processed (which will redisplay
772 the prompt). But in gdb_readline_wrapper we will not get a new
773 prompt until the next call, or until we return to the event loop.
774 So we disable this hook around the newline and restore it before we
776 static void (*saved_after_char_processing_hook) (void);
778 /* This function is called when readline has seen a complete line of
782 gdb_readline_wrapper_line (char *line)
784 gdb_assert (!gdb_readline_wrapper_done);
785 gdb_readline_wrapper_result = line;
786 gdb_readline_wrapper_done = 1;
788 /* Prevent operate-and-get-next from acting too early. */
789 saved_after_char_processing_hook = after_char_processing_hook;
790 after_char_processing_hook = NULL;
792 /* Prevent parts of the prompt from being redisplayed if annotations
793 are enabled, and readline's state getting out of sync. */
794 if (async_command_editing_p)
795 rl_callback_handler_remove ();
798 struct gdb_readline_wrapper_cleanup
800 void (*handler_orig) (char *);
801 int already_prompted_orig;
805 gdb_readline_wrapper_cleanup (void *arg)
807 struct gdb_readline_wrapper_cleanup *cleanup = arg;
809 rl_already_prompted = cleanup->already_prompted_orig;
811 gdb_assert (input_handler == gdb_readline_wrapper_line);
812 input_handler = cleanup->handler_orig;
813 gdb_readline_wrapper_result = NULL;
814 gdb_readline_wrapper_done = 0;
816 after_char_processing_hook = saved_after_char_processing_hook;
817 saved_after_char_processing_hook = NULL;
823 gdb_readline_wrapper (char *prompt)
825 struct cleanup *back_to;
826 struct gdb_readline_wrapper_cleanup *cleanup;
829 cleanup = xmalloc (sizeof (*cleanup));
830 cleanup->handler_orig = input_handler;
831 input_handler = gdb_readline_wrapper_line;
833 cleanup->already_prompted_orig = rl_already_prompted;
835 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
837 /* Display our prompt and prevent double prompt display. */
838 display_gdb_prompt (prompt);
839 rl_already_prompted = 1;
841 if (after_char_processing_hook)
842 (*after_char_processing_hook) ();
843 gdb_assert (after_char_processing_hook == NULL);
845 /* gdb_do_one_event argument is unused. */
846 while (gdb_do_one_event (NULL) >= 0)
847 if (gdb_readline_wrapper_done)
850 retval = gdb_readline_wrapper_result;
851 do_cleanups (back_to);
860 #if STOP_SIGNAL == SIGTSTP
861 signal (SIGTSTP, SIG_DFL);
867 sigprocmask (SIG_SETMASK, &zero, 0);
869 #elif HAVE_SIGSETMASK
872 kill (getpid (), SIGTSTP);
873 signal (SIGTSTP, stop_sig);
875 signal (STOP_SIGNAL, stop_sig);
877 printf_unfiltered ("%s", get_prompt ());
878 gdb_flush (gdb_stdout);
880 /* Forget about any previous command -- null line now will do nothing. */
883 #endif /* STOP_SIGNAL */
885 /* Initialize signal handlers. */
887 float_handler (int signo)
889 /* This message is based on ANSI C, section 4.7. Note that integer
890 divide by zero causes this, so "float" is a misnomer. */
891 signal (SIGFPE, float_handler);
892 error (_("Erroneous arithmetic operation."));
896 do_nothing (int signo)
898 /* Under System V the default disposition of a signal is reinstated after
899 the signal is caught and delivered to an application process. On such
900 systems one must restore the replacement signal handler if one wishes
901 to continue handling the signal in one's program. On BSD systems this
902 is not needed but it is harmless, and it simplifies the code to just do
903 it unconditionally. */
904 signal (signo, do_nothing);
907 /* The current saved history number from operate-and-get-next.
908 This is -1 if not valid. */
909 static int operate_saved_history = -1;
911 /* This is put on the appropriate hook and helps operate-and-get-next
914 gdb_rl_operate_and_get_next_completion (void)
916 int delta = where_history () - operate_saved_history;
917 /* The `key' argument to rl_get_previous_history is ignored. */
918 rl_get_previous_history (delta, 0);
919 operate_saved_history = -1;
921 /* readline doesn't automatically update the display for us. */
924 after_char_processing_hook = NULL;
925 rl_pre_input_hook = NULL;
928 /* This is a gdb-local readline command handler. It accepts the
929 current command line (like RET does) and, if this command was taken
930 from the history, arranges for the next command in the history to
931 appear on the command line when the prompt returns.
932 We ignore the arguments. */
934 gdb_rl_operate_and_get_next (int count, int key)
938 /* Use the async hook. */
939 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
941 /* Find the current line, and find the next line to use. */
942 where = where_history();
944 /* FIXME: kettenis/20020817: max_input_history is renamed into
945 history_max_entries in readline-4.2. When we do a new readline
946 import, we should probably change it here too, even though
947 readline maintains backwards compatibility for now by still
948 defining max_input_history. */
949 if ((history_is_stifled () && (history_length >= max_input_history)) ||
950 (where >= history_length - 1))
951 operate_saved_history = where;
953 operate_saved_history = where + 1;
955 return rl_newline (1, key);
958 /* Read one line from the command input stream `instream'
959 into the local static buffer `linebuffer' (whose current length
961 The buffer is made bigger as necessary.
962 Returns the address of the start of the line.
964 NULL is returned for end of file.
966 *If* the instream == stdin & stdin is a terminal, the line read
967 is copied into the file line saver (global var char *line,
968 length linesize) so that it can be duplicated.
970 This routine either uses fancy command line editing or
971 simple input as the user has requested. */
974 command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
976 static char *linebuffer = 0;
977 static unsigned linelength = 0;
981 char *local_prompt = prompt_arg;
985 /* The annotation suffix must be non-NULL. */
986 if (annotation_suffix == NULL)
987 annotation_suffix = "";
989 if (annotation_level > 1 && instream == stdin)
991 local_prompt = alloca ((prompt_arg == NULL ? 0 : strlen (prompt_arg))
992 + strlen (annotation_suffix) + 40);
993 if (prompt_arg == NULL)
994 local_prompt[0] = '\0';
996 strcpy (local_prompt, prompt_arg);
997 strcat (local_prompt, "\n\032\032");
998 strcat (local_prompt, annotation_suffix);
999 strcat (local_prompt, "\n");
1002 if (linebuffer == 0)
1005 linebuffer = (char *) xmalloc (linelength);
1010 /* Control-C quits instantly if typed while in this loop
1011 since it should not wait until the user types a newline. */
1015 signal (STOP_SIGNAL, handle_stop_sig);
1020 /* Make sure that all output has been output. Some machines may let
1021 you get away with leaving out some of the gdb_flush, but not all. */
1023 gdb_flush (gdb_stdout);
1024 gdb_flush (gdb_stderr);
1026 if (source_file_name != NULL)
1027 ++source_line_number;
1029 if (annotation_level > 1 && instream == stdin)
1031 puts_unfiltered ("\n\032\032pre-");
1032 puts_unfiltered (annotation_suffix);
1033 puts_unfiltered ("\n");
1036 /* Don't use fancy stuff if not talking to stdin. */
1037 if (deprecated_readline_hook && input_from_terminal_p ())
1039 rl = (*deprecated_readline_hook) (local_prompt);
1041 else if (command_editing_p && input_from_terminal_p ())
1043 rl = gdb_readline_wrapper (local_prompt);
1047 rl = gdb_readline (local_prompt);
1050 if (annotation_level > 1 && instream == stdin)
1052 puts_unfiltered ("\n\032\032post-");
1053 puts_unfiltered (annotation_suffix);
1054 puts_unfiltered ("\n");
1057 if (!rl || rl == (char *) EOF)
1062 if (strlen (rl) + 1 + (p - linebuffer) > linelength)
1064 linelength = strlen (rl) + 1 + (p - linebuffer);
1065 nline = (char *) xrealloc (linebuffer, linelength);
1066 p += nline - linebuffer;
1070 /* Copy line. Don't copy null at end. (Leaves line alone
1071 if this was just a newline) */
1075 xfree (rl); /* Allocated in readline. */
1077 if (p == linebuffer || *(p - 1) != '\\')
1080 p--; /* Put on top of '\'. */
1081 local_prompt = (char *) 0;
1086 signal (STOP_SIGNAL, SIG_DFL);
1093 #define SERVER_COMMAND_LENGTH 7
1095 (p - linebuffer > SERVER_COMMAND_LENGTH)
1096 && strncmp (linebuffer, "server ", SERVER_COMMAND_LENGTH) == 0;
1099 /* Note that we don't set `line'. Between this and the check in
1100 dont_repeat, this insures that repeating will still do the
1103 return linebuffer + SERVER_COMMAND_LENGTH;
1106 /* Do history expansion if that is wished. */
1107 if (history_expansion_p && instream == stdin
1108 && ISATTY (instream))
1110 char *history_value;
1113 *p = '\0'; /* Insert null now. */
1114 expanded = history_expand (linebuffer, &history_value);
1117 /* Print the changes. */
1118 printf_unfiltered ("%s\n", history_value);
1120 /* If there was an error, call this function again. */
1123 xfree (history_value);
1124 return command_line_input (prompt_arg, repeat, annotation_suffix);
1126 if (strlen (history_value) > linelength)
1128 linelength = strlen (history_value) + 1;
1129 linebuffer = (char *) xrealloc (linebuffer, linelength);
1131 strcpy (linebuffer, history_value);
1132 p = linebuffer + strlen (linebuffer);
1134 xfree (history_value);
1137 /* If we just got an empty line, and that is supposed
1138 to repeat the previous command, return the value in the
1140 if (repeat && p == linebuffer)
1142 for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
1148 /* Add line to history if appropriate. */
1149 if (instream == stdin
1150 && ISATTY (stdin) && *linebuffer)
1151 add_history (linebuffer);
1153 /* Note: lines consisting solely of comments are added to the command
1154 history. This is useful when you type a command, and then
1155 realize you don't want to execute it quite yet. You can comment
1156 out the command and then later fetch it from the value history
1157 and remove the '#'. The kill ring is probably better, but some
1158 people are in the habit of commenting things out. */
1160 *p1 = '\0'; /* Found a comment. */
1162 /* Save into global buffer if appropriate. */
1165 if (linelength > linesize)
1167 line = xrealloc (line, linelength);
1168 linesize = linelength;
1170 strcpy (line, linebuffer);
1177 /* Print the GDB banner. */
1179 print_gdb_version (struct ui_file *stream)
1181 /* From GNU coding standards, first line is meant to be easy for a
1182 program to parse, and is just canonical program name and version
1183 number, which starts after last space. */
1185 fprintf_filtered (stream, "GNU gdb %s\n", version);
1187 /* Second line is a copyright notice. */
1189 fprintf_filtered (stream, "Copyright (C) 2008 Free Software Foundation, Inc.\n");
1191 /* Following the copyright is a brief statement that the program is
1192 free software, that users are free to copy and change it on
1193 certain conditions, that it is covered by the GNU GPL, and that
1194 there is no warranty. */
1196 fprintf_filtered (stream, "\
1197 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n\
1198 This is free software: you are free to change and redistribute it.\n\
1199 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1200 and \"show warranty\" for details.\n");
1202 /* After the required info we print the configuration information. */
1204 fprintf_filtered (stream, "This GDB was configured as \"");
1205 if (strcmp (host_name, target_name) != 0)
1207 fprintf_filtered (stream, "--host=%s --target=%s", host_name, target_name);
1211 fprintf_filtered (stream, "%s", host_name);
1213 fprintf_filtered (stream, "\".");
1216 /* get_prompt: access method for the GDB prompt string. */
1225 set_prompt (char *s)
1227 /* ??rehrauer: I don't know why this fails, since it looks as though
1228 assignments to prompt are wrapped in calls to savestring...
1232 PROMPT (0) = savestring (s, strlen (s));
1236 /* If necessary, make the user confirm that we should quit. Return
1237 non-zero if we should quit, zero if we shouldn't. */
1242 if (! ptid_equal (inferior_ptid, null_ptid) && target_has_execution)
1246 /* This is something of a hack. But there's no reliable way to
1247 see if a GUI is running. The `use_windows' variable doesn't
1249 if (deprecated_init_ui_hook)
1250 s = "A debugging session is active.\nDo you still want to close the debugger?";
1251 else if (attach_flag)
1252 s = "The program is running. Quit anyway (and detach it)? ";
1254 s = "The program is running. Quit anyway (and kill it)? ";
1256 if (!query ("%s", s))
1263 /* Helper routine for quit_force that requires error handling. */
1272 quit_target (void *arg)
1274 struct qt_args *qt = (struct qt_args *)arg;
1276 if (! ptid_equal (inferior_ptid, null_ptid) && target_has_execution)
1279 target_detach (qt->args, qt->from_tty);
1284 /* UDI wants this, to kill the TIP. */
1285 target_close (¤t_target, 1);
1287 /* Save the history information if it is appropriate to do so. */
1288 if (write_history_p && history_filename)
1289 write_history (history_filename);
1291 do_final_cleanups (ALL_CLEANUPS); /* Do any final cleanups before exiting */
1296 /* Quit without asking for confirmation. */
1299 quit_force (char *args, int from_tty)
1304 /* An optional expression may be used to cause gdb to terminate with the
1305 value of that expression. */
1308 struct value *val = parse_and_eval (args);
1310 exit_code = (int) value_as_long (val);
1312 else if (return_child_result)
1313 exit_code = return_child_result_value;
1316 qt.from_tty = from_tty;
1318 /* We want to handle any quit errors and exit regardless. */
1319 catch_errors (quit_target, &qt,
1320 "Quitting: ", RETURN_MASK_ALL);
1325 /* Returns whether GDB is running on a terminal and input is
1326 currently coming from that terminal. */
1329 input_from_terminal_p (void)
1331 if (gdb_has_a_terminal () && instream == stdin)
1334 /* If INSTREAM is unset, and we are not in a user command, we
1335 must be in Insight. That's like having a terminal, for our
1337 if (instream == NULL && !in_user_command)
1344 dont_repeat_command (char *ignored, int from_tty)
1346 *line = 0; /* Can't call dont_repeat here because we're not
1347 necessarily reading from stdin. */
1350 /* Functions to manipulate command line editing control variables. */
1352 /* Number of commands to print in each call to show_commands. */
1353 #define Hist_print 10
1355 show_commands (char *args, int from_tty)
1357 /* Index for history commands. Relative to history_base. */
1360 /* Number of the history entry which we are planning to display next.
1361 Relative to history_base. */
1364 /* The first command in the history which doesn't exist (i.e. one more
1365 than the number of the last command). Relative to history_base. */
1368 /* Print out some of the commands from the command history. */
1369 /* First determine the length of the history list. */
1370 hist_len = history_size;
1371 for (offset = 0; offset < history_size; offset++)
1373 if (!history_get (history_base + offset))
1382 if (args[0] == '+' && args[1] == '\0')
1383 /* "info editing +" should print from the stored position. */
1386 /* "info editing <exp>" should print around command number <exp>. */
1387 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1389 /* "show commands" means print the last Hist_print commands. */
1392 num = hist_len - Hist_print;
1398 /* If there are at least Hist_print commands, we want to display the last
1399 Hist_print rather than, say, the last 6. */
1400 if (hist_len - num < Hist_print)
1402 num = hist_len - Hist_print;
1407 for (offset = num; offset < num + Hist_print && offset < hist_len; offset++)
1409 printf_filtered ("%5d %s\n", history_base + offset,
1410 (history_get (history_base + offset))->line);
1413 /* The next command we want to display is the next one that we haven't
1417 /* If the user repeats this command with return, it should do what
1418 "show commands +" does. This is unnecessary if arg is null,
1419 because "show commands +" is not useful after "show commands". */
1420 if (from_tty && args)
1427 /* Called by do_setshow_command. */
1429 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1431 if (history_size == INT_MAX)
1432 unstifle_history ();
1433 else if (history_size >= 0)
1434 stifle_history (history_size);
1437 history_size = INT_MAX;
1438 error (_("History size must be non-negative"));
1443 set_history (char *args, int from_tty)
1445 printf_unfiltered (_("\"set history\" must be followed by the name of a history subcommand.\n"));
1446 help_list (sethistlist, "set history ", -1, gdb_stdout);
1450 show_history (char *args, int from_tty)
1452 cmd_show_list (showhistlist, from_tty, "");
1455 int info_verbose = 0; /* Default verbose msgs off */
1457 /* Called by do_setshow_command. An elaborate joke. */
1459 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1461 char *cmdname = "verbose";
1462 struct cmd_list_element *showcmd;
1464 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1468 c->doc = "Set verbose printing of informational messages.";
1469 showcmd->doc = "Show verbose printing of informational messages.";
1473 c->doc = "Set verbosity.";
1474 showcmd->doc = "Show verbosity.";
1478 /* Init the history buffer. Note that we are called after the init file(s)
1479 * have been read so that the user can change the history file via his
1480 * .gdbinit file (for instance). The GDBHISTFILE environment variable
1481 * overrides all of this.
1489 tmpenv = getenv ("HISTSIZE");
1491 history_size = atoi (tmpenv);
1492 else if (!history_size)
1495 stifle_history (history_size);
1497 tmpenv = getenv ("GDBHISTFILE");
1499 history_filename = savestring (tmpenv, strlen (tmpenv));
1500 else if (!history_filename)
1502 /* We include the current directory so that if the user changes
1503 directories the file written will be the same as the one
1506 /* No leading dots in file names are allowed on MSDOS. */
1507 history_filename = concat (current_directory, "/_gdb_history",
1510 history_filename = concat (current_directory, "/.gdb_history",
1514 read_history (history_filename);
1518 show_new_async_prompt (struct ui_file *file, int from_tty,
1519 struct cmd_list_element *c, const char *value)
1521 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1525 show_async_command_editing_p (struct ui_file *file, int from_tty,
1526 struct cmd_list_element *c, const char *value)
1528 fprintf_filtered (file, _("\
1529 Editing of command lines as they are typed is %s.\n"),
1534 show_annotation_level (struct ui_file *file, int from_tty,
1535 struct cmd_list_element *c, const char *value)
1537 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1541 show_exec_done_display_p (struct ui_file *file, int from_tty,
1542 struct cmd_list_element *c, const char *value)
1544 fprintf_filtered (file, _("\
1545 Notification of completion for asynchronous execution commands is %s.\n"),
1551 struct cmd_list_element *c;
1553 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1554 whatever the DEFAULT_PROMPT is. */
1555 the_prompts.top = 0;
1557 PROMPT (0) = savestring (DEFAULT_PROMPT, strlen (DEFAULT_PROMPT));
1559 /* Set things up for annotation_level > 1, if the user ever decides
1561 async_annotation_suffix = "prompt";
1562 /* Set the variable associated with the setshow prompt command. */
1563 new_async_prompt = savestring (PROMPT (0), strlen (PROMPT (0)));
1565 /* If gdb was started with --annotate=2, this is equivalent to the
1566 user entering the command 'set annotate 2' at the gdb prompt, so
1567 we need to do extra processing. */
1568 if (annotation_level > 1)
1569 set_async_annotation_level (NULL, 0, NULL);
1571 /* Set the important stuff up for command editing. */
1572 command_editing_p = 1;
1573 history_expansion_p = 0;
1574 write_history_p = 0;
1576 /* Setup important stuff for command line editing. */
1577 rl_completion_entry_function = readline_line_completion_function;
1578 rl_completer_word_break_characters = default_word_break_characters ();
1579 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1580 rl_readline_name = "gdb";
1581 rl_terminal_name = getenv ("TERM");
1583 /* The name for this defun comes from Bash, where it originated.
1584 15 is Control-o, the same binding this function has in Bash. */
1585 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1587 add_setshow_string_cmd ("prompt", class_support,
1588 &new_async_prompt, _("\
1589 Set gdb's prompt"), _("\
1590 Show gdb's prompt"), NULL,
1592 show_new_async_prompt,
1593 &setlist, &showlist);
1595 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1596 Don't repeat this command.\n\
1597 Primarily used inside of user-defined commands that should not be repeated when\n\
1600 add_setshow_boolean_cmd ("editing", class_support,
1601 &async_command_editing_p, _("\
1602 Set editing of command lines as they are typed."), _("\
1603 Show editing of command lines as they are typed."), _("\
1604 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1605 Without an argument, command line editing is enabled. To edit, use\n\
1606 EMACS-like or VI-like commands like control-P or ESC."),
1607 set_async_editing_command,
1608 show_async_command_editing_p,
1609 &setlist, &showlist);
1611 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
1612 Set saving of the history record on exit."), _("\
1613 Show saving of the history record on exit."), _("\
1614 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1615 Without an argument, saving is enabled."),
1617 show_write_history_p,
1618 &sethistlist, &showhistlist);
1620 add_setshow_integer_cmd ("size", no_class, &history_size, _("\
1621 Set the size of the command history,"), _("\
1622 Show the size of the command history,"), _("\
1623 ie. the number of previous commands to keep a record of."),
1624 set_history_size_command,
1626 &sethistlist, &showhistlist);
1628 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
1629 Set the filename in which to record the command history"), _("\
1630 Show the filename in which to record the command history"), _("\
1631 (the list of previous commands of which a record is kept)."),
1633 show_history_filename,
1634 &sethistlist, &showhistlist);
1636 add_setshow_boolean_cmd ("confirm", class_support, &caution, _("\
1637 Set whether to confirm potentially dangerous operations."), _("\
1638 Show whether to confirm potentially dangerous operations."), NULL,
1641 &setlist, &showlist);
1643 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
1644 Set annotation_level."), _("\
1645 Show annotation_level."), _("\
1646 0 == normal; 1 == fullname (for use when running under emacs)\n\
1647 2 == output annotated suitably for use by programs that control GDB."),
1648 set_async_annotation_level,
1649 show_annotation_level,
1650 &setlist, &showlist);
1652 add_setshow_boolean_cmd ("exec-done-display", class_support,
1653 &exec_done_display_p, _("\
1654 Set notification of completion for asynchronous execution commands."), _("\
1655 Show notification of completion for asynchronous execution commands."), _("\
1656 Use \"on\" to enable the notification, and \"off\" to disable it."),
1658 show_exec_done_display_p,
1659 &setlist, &showlist);
1663 gdb_init (char *argv0)
1665 if (pre_init_ui_hook)
1666 pre_init_ui_hook ();
1668 /* Run the init function of each source file */
1670 getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
1671 current_directory = gdb_dirbuf;
1674 /* Make sure we return to the original directory upon exit, come
1675 what may, since the OS doesn't do that for us. */
1676 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
1679 init_cmd_lists (); /* This needs to be done first */
1680 initialize_targets (); /* Setup target_terminal macros for utils.c */
1681 initialize_utils (); /* Make errors and warnings possible */
1682 initialize_all_files ();
1683 initialize_current_architecture ();
1685 init_main (); /* But that omits this file! Do it now */
1687 initialize_stdin_serial ();
1689 async_init_signals ();
1691 /* We need a default language for parsing expressions, so simple things like
1692 "set width 0" won't fail if no language is explicitly set in a config file
1693 or implicitly set by reading an executable during startup. */
1694 set_language (language_c);
1695 expected_language = current_language; /* don't warn about the change. */
1697 /* Allow another UI to initialize. If the UI fails to initialize,
1698 and it wants GDB to revert to the CLI, it should clear
1699 deprecated_init_ui_hook. */
1700 if (deprecated_init_ui_hook)
1701 deprecated_init_ui_hook (argv0);