/*
* Copyright (c) 1981, 1993, 1994
* The Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/* Key buffer */
#define INBUF_SZ 16 /* size of key buffer - must be larger than
* longest multi-key sequence */
static wchar_t inbuf[INBUF_SZ];
static int start, end, working; /* pointers for manipulating inbuf data */
/* prototypes for private functions */
static void add_key_sequence(SCREEN *screen, const char *sequence, int key_type);
static key_entry_t *add_new_key(keymap_t *current, char ch, int key_type,
int symbol);
static void delete_key_sequence(keymap_t *current, int key_type);
static void do_keyok(keymap_t *current, int key_type, bool set, bool flag,
int *retval);
static keymap_t *new_keymap(void); /* create a new keymap */
static key_entry_t *new_key(void); /* create a new key entry */
static wchar_t inkey(int to, int delay);
/*
* Free the storage associated with the given keymap
*/
void
_cursesi_free_keymap(keymap_t *map)
{
int i;
/* check for, and free, child keymaps */
for (i = 0; i < MAX_CHAR; i++) {
if (map->mapping[i] >= 0) {
if (map->key[map->mapping[i]]->type == KEYMAP_MULTI)
_cursesi_free_keymap(
map->key[map->mapping[i]]->value.next);
}
}
/* now free any allocated keymap structs */
for (i = 0; i < map->count; i += KEYMAP_ALLOC_CHUNK) {
free(map->key[i]);
}
free(map->key);
free(map);
}
/*
* Add a new key entry to the keymap pointed to by current. Entry
* contains the character to add to the keymap, type is the type of
* entry to add (either multikey or leaf) and symbol is the symbolic
* value for a leaf type entry. The function returns a pointer to the
* new keymap entry.
*/
static key_entry_t *
add_new_key(keymap_t *current, char chr, int key_type, int symbol)
{
key_entry_t *the_key;
int i, ki;
__CTRACE(__CTRACE_MISC,
"Adding character %s of type %d, symbol 0x%x\n",
unctrl(chr), key_type, symbol);
if (current->mapping[(unsigned char)chr] < 0) {
if (current->mapping[(unsigned char)chr] == MAPPING_UNUSED) {
/* first time for this char */
current->mapping[(unsigned char)chr] =
current->count; /* map new entry */
ki = current->count;
/* make sure we have room in the key array first */
if ((current->count & (KEYMAP_ALLOC_CHUNK - 1)) == 0)
{
if ((current->key =
realloc(current->key,
ki * sizeof(key_entry_t *)
+ KEYMAP_ALLOC_CHUNK * sizeof(key_entry_t *))) == NULL) {
fprintf(stderr,
"Could not malloc for key entry\n");
exit(1);
}
the_key = new_key();
for (i = 0; i < KEYMAP_ALLOC_CHUNK; i++) {
current->key[ki + i] = &the_key[i];
}
}
} else {
/* the mapping was used but freed, reuse it */
ki = - current->mapping[(unsigned char) chr];
current->mapping[(unsigned char) chr] = ki;
}
current->count++;
/* point at the current key array element to use */
the_key = current->key[ki];
the_key->type = key_type;
switch (key_type) {
case KEYMAP_MULTI:
/* need for next key */
__CTRACE(__CTRACE_MISC, "Creating new keymap\n");
the_key->value.next = new_keymap();
the_key->enable = TRUE;
break;
case KEYMAP_LEAF:
/* the associated symbol for the key */
__CTRACE(__CTRACE_MISC, "Adding leaf key\n");
the_key->value.symbol = symbol;
the_key->enable = TRUE;
break;
default:
fprintf(stderr, "add_new_key: bad type passed\n");
exit(1);
}
} else {
/* the key is already known - just return the address. */
__CTRACE(__CTRACE_MISC, "Keymap already known\n");
the_key = current->key[current->mapping[(unsigned char)chr]];
}
return the_key;
}
/*
* Delete the given key symbol from the key mappings for the screen.
*
*/
static void
delete_key_sequence(keymap_t *current, int key_type)
{
key_entry_t *key;
int i;
/*
* we need to iterate over all the keys as there may be
* multiple instances of the leaf symbol.
*/
for (i = 0; i < MAX_CHAR; i++) {
if (current->mapping[i] < 0)
continue; /* no mapping for the key, next! */
key = current->key[current->mapping[i]];
if (key->type == KEYMAP_MULTI) {
/* have not found the leaf, recurse down */
delete_key_sequence(key->value.next, key_type);
/* if we deleted the last key in the map, free */
if (key->value.next->count == 0)
_cursesi_free_keymap(key->value.next);
} else if ((key->type == KEYMAP_LEAF)
&& (key->value.symbol == key_type)) {
__CTRACE(__CTRACE_INPUT,
"delete_key_sequence: found keysym %d, deleting\n",
key_type);
key->enable = FALSE;
}
}
}
/*
* Add the sequence of characters given in sequence as the key mapping
* for the given key symbol.
*/
static void
add_key_sequence(SCREEN *screen, const char *sequence, int key_type)
{
key_entry_t *tmp_key;
keymap_t *current;
int length, j, key_ent;
__CTRACE(__CTRACE_MISC, "add_key_sequence: add key sequence: %s(%s)\n",
sequence, keyname(key_type));
current = screen->base_keymap; /* always start with
* base keymap. */
length = (int)strlen(sequence);
/*
* OK - we really should never get a zero length string here, either
* the terminfo entry is there and it has a value or we are not called
* at all. Unfortunately, if someone assigns a terminfo string to the
* ^@ value we get passed a null string which messes up our length.
* So, if we get a null string then just insert a leaf value in
* the 0th char position of the root keymap. Note that we are
* totally screwed if someone terminates a multichar sequence
* with ^@... oh well.
*/
if (length == 0)
length = 1;
for (j = 0; j < length - 1; j++) {
/* add the entry to the struct */
tmp_key = add_new_key(current, sequence[j], KEYMAP_MULTI, 0);
/* index into the key array - it's
clearer if we stash this */
key_ent = current->mapping[(unsigned char) sequence[j]];
current->key[key_ent] = tmp_key;
/* next key uses this map... */
current = current->key[key_ent]->value.next;
}
/*
* This is the last key in the sequence (it may have been the
* only one but that does not matter) this means it is a leaf
* key and should have a symbol associated with it.
*/
tmp_key = add_new_key(current, sequence[length - 1], KEYMAP_LEAF,
key_type);
current->key[current->mapping[(int)sequence[length - 1]]] = tmp_key;
}
/*
* Init_getch - initialise all the pointers & structures needed to make
* getch work in keypad mode.
*
*/
void
__init_getch(SCREEN *screen)
{
char entry[1024], *p;
const char *s;
int i;
size_t limit, l;
#ifdef DEBUG
int k, length;
#endif
/* init the inkey state variable */
_cursesi_state = INKEY_NORM;
/* init the base keymap */
screen->base_keymap = new_keymap();
/* key input buffer pointers */
start = end = working = 0;
/* now do the terminfo snarfing ... */
for (i = 0; i < num_tcs; i++) {
p = entry;
limit = 1023;
s = screen->term->strs[tc[i].code];
if (s == NULL)
continue;
l = strlen(s) + 1;
if (limit < l)
continue;
strlcpy(p, s, limit);
p += l;
limit -= l;
#ifdef DEBUG
__CTRACE(__CTRACE_INIT,
"Processing terminfo entry %d, sequence ",
tc[i].code);
length = (int) strlen(entry);
for (k = 0; k <= length -1; k++)
__CTRACE(__CTRACE_INIT, "%s", unctrl(entry[k]));
__CTRACE(__CTRACE_INIT, "\n");
#endif
add_key_sequence(screen, entry, tc[i].symbol);
}
}
/*
* new_keymap - allocates & initialises a new keymap structure. This
* function returns a pointer to the new keymap.
*
*/
static keymap_t *
new_keymap(void)
{
int i;
keymap_t *new_map;
if ((new_map = malloc(sizeof(keymap_t))) == NULL) {
perror("Inkey: Cannot allocate new keymap");
exit(2);
}
/* Initialise the new map */
new_map->count = 0;
for (i = 0; i < MAX_CHAR; i++) {
new_map->mapping[i] = MAPPING_UNUSED; /* no mapping for char */
}
/* key array will be allocated when first key is added */
new_map->key = NULL;
return new_map;
}
/*
* new_key - allocates & initialises a new key entry. This function returns
* a pointer to the newly allocated key entry.
*
*/
static key_entry_t *
new_key(void)
{
key_entry_t *new_one;
int i;
new_one = malloc(KEYMAP_ALLOC_CHUNK * sizeof(key_entry_t));
if (new_one == NULL) {
perror("inkey: Cannot allocate new key entry chunk");
exit(2);
}
for (i = 0; i < KEYMAP_ALLOC_CHUNK; i++) {
new_one[i].type = 0;
new_one[i].value.next = NULL;
}
return new_one;
}
/*
* inkey - do the work to process keyboard input, check for multi-key
* sequences and return the appropriate symbol if we get a match.
*
*/
static wchar_t
inkey(int to, int delay)
{
wchar_t k;
int c, mapping;
keymap_t *current = _cursesi_screen->base_keymap;
FILE *infd = _cursesi_screen->infd;
k = 0; /* XXX gcc -Wuninitialized */
__CTRACE(__CTRACE_INPUT, "inkey (%d, %d)\n", to, delay);
for (;;) { /* loop until we get a complete key sequence */
reread:
if (_cursesi_state == INKEY_NORM) {
if (delay && __timeout(delay) == ERR)
return ERR;
c = __fgetc_resize(infd);
if (c == ERR || c == KEY_RESIZE) {
clearerr(infd);
return c;
}
if (delay && (__notimeout() == ERR))
return ERR;
k = (wchar_t)c;
__CTRACE(__CTRACE_INPUT,
"inkey (state normal) got '%s'\n", unctrl(k));
working = start;
inbuf[working] = k;
INC_POINTER(working);
end = working;
/* go to the assembling state now */
_cursesi_state = INKEY_ASSEMBLING;
} else if (_cursesi_state == INKEY_BACKOUT) {
k = inbuf[working];
INC_POINTER(working);
if (working == end) { /* see if we have run
* out of keys in the
* backlog */
/* if we have then switch to assembling */
_cursesi_state = INKEY_ASSEMBLING;
}
} else if (_cursesi_state == INKEY_ASSEMBLING) {
/* assembling a key sequence */
if (delay) {
if (__timeout(to ? (ESCDELAY / 100) : delay)
== ERR)
return ERR;
} else {
if (to && (__timeout(ESCDELAY / 100) == ERR))
return ERR;
}
c = __fgetc_resize(infd);
if (ferror(infd)) {
clearerr(infd);
return c;
}
if ((to || delay) && (__notimeout() == ERR))
return ERR;
__CTRACE(__CTRACE_INPUT,
"inkey (state assembling) got '%s'\n", unctrl(k));
if (feof(infd) || c == -1) { /* inter-char timeout,
* start backing out */
clearerr(infd);
if (start == end)
/* no chars in the buffer, restart */
goto reread;
k = inbuf[start];
_cursesi_state = INKEY_TIMEOUT;
} else {
k = (wchar_t) c;
inbuf[working] = k;
INC_POINTER(working);
end = working;
}
} else {
fprintf(stderr, "Inkey state screwed - exiting!!!");
exit(2);
}
/*
* Check key has no special meaning and we have not
* timed out and the key has not been disabled
*/
mapping = current->mapping[k];
if (((_cursesi_state == INKEY_TIMEOUT) || (mapping < 0))
|| ((current->key[mapping]->type == KEYMAP_LEAF)
&& (current->key[mapping]->enable == FALSE))) {
/* return the first key we know about */
k = inbuf[start];
INC_POINTER(start);
working = start;
if (start == end) { /* only one char processed */
_cursesi_state = INKEY_NORM;
} else {/* otherwise we must have more than one char
* to backout */
_cursesi_state = INKEY_BACKOUT;
}
return k;
} else { /* must be part of a multikey sequence */
/* check for completed key sequence */
if (current->key[current->mapping[k]]->type == KEYMAP_LEAF) {
start = working; /* eat the key sequence
* in inbuf */
/* check if inbuf empty now */
if (start == end) {
/* if it is go back to normal */
_cursesi_state = INKEY_NORM;
} else {
/* otherwise go to backout state */
_cursesi_state = INKEY_BACKOUT;
}
/* return the symbol */
return current->key[current->mapping[k]]->value.symbol;
} else {
/*
* Step on to next part of the multi-key
* sequence.
*/
current = current->key[current->mapping[k]]->value.next;
}
}
}
}
#ifndef _CURSES_USE_MACROS
/*
* getch --
* Read in a character from stdscr.
*/
int
getch(void)
{
return wgetch(stdscr);
}
/*
* mvgetch --
* Read in a character from stdscr at the given location.
*/
int
mvgetch(int y, int x)
{
return mvwgetch(stdscr, y, x);
}
/*
* mvwgetch --
* Read in a character from stdscr at the given location in the
* given window.
*/
int
mvwgetch(WINDOW *win, int y, int x)
{
if (wmove(win, y, x) == ERR)
return ERR;
return wgetch(win);
}
#endif
/*
* keyok --
* Set the enable flag for a keysym, if the flag is false then
* getch will not return this keysym even if the matching key sequence
* is seen.
*/
int
keyok(int key_type, bool flag)
{
int result = ERR;
/*
* do_keyok --
* Does the actual work for keyok, we need to recurse through the
* keymaps finding the passed key symbol.
*/
static void
do_keyok(keymap_t *current, int key_type, bool set, bool flag, int *retval)
{
key_entry_t *key;
int i;
/*
* we need to iterate over all the keys as there may be
* multiple instances of the leaf symbol.
*/
for (i = 0; i < MAX_CHAR; i++) {
if (current->mapping[i] < 0)
continue; /* no mapping for the key, next! */
key = current->key[current->mapping[i]];
if (key->type == KEYMAP_MULTI)
do_keyok(key->value.next, key_type, set, flag, retval);
else if ((key->type == KEYMAP_LEAF)
&& (key->value.symbol == key_type)) {
if (set)
key->enable = flag;
*retval = OK; /* we found at least one instance, ok */
}
}
}
/*
* define_key --
* Add a custom mapping of a key sequence to key symbol.
*
*/
int
define_key(const char *sequence, int symbol)
{
if (symbol <= 0 || _cursesi_screen == NULL)
return ERR;
if (win->flags & __KEYPAD) {
switch (win->delay) {
case -1:
inp = inkey (win->flags & __NOTIMEOUT ? 0 : 1, 0);
break;
case 0:
if (__nodelay() == ERR)
return ERR;
inp = inkey(0, 0);
break;
default:
inp = inkey(win->flags & __NOTIMEOUT ? 0 : 1, win->delay);
break;
}
} else {
switch (win->delay) {
case -1:
if (__delay() == ERR)
return ERR;
break;
case 0:
if (__nodelay() == ERR)
return ERR;
break;
default:
if (__timeout(win->delay) == ERR)
return ERR;
break;
}
inp = __fgetc_resize(infd);
if (inp == ERR || inp == KEY_RESIZE) {
clearerr(infd);
__restore_termios();
return inp;
}
}
#ifdef DEBUG
if (inp > 255)
/* we have a key symbol - treat it differently */
/* XXXX perhaps __unctrl should be expanded to include
* XXXX the keysyms in the table....
*/
__CTRACE(__CTRACE_INPUT, "wgetch assembled keysym 0x%x\n", inp);
else
__CTRACE(__CTRACE_INPUT, "wgetch got '%s'\n", unctrl(inp));
#endif
if (win->delay > -1) {
if (__delay() == ERR)
return ERR;
}
__restore_termios();
if ((__echoit) && (inp < KEY_MIN))
waddch(win, (chtype) inp);
if (weset)
nocbreak();
if (_cursesi_screen->nl && inp == 13)
inp = 10;
return ((inp < 0) || (inp == ERR) ? ERR : inp);
}
/*
* ungetch --
* Put the character back into the input queue.
*/
int
ungetch(int c)
{
return __unget((wint_t)c);
}
/*
* __unget --
* Do the work for ungetch() and unget_wch();
*/
int
__unget(wint_t c)
{
wchar_t *p;
int len;
/*
* __fgetc_resize --
* Any call to fgetc(3) should use this function instead
* and test for the return value of KEY_RESIZE as well as ERR.
*/
int
__fgetc_resize(FILE *infd)
{
int c;
