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