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