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 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 2 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, write to the Free Software
21 Foundation, Inc., 51 Franklin Street, Fifth Floor,
22 Boston, MA 02110-1301, USA. */
26 #include "call-cmds.h"
27 #include "cli/cli-cmds.h"
28 #include "cli/cli-script.h"
29 #include "cli/cli-setshow.h"
30 #include "cli/cli-decode.h"
33 #include "exceptions.h"
36 #include "breakpoint.h"
38 #include "expression.h"
41 #include "terminal.h" /* For job_control. */
43 #include "completer.h"
48 #include "gdb_assert.h"
50 #include "event-loop.h"
52 /* readline include files */
53 #include "readline/readline.h"
54 #include "readline/history.h"
56 /* readline defines this. */
59 #include <sys/types.h>
61 #include "event-top.h"
62 #include "gdb_string.h"
68 /* Default command line prompt. This is overriden in some configs. */
70 #ifndef DEFAULT_PROMPT
71 #define DEFAULT_PROMPT "(gdb) "
74 /* Initialization file name for gdb. This is overridden in some configs. */
78 # define PATH_MAX FILENAME_MAX
84 #ifndef GDBINIT_FILENAME
85 #define GDBINIT_FILENAME ".gdbinit"
87 char gdbinit
[PATH_MAX
+ 1] = GDBINIT_FILENAME
;
89 int inhibit_gdbinit
= 0;
91 /* If nonzero, and GDB has been configured to be able to use windows,
92 attempt to open them upon startup. */
96 extern char lang_frame_mismatch_warn
[]; /* language.c */
98 /* Flag for whether we want all the "from_tty" gubbish printed. */
100 int caution
= 1; /* Default is yes, sigh. */
102 show_caution (struct ui_file
*file
, int from_tty
,
103 struct cmd_list_element
*c
, const char *value
)
105 fprintf_filtered (file
, _("\
106 Whether to confirm potentially dangerous operations is %s.\n"),
110 /* stdio stream that command input is being read from. Set to stdin normally.
111 Set by source_command to the file we are sourcing. Set to NULL if we are
112 executing a user-defined command or interacting via a GUI. */
116 /* Flag to indicate whether a user defined command is currently running. */
120 /* Current working directory. */
122 char *current_directory
;
124 /* The directory name is actually stored here (usually). */
125 char gdb_dirbuf
[1024];
127 /* Function to call before reading a command, if nonzero.
128 The function receives two args: an input stream,
129 and a prompt string. */
131 void (*window_hook
) (FILE *, char *);
136 /* gdb prints this when reading a command interactively */
137 static char *gdb_prompt_string
; /* the global prompt string */
139 /* Buffer used for reading command lines, and the size
140 allocated for it so far. */
145 /* Nonzero if the current command is modified by "server ". This
146 affects things like recording into the command history, commands
147 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
148 whatever) can issue its own commands and also send along commands
149 from the user, and have the user not notice that the user interface
150 is issuing commands too. */
153 /* Baud rate specified for talking to serial target systems. Default
154 is left as -1, so targets can choose their own defaults. */
155 /* FIXME: This means that "show remotebaud" and gr_files_info can print -1
156 or (unsigned int)-1. This is a Bad User Interface. */
160 /* Timeout limit for response from target. */
162 /* The default value has been changed many times over the years. It
163 was originally 5 seconds. But that was thought to be a long time
164 to sit and wait, so it was changed to 2 seconds. That was thought
165 to be plenty unless the connection was going through some terminal
166 server or multiplexer or other form of hairy serial connection.
168 In mid-1996, remote_timeout was moved from remote.c to top.c and
169 it began being used in other remote-* targets. It appears that the
170 default was changed to 20 seconds at that time, perhaps because the
171 Renesas E7000 ICE didn't always respond in a timely manner.
173 But if 5 seconds is a long time to sit and wait for retransmissions,
174 20 seconds is far worse. This demonstrates the difficulty of using
175 a single variable for all protocol timeouts.
177 As remote.c is used much more than remote-e7000.c, it was changed
178 back to 2 seconds in 1999. */
180 int remote_timeout
= 2;
182 /* Non-zero tells remote* modules to output debugging info. */
184 int remote_debug
= 0;
186 /* Non-zero means the target is running. Note: this is different from
187 saying that there is an active target and we are stopped at a
188 breakpoint, for instance. This is a real indicator whether the
189 target is off and running, which gdb is doing something else. */
190 int target_executing
= 0;
192 /* Sbrk location on entry to main. Used for statistics only. */
197 /* Signal to catch ^Z typed while reading a command: SIGTSTP or SIGCONT. */
201 #define STOP_SIGNAL SIGTSTP
202 static void stop_sig (int);
206 /* Hooks for alternate command interfaces. */
208 /* Called after most modules have been initialized, but before taking users
211 If the UI fails to initialize and it wants GDB to continue
212 using the default UI, then it should clear this hook before returning. */
214 void (*deprecated_init_ui_hook
) (char *argv0
);
216 /* This hook is called from within gdb's many mini-event loops which could
217 steal control from a real user interface's event loop. It returns
218 non-zero if the user is requesting a detach, zero otherwise. */
220 int (*deprecated_ui_loop_hook
) (int);
222 /* Called instead of command_loop at top level. Can be invoked via
223 throw_exception(). */
225 void (*deprecated_command_loop_hook
) (void);
228 /* Called from print_frame_info to list the line we stopped in. */
230 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
, int line
,
231 int stopline
, int noerror
);
232 /* Replaces most of query. */
234 int (*deprecated_query_hook
) (const char *, va_list);
236 /* Replaces most of warning. */
238 void (*deprecated_warning_hook
) (const char *, va_list);
240 /* These three functions support getting lines of text from the user.
241 They are used in sequence. First deprecated_readline_begin_hook is
242 called with a text string that might be (for example) a message for
243 the user to type in a sequence of commands to be executed at a
244 breakpoint. If this function calls back to a GUI, it might take
245 this opportunity to pop up a text interaction window with this
246 message. Next, deprecated_readline_hook is called with a prompt
247 that is emitted prior to collecting the user input. It can be
248 called multiple times. Finally, deprecated_readline_end_hook is
249 called to notify the GUI that we are done with the interaction
250 window and it can close it. */
252 void (*deprecated_readline_begin_hook
) (char *, ...);
253 char *(*deprecated_readline_hook
) (char *);
254 void (*deprecated_readline_end_hook
) (void);
256 /* Called as appropriate to notify the interface of the specified breakpoint
259 void (*deprecated_create_breakpoint_hook
) (struct breakpoint
* bpt
);
260 void (*deprecated_delete_breakpoint_hook
) (struct breakpoint
* bpt
);
261 void (*deprecated_modify_breakpoint_hook
) (struct breakpoint
* bpt
);
263 /* Called as appropriate to notify the interface that we have attached
264 to or detached from an already running process. */
266 void (*deprecated_attach_hook
) (void);
267 void (*deprecated_detach_hook
) (void);
269 /* Called during long calculations to allow GUI to repair window damage, and to
270 check for stop buttons, etc... */
272 void (*deprecated_interactive_hook
) (void);
274 /* Called when the registers have changed, as a hint to a GUI
275 to minimize window update. */
277 void (*deprecated_registers_changed_hook
) (void);
279 /* Tell the GUI someone changed the register REGNO. -1 means
280 that the caller does not know which register changed or
281 that several registers have changed (see value_assign). */
282 void (*deprecated_register_changed_hook
) (int regno
);
284 /* Tell the GUI someone changed LEN bytes of memory at ADDR */
285 void (*deprecated_memory_changed_hook
) (CORE_ADDR addr
, int len
);
287 /* Called when going to wait for the target. Usually allows the GUI to run
288 while waiting for target events. */
290 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
291 struct target_waitstatus
* status
);
293 /* Used by UI as a wrapper around command execution. May do various things
294 like enabling/disabling buttons, etc... */
296 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
, char *cmd
,
299 /* Called after a `set' command has finished. Is only run if the
300 `set' command succeeded. */
302 void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
304 /* Called when the current thread changes. Argument is thread id. */
306 void (*deprecated_context_hook
) (int id
);
308 /* Takes control from error (). Typically used to prevent longjmps out of the
309 middle of the GUI. Usually used in conjunction with a catch routine. */
311 void (*deprecated_error_hook
) (void);
313 /* Handler for SIGHUP. */
316 /* NOTE 1999-04-29: This function will be static again, once we modify
317 gdb to use the event loop as the default command loop and we merge
318 event-top.c into this file, top.c */
322 caution
= 0; /* Throw caution to the wind -- we're exiting.
323 This prevents asking the user dumb questions. */
324 quit_command ((char *) 0, 0);
327 #endif /* defined SIGHUP */
329 /* Line number we are currently in in a file which is being sourced. */
330 /* NOTE 1999-04-29: This variable will be static again, once we modify
331 gdb to use the event loop as the default command loop and we merge
332 event-top.c into this file, top.c */
333 /* static */ int source_line_number
;
335 /* Name of the file we are sourcing. */
336 /* NOTE 1999-04-29: This variable will be static again, once we modify
337 gdb to use the event loop as the default command loop and we merge
338 event-top.c into this file, top.c */
339 /* static */ char *source_file_name
;
341 /* Clean up on error during a "source" command (or execution of a
342 user-defined command). */
345 do_restore_instream_cleanup (void *stream
)
347 /* Restore the previous input stream. */
351 /* Read commands from STREAM. */
353 read_command_file (FILE *stream
)
355 struct cleanup
*cleanups
;
357 cleanups
= make_cleanup (do_restore_instream_cleanup
, instream
);
360 do_cleanups (cleanups
);
363 void (*pre_init_ui_hook
) (void);
367 do_chdir_cleanup (void *old_dir
)
374 /* Execute the line P as a command.
375 Pass FROM_TTY as second argument to the defining function. */
378 execute_command (char *p
, int from_tty
)
380 struct cmd_list_element
*c
;
382 static int warned
= 0;
387 /* Force cleanup of any alloca areas if using C alloca instead of
391 /* This can happen when command_line_input hits end of file. */
395 serial_log_command (p
);
397 while (*p
== ' ' || *p
== '\t')
404 /* If trace-commands is set then this will print this command. */
405 print_command_trace (p
);
407 c
= lookup_cmd (&p
, cmdlist
, "", 0, 1);
409 /* If the target is running, we allow only a limited set of
411 if (target_can_async_p () && target_executing
)
412 if (strcmp (c
->name
, "help") != 0
413 && strcmp (c
->name
, "pwd") != 0
414 && strcmp (c
->name
, "show") != 0
415 && strcmp (c
->name
, "stop") != 0)
416 error (_("Cannot execute this command while the target is running."));
418 /* Pass null arg rather than an empty one. */
421 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
422 while the is_complete_command(cfunc) test is just plain
423 bogus. They should both be replaced by a test of the form
424 c->strip_trailing_white_space_p. */
425 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
426 can't be replaced with func. This is because it is the
427 cfunc, and not the func, that has the value that the
428 is_complete_command hack is testing for. */
429 /* Clear off trailing whitespace, except for set and complete
432 && c
->type
!= set_cmd
433 && !is_complete_command (c
))
435 p
= arg
+ strlen (arg
) - 1;
436 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
441 /* If this command has been pre-hooked, run the hook first. */
442 execute_cmd_pre_hook (c
);
444 if (c
->flags
& DEPRECATED_WARN_USER
)
445 deprecated_cmd_warning (&line
);
447 if (c
->class == class_user
)
448 execute_user_command (c
, arg
);
449 else if (c
->type
== set_cmd
|| c
->type
== show_cmd
)
450 do_setshow_command (arg
, from_tty
& caution
, c
);
451 else if (!cmd_func_p (c
))
452 error (_("That is not a command, just a help topic."));
453 else if (deprecated_call_command_hook
)
454 deprecated_call_command_hook (c
, arg
, from_tty
& caution
);
456 cmd_func (c
, arg
, from_tty
& caution
);
458 /* If this command has been post-hooked, run the hook last. */
459 execute_cmd_post_hook (c
);
463 /* Tell the user if the language has changed (except first time). */
464 if (current_language
!= expected_language
)
466 if (language_mode
== language_mode_auto
)
468 language_info (1); /* Print what changed. */
473 /* Warn the user if the working language does not match the
474 language of the current frame. Only warn the user if we are
475 actually running the program, i.e. there is a stack. */
476 /* FIXME: This should be cacheing the frame and only running when
477 the frame changes. */
479 if (target_has_stack
)
481 flang
= get_frame_language ();
483 && flang
!= language_unknown
484 && flang
!= current_language
->la_language
)
486 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
492 /* Read commands from `instream' and execute them
493 until end of file or error reading instream. */
498 struct cleanup
*old_chain
;
500 int stdin_is_tty
= ISATTY (stdin
);
501 long time_at_cmd_start
;
503 long space_at_cmd_start
= 0;
505 extern int display_time
;
506 extern int display_space
;
508 while (instream
&& !feof (instream
))
510 if (window_hook
&& instream
== stdin
)
511 (*window_hook
) (instream
, get_prompt ());
514 if (instream
== stdin
&& stdin_is_tty
)
515 reinitialize_more_filter ();
516 old_chain
= make_cleanup (null_cleanup
, 0);
518 /* Get a command-line. This calls the readline package. */
519 command
= command_line_input (instream
== stdin
?
520 get_prompt () : (char *) NULL
,
521 instream
== stdin
, "prompt");
525 time_at_cmd_start
= get_run_time ();
530 char *lim
= (char *) sbrk (0);
531 space_at_cmd_start
= lim
- lim_at_start
;
535 execute_command (command
, instream
== stdin
);
536 /* Do any commands attached to breakpoint we stopped at. */
537 bpstat_do_actions (&stop_bpstat
);
538 do_cleanups (old_chain
);
542 long cmd_time
= get_run_time () - time_at_cmd_start
;
544 printf_unfiltered (_("Command execution time: %ld.%06ld\n"),
545 cmd_time
/ 1000000, cmd_time
% 1000000);
551 char *lim
= (char *) sbrk (0);
552 long space_now
= lim
- lim_at_start
;
553 long space_diff
= space_now
- space_at_cmd_start
;
555 printf_unfiltered (_("Space used: %ld (%c%ld for this command)\n"),
557 (space_diff
>= 0 ? '+' : '-'),
564 /* Read commands from `instream' and execute them until end of file or
565 error reading instream. This command loop doesnt care about any
566 such things as displaying time and space usage. If the user asks
567 for those, they won't work. */
569 simplified_command_loop (char *(*read_input_func
) (char *),
570 void (*execute_command_func
) (char *, int))
572 struct cleanup
*old_chain
;
574 int stdin_is_tty
= ISATTY (stdin
);
576 while (instream
&& !feof (instream
))
579 if (instream
== stdin
&& stdin_is_tty
)
580 reinitialize_more_filter ();
581 old_chain
= make_cleanup (null_cleanup
, 0);
583 /* Get a command-line. */
584 command
= (*read_input_func
) (instream
== stdin
?
585 get_prompt () : (char *) NULL
);
590 (*execute_command_func
) (command
, instream
== stdin
);
592 /* Do any commands attached to breakpoint we stopped at. */
593 bpstat_do_actions (&stop_bpstat
);
595 do_cleanups (old_chain
);
599 /* Commands call this if they do not want to be repeated by null lines. */
607 /* If we aren't reading from standard input, we are saving the last
608 thing read from stdin in line and don't want to delete it. Null lines
609 won't repeat here in any case. */
610 if (instream
== stdin
)
614 /* Read a line from the stream "instream" without command line editing.
616 It prints PROMPT_ARG once at the start.
617 Action is compatible with "readline", e.g. space for the result is
618 malloc'd and should be freed by the caller.
620 A NULL return means end of file. */
622 gdb_readline (char *prompt_arg
)
627 int result_size
= 80;
631 /* Don't use a _filtered function here. It causes the assumed
632 character position to be off, since the newline we read from
633 the user is not accounted for. */
634 fputs_unfiltered (prompt_arg
, gdb_stdout
);
635 gdb_flush (gdb_stdout
);
638 result
= (char *) xmalloc (result_size
);
642 /* Read from stdin if we are executing a user defined command.
643 This is the right thing for prompt_for_continue, at least. */
644 c
= fgetc (instream
? instream
: stdin
);
649 /* The last line does not end with a newline. Return it, and
650 if we are called again fgetc will still return EOF and
651 we'll return NULL then. */
659 if (input_index
> 0 && result
[input_index
- 1] == '\r')
664 result
[input_index
++] = c
;
665 while (input_index
>= result_size
)
668 result
= (char *) xrealloc (result
, result_size
);
672 result
[input_index
++] = '\0';
676 /* Variables which control command line editing and history
677 substitution. These variables are given default values at the end
679 static int command_editing_p
;
681 /* NOTE 1999-04-29: This variable will be static again, once we modify
682 gdb to use the event loop as the default command loop and we merge
683 event-top.c into this file, top.c */
685 /* static */ int history_expansion_p
;
687 static int write_history_p
;
689 show_write_history_p (struct ui_file
*file
, int from_tty
,
690 struct cmd_list_element
*c
, const char *value
)
692 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
696 static int history_size
;
698 show_history_size (struct ui_file
*file
, int from_tty
,
699 struct cmd_list_element
*c
, const char *value
)
701 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
705 static char *history_filename
;
707 show_history_filename (struct ui_file
*file
, int from_tty
,
708 struct cmd_list_element
*c
, const char *value
)
710 fprintf_filtered (file
, _("\
711 The filename in which to record the command history is \"%s\".\n"),
715 /* This is like readline(), but it has some gdb-specific behavior.
716 gdb may want readline in both the synchronous and async modes during
717 a single gdb invocation. At the ordinary top-level prompt we might
718 be using the async readline. That means we can't use
719 rl_pre_input_hook, since it doesn't work properly in async mode.
720 However, for a secondary prompt (" >", such as occurs during a
721 `define'), gdb wants a synchronous response.
723 We used to call readline() directly, running it in synchronous
724 mode. But mixing modes this way is not supported, and as of
725 readline 5.x it no longer works; the arrow keys come unbound during
726 the synchronous call. So we make a nested call into the event
727 loop. That's what gdb_readline_wrapper is for. */
729 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
730 rely on gdb_readline_wrapper_result, which might still be NULL if
731 the user types Control-D for EOF. */
732 static int gdb_readline_wrapper_done
;
734 /* The result of the current call to gdb_readline_wrapper, once a newline
736 static char *gdb_readline_wrapper_result
;
738 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
739 to be called after the newline is processed (which will redisplay
740 the prompt). But in gdb_readline_wrapper we will not get a new
741 prompt until the next call, or until we return to the event loop.
742 So we disable this hook around the newline and restore it before we
744 static void (*saved_after_char_processing_hook
) (void);
746 /* This function is called when readline has seen a complete line of
750 gdb_readline_wrapper_line (char *line
)
752 gdb_assert (!gdb_readline_wrapper_done
);
753 gdb_readline_wrapper_result
= line
;
754 gdb_readline_wrapper_done
= 1;
756 /* Prevent operate-and-get-next from acting too early. */
757 saved_after_char_processing_hook
= after_char_processing_hook
;
758 after_char_processing_hook
= NULL
;
761 struct gdb_readline_wrapper_cleanup
763 void (*handler_orig
) (char *);
765 int already_prompted_orig
;
769 gdb_readline_wrapper_cleanup (void *arg
)
771 struct gdb_readline_wrapper_cleanup
*cleanup
= arg
;
773 gdb_assert (rl_already_prompted
== 1);
774 rl_already_prompted
= cleanup
->already_prompted_orig
;
775 PROMPT (0) = cleanup
->prompt_orig
;
777 gdb_assert (input_handler
== gdb_readline_wrapper_line
);
778 input_handler
= cleanup
->handler_orig
;
779 gdb_readline_wrapper_result
= NULL
;
780 gdb_readline_wrapper_done
= 0;
782 after_char_processing_hook
= saved_after_char_processing_hook
;
783 saved_after_char_processing_hook
= NULL
;
789 gdb_readline_wrapper (char *prompt
)
791 struct cleanup
*back_to
;
792 struct gdb_readline_wrapper_cleanup
*cleanup
;
795 cleanup
= xmalloc (sizeof (*cleanup
));
796 cleanup
->handler_orig
= input_handler
;
797 input_handler
= gdb_readline_wrapper_line
;
799 cleanup
->prompt_orig
= get_prompt ();
801 cleanup
->already_prompted_orig
= rl_already_prompted
;
803 back_to
= make_cleanup (gdb_readline_wrapper_cleanup
, cleanup
);
805 /* Display our prompt and prevent double prompt display. */
806 display_gdb_prompt (NULL
);
807 rl_already_prompted
= 1;
809 if (after_char_processing_hook
)
810 (*after_char_processing_hook
) ();
811 gdb_assert (after_char_processing_hook
== NULL
);
813 /* gdb_do_one_event argument is unused. */
814 while (gdb_do_one_event (NULL
) >= 0)
815 if (gdb_readline_wrapper_done
)
818 retval
= gdb_readline_wrapper_result
;
819 do_cleanups (back_to
);
828 #if STOP_SIGNAL == SIGTSTP
829 signal (SIGTSTP
, SIG_DFL
);
835 sigprocmask (SIG_SETMASK
, &zero
, 0);
837 #elif HAVE_SIGSETMASK
840 kill (getpid (), SIGTSTP
);
841 signal (SIGTSTP
, stop_sig
);
843 signal (STOP_SIGNAL
, stop_sig
);
845 printf_unfiltered ("%s", get_prompt ());
846 gdb_flush (gdb_stdout
);
848 /* Forget about any previous command -- null line now will do nothing. */
851 #endif /* STOP_SIGNAL */
853 /* Initialize signal handlers. */
855 float_handler (int signo
)
857 /* This message is based on ANSI C, section 4.7. Note that integer
858 divide by zero causes this, so "float" is a misnomer. */
859 signal (SIGFPE
, float_handler
);
860 error (_("Erroneous arithmetic operation."));
864 do_nothing (int signo
)
866 /* Under System V the default disposition of a signal is reinstated after
867 the signal is caught and delivered to an application process. On such
868 systems one must restore the replacement signal handler if one wishes
869 to continue handling the signal in one's program. On BSD systems this
870 is not needed but it is harmless, and it simplifies the code to just do
871 it unconditionally. */
872 signal (signo
, do_nothing
);
875 /* The current saved history number from operate-and-get-next.
876 This is -1 if not valid. */
877 static int operate_saved_history
= -1;
879 /* This is put on the appropriate hook and helps operate-and-get-next
882 gdb_rl_operate_and_get_next_completion (void)
884 int delta
= where_history () - operate_saved_history
;
885 /* The `key' argument to rl_get_previous_history is ignored. */
886 rl_get_previous_history (delta
, 0);
887 operate_saved_history
= -1;
889 /* readline doesn't automatically update the display for us. */
892 after_char_processing_hook
= NULL
;
893 rl_pre_input_hook
= NULL
;
896 /* This is a gdb-local readline command handler. It accepts the
897 current command line (like RET does) and, if this command was taken
898 from the history, arranges for the next command in the history to
899 appear on the command line when the prompt returns.
900 We ignore the arguments. */
902 gdb_rl_operate_and_get_next (int count
, int key
)
906 /* Use the async hook. */
907 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
909 /* Find the current line, and find the next line to use. */
910 where
= where_history();
912 /* FIXME: kettenis/20020817: max_input_history is renamed into
913 history_max_entries in readline-4.2. When we do a new readline
914 import, we should probably change it here too, even though
915 readline maintains backwards compatibility for now by still
916 defining max_input_history. */
917 if ((history_is_stifled () && (history_length
>= max_input_history
)) ||
918 (where
>= history_length
- 1))
919 operate_saved_history
= where
;
921 operate_saved_history
= where
+ 1;
923 return rl_newline (1, key
);
926 /* Read one line from the command input stream `instream'
927 into the local static buffer `linebuffer' (whose current length
929 The buffer is made bigger as necessary.
930 Returns the address of the start of the line.
932 NULL is returned for end of file.
934 *If* the instream == stdin & stdin is a terminal, the line read
935 is copied into the file line saver (global var char *line,
936 length linesize) so that it can be duplicated.
938 This routine either uses fancy command line editing or
939 simple input as the user has requested. */
942 command_line_input (char *prompt_arg
, int repeat
, char *annotation_suffix
)
944 static char *linebuffer
= 0;
945 static unsigned linelength
= 0;
949 char *local_prompt
= prompt_arg
;
953 /* The annotation suffix must be non-NULL. */
954 if (annotation_suffix
== NULL
)
955 annotation_suffix
= "";
957 if (annotation_level
> 1 && instream
== stdin
)
959 local_prompt
= alloca ((prompt_arg
== NULL
? 0 : strlen (prompt_arg
))
960 + strlen (annotation_suffix
) + 40);
961 if (prompt_arg
== NULL
)
962 local_prompt
[0] = '\0';
964 strcpy (local_prompt
, prompt_arg
);
965 strcat (local_prompt
, "\n\032\032");
966 strcat (local_prompt
, annotation_suffix
);
967 strcat (local_prompt
, "\n");
973 linebuffer
= (char *) xmalloc (linelength
);
978 /* Control-C quits instantly if typed while in this loop
979 since it should not wait until the user types a newline. */
983 signal (STOP_SIGNAL
, handle_stop_sig
);
988 /* Make sure that all output has been output. Some machines may let
989 you get away with leaving out some of the gdb_flush, but not all. */
991 gdb_flush (gdb_stdout
);
992 gdb_flush (gdb_stderr
);
994 if (source_file_name
!= NULL
)
995 ++source_line_number
;
997 if (annotation_level
> 1 && instream
== stdin
)
999 puts_unfiltered ("\n\032\032pre-");
1000 puts_unfiltered (annotation_suffix
);
1001 puts_unfiltered ("\n");
1004 /* Don't use fancy stuff if not talking to stdin. */
1005 if (deprecated_readline_hook
&& input_from_terminal_p ())
1007 rl
= (*deprecated_readline_hook
) (local_prompt
);
1009 else if (command_editing_p
&& input_from_terminal_p ())
1011 rl
= gdb_readline_wrapper (local_prompt
);
1015 rl
= gdb_readline (local_prompt
);
1018 if (annotation_level
> 1 && instream
== stdin
)
1020 puts_unfiltered ("\n\032\032post-");
1021 puts_unfiltered (annotation_suffix
);
1022 puts_unfiltered ("\n");
1025 if (!rl
|| rl
== (char *) EOF
)
1030 if (strlen (rl
) + 1 + (p
- linebuffer
) > linelength
)
1032 linelength
= strlen (rl
) + 1 + (p
- linebuffer
);
1033 nline
= (char *) xrealloc (linebuffer
, linelength
);
1034 p
+= nline
- linebuffer
;
1038 /* Copy line. Don't copy null at end. (Leaves line alone
1039 if this was just a newline) */
1043 xfree (rl
); /* Allocated in readline. */
1045 if (p
== linebuffer
|| *(p
- 1) != '\\')
1048 p
--; /* Put on top of '\'. */
1049 local_prompt
= (char *) 0;
1054 signal (STOP_SIGNAL
, SIG_DFL
);
1061 #define SERVER_COMMAND_LENGTH 7
1063 (p
- linebuffer
> SERVER_COMMAND_LENGTH
)
1064 && strncmp (linebuffer
, "server ", SERVER_COMMAND_LENGTH
) == 0;
1067 /* Note that we don't set `line'. Between this and the check in
1068 dont_repeat, this insures that repeating will still do the
1071 return linebuffer
+ SERVER_COMMAND_LENGTH
;
1074 /* Do history expansion if that is wished. */
1075 if (history_expansion_p
&& instream
== stdin
1076 && ISATTY (instream
))
1078 char *history_value
;
1081 *p
= '\0'; /* Insert null now. */
1082 expanded
= history_expand (linebuffer
, &history_value
);
1085 /* Print the changes. */
1086 printf_unfiltered ("%s\n", history_value
);
1088 /* If there was an error, call this function again. */
1091 xfree (history_value
);
1092 return command_line_input (prompt_arg
, repeat
, annotation_suffix
);
1094 if (strlen (history_value
) > linelength
)
1096 linelength
= strlen (history_value
) + 1;
1097 linebuffer
= (char *) xrealloc (linebuffer
, linelength
);
1099 strcpy (linebuffer
, history_value
);
1100 p
= linebuffer
+ strlen (linebuffer
);
1101 xfree (history_value
);
1105 /* If we just got an empty line, and that is supposed
1106 to repeat the previous command, return the value in the
1108 if (repeat
&& p
== linebuffer
)
1110 for (p1
= linebuffer
; *p1
== ' ' || *p1
== '\t'; p1
++);
1116 /* Add line to history if appropriate. */
1117 if (instream
== stdin
1118 && ISATTY (stdin
) && *linebuffer
)
1119 add_history (linebuffer
);
1121 /* Note: lines consisting solely of comments are added to the command
1122 history. This is useful when you type a command, and then
1123 realize you don't want to execute it quite yet. You can comment
1124 out the command and then later fetch it from the value history
1125 and remove the '#'. The kill ring is probably better, but some
1126 people are in the habit of commenting things out. */
1128 *p1
= '\0'; /* Found a comment. */
1130 /* Save into global buffer if appropriate. */
1133 if (linelength
> linesize
)
1135 line
= xrealloc (line
, linelength
);
1136 linesize
= linelength
;
1138 strcpy (line
, linebuffer
);
1145 /* Print the GDB banner. */
1147 print_gdb_version (struct ui_file
*stream
)
1149 /* From GNU coding standards, first line is meant to be easy for a
1150 program to parse, and is just canonical program name and version
1151 number, which starts after last space. */
1153 fprintf_filtered (stream
, "GNU gdb %s\n", version
);
1155 /* Second line is a copyright notice. */
1157 fprintf_filtered (stream
, "Copyright (C) 2007 Free Software Foundation, Inc.\n");
1159 /* Following the copyright is a brief statement that the program is
1160 free software, that users are free to copy and change it on
1161 certain conditions, that it is covered by the GNU GPL, and that
1162 there is no warranty. */
1164 fprintf_filtered (stream
, "\
1165 GDB is free software, covered by the GNU General Public License, and you are\n\
1166 welcome to change it and/or distribute copies of it under certain conditions.\n\
1167 Type \"show copying\" to see the conditions.\n\
1168 There is absolutely no warranty for GDB. Type \"show warranty\" for details.\n");
1170 /* After the required info we print the configuration information. */
1172 fprintf_filtered (stream
, "This GDB was configured as \"");
1173 if (strcmp (host_name
, target_name
) != 0)
1175 fprintf_filtered (stream
, "--host=%s --target=%s", host_name
, target_name
);
1179 fprintf_filtered (stream
, "%s", host_name
);
1181 fprintf_filtered (stream
, "\".");
1184 /* get_prompt: access method for the GDB prompt string. */
1193 set_prompt (char *s
)
1195 /* ??rehrauer: I don't know why this fails, since it looks as though
1196 assignments to prompt are wrapped in calls to savestring...
1200 PROMPT (0) = savestring (s
, strlen (s
));
1204 /* If necessary, make the user confirm that we should quit. Return
1205 non-zero if we should quit, zero if we shouldn't. */
1210 if (! ptid_equal (inferior_ptid
, null_ptid
) && target_has_execution
)
1214 /* This is something of a hack. But there's no reliable way to
1215 see if a GUI is running. The `use_windows' variable doesn't
1217 if (deprecated_init_ui_hook
)
1218 s
= "A debugging session is active.\nDo you still want to close the debugger?";
1219 else if (attach_flag
)
1220 s
= "The program is running. Quit anyway (and detach it)? ";
1222 s
= "The program is running. Exit anyway? ";
1224 if (!query ("%s", s
))
1231 /* Helper routine for quit_force that requires error handling. */
1240 quit_target (void *arg
)
1242 struct qt_args
*qt
= (struct qt_args
*)arg
;
1244 if (! ptid_equal (inferior_ptid
, null_ptid
) && target_has_execution
)
1247 target_detach (qt
->args
, qt
->from_tty
);
1252 /* UDI wants this, to kill the TIP. */
1253 target_close (¤t_target
, 1);
1255 /* Save the history information if it is appropriate to do so. */
1256 if (write_history_p
&& history_filename
)
1257 write_history (history_filename
);
1259 do_final_cleanups (ALL_CLEANUPS
); /* Do any final cleanups before exiting */
1264 /* Quit without asking for confirmation. */
1267 quit_force (char *args
, int from_tty
)
1272 /* An optional expression may be used to cause gdb to terminate with the
1273 value of that expression. */
1276 struct value
*val
= parse_and_eval (args
);
1278 exit_code
= (int) value_as_long (val
);
1280 else if (return_child_result
)
1281 exit_code
= return_child_result_value
;
1284 qt
.from_tty
= from_tty
;
1286 /* We want to handle any quit errors and exit regardless. */
1287 catch_errors (quit_target
, &qt
,
1288 "Quitting: ", RETURN_MASK_ALL
);
1293 /* Returns whether GDB is running on a terminal and input is
1294 currently coming from that terminal. */
1297 input_from_terminal_p (void)
1299 if (gdb_has_a_terminal () && instream
== stdin
)
1302 /* If INSTREAM is unset, and we are not in a user command, we
1303 must be in Insight. That's like having a terminal, for our
1305 if (instream
== NULL
&& !in_user_command
)
1312 dont_repeat_command (char *ignored
, int from_tty
)
1314 *line
= 0; /* Can't call dont_repeat here because we're not
1315 necessarily reading from stdin. */
1318 /* Functions to manipulate command line editing control variables. */
1320 /* Number of commands to print in each call to show_commands. */
1321 #define Hist_print 10
1323 show_commands (char *args
, int from_tty
)
1325 /* Index for history commands. Relative to history_base. */
1328 /* Number of the history entry which we are planning to display next.
1329 Relative to history_base. */
1332 /* The first command in the history which doesn't exist (i.e. one more
1333 than the number of the last command). Relative to history_base. */
1336 /* Print out some of the commands from the command history. */
1337 /* First determine the length of the history list. */
1338 hist_len
= history_size
;
1339 for (offset
= 0; offset
< history_size
; offset
++)
1341 if (!history_get (history_base
+ offset
))
1350 if (args
[0] == '+' && args
[1] == '\0')
1351 /* "info editing +" should print from the stored position. */
1354 /* "info editing <exp>" should print around command number <exp>. */
1355 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1357 /* "show commands" means print the last Hist_print commands. */
1360 num
= hist_len
- Hist_print
;
1366 /* If there are at least Hist_print commands, we want to display the last
1367 Hist_print rather than, say, the last 6. */
1368 if (hist_len
- num
< Hist_print
)
1370 num
= hist_len
- Hist_print
;
1375 for (offset
= num
; offset
< num
+ Hist_print
&& offset
< hist_len
; offset
++)
1377 printf_filtered ("%5d %s\n", history_base
+ offset
,
1378 (history_get (history_base
+ offset
))->line
);
1381 /* The next command we want to display is the next one that we haven't
1385 /* If the user repeats this command with return, it should do what
1386 "show commands +" does. This is unnecessary if arg is null,
1387 because "show commands +" is not useful after "show commands". */
1388 if (from_tty
&& args
)
1395 /* Called by do_setshow_command. */
1397 set_history_size_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1399 if (history_size
== INT_MAX
)
1400 unstifle_history ();
1401 else if (history_size
>= 0)
1402 stifle_history (history_size
);
1405 history_size
= INT_MAX
;
1406 error (_("History size must be non-negative"));
1411 set_history (char *args
, int from_tty
)
1413 printf_unfiltered (_("\"set history\" must be followed by the name of a history subcommand.\n"));
1414 help_list (sethistlist
, "set history ", -1, gdb_stdout
);
1418 show_history (char *args
, int from_tty
)
1420 cmd_show_list (showhistlist
, from_tty
, "");
1423 int info_verbose
= 0; /* Default verbose msgs off */
1425 /* Called by do_setshow_command. An elaborate joke. */
1427 set_verbose (char *args
, int from_tty
, struct cmd_list_element
*c
)
1429 char *cmdname
= "verbose";
1430 struct cmd_list_element
*showcmd
;
1432 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1436 c
->doc
= "Set verbose printing of informational messages.";
1437 showcmd
->doc
= "Show verbose printing of informational messages.";
1441 c
->doc
= "Set verbosity.";
1442 showcmd
->doc
= "Show verbosity.";
1446 /* Init the history buffer. Note that we are called after the init file(s)
1447 * have been read so that the user can change the history file via his
1448 * .gdbinit file (for instance). The GDBHISTFILE environment variable
1449 * overrides all of this.
1457 tmpenv
= getenv ("HISTSIZE");
1459 history_size
= atoi (tmpenv
);
1460 else if (!history_size
)
1463 stifle_history (history_size
);
1465 tmpenv
= getenv ("GDBHISTFILE");
1467 history_filename
= savestring (tmpenv
, strlen (tmpenv
));
1468 else if (!history_filename
)
1470 /* We include the current directory so that if the user changes
1471 directories the file written will be the same as the one
1474 /* No leading dots in file names are allowed on MSDOS. */
1475 history_filename
= concat (current_directory
, "/_gdb_history",
1478 history_filename
= concat (current_directory
, "/.gdb_history",
1482 read_history (history_filename
);
1486 show_new_async_prompt (struct ui_file
*file
, int from_tty
,
1487 struct cmd_list_element
*c
, const char *value
)
1489 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1493 show_async_command_editing_p (struct ui_file
*file
, int from_tty
,
1494 struct cmd_list_element
*c
, const char *value
)
1496 fprintf_filtered (file
, _("\
1497 Editing of command lines as they are typed is %s.\n"),
1502 show_annotation_level (struct ui_file
*file
, int from_tty
,
1503 struct cmd_list_element
*c
, const char *value
)
1505 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
1509 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
1510 struct cmd_list_element
*c
, const char *value
)
1512 fprintf_filtered (file
, _("\
1513 Notification of completion for asynchronous execution commands is %s.\n"),
1519 struct cmd_list_element
*c
;
1521 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1522 whatever the DEFAULT_PROMPT is. */
1523 the_prompts
.top
= 0;
1525 PROMPT (0) = savestring (DEFAULT_PROMPT
, strlen (DEFAULT_PROMPT
));
1527 /* Set things up for annotation_level > 1, if the user ever decides
1529 async_annotation_suffix
= "prompt";
1530 /* Set the variable associated with the setshow prompt command. */
1531 new_async_prompt
= savestring (PROMPT (0), strlen (PROMPT (0)));
1533 /* If gdb was started with --annotate=2, this is equivalent to the
1534 user entering the command 'set annotate 2' at the gdb prompt, so
1535 we need to do extra processing. */
1536 if (annotation_level
> 1)
1537 set_async_annotation_level (NULL
, 0, NULL
);
1539 /* Set the important stuff up for command editing. */
1540 command_editing_p
= 1;
1541 history_expansion_p
= 0;
1542 write_history_p
= 0;
1544 /* Setup important stuff for command line editing. */
1545 rl_completion_entry_function
= readline_line_completion_function
;
1546 rl_completer_word_break_characters
= default_word_break_characters ();
1547 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
1548 rl_readline_name
= "gdb";
1549 rl_terminal_name
= getenv ("TERM");
1551 /* The name for this defun comes from Bash, where it originated.
1552 15 is Control-o, the same binding this function has in Bash. */
1553 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
1555 add_setshow_string_cmd ("prompt", class_support
,
1556 &new_async_prompt
, _("\
1557 Set gdb's prompt"), _("\
1558 Show gdb's prompt"), NULL
,
1560 show_new_async_prompt
,
1561 &setlist
, &showlist
);
1563 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
1564 Don't repeat this command.\n\
1565 Primarily used inside of user-defined commands that should not be repeated when\n\
1568 add_setshow_boolean_cmd ("editing", class_support
,
1569 &async_command_editing_p
, _("\
1570 Set editing of command lines as they are typed."), _("\
1571 Show editing of command lines as they are typed."), _("\
1572 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1573 Without an argument, command line editing is enabled. To edit, use\n\
1574 EMACS-like or VI-like commands like control-P or ESC."),
1575 set_async_editing_command
,
1576 show_async_command_editing_p
,
1577 &setlist
, &showlist
);
1579 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
1580 Set saving of the history record on exit."), _("\
1581 Show saving of the history record on exit."), _("\
1582 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1583 Without an argument, saving is enabled."),
1585 show_write_history_p
,
1586 &sethistlist
, &showhistlist
);
1588 add_setshow_integer_cmd ("size", no_class
, &history_size
, _("\
1589 Set the size of the command history,"), _("\
1590 Show the size of the command history,"), _("\
1591 ie. the number of previous commands to keep a record of."),
1592 set_history_size_command
,
1594 &sethistlist
, &showhistlist
);
1596 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
1597 Set the filename in which to record the command history"), _("\
1598 Show the filename in which to record the command history"), _("\
1599 (the list of previous commands of which a record is kept)."),
1601 show_history_filename
,
1602 &sethistlist
, &showhistlist
);
1604 add_setshow_boolean_cmd ("confirm", class_support
, &caution
, _("\
1605 Set whether to confirm potentially dangerous operations."), _("\
1606 Show whether to confirm potentially dangerous operations."), NULL
,
1609 &setlist
, &showlist
);
1611 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
1612 Set annotation_level."), _("\
1613 Show annotation_level."), _("\
1614 0 == normal; 1 == fullname (for use when running under emacs)\n\
1615 2 == output annotated suitably for use by programs that control GDB."),
1616 set_async_annotation_level
,
1617 show_annotation_level
,
1618 &setlist
, &showlist
);
1620 add_setshow_boolean_cmd ("exec-done-display", class_support
,
1621 &exec_done_display_p
, _("\
1622 Set notification of completion for asynchronous execution commands."), _("\
1623 Show notification of completion for asynchronous execution commands."), _("\
1624 Use \"on\" to enable the notification, and \"off\" to disable it."),
1626 show_exec_done_display_p
,
1627 &setlist
, &showlist
);
1631 gdb_init (char *argv0
)
1633 if (pre_init_ui_hook
)
1634 pre_init_ui_hook ();
1636 /* Run the init function of each source file */
1638 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
1639 current_directory
= gdb_dirbuf
;
1642 /* Make sure we return to the original directory upon exit, come
1643 what may, since the OS doesn't do that for us. */
1644 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
1647 init_cmd_lists (); /* This needs to be done first */
1648 initialize_targets (); /* Setup target_terminal macros for utils.c */
1649 initialize_utils (); /* Make errors and warnings possible */
1650 initialize_all_files ();
1651 initialize_current_architecture ();
1653 init_main (); /* But that omits this file! Do it now */
1655 initialize_stdin_serial ();
1657 async_init_signals ();
1659 /* We need a default language for parsing expressions, so simple things like
1660 "set width 0" won't fail if no language is explicitly set in a config file
1661 or implicitly set by reading an executable during startup. */
1662 set_language (language_c
);
1663 expected_language
= current_language
; /* don't warn about the change. */
1665 /* Allow another UI to initialize. If the UI fails to initialize,
1666 and it wants GDB to revert to the CLI, it should clear
1667 deprecated_init_ui_hook. */
1668 if (deprecated_init_ui_hook
)
1669 deprecated_init_ui_hook (argv0
);