1 /****************************************************************************
2 * Copyright (c) 1998-2014,2015 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.133 2015/11/29 01:28:52 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 USE_TERM_DRIVER
130 _nc_get_handle(int fd)
132 intptr_t value = _get_osfhandle(fd);
133 return (HANDLE) value;
139 * Check for mouse activity, returning nonzero if we find any.
142 check_mouse_activity(SCREEN *sp, int delay EVENTLIST_2nd(_nc_eventlist * evl))
146 #ifdef USE_TERM_DRIVER
147 TERMINAL_CONTROL_BLOCK *TCB = TCBOf(sp);
148 rc = TCBOf(sp)->drv->td_testmouse(TCBOf(sp), delay EVENTLIST_2nd(evl));
150 /* if we emulate terminfo on console, we have to use the console routine */
151 if (IsTermInfoOnConsole(sp)) {
152 HANDLE fd = _nc_get_handle(sp->_ifd);
153 rc = _nc_mingw_testmouse(sp, fd, delay EVENTLIST_2nd(evl));
156 rc = TCB->drv->td_testmouse(TCB, delay EVENTLIST_2nd(evl));
159 if ((sp->_mouse_type == M_SYSMOUSE)
160 && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
165 rc = _nc_timed_wait(sp,
171 if ((sp->_mouse_type == M_SYSMOUSE)
172 && (sp->_sysmouse_head < sp->_sysmouse_tail)
174 && (errno == EINTR)) {
183 static NCURSES_INLINE int
184 fifo_peek(SCREEN *sp)
186 int ch = (peek >= 0) ? sp->_fifo[peek] : ERR;
187 TR(TRACE_IEVENT, ("peeking at %d", peek));
193 static NCURSES_INLINE int
194 fifo_pull(SCREEN *sp)
196 int ch = (head >= 0) ? sp->_fifo[head] : ERR;
198 TR(TRACE_IEVENT, ("pulling %s from %d", _nc_tracechar(sp, ch), head));
208 if (USE_TRACEF(TRACE_IEVENT)) {
210 _nc_unlock_global(tracef);
216 static NCURSES_INLINE int
217 fifo_push(SCREEN *sp EVENTLIST_2nd(_nc_eventlist * evl))
232 #ifdef NCURSES_WGETCH_EVENTS
234 #if USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
235 || (sp->_mouse_fd >= 0)
238 mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
242 if (mask & TW_EVENT) {
243 T(("fifo_push: ungetch KEY_EVENT"));
244 safe_ungetch(sp, KEY_EVENT);
247 #elif USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
248 if (sp->_mouse_fd >= 0) {
249 mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
253 #if USE_GPM_SUPPORT || USE_EMX_MOUSE
254 if ((sp->_mouse_fd >= 0) && (mask & TW_MOUSE)) {
255 sp->_mouse_event(sp);
261 if ((sp->_mouse_type == M_SYSMOUSE)
262 && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
263 sp->_mouse_event(sp);
266 } else if ((sp->_mouse_type == M_SYSMOUSE)
267 && (mask <= 0) && errno == EINTR) {
268 sp->_mouse_event(sp);
273 #ifdef USE_TERM_DRIVER
274 if ((sp->_mouse_type == M_TERM_DRIVER)
275 && (sp->_drv_mouse_head < sp->_drv_mouse_tail)) {
276 sp->_mouse_event(sp);
282 if (NC_ISATTY(sp->_ifd) && sp->_cbreak) {
283 ch = _read_kbd(0, 1, !sp->_raw);
284 n = (ch == -1) ? -1 : 1;
285 sp->_extended_key = (ch == 0);
289 #ifdef USE_TERM_DRIVER
292 if (NC_ISATTY(sp->_ifd) && IsTermInfoOnConsole(sp) && sp->_cbreak)
293 n = _nc_mingw_console_read(sp,
294 _nc_get_handle(sp->_ifd),
298 n = CallDriver_1(sp, td_read, &buf);
301 unsigned char c2 = 0;
302 # if USE_PTHREADS_EINTR
303 # if USE_WEAK_SYMBOLS
304 if ((pthread_self) && (pthread_kill) && (pthread_equal))
306 _nc_globals.read_thread = pthread_self();
308 n = (int) read(sp->_ifd, &c2, (size_t) 1);
309 #if USE_PTHREADS_EINTR
310 _nc_globals.read_thread = 0;
318 * Under System V curses with non-restarting signals, getch() returns
319 * with value ERR when a handled signal keeps it from completing.
320 * If signals restart system calls, OTOH, the signal is invisible
321 * except to its handler.
323 * We don't want this difference to show. This piece of code
324 * tries to make it look like we always have restarting signals.
326 if (n <= 0 && errno == EINTR
327 # if USE_PTHREADS_EINTR
328 && (_nc_globals.have_sigwinch == 0)
334 if ((n == -1) || (n == 0)) {
335 TR(TRACE_IEVENT, ("read(%d,&ch,1)=%d, errno=%d", sp->_ifd, n, errno));
338 TR(TRACE_IEVENT, ("read %d characters", n));
340 sp->_fifo[tail] = ch;
345 TR(TRACE_IEVENT, ("pushed %s at %d", _nc_tracechar(sp, ch), tail));
347 if (USE_TRACEF(TRACE_IEVENT)) {
349 _nc_unlock_global(tracef);
355 static NCURSES_INLINE void
356 fifo_clear(SCREEN *sp)
358 memset(sp->_fifo, 0, sizeof(sp->_fifo));
363 static int kgetch(SCREEN *EVENTLIST_2nd(_nc_eventlist * evl));
366 recur_wrefresh(WINDOW *win)
369 SCREEN *sp = _nc_screen_of(win);
370 if (_nc_use_pthreads && sp != CURRENT_SCREEN) {
373 /* temporarily switch to the window's screen to check/refresh */
374 _nc_lock_global(curses);
375 save_SP = CURRENT_SCREEN;
378 _nc_set_screen(save_SP);
379 _nc_unlock_global(curses);
382 if ((is_wintouched(win) || (win->_flags & _HASMOVED))
383 && !(win->_flags & _ISPAD)) {
389 recur_wgetnstr(WINDOW *win, char *buf)
391 SCREEN *sp = _nc_screen_of(win);
396 if (_nc_use_pthreads && sp != CURRENT_SCREEN) {
399 /* temporarily switch to the window's screen to get cooked input */
400 _nc_lock_global(curses);
401 save_SP = CURRENT_SCREEN;
403 rc = recur_wgetnstr(win, buf);
404 _nc_set_screen(save_SP);
405 _nc_unlock_global(curses);
409 sp->_called_wgetch = TRUE;
410 rc = wgetnstr(win, buf, MAXCOLUMNS);
411 sp->_called_wgetch = FALSE;
420 _nc_wgetch(WINDOW *win,
423 EVENTLIST_2nd(_nc_eventlist * evl))
428 #ifdef NCURSES_WGETCH_EVENTS
429 int event_delay = -1;
432 T((T_CALLED("_nc_wgetch(%p)"), (void *) win));
436 sp = _nc_screen_of(win);
437 if (win == 0 || sp == 0) {
441 if (cooked_key_in_fifo()) {
443 *result = fifo_pull(sp);
444 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
446 #ifdef NCURSES_WGETCH_EVENTS
447 if (evl && (evl->count == 0))
449 event_delay = _nc_eventlist_timeout(evl);
453 * Handle cooked mode. Grab a string from the screen,
454 * stuff its contents in the FIFO queue, and pop off
455 * the first character to return it.
461 !sp->_called_wgetch) {
462 char buf[MAXCOLUMNS], *bufp;
464 TR(TRACE_IEVENT, ("filling queue in cooked mode"));
466 /* ungetch in reverse order */
467 #ifdef NCURSES_WGETCH_EVENTS
468 rc = recur_wgetnstr(win, buf);
469 if (rc != KEY_EVENT && rc != ERR)
470 safe_ungetch(sp, '\n');
472 if (recur_wgetnstr(win, buf) != ERR)
473 safe_ungetch(sp, '\n');
475 for (bufp = buf + strlen(buf); bufp > buf; bufp--)
476 safe_ungetch(sp, bufp[-1]);
478 #ifdef NCURSES_WGETCH_EVENTS
479 /* Return it first */
480 if (rc == KEY_EVENT) {
484 *result = fifo_pull(sp);
485 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
488 if (win->_use_keypad != sp->_keypad_on)
489 _nc_keypad(sp, win->_use_keypad);
493 if (win->_notimeout || (win->_delay >= 0) || (sp->_cbreak > 1)) {
494 if (head == -1) { /* fifo is empty */
497 TR(TRACE_IEVENT, ("timed delay in wgetch()"));
499 delay = (sp->_cbreak - 1) * 100;
500 else if (win->_notimeout)
505 #ifdef NCURSES_WGETCH_EVENTS
506 if (event_delay >= 0 && delay > event_delay)
510 TR(TRACE_IEVENT, ("delay is %d milliseconds", delay));
512 rc = check_mouse_activity(sp, delay EVENTLIST_2nd(evl));
514 #ifdef NCURSES_WGETCH_EVENTS
517 returnCode(KEY_CODE_YES);
524 /* else go on to read data available */
527 if (win->_use_keypad) {
529 * This is tricky. We only want to get special-key
530 * events one at a time. But we want to accumulate
531 * mouse events until either (a) the mouse logic tells
532 * us it's picked up a complete gesture, or (b)
533 * there's a detectable time lapse after one.
535 * Note: if the mouse code starts failing to compose
536 * press/release events into clicks, you should probably
537 * increase the wait with mouseinterval().
542 ch = kgetch(sp EVENTLIST_2nd(evl));
543 if (ch == KEY_MOUSE) {
545 if (sp->_mouse_inline(sp))
548 if (sp->_maxclick < 0)
552 && (((rc = check_mouse_activity(sp, sp->_maxclick
553 EVENTLIST_2nd(evl))) != 0
555 || !sp->_mouse_parse(sp, runcount)));
556 #ifdef NCURSES_WGETCH_EVENTS
557 if ((rc & TW_EVENT) && !(ch == KEY_EVENT)) {
558 safe_ungetch(sp, ch);
562 if (runcount > 0 && ch != KEY_MOUSE) {
563 #ifdef NCURSES_WGETCH_EVENTS
564 /* mouse event sequence ended by an event, report event */
565 if (ch == KEY_EVENT) {
566 safe_ungetch(sp, KEY_MOUSE); /* FIXME This interrupts a gesture... */
570 /* mouse event sequence ended by keystroke, store keystroke */
571 safe_ungetch(sp, ch);
577 fifo_push(sp EVENTLIST_2nd(evl));
584 if (_nc_handle_sigwinch(sp)) {
585 _nc_update_screensize(sp);
586 /* resizeterm can push KEY_RESIZE */
587 if (cooked_key_in_fifo()) {
588 *result = fifo_pull(sp);
590 * Get the ERR from queue -- it is from WINCH,
591 * so we should take it out, the "error" is handled.
593 if (fifo_peek(sp) == -1)
595 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
603 * If echo() is in effect, display the printable version of the
604 * key on the screen. Carriage return and backspace are treated
605 * specially by Solaris curses:
607 * If carriage return is defined as a function key in the
608 * terminfo, e.g., kent, then Solaris may return either ^J (or ^M
609 * if nonl() is set) or KEY_ENTER depending on the echo() mode.
610 * We echo before translating carriage return based on nonl(),
611 * since the visual result simply moves the cursor to column 0.
613 * Backspace is a different matter. Solaris curses does not
614 * translate it to KEY_BACKSPACE if kbs=^H. This does not depend
615 * on the stty modes, but appears to be a hardcoded special case.
616 * This is a difference from ncurses, which uses the terminfo entry.
617 * However, we provide the same visual result as Solaris, moving the
618 * cursor to the left.
620 if (sp->_echo && !(win->_flags & _ISPAD)) {
621 chtype backup = (chtype) ((ch == KEY_BACKSPACE) ? '\b' : ch);
622 if (backup < KEY_MIN)
623 wechochar(win, backup);
627 * Simulate ICRNL mode
629 if ((ch == '\r') && sp->_nl)
632 /* Strip 8th-bit if so desired. We do this only for characters that
633 * are in the range 128-255, to provide compatibility with terminals
634 * that display only 7-bit characters. Note that 'ch' may be a
635 * function key at this point, so we mustn't strip _those_.
638 if ((ch < KEY_MIN) && (ch & 0x80))
641 T(("wgetch returning : %s", _nc_tracechar(sp, ch)));
644 returnCode(ch >= KEY_MIN ? KEY_CODE_YES : OK);
647 #ifdef NCURSES_WGETCH_EVENTS
649 wgetch_events(WINDOW *win, _nc_eventlist * evl)
654 T((T_CALLED("wgetch_events(%p,%p)"), win, evl));
655 code = _nc_wgetch(win,
671 T((T_CALLED("wgetch(%p)"), (void *) win));
672 code = _nc_wgetch(win,
675 EVENTLIST_2nd((_nc_eventlist *) 0));
685 ** Get an input character, but take care of keypad sequences, returning
686 ** an appropriate code when one matches the input. After each character
687 ** is received, set an alarm call based on ESCDELAY. If no more of the
688 ** sequence is received by the time the alarm goes off, pass through
689 ** the sequence gotten so far.
691 ** This function must be called when there are no cooked keys in queue.
692 ** (that is head==-1 || peek==head)
697 kgetch(SCREEN *sp EVENTLIST_2nd(_nc_eventlist * evl))
701 int timeleft = GetEscdelay(sp);
703 TR(TRACE_IEVENT, ("kgetch() called"));
708 if (cooked_key_in_fifo() && sp->_fifo[head] >= KEY_MIN) {
710 } else if (!raw_key_in_fifo()) {
711 ch = fifo_push(sp EVENTLIST_2nd(evl));
713 peek = head; /* the keys stay uninterpreted */
716 #ifdef NCURSES_WGETCH_EVENTS
717 else if (ch == KEY_EVENT) {
718 peek = head; /* the keys stay uninterpreted */
719 return fifo_pull(sp); /* Remove KEY_EVENT from the queue */
726 /* If not first in queue, somebody put this key there on purpose in
727 * emergency. Consider it higher priority than the unfinished
728 * keysequence we are parsing.
731 /* assume the key is the last in fifo */
732 t_dec(); /* remove the key */
736 TR(TRACE_IEVENT, ("ch: %s", _nc_tracechar(sp, (unsigned char) ch)));
737 while ((ptr != NULL) && (ptr->ch != (unsigned char) ch))
741 TR(TRACE_IEVENT, ("ptr is null"));
744 TR(TRACE_IEVENT, ("ptr=%p, ch=%d, value=%d",
745 (void *) ptr, ptr->ch, ptr->value));
747 if (ptr->value != 0) { /* sequence terminated */
748 TR(TRACE_IEVENT, ("end of sequence"));
759 if (!raw_key_in_fifo()) {
762 TR(TRACE_IEVENT, ("waiting for rest of sequence"));
763 rc = check_mouse_activity(sp, timeleft EVENTLIST_2nd(evl));
764 #ifdef NCURSES_WGETCH_EVENTS
766 TR(TRACE_IEVENT, ("interrupted by a user event"));
767 /* FIXME Should have preserved remainder timeleft for reuse... */
768 peek = head; /* Restart interpreting later */
773 TR(TRACE_IEVENT, ("ran out of time"));