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