getch.c revision 1.73
1/*	$NetBSD: getch.c,v 1.73 2019/06/09 07:40:14 blymn Exp $	*/
2
3/*
4 * Copyright (c) 1981, 1993, 1994
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 *    may be used to endorse or promote products derived from this software
17 *    without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#include <sys/cdefs.h>
33#ifndef lint
34#if 0
35static char sccsid[] = "@(#)getch.c	8.2 (Berkeley) 5/4/94";
36#else
37__RCSID("$NetBSD: getch.c,v 1.73 2019/06/09 07:40:14 blymn Exp $");
38#endif
39#endif					/* not lint */
40
41#include <errno.h>
42#include <string.h>
43#include <stdlib.h>
44#include <unistd.h>
45#include <stdio.h>
46#include "curses.h"
47#include "curses_private.h"
48#include "keymap.h"
49
50short _cursesi_state;		/* state of the inkey function */
51
52static const struct tcdata tc[] = {
53	{TICODE_kSAV, KEY_SSAVE},
54	{TICODE_kSPD, KEY_SSUSPEND},
55	{TICODE_kUND, KEY_SUNDO},
56	{TICODE_kHLP, KEY_SHELP},
57	{TICODE_kHOM, KEY_SHOME},
58	{TICODE_kIC, KEY_SIC},
59	{TICODE_kLFT, KEY_SLEFT},
60	{TICODE_krdo, KEY_REDO},
61	{TICODE_khlp, KEY_HELP},
62	{TICODE_kmrk, KEY_MARK},
63	{TICODE_kmsg, KEY_MESSAGE},
64	{TICODE_kmov, KEY_MOVE},
65	{TICODE_knxt, KEY_NEXT},
66	{TICODE_kopn, KEY_OPEN},
67	{TICODE_kopt, KEY_OPTIONS},
68	{TICODE_kprv, KEY_PREVIOUS},
69	{TICODE_kprt, KEY_PRINT},
70	{TICODE_kMSG, KEY_SMESSAGE},
71	{TICODE_kMOV, KEY_SMOVE},
72	{TICODE_kNXT, KEY_SNEXT},
73	{TICODE_kOPT, KEY_SOPTIONS},
74	{TICODE_kPRV, KEY_SPREVIOUS},
75	{TICODE_kPRT, KEY_SPRINT},
76	{TICODE_kRDO, KEY_SREDO},
77	{TICODE_kRPL, KEY_SREPLACE},
78	{TICODE_kRIT, KEY_SRIGHT},
79	{TICODE_kRES, KEY_SRSUME},
80	{TICODE_kCAN, KEY_SCANCEL},
81	{TICODE_kref, KEY_REFERENCE},
82	{TICODE_krfr, KEY_REFRESH},
83	{TICODE_krpl, KEY_REPLACE},
84	{TICODE_krst, KEY_RESTART},
85	{TICODE_kres, KEY_RESUME},
86	{TICODE_ksav, KEY_SAVE},
87	{TICODE_kspd, KEY_SUSPEND},
88	{TICODE_kund, KEY_UNDO},
89	{TICODE_kBEG, KEY_SBEG},
90	{TICODE_kFND, KEY_SFIND},
91	{TICODE_kCMD, KEY_SCOMMAND},
92	{TICODE_kCPY, KEY_SCOPY},
93	{TICODE_kCRT, KEY_SCREATE},
94	{TICODE_kDC, KEY_SDC},
95	{TICODE_kDL, KEY_SDL},
96	{TICODE_kslt, KEY_SELECT},
97	{TICODE_kEND, KEY_SEND},
98	{TICODE_kEOL, KEY_SEOL},
99	{TICODE_kEXT, KEY_SEXIT},
100	{TICODE_kfnd, KEY_FIND},
101	{TICODE_kbeg, KEY_BEG},
102	{TICODE_kcan, KEY_CANCEL},
103	{TICODE_kclo, KEY_CLOSE},
104	{TICODE_kcmd, KEY_COMMAND},
105	{TICODE_kcpy, KEY_COPY},
106	{TICODE_kcrt, KEY_CREATE},
107	{TICODE_kend, KEY_END},
108	{TICODE_kent, KEY_ENTER},
109	{TICODE_kext, KEY_EXIT},
110	{TICODE_kf11, KEY_F(11)},
111	{TICODE_kf12, KEY_F(12)},
112	{TICODE_kf13, KEY_F(13)},
113	{TICODE_kf14, KEY_F(14)},
114	{TICODE_kf15, KEY_F(15)},
115	{TICODE_kf16, KEY_F(16)},
116	{TICODE_kf17, KEY_F(17)},
117	{TICODE_kf18, KEY_F(18)},
118	{TICODE_kf19, KEY_F(19)},
119	{TICODE_kf20, KEY_F(20)},
120	{TICODE_kf21, KEY_F(21)},
121	{TICODE_kf22, KEY_F(22)},
122	{TICODE_kf23, KEY_F(23)},
123	{TICODE_kf24, KEY_F(24)},
124	{TICODE_kf25, KEY_F(25)},
125	{TICODE_kf26, KEY_F(26)},
126	{TICODE_kf27, KEY_F(27)},
127	{TICODE_kf28, KEY_F(28)},
128	{TICODE_kf29, KEY_F(29)},
129	{TICODE_kf30, KEY_F(30)},
130	{TICODE_kf31, KEY_F(31)},
131	{TICODE_kf32, KEY_F(32)},
132	{TICODE_kf33, KEY_F(33)},
133	{TICODE_kf34, KEY_F(34)},
134	{TICODE_kf35, KEY_F(35)},
135	{TICODE_kf36, KEY_F(36)},
136	{TICODE_kf37, KEY_F(37)},
137	{TICODE_kf38, KEY_F(38)},
138	{TICODE_kf39, KEY_F(39)},
139	{TICODE_kf40, KEY_F(40)},
140	{TICODE_kf41, KEY_F(41)},
141	{TICODE_kf42, KEY_F(42)},
142	{TICODE_kf43, KEY_F(43)},
143	{TICODE_kf44, KEY_F(44)},
144	{TICODE_kf45, KEY_F(45)},
145	{TICODE_kf46, KEY_F(46)},
146	{TICODE_kf47, KEY_F(47)},
147	{TICODE_kf48, KEY_F(48)},
148	{TICODE_kf49, KEY_F(49)},
149	{TICODE_kf50, KEY_F(50)},
150	{TICODE_kf51, KEY_F(51)},
151	{TICODE_kf52, KEY_F(52)},
152	{TICODE_kf53, KEY_F(53)},
153	{TICODE_kf54, KEY_F(54)},
154	{TICODE_kf55, KEY_F(55)},
155	{TICODE_kf56, KEY_F(56)},
156	{TICODE_kf57, KEY_F(57)},
157	{TICODE_kf58, KEY_F(58)},
158	{TICODE_kf59, KEY_F(59)},
159	{TICODE_kf60, KEY_F(60)},
160	{TICODE_kf61, KEY_F(61)},
161	{TICODE_kf62, KEY_F(62)},
162	{TICODE_kf63, KEY_F(63)},
163	{TICODE_ka1, KEY_A1},
164	{TICODE_kb2, KEY_B2},
165	{TICODE_ka3, KEY_A3},
166	{TICODE_kc1, KEY_C1},
167	{TICODE_kc3, KEY_C3},
168	{TICODE_kmous, KEY_MOUSE},
169	{TICODE_kf0, KEY_F0},
170	{TICODE_kf1, KEY_F(1)},
171	{TICODE_kf2, KEY_F(2)},
172	{TICODE_kf3, KEY_F(3)},
173	{TICODE_kf4, KEY_F(4)},
174	{TICODE_kf5, KEY_F(5)},
175	{TICODE_kf6, KEY_F(6)},
176	{TICODE_kf7, KEY_F(7)},
177	{TICODE_kf8, KEY_F(8)},
178	{TICODE_kf9, KEY_F(9)},
179	{TICODE_kf10, KEY_F(10)},
180	{TICODE_kil1, KEY_IL},
181	{TICODE_ktbc, KEY_CATAB},
182	{TICODE_kcbt, KEY_BTAB},
183	{TICODE_kbs, KEY_BACKSPACE},
184	{TICODE_kclr, KEY_CLEAR},
185	{TICODE_kdch1, KEY_DC},
186	{TICODE_kcud1, KEY_DOWN},
187	{TICODE_kel, KEY_EOL},
188	{TICODE_kind, KEY_SF},
189	{TICODE_kll, KEY_LL},
190	{TICODE_khome, KEY_HOME},
191	{TICODE_kich1, KEY_IC},
192	{TICODE_kdl1, KEY_DL},
193	{TICODE_kcub1, KEY_LEFT},
194	{TICODE_krmir, KEY_EIC},
195	{TICODE_knp, KEY_NPAGE},
196	{TICODE_kpp, KEY_PPAGE},
197	{TICODE_kri, KEY_SR},
198	{TICODE_kcuf1, KEY_RIGHT},
199	{TICODE_ked, KEY_EOS},
200	{TICODE_khts, KEY_STAB},
201	{TICODE_kctab, KEY_CTAB},
202	{TICODE_kcuu1, KEY_UP}
203};
204/* Number of TC entries .... */
205static const int num_tcs = (sizeof(tc) / sizeof(struct tcdata));
206
207/* Key buffer */
208#define INBUF_SZ 16		/* size of key buffer - must be larger than
209				 * longest multi-key sequence */
210static wchar_t	inbuf[INBUF_SZ];
211static int	start, end, working; /* pointers for manipulating inbuf data */
212
213/* prototypes for private functions */
214static void add_key_sequence(SCREEN *screen, char *sequence, int key_type);
215static key_entry_t *add_new_key(keymap_t *current, char ch, int key_type,
216        int symbol);
217static void delete_key_sequence(keymap_t *current, int key_type);
218static void do_keyok(keymap_t *current, int key_type, bool set, bool flag,
219	int *retval);
220static keymap_t *new_keymap(void); /* create a new keymap */
221static key_entry_t *new_key(void); /* create a new key entry */
222static wchar_t		inkey(int to, int delay);
223
224/*
225 * Free the storage associated with the given keymap
226 */
227void
228_cursesi_free_keymap(keymap_t *map)
229{
230	int i;
231
232	  /* check for, and free, child keymaps */
233	for (i = 0; i < MAX_CHAR; i++) {
234		if (map->mapping[i] >= 0) {
235			if (map->key[map->mapping[i]]->type == KEYMAP_MULTI)
236				_cursesi_free_keymap(
237					map->key[map->mapping[i]]->value.next);
238		}
239	}
240
241	  /* now free any allocated keymap structs */
242	for (i = 0; i < map->count; i += KEYMAP_ALLOC_CHUNK) {
243		free(map->key[i]);
244	}
245
246	free(map->key);
247	free(map);
248}
249
250
251/*
252 * Add a new key entry to the keymap pointed to by current.  Entry
253 * contains the character to add to the keymap, type is the type of
254 * entry to add (either multikey or leaf) and symbol is the symbolic
255 * value for a leaf type entry.  The function returns a pointer to the
256 * new keymap entry.
257 */
258static key_entry_t *
259add_new_key(keymap_t *current, char chr, int key_type, int symbol)
260{
261	key_entry_t *the_key;
262        int i, ki;
263
264#ifdef DEBUG
265	__CTRACE(__CTRACE_MISC,
266	    "Adding character %s of type %d, symbol 0x%x\n",
267	    unctrl(chr), key_type, symbol);
268#endif
269	if (current->mapping[(unsigned char)chr] < 0) {
270		if (current->mapping[(unsigned char)chr] == MAPPING_UNUSED) {
271			  /* first time for this char */
272			current->mapping[(unsigned char)chr] =
273				current->count;	/* map new entry */
274			ki = current->count;
275
276			  /* make sure we have room in the key array first */
277			if ((current->count & (KEYMAP_ALLOC_CHUNK - 1)) == 0)
278			{
279				if ((current->key =
280				     realloc(current->key,
281					     ki * sizeof(key_entry_t *)
282					     + KEYMAP_ALLOC_CHUNK * sizeof(key_entry_t *))) == NULL) {
283					fprintf(stderr,
284					  "Could not malloc for key entry\n");
285					exit(1);
286				}
287
288				the_key = new_key();
289				for (i = 0; i < KEYMAP_ALLOC_CHUNK; i++) {
290					current->key[ki + i] = &the_key[i];
291				}
292			}
293                } else {
294			  /* the mapping was used but freed, reuse it */
295			ki = - current->mapping[(unsigned char) chr];
296			current->mapping[(unsigned char) chr] = ki;
297		}
298
299		current->count++;
300
301		  /* point at the current key array element to use */
302		the_key = current->key[ki];
303
304		the_key->type = key_type;
305
306		switch (key_type) {
307		  case KEYMAP_MULTI:
308			    /* need for next key */
309#ifdef DEBUG
310			  __CTRACE(__CTRACE_MISC, "Creating new keymap\n");
311#endif
312			  the_key->value.next = new_keymap();
313			  the_key->enable = TRUE;
314			  break;
315
316		  case KEYMAP_LEAF:
317				/* the associated symbol for the key */
318#ifdef DEBUG
319			  __CTRACE(__CTRACE_MISC, "Adding leaf key\n");
320#endif
321			  the_key->value.symbol = symbol;
322			  the_key->enable = TRUE;
323			  break;
324
325		  default:
326			  fprintf(stderr, "add_new_key: bad type passed\n");
327			  exit(1);
328		}
329	} else {
330		  /* the key is already known - just return the address. */
331#ifdef DEBUG
332		__CTRACE(__CTRACE_MISC, "Keymap already known\n");
333#endif
334		the_key = current->key[current->mapping[(unsigned char)chr]];
335	}
336
337        return the_key;
338}
339
340/*
341 * Delete the given key symbol from the key mappings for the screen.
342 *
343 */
344static void
345delete_key_sequence(keymap_t *current, int key_type)
346{
347	key_entry_t *key;
348	int i;
349
350	  /*
351	   * we need to iterate over all the keys as there may be
352	   * multiple instances of the leaf symbol.
353	   */
354	for (i = 0; i < MAX_CHAR; i++) {
355		if (current->mapping[i] < 0)
356			continue; /* no mapping for the key, next! */
357
358		key = current->key[current->mapping[i]];
359
360		if (key->type == KEYMAP_MULTI) {
361			  /* have not found the leaf, recurse down */
362			delete_key_sequence(key->value.next, key_type);
363			  /* if we deleted the last key in the map, free */
364			if (key->value.next->count == 0)
365				_cursesi_free_keymap(key->value.next);
366		} else if ((key->type == KEYMAP_LEAF)
367			   && (key->value.symbol == key_type)) {
368#ifdef DEBUG
369		__CTRACE(__CTRACE_INPUT, "delete_key_sequence: found keysym %d, deleting\n",
370		    key_type);
371#endif
372			key->enable = FALSE;
373		}
374	}
375}
376
377/*
378 * Add the sequence of characters given in sequence as the key mapping
379 * for the given key symbol.
380 */
381static void
382add_key_sequence(SCREEN *screen, char *sequence, int key_type)
383{
384	key_entry_t *tmp_key;
385	keymap_t *current;
386	int length, j, key_ent;
387
388#ifdef DEBUG
389	__CTRACE(__CTRACE_MISC, "add_key_sequence: add key sequence: %s(%s)\n",
390	    sequence, keyname(key_type));
391#endif /* DEBUG */
392	current = screen->base_keymap;	/* always start with
393					 * base keymap. */
394	length = (int)strlen(sequence);
395
396	/*
397	 * OK - we really should never get a zero length string here, either
398	 * the terminfo entry is there and it has a value or we are not called
399	 * at all.  Unfortunately, if someone assigns a terminfo string to the
400	 * ^@ value we get passed a null string which messes up our length.
401	 * So, if we get a null string then just insert a leaf value in
402	 * the 0th char position of the root keymap.  Note that we are
403	 * totally screwed if someone terminates a multichar sequence
404	 * with ^@... oh well.
405	 */
406	if (length == 0)
407		length = 1;
408
409	for (j = 0; j < length - 1; j++) {
410		  /* add the entry to the struct */
411		tmp_key = add_new_key(current, sequence[j], KEYMAP_MULTI, 0);
412
413		  /* index into the key array - it's
414		     clearer if we stash this */
415		key_ent = current->mapping[(unsigned char) sequence[j]];
416
417		current->key[key_ent] = tmp_key;
418
419		  /* next key uses this map... */
420		current = current->key[key_ent]->value.next;
421	}
422
423	/*
424	 * This is the last key in the sequence (it may have been the
425	 * only one but that does not matter) this means it is a leaf
426	 * key and should have a symbol associated with it.
427	 */
428	tmp_key = add_new_key(current, sequence[length - 1], KEYMAP_LEAF,
429			      key_type);
430	current->key[current->mapping[(int)sequence[length - 1]]] = tmp_key;
431}
432
433/*
434 * Init_getch - initialise all the pointers & structures needed to make
435 * getch work in keypad mode.
436 *
437 */
438void
439__init_getch(SCREEN *screen)
440{
441	char entry[1024], *p;
442	const char *s;
443	int     i;
444	size_t limit, l;
445#ifdef DEBUG
446	int k, length;
447#endif
448
449	/* init the inkey state variable */
450	_cursesi_state = INKEY_NORM;
451
452	/* init the base keymap */
453	screen->base_keymap = new_keymap();
454
455	/* key input buffer pointers */
456	start = end = working = 0;
457
458	/* now do the terminfo snarfing ... */
459
460	for (i = 0; i < num_tcs; i++) {
461		p = entry;
462		limit = 1023;
463		s = screen->term->strs[tc[i].code];
464		if (s == NULL)
465			continue;
466		l = strlen(s) + 1;
467		if (limit < l)
468			continue;
469		strlcpy(p, s, limit);
470		p += l;
471		limit -= l;
472#ifdef DEBUG
473			__CTRACE(__CTRACE_INIT,
474			    "Processing terminfo entry %d, sequence ",
475			    tc[i].code);
476			length = (int) strlen(entry);
477			for (k = 0; k <= length -1; k++)
478				__CTRACE(__CTRACE_INIT, "%s", unctrl(entry[k]));
479			__CTRACE(__CTRACE_INIT, "\n");
480#endif
481		add_key_sequence(screen, entry, tc[i].symbol);
482	}
483}
484
485
486/*
487 * new_keymap - allocates & initialises a new keymap structure.  This
488 * function returns a pointer to the new keymap.
489 *
490 */
491static keymap_t *
492new_keymap(void)
493{
494	int     i;
495	keymap_t *new_map;
496
497	if ((new_map = malloc(sizeof(keymap_t))) == NULL) {
498		perror("Inkey: Cannot allocate new keymap");
499		exit(2);
500	}
501
502	/* Initialise the new map */
503	new_map->count = 0;
504	for (i = 0; i < MAX_CHAR; i++) {
505		new_map->mapping[i] = MAPPING_UNUSED; /* no mapping for char */
506	}
507
508	/* key array will be allocated when first key is added */
509	new_map->key = NULL;
510
511	return new_map;
512}
513
514/*
515 * new_key - allocates & initialises a new key entry.  This function returns
516 * a pointer to the newly allocated key entry.
517 *
518 */
519static key_entry_t *
520new_key(void)
521{
522	key_entry_t *new_one;
523	int i;
524
525	new_one = malloc(KEYMAP_ALLOC_CHUNK * sizeof(key_entry_t));
526	if (new_one == NULL) {
527		perror("inkey: Cannot allocate new key entry chunk");
528		exit(2);
529	}
530
531	for (i = 0; i < KEYMAP_ALLOC_CHUNK; i++) {
532		new_one[i].type = 0;
533		new_one[i].value.next = NULL;
534	}
535
536	return new_one;
537}
538
539/*
540 * inkey - do the work to process keyboard input, check for multi-key
541 * sequences and return the appropriate symbol if we get a match.
542 *
543 */
544
545static wchar_t
546inkey(int to, int delay)
547{
548	wchar_t		 k;
549	int              c, mapping;
550	keymap_t	*current = _cursesi_screen->base_keymap;
551	FILE            *infd = _cursesi_screen->infd;
552
553	k = 0;		/* XXX gcc -Wuninitialized */
554
555#ifdef DEBUG
556	__CTRACE(__CTRACE_INPUT, "inkey (%d, %d)\n", to, delay);
557#endif
558	for (;;) {		/* loop until we get a complete key sequence */
559reread:
560		if (_cursesi_state == INKEY_NORM) {
561			if (delay && __timeout(delay) == ERR)
562				return ERR;
563			c = __fgetc_resize(infd);
564			if (c == ERR || c == KEY_RESIZE) {
565				clearerr(infd);
566				return c;
567			}
568
569			if (delay && (__notimeout() == ERR))
570				return ERR;
571
572			k = (wchar_t)c;
573#ifdef DEBUG
574			__CTRACE(__CTRACE_INPUT,
575			    "inkey (state normal) got '%s'\n", unctrl(k));
576#endif
577
578			working = start;
579			inbuf[working] = k;
580			INC_POINTER(working);
581			end = working;
582
583			/* go to the assembling state now */
584			_cursesi_state = INKEY_ASSEMBLING;
585
586		} else if (_cursesi_state == INKEY_BACKOUT) {
587			k = inbuf[working];
588			INC_POINTER(working);
589			if (working == end) {	/* see if we have run
590						 * out of keys in the
591						 * backlog */
592
593				/* if we have then switch to assembling */
594				_cursesi_state = INKEY_ASSEMBLING;
595			}
596		} else if (_cursesi_state == INKEY_ASSEMBLING) {
597			/* assembling a key sequence */
598			if (delay) {
599				if (__timeout(to ? (ESCDELAY / 100) : delay)
600				    == ERR)
601					return ERR;
602			} else {
603				if (to && (__timeout(ESCDELAY / 100) == ERR))
604					return ERR;
605			}
606
607			c = __fgetc_resize(infd);
608			if (ferror(infd)) {
609				clearerr(infd);
610				return c;
611			}
612
613			if ((to || delay) && (__notimeout() == ERR))
614					return ERR;
615
616#ifdef DEBUG
617			__CTRACE(__CTRACE_INPUT,
618			    "inkey (state assembling) got '%s'\n", unctrl(k));
619#endif
620			if (feof(infd) || c == -1) {	/* inter-char timeout,
621							 * start backing out */
622				clearerr(infd);
623				if (start == end)
624					/* no chars in the buffer, restart */
625					goto reread;
626
627				k = inbuf[start];
628				_cursesi_state = INKEY_TIMEOUT;
629			} else {
630				k = (wchar_t) c;
631				inbuf[working] = k;
632				INC_POINTER(working);
633				end = working;
634			}
635		} else {
636			fprintf(stderr, "Inkey state screwed - exiting!!!");
637			exit(2);
638		}
639
640		  /*
641		   * Check key has no special meaning and we have not
642		   * timed out and the key has not been disabled
643		   */
644		mapping = current->mapping[k];
645		if (((_cursesi_state == INKEY_TIMEOUT) || (mapping < 0))
646			|| ((current->key[mapping]->type == KEYMAP_LEAF)
647			    && (current->key[mapping]->enable == FALSE))) {
648			/* return the first key we know about */
649			k = inbuf[start];
650
651			INC_POINTER(start);
652			working = start;
653
654			if (start == end) {	/* only one char processed */
655				_cursesi_state = INKEY_NORM;
656			} else {/* otherwise we must have more than one char
657				 * to backout */
658				_cursesi_state = INKEY_BACKOUT;
659			}
660			return k;
661		} else {	/* must be part of a multikey sequence */
662			/* check for completed key sequence */
663			if (current->key[current->mapping[k]]->type == KEYMAP_LEAF) {
664				start = working;	/* eat the key sequence
665							 * in inbuf */
666
667				/* check if inbuf empty now */
668				if (start == end) {
669					/* if it is go back to normal */
670					_cursesi_state = INKEY_NORM;
671				} else {
672					/* otherwise go to backout state */
673					_cursesi_state = INKEY_BACKOUT;
674				}
675
676				/* return the symbol */
677				return current->key[current->mapping[k]]->value.symbol;
678
679			} else {
680				/*
681				 * Step on to next part of the multi-key
682				 * sequence.
683				 */
684				current = current->key[current->mapping[k]]->value.next;
685			}
686		}
687	}
688}
689
690#ifndef _CURSES_USE_MACROS
691/*
692 * getch --
693 *	Read in a character from stdscr.
694 */
695int
696getch(void)
697{
698	return wgetch(stdscr);
699}
700
701/*
702 * mvgetch --
703 *      Read in a character from stdscr at the given location.
704 */
705int
706mvgetch(int y, int x)
707{
708	return mvwgetch(stdscr, y, x);
709}
710
711/*
712 * mvwgetch --
713 *      Read in a character from stdscr at the given location in the
714 *      given window.
715 */
716int
717mvwgetch(WINDOW *win, int y, int x)
718{
719	if (wmove(win, y, x) == ERR)
720		return ERR;
721
722	return wgetch(win);
723}
724
725#endif
726
727/*
728 * keyok --
729 *      Set the enable flag for a keysym, if the flag is false then
730 * getch will not return this keysym even if the matching key sequence
731 * is seen.
732 */
733int
734keyok(int key_type, bool flag)
735{
736	int result = ERR;
737
738	if (_cursesi_screen != NULL)
739		do_keyok(_cursesi_screen->base_keymap, key_type,
740		    true, flag, &result);
741	return result;
742}
743
744/*
745 * do_keyok --
746 *       Does the actual work for keyok, we need to recurse through the
747 * keymaps finding the passed key symbol.
748 */
749static void
750do_keyok(keymap_t *current, int key_type, bool set, bool flag, int *retval)
751{
752	key_entry_t *key;
753	int i;
754
755	  /*
756	   * we need to iterate over all the keys as there may be
757	   * multiple instances of the leaf symbol.
758	   */
759	for (i = 0; i < MAX_CHAR; i++) {
760		if (current->mapping[i] < 0)
761			continue; /* no mapping for the key, next! */
762
763		key = current->key[current->mapping[i]];
764
765		if (key->type == KEYMAP_MULTI)
766			do_keyok(key->value.next, key_type, set, flag, retval);
767		else if ((key->type == KEYMAP_LEAF)
768			 && (key->value.symbol == key_type)) {
769			if (set)
770				key->enable = flag;
771			*retval = OK; /* we found at least one instance, ok */
772		}
773	}
774}
775
776/*
777 * define_key --
778 *      Add a custom mapping of a key sequence to key symbol.
779 *
780 */
781int
782define_key(char *sequence, int symbol)
783{
784
785	if (symbol <= 0 || _cursesi_screen == NULL)
786		return ERR;
787
788	if (sequence == NULL) {
789#ifdef DEBUG
790		__CTRACE(__CTRACE_INPUT, "define_key: deleting keysym %d\n",
791		    symbol);
792#endif
793		delete_key_sequence(_cursesi_screen->base_keymap, symbol);
794	} else
795		add_key_sequence(_cursesi_screen, sequence, symbol);
796
797	return OK;
798}
799
800/*
801 * wgetch --
802 *	Read in a character from the window.
803 */
804int
805wgetch(WINDOW *win)
806{
807	int inp, weset;
808	int c;
809	FILE *infd = _cursesi_screen->infd;
810
811#ifdef DEBUG
812	__CTRACE(__CTRACE_INPUT, "wgetch: win(%p)\n", win);
813#endif
814	if (win == NULL)
815		return ERR;
816	if (!(win->flags & __SCROLLOK) && (win->flags & __FULLWIN)
817	    && win->curx == win->maxx - 1 && win->cury == win->maxy - 1
818	    && __echoit)
819		return ERR;
820
821	if (is_wintouched(win))
822		wrefresh(win);
823	else {
824		if ((_cursesi_screen->curscr->cury != (win->begy + win->cury))
825		    || (_cursesi_screen->curscr->curx != (win->begx + win->curx))) {
826#ifdef DEBUG
827			__CTRACE(__CTRACE_INPUT, "wgetch: curscr cury %d cury %d curscr curx %d curx %d\n",
828			_cursesi_screen->curscr->cury, win->begy + win->cury,
829			_cursesi_screen->curscr->curx, win->begx + win->curx);
830#endif
831			/*
832			 * Just in case the window is not dirty but the
833			 * cursor was  moved, check and update the
834			 * cursor location.
835			 */
836			mvcur(_cursesi_screen->curscr->cury,
837			    _cursesi_screen->curscr->curx,
838		      	    win->cury + win->begy, win->curx + win->begx);
839			_cursesi_screen->curscr->cury =
840			    win->cury + win->begy;
841			_cursesi_screen->curscr->curx =
842			    win->curx + win->begx;
843		}
844	}
845
846#ifdef DEBUG
847	__CTRACE(__CTRACE_INPUT, "wgetch: __echoit = %d, "
848	    "__rawmode = %d, __nl = %d, flags = %#.4x, delay = %d\n",
849	    __echoit, __rawmode, _cursesi_screen->nl, win->flags, win->delay);
850#endif
851	if (_cursesi_screen->resized) {
852		resizeterm(LINES, COLS);
853		_cursesi_screen->resized = 0;
854#ifdef DEBUG
855		__CTRACE(__CTRACE_INPUT, "wgetch returning KEY_RESIZE\n");
856#endif
857		return KEY_RESIZE;
858	}
859	if (_cursesi_screen->unget_pos) {
860#ifdef DEBUG
861		__CTRACE(__CTRACE_INPUT, "wgetch returning char at %d\n",
862		    _cursesi_screen->unget_pos);
863#endif
864		_cursesi_screen->unget_pos--;
865		c = _cursesi_screen->unget_list[_cursesi_screen->unget_pos];
866		if (__echoit)
867			waddch(win, (chtype) c);
868		return c;
869	}
870	if (__echoit && !__rawmode) {
871		cbreak();
872		weset = 1;
873	} else
874		weset = 0;
875
876	__save_termios();
877
878	if (win->flags & __KEYPAD) {
879		switch (win->delay)
880		{
881		case -1:
882			inp = inkey (win->flags & __NOTIMEOUT ? 0 : 1, 0);
883			break;
884		case 0:
885			if (__nodelay() == ERR)
886				return ERR;
887			inp = inkey(0, 0);
888			break;
889		default:
890			inp = inkey(win->flags & __NOTIMEOUT ? 0 : 1, win->delay);
891			break;
892		}
893	} else {
894		switch (win->delay)
895		{
896		case -1:
897			if (__delay() == ERR)
898				return ERR;
899			break;
900		case 0:
901			if (__nodelay() == ERR)
902				return ERR;
903			break;
904		default:
905			if (__timeout(win->delay) == ERR)
906				return ERR;
907			break;
908		}
909
910		inp = __fgetc_resize(infd);
911		if (inp == ERR || inp == KEY_RESIZE) {
912			clearerr(infd);
913			__restore_termios();
914			return inp;
915		}
916	}
917#ifdef DEBUG
918	if (inp > 255)
919		  /* we have a key symbol - treat it differently */
920		  /* XXXX perhaps __unctrl should be expanded to include
921		   * XXXX the keysyms in the table....
922		   */
923		__CTRACE(__CTRACE_INPUT, "wgetch assembled keysym 0x%x\n", inp);
924	else
925		__CTRACE(__CTRACE_INPUT, "wgetch got '%s'\n", unctrl(inp));
926#endif
927	if (win->delay > -1) {
928		if (__delay() == ERR)
929			return ERR;
930	}
931
932	__restore_termios();
933
934	if ((__echoit) && (inp < KEY_MIN))
935		waddch(win, (chtype) inp);
936
937	if (weset)
938		nocbreak();
939
940	if (_cursesi_screen->nl && inp == 13)
941		inp = 10;
942
943	return ((inp < 0) || (inp == ERR) ? ERR : inp);
944}
945
946/*
947 * ungetch --
948 *     Put the character back into the input queue.
949 */
950int
951ungetch(int c)
952{
953	return __unget((wint_t)c);
954}
955
956/*
957 * __unget --
958 *    Do the work for ungetch() and unget_wch();
959 */
960int
961__unget(wint_t c)
962{
963	wchar_t	*p;
964	int	len;
965
966#ifdef DEBUG
967	__CTRACE(__CTRACE_INPUT, "__unget(%x)\n", c);
968#endif
969	if (_cursesi_screen == NULL)
970		return ERR;
971	if (_cursesi_screen->unget_pos >= _cursesi_screen->unget_len) {
972		len = _cursesi_screen->unget_len + 32;
973		if ((p = realloc(_cursesi_screen->unget_list,
974		    sizeof(wchar_t) * len)) == NULL) {
975			/* Can't realloc(), so just lose the oldest entry */
976			memmove(_cursesi_screen->unget_list,
977			    _cursesi_screen->unget_list + sizeof(wchar_t),
978			    _cursesi_screen->unget_len - 1);
979			_cursesi_screen->unget_list[_cursesi_screen->unget_len
980			    - 1] = c;
981			_cursesi_screen->unget_pos =
982			    _cursesi_screen->unget_len;
983			return OK;
984		} else {
985			_cursesi_screen->unget_pos =
986			    _cursesi_screen->unget_len;
987			_cursesi_screen->unget_len = len;
988			_cursesi_screen->unget_list = p;
989		}
990	}
991	_cursesi_screen->unget_list[_cursesi_screen->unget_pos] = c;
992	_cursesi_screen->unget_pos++;
993	return OK;
994}
995
996int
997has_key(int key_type)
998{
999	int result = ERR;
1000
1001	if (_cursesi_screen != NULL)
1002		do_keyok(_cursesi_screen->base_keymap, key_type,
1003		    false, false, &result);
1004	return result;
1005}
1006
1007/*
1008 * set_escdelay --
1009 *   Sets the escape delay for the current screen.
1010 */
1011int
1012set_escdelay(int escdelay)
1013{
1014
1015	if (_cursesi_screen == NULL)
1016		return ERR;
1017	_cursesi_screen->ESCDELAY = escdelay;
1018	ESCDELAY = escdelay;
1019	return OK;
1020}
1021
1022/*
1023 * __fgetc_resize --
1024 *    Any call to fgetc(3) should use this function instead
1025 *    and test for the return value of KEY_RESIZE as well as ERR.
1026 */
1027int
1028__fgetc_resize(FILE *infd)
1029{
1030	int c;
1031
1032	c = fgetc(infd);
1033	if (c != EOF)
1034		return c;
1035
1036	if (!ferror(infd) || errno != EINTR || !_cursesi_screen->resized)
1037		return ERR;
1038#ifdef DEBUG
1039	__CTRACE(__CTRACE_INPUT, "__fgetc_resize returning KEY_RESIZE\n");
1040#endif
1041	resizeterm(LINES, COLS);
1042	_cursesi_screen->resized = 0;
1043	return KEY_RESIZE;
1044}
1045