update, move recovery information into docs
[nvi.git] / common / key.c
blobc69cfc2d2cbc405e9e2fb97ef5d5392973d64503
1 /*-
2 * Copyright (c) 1991, 1993
3 * The Regents of the University of California. All rights reserved.
5 * %sccs.include.redist.c%
6 */
8 #ifndef lint
9 static char sccsid[] = "$Id: key.c,v 8.37 1993/12/20 18:25:50 bostic Exp $ (Berkeley) $Date: 1993/12/20 18:25:50 $";
10 #endif /* not lint */
12 #include <sys/types.h>
13 #include <sys/time.h>
15 #include <ctype.h>
16 #include <curses.h>
17 #include <errno.h>
18 #include <stdlib.h>
19 #include <string.h>
20 #include <unistd.h>
22 #include "vi.h"
23 #include "seq.h"
25 static int keycmp __P((const void *, const void *));
28 * If we're reading less than 20 characters, up the size of the tty buffer.
29 * This shouldn't ever happen, other than the first time through, but it's
30 * possible if a map is large enough.
32 #define term_read_grow(sp, tty) \
33 (tty)->len - (tty)->cnt >= 20 ? 0 : __term_read_grow(sp, tty)
34 static int __term_read_grow __P((SCR *, IBUF *));
37 * XXX
38 * THIS REQUIRES THAT ALL SCREENS SHARE A TERMINAL TYPE.
40 typedef struct _tklist {
41 char *ts; /* Key's termcap string. */
42 char *output; /* Corresponding vi command. */
43 char *name; /* Name. */
44 } TKLIST;
45 static TKLIST const tklist[] = {
46 {"kA", "O", "insert line"},
47 {"kD", "x", "delete character"},
48 {"kd", "j", "cursor down"},
49 {"kE", "D", "delete to eol"},
50 {"kF", "\004", "scroll down"},
51 {"kH", "$", "go to eol"},
52 {"kh", "^", "go to sol"},
53 {"kI", "i", "insert at cursor"},
54 {"kL", "dd", "delete line"},
55 {"kl", "h", "cursor left"},
56 {"kN", "\006", "page down"},
57 {"kP", "\002", "page up"},
58 {"kR", "\025", "scroll up"},
59 {"kS", "dG", "delete to end of screen"},
60 {"kr", "l", "cursor right"},
61 {"ku", "k", "cursor up"},
62 {NULL},
66 * XXX
67 * THIS REQUIRES THAT ALL SCREENS SHARE A SPECIAL KEY SET.
69 typedef struct _keylist {
70 u_char value; /* Special value. */
71 CHAR_T ch; /* Key. */
72 } KEYLIST;
73 static KEYLIST keylist[] = {
74 {K_CARAT, '^'},
75 {K_CNTRLR, '\022'},
76 {K_CNTRLT, '\024'},
77 {K_CNTRLZ, '\032'},
78 {K_COLON, ':'},
79 {K_CR, '\r'},
80 {K_ESCAPE, '\033'},
81 {K_FORMFEED, '\f'},
82 {K_NL, '\n'},
83 {K_RIGHTBRACE, '}'},
84 {K_RIGHTPAREN, ')'},
85 {K_TAB, '\t'},
86 {K_VEOF, '\004'},
87 {K_VERASE, '\b'},
88 {K_VKILL, '\025'},
89 {K_VLNEXT, '\026'},
90 {K_VWERASE, '\027'},
91 {K_ZERO, '0'},
95 * term_init --
96 * Initialize the special key lookup table, and the special keys
97 * defined by the terminal's termcap entry.
99 int
100 term_init(sp)
101 SCR *sp;
103 extern CHNAME const asciiname[]; /* XXX */
104 GS *gp;
105 KEYLIST *kp;
106 TKLIST const *tkp;
107 cc_t ch;
108 int cnt;
109 char *sbp, *t, buf[2 * 1024], sbuf[128];
112 * XXX
113 * 8-bit, ASCII only, for now. Recompilation should get you
114 * any 8-bit character set, as long as nul isn't a character.
116 gp = sp->gp;
117 gp->cname = asciiname; /* XXX */
119 /* Set keys found in the termios structure. */
120 #define TERMSET(name, val) { \
121 if ((ch = gp->original_termios.c_cc[name]) != _POSIX_VDISABLE) \
122 for (kp = keylist;; ++kp) \
123 if (kp->value == (val)) { \
124 kp->ch = ch; \
125 break; \
129 * VEOF, VERASE, VKILL are required by POSIX 1003.1-1990,
130 * VWERASE is a 4.4BSD extension.
132 #ifdef VEOF
133 TERMSET(VEOF, K_VEOF);
134 #endif
135 #ifdef VERASE
136 TERMSET(VERASE, K_VERASE);
137 #endif
138 #ifdef VKILL
139 TERMSET(VKILL, K_VKILL);
140 #endif
141 #ifdef VWERASE
142 TERMSET(VWERASE, K_VWERASE);
143 #endif
145 /* Sort the special key list. */
146 qsort(keylist,
147 sizeof(keylist) / sizeof(keylist[0]), sizeof(keylist[0]), keycmp);
149 /* Initialize the fast lookup table. */
150 CALLOC_RET(sp,
151 gp->special_key, u_char *, MAX_FAST_KEY + 1, sizeof(u_char));
152 for (gp->max_special = 0, kp = keylist,
153 cnt = sizeof(keylist) / sizeof(keylist[0]); cnt--; ++kp) {
154 if (gp->max_special < kp->value)
155 gp->max_special = kp->value;
156 if (kp->ch <= MAX_FAST_KEY)
157 gp->special_key[kp->ch] = kp->value;
160 /* Set key sequences found in the termcap entry. */
161 switch (tgetent(buf, O_STR(sp, O_TERM))) {
162 case -1:
163 msgq(sp, M_ERR,
164 "tgetent: %s: %s.", O_STR(sp, O_TERM), strerror(errno));
165 return (0);
166 case 0:
167 msgq(sp, M_ERR,
168 "%s: unknown terminal type.", O_STR(sp, O_TERM));
169 return (0);
172 for (tkp = tklist; tkp->name != NULL; ++tkp) {
173 sbp = sbuf;
174 if ((t = tgetstr(tkp->ts, &sbp)) == NULL)
175 continue;
176 if (seq_set(sp, tkp->name, strlen(tkp->name), t, strlen(t),
177 tkp->output, strlen(tkp->output), SEQ_COMMAND, 0))
178 return (1);
180 return (0);
184 * term_push --
185 * Push keys onto the front of a buffer.
187 * There is a single input buffer in ex/vi. Characters are read onto the
188 * end of the buffer by the terminal input routines, and pushed onto the
189 * front of the buffer various other functions in ex/vi. Each key has an
190 * associated flag value, which indicates if it has already been quoted,
191 * if it is the result of a mapping or an abbreviation.
194 term_push(sp, s, len, cmap, flags)
195 SCR *sp;
196 CHAR_T *s; /* Characters. */
197 size_t len; /* Number of chars. */
198 u_int cmap; /* Map count. */
199 u_int flags; /* CH_* flags. */
201 IBUF *tty;
202 size_t nlen;
204 /* If we have room, stuff the keys into the buffer. */
205 tty = sp->gp->tty;
206 if (len <= tty->next ||
207 (tty->ch != NULL && tty->cnt == 0 && len <= tty->len)) {
208 if (tty->cnt != 0)
209 tty->next -= len;
210 tty->cnt += len;
211 memmove(tty->ch + tty->next, s, len * sizeof(CHAR_T));
212 memset(tty->chf + tty->next, flags, len);
213 memset(tty->cmap + tty->next, cmap, len);
214 return (0);
217 /* Get enough space plus a little extra. */
218 nlen = tty->cnt + len;
219 if (nlen > tty->len) {
220 size_t olen;
222 nlen += 64;
223 olen = tty->len;
224 BINC_RET(sp, tty->ch, olen, nlen * sizeof(tty->ch[0]));
225 olen = tty->len;
226 BINC_RET(sp, tty->chf, olen, nlen * sizeof(tty->chf[0]));
227 BINC_RET(sp, tty->cmap, tty->len, nlen * sizeof(tty->cmap[0]));
231 * If there are currently characters in the queue, shift them up,
232 * leaving some extra room.
234 #define TERM_PUSH_SHIFT 30
235 if (tty->cnt) {
236 memmove(tty->ch + TERM_PUSH_SHIFT + len,
237 tty->ch + tty->next, tty->cnt * sizeof(tty->ch[0]));
238 memmove(tty->chf + TERM_PUSH_SHIFT + len,
239 tty->chf + tty->next, tty->cnt * sizeof(tty->chf[0]));
240 memmove(tty->cmap + TERM_PUSH_SHIFT + len,
241 tty->cmap + tty->next, tty->cnt * sizeof(tty->cmap[0]));
244 /* Put the new characters into the queue. */
245 tty->next = TERM_PUSH_SHIFT;
246 tty->cnt += len;
247 memmove(tty->ch + TERM_PUSH_SHIFT, s, len * sizeof(tty->ch[0]));
248 memset(tty->chf + TERM_PUSH_SHIFT, flags, len * sizeof(tty->chf[0]));
249 memset(tty->cmap + TERM_PUSH_SHIFT, cmap, len * sizeof(tty->cmap[0]));
250 return (0);
254 * Remove characters from the queue, simultaneously clearing the
255 * flag and map counts.
257 #define QREM_HEAD(q, len) { \
258 size_t __off = (q)->next; \
259 if (len == 1) { \
260 tty->chf[__off] = 0; \
261 tty->cmap[__off] = 0; \
262 } else { \
263 memset(tty->chf + __off, 0, len); \
264 memset(tty->cmap + __off, 0, len); \
266 if (((q)->cnt -= len) == 0) \
267 (q)->next = 0; \
268 else \
269 (q)->next += len; \
271 #define QREM_TAIL(q, len) { \
272 size_t __off = (q)->next + (q)->cnt - 1; \
273 if (len == 1) { \
274 tty->chf[__off] = 0; \
275 tty->cmap[__off] = 0; \
276 } else { \
277 memset(tty->chf + __off, 0, len); \
278 memset(tty->cmap + __off, 0, len); \
280 if (((q)->cnt -= len) == 0) \
281 (q)->next = 0; \
285 * term_key --
286 * Get the next key.
288 * !!!
289 * The flag TXT_MAPNODIGIT probably needs some explanation. First, the idea
290 * of mapping keys is that one or more keystrokes act like a function key.
291 * What's going on is that vi is reading a number, and the character following
292 * the number may or may not be mapped (TXT_MAPCOMMAND). For example, if the
293 * user is entering the z command, a valid command is "z40+", and we don't want
294 * to map the '+', i.e. if '+' is mapped to "xxx", we don't want to change it
295 * into "z40xxx". However, if the user enters "35x", we want to put all of the
296 * characters through the mapping code.
298 * Historical practice is a bit muddled here. (Surprise!) It always permitted
299 * mapping digits as long as they weren't the first character of the map, e.g.
300 * ":map ^A1 xxx" was okay. It also permitted the mapping of the digits 1-9
301 * (the digit 0 was a special case as it doesn't indicate the start of a count)
302 * as the first character of the map, but then ignored those mappings. While
303 * it's probably stupid to map digits, vi isn't your mother.
305 * The way this works is that the TXT_MAPNODIGIT causes term_key to return the
306 * end-of-digit without "looking" at the next character, i.e. leaving it as the
307 * user entered it. Presumably, the next term_key call will tell us how the
308 * user wants it handled.
310 * There is one more complication. Users might map keys to digits, and, as
311 * it's described above, the commands "map g 1G|d2g" would return the keys
312 * "d2<end-of-digits>1G", when the user probably wanted "d21<end-of-digits>G".
313 * So, if a map starts off with a digit we continue as before, otherwise, we
314 * pretend that we haven't mapped the character and return <end-of-digits>.
316 * Now that that's out of the way, let's talk about Energizer Bunny macros.
317 * It's easy to create macros that expand to a loop, e.g. map x 3x. It's
318 * fairly easy to detect this example, because it's all internal to term_key.
319 * If we're expanding a macro and it gets big enough, at some point we can
320 * assume it's looping and kill it. The examples that are tough are the ones
321 * where the parser is involved, e.g. map x "ayyx"byy. We do an expansion
322 * on 'x', and get "ayyx"byy. We then return the first 4 characters, and then
323 * find the looping macro again. There is no way that we can detect this
324 * without doing a full parse of the command, because the character that might
325 * cause the loop (in this case 'x') may be a literal character, e.g. the map
326 * map x "ayy"xyy"byy is perfectly legal and won't cause a loop.
328 * Historic vi tried to detect looping macros by disallowing obvious cases in
329 * the map command, maps that that ended with the same letter as they started
330 * (which wrongly disallowed "map x 'x"), and detecting macros that expanded
331 * too many times before keys were returned to the command parser. It didn't
332 * get many (most?) of the tricky cases right, however, and it was certainly
333 * possible to create macros that ran forever. And, even if it did figure out
334 * what was going on, the user was usually tossed into ex mode. Finally, any
335 * changes made before vi realized that the macro was recursing were left in
336 * place. This implementation counts how many times each input character has
337 * been mapped. If it reaches some arbitrary value, we flush all mapped keys
338 * and return an error.
340 * XXX
341 * The final issue is recovery. It would be possible to undo all of the work
342 * that was done by the macro if we entered a record into the log so that we
343 * knew when the macro started, and, in fact, this might be worth doing at some
344 * point. Given that this might make the log grow unacceptably (consider that
345 * cursor keys are done with maps), for now we leave any changes made in place.
347 enum input
348 term_key(sp, chp, flags)
349 SCR *sp;
350 CH *chp;
351 u_int flags;
353 enum input rval;
354 struct timeval t, *tp;
355 CHAR_T ch;
356 GS *gp;
357 IBUF *tty;
358 SEQ *qp;
359 int cmap, ispartial, nr;
361 gp = sp->gp;
362 tty = gp->tty;
365 * If the queue is empty, read more keys in. Since no timeout is
366 * requested, s_key_read will either return an error or will read
367 * some number of characters.
369 loop: if (tty->cnt == 0) {
370 if (term_read_grow(sp, tty))
371 return (INP_ERR);
372 if (rval = sp->s_key_read(sp, &nr, NULL))
373 return (rval);
375 * If there's something on the mode line that we wanted
376 * the user to see, they just entered a character so we
377 * can presume they saw it.
379 if (F_ISSET(sp, S_UPDATE_MODE))
380 F_CLR(sp, S_UPDATE_MODE);
383 /* If the key is mappable and should be mapped, look it up. */
384 if (!(tty->chf[tty->next] & CH_NOMAP) &&
385 LF_ISSET(TXT_MAPCOMMAND | TXT_MAPINPUT)) {
386 /* Set up timeout value. */
387 if (O_ISSET(sp, O_TIMEOUT)) {
388 tp = &t;
389 t.tv_sec = O_VAL(sp, O_KEYTIME) / 10;
390 t.tv_usec = (O_VAL(sp, O_KEYTIME) % 10) * 100000L;
391 } else
392 tp = NULL;
394 /* Get the next key. */
395 newmap: ch = tty->ch[tty->next];
396 if (ch < MAX_BIT_SEQ && !bit_test(gp->seqb, ch))
397 goto nomap;
399 /* Search the map. */
400 remap: qp = seq_find(sp, NULL, &tty->ch[tty->next], tty->cnt,
401 LF_ISSET(TXT_MAPCOMMAND) ? SEQ_COMMAND : SEQ_INPUT,
402 &ispartial);
405 * If get a partial match, read more characters and retry
406 * the map. If no characters read, return the characters
407 * unmapped.
409 if (ispartial) {
410 if (term_read_grow(sp, tty))
411 return (INP_ERR);
412 if (rval = sp->s_key_read(sp, &nr, tp))
413 return (rval);
414 if (nr)
415 goto remap;
416 goto nomap;
419 /* If no map, return the character. */
420 if (qp == NULL)
421 goto nomap;
424 * If looking for the end of a digit string, and the first
425 * character of the map is it, pretend we haven't seen the
426 * character.
428 if (LF_ISSET(TXT_MAPNODIGIT) && !isdigit(qp->output[0]))
429 goto not_digit_ch;
432 * Only permit a character to be remapped a certain number
433 * of times before we figure that it's not going to finish.
435 if ((cmap = tty->cmap[tty->next]) > MAX_MAP_COUNT) {
436 term_map_flush(sp, "Character remapped too many times");
437 return (INP_ERR);
440 /* Delete the mapped characters from the queue. */
441 QREM_HEAD(tty, qp->ilen);
443 /* If remapping characters, push the character on the queue. */
444 if (O_ISSET(sp, O_REMAP)) {
445 if (term_push(sp, qp->output, qp->olen, ++cmap, 0))
446 return (INP_ERR);
447 goto newmap;
450 /* Else, push the characters on the queue and return one. */
451 if (term_push(sp, qp->output, qp->olen, 0, CH_NOMAP))
452 return (INP_ERR);
455 nomap: ch = tty->ch[tty->next];
456 if (LF_ISSET(TXT_MAPNODIGIT) && !isdigit(ch)) {
457 not_digit_ch: chp->ch = NOT_DIGIT_CH;
458 chp->value = 0;
459 chp->flags = 0;
460 return (INP_OK);
463 /* Fill in the return information. */
464 chp->ch = ch;
465 chp->flags = tty->chf[tty->next];
466 chp->value = term_key_val(sp, ch);
468 /* Delete the character from the queue. */
469 QREM_HEAD(tty, 1);
472 * O_BEAUTIFY eliminates all control characters except
473 * escape, form-feed, newline and tab.
475 if (isprint(ch) ||
476 !LF_ISSET(TXT_BEAUTIFY) || !O_ISSET(sp, O_BEAUTIFY) ||
477 chp->value == K_ESCAPE || chp->value == K_FORMFEED ||
478 chp->value == K_NL || chp->value == K_TAB)
479 return (INP_OK);
481 goto loop;
485 * term_ab_flush --
486 * Flush any abbreviated keys.
488 void
489 term_ab_flush(sp, msg)
490 SCR *sp;
491 char *msg;
493 IBUF *tty;
495 tty = sp->gp->tty;
496 if (!tty->cnt || !(tty->chf[tty->next] & CH_ABBREVIATED))
497 return;
498 do {
499 QREM_HEAD(tty, 1);
500 } while (tty->cnt && tty->chf[tty->next] & CH_ABBREVIATED);
501 msgq(sp, M_ERR, "%s: keys flushed.", msg);
505 * term_map_flush --
506 * Flush any mapped keys.
508 void
509 term_map_flush(sp, msg)
510 SCR *sp;
511 char *msg;
513 IBUF *tty;
515 tty = sp->gp->tty;
516 if (!tty->cnt || !tty->cmap[tty->next])
517 return;
518 do {
519 QREM_HEAD(tty, 1);
520 } while (tty->cnt && tty->cmap[tty->next]);
521 msgq(sp, M_ERR, "%s: keys flushed.", msg);
526 * term_user_key --
527 * Get the next key, but require the user enter one.
529 enum input
530 term_user_key(sp, chp)
531 SCR *sp;
532 CH *chp;
534 enum input rval;
535 struct timeval t;
536 IBUF *tty;
537 int nr;
540 * Read any keys the user has waiting. Make the race
541 * condition as short as possible.
543 t.tv_sec = 0;
544 t.tv_usec = 0;
545 for (tty = sp->gp->tty;;) {
546 if (term_read_grow(sp, tty))
547 return (INP_ERR);
548 if (rval = sp->s_key_read(sp, &nr, &t))
549 return (rval);
550 if (nr == 0)
551 break;
554 /* Read another key. */
555 if (rval = sp->s_key_read(sp, &nr, NULL))
556 return (rval);
558 /* Fill in the return information. */
559 chp->ch = tty->ch[tty->next + (tty->cnt - 1)];
560 chp->flags = 0;
561 chp->value = term_key_val(sp, chp->ch);
563 QREM_TAIL(tty, 1);
564 return (INP_OK);
568 * term_key_ch --
569 * Fill in the key for a value.
572 term_key_ch(sp, val, chp)
573 SCR *sp;
574 int val;
575 CHAR_T *chp;
577 KEYLIST *kp;
579 for (kp = keylist;; ++kp)
580 if (kp->value == val) {
581 *chp = kp->ch;
582 return (0);
584 return (1);
588 * __term_key_val --
589 * Fill in the value for a key. This routine is the backup
590 * for the term_key_val() macro.
593 __term_key_val(sp, ch)
594 SCR *sp;
595 ARG_CHAR_T ch;
597 KEYLIST k, *kp;
599 k.ch = ch;
600 kp = bsearch(&k, keylist,
601 sizeof(keylist) / sizeof(keylist[0]), sizeof(keylist[0]), keycmp);
602 return (kp == NULL ? 0 : kp->value);
606 * __term_read_grow --
607 * Grow the terminal queue. This routine is the backup for
608 * the term_read_grow() macro.
610 static int
611 __term_read_grow(sp, tty)
612 SCR *sp;
613 IBUF *tty;
615 size_t alen, len, nlen;
617 nlen = tty->len + 64;
618 alen = tty->len - (tty->next + tty->cnt);
620 len = tty->len;
621 BINC_RET(sp, tty->ch, len, nlen * sizeof(tty->ch[0]));
622 memset(tty->ch + tty->next + tty->cnt, 0, alen * sizeof(tty->ch[0]));
624 len = tty->len;
625 BINC_RET(sp, tty->chf, len, nlen * sizeof(tty->chf[0]));
626 memset(tty->chf + tty->next + tty->cnt, 0, alen * sizeof(tty->chf[0]));
628 BINC_RET(sp, tty->cmap, tty->len, nlen * sizeof(tty->cmap[0]));
629 memset(tty->cmap +
630 tty->next + tty->cnt, 0, alen * sizeof(tty->cmap[0]));
631 return (0);
634 static int
635 keycmp(ap, bp)
636 const void *ap, *bp;
638 return (((KEYLIST *)ap)->ch - ((KEYLIST *)bp)->ch);