blob: 23611a118edafdabcc8861477df4260c577f1b63 [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001/* vi:set ts=8 sts=4 sw=4:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * getchar.c
12 *
13 * functions related with getting a character from the user/mapping/redo/...
14 *
15 * manipulations with redo buffer and stuff buffer
16 * mappings and abbreviations
17 */
18
19#include "vim.h"
20
21/*
22 * These buffers are used for storing:
23 * - stuffed characters: A command that is translated into another command.
24 * - redo characters: will redo the last change.
25 * - recorded chracters: for the "q" command.
26 *
27 * The bytes are stored like in the typeahead buffer:
28 * - K_SPECIAL introduces a special key (two more bytes follow). A literal
29 * K_SPECIAL is stored as K_SPECIAL KS_SPECIAL KE_FILLER.
30 * - CSI introduces a GUI termcap code (also when gui.in_use is FALSE,
31 * otherwise switching the GUI on would make mappings invalid).
32 * A literal CSI is stored as CSI KS_EXTRA KE_CSI.
33 * These translations are also done on multi-byte characters!
34 *
35 * Escaping CSI bytes is done by the system-specific input functions, called
36 * by ui_inchar().
37 * Escaping K_SPECIAL is done by inchar().
38 * Un-escaping is done by vgetc().
39 */
40
41#define MINIMAL_SIZE 20 /* minimal size for b_str */
42
43static struct buffheader redobuff = {{NULL, {NUL}}, NULL, 0, 0};
44static struct buffheader old_redobuff = {{NULL, {NUL}}, NULL, 0, 0};
45#if defined(FEAT_AUTOCMD) || defined(FEAT_EVAL) || defined(PROTO)
46static struct buffheader save_redobuff = {{NULL, {NUL}}, NULL, 0, 0};
47static struct buffheader save_old_redobuff = {{NULL, {NUL}}, NULL, 0, 0};
48#endif
49static struct buffheader recordbuff = {{NULL, {NUL}}, NULL, 0, 0};
50
51static int typeahead_char = 0; /* typeahead char that's not flushed */
52
53/*
54 * when block_redo is TRUE redo buffer will not be changed
55 * used by edit() to repeat insertions and 'V' command for redoing
56 */
57static int block_redo = FALSE;
58
59/*
60 * Make a hash value for a mapping.
61 * "mode" is the lower 4 bits of the State for the mapping.
62 * "c1" is the first character of the "lhs".
63 * Returns a value between 0 and 255, index in maphash.
64 * Put Normal/Visual mode mappings mostly separately from Insert/Cmdline mode.
65 */
Bram Moolenaar371d5402006-03-20 21:47:49 +000066#define MAP_HASH(mode, c1) (((mode) & (NORMAL + VISUAL + SELECTMODE + OP_PENDING)) ? (c1) : ((c1) ^ 0x80))
Bram Moolenaar071d4272004-06-13 20:20:40 +000067
68/*
69 * Each mapping is put in one of the 256 hash lists, to speed up finding it.
70 */
71static mapblock_T *(maphash[256]);
72static int maphash_valid = FALSE;
73
74/*
75 * List used for abbreviations.
76 */
77static mapblock_T *first_abbr = NULL; /* first entry in abbrlist */
78
Bram Moolenaarcf8e7d12006-12-05 20:43:17 +000079static int KeyNoremap = 0; /* remapping flags */
Bram Moolenaar071d4272004-06-13 20:20:40 +000080
81/*
82 * variables used by vgetorpeek() and flush_buffers()
83 *
84 * typebuf.tb_buf[] contains all characters that are not consumed yet.
85 * typebuf.tb_buf[typebuf.tb_off] is the first valid character.
86 * typebuf.tb_buf[typebuf.tb_off + typebuf.tb_len - 1] is the last valid char.
87 * typebuf.tb_buf[typebuf.tb_off + typebuf.tb_len] must be NUL.
88 * The head of the buffer may contain the result of mappings, abbreviations
89 * and @a commands. The length of this part is typebuf.tb_maplen.
90 * typebuf.tb_silent is the part where <silent> applies.
91 * After the head are characters that come from the terminal.
92 * typebuf.tb_no_abbr_cnt is the number of characters in typebuf.tb_buf that
93 * should not be considered for abbreviations.
94 * Some parts of typebuf.tb_buf may not be mapped. These parts are remembered
95 * in typebuf.tb_noremap[], which is the same length as typebuf.tb_buf and
96 * contains RM_NONE for the characters that are not to be remapped.
97 * typebuf.tb_noremap[typebuf.tb_off] is the first valid flag.
98 * (typebuf has been put in globals.h, because check_termcode() needs it).
99 */
100#define RM_YES 0 /* tb_noremap: remap */
101#define RM_NONE 1 /* tb_noremap: don't remap */
102#define RM_SCRIPT 2 /* tb_noremap: remap local script mappings */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000103#define RM_ABBR 4 /* tb_noremap: don't remap, do abbrev. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000104
105/* typebuf.tb_buf has three parts: room in front (for result of mappings), the
106 * middle for typeahead and room for new characters (which needs to be 3 *
107 * MAXMAPLEN) for the Amiga).
108 */
109#define TYPELEN_INIT (5 * (MAXMAPLEN + 3))
110static char_u typebuf_init[TYPELEN_INIT]; /* initial typebuf.tb_buf */
111static char_u noremapbuf_init[TYPELEN_INIT]; /* initial typebuf.tb_noremap */
112
113static int last_recorded_len = 0; /* number of last recorded chars */
114
115static char_u *get_buffcont __ARGS((struct buffheader *, int));
116static void add_buff __ARGS((struct buffheader *, char_u *, long n));
117static void add_num_buff __ARGS((struct buffheader *, long));
118static void add_char_buff __ARGS((struct buffheader *, int));
119static int read_stuff __ARGS((int advance));
120static void start_stuff __ARGS((void));
121static int read_redo __ARGS((int, int));
122static void copy_redo __ARGS((int));
123static void init_typebuf __ARGS((void));
124static void gotchars __ARGS((char_u *, int));
125static void may_sync_undo __ARGS((void));
126static void closescript __ARGS((void));
127static int vgetorpeek __ARGS((int));
128static void map_free __ARGS((mapblock_T **));
129static void validate_maphash __ARGS((void));
130static void showmap __ARGS((mapblock_T *mp, int local));
Bram Moolenaarc1e37902006-04-18 21:55:01 +0000131#ifdef FEAT_EVAL
132static char_u *eval_map_expr __ARGS((char_u *str));
133#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134
135/*
136 * Free and clear a buffer.
137 */
138 void
139free_buff(buf)
140 struct buffheader *buf;
141{
142 struct buffblock *p, *np;
143
144 for (p = buf->bh_first.b_next; p != NULL; p = np)
145 {
146 np = p->b_next;
147 vim_free(p);
148 }
149 buf->bh_first.b_next = NULL;
150}
151
152/*
153 * Return the contents of a buffer as a single string.
154 * K_SPECIAL and CSI in the returned string are escaped.
155 */
156 static char_u *
157get_buffcont(buffer, dozero)
158 struct buffheader *buffer;
159 int dozero; /* count == zero is not an error */
160{
161 long_u count = 0;
162 char_u *p = NULL;
163 char_u *p2;
164 char_u *str;
165 struct buffblock *bp;
166
167 /* compute the total length of the string */
168 for (bp = buffer->bh_first.b_next; bp != NULL; bp = bp->b_next)
169 count += (long_u)STRLEN(bp->b_str);
170
171 if ((count || dozero) && (p = lalloc(count + 1, TRUE)) != NULL)
172 {
173 p2 = p;
174 for (bp = buffer->bh_first.b_next; bp != NULL; bp = bp->b_next)
175 for (str = bp->b_str; *str; )
176 *p2++ = *str++;
177 *p2 = NUL;
178 }
179 return (p);
180}
181
182/*
183 * Return the contents of the record buffer as a single string
184 * and clear the record buffer.
185 * K_SPECIAL and CSI in the returned string are escaped.
186 */
187 char_u *
188get_recorded()
189{
190 char_u *p;
191 size_t len;
192
193 p = get_buffcont(&recordbuff, TRUE);
194 free_buff(&recordbuff);
195
196 /*
197 * Remove the characters that were added the last time, these must be the
198 * (possibly mapped) characters that stopped the recording.
199 */
200 len = STRLEN(p);
201 if ((int)len >= last_recorded_len)
202 {
203 len -= last_recorded_len;
204 p[len] = NUL;
205 }
206
207 /*
208 * When stopping recording from Insert mode with CTRL-O q, also remove the
209 * CTRL-O.
210 */
211 if (len > 0 && restart_edit != 0 && p[len - 1] == Ctrl_O)
212 p[len - 1] = NUL;
213
214 return (p);
215}
216
217/*
218 * Return the contents of the redo buffer as a single string.
219 * K_SPECIAL and CSI in the returned string are escaped.
220 */
221 char_u *
222get_inserted()
223{
224 return(get_buffcont(&redobuff, FALSE));
225}
226
227/*
Bram Moolenaar4e86cba2007-05-06 11:56:32 +0000228 * Add string "s" after the current block of buffer "buf".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000229 * K_SPECIAL and CSI should have been escaped already.
230 */
231 static void
232add_buff(buf, s, slen)
233 struct buffheader *buf;
234 char_u *s;
235 long slen; /* length of "s" or -1 */
236{
237 struct buffblock *p;
238 long_u len;
239
240 if (slen < 0)
241 slen = (long)STRLEN(s);
242 if (slen == 0) /* don't add empty strings */
243 return;
244
245 if (buf->bh_first.b_next == NULL) /* first add to list */
246 {
247 buf->bh_space = 0;
248 buf->bh_curr = &(buf->bh_first);
249 }
250 else if (buf->bh_curr == NULL) /* buffer has already been read */
251 {
252 EMSG(_("E222: Add to read buffer"));
253 return;
254 }
255 else if (buf->bh_index != 0)
256 STRCPY(buf->bh_first.b_next->b_str,
257 buf->bh_first.b_next->b_str + buf->bh_index);
258 buf->bh_index = 0;
259
260 if (buf->bh_space >= (int)slen)
261 {
262 len = (long_u)STRLEN(buf->bh_curr->b_str);
Bram Moolenaarb6356332005-07-18 21:40:44 +0000263 vim_strncpy(buf->bh_curr->b_str + len, s, (size_t)slen);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264 buf->bh_space -= slen;
265 }
266 else
267 {
268 if (slen < MINIMAL_SIZE)
269 len = MINIMAL_SIZE;
270 else
271 len = slen;
272 p = (struct buffblock *)lalloc((long_u)(sizeof(struct buffblock) + len),
273 TRUE);
274 if (p == NULL)
275 return; /* no space, just forget it */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000276 buf->bh_space = (int)(len - slen);
Bram Moolenaarb6356332005-07-18 21:40:44 +0000277 vim_strncpy(p->b_str, s, (size_t)slen);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000278
279 p->b_next = buf->bh_curr->b_next;
280 buf->bh_curr->b_next = p;
281 buf->bh_curr = p;
282 }
283 return;
284}
285
286/*
287 * Add number "n" to buffer "buf".
288 */
289 static void
290add_num_buff(buf, n)
291 struct buffheader *buf;
292 long n;
293{
294 char_u number[32];
295
296 sprintf((char *)number, "%ld", n);
297 add_buff(buf, number, -1L);
298}
299
300/*
301 * Add character 'c' to buffer "buf".
302 * Translates special keys, NUL, CSI, K_SPECIAL and multibyte characters.
303 */
304 static void
305add_char_buff(buf, c)
306 struct buffheader *buf;
307 int c;
308{
309#ifdef FEAT_MBYTE
310 char_u bytes[MB_MAXBYTES + 1];
311 int len;
312 int i;
313#endif
314 char_u temp[4];
315
316#ifdef FEAT_MBYTE
317 if (IS_SPECIAL(c))
318 len = 1;
319 else
320 len = (*mb_char2bytes)(c, bytes);
321 for (i = 0; i < len; ++i)
322 {
323 if (!IS_SPECIAL(c))
324 c = bytes[i];
325#endif
326
327 if (IS_SPECIAL(c) || c == K_SPECIAL || c == NUL)
328 {
329 /* translate special key code into three byte sequence */
330 temp[0] = K_SPECIAL;
331 temp[1] = K_SECOND(c);
332 temp[2] = K_THIRD(c);
333 temp[3] = NUL;
334 }
335#ifdef FEAT_GUI
336 else if (c == CSI)
337 {
338 /* Translate a CSI to a CSI - KS_EXTRA - KE_CSI sequence */
339 temp[0] = CSI;
340 temp[1] = KS_EXTRA;
341 temp[2] = (int)KE_CSI;
342 temp[3] = NUL;
343 }
344#endif
345 else
346 {
347 temp[0] = c;
348 temp[1] = NUL;
349 }
350 add_buff(buf, temp, -1L);
351#ifdef FEAT_MBYTE
352 }
353#endif
354}
355
356/*
357 * Get one byte from the stuff buffer.
358 * If advance == TRUE go to the next char.
359 * No translation is done K_SPECIAL and CSI are escaped.
360 */
361 static int
362read_stuff(advance)
363 int advance;
364{
365 char_u c;
366 struct buffblock *curr;
367
368 if (stuffbuff.bh_first.b_next == NULL) /* buffer is empty */
369 return NUL;
370
371 curr = stuffbuff.bh_first.b_next;
372 c = curr->b_str[stuffbuff.bh_index];
373
374 if (advance)
375 {
376 if (curr->b_str[++stuffbuff.bh_index] == NUL)
377 {
378 stuffbuff.bh_first.b_next = curr->b_next;
379 vim_free(curr);
380 stuffbuff.bh_index = 0;
381 }
382 }
383 return c;
384}
385
386/*
387 * Prepare the stuff buffer for reading (if it contains something).
388 */
389 static void
390start_stuff()
391{
392 if (stuffbuff.bh_first.b_next != NULL)
393 {
394 stuffbuff.bh_curr = &(stuffbuff.bh_first);
395 stuffbuff.bh_space = 0;
396 }
397}
398
399/*
400 * Return TRUE if the stuff buffer is empty.
401 */
402 int
403stuff_empty()
404{
405 return (stuffbuff.bh_first.b_next == NULL);
406}
407
408/*
409 * Set a typeahead character that won't be flushed.
410 */
411 void
412typeahead_noflush(c)
413 int c;
414{
415 typeahead_char = c;
416}
417
418/*
419 * Remove the contents of the stuff buffer and the mapped characters in the
420 * typeahead buffer (used in case of an error). If 'typeahead' is true,
421 * flush all typeahead characters (used when interrupted by a CTRL-C).
422 */
423 void
424flush_buffers(typeahead)
425 int typeahead;
426{
427 init_typebuf();
428
429 start_stuff();
430 while (read_stuff(TRUE) != NUL)
431 ;
432
433 if (typeahead) /* remove all typeahead */
434 {
435 /*
436 * We have to get all characters, because we may delete the first part
437 * of an escape sequence.
438 * In an xterm we get one char at a time and we have to get them all.
439 */
440 while (inchar(typebuf.tb_buf, typebuf.tb_buflen - 1, 10L,
441 typebuf.tb_change_cnt) != 0)
442 ;
443 typebuf.tb_off = MAXMAPLEN;
444 typebuf.tb_len = 0;
445 }
446 else /* remove mapped characters only */
447 {
448 typebuf.tb_off += typebuf.tb_maplen;
449 typebuf.tb_len -= typebuf.tb_maplen;
450 }
451 typebuf.tb_maplen = 0;
452 typebuf.tb_silent = 0;
453 cmd_silent = FALSE;
454 typebuf.tb_no_abbr_cnt = 0;
455}
456
457/*
458 * The previous contents of the redo buffer is kept in old_redobuffer.
459 * This is used for the CTRL-O <.> command in insert mode.
460 */
461 void
462ResetRedobuff()
463{
464 if (!block_redo)
465 {
466 free_buff(&old_redobuff);
467 old_redobuff = redobuff;
468 redobuff.bh_first.b_next = NULL;
469 }
470}
471
472#if defined(FEAT_AUTOCMD) || defined(FEAT_EVAL) || defined(PROTO)
473/*
474 * Save redobuff and old_redobuff to save_redobuff and save_old_redobuff.
475 * Used before executing autocommands and user functions.
476 */
477static int save_level = 0;
478
479 void
480saveRedobuff()
481{
482 char_u *s;
483
484 if (save_level++ == 0)
485 {
486 save_redobuff = redobuff;
487 redobuff.bh_first.b_next = NULL;
488 save_old_redobuff = old_redobuff;
489 old_redobuff.bh_first.b_next = NULL;
490
491 /* Make a copy, so that ":normal ." in a function works. */
492 s = get_buffcont(&save_redobuff, FALSE);
493 if (s != NULL)
494 {
495 add_buff(&redobuff, s, -1L);
496 vim_free(s);
497 }
498 }
499}
500
501/*
502 * Restore redobuff and old_redobuff from save_redobuff and save_old_redobuff.
503 * Used after executing autocommands and user functions.
504 */
505 void
506restoreRedobuff()
507{
508 if (--save_level == 0)
509 {
510 free_buff(&redobuff);
511 redobuff = save_redobuff;
512 free_buff(&old_redobuff);
513 old_redobuff = save_old_redobuff;
514 }
515}
516#endif
517
518/*
519 * Append "s" to the redo buffer.
520 * K_SPECIAL and CSI should already have been escaped.
521 */
522 void
523AppendToRedobuff(s)
524 char_u *s;
525{
526 if (!block_redo)
527 add_buff(&redobuff, s, -1L);
528}
529
530/*
531 * Append to Redo buffer literally, escaping special characters with CTRL-V.
532 * K_SPECIAL and CSI are escaped as well.
533 */
534 void
Bram Moolenaarebefac62005-12-28 22:39:57 +0000535AppendToRedobuffLit(str, len)
536 char_u *str;
537 int len; /* length of "str" or -1 for up to the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538{
Bram Moolenaarebefac62005-12-28 22:39:57 +0000539 char_u *s = str;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540 int c;
541 char_u *start;
542
543 if (block_redo)
544 return;
545
Bram Moolenaarebefac62005-12-28 22:39:57 +0000546 while (len < 0 ? *s != NUL : s - str < len)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547 {
548 /* Put a string of normal characters in the redo buffer (that's
549 * faster). */
550 start = s;
551 while (*s >= ' '
552#ifndef EBCDIC
553 && *s < DEL /* EBCDIC: all chars above space are normal */
554#endif
Bram Moolenaarebefac62005-12-28 22:39:57 +0000555 && (len < 0 || s - str < len))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556 ++s;
557
558 /* Don't put '0' or '^' as last character, just in case a CTRL-D is
559 * typed next. */
560 if (*s == NUL && (s[-1] == '0' || s[-1] == '^'))
561 --s;
562 if (s > start)
563 add_buff(&redobuff, start, (long)(s - start));
564
Bram Moolenaarebefac62005-12-28 22:39:57 +0000565 if (*s == NUL || (len >= 0 && s - str >= len))
566 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567
Bram Moolenaarebefac62005-12-28 22:39:57 +0000568 /* Handle a special or multibyte character. */
569#ifdef FEAT_MBYTE
570 if (has_mbyte)
571 /* Handle composing chars separately. */
572 c = mb_cptr2char_adv(&s);
573 else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000574#endif
Bram Moolenaarebefac62005-12-28 22:39:57 +0000575 c = *s++;
576 if (c < ' ' || c == DEL || (*s == NUL && (c == '0' || c == '^')))
577 add_char_buff(&redobuff, Ctrl_V);
578
579 /* CTRL-V '0' must be inserted as CTRL-V 048 (EBCDIC: xf0) */
580 if (*s == NUL && c == '0')
581#ifdef EBCDIC
582 add_buff(&redobuff, (char_u *)"xf0", 3L);
583#else
584 add_buff(&redobuff, (char_u *)"048", 3L);
585#endif
586 else
587 add_char_buff(&redobuff, c);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588 }
589}
590
591/*
592 * Append a character to the redo buffer.
593 * Translates special keys, NUL, CSI, K_SPECIAL and multibyte characters.
594 */
595 void
596AppendCharToRedobuff(c)
597 int c;
598{
599 if (!block_redo)
600 add_char_buff(&redobuff, c);
601}
602
603/*
604 * Append a number to the redo buffer.
605 */
606 void
607AppendNumberToRedobuff(n)
608 long n;
609{
610 if (!block_redo)
611 add_num_buff(&redobuff, n);
612}
613
614/*
615 * Append string "s" to the stuff buffer.
616 * CSI and K_SPECIAL must already have been escaped.
617 */
618 void
619stuffReadbuff(s)
620 char_u *s;
621{
622 add_buff(&stuffbuff, s, -1L);
623}
624
625 void
626stuffReadbuffLen(s, len)
627 char_u *s;
628 long len;
629{
630 add_buff(&stuffbuff, s, len);
631}
632
633#if defined(FEAT_EVAL) || defined(PROTO)
634/*
635 * Stuff "s" into the stuff buffer, leaving special key codes unmodified and
636 * escaping other K_SPECIAL and CSI bytes.
637 */
638 void
639stuffReadbuffSpec(s)
640 char_u *s;
641{
642 while (*s != NUL)
643 {
644 if (*s == K_SPECIAL && s[1] != NUL && s[2] != NUL)
645 {
646 /* Insert special key literally. */
647 stuffReadbuffLen(s, 3L);
648 s += 3;
649 }
650 else
651#ifdef FEAT_MBYTE
652 stuffcharReadbuff(mb_ptr2char_adv(&s));
653#else
654 stuffcharReadbuff(*s++);
655#endif
656 }
657}
658#endif
659
660/*
661 * Append a character to the stuff buffer.
662 * Translates special keys, NUL, CSI, K_SPECIAL and multibyte characters.
663 */
664 void
665stuffcharReadbuff(c)
666 int c;
667{
668 add_char_buff(&stuffbuff, c);
669}
670
671/*
672 * Append a number to the stuff buffer.
673 */
674 void
675stuffnumReadbuff(n)
676 long n;
677{
678 add_num_buff(&stuffbuff, n);
679}
680
681/*
682 * Read a character from the redo buffer. Translates K_SPECIAL, CSI and
683 * multibyte characters.
684 * The redo buffer is left as it is.
685 * if init is TRUE, prepare for redo, return FAIL if nothing to redo, OK
686 * otherwise
687 * if old is TRUE, use old_redobuff instead of redobuff
688 */
689 static int
690read_redo(init, old_redo)
691 int init;
692 int old_redo;
693{
694 static struct buffblock *bp;
695 static char_u *p;
696 int c;
697#ifdef FEAT_MBYTE
698 int n;
699 char_u buf[MB_MAXBYTES];
700 int i;
701#endif
702
703 if (init)
704 {
705 if (old_redo)
706 bp = old_redobuff.bh_first.b_next;
707 else
708 bp = redobuff.bh_first.b_next;
709 if (bp == NULL)
710 return FAIL;
711 p = bp->b_str;
712 return OK;
713 }
714 if ((c = *p) != NUL)
715 {
716 /* Reverse the conversion done by add_char_buff() */
717#ifdef FEAT_MBYTE
718 /* For a multi-byte character get all the bytes and return the
719 * converted character. */
720 if (has_mbyte && (c != K_SPECIAL || p[1] == KS_SPECIAL))
721 n = MB_BYTE2LEN_CHECK(c);
722 else
723 n = 1;
724 for (i = 0; ; ++i)
725#endif
726 {
727 if (c == K_SPECIAL) /* special key or escaped K_SPECIAL */
728 {
729 c = TO_SPECIAL(p[1], p[2]);
730 p += 2;
731 }
732#ifdef FEAT_GUI
733 if (c == CSI) /* escaped CSI */
734 p += 2;
735#endif
736 if (*++p == NUL && bp->b_next != NULL)
737 {
738 bp = bp->b_next;
739 p = bp->b_str;
740 }
741#ifdef FEAT_MBYTE
742 buf[i] = c;
743 if (i == n - 1) /* last byte of a character */
744 {
745 if (n != 1)
746 c = (*mb_ptr2char)(buf);
747 break;
748 }
749 c = *p;
750 if (c == NUL) /* cannot happen? */
751 break;
752#endif
753 }
754 }
755
756 return c;
757}
758
759/*
760 * Copy the rest of the redo buffer into the stuff buffer (in a slow way).
761 * If old_redo is TRUE, use old_redobuff instead of redobuff.
762 * The escaped K_SPECIAL and CSI are copied without translation.
763 */
764 static void
765copy_redo(old_redo)
766 int old_redo;
767{
768 int c;
769
770 while ((c = read_redo(FALSE, old_redo)) != NUL)
771 stuffcharReadbuff(c);
772}
773
774/*
775 * Stuff the redo buffer into the stuffbuff.
776 * Insert the redo count into the command.
777 * If "old_redo" is TRUE, the last but one command is repeated
778 * instead of the last command (inserting text). This is used for
779 * CTRL-O <.> in insert mode
780 *
781 * return FAIL for failure, OK otherwise
782 */
783 int
784start_redo(count, old_redo)
785 long count;
786 int old_redo;
787{
788 int c;
789
790 /* init the pointers; return if nothing to redo */
791 if (read_redo(TRUE, old_redo) == FAIL)
792 return FAIL;
793
794 c = read_redo(FALSE, old_redo);
795
796 /* copy the buffer name, if present */
797 if (c == '"')
798 {
799 add_buff(&stuffbuff, (char_u *)"\"", 1L);
800 c = read_redo(FALSE, old_redo);
801
802 /* if a numbered buffer is used, increment the number */
803 if (c >= '1' && c < '9')
804 ++c;
805 add_char_buff(&stuffbuff, c);
806 c = read_redo(FALSE, old_redo);
807 }
808
809#ifdef FEAT_VISUAL
810 if (c == 'v') /* redo Visual */
811 {
812 VIsual = curwin->w_cursor;
813 VIsual_active = TRUE;
814 VIsual_select = FALSE;
815 VIsual_reselect = TRUE;
816 redo_VIsual_busy = TRUE;
817 c = read_redo(FALSE, old_redo);
818 }
819#endif
820
821 /* try to enter the count (in place of a previous count) */
822 if (count)
823 {
824 while (VIM_ISDIGIT(c)) /* skip "old" count */
825 c = read_redo(FALSE, old_redo);
826 add_num_buff(&stuffbuff, count);
827 }
828
829 /* copy from the redo buffer into the stuff buffer */
830 add_char_buff(&stuffbuff, c);
831 copy_redo(old_redo);
832 return OK;
833}
834
835/*
836 * Repeat the last insert (R, o, O, a, A, i or I command) by stuffing
837 * the redo buffer into the stuffbuff.
838 * return FAIL for failure, OK otherwise
839 */
840 int
841start_redo_ins()
842{
843 int c;
844
845 if (read_redo(TRUE, FALSE) == FAIL)
846 return FAIL;
847 start_stuff();
848
849 /* skip the count and the command character */
850 while ((c = read_redo(FALSE, FALSE)) != NUL)
851 {
852 if (vim_strchr((char_u *)"AaIiRrOo", c) != NULL)
853 {
854 if (c == 'O' || c == 'o')
855 stuffReadbuff(NL_STR);
856 break;
857 }
858 }
859
860 /* copy the typed text from the redo buffer into the stuff buffer */
861 copy_redo(FALSE);
862 block_redo = TRUE;
863 return OK;
864}
865
866 void
867stop_redo_ins()
868{
869 block_redo = FALSE;
870}
871
872/*
873 * Initialize typebuf.tb_buf to point to typebuf_init.
874 * alloc() cannot be used here: In out-of-memory situations it would
875 * be impossible to type anything.
876 */
877 static void
878init_typebuf()
879{
880 if (typebuf.tb_buf == NULL)
881 {
882 typebuf.tb_buf = typebuf_init;
883 typebuf.tb_noremap = noremapbuf_init;
884 typebuf.tb_buflen = TYPELEN_INIT;
885 typebuf.tb_len = 0;
886 typebuf.tb_off = 0;
887 typebuf.tb_change_cnt = 1;
888 }
889}
890
891/*
892 * insert a string in position 'offset' in the typeahead buffer (for "@r"
893 * and ":normal" command, vgetorpeek() and check_termcode())
894 *
895 * If noremap is REMAP_YES, new string can be mapped again.
896 * If noremap is REMAP_NONE, new string cannot be mapped again.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000897 * If noremap is REMAP_SKIP, fist char of new string cannot be mapped again,
898 * but abbreviations are allowed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899 * If noremap is REMAP_SCRIPT, new string cannot be mapped again, except for
900 * script-local mappings.
901 * If noremap is > 0, that many characters of the new string cannot be mapped.
902 *
903 * If nottyped is TRUE, the string does not return KeyTyped (don't use when
904 * offset is non-zero!).
905 *
906 * If silent is TRUE, cmd_silent is set when the characters are obtained.
907 *
908 * return FAIL for failure, OK otherwise
909 */
910 int
911ins_typebuf(str, noremap, offset, nottyped, silent)
912 char_u *str;
913 int noremap;
914 int offset;
915 int nottyped;
916 int silent;
917{
918 char_u *s1, *s2;
919 int newlen;
920 int addlen;
921 int i;
922 int newoff;
923 int val;
924 int nrm;
925
926 init_typebuf();
927 if (++typebuf.tb_change_cnt == 0)
928 typebuf.tb_change_cnt = 1;
929
930 addlen = (int)STRLEN(str);
Bram Moolenaar4e86cba2007-05-06 11:56:32 +0000931
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932 /*
933 * Easy case: there is room in front of typebuf.tb_buf[typebuf.tb_off]
934 */
935 if (offset == 0 && addlen <= typebuf.tb_off)
936 {
937 typebuf.tb_off -= addlen;
938 mch_memmove(typebuf.tb_buf + typebuf.tb_off, str, (size_t)addlen);
939 }
Bram Moolenaar4e86cba2007-05-06 11:56:32 +0000940
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941 /*
Bram Moolenaar4e86cba2007-05-06 11:56:32 +0000942 * Need to allocate a new buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000943 * In typebuf.tb_buf there must always be room for 3 * MAXMAPLEN + 4
944 * characters. We add some extra room to avoid having to allocate too
945 * often.
946 */
947 else
948 {
949 newoff = MAXMAPLEN + 4;
950 newlen = typebuf.tb_len + addlen + newoff + 4 * (MAXMAPLEN + 4);
951 if (newlen < 0) /* string is getting too long */
952 {
953 EMSG(_(e_toocompl)); /* also calls flush_buffers */
954 setcursor();
955 return FAIL;
956 }
957 s1 = alloc(newlen);
958 if (s1 == NULL) /* out of memory */
959 return FAIL;
960 s2 = alloc(newlen);
961 if (s2 == NULL) /* out of memory */
962 {
963 vim_free(s1);
964 return FAIL;
965 }
966 typebuf.tb_buflen = newlen;
967
968 /* copy the old chars, before the insertion point */
969 mch_memmove(s1 + newoff, typebuf.tb_buf + typebuf.tb_off,
970 (size_t)offset);
971 /* copy the new chars */
972 mch_memmove(s1 + newoff + offset, str, (size_t)addlen);
973 /* copy the old chars, after the insertion point, including the NUL at
974 * the end */
975 mch_memmove(s1 + newoff + offset + addlen,
976 typebuf.tb_buf + typebuf.tb_off + offset,
977 (size_t)(typebuf.tb_len - offset + 1));
978 if (typebuf.tb_buf != typebuf_init)
979 vim_free(typebuf.tb_buf);
980 typebuf.tb_buf = s1;
981
982 mch_memmove(s2 + newoff, typebuf.tb_noremap + typebuf.tb_off,
983 (size_t)offset);
984 mch_memmove(s2 + newoff + offset + addlen,
985 typebuf.tb_noremap + typebuf.tb_off + offset,
986 (size_t)(typebuf.tb_len - offset));
987 if (typebuf.tb_noremap != noremapbuf_init)
988 vim_free(typebuf.tb_noremap);
989 typebuf.tb_noremap = s2;
990
991 typebuf.tb_off = newoff;
992 }
993 typebuf.tb_len += addlen;
994
995 /* If noremap == REMAP_SCRIPT: do remap script-local mappings. */
996 if (noremap == REMAP_SCRIPT)
997 val = RM_SCRIPT;
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000998 else if (noremap == REMAP_SKIP)
999 val = RM_ABBR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 else
1001 val = RM_NONE;
1002
1003 /*
1004 * Adjust typebuf.tb_noremap[] for the new characters:
1005 * If noremap == REMAP_NONE or REMAP_SCRIPT: new characters are
1006 * (sometimes) not remappable
1007 * If noremap == REMAP_YES: all the new characters are mappable
1008 * If noremap > 0: "noremap" characters are not remappable, the rest
1009 * mappable
1010 */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001011 if (noremap == REMAP_SKIP)
1012 nrm = 1;
1013 else if (noremap < 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014 nrm = addlen;
1015 else
1016 nrm = noremap;
1017 for (i = 0; i < addlen; ++i)
1018 typebuf.tb_noremap[typebuf.tb_off + i + offset] =
1019 (--nrm >= 0) ? val : RM_YES;
1020
1021 /* tb_maplen and tb_silent only remember the length of mapped and/or
1022 * silent mappings at the start of the buffer, assuming that a mapped
1023 * sequence doesn't result in typed characters. */
1024 if (nottyped || typebuf.tb_maplen > offset)
1025 typebuf.tb_maplen += addlen;
1026 if (silent || typebuf.tb_silent > offset)
1027 {
1028 typebuf.tb_silent += addlen;
1029 cmd_silent = TRUE;
1030 }
1031 if (typebuf.tb_no_abbr_cnt && offset == 0) /* and not used for abbrev.s */
1032 typebuf.tb_no_abbr_cnt += addlen;
1033
1034 return OK;
1035}
1036
1037/*
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001038 * Put character "c" back into the typeahead buffer.
1039 * Can be used for a character obtained by vgetc() that needs to be put back.
Bram Moolenaarcf8e7d12006-12-05 20:43:17 +00001040 * Uses cmd_silent, KeyTyped and KeyNoremap to restore the flags belonging to
1041 * the char.
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001042 */
1043 void
1044ins_char_typebuf(c)
1045 int c;
1046{
1047#ifdef FEAT_MBYTE
1048 char_u buf[MB_MAXBYTES];
1049#else
1050 char_u buf[4];
1051#endif
1052 if (IS_SPECIAL(c))
1053 {
1054 buf[0] = K_SPECIAL;
1055 buf[1] = K_SECOND(c);
1056 buf[2] = K_THIRD(c);
1057 buf[3] = NUL;
1058 }
1059 else
1060 {
1061#ifdef FEAT_MBYTE
1062 buf[(*mb_char2bytes)(c, buf)] = NUL;
1063#else
1064 buf[0] = c;
1065 buf[1] = NUL;
1066#endif
1067 }
Bram Moolenaarcf8e7d12006-12-05 20:43:17 +00001068 (void)ins_typebuf(buf, KeyNoremap, 0, !KeyTyped, cmd_silent);
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001069}
1070
1071/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 * Return TRUE if the typeahead buffer was changed (while waiting for a
Bram Moolenaar4a85b412006-04-23 22:40:29 +00001073 * character to arrive). Happens when a message was received from a client or
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00001074 * from feedkeys().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 * But check in a more generic way to avoid trouble: When "typebuf.tb_buf"
1076 * changed it was reallocated and the old pointer can no longer be used.
1077 * Or "typebuf.tb_off" may have been changed and we would overwrite characters
1078 * that was just added.
1079 */
1080 int
1081typebuf_changed(tb_change_cnt)
1082 int tb_change_cnt; /* old value of typebuf.tb_change_cnt */
1083{
1084 return (tb_change_cnt != 0 && (typebuf.tb_change_cnt != tb_change_cnt
Bram Moolenaar4a85b412006-04-23 22:40:29 +00001085#if defined(FEAT_CLIENTSERVER) || defined(FEAT_EVAL)
1086 || typebuf_was_filled
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087#endif
1088 ));
1089}
1090
1091/*
1092 * Return TRUE if there are no characters in the typeahead buffer that have
1093 * not been typed (result from a mapping or come from ":normal").
1094 */
1095 int
1096typebuf_typed()
1097{
1098 return typebuf.tb_maplen == 0;
1099}
1100
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001101#if defined(FEAT_VISUAL) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102/*
1103 * Return the number of characters that are mapped (or not typed).
1104 */
1105 int
1106typebuf_maplen()
1107{
1108 return typebuf.tb_maplen;
1109}
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001110#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111
1112/*
1113 * remove "len" characters from typebuf.tb_buf[typebuf.tb_off + offset]
1114 */
1115 void
1116del_typebuf(len, offset)
1117 int len;
1118 int offset;
1119{
1120 int i;
1121
1122 if (len == 0)
1123 return; /* nothing to do */
1124
1125 typebuf.tb_len -= len;
1126
1127 /*
1128 * Easy case: Just increase typebuf.tb_off.
1129 */
1130 if (offset == 0 && typebuf.tb_buflen - (typebuf.tb_off + len)
1131 >= 3 * MAXMAPLEN + 3)
1132 typebuf.tb_off += len;
1133 /*
1134 * Have to move the characters in typebuf.tb_buf[] and typebuf.tb_noremap[]
1135 */
1136 else
1137 {
1138 i = typebuf.tb_off + offset;
1139 /*
1140 * Leave some extra room at the end to avoid reallocation.
1141 */
1142 if (typebuf.tb_off > MAXMAPLEN)
1143 {
1144 mch_memmove(typebuf.tb_buf + MAXMAPLEN,
1145 typebuf.tb_buf + typebuf.tb_off, (size_t)offset);
1146 mch_memmove(typebuf.tb_noremap + MAXMAPLEN,
1147 typebuf.tb_noremap + typebuf.tb_off, (size_t)offset);
1148 typebuf.tb_off = MAXMAPLEN;
1149 }
1150 /* adjust typebuf.tb_buf (include the NUL at the end) */
1151 mch_memmove(typebuf.tb_buf + typebuf.tb_off + offset,
1152 typebuf.tb_buf + i + len,
1153 (size_t)(typebuf.tb_len - offset + 1));
1154 /* adjust typebuf.tb_noremap[] */
1155 mch_memmove(typebuf.tb_noremap + typebuf.tb_off + offset,
1156 typebuf.tb_noremap + i + len,
1157 (size_t)(typebuf.tb_len - offset));
1158 }
1159
1160 if (typebuf.tb_maplen > offset) /* adjust tb_maplen */
1161 {
1162 if (typebuf.tb_maplen < offset + len)
1163 typebuf.tb_maplen = offset;
1164 else
1165 typebuf.tb_maplen -= len;
1166 }
1167 if (typebuf.tb_silent > offset) /* adjust tb_silent */
1168 {
1169 if (typebuf.tb_silent < offset + len)
1170 typebuf.tb_silent = offset;
1171 else
1172 typebuf.tb_silent -= len;
1173 }
1174 if (typebuf.tb_no_abbr_cnt > offset) /* adjust tb_no_abbr_cnt */
1175 {
1176 if (typebuf.tb_no_abbr_cnt < offset + len)
1177 typebuf.tb_no_abbr_cnt = offset;
1178 else
1179 typebuf.tb_no_abbr_cnt -= len;
1180 }
1181
Bram Moolenaar4a85b412006-04-23 22:40:29 +00001182#if defined(FEAT_CLIENTSERVER) || defined(FEAT_EVAL)
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00001183 /* Reset the flag that text received from a client or from feedkeys()
Bram Moolenaar4a85b412006-04-23 22:40:29 +00001184 * was inserted in the typeahead buffer. */
1185 typebuf_was_filled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186#endif
1187 if (++typebuf.tb_change_cnt == 0)
1188 typebuf.tb_change_cnt = 1;
1189}
1190
1191/*
1192 * Write typed characters to script file.
1193 * If recording is on put the character in the recordbuffer.
1194 */
1195 static void
Bram Moolenaar4e86cba2007-05-06 11:56:32 +00001196gotchars(chars, len)
1197 char_u *chars;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198 int len;
1199{
Bram Moolenaar4e86cba2007-05-06 11:56:32 +00001200 char_u *s = chars;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201 int c;
1202 char_u buf[2];
Bram Moolenaar4e86cba2007-05-06 11:56:32 +00001203 int todo = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204
1205 /* remember how many chars were last recorded */
1206 if (Recording)
1207 last_recorded_len += len;
1208
1209 buf[1] = NUL;
Bram Moolenaar4e86cba2007-05-06 11:56:32 +00001210 while (todo--)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 {
1212 /* Handle one byte at a time; no translation to be done. */
1213 c = *s++;
1214 updatescript(c);
1215
1216 if (Recording)
1217 {
1218 buf[0] = c;
1219 add_buff(&recordbuff, buf, 1L);
1220 }
1221 }
1222 may_sync_undo();
1223
1224#ifdef FEAT_EVAL
1225 /* output "debug mode" message next time in debug mode */
1226 debug_did_msg = FALSE;
1227#endif
1228
1229 /* Since characters have been typed, consider the following to be in
1230 * another mapping. Search string will be kept in history. */
1231 ++maptick;
1232}
1233
1234/*
1235 * Sync undo. Called when typed characters are obtained from the typeahead
1236 * buffer, or when a menu is used.
1237 * Do not sync:
1238 * - In Insert mode, unless cursor key has been used.
1239 * - While reading a script file.
1240 * - When no_u_sync is non-zero.
1241 */
1242 static void
1243may_sync_undo()
1244{
1245 if ((!(State & (INSERT + CMDLINE)) || arrow_used)
Bram Moolenaar779b74b2006-04-10 14:55:34 +00001246 && scriptin[curscript] == NULL)
1247 u_sync(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248}
1249
1250/*
1251 * Make "typebuf" empty and allocate new buffers.
1252 * Returns FAIL when out of memory.
1253 */
1254 int
1255alloc_typebuf()
1256{
1257 typebuf.tb_buf = alloc(TYPELEN_INIT);
1258 typebuf.tb_noremap = alloc(TYPELEN_INIT);
1259 if (typebuf.tb_buf == NULL || typebuf.tb_noremap == NULL)
1260 {
1261 free_typebuf();
1262 return FAIL;
1263 }
1264 typebuf.tb_buflen = TYPELEN_INIT;
1265 typebuf.tb_off = 0;
1266 typebuf.tb_len = 0;
1267 typebuf.tb_maplen = 0;
1268 typebuf.tb_silent = 0;
1269 typebuf.tb_no_abbr_cnt = 0;
1270 if (++typebuf.tb_change_cnt == 0)
1271 typebuf.tb_change_cnt = 1;
1272 return OK;
1273}
1274
1275/*
1276 * Free the buffers of "typebuf".
1277 */
1278 void
1279free_typebuf()
1280{
1281 vim_free(typebuf.tb_buf);
1282 vim_free(typebuf.tb_noremap);
1283}
1284
1285/*
1286 * When doing ":so! file", the current typeahead needs to be saved, and
1287 * restored when "file" has been read completely.
1288 */
1289static typebuf_T saved_typebuf[NSCRIPT];
1290
1291 int
1292save_typebuf()
1293{
1294 init_typebuf();
1295 saved_typebuf[curscript] = typebuf;
1296 /* If out of memory: restore typebuf and close file. */
1297 if (alloc_typebuf() == FAIL)
1298 {
1299 closescript();
1300 return FAIL;
1301 }
1302 return OK;
1303}
1304
1305#if defined(FEAT_EVAL) || defined(FEAT_EX_EXTRA) || defined(PROTO)
1306
1307/*
1308 * Save all three kinds of typeahead, so that the user must type at a prompt.
1309 */
1310 void
1311save_typeahead(tp)
1312 tasave_T *tp;
1313{
1314 tp->save_typebuf = typebuf;
1315 tp->typebuf_valid = (alloc_typebuf() == OK);
1316 if (!tp->typebuf_valid)
1317 typebuf = tp->save_typebuf;
1318
1319 tp->save_stuffbuff = stuffbuff;
1320 stuffbuff.bh_first.b_next = NULL;
1321# ifdef USE_INPUT_BUF
1322 tp->save_inputbuf = get_input_buf();
1323# endif
1324}
1325
1326/*
1327 * Restore the typeahead to what it was before calling save_typeahead().
1328 * The allocated memory is freed, can only be called once!
1329 */
1330 void
1331restore_typeahead(tp)
1332 tasave_T *tp;
1333{
1334 if (tp->typebuf_valid)
1335 {
1336 free_typebuf();
1337 typebuf = tp->save_typebuf;
1338 }
1339
1340 free_buff(&stuffbuff);
1341 stuffbuff = tp->save_stuffbuff;
1342# ifdef USE_INPUT_BUF
1343 set_input_buf(tp->save_inputbuf);
1344# endif
1345}
1346#endif
1347
1348/*
1349 * Open a new script file for the ":source!" command.
1350 */
1351 void
1352openscript(name, directly)
1353 char_u *name;
1354 int directly; /* when TRUE execute directly */
1355{
1356 if (curscript + 1 == NSCRIPT)
1357 {
1358 EMSG(_(e_nesting));
1359 return;
1360 }
1361
1362 if (scriptin[curscript] != NULL) /* already reading script */
1363 ++curscript;
1364 /* use NameBuff for expanded name */
1365 expand_env(name, NameBuff, MAXPATHL);
1366 if ((scriptin[curscript] = mch_fopen((char *)NameBuff, READBIN)) == NULL)
1367 {
1368 EMSG2(_(e_notopen), name);
1369 if (curscript)
1370 --curscript;
1371 return;
1372 }
1373 if (save_typebuf() == FAIL)
1374 return;
1375
1376 /*
1377 * Execute the commands from the file right now when using ":source!"
1378 * after ":global" or ":argdo" or in a loop. Also when another command
1379 * follows. This means the display won't be updated. Don't do this
1380 * always, "make test" would fail.
1381 */
1382 if (directly)
1383 {
1384 oparg_T oa;
1385 int oldcurscript;
1386 int save_State = State;
1387 int save_restart_edit = restart_edit;
1388 int save_insertmode = p_im;
1389 int save_finish_op = finish_op;
1390 int save_msg_scroll = msg_scroll;
1391
1392 State = NORMAL;
1393 msg_scroll = FALSE; /* no msg scrolling in Normal mode */
1394 restart_edit = 0; /* don't go to Insert mode */
1395 p_im = FALSE; /* don't use 'insertmode' */
1396 clear_oparg(&oa);
1397 finish_op = FALSE;
1398
1399 oldcurscript = curscript;
1400 do
1401 {
1402 update_topline_cursor(); /* update cursor position and topline */
1403 normal_cmd(&oa, FALSE); /* execute one command */
1404 vpeekc(); /* check for end of file */
1405 }
1406 while (scriptin[oldcurscript] != NULL);
1407
1408 State = save_State;
1409 msg_scroll = save_msg_scroll;
1410 restart_edit = save_restart_edit;
1411 p_im = save_insertmode;
1412 finish_op = save_finish_op;
1413 }
1414}
1415
1416/*
1417 * Close the currently active input script.
1418 */
1419 static void
1420closescript()
1421{
1422 free_typebuf();
1423 typebuf = saved_typebuf[curscript];
1424
1425 fclose(scriptin[curscript]);
1426 scriptin[curscript] = NULL;
1427 if (curscript > 0)
1428 --curscript;
1429}
1430
Bram Moolenaarea408852005-06-25 22:49:46 +00001431#if defined(EXITFREE) || defined(PROTO)
1432 void
1433close_all_scripts()
1434{
1435 while (scriptin[0] != NULL)
1436 closescript();
1437}
1438#endif
1439
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440#if defined(FEAT_INS_EXPAND) || defined(PROTO)
1441/*
1442 * Return TRUE when reading keys from a script file.
1443 */
1444 int
1445using_script()
1446{
1447 return scriptin[curscript] != NULL;
1448}
1449#endif
1450
1451/*
Bram Moolenaar238f4fa2005-06-27 22:25:50 +00001452 * This function is called just before doing a blocking wait. Thus after
1453 * waiting 'updatetime' for a character to arrive.
1454 */
1455 void
1456before_blocking()
1457{
1458 updatescript(0);
1459#ifdef FEAT_EVAL
Bram Moolenaar9fecb462006-09-05 10:59:47 +00001460 if (may_garbage_collect)
1461 garbage_collect();
Bram Moolenaar238f4fa2005-06-27 22:25:50 +00001462#endif
1463}
1464
1465/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466 * updatescipt() is called when a character can be written into the script file
1467 * or when we have waited some time for a character (c == 0)
1468 *
1469 * All the changed memfiles are synced if c == 0 or when the number of typed
1470 * characters reaches 'updatecount' and 'updatecount' is non-zero.
1471 */
1472 void
1473updatescript(c)
1474 int c;
1475{
1476 static int count = 0;
1477
1478 if (c && scriptout)
1479 putc(c, scriptout);
1480 if (c == 0 || (p_uc > 0 && ++count >= p_uc))
1481 {
1482 ml_sync_all(c == 0, TRUE);
1483 count = 0;
1484 }
1485}
1486
1487#define KL_PART_KEY -1 /* keylen value for incomplete key-code */
1488#define KL_PART_MAP -2 /* keylen value for incomplete mapping */
1489
1490static int old_char = -1; /* character put back by vungetc() */
1491static int old_mod_mask; /* mod_mask for ungotten character */
1492
1493/*
1494 * Get the next input character.
1495 * Can return a special key or a multi-byte character.
1496 * Can return NUL when called recursively, use safe_vgetc() if that's not
1497 * wanted.
1498 * This translates escaped K_SPECIAL and CSI bytes to a K_SPECIAL or CSI byte.
1499 * Collects the bytes of a multibyte character into the whole character.
1500 * Returns the modifers in the global "mod_mask".
1501 */
1502 int
1503vgetc()
1504{
1505 int c, c2;
1506#ifdef FEAT_MBYTE
1507 int n;
1508 char_u buf[MB_MAXBYTES];
1509 int i;
1510#endif
1511
Bram Moolenaar9fecb462006-09-05 10:59:47 +00001512#ifdef FEAT_EVAL
1513 /* Do garbage collection when garbagecollect() was called previously and
1514 * we are now at the toplevel. */
1515 if (may_garbage_collect && want_garbage_collect)
1516 garbage_collect();
1517#endif
1518
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 /*
1520 * If a character was put back with vungetc, it was already processed.
1521 * Return it directly.
1522 */
1523 if (old_char != -1)
1524 {
1525 c = old_char;
1526 old_char = -1;
1527 mod_mask = old_mod_mask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528 }
Bram Moolenaar9fecb462006-09-05 10:59:47 +00001529 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 {
Bram Moolenaar9fecb462006-09-05 10:59:47 +00001531 mod_mask = 0x0;
1532 last_recorded_len = 0;
1533 for (;;) /* this is done twice if there are modifiers */
1534 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001535 if (mod_mask) /* no mapping after modifier has been read */
1536 {
1537 ++no_mapping;
1538 ++allow_keys;
1539 }
1540 c = vgetorpeek(TRUE);
1541 if (mod_mask)
1542 {
1543 --no_mapping;
1544 --allow_keys;
1545 }
1546
1547 /* Get two extra bytes for special keys */
1548 if (c == K_SPECIAL
1549#ifdef FEAT_GUI
1550 || c == CSI
1551#endif
1552 )
1553 {
Bram Moolenaar19a09a12005-03-04 23:39:37 +00001554 int save_allow_keys = allow_keys;
1555
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556 ++no_mapping;
Bram Moolenaar19a09a12005-03-04 23:39:37 +00001557 allow_keys = 0; /* make sure BS is not found */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 c2 = vgetorpeek(TRUE); /* no mapping for these chars */
1559 c = vgetorpeek(TRUE);
1560 --no_mapping;
Bram Moolenaar19a09a12005-03-04 23:39:37 +00001561 allow_keys = save_allow_keys;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001562 if (c2 == KS_MODIFIER)
1563 {
1564 mod_mask = c;
1565 continue;
1566 }
1567 c = TO_SPECIAL(c2, c);
1568
1569#if defined(FEAT_GUI_W32) && defined(FEAT_MENU) && defined(FEAT_TEAROFF)
1570 /* Handle K_TEAROFF here, the caller of vgetc() doesn't need to
1571 * know that a menu was torn off */
1572 if (c == K_TEAROFF)
1573 {
1574 char_u name[200];
1575 int i;
1576
1577 /* get menu path, it ends with a <CR> */
1578 for (i = 0; (c = vgetorpeek(TRUE)) != '\r'; )
1579 {
1580 name[i] = c;
1581 if (i < 199)
1582 ++i;
1583 }
1584 name[i] = NUL;
1585 gui_make_tearoff(name);
1586 continue;
1587 }
1588#endif
Bram Moolenaarcf0c5542006-02-09 23:48:02 +00001589#if defined(FEAT_GUI) && defined(HAVE_GTK2) && defined(FEAT_MENU)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001590 /* GTK: <F10> normally selects the menu, but it's passed until
1591 * here to allow mapping it. Intercept and invoke the GTK
1592 * behavior if it's not mapped. */
1593 if (c == K_F10 && gui.menubar != NULL)
1594 {
1595 gtk_menu_shell_select_first(GTK_MENU_SHELL(gui.menubar), FALSE);
1596 continue;
1597 }
1598#endif
1599
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600#ifdef FEAT_GUI
1601 /* Translate K_CSI to CSI. The special key is only used to avoid
1602 * it being recognized as the start of a special key. */
1603 if (c == K_CSI)
1604 c = CSI;
1605#endif
1606 }
1607#ifdef MSDOS
1608 /*
1609 * If K_NUL was typed, it is replaced by K_NUL, 3 in mch_inchar().
1610 * Delete the 3 here.
1611 */
1612 else if (c == K_NUL && vpeekc() == 3)
1613 (void)vgetorpeek(TRUE);
1614#endif
1615
Bram Moolenaara88d9682005-03-25 21:45:43 +00001616 /* a keypad or special function key was not mapped, use it like
1617 * its ASCII equivalent */
1618 switch (c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 {
Bram Moolenaara88d9682005-03-25 21:45:43 +00001620 case K_KPLUS: c = '+'; break;
1621 case K_KMINUS: c = '-'; break;
1622 case K_KDIVIDE: c = '/'; break;
1623 case K_KMULTIPLY: c = '*'; break;
1624 case K_KENTER: c = CAR; break;
1625 case K_KPOINT:
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001626#ifdef WIN32
Bram Moolenaara88d9682005-03-25 21:45:43 +00001627 /* Can be either '.' or a ',', *
1628 * depending on the type of keypad. */
1629 c = MapVirtualKey(VK_DECIMAL, 2); break;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001630#else
Bram Moolenaara88d9682005-03-25 21:45:43 +00001631 c = '.'; break;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001632#endif
Bram Moolenaara88d9682005-03-25 21:45:43 +00001633 case K_K0: c = '0'; break;
1634 case K_K1: c = '1'; break;
1635 case K_K2: c = '2'; break;
1636 case K_K3: c = '3'; break;
1637 case K_K4: c = '4'; break;
1638 case K_K5: c = '5'; break;
1639 case K_K6: c = '6'; break;
1640 case K_K7: c = '7'; break;
1641 case K_K8: c = '8'; break;
1642 case K_K9: c = '9'; break;
1643
1644 case K_XHOME:
1645 case K_ZHOME: if (mod_mask == MOD_MASK_SHIFT)
1646 {
1647 c = K_S_HOME;
1648 mod_mask = 0;
1649 }
1650 else if (mod_mask == MOD_MASK_CTRL)
1651 {
1652 c = K_C_HOME;
1653 mod_mask = 0;
1654 }
1655 else
1656 c = K_HOME;
1657 break;
1658 case K_XEND:
1659 case K_ZEND: if (mod_mask == MOD_MASK_SHIFT)
1660 {
1661 c = K_S_END;
1662 mod_mask = 0;
1663 }
1664 else if (mod_mask == MOD_MASK_CTRL)
1665 {
1666 c = K_C_END;
1667 mod_mask = 0;
1668 }
1669 else
1670 c = K_END;
1671 break;
1672
1673 case K_XUP: c = K_UP; break;
1674 case K_XDOWN: c = K_DOWN; break;
1675 case K_XLEFT: c = K_LEFT; break;
1676 case K_XRIGHT: c = K_RIGHT; break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 }
1678
1679#ifdef FEAT_MBYTE
1680 /* For a multi-byte character get all the bytes and return the
1681 * converted character.
1682 * Note: This will loop until enough bytes are received!
1683 */
1684 if (has_mbyte && (n = MB_BYTE2LEN_CHECK(c)) > 1)
1685 {
1686 ++no_mapping;
1687 buf[0] = c;
1688 for (i = 1; i < n; ++i)
1689 {
1690 buf[i] = vgetorpeek(TRUE);
1691 if (buf[i] == K_SPECIAL
1692#ifdef FEAT_GUI
1693 || buf[i] == CSI
1694#endif
1695 )
1696 {
1697 /* Must be a K_SPECIAL - KS_SPECIAL - KE_FILLER sequence,
1698 * which represents a K_SPECIAL (0x80),
1699 * or a CSI - KS_EXTRA - KE_CSI sequence, which represents
1700 * a CSI (0x9B),
1701 * of a K_SPECIAL - KS_EXTRA - KE_CSI, which is CSI too. */
1702 c = vgetorpeek(TRUE);
1703 if (vgetorpeek(TRUE) == (int)KE_CSI && c == KS_EXTRA)
1704 buf[i] = CSI;
1705 }
1706 }
1707 --no_mapping;
1708 c = (*mb_ptr2char)(buf);
1709 }
1710#endif
1711
Bram Moolenaar9fecb462006-09-05 10:59:47 +00001712 break;
1713 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 }
Bram Moolenaar9fecb462006-09-05 10:59:47 +00001715
1716#ifdef FEAT_EVAL
1717 /*
1718 * In the main loop "may_garbage_collect" can be set to do garbage
1719 * collection in the first next vgetc(). It's disabled after that to
1720 * avoid internally used Lists and Dicts to be freed.
1721 */
1722 may_garbage_collect = FALSE;
1723#endif
1724
1725 return c;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726}
1727
1728/*
1729 * Like vgetc(), but never return a NUL when called recursively, get a key
1730 * directly from the user (ignoring typeahead).
1731 */
1732 int
1733safe_vgetc()
1734{
1735 int c;
1736
1737 c = vgetc();
1738 if (c == NUL)
1739 c = get_keystroke();
1740 return c;
1741}
1742
1743/*
1744 * Check if a character is available, such that vgetc() will not block.
1745 * If the next character is a special character or multi-byte, the returned
1746 * character is not valid!.
1747 */
1748 int
1749vpeekc()
1750{
1751 if (old_char != -1)
1752 return old_char;
1753 return vgetorpeek(FALSE);
1754}
1755
1756#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1757/*
1758 * Like vpeekc(), but don't allow mapping. Do allow checking for terminal
1759 * codes.
1760 */
1761 int
1762vpeekc_nomap()
1763{
1764 int c;
1765
1766 ++no_mapping;
1767 ++allow_keys;
1768 c = vpeekc();
1769 --no_mapping;
1770 --allow_keys;
1771 return c;
1772}
1773#endif
1774
1775#if defined(FEAT_INS_EXPAND) || defined(PROTO)
1776/*
1777 * Check if any character is available, also half an escape sequence.
1778 * Trick: when no typeahead found, but there is something in the typeahead
1779 * buffer, it must be an ESC that is recognized as the start of a key code.
1780 */
1781 int
1782vpeekc_any()
1783{
1784 int c;
1785
1786 c = vpeekc();
1787 if (c == NUL && typebuf.tb_len > 0)
1788 c = ESC;
1789 return c;
1790}
1791#endif
1792
1793/*
1794 * Call vpeekc() without causing anything to be mapped.
1795 * Return TRUE if a character is available, FALSE otherwise.
1796 */
1797 int
1798char_avail()
1799{
1800 int retval;
1801
1802 ++no_mapping;
1803 retval = vpeekc();
1804 --no_mapping;
1805 return (retval != NUL);
1806}
1807
1808 void
1809vungetc(c) /* unget one character (can only be done once!) */
1810 int c;
1811{
1812 old_char = c;
1813 old_mod_mask = mod_mask;
1814}
1815
1816/*
1817 * get a character:
1818 * 1. from the stuffbuffer
1819 * This is used for abbreviated commands like "D" -> "d$".
1820 * Also used to redo a command for ".".
1821 * 2. from the typeahead buffer
1822 * Stores text obtained previously but not used yet.
1823 * Also stores the result of mappings.
1824 * Also used for the ":normal" command.
1825 * 3. from the user
1826 * This may do a blocking wait if "advance" is TRUE.
1827 *
1828 * if "advance" is TRUE (vgetc()):
1829 * really get the character.
1830 * KeyTyped is set to TRUE in the case the user typed the key.
1831 * KeyStuffed is TRUE if the character comes from the stuff buffer.
1832 * if "advance" is FALSE (vpeekc()):
1833 * just look whether there is a character available.
1834 *
1835 * When "no_mapping" is zero, checks for mappings in the current mode.
1836 * Only returns one byte (of a multi-byte character).
1837 * K_SPECIAL and CSI may be escaped, need to get two more bytes then.
1838 */
1839 static int
1840vgetorpeek(advance)
1841 int advance;
1842{
1843 int c, c1;
1844 int keylen;
1845 char_u *s;
1846 mapblock_T *mp;
1847#ifdef FEAT_LOCALMAP
1848 mapblock_T *mp2;
1849#endif
1850 mapblock_T *mp_match;
1851 int mp_match_len = 0;
1852 int timedout = FALSE; /* waited for more than 1 second
1853 for mapping to complete */
1854 int mapdepth = 0; /* check for recursive mapping */
1855 int mode_deleted = FALSE; /* set when mode has been deleted */
1856 int local_State;
1857 int mlen;
1858 int max_mlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 int i;
Bram Moolenaar4e427192006-03-10 21:34:27 +00001860#ifdef FEAT_CMDL_INFO
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 int new_wcol, new_wrow;
1862#endif
1863#ifdef FEAT_GUI
1864# ifdef FEAT_MENU
1865 int idx;
1866# endif
1867 int shape_changed = FALSE; /* adjusted cursor shape */
1868#endif
1869 int n;
1870#ifdef FEAT_LANGMAP
1871 int nolmaplen;
1872#endif
1873 int old_wcol, old_wrow;
Bram Moolenaar28a37ff2005-03-15 22:28:00 +00001874 int wait_tb_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875
1876 /*
1877 * This function doesn't work very well when called recursively. This may
1878 * happen though, because of:
1879 * 1. The call to add_to_showcmd(). char_avail() is then used to check if
1880 * there is a character available, which calls this function. In that
1881 * case we must return NUL, to indicate no character is available.
1882 * 2. A GUI callback function writes to the screen, causing a
1883 * wait_return().
1884 * Using ":normal" can also do this, but it saves the typeahead buffer,
1885 * thus it should be OK. But don't get a key from the user then.
1886 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +00001887 if (vgetc_busy > 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888#ifdef FEAT_EX_EXTRA
1889 && ex_normal_busy == 0
1890#endif
1891 )
1892 return NUL;
1893
1894 local_State = get_real_state();
1895
Bram Moolenaar5555acc2006-04-07 21:33:12 +00001896 ++vgetc_busy;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897
1898 if (advance)
1899 KeyStuffed = FALSE;
1900
1901 init_typebuf();
1902 start_stuff();
1903 if (advance && typebuf.tb_maplen == 0)
1904 Exec_reg = FALSE;
1905 do
1906 {
1907/*
1908 * get a character: 1. from the stuffbuffer
1909 */
1910 if (typeahead_char != 0)
1911 {
1912 c = typeahead_char;
1913 if (advance)
1914 typeahead_char = 0;
1915 }
1916 else
1917 c = read_stuff(advance);
1918 if (c != NUL && !got_int)
1919 {
1920 if (advance)
1921 {
1922 /* KeyTyped = FALSE; When the command that stuffed something
1923 * was typed, behave like the stuffed command was typed.
1924 * needed for CTRL-W CTRl-] to open a fold, for example. */
1925 KeyStuffed = TRUE;
1926 }
1927 if (typebuf.tb_no_abbr_cnt == 0)
1928 typebuf.tb_no_abbr_cnt = 1; /* no abbreviations now */
1929 }
1930 else
1931 {
1932 /*
1933 * Loop until we either find a matching mapped key, or we
1934 * are sure that it is not a mapped key.
1935 * If a mapped key sequence is found we go back to the start to
1936 * try re-mapping.
1937 */
1938 for (;;)
1939 {
1940 /*
1941 * ui_breakcheck() is slow, don't use it too often when
1942 * inside a mapping. But call it each time for typed
1943 * characters.
1944 */
1945 if (typebuf.tb_maplen)
1946 line_breakcheck();
1947 else
1948 ui_breakcheck(); /* check for CTRL-C */
1949 keylen = 0;
1950 if (got_int)
1951 {
1952 /* flush all input */
1953 c = inchar(typebuf.tb_buf, typebuf.tb_buflen - 1, 0L,
1954 typebuf.tb_change_cnt);
1955 /*
1956 * If inchar() returns TRUE (script file was active) or we
1957 * are inside a mapping, get out of insert mode.
1958 * Otherwise we behave like having gotten a CTRL-C.
1959 * As a result typing CTRL-C in insert mode will
1960 * really insert a CTRL-C.
1961 */
1962 if ((c || typebuf.tb_maplen)
1963 && (State & (INSERT + CMDLINE)))
1964 c = ESC;
1965 else
1966 c = Ctrl_C;
1967 flush_buffers(TRUE); /* flush all typeahead */
1968
Bram Moolenaard9dfd572006-10-03 13:36:13 +00001969 if (advance)
1970 {
1971 /* Also record this character, it might be needed to
1972 * get out of Insert mode. */
1973 *typebuf.tb_buf = c;
1974 gotchars(typebuf.tb_buf, 1);
1975 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976 cmd_silent = FALSE;
1977
1978 break;
1979 }
1980 else if (typebuf.tb_len > 0)
1981 {
1982 /*
1983 * Check for a mappable key sequence.
1984 * Walk through one maphash[] list until we find an
1985 * entry that matches.
1986 *
1987 * Don't look for mappings if:
1988 * - no_mapping set: mapping disabled (e.g. for CTRL-V)
1989 * - maphash_valid not set: no mappings present.
1990 * - typebuf.tb_buf[typebuf.tb_off] should not be remapped
1991 * - in insert or cmdline mode and 'paste' option set
1992 * - waiting for "hit return to continue" and CR or SPACE
1993 * typed
1994 * - waiting for a char with --more--
1995 * - in Ctrl-X mode, and we get a valid char for that mode
1996 */
1997 mp = NULL;
1998 max_mlen = 0;
1999 c1 = typebuf.tb_buf[typebuf.tb_off];
2000 if (no_mapping == 0 && maphash_valid
2001 && (no_zero_mapping == 0 || c1 != '0')
2002 && (typebuf.tb_maplen == 0
2003 || (p_remap
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002004 && (typebuf.tb_noremap[typebuf.tb_off]
2005 & (RM_NONE|RM_ABBR)) == 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006 && !(p_paste && (State & (INSERT + CMDLINE)))
2007 && !(State == HITRETURN && (c1 == CAR || c1 == ' '))
2008 && State != ASKMORE
2009 && State != CONFIRM
2010#ifdef FEAT_INS_EXPAND
2011 && !((ctrl_x_mode != 0 && vim_is_ctrl_x_key(c1))
Bram Moolenaar4be06f92005-07-29 22:36:03 +00002012 || ((compl_cont_status & CONT_LOCAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 && (c1 == Ctrl_N || c1 == Ctrl_P)))
2014#endif
2015 )
2016 {
2017#ifdef FEAT_LANGMAP
2018 if (c1 == K_SPECIAL)
2019 nolmaplen = 2;
2020 else
2021 {
2022 LANGMAP_ADJUST(c1, TRUE);
2023 nolmaplen = 0;
2024 }
2025#endif
2026#ifdef FEAT_LOCALMAP
2027 /* First try buffer-local mappings. */
2028 mp = curbuf->b_maphash[MAP_HASH(local_State, c1)];
2029 mp2 = maphash[MAP_HASH(local_State, c1)];
2030 if (mp == NULL)
2031 {
2032 mp = mp2;
2033 mp2 = NULL;
2034 }
2035#else
2036 mp = maphash[MAP_HASH(local_State, c1)];
2037#endif
2038 /*
2039 * Loop until a partly matching mapping is found or
2040 * all (local) mappings have been checked.
2041 * The longest full match is remembered in "mp_match".
2042 * A full match is only accepted if there is no partly
2043 * match, so "aa" and "aaa" can both be mapped.
2044 */
2045 mp_match = NULL;
2046 mp_match_len = 0;
2047 for ( ; mp != NULL;
2048#ifdef FEAT_LOCALMAP
2049 mp->m_next == NULL ? (mp = mp2, mp2 = NULL) :
2050#endif
2051 (mp = mp->m_next))
2052 {
2053 /*
2054 * Only consider an entry if the first character
2055 * matches and it is for the current state.
2056 * Skip ":lmap" mappings if keys were mapped.
2057 */
2058 if (mp->m_keys[0] == c1
2059 && (mp->m_mode & local_State)
2060 && ((mp->m_mode & LANGMAP) == 0
2061 || typebuf.tb_maplen == 0))
2062 {
2063#ifdef FEAT_LANGMAP
2064 int nomap = nolmaplen;
2065 int c2;
2066#endif
2067 /* find the match length of this mapping */
2068 for (mlen = 1; mlen < typebuf.tb_len; ++mlen)
2069 {
2070#ifdef FEAT_LANGMAP
2071 c2 = typebuf.tb_buf[typebuf.tb_off + mlen];
2072 if (nomap > 0)
2073 --nomap;
2074 else if (c2 == K_SPECIAL)
2075 nomap = 2;
2076 else
2077 LANGMAP_ADJUST(c2, TRUE);
2078 if (mp->m_keys[mlen] != c2)
2079#else
2080 if (mp->m_keys[mlen] !=
2081 typebuf.tb_buf[typebuf.tb_off + mlen])
2082#endif
2083 break;
2084 }
2085
2086#ifdef FEAT_MBYTE
2087 /* Don't allow mapping the first byte(s) of a
2088 * multi-byte char. Happens when mapping
2089 * <M-a> and then changing 'encoding'. */
2090 if (has_mbyte && MB_BYTE2LEN(c1)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002091 > (*mb_ptr2len)(mp->m_keys))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092 mlen = 0;
2093#endif
2094 /*
2095 * Check an entry whether it matches.
2096 * - Full match: mlen == keylen
2097 * - Partly match: mlen == typebuf.tb_len
2098 */
2099 keylen = mp->m_keylen;
2100 if (mlen == keylen
2101 || (mlen == typebuf.tb_len
2102 && typebuf.tb_len < keylen))
2103 {
2104 /*
2105 * If only script-local mappings are
2106 * allowed, check if the mapping starts
2107 * with K_SNR.
2108 */
2109 s = typebuf.tb_noremap + typebuf.tb_off;
2110 if (*s == RM_SCRIPT
2111 && (mp->m_keys[0] != K_SPECIAL
2112 || mp->m_keys[1] != KS_EXTRA
2113 || mp->m_keys[2]
2114 != (int)KE_SNR))
2115 continue;
2116 /*
2117 * If one of the typed keys cannot be
2118 * remapped, skip the entry.
2119 */
2120 for (n = mlen; --n >= 0; )
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002121 if (*s++ & (RM_NONE|RM_ABBR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 break;
2123 if (n >= 0)
2124 continue;
2125
2126 if (keylen > typebuf.tb_len)
2127 {
2128 if (!timedout)
2129 {
2130 /* break at a partly match */
2131 keylen = KL_PART_MAP;
2132 break;
2133 }
2134 }
2135 else if (keylen > mp_match_len)
2136 {
2137 /* found a longer match */
2138 mp_match = mp;
2139 mp_match_len = keylen;
2140 }
2141 }
2142 else
2143 /* No match; may have to check for
2144 * termcode at next character. */
2145 if (max_mlen < mlen)
2146 max_mlen = mlen;
2147 }
2148 }
2149
2150 /* If no partly match found, use the longest full
2151 * match. */
2152 if (keylen != KL_PART_MAP)
2153 {
2154 mp = mp_match;
2155 keylen = mp_match_len;
2156 }
2157 }
2158
2159 /* Check for match with 'pastetoggle' */
2160 if (*p_pt != NUL && mp == NULL && (State & (INSERT|NORMAL)))
2161 {
2162 for (mlen = 0; mlen < typebuf.tb_len && p_pt[mlen];
2163 ++mlen)
2164 if (p_pt[mlen] != typebuf.tb_buf[typebuf.tb_off
2165 + mlen])
2166 break;
2167 if (p_pt[mlen] == NUL) /* match */
2168 {
2169 /* write chars to script file(s) */
2170 if (mlen > typebuf.tb_maplen)
2171 gotchars(typebuf.tb_buf + typebuf.tb_off
2172 + typebuf.tb_maplen,
2173 mlen - typebuf.tb_maplen);
2174
2175 del_typebuf(mlen, 0); /* remove the chars */
2176 set_option_value((char_u *)"paste",
2177 (long)!p_paste, NULL, 0);
2178 if (!(State & INSERT))
2179 {
2180 msg_col = 0;
2181 msg_row = Rows - 1;
2182 msg_clr_eos(); /* clear ruler */
2183 }
2184 showmode();
2185 setcursor();
2186 continue;
2187 }
2188 /* Need more chars for partly match. */
2189 if (mlen == typebuf.tb_len)
Bram Moolenaar4076b792007-04-26 14:48:01 +00002190 keylen = KL_PART_KEY;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 else if (max_mlen < mlen)
2192 /* no match, may have to check for termcode at
2193 * next character */
2194 max_mlen = mlen + 1;
2195 }
2196
2197 if ((mp == NULL || max_mlen >= mp_match_len)
2198 && keylen != KL_PART_MAP)
2199 {
2200 /*
2201 * When no matching mapping found or found a
2202 * non-matching mapping that matches at least what the
2203 * matching mapping matched:
2204 * Check if we have a terminal code, when:
2205 * mapping is allowed,
2206 * keys have not been mapped,
2207 * and not an ESC sequence, not in insert mode or
2208 * p_ek is on,
2209 * and when not timed out,
2210 */
2211 if ((no_mapping == 0 || allow_keys != 0)
2212 && (typebuf.tb_maplen == 0
2213 || (p_remap && typebuf.tb_noremap[
2214 typebuf.tb_off] == RM_YES))
2215 && !timedout)
2216 {
2217 keylen = check_termcode(max_mlen + 1, NULL, 0);
2218
2219 /*
2220 * When getting a partial match, but the last
2221 * characters were not typed, don't wait for a
2222 * typed character to complete the termcode.
2223 * This helps a lot when a ":normal" command ends
2224 * in an ESC.
2225 */
2226 if (keylen < 0
2227 && typebuf.tb_len == typebuf.tb_maplen)
2228 keylen = 0;
2229 }
2230 else
2231 keylen = 0;
2232 if (keylen == 0) /* no matching terminal code */
2233 {
2234#ifdef AMIGA /* check for window bounds report */
2235 if (typebuf.tb_maplen == 0 && (typebuf.tb_buf[
2236 typebuf.tb_off] & 0xff) == CSI)
2237 {
2238 for (s = typebuf.tb_buf + typebuf.tb_off + 1;
2239 s < typebuf.tb_buf + typebuf.tb_off
2240 + typebuf.tb_len
2241 && (VIM_ISDIGIT(*s) || *s == ';'
2242 || *s == ' ');
2243 ++s)
2244 ;
2245 if (*s == 'r' || *s == '|') /* found one */
2246 {
2247 del_typebuf((int)(s + 1 -
2248 (typebuf.tb_buf + typebuf.tb_off)), 0);
2249 /* get size and redraw screen */
2250 shell_resized();
2251 continue;
2252 }
2253 if (*s == NUL) /* need more characters */
2254 keylen = KL_PART_KEY;
2255 }
2256 if (keylen >= 0)
2257#endif
2258 /* When there was a matching mapping and no
2259 * termcode could be replaced after another one,
2260 * use that mapping. */
2261 if (mp == NULL)
2262 {
2263/*
2264 * get a character: 2. from the typeahead buffer
2265 */
2266 c = typebuf.tb_buf[typebuf.tb_off] & 255;
2267 if (advance) /* remove chars from tb_buf */
2268 {
2269 cmd_silent = (typebuf.tb_silent > 0);
2270 if (typebuf.tb_maplen > 0)
2271 KeyTyped = FALSE;
2272 else
2273 {
2274 KeyTyped = TRUE;
2275 /* write char to script file(s) */
2276 gotchars(typebuf.tb_buf
2277 + typebuf.tb_off, 1);
2278 }
Bram Moolenaarcf8e7d12006-12-05 20:43:17 +00002279 KeyNoremap = typebuf.tb_noremap[
2280 typebuf.tb_off];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281 del_typebuf(1, 0);
2282 }
2283 break; /* got character, break for loop */
2284 }
2285 }
2286 if (keylen > 0) /* full matching terminal code */
2287 {
2288#if defined(FEAT_GUI) && defined(FEAT_MENU)
2289 if (typebuf.tb_buf[typebuf.tb_off] == K_SPECIAL
2290 && typebuf.tb_buf[typebuf.tb_off + 1]
2291 == KS_MENU)
2292 {
2293 /*
2294 * Using a menu may cause a break in undo!
2295 * It's like using gotchars(), but without
2296 * recording or writing to a script file.
2297 */
2298 may_sync_undo();
2299 del_typebuf(3, 0);
2300 idx = get_menu_index(current_menu, local_State);
2301 if (idx != MENU_INDEX_INVALID)
2302 {
2303# ifdef FEAT_VISUAL
2304 /*
Bram Moolenaar371d5402006-03-20 21:47:49 +00002305 * In Select mode and a Visual mode menu
2306 * is used: Switch to Visual mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00002307 * temporarily. Append K_SELECT to switch
2308 * back to Select mode.
2309 */
Bram Moolenaar371d5402006-03-20 21:47:49 +00002310 if (VIsual_active && VIsual_select
2311 && (current_menu->modes & VISUAL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312 {
2313 VIsual_select = FALSE;
2314 (void)ins_typebuf(K_SELECT_STRING,
2315 REMAP_NONE, 0, TRUE, FALSE);
2316 }
2317# endif
2318 ins_typebuf(current_menu->strings[idx],
2319 current_menu->noremap[idx],
2320 0, TRUE,
2321 current_menu->silent[idx]);
2322 }
2323 }
2324#endif /* FEAT_GUI */
2325 continue; /* try mapping again */
2326 }
2327
2328 /* Partial match: get some more characters. When a
2329 * matching mapping was found use that one. */
2330 if (mp == NULL || keylen < 0)
2331 keylen = KL_PART_KEY;
2332 else
2333 keylen = mp_match_len;
2334 }
2335
2336 /* complete match */
2337 if (keylen >= 0 && keylen <= typebuf.tb_len)
2338 {
2339 /* write chars to script file(s) */
2340 if (keylen > typebuf.tb_maplen)
2341 gotchars(typebuf.tb_buf + typebuf.tb_off
2342 + typebuf.tb_maplen,
2343 keylen - typebuf.tb_maplen);
2344
2345 cmd_silent = (typebuf.tb_silent > 0);
2346 del_typebuf(keylen, 0); /* remove the mapped keys */
2347
2348 /*
2349 * Put the replacement string in front of mapstr.
2350 * The depth check catches ":map x y" and ":map y x".
2351 */
2352 if (++mapdepth >= p_mmd)
2353 {
2354 EMSG(_("E223: recursive mapping"));
2355 if (State & CMDLINE)
2356 redrawcmdline();
2357 else
2358 setcursor();
2359 flush_buffers(FALSE);
2360 mapdepth = 0; /* for next one */
2361 c = -1;
2362 break;
2363 }
2364
2365#ifdef FEAT_VISUAL
2366 /*
Bram Moolenaar371d5402006-03-20 21:47:49 +00002367 * In Select mode and a Visual mode mapping is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368 * Switch to Visual mode temporarily. Append K_SELECT
2369 * to switch back to Select mode.
2370 */
Bram Moolenaar371d5402006-03-20 21:47:49 +00002371 if (VIsual_active && VIsual_select
2372 && (mp->m_mode & VISUAL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002373 {
2374 VIsual_select = FALSE;
2375 (void)ins_typebuf(K_SELECT_STRING, REMAP_NONE,
2376 0, TRUE, FALSE);
2377 }
2378#endif
2379
Bram Moolenaar4e427192006-03-10 21:34:27 +00002380#ifdef FEAT_EVAL
2381 /*
2382 * Handle ":map <expr>": evaluate the {rhs} as an
Bram Moolenaar5555acc2006-04-07 21:33:12 +00002383 * expression. Save and restore the typeahead so that
Bram Moolenaarc1b52862006-04-28 22:32:28 +00002384 * getchar() can be used. Also save and restore the
2385 * command line for "normal :".
Bram Moolenaar4e427192006-03-10 21:34:27 +00002386 */
2387 if (mp->m_expr)
Bram Moolenaar5555acc2006-04-07 21:33:12 +00002388 {
2389 tasave_T tabuf;
2390 int save_vgetc_busy = vgetc_busy;
2391
2392 save_typeahead(&tabuf);
2393 if (tabuf.typebuf_valid)
2394 {
2395 vgetc_busy = 0;
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002396 s = eval_map_expr(mp->m_str);
Bram Moolenaar5555acc2006-04-07 21:33:12 +00002397 vgetc_busy = save_vgetc_busy;
2398 }
2399 else
2400 s = NULL;
2401 restore_typeahead(&tabuf);
2402 }
Bram Moolenaar4e427192006-03-10 21:34:27 +00002403 else
2404#endif
2405 s = mp->m_str;
2406
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407 /*
2408 * Insert the 'to' part in the typebuf.tb_buf.
2409 * If 'from' field is the same as the start of the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002410 * 'to' field, don't remap the first character (but do
2411 * allow abbreviations).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412 * If m_noremap is set, don't remap the whole 'to'
2413 * part.
2414 */
Bram Moolenaar4e427192006-03-10 21:34:27 +00002415 if (s == NULL)
2416 i = FAIL;
2417 else
2418 {
2419 i = ins_typebuf(s,
2420 mp->m_noremap != REMAP_YES
Bram Moolenaar071d4272004-06-13 20:20:40 +00002421 ? mp->m_noremap
Bram Moolenaar4e427192006-03-10 21:34:27 +00002422 : STRNCMP(s, mp->m_keys,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002423 (size_t)keylen) != 0
2424 ? REMAP_YES : REMAP_SKIP,
Bram Moolenaar4e427192006-03-10 21:34:27 +00002425 0, TRUE, cmd_silent || mp->m_silent);
2426#ifdef FEAT_EVAL
2427 if (mp->m_expr)
2428 vim_free(s);
2429#endif
2430 }
2431 if (i == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432 {
2433 c = -1;
2434 break;
2435 }
2436 continue;
2437 }
2438 }
2439
2440/*
2441 * get a character: 3. from the user - handle <Esc> in Insert mode
2442 */
2443 /*
2444 * special case: if we get an <ESC> in insert mode and there
2445 * are no more characters at once, we pretend to go out of
2446 * insert mode. This prevents the one second delay after
2447 * typing an <ESC>. If we get something after all, we may
2448 * have to redisplay the mode. That the cursor is in the wrong
2449 * place does not matter.
2450 */
2451 c = 0;
2452#ifdef FEAT_CMDL_INFO
2453 new_wcol = curwin->w_wcol;
2454 new_wrow = curwin->w_wrow;
2455#endif
2456 if ( advance
2457 && typebuf.tb_len == 1
2458 && typebuf.tb_buf[typebuf.tb_off] == ESC
2459 && !no_mapping
2460#ifdef FEAT_EX_EXTRA
2461 && ex_normal_busy == 0
2462#endif
2463 && typebuf.tb_maplen == 0
2464 && (State & INSERT)
2465 && (p_timeout || (keylen == KL_PART_KEY && p_ttimeout))
2466 && (c = inchar(typebuf.tb_buf + typebuf.tb_off
2467 + typebuf.tb_len, 3, 25L,
2468 typebuf.tb_change_cnt)) == 0)
2469 {
2470 colnr_T col = 0, vcol;
2471 char_u *ptr;
2472
Bram Moolenaar28c258f2006-01-25 22:02:51 +00002473 if (mode_displayed)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474 {
2475 unshowmode(TRUE);
2476 mode_deleted = TRUE;
2477 }
2478#ifdef FEAT_GUI
2479 /* may show different cursor shape */
2480 if (gui.in_use)
2481 {
2482 int save_State;
2483
2484 save_State = State;
2485 State = NORMAL;
2486 gui_update_cursor(TRUE, FALSE);
2487 State = save_State;
2488 shape_changed = TRUE;
2489 }
2490#endif
2491 validate_cursor();
2492 old_wcol = curwin->w_wcol;
2493 old_wrow = curwin->w_wrow;
2494
2495 /* move cursor left, if possible */
2496 if (curwin->w_cursor.col != 0)
2497 {
2498 if (curwin->w_wcol > 0)
2499 {
2500 if (did_ai)
2501 {
2502 /*
2503 * We are expecting to truncate the trailing
2504 * white-space, so find the last non-white
2505 * character -- webb
2506 */
2507 col = vcol = curwin->w_wcol = 0;
2508 ptr = ml_get_curline();
2509 while (col < curwin->w_cursor.col)
2510 {
2511 if (!vim_iswhite(ptr[col]))
2512 curwin->w_wcol = vcol;
2513 vcol += lbr_chartabsize(ptr + col,
2514 (colnr_T)vcol);
2515#ifdef FEAT_MBYTE
2516 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002517 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518 else
2519#endif
2520 ++col;
2521 }
2522 curwin->w_wrow = curwin->w_cline_row
2523 + curwin->w_wcol / W_WIDTH(curwin);
2524 curwin->w_wcol %= W_WIDTH(curwin);
2525 curwin->w_wcol += curwin_col_off();
2526#ifdef FEAT_MBYTE
2527 col = 0; /* no correction needed */
2528#endif
2529 }
2530 else
2531 {
2532 --curwin->w_wcol;
2533#ifdef FEAT_MBYTE
2534 col = curwin->w_cursor.col - 1;
2535#endif
2536 }
2537 }
2538 else if (curwin->w_p_wrap && curwin->w_wrow)
2539 {
2540 --curwin->w_wrow;
2541 curwin->w_wcol = W_WIDTH(curwin) - 1;
2542#ifdef FEAT_MBYTE
2543 col = curwin->w_cursor.col - 1;
2544#endif
2545 }
2546#ifdef FEAT_MBYTE
2547 if (has_mbyte && col > 0 && curwin->w_wcol > 0)
2548 {
2549 /* Correct when the cursor is on the right halve
2550 * of a double-wide character. */
2551 ptr = ml_get_curline();
2552 col -= (*mb_head_off)(ptr, ptr + col);
2553 if ((*mb_ptr2cells)(ptr + col) > 1)
2554 --curwin->w_wcol;
2555 }
2556#endif
2557 }
2558 setcursor();
2559 out_flush();
2560#ifdef FEAT_CMDL_INFO
2561 new_wcol = curwin->w_wcol;
2562 new_wrow = curwin->w_wrow;
2563#endif
2564 curwin->w_wcol = old_wcol;
2565 curwin->w_wrow = old_wrow;
2566 }
2567 if (c < 0)
2568 continue; /* end of input script reached */
2569 typebuf.tb_len += c;
2570
2571 /* buffer full, don't map */
2572 if (typebuf.tb_len >= typebuf.tb_maplen + MAXMAPLEN)
2573 {
2574 timedout = TRUE;
2575 continue;
2576 }
2577
2578#ifdef FEAT_EX_EXTRA
2579 if (ex_normal_busy > 0)
2580 {
2581# ifdef FEAT_CMDWIN
2582 static int tc = 0;
2583# endif
2584
2585 /* No typeahead left and inside ":normal". Must return
2586 * something to avoid getting stuck. When an incomplete
2587 * mapping is present, behave like it timed out. */
2588 if (typebuf.tb_len > 0)
2589 {
2590 timedout = TRUE;
2591 continue;
2592 }
2593 /* When 'insertmode' is set, ESC just beeps in Insert
2594 * mode. Use CTRL-L to make edit() return.
2595 * For the command line only CTRL-C always breaks it.
2596 * For the cmdline window: Alternate between ESC and
2597 * CTRL-C: ESC for most situations and CTRL-C to close the
2598 * cmdline window. */
2599 if (p_im && (State & INSERT))
2600 c = Ctrl_L;
2601 else if ((State & CMDLINE)
2602# ifdef FEAT_CMDWIN
2603 || (cmdwin_type > 0 && tc == ESC)
2604# endif
2605 )
2606 c = Ctrl_C;
2607 else
2608 c = ESC;
2609# ifdef FEAT_CMDWIN
2610 tc = c;
2611# endif
2612 break;
2613 }
2614#endif
2615
2616/*
2617 * get a character: 3. from the user - update display
2618 */
2619 /* In insert mode a screen update is skipped when characters
2620 * are still available. But when those available characters
2621 * are part of a mapping, and we are going to do a blocking
2622 * wait here. Need to update the screen to display the
2623 * changed text so far. */
2624 if ((State & INSERT) && advance && must_redraw != 0)
2625 {
2626 update_screen(0);
2627 setcursor(); /* put cursor back where it belongs */
2628 }
2629
2630 /*
2631 * If we have a partial match (and are going to wait for more
2632 * input from the user), show the partially matched characters
2633 * to the user with showcmd.
2634 */
2635#ifdef FEAT_CMDL_INFO
2636 i = 0;
2637#endif
2638 c1 = 0;
2639 if (typebuf.tb_len > 0 && advance && !exmode_active)
2640 {
2641 if (((State & (NORMAL | INSERT)) || State == LANGMAP)
2642 && State != HITRETURN)
2643 {
2644 /* this looks nice when typing a dead character map */
2645 if (State & INSERT
2646 && ptr2cells(typebuf.tb_buf + typebuf.tb_off
2647 + typebuf.tb_len - 1) == 1)
2648 {
2649 edit_putchar(typebuf.tb_buf[typebuf.tb_off
2650 + typebuf.tb_len - 1], FALSE);
2651 setcursor(); /* put cursor back where it belongs */
2652 c1 = 1;
2653 }
2654#ifdef FEAT_CMDL_INFO
2655 /* need to use the col and row from above here */
2656 old_wcol = curwin->w_wcol;
2657 old_wrow = curwin->w_wrow;
2658 curwin->w_wcol = new_wcol;
2659 curwin->w_wrow = new_wrow;
2660 push_showcmd();
2661 if (typebuf.tb_len > SHOWCMD_COLS)
2662 i = typebuf.tb_len - SHOWCMD_COLS;
2663 while (i < typebuf.tb_len)
2664 (void)add_to_showcmd(typebuf.tb_buf[typebuf.tb_off
2665 + i++]);
2666 curwin->w_wcol = old_wcol;
2667 curwin->w_wrow = old_wrow;
2668#endif
2669 }
2670
2671 /* this looks nice when typing a dead character map */
2672 if ((State & CMDLINE)
2673#if defined(FEAT_CRYPT) || defined(FEAT_EVAL)
2674 && cmdline_star == 0
2675#endif
2676 && ptr2cells(typebuf.tb_buf + typebuf.tb_off
2677 + typebuf.tb_len - 1) == 1)
2678 {
2679 putcmdline(typebuf.tb_buf[typebuf.tb_off
2680 + typebuf.tb_len - 1], FALSE);
2681 c1 = 1;
2682 }
2683 }
2684
2685/*
2686 * get a character: 3. from the user - get it
2687 */
Bram Moolenaar28a37ff2005-03-15 22:28:00 +00002688 wait_tb_len = typebuf.tb_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689 c = inchar(typebuf.tb_buf + typebuf.tb_off + typebuf.tb_len,
2690 typebuf.tb_buflen - typebuf.tb_off - typebuf.tb_len - 1,
2691 !advance
2692 ? 0
2693 : ((typebuf.tb_len == 0
2694 || !(p_timeout || (p_ttimeout
2695 && keylen == KL_PART_KEY)))
2696 ? -1L
2697 : ((keylen == KL_PART_KEY && p_ttm >= 0)
2698 ? p_ttm
2699 : p_tm)), typebuf.tb_change_cnt);
2700
2701#ifdef FEAT_CMDL_INFO
2702 if (i != 0)
2703 pop_showcmd();
2704#endif
2705 if (c1 == 1)
2706 {
2707 if (State & INSERT)
2708 edit_unputchar();
2709 if (State & CMDLINE)
2710 unputcmdline();
2711 setcursor(); /* put cursor back where it belongs */
2712 }
2713
2714 if (c < 0)
2715 continue; /* end of input script reached */
2716 if (c == NUL) /* no character available */
2717 {
2718 if (!advance)
2719 break;
Bram Moolenaar28a37ff2005-03-15 22:28:00 +00002720 if (wait_tb_len > 0) /* timed out */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721 {
2722 timedout = TRUE;
2723 continue;
2724 }
2725 }
2726 else
2727 { /* allow mapping for just typed characters */
2728 while (typebuf.tb_buf[typebuf.tb_off
2729 + typebuf.tb_len] != NUL)
2730 typebuf.tb_noremap[typebuf.tb_off
2731 + typebuf.tb_len++] = RM_YES;
2732#ifdef USE_IM_CONTROL
2733 /* Get IM status right after getting keys, not after the
2734 * timeout for a mapping (focus may be lost by then). */
2735 vgetc_im_active = im_get_status();
2736#endif
2737 }
2738 } /* for (;;) */
2739 } /* if (!character from stuffbuf) */
2740
2741 /* if advance is FALSE don't loop on NULs */
2742 } while (c < 0 || (advance && c == NUL));
2743
2744 /*
2745 * The "INSERT" message is taken care of here:
2746 * if we return an ESC to exit insert mode, the message is deleted
2747 * if we don't return an ESC but deleted the message before, redisplay it
2748 */
Bram Moolenaar09df3122006-01-23 22:23:09 +00002749 if (advance && p_smd && msg_silent == 0 && (State & INSERT))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 {
Bram Moolenaar28c258f2006-01-25 22:02:51 +00002751 if (c == ESC && !mode_deleted && !no_mapping && mode_displayed)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 {
2753 if (typebuf.tb_len && !KeyTyped)
2754 redraw_cmdline = TRUE; /* delete mode later */
2755 else
2756 unshowmode(FALSE);
2757 }
2758 else if (c != ESC && mode_deleted)
2759 {
2760 if (typebuf.tb_len && !KeyTyped)
2761 redraw_cmdline = TRUE; /* show mode later */
2762 else
2763 showmode();
2764 }
2765 }
2766#ifdef FEAT_GUI
2767 /* may unshow different cursor shape */
2768 if (gui.in_use && shape_changed)
2769 gui_update_cursor(TRUE, FALSE);
2770#endif
2771
Bram Moolenaar5555acc2006-04-07 21:33:12 +00002772 --vgetc_busy;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773
2774 return c;
2775}
2776
2777/*
2778 * inchar() - get one character from
2779 * 1. a scriptfile
2780 * 2. the keyboard
2781 *
2782 * As much characters as we can get (upto 'maxlen') are put in "buf" and
2783 * NUL terminated (buffer length must be 'maxlen' + 1).
2784 * Minimum for "maxlen" is 3!!!!
2785 *
2786 * "tb_change_cnt" is the value of typebuf.tb_change_cnt if "buf" points into
2787 * it. When typebuf.tb_change_cnt changes (e.g., when a message is received
2788 * from a remote client) "buf" can no longer be used. "tb_change_cnt" is 0
2789 * otherwise.
2790 *
2791 * If we got an interrupt all input is read until none is available.
2792 *
2793 * If wait_time == 0 there is no waiting for the char.
2794 * If wait_time == n we wait for n msec for a character to arrive.
2795 * If wait_time == -1 we wait forever for a character to arrive.
2796 *
2797 * Return the number of obtained characters.
2798 * Return -1 when end of input script reached.
2799 */
2800 int
2801inchar(buf, maxlen, wait_time, tb_change_cnt)
2802 char_u *buf;
2803 int maxlen;
2804 long wait_time; /* milli seconds */
2805 int tb_change_cnt;
2806{
2807 int len = 0; /* init for GCC */
2808 int retesc = FALSE; /* return ESC with gotint */
2809 int script_char;
2810
2811 if (wait_time == -1L || wait_time > 100L) /* flush output before waiting */
2812 {
2813 cursor_on();
2814 out_flush();
2815#ifdef FEAT_GUI
2816 if (gui.in_use)
2817 {
2818 gui_update_cursor(FALSE, FALSE);
2819# ifdef FEAT_MOUSESHAPE
2820 if (postponed_mouseshape)
2821 update_mouseshape(-1);
2822# endif
2823 }
2824#endif
2825 }
2826
2827 /*
2828 * Don't reset these when at the hit-return prompt, otherwise a endless
2829 * recursive loop may result (write error in swapfile, hit-return, timeout
2830 * on char wait, flush swapfile, write error....).
2831 */
2832 if (State != HITRETURN)
2833 {
2834 did_outofmem_msg = FALSE; /* display out of memory message (again) */
2835 did_swapwrite_msg = FALSE; /* display swap file write error again */
2836 }
2837 undo_off = FALSE; /* restart undo now */
2838
2839 /*
2840 * first try script file
2841 * If interrupted: Stop reading script files.
2842 */
2843 script_char = -1;
2844 while (scriptin[curscript] != NULL && script_char < 0)
2845 {
2846 if (got_int || (script_char = getc(scriptin[curscript])) < 0)
2847 {
2848 /* Reached EOF.
2849 * Careful: closescript() frees typebuf.tb_buf[] and buf[] may
2850 * point inside typebuf.tb_buf[]. Don't use buf[] after this! */
2851 closescript();
2852 /*
2853 * When reading script file is interrupted, return an ESC to get
2854 * back to normal mode.
2855 * Otherwise return -1, because typebuf.tb_buf[] has changed.
2856 */
2857 if (got_int)
2858 retesc = TRUE;
2859 else
2860 return -1;
2861 }
2862 else
2863 {
2864 buf[0] = script_char;
2865 len = 1;
2866 }
2867 }
2868
2869 if (script_char < 0) /* did not get a character from script */
2870 {
2871 /*
2872 * If we got an interrupt, skip all previously typed characters and
2873 * return TRUE if quit reading script file.
2874 * Stop reading typeahead when a single CTRL-C was read,
2875 * fill_input_buf() returns this when not able to read from stdin.
2876 * Don't use buf[] here, closescript() may have freed typebuf.tb_buf[]
2877 * and buf may be pointing inside typebuf.tb_buf[].
2878 */
2879 if (got_int)
2880 {
2881#define DUM_LEN MAXMAPLEN * 3 + 3
2882 char_u dum[DUM_LEN + 1];
2883
2884 for (;;)
2885 {
2886 len = ui_inchar(dum, DUM_LEN, 0L, 0);
2887 if (len == 0 || (len == 1 && dum[0] == 3))
2888 break;
2889 }
2890 return retesc;
2891 }
2892
2893 /*
2894 * Always flush the output characters when getting input characters
2895 * from the user.
2896 */
2897 out_flush();
2898
2899 /*
2900 * Fill up to a third of the buffer, because each character may be
2901 * tripled below.
2902 */
2903 len = ui_inchar(buf, maxlen / 3, wait_time, tb_change_cnt);
2904 }
2905
2906 if (typebuf_changed(tb_change_cnt))
2907 return 0;
2908
2909 return fix_input_buffer(buf, len, script_char >= 0);
2910}
2911
2912/*
2913 * Fix typed characters for use by vgetc() and check_termcode().
2914 * buf[] must have room to triple the number of bytes!
2915 * Returns the new length.
2916 */
2917 int
2918fix_input_buffer(buf, len, script)
2919 char_u *buf;
2920 int len;
2921 int script; /* TRUE when reading from a script */
2922{
2923 int i;
2924 char_u *p = buf;
2925
2926 /*
2927 * Two characters are special: NUL and K_SPECIAL.
2928 * When compiled With the GUI CSI is also special.
2929 * Replace NUL by K_SPECIAL KS_ZERO KE_FILLER
2930 * Replace K_SPECIAL by K_SPECIAL KS_SPECIAL KE_FILLER
2931 * Replace CSI by K_SPECIAL KS_EXTRA KE_CSI
2932 * Don't replace K_SPECIAL when reading a script file.
2933 */
2934 for (i = len; --i >= 0; ++p)
2935 {
2936#ifdef FEAT_GUI
2937 /* When the GUI is used any character can come after a CSI, don't
2938 * escape it. */
2939 if (gui.in_use && p[0] == CSI && i >= 2)
2940 {
2941 p += 2;
2942 i -= 2;
2943 }
2944 /* When the GUI is not used CSI needs to be escaped. */
2945 else if (!gui.in_use && p[0] == CSI)
2946 {
2947 mch_memmove(p + 3, p + 1, (size_t)i);
2948 *p++ = K_SPECIAL;
2949 *p++ = KS_EXTRA;
2950 *p = (int)KE_CSI;
2951 len += 2;
2952 }
2953 else
2954#endif
2955 if (p[0] == NUL || (p[0] == K_SPECIAL && !script
Bram Moolenaar28a37ff2005-03-15 22:28:00 +00002956#ifdef FEAT_AUTOCMD
2957 /* timeout may generate K_CURSORHOLD */
2958 && (i < 2 || p[1] != KS_EXTRA || p[2] != (int)KE_CURSORHOLD)
2959#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960#if defined(WIN3264) && !defined(FEAT_GUI)
2961 /* Win32 console passes modifiers */
2962 && (i < 2 || p[1] != KS_MODIFIER)
2963#endif
2964 ))
2965 {
2966 mch_memmove(p + 3, p + 1, (size_t)i);
2967 p[2] = K_THIRD(p[0]);
2968 p[1] = K_SECOND(p[0]);
2969 p[0] = K_SPECIAL;
2970 p += 2;
2971 len += 2;
2972 }
2973 }
2974 *p = NUL; /* add trailing NUL */
2975 return len;
2976}
2977
2978#if defined(USE_INPUT_BUF) || defined(PROTO)
2979/*
2980 * Return TRUE when bytes are in the input buffer or in the typeahead buffer.
2981 * Normally the input buffer would be sufficient, but the server_to_input_buf()
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00002982 * or feedkeys() may insert characters in the typeahead buffer while we are
Bram Moolenaar4a85b412006-04-23 22:40:29 +00002983 * waiting for input to arrive.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 */
2985 int
2986input_available()
2987{
2988 return (!vim_is_input_buf_empty()
Bram Moolenaar4a85b412006-04-23 22:40:29 +00002989# if defined(FEAT_CLIENTSERVER) || defined(FEAT_EVAL)
2990 || typebuf_was_filled
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991# endif
2992 );
2993}
2994#endif
2995
2996/*
2997 * map[!] : show all key mappings
2998 * map[!] {lhs} : show key mapping for {lhs}
2999 * map[!] {lhs} {rhs} : set key mapping for {lhs} to {rhs}
3000 * noremap[!] {lhs} {rhs} : same, but no remapping for {rhs}
3001 * unmap[!] {lhs} : remove key mapping for {lhs}
3002 * abbr : show all abbreviations
3003 * abbr {lhs} : show abbreviations for {lhs}
3004 * abbr {lhs} {rhs} : set abbreviation for {lhs} to {rhs}
3005 * noreabbr {lhs} {rhs} : same, but no remapping for {rhs}
3006 * unabbr {lhs} : remove abbreviation for {lhs}
3007 *
3008 * maptype: 0 for :map, 1 for :unmap, 2 for noremap.
3009 *
3010 * arg is pointer to any arguments. Note: arg cannot be a read-only string,
3011 * it will be modified.
3012 *
Bram Moolenaar371d5402006-03-20 21:47:49 +00003013 * for :map mode is NORMAL + VISUAL + SELECTMODE + OP_PENDING
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 * for :map! mode is INSERT + CMDLINE
3015 * for :cmap mode is CMDLINE
3016 * for :imap mode is INSERT
3017 * for :lmap mode is LANGMAP
3018 * for :nmap mode is NORMAL
Bram Moolenaar371d5402006-03-20 21:47:49 +00003019 * for :vmap mode is VISUAL + SELECTMODE
3020 * for :xmap mode is VISUAL
3021 * for :smap mode is SELECTMODE
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 * for :omap mode is OP_PENDING
3023 *
3024 * for :abbr mode is INSERT + CMDLINE
3025 * for :iabbr mode is INSERT
3026 * for :cabbr mode is CMDLINE
3027 *
3028 * Return 0 for success
3029 * 1 for invalid arguments
3030 * 2 for no match
3031 * 4 for out of mem
3032 * 5 for entry not unique
3033 */
3034 int
3035do_map(maptype, arg, mode, abbrev)
3036 int maptype;
3037 char_u *arg;
3038 int mode;
3039 int abbrev; /* not a mapping but an abbreviation */
3040{
3041 char_u *keys;
3042 mapblock_T *mp, **mpp;
3043 char_u *rhs;
3044 char_u *p;
3045 int n;
3046 int len = 0; /* init for GCC */
3047 char_u *newstr;
3048 int hasarg;
3049 int haskey;
3050 int did_it = FALSE;
3051#ifdef FEAT_LOCALMAP
3052 int did_local = FALSE;
3053#endif
3054 int round;
3055 char_u *keys_buf = NULL;
3056 char_u *arg_buf = NULL;
3057 int retval = 0;
3058 int do_backslash;
3059 int hash;
3060 int new_hash;
3061 mapblock_T **abbr_table;
3062 mapblock_T **map_table;
3063 int unique = FALSE;
3064 int silent = FALSE;
Bram Moolenaar9c102382006-05-03 21:26:49 +00003065 int special = FALSE;
Bram Moolenaar4e427192006-03-10 21:34:27 +00003066#ifdef FEAT_EVAL
3067 int expr = FALSE;
3068#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069 int noremap;
3070
3071 keys = arg;
3072 map_table = maphash;
3073 abbr_table = &first_abbr;
3074
3075 /* For ":noremap" don't remap, otherwise do remap. */
3076 if (maptype == 2)
3077 noremap = REMAP_NONE;
3078 else
3079 noremap = REMAP_YES;
3080
Bram Moolenaar4e427192006-03-10 21:34:27 +00003081 /* Accept <buffer>, <silent>, <expr> <script> and <unique> in any order. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 for (;;)
3083 {
3084#ifdef FEAT_LOCALMAP
3085 /*
3086 * Check for "<buffer>": mapping local to buffer.
3087 */
3088 if (STRNCMP(keys, "<buffer>", 8) == 0)
3089 {
3090 keys = skipwhite(keys + 8);
3091 map_table = curbuf->b_maphash;
3092 abbr_table = &curbuf->b_first_abbr;
3093 continue;
3094 }
3095#endif
3096
3097 /*
3098 * Check for "<silent>": don't echo commands.
3099 */
3100 if (STRNCMP(keys, "<silent>", 8) == 0)
3101 {
3102 keys = skipwhite(keys + 8);
3103 silent = TRUE;
3104 continue;
3105 }
3106
Bram Moolenaar9c102382006-05-03 21:26:49 +00003107 /*
3108 * Check for "<special>": accept special keys in <>
3109 */
3110 if (STRNCMP(keys, "<special>", 9) == 0)
3111 {
3112 keys = skipwhite(keys + 9);
3113 special = TRUE;
3114 continue;
3115 }
3116
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117#ifdef FEAT_EVAL
3118 /*
3119 * Check for "<script>": remap script-local mappings only
3120 */
3121 if (STRNCMP(keys, "<script>", 8) == 0)
3122 {
3123 keys = skipwhite(keys + 8);
3124 noremap = REMAP_SCRIPT;
3125 continue;
3126 }
Bram Moolenaar4e427192006-03-10 21:34:27 +00003127
3128 /*
3129 * Check for "<expr>": {rhs} is an expression.
3130 */
3131 if (STRNCMP(keys, "<expr>", 6) == 0)
3132 {
3133 keys = skipwhite(keys + 6);
3134 expr = TRUE;
3135 continue;
3136 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137#endif
3138 /*
3139 * Check for "<unique>": don't overwrite an existing mapping.
3140 */
3141 if (STRNCMP(keys, "<unique>", 8) == 0)
3142 {
3143 keys = skipwhite(keys + 8);
3144 unique = TRUE;
3145 continue;
3146 }
3147 break;
3148 }
3149
3150 validate_maphash();
3151
3152 /*
3153 * find end of keys and skip CTRL-Vs (and backslashes) in it
3154 * Accept backslash like CTRL-V when 'cpoptions' does not contain 'B'.
3155 * with :unmap white space is included in the keys, no argument possible
3156 */
3157 p = keys;
3158 do_backslash = (vim_strchr(p_cpo, CPO_BSLASH) == NULL);
3159 while (*p && (maptype == 1 || !vim_iswhite(*p)))
3160 {
3161 if ((p[0] == Ctrl_V || (do_backslash && p[0] == '\\')) &&
3162 p[1] != NUL)
3163 ++p; /* skip CTRL-V or backslash */
3164 ++p;
3165 }
3166 if (*p != NUL)
3167 *p++ = NUL;
3168 p = skipwhite(p);
3169 rhs = p;
3170 hasarg = (*rhs != NUL);
3171 haskey = (*keys != NUL);
3172
3173 /* check for :unmap without argument */
3174 if (maptype == 1 && !haskey)
3175 {
3176 retval = 1;
3177 goto theend;
3178 }
3179
3180 /*
3181 * If mapping has been given as ^V<C_UP> say, then replace the term codes
3182 * with the appropriate two bytes. If it is a shifted special key, unshift
3183 * it too, giving another two bytes.
3184 * replace_termcodes() may move the result to allocated memory, which
3185 * needs to be freed later (*keys_buf and *arg_buf).
3186 * replace_termcodes() also removes CTRL-Vs and sometimes backslashes.
3187 */
3188 if (haskey)
Bram Moolenaar9c102382006-05-03 21:26:49 +00003189 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, special);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 if (hasarg)
3191 {
3192 if (STRICMP(rhs, "<nop>") == 0) /* "<Nop>" means nothing */
3193 rhs = (char_u *)"";
3194 else
Bram Moolenaar9c102382006-05-03 21:26:49 +00003195 rhs = replace_termcodes(rhs, &arg_buf, FALSE, TRUE, special);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 }
3197
3198#ifdef FEAT_FKMAP
3199 /*
3200 * when in right-to-left mode and alternate keymap option set,
3201 * reverse the character flow in the rhs in Farsi.
3202 */
3203 if (p_altkeymap && curwin->w_p_rl)
3204 lrswap(rhs);
3205#endif
3206
3207 /*
3208 * check arguments and translate function keys
3209 */
3210 if (haskey)
3211 {
3212 len = (int)STRLEN(keys);
3213 if (len > MAXMAPLEN) /* maximum length of MAXMAPLEN chars */
3214 {
3215 retval = 1;
3216 goto theend;
3217 }
3218
3219 if (abbrev && maptype != 1)
3220 {
3221 /*
3222 * If an abbreviation ends in a keyword character, the
3223 * rest must be all keyword-char or all non-keyword-char.
3224 * Otherwise we won't be able to find the start of it in a
3225 * vi-compatible way.
3226 */
3227#ifdef FEAT_MBYTE
3228 if (has_mbyte)
3229 {
3230 int first, last;
3231 int same = -1;
3232
3233 first = vim_iswordp(keys);
3234 last = first;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003235 p = keys + (*mb_ptr2len)(keys);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 n = 1;
3237 while (p < keys + len)
3238 {
3239 ++n; /* nr of (multi-byte) chars */
3240 last = vim_iswordp(p); /* type of last char */
3241 if (same == -1 && last != first)
3242 same = n - 1; /* count of same char type */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003243 p += (*mb_ptr2len)(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 }
3245 if (last && n > 2 && same >= 0 && same < n - 1)
3246 {
3247 retval = 1;
3248 goto theend;
3249 }
3250 }
3251 else
3252#endif
3253 if (vim_iswordc(keys[len - 1])) /* ends in keyword char */
3254 for (n = 0; n < len - 2; ++n)
3255 if (vim_iswordc(keys[n]) != vim_iswordc(keys[len - 2]))
3256 {
3257 retval = 1;
3258 goto theend;
3259 }
3260 /* An abbrevation cannot contain white space. */
3261 for (n = 0; n < len; ++n)
3262 if (vim_iswhite(keys[n]))
3263 {
3264 retval = 1;
3265 goto theend;
3266 }
3267 }
3268 }
3269
3270 if (haskey && hasarg && abbrev) /* if we will add an abbreviation */
3271 no_abbr = FALSE; /* reset flag that indicates there are
3272 no abbreviations */
3273
3274 if (!haskey || (maptype != 1 && !hasarg))
3275 msg_start();
3276
3277#ifdef FEAT_LOCALMAP
3278 /*
3279 * Check if a new local mapping wasn't already defined globally.
3280 */
3281 if (map_table == curbuf->b_maphash && haskey && hasarg && maptype != 1)
3282 {
3283 /* need to loop over all global hash lists */
3284 for (hash = 0; hash < 256 && !got_int; ++hash)
3285 {
3286 if (abbrev)
3287 {
3288 if (hash != 0) /* there is only one abbreviation list */
3289 break;
3290 mp = first_abbr;
3291 }
3292 else
3293 mp = maphash[hash];
3294 for ( ; mp != NULL && !got_int; mp = mp->m_next)
3295 {
3296 /* check entries with the same mode */
3297 if ((mp->m_mode & mode) != 0
3298 && mp->m_keylen == len
3299 && unique
3300 && STRNCMP(mp->m_keys, keys, (size_t)len) == 0)
3301 {
3302 if (abbrev)
3303 EMSG2(_("E224: global abbreviation already exists for %s"),
3304 mp->m_keys);
3305 else
3306 EMSG2(_("E225: global mapping already exists for %s"),
3307 mp->m_keys);
3308 retval = 5;
3309 goto theend;
3310 }
3311 }
3312 }
3313 }
3314
3315 /*
3316 * When listing global mappings, also list buffer-local ones here.
3317 */
3318 if (map_table != curbuf->b_maphash && !hasarg && maptype != 1)
3319 {
3320 /* need to loop over all global hash lists */
3321 for (hash = 0; hash < 256 && !got_int; ++hash)
3322 {
3323 if (abbrev)
3324 {
3325 if (hash != 0) /* there is only one abbreviation list */
3326 break;
3327 mp = curbuf->b_first_abbr;
3328 }
3329 else
3330 mp = curbuf->b_maphash[hash];
3331 for ( ; mp != NULL && !got_int; mp = mp->m_next)
3332 {
3333 /* check entries with the same mode */
3334 if ((mp->m_mode & mode) != 0)
3335 {
3336 if (!haskey) /* show all entries */
3337 {
3338 showmap(mp, TRUE);
3339 did_local = TRUE;
3340 }
3341 else
3342 {
3343 n = mp->m_keylen;
3344 if (STRNCMP(mp->m_keys, keys,
3345 (size_t)(n < len ? n : len)) == 0)
3346 {
3347 showmap(mp, TRUE);
3348 did_local = TRUE;
3349 }
3350 }
3351 }
3352 }
3353 }
3354 }
3355#endif
3356
3357 /*
3358 * Find an entry in the maphash[] list that matches.
3359 * For :unmap we may loop two times: once to try to unmap an entry with a
3360 * matching 'from' part, a second time, if the first fails, to unmap an
3361 * entry with a matching 'to' part. This was done to allow ":ab foo bar"
3362 * to be unmapped by typing ":unab foo", where "foo" will be replaced by
3363 * "bar" because of the abbreviation.
3364 */
3365 for (round = 0; (round == 0 || maptype == 1) && round <= 1
3366 && !did_it && !got_int; ++round)
3367 {
3368 /* need to loop over all hash lists */
3369 for (hash = 0; hash < 256 && !got_int; ++hash)
3370 {
3371 if (abbrev)
3372 {
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00003373 if (hash > 0) /* there is only one abbreviation list */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 break;
3375 mpp = abbr_table;
3376 }
3377 else
3378 mpp = &(map_table[hash]);
3379 for (mp = *mpp; mp != NULL && !got_int; mp = *mpp)
3380 {
3381
3382 if (!(mp->m_mode & mode)) /* skip entries with wrong mode */
3383 {
3384 mpp = &(mp->m_next);
3385 continue;
3386 }
3387 if (!haskey) /* show all entries */
3388 {
3389 showmap(mp, map_table != maphash);
3390 did_it = TRUE;
3391 }
3392 else /* do we have a match? */
3393 {
3394 if (round) /* second round: Try unmap "rhs" string */
3395 {
3396 n = (int)STRLEN(mp->m_str);
3397 p = mp->m_str;
3398 }
3399 else
3400 {
3401 n = mp->m_keylen;
3402 p = mp->m_keys;
3403 }
3404 if (STRNCMP(p, keys, (size_t)(n < len ? n : len)) == 0)
3405 {
3406 if (maptype == 1) /* delete entry */
3407 {
3408 /* Only accept a full match. For abbreviations we
3409 * ignore trailing space when matching with the
3410 * "lhs", since an abbreviation can't have
3411 * trailing space. */
3412 if (n != len && (!abbrev || round || n > len
3413 || *skipwhite(keys + n) != NUL))
3414 {
3415 mpp = &(mp->m_next);
3416 continue;
3417 }
3418 /*
3419 * We reset the indicated mode bits. If nothing is
3420 * left the entry is deleted below.
3421 */
3422 mp->m_mode &= ~mode;
3423 did_it = TRUE; /* remember we did something */
3424 }
3425 else if (!hasarg) /* show matching entry */
3426 {
3427 showmap(mp, map_table != maphash);
3428 did_it = TRUE;
3429 }
Bram Moolenaarb6799ac2007-05-10 16:44:05 +00003430 else if (n != len) /* new entry is ambiguous */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 {
3432 mpp = &(mp->m_next);
3433 continue;
3434 }
3435 else if (unique)
3436 {
3437 if (abbrev)
3438 EMSG2(_("E226: abbreviation already exists for %s"),
3439 p);
3440 else
3441 EMSG2(_("E227: mapping already exists for %s"), p);
3442 retval = 5;
3443 goto theend;
3444 }
3445 else /* new rhs for existing entry */
3446 {
3447 mp->m_mode &= ~mode; /* remove mode bits */
3448 if (mp->m_mode == 0 && !did_it) /* reuse entry */
3449 {
3450 newstr = vim_strsave(rhs);
3451 if (newstr == NULL)
3452 {
3453 retval = 4; /* no mem */
3454 goto theend;
3455 }
3456 vim_free(mp->m_str);
3457 mp->m_str = newstr;
3458 mp->m_noremap = noremap;
3459 mp->m_silent = silent;
3460 mp->m_mode = mode;
Bram Moolenaarae5bce12005-08-15 21:41:48 +00003461#ifdef FEAT_EVAL
Bram Moolenaar4e427192006-03-10 21:34:27 +00003462 mp->m_expr = expr;
Bram Moolenaarae5bce12005-08-15 21:41:48 +00003463 mp->m_script_ID = current_SID;
3464#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 did_it = TRUE;
3466 }
3467 }
3468 if (mp->m_mode == 0) /* entry can be deleted */
3469 {
3470 map_free(mpp);
3471 continue; /* continue with *mpp */
3472 }
3473
3474 /*
3475 * May need to put this entry into another hash list.
3476 */
3477 new_hash = MAP_HASH(mp->m_mode, mp->m_keys[0]);
3478 if (!abbrev && new_hash != hash)
3479 {
3480 *mpp = mp->m_next;
3481 mp->m_next = map_table[new_hash];
3482 map_table[new_hash] = mp;
3483
3484 continue; /* continue with *mpp */
3485 }
3486 }
3487 }
3488 mpp = &(mp->m_next);
3489 }
3490 }
3491 }
3492
3493 if (maptype == 1) /* delete entry */
3494 {
3495 if (!did_it)
3496 retval = 2; /* no match */
3497 goto theend;
3498 }
3499
3500 if (!haskey || !hasarg) /* print entries */
3501 {
3502 if (!did_it
3503#ifdef FEAT_LOCALMAP
3504 && !did_local
3505#endif
3506 )
3507 {
3508 if (abbrev)
3509 MSG(_("No abbreviation found"));
3510 else
3511 MSG(_("No mapping found"));
3512 }
3513 goto theend; /* listing finished */
3514 }
3515
3516 if (did_it) /* have added the new entry already */
3517 goto theend;
3518
3519 /*
3520 * Get here when adding a new entry to the maphash[] list or abbrlist.
3521 */
3522 mp = (mapblock_T *)alloc((unsigned)sizeof(mapblock_T));
3523 if (mp == NULL)
3524 {
3525 retval = 4; /* no mem */
3526 goto theend;
3527 }
3528
3529 /* If CTRL-C has been mapped, don't always use it for Interrupting */
3530 if (*keys == Ctrl_C)
3531 mapped_ctrl_c = TRUE;
3532
3533 mp->m_keys = vim_strsave(keys);
3534 mp->m_str = vim_strsave(rhs);
3535 if (mp->m_keys == NULL || mp->m_str == NULL)
3536 {
3537 vim_free(mp->m_keys);
3538 vim_free(mp->m_str);
3539 vim_free(mp);
3540 retval = 4; /* no mem */
3541 goto theend;
3542 }
3543 mp->m_keylen = (int)STRLEN(mp->m_keys);
3544 mp->m_noremap = noremap;
3545 mp->m_silent = silent;
3546 mp->m_mode = mode;
Bram Moolenaarae5bce12005-08-15 21:41:48 +00003547#ifdef FEAT_EVAL
Bram Moolenaar4e427192006-03-10 21:34:27 +00003548 mp->m_expr = expr;
Bram Moolenaarae5bce12005-08-15 21:41:48 +00003549 mp->m_script_ID = current_SID;
3550#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551
3552 /* add the new entry in front of the abbrlist or maphash[] list */
3553 if (abbrev)
3554 {
3555 mp->m_next = *abbr_table;
3556 *abbr_table = mp;
3557 }
3558 else
3559 {
3560 n = MAP_HASH(mp->m_mode, mp->m_keys[0]);
3561 mp->m_next = map_table[n];
3562 map_table[n] = mp;
3563 }
3564
3565theend:
3566 vim_free(keys_buf);
3567 vim_free(arg_buf);
3568 return retval;
3569}
3570
3571/*
3572 * Delete one entry from the abbrlist or maphash[].
3573 * "mpp" is a pointer to the m_next field of the PREVIOUS entry!
3574 */
3575 static void
3576map_free(mpp)
3577 mapblock_T **mpp;
3578{
3579 mapblock_T *mp;
3580
3581 mp = *mpp;
3582 vim_free(mp->m_keys);
3583 vim_free(mp->m_str);
3584 *mpp = mp->m_next;
3585 vim_free(mp);
3586}
3587
3588/*
3589 * Initialize maphash[] for first use.
3590 */
3591 static void
3592validate_maphash()
3593{
3594 if (!maphash_valid)
3595 {
3596 vim_memset(maphash, 0, sizeof(maphash));
3597 maphash_valid = TRUE;
3598 }
3599}
3600
3601/*
3602 * Get the mapping mode from the command name.
3603 */
3604 int
3605get_map_mode(cmdp, forceit)
3606 char_u **cmdp;
3607 int forceit;
3608{
3609 char_u *p;
3610 int modec;
3611 int mode;
3612
3613 p = *cmdp;
3614 modec = *p++;
3615 if (modec == 'i')
3616 mode = INSERT; /* :imap */
3617 else if (modec == 'l')
3618 mode = LANGMAP; /* :lmap */
3619 else if (modec == 'c')
3620 mode = CMDLINE; /* :cmap */
3621 else if (modec == 'n' && *p != 'o') /* avoid :noremap */
3622 mode = NORMAL; /* :nmap */
3623 else if (modec == 'v')
Bram Moolenaar371d5402006-03-20 21:47:49 +00003624 mode = VISUAL + SELECTMODE; /* :vmap */
3625 else if (modec == 'x')
3626 mode = VISUAL; /* :xmap */
3627 else if (modec == 's')
3628 mode = SELECTMODE; /* :smap */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 else if (modec == 'o')
3630 mode = OP_PENDING; /* :omap */
3631 else
3632 {
3633 --p;
3634 if (forceit)
3635 mode = INSERT + CMDLINE; /* :map ! */
3636 else
Bram Moolenaar371d5402006-03-20 21:47:49 +00003637 mode = VISUAL + SELECTMODE + NORMAL + OP_PENDING;/* :map */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 }
3639
3640 *cmdp = p;
3641 return mode;
3642}
3643
3644/*
3645 * Clear all mappings or abbreviations.
3646 * 'abbr' should be FALSE for mappings, TRUE for abbreviations.
3647 */
3648/*ARGSUSED*/
3649 void
3650map_clear(cmdp, arg, forceit, abbr)
3651 char_u *cmdp;
3652 char_u *arg;
3653 int forceit;
3654 int abbr;
3655{
3656 int mode;
3657#ifdef FEAT_LOCALMAP
3658 int local;
3659
3660 local = (STRCMP(arg, "<buffer>") == 0);
3661 if (!local && *arg != NUL)
3662 {
3663 EMSG(_(e_invarg));
3664 return;
3665 }
3666#endif
3667
3668 mode = get_map_mode(&cmdp, forceit);
3669 map_clear_int(curbuf, mode,
3670#ifdef FEAT_LOCALMAP
3671 local,
3672#else
3673 FALSE,
3674#endif
3675 abbr);
3676}
3677
3678/*
3679 * Clear all mappings in "mode".
3680 */
3681/*ARGSUSED*/
3682 void
3683map_clear_int(buf, mode, local, abbr)
3684 buf_T *buf; /* buffer for local mappings */
3685 int mode; /* mode in which to delete */
3686 int local; /* TRUE for buffer-local mappings */
3687 int abbr; /* TRUE for abbreviations */
3688{
3689 mapblock_T *mp, **mpp;
3690 int hash;
3691 int new_hash;
3692
3693 validate_maphash();
3694
3695 for (hash = 0; hash < 256; ++hash)
3696 {
3697 if (abbr)
3698 {
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00003699 if (hash > 0) /* there is only one abbrlist */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 break;
3701#ifdef FEAT_LOCALMAP
3702 if (local)
3703 mpp = &buf->b_first_abbr;
3704 else
3705#endif
3706 mpp = &first_abbr;
3707 }
3708 else
3709 {
3710#ifdef FEAT_LOCALMAP
3711 if (local)
3712 mpp = &buf->b_maphash[hash];
3713 else
3714#endif
3715 mpp = &maphash[hash];
3716 }
3717 while (*mpp != NULL)
3718 {
3719 mp = *mpp;
3720 if (mp->m_mode & mode)
3721 {
3722 mp->m_mode &= ~mode;
3723 if (mp->m_mode == 0) /* entry can be deleted */
3724 {
3725 map_free(mpp);
3726 continue;
3727 }
3728 /*
3729 * May need to put this entry into another hash list.
3730 */
3731 new_hash = MAP_HASH(mp->m_mode, mp->m_keys[0]);
3732 if (!abbr && new_hash != hash)
3733 {
3734 *mpp = mp->m_next;
3735#ifdef FEAT_LOCALMAP
3736 if (local)
3737 {
3738 mp->m_next = buf->b_maphash[new_hash];
3739 buf->b_maphash[new_hash] = mp;
3740 }
3741 else
3742#endif
3743 {
3744 mp->m_next = maphash[new_hash];
3745 maphash[new_hash] = mp;
3746 }
3747 continue; /* continue with *mpp */
3748 }
3749 }
3750 mpp = &(mp->m_next);
3751 }
3752 }
3753}
3754
3755 static void
3756showmap(mp, local)
3757 mapblock_T *mp;
3758 int local; /* TRUE for buffer-local map */
3759{
3760 int len = 1;
3761
3762 if (msg_didout || msg_silent != 0)
3763 msg_putchar('\n');
3764 if ((mp->m_mode & (INSERT + CMDLINE)) == INSERT + CMDLINE)
3765 msg_putchar('!'); /* :map! */
3766 else if (mp->m_mode & INSERT)
3767 msg_putchar('i'); /* :imap */
3768 else if (mp->m_mode & LANGMAP)
3769 msg_putchar('l'); /* :lmap */
3770 else if (mp->m_mode & CMDLINE)
3771 msg_putchar('c'); /* :cmap */
Bram Moolenaar371d5402006-03-20 21:47:49 +00003772 else if ((mp->m_mode & (NORMAL + VISUAL + SELECTMODE + OP_PENDING))
3773 == NORMAL + VISUAL + SELECTMODE + OP_PENDING)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 msg_putchar(' '); /* :map */
3775 else
3776 {
3777 len = 0;
3778 if (mp->m_mode & NORMAL)
3779 {
3780 msg_putchar('n'); /* :nmap */
3781 ++len;
3782 }
3783 if (mp->m_mode & OP_PENDING)
3784 {
3785 msg_putchar('o'); /* :omap */
3786 ++len;
3787 }
Bram Moolenaar371d5402006-03-20 21:47:49 +00003788 if ((mp->m_mode & (VISUAL + SELECTMODE)) == VISUAL + SELECTMODE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 {
3790 msg_putchar('v'); /* :vmap */
3791 ++len;
3792 }
Bram Moolenaar371d5402006-03-20 21:47:49 +00003793 else
3794 {
3795 if (mp->m_mode & VISUAL)
3796 {
3797 msg_putchar('x'); /* :xmap */
3798 ++len;
3799 }
3800 if (mp->m_mode & SELECTMODE)
3801 {
3802 msg_putchar('s'); /* :smap */
3803 ++len;
3804 }
3805 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 }
3807 while (++len <= 3)
3808 msg_putchar(' ');
3809
3810 /* Get length of what we write */
3811 len = msg_outtrans_special(mp->m_keys, TRUE);
3812 do
3813 {
3814 msg_putchar(' '); /* padd with blanks */
3815 ++len;
3816 } while (len < 12);
3817
3818 if (mp->m_noremap == REMAP_NONE)
3819 msg_puts_attr((char_u *)"*", hl_attr(HLF_8));
3820 else if (mp->m_noremap == REMAP_SCRIPT)
3821 msg_puts_attr((char_u *)"&", hl_attr(HLF_8));
3822 else
3823 msg_putchar(' ');
3824
3825 if (local)
3826 msg_putchar('@');
3827 else
3828 msg_putchar(' ');
3829
3830 /* Use FALSE below if we only want things like <Up> to show up as such on
3831 * the rhs, and not M-x etc, TRUE gets both -- webb
3832 */
3833 if (*mp->m_str == NUL)
3834 msg_puts_attr((char_u *)"<Nop>", hl_attr(HLF_8));
3835 else
3836 msg_outtrans_special(mp->m_str, FALSE);
Bram Moolenaarae5bce12005-08-15 21:41:48 +00003837#ifdef FEAT_EVAL
3838 if (p_verbose > 0)
3839 last_set_msg(mp->m_script_ID);
3840#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 out_flush(); /* show one line at a time */
3842}
3843
3844#if defined(FEAT_EVAL) || defined(PROTO)
3845/*
3846 * Return TRUE if a map exists that has "str" in the rhs for mode "modechars".
3847 * Recognize termcap codes in "str".
3848 * Also checks mappings local to the current buffer.
3849 */
3850 int
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00003851map_to_exists(str, modechars, abbr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 char_u *str;
3853 char_u *modechars;
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00003854 int abbr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855{
3856 int mode = 0;
3857 char_u *rhs;
3858 char_u *buf;
3859 int retval;
3860
Bram Moolenaar9c102382006-05-03 21:26:49 +00003861 rhs = replace_termcodes(str, &buf, FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862
3863 if (vim_strchr(modechars, 'n') != NULL)
3864 mode |= NORMAL;
3865 if (vim_strchr(modechars, 'v') != NULL)
Bram Moolenaar371d5402006-03-20 21:47:49 +00003866 mode |= VISUAL + SELECTMODE;
3867 if (vim_strchr(modechars, 'x') != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868 mode |= VISUAL;
Bram Moolenaar371d5402006-03-20 21:47:49 +00003869 if (vim_strchr(modechars, 's') != NULL)
3870 mode |= SELECTMODE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 if (vim_strchr(modechars, 'o') != NULL)
3872 mode |= OP_PENDING;
3873 if (vim_strchr(modechars, 'i') != NULL)
3874 mode |= INSERT;
3875 if (vim_strchr(modechars, 'l') != NULL)
3876 mode |= LANGMAP;
3877 if (vim_strchr(modechars, 'c') != NULL)
3878 mode |= CMDLINE;
3879
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00003880 retval = map_to_exists_mode(rhs, mode, abbr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 vim_free(buf);
3882
3883 return retval;
3884}
3885#endif
3886
3887/*
3888 * Return TRUE if a map exists that has "str" in the rhs for mode "mode".
3889 * Also checks mappings local to the current buffer.
3890 */
3891 int
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00003892map_to_exists_mode(rhs, mode, abbr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 char_u *rhs;
3894 int mode;
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00003895 int abbr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896{
3897 mapblock_T *mp;
3898 int hash;
3899# ifdef FEAT_LOCALMAP
3900 int expand_buffer = FALSE;
3901
3902 validate_maphash();
3903
3904 /* Do it twice: once for global maps and once for local maps. */
3905 for (;;)
3906 {
3907# endif
3908 for (hash = 0; hash < 256; ++hash)
3909 {
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00003910 if (abbr)
3911 {
3912 if (hash > 0) /* there is only one abbr list */
3913 break;
3914#ifdef FEAT_LOCALMAP
3915 if (expand_buffer)
3916 mp = curbuf->b_first_abbr;
3917 else
3918#endif
3919 mp = first_abbr;
3920 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921# ifdef FEAT_LOCALMAP
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00003922 else if (expand_buffer)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 mp = curbuf->b_maphash[hash];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924# endif
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00003925 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 mp = maphash[hash];
3927 for (; mp; mp = mp->m_next)
3928 {
3929 if ((mp->m_mode & mode)
3930 && strstr((char *)mp->m_str, (char *)rhs) != NULL)
3931 return TRUE;
3932 }
3933 }
3934# ifdef FEAT_LOCALMAP
3935 if (expand_buffer)
3936 break;
3937 expand_buffer = TRUE;
3938 }
3939# endif
3940
3941 return FALSE;
3942}
3943
3944#if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3945/*
3946 * Used below when expanding mapping/abbreviation names.
3947 */
3948static int expand_mapmodes = 0;
3949static int expand_isabbrev = 0;
3950#ifdef FEAT_LOCALMAP
3951static int expand_buffer = FALSE;
3952#endif
3953
3954/*
3955 * Work out what to complete when doing command line completion of mapping
3956 * or abbreviation names.
3957 */
3958 char_u *
3959set_context_in_map_cmd(xp, cmd, arg, forceit, isabbrev, isunmap, cmdidx)
3960 expand_T *xp;
3961 char_u *cmd;
3962 char_u *arg;
3963 int forceit; /* TRUE if '!' given */
3964 int isabbrev; /* TRUE if abbreviation */
3965 int isunmap; /* TRUE if unmap/unabbrev command */
3966 cmdidx_T cmdidx;
3967{
3968 if (forceit && cmdidx != CMD_map && cmdidx != CMD_unmap)
3969 xp->xp_context = EXPAND_NOTHING;
3970 else
3971 {
3972 if (isunmap)
3973 expand_mapmodes = get_map_mode(&cmd, forceit || isabbrev);
3974 else
3975 {
3976 expand_mapmodes = INSERT + CMDLINE;
3977 if (!isabbrev)
Bram Moolenaar371d5402006-03-20 21:47:49 +00003978 expand_mapmodes += VISUAL + SELECTMODE + NORMAL + OP_PENDING;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 }
3980 expand_isabbrev = isabbrev;
3981 xp->xp_context = EXPAND_MAPPINGS;
3982#ifdef FEAT_LOCALMAP
3983 expand_buffer = FALSE;
3984#endif
3985 for (;;)
3986 {
3987#ifdef FEAT_LOCALMAP
3988 if (STRNCMP(arg, "<buffer>", 8) == 0)
3989 {
3990 expand_buffer = TRUE;
3991 arg = skipwhite(arg + 8);
3992 continue;
3993 }
3994#endif
3995 if (STRNCMP(arg, "<unique>", 8) == 0)
3996 {
3997 arg = skipwhite(arg + 8);
3998 continue;
3999 }
4000 if (STRNCMP(arg, "<silent>", 8) == 0)
4001 {
4002 arg = skipwhite(arg + 8);
4003 continue;
4004 }
Bram Moolenaar4e427192006-03-10 21:34:27 +00004005#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 if (STRNCMP(arg, "<script>", 8) == 0)
4007 {
4008 arg = skipwhite(arg + 8);
4009 continue;
4010 }
Bram Moolenaar4e427192006-03-10 21:34:27 +00004011 if (STRNCMP(arg, "<expr>", 6) == 0)
4012 {
4013 arg = skipwhite(arg + 6);
4014 continue;
4015 }
4016#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 break;
4018 }
4019 xp->xp_pattern = arg;
4020 }
4021
4022 return NULL;
4023}
4024
4025/*
4026 * Find all mapping/abbreviation names that match regexp 'prog'.
4027 * For command line expansion of ":[un]map" and ":[un]abbrev" in all modes.
4028 * Return OK if matches found, FAIL otherwise.
4029 */
4030 int
4031ExpandMappings(regmatch, num_file, file)
4032 regmatch_T *regmatch;
4033 int *num_file;
4034 char_u ***file;
4035{
4036 mapblock_T *mp;
4037 int hash;
4038 int count;
4039 int round;
4040 char_u *p;
4041 int i;
4042
4043 validate_maphash();
4044
4045 *num_file = 0; /* return values in case of FAIL */
4046 *file = NULL;
4047
4048 /*
4049 * round == 1: Count the matches.
4050 * round == 2: Build the array to keep the matches.
4051 */
4052 for (round = 1; round <= 2; ++round)
4053 {
4054 count = 0;
4055
Bram Moolenaar4e427192006-03-10 21:34:27 +00004056 for (i = 0; i < 5; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 {
4058 if (i == 0)
4059 p = (char_u *)"<silent>";
4060 else if (i == 1)
4061 p = (char_u *)"<unique>";
4062#ifdef FEAT_EVAL
4063 else if (i == 2)
4064 p = (char_u *)"<script>";
Bram Moolenaar4e427192006-03-10 21:34:27 +00004065 else if (i == 3)
4066 p = (char_u *)"<expr>";
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067#endif
4068#ifdef FEAT_LOCALMAP
Bram Moolenaar4e427192006-03-10 21:34:27 +00004069 else if (i == 4 && !expand_buffer)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 p = (char_u *)"<buffer>";
4071#endif
4072 else
4073 continue;
4074
4075 if (vim_regexec(regmatch, p, (colnr_T)0))
4076 {
4077 if (round == 1)
4078 ++count;
4079 else
4080 (*file)[count++] = vim_strsave(p);
4081 }
4082 }
4083
4084 for (hash = 0; hash < 256; ++hash)
4085 {
4086 if (expand_isabbrev)
4087 {
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00004088 if (hash > 0) /* only one abbrev list */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 break; /* for (hash) */
4090 mp = first_abbr;
4091 }
4092#ifdef FEAT_LOCALMAP
4093 else if (expand_buffer)
4094 mp = curbuf->b_maphash[hash];
4095#endif
4096 else
4097 mp = maphash[hash];
4098 for (; mp; mp = mp->m_next)
4099 {
4100 if (mp->m_mode & expand_mapmodes)
4101 {
4102 p = translate_mapping(mp->m_keys, TRUE);
4103 if (p != NULL && vim_regexec(regmatch, p, (colnr_T)0))
4104 {
4105 if (round == 1)
4106 ++count;
4107 else
4108 {
4109 (*file)[count++] = p;
4110 p = NULL;
4111 }
4112 }
4113 vim_free(p);
4114 }
4115 } /* for (mp) */
4116 } /* for (hash) */
4117
4118 if (count == 0) /* no match found */
4119 break; /* for (round) */
4120
4121 if (round == 1)
4122 {
4123 *file = (char_u **)alloc((unsigned)(count * sizeof(char_u *)));
4124 if (*file == NULL)
4125 return FAIL;
4126 }
4127 } /* for (round) */
4128
Bram Moolenaareb3593b2006-04-22 22:33:57 +00004129 if (count > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 {
Bram Moolenaareb3593b2006-04-22 22:33:57 +00004131 char_u **ptr1;
4132 char_u **ptr2;
4133 char_u **ptr3;
4134
4135 /* Sort the matches */
4136 sort_strings(*file, count);
4137
4138 /* Remove multiple entries */
4139 ptr1 = *file;
4140 ptr2 = ptr1 + 1;
4141 ptr3 = ptr1 + count;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142
4143 while (ptr2 < ptr3)
4144 {
4145 if (STRCMP(*ptr1, *ptr2))
4146 *++ptr1 = *ptr2++;
4147 else
4148 {
4149 vim_free(*ptr2++);
4150 count--;
4151 }
4152 }
4153 }
4154
4155 *num_file = count;
4156 return (count == 0 ? FAIL : OK);
4157}
4158#endif /* FEAT_CMDL_COMPL */
4159
4160/*
4161 * Check for an abbreviation.
4162 * Cursor is at ptr[col]. When inserting, mincol is where insert started.
4163 * "c" is the character typed before check_abbr was called. It may have
4164 * ABBR_OFF added to avoid prepending a CTRL-V to it.
4165 *
4166 * Historic vi practice: The last character of an abbreviation must be an id
4167 * character ([a-zA-Z0-9_]). The characters in front of it must be all id
4168 * characters or all non-id characters. This allows for abbr. "#i" to
4169 * "#include".
4170 *
4171 * Vim addition: Allow for abbreviations that end in a non-keyword character.
4172 * Then there must be white space before the abbr.
4173 *
4174 * return TRUE if there is an abbreviation, FALSE if not
4175 */
4176 int
4177check_abbr(c, ptr, col, mincol)
4178 int c;
4179 char_u *ptr;
4180 int col;
4181 int mincol;
4182{
4183 int len;
4184 int scol; /* starting column of the abbr. */
4185 int j;
Bram Moolenaar4e427192006-03-10 21:34:27 +00004186 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187#ifdef FEAT_MBYTE
4188 char_u tb[MB_MAXBYTES + 4];
4189#else
4190 char_u tb[4];
4191#endif
4192 mapblock_T *mp;
4193#ifdef FEAT_LOCALMAP
4194 mapblock_T *mp2;
4195#endif
4196#ifdef FEAT_MBYTE
4197 int clen = 0; /* length in characters */
4198#endif
4199 int is_id = TRUE;
4200 int vim_abbr;
4201
4202 if (typebuf.tb_no_abbr_cnt) /* abbrev. are not recursive */
4203 return FALSE;
Bram Moolenaarcf8e7d12006-12-05 20:43:17 +00004204 if ((KeyNoremap & (RM_NONE|RM_SCRIPT)) != 0)
4205 /* no remapping implies no abbreviation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 return FALSE;
4207
4208 /*
4209 * Check for word before the cursor: If it ends in a keyword char all
4210 * chars before it must be al keyword chars or non-keyword chars, but not
4211 * white space. If it ends in a non-keyword char we accept any characters
4212 * before it except white space.
4213 */
4214 if (col == 0) /* cannot be an abbr. */
4215 return FALSE;
4216
4217#ifdef FEAT_MBYTE
4218 if (has_mbyte)
4219 {
4220 char_u *p;
4221
4222 p = mb_prevptr(ptr, ptr + col);
4223 if (!vim_iswordp(p))
4224 vim_abbr = TRUE; /* Vim added abbr. */
4225 else
4226 {
4227 vim_abbr = FALSE; /* vi compatible abbr. */
4228 if (p > ptr)
4229 is_id = vim_iswordp(mb_prevptr(ptr, p));
4230 }
4231 clen = 1;
4232 while (p > ptr + mincol)
4233 {
4234 p = mb_prevptr(ptr, p);
4235 if (vim_isspace(*p) || (!vim_abbr && is_id != vim_iswordp(p)))
4236 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00004237 p += (*mb_ptr2len)(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238 break;
4239 }
4240 ++clen;
4241 }
4242 scol = (int)(p - ptr);
4243 }
4244 else
4245#endif
4246 {
4247 if (!vim_iswordc(ptr[col - 1]))
4248 vim_abbr = TRUE; /* Vim added abbr. */
4249 else
4250 {
4251 vim_abbr = FALSE; /* vi compatible abbr. */
4252 if (col > 1)
4253 is_id = vim_iswordc(ptr[col - 2]);
4254 }
4255 for (scol = col - 1; scol > 0 && !vim_isspace(ptr[scol - 1])
4256 && (vim_abbr || is_id == vim_iswordc(ptr[scol - 1])); --scol)
4257 ;
4258 }
4259
4260 if (scol < mincol)
4261 scol = mincol;
4262 if (scol < col) /* there is a word in front of the cursor */
4263 {
4264 ptr += scol;
4265 len = col - scol;
4266#ifdef FEAT_LOCALMAP
4267 mp = curbuf->b_first_abbr;
4268 mp2 = first_abbr;
4269 if (mp == NULL)
4270 {
4271 mp = mp2;
4272 mp2 = NULL;
4273 }
4274#else
4275 mp = first_abbr;
4276#endif
4277 for ( ; mp;
4278#ifdef FEAT_LOCALMAP
4279 mp->m_next == NULL ? (mp = mp2, mp2 = NULL) :
4280#endif
4281 (mp = mp->m_next))
4282 {
4283 /* find entries with right mode and keys */
4284 if ( (mp->m_mode & State)
4285 && mp->m_keylen == len
4286 && !STRNCMP(mp->m_keys, ptr, (size_t)len))
4287 break;
4288 }
4289 if (mp != NULL)
4290 {
4291 /*
4292 * Found a match:
4293 * Insert the rest of the abbreviation in typebuf.tb_buf[].
4294 * This goes from end to start.
4295 *
4296 * Characters 0x000 - 0x100: normal chars, may need CTRL-V,
4297 * except K_SPECIAL: Becomes K_SPECIAL KS_SPECIAL KE_FILLER
4298 * Characters where IS_SPECIAL() == TRUE: key codes, need
4299 * K_SPECIAL. Other characters (with ABBR_OFF): don't use CTRL-V.
4300 *
4301 * Character CTRL-] is treated specially - it completes the
4302 * abbreviation, but is not inserted into the input stream.
4303 */
4304 j = 0;
4305 /* special key code, split up */
4306 if (c != Ctrl_RSB)
4307 {
4308 if (IS_SPECIAL(c) || c == K_SPECIAL)
4309 {
4310 tb[j++] = K_SPECIAL;
4311 tb[j++] = K_SECOND(c);
4312 tb[j++] = K_THIRD(c);
4313 }
4314 else
4315 {
4316 if (c < ABBR_OFF && (c < ' ' || c > '~'))
4317 tb[j++] = Ctrl_V; /* special char needs CTRL-V */
4318#ifdef FEAT_MBYTE
4319 if (has_mbyte)
4320 {
4321 /* if ABBR_OFF has been added, remove it here */
4322 if (c >= ABBR_OFF)
4323 c -= ABBR_OFF;
4324 j += (*mb_char2bytes)(c, tb + j);
4325 }
4326 else
4327#endif
4328 tb[j++] = c;
4329 }
4330 tb[j] = NUL;
4331 /* insert the last typed char */
4332 (void)ins_typebuf(tb, 1, 0, TRUE, mp->m_silent);
4333 }
Bram Moolenaar4e427192006-03-10 21:34:27 +00004334#ifdef FEAT_EVAL
4335 if (mp->m_expr)
Bram Moolenaarc1e37902006-04-18 21:55:01 +00004336 s = eval_map_expr(mp->m_str);
Bram Moolenaar4e427192006-03-10 21:34:27 +00004337 else
4338#endif
4339 s = mp->m_str;
4340 if (s != NULL)
4341 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 /* insert the to string */
Bram Moolenaar4e427192006-03-10 21:34:27 +00004343 (void)ins_typebuf(s, mp->m_noremap, 0, TRUE, mp->m_silent);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 /* no abbrev. for these chars */
Bram Moolenaar4e427192006-03-10 21:34:27 +00004345 typebuf.tb_no_abbr_cnt += (int)STRLEN(s) + j + 1;
4346#ifdef FEAT_EVAL
4347 if (mp->m_expr)
4348 vim_free(s);
4349#endif
4350 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351
4352 tb[0] = Ctrl_H;
4353 tb[1] = NUL;
4354#ifdef FEAT_MBYTE
4355 if (has_mbyte)
4356 len = clen; /* Delete characters instead of bytes */
4357#endif
4358 while (len-- > 0) /* delete the from string */
4359 (void)ins_typebuf(tb, 1, 0, TRUE, mp->m_silent);
4360 return TRUE;
4361 }
4362 }
4363 return FALSE;
4364}
4365
Bram Moolenaarc1e37902006-04-18 21:55:01 +00004366#ifdef FEAT_EVAL
4367/*
4368 * Evaluate the RHS of a mapping or abbreviations and take care of escaping
4369 * special characters.
4370 */
4371 static char_u *
4372eval_map_expr(str)
4373 char_u *str;
4374{
4375 char_u *res;
Bram Moolenaar8424a622006-04-19 21:23:36 +00004376 char_u *p;
Bram Moolenaarc1b52862006-04-28 22:32:28 +00004377 char_u *save_cmd;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004378 pos_T save_cursor;
Bram Moolenaarc1e37902006-04-18 21:55:01 +00004379
Bram Moolenaarc1b52862006-04-28 22:32:28 +00004380 save_cmd = save_cmdline_alloc();
4381 if (save_cmd == NULL)
4382 return NULL;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004383
4384 /* Forbid changing text or using ":normal" to avoid most of the bad side
4385 * effects. Also restore the cursor position. */
4386 ++textlock;
4387#ifdef FEAT_EX_EXTRA
4388 ++ex_normal_lock;
4389#endif
4390 save_cursor = curwin->w_cursor;
Bram Moolenaar8424a622006-04-19 21:23:36 +00004391 p = eval_to_string(str, NULL, FALSE);
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004392 --textlock;
4393#ifdef FEAT_EX_EXTRA
4394 --ex_normal_lock;
4395#endif
4396 curwin->w_cursor = save_cursor;
4397
Bram Moolenaarc1b52862006-04-28 22:32:28 +00004398 restore_cmdline_alloc(save_cmd);
Bram Moolenaar8424a622006-04-19 21:23:36 +00004399 if (p == NULL)
Bram Moolenaarc1e37902006-04-18 21:55:01 +00004400 return NULL;
Bram Moolenaarf193fff2006-04-27 00:02:13 +00004401 res = vim_strsave_escape_csi(p);
4402 vim_free(p);
4403
4404 return res;
4405}
4406#endif
4407
Bram Moolenaarf193fff2006-04-27 00:02:13 +00004408/*
4409 * Copy "p" to allocated memory, escaping K_SPECIAL and CSI so that the result
4410 * can be put in the typeahead buffer.
4411 * Returns NULL when out of memory.
4412 */
4413 char_u *
4414vim_strsave_escape_csi(p)
4415 char_u *p;
4416{
4417 char_u *res;
4418 char_u *s, *d;
Bram Moolenaarc1e37902006-04-18 21:55:01 +00004419
4420 /* Need a buffer to hold up to three times as much. */
Bram Moolenaar8424a622006-04-19 21:23:36 +00004421 res = alloc((unsigned)(STRLEN(p) * 3) + 1);
Bram Moolenaarc1e37902006-04-18 21:55:01 +00004422 if (res != NULL)
4423 {
Bram Moolenaar8424a622006-04-19 21:23:36 +00004424 d = res;
4425 for (s = p; *s != NUL; )
4426 {
4427 if (s[0] == K_SPECIAL && s[1] != NUL && s[2] != NUL)
4428 {
4429 /* Copy special key unmodified. */
4430 *d++ = *s++;
4431 *d++ = *s++;
4432 *d++ = *s++;
4433 }
4434 else
4435 {
4436 /* Add character, possibly multi-byte to destination, escaping
4437 * CSI and K_SPECIAL. */
4438 d = add_char2buf(PTR2CHAR(s), d);
4439 mb_ptr_adv(s);
4440 }
4441 }
4442 *d = NUL;
Bram Moolenaarc1e37902006-04-18 21:55:01 +00004443 }
Bram Moolenaarc1e37902006-04-18 21:55:01 +00004444 return res;
4445}
Bram Moolenaarc1e37902006-04-18 21:55:01 +00004446
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447/*
Bram Moolenaar81b85872007-03-04 20:22:01 +00004448 * Remove escaping from CSI and K_SPECIAL characters. Reverse of
4449 * vim_strsave_escape_csi(). Works in-place.
4450 */
4451 void
4452vim_unescape_csi(p)
4453 char_u *p;
4454{
4455 char_u *s = p, *d = p;
4456
4457 while (*s != NUL)
4458 {
4459 if (s[0] == K_SPECIAL && s[1] == KS_SPECIAL && s[2] == KE_FILLER)
4460 {
4461 *d++ = K_SPECIAL;
4462 s += 3;
4463 }
4464 else if ((s[0] == K_SPECIAL || s[0] == CSI)
4465 && s[1] == KS_EXTRA && s[2] == (int)KE_CSI)
4466 {
4467 *d++ = CSI;
4468 s += 3;
4469 }
4470 else
4471 *d++ = *s++;
4472 }
4473 *d = NUL;
4474}
4475
4476/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 * Write map commands for the current mappings to an .exrc file.
4478 * Return FAIL on error, OK otherwise.
4479 */
4480 int
4481makemap(fd, buf)
4482 FILE *fd;
4483 buf_T *buf; /* buffer for local mappings or NULL */
4484{
4485 mapblock_T *mp;
4486 char_u c1, c2;
4487 char_u *p;
4488 char *cmd;
4489 int abbr;
4490 int hash;
4491 int did_cpo = FALSE;
4492 int i;
4493
4494 validate_maphash();
4495
4496 /*
4497 * Do the loop twice: Once for mappings, once for abbreviations.
4498 * Then loop over all map hash lists.
4499 */
4500 for (abbr = 0; abbr < 2; ++abbr)
4501 for (hash = 0; hash < 256; ++hash)
4502 {
4503 if (abbr)
4504 {
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00004505 if (hash > 0) /* there is only one abbr list */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 break;
4507#ifdef FEAT_LOCALMAP
4508 if (buf != NULL)
4509 mp = buf->b_first_abbr;
4510 else
4511#endif
4512 mp = first_abbr;
4513 }
4514 else
4515 {
4516#ifdef FEAT_LOCALMAP
4517 if (buf != NULL)
4518 mp = buf->b_maphash[hash];
4519 else
4520#endif
4521 mp = maphash[hash];
4522 }
4523
4524 for ( ; mp; mp = mp->m_next)
4525 {
4526 /* skip script-local mappings */
4527 if (mp->m_noremap == REMAP_SCRIPT)
4528 continue;
4529
4530 /* skip mappings that contain a <SNR> (script-local thing),
4531 * they probably don't work when loaded again */
4532 for (p = mp->m_str; *p != NUL; ++p)
4533 if (p[0] == K_SPECIAL && p[1] == KS_EXTRA
4534 && p[2] == (int)KE_SNR)
4535 break;
4536 if (*p != NUL)
4537 continue;
4538
4539 c1 = NUL;
4540 c2 = NUL;
4541 if (abbr)
4542 cmd = "abbr";
4543 else
4544 cmd = "map";
4545 switch (mp->m_mode)
4546 {
Bram Moolenaar371d5402006-03-20 21:47:49 +00004547 case NORMAL + VISUAL + SELECTMODE + OP_PENDING:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548 break;
4549 case NORMAL:
4550 c1 = 'n';
4551 break;
Bram Moolenaar371d5402006-03-20 21:47:49 +00004552 case VISUAL + SELECTMODE:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 c1 = 'v';
4554 break;
Bram Moolenaar371d5402006-03-20 21:47:49 +00004555 case VISUAL:
4556 c1 = 'x';
4557 break;
4558 case SELECTMODE:
4559 c1 = 's';
4560 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 case OP_PENDING:
4562 c1 = 'o';
4563 break;
Bram Moolenaar371d5402006-03-20 21:47:49 +00004564 case NORMAL + VISUAL + SELECTMODE:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565 c1 = 'n';
4566 c2 = 'v';
4567 break;
Bram Moolenaar371d5402006-03-20 21:47:49 +00004568 case VISUAL + SELECTMODE + OP_PENDING:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 c1 = 'v';
4570 c2 = 'o';
4571 break;
4572 case NORMAL + OP_PENDING:
4573 c1 = 'n';
4574 c2 = 'o';
4575 break;
4576 case CMDLINE + INSERT:
4577 if (!abbr)
4578 cmd = "map!";
4579 break;
4580 case CMDLINE:
4581 c1 = 'c';
4582 break;
4583 case INSERT:
4584 c1 = 'i';
4585 break;
4586 case LANGMAP:
4587 c1 = 'l';
4588 break;
4589 default:
4590 EMSG(_("E228: makemap: Illegal mode"));
4591 return FAIL;
4592 }
4593 do /* may do this twice if c2 is set */
4594 {
4595 /* When outputting <> form, need to make sure that 'cpo'
4596 * is set to the Vim default. */
4597 if (!did_cpo)
4598 {
4599 if (*mp->m_str == NUL) /* will use <Nop> */
4600 did_cpo = TRUE;
4601 else
4602 for (i = 0; i < 2; ++i)
4603 for (p = (i ? mp->m_str : mp->m_keys); *p; ++p)
4604 if (*p == K_SPECIAL || *p == NL)
4605 did_cpo = TRUE;
4606 if (did_cpo)
4607 {
4608 if (fprintf(fd, "let s:cpo_save=&cpo") < 0
4609 || put_eol(fd) < 0
4610 || fprintf(fd, "set cpo&vim") < 0
4611 || put_eol(fd) < 0)
4612 return FAIL;
4613 }
4614 }
4615 if (c1 && putc(c1, fd) < 0)
4616 return FAIL;
4617 if (mp->m_noremap != REMAP_YES && fprintf(fd, "nore") < 0)
4618 return FAIL;
4619 if (fprintf(fd, cmd) < 0)
4620 return FAIL;
4621 if (buf != NULL && fputs(" <buffer>", fd) < 0)
4622 return FAIL;
4623 if (mp->m_silent && fputs(" <silent>", fd) < 0)
4624 return FAIL;
Bram Moolenaar4e427192006-03-10 21:34:27 +00004625#ifdef FEAT_EVAL
4626 if (mp->m_noremap == REMAP_SCRIPT
4627 && fputs("<script>", fd) < 0)
4628 return FAIL;
4629 if (mp->m_expr && fputs(" <expr>", fd) < 0)
4630 return FAIL;
4631#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632
4633 if ( putc(' ', fd) < 0
4634 || put_escstr(fd, mp->m_keys, 0) == FAIL
4635 || putc(' ', fd) < 0
4636 || put_escstr(fd, mp->m_str, 1) == FAIL
4637 || put_eol(fd) < 0)
4638 return FAIL;
4639 c1 = c2;
4640 c2 = NUL;
4641 }
4642 while (c1);
4643 }
4644 }
4645
4646 if (did_cpo)
4647 if (fprintf(fd, "let &cpo=s:cpo_save") < 0
4648 || put_eol(fd) < 0
4649 || fprintf(fd, "unlet s:cpo_save") < 0
4650 || put_eol(fd) < 0)
4651 return FAIL;
4652 return OK;
4653}
4654
4655/*
4656 * write escape string to file
4657 * "what": 0 for :map lhs, 1 for :map rhs, 2 for :set
4658 *
4659 * return FAIL for failure, OK otherwise
4660 */
4661 int
4662put_escstr(fd, strstart, what)
4663 FILE *fd;
4664 char_u *strstart;
4665 int what;
4666{
4667 char_u *str = strstart;
4668 int c;
4669 int modifiers;
4670
4671 /* :map xx <Nop> */
4672 if (*str == NUL && what == 1)
4673 {
4674 if (fprintf(fd, "<Nop>") < 0)
4675 return FAIL;
4676 return OK;
4677 }
4678
4679 for ( ; *str != NUL; ++str)
4680 {
4681#ifdef FEAT_MBYTE
4682 char_u *p;
4683
4684 /* Check for a multi-byte character, which may contain escaped
4685 * K_SPECIAL and CSI bytes */
4686 p = mb_unescape(&str);
4687 if (p != NULL)
4688 {
4689 while (*p != NUL)
Bram Moolenaar51485f02005-06-04 21:55:20 +00004690 if (fputc(*p++, fd) < 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691 return FAIL;
4692 --str;
4693 continue;
4694 }
4695#endif
4696
4697 c = *str;
4698 /*
4699 * Special key codes have to be translated to be able to make sense
4700 * when they are read back.
4701 */
4702 if (c == K_SPECIAL && what != 2)
4703 {
4704 modifiers = 0x0;
4705 if (str[1] == KS_MODIFIER)
4706 {
4707 modifiers = str[2];
4708 str += 3;
4709 c = *str;
4710 }
4711 if (c == K_SPECIAL)
4712 {
4713 c = TO_SPECIAL(str[1], str[2]);
4714 str += 2;
4715 }
4716 if (IS_SPECIAL(c) || modifiers) /* special key */
4717 {
4718 if (fprintf(fd, (char *)get_special_key_name(c, modifiers)) < 0)
4719 return FAIL;
4720 continue;
4721 }
4722 }
4723
4724 /*
4725 * A '\n' in a map command should be written as <NL>.
4726 * A '\n' in a set command should be written as \^V^J.
4727 */
4728 if (c == NL)
4729 {
4730 if (what == 2)
4731 {
4732 if (fprintf(fd, IF_EB("\\\026\n", "\\" CTRL_V_STR "\n")) < 0)
4733 return FAIL;
4734 }
4735 else
4736 {
4737 if (fprintf(fd, "<NL>") < 0)
4738 return FAIL;
4739 }
4740 continue;
4741 }
4742
4743 /*
4744 * Some characters have to be escaped with CTRL-V to
4745 * prevent them from misinterpreted in DoOneCmd().
4746 * A space, Tab and '"' has to be escaped with a backslash to
4747 * prevent it to be misinterpreted in do_set().
4748 * A space has to be escaped with a CTRL-V when it's at the start of a
4749 * ":map" rhs.
4750 * A '<' has to be escaped with a CTRL-V to prevent it being
4751 * interpreted as the start of a special key name.
4752 * A space in the lhs of a :map needs a CTRL-V.
4753 */
4754 if (what == 2 && (vim_iswhite(c) || c == '"' || c == '\\'))
4755 {
4756 if (putc('\\', fd) < 0)
4757 return FAIL;
4758 }
4759 else if (c < ' ' || c > '~' || c == '|'
4760 || (what == 0 && c == ' ')
4761 || (what == 1 && str == strstart && c == ' ')
4762 || (what != 2 && c == '<'))
4763 {
4764 if (putc(Ctrl_V, fd) < 0)
4765 return FAIL;
4766 }
4767 if (putc(c, fd) < 0)
4768 return FAIL;
4769 }
4770 return OK;
4771}
4772
4773/*
4774 * Check all mappings for the presence of special key codes.
4775 * Used after ":set term=xxx".
4776 */
4777 void
4778check_map_keycodes()
4779{
4780 mapblock_T *mp;
4781 char_u *p;
4782 int i;
4783 char_u buf[3];
4784 char_u *save_name;
4785 int abbr;
4786 int hash;
4787#ifdef FEAT_LOCALMAP
4788 buf_T *bp;
4789#endif
4790
4791 validate_maphash();
4792 save_name = sourcing_name;
4793 sourcing_name = (char_u *)"mappings"; /* avoids giving error messages */
4794
4795#ifdef FEAT_LOCALMAP
4796 /* This this once for each buffer, and then once for global
4797 * mappings/abbreviations with bp == NULL */
4798 for (bp = firstbuf; ; bp = bp->b_next)
4799 {
4800#endif
4801 /*
4802 * Do the loop twice: Once for mappings, once for abbreviations.
4803 * Then loop over all map hash lists.
4804 */
4805 for (abbr = 0; abbr <= 1; ++abbr)
4806 for (hash = 0; hash < 256; ++hash)
4807 {
4808 if (abbr)
4809 {
4810 if (hash) /* there is only one abbr list */
4811 break;
4812#ifdef FEAT_LOCALMAP
4813 if (bp != NULL)
4814 mp = bp->b_first_abbr;
4815 else
4816#endif
4817 mp = first_abbr;
4818 }
4819 else
4820 {
4821#ifdef FEAT_LOCALMAP
4822 if (bp != NULL)
4823 mp = bp->b_maphash[hash];
4824 else
4825#endif
4826 mp = maphash[hash];
4827 }
4828 for ( ; mp != NULL; mp = mp->m_next)
4829 {
4830 for (i = 0; i <= 1; ++i) /* do this twice */
4831 {
4832 if (i == 0)
4833 p = mp->m_keys; /* once for the "from" part */
4834 else
4835 p = mp->m_str; /* and once for the "to" part */
4836 while (*p)
4837 {
4838 if (*p == K_SPECIAL)
4839 {
4840 ++p;
4841 if (*p < 128) /* for "normal" tcap entries */
4842 {
4843 buf[0] = p[0];
4844 buf[1] = p[1];
4845 buf[2] = NUL;
4846 (void)add_termcap_entry(buf, FALSE);
4847 }
4848 ++p;
4849 }
4850 ++p;
4851 }
4852 }
4853 }
4854 }
4855#ifdef FEAT_LOCALMAP
4856 if (bp == NULL)
4857 break;
4858 }
4859#endif
4860 sourcing_name = save_name;
4861}
4862
4863#ifdef FEAT_EVAL
4864/*
4865 * Check the string "keys" against the lhs of all mappings
4866 * Return pointer to rhs of mapping (mapblock->m_str)
4867 * NULL otherwise
4868 */
4869 char_u *
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00004870check_map(keys, mode, exact, ign_mod, abbr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 char_u *keys;
4872 int mode;
4873 int exact; /* require exact match */
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004874 int ign_mod; /* ignore preceding modifier */
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00004875 int abbr; /* do abbreviations */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876{
4877 int hash;
4878 int len, minlen;
4879 mapblock_T *mp;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004880 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881#ifdef FEAT_LOCALMAP
4882 int local;
4883#endif
4884
4885 validate_maphash();
4886
4887 len = (int)STRLEN(keys);
4888#ifdef FEAT_LOCALMAP
4889 for (local = 1; local >= 0; --local)
4890#endif
4891 /* loop over all hash lists */
4892 for (hash = 0; hash < 256; ++hash)
4893 {
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00004894 if (abbr)
4895 {
4896 if (hash > 0) /* there is only one list. */
4897 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898#ifdef FEAT_LOCALMAP
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00004899 if (local)
4900 mp = curbuf->b_first_abbr;
4901 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902#endif
Bram Moolenaarbe4d5062006-03-18 21:30:13 +00004903 mp = first_abbr;
4904 }
4905#ifdef FEAT_LOCALMAP
4906 else if (local)
4907 mp = curbuf->b_maphash[hash];
4908#endif
4909 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 mp = maphash[hash];
4911 for ( ; mp != NULL; mp = mp->m_next)
4912 {
4913 /* skip entries with wrong mode, wrong length and not matching
4914 * ones */
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004915 if ((mp->m_mode & mode) && (!exact || mp->m_keylen == len))
4916 {
4917 if (len > mp->m_keylen)
4918 minlen = mp->m_keylen;
4919 else
4920 minlen = len;
4921 s = mp->m_keys;
4922 if (ign_mod && s[0] == K_SPECIAL && s[1] == KS_MODIFIER
4923 && s[2] != NUL)
4924 {
4925 s += 3;
4926 if (len > mp->m_keylen - 3)
4927 minlen = mp->m_keylen - 3;
4928 }
4929 if (STRNCMP(s, keys, minlen) == 0)
4930 return mp->m_str;
4931 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932 }
4933 }
4934
4935 return NULL;
4936}
4937#endif
4938
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004939#if defined(MSDOS) || defined(MSWIN) || defined(OS2) || defined(MACOS)
Bram Moolenaar371d5402006-03-20 21:47:49 +00004940
4941#define VIS_SEL (VISUAL+SELECTMODE) /* abbreviation */
4942
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943/*
4944 * Default mappings for some often used keys.
4945 */
4946static struct initmap
4947{
4948 char_u *arg;
4949 int mode;
4950} initmappings[] =
4951{
4952#if defined(MSDOS) || defined(MSWIN) || defined(OS2)
4953 /* Use the Windows (CUA) keybindings. */
4954# ifdef FEAT_GUI
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004955# if 0 /* These are now used to move tab pages */
Bram Moolenaar371d5402006-03-20 21:47:49 +00004956 {(char_u *)"<C-PageUp> H", NORMAL+VIS_SEL},
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 {(char_u *)"<C-PageUp> <C-O>H",INSERT},
Bram Moolenaar371d5402006-03-20 21:47:49 +00004958 {(char_u *)"<C-PageDown> L$", NORMAL+VIS_SEL},
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959 {(char_u *)"<C-PageDown> <C-O>L<C-O>$", INSERT},
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004960# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961
4962 /* paste, copy and cut */
4963 {(char_u *)"<S-Insert> \"*P", NORMAL},
Bram Moolenaar371d5402006-03-20 21:47:49 +00004964 {(char_u *)"<S-Insert> \"-d\"*P", VIS_SEL},
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 {(char_u *)"<S-Insert> <C-R><C-O>*", INSERT+CMDLINE},
Bram Moolenaar371d5402006-03-20 21:47:49 +00004966 {(char_u *)"<C-Insert> \"*y", VIS_SEL},
4967 {(char_u *)"<S-Del> \"*d", VIS_SEL},
4968 {(char_u *)"<C-Del> \"*d", VIS_SEL},
4969 {(char_u *)"<C-X> \"*d", VIS_SEL},
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 /* Missing: CTRL-C (cancel) and CTRL-V (block selection) */
4971# else
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004972# if 0 /* These are now used to move tab pages */
Bram Moolenaar371d5402006-03-20 21:47:49 +00004973 {(char_u *)"\316\204 H", NORMAL+VIS_SEL}, /* CTRL-PageUp is "H" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 {(char_u *)"\316\204 \017H",INSERT}, /* CTRL-PageUp is "^OH"*/
Bram Moolenaar371d5402006-03-20 21:47:49 +00004975 {(char_u *)"\316v L$", NORMAL+VIS_SEL}, /* CTRL-PageDown is "L$" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 {(char_u *)"\316v \017L\017$", INSERT}, /* CTRL-PageDown ="^OL^O$"*/
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004977# endif
Bram Moolenaar371d5402006-03-20 21:47:49 +00004978 {(char_u *)"\316w <C-Home>", NORMAL+VIS_SEL},
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 {(char_u *)"\316w <C-Home>", INSERT+CMDLINE},
Bram Moolenaar371d5402006-03-20 21:47:49 +00004980 {(char_u *)"\316u <C-End>", NORMAL+VIS_SEL},
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 {(char_u *)"\316u <C-End>", INSERT+CMDLINE},
4982
4983 /* paste, copy and cut */
4984# ifdef FEAT_CLIPBOARD
4985# ifdef DJGPP
4986 {(char_u *)"\316\122 \"*P", NORMAL}, /* SHIFT-Insert is "*P */
Bram Moolenaar371d5402006-03-20 21:47:49 +00004987 {(char_u *)"\316\122 \"-d\"*P", VIS_SEL}, /* SHIFT-Insert is "-d"*P */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 {(char_u *)"\316\122 \022\017*", INSERT}, /* SHIFT-Insert is ^R^O* */
Bram Moolenaar371d5402006-03-20 21:47:49 +00004989 {(char_u *)"\316\222 \"*y", VIS_SEL}, /* CTRL-Insert is "*y */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990# if 0 /* Shift-Del produces the same code as Del */
Bram Moolenaar371d5402006-03-20 21:47:49 +00004991 {(char_u *)"\316\123 \"*d", VIS_SEL}, /* SHIFT-Del is "*d */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992# endif
Bram Moolenaar371d5402006-03-20 21:47:49 +00004993 {(char_u *)"\316\223 \"*d", VIS_SEL}, /* CTRL-Del is "*d */
4994 {(char_u *)"\030 \"-d", VIS_SEL}, /* CTRL-X is "-d */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995# else
4996 {(char_u *)"\316\324 \"*P", NORMAL}, /* SHIFT-Insert is "*P */
Bram Moolenaar371d5402006-03-20 21:47:49 +00004997 {(char_u *)"\316\324 \"-d\"*P", VIS_SEL}, /* SHIFT-Insert is "-d"*P */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 {(char_u *)"\316\324 \022\017*", INSERT}, /* SHIFT-Insert is ^R^O* */
Bram Moolenaar371d5402006-03-20 21:47:49 +00004999 {(char_u *)"\316\325 \"*y", VIS_SEL}, /* CTRL-Insert is "*y */
5000 {(char_u *)"\316\327 \"*d", VIS_SEL}, /* SHIFT-Del is "*d */
5001 {(char_u *)"\316\330 \"*d", VIS_SEL}, /* CTRL-Del is "*d */
5002 {(char_u *)"\030 \"-d", VIS_SEL}, /* CTRL-X is "-d */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003# endif
5004# else
5005 {(char_u *)"\316\324 P", NORMAL}, /* SHIFT-Insert is P */
Bram Moolenaar371d5402006-03-20 21:47:49 +00005006 {(char_u *)"\316\324 \"-dP", VIS_SEL}, /* SHIFT-Insert is "-dP */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007 {(char_u *)"\316\324 \022\017\"", INSERT}, /* SHIFT-Insert is ^R^O" */
Bram Moolenaar371d5402006-03-20 21:47:49 +00005008 {(char_u *)"\316\325 y", VIS_SEL}, /* CTRL-Insert is y */
5009 {(char_u *)"\316\327 d", VIS_SEL}, /* SHIFT-Del is d */
5010 {(char_u *)"\316\330 d", VIS_SEL}, /* CTRL-Del is d */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011# endif
5012# endif
5013#endif
5014
5015#if defined(MACOS)
5016 /* Use the Standard MacOS binding. */
5017 /* paste, copy and cut */
5018 {(char_u *)"<D-v> \"*P", NORMAL},
Bram Moolenaar371d5402006-03-20 21:47:49 +00005019 {(char_u *)"<D-v> \"-d\"*P", VIS_SEL},
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020 {(char_u *)"<D-v> <C-R>*", INSERT+CMDLINE},
Bram Moolenaar371d5402006-03-20 21:47:49 +00005021 {(char_u *)"<D-c> \"*y", VIS_SEL},
5022 {(char_u *)"<D-x> \"*d", VIS_SEL},
5023 {(char_u *)"<Backspace> \"-d", VIS_SEL},
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025};
Bram Moolenaar371d5402006-03-20 21:47:49 +00005026
5027# undef VIS_SEL
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005028#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005029
5030/*
5031 * Set up default mappings.
5032 */
5033 void
5034init_mappings()
5035{
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005036#if defined(MSDOS) || defined(MSWIN) || defined(OS2) || defined(MACOS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037 int i;
5038
5039 for (i = 0; i < sizeof(initmappings) / sizeof(struct initmap); ++i)
5040 add_map(initmappings[i].arg, initmappings[i].mode);
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005041#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042}
5043
Bram Moolenaar52b4b552005-03-07 23:00:57 +00005044#if defined(MSDOS) || defined(MSWIN) || defined(OS2) \
5045 || defined(FEAT_CMDWIN) || defined(MACOS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046/*
5047 * Add a mapping "map" for mode "mode".
5048 * Need to put string in allocated memory, because do_map() will modify it.
5049 */
5050 void
5051add_map(map, mode)
5052 char_u *map;
5053 int mode;
5054{
5055 char_u *s;
5056 char_u *cpo_save = p_cpo;
5057
5058 p_cpo = (char_u *)""; /* Allow <> notation */
5059 s = vim_strsave(map);
5060 if (s != NULL)
5061 {
5062 (void)do_map(0, s, mode, FALSE);
5063 vim_free(s);
5064 }
5065 p_cpo = cpo_save;
5066}
Bram Moolenaar52b4b552005-03-07 23:00:57 +00005067#endif