1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2017 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "cli/cli-cmds.h"
23 #include "cli/cli-script.h"
24 #include "cli/cli-setshow.h"
25 #include "cli/cli-decode.h"
31 #include "target-dcache.h"
32 #include "breakpoint.h"
34 #include "expression.h"
37 #include "terminal.h" /* For job_control. */
38 #include "job-control.h"
40 #include "completer.h"
46 #include "event-loop.h"
47 #include "gdbthread.h"
48 #include "extension.h"
52 #include "filenames.h"
55 #include "gdb_select.h"
57 /* readline include files. */
58 #include "readline/readline.h"
59 #include "readline/history.h"
61 /* readline defines this. */
64 #include <sys/types.h>
66 #include "event-top.h"
71 #include "tracepoint.h"
82 extern void initialize_all_files (void);
84 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
85 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
86 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
88 /* Default command line prompt. This is overriden in some configs. */
90 #ifndef DEFAULT_PROMPT
91 #define DEFAULT_PROMPT "(gdb) "
94 /* Generate a function that exports a pointer to a field of the
97 #define gen_ret_current_ui_field_ptr(type, name) \
99 current_ui_## name ## _ptr (void) \
101 return ¤t_ui->m_ ## name; \
104 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdout)
105 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdin)
106 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stderr)
107 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdlog)
108 gen_ret_current_ui_field_ptr (struct ui_out *, current_uiout)
110 /* Initialization file name for gdb. This is host-dependent. */
112 const char gdbinit[] = GDBINIT;
114 int inhibit_gdbinit = 0;
116 extern char lang_frame_mismatch_warn[]; /* language.c */
118 /* Flag for whether we want to confirm potentially dangerous
119 operations. Default is yes. */
124 show_confirm (struct ui_file *file, int from_tty,
125 struct cmd_list_element *c, const char *value)
127 fprintf_filtered (file, _("Whether to confirm potentially "
128 "dangerous operations is %s.\n"),
132 /* Current working directory. */
134 char *current_directory;
136 /* The last command line executed on the console. Used for command
138 char *saved_command_line;
140 /* Nonzero if the current command is modified by "server ". This
141 affects things like recording into the command history, commands
142 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
143 whatever) can issue its own commands and also send along commands
144 from the user, and have the user not notice that the user interface
145 is issuing commands too. */
148 /* Timeout limit for response from target. */
150 /* The default value has been changed many times over the years. It
151 was originally 5 seconds. But that was thought to be a long time
152 to sit and wait, so it was changed to 2 seconds. That was thought
153 to be plenty unless the connection was going through some terminal
154 server or multiplexer or other form of hairy serial connection.
156 In mid-1996, remote_timeout was moved from remote.c to top.c and
157 it began being used in other remote-* targets. It appears that the
158 default was changed to 20 seconds at that time, perhaps because the
159 Renesas E7000 ICE didn't always respond in a timely manner.
161 But if 5 seconds is a long time to sit and wait for retransmissions,
162 20 seconds is far worse. This demonstrates the difficulty of using
163 a single variable for all protocol timeouts.
165 As remote.c is used much more than remote-e7000.c, it was changed
166 back to 2 seconds in 1999. */
168 int remote_timeout = 2;
170 /* Non-zero tells remote* modules to output debugging info. */
172 int remote_debug = 0;
174 /* Sbrk location on entry to main. Used for statistics only. */
179 /* Hooks for alternate command interfaces. */
181 /* This hook is called from within gdb's many mini-event loops which
182 could steal control from a real user interface's event loop. It
183 returns non-zero if the user is requesting a detach, zero
186 int (*deprecated_ui_loop_hook) (int);
189 /* Called from print_frame_info to list the line we stopped in. */
191 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
195 /* Replaces most of query. */
197 int (*deprecated_query_hook) (const char *, va_list);
199 /* Replaces most of warning. */
201 void (*deprecated_warning_hook) (const char *, va_list);
203 /* These three functions support getting lines of text from the user.
204 They are used in sequence. First deprecated_readline_begin_hook is
205 called with a text string that might be (for example) a message for
206 the user to type in a sequence of commands to be executed at a
207 breakpoint. If this function calls back to a GUI, it might take
208 this opportunity to pop up a text interaction window with this
209 message. Next, deprecated_readline_hook is called with a prompt
210 that is emitted prior to collecting the user input. It can be
211 called multiple times. Finally, deprecated_readline_end_hook is
212 called to notify the GUI that we are done with the interaction
213 window and it can close it. */
215 void (*deprecated_readline_begin_hook) (const char *, ...);
216 char *(*deprecated_readline_hook) (const char *);
217 void (*deprecated_readline_end_hook) (void);
219 /* Called as appropriate to notify the interface that we have attached
220 to or detached from an already running process. */
222 void (*deprecated_attach_hook) (void);
223 void (*deprecated_detach_hook) (void);
225 /* Called during long calculations to allow GUI to repair window
226 damage, and to check for stop buttons, etc... */
228 void (*deprecated_interactive_hook) (void);
230 /* Called when going to wait for the target. Usually allows the GUI
231 to run while waiting for target events. */
233 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
234 struct target_waitstatus *status,
237 /* Used by UI as a wrapper around command execution. May do various
238 things like enabling/disabling buttons, etc... */
240 void (*deprecated_call_command_hook) (struct cmd_list_element * c,
241 char *cmd, int from_tty);
243 /* Called when the current thread changes. Argument is thread id. */
245 void (*deprecated_context_hook) (int id);
247 /* The highest UI number ever assigned. */
248 static int highest_ui_num;
253 new_ui (FILE *instream, FILE *outstream, FILE *errstream)
257 ui = XCNEW (struct ui);
259 ui->num = ++highest_ui_num;
260 ui->stdin_stream = instream;
261 ui->instream = instream;
262 ui->outstream = outstream;
263 ui->errstream = errstream;
265 ui->input_fd = fileno (ui->instream);
267 ui->input_interactive_p = ISATTY (ui->instream);
269 ui->m_gdb_stdin = new stdio_file (ui->instream);
270 ui->m_gdb_stdout = new stdio_file (ui->outstream);
271 ui->m_gdb_stderr = new stderr_file (ui->errstream);
272 ui->m_gdb_stdlog = ui->m_gdb_stderr;
274 ui->prompt_state = PROMPT_NEEDED;
282 for (last = ui_list; last->next != NULL; last = last->next)
291 free_ui (struct ui *ui)
293 delete ui->m_gdb_stdin;
294 delete ui->m_gdb_stdout;
295 delete ui->m_gdb_stderr;
301 delete_ui (struct ui *todel)
303 struct ui *ui, *uiprev;
307 for (ui = ui_list; ui != NULL; uiprev = ui, ui = ui->next)
311 gdb_assert (ui != NULL);
314 uiprev->next = ui->next;
321 /* Cleanup that deletes a UI. */
324 delete_ui_cleanup (void *void_ui)
326 struct ui *ui = (struct ui *) void_ui;
334 make_delete_ui_cleanup (struct ui *ui)
336 return make_cleanup (delete_ui_cleanup, ui);
339 /* Open file named NAME for read/write, making sure not to make it the
340 controlling terminal. */
343 open_terminal_stream (const char *name)
347 fd = gdb_open_cloexec (name, O_RDWR | O_NOCTTY, 0);
349 perror_with_name (_("opening terminal failed"));
351 return gdb_file_up (fdopen (fd, "w+"));
354 /* Implementation of the "new-ui" command. */
357 new_ui_command (const char *args, int from_tty)
360 struct interp *interp;
361 gdb_file_up stream[3];
365 const char *interpreter_name;
366 const char *tty_name;
367 struct cleanup *failure_chain;
371 gdb_argv argv (args);
372 argc = argv.count ();
375 error (_("usage: new-ui <interpreter> <tty>"));
377 interpreter_name = argv[0];
381 scoped_restore save_ui = make_scoped_restore (¤t_ui);
383 /* Open specified terminal, once for each of
384 stdin/stdout/stderr. */
385 for (i = 0; i < 3; i++)
386 stream[i] = open_terminal_stream (tty_name);
388 ui = new_ui (stream[0].get (), stream[1].get (), stream[2].get ());
389 failure_chain = make_cleanup (delete_ui_cleanup, ui);
395 set_top_level_interpreter (interpreter_name);
397 interp_pre_command_loop (top_level_interpreter ());
399 /* Make sure the files are not closed. */
400 stream[0].release ();
401 stream[1].release ();
402 stream[2].release ();
404 discard_cleanups (failure_chain);
407 printf_unfiltered ("New UI allocated\n");
410 /* Handler for SIGHUP. */
413 /* NOTE 1999-04-29: This function will be static again, once we modify
414 gdb to use the event loop as the default command loop and we merge
415 event-top.c into this file, top.c. */
419 /* Stop asking user for confirmation --- we're exiting. This
420 prevents asking the user dumb questions. */
422 quit_command ((char *) 0, 0);
424 #endif /* defined SIGHUP */
426 /* Line number we are currently in, in a file which is being sourced. */
427 /* NOTE 1999-04-29: This variable will be static again, once we modify
428 gdb to use the event loop as the default command loop and we merge
429 event-top.c into this file, top.c. */
430 /* static */ int source_line_number;
432 /* Name of the file we are sourcing. */
433 /* NOTE 1999-04-29: This variable will be static again, once we modify
434 gdb to use the event loop as the default command loop and we merge
435 event-top.c into this file, top.c. */
436 /* static */ const char *source_file_name;
438 /* Read commands from STREAM. */
440 read_command_file (FILE *stream)
442 struct ui *ui = current_ui;
444 scoped_restore save_instream
445 = make_scoped_restore (&ui->instream, stream);
447 /* Read commands from `instream' and execute them until end of file
448 or error reading instream. */
450 while (ui->instream != NULL && !feof (ui->instream))
454 /* Get a command-line. This calls the readline package. */
455 command = command_line_input (NULL, 0, NULL);
458 command_handler (command);
462 void (*pre_init_ui_hook) (void);
466 do_chdir_cleanup (void *old_dir)
468 chdir ((const char *) old_dir);
474 prepare_execute_command (void)
477 struct cleanup *cleanup;
479 mark = value_mark ();
480 cleanup = make_cleanup_value_free_to_mark (mark);
482 /* With multiple threads running while the one we're examining is
483 stopped, the dcache can get stale without us being able to detect
484 it. For the duration of the command, though, use the dcache to
485 help things like backtrace. */
487 target_dcache_invalidate ();
492 /* Tell the user if the language has changed (except first time) after
493 executing a command. */
496 check_frame_language_change (void)
498 static int warned = 0;
499 struct frame_info *frame;
501 /* First make sure that a new frame has been selected, in case the
502 command or the hooks changed the program state. */
503 frame = deprecated_safe_get_selected_frame ();
504 if (current_language != expected_language)
506 if (language_mode == language_mode_auto && info_verbose)
508 language_info (1); /* Print what changed. */
513 /* Warn the user if the working language does not match the language
514 of the current frame. Only warn the user if we are actually
515 running the program, i.e. there is a stack. */
516 /* FIXME: This should be cacheing the frame and only running when
517 the frame changes. */
519 if (has_stack_frames ())
523 flang = get_frame_language (frame);
525 && flang != language_unknown
526 && flang != current_language->la_language)
528 printf_filtered ("%s\n", lang_frame_mismatch_warn);
537 wait_sync_command_done (void)
539 /* Processing events may change the current UI. */
540 scoped_restore save_ui = make_scoped_restore (¤t_ui);
541 struct ui *ui = current_ui;
543 while (gdb_do_one_event () >= 0)
544 if (ui->prompt_state != PROMPT_BLOCKED)
551 maybe_wait_sync_command_done (int was_sync)
553 /* If the interpreter is in sync mode (we're running a user
554 command's list, running command hooks or similars), and we
555 just ran a synchronous command that started the target, wait
556 for that command to end. */
557 if (!current_ui->async
559 && current_ui->prompt_state == PROMPT_BLOCKED)
560 wait_sync_command_done ();
563 /* Execute the line P as a command, in the current user context.
564 Pass FROM_TTY as second argument to the defining function. */
567 execute_command (char *p, int from_tty)
569 struct cleanup *cleanup_if_error, *cleanup;
570 struct cmd_list_element *c;
573 cleanup_if_error = make_bpstat_clear_actions_cleanup ();
574 cleanup = prepare_execute_command ();
576 /* Force cleanup of any alloca areas if using C alloca instead of
580 /* This can happen when command_line_input hits end of file. */
583 do_cleanups (cleanup);
584 discard_cleanups (cleanup_if_error);
588 target_log_command (p);
590 while (*p == ' ' || *p == '\t')
596 int was_sync = current_ui->prompt_state == PROMPT_BLOCKED;
600 /* If trace-commands is set then this will print this command. */
601 print_command_trace (p);
603 c = lookup_cmd (&cmd, cmdlist, "", 0, 1);
606 /* Pass null arg rather than an empty one. */
609 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
610 while the is_complete_command(cfunc) test is just plain
611 bogus. They should both be replaced by a test of the form
612 c->strip_trailing_white_space_p. */
613 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
614 can't be replaced with func. This is because it is the
615 cfunc, and not the func, that has the value that the
616 is_complete_command hack is testing for. */
617 /* Clear off trailing whitespace, except for set and complete
620 && c->type != set_cmd
621 && !is_complete_command (c))
623 p = arg + strlen (arg) - 1;
624 while (p >= arg && (*p == ' ' || *p == '\t'))
629 /* If this command has been pre-hooked, run the hook first. */
630 execute_cmd_pre_hook (c);
632 if (c->deprecated_warn_user)
633 deprecated_cmd_warning (line);
635 /* c->user_commands would be NULL in the case of a python command. */
636 if (c->theclass == class_user && c->user_commands)
637 execute_user_command (c, arg);
638 else if (c->type == set_cmd)
639 do_set_command (arg, from_tty, c);
640 else if (c->type == show_cmd)
641 do_show_command (arg, from_tty, c);
642 else if (!cmd_func_p (c))
643 error (_("That is not a command, just a help topic."));
644 else if (deprecated_call_command_hook)
645 deprecated_call_command_hook (c, arg, from_tty);
647 cmd_func (c, arg, from_tty);
649 maybe_wait_sync_command_done (was_sync);
651 /* If this command has been post-hooked, run the hook last. */
652 execute_cmd_post_hook (c);
656 check_frame_language_change ();
658 do_cleanups (cleanup);
659 discard_cleanups (cleanup_if_error);
662 /* Run execute_command for P and FROM_TTY. Capture its output into the
663 returned string, do not display it to the screen. BATCH_FLAG will be
664 temporarily set to true. */
667 execute_command_to_string (char *p, int from_tty)
669 /* GDB_STDOUT should be better already restored during these
670 restoration callbacks. */
671 set_batch_flag_and_restore_page_info save_page_info;
673 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
675 string_file str_file;
678 current_uiout->redirect (&str_file);
679 ui_out_redirect_pop redirect_popper (current_uiout);
681 scoped_restore save_stdout
682 = make_scoped_restore (&gdb_stdout, &str_file);
683 scoped_restore save_stderr
684 = make_scoped_restore (&gdb_stderr, &str_file);
685 scoped_restore save_stdlog
686 = make_scoped_restore (&gdb_stdlog, &str_file);
687 scoped_restore save_stdtarg
688 = make_scoped_restore (&gdb_stdtarg, &str_file);
689 scoped_restore save_stdtargerr
690 = make_scoped_restore (&gdb_stdtargerr, &str_file);
692 execute_command (p, from_tty);
695 return std::move (str_file.string ());
699 /* When nonzero, cause dont_repeat to do nothing. This should only be
700 set via prevent_dont_repeat. */
702 static int suppress_dont_repeat = 0;
704 /* Commands call this if they do not want to be repeated by null lines. */
709 struct ui *ui = current_ui;
711 if (suppress_dont_repeat || server_command)
714 /* If we aren't reading from standard input, we are saving the last
715 thing read from stdin in line and don't want to delete it. Null
716 lines won't repeat here in any case. */
717 if (ui->instream == ui->stdin_stream)
718 *saved_command_line = 0;
721 /* Prevent dont_repeat from working, and return a cleanup that
722 restores the previous state. */
724 scoped_restore_tmpl<int>
725 prevent_dont_repeat (void)
727 return make_scoped_restore (&suppress_dont_repeat, 1);
731 /* Read a line from the stream "instream" without command line editing.
733 It prints PROMPT once at the start.
734 Action is compatible with "readline", e.g. space for the result is
735 malloc'd and should be freed by the caller.
737 A NULL return means end of file. */
740 gdb_readline_no_editing (const char *prompt)
742 struct buffer line_buffer;
743 struct ui *ui = current_ui;
744 /* Read from stdin if we are executing a user defined command. This
745 is the right thing for prompt_for_continue, at least. */
746 FILE *stream = ui->instream != NULL ? ui->instream : stdin;
747 int fd = fileno (stream);
749 buffer_init (&line_buffer);
753 /* Don't use a _filtered function here. It causes the assumed
754 character position to be off, since the newline we read from
755 the user is not accounted for. */
756 fputs_unfiltered (prompt, gdb_stdout);
757 gdb_flush (gdb_stdout);
768 /* Wait until at least one byte of data is available. Control-C
769 can interrupt interruptible_select, but not fgetc. */
771 FD_SET (fd, &readfds);
772 if (interruptible_select (fd + 1, &readfds, NULL, NULL, NULL) == -1)
776 /* If this was ctrl-c, the QUIT above handles it. */
779 perror_with_name (("select"));
786 if (line_buffer.used_size > 0)
787 /* The last line does not end with a newline. Return it, and
788 if we are called again fgetc will still return EOF and
789 we'll return NULL then. */
791 xfree (buffer_finish (&line_buffer));
797 if (line_buffer.used_size > 0
798 && line_buffer.buffer[line_buffer.used_size - 1] == '\r')
799 line_buffer.used_size--;
803 buffer_grow_char (&line_buffer, c);
806 buffer_grow_char (&line_buffer, '\0');
807 return buffer_finish (&line_buffer);
810 /* Variables which control command line editing and history
811 substitution. These variables are given default values at the end
813 static int command_editing_p;
815 /* NOTE 1999-04-29: This variable will be static again, once we modify
816 gdb to use the event loop as the default command loop and we merge
817 event-top.c into this file, top.c. */
819 /* static */ int history_expansion_p;
821 static int write_history_p;
823 show_write_history_p (struct ui_file *file, int from_tty,
824 struct cmd_list_element *c, const char *value)
826 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
830 /* The variable associated with the "set/show history size"
831 command. The value -1 means unlimited, and -2 means undefined. */
832 static int history_size_setshow_var = -2;
835 show_history_size (struct ui_file *file, int from_tty,
836 struct cmd_list_element *c, const char *value)
838 fprintf_filtered (file, _("The size of the command history is %s.\n"),
842 /* Variable associated with the "history remove-duplicates" option.
843 The value -1 means unlimited. */
844 static int history_remove_duplicates = 0;
847 show_history_remove_duplicates (struct ui_file *file, int from_tty,
848 struct cmd_list_element *c, const char *value)
850 fprintf_filtered (file,
851 _("The number of history entries to look back at for "
852 "duplicates is %s.\n"),
856 static char *history_filename;
858 show_history_filename (struct ui_file *file, int from_tty,
859 struct cmd_list_element *c, const char *value)
861 fprintf_filtered (file, _("The filename in which to record "
862 "the command history is \"%s\".\n"),
866 /* This is like readline(), but it has some gdb-specific behavior.
867 gdb may want readline in both the synchronous and async modes during
868 a single gdb invocation. At the ordinary top-level prompt we might
869 be using the async readline. That means we can't use
870 rl_pre_input_hook, since it doesn't work properly in async mode.
871 However, for a secondary prompt (" >", such as occurs during a
872 `define'), gdb wants a synchronous response.
874 We used to call readline() directly, running it in synchronous
875 mode. But mixing modes this way is not supported, and as of
876 readline 5.x it no longer works; the arrow keys come unbound during
877 the synchronous call. So we make a nested call into the event
878 loop. That's what gdb_readline_wrapper is for. */
880 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
881 rely on gdb_readline_wrapper_result, which might still be NULL if
882 the user types Control-D for EOF. */
883 static int gdb_readline_wrapper_done;
885 /* The result of the current call to gdb_readline_wrapper, once a newline
887 static char *gdb_readline_wrapper_result;
889 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
890 to be called after the newline is processed (which will redisplay
891 the prompt). But in gdb_readline_wrapper we will not get a new
892 prompt until the next call, or until we return to the event loop.
893 So we disable this hook around the newline and restore it before we
895 static void (*saved_after_char_processing_hook) (void);
901 gdb_in_secondary_prompt_p (struct ui *ui)
903 return ui->secondary_prompt_depth > 0;
907 /* This function is called when readline has seen a complete line of
911 gdb_readline_wrapper_line (char *line)
913 gdb_assert (!gdb_readline_wrapper_done);
914 gdb_readline_wrapper_result = line;
915 gdb_readline_wrapper_done = 1;
917 /* Prevent operate-and-get-next from acting too early. */
918 saved_after_char_processing_hook = after_char_processing_hook;
919 after_char_processing_hook = NULL;
921 /* Prevent parts of the prompt from being redisplayed if annotations
922 are enabled, and readline's state getting out of sync. We'll
923 reinstall the callback handler, which puts the terminal in raw
924 mode (or in readline lingo, in prepped state), when we're next
925 ready to process user input, either in display_gdb_prompt, or if
926 we're handling an asynchronous target event and running in the
927 background, just before returning to the event loop to process
928 further input (or more target events). */
929 if (current_ui->command_editing)
930 gdb_rl_callback_handler_remove ();
933 struct gdb_readline_wrapper_cleanup
935 void (*handler_orig) (char *);
936 int already_prompted_orig;
938 /* Whether the target was async. */
939 int target_is_async_orig;
943 gdb_readline_wrapper_cleanup (void *arg)
945 struct ui *ui = current_ui;
946 struct gdb_readline_wrapper_cleanup *cleanup
947 = (struct gdb_readline_wrapper_cleanup *) arg;
949 if (ui->command_editing)
950 rl_already_prompted = cleanup->already_prompted_orig;
952 gdb_assert (ui->input_handler == gdb_readline_wrapper_line);
953 ui->input_handler = cleanup->handler_orig;
955 /* Don't restore our input handler in readline yet. That would make
956 readline prep the terminal (putting it in raw mode), while the
957 line we just read may trigger execution of a command that expects
958 the terminal in the default cooked/canonical mode, such as e.g.,
959 running Python's interactive online help utility. See
960 gdb_readline_wrapper_line for when we'll reinstall it. */
962 gdb_readline_wrapper_result = NULL;
963 gdb_readline_wrapper_done = 0;
964 ui->secondary_prompt_depth--;
965 gdb_assert (ui->secondary_prompt_depth >= 0);
967 after_char_processing_hook = saved_after_char_processing_hook;
968 saved_after_char_processing_hook = NULL;
970 if (cleanup->target_is_async_orig)
977 gdb_readline_wrapper (const char *prompt)
979 struct ui *ui = current_ui;
980 struct cleanup *back_to;
981 struct gdb_readline_wrapper_cleanup *cleanup;
984 cleanup = XNEW (struct gdb_readline_wrapper_cleanup);
985 cleanup->handler_orig = ui->input_handler;
986 ui->input_handler = gdb_readline_wrapper_line;
988 if (ui->command_editing)
989 cleanup->already_prompted_orig = rl_already_prompted;
991 cleanup->already_prompted_orig = 0;
993 cleanup->target_is_async_orig = target_is_async_p ();
995 ui->secondary_prompt_depth++;
996 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
998 /* Processing events may change the current UI. */
999 scoped_restore save_ui = make_scoped_restore (¤t_ui);
1001 if (cleanup->target_is_async_orig)
1004 /* Display our prompt and prevent double prompt display. Don't pass
1005 down a NULL prompt, since that has special meaning for
1006 display_gdb_prompt -- it indicates a request to print the primary
1007 prompt, while we want a secondary prompt here. */
1008 display_gdb_prompt (prompt != NULL ? prompt : "");
1009 if (ui->command_editing)
1010 rl_already_prompted = 1;
1012 if (after_char_processing_hook)
1013 (*after_char_processing_hook) ();
1014 gdb_assert (after_char_processing_hook == NULL);
1016 while (gdb_do_one_event () >= 0)
1017 if (gdb_readline_wrapper_done)
1020 retval = gdb_readline_wrapper_result;
1021 do_cleanups (back_to);
1026 /* The current saved history number from operate-and-get-next.
1027 This is -1 if not valid. */
1028 static int operate_saved_history = -1;
1030 /* This is put on the appropriate hook and helps operate-and-get-next
1033 gdb_rl_operate_and_get_next_completion (void)
1035 int delta = where_history () - operate_saved_history;
1037 /* The `key' argument to rl_get_previous_history is ignored. */
1038 rl_get_previous_history (delta, 0);
1039 operate_saved_history = -1;
1041 /* readline doesn't automatically update the display for us. */
1044 after_char_processing_hook = NULL;
1045 rl_pre_input_hook = NULL;
1048 /* This is a gdb-local readline command handler. It accepts the
1049 current command line (like RET does) and, if this command was taken
1050 from the history, arranges for the next command in the history to
1051 appear on the command line when the prompt returns.
1052 We ignore the arguments. */
1054 gdb_rl_operate_and_get_next (int count, int key)
1058 /* Use the async hook. */
1059 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
1061 /* Find the current line, and find the next line to use. */
1062 where = where_history();
1064 if ((history_is_stifled () && (history_length >= history_max_entries))
1065 || (where >= history_length - 1))
1066 operate_saved_history = where;
1068 operate_saved_history = where + 1;
1070 return rl_newline (1, key);
1073 /* Number of user commands executed during this session. */
1075 static int command_count = 0;
1077 /* Add the user command COMMAND to the input history list. */
1080 gdb_add_history (const char *command)
1084 if (history_remove_duplicates != 0)
1087 int lookbehind_threshold;
1089 /* The lookbehind threshold for finding a duplicate history entry is
1090 bounded by command_count because we can't meaningfully delete
1091 history entries that are already stored in the history file since
1092 the history file is appended to. */
1093 if (history_remove_duplicates == -1
1094 || history_remove_duplicates > command_count)
1095 lookbehind_threshold = command_count;
1097 lookbehind_threshold = history_remove_duplicates;
1100 for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
1102 HIST_ENTRY *temp = previous_history ();
1107 if (strcmp (temp->line, command) == 0)
1109 HIST_ENTRY *prev = remove_history (where_history ());
1111 free_history_entry (prev);
1118 add_history (command);
1121 /* Safely append new history entries to the history file in a corruption-free
1122 way using an intermediate local history file. */
1125 gdb_safe_append_history (void)
1127 int ret, saved_errno;
1128 char *local_history_filename;
1129 struct cleanup *old_chain;
1131 local_history_filename
1132 = xstrprintf ("%s-gdb%ld~", history_filename, (long) getpid ());
1133 old_chain = make_cleanup (xfree, local_history_filename);
1135 ret = rename (history_filename, local_history_filename);
1136 saved_errno = errno;
1137 if (ret < 0 && saved_errno != ENOENT)
1139 warning (_("Could not rename %s to %s: %s"),
1140 history_filename, local_history_filename,
1141 safe_strerror (saved_errno));
1147 /* If the rename failed with ENOENT then either the global history
1148 file never existed in the first place or another GDB process is
1149 currently appending to it (and has thus temporarily renamed it).
1150 Since we can't distinguish between these two cases, we have to
1151 conservatively assume the first case and therefore must write out
1152 (not append) our known history to our local history file and try
1153 to move it back anyway. Otherwise a global history file would
1154 never get created! */
1155 gdb_assert (saved_errno == ENOENT);
1156 write_history (local_history_filename);
1160 append_history (command_count, local_history_filename);
1161 if (history_is_stifled ())
1162 history_truncate_file (local_history_filename, history_max_entries);
1165 ret = rename (local_history_filename, history_filename);
1166 saved_errno = errno;
1167 if (ret < 0 && saved_errno != EEXIST)
1168 warning (_("Could not rename %s to %s: %s"),
1169 local_history_filename, history_filename,
1170 safe_strerror (saved_errno));
1173 do_cleanups (old_chain);
1176 /* Read one line from the command input stream `instream' into a local
1177 static buffer. The buffer is made bigger as necessary. Returns
1178 the address of the start of the line.
1180 NULL is returned for end of file.
1182 *If* input is from an interactive stream (stdin), the line read is
1183 copied into the global 'saved_command_line' so that it can be
1186 This routine either uses fancy command line editing or simple input
1187 as the user has requested. */
1190 command_line_input (const char *prompt_arg, int repeat,
1191 const char *annotation_suffix)
1193 static struct buffer cmd_line_buffer;
1194 static int cmd_line_buffer_initialized;
1195 struct ui *ui = current_ui;
1196 const char *prompt = prompt_arg;
1198 int from_tty = ui->instream == ui->stdin_stream;
1200 /* The annotation suffix must be non-NULL. */
1201 if (annotation_suffix == NULL)
1202 annotation_suffix = "";
1204 if (from_tty && annotation_level > 1)
1209 = (char *) alloca ((prompt == NULL ? 0 : strlen (prompt))
1210 + strlen (annotation_suffix) + 40);
1212 local_prompt[0] = '\0';
1214 strcpy (local_prompt, prompt);
1215 strcat (local_prompt, "\n\032\032");
1216 strcat (local_prompt, annotation_suffix);
1217 strcat (local_prompt, "\n");
1219 prompt = local_prompt;
1222 if (!cmd_line_buffer_initialized)
1224 buffer_init (&cmd_line_buffer);
1225 cmd_line_buffer_initialized = 1;
1228 /* Starting a new command line. */
1229 cmd_line_buffer.used_size = 0;
1233 signal (STOP_SIGNAL, handle_stop_sig);
1240 /* Make sure that all output has been output. Some machines may
1241 let you get away with leaving out some of the gdb_flush, but
1244 gdb_flush (gdb_stdout);
1245 gdb_flush (gdb_stderr);
1247 if (source_file_name != NULL)
1248 ++source_line_number;
1250 if (from_tty && annotation_level > 1)
1252 puts_unfiltered ("\n\032\032pre-");
1253 puts_unfiltered (annotation_suffix);
1254 puts_unfiltered ("\n");
1257 /* Don't use fancy stuff if not talking to stdin. */
1258 if (deprecated_readline_hook
1260 && input_interactive_p (current_ui))
1262 rl = (*deprecated_readline_hook) (prompt);
1264 else if (command_editing_p
1266 && input_interactive_p (current_ui))
1268 rl = gdb_readline_wrapper (prompt);
1272 rl = gdb_readline_no_editing (prompt);
1275 cmd = handle_line_of_input (&cmd_line_buffer, rl,
1276 repeat, annotation_suffix);
1277 if (cmd == (char *) EOF)
1285 /* Got partial input. I.e., got a line that ends with a
1286 continuation character (backslash). Suppress printing the
1293 signal (STOP_SIGNAL, SIG_DFL);
1299 /* Print the GDB banner. */
1301 print_gdb_version (struct ui_file *stream)
1303 /* From GNU coding standards, first line is meant to be easy for a
1304 program to parse, and is just canonical program name and version
1305 number, which starts after last space. */
1307 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1309 /* Second line is a copyright notice. */
1311 fprintf_filtered (stream,
1312 "Copyright (C) 2017 Free Software Foundation, Inc.\n");
1314 /* Following the copyright is a brief statement that the program is
1315 free software, that users are free to copy and change it on
1316 certain conditions, that it is covered by the GNU GPL, and that
1317 there is no warranty. */
1319 fprintf_filtered (stream, "\
1320 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1321 \nThis is free software: you are free to change and redistribute it.\n\
1322 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1323 and \"show warranty\" for details.\n");
1325 /* After the required info we print the configuration information. */
1327 fprintf_filtered (stream, "This GDB was configured as \"");
1328 if (strcmp (host_name, target_name) != 0)
1330 fprintf_filtered (stream, "--host=%s --target=%s",
1331 host_name, target_name);
1335 fprintf_filtered (stream, "%s", host_name);
1337 fprintf_filtered (stream, "\".\n\
1338 Type \"show configuration\" for configuration details.");
1340 if (REPORT_BUGS_TO[0])
1342 fprintf_filtered (stream,
1343 _("\nFor bug reporting instructions, please see:\n"));
1344 fprintf_filtered (stream, "%s.\n", REPORT_BUGS_TO);
1346 fprintf_filtered (stream,
1347 _("Find the GDB manual and other documentation \
1348 resources online at:\n<http://www.gnu.org/software/gdb/documentation/>.\n"));
1349 fprintf_filtered (stream, _("For help, type \"help\".\n"));
1350 fprintf_filtered (stream, _("Type \"apropos word\" to search for \
1351 commands related to \"word\"."));
1354 /* Print the details of GDB build-time configuration. */
1356 print_gdb_configuration (struct ui_file *stream)
1358 fprintf_filtered (stream, _("\
1359 This GDB was configured as follows:\n\
1360 configure --host=%s --target=%s\n\
1361 "), host_name, target_name);
1362 fprintf_filtered (stream, _("\
1363 --with-auto-load-dir=%s\n\
1364 --with-auto-load-safe-path=%s\n\
1365 "), AUTO_LOAD_DIR, AUTO_LOAD_SAFE_PATH);
1367 fprintf_filtered (stream, _("\
1371 fprintf_filtered (stream, _("\
1376 fprintf_filtered (stream, _("\
1377 --with-gdb-datadir=%s%s\n\
1378 "), GDB_DATADIR, GDB_DATADIR_RELOCATABLE ? " (relocatable)" : "");
1380 fprintf_filtered (stream, _("\
1381 --with-iconv-bin=%s%s\n\
1382 "), ICONV_BIN, ICONV_BIN_RELOCATABLE ? " (relocatable)" : "");
1384 if (JIT_READER_DIR[0])
1385 fprintf_filtered (stream, _("\
1386 --with-jit-reader-dir=%s%s\n\
1387 "), JIT_READER_DIR, JIT_READER_DIR_RELOCATABLE ? " (relocatable)" : "");
1388 #if HAVE_LIBUNWIND_IA64_H
1389 fprintf_filtered (stream, _("\
1390 --with-libunwind-ia64\n\
1393 fprintf_filtered (stream, _("\
1394 --without-libunwind-ia64\n\
1398 fprintf_filtered (stream, _("\
1402 fprintf_filtered (stream, _("\
1406 #ifdef WITH_PYTHON_PATH
1407 fprintf_filtered (stream, _("\
1408 --with-python=%s%s\n\
1409 "), WITH_PYTHON_PATH, PYTHON_PATH_RELOCATABLE ? " (relocatable)" : "");
1412 fprintf_filtered (stream, _("\
1416 fprintf_filtered (stream, _("\
1421 fprintf_filtered (stream, _("\
1422 --with-relocated-sources=%s\n\
1426 fprintf_filtered (stream, _("\
1427 --with-separate-debug-dir=%s%s\n\
1428 "), DEBUGDIR, DEBUGDIR_RELOCATABLE ? " (relocatable)" : "");
1429 if (TARGET_SYSTEM_ROOT[0])
1430 fprintf_filtered (stream, _("\
1431 --with-sysroot=%s%s\n\
1432 "), TARGET_SYSTEM_ROOT, TARGET_SYSTEM_ROOT_RELOCATABLE ? " (relocatable)" : "");
1433 if (SYSTEM_GDBINIT[0])
1434 fprintf_filtered (stream, _("\
1435 --with-system-gdbinit=%s%s\n\
1436 "), SYSTEM_GDBINIT, SYSTEM_GDBINIT_RELOCATABLE ? " (relocatable)" : "");
1437 #if HAVE_LIBBABELTRACE
1438 fprintf_filtered (stream, _("\
1439 --with-babeltrace\n\
1442 fprintf_filtered (stream, _("\
1443 --without-babeltrace\n\
1446 /* We assume "relocatable" will be printed at least once, thus we always
1447 print this text. It's a reasonably safe assumption for now. */
1448 fprintf_filtered (stream, _("\n\
1449 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1450 tree, and GDB will still find it.)\n\
1455 /* The current top level prompt, settable with "set prompt", and/or
1456 with the python `gdb.prompt_hook' hook. */
1457 static char *top_prompt;
1459 /* Access method for the GDB prompt string. */
1467 /* Set method for the GDB prompt string. */
1470 set_prompt (const char *s)
1472 char *p = xstrdup (s);
1485 /* Callback for iterate_over_inferiors. Kills or detaches the given
1486 inferior, depending on how we originally gained control of it. */
1489 kill_or_detach (struct inferior *inf, void *args)
1491 struct qt_args *qt = (struct qt_args *) args;
1492 struct thread_info *thread;
1497 thread = any_thread_of_process (inf->pid);
1500 switch_to_thread (thread->ptid);
1502 /* Leave core files alone. */
1503 if (target_has_execution)
1505 if (inf->attach_flag)
1506 target_detach (qt->args, qt->from_tty);
1515 /* Callback for iterate_over_inferiors. Prints info about what GDB
1516 will do to each inferior on a "quit". ARG points to a struct
1517 ui_out where output is to be collected. */
1520 print_inferior_quit_action (struct inferior *inf, void *arg)
1522 struct ui_file *stb = (struct ui_file *) arg;
1527 if (inf->attach_flag)
1528 fprintf_filtered (stb,
1529 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1530 target_pid_to_str (pid_to_ptid (inf->pid)));
1532 fprintf_filtered (stb,
1533 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1534 target_pid_to_str (pid_to_ptid (inf->pid)));
1539 /* If necessary, make the user confirm that we should quit. Return
1540 non-zero if we should quit, zero if we shouldn't. */
1545 /* Don't even ask if we're only debugging a core file inferior. */
1546 if (!have_live_inferiors ())
1549 /* Build the query string as a single string. */
1552 stb.puts (_("A debugging session is active.\n\n"));
1553 iterate_over_inferiors (print_inferior_quit_action, &stb);
1554 stb.puts (_("\nQuit anyway? "));
1556 return query ("%s", stb.c_str ());
1559 /* Prepare to exit GDB cleanly by undoing any changes made to the
1560 terminal so that we leave the terminal in the state we acquired it. */
1563 undo_terminal_modifications_before_exit (void)
1565 struct ui *saved_top_level = current_ui;
1567 target_terminal::ours ();
1569 current_ui = main_ui;
1574 gdb_disable_readline ();
1576 current_ui = saved_top_level;
1580 /* Quit without asking for confirmation. */
1583 quit_force (int *exit_arg, int from_tty)
1588 undo_terminal_modifications_before_exit ();
1590 /* An optional expression may be used to cause gdb to terminate with the
1591 value of that expression. */
1593 exit_code = *exit_arg;
1594 else if (return_child_result)
1595 exit_code = return_child_result_value;
1598 qt.from_tty = from_tty;
1600 /* We want to handle any quit errors and exit regardless. */
1602 /* Get out of tfind mode, and kill or detach all inferiors. */
1605 disconnect_tracing ();
1606 iterate_over_inferiors (kill_or_detach, &qt);
1608 CATCH (ex, RETURN_MASK_ALL)
1610 exception_print (gdb_stderr, ex);
1614 /* Give all pushed targets a chance to do minimal cleanup, and pop
1620 CATCH (ex, RETURN_MASK_ALL)
1622 exception_print (gdb_stderr, ex);
1626 /* Save the history information if it is appropriate to do so. */
1629 if (write_history_p && history_filename)
1634 /* History is currently shared between all UIs. If there's
1635 any UI with a terminal, save history. */
1638 if (input_interactive_p (ui))
1646 gdb_safe_append_history ();
1649 CATCH (ex, RETURN_MASK_ALL)
1651 exception_print (gdb_stderr, ex);
1655 /* Do any final cleanups before exiting. */
1658 do_final_cleanups (all_cleanups ());
1660 CATCH (ex, RETURN_MASK_ALL)
1662 exception_print (gdb_stderr, ex);
1669 /* The value of the "interactive-mode" setting. */
1670 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
1672 /* Implement the "show interactive-mode" option. */
1675 show_interactive_mode (struct ui_file *file, int from_tty,
1676 struct cmd_list_element *c,
1679 if (interactive_mode == AUTO_BOOLEAN_AUTO)
1680 fprintf_filtered (file, "Debugger's interactive mode "
1681 "is %s (currently %s).\n",
1682 value, input_interactive_p (current_ui) ? "on" : "off");
1684 fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
1687 /* Returns whether GDB is running on an interactive terminal. */
1690 input_interactive_p (struct ui *ui)
1695 if (interactive_mode != AUTO_BOOLEAN_AUTO)
1696 return interactive_mode == AUTO_BOOLEAN_TRUE;
1698 return ui->input_interactive_p;
1702 dont_repeat_command (char *ignored, int from_tty)
1704 /* Can't call dont_repeat here because we're not necessarily reading
1706 *saved_command_line = 0;
1709 /* Functions to manipulate command line editing control variables. */
1711 /* Number of commands to print in each call to show_commands. */
1712 #define Hist_print 10
1714 show_commands (char *args, int from_tty)
1716 /* Index for history commands. Relative to history_base. */
1719 /* Number of the history entry which we are planning to display next.
1720 Relative to history_base. */
1723 /* Print out some of the commands from the command history. */
1727 if (args[0] == '+' && args[1] == '\0')
1728 /* "info editing +" should print from the stored position. */
1731 /* "info editing <exp>" should print around command number <exp>. */
1732 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1734 /* "show commands" means print the last Hist_print commands. */
1737 num = history_length - Hist_print;
1743 /* If there are at least Hist_print commands, we want to display the last
1744 Hist_print rather than, say, the last 6. */
1745 if (history_length - num < Hist_print)
1747 num = history_length - Hist_print;
1753 offset < num + Hist_print && offset < history_length;
1756 printf_filtered ("%5d %s\n", history_base + offset,
1757 (history_get (history_base + offset))->line);
1760 /* The next command we want to display is the next one that we haven't
1764 /* If the user repeats this command with return, it should do what
1765 "show commands +" does. This is unnecessary if arg is null,
1766 because "show commands +" is not useful after "show commands". */
1767 if (from_tty && args)
1774 /* Update the size of our command history file to HISTORY_SIZE.
1776 A HISTORY_SIZE of -1 stands for unlimited. */
1779 set_readline_history_size (int history_size)
1781 gdb_assert (history_size >= -1);
1783 if (history_size == -1)
1784 unstifle_history ();
1786 stifle_history (history_size);
1789 /* Called by do_setshow_command. */
1791 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1793 set_readline_history_size (history_size_setshow_var);
1797 set_history (char *args, int from_tty)
1799 printf_unfiltered (_("\"set history\" must be followed "
1800 "by the name of a history subcommand.\n"));
1801 help_list (sethistlist, "set history ", all_commands, gdb_stdout);
1805 show_history (char *args, int from_tty)
1807 cmd_show_list (showhistlist, from_tty, "");
1810 int info_verbose = 0; /* Default verbose msgs off. */
1812 /* Called by do_setshow_command. An elaborate joke. */
1814 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1816 const char *cmdname = "verbose";
1817 struct cmd_list_element *showcmd;
1819 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1820 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1824 c->doc = "Set verbose printing of informational messages.";
1825 showcmd->doc = "Show verbose printing of informational messages.";
1829 c->doc = "Set verbosity.";
1830 showcmd->doc = "Show verbosity.";
1834 /* Init the history buffer. Note that we are called after the init file(s)
1835 have been read so that the user can change the history file via his
1836 .gdbinit file (for instance). The GDBHISTFILE environment variable
1837 overrides all of this. */
1844 tmpenv = getenv ("GDBHISTSIZE");
1851 tmpenv = skip_spaces (tmpenv);
1853 var = strtol (tmpenv, &endptr, 10);
1854 saved_errno = errno;
1855 endptr = skip_spaces (endptr);
1857 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1858 empty string, a negative number or a huge positive number (larger than
1859 INT_MAX) then set the history size to unlimited. Otherwise set our
1860 history size to the number we have read. This behavior is consistent
1861 with how bash handles HISTSIZE. */
1862 if (*endptr != '\0')
1864 else if (*tmpenv == '\0'
1867 /* On targets where INT_MAX == LONG_MAX, we have to look at
1868 errno after calling strtol to distinguish between a value that
1869 is exactly INT_MAX and an overflowing value that was clamped
1871 || (var == INT_MAX && saved_errno == ERANGE))
1872 history_size_setshow_var = -1;
1874 history_size_setshow_var = var;
1877 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1879 if (history_size_setshow_var == -2)
1880 history_size_setshow_var = 256;
1882 set_readline_history_size (history_size_setshow_var);
1884 tmpenv = getenv ("GDBHISTFILE");
1886 history_filename = xstrdup (tmpenv);
1887 else if (!history_filename)
1889 /* We include the current directory so that if the user changes
1890 directories the file written will be the same as the one
1893 /* No leading dots in file names are allowed on MSDOS. */
1894 history_filename = concat (current_directory, "/_gdb_history",
1897 history_filename = concat (current_directory, "/.gdb_history",
1901 read_history (history_filename);
1905 show_prompt (struct ui_file *file, int from_tty,
1906 struct cmd_list_element *c, const char *value)
1908 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1911 /* "set editing" command. */
1914 set_editing (char *args, int from_tty, struct cmd_list_element *c)
1916 change_line_handler (set_editing_cmd_var);
1917 /* Update the control variable so that MI's =cmd-param-changed event
1918 shows the correct value. */
1919 set_editing_cmd_var = current_ui->command_editing;
1923 show_editing (struct ui_file *file, int from_tty,
1924 struct cmd_list_element *c, const char *value)
1926 fprintf_filtered (file, _("Editing of command lines as "
1927 "they are typed is %s.\n"),
1928 current_ui->command_editing ? _("on") : _("off"));
1932 show_annotation_level (struct ui_file *file, int from_tty,
1933 struct cmd_list_element *c, const char *value)
1935 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1939 show_exec_done_display_p (struct ui_file *file, int from_tty,
1940 struct cmd_list_element *c, const char *value)
1942 fprintf_filtered (file, _("Notification of completion for "
1943 "asynchronous execution commands is %s.\n"),
1947 /* New values of the "data-directory" parameter are staged here. */
1948 static char *staged_gdb_datadir;
1950 /* "set" command for the gdb_datadir configuration variable. */
1953 set_gdb_datadir (char *args, int from_tty, struct cmd_list_element *c)
1955 set_gdb_data_directory (staged_gdb_datadir);
1956 observer_notify_gdb_datadir_changed ();
1959 /* "show" command for the gdb_datadir configuration variable. */
1962 show_gdb_datadir (struct ui_file *file, int from_tty,
1963 struct cmd_list_element *c, const char *value)
1965 fprintf_filtered (file, _("GDB's data directory is \"%s\".\n"),
1970 set_history_filename (char *args, int from_tty, struct cmd_list_element *c)
1972 /* We include the current directory so that if the user changes
1973 directories the file written will be the same as the one
1975 if (!IS_ABSOLUTE_PATH (history_filename))
1976 history_filename = reconcat (history_filename, current_directory, "/",
1977 history_filename, (char *) NULL);
1983 struct cmd_list_element *c;
1985 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1986 the DEFAULT_PROMPT is. */
1987 set_prompt (DEFAULT_PROMPT);
1989 /* Set the important stuff up for command editing. */
1990 command_editing_p = 1;
1991 history_expansion_p = 0;
1992 write_history_p = 0;
1994 /* Setup important stuff for command line editing. */
1995 rl_completion_word_break_hook = gdb_completion_word_break_characters;
1996 rl_attempted_completion_function = gdb_rl_attempted_completion_function;
1997 set_rl_completer_word_break_characters (default_word_break_characters ());
1998 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1999 rl_completion_display_matches_hook = cli_display_match_list;
2000 rl_readline_name = "gdb";
2001 rl_terminal_name = getenv ("TERM");
2003 /* The name for this defun comes from Bash, where it originated.
2004 15 is Control-o, the same binding this function has in Bash. */
2005 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
2007 add_setshow_string_cmd ("prompt", class_support,
2009 _("Set gdb's prompt"),
2010 _("Show gdb's prompt"),
2013 &setlist, &showlist);
2015 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
2016 Don't repeat this command.\nPrimarily \
2017 used inside of user-defined commands that should not be repeated when\n\
2020 add_setshow_boolean_cmd ("editing", class_support,
2021 &set_editing_cmd_var, _("\
2022 Set editing of command lines as they are typed."), _("\
2023 Show editing of command lines as they are typed."), _("\
2024 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2025 Without an argument, command line editing is enabled. To edit, use\n\
2026 EMACS-like or VI-like commands like control-P or ESC."),
2029 &setlist, &showlist);
2031 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
2032 Set saving of the history record on exit."), _("\
2033 Show saving of the history record on exit."), _("\
2034 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2035 Without an argument, saving is enabled."),
2037 show_write_history_p,
2038 &sethistlist, &showhistlist);
2040 add_setshow_zuinteger_unlimited_cmd ("size", no_class,
2041 &history_size_setshow_var, _("\
2042 Set the size of the command history,"), _("\
2043 Show the size of the command history,"), _("\
2044 ie. the number of previous commands to keep a record of.\n\
2045 If set to \"unlimited\", the number of commands kept in the history\n\
2046 list is unlimited. This defaults to the value of the environment\n\
2047 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2048 set_history_size_command,
2050 &sethistlist, &showhistlist);
2052 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
2053 &history_remove_duplicates, _("\
2054 Set how far back in history to look for and remove duplicate entries."), _("\
2055 Show how far back in history to look for and remove duplicate entries."), _("\
2056 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2057 and remove the first history entry that is a duplicate of the most recent\n\
2058 entry, each time a new history entry is added.\n\
2059 If set to \"unlimited\", this lookbehind is unbounded.\n\
2060 Only history entries added during this session are considered for removal.\n\
2061 If set to 0, removal of duplicate history entries is disabled.\n\
2062 By default this option is set to 0."),
2064 show_history_remove_duplicates,
2065 &sethistlist, &showhistlist);
2067 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
2068 Set the filename in which to record the command history"), _("\
2069 Show the filename in which to record the command history"), _("\
2070 (the list of previous commands of which a record is kept)."),
2071 set_history_filename,
2072 show_history_filename,
2073 &sethistlist, &showhistlist);
2075 add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
2076 Set whether to confirm potentially dangerous operations."), _("\
2077 Show whether to confirm potentially dangerous operations."), NULL,
2080 &setlist, &showlist);
2082 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
2083 Set annotation_level."), _("\
2084 Show annotation_level."), _("\
2085 0 == normal; 1 == fullname (for use when running under emacs)\n\
2086 2 == output annotated suitably for use by programs that control GDB."),
2088 show_annotation_level,
2089 &setlist, &showlist);
2091 add_setshow_boolean_cmd ("exec-done-display", class_support,
2092 &exec_done_display_p, _("\
2093 Set notification of completion for asynchronous execution commands."), _("\
2094 Show notification of completion for asynchronous execution commands."), _("\
2095 Use \"on\" to enable the notification, and \"off\" to disable it."),
2097 show_exec_done_display_p,
2098 &setlist, &showlist);
2100 add_setshow_filename_cmd ("data-directory", class_maintenance,
2101 &staged_gdb_datadir, _("Set GDB's data directory."),
2102 _("Show GDB's data directory."),
2104 When set, GDB uses the specified path to search for data files."),
2105 set_gdb_datadir, show_gdb_datadir,
2109 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
2110 &interactive_mode, _("\
2111 Set whether GDB's standard input is a terminal."), _("\
2112 Show whether GDB's standard input is a terminal."), _("\
2113 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2114 means that GDB should wait for the user to answer queries associated to\n\
2115 commands entered at the command prompt. If off, GDB assumes that standard\n\
2116 input is not a terminal, and uses the default answer to all queries.\n\
2117 If auto (the default), determine which mode to use based on the standard\n\
2120 show_interactive_mode,
2121 &setlist, &showlist);
2123 c = add_cmd ("new-ui", class_support, new_ui_command, _("\
2124 Create a new UI. It takes two arguments:\n\
2125 The first argument is the name of the interpreter to run.\n\
2126 The second argument is the terminal the UI runs on.\n"), &cmdlist);
2127 set_cmd_completer (c, interpreter_completer);
2131 gdb_init (char *argv0)
2133 if (pre_init_ui_hook)
2134 pre_init_ui_hook ();
2136 /* Run the init function of each source file. */
2139 /* Make sure we return to the original directory upon exit, come
2140 what may, since the OS doesn't do that for us. */
2141 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
2144 init_cmd_lists (); /* This needs to be done first. */
2145 initialize_targets (); /* Setup target_terminal macros for utils.c. */
2146 initialize_utils (); /* Make errors and warnings possible. */
2150 /* Here is where we call all the _initialize_foo routines. */
2151 initialize_all_files ();
2153 /* This creates the current_program_space. Do this after all the
2154 _initialize_foo routines have had a chance to install their
2155 per-sspace data keys. Also do this before
2156 initialize_current_architecture is called, because it accesses
2157 exec_bfd of the current program space. */
2158 initialize_progspace ();
2159 initialize_inferiors ();
2160 initialize_current_architecture ();
2162 init_main (); /* But that omits this file! Do it now. */
2164 initialize_stdin_serial ();
2166 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2168 set_initial_gdb_ttystate ();
2170 async_init_signals ();
2172 /* We need a default language for parsing expressions, so simple
2173 things like "set width 0" won't fail if no language is explicitly
2174 set in a config file or implicitly set by reading an executable
2176 set_language (language_c);
2177 expected_language = current_language; /* Don't warn about the change. */
2179 /* Python initialization, for example, can require various commands to be
2180 installed. For example "info pretty-printer" needs the "info"
2181 prefix to be installed. Keep things simple and just do final
2182 script initialization here. */
2183 finish_ext_lang_initialization ();