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