xref: /vim-8.2.3635/src/misc2.c (revision 8ea05de6)
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 # ifdef FEAT_PROP_POPUP
1073     if (curwin != NULL)
1074 	close_all_popups(TRUE);
1075 # endif
1076 
1077     // Clear user commands (before deleting buffers).
1078     ex_comclear(NULL);
1079 
1080     // When exiting from mainerr_arg_missing curbuf has not been initialized,
1081     // and not much else.
1082     if (curbuf != NULL)
1083     {
1084 # ifdef FEAT_MENU
1085 	// Clear menus.
1086 	do_cmdline_cmd((char_u *)"aunmenu *");
1087 #  ifdef FEAT_MULTI_LANG
1088 	do_cmdline_cmd((char_u *)"menutranslate clear");
1089 #  endif
1090 # endif
1091 	// Clear mappings, abbreviations, breakpoints.
1092 	do_cmdline_cmd((char_u *)"lmapclear");
1093 	do_cmdline_cmd((char_u *)"xmapclear");
1094 	do_cmdline_cmd((char_u *)"mapclear");
1095 	do_cmdline_cmd((char_u *)"mapclear!");
1096 	do_cmdline_cmd((char_u *)"abclear");
1097 # if defined(FEAT_EVAL)
1098 	do_cmdline_cmd((char_u *)"breakdel *");
1099 # endif
1100 # if defined(FEAT_PROFILE)
1101 	do_cmdline_cmd((char_u *)"profdel *");
1102 # endif
1103 # if defined(FEAT_KEYMAP)
1104 	do_cmdline_cmd((char_u *)"set keymap=");
1105 # endif
1106     }
1107 
1108 # ifdef FEAT_TITLE
1109     free_titles();
1110 # endif
1111 # if defined(FEAT_SEARCHPATH)
1112     free_findfile();
1113 # endif
1114 
1115     // Obviously named calls.
1116     free_all_autocmds();
1117     clear_termcodes();
1118     free_all_marks();
1119     alist_clear(&global_alist);
1120     free_homedir();
1121     free_users();
1122     free_search_patterns();
1123     free_old_sub();
1124     free_last_insert();
1125     free_insexpand_stuff();
1126     free_prev_shellcmd();
1127     free_regexp_stuff();
1128     free_tag_stuff();
1129     free_cd_dir();
1130 # ifdef FEAT_SIGNS
1131     free_signs();
1132 # endif
1133 # ifdef FEAT_EVAL
1134     set_expr_line(NULL, NULL);
1135 # endif
1136 # ifdef FEAT_DIFF
1137     if (curtab != NULL)
1138 	diff_clear(curtab);
1139 # endif
1140     clear_sb_text(TRUE);	      // free any scrollback text
1141 
1142     // Free some global vars.
1143     vim_free(username);
1144 # ifdef FEAT_CLIPBOARD
1145     vim_regfree(clip_exclude_prog);
1146 # endif
1147     vim_free(last_cmdline);
1148     vim_free(new_last_cmdline);
1149     set_keep_msg(NULL, 0);
1150 
1151     // Clear cmdline history.
1152     p_hi = 0;
1153     init_history();
1154 # ifdef FEAT_PROP_POPUP
1155     clear_global_prop_types();
1156 # endif
1157 
1158 # ifdef FEAT_QUICKFIX
1159     {
1160 	win_T	    *win;
1161 	tabpage_T   *tab;
1162 
1163 	qf_free_all(NULL);
1164 	// Free all location lists
1165 	FOR_ALL_TAB_WINDOWS(tab, win)
1166 	    qf_free_all(win);
1167     }
1168 # endif
1169 
1170     // Close all script inputs.
1171     close_all_scripts();
1172 
1173     if (curwin != NULL)
1174 	// Destroy all windows.  Must come before freeing buffers.
1175 	win_free_all();
1176 
1177     // Free all option values.  Must come after closing windows.
1178     free_all_options();
1179 
1180     // Free all buffers.  Reset 'autochdir' to avoid accessing things that
1181     // were freed already.
1182 # ifdef FEAT_AUTOCHDIR
1183     p_acd = FALSE;
1184 # endif
1185     for (buf = firstbuf; buf != NULL; )
1186     {
1187 	bufref_T    bufref;
1188 
1189 	set_bufref(&bufref, buf);
1190 	nextbuf = buf->b_next;
1191 	close_buffer(NULL, buf, DOBUF_WIPE, FALSE, FALSE);
1192 	if (bufref_valid(&bufref))
1193 	    buf = nextbuf;	// didn't work, try next one
1194 	else
1195 	    buf = firstbuf;
1196     }
1197 
1198 # ifdef FEAT_ARABIC
1199     free_arshape_buf();
1200 # endif
1201 
1202     // Clear registers.
1203     clear_registers();
1204     ResetRedobuff();
1205     ResetRedobuff();
1206 
1207 # if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
1208     vim_free(serverDelayedStartName);
1209 # endif
1210 
1211     // highlight info
1212     free_highlight();
1213 
1214     reset_last_sourcing();
1215 
1216     if (first_tabpage != NULL)
1217     {
1218 	free_tabpage(first_tabpage);
1219 	first_tabpage = NULL;
1220     }
1221 
1222 # ifdef UNIX
1223     // Machine-specific free.
1224     mch_free_mem();
1225 # endif
1226 
1227     // message history
1228     for (;;)
1229 	if (delete_first_msg() == FAIL)
1230 	    break;
1231 
1232 # ifdef FEAT_JOB_CHANNEL
1233     channel_free_all();
1234 # endif
1235 # ifdef FEAT_TIMERS
1236     timer_free_all();
1237 # endif
1238 # ifdef FEAT_EVAL
1239     // must be after channel_free_all() with unrefs partials
1240     eval_clear();
1241 # endif
1242 # ifdef FEAT_JOB_CHANNEL
1243     // must be after eval_clear() with unrefs jobs
1244     job_free_all();
1245 # endif
1246 
1247     free_termoptions();
1248 
1249     // screenlines (can't display anything now!)
1250     free_screenlines();
1251 
1252 # if defined(FEAT_SOUND)
1253     sound_free();
1254 # endif
1255 # if defined(USE_XSMP)
1256     xsmp_close();
1257 # endif
1258 # ifdef FEAT_GUI_GTK
1259     gui_mch_free_all();
1260 # endif
1261     clear_hl_tables();
1262 
1263     vim_free(IObuff);
1264     vim_free(NameBuff);
1265 # ifdef FEAT_QUICKFIX
1266     check_quickfix_busy();
1267 # endif
1268 }
1269 #endif
1270 
1271 /*
1272  * Copy "string" into newly allocated memory.
1273  */
1274     char_u *
1275 vim_strsave(char_u *string)
1276 {
1277     char_u	*p;
1278     size_t	len;
1279 
1280     len = STRLEN(string) + 1;
1281     p = alloc(len);
1282     if (p != NULL)
1283 	mch_memmove(p, string, len);
1284     return p;
1285 }
1286 
1287 /*
1288  * Copy up to "len" bytes of "string" into newly allocated memory and
1289  * terminate with a NUL.
1290  * The allocated memory always has size "len + 1", also when "string" is
1291  * shorter.
1292  */
1293     char_u *
1294 vim_strnsave(char_u *string, size_t len)
1295 {
1296     char_u	*p;
1297 
1298     p = alloc(len + 1);
1299     if (p != NULL)
1300     {
1301 	STRNCPY(p, string, len);
1302 	p[len] = NUL;
1303     }
1304     return p;
1305 }
1306 
1307 /*
1308  * Copy "p[len]" into allocated memory, ignoring NUL characters.
1309  * Returns NULL when out of memory.
1310  */
1311     char_u *
1312 vim_memsave(char_u *p, size_t len)
1313 {
1314     char_u *ret = alloc(len);
1315 
1316     if (ret != NULL)
1317 	mch_memmove(ret, p, len);
1318     return ret;
1319 }
1320 
1321 /*
1322  * Same as vim_strsave(), but any characters found in esc_chars are preceded
1323  * by a backslash.
1324  */
1325     char_u *
1326 vim_strsave_escaped(char_u *string, char_u *esc_chars)
1327 {
1328     return vim_strsave_escaped_ext(string, esc_chars, '\\', FALSE);
1329 }
1330 
1331 /*
1332  * Same as vim_strsave_escaped(), but when "bsl" is TRUE also escape
1333  * characters where rem_backslash() would remove the backslash.
1334  * Escape the characters with "cc".
1335  */
1336     char_u *
1337 vim_strsave_escaped_ext(
1338     char_u	*string,
1339     char_u	*esc_chars,
1340     int		cc,
1341     int		bsl)
1342 {
1343     char_u	*p;
1344     char_u	*p2;
1345     char_u	*escaped_string;
1346     unsigned	length;
1347     int		l;
1348 
1349     /*
1350      * First count the number of backslashes required.
1351      * Then allocate the memory and insert them.
1352      */
1353     length = 1;				// count the trailing NUL
1354     for (p = string; *p; p++)
1355     {
1356 	if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1357 	{
1358 	    length += l;		// count a multibyte char
1359 	    p += l - 1;
1360 	    continue;
1361 	}
1362 	if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
1363 	    ++length;			// count a backslash
1364 	++length;			// count an ordinary char
1365     }
1366     escaped_string = alloc(length);
1367     if (escaped_string != NULL)
1368     {
1369 	p2 = escaped_string;
1370 	for (p = string; *p; p++)
1371 	{
1372 	    if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1373 	    {
1374 		mch_memmove(p2, p, (size_t)l);
1375 		p2 += l;
1376 		p += l - 1;		// skip multibyte char
1377 		continue;
1378 	    }
1379 	    if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
1380 		*p2++ = cc;
1381 	    *p2++ = *p;
1382 	}
1383 	*p2 = NUL;
1384     }
1385     return escaped_string;
1386 }
1387 
1388 /*
1389  * Return TRUE when 'shell' has "csh" in the tail.
1390  */
1391     int
1392 csh_like_shell(void)
1393 {
1394     return (strstr((char *)gettail(p_sh), "csh") != NULL);
1395 }
1396 
1397 /*
1398  * Escape "string" for use as a shell argument with system().
1399  * This uses single quotes, except when we know we need to use double quotes
1400  * (MS-DOS and MS-Windows without 'shellslash' set).
1401  * Escape a newline, depending on the 'shell' option.
1402  * When "do_special" is TRUE also replace "!", "%", "#" and things starting
1403  * with "<" like "<cfile>".
1404  * When "do_newline" is FALSE do not escape newline unless it is csh shell.
1405  * Returns the result in allocated memory, NULL if we have run out.
1406  */
1407     char_u *
1408 vim_strsave_shellescape(char_u *string, int do_special, int do_newline)
1409 {
1410     unsigned	length;
1411     char_u	*p;
1412     char_u	*d;
1413     char_u	*escaped_string;
1414     int		l;
1415     int		csh_like;
1416 
1417     // Only csh and similar shells expand '!' within single quotes.  For sh and
1418     // the like we must not put a backslash before it, it will be taken
1419     // literally.  If do_special is set the '!' will be escaped twice.
1420     // Csh also needs to have "\n" escaped twice when do_special is set.
1421     csh_like = csh_like_shell();
1422 
1423     // First count the number of extra bytes required.
1424     length = (unsigned)STRLEN(string) + 3;  // two quotes and a trailing NUL
1425     for (p = string; *p != NUL; MB_PTR_ADV(p))
1426     {
1427 # ifdef MSWIN
1428 	if (!p_ssl)
1429 	{
1430 	    if (*p == '"')
1431 		++length;		// " -> ""
1432 	}
1433 	else
1434 # endif
1435 	if (*p == '\'')
1436 	    length += 3;		// ' => '\''
1437 	if ((*p == '\n' && (csh_like || do_newline))
1438 		|| (*p == '!' && (csh_like || do_special)))
1439 	{
1440 	    ++length;			// insert backslash
1441 	    if (csh_like && do_special)
1442 		++length;		// insert backslash
1443 	}
1444 	if (do_special && find_cmdline_var(p, &l) >= 0)
1445 	{
1446 	    ++length;			// insert backslash
1447 	    p += l - 1;
1448 	}
1449     }
1450 
1451     // Allocate memory for the result and fill it.
1452     escaped_string = alloc(length);
1453     if (escaped_string != NULL)
1454     {
1455 	d = escaped_string;
1456 
1457 	// add opening quote
1458 # ifdef MSWIN
1459 	if (!p_ssl)
1460 	    *d++ = '"';
1461 	else
1462 # endif
1463 	    *d++ = '\'';
1464 
1465 	for (p = string; *p != NUL; )
1466 	{
1467 # ifdef MSWIN
1468 	    if (!p_ssl)
1469 	    {
1470 		if (*p == '"')
1471 		{
1472 		    *d++ = '"';
1473 		    *d++ = '"';
1474 		    ++p;
1475 		    continue;
1476 		}
1477 	    }
1478 	    else
1479 # endif
1480 	    if (*p == '\'')
1481 	    {
1482 		*d++ = '\'';
1483 		*d++ = '\\';
1484 		*d++ = '\'';
1485 		*d++ = '\'';
1486 		++p;
1487 		continue;
1488 	    }
1489 	    if ((*p == '\n' && (csh_like || do_newline))
1490 		    || (*p == '!' && (csh_like || do_special)))
1491 	    {
1492 		*d++ = '\\';
1493 		if (csh_like && do_special)
1494 		    *d++ = '\\';
1495 		*d++ = *p++;
1496 		continue;
1497 	    }
1498 	    if (do_special && find_cmdline_var(p, &l) >= 0)
1499 	    {
1500 		*d++ = '\\';		// insert backslash
1501 		while (--l >= 0)	// copy the var
1502 		    *d++ = *p++;
1503 		continue;
1504 	    }
1505 
1506 	    MB_COPY_CHAR(p, d);
1507 	}
1508 
1509 	// add terminating quote and finish with a NUL
1510 # ifdef MSWIN
1511 	if (!p_ssl)
1512 	    *d++ = '"';
1513 	else
1514 # endif
1515 	    *d++ = '\'';
1516 	*d = NUL;
1517     }
1518 
1519     return escaped_string;
1520 }
1521 
1522 /*
1523  * Like vim_strsave(), but make all characters uppercase.
1524  * This uses ASCII lower-to-upper case translation, language independent.
1525  */
1526     char_u *
1527 vim_strsave_up(char_u *string)
1528 {
1529     char_u *p1;
1530 
1531     p1 = vim_strsave(string);
1532     vim_strup(p1);
1533     return p1;
1534 }
1535 
1536 /*
1537  * Like vim_strnsave(), but make all characters uppercase.
1538  * This uses ASCII lower-to-upper case translation, language independent.
1539  */
1540     char_u *
1541 vim_strnsave_up(char_u *string, size_t len)
1542 {
1543     char_u *p1;
1544 
1545     p1 = vim_strnsave(string, len);
1546     vim_strup(p1);
1547     return p1;
1548 }
1549 
1550 /*
1551  * ASCII lower-to-upper case translation, language independent.
1552  */
1553     void
1554 vim_strup(
1555     char_u	*p)
1556 {
1557     char_u  *p2;
1558     int	    c;
1559 
1560     if (p != NULL)
1561     {
1562 	p2 = p;
1563 	while ((c = *p2) != NUL)
1564 #ifdef EBCDIC
1565 	    *p2++ = isalpha(c) ? toupper(c) : c;
1566 #else
1567 	    *p2++ = (c < 'a' || c > 'z') ? c : (c - 0x20);
1568 #endif
1569     }
1570 }
1571 
1572 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
1573 /*
1574  * Make string "s" all upper-case and return it in allocated memory.
1575  * Handles multi-byte characters as well as possible.
1576  * Returns NULL when out of memory.
1577  */
1578     char_u *
1579 strup_save(char_u *orig)
1580 {
1581     char_u	*p;
1582     char_u	*res;
1583 
1584     res = p = vim_strsave(orig);
1585 
1586     if (res != NULL)
1587 	while (*p != NUL)
1588 	{
1589 	    int		l;
1590 
1591 	    if (enc_utf8)
1592 	    {
1593 		int	c, uc;
1594 		int	newl;
1595 		char_u	*s;
1596 
1597 		c = utf_ptr2char(p);
1598 		l = utf_ptr2len(p);
1599 		if (c == 0)
1600 		{
1601 		    // overlong sequence, use only the first byte
1602 		    c = *p;
1603 		    l = 1;
1604 		}
1605 		uc = utf_toupper(c);
1606 
1607 		// Reallocate string when byte count changes.  This is rare,
1608 		// thus it's OK to do another malloc()/free().
1609 		newl = utf_char2len(uc);
1610 		if (newl != l)
1611 		{
1612 		    s = alloc(STRLEN(res) + 1 + newl - l);
1613 		    if (s == NULL)
1614 		    {
1615 			vim_free(res);
1616 			return NULL;
1617 		    }
1618 		    mch_memmove(s, res, p - res);
1619 		    STRCPY(s + (p - res) + newl, p + l);
1620 		    p = s + (p - res);
1621 		    vim_free(res);
1622 		    res = s;
1623 		}
1624 
1625 		utf_char2bytes(uc, p);
1626 		p += newl;
1627 	    }
1628 	    else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1629 		p += l;		// skip multi-byte character
1630 	    else
1631 	    {
1632 		*p = TOUPPER_LOC(*p); // note that toupper() can be a macro
1633 		p++;
1634 	    }
1635 	}
1636 
1637     return res;
1638 }
1639 
1640 /*
1641  * Make string "s" all lower-case and return it in allocated memory.
1642  * Handles multi-byte characters as well as possible.
1643  * Returns NULL when out of memory.
1644  */
1645     char_u *
1646 strlow_save(char_u *orig)
1647 {
1648     char_u	*p;
1649     char_u	*res;
1650 
1651     res = p = vim_strsave(orig);
1652 
1653     if (res != NULL)
1654 	while (*p != NUL)
1655 	{
1656 	    int		l;
1657 
1658 	    if (enc_utf8)
1659 	    {
1660 		int	c, lc;
1661 		int	newl;
1662 		char_u	*s;
1663 
1664 		c = utf_ptr2char(p);
1665 		l = utf_ptr2len(p);
1666 		if (c == 0)
1667 		{
1668 		    // overlong sequence, use only the first byte
1669 		    c = *p;
1670 		    l = 1;
1671 		}
1672 		lc = utf_tolower(c);
1673 
1674 		// Reallocate string when byte count changes.  This is rare,
1675 		// thus it's OK to do another malloc()/free().
1676 		newl = utf_char2len(lc);
1677 		if (newl != l)
1678 		{
1679 		    s = alloc(STRLEN(res) + 1 + newl - l);
1680 		    if (s == NULL)
1681 		    {
1682 			vim_free(res);
1683 			return NULL;
1684 		    }
1685 		    mch_memmove(s, res, p - res);
1686 		    STRCPY(s + (p - res) + newl, p + l);
1687 		    p = s + (p - res);
1688 		    vim_free(res);
1689 		    res = s;
1690 		}
1691 
1692 		utf_char2bytes(lc, p);
1693 		p += newl;
1694 	    }
1695 	    else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1696 		p += l;		// skip multi-byte character
1697 	    else
1698 	    {
1699 		*p = TOLOWER_LOC(*p); // note that tolower() can be a macro
1700 		p++;
1701 	    }
1702 	}
1703 
1704     return res;
1705 }
1706 #endif
1707 
1708 /*
1709  * delete spaces at the end of a string
1710  */
1711     void
1712 del_trailing_spaces(char_u *ptr)
1713 {
1714     char_u	*q;
1715 
1716     q = ptr + STRLEN(ptr);
1717     while (--q > ptr && VIM_ISWHITE(q[0]) && q[-1] != '\\' && q[-1] != Ctrl_V)
1718 	*q = NUL;
1719 }
1720 
1721 /*
1722  * Like strncpy(), but always terminate the result with one NUL.
1723  * "to" must be "len + 1" long!
1724  */
1725     void
1726 vim_strncpy(char_u *to, char_u *from, size_t len)
1727 {
1728     STRNCPY(to, from, len);
1729     to[len] = NUL;
1730 }
1731 
1732 /*
1733  * Like strcat(), but make sure the result fits in "tosize" bytes and is
1734  * always NUL terminated. "from" and "to" may overlap.
1735  */
1736     void
1737 vim_strcat(char_u *to, char_u *from, size_t tosize)
1738 {
1739     size_t tolen = STRLEN(to);
1740     size_t fromlen = STRLEN(from);
1741 
1742     if (tolen + fromlen + 1 > tosize)
1743     {
1744 	mch_memmove(to + tolen, from, tosize - tolen - 1);
1745 	to[tosize - 1] = NUL;
1746     }
1747     else
1748 	mch_memmove(to + tolen, from, fromlen + 1);
1749 }
1750 
1751 /*
1752  * Isolate one part of a string option where parts are separated with
1753  * "sep_chars".
1754  * The part is copied into "buf[maxlen]".
1755  * "*option" is advanced to the next part.
1756  * The length is returned.
1757  */
1758     int
1759 copy_option_part(
1760     char_u	**option,
1761     char_u	*buf,
1762     int		maxlen,
1763     char	*sep_chars)
1764 {
1765     int	    len = 0;
1766     char_u  *p = *option;
1767 
1768     // skip '.' at start of option part, for 'suffixes'
1769     if (*p == '.')
1770 	buf[len++] = *p++;
1771     while (*p != NUL && vim_strchr((char_u *)sep_chars, *p) == NULL)
1772     {
1773 	/*
1774 	 * Skip backslash before a separator character and space.
1775 	 */
1776 	if (p[0] == '\\' && vim_strchr((char_u *)sep_chars, p[1]) != NULL)
1777 	    ++p;
1778 	if (len < maxlen - 1)
1779 	    buf[len++] = *p;
1780 	++p;
1781     }
1782     buf[len] = NUL;
1783 
1784     if (*p != NUL && *p != ',')	// skip non-standard separator
1785 	++p;
1786     p = skip_to_option_part(p);	// p points to next file name
1787 
1788     *option = p;
1789     return len;
1790 }
1791 
1792 /*
1793  * Replacement for free() that ignores NULL pointers.
1794  * Also skip free() when exiting for sure, this helps when we caught a deadly
1795  * signal that was caused by a crash in free().
1796  * If you want to set NULL after calling this function, you should use
1797  * VIM_CLEAR() instead.
1798  */
1799     void
1800 vim_free(void *x)
1801 {
1802     if (x != NULL && !really_exiting)
1803     {
1804 #ifdef MEM_PROFILE
1805 	mem_pre_free(&x);
1806 #endif
1807 	free(x);
1808     }
1809 }
1810 
1811 #ifndef HAVE_MEMSET
1812     void *
1813 vim_memset(void *ptr, int c, size_t size)
1814 {
1815     char *p = ptr;
1816 
1817     while (size-- > 0)
1818 	*p++ = c;
1819     return ptr;
1820 }
1821 #endif
1822 
1823 #if (!defined(HAVE_STRCASECMP) && !defined(HAVE_STRICMP)) || defined(PROTO)
1824 /*
1825  * Compare two strings, ignoring case, using current locale.
1826  * Doesn't work for multi-byte characters.
1827  * return 0 for match, < 0 for smaller, > 0 for bigger
1828  */
1829     int
1830 vim_stricmp(char *s1, char *s2)
1831 {
1832     int		i;
1833 
1834     for (;;)
1835     {
1836 	i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
1837 	if (i != 0)
1838 	    return i;			    // this character different
1839 	if (*s1 == NUL)
1840 	    break;			    // strings match until NUL
1841 	++s1;
1842 	++s2;
1843     }
1844     return 0;				    // strings match
1845 }
1846 #endif
1847 
1848 #if (!defined(HAVE_STRNCASECMP) && !defined(HAVE_STRNICMP)) || defined(PROTO)
1849 /*
1850  * Compare two strings, for length "len", ignoring case, using current locale.
1851  * Doesn't work for multi-byte characters.
1852  * return 0 for match, < 0 for smaller, > 0 for bigger
1853  */
1854     int
1855 vim_strnicmp(char *s1, char *s2, size_t len)
1856 {
1857     int		i;
1858 
1859     while (len > 0)
1860     {
1861 	i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
1862 	if (i != 0)
1863 	    return i;			    // this character different
1864 	if (*s1 == NUL)
1865 	    break;			    // strings match until NUL
1866 	++s1;
1867 	++s2;
1868 	--len;
1869     }
1870     return 0;				    // strings match
1871 }
1872 #endif
1873 
1874 /*
1875  * Version of strchr() and strrchr() that handle unsigned char strings
1876  * with characters from 128 to 255 correctly.  It also doesn't return a
1877  * pointer to the NUL at the end of the string.
1878  */
1879     char_u  *
1880 vim_strchr(char_u *string, int c)
1881 {
1882     char_u	*p;
1883     int		b;
1884 
1885     p = string;
1886     if (enc_utf8 && c >= 0x80)
1887     {
1888 	while (*p != NUL)
1889 	{
1890 	    int l = utfc_ptr2len(p);
1891 
1892 	    // Avoid matching an illegal byte here.
1893 	    if (utf_ptr2char(p) == c && l > 1)
1894 		return p;
1895 	    p += l;
1896 	}
1897 	return NULL;
1898     }
1899     if (enc_dbcs != 0 && c > 255)
1900     {
1901 	int	n2 = c & 0xff;
1902 
1903 	c = ((unsigned)c >> 8) & 0xff;
1904 	while ((b = *p) != NUL)
1905 	{
1906 	    if (b == c && p[1] == n2)
1907 		return p;
1908 	    p += (*mb_ptr2len)(p);
1909 	}
1910 	return NULL;
1911     }
1912     if (has_mbyte)
1913     {
1914 	while ((b = *p) != NUL)
1915 	{
1916 	    if (b == c)
1917 		return p;
1918 	    p += (*mb_ptr2len)(p);
1919 	}
1920 	return NULL;
1921     }
1922     while ((b = *p) != NUL)
1923     {
1924 	if (b == c)
1925 	    return p;
1926 	++p;
1927     }
1928     return NULL;
1929 }
1930 
1931 /*
1932  * Version of strchr() that only works for bytes and handles unsigned char
1933  * strings with characters above 128 correctly. It also doesn't return a
1934  * pointer to the NUL at the end of the string.
1935  */
1936     char_u  *
1937 vim_strbyte(char_u *string, int c)
1938 {
1939     char_u	*p = string;
1940 
1941     while (*p != NUL)
1942     {
1943 	if (*p == c)
1944 	    return p;
1945 	++p;
1946     }
1947     return NULL;
1948 }
1949 
1950 /*
1951  * Search for last occurrence of "c" in "string".
1952  * Return NULL if not found.
1953  * Does not handle multi-byte char for "c"!
1954  */
1955     char_u  *
1956 vim_strrchr(char_u *string, int c)
1957 {
1958     char_u	*retval = NULL;
1959     char_u	*p = string;
1960 
1961     while (*p)
1962     {
1963 	if (*p == c)
1964 	    retval = p;
1965 	MB_PTR_ADV(p);
1966     }
1967     return retval;
1968 }
1969 
1970 /*
1971  * Vim's version of strpbrk(), in case it's missing.
1972  * Don't generate a prototype for this, causes problems when it's not used.
1973  */
1974 #ifndef PROTO
1975 # ifndef HAVE_STRPBRK
1976 #  ifdef vim_strpbrk
1977 #   undef vim_strpbrk
1978 #  endif
1979     char_u *
1980 vim_strpbrk(char_u *s, char_u *charset)
1981 {
1982     while (*s)
1983     {
1984 	if (vim_strchr(charset, *s) != NULL)
1985 	    return s;
1986 	MB_PTR_ADV(s);
1987     }
1988     return NULL;
1989 }
1990 # endif
1991 #endif
1992 
1993 /*
1994  * Vim has its own isspace() function, because on some machines isspace()
1995  * can't handle characters above 128.
1996  */
1997     int
1998 vim_isspace(int x)
1999 {
2000     return ((x >= 9 && x <= 13) || x == ' ');
2001 }
2002 
2003 /************************************************************************
2004  * Functions for handling growing arrays.
2005  */
2006 
2007 /*
2008  * Clear an allocated growing array.
2009  */
2010     void
2011 ga_clear(garray_T *gap)
2012 {
2013     vim_free(gap->ga_data);
2014     ga_init(gap);
2015 }
2016 
2017 /*
2018  * Clear a growing array that contains a list of strings.
2019  */
2020     void
2021 ga_clear_strings(garray_T *gap)
2022 {
2023     int		i;
2024 
2025     for (i = 0; i < gap->ga_len; ++i)
2026 	vim_free(((char_u **)(gap->ga_data))[i]);
2027     ga_clear(gap);
2028 }
2029 
2030 /*
2031  * Copy a growing array that contains a list of strings.
2032  */
2033     int
2034 ga_copy_strings(garray_T *from, garray_T *to)
2035 {
2036     int		i;
2037 
2038     ga_init2(to, sizeof(char_u *), 1);
2039     if (ga_grow(to, from->ga_len) == FAIL)
2040 	return FAIL;
2041 
2042     for (i = 0; i < from->ga_len; ++i)
2043     {
2044 	char_u *orig = ((char_u **)from->ga_data)[i];
2045 	char_u *copy;
2046 
2047 	if (orig == NULL)
2048 	    copy = NULL;
2049 	else
2050 	{
2051 	    copy = vim_strsave(orig);
2052 	    if (copy == NULL)
2053 	    {
2054 		to->ga_len = i;
2055 		ga_clear_strings(to);
2056 		return FAIL;
2057 	    }
2058 	}
2059 	((char_u **)to->ga_data)[i] = copy;
2060     }
2061     to->ga_len = from->ga_len;
2062     return OK;
2063 }
2064 
2065 /*
2066  * Initialize a growing array.	Don't forget to set ga_itemsize and
2067  * ga_growsize!  Or use ga_init2().
2068  */
2069     void
2070 ga_init(garray_T *gap)
2071 {
2072     gap->ga_data = NULL;
2073     gap->ga_maxlen = 0;
2074     gap->ga_len = 0;
2075 }
2076 
2077     void
2078 ga_init2(garray_T *gap, int itemsize, int growsize)
2079 {
2080     ga_init(gap);
2081     gap->ga_itemsize = itemsize;
2082     gap->ga_growsize = growsize;
2083 }
2084 
2085 /*
2086  * Make room in growing array "gap" for at least "n" items.
2087  * Return FAIL for failure, OK otherwise.
2088  */
2089     int
2090 ga_grow(garray_T *gap, int n)
2091 {
2092     if (gap->ga_maxlen - gap->ga_len < n)
2093 	return ga_grow_inner(gap, n);
2094     return OK;
2095 }
2096 
2097     int
2098 ga_grow_inner(garray_T *gap, int n)
2099 {
2100     size_t	old_len;
2101     size_t	new_len;
2102     char_u	*pp;
2103 
2104     if (n < gap->ga_growsize)
2105 	n = gap->ga_growsize;
2106 
2107     // A linear growth is very inefficient when the array grows big.  This
2108     // is a compromise between allocating memory that won't be used and too
2109     // many copy operations. A factor of 1.5 seems reasonable.
2110     if (n < gap->ga_len / 2)
2111 	n = gap->ga_len / 2;
2112 
2113     new_len = gap->ga_itemsize * (gap->ga_len + n);
2114     pp = vim_realloc(gap->ga_data, new_len);
2115     if (pp == NULL)
2116 	return FAIL;
2117     old_len = gap->ga_itemsize * gap->ga_maxlen;
2118     vim_memset(pp + old_len, 0, new_len - old_len);
2119     gap->ga_maxlen = gap->ga_len + n;
2120     gap->ga_data = pp;
2121     return OK;
2122 }
2123 
2124 #if defined(FEAT_EVAL) || defined(FEAT_SEARCHPATH) || defined(PROTO)
2125 /*
2126  * For a growing array that contains a list of strings: concatenate all the
2127  * strings with a separating "sep".
2128  * Returns NULL when out of memory.
2129  */
2130     char_u *
2131 ga_concat_strings(garray_T *gap, char *sep)
2132 {
2133     int		i;
2134     int		len = 0;
2135     int		sep_len = (int)STRLEN(sep);
2136     char_u	*s;
2137     char_u	*p;
2138 
2139     for (i = 0; i < gap->ga_len; ++i)
2140 	len += (int)STRLEN(((char_u **)(gap->ga_data))[i]) + sep_len;
2141 
2142     s = alloc(len + 1);
2143     if (s != NULL)
2144     {
2145 	*s = NUL;
2146 	p = s;
2147 	for (i = 0; i < gap->ga_len; ++i)
2148 	{
2149 	    if (p != s)
2150 	    {
2151 		STRCPY(p, sep);
2152 		p += sep_len;
2153 	    }
2154 	    STRCPY(p, ((char_u **)(gap->ga_data))[i]);
2155 	    p += STRLEN(p);
2156 	}
2157     }
2158     return s;
2159 }
2160 #endif
2161 
2162 #if defined(FEAT_VIMINFO) || defined(FEAT_EVAL) || defined(PROTO)
2163 /*
2164  * Make a copy of string "p" and add it to "gap".
2165  * When out of memory nothing changes.
2166  */
2167     void
2168 ga_add_string(garray_T *gap, char_u *p)
2169 {
2170     char_u *cp = vim_strsave(p);
2171 
2172     if (cp != NULL)
2173     {
2174 	if (ga_grow(gap, 1) == OK)
2175 	    ((char_u **)(gap->ga_data))[gap->ga_len++] = cp;
2176 	else
2177 	    vim_free(cp);
2178     }
2179 }
2180 #endif
2181 
2182 /*
2183  * Concatenate a string to a growarray which contains bytes.
2184  * When "s" is NULL does not do anything.
2185  * Note: Does NOT copy the NUL at the end!
2186  */
2187     void
2188 ga_concat(garray_T *gap, char_u *s)
2189 {
2190     int    len;
2191 
2192     if (s == NULL || *s == NUL)
2193 	return;
2194     len = (int)STRLEN(s);
2195     if (ga_grow(gap, len) == OK)
2196     {
2197 	mch_memmove((char *)gap->ga_data + gap->ga_len, s, (size_t)len);
2198 	gap->ga_len += len;
2199     }
2200 }
2201 
2202 /*
2203  * Append one byte to a growarray which contains bytes.
2204  */
2205     void
2206 ga_append(garray_T *gap, int c)
2207 {
2208     if (ga_grow(gap, 1) == OK)
2209     {
2210 	*((char *)gap->ga_data + gap->ga_len) = c;
2211 	++gap->ga_len;
2212     }
2213 }
2214 
2215 #if (defined(UNIX) && !defined(USE_SYSTEM)) || defined(MSWIN) \
2216 	|| defined(PROTO)
2217 /*
2218  * Append the text in "gap" below the cursor line and clear "gap".
2219  */
2220     void
2221 append_ga_line(garray_T *gap)
2222 {
2223     // Remove trailing CR.
2224     if (gap->ga_len > 0
2225 	    && !curbuf->b_p_bin
2226 	    && ((char_u *)gap->ga_data)[gap->ga_len - 1] == CAR)
2227 	--gap->ga_len;
2228     ga_append(gap, NUL);
2229     ml_append(curwin->w_cursor.lnum++, gap->ga_data, 0, FALSE);
2230     gap->ga_len = 0;
2231 }
2232 #endif
2233 
2234 /************************************************************************
2235  * functions that use lookup tables for various things, generally to do with
2236  * special key codes.
2237  */
2238 
2239 /*
2240  * Some useful tables.
2241  */
2242 
2243 static struct modmasktable
2244 {
2245     short	mod_mask;	// Bit-mask for particular key modifier
2246     short	mod_flag;	// Bit(s) for particular key modifier
2247     char_u	name;		// Single letter name of modifier
2248 } mod_mask_table[] =
2249 {
2250     {MOD_MASK_ALT,		MOD_MASK_ALT,		(char_u)'M'},
2251     {MOD_MASK_META,		MOD_MASK_META,		(char_u)'T'},
2252     {MOD_MASK_CTRL,		MOD_MASK_CTRL,		(char_u)'C'},
2253     {MOD_MASK_SHIFT,		MOD_MASK_SHIFT,		(char_u)'S'},
2254     {MOD_MASK_MULTI_CLICK,	MOD_MASK_2CLICK,	(char_u)'2'},
2255     {MOD_MASK_MULTI_CLICK,	MOD_MASK_3CLICK,	(char_u)'3'},
2256     {MOD_MASK_MULTI_CLICK,	MOD_MASK_4CLICK,	(char_u)'4'},
2257 #ifdef MACOS_X
2258     {MOD_MASK_CMD,		MOD_MASK_CMD,		(char_u)'D'},
2259 #endif
2260     // 'A' must be the last one
2261     {MOD_MASK_ALT,		MOD_MASK_ALT,		(char_u)'A'},
2262     {0, 0, NUL}
2263     // NOTE: when adding an entry, update MAX_KEY_NAME_LEN!
2264 };
2265 
2266 /*
2267  * Shifted key terminal codes and their unshifted equivalent.
2268  * Don't add mouse codes here, they are handled separately!
2269  */
2270 #define MOD_KEYS_ENTRY_SIZE 5
2271 
2272 static char_u modifier_keys_table[] =
2273 {
2274 //  mod mask	    with modifier		without modifier
2275     MOD_MASK_SHIFT, '&', '9',			'@', '1',	// begin
2276     MOD_MASK_SHIFT, '&', '0',			'@', '2',	// cancel
2277     MOD_MASK_SHIFT, '*', '1',			'@', '4',	// command
2278     MOD_MASK_SHIFT, '*', '2',			'@', '5',	// copy
2279     MOD_MASK_SHIFT, '*', '3',			'@', '6',	// create
2280     MOD_MASK_SHIFT, '*', '4',			'k', 'D',	// delete char
2281     MOD_MASK_SHIFT, '*', '5',			'k', 'L',	// delete line
2282     MOD_MASK_SHIFT, '*', '7',			'@', '7',	// end
2283     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_END,	'@', '7',	// end
2284     MOD_MASK_SHIFT, '*', '9',			'@', '9',	// exit
2285     MOD_MASK_SHIFT, '*', '0',			'@', '0',	// find
2286     MOD_MASK_SHIFT, '#', '1',			'%', '1',	// help
2287     MOD_MASK_SHIFT, '#', '2',			'k', 'h',	// home
2288     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_HOME,	'k', 'h',	// home
2289     MOD_MASK_SHIFT, '#', '3',			'k', 'I',	// insert
2290     MOD_MASK_SHIFT, '#', '4',			'k', 'l',	// left arrow
2291     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_LEFT,	'k', 'l',	// left arrow
2292     MOD_MASK_SHIFT, '%', 'a',			'%', '3',	// message
2293     MOD_MASK_SHIFT, '%', 'b',			'%', '4',	// move
2294     MOD_MASK_SHIFT, '%', 'c',			'%', '5',	// next
2295     MOD_MASK_SHIFT, '%', 'd',			'%', '7',	// options
2296     MOD_MASK_SHIFT, '%', 'e',			'%', '8',	// previous
2297     MOD_MASK_SHIFT, '%', 'f',			'%', '9',	// print
2298     MOD_MASK_SHIFT, '%', 'g',			'%', '0',	// redo
2299     MOD_MASK_SHIFT, '%', 'h',			'&', '3',	// replace
2300     MOD_MASK_SHIFT, '%', 'i',			'k', 'r',	// right arr.
2301     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_RIGHT,	'k', 'r',	// right arr.
2302     MOD_MASK_SHIFT, '%', 'j',			'&', '5',	// resume
2303     MOD_MASK_SHIFT, '!', '1',			'&', '6',	// save
2304     MOD_MASK_SHIFT, '!', '2',			'&', '7',	// suspend
2305     MOD_MASK_SHIFT, '!', '3',			'&', '8',	// undo
2306     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_UP,	'k', 'u',	// up arrow
2307     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_DOWN,	'k', 'd',	// down arrow
2308 
2309 								// vt100 F1
2310     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF1,	KS_EXTRA, (int)KE_XF1,
2311     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF2,	KS_EXTRA, (int)KE_XF2,
2312     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF3,	KS_EXTRA, (int)KE_XF3,
2313     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF4,	KS_EXTRA, (int)KE_XF4,
2314 
2315     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F1,	'k', '1',	// F1
2316     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F2,	'k', '2',
2317     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F3,	'k', '3',
2318     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F4,	'k', '4',
2319     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F5,	'k', '5',
2320     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F6,	'k', '6',
2321     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F7,	'k', '7',
2322     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F8,	'k', '8',
2323     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F9,	'k', '9',
2324     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F10,	'k', ';',	// F10
2325 
2326     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F11,	'F', '1',
2327     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F12,	'F', '2',
2328     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F13,	'F', '3',
2329     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F14,	'F', '4',
2330     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F15,	'F', '5',
2331     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F16,	'F', '6',
2332     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F17,	'F', '7',
2333     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F18,	'F', '8',
2334     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F19,	'F', '9',
2335     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F20,	'F', 'A',
2336 
2337     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F21,	'F', 'B',
2338     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F22,	'F', 'C',
2339     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F23,	'F', 'D',
2340     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F24,	'F', 'E',
2341     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F25,	'F', 'F',
2342     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F26,	'F', 'G',
2343     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F27,	'F', 'H',
2344     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F28,	'F', 'I',
2345     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F29,	'F', 'J',
2346     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F30,	'F', 'K',
2347 
2348     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F31,	'F', 'L',
2349     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F32,	'F', 'M',
2350     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F33,	'F', 'N',
2351     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F34,	'F', 'O',
2352     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F35,	'F', 'P',
2353     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F36,	'F', 'Q',
2354     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F37,	'F', 'R',
2355 
2356 							    // TAB pseudo code
2357     MOD_MASK_SHIFT, 'k', 'B',			KS_EXTRA, (int)KE_TAB,
2358 
2359     NUL
2360 };
2361 
2362 static struct key_name_entry
2363 {
2364     int	    key;	// Special key code or ascii value
2365     char_u  *name;	// Name of key
2366 } key_names_table[] =
2367 {
2368     {' ',		(char_u *)"Space"},
2369     {TAB,		(char_u *)"Tab"},
2370     {K_TAB,		(char_u *)"Tab"},
2371     {NL,		(char_u *)"NL"},
2372     {NL,		(char_u *)"NewLine"},	// Alternative name
2373     {NL,		(char_u *)"LineFeed"},	// Alternative name
2374     {NL,		(char_u *)"LF"},	// Alternative name
2375     {CAR,		(char_u *)"CR"},
2376     {CAR,		(char_u *)"Return"},	// Alternative name
2377     {CAR,		(char_u *)"Enter"},	// Alternative name
2378     {K_BS,		(char_u *)"BS"},
2379     {K_BS,		(char_u *)"BackSpace"},	// Alternative name
2380     {ESC,		(char_u *)"Esc"},
2381     {CSI,		(char_u *)"CSI"},
2382     {K_CSI,		(char_u *)"xCSI"},
2383     {'|',		(char_u *)"Bar"},
2384     {'\\',		(char_u *)"Bslash"},
2385     {K_DEL,		(char_u *)"Del"},
2386     {K_DEL,		(char_u *)"Delete"},	// Alternative name
2387     {K_KDEL,		(char_u *)"kDel"},
2388     {K_UP,		(char_u *)"Up"},
2389     {K_DOWN,		(char_u *)"Down"},
2390     {K_LEFT,		(char_u *)"Left"},
2391     {K_RIGHT,		(char_u *)"Right"},
2392     {K_XUP,		(char_u *)"xUp"},
2393     {K_XDOWN,		(char_u *)"xDown"},
2394     {K_XLEFT,		(char_u *)"xLeft"},
2395     {K_XRIGHT,		(char_u *)"xRight"},
2396     {K_PS,		(char_u *)"PasteStart"},
2397     {K_PE,		(char_u *)"PasteEnd"},
2398 
2399     {K_F1,		(char_u *)"F1"},
2400     {K_F2,		(char_u *)"F2"},
2401     {K_F3,		(char_u *)"F3"},
2402     {K_F4,		(char_u *)"F4"},
2403     {K_F5,		(char_u *)"F5"},
2404     {K_F6,		(char_u *)"F6"},
2405     {K_F7,		(char_u *)"F7"},
2406     {K_F8,		(char_u *)"F8"},
2407     {K_F9,		(char_u *)"F9"},
2408     {K_F10,		(char_u *)"F10"},
2409 
2410     {K_F11,		(char_u *)"F11"},
2411     {K_F12,		(char_u *)"F12"},
2412     {K_F13,		(char_u *)"F13"},
2413     {K_F14,		(char_u *)"F14"},
2414     {K_F15,		(char_u *)"F15"},
2415     {K_F16,		(char_u *)"F16"},
2416     {K_F17,		(char_u *)"F17"},
2417     {K_F18,		(char_u *)"F18"},
2418     {K_F19,		(char_u *)"F19"},
2419     {K_F20,		(char_u *)"F20"},
2420 
2421     {K_F21,		(char_u *)"F21"},
2422     {K_F22,		(char_u *)"F22"},
2423     {K_F23,		(char_u *)"F23"},
2424     {K_F24,		(char_u *)"F24"},
2425     {K_F25,		(char_u *)"F25"},
2426     {K_F26,		(char_u *)"F26"},
2427     {K_F27,		(char_u *)"F27"},
2428     {K_F28,		(char_u *)"F28"},
2429     {K_F29,		(char_u *)"F29"},
2430     {K_F30,		(char_u *)"F30"},
2431 
2432     {K_F31,		(char_u *)"F31"},
2433     {K_F32,		(char_u *)"F32"},
2434     {K_F33,		(char_u *)"F33"},
2435     {K_F34,		(char_u *)"F34"},
2436     {K_F35,		(char_u *)"F35"},
2437     {K_F36,		(char_u *)"F36"},
2438     {K_F37,		(char_u *)"F37"},
2439 
2440     {K_XF1,		(char_u *)"xF1"},
2441     {K_XF2,		(char_u *)"xF2"},
2442     {K_XF3,		(char_u *)"xF3"},
2443     {K_XF4,		(char_u *)"xF4"},
2444 
2445     {K_HELP,		(char_u *)"Help"},
2446     {K_UNDO,		(char_u *)"Undo"},
2447     {K_INS,		(char_u *)"Insert"},
2448     {K_INS,		(char_u *)"Ins"},	// Alternative name
2449     {K_KINS,		(char_u *)"kInsert"},
2450     {K_HOME,		(char_u *)"Home"},
2451     {K_KHOME,		(char_u *)"kHome"},
2452     {K_XHOME,		(char_u *)"xHome"},
2453     {K_ZHOME,		(char_u *)"zHome"},
2454     {K_END,		(char_u *)"End"},
2455     {K_KEND,		(char_u *)"kEnd"},
2456     {K_XEND,		(char_u *)"xEnd"},
2457     {K_ZEND,		(char_u *)"zEnd"},
2458     {K_PAGEUP,		(char_u *)"PageUp"},
2459     {K_PAGEDOWN,	(char_u *)"PageDown"},
2460     {K_KPAGEUP,		(char_u *)"kPageUp"},
2461     {K_KPAGEDOWN,	(char_u *)"kPageDown"},
2462 
2463     {K_KPLUS,		(char_u *)"kPlus"},
2464     {K_KMINUS,		(char_u *)"kMinus"},
2465     {K_KDIVIDE,		(char_u *)"kDivide"},
2466     {K_KMULTIPLY,	(char_u *)"kMultiply"},
2467     {K_KENTER,		(char_u *)"kEnter"},
2468     {K_KPOINT,		(char_u *)"kPoint"},
2469 
2470     {K_K0,		(char_u *)"k0"},
2471     {K_K1,		(char_u *)"k1"},
2472     {K_K2,		(char_u *)"k2"},
2473     {K_K3,		(char_u *)"k3"},
2474     {K_K4,		(char_u *)"k4"},
2475     {K_K5,		(char_u *)"k5"},
2476     {K_K6,		(char_u *)"k6"},
2477     {K_K7,		(char_u *)"k7"},
2478     {K_K8,		(char_u *)"k8"},
2479     {K_K9,		(char_u *)"k9"},
2480 
2481     {'<',		(char_u *)"lt"},
2482 
2483     {K_MOUSE,		(char_u *)"Mouse"},
2484 #ifdef FEAT_MOUSE_NET
2485     {K_NETTERM_MOUSE,	(char_u *)"NetMouse"},
2486 #endif
2487 #ifdef FEAT_MOUSE_DEC
2488     {K_DEC_MOUSE,	(char_u *)"DecMouse"},
2489 #endif
2490 #ifdef FEAT_MOUSE_JSB
2491     {K_JSBTERM_MOUSE,	(char_u *)"JsbMouse"},
2492 #endif
2493 #ifdef FEAT_MOUSE_PTERM
2494     {K_PTERM_MOUSE,	(char_u *)"PtermMouse"},
2495 #endif
2496 #ifdef FEAT_MOUSE_URXVT
2497     {K_URXVT_MOUSE,	(char_u *)"UrxvtMouse"},
2498 #endif
2499     {K_SGR_MOUSE,	(char_u *)"SgrMouse"},
2500     {K_SGR_MOUSERELEASE, (char_u *)"SgrMouseRelelase"},
2501     {K_LEFTMOUSE,	(char_u *)"LeftMouse"},
2502     {K_LEFTMOUSE_NM,	(char_u *)"LeftMouseNM"},
2503     {K_LEFTDRAG,	(char_u *)"LeftDrag"},
2504     {K_LEFTRELEASE,	(char_u *)"LeftRelease"},
2505     {K_LEFTRELEASE_NM,	(char_u *)"LeftReleaseNM"},
2506     {K_MOUSEMOVE,	(char_u *)"MouseMove"},
2507     {K_MIDDLEMOUSE,	(char_u *)"MiddleMouse"},
2508     {K_MIDDLEDRAG,	(char_u *)"MiddleDrag"},
2509     {K_MIDDLERELEASE,	(char_u *)"MiddleRelease"},
2510     {K_RIGHTMOUSE,	(char_u *)"RightMouse"},
2511     {K_RIGHTDRAG,	(char_u *)"RightDrag"},
2512     {K_RIGHTRELEASE,	(char_u *)"RightRelease"},
2513     {K_MOUSEDOWN,	(char_u *)"ScrollWheelUp"},
2514     {K_MOUSEUP,		(char_u *)"ScrollWheelDown"},
2515     {K_MOUSELEFT,	(char_u *)"ScrollWheelRight"},
2516     {K_MOUSERIGHT,	(char_u *)"ScrollWheelLeft"},
2517     {K_MOUSEDOWN,	(char_u *)"MouseDown"}, // OBSOLETE: Use
2518     {K_MOUSEUP,		(char_u *)"MouseUp"},	// ScrollWheelXXX instead
2519     {K_X1MOUSE,		(char_u *)"X1Mouse"},
2520     {K_X1DRAG,		(char_u *)"X1Drag"},
2521     {K_X1RELEASE,		(char_u *)"X1Release"},
2522     {K_X2MOUSE,		(char_u *)"X2Mouse"},
2523     {K_X2DRAG,		(char_u *)"X2Drag"},
2524     {K_X2RELEASE,		(char_u *)"X2Release"},
2525     {K_DROP,		(char_u *)"Drop"},
2526     {K_ZERO,		(char_u *)"Nul"},
2527 #ifdef FEAT_EVAL
2528     {K_SNR,		(char_u *)"SNR"},
2529 #endif
2530     {K_PLUG,		(char_u *)"Plug"},
2531     {K_CURSORHOLD,	(char_u *)"CursorHold"},
2532     {K_IGNORE,		(char_u *)"Ignore"},
2533     {K_COMMAND,		(char_u *)"Cmd"},
2534     {0,			NULL}
2535     // NOTE: When adding a long name update MAX_KEY_NAME_LEN.
2536 };
2537 
2538 #define KEY_NAMES_TABLE_LEN (sizeof(key_names_table) / sizeof(struct key_name_entry))
2539 
2540 /*
2541  * Return the modifier mask bit (MOD_MASK_*) which corresponds to the given
2542  * modifier name ('S' for Shift, 'C' for Ctrl etc).
2543  */
2544     static int
2545 name_to_mod_mask(int c)
2546 {
2547     int	    i;
2548 
2549     c = TOUPPER_ASC(c);
2550     for (i = 0; mod_mask_table[i].mod_mask != 0; i++)
2551 	if (c == mod_mask_table[i].name)
2552 	    return mod_mask_table[i].mod_flag;
2553     return 0;
2554 }
2555 
2556 /*
2557  * Check if if there is a special key code for "key" that includes the
2558  * modifiers specified.
2559  */
2560     int
2561 simplify_key(int key, int *modifiers)
2562 {
2563     int	    i;
2564     int	    key0;
2565     int	    key1;
2566 
2567     if (*modifiers & (MOD_MASK_SHIFT | MOD_MASK_CTRL | MOD_MASK_ALT))
2568     {
2569 	// TAB is a special case
2570 	if (key == TAB && (*modifiers & MOD_MASK_SHIFT))
2571 	{
2572 	    *modifiers &= ~MOD_MASK_SHIFT;
2573 	    return K_S_TAB;
2574 	}
2575 	key0 = KEY2TERMCAP0(key);
2576 	key1 = KEY2TERMCAP1(key);
2577 	for (i = 0; modifier_keys_table[i] != NUL; i += MOD_KEYS_ENTRY_SIZE)
2578 	    if (key0 == modifier_keys_table[i + 3]
2579 		    && key1 == modifier_keys_table[i + 4]
2580 		    && (*modifiers & modifier_keys_table[i]))
2581 	    {
2582 		*modifiers &= ~modifier_keys_table[i];
2583 		return TERMCAP2KEY(modifier_keys_table[i + 1],
2584 						   modifier_keys_table[i + 2]);
2585 	    }
2586     }
2587     return key;
2588 }
2589 
2590 /*
2591  * Change <xHome> to <Home>, <xUp> to <Up>, etc.
2592  */
2593     int
2594 handle_x_keys(int key)
2595 {
2596     switch (key)
2597     {
2598 	case K_XUP:	return K_UP;
2599 	case K_XDOWN:	return K_DOWN;
2600 	case K_XLEFT:	return K_LEFT;
2601 	case K_XRIGHT:	return K_RIGHT;
2602 	case K_XHOME:	return K_HOME;
2603 	case K_ZHOME:	return K_HOME;
2604 	case K_XEND:	return K_END;
2605 	case K_ZEND:	return K_END;
2606 	case K_XF1:	return K_F1;
2607 	case K_XF2:	return K_F2;
2608 	case K_XF3:	return K_F3;
2609 	case K_XF4:	return K_F4;
2610 	case K_S_XF1:	return K_S_F1;
2611 	case K_S_XF2:	return K_S_F2;
2612 	case K_S_XF3:	return K_S_F3;
2613 	case K_S_XF4:	return K_S_F4;
2614     }
2615     return key;
2616 }
2617 
2618 /*
2619  * Return a string which contains the name of the given key when the given
2620  * modifiers are down.
2621  */
2622     char_u *
2623 get_special_key_name(int c, int modifiers)
2624 {
2625     static char_u string[MAX_KEY_NAME_LEN + 1];
2626 
2627     int	    i, idx;
2628     int	    table_idx;
2629     char_u  *s;
2630 
2631     string[0] = '<';
2632     idx = 1;
2633 
2634     // Key that stands for a normal character.
2635     if (IS_SPECIAL(c) && KEY2TERMCAP0(c) == KS_KEY)
2636 	c = KEY2TERMCAP1(c);
2637 
2638     /*
2639      * Translate shifted special keys into unshifted keys and set modifier.
2640      * Same for CTRL and ALT modifiers.
2641      */
2642     if (IS_SPECIAL(c))
2643     {
2644 	for (i = 0; modifier_keys_table[i] != 0; i += MOD_KEYS_ENTRY_SIZE)
2645 	    if (       KEY2TERMCAP0(c) == (int)modifier_keys_table[i + 1]
2646 		    && (int)KEY2TERMCAP1(c) == (int)modifier_keys_table[i + 2])
2647 	    {
2648 		modifiers |= modifier_keys_table[i];
2649 		c = TERMCAP2KEY(modifier_keys_table[i + 3],
2650 						   modifier_keys_table[i + 4]);
2651 		break;
2652 	    }
2653     }
2654 
2655     // try to find the key in the special key table
2656     table_idx = find_special_key_in_table(c);
2657 
2658     /*
2659      * When not a known special key, and not a printable character, try to
2660      * extract modifiers.
2661      */
2662     if (c > 0 && (*mb_char2len)(c) == 1)
2663     {
2664 	if (table_idx < 0
2665 		&& (!vim_isprintc(c) || (c & 0x7f) == ' ')
2666 		&& (c & 0x80))
2667 	{
2668 	    c &= 0x7f;
2669 	    modifiers |= MOD_MASK_ALT;
2670 	    // try again, to find the un-alted key in the special key table
2671 	    table_idx = find_special_key_in_table(c);
2672 	}
2673 	if (table_idx < 0 && !vim_isprintc(c) && c < ' ')
2674 	{
2675 #ifdef EBCDIC
2676 	    c = CtrlChar(c);
2677 #else
2678 	    c += '@';
2679 #endif
2680 	    modifiers |= MOD_MASK_CTRL;
2681 	}
2682     }
2683 
2684     // translate the modifier into a string
2685     for (i = 0; mod_mask_table[i].name != 'A'; i++)
2686 	if ((modifiers & mod_mask_table[i].mod_mask)
2687 						== mod_mask_table[i].mod_flag)
2688 	{
2689 	    string[idx++] = mod_mask_table[i].name;
2690 	    string[idx++] = (char_u)'-';
2691 	}
2692 
2693     if (table_idx < 0)		// unknown special key, may output t_xx
2694     {
2695 	if (IS_SPECIAL(c))
2696 	{
2697 	    string[idx++] = 't';
2698 	    string[idx++] = '_';
2699 	    string[idx++] = KEY2TERMCAP0(c);
2700 	    string[idx++] = KEY2TERMCAP1(c);
2701 	}
2702 	// Not a special key, only modifiers, output directly
2703 	else
2704 	{
2705 	    if (has_mbyte && (*mb_char2len)(c) > 1)
2706 		idx += (*mb_char2bytes)(c, string + idx);
2707 	    else if (vim_isprintc(c))
2708 		string[idx++] = c;
2709 	    else
2710 	    {
2711 		s = transchar(c);
2712 		while (*s)
2713 		    string[idx++] = *s++;
2714 	    }
2715 	}
2716     }
2717     else		// use name of special key
2718     {
2719 	size_t len = STRLEN(key_names_table[table_idx].name);
2720 
2721 	if (len + idx + 2 <= MAX_KEY_NAME_LEN)
2722 	{
2723 	    STRCPY(string + idx, key_names_table[table_idx].name);
2724 	    idx += (int)len;
2725 	}
2726     }
2727     string[idx++] = '>';
2728     string[idx] = NUL;
2729     return string;
2730 }
2731 
2732 /*
2733  * Try translating a <> name at (*srcp)[] to dst[].
2734  * Return the number of characters added to dst[], zero for no match.
2735  * If there is a match, srcp is advanced to after the <> name.
2736  * dst[] must be big enough to hold the result (up to six characters)!
2737  */
2738     int
2739 trans_special(
2740     char_u	**srcp,
2741     char_u	*dst,
2742     int		flags,		// FSK_ values
2743     int		*did_simplify)  // FSK_SIMPLIFY and found <C-H> or <A-x>
2744 {
2745     int		modifiers = 0;
2746     int		key;
2747 
2748     key = find_special_key(srcp, &modifiers, flags, did_simplify);
2749     if (key == 0)
2750 	return 0;
2751 
2752     return special_to_buf(key, modifiers, flags & FSK_KEYCODE, dst);
2753 }
2754 
2755 /*
2756  * Put the character sequence for "key" with "modifiers" into "dst" and return
2757  * the resulting length.
2758  * When "keycode" is TRUE prefer key code, e.g. K_DEL instead of DEL.
2759  * The sequence is not NUL terminated.
2760  * This is how characters in a string are encoded.
2761  */
2762     int
2763 special_to_buf(int key, int modifiers, int keycode, char_u *dst)
2764 {
2765     int		dlen = 0;
2766 
2767     // Put the appropriate modifier in a string
2768     if (modifiers != 0)
2769     {
2770 	dst[dlen++] = K_SPECIAL;
2771 	dst[dlen++] = KS_MODIFIER;
2772 	dst[dlen++] = modifiers;
2773     }
2774 
2775     if (IS_SPECIAL(key))
2776     {
2777 	dst[dlen++] = K_SPECIAL;
2778 	dst[dlen++] = KEY2TERMCAP0(key);
2779 	dst[dlen++] = KEY2TERMCAP1(key);
2780     }
2781     else if (has_mbyte && !keycode)
2782 	dlen += (*mb_char2bytes)(key, dst + dlen);
2783     else if (keycode)
2784 	dlen = (int)(add_char2buf(key, dst + dlen) - dst);
2785     else
2786 	dst[dlen++] = key;
2787 
2788     return dlen;
2789 }
2790 
2791 /*
2792  * Try translating a <> name at (*srcp)[], return the key and modifiers.
2793  * srcp is advanced to after the <> name.
2794  * returns 0 if there is no match.
2795  */
2796     int
2797 find_special_key(
2798     char_u	**srcp,
2799     int		*modp,
2800     int		flags,		// FSK_ values
2801     int		*did_simplify)  // found <C-H> or <A-x>
2802 {
2803     char_u	*last_dash;
2804     char_u	*end_of_name;
2805     char_u	*src;
2806     char_u	*bp;
2807     int		in_string = flags & FSK_IN_STRING;
2808     int		modifiers;
2809     int		bit;
2810     int		key;
2811     uvarnumber_T	n;
2812     int		l;
2813 
2814     src = *srcp;
2815     if (src[0] != '<')
2816 	return 0;
2817     if (src[1] == '*')	    // <*xxx>: do not simplify
2818 	++src;
2819 
2820     // Find end of modifier list
2821     last_dash = src;
2822     for (bp = src + 1; *bp == '-' || vim_isIDc(*bp); bp++)
2823     {
2824 	if (*bp == '-')
2825 	{
2826 	    last_dash = bp;
2827 	    if (bp[1] != NUL)
2828 	    {
2829 		if (has_mbyte)
2830 		    l = mb_ptr2len(bp + 1);
2831 		else
2832 		    l = 1;
2833 		// Anything accepted, like <C-?>.
2834 		// <C-"> or <M-"> are not special in strings as " is
2835 		// the string delimiter. With a backslash it works: <M-\">
2836 		if (!(in_string && bp[1] == '"') && bp[l + 1] == '>')
2837 		    bp += l;
2838 		else if (in_string && bp[1] == '\\' && bp[2] == '"'
2839 							   && bp[3] == '>')
2840 		    bp += 2;
2841 	    }
2842 	}
2843 	if (bp[0] == 't' && bp[1] == '_' && bp[2] && bp[3])
2844 	    bp += 3;	// skip t_xx, xx may be '-' or '>'
2845 	else if (STRNICMP(bp, "char-", 5) == 0)
2846 	{
2847 	    vim_str2nr(bp + 5, NULL, &l, STR2NR_ALL, NULL, NULL, 0, TRUE);
2848 	    if (l == 0)
2849 	    {
2850 		emsg(_(e_invarg));
2851 		return 0;
2852 	    }
2853 	    bp += l + 5;
2854 	    break;
2855 	}
2856     }
2857 
2858     if (*bp == '>')	// found matching '>'
2859     {
2860 	end_of_name = bp + 1;
2861 
2862 	// Which modifiers are given?
2863 	modifiers = 0x0;
2864 	for (bp = src + 1; bp < last_dash; bp++)
2865 	{
2866 	    if (*bp != '-')
2867 	    {
2868 		bit = name_to_mod_mask(*bp);
2869 		if (bit == 0x0)
2870 		    break;	// Illegal modifier name
2871 		modifiers |= bit;
2872 	    }
2873 	}
2874 
2875 	/*
2876 	 * Legal modifier name.
2877 	 */
2878 	if (bp >= last_dash)
2879 	{
2880 	    if (STRNICMP(last_dash + 1, "char-", 5) == 0
2881 						 && VIM_ISDIGIT(last_dash[6]))
2882 	    {
2883 		// <Char-123> or <Char-033> or <Char-0x33>
2884 		vim_str2nr(last_dash + 6, NULL, &l, STR2NR_ALL, NULL,
2885 								  &n, 0, TRUE);
2886 		if (l == 0)
2887 		{
2888 		    emsg(_(e_invarg));
2889 		    return 0;
2890 		}
2891 		key = (int)n;
2892 	    }
2893 	    else
2894 	    {
2895 		int off = 1;
2896 
2897 		// Modifier with single letter, or special key name.
2898 		if (in_string && last_dash[1] == '\\' && last_dash[2] == '"')
2899 		    off = 2;
2900 		if (has_mbyte)
2901 		    l = mb_ptr2len(last_dash + off);
2902 		else
2903 		    l = 1;
2904 		if (modifiers != 0 && last_dash[l + off] == '>')
2905 		    key = PTR2CHAR(last_dash + off);
2906 		else
2907 		{
2908 		    key = get_special_key_code(last_dash + off);
2909 		    if (!(flags & FSK_KEEP_X_KEY))
2910 			key = handle_x_keys(key);
2911 		}
2912 	    }
2913 
2914 	    /*
2915 	     * get_special_key_code() may return NUL for invalid
2916 	     * special key name.
2917 	     */
2918 	    if (key != NUL)
2919 	    {
2920 		/*
2921 		 * Only use a modifier when there is no special key code that
2922 		 * includes the modifier.
2923 		 */
2924 		key = simplify_key(key, &modifiers);
2925 
2926 		if (!(flags & FSK_KEYCODE))
2927 		{
2928 		    // don't want keycode, use single byte code
2929 		    if (key == K_BS)
2930 			key = BS;
2931 		    else if (key == K_DEL || key == K_KDEL)
2932 			key = DEL;
2933 		}
2934 
2935 		// Normal Key with modifier: Try to make a single byte code.
2936 		if (!IS_SPECIAL(key))
2937 		    key = extract_modifiers(key, &modifiers,
2938 					   flags & FSK_SIMPLIFY, did_simplify);
2939 
2940 		*modp = modifiers;
2941 		*srcp = end_of_name;
2942 		return key;
2943 	    }
2944 	}
2945     }
2946     return 0;
2947 }
2948 
2949 
2950 /*
2951  * Some keys are used with Ctrl without Shift and are still expected to be
2952  * mapped as if Shift was pressed:
2953  * CTRL-2 is CTRL-@
2954  * CTRL-6 is CTRL-^
2955  * CTRL-- is CTRL-_
2956  * Also, <C-H> and <C-h> mean the same thing, always use "H".
2957  * Returns the possibly adjusted key.
2958  */
2959     int
2960 may_adjust_key_for_ctrl(int modifiers, int key)
2961 {
2962     if (modifiers & MOD_MASK_CTRL)
2963     {
2964 	if (ASCII_ISALPHA(key))
2965 	    return TOUPPER_ASC(key);
2966 	if (key == '2')
2967 	    return '@';
2968 	if (key == '6')
2969 	    return '^';
2970 	if (key == '-')
2971 	    return '_';
2972     }
2973     return key;
2974 }
2975 
2976 /*
2977  * Some keys already have Shift included, pass them as normal keys.
2978  * When Ctrl is also used <C-H> and <C-S-H> are different, but <C-S-{> should
2979  * be <C-{>.  Same for <C-S-}> and <C-S-|>.
2980  * Also for <A-S-a> and <M-S-a>.
2981  * This includes all printable ASCII characters except numbers and a-z.
2982  */
2983     int
2984 may_remove_shift_modifier(int modifiers, int key)
2985 {
2986     if ((modifiers == MOD_MASK_SHIFT
2987 		|| modifiers == (MOD_MASK_SHIFT | MOD_MASK_ALT)
2988 		|| modifiers == (MOD_MASK_SHIFT | MOD_MASK_META))
2989 	    && ((key >= '!' && key <= '/')
2990 		|| (key >= ':' && key <= 'Z')
2991 		|| (key >= '[' && key <= '`')
2992 		|| (key >= '{' && key <= '~')))
2993 	return modifiers & ~MOD_MASK_SHIFT;
2994 
2995     if (modifiers == (MOD_MASK_SHIFT | MOD_MASK_CTRL)
2996 		&& (key == '{' || key == '}' || key == '|'))
2997 	return modifiers & ~MOD_MASK_SHIFT;
2998 
2999     return modifiers;
3000 }
3001 
3002 /*
3003  * Try to include modifiers in the key.
3004  * Changes "Shift-a" to 'A', "Alt-A" to 0xc0, etc.
3005  * When "simplify" is FALSE don't do Ctrl and Alt.
3006  * When "simplify" is TRUE and Ctrl or Alt is removed from modifiers set
3007  * "did_simplify" when it's not NULL.
3008  */
3009     int
3010 extract_modifiers(int key, int *modp, int simplify, int *did_simplify)
3011 {
3012     int	modifiers = *modp;
3013 
3014 #ifdef MACOS_X
3015     // Command-key really special, no fancynest
3016     if (!(modifiers & MOD_MASK_CMD))
3017 #endif
3018     if ((modifiers & MOD_MASK_SHIFT) && ASCII_ISALPHA(key))
3019     {
3020 	key = TOUPPER_ASC(key);
3021 	// With <C-S-a> we keep the shift modifier.
3022 	// With <S-a>, <A-S-a> and <S-A> we don't keep the shift modifier.
3023 	if (simplify || modifiers == MOD_MASK_SHIFT
3024 		|| modifiers == (MOD_MASK_SHIFT | MOD_MASK_ALT)
3025 		|| modifiers == (MOD_MASK_SHIFT | MOD_MASK_META))
3026 	    modifiers &= ~MOD_MASK_SHIFT;
3027     }
3028 
3029     // <C-H> and <C-h> mean the same thing, always use "H"
3030     if ((modifiers & MOD_MASK_CTRL) && ASCII_ISALPHA(key))
3031 	key = TOUPPER_ASC(key);
3032 
3033     if (simplify && (modifiers & MOD_MASK_CTRL)
3034 #ifdef EBCDIC
3035 	    // TODO: EBCDIC Better use:
3036 	    // && (Ctrl_chr(key) || key == '?')
3037 	    // ???
3038 	    && strchr("?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_", key)
3039 						       != NULL
3040 #else
3041 	    && ((key >= '?' && key <= '_') || ASCII_ISALPHA(key))
3042 #endif
3043 	    )
3044     {
3045 	key = Ctrl_chr(key);
3046 	modifiers &= ~MOD_MASK_CTRL;
3047 	// <C-@> is <Nul>
3048 	if (key == 0)
3049 	    key = K_ZERO;
3050 	if (did_simplify != NULL)
3051 	    *did_simplify = TRUE;
3052     }
3053 
3054 #ifdef MACOS_X
3055     // Command-key really special, no fancynest
3056     if (!(modifiers & MOD_MASK_CMD))
3057 #endif
3058     if (simplify && (modifiers & MOD_MASK_ALT) && key < 0x80
3059 	    && !enc_dbcs)		// avoid creating a lead byte
3060     {
3061 	key |= 0x80;
3062 	modifiers &= ~MOD_MASK_ALT;	// remove the META modifier
3063 	if (did_simplify != NULL)
3064 	    *did_simplify = TRUE;
3065     }
3066 
3067     *modp = modifiers;
3068     return key;
3069 }
3070 
3071 /*
3072  * Try to find key "c" in the special key table.
3073  * Return the index when found, -1 when not found.
3074  */
3075     int
3076 find_special_key_in_table(int c)
3077 {
3078     int	    i;
3079 
3080     for (i = 0; key_names_table[i].name != NULL; i++)
3081 	if (c == key_names_table[i].key)
3082 	    break;
3083     if (key_names_table[i].name == NULL)
3084 	i = -1;
3085     return i;
3086 }
3087 
3088 /*
3089  * Find the special key with the given name (the given string does not have to
3090  * end with NUL, the name is assumed to end before the first non-idchar).
3091  * If the name starts with "t_" the next two characters are interpreted as a
3092  * termcap name.
3093  * Return the key code, or 0 if not found.
3094  */
3095     int
3096 get_special_key_code(char_u *name)
3097 {
3098     char_u  *table_name;
3099     char_u  string[3];
3100     int	    i, j;
3101 
3102     /*
3103      * If it's <t_xx> we get the code for xx from the termcap
3104      */
3105     if (name[0] == 't' && name[1] == '_' && name[2] != NUL && name[3] != NUL)
3106     {
3107 	string[0] = name[2];
3108 	string[1] = name[3];
3109 	string[2] = NUL;
3110 	if (add_termcap_entry(string, FALSE) == OK)
3111 	    return TERMCAP2KEY(name[2], name[3]);
3112     }
3113     else
3114 	for (i = 0; key_names_table[i].name != NULL; i++)
3115 	{
3116 	    table_name = key_names_table[i].name;
3117 	    for (j = 0; vim_isIDc(name[j]) && table_name[j] != NUL; j++)
3118 		if (TOLOWER_ASC(table_name[j]) != TOLOWER_ASC(name[j]))
3119 		    break;
3120 	    if (!vim_isIDc(name[j]) && table_name[j] == NUL)
3121 		return key_names_table[i].key;
3122 	}
3123     return 0;
3124 }
3125 
3126     char_u *
3127 get_key_name(int i)
3128 {
3129     if (i >= (int)KEY_NAMES_TABLE_LEN)
3130 	return NULL;
3131     return  key_names_table[i].name;
3132 }
3133 
3134 /*
3135  * Return the current end-of-line type: EOL_DOS, EOL_UNIX or EOL_MAC.
3136  */
3137     int
3138 get_fileformat(buf_T *buf)
3139 {
3140     int		c = *buf->b_p_ff;
3141 
3142     if (buf->b_p_bin || c == 'u')
3143 	return EOL_UNIX;
3144     if (c == 'm')
3145 	return EOL_MAC;
3146     return EOL_DOS;
3147 }
3148 
3149 /*
3150  * Like get_fileformat(), but override 'fileformat' with "p" for "++opt=val"
3151  * argument.
3152  */
3153     int
3154 get_fileformat_force(
3155     buf_T	*buf,
3156     exarg_T	*eap)	    // can be NULL!
3157 {
3158     int		c;
3159 
3160     if (eap != NULL && eap->force_ff != 0)
3161 	c = eap->force_ff;
3162     else
3163     {
3164 	if ((eap != NULL && eap->force_bin != 0)
3165 			       ? (eap->force_bin == FORCE_BIN) : buf->b_p_bin)
3166 	    return EOL_UNIX;
3167 	c = *buf->b_p_ff;
3168     }
3169     if (c == 'u')
3170 	return EOL_UNIX;
3171     if (c == 'm')
3172 	return EOL_MAC;
3173     return EOL_DOS;
3174 }
3175 
3176 /*
3177  * Set the current end-of-line type to EOL_DOS, EOL_UNIX or EOL_MAC.
3178  * Sets both 'textmode' and 'fileformat'.
3179  * Note: Does _not_ set global value of 'textmode'!
3180  */
3181     void
3182 set_fileformat(
3183     int		t,
3184     int		opt_flags)	// OPT_LOCAL and/or OPT_GLOBAL
3185 {
3186     char	*p = NULL;
3187 
3188     switch (t)
3189     {
3190     case EOL_DOS:
3191 	p = FF_DOS;
3192 	curbuf->b_p_tx = TRUE;
3193 	break;
3194     case EOL_UNIX:
3195 	p = FF_UNIX;
3196 	curbuf->b_p_tx = FALSE;
3197 	break;
3198     case EOL_MAC:
3199 	p = FF_MAC;
3200 	curbuf->b_p_tx = FALSE;
3201 	break;
3202     }
3203     if (p != NULL)
3204 	set_string_option_direct((char_u *)"ff", -1, (char_u *)p,
3205 						     OPT_FREE | opt_flags, 0);
3206 
3207     // This may cause the buffer to become (un)modified.
3208     check_status(curbuf);
3209     redraw_tabline = TRUE;
3210 #ifdef FEAT_TITLE
3211     need_maketitle = TRUE;	    // set window title later
3212 #endif
3213 }
3214 
3215 /*
3216  * Return the default fileformat from 'fileformats'.
3217  */
3218     int
3219 default_fileformat(void)
3220 {
3221     switch (*p_ffs)
3222     {
3223 	case 'm':   return EOL_MAC;
3224 	case 'd':   return EOL_DOS;
3225     }
3226     return EOL_UNIX;
3227 }
3228 
3229 /*
3230  * Call shell.	Calls mch_call_shell, with 'shellxquote' added.
3231  */
3232     int
3233 call_shell(char_u *cmd, int opt)
3234 {
3235     char_u	*ncmd;
3236     int		retval;
3237 #ifdef FEAT_PROFILE
3238     proftime_T	wait_time;
3239 #endif
3240 
3241     if (p_verbose > 3)
3242     {
3243 	verbose_enter();
3244 	smsg(_("Calling shell to execute: \"%s\""), cmd == NULL ? p_sh : cmd);
3245 	out_char('\n');
3246 	cursor_on();
3247 	verbose_leave();
3248     }
3249 
3250 #ifdef FEAT_PROFILE
3251     if (do_profiling == PROF_YES)
3252 	prof_child_enter(&wait_time);
3253 #endif
3254 
3255     if (*p_sh == NUL)
3256     {
3257 	emsg(_(e_shellempty));
3258 	retval = -1;
3259     }
3260     else
3261     {
3262 #ifdef FEAT_GUI_MSWIN
3263 	// Don't hide the pointer while executing a shell command.
3264 	gui_mch_mousehide(FALSE);
3265 #endif
3266 #ifdef FEAT_GUI
3267 	++hold_gui_events;
3268 #endif
3269 	// The external command may update a tags file, clear cached tags.
3270 	tag_freematch();
3271 
3272 	if (cmd == NULL || *p_sxq == NUL)
3273 	    retval = mch_call_shell(cmd, opt);
3274 	else
3275 	{
3276 	    char_u *ecmd = cmd;
3277 
3278 	    if (*p_sxe != NUL && *p_sxq == '(')
3279 	    {
3280 		ecmd = vim_strsave_escaped_ext(cmd, p_sxe, '^', FALSE);
3281 		if (ecmd == NULL)
3282 		    ecmd = cmd;
3283 	    }
3284 	    ncmd = alloc(STRLEN(ecmd) + STRLEN(p_sxq) * 2 + 1);
3285 	    if (ncmd != NULL)
3286 	    {
3287 		STRCPY(ncmd, p_sxq);
3288 		STRCAT(ncmd, ecmd);
3289 		// When 'shellxquote' is ( append ).
3290 		// When 'shellxquote' is "( append )".
3291 		STRCAT(ncmd, *p_sxq == '(' ? (char_u *)")"
3292 		    : *p_sxq == '"' && *(p_sxq+1) == '(' ? (char_u *)")\""
3293 		    : p_sxq);
3294 		retval = mch_call_shell(ncmd, opt);
3295 		vim_free(ncmd);
3296 	    }
3297 	    else
3298 		retval = -1;
3299 	    if (ecmd != cmd)
3300 		vim_free(ecmd);
3301 	}
3302 #ifdef FEAT_GUI
3303 	--hold_gui_events;
3304 #endif
3305 	/*
3306 	 * Check the window size, in case it changed while executing the
3307 	 * external command.
3308 	 */
3309 	shell_resized_check();
3310     }
3311 
3312 #ifdef FEAT_EVAL
3313     set_vim_var_nr(VV_SHELL_ERROR, (long)retval);
3314 # ifdef FEAT_PROFILE
3315     if (do_profiling == PROF_YES)
3316 	prof_child_exit(&wait_time);
3317 # endif
3318 #endif
3319 
3320     return retval;
3321 }
3322 
3323 /*
3324  * VISUAL, SELECTMODE and OP_PENDING State are never set, they are equal to
3325  * NORMAL State with a condition.  This function returns the real State.
3326  */
3327     int
3328 get_real_state(void)
3329 {
3330     if (State & NORMAL)
3331     {
3332 	if (VIsual_active)
3333 	{
3334 	    if (VIsual_select)
3335 		return SELECTMODE;
3336 	    return VISUAL;
3337 	}
3338 	else if (finish_op)
3339 	    return OP_PENDING;
3340     }
3341     return State;
3342 }
3343 
3344 /*
3345  * Return TRUE if "p" points to just after a path separator.
3346  * Takes care of multi-byte characters.
3347  * "b" must point to the start of the file name
3348  */
3349     int
3350 after_pathsep(char_u *b, char_u *p)
3351 {
3352     return p > b && vim_ispathsep(p[-1])
3353 			     && (!has_mbyte || (*mb_head_off)(b, p - 1) == 0);
3354 }
3355 
3356 /*
3357  * Return TRUE if file names "f1" and "f2" are in the same directory.
3358  * "f1" may be a short name, "f2" must be a full path.
3359  */
3360     int
3361 same_directory(char_u *f1, char_u *f2)
3362 {
3363     char_u	ffname[MAXPATHL];
3364     char_u	*t1;
3365     char_u	*t2;
3366 
3367     // safety check
3368     if (f1 == NULL || f2 == NULL)
3369 	return FALSE;
3370 
3371     (void)vim_FullName(f1, ffname, MAXPATHL, FALSE);
3372     t1 = gettail_sep(ffname);
3373     t2 = gettail_sep(f2);
3374     return (t1 - ffname == t2 - f2
3375 	     && pathcmp((char *)ffname, (char *)f2, (int)(t1 - ffname)) == 0);
3376 }
3377 
3378 #if defined(FEAT_SESSION) || defined(FEAT_AUTOCHDIR) \
3379 	|| defined(MSWIN) || defined(FEAT_GUI_GTK) \
3380 	|| defined(FEAT_NETBEANS_INTG) \
3381 	|| defined(PROTO)
3382 /*
3383  * Change to a file's directory.
3384  * Caller must call shorten_fnames()!
3385  * Return OK or FAIL.
3386  */
3387     int
3388 vim_chdirfile(char_u *fname, char *trigger_autocmd)
3389 {
3390     char_u	old_dir[MAXPATHL];
3391     char_u	new_dir[MAXPATHL];
3392     int		res;
3393 
3394     if (mch_dirname(old_dir, MAXPATHL) != OK)
3395 	*old_dir = NUL;
3396 
3397     vim_strncpy(new_dir, fname, MAXPATHL - 1);
3398     *gettail_sep(new_dir) = NUL;
3399 
3400     if (pathcmp((char *)old_dir, (char *)new_dir, -1) == 0)
3401 	// nothing to do
3402 	res = OK;
3403     else
3404     {
3405 	res = mch_chdir((char *)new_dir) == 0 ? OK : FAIL;
3406 
3407 	if (res == OK && trigger_autocmd != NULL)
3408 	    apply_autocmds(EVENT_DIRCHANGED, (char_u *)trigger_autocmd,
3409 						       new_dir, FALSE, curbuf);
3410     }
3411     return res;
3412 }
3413 #endif
3414 
3415 #if defined(STAT_IGNORES_SLASH) || defined(PROTO)
3416 /*
3417  * Check if "name" ends in a slash and is not a directory.
3418  * Used for systems where stat() ignores a trailing slash on a file name.
3419  * The Vim code assumes a trailing slash is only ignored for a directory.
3420  */
3421     static int
3422 illegal_slash(const char *name)
3423 {
3424     if (name[0] == NUL)
3425 	return FALSE;	    // no file name is not illegal
3426     if (name[strlen(name) - 1] != '/')
3427 	return FALSE;	    // no trailing slash
3428     if (mch_isdir((char_u *)name))
3429 	return FALSE;	    // trailing slash for a directory
3430     return TRUE;
3431 }
3432 
3433 /*
3434  * Special implementation of mch_stat() for Solaris.
3435  */
3436     int
3437 vim_stat(const char *name, stat_T *stp)
3438 {
3439     // On Solaris stat() accepts "file/" as if it was "file".  Return -1 if
3440     // the name ends in "/" and it's not a directory.
3441     return illegal_slash(name) ? -1 : stat(name, stp);
3442 }
3443 #endif
3444 
3445 #if defined(CURSOR_SHAPE) || defined(PROTO)
3446 
3447 /*
3448  * Handling of cursor and mouse pointer shapes in various modes.
3449  */
3450 
3451 cursorentry_T shape_table[SHAPE_IDX_COUNT] =
3452 {
3453     // The values will be filled in from the 'guicursor' and 'mouseshape'
3454     // defaults when Vim starts.
3455     // Adjust the SHAPE_IDX_ defines when making changes!
3456     {0,	0, 0, 700L, 400L, 250L, 0, 0, "n", SHAPE_CURSOR+SHAPE_MOUSE},
3457     {0,	0, 0, 700L, 400L, 250L, 0, 0, "v", SHAPE_CURSOR+SHAPE_MOUSE},
3458     {0,	0, 0, 700L, 400L, 250L, 0, 0, "i", SHAPE_CURSOR+SHAPE_MOUSE},
3459     {0,	0, 0, 700L, 400L, 250L, 0, 0, "r", SHAPE_CURSOR+SHAPE_MOUSE},
3460     {0,	0, 0, 700L, 400L, 250L, 0, 0, "c", SHAPE_CURSOR+SHAPE_MOUSE},
3461     {0,	0, 0, 700L, 400L, 250L, 0, 0, "ci", SHAPE_CURSOR+SHAPE_MOUSE},
3462     {0,	0, 0, 700L, 400L, 250L, 0, 0, "cr", SHAPE_CURSOR+SHAPE_MOUSE},
3463     {0,	0, 0, 700L, 400L, 250L, 0, 0, "o", SHAPE_CURSOR+SHAPE_MOUSE},
3464     {0,	0, 0, 700L, 400L, 250L, 0, 0, "ve", SHAPE_CURSOR+SHAPE_MOUSE},
3465     {0,	0, 0,   0L,   0L,   0L, 0, 0, "e", SHAPE_MOUSE},
3466     {0,	0, 0,   0L,   0L,   0L, 0, 0, "s", SHAPE_MOUSE},
3467     {0,	0, 0,   0L,   0L,   0L, 0, 0, "sd", SHAPE_MOUSE},
3468     {0,	0, 0,   0L,   0L,   0L, 0, 0, "vs", SHAPE_MOUSE},
3469     {0,	0, 0,   0L,   0L,   0L, 0, 0, "vd", SHAPE_MOUSE},
3470     {0,	0, 0,   0L,   0L,   0L, 0, 0, "m", SHAPE_MOUSE},
3471     {0,	0, 0,   0L,   0L,   0L, 0, 0, "ml", SHAPE_MOUSE},
3472     {0,	0, 0, 100L, 100L, 100L, 0, 0, "sm", SHAPE_CURSOR},
3473 };
3474 
3475 #ifdef FEAT_MOUSESHAPE
3476 /*
3477  * Table with names for mouse shapes.  Keep in sync with all the tables for
3478  * mch_set_mouse_shape()!.
3479  */
3480 static char * mshape_names[] =
3481 {
3482     "arrow",	// default, must be the first one
3483     "blank",	// hidden
3484     "beam",
3485     "updown",
3486     "udsizing",
3487     "leftright",
3488     "lrsizing",
3489     "busy",
3490     "no",
3491     "crosshair",
3492     "hand1",
3493     "hand2",
3494     "pencil",
3495     "question",
3496     "rightup-arrow",
3497     "up-arrow",
3498     NULL
3499 };
3500 #endif
3501 
3502 /*
3503  * Parse the 'guicursor' option ("what" is SHAPE_CURSOR) or 'mouseshape'
3504  * ("what" is SHAPE_MOUSE).
3505  * Returns error message for an illegal option, NULL otherwise.
3506  */
3507     char *
3508 parse_shape_opt(int what)
3509 {
3510     char_u	*modep;
3511     char_u	*colonp;
3512     char_u	*commap;
3513     char_u	*slashp;
3514     char_u	*p, *endp;
3515     int		idx = 0;		// init for GCC
3516     int		all_idx;
3517     int		len;
3518     int		i;
3519     long	n;
3520     int		found_ve = FALSE;	// found "ve" flag
3521     int		round;
3522 
3523     /*
3524      * First round: check for errors; second round: do it for real.
3525      */
3526     for (round = 1; round <= 2; ++round)
3527     {
3528 	/*
3529 	 * Repeat for all comma separated parts.
3530 	 */
3531 #ifdef FEAT_MOUSESHAPE
3532 	if (what == SHAPE_MOUSE)
3533 	    modep = p_mouseshape;
3534 	else
3535 #endif
3536 	    modep = p_guicursor;
3537 	while (*modep != NUL)
3538 	{
3539 	    colonp = vim_strchr(modep, ':');
3540 	    commap = vim_strchr(modep, ',');
3541 
3542 	    if (colonp == NULL || (commap != NULL && commap < colonp))
3543 		return N_("E545: Missing colon");
3544 	    if (colonp == modep)
3545 		return N_("E546: Illegal mode");
3546 
3547 	    /*
3548 	     * Repeat for all mode's before the colon.
3549 	     * For the 'a' mode, we loop to handle all the modes.
3550 	     */
3551 	    all_idx = -1;
3552 	    while (modep < colonp || all_idx >= 0)
3553 	    {
3554 		if (all_idx < 0)
3555 		{
3556 		    // Find the mode.
3557 		    if (modep[1] == '-' || modep[1] == ':')
3558 			len = 1;
3559 		    else
3560 			len = 2;
3561 		    if (len == 1 && TOLOWER_ASC(modep[0]) == 'a')
3562 			all_idx = SHAPE_IDX_COUNT - 1;
3563 		    else
3564 		    {
3565 			for (idx = 0; idx < SHAPE_IDX_COUNT; ++idx)
3566 			    if (STRNICMP(modep, shape_table[idx].name, len)
3567 									 == 0)
3568 				break;
3569 			if (idx == SHAPE_IDX_COUNT
3570 				   || (shape_table[idx].used_for & what) == 0)
3571 			    return N_("E546: Illegal mode");
3572 			if (len == 2 && modep[0] == 'v' && modep[1] == 'e')
3573 			    found_ve = TRUE;
3574 		    }
3575 		    modep += len + 1;
3576 		}
3577 
3578 		if (all_idx >= 0)
3579 		    idx = all_idx--;
3580 		else if (round == 2)
3581 		{
3582 #ifdef FEAT_MOUSESHAPE
3583 		    if (what == SHAPE_MOUSE)
3584 		    {
3585 			// Set the default, for the missing parts
3586 			shape_table[idx].mshape = 0;
3587 		    }
3588 		    else
3589 #endif
3590 		    {
3591 			// Set the defaults, for the missing parts
3592 			shape_table[idx].shape = SHAPE_BLOCK;
3593 			shape_table[idx].blinkwait = 700L;
3594 			shape_table[idx].blinkon = 400L;
3595 			shape_table[idx].blinkoff = 250L;
3596 		    }
3597 		}
3598 
3599 		// Parse the part after the colon
3600 		for (p = colonp + 1; *p && *p != ','; )
3601 		{
3602 #ifdef FEAT_MOUSESHAPE
3603 		    if (what == SHAPE_MOUSE)
3604 		    {
3605 			for (i = 0; ; ++i)
3606 			{
3607 			    if (mshape_names[i] == NULL)
3608 			    {
3609 				if (!VIM_ISDIGIT(*p))
3610 				    return N_("E547: Illegal mouseshape");
3611 				if (round == 2)
3612 				    shape_table[idx].mshape =
3613 					      getdigits(&p) + MSHAPE_NUMBERED;
3614 				else
3615 				    (void)getdigits(&p);
3616 				break;
3617 			    }
3618 			    len = (int)STRLEN(mshape_names[i]);
3619 			    if (STRNICMP(p, mshape_names[i], len) == 0)
3620 			    {
3621 				if (round == 2)
3622 				    shape_table[idx].mshape = i;
3623 				p += len;
3624 				break;
3625 			    }
3626 			}
3627 		    }
3628 		    else // if (what == SHAPE_MOUSE)
3629 #endif
3630 		    {
3631 			/*
3632 			 * First handle the ones with a number argument.
3633 			 */
3634 			i = *p;
3635 			len = 0;
3636 			if (STRNICMP(p, "ver", 3) == 0)
3637 			    len = 3;
3638 			else if (STRNICMP(p, "hor", 3) == 0)
3639 			    len = 3;
3640 			else if (STRNICMP(p, "blinkwait", 9) == 0)
3641 			    len = 9;
3642 			else if (STRNICMP(p, "blinkon", 7) == 0)
3643 			    len = 7;
3644 			else if (STRNICMP(p, "blinkoff", 8) == 0)
3645 			    len = 8;
3646 			if (len != 0)
3647 			{
3648 			    p += len;
3649 			    if (!VIM_ISDIGIT(*p))
3650 				return N_("E548: digit expected");
3651 			    n = getdigits(&p);
3652 			    if (len == 3)   // "ver" or "hor"
3653 			    {
3654 				if (n == 0)
3655 				    return N_("E549: Illegal percentage");
3656 				if (round == 2)
3657 				{
3658 				    if (TOLOWER_ASC(i) == 'v')
3659 					shape_table[idx].shape = SHAPE_VER;
3660 				    else
3661 					shape_table[idx].shape = SHAPE_HOR;
3662 				    shape_table[idx].percentage = n;
3663 				}
3664 			    }
3665 			    else if (round == 2)
3666 			    {
3667 				if (len == 9)
3668 				    shape_table[idx].blinkwait = n;
3669 				else if (len == 7)
3670 				    shape_table[idx].blinkon = n;
3671 				else
3672 				    shape_table[idx].blinkoff = n;
3673 			    }
3674 			}
3675 			else if (STRNICMP(p, "block", 5) == 0)
3676 			{
3677 			    if (round == 2)
3678 				shape_table[idx].shape = SHAPE_BLOCK;
3679 			    p += 5;
3680 			}
3681 			else	// must be a highlight group name then
3682 			{
3683 			    endp = vim_strchr(p, '-');
3684 			    if (commap == NULL)		    // last part
3685 			    {
3686 				if (endp == NULL)
3687 				    endp = p + STRLEN(p);   // find end of part
3688 			    }
3689 			    else if (endp > commap || endp == NULL)
3690 				endp = commap;
3691 			    slashp = vim_strchr(p, '/');
3692 			    if (slashp != NULL && slashp < endp)
3693 			    {
3694 				// "group/langmap_group"
3695 				i = syn_check_group(p, (int)(slashp - p));
3696 				p = slashp + 1;
3697 			    }
3698 			    if (round == 2)
3699 			    {
3700 				shape_table[idx].id = syn_check_group(p,
3701 							     (int)(endp - p));
3702 				shape_table[idx].id_lm = shape_table[idx].id;
3703 				if (slashp != NULL && slashp < endp)
3704 				    shape_table[idx].id = i;
3705 			    }
3706 			    p = endp;
3707 			}
3708 		    } // if (what != SHAPE_MOUSE)
3709 
3710 		    if (*p == '-')
3711 			++p;
3712 		}
3713 	    }
3714 	    modep = p;
3715 	    if (*modep == ',')
3716 		++modep;
3717 	}
3718     }
3719 
3720     // If the 's' flag is not given, use the 'v' cursor for 's'
3721     if (!found_ve)
3722     {
3723 #ifdef FEAT_MOUSESHAPE
3724 	if (what == SHAPE_MOUSE)
3725 	{
3726 	    shape_table[SHAPE_IDX_VE].mshape = shape_table[SHAPE_IDX_V].mshape;
3727 	}
3728 	else
3729 #endif
3730 	{
3731 	    shape_table[SHAPE_IDX_VE].shape = shape_table[SHAPE_IDX_V].shape;
3732 	    shape_table[SHAPE_IDX_VE].percentage =
3733 					 shape_table[SHAPE_IDX_V].percentage;
3734 	    shape_table[SHAPE_IDX_VE].blinkwait =
3735 					  shape_table[SHAPE_IDX_V].blinkwait;
3736 	    shape_table[SHAPE_IDX_VE].blinkon =
3737 					    shape_table[SHAPE_IDX_V].blinkon;
3738 	    shape_table[SHAPE_IDX_VE].blinkoff =
3739 					   shape_table[SHAPE_IDX_V].blinkoff;
3740 	    shape_table[SHAPE_IDX_VE].id = shape_table[SHAPE_IDX_V].id;
3741 	    shape_table[SHAPE_IDX_VE].id_lm = shape_table[SHAPE_IDX_V].id_lm;
3742 	}
3743     }
3744 
3745     return NULL;
3746 }
3747 
3748 # if defined(MCH_CURSOR_SHAPE) || defined(FEAT_GUI) \
3749 	|| defined(FEAT_MOUSESHAPE) || defined(PROTO)
3750 /*
3751  * Return the index into shape_table[] for the current mode.
3752  * When "mouse" is TRUE, consider indexes valid for the mouse pointer.
3753  */
3754     int
3755 get_shape_idx(int mouse)
3756 {
3757 #ifdef FEAT_MOUSESHAPE
3758     if (mouse && (State == HITRETURN || State == ASKMORE))
3759     {
3760 # ifdef FEAT_GUI
3761 	int x, y;
3762 	gui_mch_getmouse(&x, &y);
3763 	if (Y_2_ROW(y) == Rows - 1)
3764 	    return SHAPE_IDX_MOREL;
3765 # endif
3766 	return SHAPE_IDX_MORE;
3767     }
3768     if (mouse && drag_status_line)
3769 	return SHAPE_IDX_SDRAG;
3770     if (mouse && drag_sep_line)
3771 	return SHAPE_IDX_VDRAG;
3772 #endif
3773     if (!mouse && State == SHOWMATCH)
3774 	return SHAPE_IDX_SM;
3775     if (State & VREPLACE_FLAG)
3776 	return SHAPE_IDX_R;
3777     if (State & REPLACE_FLAG)
3778 	return SHAPE_IDX_R;
3779     if (State & INSERT)
3780 	return SHAPE_IDX_I;
3781     if (State & CMDLINE)
3782     {
3783 	if (cmdline_at_end())
3784 	    return SHAPE_IDX_C;
3785 	if (cmdline_overstrike())
3786 	    return SHAPE_IDX_CR;
3787 	return SHAPE_IDX_CI;
3788     }
3789     if (finish_op)
3790 	return SHAPE_IDX_O;
3791     if (VIsual_active)
3792     {
3793 	if (*p_sel == 'e')
3794 	    return SHAPE_IDX_VE;
3795 	else
3796 	    return SHAPE_IDX_V;
3797     }
3798     return SHAPE_IDX_N;
3799 }
3800 #endif
3801 
3802 # if defined(FEAT_MOUSESHAPE) || defined(PROTO)
3803 static int old_mouse_shape = 0;
3804 
3805 /*
3806  * Set the mouse shape:
3807  * If "shape" is -1, use shape depending on the current mode,
3808  * depending on the current state.
3809  * If "shape" is -2, only update the shape when it's CLINE or STATUS (used
3810  * when the mouse moves off the status or command line).
3811  */
3812     void
3813 update_mouseshape(int shape_idx)
3814 {
3815     int new_mouse_shape;
3816 
3817     // Only works in GUI mode.
3818     if (!gui.in_use || gui.starting)
3819 	return;
3820 
3821     // Postpone the updating when more is to come.  Speeds up executing of
3822     // mappings.
3823     if (shape_idx == -1 && char_avail())
3824     {
3825 	postponed_mouseshape = TRUE;
3826 	return;
3827     }
3828 
3829     // When ignoring the mouse don't change shape on the statusline.
3830     if (*p_mouse == NUL
3831 	    && (shape_idx == SHAPE_IDX_CLINE
3832 		|| shape_idx == SHAPE_IDX_STATUS
3833 		|| shape_idx == SHAPE_IDX_VSEP))
3834 	shape_idx = -2;
3835 
3836     if (shape_idx == -2
3837 	    && old_mouse_shape != shape_table[SHAPE_IDX_CLINE].mshape
3838 	    && old_mouse_shape != shape_table[SHAPE_IDX_STATUS].mshape
3839 	    && old_mouse_shape != shape_table[SHAPE_IDX_VSEP].mshape)
3840 	return;
3841     if (shape_idx < 0)
3842 	new_mouse_shape = shape_table[get_shape_idx(TRUE)].mshape;
3843     else
3844 	new_mouse_shape = shape_table[shape_idx].mshape;
3845     if (new_mouse_shape != old_mouse_shape)
3846     {
3847 	mch_set_mouse_shape(new_mouse_shape);
3848 	old_mouse_shape = new_mouse_shape;
3849     }
3850     postponed_mouseshape = FALSE;
3851 }
3852 # endif
3853 
3854 #endif // CURSOR_SHAPE
3855 
3856 
3857 /*
3858  * Change directory to "new_dir".  If FEAT_SEARCHPATH is defined, search
3859  * 'cdpath' for relative directory names, otherwise just mch_chdir().
3860  */
3861     int
3862 vim_chdir(char_u *new_dir)
3863 {
3864 #ifndef FEAT_SEARCHPATH
3865     return mch_chdir((char *)new_dir);
3866 #else
3867     char_u	*dir_name;
3868     int		r;
3869 
3870     dir_name = find_directory_in_path(new_dir, (int)STRLEN(new_dir),
3871 						FNAME_MESS, curbuf->b_ffname);
3872     if (dir_name == NULL)
3873 	return -1;
3874     r = mch_chdir((char *)dir_name);
3875     vim_free(dir_name);
3876     return r;
3877 #endif
3878 }
3879 
3880 /*
3881  * Get user name from machine-specific function.
3882  * Returns the user name in "buf[len]".
3883  * Some systems are quite slow in obtaining the user name (Windows NT), thus
3884  * cache the result.
3885  * Returns OK or FAIL.
3886  */
3887     int
3888 get_user_name(char_u *buf, int len)
3889 {
3890     if (username == NULL)
3891     {
3892 	if (mch_get_user_name(buf, len) == FAIL)
3893 	    return FAIL;
3894 	username = vim_strsave(buf);
3895     }
3896     else
3897 	vim_strncpy(buf, username, len - 1);
3898     return OK;
3899 }
3900 
3901 #ifndef HAVE_QSORT
3902 /*
3903  * Our own qsort(), for systems that don't have it.
3904  * It's simple and slow.  From the K&R C book.
3905  */
3906     void
3907 qsort(
3908     void	*base,
3909     size_t	elm_count,
3910     size_t	elm_size,
3911     int (*cmp)(const void *, const void *))
3912 {
3913     char_u	*buf;
3914     char_u	*p1;
3915     char_u	*p2;
3916     int		i, j;
3917     int		gap;
3918 
3919     buf = alloc(elm_size);
3920     if (buf == NULL)
3921 	return;
3922 
3923     for (gap = elm_count / 2; gap > 0; gap /= 2)
3924 	for (i = gap; i < elm_count; ++i)
3925 	    for (j = i - gap; j >= 0; j -= gap)
3926 	    {
3927 		// Compare the elements.
3928 		p1 = (char_u *)base + j * elm_size;
3929 		p2 = (char_u *)base + (j + gap) * elm_size;
3930 		if ((*cmp)((void *)p1, (void *)p2) <= 0)
3931 		    break;
3932 		// Exchange the elements.
3933 		mch_memmove(buf, p1, elm_size);
3934 		mch_memmove(p1, p2, elm_size);
3935 		mch_memmove(p2, buf, elm_size);
3936 	    }
3937 
3938     vim_free(buf);
3939 }
3940 #endif
3941 
3942 /*
3943  * Sort an array of strings.
3944  */
3945 static int sort_compare(const void *s1, const void *s2);
3946 
3947     static int
3948 sort_compare(const void *s1, const void *s2)
3949 {
3950     return STRCMP(*(char **)s1, *(char **)s2);
3951 }
3952 
3953     void
3954 sort_strings(
3955     char_u	**files,
3956     int		count)
3957 {
3958     qsort((void *)files, (size_t)count, sizeof(char_u *), sort_compare);
3959 }
3960 
3961 /*
3962  * The putenv() implementation below comes from the "screen" program.
3963  * Included with permission from Juergen Weigert.
3964  * See pty.c for the copyright notice.
3965  */
3966 
3967 /*
3968  *  putenv  --	put value into environment
3969  *
3970  *  Usage:  i = putenv (string)
3971  *    int i;
3972  *    char  *string;
3973  *
3974  *  where string is of the form <name>=<value>.
3975  *  Putenv returns 0 normally, -1 on error (not enough core for malloc).
3976  *
3977  *  Putenv may need to add a new name into the environment, or to
3978  *  associate a value longer than the current value with a particular
3979  *  name.  So, to make life simpler, putenv() copies your entire
3980  *  environment into the heap (i.e. malloc()) from the stack
3981  *  (i.e. where it resides when your process is initiated) the first
3982  *  time you call it.
3983  *
3984  *  (history removed, not very interesting.  See the "screen" sources.)
3985  */
3986 
3987 #if !defined(HAVE_SETENV) && !defined(HAVE_PUTENV)
3988 
3989 #define EXTRASIZE 5		// increment to add to env. size
3990 
3991 static int  envsize = -1;	// current size of environment
3992 extern char **environ;		// the global which is your env.
3993 
3994 static int  findenv(char *name); // look for a name in the env.
3995 static int  newenv(void);	// copy env. from stack to heap
3996 static int  moreenv(void);	// incr. size of env.
3997 
3998     int
3999 putenv(const char *string)
4000 {
4001     int	    i;
4002     char    *p;
4003 
4004     if (envsize < 0)
4005     {				// first time putenv called
4006 	if (newenv() < 0)	// copy env. to heap
4007 	    return -1;
4008     }
4009 
4010     i = findenv((char *)string); // look for name in environment
4011 
4012     if (i < 0)
4013     {				// name must be added
4014 	for (i = 0; environ[i]; i++);
4015 	if (i >= (envsize - 1))
4016 	{			// need new slot
4017 	    if (moreenv() < 0)
4018 		return -1;
4019 	}
4020 	p = alloc(strlen(string) + 1);
4021 	if (p == NULL)		// not enough core
4022 	    return -1;
4023 	environ[i + 1] = 0;	// new end of env.
4024     }
4025     else
4026     {				// name already in env.
4027 	p = vim_realloc(environ[i], strlen(string) + 1);
4028 	if (p == NULL)
4029 	    return -1;
4030     }
4031     sprintf(p, "%s", string);	// copy into env.
4032     environ[i] = p;
4033 
4034     return 0;
4035 }
4036 
4037     static int
4038 findenv(char *name)
4039 {
4040     char    *namechar, *envchar;
4041     int	    i, found;
4042 
4043     found = 0;
4044     for (i = 0; environ[i] && !found; i++)
4045     {
4046 	envchar = environ[i];
4047 	namechar = name;
4048 	while (*namechar && *namechar != '=' && (*namechar == *envchar))
4049 	{
4050 	    namechar++;
4051 	    envchar++;
4052 	}
4053 	found = ((*namechar == '\0' || *namechar == '=') && *envchar == '=');
4054     }
4055     return found ? i - 1 : -1;
4056 }
4057 
4058     static int
4059 newenv(void)
4060 {
4061     char    **env, *elem;
4062     int	    i, esize;
4063 
4064     for (i = 0; environ[i]; i++)
4065 	;
4066 
4067     esize = i + EXTRASIZE + 1;
4068     env = ALLOC_MULT(char *, esize);
4069     if (env == NULL)
4070 	return -1;
4071 
4072     for (i = 0; environ[i]; i++)
4073     {
4074 	elem = alloc(strlen(environ[i]) + 1);
4075 	if (elem == NULL)
4076 	    return -1;
4077 	env[i] = elem;
4078 	strcpy(elem, environ[i]);
4079     }
4080 
4081     env[i] = 0;
4082     environ = env;
4083     envsize = esize;
4084     return 0;
4085 }
4086 
4087     static int
4088 moreenv(void)
4089 {
4090     int	    esize;
4091     char    **env;
4092 
4093     esize = envsize + EXTRASIZE;
4094     env = vim_realloc((char *)environ, esize * sizeof (*env));
4095     if (env == 0)
4096 	return -1;
4097     environ = env;
4098     envsize = esize;
4099     return 0;
4100 }
4101 
4102 # ifdef USE_VIMPTY_GETENV
4103 /*
4104  * Used for mch_getenv() for Mac.
4105  */
4106     char_u *
4107 vimpty_getenv(const char_u *string)
4108 {
4109     int i;
4110     char_u *p;
4111 
4112     if (envsize < 0)
4113 	return NULL;
4114 
4115     i = findenv((char *)string);
4116 
4117     if (i < 0)
4118 	return NULL;
4119 
4120     p = vim_strchr((char_u *)environ[i], '=');
4121     return (p + 1);
4122 }
4123 # endif
4124 
4125 #endif // !defined(HAVE_SETENV) && !defined(HAVE_PUTENV)
4126 
4127 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
4128 /*
4129  * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
4130  * rights to write into.
4131  */
4132     int
4133 filewritable(char_u *fname)
4134 {
4135     int		retval = 0;
4136 #if defined(UNIX) || defined(VMS)
4137     int		perm = 0;
4138 #endif
4139 
4140 #if defined(UNIX) || defined(VMS)
4141     perm = mch_getperm(fname);
4142 #endif
4143     if (
4144 # ifdef MSWIN
4145 	    mch_writable(fname) &&
4146 # else
4147 # if defined(UNIX) || defined(VMS)
4148 	    (perm & 0222) &&
4149 #  endif
4150 # endif
4151 	    mch_access((char *)fname, W_OK) == 0
4152        )
4153     {
4154 	++retval;
4155 	if (mch_isdir(fname))
4156 	    ++retval;
4157     }
4158     return retval;
4159 }
4160 #endif
4161 
4162 #if defined(FEAT_SPELL) || defined(FEAT_PERSISTENT_UNDO) || defined(PROTO)
4163 /*
4164  * Read 2 bytes from "fd" and turn them into an int, MSB first.
4165  * Returns -1 when encountering EOF.
4166  */
4167     int
4168 get2c(FILE *fd)
4169 {
4170     int		c, n;
4171 
4172     n = getc(fd);
4173     if (n == EOF) return -1;
4174     c = getc(fd);
4175     if (c == EOF) return -1;
4176     return (n << 8) + c;
4177 }
4178 
4179 /*
4180  * Read 3 bytes from "fd" and turn them into an int, MSB first.
4181  * Returns -1 when encountering EOF.
4182  */
4183     int
4184 get3c(FILE *fd)
4185 {
4186     int		c, n;
4187 
4188     n = getc(fd);
4189     if (n == EOF) return -1;
4190     c = getc(fd);
4191     if (c == EOF) return -1;
4192     n = (n << 8) + c;
4193     c = getc(fd);
4194     if (c == EOF) return -1;
4195     return (n << 8) + c;
4196 }
4197 
4198 /*
4199  * Read 4 bytes from "fd" and turn them into an int, MSB first.
4200  * Returns -1 when encountering EOF.
4201  */
4202     int
4203 get4c(FILE *fd)
4204 {
4205     int		c;
4206     // Use unsigned rather than int otherwise result is undefined
4207     // when left-shift sets the MSB.
4208     unsigned	n;
4209 
4210     c = getc(fd);
4211     if (c == EOF) return -1;
4212     n = (unsigned)c;
4213     c = getc(fd);
4214     if (c == EOF) return -1;
4215     n = (n << 8) + (unsigned)c;
4216     c = getc(fd);
4217     if (c == EOF) return -1;
4218     n = (n << 8) + (unsigned)c;
4219     c = getc(fd);
4220     if (c == EOF) return -1;
4221     n = (n << 8) + (unsigned)c;
4222     return (int)n;
4223 }
4224 
4225 /*
4226  * Read a string of length "cnt" from "fd" into allocated memory.
4227  * Returns NULL when out of memory or unable to read that many bytes.
4228  */
4229     char_u *
4230 read_string(FILE *fd, int cnt)
4231 {
4232     char_u	*str;
4233     int		i;
4234     int		c;
4235 
4236     // allocate memory
4237     str = alloc(cnt + 1);
4238     if (str != NULL)
4239     {
4240 	// Read the string.  Quit when running into the EOF.
4241 	for (i = 0; i < cnt; ++i)
4242 	{
4243 	    c = getc(fd);
4244 	    if (c == EOF)
4245 	    {
4246 		vim_free(str);
4247 		return NULL;
4248 	    }
4249 	    str[i] = c;
4250 	}
4251 	str[i] = NUL;
4252     }
4253     return str;
4254 }
4255 
4256 /*
4257  * Write a number to file "fd", MSB first, in "len" bytes.
4258  */
4259     int
4260 put_bytes(FILE *fd, long_u nr, int len)
4261 {
4262     int	    i;
4263 
4264     for (i = len - 1; i >= 0; --i)
4265 	if (putc((int)(nr >> (i * 8)), fd) == EOF)
4266 	    return FAIL;
4267     return OK;
4268 }
4269 
4270 #endif
4271 
4272 #if defined(FEAT_QUICKFIX) || defined(FEAT_SPELL) || defined(PROTO)
4273 /*
4274  * Return TRUE if string "s" contains a non-ASCII character (128 or higher).
4275  * When "s" is NULL FALSE is returned.
4276  */
4277     int
4278 has_non_ascii(char_u *s)
4279 {
4280     char_u	*p;
4281 
4282     if (s != NULL)
4283 	for (p = s; *p != NUL; ++p)
4284 	    if (*p >= 128)
4285 		return TRUE;
4286     return FALSE;
4287 }
4288 #endif
4289 
4290 #ifndef PROTO  // proto is defined in vim.h
4291 # ifdef ELAPSED_TIMEVAL
4292 /*
4293  * Return time in msec since "start_tv".
4294  */
4295     long
4296 elapsed(struct timeval *start_tv)
4297 {
4298     struct timeval  now_tv;
4299 
4300     gettimeofday(&now_tv, NULL);
4301     return (now_tv.tv_sec - start_tv->tv_sec) * 1000L
4302 	 + (now_tv.tv_usec - start_tv->tv_usec) / 1000L;
4303 }
4304 # endif
4305 
4306 # ifdef ELAPSED_TICKCOUNT
4307 /*
4308  * Return time in msec since "start_tick".
4309  */
4310     long
4311 elapsed(DWORD start_tick)
4312 {
4313     DWORD	now = GetTickCount();
4314 
4315     return (long)now - (long)start_tick;
4316 }
4317 # endif
4318 #endif
4319 
4320 #if defined(FEAT_JOB_CHANNEL) \
4321 	|| (defined(UNIX) && (!defined(USE_SYSTEM) \
4322 	|| (defined(FEAT_GUI) && defined(FEAT_TERMINAL)))) \
4323 	|| defined(PROTO)
4324 /*
4325  * Parse "cmd" and put the white-separated parts in "argv".
4326  * "argv" is an allocated array with "argc" entries and room for 4 more.
4327  * Returns FAIL when out of memory.
4328  */
4329     int
4330 mch_parse_cmd(char_u *cmd, int use_shcf, char ***argv, int *argc)
4331 {
4332     int		i;
4333     char_u	*p, *d;
4334     int		inquote;
4335 
4336     /*
4337      * Do this loop twice:
4338      * 1: find number of arguments
4339      * 2: separate them and build argv[]
4340      */
4341     for (i = 1; i <= 2; ++i)
4342     {
4343 	p = skipwhite(cmd);
4344 	inquote = FALSE;
4345 	*argc = 0;
4346 	while (*p != NUL)
4347 	{
4348 	    if (i == 2)
4349 		(*argv)[*argc] = (char *)p;
4350 	    ++*argc;
4351 	    d = p;
4352 	    while (*p != NUL && (inquote || (*p != ' ' && *p != TAB)))
4353 	    {
4354 		if (p[0] == '"')
4355 		    // quotes surrounding an argument and are dropped
4356 		    inquote = !inquote;
4357 		else
4358 		{
4359 		    if (rem_backslash(p))
4360 		    {
4361 			// First pass: skip over "\ " and "\"".
4362 			// Second pass: Remove the backslash.
4363 			++p;
4364 		    }
4365 		    if (i == 2)
4366 			*d++ = *p;
4367 		}
4368 		++p;
4369 	    }
4370 	    if (*p == NUL)
4371 	    {
4372 		if (i == 2)
4373 		    *d++ = NUL;
4374 		break;
4375 	    }
4376 	    if (i == 2)
4377 		*d++ = NUL;
4378 	    p = skipwhite(p + 1);
4379 	}
4380 	if (*argv == NULL)
4381 	{
4382 	    if (use_shcf)
4383 	    {
4384 		// Account for possible multiple args in p_shcf.
4385 		p = p_shcf;
4386 		for (;;)
4387 		{
4388 		    p = skiptowhite(p);
4389 		    if (*p == NUL)
4390 			break;
4391 		    ++*argc;
4392 		    p = skipwhite(p);
4393 		}
4394 	    }
4395 
4396 	    *argv = ALLOC_MULT(char *, *argc + 4);
4397 	    if (*argv == NULL)	    // out of memory
4398 		return FAIL;
4399 	}
4400     }
4401     return OK;
4402 }
4403 
4404 # if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
4405 /*
4406  * Build "argv[argc]" from the string "cmd".
4407  * "argv[argc]" is set to NULL;
4408  * Return FAIL when out of memory.
4409  */
4410     int
4411 build_argv_from_string(char_u *cmd, char ***argv, int *argc)
4412 {
4413     char_u	*cmd_copy;
4414     int		i;
4415 
4416     // Make a copy, parsing will modify "cmd".
4417     cmd_copy = vim_strsave(cmd);
4418     if (cmd_copy == NULL
4419 	    || mch_parse_cmd(cmd_copy, FALSE, argv, argc) == FAIL)
4420     {
4421 	vim_free(cmd_copy);
4422 	return FAIL;
4423     }
4424     for (i = 0; i < *argc; i++)
4425 	(*argv)[i] = (char *)vim_strsave((char_u *)(*argv)[i]);
4426     (*argv)[*argc] = NULL;
4427     vim_free(cmd_copy);
4428     return OK;
4429 }
4430 
4431 /*
4432  * Build "argv[argc]" from the list "l".
4433  * "argv[argc]" is set to NULL;
4434  * Return FAIL when out of memory.
4435  */
4436     int
4437 build_argv_from_list(list_T *l, char ***argv, int *argc)
4438 {
4439     listitem_T  *li;
4440     char_u	*s;
4441 
4442     // Pass argv[] to mch_call_shell().
4443     *argv = ALLOC_MULT(char *, l->lv_len + 1);
4444     if (*argv == NULL)
4445 	return FAIL;
4446     *argc = 0;
4447     FOR_ALL_LIST_ITEMS(l, li)
4448     {
4449 	s = tv_get_string_chk(&li->li_tv);
4450 	if (s == NULL)
4451 	{
4452 	    int i;
4453 
4454 	    for (i = 0; i < *argc; ++i)
4455 		VIM_CLEAR((*argv)[i]);
4456 	    return FAIL;
4457 	}
4458 	(*argv)[*argc] = (char *)vim_strsave(s);
4459 	*argc += 1;
4460     }
4461     (*argv)[*argc] = NULL;
4462     return OK;
4463 }
4464 # endif
4465 #endif
4466 
4467 /*
4468  * Change the behavior of vterm.
4469  * 0: As usual.
4470  * 1: Windows 10 version 1809
4471  *      The bug causes unstable handling of ambiguous width character.
4472  * 2: Windows 10 version 1903 & 1909
4473  *      Use the wrong result because each result is different.
4474  * 3: Windows 10 insider preview (current latest logic)
4475  */
4476     int
4477 get_special_pty_type(void)
4478 {
4479 #ifdef MSWIN
4480     return get_conpty_type();
4481 #else
4482     return 0;
4483 #endif
4484 }
4485