1 /****************************************************************************
2 * Copyright (c) 1998-2011,2012 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.124 2012/01/21 19:21:29 KO.Myung-Hun 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 rc = TCBOf(sp)->drv->testmouse(TCBOf(sp), delay EVENTLIST_2nd(evl));
139 if ((sp->_mouse_type == M_SYSMOUSE)
140 && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
145 rc = _nc_timed_wait(sp,
151 if ((sp->_mouse_type == M_SYSMOUSE)
152 && (sp->_sysmouse_head < sp->_sysmouse_tail)
154 && (errno == EINTR)) {
163 static NCURSES_INLINE int
164 fifo_peek(SCREEN *sp)
166 int ch = sp->_fifo[peek];
167 TR(TRACE_IEVENT, ("peeking at %d", peek));
173 static NCURSES_INLINE int
174 fifo_pull(SCREEN *sp)
177 ch = sp->_fifo[head];
178 TR(TRACE_IEVENT, ("pulling %s from %d", _nc_tracechar(sp, ch), head));
187 if (USE_TRACEF(TRACE_IEVENT)) {
189 _nc_unlock_global(tracef);
195 static NCURSES_INLINE int
196 fifo_push(SCREEN *sp EVENTLIST_2nd(_nc_eventlist * evl))
211 #ifdef NCURSES_WGETCH_EVENTS
213 #if USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
214 || (sp->_mouse_fd >= 0)
217 mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
221 if (mask & TW_EVENT) {
222 T(("fifo_push: ungetch KEY_EVENT"));
223 safe_ungetch(sp, KEY_EVENT);
226 #elif USE_GPM_SUPPORT || USE_EMX_MOUSE || USE_SYSMOUSE
227 if (sp->_mouse_fd >= 0) {
228 mask = check_mouse_activity(sp, -1 EVENTLIST_2nd(evl));
232 #if USE_GPM_SUPPORT || USE_EMX_MOUSE
233 if ((sp->_mouse_fd >= 0) && (mask & TW_MOUSE)) {
234 sp->_mouse_event(sp);
240 if ((sp->_mouse_type == M_SYSMOUSE)
241 && (sp->_sysmouse_head < sp->_sysmouse_tail)) {
242 sp->_mouse_event(sp);
245 } else if ((sp->_mouse_type == M_SYSMOUSE)
246 && (mask <= 0) && errno == EINTR) {
247 sp->_mouse_event(sp);
252 #ifdef USE_TERM_DRIVER
253 if ((sp->_mouse_type == M_TERM_DRIVER)
254 && (sp->_drv_mouse_head < sp->_drv_mouse_tail)) {
255 sp->_mouse_event(sp);
261 if (isatty(sp->_ifd) && sp->_cbreak) {
262 ch = _read_kbd(0, 1, !sp->_raw);
263 n = (ch == -1) ? -1 : 1;
264 sp->_extended_key = (ch == 0);
268 #ifdef USE_TERM_DRIVER
270 n = CallDriver_1(sp, read, &buf);
273 unsigned char c2 = 0;
274 # if USE_PTHREADS_EINTR
275 # if USE_WEAK_SYMBOLS
276 if ((pthread_self) && (pthread_kill) && (pthread_equal))
278 _nc_globals.read_thread = pthread_self();
280 n = (int) read(sp->_ifd, &c2, (size_t) 1);
281 #if USE_PTHREADS_EINTR
282 _nc_globals.read_thread = 0;
290 * Under System V curses with non-restarting signals, getch() returns
291 * with value ERR when a handled signal keeps it from completing.
292 * If signals restart system calls, OTOH, the signal is invisible
293 * except to its handler.
295 * We don't want this difference to show. This piece of code
296 * tries to make it look like we always have restarting signals.
298 if (n <= 0 && errno == EINTR
299 # if USE_PTHREADS_EINTR
300 && (_nc_globals.have_sigwinch == 0)
306 if ((n == -1) || (n == 0)) {
307 TR(TRACE_IEVENT, ("read(%d,&ch,1)=%d, errno=%d", sp->_ifd, n, errno));
310 TR(TRACE_IEVENT, ("read %d characters", n));
312 sp->_fifo[tail] = ch;
317 TR(TRACE_IEVENT, ("pushed %s at %d", _nc_tracechar(sp, ch), tail));
319 if (USE_TRACEF(TRACE_IEVENT)) {
321 _nc_unlock_global(tracef);
327 static NCURSES_INLINE void
328 fifo_clear(SCREEN *sp)
330 memset(sp->_fifo, 0, sizeof(sp->_fifo));
335 static int kgetch(SCREEN *EVENTLIST_2nd(_nc_eventlist * evl));
338 recur_wrefresh(WINDOW *win)
341 SCREEN *sp = _nc_screen_of(win);
342 if (_nc_use_pthreads && sp != CURRENT_SCREEN) {
345 /* temporarily switch to the window's screen to check/refresh */
346 _nc_lock_global(curses);
347 save_SP = CURRENT_SCREEN;
350 _nc_set_screen(save_SP);
351 _nc_unlock_global(curses);
354 if ((is_wintouched(win) || (win->_flags & _HASMOVED))
355 && !(win->_flags & _ISPAD)) {
361 recur_wgetnstr(WINDOW *win, char *buf)
363 SCREEN *sp = _nc_screen_of(win);
368 if (_nc_use_pthreads && sp != CURRENT_SCREEN) {
371 /* temporarily switch to the window's screen to get cooked input */
372 _nc_lock_global(curses);
373 save_SP = CURRENT_SCREEN;
375 rc = recur_wgetnstr(win, buf);
376 _nc_set_screen(save_SP);
377 _nc_unlock_global(curses);
381 sp->_called_wgetch = TRUE;
382 rc = wgetnstr(win, buf, MAXCOLUMNS);
383 sp->_called_wgetch = FALSE;
392 _nc_wgetch(WINDOW *win,
395 EVENTLIST_2nd(_nc_eventlist * evl))
400 #ifdef NCURSES_WGETCH_EVENTS
401 long event_delay = -1;
404 T((T_CALLED("_nc_wgetch(%p)"), (void *) win));
408 sp = _nc_screen_of(win);
409 if (win == 0 || sp == 0) {
413 if (cooked_key_in_fifo()) {
415 *result = fifo_pull(sp);
416 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
418 #ifdef NCURSES_WGETCH_EVENTS
419 if (evl && (evl->count == 0))
421 event_delay = _nc_eventlist_timeout(evl);
425 * Handle cooked mode. Grab a string from the screen,
426 * stuff its contents in the FIFO queue, and pop off
427 * the first character to return it.
433 !sp->_called_wgetch) {
434 char buf[MAXCOLUMNS], *bufp;
436 TR(TRACE_IEVENT, ("filling queue in cooked mode"));
438 /* ungetch in reverse order */
439 #ifdef NCURSES_WGETCH_EVENTS
440 rc = recur_wgetnstr(win, buf);
442 safe_ungetch(sp, '\n');
444 (void) recur_wgetnstr(win, buf);
445 safe_ungetch(sp, '\n');
447 for (bufp = buf + strlen(buf); bufp > buf; bufp--)
448 safe_ungetch(sp, bufp[-1]);
450 #ifdef NCURSES_WGETCH_EVENTS
451 /* Return it first */
452 if (rc == KEY_EVENT) {
456 *result = fifo_pull(sp);
457 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
460 if (win->_use_keypad != sp->_keypad_on)
461 _nc_keypad(sp, win->_use_keypad);
465 if (win->_notimeout || (win->_delay >= 0) || (sp->_cbreak > 1)) {
466 if (head == -1) { /* fifo is empty */
469 TR(TRACE_IEVENT, ("timed delay in wgetch()"));
471 delay = (sp->_cbreak - 1) * 100;
475 #ifdef NCURSES_WGETCH_EVENTS
476 if (event_delay >= 0 && delay > event_delay)
480 TR(TRACE_IEVENT, ("delay is %d milliseconds", delay));
482 rc = check_mouse_activity(sp, delay EVENTLIST_2nd(evl));
484 #ifdef NCURSES_WGETCH_EVENTS
487 returnCode(KEY_CODE_YES);
494 /* else go on to read data available */
497 if (win->_use_keypad) {
499 * This is tricky. We only want to get special-key
500 * events one at a time. But we want to accumulate
501 * mouse events until either (a) the mouse logic tells
502 * us it's picked up a complete gesture, or (b)
503 * there's a detectable time lapse after one.
505 * Note: if the mouse code starts failing to compose
506 * press/release events into clicks, you should probably
507 * increase the wait with mouseinterval().
512 ch = kgetch(sp EVENTLIST_2nd(evl));
513 if (ch == KEY_MOUSE) {
515 if (sp->_mouse_inline(sp))
518 if (sp->_maxclick < 0)
522 && (((rc = check_mouse_activity(sp, sp->_maxclick
523 EVENTLIST_2nd(evl))) != 0
525 || !sp->_mouse_parse(sp, runcount)));
526 #ifdef NCURSES_WGETCH_EVENTS
527 if ((rc & TW_EVENT) && !(ch == KEY_EVENT)) {
528 safe_ungetch(sp, ch);
532 if (runcount > 0 && ch != KEY_MOUSE) {
533 #ifdef NCURSES_WGETCH_EVENTS
534 /* mouse event sequence ended by an event, report event */
535 if (ch == KEY_EVENT) {
536 safe_ungetch(sp, KEY_MOUSE); /* FIXME This interrupts a gesture... */
540 /* mouse event sequence ended by keystroke, store keystroke */
541 safe_ungetch(sp, ch);
547 fifo_push(sp EVENTLIST_2nd(evl));
554 if (_nc_handle_sigwinch(sp)) {
555 _nc_update_screensize(sp);
556 /* resizeterm can push KEY_RESIZE */
557 if (cooked_key_in_fifo()) {
558 *result = fifo_pull(sp);
560 * Get the ERR from queue -- it is from WINCH,
561 * so we should take it out, the "error" is handled.
563 if (fifo_peek(sp) == -1)
565 returnCode(*result >= KEY_MIN ? KEY_CODE_YES : OK);
573 * If echo() is in effect, display the printable version of the
574 * key on the screen. Carriage return and backspace are treated
575 * specially by Solaris curses:
577 * If carriage return is defined as a function key in the
578 * terminfo, e.g., kent, then Solaris may return either ^J (or ^M
579 * if nonl() is set) or KEY_ENTER depending on the echo() mode.
580 * We echo before translating carriage return based on nonl(),
581 * since the visual result simply moves the cursor to column 0.
583 * Backspace is a different matter. Solaris curses does not
584 * translate it to KEY_BACKSPACE if kbs=^H. This does not depend
585 * on the stty modes, but appears to be a hardcoded special case.
586 * This is a difference from ncurses, which uses the terminfo entry.
587 * However, we provide the same visual result as Solaris, moving the
588 * cursor to the left.
590 if (sp->_echo && !(win->_flags & _ISPAD)) {
591 chtype backup = (chtype) ((ch == KEY_BACKSPACE) ? '\b' : ch);
592 if (backup < KEY_MIN)
593 wechochar(win, backup);
597 * Simulate ICRNL mode
599 if ((ch == '\r') && sp->_nl)
602 /* Strip 8th-bit if so desired. We do this only for characters that
603 * are in the range 128-255, to provide compatibility with terminals
604 * that display only 7-bit characters. Note that 'ch' may be a
605 * function key at this point, so we mustn't strip _those_.
608 if ((ch < KEY_MIN) && (ch & 0x80))
611 T(("wgetch returning : %s", _nc_tracechar(sp, ch)));
614 returnCode(ch >= KEY_MIN ? KEY_CODE_YES : OK);
617 #ifdef NCURSES_WGETCH_EVENTS
619 wgetch_events(WINDOW *win, _nc_eventlist * evl)
624 T((T_CALLED("wgetch_events(%p,%p)"), win, evl));
625 code = _nc_wgetch(win,
641 T((T_CALLED("wgetch(%p)"), (void *) win));
642 code = _nc_wgetch(win,
645 EVENTLIST_2nd((_nc_eventlist *) 0));
655 ** Get an input character, but take care of keypad sequences, returning
656 ** an appropriate code when one matches the input. After each character
657 ** is received, set an alarm call based on ESCDELAY. If no more of the
658 ** sequence is received by the time the alarm goes off, pass through
659 ** the sequence gotten so far.
661 ** This function must be called when there are no cooked keys in queue.
662 ** (that is head==-1 || peek==head)
667 kgetch(SCREEN *sp EVENTLIST_2nd(_nc_eventlist * evl))
671 int timeleft = GetEscdelay(sp);
673 TR(TRACE_IEVENT, ("kgetch() called"));
678 if (cooked_key_in_fifo() && sp->_fifo[head] >= KEY_MIN) {
680 } else if (!raw_key_in_fifo()) {
681 ch = fifo_push(sp EVENTLIST_2nd(evl));
683 peek = head; /* the keys stay uninterpreted */
686 #ifdef NCURSES_WGETCH_EVENTS
687 else if (ch == KEY_EVENT) {
688 peek = head; /* the keys stay uninterpreted */
689 return fifo_pull(sp); /* Remove KEY_EVENT from the queue */
696 /* If not first in queue, somebody put this key there on purpose in
697 * emergency. Consider it higher priority than the unfinished
698 * keysequence we are parsing.
701 /* assume the key is the last in fifo */
702 t_dec(); /* remove the key */
706 TR(TRACE_IEVENT, ("ch: %s", _nc_tracechar(sp, (unsigned char) ch)));
707 while ((ptr != NULL) && (ptr->ch != (unsigned char) ch))
711 TR(TRACE_IEVENT, ("ptr is null"));
714 TR(TRACE_IEVENT, ("ptr=%p, ch=%d, value=%d",
715 (void *) ptr, ptr->ch, ptr->value));
717 if (ptr->value != 0) { /* sequence terminated */
718 TR(TRACE_IEVENT, ("end of sequence"));
728 if (!raw_key_in_fifo()) {
731 TR(TRACE_IEVENT, ("waiting for rest of sequence"));
732 rc = check_mouse_activity(sp, timeleft EVENTLIST_2nd(evl));
733 #ifdef NCURSES_WGETCH_EVENTS
735 TR(TRACE_IEVENT, ("interrupted by a user event"));
736 /* FIXME Should have preserved remainder timeleft for reuse... */
737 peek = head; /* Restart interpreting later */
742 TR(TRACE_IEVENT, ("ran out of time"));