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