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