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