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