ncurses/base/lib_getch.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2009,2010 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.111 2010/04/10 19:08:59 tom 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 /*
 128  * Check for mouse activity, returning nonzero if we find any.
 129  */
 130 static int
 131 check_mouse_activity(SCREEN *sp, int delay EVENTLIST_2nd(_nc_eventlist * evl))
 132 {
 133     int rc;
 134
 135 #ifdef USE_TERM_DRIVER
 136     rc = TCBOf(sp)->drv->testmouse(TCBOf(sp), delay);
 137 #else
 138 #if USE_SYSMOUSE
 139     if ((sp->_mouse_type == M_SYSMOUSE)
 140         && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
 141         rc = TW_MOUSE;
 142     } else
 143 #endif
 144     {
 145         rc = _nc_timed_wait(sp,
 146                             TWAIT_MASK,
 147                             delay,
 148                             (int *) 0
 149                             EVENTLIST_2nd(evl));
 150 #if USE_SYSMOUSE
 151         if ((sp->_mouse_type == M_SYSMOUSE)
 152             && (sp->_sysmouse_head < sp->_sysmouse_tail)
 153             && (rc == 0)
 154             && (errno == EINTR)) {
 155             rc |= TW_MOUSE;
 156         }
 157 #endif
 158     }
 159 #endif
 160     return rc;
 161 }
 162
 163 static NCURSES_INLINE int
 164 fifo_peek(SCREEN *sp)
 165 {
 166     int ch = sp->_fifo[peek];
 167     TR(TRACE_IEVENT, ("peeking at %d", peek));
 168
 169     p_inc();
 170     return ch;
 171 }
 172
 173 static NCURSES_INLINE int
 174 fifo_pull(SCREEN *sp)
 175 {
 176     int ch;
 177     ch = sp->_fifo[head];
 178     TR(TRACE_IEVENT, ("pulling %s from %d", _nc_tracechar(sp, ch), head));
 179
 180     if (peek == head) {
 181         h_inc();
 182         peek = head;
 183     } else
 184         h_inc();
 185
 186 #ifdef TRACE
 187     if (USE_TRACEF(TRACE_IEVENT)) {
 188         _nc_fifo_dump(sp);
 189         _nc_unlock_global(tracef);
 190     }
 191 #endif
 192     return ch;
 193 }
 194
 195 static NCURSES_INLINE int
 196 fifo_push(SCREEN *sp EVENTLIST_2nd(_nc_eventlist * evl))
 197 {
 198     int n;
 199     int ch = 0;
 200     int mask = 0;
 201
 202     (void) mask;
 203     if (tail == -1)
 204         return ERR;
 205
 206 #ifdef HIDE_EINTR
 207   again:
 208     errno = 0;
 209 #endif
 210
 211 #ifdef NCURSES_WGETCH_EVENTS
 212     if (evl
 213 #if USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
 214         || (sp->_mouse_fd >= 0)
 215 #endif
 216         ) {
 217         mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
 218     } else
 219         mask = 0;
 220
 221     if (mask & TW_EVENT) {
 222         T(("fifo_push: ungetch KEY_EVENT"));
 223         safe_ungetch(sp, KEY_EVENT);
 224         return KEY_EVENT;
 225     }
 226 #elif USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
 227     if (sp->_mouse_fd >= 0) {
 228         mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
 229     }
 230 #endif
 231
 232 #if USE_GPM_SUPPORT || USE_EMX_MOUSE
 233     if ((sp->_mouse_fd >= 0) && (mask & TW_MOUSE)) {
 234         sp->_mouse_event(sp);
 235         ch = KEY_MOUSE;
 236         n = 1;
 237     } else
 238 #endif
 239 #if USE_SYSMOUSE
 240         if ((sp->_mouse_type == M_SYSMOUSE)
 241             && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
 242         sp->_mouse_event(sp);
 243         ch = KEY_MOUSE;
 244         n = 1;
 245     } else if ((sp->_mouse_type == M_SYSMOUSE)
 246                && (mask <= 0) && errno == EINTR) {
 247         sp->_mouse_event(sp);
 248         ch = KEY_MOUSE;
 249         n = 1;
 250     } else
 251 #endif
 252 #ifdef USE_TERM_DRIVER
 253         if ((sp->_mouse_type == M_TERM_DRIVER)
 254             && (sp->_drv_mouse_head < sp->_drv_mouse_tail)) {
 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)"), (void *) 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                 /*
 540                  * Get the ERR from queue -- it is from WINCH,
 541                  * so we should take it out, the "error" is handled.
 542                  */
 543                 if (fifo_peek(sp) == -1)
 544                     fifo_pull(sp);
 545                 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
 546             }
 547         }
 548 #endif
 549         returnCode(ERR);
 550     }
 551
 552     /*
 553      * If echo() is in effect, display the printable version of the
 554      * key on the screen.  Carriage return and backspace are treated
 555      * specially by Solaris curses:
 556      *
 557      * If carriage return is defined as a function key in the
 558      * terminfo, e.g., kent, then Solaris may return either ^J (or ^M
 559      * if nonl() is set) or KEY_ENTER depending on the echo() mode.
 560      * We echo before translating carriage return based on nonl(),
 561      * since the visual result simply moves the cursor to column 0.
 562      *
 563      * Backspace is a different matter.  Solaris curses does not
 564      * translate it to KEY_BACKSPACE if kbs=^H.  This does not depend
 565      * on the stty modes, but appears to be a hardcoded special case.
 566      * This is a difference from ncurses, which uses the terminfo entry.
 567      * However, we provide the same visual result as Solaris, moving the
 568      * cursor to the left.
 569      */
 570     if (sp->_echo && !(win->_flags & _ISPAD)) {
 571         chtype backup = (ch == KEY_BACKSPACE) ? '\b' : ch;
 572         if (backup < KEY_MIN)
 573             wechochar(win, backup);
 574     }
 575
 576     /*
 577      * Simulate ICRNL mode
 578      */
 579     if ((ch == '\r') && sp->_nl)
 580         ch = '\n';
 581
 582     /* Strip 8th-bit if so desired.  We do this only for characters that
 583      * are in the range 128-255, to provide compatibility with terminals
 584      * that display only 7-bit characters.  Note that 'ch' may be a
 585      * function key at this point, so we mustn't strip _those_.
 586      */
 587     if (!use_meta)
 588         if ((ch < KEY_MIN) && (ch & 0x80))
 589             ch &= 0x7f;
 590
 591     T(("wgetch returning : %s", _nc_tracechar(sp, ch)));
 592
 593     *result = ch;
 594     returnCode(ch >= KEY_MIN ? KEY_CODE_YES : OK);
 595 }
 596
 597 #ifdef NCURSES_WGETCH_EVENTS
 598 NCURSES_EXPORT(int)
 599 wgetch_events(WINDOW *win, _nc_eventlist * evl)
 600 {
 601     int code;
 602     unsigned long value;
 603
 604     T((T_CALLED("wgetch_events(%p,%p)"), win, evl));
 605     code = _nc_wgetch(win,
 606                       &value,
 607                       _nc_use_meta(win)
 608                       EVENTLIST_2nd(evl));
 609     if (code != ERR)
 610         code = value;
 611     returnCode(code);
 612 }
 613 #endif
 614
 615 NCURSES_EXPORT(int)
 616 wgetch(WINDOW *win)
 617 {
 618     int code;
 619     unsigned long value;
 620
 621     T((T_CALLED("wgetch(%p)"), (void *) win));
 622     code = _nc_wgetch(win,
 623                       &value,
 624                       _nc_use_meta(win)
 625                       EVENTLIST_2nd((_nc_eventlist *) 0));
 626     if (code != ERR)
 627         code = value;
 628     returnCode(code);
 629 }
 630
 631 /*
 632 **      int
 633 **      kgetch()
 634 **
 635 **      Get an input character, but take care of keypad sequences, returning
 636 **      an appropriate code when one matches the input.  After each character
 637 **      is received, set an alarm call based on ESCDELAY.  If no more of the
 638 **      sequence is received by the time the alarm goes off, pass through
 639 **      the sequence gotten so far.
 640 **
 641 **      This function must be called when there are no cooked keys in queue.
 642 **      (that is head==-1 || peek==head)
 643 **
 644 */
 645
 646 static int
 647 kgetch(SCREEN *sp EVENTLIST_2nd(_nc_eventlist * evl))
 648 {
 649     TRIES *ptr;
 650     int ch = 0;
 651     int timeleft = GetEscdelay(sp);
 652
 653     TR(TRACE_IEVENT, ("kgetch() called"));
 654
 655     ptr = sp->_keytry;
 656
 657     for (;;) {
 658         if (cooked_key_in_fifo() && sp->_fifo[head] >= KEY_MIN) {
 659             break;
 660         } else if (!raw_key_in_fifo()) {
 661             ch = fifo_push(sp EVENTLIST_2nd(evl));
 662             if (ch == ERR) {
 663                 peek = head;    /* the keys stay uninterpreted */
 664                 return ERR;
 665             }
 666 #ifdef NCURSES_WGETCH_EVENTS
 667             else if (ch == KEY_EVENT) {
 668                 peek = head;    /* the keys stay uninterpreted */
 669                 return fifo_pull(sp);   /* Remove KEY_EVENT from the queue */
 670             }
 671 #endif
 672         }
 673
 674         ch = fifo_peek(sp);
 675         if (ch >= KEY_MIN) {
 676             /* If not first in queue, somebody put this key there on purpose in
 677              * emergency.  Consider it higher priority than the unfinished
 678              * keysequence we are parsing.
 679              */
 680             peek = head;
 681             /* assume the key is the last in fifo */
 682             t_dec();            /* remove the key */
 683             return ch;
 684         }
 685
 686         TR(TRACE_IEVENT, ("ch: %s", _nc_tracechar(sp, (unsigned char) ch)));
 687         while ((ptr != NULL) && (ptr->ch != (unsigned char) ch))
 688             ptr = ptr->sibling;
 689
 690         if (ptr == NULL) {
 691             TR(TRACE_IEVENT, ("ptr is null"));
 692             break;
 693         }
 694         TR(TRACE_IEVENT, ("ptr=%p, ch=%d, value=%d",
 695                           (void *) ptr, ptr->ch, ptr->value));
 696
 697         if (ptr->value != 0) {  /* sequence terminated */
 698             TR(TRACE_IEVENT, ("end of sequence"));
 699             if (peek == tail)
 700                 fifo_clear(sp);
 701             else
 702                 head = peek;
 703             return (ptr->value);
 704         }
 705
 706         ptr = ptr->child;
 707
 708         if (!raw_key_in_fifo()) {
 709             int rc;
 710
 711             TR(TRACE_IEVENT, ("waiting for rest of sequence"));
 712             rc = check_mouse_activity(sp, timeleft EVENTLIST_2nd(evl));
 713 #ifdef NCURSES_WGETCH_EVENTS
 714             if (rc & TW_EVENT) {
 715                 TR(TRACE_IEVENT, ("interrupted by a user event"));
 716                 /* FIXME Should have preserved remainder timeleft for reuse... */
 717                 peek = head;    /* Restart interpreting later */
 718                 return KEY_EVENT;
 719             }
 720 #endif
 721             if (!rc) {
 722                 TR(TRACE_IEVENT, ("ran out of time"));
 723                 break;
 724             }
 725         }
 726     }
 727     ch = fifo_pull(sp);
 728     peek = head;
 729     return ch;
 730 }