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