xref: /vim-8.2.3635/src/misc2.c (revision eae1b91f)
1 /* vi:set ts=8 sts=4 sw=4 noet:
2  *
3  * VIM - Vi IMproved	by Bram Moolenaar
4  *
5  * Do ":help uganda"  in Vim to read copying and usage conditions.
6  * Do ":help credits" in Vim to see a list of people who contributed.
7  * See README.txt for an overview of the Vim source code.
8  */
9 
10 /*
11  * misc2.c: Various functions.
12  */
13 #include "vim.h"
14 
15 static char_u	*username = NULL; /* cached result of mch_get_user_name() */
16 
17 static int coladvance2(pos_T *pos, int addspaces, int finetune, colnr_T wcol);
18 
19 /*
20  * Return TRUE if in the current mode we need to use virtual.
21  */
22     int
23 virtual_active(void)
24 {
25     /* While an operator is being executed we return "virtual_op", because
26      * VIsual_active has already been reset, thus we can't check for "block"
27      * being used. */
28     if (virtual_op != MAYBE)
29 	return virtual_op;
30     return (ve_flags == VE_ALL
31 	    || ((ve_flags & VE_BLOCK) && VIsual_active && VIsual_mode == Ctrl_V)
32 	    || ((ve_flags & VE_INSERT) && (State & INSERT)));
33 }
34 
35 /*
36  * Get the screen position of the cursor.
37  */
38     int
39 getviscol(void)
40 {
41     colnr_T	x;
42 
43     getvvcol(curwin, &curwin->w_cursor, &x, NULL, NULL);
44     return (int)x;
45 }
46 
47 /*
48  * Go to column "wcol", and add/insert white space as necessary to get the
49  * cursor in that column.
50  * The caller must have saved the cursor line for undo!
51  */
52     int
53 coladvance_force(colnr_T wcol)
54 {
55     int rc = coladvance2(&curwin->w_cursor, TRUE, FALSE, wcol);
56 
57     if (wcol == MAXCOL)
58 	curwin->w_valid &= ~VALID_VIRTCOL;
59     else
60     {
61 	/* Virtcol is valid */
62 	curwin->w_valid |= VALID_VIRTCOL;
63 	curwin->w_virtcol = wcol;
64     }
65     return rc;
66 }
67 
68 /*
69  * Get the screen position of character col with a coladd in the cursor line.
70  */
71     int
72 getviscol2(colnr_T col, colnr_T coladd UNUSED)
73 {
74     colnr_T	x;
75     pos_T	pos;
76 
77     pos.lnum = curwin->w_cursor.lnum;
78     pos.col = col;
79     pos.coladd = coladd;
80     getvvcol(curwin, &pos, &x, NULL, NULL);
81     return (int)x;
82 }
83 
84 /*
85  * Try to advance the Cursor to the specified screen column.
86  * If virtual editing: fine tune the cursor position.
87  * Note that all virtual positions off the end of a line should share
88  * a curwin->w_cursor.col value (n.b. this is equal to STRLEN(line)),
89  * beginning at coladd 0.
90  *
91  * return OK if desired column is reached, FAIL if not
92  */
93     int
94 coladvance(colnr_T wcol)
95 {
96     int rc = getvpos(&curwin->w_cursor, wcol);
97 
98     if (wcol == MAXCOL || rc == FAIL)
99 	curwin->w_valid &= ~VALID_VIRTCOL;
100     else if (*ml_get_cursor() != TAB)
101     {
102 	/* Virtcol is valid when not on a TAB */
103 	curwin->w_valid |= VALID_VIRTCOL;
104 	curwin->w_virtcol = wcol;
105     }
106     return rc;
107 }
108 
109 /*
110  * Return in "pos" the position of the cursor advanced to screen column "wcol".
111  * return OK if desired column is reached, FAIL if not
112  */
113     int
114 getvpos(pos_T *pos, colnr_T wcol)
115 {
116     return coladvance2(pos, FALSE, virtual_active(), wcol);
117 }
118 
119     static int
120 coladvance2(
121     pos_T	*pos,
122     int		addspaces,	/* change the text to achieve our goal? */
123     int		finetune,	/* change char offset for the exact column */
124     colnr_T	wcol)		/* column to move to */
125 {
126     int		idx;
127     char_u	*ptr;
128     char_u	*line;
129     colnr_T	col = 0;
130     int		csize = 0;
131     int		one_more;
132 #ifdef FEAT_LINEBREAK
133     int		head = 0;
134 #endif
135 
136     one_more = (State & INSERT)
137 		    || restart_edit != NUL
138 		    || (VIsual_active && *p_sel != 'o')
139 		    || ((ve_flags & VE_ONEMORE) && wcol < MAXCOL) ;
140     line = ml_get_buf(curbuf, pos->lnum, FALSE);
141 
142     if (wcol >= MAXCOL)
143     {
144 	    idx = (int)STRLEN(line) - 1 + one_more;
145 	    col = wcol;
146 
147 	    if ((addspaces || finetune) && !VIsual_active)
148 	    {
149 		curwin->w_curswant = linetabsize(line) + one_more;
150 		if (curwin->w_curswant > 0)
151 		    --curwin->w_curswant;
152 	    }
153     }
154     else
155     {
156 	int width = curwin->w_width - win_col_off(curwin);
157 
158 	if (finetune
159 		&& curwin->w_p_wrap
160 		&& curwin->w_width != 0
161 		&& wcol >= (colnr_T)width)
162 	{
163 	    csize = linetabsize(line);
164 	    if (csize > 0)
165 		csize--;
166 
167 	    if (wcol / width > (colnr_T)csize / width
168 		    && ((State & INSERT) == 0 || (int)wcol > csize + 1))
169 	    {
170 		/* In case of line wrapping don't move the cursor beyond the
171 		 * right screen edge.  In Insert mode allow going just beyond
172 		 * the last character (like what happens when typing and
173 		 * reaching the right window edge). */
174 		wcol = (csize / width + 1) * width - 1;
175 	    }
176 	}
177 
178 	ptr = line;
179 	while (col <= wcol && *ptr != NUL)
180 	{
181 	    /* Count a tab for what it's worth (if list mode not on) */
182 #ifdef FEAT_LINEBREAK
183 	    csize = win_lbr_chartabsize(curwin, line, ptr, col, &head);
184 	    MB_PTR_ADV(ptr);
185 #else
186 	    csize = lbr_chartabsize_adv(line, &ptr, col);
187 #endif
188 	    col += csize;
189 	}
190 	idx = (int)(ptr - line);
191 	/*
192 	 * Handle all the special cases.  The virtual_active() check
193 	 * is needed to ensure that a virtual position off the end of
194 	 * a line has the correct indexing.  The one_more comparison
195 	 * replaces an explicit add of one_more later on.
196 	 */
197 	if (col > wcol || (!virtual_active() && one_more == 0))
198 	{
199 	    idx -= 1;
200 # ifdef FEAT_LINEBREAK
201 	    /* Don't count the chars from 'showbreak'. */
202 	    csize -= head;
203 # endif
204 	    col -= csize;
205 	}
206 
207 	if (virtual_active()
208 		&& addspaces
209 		&& ((col != wcol && col != wcol + 1) || csize > 1))
210 	{
211 	    /* 'virtualedit' is set: The difference between wcol and col is
212 	     * filled with spaces. */
213 
214 	    if (line[idx] == NUL)
215 	    {
216 		/* Append spaces */
217 		int	correct = wcol - col;
218 		char_u	*newline = alloc(idx + correct + 1);
219 		int	t;
220 
221 		if (newline == NULL)
222 		    return FAIL;
223 
224 		for (t = 0; t < idx; ++t)
225 		    newline[t] = line[t];
226 
227 		for (t = 0; t < correct; ++t)
228 		    newline[t + idx] = ' ';
229 
230 		newline[idx + correct] = NUL;
231 
232 		ml_replace(pos->lnum, newline, FALSE);
233 		changed_bytes(pos->lnum, (colnr_T)idx);
234 		idx += correct;
235 		col = wcol;
236 	    }
237 	    else
238 	    {
239 		/* Break a tab */
240 		int	linelen = (int)STRLEN(line);
241 		int	correct = wcol - col - csize + 1; /* negative!! */
242 		char_u	*newline;
243 		int	t, s = 0;
244 		int	v;
245 
246 		if (-correct > csize)
247 		    return FAIL;
248 
249 		newline = alloc(linelen + csize);
250 		if (newline == NULL)
251 		    return FAIL;
252 
253 		for (t = 0; t < linelen; t++)
254 		{
255 		    if (t != idx)
256 			newline[s++] = line[t];
257 		    else
258 			for (v = 0; v < csize; v++)
259 			    newline[s++] = ' ';
260 		}
261 
262 		newline[linelen + csize - 1] = NUL;
263 
264 		ml_replace(pos->lnum, newline, FALSE);
265 		changed_bytes(pos->lnum, idx);
266 		idx += (csize - 1 + correct);
267 		col += correct;
268 	    }
269 	}
270     }
271 
272     if (idx < 0)
273 	pos->col = 0;
274     else
275 	pos->col = idx;
276 
277     pos->coladd = 0;
278 
279     if (finetune)
280     {
281 	if (wcol == MAXCOL)
282 	{
283 	    /* The width of the last character is used to set coladd. */
284 	    if (!one_more)
285 	    {
286 		colnr_T	    scol, ecol;
287 
288 		getvcol(curwin, pos, &scol, NULL, &ecol);
289 		pos->coladd = ecol - scol;
290 	    }
291 	}
292 	else
293 	{
294 	    int b = (int)wcol - (int)col;
295 
296 	    /* The difference between wcol and col is used to set coladd. */
297 	    if (b > 0 && b < (MAXCOL - 2 * curwin->w_width))
298 		pos->coladd = b;
299 
300 	    col += b;
301 	}
302     }
303 
304     /* prevent from moving onto a trail byte */
305     if (has_mbyte)
306 	mb_adjustpos(curbuf, pos);
307 
308     if (col < wcol)
309 	return FAIL;
310     return OK;
311 }
312 
313 /*
314  * Increment the cursor position.  See inc() for return values.
315  */
316     int
317 inc_cursor(void)
318 {
319     return inc(&curwin->w_cursor);
320 }
321 
322 /*
323  * Increment the line pointer "lp" crossing line boundaries as necessary.
324  * Return 1 when going to the next line.
325  * Return 2 when moving forward onto a NUL at the end of the line).
326  * Return -1 when at the end of file.
327  * Return 0 otherwise.
328  */
329     int
330 inc(pos_T *lp)
331 {
332     char_u  *p;
333 
334     /* when searching position may be set to end of a line */
335     if (lp->col != MAXCOL)
336     {
337 	p = ml_get_pos(lp);
338 	if (*p != NUL)	/* still within line, move to next char (may be NUL) */
339 	{
340 	    if (has_mbyte)
341 	    {
342 		int l = (*mb_ptr2len)(p);
343 
344 		lp->col += l;
345 		return ((p[l] != NUL) ? 0 : 2);
346 	    }
347 	    lp->col++;
348 	    lp->coladd = 0;
349 	    return ((p[1] != NUL) ? 0 : 2);
350 	}
351     }
352     if (lp->lnum != curbuf->b_ml.ml_line_count)     /* there is a next line */
353     {
354 	lp->col = 0;
355 	lp->lnum++;
356 	lp->coladd = 0;
357 	return 1;
358     }
359     return -1;
360 }
361 
362 /*
363  * incl(lp): same as inc(), but skip the NUL at the end of non-empty lines
364  */
365     int
366 incl(pos_T *lp)
367 {
368     int	    r;
369 
370     if ((r = inc(lp)) >= 1 && lp->col)
371 	r = inc(lp);
372     return r;
373 }
374 
375 /*
376  * dec(p)
377  *
378  * Decrement the line pointer 'p' crossing line boundaries as necessary.
379  * Return 1 when crossing a line, -1 when at start of file, 0 otherwise.
380  */
381     int
382 dec_cursor(void)
383 {
384     return dec(&curwin->w_cursor);
385 }
386 
387     int
388 dec(pos_T *lp)
389 {
390     char_u	*p;
391 
392     lp->coladd = 0;
393     if (lp->col == MAXCOL)
394     {
395 	/* past end of line */
396 	p = ml_get(lp->lnum);
397 	lp->col = (colnr_T)STRLEN(p);
398 	if (has_mbyte)
399 	    lp->col -= (*mb_head_off)(p, p + lp->col);
400 	return 0;
401     }
402 
403     if (lp->col > 0)
404     {
405 	/* still within line */
406 	lp->col--;
407 	if (has_mbyte)
408 	{
409 	    p = ml_get(lp->lnum);
410 	    lp->col -= (*mb_head_off)(p, p + lp->col);
411 	}
412 	return 0;
413     }
414 
415     if (lp->lnum > 1)
416     {
417 	/* there is a prior line */
418 	lp->lnum--;
419 	p = ml_get(lp->lnum);
420 	lp->col = (colnr_T)STRLEN(p);
421 	if (has_mbyte)
422 	    lp->col -= (*mb_head_off)(p, p + lp->col);
423 	return 1;
424     }
425 
426     /* at start of file */
427     return -1;
428 }
429 
430 /*
431  * decl(lp): same as dec(), but skip the NUL at the end of non-empty lines
432  */
433     int
434 decl(pos_T *lp)
435 {
436     int	    r;
437 
438     if ((r = dec(lp)) == 1 && lp->col)
439 	r = dec(lp);
440     return r;
441 }
442 
443 /*
444  * Get the line number relative to the current cursor position, i.e. the
445  * difference between line number and cursor position. Only look for lines that
446  * can be visible, folded lines don't count.
447  */
448     linenr_T
449 get_cursor_rel_lnum(
450     win_T	*wp,
451     linenr_T	lnum)		    /* line number to get the result for */
452 {
453     linenr_T	cursor = wp->w_cursor.lnum;
454     linenr_T	retval = 0;
455 
456 #ifdef FEAT_FOLDING
457     if (hasAnyFolding(wp))
458     {
459 	if (lnum > cursor)
460 	{
461 	    while (lnum > cursor)
462 	    {
463 		(void)hasFoldingWin(wp, lnum, &lnum, NULL, TRUE, NULL);
464 		/* if lnum and cursor are in the same fold,
465 		 * now lnum <= cursor */
466 		if (lnum > cursor)
467 		    retval++;
468 		lnum--;
469 	    }
470 	}
471 	else if (lnum < cursor)
472 	{
473 	    while (lnum < cursor)
474 	    {
475 		(void)hasFoldingWin(wp, lnum, NULL, &lnum, TRUE, NULL);
476 		/* if lnum and cursor are in the same fold,
477 		 * now lnum >= cursor */
478 		if (lnum < cursor)
479 		    retval--;
480 		lnum++;
481 	    }
482 	}
483 	/* else if (lnum == cursor)
484 	 *     retval = 0;
485 	 */
486     }
487     else
488 #endif
489 	retval = lnum - cursor;
490 
491     return retval;
492 }
493 
494 /*
495  * Make sure "pos.lnum" and "pos.col" are valid in "buf".
496  * This allows for the col to be on the NUL byte.
497  */
498     void
499 check_pos(buf_T *buf, pos_T *pos)
500 {
501     char_u *line;
502     colnr_T len;
503 
504     if (pos->lnum > buf->b_ml.ml_line_count)
505 	pos->lnum = buf->b_ml.ml_line_count;
506 
507     if (pos->col > 0)
508     {
509 	line = ml_get_buf(buf, pos->lnum, FALSE);
510 	len = (colnr_T)STRLEN(line);
511 	if (pos->col > len)
512 	    pos->col = len;
513     }
514 }
515 
516 /*
517  * Make sure curwin->w_cursor.lnum is valid.
518  */
519     void
520 check_cursor_lnum(void)
521 {
522     if (curwin->w_cursor.lnum > curbuf->b_ml.ml_line_count)
523     {
524 #ifdef FEAT_FOLDING
525 	/* If there is a closed fold at the end of the file, put the cursor in
526 	 * its first line.  Otherwise in the last line. */
527 	if (!hasFolding(curbuf->b_ml.ml_line_count,
528 						&curwin->w_cursor.lnum, NULL))
529 #endif
530 	    curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
531     }
532     if (curwin->w_cursor.lnum <= 0)
533 	curwin->w_cursor.lnum = 1;
534 }
535 
536 /*
537  * Make sure curwin->w_cursor.col is valid.
538  */
539     void
540 check_cursor_col(void)
541 {
542     check_cursor_col_win(curwin);
543 }
544 
545 /*
546  * Make sure win->w_cursor.col is valid.
547  */
548     void
549 check_cursor_col_win(win_T *win)
550 {
551     colnr_T len;
552     colnr_T oldcol = win->w_cursor.col;
553     colnr_T oldcoladd = win->w_cursor.col + win->w_cursor.coladd;
554 
555     len = (colnr_T)STRLEN(ml_get_buf(win->w_buffer, win->w_cursor.lnum, FALSE));
556     if (len == 0)
557 	win->w_cursor.col = 0;
558     else if (win->w_cursor.col >= len)
559     {
560 	/* Allow cursor past end-of-line when:
561 	 * - in Insert mode or restarting Insert mode
562 	 * - in Visual mode and 'selection' isn't "old"
563 	 * - 'virtualedit' is set */
564 	if ((State & INSERT) || restart_edit
565 		|| (VIsual_active && *p_sel != 'o')
566 		|| (ve_flags & VE_ONEMORE)
567 		|| virtual_active())
568 	    win->w_cursor.col = len;
569 	else
570 	{
571 	    win->w_cursor.col = len - 1;
572 	    /* Move the cursor to the head byte. */
573 	    if (has_mbyte)
574 		mb_adjustpos(win->w_buffer, &win->w_cursor);
575 	}
576     }
577     else if (win->w_cursor.col < 0)
578 	win->w_cursor.col = 0;
579 
580     /* If virtual editing is on, we can leave the cursor on the old position,
581      * only we must set it to virtual.  But don't do it when at the end of the
582      * line. */
583     if (oldcol == MAXCOL)
584 	win->w_cursor.coladd = 0;
585     else if (ve_flags == VE_ALL)
586     {
587 	if (oldcoladd > win->w_cursor.col)
588 	{
589 	    win->w_cursor.coladd = oldcoladd - win->w_cursor.col;
590 
591 	    /* Make sure that coladd is not more than the char width.
592 	     * Not for the last character, coladd is then used when the cursor
593 	     * is actually after the last character. */
594 	    if (win->w_cursor.col + 1 < len && win->w_cursor.coladd > 0)
595 	    {
596 		int cs, ce;
597 
598 		getvcol(win, &win->w_cursor, &cs, NULL, &ce);
599 		if (win->w_cursor.coladd > ce - cs)
600 		    win->w_cursor.coladd = ce - cs;
601 	    }
602 	}
603 	else
604 	    /* avoid weird number when there is a miscalculation or overflow */
605 	    win->w_cursor.coladd = 0;
606     }
607 }
608 
609 /*
610  * make sure curwin->w_cursor in on a valid character
611  */
612     void
613 check_cursor(void)
614 {
615     check_cursor_lnum();
616     check_cursor_col();
617 }
618 
619 #if defined(FEAT_TEXTOBJ) || defined(PROTO)
620 /*
621  * Make sure curwin->w_cursor is not on the NUL at the end of the line.
622  * Allow it when in Visual mode and 'selection' is not "old".
623  */
624     void
625 adjust_cursor_col(void)
626 {
627     if (curwin->w_cursor.col > 0
628 	    && (!VIsual_active || *p_sel == 'o')
629 	    && gchar_cursor() == NUL)
630 	--curwin->w_cursor.col;
631 }
632 #endif
633 
634 /*
635  * When curwin->w_leftcol has changed, adjust the cursor position.
636  * Return TRUE if the cursor was moved.
637  */
638     int
639 leftcol_changed(void)
640 {
641     long	lastcol;
642     colnr_T	s, e;
643     int		retval = FALSE;
644     long        siso = get_sidescrolloff_value();
645 
646     changed_cline_bef_curs();
647     lastcol = curwin->w_leftcol + curwin->w_width - curwin_col_off() - 1;
648     validate_virtcol();
649 
650     /*
651      * If the cursor is right or left of the screen, move it to last or first
652      * character.
653      */
654     if (curwin->w_virtcol > (colnr_T)(lastcol - siso))
655     {
656 	retval = TRUE;
657 	coladvance((colnr_T)(lastcol - siso));
658     }
659     else if (curwin->w_virtcol < curwin->w_leftcol + siso)
660     {
661 	retval = TRUE;
662 	(void)coladvance((colnr_T)(curwin->w_leftcol + siso));
663     }
664 
665     /*
666      * If the start of the character under the cursor is not on the screen,
667      * advance the cursor one more char.  If this fails (last char of the
668      * line) adjust the scrolling.
669      */
670     getvvcol(curwin, &curwin->w_cursor, &s, NULL, &e);
671     if (e > (colnr_T)lastcol)
672     {
673 	retval = TRUE;
674 	coladvance(s - 1);
675     }
676     else if (s < curwin->w_leftcol)
677     {
678 	retval = TRUE;
679 	if (coladvance(e + 1) == FAIL)	/* there isn't another character */
680 	{
681 	    curwin->w_leftcol = s;	/* adjust w_leftcol instead */
682 	    changed_cline_bef_curs();
683 	}
684     }
685 
686     if (retval)
687 	curwin->w_set_curswant = TRUE;
688     redraw_later(NOT_VALID);
689     return retval;
690 }
691 
692 /**********************************************************************
693  * Various routines dealing with allocation and deallocation of memory.
694  */
695 
696 #if defined(MEM_PROFILE) || defined(PROTO)
697 
698 # define MEM_SIZES  8200
699 static long_u mem_allocs[MEM_SIZES];
700 static long_u mem_frees[MEM_SIZES];
701 static long_u mem_allocated;
702 static long_u mem_freed;
703 static long_u mem_peak;
704 static long_u num_alloc;
705 static long_u num_freed;
706 
707     static void
708 mem_pre_alloc_s(size_t *sizep)
709 {
710     *sizep += sizeof(size_t);
711 }
712 
713     static void
714 mem_pre_alloc_l(long_u *sizep)
715 {
716     *sizep += sizeof(size_t);
717 }
718 
719     static void
720 mem_post_alloc(
721     void **pp,
722     size_t size)
723 {
724     if (*pp == NULL)
725 	return;
726     size -= sizeof(size_t);
727     *(long_u *)*pp = size;
728     if (size <= MEM_SIZES-1)
729 	mem_allocs[size-1]++;
730     else
731 	mem_allocs[MEM_SIZES-1]++;
732     mem_allocated += size;
733     if (mem_allocated - mem_freed > mem_peak)
734 	mem_peak = mem_allocated - mem_freed;
735     num_alloc++;
736     *pp = (void *)((char *)*pp + sizeof(size_t));
737 }
738 
739     static void
740 mem_pre_free(void **pp)
741 {
742     long_u size;
743 
744     *pp = (void *)((char *)*pp - sizeof(size_t));
745     size = *(size_t *)*pp;
746     if (size <= MEM_SIZES-1)
747 	mem_frees[size-1]++;
748     else
749 	mem_frees[MEM_SIZES-1]++;
750     mem_freed += size;
751     num_freed++;
752 }
753 
754 /*
755  * called on exit via atexit()
756  */
757     void
758 vim_mem_profile_dump(void)
759 {
760     int i, j;
761 
762     printf("\r\n");
763     j = 0;
764     for (i = 0; i < MEM_SIZES - 1; i++)
765     {
766 	if (mem_allocs[i] || mem_frees[i])
767 	{
768 	    if (mem_frees[i] > mem_allocs[i])
769 		printf("\r\n%s", _("ERROR: "));
770 	    printf("[%4d / %4lu-%-4lu] ", i + 1, mem_allocs[i], mem_frees[i]);
771 	    j++;
772 	    if (j > 3)
773 	    {
774 		j = 0;
775 		printf("\r\n");
776 	    }
777 	}
778     }
779 
780     i = MEM_SIZES - 1;
781     if (mem_allocs[i])
782     {
783 	printf("\r\n");
784 	if (mem_frees[i] > mem_allocs[i])
785 	    puts(_("ERROR: "));
786 	printf("[>%d / %4lu-%-4lu]", i, mem_allocs[i], mem_frees[i]);
787     }
788 
789     printf(_("\n[bytes] total alloc-freed %lu-%lu, in use %lu, peak use %lu\n"),
790 	    mem_allocated, mem_freed, mem_allocated - mem_freed, mem_peak);
791     printf(_("[calls] total re/malloc()'s %lu, total free()'s %lu\n\n"),
792 	    num_alloc, num_freed);
793 }
794 
795 #endif /* MEM_PROFILE */
796 
797 #ifdef FEAT_EVAL
798     int
799 alloc_does_fail(long_u size)
800 {
801     if (alloc_fail_countdown == 0)
802     {
803 	if (--alloc_fail_repeat <= 0)
804 	    alloc_fail_id = 0;
805 	do_outofmem_msg(size);
806 	return TRUE;
807     }
808     --alloc_fail_countdown;
809     return FALSE;
810 }
811 #endif
812 
813 /*
814  * Some memory is reserved for error messages and for being able to
815  * call mf_release_all(), which needs some memory for mf_trans_add().
816  */
817 #define KEEP_ROOM (2 * 8192L)
818 #define KEEP_ROOM_KB (KEEP_ROOM / 1024L)
819 
820 /*
821  * Note: if unsigned is 16 bits we can only allocate up to 64K with alloc().
822  * Use lalloc for larger blocks.
823  */
824     char_u *
825 alloc(unsigned size)
826 {
827     return (lalloc((long_u)size, TRUE));
828 }
829 
830 /*
831  * alloc() with an ID for alloc_fail().
832  */
833     char_u *
834 alloc_id(unsigned size, alloc_id_T id UNUSED)
835 {
836 #ifdef FEAT_EVAL
837     if (alloc_fail_id == id && alloc_does_fail((long_u)size))
838 	return NULL;
839 #endif
840     return (lalloc((long_u)size, TRUE));
841 }
842 
843 /*
844  * Allocate memory and set all bytes to zero.
845  */
846     char_u *
847 alloc_clear(unsigned size)
848 {
849     char_u *p;
850 
851     p = lalloc((long_u)size, TRUE);
852     if (p != NULL)
853 	(void)vim_memset(p, 0, (size_t)size);
854     return p;
855 }
856 
857 /*
858  * Same as alloc_clear() but with allocation id for testing
859  */
860     char_u *
861 alloc_clear_id(unsigned size, alloc_id_T id UNUSED)
862 {
863 #ifdef FEAT_EVAL
864     if (alloc_fail_id == id && alloc_does_fail((long_u)size))
865 	return NULL;
866 #endif
867     return alloc_clear(size);
868 }
869 
870 /*
871  * alloc() with check for maximum line length
872  */
873     char_u *
874 alloc_check(unsigned size)
875 {
876 #if !defined(UNIX)
877     if (sizeof(int) == 2 && size > 0x7fff)
878     {
879 	/* Don't hide this message */
880 	emsg_silent = 0;
881 	emsg(_("E340: Line is becoming too long"));
882 	return NULL;
883     }
884 #endif
885     return (lalloc((long_u)size, TRUE));
886 }
887 
888 /*
889  * Allocate memory like lalloc() and set all bytes to zero.
890  */
891     char_u *
892 lalloc_clear(long_u size, int message)
893 {
894     char_u *p;
895 
896     p = (lalloc(size, message));
897     if (p != NULL)
898 	(void)vim_memset(p, 0, (size_t)size);
899     return p;
900 }
901 
902 /*
903  * Low level memory allocation function.
904  * This is used often, KEEP IT FAST!
905  */
906     char_u *
907 lalloc(long_u size, int message)
908 {
909     char_u	*p;		    /* pointer to new storage space */
910     static int	releasing = FALSE;  /* don't do mf_release_all() recursive */
911     int		try_again;
912 #if defined(HAVE_AVAIL_MEM)
913     static long_u allocated = 0;    /* allocated since last avail check */
914 #endif
915 
916     /* Safety check for allocating zero bytes */
917     if (size == 0)
918     {
919 	/* Don't hide this message */
920 	emsg_silent = 0;
921 	siemsg(_("E341: Internal error: lalloc(%ld, )"), size);
922 	return NULL;
923     }
924 
925 #ifdef MEM_PROFILE
926     mem_pre_alloc_l(&size);
927 #endif
928 
929     /*
930      * Loop when out of memory: Try to release some memfile blocks and
931      * if some blocks are released call malloc again.
932      */
933     for (;;)
934     {
935 	/*
936 	 * Handle three kind of systems:
937 	 * 1. No check for available memory: Just return.
938 	 * 2. Slow check for available memory: call mch_avail_mem() after
939 	 *    allocating KEEP_ROOM amount of memory.
940 	 * 3. Strict check for available memory: call mch_avail_mem()
941 	 */
942 	if ((p = (char_u *)malloc((size_t)size)) != NULL)
943 	{
944 #ifndef HAVE_AVAIL_MEM
945 	    /* 1. No check for available memory: Just return. */
946 	    goto theend;
947 #else
948 	    /* 2. Slow check for available memory: call mch_avail_mem() after
949 	     *    allocating (KEEP_ROOM / 2) amount of memory. */
950 	    allocated += size;
951 	    if (allocated < KEEP_ROOM / 2)
952 		goto theend;
953 	    allocated = 0;
954 
955 	    /* 3. check for available memory: call mch_avail_mem() */
956 	    if (mch_avail_mem(TRUE) < KEEP_ROOM_KB && !releasing)
957 	    {
958 		free((char *)p);	/* System is low... no go! */
959 		p = NULL;
960 	    }
961 	    else
962 		goto theend;
963 #endif
964 	}
965 	/*
966 	 * Remember that mf_release_all() is being called to avoid an endless
967 	 * loop, because mf_release_all() may call alloc() recursively.
968 	 */
969 	if (releasing)
970 	    break;
971 	releasing = TRUE;
972 
973 	clear_sb_text(TRUE);	      /* free any scrollback text */
974 	try_again = mf_release_all(); /* release as many blocks as possible */
975 
976 	releasing = FALSE;
977 	if (!try_again)
978 	    break;
979     }
980 
981     if (message && p == NULL)
982 	do_outofmem_msg(size);
983 
984 theend:
985 #ifdef MEM_PROFILE
986     mem_post_alloc((void **)&p, (size_t)size);
987 #endif
988     return p;
989 }
990 
991 /*
992  * lalloc() with an ID for alloc_fail().
993  */
994 #if defined(FEAT_SIGNS) || defined(PROTO)
995     char_u *
996 lalloc_id(long_u size, int message, alloc_id_T id UNUSED)
997 {
998 #ifdef FEAT_EVAL
999     if (alloc_fail_id == id && alloc_does_fail(size))
1000 	return NULL;
1001 #endif
1002     return (lalloc((long_u)size, message));
1003 }
1004 #endif
1005 
1006 #if defined(MEM_PROFILE) || defined(PROTO)
1007 /*
1008  * realloc() with memory profiling.
1009  */
1010     void *
1011 mem_realloc(void *ptr, size_t size)
1012 {
1013     void *p;
1014 
1015     mem_pre_free(&ptr);
1016     mem_pre_alloc_s(&size);
1017 
1018     p = realloc(ptr, size);
1019 
1020     mem_post_alloc(&p, size);
1021 
1022     return p;
1023 }
1024 #endif
1025 
1026 /*
1027 * Avoid repeating the error message many times (they take 1 second each).
1028 * Did_outofmem_msg is reset when a character is read.
1029 */
1030     void
1031 do_outofmem_msg(long_u size)
1032 {
1033     if (!did_outofmem_msg)
1034     {
1035 	/* Don't hide this message */
1036 	emsg_silent = 0;
1037 
1038 	/* Must come first to avoid coming back here when printing the error
1039 	 * message fails, e.g. when setting v:errmsg. */
1040 	did_outofmem_msg = TRUE;
1041 
1042 	semsg(_("E342: Out of memory!  (allocating %lu bytes)"), size);
1043     }
1044 }
1045 
1046 #if defined(EXITFREE) || defined(PROTO)
1047 
1048 /*
1049  * Free everything that we allocated.
1050  * Can be used to detect memory leaks, e.g., with ccmalloc.
1051  * NOTE: This is tricky!  Things are freed that functions depend on.  Don't be
1052  * surprised if Vim crashes...
1053  * Some things can't be freed, esp. things local to a library function.
1054  */
1055     void
1056 free_all_mem(void)
1057 {
1058     buf_T	*buf, *nextbuf;
1059 
1060     /* When we cause a crash here it is caught and Vim tries to exit cleanly.
1061      * Don't try freeing everything again. */
1062     if (entered_free_all_mem)
1063 	return;
1064     entered_free_all_mem = TRUE;
1065 
1066     /* Don't want to trigger autocommands from here on. */
1067     block_autocmds();
1068 
1069     /* Close all tabs and windows.  Reset 'equalalways' to avoid redraws. */
1070     p_ea = FALSE;
1071     if (first_tabpage != NULL && first_tabpage->tp_next != NULL)
1072 	do_cmdline_cmd((char_u *)"tabonly!");
1073     if (!ONE_WINDOW)
1074 	do_cmdline_cmd((char_u *)"only!");
1075 
1076 # if defined(FEAT_SPELL)
1077     /* Free all spell info. */
1078     spell_free_all();
1079 # endif
1080 
1081 #if defined(FEAT_INS_EXPAND) && defined(FEAT_BEVAL_TERM)
1082     ui_remove_balloon();
1083 # endif
1084 
1085     // Clear user commands (before deleting buffers).
1086     ex_comclear(NULL);
1087 
1088     // When exiting from mainerr_arg_missing curbuf has not been initialized,
1089     // and not much else.
1090     if (curbuf != NULL)
1091     {
1092 # ifdef FEAT_MENU
1093 	// Clear menus.
1094 	do_cmdline_cmd((char_u *)"aunmenu *");
1095 #  ifdef FEAT_MULTI_LANG
1096 	do_cmdline_cmd((char_u *)"menutranslate clear");
1097 #  endif
1098 # endif
1099 	// Clear mappings, abbreviations, breakpoints.
1100 	do_cmdline_cmd((char_u *)"lmapclear");
1101 	do_cmdline_cmd((char_u *)"xmapclear");
1102 	do_cmdline_cmd((char_u *)"mapclear");
1103 	do_cmdline_cmd((char_u *)"mapclear!");
1104 	do_cmdline_cmd((char_u *)"abclear");
1105 # if defined(FEAT_EVAL)
1106 	do_cmdline_cmd((char_u *)"breakdel *");
1107 # endif
1108 # if defined(FEAT_PROFILE)
1109 	do_cmdline_cmd((char_u *)"profdel *");
1110 # endif
1111 # if defined(FEAT_KEYMAP)
1112 	do_cmdline_cmd((char_u *)"set keymap=");
1113 #endif
1114     }
1115 
1116 # ifdef FEAT_TITLE
1117     free_titles();
1118 # endif
1119 # if defined(FEAT_SEARCHPATH)
1120     free_findfile();
1121 # endif
1122 
1123     /* Obviously named calls. */
1124     free_all_autocmds();
1125     clear_termcodes();
1126     free_all_marks();
1127     alist_clear(&global_alist);
1128     free_homedir();
1129 # if defined(FEAT_CMDL_COMPL)
1130     free_users();
1131 # endif
1132     free_search_patterns();
1133     free_old_sub();
1134     free_last_insert();
1135 # if defined(FEAT_INS_EXPAND)
1136     free_insexpand_stuff();
1137 # endif
1138     free_prev_shellcmd();
1139     free_regexp_stuff();
1140     free_tag_stuff();
1141     free_cd_dir();
1142 # ifdef FEAT_SIGNS
1143     free_signs();
1144 # endif
1145 # ifdef FEAT_EVAL
1146     set_expr_line(NULL);
1147 # endif
1148 # ifdef FEAT_DIFF
1149     if (curtab != NULL)
1150 	diff_clear(curtab);
1151 # endif
1152     clear_sb_text(TRUE);	      /* free any scrollback text */
1153 
1154     /* Free some global vars. */
1155     vim_free(username);
1156 # ifdef FEAT_CLIPBOARD
1157     vim_regfree(clip_exclude_prog);
1158 # endif
1159     vim_free(last_cmdline);
1160 # ifdef FEAT_CMDHIST
1161     vim_free(new_last_cmdline);
1162 # endif
1163     set_keep_msg(NULL, 0);
1164 
1165     /* Clear cmdline history. */
1166     p_hi = 0;
1167 # ifdef FEAT_CMDHIST
1168     init_history();
1169 # endif
1170 #ifdef FEAT_TEXT_PROP
1171     clear_global_prop_types();
1172 #endif
1173 
1174 #ifdef FEAT_QUICKFIX
1175     {
1176 	win_T	    *win;
1177 	tabpage_T   *tab;
1178 
1179 	qf_free_all(NULL);
1180 	// Free all location lists
1181 	FOR_ALL_TAB_WINDOWS(tab, win)
1182 	    qf_free_all(win);
1183     }
1184 #endif
1185 
1186     // Close all script inputs.
1187     close_all_scripts();
1188 
1189     if (curwin != NULL)
1190 	// Destroy all windows.  Must come before freeing buffers.
1191 	win_free_all();
1192 
1193     /* Free all option values.  Must come after closing windows. */
1194     free_all_options();
1195 
1196     /* Free all buffers.  Reset 'autochdir' to avoid accessing things that
1197      * were freed already. */
1198 #ifdef FEAT_AUTOCHDIR
1199     p_acd = FALSE;
1200 #endif
1201     for (buf = firstbuf; buf != NULL; )
1202     {
1203 	bufref_T    bufref;
1204 
1205 	set_bufref(&bufref, buf);
1206 	nextbuf = buf->b_next;
1207 	close_buffer(NULL, buf, DOBUF_WIPE, FALSE);
1208 	if (bufref_valid(&bufref))
1209 	    buf = nextbuf;	/* didn't work, try next one */
1210 	else
1211 	    buf = firstbuf;
1212     }
1213 
1214 # ifdef FEAT_ARABIC
1215     free_cmdline_buf();
1216 # endif
1217 
1218     /* Clear registers. */
1219     clear_registers();
1220     ResetRedobuff();
1221     ResetRedobuff();
1222 
1223 # if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
1224     vim_free(serverDelayedStartName);
1225 # endif
1226 
1227     /* highlight info */
1228     free_highlight();
1229 
1230     reset_last_sourcing();
1231 
1232     if (first_tabpage != NULL)
1233     {
1234 	free_tabpage(first_tabpage);
1235 	first_tabpage = NULL;
1236     }
1237 
1238 # ifdef UNIX
1239     /* Machine-specific free. */
1240     mch_free_mem();
1241 # endif
1242 
1243     /* message history */
1244     for (;;)
1245 	if (delete_first_msg() == FAIL)
1246 	    break;
1247 
1248 # ifdef FEAT_JOB_CHANNEL
1249     channel_free_all();
1250 # endif
1251 # ifdef FEAT_TIMERS
1252     timer_free_all();
1253 # endif
1254 # ifdef FEAT_EVAL
1255     /* must be after channel_free_all() with unrefs partials */
1256     eval_clear();
1257 # endif
1258 # ifdef FEAT_JOB_CHANNEL
1259     /* must be after eval_clear() with unrefs jobs */
1260     job_free_all();
1261 # endif
1262 
1263     free_termoptions();
1264 
1265     /* screenlines (can't display anything now!) */
1266     free_screenlines();
1267 
1268 # if defined(USE_XSMP)
1269     xsmp_close();
1270 # endif
1271 # ifdef FEAT_GUI_GTK
1272     gui_mch_free_all();
1273 # endif
1274     clear_hl_tables();
1275 
1276     vim_free(IObuff);
1277     vim_free(NameBuff);
1278 # ifdef FEAT_QUICKFIX
1279     check_quickfix_busy();
1280 # endif
1281 }
1282 #endif
1283 
1284 /*
1285  * Copy "string" into newly allocated memory.
1286  */
1287     char_u *
1288 vim_strsave(char_u *string)
1289 {
1290     char_u	*p;
1291     unsigned	len;
1292 
1293     len = (unsigned)STRLEN(string) + 1;
1294     p = alloc(len);
1295     if (p != NULL)
1296 	mch_memmove(p, string, (size_t)len);
1297     return p;
1298 }
1299 
1300 /*
1301  * Copy up to "len" bytes of "string" into newly allocated memory and
1302  * terminate with a NUL.
1303  * The allocated memory always has size "len + 1", also when "string" is
1304  * shorter.
1305  */
1306     char_u *
1307 vim_strnsave(char_u *string, int len)
1308 {
1309     char_u	*p;
1310 
1311     p = alloc((unsigned)(len + 1));
1312     if (p != NULL)
1313     {
1314 	STRNCPY(p, string, len);
1315 	p[len] = NUL;
1316     }
1317     return p;
1318 }
1319 
1320 /*
1321  * Copy "p[len]" into allocated memory, ignoring NUL characters.
1322  * Returns NULL when out of memory.
1323  */
1324     char_u *
1325 vim_memsave(char_u *p, int len)
1326 {
1327     char_u *ret = alloc((unsigned)len);
1328 
1329     if (ret != NULL)
1330 	mch_memmove(ret, p, (size_t)len);
1331     return ret;
1332 }
1333 
1334 /*
1335  * Same as vim_strsave(), but any characters found in esc_chars are preceded
1336  * by a backslash.
1337  */
1338     char_u *
1339 vim_strsave_escaped(char_u *string, char_u *esc_chars)
1340 {
1341     return vim_strsave_escaped_ext(string, esc_chars, '\\', FALSE);
1342 }
1343 
1344 /*
1345  * Same as vim_strsave_escaped(), but when "bsl" is TRUE also escape
1346  * characters where rem_backslash() would remove the backslash.
1347  * Escape the characters with "cc".
1348  */
1349     char_u *
1350 vim_strsave_escaped_ext(
1351     char_u	*string,
1352     char_u	*esc_chars,
1353     int		cc,
1354     int		bsl)
1355 {
1356     char_u	*p;
1357     char_u	*p2;
1358     char_u	*escaped_string;
1359     unsigned	length;
1360     int		l;
1361 
1362     /*
1363      * First count the number of backslashes required.
1364      * Then allocate the memory and insert them.
1365      */
1366     length = 1;				/* count the trailing NUL */
1367     for (p = string; *p; p++)
1368     {
1369 	if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1370 	{
1371 	    length += l;		/* count a multibyte char */
1372 	    p += l - 1;
1373 	    continue;
1374 	}
1375 	if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
1376 	    ++length;			/* count a backslash */
1377 	++length;			/* count an ordinary char */
1378     }
1379     escaped_string = alloc(length);
1380     if (escaped_string != NULL)
1381     {
1382 	p2 = escaped_string;
1383 	for (p = string; *p; p++)
1384 	{
1385 	    if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1386 	    {
1387 		mch_memmove(p2, p, (size_t)l);
1388 		p2 += l;
1389 		p += l - 1;		/* skip multibyte char  */
1390 		continue;
1391 	    }
1392 	    if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p)))
1393 		*p2++ = cc;
1394 	    *p2++ = *p;
1395 	}
1396 	*p2 = NUL;
1397     }
1398     return escaped_string;
1399 }
1400 
1401 /*
1402  * Return TRUE when 'shell' has "csh" in the tail.
1403  */
1404     int
1405 csh_like_shell(void)
1406 {
1407     return (strstr((char *)gettail(p_sh), "csh") != NULL);
1408 }
1409 
1410 /*
1411  * Escape "string" for use as a shell argument with system().
1412  * This uses single quotes, except when we know we need to use double quotes
1413  * (MS-DOS and MS-Windows without 'shellslash' set).
1414  * Escape a newline, depending on the 'shell' option.
1415  * When "do_special" is TRUE also replace "!", "%", "#" and things starting
1416  * with "<" like "<cfile>".
1417  * When "do_newline" is FALSE do not escape newline unless it is csh shell.
1418  * Returns the result in allocated memory, NULL if we have run out.
1419  */
1420     char_u *
1421 vim_strsave_shellescape(char_u *string, int do_special, int do_newline)
1422 {
1423     unsigned	length;
1424     char_u	*p;
1425     char_u	*d;
1426     char_u	*escaped_string;
1427     int		l;
1428     int		csh_like;
1429 
1430     /* Only csh and similar shells expand '!' within single quotes.  For sh and
1431      * the like we must not put a backslash before it, it will be taken
1432      * literally.  If do_special is set the '!' will be escaped twice.
1433      * Csh also needs to have "\n" escaped twice when do_special is set. */
1434     csh_like = csh_like_shell();
1435 
1436     /* First count the number of extra bytes required. */
1437     length = (unsigned)STRLEN(string) + 3;  /* two quotes and a trailing NUL */
1438     for (p = string; *p != NUL; MB_PTR_ADV(p))
1439     {
1440 # ifdef MSWIN
1441 	if (!p_ssl)
1442 	{
1443 	    if (*p == '"')
1444 		++length;		/* " -> "" */
1445 	}
1446 	else
1447 # endif
1448 	if (*p == '\'')
1449 	    length += 3;		/* ' => '\'' */
1450 	if ((*p == '\n' && (csh_like || do_newline))
1451 		|| (*p == '!' && (csh_like || do_special)))
1452 	{
1453 	    ++length;			/* insert backslash */
1454 	    if (csh_like && do_special)
1455 		++length;		/* insert backslash */
1456 	}
1457 	if (do_special && find_cmdline_var(p, &l) >= 0)
1458 	{
1459 	    ++length;			/* insert backslash */
1460 	    p += l - 1;
1461 	}
1462     }
1463 
1464     /* Allocate memory for the result and fill it. */
1465     escaped_string = alloc(length);
1466     if (escaped_string != NULL)
1467     {
1468 	d = escaped_string;
1469 
1470 	/* add opening quote */
1471 # ifdef MSWIN
1472 	if (!p_ssl)
1473 	    *d++ = '"';
1474 	else
1475 # endif
1476 	    *d++ = '\'';
1477 
1478 	for (p = string; *p != NUL; )
1479 	{
1480 # ifdef MSWIN
1481 	    if (!p_ssl)
1482 	    {
1483 		if (*p == '"')
1484 		{
1485 		    *d++ = '"';
1486 		    *d++ = '"';
1487 		    ++p;
1488 		    continue;
1489 		}
1490 	    }
1491 	    else
1492 # endif
1493 	    if (*p == '\'')
1494 	    {
1495 		*d++ = '\'';
1496 		*d++ = '\\';
1497 		*d++ = '\'';
1498 		*d++ = '\'';
1499 		++p;
1500 		continue;
1501 	    }
1502 	    if ((*p == '\n' && (csh_like || do_newline))
1503 		    || (*p == '!' && (csh_like || do_special)))
1504 	    {
1505 		*d++ = '\\';
1506 		if (csh_like && do_special)
1507 		    *d++ = '\\';
1508 		*d++ = *p++;
1509 		continue;
1510 	    }
1511 	    if (do_special && find_cmdline_var(p, &l) >= 0)
1512 	    {
1513 		*d++ = '\\';		/* insert backslash */
1514 		while (--l >= 0)	/* copy the var */
1515 		    *d++ = *p++;
1516 		continue;
1517 	    }
1518 
1519 	    MB_COPY_CHAR(p, d);
1520 	}
1521 
1522 	/* add terminating quote and finish with a NUL */
1523 # ifdef MSWIN
1524 	if (!p_ssl)
1525 	    *d++ = '"';
1526 	else
1527 # endif
1528 	    *d++ = '\'';
1529 	*d = NUL;
1530     }
1531 
1532     return escaped_string;
1533 }
1534 
1535 /*
1536  * Like vim_strsave(), but make all characters uppercase.
1537  * This uses ASCII lower-to-upper case translation, language independent.
1538  */
1539     char_u *
1540 vim_strsave_up(char_u *string)
1541 {
1542     char_u *p1;
1543 
1544     p1 = vim_strsave(string);
1545     vim_strup(p1);
1546     return p1;
1547 }
1548 
1549 /*
1550  * Like vim_strnsave(), but make all characters uppercase.
1551  * This uses ASCII lower-to-upper case translation, language independent.
1552  */
1553     char_u *
1554 vim_strnsave_up(char_u *string, int len)
1555 {
1556     char_u *p1;
1557 
1558     p1 = vim_strnsave(string, len);
1559     vim_strup(p1);
1560     return p1;
1561 }
1562 
1563 /*
1564  * ASCII lower-to-upper case translation, language independent.
1565  */
1566     void
1567 vim_strup(
1568     char_u	*p)
1569 {
1570     char_u  *p2;
1571     int	    c;
1572 
1573     if (p != NULL)
1574     {
1575 	p2 = p;
1576 	while ((c = *p2) != NUL)
1577 #ifdef EBCDIC
1578 	    *p2++ = isalpha(c) ? toupper(c) : c;
1579 #else
1580 	    *p2++ = (c < 'a' || c > 'z') ? c : (c - 0x20);
1581 #endif
1582     }
1583 }
1584 
1585 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
1586 /*
1587  * Make string "s" all upper-case and return it in allocated memory.
1588  * Handles multi-byte characters as well as possible.
1589  * Returns NULL when out of memory.
1590  */
1591     char_u *
1592 strup_save(char_u *orig)
1593 {
1594     char_u	*p;
1595     char_u	*res;
1596 
1597     res = p = vim_strsave(orig);
1598 
1599     if (res != NULL)
1600 	while (*p != NUL)
1601 	{
1602 	    int		l;
1603 
1604 	    if (enc_utf8)
1605 	    {
1606 		int	c, uc;
1607 		int	newl;
1608 		char_u	*s;
1609 
1610 		c = utf_ptr2char(p);
1611 		l = utf_ptr2len(p);
1612 		if (c == 0)
1613 		{
1614 		    /* overlong sequence, use only the first byte */
1615 		    c = *p;
1616 		    l = 1;
1617 		}
1618 		uc = utf_toupper(c);
1619 
1620 		/* Reallocate string when byte count changes.  This is rare,
1621 		 * thus it's OK to do another malloc()/free(). */
1622 		newl = utf_char2len(uc);
1623 		if (newl != l)
1624 		{
1625 		    s = alloc((unsigned)STRLEN(res) + 1 + newl - l);
1626 		    if (s == NULL)
1627 		    {
1628 			vim_free(res);
1629 			return NULL;
1630 		    }
1631 		    mch_memmove(s, res, p - res);
1632 		    STRCPY(s + (p - res) + newl, p + l);
1633 		    p = s + (p - res);
1634 		    vim_free(res);
1635 		    res = s;
1636 		}
1637 
1638 		utf_char2bytes(uc, p);
1639 		p += newl;
1640 	    }
1641 	    else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1642 		p += l;		/* skip multi-byte character */
1643 	    else
1644 	    {
1645 		*p = TOUPPER_LOC(*p); /* note that toupper() can be a macro */
1646 		p++;
1647 	    }
1648 	}
1649 
1650     return res;
1651 }
1652 
1653 /*
1654  * Make string "s" all lower-case and return it in allocated memory.
1655  * Handles multi-byte characters as well as possible.
1656  * Returns NULL when out of memory.
1657  */
1658     char_u *
1659 strlow_save(char_u *orig)
1660 {
1661     char_u	*p;
1662     char_u	*res;
1663 
1664     res = p = vim_strsave(orig);
1665 
1666     if (res != NULL)
1667 	while (*p != NUL)
1668 	{
1669 	    int		l;
1670 
1671 	    if (enc_utf8)
1672 	    {
1673 		int	c, lc;
1674 		int	newl;
1675 		char_u	*s;
1676 
1677 		c = utf_ptr2char(p);
1678 		l = utf_ptr2len(p);
1679 		if (c == 0)
1680 		{
1681 		    /* overlong sequence, use only the first byte */
1682 		    c = *p;
1683 		    l = 1;
1684 		}
1685 		lc = utf_tolower(c);
1686 
1687 		/* Reallocate string when byte count changes.  This is rare,
1688 		 * thus it's OK to do another malloc()/free(). */
1689 		newl = utf_char2len(lc);
1690 		if (newl != l)
1691 		{
1692 		    s = alloc((unsigned)STRLEN(res) + 1 + newl - l);
1693 		    if (s == NULL)
1694 		    {
1695 			vim_free(res);
1696 			return NULL;
1697 		    }
1698 		    mch_memmove(s, res, p - res);
1699 		    STRCPY(s + (p - res) + newl, p + l);
1700 		    p = s + (p - res);
1701 		    vim_free(res);
1702 		    res = s;
1703 		}
1704 
1705 		utf_char2bytes(lc, p);
1706 		p += newl;
1707 	    }
1708 	    else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1709 		p += l;		/* skip multi-byte character */
1710 	    else
1711 	    {
1712 		*p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
1713 		p++;
1714 	    }
1715 	}
1716 
1717     return res;
1718 }
1719 #endif
1720 
1721 /*
1722  * delete spaces at the end of a string
1723  */
1724     void
1725 del_trailing_spaces(char_u *ptr)
1726 {
1727     char_u	*q;
1728 
1729     q = ptr + STRLEN(ptr);
1730     while (--q > ptr && VIM_ISWHITE(q[0]) && q[-1] != '\\' && q[-1] != Ctrl_V)
1731 	*q = NUL;
1732 }
1733 
1734 /*
1735  * Like strncpy(), but always terminate the result with one NUL.
1736  * "to" must be "len + 1" long!
1737  */
1738     void
1739 vim_strncpy(char_u *to, char_u *from, size_t len)
1740 {
1741     STRNCPY(to, from, len);
1742     to[len] = NUL;
1743 }
1744 
1745 /*
1746  * Like strcat(), but make sure the result fits in "tosize" bytes and is
1747  * always NUL terminated. "from" and "to" may overlap.
1748  */
1749     void
1750 vim_strcat(char_u *to, char_u *from, size_t tosize)
1751 {
1752     size_t tolen = STRLEN(to);
1753     size_t fromlen = STRLEN(from);
1754 
1755     if (tolen + fromlen + 1 > tosize)
1756     {
1757 	mch_memmove(to + tolen, from, tosize - tolen - 1);
1758 	to[tosize - 1] = NUL;
1759     }
1760     else
1761 	mch_memmove(to + tolen, from, fromlen + 1);
1762 }
1763 
1764 /*
1765  * Isolate one part of a string option where parts are separated with
1766  * "sep_chars".
1767  * The part is copied into "buf[maxlen]".
1768  * "*option" is advanced to the next part.
1769  * The length is returned.
1770  */
1771     int
1772 copy_option_part(
1773     char_u	**option,
1774     char_u	*buf,
1775     int		maxlen,
1776     char	*sep_chars)
1777 {
1778     int	    len = 0;
1779     char_u  *p = *option;
1780 
1781     /* skip '.' at start of option part, for 'suffixes' */
1782     if (*p == '.')
1783 	buf[len++] = *p++;
1784     while (*p != NUL && vim_strchr((char_u *)sep_chars, *p) == NULL)
1785     {
1786 	/*
1787 	 * Skip backslash before a separator character and space.
1788 	 */
1789 	if (p[0] == '\\' && vim_strchr((char_u *)sep_chars, p[1]) != NULL)
1790 	    ++p;
1791 	if (len < maxlen - 1)
1792 	    buf[len++] = *p;
1793 	++p;
1794     }
1795     buf[len] = NUL;
1796 
1797     if (*p != NUL && *p != ',')	/* skip non-standard separator */
1798 	++p;
1799     p = skip_to_option_part(p);	/* p points to next file name */
1800 
1801     *option = p;
1802     return len;
1803 }
1804 
1805 /*
1806  * Replacement for free() that ignores NULL pointers.
1807  * Also skip free() when exiting for sure, this helps when we caught a deadly
1808  * signal that was caused by a crash in free().
1809  * If you want to set NULL after calling this function, you should use
1810  * VIM_CLEAR() instead.
1811  */
1812     void
1813 vim_free(void *x)
1814 {
1815     if (x != NULL && !really_exiting)
1816     {
1817 #ifdef MEM_PROFILE
1818 	mem_pre_free(&x);
1819 #endif
1820 	free(x);
1821     }
1822 }
1823 
1824 #ifndef HAVE_MEMSET
1825     void *
1826 vim_memset(void *ptr, int c, size_t size)
1827 {
1828     char *p = ptr;
1829 
1830     while (size-- > 0)
1831 	*p++ = c;
1832     return ptr;
1833 }
1834 #endif
1835 
1836 #if (!defined(HAVE_STRCASECMP) && !defined(HAVE_STRICMP)) || defined(PROTO)
1837 /*
1838  * Compare two strings, ignoring case, using current locale.
1839  * Doesn't work for multi-byte characters.
1840  * return 0 for match, < 0 for smaller, > 0 for bigger
1841  */
1842     int
1843 vim_stricmp(char *s1, char *s2)
1844 {
1845     int		i;
1846 
1847     for (;;)
1848     {
1849 	i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
1850 	if (i != 0)
1851 	    return i;			    /* this character different */
1852 	if (*s1 == NUL)
1853 	    break;			    /* strings match until NUL */
1854 	++s1;
1855 	++s2;
1856     }
1857     return 0;				    /* strings match */
1858 }
1859 #endif
1860 
1861 #if (!defined(HAVE_STRNCASECMP) && !defined(HAVE_STRNICMP)) || defined(PROTO)
1862 /*
1863  * Compare two strings, for length "len", ignoring case, using current locale.
1864  * Doesn't work for multi-byte characters.
1865  * return 0 for match, < 0 for smaller, > 0 for bigger
1866  */
1867     int
1868 vim_strnicmp(char *s1, char *s2, size_t len)
1869 {
1870     int		i;
1871 
1872     while (len > 0)
1873     {
1874 	i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2);
1875 	if (i != 0)
1876 	    return i;			    /* this character different */
1877 	if (*s1 == NUL)
1878 	    break;			    /* strings match until NUL */
1879 	++s1;
1880 	++s2;
1881 	--len;
1882     }
1883     return 0;				    /* strings match */
1884 }
1885 #endif
1886 
1887 /*
1888  * Version of strchr() and strrchr() that handle unsigned char strings
1889  * with characters from 128 to 255 correctly.  It also doesn't return a
1890  * pointer to the NUL at the end of the string.
1891  */
1892     char_u  *
1893 vim_strchr(char_u *string, int c)
1894 {
1895     char_u	*p;
1896     int		b;
1897 
1898     p = string;
1899     if (enc_utf8 && c >= 0x80)
1900     {
1901 	while (*p != NUL)
1902 	{
1903 	    int l = utfc_ptr2len(p);
1904 
1905 	    /* Avoid matching an illegal byte here. */
1906 	    if (utf_ptr2char(p) == c && l > 1)
1907 		return p;
1908 	    p += l;
1909 	}
1910 	return NULL;
1911     }
1912     if (enc_dbcs != 0 && c > 255)
1913     {
1914 	int	n2 = c & 0xff;
1915 
1916 	c = ((unsigned)c >> 8) & 0xff;
1917 	while ((b = *p) != NUL)
1918 	{
1919 	    if (b == c && p[1] == n2)
1920 		return p;
1921 	    p += (*mb_ptr2len)(p);
1922 	}
1923 	return NULL;
1924     }
1925     if (has_mbyte)
1926     {
1927 	while ((b = *p) != NUL)
1928 	{
1929 	    if (b == c)
1930 		return p;
1931 	    p += (*mb_ptr2len)(p);
1932 	}
1933 	return NULL;
1934     }
1935     while ((b = *p) != NUL)
1936     {
1937 	if (b == c)
1938 	    return p;
1939 	++p;
1940     }
1941     return NULL;
1942 }
1943 
1944 /*
1945  * Version of strchr() that only works for bytes and handles unsigned char
1946  * strings with characters above 128 correctly. It also doesn't return a
1947  * pointer to the NUL at the end of the string.
1948  */
1949     char_u  *
1950 vim_strbyte(char_u *string, int c)
1951 {
1952     char_u	*p = string;
1953 
1954     while (*p != NUL)
1955     {
1956 	if (*p == c)
1957 	    return p;
1958 	++p;
1959     }
1960     return NULL;
1961 }
1962 
1963 /*
1964  * Search for last occurrence of "c" in "string".
1965  * Return NULL if not found.
1966  * Does not handle multi-byte char for "c"!
1967  */
1968     char_u  *
1969 vim_strrchr(char_u *string, int c)
1970 {
1971     char_u	*retval = NULL;
1972     char_u	*p = string;
1973 
1974     while (*p)
1975     {
1976 	if (*p == c)
1977 	    retval = p;
1978 	MB_PTR_ADV(p);
1979     }
1980     return retval;
1981 }
1982 
1983 /*
1984  * Vim's version of strpbrk(), in case it's missing.
1985  * Don't generate a prototype for this, causes problems when it's not used.
1986  */
1987 #ifndef PROTO
1988 # ifndef HAVE_STRPBRK
1989 #  ifdef vim_strpbrk
1990 #   undef vim_strpbrk
1991 #  endif
1992     char_u *
1993 vim_strpbrk(char_u *s, char_u *charset)
1994 {
1995     while (*s)
1996     {
1997 	if (vim_strchr(charset, *s) != NULL)
1998 	    return s;
1999 	MB_PTR_ADV(s);
2000     }
2001     return NULL;
2002 }
2003 # endif
2004 #endif
2005 
2006 /*
2007  * Vim has its own isspace() function, because on some machines isspace()
2008  * can't handle characters above 128.
2009  */
2010     int
2011 vim_isspace(int x)
2012 {
2013     return ((x >= 9 && x <= 13) || x == ' ');
2014 }
2015 
2016 /************************************************************************
2017  * Functions for handling growing arrays.
2018  */
2019 
2020 /*
2021  * Clear an allocated growing array.
2022  */
2023     void
2024 ga_clear(garray_T *gap)
2025 {
2026     vim_free(gap->ga_data);
2027     ga_init(gap);
2028 }
2029 
2030 /*
2031  * Clear a growing array that contains a list of strings.
2032  */
2033     void
2034 ga_clear_strings(garray_T *gap)
2035 {
2036     int		i;
2037 
2038     for (i = 0; i < gap->ga_len; ++i)
2039 	vim_free(((char_u **)(gap->ga_data))[i]);
2040     ga_clear(gap);
2041 }
2042 
2043 /*
2044  * Initialize a growing array.	Don't forget to set ga_itemsize and
2045  * ga_growsize!  Or use ga_init2().
2046  */
2047     void
2048 ga_init(garray_T *gap)
2049 {
2050     gap->ga_data = NULL;
2051     gap->ga_maxlen = 0;
2052     gap->ga_len = 0;
2053 }
2054 
2055     void
2056 ga_init2(garray_T *gap, int itemsize, int growsize)
2057 {
2058     ga_init(gap);
2059     gap->ga_itemsize = itemsize;
2060     gap->ga_growsize = growsize;
2061 }
2062 
2063 /*
2064  * Make room in growing array "gap" for at least "n" items.
2065  * Return FAIL for failure, OK otherwise.
2066  */
2067     int
2068 ga_grow(garray_T *gap, int n)
2069 {
2070     size_t	old_len;
2071     size_t	new_len;
2072     char_u	*pp;
2073 
2074     if (gap->ga_maxlen - gap->ga_len < n)
2075     {
2076 	if (n < gap->ga_growsize)
2077 	    n = gap->ga_growsize;
2078 	new_len = gap->ga_itemsize * (gap->ga_len + n);
2079 	pp = (gap->ga_data == NULL)
2080 	      ? alloc((unsigned)new_len) : vim_realloc(gap->ga_data, new_len);
2081 	if (pp == NULL)
2082 	    return FAIL;
2083 	old_len = gap->ga_itemsize * gap->ga_maxlen;
2084 	vim_memset(pp + old_len, 0, new_len - old_len);
2085 	gap->ga_maxlen = gap->ga_len + n;
2086 	gap->ga_data = pp;
2087     }
2088     return OK;
2089 }
2090 
2091 #if defined(FEAT_EVAL) || defined(FEAT_SEARCHPATH) || defined(PROTO)
2092 /*
2093  * For a growing array that contains a list of strings: concatenate all the
2094  * strings with a separating "sep".
2095  * Returns NULL when out of memory.
2096  */
2097     char_u *
2098 ga_concat_strings(garray_T *gap, char *sep)
2099 {
2100     int		i;
2101     int		len = 0;
2102     int		sep_len = (int)STRLEN(sep);
2103     char_u	*s;
2104     char_u	*p;
2105 
2106     for (i = 0; i < gap->ga_len; ++i)
2107 	len += (int)STRLEN(((char_u **)(gap->ga_data))[i]) + sep_len;
2108 
2109     s = alloc(len + 1);
2110     if (s != NULL)
2111     {
2112 	*s = NUL;
2113 	p = s;
2114 	for (i = 0; i < gap->ga_len; ++i)
2115 	{
2116 	    if (p != s)
2117 	    {
2118 		STRCPY(p, sep);
2119 		p += sep_len;
2120 	    }
2121 	    STRCPY(p, ((char_u **)(gap->ga_data))[i]);
2122 	    p += STRLEN(p);
2123 	}
2124     }
2125     return s;
2126 }
2127 #endif
2128 
2129 #if defined(FEAT_VIMINFO) || defined(FEAT_EVAL) || defined(PROTO)
2130 /*
2131  * Make a copy of string "p" and add it to "gap".
2132  * When out of memory nothing changes.
2133  */
2134     void
2135 ga_add_string(garray_T *gap, char_u *p)
2136 {
2137     char_u *cp = vim_strsave(p);
2138 
2139     if (cp != NULL)
2140     {
2141 	if (ga_grow(gap, 1) == OK)
2142 	    ((char_u **)(gap->ga_data))[gap->ga_len++] = cp;
2143 	else
2144 	    vim_free(cp);
2145     }
2146 }
2147 #endif
2148 
2149 /*
2150  * Concatenate a string to a growarray which contains bytes.
2151  * When "s" is NULL does not do anything.
2152  * Note: Does NOT copy the NUL at the end!
2153  */
2154     void
2155 ga_concat(garray_T *gap, char_u *s)
2156 {
2157     int    len;
2158 
2159     if (s == NULL || *s == NUL)
2160 	return;
2161     len = (int)STRLEN(s);
2162     if (ga_grow(gap, len) == OK)
2163     {
2164 	mch_memmove((char *)gap->ga_data + gap->ga_len, s, (size_t)len);
2165 	gap->ga_len += len;
2166     }
2167 }
2168 
2169 /*
2170  * Append one byte to a growarray which contains bytes.
2171  */
2172     void
2173 ga_append(garray_T *gap, int c)
2174 {
2175     if (ga_grow(gap, 1) == OK)
2176     {
2177 	*((char *)gap->ga_data + gap->ga_len) = c;
2178 	++gap->ga_len;
2179     }
2180 }
2181 
2182 #if (defined(UNIX) && !defined(USE_SYSTEM)) || defined(MSWIN) \
2183 	|| defined(PROTO)
2184 /*
2185  * Append the text in "gap" below the cursor line and clear "gap".
2186  */
2187     void
2188 append_ga_line(garray_T *gap)
2189 {
2190     /* Remove trailing CR. */
2191     if (gap->ga_len > 0
2192 	    && !curbuf->b_p_bin
2193 	    && ((char_u *)gap->ga_data)[gap->ga_len - 1] == CAR)
2194 	--gap->ga_len;
2195     ga_append(gap, NUL);
2196     ml_append(curwin->w_cursor.lnum++, gap->ga_data, 0, FALSE);
2197     gap->ga_len = 0;
2198 }
2199 #endif
2200 
2201 /************************************************************************
2202  * functions that use lookup tables for various things, generally to do with
2203  * special key codes.
2204  */
2205 
2206 /*
2207  * Some useful tables.
2208  */
2209 
2210 static struct modmasktable
2211 {
2212     short	mod_mask;	/* Bit-mask for particular key modifier */
2213     short	mod_flag;	/* Bit(s) for particular key modifier */
2214     char_u	name;		/* Single letter name of modifier */
2215 } mod_mask_table[] =
2216 {
2217     {MOD_MASK_ALT,		MOD_MASK_ALT,		(char_u)'M'},
2218     {MOD_MASK_META,		MOD_MASK_META,		(char_u)'T'},
2219     {MOD_MASK_CTRL,		MOD_MASK_CTRL,		(char_u)'C'},
2220     {MOD_MASK_SHIFT,		MOD_MASK_SHIFT,		(char_u)'S'},
2221     {MOD_MASK_MULTI_CLICK,	MOD_MASK_2CLICK,	(char_u)'2'},
2222     {MOD_MASK_MULTI_CLICK,	MOD_MASK_3CLICK,	(char_u)'3'},
2223     {MOD_MASK_MULTI_CLICK,	MOD_MASK_4CLICK,	(char_u)'4'},
2224 #ifdef MACOS_X
2225     {MOD_MASK_CMD,		MOD_MASK_CMD,		(char_u)'D'},
2226 #endif
2227     /* 'A' must be the last one */
2228     {MOD_MASK_ALT,		MOD_MASK_ALT,		(char_u)'A'},
2229     {0, 0, NUL}
2230     /* NOTE: when adding an entry, update MAX_KEY_NAME_LEN! */
2231 };
2232 
2233 /*
2234  * Shifted key terminal codes and their unshifted equivalent.
2235  * Don't add mouse codes here, they are handled separately!
2236  */
2237 #define MOD_KEYS_ENTRY_SIZE 5
2238 
2239 static char_u modifier_keys_table[] =
2240 {
2241 /*  mod mask	    with modifier		without modifier */
2242     MOD_MASK_SHIFT, '&', '9',			'@', '1',	/* begin */
2243     MOD_MASK_SHIFT, '&', '0',			'@', '2',	/* cancel */
2244     MOD_MASK_SHIFT, '*', '1',			'@', '4',	/* command */
2245     MOD_MASK_SHIFT, '*', '2',			'@', '5',	/* copy */
2246     MOD_MASK_SHIFT, '*', '3',			'@', '6',	/* create */
2247     MOD_MASK_SHIFT, '*', '4',			'k', 'D',	/* delete char */
2248     MOD_MASK_SHIFT, '*', '5',			'k', 'L',	/* delete line */
2249     MOD_MASK_SHIFT, '*', '7',			'@', '7',	/* end */
2250     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_END,	'@', '7',	/* end */
2251     MOD_MASK_SHIFT, '*', '9',			'@', '9',	/* exit */
2252     MOD_MASK_SHIFT, '*', '0',			'@', '0',	/* find */
2253     MOD_MASK_SHIFT, '#', '1',			'%', '1',	/* help */
2254     MOD_MASK_SHIFT, '#', '2',			'k', 'h',	/* home */
2255     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_HOME,	'k', 'h',	/* home */
2256     MOD_MASK_SHIFT, '#', '3',			'k', 'I',	/* insert */
2257     MOD_MASK_SHIFT, '#', '4',			'k', 'l',	/* left arrow */
2258     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_LEFT,	'k', 'l',	/* left arrow */
2259     MOD_MASK_SHIFT, '%', 'a',			'%', '3',	/* message */
2260     MOD_MASK_SHIFT, '%', 'b',			'%', '4',	/* move */
2261     MOD_MASK_SHIFT, '%', 'c',			'%', '5',	/* next */
2262     MOD_MASK_SHIFT, '%', 'd',			'%', '7',	/* options */
2263     MOD_MASK_SHIFT, '%', 'e',			'%', '8',	/* previous */
2264     MOD_MASK_SHIFT, '%', 'f',			'%', '9',	/* print */
2265     MOD_MASK_SHIFT, '%', 'g',			'%', '0',	/* redo */
2266     MOD_MASK_SHIFT, '%', 'h',			'&', '3',	/* replace */
2267     MOD_MASK_SHIFT, '%', 'i',			'k', 'r',	/* right arr. */
2268     MOD_MASK_CTRL,  KS_EXTRA, (int)KE_C_RIGHT,	'k', 'r',	/* right arr. */
2269     MOD_MASK_SHIFT, '%', 'j',			'&', '5',	/* resume */
2270     MOD_MASK_SHIFT, '!', '1',			'&', '6',	/* save */
2271     MOD_MASK_SHIFT, '!', '2',			'&', '7',	/* suspend */
2272     MOD_MASK_SHIFT, '!', '3',			'&', '8',	/* undo */
2273     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_UP,	'k', 'u',	/* up arrow */
2274     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_DOWN,	'k', 'd',	/* down arrow */
2275 
2276 								/* vt100 F1 */
2277     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF1,	KS_EXTRA, (int)KE_XF1,
2278     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF2,	KS_EXTRA, (int)KE_XF2,
2279     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF3,	KS_EXTRA, (int)KE_XF3,
2280     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF4,	KS_EXTRA, (int)KE_XF4,
2281 
2282     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F1,	'k', '1',	/* F1 */
2283     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F2,	'k', '2',
2284     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F3,	'k', '3',
2285     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F4,	'k', '4',
2286     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F5,	'k', '5',
2287     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F6,	'k', '6',
2288     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F7,	'k', '7',
2289     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F8,	'k', '8',
2290     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F9,	'k', '9',
2291     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F10,	'k', ';',	/* F10 */
2292 
2293     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F11,	'F', '1',
2294     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F12,	'F', '2',
2295     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F13,	'F', '3',
2296     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F14,	'F', '4',
2297     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F15,	'F', '5',
2298     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F16,	'F', '6',
2299     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F17,	'F', '7',
2300     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F18,	'F', '8',
2301     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F19,	'F', '9',
2302     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F20,	'F', 'A',
2303 
2304     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F21,	'F', 'B',
2305     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F22,	'F', 'C',
2306     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F23,	'F', 'D',
2307     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F24,	'F', 'E',
2308     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F25,	'F', 'F',
2309     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F26,	'F', 'G',
2310     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F27,	'F', 'H',
2311     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F28,	'F', 'I',
2312     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F29,	'F', 'J',
2313     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F30,	'F', 'K',
2314 
2315     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F31,	'F', 'L',
2316     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F32,	'F', 'M',
2317     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F33,	'F', 'N',
2318     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F34,	'F', 'O',
2319     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F35,	'F', 'P',
2320     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F36,	'F', 'Q',
2321     MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F37,	'F', 'R',
2322 
2323 							    /* TAB pseudo code*/
2324     MOD_MASK_SHIFT, 'k', 'B',			KS_EXTRA, (int)KE_TAB,
2325 
2326     NUL
2327 };
2328 
2329 static struct key_name_entry
2330 {
2331     int	    key;	/* Special key code or ascii value */
2332     char_u  *name;	/* Name of key */
2333 } key_names_table[] =
2334 {
2335     {' ',		(char_u *)"Space"},
2336     {TAB,		(char_u *)"Tab"},
2337     {K_TAB,		(char_u *)"Tab"},
2338     {NL,		(char_u *)"NL"},
2339     {NL,		(char_u *)"NewLine"},	/* Alternative name */
2340     {NL,		(char_u *)"LineFeed"},	/* Alternative name */
2341     {NL,		(char_u *)"LF"},	/* Alternative name */
2342     {CAR,		(char_u *)"CR"},
2343     {CAR,		(char_u *)"Return"},	/* Alternative name */
2344     {CAR,		(char_u *)"Enter"},	/* Alternative name */
2345     {K_BS,		(char_u *)"BS"},
2346     {K_BS,		(char_u *)"BackSpace"},	/* Alternative name */
2347     {ESC,		(char_u *)"Esc"},
2348     {CSI,		(char_u *)"CSI"},
2349     {K_CSI,		(char_u *)"xCSI"},
2350     {'|',		(char_u *)"Bar"},
2351     {'\\',		(char_u *)"Bslash"},
2352     {K_DEL,		(char_u *)"Del"},
2353     {K_DEL,		(char_u *)"Delete"},	/* Alternative name */
2354     {K_KDEL,		(char_u *)"kDel"},
2355     {K_UP,		(char_u *)"Up"},
2356     {K_DOWN,		(char_u *)"Down"},
2357     {K_LEFT,		(char_u *)"Left"},
2358     {K_RIGHT,		(char_u *)"Right"},
2359     {K_XUP,		(char_u *)"xUp"},
2360     {K_XDOWN,		(char_u *)"xDown"},
2361     {K_XLEFT,		(char_u *)"xLeft"},
2362     {K_XRIGHT,		(char_u *)"xRight"},
2363     {K_PS,		(char_u *)"PasteStart"},
2364     {K_PE,		(char_u *)"PasteEnd"},
2365 
2366     {K_F1,		(char_u *)"F1"},
2367     {K_F2,		(char_u *)"F2"},
2368     {K_F3,		(char_u *)"F3"},
2369     {K_F4,		(char_u *)"F4"},
2370     {K_F5,		(char_u *)"F5"},
2371     {K_F6,		(char_u *)"F6"},
2372     {K_F7,		(char_u *)"F7"},
2373     {K_F8,		(char_u *)"F8"},
2374     {K_F9,		(char_u *)"F9"},
2375     {K_F10,		(char_u *)"F10"},
2376 
2377     {K_F11,		(char_u *)"F11"},
2378     {K_F12,		(char_u *)"F12"},
2379     {K_F13,		(char_u *)"F13"},
2380     {K_F14,		(char_u *)"F14"},
2381     {K_F15,		(char_u *)"F15"},
2382     {K_F16,		(char_u *)"F16"},
2383     {K_F17,		(char_u *)"F17"},
2384     {K_F18,		(char_u *)"F18"},
2385     {K_F19,		(char_u *)"F19"},
2386     {K_F20,		(char_u *)"F20"},
2387 
2388     {K_F21,		(char_u *)"F21"},
2389     {K_F22,		(char_u *)"F22"},
2390     {K_F23,		(char_u *)"F23"},
2391     {K_F24,		(char_u *)"F24"},
2392     {K_F25,		(char_u *)"F25"},
2393     {K_F26,		(char_u *)"F26"},
2394     {K_F27,		(char_u *)"F27"},
2395     {K_F28,		(char_u *)"F28"},
2396     {K_F29,		(char_u *)"F29"},
2397     {K_F30,		(char_u *)"F30"},
2398 
2399     {K_F31,		(char_u *)"F31"},
2400     {K_F32,		(char_u *)"F32"},
2401     {K_F33,		(char_u *)"F33"},
2402     {K_F34,		(char_u *)"F34"},
2403     {K_F35,		(char_u *)"F35"},
2404     {K_F36,		(char_u *)"F36"},
2405     {K_F37,		(char_u *)"F37"},
2406 
2407     {K_XF1,		(char_u *)"xF1"},
2408     {K_XF2,		(char_u *)"xF2"},
2409     {K_XF3,		(char_u *)"xF3"},
2410     {K_XF4,		(char_u *)"xF4"},
2411 
2412     {K_HELP,		(char_u *)"Help"},
2413     {K_UNDO,		(char_u *)"Undo"},
2414     {K_INS,		(char_u *)"Insert"},
2415     {K_INS,		(char_u *)"Ins"},	/* Alternative name */
2416     {K_KINS,		(char_u *)"kInsert"},
2417     {K_HOME,		(char_u *)"Home"},
2418     {K_KHOME,		(char_u *)"kHome"},
2419     {K_XHOME,		(char_u *)"xHome"},
2420     {K_ZHOME,		(char_u *)"zHome"},
2421     {K_END,		(char_u *)"End"},
2422     {K_KEND,		(char_u *)"kEnd"},
2423     {K_XEND,		(char_u *)"xEnd"},
2424     {K_ZEND,		(char_u *)"zEnd"},
2425     {K_PAGEUP,		(char_u *)"PageUp"},
2426     {K_PAGEDOWN,	(char_u *)"PageDown"},
2427     {K_KPAGEUP,		(char_u *)"kPageUp"},
2428     {K_KPAGEDOWN,	(char_u *)"kPageDown"},
2429 
2430     {K_KPLUS,		(char_u *)"kPlus"},
2431     {K_KMINUS,		(char_u *)"kMinus"},
2432     {K_KDIVIDE,		(char_u *)"kDivide"},
2433     {K_KMULTIPLY,	(char_u *)"kMultiply"},
2434     {K_KENTER,		(char_u *)"kEnter"},
2435     {K_KPOINT,		(char_u *)"kPoint"},
2436 
2437     {K_K0,		(char_u *)"k0"},
2438     {K_K1,		(char_u *)"k1"},
2439     {K_K2,		(char_u *)"k2"},
2440     {K_K3,		(char_u *)"k3"},
2441     {K_K4,		(char_u *)"k4"},
2442     {K_K5,		(char_u *)"k5"},
2443     {K_K6,		(char_u *)"k6"},
2444     {K_K7,		(char_u *)"k7"},
2445     {K_K8,		(char_u *)"k8"},
2446     {K_K9,		(char_u *)"k9"},
2447 
2448     {'<',		(char_u *)"lt"},
2449 
2450     {K_MOUSE,		(char_u *)"Mouse"},
2451 #ifdef FEAT_MOUSE_NET
2452     {K_NETTERM_MOUSE,	(char_u *)"NetMouse"},
2453 #endif
2454 #ifdef FEAT_MOUSE_DEC
2455     {K_DEC_MOUSE,	(char_u *)"DecMouse"},
2456 #endif
2457 #ifdef FEAT_MOUSE_JSB
2458     {K_JSBTERM_MOUSE,	(char_u *)"JsbMouse"},
2459 #endif
2460 #ifdef FEAT_MOUSE_PTERM
2461     {K_PTERM_MOUSE,	(char_u *)"PtermMouse"},
2462 #endif
2463 #ifdef FEAT_MOUSE_URXVT
2464     {K_URXVT_MOUSE,	(char_u *)"UrxvtMouse"},
2465 #endif
2466     {K_SGR_MOUSE,	(char_u *)"SgrMouse"},
2467     {K_SGR_MOUSERELEASE, (char_u *)"SgrMouseRelelase"},
2468     {K_LEFTMOUSE,	(char_u *)"LeftMouse"},
2469     {K_LEFTMOUSE_NM,	(char_u *)"LeftMouseNM"},
2470     {K_LEFTDRAG,	(char_u *)"LeftDrag"},
2471     {K_LEFTRELEASE,	(char_u *)"LeftRelease"},
2472     {K_LEFTRELEASE_NM,	(char_u *)"LeftReleaseNM"},
2473     {K_MOUSEMOVE,	(char_u *)"MouseMove"},
2474     {K_MIDDLEMOUSE,	(char_u *)"MiddleMouse"},
2475     {K_MIDDLEDRAG,	(char_u *)"MiddleDrag"},
2476     {K_MIDDLERELEASE,	(char_u *)"MiddleRelease"},
2477     {K_RIGHTMOUSE,	(char_u *)"RightMouse"},
2478     {K_RIGHTDRAG,	(char_u *)"RightDrag"},
2479     {K_RIGHTRELEASE,	(char_u *)"RightRelease"},
2480     {K_MOUSEDOWN,	(char_u *)"ScrollWheelUp"},
2481     {K_MOUSEUP,		(char_u *)"ScrollWheelDown"},
2482     {K_MOUSELEFT,	(char_u *)"ScrollWheelRight"},
2483     {K_MOUSERIGHT,	(char_u *)"ScrollWheelLeft"},
2484     {K_MOUSEDOWN,	(char_u *)"MouseDown"}, /* OBSOLETE: Use	  */
2485     {K_MOUSEUP,		(char_u *)"MouseUp"},	/* ScrollWheelXXX instead */
2486     {K_X1MOUSE,		(char_u *)"X1Mouse"},
2487     {K_X1DRAG,		(char_u *)"X1Drag"},
2488     {K_X1RELEASE,		(char_u *)"X1Release"},
2489     {K_X2MOUSE,		(char_u *)"X2Mouse"},
2490     {K_X2DRAG,		(char_u *)"X2Drag"},
2491     {K_X2RELEASE,		(char_u *)"X2Release"},
2492     {K_DROP,		(char_u *)"Drop"},
2493     {K_ZERO,		(char_u *)"Nul"},
2494 #ifdef FEAT_EVAL
2495     {K_SNR,		(char_u *)"SNR"},
2496 #endif
2497     {K_PLUG,		(char_u *)"Plug"},
2498     {K_CURSORHOLD,	(char_u *)"CursorHold"},
2499     {K_IGNORE,		(char_u *)"Ignore"},
2500     {0,			NULL}
2501     /* NOTE: When adding a long name update MAX_KEY_NAME_LEN. */
2502 };
2503 
2504 #define KEY_NAMES_TABLE_LEN (sizeof(key_names_table) / sizeof(struct key_name_entry))
2505 
2506 #ifdef FEAT_MOUSE
2507 static struct mousetable
2508 {
2509     int	    pseudo_code;	/* Code for pseudo mouse event */
2510     int	    button;		/* Which mouse button is it? */
2511     int	    is_click;		/* Is it a mouse button click event? */
2512     int	    is_drag;		/* Is it a mouse drag event? */
2513 } mouse_table[] =
2514 {
2515     {(int)KE_LEFTMOUSE,		MOUSE_LEFT,	TRUE,	FALSE},
2516 #ifdef FEAT_GUI
2517     {(int)KE_LEFTMOUSE_NM,	MOUSE_LEFT,	TRUE,	FALSE},
2518 #endif
2519     {(int)KE_LEFTDRAG,		MOUSE_LEFT,	FALSE,	TRUE},
2520     {(int)KE_LEFTRELEASE,	MOUSE_LEFT,	FALSE,	FALSE},
2521 #ifdef FEAT_GUI
2522     {(int)KE_LEFTRELEASE_NM,	MOUSE_LEFT,	FALSE,	FALSE},
2523 #endif
2524     {(int)KE_MIDDLEMOUSE,	MOUSE_MIDDLE,	TRUE,	FALSE},
2525     {(int)KE_MIDDLEDRAG,	MOUSE_MIDDLE,	FALSE,	TRUE},
2526     {(int)KE_MIDDLERELEASE,	MOUSE_MIDDLE,	FALSE,	FALSE},
2527     {(int)KE_RIGHTMOUSE,	MOUSE_RIGHT,	TRUE,	FALSE},
2528     {(int)KE_RIGHTDRAG,		MOUSE_RIGHT,	FALSE,	TRUE},
2529     {(int)KE_RIGHTRELEASE,	MOUSE_RIGHT,	FALSE,	FALSE},
2530     {(int)KE_X1MOUSE,		MOUSE_X1,	TRUE,	FALSE},
2531     {(int)KE_X1DRAG,		MOUSE_X1,	FALSE,	TRUE},
2532     {(int)KE_X1RELEASE,		MOUSE_X1,	FALSE,	FALSE},
2533     {(int)KE_X2MOUSE,		MOUSE_X2,	TRUE,	FALSE},
2534     {(int)KE_X2DRAG,		MOUSE_X2,	FALSE,	TRUE},
2535     {(int)KE_X2RELEASE,		MOUSE_X2,	FALSE,	FALSE},
2536     /* DRAG without CLICK */
2537     {(int)KE_MOUSEMOVE,		MOUSE_RELEASE,	FALSE,	TRUE},
2538     /* RELEASE without CLICK */
2539     {(int)KE_IGNORE,		MOUSE_RELEASE,	FALSE,	FALSE},
2540     {0,				0,		0,	0},
2541 };
2542 #endif /* FEAT_MOUSE */
2543 
2544 /*
2545  * Return the modifier mask bit (MOD_MASK_*) which corresponds to the given
2546  * modifier name ('S' for Shift, 'C' for Ctrl etc).
2547  */
2548     int
2549 name_to_mod_mask(int c)
2550 {
2551     int	    i;
2552 
2553     c = TOUPPER_ASC(c);
2554     for (i = 0; mod_mask_table[i].mod_mask != 0; i++)
2555 	if (c == mod_mask_table[i].name)
2556 	    return mod_mask_table[i].mod_flag;
2557     return 0;
2558 }
2559 
2560 /*
2561  * Check if if there is a special key code for "key" that includes the
2562  * modifiers specified.
2563  */
2564     int
2565 simplify_key(int key, int *modifiers)
2566 {
2567     int	    i;
2568     int	    key0;
2569     int	    key1;
2570 
2571     if (*modifiers & (MOD_MASK_SHIFT | MOD_MASK_CTRL | MOD_MASK_ALT))
2572     {
2573 	/* TAB is a special case */
2574 	if (key == TAB && (*modifiers & MOD_MASK_SHIFT))
2575 	{
2576 	    *modifiers &= ~MOD_MASK_SHIFT;
2577 	    return K_S_TAB;
2578 	}
2579 	key0 = KEY2TERMCAP0(key);
2580 	key1 = KEY2TERMCAP1(key);
2581 	for (i = 0; modifier_keys_table[i] != NUL; i += MOD_KEYS_ENTRY_SIZE)
2582 	    if (key0 == modifier_keys_table[i + 3]
2583 		    && key1 == modifier_keys_table[i + 4]
2584 		    && (*modifiers & modifier_keys_table[i]))
2585 	    {
2586 		*modifiers &= ~modifier_keys_table[i];
2587 		return TERMCAP2KEY(modifier_keys_table[i + 1],
2588 						   modifier_keys_table[i + 2]);
2589 	    }
2590     }
2591     return key;
2592 }
2593 
2594 /*
2595  * Change <xHome> to <Home>, <xUp> to <Up>, etc.
2596  */
2597     int
2598 handle_x_keys(int key)
2599 {
2600     switch (key)
2601     {
2602 	case K_XUP:	return K_UP;
2603 	case K_XDOWN:	return K_DOWN;
2604 	case K_XLEFT:	return K_LEFT;
2605 	case K_XRIGHT:	return K_RIGHT;
2606 	case K_XHOME:	return K_HOME;
2607 	case K_ZHOME:	return K_HOME;
2608 	case K_XEND:	return K_END;
2609 	case K_ZEND:	return K_END;
2610 	case K_XF1:	return K_F1;
2611 	case K_XF2:	return K_F2;
2612 	case K_XF3:	return K_F3;
2613 	case K_XF4:	return K_F4;
2614 	case K_S_XF1:	return K_S_F1;
2615 	case K_S_XF2:	return K_S_F2;
2616 	case K_S_XF3:	return K_S_F3;
2617 	case K_S_XF4:	return K_S_F4;
2618     }
2619     return key;
2620 }
2621 
2622 /*
2623  * Return a string which contains the name of the given key when the given
2624  * modifiers are down.
2625  */
2626     char_u *
2627 get_special_key_name(int c, int modifiers)
2628 {
2629     static char_u string[MAX_KEY_NAME_LEN + 1];
2630 
2631     int	    i, idx;
2632     int	    table_idx;
2633     char_u  *s;
2634 
2635     string[0] = '<';
2636     idx = 1;
2637 
2638     /* Key that stands for a normal character. */
2639     if (IS_SPECIAL(c) && KEY2TERMCAP0(c) == KS_KEY)
2640 	c = KEY2TERMCAP1(c);
2641 
2642     /*
2643      * Translate shifted special keys into unshifted keys and set modifier.
2644      * Same for CTRL and ALT modifiers.
2645      */
2646     if (IS_SPECIAL(c))
2647     {
2648 	for (i = 0; modifier_keys_table[i] != 0; i += MOD_KEYS_ENTRY_SIZE)
2649 	    if (       KEY2TERMCAP0(c) == (int)modifier_keys_table[i + 1]
2650 		    && (int)KEY2TERMCAP1(c) == (int)modifier_keys_table[i + 2])
2651 	    {
2652 		modifiers |= modifier_keys_table[i];
2653 		c = TERMCAP2KEY(modifier_keys_table[i + 3],
2654 						   modifier_keys_table[i + 4]);
2655 		break;
2656 	    }
2657     }
2658 
2659     /* try to find the key in the special key table */
2660     table_idx = find_special_key_in_table(c);
2661 
2662     /*
2663      * When not a known special key, and not a printable character, try to
2664      * extract modifiers.
2665      */
2666     if (c > 0 && (*mb_char2len)(c) == 1)
2667     {
2668 	if (table_idx < 0
2669 		&& (!vim_isprintc(c) || (c & 0x7f) == ' ')
2670 		&& (c & 0x80))
2671 	{
2672 	    c &= 0x7f;
2673 	    modifiers |= MOD_MASK_ALT;
2674 	    /* try again, to find the un-alted key in the special key table */
2675 	    table_idx = find_special_key_in_table(c);
2676 	}
2677 	if (table_idx < 0 && !vim_isprintc(c) && c < ' ')
2678 	{
2679 #ifdef EBCDIC
2680 	    c = CtrlChar(c);
2681 #else
2682 	    c += '@';
2683 #endif
2684 	    modifiers |= MOD_MASK_CTRL;
2685 	}
2686     }
2687 
2688     /* translate the modifier into a string */
2689     for (i = 0; mod_mask_table[i].name != 'A'; i++)
2690 	if ((modifiers & mod_mask_table[i].mod_mask)
2691 						== mod_mask_table[i].mod_flag)
2692 	{
2693 	    string[idx++] = mod_mask_table[i].name;
2694 	    string[idx++] = (char_u)'-';
2695 	}
2696 
2697     if (table_idx < 0)		/* unknown special key, may output t_xx */
2698     {
2699 	if (IS_SPECIAL(c))
2700 	{
2701 	    string[idx++] = 't';
2702 	    string[idx++] = '_';
2703 	    string[idx++] = KEY2TERMCAP0(c);
2704 	    string[idx++] = KEY2TERMCAP1(c);
2705 	}
2706 	/* Not a special key, only modifiers, output directly */
2707 	else
2708 	{
2709 	    if (has_mbyte && (*mb_char2len)(c) > 1)
2710 		idx += (*mb_char2bytes)(c, string + idx);
2711 	    else if (vim_isprintc(c))
2712 		string[idx++] = c;
2713 	    else
2714 	    {
2715 		s = transchar(c);
2716 		while (*s)
2717 		    string[idx++] = *s++;
2718 	    }
2719 	}
2720     }
2721     else		/* use name of special key */
2722     {
2723 	size_t len = STRLEN(key_names_table[table_idx].name);
2724 
2725 	if (len + idx + 2 <= MAX_KEY_NAME_LEN)
2726 	{
2727 	    STRCPY(string + idx, key_names_table[table_idx].name);
2728 	    idx += (int)len;
2729 	}
2730     }
2731     string[idx++] = '>';
2732     string[idx] = NUL;
2733     return string;
2734 }
2735 
2736 /*
2737  * Try translating a <> name at (*srcp)[] to dst[].
2738  * Return the number of characters added to dst[], zero for no match.
2739  * If there is a match, srcp is advanced to after the <> name.
2740  * dst[] must be big enough to hold the result (up to six characters)!
2741  */
2742     int
2743 trans_special(
2744     char_u	**srcp,
2745     char_u	*dst,
2746     int		keycode, /* prefer key code, e.g. K_DEL instead of DEL */
2747     int		in_string) /* TRUE when inside a double quoted string */
2748 {
2749     int		modifiers = 0;
2750     int		key;
2751     int		dlen = 0;
2752 
2753     key = find_special_key(srcp, &modifiers, keycode, FALSE, in_string);
2754     if (key == 0)
2755 	return 0;
2756 
2757     /* Put the appropriate modifier in a string */
2758     if (modifiers != 0)
2759     {
2760 	dst[dlen++] = K_SPECIAL;
2761 	dst[dlen++] = KS_MODIFIER;
2762 	dst[dlen++] = modifiers;
2763     }
2764 
2765     if (IS_SPECIAL(key))
2766     {
2767 	dst[dlen++] = K_SPECIAL;
2768 	dst[dlen++] = KEY2TERMCAP0(key);
2769 	dst[dlen++] = KEY2TERMCAP1(key);
2770     }
2771     else if (has_mbyte && !keycode)
2772 	dlen += (*mb_char2bytes)(key, dst + dlen);
2773     else if (keycode)
2774 	dlen = (int)(add_char2buf(key, dst + dlen) - dst);
2775     else
2776 	dst[dlen++] = key;
2777 
2778     return dlen;
2779 }
2780 
2781 /*
2782  * Try translating a <> name at (*srcp)[], return the key and modifiers.
2783  * srcp is advanced to after the <> name.
2784  * returns 0 if there is no match.
2785  */
2786     int
2787 find_special_key(
2788     char_u	**srcp,
2789     int		*modp,
2790     int		keycode,     /* prefer key code, e.g. K_DEL instead of DEL */
2791     int		keep_x_key,  /* don't translate xHome to Home key */
2792     int		in_string)   /* TRUE in string, double quote is escaped */
2793 {
2794     char_u	*last_dash;
2795     char_u	*end_of_name;
2796     char_u	*src;
2797     char_u	*bp;
2798     int		modifiers;
2799     int		bit;
2800     int		key;
2801     uvarnumber_T	n;
2802     int		l;
2803 
2804     src = *srcp;
2805     if (src[0] != '<')
2806 	return 0;
2807 
2808     /* Find end of modifier list */
2809     last_dash = src;
2810     for (bp = src + 1; *bp == '-' || vim_isIDc(*bp); bp++)
2811     {
2812 	if (*bp == '-')
2813 	{
2814 	    last_dash = bp;
2815 	    if (bp[1] != NUL)
2816 	    {
2817 		if (has_mbyte)
2818 		    l = mb_ptr2len(bp + 1);
2819 		else
2820 		    l = 1;
2821 		/* Anything accepted, like <C-?>.
2822 		 * <C-"> or <M-"> are not special in strings as " is
2823 		 * the string delimiter. With a backslash it works: <M-\"> */
2824 		if (!(in_string && bp[1] == '"') && bp[2] == '>')
2825 		    bp += l;
2826 		else if (in_string && bp[1] == '\\' && bp[2] == '"'
2827 							       && bp[3] == '>')
2828 		    bp += 2;
2829 	    }
2830 	}
2831 	if (bp[0] == 't' && bp[1] == '_' && bp[2] && bp[3])
2832 	    bp += 3;	/* skip t_xx, xx may be '-' or '>' */
2833 	else if (STRNICMP(bp, "char-", 5) == 0)
2834 	{
2835 	    vim_str2nr(bp + 5, NULL, &l, STR2NR_ALL, NULL, NULL, 0);
2836 	    bp += l + 5;
2837 	    break;
2838 	}
2839     }
2840 
2841     if (*bp == '>')	/* found matching '>' */
2842     {
2843 	end_of_name = bp + 1;
2844 
2845 	/* Which modifiers are given? */
2846 	modifiers = 0x0;
2847 	for (bp = src + 1; bp < last_dash; bp++)
2848 	{
2849 	    if (*bp != '-')
2850 	    {
2851 		bit = name_to_mod_mask(*bp);
2852 		if (bit == 0x0)
2853 		    break;	/* Illegal modifier name */
2854 		modifiers |= bit;
2855 	    }
2856 	}
2857 
2858 	/*
2859 	 * Legal modifier name.
2860 	 */
2861 	if (bp >= last_dash)
2862 	{
2863 	    if (STRNICMP(last_dash + 1, "char-", 5) == 0
2864 						 && VIM_ISDIGIT(last_dash[6]))
2865 	    {
2866 		/* <Char-123> or <Char-033> or <Char-0x33> */
2867 		vim_str2nr(last_dash + 6, NULL, NULL, STR2NR_ALL, NULL, &n, 0);
2868 		key = (int)n;
2869 	    }
2870 	    else
2871 	    {
2872 		int off = 1;
2873 
2874 		/* Modifier with single letter, or special key name.  */
2875 		if (in_string && last_dash[1] == '\\' && last_dash[2] == '"')
2876 		    off = 2;
2877 		if (has_mbyte)
2878 		    l = mb_ptr2len(last_dash + off);
2879 		else
2880 		    l = 1;
2881 		if (modifiers != 0 && last_dash[l + off] == '>')
2882 		    key = PTR2CHAR(last_dash + off);
2883 		else
2884 		{
2885 		    key = get_special_key_code(last_dash + off);
2886 		    if (!keep_x_key)
2887 			key = handle_x_keys(key);
2888 		}
2889 	    }
2890 
2891 	    /*
2892 	     * get_special_key_code() may return NUL for invalid
2893 	     * special key name.
2894 	     */
2895 	    if (key != NUL)
2896 	    {
2897 		/*
2898 		 * Only use a modifier when there is no special key code that
2899 		 * includes the modifier.
2900 		 */
2901 		key = simplify_key(key, &modifiers);
2902 
2903 		if (!keycode)
2904 		{
2905 		    /* don't want keycode, use single byte code */
2906 		    if (key == K_BS)
2907 			key = BS;
2908 		    else if (key == K_DEL || key == K_KDEL)
2909 			key = DEL;
2910 		}
2911 
2912 		/*
2913 		 * Normal Key with modifier: Try to make a single byte code.
2914 		 */
2915 		if (!IS_SPECIAL(key))
2916 		    key = extract_modifiers(key, &modifiers);
2917 
2918 		*modp = modifiers;
2919 		*srcp = end_of_name;
2920 		return key;
2921 	    }
2922 	}
2923     }
2924     return 0;
2925 }
2926 
2927 /*
2928  * Try to include modifiers in the key.
2929  * Changes "Shift-a" to 'A', "Alt-A" to 0xc0, etc.
2930  */
2931     int
2932 extract_modifiers(int key, int *modp)
2933 {
2934     int	modifiers = *modp;
2935 
2936 #ifdef MACOS_X
2937     /* Command-key really special, no fancynest */
2938     if (!(modifiers & MOD_MASK_CMD))
2939 #endif
2940     if ((modifiers & MOD_MASK_SHIFT) && ASCII_ISALPHA(key))
2941     {
2942 	key = TOUPPER_ASC(key);
2943 	modifiers &= ~MOD_MASK_SHIFT;
2944     }
2945     if ((modifiers & MOD_MASK_CTRL)
2946 #ifdef EBCDIC
2947 	    /* * TODO: EBCDIC Better use:
2948 	     * && (Ctrl_chr(key) || key == '?')
2949 	     * ???  */
2950 	    && strchr("?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_", key)
2951 						       != NULL
2952 #else
2953 	    && ((key >= '?' && key <= '_') || ASCII_ISALPHA(key))
2954 #endif
2955 	    )
2956     {
2957 	key = Ctrl_chr(key);
2958 	modifiers &= ~MOD_MASK_CTRL;
2959 	/* <C-@> is <Nul> */
2960 	if (key == 0)
2961 	    key = K_ZERO;
2962     }
2963 #ifdef MACOS_X
2964     /* Command-key really special, no fancynest */
2965     if (!(modifiers & MOD_MASK_CMD))
2966 #endif
2967     if ((modifiers & MOD_MASK_ALT) && key < 0x80
2968 	    && !enc_dbcs)		// avoid creating a lead byte
2969     {
2970 	key |= 0x80;
2971 	modifiers &= ~MOD_MASK_ALT;	/* remove the META modifier */
2972     }
2973 
2974     *modp = modifiers;
2975     return key;
2976 }
2977 
2978 /*
2979  * Try to find key "c" in the special key table.
2980  * Return the index when found, -1 when not found.
2981  */
2982     int
2983 find_special_key_in_table(int c)
2984 {
2985     int	    i;
2986 
2987     for (i = 0; key_names_table[i].name != NULL; i++)
2988 	if (c == key_names_table[i].key)
2989 	    break;
2990     if (key_names_table[i].name == NULL)
2991 	i = -1;
2992     return i;
2993 }
2994 
2995 /*
2996  * Find the special key with the given name (the given string does not have to
2997  * end with NUL, the name is assumed to end before the first non-idchar).
2998  * If the name starts with "t_" the next two characters are interpreted as a
2999  * termcap name.
3000  * Return the key code, or 0 if not found.
3001  */
3002     int
3003 get_special_key_code(char_u *name)
3004 {
3005     char_u  *table_name;
3006     char_u  string[3];
3007     int	    i, j;
3008 
3009     /*
3010      * If it's <t_xx> we get the code for xx from the termcap
3011      */
3012     if (name[0] == 't' && name[1] == '_' && name[2] != NUL && name[3] != NUL)
3013     {
3014 	string[0] = name[2];
3015 	string[1] = name[3];
3016 	string[2] = NUL;
3017 	if (add_termcap_entry(string, FALSE) == OK)
3018 	    return TERMCAP2KEY(name[2], name[3]);
3019     }
3020     else
3021 	for (i = 0; key_names_table[i].name != NULL; i++)
3022 	{
3023 	    table_name = key_names_table[i].name;
3024 	    for (j = 0; vim_isIDc(name[j]) && table_name[j] != NUL; j++)
3025 		if (TOLOWER_ASC(table_name[j]) != TOLOWER_ASC(name[j]))
3026 		    break;
3027 	    if (!vim_isIDc(name[j]) && table_name[j] == NUL)
3028 		return key_names_table[i].key;
3029 	}
3030     return 0;
3031 }
3032 
3033 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3034     char_u *
3035 get_key_name(int i)
3036 {
3037     if (i >= (int)KEY_NAMES_TABLE_LEN)
3038 	return NULL;
3039     return  key_names_table[i].name;
3040 }
3041 #endif
3042 
3043 #if defined(FEAT_MOUSE) || defined(PROTO)
3044 /*
3045  * Look up the given mouse code to return the relevant information in the other
3046  * arguments.  Return which button is down or was released.
3047  */
3048     int
3049 get_mouse_button(int code, int *is_click, int *is_drag)
3050 {
3051     int	    i;
3052 
3053     for (i = 0; mouse_table[i].pseudo_code; i++)
3054 	if (code == mouse_table[i].pseudo_code)
3055 	{
3056 	    *is_click = mouse_table[i].is_click;
3057 	    *is_drag = mouse_table[i].is_drag;
3058 	    return mouse_table[i].button;
3059 	}
3060     return 0;	    /* Shouldn't get here */
3061 }
3062 
3063 /*
3064  * Return the appropriate pseudo mouse event token (KE_LEFTMOUSE etc) based on
3065  * the given information about which mouse button is down, and whether the
3066  * mouse was clicked, dragged or released.
3067  */
3068     int
3069 get_pseudo_mouse_code(
3070     int	    button,	/* eg MOUSE_LEFT */
3071     int	    is_click,
3072     int	    is_drag)
3073 {
3074     int	    i;
3075 
3076     for (i = 0; mouse_table[i].pseudo_code; i++)
3077 	if (button == mouse_table[i].button
3078 	    && is_click == mouse_table[i].is_click
3079 	    && is_drag == mouse_table[i].is_drag)
3080 	{
3081 #ifdef FEAT_GUI
3082 	    /* Trick: a non mappable left click and release has mouse_col -1
3083 	     * or added MOUSE_COLOFF.  Used for 'mousefocus' in
3084 	     * gui_mouse_moved() */
3085 	    if (mouse_col < 0 || mouse_col > MOUSE_COLOFF)
3086 	    {
3087 		if (mouse_col < 0)
3088 		    mouse_col = 0;
3089 		else
3090 		    mouse_col -= MOUSE_COLOFF;
3091 		if (mouse_table[i].pseudo_code == (int)KE_LEFTMOUSE)
3092 		    return (int)KE_LEFTMOUSE_NM;
3093 		if (mouse_table[i].pseudo_code == (int)KE_LEFTRELEASE)
3094 		    return (int)KE_LEFTRELEASE_NM;
3095 	    }
3096 #endif
3097 	    return mouse_table[i].pseudo_code;
3098 	}
3099     return (int)KE_IGNORE;	    /* not recognized, ignore it */
3100 }
3101 #endif /* FEAT_MOUSE */
3102 
3103 /*
3104  * Return the current end-of-line type: EOL_DOS, EOL_UNIX or EOL_MAC.
3105  */
3106     int
3107 get_fileformat(buf_T *buf)
3108 {
3109     int		c = *buf->b_p_ff;
3110 
3111     if (buf->b_p_bin || c == 'u')
3112 	return EOL_UNIX;
3113     if (c == 'm')
3114 	return EOL_MAC;
3115     return EOL_DOS;
3116 }
3117 
3118 /*
3119  * Like get_fileformat(), but override 'fileformat' with "p" for "++opt=val"
3120  * argument.
3121  */
3122     int
3123 get_fileformat_force(
3124     buf_T	*buf,
3125     exarg_T	*eap)	    /* can be NULL! */
3126 {
3127     int		c;
3128 
3129     if (eap != NULL && eap->force_ff != 0)
3130 	c = eap->force_ff;
3131     else
3132     {
3133 	if ((eap != NULL && eap->force_bin != 0)
3134 			       ? (eap->force_bin == FORCE_BIN) : buf->b_p_bin)
3135 	    return EOL_UNIX;
3136 	c = *buf->b_p_ff;
3137     }
3138     if (c == 'u')
3139 	return EOL_UNIX;
3140     if (c == 'm')
3141 	return EOL_MAC;
3142     return EOL_DOS;
3143 }
3144 
3145 /*
3146  * Set the current end-of-line type to EOL_DOS, EOL_UNIX or EOL_MAC.
3147  * Sets both 'textmode' and 'fileformat'.
3148  * Note: Does _not_ set global value of 'textmode'!
3149  */
3150     void
3151 set_fileformat(
3152     int		t,
3153     int		opt_flags)	/* OPT_LOCAL and/or OPT_GLOBAL */
3154 {
3155     char	*p = NULL;
3156 
3157     switch (t)
3158     {
3159     case EOL_DOS:
3160 	p = FF_DOS;
3161 	curbuf->b_p_tx = TRUE;
3162 	break;
3163     case EOL_UNIX:
3164 	p = FF_UNIX;
3165 	curbuf->b_p_tx = FALSE;
3166 	break;
3167     case EOL_MAC:
3168 	p = FF_MAC;
3169 	curbuf->b_p_tx = FALSE;
3170 	break;
3171     }
3172     if (p != NULL)
3173 	set_string_option_direct((char_u *)"ff", -1, (char_u *)p,
3174 						     OPT_FREE | opt_flags, 0);
3175 
3176     /* This may cause the buffer to become (un)modified. */
3177     check_status(curbuf);
3178     redraw_tabline = TRUE;
3179 #ifdef FEAT_TITLE
3180     need_maketitle = TRUE;	    /* set window title later */
3181 #endif
3182 }
3183 
3184 /*
3185  * Return the default fileformat from 'fileformats'.
3186  */
3187     int
3188 default_fileformat(void)
3189 {
3190     switch (*p_ffs)
3191     {
3192 	case 'm':   return EOL_MAC;
3193 	case 'd':   return EOL_DOS;
3194     }
3195     return EOL_UNIX;
3196 }
3197 
3198 /*
3199  * Call shell.	Calls mch_call_shell, with 'shellxquote' added.
3200  */
3201     int
3202 call_shell(char_u *cmd, int opt)
3203 {
3204     char_u	*ncmd;
3205     int		retval;
3206 #ifdef FEAT_PROFILE
3207     proftime_T	wait_time;
3208 #endif
3209 
3210     if (p_verbose > 3)
3211     {
3212 	verbose_enter();
3213 	smsg(_("Calling shell to execute: \"%s\""),
3214 						    cmd == NULL ? p_sh : cmd);
3215 	out_char('\n');
3216 	cursor_on();
3217 	verbose_leave();
3218     }
3219 
3220 #ifdef FEAT_PROFILE
3221     if (do_profiling == PROF_YES)
3222 	prof_child_enter(&wait_time);
3223 #endif
3224 
3225     if (*p_sh == NUL)
3226     {
3227 	emsg(_(e_shellempty));
3228 	retval = -1;
3229     }
3230     else
3231     {
3232 #ifdef FEAT_GUI_MSWIN
3233 	/* Don't hide the pointer while executing a shell command. */
3234 	gui_mch_mousehide(FALSE);
3235 #endif
3236 #ifdef FEAT_GUI
3237 	++hold_gui_events;
3238 #endif
3239 	/* The external command may update a tags file, clear cached tags. */
3240 	tag_freematch();
3241 
3242 	if (cmd == NULL || *p_sxq == NUL)
3243 	    retval = mch_call_shell(cmd, opt);
3244 	else
3245 	{
3246 	    char_u *ecmd = cmd;
3247 
3248 	    if (*p_sxe != NUL && STRCMP(p_sxq, "(") == 0)
3249 	    {
3250 		ecmd = vim_strsave_escaped_ext(cmd, p_sxe, '^', FALSE);
3251 		if (ecmd == NULL)
3252 		    ecmd = cmd;
3253 	    }
3254 	    ncmd = alloc((unsigned)(STRLEN(ecmd) + STRLEN(p_sxq) * 2 + 1));
3255 	    if (ncmd != NULL)
3256 	    {
3257 		STRCPY(ncmd, p_sxq);
3258 		STRCAT(ncmd, ecmd);
3259 		/* When 'shellxquote' is ( append ).
3260 		 * When 'shellxquote' is "( append )". */
3261 		STRCAT(ncmd, STRCMP(p_sxq, "(") == 0 ? (char_u *)")"
3262 			   : STRCMP(p_sxq, "\"(") == 0 ? (char_u *)")\""
3263 			   : p_sxq);
3264 		retval = mch_call_shell(ncmd, opt);
3265 		vim_free(ncmd);
3266 	    }
3267 	    else
3268 		retval = -1;
3269 	    if (ecmd != cmd)
3270 		vim_free(ecmd);
3271 	}
3272 #ifdef FEAT_GUI
3273 	--hold_gui_events;
3274 #endif
3275 	/*
3276 	 * Check the window size, in case it changed while executing the
3277 	 * external command.
3278 	 */
3279 	shell_resized_check();
3280     }
3281 
3282 #ifdef FEAT_EVAL
3283     set_vim_var_nr(VV_SHELL_ERROR, (long)retval);
3284 # ifdef FEAT_PROFILE
3285     if (do_profiling == PROF_YES)
3286 	prof_child_exit(&wait_time);
3287 # endif
3288 #endif
3289 
3290     return retval;
3291 }
3292 
3293 /*
3294  * VISUAL, SELECTMODE and OP_PENDING State are never set, they are equal to
3295  * NORMAL State with a condition.  This function returns the real State.
3296  */
3297     int
3298 get_real_state(void)
3299 {
3300     if (State & NORMAL)
3301     {
3302 	if (VIsual_active)
3303 	{
3304 	    if (VIsual_select)
3305 		return SELECTMODE;
3306 	    return VISUAL;
3307 	}
3308 	else if (finish_op)
3309 	    return OP_PENDING;
3310     }
3311     return State;
3312 }
3313 
3314 /*
3315  * Return TRUE if "p" points to just after a path separator.
3316  * Takes care of multi-byte characters.
3317  * "b" must point to the start of the file name
3318  */
3319     int
3320 after_pathsep(char_u *b, char_u *p)
3321 {
3322     return p > b && vim_ispathsep(p[-1])
3323 			     && (!has_mbyte || (*mb_head_off)(b, p - 1) == 0);
3324 }
3325 
3326 /*
3327  * Return TRUE if file names "f1" and "f2" are in the same directory.
3328  * "f1" may be a short name, "f2" must be a full path.
3329  */
3330     int
3331 same_directory(char_u *f1, char_u *f2)
3332 {
3333     char_u	ffname[MAXPATHL];
3334     char_u	*t1;
3335     char_u	*t2;
3336 
3337     /* safety check */
3338     if (f1 == NULL || f2 == NULL)
3339 	return FALSE;
3340 
3341     (void)vim_FullName(f1, ffname, MAXPATHL, FALSE);
3342     t1 = gettail_sep(ffname);
3343     t2 = gettail_sep(f2);
3344     return (t1 - ffname == t2 - f2
3345 	     && pathcmp((char *)ffname, (char *)f2, (int)(t1 - ffname)) == 0);
3346 }
3347 
3348 #if defined(FEAT_SESSION) || defined(FEAT_AUTOCHDIR) \
3349 	|| defined(MSWIN) || defined(FEAT_GUI_MAC) || defined(FEAT_GUI_GTK) \
3350 	|| defined(FEAT_NETBEANS_INTG) \
3351 	|| defined(PROTO)
3352 /*
3353  * Change to a file's directory.
3354  * Caller must call shorten_fnames()!
3355  * Return OK or FAIL.
3356  */
3357     int
3358 vim_chdirfile(char_u *fname, char *trigger_autocmd)
3359 {
3360     char_u	old_dir[MAXPATHL];
3361     char_u	new_dir[MAXPATHL];
3362     int		res;
3363 
3364     if (mch_dirname(old_dir, MAXPATHL) != OK)
3365 	*old_dir = NUL;
3366 
3367     vim_strncpy(new_dir, fname, MAXPATHL - 1);
3368     *gettail_sep(new_dir) = NUL;
3369 
3370     if (pathcmp((char *)old_dir, (char *)new_dir, -1) == 0)
3371 	// nothing to do
3372 	res = OK;
3373     else
3374     {
3375 	res = mch_chdir((char *)new_dir) == 0 ? OK : FAIL;
3376 
3377 	if (res == OK && trigger_autocmd != NULL)
3378 	    apply_autocmds(EVENT_DIRCHANGED, (char_u *)trigger_autocmd,
3379 						       new_dir, FALSE, curbuf);
3380     }
3381     return res;
3382 }
3383 #endif
3384 
3385 #if defined(STAT_IGNORES_SLASH) || defined(PROTO)
3386 /*
3387  * Check if "name" ends in a slash and is not a directory.
3388  * Used for systems where stat() ignores a trailing slash on a file name.
3389  * The Vim code assumes a trailing slash is only ignored for a directory.
3390  */
3391     static int
3392 illegal_slash(const char *name)
3393 {
3394     if (name[0] == NUL)
3395 	return FALSE;	    /* no file name is not illegal */
3396     if (name[strlen(name) - 1] != '/')
3397 	return FALSE;	    /* no trailing slash */
3398     if (mch_isdir((char_u *)name))
3399 	return FALSE;	    /* trailing slash for a directory */
3400     return TRUE;
3401 }
3402 
3403 /*
3404  * Special implementation of mch_stat() for Solaris.
3405  */
3406     int
3407 vim_stat(const char *name, stat_T *stp)
3408 {
3409     /* On Solaris stat() accepts "file/" as if it was "file".  Return -1 if
3410      * the name ends in "/" and it's not a directory. */
3411     return illegal_slash(name) ? -1 : stat(name, stp);
3412 }
3413 #endif
3414 
3415 #if defined(CURSOR_SHAPE) || defined(PROTO)
3416 
3417 /*
3418  * Handling of cursor and mouse pointer shapes in various modes.
3419  */
3420 
3421 cursorentry_T shape_table[SHAPE_IDX_COUNT] =
3422 {
3423     /* The values will be filled in from the 'guicursor' and 'mouseshape'
3424      * defaults when Vim starts.
3425      * Adjust the SHAPE_IDX_ defines when making changes! */
3426     {0,	0, 0, 700L, 400L, 250L, 0, 0, "n", SHAPE_CURSOR+SHAPE_MOUSE},
3427     {0,	0, 0, 700L, 400L, 250L, 0, 0, "v", SHAPE_CURSOR+SHAPE_MOUSE},
3428     {0,	0, 0, 700L, 400L, 250L, 0, 0, "i", SHAPE_CURSOR+SHAPE_MOUSE},
3429     {0,	0, 0, 700L, 400L, 250L, 0, 0, "r", SHAPE_CURSOR+SHAPE_MOUSE},
3430     {0,	0, 0, 700L, 400L, 250L, 0, 0, "c", SHAPE_CURSOR+SHAPE_MOUSE},
3431     {0,	0, 0, 700L, 400L, 250L, 0, 0, "ci", SHAPE_CURSOR+SHAPE_MOUSE},
3432     {0,	0, 0, 700L, 400L, 250L, 0, 0, "cr", SHAPE_CURSOR+SHAPE_MOUSE},
3433     {0,	0, 0, 700L, 400L, 250L, 0, 0, "o", SHAPE_CURSOR+SHAPE_MOUSE},
3434     {0,	0, 0, 700L, 400L, 250L, 0, 0, "ve", SHAPE_CURSOR+SHAPE_MOUSE},
3435     {0,	0, 0,   0L,   0L,   0L, 0, 0, "e", SHAPE_MOUSE},
3436     {0,	0, 0,   0L,   0L,   0L, 0, 0, "s", SHAPE_MOUSE},
3437     {0,	0, 0,   0L,   0L,   0L, 0, 0, "sd", SHAPE_MOUSE},
3438     {0,	0, 0,   0L,   0L,   0L, 0, 0, "vs", SHAPE_MOUSE},
3439     {0,	0, 0,   0L,   0L,   0L, 0, 0, "vd", SHAPE_MOUSE},
3440     {0,	0, 0,   0L,   0L,   0L, 0, 0, "m", SHAPE_MOUSE},
3441     {0,	0, 0,   0L,   0L,   0L, 0, 0, "ml", SHAPE_MOUSE},
3442     {0,	0, 0, 100L, 100L, 100L, 0, 0, "sm", SHAPE_CURSOR},
3443 };
3444 
3445 #ifdef FEAT_MOUSESHAPE
3446 /*
3447  * Table with names for mouse shapes.  Keep in sync with all the tables for
3448  * mch_set_mouse_shape()!.
3449  */
3450 static char * mshape_names[] =
3451 {
3452     "arrow",	/* default, must be the first one */
3453     "blank",	/* hidden */
3454     "beam",
3455     "updown",
3456     "udsizing",
3457     "leftright",
3458     "lrsizing",
3459     "busy",
3460     "no",
3461     "crosshair",
3462     "hand1",
3463     "hand2",
3464     "pencil",
3465     "question",
3466     "rightup-arrow",
3467     "up-arrow",
3468     NULL
3469 };
3470 #endif
3471 
3472 /*
3473  * Parse the 'guicursor' option ("what" is SHAPE_CURSOR) or 'mouseshape'
3474  * ("what" is SHAPE_MOUSE).
3475  * Returns error message for an illegal option, NULL otherwise.
3476  */
3477     char *
3478 parse_shape_opt(int what)
3479 {
3480     char_u	*modep;
3481     char_u	*colonp;
3482     char_u	*commap;
3483     char_u	*slashp;
3484     char_u	*p, *endp;
3485     int		idx = 0;		/* init for GCC */
3486     int		all_idx;
3487     int		len;
3488     int		i;
3489     long	n;
3490     int		found_ve = FALSE;	/* found "ve" flag */
3491     int		round;
3492 
3493     /*
3494      * First round: check for errors; second round: do it for real.
3495      */
3496     for (round = 1; round <= 2; ++round)
3497     {
3498 	/*
3499 	 * Repeat for all comma separated parts.
3500 	 */
3501 #ifdef FEAT_MOUSESHAPE
3502 	if (what == SHAPE_MOUSE)
3503 	    modep = p_mouseshape;
3504 	else
3505 #endif
3506 	    modep = p_guicursor;
3507 	while (*modep != NUL)
3508 	{
3509 	    colonp = vim_strchr(modep, ':');
3510 	    commap = vim_strchr(modep, ',');
3511 
3512 	    if (colonp == NULL || (commap != NULL && commap < colonp))
3513 		return N_("E545: Missing colon");
3514 	    if (colonp == modep)
3515 		return N_("E546: Illegal mode");
3516 
3517 	    /*
3518 	     * Repeat for all mode's before the colon.
3519 	     * For the 'a' mode, we loop to handle all the modes.
3520 	     */
3521 	    all_idx = -1;
3522 	    while (modep < colonp || all_idx >= 0)
3523 	    {
3524 		if (all_idx < 0)
3525 		{
3526 		    /* Find the mode. */
3527 		    if (modep[1] == '-' || modep[1] == ':')
3528 			len = 1;
3529 		    else
3530 			len = 2;
3531 		    if (len == 1 && TOLOWER_ASC(modep[0]) == 'a')
3532 			all_idx = SHAPE_IDX_COUNT - 1;
3533 		    else
3534 		    {
3535 			for (idx = 0; idx < SHAPE_IDX_COUNT; ++idx)
3536 			    if (STRNICMP(modep, shape_table[idx].name, len)
3537 									 == 0)
3538 				break;
3539 			if (idx == SHAPE_IDX_COUNT
3540 				   || (shape_table[idx].used_for & what) == 0)
3541 			    return N_("E546: Illegal mode");
3542 			if (len == 2 && modep[0] == 'v' && modep[1] == 'e')
3543 			    found_ve = TRUE;
3544 		    }
3545 		    modep += len + 1;
3546 		}
3547 
3548 		if (all_idx >= 0)
3549 		    idx = all_idx--;
3550 		else if (round == 2)
3551 		{
3552 #ifdef FEAT_MOUSESHAPE
3553 		    if (what == SHAPE_MOUSE)
3554 		    {
3555 			/* Set the default, for the missing parts */
3556 			shape_table[idx].mshape = 0;
3557 		    }
3558 		    else
3559 #endif
3560 		    {
3561 			/* Set the defaults, for the missing parts */
3562 			shape_table[idx].shape = SHAPE_BLOCK;
3563 			shape_table[idx].blinkwait = 700L;
3564 			shape_table[idx].blinkon = 400L;
3565 			shape_table[idx].blinkoff = 250L;
3566 		    }
3567 		}
3568 
3569 		/* Parse the part after the colon */
3570 		for (p = colonp + 1; *p && *p != ','; )
3571 		{
3572 #ifdef FEAT_MOUSESHAPE
3573 		    if (what == SHAPE_MOUSE)
3574 		    {
3575 			for (i = 0; ; ++i)
3576 			{
3577 			    if (mshape_names[i] == NULL)
3578 			    {
3579 				if (!VIM_ISDIGIT(*p))
3580 				    return N_("E547: Illegal mouseshape");
3581 				if (round == 2)
3582 				    shape_table[idx].mshape =
3583 					      getdigits(&p) + MSHAPE_NUMBERED;
3584 				else
3585 				    (void)getdigits(&p);
3586 				break;
3587 			    }
3588 			    len = (int)STRLEN(mshape_names[i]);
3589 			    if (STRNICMP(p, mshape_names[i], len) == 0)
3590 			    {
3591 				if (round == 2)
3592 				    shape_table[idx].mshape = i;
3593 				p += len;
3594 				break;
3595 			    }
3596 			}
3597 		    }
3598 		    else /* if (what == SHAPE_MOUSE) */
3599 #endif
3600 		    {
3601 			/*
3602 			 * First handle the ones with a number argument.
3603 			 */
3604 			i = *p;
3605 			len = 0;
3606 			if (STRNICMP(p, "ver", 3) == 0)
3607 			    len = 3;
3608 			else if (STRNICMP(p, "hor", 3) == 0)
3609 			    len = 3;
3610 			else if (STRNICMP(p, "blinkwait", 9) == 0)
3611 			    len = 9;
3612 			else if (STRNICMP(p, "blinkon", 7) == 0)
3613 			    len = 7;
3614 			else if (STRNICMP(p, "blinkoff", 8) == 0)
3615 			    len = 8;
3616 			if (len != 0)
3617 			{
3618 			    p += len;
3619 			    if (!VIM_ISDIGIT(*p))
3620 				return N_("E548: digit expected");
3621 			    n = getdigits(&p);
3622 			    if (len == 3)   /* "ver" or "hor" */
3623 			    {
3624 				if (n == 0)
3625 				    return N_("E549: Illegal percentage");
3626 				if (round == 2)
3627 				{
3628 				    if (TOLOWER_ASC(i) == 'v')
3629 					shape_table[idx].shape = SHAPE_VER;
3630 				    else
3631 					shape_table[idx].shape = SHAPE_HOR;
3632 				    shape_table[idx].percentage = n;
3633 				}
3634 			    }
3635 			    else if (round == 2)
3636 			    {
3637 				if (len == 9)
3638 				    shape_table[idx].blinkwait = n;
3639 				else if (len == 7)
3640 				    shape_table[idx].blinkon = n;
3641 				else
3642 				    shape_table[idx].blinkoff = n;
3643 			    }
3644 			}
3645 			else if (STRNICMP(p, "block", 5) == 0)
3646 			{
3647 			    if (round == 2)
3648 				shape_table[idx].shape = SHAPE_BLOCK;
3649 			    p += 5;
3650 			}
3651 			else	/* must be a highlight group name then */
3652 			{
3653 			    endp = vim_strchr(p, '-');
3654 			    if (commap == NULL)		    /* last part */
3655 			    {
3656 				if (endp == NULL)
3657 				    endp = p + STRLEN(p);   /* find end of part */
3658 			    }
3659 			    else if (endp > commap || endp == NULL)
3660 				endp = commap;
3661 			    slashp = vim_strchr(p, '/');
3662 			    if (slashp != NULL && slashp < endp)
3663 			    {
3664 				/* "group/langmap_group" */
3665 				i = syn_check_group(p, (int)(slashp - p));
3666 				p = slashp + 1;
3667 			    }
3668 			    if (round == 2)
3669 			    {
3670 				shape_table[idx].id = syn_check_group(p,
3671 							     (int)(endp - p));
3672 				shape_table[idx].id_lm = shape_table[idx].id;
3673 				if (slashp != NULL && slashp < endp)
3674 				    shape_table[idx].id = i;
3675 			    }
3676 			    p = endp;
3677 			}
3678 		    } /* if (what != SHAPE_MOUSE) */
3679 
3680 		    if (*p == '-')
3681 			++p;
3682 		}
3683 	    }
3684 	    modep = p;
3685 	    if (*modep == ',')
3686 		++modep;
3687 	}
3688     }
3689 
3690     /* If the 's' flag is not given, use the 'v' cursor for 's' */
3691     if (!found_ve)
3692     {
3693 #ifdef FEAT_MOUSESHAPE
3694 	if (what == SHAPE_MOUSE)
3695 	{
3696 	    shape_table[SHAPE_IDX_VE].mshape = shape_table[SHAPE_IDX_V].mshape;
3697 	}
3698 	else
3699 #endif
3700 	{
3701 	    shape_table[SHAPE_IDX_VE].shape = shape_table[SHAPE_IDX_V].shape;
3702 	    shape_table[SHAPE_IDX_VE].percentage =
3703 					 shape_table[SHAPE_IDX_V].percentage;
3704 	    shape_table[SHAPE_IDX_VE].blinkwait =
3705 					  shape_table[SHAPE_IDX_V].blinkwait;
3706 	    shape_table[SHAPE_IDX_VE].blinkon =
3707 					    shape_table[SHAPE_IDX_V].blinkon;
3708 	    shape_table[SHAPE_IDX_VE].blinkoff =
3709 					   shape_table[SHAPE_IDX_V].blinkoff;
3710 	    shape_table[SHAPE_IDX_VE].id = shape_table[SHAPE_IDX_V].id;
3711 	    shape_table[SHAPE_IDX_VE].id_lm = shape_table[SHAPE_IDX_V].id_lm;
3712 	}
3713     }
3714 
3715     return NULL;
3716 }
3717 
3718 # if defined(MCH_CURSOR_SHAPE) || defined(FEAT_GUI) \
3719 	|| defined(FEAT_MOUSESHAPE) || defined(PROTO)
3720 /*
3721  * Return the index into shape_table[] for the current mode.
3722  * When "mouse" is TRUE, consider indexes valid for the mouse pointer.
3723  */
3724     int
3725 get_shape_idx(int mouse)
3726 {
3727 #ifdef FEAT_MOUSESHAPE
3728     if (mouse && (State == HITRETURN || State == ASKMORE))
3729     {
3730 # ifdef FEAT_GUI
3731 	int x, y;
3732 	gui_mch_getmouse(&x, &y);
3733 	if (Y_2_ROW(y) == Rows - 1)
3734 	    return SHAPE_IDX_MOREL;
3735 # endif
3736 	return SHAPE_IDX_MORE;
3737     }
3738     if (mouse && drag_status_line)
3739 	return SHAPE_IDX_SDRAG;
3740     if (mouse && drag_sep_line)
3741 	return SHAPE_IDX_VDRAG;
3742 #endif
3743     if (!mouse && State == SHOWMATCH)
3744 	return SHAPE_IDX_SM;
3745     if (State & VREPLACE_FLAG)
3746 	return SHAPE_IDX_R;
3747     if (State & REPLACE_FLAG)
3748 	return SHAPE_IDX_R;
3749     if (State & INSERT)
3750 	return SHAPE_IDX_I;
3751     if (State & CMDLINE)
3752     {
3753 	if (cmdline_at_end())
3754 	    return SHAPE_IDX_C;
3755 	if (cmdline_overstrike())
3756 	    return SHAPE_IDX_CR;
3757 	return SHAPE_IDX_CI;
3758     }
3759     if (finish_op)
3760 	return SHAPE_IDX_O;
3761     if (VIsual_active)
3762     {
3763 	if (*p_sel == 'e')
3764 	    return SHAPE_IDX_VE;
3765 	else
3766 	    return SHAPE_IDX_V;
3767     }
3768     return SHAPE_IDX_N;
3769 }
3770 #endif
3771 
3772 # if defined(FEAT_MOUSESHAPE) || defined(PROTO)
3773 static int old_mouse_shape = 0;
3774 
3775 /*
3776  * Set the mouse shape:
3777  * If "shape" is -1, use shape depending on the current mode,
3778  * depending on the current state.
3779  * If "shape" is -2, only update the shape when it's CLINE or STATUS (used
3780  * when the mouse moves off the status or command line).
3781  */
3782     void
3783 update_mouseshape(int shape_idx)
3784 {
3785     int new_mouse_shape;
3786 
3787     /* Only works in GUI mode. */
3788     if (!gui.in_use || gui.starting)
3789 	return;
3790 
3791     /* Postpone the updating when more is to come.  Speeds up executing of
3792      * mappings. */
3793     if (shape_idx == -1 && char_avail())
3794     {
3795 	postponed_mouseshape = TRUE;
3796 	return;
3797     }
3798 
3799     /* When ignoring the mouse don't change shape on the statusline. */
3800     if (*p_mouse == NUL
3801 	    && (shape_idx == SHAPE_IDX_CLINE
3802 		|| shape_idx == SHAPE_IDX_STATUS
3803 		|| shape_idx == SHAPE_IDX_VSEP))
3804 	shape_idx = -2;
3805 
3806     if (shape_idx == -2
3807 	    && old_mouse_shape != shape_table[SHAPE_IDX_CLINE].mshape
3808 	    && old_mouse_shape != shape_table[SHAPE_IDX_STATUS].mshape
3809 	    && old_mouse_shape != shape_table[SHAPE_IDX_VSEP].mshape)
3810 	return;
3811     if (shape_idx < 0)
3812 	new_mouse_shape = shape_table[get_shape_idx(TRUE)].mshape;
3813     else
3814 	new_mouse_shape = shape_table[shape_idx].mshape;
3815     if (new_mouse_shape != old_mouse_shape)
3816     {
3817 	mch_set_mouse_shape(new_mouse_shape);
3818 	old_mouse_shape = new_mouse_shape;
3819     }
3820     postponed_mouseshape = FALSE;
3821 }
3822 # endif
3823 
3824 #endif /* CURSOR_SHAPE */
3825 
3826 
3827 /*
3828  * Change directory to "new_dir".  If FEAT_SEARCHPATH is defined, search
3829  * 'cdpath' for relative directory names, otherwise just mch_chdir().
3830  */
3831     int
3832 vim_chdir(char_u *new_dir)
3833 {
3834 #ifndef FEAT_SEARCHPATH
3835     return mch_chdir((char *)new_dir);
3836 #else
3837     char_u	*dir_name;
3838     int		r;
3839 
3840     dir_name = find_directory_in_path(new_dir, (int)STRLEN(new_dir),
3841 						FNAME_MESS, curbuf->b_ffname);
3842     if (dir_name == NULL)
3843 	return -1;
3844     r = mch_chdir((char *)dir_name);
3845     vim_free(dir_name);
3846     return r;
3847 #endif
3848 }
3849 
3850 /*
3851  * Get user name from machine-specific function.
3852  * Returns the user name in "buf[len]".
3853  * Some systems are quite slow in obtaining the user name (Windows NT), thus
3854  * cache the result.
3855  * Returns OK or FAIL.
3856  */
3857     int
3858 get_user_name(char_u *buf, int len)
3859 {
3860     if (username == NULL)
3861     {
3862 	if (mch_get_user_name(buf, len) == FAIL)
3863 	    return FAIL;
3864 	username = vim_strsave(buf);
3865     }
3866     else
3867 	vim_strncpy(buf, username, len - 1);
3868     return OK;
3869 }
3870 
3871 #ifndef HAVE_QSORT
3872 /*
3873  * Our own qsort(), for systems that don't have it.
3874  * It's simple and slow.  From the K&R C book.
3875  */
3876     void
3877 qsort(
3878     void	*base,
3879     size_t	elm_count,
3880     size_t	elm_size,
3881     int (*cmp)(const void *, const void *))
3882 {
3883     char_u	*buf;
3884     char_u	*p1;
3885     char_u	*p2;
3886     int		i, j;
3887     int		gap;
3888 
3889     buf = alloc((unsigned)elm_size);
3890     if (buf == NULL)
3891 	return;
3892 
3893     for (gap = elm_count / 2; gap > 0; gap /= 2)
3894 	for (i = gap; i < elm_count; ++i)
3895 	    for (j = i - gap; j >= 0; j -= gap)
3896 	    {
3897 		/* Compare the elements. */
3898 		p1 = (char_u *)base + j * elm_size;
3899 		p2 = (char_u *)base + (j + gap) * elm_size;
3900 		if ((*cmp)((void *)p1, (void *)p2) <= 0)
3901 		    break;
3902 		/* Exchange the elements. */
3903 		mch_memmove(buf, p1, elm_size);
3904 		mch_memmove(p1, p2, elm_size);
3905 		mch_memmove(p2, buf, elm_size);
3906 	    }
3907 
3908     vim_free(buf);
3909 }
3910 #endif
3911 
3912 /*
3913  * Sort an array of strings.
3914  */
3915 static int sort_compare(const void *s1, const void *s2);
3916 
3917     static int
3918 sort_compare(const void *s1, const void *s2)
3919 {
3920     return STRCMP(*(char **)s1, *(char **)s2);
3921 }
3922 
3923     void
3924 sort_strings(
3925     char_u	**files,
3926     int		count)
3927 {
3928     qsort((void *)files, (size_t)count, sizeof(char_u *), sort_compare);
3929 }
3930 
3931 #if !defined(NO_EXPANDPATH) || defined(PROTO)
3932 /*
3933  * Compare path "p[]" to "q[]".
3934  * If "maxlen" >= 0 compare "p[maxlen]" to "q[maxlen]"
3935  * Return value like strcmp(p, q), but consider path separators.
3936  */
3937     int
3938 pathcmp(const char *p, const char *q, int maxlen)
3939 {
3940     int		i, j;
3941     int		c1, c2;
3942     const char	*s = NULL;
3943 
3944     for (i = 0, j = 0; maxlen < 0 || (i < maxlen && j < maxlen);)
3945     {
3946 	c1 = PTR2CHAR((char_u *)p + i);
3947 	c2 = PTR2CHAR((char_u *)q + j);
3948 
3949 	/* End of "p": check if "q" also ends or just has a slash. */
3950 	if (c1 == NUL)
3951 	{
3952 	    if (c2 == NUL)  /* full match */
3953 		return 0;
3954 	    s = q;
3955 	    i = j;
3956 	    break;
3957 	}
3958 
3959 	/* End of "q": check if "p" just has a slash. */
3960 	if (c2 == NUL)
3961 	{
3962 	    s = p;
3963 	    break;
3964 	}
3965 
3966 	if ((p_fic ? MB_TOUPPER(c1) != MB_TOUPPER(c2) : c1 != c2)
3967 #ifdef BACKSLASH_IN_FILENAME
3968 		/* consider '/' and '\\' to be equal */
3969 		&& !((c1 == '/' && c2 == '\\')
3970 		    || (c1 == '\\' && c2 == '/'))
3971 #endif
3972 		)
3973 	{
3974 	    if (vim_ispathsep(c1))
3975 		return -1;
3976 	    if (vim_ispathsep(c2))
3977 		return 1;
3978 	    return p_fic ? MB_TOUPPER(c1) - MB_TOUPPER(c2)
3979 		    : c1 - c2;  /* no match */
3980 	}
3981 
3982 	i += MB_PTR2LEN((char_u *)p + i);
3983 	j += MB_PTR2LEN((char_u *)q + j);
3984     }
3985     if (s == NULL)	/* "i" or "j" ran into "maxlen" */
3986 	return 0;
3987 
3988     c1 = PTR2CHAR((char_u *)s + i);
3989     c2 = PTR2CHAR((char_u *)s + i + MB_PTR2LEN((char_u *)s + i));
3990     /* ignore a trailing slash, but not "//" or ":/" */
3991     if (c2 == NUL
3992 	    && i > 0
3993 	    && !after_pathsep((char_u *)s, (char_u *)s + i)
3994 #ifdef BACKSLASH_IN_FILENAME
3995 	    && (c1 == '/' || c1 == '\\')
3996 #else
3997 	    && c1 == '/'
3998 #endif
3999        )
4000 	return 0;   /* match with trailing slash */
4001     if (s == q)
4002 	return -1;	    /* no match */
4003     return 1;
4004 }
4005 #endif
4006 
4007 /*
4008  * The putenv() implementation below comes from the "screen" program.
4009  * Included with permission from Juergen Weigert.
4010  * See pty.c for the copyright notice.
4011  */
4012 
4013 /*
4014  *  putenv  --	put value into environment
4015  *
4016  *  Usage:  i = putenv (string)
4017  *    int i;
4018  *    char  *string;
4019  *
4020  *  where string is of the form <name>=<value>.
4021  *  Putenv returns 0 normally, -1 on error (not enough core for malloc).
4022  *
4023  *  Putenv may need to add a new name into the environment, or to
4024  *  associate a value longer than the current value with a particular
4025  *  name.  So, to make life simpler, putenv() copies your entire
4026  *  environment into the heap (i.e. malloc()) from the stack
4027  *  (i.e. where it resides when your process is initiated) the first
4028  *  time you call it.
4029  *
4030  *  (history removed, not very interesting.  See the "screen" sources.)
4031  */
4032 
4033 #if !defined(HAVE_SETENV) && !defined(HAVE_PUTENV)
4034 
4035 #define EXTRASIZE 5		/* increment to add to env. size */
4036 
4037 static int  envsize = -1;	/* current size of environment */
4038 extern char **environ;		/* the global which is your env. */
4039 
4040 static int  findenv(char *name); /* look for a name in the env. */
4041 static int  newenv(void);	/* copy env. from stack to heap */
4042 static int  moreenv(void);	/* incr. size of env. */
4043 
4044     int
4045 putenv(const char *string)
4046 {
4047     int	    i;
4048     char    *p;
4049 
4050     if (envsize < 0)
4051     {				/* first time putenv called */
4052 	if (newenv() < 0)	/* copy env. to heap */
4053 	    return -1;
4054     }
4055 
4056     i = findenv((char *)string); /* look for name in environment */
4057 
4058     if (i < 0)
4059     {				/* name must be added */
4060 	for (i = 0; environ[i]; i++);
4061 	if (i >= (envsize - 1))
4062 	{			/* need new slot */
4063 	    if (moreenv() < 0)
4064 		return -1;
4065 	}
4066 	p = (char *)alloc((unsigned)(strlen(string) + 1));
4067 	if (p == NULL)		/* not enough core */
4068 	    return -1;
4069 	environ[i + 1] = 0;	/* new end of env. */
4070     }
4071     else
4072     {				/* name already in env. */
4073 	p = vim_realloc(environ[i], strlen(string) + 1);
4074 	if (p == NULL)
4075 	    return -1;
4076     }
4077     sprintf(p, "%s", string);	/* copy into env. */
4078     environ[i] = p;
4079 
4080     return 0;
4081 }
4082 
4083     static int
4084 findenv(char *name)
4085 {
4086     char    *namechar, *envchar;
4087     int	    i, found;
4088 
4089     found = 0;
4090     for (i = 0; environ[i] && !found; i++)
4091     {
4092 	envchar = environ[i];
4093 	namechar = name;
4094 	while (*namechar && *namechar != '=' && (*namechar == *envchar))
4095 	{
4096 	    namechar++;
4097 	    envchar++;
4098 	}
4099 	found = ((*namechar == '\0' || *namechar == '=') && *envchar == '=');
4100     }
4101     return found ? i - 1 : -1;
4102 }
4103 
4104     static int
4105 newenv(void)
4106 {
4107     char    **env, *elem;
4108     int	    i, esize;
4109 
4110     for (i = 0; environ[i]; i++)
4111 	;
4112 
4113     esize = i + EXTRASIZE + 1;
4114     env = (char **)alloc((unsigned)(esize * sizeof (elem)));
4115     if (env == NULL)
4116 	return -1;
4117 
4118     for (i = 0; environ[i]; i++)
4119     {
4120 	elem = (char *)alloc((unsigned)(strlen(environ[i]) + 1));
4121 	if (elem == NULL)
4122 	    return -1;
4123 	env[i] = elem;
4124 	strcpy(elem, environ[i]);
4125     }
4126 
4127     env[i] = 0;
4128     environ = env;
4129     envsize = esize;
4130     return 0;
4131 }
4132 
4133     static int
4134 moreenv(void)
4135 {
4136     int	    esize;
4137     char    **env;
4138 
4139     esize = envsize + EXTRASIZE;
4140     env = (char **)vim_realloc((char *)environ, esize * sizeof (*env));
4141     if (env == 0)
4142 	return -1;
4143     environ = env;
4144     envsize = esize;
4145     return 0;
4146 }
4147 
4148 # ifdef USE_VIMPTY_GETENV
4149 /*
4150  * Used for mch_getenv() for Mac.
4151  */
4152     char_u *
4153 vimpty_getenv(const char_u *string)
4154 {
4155     int i;
4156     char_u *p;
4157 
4158     if (envsize < 0)
4159 	return NULL;
4160 
4161     i = findenv((char *)string);
4162 
4163     if (i < 0)
4164 	return NULL;
4165 
4166     p = vim_strchr((char_u *)environ[i], '=');
4167     return (p + 1);
4168 }
4169 # endif
4170 
4171 #endif /* !defined(HAVE_SETENV) && !defined(HAVE_PUTENV) */
4172 
4173 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
4174 /*
4175  * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
4176  * rights to write into.
4177  */
4178     int
4179 filewritable(char_u *fname)
4180 {
4181     int		retval = 0;
4182 #if defined(UNIX) || defined(VMS)
4183     int		perm = 0;
4184 #endif
4185 
4186 #if defined(UNIX) || defined(VMS)
4187     perm = mch_getperm(fname);
4188 #endif
4189     if (
4190 # ifdef MSWIN
4191 	    mch_writable(fname) &&
4192 # else
4193 # if defined(UNIX) || defined(VMS)
4194 	    (perm & 0222) &&
4195 #  endif
4196 # endif
4197 	    mch_access((char *)fname, W_OK) == 0
4198        )
4199     {
4200 	++retval;
4201 	if (mch_isdir(fname))
4202 	    ++retval;
4203     }
4204     return retval;
4205 }
4206 #endif
4207 
4208 #if defined(FEAT_SPELL) || defined(FEAT_PERSISTENT_UNDO) || defined(PROTO)
4209 /*
4210  * Read 2 bytes from "fd" and turn them into an int, MSB first.
4211  * Returns -1 when encountering EOF.
4212  */
4213     int
4214 get2c(FILE *fd)
4215 {
4216     int		c, n;
4217 
4218     n = getc(fd);
4219     if (n == EOF) return -1;
4220     c = getc(fd);
4221     if (c == EOF) return -1;
4222     return (n << 8) + c;
4223 }
4224 
4225 /*
4226  * Read 3 bytes from "fd" and turn them into an int, MSB first.
4227  * Returns -1 when encountering EOF.
4228  */
4229     int
4230 get3c(FILE *fd)
4231 {
4232     int		c, n;
4233 
4234     n = getc(fd);
4235     if (n == EOF) return -1;
4236     c = getc(fd);
4237     if (c == EOF) return -1;
4238     n = (n << 8) + c;
4239     c = getc(fd);
4240     if (c == EOF) return -1;
4241     return (n << 8) + c;
4242 }
4243 
4244 /*
4245  * Read 4 bytes from "fd" and turn them into an int, MSB first.
4246  * Returns -1 when encountering EOF.
4247  */
4248     int
4249 get4c(FILE *fd)
4250 {
4251     int		c;
4252     /* Use unsigned rather than int otherwise result is undefined
4253      * when left-shift sets the MSB. */
4254     unsigned	n;
4255 
4256     c = getc(fd);
4257     if (c == EOF) return -1;
4258     n = (unsigned)c;
4259     c = getc(fd);
4260     if (c == EOF) return -1;
4261     n = (n << 8) + (unsigned)c;
4262     c = getc(fd);
4263     if (c == EOF) return -1;
4264     n = (n << 8) + (unsigned)c;
4265     c = getc(fd);
4266     if (c == EOF) return -1;
4267     n = (n << 8) + (unsigned)c;
4268     return (int)n;
4269 }
4270 
4271 /*
4272  * Read 8 bytes from "fd" and turn them into a time_T, MSB first.
4273  * Returns -1 when encountering EOF.
4274  */
4275     time_T
4276 get8ctime(FILE *fd)
4277 {
4278     int		c;
4279     time_T	n = 0;
4280     int		i;
4281 
4282     for (i = 0; i < 8; ++i)
4283     {
4284 	c = getc(fd);
4285 	if (c == EOF) return -1;
4286 	n = (n << 8) + c;
4287     }
4288     return n;
4289 }
4290 
4291 /*
4292  * Read a string of length "cnt" from "fd" into allocated memory.
4293  * Returns NULL when out of memory or unable to read that many bytes.
4294  */
4295     char_u *
4296 read_string(FILE *fd, int cnt)
4297 {
4298     char_u	*str;
4299     int		i;
4300     int		c;
4301 
4302     /* allocate memory */
4303     str = alloc((unsigned)cnt + 1);
4304     if (str != NULL)
4305     {
4306 	/* Read the string.  Quit when running into the EOF. */
4307 	for (i = 0; i < cnt; ++i)
4308 	{
4309 	    c = getc(fd);
4310 	    if (c == EOF)
4311 	    {
4312 		vim_free(str);
4313 		return NULL;
4314 	    }
4315 	    str[i] = c;
4316 	}
4317 	str[i] = NUL;
4318     }
4319     return str;
4320 }
4321 
4322 /*
4323  * Write a number to file "fd", MSB first, in "len" bytes.
4324  */
4325     int
4326 put_bytes(FILE *fd, long_u nr, int len)
4327 {
4328     int	    i;
4329 
4330     for (i = len - 1; i >= 0; --i)
4331 	if (putc((int)(nr >> (i * 8)), fd) == EOF)
4332 	    return FAIL;
4333     return OK;
4334 }
4335 
4336 #ifdef _MSC_VER
4337 # if (_MSC_VER <= 1200)
4338 /* This line is required for VC6 without the service pack.  Also see the
4339  * matching #pragma below. */
4340  #  pragma optimize("", off)
4341 # endif
4342 #endif
4343 
4344 /*
4345  * Write time_T to file "fd" in 8 bytes.
4346  * Returns FAIL when the write failed.
4347  */
4348     int
4349 put_time(FILE *fd, time_T the_time)
4350 {
4351     char_u	buf[8];
4352 
4353     time_to_bytes(the_time, buf);
4354     return fwrite(buf, (size_t)8, (size_t)1, fd) == 1 ? OK : FAIL;
4355 }
4356 
4357 /*
4358  * Write time_T to "buf[8]".
4359  */
4360     void
4361 time_to_bytes(time_T the_time, char_u *buf)
4362 {
4363     int		c;
4364     int		i;
4365     int		bi = 0;
4366     time_T	wtime = the_time;
4367 
4368     /* time_T can be up to 8 bytes in size, more than long_u, thus we
4369      * can't use put_bytes() here.
4370      * Another problem is that ">>" may do an arithmetic shift that keeps the
4371      * sign.  This happens for large values of wtime.  A cast to long_u may
4372      * truncate if time_T is 8 bytes.  So only use a cast when it is 4 bytes,
4373      * it's safe to assume that long_u is 4 bytes or more and when using 8
4374      * bytes the top bit won't be set. */
4375     for (i = 7; i >= 0; --i)
4376     {
4377 	if (i + 1 > (int)sizeof(time_T))
4378 	    /* ">>" doesn't work well when shifting more bits than avail */
4379 	    buf[bi++] = 0;
4380 	else
4381 	{
4382 #if defined(SIZEOF_TIME_T) && SIZEOF_TIME_T > 4
4383 	    c = (int)(wtime >> (i * 8));
4384 #else
4385 	    c = (int)((long_u)wtime >> (i * 8));
4386 #endif
4387 	    buf[bi++] = c;
4388 	}
4389     }
4390 }
4391 
4392 #ifdef _MSC_VER
4393 # if (_MSC_VER <= 1200)
4394  #  pragma optimize("", on)
4395 # endif
4396 #endif
4397 
4398 #endif
4399 
4400 #if defined(FEAT_QUICKFIX) || defined(FEAT_SPELL) || defined(PROTO)
4401 /*
4402  * Return TRUE if string "s" contains a non-ASCII character (128 or higher).
4403  * When "s" is NULL FALSE is returned.
4404  */
4405     int
4406 has_non_ascii(char_u *s)
4407 {
4408     char_u	*p;
4409 
4410     if (s != NULL)
4411 	for (p = s; *p != NUL; ++p)
4412 	    if (*p >= 128)
4413 		return TRUE;
4414     return FALSE;
4415 }
4416 #endif
4417 
4418 #if defined(MESSAGE_QUEUE) || defined(PROTO)
4419 # define MAX_REPEAT_PARSE 8
4420 
4421 /*
4422  * Process messages that have been queued for netbeans or clientserver.
4423  * Also check if any jobs have ended.
4424  * These functions can call arbitrary vimscript and should only be called when
4425  * it is safe to do so.
4426  */
4427     void
4428 parse_queued_messages(void)
4429 {
4430     win_T   *old_curwin = curwin;
4431     int	    i;
4432 
4433     // Do not handle messages while redrawing, because it may cause buffers to
4434     // change or be wiped while they are being redrawn.
4435     if (updating_screen)
4436 	return;
4437 
4438     // Loop when a job ended, but don't keep looping forever.
4439     for (i = 0; i < MAX_REPEAT_PARSE; ++i)
4440     {
4441 	// For Win32 mch_breakcheck() does not check for input, do it here.
4442 # if defined(MSWIN) && defined(FEAT_JOB_CHANNEL)
4443 	channel_handle_events(FALSE);
4444 # endif
4445 
4446 # ifdef FEAT_NETBEANS_INTG
4447 	// Process the queued netbeans messages.
4448 	netbeans_parse_messages();
4449 # endif
4450 # ifdef FEAT_JOB_CHANNEL
4451 	// Write any buffer lines still to be written.
4452 	channel_write_any_lines();
4453 
4454 	// Process the messages queued on channels.
4455 	channel_parse_messages();
4456 # endif
4457 # if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
4458 	// Process the queued clientserver messages.
4459 	server_parse_messages();
4460 # endif
4461 # ifdef FEAT_JOB_CHANNEL
4462 	// Check if any jobs have ended.  If so, repeat the above to handle
4463 	// changes, e.g. stdin may have been closed.
4464 	if (job_check_ended())
4465 	    continue;
4466 # endif
4467 # ifdef FEAT_TERMINAL
4468 	free_unused_terminals();
4469 # endif
4470 	break;
4471     }
4472 
4473     // If the current window changed we need to bail out of the waiting loop.
4474     // E.g. when a job exit callback closes the terminal window.
4475     if (curwin != old_curwin)
4476 	ins_char_typebuf(K_IGNORE);
4477 }
4478 #endif
4479 
4480 #ifndef PROTO  /* proto is defined in vim.h */
4481 # ifdef ELAPSED_TIMEVAL
4482 /*
4483  * Return time in msec since "start_tv".
4484  */
4485     long
4486 elapsed(struct timeval *start_tv)
4487 {
4488     struct timeval  now_tv;
4489 
4490     gettimeofday(&now_tv, NULL);
4491     return (now_tv.tv_sec - start_tv->tv_sec) * 1000L
4492 	 + (now_tv.tv_usec - start_tv->tv_usec) / 1000L;
4493 }
4494 # endif
4495 
4496 # ifdef ELAPSED_TICKCOUNT
4497 /*
4498  * Return time in msec since "start_tick".
4499  */
4500     long
4501 elapsed(DWORD start_tick)
4502 {
4503     DWORD	now = GetTickCount();
4504 
4505     return (long)now - (long)start_tick;
4506 }
4507 # endif
4508 #endif
4509 
4510 #if defined(FEAT_JOB_CHANNEL) \
4511 	|| (defined(UNIX) && (!defined(USE_SYSTEM) \
4512 	|| (defined(FEAT_GUI) && defined(FEAT_TERMINAL)))) \
4513 	|| defined(PROTO)
4514 /*
4515  * Parse "cmd" and put the white-separated parts in "argv".
4516  * "argv" is an allocated array with "argc" entries and room for 4 more.
4517  * Returns FAIL when out of memory.
4518  */
4519     int
4520 mch_parse_cmd(char_u *cmd, int use_shcf, char ***argv, int *argc)
4521 {
4522     int		i;
4523     char_u	*p, *d;
4524     int		inquote;
4525 
4526     /*
4527      * Do this loop twice:
4528      * 1: find number of arguments
4529      * 2: separate them and build argv[]
4530      */
4531     for (i = 0; i < 2; ++i)
4532     {
4533 	p = skipwhite(cmd);
4534 	inquote = FALSE;
4535 	*argc = 0;
4536 	for (;;)
4537 	{
4538 	    if (i == 1)
4539 		(*argv)[*argc] = (char *)p;
4540 	    ++*argc;
4541 	    d = p;
4542 	    while (*p != NUL && (inquote || (*p != ' ' && *p != TAB)))
4543 	    {
4544 		if (p[0] == '"')
4545 		    // quotes surrounding an argument and are dropped
4546 		    inquote = !inquote;
4547 		else
4548 		{
4549 		    if (rem_backslash(p))
4550 		    {
4551 			// First pass: skip over "\ " and "\"".
4552 			// Second pass: Remove the backslash.
4553 			++p;
4554 		    }
4555 		    if (i == 1)
4556 			*d++ = *p;
4557 		}
4558 		++p;
4559 	    }
4560 	    if (*p == NUL)
4561 	    {
4562 		if (i == 1)
4563 		    *d++ = NUL;
4564 		break;
4565 	    }
4566 	    if (i == 1)
4567 		*d++ = NUL;
4568 	    p = skipwhite(p + 1);
4569 	}
4570 	if (*argv == NULL)
4571 	{
4572 	    if (use_shcf)
4573 	    {
4574 		/* Account for possible multiple args in p_shcf. */
4575 		p = p_shcf;
4576 		for (;;)
4577 		{
4578 		    p = skiptowhite(p);
4579 		    if (*p == NUL)
4580 			break;
4581 		    ++*argc;
4582 		    p = skipwhite(p);
4583 		}
4584 	    }
4585 
4586 	    *argv = (char **)alloc((unsigned)((*argc + 4) * sizeof(char *)));
4587 	    if (*argv == NULL)	    /* out of memory */
4588 		return FAIL;
4589 	}
4590     }
4591     return OK;
4592 }
4593 
4594 # if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
4595 /*
4596  * Build "argv[argc]" from the string "cmd".
4597  * "argv[argc]" is set to NULL;
4598  * Return FAIL when out of memory.
4599  */
4600     int
4601 build_argv_from_string(char_u *cmd, char ***argv, int *argc)
4602 {
4603     char_u	*cmd_copy;
4604     int		i;
4605 
4606     /* Make a copy, parsing will modify "cmd". */
4607     cmd_copy = vim_strsave(cmd);
4608     if (cmd_copy == NULL
4609 	    || mch_parse_cmd(cmd_copy, FALSE, argv, argc) == FAIL)
4610     {
4611 	vim_free(cmd_copy);
4612 	return FAIL;
4613     }
4614     for (i = 0; i < *argc; i++)
4615 	(*argv)[i] = (char *)vim_strsave((char_u *)(*argv)[i]);
4616     (*argv)[*argc] = NULL;
4617     vim_free(cmd_copy);
4618     return OK;
4619 }
4620 
4621 /*
4622  * Build "argv[argc]" from the list "l".
4623  * "argv[argc]" is set to NULL;
4624  * Return FAIL when out of memory.
4625  */
4626     int
4627 build_argv_from_list(list_T *l, char ***argv, int *argc)
4628 {
4629     listitem_T  *li;
4630     char_u	*s;
4631 
4632     /* Pass argv[] to mch_call_shell(). */
4633     *argv = (char **)alloc(sizeof(char *) * (l->lv_len + 1));
4634     if (*argv == NULL)
4635 	return FAIL;
4636     *argc = 0;
4637     for (li = l->lv_first; li != NULL; li = li->li_next)
4638     {
4639 	s = tv_get_string_chk(&li->li_tv);
4640 	if (s == NULL)
4641 	{
4642 	    int i;
4643 
4644 	    for (i = 0; i < *argc; ++i)
4645 		vim_free((*argv)[i]);
4646 	    return FAIL;
4647 	}
4648 	(*argv)[*argc] = (char *)vim_strsave(s);
4649 	*argc += 1;
4650     }
4651     (*argv)[*argc] = NULL;
4652     return OK;
4653 }
4654 # endif
4655 #endif
4656 
4657 #if defined(FEAT_SESSION) || defined(PROTO)
4658 /*
4659  * Generate a script that can be used to restore the current editing session.
4660  * Save the value of v:this_session before running :mksession in order to make
4661  * automagic session save fully transparent.  Return TRUE on success.
4662  */
4663     int
4664 write_session_file(char_u *filename)
4665 {
4666     char_u	    *escaped_filename;
4667     char	    *mksession_cmdline;
4668     unsigned int    save_ssop_flags;
4669     int		    failed;
4670 
4671     /*
4672      * Build an ex command line to create a script that restores the current
4673      * session if executed.  Escape the filename to avoid nasty surprises.
4674      */
4675     escaped_filename = vim_strsave_escaped(filename, escape_chars);
4676     if (escaped_filename == NULL)
4677 	return FALSE;
4678     mksession_cmdline = (char *)alloc(10 + (int)STRLEN(escaped_filename) + 1);
4679     if (mksession_cmdline == NULL)
4680     {
4681 	vim_free(escaped_filename);
4682 	return FALSE;
4683     }
4684     strcpy(mksession_cmdline, "mksession ");
4685     STRCAT(mksession_cmdline, escaped_filename);
4686     vim_free(escaped_filename);
4687 
4688     /*
4689      * Use a reasonable hardcoded set of 'sessionoptions' flags to avoid
4690      * unpredictable effects when the session is saved automatically.  Also,
4691      * we definitely need SSOP_GLOBALS to be able to restore v:this_session.
4692      * Don't use SSOP_BUFFERS to prevent the buffer list from becoming
4693      * enormously large if the GNOME session feature is used regularly.
4694      */
4695     save_ssop_flags = ssop_flags;
4696     ssop_flags = (SSOP_BLANK|SSOP_CURDIR|SSOP_FOLDS|SSOP_GLOBALS
4697 		  |SSOP_HELP|SSOP_OPTIONS|SSOP_WINSIZE|SSOP_TABPAGES);
4698 
4699     do_cmdline_cmd((char_u *)"let Save_VV_this_session = v:this_session");
4700     failed = (do_cmdline_cmd((char_u *)mksession_cmdline) == FAIL);
4701     do_cmdline_cmd((char_u *)"let v:this_session = Save_VV_this_session");
4702     do_unlet((char_u *)"Save_VV_this_session", TRUE);
4703 
4704     ssop_flags = save_ssop_flags;
4705     vim_free(mksession_cmdline);
4706 
4707     /*
4708      * Reopen the file and append a command to restore v:this_session,
4709      * as if this save never happened.	This is to avoid conflicts with
4710      * the user's own sessions.  FIXME: It's probably less hackish to add
4711      * a "stealth" flag to 'sessionoptions' -- gotta ask Bram.
4712      */
4713     if (!failed)
4714     {
4715 	FILE *fd;
4716 
4717 	fd = open_exfile(filename, TRUE, APPENDBIN);
4718 
4719 	failed = (fd == NULL
4720 	       || put_line(fd, "let v:this_session = Save_VV_this_session") == FAIL
4721 	       || put_line(fd, "unlet Save_VV_this_session") == FAIL);
4722 
4723 	if (fd != NULL && fclose(fd) != 0)
4724 	    failed = TRUE;
4725 
4726 	if (failed)
4727 	    mch_remove(filename);
4728     }
4729 
4730     return !failed;
4731 }
4732 #endif
4733