xref: /vim-8.2.3635/src/misc2.c (revision 5be4ceec)
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  * misc2.c: Various functions.
12  */
13 #include "vim.h"
14 
15 static char_u	*username = NULL; /* cached result of mch_get_user_name() */
16 
17 static int coladvance2(pos_T *pos, int addspaces, int finetune, colnr_T wcol);
18 
19 /*
20  * Return TRUE if in the current mode we need to use virtual.
21  */
22     int
23 virtual_active(void)
24 {
25     /* While an operator is being executed we return "virtual_op", because
26      * VIsual_active has already been reset, thus we can't check for "block"
27      * being used. */
28     if (virtual_op != MAYBE)
29 	return virtual_op;
30     return (ve_flags == VE_ALL
31 	    || ((ve_flags & VE_BLOCK) && VIsual_active && VIsual_mode == Ctrl_V)
32 	    || ((ve_flags & VE_INSERT) && (State & INSERT)));
33 }
34 
35 /*
36  * Get the screen position of the cursor.
37  */
38     int
39 getviscol(void)
40 {
41     colnr_T	x;
42 
43     getvvcol(curwin, &curwin->w_cursor, &x, NULL, NULL);
44     return (int)x;
45 }
46 
47 /*
48  * Go to column "wcol", and add/insert white space as necessary to get the
49  * cursor in that column.
50  * The caller must have saved the cursor line for undo!
51  */
52     int
53 coladvance_force(colnr_T wcol)
54 {
55     int rc = coladvance2(&curwin->w_cursor, TRUE, FALSE, wcol);
56 
57     if (wcol == MAXCOL)
58 	curwin->w_valid &= ~VALID_VIRTCOL;
59     else
60     {
61 	/* Virtcol is valid */
62 	curwin->w_valid |= VALID_VIRTCOL;
63 	curwin->w_virtcol = wcol;
64     }
65     return rc;
66 }
67 
68 /*
69  * Get the screen position of character col with a coladd in the cursor line.
70  */
71     int
72 getviscol2(colnr_T col, colnr_T coladd UNUSED)
73 {
74     colnr_T	x;
75     pos_T	pos;
76 
77     pos.lnum = curwin->w_cursor.lnum;
78     pos.col = col;
79     pos.coladd = coladd;
80     getvvcol(curwin, &pos, &x, NULL, NULL);
81     return (int)x;
82 }
83 
84 /*
85  * Try to advance the Cursor to the specified screen column.
86  * If virtual editing: fine tune the cursor position.
87  * Note that all virtual positions off the end of a line should share
88  * a curwin->w_cursor.col value (n.b. this is equal to STRLEN(line)),
89  * beginning at coladd 0.
90  *
91  * return OK if desired column is reached, FAIL if not
92  */
93     int
94 coladvance(colnr_T wcol)
95 {
96     int rc = getvpos(&curwin->w_cursor, wcol);
97 
98     if (wcol == MAXCOL || rc == FAIL)
99 	curwin->w_valid &= ~VALID_VIRTCOL;
100     else if (*ml_get_cursor() != TAB)
101     {
102 	/* Virtcol is valid when not on a TAB */
103 	curwin->w_valid |= VALID_VIRTCOL;
104 	curwin->w_virtcol = wcol;
105     }
106     return rc;
107 }
108 
109 /*
110  * Return in "pos" the position of the cursor advanced to screen column "wcol".
111  * return OK if desired column is reached, FAIL if not
112  */
113     int
114 getvpos(pos_T *pos, colnr_T wcol)
115 {
116     return coladvance2(pos, FALSE, virtual_active(), wcol);
117 }
118 
119     static int
120 coladvance2(
121     pos_T	*pos,
122     int		addspaces,	/* change the text to achieve our goal? */
123     int		finetune,	/* change char offset for the exact column */
124     colnr_T	wcol)		/* column to move to */
125 {
126     int		idx;
127     char_u	*ptr;
128     char_u	*line;
129     colnr_T	col = 0;
130     int		csize = 0;
131     int		one_more;
132 #ifdef FEAT_LINEBREAK
133     int		head = 0;
134 #endif
135 
136     one_more = (State & INSERT)
137 		    || restart_edit != NUL
138 		    || (VIsual_active && *p_sel != 'o')
139 		    || ((ve_flags & VE_ONEMORE) && wcol < MAXCOL) ;
140     line = ml_get_buf(curbuf, pos->lnum, FALSE);
141 
142     if (wcol >= MAXCOL)
143     {
144 	    idx = (int)STRLEN(line) - 1 + one_more;
145 	    col = wcol;
146 
147 	    if ((addspaces || finetune) && !VIsual_active)
148 	    {
149 		curwin->w_curswant = linetabsize(line) + one_more;
150 		if (curwin->w_curswant > 0)
151 		    --curwin->w_curswant;
152 	    }
153     }
154     else
155     {
156 	int width = curwin->w_width - win_col_off(curwin);
157 
158 	if (finetune
159 		&& curwin->w_p_wrap
160 		&& curwin->w_width != 0
161 		&& wcol >= (colnr_T)width)
162 	{
163 	    csize = linetabsize(line);
164 	    if (csize > 0)
165 		csize--;
166 
167 	    if (wcol / width > (colnr_T)csize / width
168 		    && ((State & INSERT) == 0 || (int)wcol > csize + 1))
169 	    {
170 		/* In case of line wrapping don't move the cursor beyond the
171 		 * right screen edge.  In Insert mode allow going just beyond
172 		 * the last character (like what happens when typing and
173 		 * reaching the right window edge). */
174 		wcol = (csize / width + 1) * width - 1;
175 	    }
176 	}
177 
178 	ptr = line;
179 	while (col <= wcol && *ptr != NUL)
180 	{
181 	    /* Count a tab for what it's worth (if list mode not on) */
182 #ifdef FEAT_LINEBREAK
183 	    csize = win_lbr_chartabsize(curwin, line, ptr, col, &head);
184 	    MB_PTR_ADV(ptr);
185 #else
186 	    csize = lbr_chartabsize_adv(line, &ptr, col);
187 #endif
188 	    col += csize;
189 	}
190 	idx = (int)(ptr - line);
191 	/*
192 	 * Handle all the special cases.  The virtual_active() check
193 	 * is needed to ensure that a virtual position off the end of
194 	 * a line has the correct indexing.  The one_more comparison
195 	 * replaces an explicit add of one_more later on.
196 	 */
197 	if (col > wcol || (!virtual_active() && one_more == 0))
198 	{
199 	    idx -= 1;
200 # ifdef FEAT_LINEBREAK
201 	    /* Don't count the chars from 'showbreak'. */
202 	    csize -= head;
203 # endif
204 	    col -= csize;
205 	}
206 
207 	if (virtual_active()
208 		&& addspaces
209 		&& ((col != wcol && col != wcol + 1) || csize > 1))
210 	{
211 	    /* 'virtualedit' is set: The difference between wcol and col is
212 	     * filled with spaces. */
213 
214 	    if (line[idx] == NUL)
215 	    {
216 		/* Append spaces */
217 		int	correct = wcol - col;
218 		char_u	*newline = alloc(idx + correct + 1);
219 		int	t;
220 
221 		if (newline == NULL)
222 		    return FAIL;
223 
224 		for (t = 0; t < idx; ++t)
225 		    newline[t] = line[t];
226 
227 		for (t = 0; t < correct; ++t)
228 		    newline[t + idx] = ' ';
229 
230 		newline[idx + correct] = NUL;
231 
232 		ml_replace(pos->lnum, newline, FALSE);
233 		changed_bytes(pos->lnum, (colnr_T)idx);
234 		idx += correct;
235 		col = wcol;
236 	    }
237 	    else
238 	    {
239 		/* Break a tab */
240 		int	linelen = (int)STRLEN(line);
241 		int	correct = wcol - col - csize + 1; /* negative!! */
242 		char_u	*newline;
243 		int	t, s = 0;
244 		int	v;
245 
246 		if (-correct > csize)
247 		    return FAIL;
248 
249 		newline = alloc(linelen + csize);
250 		if (newline == NULL)
251 		    return FAIL;
252 
253 		for (t = 0; t < linelen; t++)
254 		{
255 		    if (t != idx)
256 			newline[s++] = line[t];
257 		    else
258 			for (v = 0; v < csize; v++)
259 			    newline[s++] = ' ';
260 		}
261 
262 		newline[linelen + csize - 1] = NUL;
263 
264 		ml_replace(pos->lnum, newline, FALSE);
265 		changed_bytes(pos->lnum, idx);
266 		idx += (csize - 1 + correct);
267 		col += correct;
268 	    }
269 	}
270     }
271 
272     if (idx < 0)
273 	pos->col = 0;
274     else
275 	pos->col = idx;
276 
277     pos->coladd = 0;
278 
279     if (finetune)
280     {
281 	if (wcol == MAXCOL)
282 	{
283 	    /* The width of the last character is used to set coladd. */
284 	    if (!one_more)
285 	    {
286 		colnr_T	    scol, ecol;
287 
288 		getvcol(curwin, pos, &scol, NULL, &ecol);
289 		pos->coladd = ecol - scol;
290 	    }
291 	}
292 	else
293 	{
294 	    int b = (int)wcol - (int)col;
295 
296 	    /* The difference between wcol and col is used to set coladd. */
297 	    if (b > 0 && b < (MAXCOL - 2 * curwin->w_width))
298 		pos->coladd = b;
299 
300 	    col += b;
301 	}
302     }
303 
304     /* prevent from moving onto a trail byte */
305     if (has_mbyte)
306 	mb_adjustpos(curbuf, pos);
307 
308     if (col < wcol)
309 	return FAIL;
310     return OK;
311 }
312 
313 /*
314  * Increment the cursor position.  See inc() for return values.
315  */
316     int
317 inc_cursor(void)
318 {
319     return inc(&curwin->w_cursor);
320 }
321 
322 /*
323  * Increment the line pointer "lp" crossing line boundaries as necessary.
324  * Return 1 when going to the next line.
325  * Return 2 when moving forward onto a NUL at the end of the line).
326  * Return -1 when at the end of file.
327  * Return 0 otherwise.
328  */
329     int
330 inc(pos_T *lp)
331 {
332     char_u  *p;
333 
334     /* when searching position may be set to end of a line */
335     if (lp->col != MAXCOL)
336     {
337 	p = ml_get_pos(lp);
338 	if (*p != NUL)	/* still within line, move to next char (may be NUL) */
339 	{
340 	    if (has_mbyte)
341 	    {
342 		int l = (*mb_ptr2len)(p);
343 
344 		lp->col += l;
345 		return ((p[l] != NUL) ? 0 : 2);
346 	    }
347 	    lp->col++;
348 	    lp->coladd = 0;
349 	    return ((p[1] != NUL) ? 0 : 2);
350 	}
351     }
352     if (lp->lnum != curbuf->b_ml.ml_line_count)     /* there is a next line */
353     {
354 	lp->col = 0;
355 	lp->lnum++;
356 	lp->coladd = 0;
357 	return 1;
358     }
359     return -1;
360 }
361 
362 /*
363  * incl(lp): same as inc(), but skip the NUL at the end of non-empty lines
364  */
365     int
366 incl(pos_T *lp)
367 {
368     int	    r;
369 
370     if ((r = inc(lp)) >= 1 && lp->col)
371 	r = inc(lp);
372     return r;
373 }
374 
375 /*
376  * dec(p)
377  *
378  * Decrement the line pointer 'p' crossing line boundaries as necessary.
379  * Return 1 when crossing a line, -1 when at start of file, 0 otherwise.
380  */
381     int
382 dec_cursor(void)
383 {
384     return dec(&curwin->w_cursor);
385 }
386 
387     int
388 dec(pos_T *lp)
389 {
390     char_u	*p;
391 
392     lp->coladd = 0;
393     if (lp->col == MAXCOL)
394     {
395 	/* past end of line */
396 	p = ml_get(lp->lnum);
397 	lp->col = (colnr_T)STRLEN(p);
398 	if (has_mbyte)
399 	    lp->col -= (*mb_head_off)(p, p + lp->col);
400 	return 0;
401     }
402 
403     if (lp->col > 0)
404     {
405 	/* still within line */
406 	lp->col--;
407 	if (has_mbyte)
408 	{
409 	    p = ml_get(lp->lnum);
410 	    lp->col -= (*mb_head_off)(p, p + lp->col);
411 	}
412 	return 0;
413     }
414 
415     if (lp->lnum > 1)
416     {
417 	/* there is a prior line */
418 	lp->lnum--;
419 	p = ml_get(lp->lnum);
420 	lp->col = (colnr_T)STRLEN(p);
421 	if (has_mbyte)
422 	    lp->col -= (*mb_head_off)(p, p + lp->col);
423 	return 1;
424     }
425 
426     /* at start of file */
427     return -1;
428 }
429 
430 /*
431  * decl(lp): same as dec(), but skip the NUL at the end of non-empty lines
432  */
433     int
434 decl(pos_T *lp)
435 {
436     int	    r;
437 
438     if ((r = dec(lp)) == 1 && lp->col)
439 	r = dec(lp);
440     return r;
441 }
442 
443 /*
444  * Get the line number relative to the current cursor position, i.e. the
445  * difference between line number and cursor position. Only look for lines that
446  * can be visible, folded lines don't count.
447  */
448     linenr_T
449 get_cursor_rel_lnum(
450     win_T	*wp,
451     linenr_T	lnum)		    /* line number to get the result for */
452 {
453     linenr_T	cursor = wp->w_cursor.lnum;
454     linenr_T	retval = 0;
455 
456 #ifdef FEAT_FOLDING
457     if (hasAnyFolding(wp))
458     {
459 	if (lnum > cursor)
460 	{
461 	    while (lnum > cursor)
462 	    {
463 		(void)hasFoldingWin(wp, lnum, &lnum, NULL, TRUE, NULL);
464 		/* if lnum and cursor are in the same fold,
465 		 * now lnum <= cursor */
466 		if (lnum > cursor)
467 		    retval++;
468 		lnum--;
469 	    }
470 	}
471 	else if (lnum < cursor)
472 	{
473 	    while (lnum < cursor)
474 	    {
475 		(void)hasFoldingWin(wp, lnum, NULL, &lnum, TRUE, NULL);
476 		/* if lnum and cursor are in the same fold,
477 		 * now lnum >= cursor */
478 		if (lnum < cursor)
479 		    retval--;
480 		lnum++;
481 	    }
482 	}
483 	/* else if (lnum == cursor)
484 	 *     retval = 0;
485 	 */
486     }
487     else
488 #endif
489 	retval = lnum - cursor;
490 
491     return retval;
492 }
493 
494 /*
495  * Make sure "pos.lnum" and "pos.col" are valid in "buf".
496  * This allows for the col to be on the NUL byte.
497  */
498     void
499 check_pos(buf_T *buf, pos_T *pos)
500 {
501     char_u *line;
502     colnr_T len;
503 
504     if (pos->lnum > buf->b_ml.ml_line_count)
505 	pos->lnum = buf->b_ml.ml_line_count;
506 
507     if (pos->col > 0)
508     {
509 	line = ml_get_buf(buf, pos->lnum, FALSE);
510 	len = (colnr_T)STRLEN(line);
511 	if (pos->col > len)
512 	    pos->col = len;
513     }
514 }
515 
516 /*
517  * Make sure curwin->w_cursor.lnum is valid.
518  */
519     void
520 check_cursor_lnum(void)
521 {
522     if (curwin->w_cursor.lnum > curbuf->b_ml.ml_line_count)
523     {
524 #ifdef FEAT_FOLDING
525 	/* If there is a closed fold at the end of the file, put the cursor in
526 	 * its first line.  Otherwise in the last line. */
527 	if (!hasFolding(curbuf->b_ml.ml_line_count,
528 						&curwin->w_cursor.lnum, NULL))
529 #endif
530 	    curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
531     }
532     if (curwin->w_cursor.lnum <= 0)
533 	curwin->w_cursor.lnum = 1;
534 }
535 
536 /*
537  * Make sure curwin->w_cursor.col is valid.
538  */
539     void
540 check_cursor_col(void)
541 {
542     check_cursor_col_win(curwin);
543 }
544 
545 /*
546  * Make sure win->w_cursor.col is valid.
547  */
548     void
549 check_cursor_col_win(win_T *win)
550 {
551     colnr_T len;
552     colnr_T oldcol = win->w_cursor.col;
553     colnr_T oldcoladd = win->w_cursor.col + win->w_cursor.coladd;
554 
555     len = (colnr_T)STRLEN(ml_get_buf(win->w_buffer, win->w_cursor.lnum, FALSE));
556     if (len == 0)
557 	win->w_cursor.col = 0;
558     else if (win->w_cursor.col >= len)
559     {
560 	/* Allow cursor past end-of-line when:
561 	 * - in Insert mode or restarting Insert mode
562 	 * - in Visual mode and 'selection' isn't "old"
563 	 * - 'virtualedit' is set */
564 	if ((State & INSERT) || restart_edit
565 		|| (VIsual_active && *p_sel != 'o')
566 		|| (ve_flags & VE_ONEMORE)
567 		|| virtual_active())
568 	    win->w_cursor.col = len;
569 	else
570 	{
571 	    win->w_cursor.col = len - 1;
572 	    /* Move the cursor to the head byte. */
573 	    if (has_mbyte)
574 		mb_adjustpos(win->w_buffer, &win->w_cursor);
575 	}
576     }
577     else if (win->w_cursor.col < 0)
578 	win->w_cursor.col = 0;
579 
580     /* If virtual editing is on, we can leave the cursor on the old position,
581      * only we must set it to virtual.  But don't do it when at the end of the
582      * line. */
583     if (oldcol == MAXCOL)
584 	win->w_cursor.coladd = 0;
585     else if (ve_flags == VE_ALL)
586     {
587 	if (oldcoladd > win->w_cursor.col)
588 	{
589 	    win->w_cursor.coladd = oldcoladd - win->w_cursor.col;
590 
591 	    /* Make sure that coladd is not more than the char width.
592 	     * Not for the last character, coladd is then used when the cursor
593 	     * is actually after the last character. */
594 	    if (win->w_cursor.col + 1 < len && win->w_cursor.coladd > 0)
595 	    {
596 		int cs, ce;
597 
598 		getvcol(win, &win->w_cursor, &cs, NULL, &ce);
599 		if (win->w_cursor.coladd > ce - cs)
600 		    win->w_cursor.coladd = ce - cs;
601 	    }
602 	}
603 	else
604 	    /* avoid weird number when there is a miscalculation or overflow */
605 	    win->w_cursor.coladd = 0;
606     }
607 }
608 
609 /*
610  * make sure curwin->w_cursor in on a valid character
611  */
612     void
613 check_cursor(void)
614 {
615     check_cursor_lnum();
616     check_cursor_col();
617 }
618 
619 #if defined(FEAT_TEXTOBJ) || defined(PROTO)
620 /*
621  * Make sure curwin->w_cursor is not on the NUL at the end of the line.
622  * Allow it when in Visual mode and 'selection' is not "old".
623  */
624     void
625 adjust_cursor_col(void)
626 {
627     if (curwin->w_cursor.col > 0
628 	    && (!VIsual_active || *p_sel == 'o')
629 	    && gchar_cursor() == NUL)
630 	--curwin->w_cursor.col;
631 }
632 #endif
633 
634 /*
635  * When curwin->w_leftcol has changed, adjust the cursor position.
636  * Return TRUE if the cursor was moved.
637  */
638     int
639 leftcol_changed(void)
640 {
641     long	lastcol;
642     colnr_T	s, e;
643     int		retval = FALSE;
644     long        siso = get_sidescrolloff_value();
645 
646     changed_cline_bef_curs();
647     lastcol = curwin->w_leftcol + curwin->w_width - curwin_col_off() - 1;
648     validate_virtcol();
649 
650     /*
651      * If the cursor is right or left of the screen, move it to last or first
652      * character.
653      */
654     if (curwin->w_virtcol > (colnr_T)(lastcol - siso))
655     {
656 	retval = TRUE;
657 	coladvance((colnr_T)(lastcol - siso));
658     }
659     else if (curwin->w_virtcol < curwin->w_leftcol + siso)
660     {
661 	retval = TRUE;
662 	(void)coladvance((colnr_T)(curwin->w_leftcol + siso));
663     }
664 
665     /*
666      * If the start of the character under the cursor is not on the screen,
667      * advance the cursor one more char.  If this fails (last char of the
668      * line) adjust the scrolling.
669      */
670     getvvcol(curwin, &curwin->w_cursor, &s, NULL, &e);
671     if (e > (colnr_T)lastcol)
672     {
673 	retval = TRUE;
674 	coladvance(s - 1);
675     }
676     else if (s < curwin->w_leftcol)
677     {
678 	retval = TRUE;
679 	if (coladvance(e + 1) == FAIL)	/* there isn't another character */
680 	{
681 	    curwin->w_leftcol = s;	/* adjust w_leftcol instead */
682 	    changed_cline_bef_curs();
683 	}
684     }
685 
686     if (retval)
687 	curwin->w_set_curswant = TRUE;
688     redraw_later(NOT_VALID);
689     return retval;
690 }
691 
692 /**********************************************************************
693  * Various routines dealing with allocation and deallocation of memory.
694  */
695 
696 #if defined(MEM_PROFILE) || defined(PROTO)
697 
698 # define MEM_SIZES  8200
699 static long_u mem_allocs[MEM_SIZES];
700 static long_u mem_frees[MEM_SIZES];
701 static long_u mem_allocated;
702 static long_u mem_freed;
703 static long_u mem_peak;
704 static long_u num_alloc;
705 static long_u num_freed;
706 
707     static void
708 mem_pre_alloc_s(size_t *sizep)
709 {
710     *sizep += sizeof(size_t);
711 }
712 
713     static void
714 mem_pre_alloc_l(size_t *sizep)
715 {
716     *sizep += sizeof(size_t);
717 }
718 
719     static void
720 mem_post_alloc(
721     void **pp,
722     size_t size)
723 {
724     if (*pp == NULL)
725 	return;
726     size -= sizeof(size_t);
727     *(long_u *)*pp = size;
728     if (size <= MEM_SIZES-1)
729 	mem_allocs[size-1]++;
730     else
731 	mem_allocs[MEM_SIZES-1]++;
732     mem_allocated += size;
733     if (mem_allocated - mem_freed > mem_peak)
734 	mem_peak = mem_allocated - mem_freed;
735     num_alloc++;
736     *pp = (void *)((char *)*pp + sizeof(size_t));
737 }
738 
739     static void
740 mem_pre_free(void **pp)
741 {
742     long_u size;
743 
744     *pp = (void *)((char *)*pp - sizeof(size_t));
745     size = *(size_t *)*pp;
746     if (size <= MEM_SIZES-1)
747 	mem_frees[size-1]++;
748     else
749 	mem_frees[MEM_SIZES-1]++;
750     mem_freed += size;
751     num_freed++;
752 }
753 
754 /*
755  * called on exit via atexit()
756  */
757     void
758 vim_mem_profile_dump(void)
759 {
760     int i, j;
761 
762     printf("\r\n");
763     j = 0;
764     for (i = 0; i < MEM_SIZES - 1; i++)
765     {
766 	if (mem_allocs[i] || mem_frees[i])
767 	{
768 	    if (mem_frees[i] > mem_allocs[i])
769 		printf("\r\n%s", _("ERROR: "));
770 	    printf("[%4d / %4lu-%-4lu] ", i + 1, mem_allocs[i], mem_frees[i]);
771 	    j++;
772 	    if (j > 3)
773 	    {
774 		j = 0;
775 		printf("\r\n");
776 	    }
777 	}
778     }
779 
780     i = MEM_SIZES - 1;
781     if (mem_allocs[i])
782     {
783 	printf("\r\n");
784 	if (mem_frees[i] > mem_allocs[i])
785 	    puts(_("ERROR: "));
786 	printf("[>%d / %4lu-%-4lu]", i, mem_allocs[i], mem_frees[i]);
787     }
788 
789     printf(_("\n[bytes] total alloc-freed %lu-%lu, in use %lu, peak use %lu\n"),
790 	    mem_allocated, mem_freed, mem_allocated - mem_freed, mem_peak);
791     printf(_("[calls] total re/malloc()'s %lu, total free()'s %lu\n\n"),
792 	    num_alloc, num_freed);
793 }
794 
795 #endif /* MEM_PROFILE */
796 
797 #ifdef FEAT_EVAL
798     int
799 alloc_does_fail(size_t size)
800 {
801     if (alloc_fail_countdown == 0)
802     {
803 	if (--alloc_fail_repeat <= 0)
804 	    alloc_fail_id = 0;
805 	do_outofmem_msg(size);
806 	return TRUE;
807     }
808     --alloc_fail_countdown;
809     return FALSE;
810 }
811 #endif
812 
813 /*
814  * Some memory is reserved for error messages and for being able to
815  * call mf_release_all(), which needs some memory for mf_trans_add().
816  */
817 #define KEEP_ROOM (2 * 8192L)
818 #define KEEP_ROOM_KB (KEEP_ROOM / 1024L)
819 
820 /*
821  * The normal way to allocate memory.  This handles an out-of-memory situation
822  * as well as possible, still returns NULL when we're completely out.
823  */
824     void *
825 alloc(size_t size)
826 {
827     return lalloc(size, TRUE);
828 }
829 
830 /*
831  * alloc() with an ID for alloc_fail().
832  */
833     void *
834 alloc_id(size_t size, alloc_id_T id UNUSED)
835 {
836 #ifdef FEAT_EVAL
837     if (alloc_fail_id == id && alloc_does_fail(size))
838 	return NULL;
839 #endif
840     return lalloc(size, TRUE);
841 }
842 
843 /*
844  * Allocate memory and set all bytes to zero.
845  */
846     void *
847 alloc_clear(size_t size)
848 {
849     void *p;
850 
851     p = lalloc(size, TRUE);
852     if (p != NULL)
853 	(void)vim_memset(p, 0, size);
854     return p;
855 }
856 
857 /*
858  * Same as alloc_clear() but with allocation id for testing
859  */
860     void *
861 alloc_clear_id(size_t size, alloc_id_T id UNUSED)
862 {
863 #ifdef FEAT_EVAL
864     if (alloc_fail_id == id && alloc_does_fail(size))
865 	return NULL;
866 #endif
867     return alloc_clear(size);
868 }
869 
870 /*
871  * Allocate memory like lalloc() and set all bytes to zero.
872  */
873     void *
874 lalloc_clear(size_t size, int message)
875 {
876     void *p;
877 
878     p = lalloc(size, message);
879     if (p != NULL)
880 	(void)vim_memset(p, 0, size);
881     return p;
882 }
883 
884 /*
885  * Low level memory allocation function.
886  * This is used often, KEEP IT FAST!
887  */
888     void *
889 lalloc(size_t size, int message)
890 {
891     void	*p;		    /* pointer to new storage space */
892     static int	releasing = FALSE;  /* don't do mf_release_all() recursive */
893     int		try_again;
894 #if defined(HAVE_AVAIL_MEM)
895     static size_t allocated = 0;    /* allocated since last avail check */
896 #endif
897 
898     // Safety check for allocating zero bytes
899     if (size == 0)
900     {
901 	// Don't hide this message
902 	emsg_silent = 0;
903 	iemsg(_("E341: Internal error: lalloc(0, )"));
904 	return NULL;
905     }
906 
907 #ifdef MEM_PROFILE
908     mem_pre_alloc_l(&size);
909 #endif
910 
911     /*
912      * Loop when out of memory: Try to release some memfile blocks and
913      * if some blocks are released call malloc again.
914      */
915     for (;;)
916     {
917 	/*
918 	 * Handle three kind of systems:
919 	 * 1. No check for available memory: Just return.
920 	 * 2. Slow check for available memory: call mch_avail_mem() after
921 	 *    allocating KEEP_ROOM amount of memory.
922 	 * 3. Strict check for available memory: call mch_avail_mem()
923 	 */
924 	if ((p = malloc(size)) != NULL)
925 	{
926 #ifndef HAVE_AVAIL_MEM
927 	    /* 1. No check for available memory: Just return. */
928 	    goto theend;
929 #else
930 	    /* 2. Slow check for available memory: call mch_avail_mem() after
931 	     *    allocating (KEEP_ROOM / 2) amount of memory. */
932 	    allocated += size;
933 	    if (allocated < KEEP_ROOM / 2)
934 		goto theend;
935 	    allocated = 0;
936 
937 	    /* 3. check for available memory: call mch_avail_mem() */
938 	    if (mch_avail_mem(TRUE) < KEEP_ROOM_KB && !releasing)
939 	    {
940 		free(p);	/* System is low... no go! */
941 		p = NULL;
942 	    }
943 	    else
944 		goto theend;
945 #endif
946 	}
947 	/*
948 	 * Remember that mf_release_all() is being called to avoid an endless
949 	 * loop, because mf_release_all() may call alloc() recursively.
950 	 */
951 	if (releasing)
952 	    break;
953 	releasing = TRUE;
954 
955 	clear_sb_text(TRUE);	      /* free any scrollback text */
956 	try_again = mf_release_all(); /* release as many blocks as possible */
957 
958 	releasing = FALSE;
959 	if (!try_again)
960 	    break;
961     }
962 
963     if (message && p == NULL)
964 	do_outofmem_msg(size);
965 
966 theend:
967 #ifdef MEM_PROFILE
968     mem_post_alloc(&p, size);
969 #endif
970     return p;
971 }
972 
973 /*
974  * lalloc() with an ID for alloc_fail().
975  */
976 #if defined(FEAT_SIGNS) || defined(PROTO)
977     void *
978 lalloc_id(size_t size, int message, alloc_id_T id UNUSED)
979 {
980 #ifdef FEAT_EVAL
981     if (alloc_fail_id == id && alloc_does_fail(size))
982 	return NULL;
983 #endif
984     return (lalloc(size, message));
985 }
986 #endif
987 
988 #if defined(MEM_PROFILE) || defined(PROTO)
989 /*
990  * realloc() with memory profiling.
991  */
992     void *
993 mem_realloc(void *ptr, size_t size)
994 {
995     void *p;
996 
997     mem_pre_free(&ptr);
998     mem_pre_alloc_s(&size);
999 
1000     p = realloc(ptr, size);
1001 
1002     mem_post_alloc(&p, size);
1003 
1004     return p;
1005 }
1006 #endif
1007 
1008 /*
1009 * Avoid repeating the error message many times (they take 1 second each).
1010 * Did_outofmem_msg is reset when a character is read.
1011 */
1012     void
1013 do_outofmem_msg(size_t size)
1014 {
1015     if (!did_outofmem_msg)
1016     {
1017 	// Don't hide this message
1018 	emsg_silent = 0;
1019 
1020 	// Must come first to avoid coming back here when printing the error
1021 	// message fails, e.g. when setting v:errmsg.
1022 	did_outofmem_msg = TRUE;
1023 
1024 	semsg(_("E342: Out of memory!  (allocating %lu bytes)"), (long_u)size);
1025 
1026 	if (starting == NO_SCREEN)
1027 	    // Not even finished with initializations and already out of
1028 	    // memory?  Then nothing is going to work, exit.
1029 	    mch_exit(123);
1030     }
1031 }
1032 
1033 #if defined(EXITFREE) || defined(PROTO)
1034 
1035 /*
1036  * Free everything that we allocated.
1037  * Can be used to detect memory leaks, e.g., with ccmalloc.
1038  * NOTE: This is tricky!  Things are freed that functions depend on.  Don't be
1039  * surprised if Vim crashes...
1040  * Some things can't be freed, esp. things local to a library function.
1041  */
1042     void
1043 free_all_mem(void)
1044 {
1045     buf_T	*buf, *nextbuf;
1046 
1047     /* When we cause a crash here it is caught and Vim tries to exit cleanly.
1048      * Don't try freeing everything again. */
1049     if (entered_free_all_mem)
1050 	return;
1051     entered_free_all_mem = TRUE;
1052 
1053     /* Don't want to trigger autocommands from here on. */
1054     block_autocmds();
1055 
1056     /* Close all tabs and windows.  Reset 'equalalways' to avoid redraws. */
1057     p_ea = FALSE;
1058     if (first_tabpage != NULL && first_tabpage->tp_next != NULL)
1059 	do_cmdline_cmd((char_u *)"tabonly!");
1060     if (!ONE_WINDOW)
1061 	do_cmdline_cmd((char_u *)"only!");
1062 
1063 # if defined(FEAT_SPELL)
1064     /* Free all spell info. */
1065     spell_free_all();
1066 # endif
1067 
1068 # if defined(FEAT_BEVAL_TERM)
1069     ui_remove_balloon();
1070 # endif
1071 
1072     // Clear user commands (before deleting buffers).
1073     ex_comclear(NULL);
1074 
1075     // When exiting from mainerr_arg_missing curbuf has not been initialized,
1076     // and not much else.
1077     if (curbuf != NULL)
1078     {
1079 # ifdef FEAT_MENU
1080 	// Clear menus.
1081 	do_cmdline_cmd((char_u *)"aunmenu *");
1082 #  ifdef FEAT_MULTI_LANG
1083 	do_cmdline_cmd((char_u *)"menutranslate clear");
1084 #  endif
1085 # endif
1086 	// Clear mappings, abbreviations, breakpoints.
1087 	do_cmdline_cmd((char_u *)"lmapclear");
1088 	do_cmdline_cmd((char_u *)"xmapclear");
1089 	do_cmdline_cmd((char_u *)"mapclear");
1090 	do_cmdline_cmd((char_u *)"mapclear!");
1091 	do_cmdline_cmd((char_u *)"abclear");
1092 # if defined(FEAT_EVAL)
1093 	do_cmdline_cmd((char_u *)"breakdel *");
1094 # endif
1095 # if defined(FEAT_PROFILE)
1096 	do_cmdline_cmd((char_u *)"profdel *");
1097 # endif
1098 # if defined(FEAT_KEYMAP)
1099 	do_cmdline_cmd((char_u *)"set keymap=");
1100 # endif
1101     }
1102 
1103 # ifdef FEAT_TITLE
1104     free_titles();
1105 # endif
1106 # if defined(FEAT_SEARCHPATH)
1107     free_findfile();
1108 # endif
1109 
1110     /* Obviously named calls. */
1111     free_all_autocmds();
1112     clear_termcodes();
1113     free_all_marks();
1114     alist_clear(&global_alist);
1115     free_homedir();
1116     free_users();
1117     free_search_patterns();
1118     free_old_sub();
1119     free_last_insert();
1120     free_insexpand_stuff();
1121     free_prev_shellcmd();
1122     free_regexp_stuff();
1123     free_tag_stuff();
1124     free_cd_dir();
1125 # ifdef FEAT_SIGNS
1126     free_signs();
1127 # endif
1128 # ifdef FEAT_EVAL
1129     set_expr_line(NULL);
1130 # endif
1131 # ifdef FEAT_DIFF
1132     if (curtab != NULL)
1133 	diff_clear(curtab);
1134 # endif
1135     clear_sb_text(TRUE);	      /* free any scrollback text */
1136 
1137     /* Free some global vars. */
1138     vim_free(username);
1139 # ifdef FEAT_CLIPBOARD
1140     vim_regfree(clip_exclude_prog);
1141 # endif
1142     vim_free(last_cmdline);
1143     vim_free(new_last_cmdline);
1144     set_keep_msg(NULL, 0);
1145 
1146     /* Clear cmdline history. */
1147     p_hi = 0;
1148     init_history();
1149 # ifdef FEAT_TEXT_PROP
1150     clear_global_prop_types();
1151 # endif
1152 
1153 # ifdef FEAT_QUICKFIX
1154     {
1155 	win_T	    *win;
1156 	tabpage_T   *tab;
1157 
1158 	qf_free_all(NULL);
1159 	// Free all location lists
1160 	FOR_ALL_TAB_WINDOWS(tab, win)
1161 	    qf_free_all(win);
1162     }
1163 # endif
1164 
1165     // Close all script inputs.
1166     close_all_scripts();
1167 
1168     if (curwin != NULL)
1169 	// Destroy all windows.  Must come before freeing buffers.
1170 	win_free_all();
1171 
1172     /* Free all option values.  Must come after closing windows. */
1173     free_all_options();
1174 
1175     /* Free all buffers.  Reset 'autochdir' to avoid accessing things that
1176      * were freed already. */
1177 # ifdef FEAT_AUTOCHDIR
1178     p_acd = FALSE;
1179 # endif
1180     for (buf = firstbuf; buf != NULL; )
1181     {
1182 	bufref_T    bufref;
1183 
1184 	set_bufref(&bufref, buf);
1185 	nextbuf = buf->b_next;
1186 	close_buffer(NULL, buf, DOBUF_WIPE, FALSE);
1187 	if (bufref_valid(&bufref))
1188 	    buf = nextbuf;	/* didn't work, try next one */
1189 	else
1190 	    buf = firstbuf;
1191     }
1192 
1193 # ifdef FEAT_ARABIC
1194     free_arshape_buf();
1195 # endif
1196 
1197     /* Clear registers. */
1198     clear_registers();
1199     ResetRedobuff();
1200     ResetRedobuff();
1201 
1202 # if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
1203     vim_free(serverDelayedStartName);
1204 # endif
1205 
1206     /* highlight info */
1207     free_highlight();
1208 
1209     reset_last_sourcing();
1210 
1211     if (first_tabpage != NULL)
1212     {
1213 	free_tabpage(first_tabpage);
1214 	first_tabpage = NULL;
1215     }
1216 
1217 # ifdef UNIX
1218     /* Machine-specific free. */
1219     mch_free_mem();
1220 # endif
1221 
1222     /* message history */
1223     for (;;)
1224 	if (delete_first_msg() == FAIL)
1225 	    break;
1226 
1227 # ifdef FEAT_JOB_CHANNEL
1228     channel_free_all();
1229 # endif
1230 # ifdef FEAT_TIMERS
1231     timer_free_all();
1232 # endif
1233 # ifdef FEAT_EVAL
1234     /* must be after channel_free_all() with unrefs partials */
1235     eval_clear();
1236 # endif
1237 # ifdef FEAT_JOB_CHANNEL
1238     /* must be after eval_clear() with unrefs jobs */
1239     job_free_all();
1240 # endif
1241 
1242     free_termoptions();
1243 
1244     /* screenlines (can't display anything now!) */
1245     free_screenlines();
1246 
1247 # if defined(FEAT_SOUND)
1248     sound_free();
1249 # endif
1250 # if defined(USE_XSMP)
1251     xsmp_close();
1252 # endif
1253 # ifdef FEAT_GUI_GTK
1254     gui_mch_free_all();
1255 # endif
1256     clear_hl_tables();
1257 
1258     vim_free(IObuff);
1259     vim_free(NameBuff);
1260 # ifdef FEAT_QUICKFIX
1261     check_quickfix_busy();
1262 # endif
1263 }
1264 #endif
1265 
1266 /*
1267  * Copy "string" into newly allocated memory.
1268  */
1269     char_u *
1270 vim_strsave(char_u *string)
1271 {
1272     char_u	*p;
1273     size_t	len;
1274 
1275     len = STRLEN(string) + 1;
1276     p = alloc(len);
1277     if (p != NULL)
1278 	mch_memmove(p, string, len);
1279     return p;
1280 }
1281 
1282 /*
1283  * Copy up to "len" bytes of "string" into newly allocated memory and
1284  * terminate with a NUL.
1285  * The allocated memory always has size "len + 1", also when "string" is
1286  * shorter.
1287  */
1288     char_u *
1289 vim_strnsave(char_u *string, int len)
1290 {
1291     char_u	*p;
1292 
1293     p = alloc(len + 1);
1294     if (p != NULL)
1295     {
1296 	STRNCPY(p, string, len);
1297 	p[len] = NUL;
1298     }
1299     return p;
1300 }
1301 
1302 /*
1303  * Copy "p[len]" into allocated memory, ignoring NUL characters.
1304  * Returns NULL when out of memory.
1305  */
1306     char_u *
1307 vim_memsave(char_u *p, size_t len)
1308 {
1309     char_u *ret = alloc(len);
1310 
1311     if (ret != NULL)
1312 	mch_memmove(ret, p, len);
1313     return ret;
1314 }
1315 
1316 /*
1317  * Same as vim_strsave(), but any characters found in esc_chars are preceded
1318  * by a backslash.
1319  */
1320     char_u *
1321 vim_strsave_escaped(char_u *string, char_u *esc_chars)
1322 {
1323     return vim_strsave_escaped_ext(string, esc_chars, '\\', FALSE);
1324 }
1325 
1326 /*
1327  * Same as vim_strsave_escaped(), but when "bsl" is TRUE also escape
1328  * characters where rem_backslash() would remove the backslash.
1329  * Escape the characters with "cc".
1330  */
1331     char_u *
1332 vim_strsave_escaped_ext(
1333     char_u	*string,
1334     char_u	*esc_chars,
1335     int		cc,
1336     int		bsl)
1337 {
1338     char_u	*p;
1339     char_u	*p2;
1340     char_u	*escaped_string;
1341     unsigned	length;
1342     int		l;
1343 
1344     /*
1345      * First count the number of backslashes required.
1346      * Then allocate the memory and insert them.
1347      */
1348     length = 1;				/* count the trailing NUL */
1349     for (p = string; *p; p++)
1350     {
1351 	if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1352 	{
1353 	    length += l;		/* count a multibyte char */
1354 	    p += l - 1;
1355 	    continue;
1356 	}
1357 	if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
1358 	    ++length;			/* count a backslash */
1359 	++length;			/* count an ordinary char */
1360     }
1361     escaped_string = alloc(length);
1362     if (escaped_string != NULL)
1363     {
1364 	p2 = escaped_string;
1365 	for (p = string; *p; p++)
1366 	{
1367 	    if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1368 	    {
1369 		mch_memmove(p2, p, (size_t)l);
1370 		p2 += l;
1371 		p += l - 1;		/* skip multibyte char  */
1372 		continue;
1373 	    }
1374 	    if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
1375 		*p2++ = cc;
1376 	    *p2++ = *p;
1377 	}
1378 	*p2 = NUL;
1379     }
1380     return escaped_string;
1381 }
1382 
1383 /*
1384  * Return TRUE when 'shell' has "csh" in the tail.
1385  */
1386     int
1387 csh_like_shell(void)
1388 {
1389     return (strstr((char *)gettail(p_sh), "csh") != NULL);
1390 }
1391 
1392 /*
1393  * Escape "string" for use as a shell argument with system().
1394  * This uses single quotes, except when we know we need to use double quotes
1395  * (MS-DOS and MS-Windows without 'shellslash' set).
1396  * Escape a newline, depending on the 'shell' option.
1397  * When "do_special" is TRUE also replace "!", "%", "#" and things starting
1398  * with "<" like "<cfile>".
1399  * When "do_newline" is FALSE do not escape newline unless it is csh shell.
1400  * Returns the result in allocated memory, NULL if we have run out.
1401  */
1402     char_u *
1403 vim_strsave_shellescape(char_u *string, int do_special, int do_newline)
1404 {
1405     unsigned	length;
1406     char_u	*p;
1407     char_u	*d;
1408     char_u	*escaped_string;
1409     int		l;
1410     int		csh_like;
1411 
1412     /* Only csh and similar shells expand '!' within single quotes.  For sh and
1413      * the like we must not put a backslash before it, it will be taken
1414      * literally.  If do_special is set the '!' will be escaped twice.
1415      * Csh also needs to have "\n" escaped twice when do_special is set. */
1416     csh_like = csh_like_shell();
1417 
1418     /* First count the number of extra bytes required. */
1419     length = (unsigned)STRLEN(string) + 3;  /* two quotes and a trailing NUL */
1420     for (p = string; *p != NUL; MB_PTR_ADV(p))
1421     {
1422 # ifdef MSWIN
1423 	if (!p_ssl)
1424 	{
1425 	    if (*p == '"')
1426 		++length;		/* " -> "" */
1427 	}
1428 	else
1429 # endif
1430 	if (*p == '\'')
1431 	    length += 3;		/* ' => '\'' */
1432 	if ((*p == '\n' && (csh_like || do_newline))
1433 		|| (*p == '!' && (csh_like || do_special)))
1434 	{
1435 	    ++length;			/* insert backslash */
1436 	    if (csh_like && do_special)
1437 		++length;		/* insert backslash */
1438 	}
1439 	if (do_special && find_cmdline_var(p, &l) >= 0)
1440 	{
1441 	    ++length;			/* insert backslash */
1442 	    p += l - 1;
1443 	}
1444     }
1445 
1446     /* Allocate memory for the result and fill it. */
1447     escaped_string = alloc(length);
1448     if (escaped_string != NULL)
1449     {
1450 	d = escaped_string;
1451 
1452 	/* add opening quote */
1453 # ifdef MSWIN
1454 	if (!p_ssl)
1455 	    *d++ = '"';
1456 	else
1457 # endif
1458 	    *d++ = '\'';
1459 
1460 	for (p = string; *p != NUL; )
1461 	{
1462 # ifdef MSWIN
1463 	    if (!p_ssl)
1464 	    {
1465 		if (*p == '"')
1466 		{
1467 		    *d++ = '"';
1468 		    *d++ = '"';
1469 		    ++p;
1470 		    continue;
1471 		}
1472 	    }
1473 	    else
1474 # endif
1475 	    if (*p == '\'')
1476 	    {
1477 		*d++ = '\'';
1478 		*d++ = '\\';
1479 		*d++ = '\'';
1480 		*d++ = '\'';
1481 		++p;
1482 		continue;
1483 	    }
1484 	    if ((*p == '\n' && (csh_like || do_newline))
1485 		    || (*p == '!' && (csh_like || do_special)))
1486 	    {
1487 		*d++ = '\\';
1488 		if (csh_like && do_special)
1489 		    *d++ = '\\';
1490 		*d++ = *p++;
1491 		continue;
1492 	    }
1493 	    if (do_special && find_cmdline_var(p, &l) >= 0)
1494 	    {
1495 		*d++ = '\\';		/* insert backslash */
1496 		while (--l >= 0)	/* copy the var */
1497 		    *d++ = *p++;
1498 		continue;
1499 	    }
1500 
1501 	    MB_COPY_CHAR(p, d);
1502 	}
1503 
1504 	/* add terminating quote and finish with a NUL */
1505 # ifdef MSWIN
1506 	if (!p_ssl)
1507 	    *d++ = '"';
1508 	else
1509 # endif
1510 	    *d++ = '\'';
1511 	*d = NUL;
1512     }
1513 
1514     return escaped_string;
1515 }
1516 
1517 /*
1518  * Like vim_strsave(), but make all characters uppercase.
1519  * This uses ASCII lower-to-upper case translation, language independent.
1520  */
1521     char_u *
1522 vim_strsave_up(char_u *string)
1523 {
1524     char_u *p1;
1525 
1526     p1 = vim_strsave(string);
1527     vim_strup(p1);
1528     return p1;
1529 }
1530 
1531 /*
1532  * Like vim_strnsave(), but make all characters uppercase.
1533  * This uses ASCII lower-to-upper case translation, language independent.
1534  */
1535     char_u *
1536 vim_strnsave_up(char_u *string, int len)
1537 {
1538     char_u *p1;
1539 
1540     p1 = vim_strnsave(string, len);
1541     vim_strup(p1);
1542     return p1;
1543 }
1544 
1545 /*
1546  * ASCII lower-to-upper case translation, language independent.
1547  */
1548     void
1549 vim_strup(
1550     char_u	*p)
1551 {
1552     char_u  *p2;
1553     int	    c;
1554 
1555     if (p != NULL)
1556     {
1557 	p2 = p;
1558 	while ((c = *p2) != NUL)
1559 #ifdef EBCDIC
1560 	    *p2++ = isalpha(c) ? toupper(c) : c;
1561 #else
1562 	    *p2++ = (c < 'a' || c > 'z') ? c : (c - 0x20);
1563 #endif
1564     }
1565 }
1566 
1567 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
1568 /*
1569  * Make string "s" all upper-case and return it in allocated memory.
1570  * Handles multi-byte characters as well as possible.
1571  * Returns NULL when out of memory.
1572  */
1573     char_u *
1574 strup_save(char_u *orig)
1575 {
1576     char_u	*p;
1577     char_u	*res;
1578 
1579     res = p = vim_strsave(orig);
1580 
1581     if (res != NULL)
1582 	while (*p != NUL)
1583 	{
1584 	    int		l;
1585 
1586 	    if (enc_utf8)
1587 	    {
1588 		int	c, uc;
1589 		int	newl;
1590 		char_u	*s;
1591 
1592 		c = utf_ptr2char(p);
1593 		l = utf_ptr2len(p);
1594 		if (c == 0)
1595 		{
1596 		    /* overlong sequence, use only the first byte */
1597 		    c = *p;
1598 		    l = 1;
1599 		}
1600 		uc = utf_toupper(c);
1601 
1602 		/* Reallocate string when byte count changes.  This is rare,
1603 		 * thus it's OK to do another malloc()/free(). */
1604 		newl = utf_char2len(uc);
1605 		if (newl != l)
1606 		{
1607 		    s = alloc(STRLEN(res) + 1 + newl - l);
1608 		    if (s == NULL)
1609 		    {
1610 			vim_free(res);
1611 			return NULL;
1612 		    }
1613 		    mch_memmove(s, res, p - res);
1614 		    STRCPY(s + (p - res) + newl, p + l);
1615 		    p = s + (p - res);
1616 		    vim_free(res);
1617 		    res = s;
1618 		}
1619 
1620 		utf_char2bytes(uc, p);
1621 		p += newl;
1622 	    }
1623 	    else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1624 		p += l;		/* skip multi-byte character */
1625 	    else
1626 	    {
1627 		*p = TOUPPER_LOC(*p); /* note that toupper() can be a macro */
1628 		p++;
1629 	    }
1630 	}
1631 
1632     return res;
1633 }
1634 
1635 /*
1636  * Make string "s" all lower-case and return it in allocated memory.
1637  * Handles multi-byte characters as well as possible.
1638  * Returns NULL when out of memory.
1639  */
1640     char_u *
1641 strlow_save(char_u *orig)
1642 {
1643     char_u	*p;
1644     char_u	*res;
1645 
1646     res = p = vim_strsave(orig);
1647 
1648     if (res != NULL)
1649 	while (*p != NUL)
1650 	{
1651 	    int		l;
1652 
1653 	    if (enc_utf8)
1654 	    {
1655 		int	c, lc;
1656 		int	newl;
1657 		char_u	*s;
1658 
1659 		c = utf_ptr2char(p);
1660 		l = utf_ptr2len(p);
1661 		if (c == 0)
1662 		{
1663 		    /* overlong sequence, use only the first byte */
1664 		    c = *p;
1665 		    l = 1;
1666 		}
1667 		lc = utf_tolower(c);
1668 
1669 		/* Reallocate string when byte count changes.  This is rare,
1670 		 * thus it's OK to do another malloc()/free(). */
1671 		newl = utf_char2len(lc);
1672 		if (newl != l)
1673 		{
1674 		    s = alloc(STRLEN(res) + 1 + newl - l);
1675 		    if (s == NULL)
1676 		    {
1677 			vim_free(res);
1678 			return NULL;
1679 		    }
1680 		    mch_memmove(s, res, p - res);
1681 		    STRCPY(s + (p - res) + newl, p + l);
1682 		    p = s + (p - res);
1683 		    vim_free(res);
1684 		    res = s;
1685 		}
1686 
1687 		utf_char2bytes(lc, p);
1688 		p += newl;
1689 	    }
1690 	    else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1691 		p += l;		/* skip multi-byte character */
1692 	    else
1693 	    {
1694 		*p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
1695 		p++;
1696 	    }
1697 	}
1698 
1699     return res;
1700 }
1701 #endif
1702 
1703 /*
1704  * delete spaces at the end of a string
1705  */
1706     void
1707 del_trailing_spaces(char_u *ptr)
1708 {
1709     char_u	*q;
1710 
1711     q = ptr + STRLEN(ptr);
1712     while (--q > ptr && VIM_ISWHITE(q[0]) && q[-1] != '\\' && q[-1] != Ctrl_V)
1713 	*q = NUL;
1714 }
1715 
1716 /*
1717  * Like strncpy(), but always terminate the result with one NUL.
1718  * "to" must be "len + 1" long!
1719  */
1720     void
1721 vim_strncpy(char_u *to, char_u *from, size_t len)
1722 {
1723     STRNCPY(to, from, len);
1724     to[len] = NUL;
1725 }
1726 
1727 /*
1728  * Like strcat(), but make sure the result fits in "tosize" bytes and is
1729  * always NUL terminated. "from" and "to" may overlap.
1730  */
1731     void
1732 vim_strcat(char_u *to, char_u *from, size_t tosize)
1733 {
1734     size_t tolen = STRLEN(to);
1735     size_t fromlen = STRLEN(from);
1736 
1737     if (tolen + fromlen + 1 > tosize)
1738     {
1739 	mch_memmove(to + tolen, from, tosize - tolen - 1);
1740 	to[tosize - 1] = NUL;
1741     }
1742     else
1743 	mch_memmove(to + tolen, from, fromlen + 1);
1744 }
1745 
1746 /*
1747  * Isolate one part of a string option where parts are separated with
1748  * "sep_chars".
1749  * The part is copied into "buf[maxlen]".
1750  * "*option" is advanced to the next part.
1751  * The length is returned.
1752  */
1753     int
1754 copy_option_part(
1755     char_u	**option,
1756     char_u	*buf,
1757     int		maxlen,
1758     char	*sep_chars)
1759 {
1760     int	    len = 0;
1761     char_u  *p = *option;
1762 
1763     /* skip '.' at start of option part, for 'suffixes' */
1764     if (*p == '.')
1765 	buf[len++] = *p++;
1766     while (*p != NUL && vim_strchr((char_u *)sep_chars, *p) == NULL)
1767     {
1768 	/*
1769 	 * Skip backslash before a separator character and space.
1770 	 */
1771 	if (p[0] == '\\' && vim_strchr((char_u *)sep_chars, p[1]) != NULL)
1772 	    ++p;
1773 	if (len < maxlen - 1)
1774 	    buf[len++] = *p;
1775 	++p;
1776     }
1777     buf[len] = NUL;
1778 
1779     if (*p != NUL && *p != ',')	/* skip non-standard separator */
1780 	++p;
1781     p = skip_to_option_part(p);	/* p points to next file name */
1782 
1783     *option = p;
1784     return len;
1785 }
1786 
1787 /*
1788  * Replacement for free() that ignores NULL pointers.
1789  * Also skip free() when exiting for sure, this helps when we caught a deadly
1790  * signal that was caused by a crash in free().
1791  * If you want to set NULL after calling this function, you should use
1792  * VIM_CLEAR() instead.
1793  */
1794     void
1795 vim_free(void *x)
1796 {
1797     if (x != NULL && !really_exiting)
1798     {
1799 #ifdef MEM_PROFILE
1800 	mem_pre_free(&x);
1801 #endif
1802 	free(x);
1803     }
1804 }
1805 
1806 #ifndef HAVE_MEMSET
1807     void *
1808 vim_memset(void *ptr, int c, size_t size)
1809 {
1810     char *p = ptr;
1811 
1812     while (size-- > 0)
1813 	*p++ = c;
1814     return ptr;
1815 }
1816 #endif
1817 
1818 #if (!defined(HAVE_STRCASECMP) && !defined(HAVE_STRICMP)) || defined(PROTO)
1819 /*
1820  * Compare two strings, ignoring case, using current locale.
1821  * Doesn't work for multi-byte characters.
1822  * return 0 for match, < 0 for smaller, > 0 for bigger
1823  */
1824     int
1825 vim_stricmp(char *s1, char *s2)
1826 {
1827     int		i;
1828 
1829     for (;;)
1830     {
1831 	i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
1832 	if (i != 0)
1833 	    return i;			    /* this character different */
1834 	if (*s1 == NUL)
1835 	    break;			    /* strings match until NUL */
1836 	++s1;
1837 	++s2;
1838     }
1839     return 0;				    /* strings match */
1840 }
1841 #endif
1842 
1843 #if (!defined(HAVE_STRNCASECMP) && !defined(HAVE_STRNICMP)) || defined(PROTO)
1844 /*
1845  * Compare two strings, for length "len", ignoring case, using current locale.
1846  * Doesn't work for multi-byte characters.
1847  * return 0 for match, < 0 for smaller, > 0 for bigger
1848  */
1849     int
1850 vim_strnicmp(char *s1, char *s2, size_t len)
1851 {
1852     int		i;
1853 
1854     while (len > 0)
1855     {
1856 	i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
1857 	if (i != 0)
1858 	    return i;			    /* this character different */
1859 	if (*s1 == NUL)
1860 	    break;			    /* strings match until NUL */
1861 	++s1;
1862 	++s2;
1863 	--len;
1864     }
1865     return 0;				    /* strings match */
1866 }
1867 #endif
1868 
1869 /*
1870  * Version of strchr() and strrchr() that handle unsigned char strings
1871  * with characters from 128 to 255 correctly.  It also doesn't return a
1872  * pointer to the NUL at the end of the string.
1873  */
1874     char_u  *
1875 vim_strchr(char_u *string, int c)
1876 {
1877     char_u	*p;
1878     int		b;
1879 
1880     p = string;
1881     if (enc_utf8 && c >= 0x80)
1882     {
1883 	while (*p != NUL)
1884 	{
1885 	    int l = utfc_ptr2len(p);
1886 
1887 	    /* Avoid matching an illegal byte here. */
1888 	    if (utf_ptr2char(p) == c && l > 1)
1889 		return p;
1890 	    p += l;
1891 	}
1892 	return NULL;
1893     }
1894     if (enc_dbcs != 0 && c > 255)
1895     {
1896 	int	n2 = c & 0xff;
1897 
1898 	c = ((unsigned)c >> 8) & 0xff;
1899 	while ((b = *p) != NUL)
1900 	{
1901 	    if (b == c && p[1] == n2)
1902 		return p;
1903 	    p += (*mb_ptr2len)(p);
1904 	}
1905 	return NULL;
1906     }
1907     if (has_mbyte)
1908     {
1909 	while ((b = *p) != NUL)
1910 	{
1911 	    if (b == c)
1912 		return p;
1913 	    p += (*mb_ptr2len)(p);
1914 	}
1915 	return NULL;
1916     }
1917     while ((b = *p) != NUL)
1918     {
1919 	if (b == c)
1920 	    return p;
1921 	++p;
1922     }
1923     return NULL;
1924 }
1925 
1926 /*
1927  * Version of strchr() that only works for bytes and handles unsigned char
1928  * strings with characters above 128 correctly. It also doesn't return a
1929  * pointer to the NUL at the end of the string.
1930  */
1931     char_u  *
1932 vim_strbyte(char_u *string, int c)
1933 {
1934     char_u	*p = string;
1935 
1936     while (*p != NUL)
1937     {
1938 	if (*p == c)
1939 	    return p;
1940 	++p;
1941     }
1942     return NULL;
1943 }
1944 
1945 /*
1946  * Search for last occurrence of "c" in "string".
1947  * Return NULL if not found.
1948  * Does not handle multi-byte char for "c"!
1949  */
1950     char_u  *
1951 vim_strrchr(char_u *string, int c)
1952 {
1953     char_u	*retval = NULL;
1954     char_u	*p = string;
1955 
1956     while (*p)
1957     {
1958 	if (*p == c)
1959 	    retval = p;
1960 	MB_PTR_ADV(p);
1961     }
1962     return retval;
1963 }
1964 
1965 /*
1966  * Vim's version of strpbrk(), in case it's missing.
1967  * Don't generate a prototype for this, causes problems when it's not used.
1968  */
1969 #ifndef PROTO
1970 # ifndef HAVE_STRPBRK
1971 #  ifdef vim_strpbrk
1972 #   undef vim_strpbrk
1973 #  endif
1974     char_u *
1975 vim_strpbrk(char_u *s, char_u *charset)
1976 {
1977     while (*s)
1978     {
1979 	if (vim_strchr(charset, *s) != NULL)
1980 	    return s;
1981 	MB_PTR_ADV(s);
1982     }
1983     return NULL;
1984 }
1985 # endif
1986 #endif
1987 
1988 /*
1989  * Vim has its own isspace() function, because on some machines isspace()
1990  * can't handle characters above 128.
1991  */
1992     int
1993 vim_isspace(int x)
1994 {
1995     return ((x >= 9 && x <= 13) || x == ' ');
1996 }
1997 
1998 /************************************************************************
1999  * Functions for handling growing arrays.
2000  */
2001 
2002 /*
2003  * Clear an allocated growing array.
2004  */
2005     void
2006 ga_clear(garray_T *gap)
2007 {
2008     vim_free(gap->ga_data);
2009     ga_init(gap);
2010 }
2011 
2012 /*
2013  * Clear a growing array that contains a list of strings.
2014  */
2015     void
2016 ga_clear_strings(garray_T *gap)
2017 {
2018     int		i;
2019 
2020     for (i = 0; i < gap->ga_len; ++i)
2021 	vim_free(((char_u **)(gap->ga_data))[i]);
2022     ga_clear(gap);
2023 }
2024 
2025 /*
2026  * Initialize a growing array.	Don't forget to set ga_itemsize and
2027  * ga_growsize!  Or use ga_init2().
2028  */
2029     void
2030 ga_init(garray_T *gap)
2031 {
2032     gap->ga_data = NULL;
2033     gap->ga_maxlen = 0;
2034     gap->ga_len = 0;
2035 }
2036 
2037     void
2038 ga_init2(garray_T *gap, int itemsize, int growsize)
2039 {
2040     ga_init(gap);
2041     gap->ga_itemsize = itemsize;
2042     gap->ga_growsize = growsize;
2043 }
2044 
2045 /*
2046  * Make room in growing array "gap" for at least "n" items.
2047  * Return FAIL for failure, OK otherwise.
2048  */
2049     int
2050 ga_grow(garray_T *gap, int n)
2051 {
2052     size_t	old_len;
2053     size_t	new_len;
2054     char_u	*pp;
2055 
2056     if (gap->ga_maxlen - gap->ga_len < n)
2057     {
2058 	if (n < gap->ga_growsize)
2059 	    n = gap->ga_growsize;
2060 
2061 	// A linear growth is very inefficient when the array grows big.  This
2062 	// is a compromise between allocating memory that won't be used and too
2063 	// many copy operations. A factor of 1.5 seems reasonable.
2064 	if (n < gap->ga_len / 2)
2065 	    n = gap->ga_len / 2;
2066 
2067 	new_len = gap->ga_itemsize * (gap->ga_len + n);
2068 	pp = vim_realloc(gap->ga_data, new_len);
2069 	if (pp == NULL)
2070 	    return FAIL;
2071 	old_len = gap->ga_itemsize * gap->ga_maxlen;
2072 	vim_memset(pp + old_len, 0, new_len - old_len);
2073 	gap->ga_maxlen = gap->ga_len + n;
2074 	gap->ga_data = pp;
2075     }
2076     return OK;
2077 }
2078 
2079 #if defined(FEAT_EVAL) || defined(FEAT_SEARCHPATH) || defined(PROTO)
2080 /*
2081  * For a growing array that contains a list of strings: concatenate all the
2082  * strings with a separating "sep".
2083  * Returns NULL when out of memory.
2084  */
2085     char_u *
2086 ga_concat_strings(garray_T *gap, char *sep)
2087 {
2088     int		i;
2089     int		len = 0;
2090     int		sep_len = (int)STRLEN(sep);
2091     char_u	*s;
2092     char_u	*p;
2093 
2094     for (i = 0; i < gap->ga_len; ++i)
2095 	len += (int)STRLEN(((char_u **)(gap->ga_data))[i]) + sep_len;
2096 
2097     s = alloc(len + 1);
2098     if (s != NULL)
2099     {
2100 	*s = NUL;
2101 	p = s;
2102 	for (i = 0; i < gap->ga_len; ++i)
2103 	{
2104 	    if (p != s)
2105 	    {
2106 		STRCPY(p, sep);
2107 		p += sep_len;
2108 	    }
2109 	    STRCPY(p, ((char_u **)(gap->ga_data))[i]);
2110 	    p += STRLEN(p);
2111 	}
2112     }
2113     return s;
2114 }
2115 #endif
2116 
2117 #if defined(FEAT_VIMINFO) || defined(FEAT_EVAL) || defined(PROTO)
2118 /*
2119  * Make a copy of string "p" and add it to "gap".
2120  * When out of memory nothing changes.
2121  */
2122     void
2123 ga_add_string(garray_T *gap, char_u *p)
2124 {
2125     char_u *cp = vim_strsave(p);
2126 
2127     if (cp != NULL)
2128     {
2129 	if (ga_grow(gap, 1) == OK)
2130 	    ((char_u **)(gap->ga_data))[gap->ga_len++] = cp;
2131 	else
2132 	    vim_free(cp);
2133     }
2134 }
2135 #endif
2136 
2137 /*
2138  * Concatenate a string to a growarray which contains bytes.
2139  * When "s" is NULL does not do anything.
2140  * Note: Does NOT copy the NUL at the end!
2141  */
2142     void
2143 ga_concat(garray_T *gap, char_u *s)
2144 {
2145     int    len;
2146 
2147     if (s == NULL || *s == NUL)
2148 	return;
2149     len = (int)STRLEN(s);
2150     if (ga_grow(gap, len) == OK)
2151     {
2152 	mch_memmove((char *)gap->ga_data + gap->ga_len, s, (size_t)len);
2153 	gap->ga_len += len;
2154     }
2155 }
2156 
2157 /*
2158  * Append one byte to a growarray which contains bytes.
2159  */
2160     void
2161 ga_append(garray_T *gap, int c)
2162 {
2163     if (ga_grow(gap, 1) == OK)
2164     {
2165 	*((char *)gap->ga_data + gap->ga_len) = c;
2166 	++gap->ga_len;
2167     }
2168 }
2169 
2170 #if (defined(UNIX) && !defined(USE_SYSTEM)) || defined(MSWIN) \
2171 	|| defined(PROTO)
2172 /*
2173  * Append the text in "gap" below the cursor line and clear "gap".
2174  */
2175     void
2176 append_ga_line(garray_T *gap)
2177 {
2178     /* Remove trailing CR. */
2179     if (gap->ga_len > 0
2180 	    && !curbuf->b_p_bin
2181 	    && ((char_u *)gap->ga_data)[gap->ga_len - 1] == CAR)
2182 	--gap->ga_len;
2183     ga_append(gap, NUL);
2184     ml_append(curwin->w_cursor.lnum++, gap->ga_data, 0, FALSE);
2185     gap->ga_len = 0;
2186 }
2187 #endif
2188 
2189 /************************************************************************
2190  * functions that use lookup tables for various things, generally to do with
2191  * special key codes.
2192  */
2193 
2194 /*
2195  * Some useful tables.
2196  */
2197 
2198 static struct modmasktable
2199 {
2200     short	mod_mask;	/* Bit-mask for particular key modifier */
2201     short	mod_flag;	/* Bit(s) for particular key modifier */
2202     char_u	name;		/* Single letter name of modifier */
2203 } mod_mask_table[] =
2204 {
2205     {MOD_MASK_ALT,		MOD_MASK_ALT,		(char_u)'M'},
2206     {MOD_MASK_META,		MOD_MASK_META,		(char_u)'T'},
2207     {MOD_MASK_CTRL,		MOD_MASK_CTRL,		(char_u)'C'},
2208     {MOD_MASK_SHIFT,		MOD_MASK_SHIFT,		(char_u)'S'},
2209     {MOD_MASK_MULTI_CLICK,	MOD_MASK_2CLICK,	(char_u)'2'},
2210     {MOD_MASK_MULTI_CLICK,	MOD_MASK_3CLICK,	(char_u)'3'},
2211     {MOD_MASK_MULTI_CLICK,	MOD_MASK_4CLICK,	(char_u)'4'},
2212 #ifdef MACOS_X
2213     {MOD_MASK_CMD,		MOD_MASK_CMD,		(char_u)'D'},
2214 #endif
2215     /* 'A' must be the last one */
2216     {MOD_MASK_ALT,		MOD_MASK_ALT,		(char_u)'A'},
2217     {0, 0, NUL}
2218     /* NOTE: when adding an entry, update MAX_KEY_NAME_LEN! */
2219 };
2220 
2221 /*
2222  * Shifted key terminal codes and their unshifted equivalent.
2223  * Don't add mouse codes here, they are handled separately!
2224  */
2225 #define MOD_KEYS_ENTRY_SIZE 5
2226 
2227 static char_u modifier_keys_table[] =
2228 {
2229 /*  mod mask	    with modifier		without modifier */
2230     MOD_MASK_SHIFT, '&', '9',			'@', '1',	/* begin */
2231     MOD_MASK_SHIFT, '&', '0',			'@', '2',	/* cancel */
2232     MOD_MASK_SHIFT, '*', '1',			'@', '4',	/* command */
2233     MOD_MASK_SHIFT, '*', '2',			'@', '5',	/* copy */
2234     MOD_MASK_SHIFT, '*', '3',			'@', '6',	/* create */
2235     MOD_MASK_SHIFT, '*', '4',			'k', 'D',	/* delete char */
2236     MOD_MASK_SHIFT, '*', '5',			'k', 'L',	/* delete line */
2237     MOD_MASK_SHIFT, '*', '7',			'@', '7',	/* end */
2238     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_END,	'@', '7',	/* end */
2239     MOD_MASK_SHIFT, '*', '9',			'@', '9',	/* exit */
2240     MOD_MASK_SHIFT, '*', '0',			'@', '0',	/* find */
2241     MOD_MASK_SHIFT, '#', '1',			'%', '1',	/* help */
2242     MOD_MASK_SHIFT, '#', '2',			'k', 'h',	/* home */
2243     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_HOME,	'k', 'h',	/* home */
2244     MOD_MASK_SHIFT, '#', '3',			'k', 'I',	/* insert */
2245     MOD_MASK_SHIFT, '#', '4',			'k', 'l',	/* left arrow */
2246     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_LEFT,	'k', 'l',	/* left arrow */
2247     MOD_MASK_SHIFT, '%', 'a',			'%', '3',	/* message */
2248     MOD_MASK_SHIFT, '%', 'b',			'%', '4',	/* move */
2249     MOD_MASK_SHIFT, '%', 'c',			'%', '5',	/* next */
2250     MOD_MASK_SHIFT, '%', 'd',			'%', '7',	/* options */
2251     MOD_MASK_SHIFT, '%', 'e',			'%', '8',	/* previous */
2252     MOD_MASK_SHIFT, '%', 'f',			'%', '9',	/* print */
2253     MOD_MASK_SHIFT, '%', 'g',			'%', '0',	/* redo */
2254     MOD_MASK_SHIFT, '%', 'h',			'&', '3',	/* replace */
2255     MOD_MASK_SHIFT, '%', 'i',			'k', 'r',	/* right arr. */
2256     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_RIGHT,	'k', 'r',	/* right arr. */
2257     MOD_MASK_SHIFT, '%', 'j',			'&', '5',	/* resume */
2258     MOD_MASK_SHIFT, '!', '1',			'&', '6',	/* save */
2259     MOD_MASK_SHIFT, '!', '2',			'&', '7',	/* suspend */
2260     MOD_MASK_SHIFT, '!', '3',			'&', '8',	/* undo */
2261     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_UP,	'k', 'u',	/* up arrow */
2262     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_DOWN,	'k', 'd',	/* down arrow */
2263 
2264 								/* vt100 F1 */
2265     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF1,	KS_EXTRA, (int)KE_XF1,
2266     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF2,	KS_EXTRA, (int)KE_XF2,
2267     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF3,	KS_EXTRA, (int)KE_XF3,
2268     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF4,	KS_EXTRA, (int)KE_XF4,
2269 
2270     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F1,	'k', '1',	/* F1 */
2271     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F2,	'k', '2',
2272     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F3,	'k', '3',
2273     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F4,	'k', '4',
2274     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F5,	'k', '5',
2275     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F6,	'k', '6',
2276     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F7,	'k', '7',
2277     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F8,	'k', '8',
2278     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F9,	'k', '9',
2279     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F10,	'k', ';',	/* F10 */
2280 
2281     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F11,	'F', '1',
2282     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F12,	'F', '2',
2283     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F13,	'F', '3',
2284     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F14,	'F', '4',
2285     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F15,	'F', '5',
2286     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F16,	'F', '6',
2287     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F17,	'F', '7',
2288     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F18,	'F', '8',
2289     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F19,	'F', '9',
2290     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F20,	'F', 'A',
2291 
2292     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F21,	'F', 'B',
2293     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F22,	'F', 'C',
2294     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F23,	'F', 'D',
2295     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F24,	'F', 'E',
2296     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F25,	'F', 'F',
2297     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F26,	'F', 'G',
2298     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F27,	'F', 'H',
2299     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F28,	'F', 'I',
2300     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F29,	'F', 'J',
2301     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F30,	'F', 'K',
2302 
2303     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F31,	'F', 'L',
2304     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F32,	'F', 'M',
2305     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F33,	'F', 'N',
2306     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F34,	'F', 'O',
2307     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F35,	'F', 'P',
2308     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F36,	'F', 'Q',
2309     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F37,	'F', 'R',
2310 
2311 							    /* TAB pseudo code*/
2312     MOD_MASK_SHIFT, 'k', 'B',			KS_EXTRA, (int)KE_TAB,
2313 
2314     NUL
2315 };
2316 
2317 static struct key_name_entry
2318 {
2319     int	    key;	/* Special key code or ascii value */
2320     char_u  *name;	/* Name of key */
2321 } key_names_table[] =
2322 {
2323     {' ',		(char_u *)"Space"},
2324     {TAB,		(char_u *)"Tab"},
2325     {K_TAB,		(char_u *)"Tab"},
2326     {NL,		(char_u *)"NL"},
2327     {NL,		(char_u *)"NewLine"},	/* Alternative name */
2328     {NL,		(char_u *)"LineFeed"},	/* Alternative name */
2329     {NL,		(char_u *)"LF"},	/* Alternative name */
2330     {CAR,		(char_u *)"CR"},
2331     {CAR,		(char_u *)"Return"},	/* Alternative name */
2332     {CAR,		(char_u *)"Enter"},	/* Alternative name */
2333     {K_BS,		(char_u *)"BS"},
2334     {K_BS,		(char_u *)"BackSpace"},	/* Alternative name */
2335     {ESC,		(char_u *)"Esc"},
2336     {CSI,		(char_u *)"CSI"},
2337     {K_CSI,		(char_u *)"xCSI"},
2338     {'|',		(char_u *)"Bar"},
2339     {'\\',		(char_u *)"Bslash"},
2340     {K_DEL,		(char_u *)"Del"},
2341     {K_DEL,		(char_u *)"Delete"},	/* Alternative name */
2342     {K_KDEL,		(char_u *)"kDel"},
2343     {K_UP,		(char_u *)"Up"},
2344     {K_DOWN,		(char_u *)"Down"},
2345     {K_LEFT,		(char_u *)"Left"},
2346     {K_RIGHT,		(char_u *)"Right"},
2347     {K_XUP,		(char_u *)"xUp"},
2348     {K_XDOWN,		(char_u *)"xDown"},
2349     {K_XLEFT,		(char_u *)"xLeft"},
2350     {K_XRIGHT,		(char_u *)"xRight"},
2351     {K_PS,		(char_u *)"PasteStart"},
2352     {K_PE,		(char_u *)"PasteEnd"},
2353 
2354     {K_F1,		(char_u *)"F1"},
2355     {K_F2,		(char_u *)"F2"},
2356     {K_F3,		(char_u *)"F3"},
2357     {K_F4,		(char_u *)"F4"},
2358     {K_F5,		(char_u *)"F5"},
2359     {K_F6,		(char_u *)"F6"},
2360     {K_F7,		(char_u *)"F7"},
2361     {K_F8,		(char_u *)"F8"},
2362     {K_F9,		(char_u *)"F9"},
2363     {K_F10,		(char_u *)"F10"},
2364 
2365     {K_F11,		(char_u *)"F11"},
2366     {K_F12,		(char_u *)"F12"},
2367     {K_F13,		(char_u *)"F13"},
2368     {K_F14,		(char_u *)"F14"},
2369     {K_F15,		(char_u *)"F15"},
2370     {K_F16,		(char_u *)"F16"},
2371     {K_F17,		(char_u *)"F17"},
2372     {K_F18,		(char_u *)"F18"},
2373     {K_F19,		(char_u *)"F19"},
2374     {K_F20,		(char_u *)"F20"},
2375 
2376     {K_F21,		(char_u *)"F21"},
2377     {K_F22,		(char_u *)"F22"},
2378     {K_F23,		(char_u *)"F23"},
2379     {K_F24,		(char_u *)"F24"},
2380     {K_F25,		(char_u *)"F25"},
2381     {K_F26,		(char_u *)"F26"},
2382     {K_F27,		(char_u *)"F27"},
2383     {K_F28,		(char_u *)"F28"},
2384     {K_F29,		(char_u *)"F29"},
2385     {K_F30,		(char_u *)"F30"},
2386 
2387     {K_F31,		(char_u *)"F31"},
2388     {K_F32,		(char_u *)"F32"},
2389     {K_F33,		(char_u *)"F33"},
2390     {K_F34,		(char_u *)"F34"},
2391     {K_F35,		(char_u *)"F35"},
2392     {K_F36,		(char_u *)"F36"},
2393     {K_F37,		(char_u *)"F37"},
2394 
2395     {K_XF1,		(char_u *)"xF1"},
2396     {K_XF2,		(char_u *)"xF2"},
2397     {K_XF3,		(char_u *)"xF3"},
2398     {K_XF4,		(char_u *)"xF4"},
2399 
2400     {K_HELP,		(char_u *)"Help"},
2401     {K_UNDO,		(char_u *)"Undo"},
2402     {K_INS,		(char_u *)"Insert"},
2403     {K_INS,		(char_u *)"Ins"},	/* Alternative name */
2404     {K_KINS,		(char_u *)"kInsert"},
2405     {K_HOME,		(char_u *)"Home"},
2406     {K_KHOME,		(char_u *)"kHome"},
2407     {K_XHOME,		(char_u *)"xHome"},
2408     {K_ZHOME,		(char_u *)"zHome"},
2409     {K_END,		(char_u *)"End"},
2410     {K_KEND,		(char_u *)"kEnd"},
2411     {K_XEND,		(char_u *)"xEnd"},
2412     {K_ZEND,		(char_u *)"zEnd"},
2413     {K_PAGEUP,		(char_u *)"PageUp"},
2414     {K_PAGEDOWN,	(char_u *)"PageDown"},
2415     {K_KPAGEUP,		(char_u *)"kPageUp"},
2416     {K_KPAGEDOWN,	(char_u *)"kPageDown"},
2417 
2418     {K_KPLUS,		(char_u *)"kPlus"},
2419     {K_KMINUS,		(char_u *)"kMinus"},
2420     {K_KDIVIDE,		(char_u *)"kDivide"},
2421     {K_KMULTIPLY,	(char_u *)"kMultiply"},
2422     {K_KENTER,		(char_u *)"kEnter"},
2423     {K_KPOINT,		(char_u *)"kPoint"},
2424 
2425     {K_K0,		(char_u *)"k0"},
2426     {K_K1,		(char_u *)"k1"},
2427     {K_K2,		(char_u *)"k2"},
2428     {K_K3,		(char_u *)"k3"},
2429     {K_K4,		(char_u *)"k4"},
2430     {K_K5,		(char_u *)"k5"},
2431     {K_K6,		(char_u *)"k6"},
2432     {K_K7,		(char_u *)"k7"},
2433     {K_K8,		(char_u *)"k8"},
2434     {K_K9,		(char_u *)"k9"},
2435 
2436     {'<',		(char_u *)"lt"},
2437 
2438     {K_MOUSE,		(char_u *)"Mouse"},
2439 #ifdef FEAT_MOUSE_NET
2440     {K_NETTERM_MOUSE,	(char_u *)"NetMouse"},
2441 #endif
2442 #ifdef FEAT_MOUSE_DEC
2443     {K_DEC_MOUSE,	(char_u *)"DecMouse"},
2444 #endif
2445 #ifdef FEAT_MOUSE_JSB
2446     {K_JSBTERM_MOUSE,	(char_u *)"JsbMouse"},
2447 #endif
2448 #ifdef FEAT_MOUSE_PTERM
2449     {K_PTERM_MOUSE,	(char_u *)"PtermMouse"},
2450 #endif
2451 #ifdef FEAT_MOUSE_URXVT
2452     {K_URXVT_MOUSE,	(char_u *)"UrxvtMouse"},
2453 #endif
2454     {K_SGR_MOUSE,	(char_u *)"SgrMouse"},
2455     {K_SGR_MOUSERELEASE, (char_u *)"SgrMouseRelelase"},
2456     {K_LEFTMOUSE,	(char_u *)"LeftMouse"},
2457     {K_LEFTMOUSE_NM,	(char_u *)"LeftMouseNM"},
2458     {K_LEFTDRAG,	(char_u *)"LeftDrag"},
2459     {K_LEFTRELEASE,	(char_u *)"LeftRelease"},
2460     {K_LEFTRELEASE_NM,	(char_u *)"LeftReleaseNM"},
2461     {K_MOUSEMOVE,	(char_u *)"MouseMove"},
2462     {K_MIDDLEMOUSE,	(char_u *)"MiddleMouse"},
2463     {K_MIDDLEDRAG,	(char_u *)"MiddleDrag"},
2464     {K_MIDDLERELEASE,	(char_u *)"MiddleRelease"},
2465     {K_RIGHTMOUSE,	(char_u *)"RightMouse"},
2466     {K_RIGHTDRAG,	(char_u *)"RightDrag"},
2467     {K_RIGHTRELEASE,	(char_u *)"RightRelease"},
2468     {K_MOUSEDOWN,	(char_u *)"ScrollWheelUp"},
2469     {K_MOUSEUP,		(char_u *)"ScrollWheelDown"},
2470     {K_MOUSELEFT,	(char_u *)"ScrollWheelRight"},
2471     {K_MOUSERIGHT,	(char_u *)"ScrollWheelLeft"},
2472     {K_MOUSEDOWN,	(char_u *)"MouseDown"}, /* OBSOLETE: Use	  */
2473     {K_MOUSEUP,		(char_u *)"MouseUp"},	/* ScrollWheelXXX instead */
2474     {K_X1MOUSE,		(char_u *)"X1Mouse"},
2475     {K_X1DRAG,		(char_u *)"X1Drag"},
2476     {K_X1RELEASE,		(char_u *)"X1Release"},
2477     {K_X2MOUSE,		(char_u *)"X2Mouse"},
2478     {K_X2DRAG,		(char_u *)"X2Drag"},
2479     {K_X2RELEASE,		(char_u *)"X2Release"},
2480     {K_DROP,		(char_u *)"Drop"},
2481     {K_ZERO,		(char_u *)"Nul"},
2482 #ifdef FEAT_EVAL
2483     {K_SNR,		(char_u *)"SNR"},
2484 #endif
2485     {K_PLUG,		(char_u *)"Plug"},
2486     {K_CURSORHOLD,	(char_u *)"CursorHold"},
2487     {K_IGNORE,		(char_u *)"Ignore"},
2488     {0,			NULL}
2489     /* NOTE: When adding a long name update MAX_KEY_NAME_LEN. */
2490 };
2491 
2492 #define KEY_NAMES_TABLE_LEN (sizeof(key_names_table) / sizeof(struct key_name_entry))
2493 
2494 /*
2495  * Return the modifier mask bit (MOD_MASK_*) which corresponds to the given
2496  * modifier name ('S' for Shift, 'C' for Ctrl etc).
2497  */
2498     static int
2499 name_to_mod_mask(int c)
2500 {
2501     int	    i;
2502 
2503     c = TOUPPER_ASC(c);
2504     for (i = 0; mod_mask_table[i].mod_mask != 0; i++)
2505 	if (c == mod_mask_table[i].name)
2506 	    return mod_mask_table[i].mod_flag;
2507     return 0;
2508 }
2509 
2510 /*
2511  * Check if if there is a special key code for "key" that includes the
2512  * modifiers specified.
2513  */
2514     int
2515 simplify_key(int key, int *modifiers)
2516 {
2517     int	    i;
2518     int	    key0;
2519     int	    key1;
2520 
2521     if (*modifiers & (MOD_MASK_SHIFT | MOD_MASK_CTRL | MOD_MASK_ALT))
2522     {
2523 	/* TAB is a special case */
2524 	if (key == TAB && (*modifiers & MOD_MASK_SHIFT))
2525 	{
2526 	    *modifiers &= ~MOD_MASK_SHIFT;
2527 	    return K_S_TAB;
2528 	}
2529 	key0 = KEY2TERMCAP0(key);
2530 	key1 = KEY2TERMCAP1(key);
2531 	for (i = 0; modifier_keys_table[i] != NUL; i += MOD_KEYS_ENTRY_SIZE)
2532 	    if (key0 == modifier_keys_table[i + 3]
2533 		    && key1 == modifier_keys_table[i + 4]
2534 		    && (*modifiers & modifier_keys_table[i]))
2535 	    {
2536 		*modifiers &= ~modifier_keys_table[i];
2537 		return TERMCAP2KEY(modifier_keys_table[i + 1],
2538 						   modifier_keys_table[i + 2]);
2539 	    }
2540     }
2541     return key;
2542 }
2543 
2544 /*
2545  * Change <xHome> to <Home>, <xUp> to <Up>, etc.
2546  */
2547     int
2548 handle_x_keys(int key)
2549 {
2550     switch (key)
2551     {
2552 	case K_XUP:	return K_UP;
2553 	case K_XDOWN:	return K_DOWN;
2554 	case K_XLEFT:	return K_LEFT;
2555 	case K_XRIGHT:	return K_RIGHT;
2556 	case K_XHOME:	return K_HOME;
2557 	case K_ZHOME:	return K_HOME;
2558 	case K_XEND:	return K_END;
2559 	case K_ZEND:	return K_END;
2560 	case K_XF1:	return K_F1;
2561 	case K_XF2:	return K_F2;
2562 	case K_XF3:	return K_F3;
2563 	case K_XF4:	return K_F4;
2564 	case K_S_XF1:	return K_S_F1;
2565 	case K_S_XF2:	return K_S_F2;
2566 	case K_S_XF3:	return K_S_F3;
2567 	case K_S_XF4:	return K_S_F4;
2568     }
2569     return key;
2570 }
2571 
2572 /*
2573  * Return a string which contains the name of the given key when the given
2574  * modifiers are down.
2575  */
2576     char_u *
2577 get_special_key_name(int c, int modifiers)
2578 {
2579     static char_u string[MAX_KEY_NAME_LEN + 1];
2580 
2581     int	    i, idx;
2582     int	    table_idx;
2583     char_u  *s;
2584 
2585     string[0] = '<';
2586     idx = 1;
2587 
2588     /* Key that stands for a normal character. */
2589     if (IS_SPECIAL(c) && KEY2TERMCAP0(c) == KS_KEY)
2590 	c = KEY2TERMCAP1(c);
2591 
2592     /*
2593      * Translate shifted special keys into unshifted keys and set modifier.
2594      * Same for CTRL and ALT modifiers.
2595      */
2596     if (IS_SPECIAL(c))
2597     {
2598 	for (i = 0; modifier_keys_table[i] != 0; i += MOD_KEYS_ENTRY_SIZE)
2599 	    if (       KEY2TERMCAP0(c) == (int)modifier_keys_table[i + 1]
2600 		    && (int)KEY2TERMCAP1(c) == (int)modifier_keys_table[i + 2])
2601 	    {
2602 		modifiers |= modifier_keys_table[i];
2603 		c = TERMCAP2KEY(modifier_keys_table[i + 3],
2604 						   modifier_keys_table[i + 4]);
2605 		break;
2606 	    }
2607     }
2608 
2609     /* try to find the key in the special key table */
2610     table_idx = find_special_key_in_table(c);
2611 
2612     /*
2613      * When not a known special key, and not a printable character, try to
2614      * extract modifiers.
2615      */
2616     if (c > 0 && (*mb_char2len)(c) == 1)
2617     {
2618 	if (table_idx < 0
2619 		&& (!vim_isprintc(c) || (c & 0x7f) == ' ')
2620 		&& (c & 0x80))
2621 	{
2622 	    c &= 0x7f;
2623 	    modifiers |= MOD_MASK_ALT;
2624 	    /* try again, to find the un-alted key in the special key table */
2625 	    table_idx = find_special_key_in_table(c);
2626 	}
2627 	if (table_idx < 0 && !vim_isprintc(c) && c < ' ')
2628 	{
2629 #ifdef EBCDIC
2630 	    c = CtrlChar(c);
2631 #else
2632 	    c += '@';
2633 #endif
2634 	    modifiers |= MOD_MASK_CTRL;
2635 	}
2636     }
2637 
2638     /* translate the modifier into a string */
2639     for (i = 0; mod_mask_table[i].name != 'A'; i++)
2640 	if ((modifiers & mod_mask_table[i].mod_mask)
2641 						== mod_mask_table[i].mod_flag)
2642 	{
2643 	    string[idx++] = mod_mask_table[i].name;
2644 	    string[idx++] = (char_u)'-';
2645 	}
2646 
2647     if (table_idx < 0)		/* unknown special key, may output t_xx */
2648     {
2649 	if (IS_SPECIAL(c))
2650 	{
2651 	    string[idx++] = 't';
2652 	    string[idx++] = '_';
2653 	    string[idx++] = KEY2TERMCAP0(c);
2654 	    string[idx++] = KEY2TERMCAP1(c);
2655 	}
2656 	/* Not a special key, only modifiers, output directly */
2657 	else
2658 	{
2659 	    if (has_mbyte && (*mb_char2len)(c) > 1)
2660 		idx += (*mb_char2bytes)(c, string + idx);
2661 	    else if (vim_isprintc(c))
2662 		string[idx++] = c;
2663 	    else
2664 	    {
2665 		s = transchar(c);
2666 		while (*s)
2667 		    string[idx++] = *s++;
2668 	    }
2669 	}
2670     }
2671     else		/* use name of special key */
2672     {
2673 	size_t len = STRLEN(key_names_table[table_idx].name);
2674 
2675 	if (len + idx + 2 <= MAX_KEY_NAME_LEN)
2676 	{
2677 	    STRCPY(string + idx, key_names_table[table_idx].name);
2678 	    idx += (int)len;
2679 	}
2680     }
2681     string[idx++] = '>';
2682     string[idx] = NUL;
2683     return string;
2684 }
2685 
2686 /*
2687  * Try translating a <> name at (*srcp)[] to dst[].
2688  * Return the number of characters added to dst[], zero for no match.
2689  * If there is a match, srcp is advanced to after the <> name.
2690  * dst[] must be big enough to hold the result (up to six characters)!
2691  */
2692     int
2693 trans_special(
2694     char_u	**srcp,
2695     char_u	*dst,
2696     int		keycode,    // prefer key code, e.g. K_DEL instead of DEL
2697     int		in_string)  // TRUE when inside a double quoted string
2698 {
2699     int		modifiers = 0;
2700     int		key;
2701 
2702     key = find_special_key(srcp, &modifiers, keycode, FALSE, in_string);
2703     if (key == 0)
2704 	return 0;
2705 
2706     return special_to_buf(key, modifiers, keycode, dst);
2707 }
2708 
2709 /*
2710  * Put the character sequence for "key" with "modifiers" into "dst" and return
2711  * the resulting length.
2712  * When "keycode" is TRUE prefer key code, e.g. K_DEL instead of DEL.
2713  * The sequence is not NUL terminated.
2714  * This is how characters in a string are encoded.
2715  */
2716     int
2717 special_to_buf(int key, int modifiers, int keycode, char_u *dst)
2718 {
2719     int		dlen = 0;
2720 
2721     /* Put the appropriate modifier in a string */
2722     if (modifiers != 0)
2723     {
2724 	dst[dlen++] = K_SPECIAL;
2725 	dst[dlen++] = KS_MODIFIER;
2726 	dst[dlen++] = modifiers;
2727     }
2728 
2729     if (IS_SPECIAL(key))
2730     {
2731 	dst[dlen++] = K_SPECIAL;
2732 	dst[dlen++] = KEY2TERMCAP0(key);
2733 	dst[dlen++] = KEY2TERMCAP1(key);
2734     }
2735     else if (has_mbyte && !keycode)
2736 	dlen += (*mb_char2bytes)(key, dst + dlen);
2737     else if (keycode)
2738 	dlen = (int)(add_char2buf(key, dst + dlen) - dst);
2739     else
2740 	dst[dlen++] = key;
2741 
2742     return dlen;
2743 }
2744 
2745 /*
2746  * Try translating a <> name at (*srcp)[], return the key and modifiers.
2747  * srcp is advanced to after the <> name.
2748  * returns 0 if there is no match.
2749  */
2750     int
2751 find_special_key(
2752     char_u	**srcp,
2753     int		*modp,
2754     int		keycode,     /* prefer key code, e.g. K_DEL instead of DEL */
2755     int		keep_x_key,  /* don't translate xHome to Home key */
2756     int		in_string)   /* TRUE in string, double quote is escaped */
2757 {
2758     char_u	*last_dash;
2759     char_u	*end_of_name;
2760     char_u	*src;
2761     char_u	*bp;
2762     int		modifiers;
2763     int		bit;
2764     int		key;
2765     uvarnumber_T	n;
2766     int		l;
2767 
2768     src = *srcp;
2769     if (src[0] != '<')
2770 	return 0;
2771 
2772     /* Find end of modifier list */
2773     last_dash = src;
2774     for (bp = src + 1; *bp == '-' || vim_isIDc(*bp); bp++)
2775     {
2776 	if (*bp == '-')
2777 	{
2778 	    last_dash = bp;
2779 	    if (bp[1] != NUL)
2780 	    {
2781 		if (has_mbyte)
2782 		    l = mb_ptr2len(bp + 1);
2783 		else
2784 		    l = 1;
2785 		// Anything accepted, like <C-?>.
2786 		// <C-"> or <M-"> are not special in strings as " is
2787 		// the string delimiter. With a backslash it works: <M-\">
2788 		if (!(in_string && bp[1] == '"') && bp[l + 1] == '>')
2789 		    bp += l;
2790 		else if (in_string && bp[1] == '\\' && bp[2] == '"'
2791 							       && bp[3] == '>')
2792 		    bp += 2;
2793 	    }
2794 	}
2795 	if (bp[0] == 't' && bp[1] == '_' && bp[2] && bp[3])
2796 	    bp += 3;	/* skip t_xx, xx may be '-' or '>' */
2797 	else if (STRNICMP(bp, "char-", 5) == 0)
2798 	{
2799 	    vim_str2nr(bp + 5, NULL, &l, STR2NR_ALL, NULL, NULL, 0, TRUE);
2800 	    if (l == 0)
2801 	    {
2802 		emsg(_(e_invarg));
2803 		return 0;
2804 	    }
2805 	    bp += l + 5;
2806 	    break;
2807 	}
2808     }
2809 
2810     if (*bp == '>')	/* found matching '>' */
2811     {
2812 	end_of_name = bp + 1;
2813 
2814 	/* Which modifiers are given? */
2815 	modifiers = 0x0;
2816 	for (bp = src + 1; bp < last_dash; bp++)
2817 	{
2818 	    if (*bp != '-')
2819 	    {
2820 		bit = name_to_mod_mask(*bp);
2821 		if (bit == 0x0)
2822 		    break;	/* Illegal modifier name */
2823 		modifiers |= bit;
2824 	    }
2825 	}
2826 
2827 	/*
2828 	 * Legal modifier name.
2829 	 */
2830 	if (bp >= last_dash)
2831 	{
2832 	    if (STRNICMP(last_dash + 1, "char-", 5) == 0
2833 						 && VIM_ISDIGIT(last_dash[6]))
2834 	    {
2835 		/* <Char-123> or <Char-033> or <Char-0x33> */
2836 		vim_str2nr(last_dash + 6, NULL, &l, STR2NR_ALL, NULL, &n, 0, TRUE);
2837 		if (l == 0)
2838 		{
2839 		    emsg(_(e_invarg));
2840 		    return 0;
2841 		}
2842 		key = (int)n;
2843 	    }
2844 	    else
2845 	    {
2846 		int off = 1;
2847 
2848 		/* Modifier with single letter, or special key name.  */
2849 		if (in_string && last_dash[1] == '\\' && last_dash[2] == '"')
2850 		    off = 2;
2851 		if (has_mbyte)
2852 		    l = mb_ptr2len(last_dash + off);
2853 		else
2854 		    l = 1;
2855 		if (modifiers != 0 && last_dash[l + off] == '>')
2856 		    key = PTR2CHAR(last_dash + off);
2857 		else
2858 		{
2859 		    key = get_special_key_code(last_dash + off);
2860 		    if (!keep_x_key)
2861 			key = handle_x_keys(key);
2862 		}
2863 	    }
2864 
2865 	    /*
2866 	     * get_special_key_code() may return NUL for invalid
2867 	     * special key name.
2868 	     */
2869 	    if (key != NUL)
2870 	    {
2871 		/*
2872 		 * Only use a modifier when there is no special key code that
2873 		 * includes the modifier.
2874 		 */
2875 		key = simplify_key(key, &modifiers);
2876 
2877 		if (!keycode)
2878 		{
2879 		    /* don't want keycode, use single byte code */
2880 		    if (key == K_BS)
2881 			key = BS;
2882 		    else if (key == K_DEL || key == K_KDEL)
2883 			key = DEL;
2884 		}
2885 
2886 		/*
2887 		 * Normal Key with modifier: Try to make a single byte code.
2888 		 */
2889 		if (!IS_SPECIAL(key))
2890 		    key = extract_modifiers(key, &modifiers);
2891 
2892 		*modp = modifiers;
2893 		*srcp = end_of_name;
2894 		return key;
2895 	    }
2896 	}
2897     }
2898     return 0;
2899 }
2900 
2901 /*
2902  * Try to include modifiers in the key.
2903  * Changes "Shift-a" to 'A', "Alt-A" to 0xc0, etc.
2904  */
2905     int
2906 extract_modifiers(int key, int *modp)
2907 {
2908     int	modifiers = *modp;
2909 
2910 #ifdef MACOS_X
2911     /* Command-key really special, no fancynest */
2912     if (!(modifiers & MOD_MASK_CMD))
2913 #endif
2914     if ((modifiers & MOD_MASK_SHIFT) && ASCII_ISALPHA(key))
2915     {
2916 	key = TOUPPER_ASC(key);
2917 	modifiers &= ~MOD_MASK_SHIFT;
2918     }
2919     if ((modifiers & MOD_MASK_CTRL)
2920 #ifdef EBCDIC
2921 	    /* * TODO: EBCDIC Better use:
2922 	     * && (Ctrl_chr(key) || key == '?')
2923 	     * ???  */
2924 	    && strchr("?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_", key)
2925 						       != NULL
2926 #else
2927 	    && ((key >= '?' && key <= '_') || ASCII_ISALPHA(key))
2928 #endif
2929 	    )
2930     {
2931 	key = Ctrl_chr(key);
2932 	modifiers &= ~MOD_MASK_CTRL;
2933 	/* <C-@> is <Nul> */
2934 	if (key == 0)
2935 	    key = K_ZERO;
2936     }
2937 #ifdef MACOS_X
2938     /* Command-key really special, no fancynest */
2939     if (!(modifiers & MOD_MASK_CMD))
2940 #endif
2941     if ((modifiers & MOD_MASK_ALT) && key < 0x80
2942 	    && !enc_dbcs)		// avoid creating a lead byte
2943     {
2944 	key |= 0x80;
2945 	modifiers &= ~MOD_MASK_ALT;	/* remove the META modifier */
2946     }
2947 
2948     *modp = modifiers;
2949     return key;
2950 }
2951 
2952 /*
2953  * Try to find key "c" in the special key table.
2954  * Return the index when found, -1 when not found.
2955  */
2956     int
2957 find_special_key_in_table(int c)
2958 {
2959     int	    i;
2960 
2961     for (i = 0; key_names_table[i].name != NULL; i++)
2962 	if (c == key_names_table[i].key)
2963 	    break;
2964     if (key_names_table[i].name == NULL)
2965 	i = -1;
2966     return i;
2967 }
2968 
2969 /*
2970  * Find the special key with the given name (the given string does not have to
2971  * end with NUL, the name is assumed to end before the first non-idchar).
2972  * If the name starts with "t_" the next two characters are interpreted as a
2973  * termcap name.
2974  * Return the key code, or 0 if not found.
2975  */
2976     int
2977 get_special_key_code(char_u *name)
2978 {
2979     char_u  *table_name;
2980     char_u  string[3];
2981     int	    i, j;
2982 
2983     /*
2984      * If it's <t_xx> we get the code for xx from the termcap
2985      */
2986     if (name[0] == 't' && name[1] == '_' && name[2] != NUL && name[3] != NUL)
2987     {
2988 	string[0] = name[2];
2989 	string[1] = name[3];
2990 	string[2] = NUL;
2991 	if (add_termcap_entry(string, FALSE) == OK)
2992 	    return TERMCAP2KEY(name[2], name[3]);
2993     }
2994     else
2995 	for (i = 0; key_names_table[i].name != NULL; i++)
2996 	{
2997 	    table_name = key_names_table[i].name;
2998 	    for (j = 0; vim_isIDc(name[j]) && table_name[j] != NUL; j++)
2999 		if (TOLOWER_ASC(table_name[j]) != TOLOWER_ASC(name[j]))
3000 		    break;
3001 	    if (!vim_isIDc(name[j]) && table_name[j] == NUL)
3002 		return key_names_table[i].key;
3003 	}
3004     return 0;
3005 }
3006 
3007     char_u *
3008 get_key_name(int i)
3009 {
3010     if (i >= (int)KEY_NAMES_TABLE_LEN)
3011 	return NULL;
3012     return  key_names_table[i].name;
3013 }
3014 
3015 /*
3016  * Return the current end-of-line type: EOL_DOS, EOL_UNIX or EOL_MAC.
3017  */
3018     int
3019 get_fileformat(buf_T *buf)
3020 {
3021     int		c = *buf->b_p_ff;
3022 
3023     if (buf->b_p_bin || c == 'u')
3024 	return EOL_UNIX;
3025     if (c == 'm')
3026 	return EOL_MAC;
3027     return EOL_DOS;
3028 }
3029 
3030 /*
3031  * Like get_fileformat(), but override 'fileformat' with "p" for "++opt=val"
3032  * argument.
3033  */
3034     int
3035 get_fileformat_force(
3036     buf_T	*buf,
3037     exarg_T	*eap)	    /* can be NULL! */
3038 {
3039     int		c;
3040 
3041     if (eap != NULL && eap->force_ff != 0)
3042 	c = eap->force_ff;
3043     else
3044     {
3045 	if ((eap != NULL && eap->force_bin != 0)
3046 			       ? (eap->force_bin == FORCE_BIN) : buf->b_p_bin)
3047 	    return EOL_UNIX;
3048 	c = *buf->b_p_ff;
3049     }
3050     if (c == 'u')
3051 	return EOL_UNIX;
3052     if (c == 'm')
3053 	return EOL_MAC;
3054     return EOL_DOS;
3055 }
3056 
3057 /*
3058  * Set the current end-of-line type to EOL_DOS, EOL_UNIX or EOL_MAC.
3059  * Sets both 'textmode' and 'fileformat'.
3060  * Note: Does _not_ set global value of 'textmode'!
3061  */
3062     void
3063 set_fileformat(
3064     int		t,
3065     int		opt_flags)	/* OPT_LOCAL and/or OPT_GLOBAL */
3066 {
3067     char	*p = NULL;
3068 
3069     switch (t)
3070     {
3071     case EOL_DOS:
3072 	p = FF_DOS;
3073 	curbuf->b_p_tx = TRUE;
3074 	break;
3075     case EOL_UNIX:
3076 	p = FF_UNIX;
3077 	curbuf->b_p_tx = FALSE;
3078 	break;
3079     case EOL_MAC:
3080 	p = FF_MAC;
3081 	curbuf->b_p_tx = FALSE;
3082 	break;
3083     }
3084     if (p != NULL)
3085 	set_string_option_direct((char_u *)"ff", -1, (char_u *)p,
3086 						     OPT_FREE | opt_flags, 0);
3087 
3088     /* This may cause the buffer to become (un)modified. */
3089     check_status(curbuf);
3090     redraw_tabline = TRUE;
3091 #ifdef FEAT_TITLE
3092     need_maketitle = TRUE;	    /* set window title later */
3093 #endif
3094 }
3095 
3096 /*
3097  * Return the default fileformat from 'fileformats'.
3098  */
3099     int
3100 default_fileformat(void)
3101 {
3102     switch (*p_ffs)
3103     {
3104 	case 'm':   return EOL_MAC;
3105 	case 'd':   return EOL_DOS;
3106     }
3107     return EOL_UNIX;
3108 }
3109 
3110 /*
3111  * Call shell.	Calls mch_call_shell, with 'shellxquote' added.
3112  */
3113     int
3114 call_shell(char_u *cmd, int opt)
3115 {
3116     char_u	*ncmd;
3117     int		retval;
3118 #ifdef FEAT_PROFILE
3119     proftime_T	wait_time;
3120 #endif
3121 
3122     if (p_verbose > 3)
3123     {
3124 	verbose_enter();
3125 	smsg(_("Calling shell to execute: \"%s\""),
3126 						    cmd == NULL ? p_sh : cmd);
3127 	out_char('\n');
3128 	cursor_on();
3129 	verbose_leave();
3130     }
3131 
3132 #ifdef FEAT_PROFILE
3133     if (do_profiling == PROF_YES)
3134 	prof_child_enter(&wait_time);
3135 #endif
3136 
3137     if (*p_sh == NUL)
3138     {
3139 	emsg(_(e_shellempty));
3140 	retval = -1;
3141     }
3142     else
3143     {
3144 #ifdef FEAT_GUI_MSWIN
3145 	/* Don't hide the pointer while executing a shell command. */
3146 	gui_mch_mousehide(FALSE);
3147 #endif
3148 #ifdef FEAT_GUI
3149 	++hold_gui_events;
3150 #endif
3151 	/* The external command may update a tags file, clear cached tags. */
3152 	tag_freematch();
3153 
3154 	if (cmd == NULL || *p_sxq == NUL)
3155 	    retval = mch_call_shell(cmd, opt);
3156 	else
3157 	{
3158 	    char_u *ecmd = cmd;
3159 
3160 	    if (*p_sxe != NUL && STRCMP(p_sxq, "(") == 0)
3161 	    {
3162 		ecmd = vim_strsave_escaped_ext(cmd, p_sxe, '^', FALSE);
3163 		if (ecmd == NULL)
3164 		    ecmd = cmd;
3165 	    }
3166 	    ncmd = alloc(STRLEN(ecmd) + STRLEN(p_sxq) * 2 + 1);
3167 	    if (ncmd != NULL)
3168 	    {
3169 		STRCPY(ncmd, p_sxq);
3170 		STRCAT(ncmd, ecmd);
3171 		/* When 'shellxquote' is ( append ).
3172 		 * When 'shellxquote' is "( append )". */
3173 		STRCAT(ncmd, STRCMP(p_sxq, "(") == 0 ? (char_u *)")"
3174 			   : STRCMP(p_sxq, "\"(") == 0 ? (char_u *)")\""
3175 			   : p_sxq);
3176 		retval = mch_call_shell(ncmd, opt);
3177 		vim_free(ncmd);
3178 	    }
3179 	    else
3180 		retval = -1;
3181 	    if (ecmd != cmd)
3182 		vim_free(ecmd);
3183 	}
3184 #ifdef FEAT_GUI
3185 	--hold_gui_events;
3186 #endif
3187 	/*
3188 	 * Check the window size, in case it changed while executing the
3189 	 * external command.
3190 	 */
3191 	shell_resized_check();
3192     }
3193 
3194 #ifdef FEAT_EVAL
3195     set_vim_var_nr(VV_SHELL_ERROR, (long)retval);
3196 # ifdef FEAT_PROFILE
3197     if (do_profiling == PROF_YES)
3198 	prof_child_exit(&wait_time);
3199 # endif
3200 #endif
3201 
3202     return retval;
3203 }
3204 
3205 /*
3206  * VISUAL, SELECTMODE and OP_PENDING State are never set, they are equal to
3207  * NORMAL State with a condition.  This function returns the real State.
3208  */
3209     int
3210 get_real_state(void)
3211 {
3212     if (State & NORMAL)
3213     {
3214 	if (VIsual_active)
3215 	{
3216 	    if (VIsual_select)
3217 		return SELECTMODE;
3218 	    return VISUAL;
3219 	}
3220 	else if (finish_op)
3221 	    return OP_PENDING;
3222     }
3223     return State;
3224 }
3225 
3226 /*
3227  * Return TRUE if "p" points to just after a path separator.
3228  * Takes care of multi-byte characters.
3229  * "b" must point to the start of the file name
3230  */
3231     int
3232 after_pathsep(char_u *b, char_u *p)
3233 {
3234     return p > b && vim_ispathsep(p[-1])
3235 			     && (!has_mbyte || (*mb_head_off)(b, p - 1) == 0);
3236 }
3237 
3238 /*
3239  * Return TRUE if file names "f1" and "f2" are in the same directory.
3240  * "f1" may be a short name, "f2" must be a full path.
3241  */
3242     int
3243 same_directory(char_u *f1, char_u *f2)
3244 {
3245     char_u	ffname[MAXPATHL];
3246     char_u	*t1;
3247     char_u	*t2;
3248 
3249     /* safety check */
3250     if (f1 == NULL || f2 == NULL)
3251 	return FALSE;
3252 
3253     (void)vim_FullName(f1, ffname, MAXPATHL, FALSE);
3254     t1 = gettail_sep(ffname);
3255     t2 = gettail_sep(f2);
3256     return (t1 - ffname == t2 - f2
3257 	     && pathcmp((char *)ffname, (char *)f2, (int)(t1 - ffname)) == 0);
3258 }
3259 
3260 #if defined(FEAT_SESSION) || defined(FEAT_AUTOCHDIR) \
3261 	|| defined(MSWIN) || defined(FEAT_GUI_MAC) || defined(FEAT_GUI_GTK) \
3262 	|| defined(FEAT_NETBEANS_INTG) \
3263 	|| defined(PROTO)
3264 /*
3265  * Change to a file's directory.
3266  * Caller must call shorten_fnames()!
3267  * Return OK or FAIL.
3268  */
3269     int
3270 vim_chdirfile(char_u *fname, char *trigger_autocmd)
3271 {
3272     char_u	old_dir[MAXPATHL];
3273     char_u	new_dir[MAXPATHL];
3274     int		res;
3275 
3276     if (mch_dirname(old_dir, MAXPATHL) != OK)
3277 	*old_dir = NUL;
3278 
3279     vim_strncpy(new_dir, fname, MAXPATHL - 1);
3280     *gettail_sep(new_dir) = NUL;
3281 
3282     if (pathcmp((char *)old_dir, (char *)new_dir, -1) == 0)
3283 	// nothing to do
3284 	res = OK;
3285     else
3286     {
3287 	res = mch_chdir((char *)new_dir) == 0 ? OK : FAIL;
3288 
3289 	if (res == OK && trigger_autocmd != NULL)
3290 	    apply_autocmds(EVENT_DIRCHANGED, (char_u *)trigger_autocmd,
3291 						       new_dir, FALSE, curbuf);
3292     }
3293     return res;
3294 }
3295 #endif
3296 
3297 #if defined(STAT_IGNORES_SLASH) || defined(PROTO)
3298 /*
3299  * Check if "name" ends in a slash and is not a directory.
3300  * Used for systems where stat() ignores a trailing slash on a file name.
3301  * The Vim code assumes a trailing slash is only ignored for a directory.
3302  */
3303     static int
3304 illegal_slash(const char *name)
3305 {
3306     if (name[0] == NUL)
3307 	return FALSE;	    /* no file name is not illegal */
3308     if (name[strlen(name) - 1] != '/')
3309 	return FALSE;	    /* no trailing slash */
3310     if (mch_isdir((char_u *)name))
3311 	return FALSE;	    /* trailing slash for a directory */
3312     return TRUE;
3313 }
3314 
3315 /*
3316  * Special implementation of mch_stat() for Solaris.
3317  */
3318     int
3319 vim_stat(const char *name, stat_T *stp)
3320 {
3321     /* On Solaris stat() accepts "file/" as if it was "file".  Return -1 if
3322      * the name ends in "/" and it's not a directory. */
3323     return illegal_slash(name) ? -1 : stat(name, stp);
3324 }
3325 #endif
3326 
3327 #if defined(CURSOR_SHAPE) || defined(PROTO)
3328 
3329 /*
3330  * Handling of cursor and mouse pointer shapes in various modes.
3331  */
3332 
3333 cursorentry_T shape_table[SHAPE_IDX_COUNT] =
3334 {
3335     /* The values will be filled in from the 'guicursor' and 'mouseshape'
3336      * defaults when Vim starts.
3337      * Adjust the SHAPE_IDX_ defines when making changes! */
3338     {0,	0, 0, 700L, 400L, 250L, 0, 0, "n", SHAPE_CURSOR+SHAPE_MOUSE},
3339     {0,	0, 0, 700L, 400L, 250L, 0, 0, "v", SHAPE_CURSOR+SHAPE_MOUSE},
3340     {0,	0, 0, 700L, 400L, 250L, 0, 0, "i", SHAPE_CURSOR+SHAPE_MOUSE},
3341     {0,	0, 0, 700L, 400L, 250L, 0, 0, "r", SHAPE_CURSOR+SHAPE_MOUSE},
3342     {0,	0, 0, 700L, 400L, 250L, 0, 0, "c", SHAPE_CURSOR+SHAPE_MOUSE},
3343     {0,	0, 0, 700L, 400L, 250L, 0, 0, "ci", SHAPE_CURSOR+SHAPE_MOUSE},
3344     {0,	0, 0, 700L, 400L, 250L, 0, 0, "cr", SHAPE_CURSOR+SHAPE_MOUSE},
3345     {0,	0, 0, 700L, 400L, 250L, 0, 0, "o", SHAPE_CURSOR+SHAPE_MOUSE},
3346     {0,	0, 0, 700L, 400L, 250L, 0, 0, "ve", SHAPE_CURSOR+SHAPE_MOUSE},
3347     {0,	0, 0,   0L,   0L,   0L, 0, 0, "e", SHAPE_MOUSE},
3348     {0,	0, 0,   0L,   0L,   0L, 0, 0, "s", SHAPE_MOUSE},
3349     {0,	0, 0,   0L,   0L,   0L, 0, 0, "sd", SHAPE_MOUSE},
3350     {0,	0, 0,   0L,   0L,   0L, 0, 0, "vs", SHAPE_MOUSE},
3351     {0,	0, 0,   0L,   0L,   0L, 0, 0, "vd", SHAPE_MOUSE},
3352     {0,	0, 0,   0L,   0L,   0L, 0, 0, "m", SHAPE_MOUSE},
3353     {0,	0, 0,   0L,   0L,   0L, 0, 0, "ml", SHAPE_MOUSE},
3354     {0,	0, 0, 100L, 100L, 100L, 0, 0, "sm", SHAPE_CURSOR},
3355 };
3356 
3357 #ifdef FEAT_MOUSESHAPE
3358 /*
3359  * Table with names for mouse shapes.  Keep in sync with all the tables for
3360  * mch_set_mouse_shape()!.
3361  */
3362 static char * mshape_names[] =
3363 {
3364     "arrow",	/* default, must be the first one */
3365     "blank",	/* hidden */
3366     "beam",
3367     "updown",
3368     "udsizing",
3369     "leftright",
3370     "lrsizing",
3371     "busy",
3372     "no",
3373     "crosshair",
3374     "hand1",
3375     "hand2",
3376     "pencil",
3377     "question",
3378     "rightup-arrow",
3379     "up-arrow",
3380     NULL
3381 };
3382 #endif
3383 
3384 /*
3385  * Parse the 'guicursor' option ("what" is SHAPE_CURSOR) or 'mouseshape'
3386  * ("what" is SHAPE_MOUSE).
3387  * Returns error message for an illegal option, NULL otherwise.
3388  */
3389     char *
3390 parse_shape_opt(int what)
3391 {
3392     char_u	*modep;
3393     char_u	*colonp;
3394     char_u	*commap;
3395     char_u	*slashp;
3396     char_u	*p, *endp;
3397     int		idx = 0;		/* init for GCC */
3398     int		all_idx;
3399     int		len;
3400     int		i;
3401     long	n;
3402     int		found_ve = FALSE;	/* found "ve" flag */
3403     int		round;
3404 
3405     /*
3406      * First round: check for errors; second round: do it for real.
3407      */
3408     for (round = 1; round <= 2; ++round)
3409     {
3410 	/*
3411 	 * Repeat for all comma separated parts.
3412 	 */
3413 #ifdef FEAT_MOUSESHAPE
3414 	if (what == SHAPE_MOUSE)
3415 	    modep = p_mouseshape;
3416 	else
3417 #endif
3418 	    modep = p_guicursor;
3419 	while (*modep != NUL)
3420 	{
3421 	    colonp = vim_strchr(modep, ':');
3422 	    commap = vim_strchr(modep, ',');
3423 
3424 	    if (colonp == NULL || (commap != NULL && commap < colonp))
3425 		return N_("E545: Missing colon");
3426 	    if (colonp == modep)
3427 		return N_("E546: Illegal mode");
3428 
3429 	    /*
3430 	     * Repeat for all mode's before the colon.
3431 	     * For the 'a' mode, we loop to handle all the modes.
3432 	     */
3433 	    all_idx = -1;
3434 	    while (modep < colonp || all_idx >= 0)
3435 	    {
3436 		if (all_idx < 0)
3437 		{
3438 		    /* Find the mode. */
3439 		    if (modep[1] == '-' || modep[1] == ':')
3440 			len = 1;
3441 		    else
3442 			len = 2;
3443 		    if (len == 1 && TOLOWER_ASC(modep[0]) == 'a')
3444 			all_idx = SHAPE_IDX_COUNT - 1;
3445 		    else
3446 		    {
3447 			for (idx = 0; idx < SHAPE_IDX_COUNT; ++idx)
3448 			    if (STRNICMP(modep, shape_table[idx].name, len)
3449 									 == 0)
3450 				break;
3451 			if (idx == SHAPE_IDX_COUNT
3452 				   || (shape_table[idx].used_for & what) == 0)
3453 			    return N_("E546: Illegal mode");
3454 			if (len == 2 && modep[0] == 'v' && modep[1] == 'e')
3455 			    found_ve = TRUE;
3456 		    }
3457 		    modep += len + 1;
3458 		}
3459 
3460 		if (all_idx >= 0)
3461 		    idx = all_idx--;
3462 		else if (round == 2)
3463 		{
3464 #ifdef FEAT_MOUSESHAPE
3465 		    if (what == SHAPE_MOUSE)
3466 		    {
3467 			/* Set the default, for the missing parts */
3468 			shape_table[idx].mshape = 0;
3469 		    }
3470 		    else
3471 #endif
3472 		    {
3473 			/* Set the defaults, for the missing parts */
3474 			shape_table[idx].shape = SHAPE_BLOCK;
3475 			shape_table[idx].blinkwait = 700L;
3476 			shape_table[idx].blinkon = 400L;
3477 			shape_table[idx].blinkoff = 250L;
3478 		    }
3479 		}
3480 
3481 		/* Parse the part after the colon */
3482 		for (p = colonp + 1; *p && *p != ','; )
3483 		{
3484 #ifdef FEAT_MOUSESHAPE
3485 		    if (what == SHAPE_MOUSE)
3486 		    {
3487 			for (i = 0; ; ++i)
3488 			{
3489 			    if (mshape_names[i] == NULL)
3490 			    {
3491 				if (!VIM_ISDIGIT(*p))
3492 				    return N_("E547: Illegal mouseshape");
3493 				if (round == 2)
3494 				    shape_table[idx].mshape =
3495 					      getdigits(&p) + MSHAPE_NUMBERED;
3496 				else
3497 				    (void)getdigits(&p);
3498 				break;
3499 			    }
3500 			    len = (int)STRLEN(mshape_names[i]);
3501 			    if (STRNICMP(p, mshape_names[i], len) == 0)
3502 			    {
3503 				if (round == 2)
3504 				    shape_table[idx].mshape = i;
3505 				p += len;
3506 				break;
3507 			    }
3508 			}
3509 		    }
3510 		    else /* if (what == SHAPE_MOUSE) */
3511 #endif
3512 		    {
3513 			/*
3514 			 * First handle the ones with a number argument.
3515 			 */
3516 			i = *p;
3517 			len = 0;
3518 			if (STRNICMP(p, "ver", 3) == 0)
3519 			    len = 3;
3520 			else if (STRNICMP(p, "hor", 3) == 0)
3521 			    len = 3;
3522 			else if (STRNICMP(p, "blinkwait", 9) == 0)
3523 			    len = 9;
3524 			else if (STRNICMP(p, "blinkon", 7) == 0)
3525 			    len = 7;
3526 			else if (STRNICMP(p, "blinkoff", 8) == 0)
3527 			    len = 8;
3528 			if (len != 0)
3529 			{
3530 			    p += len;
3531 			    if (!VIM_ISDIGIT(*p))
3532 				return N_("E548: digit expected");
3533 			    n = getdigits(&p);
3534 			    if (len == 3)   /* "ver" or "hor" */
3535 			    {
3536 				if (n == 0)
3537 				    return N_("E549: Illegal percentage");
3538 				if (round == 2)
3539 				{
3540 				    if (TOLOWER_ASC(i) == 'v')
3541 					shape_table[idx].shape = SHAPE_VER;
3542 				    else
3543 					shape_table[idx].shape = SHAPE_HOR;
3544 				    shape_table[idx].percentage = n;
3545 				}
3546 			    }
3547 			    else if (round == 2)
3548 			    {
3549 				if (len == 9)
3550 				    shape_table[idx].blinkwait = n;
3551 				else if (len == 7)
3552 				    shape_table[idx].blinkon = n;
3553 				else
3554 				    shape_table[idx].blinkoff = n;
3555 			    }
3556 			}
3557 			else if (STRNICMP(p, "block", 5) == 0)
3558 			{
3559 			    if (round == 2)
3560 				shape_table[idx].shape = SHAPE_BLOCK;
3561 			    p += 5;
3562 			}
3563 			else	/* must be a highlight group name then */
3564 			{
3565 			    endp = vim_strchr(p, '-');
3566 			    if (commap == NULL)		    /* last part */
3567 			    {
3568 				if (endp == NULL)
3569 				    endp = p + STRLEN(p);   /* find end of part */
3570 			    }
3571 			    else if (endp > commap || endp == NULL)
3572 				endp = commap;
3573 			    slashp = vim_strchr(p, '/');
3574 			    if (slashp != NULL && slashp < endp)
3575 			    {
3576 				/* "group/langmap_group" */
3577 				i = syn_check_group(p, (int)(slashp - p));
3578 				p = slashp + 1;
3579 			    }
3580 			    if (round == 2)
3581 			    {
3582 				shape_table[idx].id = syn_check_group(p,
3583 							     (int)(endp - p));
3584 				shape_table[idx].id_lm = shape_table[idx].id;
3585 				if (slashp != NULL && slashp < endp)
3586 				    shape_table[idx].id = i;
3587 			    }
3588 			    p = endp;
3589 			}
3590 		    } /* if (what != SHAPE_MOUSE) */
3591 
3592 		    if (*p == '-')
3593 			++p;
3594 		}
3595 	    }
3596 	    modep = p;
3597 	    if (*modep == ',')
3598 		++modep;
3599 	}
3600     }
3601 
3602     /* If the 's' flag is not given, use the 'v' cursor for 's' */
3603     if (!found_ve)
3604     {
3605 #ifdef FEAT_MOUSESHAPE
3606 	if (what == SHAPE_MOUSE)
3607 	{
3608 	    shape_table[SHAPE_IDX_VE].mshape = shape_table[SHAPE_IDX_V].mshape;
3609 	}
3610 	else
3611 #endif
3612 	{
3613 	    shape_table[SHAPE_IDX_VE].shape = shape_table[SHAPE_IDX_V].shape;
3614 	    shape_table[SHAPE_IDX_VE].percentage =
3615 					 shape_table[SHAPE_IDX_V].percentage;
3616 	    shape_table[SHAPE_IDX_VE].blinkwait =
3617 					  shape_table[SHAPE_IDX_V].blinkwait;
3618 	    shape_table[SHAPE_IDX_VE].blinkon =
3619 					    shape_table[SHAPE_IDX_V].blinkon;
3620 	    shape_table[SHAPE_IDX_VE].blinkoff =
3621 					   shape_table[SHAPE_IDX_V].blinkoff;
3622 	    shape_table[SHAPE_IDX_VE].id = shape_table[SHAPE_IDX_V].id;
3623 	    shape_table[SHAPE_IDX_VE].id_lm = shape_table[SHAPE_IDX_V].id_lm;
3624 	}
3625     }
3626 
3627     return NULL;
3628 }
3629 
3630 # if defined(MCH_CURSOR_SHAPE) || defined(FEAT_GUI) \
3631 	|| defined(FEAT_MOUSESHAPE) || defined(PROTO)
3632 /*
3633  * Return the index into shape_table[] for the current mode.
3634  * When "mouse" is TRUE, consider indexes valid for the mouse pointer.
3635  */
3636     int
3637 get_shape_idx(int mouse)
3638 {
3639 #ifdef FEAT_MOUSESHAPE
3640     if (mouse && (State == HITRETURN || State == ASKMORE))
3641     {
3642 # ifdef FEAT_GUI
3643 	int x, y;
3644 	gui_mch_getmouse(&x, &y);
3645 	if (Y_2_ROW(y) == Rows - 1)
3646 	    return SHAPE_IDX_MOREL;
3647 # endif
3648 	return SHAPE_IDX_MORE;
3649     }
3650     if (mouse && drag_status_line)
3651 	return SHAPE_IDX_SDRAG;
3652     if (mouse && drag_sep_line)
3653 	return SHAPE_IDX_VDRAG;
3654 #endif
3655     if (!mouse && State == SHOWMATCH)
3656 	return SHAPE_IDX_SM;
3657     if (State & VREPLACE_FLAG)
3658 	return SHAPE_IDX_R;
3659     if (State & REPLACE_FLAG)
3660 	return SHAPE_IDX_R;
3661     if (State & INSERT)
3662 	return SHAPE_IDX_I;
3663     if (State & CMDLINE)
3664     {
3665 	if (cmdline_at_end())
3666 	    return SHAPE_IDX_C;
3667 	if (cmdline_overstrike())
3668 	    return SHAPE_IDX_CR;
3669 	return SHAPE_IDX_CI;
3670     }
3671     if (finish_op)
3672 	return SHAPE_IDX_O;
3673     if (VIsual_active)
3674     {
3675 	if (*p_sel == 'e')
3676 	    return SHAPE_IDX_VE;
3677 	else
3678 	    return SHAPE_IDX_V;
3679     }
3680     return SHAPE_IDX_N;
3681 }
3682 #endif
3683 
3684 # if defined(FEAT_MOUSESHAPE) || defined(PROTO)
3685 static int old_mouse_shape = 0;
3686 
3687 /*
3688  * Set the mouse shape:
3689  * If "shape" is -1, use shape depending on the current mode,
3690  * depending on the current state.
3691  * If "shape" is -2, only update the shape when it's CLINE or STATUS (used
3692  * when the mouse moves off the status or command line).
3693  */
3694     void
3695 update_mouseshape(int shape_idx)
3696 {
3697     int new_mouse_shape;
3698 
3699     /* Only works in GUI mode. */
3700     if (!gui.in_use || gui.starting)
3701 	return;
3702 
3703     /* Postpone the updating when more is to come.  Speeds up executing of
3704      * mappings. */
3705     if (shape_idx == -1 && char_avail())
3706     {
3707 	postponed_mouseshape = TRUE;
3708 	return;
3709     }
3710 
3711     /* When ignoring the mouse don't change shape on the statusline. */
3712     if (*p_mouse == NUL
3713 	    && (shape_idx == SHAPE_IDX_CLINE
3714 		|| shape_idx == SHAPE_IDX_STATUS
3715 		|| shape_idx == SHAPE_IDX_VSEP))
3716 	shape_idx = -2;
3717 
3718     if (shape_idx == -2
3719 	    && old_mouse_shape != shape_table[SHAPE_IDX_CLINE].mshape
3720 	    && old_mouse_shape != shape_table[SHAPE_IDX_STATUS].mshape
3721 	    && old_mouse_shape != shape_table[SHAPE_IDX_VSEP].mshape)
3722 	return;
3723     if (shape_idx < 0)
3724 	new_mouse_shape = shape_table[get_shape_idx(TRUE)].mshape;
3725     else
3726 	new_mouse_shape = shape_table[shape_idx].mshape;
3727     if (new_mouse_shape != old_mouse_shape)
3728     {
3729 	mch_set_mouse_shape(new_mouse_shape);
3730 	old_mouse_shape = new_mouse_shape;
3731     }
3732     postponed_mouseshape = FALSE;
3733 }
3734 # endif
3735 
3736 #endif /* CURSOR_SHAPE */
3737 
3738 
3739 /*
3740  * Change directory to "new_dir".  If FEAT_SEARCHPATH is defined, search
3741  * 'cdpath' for relative directory names, otherwise just mch_chdir().
3742  */
3743     int
3744 vim_chdir(char_u *new_dir)
3745 {
3746 #ifndef FEAT_SEARCHPATH
3747     return mch_chdir((char *)new_dir);
3748 #else
3749     char_u	*dir_name;
3750     int		r;
3751 
3752     dir_name = find_directory_in_path(new_dir, (int)STRLEN(new_dir),
3753 						FNAME_MESS, curbuf->b_ffname);
3754     if (dir_name == NULL)
3755 	return -1;
3756     r = mch_chdir((char *)dir_name);
3757     vim_free(dir_name);
3758     return r;
3759 #endif
3760 }
3761 
3762 /*
3763  * Get user name from machine-specific function.
3764  * Returns the user name in "buf[len]".
3765  * Some systems are quite slow in obtaining the user name (Windows NT), thus
3766  * cache the result.
3767  * Returns OK or FAIL.
3768  */
3769     int
3770 get_user_name(char_u *buf, int len)
3771 {
3772     if (username == NULL)
3773     {
3774 	if (mch_get_user_name(buf, len) == FAIL)
3775 	    return FAIL;
3776 	username = vim_strsave(buf);
3777     }
3778     else
3779 	vim_strncpy(buf, username, len - 1);
3780     return OK;
3781 }
3782 
3783 #ifndef HAVE_QSORT
3784 /*
3785  * Our own qsort(), for systems that don't have it.
3786  * It's simple and slow.  From the K&R C book.
3787  */
3788     void
3789 qsort(
3790     void	*base,
3791     size_t	elm_count,
3792     size_t	elm_size,
3793     int (*cmp)(const void *, const void *))
3794 {
3795     char_u	*buf;
3796     char_u	*p1;
3797     char_u	*p2;
3798     int		i, j;
3799     int		gap;
3800 
3801     buf = alloc(elm_size);
3802     if (buf == NULL)
3803 	return;
3804 
3805     for (gap = elm_count / 2; gap > 0; gap /= 2)
3806 	for (i = gap; i < elm_count; ++i)
3807 	    for (j = i - gap; j >= 0; j -= gap)
3808 	    {
3809 		/* Compare the elements. */
3810 		p1 = (char_u *)base + j * elm_size;
3811 		p2 = (char_u *)base + (j + gap) * elm_size;
3812 		if ((*cmp)((void *)p1, (void *)p2) <= 0)
3813 		    break;
3814 		/* Exchange the elements. */
3815 		mch_memmove(buf, p1, elm_size);
3816 		mch_memmove(p1, p2, elm_size);
3817 		mch_memmove(p2, buf, elm_size);
3818 	    }
3819 
3820     vim_free(buf);
3821 }
3822 #endif
3823 
3824 /*
3825  * Sort an array of strings.
3826  */
3827 static int sort_compare(const void *s1, const void *s2);
3828 
3829     static int
3830 sort_compare(const void *s1, const void *s2)
3831 {
3832     return STRCMP(*(char **)s1, *(char **)s2);
3833 }
3834 
3835     void
3836 sort_strings(
3837     char_u	**files,
3838     int		count)
3839 {
3840     qsort((void *)files, (size_t)count, sizeof(char_u *), sort_compare);
3841 }
3842 
3843 /*
3844  * The putenv() implementation below comes from the "screen" program.
3845  * Included with permission from Juergen Weigert.
3846  * See pty.c for the copyright notice.
3847  */
3848 
3849 /*
3850  *  putenv  --	put value into environment
3851  *
3852  *  Usage:  i = putenv (string)
3853  *    int i;
3854  *    char  *string;
3855  *
3856  *  where string is of the form <name>=<value>.
3857  *  Putenv returns 0 normally, -1 on error (not enough core for malloc).
3858  *
3859  *  Putenv may need to add a new name into the environment, or to
3860  *  associate a value longer than the current value with a particular
3861  *  name.  So, to make life simpler, putenv() copies your entire
3862  *  environment into the heap (i.e. malloc()) from the stack
3863  *  (i.e. where it resides when your process is initiated) the first
3864  *  time you call it.
3865  *
3866  *  (history removed, not very interesting.  See the "screen" sources.)
3867  */
3868 
3869 #if !defined(HAVE_SETENV) && !defined(HAVE_PUTENV)
3870 
3871 #define EXTRASIZE 5		/* increment to add to env. size */
3872 
3873 static int  envsize = -1;	/* current size of environment */
3874 extern char **environ;		/* the global which is your env. */
3875 
3876 static int  findenv(char *name); /* look for a name in the env. */
3877 static int  newenv(void);	/* copy env. from stack to heap */
3878 static int  moreenv(void);	/* incr. size of env. */
3879 
3880     int
3881 putenv(const char *string)
3882 {
3883     int	    i;
3884     char    *p;
3885 
3886     if (envsize < 0)
3887     {				/* first time putenv called */
3888 	if (newenv() < 0)	/* copy env. to heap */
3889 	    return -1;
3890     }
3891 
3892     i = findenv((char *)string); /* look for name in environment */
3893 
3894     if (i < 0)
3895     {				/* name must be added */
3896 	for (i = 0; environ[i]; i++);
3897 	if (i >= (envsize - 1))
3898 	{			/* need new slot */
3899 	    if (moreenv() < 0)
3900 		return -1;
3901 	}
3902 	p = alloc(strlen(string) + 1);
3903 	if (p == NULL)		/* not enough core */
3904 	    return -1;
3905 	environ[i + 1] = 0;	/* new end of env. */
3906     }
3907     else
3908     {				/* name already in env. */
3909 	p = vim_realloc(environ[i], strlen(string) + 1);
3910 	if (p == NULL)
3911 	    return -1;
3912     }
3913     sprintf(p, "%s", string);	/* copy into env. */
3914     environ[i] = p;
3915 
3916     return 0;
3917 }
3918 
3919     static int
3920 findenv(char *name)
3921 {
3922     char    *namechar, *envchar;
3923     int	    i, found;
3924 
3925     found = 0;
3926     for (i = 0; environ[i] && !found; i++)
3927     {
3928 	envchar = environ[i];
3929 	namechar = name;
3930 	while (*namechar && *namechar != '=' && (*namechar == *envchar))
3931 	{
3932 	    namechar++;
3933 	    envchar++;
3934 	}
3935 	found = ((*namechar == '\0' || *namechar == '=') && *envchar == '=');
3936     }
3937     return found ? i - 1 : -1;
3938 }
3939 
3940     static int
3941 newenv(void)
3942 {
3943     char    **env, *elem;
3944     int	    i, esize;
3945 
3946     for (i = 0; environ[i]; i++)
3947 	;
3948 
3949     esize = i + EXTRASIZE + 1;
3950     env = ALLOC_MULT(char *, esize);
3951     if (env == NULL)
3952 	return -1;
3953 
3954     for (i = 0; environ[i]; i++)
3955     {
3956 	elem = alloc(strlen(environ[i]) + 1);
3957 	if (elem == NULL)
3958 	    return -1;
3959 	env[i] = elem;
3960 	strcpy(elem, environ[i]);
3961     }
3962 
3963     env[i] = 0;
3964     environ = env;
3965     envsize = esize;
3966     return 0;
3967 }
3968 
3969     static int
3970 moreenv(void)
3971 {
3972     int	    esize;
3973     char    **env;
3974 
3975     esize = envsize + EXTRASIZE;
3976     env = vim_realloc((char *)environ, esize * sizeof (*env));
3977     if (env == 0)
3978 	return -1;
3979     environ = env;
3980     envsize = esize;
3981     return 0;
3982 }
3983 
3984 # ifdef USE_VIMPTY_GETENV
3985 /*
3986  * Used for mch_getenv() for Mac.
3987  */
3988     char_u *
3989 vimpty_getenv(const char_u *string)
3990 {
3991     int i;
3992     char_u *p;
3993 
3994     if (envsize < 0)
3995 	return NULL;
3996 
3997     i = findenv((char *)string);
3998 
3999     if (i < 0)
4000 	return NULL;
4001 
4002     p = vim_strchr((char_u *)environ[i], '=');
4003     return (p + 1);
4004 }
4005 # endif
4006 
4007 #endif /* !defined(HAVE_SETENV) && !defined(HAVE_PUTENV) */
4008 
4009 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
4010 /*
4011  * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
4012  * rights to write into.
4013  */
4014     int
4015 filewritable(char_u *fname)
4016 {
4017     int		retval = 0;
4018 #if defined(UNIX) || defined(VMS)
4019     int		perm = 0;
4020 #endif
4021 
4022 #if defined(UNIX) || defined(VMS)
4023     perm = mch_getperm(fname);
4024 #endif
4025     if (
4026 # ifdef MSWIN
4027 	    mch_writable(fname) &&
4028 # else
4029 # if defined(UNIX) || defined(VMS)
4030 	    (perm & 0222) &&
4031 #  endif
4032 # endif
4033 	    mch_access((char *)fname, W_OK) == 0
4034        )
4035     {
4036 	++retval;
4037 	if (mch_isdir(fname))
4038 	    ++retval;
4039     }
4040     return retval;
4041 }
4042 #endif
4043 
4044 #if defined(FEAT_SPELL) || defined(FEAT_PERSISTENT_UNDO) || defined(PROTO)
4045 /*
4046  * Read 2 bytes from "fd" and turn them into an int, MSB first.
4047  * Returns -1 when encountering EOF.
4048  */
4049     int
4050 get2c(FILE *fd)
4051 {
4052     int		c, n;
4053 
4054     n = getc(fd);
4055     if (n == EOF) return -1;
4056     c = getc(fd);
4057     if (c == EOF) return -1;
4058     return (n << 8) + c;
4059 }
4060 
4061 /*
4062  * Read 3 bytes from "fd" and turn them into an int, MSB first.
4063  * Returns -1 when encountering EOF.
4064  */
4065     int
4066 get3c(FILE *fd)
4067 {
4068     int		c, n;
4069 
4070     n = getc(fd);
4071     if (n == EOF) return -1;
4072     c = getc(fd);
4073     if (c == EOF) return -1;
4074     n = (n << 8) + c;
4075     c = getc(fd);
4076     if (c == EOF) return -1;
4077     return (n << 8) + c;
4078 }
4079 
4080 /*
4081  * Read 4 bytes from "fd" and turn them into an int, MSB first.
4082  * Returns -1 when encountering EOF.
4083  */
4084     int
4085 get4c(FILE *fd)
4086 {
4087     int		c;
4088     /* Use unsigned rather than int otherwise result is undefined
4089      * when left-shift sets the MSB. */
4090     unsigned	n;
4091 
4092     c = getc(fd);
4093     if (c == EOF) return -1;
4094     n = (unsigned)c;
4095     c = getc(fd);
4096     if (c == EOF) return -1;
4097     n = (n << 8) + (unsigned)c;
4098     c = getc(fd);
4099     if (c == EOF) return -1;
4100     n = (n << 8) + (unsigned)c;
4101     c = getc(fd);
4102     if (c == EOF) return -1;
4103     n = (n << 8) + (unsigned)c;
4104     return (int)n;
4105 }
4106 
4107 /*
4108  * Read 8 bytes from "fd" and turn them into a time_T, MSB first.
4109  * Returns -1 when encountering EOF.
4110  */
4111     time_T
4112 get8ctime(FILE *fd)
4113 {
4114     int		c;
4115     time_T	n = 0;
4116     int		i;
4117 
4118     for (i = 0; i < 8; ++i)
4119     {
4120 	c = getc(fd);
4121 	if (c == EOF) return -1;
4122 	n = (n << 8) + c;
4123     }
4124     return n;
4125 }
4126 
4127 /*
4128  * Read a string of length "cnt" from "fd" into allocated memory.
4129  * Returns NULL when out of memory or unable to read that many bytes.
4130  */
4131     char_u *
4132 read_string(FILE *fd, int cnt)
4133 {
4134     char_u	*str;
4135     int		i;
4136     int		c;
4137 
4138     /* allocate memory */
4139     str = alloc(cnt + 1);
4140     if (str != NULL)
4141     {
4142 	/* Read the string.  Quit when running into the EOF. */
4143 	for (i = 0; i < cnt; ++i)
4144 	{
4145 	    c = getc(fd);
4146 	    if (c == EOF)
4147 	    {
4148 		vim_free(str);
4149 		return NULL;
4150 	    }
4151 	    str[i] = c;
4152 	}
4153 	str[i] = NUL;
4154     }
4155     return str;
4156 }
4157 
4158 /*
4159  * Write a number to file "fd", MSB first, in "len" bytes.
4160  */
4161     int
4162 put_bytes(FILE *fd, long_u nr, int len)
4163 {
4164     int	    i;
4165 
4166     for (i = len - 1; i >= 0; --i)
4167 	if (putc((int)(nr >> (i * 8)), fd) == EOF)
4168 	    return FAIL;
4169     return OK;
4170 }
4171 
4172 #ifdef _MSC_VER
4173 # if (_MSC_VER <= 1200)
4174 /* This line is required for VC6 without the service pack.  Also see the
4175  * matching #pragma below. */
4176  #  pragma optimize("", off)
4177 # endif
4178 #endif
4179 
4180 /*
4181  * Write time_T to file "fd" in 8 bytes.
4182  * Returns FAIL when the write failed.
4183  */
4184     int
4185 put_time(FILE *fd, time_T the_time)
4186 {
4187     char_u	buf[8];
4188 
4189     time_to_bytes(the_time, buf);
4190     return fwrite(buf, (size_t)8, (size_t)1, fd) == 1 ? OK : FAIL;
4191 }
4192 
4193 /*
4194  * Write time_T to "buf[8]".
4195  */
4196     void
4197 time_to_bytes(time_T the_time, char_u *buf)
4198 {
4199     int		c;
4200     int		i;
4201     int		bi = 0;
4202     time_T	wtime = the_time;
4203 
4204     /* time_T can be up to 8 bytes in size, more than long_u, thus we
4205      * can't use put_bytes() here.
4206      * Another problem is that ">>" may do an arithmetic shift that keeps the
4207      * sign.  This happens for large values of wtime.  A cast to long_u may
4208      * truncate if time_T is 8 bytes.  So only use a cast when it is 4 bytes,
4209      * it's safe to assume that long_u is 4 bytes or more and when using 8
4210      * bytes the top bit won't be set. */
4211     for (i = 7; i >= 0; --i)
4212     {
4213 	if (i + 1 > (int)sizeof(time_T))
4214 	    /* ">>" doesn't work well when shifting more bits than avail */
4215 	    buf[bi++] = 0;
4216 	else
4217 	{
4218 #if defined(SIZEOF_TIME_T) && SIZEOF_TIME_T > 4
4219 	    c = (int)(wtime >> (i * 8));
4220 #else
4221 	    c = (int)((long_u)wtime >> (i * 8));
4222 #endif
4223 	    buf[bi++] = c;
4224 	}
4225     }
4226 }
4227 
4228 #ifdef _MSC_VER
4229 # if (_MSC_VER <= 1200)
4230  #  pragma optimize("", on)
4231 # endif
4232 #endif
4233 
4234 #endif
4235 
4236 #if defined(FEAT_QUICKFIX) || defined(FEAT_SPELL) || defined(PROTO)
4237 /*
4238  * Return TRUE if string "s" contains a non-ASCII character (128 or higher).
4239  * When "s" is NULL FALSE is returned.
4240  */
4241     int
4242 has_non_ascii(char_u *s)
4243 {
4244     char_u	*p;
4245 
4246     if (s != NULL)
4247 	for (p = s; *p != NUL; ++p)
4248 	    if (*p >= 128)
4249 		return TRUE;
4250     return FALSE;
4251 }
4252 #endif
4253 
4254 #ifndef PROTO  /* proto is defined in vim.h */
4255 # ifdef ELAPSED_TIMEVAL
4256 /*
4257  * Return time in msec since "start_tv".
4258  */
4259     long
4260 elapsed(struct timeval *start_tv)
4261 {
4262     struct timeval  now_tv;
4263 
4264     gettimeofday(&now_tv, NULL);
4265     return (now_tv.tv_sec - start_tv->tv_sec) * 1000L
4266 	 + (now_tv.tv_usec - start_tv->tv_usec) / 1000L;
4267 }
4268 # endif
4269 
4270 # ifdef ELAPSED_TICKCOUNT
4271 /*
4272  * Return time in msec since "start_tick".
4273  */
4274     long
4275 elapsed(DWORD start_tick)
4276 {
4277     DWORD	now = GetTickCount();
4278 
4279     return (long)now - (long)start_tick;
4280 }
4281 # endif
4282 #endif
4283 
4284 #if defined(FEAT_JOB_CHANNEL) \
4285 	|| (defined(UNIX) && (!defined(USE_SYSTEM) \
4286 	|| (defined(FEAT_GUI) && defined(FEAT_TERMINAL)))) \
4287 	|| defined(PROTO)
4288 /*
4289  * Parse "cmd" and put the white-separated parts in "argv".
4290  * "argv" is an allocated array with "argc" entries and room for 4 more.
4291  * Returns FAIL when out of memory.
4292  */
4293     int
4294 mch_parse_cmd(char_u *cmd, int use_shcf, char ***argv, int *argc)
4295 {
4296     int		i;
4297     char_u	*p, *d;
4298     int		inquote;
4299 
4300     /*
4301      * Do this loop twice:
4302      * 1: find number of arguments
4303      * 2: separate them and build argv[]
4304      */
4305     for (i = 0; i < 2; ++i)
4306     {
4307 	p = skipwhite(cmd);
4308 	inquote = FALSE;
4309 	*argc = 0;
4310 	for (;;)
4311 	{
4312 	    if (i == 1)
4313 		(*argv)[*argc] = (char *)p;
4314 	    ++*argc;
4315 	    d = p;
4316 	    while (*p != NUL && (inquote || (*p != ' ' && *p != TAB)))
4317 	    {
4318 		if (p[0] == '"')
4319 		    // quotes surrounding an argument and are dropped
4320 		    inquote = !inquote;
4321 		else
4322 		{
4323 		    if (rem_backslash(p))
4324 		    {
4325 			// First pass: skip over "\ " and "\"".
4326 			// Second pass: Remove the backslash.
4327 			++p;
4328 		    }
4329 		    if (i == 1)
4330 			*d++ = *p;
4331 		}
4332 		++p;
4333 	    }
4334 	    if (*p == NUL)
4335 	    {
4336 		if (i == 1)
4337 		    *d++ = NUL;
4338 		break;
4339 	    }
4340 	    if (i == 1)
4341 		*d++ = NUL;
4342 	    p = skipwhite(p + 1);
4343 	}
4344 	if (*argv == NULL)
4345 	{
4346 	    if (use_shcf)
4347 	    {
4348 		/* Account for possible multiple args in p_shcf. */
4349 		p = p_shcf;
4350 		for (;;)
4351 		{
4352 		    p = skiptowhite(p);
4353 		    if (*p == NUL)
4354 			break;
4355 		    ++*argc;
4356 		    p = skipwhite(p);
4357 		}
4358 	    }
4359 
4360 	    *argv = ALLOC_MULT(char *, *argc + 4);
4361 	    if (*argv == NULL)	    /* out of memory */
4362 		return FAIL;
4363 	}
4364     }
4365     return OK;
4366 }
4367 
4368 # if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
4369 /*
4370  * Build "argv[argc]" from the string "cmd".
4371  * "argv[argc]" is set to NULL;
4372  * Return FAIL when out of memory.
4373  */
4374     int
4375 build_argv_from_string(char_u *cmd, char ***argv, int *argc)
4376 {
4377     char_u	*cmd_copy;
4378     int		i;
4379 
4380     /* Make a copy, parsing will modify "cmd". */
4381     cmd_copy = vim_strsave(cmd);
4382     if (cmd_copy == NULL
4383 	    || mch_parse_cmd(cmd_copy, FALSE, argv, argc) == FAIL)
4384     {
4385 	vim_free(cmd_copy);
4386 	return FAIL;
4387     }
4388     for (i = 0; i < *argc; i++)
4389 	(*argv)[i] = (char *)vim_strsave((char_u *)(*argv)[i]);
4390     (*argv)[*argc] = NULL;
4391     vim_free(cmd_copy);
4392     return OK;
4393 }
4394 
4395 /*
4396  * Build "argv[argc]" from the list "l".
4397  * "argv[argc]" is set to NULL;
4398  * Return FAIL when out of memory.
4399  */
4400     int
4401 build_argv_from_list(list_T *l, char ***argv, int *argc)
4402 {
4403     listitem_T  *li;
4404     char_u	*s;
4405 
4406     /* Pass argv[] to mch_call_shell(). */
4407     *argv = ALLOC_MULT(char *, l->lv_len + 1);
4408     if (*argv == NULL)
4409 	return FAIL;
4410     *argc = 0;
4411     for (li = l->lv_first; li != NULL; li = li->li_next)
4412     {
4413 	s = tv_get_string_chk(&li->li_tv);
4414 	if (s == NULL)
4415 	{
4416 	    int i;
4417 
4418 	    for (i = 0; i < *argc; ++i)
4419 		vim_free((*argv)[i]);
4420 	    return FAIL;
4421 	}
4422 	(*argv)[*argc] = (char *)vim_strsave(s);
4423 	*argc += 1;
4424     }
4425     (*argv)[*argc] = NULL;
4426     return OK;
4427 }
4428 # endif
4429 #endif
4430 
4431 /*
4432  * Change the behavior of vterm.
4433  * 0: As usual.
4434  * 1: Windows 10 version 1809
4435  *      The bug causes unstable handling of ambiguous width character.
4436  * 2: Windows 10 version 1903
4437  *      Use the wrong result because each result is different.
4438  * 3: Windows 10 insider preview (current latest logic)
4439  */
4440     int
4441 get_special_pty_type(void)
4442 {
4443 #ifdef MSWIN
4444     return get_conpty_type();
4445 #else
4446     return 0;
4447 #endif
4448 }
4449