Fix annota-input-while-running.exp remote check
[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 gdb_readline_wrapper_cleanup *cleanup
798     = (struct gdb_readline_wrapper_cleanup *) arg;
799
800   rl_already_prompted = cleanup->already_prompted_orig;
801
802   gdb_assert (input_handler == gdb_readline_wrapper_line);
803   input_handler = cleanup->handler_orig;
804
805   /* Don't restore our input handler in readline yet.  That would make
806      readline prep the terminal (putting it in raw mode), while the
807      line we just read may trigger execution of a command that expects
808      the terminal in the default cooked/canonical mode, such as e.g.,
809      running Python's interactive online help utility.  See
810      gdb_readline_wrapper_line for when we'll reinstall it.  */
811
812   gdb_readline_wrapper_result = NULL;
813   gdb_readline_wrapper_done = 0;
814   gdb_secondary_prompt_depth--;
815   gdb_assert (gdb_secondary_prompt_depth >= 0);
816
817   after_char_processing_hook = saved_after_char_processing_hook;
818   saved_after_char_processing_hook = NULL;
819
820   if (cleanup->target_is_async_orig)
821     target_async (1);
822
823   xfree (cleanup);
824 }
825
826 char *
827 gdb_readline_wrapper (const char *prompt)
828 {
829   struct cleanup *back_to;
830   struct gdb_readline_wrapper_cleanup *cleanup;
831   char *retval;
832
833   cleanup = XNEW (struct gdb_readline_wrapper_cleanup);
834   cleanup->handler_orig = input_handler;
835   input_handler = gdb_readline_wrapper_line;
836
837   cleanup->already_prompted_orig = rl_already_prompted;
838
839   cleanup->target_is_async_orig = target_is_async_p ();
840
841   gdb_secondary_prompt_depth++;
842   back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
843
844   if (cleanup->target_is_async_orig)
845     target_async (0);
846
847   /* Display our prompt and prevent double prompt display.  */
848   display_gdb_prompt (prompt);
849   rl_already_prompted = 1;
850
851   if (after_char_processing_hook)
852     (*after_char_processing_hook) ();
853   gdb_assert (after_char_processing_hook == NULL);
854
855   while (gdb_do_one_event () >= 0)
856     if (gdb_readline_wrapper_done)
857       break;
858
859   retval = gdb_readline_wrapper_result;
860   do_cleanups (back_to);
861   return retval;
862 }
863
864 \f
865 /* The current saved history number from operate-and-get-next.
866    This is -1 if not valid.  */
867 static int operate_saved_history = -1;
868
869 /* This is put on the appropriate hook and helps operate-and-get-next
870    do its work.  */
871 static void
872 gdb_rl_operate_and_get_next_completion (void)
873 {
874   int delta = where_history () - operate_saved_history;
875
876   /* The `key' argument to rl_get_previous_history is ignored.  */
877   rl_get_previous_history (delta, 0);
878   operate_saved_history = -1;
879
880   /* readline doesn't automatically update the display for us.  */
881   rl_redisplay ();
882
883   after_char_processing_hook = NULL;
884   rl_pre_input_hook = NULL;
885 }
886
887 /* This is a gdb-local readline command handler.  It accepts the
888    current command line (like RET does) and, if this command was taken
889    from the history, arranges for the next command in the history to
890    appear on the command line when the prompt returns.
891    We ignore the arguments.  */
892 static int
893 gdb_rl_operate_and_get_next (int count, int key)
894 {
895   int where;
896
897   /* Use the async hook.  */
898   after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
899
900   /* Find the current line, and find the next line to use.  */
901   where = where_history();
902
903   if ((history_is_stifled () && (history_length >= history_max_entries))
904       || (where >= history_length - 1))
905     operate_saved_history = where;
906   else
907     operate_saved_history = where + 1;
908
909   return rl_newline (1, key);
910 }
911
912 /* Number of user commands executed during this session.  */
913
914 static int command_count = 0;
915
916 /* Add the user command COMMAND to the input history list.  */
917
918 void
919 gdb_add_history (const char *command)
920 {
921   command_count++;
922
923   if (history_remove_duplicates != 0)
924     {
925       int lookbehind;
926       int lookbehind_threshold;
927
928       /* The lookbehind threshold for finding a duplicate history entry is
929          bounded by command_count because we can't meaningfully delete
930          history entries that are already stored in the history file since
931          the history file is appended to.  */
932       if (history_remove_duplicates == -1
933           || history_remove_duplicates > command_count)
934         lookbehind_threshold = command_count;
935       else
936         lookbehind_threshold = history_remove_duplicates;
937
938       using_history ();
939       for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
940         {
941           HIST_ENTRY *temp = previous_history ();
942
943           if (temp == NULL)
944             break;
945
946           if (strcmp (temp->line, command) == 0)
947             {
948               HIST_ENTRY *prev = remove_history (where_history ());
949               command_count--;
950               free_history_entry (prev);
951               break;
952             }
953         }
954       using_history ();
955     }
956
957   add_history (command);
958 }
959
960 /* Safely append new history entries to the history file in a corruption-free
961    way using an intermediate local history file.  */
962
963 static void
964 gdb_safe_append_history (void)
965 {
966   int ret, saved_errno;
967   char *local_history_filename;
968   struct cleanup *old_chain;
969
970   local_history_filename
971     = xstrprintf ("%s-gdb%d~", history_filename, getpid ());
972   old_chain = make_cleanup (xfree, local_history_filename);
973
974   ret = rename (history_filename, local_history_filename);
975   saved_errno = errno;
976   if (ret < 0 && saved_errno != ENOENT)
977     {
978       warning (_("Could not rename %s to %s: %s"),
979                history_filename, local_history_filename,
980                safe_strerror (saved_errno));
981     }
982   else
983     {
984       if (ret < 0)
985         {
986           /* If the rename failed with ENOENT then either the global history
987              file never existed in the first place or another GDB process is
988              currently appending to it (and has thus temporarily renamed it).
989              Since we can't distinguish between these two cases, we have to
990              conservatively assume the first case and therefore must write out
991              (not append) our known history to our local history file and try
992              to move it back anyway.  Otherwise a global history file would
993              never get created!  */
994            gdb_assert (saved_errno == ENOENT);
995            write_history (local_history_filename);
996         }
997       else
998         {
999           append_history (command_count, local_history_filename);
1000           if (history_is_stifled ())
1001             history_truncate_file (local_history_filename, history_max_entries);
1002         }
1003
1004       ret = rename (local_history_filename, history_filename);
1005       saved_errno = errno;
1006       if (ret < 0 && saved_errno != EEXIST)
1007         warning (_("Could not rename %s to %s: %s"),
1008                  local_history_filename, history_filename,
1009                  safe_strerror (saved_errno));
1010     }
1011
1012   do_cleanups (old_chain);
1013 }
1014
1015 /* Read one line from the command input stream `instream' into a local
1016    static buffer.  The buffer is made bigger as necessary.  Returns
1017    the address of the start of the line.
1018
1019    NULL is returned for end of file.
1020
1021    *If* the instream == stdin & stdin is a terminal, the line read is
1022    copied into the global 'saved_command_line' so that it can be
1023    repeated.
1024
1025    This routine either uses fancy command line editing or simple input
1026    as the user has requested.  */
1027
1028 char *
1029 command_line_input (const char *prompt_arg, int repeat, char *annotation_suffix)
1030 {
1031   static struct buffer cmd_line_buffer;
1032   static int cmd_line_buffer_initialized;
1033   const char *prompt = prompt_arg;
1034   char *cmd;
1035
1036   /* The annotation suffix must be non-NULL.  */
1037   if (annotation_suffix == NULL)
1038     annotation_suffix = "";
1039
1040   if (annotation_level > 1 && instream == stdin)
1041     {
1042       char *local_prompt;
1043
1044       local_prompt
1045         = (char *) alloca ((prompt == NULL ? 0 : strlen (prompt))
1046                            + strlen (annotation_suffix) + 40);
1047       if (prompt == NULL)
1048         local_prompt[0] = '\0';
1049       else
1050         strcpy (local_prompt, prompt);
1051       strcat (local_prompt, "\n\032\032");
1052       strcat (local_prompt, annotation_suffix);
1053       strcat (local_prompt, "\n");
1054
1055       prompt = local_prompt;
1056     }
1057
1058   if (!cmd_line_buffer_initialized)
1059     {
1060       buffer_init (&cmd_line_buffer);
1061       cmd_line_buffer_initialized = 1;
1062     }
1063
1064   /* Starting a new command line.  */
1065   cmd_line_buffer.used_size = 0;
1066
1067 #ifdef STOP_SIGNAL
1068   if (job_control)
1069     signal (STOP_SIGNAL, handle_stop_sig);
1070 #endif
1071
1072   while (1)
1073     {
1074       char *rl;
1075
1076       /* Make sure that all output has been output.  Some machines may
1077          let you get away with leaving out some of the gdb_flush, but
1078          not all.  */
1079       wrap_here ("");
1080       gdb_flush (gdb_stdout);
1081       gdb_flush (gdb_stderr);
1082
1083       if (source_file_name != NULL)
1084         ++source_line_number;
1085
1086       if (annotation_level > 1 && instream == stdin)
1087         {
1088           puts_unfiltered ("\n\032\032pre-");
1089           puts_unfiltered (annotation_suffix);
1090           puts_unfiltered ("\n");
1091         }
1092
1093       /* Don't use fancy stuff if not talking to stdin.  */
1094       if (deprecated_readline_hook && input_from_terminal_p ())
1095         {
1096           rl = (*deprecated_readline_hook) (prompt);
1097         }
1098       else if (command_editing_p && input_from_terminal_p ())
1099         {
1100           rl = gdb_readline_wrapper (prompt);
1101         }
1102       else
1103         {
1104           rl = gdb_readline_no_editing (prompt);
1105         }
1106
1107       cmd = handle_line_of_input (&cmd_line_buffer, rl,
1108                                   repeat, annotation_suffix);
1109       if (cmd == (char *) EOF)
1110         {
1111           cmd = NULL;
1112           break;
1113         }
1114       if (cmd != NULL)
1115         break;
1116
1117       prompt = NULL;
1118     }
1119
1120 #ifdef STOP_SIGNAL
1121   if (job_control)
1122     signal (STOP_SIGNAL, SIG_DFL);
1123 #endif
1124
1125   return cmd;
1126 }
1127 \f
1128 /* Print the GDB banner.  */
1129 void
1130 print_gdb_version (struct ui_file *stream)
1131 {
1132   /* From GNU coding standards, first line is meant to be easy for a
1133      program to parse, and is just canonical program name and version
1134      number, which starts after last space.  */
1135
1136   fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1137
1138   /* Second line is a copyright notice.  */
1139
1140   fprintf_filtered (stream,
1141                     "Copyright (C) 2016 Free Software Foundation, Inc.\n");
1142
1143   /* Following the copyright is a brief statement that the program is
1144      free software, that users are free to copy and change it on
1145      certain conditions, that it is covered by the GNU GPL, and that
1146      there is no warranty.  */
1147
1148   fprintf_filtered (stream, "\
1149 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1150 \nThis is free software: you are free to change and redistribute it.\n\
1151 There is NO WARRANTY, to the extent permitted by law.  Type \"show copying\"\n\
1152 and \"show warranty\" for details.\n");
1153
1154   /* After the required info we print the configuration information.  */
1155
1156   fprintf_filtered (stream, "This GDB was configured as \"");
1157   if (strcmp (host_name, target_name) != 0)
1158     {
1159       fprintf_filtered (stream, "--host=%s --target=%s",
1160                         host_name, target_name);
1161     }
1162   else
1163     {
1164       fprintf_filtered (stream, "%s", host_name);
1165     }
1166   fprintf_filtered (stream, "\".\n\
1167 Type \"show configuration\" for configuration details.");
1168
1169   if (REPORT_BUGS_TO[0])
1170     {
1171       fprintf_filtered (stream,
1172                         _("\nFor bug reporting instructions, please see:\n"));
1173       fprintf_filtered (stream, "%s.\n", REPORT_BUGS_TO);
1174     }
1175   fprintf_filtered (stream,
1176                     _("Find the GDB manual and other documentation \
1177 resources online at:\n<http://www.gnu.org/software/gdb/documentation/>.\n"));
1178   fprintf_filtered (stream, _("For help, type \"help\".\n"));
1179   fprintf_filtered (stream, _("Type \"apropos word\" to search for \
1180 commands related to \"word\"."));
1181 }
1182
1183 /* Print the details of GDB build-time configuration.  */
1184 void
1185 print_gdb_configuration (struct ui_file *stream)
1186 {
1187   fprintf_filtered (stream, _("\
1188 This GDB was configured as follows:\n\
1189    configure --host=%s --target=%s\n\
1190 "), host_name, target_name);
1191   fprintf_filtered (stream, _("\
1192              --with-auto-load-dir=%s\n\
1193              --with-auto-load-safe-path=%s\n\
1194 "), AUTO_LOAD_DIR, AUTO_LOAD_SAFE_PATH);
1195 #if HAVE_LIBEXPAT
1196   fprintf_filtered (stream, _("\
1197              --with-expat\n\
1198 "));
1199 #else
1200   fprintf_filtered (stream, _("\
1201              --without-expat\n\
1202 "));
1203 #endif
1204   if (GDB_DATADIR[0])
1205     fprintf_filtered (stream, _("\
1206              --with-gdb-datadir=%s%s\n\
1207 "), GDB_DATADIR, GDB_DATADIR_RELOCATABLE ? " (relocatable)" : "");
1208 #ifdef ICONV_BIN
1209   fprintf_filtered (stream, _("\
1210              --with-iconv-bin=%s%s\n\
1211 "), ICONV_BIN, ICONV_BIN_RELOCATABLE ? " (relocatable)" : "");
1212 #endif
1213   if (JIT_READER_DIR[0])
1214     fprintf_filtered (stream, _("\
1215              --with-jit-reader-dir=%s%s\n\
1216 "), JIT_READER_DIR, JIT_READER_DIR_RELOCATABLE ? " (relocatable)" : "");
1217 #if HAVE_LIBUNWIND_IA64_H
1218   fprintf_filtered (stream, _("\
1219              --with-libunwind-ia64\n\
1220 "));
1221 #else
1222   fprintf_filtered (stream, _("\
1223              --without-libunwind-ia64\n\
1224 "));
1225 #endif
1226 #if HAVE_LIBLZMA
1227   fprintf_filtered (stream, _("\
1228              --with-lzma\n\
1229 "));
1230 #else
1231   fprintf_filtered (stream, _("\
1232              --without-lzma\n\
1233 "));
1234 #endif
1235 #ifdef WITH_PYTHON_PATH
1236   fprintf_filtered (stream, _("\
1237              --with-python=%s%s\n\
1238 "), WITH_PYTHON_PATH, PYTHON_PATH_RELOCATABLE ? " (relocatable)" : "");
1239 #endif
1240 #if HAVE_GUILE
1241   fprintf_filtered (stream, _("\
1242              --with-guile\n\
1243 "));
1244 #else
1245   fprintf_filtered (stream, _("\
1246              --without-guile\n\
1247 "));
1248 #endif
1249 #ifdef RELOC_SRCDIR
1250   fprintf_filtered (stream, _("\
1251              --with-relocated-sources=%s\n\
1252 "), RELOC_SRCDIR);
1253 #endif
1254   if (DEBUGDIR[0])
1255     fprintf_filtered (stream, _("\
1256              --with-separate-debug-dir=%s%s\n\
1257 "), DEBUGDIR, DEBUGDIR_RELOCATABLE ? " (relocatable)" : "");
1258   if (TARGET_SYSTEM_ROOT[0])
1259     fprintf_filtered (stream, _("\
1260              --with-sysroot=%s%s\n\
1261 "), TARGET_SYSTEM_ROOT, TARGET_SYSTEM_ROOT_RELOCATABLE ? " (relocatable)" : "");
1262   if (SYSTEM_GDBINIT[0])
1263     fprintf_filtered (stream, _("\
1264              --with-system-gdbinit=%s%s\n\
1265 "), SYSTEM_GDBINIT, SYSTEM_GDBINIT_RELOCATABLE ? " (relocatable)" : "");
1266 #if HAVE_LIBBABELTRACE
1267     fprintf_filtered (stream, _("\
1268              --with-babeltrace\n\
1269 "));
1270 #else
1271     fprintf_filtered (stream, _("\
1272              --without-babeltrace\n\
1273 "));
1274 #endif
1275     /* We assume "relocatable" will be printed at least once, thus we always
1276        print this text.  It's a reasonably safe assumption for now.  */
1277     fprintf_filtered (stream, _("\n\
1278 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1279 tree, and GDB will still find it.)\n\
1280 "));
1281 }
1282 \f
1283
1284 /* The current top level prompt, settable with "set prompt", and/or
1285    with the python `gdb.prompt_hook' hook.  */
1286 static char *top_prompt;
1287
1288 /* Access method for the GDB prompt string.  */
1289
1290 char *
1291 get_prompt (void)
1292 {
1293   return top_prompt;
1294 }
1295
1296 /* Set method for the GDB prompt string.  */
1297
1298 void
1299 set_prompt (const char *s)
1300 {
1301   char *p = xstrdup (s);
1302
1303   xfree (top_prompt);
1304   top_prompt = p;
1305 }
1306 \f
1307
1308 struct qt_args
1309 {
1310   char *args;
1311   int from_tty;
1312 };
1313
1314 /* Callback for iterate_over_inferiors.  Kills or detaches the given
1315    inferior, depending on how we originally gained control of it.  */
1316
1317 static int
1318 kill_or_detach (struct inferior *inf, void *args)
1319 {
1320   struct qt_args *qt = (struct qt_args *) args;
1321   struct thread_info *thread;
1322
1323   if (inf->pid == 0)
1324     return 0;
1325
1326   thread = any_thread_of_process (inf->pid);
1327   if (thread != NULL)
1328     {
1329       switch_to_thread (thread->ptid);
1330
1331       /* Leave core files alone.  */
1332       if (target_has_execution)
1333         {
1334           if (inf->attach_flag)
1335             target_detach (qt->args, qt->from_tty);
1336           else
1337             target_kill ();
1338         }
1339     }
1340
1341   return 0;
1342 }
1343
1344 /* Callback for iterate_over_inferiors.  Prints info about what GDB
1345    will do to each inferior on a "quit".  ARG points to a struct
1346    ui_out where output is to be collected.  */
1347
1348 static int
1349 print_inferior_quit_action (struct inferior *inf, void *arg)
1350 {
1351   struct ui_file *stb = (struct ui_file *) arg;
1352
1353   if (inf->pid == 0)
1354     return 0;
1355
1356   if (inf->attach_flag)
1357     fprintf_filtered (stb,
1358                       _("\tInferior %d [%s] will be detached.\n"), inf->num,
1359                       target_pid_to_str (pid_to_ptid (inf->pid)));
1360   else
1361     fprintf_filtered (stb,
1362                       _("\tInferior %d [%s] will be killed.\n"), inf->num,
1363                       target_pid_to_str (pid_to_ptid (inf->pid)));
1364
1365   return 0;
1366 }
1367
1368 /* If necessary, make the user confirm that we should quit.  Return
1369    non-zero if we should quit, zero if we shouldn't.  */
1370
1371 int
1372 quit_confirm (void)
1373 {
1374   struct ui_file *stb;
1375   struct cleanup *old_chain;
1376   char *str;
1377   int qr;
1378
1379   /* Don't even ask if we're only debugging a core file inferior.  */
1380   if (!have_live_inferiors ())
1381     return 1;
1382
1383   /* Build the query string as a single string.  */
1384   stb = mem_fileopen ();
1385   old_chain = make_cleanup_ui_file_delete (stb);
1386
1387   fprintf_filtered (stb, _("A debugging session is active.\n\n"));
1388   iterate_over_inferiors (print_inferior_quit_action, stb);
1389   fprintf_filtered (stb, _("\nQuit anyway? "));
1390
1391   str = ui_file_xstrdup (stb, NULL);
1392   make_cleanup (xfree, str);
1393
1394   qr = query ("%s", str);
1395   do_cleanups (old_chain);
1396   return qr;
1397 }
1398
1399 /* Prepare to exit GDB cleanly by undoing any changes made to the
1400    terminal so that we leave the terminal in the state we acquired it.  */
1401
1402 static void
1403 undo_terminal_modifications_before_exit (void)
1404 {
1405   target_terminal_ours ();
1406 #if defined(TUI)
1407   tui_disable ();
1408 #endif
1409   if (async_command_editing_p)
1410     gdb_disable_readline ();
1411 }
1412
1413
1414 /* Quit without asking for confirmation.  */
1415
1416 void
1417 quit_force (char *args, int from_tty)
1418 {
1419   int exit_code = 0;
1420   struct qt_args qt;
1421
1422   undo_terminal_modifications_before_exit ();
1423
1424   /* An optional expression may be used to cause gdb to terminate with the 
1425      value of that expression.  */
1426   if (args)
1427     {
1428       struct value *val = parse_and_eval (args);
1429
1430       exit_code = (int) value_as_long (val);
1431     }
1432   else if (return_child_result)
1433     exit_code = return_child_result_value;
1434
1435   qt.args = args;
1436   qt.from_tty = from_tty;
1437
1438   /* We want to handle any quit errors and exit regardless.  */
1439
1440   /* Get out of tfind mode, and kill or detach all inferiors.  */
1441   TRY
1442     {
1443       disconnect_tracing ();
1444       iterate_over_inferiors (kill_or_detach, &qt);
1445     }
1446   CATCH (ex, RETURN_MASK_ALL)
1447     {
1448       exception_print (gdb_stderr, ex);
1449     }
1450   END_CATCH
1451
1452   /* Give all pushed targets a chance to do minimal cleanup, and pop
1453      them all out.  */
1454   TRY
1455     {
1456       pop_all_targets ();
1457     }
1458   CATCH (ex, RETURN_MASK_ALL)
1459     {
1460       exception_print (gdb_stderr, ex);
1461     }
1462   END_CATCH
1463
1464   /* Save the history information if it is appropriate to do so.  */
1465   TRY
1466     {
1467       if (write_history_p && history_filename
1468           && input_from_terminal_p ())
1469         gdb_safe_append_history ();
1470     }
1471   CATCH (ex, RETURN_MASK_ALL)
1472     {
1473       exception_print (gdb_stderr, ex);
1474     }
1475   END_CATCH
1476
1477   /* Do any final cleanups before exiting.  */
1478   TRY
1479     {
1480       do_final_cleanups (all_cleanups ());
1481     }
1482   CATCH (ex, RETURN_MASK_ALL)
1483     {
1484       exception_print (gdb_stderr, ex);
1485     }
1486   END_CATCH
1487
1488   exit (exit_code);
1489 }
1490
1491 /* Returns whether GDB is running on a terminal and input is
1492    currently coming from that terminal.  */
1493
1494 int
1495 input_from_terminal_p (void)
1496 {
1497   if (batch_flag)
1498     return 0;
1499
1500   if (gdb_has_a_terminal () && instream == stdin)
1501     return 1;
1502
1503   /* If INSTREAM is unset, and we are not in a user command, we
1504      must be in Insight.  That's like having a terminal, for our
1505      purposes.  */
1506   if (instream == NULL && !in_user_command)
1507     return 1;
1508
1509   return 0;
1510 }
1511 \f
1512 static void
1513 dont_repeat_command (char *ignored, int from_tty)
1514 {
1515   /* Can't call dont_repeat here because we're not necessarily reading
1516      from stdin.  */
1517   *saved_command_line = 0;
1518 }
1519 \f
1520 /* Functions to manipulate command line editing control variables.  */
1521
1522 /* Number of commands to print in each call to show_commands.  */
1523 #define Hist_print 10
1524 void
1525 show_commands (char *args, int from_tty)
1526 {
1527   /* Index for history commands.  Relative to history_base.  */
1528   int offset;
1529
1530   /* Number of the history entry which we are planning to display next.
1531      Relative to history_base.  */
1532   static int num = 0;
1533
1534   /* Print out some of the commands from the command history.  */
1535
1536   if (args)
1537     {
1538       if (args[0] == '+' && args[1] == '\0')
1539         /* "info editing +" should print from the stored position.  */
1540         ;
1541       else
1542         /* "info editing <exp>" should print around command number <exp>.  */
1543         num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1544     }
1545   /* "show commands" means print the last Hist_print commands.  */
1546   else
1547     {
1548       num = history_length - Hist_print;
1549     }
1550
1551   if (num < 0)
1552     num = 0;
1553
1554   /* If there are at least Hist_print commands, we want to display the last
1555      Hist_print rather than, say, the last 6.  */
1556   if (history_length - num < Hist_print)
1557     {
1558       num = history_length - Hist_print;
1559       if (num < 0)
1560         num = 0;
1561     }
1562
1563   for (offset = num;
1564        offset < num + Hist_print && offset < history_length;
1565        offset++)
1566     {
1567       printf_filtered ("%5d  %s\n", history_base + offset,
1568                        (history_get (history_base + offset))->line);
1569     }
1570
1571   /* The next command we want to display is the next one that we haven't
1572      displayed yet.  */
1573   num += Hist_print;
1574
1575   /* If the user repeats this command with return, it should do what
1576      "show commands +" does.  This is unnecessary if arg is null,
1577      because "show commands +" is not useful after "show commands".  */
1578   if (from_tty && args)
1579     {
1580       args[0] = '+';
1581       args[1] = '\0';
1582     }
1583 }
1584
1585 /* Update the size of our command history file to HISTORY_SIZE.
1586
1587    A HISTORY_SIZE of -1 stands for unlimited.  */
1588
1589 static void
1590 set_readline_history_size (int history_size)
1591 {
1592   gdb_assert (history_size >= -1);
1593
1594   if (history_size == -1)
1595     unstifle_history ();
1596   else
1597     stifle_history (history_size);
1598 }
1599
1600 /* Called by do_setshow_command.  */
1601 static void
1602 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1603 {
1604   set_readline_history_size (history_size_setshow_var);
1605 }
1606
1607 void
1608 set_history (char *args, int from_tty)
1609 {
1610   printf_unfiltered (_("\"set history\" must be followed "
1611                        "by the name of a history subcommand.\n"));
1612   help_list (sethistlist, "set history ", all_commands, gdb_stdout);
1613 }
1614
1615 void
1616 show_history (char *args, int from_tty)
1617 {
1618   cmd_show_list (showhistlist, from_tty, "");
1619 }
1620
1621 int info_verbose = 0;           /* Default verbose msgs off.  */
1622
1623 /* Called by do_setshow_command.  An elaborate joke.  */
1624 void
1625 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1626 {
1627   const char *cmdname = "verbose";
1628   struct cmd_list_element *showcmd;
1629
1630   showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1631   gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1632
1633   if (info_verbose)
1634     {
1635       c->doc = "Set verbose printing of informational messages.";
1636       showcmd->doc = "Show verbose printing of informational messages.";
1637     }
1638   else
1639     {
1640       c->doc = "Set verbosity.";
1641       showcmd->doc = "Show verbosity.";
1642     }
1643 }
1644
1645 /* Init the history buffer.  Note that we are called after the init file(s)
1646    have been read so that the user can change the history file via his
1647    .gdbinit file (for instance).  The GDBHISTFILE environment variable
1648    overrides all of this.  */
1649
1650 void
1651 init_history (void)
1652 {
1653   char *tmpenv;
1654
1655   tmpenv = getenv ("GDBHISTSIZE");
1656   if (tmpenv)
1657     {
1658       long var;
1659       int saved_errno;
1660       char *endptr;
1661
1662       tmpenv = skip_spaces (tmpenv);
1663       errno = 0;
1664       var = strtol (tmpenv, &endptr, 10);
1665       saved_errno = errno;
1666       endptr = skip_spaces (endptr);
1667
1668       /* If GDBHISTSIZE is non-numeric then ignore it.  If GDBHISTSIZE is the
1669          empty string, a negative number or a huge positive number (larger than
1670          INT_MAX) then set the history size to unlimited.  Otherwise set our
1671          history size to the number we have read.  This behavior is consistent
1672          with how bash handles HISTSIZE.  */
1673       if (*endptr != '\0')
1674         ;
1675       else if (*tmpenv == '\0'
1676                || var < 0
1677                || var > INT_MAX
1678                /* On targets where INT_MAX == LONG_MAX, we have to look at
1679                   errno after calling strtol to distinguish between a value that
1680                   is exactly INT_MAX and an overflowing value that was clamped
1681                   to INT_MAX.  */
1682                || (var == INT_MAX && saved_errno == ERANGE))
1683         history_size_setshow_var = -1;
1684       else
1685         history_size_setshow_var = var;
1686     }
1687
1688   /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1689      default.  */
1690   if (history_size_setshow_var == -2)
1691     history_size_setshow_var = 256;
1692
1693   set_readline_history_size (history_size_setshow_var);
1694
1695   tmpenv = getenv ("GDBHISTFILE");
1696   if (tmpenv)
1697     history_filename = xstrdup (tmpenv);
1698   else if (!history_filename)
1699     {
1700       /* We include the current directory so that if the user changes
1701          directories the file written will be the same as the one
1702          that was read.  */
1703 #ifdef __MSDOS__
1704       /* No leading dots in file names are allowed on MSDOS.  */
1705       history_filename = concat (current_directory, "/_gdb_history",
1706                                  (char *)NULL);
1707 #else
1708       history_filename = concat (current_directory, "/.gdb_history",
1709                                  (char *)NULL);
1710 #endif
1711     }
1712   read_history (history_filename);
1713 }
1714
1715 static void
1716 show_prompt (struct ui_file *file, int from_tty,
1717              struct cmd_list_element *c, const char *value)
1718 {
1719   fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1720 }
1721
1722 static void
1723 show_async_command_editing_p (struct ui_file *file, int from_tty,
1724                               struct cmd_list_element *c, const char *value)
1725 {
1726   fprintf_filtered (file, _("Editing of command lines as "
1727                             "they are typed is %s.\n"),
1728                     value);
1729 }
1730
1731 static void
1732 show_annotation_level (struct ui_file *file, int from_tty,
1733                        struct cmd_list_element *c, const char *value)
1734 {
1735   fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1736 }
1737
1738 static void
1739 show_exec_done_display_p (struct ui_file *file, int from_tty,
1740                           struct cmd_list_element *c, const char *value)
1741 {
1742   fprintf_filtered (file, _("Notification of completion for "
1743                             "asynchronous execution commands is %s.\n"),
1744                     value);
1745 }
1746
1747 /* New values of the "data-directory" parameter are staged here.  */
1748 static char *staged_gdb_datadir;
1749
1750 /* "set" command for the gdb_datadir configuration variable.  */
1751
1752 static void
1753 set_gdb_datadir (char *args, int from_tty, struct cmd_list_element *c)
1754 {
1755   set_gdb_data_directory (staged_gdb_datadir);
1756   observer_notify_gdb_datadir_changed ();
1757 }
1758
1759 /* "show" command for the gdb_datadir configuration variable.  */
1760
1761 static void
1762 show_gdb_datadir (struct ui_file *file, int from_tty,
1763                   struct cmd_list_element *c, const char *value)
1764 {
1765   fprintf_filtered (file, _("GDB's data directory is \"%s\".\n"),
1766                     gdb_datadir);
1767 }
1768
1769 static void
1770 set_history_filename (char *args, int from_tty, struct cmd_list_element *c)
1771 {
1772   /* We include the current directory so that if the user changes
1773      directories the file written will be the same as the one
1774      that was read.  */
1775   if (!IS_ABSOLUTE_PATH (history_filename))
1776     history_filename = reconcat (history_filename, current_directory, "/", 
1777                                  history_filename, (char *) NULL);
1778 }
1779
1780 static void
1781 init_main (void)
1782 {
1783   /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1784      the DEFAULT_PROMPT is.  */
1785   set_prompt (DEFAULT_PROMPT);
1786
1787   /* Set the important stuff up for command editing.  */
1788   command_editing_p = 1;
1789   history_expansion_p = 0;
1790   write_history_p = 0;
1791
1792   /* Setup important stuff for command line editing.  */
1793   rl_completion_word_break_hook = gdb_completion_word_break_characters;
1794   rl_completion_entry_function = readline_line_completion_function;
1795   rl_completer_word_break_characters = default_word_break_characters ();
1796   rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1797   rl_completion_display_matches_hook = cli_display_match_list;
1798   rl_readline_name = "gdb";
1799   rl_terminal_name = getenv ("TERM");
1800
1801   /* The name for this defun comes from Bash, where it originated.
1802      15 is Control-o, the same binding this function has in Bash.  */
1803   rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1804
1805   add_setshow_string_cmd ("prompt", class_support,
1806                           &top_prompt,
1807                           _("Set gdb's prompt"),
1808                           _("Show gdb's prompt"),
1809                           NULL, NULL,
1810                           show_prompt,
1811                           &setlist, &showlist);
1812
1813   add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1814 Don't repeat this command.\nPrimarily \
1815 used inside of user-defined commands that should not be repeated when\n\
1816 hitting return."));
1817
1818   add_setshow_boolean_cmd ("editing", class_support,
1819                            &async_command_editing_p, _("\
1820 Set editing of command lines as they are typed."), _("\
1821 Show editing of command lines as they are typed."), _("\
1822 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1823 Without an argument, command line editing is enabled.  To edit, use\n\
1824 EMACS-like or VI-like commands like control-P or ESC."),
1825                            set_async_editing_command,
1826                            show_async_command_editing_p,
1827                            &setlist, &showlist);
1828
1829   add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
1830 Set saving of the history record on exit."), _("\
1831 Show saving of the history record on exit."), _("\
1832 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1833 Without an argument, saving is enabled."),
1834                            NULL,
1835                            show_write_history_p,
1836                            &sethistlist, &showhistlist);
1837
1838   add_setshow_zuinteger_unlimited_cmd ("size", no_class,
1839                                        &history_size_setshow_var, _("\
1840 Set the size of the command history,"), _("\
1841 Show the size of the command history,"), _("\
1842 ie. the number of previous commands to keep a record of.\n\
1843 If set to \"unlimited\", the number of commands kept in the history\n\
1844 list is unlimited.  This defaults to the value of the environment\n\
1845 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
1846                             set_history_size_command,
1847                             show_history_size,
1848                             &sethistlist, &showhistlist);
1849
1850   add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
1851                                        &history_remove_duplicates, _("\
1852 Set how far back in history to look for and remove duplicate entries."), _("\
1853 Show how far back in history to look for and remove duplicate entries."), _("\
1854 If set to a nonzero value N, GDB will look back at the last N history entries\n\
1855 and remove the first history entry that is a duplicate of the most recent\n\
1856 entry, each time a new history entry is added.\n\
1857 If set to \"unlimited\", this lookbehind is unbounded.\n\
1858 Only history entries added during this session are considered for removal.\n\
1859 If set to 0, removal of duplicate history entries is disabled.\n\
1860 By default this option is set to 0."),
1861                            NULL,
1862                            show_history_remove_duplicates,
1863                            &sethistlist, &showhistlist);
1864
1865   add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
1866 Set the filename in which to record the command history"), _("\
1867 Show the filename in which to record the command history"), _("\
1868 (the list of previous commands of which a record is kept)."),
1869                             set_history_filename,
1870                             show_history_filename,
1871                             &sethistlist, &showhistlist);
1872
1873   add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
1874 Set whether to confirm potentially dangerous operations."), _("\
1875 Show whether to confirm potentially dangerous operations."), NULL,
1876                            NULL,
1877                            show_confirm,
1878                            &setlist, &showlist);
1879
1880   add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
1881 Set annotation_level."), _("\
1882 Show annotation_level."), _("\
1883 0 == normal;     1 == fullname (for use when running under emacs)\n\
1884 2 == output annotated suitably for use by programs that control GDB."),
1885                             NULL,
1886                             show_annotation_level,
1887                             &setlist, &showlist);
1888
1889   add_setshow_boolean_cmd ("exec-done-display", class_support,
1890                            &exec_done_display_p, _("\
1891 Set notification of completion for asynchronous execution commands."), _("\
1892 Show notification of completion for asynchronous execution commands."), _("\
1893 Use \"on\" to enable the notification, and \"off\" to disable it."),
1894                            NULL,
1895                            show_exec_done_display_p,
1896                            &setlist, &showlist);
1897
1898   add_setshow_filename_cmd ("data-directory", class_maintenance,
1899                            &staged_gdb_datadir, _("Set GDB's data directory."),
1900                            _("Show GDB's data directory."),
1901                            _("\
1902 When set, GDB uses the specified path to search for data files."),
1903                            set_gdb_datadir, show_gdb_datadir,
1904                            &setlist,
1905                            &showlist);
1906 }
1907
1908 void
1909 gdb_init (char *argv0)
1910 {
1911   if (pre_init_ui_hook)
1912     pre_init_ui_hook ();
1913
1914   /* Run the init function of each source file.  */
1915
1916 #ifdef __MSDOS__
1917   /* Make sure we return to the original directory upon exit, come
1918      what may, since the OS doesn't do that for us.  */
1919   make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
1920 #endif
1921
1922   init_cmd_lists ();        /* This needs to be done first.  */
1923   initialize_targets ();    /* Setup target_terminal macros for utils.c.  */
1924   initialize_utils ();      /* Make errors and warnings possible.  */
1925
1926   init_page_info ();
1927
1928   /* Here is where we call all the _initialize_foo routines.  */
1929   initialize_all_files ();
1930
1931   /* This creates the current_program_space.  Do this after all the
1932      _initialize_foo routines have had a chance to install their
1933      per-sspace data keys.  Also do this before
1934      initialize_current_architecture is called, because it accesses
1935      exec_bfd of the current program space.  */
1936   initialize_progspace ();
1937   initialize_inferiors ();
1938   initialize_current_architecture ();
1939   init_cli_cmds();
1940   init_main ();                 /* But that omits this file!  Do it now.  */
1941
1942   initialize_stdin_serial ();
1943
1944   /* Take a snapshot of our tty state before readline/ncurses have had a chance
1945      to alter it.  */
1946   set_initial_gdb_ttystate ();
1947
1948   async_init_signals ();
1949
1950   /* We need a default language for parsing expressions, so simple
1951      things like "set width 0" won't fail if no language is explicitly
1952      set in a config file or implicitly set by reading an executable
1953      during startup.  */
1954   set_language (language_c);
1955   expected_language = current_language; /* Don't warn about the change.  */
1956
1957   /* Python initialization, for example, can require various commands to be
1958      installed.  For example "info pretty-printer" needs the "info"
1959      prefix to be installed.  Keep things simple and just do final
1960      script initialization here.  */
1961   finish_ext_lang_initialization ();
1962 }