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