2 * Copyright (c) 1991, 1993
3 * The Regents of the University of California. All rights reserved.
5 * %sccs.include.redist.c%
9 static char sccsid
[] = "$Id: key.c,v 8.32 1993/12/02 10:33:52 bostic Exp $ (Berkeley) $Date: 1993/12/02 10:33:52 $";
12 #include <sys/types.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
*));
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. */
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"},
67 * THIS REQUIRES THAT ALL SCREENS SHARE A SPECIAL KEY SET.
69 typedef struct _keylist
{
70 u_char value
; /* Special value. */
73 static KEYLIST keylist
[] = {
96 * Initialize the special key lookup table, and the special keys
97 * defined by the terminal's termcap entry.
103 extern CHNAME
const asciiname
[]; /* XXX */
109 char *sbp
, *t
, buf
[2 * 1024], sbuf
[128];
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.
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)) { \
129 * VEOF, VERASE, VKILL are required by POSIX 1003.1-1990,
130 * VWERASE is a 4.4BSD extension.
133 TERMSET(VEOF
, K_VEOF
);
136 TERMSET(VERASE
, K_VERASE
);
139 TERMSET(VKILL
, K_VKILL
);
142 TERMSET(VWERASE
, K_VWERASE
);
145 /* Sort the special key list. */
147 sizeof(keylist
) / sizeof(keylist
[0]), sizeof(keylist
[0]), keycmp
);
149 /* Initialize the fast lookup table. */
150 if ((gp
->special_key
=
151 calloc(MAX_FAST_KEY
+ 1, sizeof(u_char
))) == NULL
) {
152 msgq(sp
, M_SYSERR
, NULL
);
155 for (gp
->max_special
= 0, kp
= keylist
,
156 cnt
= sizeof(keylist
) / sizeof(keylist
[0]); cnt
--; ++kp
) {
157 if (gp
->max_special
< kp
->value
)
158 gp
->max_special
= kp
->value
;
159 if (kp
->ch
<= MAX_FAST_KEY
)
160 gp
->special_key
[kp
->ch
] = kp
->value
;
163 /* Set key sequences found in the termcap entry. */
164 switch (tgetent(buf
, O_STR(sp
, O_TERM
))) {
166 msgq(sp
, M_ERR
, "%s tgetent: %s.",
167 O_STR(sp
, O_TERM
), strerror(errno
));
170 msgq(sp
, M_ERR
, "%s: unknown terminal type.",
171 O_STR(sp
, O_TERM
), strerror(errno
));
175 for (tkp
= tklist
; tkp
->name
!= NULL
; ++tkp
) {
177 if ((t
= tgetstr(tkp
->ts
, &sbp
)) == NULL
)
179 if (seq_set(sp
, tkp
->name
, strlen(tkp
->name
), t
, strlen(t
),
180 tkp
->output
, strlen(tkp
->output
), SEQ_COMMAND
, 0))
188 * Push keys onto the front of a buffer.
190 * There is a single input buffer in ex/vi. Characters are read onto the
191 * end of the buffer by the terminal input routines, and pushed onto the
192 * front of the buffer various other functions in ex/vi. Each key has an
193 * associated flag value, which indicates if it has already been quoted,
194 * if it is the result of a mapping or an abbreviation.
197 term_push(sp
, s
, len
, cmap
, flags
)
199 CHAR_T
*s
; /* Characters. */
200 size_t len
; /* Number of chars. */
201 u_int cmap
; /* Map count. */
202 u_int flags
; /* CH_* flags. */
207 /* If we have room, stuff the keys into the buffer. */
209 if (len
<= tty
->next
|| tty
->cnt
== 0) {
213 memmove(tty
->ch
+ tty
->next
, s
, len
* sizeof(CHAR_T
));
214 memset(tty
->chf
+ tty
->next
, flags
, len
);
215 memset(tty
->cmap
+ tty
->next
, cmap
, len
);
219 /* Get enough space plus a little extra. */
220 nlen
= tty
->cnt
+ len
;
221 if (nlen
> tty
->len
) {
224 tty
->ch
, tty
->len
, nlen
* sizeof(tty
->ch
[0]));
226 tty
->chf
, tty
->len
, nlen
* sizeof(tty
->chf
[0]));
228 tty
->cmap
, tty
->len
, nlen
* sizeof(tty
->cmap
[0]));
232 * If there are currently characters in the queue, shift them up,
233 * leaving some extra room.
235 #define TERM_PUSH_SHIFT 30
237 memmove(tty
->ch
+ TERM_PUSH_SHIFT
+ len
,
238 tty
->ch
+ tty
->next
, tty
->cnt
* sizeof(tty
->ch
[0]));
239 memmove(tty
->chf
+ TERM_PUSH_SHIFT
+ len
,
240 tty
->chf
+ tty
->next
, tty
->cnt
* sizeof(tty
->chf
[0]));
241 memmove(tty
->cmap
+ TERM_PUSH_SHIFT
+ len
,
242 tty
->cmap
+ tty
->next
, tty
->cnt
* sizeof(tty
->cmap
[0]));
245 /* Put the new characters into the queue. */
246 tty
->next
= TERM_PUSH_SHIFT
;
248 memmove(tty
->ch
+ TERM_PUSH_SHIFT
, s
, len
* sizeof(tty
->ch
[0]));
249 memset(tty
->chf
+ TERM_PUSH_SHIFT
, flags
, len
* sizeof(tty
->chf
[0]));
250 memset(tty
->cmap
+ TERM_PUSH_SHIFT
, cmap
, len
* sizeof(tty
->cmap
[0]));
255 * Remove characters from the queue, simultaneously clearing the
256 * flag and map counts.
258 #define QREM_HEAD(q, len) { \
259 size_t __off = (q)->next; \
261 tty->chf[__off] = 0; \
262 tty->cmap[__off] = 0; \
264 memset(tty->chf + __off, 0, len); \
265 memset(tty->cmap + __off, 0, len); \
267 if (((q)->cnt -= len) == 0) \
272 #define QREM_TAIL(q, len) { \
273 size_t __off = (q)->next + (q)->cnt - 1; \
275 tty->chf[__off] = 0; \
276 tty->cmap[__off] = 0; \
278 memset(tty->chf + __off, 0, len); \
279 memset(tty->cmap + __off, 0, len); \
281 if (((q)->cnt -= len) == 0) \
290 * The flag TXT_MAPNODIGIT probably needs some explanation. First, the idea
291 * of mapping keys is that one or more keystrokes act like a function key.
292 * What's going on is that vi is reading a number, and the character following
293 * the number may or may not be mapped (TXT_MAPCOMMAND). For example, if the
294 * user is entering the z command, a valid command is "z40+", and we don't want
295 * to map the '+', i.e. if '+' is mapped to "xxx", we don't want to change it
296 * into "z40xxx". However, if the user enters "35x", we want to put all of the
297 * characters through the mapping code.
299 * Historical practice is a bit muddled here. (Surprise!) It always permitted
300 * mapping digits as long as they weren't the first character of the map, e.g.
301 * ":map ^A1 xxx" was okay. It also permitted the mapping of the digits 1-9
302 * (the digit 0 was a special case as it doesn't indicate the start of a count)
303 * as the first character of the map, but then ignored those mappings. While
304 * it's probably stupid to map digits, vi isn't your mother.
306 * The way this works is that the TXT_MAPNODIGIT causes term_key to return the
307 * end-of-digit without "looking" at the next character, i.e. leaving it as the
308 * user entered it. Presumably, the next term_key call will tell us how the
309 * user wants it handled.
311 * There is one more complication. Users might map keys to digits, and, as
312 * it's described above, the commands "map g 1G|d2g" would return the keys
313 * "d2<end-of-digits>1G", when the user probably wanted "d21<end-of-digits>G".
314 * So, if a map starts off with a digit we continue as before, otherwise, we
315 * pretend that we haven't mapped the character and return <end-of-digits>.
317 * Now that that's out of the way, let's talk about Energizer Bunny macros.
318 * It's easy to create macros that expand to a loop, e.g. map x 3x. It's
319 * fairly easy to detect this example, because it's all internal to term_key.
320 * If we're expanding a macro and it gets big enough, at some point we can
321 * assume it's looping and kill it. The examples that are tough are the ones
322 * where the parser is involved, e.g. map x "ayyx"byy. We do an expansion
323 * on 'x', and get "ayyx"byy. We then return the first 4 characters, and then
324 * find the looping macro again. There is no way that we can detect this
325 * without doing a full parse of the command, because the character that might
326 * cause the loop (in this case 'x') may be a literal character, e.g. the map
327 * map x "ayy"xyy"byy is perfectly legal and won't cause a loop.
329 * Historic vi tried to detect looping macros by disallowing obvious cases in
330 * the map command, maps that that ended with the same letter as they started
331 * (which wrongly disallowed "map x 'x"), and detecting macros that expanded
332 * too many times before keys were returned to the command parser. It didn't
333 * get many (most?) of the tricky cases right, however, and it was certainly
334 * possible to create macros that ran forever. And, even if it did figure out
335 * what was going on, the user was usually tossed into ex mode. Finally, any
336 * changes made before vi realized that the macro was recursing were left in
337 * place. This implementation counts how many times each input character has
338 * been mapped. If it reaches some arbitrary value, we flush all mapped keys
339 * and return an error.
342 * The final issue is recovery. It would be possible to undo all of the work
343 * that was done by the macro if we entered a record into the log so that we
344 * knew when the macro started, and, in fact, this might be worth doing at some
345 * point. Given that this might make the log grow unacceptably (consider that
346 * cursor keys are done with maps), for now we leave any changes made in place.
349 term_key(sp
, chp
, flags
)
360 int cmap
, ispartial
, nr
;
366 * If the queue is empty, read more keys in. Since no timeout is
367 * requested, s_key_read will either return an error or will read
368 * some number of characters.
370 loop
: if (tty
->cnt
== 0) {
371 if (term_read_grow(sp
, tty
))
373 if (rval
= sp
->s_key_read(sp
, &nr
, NULL
))
376 * If there's something on the mode line that we wanted
377 * the user to see, they just entered a character so we
378 * can presume they saw it.
380 if (F_ISSET(sp
, S_UPDATE_MODE
))
381 F_CLR(sp
, S_UPDATE_MODE
);
384 /* If the key is mappable and should be mapped, look it up. */
385 if (!(tty
->chf
[tty
->next
] & CH_NOMAP
) &&
386 LF_ISSET(TXT_MAPCOMMAND
| TXT_MAPINPUT
)) {
387 /* Set up timeout value. */
388 t
.tv_sec
= O_VAL(sp
, O_KEYTIME
) / 10;
389 t
.tv_usec
= (O_VAL(sp
, O_KEYTIME
) % 10) * 100000L;
391 /* Get the next key. */
392 newmap
: ch
= tty
->ch
[tty
->next
];
393 if (ch
< MAX_BIT_SEQ
&& !bit_test(gp
->seqb
, ch
))
396 /* Search the map. */
397 remap
: qp
= seq_find(sp
, NULL
, &tty
->ch
[tty
->next
], tty
->cnt
,
398 LF_ISSET(TXT_MAPCOMMAND
) ? SEQ_COMMAND
: SEQ_INPUT
,
402 * If get a partial match, read more characters and retry
403 * the map. If no characters read, return the characters
407 if (term_read_grow(sp
, tty
))
409 if (rval
= sp
->s_key_read(sp
, &nr
, &t
))
416 /* If no map, return the character. */
421 * If looking for the end of a digit string, and the first
422 * character of the map is it, pretend we haven't seen the
425 if (LF_ISSET(TXT_MAPNODIGIT
) && !isdigit(qp
->output
[0]))
429 * Only permit a character to be remapped a certain number
430 * of times before we figure that it's not going to finish.
432 if ((cmap
= tty
->cmap
[tty
->next
]) > MAX_MAP_COUNT
) {
433 term_map_flush(sp
, "Character remapped too many times");
437 /* Delete the mapped characters from the queue. */
438 QREM_HEAD(tty
, qp
->ilen
);
440 /* If remapping characters, push the character on the queue. */
441 if (O_ISSET(sp
, O_REMAP
)) {
442 if (term_push(sp
, qp
->output
, qp
->olen
, ++cmap
, 0))
447 /* Else, push the characters on the queue and return one. */
448 if (term_push(sp
, qp
->output
, qp
->olen
, 0, CH_NOMAP
))
452 nomap
: ch
= tty
->ch
[tty
->next
];
453 if (LF_ISSET(TXT_MAPNODIGIT
) && !isdigit(ch
)) {
454 not_digit_ch
: chp
->ch
= NOT_DIGIT_CH
;
460 /* Fill in the return information. */
462 chp
->flags
= tty
->chf
[tty
->next
];
463 chp
->value
= term_key_val(sp
, ch
);
465 /* Delete the character from the queue. */
469 * O_BEAUTIFY eliminates all control characters except
470 * escape, form-feed, newline and tab.
473 !LF_ISSET(TXT_BEAUTIFY
) || !O_ISSET(sp
, O_BEAUTIFY
) ||
474 chp
->value
== K_ESCAPE
|| chp
->value
== K_FORMFEED
||
475 chp
->value
== K_NL
|| chp
->value
== K_TAB
)
483 * Flush any abbreviated keys.
486 term_ab_flush(sp
, msg
)
493 if (!tty
->cnt
|| !(tty
->chf
[tty
->next
] & CH_ABBREVIATED
))
497 } while (tty
->cnt
&& tty
->chf
[tty
->next
] & CH_ABBREVIATED
);
498 msgq(sp
, M_ERR
, "%s: keys flushed.", msg
);
503 * Flush any mapped keys.
506 term_map_flush(sp
, msg
)
513 if (!tty
->cnt
|| !tty
->cmap
[tty
->next
])
517 } while (tty
->cnt
&& tty
->cmap
[tty
->next
]);
518 msgq(sp
, M_ERR
, "%s: keys flushed.", msg
);
524 * Get the next key, but require the user enter one.
527 term_user_key(sp
, chp
)
537 * Read any keys the user has waiting. Make the race condition
538 * as short as possible.
543 if (term_read_grow(sp
, tty
))
545 if (rval
= sp
->s_key_read(sp
, &nr
, &t
))
548 /* Read another key. */
549 if (term_read_grow(sp
, tty
))
551 if (rval
= sp
->s_key_read(sp
, &nr
, NULL
))
554 /* Fill in the return information. */
555 chp
->ch
= tty
->ch
[tty
->next
+ (tty
->cnt
- 1)];
557 chp
->value
= term_key_val(sp
, chp
->ch
);
565 * Fill in the key for a value.
568 term_key_ch(sp
, val
, chp
)
575 for (kp
= keylist
;; ++kp
)
576 if (kp
->value
== val
) {
585 * Fill in the value for a key. This routine is the backup
586 * for the term_key_val() macro.
589 __term_key_val(sp
, ch
)
596 kp
= bsearch(&k
, keylist
,
597 sizeof(keylist
) / sizeof(keylist
[0]), sizeof(keylist
[0]), keycmp
);
598 return (kp
== NULL
? 0 : kp
->value
);
602 * __term_read_grow --
603 * Grow the terminal queue. This routine is the backup for
604 * the term_read_grow() macro.
607 __term_read_grow(sp
, tty
)
611 size_t alen
, len
, nlen
;
613 nlen
= tty
->len
+ 64;
614 alen
= tty
->len
- (tty
->next
+ tty
->cnt
);
617 BINC(sp
, tty
->ch
, len
, nlen
* sizeof(tty
->ch
[0]));
618 memset(tty
->ch
+ tty
->next
+ tty
->cnt
, 0, alen
* sizeof(tty
->ch
[0]));
621 BINC(sp
, tty
->chf
, len
, nlen
* sizeof(tty
->chf
[0]));
622 memset(tty
->chf
+ tty
->next
+ tty
->cnt
, 0, alen
* sizeof(tty
->chf
[0]));
624 BINC(sp
, tty
->cmap
, tty
->len
, nlen
* sizeof(tty
->cmap
[0]));
626 tty
->next
+ tty
->cnt
, 0, alen
* sizeof(tty
->cmap
[0]));
634 return (((KEYLIST
*)ap
)->ch
- ((KEYLIST
*)bp
)->ch
);