1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2016 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. */
39 #include "completer.h"
45 #include "event-loop.h"
46 #include "gdbthread.h"
47 #include "extension.h"
51 #include "filenames.h"
54 #include "gdb_select.h"
56 /* readline include files. */
57 #include "readline/readline.h"
58 #include "readline/history.h"
60 /* readline defines this. */
63 #include <sys/types.h>
65 #include "event-top.h"
70 #include "tracepoint.h"
81 extern void initialize_all_files (void);
83 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
84 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
85 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
87 /* Default command line prompt. This is overriden in some configs. */
89 #ifndef DEFAULT_PROMPT
90 #define DEFAULT_PROMPT "(gdb) "
93 /* Generate a function that exports a pointer to a field of the
96 #define gen_ret_current_ui_field_ptr(type, name) \
98 current_ui_## name ## _ptr (void) \
100 return ¤t_ui->m_ ## name; \
103 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdout)
104 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdin)
105 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stderr)
106 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdlog)
107 gen_ret_current_ui_field_ptr (struct ui_out *, current_uiout)
109 /* Initialization file name for gdb. This is host-dependent. */
111 const char gdbinit[] = GDBINIT;
113 int inhibit_gdbinit = 0;
115 extern char lang_frame_mismatch_warn[]; /* language.c */
117 /* Flag for whether we want to confirm potentially dangerous
118 operations. Default is yes. */
123 show_confirm (struct ui_file *file, int from_tty,
124 struct cmd_list_element *c, const char *value)
126 fprintf_filtered (file, _("Whether to confirm potentially "
127 "dangerous operations is %s.\n"),
131 /* Flag to indicate whether a user defined command is currently running. */
135 /* Current working directory. */
137 char *current_directory;
139 /* The directory name is actually stored here (usually). */
140 char gdb_dirbuf[1024];
142 /* The last command line executed on the console. Used for command
144 char *saved_command_line;
146 /* Nonzero if the current command is modified by "server ". This
147 affects things like recording into the command history, commands
148 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
149 whatever) can issue its own commands and also send along commands
150 from the user, and have the user not notice that the user interface
151 is issuing commands too. */
154 /* Timeout limit for response from target. */
156 /* The default value has been changed many times over the years. It
157 was originally 5 seconds. But that was thought to be a long time
158 to sit and wait, so it was changed to 2 seconds. That was thought
159 to be plenty unless the connection was going through some terminal
160 server or multiplexer or other form of hairy serial connection.
162 In mid-1996, remote_timeout was moved from remote.c to top.c and
163 it began being used in other remote-* targets. It appears that the
164 default was changed to 20 seconds at that time, perhaps because the
165 Renesas E7000 ICE didn't always respond in a timely manner.
167 But if 5 seconds is a long time to sit and wait for retransmissions,
168 20 seconds is far worse. This demonstrates the difficulty of using
169 a single variable for all protocol timeouts.
171 As remote.c is used much more than remote-e7000.c, it was changed
172 back to 2 seconds in 1999. */
174 int remote_timeout = 2;
176 /* Non-zero tells remote* modules to output debugging info. */
178 int remote_debug = 0;
180 /* Sbrk location on entry to main. Used for statistics only. */
185 /* Hooks for alternate command interfaces. */
187 /* This hook is called from within gdb's many mini-event loops which
188 could steal control from a real user interface's event loop. It
189 returns non-zero if the user is requesting a detach, zero
192 int (*deprecated_ui_loop_hook) (int);
195 /* Called from print_frame_info to list the line we stopped in. */
197 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
201 /* Replaces most of query. */
203 int (*deprecated_query_hook) (const char *, va_list);
205 /* Replaces most of warning. */
207 void (*deprecated_warning_hook) (const char *, va_list);
209 /* These three functions support getting lines of text from the user.
210 They are used in sequence. First deprecated_readline_begin_hook is
211 called with a text string that might be (for example) a message for
212 the user to type in a sequence of commands to be executed at a
213 breakpoint. If this function calls back to a GUI, it might take
214 this opportunity to pop up a text interaction window with this
215 message. Next, deprecated_readline_hook is called with a prompt
216 that is emitted prior to collecting the user input. It can be
217 called multiple times. Finally, deprecated_readline_end_hook is
218 called to notify the GUI that we are done with the interaction
219 window and it can close it. */
221 void (*deprecated_readline_begin_hook) (char *, ...);
222 char *(*deprecated_readline_hook) (const char *);
223 void (*deprecated_readline_end_hook) (void);
225 /* Called as appropriate to notify the interface that we have attached
226 to or detached from an already running process. */
228 void (*deprecated_attach_hook) (void);
229 void (*deprecated_detach_hook) (void);
231 /* Called during long calculations to allow GUI to repair window
232 damage, and to check for stop buttons, etc... */
234 void (*deprecated_interactive_hook) (void);
236 /* Called when going to wait for the target. Usually allows the GUI
237 to run while waiting for target events. */
239 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
240 struct target_waitstatus *status,
243 /* Used by UI as a wrapper around command execution. May do various
244 things like enabling/disabling buttons, etc... */
246 void (*deprecated_call_command_hook) (struct cmd_list_element * c,
247 char *cmd, int from_tty);
249 /* Called when the current thread changes. Argument is thread id. */
251 void (*deprecated_context_hook) (int id);
253 /* The highest UI number ever assigned. */
254 static int highest_ui_num;
259 new_ui (FILE *instream, FILE *outstream, FILE *errstream)
263 ui = XCNEW (struct ui);
265 ui->num = ++highest_ui_num;
266 ui->stdin_stream = instream;
267 ui->instream = instream;
268 ui->outstream = outstream;
269 ui->errstream = errstream;
271 ui->input_fd = fileno (ui->instream);
273 ui->input_interactive_p = ISATTY (ui->instream);
275 ui->m_gdb_stdin = stdio_fileopen (ui->instream);
276 ui->m_gdb_stdout = stdio_fileopen (ui->outstream);
277 ui->m_gdb_stderr = stderr_fileopen (ui->errstream);
278 ui->m_gdb_stdlog = ui->m_gdb_stderr;
280 ui->prompt_state = PROMPT_NEEDED;
288 for (last = ui_list; last->next != NULL; last = last->next)
297 free_ui (struct ui *ui)
299 ui_file_delete (ui->m_gdb_stdin);
300 ui_file_delete (ui->m_gdb_stdout);
301 ui_file_delete (ui->m_gdb_stderr);
307 delete_ui (struct ui *todel)
309 struct ui *ui, *uiprev;
313 for (ui = ui_list; ui != NULL; uiprev = ui, ui = ui->next)
317 gdb_assert (ui != NULL);
320 uiprev->next = ui->next;
327 /* Cleanup that deletes a UI. */
330 delete_ui_cleanup (void *void_ui)
332 struct ui *ui = (struct ui *) void_ui;
340 make_delete_ui_cleanup (struct ui *ui)
342 return make_cleanup (delete_ui_cleanup, ui);
345 /* Open file named NAME for read/write, making sure not to make it the
346 controlling terminal. */
349 open_terminal_stream (const char *name)
353 fd = open (name, O_RDWR | O_NOCTTY);
355 perror_with_name (_("opening terminal failed"));
357 return fdopen (fd, "w+");
360 /* Implementation of the "new-ui" command. */
363 new_ui_command (char *args, int from_tty)
366 struct interp *interp;
367 FILE *stream[3] = { NULL, NULL, NULL };
372 const char *interpreter_name;
373 const char *tty_name;
374 struct cleanup *success_chain;
375 struct cleanup *failure_chain;
379 argv = gdb_buildargv (args);
380 success_chain = make_cleanup_freeargv (argv);
381 argc = countargv (argv);
384 error (_("usage: new-ui <interpreter> <tty>"));
386 interpreter_name = argv[0];
390 scoped_restore save_ui = make_scoped_restore (¤t_ui);
392 failure_chain = make_cleanup (null_cleanup, NULL);
394 /* Open specified terminal, once for each of
395 stdin/stdout/stderr. */
396 for (i = 0; i < 3; i++)
398 stream[i] = open_terminal_stream (tty_name);
399 make_cleanup_fclose (stream[i]);
402 ui = new_ui (stream[0], stream[1], stream[2]);
403 make_cleanup (delete_ui_cleanup, ui);
409 set_top_level_interpreter (interpreter_name);
411 interp_pre_command_loop (top_level_interpreter ());
413 discard_cleanups (failure_chain);
415 /* This restores the previous UI and frees argv. */
416 do_cleanups (success_chain);
419 printf_unfiltered ("New UI allocated\n");
422 /* Handler for SIGHUP. */
425 /* NOTE 1999-04-29: This function will be static again, once we modify
426 gdb to use the event loop as the default command loop and we merge
427 event-top.c into this file, top.c. */
431 /* Stop asking user for confirmation --- we're exiting. This
432 prevents asking the user dumb questions. */
434 quit_command ((char *) 0, 0);
436 #endif /* defined SIGHUP */
438 /* Line number we are currently in, in a file which is being sourced. */
439 /* NOTE 1999-04-29: This variable will be static again, once we modify
440 gdb to use the event loop as the default command loop and we merge
441 event-top.c into this file, top.c. */
442 /* static */ int source_line_number;
444 /* Name of the file we are sourcing. */
445 /* NOTE 1999-04-29: This variable will be static again, once we modify
446 gdb to use the event loop as the default command loop and we merge
447 event-top.c into this file, top.c. */
448 /* static */ const char *source_file_name;
450 /* Clean up on error during a "source" command (or execution of a
451 user-defined command). */
454 do_restore_instream_cleanup (void *stream)
456 struct ui *ui = current_ui;
458 /* Restore the previous input stream. */
459 ui->instream = (FILE *) stream;
462 /* Read commands from STREAM. */
464 read_command_file (FILE *stream)
466 struct ui *ui = current_ui;
467 struct cleanup *cleanups;
469 cleanups = make_cleanup (do_restore_instream_cleanup, ui->instream);
470 ui->instream = stream;
472 /* Read commands from `instream' and execute them until end of file
473 or error reading instream. */
475 while (ui->instream != NULL && !feof (ui->instream))
479 /* Get a command-line. This calls the readline package. */
480 command = command_line_input (NULL, 0, NULL);
483 command_handler (command);
486 do_cleanups (cleanups);
489 void (*pre_init_ui_hook) (void);
493 do_chdir_cleanup (void *old_dir)
495 chdir ((const char *) old_dir);
501 prepare_execute_command (void)
504 struct cleanup *cleanup;
506 mark = value_mark ();
507 cleanup = make_cleanup_value_free_to_mark (mark);
509 /* With multiple threads running while the one we're examining is
510 stopped, the dcache can get stale without us being able to detect
511 it. For the duration of the command, though, use the dcache to
512 help things like backtrace. */
514 target_dcache_invalidate ();
519 /* Tell the user if the language has changed (except first time) after
520 executing a command. */
523 check_frame_language_change (void)
525 static int warned = 0;
526 struct frame_info *frame;
528 /* First make sure that a new frame has been selected, in case the
529 command or the hooks changed the program state. */
530 frame = deprecated_safe_get_selected_frame ();
531 if (current_language != expected_language)
533 if (language_mode == language_mode_auto && info_verbose)
535 language_info (1); /* Print what changed. */
540 /* Warn the user if the working language does not match the language
541 of the current frame. Only warn the user if we are actually
542 running the program, i.e. there is a stack. */
543 /* FIXME: This should be cacheing the frame and only running when
544 the frame changes. */
546 if (has_stack_frames ())
550 flang = get_frame_language (frame);
552 && flang != language_unknown
553 && flang != current_language->la_language)
555 printf_filtered ("%s\n", lang_frame_mismatch_warn);
564 wait_sync_command_done (void)
566 /* Processing events may change the current UI. */
567 scoped_restore save_ui = make_scoped_restore (¤t_ui);
568 struct ui *ui = current_ui;
570 while (gdb_do_one_event () >= 0)
571 if (ui->prompt_state != PROMPT_BLOCKED)
578 maybe_wait_sync_command_done (int was_sync)
580 /* If the interpreter is in sync mode (we're running a user
581 command's list, running command hooks or similars), and we
582 just ran a synchronous command that started the target, wait
583 for that command to end. */
584 if (!current_ui->async
586 && current_ui->prompt_state == PROMPT_BLOCKED)
587 wait_sync_command_done ();
590 /* Execute the line P as a command, in the current user context.
591 Pass FROM_TTY as second argument to the defining function. */
594 execute_command (char *p, int from_tty)
596 struct cleanup *cleanup_if_error, *cleanup;
597 struct cmd_list_element *c;
600 cleanup_if_error = make_bpstat_clear_actions_cleanup ();
601 cleanup = prepare_execute_command ();
603 /* Force cleanup of any alloca areas if using C alloca instead of
607 /* This can happen when command_line_input hits end of file. */
610 do_cleanups (cleanup);
611 discard_cleanups (cleanup_if_error);
615 target_log_command (p);
617 while (*p == ' ' || *p == '\t')
623 int was_sync = current_ui->prompt_state == PROMPT_BLOCKED;
627 /* If trace-commands is set then this will print this command. */
628 print_command_trace (p);
630 c = lookup_cmd (&cmd, cmdlist, "", 0, 1);
633 /* Pass null arg rather than an empty one. */
636 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
637 while the is_complete_command(cfunc) test is just plain
638 bogus. They should both be replaced by a test of the form
639 c->strip_trailing_white_space_p. */
640 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
641 can't be replaced with func. This is because it is the
642 cfunc, and not the func, that has the value that the
643 is_complete_command hack is testing for. */
644 /* Clear off trailing whitespace, except for set and complete
647 && c->type != set_cmd
648 && !is_complete_command (c))
650 p = arg + strlen (arg) - 1;
651 while (p >= arg && (*p == ' ' || *p == '\t'))
656 /* If this command has been pre-hooked, run the hook first. */
657 execute_cmd_pre_hook (c);
659 if (c->deprecated_warn_user)
660 deprecated_cmd_warning (line);
662 /* c->user_commands would be NULL in the case of a python command. */
663 if (c->theclass == class_user && c->user_commands)
664 execute_user_command (c, arg);
665 else if (c->type == set_cmd)
666 do_set_command (arg, from_tty, c);
667 else if (c->type == show_cmd)
668 do_show_command (arg, from_tty, c);
669 else if (!cmd_func_p (c))
670 error (_("That is not a command, just a help topic."));
671 else if (deprecated_call_command_hook)
672 deprecated_call_command_hook (c, arg, from_tty);
674 cmd_func (c, arg, from_tty);
676 maybe_wait_sync_command_done (was_sync);
678 /* If this command has been post-hooked, run the hook last. */
679 execute_cmd_post_hook (c);
683 check_frame_language_change ();
685 do_cleanups (cleanup);
686 discard_cleanups (cleanup_if_error);
689 /* Run execute_command for P and FROM_TTY. Capture its output into the
690 returned string, do not display it to the screen. BATCH_FLAG will be
691 temporarily set to true. */
694 execute_command_to_string (char *p, int from_tty)
696 struct ui_file *str_file;
697 struct cleanup *cleanup;
699 /* GDB_STDOUT should be better already restored during these
700 restoration callbacks. */
701 cleanup = set_batch_flag_and_make_cleanup_restore_page_info ();
703 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
705 str_file = mem_fileopen ();
707 make_cleanup_ui_file_delete (str_file);
709 if (ui_out_redirect (current_uiout, str_file) < 0)
710 warning (_("Current output protocol does not support redirection"));
712 make_cleanup_ui_out_redirect_pop (current_uiout);
714 scoped_restore save_stdout
715 = make_scoped_restore (&gdb_stdout, str_file);
716 scoped_restore save_stderr
717 = make_scoped_restore (&gdb_stderr, str_file);
718 scoped_restore save_stdlog
719 = make_scoped_restore (&gdb_stdlog, str_file);
720 scoped_restore save_stdtarg
721 = make_scoped_restore (&gdb_stdtarg, str_file);
722 scoped_restore save_stdtargerr
723 = make_scoped_restore (&gdb_stdtargerr, str_file);
725 execute_command (p, from_tty);
727 std::string retval = ui_file_as_string (str_file);
729 do_cleanups (cleanup);
735 /* When nonzero, cause dont_repeat to do nothing. This should only be
736 set via prevent_dont_repeat. */
738 static int suppress_dont_repeat = 0;
740 /* Commands call this if they do not want to be repeated by null lines. */
745 struct ui *ui = current_ui;
747 if (suppress_dont_repeat || server_command)
750 /* If we aren't reading from standard input, we are saving the last
751 thing read from stdin in line and don't want to delete it. Null
752 lines won't repeat here in any case. */
753 if (ui->instream == ui->stdin_stream)
754 *saved_command_line = 0;
757 /* Prevent dont_repeat from working, and return a cleanup that
758 restores the previous state. */
761 prevent_dont_repeat (void)
763 struct cleanup *result = make_cleanup_restore_integer (&suppress_dont_repeat);
765 suppress_dont_repeat = 1;
770 /* Read a line from the stream "instream" without command line editing.
772 It prints PROMPT once at the start.
773 Action is compatible with "readline", e.g. space for the result is
774 malloc'd and should be freed by the caller.
776 A NULL return means end of file. */
779 gdb_readline_no_editing (const char *prompt)
781 struct buffer line_buffer;
782 struct ui *ui = current_ui;
783 /* Read from stdin if we are executing a user defined command. This
784 is the right thing for prompt_for_continue, at least. */
785 FILE *stream = ui->instream != NULL ? ui->instream : stdin;
786 int fd = fileno (stream);
788 buffer_init (&line_buffer);
792 /* Don't use a _filtered function here. It causes the assumed
793 character position to be off, since the newline we read from
794 the user is not accounted for. */
795 fputs_unfiltered (prompt, gdb_stdout);
796 gdb_flush (gdb_stdout);
807 /* Wait until at least one byte of data is available. Control-C
808 can interrupt interruptible_select, but not fgetc. */
810 FD_SET (fd, &readfds);
811 if (interruptible_select (fd + 1, &readfds, NULL, NULL, NULL) == -1)
815 /* If this was ctrl-c, the QUIT above handles it. */
818 perror_with_name (("select"));
825 if (line_buffer.used_size > 0)
826 /* The last line does not end with a newline. Return it, and
827 if we are called again fgetc will still return EOF and
828 we'll return NULL then. */
830 xfree (buffer_finish (&line_buffer));
836 if (line_buffer.used_size > 0
837 && line_buffer.buffer[line_buffer.used_size - 1] == '\r')
838 line_buffer.used_size--;
842 buffer_grow_char (&line_buffer, c);
845 buffer_grow_char (&line_buffer, '\0');
846 return buffer_finish (&line_buffer);
849 /* Variables which control command line editing and history
850 substitution. These variables are given default values at the end
852 static int command_editing_p;
854 /* NOTE 1999-04-29: This variable will be static again, once we modify
855 gdb to use the event loop as the default command loop and we merge
856 event-top.c into this file, top.c. */
858 /* static */ int history_expansion_p;
860 static int write_history_p;
862 show_write_history_p (struct ui_file *file, int from_tty,
863 struct cmd_list_element *c, const char *value)
865 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
869 /* The variable associated with the "set/show history size"
870 command. The value -1 means unlimited, and -2 means undefined. */
871 static int history_size_setshow_var = -2;
874 show_history_size (struct ui_file *file, int from_tty,
875 struct cmd_list_element *c, const char *value)
877 fprintf_filtered (file, _("The size of the command history is %s.\n"),
881 /* Variable associated with the "history remove-duplicates" option.
882 The value -1 means unlimited. */
883 static int history_remove_duplicates = 0;
886 show_history_remove_duplicates (struct ui_file *file, int from_tty,
887 struct cmd_list_element *c, const char *value)
889 fprintf_filtered (file,
890 _("The number of history entries to look back at for "
891 "duplicates is %s.\n"),
895 static char *history_filename;
897 show_history_filename (struct ui_file *file, int from_tty,
898 struct cmd_list_element *c, const char *value)
900 fprintf_filtered (file, _("The filename in which to record "
901 "the command history is \"%s\".\n"),
905 /* This is like readline(), but it has some gdb-specific behavior.
906 gdb may want readline in both the synchronous and async modes during
907 a single gdb invocation. At the ordinary top-level prompt we might
908 be using the async readline. That means we can't use
909 rl_pre_input_hook, since it doesn't work properly in async mode.
910 However, for a secondary prompt (" >", such as occurs during a
911 `define'), gdb wants a synchronous response.
913 We used to call readline() directly, running it in synchronous
914 mode. But mixing modes this way is not supported, and as of
915 readline 5.x it no longer works; the arrow keys come unbound during
916 the synchronous call. So we make a nested call into the event
917 loop. That's what gdb_readline_wrapper is for. */
919 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
920 rely on gdb_readline_wrapper_result, which might still be NULL if
921 the user types Control-D for EOF. */
922 static int gdb_readline_wrapper_done;
924 /* The result of the current call to gdb_readline_wrapper, once a newline
926 static char *gdb_readline_wrapper_result;
928 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
929 to be called after the newline is processed (which will redisplay
930 the prompt). But in gdb_readline_wrapper we will not get a new
931 prompt until the next call, or until we return to the event loop.
932 So we disable this hook around the newline and restore it before we
934 static void (*saved_after_char_processing_hook) (void);
940 gdb_in_secondary_prompt_p (struct ui *ui)
942 return ui->secondary_prompt_depth > 0;
946 /* This function is called when readline has seen a complete line of
950 gdb_readline_wrapper_line (char *line)
952 gdb_assert (!gdb_readline_wrapper_done);
953 gdb_readline_wrapper_result = line;
954 gdb_readline_wrapper_done = 1;
956 /* Prevent operate-and-get-next from acting too early. */
957 saved_after_char_processing_hook = after_char_processing_hook;
958 after_char_processing_hook = NULL;
960 /* Prevent parts of the prompt from being redisplayed if annotations
961 are enabled, and readline's state getting out of sync. We'll
962 reinstall the callback handler, which puts the terminal in raw
963 mode (or in readline lingo, in prepped state), when we're next
964 ready to process user input, either in display_gdb_prompt, or if
965 we're handling an asynchronous target event and running in the
966 background, just before returning to the event loop to process
967 further input (or more target events). */
968 if (current_ui->command_editing)
969 gdb_rl_callback_handler_remove ();
972 struct gdb_readline_wrapper_cleanup
974 void (*handler_orig) (char *);
975 int already_prompted_orig;
977 /* Whether the target was async. */
978 int target_is_async_orig;
982 gdb_readline_wrapper_cleanup (void *arg)
984 struct ui *ui = current_ui;
985 struct gdb_readline_wrapper_cleanup *cleanup
986 = (struct gdb_readline_wrapper_cleanup *) arg;
988 if (ui->command_editing)
989 rl_already_prompted = cleanup->already_prompted_orig;
991 gdb_assert (ui->input_handler == gdb_readline_wrapper_line);
992 ui->input_handler = cleanup->handler_orig;
994 /* Don't restore our input handler in readline yet. That would make
995 readline prep the terminal (putting it in raw mode), while the
996 line we just read may trigger execution of a command that expects
997 the terminal in the default cooked/canonical mode, such as e.g.,
998 running Python's interactive online help utility. See
999 gdb_readline_wrapper_line for when we'll reinstall it. */
1001 gdb_readline_wrapper_result = NULL;
1002 gdb_readline_wrapper_done = 0;
1003 ui->secondary_prompt_depth--;
1004 gdb_assert (ui->secondary_prompt_depth >= 0);
1006 after_char_processing_hook = saved_after_char_processing_hook;
1007 saved_after_char_processing_hook = NULL;
1009 if (cleanup->target_is_async_orig)
1016 gdb_readline_wrapper (const char *prompt)
1018 struct ui *ui = current_ui;
1019 struct cleanup *back_to;
1020 struct gdb_readline_wrapper_cleanup *cleanup;
1023 cleanup = XNEW (struct gdb_readline_wrapper_cleanup);
1024 cleanup->handler_orig = ui->input_handler;
1025 ui->input_handler = gdb_readline_wrapper_line;
1027 if (ui->command_editing)
1028 cleanup->already_prompted_orig = rl_already_prompted;
1030 cleanup->already_prompted_orig = 0;
1032 cleanup->target_is_async_orig = target_is_async_p ();
1034 ui->secondary_prompt_depth++;
1035 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
1037 /* Processing events may change the current UI. */
1038 scoped_restore save_ui = make_scoped_restore (¤t_ui);
1040 if (cleanup->target_is_async_orig)
1043 /* Display our prompt and prevent double prompt display. */
1044 display_gdb_prompt (prompt);
1045 if (ui->command_editing)
1046 rl_already_prompted = 1;
1048 if (after_char_processing_hook)
1049 (*after_char_processing_hook) ();
1050 gdb_assert (after_char_processing_hook == NULL);
1052 while (gdb_do_one_event () >= 0)
1053 if (gdb_readline_wrapper_done)
1056 retval = gdb_readline_wrapper_result;
1057 do_cleanups (back_to);
1062 /* The current saved history number from operate-and-get-next.
1063 This is -1 if not valid. */
1064 static int operate_saved_history = -1;
1066 /* This is put on the appropriate hook and helps operate-and-get-next
1069 gdb_rl_operate_and_get_next_completion (void)
1071 int delta = where_history () - operate_saved_history;
1073 /* The `key' argument to rl_get_previous_history is ignored. */
1074 rl_get_previous_history (delta, 0);
1075 operate_saved_history = -1;
1077 /* readline doesn't automatically update the display for us. */
1080 after_char_processing_hook = NULL;
1081 rl_pre_input_hook = NULL;
1084 /* This is a gdb-local readline command handler. It accepts the
1085 current command line (like RET does) and, if this command was taken
1086 from the history, arranges for the next command in the history to
1087 appear on the command line when the prompt returns.
1088 We ignore the arguments. */
1090 gdb_rl_operate_and_get_next (int count, int key)
1094 /* Use the async hook. */
1095 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
1097 /* Find the current line, and find the next line to use. */
1098 where = where_history();
1100 if ((history_is_stifled () && (history_length >= history_max_entries))
1101 || (where >= history_length - 1))
1102 operate_saved_history = where;
1104 operate_saved_history = where + 1;
1106 return rl_newline (1, key);
1109 /* Number of user commands executed during this session. */
1111 static int command_count = 0;
1113 /* Add the user command COMMAND to the input history list. */
1116 gdb_add_history (const char *command)
1120 if (history_remove_duplicates != 0)
1123 int lookbehind_threshold;
1125 /* The lookbehind threshold for finding a duplicate history entry is
1126 bounded by command_count because we can't meaningfully delete
1127 history entries that are already stored in the history file since
1128 the history file is appended to. */
1129 if (history_remove_duplicates == -1
1130 || history_remove_duplicates > command_count)
1131 lookbehind_threshold = command_count;
1133 lookbehind_threshold = history_remove_duplicates;
1136 for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
1138 HIST_ENTRY *temp = previous_history ();
1143 if (strcmp (temp->line, command) == 0)
1145 HIST_ENTRY *prev = remove_history (where_history ());
1147 free_history_entry (prev);
1154 add_history (command);
1157 /* Safely append new history entries to the history file in a corruption-free
1158 way using an intermediate local history file. */
1161 gdb_safe_append_history (void)
1163 int ret, saved_errno;
1164 char *local_history_filename;
1165 struct cleanup *old_chain;
1167 local_history_filename
1168 = xstrprintf ("%s-gdb%ld~", history_filename, (long) getpid ());
1169 old_chain = make_cleanup (xfree, local_history_filename);
1171 ret = rename (history_filename, local_history_filename);
1172 saved_errno = errno;
1173 if (ret < 0 && saved_errno != ENOENT)
1175 warning (_("Could not rename %s to %s: %s"),
1176 history_filename, local_history_filename,
1177 safe_strerror (saved_errno));
1183 /* If the rename failed with ENOENT then either the global history
1184 file never existed in the first place or another GDB process is
1185 currently appending to it (and has thus temporarily renamed it).
1186 Since we can't distinguish between these two cases, we have to
1187 conservatively assume the first case and therefore must write out
1188 (not append) our known history to our local history file and try
1189 to move it back anyway. Otherwise a global history file would
1190 never get created! */
1191 gdb_assert (saved_errno == ENOENT);
1192 write_history (local_history_filename);
1196 append_history (command_count, local_history_filename);
1197 if (history_is_stifled ())
1198 history_truncate_file (local_history_filename, history_max_entries);
1201 ret = rename (local_history_filename, history_filename);
1202 saved_errno = errno;
1203 if (ret < 0 && saved_errno != EEXIST)
1204 warning (_("Could not rename %s to %s: %s"),
1205 local_history_filename, history_filename,
1206 safe_strerror (saved_errno));
1209 do_cleanups (old_chain);
1212 /* Read one line from the command input stream `instream' into a local
1213 static buffer. The buffer is made bigger as necessary. Returns
1214 the address of the start of the line.
1216 NULL is returned for end of file.
1218 *If* input is from an interactive stream (stdin), the line read is
1219 copied into the global 'saved_command_line' so that it can be
1222 This routine either uses fancy command line editing or simple input
1223 as the user has requested. */
1226 command_line_input (const char *prompt_arg, int repeat, char *annotation_suffix)
1228 static struct buffer cmd_line_buffer;
1229 static int cmd_line_buffer_initialized;
1230 struct ui *ui = current_ui;
1231 const char *prompt = prompt_arg;
1233 int from_tty = ui->instream == ui->stdin_stream;
1235 /* The annotation suffix must be non-NULL. */
1236 if (annotation_suffix == NULL)
1237 annotation_suffix = "";
1239 if (from_tty && annotation_level > 1)
1244 = (char *) alloca ((prompt == NULL ? 0 : strlen (prompt))
1245 + strlen (annotation_suffix) + 40);
1247 local_prompt[0] = '\0';
1249 strcpy (local_prompt, prompt);
1250 strcat (local_prompt, "\n\032\032");
1251 strcat (local_prompt, annotation_suffix);
1252 strcat (local_prompt, "\n");
1254 prompt = local_prompt;
1257 if (!cmd_line_buffer_initialized)
1259 buffer_init (&cmd_line_buffer);
1260 cmd_line_buffer_initialized = 1;
1263 /* Starting a new command line. */
1264 cmd_line_buffer.used_size = 0;
1268 signal (STOP_SIGNAL, handle_stop_sig);
1275 /* Make sure that all output has been output. Some machines may
1276 let you get away with leaving out some of the gdb_flush, but
1279 gdb_flush (gdb_stdout);
1280 gdb_flush (gdb_stderr);
1282 if (source_file_name != NULL)
1283 ++source_line_number;
1285 if (from_tty && annotation_level > 1)
1287 puts_unfiltered ("\n\032\032pre-");
1288 puts_unfiltered (annotation_suffix);
1289 puts_unfiltered ("\n");
1292 /* Don't use fancy stuff if not talking to stdin. */
1293 if (deprecated_readline_hook
1295 && input_interactive_p (current_ui))
1297 rl = (*deprecated_readline_hook) (prompt);
1299 else if (command_editing_p
1301 && input_interactive_p (current_ui))
1303 rl = gdb_readline_wrapper (prompt);
1307 rl = gdb_readline_no_editing (prompt);
1310 cmd = handle_line_of_input (&cmd_line_buffer, rl,
1311 repeat, annotation_suffix);
1312 if (cmd == (char *) EOF)
1325 signal (STOP_SIGNAL, SIG_DFL);
1331 /* Print the GDB banner. */
1333 print_gdb_version (struct ui_file *stream)
1335 /* From GNU coding standards, first line is meant to be easy for a
1336 program to parse, and is just canonical program name and version
1337 number, which starts after last space. */
1339 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1341 /* Second line is a copyright notice. */
1343 fprintf_filtered (stream,
1344 "Copyright (C) 2016 Free Software Foundation, Inc.\n");
1346 /* Following the copyright is a brief statement that the program is
1347 free software, that users are free to copy and change it on
1348 certain conditions, that it is covered by the GNU GPL, and that
1349 there is no warranty. */
1351 fprintf_filtered (stream, "\
1352 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1353 \nThis is free software: you are free to change and redistribute it.\n\
1354 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1355 and \"show warranty\" for details.\n");
1357 /* After the required info we print the configuration information. */
1359 fprintf_filtered (stream, "This GDB was configured as \"");
1360 if (strcmp (host_name, target_name) != 0)
1362 fprintf_filtered (stream, "--host=%s --target=%s",
1363 host_name, target_name);
1367 fprintf_filtered (stream, "%s", host_name);
1369 fprintf_filtered (stream, "\".\n\
1370 Type \"show configuration\" for configuration details.");
1372 if (REPORT_BUGS_TO[0])
1374 fprintf_filtered (stream,
1375 _("\nFor bug reporting instructions, please see:\n"));
1376 fprintf_filtered (stream, "%s.\n", REPORT_BUGS_TO);
1378 fprintf_filtered (stream,
1379 _("Find the GDB manual and other documentation \
1380 resources online at:\n<http://www.gnu.org/software/gdb/documentation/>.\n"));
1381 fprintf_filtered (stream, _("For help, type \"help\".\n"));
1382 fprintf_filtered (stream, _("Type \"apropos word\" to search for \
1383 commands related to \"word\"."));
1386 /* Print the details of GDB build-time configuration. */
1388 print_gdb_configuration (struct ui_file *stream)
1390 fprintf_filtered (stream, _("\
1391 This GDB was configured as follows:\n\
1392 configure --host=%s --target=%s\n\
1393 "), host_name, target_name);
1394 fprintf_filtered (stream, _("\
1395 --with-auto-load-dir=%s\n\
1396 --with-auto-load-safe-path=%s\n\
1397 "), AUTO_LOAD_DIR, AUTO_LOAD_SAFE_PATH);
1399 fprintf_filtered (stream, _("\
1403 fprintf_filtered (stream, _("\
1408 fprintf_filtered (stream, _("\
1409 --with-gdb-datadir=%s%s\n\
1410 "), GDB_DATADIR, GDB_DATADIR_RELOCATABLE ? " (relocatable)" : "");
1412 fprintf_filtered (stream, _("\
1413 --with-iconv-bin=%s%s\n\
1414 "), ICONV_BIN, ICONV_BIN_RELOCATABLE ? " (relocatable)" : "");
1416 if (JIT_READER_DIR[0])
1417 fprintf_filtered (stream, _("\
1418 --with-jit-reader-dir=%s%s\n\
1419 "), JIT_READER_DIR, JIT_READER_DIR_RELOCATABLE ? " (relocatable)" : "");
1420 #if HAVE_LIBUNWIND_IA64_H
1421 fprintf_filtered (stream, _("\
1422 --with-libunwind-ia64\n\
1425 fprintf_filtered (stream, _("\
1426 --without-libunwind-ia64\n\
1430 fprintf_filtered (stream, _("\
1434 fprintf_filtered (stream, _("\
1438 #ifdef WITH_PYTHON_PATH
1439 fprintf_filtered (stream, _("\
1440 --with-python=%s%s\n\
1441 "), WITH_PYTHON_PATH, PYTHON_PATH_RELOCATABLE ? " (relocatable)" : "");
1444 fprintf_filtered (stream, _("\
1448 fprintf_filtered (stream, _("\
1453 fprintf_filtered (stream, _("\
1454 --with-relocated-sources=%s\n\
1458 fprintf_filtered (stream, _("\
1459 --with-separate-debug-dir=%s%s\n\
1460 "), DEBUGDIR, DEBUGDIR_RELOCATABLE ? " (relocatable)" : "");
1461 if (TARGET_SYSTEM_ROOT[0])
1462 fprintf_filtered (stream, _("\
1463 --with-sysroot=%s%s\n\
1464 "), TARGET_SYSTEM_ROOT, TARGET_SYSTEM_ROOT_RELOCATABLE ? " (relocatable)" : "");
1465 if (SYSTEM_GDBINIT[0])
1466 fprintf_filtered (stream, _("\
1467 --with-system-gdbinit=%s%s\n\
1468 "), SYSTEM_GDBINIT, SYSTEM_GDBINIT_RELOCATABLE ? " (relocatable)" : "");
1469 #if HAVE_LIBBABELTRACE
1470 fprintf_filtered (stream, _("\
1471 --with-babeltrace\n\
1474 fprintf_filtered (stream, _("\
1475 --without-babeltrace\n\
1478 /* We assume "relocatable" will be printed at least once, thus we always
1479 print this text. It's a reasonably safe assumption for now. */
1480 fprintf_filtered (stream, _("\n\
1481 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1482 tree, and GDB will still find it.)\n\
1487 /* The current top level prompt, settable with "set prompt", and/or
1488 with the python `gdb.prompt_hook' hook. */
1489 static char *top_prompt;
1491 /* Access method for the GDB prompt string. */
1499 /* Set method for the GDB prompt string. */
1502 set_prompt (const char *s)
1504 char *p = xstrdup (s);
1517 /* Callback for iterate_over_inferiors. Kills or detaches the given
1518 inferior, depending on how we originally gained control of it. */
1521 kill_or_detach (struct inferior *inf, void *args)
1523 struct qt_args *qt = (struct qt_args *) args;
1524 struct thread_info *thread;
1529 thread = any_thread_of_process (inf->pid);
1532 switch_to_thread (thread->ptid);
1534 /* Leave core files alone. */
1535 if (target_has_execution)
1537 if (inf->attach_flag)
1538 target_detach (qt->args, qt->from_tty);
1547 /* Callback for iterate_over_inferiors. Prints info about what GDB
1548 will do to each inferior on a "quit". ARG points to a struct
1549 ui_out where output is to be collected. */
1552 print_inferior_quit_action (struct inferior *inf, void *arg)
1554 struct ui_file *stb = (struct ui_file *) arg;
1559 if (inf->attach_flag)
1560 fprintf_filtered (stb,
1561 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1562 target_pid_to_str (pid_to_ptid (inf->pid)));
1564 fprintf_filtered (stb,
1565 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1566 target_pid_to_str (pid_to_ptid (inf->pid)));
1571 /* If necessary, make the user confirm that we should quit. Return
1572 non-zero if we should quit, zero if we shouldn't. */
1577 struct ui_file *stb;
1578 struct cleanup *old_chain;
1580 /* Don't even ask if we're only debugging a core file inferior. */
1581 if (!have_live_inferiors ())
1584 /* Build the query string as a single string. */
1585 stb = mem_fileopen ();
1586 old_chain = make_cleanup_ui_file_delete (stb);
1588 fprintf_filtered (stb, _("A debugging session is active.\n\n"));
1589 iterate_over_inferiors (print_inferior_quit_action, stb);
1590 fprintf_filtered (stb, _("\nQuit anyway? "));
1592 std::string str = ui_file_as_string (stb);
1594 do_cleanups (old_chain);
1596 return query ("%s", str.c_str ());
1599 /* Prepare to exit GDB cleanly by undoing any changes made to the
1600 terminal so that we leave the terminal in the state we acquired it. */
1603 undo_terminal_modifications_before_exit (void)
1605 struct ui *saved_top_level = current_ui;
1607 target_terminal_ours ();
1609 current_ui = main_ui;
1614 gdb_disable_readline ();
1616 current_ui = saved_top_level;
1620 /* Quit without asking for confirmation. */
1623 quit_force (int *exit_arg, int from_tty)
1628 undo_terminal_modifications_before_exit ();
1630 /* An optional expression may be used to cause gdb to terminate with the
1631 value of that expression. */
1633 exit_code = *exit_arg;
1634 else if (return_child_result)
1635 exit_code = return_child_result_value;
1638 qt.from_tty = from_tty;
1640 /* We want to handle any quit errors and exit regardless. */
1642 /* Get out of tfind mode, and kill or detach all inferiors. */
1645 disconnect_tracing ();
1646 iterate_over_inferiors (kill_or_detach, &qt);
1648 CATCH (ex, RETURN_MASK_ALL)
1650 exception_print (gdb_stderr, ex);
1654 /* Give all pushed targets a chance to do minimal cleanup, and pop
1660 CATCH (ex, RETURN_MASK_ALL)
1662 exception_print (gdb_stderr, ex);
1666 /* Save the history information if it is appropriate to do so. */
1669 if (write_history_p && history_filename)
1674 /* History is currently shared between all UIs. If there's
1675 any UI with a terminal, save history. */
1678 if (input_interactive_p (ui))
1686 gdb_safe_append_history ();
1689 CATCH (ex, RETURN_MASK_ALL)
1691 exception_print (gdb_stderr, ex);
1695 /* Do any final cleanups before exiting. */
1698 do_final_cleanups (all_cleanups ());
1700 CATCH (ex, RETURN_MASK_ALL)
1702 exception_print (gdb_stderr, ex);
1709 /* The value of the "interactive-mode" setting. */
1710 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
1712 /* Implement the "show interactive-mode" option. */
1715 show_interactive_mode (struct ui_file *file, int from_tty,
1716 struct cmd_list_element *c,
1719 if (interactive_mode == AUTO_BOOLEAN_AUTO)
1720 fprintf_filtered (file, "Debugger's interactive mode "
1721 "is %s (currently %s).\n",
1722 value, input_interactive_p (current_ui) ? "on" : "off");
1724 fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
1727 /* Returns whether GDB is running on an interactive terminal. */
1730 input_interactive_p (struct ui *ui)
1735 if (interactive_mode != AUTO_BOOLEAN_AUTO)
1736 return interactive_mode == AUTO_BOOLEAN_TRUE;
1738 return ui->input_interactive_p;
1742 dont_repeat_command (char *ignored, int from_tty)
1744 /* Can't call dont_repeat here because we're not necessarily reading
1746 *saved_command_line = 0;
1749 /* Functions to manipulate command line editing control variables. */
1751 /* Number of commands to print in each call to show_commands. */
1752 #define Hist_print 10
1754 show_commands (char *args, int from_tty)
1756 /* Index for history commands. Relative to history_base. */
1759 /* Number of the history entry which we are planning to display next.
1760 Relative to history_base. */
1763 /* Print out some of the commands from the command history. */
1767 if (args[0] == '+' && args[1] == '\0')
1768 /* "info editing +" should print from the stored position. */
1771 /* "info editing <exp>" should print around command number <exp>. */
1772 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1774 /* "show commands" means print the last Hist_print commands. */
1777 num = history_length - Hist_print;
1783 /* If there are at least Hist_print commands, we want to display the last
1784 Hist_print rather than, say, the last 6. */
1785 if (history_length - num < Hist_print)
1787 num = history_length - Hist_print;
1793 offset < num + Hist_print && offset < history_length;
1796 printf_filtered ("%5d %s\n", history_base + offset,
1797 (history_get (history_base + offset))->line);
1800 /* The next command we want to display is the next one that we haven't
1804 /* If the user repeats this command with return, it should do what
1805 "show commands +" does. This is unnecessary if arg is null,
1806 because "show commands +" is not useful after "show commands". */
1807 if (from_tty && args)
1814 /* Update the size of our command history file to HISTORY_SIZE.
1816 A HISTORY_SIZE of -1 stands for unlimited. */
1819 set_readline_history_size (int history_size)
1821 gdb_assert (history_size >= -1);
1823 if (history_size == -1)
1824 unstifle_history ();
1826 stifle_history (history_size);
1829 /* Called by do_setshow_command. */
1831 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1833 set_readline_history_size (history_size_setshow_var);
1837 set_history (char *args, int from_tty)
1839 printf_unfiltered (_("\"set history\" must be followed "
1840 "by the name of a history subcommand.\n"));
1841 help_list (sethistlist, "set history ", all_commands, gdb_stdout);
1845 show_history (char *args, int from_tty)
1847 cmd_show_list (showhistlist, from_tty, "");
1850 int info_verbose = 0; /* Default verbose msgs off. */
1852 /* Called by do_setshow_command. An elaborate joke. */
1854 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1856 const char *cmdname = "verbose";
1857 struct cmd_list_element *showcmd;
1859 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1860 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1864 c->doc = "Set verbose printing of informational messages.";
1865 showcmd->doc = "Show verbose printing of informational messages.";
1869 c->doc = "Set verbosity.";
1870 showcmd->doc = "Show verbosity.";
1874 /* Init the history buffer. Note that we are called after the init file(s)
1875 have been read so that the user can change the history file via his
1876 .gdbinit file (for instance). The GDBHISTFILE environment variable
1877 overrides all of this. */
1884 tmpenv = getenv ("GDBHISTSIZE");
1891 tmpenv = skip_spaces (tmpenv);
1893 var = strtol (tmpenv, &endptr, 10);
1894 saved_errno = errno;
1895 endptr = skip_spaces (endptr);
1897 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1898 empty string, a negative number or a huge positive number (larger than
1899 INT_MAX) then set the history size to unlimited. Otherwise set our
1900 history size to the number we have read. This behavior is consistent
1901 with how bash handles HISTSIZE. */
1902 if (*endptr != '\0')
1904 else if (*tmpenv == '\0'
1907 /* On targets where INT_MAX == LONG_MAX, we have to look at
1908 errno after calling strtol to distinguish between a value that
1909 is exactly INT_MAX and an overflowing value that was clamped
1911 || (var == INT_MAX && saved_errno == ERANGE))
1912 history_size_setshow_var = -1;
1914 history_size_setshow_var = var;
1917 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1919 if (history_size_setshow_var == -2)
1920 history_size_setshow_var = 256;
1922 set_readline_history_size (history_size_setshow_var);
1924 tmpenv = getenv ("GDBHISTFILE");
1926 history_filename = xstrdup (tmpenv);
1927 else if (!history_filename)
1929 /* We include the current directory so that if the user changes
1930 directories the file written will be the same as the one
1933 /* No leading dots in file names are allowed on MSDOS. */
1934 history_filename = concat (current_directory, "/_gdb_history",
1937 history_filename = concat (current_directory, "/.gdb_history",
1941 read_history (history_filename);
1945 show_prompt (struct ui_file *file, int from_tty,
1946 struct cmd_list_element *c, const char *value)
1948 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1951 /* "set editing" command. */
1954 set_editing (char *args, int from_tty, struct cmd_list_element *c)
1956 change_line_handler (set_editing_cmd_var);
1957 /* Update the control variable so that MI's =cmd-param-changed event
1958 shows the correct value. */
1959 set_editing_cmd_var = current_ui->command_editing;
1963 show_editing (struct ui_file *file, int from_tty,
1964 struct cmd_list_element *c, const char *value)
1966 fprintf_filtered (file, _("Editing of command lines as "
1967 "they are typed is %s.\n"),
1968 current_ui->command_editing ? _("on") : _("off"));
1972 show_annotation_level (struct ui_file *file, int from_tty,
1973 struct cmd_list_element *c, const char *value)
1975 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1979 show_exec_done_display_p (struct ui_file *file, int from_tty,
1980 struct cmd_list_element *c, const char *value)
1982 fprintf_filtered (file, _("Notification of completion for "
1983 "asynchronous execution commands is %s.\n"),
1987 /* New values of the "data-directory" parameter are staged here. */
1988 static char *staged_gdb_datadir;
1990 /* "set" command for the gdb_datadir configuration variable. */
1993 set_gdb_datadir (char *args, int from_tty, struct cmd_list_element *c)
1995 set_gdb_data_directory (staged_gdb_datadir);
1996 observer_notify_gdb_datadir_changed ();
1999 /* "show" command for the gdb_datadir configuration variable. */
2002 show_gdb_datadir (struct ui_file *file, int from_tty,
2003 struct cmd_list_element *c, const char *value)
2005 fprintf_filtered (file, _("GDB's data directory is \"%s\".\n"),
2010 set_history_filename (char *args, int from_tty, struct cmd_list_element *c)
2012 /* We include the current directory so that if the user changes
2013 directories the file written will be the same as the one
2015 if (!IS_ABSOLUTE_PATH (history_filename))
2016 history_filename = reconcat (history_filename, current_directory, "/",
2017 history_filename, (char *) NULL);
2023 struct cmd_list_element *c;
2025 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2026 the DEFAULT_PROMPT is. */
2027 set_prompt (DEFAULT_PROMPT);
2029 /* Set the important stuff up for command editing. */
2030 command_editing_p = 1;
2031 history_expansion_p = 0;
2032 write_history_p = 0;
2034 /* Setup important stuff for command line editing. */
2035 rl_completion_word_break_hook = gdb_completion_word_break_characters;
2036 rl_completion_entry_function = readline_line_completion_function;
2037 rl_completer_word_break_characters = default_word_break_characters ();
2038 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
2039 rl_completion_display_matches_hook = cli_display_match_list;
2040 rl_readline_name = "gdb";
2041 rl_terminal_name = getenv ("TERM");
2043 /* The name for this defun comes from Bash, where it originated.
2044 15 is Control-o, the same binding this function has in Bash. */
2045 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
2047 add_setshow_string_cmd ("prompt", class_support,
2049 _("Set gdb's prompt"),
2050 _("Show gdb's prompt"),
2053 &setlist, &showlist);
2055 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
2056 Don't repeat this command.\nPrimarily \
2057 used inside of user-defined commands that should not be repeated when\n\
2060 add_setshow_boolean_cmd ("editing", class_support,
2061 &set_editing_cmd_var, _("\
2062 Set editing of command lines as they are typed."), _("\
2063 Show editing of command lines as they are typed."), _("\
2064 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2065 Without an argument, command line editing is enabled. To edit, use\n\
2066 EMACS-like or VI-like commands like control-P or ESC."),
2069 &setlist, &showlist);
2071 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
2072 Set saving of the history record on exit."), _("\
2073 Show saving of the history record on exit."), _("\
2074 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2075 Without an argument, saving is enabled."),
2077 show_write_history_p,
2078 &sethistlist, &showhistlist);
2080 add_setshow_zuinteger_unlimited_cmd ("size", no_class,
2081 &history_size_setshow_var, _("\
2082 Set the size of the command history,"), _("\
2083 Show the size of the command history,"), _("\
2084 ie. the number of previous commands to keep a record of.\n\
2085 If set to \"unlimited\", the number of commands kept in the history\n\
2086 list is unlimited. This defaults to the value of the environment\n\
2087 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2088 set_history_size_command,
2090 &sethistlist, &showhistlist);
2092 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
2093 &history_remove_duplicates, _("\
2094 Set how far back in history to look for and remove duplicate entries."), _("\
2095 Show how far back in history to look for and remove duplicate entries."), _("\
2096 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2097 and remove the first history entry that is a duplicate of the most recent\n\
2098 entry, each time a new history entry is added.\n\
2099 If set to \"unlimited\", this lookbehind is unbounded.\n\
2100 Only history entries added during this session are considered for removal.\n\
2101 If set to 0, removal of duplicate history entries is disabled.\n\
2102 By default this option is set to 0."),
2104 show_history_remove_duplicates,
2105 &sethistlist, &showhistlist);
2107 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
2108 Set the filename in which to record the command history"), _("\
2109 Show the filename in which to record the command history"), _("\
2110 (the list of previous commands of which a record is kept)."),
2111 set_history_filename,
2112 show_history_filename,
2113 &sethistlist, &showhistlist);
2115 add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
2116 Set whether to confirm potentially dangerous operations."), _("\
2117 Show whether to confirm potentially dangerous operations."), NULL,
2120 &setlist, &showlist);
2122 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
2123 Set annotation_level."), _("\
2124 Show annotation_level."), _("\
2125 0 == normal; 1 == fullname (for use when running under emacs)\n\
2126 2 == output annotated suitably for use by programs that control GDB."),
2128 show_annotation_level,
2129 &setlist, &showlist);
2131 add_setshow_boolean_cmd ("exec-done-display", class_support,
2132 &exec_done_display_p, _("\
2133 Set notification of completion for asynchronous execution commands."), _("\
2134 Show notification of completion for asynchronous execution commands."), _("\
2135 Use \"on\" to enable the notification, and \"off\" to disable it."),
2137 show_exec_done_display_p,
2138 &setlist, &showlist);
2140 add_setshow_filename_cmd ("data-directory", class_maintenance,
2141 &staged_gdb_datadir, _("Set GDB's data directory."),
2142 _("Show GDB's data directory."),
2144 When set, GDB uses the specified path to search for data files."),
2145 set_gdb_datadir, show_gdb_datadir,
2149 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
2150 &interactive_mode, _("\
2151 Set whether GDB's standard input is a terminal."), _("\
2152 Show whether GDB's standard input is a terminal."), _("\
2153 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2154 means that GDB should wait for the user to answer queries associated to\n\
2155 commands entered at the command prompt. If off, GDB assumes that standard\n\
2156 input is not a terminal, and uses the default answer to all queries.\n\
2157 If auto (the default), determine which mode to use based on the standard\n\
2160 show_interactive_mode,
2161 &setlist, &showlist);
2163 c = add_cmd ("new-ui", class_support, new_ui_command, _("\
2164 Create a new UI. It takes two arguments:\n\
2165 The first argument is the name of the interpreter to run.\n\
2166 The second argument is the terminal the UI runs on.\n"), &cmdlist);
2167 set_cmd_completer (c, interpreter_completer);
2171 gdb_init (char *argv0)
2173 if (pre_init_ui_hook)
2174 pre_init_ui_hook ();
2176 /* Run the init function of each source file. */
2179 /* Make sure we return to the original directory upon exit, come
2180 what may, since the OS doesn't do that for us. */
2181 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
2184 init_cmd_lists (); /* This needs to be done first. */
2185 initialize_targets (); /* Setup target_terminal macros for utils.c. */
2186 initialize_utils (); /* Make errors and warnings possible. */
2190 /* Here is where we call all the _initialize_foo routines. */
2191 initialize_all_files ();
2193 /* This creates the current_program_space. Do this after all the
2194 _initialize_foo routines have had a chance to install their
2195 per-sspace data keys. Also do this before
2196 initialize_current_architecture is called, because it accesses
2197 exec_bfd of the current program space. */
2198 initialize_progspace ();
2199 initialize_inferiors ();
2200 initialize_current_architecture ();
2202 init_main (); /* But that omits this file! Do it now. */
2204 initialize_stdin_serial ();
2206 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2208 set_initial_gdb_ttystate ();
2210 async_init_signals ();
2212 /* We need a default language for parsing expressions, so simple
2213 things like "set width 0" won't fail if no language is explicitly
2214 set in a config file or implicitly set by reading an executable
2216 set_language (language_c);
2217 expected_language = current_language; /* Don't warn about the change. */
2219 /* Python initialization, for example, can require various commands to be
2220 installed. For example "info pretty-printer" needs the "info"
2221 prefix to be installed. Keep things simple and just do final
2222 script initialization here. */
2223 finish_ext_lang_initialization ();