Remove make_delete_ui_cleanup
[external/binutils.git] / gdb / top.c
1 /* Top level stuff for GDB, the GNU debugger.
2
3    Copyright (C) 1986-2017 Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
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.
11
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.
16
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/>.  */
19
20 #include "defs.h"
21 #include "gdbcmd.h"
22 #include "cli/cli-cmds.h"
23 #include "cli/cli-script.h"
24 #include "cli/cli-setshow.h"
25 #include "cli/cli-decode.h"
26 #include "symtab.h"
27 #include "inferior.h"
28 #include "infrun.h"
29 #include <signal.h>
30 #include "target.h"
31 #include "target-dcache.h"
32 #include "breakpoint.h"
33 #include "gdbtypes.h"
34 #include "expression.h"
35 #include "value.h"
36 #include "language.h"
37 #include "terminal.h"           /* For job_control.  */
38 #include "job-control.h"
39 #include "annotate.h"
40 #include "completer.h"
41 #include "top.h"
42 #include "version.h"
43 #include "serial.h"
44 #include "doublest.h"
45 #include "main.h"
46 #include "event-loop.h"
47 #include "gdbthread.h"
48 #include "extension.h"
49 #include "interps.h"
50 #include "observer.h"
51 #include "maint.h"
52 #include "filenames.h"
53 #include "frame.h"
54 #include "buffer.h"
55 #include "gdb_select.h"
56
57 /* readline include files.  */
58 #include "readline/readline.h"
59 #include "readline/history.h"
60
61 /* readline defines this.  */
62 #undef savestring
63
64 #include <sys/types.h>
65
66 #include "event-top.h"
67 #include <sys/stat.h>
68 #include <ctype.h>
69 #include "ui-out.h"
70 #include "cli-out.h"
71 #include "tracepoint.h"
72 #include "inf-loop.h"
73
74 #if defined(TUI)
75 # include "tui/tui.h"
76 #endif
77
78 #ifndef O_NOCTTY
79 # define O_NOCTTY 0
80 #endif
81
82 extern void initialize_all_files (void);
83
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
87
88 /* Default command line prompt.  This is overriden in some configs.  */
89
90 #ifndef DEFAULT_PROMPT
91 #define DEFAULT_PROMPT  "(gdb) "
92 #endif
93
94 /* Generate a function that exports a pointer to a field of the
95    current UI.  */
96
97 #define gen_ret_current_ui_field_ptr(type, name)        \
98 type *                                                  \
99 current_ui_## name ## _ptr (void)                       \
100 {                                                       \
101   return &current_ui->m_ ## name;               \
102 }
103
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)
109
110 /* Initialization file name for gdb.  This is host-dependent.  */
111
112 const char gdbinit[] = GDBINIT;
113
114 int inhibit_gdbinit = 0;
115
116 extern char lang_frame_mismatch_warn[];         /* language.c */
117
118 /* Flag for whether we want to confirm potentially dangerous
119    operations.  Default is yes.  */
120
121 int confirm = 1;
122
123 static void
124 show_confirm (struct ui_file *file, int from_tty,
125               struct cmd_list_element *c, const char *value)
126 {
127   fprintf_filtered (file, _("Whether to confirm potentially "
128                             "dangerous operations is %s.\n"),
129                     value);
130 }
131
132 /* Current working directory.  */
133
134 char *current_directory;
135
136 /* The last command line executed on the console.  Used for command
137    repetitions.  */
138 char *saved_command_line;
139
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.  */
146 int server_command;
147
148 /* Timeout limit for response from target.  */
149
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.
155
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.
160
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.
164
165    As remote.c is used much more than remote-e7000.c, it was changed 
166    back to 2 seconds in 1999.  */
167
168 int remote_timeout = 2;
169
170 /* Non-zero tells remote* modules to output debugging info.  */
171
172 int remote_debug = 0;
173
174 /* Sbrk location on entry to main.  Used for statistics only.  */
175 #ifdef HAVE_SBRK
176 char *lim_at_start;
177 #endif
178
179 /* Hooks for alternate command interfaces.  */
180
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
184    otherwise.  */
185
186 int (*deprecated_ui_loop_hook) (int);
187
188
189 /* Called from print_frame_info to list the line we stopped in.  */
190
191 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s, 
192                                                   int line,
193                                                   int stopline, 
194                                                   int noerror);
195 /* Replaces most of query.  */
196
197 int (*deprecated_query_hook) (const char *, va_list);
198
199 /* Replaces most of warning.  */
200
201 void (*deprecated_warning_hook) (const char *, va_list);
202
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.  */
214
215 void (*deprecated_readline_begin_hook) (const char *, ...);
216 char *(*deprecated_readline_hook) (const char *);
217 void (*deprecated_readline_end_hook) (void);
218
219 /* Called as appropriate to notify the interface that we have attached
220    to or detached from an already running process.  */
221
222 void (*deprecated_attach_hook) (void);
223 void (*deprecated_detach_hook) (void);
224
225 /* Called during long calculations to allow GUI to repair window
226    damage, and to check for stop buttons, etc...  */
227
228 void (*deprecated_interactive_hook) (void);
229
230 /* Called when going to wait for the target.  Usually allows the GUI
231    to run while waiting for target events.  */
232
233 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
234                                        struct target_waitstatus *status,
235                                        int options);
236
237 /* Used by UI as a wrapper around command execution.  May do various
238    things like enabling/disabling buttons, etc...  */
239
240 void (*deprecated_call_command_hook) (struct cmd_list_element * c, 
241                                       char *cmd, int from_tty);
242
243 /* Called when the current thread changes.  Argument is thread id.  */
244
245 void (*deprecated_context_hook) (int id);
246
247 /* The highest UI number ever assigned.  */
248 static int highest_ui_num;
249
250 /* See top.h.  */
251
252 ui::ui (FILE *instream_, FILE *outstream_, FILE *errstream_)
253   : next (nullptr),
254     num (++highest_ui_num),
255     call_readline (nullptr),
256     input_handler (nullptr),
257     command_editing (0),
258     interp_info (nullptr),
259     async (0),
260     secondary_prompt_depth (0),
261     stdin_stream (instream_),
262     instream (instream_),
263     outstream (outstream_),
264     errstream (errstream_),
265     input_fd (fileno (instream)),
266     input_interactive_p (ISATTY (instream)),
267     prompt_state (PROMPT_NEEDED),
268     m_gdb_stdout (new stdio_file (outstream)),
269     m_gdb_stdin (new stdio_file (instream)),
270     m_gdb_stderr (new stderr_file (errstream)),
271     m_gdb_stdlog (m_gdb_stderr),
272     m_current_uiout (nullptr)
273 {
274   buffer_init (&line_buffer);
275
276   if (ui_list == NULL)
277     ui_list = this;
278   else
279     {
280       struct ui *last;
281
282       for (last = ui_list; last->next != NULL; last = last->next)
283         ;
284       last->next = this;
285     }
286 }
287
288 ui::~ui ()
289 {
290   struct ui *ui, *uiprev;
291
292   uiprev = NULL;
293
294   for (ui = ui_list; ui != NULL; uiprev = ui, ui = ui->next)
295     if (ui == this)
296       break;
297
298   gdb_assert (ui != NULL);
299
300   if (uiprev != NULL)
301     uiprev->next = next;
302   else
303     ui_list = next;
304
305   delete m_gdb_stdin;
306   delete m_gdb_stdout;
307   delete m_gdb_stderr;
308 }
309
310 /* Open file named NAME for read/write, making sure not to make it the
311    controlling terminal.  */
312
313 static gdb_file_up
314 open_terminal_stream (const char *name)
315 {
316   int fd;
317
318   fd = gdb_open_cloexec (name, O_RDWR | O_NOCTTY, 0);
319   if (fd < 0)
320     perror_with_name  (_("opening terminal failed"));
321
322   return gdb_file_up (fdopen (fd, "w+"));
323 }
324
325 /* Implementation of the "new-ui" command.  */
326
327 static void
328 new_ui_command (const char *args, int from_tty)
329 {
330   struct interp *interp;
331   gdb_file_up stream[3];
332   int i;
333   int res;
334   int argc;
335   const char *interpreter_name;
336   const char *tty_name;
337
338   dont_repeat ();
339
340   gdb_argv argv (args);
341   argc = argv.count ();
342
343   if (argc < 2)
344     error (_("usage: new-ui <interpreter> <tty>"));
345
346   interpreter_name = argv[0];
347   tty_name = argv[1];
348
349   {
350     scoped_restore save_ui = make_scoped_restore (&current_ui);
351
352     /* Open specified terminal, once for each of
353        stdin/stdout/stderr.  */
354     for (i = 0; i < 3; i++)
355       stream[i] = open_terminal_stream (tty_name);
356
357     std::unique_ptr<ui> ui
358       (new struct ui (stream[0].get (), stream[1].get (), stream[2].get ()));
359
360     ui->async = 1;
361
362     current_ui = ui.get ();
363
364     set_top_level_interpreter (interpreter_name);
365
366     interp_pre_command_loop (top_level_interpreter ());
367
368     /* Make sure the files are not closed.  */
369     stream[0].release ();
370     stream[1].release ();
371     stream[2].release ();
372
373     ui.release ();
374   }
375
376   printf_unfiltered ("New UI allocated\n");
377 }
378
379 /* Handler for SIGHUP.  */
380
381 #ifdef SIGHUP
382 /* NOTE 1999-04-29: This function will be static again, once we modify
383    gdb to use the event loop as the default command loop and we merge
384    event-top.c into this file, top.c.  */
385 /* static */ void
386 quit_cover (void)
387 {
388   /* Stop asking user for confirmation --- we're exiting.  This
389      prevents asking the user dumb questions.  */
390   confirm = 0;
391   quit_command ((char *) 0, 0);
392 }
393 #endif /* defined SIGHUP */
394 \f
395 /* Line number we are currently in, in a file which is being sourced.  */
396 /* NOTE 1999-04-29: This variable will be static again, once we modify
397    gdb to use the event loop as the default command loop and we merge
398    event-top.c into this file, top.c.  */
399 /* static */ int source_line_number;
400
401 /* Name of the file we are sourcing.  */
402 /* NOTE 1999-04-29: This variable will be static again, once we modify
403    gdb to use the event loop as the default command loop and we merge
404    event-top.c into this file, top.c.  */
405 /* static */ const char *source_file_name;
406
407 /* Read commands from STREAM.  */
408 void
409 read_command_file (FILE *stream)
410 {
411   struct ui *ui = current_ui;
412
413   scoped_restore save_instream
414     = make_scoped_restore (&ui->instream, stream);
415
416   /* Read commands from `instream' and execute them until end of file
417      or error reading instream.  */
418
419   while (ui->instream != NULL && !feof (ui->instream))
420     {
421       char *command;
422
423       /* Get a command-line.  This calls the readline package.  */
424       command = command_line_input (NULL, 0, NULL);
425       if (command == NULL)
426         break;
427       command_handler (command);
428     }
429 }
430 \f
431 void (*pre_init_ui_hook) (void);
432
433 #ifdef __MSDOS__
434 static void
435 do_chdir_cleanup (void *old_dir)
436 {
437   chdir ((const char *) old_dir);
438   xfree (old_dir);
439 }
440 #endif
441
442 struct cleanup *
443 prepare_execute_command (void)
444 {
445   struct value *mark;
446   struct cleanup *cleanup;
447
448   mark = value_mark ();
449   cleanup = make_cleanup_value_free_to_mark (mark);
450
451   /* With multiple threads running while the one we're examining is
452      stopped, the dcache can get stale without us being able to detect
453      it.  For the duration of the command, though, use the dcache to
454      help things like backtrace.  */
455   if (non_stop)
456     target_dcache_invalidate ();
457
458   return cleanup;
459 }
460
461 /* Tell the user if the language has changed (except first time) after
462    executing a command.  */
463
464 void
465 check_frame_language_change (void)
466 {
467   static int warned = 0;
468   struct frame_info *frame;
469
470   /* First make sure that a new frame has been selected, in case the
471      command or the hooks changed the program state.  */
472   frame = deprecated_safe_get_selected_frame ();
473   if (current_language != expected_language)
474     {
475       if (language_mode == language_mode_auto && info_verbose)
476         {
477           language_info (1);    /* Print what changed.  */
478         }
479       warned = 0;
480     }
481
482   /* Warn the user if the working language does not match the language
483      of the current frame.  Only warn the user if we are actually
484      running the program, i.e. there is a stack.  */
485   /* FIXME: This should be cacheing the frame and only running when
486      the frame changes.  */
487
488   if (has_stack_frames ())
489     {
490       enum language flang;
491
492       flang = get_frame_language (frame);
493       if (!warned
494           && flang != language_unknown
495           && flang != current_language->la_language)
496         {
497           printf_filtered ("%s\n", lang_frame_mismatch_warn);
498           warned = 1;
499         }
500     }
501 }
502
503 /* See top.h.  */
504
505 void
506 wait_sync_command_done (void)
507 {
508   /* Processing events may change the current UI.  */
509   scoped_restore save_ui = make_scoped_restore (&current_ui);
510   struct ui *ui = current_ui;
511
512   while (gdb_do_one_event () >= 0)
513     if (ui->prompt_state != PROMPT_BLOCKED)
514       break;
515 }
516
517 /* See top.h.  */
518
519 void
520 maybe_wait_sync_command_done (int was_sync)
521 {
522   /* If the interpreter is in sync mode (we're running a user
523      command's list, running command hooks or similars), and we
524      just ran a synchronous command that started the target, wait
525      for that command to end.  */
526   if (!current_ui->async
527       && !was_sync
528       && current_ui->prompt_state == PROMPT_BLOCKED)
529     wait_sync_command_done ();
530 }
531
532 /* Execute the line P as a command, in the current user context.
533    Pass FROM_TTY as second argument to the defining function.  */
534
535 void
536 execute_command (char *p, int from_tty)
537 {
538   struct cleanup *cleanup_if_error, *cleanup;
539   struct cmd_list_element *c;
540   char *line;
541
542   cleanup_if_error = make_bpstat_clear_actions_cleanup ();
543   cleanup = prepare_execute_command ();
544
545   /* Force cleanup of any alloca areas if using C alloca instead of
546      a builtin alloca.  */
547   alloca (0);
548
549   /* This can happen when command_line_input hits end of file.  */
550   if (p == NULL)
551     {
552       do_cleanups (cleanup);
553       discard_cleanups (cleanup_if_error);
554       return;
555     }
556
557   target_log_command (p);
558
559   while (*p == ' ' || *p == '\t')
560     p++;
561   if (*p)
562     {
563       const char *cmd = p;
564       char *arg;
565       int was_sync = current_ui->prompt_state == PROMPT_BLOCKED;
566
567       line = p;
568
569       /* If trace-commands is set then this will print this command.  */
570       print_command_trace (p);
571
572       c = lookup_cmd (&cmd, cmdlist, "", 0, 1);
573       p = (char *) cmd;
574
575       /* Pass null arg rather than an empty one.  */
576       arg = *p ? p : 0;
577
578       /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
579          while the is_complete_command(cfunc) test is just plain
580          bogus.  They should both be replaced by a test of the form
581          c->strip_trailing_white_space_p.  */
582       /* NOTE: cagney/2002-02-02: The function.cfunc in the below
583          can't be replaced with func.  This is because it is the
584          cfunc, and not the func, that has the value that the
585          is_complete_command hack is testing for.  */
586       /* Clear off trailing whitespace, except for set and complete
587          command.  */
588       if (arg
589           && c->type != set_cmd
590           && !is_complete_command (c))
591         {
592           p = arg + strlen (arg) - 1;
593           while (p >= arg && (*p == ' ' || *p == '\t'))
594             p--;
595           *(p + 1) = '\0';
596         }
597
598       /* If this command has been pre-hooked, run the hook first.  */
599       execute_cmd_pre_hook (c);
600
601       if (c->deprecated_warn_user)
602         deprecated_cmd_warning (line);
603
604       /* c->user_commands would be NULL in the case of a python command.  */
605       if (c->theclass == class_user && c->user_commands)
606         execute_user_command (c, arg);
607       else if (c->type == set_cmd)
608         do_set_command (arg, from_tty, c);
609       else if (c->type == show_cmd)
610         do_show_command (arg, from_tty, c);
611       else if (!cmd_func_p (c))
612         error (_("That is not a command, just a help topic."));
613       else if (deprecated_call_command_hook)
614         deprecated_call_command_hook (c, arg, from_tty);
615       else
616         cmd_func (c, arg, from_tty);
617
618       maybe_wait_sync_command_done (was_sync);
619
620       /* If this command has been post-hooked, run the hook last.  */
621       execute_cmd_post_hook (c);
622
623     }
624
625   check_frame_language_change ();
626
627   do_cleanups (cleanup);
628   discard_cleanups (cleanup_if_error);
629 }
630
631 /* Run execute_command for P and FROM_TTY.  Capture its output into the
632    returned string, do not display it to the screen.  BATCH_FLAG will be
633    temporarily set to true.  */
634
635 std::string
636 execute_command_to_string (char *p, int from_tty)
637 {
638   /* GDB_STDOUT should be better already restored during these
639      restoration callbacks.  */
640   set_batch_flag_and_restore_page_info save_page_info;
641
642   scoped_restore save_async = make_scoped_restore (&current_ui->async, 0);
643
644   string_file str_file;
645
646   {
647     current_uiout->redirect (&str_file);
648     ui_out_redirect_pop redirect_popper (current_uiout);
649
650     scoped_restore save_stdout
651       = make_scoped_restore (&gdb_stdout, &str_file);
652     scoped_restore save_stderr
653       = make_scoped_restore (&gdb_stderr, &str_file);
654     scoped_restore save_stdlog
655       = make_scoped_restore (&gdb_stdlog, &str_file);
656     scoped_restore save_stdtarg
657       = make_scoped_restore (&gdb_stdtarg, &str_file);
658     scoped_restore save_stdtargerr
659       = make_scoped_restore (&gdb_stdtargerr, &str_file);
660
661     execute_command (p, from_tty);
662   }
663
664   return std::move (str_file.string ());
665 }
666
667 \f
668 /* When nonzero, cause dont_repeat to do nothing.  This should only be
669    set via prevent_dont_repeat.  */
670
671 static int suppress_dont_repeat = 0;
672
673 /* Commands call this if they do not want to be repeated by null lines.  */
674
675 void
676 dont_repeat (void)
677 {
678   struct ui *ui = current_ui;
679
680   if (suppress_dont_repeat || server_command)
681     return;
682
683   /* If we aren't reading from standard input, we are saving the last
684      thing read from stdin in line and don't want to delete it.  Null
685      lines won't repeat here in any case.  */
686   if (ui->instream == ui->stdin_stream)
687     *saved_command_line = 0;
688 }
689
690 /* Prevent dont_repeat from working, and return a cleanup that
691    restores the previous state.  */
692
693 scoped_restore_tmpl<int>
694 prevent_dont_repeat (void)
695 {
696   return make_scoped_restore (&suppress_dont_repeat, 1);
697 }
698
699 \f
700 /* Read a line from the stream "instream" without command line editing.
701
702    It prints PROMPT once at the start.
703    Action is compatible with "readline", e.g. space for the result is
704    malloc'd and should be freed by the caller.
705
706    A NULL return means end of file.  */
707
708 static char *
709 gdb_readline_no_editing (const char *prompt)
710 {
711   struct buffer line_buffer;
712   struct ui *ui = current_ui;
713   /* Read from stdin if we are executing a user defined command.  This
714      is the right thing for prompt_for_continue, at least.  */
715   FILE *stream = ui->instream != NULL ? ui->instream : stdin;
716   int fd = fileno (stream);
717
718   buffer_init (&line_buffer);
719
720   if (prompt != NULL)
721     {
722       /* Don't use a _filtered function here.  It causes the assumed
723          character position to be off, since the newline we read from
724          the user is not accounted for.  */
725       fputs_unfiltered (prompt, gdb_stdout);
726       gdb_flush (gdb_stdout);
727     }
728
729   while (1)
730     {
731       int c;
732       int numfds;
733       fd_set readfds;
734
735       QUIT;
736
737       /* Wait until at least one byte of data is available.  Control-C
738          can interrupt interruptible_select, but not fgetc.  */
739       FD_ZERO (&readfds);
740       FD_SET (fd, &readfds);
741       if (interruptible_select (fd + 1, &readfds, NULL, NULL, NULL) == -1)
742         {
743           if (errno == EINTR)
744             {
745               /* If this was ctrl-c, the QUIT above handles it.  */
746               continue;
747             }
748           perror_with_name (("select"));
749         }
750
751       c = fgetc (stream);
752
753       if (c == EOF)
754         {
755           if (line_buffer.used_size > 0)
756             /* The last line does not end with a newline.  Return it, and
757                if we are called again fgetc will still return EOF and
758                we'll return NULL then.  */
759             break;
760           xfree (buffer_finish (&line_buffer));
761           return NULL;
762         }
763
764       if (c == '\n')
765         {
766           if (line_buffer.used_size > 0
767               && line_buffer.buffer[line_buffer.used_size - 1] == '\r')
768             line_buffer.used_size--;
769           break;
770         }
771
772       buffer_grow_char (&line_buffer, c);
773     }
774
775   buffer_grow_char (&line_buffer, '\0');
776   return buffer_finish (&line_buffer);
777 }
778
779 /* Variables which control command line editing and history
780    substitution.  These variables are given default values at the end
781    of this file.  */
782 static int command_editing_p;
783
784 /* NOTE 1999-04-29: This variable will be static again, once we modify
785    gdb to use the event loop as the default command loop and we merge
786    event-top.c into this file, top.c.  */
787
788 /* static */ int history_expansion_p;
789
790 static int write_history_p;
791 static void
792 show_write_history_p (struct ui_file *file, int from_tty,
793                       struct cmd_list_element *c, const char *value)
794 {
795   fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
796                     value);
797 }
798
799 /* The variable associated with the "set/show history size"
800    command.  The value -1 means unlimited, and -2 means undefined.  */
801 static int history_size_setshow_var = -2;
802
803 static void
804 show_history_size (struct ui_file *file, int from_tty,
805                    struct cmd_list_element *c, const char *value)
806 {
807   fprintf_filtered (file, _("The size of the command history is %s.\n"),
808                     value);
809 }
810
811 /* Variable associated with the "history remove-duplicates" option.
812    The value -1 means unlimited.  */
813 static int history_remove_duplicates = 0;
814
815 static void
816 show_history_remove_duplicates (struct ui_file *file, int from_tty,
817                                 struct cmd_list_element *c, const char *value)
818 {
819   fprintf_filtered (file,
820                     _("The number of history entries to look back at for "
821                       "duplicates is %s.\n"),
822                     value);
823 }
824
825 static char *history_filename;
826 static void
827 show_history_filename (struct ui_file *file, int from_tty,
828                        struct cmd_list_element *c, const char *value)
829 {
830   fprintf_filtered (file, _("The filename in which to record "
831                             "the command history is \"%s\".\n"),
832                     value);
833 }
834
835 /* This is like readline(), but it has some gdb-specific behavior.
836    gdb may want readline in both the synchronous and async modes during
837    a single gdb invocation.  At the ordinary top-level prompt we might
838    be using the async readline.  That means we can't use
839    rl_pre_input_hook, since it doesn't work properly in async mode.
840    However, for a secondary prompt (" >", such as occurs during a
841    `define'), gdb wants a synchronous response.
842
843    We used to call readline() directly, running it in synchronous
844    mode.  But mixing modes this way is not supported, and as of
845    readline 5.x it no longer works; the arrow keys come unbound during
846    the synchronous call.  So we make a nested call into the event
847    loop.  That's what gdb_readline_wrapper is for.  */
848
849 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
850    rely on gdb_readline_wrapper_result, which might still be NULL if
851    the user types Control-D for EOF.  */
852 static int gdb_readline_wrapper_done;
853
854 /* The result of the current call to gdb_readline_wrapper, once a newline
855    is seen.  */
856 static char *gdb_readline_wrapper_result;
857
858 /* Any intercepted hook.  Operate-and-get-next sets this, expecting it
859    to be called after the newline is processed (which will redisplay
860    the prompt).  But in gdb_readline_wrapper we will not get a new
861    prompt until the next call, or until we return to the event loop.
862    So we disable this hook around the newline and restore it before we
863    return.  */
864 static void (*saved_after_char_processing_hook) (void);
865
866
867 /* See top.h.  */
868
869 int
870 gdb_in_secondary_prompt_p (struct ui *ui)
871 {
872   return ui->secondary_prompt_depth > 0;
873 }
874
875
876 /* This function is called when readline has seen a complete line of
877    text.  */
878
879 static void
880 gdb_readline_wrapper_line (char *line)
881 {
882   gdb_assert (!gdb_readline_wrapper_done);
883   gdb_readline_wrapper_result = line;
884   gdb_readline_wrapper_done = 1;
885
886   /* Prevent operate-and-get-next from acting too early.  */
887   saved_after_char_processing_hook = after_char_processing_hook;
888   after_char_processing_hook = NULL;
889
890   /* Prevent parts of the prompt from being redisplayed if annotations
891      are enabled, and readline's state getting out of sync.  We'll
892      reinstall the callback handler, which puts the terminal in raw
893      mode (or in readline lingo, in prepped state), when we're next
894      ready to process user input, either in display_gdb_prompt, or if
895      we're handling an asynchronous target event and running in the
896      background, just before returning to the event loop to process
897      further input (or more target events).  */
898   if (current_ui->command_editing)
899     gdb_rl_callback_handler_remove ();
900 }
901
902 struct gdb_readline_wrapper_cleanup
903   {
904     void (*handler_orig) (char *);
905     int already_prompted_orig;
906
907     /* Whether the target was async.  */
908     int target_is_async_orig;
909   };
910
911 static void
912 gdb_readline_wrapper_cleanup (void *arg)
913 {
914   struct ui *ui = current_ui;
915   struct gdb_readline_wrapper_cleanup *cleanup
916     = (struct gdb_readline_wrapper_cleanup *) arg;
917
918   if (ui->command_editing)
919     rl_already_prompted = cleanup->already_prompted_orig;
920
921   gdb_assert (ui->input_handler == gdb_readline_wrapper_line);
922   ui->input_handler = cleanup->handler_orig;
923
924   /* Don't restore our input handler in readline yet.  That would make
925      readline prep the terminal (putting it in raw mode), while the
926      line we just read may trigger execution of a command that expects
927      the terminal in the default cooked/canonical mode, such as e.g.,
928      running Python's interactive online help utility.  See
929      gdb_readline_wrapper_line for when we'll reinstall it.  */
930
931   gdb_readline_wrapper_result = NULL;
932   gdb_readline_wrapper_done = 0;
933   ui->secondary_prompt_depth--;
934   gdb_assert (ui->secondary_prompt_depth >= 0);
935
936   after_char_processing_hook = saved_after_char_processing_hook;
937   saved_after_char_processing_hook = NULL;
938
939   if (cleanup->target_is_async_orig)
940     target_async (1);
941
942   xfree (cleanup);
943 }
944
945 char *
946 gdb_readline_wrapper (const char *prompt)
947 {
948   struct ui *ui = current_ui;
949   struct cleanup *back_to;
950   struct gdb_readline_wrapper_cleanup *cleanup;
951   char *retval;
952
953   cleanup = XNEW (struct gdb_readline_wrapper_cleanup);
954   cleanup->handler_orig = ui->input_handler;
955   ui->input_handler = gdb_readline_wrapper_line;
956
957   if (ui->command_editing)
958     cleanup->already_prompted_orig = rl_already_prompted;
959   else
960     cleanup->already_prompted_orig = 0;
961
962   cleanup->target_is_async_orig = target_is_async_p ();
963
964   ui->secondary_prompt_depth++;
965   back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
966
967   /* Processing events may change the current UI.  */
968   scoped_restore save_ui = make_scoped_restore (&current_ui);
969
970   if (cleanup->target_is_async_orig)
971     target_async (0);
972
973   /* Display our prompt and prevent double prompt display.  Don't pass
974      down a NULL prompt, since that has special meaning for
975      display_gdb_prompt -- it indicates a request to print the primary
976      prompt, while we want a secondary prompt here.  */
977   display_gdb_prompt (prompt != NULL ? prompt : "");
978   if (ui->command_editing)
979     rl_already_prompted = 1;
980
981   if (after_char_processing_hook)
982     (*after_char_processing_hook) ();
983   gdb_assert (after_char_processing_hook == NULL);
984
985   while (gdb_do_one_event () >= 0)
986     if (gdb_readline_wrapper_done)
987       break;
988
989   retval = gdb_readline_wrapper_result;
990   do_cleanups (back_to);
991   return retval;
992 }
993
994 \f
995 /* The current saved history number from operate-and-get-next.
996    This is -1 if not valid.  */
997 static int operate_saved_history = -1;
998
999 /* This is put on the appropriate hook and helps operate-and-get-next
1000    do its work.  */
1001 static void
1002 gdb_rl_operate_and_get_next_completion (void)
1003 {
1004   int delta = where_history () - operate_saved_history;
1005
1006   /* The `key' argument to rl_get_previous_history is ignored.  */
1007   rl_get_previous_history (delta, 0);
1008   operate_saved_history = -1;
1009
1010   /* readline doesn't automatically update the display for us.  */
1011   rl_redisplay ();
1012
1013   after_char_processing_hook = NULL;
1014   rl_pre_input_hook = NULL;
1015 }
1016
1017 /* This is a gdb-local readline command handler.  It accepts the
1018    current command line (like RET does) and, if this command was taken
1019    from the history, arranges for the next command in the history to
1020    appear on the command line when the prompt returns.
1021    We ignore the arguments.  */
1022 static int
1023 gdb_rl_operate_and_get_next (int count, int key)
1024 {
1025   int where;
1026
1027   /* Use the async hook.  */
1028   after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
1029
1030   /* Find the current line, and find the next line to use.  */
1031   where = where_history();
1032
1033   if ((history_is_stifled () && (history_length >= history_max_entries))
1034       || (where >= history_length - 1))
1035     operate_saved_history = where;
1036   else
1037     operate_saved_history = where + 1;
1038
1039   return rl_newline (1, key);
1040 }
1041
1042 /* Number of user commands executed during this session.  */
1043
1044 static int command_count = 0;
1045
1046 /* Add the user command COMMAND to the input history list.  */
1047
1048 void
1049 gdb_add_history (const char *command)
1050 {
1051   command_count++;
1052
1053   if (history_remove_duplicates != 0)
1054     {
1055       int lookbehind;
1056       int lookbehind_threshold;
1057
1058       /* The lookbehind threshold for finding a duplicate history entry is
1059          bounded by command_count because we can't meaningfully delete
1060          history entries that are already stored in the history file since
1061          the history file is appended to.  */
1062       if (history_remove_duplicates == -1
1063           || history_remove_duplicates > command_count)
1064         lookbehind_threshold = command_count;
1065       else
1066         lookbehind_threshold = history_remove_duplicates;
1067
1068       using_history ();
1069       for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
1070         {
1071           HIST_ENTRY *temp = previous_history ();
1072
1073           if (temp == NULL)
1074             break;
1075
1076           if (strcmp (temp->line, command) == 0)
1077             {
1078               HIST_ENTRY *prev = remove_history (where_history ());
1079               command_count--;
1080               free_history_entry (prev);
1081               break;
1082             }
1083         }
1084       using_history ();
1085     }
1086
1087   add_history (command);
1088 }
1089
1090 /* Safely append new history entries to the history file in a corruption-free
1091    way using an intermediate local history file.  */
1092
1093 static void
1094 gdb_safe_append_history (void)
1095 {
1096   int ret, saved_errno;
1097   char *local_history_filename;
1098   struct cleanup *old_chain;
1099
1100   local_history_filename
1101     = xstrprintf ("%s-gdb%ld~", history_filename, (long) getpid ());
1102   old_chain = make_cleanup (xfree, local_history_filename);
1103
1104   ret = rename (history_filename, local_history_filename);
1105   saved_errno = errno;
1106   if (ret < 0 && saved_errno != ENOENT)
1107     {
1108       warning (_("Could not rename %s to %s: %s"),
1109                history_filename, local_history_filename,
1110                safe_strerror (saved_errno));
1111     }
1112   else
1113     {
1114       if (ret < 0)
1115         {
1116           /* If the rename failed with ENOENT then either the global history
1117              file never existed in the first place or another GDB process is
1118              currently appending to it (and has thus temporarily renamed it).
1119              Since we can't distinguish between these two cases, we have to
1120              conservatively assume the first case and therefore must write out
1121              (not append) our known history to our local history file and try
1122              to move it back anyway.  Otherwise a global history file would
1123              never get created!  */
1124            gdb_assert (saved_errno == ENOENT);
1125            write_history (local_history_filename);
1126         }
1127       else
1128         {
1129           append_history (command_count, local_history_filename);
1130           if (history_is_stifled ())
1131             history_truncate_file (local_history_filename, history_max_entries);
1132         }
1133
1134       ret = rename (local_history_filename, history_filename);
1135       saved_errno = errno;
1136       if (ret < 0 && saved_errno != EEXIST)
1137         warning (_("Could not rename %s to %s: %s"),
1138                  local_history_filename, history_filename,
1139                  safe_strerror (saved_errno));
1140     }
1141
1142   do_cleanups (old_chain);
1143 }
1144
1145 /* Read one line from the command input stream `instream' into a local
1146    static buffer.  The buffer is made bigger as necessary.  Returns
1147    the address of the start of the line.
1148
1149    NULL is returned for end of file.
1150
1151    *If* input is from an interactive stream (stdin), the line read is
1152    copied into the global 'saved_command_line' so that it can be
1153    repeated.
1154
1155    This routine either uses fancy command line editing or simple input
1156    as the user has requested.  */
1157
1158 char *
1159 command_line_input (const char *prompt_arg, int repeat,
1160                     const char *annotation_suffix)
1161 {
1162   static struct buffer cmd_line_buffer;
1163   static int cmd_line_buffer_initialized;
1164   struct ui *ui = current_ui;
1165   const char *prompt = prompt_arg;
1166   char *cmd;
1167   int from_tty = ui->instream == ui->stdin_stream;
1168
1169   /* The annotation suffix must be non-NULL.  */
1170   if (annotation_suffix == NULL)
1171     annotation_suffix = "";
1172
1173   if (from_tty && annotation_level > 1)
1174     {
1175       char *local_prompt;
1176
1177       local_prompt
1178         = (char *) alloca ((prompt == NULL ? 0 : strlen (prompt))
1179                            + strlen (annotation_suffix) + 40);
1180       if (prompt == NULL)
1181         local_prompt[0] = '\0';
1182       else
1183         strcpy (local_prompt, prompt);
1184       strcat (local_prompt, "\n\032\032");
1185       strcat (local_prompt, annotation_suffix);
1186       strcat (local_prompt, "\n");
1187
1188       prompt = local_prompt;
1189     }
1190
1191   if (!cmd_line_buffer_initialized)
1192     {
1193       buffer_init (&cmd_line_buffer);
1194       cmd_line_buffer_initialized = 1;
1195     }
1196
1197   /* Starting a new command line.  */
1198   cmd_line_buffer.used_size = 0;
1199
1200 #ifdef STOP_SIGNAL
1201   if (job_control)
1202     signal (STOP_SIGNAL, handle_stop_sig);
1203 #endif
1204
1205   while (1)
1206     {
1207       char *rl;
1208
1209       /* Make sure that all output has been output.  Some machines may
1210          let you get away with leaving out some of the gdb_flush, but
1211          not all.  */
1212       wrap_here ("");
1213       gdb_flush (gdb_stdout);
1214       gdb_flush (gdb_stderr);
1215
1216       if (source_file_name != NULL)
1217         ++source_line_number;
1218
1219       if (from_tty && annotation_level > 1)
1220         {
1221           puts_unfiltered ("\n\032\032pre-");
1222           puts_unfiltered (annotation_suffix);
1223           puts_unfiltered ("\n");
1224         }
1225
1226       /* Don't use fancy stuff if not talking to stdin.  */
1227       if (deprecated_readline_hook
1228           && from_tty
1229           && input_interactive_p (current_ui))
1230         {
1231           rl = (*deprecated_readline_hook) (prompt);
1232         }
1233       else if (command_editing_p
1234                && from_tty
1235                && input_interactive_p (current_ui))
1236         {
1237           rl = gdb_readline_wrapper (prompt);
1238         }
1239       else
1240         {
1241           rl = gdb_readline_no_editing (prompt);
1242         }
1243
1244       cmd = handle_line_of_input (&cmd_line_buffer, rl,
1245                                   repeat, annotation_suffix);
1246       if (cmd == (char *) EOF)
1247         {
1248           cmd = NULL;
1249           break;
1250         }
1251       if (cmd != NULL)
1252         break;
1253
1254       /* Got partial input.  I.e., got a line that ends with a
1255          continuation character (backslash).  Suppress printing the
1256          prompt again.  */
1257       prompt = NULL;
1258     }
1259
1260 #ifdef STOP_SIGNAL
1261   if (job_control)
1262     signal (STOP_SIGNAL, SIG_DFL);
1263 #endif
1264
1265   return cmd;
1266 }
1267 \f
1268 /* Print the GDB banner.  */
1269 void
1270 print_gdb_version (struct ui_file *stream)
1271 {
1272   /* From GNU coding standards, first line is meant to be easy for a
1273      program to parse, and is just canonical program name and version
1274      number, which starts after last space.  */
1275
1276   fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1277
1278   /* Second line is a copyright notice.  */
1279
1280   fprintf_filtered (stream,
1281                     "Copyright (C) 2017 Free Software Foundation, Inc.\n");
1282
1283   /* Following the copyright is a brief statement that the program is
1284      free software, that users are free to copy and change it on
1285      certain conditions, that it is covered by the GNU GPL, and that
1286      there is no warranty.  */
1287
1288   fprintf_filtered (stream, "\
1289 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1290 \nThis is free software: you are free to change and redistribute it.\n\
1291 There is NO WARRANTY, to the extent permitted by law.  Type \"show copying\"\n\
1292 and \"show warranty\" for details.\n");
1293
1294   /* After the required info we print the configuration information.  */
1295
1296   fprintf_filtered (stream, "This GDB was configured as \"");
1297   if (strcmp (host_name, target_name) != 0)
1298     {
1299       fprintf_filtered (stream, "--host=%s --target=%s",
1300                         host_name, target_name);
1301     }
1302   else
1303     {
1304       fprintf_filtered (stream, "%s", host_name);
1305     }
1306   fprintf_filtered (stream, "\".\n\
1307 Type \"show configuration\" for configuration details.");
1308
1309   if (REPORT_BUGS_TO[0])
1310     {
1311       fprintf_filtered (stream,
1312                         _("\nFor bug reporting instructions, please see:\n"));
1313       fprintf_filtered (stream, "%s.\n", REPORT_BUGS_TO);
1314     }
1315   fprintf_filtered (stream,
1316                     _("Find the GDB manual and other documentation \
1317 resources online at:\n<http://www.gnu.org/software/gdb/documentation/>.\n"));
1318   fprintf_filtered (stream, _("For help, type \"help\".\n"));
1319   fprintf_filtered (stream, _("Type \"apropos word\" to search for \
1320 commands related to \"word\"."));
1321 }
1322
1323 /* Print the details of GDB build-time configuration.  */
1324 void
1325 print_gdb_configuration (struct ui_file *stream)
1326 {
1327   fprintf_filtered (stream, _("\
1328 This GDB was configured as follows:\n\
1329    configure --host=%s --target=%s\n\
1330 "), host_name, target_name);
1331   fprintf_filtered (stream, _("\
1332              --with-auto-load-dir=%s\n\
1333              --with-auto-load-safe-path=%s\n\
1334 "), AUTO_LOAD_DIR, AUTO_LOAD_SAFE_PATH);
1335 #if HAVE_LIBEXPAT
1336   fprintf_filtered (stream, _("\
1337              --with-expat\n\
1338 "));
1339 #else
1340   fprintf_filtered (stream, _("\
1341              --without-expat\n\
1342 "));
1343 #endif
1344   if (GDB_DATADIR[0])
1345     fprintf_filtered (stream, _("\
1346              --with-gdb-datadir=%s%s\n\
1347 "), GDB_DATADIR, GDB_DATADIR_RELOCATABLE ? " (relocatable)" : "");
1348 #ifdef ICONV_BIN
1349   fprintf_filtered (stream, _("\
1350              --with-iconv-bin=%s%s\n\
1351 "), ICONV_BIN, ICONV_BIN_RELOCATABLE ? " (relocatable)" : "");
1352 #endif
1353   if (JIT_READER_DIR[0])
1354     fprintf_filtered (stream, _("\
1355              --with-jit-reader-dir=%s%s\n\
1356 "), JIT_READER_DIR, JIT_READER_DIR_RELOCATABLE ? " (relocatable)" : "");
1357 #if HAVE_LIBUNWIND_IA64_H
1358   fprintf_filtered (stream, _("\
1359              --with-libunwind-ia64\n\
1360 "));
1361 #else
1362   fprintf_filtered (stream, _("\
1363              --without-libunwind-ia64\n\
1364 "));
1365 #endif
1366 #if HAVE_LIBLZMA
1367   fprintf_filtered (stream, _("\
1368              --with-lzma\n\
1369 "));
1370 #else
1371   fprintf_filtered (stream, _("\
1372              --without-lzma\n\
1373 "));
1374 #endif
1375 #ifdef WITH_PYTHON_PATH
1376   fprintf_filtered (stream, _("\
1377              --with-python=%s%s\n\
1378 "), WITH_PYTHON_PATH, PYTHON_PATH_RELOCATABLE ? " (relocatable)" : "");
1379 #endif
1380 #if HAVE_GUILE
1381   fprintf_filtered (stream, _("\
1382              --with-guile\n\
1383 "));
1384 #else
1385   fprintf_filtered (stream, _("\
1386              --without-guile\n\
1387 "));
1388 #endif
1389 #ifdef RELOC_SRCDIR
1390   fprintf_filtered (stream, _("\
1391              --with-relocated-sources=%s\n\
1392 "), RELOC_SRCDIR);
1393 #endif
1394   if (DEBUGDIR[0])
1395     fprintf_filtered (stream, _("\
1396              --with-separate-debug-dir=%s%s\n\
1397 "), DEBUGDIR, DEBUGDIR_RELOCATABLE ? " (relocatable)" : "");
1398   if (TARGET_SYSTEM_ROOT[0])
1399     fprintf_filtered (stream, _("\
1400              --with-sysroot=%s%s\n\
1401 "), TARGET_SYSTEM_ROOT, TARGET_SYSTEM_ROOT_RELOCATABLE ? " (relocatable)" : "");
1402   if (SYSTEM_GDBINIT[0])
1403     fprintf_filtered (stream, _("\
1404              --with-system-gdbinit=%s%s\n\
1405 "), SYSTEM_GDBINIT, SYSTEM_GDBINIT_RELOCATABLE ? " (relocatable)" : "");
1406 #if HAVE_LIBBABELTRACE
1407     fprintf_filtered (stream, _("\
1408              --with-babeltrace\n\
1409 "));
1410 #else
1411     fprintf_filtered (stream, _("\
1412              --without-babeltrace\n\
1413 "));
1414 #endif
1415     /* We assume "relocatable" will be printed at least once, thus we always
1416        print this text.  It's a reasonably safe assumption for now.  */
1417     fprintf_filtered (stream, _("\n\
1418 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1419 tree, and GDB will still find it.)\n\
1420 "));
1421 }
1422 \f
1423
1424 /* The current top level prompt, settable with "set prompt", and/or
1425    with the python `gdb.prompt_hook' hook.  */
1426 static char *top_prompt;
1427
1428 /* Access method for the GDB prompt string.  */
1429
1430 char *
1431 get_prompt (void)
1432 {
1433   return top_prompt;
1434 }
1435
1436 /* Set method for the GDB prompt string.  */
1437
1438 void
1439 set_prompt (const char *s)
1440 {
1441   char *p = xstrdup (s);
1442
1443   xfree (top_prompt);
1444   top_prompt = p;
1445 }
1446 \f
1447
1448 struct qt_args
1449 {
1450   char *args;
1451   int from_tty;
1452 };
1453
1454 /* Callback for iterate_over_inferiors.  Kills or detaches the given
1455    inferior, depending on how we originally gained control of it.  */
1456
1457 static int
1458 kill_or_detach (struct inferior *inf, void *args)
1459 {
1460   struct qt_args *qt = (struct qt_args *) args;
1461   struct thread_info *thread;
1462
1463   if (inf->pid == 0)
1464     return 0;
1465
1466   thread = any_thread_of_process (inf->pid);
1467   if (thread != NULL)
1468     {
1469       switch_to_thread (thread->ptid);
1470
1471       /* Leave core files alone.  */
1472       if (target_has_execution)
1473         {
1474           if (inf->attach_flag)
1475             target_detach (qt->args, qt->from_tty);
1476           else
1477             target_kill ();
1478         }
1479     }
1480
1481   return 0;
1482 }
1483
1484 /* Callback for iterate_over_inferiors.  Prints info about what GDB
1485    will do to each inferior on a "quit".  ARG points to a struct
1486    ui_out where output is to be collected.  */
1487
1488 static int
1489 print_inferior_quit_action (struct inferior *inf, void *arg)
1490 {
1491   struct ui_file *stb = (struct ui_file *) arg;
1492
1493   if (inf->pid == 0)
1494     return 0;
1495
1496   if (inf->attach_flag)
1497     fprintf_filtered (stb,
1498                       _("\tInferior %d [%s] will be detached.\n"), inf->num,
1499                       target_pid_to_str (pid_to_ptid (inf->pid)));
1500   else
1501     fprintf_filtered (stb,
1502                       _("\tInferior %d [%s] will be killed.\n"), inf->num,
1503                       target_pid_to_str (pid_to_ptid (inf->pid)));
1504
1505   return 0;
1506 }
1507
1508 /* If necessary, make the user confirm that we should quit.  Return
1509    non-zero if we should quit, zero if we shouldn't.  */
1510
1511 int
1512 quit_confirm (void)
1513 {
1514   /* Don't even ask if we're only debugging a core file inferior.  */
1515   if (!have_live_inferiors ())
1516     return 1;
1517
1518   /* Build the query string as a single string.  */
1519   string_file stb;
1520
1521   stb.puts (_("A debugging session is active.\n\n"));
1522   iterate_over_inferiors (print_inferior_quit_action, &stb);
1523   stb.puts (_("\nQuit anyway? "));
1524
1525   return query ("%s", stb.c_str ());
1526 }
1527
1528 /* Prepare to exit GDB cleanly by undoing any changes made to the
1529    terminal so that we leave the terminal in the state we acquired it.  */
1530
1531 static void
1532 undo_terminal_modifications_before_exit (void)
1533 {
1534   struct ui *saved_top_level = current_ui;
1535
1536   target_terminal::ours ();
1537
1538   current_ui = main_ui;
1539
1540 #if defined(TUI)
1541   tui_disable ();
1542 #endif
1543   gdb_disable_readline ();
1544
1545   current_ui = saved_top_level;
1546 }
1547
1548
1549 /* Quit without asking for confirmation.  */
1550
1551 void
1552 quit_force (int *exit_arg, int from_tty)
1553 {
1554   int exit_code = 0;
1555   struct qt_args qt;
1556
1557   undo_terminal_modifications_before_exit ();
1558
1559   /* An optional expression may be used to cause gdb to terminate with the 
1560      value of that expression.  */
1561   if (exit_arg)
1562     exit_code = *exit_arg;
1563   else if (return_child_result)
1564     exit_code = return_child_result_value;
1565
1566   qt.args = NULL;
1567   qt.from_tty = from_tty;
1568
1569   /* We want to handle any quit errors and exit regardless.  */
1570
1571   /* Get out of tfind mode, and kill or detach all inferiors.  */
1572   TRY
1573     {
1574       disconnect_tracing ();
1575       iterate_over_inferiors (kill_or_detach, &qt);
1576     }
1577   CATCH (ex, RETURN_MASK_ALL)
1578     {
1579       exception_print (gdb_stderr, ex);
1580     }
1581   END_CATCH
1582
1583   /* Give all pushed targets a chance to do minimal cleanup, and pop
1584      them all out.  */
1585   TRY
1586     {
1587       pop_all_targets ();
1588     }
1589   CATCH (ex, RETURN_MASK_ALL)
1590     {
1591       exception_print (gdb_stderr, ex);
1592     }
1593   END_CATCH
1594
1595   /* Save the history information if it is appropriate to do so.  */
1596   TRY
1597     {
1598       if (write_history_p && history_filename)
1599         {
1600           struct ui *ui;
1601           int save = 0;
1602
1603           /* History is currently shared between all UIs.  If there's
1604              any UI with a terminal, save history.  */
1605           ALL_UIS (ui)
1606             {
1607               if (input_interactive_p (ui))
1608                 {
1609                   save = 1;
1610                   break;
1611                 }
1612             }
1613
1614           if (save)
1615             gdb_safe_append_history ();
1616         }
1617     }
1618   CATCH (ex, RETURN_MASK_ALL)
1619     {
1620       exception_print (gdb_stderr, ex);
1621     }
1622   END_CATCH
1623
1624   /* Do any final cleanups before exiting.  */
1625   TRY
1626     {
1627       do_final_cleanups (all_cleanups ());
1628     }
1629   CATCH (ex, RETURN_MASK_ALL)
1630     {
1631       exception_print (gdb_stderr, ex);
1632     }
1633   END_CATCH
1634
1635   exit (exit_code);
1636 }
1637
1638 /* The value of the "interactive-mode" setting.  */
1639 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
1640
1641 /* Implement the "show interactive-mode" option.  */
1642
1643 static void
1644 show_interactive_mode (struct ui_file *file, int from_tty,
1645                        struct cmd_list_element *c,
1646                        const char *value)
1647 {
1648   if (interactive_mode == AUTO_BOOLEAN_AUTO)
1649     fprintf_filtered (file, "Debugger's interactive mode "
1650                             "is %s (currently %s).\n",
1651                       value, input_interactive_p (current_ui) ? "on" : "off");
1652   else
1653     fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
1654 }
1655
1656 /* Returns whether GDB is running on an interactive terminal.  */
1657
1658 int
1659 input_interactive_p (struct ui *ui)
1660 {
1661   if (batch_flag)
1662     return 0;
1663
1664   if (interactive_mode != AUTO_BOOLEAN_AUTO)
1665     return interactive_mode == AUTO_BOOLEAN_TRUE;
1666
1667   return ui->input_interactive_p;
1668 }
1669 \f
1670 static void
1671 dont_repeat_command (char *ignored, int from_tty)
1672 {
1673   /* Can't call dont_repeat here because we're not necessarily reading
1674      from stdin.  */
1675   *saved_command_line = 0;
1676 }
1677 \f
1678 /* Functions to manipulate command line editing control variables.  */
1679
1680 /* Number of commands to print in each call to show_commands.  */
1681 #define Hist_print 10
1682 void
1683 show_commands (char *args, int from_tty)
1684 {
1685   /* Index for history commands.  Relative to history_base.  */
1686   int offset;
1687
1688   /* Number of the history entry which we are planning to display next.
1689      Relative to history_base.  */
1690   static int num = 0;
1691
1692   /* Print out some of the commands from the command history.  */
1693
1694   if (args)
1695     {
1696       if (args[0] == '+' && args[1] == '\0')
1697         /* "info editing +" should print from the stored position.  */
1698         ;
1699       else
1700         /* "info editing <exp>" should print around command number <exp>.  */
1701         num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1702     }
1703   /* "show commands" means print the last Hist_print commands.  */
1704   else
1705     {
1706       num = history_length - Hist_print;
1707     }
1708
1709   if (num < 0)
1710     num = 0;
1711
1712   /* If there are at least Hist_print commands, we want to display the last
1713      Hist_print rather than, say, the last 6.  */
1714   if (history_length - num < Hist_print)
1715     {
1716       num = history_length - Hist_print;
1717       if (num < 0)
1718         num = 0;
1719     }
1720
1721   for (offset = num;
1722        offset < num + Hist_print && offset < history_length;
1723        offset++)
1724     {
1725       printf_filtered ("%5d  %s\n", history_base + offset,
1726                        (history_get (history_base + offset))->line);
1727     }
1728
1729   /* The next command we want to display is the next one that we haven't
1730      displayed yet.  */
1731   num += Hist_print;
1732
1733   /* If the user repeats this command with return, it should do what
1734      "show commands +" does.  This is unnecessary if arg is null,
1735      because "show commands +" is not useful after "show commands".  */
1736   if (from_tty && args)
1737     {
1738       args[0] = '+';
1739       args[1] = '\0';
1740     }
1741 }
1742
1743 /* Update the size of our command history file to HISTORY_SIZE.
1744
1745    A HISTORY_SIZE of -1 stands for unlimited.  */
1746
1747 static void
1748 set_readline_history_size (int history_size)
1749 {
1750   gdb_assert (history_size >= -1);
1751
1752   if (history_size == -1)
1753     unstifle_history ();
1754   else
1755     stifle_history (history_size);
1756 }
1757
1758 /* Called by do_setshow_command.  */
1759 static void
1760 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1761 {
1762   set_readline_history_size (history_size_setshow_var);
1763 }
1764
1765 void
1766 set_history (char *args, int from_tty)
1767 {
1768   printf_unfiltered (_("\"set history\" must be followed "
1769                        "by the name of a history subcommand.\n"));
1770   help_list (sethistlist, "set history ", all_commands, gdb_stdout);
1771 }
1772
1773 void
1774 show_history (char *args, int from_tty)
1775 {
1776   cmd_show_list (showhistlist, from_tty, "");
1777 }
1778
1779 int info_verbose = 0;           /* Default verbose msgs off.  */
1780
1781 /* Called by do_setshow_command.  An elaborate joke.  */
1782 void
1783 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1784 {
1785   const char *cmdname = "verbose";
1786   struct cmd_list_element *showcmd;
1787
1788   showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1789   gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1790
1791   if (info_verbose)
1792     {
1793       c->doc = "Set verbose printing of informational messages.";
1794       showcmd->doc = "Show verbose printing of informational messages.";
1795     }
1796   else
1797     {
1798       c->doc = "Set verbosity.";
1799       showcmd->doc = "Show verbosity.";
1800     }
1801 }
1802
1803 /* Init the history buffer.  Note that we are called after the init file(s)
1804    have been read so that the user can change the history file via his
1805    .gdbinit file (for instance).  The GDBHISTFILE environment variable
1806    overrides all of this.  */
1807
1808 void
1809 init_history (void)
1810 {
1811   char *tmpenv;
1812
1813   tmpenv = getenv ("GDBHISTSIZE");
1814   if (tmpenv)
1815     {
1816       long var;
1817       int saved_errno;
1818       char *endptr;
1819
1820       tmpenv = skip_spaces (tmpenv);
1821       errno = 0;
1822       var = strtol (tmpenv, &endptr, 10);
1823       saved_errno = errno;
1824       endptr = skip_spaces (endptr);
1825
1826       /* If GDBHISTSIZE is non-numeric then ignore it.  If GDBHISTSIZE is the
1827          empty string, a negative number or a huge positive number (larger than
1828          INT_MAX) then set the history size to unlimited.  Otherwise set our
1829          history size to the number we have read.  This behavior is consistent
1830          with how bash handles HISTSIZE.  */
1831       if (*endptr != '\0')
1832         ;
1833       else if (*tmpenv == '\0'
1834                || var < 0
1835                || var > INT_MAX
1836                /* On targets where INT_MAX == LONG_MAX, we have to look at
1837                   errno after calling strtol to distinguish between a value that
1838                   is exactly INT_MAX and an overflowing value that was clamped
1839                   to INT_MAX.  */
1840                || (var == INT_MAX && saved_errno == ERANGE))
1841         history_size_setshow_var = -1;
1842       else
1843         history_size_setshow_var = var;
1844     }
1845
1846   /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1847      default.  */
1848   if (history_size_setshow_var == -2)
1849     history_size_setshow_var = 256;
1850
1851   set_readline_history_size (history_size_setshow_var);
1852
1853   tmpenv = getenv ("GDBHISTFILE");
1854   if (tmpenv)
1855     history_filename = xstrdup (tmpenv);
1856   else if (!history_filename)
1857     {
1858       /* We include the current directory so that if the user changes
1859          directories the file written will be the same as the one
1860          that was read.  */
1861 #ifdef __MSDOS__
1862       /* No leading dots in file names are allowed on MSDOS.  */
1863       history_filename = concat (current_directory, "/_gdb_history",
1864                                  (char *)NULL);
1865 #else
1866       history_filename = concat (current_directory, "/.gdb_history",
1867                                  (char *)NULL);
1868 #endif
1869     }
1870   read_history (history_filename);
1871 }
1872
1873 static void
1874 show_prompt (struct ui_file *file, int from_tty,
1875              struct cmd_list_element *c, const char *value)
1876 {
1877   fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1878 }
1879
1880 /* "set editing" command.  */
1881
1882 static void
1883 set_editing (char *args, int from_tty, struct cmd_list_element *c)
1884 {
1885   change_line_handler (set_editing_cmd_var);
1886   /* Update the control variable so that MI's =cmd-param-changed event
1887      shows the correct value. */
1888   set_editing_cmd_var = current_ui->command_editing;
1889 }
1890
1891 static void
1892 show_editing (struct ui_file *file, int from_tty,
1893               struct cmd_list_element *c, const char *value)
1894 {
1895   fprintf_filtered (file, _("Editing of command lines as "
1896                             "they are typed is %s.\n"),
1897                     current_ui->command_editing ? _("on") : _("off"));
1898 }
1899
1900 static void
1901 show_annotation_level (struct ui_file *file, int from_tty,
1902                        struct cmd_list_element *c, const char *value)
1903 {
1904   fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1905 }
1906
1907 static void
1908 show_exec_done_display_p (struct ui_file *file, int from_tty,
1909                           struct cmd_list_element *c, const char *value)
1910 {
1911   fprintf_filtered (file, _("Notification of completion for "
1912                             "asynchronous execution commands is %s.\n"),
1913                     value);
1914 }
1915
1916 /* New values of the "data-directory" parameter are staged here.  */
1917 static char *staged_gdb_datadir;
1918
1919 /* "set" command for the gdb_datadir configuration variable.  */
1920
1921 static void
1922 set_gdb_datadir (char *args, int from_tty, struct cmd_list_element *c)
1923 {
1924   set_gdb_data_directory (staged_gdb_datadir);
1925   observer_notify_gdb_datadir_changed ();
1926 }
1927
1928 /* "show" command for the gdb_datadir configuration variable.  */
1929
1930 static void
1931 show_gdb_datadir (struct ui_file *file, int from_tty,
1932                   struct cmd_list_element *c, const char *value)
1933 {
1934   fprintf_filtered (file, _("GDB's data directory is \"%s\".\n"),
1935                     gdb_datadir);
1936 }
1937
1938 static void
1939 set_history_filename (char *args, int from_tty, struct cmd_list_element *c)
1940 {
1941   /* We include the current directory so that if the user changes
1942      directories the file written will be the same as the one
1943      that was read.  */
1944   if (!IS_ABSOLUTE_PATH (history_filename))
1945     history_filename = reconcat (history_filename, current_directory, "/", 
1946                                  history_filename, (char *) NULL);
1947 }
1948
1949 static void
1950 init_main (void)
1951 {
1952   struct cmd_list_element *c;
1953
1954   /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1955      the DEFAULT_PROMPT is.  */
1956   set_prompt (DEFAULT_PROMPT);
1957
1958   /* Set the important stuff up for command editing.  */
1959   command_editing_p = 1;
1960   history_expansion_p = 0;
1961   write_history_p = 0;
1962
1963   /* Setup important stuff for command line editing.  */
1964   rl_completion_word_break_hook = gdb_completion_word_break_characters;
1965   rl_attempted_completion_function = gdb_rl_attempted_completion_function;
1966   set_rl_completer_word_break_characters (default_word_break_characters ());
1967   rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1968   rl_completion_display_matches_hook = cli_display_match_list;
1969   rl_readline_name = "gdb";
1970   rl_terminal_name = getenv ("TERM");
1971
1972   /* The name for this defun comes from Bash, where it originated.
1973      15 is Control-o, the same binding this function has in Bash.  */
1974   rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1975
1976   add_setshow_string_cmd ("prompt", class_support,
1977                           &top_prompt,
1978                           _("Set gdb's prompt"),
1979                           _("Show gdb's prompt"),
1980                           NULL, NULL,
1981                           show_prompt,
1982                           &setlist, &showlist);
1983
1984   add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1985 Don't repeat this command.\nPrimarily \
1986 used inside of user-defined commands that should not be repeated when\n\
1987 hitting return."));
1988
1989   add_setshow_boolean_cmd ("editing", class_support,
1990                            &set_editing_cmd_var, _("\
1991 Set editing of command lines as they are typed."), _("\
1992 Show editing of command lines as they are typed."), _("\
1993 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1994 Without an argument, command line editing is enabled.  To edit, use\n\
1995 EMACS-like or VI-like commands like control-P or ESC."),
1996                            set_editing,
1997                            show_editing,
1998                            &setlist, &showlist);
1999
2000   add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
2001 Set saving of the history record on exit."), _("\
2002 Show saving of the history record on exit."), _("\
2003 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2004 Without an argument, saving is enabled."),
2005                            NULL,
2006                            show_write_history_p,
2007                            &sethistlist, &showhistlist);
2008
2009   add_setshow_zuinteger_unlimited_cmd ("size", no_class,
2010                                        &history_size_setshow_var, _("\
2011 Set the size of the command history,"), _("\
2012 Show the size of the command history,"), _("\
2013 ie. the number of previous commands to keep a record of.\n\
2014 If set to \"unlimited\", the number of commands kept in the history\n\
2015 list is unlimited.  This defaults to the value of the environment\n\
2016 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2017                             set_history_size_command,
2018                             show_history_size,
2019                             &sethistlist, &showhistlist);
2020
2021   add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
2022                                        &history_remove_duplicates, _("\
2023 Set how far back in history to look for and remove duplicate entries."), _("\
2024 Show how far back in history to look for and remove duplicate entries."), _("\
2025 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2026 and remove the first history entry that is a duplicate of the most recent\n\
2027 entry, each time a new history entry is added.\n\
2028 If set to \"unlimited\", this lookbehind is unbounded.\n\
2029 Only history entries added during this session are considered for removal.\n\
2030 If set to 0, removal of duplicate history entries is disabled.\n\
2031 By default this option is set to 0."),
2032                            NULL,
2033                            show_history_remove_duplicates,
2034                            &sethistlist, &showhistlist);
2035
2036   add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
2037 Set the filename in which to record the command history"), _("\
2038 Show the filename in which to record the command history"), _("\
2039 (the list of previous commands of which a record is kept)."),
2040                             set_history_filename,
2041                             show_history_filename,
2042                             &sethistlist, &showhistlist);
2043
2044   add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
2045 Set whether to confirm potentially dangerous operations."), _("\
2046 Show whether to confirm potentially dangerous operations."), NULL,
2047                            NULL,
2048                            show_confirm,
2049                            &setlist, &showlist);
2050
2051   add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
2052 Set annotation_level."), _("\
2053 Show annotation_level."), _("\
2054 0 == normal;     1 == fullname (for use when running under emacs)\n\
2055 2 == output annotated suitably for use by programs that control GDB."),
2056                             NULL,
2057                             show_annotation_level,
2058                             &setlist, &showlist);
2059
2060   add_setshow_boolean_cmd ("exec-done-display", class_support,
2061                            &exec_done_display_p, _("\
2062 Set notification of completion for asynchronous execution commands."), _("\
2063 Show notification of completion for asynchronous execution commands."), _("\
2064 Use \"on\" to enable the notification, and \"off\" to disable it."),
2065                            NULL,
2066                            show_exec_done_display_p,
2067                            &setlist, &showlist);
2068
2069   add_setshow_filename_cmd ("data-directory", class_maintenance,
2070                            &staged_gdb_datadir, _("Set GDB's data directory."),
2071                            _("Show GDB's data directory."),
2072                            _("\
2073 When set, GDB uses the specified path to search for data files."),
2074                            set_gdb_datadir, show_gdb_datadir,
2075                            &setlist,
2076                            &showlist);
2077
2078   add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
2079                                 &interactive_mode, _("\
2080 Set whether GDB's standard input is a terminal."), _("\
2081 Show whether GDB's standard input is a terminal."), _("\
2082 If on, GDB assumes that standard input is a terminal.  In practice, it\n\
2083 means that GDB should wait for the user to answer queries associated to\n\
2084 commands entered at the command prompt.  If off, GDB assumes that standard\n\
2085 input is not a terminal, and uses the default answer to all queries.\n\
2086 If auto (the default), determine which mode to use based on the standard\n\
2087 input settings."),
2088                         NULL,
2089                         show_interactive_mode,
2090                         &setlist, &showlist);
2091
2092   c = add_cmd ("new-ui", class_support, new_ui_command, _("\
2093 Create a new UI.  It takes two arguments:\n\
2094 The first argument is the name of the interpreter to run.\n\
2095 The second argument is the terminal the UI runs on.\n"), &cmdlist);
2096   set_cmd_completer (c, interpreter_completer);
2097 }
2098
2099 void
2100 gdb_init (char *argv0)
2101 {
2102   if (pre_init_ui_hook)
2103     pre_init_ui_hook ();
2104
2105   /* Run the init function of each source file.  */
2106
2107 #ifdef __MSDOS__
2108   /* Make sure we return to the original directory upon exit, come
2109      what may, since the OS doesn't do that for us.  */
2110   make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
2111 #endif
2112
2113   init_cmd_lists ();        /* This needs to be done first.  */
2114   initialize_targets ();    /* Setup target_terminal macros for utils.c.  */
2115   initialize_utils ();      /* Make errors and warnings possible.  */
2116
2117   init_page_info ();
2118
2119   /* Here is where we call all the _initialize_foo routines.  */
2120   initialize_all_files ();
2121
2122   /* This creates the current_program_space.  Do this after all the
2123      _initialize_foo routines have had a chance to install their
2124      per-sspace data keys.  Also do this before
2125      initialize_current_architecture is called, because it accesses
2126      exec_bfd of the current program space.  */
2127   initialize_progspace ();
2128   initialize_inferiors ();
2129   initialize_current_architecture ();
2130   init_cli_cmds();
2131   init_main ();                 /* But that omits this file!  Do it now.  */
2132
2133   initialize_stdin_serial ();
2134
2135   /* Take a snapshot of our tty state before readline/ncurses have had a chance
2136      to alter it.  */
2137   set_initial_gdb_ttystate ();
2138
2139   async_init_signals ();
2140
2141   /* We need a default language for parsing expressions, so simple
2142      things like "set width 0" won't fail if no language is explicitly
2143      set in a config file or implicitly set by reading an executable
2144      during startup.  */
2145   set_language (language_c);
2146   expected_language = current_language; /* Don't warn about the change.  */
2147
2148   /* Python initialization, for example, can require various commands to be
2149      installed.  For example "info pretty-printer" needs the "info"
2150      prefix to be installed.  Keep things simple and just do final
2151      script initialization here.  */
2152   finish_ext_lang_initialization ();
2153 }