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"
49 #include "gdbthread.h"
51 /* readline include files */
52 #include "readline/readline.h"
53 #include "readline/history.h"
55 /* readline defines this. */
58 #include <sys/types.h>
60 #include "event-top.h"
61 #include "gdb_string.h"
67 /* Default command line prompt. This is overriden in some configs. */
69 #ifndef DEFAULT_PROMPT
70 #define DEFAULT_PROMPT "(gdb) "
73 /* Initialization file name for gdb. This is overridden in some configs. */
77 # define PATH_MAX FILENAME_MAX
83 #ifndef GDBINIT_FILENAME
84 #define GDBINIT_FILENAME ".gdbinit"
86 char gdbinit
[PATH_MAX
+ 1] = GDBINIT_FILENAME
;
88 int inhibit_gdbinit
= 0;
90 /* If nonzero, and GDB has been configured to be able to use windows,
91 attempt to open them upon startup. */
95 extern char lang_frame_mismatch_warn
[]; /* language.c */
97 /* Flag for whether we want all the "from_tty" gubbish printed. */
99 int caution
= 1; /* Default is yes, sigh. */
101 show_caution (struct ui_file
*file
, int from_tty
,
102 struct cmd_list_element
*c
, const char *value
)
104 fprintf_filtered (file
, _("\
105 Whether to confirm potentially dangerous operations is %s.\n"),
109 /* stdio stream that command input is being read from. Set to stdin normally.
110 Set by source_command to the file we are sourcing. Set to NULL if we are
111 executing a user-defined command or interacting via a GUI. */
115 /* Flag to indicate whether a user defined command is currently running. */
119 /* Current working directory. */
121 char *current_directory
;
123 /* The directory name is actually stored here (usually). */
124 char gdb_dirbuf
[1024];
126 /* Function to call before reading a command, if nonzero.
127 The function receives two args: an input stream,
128 and a prompt string. */
130 void (*window_hook
) (FILE *, char *);
135 /* gdb prints this when reading a command interactively */
136 static char *gdb_prompt_string
; /* the global prompt string */
138 /* Buffer used for reading command lines, and the size
139 allocated for it so far. */
144 /* Nonzero if the current command is modified by "server ". This
145 affects things like recording into the command history, commands
146 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
147 whatever) can issue its own commands and also send along commands
148 from the user, and have the user not notice that the user interface
149 is issuing commands too. */
152 /* Baud rate specified for talking to serial target systems. Default
153 is left as -1, so targets can choose their own defaults. */
154 /* FIXME: This means that "show remotebaud" and gr_files_info can print -1
155 or (unsigned int)-1. This is a Bad User Interface. */
159 /* Timeout limit for response from target. */
161 /* The default value has been changed many times over the years. It
162 was originally 5 seconds. But that was thought to be a long time
163 to sit and wait, so it was changed to 2 seconds. That was thought
164 to be plenty unless the connection was going through some terminal
165 server or multiplexer or other form of hairy serial connection.
167 In mid-1996, remote_timeout was moved from remote.c to top.c and
168 it began being used in other remote-* targets. It appears that the
169 default was changed to 20 seconds at that time, perhaps because the
170 Renesas E7000 ICE didn't always respond in a timely manner.
172 But if 5 seconds is a long time to sit and wait for retransmissions,
173 20 seconds is far worse. This demonstrates the difficulty of using
174 a single variable for all protocol timeouts.
176 As remote.c is used much more than remote-e7000.c, it was changed
177 back to 2 seconds in 1999. */
179 int remote_timeout
= 2;
181 /* Non-zero tells remote* modules to output debugging info. */
183 int remote_debug
= 0;
185 /* Sbrk location on entry to main. Used for statistics only. */
190 /* Signal to catch ^Z typed while reading a command: SIGTSTP or SIGCONT. */
194 #define STOP_SIGNAL SIGTSTP
195 static void stop_sig (int);
199 /* Hooks for alternate command interfaces. */
201 /* Called after most modules have been initialized, but before taking users
204 If the UI fails to initialize and it wants GDB to continue
205 using the default UI, then it should clear this hook before returning. */
207 void (*deprecated_init_ui_hook
) (char *argv0
);
209 /* This hook is called from within gdb's many mini-event loops which could
210 steal control from a real user interface's event loop. It returns
211 non-zero if the user is requesting a detach, zero otherwise. */
213 int (*deprecated_ui_loop_hook
) (int);
215 /* Called instead of command_loop at top level. Can be invoked via
216 throw_exception(). */
218 void (*deprecated_command_loop_hook
) (void);
221 /* Called from print_frame_info to list the line we stopped in. */
223 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
, int line
,
224 int stopline
, int noerror
);
225 /* Replaces most of query. */
227 int (*deprecated_query_hook
) (const char *, va_list);
229 /* Replaces most of warning. */
231 void (*deprecated_warning_hook
) (const char *, va_list);
233 /* These three functions support getting lines of text from the user.
234 They are used in sequence. First deprecated_readline_begin_hook is
235 called with a text string that might be (for example) a message for
236 the user to type in a sequence of commands to be executed at a
237 breakpoint. If this function calls back to a GUI, it might take
238 this opportunity to pop up a text interaction window with this
239 message. Next, deprecated_readline_hook is called with a prompt
240 that is emitted prior to collecting the user input. It can be
241 called multiple times. Finally, deprecated_readline_end_hook is
242 called to notify the GUI that we are done with the interaction
243 window and it can close it. */
245 void (*deprecated_readline_begin_hook
) (char *, ...);
246 char *(*deprecated_readline_hook
) (char *);
247 void (*deprecated_readline_end_hook
) (void);
249 /* Called as appropriate to notify the interface that we have attached
250 to or detached from an already running process. */
252 void (*deprecated_attach_hook
) (void);
253 void (*deprecated_detach_hook
) (void);
255 /* Called during long calculations to allow GUI to repair window damage, and to
256 check for stop buttons, etc... */
258 void (*deprecated_interactive_hook
) (void);
260 /* Tell the GUI someone changed the register REGNO. -1 means
261 that the caller does not know which register changed or
262 that several registers have changed (see value_assign). */
263 void (*deprecated_register_changed_hook
) (int regno
);
265 /* Tell the GUI someone changed LEN bytes of memory at ADDR */
266 void (*deprecated_memory_changed_hook
) (CORE_ADDR addr
, int len
);
268 /* Called when going to wait for the target. Usually allows the GUI to run
269 while waiting for target events. */
271 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
272 struct target_waitstatus
* status
);
274 /* Used by UI as a wrapper around command execution. May do various things
275 like enabling/disabling buttons, etc... */
277 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
, char *cmd
,
280 /* Called after a `set' command has finished. Is only run if the
281 `set' command succeeded. */
283 void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
285 /* Called when the current thread changes. Argument is thread id. */
287 void (*deprecated_context_hook
) (int id
);
289 /* Takes control from error (). Typically used to prevent longjmps out of the
290 middle of the GUI. Usually used in conjunction with a catch routine. */
292 void (*deprecated_error_hook
) (void);
294 /* Handler for SIGHUP. */
297 /* NOTE 1999-04-29: This function will be static again, once we modify
298 gdb to use the event loop as the default command loop and we merge
299 event-top.c into this file, top.c */
303 caution
= 0; /* Throw caution to the wind -- we're exiting.
304 This prevents asking the user dumb questions. */
305 quit_command ((char *) 0, 0);
308 #endif /* defined SIGHUP */
310 /* Line number we are currently in in a file which is being sourced. */
311 /* NOTE 1999-04-29: This variable will be static again, once we modify
312 gdb to use the event loop as the default command loop and we merge
313 event-top.c into this file, top.c */
314 /* static */ int source_line_number
;
316 /* Name of the file we are sourcing. */
317 /* NOTE 1999-04-29: This variable will be static again, once we modify
318 gdb to use the event loop as the default command loop and we merge
319 event-top.c into this file, top.c */
320 /* static */ char *source_file_name
;
322 /* Clean up on error during a "source" command (or execution of a
323 user-defined command). */
326 do_restore_instream_cleanup (void *stream
)
328 /* Restore the previous input stream. */
332 /* Read commands from STREAM. */
334 read_command_file (FILE *stream
)
336 struct cleanup
*cleanups
;
338 cleanups
= make_cleanup (do_restore_instream_cleanup
, instream
);
341 do_cleanups (cleanups
);
344 void (*pre_init_ui_hook
) (void);
348 do_chdir_cleanup (void *old_dir
)
355 /* Execute the line P as a command.
356 Pass FROM_TTY as second argument to the defining function. */
358 /* Execute command P, in the current user context. */
361 execute_command (char *p
, int from_tty
)
363 struct cmd_list_element
*c
;
365 static int warned
= 0;
367 long time_at_cmd_start
= 0;
369 long space_at_cmd_start
= 0;
371 extern int display_time
;
372 extern int display_space
;
374 if (target_can_async_p ())
376 time_at_cmd_start
= get_run_time ();
381 char *lim
= (char *) sbrk (0);
382 space_at_cmd_start
= lim
- lim_at_start
;
389 /* Force cleanup of any alloca areas if using C alloca instead of
393 /* This can happen when command_line_input hits end of file. */
397 target_log_command (p
);
399 while (*p
== ' ' || *p
== '\t')
406 /* If trace-commands is set then this will print this command. */
407 print_command_trace (p
);
409 c
= lookup_cmd (&p
, cmdlist
, "", 0, 1);
411 /* If the selected thread has terminated, we allow only a
412 limited set of commands. */
413 if (target_can_async_p ()
414 && is_exited (inferior_ptid
)
415 && !get_cmd_no_selected_thread_ok (c
))
417 Cannot execute this command without a live selected thread. See `help thread'."));
419 /* Pass null arg rather than an empty one. */
422 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
423 while the is_complete_command(cfunc) test is just plain
424 bogus. They should both be replaced by a test of the form
425 c->strip_trailing_white_space_p. */
426 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
427 can't be replaced with func. This is because it is the
428 cfunc, and not the func, that has the value that the
429 is_complete_command hack is testing for. */
430 /* Clear off trailing whitespace, except for set and complete
433 && c
->type
!= set_cmd
434 && !is_complete_command (c
))
436 p
= arg
+ strlen (arg
) - 1;
437 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
442 /* If this command has been pre-hooked, run the hook first. */
443 execute_cmd_pre_hook (c
);
445 if (c
->flags
& DEPRECATED_WARN_USER
)
446 deprecated_cmd_warning (&line
);
448 if (c
->class == class_user
)
449 execute_user_command (c
, arg
);
450 else if (c
->type
== set_cmd
|| c
->type
== show_cmd
)
451 do_setshow_command (arg
, from_tty
& caution
, c
);
452 else if (!cmd_func_p (c
))
453 error (_("That is not a command, just a help topic."));
454 else if (deprecated_call_command_hook
)
455 deprecated_call_command_hook (c
, arg
, from_tty
& caution
);
457 cmd_func (c
, arg
, from_tty
& caution
);
459 /* If this command has been post-hooked, run the hook last. */
460 execute_cmd_post_hook (c
);
464 /* Tell the user if the language has changed (except first time). */
465 if (current_language
!= expected_language
)
467 if (language_mode
== language_mode_auto
)
469 language_info (1); /* Print what changed. */
474 /* Warn the user if the working language does not match the
475 language of the current frame. Only warn the user if we are
476 actually running the program, i.e. there is a stack. */
477 /* FIXME: This should be cacheing the frame and only running when
478 the frame changes. */
480 if (target_has_stack
&& !is_running (inferior_ptid
))
482 flang
= get_frame_language ();
484 && flang
!= language_unknown
485 && flang
!= current_language
->la_language
)
487 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
493 /* Read commands from `instream' and execute them
494 until end of file or error reading instream. */
499 struct cleanup
*old_chain
;
501 int stdin_is_tty
= ISATTY (stdin
);
502 long time_at_cmd_start
;
504 long space_at_cmd_start
= 0;
506 extern int display_time
;
507 extern int display_space
;
509 while (instream
&& !feof (instream
))
511 if (window_hook
&& instream
== stdin
)
512 (*window_hook
) (instream
, get_prompt ());
515 if (instream
== stdin
&& stdin_is_tty
)
516 reinitialize_more_filter ();
517 old_chain
= make_cleanup (null_cleanup
, 0);
519 /* Get a command-line. This calls the readline package. */
520 command
= command_line_input (instream
== stdin
?
521 get_prompt () : (char *) NULL
,
522 instream
== stdin
, "prompt");
526 time_at_cmd_start
= get_run_time ();
531 char *lim
= (char *) sbrk (0);
532 space_at_cmd_start
= lim
- lim_at_start
;
536 execute_command (command
, instream
== stdin
);
537 /* Do any commands attached to breakpoint we stopped at. */
538 bpstat_do_actions (&stop_bpstat
);
539 do_cleanups (old_chain
);
543 long cmd_time
= get_run_time () - time_at_cmd_start
;
545 printf_unfiltered (_("Command execution time: %ld.%06ld\n"),
546 cmd_time
/ 1000000, cmd_time
% 1000000);
552 char *lim
= (char *) sbrk (0);
553 long space_now
= lim
- lim_at_start
;
554 long space_diff
= space_now
- space_at_cmd_start
;
556 printf_unfiltered (_("Space used: %ld (%s%ld for this command)\n"),
558 (space_diff
>= 0 ? "+" : ""),
565 /* Commands call this if they do not want to be repeated by null lines. */
573 /* If we aren't reading from standard input, we are saving the last
574 thing read from stdin in line and don't want to delete it. Null lines
575 won't repeat here in any case. */
576 if (instream
== stdin
)
580 /* Read a line from the stream "instream" without command line editing.
582 It prints PROMPT_ARG once at the start.
583 Action is compatible with "readline", e.g. space for the result is
584 malloc'd and should be freed by the caller.
586 A NULL return means end of file. */
588 gdb_readline (char *prompt_arg
)
593 int result_size
= 80;
597 /* Don't use a _filtered function here. It causes the assumed
598 character position to be off, since the newline we read from
599 the user is not accounted for. */
600 fputs_unfiltered (prompt_arg
, gdb_stdout
);
601 gdb_flush (gdb_stdout
);
604 result
= (char *) xmalloc (result_size
);
608 /* Read from stdin if we are executing a user defined command.
609 This is the right thing for prompt_for_continue, at least. */
610 c
= fgetc (instream
? instream
: stdin
);
615 /* The last line does not end with a newline. Return it, and
616 if we are called again fgetc will still return EOF and
617 we'll return NULL then. */
625 if (input_index
> 0 && result
[input_index
- 1] == '\r')
630 result
[input_index
++] = c
;
631 while (input_index
>= result_size
)
634 result
= (char *) xrealloc (result
, result_size
);
638 result
[input_index
++] = '\0';
642 /* Variables which control command line editing and history
643 substitution. These variables are given default values at the end
645 static int command_editing_p
;
647 /* NOTE 1999-04-29: This variable will be static again, once we modify
648 gdb to use the event loop as the default command loop and we merge
649 event-top.c into this file, top.c */
651 /* static */ int history_expansion_p
;
653 static int write_history_p
;
655 show_write_history_p (struct ui_file
*file
, int from_tty
,
656 struct cmd_list_element
*c
, const char *value
)
658 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
662 static int history_size
;
664 show_history_size (struct ui_file
*file
, int from_tty
,
665 struct cmd_list_element
*c
, const char *value
)
667 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
671 static char *history_filename
;
673 show_history_filename (struct ui_file
*file
, int from_tty
,
674 struct cmd_list_element
*c
, const char *value
)
676 fprintf_filtered (file
, _("\
677 The filename in which to record the command history is \"%s\".\n"),
681 /* This is like readline(), but it has some gdb-specific behavior.
682 gdb may want readline in both the synchronous and async modes during
683 a single gdb invocation. At the ordinary top-level prompt we might
684 be using the async readline. That means we can't use
685 rl_pre_input_hook, since it doesn't work properly in async mode.
686 However, for a secondary prompt (" >", such as occurs during a
687 `define'), gdb wants a synchronous response.
689 We used to call readline() directly, running it in synchronous
690 mode. But mixing modes this way is not supported, and as of
691 readline 5.x it no longer works; the arrow keys come unbound during
692 the synchronous call. So we make a nested call into the event
693 loop. That's what gdb_readline_wrapper is for. */
695 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
696 rely on gdb_readline_wrapper_result, which might still be NULL if
697 the user types Control-D for EOF. */
698 static int gdb_readline_wrapper_done
;
700 /* The result of the current call to gdb_readline_wrapper, once a newline
702 static char *gdb_readline_wrapper_result
;
704 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
705 to be called after the newline is processed (which will redisplay
706 the prompt). But in gdb_readline_wrapper we will not get a new
707 prompt until the next call, or until we return to the event loop.
708 So we disable this hook around the newline and restore it before we
710 static void (*saved_after_char_processing_hook
) (void);
712 /* This function is called when readline has seen a complete line of
716 gdb_readline_wrapper_line (char *line
)
718 gdb_assert (!gdb_readline_wrapper_done
);
719 gdb_readline_wrapper_result
= line
;
720 gdb_readline_wrapper_done
= 1;
722 /* Prevent operate-and-get-next from acting too early. */
723 saved_after_char_processing_hook
= after_char_processing_hook
;
724 after_char_processing_hook
= NULL
;
726 /* Prevent parts of the prompt from being redisplayed if annotations
727 are enabled, and readline's state getting out of sync. */
728 if (async_command_editing_p
)
729 rl_callback_handler_remove ();
732 struct gdb_readline_wrapper_cleanup
734 void (*handler_orig
) (char *);
735 int already_prompted_orig
;
739 gdb_readline_wrapper_cleanup (void *arg
)
741 struct gdb_readline_wrapper_cleanup
*cleanup
= arg
;
743 rl_already_prompted
= cleanup
->already_prompted_orig
;
745 gdb_assert (input_handler
== gdb_readline_wrapper_line
);
746 input_handler
= cleanup
->handler_orig
;
747 gdb_readline_wrapper_result
= NULL
;
748 gdb_readline_wrapper_done
= 0;
750 after_char_processing_hook
= saved_after_char_processing_hook
;
751 saved_after_char_processing_hook
= NULL
;
757 gdb_readline_wrapper (char *prompt
)
759 struct cleanup
*back_to
;
760 struct gdb_readline_wrapper_cleanup
*cleanup
;
763 cleanup
= xmalloc (sizeof (*cleanup
));
764 cleanup
->handler_orig
= input_handler
;
765 input_handler
= gdb_readline_wrapper_line
;
767 cleanup
->already_prompted_orig
= rl_already_prompted
;
769 back_to
= make_cleanup (gdb_readline_wrapper_cleanup
, cleanup
);
771 /* Display our prompt and prevent double prompt display. */
772 display_gdb_prompt (prompt
);
773 rl_already_prompted
= 1;
775 if (after_char_processing_hook
)
776 (*after_char_processing_hook
) ();
777 gdb_assert (after_char_processing_hook
== NULL
);
779 /* gdb_do_one_event argument is unused. */
780 while (gdb_do_one_event (NULL
) >= 0)
781 if (gdb_readline_wrapper_done
)
784 retval
= gdb_readline_wrapper_result
;
785 do_cleanups (back_to
);
794 #if STOP_SIGNAL == SIGTSTP
795 signal (SIGTSTP
, SIG_DFL
);
801 sigprocmask (SIG_SETMASK
, &zero
, 0);
803 #elif HAVE_SIGSETMASK
806 kill (getpid (), SIGTSTP
);
807 signal (SIGTSTP
, stop_sig
);
809 signal (STOP_SIGNAL
, stop_sig
);
811 printf_unfiltered ("%s", get_prompt ());
812 gdb_flush (gdb_stdout
);
814 /* Forget about any previous command -- null line now will do nothing. */
817 #endif /* STOP_SIGNAL */
819 /* Initialize signal handlers. */
821 float_handler (int signo
)
823 /* This message is based on ANSI C, section 4.7. Note that integer
824 divide by zero causes this, so "float" is a misnomer. */
825 signal (SIGFPE
, float_handler
);
826 error (_("Erroneous arithmetic operation."));
830 do_nothing (int signo
)
832 /* Under System V the default disposition of a signal is reinstated after
833 the signal is caught and delivered to an application process. On such
834 systems one must restore the replacement signal handler if one wishes
835 to continue handling the signal in one's program. On BSD systems this
836 is not needed but it is harmless, and it simplifies the code to just do
837 it unconditionally. */
838 signal (signo
, do_nothing
);
841 /* The current saved history number from operate-and-get-next.
842 This is -1 if not valid. */
843 static int operate_saved_history
= -1;
845 /* This is put on the appropriate hook and helps operate-and-get-next
848 gdb_rl_operate_and_get_next_completion (void)
850 int delta
= where_history () - operate_saved_history
;
851 /* The `key' argument to rl_get_previous_history is ignored. */
852 rl_get_previous_history (delta
, 0);
853 operate_saved_history
= -1;
855 /* readline doesn't automatically update the display for us. */
858 after_char_processing_hook
= NULL
;
859 rl_pre_input_hook
= NULL
;
862 /* This is a gdb-local readline command handler. It accepts the
863 current command line (like RET does) and, if this command was taken
864 from the history, arranges for the next command in the history to
865 appear on the command line when the prompt returns.
866 We ignore the arguments. */
868 gdb_rl_operate_and_get_next (int count
, int key
)
872 /* Use the async hook. */
873 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
875 /* Find the current line, and find the next line to use. */
876 where
= where_history();
878 /* FIXME: kettenis/20020817: max_input_history is renamed into
879 history_max_entries in readline-4.2. When we do a new readline
880 import, we should probably change it here too, even though
881 readline maintains backwards compatibility for now by still
882 defining max_input_history. */
883 if ((history_is_stifled () && (history_length
>= max_input_history
)) ||
884 (where
>= history_length
- 1))
885 operate_saved_history
= where
;
887 operate_saved_history
= where
+ 1;
889 return rl_newline (1, key
);
892 /* Read one line from the command input stream `instream'
893 into the local static buffer `linebuffer' (whose current length
895 The buffer is made bigger as necessary.
896 Returns the address of the start of the line.
898 NULL is returned for end of file.
900 *If* the instream == stdin & stdin is a terminal, the line read
901 is copied into the file line saver (global var char *line,
902 length linesize) so that it can be duplicated.
904 This routine either uses fancy command line editing or
905 simple input as the user has requested. */
908 command_line_input (char *prompt_arg
, int repeat
, char *annotation_suffix
)
910 static char *linebuffer
= 0;
911 static unsigned linelength
= 0;
915 char *local_prompt
= prompt_arg
;
919 /* The annotation suffix must be non-NULL. */
920 if (annotation_suffix
== NULL
)
921 annotation_suffix
= "";
923 if (annotation_level
> 1 && instream
== stdin
)
925 local_prompt
= alloca ((prompt_arg
== NULL
? 0 : strlen (prompt_arg
))
926 + strlen (annotation_suffix
) + 40);
927 if (prompt_arg
== NULL
)
928 local_prompt
[0] = '\0';
930 strcpy (local_prompt
, prompt_arg
);
931 strcat (local_prompt
, "\n\032\032");
932 strcat (local_prompt
, annotation_suffix
);
933 strcat (local_prompt
, "\n");
939 linebuffer
= (char *) xmalloc (linelength
);
944 /* Control-C quits instantly if typed while in this loop
945 since it should not wait until the user types a newline. */
949 signal (STOP_SIGNAL
, handle_stop_sig
);
954 /* Make sure that all output has been output. Some machines may let
955 you get away with leaving out some of the gdb_flush, but not all. */
957 gdb_flush (gdb_stdout
);
958 gdb_flush (gdb_stderr
);
960 if (source_file_name
!= NULL
)
961 ++source_line_number
;
963 if (annotation_level
> 1 && instream
== stdin
)
965 puts_unfiltered ("\n\032\032pre-");
966 puts_unfiltered (annotation_suffix
);
967 puts_unfiltered ("\n");
970 /* Don't use fancy stuff if not talking to stdin. */
971 if (deprecated_readline_hook
&& input_from_terminal_p ())
973 rl
= (*deprecated_readline_hook
) (local_prompt
);
975 else if (command_editing_p
&& input_from_terminal_p ())
977 rl
= gdb_readline_wrapper (local_prompt
);
981 rl
= gdb_readline (local_prompt
);
984 if (annotation_level
> 1 && instream
== stdin
)
986 puts_unfiltered ("\n\032\032post-");
987 puts_unfiltered (annotation_suffix
);
988 puts_unfiltered ("\n");
991 if (!rl
|| rl
== (char *) EOF
)
996 if (strlen (rl
) + 1 + (p
- linebuffer
) > linelength
)
998 linelength
= strlen (rl
) + 1 + (p
- linebuffer
);
999 nline
= (char *) xrealloc (linebuffer
, linelength
);
1000 p
+= nline
- linebuffer
;
1004 /* Copy line. Don't copy null at end. (Leaves line alone
1005 if this was just a newline) */
1009 xfree (rl
); /* Allocated in readline. */
1011 if (p
== linebuffer
|| *(p
- 1) != '\\')
1014 p
--; /* Put on top of '\'. */
1015 local_prompt
= (char *) 0;
1020 signal (STOP_SIGNAL
, SIG_DFL
);
1027 #define SERVER_COMMAND_LENGTH 7
1029 (p
- linebuffer
> SERVER_COMMAND_LENGTH
)
1030 && strncmp (linebuffer
, "server ", SERVER_COMMAND_LENGTH
) == 0;
1033 /* Note that we don't set `line'. Between this and the check in
1034 dont_repeat, this insures that repeating will still do the
1037 return linebuffer
+ SERVER_COMMAND_LENGTH
;
1040 /* Do history expansion if that is wished. */
1041 if (history_expansion_p
&& instream
== stdin
1042 && ISATTY (instream
))
1044 char *history_value
;
1047 *p
= '\0'; /* Insert null now. */
1048 expanded
= history_expand (linebuffer
, &history_value
);
1051 /* Print the changes. */
1052 printf_unfiltered ("%s\n", history_value
);
1054 /* If there was an error, call this function again. */
1057 xfree (history_value
);
1058 return command_line_input (prompt_arg
, repeat
, annotation_suffix
);
1060 if (strlen (history_value
) > linelength
)
1062 linelength
= strlen (history_value
) + 1;
1063 linebuffer
= (char *) xrealloc (linebuffer
, linelength
);
1065 strcpy (linebuffer
, history_value
);
1066 p
= linebuffer
+ strlen (linebuffer
);
1068 xfree (history_value
);
1071 /* If we just got an empty line, and that is supposed
1072 to repeat the previous command, return the value in the
1074 if (repeat
&& p
== linebuffer
)
1076 for (p1
= linebuffer
; *p1
== ' ' || *p1
== '\t'; p1
++);
1082 /* Add line to history if appropriate. */
1083 if (instream
== stdin
1084 && ISATTY (stdin
) && *linebuffer
)
1085 add_history (linebuffer
);
1087 /* Note: lines consisting solely of comments are added to the command
1088 history. This is useful when you type a command, and then
1089 realize you don't want to execute it quite yet. You can comment
1090 out the command and then later fetch it from the value history
1091 and remove the '#'. The kill ring is probably better, but some
1092 people are in the habit of commenting things out. */
1094 *p1
= '\0'; /* Found a comment. */
1096 /* Save into global buffer if appropriate. */
1099 if (linelength
> linesize
)
1101 line
= xrealloc (line
, linelength
);
1102 linesize
= linelength
;
1104 strcpy (line
, linebuffer
);
1111 /* Print the GDB banner. */
1113 print_gdb_version (struct ui_file
*stream
)
1115 /* From GNU coding standards, first line is meant to be easy for a
1116 program to parse, and is just canonical program name and version
1117 number, which starts after last space. */
1119 fprintf_filtered (stream
, "GNU gdb %s%s\n", PKGVERSION
, version
);
1121 /* Second line is a copyright notice. */
1123 fprintf_filtered (stream
, "Copyright (C) 2008 Free Software Foundation, Inc.\n");
1125 /* Following the copyright is a brief statement that the program is
1126 free software, that users are free to copy and change it on
1127 certain conditions, that it is covered by the GNU GPL, and that
1128 there is no warranty. */
1130 fprintf_filtered (stream
, "\
1131 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n\
1132 This is free software: you are free to change and redistribute it.\n\
1133 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1134 and \"show warranty\" for details.\n");
1136 /* After the required info we print the configuration information. */
1138 fprintf_filtered (stream
, "This GDB was configured as \"");
1139 if (strcmp (host_name
, target_name
) != 0)
1141 fprintf_filtered (stream
, "--host=%s --target=%s", host_name
, target_name
);
1145 fprintf_filtered (stream
, "%s", host_name
);
1147 fprintf_filtered (stream
, "\".");
1149 if (REPORT_BUGS_TO
[0])
1151 fprintf_filtered (stream
,
1152 _("\nFor bug reporting instructions, please see:\n"));
1153 fprintf_filtered (stream
, "%s.", REPORT_BUGS_TO
);
1157 /* get_prompt: access method for the GDB prompt string. */
1166 set_prompt (char *s
)
1168 /* ??rehrauer: I don't know why this fails, since it looks as though
1169 assignments to prompt are wrapped in calls to savestring...
1173 PROMPT (0) = savestring (s
, strlen (s
));
1177 /* If necessary, make the user confirm that we should quit. Return
1178 non-zero if we should quit, zero if we shouldn't. */
1183 if (! ptid_equal (inferior_ptid
, null_ptid
) && target_has_execution
)
1187 /* This is something of a hack. But there's no reliable way to
1188 see if a GUI is running. The `use_windows' variable doesn't
1190 if (deprecated_init_ui_hook
)
1191 s
= "A debugging session is active.\nDo you still want to close the debugger?";
1192 else if (attach_flag
)
1193 s
= "The program is running. Quit anyway (and detach it)? ";
1195 s
= "The program is running. Quit anyway (and kill it)? ";
1197 if (!query ("%s", s
))
1204 /* Helper routine for quit_force that requires error handling. */
1213 quit_target (void *arg
)
1215 struct qt_args
*qt
= (struct qt_args
*)arg
;
1217 if (! ptid_equal (inferior_ptid
, null_ptid
) && target_has_execution
)
1220 target_detach (qt
->args
, qt
->from_tty
);
1225 /* UDI wants this, to kill the TIP. */
1226 target_close (¤t_target
, 1);
1228 /* Save the history information if it is appropriate to do so. */
1229 if (write_history_p
&& history_filename
)
1230 write_history (history_filename
);
1232 do_final_cleanups (ALL_CLEANUPS
); /* Do any final cleanups before exiting */
1237 /* Quit without asking for confirmation. */
1240 quit_force (char *args
, int from_tty
)
1245 /* An optional expression may be used to cause gdb to terminate with the
1246 value of that expression. */
1249 struct value
*val
= parse_and_eval (args
);
1251 exit_code
= (int) value_as_long (val
);
1253 else if (return_child_result
)
1254 exit_code
= return_child_result_value
;
1257 qt
.from_tty
= from_tty
;
1259 /* We want to handle any quit errors and exit regardless. */
1260 catch_errors (quit_target
, &qt
,
1261 "Quitting: ", RETURN_MASK_ALL
);
1266 /* Returns whether GDB is running on a terminal and input is
1267 currently coming from that terminal. */
1270 input_from_terminal_p (void)
1272 if (gdb_has_a_terminal () && instream
== stdin
)
1275 /* If INSTREAM is unset, and we are not in a user command, we
1276 must be in Insight. That's like having a terminal, for our
1278 if (instream
== NULL
&& !in_user_command
)
1285 dont_repeat_command (char *ignored
, int from_tty
)
1287 *line
= 0; /* Can't call dont_repeat here because we're not
1288 necessarily reading from stdin. */
1291 /* Functions to manipulate command line editing control variables. */
1293 /* Number of commands to print in each call to show_commands. */
1294 #define Hist_print 10
1296 show_commands (char *args
, int from_tty
)
1298 /* Index for history commands. Relative to history_base. */
1301 /* Number of the history entry which we are planning to display next.
1302 Relative to history_base. */
1305 /* The first command in the history which doesn't exist (i.e. one more
1306 than the number of the last command). Relative to history_base. */
1309 /* Print out some of the commands from the command history. */
1310 /* First determine the length of the history list. */
1311 hist_len
= history_size
;
1312 for (offset
= 0; offset
< history_size
; offset
++)
1314 if (!history_get (history_base
+ offset
))
1323 if (args
[0] == '+' && args
[1] == '\0')
1324 /* "info editing +" should print from the stored position. */
1327 /* "info editing <exp>" should print around command number <exp>. */
1328 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1330 /* "show commands" means print the last Hist_print commands. */
1333 num
= hist_len
- Hist_print
;
1339 /* If there are at least Hist_print commands, we want to display the last
1340 Hist_print rather than, say, the last 6. */
1341 if (hist_len
- num
< Hist_print
)
1343 num
= hist_len
- Hist_print
;
1348 for (offset
= num
; offset
< num
+ Hist_print
&& offset
< hist_len
; offset
++)
1350 printf_filtered ("%5d %s\n", history_base
+ offset
,
1351 (history_get (history_base
+ offset
))->line
);
1354 /* The next command we want to display is the next one that we haven't
1358 /* If the user repeats this command with return, it should do what
1359 "show commands +" does. This is unnecessary if arg is null,
1360 because "show commands +" is not useful after "show commands". */
1361 if (from_tty
&& args
)
1368 /* Called by do_setshow_command. */
1370 set_history_size_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1372 if (history_size
== INT_MAX
)
1373 unstifle_history ();
1374 else if (history_size
>= 0)
1375 stifle_history (history_size
);
1378 history_size
= INT_MAX
;
1379 error (_("History size must be non-negative"));
1384 set_history (char *args
, int from_tty
)
1386 printf_unfiltered (_("\"set history\" must be followed by the name of a history subcommand.\n"));
1387 help_list (sethistlist
, "set history ", -1, gdb_stdout
);
1391 show_history (char *args
, int from_tty
)
1393 cmd_show_list (showhistlist
, from_tty
, "");
1396 int info_verbose
= 0; /* Default verbose msgs off */
1398 /* Called by do_setshow_command. An elaborate joke. */
1400 set_verbose (char *args
, int from_tty
, struct cmd_list_element
*c
)
1402 char *cmdname
= "verbose";
1403 struct cmd_list_element
*showcmd
;
1405 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1409 c
->doc
= "Set verbose printing of informational messages.";
1410 showcmd
->doc
= "Show verbose printing of informational messages.";
1414 c
->doc
= "Set verbosity.";
1415 showcmd
->doc
= "Show verbosity.";
1419 /* Init the history buffer. Note that we are called after the init file(s)
1420 * have been read so that the user can change the history file via his
1421 * .gdbinit file (for instance). The GDBHISTFILE environment variable
1422 * overrides all of this.
1430 tmpenv
= getenv ("HISTSIZE");
1432 history_size
= atoi (tmpenv
);
1433 else if (!history_size
)
1436 stifle_history (history_size
);
1438 tmpenv
= getenv ("GDBHISTFILE");
1440 history_filename
= savestring (tmpenv
, strlen (tmpenv
));
1441 else if (!history_filename
)
1443 /* We include the current directory so that if the user changes
1444 directories the file written will be the same as the one
1447 /* No leading dots in file names are allowed on MSDOS. */
1448 history_filename
= concat (current_directory
, "/_gdb_history",
1451 history_filename
= concat (current_directory
, "/.gdb_history",
1455 read_history (history_filename
);
1459 show_new_async_prompt (struct ui_file
*file
, int from_tty
,
1460 struct cmd_list_element
*c
, const char *value
)
1462 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1466 show_async_command_editing_p (struct ui_file
*file
, int from_tty
,
1467 struct cmd_list_element
*c
, const char *value
)
1469 fprintf_filtered (file
, _("\
1470 Editing of command lines as they are typed is %s.\n"),
1475 show_annotation_level (struct ui_file
*file
, int from_tty
,
1476 struct cmd_list_element
*c
, const char *value
)
1478 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
1482 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
1483 struct cmd_list_element
*c
, const char *value
)
1485 fprintf_filtered (file
, _("\
1486 Notification of completion for asynchronous execution commands is %s.\n"),
1492 struct cmd_list_element
*c
;
1494 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1495 whatever the DEFAULT_PROMPT is. */
1496 the_prompts
.top
= 0;
1498 PROMPT (0) = savestring (DEFAULT_PROMPT
, strlen (DEFAULT_PROMPT
));
1500 /* Set things up for annotation_level > 1, if the user ever decides
1502 async_annotation_suffix
= "prompt";
1503 /* Set the variable associated with the setshow prompt command. */
1504 new_async_prompt
= savestring (PROMPT (0), strlen (PROMPT (0)));
1506 /* If gdb was started with --annotate=2, this is equivalent to the
1507 user entering the command 'set annotate 2' at the gdb prompt, so
1508 we need to do extra processing. */
1509 if (annotation_level
> 1)
1510 set_async_annotation_level (NULL
, 0, NULL
);
1512 /* Set the important stuff up for command editing. */
1513 command_editing_p
= 1;
1514 history_expansion_p
= 0;
1515 write_history_p
= 0;
1517 /* Setup important stuff for command line editing. */
1518 rl_completion_entry_function
= readline_line_completion_function
;
1519 rl_completer_word_break_characters
= default_word_break_characters ();
1520 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
1521 rl_readline_name
= "gdb";
1522 rl_terminal_name
= getenv ("TERM");
1524 /* The name for this defun comes from Bash, where it originated.
1525 15 is Control-o, the same binding this function has in Bash. */
1526 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
1528 add_setshow_string_cmd ("prompt", class_support
,
1529 &new_async_prompt
, _("\
1530 Set gdb's prompt"), _("\
1531 Show gdb's prompt"), NULL
,
1533 show_new_async_prompt
,
1534 &setlist
, &showlist
);
1536 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
1537 Don't repeat this command.\n\
1538 Primarily used inside of user-defined commands that should not be repeated when\n\
1541 add_setshow_boolean_cmd ("editing", class_support
,
1542 &async_command_editing_p
, _("\
1543 Set editing of command lines as they are typed."), _("\
1544 Show editing of command lines as they are typed."), _("\
1545 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1546 Without an argument, command line editing is enabled. To edit, use\n\
1547 EMACS-like or VI-like commands like control-P or ESC."),
1548 set_async_editing_command
,
1549 show_async_command_editing_p
,
1550 &setlist
, &showlist
);
1552 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
1553 Set saving of the history record on exit."), _("\
1554 Show saving of the history record on exit."), _("\
1555 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1556 Without an argument, saving is enabled."),
1558 show_write_history_p
,
1559 &sethistlist
, &showhistlist
);
1561 add_setshow_integer_cmd ("size", no_class
, &history_size
, _("\
1562 Set the size of the command history,"), _("\
1563 Show the size of the command history,"), _("\
1564 ie. the number of previous commands to keep a record of."),
1565 set_history_size_command
,
1567 &sethistlist
, &showhistlist
);
1569 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
1570 Set the filename in which to record the command history"), _("\
1571 Show the filename in which to record the command history"), _("\
1572 (the list of previous commands of which a record is kept)."),
1574 show_history_filename
,
1575 &sethistlist
, &showhistlist
);
1577 add_setshow_boolean_cmd ("confirm", class_support
, &caution
, _("\
1578 Set whether to confirm potentially dangerous operations."), _("\
1579 Show whether to confirm potentially dangerous operations."), NULL
,
1582 &setlist
, &showlist
);
1584 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
1585 Set annotation_level."), _("\
1586 Show annotation_level."), _("\
1587 0 == normal; 1 == fullname (for use when running under emacs)\n\
1588 2 == output annotated suitably for use by programs that control GDB."),
1589 set_async_annotation_level
,
1590 show_annotation_level
,
1591 &setlist
, &showlist
);
1593 add_setshow_boolean_cmd ("exec-done-display", class_support
,
1594 &exec_done_display_p
, _("\
1595 Set notification of completion for asynchronous execution commands."), _("\
1596 Show notification of completion for asynchronous execution commands."), _("\
1597 Use \"on\" to enable the notification, and \"off\" to disable it."),
1599 show_exec_done_display_p
,
1600 &setlist
, &showlist
);
1604 gdb_init (char *argv0
)
1606 if (pre_init_ui_hook
)
1607 pre_init_ui_hook ();
1609 /* Run the init function of each source file */
1611 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
1612 current_directory
= gdb_dirbuf
;
1615 /* Make sure we return to the original directory upon exit, come
1616 what may, since the OS doesn't do that for us. */
1617 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
1620 init_cmd_lists (); /* This needs to be done first */
1621 initialize_targets (); /* Setup target_terminal macros for utils.c */
1622 initialize_utils (); /* Make errors and warnings possible */
1623 initialize_all_files ();
1624 initialize_current_architecture ();
1626 init_main (); /* But that omits this file! Do it now */
1628 initialize_stdin_serial ();
1630 async_init_signals ();
1632 /* We need a default language for parsing expressions, so simple things like
1633 "set width 0" won't fail if no language is explicitly set in a config file
1634 or implicitly set by reading an executable during startup. */
1635 set_language (language_c
);
1636 expected_language
= current_language
; /* don't warn about the change. */
1638 /* Allow another UI to initialize. If the UI fails to initialize,
1639 and it wants GDB to revert to the CLI, it should clear
1640 deprecated_init_ui_hook. */
1641 if (deprecated_init_ui_hook
)
1642 deprecated_init_ui_hook (argv0
);