1 /****************************************************************************
2 * Copyright (c) 1998-2008,2009 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
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 ****************************************************************************/
39 ** The routine getch().
43 #include <curses.priv.h>
45 MODULE_ID("$Id: lib_getch.c,v 1.110 2010/02/06 18:39:16 tom Exp $")
47 #include <fifo_defs.h>
50 #define GetEscdelay(sp) *_nc_ptr_Escdelay(sp)
52 NCURSES_PUBLIC_VAR(ESCDELAY) (void)
54 return *(_nc_ptr_Escdelay(CURRENT_SCREEN));
58 _nc_ptr_Escdelay(SCREEN *sp)
60 return ptrEscdelay(sp);
63 #define GetEscdelay(sp) ESCDELAY
64 NCURSES_EXPORT_VAR(int) ESCDELAY = 1000;
69 NCURSES_SP_NAME(set_escdelay) (NCURSES_SP_DCLx int value)
87 set_escdelay(int value)
91 code = NCURSES_SP_NAME(set_escdelay) (CURRENT_SCREEN, value);
99 #endif /* NCURSES_EXT_FUNCS */
101 #if NCURSES_EXT_FUNCS
103 NCURSES_SP_NAME(get_escdelay) (NCURSES_SP_DCL0)
108 return GetEscdelay(SP_PARM);
115 return NCURSES_SP_NAME(get_escdelay) (CURRENT_SCREEN);
118 #endif /* NCURSES_EXT_FUNCS */
121 _nc_use_meta(WINDOW *win)
123 SCREEN *sp = _nc_screen_of(win);
124 return (sp ? sp->_use_meta : 0);
127 #ifdef NCURSES_WGETCH_EVENTS
128 #define TWAIT_MASK (TW_ANY | TW_EVENT)
130 #define TWAIT_MASK TW_ANY
134 * Check for mouse activity, returning nonzero if we find any.
137 check_mouse_activity(SCREEN *sp, int delay EVENTLIST_2nd(_nc_eventlist * evl))
142 if ((sp->_mouse_type == M_SYSMOUSE)
143 && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
147 #ifdef USE_TERM_DRIVER
148 rc = TCBOf(sp)->drv->twait(TCBOf(sp),
154 rc = _nc_timed_wait(sp,
161 if ((sp->_mouse_type == M_SYSMOUSE)
162 && (sp->_sysmouse_head < sp->_sysmouse_tail)
164 && (errno == EINTR)) {
171 static NCURSES_INLINE int
172 fifo_peek(SCREEN *sp)
174 int ch = sp->_fifo[peek];
175 TR(TRACE_IEVENT, ("peeking at %d", peek));
181 static NCURSES_INLINE int
182 fifo_pull(SCREEN *sp)
185 ch = sp->_fifo[head];
186 TR(TRACE_IEVENT, ("pulling %s from %d", _nc_tracechar(sp, ch), head));
195 if (USE_TRACEF(TRACE_IEVENT)) {
197 _nc_unlock_global(tracef);
203 static NCURSES_INLINE int
204 fifo_push(SCREEN *sp EVENTLIST_2nd(_nc_eventlist * evl))
219 #ifdef NCURSES_WGETCH_EVENTS
221 #if USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
222 || (sp->_mouse_fd >= 0)
225 mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
229 if (mask & TW_EVENT) {
230 T(("fifo_push: ungetch KEY_EVENT"));
231 safe_ungetch(sp, KEY_EVENT);
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));
240 #if USE_GPM_SUPPORT || USE_EMX_MOUSE
241 if ((sp->_mouse_fd >= 0) && (mask & TW_MOUSE)) {
242 sp->_mouse_event(sp);
248 if ((sp->_mouse_type == M_SYSMOUSE)
249 && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
250 sp->_mouse_event(sp);
253 } else if ((sp->_mouse_type == M_SYSMOUSE)
254 && (mask <= 0) && errno == EINTR) {
255 sp->_mouse_event(sp);
260 #ifdef USE_TERM_DRIVER
261 if ((sp->_mouse_type == M_TERM_DRIVER)
262 && (sp->_drv_mouse_head < sp->_drv_mouse_tail)) {
263 sp->_mouse_event(sp);
269 #ifdef USE_TERM_DRIVER
271 n = CallDriver_1(sp, read, &buf);
274 unsigned char c2 = 0;
275 n = read(sp->_ifd, &c2, 1);
282 * Under System V curses with non-restarting signals, getch() returns
283 * with value ERR when a handled signal keeps it from completing.
284 * If signals restart system calls, OTOH, the signal is invisible
285 * except to its handler.
287 * We don't want this difference to show. This piece of code
288 * tries to make it look like we always have restarting signals.
290 if (n <= 0 && errno == EINTR)
294 if ((n == -1) || (n == 0)) {
295 TR(TRACE_IEVENT, ("read(%d,&ch,1)=%d, errno=%d", sp->_ifd, n, errno));
298 TR(TRACE_IEVENT, ("read %d characters", n));
300 sp->_fifo[tail] = ch;
305 TR(TRACE_IEVENT, ("pushed %s at %d", _nc_tracechar(sp, ch), tail));
307 if (USE_TRACEF(TRACE_IEVENT)) {
309 _nc_unlock_global(tracef);
315 static NCURSES_INLINE void
316 fifo_clear(SCREEN *sp)
318 memset(sp->_fifo, 0, sizeof(sp->_fifo));
323 static int kgetch(SCREEN *EVENTLIST_2nd(_nc_eventlist * evl));
326 recur_wrefresh(WINDOW *win)
329 SCREEN *sp = _nc_screen_of(win);
330 if (_nc_use_pthreads && sp != CURRENT_SCREEN) {
333 /* temporarily switch to the window's screen to check/refresh */
334 _nc_lock_global(curses);
335 save_SP = CURRENT_SCREEN;
338 _nc_set_screen(save_SP);
339 _nc_unlock_global(curses);
342 if ((is_wintouched(win) || (win->_flags & _HASMOVED))
343 && !(win->_flags & _ISPAD)) {
349 recur_wgetnstr(WINDOW *win, char *buf)
351 SCREEN *sp = _nc_screen_of(win);
356 if (_nc_use_pthreads && sp != CURRENT_SCREEN) {
359 /* temporarily switch to the window's screen to get cooked input */
360 _nc_lock_global(curses);
361 save_SP = CURRENT_SCREEN;
363 rc = recur_wgetnstr(win, buf);
364 _nc_set_screen(save_SP);
365 _nc_unlock_global(curses);
369 sp->_called_wgetch = TRUE;
370 rc = wgetnstr(win, buf, MAXCOLUMNS);
371 sp->_called_wgetch = FALSE;
380 _nc_wgetch(WINDOW *win,
381 unsigned long *result,
383 EVENTLIST_2nd(_nc_eventlist * evl))
387 #ifdef NCURSES_WGETCH_EVENTS
388 long event_delay = -1;
391 T((T_CALLED("_nc_wgetch(%p)"), (void *) win));
395 sp = _nc_screen_of(win);
396 if (win == 0 || sp == 0) {
400 if (cooked_key_in_fifo()) {
402 *result = fifo_pull(sp);
403 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
405 #ifdef NCURSES_WGETCH_EVENTS
406 if (evl && (evl->count == 0))
408 event_delay = _nc_eventlist_timeout(evl);
412 * Handle cooked mode. Grab a string from the screen,
413 * stuff its contents in the FIFO queue, and pop off
414 * the first character to return it.
420 !sp->_called_wgetch) {
421 char buf[MAXCOLUMNS], *bufp;
424 TR(TRACE_IEVENT, ("filling queue in cooked mode"));
426 rc = recur_wgetnstr(win, buf);
428 /* ungetch in reverse order */
429 #ifdef NCURSES_WGETCH_EVENTS
432 safe_ungetch(sp, '\n');
433 for (bufp = buf + strlen(buf); bufp > buf; bufp--)
434 safe_ungetch(sp, bufp[-1]);
436 #ifdef NCURSES_WGETCH_EVENTS
437 /* Return it first */
438 if (rc == KEY_EVENT) {
442 *result = fifo_pull(sp);
443 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
446 if (win->_use_keypad != sp->_keypad_on)
447 _nc_keypad(sp, win->_use_keypad);
451 if (win->_notimeout || (win->_delay >= 0) || (sp->_cbreak > 1)) {
452 if (head == -1) { /* fifo is empty */
456 TR(TRACE_IEVENT, ("timed delay in wgetch()"));
458 delay = (sp->_cbreak - 1) * 100;
462 #ifdef NCURSES_WGETCH_EVENTS
463 if (event_delay >= 0 && delay > event_delay)
467 TR(TRACE_IEVENT, ("delay is %d milliseconds", delay));
469 rc = check_mouse_activity(sp, delay EVENTLIST_2nd(evl));
471 #ifdef NCURSES_WGETCH_EVENTS
474 returnCode(KEY_CODE_YES);
481 /* else go on to read data available */
484 if (win->_use_keypad) {
486 * This is tricky. We only want to get special-key
487 * events one at a time. But we want to accumulate
488 * mouse events until either (a) the mouse logic tells
489 * us it's picked up a complete gesture, or (b)
490 * there's a detectable time lapse after one.
492 * Note: if the mouse code starts failing to compose
493 * press/release events into clicks, you should probably
494 * increase the wait with mouseinterval().
500 ch = kgetch(sp EVENTLIST_2nd(evl));
501 if (ch == KEY_MOUSE) {
503 if (sp->_mouse_inline(sp))
506 if (sp->_maxclick < 0)
510 && (((rc = check_mouse_activity(sp, sp->_maxclick
511 EVENTLIST_2nd(evl))) != 0
513 || !sp->_mouse_parse(sp, runcount)));
514 #ifdef NCURSES_WGETCH_EVENTS
515 if ((rc & TW_EVENT) && !(ch == KEY_EVENT)) {
516 safe_ungetch(sp, ch);
520 if (runcount > 0 && ch != KEY_MOUSE) {
521 #ifdef NCURSES_WGETCH_EVENTS
522 /* mouse event sequence ended by an event, report event */
523 if (ch == KEY_EVENT) {
524 safe_ungetch(sp, KEY_MOUSE); /* FIXME This interrupts a gesture... */
528 /* mouse event sequence ended by keystroke, store keystroke */
529 safe_ungetch(sp, ch);
535 fifo_push(sp EVENTLIST_2nd(evl));
542 if (_nc_handle_sigwinch(sp)) {
543 _nc_update_screensize(sp);
544 /* resizeterm can push KEY_RESIZE */
545 if (cooked_key_in_fifo()) {
546 *result = fifo_pull(sp);
548 * Get the ERR from queue -- it is from WINCH,
549 * so we should take it out, the "error" is handled.
551 if (fifo_peek(sp) == -1)
553 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
561 * If echo() is in effect, display the printable version of the
562 * key on the screen. Carriage return and backspace are treated
563 * specially by Solaris curses:
565 * If carriage return is defined as a function key in the
566 * terminfo, e.g., kent, then Solaris may return either ^J (or ^M
567 * if nonl() is set) or KEY_ENTER depending on the echo() mode.
568 * We echo before translating carriage return based on nonl(),
569 * since the visual result simply moves the cursor to column 0.
571 * Backspace is a different matter. Solaris curses does not
572 * translate it to KEY_BACKSPACE if kbs=^H. This does not depend
573 * on the stty modes, but appears to be a hardcoded special case.
574 * This is a difference from ncurses, which uses the terminfo entry.
575 * However, we provide the same visual result as Solaris, moving the
576 * cursor to the left.
578 if (sp->_echo && !(win->_flags & _ISPAD)) {
579 chtype backup = (ch == KEY_BACKSPACE) ? '\b' : ch;
580 if (backup < KEY_MIN)
581 wechochar(win, backup);
585 * Simulate ICRNL mode
587 if ((ch == '\r') && sp->_nl)
590 /* Strip 8th-bit if so desired. We do this only for characters that
591 * are in the range 128-255, to provide compatibility with terminals
592 * that display only 7-bit characters. Note that 'ch' may be a
593 * function key at this point, so we mustn't strip _those_.
596 if ((ch < KEY_MIN) && (ch & 0x80))
599 T(("wgetch returning : %s", _nc_tracechar(sp, ch)));
602 returnCode(ch >= KEY_MIN ? KEY_CODE_YES : OK);
605 #ifdef NCURSES_WGETCH_EVENTS
607 wgetch_events(WINDOW *win, _nc_eventlist * evl)
612 T((T_CALLED("wgetch_events(%p,%p)"), win, evl));
613 code = _nc_wgetch(win,
629 T((T_CALLED("wgetch(%p)"), (void *) win));
630 code = _nc_wgetch(win,
633 EVENTLIST_2nd((_nc_eventlist *) 0));
643 ** Get an input character, but take care of keypad sequences, returning
644 ** an appropriate code when one matches the input. After each character
645 ** is received, set an alarm call based on ESCDELAY. If no more of the
646 ** sequence is received by the time the alarm goes off, pass through
647 ** the sequence gotten so far.
649 ** This function must be called when there are no cooked keys in queue.
650 ** (that is head==-1 || peek==head)
655 kgetch(SCREEN *sp EVENTLIST_2nd(_nc_eventlist * evl))
659 int timeleft = GetEscdelay(sp);
661 TR(TRACE_IEVENT, ("kgetch() called"));
666 if (cooked_key_in_fifo() && sp->_fifo[head] >= KEY_MIN) {
668 } else if (!raw_key_in_fifo()) {
669 ch = fifo_push(sp EVENTLIST_2nd(evl));
671 peek = head; /* the keys stay uninterpreted */
674 #ifdef NCURSES_WGETCH_EVENTS
675 else if (ch == KEY_EVENT) {
676 peek = head; /* the keys stay uninterpreted */
677 return fifo_pull(sp); /* Remove KEY_EVENT from the queue */
684 /* If not first in queue, somebody put this key there on purpose in
685 * emergency. Consider it higher priority than the unfinished
686 * keysequence we are parsing.
689 /* assume the key is the last in fifo */
690 t_dec(); /* remove the key */
694 TR(TRACE_IEVENT, ("ch: %s", _nc_tracechar(sp, (unsigned char) ch)));
695 while ((ptr != NULL) && (ptr->ch != (unsigned char) ch))
699 TR(TRACE_IEVENT, ("ptr is null"));
702 TR(TRACE_IEVENT, ("ptr=%p, ch=%d, value=%d",
703 (void *) ptr, ptr->ch, ptr->value));
705 if (ptr->value != 0) { /* sequence terminated */
706 TR(TRACE_IEVENT, ("end of sequence"));
716 if (!raw_key_in_fifo()) {
719 TR(TRACE_IEVENT, ("waiting for rest of sequence"));
720 rc = check_mouse_activity(sp, timeleft EVENTLIST_2nd(evl));
721 #ifdef NCURSES_WGETCH_EVENTS
723 TR(TRACE_IEVENT, ("interrupted by a user event"));
724 /* FIXME Should have preserved remainder timeleft for reuse... */
725 peek = head; /* Restart interpreting later */
730 TR(TRACE_IEVENT, ("ran out of time"));