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