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