Make the interpreters 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 /* stdio stream that command input is being read from.  Set to stdin
127    normally.  Set by source_command to the file we are sourcing.  Set
128    to NULL if we are executing a user-defined command or interacting
129    via a GUI.  */
130
131 FILE *instream;
132
133 /* Flag to indicate whether a user defined command is currently running.  */
134
135 int in_user_command;
136
137 /* Current working directory.  */
138
139 char *current_directory;
140
141 /* The directory name is actually stored here (usually).  */
142 char gdb_dirbuf[1024];
143
144 /* The last command line executed on the console.  Used for command
145    repetitions.  */
146 char *saved_command_line;
147
148 /* Nonzero if the current command is modified by "server ".  This
149    affects things like recording into the command history, commands
150    repeating on RETURN, etc.  This is so a user interface (emacs, GUI,
151    whatever) can issue its own commands and also send along commands
152    from the user, and have the user not notice that the user interface
153    is issuing commands too.  */
154 int server_command;
155
156 /* Timeout limit for response from target.  */
157
158 /* The default value has been changed many times over the years.  It 
159    was originally 5 seconds.  But that was thought to be a long time 
160    to sit and wait, so it was changed to 2 seconds.  That was thought
161    to be plenty unless the connection was going through some terminal 
162    server or multiplexer or other form of hairy serial connection.
163
164    In mid-1996, remote_timeout was moved from remote.c to top.c and 
165    it began being used in other remote-* targets.  It appears that the
166    default was changed to 20 seconds at that time, perhaps because the
167    Renesas E7000 ICE didn't always respond in a timely manner.
168
169    But if 5 seconds is a long time to sit and wait for retransmissions,
170    20 seconds is far worse.  This demonstrates the difficulty of using 
171    a single variable for all protocol timeouts.
172
173    As remote.c is used much more than remote-e7000.c, it was changed 
174    back to 2 seconds in 1999.  */
175
176 int remote_timeout = 2;
177
178 /* Non-zero tells remote* modules to output debugging info.  */
179
180 int remote_debug = 0;
181
182 /* Sbrk location on entry to main.  Used for statistics only.  */
183 #ifdef HAVE_SBRK
184 char *lim_at_start;
185 #endif
186
187 /* Hooks for alternate command interfaces.  */
188
189 /* This hook is called from within gdb's many mini-event loops which
190    could steal control from a real user interface's event loop.  It
191    returns non-zero if the user is requesting a detach, zero
192    otherwise.  */
193
194 int (*deprecated_ui_loop_hook) (int);
195
196
197 /* Called from print_frame_info to list the line we stopped in.  */
198
199 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s, 
200                                                   int line,
201                                                   int stopline, 
202                                                   int noerror);
203 /* Replaces most of query.  */
204
205 int (*deprecated_query_hook) (const char *, va_list);
206
207 /* Replaces most of warning.  */
208
209 void (*deprecated_warning_hook) (const char *, va_list);
210
211 /* These three functions support getting lines of text from the user.
212    They are used in sequence.  First deprecated_readline_begin_hook is
213    called with a text string that might be (for example) a message for
214    the user to type in a sequence of commands to be executed at a
215    breakpoint.  If this function calls back to a GUI, it might take
216    this opportunity to pop up a text interaction window with this
217    message.  Next, deprecated_readline_hook is called with a prompt
218    that is emitted prior to collecting the user input.  It can be
219    called multiple times.  Finally, deprecated_readline_end_hook is
220    called to notify the GUI that we are done with the interaction
221    window and it can close it.  */
222
223 void (*deprecated_readline_begin_hook) (char *, ...);
224 char *(*deprecated_readline_hook) (const char *);
225 void (*deprecated_readline_end_hook) (void);
226
227 /* Called as appropriate to notify the interface that we have attached
228    to or detached from an already running process.  */
229
230 void (*deprecated_attach_hook) (void);
231 void (*deprecated_detach_hook) (void);
232
233 /* Called during long calculations to allow GUI to repair window
234    damage, and to check for stop buttons, etc...  */
235
236 void (*deprecated_interactive_hook) (void);
237
238 /* Called when going to wait for the target.  Usually allows the GUI
239    to run while waiting for target events.  */
240
241 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
242                                        struct target_waitstatus *status,
243                                        int options);
244
245 /* Used by UI as a wrapper around command execution.  May do various
246    things like enabling/disabling buttons, etc...  */
247
248 void (*deprecated_call_command_hook) (struct cmd_list_element * c, 
249                                       char *cmd, int from_tty);
250
251 /* Called when the current thread changes.  Argument is thread id.  */
252
253 void (*deprecated_context_hook) (int id);
254
255 /* Handler for SIGHUP.  */
256
257 #ifdef SIGHUP
258 /* NOTE 1999-04-29: This function will be static again, once we modify
259    gdb to use the event loop as the default command loop and we merge
260    event-top.c into this file, top.c.  */
261 /* static */ void
262 quit_cover (void)
263 {
264   /* Stop asking user for confirmation --- we're exiting.  This
265      prevents asking the user dumb questions.  */
266   confirm = 0;
267   quit_command ((char *) 0, 0);
268 }
269 #endif /* defined SIGHUP */
270 \f
271 /* Line number we are currently in, in a file which is being sourced.  */
272 /* NOTE 1999-04-29: This variable will be static again, once we modify
273    gdb to use the event loop as the default command loop and we merge
274    event-top.c into this file, top.c.  */
275 /* static */ int source_line_number;
276
277 /* Name of the file we are sourcing.  */
278 /* NOTE 1999-04-29: This variable will be static again, once we modify
279    gdb to use the event loop as the default command loop and we merge
280    event-top.c into this file, top.c.  */
281 /* static */ const char *source_file_name;
282
283 /* Clean up on error during a "source" command (or execution of a
284    user-defined command).  */
285
286 void
287 do_restore_instream_cleanup (void *stream)
288 {
289   /* Restore the previous input stream.  */
290   instream = (FILE *) stream;
291 }
292
293 /* Read commands from STREAM.  */
294 void
295 read_command_file (FILE *stream)
296 {
297   struct cleanup *cleanups;
298
299   cleanups = make_cleanup (do_restore_instream_cleanup, instream);
300   instream = stream;
301
302   /* Read commands from `instream' and execute them until end of file
303      or error reading instream.  */
304
305   while (instream != NULL && !feof (instream))
306     {
307       char *command;
308
309       /* Get a command-line.  This calls the readline package.  */
310       command = command_line_input (NULL, 0, NULL);
311       if (command == NULL)
312         break;
313       command_handler (command);
314     }
315
316   do_cleanups (cleanups);
317 }
318 \f
319 void (*pre_init_ui_hook) (void);
320
321 #ifdef __MSDOS__
322 static void
323 do_chdir_cleanup (void *old_dir)
324 {
325   chdir (old_dir);
326   xfree (old_dir);
327 }
328 #endif
329
330 struct cleanup *
331 prepare_execute_command (void)
332 {
333   struct value *mark;
334   struct cleanup *cleanup;
335
336   mark = value_mark ();
337   cleanup = make_cleanup_value_free_to_mark (mark);
338
339   /* With multiple threads running while the one we're examining is
340      stopped, the dcache can get stale without us being able to detect
341      it.  For the duration of the command, though, use the dcache to
342      help things like backtrace.  */
343   if (non_stop)
344     target_dcache_invalidate ();
345
346   return cleanup;
347 }
348
349 /* Tell the user if the language has changed (except first time) after
350    executing a command.  */
351
352 void
353 check_frame_language_change (void)
354 {
355   static int warned = 0;
356   struct frame_info *frame;
357
358   /* First make sure that a new frame has been selected, in case the
359      command or the hooks changed the program state.  */
360   frame = deprecated_safe_get_selected_frame ();
361   if (current_language != expected_language)
362     {
363       if (language_mode == language_mode_auto && info_verbose)
364         {
365           language_info (1);    /* Print what changed.  */
366         }
367       warned = 0;
368     }
369
370   /* Warn the user if the working language does not match the language
371      of the current frame.  Only warn the user if we are actually
372      running the program, i.e. there is a stack.  */
373   /* FIXME: This should be cacheing the frame and only running when
374      the frame changes.  */
375
376   if (has_stack_frames ())
377     {
378       enum language flang;
379
380       flang = get_frame_language (frame);
381       if (!warned
382           && flang != language_unknown
383           && flang != current_language->la_language)
384         {
385           printf_filtered ("%s\n", lang_frame_mismatch_warn);
386           warned = 1;
387         }
388     }
389 }
390
391 /* See top.h.  */
392
393 void
394 wait_sync_command_done (void)
395 {
396   while (gdb_do_one_event () >= 0)
397     if (!sync_execution)
398       break;
399 }
400
401 /* See top.h.  */
402
403 void
404 maybe_wait_sync_command_done (int was_sync)
405 {
406   /* If the interpreter is in sync mode (we're running a user
407      command's list, running command hooks or similars), and we
408      just ran a synchronous command that started the target, wait
409      for that command to end.  */
410   if (!current_ui->async && !was_sync && sync_execution)
411     wait_sync_command_done ();
412 }
413
414 /* Execute the line P as a command, in the current user context.
415    Pass FROM_TTY as second argument to the defining function.  */
416
417 void
418 execute_command (char *p, int from_tty)
419 {
420   struct cleanup *cleanup_if_error, *cleanup;
421   struct cmd_list_element *c;
422   char *line;
423
424   cleanup_if_error = make_bpstat_clear_actions_cleanup ();
425   cleanup = prepare_execute_command ();
426
427   /* Force cleanup of any alloca areas if using C alloca instead of
428      a builtin alloca.  */
429   alloca (0);
430
431   /* This can happen when command_line_input hits end of file.  */
432   if (p == NULL)
433     {
434       do_cleanups (cleanup);
435       discard_cleanups (cleanup_if_error);
436       return;
437     }
438
439   target_log_command (p);
440
441   while (*p == ' ' || *p == '\t')
442     p++;
443   if (*p)
444     {
445       const char *cmd = p;
446       char *arg;
447       int was_sync = sync_execution;
448
449       line = p;
450
451       /* If trace-commands is set then this will print this command.  */
452       print_command_trace (p);
453
454       c = lookup_cmd (&cmd, cmdlist, "", 0, 1);
455       p = (char *) cmd;
456
457       /* Pass null arg rather than an empty one.  */
458       arg = *p ? p : 0;
459
460       /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
461          while the is_complete_command(cfunc) test is just plain
462          bogus.  They should both be replaced by a test of the form
463          c->strip_trailing_white_space_p.  */
464       /* NOTE: cagney/2002-02-02: The function.cfunc in the below
465          can't be replaced with func.  This is because it is the
466          cfunc, and not the func, that has the value that the
467          is_complete_command hack is testing for.  */
468       /* Clear off trailing whitespace, except for set and complete
469          command.  */
470       if (arg
471           && c->type != set_cmd
472           && !is_complete_command (c))
473         {
474           p = arg + strlen (arg) - 1;
475           while (p >= arg && (*p == ' ' || *p == '\t'))
476             p--;
477           *(p + 1) = '\0';
478         }
479
480       /* If this command has been pre-hooked, run the hook first.  */
481       execute_cmd_pre_hook (c);
482
483       if (c->deprecated_warn_user)
484         deprecated_cmd_warning (line);
485
486       /* c->user_commands would be NULL in the case of a python command.  */
487       if (c->theclass == class_user && c->user_commands)
488         execute_user_command (c, arg);
489       else if (c->type == set_cmd)
490         do_set_command (arg, from_tty, c);
491       else if (c->type == show_cmd)
492         do_show_command (arg, from_tty, c);
493       else if (!cmd_func_p (c))
494         error (_("That is not a command, just a help topic."));
495       else if (deprecated_call_command_hook)
496         deprecated_call_command_hook (c, arg, from_tty);
497       else
498         cmd_func (c, arg, from_tty);
499
500       maybe_wait_sync_command_done (was_sync);
501
502       /* If this command has been post-hooked, run the hook last.  */
503       execute_cmd_post_hook (c);
504
505     }
506
507   check_frame_language_change ();
508
509   do_cleanups (cleanup);
510   discard_cleanups (cleanup_if_error);
511 }
512
513 /* Run execute_command for P and FROM_TTY.  Capture its output into the
514    returned string, do not display it to the screen.  BATCH_FLAG will be
515    temporarily set to true.  */
516
517 char *
518 execute_command_to_string (char *p, int from_tty)
519 {
520   struct ui_file *str_file;
521   struct cleanup *cleanup;
522   char *retval;
523
524   /* GDB_STDOUT should be better already restored during these
525      restoration callbacks.  */
526   cleanup = set_batch_flag_and_make_cleanup_restore_page_info ();
527
528   make_cleanup_restore_integer (&current_ui->async);
529   current_ui->async = 0;
530
531   str_file = mem_fileopen ();
532
533   make_cleanup_ui_file_delete (str_file);
534   make_cleanup_restore_ui_file (&gdb_stdout);
535   make_cleanup_restore_ui_file (&gdb_stderr);
536   make_cleanup_restore_ui_file (&gdb_stdlog);
537   make_cleanup_restore_ui_file (&gdb_stdtarg);
538   make_cleanup_restore_ui_file (&gdb_stdtargerr);
539
540   if (ui_out_redirect (current_uiout, str_file) < 0)
541     warning (_("Current output protocol does not support redirection"));
542   else
543     make_cleanup_ui_out_redirect_pop (current_uiout);
544
545   gdb_stdout = str_file;
546   gdb_stderr = str_file;
547   gdb_stdlog = str_file;
548   gdb_stdtarg = str_file;
549   gdb_stdtargerr = str_file;
550
551   execute_command (p, from_tty);
552
553   retval = ui_file_xstrdup (str_file, NULL);
554
555   do_cleanups (cleanup);
556
557   return retval;
558 }
559
560 \f
561 /* When nonzero, cause dont_repeat to do nothing.  This should only be
562    set via prevent_dont_repeat.  */
563
564 static int suppress_dont_repeat = 0;
565
566 /* Commands call this if they do not want to be repeated by null lines.  */
567
568 void
569 dont_repeat (void)
570 {
571   if (suppress_dont_repeat || server_command)
572     return;
573
574   /* If we aren't reading from standard input, we are saving the last
575      thing read from stdin in line and don't want to delete it.  Null
576      lines won't repeat here in any case.  */
577   if (instream == stdin)
578     *saved_command_line = 0;
579 }
580
581 /* Prevent dont_repeat from working, and return a cleanup that
582    restores the previous state.  */
583
584 struct cleanup *
585 prevent_dont_repeat (void)
586 {
587   struct cleanup *result = make_cleanup_restore_integer (&suppress_dont_repeat);
588
589   suppress_dont_repeat = 1;
590   return result;
591 }
592
593 \f
594 /* Read a line from the stream "instream" without command line editing.
595
596    It prints PROMPT once at the start.
597    Action is compatible with "readline", e.g. space for the result is
598    malloc'd and should be freed by the caller.
599
600    A NULL return means end of file.  */
601
602 static char *
603 gdb_readline_no_editing (const char *prompt)
604 {
605   struct buffer line_buffer;
606   /* Read from stdin if we are executing a user defined command.  This
607      is the right thing for prompt_for_continue, at least.  */
608   FILE *stream = instream != NULL ? instream : stdin;
609   int fd = fileno (stream);
610
611   buffer_init (&line_buffer);
612
613   if (prompt != NULL)
614     {
615       /* Don't use a _filtered function here.  It causes the assumed
616          character position to be off, since the newline we read from
617          the user is not accounted for.  */
618       fputs_unfiltered (prompt, gdb_stdout);
619       gdb_flush (gdb_stdout);
620     }
621
622   while (1)
623     {
624       int c;
625       int numfds;
626       fd_set readfds;
627
628       QUIT;
629
630       /* Wait until at least one byte of data is available.  Control-C
631          can interrupt interruptible_select, but not fgetc.  */
632       FD_ZERO (&readfds);
633       FD_SET (fd, &readfds);
634       if (interruptible_select (fd + 1, &readfds, NULL, NULL, NULL) == -1)
635         {
636           if (errno == EINTR)
637             {
638               /* If this was ctrl-c, the QUIT above handles it.  */
639               continue;
640             }
641           perror_with_name (("select"));
642         }
643
644       c = fgetc (stream);
645
646       if (c == EOF)
647         {
648           if (line_buffer.used_size > 0)
649             /* The last line does not end with a newline.  Return it, and
650                if we are called again fgetc will still return EOF and
651                we'll return NULL then.  */
652             break;
653           xfree (buffer_finish (&line_buffer));
654           return NULL;
655         }
656
657       if (c == '\n')
658         {
659           if (line_buffer.used_size > 0
660               && line_buffer.buffer[line_buffer.used_size - 1] == '\r')
661             line_buffer.used_size--;
662           break;
663         }
664
665       buffer_grow_char (&line_buffer, c);
666     }
667
668   buffer_grow_char (&line_buffer, '\0');
669   return buffer_finish (&line_buffer);
670 }
671
672 /* Variables which control command line editing and history
673    substitution.  These variables are given default values at the end
674    of this file.  */
675 static int command_editing_p;
676
677 /* NOTE 1999-04-29: This variable will be static again, once we modify
678    gdb to use the event loop as the default command loop and we merge
679    event-top.c into this file, top.c.  */
680
681 /* static */ int history_expansion_p;
682
683 static int write_history_p;
684 static void
685 show_write_history_p (struct ui_file *file, int from_tty,
686                       struct cmd_list_element *c, const char *value)
687 {
688   fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
689                     value);
690 }
691
692 /* The variable associated with the "set/show history size"
693    command.  The value -1 means unlimited, and -2 means undefined.  */
694 static int history_size_setshow_var = -2;
695
696 static void
697 show_history_size (struct ui_file *file, int from_tty,
698                    struct cmd_list_element *c, const char *value)
699 {
700   fprintf_filtered (file, _("The size of the command history is %s.\n"),
701                     value);
702 }
703
704 /* Variable associated with the "history remove-duplicates" option.
705    The value -1 means unlimited.  */
706 static int history_remove_duplicates = 0;
707
708 static void
709 show_history_remove_duplicates (struct ui_file *file, int from_tty,
710                                 struct cmd_list_element *c, const char *value)
711 {
712   fprintf_filtered (file,
713                     _("The number of history entries to look back at for "
714                       "duplicates is %s.\n"),
715                     value);
716 }
717
718 static char *history_filename;
719 static void
720 show_history_filename (struct ui_file *file, int from_tty,
721                        struct cmd_list_element *c, const char *value)
722 {
723   fprintf_filtered (file, _("The filename in which to record "
724                             "the command history is \"%s\".\n"),
725                     value);
726 }
727
728 /* This is like readline(), but it has some gdb-specific behavior.
729    gdb may want readline in both the synchronous and async modes during
730    a single gdb invocation.  At the ordinary top-level prompt we might
731    be using the async readline.  That means we can't use
732    rl_pre_input_hook, since it doesn't work properly in async mode.
733    However, for a secondary prompt (" >", such as occurs during a
734    `define'), gdb wants a synchronous response.
735
736    We used to call readline() directly, running it in synchronous
737    mode.  But mixing modes this way is not supported, and as of
738    readline 5.x it no longer works; the arrow keys come unbound during
739    the synchronous call.  So we make a nested call into the event
740    loop.  That's what gdb_readline_wrapper is for.  */
741
742 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
743    rely on gdb_readline_wrapper_result, which might still be NULL if
744    the user types Control-D for EOF.  */
745 static int gdb_readline_wrapper_done;
746
747 /* The result of the current call to gdb_readline_wrapper, once a newline
748    is seen.  */
749 static char *gdb_readline_wrapper_result;
750
751 /* Any intercepted hook.  Operate-and-get-next sets this, expecting it
752    to be called after the newline is processed (which will redisplay
753    the prompt).  But in gdb_readline_wrapper we will not get a new
754    prompt until the next call, or until we return to the event loop.
755    So we disable this hook around the newline and restore it before we
756    return.  */
757 static void (*saved_after_char_processing_hook) (void);
758
759
760 /* The number of nested readline secondary prompts that are currently
761    active.  */
762
763 static int gdb_secondary_prompt_depth = 0;
764
765 /* See top.h.  */
766
767 int
768 gdb_in_secondary_prompt_p (void)
769 {
770   return gdb_secondary_prompt_depth > 0;
771 }
772
773
774 /* This function is called when readline has seen a complete line of
775    text.  */
776
777 static void
778 gdb_readline_wrapper_line (char *line)
779 {
780   gdb_assert (!gdb_readline_wrapper_done);
781   gdb_readline_wrapper_result = line;
782   gdb_readline_wrapper_done = 1;
783
784   /* Prevent operate-and-get-next from acting too early.  */
785   saved_after_char_processing_hook = after_char_processing_hook;
786   after_char_processing_hook = NULL;
787
788   /* Prevent parts of the prompt from being redisplayed if annotations
789      are enabled, and readline's state getting out of sync.  We'll
790      reinstall the callback handler, which puts the terminal in raw
791      mode (or in readline lingo, in prepped state), when we're next
792      ready to process user input, either in display_gdb_prompt, or if
793      we're handling an asynchronous target event and running in the
794      background, just before returning to the event loop to process
795      further input (or more target events).  */
796   if (async_command_editing_p)
797     gdb_rl_callback_handler_remove ();
798 }
799
800 struct gdb_readline_wrapper_cleanup
801   {
802     void (*handler_orig) (char *);
803     int already_prompted_orig;
804
805     /* Whether the target was async.  */
806     int target_is_async_orig;
807   };
808
809 static void
810 gdb_readline_wrapper_cleanup (void *arg)
811 {
812   struct ui *ui = current_ui;
813   struct gdb_readline_wrapper_cleanup *cleanup
814     = (struct gdb_readline_wrapper_cleanup *) arg;
815
816   rl_already_prompted = cleanup->already_prompted_orig;
817
818   gdb_assert (ui->input_handler == gdb_readline_wrapper_line);
819   ui->input_handler = cleanup->handler_orig;
820
821   /* Don't restore our input handler in readline yet.  That would make
822      readline prep the terminal (putting it in raw mode), while the
823      line we just read may trigger execution of a command that expects
824      the terminal in the default cooked/canonical mode, such as e.g.,
825      running Python's interactive online help utility.  See
826      gdb_readline_wrapper_line for when we'll reinstall it.  */
827
828   gdb_readline_wrapper_result = NULL;
829   gdb_readline_wrapper_done = 0;
830   gdb_secondary_prompt_depth--;
831   gdb_assert (gdb_secondary_prompt_depth >= 0);
832
833   after_char_processing_hook = saved_after_char_processing_hook;
834   saved_after_char_processing_hook = NULL;
835
836   if (cleanup->target_is_async_orig)
837     target_async (1);
838
839   xfree (cleanup);
840 }
841
842 char *
843 gdb_readline_wrapper (const char *prompt)
844 {
845   struct ui *ui = current_ui;
846   struct cleanup *back_to;
847   struct gdb_readline_wrapper_cleanup *cleanup;
848   char *retval;
849
850   cleanup = XNEW (struct gdb_readline_wrapper_cleanup);
851   cleanup->handler_orig = ui->input_handler;
852   ui->input_handler = gdb_readline_wrapper_line;
853
854   cleanup->already_prompted_orig = rl_already_prompted;
855
856   cleanup->target_is_async_orig = target_is_async_p ();
857
858   gdb_secondary_prompt_depth++;
859   back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
860
861   if (cleanup->target_is_async_orig)
862     target_async (0);
863
864   /* Display our prompt and prevent double prompt display.  */
865   display_gdb_prompt (prompt);
866   rl_already_prompted = 1;
867
868   if (after_char_processing_hook)
869     (*after_char_processing_hook) ();
870   gdb_assert (after_char_processing_hook == NULL);
871
872   while (gdb_do_one_event () >= 0)
873     if (gdb_readline_wrapper_done)
874       break;
875
876   retval = gdb_readline_wrapper_result;
877   do_cleanups (back_to);
878   return retval;
879 }
880
881 \f
882 /* The current saved history number from operate-and-get-next.
883    This is -1 if not valid.  */
884 static int operate_saved_history = -1;
885
886 /* This is put on the appropriate hook and helps operate-and-get-next
887    do its work.  */
888 static void
889 gdb_rl_operate_and_get_next_completion (void)
890 {
891   int delta = where_history () - operate_saved_history;
892
893   /* The `key' argument to rl_get_previous_history is ignored.  */
894   rl_get_previous_history (delta, 0);
895   operate_saved_history = -1;
896
897   /* readline doesn't automatically update the display for us.  */
898   rl_redisplay ();
899
900   after_char_processing_hook = NULL;
901   rl_pre_input_hook = NULL;
902 }
903
904 /* This is a gdb-local readline command handler.  It accepts the
905    current command line (like RET does) and, if this command was taken
906    from the history, arranges for the next command in the history to
907    appear on the command line when the prompt returns.
908    We ignore the arguments.  */
909 static int
910 gdb_rl_operate_and_get_next (int count, int key)
911 {
912   int where;
913
914   /* Use the async hook.  */
915   after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
916
917   /* Find the current line, and find the next line to use.  */
918   where = where_history();
919
920   if ((history_is_stifled () && (history_length >= history_max_entries))
921       || (where >= history_length - 1))
922     operate_saved_history = where;
923   else
924     operate_saved_history = where + 1;
925
926   return rl_newline (1, key);
927 }
928
929 /* Number of user commands executed during this session.  */
930
931 static int command_count = 0;
932
933 /* Add the user command COMMAND to the input history list.  */
934
935 void
936 gdb_add_history (const char *command)
937 {
938   command_count++;
939
940   if (history_remove_duplicates != 0)
941     {
942       int lookbehind;
943       int lookbehind_threshold;
944
945       /* The lookbehind threshold for finding a duplicate history entry is
946          bounded by command_count because we can't meaningfully delete
947          history entries that are already stored in the history file since
948          the history file is appended to.  */
949       if (history_remove_duplicates == -1
950           || history_remove_duplicates > command_count)
951         lookbehind_threshold = command_count;
952       else
953         lookbehind_threshold = history_remove_duplicates;
954
955       using_history ();
956       for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
957         {
958           HIST_ENTRY *temp = previous_history ();
959
960           if (temp == NULL)
961             break;
962
963           if (strcmp (temp->line, command) == 0)
964             {
965               HIST_ENTRY *prev = remove_history (where_history ());
966               command_count--;
967               free_history_entry (prev);
968               break;
969             }
970         }
971       using_history ();
972     }
973
974   add_history (command);
975 }
976
977 /* Safely append new history entries to the history file in a corruption-free
978    way using an intermediate local history file.  */
979
980 static void
981 gdb_safe_append_history (void)
982 {
983   int ret, saved_errno;
984   char *local_history_filename;
985   struct cleanup *old_chain;
986
987   local_history_filename
988     = xstrprintf ("%s-gdb%d~", history_filename, getpid ());
989   old_chain = make_cleanup (xfree, local_history_filename);
990
991   ret = rename (history_filename, local_history_filename);
992   saved_errno = errno;
993   if (ret < 0 && saved_errno != ENOENT)
994     {
995       warning (_("Could not rename %s to %s: %s"),
996                history_filename, local_history_filename,
997                safe_strerror (saved_errno));
998     }
999   else
1000     {
1001       if (ret < 0)
1002         {
1003           /* If the rename failed with ENOENT then either the global history
1004              file never existed in the first place or another GDB process is
1005              currently appending to it (and has thus temporarily renamed it).
1006              Since we can't distinguish between these two cases, we have to
1007              conservatively assume the first case and therefore must write out
1008              (not append) our known history to our local history file and try
1009              to move it back anyway.  Otherwise a global history file would
1010              never get created!  */
1011            gdb_assert (saved_errno == ENOENT);
1012            write_history (local_history_filename);
1013         }
1014       else
1015         {
1016           append_history (command_count, local_history_filename);
1017           if (history_is_stifled ())
1018             history_truncate_file (local_history_filename, history_max_entries);
1019         }
1020
1021       ret = rename (local_history_filename, history_filename);
1022       saved_errno = errno;
1023       if (ret < 0 && saved_errno != EEXIST)
1024         warning (_("Could not rename %s to %s: %s"),
1025                  local_history_filename, history_filename,
1026                  safe_strerror (saved_errno));
1027     }
1028
1029   do_cleanups (old_chain);
1030 }
1031
1032 /* Read one line from the command input stream `instream' into a local
1033    static buffer.  The buffer is made bigger as necessary.  Returns
1034    the address of the start of the line.
1035
1036    NULL is returned for end of file.
1037
1038    *If* the instream == stdin & stdin is a terminal, the line read is
1039    copied into the global 'saved_command_line' so that it can be
1040    repeated.
1041
1042    This routine either uses fancy command line editing or simple input
1043    as the user has requested.  */
1044
1045 char *
1046 command_line_input (const char *prompt_arg, int repeat, char *annotation_suffix)
1047 {
1048   static struct buffer cmd_line_buffer;
1049   static int cmd_line_buffer_initialized;
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 && 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 && 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   if (batch_flag)
1515     return 0;
1516
1517   if (gdb_has_a_terminal () && instream == stdin)
1518     return 1;
1519
1520   /* If INSTREAM is unset, and we are not in a user command, we
1521      must be in Insight.  That's like having a terminal, for our
1522      purposes.  */
1523   if (instream == NULL && !in_user_command)
1524     return 1;
1525
1526   return 0;
1527 }
1528 \f
1529 static void
1530 dont_repeat_command (char *ignored, int from_tty)
1531 {
1532   /* Can't call dont_repeat here because we're not necessarily reading
1533      from stdin.  */
1534   *saved_command_line = 0;
1535 }
1536 \f
1537 /* Functions to manipulate command line editing control variables.  */
1538
1539 /* Number of commands to print in each call to show_commands.  */
1540 #define Hist_print 10
1541 void
1542 show_commands (char *args, int from_tty)
1543 {
1544   /* Index for history commands.  Relative to history_base.  */
1545   int offset;
1546
1547   /* Number of the history entry which we are planning to display next.
1548      Relative to history_base.  */
1549   static int num = 0;
1550
1551   /* Print out some of the commands from the command history.  */
1552
1553   if (args)
1554     {
1555       if (args[0] == '+' && args[1] == '\0')
1556         /* "info editing +" should print from the stored position.  */
1557         ;
1558       else
1559         /* "info editing <exp>" should print around command number <exp>.  */
1560         num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1561     }
1562   /* "show commands" means print the last Hist_print commands.  */
1563   else
1564     {
1565       num = history_length - Hist_print;
1566     }
1567
1568   if (num < 0)
1569     num = 0;
1570
1571   /* If there are at least Hist_print commands, we want to display the last
1572      Hist_print rather than, say, the last 6.  */
1573   if (history_length - num < Hist_print)
1574     {
1575       num = history_length - Hist_print;
1576       if (num < 0)
1577         num = 0;
1578     }
1579
1580   for (offset = num;
1581        offset < num + Hist_print && offset < history_length;
1582        offset++)
1583     {
1584       printf_filtered ("%5d  %s\n", history_base + offset,
1585                        (history_get (history_base + offset))->line);
1586     }
1587
1588   /* The next command we want to display is the next one that we haven't
1589      displayed yet.  */
1590   num += Hist_print;
1591
1592   /* If the user repeats this command with return, it should do what
1593      "show commands +" does.  This is unnecessary if arg is null,
1594      because "show commands +" is not useful after "show commands".  */
1595   if (from_tty && args)
1596     {
1597       args[0] = '+';
1598       args[1] = '\0';
1599     }
1600 }
1601
1602 /* Update the size of our command history file to HISTORY_SIZE.
1603
1604    A HISTORY_SIZE of -1 stands for unlimited.  */
1605
1606 static void
1607 set_readline_history_size (int history_size)
1608 {
1609   gdb_assert (history_size >= -1);
1610
1611   if (history_size == -1)
1612     unstifle_history ();
1613   else
1614     stifle_history (history_size);
1615 }
1616
1617 /* Called by do_setshow_command.  */
1618 static void
1619 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1620 {
1621   set_readline_history_size (history_size_setshow_var);
1622 }
1623
1624 void
1625 set_history (char *args, int from_tty)
1626 {
1627   printf_unfiltered (_("\"set history\" must be followed "
1628                        "by the name of a history subcommand.\n"));
1629   help_list (sethistlist, "set history ", all_commands, gdb_stdout);
1630 }
1631
1632 void
1633 show_history (char *args, int from_tty)
1634 {
1635   cmd_show_list (showhistlist, from_tty, "");
1636 }
1637
1638 int info_verbose = 0;           /* Default verbose msgs off.  */
1639
1640 /* Called by do_setshow_command.  An elaborate joke.  */
1641 void
1642 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1643 {
1644   const char *cmdname = "verbose";
1645   struct cmd_list_element *showcmd;
1646
1647   showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1648   gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1649
1650   if (info_verbose)
1651     {
1652       c->doc = "Set verbose printing of informational messages.";
1653       showcmd->doc = "Show verbose printing of informational messages.";
1654     }
1655   else
1656     {
1657       c->doc = "Set verbosity.";
1658       showcmd->doc = "Show verbosity.";
1659     }
1660 }
1661
1662 /* Init the history buffer.  Note that we are called after the init file(s)
1663    have been read so that the user can change the history file via his
1664    .gdbinit file (for instance).  The GDBHISTFILE environment variable
1665    overrides all of this.  */
1666
1667 void
1668 init_history (void)
1669 {
1670   char *tmpenv;
1671
1672   tmpenv = getenv ("GDBHISTSIZE");
1673   if (tmpenv)
1674     {
1675       long var;
1676       int saved_errno;
1677       char *endptr;
1678
1679       tmpenv = skip_spaces (tmpenv);
1680       errno = 0;
1681       var = strtol (tmpenv, &endptr, 10);
1682       saved_errno = errno;
1683       endptr = skip_spaces (endptr);
1684
1685       /* If GDBHISTSIZE is non-numeric then ignore it.  If GDBHISTSIZE is the
1686          empty string, a negative number or a huge positive number (larger than
1687          INT_MAX) then set the history size to unlimited.  Otherwise set our
1688          history size to the number we have read.  This behavior is consistent
1689          with how bash handles HISTSIZE.  */
1690       if (*endptr != '\0')
1691         ;
1692       else if (*tmpenv == '\0'
1693                || var < 0
1694                || var > INT_MAX
1695                /* On targets where INT_MAX == LONG_MAX, we have to look at
1696                   errno after calling strtol to distinguish between a value that
1697                   is exactly INT_MAX and an overflowing value that was clamped
1698                   to INT_MAX.  */
1699                || (var == INT_MAX && saved_errno == ERANGE))
1700         history_size_setshow_var = -1;
1701       else
1702         history_size_setshow_var = var;
1703     }
1704
1705   /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1706      default.  */
1707   if (history_size_setshow_var == -2)
1708     history_size_setshow_var = 256;
1709
1710   set_readline_history_size (history_size_setshow_var);
1711
1712   tmpenv = getenv ("GDBHISTFILE");
1713   if (tmpenv)
1714     history_filename = xstrdup (tmpenv);
1715   else if (!history_filename)
1716     {
1717       /* We include the current directory so that if the user changes
1718          directories the file written will be the same as the one
1719          that was read.  */
1720 #ifdef __MSDOS__
1721       /* No leading dots in file names are allowed on MSDOS.  */
1722       history_filename = concat (current_directory, "/_gdb_history",
1723                                  (char *)NULL);
1724 #else
1725       history_filename = concat (current_directory, "/.gdb_history",
1726                                  (char *)NULL);
1727 #endif
1728     }
1729   read_history (history_filename);
1730 }
1731
1732 static void
1733 show_prompt (struct ui_file *file, int from_tty,
1734              struct cmd_list_element *c, const char *value)
1735 {
1736   fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1737 }
1738
1739 static void
1740 show_async_command_editing_p (struct ui_file *file, int from_tty,
1741                               struct cmd_list_element *c, const char *value)
1742 {
1743   fprintf_filtered (file, _("Editing of command lines as "
1744                             "they are typed is %s.\n"),
1745                     value);
1746 }
1747
1748 static void
1749 show_annotation_level (struct ui_file *file, int from_tty,
1750                        struct cmd_list_element *c, const char *value)
1751 {
1752   fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1753 }
1754
1755 static void
1756 show_exec_done_display_p (struct ui_file *file, int from_tty,
1757                           struct cmd_list_element *c, const char *value)
1758 {
1759   fprintf_filtered (file, _("Notification of completion for "
1760                             "asynchronous execution commands is %s.\n"),
1761                     value);
1762 }
1763
1764 /* New values of the "data-directory" parameter are staged here.  */
1765 static char *staged_gdb_datadir;
1766
1767 /* "set" command for the gdb_datadir configuration variable.  */
1768
1769 static void
1770 set_gdb_datadir (char *args, int from_tty, struct cmd_list_element *c)
1771 {
1772   set_gdb_data_directory (staged_gdb_datadir);
1773   observer_notify_gdb_datadir_changed ();
1774 }
1775
1776 /* "show" command for the gdb_datadir configuration variable.  */
1777
1778 static void
1779 show_gdb_datadir (struct ui_file *file, int from_tty,
1780                   struct cmd_list_element *c, const char *value)
1781 {
1782   fprintf_filtered (file, _("GDB's data directory is \"%s\".\n"),
1783                     gdb_datadir);
1784 }
1785
1786 static void
1787 set_history_filename (char *args, int from_tty, struct cmd_list_element *c)
1788 {
1789   /* We include the current directory so that if the user changes
1790      directories the file written will be the same as the one
1791      that was read.  */
1792   if (!IS_ABSOLUTE_PATH (history_filename))
1793     history_filename = reconcat (history_filename, current_directory, "/", 
1794                                  history_filename, (char *) NULL);
1795 }
1796
1797 static void
1798 init_main (void)
1799 {
1800   /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1801      the DEFAULT_PROMPT is.  */
1802   set_prompt (DEFAULT_PROMPT);
1803
1804   /* Set the important stuff up for command editing.  */
1805   command_editing_p = 1;
1806   history_expansion_p = 0;
1807   write_history_p = 0;
1808
1809   /* Setup important stuff for command line editing.  */
1810   rl_completion_word_break_hook = gdb_completion_word_break_characters;
1811   rl_completion_entry_function = readline_line_completion_function;
1812   rl_completer_word_break_characters = default_word_break_characters ();
1813   rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1814   rl_completion_display_matches_hook = cli_display_match_list;
1815   rl_readline_name = "gdb";
1816   rl_terminal_name = getenv ("TERM");
1817
1818   /* The name for this defun comes from Bash, where it originated.
1819      15 is Control-o, the same binding this function has in Bash.  */
1820   rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1821
1822   add_setshow_string_cmd ("prompt", class_support,
1823                           &top_prompt,
1824                           _("Set gdb's prompt"),
1825                           _("Show gdb's prompt"),
1826                           NULL, NULL,
1827                           show_prompt,
1828                           &setlist, &showlist);
1829
1830   add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1831 Don't repeat this command.\nPrimarily \
1832 used inside of user-defined commands that should not be repeated when\n\
1833 hitting return."));
1834
1835   add_setshow_boolean_cmd ("editing", class_support,
1836                            &async_command_editing_p, _("\
1837 Set editing of command lines as they are typed."), _("\
1838 Show editing of command lines as they are typed."), _("\
1839 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1840 Without an argument, command line editing is enabled.  To edit, use\n\
1841 EMACS-like or VI-like commands like control-P or ESC."),
1842                            set_async_editing_command,
1843                            show_async_command_editing_p,
1844                            &setlist, &showlist);
1845
1846   add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
1847 Set saving of the history record on exit."), _("\
1848 Show saving of the history record on exit."), _("\
1849 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1850 Without an argument, saving is enabled."),
1851                            NULL,
1852                            show_write_history_p,
1853                            &sethistlist, &showhistlist);
1854
1855   add_setshow_zuinteger_unlimited_cmd ("size", no_class,
1856                                        &history_size_setshow_var, _("\
1857 Set the size of the command history,"), _("\
1858 Show the size of the command history,"), _("\
1859 ie. the number of previous commands to keep a record of.\n\
1860 If set to \"unlimited\", the number of commands kept in the history\n\
1861 list is unlimited.  This defaults to the value of the environment\n\
1862 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
1863                             set_history_size_command,
1864                             show_history_size,
1865                             &sethistlist, &showhistlist);
1866
1867   add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
1868                                        &history_remove_duplicates, _("\
1869 Set how far back in history to look for and remove duplicate entries."), _("\
1870 Show how far back in history to look for and remove duplicate entries."), _("\
1871 If set to a nonzero value N, GDB will look back at the last N history entries\n\
1872 and remove the first history entry that is a duplicate of the most recent\n\
1873 entry, each time a new history entry is added.\n\
1874 If set to \"unlimited\", this lookbehind is unbounded.\n\
1875 Only history entries added during this session are considered for removal.\n\
1876 If set to 0, removal of duplicate history entries is disabled.\n\
1877 By default this option is set to 0."),
1878                            NULL,
1879                            show_history_remove_duplicates,
1880                            &sethistlist, &showhistlist);
1881
1882   add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
1883 Set the filename in which to record the command history"), _("\
1884 Show the filename in which to record the command history"), _("\
1885 (the list of previous commands of which a record is kept)."),
1886                             set_history_filename,
1887                             show_history_filename,
1888                             &sethistlist, &showhistlist);
1889
1890   add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
1891 Set whether to confirm potentially dangerous operations."), _("\
1892 Show whether to confirm potentially dangerous operations."), NULL,
1893                            NULL,
1894                            show_confirm,
1895                            &setlist, &showlist);
1896
1897   add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
1898 Set annotation_level."), _("\
1899 Show annotation_level."), _("\
1900 0 == normal;     1 == fullname (for use when running under emacs)\n\
1901 2 == output annotated suitably for use by programs that control GDB."),
1902                             NULL,
1903                             show_annotation_level,
1904                             &setlist, &showlist);
1905
1906   add_setshow_boolean_cmd ("exec-done-display", class_support,
1907                            &exec_done_display_p, _("\
1908 Set notification of completion for asynchronous execution commands."), _("\
1909 Show notification of completion for asynchronous execution commands."), _("\
1910 Use \"on\" to enable the notification, and \"off\" to disable it."),
1911                            NULL,
1912                            show_exec_done_display_p,
1913                            &setlist, &showlist);
1914
1915   add_setshow_filename_cmd ("data-directory", class_maintenance,
1916                            &staged_gdb_datadir, _("Set GDB's data directory."),
1917                            _("Show GDB's data directory."),
1918                            _("\
1919 When set, GDB uses the specified path to search for data files."),
1920                            set_gdb_datadir, show_gdb_datadir,
1921                            &setlist,
1922                            &showlist);
1923 }
1924
1925 void
1926 gdb_init (char *argv0)
1927 {
1928   if (pre_init_ui_hook)
1929     pre_init_ui_hook ();
1930
1931   /* Run the init function of each source file.  */
1932
1933 #ifdef __MSDOS__
1934   /* Make sure we return to the original directory upon exit, come
1935      what may, since the OS doesn't do that for us.  */
1936   make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
1937 #endif
1938
1939   init_cmd_lists ();        /* This needs to be done first.  */
1940   initialize_targets ();    /* Setup target_terminal macros for utils.c.  */
1941   initialize_utils ();      /* Make errors and warnings possible.  */
1942
1943   init_page_info ();
1944
1945   /* Here is where we call all the _initialize_foo routines.  */
1946   initialize_all_files ();
1947
1948   /* This creates the current_program_space.  Do this after all the
1949      _initialize_foo routines have had a chance to install their
1950      per-sspace data keys.  Also do this before
1951      initialize_current_architecture is called, because it accesses
1952      exec_bfd of the current program space.  */
1953   initialize_progspace ();
1954   initialize_inferiors ();
1955   initialize_current_architecture ();
1956   init_cli_cmds();
1957   init_main ();                 /* But that omits this file!  Do it now.  */
1958
1959   initialize_stdin_serial ();
1960
1961   /* Take a snapshot of our tty state before readline/ncurses have had a chance
1962      to alter it.  */
1963   set_initial_gdb_ttystate ();
1964
1965   async_init_signals ();
1966
1967   /* We need a default language for parsing expressions, so simple
1968      things like "set width 0" won't fail if no language is explicitly
1969      set in a config file or implicitly set by reading an executable
1970      during startup.  */
1971   set_language (language_c);
1972   expected_language = current_language; /* Don't warn about the change.  */
1973
1974   /* Python initialization, for example, can require various commands to be
1975      installed.  For example "info pretty-printer" needs the "info"
1976      prefix to be installed.  Keep things simple and just do final
1977      script initialization here.  */
1978   finish_ext_lang_initialization ();
1979 }