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