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 #define NEED_KEY_EVENT
45 #include <curses.priv.h>
47 MODULE_ID("$Id: lib_getch.c,v 1.140 2020/07/18 20:02:24 tom Exp $")
49 #include <fifo_defs.h>
52 #define GetEscdelay(sp) *_nc_ptr_Escdelay(sp)
54 NCURSES_PUBLIC_VAR(ESCDELAY) (void)
56 return *(_nc_ptr_Escdelay(CURRENT_SCREEN));
60 _nc_ptr_Escdelay(SCREEN *sp)
62 return ptrEscdelay(sp);
65 #define GetEscdelay(sp) ESCDELAY
66 NCURSES_EXPORT_VAR(int) ESCDELAY = 1000;
71 NCURSES_SP_NAME(set_escdelay) (NCURSES_SP_DCLx int value)
93 set_escdelay(int value)
100 code = NCURSES_SP_NAME(set_escdelay) (CURRENT_SCREEN, value);
109 #endif /* NCURSES_EXT_FUNCS */
111 #if NCURSES_EXT_FUNCS
113 NCURSES_SP_NAME(get_escdelay) (NCURSES_SP_DCL0)
118 return GetEscdelay(SP_PARM);
125 return NCURSES_SP_NAME(get_escdelay) (CURRENT_SCREEN);
128 #endif /* NCURSES_EXT_FUNCS */
131 _nc_use_meta(WINDOW *win)
133 SCREEN *sp = _nc_screen_of(win);
134 return (sp ? sp->_use_meta : 0);
137 #ifdef USE_TERM_DRIVER
140 _nc_get_handle(int fd)
142 intptr_t value = _get_osfhandle(fd);
143 return (HANDLE) value;
149 * Check for mouse activity, returning nonzero if we find any.
152 check_mouse_activity(SCREEN *sp, int delay EVENTLIST_2nd(_nc_eventlist * evl))
156 #ifdef USE_TERM_DRIVER
157 TERMINAL_CONTROL_BLOCK *TCB = TCBOf(sp);
158 rc = TCBOf(sp)->drv->td_testmouse(TCBOf(sp), delay EVENTLIST_2nd(evl));
160 /* if we emulate terminfo on console, we have to use the console routine */
161 if (IsTermInfoOnConsole(sp)) {
162 HANDLE fd = _nc_get_handle(sp->_ifd);
163 rc = _nc_mingw_testmouse(sp, fd, delay EVENTLIST_2nd(evl));
166 rc = TCB->drv->td_testmouse(TCB, delay EVENTLIST_2nd(evl));
169 if ((sp->_mouse_type == M_SYSMOUSE)
170 && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
175 rc = _nc_timed_wait(sp,
181 if ((sp->_mouse_type == M_SYSMOUSE)
182 && (sp->_sysmouse_head < sp->_sysmouse_tail)
184 && (errno == EINTR)) {
193 static NCURSES_INLINE int
194 fifo_peek(SCREEN *sp)
196 int ch = (peek >= 0) ? sp->_fifo[peek] : ERR;
197 TR(TRACE_IEVENT, ("peeking at %d", peek));
203 static NCURSES_INLINE int
204 fifo_pull(SCREEN *sp)
206 int ch = (head >= 0) ? sp->_fifo[head] : ERR;
208 TR(TRACE_IEVENT, ("pulling %s from %d", _nc_tracechar(sp, ch), head));
218 if (USE_TRACEF(TRACE_IEVENT)) {
220 _nc_unlock_global(tracef);
226 static NCURSES_INLINE int
227 fifo_push(SCREEN *sp EVENTLIST_2nd(_nc_eventlist * evl))
237 #ifdef NCURSES_WGETCH_EVENTS
239 #if USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
240 || (sp->_mouse_fd >= 0)
243 mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
247 if (mask & TW_EVENT) {
248 T(("fifo_push: ungetch KEY_EVENT"));
249 safe_ungetch(sp, KEY_EVENT);
252 #elif USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
253 if (sp->_mouse_fd >= 0) {
254 mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
258 #if USE_GPM_SUPPORT || USE_EMX_MOUSE
259 if ((sp->_mouse_fd >= 0) && (mask & TW_MOUSE)) {
260 sp->_mouse_event(sp);
266 if ((sp->_mouse_type == M_SYSMOUSE)
267 && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
268 sp->_mouse_event(sp);
271 } else if ((sp->_mouse_type == M_SYSMOUSE)
272 && (mask <= 0) && errno == EINTR) {
273 sp->_mouse_event(sp);
278 #ifdef USE_TERM_DRIVER
279 if ((sp->_mouse_type == M_TERM_DRIVER)
280 && (sp->_drv_mouse_head < sp->_drv_mouse_tail)) {
281 sp->_mouse_event(sp);
287 if (NC_ISATTY(sp->_ifd) && sp->_cbreak) {
288 ch = _read_kbd(0, 1, !sp->_raw);
289 n = (ch == -1) ? -1 : 1;
290 sp->_extended_key = (ch == 0);
294 #ifdef USE_TERM_DRIVER
297 if (NC_ISATTY(sp->_ifd) && IsTermInfoOnConsole(sp) && sp->_cbreak)
298 n = _nc_mingw_console_read(sp,
299 _nc_get_handle(sp->_ifd),
303 n = CallDriver_1(sp, td_read, &buf);
306 unsigned char c2 = 0;
307 # if USE_PTHREADS_EINTR
308 # if USE_WEAK_SYMBOLS
309 if ((pthread_self) && (pthread_kill) && (pthread_equal))
311 _nc_globals.read_thread = pthread_self();
313 n = (int) read(sp->_ifd, &c2, (size_t) 1);
314 #if USE_PTHREADS_EINTR
315 _nc_globals.read_thread = 0;
321 if ((n == -1) || (n == 0)) {
322 TR(TRACE_IEVENT, ("read(%d,&ch,1)=%d, errno=%d", sp->_ifd, n, errno));
325 TR(TRACE_IEVENT, ("read %d characters", n));
327 sp->_fifo[tail] = ch;
332 TR(TRACE_IEVENT, ("pushed %s at %d", _nc_tracechar(sp, ch), tail));
334 if (USE_TRACEF(TRACE_IEVENT)) {
336 _nc_unlock_global(tracef);
342 static NCURSES_INLINE void
343 fifo_clear(SCREEN *sp)
345 memset(sp->_fifo, 0, sizeof(sp->_fifo));
350 static int kgetch(SCREEN *, bool EVENTLIST_2nd(_nc_eventlist *));
353 recur_wrefresh(WINDOW *win)
356 SCREEN *sp = _nc_screen_of(win);
357 if (_nc_use_pthreads && sp != CURRENT_SCREEN) {
360 /* temporarily switch to the window's screen to check/refresh */
361 _nc_lock_global(curses);
362 save_SP = CURRENT_SCREEN;
365 _nc_set_screen(save_SP);
366 _nc_unlock_global(curses);
369 if ((is_wintouched(win) || (win->_flags & _HASMOVED))
370 && !(win->_flags & _ISPAD)) {
376 recur_wgetnstr(WINDOW *win, char *buf)
378 SCREEN *sp = _nc_screen_of(win);
383 if (_nc_use_pthreads && sp != CURRENT_SCREEN) {
386 /* temporarily switch to the window's screen to get cooked input */
387 _nc_lock_global(curses);
388 save_SP = CURRENT_SCREEN;
390 rc = recur_wgetnstr(win, buf);
391 _nc_set_screen(save_SP);
392 _nc_unlock_global(curses);
396 sp->_called_wgetch = TRUE;
397 rc = wgetnstr(win, buf, MAXCOLUMNS);
398 sp->_called_wgetch = FALSE;
407 _nc_wgetch(WINDOW *win,
410 EVENTLIST_2nd(_nc_eventlist * evl))
415 #ifdef NCURSES_WGETCH_EVENTS
416 int event_delay = -1;
419 T((T_CALLED("_nc_wgetch(%p)"), (void *) win));
423 sp = _nc_screen_of(win);
424 if (win == 0 || sp == 0) {
428 if (cooked_key_in_fifo()) {
430 *result = fifo_pull(sp);
431 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
433 #ifdef NCURSES_WGETCH_EVENTS
434 if (evl && (evl->count == 0))
436 event_delay = _nc_eventlist_timeout(evl);
440 * Handle cooked mode. Grab a string from the screen,
441 * stuff its contents in the FIFO queue, and pop off
442 * the first character to return it.
448 !sp->_called_wgetch) {
449 char buf[MAXCOLUMNS], *bufp;
451 TR(TRACE_IEVENT, ("filling queue in cooked mode"));
453 /* ungetch in reverse order */
454 #ifdef NCURSES_WGETCH_EVENTS
455 rc = recur_wgetnstr(win, buf);
456 if (rc != KEY_EVENT && rc != ERR)
457 safe_ungetch(sp, '\n');
459 if (recur_wgetnstr(win, buf) != ERR)
460 safe_ungetch(sp, '\n');
462 for (bufp = buf + strlen(buf); bufp > buf; bufp--)
463 safe_ungetch(sp, bufp[-1]);
465 #ifdef NCURSES_WGETCH_EVENTS
466 /* Return it first */
467 if (rc == KEY_EVENT) {
471 *result = fifo_pull(sp);
472 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
475 if (win->_use_keypad != sp->_keypad_on)
476 _nc_keypad(sp, win->_use_keypad);
480 if (win->_notimeout || (win->_delay >= 0) || (sp->_cbreak > 1)) {
481 if (head == -1) { /* fifo is empty */
484 TR(TRACE_IEVENT, ("timed delay in wgetch()"));
486 delay = (sp->_cbreak - 1) * 100;
490 #ifdef NCURSES_WGETCH_EVENTS
491 if (event_delay >= 0 && delay > event_delay)
495 TR(TRACE_IEVENT, ("delay is %d milliseconds", delay));
497 rc = check_mouse_activity(sp, delay EVENTLIST_2nd(evl));
499 #ifdef NCURSES_WGETCH_EVENTS
502 returnCode(KEY_CODE_YES);
509 /* else go on to read data available */
512 if (win->_use_keypad) {
514 * This is tricky. We only want to get special-key
515 * events one at a time. But we want to accumulate
516 * mouse events until either (a) the mouse logic tells
517 * us it's picked up a complete gesture, or (b)
518 * there's a detectable time lapse after one.
520 * Note: if the mouse code starts failing to compose
521 * press/release events into clicks, you should probably
522 * increase the wait with mouseinterval().
527 ch = kgetch(sp, win->_notimeout EVENTLIST_2nd(evl));
528 if (ch == KEY_MOUSE) {
530 if (sp->_mouse_inline(sp))
533 if (sp->_maxclick < 0)
537 && (((rc = check_mouse_activity(sp, sp->_maxclick
538 EVENTLIST_2nd(evl))) != 0
540 || !sp->_mouse_parse(sp, runcount)));
541 #ifdef NCURSES_WGETCH_EVENTS
542 if ((rc & TW_EVENT) && !(ch == KEY_EVENT)) {
543 safe_ungetch(sp, ch);
547 if (runcount > 0 && ch != KEY_MOUSE) {
548 #ifdef NCURSES_WGETCH_EVENTS
549 /* mouse event sequence ended by an event, report event */
550 if (ch == KEY_EVENT) {
551 safe_ungetch(sp, KEY_MOUSE); /* FIXME This interrupts a gesture... */
555 /* mouse event sequence ended by keystroke, store keystroke */
556 safe_ungetch(sp, ch);
562 fifo_push(sp EVENTLIST_2nd(evl));
569 if (_nc_handle_sigwinch(sp)) {
570 _nc_update_screensize(sp);
571 /* resizeterm can push KEY_RESIZE */
572 if (cooked_key_in_fifo()) {
573 *result = fifo_pull(sp);
575 * Get the ERR from queue -- it is from WINCH,
576 * so we should take it out, the "error" is handled.
578 if (fifo_peek(sp) == -1)
580 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
588 * If echo() is in effect, display the printable version of the
589 * key on the screen. Carriage return and backspace are treated
590 * specially by Solaris curses:
592 * If carriage return is defined as a function key in the
593 * terminfo, e.g., kent, then Solaris may return either ^J (or ^M
594 * if nonl() is set) or KEY_ENTER depending on the echo() mode.
595 * We echo before translating carriage return based on nonl(),
596 * since the visual result simply moves the cursor to column 0.
598 * Backspace is a different matter. Solaris curses does not
599 * translate it to KEY_BACKSPACE if kbs=^H. This does not depend
600 * on the stty modes, but appears to be a hardcoded special case.
601 * This is a difference from ncurses, which uses the terminfo entry.
602 * However, we provide the same visual result as Solaris, moving the
603 * cursor to the left.
605 if (sp->_echo && !(win->_flags & _ISPAD)) {
606 chtype backup = (chtype) ((ch == KEY_BACKSPACE) ? '\b' : ch);
607 if (backup < KEY_MIN)
608 wechochar(win, backup);
612 * Simulate ICRNL mode
614 if ((ch == '\r') && sp->_nl)
617 /* Strip 8th-bit if so desired. We do this only for characters that
618 * are in the range 128-255, to provide compatibility with terminals
619 * that display only 7-bit characters. Note that 'ch' may be a
620 * function key at this point, so we mustn't strip _those_.
623 if ((ch < KEY_MIN) && (ch & 0x80))
626 T(("wgetch returning : %s", _nc_tracechar(sp, ch)));
629 returnCode(ch >= KEY_MIN ? KEY_CODE_YES : OK);
632 #ifdef NCURSES_WGETCH_EVENTS
634 wgetch_events(WINDOW *win, _nc_eventlist * evl)
639 T((T_CALLED("wgetch_events(%p,%p)"), (void *) win, (void *) evl));
640 code = _nc_wgetch(win,
656 T((T_CALLED("wgetch(%p)"), (void *) win));
657 code = _nc_wgetch(win,
660 EVENTLIST_2nd((_nc_eventlist *) 0));
670 ** Get an input character, but take care of keypad sequences, returning
671 ** an appropriate code when one matches the input. After each character
672 ** is received, set an alarm call based on ESCDELAY. If no more of the
673 ** sequence is received by the time the alarm goes off, pass through
674 ** the sequence gotten so far.
676 ** This function must be called when there are no cooked keys in queue.
677 ** (that is head==-1 || peek==head)
682 kgetch(SCREEN *sp, bool forever EVENTLIST_2nd(_nc_eventlist * evl))
686 int timeleft = forever ? 9999999 : GetEscdelay(sp);
688 TR(TRACE_IEVENT, ("kgetch() called"));
693 if (cooked_key_in_fifo() && sp->_fifo[head] >= KEY_MIN) {
695 } else if (!raw_key_in_fifo()) {
696 ch = fifo_push(sp EVENTLIST_2nd(evl));
698 peek = head; /* the keys stay uninterpreted */
701 #ifdef NCURSES_WGETCH_EVENTS
702 else if (ch == KEY_EVENT) {
703 peek = head; /* the keys stay uninterpreted */
704 return fifo_pull(sp); /* Remove KEY_EVENT from the queue */
711 /* If not first in queue, somebody put this key there on purpose in
712 * emergency. Consider it higher priority than the unfinished
713 * keysequence we are parsing.
716 /* assume the key is the last in fifo */
717 t_dec(); /* remove the key */
721 TR(TRACE_IEVENT, ("ch: %s", _nc_tracechar(sp, (unsigned char) ch)));
722 while ((ptr != NULL) && (ptr->ch != (unsigned char) ch))
726 TR(TRACE_IEVENT, ("ptr is null"));
729 TR(TRACE_IEVENT, ("ptr=%p, ch=%d, value=%d",
730 (void *) ptr, ptr->ch, ptr->value));
732 if (ptr->value != 0) { /* sequence terminated */
733 TR(TRACE_IEVENT, ("end of sequence"));
744 if (!raw_key_in_fifo()) {
747 TR(TRACE_IEVENT, ("waiting for rest of sequence"));
748 rc = check_mouse_activity(sp, timeleft EVENTLIST_2nd(evl));
749 #ifdef NCURSES_WGETCH_EVENTS
751 TR(TRACE_IEVENT, ("interrupted by a user event"));
752 /* FIXME Should have preserved remainder timeleft for reuse... */
753 peek = head; /* Restart interpreting later */
758 TR(TRACE_IEVENT, ("ran out of time"));