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