119304Speter/*- 219304Speter * Copyright (c) 1991, 1993, 1994 319304Speter * The Regents of the University of California. All rights reserved. 419304Speter * Copyright (c) 1991, 1993, 1994, 1995, 1996 519304Speter * Keith Bostic. All rights reserved. 619304Speter * 719304Speter * See the LICENSE file for redistribution information. 819304Speter */ 919304Speter 1019304Speter#include "config.h" 1119304Speter 1219304Speter#ifndef lint 13270026Semastestatic const char sccsid[] = "$Id: key.c,v 10.54 2013/11/13 12:15:27 zy Exp $"; 1419304Speter#endif /* not lint */ 1519304Speter 1619304Speter#include <sys/types.h> 1719304Speter#include <sys/queue.h> 1819304Speter#include <sys/time.h> 1919304Speter 2019304Speter#include <bitstring.h> 2119304Speter#include <ctype.h> 2219304Speter#include <errno.h> 2319304Speter#include <limits.h> 2419304Speter#include <stdio.h> 2519304Speter#include <stdlib.h> 2619304Speter#include <string.h> 27254225Speter#include <strings.h> 2819304Speter#include <unistd.h> 2919304Speter 3019304Speter#include "common.h" 3119304Speter#include "../vi/vi.h" 3219304Speter 3319304Speterstatic int v_event_append __P((SCR *, EVENT *)); 3419304Speterstatic int v_event_grow __P((SCR *, int)); 3519304Speterstatic int v_key_cmp __P((const void *, const void *)); 3619304Speterstatic void v_keyval __P((SCR *, int, scr_keyval_t)); 3719304Speterstatic void v_sync __P((SCR *, int)); 3819304Speter 3919304Speter/* 4019304Speter * !!! 4119304Speter * Historic vi always used: 4219304Speter * 4319304Speter * ^D: autoindent deletion 4419304Speter * ^H: last character deletion 4519304Speter * ^W: last word deletion 4619304Speter * ^Q: quote the next character (if not used in flow control). 4719304Speter * ^V: quote the next character 4819304Speter * 4919304Speter * regardless of the user's choices for these characters. The user's erase 5019304Speter * and kill characters worked in addition to these characters. Nvi wires 5119304Speter * down the above characters, but in addition permits the VEOF, VERASE, VKILL 5219304Speter * and VWERASE characters described by the user's termios structure. 5319304Speter * 5419304Speter * Ex was not consistent with this scheme, as it historically ran in tty 5519304Speter * cooked mode. This meant that the scroll command and autoindent erase 5619304Speter * characters were mapped to the user's EOF character, and the character 5719304Speter * and word deletion characters were the user's tty character and word 5819304Speter * deletion characters. This implementation makes it all consistent, as 5919304Speter * described above for vi. 6019304Speter * 6119304Speter * !!! 6219304Speter * This means that all screens share a special key set. 6319304Speter */ 6419304SpeterKEYLIST keylist[] = { 6519304Speter {K_BACKSLASH, '\\'}, /* \ */ 6619304Speter {K_CARAT, '^'}, /* ^ */ 6719304Speter {K_CNTRLD, '\004'}, /* ^D */ 6819304Speter {K_CNTRLR, '\022'}, /* ^R */ 6919304Speter {K_CNTRLT, '\024'}, /* ^T */ 7019304Speter {K_CNTRLZ, '\032'}, /* ^Z */ 7119304Speter {K_COLON, ':'}, /* : */ 7219304Speter {K_CR, '\r'}, /* \r */ 7319304Speter {K_ESCAPE, '\033'}, /* ^[ */ 7419304Speter {K_FORMFEED, '\f'}, /* \f */ 7519304Speter {K_HEXCHAR, '\030'}, /* ^X */ 7619304Speter {K_NL, '\n'}, /* \n */ 7719304Speter {K_RIGHTBRACE, '}'}, /* } */ 7819304Speter {K_RIGHTPAREN, ')'}, /* ) */ 7919304Speter {K_TAB, '\t'}, /* \t */ 8019304Speter {K_VERASE, '\b'}, /* \b */ 8119304Speter {K_VKILL, '\025'}, /* ^U */ 8219304Speter {K_VLNEXT, '\021'}, /* ^Q */ 8319304Speter {K_VLNEXT, '\026'}, /* ^V */ 8419304Speter {K_VWERASE, '\027'}, /* ^W */ 8519304Speter {K_ZERO, '0'}, /* 0 */ 8619304Speter 8719304Speter#define ADDITIONAL_CHARACTERS 4 8819304Speter {K_NOTUSED, 0}, /* VEOF, VERASE, VKILL, VWERASE */ 8919304Speter {K_NOTUSED, 0}, 9019304Speter {K_NOTUSED, 0}, 9119304Speter {K_NOTUSED, 0}, 9219304Speter}; 9319304Speterstatic int nkeylist = 9419304Speter (sizeof(keylist) / sizeof(keylist[0])) - ADDITIONAL_CHARACTERS; 9519304Speter 9619304Speter/* 9719304Speter * v_key_init -- 9819304Speter * Initialize the special key lookup table. 9919304Speter * 10019304Speter * PUBLIC: int v_key_init __P((SCR *)); 10119304Speter */ 10219304Speterint 103254225Speterv_key_init(SCR *sp) 10419304Speter{ 105254225Speter int ch; 10619304Speter GS *gp; 10719304Speter KEYLIST *kp; 10819304Speter int cnt; 10919304Speter 11019304Speter gp = sp->gp; 11119304Speter 11219304Speter v_key_ilookup(sp); 11319304Speter 11419304Speter v_keyval(sp, K_CNTRLD, KEY_VEOF); 11519304Speter v_keyval(sp, K_VERASE, KEY_VERASE); 11619304Speter v_keyval(sp, K_VKILL, KEY_VKILL); 11719304Speter v_keyval(sp, K_VWERASE, KEY_VWERASE); 11819304Speter 11919304Speter /* Sort the special key list. */ 12019304Speter qsort(keylist, nkeylist, sizeof(keylist[0]), v_key_cmp); 12119304Speter 12219304Speter /* Initialize the fast lookup table. */ 123254225Speter for (kp = keylist, cnt = nkeylist; cnt--; ++kp) 124254225Speter gp->special_key[kp->ch] = kp->value; 12519304Speter 12619304Speter /* Find a non-printable character to use as a message separator. */ 127254225Speter for (ch = 1; ch <= UCHAR_MAX; ++ch) 12819304Speter if (!isprint(ch)) { 12919304Speter gp->noprint = ch; 13019304Speter break; 13119304Speter } 13219304Speter if (ch != gp->noprint) { 13319304Speter msgq(sp, M_ERR, "079|No non-printable character found"); 13419304Speter return (1); 13519304Speter } 13619304Speter return (0); 13719304Speter} 13819304Speter 13919304Speter/* 14019304Speter * v_keyval -- 14119304Speter * Set key values. 14219304Speter * 14319304Speter * We've left some open slots in the keylist table, and if these values exist, 14419304Speter * we put them into place. Note, they may reset (or duplicate) values already 14519304Speter * in the table, so we check for that first. 14619304Speter */ 14719304Speterstatic void 148254225Speterv_keyval( 149254225Speter SCR *sp, 150254225Speter int val, 151254225Speter scr_keyval_t name) 15219304Speter{ 15319304Speter KEYLIST *kp; 15419304Speter CHAR_T ch; 15519304Speter int dne; 15619304Speter 15719304Speter /* Get the key's value from the screen. */ 15819304Speter if (sp->gp->scr_keyval(sp, name, &ch, &dne)) 15919304Speter return; 16019304Speter if (dne) 16119304Speter return; 16219304Speter 16319304Speter /* Check for duplication. */ 16419304Speter for (kp = keylist; kp->value != K_NOTUSED; ++kp) 16519304Speter if (kp->ch == ch) { 16619304Speter kp->value = val; 16719304Speter return; 16819304Speter } 16919304Speter 17019304Speter /* Add a new entry. */ 17119304Speter if (kp->value == K_NOTUSED) { 17219304Speter keylist[nkeylist].ch = ch; 17319304Speter keylist[nkeylist].value = val; 17419304Speter ++nkeylist; 17519304Speter } 17619304Speter} 17719304Speter 17819304Speter/* 17919304Speter * v_key_ilookup -- 18019304Speter * Build the fast-lookup key display array. 18119304Speter * 18219304Speter * PUBLIC: void v_key_ilookup __P((SCR *)); 18319304Speter */ 18419304Spetervoid 185254225Speterv_key_ilookup(SCR *sp) 18619304Speter{ 187254225Speter UCHAR_T ch; 188254225Speter char *p, *t; 18919304Speter GS *gp; 19019304Speter size_t len; 19119304Speter 192254225Speter for (gp = sp->gp, ch = 0;; ++ch) { 19319304Speter for (p = gp->cname[ch].name, t = v_key_name(sp, ch), 19419304Speter len = gp->cname[ch].len = sp->clen; len--;) 19519304Speter *p++ = *t++; 196254225Speter if (ch == MAX_FAST_KEY) 197254225Speter break; 198254225Speter } 19919304Speter} 20019304Speter 20119304Speter/* 20219304Speter * v_key_len -- 20319304Speter * Return the length of the string that will display the key. 20419304Speter * This routine is the backup for the KEY_LEN() macro. 20519304Speter * 20619304Speter * PUBLIC: size_t v_key_len __P((SCR *, ARG_CHAR_T)); 20719304Speter */ 20819304Spetersize_t 209254225Speterv_key_len( 210254225Speter SCR *sp, 211254225Speter ARG_CHAR_T ch) 21219304Speter{ 21319304Speter (void)v_key_name(sp, ch); 21419304Speter return (sp->clen); 21519304Speter} 21619304Speter 21719304Speter/* 21819304Speter * v_key_name -- 21919304Speter * Return the string that will display the key. This routine 22019304Speter * is the backup for the KEY_NAME() macro. 22119304Speter * 222254225Speter * PUBLIC: char *v_key_name __P((SCR *, ARG_CHAR_T)); 22319304Speter */ 224254225Speterchar * 225254225Speterv_key_name( 226254225Speter SCR *sp, 227254225Speter ARG_CHAR_T ach) 22819304Speter{ 229254225Speter static const char hexdigit[] = "0123456789abcdef"; 230254225Speter static const char octdigit[] = "01234567"; 231254225Speter int ch; 23219304Speter size_t len; 233254225Speter char *chp; 23419304Speter 235254225Speter /* 236254225Speter * Cache the last checked character. It won't be a problem 237254225Speter * since nvi will rescan the mapping when settings changed. 238254225Speter */ 239254225Speter if (ach && sp->lastc == ach) 240254225Speter return (sp->cname); 241254225Speter sp->lastc = ach; 24219304Speter 243254225Speter#ifdef USE_WIDECHAR 244254225Speter len = wctomb(sp->cname, ach); 245254225Speter if (len > MB_CUR_MAX) 246254225Speter#endif 247254225Speter sp->cname[(len = 1)-1] = (u_char)ach; 248254225Speter 249254225Speter ch = (u_char)sp->cname[0]; 250254225Speter sp->cname[len] = '\0'; 251254225Speter 25219304Speter /* See if the character was explicitly declared printable or not. */ 25319304Speter if ((chp = O_STR(sp, O_PRINT)) != NULL) 254254225Speter if (strstr(chp, sp->cname) != NULL) 255254225Speter goto done; 25619304Speter if ((chp = O_STR(sp, O_NOPRINT)) != NULL) 257254225Speter if (strstr(chp, sp->cname) != NULL) 258254225Speter goto nopr; 25919304Speter 26019304Speter /* 26119304Speter * Historical (ARPA standard) mappings. Printable characters are left 26219304Speter * alone. Control characters less than 0x20 are represented as '^' 26319304Speter * followed by the character offset from the '@' character in the ASCII 26419304Speter * character set. Del (0x7f) is represented as '^' followed by '?'. 26519304Speter * 26619304Speter * XXX 26719304Speter * The following code depends on the current locale being identical to 26819304Speter * the ASCII map from 0x40 to 0x5f (since 0x1f + 0x40 == 0x5f). I'm 26919304Speter * told that this is a reasonable assumption... 27019304Speter * 27119304Speter * XXX 272254225Speter * The code prints non-printable wide characters in 4 or 5 digits 273254225Speter * Unicode escape sequences, so only supports plane 0 to 15. 27419304Speter */ 275270026Semaste if (CAN_PRINT(sp, ach)) 27619304Speter goto done; 27719304Speternopr: if (iscntrl(ch) && (ch < 0x20 || ch == 0x7f)) { 27819304Speter sp->cname[0] = '^'; 27919304Speter sp->cname[1] = ch == 0x7f ? '?' : '@' + ch; 28019304Speter len = 2; 281254225Speter goto done; 282254225Speter } 283254225Speter#ifdef USE_WIDECHAR 284254225Speter if (INTISWIDE(ach)) { 285254225Speter int uc = -1; 286254225Speter 287254225Speter if (!strcmp(codeset(), "UTF-8")) 288254225Speter uc = decode_utf8(sp->cname); 289254225Speter#ifdef USE_ICONV 290254225Speter else { 291254225Speter char buf[sizeof(sp->cname)] = ""; 292254225Speter size_t left = sizeof(sp->cname); 293254225Speter char *in = sp->cname; 294254225Speter char *out = buf; 295254225Speter iconv(sp->conv.id[IC_IE_TO_UTF16], 296254225Speter (iconv_src_t)&in, &len, &out, &left); 297254225Speter iconv(sp->conv.id[IC_IE_TO_UTF16], 298254225Speter NULL, NULL, NULL, NULL); 299254225Speter uc = decode_utf16(buf, 1); 300254225Speter } 301254225Speter#endif 302254225Speter if (uc >= 0) { 303254225Speter len = snprintf(sp->cname, sizeof(sp->cname), 304254225Speter uc < 0x10000 ? "\\u%04x" : "\\U%05X", uc); 305254225Speter goto done; 306254225Speter } 307254225Speter } 308254225Speter#endif 309254225Speter if (O_ISSET(sp, O_OCTAL)) { 31019304Speter sp->cname[0] = '\\'; 311254225Speter sp->cname[1] = octdigit[(ch & 0300) >> 6]; 312254225Speter sp->cname[2] = octdigit[(ch & 070) >> 3]; 313254225Speter sp->cname[3] = octdigit[ ch & 07 ]; 31419304Speter } else { 31519304Speter sp->cname[0] = '\\'; 31619304Speter sp->cname[1] = 'x'; 317254225Speter sp->cname[2] = hexdigit[(ch & 0xf0) >> 4]; 318254225Speter sp->cname[3] = hexdigit[ ch & 0x0f ]; 31919304Speter } 320254225Speter len = 4; 32119304Speterdone: sp->cname[sp->clen = len] = '\0'; 32219304Speter return (sp->cname); 32319304Speter} 32419304Speter 32519304Speter/* 32619304Speter * v_key_val -- 32719304Speter * Fill in the value for a key. This routine is the backup 32819304Speter * for the KEY_VAL() macro. 32919304Speter * 330254225Speter * PUBLIC: e_key_t v_key_val __P((SCR *, ARG_CHAR_T)); 33119304Speter */ 332254225Spetere_key_t 333254225Speterv_key_val( 334254225Speter SCR *sp, 335254225Speter ARG_CHAR_T ch) 33619304Speter{ 33719304Speter KEYLIST k, *kp; 33819304Speter 33919304Speter k.ch = ch; 34019304Speter kp = bsearch(&k, keylist, nkeylist, sizeof(keylist[0]), v_key_cmp); 34119304Speter return (kp == NULL ? K_NOTUSED : kp->value); 34219304Speter} 34319304Speter 34419304Speter/* 34519304Speter * v_event_push -- 34619304Speter * Push events/keys onto the front of the buffer. 34719304Speter * 34819304Speter * There is a single input buffer in ex/vi. Characters are put onto the 34919304Speter * end of the buffer by the terminal input routines, and pushed onto the 35019304Speter * front of the buffer by various other functions in ex/vi. Each key has 35119304Speter * an associated flag value, which indicates if it has already been quoted, 35219304Speter * and if it is the result of a mapping or an abbreviation. 35319304Speter * 35419304Speter * PUBLIC: int v_event_push __P((SCR *, EVENT *, CHAR_T *, size_t, u_int)); 35519304Speter */ 35619304Speterint 357254225Speterv_event_push( 358254225Speter SCR *sp, 359254225Speter EVENT *p_evp, /* Push event. */ 360254225Speter CHAR_T *p_s, /* Push characters. */ 361254225Speter size_t nitems, /* Number of items to push. */ 362254225Speter u_int flags) /* CH_* flags. */ 36319304Speter{ 36419304Speter EVENT *evp; 36519304Speter GS *gp; 36619304Speter size_t total; 36719304Speter 36819304Speter /* If we have room, stuff the items into the buffer. */ 36919304Speter gp = sp->gp; 37019304Speter if (nitems <= gp->i_next || 37119304Speter (gp->i_event != NULL && gp->i_cnt == 0 && nitems <= gp->i_nelem)) { 37219304Speter if (gp->i_cnt != 0) 37319304Speter gp->i_next -= nitems; 37419304Speter goto copy; 37519304Speter } 37619304Speter 37719304Speter /* 37819304Speter * If there are currently items in the queue, shift them up, 37919304Speter * leaving some extra room. Get enough space plus a little 38019304Speter * extra. 38119304Speter */ 38219304Speter#define TERM_PUSH_SHIFT 30 38319304Speter total = gp->i_cnt + gp->i_next + nitems + TERM_PUSH_SHIFT; 38419304Speter if (total >= gp->i_nelem && v_event_grow(sp, MAX(total, 64))) 38519304Speter return (1); 38619304Speter if (gp->i_cnt) 387254225Speter BCOPY(gp->i_event + gp->i_next, 388254225Speter gp->i_event + TERM_PUSH_SHIFT + nitems, gp->i_cnt); 38919304Speter gp->i_next = TERM_PUSH_SHIFT; 39019304Speter 39119304Speter /* Put the new items into the queue. */ 39219304Spetercopy: gp->i_cnt += nitems; 39319304Speter for (evp = gp->i_event + gp->i_next; nitems--; ++evp) { 39419304Speter if (p_evp != NULL) 39519304Speter *evp = *p_evp++; 39619304Speter else { 39719304Speter evp->e_event = E_CHARACTER; 39819304Speter evp->e_c = *p_s++; 39919304Speter evp->e_value = KEY_VAL(sp, evp->e_c); 40019304Speter F_INIT(&evp->e_ch, flags); 40119304Speter } 40219304Speter } 40319304Speter return (0); 40419304Speter} 40519304Speter 40619304Speter/* 40719304Speter * v_event_append -- 40819304Speter * Append events onto the tail of the buffer. 40919304Speter */ 41019304Speterstatic int 411254225Speterv_event_append( 412254225Speter SCR *sp, 413254225Speter EVENT *argp) 41419304Speter{ 41519304Speter CHAR_T *s; /* Characters. */ 41619304Speter EVENT *evp; 41719304Speter GS *gp; 41819304Speter size_t nevents; /* Number of events. */ 41919304Speter 42019304Speter /* Grow the buffer as necessary. */ 42119304Speter nevents = argp->e_event == E_STRING ? argp->e_len : 1; 42219304Speter gp = sp->gp; 42319304Speter if (gp->i_event == NULL || 42419304Speter nevents > gp->i_nelem - (gp->i_next + gp->i_cnt)) 42519304Speter v_event_grow(sp, MAX(nevents, 64)); 42619304Speter evp = gp->i_event + gp->i_next + gp->i_cnt; 42719304Speter gp->i_cnt += nevents; 42819304Speter 42919304Speter /* Transform strings of characters into single events. */ 43019304Speter if (argp->e_event == E_STRING) 43119304Speter for (s = argp->e_csp; nevents--; ++evp) { 43219304Speter evp->e_event = E_CHARACTER; 43319304Speter evp->e_c = *s++; 43419304Speter evp->e_value = KEY_VAL(sp, evp->e_c); 43519304Speter evp->e_flags = 0; 43619304Speter } 43719304Speter else 43819304Speter *evp = *argp; 43919304Speter return (0); 44019304Speter} 44119304Speter 44219304Speter/* Remove events from the queue. */ 44319304Speter#define QREM(len) { \ 44419304Speter if ((gp->i_cnt -= len) == 0) \ 44519304Speter gp->i_next = 0; \ 44619304Speter else \ 44719304Speter gp->i_next += len; \ 44819304Speter} 44919304Speter 45019304Speter/* 45119304Speter * v_event_get -- 45219304Speter * Return the next event. 45319304Speter * 45419304Speter * !!! 45519304Speter * The flag EC_NODIGIT probably needs some explanation. First, the idea of 45619304Speter * mapping keys is that one or more keystrokes act like a function key. 45719304Speter * What's going on is that vi is reading a number, and the character following 45819304Speter * the number may or may not be mapped (EC_MAPCOMMAND). For example, if the 45919304Speter * user is entering the z command, a valid command is "z40+", and we don't want 46019304Speter * to map the '+', i.e. if '+' is mapped to "xxx", we don't want to change it 46119304Speter * into "z40xxx". However, if the user enters "35x", we want to put all of the 46219304Speter * characters through the mapping code. 46319304Speter * 46419304Speter * Historical practice is a bit muddled here. (Surprise!) It always permitted 46519304Speter * mapping digits as long as they weren't the first character of the map, e.g. 46619304Speter * ":map ^A1 xxx" was okay. It also permitted the mapping of the digits 1-9 46719304Speter * (the digit 0 was a special case as it doesn't indicate the start of a count) 46819304Speter * as the first character of the map, but then ignored those mappings. While 46919304Speter * it's probably stupid to map digits, vi isn't your mother. 47019304Speter * 47119304Speter * The way this works is that the EC_MAPNODIGIT causes term_key to return the 47219304Speter * end-of-digit without "looking" at the next character, i.e. leaving it as the 47319304Speter * user entered it. Presumably, the next term_key call will tell us how the 47419304Speter * user wants it handled. 47519304Speter * 47619304Speter * There is one more complication. Users might map keys to digits, and, as 47719304Speter * it's described above, the commands: 47819304Speter * 47919304Speter * :map g 1G 48019304Speter * d2g 48119304Speter * 48219304Speter * would return the keys "d2<end-of-digits>1G", when the user probably wanted 48319304Speter * "d21<end-of-digits>G". So, if a map starts off with a digit we continue as 48419304Speter * before, otherwise, we pretend we haven't mapped the character, and return 48519304Speter * <end-of-digits>. 48619304Speter * 48719304Speter * Now that that's out of the way, let's talk about Energizer Bunny macros. 48819304Speter * It's easy to create macros that expand to a loop, e.g. map x 3x. It's 48919304Speter * fairly easy to detect this example, because it's all internal to term_key. 49019304Speter * If we're expanding a macro and it gets big enough, at some point we can 49119304Speter * assume it's looping and kill it. The examples that are tough are the ones 49219304Speter * where the parser is involved, e.g. map x "ayyx"byy. We do an expansion 49319304Speter * on 'x', and get "ayyx"byy. We then return the first 4 characters, and then 49419304Speter * find the looping macro again. There is no way that we can detect this 49519304Speter * without doing a full parse of the command, because the character that might 49619304Speter * cause the loop (in this case 'x') may be a literal character, e.g. the map 49719304Speter * map x "ayy"xyy"byy is perfectly legal and won't cause a loop. 49819304Speter * 49919304Speter * Historic vi tried to detect looping macros by disallowing obvious cases in 50019304Speter * the map command, maps that that ended with the same letter as they started 50119304Speter * (which wrongly disallowed "map x 'x"), and detecting macros that expanded 50219304Speter * too many times before keys were returned to the command parser. It didn't 50319304Speter * get many (most?) of the tricky cases right, however, and it was certainly 50419304Speter * possible to create macros that ran forever. And, even if it did figure out 50519304Speter * what was going on, the user was usually tossed into ex mode. Finally, any 50619304Speter * changes made before vi realized that the macro was recursing were left in 50719304Speter * place. We recover gracefully, but the only recourse the user has in an 50819304Speter * infinite macro loop is to interrupt. 50919304Speter * 51019304Speter * !!! 51119304Speter * It is historic practice that mapping characters to themselves as the first 51219304Speter * part of the mapped string was legal, and did not cause infinite loops, i.e. 51319304Speter * ":map! { {^M^T" and ":map n nz." were known to work. The initial, matching 51419304Speter * characters were returned instead of being remapped. 51519304Speter * 51619304Speter * !!! 51719304Speter * It is also historic practice that the macro "map ] ]]^" caused a single ] 51819304Speter * keypress to behave as the command ]] (the ^ got the map past the vi check 51919304Speter * for "tail recursion"). Conversely, the mapping "map n nn^" went recursive. 52019304Speter * What happened was that, in the historic vi, maps were expanded as the keys 52119304Speter * were retrieved, but not all at once and not centrally. So, the keypress ] 52219304Speter * pushed ]]^ on the stack, and then the first ] from the stack was passed to 52319304Speter * the ]] command code. The ]] command then retrieved a key without entering 52419304Speter * the mapping code. This could bite us anytime a user has a map that depends 52519304Speter * on secondary keys NOT being mapped. I can't see any possible way to make 52619304Speter * this work in here without the complete abandonment of Rationality Itself. 52719304Speter * 52819304Speter * XXX 52919304Speter * The final issue is recovery. It would be possible to undo all of the work 53019304Speter * that was done by the macro if we entered a record into the log so that we 53119304Speter * knew when the macro started, and, in fact, this might be worth doing at some 53219304Speter * point. Given that this might make the log grow unacceptably (consider that 53319304Speter * cursor keys are done with maps), for now we leave any changes made in place. 53419304Speter * 53519304Speter * PUBLIC: int v_event_get __P((SCR *, EVENT *, int, u_int32_t)); 53619304Speter */ 53719304Speterint 538254225Speterv_event_get( 539254225Speter SCR *sp, 540254225Speter EVENT *argp, 541254225Speter int timeout, 542254225Speter u_int32_t flags) 54319304Speter{ 54419304Speter EVENT *evp, ev; 54519304Speter GS *gp; 54619304Speter SEQ *qp; 54719304Speter int init_nomap, ispartial, istimeout, remap_cnt; 54819304Speter 54919304Speter gp = sp->gp; 55019304Speter 55119304Speter /* If simply checking for interrupts, argp may be NULL. */ 55219304Speter if (argp == NULL) 55319304Speter argp = &ev; 55419304Speter 55519304Speterretry: istimeout = remap_cnt = 0; 55619304Speter 55719304Speter /* 55819304Speter * If the queue isn't empty and we're timing out for characters, 55919304Speter * return immediately. 56019304Speter */ 56119304Speter if (gp->i_cnt != 0 && LF_ISSET(EC_TIMEOUT)) 56219304Speter return (0); 56319304Speter 56419304Speter /* 56519304Speter * If the queue is empty, we're checking for interrupts, or we're 56619304Speter * timing out for characters, get more events. 56719304Speter */ 56819304Speter if (gp->i_cnt == 0 || LF_ISSET(EC_INTERRUPT | EC_TIMEOUT)) { 56919304Speter /* 57019304Speter * If we're reading new characters, check any scripting 57119304Speter * windows for input. 57219304Speter */ 57319304Speter if (F_ISSET(gp, G_SCRWIN) && sscr_input(sp)) 57419304Speter return (1); 57519304Speterloop: if (gp->scr_event(sp, argp, 57619304Speter LF_ISSET(EC_INTERRUPT | EC_QUOTED | EC_RAW), timeout)) 57719304Speter return (1); 57819304Speter switch (argp->e_event) { 57919304Speter case E_ERR: 58019304Speter case E_SIGHUP: 58119304Speter case E_SIGTERM: 58219304Speter /* 58319304Speter * Fatal conditions cause the file to be synced to 58419304Speter * disk immediately. 58519304Speter */ 58619304Speter v_sync(sp, RCV_ENDSESSION | RCV_PRESERVE | 58719304Speter (argp->e_event == E_SIGTERM ? 0: RCV_EMAIL)); 58819304Speter return (1); 58919304Speter case E_TIMEOUT: 59019304Speter istimeout = 1; 59119304Speter break; 59219304Speter case E_INTERRUPT: 59319304Speter /* Set the global interrupt flag. */ 59419304Speter F_SET(sp->gp, G_INTERRUPTED); 59519304Speter 59619304Speter /* 59719304Speter * If the caller was interested in interrupts, return 59819304Speter * immediately. 59919304Speter */ 60019304Speter if (LF_ISSET(EC_INTERRUPT)) 60119304Speter return (0); 60219304Speter goto append; 60319304Speter default: 60419304Speterappend: if (v_event_append(sp, argp)) 60519304Speter return (1); 60619304Speter break; 60719304Speter } 60819304Speter } 60919304Speter 61019304Speter /* 61119304Speter * If the caller was only interested in interrupts or timeouts, return 61219304Speter * immediately. (We may have gotten characters, and that's okay, they 61319304Speter * were queued up for later use.) 61419304Speter */ 61519304Speter if (LF_ISSET(EC_INTERRUPT | EC_TIMEOUT)) 61619304Speter return (0); 61719304Speter 61819304Speternewmap: evp = &gp->i_event[gp->i_next]; 61919304Speter 62019304Speter /* 62119304Speter * If the next event in the queue isn't a character event, return 62219304Speter * it, we're done. 62319304Speter */ 62419304Speter if (evp->e_event != E_CHARACTER) { 62519304Speter *argp = *evp; 62619304Speter QREM(1); 62719304Speter return (0); 62819304Speter } 62919304Speter 63019304Speter /* 63119304Speter * If the key isn't mappable because: 63219304Speter * 63319304Speter * + ... the timeout has expired 63419304Speter * + ... it's not a mappable key 63519304Speter * + ... neither the command or input map flags are set 63619304Speter * + ... there are no maps that can apply to it 63719304Speter * 63819304Speter * return it forthwith. 63919304Speter */ 64019304Speter if (istimeout || F_ISSET(&evp->e_ch, CH_NOMAP) || 64119304Speter !LF_ISSET(EC_MAPCOMMAND | EC_MAPINPUT) || 642254225Speter ((evp->e_c & ~MAX_BIT_SEQ) == 0 && 643254225Speter !bit_test(gp->seqb, evp->e_c))) 64419304Speter goto nomap; 64519304Speter 64619304Speter /* Search the map. */ 64719304Speter qp = seq_find(sp, NULL, evp, NULL, gp->i_cnt, 64819304Speter LF_ISSET(EC_MAPCOMMAND) ? SEQ_COMMAND : SEQ_INPUT, &ispartial); 64919304Speter 65019304Speter /* 65119304Speter * If get a partial match, get more characters and retry the map. 65219304Speter * If time out without further characters, return the characters 65319304Speter * unmapped. 65419304Speter * 65519304Speter * !!! 65619304Speter * <escape> characters are a problem. Cursor keys start with <escape> 65719304Speter * characters, so there's almost always a map in place that begins with 65819304Speter * an <escape> character. If we timeout <escape> keys in the same way 65919304Speter * that we timeout other keys, the user will get a noticeable pause as 66019304Speter * they enter <escape> to terminate input mode. If key timeout is set 66119304Speter * for a slow link, users will get an even longer pause. Nvi used to 66219304Speter * simply timeout <escape> characters at 1/10th of a second, but this 66319304Speter * loses over PPP links where the latency is greater than 100Ms. 66419304Speter */ 66519304Speter if (ispartial) { 66619304Speter if (O_ISSET(sp, O_TIMEOUT)) 66719304Speter timeout = (evp->e_value == K_ESCAPE ? 66819304Speter O_VAL(sp, O_ESCAPETIME) : 66919304Speter O_VAL(sp, O_KEYTIME)) * 100; 67019304Speter else 67119304Speter timeout = 0; 67219304Speter goto loop; 67319304Speter } 67419304Speter 67519304Speter /* If no map, return the character. */ 67619304Speter if (qp == NULL) { 677254225Speternomap: if (!ISDIGIT(evp->e_c) && LF_ISSET(EC_MAPNODIGIT)) 67819304Speter goto not_digit; 67919304Speter *argp = *evp; 68019304Speter QREM(1); 68119304Speter return (0); 68219304Speter } 68319304Speter 68419304Speter /* 68519304Speter * If looking for the end of a digit string, and the first character 68619304Speter * of the map is it, pretend we haven't seen the character. 68719304Speter */ 68819304Speter if (LF_ISSET(EC_MAPNODIGIT) && 689254225Speter qp->output != NULL && !ISDIGIT(qp->output[0])) { 69019304Speternot_digit: argp->e_c = CH_NOT_DIGIT; 69119304Speter argp->e_value = K_NOTUSED; 69219304Speter argp->e_event = E_CHARACTER; 69319304Speter F_INIT(&argp->e_ch, 0); 69419304Speter return (0); 69519304Speter } 69619304Speter 69719304Speter /* Find out if the initial segments are identical. */ 69819304Speter init_nomap = !e_memcmp(qp->output, &gp->i_event[gp->i_next], qp->ilen); 69919304Speter 70019304Speter /* Delete the mapped characters from the queue. */ 70119304Speter QREM(qp->ilen); 70219304Speter 70319304Speter /* If keys mapped to nothing, go get more. */ 70419304Speter if (qp->output == NULL) 70519304Speter goto retry; 70619304Speter 70719304Speter /* If remapping characters... */ 70819304Speter if (O_ISSET(sp, O_REMAP)) { 70919304Speter /* 71019304Speter * Periodically check for interrupts. Always check the first 71119304Speter * time through, because it's possible to set up a map that 71219304Speter * will return a character every time, but will expand to more, 71319304Speter * e.g. "map! a aaaa" will always return a 'a', but we'll never 71419304Speter * get anywhere useful. 71519304Speter */ 71619304Speter if ((++remap_cnt == 1 || remap_cnt % 10 == 0) && 71719304Speter (gp->scr_event(sp, &ev, 71819304Speter EC_INTERRUPT, 0) || ev.e_event == E_INTERRUPT)) { 71919304Speter F_SET(sp->gp, G_INTERRUPTED); 72019304Speter argp->e_event = E_INTERRUPT; 72119304Speter return (0); 72219304Speter } 72319304Speter 72419304Speter /* 72519304Speter * If an initial part of the characters mapped, they are not 72619304Speter * further remapped -- return the first one. Push the rest 72719304Speter * of the characters, or all of the characters if no initial 72819304Speter * part mapped, back on the queue. 72919304Speter */ 73019304Speter if (init_nomap) { 73119304Speter if (v_event_push(sp, NULL, qp->output + qp->ilen, 73219304Speter qp->olen - qp->ilen, CH_MAPPED)) 73319304Speter return (1); 73419304Speter if (v_event_push(sp, NULL, 73519304Speter qp->output, qp->ilen, CH_NOMAP | CH_MAPPED)) 73619304Speter return (1); 73719304Speter evp = &gp->i_event[gp->i_next]; 73819304Speter goto nomap; 73919304Speter } 74019304Speter if (v_event_push(sp, NULL, qp->output, qp->olen, CH_MAPPED)) 74119304Speter return (1); 74219304Speter goto newmap; 74319304Speter } 74419304Speter 74519304Speter /* Else, push the characters on the queue and return one. */ 74619304Speter if (v_event_push(sp, NULL, qp->output, qp->olen, CH_MAPPED | CH_NOMAP)) 74719304Speter return (1); 74819304Speter 74919304Speter goto nomap; 75019304Speter} 75119304Speter 75219304Speter/* 75319304Speter * v_sync -- 75419304Speter * Walk the screen lists, sync'ing files to their backup copies. 75519304Speter */ 75619304Speterstatic void 757254225Speterv_sync( 758254225Speter SCR *sp, 759254225Speter int flags) 76019304Speter{ 76119304Speter GS *gp; 76219304Speter 76319304Speter gp = sp->gp; 764254225Speter TAILQ_FOREACH(sp, gp->dq, q) 76519304Speter rcv_sync(sp, flags); 766254225Speter TAILQ_FOREACH(sp, gp->hq, q) 76719304Speter rcv_sync(sp, flags); 76819304Speter} 76919304Speter 77019304Speter/* 77119304Speter * v_event_err -- 77219304Speter * Unexpected event. 77319304Speter * 77419304Speter * PUBLIC: void v_event_err __P((SCR *, EVENT *)); 77519304Speter */ 77619304Spetervoid 777254225Speterv_event_err( 778254225Speter SCR *sp, 779254225Speter EVENT *evp) 78019304Speter{ 78119304Speter switch (evp->e_event) { 78219304Speter case E_CHARACTER: 78319304Speter msgq(sp, M_ERR, "276|Unexpected character event"); 78419304Speter break; 78519304Speter case E_EOF: 78619304Speter msgq(sp, M_ERR, "277|Unexpected end-of-file event"); 78719304Speter break; 78819304Speter case E_INTERRUPT: 78919304Speter msgq(sp, M_ERR, "279|Unexpected interrupt event"); 79019304Speter break; 79119304Speter case E_REPAINT: 79219304Speter msgq(sp, M_ERR, "281|Unexpected repaint event"); 79319304Speter break; 79419304Speter case E_STRING: 79519304Speter msgq(sp, M_ERR, "285|Unexpected string event"); 79619304Speter break; 79719304Speter case E_TIMEOUT: 79819304Speter msgq(sp, M_ERR, "286|Unexpected timeout event"); 79919304Speter break; 80019304Speter case E_WRESIZE: 80119304Speter msgq(sp, M_ERR, "316|Unexpected resize event"); 80219304Speter break; 80319304Speter 80419304Speter /* 80519304Speter * Theoretically, none of these can occur, as they're handled at the 80619304Speter * top editor level. 80719304Speter */ 80819304Speter case E_ERR: 80919304Speter case E_SIGHUP: 81019304Speter case E_SIGTERM: 81119304Speter default: 81219304Speter abort(); 81319304Speter } 81419304Speter 81519304Speter /* Free any allocated memory. */ 81619304Speter if (evp->e_asp != NULL) 81719304Speter free(evp->e_asp); 81819304Speter} 81919304Speter 82019304Speter/* 82119304Speter * v_event_flush -- 82219304Speter * Flush any flagged keys, returning if any keys were flushed. 82319304Speter * 82419304Speter * PUBLIC: int v_event_flush __P((SCR *, u_int)); 82519304Speter */ 82619304Speterint 827254225Speterv_event_flush( 828254225Speter SCR *sp, 829254225Speter u_int flags) 83019304Speter{ 83119304Speter GS *gp; 83219304Speter int rval; 83319304Speter 83419304Speter for (rval = 0, gp = sp->gp; gp->i_cnt != 0 && 83519304Speter F_ISSET(&gp->i_event[gp->i_next].e_ch, flags); rval = 1) 83619304Speter QREM(1); 83719304Speter return (rval); 83819304Speter} 83919304Speter 84019304Speter/* 84119304Speter * v_event_grow -- 84219304Speter * Grow the terminal queue. 84319304Speter */ 84419304Speterstatic int 845254225Speterv_event_grow( 846254225Speter SCR *sp, 847254225Speter int add) 84819304Speter{ 84919304Speter GS *gp; 85019304Speter size_t new_nelem, olen; 85119304Speter 85219304Speter gp = sp->gp; 85319304Speter new_nelem = gp->i_nelem + add; 85419304Speter olen = gp->i_nelem * sizeof(gp->i_event[0]); 855254225Speter BINC_RET(sp, EVENT, gp->i_event, olen, new_nelem * sizeof(gp->i_event[0])); 85619304Speter gp->i_nelem = olen / sizeof(gp->i_event[0]); 85719304Speter return (0); 85819304Speter} 85919304Speter 86019304Speter/* 86119304Speter * v_key_cmp -- 86219304Speter * Compare two keys for sorting. 86319304Speter */ 86419304Speterstatic int 865254225Speterv_key_cmp( 866254225Speter const void *ap, 867254225Speter const void *bp) 86819304Speter{ 86919304Speter return (((KEYLIST *)ap)->ch - ((KEYLIST *)bp)->ch); 87019304Speter} 871