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