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