xref: /vim-8.2.3635/src/misc2.c (revision f0d58efc)
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 char_u	*ff_expand_buffer = NULL; /* used for expanding filenames */
18 
19 #if defined(FEAT_VIRTUALEDIT) || defined(PROTO)
20 static int coladvance2(pos_T *pos, int addspaces, int finetune, colnr_T wcol);
21 
22 /*
23  * Return TRUE if in the current mode we need to use virtual.
24  */
25     int
26 virtual_active(void)
27 {
28     /* While an operator is being executed we return "virtual_op", because
29      * VIsual_active has already been reset, thus we can't check for "block"
30      * being used. */
31     if (virtual_op != MAYBE)
32 	return virtual_op;
33     return (ve_flags == VE_ALL
34 	    || ((ve_flags & VE_BLOCK) && VIsual_active && VIsual_mode == Ctrl_V)
35 	    || ((ve_flags & VE_INSERT) && (State & INSERT)));
36 }
37 
38 /*
39  * Get the screen position of the cursor.
40  */
41     int
42 getviscol(void)
43 {
44     colnr_T	x;
45 
46     getvvcol(curwin, &curwin->w_cursor, &x, NULL, NULL);
47     return (int)x;
48 }
49 
50 /*
51  * Get the screen position of character col with a coladd in the cursor line.
52  */
53     int
54 getviscol2(colnr_T col, colnr_T coladd)
55 {
56     colnr_T	x;
57     pos_T	pos;
58 
59     pos.lnum = curwin->w_cursor.lnum;
60     pos.col = col;
61     pos.coladd = coladd;
62     getvvcol(curwin, &pos, &x, NULL, NULL);
63     return (int)x;
64 }
65 
66 /*
67  * Go to column "wcol", and add/insert white space as necessary to get the
68  * cursor in that column.
69  * The caller must have saved the cursor line for undo!
70  */
71     int
72 coladvance_force(colnr_T wcol)
73 {
74     int rc = coladvance2(&curwin->w_cursor, TRUE, FALSE, wcol);
75 
76     if (wcol == MAXCOL)
77 	curwin->w_valid &= ~VALID_VIRTCOL;
78     else
79     {
80 	/* Virtcol is valid */
81 	curwin->w_valid |= VALID_VIRTCOL;
82 	curwin->w_virtcol = wcol;
83     }
84     return rc;
85 }
86 #endif
87 
88 /*
89  * Try to advance the Cursor to the specified screen column.
90  * If virtual editing: fine tune the cursor position.
91  * Note that all virtual positions off the end of a line should share
92  * a curwin->w_cursor.col value (n.b. this is equal to STRLEN(line)),
93  * beginning at coladd 0.
94  *
95  * return OK if desired column is reached, FAIL if not
96  */
97     int
98 coladvance(colnr_T wcol)
99 {
100     int rc = getvpos(&curwin->w_cursor, wcol);
101 
102     if (wcol == MAXCOL || rc == FAIL)
103 	curwin->w_valid &= ~VALID_VIRTCOL;
104     else if (*ml_get_cursor() != TAB)
105     {
106 	/* Virtcol is valid when not on a TAB */
107 	curwin->w_valid |= VALID_VIRTCOL;
108 	curwin->w_virtcol = wcol;
109     }
110     return rc;
111 }
112 
113 /*
114  * Return in "pos" the position of the cursor advanced to screen column "wcol".
115  * return OK if desired column is reached, FAIL if not
116  */
117     int
118 getvpos(pos_T *pos, colnr_T wcol)
119 {
120 #ifdef FEAT_VIRTUALEDIT
121     return coladvance2(pos, FALSE, virtual_active(), wcol);
122 }
123 
124     static int
125 coladvance2(
126     pos_T	*pos,
127     int		addspaces,	/* change the text to achieve our goal? */
128     int		finetune,	/* change char offset for the exact column */
129     colnr_T	wcol)		/* column to move to */
130 {
131 #endif
132     int		idx;
133     char_u	*ptr;
134     char_u	*line;
135     colnr_T	col = 0;
136     int		csize = 0;
137     int		one_more;
138 #ifdef FEAT_LINEBREAK
139     int		head = 0;
140 #endif
141 
142     one_more = (State & INSERT)
143 		    || restart_edit != NUL
144 		    || (VIsual_active && *p_sel != 'o')
145 #ifdef FEAT_VIRTUALEDIT
146 		    || ((ve_flags & VE_ONEMORE) && wcol < MAXCOL)
147 #endif
148 		    ;
149     line = ml_get_buf(curbuf, pos->lnum, FALSE);
150 
151     if (wcol >= MAXCOL)
152     {
153 	    idx = (int)STRLEN(line) - 1 + one_more;
154 	    col = wcol;
155 
156 #ifdef FEAT_VIRTUALEDIT
157 	    if ((addspaces || finetune) && !VIsual_active)
158 	    {
159 		curwin->w_curswant = linetabsize(line) + one_more;
160 		if (curwin->w_curswant > 0)
161 		    --curwin->w_curswant;
162 	    }
163 #endif
164     }
165     else
166     {
167 #ifdef FEAT_VIRTUALEDIT
168 	int width = curwin->w_width - win_col_off(curwin);
169 
170 	if (finetune
171 		&& curwin->w_p_wrap
172 		&& curwin->w_width != 0
173 		&& wcol >= (colnr_T)width)
174 	{
175 	    csize = linetabsize(line);
176 	    if (csize > 0)
177 		csize--;
178 
179 	    if (wcol / width > (colnr_T)csize / width
180 		    && ((State & INSERT) == 0 || (int)wcol > csize + 1))
181 	    {
182 		/* In case of line wrapping don't move the cursor beyond the
183 		 * right screen edge.  In Insert mode allow going just beyond
184 		 * the last character (like what happens when typing and
185 		 * reaching the right window edge). */
186 		wcol = (csize / width + 1) * width - 1;
187 	    }
188 	}
189 #endif
190 
191 	ptr = line;
192 	while (col <= wcol && *ptr != NUL)
193 	{
194 	    /* Count a tab for what it's worth (if list mode not on) */
195 #ifdef FEAT_LINEBREAK
196 	    csize = win_lbr_chartabsize(curwin, line, ptr, col, &head);
197 	    MB_PTR_ADV(ptr);
198 #else
199 	    csize = lbr_chartabsize_adv(line, &ptr, col);
200 #endif
201 	    col += csize;
202 	}
203 	idx = (int)(ptr - line);
204 	/*
205 	 * Handle all the special cases.  The virtual_active() check
206 	 * is needed to ensure that a virtual position off the end of
207 	 * a line has the correct indexing.  The one_more comparison
208 	 * replaces an explicit add of one_more later on.
209 	 */
210 	if (col > wcol || (!virtual_active() && one_more == 0))
211 	{
212 	    idx -= 1;
213 # ifdef FEAT_LINEBREAK
214 	    /* Don't count the chars from 'showbreak'. */
215 	    csize -= head;
216 # endif
217 	    col -= csize;
218 	}
219 
220 #ifdef FEAT_VIRTUALEDIT
221 	if (virtual_active()
222 		&& addspaces
223 		&& ((col != wcol && col != wcol + 1) || csize > 1))
224 	{
225 	    /* 'virtualedit' is set: The difference between wcol and col is
226 	     * filled with spaces. */
227 
228 	    if (line[idx] == NUL)
229 	    {
230 		/* Append spaces */
231 		int	correct = wcol - col;
232 		char_u	*newline = alloc(idx + correct + 1);
233 		int	t;
234 
235 		if (newline == NULL)
236 		    return FAIL;
237 
238 		for (t = 0; t < idx; ++t)
239 		    newline[t] = line[t];
240 
241 		for (t = 0; t < correct; ++t)
242 		    newline[t + idx] = ' ';
243 
244 		newline[idx + correct] = NUL;
245 
246 		ml_replace(pos->lnum, newline, FALSE);
247 		changed_bytes(pos->lnum, (colnr_T)idx);
248 		idx += correct;
249 		col = wcol;
250 	    }
251 	    else
252 	    {
253 		/* Break a tab */
254 		int	linelen = (int)STRLEN(line);
255 		int	correct = wcol - col - csize + 1; /* negative!! */
256 		char_u	*newline;
257 		int	t, s = 0;
258 		int	v;
259 
260 		if (-correct > csize)
261 		    return FAIL;
262 
263 		newline = alloc(linelen + csize);
264 		if (newline == NULL)
265 		    return FAIL;
266 
267 		for (t = 0; t < linelen; t++)
268 		{
269 		    if (t != idx)
270 			newline[s++] = line[t];
271 		    else
272 			for (v = 0; v < csize; v++)
273 			    newline[s++] = ' ';
274 		}
275 
276 		newline[linelen + csize - 1] = NUL;
277 
278 		ml_replace(pos->lnum, newline, FALSE);
279 		changed_bytes(pos->lnum, idx);
280 		idx += (csize - 1 + correct);
281 		col += correct;
282 	    }
283 	}
284 #endif
285     }
286 
287     if (idx < 0)
288 	pos->col = 0;
289     else
290 	pos->col = idx;
291 
292 #ifdef FEAT_VIRTUALEDIT
293     pos->coladd = 0;
294 
295     if (finetune)
296     {
297 	if (wcol == MAXCOL)
298 	{
299 	    /* The width of the last character is used to set coladd. */
300 	    if (!one_more)
301 	    {
302 		colnr_T	    scol, ecol;
303 
304 		getvcol(curwin, pos, &scol, NULL, &ecol);
305 		pos->coladd = ecol - scol;
306 	    }
307 	}
308 	else
309 	{
310 	    int b = (int)wcol - (int)col;
311 
312 	    /* The difference between wcol and col is used to set coladd. */
313 	    if (b > 0 && b < (MAXCOL - 2 * curwin->w_width))
314 		pos->coladd = b;
315 
316 	    col += b;
317 	}
318     }
319 #endif
320 
321 #ifdef FEAT_MBYTE
322     /* prevent from moving onto a trail byte */
323     if (has_mbyte)
324 	mb_adjustpos(curbuf, pos);
325 #endif
326 
327     if (col < wcol)
328 	return FAIL;
329     return OK;
330 }
331 
332 /*
333  * Increment the cursor position.  See inc() for return values.
334  */
335     int
336 inc_cursor(void)
337 {
338     return inc(&curwin->w_cursor);
339 }
340 
341 /*
342  * Increment the line pointer "lp" crossing line boundaries as necessary.
343  * Return 1 when going to the next line.
344  * Return 2 when moving forward onto a NUL at the end of the line).
345  * Return -1 when at the end of file.
346  * Return 0 otherwise.
347  */
348     int
349 inc(pos_T *lp)
350 {
351     char_u  *p;
352 
353     /* when searching position may be set to end of a line */
354     if (lp->col != MAXCOL)
355     {
356 	p = ml_get_pos(lp);
357 	if (*p != NUL)	/* still within line, move to next char (may be NUL) */
358 	{
359 #ifdef FEAT_MBYTE
360 	    if (has_mbyte)
361 	    {
362 		int l = (*mb_ptr2len)(p);
363 
364 		lp->col += l;
365 		return ((p[l] != NUL) ? 0 : 2);
366 	    }
367 #endif
368 	    lp->col++;
369 #ifdef FEAT_VIRTUALEDIT
370 	    lp->coladd = 0;
371 #endif
372 	    return ((p[1] != NUL) ? 0 : 2);
373 	}
374     }
375     if (lp->lnum != curbuf->b_ml.ml_line_count)     /* there is a next line */
376     {
377 	lp->col = 0;
378 	lp->lnum++;
379 #ifdef FEAT_VIRTUALEDIT
380 	lp->coladd = 0;
381 #endif
382 	return 1;
383     }
384     return -1;
385 }
386 
387 /*
388  * incl(lp): same as inc(), but skip the NUL at the end of non-empty lines
389  */
390     int
391 incl(pos_T *lp)
392 {
393     int	    r;
394 
395     if ((r = inc(lp)) >= 1 && lp->col)
396 	r = inc(lp);
397     return r;
398 }
399 
400 /*
401  * dec(p)
402  *
403  * Decrement the line pointer 'p' crossing line boundaries as necessary.
404  * Return 1 when crossing a line, -1 when at start of file, 0 otherwise.
405  */
406     int
407 dec_cursor(void)
408 {
409     return dec(&curwin->w_cursor);
410 }
411 
412     int
413 dec(pos_T *lp)
414 {
415     char_u	*p;
416 
417 #ifdef FEAT_VIRTUALEDIT
418     lp->coladd = 0;
419 #endif
420     if (lp->col == MAXCOL)
421     {
422 	/* past end of line */
423 	p = ml_get(lp->lnum);
424 	lp->col = (colnr_T)STRLEN(p);
425 #ifdef FEAT_MBYTE
426 	if (has_mbyte)
427 	    lp->col -= (*mb_head_off)(p, p + lp->col);
428 #endif
429 	return 0;
430     }
431 
432     if (lp->col > 0)
433     {
434 	/* still within line */
435 	lp->col--;
436 #ifdef FEAT_MBYTE
437 	if (has_mbyte)
438 	{
439 	    p = ml_get(lp->lnum);
440 	    lp->col -= (*mb_head_off)(p, p + lp->col);
441 	}
442 #endif
443 	return 0;
444     }
445 
446     if (lp->lnum > 1)
447     {
448 	/* there is a prior line */
449 	lp->lnum--;
450 	p = ml_get(lp->lnum);
451 	lp->col = (colnr_T)STRLEN(p);
452 #ifdef FEAT_MBYTE
453 	if (has_mbyte)
454 	    lp->col -= (*mb_head_off)(p, p + lp->col);
455 #endif
456 	return 1;
457     }
458 
459     /* at start of file */
460     return -1;
461 }
462 
463 /*
464  * decl(lp): same as dec(), but skip the NUL at the end of non-empty lines
465  */
466     int
467 decl(pos_T *lp)
468 {
469     int	    r;
470 
471     if ((r = dec(lp)) == 1 && lp->col)
472 	r = dec(lp);
473     return r;
474 }
475 
476 /*
477  * Get the line number relative to the current cursor position, i.e. the
478  * difference between line number and cursor position. Only look for lines that
479  * can be visible, folded lines don't count.
480  */
481     linenr_T
482 get_cursor_rel_lnum(
483     win_T	*wp,
484     linenr_T	lnum)		    /* line number to get the result for */
485 {
486     linenr_T	cursor = wp->w_cursor.lnum;
487     linenr_T	retval = 0;
488 
489 #ifdef FEAT_FOLDING
490     if (hasAnyFolding(wp))
491     {
492 	if (lnum > cursor)
493 	{
494 	    while (lnum > cursor)
495 	    {
496 		(void)hasFoldingWin(wp, lnum, &lnum, NULL, TRUE, NULL);
497 		/* if lnum and cursor are in the same fold,
498 		 * now lnum <= cursor */
499 		if (lnum > cursor)
500 		    retval++;
501 		lnum--;
502 	    }
503 	}
504 	else if (lnum < cursor)
505 	{
506 	    while (lnum < cursor)
507 	    {
508 		(void)hasFoldingWin(wp, lnum, NULL, &lnum, TRUE, NULL);
509 		/* if lnum and cursor are in the same fold,
510 		 * now lnum >= cursor */
511 		if (lnum < cursor)
512 		    retval--;
513 		lnum++;
514 	    }
515 	}
516 	/* else if (lnum == cursor)
517 	 *     retval = 0;
518 	 */
519     }
520     else
521 #endif
522 	retval = lnum - cursor;
523 
524     return retval;
525 }
526 
527 /*
528  * Make sure "pos.lnum" and "pos.col" are valid in "buf".
529  * This allows for the col to be on the NUL byte.
530  */
531     void
532 check_pos(buf_T *buf, pos_T *pos)
533 {
534     char_u *line;
535     colnr_T len;
536 
537     if (pos->lnum > buf->b_ml.ml_line_count)
538 	pos->lnum = buf->b_ml.ml_line_count;
539 
540     if (pos->col > 0)
541     {
542 	line = ml_get_buf(buf, pos->lnum, FALSE);
543 	len = (colnr_T)STRLEN(line);
544 	if (pos->col > len)
545 	    pos->col = len;
546     }
547 }
548 
549 /*
550  * Make sure curwin->w_cursor.lnum is valid.
551  */
552     void
553 check_cursor_lnum(void)
554 {
555     if (curwin->w_cursor.lnum > curbuf->b_ml.ml_line_count)
556     {
557 #ifdef FEAT_FOLDING
558 	/* If there is a closed fold at the end of the file, put the cursor in
559 	 * its first line.  Otherwise in the last line. */
560 	if (!hasFolding(curbuf->b_ml.ml_line_count,
561 						&curwin->w_cursor.lnum, NULL))
562 #endif
563 	    curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
564     }
565     if (curwin->w_cursor.lnum <= 0)
566 	curwin->w_cursor.lnum = 1;
567 }
568 
569 /*
570  * Make sure curwin->w_cursor.col is valid.
571  */
572     void
573 check_cursor_col(void)
574 {
575     check_cursor_col_win(curwin);
576 }
577 
578 /*
579  * Make sure win->w_cursor.col is valid.
580  */
581     void
582 check_cursor_col_win(win_T *win)
583 {
584     colnr_T len;
585 #ifdef FEAT_VIRTUALEDIT
586     colnr_T oldcol = win->w_cursor.col;
587     colnr_T oldcoladd = win->w_cursor.col + win->w_cursor.coladd;
588 #endif
589 
590     len = (colnr_T)STRLEN(ml_get_buf(win->w_buffer, win->w_cursor.lnum, FALSE));
591     if (len == 0)
592 	win->w_cursor.col = 0;
593     else if (win->w_cursor.col >= len)
594     {
595 	/* Allow cursor past end-of-line when:
596 	 * - in Insert mode or restarting Insert mode
597 	 * - in Visual mode and 'selection' isn't "old"
598 	 * - 'virtualedit' is set */
599 	if ((State & INSERT) || restart_edit
600 		|| (VIsual_active && *p_sel != 'o')
601 #ifdef FEAT_VIRTUALEDIT
602 		|| (ve_flags & VE_ONEMORE)
603 #endif
604 		|| virtual_active())
605 	    win->w_cursor.col = len;
606 	else
607 	{
608 	    win->w_cursor.col = len - 1;
609 #ifdef FEAT_MBYTE
610 	    /* Move the cursor to the head byte. */
611 	    if (has_mbyte)
612 		mb_adjustpos(win->w_buffer, &win->w_cursor);
613 #endif
614 	}
615     }
616     else if (win->w_cursor.col < 0)
617 	win->w_cursor.col = 0;
618 
619 #ifdef FEAT_VIRTUALEDIT
620     /* If virtual editing is on, we can leave the cursor on the old position,
621      * only we must set it to virtual.  But don't do it when at the end of the
622      * line. */
623     if (oldcol == MAXCOL)
624 	win->w_cursor.coladd = 0;
625     else if (ve_flags == VE_ALL)
626     {
627 	if (oldcoladd > win->w_cursor.col)
628 	{
629 	    win->w_cursor.coladd = oldcoladd - win->w_cursor.col;
630 
631 	    /* Make sure that coladd is not more than the char width.
632 	     * Not for the last character, coladd is then used when the cursor
633 	     * is actually after the last character. */
634 	    if (win->w_cursor.col + 1 < len && win->w_cursor.coladd > 0)
635 	    {
636 		int cs, ce;
637 
638 		getvcol(win, &win->w_cursor, &cs, NULL, &ce);
639 		if (win->w_cursor.coladd > ce - cs)
640 		    win->w_cursor.coladd = ce - cs;
641 	    }
642 	}
643 	else
644 	    /* avoid weird number when there is a miscalculation or overflow */
645 	    win->w_cursor.coladd = 0;
646     }
647 #endif
648 }
649 
650 /*
651  * make sure curwin->w_cursor in on a valid character
652  */
653     void
654 check_cursor(void)
655 {
656     check_cursor_lnum();
657     check_cursor_col();
658 }
659 
660 #if defined(FEAT_TEXTOBJ) || defined(PROTO)
661 /*
662  * Make sure curwin->w_cursor is not on the NUL at the end of the line.
663  * Allow it when in Visual mode and 'selection' is not "old".
664  */
665     void
666 adjust_cursor_col(void)
667 {
668     if (curwin->w_cursor.col > 0
669 	    && (!VIsual_active || *p_sel == 'o')
670 	    && gchar_cursor() == NUL)
671 	--curwin->w_cursor.col;
672 }
673 #endif
674 
675 /*
676  * When curwin->w_leftcol has changed, adjust the cursor position.
677  * Return TRUE if the cursor was moved.
678  */
679     int
680 leftcol_changed(void)
681 {
682     long	lastcol;
683     colnr_T	s, e;
684     int		retval = FALSE;
685 
686     changed_cline_bef_curs();
687     lastcol = curwin->w_leftcol + curwin->w_width - curwin_col_off() - 1;
688     validate_virtcol();
689 
690     /*
691      * If the cursor is right or left of the screen, move it to last or first
692      * character.
693      */
694     if (curwin->w_virtcol > (colnr_T)(lastcol - p_siso))
695     {
696 	retval = TRUE;
697 	coladvance((colnr_T)(lastcol - p_siso));
698     }
699     else if (curwin->w_virtcol < curwin->w_leftcol + p_siso)
700     {
701 	retval = TRUE;
702 	(void)coladvance((colnr_T)(curwin->w_leftcol + p_siso));
703     }
704 
705     /*
706      * If the start of the character under the cursor is not on the screen,
707      * advance the cursor one more char.  If this fails (last char of the
708      * line) adjust the scrolling.
709      */
710     getvvcol(curwin, &curwin->w_cursor, &s, NULL, &e);
711     if (e > (colnr_T)lastcol)
712     {
713 	retval = TRUE;
714 	coladvance(s - 1);
715     }
716     else if (s < curwin->w_leftcol)
717     {
718 	retval = TRUE;
719 	if (coladvance(e + 1) == FAIL)	/* there isn't another character */
720 	{
721 	    curwin->w_leftcol = s;	/* adjust w_leftcol instead */
722 	    changed_cline_bef_curs();
723 	}
724     }
725 
726     if (retval)
727 	curwin->w_set_curswant = TRUE;
728     redraw_later(NOT_VALID);
729     return retval;
730 }
731 
732 /**********************************************************************
733  * Various routines dealing with allocation and deallocation of memory.
734  */
735 
736 #if defined(MEM_PROFILE) || defined(PROTO)
737 
738 # define MEM_SIZES  8200
739 static long_u mem_allocs[MEM_SIZES];
740 static long_u mem_frees[MEM_SIZES];
741 static long_u mem_allocated;
742 static long_u mem_freed;
743 static long_u mem_peak;
744 static long_u num_alloc;
745 static long_u num_freed;
746 
747     static void
748 mem_pre_alloc_s(size_t *sizep)
749 {
750     *sizep += sizeof(size_t);
751 }
752 
753     static void
754 mem_pre_alloc_l(long_u *sizep)
755 {
756     *sizep += sizeof(size_t);
757 }
758 
759     static void
760 mem_post_alloc(
761     void **pp,
762     size_t size)
763 {
764     if (*pp == NULL)
765 	return;
766     size -= sizeof(size_t);
767     *(long_u *)*pp = size;
768     if (size <= MEM_SIZES-1)
769 	mem_allocs[size-1]++;
770     else
771 	mem_allocs[MEM_SIZES-1]++;
772     mem_allocated += size;
773     if (mem_allocated - mem_freed > mem_peak)
774 	mem_peak = mem_allocated - mem_freed;
775     num_alloc++;
776     *pp = (void *)((char *)*pp + sizeof(size_t));
777 }
778 
779     static void
780 mem_pre_free(void **pp)
781 {
782     long_u size;
783 
784     *pp = (void *)((char *)*pp - sizeof(size_t));
785     size = *(size_t *)*pp;
786     if (size <= MEM_SIZES-1)
787 	mem_frees[size-1]++;
788     else
789 	mem_frees[MEM_SIZES-1]++;
790     mem_freed += size;
791     num_freed++;
792 }
793 
794 /*
795  * called on exit via atexit()
796  */
797     void
798 vim_mem_profile_dump(void)
799 {
800     int i, j;
801 
802     printf("\r\n");
803     j = 0;
804     for (i = 0; i < MEM_SIZES - 1; i++)
805     {
806 	if (mem_allocs[i] || mem_frees[i])
807 	{
808 	    if (mem_frees[i] > mem_allocs[i])
809 		printf("\r\n%s", _("ERROR: "));
810 	    printf("[%4d / %4lu-%-4lu] ", i + 1, mem_allocs[i], mem_frees[i]);
811 	    j++;
812 	    if (j > 3)
813 	    {
814 		j = 0;
815 		printf("\r\n");
816 	    }
817 	}
818     }
819 
820     i = MEM_SIZES - 1;
821     if (mem_allocs[i])
822     {
823 	printf("\r\n");
824 	if (mem_frees[i] > mem_allocs[i])
825 	    puts(_("ERROR: "));
826 	printf("[>%d / %4lu-%-4lu]", i, mem_allocs[i], mem_frees[i]);
827     }
828 
829     printf(_("\n[bytes] total alloc-freed %lu-%lu, in use %lu, peak use %lu\n"),
830 	    mem_allocated, mem_freed, mem_allocated - mem_freed, mem_peak);
831     printf(_("[calls] total re/malloc()'s %lu, total free()'s %lu\n\n"),
832 	    num_alloc, num_freed);
833 }
834 
835 #endif /* MEM_PROFILE */
836 
837 #ifdef FEAT_EVAL
838     int
839 alloc_does_fail(long_u size)
840 {
841     if (alloc_fail_countdown == 0)
842     {
843 	if (--alloc_fail_repeat <= 0)
844 	    alloc_fail_id = 0;
845 	do_outofmem_msg(size);
846 	return TRUE;
847     }
848     --alloc_fail_countdown;
849     return FALSE;
850 }
851 #endif
852 
853 /*
854  * Some memory is reserved for error messages and for being able to
855  * call mf_release_all(), which needs some memory for mf_trans_add().
856  */
857 #define KEEP_ROOM (2 * 8192L)
858 #define KEEP_ROOM_KB (KEEP_ROOM / 1024L)
859 
860 /*
861  * Note: if unsigned is 16 bits we can only allocate up to 64K with alloc().
862  * Use lalloc for larger blocks.
863  */
864     char_u *
865 alloc(unsigned size)
866 {
867     return (lalloc((long_u)size, TRUE));
868 }
869 
870 /*
871  * alloc() with an ID for alloc_fail().
872  */
873     char_u *
874 alloc_id(unsigned size, alloc_id_T id UNUSED)
875 {
876 #ifdef FEAT_EVAL
877     if (alloc_fail_id == id && alloc_does_fail((long_u)size))
878 	return NULL;
879 #endif
880     return (lalloc((long_u)size, TRUE));
881 }
882 
883 /*
884  * Allocate memory and set all bytes to zero.
885  */
886     char_u *
887 alloc_clear(unsigned size)
888 {
889     char_u *p;
890 
891     p = lalloc((long_u)size, TRUE);
892     if (p != NULL)
893 	(void)vim_memset(p, 0, (size_t)size);
894     return p;
895 }
896 
897 /*
898  * alloc() with check for maximum line length
899  */
900     char_u *
901 alloc_check(unsigned size)
902 {
903 #if !defined(UNIX)
904     if (sizeof(int) == 2 && size > 0x7fff)
905     {
906 	/* Don't hide this message */
907 	emsg_silent = 0;
908 	EMSG(_("E340: Line is becoming too long"));
909 	return NULL;
910     }
911 #endif
912     return (lalloc((long_u)size, TRUE));
913 }
914 
915 /*
916  * Allocate memory like lalloc() and set all bytes to zero.
917  */
918     char_u *
919 lalloc_clear(long_u size, int message)
920 {
921     char_u *p;
922 
923     p = (lalloc(size, message));
924     if (p != NULL)
925 	(void)vim_memset(p, 0, (size_t)size);
926     return p;
927 }
928 
929 /*
930  * Low level memory allocation function.
931  * This is used often, KEEP IT FAST!
932  */
933     char_u *
934 lalloc(long_u size, int message)
935 {
936     char_u	*p;		    /* pointer to new storage space */
937     static int	releasing = FALSE;  /* don't do mf_release_all() recursive */
938     int		try_again;
939 #if defined(HAVE_AVAIL_MEM)
940     static long_u allocated = 0;    /* allocated since last avail check */
941 #endif
942 
943     /* Safety check for allocating zero bytes */
944     if (size == 0)
945     {
946 	/* Don't hide this message */
947 	emsg_silent = 0;
948 	IEMSGN(_("E341: Internal error: lalloc(%ld, )"), size);
949 	return NULL;
950     }
951 
952 #ifdef MEM_PROFILE
953     mem_pre_alloc_l(&size);
954 #endif
955 
956     /*
957      * Loop when out of memory: Try to release some memfile blocks and
958      * if some blocks are released call malloc again.
959      */
960     for (;;)
961     {
962 	/*
963 	 * Handle three kind of systems:
964 	 * 1. No check for available memory: Just return.
965 	 * 2. Slow check for available memory: call mch_avail_mem() after
966 	 *    allocating KEEP_ROOM amount of memory.
967 	 * 3. Strict check for available memory: call mch_avail_mem()
968 	 */
969 	if ((p = (char_u *)malloc((size_t)size)) != NULL)
970 	{
971 #ifndef HAVE_AVAIL_MEM
972 	    /* 1. No check for available memory: Just return. */
973 	    goto theend;
974 #else
975 	    /* 2. Slow check for available memory: call mch_avail_mem() after
976 	     *    allocating (KEEP_ROOM / 2) amount of memory. */
977 	    allocated += size;
978 	    if (allocated < KEEP_ROOM / 2)
979 		goto theend;
980 	    allocated = 0;
981 
982 	    /* 3. check for available memory: call mch_avail_mem() */
983 	    if (mch_avail_mem(TRUE) < KEEP_ROOM_KB && !releasing)
984 	    {
985 		free((char *)p);	/* System is low... no go! */
986 		p = NULL;
987 	    }
988 	    else
989 		goto theend;
990 #endif
991 	}
992 	/*
993 	 * Remember that mf_release_all() is being called to avoid an endless
994 	 * loop, because mf_release_all() may call alloc() recursively.
995 	 */
996 	if (releasing)
997 	    break;
998 	releasing = TRUE;
999 
1000 	clear_sb_text(TRUE);	      /* free any scrollback text */
1001 	try_again = mf_release_all(); /* release as many blocks as possible */
1002 
1003 	releasing = FALSE;
1004 	if (!try_again)
1005 	    break;
1006     }
1007 
1008     if (message && p == NULL)
1009 	do_outofmem_msg(size);
1010 
1011 theend:
1012 #ifdef MEM_PROFILE
1013     mem_post_alloc((void **)&p, (size_t)size);
1014 #endif
1015     return p;
1016 }
1017 
1018 /*
1019  * lalloc() with an ID for alloc_fail().
1020  */
1021     char_u *
1022 lalloc_id(long_u size, int message, alloc_id_T id UNUSED)
1023 {
1024 #ifdef FEAT_EVAL
1025     if (alloc_fail_id == id && alloc_does_fail(size))
1026 	return NULL;
1027 #endif
1028     return (lalloc((long_u)size, message));
1029 }
1030 
1031 #if defined(MEM_PROFILE) || defined(PROTO)
1032 /*
1033  * realloc() with memory profiling.
1034  */
1035     void *
1036 mem_realloc(void *ptr, size_t size)
1037 {
1038     void *p;
1039 
1040     mem_pre_free(&ptr);
1041     mem_pre_alloc_s(&size);
1042 
1043     p = realloc(ptr, size);
1044 
1045     mem_post_alloc(&p, size);
1046 
1047     return p;
1048 }
1049 #endif
1050 
1051 /*
1052 * Avoid repeating the error message many times (they take 1 second each).
1053 * Did_outofmem_msg is reset when a character is read.
1054 */
1055     void
1056 do_outofmem_msg(long_u size)
1057 {
1058     if (!did_outofmem_msg)
1059     {
1060 	/* Don't hide this message */
1061 	emsg_silent = 0;
1062 
1063 	/* Must come first to avoid coming back here when printing the error
1064 	 * message fails, e.g. when setting v:errmsg. */
1065 	did_outofmem_msg = TRUE;
1066 
1067 	EMSGN(_("E342: Out of memory!  (allocating %lu bytes)"), size);
1068     }
1069 }
1070 
1071 #if defined(EXITFREE) || defined(PROTO)
1072 
1073 # if defined(FEAT_SEARCHPATH)
1074 static void free_findfile(void);
1075 # endif
1076 
1077 /*
1078  * Free everything that we allocated.
1079  * Can be used to detect memory leaks, e.g., with ccmalloc.
1080  * NOTE: This is tricky!  Things are freed that functions depend on.  Don't be
1081  * surprised if Vim crashes...
1082  * Some things can't be freed, esp. things local to a library function.
1083  */
1084     void
1085 free_all_mem(void)
1086 {
1087     buf_T	*buf, *nextbuf;
1088 
1089     /* When we cause a crash here it is caught and Vim tries to exit cleanly.
1090      * Don't try freeing everything again. */
1091     if (entered_free_all_mem)
1092 	return;
1093     entered_free_all_mem = TRUE;
1094 
1095     /* Don't want to trigger autocommands from here on. */
1096     block_autocmds();
1097 
1098     /* Close all tabs and windows.  Reset 'equalalways' to avoid redraws. */
1099     p_ea = FALSE;
1100     if (first_tabpage->tp_next != NULL)
1101 	do_cmdline_cmd((char_u *)"tabonly!");
1102     if (!ONE_WINDOW)
1103 	do_cmdline_cmd((char_u *)"only!");
1104 
1105 # if defined(FEAT_SPELL)
1106     /* Free all spell info. */
1107     spell_free_all();
1108 # endif
1109 
1110 #if defined(FEAT_INS_EXPAND) && defined(FEAT_BEVAL_TERM)
1111     ui_remove_balloon();
1112 # endif
1113 
1114 # if defined(FEAT_USR_CMDS)
1115     /* Clear user commands (before deleting buffers). */
1116     ex_comclear(NULL);
1117 # endif
1118 
1119 # ifdef FEAT_MENU
1120     /* Clear menus. */
1121     do_cmdline_cmd((char_u *)"aunmenu *");
1122 #  ifdef FEAT_MULTI_LANG
1123     do_cmdline_cmd((char_u *)"menutranslate clear");
1124 #  endif
1125 # endif
1126 
1127     /* Clear mappings, abbreviations, breakpoints. */
1128     do_cmdline_cmd((char_u *)"lmapclear");
1129     do_cmdline_cmd((char_u *)"xmapclear");
1130     do_cmdline_cmd((char_u *)"mapclear");
1131     do_cmdline_cmd((char_u *)"mapclear!");
1132     do_cmdline_cmd((char_u *)"abclear");
1133 # if defined(FEAT_EVAL)
1134     do_cmdline_cmd((char_u *)"breakdel *");
1135 # endif
1136 # if defined(FEAT_PROFILE)
1137     do_cmdline_cmd((char_u *)"profdel *");
1138 # endif
1139 # if defined(FEAT_KEYMAP)
1140     do_cmdline_cmd((char_u *)"set keymap=");
1141 #endif
1142 
1143 # ifdef FEAT_TITLE
1144     free_titles();
1145 # endif
1146 # if defined(FEAT_SEARCHPATH)
1147     free_findfile();
1148 # endif
1149 
1150     /* Obviously named calls. */
1151     free_all_autocmds();
1152     clear_termcodes();
1153     free_all_marks();
1154     alist_clear(&global_alist);
1155     free_homedir();
1156 # if defined(FEAT_CMDL_COMPL)
1157     free_users();
1158 # endif
1159     free_search_patterns();
1160     free_old_sub();
1161     free_last_insert();
1162     free_prev_shellcmd();
1163     free_regexp_stuff();
1164     free_tag_stuff();
1165     free_cd_dir();
1166 # ifdef FEAT_SIGNS
1167     free_signs();
1168 # endif
1169 # ifdef FEAT_EVAL
1170     set_expr_line(NULL);
1171 # endif
1172 # ifdef FEAT_DIFF
1173     diff_clear(curtab);
1174 # endif
1175     clear_sb_text(TRUE);	      /* free any scrollback text */
1176 
1177     /* Free some global vars. */
1178     vim_free(username);
1179 # ifdef FEAT_CLIPBOARD
1180     vim_regfree(clip_exclude_prog);
1181 # endif
1182     vim_free(last_cmdline);
1183 # ifdef FEAT_CMDHIST
1184     vim_free(new_last_cmdline);
1185 # endif
1186     set_keep_msg(NULL, 0);
1187     vim_free(ff_expand_buffer);
1188 
1189     /* Clear cmdline history. */
1190     p_hi = 0;
1191 # ifdef FEAT_CMDHIST
1192     init_history();
1193 # endif
1194 
1195 #ifdef FEAT_QUICKFIX
1196     {
1197 	win_T	    *win;
1198 	tabpage_T   *tab;
1199 
1200 	qf_free_all(NULL);
1201 	/* Free all location lists */
1202 	FOR_ALL_TAB_WINDOWS(tab, win)
1203 	    qf_free_all(win);
1204     }
1205 #endif
1206 
1207     /* Close all script inputs. */
1208     close_all_scripts();
1209 
1210     /* Destroy all windows.  Must come before freeing buffers. */
1211     win_free_all();
1212 
1213     /* Free all option values.  Must come after closing windows. */
1214     free_all_options();
1215 
1216     /* Free all buffers.  Reset 'autochdir' to avoid accessing things that
1217      * were freed already. */
1218 #ifdef FEAT_AUTOCHDIR
1219     p_acd = FALSE;
1220 #endif
1221     for (buf = firstbuf; buf != NULL; )
1222     {
1223 	bufref_T    bufref;
1224 
1225 	set_bufref(&bufref, buf);
1226 	nextbuf = buf->b_next;
1227 	close_buffer(NULL, buf, DOBUF_WIPE, FALSE);
1228 	if (bufref_valid(&bufref))
1229 	    buf = nextbuf;	/* didn't work, try next one */
1230 	else
1231 	    buf = firstbuf;
1232     }
1233 
1234 # ifdef FEAT_ARABIC
1235     free_cmdline_buf();
1236 # endif
1237 
1238     /* Clear registers. */
1239     clear_registers();
1240     ResetRedobuff();
1241     ResetRedobuff();
1242 
1243 # if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
1244     vim_free(serverDelayedStartName);
1245 # endif
1246 
1247     /* highlight info */
1248     free_highlight();
1249 
1250     reset_last_sourcing();
1251 
1252     free_tabpage(first_tabpage);
1253     first_tabpage = NULL;
1254 
1255 # ifdef UNIX
1256     /* Machine-specific free. */
1257     mch_free_mem();
1258 # endif
1259 
1260     /* message history */
1261     for (;;)
1262 	if (delete_first_msg() == FAIL)
1263 	    break;
1264 
1265 # ifdef FEAT_JOB_CHANNEL
1266     channel_free_all();
1267 # endif
1268 # ifdef FEAT_TIMERS
1269     timer_free_all();
1270 # endif
1271 # ifdef FEAT_EVAL
1272     /* must be after channel_free_all() with unrefs partials */
1273     eval_clear();
1274 # endif
1275 # ifdef FEAT_JOB_CHANNEL
1276     /* must be after eval_clear() with unrefs jobs */
1277     job_free_all();
1278 # endif
1279 
1280     free_termoptions();
1281 
1282     /* screenlines (can't display anything now!) */
1283     free_screenlines();
1284 
1285 # if defined(USE_XSMP)
1286     xsmp_close();
1287 # endif
1288 # ifdef FEAT_GUI_GTK
1289     gui_mch_free_all();
1290 # endif
1291     clear_hl_tables();
1292 
1293     vim_free(IObuff);
1294     vim_free(NameBuff);
1295 # ifdef FEAT_QUICKFIX
1296     check_quickfix_busy();
1297 # endif
1298 }
1299 #endif
1300 
1301 /*
1302  * Copy "string" into newly allocated memory.
1303  */
1304     char_u *
1305 vim_strsave(char_u *string)
1306 {
1307     char_u	*p;
1308     unsigned	len;
1309 
1310     len = (unsigned)STRLEN(string) + 1;
1311     p = alloc(len);
1312     if (p != NULL)
1313 	mch_memmove(p, string, (size_t)len);
1314     return p;
1315 }
1316 
1317 /*
1318  * Copy up to "len" bytes of "string" into newly allocated memory and
1319  * terminate with a NUL.
1320  * The allocated memory always has size "len + 1", also when "string" is
1321  * shorter.
1322  */
1323     char_u *
1324 vim_strnsave(char_u *string, int len)
1325 {
1326     char_u	*p;
1327 
1328     p = alloc((unsigned)(len + 1));
1329     if (p != NULL)
1330     {
1331 	STRNCPY(p, string, len);
1332 	p[len] = NUL;
1333     }
1334     return p;
1335 }
1336 
1337 /*
1338  * Same as vim_strsave(), but any characters found in esc_chars are preceded
1339  * by a backslash.
1340  */
1341     char_u *
1342 vim_strsave_escaped(char_u *string, char_u *esc_chars)
1343 {
1344     return vim_strsave_escaped_ext(string, esc_chars, '\\', FALSE);
1345 }
1346 
1347 /*
1348  * Same as vim_strsave_escaped(), but when "bsl" is TRUE also escape
1349  * characters where rem_backslash() would remove the backslash.
1350  * Escape the characters with "cc".
1351  */
1352     char_u *
1353 vim_strsave_escaped_ext(
1354     char_u	*string,
1355     char_u	*esc_chars,
1356     int		cc,
1357     int		bsl)
1358 {
1359     char_u	*p;
1360     char_u	*p2;
1361     char_u	*escaped_string;
1362     unsigned	length;
1363 #ifdef FEAT_MBYTE
1364     int		l;
1365 #endif
1366 
1367     /*
1368      * First count the number of backslashes required.
1369      * Then allocate the memory and insert them.
1370      */
1371     length = 1;				/* count the trailing NUL */
1372     for (p = string; *p; p++)
1373     {
1374 #ifdef FEAT_MBYTE
1375 	if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1376 	{
1377 	    length += l;		/* count a multibyte char */
1378 	    p += l - 1;
1379 	    continue;
1380 	}
1381 #endif
1382 	if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
1383 	    ++length;			/* count a backslash */
1384 	++length;			/* count an ordinary char */
1385     }
1386     escaped_string = alloc(length);
1387     if (escaped_string != NULL)
1388     {
1389 	p2 = escaped_string;
1390 	for (p = string; *p; p++)
1391 	{
1392 #ifdef FEAT_MBYTE
1393 	    if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1394 	    {
1395 		mch_memmove(p2, p, (size_t)l);
1396 		p2 += l;
1397 		p += l - 1;		/* skip multibyte char  */
1398 		continue;
1399 	    }
1400 #endif
1401 	    if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
1402 		*p2++ = cc;
1403 	    *p2++ = *p;
1404 	}
1405 	*p2 = NUL;
1406     }
1407     return escaped_string;
1408 }
1409 
1410 /*
1411  * Return TRUE when 'shell' has "csh" in the tail.
1412  */
1413     int
1414 csh_like_shell(void)
1415 {
1416     return (strstr((char *)gettail(p_sh), "csh") != NULL);
1417 }
1418 
1419 /*
1420  * Escape "string" for use as a shell argument with system().
1421  * This uses single quotes, except when we know we need to use double quotes
1422  * (MS-DOS and MS-Windows without 'shellslash' set).
1423  * Escape a newline, depending on the 'shell' option.
1424  * When "do_special" is TRUE also replace "!", "%", "#" and things starting
1425  * with "<" like "<cfile>".
1426  * When "do_newline" is FALSE do not escape newline unless it is csh shell.
1427  * Returns the result in allocated memory, NULL if we have run out.
1428  */
1429     char_u *
1430 vim_strsave_shellescape(char_u *string, int do_special, int do_newline)
1431 {
1432     unsigned	length;
1433     char_u	*p;
1434     char_u	*d;
1435     char_u	*escaped_string;
1436     int		l;
1437     int		csh_like;
1438 
1439     /* Only csh and similar shells expand '!' within single quotes.  For sh and
1440      * the like we must not put a backslash before it, it will be taken
1441      * literally.  If do_special is set the '!' will be escaped twice.
1442      * Csh also needs to have "\n" escaped twice when do_special is set. */
1443     csh_like = csh_like_shell();
1444 
1445     /* First count the number of extra bytes required. */
1446     length = (unsigned)STRLEN(string) + 3;  /* two quotes and a trailing NUL */
1447     for (p = string; *p != NUL; MB_PTR_ADV(p))
1448     {
1449 # ifdef WIN32
1450 	if (!p_ssl)
1451 	{
1452 	    if (*p == '"')
1453 		++length;		/* " -> "" */
1454 	}
1455 	else
1456 # endif
1457 	if (*p == '\'')
1458 	    length += 3;		/* ' => '\'' */
1459 	if ((*p == '\n' && (csh_like || do_newline))
1460 		|| (*p == '!' && (csh_like || do_special)))
1461 	{
1462 	    ++length;			/* insert backslash */
1463 	    if (csh_like && do_special)
1464 		++length;		/* insert backslash */
1465 	}
1466 	if (do_special && find_cmdline_var(p, &l) >= 0)
1467 	{
1468 	    ++length;			/* insert backslash */
1469 	    p += l - 1;
1470 	}
1471     }
1472 
1473     /* Allocate memory for the result and fill it. */
1474     escaped_string = alloc(length);
1475     if (escaped_string != NULL)
1476     {
1477 	d = escaped_string;
1478 
1479 	/* add opening quote */
1480 # ifdef WIN32
1481 	if (!p_ssl)
1482 	    *d++ = '"';
1483 	else
1484 # endif
1485 	    *d++ = '\'';
1486 
1487 	for (p = string; *p != NUL; )
1488 	{
1489 # ifdef WIN32
1490 	    if (!p_ssl)
1491 	    {
1492 		if (*p == '"')
1493 		{
1494 		    *d++ = '"';
1495 		    *d++ = '"';
1496 		    ++p;
1497 		    continue;
1498 		}
1499 	    }
1500 	    else
1501 # endif
1502 	    if (*p == '\'')
1503 	    {
1504 		*d++ = '\'';
1505 		*d++ = '\\';
1506 		*d++ = '\'';
1507 		*d++ = '\'';
1508 		++p;
1509 		continue;
1510 	    }
1511 	    if ((*p == '\n' && (csh_like || do_newline))
1512 		    || (*p == '!' && (csh_like || do_special)))
1513 	    {
1514 		*d++ = '\\';
1515 		if (csh_like && do_special)
1516 		    *d++ = '\\';
1517 		*d++ = *p++;
1518 		continue;
1519 	    }
1520 	    if (do_special && find_cmdline_var(p, &l) >= 0)
1521 	    {
1522 		*d++ = '\\';		/* insert backslash */
1523 		while (--l >= 0)	/* copy the var */
1524 		    *d++ = *p++;
1525 		continue;
1526 	    }
1527 
1528 	    MB_COPY_CHAR(p, d);
1529 	}
1530 
1531 	/* add terminating quote and finish with a NUL */
1532 # ifdef WIN32
1533 	if (!p_ssl)
1534 	    *d++ = '"';
1535 	else
1536 # endif
1537 	    *d++ = '\'';
1538 	*d = NUL;
1539     }
1540 
1541     return escaped_string;
1542 }
1543 
1544 /*
1545  * Like vim_strsave(), but make all characters uppercase.
1546  * This uses ASCII lower-to-upper case translation, language independent.
1547  */
1548     char_u *
1549 vim_strsave_up(char_u *string)
1550 {
1551     char_u *p1;
1552 
1553     p1 = vim_strsave(string);
1554     vim_strup(p1);
1555     return p1;
1556 }
1557 
1558 /*
1559  * Like vim_strnsave(), but make all characters uppercase.
1560  * This uses ASCII lower-to-upper case translation, language independent.
1561  */
1562     char_u *
1563 vim_strnsave_up(char_u *string, int len)
1564 {
1565     char_u *p1;
1566 
1567     p1 = vim_strnsave(string, len);
1568     vim_strup(p1);
1569     return p1;
1570 }
1571 
1572 /*
1573  * ASCII lower-to-upper case translation, language independent.
1574  */
1575     void
1576 vim_strup(
1577     char_u	*p)
1578 {
1579     char_u  *p2;
1580     int	    c;
1581 
1582     if (p != NULL)
1583     {
1584 	p2 = p;
1585 	while ((c = *p2) != NUL)
1586 #ifdef EBCDIC
1587 	    *p2++ = isalpha(c) ? toupper(c) : c;
1588 #else
1589 	    *p2++ = (c < 'a' || c > 'z') ? c : (c - 0x20);
1590 #endif
1591     }
1592 }
1593 
1594 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
1595 /*
1596  * Make string "s" all upper-case and return it in allocated memory.
1597  * Handles multi-byte characters as well as possible.
1598  * Returns NULL when out of memory.
1599  */
1600     char_u *
1601 strup_save(char_u *orig)
1602 {
1603     char_u	*p;
1604     char_u	*res;
1605 
1606     res = p = vim_strsave(orig);
1607 
1608     if (res != NULL)
1609 	while (*p != NUL)
1610 	{
1611 # ifdef FEAT_MBYTE
1612 	    int		l;
1613 
1614 	    if (enc_utf8)
1615 	    {
1616 		int	c, uc;
1617 		int	newl;
1618 		char_u	*s;
1619 
1620 		c = utf_ptr2char(p);
1621 		l = utf_ptr2len(p);
1622 		if (c == 0)
1623 		{
1624 		    /* overlong sequence, use only the first byte */
1625 		    c = *p;
1626 		    l = 1;
1627 		}
1628 		uc = utf_toupper(c);
1629 
1630 		/* Reallocate string when byte count changes.  This is rare,
1631 		 * thus it's OK to do another malloc()/free(). */
1632 		newl = utf_char2len(uc);
1633 		if (newl != l)
1634 		{
1635 		    s = alloc((unsigned)STRLEN(res) + 1 + newl - l);
1636 		    if (s == NULL)
1637 		    {
1638 			vim_free(res);
1639 			return NULL;
1640 		    }
1641 		    mch_memmove(s, res, p - res);
1642 		    STRCPY(s + (p - res) + newl, p + l);
1643 		    p = s + (p - res);
1644 		    vim_free(res);
1645 		    res = s;
1646 		}
1647 
1648 		utf_char2bytes(uc, p);
1649 		p += newl;
1650 	    }
1651 	    else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1652 		p += l;		/* skip multi-byte character */
1653 	    else
1654 # endif
1655 	    {
1656 		*p = TOUPPER_LOC(*p); /* note that toupper() can be a macro */
1657 		p++;
1658 	    }
1659 	}
1660 
1661     return res;
1662 }
1663 
1664 /*
1665  * Make string "s" all lower-case and return it in allocated memory.
1666  * Handles multi-byte characters as well as possible.
1667  * Returns NULL when out of memory.
1668  */
1669     char_u *
1670 strlow_save(char_u *orig)
1671 {
1672     char_u	*p;
1673     char_u	*res;
1674 
1675     res = p = vim_strsave(orig);
1676 
1677     if (res != NULL)
1678 	while (*p != NUL)
1679 	{
1680 # ifdef FEAT_MBYTE
1681 	    int		l;
1682 
1683 	    if (enc_utf8)
1684 	    {
1685 		int	c, lc;
1686 		int	newl;
1687 		char_u	*s;
1688 
1689 		c = utf_ptr2char(p);
1690 		l = utf_ptr2len(p);
1691 		if (c == 0)
1692 		{
1693 		    /* overlong sequence, use only the first byte */
1694 		    c = *p;
1695 		    l = 1;
1696 		}
1697 		lc = utf_tolower(c);
1698 
1699 		/* Reallocate string when byte count changes.  This is rare,
1700 		 * thus it's OK to do another malloc()/free(). */
1701 		newl = utf_char2len(lc);
1702 		if (newl != l)
1703 		{
1704 		    s = alloc((unsigned)STRLEN(res) + 1 + newl - l);
1705 		    if (s == NULL)
1706 		    {
1707 			vim_free(res);
1708 			return NULL;
1709 		    }
1710 		    mch_memmove(s, res, p - res);
1711 		    STRCPY(s + (p - res) + newl, p + l);
1712 		    p = s + (p - res);
1713 		    vim_free(res);
1714 		    res = s;
1715 		}
1716 
1717 		utf_char2bytes(lc, p);
1718 		p += newl;
1719 	    }
1720 	    else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1721 		p += l;		/* skip multi-byte character */
1722 	    else
1723 # endif
1724 	    {
1725 		*p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
1726 		p++;
1727 	    }
1728 	}
1729 
1730     return res;
1731 }
1732 #endif
1733 
1734 /*
1735  * delete spaces at the end of a string
1736  */
1737     void
1738 del_trailing_spaces(char_u *ptr)
1739 {
1740     char_u	*q;
1741 
1742     q = ptr + STRLEN(ptr);
1743     while (--q > ptr && VIM_ISWHITE(q[0]) && q[-1] != '\\' && q[-1] != Ctrl_V)
1744 	*q = NUL;
1745 }
1746 
1747 /*
1748  * Like strncpy(), but always terminate the result with one NUL.
1749  * "to" must be "len + 1" long!
1750  */
1751     void
1752 vim_strncpy(char_u *to, char_u *from, size_t len)
1753 {
1754     STRNCPY(to, from, len);
1755     to[len] = NUL;
1756 }
1757 
1758 /*
1759  * Like strcat(), but make sure the result fits in "tosize" bytes and is
1760  * always NUL terminated. "from" and "to" may overlap.
1761  */
1762     void
1763 vim_strcat(char_u *to, char_u *from, size_t tosize)
1764 {
1765     size_t tolen = STRLEN(to);
1766     size_t fromlen = STRLEN(from);
1767 
1768     if (tolen + fromlen + 1 > tosize)
1769     {
1770 	mch_memmove(to + tolen, from, tosize - tolen - 1);
1771 	to[tosize - 1] = NUL;
1772     }
1773     else
1774 	mch_memmove(to + tolen, from, fromlen + 1);
1775 }
1776 
1777 /*
1778  * Isolate one part of a string option where parts are separated with
1779  * "sep_chars".
1780  * The part is copied into "buf[maxlen]".
1781  * "*option" is advanced to the next part.
1782  * The length is returned.
1783  */
1784     int
1785 copy_option_part(
1786     char_u	**option,
1787     char_u	*buf,
1788     int		maxlen,
1789     char	*sep_chars)
1790 {
1791     int	    len = 0;
1792     char_u  *p = *option;
1793 
1794     /* skip '.' at start of option part, for 'suffixes' */
1795     if (*p == '.')
1796 	buf[len++] = *p++;
1797     while (*p != NUL && vim_strchr((char_u *)sep_chars, *p) == NULL)
1798     {
1799 	/*
1800 	 * Skip backslash before a separator character and space.
1801 	 */
1802 	if (p[0] == '\\' && vim_strchr((char_u *)sep_chars, p[1]) != NULL)
1803 	    ++p;
1804 	if (len < maxlen - 1)
1805 	    buf[len++] = *p;
1806 	++p;
1807     }
1808     buf[len] = NUL;
1809 
1810     if (*p != NUL && *p != ',')	/* skip non-standard separator */
1811 	++p;
1812     p = skip_to_option_part(p);	/* p points to next file name */
1813 
1814     *option = p;
1815     return len;
1816 }
1817 
1818 /*
1819  * Replacement for free() that ignores NULL pointers.
1820  * Also skip free() when exiting for sure, this helps when we caught a deadly
1821  * signal that was caused by a crash in free().
1822  * If you want to set NULL after calling this function, you should use
1823  * VIM_CLEAR() instead.
1824  */
1825     void
1826 vim_free(void *x)
1827 {
1828     if (x != NULL && !really_exiting)
1829     {
1830 #ifdef MEM_PROFILE
1831 	mem_pre_free(&x);
1832 #endif
1833 	free(x);
1834     }
1835 }
1836 
1837 #ifndef HAVE_MEMSET
1838     void *
1839 vim_memset(void *ptr, int c, size_t size)
1840 {
1841     char *p = ptr;
1842 
1843     while (size-- > 0)
1844 	*p++ = c;
1845     return ptr;
1846 }
1847 #endif
1848 
1849 #if (!defined(HAVE_STRCASECMP) && !defined(HAVE_STRICMP)) || defined(PROTO)
1850 /*
1851  * Compare two strings, ignoring case, using current locale.
1852  * Doesn't work for multi-byte characters.
1853  * return 0 for match, < 0 for smaller, > 0 for bigger
1854  */
1855     int
1856 vim_stricmp(char *s1, char *s2)
1857 {
1858     int		i;
1859 
1860     for (;;)
1861     {
1862 	i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
1863 	if (i != 0)
1864 	    return i;			    /* this character different */
1865 	if (*s1 == NUL)
1866 	    break;			    /* strings match until NUL */
1867 	++s1;
1868 	++s2;
1869     }
1870     return 0;				    /* strings match */
1871 }
1872 #endif
1873 
1874 #if (!defined(HAVE_STRNCASECMP) && !defined(HAVE_STRNICMP)) || defined(PROTO)
1875 /*
1876  * Compare two strings, for length "len", ignoring case, using current locale.
1877  * Doesn't work for multi-byte characters.
1878  * return 0 for match, < 0 for smaller, > 0 for bigger
1879  */
1880     int
1881 vim_strnicmp(char *s1, char *s2, size_t len)
1882 {
1883     int		i;
1884 
1885     while (len > 0)
1886     {
1887 	i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
1888 	if (i != 0)
1889 	    return i;			    /* this character different */
1890 	if (*s1 == NUL)
1891 	    break;			    /* strings match until NUL */
1892 	++s1;
1893 	++s2;
1894 	--len;
1895     }
1896     return 0;				    /* strings match */
1897 }
1898 #endif
1899 
1900 /*
1901  * Version of strchr() and strrchr() that handle unsigned char strings
1902  * with characters from 128 to 255 correctly.  It also doesn't return a
1903  * pointer to the NUL at the end of the string.
1904  */
1905     char_u  *
1906 vim_strchr(char_u *string, int c)
1907 {
1908     char_u	*p;
1909     int		b;
1910 
1911     p = string;
1912 #ifdef FEAT_MBYTE
1913     if (enc_utf8 && c >= 0x80)
1914     {
1915 	while (*p != NUL)
1916 	{
1917 	    int l = utfc_ptr2len(p);
1918 
1919 	    /* Avoid matching an illegal byte here. */
1920 	    if (utf_ptr2char(p) == c && l > 1)
1921 		return p;
1922 	    p += l;
1923 	}
1924 	return NULL;
1925     }
1926     if (enc_dbcs != 0 && c > 255)
1927     {
1928 	int	n2 = c & 0xff;
1929 
1930 	c = ((unsigned)c >> 8) & 0xff;
1931 	while ((b = *p) != NUL)
1932 	{
1933 	    if (b == c && p[1] == n2)
1934 		return p;
1935 	    p += (*mb_ptr2len)(p);
1936 	}
1937 	return NULL;
1938     }
1939     if (has_mbyte)
1940     {
1941 	while ((b = *p) != NUL)
1942 	{
1943 	    if (b == c)
1944 		return p;
1945 	    p += (*mb_ptr2len)(p);
1946 	}
1947 	return NULL;
1948     }
1949 #endif
1950     while ((b = *p) != NUL)
1951     {
1952 	if (b == c)
1953 	    return p;
1954 	++p;
1955     }
1956     return NULL;
1957 }
1958 
1959 /*
1960  * Version of strchr() that only works for bytes and handles unsigned char
1961  * strings with characters above 128 correctly. It also doesn't return a
1962  * pointer to the NUL at the end of the string.
1963  */
1964     char_u  *
1965 vim_strbyte(char_u *string, int c)
1966 {
1967     char_u	*p = string;
1968 
1969     while (*p != NUL)
1970     {
1971 	if (*p == c)
1972 	    return p;
1973 	++p;
1974     }
1975     return NULL;
1976 }
1977 
1978 /*
1979  * Search for last occurrence of "c" in "string".
1980  * Return NULL if not found.
1981  * Does not handle multi-byte char for "c"!
1982  */
1983     char_u  *
1984 vim_strrchr(char_u *string, int c)
1985 {
1986     char_u	*retval = NULL;
1987     char_u	*p = string;
1988 
1989     while (*p)
1990     {
1991 	if (*p == c)
1992 	    retval = p;
1993 	MB_PTR_ADV(p);
1994     }
1995     return retval;
1996 }
1997 
1998 /*
1999  * Vim's version of strpbrk(), in case it's missing.
2000  * Don't generate a prototype for this, causes problems when it's not used.
2001  */
2002 #ifndef PROTO
2003 # ifndef HAVE_STRPBRK
2004 #  ifdef vim_strpbrk
2005 #   undef vim_strpbrk
2006 #  endif
2007     char_u *
2008 vim_strpbrk(char_u *s, char_u *charset)
2009 {
2010     while (*s)
2011     {
2012 	if (vim_strchr(charset, *s) != NULL)
2013 	    return s;
2014 	MB_PTR_ADV(s);
2015     }
2016     return NULL;
2017 }
2018 # endif
2019 #endif
2020 
2021 /*
2022  * Vim has its own isspace() function, because on some machines isspace()
2023  * can't handle characters above 128.
2024  */
2025     int
2026 vim_isspace(int x)
2027 {
2028     return ((x >= 9 && x <= 13) || x == ' ');
2029 }
2030 
2031 /************************************************************************
2032  * Functions for handling growing arrays.
2033  */
2034 
2035 /*
2036  * Clear an allocated growing array.
2037  */
2038     void
2039 ga_clear(garray_T *gap)
2040 {
2041     vim_free(gap->ga_data);
2042     ga_init(gap);
2043 }
2044 
2045 /*
2046  * Clear a growing array that contains a list of strings.
2047  */
2048     void
2049 ga_clear_strings(garray_T *gap)
2050 {
2051     int		i;
2052 
2053     for (i = 0; i < gap->ga_len; ++i)
2054 	vim_free(((char_u **)(gap->ga_data))[i]);
2055     ga_clear(gap);
2056 }
2057 
2058 /*
2059  * Initialize a growing array.	Don't forget to set ga_itemsize and
2060  * ga_growsize!  Or use ga_init2().
2061  */
2062     void
2063 ga_init(garray_T *gap)
2064 {
2065     gap->ga_data = NULL;
2066     gap->ga_maxlen = 0;
2067     gap->ga_len = 0;
2068 }
2069 
2070     void
2071 ga_init2(garray_T *gap, int itemsize, int growsize)
2072 {
2073     ga_init(gap);
2074     gap->ga_itemsize = itemsize;
2075     gap->ga_growsize = growsize;
2076 }
2077 
2078 /*
2079  * Make room in growing array "gap" for at least "n" items.
2080  * Return FAIL for failure, OK otherwise.
2081  */
2082     int
2083 ga_grow(garray_T *gap, int n)
2084 {
2085     size_t	old_len;
2086     size_t	new_len;
2087     char_u	*pp;
2088 
2089     if (gap->ga_maxlen - gap->ga_len < n)
2090     {
2091 	if (n < gap->ga_growsize)
2092 	    n = gap->ga_growsize;
2093 	new_len = gap->ga_itemsize * (gap->ga_len + n);
2094 	pp = (gap->ga_data == NULL)
2095 	      ? alloc((unsigned)new_len) : vim_realloc(gap->ga_data, new_len);
2096 	if (pp == NULL)
2097 	    return FAIL;
2098 	old_len = gap->ga_itemsize * gap->ga_maxlen;
2099 	vim_memset(pp + old_len, 0, new_len - old_len);
2100 	gap->ga_maxlen = gap->ga_len + n;
2101 	gap->ga_data = pp;
2102     }
2103     return OK;
2104 }
2105 
2106 /*
2107  * For a growing array that contains a list of strings: concatenate all the
2108  * strings with a separating "sep".
2109  * Returns NULL when out of memory.
2110  */
2111     char_u *
2112 ga_concat_strings(garray_T *gap, char *sep)
2113 {
2114     int		i;
2115     int		len = 0;
2116     int		sep_len = (int)STRLEN(sep);
2117     char_u	*s;
2118     char_u	*p;
2119 
2120     for (i = 0; i < gap->ga_len; ++i)
2121 	len += (int)STRLEN(((char_u **)(gap->ga_data))[i]) + sep_len;
2122 
2123     s = alloc(len + 1);
2124     if (s != NULL)
2125     {
2126 	*s = NUL;
2127 	p = s;
2128 	for (i = 0; i < gap->ga_len; ++i)
2129 	{
2130 	    if (p != s)
2131 	    {
2132 		STRCPY(p, sep);
2133 		p += sep_len;
2134 	    }
2135 	    STRCPY(p, ((char_u **)(gap->ga_data))[i]);
2136 	    p += STRLEN(p);
2137 	}
2138     }
2139     return s;
2140 }
2141 
2142 #if defined(FEAT_VIMINFO) || defined(FEAT_EVAL) || defined(PROTO)
2143 /*
2144  * Make a copy of string "p" and add it to "gap".
2145  * When out of memory nothing changes.
2146  */
2147     void
2148 ga_add_string(garray_T *gap, char_u *p)
2149 {
2150     char_u *cp = vim_strsave(p);
2151 
2152     if (cp != NULL)
2153     {
2154 	if (ga_grow(gap, 1) == OK)
2155 	    ((char_u **)(gap->ga_data))[gap->ga_len++] = cp;
2156 	else
2157 	    vim_free(cp);
2158     }
2159 }
2160 #endif
2161 
2162 /*
2163  * Concatenate a string to a growarray which contains characters.
2164  * When "s" is NULL does not do anything.
2165  * Note: Does NOT copy the NUL at the end!
2166  */
2167     void
2168 ga_concat(garray_T *gap, char_u *s)
2169 {
2170     int    len;
2171 
2172     if (s == NULL || *s == NUL)
2173 	return;
2174     len = (int)STRLEN(s);
2175     if (ga_grow(gap, len) == OK)
2176     {
2177 	mch_memmove((char *)gap->ga_data + gap->ga_len, s, (size_t)len);
2178 	gap->ga_len += len;
2179     }
2180 }
2181 
2182 /*
2183  * Append one byte to a growarray which contains bytes.
2184  */
2185     void
2186 ga_append(garray_T *gap, int c)
2187 {
2188     if (ga_grow(gap, 1) == OK)
2189     {
2190 	*((char *)gap->ga_data + gap->ga_len) = c;
2191 	++gap->ga_len;
2192     }
2193 }
2194 
2195 #if (defined(UNIX) && !defined(USE_SYSTEM)) || defined(WIN3264) \
2196 	|| defined(PROTO)
2197 /*
2198  * Append the text in "gap" below the cursor line and clear "gap".
2199  */
2200     void
2201 append_ga_line(garray_T *gap)
2202 {
2203     /* Remove trailing CR. */
2204     if (gap->ga_len > 0
2205 	    && !curbuf->b_p_bin
2206 	    && ((char_u *)gap->ga_data)[gap->ga_len - 1] == CAR)
2207 	--gap->ga_len;
2208     ga_append(gap, NUL);
2209     ml_append(curwin->w_cursor.lnum++, gap->ga_data, 0, FALSE);
2210     gap->ga_len = 0;
2211 }
2212 #endif
2213 
2214 /************************************************************************
2215  * functions that use lookup tables for various things, generally to do with
2216  * special key codes.
2217  */
2218 
2219 /*
2220  * Some useful tables.
2221  */
2222 
2223 static struct modmasktable
2224 {
2225     short	mod_mask;	/* Bit-mask for particular key modifier */
2226     short	mod_flag;	/* Bit(s) for particular key modifier */
2227     char_u	name;		/* Single letter name of modifier */
2228 } mod_mask_table[] =
2229 {
2230     {MOD_MASK_ALT,		MOD_MASK_ALT,		(char_u)'M'},
2231     {MOD_MASK_META,		MOD_MASK_META,		(char_u)'T'},
2232     {MOD_MASK_CTRL,		MOD_MASK_CTRL,		(char_u)'C'},
2233     {MOD_MASK_SHIFT,		MOD_MASK_SHIFT,		(char_u)'S'},
2234     {MOD_MASK_MULTI_CLICK,	MOD_MASK_2CLICK,	(char_u)'2'},
2235     {MOD_MASK_MULTI_CLICK,	MOD_MASK_3CLICK,	(char_u)'3'},
2236     {MOD_MASK_MULTI_CLICK,	MOD_MASK_4CLICK,	(char_u)'4'},
2237 #ifdef MACOS_X
2238     {MOD_MASK_CMD,		MOD_MASK_CMD,		(char_u)'D'},
2239 #endif
2240     /* 'A' must be the last one */
2241     {MOD_MASK_ALT,		MOD_MASK_ALT,		(char_u)'A'},
2242     {0, 0, NUL}
2243     /* NOTE: when adding an entry, update MAX_KEY_NAME_LEN! */
2244 };
2245 
2246 /*
2247  * Shifted key terminal codes and their unshifted equivalent.
2248  * Don't add mouse codes here, they are handled separately!
2249  */
2250 #define MOD_KEYS_ENTRY_SIZE 5
2251 
2252 static char_u modifier_keys_table[] =
2253 {
2254 /*  mod mask	    with modifier		without modifier */
2255     MOD_MASK_SHIFT, '&', '9',			'@', '1',	/* begin */
2256     MOD_MASK_SHIFT, '&', '0',			'@', '2',	/* cancel */
2257     MOD_MASK_SHIFT, '*', '1',			'@', '4',	/* command */
2258     MOD_MASK_SHIFT, '*', '2',			'@', '5',	/* copy */
2259     MOD_MASK_SHIFT, '*', '3',			'@', '6',	/* create */
2260     MOD_MASK_SHIFT, '*', '4',			'k', 'D',	/* delete char */
2261     MOD_MASK_SHIFT, '*', '5',			'k', 'L',	/* delete line */
2262     MOD_MASK_SHIFT, '*', '7',			'@', '7',	/* end */
2263     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_END,	'@', '7',	/* end */
2264     MOD_MASK_SHIFT, '*', '9',			'@', '9',	/* exit */
2265     MOD_MASK_SHIFT, '*', '0',			'@', '0',	/* find */
2266     MOD_MASK_SHIFT, '#', '1',			'%', '1',	/* help */
2267     MOD_MASK_SHIFT, '#', '2',			'k', 'h',	/* home */
2268     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_HOME,	'k', 'h',	/* home */
2269     MOD_MASK_SHIFT, '#', '3',			'k', 'I',	/* insert */
2270     MOD_MASK_SHIFT, '#', '4',			'k', 'l',	/* left arrow */
2271     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_LEFT,	'k', 'l',	/* left arrow */
2272     MOD_MASK_SHIFT, '%', 'a',			'%', '3',	/* message */
2273     MOD_MASK_SHIFT, '%', 'b',			'%', '4',	/* move */
2274     MOD_MASK_SHIFT, '%', 'c',			'%', '5',	/* next */
2275     MOD_MASK_SHIFT, '%', 'd',			'%', '7',	/* options */
2276     MOD_MASK_SHIFT, '%', 'e',			'%', '8',	/* previous */
2277     MOD_MASK_SHIFT, '%', 'f',			'%', '9',	/* print */
2278     MOD_MASK_SHIFT, '%', 'g',			'%', '0',	/* redo */
2279     MOD_MASK_SHIFT, '%', 'h',			'&', '3',	/* replace */
2280     MOD_MASK_SHIFT, '%', 'i',			'k', 'r',	/* right arr. */
2281     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_RIGHT,	'k', 'r',	/* right arr. */
2282     MOD_MASK_SHIFT, '%', 'j',			'&', '5',	/* resume */
2283     MOD_MASK_SHIFT, '!', '1',			'&', '6',	/* save */
2284     MOD_MASK_SHIFT, '!', '2',			'&', '7',	/* suspend */
2285     MOD_MASK_SHIFT, '!', '3',			'&', '8',	/* undo */
2286     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_UP,	'k', 'u',	/* up arrow */
2287     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_DOWN,	'k', 'd',	/* down arrow */
2288 
2289 								/* vt100 F1 */
2290     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF1,	KS_EXTRA, (int)KE_XF1,
2291     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF2,	KS_EXTRA, (int)KE_XF2,
2292     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF3,	KS_EXTRA, (int)KE_XF3,
2293     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF4,	KS_EXTRA, (int)KE_XF4,
2294 
2295     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F1,	'k', '1',	/* F1 */
2296     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F2,	'k', '2',
2297     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F3,	'k', '3',
2298     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F4,	'k', '4',
2299     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F5,	'k', '5',
2300     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F6,	'k', '6',
2301     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F7,	'k', '7',
2302     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F8,	'k', '8',
2303     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F9,	'k', '9',
2304     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F10,	'k', ';',	/* F10 */
2305 
2306     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F11,	'F', '1',
2307     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F12,	'F', '2',
2308     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F13,	'F', '3',
2309     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F14,	'F', '4',
2310     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F15,	'F', '5',
2311     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F16,	'F', '6',
2312     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F17,	'F', '7',
2313     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F18,	'F', '8',
2314     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F19,	'F', '9',
2315     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F20,	'F', 'A',
2316 
2317     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F21,	'F', 'B',
2318     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F22,	'F', 'C',
2319     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F23,	'F', 'D',
2320     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F24,	'F', 'E',
2321     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F25,	'F', 'F',
2322     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F26,	'F', 'G',
2323     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F27,	'F', 'H',
2324     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F28,	'F', 'I',
2325     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F29,	'F', 'J',
2326     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F30,	'F', 'K',
2327 
2328     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F31,	'F', 'L',
2329     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F32,	'F', 'M',
2330     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F33,	'F', 'N',
2331     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F34,	'F', 'O',
2332     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F35,	'F', 'P',
2333     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F36,	'F', 'Q',
2334     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F37,	'F', 'R',
2335 
2336 							    /* TAB pseudo code*/
2337     MOD_MASK_SHIFT, 'k', 'B',			KS_EXTRA, (int)KE_TAB,
2338 
2339     NUL
2340 };
2341 
2342 static struct key_name_entry
2343 {
2344     int	    key;	/* Special key code or ascii value */
2345     char_u  *name;	/* Name of key */
2346 } key_names_table[] =
2347 {
2348     {' ',		(char_u *)"Space"},
2349     {TAB,		(char_u *)"Tab"},
2350     {K_TAB,		(char_u *)"Tab"},
2351     {NL,		(char_u *)"NL"},
2352     {NL,		(char_u *)"NewLine"},	/* Alternative name */
2353     {NL,		(char_u *)"LineFeed"},	/* Alternative name */
2354     {NL,		(char_u *)"LF"},	/* Alternative name */
2355     {CAR,		(char_u *)"CR"},
2356     {CAR,		(char_u *)"Return"},	/* Alternative name */
2357     {CAR,		(char_u *)"Enter"},	/* Alternative name */
2358     {K_BS,		(char_u *)"BS"},
2359     {K_BS,		(char_u *)"BackSpace"},	/* Alternative name */
2360     {ESC,		(char_u *)"Esc"},
2361     {CSI,		(char_u *)"CSI"},
2362     {K_CSI,		(char_u *)"xCSI"},
2363     {'|',		(char_u *)"Bar"},
2364     {'\\',		(char_u *)"Bslash"},
2365     {K_DEL,		(char_u *)"Del"},
2366     {K_DEL,		(char_u *)"Delete"},	/* Alternative name */
2367     {K_KDEL,		(char_u *)"kDel"},
2368     {K_UP,		(char_u *)"Up"},
2369     {K_DOWN,		(char_u *)"Down"},
2370     {K_LEFT,		(char_u *)"Left"},
2371     {K_RIGHT,		(char_u *)"Right"},
2372     {K_XUP,		(char_u *)"xUp"},
2373     {K_XDOWN,		(char_u *)"xDown"},
2374     {K_XLEFT,		(char_u *)"xLeft"},
2375     {K_XRIGHT,		(char_u *)"xRight"},
2376     {K_PS,		(char_u *)"PasteStart"},
2377     {K_PE,		(char_u *)"PasteEnd"},
2378 
2379     {K_F1,		(char_u *)"F1"},
2380     {K_F2,		(char_u *)"F2"},
2381     {K_F3,		(char_u *)"F3"},
2382     {K_F4,		(char_u *)"F4"},
2383     {K_F5,		(char_u *)"F5"},
2384     {K_F6,		(char_u *)"F6"},
2385     {K_F7,		(char_u *)"F7"},
2386     {K_F8,		(char_u *)"F8"},
2387     {K_F9,		(char_u *)"F9"},
2388     {K_F10,		(char_u *)"F10"},
2389 
2390     {K_F11,		(char_u *)"F11"},
2391     {K_F12,		(char_u *)"F12"},
2392     {K_F13,		(char_u *)"F13"},
2393     {K_F14,		(char_u *)"F14"},
2394     {K_F15,		(char_u *)"F15"},
2395     {K_F16,		(char_u *)"F16"},
2396     {K_F17,		(char_u *)"F17"},
2397     {K_F18,		(char_u *)"F18"},
2398     {K_F19,		(char_u *)"F19"},
2399     {K_F20,		(char_u *)"F20"},
2400 
2401     {K_F21,		(char_u *)"F21"},
2402     {K_F22,		(char_u *)"F22"},
2403     {K_F23,		(char_u *)"F23"},
2404     {K_F24,		(char_u *)"F24"},
2405     {K_F25,		(char_u *)"F25"},
2406     {K_F26,		(char_u *)"F26"},
2407     {K_F27,		(char_u *)"F27"},
2408     {K_F28,		(char_u *)"F28"},
2409     {K_F29,		(char_u *)"F29"},
2410     {K_F30,		(char_u *)"F30"},
2411 
2412     {K_F31,		(char_u *)"F31"},
2413     {K_F32,		(char_u *)"F32"},
2414     {K_F33,		(char_u *)"F33"},
2415     {K_F34,		(char_u *)"F34"},
2416     {K_F35,		(char_u *)"F35"},
2417     {K_F36,		(char_u *)"F36"},
2418     {K_F37,		(char_u *)"F37"},
2419 
2420     {K_XF1,		(char_u *)"xF1"},
2421     {K_XF2,		(char_u *)"xF2"},
2422     {K_XF3,		(char_u *)"xF3"},
2423     {K_XF4,		(char_u *)"xF4"},
2424 
2425     {K_HELP,		(char_u *)"Help"},
2426     {K_UNDO,		(char_u *)"Undo"},
2427     {K_INS,		(char_u *)"Insert"},
2428     {K_INS,		(char_u *)"Ins"},	/* Alternative name */
2429     {K_KINS,		(char_u *)"kInsert"},
2430     {K_HOME,		(char_u *)"Home"},
2431     {K_KHOME,		(char_u *)"kHome"},
2432     {K_XHOME,		(char_u *)"xHome"},
2433     {K_ZHOME,		(char_u *)"zHome"},
2434     {K_END,		(char_u *)"End"},
2435     {K_KEND,		(char_u *)"kEnd"},
2436     {K_XEND,		(char_u *)"xEnd"},
2437     {K_ZEND,		(char_u *)"zEnd"},
2438     {K_PAGEUP,		(char_u *)"PageUp"},
2439     {K_PAGEDOWN,	(char_u *)"PageDown"},
2440     {K_KPAGEUP,		(char_u *)"kPageUp"},
2441     {K_KPAGEDOWN,	(char_u *)"kPageDown"},
2442 
2443     {K_KPLUS,		(char_u *)"kPlus"},
2444     {K_KMINUS,		(char_u *)"kMinus"},
2445     {K_KDIVIDE,		(char_u *)"kDivide"},
2446     {K_KMULTIPLY,	(char_u *)"kMultiply"},
2447     {K_KENTER,		(char_u *)"kEnter"},
2448     {K_KPOINT,		(char_u *)"kPoint"},
2449 
2450     {K_K0,		(char_u *)"k0"},
2451     {K_K1,		(char_u *)"k1"},
2452     {K_K2,		(char_u *)"k2"},
2453     {K_K3,		(char_u *)"k3"},
2454     {K_K4,		(char_u *)"k4"},
2455     {K_K5,		(char_u *)"k5"},
2456     {K_K6,		(char_u *)"k6"},
2457     {K_K7,		(char_u *)"k7"},
2458     {K_K8,		(char_u *)"k8"},
2459     {K_K9,		(char_u *)"k9"},
2460 
2461     {'<',		(char_u *)"lt"},
2462 
2463     {K_MOUSE,		(char_u *)"Mouse"},
2464 #ifdef FEAT_MOUSE_NET
2465     {K_NETTERM_MOUSE,	(char_u *)"NetMouse"},
2466 #endif
2467 #ifdef FEAT_MOUSE_DEC
2468     {K_DEC_MOUSE,	(char_u *)"DecMouse"},
2469 #endif
2470 #ifdef FEAT_MOUSE_JSB
2471     {K_JSBTERM_MOUSE,	(char_u *)"JsbMouse"},
2472 #endif
2473 #ifdef FEAT_MOUSE_PTERM
2474     {K_PTERM_MOUSE,	(char_u *)"PtermMouse"},
2475 #endif
2476 #ifdef FEAT_MOUSE_URXVT
2477     {K_URXVT_MOUSE,	(char_u *)"UrxvtMouse"},
2478 #endif
2479 #ifdef FEAT_MOUSE_SGR
2480     {K_SGR_MOUSE,	(char_u *)"SgrMouse"},
2481     {K_SGR_MOUSERELEASE, (char_u *)"SgrMouseRelelase"},
2482 #endif
2483     {K_LEFTMOUSE,	(char_u *)"LeftMouse"},
2484     {K_LEFTMOUSE_NM,	(char_u *)"LeftMouseNM"},
2485     {K_LEFTDRAG,	(char_u *)"LeftDrag"},
2486     {K_LEFTRELEASE,	(char_u *)"LeftRelease"},
2487     {K_LEFTRELEASE_NM,	(char_u *)"LeftReleaseNM"},
2488     {K_MOUSEMOVE,	(char_u *)"MouseMove"},
2489     {K_MIDDLEMOUSE,	(char_u *)"MiddleMouse"},
2490     {K_MIDDLEDRAG,	(char_u *)"MiddleDrag"},
2491     {K_MIDDLERELEASE,	(char_u *)"MiddleRelease"},
2492     {K_RIGHTMOUSE,	(char_u *)"RightMouse"},
2493     {K_RIGHTDRAG,	(char_u *)"RightDrag"},
2494     {K_RIGHTRELEASE,	(char_u *)"RightRelease"},
2495     {K_MOUSEDOWN,	(char_u *)"ScrollWheelUp"},
2496     {K_MOUSEUP,		(char_u *)"ScrollWheelDown"},
2497     {K_MOUSELEFT,	(char_u *)"ScrollWheelRight"},
2498     {K_MOUSERIGHT,	(char_u *)"ScrollWheelLeft"},
2499     {K_MOUSEDOWN,	(char_u *)"MouseDown"}, /* OBSOLETE: Use	  */
2500     {K_MOUSEUP,		(char_u *)"MouseUp"},	/* ScrollWheelXXX instead */
2501     {K_X1MOUSE,		(char_u *)"X1Mouse"},
2502     {K_X1DRAG,		(char_u *)"X1Drag"},
2503     {K_X1RELEASE,		(char_u *)"X1Release"},
2504     {K_X2MOUSE,		(char_u *)"X2Mouse"},
2505     {K_X2DRAG,		(char_u *)"X2Drag"},
2506     {K_X2RELEASE,		(char_u *)"X2Release"},
2507     {K_DROP,		(char_u *)"Drop"},
2508     {K_ZERO,		(char_u *)"Nul"},
2509 #ifdef FEAT_EVAL
2510     {K_SNR,		(char_u *)"SNR"},
2511 #endif
2512     {K_PLUG,		(char_u *)"Plug"},
2513     {K_CURSORHOLD,	(char_u *)"CursorHold"},
2514     {0,			NULL}
2515     /* NOTE: When adding a long name update MAX_KEY_NAME_LEN. */
2516 };
2517 
2518 #define KEY_NAMES_TABLE_LEN (sizeof(key_names_table) / sizeof(struct key_name_entry))
2519 
2520 #ifdef FEAT_MOUSE
2521 static struct mousetable
2522 {
2523     int	    pseudo_code;	/* Code for pseudo mouse event */
2524     int	    button;		/* Which mouse button is it? */
2525     int	    is_click;		/* Is it a mouse button click event? */
2526     int	    is_drag;		/* Is it a mouse drag event? */
2527 } mouse_table[] =
2528 {
2529     {(int)KE_LEFTMOUSE,		MOUSE_LEFT,	TRUE,	FALSE},
2530 #ifdef FEAT_GUI
2531     {(int)KE_LEFTMOUSE_NM,	MOUSE_LEFT,	TRUE,	FALSE},
2532 #endif
2533     {(int)KE_LEFTDRAG,		MOUSE_LEFT,	FALSE,	TRUE},
2534     {(int)KE_LEFTRELEASE,	MOUSE_LEFT,	FALSE,	FALSE},
2535 #ifdef FEAT_GUI
2536     {(int)KE_LEFTRELEASE_NM,	MOUSE_LEFT,	FALSE,	FALSE},
2537 #endif
2538     {(int)KE_MIDDLEMOUSE,	MOUSE_MIDDLE,	TRUE,	FALSE},
2539     {(int)KE_MIDDLEDRAG,	MOUSE_MIDDLE,	FALSE,	TRUE},
2540     {(int)KE_MIDDLERELEASE,	MOUSE_MIDDLE,	FALSE,	FALSE},
2541     {(int)KE_RIGHTMOUSE,	MOUSE_RIGHT,	TRUE,	FALSE},
2542     {(int)KE_RIGHTDRAG,		MOUSE_RIGHT,	FALSE,	TRUE},
2543     {(int)KE_RIGHTRELEASE,	MOUSE_RIGHT,	FALSE,	FALSE},
2544     {(int)KE_X1MOUSE,		MOUSE_X1,	TRUE,	FALSE},
2545     {(int)KE_X1DRAG,		MOUSE_X1,	FALSE,	TRUE},
2546     {(int)KE_X1RELEASE,		MOUSE_X1,	FALSE,	FALSE},
2547     {(int)KE_X2MOUSE,		MOUSE_X2,	TRUE,	FALSE},
2548     {(int)KE_X2DRAG,		MOUSE_X2,	FALSE,	TRUE},
2549     {(int)KE_X2RELEASE,		MOUSE_X2,	FALSE,	FALSE},
2550     /* DRAG without CLICK */
2551     {(int)KE_MOUSEMOVE,		MOUSE_RELEASE,	FALSE,	TRUE},
2552     /* RELEASE without CLICK */
2553     {(int)KE_IGNORE,		MOUSE_RELEASE,	FALSE,	FALSE},
2554     {0,				0,		0,	0},
2555 };
2556 #endif /* FEAT_MOUSE */
2557 
2558 /*
2559  * Return the modifier mask bit (MOD_MASK_*) which corresponds to the given
2560  * modifier name ('S' for Shift, 'C' for Ctrl etc).
2561  */
2562     int
2563 name_to_mod_mask(int c)
2564 {
2565     int	    i;
2566 
2567     c = TOUPPER_ASC(c);
2568     for (i = 0; mod_mask_table[i].mod_mask != 0; i++)
2569 	if (c == mod_mask_table[i].name)
2570 	    return mod_mask_table[i].mod_flag;
2571     return 0;
2572 }
2573 
2574 /*
2575  * Check if if there is a special key code for "key" that includes the
2576  * modifiers specified.
2577  */
2578     int
2579 simplify_key(int key, int *modifiers)
2580 {
2581     int	    i;
2582     int	    key0;
2583     int	    key1;
2584 
2585     if (*modifiers & (MOD_MASK_SHIFT | MOD_MASK_CTRL | MOD_MASK_ALT))
2586     {
2587 	/* TAB is a special case */
2588 	if (key == TAB && (*modifiers & MOD_MASK_SHIFT))
2589 	{
2590 	    *modifiers &= ~MOD_MASK_SHIFT;
2591 	    return K_S_TAB;
2592 	}
2593 	key0 = KEY2TERMCAP0(key);
2594 	key1 = KEY2TERMCAP1(key);
2595 	for (i = 0; modifier_keys_table[i] != NUL; i += MOD_KEYS_ENTRY_SIZE)
2596 	    if (key0 == modifier_keys_table[i + 3]
2597 		    && key1 == modifier_keys_table[i + 4]
2598 		    && (*modifiers & modifier_keys_table[i]))
2599 	    {
2600 		*modifiers &= ~modifier_keys_table[i];
2601 		return TERMCAP2KEY(modifier_keys_table[i + 1],
2602 						   modifier_keys_table[i + 2]);
2603 	    }
2604     }
2605     return key;
2606 }
2607 
2608 /*
2609  * Change <xHome> to <Home>, <xUp> to <Up>, etc.
2610  */
2611     int
2612 handle_x_keys(int key)
2613 {
2614     switch (key)
2615     {
2616 	case K_XUP:	return K_UP;
2617 	case K_XDOWN:	return K_DOWN;
2618 	case K_XLEFT:	return K_LEFT;
2619 	case K_XRIGHT:	return K_RIGHT;
2620 	case K_XHOME:	return K_HOME;
2621 	case K_ZHOME:	return K_HOME;
2622 	case K_XEND:	return K_END;
2623 	case K_ZEND:	return K_END;
2624 	case K_XF1:	return K_F1;
2625 	case K_XF2:	return K_F2;
2626 	case K_XF3:	return K_F3;
2627 	case K_XF4:	return K_F4;
2628 	case K_S_XF1:	return K_S_F1;
2629 	case K_S_XF2:	return K_S_F2;
2630 	case K_S_XF3:	return K_S_F3;
2631 	case K_S_XF4:	return K_S_F4;
2632     }
2633     return key;
2634 }
2635 
2636 /*
2637  * Return a string which contains the name of the given key when the given
2638  * modifiers are down.
2639  */
2640     char_u *
2641 get_special_key_name(int c, int modifiers)
2642 {
2643     static char_u string[MAX_KEY_NAME_LEN + 1];
2644 
2645     int	    i, idx;
2646     int	    table_idx;
2647     char_u  *s;
2648 
2649     string[0] = '<';
2650     idx = 1;
2651 
2652     /* Key that stands for a normal character. */
2653     if (IS_SPECIAL(c) && KEY2TERMCAP0(c) == KS_KEY)
2654 	c = KEY2TERMCAP1(c);
2655 
2656     /*
2657      * Translate shifted special keys into unshifted keys and set modifier.
2658      * Same for CTRL and ALT modifiers.
2659      */
2660     if (IS_SPECIAL(c))
2661     {
2662 	for (i = 0; modifier_keys_table[i] != 0; i += MOD_KEYS_ENTRY_SIZE)
2663 	    if (       KEY2TERMCAP0(c) == (int)modifier_keys_table[i + 1]
2664 		    && (int)KEY2TERMCAP1(c) == (int)modifier_keys_table[i + 2])
2665 	    {
2666 		modifiers |= modifier_keys_table[i];
2667 		c = TERMCAP2KEY(modifier_keys_table[i + 3],
2668 						   modifier_keys_table[i + 4]);
2669 		break;
2670 	    }
2671     }
2672 
2673     /* try to find the key in the special key table */
2674     table_idx = find_special_key_in_table(c);
2675 
2676     /*
2677      * When not a known special key, and not a printable character, try to
2678      * extract modifiers.
2679      */
2680     if (c > 0
2681 #ifdef FEAT_MBYTE
2682 	    && (*mb_char2len)(c) == 1
2683 #endif
2684        )
2685     {
2686 	if (table_idx < 0
2687 		&& (!vim_isprintc(c) || (c & 0x7f) == ' ')
2688 		&& (c & 0x80))
2689 	{
2690 	    c &= 0x7f;
2691 	    modifiers |= MOD_MASK_ALT;
2692 	    /* try again, to find the un-alted key in the special key table */
2693 	    table_idx = find_special_key_in_table(c);
2694 	}
2695 	if (table_idx < 0 && !vim_isprintc(c) && c < ' ')
2696 	{
2697 #ifdef EBCDIC
2698 	    c = CtrlChar(c);
2699 #else
2700 	    c += '@';
2701 #endif
2702 	    modifiers |= MOD_MASK_CTRL;
2703 	}
2704     }
2705 
2706     /* translate the modifier into a string */
2707     for (i = 0; mod_mask_table[i].name != 'A'; i++)
2708 	if ((modifiers & mod_mask_table[i].mod_mask)
2709 						== mod_mask_table[i].mod_flag)
2710 	{
2711 	    string[idx++] = mod_mask_table[i].name;
2712 	    string[idx++] = (char_u)'-';
2713 	}
2714 
2715     if (table_idx < 0)		/* unknown special key, may output t_xx */
2716     {
2717 	if (IS_SPECIAL(c))
2718 	{
2719 	    string[idx++] = 't';
2720 	    string[idx++] = '_';
2721 	    string[idx++] = KEY2TERMCAP0(c);
2722 	    string[idx++] = KEY2TERMCAP1(c);
2723 	}
2724 	/* Not a special key, only modifiers, output directly */
2725 	else
2726 	{
2727 #ifdef FEAT_MBYTE
2728 	    if (has_mbyte && (*mb_char2len)(c) > 1)
2729 		idx += (*mb_char2bytes)(c, string + idx);
2730 	    else
2731 #endif
2732 	    if (vim_isprintc(c))
2733 		string[idx++] = c;
2734 	    else
2735 	    {
2736 		s = transchar(c);
2737 		while (*s)
2738 		    string[idx++] = *s++;
2739 	    }
2740 	}
2741     }
2742     else		/* use name of special key */
2743     {
2744 	size_t len = STRLEN(key_names_table[table_idx].name);
2745 
2746 	if (len + idx + 2 <= MAX_KEY_NAME_LEN)
2747 	{
2748 	    STRCPY(string + idx, key_names_table[table_idx].name);
2749 	    idx += (int)len;
2750 	}
2751     }
2752     string[idx++] = '>';
2753     string[idx] = NUL;
2754     return string;
2755 }
2756 
2757 /*
2758  * Try translating a <> name at (*srcp)[] to dst[].
2759  * Return the number of characters added to dst[], zero for no match.
2760  * If there is a match, srcp is advanced to after the <> name.
2761  * dst[] must be big enough to hold the result (up to six characters)!
2762  */
2763     int
2764 trans_special(
2765     char_u	**srcp,
2766     char_u	*dst,
2767     int		keycode, /* prefer key code, e.g. K_DEL instead of DEL */
2768     int		in_string) /* TRUE when inside a double quoted string */
2769 {
2770     int		modifiers = 0;
2771     int		key;
2772     int		dlen = 0;
2773 
2774     key = find_special_key(srcp, &modifiers, keycode, FALSE, in_string);
2775     if (key == 0)
2776 	return 0;
2777 
2778     /* Put the appropriate modifier in a string */
2779     if (modifiers != 0)
2780     {
2781 	dst[dlen++] = K_SPECIAL;
2782 	dst[dlen++] = KS_MODIFIER;
2783 	dst[dlen++] = modifiers;
2784     }
2785 
2786     if (IS_SPECIAL(key))
2787     {
2788 	dst[dlen++] = K_SPECIAL;
2789 	dst[dlen++] = KEY2TERMCAP0(key);
2790 	dst[dlen++] = KEY2TERMCAP1(key);
2791     }
2792 #ifdef FEAT_MBYTE
2793     else if (has_mbyte && !keycode)
2794 	dlen += (*mb_char2bytes)(key, dst + dlen);
2795 #endif
2796     else if (keycode)
2797 	dlen = (int)(add_char2buf(key, dst + dlen) - dst);
2798     else
2799 	dst[dlen++] = key;
2800 
2801     return dlen;
2802 }
2803 
2804 /*
2805  * Try translating a <> name at (*srcp)[], return the key and modifiers.
2806  * srcp is advanced to after the <> name.
2807  * returns 0 if there is no match.
2808  */
2809     int
2810 find_special_key(
2811     char_u	**srcp,
2812     int		*modp,
2813     int		keycode,     /* prefer key code, e.g. K_DEL instead of DEL */
2814     int		keep_x_key,  /* don't translate xHome to Home key */
2815     int		in_string)   /* TRUE in string, double quote is escaped */
2816 {
2817     char_u	*last_dash;
2818     char_u	*end_of_name;
2819     char_u	*src;
2820     char_u	*bp;
2821     int		modifiers;
2822     int		bit;
2823     int		key;
2824     uvarnumber_T	n;
2825     int		l;
2826 
2827     src = *srcp;
2828     if (src[0] != '<')
2829 	return 0;
2830 
2831     /* Find end of modifier list */
2832     last_dash = src;
2833     for (bp = src + 1; *bp == '-' || vim_isIDc(*bp); bp++)
2834     {
2835 	if (*bp == '-')
2836 	{
2837 	    last_dash = bp;
2838 	    if (bp[1] != NUL)
2839 	    {
2840 #ifdef FEAT_MBYTE
2841 		if (has_mbyte)
2842 		    l = mb_ptr2len(bp + 1);
2843 		else
2844 #endif
2845 		    l = 1;
2846 		/* Anything accepted, like <C-?>.
2847 		 * <C-"> or <M-"> are not special in strings as " is
2848 		 * the string delimiter. With a backslash it works: <M-\"> */
2849 		if (!(in_string && bp[1] == '"') && bp[2] == '>')
2850 		    bp += l;
2851 		else if (in_string && bp[1] == '\\' && bp[2] == '"'
2852 							       && bp[3] == '>')
2853 		    bp += 2;
2854 	    }
2855 	}
2856 	if (bp[0] == 't' && bp[1] == '_' && bp[2] && bp[3])
2857 	    bp += 3;	/* skip t_xx, xx may be '-' or '>' */
2858 	else if (STRNICMP(bp, "char-", 5) == 0)
2859 	{
2860 	    vim_str2nr(bp + 5, NULL, &l, STR2NR_ALL, NULL, NULL, 0);
2861 	    bp += l + 5;
2862 	    break;
2863 	}
2864     }
2865 
2866     if (*bp == '>')	/* found matching '>' */
2867     {
2868 	end_of_name = bp + 1;
2869 
2870 	/* Which modifiers are given? */
2871 	modifiers = 0x0;
2872 	for (bp = src + 1; bp < last_dash; bp++)
2873 	{
2874 	    if (*bp != '-')
2875 	    {
2876 		bit = name_to_mod_mask(*bp);
2877 		if (bit == 0x0)
2878 		    break;	/* Illegal modifier name */
2879 		modifiers |= bit;
2880 	    }
2881 	}
2882 
2883 	/*
2884 	 * Legal modifier name.
2885 	 */
2886 	if (bp >= last_dash)
2887 	{
2888 	    if (STRNICMP(last_dash + 1, "char-", 5) == 0
2889 						 && VIM_ISDIGIT(last_dash[6]))
2890 	    {
2891 		/* <Char-123> or <Char-033> or <Char-0x33> */
2892 		vim_str2nr(last_dash + 6, NULL, NULL, STR2NR_ALL, NULL, &n, 0);
2893 		key = (int)n;
2894 	    }
2895 	    else
2896 	    {
2897 		int off = 1;
2898 
2899 		/* Modifier with single letter, or special key name.  */
2900 		if (in_string && last_dash[1] == '\\' && last_dash[2] == '"')
2901 		    off = 2;
2902 #ifdef FEAT_MBYTE
2903 		if (has_mbyte)
2904 		    l = mb_ptr2len(last_dash + off);
2905 		else
2906 #endif
2907 		    l = 1;
2908 		if (modifiers != 0 && last_dash[l + off] == '>')
2909 		    key = PTR2CHAR(last_dash + off);
2910 		else
2911 		{
2912 		    key = get_special_key_code(last_dash + off);
2913 		    if (!keep_x_key)
2914 			key = handle_x_keys(key);
2915 		}
2916 	    }
2917 
2918 	    /*
2919 	     * get_special_key_code() may return NUL for invalid
2920 	     * special key name.
2921 	     */
2922 	    if (key != NUL)
2923 	    {
2924 		/*
2925 		 * Only use a modifier when there is no special key code that
2926 		 * includes the modifier.
2927 		 */
2928 		key = simplify_key(key, &modifiers);
2929 
2930 		if (!keycode)
2931 		{
2932 		    /* don't want keycode, use single byte code */
2933 		    if (key == K_BS)
2934 			key = BS;
2935 		    else if (key == K_DEL || key == K_KDEL)
2936 			key = DEL;
2937 		}
2938 
2939 		/*
2940 		 * Normal Key with modifier: Try to make a single byte code.
2941 		 */
2942 		if (!IS_SPECIAL(key))
2943 		    key = extract_modifiers(key, &modifiers);
2944 
2945 		*modp = modifiers;
2946 		*srcp = end_of_name;
2947 		return key;
2948 	    }
2949 	}
2950     }
2951     return 0;
2952 }
2953 
2954 /*
2955  * Try to include modifiers in the key.
2956  * Changes "Shift-a" to 'A', "Alt-A" to 0xc0, etc.
2957  */
2958     int
2959 extract_modifiers(int key, int *modp)
2960 {
2961     int	modifiers = *modp;
2962 
2963 #ifdef MACOS_X
2964     /* Command-key really special, no fancynest */
2965     if (!(modifiers & MOD_MASK_CMD))
2966 #endif
2967     if ((modifiers & MOD_MASK_SHIFT) && ASCII_ISALPHA(key))
2968     {
2969 	key = TOUPPER_ASC(key);
2970 	modifiers &= ~MOD_MASK_SHIFT;
2971     }
2972     if ((modifiers & MOD_MASK_CTRL)
2973 #ifdef EBCDIC
2974 	    /* * TODO: EBCDIC Better use:
2975 	     * && (Ctrl_chr(key) || key == '?')
2976 	     * ???  */
2977 	    && strchr("?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_", key)
2978 						       != NULL
2979 #else
2980 	    && ((key >= '?' && key <= '_') || ASCII_ISALPHA(key))
2981 #endif
2982 	    )
2983     {
2984 	key = Ctrl_chr(key);
2985 	modifiers &= ~MOD_MASK_CTRL;
2986 	/* <C-@> is <Nul> */
2987 	if (key == 0)
2988 	    key = K_ZERO;
2989     }
2990 #ifdef MACOS_X
2991     /* Command-key really special, no fancynest */
2992     if (!(modifiers & MOD_MASK_CMD))
2993 #endif
2994     if ((modifiers & MOD_MASK_ALT) && key < 0x80
2995 #ifdef FEAT_MBYTE
2996 	    && !enc_dbcs		/* avoid creating a lead byte */
2997 #endif
2998 	    )
2999     {
3000 	key |= 0x80;
3001 	modifiers &= ~MOD_MASK_ALT;	/* remove the META modifier */
3002     }
3003 
3004     *modp = modifiers;
3005     return key;
3006 }
3007 
3008 /*
3009  * Try to find key "c" in the special key table.
3010  * Return the index when found, -1 when not found.
3011  */
3012     int
3013 find_special_key_in_table(int c)
3014 {
3015     int	    i;
3016 
3017     for (i = 0; key_names_table[i].name != NULL; i++)
3018 	if (c == key_names_table[i].key)
3019 	    break;
3020     if (key_names_table[i].name == NULL)
3021 	i = -1;
3022     return i;
3023 }
3024 
3025 /*
3026  * Find the special key with the given name (the given string does not have to
3027  * end with NUL, the name is assumed to end before the first non-idchar).
3028  * If the name starts with "t_" the next two characters are interpreted as a
3029  * termcap name.
3030  * Return the key code, or 0 if not found.
3031  */
3032     int
3033 get_special_key_code(char_u *name)
3034 {
3035     char_u  *table_name;
3036     char_u  string[3];
3037     int	    i, j;
3038 
3039     /*
3040      * If it's <t_xx> we get the code for xx from the termcap
3041      */
3042     if (name[0] == 't' && name[1] == '_' && name[2] != NUL && name[3] != NUL)
3043     {
3044 	string[0] = name[2];
3045 	string[1] = name[3];
3046 	string[2] = NUL;
3047 	if (add_termcap_entry(string, FALSE) == OK)
3048 	    return TERMCAP2KEY(name[2], name[3]);
3049     }
3050     else
3051 	for (i = 0; key_names_table[i].name != NULL; i++)
3052 	{
3053 	    table_name = key_names_table[i].name;
3054 	    for (j = 0; vim_isIDc(name[j]) && table_name[j] != NUL; j++)
3055 		if (TOLOWER_ASC(table_name[j]) != TOLOWER_ASC(name[j]))
3056 		    break;
3057 	    if (!vim_isIDc(name[j]) && table_name[j] == NUL)
3058 		return key_names_table[i].key;
3059 	}
3060     return 0;
3061 }
3062 
3063 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3064     char_u *
3065 get_key_name(int i)
3066 {
3067     if (i >= (int)KEY_NAMES_TABLE_LEN)
3068 	return NULL;
3069     return  key_names_table[i].name;
3070 }
3071 #endif
3072 
3073 #if defined(FEAT_MOUSE) || defined(PROTO)
3074 /*
3075  * Look up the given mouse code to return the relevant information in the other
3076  * arguments.  Return which button is down or was released.
3077  */
3078     int
3079 get_mouse_button(int code, int *is_click, int *is_drag)
3080 {
3081     int	    i;
3082 
3083     for (i = 0; mouse_table[i].pseudo_code; i++)
3084 	if (code == mouse_table[i].pseudo_code)
3085 	{
3086 	    *is_click = mouse_table[i].is_click;
3087 	    *is_drag = mouse_table[i].is_drag;
3088 	    return mouse_table[i].button;
3089 	}
3090     return 0;	    /* Shouldn't get here */
3091 }
3092 
3093 /*
3094  * Return the appropriate pseudo mouse event token (KE_LEFTMOUSE etc) based on
3095  * the given information about which mouse button is down, and whether the
3096  * mouse was clicked, dragged or released.
3097  */
3098     int
3099 get_pseudo_mouse_code(
3100     int	    button,	/* eg MOUSE_LEFT */
3101     int	    is_click,
3102     int	    is_drag)
3103 {
3104     int	    i;
3105 
3106     for (i = 0; mouse_table[i].pseudo_code; i++)
3107 	if (button == mouse_table[i].button
3108 	    && is_click == mouse_table[i].is_click
3109 	    && is_drag == mouse_table[i].is_drag)
3110 	{
3111 #ifdef FEAT_GUI
3112 	    /* Trick: a non mappable left click and release has mouse_col -1
3113 	     * or added MOUSE_COLOFF.  Used for 'mousefocus' in
3114 	     * gui_mouse_moved() */
3115 	    if (mouse_col < 0 || mouse_col > MOUSE_COLOFF)
3116 	    {
3117 		if (mouse_col < 0)
3118 		    mouse_col = 0;
3119 		else
3120 		    mouse_col -= MOUSE_COLOFF;
3121 		if (mouse_table[i].pseudo_code == (int)KE_LEFTMOUSE)
3122 		    return (int)KE_LEFTMOUSE_NM;
3123 		if (mouse_table[i].pseudo_code == (int)KE_LEFTRELEASE)
3124 		    return (int)KE_LEFTRELEASE_NM;
3125 	    }
3126 #endif
3127 	    return mouse_table[i].pseudo_code;
3128 	}
3129     return (int)KE_IGNORE;	    /* not recognized, ignore it */
3130 }
3131 #endif /* FEAT_MOUSE */
3132 
3133 /*
3134  * Return the current end-of-line type: EOL_DOS, EOL_UNIX or EOL_MAC.
3135  */
3136     int
3137 get_fileformat(buf_T *buf)
3138 {
3139     int		c = *buf->b_p_ff;
3140 
3141     if (buf->b_p_bin || c == 'u')
3142 	return EOL_UNIX;
3143     if (c == 'm')
3144 	return EOL_MAC;
3145     return EOL_DOS;
3146 }
3147 
3148 /*
3149  * Like get_fileformat(), but override 'fileformat' with "p" for "++opt=val"
3150  * argument.
3151  */
3152     int
3153 get_fileformat_force(
3154     buf_T	*buf,
3155     exarg_T	*eap)	    /* can be NULL! */
3156 {
3157     int		c;
3158 
3159     if (eap != NULL && eap->force_ff != 0)
3160 	c = eap->force_ff;
3161     else
3162     {
3163 	if ((eap != NULL && eap->force_bin != 0)
3164 			       ? (eap->force_bin == FORCE_BIN) : buf->b_p_bin)
3165 	    return EOL_UNIX;
3166 	c = *buf->b_p_ff;
3167     }
3168     if (c == 'u')
3169 	return EOL_UNIX;
3170     if (c == 'm')
3171 	return EOL_MAC;
3172     return EOL_DOS;
3173 }
3174 
3175 /*
3176  * Set the current end-of-line type to EOL_DOS, EOL_UNIX or EOL_MAC.
3177  * Sets both 'textmode' and 'fileformat'.
3178  * Note: Does _not_ set global value of 'textmode'!
3179  */
3180     void
3181 set_fileformat(
3182     int		t,
3183     int		opt_flags)	/* OPT_LOCAL and/or OPT_GLOBAL */
3184 {
3185     char	*p = NULL;
3186 
3187     switch (t)
3188     {
3189     case EOL_DOS:
3190 	p = FF_DOS;
3191 	curbuf->b_p_tx = TRUE;
3192 	break;
3193     case EOL_UNIX:
3194 	p = FF_UNIX;
3195 	curbuf->b_p_tx = FALSE;
3196 	break;
3197     case EOL_MAC:
3198 	p = FF_MAC;
3199 	curbuf->b_p_tx = FALSE;
3200 	break;
3201     }
3202     if (p != NULL)
3203 	set_string_option_direct((char_u *)"ff", -1, (char_u *)p,
3204 						     OPT_FREE | opt_flags, 0);
3205 
3206     /* This may cause the buffer to become (un)modified. */
3207     check_status(curbuf);
3208     redraw_tabline = TRUE;
3209 #ifdef FEAT_TITLE
3210     need_maketitle = TRUE;	    /* set window title later */
3211 #endif
3212 }
3213 
3214 /*
3215  * Return the default fileformat from 'fileformats'.
3216  */
3217     int
3218 default_fileformat(void)
3219 {
3220     switch (*p_ffs)
3221     {
3222 	case 'm':   return EOL_MAC;
3223 	case 'd':   return EOL_DOS;
3224     }
3225     return EOL_UNIX;
3226 }
3227 
3228 /*
3229  * Call shell.	Calls mch_call_shell, with 'shellxquote' added.
3230  */
3231     int
3232 call_shell(char_u *cmd, int opt)
3233 {
3234     char_u	*ncmd;
3235     int		retval;
3236 #ifdef FEAT_PROFILE
3237     proftime_T	wait_time;
3238 #endif
3239 
3240     if (p_verbose > 3)
3241     {
3242 	verbose_enter();
3243 	smsg((char_u *)_("Calling shell to execute: \"%s\""),
3244 						    cmd == NULL ? p_sh : cmd);
3245 	out_char('\n');
3246 	cursor_on();
3247 	verbose_leave();
3248     }
3249 
3250 #ifdef FEAT_PROFILE
3251     if (do_profiling == PROF_YES)
3252 	prof_child_enter(&wait_time);
3253 #endif
3254 
3255     if (*p_sh == NUL)
3256     {
3257 	EMSG(_(e_shellempty));
3258 	retval = -1;
3259     }
3260     else
3261     {
3262 #ifdef FEAT_GUI_MSWIN
3263 	/* Don't hide the pointer while executing a shell command. */
3264 	gui_mch_mousehide(FALSE);
3265 #endif
3266 #ifdef FEAT_GUI
3267 	++hold_gui_events;
3268 #endif
3269 	/* The external command may update a tags file, clear cached tags. */
3270 	tag_freematch();
3271 
3272 	if (cmd == NULL || *p_sxq == NUL)
3273 	    retval = mch_call_shell(cmd, opt);
3274 	else
3275 	{
3276 	    char_u *ecmd = cmd;
3277 
3278 	    if (*p_sxe != NUL && STRCMP(p_sxq, "(") == 0)
3279 	    {
3280 		ecmd = vim_strsave_escaped_ext(cmd, p_sxe, '^', FALSE);
3281 		if (ecmd == NULL)
3282 		    ecmd = cmd;
3283 	    }
3284 	    ncmd = alloc((unsigned)(STRLEN(ecmd) + STRLEN(p_sxq) * 2 + 1));
3285 	    if (ncmd != NULL)
3286 	    {
3287 		STRCPY(ncmd, p_sxq);
3288 		STRCAT(ncmd, ecmd);
3289 		/* When 'shellxquote' is ( append ).
3290 		 * When 'shellxquote' is "( append )". */
3291 		STRCAT(ncmd, STRCMP(p_sxq, "(") == 0 ? (char_u *)")"
3292 			   : STRCMP(p_sxq, "\"(") == 0 ? (char_u *)")\""
3293 			   : p_sxq);
3294 		retval = mch_call_shell(ncmd, opt);
3295 		vim_free(ncmd);
3296 	    }
3297 	    else
3298 		retval = -1;
3299 	    if (ecmd != cmd)
3300 		vim_free(ecmd);
3301 	}
3302 #ifdef FEAT_GUI
3303 	--hold_gui_events;
3304 #endif
3305 	/*
3306 	 * Check the window size, in case it changed while executing the
3307 	 * external command.
3308 	 */
3309 	shell_resized_check();
3310     }
3311 
3312 #ifdef FEAT_EVAL
3313     set_vim_var_nr(VV_SHELL_ERROR, (long)retval);
3314 # ifdef FEAT_PROFILE
3315     if (do_profiling == PROF_YES)
3316 	prof_child_exit(&wait_time);
3317 # endif
3318 #endif
3319 
3320     return retval;
3321 }
3322 
3323 /*
3324  * VISUAL, SELECTMODE and OP_PENDING State are never set, they are equal to
3325  * NORMAL State with a condition.  This function returns the real State.
3326  */
3327     int
3328 get_real_state(void)
3329 {
3330     if (State & NORMAL)
3331     {
3332 	if (VIsual_active)
3333 	{
3334 	    if (VIsual_select)
3335 		return SELECTMODE;
3336 	    return VISUAL;
3337 	}
3338 	else if (finish_op)
3339 	    return OP_PENDING;
3340     }
3341     return State;
3342 }
3343 
3344 #if defined(FEAT_MBYTE) || defined(PROTO)
3345 /*
3346  * Return TRUE if "p" points to just after a path separator.
3347  * Takes care of multi-byte characters.
3348  * "b" must point to the start of the file name
3349  */
3350     int
3351 after_pathsep(char_u *b, char_u *p)
3352 {
3353     return p > b && vim_ispathsep(p[-1])
3354 			     && (!has_mbyte || (*mb_head_off)(b, p - 1) == 0);
3355 }
3356 #endif
3357 
3358 /*
3359  * Return TRUE if file names "f1" and "f2" are in the same directory.
3360  * "f1" may be a short name, "f2" must be a full path.
3361  */
3362     int
3363 same_directory(char_u *f1, char_u *f2)
3364 {
3365     char_u	ffname[MAXPATHL];
3366     char_u	*t1;
3367     char_u	*t2;
3368 
3369     /* safety check */
3370     if (f1 == NULL || f2 == NULL)
3371 	return FALSE;
3372 
3373     (void)vim_FullName(f1, ffname, MAXPATHL, FALSE);
3374     t1 = gettail_sep(ffname);
3375     t2 = gettail_sep(f2);
3376     return (t1 - ffname == t2 - f2
3377 	     && pathcmp((char *)ffname, (char *)f2, (int)(t1 - ffname)) == 0);
3378 }
3379 
3380 #if defined(FEAT_SESSION) || defined(FEAT_AUTOCHDIR) \
3381 	|| defined(MSWIN) || defined(FEAT_GUI_MAC) || defined(FEAT_GUI_GTK) \
3382 	|| defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG) \
3383 	|| defined(PROTO)
3384 /*
3385  * Change to a file's directory.
3386  * Caller must call shorten_fnames()!
3387  * Return OK or FAIL.
3388  */
3389     int
3390 vim_chdirfile(char_u *fname, char *trigger_autocmd UNUSED)
3391 {
3392     char_u	dir[MAXPATHL];
3393     int		res;
3394 
3395     vim_strncpy(dir, fname, MAXPATHL - 1);
3396     *gettail_sep(dir) = NUL;
3397     res = mch_chdir((char *)dir) == 0 ? OK : FAIL;
3398     if (res == OK && trigger_autocmd != NULL)
3399 	apply_autocmds(EVENT_DIRCHANGED, (char_u *)trigger_autocmd,
3400 							   dir, FALSE, curbuf);
3401     return res;
3402 }
3403 #endif
3404 
3405 #if defined(STAT_IGNORES_SLASH) || defined(PROTO)
3406 /*
3407  * Check if "name" ends in a slash and is not a directory.
3408  * Used for systems where stat() ignores a trailing slash on a file name.
3409  * The Vim code assumes a trailing slash is only ignored for a directory.
3410  */
3411     static int
3412 illegal_slash(const char *name)
3413 {
3414     if (name[0] == NUL)
3415 	return FALSE;	    /* no file name is not illegal */
3416     if (name[strlen(name) - 1] != '/')
3417 	return FALSE;	    /* no trailing slash */
3418     if (mch_isdir((char_u *)name))
3419 	return FALSE;	    /* trailing slash for a directory */
3420     return TRUE;
3421 }
3422 
3423 /*
3424  * Special implementation of mch_stat() for Solaris.
3425  */
3426     int
3427 vim_stat(const char *name, stat_T *stp)
3428 {
3429     /* On Solaris stat() accepts "file/" as if it was "file".  Return -1 if
3430      * the name ends in "/" and it's not a directory. */
3431     return illegal_slash(name) ? -1 : stat(name, stp);
3432 }
3433 #endif
3434 
3435 #if defined(CURSOR_SHAPE) || defined(PROTO)
3436 
3437 /*
3438  * Handling of cursor and mouse pointer shapes in various modes.
3439  */
3440 
3441 cursorentry_T shape_table[SHAPE_IDX_COUNT] =
3442 {
3443     /* The values will be filled in from the 'guicursor' and 'mouseshape'
3444      * defaults when Vim starts.
3445      * Adjust the SHAPE_IDX_ defines when making changes! */
3446     {0,	0, 0, 700L, 400L, 250L, 0, 0, "n", SHAPE_CURSOR+SHAPE_MOUSE},
3447     {0,	0, 0, 700L, 400L, 250L, 0, 0, "v", SHAPE_CURSOR+SHAPE_MOUSE},
3448     {0,	0, 0, 700L, 400L, 250L, 0, 0, "i", SHAPE_CURSOR+SHAPE_MOUSE},
3449     {0,	0, 0, 700L, 400L, 250L, 0, 0, "r", SHAPE_CURSOR+SHAPE_MOUSE},
3450     {0,	0, 0, 700L, 400L, 250L, 0, 0, "c", SHAPE_CURSOR+SHAPE_MOUSE},
3451     {0,	0, 0, 700L, 400L, 250L, 0, 0, "ci", SHAPE_CURSOR+SHAPE_MOUSE},
3452     {0,	0, 0, 700L, 400L, 250L, 0, 0, "cr", SHAPE_CURSOR+SHAPE_MOUSE},
3453     {0,	0, 0, 700L, 400L, 250L, 0, 0, "o", SHAPE_CURSOR+SHAPE_MOUSE},
3454     {0,	0, 0, 700L, 400L, 250L, 0, 0, "ve", SHAPE_CURSOR+SHAPE_MOUSE},
3455     {0,	0, 0,   0L,   0L,   0L, 0, 0, "e", SHAPE_MOUSE},
3456     {0,	0, 0,   0L,   0L,   0L, 0, 0, "s", SHAPE_MOUSE},
3457     {0,	0, 0,   0L,   0L,   0L, 0, 0, "sd", SHAPE_MOUSE},
3458     {0,	0, 0,   0L,   0L,   0L, 0, 0, "vs", SHAPE_MOUSE},
3459     {0,	0, 0,   0L,   0L,   0L, 0, 0, "vd", SHAPE_MOUSE},
3460     {0,	0, 0,   0L,   0L,   0L, 0, 0, "m", SHAPE_MOUSE},
3461     {0,	0, 0,   0L,   0L,   0L, 0, 0, "ml", SHAPE_MOUSE},
3462     {0,	0, 0, 100L, 100L, 100L, 0, 0, "sm", SHAPE_CURSOR},
3463 };
3464 
3465 #ifdef FEAT_MOUSESHAPE
3466 /*
3467  * Table with names for mouse shapes.  Keep in sync with all the tables for
3468  * mch_set_mouse_shape()!.
3469  */
3470 static char * mshape_names[] =
3471 {
3472     "arrow",	/* default, must be the first one */
3473     "blank",	/* hidden */
3474     "beam",
3475     "updown",
3476     "udsizing",
3477     "leftright",
3478     "lrsizing",
3479     "busy",
3480     "no",
3481     "crosshair",
3482     "hand1",
3483     "hand2",
3484     "pencil",
3485     "question",
3486     "rightup-arrow",
3487     "up-arrow",
3488     NULL
3489 };
3490 #endif
3491 
3492 /*
3493  * Parse the 'guicursor' option ("what" is SHAPE_CURSOR) or 'mouseshape'
3494  * ("what" is SHAPE_MOUSE).
3495  * Returns error message for an illegal option, NULL otherwise.
3496  */
3497     char_u *
3498 parse_shape_opt(int what)
3499 {
3500     char_u	*modep;
3501     char_u	*colonp;
3502     char_u	*commap;
3503     char_u	*slashp;
3504     char_u	*p, *endp;
3505     int		idx = 0;		/* init for GCC */
3506     int		all_idx;
3507     int		len;
3508     int		i;
3509     long	n;
3510     int		found_ve = FALSE;	/* found "ve" flag */
3511     int		round;
3512 
3513     /*
3514      * First round: check for errors; second round: do it for real.
3515      */
3516     for (round = 1; round <= 2; ++round)
3517     {
3518 	/*
3519 	 * Repeat for all comma separated parts.
3520 	 */
3521 #ifdef FEAT_MOUSESHAPE
3522 	if (what == SHAPE_MOUSE)
3523 	    modep = p_mouseshape;
3524 	else
3525 #endif
3526 	    modep = p_guicursor;
3527 	while (*modep != NUL)
3528 	{
3529 	    colonp = vim_strchr(modep, ':');
3530 	    commap = vim_strchr(modep, ',');
3531 
3532 	    if (colonp == NULL || (commap != NULL && commap < colonp))
3533 		return (char_u *)N_("E545: Missing colon");
3534 	    if (colonp == modep)
3535 		return (char_u *)N_("E546: Illegal mode");
3536 
3537 	    /*
3538 	     * Repeat for all mode's before the colon.
3539 	     * For the 'a' mode, we loop to handle all the modes.
3540 	     */
3541 	    all_idx = -1;
3542 	    while (modep < colonp || all_idx >= 0)
3543 	    {
3544 		if (all_idx < 0)
3545 		{
3546 		    /* Find the mode. */
3547 		    if (modep[1] == '-' || modep[1] == ':')
3548 			len = 1;
3549 		    else
3550 			len = 2;
3551 		    if (len == 1 && TOLOWER_ASC(modep[0]) == 'a')
3552 			all_idx = SHAPE_IDX_COUNT - 1;
3553 		    else
3554 		    {
3555 			for (idx = 0; idx < SHAPE_IDX_COUNT; ++idx)
3556 			    if (STRNICMP(modep, shape_table[idx].name, len)
3557 									 == 0)
3558 				break;
3559 			if (idx == SHAPE_IDX_COUNT
3560 				   || (shape_table[idx].used_for & what) == 0)
3561 			    return (char_u *)N_("E546: Illegal mode");
3562 			if (len == 2 && modep[0] == 'v' && modep[1] == 'e')
3563 			    found_ve = TRUE;
3564 		    }
3565 		    modep += len + 1;
3566 		}
3567 
3568 		if (all_idx >= 0)
3569 		    idx = all_idx--;
3570 		else if (round == 2)
3571 		{
3572 #ifdef FEAT_MOUSESHAPE
3573 		    if (what == SHAPE_MOUSE)
3574 		    {
3575 			/* Set the default, for the missing parts */
3576 			shape_table[idx].mshape = 0;
3577 		    }
3578 		    else
3579 #endif
3580 		    {
3581 			/* Set the defaults, for the missing parts */
3582 			shape_table[idx].shape = SHAPE_BLOCK;
3583 			shape_table[idx].blinkwait = 700L;
3584 			shape_table[idx].blinkon = 400L;
3585 			shape_table[idx].blinkoff = 250L;
3586 		    }
3587 		}
3588 
3589 		/* Parse the part after the colon */
3590 		for (p = colonp + 1; *p && *p != ','; )
3591 		{
3592 #ifdef FEAT_MOUSESHAPE
3593 		    if (what == SHAPE_MOUSE)
3594 		    {
3595 			for (i = 0; ; ++i)
3596 			{
3597 			    if (mshape_names[i] == NULL)
3598 			    {
3599 				if (!VIM_ISDIGIT(*p))
3600 				    return (char_u *)N_("E547: Illegal mouseshape");
3601 				if (round == 2)
3602 				    shape_table[idx].mshape =
3603 					      getdigits(&p) + MSHAPE_NUMBERED;
3604 				else
3605 				    (void)getdigits(&p);
3606 				break;
3607 			    }
3608 			    len = (int)STRLEN(mshape_names[i]);
3609 			    if (STRNICMP(p, mshape_names[i], len) == 0)
3610 			    {
3611 				if (round == 2)
3612 				    shape_table[idx].mshape = i;
3613 				p += len;
3614 				break;
3615 			    }
3616 			}
3617 		    }
3618 		    else /* if (what == SHAPE_MOUSE) */
3619 #endif
3620 		    {
3621 			/*
3622 			 * First handle the ones with a number argument.
3623 			 */
3624 			i = *p;
3625 			len = 0;
3626 			if (STRNICMP(p, "ver", 3) == 0)
3627 			    len = 3;
3628 			else if (STRNICMP(p, "hor", 3) == 0)
3629 			    len = 3;
3630 			else if (STRNICMP(p, "blinkwait", 9) == 0)
3631 			    len = 9;
3632 			else if (STRNICMP(p, "blinkon", 7) == 0)
3633 			    len = 7;
3634 			else if (STRNICMP(p, "blinkoff", 8) == 0)
3635 			    len = 8;
3636 			if (len != 0)
3637 			{
3638 			    p += len;
3639 			    if (!VIM_ISDIGIT(*p))
3640 				return (char_u *)N_("E548: digit expected");
3641 			    n = getdigits(&p);
3642 			    if (len == 3)   /* "ver" or "hor" */
3643 			    {
3644 				if (n == 0)
3645 				    return (char_u *)N_("E549: Illegal percentage");
3646 				if (round == 2)
3647 				{
3648 				    if (TOLOWER_ASC(i) == 'v')
3649 					shape_table[idx].shape = SHAPE_VER;
3650 				    else
3651 					shape_table[idx].shape = SHAPE_HOR;
3652 				    shape_table[idx].percentage = n;
3653 				}
3654 			    }
3655 			    else if (round == 2)
3656 			    {
3657 				if (len == 9)
3658 				    shape_table[idx].blinkwait = n;
3659 				else if (len == 7)
3660 				    shape_table[idx].blinkon = n;
3661 				else
3662 				    shape_table[idx].blinkoff = n;
3663 			    }
3664 			}
3665 			else if (STRNICMP(p, "block", 5) == 0)
3666 			{
3667 			    if (round == 2)
3668 				shape_table[idx].shape = SHAPE_BLOCK;
3669 			    p += 5;
3670 			}
3671 			else	/* must be a highlight group name then */
3672 			{
3673 			    endp = vim_strchr(p, '-');
3674 			    if (commap == NULL)		    /* last part */
3675 			    {
3676 				if (endp == NULL)
3677 				    endp = p + STRLEN(p);   /* find end of part */
3678 			    }
3679 			    else if (endp > commap || endp == NULL)
3680 				endp = commap;
3681 			    slashp = vim_strchr(p, '/');
3682 			    if (slashp != NULL && slashp < endp)
3683 			    {
3684 				/* "group/langmap_group" */
3685 				i = syn_check_group(p, (int)(slashp - p));
3686 				p = slashp + 1;
3687 			    }
3688 			    if (round == 2)
3689 			    {
3690 				shape_table[idx].id = syn_check_group(p,
3691 							     (int)(endp - p));
3692 				shape_table[idx].id_lm = shape_table[idx].id;
3693 				if (slashp != NULL && slashp < endp)
3694 				    shape_table[idx].id = i;
3695 			    }
3696 			    p = endp;
3697 			}
3698 		    } /* if (what != SHAPE_MOUSE) */
3699 
3700 		    if (*p == '-')
3701 			++p;
3702 		}
3703 	    }
3704 	    modep = p;
3705 	    if (*modep == ',')
3706 		++modep;
3707 	}
3708     }
3709 
3710     /* If the 's' flag is not given, use the 'v' cursor for 's' */
3711     if (!found_ve)
3712     {
3713 #ifdef FEAT_MOUSESHAPE
3714 	if (what == SHAPE_MOUSE)
3715 	{
3716 	    shape_table[SHAPE_IDX_VE].mshape = shape_table[SHAPE_IDX_V].mshape;
3717 	}
3718 	else
3719 #endif
3720 	{
3721 	    shape_table[SHAPE_IDX_VE].shape = shape_table[SHAPE_IDX_V].shape;
3722 	    shape_table[SHAPE_IDX_VE].percentage =
3723 					 shape_table[SHAPE_IDX_V].percentage;
3724 	    shape_table[SHAPE_IDX_VE].blinkwait =
3725 					  shape_table[SHAPE_IDX_V].blinkwait;
3726 	    shape_table[SHAPE_IDX_VE].blinkon =
3727 					    shape_table[SHAPE_IDX_V].blinkon;
3728 	    shape_table[SHAPE_IDX_VE].blinkoff =
3729 					   shape_table[SHAPE_IDX_V].blinkoff;
3730 	    shape_table[SHAPE_IDX_VE].id = shape_table[SHAPE_IDX_V].id;
3731 	    shape_table[SHAPE_IDX_VE].id_lm = shape_table[SHAPE_IDX_V].id_lm;
3732 	}
3733     }
3734 
3735     return NULL;
3736 }
3737 
3738 # if defined(MCH_CURSOR_SHAPE) || defined(FEAT_GUI) \
3739 	|| defined(FEAT_MOUSESHAPE) || defined(PROTO)
3740 /*
3741  * Return the index into shape_table[] for the current mode.
3742  * When "mouse" is TRUE, consider indexes valid for the mouse pointer.
3743  */
3744     int
3745 get_shape_idx(int mouse)
3746 {
3747 #ifdef FEAT_MOUSESHAPE
3748     if (mouse && (State == HITRETURN || State == ASKMORE))
3749     {
3750 # ifdef FEAT_GUI
3751 	int x, y;
3752 	gui_mch_getmouse(&x, &y);
3753 	if (Y_2_ROW(y) == Rows - 1)
3754 	    return SHAPE_IDX_MOREL;
3755 # endif
3756 	return SHAPE_IDX_MORE;
3757     }
3758     if (mouse && drag_status_line)
3759 	return SHAPE_IDX_SDRAG;
3760     if (mouse && drag_sep_line)
3761 	return SHAPE_IDX_VDRAG;
3762 #endif
3763     if (!mouse && State == SHOWMATCH)
3764 	return SHAPE_IDX_SM;
3765     if (State & VREPLACE_FLAG)
3766 	return SHAPE_IDX_R;
3767     if (State & REPLACE_FLAG)
3768 	return SHAPE_IDX_R;
3769     if (State & INSERT)
3770 	return SHAPE_IDX_I;
3771     if (State & CMDLINE)
3772     {
3773 	if (cmdline_at_end())
3774 	    return SHAPE_IDX_C;
3775 	if (cmdline_overstrike())
3776 	    return SHAPE_IDX_CR;
3777 	return SHAPE_IDX_CI;
3778     }
3779     if (finish_op)
3780 	return SHAPE_IDX_O;
3781     if (VIsual_active)
3782     {
3783 	if (*p_sel == 'e')
3784 	    return SHAPE_IDX_VE;
3785 	else
3786 	    return SHAPE_IDX_V;
3787     }
3788     return SHAPE_IDX_N;
3789 }
3790 #endif
3791 
3792 # if defined(FEAT_MOUSESHAPE) || defined(PROTO)
3793 static int old_mouse_shape = 0;
3794 
3795 /*
3796  * Set the mouse shape:
3797  * If "shape" is -1, use shape depending on the current mode,
3798  * depending on the current state.
3799  * If "shape" is -2, only update the shape when it's CLINE or STATUS (used
3800  * when the mouse moves off the status or command line).
3801  */
3802     void
3803 update_mouseshape(int shape_idx)
3804 {
3805     int new_mouse_shape;
3806 
3807     /* Only works in GUI mode. */
3808     if (!gui.in_use || gui.starting)
3809 	return;
3810 
3811     /* Postpone the updating when more is to come.  Speeds up executing of
3812      * mappings. */
3813     if (shape_idx == -1 && char_avail())
3814     {
3815 	postponed_mouseshape = TRUE;
3816 	return;
3817     }
3818 
3819     /* When ignoring the mouse don't change shape on the statusline. */
3820     if (*p_mouse == NUL
3821 	    && (shape_idx == SHAPE_IDX_CLINE
3822 		|| shape_idx == SHAPE_IDX_STATUS
3823 		|| shape_idx == SHAPE_IDX_VSEP))
3824 	shape_idx = -2;
3825 
3826     if (shape_idx == -2
3827 	    && old_mouse_shape != shape_table[SHAPE_IDX_CLINE].mshape
3828 	    && old_mouse_shape != shape_table[SHAPE_IDX_STATUS].mshape
3829 	    && old_mouse_shape != shape_table[SHAPE_IDX_VSEP].mshape)
3830 	return;
3831     if (shape_idx < 0)
3832 	new_mouse_shape = shape_table[get_shape_idx(TRUE)].mshape;
3833     else
3834 	new_mouse_shape = shape_table[shape_idx].mshape;
3835     if (new_mouse_shape != old_mouse_shape)
3836     {
3837 	mch_set_mouse_shape(new_mouse_shape);
3838 	old_mouse_shape = new_mouse_shape;
3839     }
3840     postponed_mouseshape = FALSE;
3841 }
3842 # endif
3843 
3844 #endif /* CURSOR_SHAPE */
3845 
3846 
3847 /* TODO: make some #ifdef for this */
3848 /*--------[ file searching ]-------------------------------------------------*/
3849 /*
3850  * File searching functions for 'path', 'tags' and 'cdpath' options.
3851  * External visible functions:
3852  * vim_findfile_init()		creates/initialises the search context
3853  * vim_findfile_free_visited()	free list of visited files/dirs of search
3854  *				context
3855  * vim_findfile()		find a file in the search context
3856  * vim_findfile_cleanup()	cleanup/free search context created by
3857  *				vim_findfile_init()
3858  *
3859  * All static functions and variables start with 'ff_'
3860  *
3861  * In general it works like this:
3862  * First you create yourself a search context by calling vim_findfile_init().
3863  * It is possible to give a search context from a previous call to
3864  * vim_findfile_init(), so it can be reused. After this you call vim_findfile()
3865  * until you are satisfied with the result or it returns NULL. On every call it
3866  * returns the next file which matches the conditions given to
3867  * vim_findfile_init(). If it doesn't find a next file it returns NULL.
3868  *
3869  * It is possible to call vim_findfile_init() again to reinitialise your search
3870  * with some new parameters. Don't forget to pass your old search context to
3871  * it, so it can reuse it and especially reuse the list of already visited
3872  * directories. If you want to delete the list of already visited directories
3873  * simply call vim_findfile_free_visited().
3874  *
3875  * When you are done call vim_findfile_cleanup() to free the search context.
3876  *
3877  * The function vim_findfile_init() has a long comment, which describes the
3878  * needed parameters.
3879  *
3880  *
3881  *
3882  * ATTENTION:
3883  * ==========
3884  *	Also we use an allocated search context here, this functions are NOT
3885  *	thread-safe!!!!!
3886  *
3887  *	To minimize parameter passing (or because I'm to lazy), only the
3888  *	external visible functions get a search context as a parameter. This is
3889  *	then assigned to a static global, which is used throughout the local
3890  *	functions.
3891  */
3892 
3893 /*
3894  * type for the directory search stack
3895  */
3896 typedef struct ff_stack
3897 {
3898     struct ff_stack	*ffs_prev;
3899 
3900     /* the fix part (no wildcards) and the part containing the wildcards
3901      * of the search path
3902      */
3903     char_u		*ffs_fix_path;
3904 #ifdef FEAT_PATH_EXTRA
3905     char_u		*ffs_wc_path;
3906 #endif
3907 
3908     /* files/dirs found in the above directory, matched by the first wildcard
3909      * of wc_part
3910      */
3911     char_u		**ffs_filearray;
3912     int			ffs_filearray_size;
3913     char_u		ffs_filearray_cur;   /* needed for partly handled dirs */
3914 
3915     /* to store status of partly handled directories
3916      * 0: we work on this directory for the first time
3917      * 1: this directory was partly searched in an earlier step
3918      */
3919     int			ffs_stage;
3920 
3921     /* How deep are we in the directory tree?
3922      * Counts backward from value of level parameter to vim_findfile_init
3923      */
3924     int			ffs_level;
3925 
3926     /* Did we already expand '**' to an empty string? */
3927     int			ffs_star_star_empty;
3928 } ff_stack_T;
3929 
3930 /*
3931  * type for already visited directories or files.
3932  */
3933 typedef struct ff_visited
3934 {
3935     struct ff_visited	*ffv_next;
3936 
3937 #ifdef FEAT_PATH_EXTRA
3938     /* Visited directories are different if the wildcard string are
3939      * different. So we have to save it.
3940      */
3941     char_u		*ffv_wc_path;
3942 #endif
3943     /* for unix use inode etc for comparison (needed because of links), else
3944      * use filename.
3945      */
3946 #ifdef UNIX
3947     int			ffv_dev_valid;	/* ffv_dev and ffv_ino were set */
3948     dev_t		ffv_dev;	/* device number */
3949     ino_t		ffv_ino;	/* inode number */
3950 #endif
3951     /* The memory for this struct is allocated according to the length of
3952      * ffv_fname.
3953      */
3954     char_u		ffv_fname[1];	/* actually longer */
3955 } ff_visited_T;
3956 
3957 /*
3958  * We might have to manage several visited lists during a search.
3959  * This is especially needed for the tags option. If tags is set to:
3960  *      "./++/tags,./++/TAGS,++/tags"  (replace + with *)
3961  * So we have to do 3 searches:
3962  *   1) search from the current files directory downward for the file "tags"
3963  *   2) search from the current files directory downward for the file "TAGS"
3964  *   3) search from Vims current directory downwards for the file "tags"
3965  * As you can see, the first and the third search are for the same file, so for
3966  * the third search we can use the visited list of the first search. For the
3967  * second search we must start from a empty visited list.
3968  * The struct ff_visited_list_hdr is used to manage a linked list of already
3969  * visited lists.
3970  */
3971 typedef struct ff_visited_list_hdr
3972 {
3973     struct ff_visited_list_hdr	*ffvl_next;
3974 
3975     /* the filename the attached visited list is for */
3976     char_u			*ffvl_filename;
3977 
3978     ff_visited_T		*ffvl_visited_list;
3979 
3980 } ff_visited_list_hdr_T;
3981 
3982 
3983 /*
3984  * '**' can be expanded to several directory levels.
3985  * Set the default maximum depth.
3986  */
3987 #define FF_MAX_STAR_STAR_EXPAND ((char_u)30)
3988 
3989 /*
3990  * The search context:
3991  *   ffsc_stack_ptr:	the stack for the dirs to search
3992  *   ffsc_visited_list: the currently active visited list
3993  *   ffsc_dir_visited_list: the currently active visited list for search dirs
3994  *   ffsc_visited_lists_list: the list of all visited lists
3995  *   ffsc_dir_visited_lists_list: the list of all visited lists for search dirs
3996  *   ffsc_file_to_search:     the file to search for
3997  *   ffsc_start_dir:	the starting directory, if search path was relative
3998  *   ffsc_fix_path:	the fix part of the given path (without wildcards)
3999  *			Needed for upward search.
4000  *   ffsc_wc_path:	the part of the given path containing wildcards
4001  *   ffsc_level:	how many levels of dirs to search downwards
4002  *   ffsc_stopdirs_v:	array of stop directories for upward search
4003  *   ffsc_find_what:	FINDFILE_BOTH, FINDFILE_DIR or FINDFILE_FILE
4004  *   ffsc_tagfile:	searching for tags file, don't use 'suffixesadd'
4005  */
4006 typedef struct ff_search_ctx_T
4007 {
4008      ff_stack_T			*ffsc_stack_ptr;
4009      ff_visited_list_hdr_T	*ffsc_visited_list;
4010      ff_visited_list_hdr_T	*ffsc_dir_visited_list;
4011      ff_visited_list_hdr_T	*ffsc_visited_lists_list;
4012      ff_visited_list_hdr_T	*ffsc_dir_visited_lists_list;
4013      char_u			*ffsc_file_to_search;
4014      char_u			*ffsc_start_dir;
4015      char_u			*ffsc_fix_path;
4016 #ifdef FEAT_PATH_EXTRA
4017      char_u			*ffsc_wc_path;
4018      int			ffsc_level;
4019      char_u			**ffsc_stopdirs_v;
4020 #endif
4021      int			ffsc_find_what;
4022      int			ffsc_tagfile;
4023 } ff_search_ctx_T;
4024 
4025 /* locally needed functions */
4026 #ifdef FEAT_PATH_EXTRA
4027 static int ff_check_visited(ff_visited_T **, char_u *, char_u *);
4028 #else
4029 static int ff_check_visited(ff_visited_T **, char_u *);
4030 #endif
4031 static void vim_findfile_free_visited_list(ff_visited_list_hdr_T **list_headp);
4032 static void ff_free_visited_list(ff_visited_T *vl);
4033 static ff_visited_list_hdr_T* ff_get_visited_list(char_u *, ff_visited_list_hdr_T **list_headp);
4034 
4035 static void ff_push(ff_search_ctx_T *search_ctx, ff_stack_T *stack_ptr);
4036 static ff_stack_T *ff_pop(ff_search_ctx_T *search_ctx);
4037 static void ff_clear(ff_search_ctx_T *search_ctx);
4038 static void ff_free_stack_element(ff_stack_T *stack_ptr);
4039 #ifdef FEAT_PATH_EXTRA
4040 static ff_stack_T *ff_create_stack_element(char_u *, char_u *, int, int);
4041 #else
4042 static ff_stack_T *ff_create_stack_element(char_u *, int, int);
4043 #endif
4044 #ifdef FEAT_PATH_EXTRA
4045 static int ff_path_in_stoplist(char_u *, int, char_u **);
4046 #endif
4047 
4048 static char_u e_pathtoolong[] = N_("E854: path too long for completion");
4049 
4050 #if 0
4051 /*
4052  * if someone likes findfirst/findnext, here are the functions
4053  * NOT TESTED!!
4054  */
4055 
4056 static void *ff_fn_search_context = NULL;
4057 
4058     char_u *
4059 vim_findfirst(char_u *path, char_u *filename, int level)
4060 {
4061     ff_fn_search_context =
4062 	vim_findfile_init(path, filename, NULL, level, TRUE, FALSE,
4063 		ff_fn_search_context, rel_fname);
4064     if (NULL == ff_fn_search_context)
4065 	return NULL;
4066     else
4067 	return vim_findnext()
4068 }
4069 
4070     char_u *
4071 vim_findnext(void)
4072 {
4073     char_u *ret = vim_findfile(ff_fn_search_context);
4074 
4075     if (NULL == ret)
4076     {
4077 	vim_findfile_cleanup(ff_fn_search_context);
4078 	ff_fn_search_context = NULL;
4079     }
4080     return ret;
4081 }
4082 #endif
4083 
4084 /*
4085  * Initialization routine for vim_findfile().
4086  *
4087  * Returns the newly allocated search context or NULL if an error occurred.
4088  *
4089  * Don't forget to clean up by calling vim_findfile_cleanup() if you are done
4090  * with the search context.
4091  *
4092  * Find the file 'filename' in the directory 'path'.
4093  * The parameter 'path' may contain wildcards. If so only search 'level'
4094  * directories deep. The parameter 'level' is the absolute maximum and is
4095  * not related to restricts given to the '**' wildcard. If 'level' is 100
4096  * and you use '**200' vim_findfile() will stop after 100 levels.
4097  *
4098  * 'filename' cannot contain wildcards!  It is used as-is, no backslashes to
4099  * escape special characters.
4100  *
4101  * If 'stopdirs' is not NULL and nothing is found downward, the search is
4102  * restarted on the next higher directory level. This is repeated until the
4103  * start-directory of a search is contained in 'stopdirs'. 'stopdirs' has the
4104  * format ";*<dirname>*\(;<dirname>\)*;\=$".
4105  *
4106  * If the 'path' is relative, the starting dir for the search is either VIM's
4107  * current dir or if the path starts with "./" the current files dir.
4108  * If the 'path' is absolute, the starting dir is that part of the path before
4109  * the first wildcard.
4110  *
4111  * Upward search is only done on the starting dir.
4112  *
4113  * If 'free_visited' is TRUE the list of already visited files/directories is
4114  * cleared. Set this to FALSE if you just want to search from another
4115  * directory, but want to be sure that no directory from a previous search is
4116  * searched again. This is useful if you search for a file at different places.
4117  * The list of visited files/dirs can also be cleared with the function
4118  * vim_findfile_free_visited().
4119  *
4120  * Set the parameter 'find_what' to FINDFILE_DIR if you want to search for
4121  * directories only, FINDFILE_FILE for files only, FINDFILE_BOTH for both.
4122  *
4123  * A search context returned by a previous call to vim_findfile_init() can be
4124  * passed in the parameter "search_ctx_arg".  This context is reused and
4125  * reinitialized with the new parameters.  The list of already visited
4126  * directories from this context is only deleted if the parameter
4127  * "free_visited" is true.  Be aware that the passed "search_ctx_arg" is freed
4128  * if the reinitialization fails.
4129  *
4130  * If you don't have a search context from a previous call "search_ctx_arg"
4131  * must be NULL.
4132  *
4133  * This function silently ignores a few errors, vim_findfile() will have
4134  * limited functionality then.
4135  */
4136     void *
4137 vim_findfile_init(
4138     char_u	*path,
4139     char_u	*filename,
4140     char_u	*stopdirs UNUSED,
4141     int		level,
4142     int		free_visited,
4143     int		find_what,
4144     void	*search_ctx_arg,
4145     int		tagfile,	/* expanding names of tags files */
4146     char_u	*rel_fname)	/* file name to use for "." */
4147 {
4148 #ifdef FEAT_PATH_EXTRA
4149     char_u		*wc_part;
4150 #endif
4151     ff_stack_T		*sptr;
4152     ff_search_ctx_T	*search_ctx;
4153 
4154     /* If a search context is given by the caller, reuse it, else allocate a
4155      * new one.
4156      */
4157     if (search_ctx_arg != NULL)
4158 	search_ctx = search_ctx_arg;
4159     else
4160     {
4161 	search_ctx = (ff_search_ctx_T*)alloc((unsigned)sizeof(ff_search_ctx_T));
4162 	if (search_ctx == NULL)
4163 	    goto error_return;
4164 	vim_memset(search_ctx, 0, sizeof(ff_search_ctx_T));
4165     }
4166     search_ctx->ffsc_find_what = find_what;
4167     search_ctx->ffsc_tagfile = tagfile;
4168 
4169     /* clear the search context, but NOT the visited lists */
4170     ff_clear(search_ctx);
4171 
4172     /* clear visited list if wanted */
4173     if (free_visited == TRUE)
4174 	vim_findfile_free_visited(search_ctx);
4175     else
4176     {
4177 	/* Reuse old visited lists. Get the visited list for the given
4178 	 * filename. If no list for the current filename exists, creates a new
4179 	 * one. */
4180 	search_ctx->ffsc_visited_list = ff_get_visited_list(filename,
4181 					&search_ctx->ffsc_visited_lists_list);
4182 	if (search_ctx->ffsc_visited_list == NULL)
4183 	    goto error_return;
4184 	search_ctx->ffsc_dir_visited_list = ff_get_visited_list(filename,
4185 				    &search_ctx->ffsc_dir_visited_lists_list);
4186 	if (search_ctx->ffsc_dir_visited_list == NULL)
4187 	    goto error_return;
4188     }
4189 
4190     if (ff_expand_buffer == NULL)
4191     {
4192 	ff_expand_buffer = (char_u*)alloc(MAXPATHL);
4193 	if (ff_expand_buffer == NULL)
4194 	    goto error_return;
4195     }
4196 
4197     /* Store information on starting dir now if path is relative.
4198      * If path is absolute, we do that later.  */
4199     if (path[0] == '.'
4200 	    && (vim_ispathsep(path[1]) || path[1] == NUL)
4201 	    && (!tagfile || vim_strchr(p_cpo, CPO_DOTTAG) == NULL)
4202 	    && rel_fname != NULL)
4203     {
4204 	int	len = (int)(gettail(rel_fname) - rel_fname);
4205 
4206 	if (!vim_isAbsName(rel_fname) && len + 1 < MAXPATHL)
4207 	{
4208 	    /* Make the start dir an absolute path name. */
4209 	    vim_strncpy(ff_expand_buffer, rel_fname, len);
4210 	    search_ctx->ffsc_start_dir = FullName_save(ff_expand_buffer, FALSE);
4211 	}
4212 	else
4213 	    search_ctx->ffsc_start_dir = vim_strnsave(rel_fname, len);
4214 	if (search_ctx->ffsc_start_dir == NULL)
4215 	    goto error_return;
4216 	if (*++path != NUL)
4217 	    ++path;
4218     }
4219     else if (*path == NUL || !vim_isAbsName(path))
4220     {
4221 #ifdef BACKSLASH_IN_FILENAME
4222 	/* "c:dir" needs "c:" to be expanded, otherwise use current dir */
4223 	if (*path != NUL && path[1] == ':')
4224 	{
4225 	    char_u  drive[3];
4226 
4227 	    drive[0] = path[0];
4228 	    drive[1] = ':';
4229 	    drive[2] = NUL;
4230 	    if (vim_FullName(drive, ff_expand_buffer, MAXPATHL, TRUE) == FAIL)
4231 		goto error_return;
4232 	    path += 2;
4233 	}
4234 	else
4235 #endif
4236 	if (mch_dirname(ff_expand_buffer, MAXPATHL) == FAIL)
4237 	    goto error_return;
4238 
4239 	search_ctx->ffsc_start_dir = vim_strsave(ff_expand_buffer);
4240 	if (search_ctx->ffsc_start_dir == NULL)
4241 	    goto error_return;
4242 
4243 #ifdef BACKSLASH_IN_FILENAME
4244 	/* A path that starts with "/dir" is relative to the drive, not to the
4245 	 * directory (but not for "//machine/dir").  Only use the drive name. */
4246 	if ((*path == '/' || *path == '\\')
4247 		&& path[1] != path[0]
4248 		&& search_ctx->ffsc_start_dir[1] == ':')
4249 	    search_ctx->ffsc_start_dir[2] = NUL;
4250 #endif
4251     }
4252 
4253 #ifdef FEAT_PATH_EXTRA
4254     /*
4255      * If stopdirs are given, split them into an array of pointers.
4256      * If this fails (mem allocation), there is no upward search at all or a
4257      * stop directory is not recognized -> continue silently.
4258      * If stopdirs just contains a ";" or is empty,
4259      * search_ctx->ffsc_stopdirs_v will only contain a  NULL pointer. This
4260      * is handled as unlimited upward search.  See function
4261      * ff_path_in_stoplist() for details.
4262      */
4263     if (stopdirs != NULL)
4264     {
4265 	char_u	*walker = stopdirs;
4266 	int	dircount;
4267 
4268 	while (*walker == ';')
4269 	    walker++;
4270 
4271 	dircount = 1;
4272 	search_ctx->ffsc_stopdirs_v =
4273 				 (char_u **)alloc((unsigned)sizeof(char_u *));
4274 
4275 	if (search_ctx->ffsc_stopdirs_v != NULL)
4276 	{
4277 	    do
4278 	    {
4279 		char_u	*helper;
4280 		void	*ptr;
4281 
4282 		helper = walker;
4283 		ptr = vim_realloc(search_ctx->ffsc_stopdirs_v,
4284 					   (dircount + 1) * sizeof(char_u *));
4285 		if (ptr)
4286 		    search_ctx->ffsc_stopdirs_v = ptr;
4287 		else
4288 		    /* ignore, keep what we have and continue */
4289 		    break;
4290 		walker = vim_strchr(walker, ';');
4291 		if (walker)
4292 		{
4293 		    search_ctx->ffsc_stopdirs_v[dircount-1] =
4294 				 vim_strnsave(helper, (int)(walker - helper));
4295 		    walker++;
4296 		}
4297 		else
4298 		    /* this might be "", which means ascent till top
4299 		     * of directory tree.
4300 		     */
4301 		    search_ctx->ffsc_stopdirs_v[dircount-1] =
4302 							  vim_strsave(helper);
4303 
4304 		dircount++;
4305 
4306 	    } while (walker != NULL);
4307 	    search_ctx->ffsc_stopdirs_v[dircount-1] = NULL;
4308 	}
4309     }
4310 #endif
4311 
4312 #ifdef FEAT_PATH_EXTRA
4313     search_ctx->ffsc_level = level;
4314 
4315     /* split into:
4316      *  -fix path
4317      *  -wildcard_stuff (might be NULL)
4318      */
4319     wc_part = vim_strchr(path, '*');
4320     if (wc_part != NULL)
4321     {
4322 	int	llevel;
4323 	int	len;
4324 	char	*errpt;
4325 
4326 	/* save the fix part of the path */
4327 	search_ctx->ffsc_fix_path = vim_strnsave(path, (int)(wc_part - path));
4328 
4329 	/*
4330 	 * copy wc_path and add restricts to the '**' wildcard.
4331 	 * The octet after a '**' is used as a (binary) counter.
4332 	 * So '**3' is transposed to '**^C' ('^C' is ASCII value 3)
4333 	 * or '**76' is transposed to '**N'( 'N' is ASCII value 76).
4334 	 * For EBCDIC you get different character values.
4335 	 * If no restrict is given after '**' the default is used.
4336 	 * Due to this technique the path looks awful if you print it as a
4337 	 * string.
4338 	 */
4339 	len = 0;
4340 	while (*wc_part != NUL)
4341 	{
4342 	    if (len + 5 >= MAXPATHL)
4343 	    {
4344 		EMSG(_(e_pathtoolong));
4345 		break;
4346 	    }
4347 	    if (STRNCMP(wc_part, "**", 2) == 0)
4348 	    {
4349 		ff_expand_buffer[len++] = *wc_part++;
4350 		ff_expand_buffer[len++] = *wc_part++;
4351 
4352 		llevel = strtol((char *)wc_part, &errpt, 10);
4353 		if ((char_u *)errpt != wc_part && llevel > 0 && llevel < 255)
4354 		    ff_expand_buffer[len++] = llevel;
4355 		else if ((char_u *)errpt != wc_part && llevel == 0)
4356 		    /* restrict is 0 -> remove already added '**' */
4357 		    len -= 2;
4358 		else
4359 		    ff_expand_buffer[len++] = FF_MAX_STAR_STAR_EXPAND;
4360 		wc_part = (char_u *)errpt;
4361 		if (*wc_part != NUL && !vim_ispathsep(*wc_part))
4362 		{
4363 		    EMSG2(_("E343: Invalid path: '**[number]' must be at the end of the path or be followed by '%s'."), PATHSEPSTR);
4364 		    goto error_return;
4365 		}
4366 	    }
4367 	    else
4368 		ff_expand_buffer[len++] = *wc_part++;
4369 	}
4370 	ff_expand_buffer[len] = NUL;
4371 	search_ctx->ffsc_wc_path = vim_strsave(ff_expand_buffer);
4372 
4373 	if (search_ctx->ffsc_wc_path == NULL)
4374 	    goto error_return;
4375     }
4376     else
4377 #endif
4378 	search_ctx->ffsc_fix_path = vim_strsave(path);
4379 
4380     if (search_ctx->ffsc_start_dir == NULL)
4381     {
4382 	/* store the fix part as startdir.
4383 	 * This is needed if the parameter path is fully qualified.
4384 	 */
4385 	search_ctx->ffsc_start_dir = vim_strsave(search_ctx->ffsc_fix_path);
4386 	if (search_ctx->ffsc_start_dir == NULL)
4387 	    goto error_return;
4388 	search_ctx->ffsc_fix_path[0] = NUL;
4389     }
4390 
4391     /* create an absolute path */
4392     if (STRLEN(search_ctx->ffsc_start_dir)
4393 			  + STRLEN(search_ctx->ffsc_fix_path) + 3 >= MAXPATHL)
4394     {
4395 	EMSG(_(e_pathtoolong));
4396 	goto error_return;
4397     }
4398     STRCPY(ff_expand_buffer, search_ctx->ffsc_start_dir);
4399     add_pathsep(ff_expand_buffer);
4400     {
4401 	int    eb_len = (int)STRLEN(ff_expand_buffer);
4402 	char_u *buf = alloc(eb_len
4403 				+ (int)STRLEN(search_ctx->ffsc_fix_path) + 1);
4404 
4405 	STRCPY(buf, ff_expand_buffer);
4406 	STRCPY(buf + eb_len, search_ctx->ffsc_fix_path);
4407 	if (mch_isdir(buf))
4408 	{
4409 	    STRCAT(ff_expand_buffer, search_ctx->ffsc_fix_path);
4410 	    add_pathsep(ff_expand_buffer);
4411 	}
4412 #ifdef FEAT_PATH_EXTRA
4413 	else
4414 	{
4415 	    char_u *p =  gettail(search_ctx->ffsc_fix_path);
4416 	    char_u *wc_path = NULL;
4417 	    char_u *temp = NULL;
4418 	    int    len = 0;
4419 
4420 	    if (p > search_ctx->ffsc_fix_path)
4421 	    {
4422 		len = (int)(p - search_ctx->ffsc_fix_path) - 1;
4423 		STRNCAT(ff_expand_buffer, search_ctx->ffsc_fix_path, len);
4424 		add_pathsep(ff_expand_buffer);
4425 	    }
4426 	    else
4427 		len = (int)STRLEN(search_ctx->ffsc_fix_path);
4428 
4429 	    if (search_ctx->ffsc_wc_path != NULL)
4430 	    {
4431 		wc_path = vim_strsave(search_ctx->ffsc_wc_path);
4432 		temp = alloc((int)(STRLEN(search_ctx->ffsc_wc_path)
4433 				 + STRLEN(search_ctx->ffsc_fix_path + len)
4434 				 + 1));
4435 		if (temp == NULL || wc_path == NULL)
4436 		{
4437 		    vim_free(buf);
4438 		    vim_free(temp);
4439 		    vim_free(wc_path);
4440 		    goto error_return;
4441 		}
4442 
4443 		STRCPY(temp, search_ctx->ffsc_fix_path + len);
4444 		STRCAT(temp, search_ctx->ffsc_wc_path);
4445 		vim_free(search_ctx->ffsc_wc_path);
4446 		vim_free(wc_path);
4447 		search_ctx->ffsc_wc_path = temp;
4448 	    }
4449 	}
4450 #endif
4451 	vim_free(buf);
4452     }
4453 
4454     sptr = ff_create_stack_element(ff_expand_buffer,
4455 #ifdef FEAT_PATH_EXTRA
4456 	    search_ctx->ffsc_wc_path,
4457 #endif
4458 	    level, 0);
4459 
4460     if (sptr == NULL)
4461 	goto error_return;
4462 
4463     ff_push(search_ctx, sptr);
4464 
4465     search_ctx->ffsc_file_to_search = vim_strsave(filename);
4466     if (search_ctx->ffsc_file_to_search == NULL)
4467 	goto error_return;
4468 
4469     return search_ctx;
4470 
4471 error_return:
4472     /*
4473      * We clear the search context now!
4474      * Even when the caller gave us a (perhaps valid) context we free it here,
4475      * as we might have already destroyed it.
4476      */
4477     vim_findfile_cleanup(search_ctx);
4478     return NULL;
4479 }
4480 
4481 #if defined(FEAT_PATH_EXTRA) || defined(PROTO)
4482 /*
4483  * Get the stopdir string.  Check that ';' is not escaped.
4484  */
4485     char_u *
4486 vim_findfile_stopdir(char_u *buf)
4487 {
4488     char_u	*r_ptr = buf;
4489 
4490     while (*r_ptr != NUL && *r_ptr != ';')
4491     {
4492 	if (r_ptr[0] == '\\' && r_ptr[1] == ';')
4493 	{
4494 	    /* Overwrite the escape char,
4495 	     * use STRLEN(r_ptr) to move the trailing '\0'. */
4496 	    STRMOVE(r_ptr, r_ptr + 1);
4497 	    r_ptr++;
4498 	}
4499 	r_ptr++;
4500     }
4501     if (*r_ptr == ';')
4502     {
4503 	*r_ptr = 0;
4504 	r_ptr++;
4505     }
4506     else if (*r_ptr == NUL)
4507 	r_ptr = NULL;
4508     return r_ptr;
4509 }
4510 #endif
4511 
4512 /*
4513  * Clean up the given search context. Can handle a NULL pointer.
4514  */
4515     void
4516 vim_findfile_cleanup(void *ctx)
4517 {
4518     if (ctx == NULL)
4519 	return;
4520 
4521     vim_findfile_free_visited(ctx);
4522     ff_clear(ctx);
4523     vim_free(ctx);
4524 }
4525 
4526 /*
4527  * Find a file in a search context.
4528  * The search context was created with vim_findfile_init() above.
4529  * Return a pointer to an allocated file name or NULL if nothing found.
4530  * To get all matching files call this function until you get NULL.
4531  *
4532  * If the passed search_context is NULL, NULL is returned.
4533  *
4534  * The search algorithm is depth first. To change this replace the
4535  * stack with a list (don't forget to leave partly searched directories on the
4536  * top of the list).
4537  */
4538     char_u *
4539 vim_findfile(void *search_ctx_arg)
4540 {
4541     char_u	*file_path;
4542 #ifdef FEAT_PATH_EXTRA
4543     char_u	*rest_of_wildcards;
4544     char_u	*path_end = NULL;
4545 #endif
4546     ff_stack_T	*stackp;
4547 #if defined(FEAT_SEARCHPATH) || defined(FEAT_PATH_EXTRA)
4548     int		len;
4549 #endif
4550     int		i;
4551     char_u	*p;
4552 #ifdef FEAT_SEARCHPATH
4553     char_u	*suf;
4554 #endif
4555     ff_search_ctx_T *search_ctx;
4556 
4557     if (search_ctx_arg == NULL)
4558 	return NULL;
4559 
4560     search_ctx = (ff_search_ctx_T *)search_ctx_arg;
4561 
4562     /*
4563      * filepath is used as buffer for various actions and as the storage to
4564      * return a found filename.
4565      */
4566     if ((file_path = alloc((int)MAXPATHL)) == NULL)
4567 	return NULL;
4568 
4569 #ifdef FEAT_PATH_EXTRA
4570     /* store the end of the start dir -- needed for upward search */
4571     if (search_ctx->ffsc_start_dir != NULL)
4572 	path_end = &search_ctx->ffsc_start_dir[
4573 					  STRLEN(search_ctx->ffsc_start_dir)];
4574 #endif
4575 
4576 #ifdef FEAT_PATH_EXTRA
4577     /* upward search loop */
4578     for (;;)
4579     {
4580 #endif
4581 	/* downward search loop */
4582 	for (;;)
4583 	{
4584 	    /* check if user user wants to stop the search*/
4585 	    ui_breakcheck();
4586 	    if (got_int)
4587 		break;
4588 
4589 	    /* get directory to work on from stack */
4590 	    stackp = ff_pop(search_ctx);
4591 	    if (stackp == NULL)
4592 		break;
4593 
4594 	    /*
4595 	     * TODO: decide if we leave this test in
4596 	     *
4597 	     * GOOD: don't search a directory(-tree) twice.
4598 	     * BAD:  - check linked list for every new directory entered.
4599 	     *       - check for double files also done below
4600 	     *
4601 	     * Here we check if we already searched this directory.
4602 	     * We already searched a directory if:
4603 	     * 1) The directory is the same.
4604 	     * 2) We would use the same wildcard string.
4605 	     *
4606 	     * Good if you have links on same directory via several ways
4607 	     *  or you have selfreferences in directories (e.g. SuSE Linux 6.3:
4608 	     *  /etc/rc.d/init.d is linked to /etc/rc.d -> endless loop)
4609 	     *
4610 	     * This check is only needed for directories we work on for the
4611 	     * first time (hence stackp->ff_filearray == NULL)
4612 	     */
4613 	    if (stackp->ffs_filearray == NULL
4614 		    && ff_check_visited(&search_ctx->ffsc_dir_visited_list
4615 							  ->ffvl_visited_list,
4616 			stackp->ffs_fix_path
4617 #ifdef FEAT_PATH_EXTRA
4618 			, stackp->ffs_wc_path
4619 #endif
4620 			) == FAIL)
4621 	    {
4622 #ifdef FF_VERBOSE
4623 		if (p_verbose >= 5)
4624 		{
4625 		    verbose_enter_scroll();
4626 		    smsg((char_u *)"Already Searched: %s (%s)",
4627 				   stackp->ffs_fix_path, stackp->ffs_wc_path);
4628 		    /* don't overwrite this either */
4629 		    msg_puts((char_u *)"\n");
4630 		    verbose_leave_scroll();
4631 		}
4632 #endif
4633 		ff_free_stack_element(stackp);
4634 		continue;
4635 	    }
4636 #ifdef FF_VERBOSE
4637 	    else if (p_verbose >= 5)
4638 	    {
4639 		verbose_enter_scroll();
4640 		smsg((char_u *)"Searching: %s (%s)",
4641 				   stackp->ffs_fix_path, stackp->ffs_wc_path);
4642 		/* don't overwrite this either */
4643 		msg_puts((char_u *)"\n");
4644 		verbose_leave_scroll();
4645 	    }
4646 #endif
4647 
4648 	    /* check depth */
4649 	    if (stackp->ffs_level <= 0)
4650 	    {
4651 		ff_free_stack_element(stackp);
4652 		continue;
4653 	    }
4654 
4655 	    file_path[0] = NUL;
4656 
4657 	    /*
4658 	     * If no filearray till now expand wildcards
4659 	     * The function expand_wildcards() can handle an array of paths
4660 	     * and all possible expands are returned in one array. We use this
4661 	     * to handle the expansion of '**' into an empty string.
4662 	     */
4663 	    if (stackp->ffs_filearray == NULL)
4664 	    {
4665 		char_u *dirptrs[2];
4666 
4667 		/* we use filepath to build the path expand_wildcards() should
4668 		 * expand.
4669 		 */
4670 		dirptrs[0] = file_path;
4671 		dirptrs[1] = NULL;
4672 
4673 		/* if we have a start dir copy it in */
4674 		if (!vim_isAbsName(stackp->ffs_fix_path)
4675 						&& search_ctx->ffsc_start_dir)
4676 		{
4677 		    if (STRLEN(search_ctx->ffsc_start_dir) + 1 < MAXPATHL)
4678 		    {
4679 			STRCPY(file_path, search_ctx->ffsc_start_dir);
4680 			add_pathsep(file_path);
4681 		    }
4682 		    else
4683 			goto fail;
4684 		}
4685 
4686 		/* append the fix part of the search path */
4687 		if (STRLEN(file_path) + STRLEN(stackp->ffs_fix_path) + 1 < MAXPATHL)
4688 		{
4689 		    STRCAT(file_path, stackp->ffs_fix_path);
4690 		    add_pathsep(file_path);
4691 		}
4692 		else
4693 		    goto fail;
4694 
4695 #ifdef FEAT_PATH_EXTRA
4696 		rest_of_wildcards = stackp->ffs_wc_path;
4697 		if (*rest_of_wildcards != NUL)
4698 		{
4699 		    len = (int)STRLEN(file_path);
4700 		    if (STRNCMP(rest_of_wildcards, "**", 2) == 0)
4701 		    {
4702 			/* pointer to the restrict byte
4703 			 * The restrict byte is not a character!
4704 			 */
4705 			p = rest_of_wildcards + 2;
4706 
4707 			if (*p > 0)
4708 			{
4709 			    (*p)--;
4710 			    if (len + 1 < MAXPATHL)
4711 				file_path[len++] = '*';
4712 			    else
4713 				goto fail;
4714 			}
4715 
4716 			if (*p == 0)
4717 			{
4718 			    /* remove '**<numb> from wildcards */
4719 			    STRMOVE(rest_of_wildcards, rest_of_wildcards + 3);
4720 			}
4721 			else
4722 			    rest_of_wildcards += 3;
4723 
4724 			if (stackp->ffs_star_star_empty == 0)
4725 			{
4726 			    /* if not done before, expand '**' to empty */
4727 			    stackp->ffs_star_star_empty = 1;
4728 			    dirptrs[1] = stackp->ffs_fix_path;
4729 			}
4730 		    }
4731 
4732 		    /*
4733 		     * Here we copy until the next path separator or the end of
4734 		     * the path. If we stop at a path separator, there is
4735 		     * still something else left. This is handled below by
4736 		     * pushing every directory returned from expand_wildcards()
4737 		     * on the stack again for further search.
4738 		     */
4739 		    while (*rest_of_wildcards
4740 			    && !vim_ispathsep(*rest_of_wildcards))
4741 			if (len + 1 < MAXPATHL)
4742 			    file_path[len++] = *rest_of_wildcards++;
4743 			else
4744 			    goto fail;
4745 
4746 		    file_path[len] = NUL;
4747 		    if (vim_ispathsep(*rest_of_wildcards))
4748 			rest_of_wildcards++;
4749 		}
4750 #endif
4751 
4752 		/*
4753 		 * Expand wildcards like "*" and "$VAR".
4754 		 * If the path is a URL don't try this.
4755 		 */
4756 		if (path_with_url(dirptrs[0]))
4757 		{
4758 		    stackp->ffs_filearray = (char_u **)
4759 					      alloc((unsigned)sizeof(char *));
4760 		    if (stackp->ffs_filearray != NULL
4761 			    && (stackp->ffs_filearray[0]
4762 				= vim_strsave(dirptrs[0])) != NULL)
4763 			stackp->ffs_filearray_size = 1;
4764 		    else
4765 			stackp->ffs_filearray_size = 0;
4766 		}
4767 		else
4768 		    /* Add EW_NOTWILD because the expanded path may contain
4769 		     * wildcard characters that are to be taken literally.
4770 		     * This is a bit of a hack. */
4771 		    expand_wildcards((dirptrs[1] == NULL) ? 1 : 2, dirptrs,
4772 			    &stackp->ffs_filearray_size,
4773 			    &stackp->ffs_filearray,
4774 			    EW_DIR|EW_ADDSLASH|EW_SILENT|EW_NOTWILD);
4775 
4776 		stackp->ffs_filearray_cur = 0;
4777 		stackp->ffs_stage = 0;
4778 	    }
4779 #ifdef FEAT_PATH_EXTRA
4780 	    else
4781 		rest_of_wildcards = &stackp->ffs_wc_path[
4782 						 STRLEN(stackp->ffs_wc_path)];
4783 #endif
4784 
4785 	    if (stackp->ffs_stage == 0)
4786 	    {
4787 		/* this is the first time we work on this directory */
4788 #ifdef FEAT_PATH_EXTRA
4789 		if (*rest_of_wildcards == NUL)
4790 #endif
4791 		{
4792 		    /*
4793 		     * We don't have further wildcards to expand, so we have to
4794 		     * check for the final file now.
4795 		     */
4796 		    for (i = stackp->ffs_filearray_cur;
4797 					  i < stackp->ffs_filearray_size; ++i)
4798 		    {
4799 			if (!path_with_url(stackp->ffs_filearray[i])
4800 				      && !mch_isdir(stackp->ffs_filearray[i]))
4801 			    continue;   /* not a directory */
4802 
4803 			/* prepare the filename to be checked for existence
4804 			 * below */
4805 			if (STRLEN(stackp->ffs_filearray[i]) + 1
4806 				+ STRLEN(search_ctx->ffsc_file_to_search) < MAXPATHL)
4807 			{
4808 			    STRCPY(file_path, stackp->ffs_filearray[i]);
4809 			    add_pathsep(file_path);
4810 			    STRCAT(file_path, search_ctx->ffsc_file_to_search);
4811 			}
4812 			else
4813 			    goto fail;
4814 
4815 			/*
4816 			 * Try without extra suffix and then with suffixes
4817 			 * from 'suffixesadd'.
4818 			 */
4819 #ifdef FEAT_SEARCHPATH
4820 			len = (int)STRLEN(file_path);
4821 			if (search_ctx->ffsc_tagfile)
4822 			    suf = (char_u *)"";
4823 			else
4824 			    suf = curbuf->b_p_sua;
4825 			for (;;)
4826 #endif
4827 			{
4828 			    /* if file exists and we didn't already find it */
4829 			    if ((path_with_url(file_path)
4830 				  || (mch_getperm(file_path) >= 0
4831 				      && (search_ctx->ffsc_find_what
4832 							      == FINDFILE_BOTH
4833 					  || ((search_ctx->ffsc_find_what
4834 							      == FINDFILE_DIR)
4835 						   == mch_isdir(file_path)))))
4836 #ifndef FF_VERBOSE
4837 				    && (ff_check_visited(
4838 					    &search_ctx->ffsc_visited_list->ffvl_visited_list,
4839 					    file_path
4840 #ifdef FEAT_PATH_EXTRA
4841 					    , (char_u *)""
4842 #endif
4843 					    ) == OK)
4844 #endif
4845 			       )
4846 			    {
4847 #ifdef FF_VERBOSE
4848 				if (ff_check_visited(
4849 					    &search_ctx->ffsc_visited_list->ffvl_visited_list,
4850 					    file_path
4851 #ifdef FEAT_PATH_EXTRA
4852 					    , (char_u *)""
4853 #endif
4854 						    ) == FAIL)
4855 				{
4856 				    if (p_verbose >= 5)
4857 				    {
4858 					verbose_enter_scroll();
4859 					smsg((char_u *)"Already: %s",
4860 								   file_path);
4861 					/* don't overwrite this either */
4862 					msg_puts((char_u *)"\n");
4863 					verbose_leave_scroll();
4864 				    }
4865 				    continue;
4866 				}
4867 #endif
4868 
4869 				/* push dir to examine rest of subdirs later */
4870 				stackp->ffs_filearray_cur = i + 1;
4871 				ff_push(search_ctx, stackp);
4872 
4873 				if (!path_with_url(file_path))
4874 				    simplify_filename(file_path);
4875 				if (mch_dirname(ff_expand_buffer, MAXPATHL)
4876 									== OK)
4877 				{
4878 				    p = shorten_fname(file_path,
4879 							    ff_expand_buffer);
4880 				    if (p != NULL)
4881 					STRMOVE(file_path, p);
4882 				}
4883 #ifdef FF_VERBOSE
4884 				if (p_verbose >= 5)
4885 				{
4886 				    verbose_enter_scroll();
4887 				    smsg((char_u *)"HIT: %s", file_path);
4888 				    /* don't overwrite this either */
4889 				    msg_puts((char_u *)"\n");
4890 				    verbose_leave_scroll();
4891 				}
4892 #endif
4893 				return file_path;
4894 			    }
4895 
4896 #ifdef FEAT_SEARCHPATH
4897 			    /* Not found or found already, try next suffix. */
4898 			    if (*suf == NUL)
4899 				break;
4900 			    copy_option_part(&suf, file_path + len,
4901 							 MAXPATHL - len, ",");
4902 #endif
4903 			}
4904 		    }
4905 		}
4906 #ifdef FEAT_PATH_EXTRA
4907 		else
4908 		{
4909 		    /*
4910 		     * still wildcards left, push the directories for further
4911 		     * search
4912 		     */
4913 		    for (i = stackp->ffs_filearray_cur;
4914 					  i < stackp->ffs_filearray_size; ++i)
4915 		    {
4916 			if (!mch_isdir(stackp->ffs_filearray[i]))
4917 			    continue;	/* not a directory */
4918 
4919 			ff_push(search_ctx,
4920 				ff_create_stack_element(
4921 						     stackp->ffs_filearray[i],
4922 						     rest_of_wildcards,
4923 						     stackp->ffs_level - 1, 0));
4924 		    }
4925 		}
4926 #endif
4927 		stackp->ffs_filearray_cur = 0;
4928 		stackp->ffs_stage = 1;
4929 	    }
4930 
4931 #ifdef FEAT_PATH_EXTRA
4932 	    /*
4933 	     * if wildcards contains '**' we have to descent till we reach the
4934 	     * leaves of the directory tree.
4935 	     */
4936 	    if (STRNCMP(stackp->ffs_wc_path, "**", 2) == 0)
4937 	    {
4938 		for (i = stackp->ffs_filearray_cur;
4939 					  i < stackp->ffs_filearray_size; ++i)
4940 		{
4941 		    if (fnamecmp(stackp->ffs_filearray[i],
4942 						   stackp->ffs_fix_path) == 0)
4943 			continue; /* don't repush same directory */
4944 		    if (!mch_isdir(stackp->ffs_filearray[i]))
4945 			continue;   /* not a directory */
4946 		    ff_push(search_ctx,
4947 			    ff_create_stack_element(stackp->ffs_filearray[i],
4948 				stackp->ffs_wc_path, stackp->ffs_level - 1, 1));
4949 		}
4950 	    }
4951 #endif
4952 
4953 	    /* we are done with the current directory */
4954 	    ff_free_stack_element(stackp);
4955 
4956 	}
4957 
4958 #ifdef FEAT_PATH_EXTRA
4959 	/* If we reached this, we didn't find anything downwards.
4960 	 * Let's check if we should do an upward search.
4961 	 */
4962 	if (search_ctx->ffsc_start_dir
4963 		&& search_ctx->ffsc_stopdirs_v != NULL && !got_int)
4964 	{
4965 	    ff_stack_T  *sptr;
4966 
4967 	    /* is the last starting directory in the stop list? */
4968 	    if (ff_path_in_stoplist(search_ctx->ffsc_start_dir,
4969 		       (int)(path_end - search_ctx->ffsc_start_dir),
4970 		       search_ctx->ffsc_stopdirs_v) == TRUE)
4971 		break;
4972 
4973 	    /* cut of last dir */
4974 	    while (path_end > search_ctx->ffsc_start_dir
4975 						  && vim_ispathsep(*path_end))
4976 		path_end--;
4977 	    while (path_end > search_ctx->ffsc_start_dir
4978 					      && !vim_ispathsep(path_end[-1]))
4979 		path_end--;
4980 	    *path_end = 0;
4981 	    path_end--;
4982 
4983 	    if (*search_ctx->ffsc_start_dir == 0)
4984 		break;
4985 
4986 	    if (STRLEN(search_ctx->ffsc_start_dir) + 1
4987 		    + STRLEN(search_ctx->ffsc_fix_path) < MAXPATHL)
4988 	    {
4989 		STRCPY(file_path, search_ctx->ffsc_start_dir);
4990 		add_pathsep(file_path);
4991 		STRCAT(file_path, search_ctx->ffsc_fix_path);
4992 	    }
4993 	    else
4994 		goto fail;
4995 
4996 	    /* create a new stack entry */
4997 	    sptr = ff_create_stack_element(file_path,
4998 		    search_ctx->ffsc_wc_path, search_ctx->ffsc_level, 0);
4999 	    if (sptr == NULL)
5000 		break;
5001 	    ff_push(search_ctx, sptr);
5002 	}
5003 	else
5004 	    break;
5005     }
5006 #endif
5007 
5008 fail:
5009     vim_free(file_path);
5010     return NULL;
5011 }
5012 
5013 /*
5014  * Free the list of lists of visited files and directories
5015  * Can handle it if the passed search_context is NULL;
5016  */
5017     void
5018 vim_findfile_free_visited(void *search_ctx_arg)
5019 {
5020     ff_search_ctx_T *search_ctx;
5021 
5022     if (search_ctx_arg == NULL)
5023 	return;
5024 
5025     search_ctx = (ff_search_ctx_T *)search_ctx_arg;
5026     vim_findfile_free_visited_list(&search_ctx->ffsc_visited_lists_list);
5027     vim_findfile_free_visited_list(&search_ctx->ffsc_dir_visited_lists_list);
5028 }
5029 
5030     static void
5031 vim_findfile_free_visited_list(ff_visited_list_hdr_T **list_headp)
5032 {
5033     ff_visited_list_hdr_T *vp;
5034 
5035     while (*list_headp != NULL)
5036     {
5037 	vp = (*list_headp)->ffvl_next;
5038 	ff_free_visited_list((*list_headp)->ffvl_visited_list);
5039 
5040 	vim_free((*list_headp)->ffvl_filename);
5041 	vim_free(*list_headp);
5042 	*list_headp = vp;
5043     }
5044     *list_headp = NULL;
5045 }
5046 
5047     static void
5048 ff_free_visited_list(ff_visited_T *vl)
5049 {
5050     ff_visited_T *vp;
5051 
5052     while (vl != NULL)
5053     {
5054 	vp = vl->ffv_next;
5055 #ifdef FEAT_PATH_EXTRA
5056 	vim_free(vl->ffv_wc_path);
5057 #endif
5058 	vim_free(vl);
5059 	vl = vp;
5060     }
5061     vl = NULL;
5062 }
5063 
5064 /*
5065  * Returns the already visited list for the given filename. If none is found it
5066  * allocates a new one.
5067  */
5068     static ff_visited_list_hdr_T*
5069 ff_get_visited_list(
5070     char_u			*filename,
5071     ff_visited_list_hdr_T	**list_headp)
5072 {
5073     ff_visited_list_hdr_T  *retptr = NULL;
5074 
5075     /* check if a visited list for the given filename exists */
5076     if (*list_headp != NULL)
5077     {
5078 	retptr = *list_headp;
5079 	while (retptr != NULL)
5080 	{
5081 	    if (fnamecmp(filename, retptr->ffvl_filename) == 0)
5082 	    {
5083 #ifdef FF_VERBOSE
5084 		if (p_verbose >= 5)
5085 		{
5086 		    verbose_enter_scroll();
5087 		    smsg((char_u *)"ff_get_visited_list: FOUND list for %s",
5088 								    filename);
5089 		    /* don't overwrite this either */
5090 		    msg_puts((char_u *)"\n");
5091 		    verbose_leave_scroll();
5092 		}
5093 #endif
5094 		return retptr;
5095 	    }
5096 	    retptr = retptr->ffvl_next;
5097 	}
5098     }
5099 
5100 #ifdef FF_VERBOSE
5101     if (p_verbose >= 5)
5102     {
5103 	verbose_enter_scroll();
5104 	smsg((char_u *)"ff_get_visited_list: new list for %s", filename);
5105 	/* don't overwrite this either */
5106 	msg_puts((char_u *)"\n");
5107 	verbose_leave_scroll();
5108     }
5109 #endif
5110 
5111     /*
5112      * if we reach this we didn't find a list and we have to allocate new list
5113      */
5114     retptr = (ff_visited_list_hdr_T*)alloc((unsigned)sizeof(*retptr));
5115     if (retptr == NULL)
5116 	return NULL;
5117 
5118     retptr->ffvl_visited_list = NULL;
5119     retptr->ffvl_filename = vim_strsave(filename);
5120     if (retptr->ffvl_filename == NULL)
5121     {
5122 	vim_free(retptr);
5123 	return NULL;
5124     }
5125     retptr->ffvl_next = *list_headp;
5126     *list_headp = retptr;
5127 
5128     return retptr;
5129 }
5130 
5131 #ifdef FEAT_PATH_EXTRA
5132 /*
5133  * check if two wildcard paths are equal. Returns TRUE or FALSE.
5134  * They are equal if:
5135  *  - both paths are NULL
5136  *  - they have the same length
5137  *  - char by char comparison is OK
5138  *  - the only differences are in the counters behind a '**', so
5139  *    '**\20' is equal to '**\24'
5140  */
5141     static int
5142 ff_wc_equal(char_u *s1, char_u *s2)
5143 {
5144     int		i, j;
5145     int		c1 = NUL;
5146     int		c2 = NUL;
5147     int		prev1 = NUL;
5148     int		prev2 = NUL;
5149 
5150     if (s1 == s2)
5151 	return TRUE;
5152 
5153     if (s1 == NULL || s2 == NULL)
5154 	return FALSE;
5155 
5156     for (i = 0, j = 0; s1[i] != NUL && s2[j] != NUL;)
5157     {
5158 	c1 = PTR2CHAR(s1 + i);
5159 	c2 = PTR2CHAR(s2 + j);
5160 
5161 	if ((p_fic ? MB_TOLOWER(c1) != MB_TOLOWER(c2) : c1 != c2)
5162 		&& (prev1 != '*' || prev2 != '*'))
5163 	    return FALSE;
5164 	prev2 = prev1;
5165 	prev1 = c1;
5166 
5167 	i += MB_PTR2LEN(s1 + i);
5168 	j += MB_PTR2LEN(s2 + j);
5169     }
5170     return s1[i] == s2[j];
5171 }
5172 #endif
5173 
5174 /*
5175  * maintains the list of already visited files and dirs
5176  * returns FAIL if the given file/dir is already in the list
5177  * returns OK if it is newly added
5178  *
5179  * TODO: What to do on memory allocation problems?
5180  *	 -> return TRUE - Better the file is found several times instead of
5181  *	    never.
5182  */
5183     static int
5184 ff_check_visited(
5185     ff_visited_T	**visited_list,
5186     char_u		*fname
5187 #ifdef FEAT_PATH_EXTRA
5188     , char_u		*wc_path
5189 #endif
5190     )
5191 {
5192     ff_visited_T	*vp;
5193 #ifdef UNIX
5194     stat_T		st;
5195     int			url = FALSE;
5196 #endif
5197 
5198     /* For an URL we only compare the name, otherwise we compare the
5199      * device/inode (unix) or the full path name (not Unix). */
5200     if (path_with_url(fname))
5201     {
5202 	vim_strncpy(ff_expand_buffer, fname, MAXPATHL - 1);
5203 #ifdef UNIX
5204 	url = TRUE;
5205 #endif
5206     }
5207     else
5208     {
5209 	ff_expand_buffer[0] = NUL;
5210 #ifdef UNIX
5211 	if (mch_stat((char *)fname, &st) < 0)
5212 #else
5213 	if (vim_FullName(fname, ff_expand_buffer, MAXPATHL, TRUE) == FAIL)
5214 #endif
5215 	    return FAIL;
5216     }
5217 
5218     /* check against list of already visited files */
5219     for (vp = *visited_list; vp != NULL; vp = vp->ffv_next)
5220     {
5221 	if (
5222 #ifdef UNIX
5223 		!url ? (vp->ffv_dev_valid && vp->ffv_dev == st.st_dev
5224 						  && vp->ffv_ino == st.st_ino)
5225 		     :
5226 #endif
5227 		fnamecmp(vp->ffv_fname, ff_expand_buffer) == 0
5228 	   )
5229 	{
5230 #ifdef FEAT_PATH_EXTRA
5231 	    /* are the wildcard parts equal */
5232 	    if (ff_wc_equal(vp->ffv_wc_path, wc_path) == TRUE)
5233 #endif
5234 		/* already visited */
5235 		return FAIL;
5236 	}
5237     }
5238 
5239     /*
5240      * New file/dir.  Add it to the list of visited files/dirs.
5241      */
5242     vp = (ff_visited_T *)alloc((unsigned)(sizeof(ff_visited_T)
5243 						 + STRLEN(ff_expand_buffer)));
5244 
5245     if (vp != NULL)
5246     {
5247 #ifdef UNIX
5248 	if (!url)
5249 	{
5250 	    vp->ffv_dev_valid = TRUE;
5251 	    vp->ffv_ino = st.st_ino;
5252 	    vp->ffv_dev = st.st_dev;
5253 	    vp->ffv_fname[0] = NUL;
5254 	}
5255 	else
5256 	{
5257 	    vp->ffv_dev_valid = FALSE;
5258 #endif
5259 	    STRCPY(vp->ffv_fname, ff_expand_buffer);
5260 #ifdef UNIX
5261 	}
5262 #endif
5263 #ifdef FEAT_PATH_EXTRA
5264 	if (wc_path != NULL)
5265 	    vp->ffv_wc_path = vim_strsave(wc_path);
5266 	else
5267 	    vp->ffv_wc_path = NULL;
5268 #endif
5269 
5270 	vp->ffv_next = *visited_list;
5271 	*visited_list = vp;
5272     }
5273 
5274     return OK;
5275 }
5276 
5277 /*
5278  * create stack element from given path pieces
5279  */
5280     static ff_stack_T *
5281 ff_create_stack_element(
5282     char_u	*fix_part,
5283 #ifdef FEAT_PATH_EXTRA
5284     char_u	*wc_part,
5285 #endif
5286     int		level,
5287     int		star_star_empty)
5288 {
5289     ff_stack_T	*new;
5290 
5291     new = (ff_stack_T *)alloc((unsigned)sizeof(ff_stack_T));
5292     if (new == NULL)
5293 	return NULL;
5294 
5295     new->ffs_prev	   = NULL;
5296     new->ffs_filearray	   = NULL;
5297     new->ffs_filearray_size = 0;
5298     new->ffs_filearray_cur  = 0;
5299     new->ffs_stage	   = 0;
5300     new->ffs_level	   = level;
5301     new->ffs_star_star_empty = star_star_empty;
5302 
5303     /* the following saves NULL pointer checks in vim_findfile */
5304     if (fix_part == NULL)
5305 	fix_part = (char_u *)"";
5306     new->ffs_fix_path = vim_strsave(fix_part);
5307 
5308 #ifdef FEAT_PATH_EXTRA
5309     if (wc_part == NULL)
5310 	wc_part  = (char_u *)"";
5311     new->ffs_wc_path = vim_strsave(wc_part);
5312 #endif
5313 
5314     if (new->ffs_fix_path == NULL
5315 #ifdef FEAT_PATH_EXTRA
5316 	    || new->ffs_wc_path == NULL
5317 #endif
5318 	    )
5319     {
5320 	ff_free_stack_element(new);
5321 	new = NULL;
5322     }
5323 
5324     return new;
5325 }
5326 
5327 /*
5328  * Push a dir on the directory stack.
5329  */
5330     static void
5331 ff_push(ff_search_ctx_T *search_ctx, ff_stack_T *stack_ptr)
5332 {
5333     /* check for NULL pointer, not to return an error to the user, but
5334      * to prevent a crash */
5335     if (stack_ptr != NULL)
5336     {
5337 	stack_ptr->ffs_prev = search_ctx->ffsc_stack_ptr;
5338 	search_ctx->ffsc_stack_ptr = stack_ptr;
5339     }
5340 }
5341 
5342 /*
5343  * Pop a dir from the directory stack.
5344  * Returns NULL if stack is empty.
5345  */
5346     static ff_stack_T *
5347 ff_pop(ff_search_ctx_T *search_ctx)
5348 {
5349     ff_stack_T  *sptr;
5350 
5351     sptr = search_ctx->ffsc_stack_ptr;
5352     if (search_ctx->ffsc_stack_ptr != NULL)
5353 	search_ctx->ffsc_stack_ptr = search_ctx->ffsc_stack_ptr->ffs_prev;
5354 
5355     return sptr;
5356 }
5357 
5358 /*
5359  * free the given stack element
5360  */
5361     static void
5362 ff_free_stack_element(ff_stack_T *stack_ptr)
5363 {
5364     /* vim_free handles possible NULL pointers */
5365     vim_free(stack_ptr->ffs_fix_path);
5366 #ifdef FEAT_PATH_EXTRA
5367     vim_free(stack_ptr->ffs_wc_path);
5368 #endif
5369 
5370     if (stack_ptr->ffs_filearray != NULL)
5371 	FreeWild(stack_ptr->ffs_filearray_size, stack_ptr->ffs_filearray);
5372 
5373     vim_free(stack_ptr);
5374 }
5375 
5376 /*
5377  * Clear the search context, but NOT the visited list.
5378  */
5379     static void
5380 ff_clear(ff_search_ctx_T *search_ctx)
5381 {
5382     ff_stack_T   *sptr;
5383 
5384     /* clear up stack */
5385     while ((sptr = ff_pop(search_ctx)) != NULL)
5386 	ff_free_stack_element(sptr);
5387 
5388     vim_free(search_ctx->ffsc_file_to_search);
5389     vim_free(search_ctx->ffsc_start_dir);
5390     vim_free(search_ctx->ffsc_fix_path);
5391 #ifdef FEAT_PATH_EXTRA
5392     vim_free(search_ctx->ffsc_wc_path);
5393 #endif
5394 
5395 #ifdef FEAT_PATH_EXTRA
5396     if (search_ctx->ffsc_stopdirs_v != NULL)
5397     {
5398 	int  i = 0;
5399 
5400 	while (search_ctx->ffsc_stopdirs_v[i] != NULL)
5401 	{
5402 	    vim_free(search_ctx->ffsc_stopdirs_v[i]);
5403 	    i++;
5404 	}
5405 	vim_free(search_ctx->ffsc_stopdirs_v);
5406     }
5407     search_ctx->ffsc_stopdirs_v = NULL;
5408 #endif
5409 
5410     /* reset everything */
5411     search_ctx->ffsc_file_to_search = NULL;
5412     search_ctx->ffsc_start_dir = NULL;
5413     search_ctx->ffsc_fix_path = NULL;
5414 #ifdef FEAT_PATH_EXTRA
5415     search_ctx->ffsc_wc_path = NULL;
5416     search_ctx->ffsc_level = 0;
5417 #endif
5418 }
5419 
5420 #ifdef FEAT_PATH_EXTRA
5421 /*
5422  * check if the given path is in the stopdirs
5423  * returns TRUE if yes else FALSE
5424  */
5425     static int
5426 ff_path_in_stoplist(char_u *path, int path_len, char_u **stopdirs_v)
5427 {
5428     int		i = 0;
5429 
5430     /* eat up trailing path separators, except the first */
5431     while (path_len > 1 && vim_ispathsep(path[path_len - 1]))
5432 	path_len--;
5433 
5434     /* if no path consider it as match */
5435     if (path_len == 0)
5436 	return TRUE;
5437 
5438     for (i = 0; stopdirs_v[i] != NULL; i++)
5439     {
5440 	if ((int)STRLEN(stopdirs_v[i]) > path_len)
5441 	{
5442 	    /* match for parent directory. So '/home' also matches
5443 	     * '/home/rks'. Check for PATHSEP in stopdirs_v[i], else
5444 	     * '/home/r' would also match '/home/rks'
5445 	     */
5446 	    if (fnamencmp(stopdirs_v[i], path, path_len) == 0
5447 		    && vim_ispathsep(stopdirs_v[i][path_len]))
5448 		return TRUE;
5449 	}
5450 	else
5451 	{
5452 	    if (fnamecmp(stopdirs_v[i], path) == 0)
5453 		return TRUE;
5454 	}
5455     }
5456     return FALSE;
5457 }
5458 #endif
5459 
5460 #if defined(FEAT_SEARCHPATH) || defined(PROTO)
5461 /*
5462  * Find the file name "ptr[len]" in the path.  Also finds directory names.
5463  *
5464  * On the first call set the parameter 'first' to TRUE to initialize
5465  * the search.  For repeating calls to FALSE.
5466  *
5467  * Repeating calls will return other files called 'ptr[len]' from the path.
5468  *
5469  * Only on the first call 'ptr' and 'len' are used.  For repeating calls they
5470  * don't need valid values.
5471  *
5472  * If nothing found on the first call the option FNAME_MESS will issue the
5473  * message:
5474  *	    'Can't find file "<file>" in path'
5475  * On repeating calls:
5476  *	    'No more file "<file>" found in path'
5477  *
5478  * options:
5479  * FNAME_MESS	    give error message when not found
5480  *
5481  * Uses NameBuff[]!
5482  *
5483  * Returns an allocated string for the file name.  NULL for error.
5484  *
5485  */
5486     char_u *
5487 find_file_in_path(
5488     char_u	*ptr,		/* file name */
5489     int		len,		/* length of file name */
5490     int		options,
5491     int		first,		/* use count'th matching file name */
5492     char_u	*rel_fname)	/* file name searching relative to */
5493 {
5494     return find_file_in_path_option(ptr, len, options, first,
5495 	    *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path,
5496 	    FINDFILE_BOTH, rel_fname, curbuf->b_p_sua);
5497 }
5498 
5499 static char_u	*ff_file_to_find = NULL;
5500 static void	*fdip_search_ctx = NULL;
5501 
5502 #if defined(EXITFREE)
5503     static void
5504 free_findfile(void)
5505 {
5506     vim_free(ff_file_to_find);
5507     vim_findfile_cleanup(fdip_search_ctx);
5508 }
5509 #endif
5510 
5511 /*
5512  * Find the directory name "ptr[len]" in the path.
5513  *
5514  * options:
5515  * FNAME_MESS	    give error message when not found
5516  * FNAME_UNESC	    unescape backslashes.
5517  *
5518  * Uses NameBuff[]!
5519  *
5520  * Returns an allocated string for the file name.  NULL for error.
5521  */
5522     char_u *
5523 find_directory_in_path(
5524     char_u	*ptr,		/* file name */
5525     int		len,		/* length of file name */
5526     int		options,
5527     char_u	*rel_fname)	/* file name searching relative to */
5528 {
5529     return find_file_in_path_option(ptr, len, options, TRUE, p_cdpath,
5530 				       FINDFILE_DIR, rel_fname, (char_u *)"");
5531 }
5532 
5533     char_u *
5534 find_file_in_path_option(
5535     char_u	*ptr,		/* file name */
5536     int		len,		/* length of file name */
5537     int		options,
5538     int		first,		/* use count'th matching file name */
5539     char_u	*path_option,	/* p_path or p_cdpath */
5540     int		find_what,	/* FINDFILE_FILE, _DIR or _BOTH */
5541     char_u	*rel_fname,	/* file name we are looking relative to. */
5542     char_u	*suffixes)	/* list of suffixes, 'suffixesadd' option */
5543 {
5544     static char_u	*dir;
5545     static int		did_findfile_init = FALSE;
5546     char_u		save_char;
5547     char_u		*file_name = NULL;
5548     char_u		*buf = NULL;
5549     int			rel_to_curdir;
5550 #ifdef AMIGA
5551     struct Process	*proc = (struct Process *)FindTask(0L);
5552     APTR		save_winptr = proc->pr_WindowPtr;
5553 
5554     /* Avoid a requester here for a volume that doesn't exist. */
5555     proc->pr_WindowPtr = (APTR)-1L;
5556 #endif
5557 
5558     if (first == TRUE)
5559     {
5560 	/* copy file name into NameBuff, expanding environment variables */
5561 	save_char = ptr[len];
5562 	ptr[len] = NUL;
5563 	expand_env_esc(ptr, NameBuff, MAXPATHL, FALSE, TRUE, NULL);
5564 	ptr[len] = save_char;
5565 
5566 	vim_free(ff_file_to_find);
5567 	ff_file_to_find = vim_strsave(NameBuff);
5568 	if (ff_file_to_find == NULL)	/* out of memory */
5569 	{
5570 	    file_name = NULL;
5571 	    goto theend;
5572 	}
5573 	if (options & FNAME_UNESC)
5574 	{
5575 	    /* Change all "\ " to " ". */
5576 	    for (ptr = ff_file_to_find; *ptr != NUL; ++ptr)
5577 		if (ptr[0] == '\\' && ptr[1] == ' ')
5578 		    mch_memmove(ptr, ptr + 1, STRLEN(ptr));
5579 	}
5580     }
5581 
5582     rel_to_curdir = (ff_file_to_find[0] == '.'
5583 		    && (ff_file_to_find[1] == NUL
5584 			|| vim_ispathsep(ff_file_to_find[1])
5585 			|| (ff_file_to_find[1] == '.'
5586 			    && (ff_file_to_find[2] == NUL
5587 				|| vim_ispathsep(ff_file_to_find[2])))));
5588     if (vim_isAbsName(ff_file_to_find)
5589 	    /* "..", "../path", "." and "./path": don't use the path_option */
5590 	    || rel_to_curdir
5591 #if defined(MSWIN)
5592 	    /* handle "\tmp" as absolute path */
5593 	    || vim_ispathsep(ff_file_to_find[0])
5594 	    /* handle "c:name" as absolute path */
5595 	    || (ff_file_to_find[0] != NUL && ff_file_to_find[1] == ':')
5596 #endif
5597 #ifdef AMIGA
5598 	    /* handle ":tmp" as absolute path */
5599 	    || ff_file_to_find[0] == ':'
5600 #endif
5601        )
5602     {
5603 	/*
5604 	 * Absolute path, no need to use "path_option".
5605 	 * If this is not a first call, return NULL.  We already returned a
5606 	 * filename on the first call.
5607 	 */
5608 	if (first == TRUE)
5609 	{
5610 	    int		l;
5611 	    int		run;
5612 
5613 	    if (path_with_url(ff_file_to_find))
5614 	    {
5615 		file_name = vim_strsave(ff_file_to_find);
5616 		goto theend;
5617 	    }
5618 
5619 	    /* When FNAME_REL flag given first use the directory of the file.
5620 	     * Otherwise or when this fails use the current directory. */
5621 	    for (run = 1; run <= 2; ++run)
5622 	    {
5623 		l = (int)STRLEN(ff_file_to_find);
5624 		if (run == 1
5625 			&& rel_to_curdir
5626 			&& (options & FNAME_REL)
5627 			&& rel_fname != NULL
5628 			&& STRLEN(rel_fname) + l < MAXPATHL)
5629 		{
5630 		    STRCPY(NameBuff, rel_fname);
5631 		    STRCPY(gettail(NameBuff), ff_file_to_find);
5632 		    l = (int)STRLEN(NameBuff);
5633 		}
5634 		else
5635 		{
5636 		    STRCPY(NameBuff, ff_file_to_find);
5637 		    run = 2;
5638 		}
5639 
5640 		/* When the file doesn't exist, try adding parts of
5641 		 * 'suffixesadd'. */
5642 		buf = suffixes;
5643 		for (;;)
5644 		{
5645 		    if (mch_getperm(NameBuff) >= 0
5646 			     && (find_what == FINDFILE_BOTH
5647 				 || ((find_what == FINDFILE_DIR)
5648 						    == mch_isdir(NameBuff))))
5649 		    {
5650 			file_name = vim_strsave(NameBuff);
5651 			goto theend;
5652 		    }
5653 		    if (*buf == NUL)
5654 			break;
5655 		    copy_option_part(&buf, NameBuff + l, MAXPATHL - l, ",");
5656 		}
5657 	    }
5658 	}
5659     }
5660     else
5661     {
5662 	/*
5663 	 * Loop over all paths in the 'path' or 'cdpath' option.
5664 	 * When "first" is set, first setup to the start of the option.
5665 	 * Otherwise continue to find the next match.
5666 	 */
5667 	if (first == TRUE)
5668 	{
5669 	    /* vim_findfile_free_visited can handle a possible NULL pointer */
5670 	    vim_findfile_free_visited(fdip_search_ctx);
5671 	    dir = path_option;
5672 	    did_findfile_init = FALSE;
5673 	}
5674 
5675 	for (;;)
5676 	{
5677 	    if (did_findfile_init)
5678 	    {
5679 		file_name = vim_findfile(fdip_search_ctx);
5680 		if (file_name != NULL)
5681 		    break;
5682 
5683 		did_findfile_init = FALSE;
5684 	    }
5685 	    else
5686 	    {
5687 		char_u  *r_ptr;
5688 
5689 		if (dir == NULL || *dir == NUL)
5690 		{
5691 		    /* We searched all paths of the option, now we can
5692 		     * free the search context. */
5693 		    vim_findfile_cleanup(fdip_search_ctx);
5694 		    fdip_search_ctx = NULL;
5695 		    break;
5696 		}
5697 
5698 		if ((buf = alloc((int)(MAXPATHL))) == NULL)
5699 		    break;
5700 
5701 		/* copy next path */
5702 		buf[0] = 0;
5703 		copy_option_part(&dir, buf, MAXPATHL, " ,");
5704 
5705 #ifdef FEAT_PATH_EXTRA
5706 		/* get the stopdir string */
5707 		r_ptr = vim_findfile_stopdir(buf);
5708 #else
5709 		r_ptr = NULL;
5710 #endif
5711 		fdip_search_ctx = vim_findfile_init(buf, ff_file_to_find,
5712 					    r_ptr, 100, FALSE, find_what,
5713 					   fdip_search_ctx, FALSE, rel_fname);
5714 		if (fdip_search_ctx != NULL)
5715 		    did_findfile_init = TRUE;
5716 		vim_free(buf);
5717 	    }
5718 	}
5719     }
5720     if (file_name == NULL && (options & FNAME_MESS))
5721     {
5722 	if (first == TRUE)
5723 	{
5724 	    if (find_what == FINDFILE_DIR)
5725 		EMSG2(_("E344: Can't find directory \"%s\" in cdpath"),
5726 			ff_file_to_find);
5727 	    else
5728 		EMSG2(_("E345: Can't find file \"%s\" in path"),
5729 			ff_file_to_find);
5730 	}
5731 	else
5732 	{
5733 	    if (find_what == FINDFILE_DIR)
5734 		EMSG2(_("E346: No more directory \"%s\" found in cdpath"),
5735 			ff_file_to_find);
5736 	    else
5737 		EMSG2(_("E347: No more file \"%s\" found in path"),
5738 			ff_file_to_find);
5739 	}
5740     }
5741 
5742 theend:
5743 #ifdef AMIGA
5744     proc->pr_WindowPtr = save_winptr;
5745 #endif
5746     return file_name;
5747 }
5748 
5749 #endif /* FEAT_SEARCHPATH */
5750 
5751 /*
5752  * Change directory to "new_dir".  If FEAT_SEARCHPATH is defined, search
5753  * 'cdpath' for relative directory names, otherwise just mch_chdir().
5754  */
5755     int
5756 vim_chdir(char_u *new_dir)
5757 {
5758 #ifndef FEAT_SEARCHPATH
5759     return mch_chdir((char *)new_dir);
5760 #else
5761     char_u	*dir_name;
5762     int		r;
5763 
5764     dir_name = find_directory_in_path(new_dir, (int)STRLEN(new_dir),
5765 						FNAME_MESS, curbuf->b_ffname);
5766     if (dir_name == NULL)
5767 	return -1;
5768     r = mch_chdir((char *)dir_name);
5769     vim_free(dir_name);
5770     return r;
5771 #endif
5772 }
5773 
5774 /*
5775  * Get user name from machine-specific function.
5776  * Returns the user name in "buf[len]".
5777  * Some systems are quite slow in obtaining the user name (Windows NT), thus
5778  * cache the result.
5779  * Returns OK or FAIL.
5780  */
5781     int
5782 get_user_name(char_u *buf, int len)
5783 {
5784     if (username == NULL)
5785     {
5786 	if (mch_get_user_name(buf, len) == FAIL)
5787 	    return FAIL;
5788 	username = vim_strsave(buf);
5789     }
5790     else
5791 	vim_strncpy(buf, username, len - 1);
5792     return OK;
5793 }
5794 
5795 #ifndef HAVE_QSORT
5796 /*
5797  * Our own qsort(), for systems that don't have it.
5798  * It's simple and slow.  From the K&R C book.
5799  */
5800     void
5801 qsort(
5802     void	*base,
5803     size_t	elm_count,
5804     size_t	elm_size,
5805     int (*cmp)(const void *, const void *))
5806 {
5807     char_u	*buf;
5808     char_u	*p1;
5809     char_u	*p2;
5810     int		i, j;
5811     int		gap;
5812 
5813     buf = alloc((unsigned)elm_size);
5814     if (buf == NULL)
5815 	return;
5816 
5817     for (gap = elm_count / 2; gap > 0; gap /= 2)
5818 	for (i = gap; i < elm_count; ++i)
5819 	    for (j = i - gap; j >= 0; j -= gap)
5820 	    {
5821 		/* Compare the elements. */
5822 		p1 = (char_u *)base + j * elm_size;
5823 		p2 = (char_u *)base + (j + gap) * elm_size;
5824 		if ((*cmp)((void *)p1, (void *)p2) <= 0)
5825 		    break;
5826 		/* Exchange the elements. */
5827 		mch_memmove(buf, p1, elm_size);
5828 		mch_memmove(p1, p2, elm_size);
5829 		mch_memmove(p2, buf, elm_size);
5830 	    }
5831 
5832     vim_free(buf);
5833 }
5834 #endif
5835 
5836 /*
5837  * Sort an array of strings.
5838  */
5839 static int
5840 #ifdef __BORLANDC__
5841 _RTLENTRYF
5842 #endif
5843 sort_compare(const void *s1, const void *s2);
5844 
5845     static int
5846 #ifdef __BORLANDC__
5847 _RTLENTRYF
5848 #endif
5849 sort_compare(const void *s1, const void *s2)
5850 {
5851     return STRCMP(*(char **)s1, *(char **)s2);
5852 }
5853 
5854     void
5855 sort_strings(
5856     char_u	**files,
5857     int		count)
5858 {
5859     qsort((void *)files, (size_t)count, sizeof(char_u *), sort_compare);
5860 }
5861 
5862 #if !defined(NO_EXPANDPATH) || defined(PROTO)
5863 /*
5864  * Compare path "p[]" to "q[]".
5865  * If "maxlen" >= 0 compare "p[maxlen]" to "q[maxlen]"
5866  * Return value like strcmp(p, q), but consider path separators.
5867  */
5868     int
5869 pathcmp(const char *p, const char *q, int maxlen)
5870 {
5871     int		i, j;
5872     int		c1, c2;
5873     const char	*s = NULL;
5874 
5875     for (i = 0, j = 0; maxlen < 0 || (i < maxlen && j < maxlen);)
5876     {
5877 	c1 = PTR2CHAR((char_u *)p + i);
5878 	c2 = PTR2CHAR((char_u *)q + j);
5879 
5880 	/* End of "p": check if "q" also ends or just has a slash. */
5881 	if (c1 == NUL)
5882 	{
5883 	    if (c2 == NUL)  /* full match */
5884 		return 0;
5885 	    s = q;
5886 	    i = j;
5887 	    break;
5888 	}
5889 
5890 	/* End of "q": check if "p" just has a slash. */
5891 	if (c2 == NUL)
5892 	{
5893 	    s = p;
5894 	    break;
5895 	}
5896 
5897 	if ((p_fic ? MB_TOUPPER(c1) != MB_TOUPPER(c2) : c1 != c2)
5898 #ifdef BACKSLASH_IN_FILENAME
5899 		/* consider '/' and '\\' to be equal */
5900 		&& !((c1 == '/' && c2 == '\\')
5901 		    || (c1 == '\\' && c2 == '/'))
5902 #endif
5903 		)
5904 	{
5905 	    if (vim_ispathsep(c1))
5906 		return -1;
5907 	    if (vim_ispathsep(c2))
5908 		return 1;
5909 	    return p_fic ? MB_TOUPPER(c1) - MB_TOUPPER(c2)
5910 		    : c1 - c2;  /* no match */
5911 	}
5912 
5913 	i += MB_PTR2LEN((char_u *)p + i);
5914 	j += MB_PTR2LEN((char_u *)q + j);
5915     }
5916     if (s == NULL)	/* "i" or "j" ran into "maxlen" */
5917 	return 0;
5918 
5919     c1 = PTR2CHAR((char_u *)s + i);
5920     c2 = PTR2CHAR((char_u *)s + i + MB_PTR2LEN((char_u *)s + i));
5921     /* ignore a trailing slash, but not "//" or ":/" */
5922     if (c2 == NUL
5923 	    && i > 0
5924 	    && !after_pathsep((char_u *)s, (char_u *)s + i)
5925 #ifdef BACKSLASH_IN_FILENAME
5926 	    && (c1 == '/' || c1 == '\\')
5927 #else
5928 	    && c1 == '/'
5929 #endif
5930        )
5931 	return 0;   /* match with trailing slash */
5932     if (s == q)
5933 	return -1;	    /* no match */
5934     return 1;
5935 }
5936 #endif
5937 
5938 /*
5939  * The putenv() implementation below comes from the "screen" program.
5940  * Included with permission from Juergen Weigert.
5941  * See pty.c for the copyright notice.
5942  */
5943 
5944 /*
5945  *  putenv  --	put value into environment
5946  *
5947  *  Usage:  i = putenv (string)
5948  *    int i;
5949  *    char  *string;
5950  *
5951  *  where string is of the form <name>=<value>.
5952  *  Putenv returns 0 normally, -1 on error (not enough core for malloc).
5953  *
5954  *  Putenv may need to add a new name into the environment, or to
5955  *  associate a value longer than the current value with a particular
5956  *  name.  So, to make life simpler, putenv() copies your entire
5957  *  environment into the heap (i.e. malloc()) from the stack
5958  *  (i.e. where it resides when your process is initiated) the first
5959  *  time you call it.
5960  *
5961  *  (history removed, not very interesting.  See the "screen" sources.)
5962  */
5963 
5964 #if !defined(HAVE_SETENV) && !defined(HAVE_PUTENV)
5965 
5966 #define EXTRASIZE 5		/* increment to add to env. size */
5967 
5968 static int  envsize = -1;	/* current size of environment */
5969 extern char **environ;		/* the global which is your env. */
5970 
5971 static int  findenv(char *name); /* look for a name in the env. */
5972 static int  newenv(void);	/* copy env. from stack to heap */
5973 static int  moreenv(void);	/* incr. size of env. */
5974 
5975     int
5976 putenv(const char *string)
5977 {
5978     int	    i;
5979     char    *p;
5980 
5981     if (envsize < 0)
5982     {				/* first time putenv called */
5983 	if (newenv() < 0)	/* copy env. to heap */
5984 	    return -1;
5985     }
5986 
5987     i = findenv((char *)string); /* look for name in environment */
5988 
5989     if (i < 0)
5990     {				/* name must be added */
5991 	for (i = 0; environ[i]; i++);
5992 	if (i >= (envsize - 1))
5993 	{			/* need new slot */
5994 	    if (moreenv() < 0)
5995 		return -1;
5996 	}
5997 	p = (char *)alloc((unsigned)(strlen(string) + 1));
5998 	if (p == NULL)		/* not enough core */
5999 	    return -1;
6000 	environ[i + 1] = 0;	/* new end of env. */
6001     }
6002     else
6003     {				/* name already in env. */
6004 	p = vim_realloc(environ[i], strlen(string) + 1);
6005 	if (p == NULL)
6006 	    return -1;
6007     }
6008     sprintf(p, "%s", string);	/* copy into env. */
6009     environ[i] = p;
6010 
6011     return 0;
6012 }
6013 
6014     static int
6015 findenv(char *name)
6016 {
6017     char    *namechar, *envchar;
6018     int	    i, found;
6019 
6020     found = 0;
6021     for (i = 0; environ[i] && !found; i++)
6022     {
6023 	envchar = environ[i];
6024 	namechar = name;
6025 	while (*namechar && *namechar != '=' && (*namechar == *envchar))
6026 	{
6027 	    namechar++;
6028 	    envchar++;
6029 	}
6030 	found = ((*namechar == '\0' || *namechar == '=') && *envchar == '=');
6031     }
6032     return found ? i - 1 : -1;
6033 }
6034 
6035     static int
6036 newenv(void)
6037 {
6038     char    **env, *elem;
6039     int	    i, esize;
6040 
6041     for (i = 0; environ[i]; i++)
6042 	;
6043 
6044     esize = i + EXTRASIZE + 1;
6045     env = (char **)alloc((unsigned)(esize * sizeof (elem)));
6046     if (env == NULL)
6047 	return -1;
6048 
6049     for (i = 0; environ[i]; i++)
6050     {
6051 	elem = (char *)alloc((unsigned)(strlen(environ[i]) + 1));
6052 	if (elem == NULL)
6053 	    return -1;
6054 	env[i] = elem;
6055 	strcpy(elem, environ[i]);
6056     }
6057 
6058     env[i] = 0;
6059     environ = env;
6060     envsize = esize;
6061     return 0;
6062 }
6063 
6064     static int
6065 moreenv(void)
6066 {
6067     int	    esize;
6068     char    **env;
6069 
6070     esize = envsize + EXTRASIZE;
6071     env = (char **)vim_realloc((char *)environ, esize * sizeof (*env));
6072     if (env == 0)
6073 	return -1;
6074     environ = env;
6075     envsize = esize;
6076     return 0;
6077 }
6078 
6079 # ifdef USE_VIMPTY_GETENV
6080 /*
6081  * Used for mch_getenv() for Mac.
6082  */
6083     char_u *
6084 vimpty_getenv(const char_u *string)
6085 {
6086     int i;
6087     char_u *p;
6088 
6089     if (envsize < 0)
6090 	return NULL;
6091 
6092     i = findenv((char *)string);
6093 
6094     if (i < 0)
6095 	return NULL;
6096 
6097     p = vim_strchr((char_u *)environ[i], '=');
6098     return (p + 1);
6099 }
6100 # endif
6101 
6102 #endif /* !defined(HAVE_SETENV) && !defined(HAVE_PUTENV) */
6103 
6104 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
6105 /*
6106  * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
6107  * rights to write into.
6108  */
6109     int
6110 filewritable(char_u *fname)
6111 {
6112     int		retval = 0;
6113 #if defined(UNIX) || defined(VMS)
6114     int		perm = 0;
6115 #endif
6116 
6117 #if defined(UNIX) || defined(VMS)
6118     perm = mch_getperm(fname);
6119 #endif
6120     if (
6121 # ifdef WIN3264
6122 	    mch_writable(fname) &&
6123 # else
6124 # if defined(UNIX) || defined(VMS)
6125 	    (perm & 0222) &&
6126 #  endif
6127 # endif
6128 	    mch_access((char *)fname, W_OK) == 0
6129        )
6130     {
6131 	++retval;
6132 	if (mch_isdir(fname))
6133 	    ++retval;
6134     }
6135     return retval;
6136 }
6137 #endif
6138 
6139 #if defined(FEAT_SPELL) || defined(FEAT_PERSISTENT_UNDO) || defined(PROTO)
6140 /*
6141  * Read 2 bytes from "fd" and turn them into an int, MSB first.
6142  * Returns -1 when encountering EOF.
6143  */
6144     int
6145 get2c(FILE *fd)
6146 {
6147     int		c, n;
6148 
6149     n = getc(fd);
6150     if (n == EOF) return -1;
6151     c = getc(fd);
6152     if (c == EOF) return -1;
6153     return (n << 8) + c;
6154 }
6155 
6156 /*
6157  * Read 3 bytes from "fd" and turn them into an int, MSB first.
6158  * Returns -1 when encountering EOF.
6159  */
6160     int
6161 get3c(FILE *fd)
6162 {
6163     int		c, n;
6164 
6165     n = getc(fd);
6166     if (n == EOF) return -1;
6167     c = getc(fd);
6168     if (c == EOF) return -1;
6169     n = (n << 8) + c;
6170     c = getc(fd);
6171     if (c == EOF) return -1;
6172     return (n << 8) + c;
6173 }
6174 
6175 /*
6176  * Read 4 bytes from "fd" and turn them into an int, MSB first.
6177  * Returns -1 when encountering EOF.
6178  */
6179     int
6180 get4c(FILE *fd)
6181 {
6182     int		c;
6183     /* Use unsigned rather than int otherwise result is undefined
6184      * when left-shift sets the MSB. */
6185     unsigned	n;
6186 
6187     c = getc(fd);
6188     if (c == EOF) return -1;
6189     n = (unsigned)c;
6190     c = getc(fd);
6191     if (c == EOF) return -1;
6192     n = (n << 8) + (unsigned)c;
6193     c = getc(fd);
6194     if (c == EOF) return -1;
6195     n = (n << 8) + (unsigned)c;
6196     c = getc(fd);
6197     if (c == EOF) return -1;
6198     n = (n << 8) + (unsigned)c;
6199     return (int)n;
6200 }
6201 
6202 /*
6203  * Read 8 bytes from "fd" and turn them into a time_T, MSB first.
6204  * Returns -1 when encountering EOF.
6205  */
6206     time_T
6207 get8ctime(FILE *fd)
6208 {
6209     int		c;
6210     time_T	n = 0;
6211     int		i;
6212 
6213     for (i = 0; i < 8; ++i)
6214     {
6215 	c = getc(fd);
6216 	if (c == EOF) return -1;
6217 	n = (n << 8) + c;
6218     }
6219     return n;
6220 }
6221 
6222 /*
6223  * Read a string of length "cnt" from "fd" into allocated memory.
6224  * Returns NULL when out of memory or unable to read that many bytes.
6225  */
6226     char_u *
6227 read_string(FILE *fd, int cnt)
6228 {
6229     char_u	*str;
6230     int		i;
6231     int		c;
6232 
6233     /* allocate memory */
6234     str = alloc((unsigned)cnt + 1);
6235     if (str != NULL)
6236     {
6237 	/* Read the string.  Quit when running into the EOF. */
6238 	for (i = 0; i < cnt; ++i)
6239 	{
6240 	    c = getc(fd);
6241 	    if (c == EOF)
6242 	    {
6243 		vim_free(str);
6244 		return NULL;
6245 	    }
6246 	    str[i] = c;
6247 	}
6248 	str[i] = NUL;
6249     }
6250     return str;
6251 }
6252 
6253 /*
6254  * Write a number to file "fd", MSB first, in "len" bytes.
6255  */
6256     int
6257 put_bytes(FILE *fd, long_u nr, int len)
6258 {
6259     int	    i;
6260 
6261     for (i = len - 1; i >= 0; --i)
6262 	if (putc((int)(nr >> (i * 8)), fd) == EOF)
6263 	    return FAIL;
6264     return OK;
6265 }
6266 
6267 #ifdef _MSC_VER
6268 # if (_MSC_VER <= 1200)
6269 /* This line is required for VC6 without the service pack.  Also see the
6270  * matching #pragma below. */
6271  #  pragma optimize("", off)
6272 # endif
6273 #endif
6274 
6275 /*
6276  * Write time_T to file "fd" in 8 bytes.
6277  * Returns FAIL when the write failed.
6278  */
6279     int
6280 put_time(FILE *fd, time_T the_time)
6281 {
6282     char_u	buf[8];
6283 
6284     time_to_bytes(the_time, buf);
6285     return fwrite(buf, (size_t)8, (size_t)1, fd) == 1 ? OK : FAIL;
6286 }
6287 
6288 /*
6289  * Write time_T to "buf[8]".
6290  */
6291     void
6292 time_to_bytes(time_T the_time, char_u *buf)
6293 {
6294     int		c;
6295     int		i;
6296     int		bi = 0;
6297     time_T	wtime = the_time;
6298 
6299     /* time_T can be up to 8 bytes in size, more than long_u, thus we
6300      * can't use put_bytes() here.
6301      * Another problem is that ">>" may do an arithmetic shift that keeps the
6302      * sign.  This happens for large values of wtime.  A cast to long_u may
6303      * truncate if time_T is 8 bytes.  So only use a cast when it is 4 bytes,
6304      * it's safe to assume that long_u is 4 bytes or more and when using 8
6305      * bytes the top bit won't be set. */
6306     for (i = 7; i >= 0; --i)
6307     {
6308 	if (i + 1 > (int)sizeof(time_T))
6309 	    /* ">>" doesn't work well when shifting more bits than avail */
6310 	    buf[bi++] = 0;
6311 	else
6312 	{
6313 #if defined(SIZEOF_TIME_T) && SIZEOF_TIME_T > 4
6314 	    c = (int)(wtime >> (i * 8));
6315 #else
6316 	    c = (int)((long_u)wtime >> (i * 8));
6317 #endif
6318 	    buf[bi++] = c;
6319 	}
6320     }
6321 }
6322 
6323 #ifdef _MSC_VER
6324 # if (_MSC_VER <= 1200)
6325  #  pragma optimize("", on)
6326 # endif
6327 #endif
6328 
6329 #endif
6330 
6331 #if (defined(FEAT_MBYTE) && defined(FEAT_QUICKFIX)) \
6332 	|| defined(FEAT_SPELL) || defined(PROTO)
6333 /*
6334  * Return TRUE if string "s" contains a non-ASCII character (128 or higher).
6335  * When "s" is NULL FALSE is returned.
6336  */
6337     int
6338 has_non_ascii(char_u *s)
6339 {
6340     char_u	*p;
6341 
6342     if (s != NULL)
6343 	for (p = s; *p != NUL; ++p)
6344 	    if (*p >= 128)
6345 		return TRUE;
6346     return FALSE;
6347 }
6348 #endif
6349 
6350 #if defined(MESSAGE_QUEUE) || defined(PROTO)
6351 /*
6352  * Process messages that have been queued for netbeans or clientserver.
6353  * Also check if any jobs have ended.
6354  * These functions can call arbitrary vimscript and should only be called when
6355  * it is safe to do so.
6356  */
6357     void
6358 parse_queued_messages(void)
6359 {
6360     win_T *old_curwin = curwin;
6361 
6362     // Do not handle messages while redrawing, because it may cause buffers to
6363     // change or be wiped while they are being redrawn.
6364     if (updating_screen)
6365 	return;
6366 
6367     // For Win32 mch_breakcheck() does not check for input, do it here.
6368 # if defined(WIN32) && defined(FEAT_JOB_CHANNEL)
6369     channel_handle_events(FALSE);
6370 # endif
6371 
6372 # ifdef FEAT_NETBEANS_INTG
6373     // Process the queued netbeans messages.
6374     netbeans_parse_messages();
6375 # endif
6376 # ifdef FEAT_JOB_CHANNEL
6377     // Write any buffer lines still to be written.
6378     channel_write_any_lines();
6379 
6380     // Process the messages queued on channels.
6381     channel_parse_messages();
6382 # endif
6383 # if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
6384     // Process the queued clientserver messages.
6385     server_parse_messages();
6386 # endif
6387 # ifdef FEAT_JOB_CHANNEL
6388     // Check if any jobs have ended.
6389     job_check_ended();
6390 # endif
6391 
6392     // If the current window changed we need to bail out of the waiting loop.
6393     // E.g. when a job exit callback closes the terminal window.
6394     if (curwin != old_curwin)
6395 	ins_char_typebuf(K_IGNORE);
6396 }
6397 #endif
6398 
6399 #ifndef PROTO  /* proto is defined in vim.h */
6400 # ifdef ELAPSED_TIMEVAL
6401 /*
6402  * Return time in msec since "start_tv".
6403  */
6404     long
6405 elapsed(struct timeval *start_tv)
6406 {
6407     struct timeval  now_tv;
6408 
6409     gettimeofday(&now_tv, NULL);
6410     return (now_tv.tv_sec - start_tv->tv_sec) * 1000L
6411 	 + (now_tv.tv_usec - start_tv->tv_usec) / 1000L;
6412 }
6413 # endif
6414 
6415 # ifdef ELAPSED_TICKCOUNT
6416 /*
6417  * Return time in msec since "start_tick".
6418  */
6419     long
6420 elapsed(DWORD start_tick)
6421 {
6422     DWORD	now = GetTickCount();
6423 
6424     return (long)now - (long)start_tick;
6425 }
6426 # endif
6427 #endif
6428 
6429 #if defined(FEAT_JOB_CHANNEL) \
6430 	|| (defined(UNIX) && (!defined(USE_SYSTEM) \
6431 	|| (defined(FEAT_GUI) && defined(FEAT_TERMINAL)))) \
6432 	|| defined(PROTO)
6433 /*
6434  * Parse "cmd" and put the white-separated parts in "argv".
6435  * "argv" is an allocated array with "argc" entries and room for 4 more.
6436  * Returns FAIL when out of memory.
6437  */
6438     int
6439 mch_parse_cmd(char_u *cmd, int use_shcf, char ***argv, int *argc)
6440 {
6441     int		i;
6442     char_u	*p, *d;
6443     int		inquote;
6444 
6445     /*
6446      * Do this loop twice:
6447      * 1: find number of arguments
6448      * 2: separate them and build argv[]
6449      */
6450     for (i = 0; i < 2; ++i)
6451     {
6452 	p = skipwhite(cmd);
6453 	inquote = FALSE;
6454 	*argc = 0;
6455 	for (;;)
6456 	{
6457 	    if (i == 1)
6458 		(*argv)[*argc] = (char *)p;
6459 	    ++*argc;
6460 	    d = p;
6461 	    while (*p != NUL && (inquote || (*p != ' ' && *p != TAB)))
6462 	    {
6463 		if (p[0] == '"')
6464 		    // quotes surrounding an argument and are dropped
6465 		    inquote = !inquote;
6466 		else
6467 		{
6468 		    if (rem_backslash(p))
6469 		    {
6470 			// First pass: skip over "\ " and "\"".
6471 			// Second pass: Remove the backslash.
6472 			++p;
6473 		    }
6474 		    if (i == 1)
6475 			*d++ = *p;
6476 		}
6477 		++p;
6478 	    }
6479 	    if (*p == NUL)
6480 	    {
6481 		if (i == 1)
6482 		    *d++ = NUL;
6483 		break;
6484 	    }
6485 	    if (i == 1)
6486 		*d++ = NUL;
6487 	    p = skipwhite(p + 1);
6488 	}
6489 	if (*argv == NULL)
6490 	{
6491 	    if (use_shcf)
6492 	    {
6493 		/* Account for possible multiple args in p_shcf. */
6494 		p = p_shcf;
6495 		for (;;)
6496 		{
6497 		    p = skiptowhite(p);
6498 		    if (*p == NUL)
6499 			break;
6500 		    ++*argc;
6501 		    p = skipwhite(p);
6502 		}
6503 	    }
6504 
6505 	    *argv = (char **)alloc((unsigned)((*argc + 4) * sizeof(char *)));
6506 	    if (*argv == NULL)	    /* out of memory */
6507 		return FAIL;
6508 	}
6509     }
6510     return OK;
6511 }
6512 
6513 # if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
6514 /*
6515  * Build "argv[argc]" from the string "cmd".
6516  * "argv[argc]" is set to NULL;
6517  * Return FAIL when out of memory.
6518  */
6519     int
6520 build_argv_from_string(char_u *cmd, char ***argv, int *argc)
6521 {
6522     char_u	*cmd_copy;
6523     int		i;
6524 
6525     /* Make a copy, parsing will modify "cmd". */
6526     cmd_copy = vim_strsave(cmd);
6527     if (cmd_copy == NULL
6528 	    || mch_parse_cmd(cmd_copy, FALSE, argv, argc) == FAIL)
6529     {
6530 	vim_free(cmd_copy);
6531 	return FAIL;
6532     }
6533     for (i = 0; i < *argc; i++)
6534 	(*argv)[i] = (char *)vim_strsave((char_u *)(*argv)[i]);
6535     (*argv)[*argc] = NULL;
6536     vim_free(cmd_copy);
6537     return OK;
6538 }
6539 
6540 /*
6541  * Build "argv[argc]" from the list "l".
6542  * "argv[argc]" is set to NULL;
6543  * Return FAIL when out of memory.
6544  */
6545     int
6546 build_argv_from_list(list_T *l, char ***argv, int *argc)
6547 {
6548     listitem_T  *li;
6549     char_u	*s;
6550 
6551     /* Pass argv[] to mch_call_shell(). */
6552     *argv = (char **)alloc(sizeof(char *) * (l->lv_len + 1));
6553     if (*argv == NULL)
6554 	return FAIL;
6555     *argc = 0;
6556     for (li = l->lv_first; li != NULL; li = li->li_next)
6557     {
6558 	s = get_tv_string_chk(&li->li_tv);
6559 	if (s == NULL)
6560 	{
6561 	    int i;
6562 
6563 	    for (i = 0; i < *argc; ++i)
6564 		vim_free((*argv)[i]);
6565 	    return FAIL;
6566 	}
6567 	(*argv)[*argc] = (char *)vim_strsave(s);
6568 	*argc += 1;
6569     }
6570     (*argv)[*argc] = NULL;
6571     return OK;
6572 }
6573 # endif
6574 #endif
6575