1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2017 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "cli/cli-cmds.h"
23 #include "cli/cli-script.h"
24 #include "cli/cli-setshow.h"
25 #include "cli/cli-decode.h"
31 #include "target-dcache.h"
32 #include "breakpoint.h"
34 #include "expression.h"
37 #include "terminal.h" /* For job_control. */
38 #include "job-control.h"
40 #include "completer.h"
46 #include "event-loop.h"
47 #include "gdbthread.h"
48 #include "extension.h"
52 #include "filenames.h"
55 #include "gdb_select.h"
57 /* readline include files. */
58 #include "readline/readline.h"
59 #include "readline/history.h"
61 /* readline defines this. */
64 #include <sys/types.h>
66 #include "event-top.h"
71 #include "tracepoint.h"
82 extern void initialize_all_files (void);
84 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
85 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
86 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
88 /* Default command line prompt. This is overriden in some configs. */
90 #ifndef DEFAULT_PROMPT
91 #define DEFAULT_PROMPT "(gdb) "
94 /* Generate a function that exports a pointer to a field of the
97 #define gen_ret_current_ui_field_ptr(type, name) \
99 current_ui_## name ## _ptr (void) \
101 return ¤t_ui->m_ ## name; \
104 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdout)
105 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdin)
106 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stderr)
107 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdlog)
108 gen_ret_current_ui_field_ptr (struct ui_out *, current_uiout)
110 /* Initialization file name for gdb. This is host-dependent. */
112 const char gdbinit[] = GDBINIT;
114 int inhibit_gdbinit = 0;
116 extern char lang_frame_mismatch_warn[]; /* language.c */
118 /* Flag for whether we want to confirm potentially dangerous
119 operations. Default is yes. */
124 show_confirm (struct ui_file *file, int from_tty,
125 struct cmd_list_element *c, const char *value)
127 fprintf_filtered (file, _("Whether to confirm potentially "
128 "dangerous operations is %s.\n"),
132 /* Current working directory. */
134 char *current_directory;
136 /* The directory name is actually stored here (usually). */
137 char gdb_dirbuf[1024];
139 /* The last command line executed on the console. Used for command
141 char *saved_command_line;
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 /* Timeout limit for response from target. */
153 /* The default value has been changed many times over the years. It
154 was originally 5 seconds. But that was thought to be a long time
155 to sit and wait, so it was changed to 2 seconds. That was thought
156 to be plenty unless the connection was going through some terminal
157 server or multiplexer or other form of hairy serial connection.
159 In mid-1996, remote_timeout was moved from remote.c to top.c and
160 it began being used in other remote-* targets. It appears that the
161 default was changed to 20 seconds at that time, perhaps because the
162 Renesas E7000 ICE didn't always respond in a timely manner.
164 But if 5 seconds is a long time to sit and wait for retransmissions,
165 20 seconds is far worse. This demonstrates the difficulty of using
166 a single variable for all protocol timeouts.
168 As remote.c is used much more than remote-e7000.c, it was changed
169 back to 2 seconds in 1999. */
171 int remote_timeout = 2;
173 /* Non-zero tells remote* modules to output debugging info. */
175 int remote_debug = 0;
177 /* Sbrk location on entry to main. Used for statistics only. */
182 /* Hooks for alternate command interfaces. */
184 /* This hook is called from within gdb's many mini-event loops which
185 could steal control from a real user interface's event loop. It
186 returns non-zero if the user is requesting a detach, zero
189 int (*deprecated_ui_loop_hook) (int);
192 /* Called from print_frame_info to list the line we stopped in. */
194 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
198 /* Replaces most of query. */
200 int (*deprecated_query_hook) (const char *, va_list);
202 /* Replaces most of warning. */
204 void (*deprecated_warning_hook) (const char *, va_list);
206 /* These three functions support getting lines of text from the user.
207 They are used in sequence. First deprecated_readline_begin_hook is
208 called with a text string that might be (for example) a message for
209 the user to type in a sequence of commands to be executed at a
210 breakpoint. If this function calls back to a GUI, it might take
211 this opportunity to pop up a text interaction window with this
212 message. Next, deprecated_readline_hook is called with a prompt
213 that is emitted prior to collecting the user input. It can be
214 called multiple times. Finally, deprecated_readline_end_hook is
215 called to notify the GUI that we are done with the interaction
216 window and it can close it. */
218 void (*deprecated_readline_begin_hook) (const char *, ...);
219 char *(*deprecated_readline_hook) (const char *);
220 void (*deprecated_readline_end_hook) (void);
222 /* Called as appropriate to notify the interface that we have attached
223 to or detached from an already running process. */
225 void (*deprecated_attach_hook) (void);
226 void (*deprecated_detach_hook) (void);
228 /* Called during long calculations to allow GUI to repair window
229 damage, and to check for stop buttons, etc... */
231 void (*deprecated_interactive_hook) (void);
233 /* Called when going to wait for the target. Usually allows the GUI
234 to run while waiting for target events. */
236 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
237 struct target_waitstatus *status,
240 /* Used by UI as a wrapper around command execution. May do various
241 things like enabling/disabling buttons, etc... */
243 void (*deprecated_call_command_hook) (struct cmd_list_element * c,
244 char *cmd, int from_tty);
246 /* Called when the current thread changes. Argument is thread id. */
248 void (*deprecated_context_hook) (int id);
250 /* The highest UI number ever assigned. */
251 static int highest_ui_num;
256 new_ui (FILE *instream, FILE *outstream, FILE *errstream)
260 ui = XCNEW (struct ui);
262 ui->num = ++highest_ui_num;
263 ui->stdin_stream = instream;
264 ui->instream = instream;
265 ui->outstream = outstream;
266 ui->errstream = errstream;
268 ui->input_fd = fileno (ui->instream);
270 ui->input_interactive_p = ISATTY (ui->instream);
272 ui->m_gdb_stdin = new stdio_file (ui->instream);
273 ui->m_gdb_stdout = new stdio_file (ui->outstream);
274 ui->m_gdb_stderr = new stderr_file (ui->errstream);
275 ui->m_gdb_stdlog = ui->m_gdb_stderr;
277 ui->prompt_state = PROMPT_NEEDED;
285 for (last = ui_list; last->next != NULL; last = last->next)
294 free_ui (struct ui *ui)
296 delete ui->m_gdb_stdin;
297 delete ui->m_gdb_stdout;
298 delete ui->m_gdb_stderr;
304 delete_ui (struct ui *todel)
306 struct ui *ui, *uiprev;
310 for (ui = ui_list; ui != NULL; uiprev = ui, ui = ui->next)
314 gdb_assert (ui != NULL);
317 uiprev->next = ui->next;
324 /* Cleanup that deletes a UI. */
327 delete_ui_cleanup (void *void_ui)
329 struct ui *ui = (struct ui *) void_ui;
337 make_delete_ui_cleanup (struct ui *ui)
339 return make_cleanup (delete_ui_cleanup, ui);
342 /* Open file named NAME for read/write, making sure not to make it the
343 controlling terminal. */
346 open_terminal_stream (const char *name)
350 fd = gdb_open_cloexec (name, O_RDWR | O_NOCTTY, 0);
352 perror_with_name (_("opening terminal failed"));
354 return gdb_file_up (fdopen (fd, "w+"));
357 /* Implementation of the "new-ui" command. */
360 new_ui_command (char *args, int from_tty)
363 struct interp *interp;
364 gdb_file_up stream[3];
368 const char *interpreter_name;
369 const char *tty_name;
370 struct cleanup *failure_chain;
374 gdb_argv argv (args);
375 argc = argv.count ();
378 error (_("usage: new-ui <interpreter> <tty>"));
380 interpreter_name = argv[0];
384 scoped_restore save_ui = make_scoped_restore (¤t_ui);
386 /* Open specified terminal, once for each of
387 stdin/stdout/stderr. */
388 for (i = 0; i < 3; i++)
389 stream[i] = open_terminal_stream (tty_name);
391 ui = new_ui (stream[0].get (), stream[1].get (), stream[2].get ());
392 failure_chain = make_cleanup (delete_ui_cleanup, ui);
398 set_top_level_interpreter (interpreter_name);
400 interp_pre_command_loop (top_level_interpreter ());
402 /* Make sure the files are not closed. */
403 stream[0].release ();
404 stream[1].release ();
405 stream[2].release ();
407 discard_cleanups (failure_chain);
410 printf_unfiltered ("New UI allocated\n");
413 /* Handler for SIGHUP. */
416 /* NOTE 1999-04-29: This function will be static again, once we modify
417 gdb to use the event loop as the default command loop and we merge
418 event-top.c into this file, top.c. */
422 /* Stop asking user for confirmation --- we're exiting. This
423 prevents asking the user dumb questions. */
425 quit_command ((char *) 0, 0);
427 #endif /* defined SIGHUP */
429 /* Line number we are currently in, in a file which is being sourced. */
430 /* NOTE 1999-04-29: This variable will be static again, once we modify
431 gdb to use the event loop as the default command loop and we merge
432 event-top.c into this file, top.c. */
433 /* static */ int source_line_number;
435 /* Name of the file we are sourcing. */
436 /* NOTE 1999-04-29: This variable will be static again, once we modify
437 gdb to use the event loop as the default command loop and we merge
438 event-top.c into this file, top.c. */
439 /* static */ const char *source_file_name;
441 /* Read commands from STREAM. */
443 read_command_file (FILE *stream)
445 struct ui *ui = current_ui;
447 scoped_restore save_instream
448 = make_scoped_restore (&ui->instream, stream);
450 /* Read commands from `instream' and execute them until end of file
451 or error reading instream. */
453 while (ui->instream != NULL && !feof (ui->instream))
457 /* Get a command-line. This calls the readline package. */
458 command = command_line_input (NULL, 0, NULL);
461 command_handler (command);
465 void (*pre_init_ui_hook) (void);
469 do_chdir_cleanup (void *old_dir)
471 chdir ((const char *) old_dir);
477 prepare_execute_command (void)
480 struct cleanup *cleanup;
482 mark = value_mark ();
483 cleanup = make_cleanup_value_free_to_mark (mark);
485 /* With multiple threads running while the one we're examining is
486 stopped, the dcache can get stale without us being able to detect
487 it. For the duration of the command, though, use the dcache to
488 help things like backtrace. */
490 target_dcache_invalidate ();
495 /* Tell the user if the language has changed (except first time) after
496 executing a command. */
499 check_frame_language_change (void)
501 static int warned = 0;
502 struct frame_info *frame;
504 /* First make sure that a new frame has been selected, in case the
505 command or the hooks changed the program state. */
506 frame = deprecated_safe_get_selected_frame ();
507 if (current_language != expected_language)
509 if (language_mode == language_mode_auto && info_verbose)
511 language_info (1); /* Print what changed. */
516 /* Warn the user if the working language does not match the language
517 of the current frame. Only warn the user if we are actually
518 running the program, i.e. there is a stack. */
519 /* FIXME: This should be cacheing the frame and only running when
520 the frame changes. */
522 if (has_stack_frames ())
526 flang = get_frame_language (frame);
528 && flang != language_unknown
529 && flang != current_language->la_language)
531 printf_filtered ("%s\n", lang_frame_mismatch_warn);
540 wait_sync_command_done (void)
542 /* Processing events may change the current UI. */
543 scoped_restore save_ui = make_scoped_restore (¤t_ui);
544 struct ui *ui = current_ui;
546 while (gdb_do_one_event () >= 0)
547 if (ui->prompt_state != PROMPT_BLOCKED)
554 maybe_wait_sync_command_done (int was_sync)
556 /* If the interpreter is in sync mode (we're running a user
557 command's list, running command hooks or similars), and we
558 just ran a synchronous command that started the target, wait
559 for that command to end. */
560 if (!current_ui->async
562 && current_ui->prompt_state == PROMPT_BLOCKED)
563 wait_sync_command_done ();
566 /* Execute the line P as a command, in the current user context.
567 Pass FROM_TTY as second argument to the defining function. */
570 execute_command (char *p, int from_tty)
572 struct cleanup *cleanup_if_error, *cleanup;
573 struct cmd_list_element *c;
576 cleanup_if_error = make_bpstat_clear_actions_cleanup ();
577 cleanup = prepare_execute_command ();
579 /* Force cleanup of any alloca areas if using C alloca instead of
583 /* This can happen when command_line_input hits end of file. */
586 do_cleanups (cleanup);
587 discard_cleanups (cleanup_if_error);
591 target_log_command (p);
593 while (*p == ' ' || *p == '\t')
599 int was_sync = current_ui->prompt_state == PROMPT_BLOCKED;
603 /* If trace-commands is set then this will print this command. */
604 print_command_trace (p);
606 c = lookup_cmd (&cmd, cmdlist, "", 0, 1);
609 /* Pass null arg rather than an empty one. */
612 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
613 while the is_complete_command(cfunc) test is just plain
614 bogus. They should both be replaced by a test of the form
615 c->strip_trailing_white_space_p. */
616 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
617 can't be replaced with func. This is because it is the
618 cfunc, and not the func, that has the value that the
619 is_complete_command hack is testing for. */
620 /* Clear off trailing whitespace, except for set and complete
623 && c->type != set_cmd
624 && !is_complete_command (c))
626 p = arg + strlen (arg) - 1;
627 while (p >= arg && (*p == ' ' || *p == '\t'))
632 /* If this command has been pre-hooked, run the hook first. */
633 execute_cmd_pre_hook (c);
635 if (c->deprecated_warn_user)
636 deprecated_cmd_warning (line);
638 /* c->user_commands would be NULL in the case of a python command. */
639 if (c->theclass == class_user && c->user_commands)
640 execute_user_command (c, arg);
641 else if (c->type == set_cmd)
642 do_set_command (arg, from_tty, c);
643 else if (c->type == show_cmd)
644 do_show_command (arg, from_tty, c);
645 else if (!cmd_func_p (c))
646 error (_("That is not a command, just a help topic."));
647 else if (deprecated_call_command_hook)
648 deprecated_call_command_hook (c, arg, from_tty);
650 cmd_func (c, arg, from_tty);
652 maybe_wait_sync_command_done (was_sync);
654 /* If this command has been post-hooked, run the hook last. */
655 execute_cmd_post_hook (c);
659 check_frame_language_change ();
661 do_cleanups (cleanup);
662 discard_cleanups (cleanup_if_error);
665 /* Run execute_command for P and FROM_TTY. Capture its output into the
666 returned string, do not display it to the screen. BATCH_FLAG will be
667 temporarily set to true. */
670 execute_command_to_string (char *p, int from_tty)
672 struct cleanup *cleanup;
674 /* GDB_STDOUT should be better already restored during these
675 restoration callbacks. */
676 cleanup = set_batch_flag_and_make_cleanup_restore_page_info ();
678 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
680 string_file str_file;
683 current_uiout->redirect (&str_file);
684 ui_out_redirect_pop redirect_popper (current_uiout);
686 scoped_restore save_stdout
687 = make_scoped_restore (&gdb_stdout, &str_file);
688 scoped_restore save_stderr
689 = make_scoped_restore (&gdb_stderr, &str_file);
690 scoped_restore save_stdlog
691 = make_scoped_restore (&gdb_stdlog, &str_file);
692 scoped_restore save_stdtarg
693 = make_scoped_restore (&gdb_stdtarg, &str_file);
694 scoped_restore save_stdtargerr
695 = make_scoped_restore (&gdb_stdtargerr, &str_file);
697 execute_command (p, from_tty);
700 do_cleanups (cleanup);
702 return std::move (str_file.string ());
706 /* When nonzero, cause dont_repeat to do nothing. This should only be
707 set via prevent_dont_repeat. */
709 static int suppress_dont_repeat = 0;
711 /* Commands call this if they do not want to be repeated by null lines. */
716 struct ui *ui = current_ui;
718 if (suppress_dont_repeat || server_command)
721 /* If we aren't reading from standard input, we are saving the last
722 thing read from stdin in line and don't want to delete it. Null
723 lines won't repeat here in any case. */
724 if (ui->instream == ui->stdin_stream)
725 *saved_command_line = 0;
728 /* Prevent dont_repeat from working, and return a cleanup that
729 restores the previous state. */
731 scoped_restore_tmpl<int>
732 prevent_dont_repeat (void)
734 return make_scoped_restore (&suppress_dont_repeat, 1);
738 /* Read a line from the stream "instream" without command line editing.
740 It prints PROMPT once at the start.
741 Action is compatible with "readline", e.g. space for the result is
742 malloc'd and should be freed by the caller.
744 A NULL return means end of file. */
747 gdb_readline_no_editing (const char *prompt)
749 struct buffer line_buffer;
750 struct ui *ui = current_ui;
751 /* Read from stdin if we are executing a user defined command. This
752 is the right thing for prompt_for_continue, at least. */
753 FILE *stream = ui->instream != NULL ? ui->instream : stdin;
754 int fd = fileno (stream);
756 buffer_init (&line_buffer);
760 /* Don't use a _filtered function here. It causes the assumed
761 character position to be off, since the newline we read from
762 the user is not accounted for. */
763 fputs_unfiltered (prompt, gdb_stdout);
764 gdb_flush (gdb_stdout);
775 /* Wait until at least one byte of data is available. Control-C
776 can interrupt interruptible_select, but not fgetc. */
778 FD_SET (fd, &readfds);
779 if (interruptible_select (fd + 1, &readfds, NULL, NULL, NULL) == -1)
783 /* If this was ctrl-c, the QUIT above handles it. */
786 perror_with_name (("select"));
793 if (line_buffer.used_size > 0)
794 /* The last line does not end with a newline. Return it, and
795 if we are called again fgetc will still return EOF and
796 we'll return NULL then. */
798 xfree (buffer_finish (&line_buffer));
804 if (line_buffer.used_size > 0
805 && line_buffer.buffer[line_buffer.used_size - 1] == '\r')
806 line_buffer.used_size--;
810 buffer_grow_char (&line_buffer, c);
813 buffer_grow_char (&line_buffer, '\0');
814 return buffer_finish (&line_buffer);
817 /* Variables which control command line editing and history
818 substitution. These variables are given default values at the end
820 static int command_editing_p;
822 /* NOTE 1999-04-29: This variable will be static again, once we modify
823 gdb to use the event loop as the default command loop and we merge
824 event-top.c into this file, top.c. */
826 /* static */ int history_expansion_p;
828 static int write_history_p;
830 show_write_history_p (struct ui_file *file, int from_tty,
831 struct cmd_list_element *c, const char *value)
833 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
837 /* The variable associated with the "set/show history size"
838 command. The value -1 means unlimited, and -2 means undefined. */
839 static int history_size_setshow_var = -2;
842 show_history_size (struct ui_file *file, int from_tty,
843 struct cmd_list_element *c, const char *value)
845 fprintf_filtered (file, _("The size of the command history is %s.\n"),
849 /* Variable associated with the "history remove-duplicates" option.
850 The value -1 means unlimited. */
851 static int history_remove_duplicates = 0;
854 show_history_remove_duplicates (struct ui_file *file, int from_tty,
855 struct cmd_list_element *c, const char *value)
857 fprintf_filtered (file,
858 _("The number of history entries to look back at for "
859 "duplicates is %s.\n"),
863 static char *history_filename;
865 show_history_filename (struct ui_file *file, int from_tty,
866 struct cmd_list_element *c, const char *value)
868 fprintf_filtered (file, _("The filename in which to record "
869 "the command history is \"%s\".\n"),
873 /* This is like readline(), but it has some gdb-specific behavior.
874 gdb may want readline in both the synchronous and async modes during
875 a single gdb invocation. At the ordinary top-level prompt we might
876 be using the async readline. That means we can't use
877 rl_pre_input_hook, since it doesn't work properly in async mode.
878 However, for a secondary prompt (" >", such as occurs during a
879 `define'), gdb wants a synchronous response.
881 We used to call readline() directly, running it in synchronous
882 mode. But mixing modes this way is not supported, and as of
883 readline 5.x it no longer works; the arrow keys come unbound during
884 the synchronous call. So we make a nested call into the event
885 loop. That's what gdb_readline_wrapper is for. */
887 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
888 rely on gdb_readline_wrapper_result, which might still be NULL if
889 the user types Control-D for EOF. */
890 static int gdb_readline_wrapper_done;
892 /* The result of the current call to gdb_readline_wrapper, once a newline
894 static char *gdb_readline_wrapper_result;
896 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
897 to be called after the newline is processed (which will redisplay
898 the prompt). But in gdb_readline_wrapper we will not get a new
899 prompt until the next call, or until we return to the event loop.
900 So we disable this hook around the newline and restore it before we
902 static void (*saved_after_char_processing_hook) (void);
908 gdb_in_secondary_prompt_p (struct ui *ui)
910 return ui->secondary_prompt_depth > 0;
914 /* This function is called when readline has seen a complete line of
918 gdb_readline_wrapper_line (char *line)
920 gdb_assert (!gdb_readline_wrapper_done);
921 gdb_readline_wrapper_result = line;
922 gdb_readline_wrapper_done = 1;
924 /* Prevent operate-and-get-next from acting too early. */
925 saved_after_char_processing_hook = after_char_processing_hook;
926 after_char_processing_hook = NULL;
928 /* Prevent parts of the prompt from being redisplayed if annotations
929 are enabled, and readline's state getting out of sync. We'll
930 reinstall the callback handler, which puts the terminal in raw
931 mode (or in readline lingo, in prepped state), when we're next
932 ready to process user input, either in display_gdb_prompt, or if
933 we're handling an asynchronous target event and running in the
934 background, just before returning to the event loop to process
935 further input (or more target events). */
936 if (current_ui->command_editing)
937 gdb_rl_callback_handler_remove ();
940 struct gdb_readline_wrapper_cleanup
942 void (*handler_orig) (char *);
943 int already_prompted_orig;
945 /* Whether the target was async. */
946 int target_is_async_orig;
950 gdb_readline_wrapper_cleanup (void *arg)
952 struct ui *ui = current_ui;
953 struct gdb_readline_wrapper_cleanup *cleanup
954 = (struct gdb_readline_wrapper_cleanup *) arg;
956 if (ui->command_editing)
957 rl_already_prompted = cleanup->already_prompted_orig;
959 gdb_assert (ui->input_handler == gdb_readline_wrapper_line);
960 ui->input_handler = cleanup->handler_orig;
962 /* Don't restore our input handler in readline yet. That would make
963 readline prep the terminal (putting it in raw mode), while the
964 line we just read may trigger execution of a command that expects
965 the terminal in the default cooked/canonical mode, such as e.g.,
966 running Python's interactive online help utility. See
967 gdb_readline_wrapper_line for when we'll reinstall it. */
969 gdb_readline_wrapper_result = NULL;
970 gdb_readline_wrapper_done = 0;
971 ui->secondary_prompt_depth--;
972 gdb_assert (ui->secondary_prompt_depth >= 0);
974 after_char_processing_hook = saved_after_char_processing_hook;
975 saved_after_char_processing_hook = NULL;
977 if (cleanup->target_is_async_orig)
984 gdb_readline_wrapper (const char *prompt)
986 struct ui *ui = current_ui;
987 struct cleanup *back_to;
988 struct gdb_readline_wrapper_cleanup *cleanup;
991 cleanup = XNEW (struct gdb_readline_wrapper_cleanup);
992 cleanup->handler_orig = ui->input_handler;
993 ui->input_handler = gdb_readline_wrapper_line;
995 if (ui->command_editing)
996 cleanup->already_prompted_orig = rl_already_prompted;
998 cleanup->already_prompted_orig = 0;
1000 cleanup->target_is_async_orig = target_is_async_p ();
1002 ui->secondary_prompt_depth++;
1003 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
1005 /* Processing events may change the current UI. */
1006 scoped_restore save_ui = make_scoped_restore (¤t_ui);
1008 if (cleanup->target_is_async_orig)
1011 /* Display our prompt and prevent double prompt display. Don't pass
1012 down a NULL prompt, since that has special meaning for
1013 display_gdb_prompt -- it indicates a request to print the primary
1014 prompt, while we want a secondary prompt here. */
1015 display_gdb_prompt (prompt != NULL ? prompt : "");
1016 if (ui->command_editing)
1017 rl_already_prompted = 1;
1019 if (after_char_processing_hook)
1020 (*after_char_processing_hook) ();
1021 gdb_assert (after_char_processing_hook == NULL);
1023 while (gdb_do_one_event () >= 0)
1024 if (gdb_readline_wrapper_done)
1027 retval = gdb_readline_wrapper_result;
1028 do_cleanups (back_to);
1033 /* The current saved history number from operate-and-get-next.
1034 This is -1 if not valid. */
1035 static int operate_saved_history = -1;
1037 /* This is put on the appropriate hook and helps operate-and-get-next
1040 gdb_rl_operate_and_get_next_completion (void)
1042 int delta = where_history () - operate_saved_history;
1044 /* The `key' argument to rl_get_previous_history is ignored. */
1045 rl_get_previous_history (delta, 0);
1046 operate_saved_history = -1;
1048 /* readline doesn't automatically update the display for us. */
1051 after_char_processing_hook = NULL;
1052 rl_pre_input_hook = NULL;
1055 /* This is a gdb-local readline command handler. It accepts the
1056 current command line (like RET does) and, if this command was taken
1057 from the history, arranges for the next command in the history to
1058 appear on the command line when the prompt returns.
1059 We ignore the arguments. */
1061 gdb_rl_operate_and_get_next (int count, int key)
1065 /* Use the async hook. */
1066 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
1068 /* Find the current line, and find the next line to use. */
1069 where = where_history();
1071 if ((history_is_stifled () && (history_length >= history_max_entries))
1072 || (where >= history_length - 1))
1073 operate_saved_history = where;
1075 operate_saved_history = where + 1;
1077 return rl_newline (1, key);
1080 /* Number of user commands executed during this session. */
1082 static int command_count = 0;
1084 /* Add the user command COMMAND to the input history list. */
1087 gdb_add_history (const char *command)
1091 if (history_remove_duplicates != 0)
1094 int lookbehind_threshold;
1096 /* The lookbehind threshold for finding a duplicate history entry is
1097 bounded by command_count because we can't meaningfully delete
1098 history entries that are already stored in the history file since
1099 the history file is appended to. */
1100 if (history_remove_duplicates == -1
1101 || history_remove_duplicates > command_count)
1102 lookbehind_threshold = command_count;
1104 lookbehind_threshold = history_remove_duplicates;
1107 for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
1109 HIST_ENTRY *temp = previous_history ();
1114 if (strcmp (temp->line, command) == 0)
1116 HIST_ENTRY *prev = remove_history (where_history ());
1118 free_history_entry (prev);
1125 add_history (command);
1128 /* Safely append new history entries to the history file in a corruption-free
1129 way using an intermediate local history file. */
1132 gdb_safe_append_history (void)
1134 int ret, saved_errno;
1135 char *local_history_filename;
1136 struct cleanup *old_chain;
1138 local_history_filename
1139 = xstrprintf ("%s-gdb%ld~", history_filename, (long) getpid ());
1140 old_chain = make_cleanup (xfree, local_history_filename);
1142 ret = rename (history_filename, local_history_filename);
1143 saved_errno = errno;
1144 if (ret < 0 && saved_errno != ENOENT)
1146 warning (_("Could not rename %s to %s: %s"),
1147 history_filename, local_history_filename,
1148 safe_strerror (saved_errno));
1154 /* If the rename failed with ENOENT then either the global history
1155 file never existed in the first place or another GDB process is
1156 currently appending to it (and has thus temporarily renamed it).
1157 Since we can't distinguish between these two cases, we have to
1158 conservatively assume the first case and therefore must write out
1159 (not append) our known history to our local history file and try
1160 to move it back anyway. Otherwise a global history file would
1161 never get created! */
1162 gdb_assert (saved_errno == ENOENT);
1163 write_history (local_history_filename);
1167 append_history (command_count, local_history_filename);
1168 if (history_is_stifled ())
1169 history_truncate_file (local_history_filename, history_max_entries);
1172 ret = rename (local_history_filename, history_filename);
1173 saved_errno = errno;
1174 if (ret < 0 && saved_errno != EEXIST)
1175 warning (_("Could not rename %s to %s: %s"),
1176 local_history_filename, history_filename,
1177 safe_strerror (saved_errno));
1180 do_cleanups (old_chain);
1183 /* Read one line from the command input stream `instream' into a local
1184 static buffer. The buffer is made bigger as necessary. Returns
1185 the address of the start of the line.
1187 NULL is returned for end of file.
1189 *If* input is from an interactive stream (stdin), the line read is
1190 copied into the global 'saved_command_line' so that it can be
1193 This routine either uses fancy command line editing or simple input
1194 as the user has requested. */
1197 command_line_input (const char *prompt_arg, int repeat,
1198 const char *annotation_suffix)
1200 static struct buffer cmd_line_buffer;
1201 static int cmd_line_buffer_initialized;
1202 struct ui *ui = current_ui;
1203 const char *prompt = prompt_arg;
1205 int from_tty = ui->instream == ui->stdin_stream;
1207 /* The annotation suffix must be non-NULL. */
1208 if (annotation_suffix == NULL)
1209 annotation_suffix = "";
1211 if (from_tty && annotation_level > 1)
1216 = (char *) alloca ((prompt == NULL ? 0 : strlen (prompt))
1217 + strlen (annotation_suffix) + 40);
1219 local_prompt[0] = '\0';
1221 strcpy (local_prompt, prompt);
1222 strcat (local_prompt, "\n\032\032");
1223 strcat (local_prompt, annotation_suffix);
1224 strcat (local_prompt, "\n");
1226 prompt = local_prompt;
1229 if (!cmd_line_buffer_initialized)
1231 buffer_init (&cmd_line_buffer);
1232 cmd_line_buffer_initialized = 1;
1235 /* Starting a new command line. */
1236 cmd_line_buffer.used_size = 0;
1240 signal (STOP_SIGNAL, handle_stop_sig);
1247 /* Make sure that all output has been output. Some machines may
1248 let you get away with leaving out some of the gdb_flush, but
1251 gdb_flush (gdb_stdout);
1252 gdb_flush (gdb_stderr);
1254 if (source_file_name != NULL)
1255 ++source_line_number;
1257 if (from_tty && annotation_level > 1)
1259 puts_unfiltered ("\n\032\032pre-");
1260 puts_unfiltered (annotation_suffix);
1261 puts_unfiltered ("\n");
1264 /* Don't use fancy stuff if not talking to stdin. */
1265 if (deprecated_readline_hook
1267 && input_interactive_p (current_ui))
1269 rl = (*deprecated_readline_hook) (prompt);
1271 else if (command_editing_p
1273 && input_interactive_p (current_ui))
1275 rl = gdb_readline_wrapper (prompt);
1279 rl = gdb_readline_no_editing (prompt);
1282 cmd = handle_line_of_input (&cmd_line_buffer, rl,
1283 repeat, annotation_suffix);
1284 if (cmd == (char *) EOF)
1292 /* Got partial input. I.e., got a line that ends with a
1293 continuation character (backslash). Suppress printing the
1300 signal (STOP_SIGNAL, SIG_DFL);
1306 /* Print the GDB banner. */
1308 print_gdb_version (struct ui_file *stream)
1310 /* From GNU coding standards, first line is meant to be easy for a
1311 program to parse, and is just canonical program name and version
1312 number, which starts after last space. */
1314 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1316 /* Second line is a copyright notice. */
1318 fprintf_filtered (stream,
1319 "Copyright (C) 2017 Free Software Foundation, Inc.\n");
1321 /* Following the copyright is a brief statement that the program is
1322 free software, that users are free to copy and change it on
1323 certain conditions, that it is covered by the GNU GPL, and that
1324 there is no warranty. */
1326 fprintf_filtered (stream, "\
1327 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1328 \nThis is free software: you are free to change and redistribute it.\n\
1329 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1330 and \"show warranty\" for details.\n");
1332 /* After the required info we print the configuration information. */
1334 fprintf_filtered (stream, "This GDB was configured as \"");
1335 if (strcmp (host_name, target_name) != 0)
1337 fprintf_filtered (stream, "--host=%s --target=%s",
1338 host_name, target_name);
1342 fprintf_filtered (stream, "%s", host_name);
1344 fprintf_filtered (stream, "\".\n\
1345 Type \"show configuration\" for configuration details.");
1347 if (REPORT_BUGS_TO[0])
1349 fprintf_filtered (stream,
1350 _("\nFor bug reporting instructions, please see:\n"));
1351 fprintf_filtered (stream, "%s.\n", REPORT_BUGS_TO);
1353 fprintf_filtered (stream,
1354 _("Find the GDB manual and other documentation \
1355 resources online at:\n<http://www.gnu.org/software/gdb/documentation/>.\n"));
1356 fprintf_filtered (stream, _("For help, type \"help\".\n"));
1357 fprintf_filtered (stream, _("Type \"apropos word\" to search for \
1358 commands related to \"word\"."));
1361 /* Print the details of GDB build-time configuration. */
1363 print_gdb_configuration (struct ui_file *stream)
1365 fprintf_filtered (stream, _("\
1366 This GDB was configured as follows:\n\
1367 configure --host=%s --target=%s\n\
1368 "), host_name, target_name);
1369 fprintf_filtered (stream, _("\
1370 --with-auto-load-dir=%s\n\
1371 --with-auto-load-safe-path=%s\n\
1372 "), AUTO_LOAD_DIR, AUTO_LOAD_SAFE_PATH);
1374 fprintf_filtered (stream, _("\
1378 fprintf_filtered (stream, _("\
1383 fprintf_filtered (stream, _("\
1384 --with-gdb-datadir=%s%s\n\
1385 "), GDB_DATADIR, GDB_DATADIR_RELOCATABLE ? " (relocatable)" : "");
1387 fprintf_filtered (stream, _("\
1388 --with-iconv-bin=%s%s\n\
1389 "), ICONV_BIN, ICONV_BIN_RELOCATABLE ? " (relocatable)" : "");
1391 if (JIT_READER_DIR[0])
1392 fprintf_filtered (stream, _("\
1393 --with-jit-reader-dir=%s%s\n\
1394 "), JIT_READER_DIR, JIT_READER_DIR_RELOCATABLE ? " (relocatable)" : "");
1395 #if HAVE_LIBUNWIND_IA64_H
1396 fprintf_filtered (stream, _("\
1397 --with-libunwind-ia64\n\
1400 fprintf_filtered (stream, _("\
1401 --without-libunwind-ia64\n\
1405 fprintf_filtered (stream, _("\
1409 fprintf_filtered (stream, _("\
1413 #ifdef WITH_PYTHON_PATH
1414 fprintf_filtered (stream, _("\
1415 --with-python=%s%s\n\
1416 "), WITH_PYTHON_PATH, PYTHON_PATH_RELOCATABLE ? " (relocatable)" : "");
1419 fprintf_filtered (stream, _("\
1423 fprintf_filtered (stream, _("\
1428 fprintf_filtered (stream, _("\
1429 --with-relocated-sources=%s\n\
1433 fprintf_filtered (stream, _("\
1434 --with-separate-debug-dir=%s%s\n\
1435 "), DEBUGDIR, DEBUGDIR_RELOCATABLE ? " (relocatable)" : "");
1436 if (TARGET_SYSTEM_ROOT[0])
1437 fprintf_filtered (stream, _("\
1438 --with-sysroot=%s%s\n\
1439 "), TARGET_SYSTEM_ROOT, TARGET_SYSTEM_ROOT_RELOCATABLE ? " (relocatable)" : "");
1440 if (SYSTEM_GDBINIT[0])
1441 fprintf_filtered (stream, _("\
1442 --with-system-gdbinit=%s%s\n\
1443 "), SYSTEM_GDBINIT, SYSTEM_GDBINIT_RELOCATABLE ? " (relocatable)" : "");
1444 #if HAVE_LIBBABELTRACE
1445 fprintf_filtered (stream, _("\
1446 --with-babeltrace\n\
1449 fprintf_filtered (stream, _("\
1450 --without-babeltrace\n\
1453 /* We assume "relocatable" will be printed at least once, thus we always
1454 print this text. It's a reasonably safe assumption for now. */
1455 fprintf_filtered (stream, _("\n\
1456 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1457 tree, and GDB will still find it.)\n\
1462 /* The current top level prompt, settable with "set prompt", and/or
1463 with the python `gdb.prompt_hook' hook. */
1464 static char *top_prompt;
1466 /* Access method for the GDB prompt string. */
1474 /* Set method for the GDB prompt string. */
1477 set_prompt (const char *s)
1479 char *p = xstrdup (s);
1492 /* Callback for iterate_over_inferiors. Kills or detaches the given
1493 inferior, depending on how we originally gained control of it. */
1496 kill_or_detach (struct inferior *inf, void *args)
1498 struct qt_args *qt = (struct qt_args *) args;
1499 struct thread_info *thread;
1504 thread = any_thread_of_process (inf->pid);
1507 switch_to_thread (thread->ptid);
1509 /* Leave core files alone. */
1510 if (target_has_execution)
1512 if (inf->attach_flag)
1513 target_detach (qt->args, qt->from_tty);
1522 /* Callback for iterate_over_inferiors. Prints info about what GDB
1523 will do to each inferior on a "quit". ARG points to a struct
1524 ui_out where output is to be collected. */
1527 print_inferior_quit_action (struct inferior *inf, void *arg)
1529 struct ui_file *stb = (struct ui_file *) arg;
1534 if (inf->attach_flag)
1535 fprintf_filtered (stb,
1536 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1537 target_pid_to_str (pid_to_ptid (inf->pid)));
1539 fprintf_filtered (stb,
1540 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1541 target_pid_to_str (pid_to_ptid (inf->pid)));
1546 /* If necessary, make the user confirm that we should quit. Return
1547 non-zero if we should quit, zero if we shouldn't. */
1552 /* Don't even ask if we're only debugging a core file inferior. */
1553 if (!have_live_inferiors ())
1556 /* Build the query string as a single string. */
1559 stb.puts (_("A debugging session is active.\n\n"));
1560 iterate_over_inferiors (print_inferior_quit_action, &stb);
1561 stb.puts (_("\nQuit anyway? "));
1563 return query ("%s", stb.c_str ());
1566 /* Prepare to exit GDB cleanly by undoing any changes made to the
1567 terminal so that we leave the terminal in the state we acquired it. */
1570 undo_terminal_modifications_before_exit (void)
1572 struct ui *saved_top_level = current_ui;
1574 target_terminal::ours ();
1576 current_ui = main_ui;
1581 gdb_disable_readline ();
1583 current_ui = saved_top_level;
1587 /* Quit without asking for confirmation. */
1590 quit_force (int *exit_arg, int from_tty)
1595 undo_terminal_modifications_before_exit ();
1597 /* An optional expression may be used to cause gdb to terminate with the
1598 value of that expression. */
1600 exit_code = *exit_arg;
1601 else if (return_child_result)
1602 exit_code = return_child_result_value;
1605 qt.from_tty = from_tty;
1607 /* We want to handle any quit errors and exit regardless. */
1609 /* Get out of tfind mode, and kill or detach all inferiors. */
1612 disconnect_tracing ();
1613 iterate_over_inferiors (kill_or_detach, &qt);
1615 CATCH (ex, RETURN_MASK_ALL)
1617 exception_print (gdb_stderr, ex);
1621 /* Give all pushed targets a chance to do minimal cleanup, and pop
1627 CATCH (ex, RETURN_MASK_ALL)
1629 exception_print (gdb_stderr, ex);
1633 /* Save the history information if it is appropriate to do so. */
1636 if (write_history_p && history_filename)
1641 /* History is currently shared between all UIs. If there's
1642 any UI with a terminal, save history. */
1645 if (input_interactive_p (ui))
1653 gdb_safe_append_history ();
1656 CATCH (ex, RETURN_MASK_ALL)
1658 exception_print (gdb_stderr, ex);
1662 /* Do any final cleanups before exiting. */
1665 do_final_cleanups (all_cleanups ());
1667 CATCH (ex, RETURN_MASK_ALL)
1669 exception_print (gdb_stderr, ex);
1676 /* The value of the "interactive-mode" setting. */
1677 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
1679 /* Implement the "show interactive-mode" option. */
1682 show_interactive_mode (struct ui_file *file, int from_tty,
1683 struct cmd_list_element *c,
1686 if (interactive_mode == AUTO_BOOLEAN_AUTO)
1687 fprintf_filtered (file, "Debugger's interactive mode "
1688 "is %s (currently %s).\n",
1689 value, input_interactive_p (current_ui) ? "on" : "off");
1691 fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
1694 /* Returns whether GDB is running on an interactive terminal. */
1697 input_interactive_p (struct ui *ui)
1702 if (interactive_mode != AUTO_BOOLEAN_AUTO)
1703 return interactive_mode == AUTO_BOOLEAN_TRUE;
1705 return ui->input_interactive_p;
1709 dont_repeat_command (char *ignored, int from_tty)
1711 /* Can't call dont_repeat here because we're not necessarily reading
1713 *saved_command_line = 0;
1716 /* Functions to manipulate command line editing control variables. */
1718 /* Number of commands to print in each call to show_commands. */
1719 #define Hist_print 10
1721 show_commands (char *args, int from_tty)
1723 /* Index for history commands. Relative to history_base. */
1726 /* Number of the history entry which we are planning to display next.
1727 Relative to history_base. */
1730 /* Print out some of the commands from the command history. */
1734 if (args[0] == '+' && args[1] == '\0')
1735 /* "info editing +" should print from the stored position. */
1738 /* "info editing <exp>" should print around command number <exp>. */
1739 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1741 /* "show commands" means print the last Hist_print commands. */
1744 num = history_length - Hist_print;
1750 /* If there are at least Hist_print commands, we want to display the last
1751 Hist_print rather than, say, the last 6. */
1752 if (history_length - num < Hist_print)
1754 num = history_length - Hist_print;
1760 offset < num + Hist_print && offset < history_length;
1763 printf_filtered ("%5d %s\n", history_base + offset,
1764 (history_get (history_base + offset))->line);
1767 /* The next command we want to display is the next one that we haven't
1771 /* If the user repeats this command with return, it should do what
1772 "show commands +" does. This is unnecessary if arg is null,
1773 because "show commands +" is not useful after "show commands". */
1774 if (from_tty && args)
1781 /* Update the size of our command history file to HISTORY_SIZE.
1783 A HISTORY_SIZE of -1 stands for unlimited. */
1786 set_readline_history_size (int history_size)
1788 gdb_assert (history_size >= -1);
1790 if (history_size == -1)
1791 unstifle_history ();
1793 stifle_history (history_size);
1796 /* Called by do_setshow_command. */
1798 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1800 set_readline_history_size (history_size_setshow_var);
1804 set_history (char *args, int from_tty)
1806 printf_unfiltered (_("\"set history\" must be followed "
1807 "by the name of a history subcommand.\n"));
1808 help_list (sethistlist, "set history ", all_commands, gdb_stdout);
1812 show_history (char *args, int from_tty)
1814 cmd_show_list (showhistlist, from_tty, "");
1817 int info_verbose = 0; /* Default verbose msgs off. */
1819 /* Called by do_setshow_command. An elaborate joke. */
1821 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1823 const char *cmdname = "verbose";
1824 struct cmd_list_element *showcmd;
1826 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1827 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1831 c->doc = "Set verbose printing of informational messages.";
1832 showcmd->doc = "Show verbose printing of informational messages.";
1836 c->doc = "Set verbosity.";
1837 showcmd->doc = "Show verbosity.";
1841 /* Init the history buffer. Note that we are called after the init file(s)
1842 have been read so that the user can change the history file via his
1843 .gdbinit file (for instance). The GDBHISTFILE environment variable
1844 overrides all of this. */
1851 tmpenv = getenv ("GDBHISTSIZE");
1858 tmpenv = skip_spaces (tmpenv);
1860 var = strtol (tmpenv, &endptr, 10);
1861 saved_errno = errno;
1862 endptr = skip_spaces (endptr);
1864 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1865 empty string, a negative number or a huge positive number (larger than
1866 INT_MAX) then set the history size to unlimited. Otherwise set our
1867 history size to the number we have read. This behavior is consistent
1868 with how bash handles HISTSIZE. */
1869 if (*endptr != '\0')
1871 else if (*tmpenv == '\0'
1874 /* On targets where INT_MAX == LONG_MAX, we have to look at
1875 errno after calling strtol to distinguish between a value that
1876 is exactly INT_MAX and an overflowing value that was clamped
1878 || (var == INT_MAX && saved_errno == ERANGE))
1879 history_size_setshow_var = -1;
1881 history_size_setshow_var = var;
1884 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1886 if (history_size_setshow_var == -2)
1887 history_size_setshow_var = 256;
1889 set_readline_history_size (history_size_setshow_var);
1891 tmpenv = getenv ("GDBHISTFILE");
1893 history_filename = xstrdup (tmpenv);
1894 else if (!history_filename)
1896 /* We include the current directory so that if the user changes
1897 directories the file written will be the same as the one
1900 /* No leading dots in file names are allowed on MSDOS. */
1901 history_filename = concat (current_directory, "/_gdb_history",
1904 history_filename = concat (current_directory, "/.gdb_history",
1908 read_history (history_filename);
1912 show_prompt (struct ui_file *file, int from_tty,
1913 struct cmd_list_element *c, const char *value)
1915 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1918 /* "set editing" command. */
1921 set_editing (char *args, int from_tty, struct cmd_list_element *c)
1923 change_line_handler (set_editing_cmd_var);
1924 /* Update the control variable so that MI's =cmd-param-changed event
1925 shows the correct value. */
1926 set_editing_cmd_var = current_ui->command_editing;
1930 show_editing (struct ui_file *file, int from_tty,
1931 struct cmd_list_element *c, const char *value)
1933 fprintf_filtered (file, _("Editing of command lines as "
1934 "they are typed is %s.\n"),
1935 current_ui->command_editing ? _("on") : _("off"));
1939 show_annotation_level (struct ui_file *file, int from_tty,
1940 struct cmd_list_element *c, const char *value)
1942 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1946 show_exec_done_display_p (struct ui_file *file, int from_tty,
1947 struct cmd_list_element *c, const char *value)
1949 fprintf_filtered (file, _("Notification of completion for "
1950 "asynchronous execution commands is %s.\n"),
1954 /* New values of the "data-directory" parameter are staged here. */
1955 static char *staged_gdb_datadir;
1957 /* "set" command for the gdb_datadir configuration variable. */
1960 set_gdb_datadir (char *args, int from_tty, struct cmd_list_element *c)
1962 set_gdb_data_directory (staged_gdb_datadir);
1963 observer_notify_gdb_datadir_changed ();
1966 /* "show" command for the gdb_datadir configuration variable. */
1969 show_gdb_datadir (struct ui_file *file, int from_tty,
1970 struct cmd_list_element *c, const char *value)
1972 fprintf_filtered (file, _("GDB's data directory is \"%s\".\n"),
1977 set_history_filename (char *args, int from_tty, struct cmd_list_element *c)
1979 /* We include the current directory so that if the user changes
1980 directories the file written will be the same as the one
1982 if (!IS_ABSOLUTE_PATH (history_filename))
1983 history_filename = reconcat (history_filename, current_directory, "/",
1984 history_filename, (char *) NULL);
1990 struct cmd_list_element *c;
1992 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1993 the DEFAULT_PROMPT is. */
1994 set_prompt (DEFAULT_PROMPT);
1996 /* Set the important stuff up for command editing. */
1997 command_editing_p = 1;
1998 history_expansion_p = 0;
1999 write_history_p = 0;
2001 /* Setup important stuff for command line editing. */
2002 rl_completion_word_break_hook = gdb_completion_word_break_characters;
2003 rl_attempted_completion_function = gdb_rl_attempted_completion_function;
2004 set_rl_completer_word_break_characters (default_word_break_characters ());
2005 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
2006 rl_completion_display_matches_hook = cli_display_match_list;
2007 rl_readline_name = "gdb";
2008 rl_terminal_name = getenv ("TERM");
2010 /* The name for this defun comes from Bash, where it originated.
2011 15 is Control-o, the same binding this function has in Bash. */
2012 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
2014 add_setshow_string_cmd ("prompt", class_support,
2016 _("Set gdb's prompt"),
2017 _("Show gdb's prompt"),
2020 &setlist, &showlist);
2022 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
2023 Don't repeat this command.\nPrimarily \
2024 used inside of user-defined commands that should not be repeated when\n\
2027 add_setshow_boolean_cmd ("editing", class_support,
2028 &set_editing_cmd_var, _("\
2029 Set editing of command lines as they are typed."), _("\
2030 Show editing of command lines as they are typed."), _("\
2031 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2032 Without an argument, command line editing is enabled. To edit, use\n\
2033 EMACS-like or VI-like commands like control-P or ESC."),
2036 &setlist, &showlist);
2038 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
2039 Set saving of the history record on exit."), _("\
2040 Show saving of the history record on exit."), _("\
2041 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2042 Without an argument, saving is enabled."),
2044 show_write_history_p,
2045 &sethistlist, &showhistlist);
2047 add_setshow_zuinteger_unlimited_cmd ("size", no_class,
2048 &history_size_setshow_var, _("\
2049 Set the size of the command history,"), _("\
2050 Show the size of the command history,"), _("\
2051 ie. the number of previous commands to keep a record of.\n\
2052 If set to \"unlimited\", the number of commands kept in the history\n\
2053 list is unlimited. This defaults to the value of the environment\n\
2054 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2055 set_history_size_command,
2057 &sethistlist, &showhistlist);
2059 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
2060 &history_remove_duplicates, _("\
2061 Set how far back in history to look for and remove duplicate entries."), _("\
2062 Show how far back in history to look for and remove duplicate entries."), _("\
2063 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2064 and remove the first history entry that is a duplicate of the most recent\n\
2065 entry, each time a new history entry is added.\n\
2066 If set to \"unlimited\", this lookbehind is unbounded.\n\
2067 Only history entries added during this session are considered for removal.\n\
2068 If set to 0, removal of duplicate history entries is disabled.\n\
2069 By default this option is set to 0."),
2071 show_history_remove_duplicates,
2072 &sethistlist, &showhistlist);
2074 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
2075 Set the filename in which to record the command history"), _("\
2076 Show the filename in which to record the command history"), _("\
2077 (the list of previous commands of which a record is kept)."),
2078 set_history_filename,
2079 show_history_filename,
2080 &sethistlist, &showhistlist);
2082 add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
2083 Set whether to confirm potentially dangerous operations."), _("\
2084 Show whether to confirm potentially dangerous operations."), NULL,
2087 &setlist, &showlist);
2089 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
2090 Set annotation_level."), _("\
2091 Show annotation_level."), _("\
2092 0 == normal; 1 == fullname (for use when running under emacs)\n\
2093 2 == output annotated suitably for use by programs that control GDB."),
2095 show_annotation_level,
2096 &setlist, &showlist);
2098 add_setshow_boolean_cmd ("exec-done-display", class_support,
2099 &exec_done_display_p, _("\
2100 Set notification of completion for asynchronous execution commands."), _("\
2101 Show notification of completion for asynchronous execution commands."), _("\
2102 Use \"on\" to enable the notification, and \"off\" to disable it."),
2104 show_exec_done_display_p,
2105 &setlist, &showlist);
2107 add_setshow_filename_cmd ("data-directory", class_maintenance,
2108 &staged_gdb_datadir, _("Set GDB's data directory."),
2109 _("Show GDB's data directory."),
2111 When set, GDB uses the specified path to search for data files."),
2112 set_gdb_datadir, show_gdb_datadir,
2116 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
2117 &interactive_mode, _("\
2118 Set whether GDB's standard input is a terminal."), _("\
2119 Show whether GDB's standard input is a terminal."), _("\
2120 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2121 means that GDB should wait for the user to answer queries associated to\n\
2122 commands entered at the command prompt. If off, GDB assumes that standard\n\
2123 input is not a terminal, and uses the default answer to all queries.\n\
2124 If auto (the default), determine which mode to use based on the standard\n\
2127 show_interactive_mode,
2128 &setlist, &showlist);
2130 c = add_cmd ("new-ui", class_support, new_ui_command, _("\
2131 Create a new UI. It takes two arguments:\n\
2132 The first argument is the name of the interpreter to run.\n\
2133 The second argument is the terminal the UI runs on.\n"), &cmdlist);
2134 set_cmd_completer (c, interpreter_completer);
2138 gdb_init (char *argv0)
2140 if (pre_init_ui_hook)
2141 pre_init_ui_hook ();
2143 /* Run the init function of each source file. */
2146 /* Make sure we return to the original directory upon exit, come
2147 what may, since the OS doesn't do that for us. */
2148 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
2151 init_cmd_lists (); /* This needs to be done first. */
2152 initialize_targets (); /* Setup target_terminal macros for utils.c. */
2153 initialize_utils (); /* Make errors and warnings possible. */
2157 /* Here is where we call all the _initialize_foo routines. */
2158 initialize_all_files ();
2160 /* This creates the current_program_space. Do this after all the
2161 _initialize_foo routines have had a chance to install their
2162 per-sspace data keys. Also do this before
2163 initialize_current_architecture is called, because it accesses
2164 exec_bfd of the current program space. */
2165 initialize_progspace ();
2166 initialize_inferiors ();
2167 initialize_current_architecture ();
2169 init_main (); /* But that omits this file! Do it now. */
2171 initialize_stdin_serial ();
2173 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2175 set_initial_gdb_ttystate ();
2177 async_init_signals ();
2179 /* We need a default language for parsing expressions, so simple
2180 things like "set width 0" won't fail if no language is explicitly
2181 set in a config file or implicitly set by reading an executable
2183 set_language (language_c);
2184 expected_language = current_language; /* Don't warn about the change. */
2186 /* Python initialization, for example, can require various commands to be
2187 installed. For example "info pretty-printer" needs the "info"
2188 prefix to be installed. Keep things simple and just do final
2189 script initialization here. */
2190 finish_ext_lang_initialization ();