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