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. */
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 current_uiout->redirect (str_file);
710 make_cleanup_ui_out_redirect_pop (current_uiout);
712 scoped_restore save_stdout
713 = make_scoped_restore (&gdb_stdout, str_file);
714 scoped_restore save_stderr
715 = make_scoped_restore (&gdb_stderr, str_file);
716 scoped_restore save_stdlog
717 = make_scoped_restore (&gdb_stdlog, str_file);
718 scoped_restore save_stdtarg
719 = make_scoped_restore (&gdb_stdtarg, str_file);
720 scoped_restore save_stdtargerr
721 = make_scoped_restore (&gdb_stdtargerr, str_file);
723 execute_command (p, from_tty);
725 std::string retval = ui_file_as_string (str_file);
727 do_cleanups (cleanup);
733 /* When nonzero, cause dont_repeat to do nothing. This should only be
734 set via prevent_dont_repeat. */
736 static int suppress_dont_repeat = 0;
738 /* Commands call this if they do not want to be repeated by null lines. */
743 struct ui *ui = current_ui;
745 if (suppress_dont_repeat || server_command)
748 /* If we aren't reading from standard input, we are saving the last
749 thing read from stdin in line and don't want to delete it. Null
750 lines won't repeat here in any case. */
751 if (ui->instream == ui->stdin_stream)
752 *saved_command_line = 0;
755 /* Prevent dont_repeat from working, and return a cleanup that
756 restores the previous state. */
758 scoped_restore_tmpl<int>
759 prevent_dont_repeat (void)
761 return make_scoped_restore (&suppress_dont_repeat, 1);
765 /* Read a line from the stream "instream" without command line editing.
767 It prints PROMPT once at the start.
768 Action is compatible with "readline", e.g. space for the result is
769 malloc'd and should be freed by the caller.
771 A NULL return means end of file. */
774 gdb_readline_no_editing (const char *prompt)
776 struct buffer line_buffer;
777 struct ui *ui = current_ui;
778 /* Read from stdin if we are executing a user defined command. This
779 is the right thing for prompt_for_continue, at least. */
780 FILE *stream = ui->instream != NULL ? ui->instream : stdin;
781 int fd = fileno (stream);
783 buffer_init (&line_buffer);
787 /* Don't use a _filtered function here. It causes the assumed
788 character position to be off, since the newline we read from
789 the user is not accounted for. */
790 fputs_unfiltered (prompt, gdb_stdout);
791 gdb_flush (gdb_stdout);
802 /* Wait until at least one byte of data is available. Control-C
803 can interrupt interruptible_select, but not fgetc. */
805 FD_SET (fd, &readfds);
806 if (interruptible_select (fd + 1, &readfds, NULL, NULL, NULL) == -1)
810 /* If this was ctrl-c, the QUIT above handles it. */
813 perror_with_name (("select"));
820 if (line_buffer.used_size > 0)
821 /* The last line does not end with a newline. Return it, and
822 if we are called again fgetc will still return EOF and
823 we'll return NULL then. */
825 xfree (buffer_finish (&line_buffer));
831 if (line_buffer.used_size > 0
832 && line_buffer.buffer[line_buffer.used_size - 1] == '\r')
833 line_buffer.used_size--;
837 buffer_grow_char (&line_buffer, c);
840 buffer_grow_char (&line_buffer, '\0');
841 return buffer_finish (&line_buffer);
844 /* Variables which control command line editing and history
845 substitution. These variables are given default values at the end
847 static int command_editing_p;
849 /* NOTE 1999-04-29: This variable will be static again, once we modify
850 gdb to use the event loop as the default command loop and we merge
851 event-top.c into this file, top.c. */
853 /* static */ int history_expansion_p;
855 static int write_history_p;
857 show_write_history_p (struct ui_file *file, int from_tty,
858 struct cmd_list_element *c, const char *value)
860 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
864 /* The variable associated with the "set/show history size"
865 command. The value -1 means unlimited, and -2 means undefined. */
866 static int history_size_setshow_var = -2;
869 show_history_size (struct ui_file *file, int from_tty,
870 struct cmd_list_element *c, const char *value)
872 fprintf_filtered (file, _("The size of the command history is %s.\n"),
876 /* Variable associated with the "history remove-duplicates" option.
877 The value -1 means unlimited. */
878 static int history_remove_duplicates = 0;
881 show_history_remove_duplicates (struct ui_file *file, int from_tty,
882 struct cmd_list_element *c, const char *value)
884 fprintf_filtered (file,
885 _("The number of history entries to look back at for "
886 "duplicates is %s.\n"),
890 static char *history_filename;
892 show_history_filename (struct ui_file *file, int from_tty,
893 struct cmd_list_element *c, const char *value)
895 fprintf_filtered (file, _("The filename in which to record "
896 "the command history is \"%s\".\n"),
900 /* This is like readline(), but it has some gdb-specific behavior.
901 gdb may want readline in both the synchronous and async modes during
902 a single gdb invocation. At the ordinary top-level prompt we might
903 be using the async readline. That means we can't use
904 rl_pre_input_hook, since it doesn't work properly in async mode.
905 However, for a secondary prompt (" >", such as occurs during a
906 `define'), gdb wants a synchronous response.
908 We used to call readline() directly, running it in synchronous
909 mode. But mixing modes this way is not supported, and as of
910 readline 5.x it no longer works; the arrow keys come unbound during
911 the synchronous call. So we make a nested call into the event
912 loop. That's what gdb_readline_wrapper is for. */
914 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
915 rely on gdb_readline_wrapper_result, which might still be NULL if
916 the user types Control-D for EOF. */
917 static int gdb_readline_wrapper_done;
919 /* The result of the current call to gdb_readline_wrapper, once a newline
921 static char *gdb_readline_wrapper_result;
923 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
924 to be called after the newline is processed (which will redisplay
925 the prompt). But in gdb_readline_wrapper we will not get a new
926 prompt until the next call, or until we return to the event loop.
927 So we disable this hook around the newline and restore it before we
929 static void (*saved_after_char_processing_hook) (void);
935 gdb_in_secondary_prompt_p (struct ui *ui)
937 return ui->secondary_prompt_depth > 0;
941 /* This function is called when readline has seen a complete line of
945 gdb_readline_wrapper_line (char *line)
947 gdb_assert (!gdb_readline_wrapper_done);
948 gdb_readline_wrapper_result = line;
949 gdb_readline_wrapper_done = 1;
951 /* Prevent operate-and-get-next from acting too early. */
952 saved_after_char_processing_hook = after_char_processing_hook;
953 after_char_processing_hook = NULL;
955 /* Prevent parts of the prompt from being redisplayed if annotations
956 are enabled, and readline's state getting out of sync. We'll
957 reinstall the callback handler, which puts the terminal in raw
958 mode (or in readline lingo, in prepped state), when we're next
959 ready to process user input, either in display_gdb_prompt, or if
960 we're handling an asynchronous target event and running in the
961 background, just before returning to the event loop to process
962 further input (or more target events). */
963 if (current_ui->command_editing)
964 gdb_rl_callback_handler_remove ();
967 struct gdb_readline_wrapper_cleanup
969 void (*handler_orig) (char *);
970 int already_prompted_orig;
972 /* Whether the target was async. */
973 int target_is_async_orig;
977 gdb_readline_wrapper_cleanup (void *arg)
979 struct ui *ui = current_ui;
980 struct gdb_readline_wrapper_cleanup *cleanup
981 = (struct gdb_readline_wrapper_cleanup *) arg;
983 if (ui->command_editing)
984 rl_already_prompted = cleanup->already_prompted_orig;
986 gdb_assert (ui->input_handler == gdb_readline_wrapper_line);
987 ui->input_handler = cleanup->handler_orig;
989 /* Don't restore our input handler in readline yet. That would make
990 readline prep the terminal (putting it in raw mode), while the
991 line we just read may trigger execution of a command that expects
992 the terminal in the default cooked/canonical mode, such as e.g.,
993 running Python's interactive online help utility. See
994 gdb_readline_wrapper_line for when we'll reinstall it. */
996 gdb_readline_wrapper_result = NULL;
997 gdb_readline_wrapper_done = 0;
998 ui->secondary_prompt_depth--;
999 gdb_assert (ui->secondary_prompt_depth >= 0);
1001 after_char_processing_hook = saved_after_char_processing_hook;
1002 saved_after_char_processing_hook = NULL;
1004 if (cleanup->target_is_async_orig)
1011 gdb_readline_wrapper (const char *prompt)
1013 struct ui *ui = current_ui;
1014 struct cleanup *back_to;
1015 struct gdb_readline_wrapper_cleanup *cleanup;
1018 cleanup = XNEW (struct gdb_readline_wrapper_cleanup);
1019 cleanup->handler_orig = ui->input_handler;
1020 ui->input_handler = gdb_readline_wrapper_line;
1022 if (ui->command_editing)
1023 cleanup->already_prompted_orig = rl_already_prompted;
1025 cleanup->already_prompted_orig = 0;
1027 cleanup->target_is_async_orig = target_is_async_p ();
1029 ui->secondary_prompt_depth++;
1030 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
1032 /* Processing events may change the current UI. */
1033 scoped_restore save_ui = make_scoped_restore (¤t_ui);
1035 if (cleanup->target_is_async_orig)
1038 /* Display our prompt and prevent double prompt display. */
1039 display_gdb_prompt (prompt);
1040 if (ui->command_editing)
1041 rl_already_prompted = 1;
1043 if (after_char_processing_hook)
1044 (*after_char_processing_hook) ();
1045 gdb_assert (after_char_processing_hook == NULL);
1047 while (gdb_do_one_event () >= 0)
1048 if (gdb_readline_wrapper_done)
1051 retval = gdb_readline_wrapper_result;
1052 do_cleanups (back_to);
1057 /* The current saved history number from operate-and-get-next.
1058 This is -1 if not valid. */
1059 static int operate_saved_history = -1;
1061 /* This is put on the appropriate hook and helps operate-and-get-next
1064 gdb_rl_operate_and_get_next_completion (void)
1066 int delta = where_history () - operate_saved_history;
1068 /* The `key' argument to rl_get_previous_history is ignored. */
1069 rl_get_previous_history (delta, 0);
1070 operate_saved_history = -1;
1072 /* readline doesn't automatically update the display for us. */
1075 after_char_processing_hook = NULL;
1076 rl_pre_input_hook = NULL;
1079 /* This is a gdb-local readline command handler. It accepts the
1080 current command line (like RET does) and, if this command was taken
1081 from the history, arranges for the next command in the history to
1082 appear on the command line when the prompt returns.
1083 We ignore the arguments. */
1085 gdb_rl_operate_and_get_next (int count, int key)
1089 /* Use the async hook. */
1090 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
1092 /* Find the current line, and find the next line to use. */
1093 where = where_history();
1095 if ((history_is_stifled () && (history_length >= history_max_entries))
1096 || (where >= history_length - 1))
1097 operate_saved_history = where;
1099 operate_saved_history = where + 1;
1101 return rl_newline (1, key);
1104 /* Number of user commands executed during this session. */
1106 static int command_count = 0;
1108 /* Add the user command COMMAND to the input history list. */
1111 gdb_add_history (const char *command)
1115 if (history_remove_duplicates != 0)
1118 int lookbehind_threshold;
1120 /* The lookbehind threshold for finding a duplicate history entry is
1121 bounded by command_count because we can't meaningfully delete
1122 history entries that are already stored in the history file since
1123 the history file is appended to. */
1124 if (history_remove_duplicates == -1
1125 || history_remove_duplicates > command_count)
1126 lookbehind_threshold = command_count;
1128 lookbehind_threshold = history_remove_duplicates;
1131 for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
1133 HIST_ENTRY *temp = previous_history ();
1138 if (strcmp (temp->line, command) == 0)
1140 HIST_ENTRY *prev = remove_history (where_history ());
1142 free_history_entry (prev);
1149 add_history (command);
1152 /* Safely append new history entries to the history file in a corruption-free
1153 way using an intermediate local history file. */
1156 gdb_safe_append_history (void)
1158 int ret, saved_errno;
1159 char *local_history_filename;
1160 struct cleanup *old_chain;
1162 local_history_filename
1163 = xstrprintf ("%s-gdb%ld~", history_filename, (long) getpid ());
1164 old_chain = make_cleanup (xfree, local_history_filename);
1166 ret = rename (history_filename, local_history_filename);
1167 saved_errno = errno;
1168 if (ret < 0 && saved_errno != ENOENT)
1170 warning (_("Could not rename %s to %s: %s"),
1171 history_filename, local_history_filename,
1172 safe_strerror (saved_errno));
1178 /* If the rename failed with ENOENT then either the global history
1179 file never existed in the first place or another GDB process is
1180 currently appending to it (and has thus temporarily renamed it).
1181 Since we can't distinguish between these two cases, we have to
1182 conservatively assume the first case and therefore must write out
1183 (not append) our known history to our local history file and try
1184 to move it back anyway. Otherwise a global history file would
1185 never get created! */
1186 gdb_assert (saved_errno == ENOENT);
1187 write_history (local_history_filename);
1191 append_history (command_count, local_history_filename);
1192 if (history_is_stifled ())
1193 history_truncate_file (local_history_filename, history_max_entries);
1196 ret = rename (local_history_filename, history_filename);
1197 saved_errno = errno;
1198 if (ret < 0 && saved_errno != EEXIST)
1199 warning (_("Could not rename %s to %s: %s"),
1200 local_history_filename, history_filename,
1201 safe_strerror (saved_errno));
1204 do_cleanups (old_chain);
1207 /* Read one line from the command input stream `instream' into a local
1208 static buffer. The buffer is made bigger as necessary. Returns
1209 the address of the start of the line.
1211 NULL is returned for end of file.
1213 *If* input is from an interactive stream (stdin), the line read is
1214 copied into the global 'saved_command_line' so that it can be
1217 This routine either uses fancy command line editing or simple input
1218 as the user has requested. */
1221 command_line_input (const char *prompt_arg, int repeat, char *annotation_suffix)
1223 static struct buffer cmd_line_buffer;
1224 static int cmd_line_buffer_initialized;
1225 struct ui *ui = current_ui;
1226 const char *prompt = prompt_arg;
1228 int from_tty = ui->instream == ui->stdin_stream;
1230 /* The annotation suffix must be non-NULL. */
1231 if (annotation_suffix == NULL)
1232 annotation_suffix = "";
1234 if (from_tty && annotation_level > 1)
1239 = (char *) alloca ((prompt == NULL ? 0 : strlen (prompt))
1240 + strlen (annotation_suffix) + 40);
1242 local_prompt[0] = '\0';
1244 strcpy (local_prompt, prompt);
1245 strcat (local_prompt, "\n\032\032");
1246 strcat (local_prompt, annotation_suffix);
1247 strcat (local_prompt, "\n");
1249 prompt = local_prompt;
1252 if (!cmd_line_buffer_initialized)
1254 buffer_init (&cmd_line_buffer);
1255 cmd_line_buffer_initialized = 1;
1258 /* Starting a new command line. */
1259 cmd_line_buffer.used_size = 0;
1263 signal (STOP_SIGNAL, handle_stop_sig);
1270 /* Make sure that all output has been output. Some machines may
1271 let you get away with leaving out some of the gdb_flush, but
1274 gdb_flush (gdb_stdout);
1275 gdb_flush (gdb_stderr);
1277 if (source_file_name != NULL)
1278 ++source_line_number;
1280 if (from_tty && annotation_level > 1)
1282 puts_unfiltered ("\n\032\032pre-");
1283 puts_unfiltered (annotation_suffix);
1284 puts_unfiltered ("\n");
1287 /* Don't use fancy stuff if not talking to stdin. */
1288 if (deprecated_readline_hook
1290 && input_interactive_p (current_ui))
1292 rl = (*deprecated_readline_hook) (prompt);
1294 else if (command_editing_p
1296 && input_interactive_p (current_ui))
1298 rl = gdb_readline_wrapper (prompt);
1302 rl = gdb_readline_no_editing (prompt);
1305 cmd = handle_line_of_input (&cmd_line_buffer, rl,
1306 repeat, annotation_suffix);
1307 if (cmd == (char *) EOF)
1320 signal (STOP_SIGNAL, SIG_DFL);
1326 /* Print the GDB banner. */
1328 print_gdb_version (struct ui_file *stream)
1330 /* From GNU coding standards, first line is meant to be easy for a
1331 program to parse, and is just canonical program name and version
1332 number, which starts after last space. */
1334 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1336 /* Second line is a copyright notice. */
1338 fprintf_filtered (stream,
1339 "Copyright (C) 2017 Free Software Foundation, Inc.\n");
1341 /* Following the copyright is a brief statement that the program is
1342 free software, that users are free to copy and change it on
1343 certain conditions, that it is covered by the GNU GPL, and that
1344 there is no warranty. */
1346 fprintf_filtered (stream, "\
1347 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1348 \nThis is free software: you are free to change and redistribute it.\n\
1349 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1350 and \"show warranty\" for details.\n");
1352 /* After the required info we print the configuration information. */
1354 fprintf_filtered (stream, "This GDB was configured as \"");
1355 if (strcmp (host_name, target_name) != 0)
1357 fprintf_filtered (stream, "--host=%s --target=%s",
1358 host_name, target_name);
1362 fprintf_filtered (stream, "%s", host_name);
1364 fprintf_filtered (stream, "\".\n\
1365 Type \"show configuration\" for configuration details.");
1367 if (REPORT_BUGS_TO[0])
1369 fprintf_filtered (stream,
1370 _("\nFor bug reporting instructions, please see:\n"));
1371 fprintf_filtered (stream, "%s.\n", REPORT_BUGS_TO);
1373 fprintf_filtered (stream,
1374 _("Find the GDB manual and other documentation \
1375 resources online at:\n<http://www.gnu.org/software/gdb/documentation/>.\n"));
1376 fprintf_filtered (stream, _("For help, type \"help\".\n"));
1377 fprintf_filtered (stream, _("Type \"apropos word\" to search for \
1378 commands related to \"word\"."));
1381 /* Print the details of GDB build-time configuration. */
1383 print_gdb_configuration (struct ui_file *stream)
1385 fprintf_filtered (stream, _("\
1386 This GDB was configured as follows:\n\
1387 configure --host=%s --target=%s\n\
1388 "), host_name, target_name);
1389 fprintf_filtered (stream, _("\
1390 --with-auto-load-dir=%s\n\
1391 --with-auto-load-safe-path=%s\n\
1392 "), AUTO_LOAD_DIR, AUTO_LOAD_SAFE_PATH);
1394 fprintf_filtered (stream, _("\
1398 fprintf_filtered (stream, _("\
1403 fprintf_filtered (stream, _("\
1404 --with-gdb-datadir=%s%s\n\
1405 "), GDB_DATADIR, GDB_DATADIR_RELOCATABLE ? " (relocatable)" : "");
1407 fprintf_filtered (stream, _("\
1408 --with-iconv-bin=%s%s\n\
1409 "), ICONV_BIN, ICONV_BIN_RELOCATABLE ? " (relocatable)" : "");
1411 if (JIT_READER_DIR[0])
1412 fprintf_filtered (stream, _("\
1413 --with-jit-reader-dir=%s%s\n\
1414 "), JIT_READER_DIR, JIT_READER_DIR_RELOCATABLE ? " (relocatable)" : "");
1415 #if HAVE_LIBUNWIND_IA64_H
1416 fprintf_filtered (stream, _("\
1417 --with-libunwind-ia64\n\
1420 fprintf_filtered (stream, _("\
1421 --without-libunwind-ia64\n\
1425 fprintf_filtered (stream, _("\
1429 fprintf_filtered (stream, _("\
1433 #ifdef WITH_PYTHON_PATH
1434 fprintf_filtered (stream, _("\
1435 --with-python=%s%s\n\
1436 "), WITH_PYTHON_PATH, PYTHON_PATH_RELOCATABLE ? " (relocatable)" : "");
1439 fprintf_filtered (stream, _("\
1443 fprintf_filtered (stream, _("\
1448 fprintf_filtered (stream, _("\
1449 --with-relocated-sources=%s\n\
1453 fprintf_filtered (stream, _("\
1454 --with-separate-debug-dir=%s%s\n\
1455 "), DEBUGDIR, DEBUGDIR_RELOCATABLE ? " (relocatable)" : "");
1456 if (TARGET_SYSTEM_ROOT[0])
1457 fprintf_filtered (stream, _("\
1458 --with-sysroot=%s%s\n\
1459 "), TARGET_SYSTEM_ROOT, TARGET_SYSTEM_ROOT_RELOCATABLE ? " (relocatable)" : "");
1460 if (SYSTEM_GDBINIT[0])
1461 fprintf_filtered (stream, _("\
1462 --with-system-gdbinit=%s%s\n\
1463 "), SYSTEM_GDBINIT, SYSTEM_GDBINIT_RELOCATABLE ? " (relocatable)" : "");
1464 #if HAVE_LIBBABELTRACE
1465 fprintf_filtered (stream, _("\
1466 --with-babeltrace\n\
1469 fprintf_filtered (stream, _("\
1470 --without-babeltrace\n\
1473 /* We assume "relocatable" will be printed at least once, thus we always
1474 print this text. It's a reasonably safe assumption for now. */
1475 fprintf_filtered (stream, _("\n\
1476 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1477 tree, and GDB will still find it.)\n\
1482 /* The current top level prompt, settable with "set prompt", and/or
1483 with the python `gdb.prompt_hook' hook. */
1484 static char *top_prompt;
1486 /* Access method for the GDB prompt string. */
1494 /* Set method for the GDB prompt string. */
1497 set_prompt (const char *s)
1499 char *p = xstrdup (s);
1512 /* Callback for iterate_over_inferiors. Kills or detaches the given
1513 inferior, depending on how we originally gained control of it. */
1516 kill_or_detach (struct inferior *inf, void *args)
1518 struct qt_args *qt = (struct qt_args *) args;
1519 struct thread_info *thread;
1524 thread = any_thread_of_process (inf->pid);
1527 switch_to_thread (thread->ptid);
1529 /* Leave core files alone. */
1530 if (target_has_execution)
1532 if (inf->attach_flag)
1533 target_detach (qt->args, qt->from_tty);
1542 /* Callback for iterate_over_inferiors. Prints info about what GDB
1543 will do to each inferior on a "quit". ARG points to a struct
1544 ui_out where output is to be collected. */
1547 print_inferior_quit_action (struct inferior *inf, void *arg)
1549 struct ui_file *stb = (struct ui_file *) arg;
1554 if (inf->attach_flag)
1555 fprintf_filtered (stb,
1556 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1557 target_pid_to_str (pid_to_ptid (inf->pid)));
1559 fprintf_filtered (stb,
1560 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1561 target_pid_to_str (pid_to_ptid (inf->pid)));
1566 /* If necessary, make the user confirm that we should quit. Return
1567 non-zero if we should quit, zero if we shouldn't. */
1572 struct ui_file *stb;
1573 struct cleanup *old_chain;
1575 /* Don't even ask if we're only debugging a core file inferior. */
1576 if (!have_live_inferiors ())
1579 /* Build the query string as a single string. */
1580 stb = mem_fileopen ();
1581 old_chain = make_cleanup_ui_file_delete (stb);
1583 fprintf_filtered (stb, _("A debugging session is active.\n\n"));
1584 iterate_over_inferiors (print_inferior_quit_action, stb);
1585 fprintf_filtered (stb, _("\nQuit anyway? "));
1587 std::string str = ui_file_as_string (stb);
1589 do_cleanups (old_chain);
1591 return query ("%s", str.c_str ());
1594 /* Prepare to exit GDB cleanly by undoing any changes made to the
1595 terminal so that we leave the terminal in the state we acquired it. */
1598 undo_terminal_modifications_before_exit (void)
1600 struct ui *saved_top_level = current_ui;
1602 target_terminal_ours ();
1604 current_ui = main_ui;
1609 gdb_disable_readline ();
1611 current_ui = saved_top_level;
1615 /* Quit without asking for confirmation. */
1618 quit_force (int *exit_arg, int from_tty)
1623 undo_terminal_modifications_before_exit ();
1625 /* An optional expression may be used to cause gdb to terminate with the
1626 value of that expression. */
1628 exit_code = *exit_arg;
1629 else if (return_child_result)
1630 exit_code = return_child_result_value;
1633 qt.from_tty = from_tty;
1635 /* We want to handle any quit errors and exit regardless. */
1637 /* Get out of tfind mode, and kill or detach all inferiors. */
1640 disconnect_tracing ();
1641 iterate_over_inferiors (kill_or_detach, &qt);
1643 CATCH (ex, RETURN_MASK_ALL)
1645 exception_print (gdb_stderr, ex);
1649 /* Give all pushed targets a chance to do minimal cleanup, and pop
1655 CATCH (ex, RETURN_MASK_ALL)
1657 exception_print (gdb_stderr, ex);
1661 /* Save the history information if it is appropriate to do so. */
1664 if (write_history_p && history_filename)
1669 /* History is currently shared between all UIs. If there's
1670 any UI with a terminal, save history. */
1673 if (input_interactive_p (ui))
1681 gdb_safe_append_history ();
1684 CATCH (ex, RETURN_MASK_ALL)
1686 exception_print (gdb_stderr, ex);
1690 /* Do any final cleanups before exiting. */
1693 do_final_cleanups (all_cleanups ());
1695 CATCH (ex, RETURN_MASK_ALL)
1697 exception_print (gdb_stderr, ex);
1704 /* The value of the "interactive-mode" setting. */
1705 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
1707 /* Implement the "show interactive-mode" option. */
1710 show_interactive_mode (struct ui_file *file, int from_tty,
1711 struct cmd_list_element *c,
1714 if (interactive_mode == AUTO_BOOLEAN_AUTO)
1715 fprintf_filtered (file, "Debugger's interactive mode "
1716 "is %s (currently %s).\n",
1717 value, input_interactive_p (current_ui) ? "on" : "off");
1719 fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
1722 /* Returns whether GDB is running on an interactive terminal. */
1725 input_interactive_p (struct ui *ui)
1730 if (interactive_mode != AUTO_BOOLEAN_AUTO)
1731 return interactive_mode == AUTO_BOOLEAN_TRUE;
1733 return ui->input_interactive_p;
1737 dont_repeat_command (char *ignored, int from_tty)
1739 /* Can't call dont_repeat here because we're not necessarily reading
1741 *saved_command_line = 0;
1744 /* Functions to manipulate command line editing control variables. */
1746 /* Number of commands to print in each call to show_commands. */
1747 #define Hist_print 10
1749 show_commands (char *args, int from_tty)
1751 /* Index for history commands. Relative to history_base. */
1754 /* Number of the history entry which we are planning to display next.
1755 Relative to history_base. */
1758 /* Print out some of the commands from the command history. */
1762 if (args[0] == '+' && args[1] == '\0')
1763 /* "info editing +" should print from the stored position. */
1766 /* "info editing <exp>" should print around command number <exp>. */
1767 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1769 /* "show commands" means print the last Hist_print commands. */
1772 num = history_length - Hist_print;
1778 /* If there are at least Hist_print commands, we want to display the last
1779 Hist_print rather than, say, the last 6. */
1780 if (history_length - num < Hist_print)
1782 num = history_length - Hist_print;
1788 offset < num + Hist_print && offset < history_length;
1791 printf_filtered ("%5d %s\n", history_base + offset,
1792 (history_get (history_base + offset))->line);
1795 /* The next command we want to display is the next one that we haven't
1799 /* If the user repeats this command with return, it should do what
1800 "show commands +" does. This is unnecessary if arg is null,
1801 because "show commands +" is not useful after "show commands". */
1802 if (from_tty && args)
1809 /* Update the size of our command history file to HISTORY_SIZE.
1811 A HISTORY_SIZE of -1 stands for unlimited. */
1814 set_readline_history_size (int history_size)
1816 gdb_assert (history_size >= -1);
1818 if (history_size == -1)
1819 unstifle_history ();
1821 stifle_history (history_size);
1824 /* Called by do_setshow_command. */
1826 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1828 set_readline_history_size (history_size_setshow_var);
1832 set_history (char *args, int from_tty)
1834 printf_unfiltered (_("\"set history\" must be followed "
1835 "by the name of a history subcommand.\n"));
1836 help_list (sethistlist, "set history ", all_commands, gdb_stdout);
1840 show_history (char *args, int from_tty)
1842 cmd_show_list (showhistlist, from_tty, "");
1845 int info_verbose = 0; /* Default verbose msgs off. */
1847 /* Called by do_setshow_command. An elaborate joke. */
1849 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1851 const char *cmdname = "verbose";
1852 struct cmd_list_element *showcmd;
1854 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1855 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1859 c->doc = "Set verbose printing of informational messages.";
1860 showcmd->doc = "Show verbose printing of informational messages.";
1864 c->doc = "Set verbosity.";
1865 showcmd->doc = "Show verbosity.";
1869 /* Init the history buffer. Note that we are called after the init file(s)
1870 have been read so that the user can change the history file via his
1871 .gdbinit file (for instance). The GDBHISTFILE environment variable
1872 overrides all of this. */
1879 tmpenv = getenv ("GDBHISTSIZE");
1886 tmpenv = skip_spaces (tmpenv);
1888 var = strtol (tmpenv, &endptr, 10);
1889 saved_errno = errno;
1890 endptr = skip_spaces (endptr);
1892 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1893 empty string, a negative number or a huge positive number (larger than
1894 INT_MAX) then set the history size to unlimited. Otherwise set our
1895 history size to the number we have read. This behavior is consistent
1896 with how bash handles HISTSIZE. */
1897 if (*endptr != '\0')
1899 else if (*tmpenv == '\0'
1902 /* On targets where INT_MAX == LONG_MAX, we have to look at
1903 errno after calling strtol to distinguish between a value that
1904 is exactly INT_MAX and an overflowing value that was clamped
1906 || (var == INT_MAX && saved_errno == ERANGE))
1907 history_size_setshow_var = -1;
1909 history_size_setshow_var = var;
1912 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1914 if (history_size_setshow_var == -2)
1915 history_size_setshow_var = 256;
1917 set_readline_history_size (history_size_setshow_var);
1919 tmpenv = getenv ("GDBHISTFILE");
1921 history_filename = xstrdup (tmpenv);
1922 else if (!history_filename)
1924 /* We include the current directory so that if the user changes
1925 directories the file written will be the same as the one
1928 /* No leading dots in file names are allowed on MSDOS. */
1929 history_filename = concat (current_directory, "/_gdb_history",
1932 history_filename = concat (current_directory, "/.gdb_history",
1936 read_history (history_filename);
1940 show_prompt (struct ui_file *file, int from_tty,
1941 struct cmd_list_element *c, const char *value)
1943 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1946 /* "set editing" command. */
1949 set_editing (char *args, int from_tty, struct cmd_list_element *c)
1951 change_line_handler (set_editing_cmd_var);
1952 /* Update the control variable so that MI's =cmd-param-changed event
1953 shows the correct value. */
1954 set_editing_cmd_var = current_ui->command_editing;
1958 show_editing (struct ui_file *file, int from_tty,
1959 struct cmd_list_element *c, const char *value)
1961 fprintf_filtered (file, _("Editing of command lines as "
1962 "they are typed is %s.\n"),
1963 current_ui->command_editing ? _("on") : _("off"));
1967 show_annotation_level (struct ui_file *file, int from_tty,
1968 struct cmd_list_element *c, const char *value)
1970 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1974 show_exec_done_display_p (struct ui_file *file, int from_tty,
1975 struct cmd_list_element *c, const char *value)
1977 fprintf_filtered (file, _("Notification of completion for "
1978 "asynchronous execution commands is %s.\n"),
1982 /* New values of the "data-directory" parameter are staged here. */
1983 static char *staged_gdb_datadir;
1985 /* "set" command for the gdb_datadir configuration variable. */
1988 set_gdb_datadir (char *args, int from_tty, struct cmd_list_element *c)
1990 set_gdb_data_directory (staged_gdb_datadir);
1991 observer_notify_gdb_datadir_changed ();
1994 /* "show" command for the gdb_datadir configuration variable. */
1997 show_gdb_datadir (struct ui_file *file, int from_tty,
1998 struct cmd_list_element *c, const char *value)
2000 fprintf_filtered (file, _("GDB's data directory is \"%s\".\n"),
2005 set_history_filename (char *args, int from_tty, struct cmd_list_element *c)
2007 /* We include the current directory so that if the user changes
2008 directories the file written will be the same as the one
2010 if (!IS_ABSOLUTE_PATH (history_filename))
2011 history_filename = reconcat (history_filename, current_directory, "/",
2012 history_filename, (char *) NULL);
2018 struct cmd_list_element *c;
2020 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2021 the DEFAULT_PROMPT is. */
2022 set_prompt (DEFAULT_PROMPT);
2024 /* Set the important stuff up for command editing. */
2025 command_editing_p = 1;
2026 history_expansion_p = 0;
2027 write_history_p = 0;
2029 /* Setup important stuff for command line editing. */
2030 rl_completion_word_break_hook = gdb_completion_word_break_characters;
2031 rl_completion_entry_function = readline_line_completion_function;
2032 rl_completer_word_break_characters = default_word_break_characters ();
2033 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
2034 rl_completion_display_matches_hook = cli_display_match_list;
2035 rl_readline_name = "gdb";
2036 rl_terminal_name = getenv ("TERM");
2038 /* The name for this defun comes from Bash, where it originated.
2039 15 is Control-o, the same binding this function has in Bash. */
2040 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
2042 add_setshow_string_cmd ("prompt", class_support,
2044 _("Set gdb's prompt"),
2045 _("Show gdb's prompt"),
2048 &setlist, &showlist);
2050 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
2051 Don't repeat this command.\nPrimarily \
2052 used inside of user-defined commands that should not be repeated when\n\
2055 add_setshow_boolean_cmd ("editing", class_support,
2056 &set_editing_cmd_var, _("\
2057 Set editing of command lines as they are typed."), _("\
2058 Show editing of command lines as they are typed."), _("\
2059 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2060 Without an argument, command line editing is enabled. To edit, use\n\
2061 EMACS-like or VI-like commands like control-P or ESC."),
2064 &setlist, &showlist);
2066 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
2067 Set saving of the history record on exit."), _("\
2068 Show saving of the history record on exit."), _("\
2069 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2070 Without an argument, saving is enabled."),
2072 show_write_history_p,
2073 &sethistlist, &showhistlist);
2075 add_setshow_zuinteger_unlimited_cmd ("size", no_class,
2076 &history_size_setshow_var, _("\
2077 Set the size of the command history,"), _("\
2078 Show the size of the command history,"), _("\
2079 ie. the number of previous commands to keep a record of.\n\
2080 If set to \"unlimited\", the number of commands kept in the history\n\
2081 list is unlimited. This defaults to the value of the environment\n\
2082 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2083 set_history_size_command,
2085 &sethistlist, &showhistlist);
2087 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
2088 &history_remove_duplicates, _("\
2089 Set how far back in history to look for and remove duplicate entries."), _("\
2090 Show how far back in history to look for and remove duplicate entries."), _("\
2091 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2092 and remove the first history entry that is a duplicate of the most recent\n\
2093 entry, each time a new history entry is added.\n\
2094 If set to \"unlimited\", this lookbehind is unbounded.\n\
2095 Only history entries added during this session are considered for removal.\n\
2096 If set to 0, removal of duplicate history entries is disabled.\n\
2097 By default this option is set to 0."),
2099 show_history_remove_duplicates,
2100 &sethistlist, &showhistlist);
2102 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
2103 Set the filename in which to record the command history"), _("\
2104 Show the filename in which to record the command history"), _("\
2105 (the list of previous commands of which a record is kept)."),
2106 set_history_filename,
2107 show_history_filename,
2108 &sethistlist, &showhistlist);
2110 add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
2111 Set whether to confirm potentially dangerous operations."), _("\
2112 Show whether to confirm potentially dangerous operations."), NULL,
2115 &setlist, &showlist);
2117 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
2118 Set annotation_level."), _("\
2119 Show annotation_level."), _("\
2120 0 == normal; 1 == fullname (for use when running under emacs)\n\
2121 2 == output annotated suitably for use by programs that control GDB."),
2123 show_annotation_level,
2124 &setlist, &showlist);
2126 add_setshow_boolean_cmd ("exec-done-display", class_support,
2127 &exec_done_display_p, _("\
2128 Set notification of completion for asynchronous execution commands."), _("\
2129 Show notification of completion for asynchronous execution commands."), _("\
2130 Use \"on\" to enable the notification, and \"off\" to disable it."),
2132 show_exec_done_display_p,
2133 &setlist, &showlist);
2135 add_setshow_filename_cmd ("data-directory", class_maintenance,
2136 &staged_gdb_datadir, _("Set GDB's data directory."),
2137 _("Show GDB's data directory."),
2139 When set, GDB uses the specified path to search for data files."),
2140 set_gdb_datadir, show_gdb_datadir,
2144 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
2145 &interactive_mode, _("\
2146 Set whether GDB's standard input is a terminal."), _("\
2147 Show whether GDB's standard input is a terminal."), _("\
2148 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2149 means that GDB should wait for the user to answer queries associated to\n\
2150 commands entered at the command prompt. If off, GDB assumes that standard\n\
2151 input is not a terminal, and uses the default answer to all queries.\n\
2152 If auto (the default), determine which mode to use based on the standard\n\
2155 show_interactive_mode,
2156 &setlist, &showlist);
2158 c = add_cmd ("new-ui", class_support, new_ui_command, _("\
2159 Create a new UI. It takes two arguments:\n\
2160 The first argument is the name of the interpreter to run.\n\
2161 The second argument is the terminal the UI runs on.\n"), &cmdlist);
2162 set_cmd_completer (c, interpreter_completer);
2166 gdb_init (char *argv0)
2168 if (pre_init_ui_hook)
2169 pre_init_ui_hook ();
2171 /* Run the init function of each source file. */
2174 /* Make sure we return to the original directory upon exit, come
2175 what may, since the OS doesn't do that for us. */
2176 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
2179 init_cmd_lists (); /* This needs to be done first. */
2180 initialize_targets (); /* Setup target_terminal macros for utils.c. */
2181 initialize_utils (); /* Make errors and warnings possible. */
2185 /* Here is where we call all the _initialize_foo routines. */
2186 initialize_all_files ();
2188 /* This creates the current_program_space. Do this after all the
2189 _initialize_foo routines have had a chance to install their
2190 per-sspace data keys. Also do this before
2191 initialize_current_architecture is called, because it accesses
2192 exec_bfd of the current program space. */
2193 initialize_progspace ();
2194 initialize_inferiors ();
2195 initialize_current_architecture ();
2197 init_main (); /* But that omits this file! Do it now. */
2199 initialize_stdin_serial ();
2201 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2203 set_initial_gdb_ttystate ();
2205 async_init_signals ();
2207 /* We need a default language for parsing expressions, so simple
2208 things like "set width 0" won't fail if no language is explicitly
2209 set in a config file or implicitly set by reading an executable
2211 set_language (language_c);
2212 expected_language = current_language; /* Don't warn about the change. */
2214 /* Python initialization, for example, can require various commands to be
2215 installed. For example "info pretty-printer" needs the "info"
2216 prefix to be installed. Keep things simple and just do final
2217 script initialization here. */
2218 finish_ext_lang_initialization ();