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