ncurses 5.7 - patch 20090815
[ncurses.git] / ncurses / base / lib_getch.c
1 /****************************************************************************
2  * Copyright (c) 1998-2008,2009 Free Software Foundation, Inc.              *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32  *     and: Thomas E. Dickey                        1996-on                 *
33  *     and: Juergen Pfeifer                         2009                    *
34  ****************************************************************************/
35
36 /*
37 **      lib_getch.c
38 **
39 **      The routine getch().
40 **
41 */
42
43 #include <curses.priv.h>
44
45 MODULE_ID("$Id: lib_getch.c,v 1.107 2009/08/15 20:41:24 Clemens.Ladisch Exp $")
46
47 #include <fifo_defs.h>
48
49 #if USE_REENTRANT
50 #define GetEscdelay(sp) *_nc_ptr_Escdelay(sp)
51 NCURSES_EXPORT(int)
52 NCURSES_PUBLIC_VAR(ESCDELAY) (void)
53 {
54     return *(_nc_ptr_Escdelay(CURRENT_SCREEN));
55 }
56
57 NCURSES_EXPORT(int *)
58 _nc_ptr_Escdelay(SCREEN *sp)
59 {
60     return ptrEscdelay(sp);
61 }
62 #else
63 #define GetEscdelay(sp) ESCDELAY
64 NCURSES_EXPORT_VAR(int) ESCDELAY = 1000;
65 #endif
66
67 #if NCURSES_EXT_FUNCS
68 NCURSES_EXPORT(int)
69 NCURSES_SP_NAME(set_escdelay) (NCURSES_SP_DCLx int value)
70 {
71     int code = OK;
72 #if USE_REENTRANT
73     if (SP_PARM) {
74         SET_ESCDELAY(value);
75     } else {
76         code = ERR;
77     }
78 #else
79     (void) SP_PARM;
80     ESCDELAY = value;
81 #endif
82     return code;
83 }
84
85 #if NCURSES_SP_FUNCS
86 NCURSES_EXPORT(int)
87 set_escdelay(int value)
88 {
89     int code;
90 #if USE_REENTRANT
91     code = NCURSES_SP_NAME(set_escdelay) (CURRENT_SCREEN, value);
92 #else
93     ESCDELAY = value;
94     code = OK;
95 #endif
96     return code;
97 }
98 #endif
99 #endif /* NCURSES_EXT_FUNCS */
100
101 #if NCURSES_EXT_FUNCS
102 NCURSES_EXPORT(int)
103 NCURSES_SP_NAME(get_escdelay) (NCURSES_SP_DCL0)
104 {
105 #if !USE_REENTRANT
106     (void) SP_PARM;
107 #endif
108     return GetEscdelay(SP_PARM);
109 }
110
111 #if NCURSES_SP_FUNCS
112 NCURSES_EXPORT(int)
113 get_escdelay(void)
114 {
115     return NCURSES_SP_NAME(get_escdelay) (CURRENT_SCREEN);
116 }
117 #endif
118 #endif /* NCURSES_EXT_FUNCS */
119
120 static int
121 _nc_use_meta(WINDOW *win)
122 {
123     SCREEN *sp = _nc_screen_of(win);
124     return (sp ? sp->_use_meta : 0);
125 }
126
127 #ifdef NCURSES_WGETCH_EVENTS
128 #define TWAIT_MASK (TW_ANY | TW_EVENT)
129 #else
130 #define TWAIT_MASK TW_ANY
131 #endif
132
133 /*
134  * Check for mouse activity, returning nonzero if we find any.
135  */
136 static int
137 check_mouse_activity(SCREEN *sp, int delay EVENTLIST_2nd(_nc_eventlist * evl))
138 {
139     int rc;
140
141 #if USE_SYSMOUSE
142     if ((sp->_mouse_type == M_SYSMOUSE)
143         && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
144         return TW_MOUSE;
145     }
146 #endif
147 #ifdef USE_TERM_DRIVER
148     rc = TCBOf(sp)->drv->twait(TCBOf(sp),
149                                TWAIT_MASK,
150                                delay,
151                                (int *) 0
152                                EVENTLIST_2nd(evl));
153 #else
154     rc = _nc_timed_wait(sp,
155                         TWAIT_MASK,
156                         delay,
157                         (int *) 0
158                         EVENTLIST_2nd(evl));
159 #endif
160 #if USE_SYSMOUSE
161     if ((sp->_mouse_type == M_SYSMOUSE)
162         && (sp->_sysmouse_head < sp->_sysmouse_tail)
163         && (rc == 0)
164         && (errno == EINTR)) {
165         rc |= TW_MOUSE;
166     }
167 #endif
168     return rc;
169 }
170
171 static NCURSES_INLINE int
172 fifo_peek(SCREEN *sp)
173 {
174     int ch = sp->_fifo[peek];
175     TR(TRACE_IEVENT, ("peeking at %d", peek));
176
177     p_inc();
178     return ch;
179 }
180
181 static NCURSES_INLINE int
182 fifo_pull(SCREEN *sp)
183 {
184     int ch;
185     ch = sp->_fifo[head];
186     TR(TRACE_IEVENT, ("pulling %s from %d", _nc_tracechar(sp, ch), head));
187
188     if (peek == head) {
189         h_inc();
190         peek = head;
191     } else
192         h_inc();
193
194 #ifdef TRACE
195     if (USE_TRACEF(TRACE_IEVENT)) {
196         _nc_fifo_dump(sp);
197         _nc_unlock_global(tracef);
198     }
199 #endif
200     return ch;
201 }
202
203 static NCURSES_INLINE int
204 fifo_push(SCREEN *sp EVENTLIST_2nd(_nc_eventlist * evl))
205 {
206     int n;
207     int ch = 0;
208     int mask = 0;
209
210     (void) mask;
211     if (tail == -1)
212         return ERR;
213
214 #ifdef HIDE_EINTR
215   again:
216     errno = 0;
217 #endif
218
219 #ifdef NCURSES_WGETCH_EVENTS
220     if (evl
221 #if USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
222         || (sp->_mouse_fd >= 0)
223 #endif
224         ) {
225         mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
226     } else
227         mask = 0;
228
229     if (mask & TW_EVENT) {
230         T(("fifo_push: ungetch KEY_EVENT"));
231         safe_ungetch(sp, KEY_EVENT);
232         return KEY_EVENT;
233     }
234 #elif USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
235     if (sp->_mouse_fd >= 0) {
236         mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
237     }
238 #endif
239
240 #if USE_GPM_SUPPORT || USE_EMX_MOUSE
241     if ((sp->_mouse_fd >= 0) && (mask & TW_MOUSE)) {
242         sp->_mouse_event(sp);
243         ch = KEY_MOUSE;
244         n = 1;
245     } else
246 #endif
247 #if USE_SYSMOUSE
248         if ((sp->_mouse_type == M_SYSMOUSE)
249             && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
250         sp->_mouse_event(sp);
251         ch = KEY_MOUSE;
252         n = 1;
253     } else if ((sp->_mouse_type == M_SYSMOUSE)
254                && (mask <= 0) && errno == EINTR) {
255         sp->_mouse_event(sp);
256         ch = KEY_MOUSE;
257         n = 1;
258     } else
259 #endif
260     {                           /* Can block... */
261 #ifdef USE_TERM_DRIVER
262         int buf;
263         n = CallDriver_1(sp, read, &buf);
264         ch = buf;
265 #else
266         unsigned char c2 = 0;
267         n = read(sp->_ifd, &c2, 1);
268         ch = c2;
269 #endif
270     }
271
272 #ifdef HIDE_EINTR
273     /*
274      * Under System V curses with non-restarting signals, getch() returns
275      * with value ERR when a handled signal keeps it from completing.
276      * If signals restart system calls, OTOH, the signal is invisible
277      * except to its handler.
278      *
279      * We don't want this difference to show.  This piece of code
280      * tries to make it look like we always have restarting signals.
281      */
282     if (n <= 0 && errno == EINTR)
283         goto again;
284 #endif
285
286     if ((n == -1) || (n == 0)) {
287         TR(TRACE_IEVENT, ("read(%d,&ch,1)=%d, errno=%d", sp->_ifd, n, errno));
288         ch = ERR;
289     }
290     TR(TRACE_IEVENT, ("read %d characters", n));
291
292     sp->_fifo[tail] = ch;
293     sp->_fifohold = 0;
294     if (head == -1)
295         head = peek = tail;
296     t_inc();
297     TR(TRACE_IEVENT, ("pushed %s at %d", _nc_tracechar(sp, ch), tail));
298 #ifdef TRACE
299     if (USE_TRACEF(TRACE_IEVENT)) {
300         _nc_fifo_dump(sp);
301         _nc_unlock_global(tracef);
302     }
303 #endif
304     return ch;
305 }
306
307 static NCURSES_INLINE void
308 fifo_clear(SCREEN *sp)
309 {
310     memset(sp->_fifo, 0, sizeof(sp->_fifo));
311     head = -1;
312     tail = peek = 0;
313 }
314
315 static int kgetch(SCREEN *EVENTLIST_2nd(_nc_eventlist * evl));
316
317 static void
318 recur_wrefresh(WINDOW *win)
319 {
320 #ifdef USE_PTHREADS
321     SCREEN *sp = _nc_screen_of(win);
322     if (_nc_use_pthreads && sp != CURRENT_SCREEN) {
323         SCREEN *save_SP;
324
325         /* temporarily switch to the window's screen to check/refresh */
326         _nc_lock_global(curses);
327         save_SP = CURRENT_SCREEN;
328         _nc_set_screen(sp);
329         recur_wrefresh(win);
330         _nc_set_screen(save_SP);
331         _nc_unlock_global(curses);
332     } else
333 #endif
334         if ((is_wintouched(win) || (win->_flags & _HASMOVED))
335             && !(win->_flags & _ISPAD)) {
336         wrefresh(win);
337     }
338 }
339
340 static int
341 recur_wgetnstr(WINDOW *win, char *buf)
342 {
343     SCREEN *sp = _nc_screen_of(win);
344     int rc;
345
346     if (sp != 0) {
347 #ifdef USE_PTHREADS
348         if (_nc_use_pthreads && sp != CURRENT_SCREEN) {
349             SCREEN *save_SP;
350
351             /* temporarily switch to the window's screen to get cooked input */
352             _nc_lock_global(curses);
353             save_SP = CURRENT_SCREEN;
354             _nc_set_screen(sp);
355             rc = recur_wgetnstr(win, buf);
356             _nc_set_screen(save_SP);
357             _nc_unlock_global(curses);
358         } else
359 #endif
360         {
361             sp->_called_wgetch = TRUE;
362             rc = wgetnstr(win, buf, MAXCOLUMNS);
363             sp->_called_wgetch = FALSE;
364         }
365     } else {
366         rc = ERR;
367     }
368     return rc;
369 }
370
371 NCURSES_EXPORT(int)
372 _nc_wgetch(WINDOW *win,
373            unsigned long *result,
374            int use_meta
375            EVENTLIST_2nd(_nc_eventlist * evl))
376 {
377     SCREEN *sp;
378     int ch;
379 #ifdef NCURSES_WGETCH_EVENTS
380     long event_delay = -1;
381 #endif
382
383     T((T_CALLED("_nc_wgetch(%p)"), win));
384
385     *result = 0;
386
387     sp = _nc_screen_of(win);
388     if (win == 0 || sp == 0) {
389         returnCode(ERR);
390     }
391
392     if (cooked_key_in_fifo()) {
393         recur_wrefresh(win);
394         *result = fifo_pull(sp);
395         returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
396     }
397 #ifdef NCURSES_WGETCH_EVENTS
398     if (evl && (evl->count == 0))
399         evl = NULL;
400     event_delay = _nc_eventlist_timeout(evl);
401 #endif
402
403     /*
404      * Handle cooked mode.  Grab a string from the screen,
405      * stuff its contents in the FIFO queue, and pop off
406      * the first character to return it.
407      */
408     if (head == -1 &&
409         !sp->_notty &&
410         !sp->_raw &&
411         !sp->_cbreak &&
412         !sp->_called_wgetch) {
413         char buf[MAXCOLUMNS], *bufp;
414         int rc;
415
416         TR(TRACE_IEVENT, ("filling queue in cooked mode"));
417
418         rc = recur_wgetnstr(win, buf);
419
420         /* ungetch in reverse order */
421 #ifdef NCURSES_WGETCH_EVENTS
422         if (rc != KEY_EVENT)
423 #endif
424             safe_ungetch(sp, '\n');
425         for (bufp = buf + strlen(buf); bufp > buf; bufp--)
426             safe_ungetch(sp, bufp[-1]);
427
428 #ifdef NCURSES_WGETCH_EVENTS
429         /* Return it first */
430         if (rc == KEY_EVENT) {
431             *result = rc;
432         } else
433 #endif
434             *result = fifo_pull(sp);
435         returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
436     }
437
438     if (win->_use_keypad != sp->_keypad_on)
439         _nc_keypad(sp, win->_use_keypad);
440
441     recur_wrefresh(win);
442
443     if (win->_notimeout || (win->_delay >= 0) || (sp->_cbreak > 1)) {
444         if (head == -1) {       /* fifo is empty */
445             int delay;
446             int rc;
447
448             TR(TRACE_IEVENT, ("timed delay in wgetch()"));
449             if (sp->_cbreak > 1)
450                 delay = (sp->_cbreak - 1) * 100;
451             else
452                 delay = win->_delay;
453
454 #ifdef NCURSES_WGETCH_EVENTS
455             if (event_delay >= 0 && delay > event_delay)
456                 delay = event_delay;
457 #endif
458
459             TR(TRACE_IEVENT, ("delay is %d milliseconds", delay));
460
461             rc = check_mouse_activity(sp, delay EVENTLIST_2nd(evl));
462
463 #ifdef NCURSES_WGETCH_EVENTS
464             if (rc & TW_EVENT) {
465                 *result = KEY_EVENT;
466                 returnCode(KEY_CODE_YES);
467             }
468 #endif
469             if (!rc) {
470                 goto check_sigwinch;
471             }
472         }
473         /* else go on to read data available */
474     }
475
476     if (win->_use_keypad) {
477         /*
478          * This is tricky.  We only want to get special-key
479          * events one at a time.  But we want to accumulate
480          * mouse events until either (a) the mouse logic tells
481          * us it's picked up a complete gesture, or (b)
482          * there's a detectable time lapse after one.
483          *
484          * Note: if the mouse code starts failing to compose
485          * press/release events into clicks, you should probably
486          * increase the wait with mouseinterval().
487          */
488         int runcount = 0;
489         int rc = 0;
490
491         do {
492             ch = kgetch(sp EVENTLIST_2nd(evl));
493             if (ch == KEY_MOUSE) {
494                 ++runcount;
495                 if (sp->_mouse_inline(sp))
496                     break;
497             }
498             if (sp->_maxclick < 0)
499                 break;
500         } while
501             (ch == KEY_MOUSE
502              && (((rc = check_mouse_activity(sp, sp->_maxclick
503                                              EVENTLIST_2nd(evl))) != 0
504                   && !(rc & TW_EVENT))
505                  || !sp->_mouse_parse(sp, runcount)));
506 #ifdef NCURSES_WGETCH_EVENTS
507         if ((rc & TW_EVENT) && !(ch == KEY_EVENT)) {
508             safe_ungetch(sp, ch);
509             ch = KEY_EVENT;
510         }
511 #endif
512         if (runcount > 0 && ch != KEY_MOUSE) {
513 #ifdef NCURSES_WGETCH_EVENTS
514             /* mouse event sequence ended by an event, report event */
515             if (ch == KEY_EVENT) {
516                 safe_ungetch(sp, KEY_MOUSE);    /* FIXME This interrupts a gesture... */
517             } else
518 #endif
519             {
520                 /* mouse event sequence ended by keystroke, store keystroke */
521                 safe_ungetch(sp, ch);
522                 ch = KEY_MOUSE;
523             }
524         }
525     } else {
526         if (head == -1)
527             fifo_push(sp EVENTLIST_2nd(evl));
528         ch = fifo_pull(sp);
529     }
530
531     if (ch == ERR) {
532       check_sigwinch:
533 #if USE_SIZECHANGE
534         if (_nc_handle_sigwinch(sp)) {
535             _nc_update_screensize(sp);
536             /* resizeterm can push KEY_RESIZE */
537             if (cooked_key_in_fifo()) {
538                 *result = fifo_pull(sp);
539                 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
540             }
541         }
542 #endif
543         returnCode(ERR);
544     }
545
546     /*
547      * If echo() is in effect, display the printable version of the
548      * key on the screen.  Carriage return and backspace are treated
549      * specially by Solaris curses:
550      *
551      * If carriage return is defined as a function key in the
552      * terminfo, e.g., kent, then Solaris may return either ^J (or ^M
553      * if nonl() is set) or KEY_ENTER depending on the echo() mode. 
554      * We echo before translating carriage return based on nonl(),
555      * since the visual result simply moves the cursor to column 0.
556      *
557      * Backspace is a different matter.  Solaris curses does not
558      * translate it to KEY_BACKSPACE if kbs=^H.  This does not depend
559      * on the stty modes, but appears to be a hardcoded special case.
560      * This is a difference from ncurses, which uses the terminfo entry.
561      * However, we provide the same visual result as Solaris, moving the
562      * cursor to the left.
563      */
564     if (sp->_echo && !(win->_flags & _ISPAD)) {
565         chtype backup = (ch == KEY_BACKSPACE) ? '\b' : ch;
566         if (backup < KEY_MIN)
567             wechochar(win, backup);
568     }
569
570     /*
571      * Simulate ICRNL mode
572      */
573     if ((ch == '\r') && sp->_nl)
574         ch = '\n';
575
576     /* Strip 8th-bit if so desired.  We do this only for characters that
577      * are in the range 128-255, to provide compatibility with terminals
578      * that display only 7-bit characters.  Note that 'ch' may be a
579      * function key at this point, so we mustn't strip _those_.
580      */
581     if (!use_meta)
582         if ((ch < KEY_MIN) && (ch & 0x80))
583             ch &= 0x7f;
584
585     T(("wgetch returning : %s", _nc_tracechar(sp, ch)));
586
587     *result = ch;
588     returnCode(ch >= KEY_MIN ? KEY_CODE_YES : OK);
589 }
590
591 #ifdef NCURSES_WGETCH_EVENTS
592 NCURSES_EXPORT(int)
593 wgetch_events(WINDOW *win, _nc_eventlist * evl)
594 {
595     int code;
596     unsigned long value;
597
598     T((T_CALLED("wgetch_events(%p,%p)"), win, evl));
599     code = _nc_wgetch(win,
600                       &value,
601                       _nc_use_meta(win)
602                       EVENTLIST_2nd(evl));
603     if (code != ERR)
604         code = value;
605     returnCode(code);
606 }
607 #endif
608
609 NCURSES_EXPORT(int)
610 wgetch(WINDOW *win)
611 {
612     int code;
613     unsigned long value;
614
615     T((T_CALLED("wgetch(%p)"), win));
616     code = _nc_wgetch(win,
617                       &value,
618                       _nc_use_meta(win)
619                       EVENTLIST_2nd((_nc_eventlist *) 0));
620     if (code != ERR)
621         code = value;
622     returnCode(code);
623 }
624
625 /*
626 **      int
627 **      kgetch()
628 **
629 **      Get an input character, but take care of keypad sequences, returning
630 **      an appropriate code when one matches the input.  After each character
631 **      is received, set an alarm call based on ESCDELAY.  If no more of the
632 **      sequence is received by the time the alarm goes off, pass through
633 **      the sequence gotten so far.
634 **
635 **      This function must be called when there are no cooked keys in queue.
636 **      (that is head==-1 || peek==head)
637 **
638 */
639
640 static int
641 kgetch(SCREEN *sp EVENTLIST_2nd(_nc_eventlist * evl))
642 {
643     TRIES *ptr;
644     int ch = 0;
645     int timeleft = GetEscdelay(sp);
646
647     TR(TRACE_IEVENT, ("kgetch() called"));
648
649     ptr = sp->_keytry;
650
651     for (;;) {
652         if (cooked_key_in_fifo() && sp->_fifo[head] >= KEY_MIN) {
653             break;
654         } else if (!raw_key_in_fifo()) {
655             ch = fifo_push(sp EVENTLIST_2nd(evl));
656             if (ch == ERR) {
657                 peek = head;    /* the keys stay uninterpreted */
658                 return ERR;
659             }
660 #ifdef NCURSES_WGETCH_EVENTS
661             else if (ch == KEY_EVENT) {
662                 peek = head;    /* the keys stay uninterpreted */
663                 return fifo_pull(sp);   /* Remove KEY_EVENT from the queue */
664             }
665 #endif
666         }
667
668         ch = fifo_peek(sp);
669         if (ch >= KEY_MIN) {
670             /* If not first in queue, somebody put this key there on purpose in
671              * emergency.  Consider it higher priority than the unfinished
672              * keysequence we are parsing.
673              */
674             peek = head;
675             /* assume the key is the last in fifo */
676             t_dec();            /* remove the key */
677             return ch;
678         }
679
680         TR(TRACE_IEVENT, ("ch: %s", _nc_tracechar(sp, (unsigned char) ch)));
681         while ((ptr != NULL) && (ptr->ch != (unsigned char) ch))
682             ptr = ptr->sibling;
683
684         if (ptr == NULL) {
685             TR(TRACE_IEVENT, ("ptr is null"));
686             break;
687         }
688         TR(TRACE_IEVENT, ("ptr=%p, ch=%d, value=%d",
689                           ptr, ptr->ch, ptr->value));
690
691         if (ptr->value != 0) {  /* sequence terminated */
692             TR(TRACE_IEVENT, ("end of sequence"));
693             if (peek == tail)
694                 fifo_clear(sp);
695             else
696                 head = peek;
697             return (ptr->value);
698         }
699
700         ptr = ptr->child;
701
702         if (!raw_key_in_fifo()) {
703             int rc;
704
705             TR(TRACE_IEVENT, ("waiting for rest of sequence"));
706             rc = check_mouse_activity(sp, timeleft EVENTLIST_2nd(evl));
707 #ifdef NCURSES_WGETCH_EVENTS
708             if (rc & TW_EVENT) {
709                 TR(TRACE_IEVENT, ("interrupted by a user event"));
710                 /* FIXME Should have preserved remainder timeleft for reuse... */
711                 peek = head;    /* Restart interpreting later */
712                 return KEY_EVENT;
713             }
714 #endif
715             if (!rc) {
716                 TR(TRACE_IEVENT, ("ran out of time"));
717                 break;
718             }
719         }
720     }
721     ch = fifo_pull(sp);
722     peek = head;
723     return ch;
724 }