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