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