1 /****************************************************************************
2 * Copyright (c) 1998-2013,2014 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.130 2014/05/03 20:49:50 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);
128 * Check for mouse activity, returning nonzero if we find any.
131 check_mouse_activity(SCREEN *sp, int delay EVENTLIST_2nd(_nc_eventlist * evl))
135 #ifdef USE_TERM_DRIVER
136 TERMINAL_CONTROL_BLOCK *TCB = TCBOf(sp);
137 rc = TCBOf(sp)->drv->td_testmouse(TCBOf(sp), delay EVENTLIST_2nd(evl));
139 /* if we emulate terminfo on console, we have to use the console routine */
140 if (IsTermInfoOnConsole(sp)) {
141 HANDLE fd = (HANDLE) _get_osfhandle(sp->_ifd);
142 rc = _nc_mingw_testmouse(sp, fd, delay EVENTLIST_2nd(evl));
145 rc = TCB->drv->td_testmouse(TCB, delay EVENTLIST_2nd(evl));
148 if ((sp->_mouse_type == M_SYSMOUSE)
149 && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
154 rc = _nc_timed_wait(sp,
160 if ((sp->_mouse_type == M_SYSMOUSE)
161 && (sp->_sysmouse_head < sp->_sysmouse_tail)
163 && (errno == EINTR)) {
172 static NCURSES_INLINE int
173 fifo_peek(SCREEN *sp)
175 int ch = (peek >= 0) ? sp->_fifo[peek] : ERR;
176 TR(TRACE_IEVENT, ("peeking at %d", peek));
182 static NCURSES_INLINE int
183 fifo_pull(SCREEN *sp)
185 int ch = (head >= 0) ? sp->_fifo[head] : ERR;
187 TR(TRACE_IEVENT, ("pulling %s from %d", _nc_tracechar(sp, ch), head));
197 if (USE_TRACEF(TRACE_IEVENT)) {
199 _nc_unlock_global(tracef);
205 static NCURSES_INLINE int
206 fifo_push(SCREEN *sp EVENTLIST_2nd(_nc_eventlist * evl))
221 #ifdef NCURSES_WGETCH_EVENTS
223 #if USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
224 || (sp->_mouse_fd >= 0)
227 mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
231 if (mask & TW_EVENT) {
232 T(("fifo_push: ungetch KEY_EVENT"));
233 safe_ungetch(sp, KEY_EVENT);
236 #elif USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
237 if (sp->_mouse_fd >= 0) {
238 mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
242 #if USE_GPM_SUPPORT || USE_EMX_MOUSE
243 if ((sp->_mouse_fd >= 0) && (mask & TW_MOUSE)) {
244 sp->_mouse_event(sp);
250 if ((sp->_mouse_type == M_SYSMOUSE)
251 && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
252 sp->_mouse_event(sp);
255 } else if ((sp->_mouse_type == M_SYSMOUSE)
256 && (mask <= 0) && errno == EINTR) {
257 sp->_mouse_event(sp);
262 #ifdef USE_TERM_DRIVER
263 if ((sp->_mouse_type == M_TERM_DRIVER)
264 && (sp->_drv_mouse_head < sp->_drv_mouse_tail)) {
265 sp->_mouse_event(sp);
271 if (NC_ISATTY(sp->_ifd) && sp->_cbreak) {
272 ch = _read_kbd(0, 1, !sp->_raw);
273 n = (ch == -1) ? -1 : 1;
274 sp->_extended_key = (ch == 0);
278 #ifdef USE_TERM_DRIVER
281 if (NC_ISATTY(sp->_ifd) && IsTermInfoOnConsole(sp) && sp->_cbreak)
282 n = _nc_mingw_console_read(sp,
283 (HANDLE) _get_osfhandle(sp->_ifd),
287 n = CallDriver_1(sp, td_read, &buf);
290 unsigned char c2 = 0;
291 # if USE_PTHREADS_EINTR
292 # if USE_WEAK_SYMBOLS
293 if ((pthread_self) && (pthread_kill) && (pthread_equal))
295 _nc_globals.read_thread = pthread_self();
297 n = (int) read(sp->_ifd, &c2, (size_t) 1);
298 #if USE_PTHREADS_EINTR
299 _nc_globals.read_thread = 0;
307 * Under System V curses with non-restarting signals, getch() returns
308 * with value ERR when a handled signal keeps it from completing.
309 * If signals restart system calls, OTOH, the signal is invisible
310 * except to its handler.
312 * We don't want this difference to show. This piece of code
313 * tries to make it look like we always have restarting signals.
315 if (n <= 0 && errno == EINTR
316 # if USE_PTHREADS_EINTR
317 && (_nc_globals.have_sigwinch == 0)
323 if ((n == -1) || (n == 0)) {
324 TR(TRACE_IEVENT, ("read(%d,&ch,1)=%d, errno=%d", sp->_ifd, n, errno));
327 TR(TRACE_IEVENT, ("read %d characters", n));
329 sp->_fifo[tail] = ch;
334 TR(TRACE_IEVENT, ("pushed %s at %d", _nc_tracechar(sp, ch), tail));
336 if (USE_TRACEF(TRACE_IEVENT)) {
338 _nc_unlock_global(tracef);
344 static NCURSES_INLINE void
345 fifo_clear(SCREEN *sp)
347 memset(sp->_fifo, 0, sizeof(sp->_fifo));
352 static int kgetch(SCREEN *EVENTLIST_2nd(_nc_eventlist * evl));
355 recur_wrefresh(WINDOW *win)
358 SCREEN *sp = _nc_screen_of(win);
359 if (_nc_use_pthreads && sp != CURRENT_SCREEN) {
362 /* temporarily switch to the window's screen to check/refresh */
363 _nc_lock_global(curses);
364 save_SP = CURRENT_SCREEN;
367 _nc_set_screen(save_SP);
368 _nc_unlock_global(curses);
371 if ((is_wintouched(win) || (win->_flags & _HASMOVED))
372 && !(win->_flags & _ISPAD)) {
378 recur_wgetnstr(WINDOW *win, char *buf)
380 SCREEN *sp = _nc_screen_of(win);
385 if (_nc_use_pthreads && sp != CURRENT_SCREEN) {
388 /* temporarily switch to the window's screen to get cooked input */
389 _nc_lock_global(curses);
390 save_SP = CURRENT_SCREEN;
392 rc = recur_wgetnstr(win, buf);
393 _nc_set_screen(save_SP);
394 _nc_unlock_global(curses);
398 sp->_called_wgetch = TRUE;
399 rc = wgetnstr(win, buf, MAXCOLUMNS);
400 sp->_called_wgetch = FALSE;
409 _nc_wgetch(WINDOW *win,
412 EVENTLIST_2nd(_nc_eventlist * evl))
417 #ifdef NCURSES_WGETCH_EVENTS
418 long event_delay = -1;
421 T((T_CALLED("_nc_wgetch(%p)"), (void *) win));
425 sp = _nc_screen_of(win);
426 if (win == 0 || sp == 0) {
430 if (cooked_key_in_fifo()) {
432 *result = fifo_pull(sp);
433 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
435 #ifdef NCURSES_WGETCH_EVENTS
436 if (evl && (evl->count == 0))
438 event_delay = _nc_eventlist_timeout(evl);
442 * Handle cooked mode. Grab a string from the screen,
443 * stuff its contents in the FIFO queue, and pop off
444 * the first character to return it.
450 !sp->_called_wgetch) {
451 char buf[MAXCOLUMNS], *bufp;
453 TR(TRACE_IEVENT, ("filling queue in cooked mode"));
455 /* ungetch in reverse order */
456 #ifdef NCURSES_WGETCH_EVENTS
457 rc = recur_wgetnstr(win, buf);
458 if (rc != KEY_EVENT && rc != ERR)
459 safe_ungetch(sp, '\n');
461 if (recur_wgetnstr(win, buf) != ERR)
462 safe_ungetch(sp, '\n');
464 for (bufp = buf + strlen(buf); bufp > buf; bufp--)
465 safe_ungetch(sp, bufp[-1]);
467 #ifdef NCURSES_WGETCH_EVENTS
468 /* Return it first */
469 if (rc == KEY_EVENT) {
473 *result = fifo_pull(sp);
474 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
477 if (win->_use_keypad != sp->_keypad_on)
478 _nc_keypad(sp, win->_use_keypad);
482 if (win->_notimeout || (win->_delay >= 0) || (sp->_cbreak > 1)) {
483 if (head == -1) { /* fifo is empty */
486 TR(TRACE_IEVENT, ("timed delay in wgetch()"));
488 delay = (sp->_cbreak - 1) * 100;
492 #ifdef NCURSES_WGETCH_EVENTS
493 if (event_delay >= 0 && delay > event_delay)
497 TR(TRACE_IEVENT, ("delay is %d milliseconds", delay));
499 rc = check_mouse_activity(sp, delay EVENTLIST_2nd(evl));
501 #ifdef NCURSES_WGETCH_EVENTS
504 returnCode(KEY_CODE_YES);
511 /* else go on to read data available */
514 if (win->_use_keypad) {
516 * This is tricky. We only want to get special-key
517 * events one at a time. But we want to accumulate
518 * mouse events until either (a) the mouse logic tells
519 * us it's picked up a complete gesture, or (b)
520 * there's a detectable time lapse after one.
522 * Note: if the mouse code starts failing to compose
523 * press/release events into clicks, you should probably
524 * increase the wait with mouseinterval().
529 ch = kgetch(sp EVENTLIST_2nd(evl));
530 if (ch == KEY_MOUSE) {
532 if (sp->_mouse_inline(sp))
535 if (sp->_maxclick < 0)
539 && (((rc = check_mouse_activity(sp, sp->_maxclick
540 EVENTLIST_2nd(evl))) != 0
542 || !sp->_mouse_parse(sp, runcount)));
543 #ifdef NCURSES_WGETCH_EVENTS
544 if ((rc & TW_EVENT) && !(ch == KEY_EVENT)) {
545 safe_ungetch(sp, ch);
549 if (runcount > 0 && ch != KEY_MOUSE) {
550 #ifdef NCURSES_WGETCH_EVENTS
551 /* mouse event sequence ended by an event, report event */
552 if (ch == KEY_EVENT) {
553 safe_ungetch(sp, KEY_MOUSE); /* FIXME This interrupts a gesture... */
557 /* mouse event sequence ended by keystroke, store keystroke */
558 safe_ungetch(sp, ch);
564 fifo_push(sp EVENTLIST_2nd(evl));
571 if (_nc_handle_sigwinch(sp)) {
572 _nc_update_screensize(sp);
573 /* resizeterm can push KEY_RESIZE */
574 if (cooked_key_in_fifo()) {
575 *result = fifo_pull(sp);
577 * Get the ERR from queue -- it is from WINCH,
578 * so we should take it out, the "error" is handled.
580 if (fifo_peek(sp) == -1)
582 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
590 * If echo() is in effect, display the printable version of the
591 * key on the screen. Carriage return and backspace are treated
592 * specially by Solaris curses:
594 * If carriage return is defined as a function key in the
595 * terminfo, e.g., kent, then Solaris may return either ^J (or ^M
596 * if nonl() is set) or KEY_ENTER depending on the echo() mode.
597 * We echo before translating carriage return based on nonl(),
598 * since the visual result simply moves the cursor to column 0.
600 * Backspace is a different matter. Solaris curses does not
601 * translate it to KEY_BACKSPACE if kbs=^H. This does not depend
602 * on the stty modes, but appears to be a hardcoded special case.
603 * This is a difference from ncurses, which uses the terminfo entry.
604 * However, we provide the same visual result as Solaris, moving the
605 * cursor to the left.
607 if (sp->_echo && !(win->_flags & _ISPAD)) {
608 chtype backup = (chtype) ((ch == KEY_BACKSPACE) ? '\b' : ch);
609 if (backup < KEY_MIN)
610 wechochar(win, backup);
614 * Simulate ICRNL mode
616 if ((ch == '\r') && sp->_nl)
619 /* Strip 8th-bit if so desired. We do this only for characters that
620 * are in the range 128-255, to provide compatibility with terminals
621 * that display only 7-bit characters. Note that 'ch' may be a
622 * function key at this point, so we mustn't strip _those_.
625 if ((ch < KEY_MIN) && (ch & 0x80))
628 T(("wgetch returning : %s", _nc_tracechar(sp, ch)));
631 returnCode(ch >= KEY_MIN ? KEY_CODE_YES : OK);
634 #ifdef NCURSES_WGETCH_EVENTS
636 wgetch_events(WINDOW *win, _nc_eventlist * evl)
641 T((T_CALLED("wgetch_events(%p,%p)"), win, evl));
642 code = _nc_wgetch(win,
658 T((T_CALLED("wgetch(%p)"), (void *) win));
659 code = _nc_wgetch(win,
662 EVENTLIST_2nd((_nc_eventlist *) 0));
672 ** Get an input character, but take care of keypad sequences, returning
673 ** an appropriate code when one matches the input. After each character
674 ** is received, set an alarm call based on ESCDELAY. If no more of the
675 ** sequence is received by the time the alarm goes off, pass through
676 ** the sequence gotten so far.
678 ** This function must be called when there are no cooked keys in queue.
679 ** (that is head==-1 || peek==head)
684 kgetch(SCREEN *sp EVENTLIST_2nd(_nc_eventlist * evl))
688 int timeleft = GetEscdelay(sp);
690 TR(TRACE_IEVENT, ("kgetch() called"));
695 if (cooked_key_in_fifo() && sp->_fifo[head] >= KEY_MIN) {
697 } else if (!raw_key_in_fifo()) {
698 ch = fifo_push(sp EVENTLIST_2nd(evl));
700 peek = head; /* the keys stay uninterpreted */
703 #ifdef NCURSES_WGETCH_EVENTS
704 else if (ch == KEY_EVENT) {
705 peek = head; /* the keys stay uninterpreted */
706 return fifo_pull(sp); /* Remove KEY_EVENT from the queue */
713 /* If not first in queue, somebody put this key there on purpose in
714 * emergency. Consider it higher priority than the unfinished
715 * keysequence we are parsing.
718 /* assume the key is the last in fifo */
719 t_dec(); /* remove the key */
723 TR(TRACE_IEVENT, ("ch: %s", _nc_tracechar(sp, (unsigned char) ch)));
724 while ((ptr != NULL) && (ptr->ch != (unsigned char) ch))
728 TR(TRACE_IEVENT, ("ptr is null"));
731 TR(TRACE_IEVENT, ("ptr=%p, ch=%d, value=%d",
732 (void *) ptr, ptr->ch, ptr->value));
734 if (ptr->value != 0) { /* sequence terminated */
735 TR(TRACE_IEVENT, ("end of sequence"));
746 if (!raw_key_in_fifo()) {
749 TR(TRACE_IEVENT, ("waiting for rest of sequence"));
750 rc = check_mouse_activity(sp, timeleft EVENTLIST_2nd(evl));
751 #ifdef NCURSES_WGETCH_EVENTS
753 TR(TRACE_IEVENT, ("interrupted by a user event"));
754 /* FIXME Should have preserved remainder timeleft for reuse... */
755 peek = head; /* Restart interpreting later */
760 TR(TRACE_IEVENT, ("ran out of time"));