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