2011-07-22 Phil Muldoon <pmuldoon@redhat.com>
[external/binutils.git] / gdb / event-top.c
1 /* Top level stuff for GDB, the GNU debugger.
2
3    Copyright (C) 1999, 2000, 2001, 2002, 2004, 2005, 2007, 2008, 2009, 2010,
4    2011 Free Software Foundation, Inc.
5
6    Written by Elena Zannoni <ezannoni@cygnus.com> of Cygnus Solutions.
7
8    This file is part of GDB.
9
10    This program is free software; you can redistribute it and/or modify
11    it under the terms of the GNU General Public License as published by
12    the Free Software Foundation; either version 3 of the License, or
13    (at your option) any later version.
14
15    This program is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
22
23 #include "defs.h"
24 #include "top.h"
25 #include "inferior.h"
26 #include "target.h"
27 #include "terminal.h"           /* for job_control */
28 #include "event-loop.h"
29 #include "event-top.h"
30 #include "interps.h"
31 #include <signal.h>
32 #include "exceptions.h"
33 #include "cli/cli-script.h"     /* for reset_command_nest_depth */
34 #include "main.h"
35 #include "gdbthread.h"
36 #include "observer.h"
37 #include "continuations.h"
38 #include "gdbcmd.h"             /* for dont_repeat() */
39
40 /* readline include files.  */
41 #include "readline/readline.h"
42 #include "readline/history.h"
43
44 /* readline defines this.  */
45 #undef savestring
46
47 static void rl_callback_read_char_wrapper (gdb_client_data client_data);
48 static void command_line_handler (char *rl);
49 static void change_line_handler (void);
50 static void change_annotation_level (void);
51 static void command_handler (char *command);
52
53 /* Signal handlers.  */
54 #ifdef SIGQUIT
55 static void handle_sigquit (int sig);
56 #endif
57 #ifdef SIGHUP
58 static void handle_sighup (int sig);
59 #endif
60 static void handle_sigfpe (int sig);
61 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
62 static void handle_sigwinch (int sig);
63 #endif
64
65 /* Functions to be invoked by the event loop in response to
66    signals.  */
67 #if defined (SIGQUIT) || defined (SIGHUP)
68 static void async_do_nothing (gdb_client_data);
69 #endif
70 #ifdef SIGHUP
71 static void async_disconnect (gdb_client_data);
72 #endif
73 static void async_float_handler (gdb_client_data);
74 #ifdef STOP_SIGNAL
75 static void async_stop_sig (gdb_client_data);
76 #endif
77
78 /* Readline offers an alternate interface, via callback
79    functions.  These are all included in the file callback.c in the
80    readline distribution.  This file provides (mainly) a function, which
81    the event loop uses as callback (i.e. event handler) whenever an event
82    is detected on the standard input file descriptor.
83    readline_callback_read_char is called (by the GDB event loop) whenever
84    there is a new character ready on the input stream.  This function
85    incrementally builds a buffer internal to readline where it
86    accumulates the line read up to the point of invocation.  In the
87    special case in which the character read is newline, the function
88    invokes a GDB supplied callback routine, which does the processing of
89    a full command line.  This latter routine is the asynchronous analog
90    of the old command_line_input in gdb.  Instead of invoking (and waiting
91    for) readline to read the command line and pass it back to
92    command_loop for processing, the new command_line_handler function has
93    the command line already available as its parameter.  INPUT_HANDLER is
94    to be set to the function that readline will invoke when a complete
95    line of input is ready.  CALL_READLINE is to be set to the function
96    that readline offers as callback to the event_loop.  */
97
98 void (*input_handler) (char *);
99 void (*call_readline) (gdb_client_data);
100
101 /* Important variables for the event loop.  */
102
103 /* This is used to determine if GDB is using the readline library or
104    its own simplified form of readline.  It is used by the asynchronous
105    form of the set editing command.
106    ezannoni: as of 1999-04-29 I expect that this
107    variable will not be used after gdb is changed to use the event
108    loop as default engine, and event-top.c is merged into top.c.  */
109 int async_command_editing_p;
110
111 /* This variable contains the new prompt that the user sets with the
112    set prompt command.  */
113 char *new_async_prompt;
114
115 /* This is the annotation suffix that will be used when the
116    annotation_level is 2.  */
117 char *async_annotation_suffix;
118
119 /* This is used to display the notification of the completion of an
120    asynchronous execution command.  */
121 int exec_done_display_p = 0;
122
123 /* This is the file descriptor for the input stream that GDB uses to
124    read commands from.  */
125 int input_fd;
126
127 /* This is the prompt stack.  Prompts will be pushed on the stack as
128    needed by the different 'kinds' of user inputs GDB is asking
129    for.  See event-loop.h.  */
130 struct prompts the_prompts;
131
132 /* Signal handling variables.  */
133 /* Each of these is a pointer to a function that the event loop will
134    invoke if the corresponding signal has received.  The real signal
135    handlers mark these functions as ready to be executed and the event
136    loop, in a later iteration, calls them.  See the function
137    invoke_async_signal_handler.  */
138 void *sigint_token;
139 #ifdef SIGHUP
140 void *sighup_token;
141 #endif
142 #ifdef SIGQUIT
143 void *sigquit_token;
144 #endif
145 void *sigfpe_token;
146 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
147 void *sigwinch_token;
148 #endif
149 #ifdef STOP_SIGNAL
150 void *sigtstp_token;
151 #endif
152
153 /* Structure to save a partially entered command.  This is used when
154    the user types '\' at the end of a command line.  This is necessary
155    because each line of input is handled by a different call to
156    command_line_handler, and normally there is no state retained
157    between different calls.  */
158 int more_to_come = 0;
159
160 struct readline_input_state
161   {
162     char *linebuffer;
163     char *linebuffer_ptr;
164   }
165 readline_input_state;
166
167 /* This hook is called by rl_callback_read_char_wrapper after each
168    character is processed.  */
169 void (*after_char_processing_hook) (void);
170 \f
171
172 /* Wrapper function for calling into the readline library.  The event
173    loop expects the callback function to have a paramter, while
174    readline expects none.  */
175 static void
176 rl_callback_read_char_wrapper (gdb_client_data client_data)
177 {
178   rl_callback_read_char ();
179   if (after_char_processing_hook)
180     (*after_char_processing_hook) ();
181 }
182
183 /* Initialize all the necessary variables, start the event loop,
184    register readline, and stdin, start the loop.  */
185 void
186 cli_command_loop (void)
187 {
188   /* If we are using readline, set things up and display the first
189      prompt, otherwise just print the prompt.  */
190   if (async_command_editing_p)
191     {
192       int length;
193       char *a_prompt;
194       char *gdb_prompt = get_prompt (0);
195
196       /* Tell readline what the prompt to display is and what function
197          it will need to call after a whole line is read.  This also
198          displays the first prompt.  */
199       length = strlen (get_prefix (0))
200         + strlen (gdb_prompt) + strlen (get_suffix(0)) + 1;
201       a_prompt = (char *) alloca (length);
202       strcpy (a_prompt, get_prefix (0));
203       strcat (a_prompt, gdb_prompt);
204       strcat (a_prompt, get_suffix (0));
205       rl_callback_handler_install (a_prompt, input_handler);
206     }
207   else
208     display_gdb_prompt (0);
209
210   /* Now it's time to start the event loop.  */
211   start_event_loop ();
212 }
213
214 /* Change the function to be invoked every time there is a character
215    ready on stdin.  This is used when the user sets the editing off,
216    therefore bypassing readline, and letting gdb handle the input
217    itself, via gdb_readline2.  Also it is used in the opposite case in
218    which the user sets editing on again, by restoring readline
219    handling of the input.  */
220 static void
221 change_line_handler (void)
222 {
223   /* NOTE: this operates on input_fd, not instream.  If we are reading
224      commands from a file, instream will point to the file.  However in
225      async mode, we always read commands from a file with editing
226      off.  This means that the 'set editing on/off' will have effect
227      only on the interactive session.  */
228
229   if (async_command_editing_p)
230     {
231       /* Turn on editing by using readline.  */
232       call_readline = rl_callback_read_char_wrapper;
233       input_handler = command_line_handler;
234     }
235   else
236     {
237       /* Turn off editing by using gdb_readline2.  */
238       rl_callback_handler_remove ();
239       call_readline = gdb_readline2;
240
241       /* Set up the command handler as well, in case we are called as
242          first thing from .gdbinit.  */
243       input_handler = command_line_handler;
244     }
245 }
246
247 /* Displays the prompt. The prompt that is displayed is the current
248    top of the prompt stack, if the argument NEW_PROMPT is
249    0. Otherwise, it displays whatever NEW_PROMPT is.  This is used
250    after each gdb command has completed, and in the following cases:
251    1. When the user enters a command line which is ended by '\'
252    indicating that the command will continue on the next line.
253    In that case the prompt that is displayed is the empty string.
254    2. When the user is entering 'commands' for a breakpoint, or
255    actions for a tracepoint.  In this case the prompt will be '>'
256    3. Other????
257    FIXME: 2. & 3. not implemented yet for async.  */
258 void
259 display_gdb_prompt (char *new_prompt)
260 {
261   int prompt_length = 0;
262   char *actual_gdb_prompt = NULL;
263
264   /* Reset the nesting depth used when trace-commands is set.  */
265   reset_command_nest_depth ();
266
267   /* Each interpreter has its own rules on displaying the command
268      prompt.  */
269   if (!current_interp_display_prompt_p ())
270     return;
271
272   /* Get the prompt before the observers are called as observer hook
273      functions may change the prompt.  Do not call observers on an
274      explicit prompt change as passed to this function, as this forms
275      a temporary prompt, IE, displayed but not set.  */
276   if (! new_prompt)
277     {
278       char *post_gdb_prompt = NULL;
279       char *pre_gdb_prompt = xstrdup (get_prompt (0));
280
281       observer_notify_before_prompt (pre_gdb_prompt);
282       post_gdb_prompt = get_prompt (0);
283
284       /* If the observer changed the prompt, use that prompt.  */
285       if (strcmp (pre_gdb_prompt, post_gdb_prompt) != 0)
286         actual_gdb_prompt = post_gdb_prompt;
287
288       xfree (pre_gdb_prompt);
289     }
290
291   if (sync_execution && is_running (inferior_ptid))
292     {
293       /* This is to trick readline into not trying to display the
294          prompt.  Even though we display the prompt using this
295          function, readline still tries to do its own display if we
296          don't call rl_callback_handler_install and
297          rl_callback_handler_remove (which readline detects because a
298          global variable is not set).  If readline did that, it could
299          mess up gdb signal handlers for SIGINT.  Readline assumes
300          that between calls to rl_set_signals and rl_clear_signals gdb
301          doesn't do anything with the signal handlers.  Well, that's
302          not the case, because when the target executes we change the
303          SIGINT signal handler.  If we allowed readline to display the
304          prompt, the signal handler change would happen exactly
305          between the calls to the above two functions.
306          Calling rl_callback_handler_remove(), does the job.  */
307
308       rl_callback_handler_remove ();
309       return;
310     }
311
312   /* If the observer changed the prompt, ACTUAL_GDB_PROMPT will not be
313      NULL.  Otherwise, either copy the existing prompt, or set it to
314      NEW_PROMPT.  */
315   if (! actual_gdb_prompt)
316     {
317       if (! new_prompt)
318         {
319           /* Just use the top of the prompt stack.  */
320           prompt_length = strlen (get_prefix (0)) +
321             strlen (get_suffix (0)) +
322             strlen (get_prompt (0)) + 1;
323
324           actual_gdb_prompt = (char *) alloca (prompt_length);
325
326           /* Prefix needs to have new line at end.  */
327           strcpy (actual_gdb_prompt, get_prefix (0));
328           strcat (actual_gdb_prompt, get_prompt (0));
329           /* Suffix needs to have a new line at end and \032 \032 at
330              beginning.  */
331           strcat (actual_gdb_prompt, get_suffix (0));
332         }
333       else
334         actual_gdb_prompt = new_prompt;;
335     }
336
337   if (async_command_editing_p)
338     {
339       rl_callback_handler_remove ();
340       rl_callback_handler_install (actual_gdb_prompt, input_handler);
341     }
342   /* new_prompt at this point can be the top of the stack or the one
343      passed in.  It can't be NULL.  */
344   else
345     {
346       /* Don't use a _filtered function here.  It causes the assumed
347          character position to be off, since the newline we read from
348          the user is not accounted for.  */
349       fputs_unfiltered (actual_gdb_prompt, gdb_stdout);
350       gdb_flush (gdb_stdout);
351     }
352 }
353
354 /* Used when the user requests a different annotation level, with
355    'set annotate'.  It pushes a new prompt (with prefix and suffix) on top
356    of the prompt stack, if the annotation level desired is 2, otherwise
357    it pops the top of the prompt stack when we want the annotation level
358    to be the normal ones (1 or 0).  */
359 static void
360 change_annotation_level (void)
361 {
362   char *prefix, *suffix;
363
364   if (!get_prefix (0) || !get_prompt (0) || !get_suffix (0))
365     {
366       /* The prompt stack has not been initialized to "", we are
367          using gdb w/o the --async switch.  */
368       warning (_("Command has same effect as set annotate"));
369       return;
370     }
371
372   if (annotation_level > 1)
373     {
374       if (!strcmp (get_prefix (0), "") && !strcmp (get_suffix (0), ""))
375         {
376           /* Push a new prompt if the previous annotation_level was not >1.  */
377           prefix = (char *) alloca (strlen (async_annotation_suffix) + 10);
378           strcpy (prefix, "\n\032\032pre-");
379           strcat (prefix, async_annotation_suffix);
380           strcat (prefix, "\n");
381
382           suffix = (char *) alloca (strlen (async_annotation_suffix) + 6);
383           strcpy (suffix, "\n\032\032");
384           strcat (suffix, async_annotation_suffix);
385           strcat (suffix, "\n");
386
387           push_prompt (prefix, (char *) 0, suffix);
388         }
389     }
390   else
391     {
392       if (strcmp (get_prefix (0), "") && strcmp (get_suffix (0), ""))
393         {
394           /* Pop the top of the stack, we are going back to annotation < 1.  */
395           pop_prompt ();
396         }
397     }
398 }
399
400 /* Pushes a new prompt on the prompt stack.  Each prompt has three
401    parts: prefix, prompt, suffix.  Usually prefix and suffix are empty
402    strings, except when the annotation level is 2.  Memory is allocated
403    within xstrdup for the new prompt.  */
404 void
405 push_prompt (char *prefix, char *prompt, char *suffix)
406 {
407   the_prompts.top++;
408   set_prefix (prefix, 0);
409
410   /* Note that this function is used by the set annotate 2
411      command.  This is why we take care of saving the old prompt
412      in case a new one is not specified.  */
413   if (prompt)
414     set_prompt (prompt, 0);
415   else
416     set_prompt (get_prompt (-1), 0);
417
418   set_suffix (suffix, 0);
419 }
420
421 /* Pops the top of the prompt stack, and frees the memory allocated
422    for it.  */
423 void
424 pop_prompt (void)
425 {
426   /* If we are not during a 'synchronous' execution command, in which
427      case, the top prompt would be empty.  */
428   if (strcmp (get_prompt (0), ""))
429     /* This is for the case in which the prompt is set while the
430        annotation level is 2.  The top prompt will be changed, but when
431        we return to annotation level < 2, we want that new prompt to be
432        in effect, until the user does another 'set prompt'.  */
433     if (strcmp (get_prompt (0), get_prompt (-1)))
434       set_prompt (get_prompt (0), -1);
435
436   set_prefix (NULL, 0);
437   set_prompt (NULL, 0);
438   set_suffix (NULL, 0);
439   the_prompts.top--;
440 }
441
442 /* When there is an event ready on the stdin file desriptor, instead
443    of calling readline directly throught the callback function, or
444    instead of calling gdb_readline2, give gdb a chance to detect
445    errors and do something.  */
446 void
447 stdin_event_handler (int error, gdb_client_data client_data)
448 {
449   if (error)
450     {
451       printf_unfiltered (_("error detected on stdin\n"));
452       delete_file_handler (input_fd);
453       discard_all_continuations ();
454       discard_all_intermediate_continuations ();
455       /* If stdin died, we may as well kill gdb.  */
456       quit_command ((char *) 0, stdin == instream);
457     }
458   else
459     (*call_readline) (client_data);
460 }
461
462 /* Re-enable stdin after the end of an execution command in
463    synchronous mode, or after an error from the target, and we aborted
464    the exec operation.  */
465
466 void
467 async_enable_stdin (void)
468 {
469   if (sync_execution)
470     {
471       /* See NOTE in async_disable_stdin().  */
472       /* FIXME: cagney/1999-09-27: Call this before clearing
473          sync_execution.  Current target_terminal_ours() implementations
474          check for sync_execution before switching the terminal.  */
475       target_terminal_ours ();
476       pop_prompt ();
477       sync_execution = 0;
478     }
479 }
480
481 /* Disable reads from stdin (the console) marking the command as
482    synchronous.  */
483
484 void
485 async_disable_stdin (void)
486 {
487   if (!sync_execution)
488     {
489       sync_execution = 1;
490       push_prompt ("", "", "");
491     }
492 }
493 \f
494
495 /* Handles a gdb command.  This function is called by
496    command_line_handler, which has processed one or more input lines
497    into COMMAND.  */
498 /* NOTE: 1999-04-30 This is the asynchronous version of the command_loop
499    function.  The command_loop function will be obsolete when we
500    switch to use the event loop at every execution of gdb.  */
501 static void
502 command_handler (char *command)
503 {
504   int stdin_is_tty = ISATTY (stdin);
505   struct cleanup *stat_chain;
506
507   quit_flag = 0;
508   if (instream == stdin && stdin_is_tty)
509     reinitialize_more_filter ();
510
511   /* If readline returned a NULL command, it means that the connection
512      with the terminal is gone.  This happens at the end of a
513      testsuite run, after Expect has hung up but GDB is still alive.
514      In such a case, we just quit gdb killing the inferior program
515      too.  */
516   if (command == 0)
517     {
518       printf_unfiltered ("quit\n");
519       execute_command ("quit", stdin == instream);
520     }
521
522   stat_chain = make_command_stats_cleanup (1);
523
524   execute_command (command, instream == stdin);
525
526   /* Do any commands attached to breakpoint we stopped at.  */
527   bpstat_do_actions ();
528
529   do_cleanups (stat_chain);
530 }
531
532 /* Handle a complete line of input.  This is called by the callback
533    mechanism within the readline library.  Deal with incomplete
534    commands as well, by saving the partial input in a global
535    buffer.  */
536
537 /* NOTE: 1999-04-30 This is the asynchronous version of the
538    command_line_input function; command_line_input will become
539    obsolete once we use the event loop as the default mechanism in
540    GDB.  */
541 static void
542 command_line_handler (char *rl)
543 {
544   static char *linebuffer = 0;
545   static unsigned linelength = 0;
546   char *p;
547   char *p1;
548   char *nline;
549   char got_eof = 0;
550
551   int repeat = (instream == stdin);
552
553   if (annotation_level > 1 && instream == stdin)
554     {
555       printf_unfiltered (("\n\032\032post-"));
556       puts_unfiltered (async_annotation_suffix);
557       printf_unfiltered (("\n"));
558     }
559
560   if (linebuffer == 0)
561     {
562       linelength = 80;
563       linebuffer = (char *) xmalloc (linelength);
564     }
565
566   p = linebuffer;
567
568   if (more_to_come)
569     {
570       strcpy (linebuffer, readline_input_state.linebuffer);
571       p = readline_input_state.linebuffer_ptr;
572       xfree (readline_input_state.linebuffer);
573       more_to_come = 0;
574       pop_prompt ();
575     }
576
577 #ifdef STOP_SIGNAL
578   if (job_control)
579     signal (STOP_SIGNAL, handle_stop_sig);
580 #endif
581
582   /* Make sure that all output has been output.  Some machines may let
583      you get away with leaving out some of the gdb_flush, but not
584      all.  */
585   wrap_here ("");
586   gdb_flush (gdb_stdout);
587   gdb_flush (gdb_stderr);
588
589   if (source_file_name != NULL)
590     ++source_line_number;
591
592   /* If we are in this case, then command_handler will call quit 
593      and exit from gdb.  */
594   if (!rl || rl == (char *) EOF)
595     {
596       got_eof = 1;
597       command_handler (0);
598       return;                   /* Lint.  */
599     }
600   if (strlen (rl) + 1 + (p - linebuffer) > linelength)
601     {
602       linelength = strlen (rl) + 1 + (p - linebuffer);
603       nline = (char *) xrealloc (linebuffer, linelength);
604       p += nline - linebuffer;
605       linebuffer = nline;
606     }
607   p1 = rl;
608   /* Copy line.  Don't copy null at end.  (Leaves line alone
609      if this was just a newline).  */
610   while (*p1)
611     *p++ = *p1++;
612
613   xfree (rl);                   /* Allocated in readline.  */
614
615   if (p > linebuffer && *(p - 1) == '\\')
616     {
617       *p = '\0';
618       p--;                      /* Put on top of '\'.  */
619
620       readline_input_state.linebuffer = xstrdup (linebuffer);
621       readline_input_state.linebuffer_ptr = p;
622
623       /* We will not invoke a execute_command if there is more
624          input expected to complete the command.  So, we need to
625          print an empty prompt here.  */
626       more_to_come = 1;
627       push_prompt ("", "", "");
628       display_gdb_prompt (0);
629       return;
630     }
631
632 #ifdef STOP_SIGNAL
633   if (job_control)
634     signal (STOP_SIGNAL, SIG_DFL);
635 #endif
636
637 #define SERVER_COMMAND_LENGTH 7
638   server_command =
639     (p - linebuffer > SERVER_COMMAND_LENGTH)
640     && strncmp (linebuffer, "server ", SERVER_COMMAND_LENGTH) == 0;
641   if (server_command)
642     {
643       /* Note that we don't set `line'.  Between this and the check in
644          dont_repeat, this insures that repeating will still do the
645          right thing.  */
646       *p = '\0';
647       command_handler (linebuffer + SERVER_COMMAND_LENGTH);
648       display_gdb_prompt (0);
649       return;
650     }
651
652   /* Do history expansion if that is wished.  */
653   if (history_expansion_p && instream == stdin
654       && ISATTY (instream))
655     {
656       char *history_value;
657       int expanded;
658
659       *p = '\0';                /* Insert null now.  */
660       expanded = history_expand (linebuffer, &history_value);
661       if (expanded)
662         {
663           /* Print the changes.  */
664           printf_unfiltered ("%s\n", history_value);
665
666           /* If there was an error, call this function again.  */
667           if (expanded < 0)
668             {
669               xfree (history_value);
670               return;
671             }
672           if (strlen (history_value) > linelength)
673             {
674               linelength = strlen (history_value) + 1;
675               linebuffer = (char *) xrealloc (linebuffer, linelength);
676             }
677           strcpy (linebuffer, history_value);
678           p = linebuffer + strlen (linebuffer);
679         }
680       xfree (history_value);
681     }
682
683   /* If we just got an empty line, and that is supposed to repeat the
684      previous command, return the value in the global buffer.  */
685   if (repeat && p == linebuffer && *p != '\\')
686     {
687       command_handler (saved_command_line);
688       display_gdb_prompt (0);
689       return;
690     }
691
692   for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
693   if (repeat && !*p1)
694     {
695       command_handler (saved_command_line);
696       display_gdb_prompt (0);
697       return;
698     }
699
700   *p = 0;
701
702   /* Add line to history if appropriate.  */
703   if (instream == stdin
704       && ISATTY (stdin) && *linebuffer)
705     add_history (linebuffer);
706
707   /* Note: lines consisting solely of comments are added to the command
708      history.  This is useful when you type a command, and then
709      realize you don't want to execute it quite yet.  You can comment
710      out the command and then later fetch it from the value history
711      and remove the '#'.  The kill ring is probably better, but some
712      people are in the habit of commenting things out.  */
713   if (*p1 == '#')
714     *p1 = '\0';                 /* Found a comment.  */
715
716   /* Save into global buffer if appropriate.  */
717   if (repeat)
718     {
719       if (linelength > saved_command_line_size)
720         {
721           saved_command_line = xrealloc (saved_command_line, linelength);
722           saved_command_line_size = linelength;
723         }
724       strcpy (saved_command_line, linebuffer);
725       if (!more_to_come)
726         {
727           command_handler (saved_command_line);
728           display_gdb_prompt (0);
729         }
730       return;
731     }
732
733   command_handler (linebuffer);
734   display_gdb_prompt (0);
735   return;
736 }
737
738 /* Does reading of input from terminal w/o the editing features
739    provided by the readline library.  */
740
741 /* NOTE: 1999-04-30 Asynchronous version of gdb_readline; gdb_readline
742    will become obsolete when the event loop is made the default
743    execution for gdb.  */
744 void
745 gdb_readline2 (gdb_client_data client_data)
746 {
747   int c;
748   char *result;
749   int input_index = 0;
750   int result_size = 80;
751   static int done_once = 0;
752
753   /* Unbuffer the input stream, so that, later on, the calls to fgetc
754      fetch only one char at the time from the stream.  The fgetc's will
755      get up to the first newline, but there may be more chars in the
756      stream after '\n'.  If we buffer the input and fgetc drains the
757      stream, getting stuff beyond the newline as well, a select, done
758      afterwards will not trigger.  */
759   if (!done_once && !ISATTY (instream))
760     {
761       setbuf (instream, NULL);
762       done_once = 1;
763     }
764
765   result = (char *) xmalloc (result_size);
766
767   /* We still need the while loop here, even though it would seem
768      obvious to invoke gdb_readline2 at every character entered.  If
769      not using the readline library, the terminal is in cooked mode,
770      which sends the characters all at once.  Poll will notice that the
771      input fd has changed state only after enter is pressed.  At this
772      point we still need to fetch all the chars entered.  */
773
774   while (1)
775     {
776       /* Read from stdin if we are executing a user defined command.
777          This is the right thing for prompt_for_continue, at least.  */
778       c = fgetc (instream ? instream : stdin);
779
780       if (c == EOF)
781         {
782           if (input_index > 0)
783             /* The last line does not end with a newline.  Return it,
784                and if we are called again fgetc will still return EOF
785                and we'll return NULL then.  */
786             break;
787           xfree (result);
788           (*input_handler) (0);
789           return;
790         }
791
792       if (c == '\n')
793         {
794           if (input_index > 0 && result[input_index - 1] == '\r')
795             input_index--;
796           break;
797         }
798
799       result[input_index++] = c;
800       while (input_index >= result_size)
801         {
802           result_size *= 2;
803           result = (char *) xrealloc (result, result_size);
804         }
805     }
806
807   result[input_index++] = '\0';
808   (*input_handler) (result);
809 }
810 \f
811
812 /* Initialization of signal handlers and tokens.  There is a function
813    handle_sig* for each of the signals GDB cares about.  Specifically:
814    SIGINT, SIGFPE, SIGQUIT, SIGTSTP, SIGHUP, SIGWINCH.  These
815    functions are the actual signal handlers associated to the signals
816    via calls to signal().  The only job for these functions is to
817    enqueue the appropriate event/procedure with the event loop.  Such
818    procedures are the old signal handlers.  The event loop will take
819    care of invoking the queued procedures to perform the usual tasks
820    associated with the reception of the signal.  */
821 /* NOTE: 1999-04-30 This is the asynchronous version of init_signals.
822    init_signals will become obsolete as we move to have to event loop
823    as the default for gdb.  */
824 void
825 async_init_signals (void)
826 {
827   signal (SIGINT, handle_sigint);
828   sigint_token =
829     create_async_signal_handler (async_request_quit, NULL);
830   signal (SIGTERM, handle_sigterm);
831
832   /* If SIGTRAP was set to SIG_IGN, then the SIG_IGN will get passed
833      to the inferior and breakpoints will be ignored.  */
834 #ifdef SIGTRAP
835   signal (SIGTRAP, SIG_DFL);
836 #endif
837
838 #ifdef SIGQUIT
839   /* If we initialize SIGQUIT to SIG_IGN, then the SIG_IGN will get
840      passed to the inferior, which we don't want.  It would be
841      possible to do a "signal (SIGQUIT, SIG_DFL)" after we fork, but
842      on BSD4.3 systems using vfork, that can affect the
843      GDB process as well as the inferior (the signal handling tables
844      might be in memory, shared between the two).  Since we establish
845      a handler for SIGQUIT, when we call exec it will set the signal
846      to SIG_DFL for us.  */
847   signal (SIGQUIT, handle_sigquit);
848   sigquit_token =
849     create_async_signal_handler (async_do_nothing, NULL);
850 #endif
851 #ifdef SIGHUP
852   if (signal (SIGHUP, handle_sighup) != SIG_IGN)
853     sighup_token =
854       create_async_signal_handler (async_disconnect, NULL);
855   else
856     sighup_token =
857       create_async_signal_handler (async_do_nothing, NULL);
858 #endif
859   signal (SIGFPE, handle_sigfpe);
860   sigfpe_token =
861     create_async_signal_handler (async_float_handler, NULL);
862
863 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
864   signal (SIGWINCH, handle_sigwinch);
865   sigwinch_token =
866     create_async_signal_handler (SIGWINCH_HANDLER, NULL);
867 #endif
868 #ifdef STOP_SIGNAL
869   sigtstp_token =
870     create_async_signal_handler (async_stop_sig, NULL);
871 #endif
872
873 }
874
875 void
876 mark_async_signal_handler_wrapper (void *token)
877 {
878   mark_async_signal_handler ((struct async_signal_handler *) token);
879 }
880
881 /* Tell the event loop what to do if SIGINT is received.
882    See event-signal.c.  */
883 void
884 handle_sigint (int sig)
885 {
886   signal (sig, handle_sigint);
887
888   /* We could be running in a loop reading in symfiles or something so
889      it may be quite a while before we get back to the event loop.  So
890      set quit_flag to 1 here.  Then if QUIT is called before we get to
891      the event loop, we will unwind as expected.  */
892
893   quit_flag = 1;
894
895   /* If immediate_quit is set, we go ahead and process the SIGINT right
896      away, even if we usually would defer this to the event loop.  The
897      assumption here is that it is safe to process ^C immediately if
898      immediate_quit is set.  If we didn't, SIGINT would be really
899      processed only the next time through the event loop.  To get to
900      that point, though, the command that we want to interrupt needs to
901      finish first, which is unacceptable.  If immediate quit is not set,
902      we process SIGINT the next time through the loop, which is fine.  */
903   gdb_call_async_signal_handler (sigint_token, immediate_quit);
904 }
905
906 /* Quit GDB if SIGTERM is received.
907    GDB would quit anyway, but this way it will clean up properly.  */
908 void
909 handle_sigterm (int sig)
910 {
911   signal (sig, handle_sigterm);
912   quit_force ((char *) 0, stdin == instream);
913 }
914
915 /* Do the quit.  All the checks have been done by the caller.  */
916 void
917 async_request_quit (gdb_client_data arg)
918 {
919   /* If the quit_flag has gotten reset back to 0 by the time we get
920      back here, that means that an exception was thrown to unwind the
921      current command before we got back to the event loop.  So there
922      is no reason to call quit again here, unless immediate_quit is
923      set.  */
924
925   if (quit_flag || immediate_quit)
926     quit ();
927 }
928
929 #ifdef SIGQUIT
930 /* Tell the event loop what to do if SIGQUIT is received.
931    See event-signal.c.  */
932 static void
933 handle_sigquit (int sig)
934 {
935   mark_async_signal_handler_wrapper (sigquit_token);
936   signal (sig, handle_sigquit);
937 }
938 #endif
939
940 #if defined (SIGQUIT) || defined (SIGHUP)
941 /* Called by the event loop in response to a SIGQUIT or an
942    ignored SIGHUP.  */
943 static void
944 async_do_nothing (gdb_client_data arg)
945 {
946   /* Empty function body.  */
947 }
948 #endif
949
950 #ifdef SIGHUP
951 /* Tell the event loop what to do if SIGHUP is received.
952    See event-signal.c.  */
953 static void
954 handle_sighup (int sig)
955 {
956   mark_async_signal_handler_wrapper (sighup_token);
957   signal (sig, handle_sighup);
958 }
959
960 /* Called by the event loop to process a SIGHUP.  */
961 static void
962 async_disconnect (gdb_client_data arg)
963 {
964   catch_errors (quit_cover, NULL,
965                 "Could not kill the program being debugged",
966                 RETURN_MASK_ALL);
967   signal (SIGHUP, SIG_DFL);     /*FIXME: ???????????  */
968   raise (SIGHUP);
969 }
970 #endif
971
972 #ifdef STOP_SIGNAL
973 void
974 handle_stop_sig (int sig)
975 {
976   mark_async_signal_handler_wrapper (sigtstp_token);
977   signal (sig, handle_stop_sig);
978 }
979
980 static void
981 async_stop_sig (gdb_client_data arg)
982 {
983   char *prompt = get_prompt (0);
984
985 #if STOP_SIGNAL == SIGTSTP
986   signal (SIGTSTP, SIG_DFL);
987 #if HAVE_SIGPROCMASK
988   {
989     sigset_t zero;
990
991     sigemptyset (&zero);
992     sigprocmask (SIG_SETMASK, &zero, 0);
993   }
994 #elif HAVE_SIGSETMASK
995   sigsetmask (0);
996 #endif
997   raise (SIGTSTP);
998   signal (SIGTSTP, handle_stop_sig);
999 #else
1000   signal (STOP_SIGNAL, handle_stop_sig);
1001 #endif
1002   printf_unfiltered ("%s", prompt);
1003   gdb_flush (gdb_stdout);
1004
1005   /* Forget about any previous command -- null line now will do
1006      nothing.  */
1007   dont_repeat ();
1008 }
1009 #endif /* STOP_SIGNAL */
1010
1011 /* Tell the event loop what to do if SIGFPE is received.
1012    See event-signal.c.  */
1013 static void
1014 handle_sigfpe (int sig)
1015 {
1016   mark_async_signal_handler_wrapper (sigfpe_token);
1017   signal (sig, handle_sigfpe);
1018 }
1019
1020 /* Event loop will call this functin to process a SIGFPE.  */
1021 static void
1022 async_float_handler (gdb_client_data arg)
1023 {
1024   /* This message is based on ANSI C, section 4.7.  Note that integer
1025      divide by zero causes this, so "float" is a misnomer.  */
1026   error (_("Erroneous arithmetic operation."));
1027 }
1028
1029 /* Tell the event loop what to do if SIGWINCH is received.
1030    See event-signal.c.  */
1031 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
1032 static void
1033 handle_sigwinch (int sig)
1034 {
1035   mark_async_signal_handler_wrapper (sigwinch_token);
1036   signal (sig, handle_sigwinch);
1037 }
1038 #endif
1039 \f
1040
1041 /* Called by do_setshow_command.  */
1042 void
1043 set_async_editing_command (char *args, int from_tty,
1044                            struct cmd_list_element *c)
1045 {
1046   change_line_handler ();
1047 }
1048
1049 /* Called by do_setshow_command.  */
1050 void
1051 set_async_annotation_level (char *args, int from_tty,
1052                             struct cmd_list_element *c)
1053 {
1054   change_annotation_level ();
1055 }
1056
1057 /* Called by do_setshow_command.  */
1058 void
1059 set_async_prompt (char *args, int from_tty, struct cmd_list_element *c)
1060 {
1061   set_prompt (new_async_prompt, 0);
1062 }
1063
1064 /* Set things up for readline to be invoked via the alternate
1065    interface, i.e. via a callback function (rl_callback_read_char),
1066    and hook up instream to the event loop.  */
1067 void
1068 gdb_setup_readline (void)
1069 {
1070   /* This function is a noop for the sync case.  The assumption is
1071      that the sync setup is ALL done in gdb_init, and we would only
1072      mess it up here.  The sync stuff should really go away over
1073      time.  */
1074   if (!batch_silent)
1075     gdb_stdout = stdio_fileopen (stdout);
1076   gdb_stderr = stdio_fileopen (stderr);
1077   gdb_stdlog = gdb_stderr;  /* for moment */
1078   gdb_stdtarg = gdb_stderr; /* for moment */
1079   gdb_stdtargerr = gdb_stderr; /* for moment */
1080
1081   /* If the input stream is connected to a terminal, turn on
1082      editing.  */
1083   if (ISATTY (instream))
1084     {
1085       /* Tell gdb that we will be using the readline library.  This
1086          could be overwritten by a command in .gdbinit like 'set
1087          editing on' or 'off'.  */
1088       async_command_editing_p = 1;
1089           
1090       /* When a character is detected on instream by select or poll,
1091          readline will be invoked via this callback function.  */
1092       call_readline = rl_callback_read_char_wrapper;
1093     }
1094   else
1095     {
1096       async_command_editing_p = 0;
1097       call_readline = gdb_readline2;
1098     }
1099   
1100   /* When readline has read an end-of-line character, it passes the
1101      complete line to gdb for processing; command_line_handler is the
1102      function that does this.  */
1103   input_handler = command_line_handler;
1104       
1105   /* Tell readline to use the same input stream that gdb uses.  */
1106   rl_instream = instream;
1107
1108   /* Get a file descriptor for the input stream, so that we can
1109      register it with the event loop.  */
1110   input_fd = fileno (instream);
1111
1112   /* Now we need to create the event sources for the input file
1113      descriptor.  */
1114   /* At this point in time, this is the only event source that we
1115      register with the even loop.  Another source is going to be the
1116      target program (inferior), but that must be registered only when
1117      it actually exists (I.e. after we say 'run' or after we connect
1118      to a remote target.  */
1119   add_file_handler (input_fd, stdin_event_handler, 0);
1120 }
1121
1122 /* Disable command input through the standard CLI channels.  Used in
1123    the suspend proc for interpreters that use the standard gdb readline
1124    interface, like the cli & the mi.  */
1125 void
1126 gdb_disable_readline (void)
1127 {
1128   /* FIXME - It is too heavyweight to delete and remake these every
1129      time you run an interpreter that needs readline.  It is probably
1130      better to have the interpreters cache these, which in turn means
1131      that this needs to be moved into interpreter specific code.  */
1132
1133 #if 0
1134   ui_file_delete (gdb_stdout);
1135   ui_file_delete (gdb_stderr);
1136   gdb_stdlog = NULL;
1137   gdb_stdtarg = NULL;
1138   gdb_stdtargerr = NULL;
1139 #endif
1140
1141   rl_callback_handler_remove ();
1142   delete_file_handler (input_fd);
1143 }