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