gdb: Move get_frame_language from stack.c to frame.c.
[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 /* This function is called when readline has seen a complete line of
758    text.  */
759
760 static void
761 gdb_readline_wrapper_line (char *line)
762 {
763   gdb_assert (!gdb_readline_wrapper_done);
764   gdb_readline_wrapper_result = line;
765   gdb_readline_wrapper_done = 1;
766
767   /* Prevent operate-and-get-next from acting too early.  */
768   saved_after_char_processing_hook = after_char_processing_hook;
769   after_char_processing_hook = NULL;
770
771   /* Prevent parts of the prompt from being redisplayed if annotations
772      are enabled, and readline's state getting out of sync.  We'll
773      reinstall the callback handler, which puts the terminal in raw
774      mode (or in readline lingo, in prepped state), when we're next
775      ready to process user input, either in display_gdb_prompt, or if
776      we're handling an asynchronous target event and running in the
777      background, just before returning to the event loop to process
778      further input (or more target events).  */
779   if (async_command_editing_p)
780     gdb_rl_callback_handler_remove ();
781 }
782
783 struct gdb_readline_wrapper_cleanup
784   {
785     void (*handler_orig) (char *);
786     int already_prompted_orig;
787
788     /* Whether the target was async.  */
789     int target_is_async_orig;
790   };
791
792 static void
793 gdb_readline_wrapper_cleanup (void *arg)
794 {
795   struct gdb_readline_wrapper_cleanup *cleanup = arg;
796
797   rl_already_prompted = cleanup->already_prompted_orig;
798
799   gdb_assert (input_handler == gdb_readline_wrapper_line);
800   input_handler = cleanup->handler_orig;
801
802   /* Don't restore our input handler in readline yet.  That would make
803      readline prep the terminal (putting it in raw mode), while the
804      line we just read may trigger execution of a command that expects
805      the terminal in the default cooked/canonical mode, such as e.g.,
806      running Python's interactive online help utility.  See
807      gdb_readline_wrapper_line for when we'll reinstall it.  */
808
809   gdb_readline_wrapper_result = NULL;
810   gdb_readline_wrapper_done = 0;
811
812   after_char_processing_hook = saved_after_char_processing_hook;
813   saved_after_char_processing_hook = NULL;
814
815   if (cleanup->target_is_async_orig)
816     target_async (1);
817
818   xfree (cleanup);
819 }
820
821 char *
822 gdb_readline_wrapper (const char *prompt)
823 {
824   struct cleanup *back_to;
825   struct gdb_readline_wrapper_cleanup *cleanup;
826   char *retval;
827
828   cleanup = xmalloc (sizeof (*cleanup));
829   cleanup->handler_orig = input_handler;
830   input_handler = gdb_readline_wrapper_line;
831
832   cleanup->already_prompted_orig = rl_already_prompted;
833
834   cleanup->target_is_async_orig = target_is_async_p ();
835
836   back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
837
838   if (cleanup->target_is_async_orig)
839     target_async (0);
840
841   /* Display our prompt and prevent double prompt display.  */
842   display_gdb_prompt (prompt);
843   rl_already_prompted = 1;
844
845   if (after_char_processing_hook)
846     (*after_char_processing_hook) ();
847   gdb_assert (after_char_processing_hook == NULL);
848
849   while (gdb_do_one_event () >= 0)
850     if (gdb_readline_wrapper_done)
851       break;
852
853   retval = gdb_readline_wrapper_result;
854   do_cleanups (back_to);
855   return retval;
856 }
857
858 \f
859 /* The current saved history number from operate-and-get-next.
860    This is -1 if not valid.  */
861 static int operate_saved_history = -1;
862
863 /* This is put on the appropriate hook and helps operate-and-get-next
864    do its work.  */
865 static void
866 gdb_rl_operate_and_get_next_completion (void)
867 {
868   int delta = where_history () - operate_saved_history;
869
870   /* The `key' argument to rl_get_previous_history is ignored.  */
871   rl_get_previous_history (delta, 0);
872   operate_saved_history = -1;
873
874   /* readline doesn't automatically update the display for us.  */
875   rl_redisplay ();
876
877   after_char_processing_hook = NULL;
878   rl_pre_input_hook = NULL;
879 }
880
881 /* This is a gdb-local readline command handler.  It accepts the
882    current command line (like RET does) and, if this command was taken
883    from the history, arranges for the next command in the history to
884    appear on the command line when the prompt returns.
885    We ignore the arguments.  */
886 static int
887 gdb_rl_operate_and_get_next (int count, int key)
888 {
889   int where;
890
891   /* Use the async hook.  */
892   after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
893
894   /* Find the current line, and find the next line to use.  */
895   where = where_history();
896
897   if ((history_is_stifled () && (history_length >= history_max_entries))
898       || (where >= history_length - 1))
899     operate_saved_history = where;
900   else
901     operate_saved_history = where + 1;
902
903   return rl_newline (1, key);
904 }
905
906 /* Number of user commands executed during this session.  */
907
908 static int command_count = 0;
909
910 /* Add the user command COMMAND to the input history list.  */
911
912 void
913 gdb_add_history (const char *command)
914 {
915   command_count++;
916
917   if (history_remove_duplicates != 0)
918     {
919       int lookbehind;
920       int lookbehind_threshold;
921
922       /* The lookbehind threshold for finding a duplicate history entry is
923          bounded by command_count because we can't meaningfully delete
924          history entries that are already stored in the history file since
925          the history file is appended to.  */
926       if (history_remove_duplicates == -1
927           || history_remove_duplicates > command_count)
928         lookbehind_threshold = command_count;
929       else
930         lookbehind_threshold = history_remove_duplicates;
931
932       using_history ();
933       for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
934         {
935           HIST_ENTRY *temp = previous_history ();
936
937           if (temp == NULL)
938             break;
939
940           if (strcmp (temp->line, command) == 0)
941             {
942               HIST_ENTRY *prev = remove_history (where_history ());
943               command_count--;
944               free_history_entry (prev);
945               break;
946             }
947         }
948       using_history ();
949     }
950
951   add_history (command);
952 }
953
954 /* Safely append new history entries to the history file in a corruption-free
955    way using an intermediate local history file.  */
956
957 static void
958 gdb_safe_append_history (void)
959 {
960   int ret, saved_errno;
961   char *local_history_filename;
962   struct cleanup *old_chain;
963
964   local_history_filename
965     = xstrprintf ("%s-gdb%d~", history_filename, getpid ());
966   old_chain = make_cleanup (xfree, local_history_filename);
967
968   ret = rename (history_filename, local_history_filename);
969   saved_errno = errno;
970   if (ret < 0 && saved_errno != ENOENT)
971     {
972       warning (_("Could not rename %s to %s: %s"),
973                history_filename, local_history_filename,
974                safe_strerror (saved_errno));
975     }
976   else
977     {
978       if (ret < 0)
979         {
980           /* If the rename failed with ENOENT then either the global history
981              file never existed in the first place or another GDB process is
982              currently appending to it (and has thus temporarily renamed it).
983              Since we can't distinguish between these two cases, we have to
984              conservatively assume the first case and therefore must write out
985              (not append) our known history to our local history file and try
986              to move it back anyway.  Otherwise a global history file would
987              never get created!  */
988            gdb_assert (saved_errno == ENOENT);
989            write_history (local_history_filename);
990         }
991       else
992         {
993           append_history (command_count, local_history_filename);
994           if (history_is_stifled ())
995             history_truncate_file (local_history_filename, history_max_entries);
996         }
997
998       ret = rename (local_history_filename, history_filename);
999       saved_errno = errno;
1000       if (ret < 0 && saved_errno != EEXIST)
1001         warning (_("Could not rename %s to %s: %s"),
1002                  local_history_filename, history_filename,
1003                  safe_strerror (saved_errno));
1004     }
1005
1006   do_cleanups (old_chain);
1007 }
1008
1009 /* Read one line from the command input stream `instream'
1010    into the local static buffer `linebuffer' (whose current length
1011    is `linelength').
1012    The buffer is made bigger as necessary.
1013    Returns the address of the start of the line.
1014
1015    NULL is returned for end of file.
1016
1017    *If* the instream == stdin & stdin is a terminal, the line read
1018    is copied into the file line saver (global var char *line,
1019    length linesize) so that it can be duplicated.
1020
1021    This routine either uses fancy command line editing or
1022    simple input as the user has requested.  */
1023
1024 char *
1025 command_line_input (const char *prompt_arg, int repeat, char *annotation_suffix)
1026 {
1027   static char *linebuffer = 0;
1028   static unsigned linelength = 0;
1029   const char *prompt = prompt_arg;
1030   char *p;
1031   char *p1;
1032   char *rl;
1033   char *nline;
1034   char got_eof = 0;
1035
1036   /* The annotation suffix must be non-NULL.  */
1037   if (annotation_suffix == NULL)
1038     annotation_suffix = "";
1039
1040   if (annotation_level > 1 && instream == stdin)
1041     {
1042       char *local_prompt;
1043
1044       local_prompt = alloca ((prompt == NULL ? 0 : strlen (prompt))
1045                              + strlen (annotation_suffix) + 40);
1046       if (prompt == NULL)
1047         local_prompt[0] = '\0';
1048       else
1049         strcpy (local_prompt, prompt);
1050       strcat (local_prompt, "\n\032\032");
1051       strcat (local_prompt, annotation_suffix);
1052       strcat (local_prompt, "\n");
1053
1054       prompt = local_prompt;
1055     }
1056
1057   if (linebuffer == 0)
1058     {
1059       linelength = 80;
1060       linebuffer = (char *) xmalloc (linelength);
1061     }
1062
1063   p = linebuffer;
1064
1065   /* Control-C quits instantly if typed while in this loop
1066      since it should not wait until the user types a newline.  */
1067   immediate_quit++;
1068   QUIT;
1069 #ifdef STOP_SIGNAL
1070   if (job_control)
1071     signal (STOP_SIGNAL, handle_stop_sig);
1072 #endif
1073
1074   while (1)
1075     {
1076       /* Make sure that all output has been output.  Some machines may
1077          let you get away with leaving out some of the gdb_flush, but
1078          not all.  */
1079       wrap_here ("");
1080       gdb_flush (gdb_stdout);
1081       gdb_flush (gdb_stderr);
1082
1083       if (source_file_name != NULL)
1084         ++source_line_number;
1085
1086       if (annotation_level > 1 && instream == stdin)
1087         {
1088           puts_unfiltered ("\n\032\032pre-");
1089           puts_unfiltered (annotation_suffix);
1090           puts_unfiltered ("\n");
1091         }
1092
1093       /* Don't use fancy stuff if not talking to stdin.  */
1094       if (deprecated_readline_hook && input_from_terminal_p ())
1095         {
1096           rl = (*deprecated_readline_hook) (prompt);
1097         }
1098       else if (command_editing_p && input_from_terminal_p ())
1099         {
1100           rl = gdb_readline_wrapper (prompt);
1101         }
1102       else
1103         {
1104           rl = gdb_readline (prompt);
1105         }
1106
1107       if (annotation_level > 1 && instream == stdin)
1108         {
1109           puts_unfiltered ("\n\032\032post-");
1110           puts_unfiltered (annotation_suffix);
1111           puts_unfiltered ("\n");
1112         }
1113
1114       if (!rl || rl == (char *) EOF)
1115         {
1116           got_eof = 1;
1117           break;
1118         }
1119       if (strlen (rl) + 1 + (p - linebuffer) > linelength)
1120         {
1121           linelength = strlen (rl) + 1 + (p - linebuffer);
1122           nline = (char *) xrealloc (linebuffer, linelength);
1123           p += nline - linebuffer;
1124           linebuffer = nline;
1125         }
1126       p1 = rl;
1127       /* Copy line.  Don't copy null at end.  (Leaves line alone
1128          if this was just a newline).  */
1129       while (*p1)
1130         *p++ = *p1++;
1131
1132       xfree (rl);               /* Allocated in readline.  */
1133
1134       if (p == linebuffer || *(p - 1) != '\\')
1135         break;
1136
1137       p--;                      /* Put on top of '\'.  */
1138       prompt = NULL;
1139     }
1140
1141 #ifdef STOP_SIGNAL
1142   if (job_control)
1143     signal (STOP_SIGNAL, SIG_DFL);
1144 #endif
1145   immediate_quit--;
1146
1147   if (got_eof)
1148     return NULL;
1149
1150 #define SERVER_COMMAND_LENGTH 7
1151   server_command =
1152     (p - linebuffer > SERVER_COMMAND_LENGTH)
1153     && strncmp (linebuffer, "server ", SERVER_COMMAND_LENGTH) == 0;
1154   if (server_command)
1155     {
1156       /* Note that we don't set `line'.  Between this and the check in
1157          dont_repeat, this insures that repeating will still do the
1158          right thing.  */
1159       *p = '\0';
1160       return linebuffer + SERVER_COMMAND_LENGTH;
1161     }
1162
1163   /* Do history expansion if that is wished.  */
1164   if (history_expansion_p && instream == stdin
1165       && ISATTY (instream))
1166     {
1167       char *history_value;
1168       int expanded;
1169
1170       *p = '\0';                /* Insert null now.  */
1171       expanded = history_expand (linebuffer, &history_value);
1172       if (expanded)
1173         {
1174           /* Print the changes.  */
1175           printf_unfiltered ("%s\n", history_value);
1176
1177           /* If there was an error, call this function again.  */
1178           if (expanded < 0)
1179             {
1180               xfree (history_value);
1181               return command_line_input (prompt, repeat,
1182                                          annotation_suffix);
1183             }
1184           if (strlen (history_value) > linelength)
1185             {
1186               linelength = strlen (history_value) + 1;
1187               linebuffer = (char *) xrealloc (linebuffer, linelength);
1188             }
1189           strcpy (linebuffer, history_value);
1190           p = linebuffer + strlen (linebuffer);
1191         }
1192       xfree (history_value);
1193     }
1194
1195   /* If we just got an empty line, and that is supposed to repeat the
1196      previous command, return the value in the global buffer.  */
1197   if (repeat && p == linebuffer)
1198     return saved_command_line;
1199   for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
1200   if (repeat && !*p1)
1201     return saved_command_line;
1202
1203   *p = 0;
1204
1205   /* Add line to history if appropriate.  */
1206   if (*linebuffer && input_from_terminal_p ())
1207     gdb_add_history (linebuffer);
1208
1209   /* Save into global buffer if appropriate.  */
1210   if (repeat)
1211     {
1212       if (linelength > saved_command_line_size)
1213         {
1214           saved_command_line = xrealloc (saved_command_line, linelength);
1215           saved_command_line_size = linelength;
1216         }
1217       strcpy (saved_command_line, linebuffer);
1218       return saved_command_line;
1219     }
1220
1221   return linebuffer;
1222 }
1223 \f
1224 /* Print the GDB banner.  */
1225 void
1226 print_gdb_version (struct ui_file *stream)
1227 {
1228   /* From GNU coding standards, first line is meant to be easy for a
1229      program to parse, and is just canonical program name and version
1230      number, which starts after last space.  */
1231
1232   fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1233
1234   /* Second line is a copyright notice.  */
1235
1236   fprintf_filtered (stream,
1237                     "Copyright (C) 2015 Free Software Foundation, Inc.\n");
1238
1239   /* Following the copyright is a brief statement that the program is
1240      free software, that users are free to copy and change it on
1241      certain conditions, that it is covered by the GNU GPL, and that
1242      there is no warranty.  */
1243
1244   fprintf_filtered (stream, "\
1245 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1246 \nThis is free software: you are free to change and redistribute it.\n\
1247 There is NO WARRANTY, to the extent permitted by law.  Type \"show copying\"\n\
1248 and \"show warranty\" for details.\n");
1249
1250   /* After the required info we print the configuration information.  */
1251
1252   fprintf_filtered (stream, "This GDB was configured as \"");
1253   if (strcmp (host_name, target_name) != 0)
1254     {
1255       fprintf_filtered (stream, "--host=%s --target=%s",
1256                         host_name, target_name);
1257     }
1258   else
1259     {
1260       fprintf_filtered (stream, "%s", host_name);
1261     }
1262   fprintf_filtered (stream, "\".\n\
1263 Type \"show configuration\" for configuration details.");
1264
1265   if (REPORT_BUGS_TO[0])
1266     {
1267       fprintf_filtered (stream,
1268                         _("\nFor bug reporting instructions, please see:\n"));
1269       fprintf_filtered (stream, "%s.\n", REPORT_BUGS_TO);
1270     }
1271   fprintf_filtered (stream,
1272                     _("Find the GDB manual and other documentation \
1273 resources online at:\n<http://www.gnu.org/software/gdb/documentation/>.\n"));
1274   fprintf_filtered (stream, _("For help, type \"help\".\n"));
1275   fprintf_filtered (stream, _("Type \"apropos word\" to search for \
1276 commands related to \"word\"."));
1277 }
1278
1279 /* Print the details of GDB build-time configuration.  */
1280 void
1281 print_gdb_configuration (struct ui_file *stream)
1282 {
1283   fprintf_filtered (stream, _("\
1284 This GDB was configured as follows:\n\
1285    configure --host=%s --target=%s\n\
1286 "), host_name, target_name);
1287   fprintf_filtered (stream, _("\
1288              --with-auto-load-dir=%s\n\
1289              --with-auto-load-safe-path=%s\n\
1290 "), AUTO_LOAD_DIR, AUTO_LOAD_SAFE_PATH);
1291 #if HAVE_LIBEXPAT
1292   fprintf_filtered (stream, _("\
1293              --with-expat\n\
1294 "));
1295 #else
1296   fprintf_filtered (stream, _("\
1297              --without-expat\n\
1298 "));
1299 #endif
1300   if (GDB_DATADIR[0])
1301     fprintf_filtered (stream, _("\
1302              --with-gdb-datadir=%s%s\n\
1303 "), GDB_DATADIR, GDB_DATADIR_RELOCATABLE ? " (relocatable)" : "");
1304 #ifdef ICONV_BIN
1305   fprintf_filtered (stream, _("\
1306              --with-iconv-bin=%s%s\n\
1307 "), ICONV_BIN, ICONV_BIN_RELOCATABLE ? " (relocatable)" : "");
1308 #endif
1309   if (JIT_READER_DIR[0])
1310     fprintf_filtered (stream, _("\
1311              --with-jit-reader-dir=%s%s\n\
1312 "), JIT_READER_DIR, JIT_READER_DIR_RELOCATABLE ? " (relocatable)" : "");
1313 #if HAVE_LIBUNWIND_IA64_H
1314   fprintf_filtered (stream, _("\
1315              --with-libunwind-ia64\n\
1316 "));
1317 #else
1318   fprintf_filtered (stream, _("\
1319              --without-libunwind-ia64\n\
1320 "));
1321 #endif
1322 #if HAVE_LIBLZMA
1323   fprintf_filtered (stream, _("\
1324              --with-lzma\n\
1325 "));
1326 #else
1327   fprintf_filtered (stream, _("\
1328              --without-lzma\n\
1329 "));
1330 #endif
1331 #ifdef WITH_PYTHON_PATH
1332   fprintf_filtered (stream, _("\
1333              --with-python=%s%s\n\
1334 "), WITH_PYTHON_PATH, PYTHON_PATH_RELOCATABLE ? " (relocatable)" : "");
1335 #endif
1336 #if HAVE_GUILE
1337   fprintf_filtered (stream, _("\
1338              --with-guile\n\
1339 "));
1340 #else
1341   fprintf_filtered (stream, _("\
1342              --without-guile\n\
1343 "));
1344 #endif
1345 #ifdef RELOC_SRCDIR
1346   fprintf_filtered (stream, _("\
1347              --with-relocated-sources=%s\n\
1348 "), RELOC_SRCDIR);
1349 #endif
1350   if (DEBUGDIR[0])
1351     fprintf_filtered (stream, _("\
1352              --with-separate-debug-dir=%s%s\n\
1353 "), DEBUGDIR, DEBUGDIR_RELOCATABLE ? " (relocatable)" : "");
1354   if (TARGET_SYSTEM_ROOT[0])
1355     fprintf_filtered (stream, _("\
1356              --with-sysroot=%s%s\n\
1357 "), TARGET_SYSTEM_ROOT, TARGET_SYSTEM_ROOT_RELOCATABLE ? " (relocatable)" : "");
1358   if (SYSTEM_GDBINIT[0])
1359     fprintf_filtered (stream, _("\
1360              --with-system-gdbinit=%s%s\n\
1361 "), SYSTEM_GDBINIT, SYSTEM_GDBINIT_RELOCATABLE ? " (relocatable)" : "");
1362 #if HAVE_LIBBABELTRACE
1363     fprintf_filtered (stream, _("\
1364              --with-babeltrace\n\
1365 "));
1366 #else
1367     fprintf_filtered (stream, _("\
1368              --without-babeltrace\n\
1369 "));
1370 #endif
1371     /* We assume "relocatable" will be printed at least once, thus we always
1372        print this text.  It's a reasonably safe assumption for now.  */
1373     fprintf_filtered (stream, _("\n\
1374 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1375 tree, and GDB will still find it.)\n\
1376 "));
1377 }
1378 \f
1379
1380 /* The current top level prompt, settable with "set prompt", and/or
1381    with the python `gdb.prompt_hook' hook.  */
1382 static char *top_prompt;
1383
1384 /* Access method for the GDB prompt string.  */
1385
1386 char *
1387 get_prompt (void)
1388 {
1389   return top_prompt;
1390 }
1391
1392 /* Set method for the GDB prompt string.  */
1393
1394 void
1395 set_prompt (const char *s)
1396 {
1397   char *p = xstrdup (s);
1398
1399   xfree (top_prompt);
1400   top_prompt = p;
1401 }
1402 \f
1403
1404 struct qt_args
1405 {
1406   char *args;
1407   int from_tty;
1408 };
1409
1410 /* Callback for iterate_over_inferiors.  Kills or detaches the given
1411    inferior, depending on how we originally gained control of it.  */
1412
1413 static int
1414 kill_or_detach (struct inferior *inf, void *args)
1415 {
1416   struct qt_args *qt = args;
1417   struct thread_info *thread;
1418
1419   if (inf->pid == 0)
1420     return 0;
1421
1422   thread = any_thread_of_process (inf->pid);
1423   if (thread != NULL)
1424     {
1425       switch_to_thread (thread->ptid);
1426
1427       /* Leave core files alone.  */
1428       if (target_has_execution)
1429         {
1430           if (inf->attach_flag)
1431             target_detach (qt->args, qt->from_tty);
1432           else
1433             target_kill ();
1434         }
1435     }
1436
1437   return 0;
1438 }
1439
1440 /* Callback for iterate_over_inferiors.  Prints info about what GDB
1441    will do to each inferior on a "quit".  ARG points to a struct
1442    ui_out where output is to be collected.  */
1443
1444 static int
1445 print_inferior_quit_action (struct inferior *inf, void *arg)
1446 {
1447   struct ui_file *stb = arg;
1448
1449   if (inf->pid == 0)
1450     return 0;
1451
1452   if (inf->attach_flag)
1453     fprintf_filtered (stb,
1454                       _("\tInferior %d [%s] will be detached.\n"), inf->num,
1455                       target_pid_to_str (pid_to_ptid (inf->pid)));
1456   else
1457     fprintf_filtered (stb,
1458                       _("\tInferior %d [%s] will be killed.\n"), inf->num,
1459                       target_pid_to_str (pid_to_ptid (inf->pid)));
1460
1461   return 0;
1462 }
1463
1464 /* If necessary, make the user confirm that we should quit.  Return
1465    non-zero if we should quit, zero if we shouldn't.  */
1466
1467 int
1468 quit_confirm (void)
1469 {
1470   struct ui_file *stb;
1471   struct cleanup *old_chain;
1472   char *str;
1473   int qr;
1474
1475   /* Don't even ask if we're only debugging a core file inferior.  */
1476   if (!have_live_inferiors ())
1477     return 1;
1478
1479   /* Build the query string as a single string.  */
1480   stb = mem_fileopen ();
1481   old_chain = make_cleanup_ui_file_delete (stb);
1482
1483   fprintf_filtered (stb, _("A debugging session is active.\n\n"));
1484   iterate_over_inferiors (print_inferior_quit_action, stb);
1485   fprintf_filtered (stb, _("\nQuit anyway? "));
1486
1487   str = ui_file_xstrdup (stb, NULL);
1488   make_cleanup (xfree, str);
1489
1490   qr = query ("%s", str);
1491   do_cleanups (old_chain);
1492   return qr;
1493 }
1494
1495 /* Prepare to exit GDB cleanly by undoing any changes made to the
1496    terminal so that we leave the terminal in the state we acquired it.  */
1497
1498 static void
1499 undo_terminal_modifications_before_exit (void)
1500 {
1501   target_terminal_ours ();
1502 #if defined(TUI)
1503   tui_disable ();
1504 #endif
1505   if (async_command_editing_p)
1506     gdb_disable_readline ();
1507 }
1508
1509
1510 /* Quit without asking for confirmation.  */
1511
1512 void
1513 quit_force (char *args, int from_tty)
1514 {
1515   int exit_code = 0;
1516   struct qt_args qt;
1517
1518   undo_terminal_modifications_before_exit ();
1519
1520   /* An optional expression may be used to cause gdb to terminate with the 
1521      value of that expression.  */
1522   if (args)
1523     {
1524       struct value *val = parse_and_eval (args);
1525
1526       exit_code = (int) value_as_long (val);
1527     }
1528   else if (return_child_result)
1529     exit_code = return_child_result_value;
1530
1531   qt.args = args;
1532   qt.from_tty = from_tty;
1533
1534   /* We want to handle any quit errors and exit regardless.  */
1535
1536   /* Get out of tfind mode, and kill or detach all inferiors.  */
1537   TRY
1538     {
1539       disconnect_tracing ();
1540       iterate_over_inferiors (kill_or_detach, &qt);
1541     }
1542   CATCH (ex, RETURN_MASK_ALL)
1543     {
1544       exception_print (gdb_stderr, ex);
1545     }
1546   END_CATCH
1547
1548   /* Give all pushed targets a chance to do minimal cleanup, and pop
1549      them all out.  */
1550   TRY
1551     {
1552       pop_all_targets ();
1553     }
1554   CATCH (ex, RETURN_MASK_ALL)
1555     {
1556       exception_print (gdb_stderr, ex);
1557     }
1558   END_CATCH
1559
1560   /* Save the history information if it is appropriate to do so.  */
1561   TRY
1562     {
1563       if (write_history_p && history_filename
1564           && input_from_terminal_p ())
1565         gdb_safe_append_history ();
1566     }
1567   CATCH (ex, RETURN_MASK_ALL)
1568     {
1569       exception_print (gdb_stderr, ex);
1570     }
1571   END_CATCH
1572
1573   /* Do any final cleanups before exiting.  */
1574   TRY
1575     {
1576       do_final_cleanups (all_cleanups ());
1577     }
1578   CATCH (ex, RETURN_MASK_ALL)
1579     {
1580       exception_print (gdb_stderr, ex);
1581     }
1582   END_CATCH
1583
1584   exit (exit_code);
1585 }
1586
1587 /* Returns whether GDB is running on a terminal and input is
1588    currently coming from that terminal.  */
1589
1590 int
1591 input_from_terminal_p (void)
1592 {
1593   if (batch_flag)
1594     return 0;
1595
1596   if (gdb_has_a_terminal () && instream == stdin)
1597     return 1;
1598
1599   /* If INSTREAM is unset, and we are not in a user command, we
1600      must be in Insight.  That's like having a terminal, for our
1601      purposes.  */
1602   if (instream == NULL && !in_user_command)
1603     return 1;
1604
1605   return 0;
1606 }
1607 \f
1608 static void
1609 dont_repeat_command (char *ignored, int from_tty)
1610 {
1611   /* Can't call dont_repeat here because we're not necessarily reading
1612      from stdin.  */
1613   *saved_command_line = 0;
1614 }
1615 \f
1616 /* Functions to manipulate command line editing control variables.  */
1617
1618 /* Number of commands to print in each call to show_commands.  */
1619 #define Hist_print 10
1620 void
1621 show_commands (char *args, int from_tty)
1622 {
1623   /* Index for history commands.  Relative to history_base.  */
1624   int offset;
1625
1626   /* Number of the history entry which we are planning to display next.
1627      Relative to history_base.  */
1628   static int num = 0;
1629
1630   /* Print out some of the commands from the command history.  */
1631
1632   if (args)
1633     {
1634       if (args[0] == '+' && args[1] == '\0')
1635         /* "info editing +" should print from the stored position.  */
1636         ;
1637       else
1638         /* "info editing <exp>" should print around command number <exp>.  */
1639         num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1640     }
1641   /* "show commands" means print the last Hist_print commands.  */
1642   else
1643     {
1644       num = history_length - Hist_print;
1645     }
1646
1647   if (num < 0)
1648     num = 0;
1649
1650   /* If there are at least Hist_print commands, we want to display the last
1651      Hist_print rather than, say, the last 6.  */
1652   if (history_length - num < Hist_print)
1653     {
1654       num = history_length - Hist_print;
1655       if (num < 0)
1656         num = 0;
1657     }
1658
1659   for (offset = num;
1660        offset < num + Hist_print && offset < history_length;
1661        offset++)
1662     {
1663       printf_filtered ("%5d  %s\n", history_base + offset,
1664                        (history_get (history_base + offset))->line);
1665     }
1666
1667   /* The next command we want to display is the next one that we haven't
1668      displayed yet.  */
1669   num += Hist_print;
1670
1671   /* If the user repeats this command with return, it should do what
1672      "show commands +" does.  This is unnecessary if arg is null,
1673      because "show commands +" is not useful after "show commands".  */
1674   if (from_tty && args)
1675     {
1676       args[0] = '+';
1677       args[1] = '\0';
1678     }
1679 }
1680
1681 /* Update the size of our command history file to HISTORY_SIZE.
1682
1683    A HISTORY_SIZE of -1 stands for unlimited.  */
1684
1685 static void
1686 set_readline_history_size (int history_size)
1687 {
1688   gdb_assert (history_size >= -1);
1689
1690   if (history_size == -1)
1691     unstifle_history ();
1692   else
1693     stifle_history (history_size);
1694 }
1695
1696 /* Called by do_setshow_command.  */
1697 static void
1698 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1699 {
1700   set_readline_history_size (history_size_setshow_var);
1701 }
1702
1703 void
1704 set_history (char *args, int from_tty)
1705 {
1706   printf_unfiltered (_("\"set history\" must be followed "
1707                        "by the name of a history subcommand.\n"));
1708   help_list (sethistlist, "set history ", all_commands, gdb_stdout);
1709 }
1710
1711 void
1712 show_history (char *args, int from_tty)
1713 {
1714   cmd_show_list (showhistlist, from_tty, "");
1715 }
1716
1717 int info_verbose = 0;           /* Default verbose msgs off.  */
1718
1719 /* Called by do_setshow_command.  An elaborate joke.  */
1720 void
1721 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1722 {
1723   const char *cmdname = "verbose";
1724   struct cmd_list_element *showcmd;
1725
1726   showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1727   gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1728
1729   if (info_verbose)
1730     {
1731       c->doc = "Set verbose printing of informational messages.";
1732       showcmd->doc = "Show verbose printing of informational messages.";
1733     }
1734   else
1735     {
1736       c->doc = "Set verbosity.";
1737       showcmd->doc = "Show verbosity.";
1738     }
1739 }
1740
1741 /* Init the history buffer.  Note that we are called after the init file(s)
1742    have been read so that the user can change the history file via his
1743    .gdbinit file (for instance).  The GDBHISTFILE environment variable
1744    overrides all of this.  */
1745
1746 void
1747 init_history (void)
1748 {
1749   char *tmpenv;
1750
1751   tmpenv = getenv ("GDBHISTSIZE");
1752   if (tmpenv)
1753     {
1754       long var;
1755       int saved_errno;
1756       char *endptr;
1757
1758       tmpenv = skip_spaces (tmpenv);
1759       errno = 0;
1760       var = strtol (tmpenv, &endptr, 10);
1761       saved_errno = errno;
1762       endptr = skip_spaces (endptr);
1763
1764       /* If GDBHISTSIZE is non-numeric then ignore it.  If GDBHISTSIZE is the
1765          empty string, a negative number or a huge positive number (larger than
1766          INT_MAX) then set the history size to unlimited.  Otherwise set our
1767          history size to the number we have read.  This behavior is consistent
1768          with how bash handles HISTSIZE.  */
1769       if (*endptr != '\0')
1770         ;
1771       else if (*tmpenv == '\0'
1772                || var < 0
1773                || var > INT_MAX
1774                /* On targets where INT_MAX == LONG_MAX, we have to look at
1775                   errno after calling strtol to distinguish between a value that
1776                   is exactly INT_MAX and an overflowing value that was clamped
1777                   to INT_MAX.  */
1778                || (var == INT_MAX && saved_errno == ERANGE))
1779         history_size_setshow_var = -1;
1780       else
1781         history_size_setshow_var = var;
1782     }
1783
1784   /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1785      default.  */
1786   if (history_size_setshow_var == -2)
1787     history_size_setshow_var = 256;
1788
1789   set_readline_history_size (history_size_setshow_var);
1790
1791   tmpenv = getenv ("GDBHISTFILE");
1792   if (tmpenv)
1793     history_filename = xstrdup (tmpenv);
1794   else if (!history_filename)
1795     {
1796       /* We include the current directory so that if the user changes
1797          directories the file written will be the same as the one
1798          that was read.  */
1799 #ifdef __MSDOS__
1800       /* No leading dots in file names are allowed on MSDOS.  */
1801       history_filename = concat (current_directory, "/_gdb_history",
1802                                  (char *)NULL);
1803 #else
1804       history_filename = concat (current_directory, "/.gdb_history",
1805                                  (char *)NULL);
1806 #endif
1807     }
1808   read_history (history_filename);
1809 }
1810
1811 static void
1812 show_prompt (struct ui_file *file, int from_tty,
1813              struct cmd_list_element *c, const char *value)
1814 {
1815   fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1816 }
1817
1818 static void
1819 show_async_command_editing_p (struct ui_file *file, int from_tty,
1820                               struct cmd_list_element *c, const char *value)
1821 {
1822   fprintf_filtered (file, _("Editing of command lines as "
1823                             "they are typed is %s.\n"),
1824                     value);
1825 }
1826
1827 static void
1828 show_annotation_level (struct ui_file *file, int from_tty,
1829                        struct cmd_list_element *c, const char *value)
1830 {
1831   fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1832 }
1833
1834 static void
1835 show_exec_done_display_p (struct ui_file *file, int from_tty,
1836                           struct cmd_list_element *c, const char *value)
1837 {
1838   fprintf_filtered (file, _("Notification of completion for "
1839                             "asynchronous execution commands is %s.\n"),
1840                     value);
1841 }
1842
1843 /* New values of the "data-directory" parameter are staged here.  */
1844 static char *staged_gdb_datadir;
1845
1846 /* "set" command for the gdb_datadir configuration variable.  */
1847
1848 static void
1849 set_gdb_datadir (char *args, int from_tty, struct cmd_list_element *c)
1850 {
1851   set_gdb_data_directory (staged_gdb_datadir);
1852   observer_notify_gdb_datadir_changed ();
1853 }
1854
1855 /* "show" command for the gdb_datadir configuration variable.  */
1856
1857 static void
1858 show_gdb_datadir (struct ui_file *file, int from_tty,
1859                   struct cmd_list_element *c, const char *value)
1860 {
1861   fprintf_filtered (file, _("GDB's data directory is \"%s\".\n"),
1862                     gdb_datadir);
1863 }
1864
1865 static void
1866 set_history_filename (char *args, int from_tty, struct cmd_list_element *c)
1867 {
1868   /* We include the current directory so that if the user changes
1869      directories the file written will be the same as the one
1870      that was read.  */
1871   if (!IS_ABSOLUTE_PATH (history_filename))
1872     history_filename = reconcat (history_filename, current_directory, "/", 
1873                                  history_filename, (char *) NULL);
1874 }
1875
1876 static void
1877 init_main (void)
1878 {
1879   /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1880      the DEFAULT_PROMPT is.  */
1881   set_prompt (DEFAULT_PROMPT);
1882
1883   /* Set things up for annotation_level > 1, if the user ever decides
1884      to use it.  */
1885   async_annotation_suffix = "prompt";
1886
1887   /* Set the important stuff up for command editing.  */
1888   command_editing_p = 1;
1889   history_expansion_p = 0;
1890   write_history_p = 0;
1891
1892   /* Setup important stuff for command line editing.  */
1893   rl_completion_word_break_hook = gdb_completion_word_break_characters;
1894   rl_completion_entry_function = readline_line_completion_function;
1895   rl_completer_word_break_characters = default_word_break_characters ();
1896   rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1897   rl_completion_display_matches_hook = cli_display_match_list;
1898   rl_readline_name = "gdb";
1899   rl_terminal_name = getenv ("TERM");
1900
1901   /* The name for this defun comes from Bash, where it originated.
1902      15 is Control-o, the same binding this function has in Bash.  */
1903   rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1904
1905   add_setshow_string_cmd ("prompt", class_support,
1906                           &top_prompt,
1907                           _("Set gdb's prompt"),
1908                           _("Show gdb's prompt"),
1909                           NULL, NULL,
1910                           show_prompt,
1911                           &setlist, &showlist);
1912
1913   add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1914 Don't repeat this command.\nPrimarily \
1915 used inside of user-defined commands that should not be repeated when\n\
1916 hitting return."));
1917
1918   add_setshow_boolean_cmd ("editing", class_support,
1919                            &async_command_editing_p, _("\
1920 Set editing of command lines as they are typed."), _("\
1921 Show editing of command lines as they are typed."), _("\
1922 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1923 Without an argument, command line editing is enabled.  To edit, use\n\
1924 EMACS-like or VI-like commands like control-P or ESC."),
1925                            set_async_editing_command,
1926                            show_async_command_editing_p,
1927                            &setlist, &showlist);
1928
1929   add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
1930 Set saving of the history record on exit."), _("\
1931 Show saving of the history record on exit."), _("\
1932 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1933 Without an argument, saving is enabled."),
1934                            NULL,
1935                            show_write_history_p,
1936                            &sethistlist, &showhistlist);
1937
1938   add_setshow_zuinteger_unlimited_cmd ("size", no_class,
1939                                        &history_size_setshow_var, _("\
1940 Set the size of the command history,"), _("\
1941 Show the size of the command history,"), _("\
1942 ie. the number of previous commands to keep a record of.\n\
1943 If set to \"unlimited\", the number of commands kept in the history\n\
1944 list is unlimited.  This defaults to the value of the environment\n\
1945 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
1946                             set_history_size_command,
1947                             show_history_size,
1948                             &sethistlist, &showhistlist);
1949
1950   add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
1951                                        &history_remove_duplicates, _("\
1952 Set how far back in history to look for and remove duplicate entries."), _("\
1953 Show how far back in history to look for and remove duplicate entries."), _("\
1954 If set to a nonzero value N, GDB will look back at the last N history entries\n\
1955 and remove the first history entry that is a duplicate of the most recent\n\
1956 entry, each time a new history entry is added.\n\
1957 If set to \"unlimited\", this lookbehind is unbounded.\n\
1958 Only history entries added during this session are considered for removal.\n\
1959 If set to 0, removal of duplicate history entries is disabled.\n\
1960 By default this option is set to 0."),
1961                            NULL,
1962                            show_history_remove_duplicates,
1963                            &sethistlist, &showhistlist);
1964
1965   add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
1966 Set the filename in which to record the command history"), _("\
1967 Show the filename in which to record the command history"), _("\
1968 (the list of previous commands of which a record is kept)."),
1969                             set_history_filename,
1970                             show_history_filename,
1971                             &sethistlist, &showhistlist);
1972
1973   add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
1974 Set whether to confirm potentially dangerous operations."), _("\
1975 Show whether to confirm potentially dangerous operations."), NULL,
1976                            NULL,
1977                            show_confirm,
1978                            &setlist, &showlist);
1979
1980   add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
1981 Set annotation_level."), _("\
1982 Show annotation_level."), _("\
1983 0 == normal;     1 == fullname (for use when running under emacs)\n\
1984 2 == output annotated suitably for use by programs that control GDB."),
1985                             NULL,
1986                             show_annotation_level,
1987                             &setlist, &showlist);
1988
1989   add_setshow_boolean_cmd ("exec-done-display", class_support,
1990                            &exec_done_display_p, _("\
1991 Set notification of completion for asynchronous execution commands."), _("\
1992 Show notification of completion for asynchronous execution commands."), _("\
1993 Use \"on\" to enable the notification, and \"off\" to disable it."),
1994                            NULL,
1995                            show_exec_done_display_p,
1996                            &setlist, &showlist);
1997
1998   add_setshow_filename_cmd ("data-directory", class_maintenance,
1999                            &staged_gdb_datadir, _("Set GDB's data directory."),
2000                            _("Show GDB's data directory."),
2001                            _("\
2002 When set, GDB uses the specified path to search for data files."),
2003                            set_gdb_datadir, show_gdb_datadir,
2004                            &setlist,
2005                            &showlist);
2006 }
2007
2008 void
2009 gdb_init (char *argv0)
2010 {
2011   if (pre_init_ui_hook)
2012     pre_init_ui_hook ();
2013
2014   /* Run the init function of each source file.  */
2015
2016 #ifdef __MSDOS__
2017   /* Make sure we return to the original directory upon exit, come
2018      what may, since the OS doesn't do that for us.  */
2019   make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
2020 #endif
2021
2022   init_cmd_lists ();        /* This needs to be done first.  */
2023   initialize_targets ();    /* Setup target_terminal macros for utils.c.  */
2024   initialize_utils ();      /* Make errors and warnings possible.  */
2025
2026   init_page_info ();
2027
2028   /* Here is where we call all the _initialize_foo routines.  */
2029   initialize_all_files ();
2030
2031   /* This creates the current_program_space.  Do this after all the
2032      _initialize_foo routines have had a chance to install their
2033      per-sspace data keys.  Also do this before
2034      initialize_current_architecture is called, because it accesses
2035      exec_bfd of the current program space.  */
2036   initialize_progspace ();
2037   initialize_inferiors ();
2038   initialize_current_architecture ();
2039   init_cli_cmds();
2040   init_main ();                 /* But that omits this file!  Do it now.  */
2041
2042   initialize_stdin_serial ();
2043
2044   /* Take a snapshot of our tty state before readline/ncurses have had a chance
2045      to alter it.  */
2046   set_initial_gdb_ttystate ();
2047
2048   async_init_signals ();
2049
2050   /* We need a default language for parsing expressions, so simple
2051      things like "set width 0" won't fail if no language is explicitly
2052      set in a config file or implicitly set by reading an executable
2053      during startup.  */
2054   set_language (language_c);
2055   expected_language = current_language; /* Don't warn about the change.  */
2056
2057   /* Python initialization, for example, can require various commands to be
2058      installed.  For example "info pretty-printer" needs the "info"
2059      prefix to be installed.  Keep things simple and just do final
2060      script initialization here.  */
2061   finish_ext_lang_initialization ();
2062 }