1 /****************************************************************************
2 * Copyright 2018-2019,2020 Thomas E. Dickey *
3 * Copyright 1998-2015,2016 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************/
30 /****************************************************************************
31 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
32 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
33 * and: Thomas E. Dickey 1996-on *
34 * and: Juergen Pfeifer 2009 *
35 ****************************************************************************/
40 ** The routine getch().
44 #include <curses.priv.h>
46 MODULE_ID("$Id: lib_getch.c,v 1.139 2020/02/02 23:34:34 tom Exp $")
48 #include <fifo_defs.h>
51 #define GetEscdelay(sp) *_nc_ptr_Escdelay(sp)
53 NCURSES_PUBLIC_VAR(ESCDELAY) (void)
55 return *(_nc_ptr_Escdelay(CURRENT_SCREEN));
59 _nc_ptr_Escdelay(SCREEN *sp)
61 return ptrEscdelay(sp);
64 #define GetEscdelay(sp) ESCDELAY
65 NCURSES_EXPORT_VAR(int) ESCDELAY = 1000;
70 NCURSES_SP_NAME(set_escdelay) (NCURSES_SP_DCLx int value)
92 set_escdelay(int value)
99 code = NCURSES_SP_NAME(set_escdelay) (CURRENT_SCREEN, value);
108 #endif /* NCURSES_EXT_FUNCS */
110 #if NCURSES_EXT_FUNCS
112 NCURSES_SP_NAME(get_escdelay) (NCURSES_SP_DCL0)
117 return GetEscdelay(SP_PARM);
124 return NCURSES_SP_NAME(get_escdelay) (CURRENT_SCREEN);
127 #endif /* NCURSES_EXT_FUNCS */
130 _nc_use_meta(WINDOW *win)
132 SCREEN *sp = _nc_screen_of(win);
133 return (sp ? sp->_use_meta : 0);
136 #ifdef USE_TERM_DRIVER
139 _nc_get_handle(int fd)
141 intptr_t value = _get_osfhandle(fd);
142 return (HANDLE) value;
148 * Check for mouse activity, returning nonzero if we find any.
151 check_mouse_activity(SCREEN *sp, int delay EVENTLIST_2nd(_nc_eventlist * evl))
155 #ifdef USE_TERM_DRIVER
156 TERMINAL_CONTROL_BLOCK *TCB = TCBOf(sp);
157 rc = TCBOf(sp)->drv->td_testmouse(TCBOf(sp), delay EVENTLIST_2nd(evl));
159 /* if we emulate terminfo on console, we have to use the console routine */
160 if (IsTermInfoOnConsole(sp)) {
161 HANDLE fd = _nc_get_handle(sp->_ifd);
162 rc = _nc_mingw_testmouse(sp, fd, delay EVENTLIST_2nd(evl));
165 rc = TCB->drv->td_testmouse(TCB, delay EVENTLIST_2nd(evl));
168 if ((sp->_mouse_type == M_SYSMOUSE)
169 && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
174 rc = _nc_timed_wait(sp,
180 if ((sp->_mouse_type == M_SYSMOUSE)
181 && (sp->_sysmouse_head < sp->_sysmouse_tail)
183 && (errno == EINTR)) {
192 static NCURSES_INLINE int
193 fifo_peek(SCREEN *sp)
195 int ch = (peek >= 0) ? sp->_fifo[peek] : ERR;
196 TR(TRACE_IEVENT, ("peeking at %d", peek));
202 static NCURSES_INLINE int
203 fifo_pull(SCREEN *sp)
205 int ch = (head >= 0) ? sp->_fifo[head] : ERR;
207 TR(TRACE_IEVENT, ("pulling %s from %d", _nc_tracechar(sp, ch), head));
217 if (USE_TRACEF(TRACE_IEVENT)) {
219 _nc_unlock_global(tracef);
225 static NCURSES_INLINE int
226 fifo_push(SCREEN *sp EVENTLIST_2nd(_nc_eventlist * evl))
236 #ifdef NCURSES_WGETCH_EVENTS
238 #if USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
239 || (sp->_mouse_fd >= 0)
242 mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
246 if (mask & TW_EVENT) {
247 T(("fifo_push: ungetch KEY_EVENT"));
248 safe_ungetch(sp, KEY_EVENT);
251 #elif USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
252 if (sp->_mouse_fd >= 0) {
253 mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
257 #if USE_GPM_SUPPORT || USE_EMX_MOUSE
258 if ((sp->_mouse_fd >= 0) && (mask & TW_MOUSE)) {
259 sp->_mouse_event(sp);
265 if ((sp->_mouse_type == M_SYSMOUSE)
266 && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
267 sp->_mouse_event(sp);
270 } else if ((sp->_mouse_type == M_SYSMOUSE)
271 && (mask <= 0) && errno == EINTR) {
272 sp->_mouse_event(sp);
277 #ifdef USE_TERM_DRIVER
278 if ((sp->_mouse_type == M_TERM_DRIVER)
279 && (sp->_drv_mouse_head < sp->_drv_mouse_tail)) {
280 sp->_mouse_event(sp);
286 if (NC_ISATTY(sp->_ifd) && sp->_cbreak) {
287 ch = _read_kbd(0, 1, !sp->_raw);
288 n = (ch == -1) ? -1 : 1;
289 sp->_extended_key = (ch == 0);
293 #ifdef USE_TERM_DRIVER
296 if (NC_ISATTY(sp->_ifd) && IsTermInfoOnConsole(sp) && sp->_cbreak)
297 n = _nc_mingw_console_read(sp,
298 _nc_get_handle(sp->_ifd),
302 n = CallDriver_1(sp, td_read, &buf);
305 unsigned char c2 = 0;
306 # if USE_PTHREADS_EINTR
307 # if USE_WEAK_SYMBOLS
308 if ((pthread_self) && (pthread_kill) && (pthread_equal))
310 _nc_globals.read_thread = pthread_self();
312 n = (int) read(sp->_ifd, &c2, (size_t) 1);
313 #if USE_PTHREADS_EINTR
314 _nc_globals.read_thread = 0;
320 if ((n == -1) || (n == 0)) {
321 TR(TRACE_IEVENT, ("read(%d,&ch,1)=%d, errno=%d", sp->_ifd, n, errno));
324 TR(TRACE_IEVENT, ("read %d characters", n));
326 sp->_fifo[tail] = ch;
331 TR(TRACE_IEVENT, ("pushed %s at %d", _nc_tracechar(sp, ch), tail));
333 if (USE_TRACEF(TRACE_IEVENT)) {
335 _nc_unlock_global(tracef);
341 static NCURSES_INLINE void
342 fifo_clear(SCREEN *sp)
344 memset(sp->_fifo, 0, sizeof(sp->_fifo));
349 static int kgetch(SCREEN *, bool EVENTLIST_2nd(_nc_eventlist *));
352 recur_wrefresh(WINDOW *win)
355 SCREEN *sp = _nc_screen_of(win);
356 if (_nc_use_pthreads && sp != CURRENT_SCREEN) {
359 /* temporarily switch to the window's screen to check/refresh */
360 _nc_lock_global(curses);
361 save_SP = CURRENT_SCREEN;
364 _nc_set_screen(save_SP);
365 _nc_unlock_global(curses);
368 if ((is_wintouched(win) || (win->_flags & _HASMOVED))
369 && !(win->_flags & _ISPAD)) {
375 recur_wgetnstr(WINDOW *win, char *buf)
377 SCREEN *sp = _nc_screen_of(win);
382 if (_nc_use_pthreads && sp != CURRENT_SCREEN) {
385 /* temporarily switch to the window's screen to get cooked input */
386 _nc_lock_global(curses);
387 save_SP = CURRENT_SCREEN;
389 rc = recur_wgetnstr(win, buf);
390 _nc_set_screen(save_SP);
391 _nc_unlock_global(curses);
395 sp->_called_wgetch = TRUE;
396 rc = wgetnstr(win, buf, MAXCOLUMNS);
397 sp->_called_wgetch = FALSE;
406 _nc_wgetch(WINDOW *win,
409 EVENTLIST_2nd(_nc_eventlist * evl))
414 #ifdef NCURSES_WGETCH_EVENTS
415 int event_delay = -1;
418 T((T_CALLED("_nc_wgetch(%p)"), (void *) win));
422 sp = _nc_screen_of(win);
423 if (win == 0 || sp == 0) {
427 if (cooked_key_in_fifo()) {
429 *result = fifo_pull(sp);
430 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
432 #ifdef NCURSES_WGETCH_EVENTS
433 if (evl && (evl->count == 0))
435 event_delay = _nc_eventlist_timeout(evl);
439 * Handle cooked mode. Grab a string from the screen,
440 * stuff its contents in the FIFO queue, and pop off
441 * the first character to return it.
447 !sp->_called_wgetch) {
448 char buf[MAXCOLUMNS], *bufp;
450 TR(TRACE_IEVENT, ("filling queue in cooked mode"));
452 /* ungetch in reverse order */
453 #ifdef NCURSES_WGETCH_EVENTS
454 rc = recur_wgetnstr(win, buf);
455 if (rc != KEY_EVENT && rc != ERR)
456 safe_ungetch(sp, '\n');
458 if (recur_wgetnstr(win, buf) != ERR)
459 safe_ungetch(sp, '\n');
461 for (bufp = buf + strlen(buf); bufp > buf; bufp--)
462 safe_ungetch(sp, bufp[-1]);
464 #ifdef NCURSES_WGETCH_EVENTS
465 /* Return it first */
466 if (rc == KEY_EVENT) {
470 *result = fifo_pull(sp);
471 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
474 if (win->_use_keypad != sp->_keypad_on)
475 _nc_keypad(sp, win->_use_keypad);
479 if (win->_notimeout || (win->_delay >= 0) || (sp->_cbreak > 1)) {
480 if (head == -1) { /* fifo is empty */
483 TR(TRACE_IEVENT, ("timed delay in wgetch()"));
485 delay = (sp->_cbreak - 1) * 100;
489 #ifdef NCURSES_WGETCH_EVENTS
490 if (event_delay >= 0 && delay > event_delay)
494 TR(TRACE_IEVENT, ("delay is %d milliseconds", delay));
496 rc = check_mouse_activity(sp, delay EVENTLIST_2nd(evl));
498 #ifdef NCURSES_WGETCH_EVENTS
501 returnCode(KEY_CODE_YES);
508 /* else go on to read data available */
511 if (win->_use_keypad) {
513 * This is tricky. We only want to get special-key
514 * events one at a time. But we want to accumulate
515 * mouse events until either (a) the mouse logic tells
516 * us it's picked up a complete gesture, or (b)
517 * there's a detectable time lapse after one.
519 * Note: if the mouse code starts failing to compose
520 * press/release events into clicks, you should probably
521 * increase the wait with mouseinterval().
526 ch = kgetch(sp, win->_notimeout EVENTLIST_2nd(evl));
527 if (ch == KEY_MOUSE) {
529 if (sp->_mouse_inline(sp))
532 if (sp->_maxclick < 0)
536 && (((rc = check_mouse_activity(sp, sp->_maxclick
537 EVENTLIST_2nd(evl))) != 0
539 || !sp->_mouse_parse(sp, runcount)));
540 #ifdef NCURSES_WGETCH_EVENTS
541 if ((rc & TW_EVENT) && !(ch == KEY_EVENT)) {
542 safe_ungetch(sp, ch);
546 if (runcount > 0 && ch != KEY_MOUSE) {
547 #ifdef NCURSES_WGETCH_EVENTS
548 /* mouse event sequence ended by an event, report event */
549 if (ch == KEY_EVENT) {
550 safe_ungetch(sp, KEY_MOUSE); /* FIXME This interrupts a gesture... */
554 /* mouse event sequence ended by keystroke, store keystroke */
555 safe_ungetch(sp, ch);
561 fifo_push(sp EVENTLIST_2nd(evl));
568 if (_nc_handle_sigwinch(sp)) {
569 _nc_update_screensize(sp);
570 /* resizeterm can push KEY_RESIZE */
571 if (cooked_key_in_fifo()) {
572 *result = fifo_pull(sp);
574 * Get the ERR from queue -- it is from WINCH,
575 * so we should take it out, the "error" is handled.
577 if (fifo_peek(sp) == -1)
579 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
587 * If echo() is in effect, display the printable version of the
588 * key on the screen. Carriage return and backspace are treated
589 * specially by Solaris curses:
591 * If carriage return is defined as a function key in the
592 * terminfo, e.g., kent, then Solaris may return either ^J (or ^M
593 * if nonl() is set) or KEY_ENTER depending on the echo() mode.
594 * We echo before translating carriage return based on nonl(),
595 * since the visual result simply moves the cursor to column 0.
597 * Backspace is a different matter. Solaris curses does not
598 * translate it to KEY_BACKSPACE if kbs=^H. This does not depend
599 * on the stty modes, but appears to be a hardcoded special case.
600 * This is a difference from ncurses, which uses the terminfo entry.
601 * However, we provide the same visual result as Solaris, moving the
602 * cursor to the left.
604 if (sp->_echo && !(win->_flags & _ISPAD)) {
605 chtype backup = (chtype) ((ch == KEY_BACKSPACE) ? '\b' : ch);
606 if (backup < KEY_MIN)
607 wechochar(win, backup);
611 * Simulate ICRNL mode
613 if ((ch == '\r') && sp->_nl)
616 /* Strip 8th-bit if so desired. We do this only for characters that
617 * are in the range 128-255, to provide compatibility with terminals
618 * that display only 7-bit characters. Note that 'ch' may be a
619 * function key at this point, so we mustn't strip _those_.
622 if ((ch < KEY_MIN) && (ch & 0x80))
625 T(("wgetch returning : %s", _nc_tracechar(sp, ch)));
628 returnCode(ch >= KEY_MIN ? KEY_CODE_YES : OK);
631 #ifdef NCURSES_WGETCH_EVENTS
633 wgetch_events(WINDOW *win, _nc_eventlist * evl)
638 T((T_CALLED("wgetch_events(%p,%p)"), (void *) win, (void *) evl));
639 code = _nc_wgetch(win,
655 T((T_CALLED("wgetch(%p)"), (void *) win));
656 code = _nc_wgetch(win,
659 EVENTLIST_2nd((_nc_eventlist *) 0));
669 ** Get an input character, but take care of keypad sequences, returning
670 ** an appropriate code when one matches the input. After each character
671 ** is received, set an alarm call based on ESCDELAY. If no more of the
672 ** sequence is received by the time the alarm goes off, pass through
673 ** the sequence gotten so far.
675 ** This function must be called when there are no cooked keys in queue.
676 ** (that is head==-1 || peek==head)
681 kgetch(SCREEN *sp, bool forever EVENTLIST_2nd(_nc_eventlist * evl))
685 int timeleft = forever ? 9999999 : GetEscdelay(sp);
687 TR(TRACE_IEVENT, ("kgetch() called"));
692 if (cooked_key_in_fifo() && sp->_fifo[head] >= KEY_MIN) {
694 } else if (!raw_key_in_fifo()) {
695 ch = fifo_push(sp EVENTLIST_2nd(evl));
697 peek = head; /* the keys stay uninterpreted */
700 #ifdef NCURSES_WGETCH_EVENTS
701 else if (ch == KEY_EVENT) {
702 peek = head; /* the keys stay uninterpreted */
703 return fifo_pull(sp); /* Remove KEY_EVENT from the queue */
710 /* If not first in queue, somebody put this key there on purpose in
711 * emergency. Consider it higher priority than the unfinished
712 * keysequence we are parsing.
715 /* assume the key is the last in fifo */
716 t_dec(); /* remove the key */
720 TR(TRACE_IEVENT, ("ch: %s", _nc_tracechar(sp, (unsigned char) ch)));
721 while ((ptr != NULL) && (ptr->ch != (unsigned char) ch))
725 TR(TRACE_IEVENT, ("ptr is null"));
728 TR(TRACE_IEVENT, ("ptr=%p, ch=%d, value=%d",
729 (void *) ptr, ptr->ch, ptr->value));
731 if (ptr->value != 0) { /* sequence terminated */
732 TR(TRACE_IEVENT, ("end of sequence"));
743 if (!raw_key_in_fifo()) {
746 TR(TRACE_IEVENT, ("waiting for rest of sequence"));
747 rc = check_mouse_activity(sp, timeleft EVENTLIST_2nd(evl));
748 #ifdef NCURSES_WGETCH_EVENTS
750 TR(TRACE_IEVENT, ("interrupted by a user event"));
751 /* FIXME Should have preserved remainder timeleft for reuse... */
752 peek = head; /* Restart interpreting later */
757 TR(TRACE_IEVENT, ("ran out of time"));