xref: /vim-8.2.3635/src/misc2.c (revision 577fadfc)
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(long_u *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(long_u 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  * Note: if unsigned is 16 bits we can only allocate up to 64K with alloc().
822  * Use lalloc for larger blocks.
823  */
824     char_u *
825 alloc(unsigned size)
826 {
827     return (lalloc((long_u)size, TRUE));
828 }
829 
830 /*
831  * alloc() with an ID for alloc_fail().
832  */
833     char_u *
834 alloc_id(unsigned size, alloc_id_T id UNUSED)
835 {
836 #ifdef FEAT_EVAL
837     if (alloc_fail_id == id && alloc_does_fail((long_u)size))
838 	return NULL;
839 #endif
840     return (lalloc((long_u)size, TRUE));
841 }
842 
843 /*
844  * Allocate memory and set all bytes to zero.
845  */
846     char_u *
847 alloc_clear(unsigned size)
848 {
849     char_u *p;
850 
851     p = lalloc((long_u)size, TRUE);
852     if (p != NULL)
853 	(void)vim_memset(p, 0, (size_t)size);
854     return p;
855 }
856 
857 /*
858  * Same as alloc_clear() but with allocation id for testing
859  */
860     char_u *
861 alloc_clear_id(unsigned size, alloc_id_T id UNUSED)
862 {
863 #ifdef FEAT_EVAL
864     if (alloc_fail_id == id && alloc_does_fail((long_u)size))
865 	return NULL;
866 #endif
867     return alloc_clear(size);
868 }
869 
870 /*
871  * alloc() with check for maximum line length
872  */
873     char_u *
874 alloc_check(unsigned size)
875 {
876 #if !defined(UNIX)
877     if (sizeof(int) == 2 && size > 0x7fff)
878     {
879 	/* Don't hide this message */
880 	emsg_silent = 0;
881 	emsg(_("E340: Line is becoming too long"));
882 	return NULL;
883     }
884 #endif
885     return (lalloc((long_u)size, TRUE));
886 }
887 
888 /*
889  * Allocate memory like lalloc() and set all bytes to zero.
890  */
891     char_u *
892 lalloc_clear(long_u size, int message)
893 {
894     char_u *p;
895 
896     p = (lalloc(size, message));
897     if (p != NULL)
898 	(void)vim_memset(p, 0, (size_t)size);
899     return p;
900 }
901 
902 /*
903  * Low level memory allocation function.
904  * This is used often, KEEP IT FAST!
905  */
906     char_u *
907 lalloc(long_u size, int message)
908 {
909     char_u	*p;		    /* pointer to new storage space */
910     static int	releasing = FALSE;  /* don't do mf_release_all() recursive */
911     int		try_again;
912 #if defined(HAVE_AVAIL_MEM)
913     static long_u allocated = 0;    /* allocated since last avail check */
914 #endif
915 
916     /* Safety check for allocating zero bytes */
917     if (size == 0)
918     {
919 	/* Don't hide this message */
920 	emsg_silent = 0;
921 	siemsg(_("E341: Internal error: lalloc(%ld, )"), size);
922 	return NULL;
923     }
924 
925 #ifdef MEM_PROFILE
926     mem_pre_alloc_l(&size);
927 #endif
928 
929     /*
930      * Loop when out of memory: Try to release some memfile blocks and
931      * if some blocks are released call malloc again.
932      */
933     for (;;)
934     {
935 	/*
936 	 * Handle three kind of systems:
937 	 * 1. No check for available memory: Just return.
938 	 * 2. Slow check for available memory: call mch_avail_mem() after
939 	 *    allocating KEEP_ROOM amount of memory.
940 	 * 3. Strict check for available memory: call mch_avail_mem()
941 	 */
942 	if ((p = (char_u *)malloc((size_t)size)) != NULL)
943 	{
944 #ifndef HAVE_AVAIL_MEM
945 	    /* 1. No check for available memory: Just return. */
946 	    goto theend;
947 #else
948 	    /* 2. Slow check for available memory: call mch_avail_mem() after
949 	     *    allocating (KEEP_ROOM / 2) amount of memory. */
950 	    allocated += size;
951 	    if (allocated < KEEP_ROOM / 2)
952 		goto theend;
953 	    allocated = 0;
954 
955 	    /* 3. check for available memory: call mch_avail_mem() */
956 	    if (mch_avail_mem(TRUE) < KEEP_ROOM_KB && !releasing)
957 	    {
958 		free((char *)p);	/* System is low... no go! */
959 		p = NULL;
960 	    }
961 	    else
962 		goto theend;
963 #endif
964 	}
965 	/*
966 	 * Remember that mf_release_all() is being called to avoid an endless
967 	 * loop, because mf_release_all() may call alloc() recursively.
968 	 */
969 	if (releasing)
970 	    break;
971 	releasing = TRUE;
972 
973 	clear_sb_text(TRUE);	      /* free any scrollback text */
974 	try_again = mf_release_all(); /* release as many blocks as possible */
975 
976 	releasing = FALSE;
977 	if (!try_again)
978 	    break;
979     }
980 
981     if (message && p == NULL)
982 	do_outofmem_msg(size);
983 
984 theend:
985 #ifdef MEM_PROFILE
986     mem_post_alloc((void **)&p, (size_t)size);
987 #endif
988     return p;
989 }
990 
991 /*
992  * lalloc() with an ID for alloc_fail().
993  */
994 #if defined(FEAT_SIGNS) || defined(PROTO)
995     char_u *
996 lalloc_id(long_u size, int message, alloc_id_T id UNUSED)
997 {
998 #ifdef FEAT_EVAL
999     if (alloc_fail_id == id && alloc_does_fail(size))
1000 	return NULL;
1001 #endif
1002     return (lalloc((long_u)size, message));
1003 }
1004 #endif
1005 
1006 #if defined(MEM_PROFILE) || defined(PROTO)
1007 /*
1008  * realloc() with memory profiling.
1009  */
1010     void *
1011 mem_realloc(void *ptr, size_t size)
1012 {
1013     void *p;
1014 
1015     mem_pre_free(&ptr);
1016     mem_pre_alloc_s(&size);
1017 
1018     p = realloc(ptr, size);
1019 
1020     mem_post_alloc(&p, size);
1021 
1022     return p;
1023 }
1024 #endif
1025 
1026 /*
1027 * Avoid repeating the error message many times (they take 1 second each).
1028 * Did_outofmem_msg is reset when a character is read.
1029 */
1030     void
1031 do_outofmem_msg(long_u size)
1032 {
1033     if (!did_outofmem_msg)
1034     {
1035 	/* Don't hide this message */
1036 	emsg_silent = 0;
1037 
1038 	/* Must come first to avoid coming back here when printing the error
1039 	 * message fails, e.g. when setting v:errmsg. */
1040 	did_outofmem_msg = TRUE;
1041 
1042 	semsg(_("E342: Out of memory!  (allocating %lu bytes)"), size);
1043     }
1044 }
1045 
1046 #if defined(EXITFREE) || defined(PROTO)
1047 
1048 /*
1049  * Free everything that we allocated.
1050  * Can be used to detect memory leaks, e.g., with ccmalloc.
1051  * NOTE: This is tricky!  Things are freed that functions depend on.  Don't be
1052  * surprised if Vim crashes...
1053  * Some things can't be freed, esp. things local to a library function.
1054  */
1055     void
1056 free_all_mem(void)
1057 {
1058     buf_T	*buf, *nextbuf;
1059 
1060     /* When we cause a crash here it is caught and Vim tries to exit cleanly.
1061      * Don't try freeing everything again. */
1062     if (entered_free_all_mem)
1063 	return;
1064     entered_free_all_mem = TRUE;
1065 
1066     /* Don't want to trigger autocommands from here on. */
1067     block_autocmds();
1068 
1069     /* Close all tabs and windows.  Reset 'equalalways' to avoid redraws. */
1070     p_ea = FALSE;
1071     if (first_tabpage->tp_next != NULL)
1072 	do_cmdline_cmd((char_u *)"tabonly!");
1073     if (!ONE_WINDOW)
1074 	do_cmdline_cmd((char_u *)"only!");
1075 
1076 # if defined(FEAT_SPELL)
1077     /* Free all spell info. */
1078     spell_free_all();
1079 # endif
1080 
1081 #if defined(FEAT_INS_EXPAND) && defined(FEAT_BEVAL_TERM)
1082     ui_remove_balloon();
1083 # endif
1084 
1085 # if defined(FEAT_USR_CMDS)
1086     /* Clear user commands (before deleting buffers). */
1087     ex_comclear(NULL);
1088 # endif
1089 
1090 # ifdef FEAT_MENU
1091     /* Clear menus. */
1092     do_cmdline_cmd((char_u *)"aunmenu *");
1093 #  ifdef FEAT_MULTI_LANG
1094     do_cmdline_cmd((char_u *)"menutranslate clear");
1095 #  endif
1096 # endif
1097 
1098     /* Clear mappings, abbreviations, breakpoints. */
1099     do_cmdline_cmd((char_u *)"lmapclear");
1100     do_cmdline_cmd((char_u *)"xmapclear");
1101     do_cmdline_cmd((char_u *)"mapclear");
1102     do_cmdline_cmd((char_u *)"mapclear!");
1103     do_cmdline_cmd((char_u *)"abclear");
1104 # if defined(FEAT_EVAL)
1105     do_cmdline_cmd((char_u *)"breakdel *");
1106 # endif
1107 # if defined(FEAT_PROFILE)
1108     do_cmdline_cmd((char_u *)"profdel *");
1109 # endif
1110 # if defined(FEAT_KEYMAP)
1111     do_cmdline_cmd((char_u *)"set keymap=");
1112 #endif
1113 
1114 # ifdef FEAT_TITLE
1115     free_titles();
1116 # endif
1117 # if defined(FEAT_SEARCHPATH)
1118     free_findfile();
1119 # endif
1120 
1121     /* Obviously named calls. */
1122     free_all_autocmds();
1123     clear_termcodes();
1124     free_all_marks();
1125     alist_clear(&global_alist);
1126     free_homedir();
1127 # if defined(FEAT_CMDL_COMPL)
1128     free_users();
1129 # endif
1130     free_search_patterns();
1131     free_old_sub();
1132     free_last_insert();
1133     free_insexpand_stuff();
1134     free_prev_shellcmd();
1135     free_regexp_stuff();
1136     free_tag_stuff();
1137     free_cd_dir();
1138 # ifdef FEAT_SIGNS
1139     free_signs();
1140 # endif
1141 # ifdef FEAT_EVAL
1142     set_expr_line(NULL);
1143 # endif
1144 # ifdef FEAT_DIFF
1145     diff_clear(curtab);
1146 # endif
1147     clear_sb_text(TRUE);	      /* free any scrollback text */
1148 
1149     /* Free some global vars. */
1150     vim_free(username);
1151 # ifdef FEAT_CLIPBOARD
1152     vim_regfree(clip_exclude_prog);
1153 # endif
1154     vim_free(last_cmdline);
1155 # ifdef FEAT_CMDHIST
1156     vim_free(new_last_cmdline);
1157 # endif
1158     set_keep_msg(NULL, 0);
1159 
1160     /* Clear cmdline history. */
1161     p_hi = 0;
1162 # ifdef FEAT_CMDHIST
1163     init_history();
1164 # endif
1165 #ifdef FEAT_TEXT_PROP
1166     clear_global_prop_types();
1167 #endif
1168 
1169 #ifdef FEAT_QUICKFIX
1170     {
1171 	win_T	    *win;
1172 	tabpage_T   *tab;
1173 
1174 	qf_free_all(NULL);
1175 	/* Free all location lists */
1176 	FOR_ALL_TAB_WINDOWS(tab, win)
1177 	    qf_free_all(win);
1178     }
1179 #endif
1180 
1181     /* Close all script inputs. */
1182     close_all_scripts();
1183 
1184     /* Destroy all windows.  Must come before freeing buffers. */
1185     win_free_all();
1186 
1187     /* Free all option values.  Must come after closing windows. */
1188     free_all_options();
1189 
1190     /* Free all buffers.  Reset 'autochdir' to avoid accessing things that
1191      * were freed already. */
1192 #ifdef FEAT_AUTOCHDIR
1193     p_acd = FALSE;
1194 #endif
1195     for (buf = firstbuf; buf != NULL; )
1196     {
1197 	bufref_T    bufref;
1198 
1199 	set_bufref(&bufref, buf);
1200 	nextbuf = buf->b_next;
1201 	close_buffer(NULL, buf, DOBUF_WIPE, FALSE);
1202 	if (bufref_valid(&bufref))
1203 	    buf = nextbuf;	/* didn't work, try next one */
1204 	else
1205 	    buf = firstbuf;
1206     }
1207 
1208 # ifdef FEAT_ARABIC
1209     free_cmdline_buf();
1210 # endif
1211 
1212     /* Clear registers. */
1213     clear_registers();
1214     ResetRedobuff();
1215     ResetRedobuff();
1216 
1217 # if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
1218     vim_free(serverDelayedStartName);
1219 # endif
1220 
1221     /* highlight info */
1222     free_highlight();
1223 
1224     reset_last_sourcing();
1225 
1226     free_tabpage(first_tabpage);
1227     first_tabpage = NULL;
1228 
1229 # ifdef UNIX
1230     /* Machine-specific free. */
1231     mch_free_mem();
1232 # endif
1233 
1234     /* message history */
1235     for (;;)
1236 	if (delete_first_msg() == FAIL)
1237 	    break;
1238 
1239 # ifdef FEAT_JOB_CHANNEL
1240     channel_free_all();
1241 # endif
1242 # ifdef FEAT_TIMERS
1243     timer_free_all();
1244 # endif
1245 # ifdef FEAT_EVAL
1246     /* must be after channel_free_all() with unrefs partials */
1247     eval_clear();
1248 # endif
1249 # ifdef FEAT_JOB_CHANNEL
1250     /* must be after eval_clear() with unrefs jobs */
1251     job_free_all();
1252 # endif
1253 
1254     free_termoptions();
1255 
1256     /* screenlines (can't display anything now!) */
1257     free_screenlines();
1258 
1259 # if defined(USE_XSMP)
1260     xsmp_close();
1261 # endif
1262 # ifdef FEAT_GUI_GTK
1263     gui_mch_free_all();
1264 # endif
1265     clear_hl_tables();
1266 
1267     vim_free(IObuff);
1268     vim_free(NameBuff);
1269 # ifdef FEAT_QUICKFIX
1270     check_quickfix_busy();
1271 # endif
1272 }
1273 #endif
1274 
1275 /*
1276  * Copy "string" into newly allocated memory.
1277  */
1278     char_u *
1279 vim_strsave(char_u *string)
1280 {
1281     char_u	*p;
1282     unsigned	len;
1283 
1284     len = (unsigned)STRLEN(string) + 1;
1285     p = alloc(len);
1286     if (p != NULL)
1287 	mch_memmove(p, string, (size_t)len);
1288     return p;
1289 }
1290 
1291 /*
1292  * Copy up to "len" bytes of "string" into newly allocated memory and
1293  * terminate with a NUL.
1294  * The allocated memory always has size "len + 1", also when "string" is
1295  * shorter.
1296  */
1297     char_u *
1298 vim_strnsave(char_u *string, int len)
1299 {
1300     char_u	*p;
1301 
1302     p = alloc((unsigned)(len + 1));
1303     if (p != NULL)
1304     {
1305 	STRNCPY(p, string, len);
1306 	p[len] = NUL;
1307     }
1308     return p;
1309 }
1310 
1311 /*
1312  * Copy "p[len]" into allocated memory, ignoring NUL characters.
1313  * Returns NULL when out of memory.
1314  */
1315     char_u *
1316 vim_memsave(char_u *p, int len)
1317 {
1318     char_u *ret = alloc((unsigned)len);
1319 
1320     if (ret != NULL)
1321 	mch_memmove(ret, p, (size_t)len);
1322     return ret;
1323 }
1324 
1325 /*
1326  * Same as vim_strsave(), but any characters found in esc_chars are preceded
1327  * by a backslash.
1328  */
1329     char_u *
1330 vim_strsave_escaped(char_u *string, char_u *esc_chars)
1331 {
1332     return vim_strsave_escaped_ext(string, esc_chars, '\\', FALSE);
1333 }
1334 
1335 /*
1336  * Same as vim_strsave_escaped(), but when "bsl" is TRUE also escape
1337  * characters where rem_backslash() would remove the backslash.
1338  * Escape the characters with "cc".
1339  */
1340     char_u *
1341 vim_strsave_escaped_ext(
1342     char_u	*string,
1343     char_u	*esc_chars,
1344     int		cc,
1345     int		bsl)
1346 {
1347     char_u	*p;
1348     char_u	*p2;
1349     char_u	*escaped_string;
1350     unsigned	length;
1351     int		l;
1352 
1353     /*
1354      * First count the number of backslashes required.
1355      * Then allocate the memory and insert them.
1356      */
1357     length = 1;				/* count the trailing NUL */
1358     for (p = string; *p; p++)
1359     {
1360 	if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1361 	{
1362 	    length += l;		/* count a multibyte char */
1363 	    p += l - 1;
1364 	    continue;
1365 	}
1366 	if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
1367 	    ++length;			/* count a backslash */
1368 	++length;			/* count an ordinary char */
1369     }
1370     escaped_string = alloc(length);
1371     if (escaped_string != NULL)
1372     {
1373 	p2 = escaped_string;
1374 	for (p = string; *p; p++)
1375 	{
1376 	    if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1377 	    {
1378 		mch_memmove(p2, p, (size_t)l);
1379 		p2 += l;
1380 		p += l - 1;		/* skip multibyte char  */
1381 		continue;
1382 	    }
1383 	    if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
1384 		*p2++ = cc;
1385 	    *p2++ = *p;
1386 	}
1387 	*p2 = NUL;
1388     }
1389     return escaped_string;
1390 }
1391 
1392 /*
1393  * Return TRUE when 'shell' has "csh" in the tail.
1394  */
1395     int
1396 csh_like_shell(void)
1397 {
1398     return (strstr((char *)gettail(p_sh), "csh") != NULL);
1399 }
1400 
1401 /*
1402  * Escape "string" for use as a shell argument with system().
1403  * This uses single quotes, except when we know we need to use double quotes
1404  * (MS-DOS and MS-Windows without 'shellslash' set).
1405  * Escape a newline, depending on the 'shell' option.
1406  * When "do_special" is TRUE also replace "!", "%", "#" and things starting
1407  * with "<" like "<cfile>".
1408  * When "do_newline" is FALSE do not escape newline unless it is csh shell.
1409  * Returns the result in allocated memory, NULL if we have run out.
1410  */
1411     char_u *
1412 vim_strsave_shellescape(char_u *string, int do_special, int do_newline)
1413 {
1414     unsigned	length;
1415     char_u	*p;
1416     char_u	*d;
1417     char_u	*escaped_string;
1418     int		l;
1419     int		csh_like;
1420 
1421     /* Only csh and similar shells expand '!' within single quotes.  For sh and
1422      * the like we must not put a backslash before it, it will be taken
1423      * literally.  If do_special is set the '!' will be escaped twice.
1424      * Csh also needs to have "\n" escaped twice when do_special is set. */
1425     csh_like = csh_like_shell();
1426 
1427     /* First count the number of extra bytes required. */
1428     length = (unsigned)STRLEN(string) + 3;  /* two quotes and a trailing NUL */
1429     for (p = string; *p != NUL; MB_PTR_ADV(p))
1430     {
1431 # ifdef MSWIN
1432 	if (!p_ssl)
1433 	{
1434 	    if (*p == '"')
1435 		++length;		/* " -> "" */
1436 	}
1437 	else
1438 # endif
1439 	if (*p == '\'')
1440 	    length += 3;		/* ' => '\'' */
1441 	if ((*p == '\n' && (csh_like || do_newline))
1442 		|| (*p == '!' && (csh_like || do_special)))
1443 	{
1444 	    ++length;			/* insert backslash */
1445 	    if (csh_like && do_special)
1446 		++length;		/* insert backslash */
1447 	}
1448 	if (do_special && find_cmdline_var(p, &l) >= 0)
1449 	{
1450 	    ++length;			/* insert backslash */
1451 	    p += l - 1;
1452 	}
1453     }
1454 
1455     /* Allocate memory for the result and fill it. */
1456     escaped_string = alloc(length);
1457     if (escaped_string != NULL)
1458     {
1459 	d = escaped_string;
1460 
1461 	/* add opening quote */
1462 # ifdef MSWIN
1463 	if (!p_ssl)
1464 	    *d++ = '"';
1465 	else
1466 # endif
1467 	    *d++ = '\'';
1468 
1469 	for (p = string; *p != NUL; )
1470 	{
1471 # ifdef MSWIN
1472 	    if (!p_ssl)
1473 	    {
1474 		if (*p == '"')
1475 		{
1476 		    *d++ = '"';
1477 		    *d++ = '"';
1478 		    ++p;
1479 		    continue;
1480 		}
1481 	    }
1482 	    else
1483 # endif
1484 	    if (*p == '\'')
1485 	    {
1486 		*d++ = '\'';
1487 		*d++ = '\\';
1488 		*d++ = '\'';
1489 		*d++ = '\'';
1490 		++p;
1491 		continue;
1492 	    }
1493 	    if ((*p == '\n' && (csh_like || do_newline))
1494 		    || (*p == '!' && (csh_like || do_special)))
1495 	    {
1496 		*d++ = '\\';
1497 		if (csh_like && do_special)
1498 		    *d++ = '\\';
1499 		*d++ = *p++;
1500 		continue;
1501 	    }
1502 	    if (do_special && find_cmdline_var(p, &l) >= 0)
1503 	    {
1504 		*d++ = '\\';		/* insert backslash */
1505 		while (--l >= 0)	/* copy the var */
1506 		    *d++ = *p++;
1507 		continue;
1508 	    }
1509 
1510 	    MB_COPY_CHAR(p, d);
1511 	}
1512 
1513 	/* add terminating quote and finish with a NUL */
1514 # ifdef MSWIN
1515 	if (!p_ssl)
1516 	    *d++ = '"';
1517 	else
1518 # endif
1519 	    *d++ = '\'';
1520 	*d = NUL;
1521     }
1522 
1523     return escaped_string;
1524 }
1525 
1526 /*
1527  * Like vim_strsave(), but make all characters uppercase.
1528  * This uses ASCII lower-to-upper case translation, language independent.
1529  */
1530     char_u *
1531 vim_strsave_up(char_u *string)
1532 {
1533     char_u *p1;
1534 
1535     p1 = vim_strsave(string);
1536     vim_strup(p1);
1537     return p1;
1538 }
1539 
1540 /*
1541  * Like vim_strnsave(), but make all characters uppercase.
1542  * This uses ASCII lower-to-upper case translation, language independent.
1543  */
1544     char_u *
1545 vim_strnsave_up(char_u *string, int len)
1546 {
1547     char_u *p1;
1548 
1549     p1 = vim_strnsave(string, len);
1550     vim_strup(p1);
1551     return p1;
1552 }
1553 
1554 /*
1555  * ASCII lower-to-upper case translation, language independent.
1556  */
1557     void
1558 vim_strup(
1559     char_u	*p)
1560 {
1561     char_u  *p2;
1562     int	    c;
1563 
1564     if (p != NULL)
1565     {
1566 	p2 = p;
1567 	while ((c = *p2) != NUL)
1568 #ifdef EBCDIC
1569 	    *p2++ = isalpha(c) ? toupper(c) : c;
1570 #else
1571 	    *p2++ = (c < 'a' || c > 'z') ? c : (c - 0x20);
1572 #endif
1573     }
1574 }
1575 
1576 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
1577 /*
1578  * Make string "s" all upper-case and return it in allocated memory.
1579  * Handles multi-byte characters as well as possible.
1580  * Returns NULL when out of memory.
1581  */
1582     char_u *
1583 strup_save(char_u *orig)
1584 {
1585     char_u	*p;
1586     char_u	*res;
1587 
1588     res = p = vim_strsave(orig);
1589 
1590     if (res != NULL)
1591 	while (*p != NUL)
1592 	{
1593 	    int		l;
1594 
1595 	    if (enc_utf8)
1596 	    {
1597 		int	c, uc;
1598 		int	newl;
1599 		char_u	*s;
1600 
1601 		c = utf_ptr2char(p);
1602 		l = utf_ptr2len(p);
1603 		if (c == 0)
1604 		{
1605 		    /* overlong sequence, use only the first byte */
1606 		    c = *p;
1607 		    l = 1;
1608 		}
1609 		uc = utf_toupper(c);
1610 
1611 		/* Reallocate string when byte count changes.  This is rare,
1612 		 * thus it's OK to do another malloc()/free(). */
1613 		newl = utf_char2len(uc);
1614 		if (newl != l)
1615 		{
1616 		    s = alloc((unsigned)STRLEN(res) + 1 + newl - l);
1617 		    if (s == NULL)
1618 		    {
1619 			vim_free(res);
1620 			return NULL;
1621 		    }
1622 		    mch_memmove(s, res, p - res);
1623 		    STRCPY(s + (p - res) + newl, p + l);
1624 		    p = s + (p - res);
1625 		    vim_free(res);
1626 		    res = s;
1627 		}
1628 
1629 		utf_char2bytes(uc, p);
1630 		p += newl;
1631 	    }
1632 	    else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1633 		p += l;		/* skip multi-byte character */
1634 	    else
1635 	    {
1636 		*p = TOUPPER_LOC(*p); /* note that toupper() can be a macro */
1637 		p++;
1638 	    }
1639 	}
1640 
1641     return res;
1642 }
1643 
1644 /*
1645  * Make string "s" all lower-case and return it in allocated memory.
1646  * Handles multi-byte characters as well as possible.
1647  * Returns NULL when out of memory.
1648  */
1649     char_u *
1650 strlow_save(char_u *orig)
1651 {
1652     char_u	*p;
1653     char_u	*res;
1654 
1655     res = p = vim_strsave(orig);
1656 
1657     if (res != NULL)
1658 	while (*p != NUL)
1659 	{
1660 	    int		l;
1661 
1662 	    if (enc_utf8)
1663 	    {
1664 		int	c, lc;
1665 		int	newl;
1666 		char_u	*s;
1667 
1668 		c = utf_ptr2char(p);
1669 		l = utf_ptr2len(p);
1670 		if (c == 0)
1671 		{
1672 		    /* overlong sequence, use only the first byte */
1673 		    c = *p;
1674 		    l = 1;
1675 		}
1676 		lc = utf_tolower(c);
1677 
1678 		/* Reallocate string when byte count changes.  This is rare,
1679 		 * thus it's OK to do another malloc()/free(). */
1680 		newl = utf_char2len(lc);
1681 		if (newl != l)
1682 		{
1683 		    s = alloc((unsigned)STRLEN(res) + 1 + newl - l);
1684 		    if (s == NULL)
1685 		    {
1686 			vim_free(res);
1687 			return NULL;
1688 		    }
1689 		    mch_memmove(s, res, p - res);
1690 		    STRCPY(s + (p - res) + newl, p + l);
1691 		    p = s + (p - res);
1692 		    vim_free(res);
1693 		    res = s;
1694 		}
1695 
1696 		utf_char2bytes(lc, p);
1697 		p += newl;
1698 	    }
1699 	    else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1700 		p += l;		/* skip multi-byte character */
1701 	    else
1702 	    {
1703 		*p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
1704 		p++;
1705 	    }
1706 	}
1707 
1708     return res;
1709 }
1710 #endif
1711 
1712 /*
1713  * delete spaces at the end of a string
1714  */
1715     void
1716 del_trailing_spaces(char_u *ptr)
1717 {
1718     char_u	*q;
1719 
1720     q = ptr + STRLEN(ptr);
1721     while (--q > ptr && VIM_ISWHITE(q[0]) && q[-1] != '\\' && q[-1] != Ctrl_V)
1722 	*q = NUL;
1723 }
1724 
1725 /*
1726  * Like strncpy(), but always terminate the result with one NUL.
1727  * "to" must be "len + 1" long!
1728  */
1729     void
1730 vim_strncpy(char_u *to, char_u *from, size_t len)
1731 {
1732     STRNCPY(to, from, len);
1733     to[len] = NUL;
1734 }
1735 
1736 /*
1737  * Like strcat(), but make sure the result fits in "tosize" bytes and is
1738  * always NUL terminated. "from" and "to" may overlap.
1739  */
1740     void
1741 vim_strcat(char_u *to, char_u *from, size_t tosize)
1742 {
1743     size_t tolen = STRLEN(to);
1744     size_t fromlen = STRLEN(from);
1745 
1746     if (tolen + fromlen + 1 > tosize)
1747     {
1748 	mch_memmove(to + tolen, from, tosize - tolen - 1);
1749 	to[tosize - 1] = NUL;
1750     }
1751     else
1752 	mch_memmove(to + tolen, from, fromlen + 1);
1753 }
1754 
1755 /*
1756  * Isolate one part of a string option where parts are separated with
1757  * "sep_chars".
1758  * The part is copied into "buf[maxlen]".
1759  * "*option" is advanced to the next part.
1760  * The length is returned.
1761  */
1762     int
1763 copy_option_part(
1764     char_u	**option,
1765     char_u	*buf,
1766     int		maxlen,
1767     char	*sep_chars)
1768 {
1769     int	    len = 0;
1770     char_u  *p = *option;
1771 
1772     /* skip '.' at start of option part, for 'suffixes' */
1773     if (*p == '.')
1774 	buf[len++] = *p++;
1775     while (*p != NUL && vim_strchr((char_u *)sep_chars, *p) == NULL)
1776     {
1777 	/*
1778 	 * Skip backslash before a separator character and space.
1779 	 */
1780 	if (p[0] == '\\' && vim_strchr((char_u *)sep_chars, p[1]) != NULL)
1781 	    ++p;
1782 	if (len < maxlen - 1)
1783 	    buf[len++] = *p;
1784 	++p;
1785     }
1786     buf[len] = NUL;
1787 
1788     if (*p != NUL && *p != ',')	/* skip non-standard separator */
1789 	++p;
1790     p = skip_to_option_part(p);	/* p points to next file name */
1791 
1792     *option = p;
1793     return len;
1794 }
1795 
1796 /*
1797  * Replacement for free() that ignores NULL pointers.
1798  * Also skip free() when exiting for sure, this helps when we caught a deadly
1799  * signal that was caused by a crash in free().
1800  * If you want to set NULL after calling this function, you should use
1801  * VIM_CLEAR() instead.
1802  */
1803     void
1804 vim_free(void *x)
1805 {
1806     if (x != NULL && !really_exiting)
1807     {
1808 #ifdef MEM_PROFILE
1809 	mem_pre_free(&x);
1810 #endif
1811 	free(x);
1812     }
1813 }
1814 
1815 #ifndef HAVE_MEMSET
1816     void *
1817 vim_memset(void *ptr, int c, size_t size)
1818 {
1819     char *p = ptr;
1820 
1821     while (size-- > 0)
1822 	*p++ = c;
1823     return ptr;
1824 }
1825 #endif
1826 
1827 #if (!defined(HAVE_STRCASECMP) && !defined(HAVE_STRICMP)) || defined(PROTO)
1828 /*
1829  * Compare two strings, ignoring case, using current locale.
1830  * Doesn't work for multi-byte characters.
1831  * return 0 for match, < 0 for smaller, > 0 for bigger
1832  */
1833     int
1834 vim_stricmp(char *s1, char *s2)
1835 {
1836     int		i;
1837 
1838     for (;;)
1839     {
1840 	i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
1841 	if (i != 0)
1842 	    return i;			    /* this character different */
1843 	if (*s1 == NUL)
1844 	    break;			    /* strings match until NUL */
1845 	++s1;
1846 	++s2;
1847     }
1848     return 0;				    /* strings match */
1849 }
1850 #endif
1851 
1852 #if (!defined(HAVE_STRNCASECMP) && !defined(HAVE_STRNICMP)) || defined(PROTO)
1853 /*
1854  * Compare two strings, for length "len", ignoring case, using current locale.
1855  * Doesn't work for multi-byte characters.
1856  * return 0 for match, < 0 for smaller, > 0 for bigger
1857  */
1858     int
1859 vim_strnicmp(char *s1, char *s2, size_t len)
1860 {
1861     int		i;
1862 
1863     while (len > 0)
1864     {
1865 	i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
1866 	if (i != 0)
1867 	    return i;			    /* this character different */
1868 	if (*s1 == NUL)
1869 	    break;			    /* strings match until NUL */
1870 	++s1;
1871 	++s2;
1872 	--len;
1873     }
1874     return 0;				    /* strings match */
1875 }
1876 #endif
1877 
1878 /*
1879  * Version of strchr() and strrchr() that handle unsigned char strings
1880  * with characters from 128 to 255 correctly.  It also doesn't return a
1881  * pointer to the NUL at the end of the string.
1882  */
1883     char_u  *
1884 vim_strchr(char_u *string, int c)
1885 {
1886     char_u	*p;
1887     int		b;
1888 
1889     p = string;
1890     if (enc_utf8 && c >= 0x80)
1891     {
1892 	while (*p != NUL)
1893 	{
1894 	    int l = utfc_ptr2len(p);
1895 
1896 	    /* Avoid matching an illegal byte here. */
1897 	    if (utf_ptr2char(p) == c && l > 1)
1898 		return p;
1899 	    p += l;
1900 	}
1901 	return NULL;
1902     }
1903     if (enc_dbcs != 0 && c > 255)
1904     {
1905 	int	n2 = c & 0xff;
1906 
1907 	c = ((unsigned)c >> 8) & 0xff;
1908 	while ((b = *p) != NUL)
1909 	{
1910 	    if (b == c && p[1] == n2)
1911 		return p;
1912 	    p += (*mb_ptr2len)(p);
1913 	}
1914 	return NULL;
1915     }
1916     if (has_mbyte)
1917     {
1918 	while ((b = *p) != NUL)
1919 	{
1920 	    if (b == c)
1921 		return p;
1922 	    p += (*mb_ptr2len)(p);
1923 	}
1924 	return NULL;
1925     }
1926     while ((b = *p) != NUL)
1927     {
1928 	if (b == c)
1929 	    return p;
1930 	++p;
1931     }
1932     return NULL;
1933 }
1934 
1935 /*
1936  * Version of strchr() that only works for bytes and handles unsigned char
1937  * strings with characters above 128 correctly. It also doesn't return a
1938  * pointer to the NUL at the end of the string.
1939  */
1940     char_u  *
1941 vim_strbyte(char_u *string, int c)
1942 {
1943     char_u	*p = string;
1944 
1945     while (*p != NUL)
1946     {
1947 	if (*p == c)
1948 	    return p;
1949 	++p;
1950     }
1951     return NULL;
1952 }
1953 
1954 /*
1955  * Search for last occurrence of "c" in "string".
1956  * Return NULL if not found.
1957  * Does not handle multi-byte char for "c"!
1958  */
1959     char_u  *
1960 vim_strrchr(char_u *string, int c)
1961 {
1962     char_u	*retval = NULL;
1963     char_u	*p = string;
1964 
1965     while (*p)
1966     {
1967 	if (*p == c)
1968 	    retval = p;
1969 	MB_PTR_ADV(p);
1970     }
1971     return retval;
1972 }
1973 
1974 /*
1975  * Vim's version of strpbrk(), in case it's missing.
1976  * Don't generate a prototype for this, causes problems when it's not used.
1977  */
1978 #ifndef PROTO
1979 # ifndef HAVE_STRPBRK
1980 #  ifdef vim_strpbrk
1981 #   undef vim_strpbrk
1982 #  endif
1983     char_u *
1984 vim_strpbrk(char_u *s, char_u *charset)
1985 {
1986     while (*s)
1987     {
1988 	if (vim_strchr(charset, *s) != NULL)
1989 	    return s;
1990 	MB_PTR_ADV(s);
1991     }
1992     return NULL;
1993 }
1994 # endif
1995 #endif
1996 
1997 /*
1998  * Vim has its own isspace() function, because on some machines isspace()
1999  * can't handle characters above 128.
2000  */
2001     int
2002 vim_isspace(int x)
2003 {
2004     return ((x >= 9 && x <= 13) || x == ' ');
2005 }
2006 
2007 /************************************************************************
2008  * Functions for handling growing arrays.
2009  */
2010 
2011 /*
2012  * Clear an allocated growing array.
2013  */
2014     void
2015 ga_clear(garray_T *gap)
2016 {
2017     vim_free(gap->ga_data);
2018     ga_init(gap);
2019 }
2020 
2021 /*
2022  * Clear a growing array that contains a list of strings.
2023  */
2024     void
2025 ga_clear_strings(garray_T *gap)
2026 {
2027     int		i;
2028 
2029     for (i = 0; i < gap->ga_len; ++i)
2030 	vim_free(((char_u **)(gap->ga_data))[i]);
2031     ga_clear(gap);
2032 }
2033 
2034 /*
2035  * Initialize a growing array.	Don't forget to set ga_itemsize and
2036  * ga_growsize!  Or use ga_init2().
2037  */
2038     void
2039 ga_init(garray_T *gap)
2040 {
2041     gap->ga_data = NULL;
2042     gap->ga_maxlen = 0;
2043     gap->ga_len = 0;
2044 }
2045 
2046     void
2047 ga_init2(garray_T *gap, int itemsize, int growsize)
2048 {
2049     ga_init(gap);
2050     gap->ga_itemsize = itemsize;
2051     gap->ga_growsize = growsize;
2052 }
2053 
2054 /*
2055  * Make room in growing array "gap" for at least "n" items.
2056  * Return FAIL for failure, OK otherwise.
2057  */
2058     int
2059 ga_grow(garray_T *gap, int n)
2060 {
2061     size_t	old_len;
2062     size_t	new_len;
2063     char_u	*pp;
2064 
2065     if (gap->ga_maxlen - gap->ga_len < n)
2066     {
2067 	if (n < gap->ga_growsize)
2068 	    n = gap->ga_growsize;
2069 	new_len = gap->ga_itemsize * (gap->ga_len + n);
2070 	pp = (gap->ga_data == NULL)
2071 	      ? alloc((unsigned)new_len) : 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     {0,			NULL}
2491     /* NOTE: When adding a long name update MAX_KEY_NAME_LEN. */
2492 };
2493 
2494 #define KEY_NAMES_TABLE_LEN (sizeof(key_names_table) / sizeof(struct key_name_entry))
2495 
2496 #ifdef FEAT_MOUSE
2497 static struct mousetable
2498 {
2499     int	    pseudo_code;	/* Code for pseudo mouse event */
2500     int	    button;		/* Which mouse button is it? */
2501     int	    is_click;		/* Is it a mouse button click event? */
2502     int	    is_drag;		/* Is it a mouse drag event? */
2503 } mouse_table[] =
2504 {
2505     {(int)KE_LEFTMOUSE,		MOUSE_LEFT,	TRUE,	FALSE},
2506 #ifdef FEAT_GUI
2507     {(int)KE_LEFTMOUSE_NM,	MOUSE_LEFT,	TRUE,	FALSE},
2508 #endif
2509     {(int)KE_LEFTDRAG,		MOUSE_LEFT,	FALSE,	TRUE},
2510     {(int)KE_LEFTRELEASE,	MOUSE_LEFT,	FALSE,	FALSE},
2511 #ifdef FEAT_GUI
2512     {(int)KE_LEFTRELEASE_NM,	MOUSE_LEFT,	FALSE,	FALSE},
2513 #endif
2514     {(int)KE_MIDDLEMOUSE,	MOUSE_MIDDLE,	TRUE,	FALSE},
2515     {(int)KE_MIDDLEDRAG,	MOUSE_MIDDLE,	FALSE,	TRUE},
2516     {(int)KE_MIDDLERELEASE,	MOUSE_MIDDLE,	FALSE,	FALSE},
2517     {(int)KE_RIGHTMOUSE,	MOUSE_RIGHT,	TRUE,	FALSE},
2518     {(int)KE_RIGHTDRAG,		MOUSE_RIGHT,	FALSE,	TRUE},
2519     {(int)KE_RIGHTRELEASE,	MOUSE_RIGHT,	FALSE,	FALSE},
2520     {(int)KE_X1MOUSE,		MOUSE_X1,	TRUE,	FALSE},
2521     {(int)KE_X1DRAG,		MOUSE_X1,	FALSE,	TRUE},
2522     {(int)KE_X1RELEASE,		MOUSE_X1,	FALSE,	FALSE},
2523     {(int)KE_X2MOUSE,		MOUSE_X2,	TRUE,	FALSE},
2524     {(int)KE_X2DRAG,		MOUSE_X2,	FALSE,	TRUE},
2525     {(int)KE_X2RELEASE,		MOUSE_X2,	FALSE,	FALSE},
2526     /* DRAG without CLICK */
2527     {(int)KE_MOUSEMOVE,		MOUSE_RELEASE,	FALSE,	TRUE},
2528     /* RELEASE without CLICK */
2529     {(int)KE_IGNORE,		MOUSE_RELEASE,	FALSE,	FALSE},
2530     {0,				0,		0,	0},
2531 };
2532 #endif /* FEAT_MOUSE */
2533 
2534 /*
2535  * Return the modifier mask bit (MOD_MASK_*) which corresponds to the given
2536  * modifier name ('S' for Shift, 'C' for Ctrl etc).
2537  */
2538     int
2539 name_to_mod_mask(int c)
2540 {
2541     int	    i;
2542 
2543     c = TOUPPER_ASC(c);
2544     for (i = 0; mod_mask_table[i].mod_mask != 0; i++)
2545 	if (c == mod_mask_table[i].name)
2546 	    return mod_mask_table[i].mod_flag;
2547     return 0;
2548 }
2549 
2550 /*
2551  * Check if if there is a special key code for "key" that includes the
2552  * modifiers specified.
2553  */
2554     int
2555 simplify_key(int key, int *modifiers)
2556 {
2557     int	    i;
2558     int	    key0;
2559     int	    key1;
2560 
2561     if (*modifiers & (MOD_MASK_SHIFT | MOD_MASK_CTRL | MOD_MASK_ALT))
2562     {
2563 	/* TAB is a special case */
2564 	if (key == TAB && (*modifiers & MOD_MASK_SHIFT))
2565 	{
2566 	    *modifiers &= ~MOD_MASK_SHIFT;
2567 	    return K_S_TAB;
2568 	}
2569 	key0 = KEY2TERMCAP0(key);
2570 	key1 = KEY2TERMCAP1(key);
2571 	for (i = 0; modifier_keys_table[i] != NUL; i += MOD_KEYS_ENTRY_SIZE)
2572 	    if (key0 == modifier_keys_table[i + 3]
2573 		    && key1 == modifier_keys_table[i + 4]
2574 		    && (*modifiers & modifier_keys_table[i]))
2575 	    {
2576 		*modifiers &= ~modifier_keys_table[i];
2577 		return TERMCAP2KEY(modifier_keys_table[i + 1],
2578 						   modifier_keys_table[i + 2]);
2579 	    }
2580     }
2581     return key;
2582 }
2583 
2584 /*
2585  * Change <xHome> to <Home>, <xUp> to <Up>, etc.
2586  */
2587     int
2588 handle_x_keys(int key)
2589 {
2590     switch (key)
2591     {
2592 	case K_XUP:	return K_UP;
2593 	case K_XDOWN:	return K_DOWN;
2594 	case K_XLEFT:	return K_LEFT;
2595 	case K_XRIGHT:	return K_RIGHT;
2596 	case K_XHOME:	return K_HOME;
2597 	case K_ZHOME:	return K_HOME;
2598 	case K_XEND:	return K_END;
2599 	case K_ZEND:	return K_END;
2600 	case K_XF1:	return K_F1;
2601 	case K_XF2:	return K_F2;
2602 	case K_XF3:	return K_F3;
2603 	case K_XF4:	return K_F4;
2604 	case K_S_XF1:	return K_S_F1;
2605 	case K_S_XF2:	return K_S_F2;
2606 	case K_S_XF3:	return K_S_F3;
2607 	case K_S_XF4:	return K_S_F4;
2608     }
2609     return key;
2610 }
2611 
2612 /*
2613  * Return a string which contains the name of the given key when the given
2614  * modifiers are down.
2615  */
2616     char_u *
2617 get_special_key_name(int c, int modifiers)
2618 {
2619     static char_u string[MAX_KEY_NAME_LEN + 1];
2620 
2621     int	    i, idx;
2622     int	    table_idx;
2623     char_u  *s;
2624 
2625     string[0] = '<';
2626     idx = 1;
2627 
2628     /* Key that stands for a normal character. */
2629     if (IS_SPECIAL(c) && KEY2TERMCAP0(c) == KS_KEY)
2630 	c = KEY2TERMCAP1(c);
2631 
2632     /*
2633      * Translate shifted special keys into unshifted keys and set modifier.
2634      * Same for CTRL and ALT modifiers.
2635      */
2636     if (IS_SPECIAL(c))
2637     {
2638 	for (i = 0; modifier_keys_table[i] != 0; i += MOD_KEYS_ENTRY_SIZE)
2639 	    if (       KEY2TERMCAP0(c) == (int)modifier_keys_table[i + 1]
2640 		    && (int)KEY2TERMCAP1(c) == (int)modifier_keys_table[i + 2])
2641 	    {
2642 		modifiers |= modifier_keys_table[i];
2643 		c = TERMCAP2KEY(modifier_keys_table[i + 3],
2644 						   modifier_keys_table[i + 4]);
2645 		break;
2646 	    }
2647     }
2648 
2649     /* try to find the key in the special key table */
2650     table_idx = find_special_key_in_table(c);
2651 
2652     /*
2653      * When not a known special key, and not a printable character, try to
2654      * extract modifiers.
2655      */
2656     if (c > 0 && (*mb_char2len)(c) == 1)
2657     {
2658 	if (table_idx < 0
2659 		&& (!vim_isprintc(c) || (c & 0x7f) == ' ')
2660 		&& (c & 0x80))
2661 	{
2662 	    c &= 0x7f;
2663 	    modifiers |= MOD_MASK_ALT;
2664 	    /* try again, to find the un-alted key in the special key table */
2665 	    table_idx = find_special_key_in_table(c);
2666 	}
2667 	if (table_idx < 0 && !vim_isprintc(c) && c < ' ')
2668 	{
2669 #ifdef EBCDIC
2670 	    c = CtrlChar(c);
2671 #else
2672 	    c += '@';
2673 #endif
2674 	    modifiers |= MOD_MASK_CTRL;
2675 	}
2676     }
2677 
2678     /* translate the modifier into a string */
2679     for (i = 0; mod_mask_table[i].name != 'A'; i++)
2680 	if ((modifiers & mod_mask_table[i].mod_mask)
2681 						== mod_mask_table[i].mod_flag)
2682 	{
2683 	    string[idx++] = mod_mask_table[i].name;
2684 	    string[idx++] = (char_u)'-';
2685 	}
2686 
2687     if (table_idx < 0)		/* unknown special key, may output t_xx */
2688     {
2689 	if (IS_SPECIAL(c))
2690 	{
2691 	    string[idx++] = 't';
2692 	    string[idx++] = '_';
2693 	    string[idx++] = KEY2TERMCAP0(c);
2694 	    string[idx++] = KEY2TERMCAP1(c);
2695 	}
2696 	/* Not a special key, only modifiers, output directly */
2697 	else
2698 	{
2699 	    if (has_mbyte && (*mb_char2len)(c) > 1)
2700 		idx += (*mb_char2bytes)(c, string + idx);
2701 	    else if (vim_isprintc(c))
2702 		string[idx++] = c;
2703 	    else
2704 	    {
2705 		s = transchar(c);
2706 		while (*s)
2707 		    string[idx++] = *s++;
2708 	    }
2709 	}
2710     }
2711     else		/* use name of special key */
2712     {
2713 	size_t len = STRLEN(key_names_table[table_idx].name);
2714 
2715 	if (len + idx + 2 <= MAX_KEY_NAME_LEN)
2716 	{
2717 	    STRCPY(string + idx, key_names_table[table_idx].name);
2718 	    idx += (int)len;
2719 	}
2720     }
2721     string[idx++] = '>';
2722     string[idx] = NUL;
2723     return string;
2724 }
2725 
2726 /*
2727  * Try translating a <> name at (*srcp)[] to dst[].
2728  * Return the number of characters added to dst[], zero for no match.
2729  * If there is a match, srcp is advanced to after the <> name.
2730  * dst[] must be big enough to hold the result (up to six characters)!
2731  */
2732     int
2733 trans_special(
2734     char_u	**srcp,
2735     char_u	*dst,
2736     int		keycode, /* prefer key code, e.g. K_DEL instead of DEL */
2737     int		in_string) /* TRUE when inside a double quoted string */
2738 {
2739     int		modifiers = 0;
2740     int		key;
2741     int		dlen = 0;
2742 
2743     key = find_special_key(srcp, &modifiers, keycode, FALSE, in_string);
2744     if (key == 0)
2745 	return 0;
2746 
2747     /* Put the appropriate modifier in a string */
2748     if (modifiers != 0)
2749     {
2750 	dst[dlen++] = K_SPECIAL;
2751 	dst[dlen++] = KS_MODIFIER;
2752 	dst[dlen++] = modifiers;
2753     }
2754 
2755     if (IS_SPECIAL(key))
2756     {
2757 	dst[dlen++] = K_SPECIAL;
2758 	dst[dlen++] = KEY2TERMCAP0(key);
2759 	dst[dlen++] = KEY2TERMCAP1(key);
2760     }
2761     else if (has_mbyte && !keycode)
2762 	dlen += (*mb_char2bytes)(key, dst + dlen);
2763     else if (keycode)
2764 	dlen = (int)(add_char2buf(key, dst + dlen) - dst);
2765     else
2766 	dst[dlen++] = key;
2767 
2768     return dlen;
2769 }
2770 
2771 /*
2772  * Try translating a <> name at (*srcp)[], return the key and modifiers.
2773  * srcp is advanced to after the <> name.
2774  * returns 0 if there is no match.
2775  */
2776     int
2777 find_special_key(
2778     char_u	**srcp,
2779     int		*modp,
2780     int		keycode,     /* prefer key code, e.g. K_DEL instead of DEL */
2781     int		keep_x_key,  /* don't translate xHome to Home key */
2782     int		in_string)   /* TRUE in string, double quote is escaped */
2783 {
2784     char_u	*last_dash;
2785     char_u	*end_of_name;
2786     char_u	*src;
2787     char_u	*bp;
2788     int		modifiers;
2789     int		bit;
2790     int		key;
2791     uvarnumber_T	n;
2792     int		l;
2793 
2794     src = *srcp;
2795     if (src[0] != '<')
2796 	return 0;
2797 
2798     /* Find end of modifier list */
2799     last_dash = src;
2800     for (bp = src + 1; *bp == '-' || vim_isIDc(*bp); bp++)
2801     {
2802 	if (*bp == '-')
2803 	{
2804 	    last_dash = bp;
2805 	    if (bp[1] != NUL)
2806 	    {
2807 		if (has_mbyte)
2808 		    l = mb_ptr2len(bp + 1);
2809 		else
2810 		    l = 1;
2811 		/* Anything accepted, like <C-?>.
2812 		 * <C-"> or <M-"> are not special in strings as " is
2813 		 * the string delimiter. With a backslash it works: <M-\"> */
2814 		if (!(in_string && bp[1] == '"') && bp[2] == '>')
2815 		    bp += l;
2816 		else if (in_string && bp[1] == '\\' && bp[2] == '"'
2817 							       && bp[3] == '>')
2818 		    bp += 2;
2819 	    }
2820 	}
2821 	if (bp[0] == 't' && bp[1] == '_' && bp[2] && bp[3])
2822 	    bp += 3;	/* skip t_xx, xx may be '-' or '>' */
2823 	else if (STRNICMP(bp, "char-", 5) == 0)
2824 	{
2825 	    vim_str2nr(bp + 5, NULL, &l, STR2NR_ALL, NULL, NULL, 0);
2826 	    bp += l + 5;
2827 	    break;
2828 	}
2829     }
2830 
2831     if (*bp == '>')	/* found matching '>' */
2832     {
2833 	end_of_name = bp + 1;
2834 
2835 	/* Which modifiers are given? */
2836 	modifiers = 0x0;
2837 	for (bp = src + 1; bp < last_dash; bp++)
2838 	{
2839 	    if (*bp != '-')
2840 	    {
2841 		bit = name_to_mod_mask(*bp);
2842 		if (bit == 0x0)
2843 		    break;	/* Illegal modifier name */
2844 		modifiers |= bit;
2845 	    }
2846 	}
2847 
2848 	/*
2849 	 * Legal modifier name.
2850 	 */
2851 	if (bp >= last_dash)
2852 	{
2853 	    if (STRNICMP(last_dash + 1, "char-", 5) == 0
2854 						 && VIM_ISDIGIT(last_dash[6]))
2855 	    {
2856 		/* <Char-123> or <Char-033> or <Char-0x33> */
2857 		vim_str2nr(last_dash + 6, NULL, NULL, STR2NR_ALL, NULL, &n, 0);
2858 		key = (int)n;
2859 	    }
2860 	    else
2861 	    {
2862 		int off = 1;
2863 
2864 		/* Modifier with single letter, or special key name.  */
2865 		if (in_string && last_dash[1] == '\\' && last_dash[2] == '"')
2866 		    off = 2;
2867 		if (has_mbyte)
2868 		    l = mb_ptr2len(last_dash + off);
2869 		else
2870 		    l = 1;
2871 		if (modifiers != 0 && last_dash[l + off] == '>')
2872 		    key = PTR2CHAR(last_dash + off);
2873 		else
2874 		{
2875 		    key = get_special_key_code(last_dash + off);
2876 		    if (!keep_x_key)
2877 			key = handle_x_keys(key);
2878 		}
2879 	    }
2880 
2881 	    /*
2882 	     * get_special_key_code() may return NUL for invalid
2883 	     * special key name.
2884 	     */
2885 	    if (key != NUL)
2886 	    {
2887 		/*
2888 		 * Only use a modifier when there is no special key code that
2889 		 * includes the modifier.
2890 		 */
2891 		key = simplify_key(key, &modifiers);
2892 
2893 		if (!keycode)
2894 		{
2895 		    /* don't want keycode, use single byte code */
2896 		    if (key == K_BS)
2897 			key = BS;
2898 		    else if (key == K_DEL || key == K_KDEL)
2899 			key = DEL;
2900 		}
2901 
2902 		/*
2903 		 * Normal Key with modifier: Try to make a single byte code.
2904 		 */
2905 		if (!IS_SPECIAL(key))
2906 		    key = extract_modifiers(key, &modifiers);
2907 
2908 		*modp = modifiers;
2909 		*srcp = end_of_name;
2910 		return key;
2911 	    }
2912 	}
2913     }
2914     return 0;
2915 }
2916 
2917 /*
2918  * Try to include modifiers in the key.
2919  * Changes "Shift-a" to 'A', "Alt-A" to 0xc0, etc.
2920  */
2921     int
2922 extract_modifiers(int key, int *modp)
2923 {
2924     int	modifiers = *modp;
2925 
2926 #ifdef MACOS_X
2927     /* Command-key really special, no fancynest */
2928     if (!(modifiers & MOD_MASK_CMD))
2929 #endif
2930     if ((modifiers & MOD_MASK_SHIFT) && ASCII_ISALPHA(key))
2931     {
2932 	key = TOUPPER_ASC(key);
2933 	modifiers &= ~MOD_MASK_SHIFT;
2934     }
2935     if ((modifiers & MOD_MASK_CTRL)
2936 #ifdef EBCDIC
2937 	    /* * TODO: EBCDIC Better use:
2938 	     * && (Ctrl_chr(key) || key == '?')
2939 	     * ???  */
2940 	    && strchr("?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_", key)
2941 						       != NULL
2942 #else
2943 	    && ((key >= '?' && key <= '_') || ASCII_ISALPHA(key))
2944 #endif
2945 	    )
2946     {
2947 	key = Ctrl_chr(key);
2948 	modifiers &= ~MOD_MASK_CTRL;
2949 	/* <C-@> is <Nul> */
2950 	if (key == 0)
2951 	    key = K_ZERO;
2952     }
2953 #ifdef MACOS_X
2954     /* Command-key really special, no fancynest */
2955     if (!(modifiers & MOD_MASK_CMD))
2956 #endif
2957     if ((modifiers & MOD_MASK_ALT) && key < 0x80
2958 	    && !enc_dbcs)		// avoid creating a lead byte
2959     {
2960 	key |= 0x80;
2961 	modifiers &= ~MOD_MASK_ALT;	/* remove the META modifier */
2962     }
2963 
2964     *modp = modifiers;
2965     return key;
2966 }
2967 
2968 /*
2969  * Try to find key "c" in the special key table.
2970  * Return the index when found, -1 when not found.
2971  */
2972     int
2973 find_special_key_in_table(int c)
2974 {
2975     int	    i;
2976 
2977     for (i = 0; key_names_table[i].name != NULL; i++)
2978 	if (c == key_names_table[i].key)
2979 	    break;
2980     if (key_names_table[i].name == NULL)
2981 	i = -1;
2982     return i;
2983 }
2984 
2985 /*
2986  * Find the special key with the given name (the given string does not have to
2987  * end with NUL, the name is assumed to end before the first non-idchar).
2988  * If the name starts with "t_" the next two characters are interpreted as a
2989  * termcap name.
2990  * Return the key code, or 0 if not found.
2991  */
2992     int
2993 get_special_key_code(char_u *name)
2994 {
2995     char_u  *table_name;
2996     char_u  string[3];
2997     int	    i, j;
2998 
2999     /*
3000      * If it's <t_xx> we get the code for xx from the termcap
3001      */
3002     if (name[0] == 't' && name[1] == '_' && name[2] != NUL && name[3] != NUL)
3003     {
3004 	string[0] = name[2];
3005 	string[1] = name[3];
3006 	string[2] = NUL;
3007 	if (add_termcap_entry(string, FALSE) == OK)
3008 	    return TERMCAP2KEY(name[2], name[3]);
3009     }
3010     else
3011 	for (i = 0; key_names_table[i].name != NULL; i++)
3012 	{
3013 	    table_name = key_names_table[i].name;
3014 	    for (j = 0; vim_isIDc(name[j]) && table_name[j] != NUL; j++)
3015 		if (TOLOWER_ASC(table_name[j]) != TOLOWER_ASC(name[j]))
3016 		    break;
3017 	    if (!vim_isIDc(name[j]) && table_name[j] == NUL)
3018 		return key_names_table[i].key;
3019 	}
3020     return 0;
3021 }
3022 
3023 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3024     char_u *
3025 get_key_name(int i)
3026 {
3027     if (i >= (int)KEY_NAMES_TABLE_LEN)
3028 	return NULL;
3029     return  key_names_table[i].name;
3030 }
3031 #endif
3032 
3033 #if defined(FEAT_MOUSE) || defined(PROTO)
3034 /*
3035  * Look up the given mouse code to return the relevant information in the other
3036  * arguments.  Return which button is down or was released.
3037  */
3038     int
3039 get_mouse_button(int code, int *is_click, int *is_drag)
3040 {
3041     int	    i;
3042 
3043     for (i = 0; mouse_table[i].pseudo_code; i++)
3044 	if (code == mouse_table[i].pseudo_code)
3045 	{
3046 	    *is_click = mouse_table[i].is_click;
3047 	    *is_drag = mouse_table[i].is_drag;
3048 	    return mouse_table[i].button;
3049 	}
3050     return 0;	    /* Shouldn't get here */
3051 }
3052 
3053 /*
3054  * Return the appropriate pseudo mouse event token (KE_LEFTMOUSE etc) based on
3055  * the given information about which mouse button is down, and whether the
3056  * mouse was clicked, dragged or released.
3057  */
3058     int
3059 get_pseudo_mouse_code(
3060     int	    button,	/* eg MOUSE_LEFT */
3061     int	    is_click,
3062     int	    is_drag)
3063 {
3064     int	    i;
3065 
3066     for (i = 0; mouse_table[i].pseudo_code; i++)
3067 	if (button == mouse_table[i].button
3068 	    && is_click == mouse_table[i].is_click
3069 	    && is_drag == mouse_table[i].is_drag)
3070 	{
3071 #ifdef FEAT_GUI
3072 	    /* Trick: a non mappable left click and release has mouse_col -1
3073 	     * or added MOUSE_COLOFF.  Used for 'mousefocus' in
3074 	     * gui_mouse_moved() */
3075 	    if (mouse_col < 0 || mouse_col > MOUSE_COLOFF)
3076 	    {
3077 		if (mouse_col < 0)
3078 		    mouse_col = 0;
3079 		else
3080 		    mouse_col -= MOUSE_COLOFF;
3081 		if (mouse_table[i].pseudo_code == (int)KE_LEFTMOUSE)
3082 		    return (int)KE_LEFTMOUSE_NM;
3083 		if (mouse_table[i].pseudo_code == (int)KE_LEFTRELEASE)
3084 		    return (int)KE_LEFTRELEASE_NM;
3085 	    }
3086 #endif
3087 	    return mouse_table[i].pseudo_code;
3088 	}
3089     return (int)KE_IGNORE;	    /* not recognized, ignore it */
3090 }
3091 #endif /* FEAT_MOUSE */
3092 
3093 /*
3094  * Return the current end-of-line type: EOL_DOS, EOL_UNIX or EOL_MAC.
3095  */
3096     int
3097 get_fileformat(buf_T *buf)
3098 {
3099     int		c = *buf->b_p_ff;
3100 
3101     if (buf->b_p_bin || c == 'u')
3102 	return EOL_UNIX;
3103     if (c == 'm')
3104 	return EOL_MAC;
3105     return EOL_DOS;
3106 }
3107 
3108 /*
3109  * Like get_fileformat(), but override 'fileformat' with "p" for "++opt=val"
3110  * argument.
3111  */
3112     int
3113 get_fileformat_force(
3114     buf_T	*buf,
3115     exarg_T	*eap)	    /* can be NULL! */
3116 {
3117     int		c;
3118 
3119     if (eap != NULL && eap->force_ff != 0)
3120 	c = eap->force_ff;
3121     else
3122     {
3123 	if ((eap != NULL && eap->force_bin != 0)
3124 			       ? (eap->force_bin == FORCE_BIN) : buf->b_p_bin)
3125 	    return EOL_UNIX;
3126 	c = *buf->b_p_ff;
3127     }
3128     if (c == 'u')
3129 	return EOL_UNIX;
3130     if (c == 'm')
3131 	return EOL_MAC;
3132     return EOL_DOS;
3133 }
3134 
3135 /*
3136  * Set the current end-of-line type to EOL_DOS, EOL_UNIX or EOL_MAC.
3137  * Sets both 'textmode' and 'fileformat'.
3138  * Note: Does _not_ set global value of 'textmode'!
3139  */
3140     void
3141 set_fileformat(
3142     int		t,
3143     int		opt_flags)	/* OPT_LOCAL and/or OPT_GLOBAL */
3144 {
3145     char	*p = NULL;
3146 
3147     switch (t)
3148     {
3149     case EOL_DOS:
3150 	p = FF_DOS;
3151 	curbuf->b_p_tx = TRUE;
3152 	break;
3153     case EOL_UNIX:
3154 	p = FF_UNIX;
3155 	curbuf->b_p_tx = FALSE;
3156 	break;
3157     case EOL_MAC:
3158 	p = FF_MAC;
3159 	curbuf->b_p_tx = FALSE;
3160 	break;
3161     }
3162     if (p != NULL)
3163 	set_string_option_direct((char_u *)"ff", -1, (char_u *)p,
3164 						     OPT_FREE | opt_flags, 0);
3165 
3166     /* This may cause the buffer to become (un)modified. */
3167     check_status(curbuf);
3168     redraw_tabline = TRUE;
3169 #ifdef FEAT_TITLE
3170     need_maketitle = TRUE;	    /* set window title later */
3171 #endif
3172 }
3173 
3174 /*
3175  * Return the default fileformat from 'fileformats'.
3176  */
3177     int
3178 default_fileformat(void)
3179 {
3180     switch (*p_ffs)
3181     {
3182 	case 'm':   return EOL_MAC;
3183 	case 'd':   return EOL_DOS;
3184     }
3185     return EOL_UNIX;
3186 }
3187 
3188 /*
3189  * Call shell.	Calls mch_call_shell, with 'shellxquote' added.
3190  */
3191     int
3192 call_shell(char_u *cmd, int opt)
3193 {
3194     char_u	*ncmd;
3195     int		retval;
3196 #ifdef FEAT_PROFILE
3197     proftime_T	wait_time;
3198 #endif
3199 
3200     if (p_verbose > 3)
3201     {
3202 	verbose_enter();
3203 	smsg(_("Calling shell to execute: \"%s\""),
3204 						    cmd == NULL ? p_sh : cmd);
3205 	out_char('\n');
3206 	cursor_on();
3207 	verbose_leave();
3208     }
3209 
3210 #ifdef FEAT_PROFILE
3211     if (do_profiling == PROF_YES)
3212 	prof_child_enter(&wait_time);
3213 #endif
3214 
3215     if (*p_sh == NUL)
3216     {
3217 	emsg(_(e_shellempty));
3218 	retval = -1;
3219     }
3220     else
3221     {
3222 #ifdef FEAT_GUI_MSWIN
3223 	/* Don't hide the pointer while executing a shell command. */
3224 	gui_mch_mousehide(FALSE);
3225 #endif
3226 #ifdef FEAT_GUI
3227 	++hold_gui_events;
3228 #endif
3229 	/* The external command may update a tags file, clear cached tags. */
3230 	tag_freematch();
3231 
3232 	if (cmd == NULL || *p_sxq == NUL)
3233 	    retval = mch_call_shell(cmd, opt);
3234 	else
3235 	{
3236 	    char_u *ecmd = cmd;
3237 
3238 	    if (*p_sxe != NUL && STRCMP(p_sxq, "(") == 0)
3239 	    {
3240 		ecmd = vim_strsave_escaped_ext(cmd, p_sxe, '^', FALSE);
3241 		if (ecmd == NULL)
3242 		    ecmd = cmd;
3243 	    }
3244 	    ncmd = alloc((unsigned)(STRLEN(ecmd) + STRLEN(p_sxq) * 2 + 1));
3245 	    if (ncmd != NULL)
3246 	    {
3247 		STRCPY(ncmd, p_sxq);
3248 		STRCAT(ncmd, ecmd);
3249 		/* When 'shellxquote' is ( append ).
3250 		 * When 'shellxquote' is "( append )". */
3251 		STRCAT(ncmd, STRCMP(p_sxq, "(") == 0 ? (char_u *)")"
3252 			   : STRCMP(p_sxq, "\"(") == 0 ? (char_u *)")\""
3253 			   : p_sxq);
3254 		retval = mch_call_shell(ncmd, opt);
3255 		vim_free(ncmd);
3256 	    }
3257 	    else
3258 		retval = -1;
3259 	    if (ecmd != cmd)
3260 		vim_free(ecmd);
3261 	}
3262 #ifdef FEAT_GUI
3263 	--hold_gui_events;
3264 #endif
3265 	/*
3266 	 * Check the window size, in case it changed while executing the
3267 	 * external command.
3268 	 */
3269 	shell_resized_check();
3270     }
3271 
3272 #ifdef FEAT_EVAL
3273     set_vim_var_nr(VV_SHELL_ERROR, (long)retval);
3274 # ifdef FEAT_PROFILE
3275     if (do_profiling == PROF_YES)
3276 	prof_child_exit(&wait_time);
3277 # endif
3278 #endif
3279 
3280     return retval;
3281 }
3282 
3283 /*
3284  * VISUAL, SELECTMODE and OP_PENDING State are never set, they are equal to
3285  * NORMAL State with a condition.  This function returns the real State.
3286  */
3287     int
3288 get_real_state(void)
3289 {
3290     if (State & NORMAL)
3291     {
3292 	if (VIsual_active)
3293 	{
3294 	    if (VIsual_select)
3295 		return SELECTMODE;
3296 	    return VISUAL;
3297 	}
3298 	else if (finish_op)
3299 	    return OP_PENDING;
3300     }
3301     return State;
3302 }
3303 
3304 /*
3305  * Return TRUE if "p" points to just after a path separator.
3306  * Takes care of multi-byte characters.
3307  * "b" must point to the start of the file name
3308  */
3309     int
3310 after_pathsep(char_u *b, char_u *p)
3311 {
3312     return p > b && vim_ispathsep(p[-1])
3313 			     && (!has_mbyte || (*mb_head_off)(b, p - 1) == 0);
3314 }
3315 
3316 /*
3317  * Return TRUE if file names "f1" and "f2" are in the same directory.
3318  * "f1" may be a short name, "f2" must be a full path.
3319  */
3320     int
3321 same_directory(char_u *f1, char_u *f2)
3322 {
3323     char_u	ffname[MAXPATHL];
3324     char_u	*t1;
3325     char_u	*t2;
3326 
3327     /* safety check */
3328     if (f1 == NULL || f2 == NULL)
3329 	return FALSE;
3330 
3331     (void)vim_FullName(f1, ffname, MAXPATHL, FALSE);
3332     t1 = gettail_sep(ffname);
3333     t2 = gettail_sep(f2);
3334     return (t1 - ffname == t2 - f2
3335 	     && pathcmp((char *)ffname, (char *)f2, (int)(t1 - ffname)) == 0);
3336 }
3337 
3338 #if defined(FEAT_SESSION) || defined(FEAT_AUTOCHDIR) \
3339 	|| defined(MSWIN) || defined(FEAT_GUI_MAC) || defined(FEAT_GUI_GTK) \
3340 	|| defined(FEAT_NETBEANS_INTG) \
3341 	|| defined(PROTO)
3342 /*
3343  * Change to a file's directory.
3344  * Caller must call shorten_fnames()!
3345  * Return OK or FAIL.
3346  */
3347     int
3348 vim_chdirfile(char_u *fname, char *trigger_autocmd)
3349 {
3350     char_u	old_dir[MAXPATHL];
3351     char_u	new_dir[MAXPATHL];
3352     int		res;
3353 
3354     if (mch_dirname(old_dir, MAXPATHL) != OK)
3355 	*old_dir = NUL;
3356 
3357     vim_strncpy(new_dir, fname, MAXPATHL - 1);
3358     *gettail_sep(new_dir) = NUL;
3359 
3360     if (pathcmp((char *)old_dir, (char *)new_dir, -1) == 0)
3361 	// nothing to do
3362 	res = OK;
3363     else
3364     {
3365 	res = mch_chdir((char *)new_dir) == 0 ? OK : FAIL;
3366 
3367 	if (res == OK && trigger_autocmd != NULL)
3368 	    apply_autocmds(EVENT_DIRCHANGED, (char_u *)trigger_autocmd,
3369 						       new_dir, FALSE, curbuf);
3370     }
3371     return res;
3372 }
3373 #endif
3374 
3375 #if defined(STAT_IGNORES_SLASH) || defined(PROTO)
3376 /*
3377  * Check if "name" ends in a slash and is not a directory.
3378  * Used for systems where stat() ignores a trailing slash on a file name.
3379  * The Vim code assumes a trailing slash is only ignored for a directory.
3380  */
3381     static int
3382 illegal_slash(const char *name)
3383 {
3384     if (name[0] == NUL)
3385 	return FALSE;	    /* no file name is not illegal */
3386     if (name[strlen(name) - 1] != '/')
3387 	return FALSE;	    /* no trailing slash */
3388     if (mch_isdir((char_u *)name))
3389 	return FALSE;	    /* trailing slash for a directory */
3390     return TRUE;
3391 }
3392 
3393 /*
3394  * Special implementation of mch_stat() for Solaris.
3395  */
3396     int
3397 vim_stat(const char *name, stat_T *stp)
3398 {
3399     /* On Solaris stat() accepts "file/" as if it was "file".  Return -1 if
3400      * the name ends in "/" and it's not a directory. */
3401     return illegal_slash(name) ? -1 : stat(name, stp);
3402 }
3403 #endif
3404 
3405 #if defined(CURSOR_SHAPE) || defined(PROTO)
3406 
3407 /*
3408  * Handling of cursor and mouse pointer shapes in various modes.
3409  */
3410 
3411 cursorentry_T shape_table[SHAPE_IDX_COUNT] =
3412 {
3413     /* The values will be filled in from the 'guicursor' and 'mouseshape'
3414      * defaults when Vim starts.
3415      * Adjust the SHAPE_IDX_ defines when making changes! */
3416     {0,	0, 0, 700L, 400L, 250L, 0, 0, "n", SHAPE_CURSOR+SHAPE_MOUSE},
3417     {0,	0, 0, 700L, 400L, 250L, 0, 0, "v", SHAPE_CURSOR+SHAPE_MOUSE},
3418     {0,	0, 0, 700L, 400L, 250L, 0, 0, "i", SHAPE_CURSOR+SHAPE_MOUSE},
3419     {0,	0, 0, 700L, 400L, 250L, 0, 0, "r", SHAPE_CURSOR+SHAPE_MOUSE},
3420     {0,	0, 0, 700L, 400L, 250L, 0, 0, "c", SHAPE_CURSOR+SHAPE_MOUSE},
3421     {0,	0, 0, 700L, 400L, 250L, 0, 0, "ci", SHAPE_CURSOR+SHAPE_MOUSE},
3422     {0,	0, 0, 700L, 400L, 250L, 0, 0, "cr", SHAPE_CURSOR+SHAPE_MOUSE},
3423     {0,	0, 0, 700L, 400L, 250L, 0, 0, "o", SHAPE_CURSOR+SHAPE_MOUSE},
3424     {0,	0, 0, 700L, 400L, 250L, 0, 0, "ve", SHAPE_CURSOR+SHAPE_MOUSE},
3425     {0,	0, 0,   0L,   0L,   0L, 0, 0, "e", SHAPE_MOUSE},
3426     {0,	0, 0,   0L,   0L,   0L, 0, 0, "s", SHAPE_MOUSE},
3427     {0,	0, 0,   0L,   0L,   0L, 0, 0, "sd", SHAPE_MOUSE},
3428     {0,	0, 0,   0L,   0L,   0L, 0, 0, "vs", SHAPE_MOUSE},
3429     {0,	0, 0,   0L,   0L,   0L, 0, 0, "vd", SHAPE_MOUSE},
3430     {0,	0, 0,   0L,   0L,   0L, 0, 0, "m", SHAPE_MOUSE},
3431     {0,	0, 0,   0L,   0L,   0L, 0, 0, "ml", SHAPE_MOUSE},
3432     {0,	0, 0, 100L, 100L, 100L, 0, 0, "sm", SHAPE_CURSOR},
3433 };
3434 
3435 #ifdef FEAT_MOUSESHAPE
3436 /*
3437  * Table with names for mouse shapes.  Keep in sync with all the tables for
3438  * mch_set_mouse_shape()!.
3439  */
3440 static char * mshape_names[] =
3441 {
3442     "arrow",	/* default, must be the first one */
3443     "blank",	/* hidden */
3444     "beam",
3445     "updown",
3446     "udsizing",
3447     "leftright",
3448     "lrsizing",
3449     "busy",
3450     "no",
3451     "crosshair",
3452     "hand1",
3453     "hand2",
3454     "pencil",
3455     "question",
3456     "rightup-arrow",
3457     "up-arrow",
3458     NULL
3459 };
3460 #endif
3461 
3462 /*
3463  * Parse the 'guicursor' option ("what" is SHAPE_CURSOR) or 'mouseshape'
3464  * ("what" is SHAPE_MOUSE).
3465  * Returns error message for an illegal option, NULL otherwise.
3466  */
3467     char *
3468 parse_shape_opt(int what)
3469 {
3470     char_u	*modep;
3471     char_u	*colonp;
3472     char_u	*commap;
3473     char_u	*slashp;
3474     char_u	*p, *endp;
3475     int		idx = 0;		/* init for GCC */
3476     int		all_idx;
3477     int		len;
3478     int		i;
3479     long	n;
3480     int		found_ve = FALSE;	/* found "ve" flag */
3481     int		round;
3482 
3483     /*
3484      * First round: check for errors; second round: do it for real.
3485      */
3486     for (round = 1; round <= 2; ++round)
3487     {
3488 	/*
3489 	 * Repeat for all comma separated parts.
3490 	 */
3491 #ifdef FEAT_MOUSESHAPE
3492 	if (what == SHAPE_MOUSE)
3493 	    modep = p_mouseshape;
3494 	else
3495 #endif
3496 	    modep = p_guicursor;
3497 	while (*modep != NUL)
3498 	{
3499 	    colonp = vim_strchr(modep, ':');
3500 	    commap = vim_strchr(modep, ',');
3501 
3502 	    if (colonp == NULL || (commap != NULL && commap < colonp))
3503 		return N_("E545: Missing colon");
3504 	    if (colonp == modep)
3505 		return N_("E546: Illegal mode");
3506 
3507 	    /*
3508 	     * Repeat for all mode's before the colon.
3509 	     * For the 'a' mode, we loop to handle all the modes.
3510 	     */
3511 	    all_idx = -1;
3512 	    while (modep < colonp || all_idx >= 0)
3513 	    {
3514 		if (all_idx < 0)
3515 		{
3516 		    /* Find the mode. */
3517 		    if (modep[1] == '-' || modep[1] == ':')
3518 			len = 1;
3519 		    else
3520 			len = 2;
3521 		    if (len == 1 && TOLOWER_ASC(modep[0]) == 'a')
3522 			all_idx = SHAPE_IDX_COUNT - 1;
3523 		    else
3524 		    {
3525 			for (idx = 0; idx < SHAPE_IDX_COUNT; ++idx)
3526 			    if (STRNICMP(modep, shape_table[idx].name, len)
3527 									 == 0)
3528 				break;
3529 			if (idx == SHAPE_IDX_COUNT
3530 				   || (shape_table[idx].used_for & what) == 0)
3531 			    return N_("E546: Illegal mode");
3532 			if (len == 2 && modep[0] == 'v' && modep[1] == 'e')
3533 			    found_ve = TRUE;
3534 		    }
3535 		    modep += len + 1;
3536 		}
3537 
3538 		if (all_idx >= 0)
3539 		    idx = all_idx--;
3540 		else if (round == 2)
3541 		{
3542 #ifdef FEAT_MOUSESHAPE
3543 		    if (what == SHAPE_MOUSE)
3544 		    {
3545 			/* Set the default, for the missing parts */
3546 			shape_table[idx].mshape = 0;
3547 		    }
3548 		    else
3549 #endif
3550 		    {
3551 			/* Set the defaults, for the missing parts */
3552 			shape_table[idx].shape = SHAPE_BLOCK;
3553 			shape_table[idx].blinkwait = 700L;
3554 			shape_table[idx].blinkon = 400L;
3555 			shape_table[idx].blinkoff = 250L;
3556 		    }
3557 		}
3558 
3559 		/* Parse the part after the colon */
3560 		for (p = colonp + 1; *p && *p != ','; )
3561 		{
3562 #ifdef FEAT_MOUSESHAPE
3563 		    if (what == SHAPE_MOUSE)
3564 		    {
3565 			for (i = 0; ; ++i)
3566 			{
3567 			    if (mshape_names[i] == NULL)
3568 			    {
3569 				if (!VIM_ISDIGIT(*p))
3570 				    return N_("E547: Illegal mouseshape");
3571 				if (round == 2)
3572 				    shape_table[idx].mshape =
3573 					      getdigits(&p) + MSHAPE_NUMBERED;
3574 				else
3575 				    (void)getdigits(&p);
3576 				break;
3577 			    }
3578 			    len = (int)STRLEN(mshape_names[i]);
3579 			    if (STRNICMP(p, mshape_names[i], len) == 0)
3580 			    {
3581 				if (round == 2)
3582 				    shape_table[idx].mshape = i;
3583 				p += len;
3584 				break;
3585 			    }
3586 			}
3587 		    }
3588 		    else /* if (what == SHAPE_MOUSE) */
3589 #endif
3590 		    {
3591 			/*
3592 			 * First handle the ones with a number argument.
3593 			 */
3594 			i = *p;
3595 			len = 0;
3596 			if (STRNICMP(p, "ver", 3) == 0)
3597 			    len = 3;
3598 			else if (STRNICMP(p, "hor", 3) == 0)
3599 			    len = 3;
3600 			else if (STRNICMP(p, "blinkwait", 9) == 0)
3601 			    len = 9;
3602 			else if (STRNICMP(p, "blinkon", 7) == 0)
3603 			    len = 7;
3604 			else if (STRNICMP(p, "blinkoff", 8) == 0)
3605 			    len = 8;
3606 			if (len != 0)
3607 			{
3608 			    p += len;
3609 			    if (!VIM_ISDIGIT(*p))
3610 				return N_("E548: digit expected");
3611 			    n = getdigits(&p);
3612 			    if (len == 3)   /* "ver" or "hor" */
3613 			    {
3614 				if (n == 0)
3615 				    return N_("E549: Illegal percentage");
3616 				if (round == 2)
3617 				{
3618 				    if (TOLOWER_ASC(i) == 'v')
3619 					shape_table[idx].shape = SHAPE_VER;
3620 				    else
3621 					shape_table[idx].shape = SHAPE_HOR;
3622 				    shape_table[idx].percentage = n;
3623 				}
3624 			    }
3625 			    else if (round == 2)
3626 			    {
3627 				if (len == 9)
3628 				    shape_table[idx].blinkwait = n;
3629 				else if (len == 7)
3630 				    shape_table[idx].blinkon = n;
3631 				else
3632 				    shape_table[idx].blinkoff = n;
3633 			    }
3634 			}
3635 			else if (STRNICMP(p, "block", 5) == 0)
3636 			{
3637 			    if (round == 2)
3638 				shape_table[idx].shape = SHAPE_BLOCK;
3639 			    p += 5;
3640 			}
3641 			else	/* must be a highlight group name then */
3642 			{
3643 			    endp = vim_strchr(p, '-');
3644 			    if (commap == NULL)		    /* last part */
3645 			    {
3646 				if (endp == NULL)
3647 				    endp = p + STRLEN(p);   /* find end of part */
3648 			    }
3649 			    else if (endp > commap || endp == NULL)
3650 				endp = commap;
3651 			    slashp = vim_strchr(p, '/');
3652 			    if (slashp != NULL && slashp < endp)
3653 			    {
3654 				/* "group/langmap_group" */
3655 				i = syn_check_group(p, (int)(slashp - p));
3656 				p = slashp + 1;
3657 			    }
3658 			    if (round == 2)
3659 			    {
3660 				shape_table[idx].id = syn_check_group(p,
3661 							     (int)(endp - p));
3662 				shape_table[idx].id_lm = shape_table[idx].id;
3663 				if (slashp != NULL && slashp < endp)
3664 				    shape_table[idx].id = i;
3665 			    }
3666 			    p = endp;
3667 			}
3668 		    } /* if (what != SHAPE_MOUSE) */
3669 
3670 		    if (*p == '-')
3671 			++p;
3672 		}
3673 	    }
3674 	    modep = p;
3675 	    if (*modep == ',')
3676 		++modep;
3677 	}
3678     }
3679 
3680     /* If the 's' flag is not given, use the 'v' cursor for 's' */
3681     if (!found_ve)
3682     {
3683 #ifdef FEAT_MOUSESHAPE
3684 	if (what == SHAPE_MOUSE)
3685 	{
3686 	    shape_table[SHAPE_IDX_VE].mshape = shape_table[SHAPE_IDX_V].mshape;
3687 	}
3688 	else
3689 #endif
3690 	{
3691 	    shape_table[SHAPE_IDX_VE].shape = shape_table[SHAPE_IDX_V].shape;
3692 	    shape_table[SHAPE_IDX_VE].percentage =
3693 					 shape_table[SHAPE_IDX_V].percentage;
3694 	    shape_table[SHAPE_IDX_VE].blinkwait =
3695 					  shape_table[SHAPE_IDX_V].blinkwait;
3696 	    shape_table[SHAPE_IDX_VE].blinkon =
3697 					    shape_table[SHAPE_IDX_V].blinkon;
3698 	    shape_table[SHAPE_IDX_VE].blinkoff =
3699 					   shape_table[SHAPE_IDX_V].blinkoff;
3700 	    shape_table[SHAPE_IDX_VE].id = shape_table[SHAPE_IDX_V].id;
3701 	    shape_table[SHAPE_IDX_VE].id_lm = shape_table[SHAPE_IDX_V].id_lm;
3702 	}
3703     }
3704 
3705     return NULL;
3706 }
3707 
3708 # if defined(MCH_CURSOR_SHAPE) || defined(FEAT_GUI) \
3709 	|| defined(FEAT_MOUSESHAPE) || defined(PROTO)
3710 /*
3711  * Return the index into shape_table[] for the current mode.
3712  * When "mouse" is TRUE, consider indexes valid for the mouse pointer.
3713  */
3714     int
3715 get_shape_idx(int mouse)
3716 {
3717 #ifdef FEAT_MOUSESHAPE
3718     if (mouse && (State == HITRETURN || State == ASKMORE))
3719     {
3720 # ifdef FEAT_GUI
3721 	int x, y;
3722 	gui_mch_getmouse(&x, &y);
3723 	if (Y_2_ROW(y) == Rows - 1)
3724 	    return SHAPE_IDX_MOREL;
3725 # endif
3726 	return SHAPE_IDX_MORE;
3727     }
3728     if (mouse && drag_status_line)
3729 	return SHAPE_IDX_SDRAG;
3730     if (mouse && drag_sep_line)
3731 	return SHAPE_IDX_VDRAG;
3732 #endif
3733     if (!mouse && State == SHOWMATCH)
3734 	return SHAPE_IDX_SM;
3735     if (State & VREPLACE_FLAG)
3736 	return SHAPE_IDX_R;
3737     if (State & REPLACE_FLAG)
3738 	return SHAPE_IDX_R;
3739     if (State & INSERT)
3740 	return SHAPE_IDX_I;
3741     if (State & CMDLINE)
3742     {
3743 	if (cmdline_at_end())
3744 	    return SHAPE_IDX_C;
3745 	if (cmdline_overstrike())
3746 	    return SHAPE_IDX_CR;
3747 	return SHAPE_IDX_CI;
3748     }
3749     if (finish_op)
3750 	return SHAPE_IDX_O;
3751     if (VIsual_active)
3752     {
3753 	if (*p_sel == 'e')
3754 	    return SHAPE_IDX_VE;
3755 	else
3756 	    return SHAPE_IDX_V;
3757     }
3758     return SHAPE_IDX_N;
3759 }
3760 #endif
3761 
3762 # if defined(FEAT_MOUSESHAPE) || defined(PROTO)
3763 static int old_mouse_shape = 0;
3764 
3765 /*
3766  * Set the mouse shape:
3767  * If "shape" is -1, use shape depending on the current mode,
3768  * depending on the current state.
3769  * If "shape" is -2, only update the shape when it's CLINE or STATUS (used
3770  * when the mouse moves off the status or command line).
3771  */
3772     void
3773 update_mouseshape(int shape_idx)
3774 {
3775     int new_mouse_shape;
3776 
3777     /* Only works in GUI mode. */
3778     if (!gui.in_use || gui.starting)
3779 	return;
3780 
3781     /* Postpone the updating when more is to come.  Speeds up executing of
3782      * mappings. */
3783     if (shape_idx == -1 && char_avail())
3784     {
3785 	postponed_mouseshape = TRUE;
3786 	return;
3787     }
3788 
3789     /* When ignoring the mouse don't change shape on the statusline. */
3790     if (*p_mouse == NUL
3791 	    && (shape_idx == SHAPE_IDX_CLINE
3792 		|| shape_idx == SHAPE_IDX_STATUS
3793 		|| shape_idx == SHAPE_IDX_VSEP))
3794 	shape_idx = -2;
3795 
3796     if (shape_idx == -2
3797 	    && old_mouse_shape != shape_table[SHAPE_IDX_CLINE].mshape
3798 	    && old_mouse_shape != shape_table[SHAPE_IDX_STATUS].mshape
3799 	    && old_mouse_shape != shape_table[SHAPE_IDX_VSEP].mshape)
3800 	return;
3801     if (shape_idx < 0)
3802 	new_mouse_shape = shape_table[get_shape_idx(TRUE)].mshape;
3803     else
3804 	new_mouse_shape = shape_table[shape_idx].mshape;
3805     if (new_mouse_shape != old_mouse_shape)
3806     {
3807 	mch_set_mouse_shape(new_mouse_shape);
3808 	old_mouse_shape = new_mouse_shape;
3809     }
3810     postponed_mouseshape = FALSE;
3811 }
3812 # endif
3813 
3814 #endif /* CURSOR_SHAPE */
3815 
3816 
3817 /*
3818  * Change directory to "new_dir".  If FEAT_SEARCHPATH is defined, search
3819  * 'cdpath' for relative directory names, otherwise just mch_chdir().
3820  */
3821     int
3822 vim_chdir(char_u *new_dir)
3823 {
3824 #ifndef FEAT_SEARCHPATH
3825     return mch_chdir((char *)new_dir);
3826 #else
3827     char_u	*dir_name;
3828     int		r;
3829 
3830     dir_name = find_directory_in_path(new_dir, (int)STRLEN(new_dir),
3831 						FNAME_MESS, curbuf->b_ffname);
3832     if (dir_name == NULL)
3833 	return -1;
3834     r = mch_chdir((char *)dir_name);
3835     vim_free(dir_name);
3836     return r;
3837 #endif
3838 }
3839 
3840 /*
3841  * Get user name from machine-specific function.
3842  * Returns the user name in "buf[len]".
3843  * Some systems are quite slow in obtaining the user name (Windows NT), thus
3844  * cache the result.
3845  * Returns OK or FAIL.
3846  */
3847     int
3848 get_user_name(char_u *buf, int len)
3849 {
3850     if (username == NULL)
3851     {
3852 	if (mch_get_user_name(buf, len) == FAIL)
3853 	    return FAIL;
3854 	username = vim_strsave(buf);
3855     }
3856     else
3857 	vim_strncpy(buf, username, len - 1);
3858     return OK;
3859 }
3860 
3861 #ifndef HAVE_QSORT
3862 /*
3863  * Our own qsort(), for systems that don't have it.
3864  * It's simple and slow.  From the K&R C book.
3865  */
3866     void
3867 qsort(
3868     void	*base,
3869     size_t	elm_count,
3870     size_t	elm_size,
3871     int (*cmp)(const void *, const void *))
3872 {
3873     char_u	*buf;
3874     char_u	*p1;
3875     char_u	*p2;
3876     int		i, j;
3877     int		gap;
3878 
3879     buf = alloc((unsigned)elm_size);
3880     if (buf == NULL)
3881 	return;
3882 
3883     for (gap = elm_count / 2; gap > 0; gap /= 2)
3884 	for (i = gap; i < elm_count; ++i)
3885 	    for (j = i - gap; j >= 0; j -= gap)
3886 	    {
3887 		/* Compare the elements. */
3888 		p1 = (char_u *)base + j * elm_size;
3889 		p2 = (char_u *)base + (j + gap) * elm_size;
3890 		if ((*cmp)((void *)p1, (void *)p2) <= 0)
3891 		    break;
3892 		/* Exchange the elements. */
3893 		mch_memmove(buf, p1, elm_size);
3894 		mch_memmove(p1, p2, elm_size);
3895 		mch_memmove(p2, buf, elm_size);
3896 	    }
3897 
3898     vim_free(buf);
3899 }
3900 #endif
3901 
3902 /*
3903  * Sort an array of strings.
3904  */
3905 static int
3906 #ifdef __BORLANDC__
3907 _RTLENTRYF
3908 #endif
3909 sort_compare(const void *s1, const void *s2);
3910 
3911     static int
3912 #ifdef __BORLANDC__
3913 _RTLENTRYF
3914 #endif
3915 sort_compare(const void *s1, const void *s2)
3916 {
3917     return STRCMP(*(char **)s1, *(char **)s2);
3918 }
3919 
3920     void
3921 sort_strings(
3922     char_u	**files,
3923     int		count)
3924 {
3925     qsort((void *)files, (size_t)count, sizeof(char_u *), sort_compare);
3926 }
3927 
3928 #if !defined(NO_EXPANDPATH) || defined(PROTO)
3929 /*
3930  * Compare path "p[]" to "q[]".
3931  * If "maxlen" >= 0 compare "p[maxlen]" to "q[maxlen]"
3932  * Return value like strcmp(p, q), but consider path separators.
3933  */
3934     int
3935 pathcmp(const char *p, const char *q, int maxlen)
3936 {
3937     int		i, j;
3938     int		c1, c2;
3939     const char	*s = NULL;
3940 
3941     for (i = 0, j = 0; maxlen < 0 || (i < maxlen && j < maxlen);)
3942     {
3943 	c1 = PTR2CHAR((char_u *)p + i);
3944 	c2 = PTR2CHAR((char_u *)q + j);
3945 
3946 	/* End of "p": check if "q" also ends or just has a slash. */
3947 	if (c1 == NUL)
3948 	{
3949 	    if (c2 == NUL)  /* full match */
3950 		return 0;
3951 	    s = q;
3952 	    i = j;
3953 	    break;
3954 	}
3955 
3956 	/* End of "q": check if "p" just has a slash. */
3957 	if (c2 == NUL)
3958 	{
3959 	    s = p;
3960 	    break;
3961 	}
3962 
3963 	if ((p_fic ? MB_TOUPPER(c1) != MB_TOUPPER(c2) : c1 != c2)
3964 #ifdef BACKSLASH_IN_FILENAME
3965 		/* consider '/' and '\\' to be equal */
3966 		&& !((c1 == '/' && c2 == '\\')
3967 		    || (c1 == '\\' && c2 == '/'))
3968 #endif
3969 		)
3970 	{
3971 	    if (vim_ispathsep(c1))
3972 		return -1;
3973 	    if (vim_ispathsep(c2))
3974 		return 1;
3975 	    return p_fic ? MB_TOUPPER(c1) - MB_TOUPPER(c2)
3976 		    : c1 - c2;  /* no match */
3977 	}
3978 
3979 	i += MB_PTR2LEN((char_u *)p + i);
3980 	j += MB_PTR2LEN((char_u *)q + j);
3981     }
3982     if (s == NULL)	/* "i" or "j" ran into "maxlen" */
3983 	return 0;
3984 
3985     c1 = PTR2CHAR((char_u *)s + i);
3986     c2 = PTR2CHAR((char_u *)s + i + MB_PTR2LEN((char_u *)s + i));
3987     /* ignore a trailing slash, but not "//" or ":/" */
3988     if (c2 == NUL
3989 	    && i > 0
3990 	    && !after_pathsep((char_u *)s, (char_u *)s + i)
3991 #ifdef BACKSLASH_IN_FILENAME
3992 	    && (c1 == '/' || c1 == '\\')
3993 #else
3994 	    && c1 == '/'
3995 #endif
3996        )
3997 	return 0;   /* match with trailing slash */
3998     if (s == q)
3999 	return -1;	    /* no match */
4000     return 1;
4001 }
4002 #endif
4003 
4004 /*
4005  * The putenv() implementation below comes from the "screen" program.
4006  * Included with permission from Juergen Weigert.
4007  * See pty.c for the copyright notice.
4008  */
4009 
4010 /*
4011  *  putenv  --	put value into environment
4012  *
4013  *  Usage:  i = putenv (string)
4014  *    int i;
4015  *    char  *string;
4016  *
4017  *  where string is of the form <name>=<value>.
4018  *  Putenv returns 0 normally, -1 on error (not enough core for malloc).
4019  *
4020  *  Putenv may need to add a new name into the environment, or to
4021  *  associate a value longer than the current value with a particular
4022  *  name.  So, to make life simpler, putenv() copies your entire
4023  *  environment into the heap (i.e. malloc()) from the stack
4024  *  (i.e. where it resides when your process is initiated) the first
4025  *  time you call it.
4026  *
4027  *  (history removed, not very interesting.  See the "screen" sources.)
4028  */
4029 
4030 #if !defined(HAVE_SETENV) && !defined(HAVE_PUTENV)
4031 
4032 #define EXTRASIZE 5		/* increment to add to env. size */
4033 
4034 static int  envsize = -1;	/* current size of environment */
4035 extern char **environ;		/* the global which is your env. */
4036 
4037 static int  findenv(char *name); /* look for a name in the env. */
4038 static int  newenv(void);	/* copy env. from stack to heap */
4039 static int  moreenv(void);	/* incr. size of env. */
4040 
4041     int
4042 putenv(const char *string)
4043 {
4044     int	    i;
4045     char    *p;
4046 
4047     if (envsize < 0)
4048     {				/* first time putenv called */
4049 	if (newenv() < 0)	/* copy env. to heap */
4050 	    return -1;
4051     }
4052 
4053     i = findenv((char *)string); /* look for name in environment */
4054 
4055     if (i < 0)
4056     {				/* name must be added */
4057 	for (i = 0; environ[i]; i++);
4058 	if (i >= (envsize - 1))
4059 	{			/* need new slot */
4060 	    if (moreenv() < 0)
4061 		return -1;
4062 	}
4063 	p = (char *)alloc((unsigned)(strlen(string) + 1));
4064 	if (p == NULL)		/* not enough core */
4065 	    return -1;
4066 	environ[i + 1] = 0;	/* new end of env. */
4067     }
4068     else
4069     {				/* name already in env. */
4070 	p = vim_realloc(environ[i], strlen(string) + 1);
4071 	if (p == NULL)
4072 	    return -1;
4073     }
4074     sprintf(p, "%s", string);	/* copy into env. */
4075     environ[i] = p;
4076 
4077     return 0;
4078 }
4079 
4080     static int
4081 findenv(char *name)
4082 {
4083     char    *namechar, *envchar;
4084     int	    i, found;
4085 
4086     found = 0;
4087     for (i = 0; environ[i] && !found; i++)
4088     {
4089 	envchar = environ[i];
4090 	namechar = name;
4091 	while (*namechar && *namechar != '=' && (*namechar == *envchar))
4092 	{
4093 	    namechar++;
4094 	    envchar++;
4095 	}
4096 	found = ((*namechar == '\0' || *namechar == '=') && *envchar == '=');
4097     }
4098     return found ? i - 1 : -1;
4099 }
4100 
4101     static int
4102 newenv(void)
4103 {
4104     char    **env, *elem;
4105     int	    i, esize;
4106 
4107     for (i = 0; environ[i]; i++)
4108 	;
4109 
4110     esize = i + EXTRASIZE + 1;
4111     env = (char **)alloc((unsigned)(esize * sizeof (elem)));
4112     if (env == NULL)
4113 	return -1;
4114 
4115     for (i = 0; environ[i]; i++)
4116     {
4117 	elem = (char *)alloc((unsigned)(strlen(environ[i]) + 1));
4118 	if (elem == NULL)
4119 	    return -1;
4120 	env[i] = elem;
4121 	strcpy(elem, environ[i]);
4122     }
4123 
4124     env[i] = 0;
4125     environ = env;
4126     envsize = esize;
4127     return 0;
4128 }
4129 
4130     static int
4131 moreenv(void)
4132 {
4133     int	    esize;
4134     char    **env;
4135 
4136     esize = envsize + EXTRASIZE;
4137     env = (char **)vim_realloc((char *)environ, esize * sizeof (*env));
4138     if (env == 0)
4139 	return -1;
4140     environ = env;
4141     envsize = esize;
4142     return 0;
4143 }
4144 
4145 # ifdef USE_VIMPTY_GETENV
4146 /*
4147  * Used for mch_getenv() for Mac.
4148  */
4149     char_u *
4150 vimpty_getenv(const char_u *string)
4151 {
4152     int i;
4153     char_u *p;
4154 
4155     if (envsize < 0)
4156 	return NULL;
4157 
4158     i = findenv((char *)string);
4159 
4160     if (i < 0)
4161 	return NULL;
4162 
4163     p = vim_strchr((char_u *)environ[i], '=');
4164     return (p + 1);
4165 }
4166 # endif
4167 
4168 #endif /* !defined(HAVE_SETENV) && !defined(HAVE_PUTENV) */
4169 
4170 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
4171 /*
4172  * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
4173  * rights to write into.
4174  */
4175     int
4176 filewritable(char_u *fname)
4177 {
4178     int		retval = 0;
4179 #if defined(UNIX) || defined(VMS)
4180     int		perm = 0;
4181 #endif
4182 
4183 #if defined(UNIX) || defined(VMS)
4184     perm = mch_getperm(fname);
4185 #endif
4186     if (
4187 # ifdef MSWIN
4188 	    mch_writable(fname) &&
4189 # else
4190 # if defined(UNIX) || defined(VMS)
4191 	    (perm & 0222) &&
4192 #  endif
4193 # endif
4194 	    mch_access((char *)fname, W_OK) == 0
4195        )
4196     {
4197 	++retval;
4198 	if (mch_isdir(fname))
4199 	    ++retval;
4200     }
4201     return retval;
4202 }
4203 #endif
4204 
4205 #if defined(FEAT_SPELL) || defined(FEAT_PERSISTENT_UNDO) || defined(PROTO)
4206 /*
4207  * Read 2 bytes from "fd" and turn them into an int, MSB first.
4208  * Returns -1 when encountering EOF.
4209  */
4210     int
4211 get2c(FILE *fd)
4212 {
4213     int		c, n;
4214 
4215     n = getc(fd);
4216     if (n == EOF) return -1;
4217     c = getc(fd);
4218     if (c == EOF) return -1;
4219     return (n << 8) + c;
4220 }
4221 
4222 /*
4223  * Read 3 bytes from "fd" and turn them into an int, MSB first.
4224  * Returns -1 when encountering EOF.
4225  */
4226     int
4227 get3c(FILE *fd)
4228 {
4229     int		c, n;
4230 
4231     n = getc(fd);
4232     if (n == EOF) return -1;
4233     c = getc(fd);
4234     if (c == EOF) return -1;
4235     n = (n << 8) + c;
4236     c = getc(fd);
4237     if (c == EOF) return -1;
4238     return (n << 8) + c;
4239 }
4240 
4241 /*
4242  * Read 4 bytes from "fd" and turn them into an int, MSB first.
4243  * Returns -1 when encountering EOF.
4244  */
4245     int
4246 get4c(FILE *fd)
4247 {
4248     int		c;
4249     /* Use unsigned rather than int otherwise result is undefined
4250      * when left-shift sets the MSB. */
4251     unsigned	n;
4252 
4253     c = getc(fd);
4254     if (c == EOF) return -1;
4255     n = (unsigned)c;
4256     c = getc(fd);
4257     if (c == EOF) return -1;
4258     n = (n << 8) + (unsigned)c;
4259     c = getc(fd);
4260     if (c == EOF) return -1;
4261     n = (n << 8) + (unsigned)c;
4262     c = getc(fd);
4263     if (c == EOF) return -1;
4264     n = (n << 8) + (unsigned)c;
4265     return (int)n;
4266 }
4267 
4268 /*
4269  * Read 8 bytes from "fd" and turn them into a time_T, MSB first.
4270  * Returns -1 when encountering EOF.
4271  */
4272     time_T
4273 get8ctime(FILE *fd)
4274 {
4275     int		c;
4276     time_T	n = 0;
4277     int		i;
4278 
4279     for (i = 0; i < 8; ++i)
4280     {
4281 	c = getc(fd);
4282 	if (c == EOF) return -1;
4283 	n = (n << 8) + c;
4284     }
4285     return n;
4286 }
4287 
4288 /*
4289  * Read a string of length "cnt" from "fd" into allocated memory.
4290  * Returns NULL when out of memory or unable to read that many bytes.
4291  */
4292     char_u *
4293 read_string(FILE *fd, int cnt)
4294 {
4295     char_u	*str;
4296     int		i;
4297     int		c;
4298 
4299     /* allocate memory */
4300     str = alloc((unsigned)cnt + 1);
4301     if (str != NULL)
4302     {
4303 	/* Read the string.  Quit when running into the EOF. */
4304 	for (i = 0; i < cnt; ++i)
4305 	{
4306 	    c = getc(fd);
4307 	    if (c == EOF)
4308 	    {
4309 		vim_free(str);
4310 		return NULL;
4311 	    }
4312 	    str[i] = c;
4313 	}
4314 	str[i] = NUL;
4315     }
4316     return str;
4317 }
4318 
4319 /*
4320  * Write a number to file "fd", MSB first, in "len" bytes.
4321  */
4322     int
4323 put_bytes(FILE *fd, long_u nr, int len)
4324 {
4325     int	    i;
4326 
4327     for (i = len - 1; i >= 0; --i)
4328 	if (putc((int)(nr >> (i * 8)), fd) == EOF)
4329 	    return FAIL;
4330     return OK;
4331 }
4332 
4333 #ifdef _MSC_VER
4334 # if (_MSC_VER <= 1200)
4335 /* This line is required for VC6 without the service pack.  Also see the
4336  * matching #pragma below. */
4337  #  pragma optimize("", off)
4338 # endif
4339 #endif
4340 
4341 /*
4342  * Write time_T to file "fd" in 8 bytes.
4343  * Returns FAIL when the write failed.
4344  */
4345     int
4346 put_time(FILE *fd, time_T the_time)
4347 {
4348     char_u	buf[8];
4349 
4350     time_to_bytes(the_time, buf);
4351     return fwrite(buf, (size_t)8, (size_t)1, fd) == 1 ? OK : FAIL;
4352 }
4353 
4354 /*
4355  * Write time_T to "buf[8]".
4356  */
4357     void
4358 time_to_bytes(time_T the_time, char_u *buf)
4359 {
4360     int		c;
4361     int		i;
4362     int		bi = 0;
4363     time_T	wtime = the_time;
4364 
4365     /* time_T can be up to 8 bytes in size, more than long_u, thus we
4366      * can't use put_bytes() here.
4367      * Another problem is that ">>" may do an arithmetic shift that keeps the
4368      * sign.  This happens for large values of wtime.  A cast to long_u may
4369      * truncate if time_T is 8 bytes.  So only use a cast when it is 4 bytes,
4370      * it's safe to assume that long_u is 4 bytes or more and when using 8
4371      * bytes the top bit won't be set. */
4372     for (i = 7; i >= 0; --i)
4373     {
4374 	if (i + 1 > (int)sizeof(time_T))
4375 	    /* ">>" doesn't work well when shifting more bits than avail */
4376 	    buf[bi++] = 0;
4377 	else
4378 	{
4379 #if defined(SIZEOF_TIME_T) && SIZEOF_TIME_T > 4
4380 	    c = (int)(wtime >> (i * 8));
4381 #else
4382 	    c = (int)((long_u)wtime >> (i * 8));
4383 #endif
4384 	    buf[bi++] = c;
4385 	}
4386     }
4387 }
4388 
4389 #ifdef _MSC_VER
4390 # if (_MSC_VER <= 1200)
4391  #  pragma optimize("", on)
4392 # endif
4393 #endif
4394 
4395 #endif
4396 
4397 #if defined(FEAT_QUICKFIX) || defined(FEAT_SPELL) || defined(PROTO)
4398 /*
4399  * Return TRUE if string "s" contains a non-ASCII character (128 or higher).
4400  * When "s" is NULL FALSE is returned.
4401  */
4402     int
4403 has_non_ascii(char_u *s)
4404 {
4405     char_u	*p;
4406 
4407     if (s != NULL)
4408 	for (p = s; *p != NUL; ++p)
4409 	    if (*p >= 128)
4410 		return TRUE;
4411     return FALSE;
4412 }
4413 #endif
4414 
4415 #if defined(MESSAGE_QUEUE) || defined(PROTO)
4416 # define MAX_REPEAT_PARSE 8
4417 
4418 /*
4419  * Process messages that have been queued for netbeans or clientserver.
4420  * Also check if any jobs have ended.
4421  * These functions can call arbitrary vimscript and should only be called when
4422  * it is safe to do so.
4423  */
4424     void
4425 parse_queued_messages(void)
4426 {
4427     win_T   *old_curwin = curwin;
4428     int	    i;
4429 
4430     // Do not handle messages while redrawing, because it may cause buffers to
4431     // change or be wiped while they are being redrawn.
4432     if (updating_screen)
4433 	return;
4434 
4435     // Loop when a job ended, but don't keep looping forever.
4436     for (i = 0; i < MAX_REPEAT_PARSE; ++i)
4437     {
4438 	// For Win32 mch_breakcheck() does not check for input, do it here.
4439 # if defined(MSWIN) && defined(FEAT_JOB_CHANNEL)
4440 	channel_handle_events(FALSE);
4441 # endif
4442 
4443 # ifdef FEAT_NETBEANS_INTG
4444 	// Process the queued netbeans messages.
4445 	netbeans_parse_messages();
4446 # endif
4447 # ifdef FEAT_JOB_CHANNEL
4448 	// Write any buffer lines still to be written.
4449 	channel_write_any_lines();
4450 
4451 	// Process the messages queued on channels.
4452 	channel_parse_messages();
4453 # endif
4454 # if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
4455 	// Process the queued clientserver messages.
4456 	server_parse_messages();
4457 # endif
4458 # ifdef FEAT_JOB_CHANNEL
4459 	// Check if any jobs have ended.  If so, repeat the above to handle
4460 	// changes, e.g. stdin may have been closed.
4461 	if (job_check_ended())
4462 	    continue;
4463 # endif
4464 # ifdef FEAT_TERMINAL
4465 	free_unused_terminals();
4466 # endif
4467 	break;
4468     }
4469 
4470     // If the current window changed we need to bail out of the waiting loop.
4471     // E.g. when a job exit callback closes the terminal window.
4472     if (curwin != old_curwin)
4473 	ins_char_typebuf(K_IGNORE);
4474 }
4475 #endif
4476 
4477 #ifndef PROTO  /* proto is defined in vim.h */
4478 # ifdef ELAPSED_TIMEVAL
4479 /*
4480  * Return time in msec since "start_tv".
4481  */
4482     long
4483 elapsed(struct timeval *start_tv)
4484 {
4485     struct timeval  now_tv;
4486 
4487     gettimeofday(&now_tv, NULL);
4488     return (now_tv.tv_sec - start_tv->tv_sec) * 1000L
4489 	 + (now_tv.tv_usec - start_tv->tv_usec) / 1000L;
4490 }
4491 # endif
4492 
4493 # ifdef ELAPSED_TICKCOUNT
4494 /*
4495  * Return time in msec since "start_tick".
4496  */
4497     long
4498 elapsed(DWORD start_tick)
4499 {
4500     DWORD	now = GetTickCount();
4501 
4502     return (long)now - (long)start_tick;
4503 }
4504 # endif
4505 #endif
4506 
4507 #if defined(FEAT_JOB_CHANNEL) \
4508 	|| (defined(UNIX) && (!defined(USE_SYSTEM) \
4509 	|| (defined(FEAT_GUI) && defined(FEAT_TERMINAL)))) \
4510 	|| defined(PROTO)
4511 /*
4512  * Parse "cmd" and put the white-separated parts in "argv".
4513  * "argv" is an allocated array with "argc" entries and room for 4 more.
4514  * Returns FAIL when out of memory.
4515  */
4516     int
4517 mch_parse_cmd(char_u *cmd, int use_shcf, char ***argv, int *argc)
4518 {
4519     int		i;
4520     char_u	*p, *d;
4521     int		inquote;
4522 
4523     /*
4524      * Do this loop twice:
4525      * 1: find number of arguments
4526      * 2: separate them and build argv[]
4527      */
4528     for (i = 0; i < 2; ++i)
4529     {
4530 	p = skipwhite(cmd);
4531 	inquote = FALSE;
4532 	*argc = 0;
4533 	for (;;)
4534 	{
4535 	    if (i == 1)
4536 		(*argv)[*argc] = (char *)p;
4537 	    ++*argc;
4538 	    d = p;
4539 	    while (*p != NUL && (inquote || (*p != ' ' && *p != TAB)))
4540 	    {
4541 		if (p[0] == '"')
4542 		    // quotes surrounding an argument and are dropped
4543 		    inquote = !inquote;
4544 		else
4545 		{
4546 		    if (rem_backslash(p))
4547 		    {
4548 			// First pass: skip over "\ " and "\"".
4549 			// Second pass: Remove the backslash.
4550 			++p;
4551 		    }
4552 		    if (i == 1)
4553 			*d++ = *p;
4554 		}
4555 		++p;
4556 	    }
4557 	    if (*p == NUL)
4558 	    {
4559 		if (i == 1)
4560 		    *d++ = NUL;
4561 		break;
4562 	    }
4563 	    if (i == 1)
4564 		*d++ = NUL;
4565 	    p = skipwhite(p + 1);
4566 	}
4567 	if (*argv == NULL)
4568 	{
4569 	    if (use_shcf)
4570 	    {
4571 		/* Account for possible multiple args in p_shcf. */
4572 		p = p_shcf;
4573 		for (;;)
4574 		{
4575 		    p = skiptowhite(p);
4576 		    if (*p == NUL)
4577 			break;
4578 		    ++*argc;
4579 		    p = skipwhite(p);
4580 		}
4581 	    }
4582 
4583 	    *argv = (char **)alloc((unsigned)((*argc + 4) * sizeof(char *)));
4584 	    if (*argv == NULL)	    /* out of memory */
4585 		return FAIL;
4586 	}
4587     }
4588     return OK;
4589 }
4590 
4591 # if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
4592 /*
4593  * Build "argv[argc]" from the string "cmd".
4594  * "argv[argc]" is set to NULL;
4595  * Return FAIL when out of memory.
4596  */
4597     int
4598 build_argv_from_string(char_u *cmd, char ***argv, int *argc)
4599 {
4600     char_u	*cmd_copy;
4601     int		i;
4602 
4603     /* Make a copy, parsing will modify "cmd". */
4604     cmd_copy = vim_strsave(cmd);
4605     if (cmd_copy == NULL
4606 	    || mch_parse_cmd(cmd_copy, FALSE, argv, argc) == FAIL)
4607     {
4608 	vim_free(cmd_copy);
4609 	return FAIL;
4610     }
4611     for (i = 0; i < *argc; i++)
4612 	(*argv)[i] = (char *)vim_strsave((char_u *)(*argv)[i]);
4613     (*argv)[*argc] = NULL;
4614     vim_free(cmd_copy);
4615     return OK;
4616 }
4617 
4618 /*
4619  * Build "argv[argc]" from the list "l".
4620  * "argv[argc]" is set to NULL;
4621  * Return FAIL when out of memory.
4622  */
4623     int
4624 build_argv_from_list(list_T *l, char ***argv, int *argc)
4625 {
4626     listitem_T  *li;
4627     char_u	*s;
4628 
4629     /* Pass argv[] to mch_call_shell(). */
4630     *argv = (char **)alloc(sizeof(char *) * (l->lv_len + 1));
4631     if (*argv == NULL)
4632 	return FAIL;
4633     *argc = 0;
4634     for (li = l->lv_first; li != NULL; li = li->li_next)
4635     {
4636 	s = tv_get_string_chk(&li->li_tv);
4637 	if (s == NULL)
4638 	{
4639 	    int i;
4640 
4641 	    for (i = 0; i < *argc; ++i)
4642 		vim_free((*argv)[i]);
4643 	    return FAIL;
4644 	}
4645 	(*argv)[*argc] = (char *)vim_strsave(s);
4646 	*argc += 1;
4647     }
4648     (*argv)[*argc] = NULL;
4649     return OK;
4650 }
4651 # endif
4652 #endif
4653