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