xref: /vim-8.2.3635/src/misc1.c (revision 9faec4e3)
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  * misc1.c: functions that didn't seem to fit elsewhere
12  */
13 
14 #include "vim.h"
15 #include "version.h"
16 
17 #if defined(__HAIKU__)
18 # include <storage/FindDirectory.h>
19 #endif
20 
21 #if defined(MSWIN)
22 # include <lm.h>
23 #endif
24 
25 #define URL_SLASH	1		// path_is_url() has found "://"
26 #define URL_BACKSLASH	2		// path_is_url() has found ":\\"
27 
28 // All user names (for ~user completion as done by shell).
29 static garray_T	ga_users;
30 
31 /*
32  * get_leader_len() returns the length in bytes of the prefix of the given
33  * string which introduces a comment.  If this string is not a comment then
34  * 0 is returned.
35  * When "flags" is not NULL, it is set to point to the flags of the recognized
36  * comment leader.
37  * "backward" must be true for the "O" command.
38  * If "include_space" is set, include trailing whitespace while calculating the
39  * length.
40  */
41     int
42 get_leader_len(
43     char_u	*line,
44     char_u	**flags,
45     int		backward,
46     int		include_space)
47 {
48     int		i, j;
49     int		result;
50     int		got_com = FALSE;
51     int		found_one;
52     char_u	part_buf[COM_MAX_LEN];	// buffer for one option part
53     char_u	*string;		// pointer to comment string
54     char_u	*list;
55     int		middle_match_len = 0;
56     char_u	*prev_list;
57     char_u	*saved_flags = NULL;
58 
59     result = i = 0;
60     while (VIM_ISWHITE(line[i]))    // leading white space is ignored
61 	++i;
62 
63     /*
64      * Repeat to match several nested comment strings.
65      */
66     while (line[i] != NUL)
67     {
68 	/*
69 	 * scan through the 'comments' option for a match
70 	 */
71 	found_one = FALSE;
72 	for (list = curbuf->b_p_com; *list; )
73 	{
74 	    // Get one option part into part_buf[].  Advance "list" to next
75 	    // one.  Put "string" at start of string.
76 	    if (!got_com && flags != NULL)
77 		*flags = list;	    // remember where flags started
78 	    prev_list = list;
79 	    (void)copy_option_part(&list, part_buf, COM_MAX_LEN, ",");
80 	    string = vim_strchr(part_buf, ':');
81 	    if (string == NULL)	    // missing ':', ignore this part
82 		continue;
83 	    *string++ = NUL;	    // isolate flags from string
84 
85 	    // If we found a middle match previously, use that match when this
86 	    // is not a middle or end.
87 	    if (middle_match_len != 0
88 		    && vim_strchr(part_buf, COM_MIDDLE) == NULL
89 		    && vim_strchr(part_buf, COM_END) == NULL)
90 		break;
91 
92 	    // When we already found a nested comment, only accept further
93 	    // nested comments.
94 	    if (got_com && vim_strchr(part_buf, COM_NEST) == NULL)
95 		continue;
96 
97 	    // When 'O' flag present and using "O" command skip this one.
98 	    if (backward && vim_strchr(part_buf, COM_NOBACK) != NULL)
99 		continue;
100 
101 	    // Line contents and string must match.
102 	    // When string starts with white space, must have some white space
103 	    // (but the amount does not need to match, there might be a mix of
104 	    // TABs and spaces).
105 	    if (VIM_ISWHITE(string[0]))
106 	    {
107 		if (i == 0 || !VIM_ISWHITE(line[i - 1]))
108 		    continue;  // missing white space
109 		while (VIM_ISWHITE(string[0]))
110 		    ++string;
111 	    }
112 	    for (j = 0; string[j] != NUL && string[j] == line[i + j]; ++j)
113 		;
114 	    if (string[j] != NUL)
115 		continue;  // string doesn't match
116 
117 	    // When 'b' flag used, there must be white space or an
118 	    // end-of-line after the string in the line.
119 	    if (vim_strchr(part_buf, COM_BLANK) != NULL
120 			   && !VIM_ISWHITE(line[i + j]) && line[i + j] != NUL)
121 		continue;
122 
123 	    // We have found a match, stop searching unless this is a middle
124 	    // comment. The middle comment can be a substring of the end
125 	    // comment in which case it's better to return the length of the
126 	    // end comment and its flags.  Thus we keep searching with middle
127 	    // and end matches and use an end match if it matches better.
128 	    if (vim_strchr(part_buf, COM_MIDDLE) != NULL)
129 	    {
130 		if (middle_match_len == 0)
131 		{
132 		    middle_match_len = j;
133 		    saved_flags = prev_list;
134 		}
135 		continue;
136 	    }
137 	    if (middle_match_len != 0 && j > middle_match_len)
138 		// Use this match instead of the middle match, since it's a
139 		// longer thus better match.
140 		middle_match_len = 0;
141 
142 	    if (middle_match_len == 0)
143 		i += j;
144 	    found_one = TRUE;
145 	    break;
146 	}
147 
148 	if (middle_match_len != 0)
149 	{
150 	    // Use the previously found middle match after failing to find a
151 	    // match with an end.
152 	    if (!got_com && flags != NULL)
153 		*flags = saved_flags;
154 	    i += middle_match_len;
155 	    found_one = TRUE;
156 	}
157 
158 	// No match found, stop scanning.
159 	if (!found_one)
160 	    break;
161 
162 	result = i;
163 
164 	// Include any trailing white space.
165 	while (VIM_ISWHITE(line[i]))
166 	    ++i;
167 
168 	if (include_space)
169 	    result = i;
170 
171 	// If this comment doesn't nest, stop here.
172 	got_com = TRUE;
173 	if (vim_strchr(part_buf, COM_NEST) == NULL)
174 	    break;
175     }
176     return result;
177 }
178 
179 /*
180  * Return the offset at which the last comment in line starts. If there is no
181  * comment in the whole line, -1 is returned.
182  *
183  * When "flags" is not null, it is set to point to the flags describing the
184  * recognized comment leader.
185  */
186     int
187 get_last_leader_offset(char_u *line, char_u **flags)
188 {
189     int		result = -1;
190     int		i, j;
191     int		lower_check_bound = 0;
192     char_u	*string;
193     char_u	*com_leader;
194     char_u	*com_flags;
195     char_u	*list;
196     int		found_one;
197     char_u	part_buf[COM_MAX_LEN];	// buffer for one option part
198 
199     /*
200      * Repeat to match several nested comment strings.
201      */
202     i = (int)STRLEN(line);
203     while (--i >= lower_check_bound)
204     {
205 	/*
206 	 * scan through the 'comments' option for a match
207 	 */
208 	found_one = FALSE;
209 	for (list = curbuf->b_p_com; *list; )
210 	{
211 	    char_u *flags_save = list;
212 
213 	    /*
214 	     * Get one option part into part_buf[].  Advance list to next one.
215 	     * put string at start of string.
216 	     */
217 	    (void)copy_option_part(&list, part_buf, COM_MAX_LEN, ",");
218 	    string = vim_strchr(part_buf, ':');
219 	    if (string == NULL)	// If everything is fine, this cannot actually
220 				// happen.
221 		continue;
222 	    *string++ = NUL;	// Isolate flags from string.
223 	    com_leader = string;
224 
225 	    /*
226 	     * Line contents and string must match.
227 	     * When string starts with white space, must have some white space
228 	     * (but the amount does not need to match, there might be a mix of
229 	     * TABs and spaces).
230 	     */
231 	    if (VIM_ISWHITE(string[0]))
232 	    {
233 		if (i == 0 || !VIM_ISWHITE(line[i - 1]))
234 		    continue;
235 		while (VIM_ISWHITE(*string))
236 		    ++string;
237 	    }
238 	    for (j = 0; string[j] != NUL && string[j] == line[i + j]; ++j)
239 		/* do nothing */;
240 	    if (string[j] != NUL)
241 		continue;
242 
243 	    /*
244 	     * When 'b' flag used, there must be white space or an
245 	     * end-of-line after the string in the line.
246 	     */
247 	    if (vim_strchr(part_buf, COM_BLANK) != NULL
248 		    && !VIM_ISWHITE(line[i + j]) && line[i + j] != NUL)
249 		continue;
250 
251 	    if (vim_strchr(part_buf, COM_MIDDLE) != NULL)
252 	    {
253 		// For a middlepart comment, only consider it to match if
254 		// everything before the current position in the line is
255 		// whitespace.  Otherwise we would think we are inside a
256 		// comment if the middle part appears somewhere in the middle
257 		// of the line.  E.g. for C the "*" appears often.
258 		for (j = 0; VIM_ISWHITE(line[j]) && j <= i; j++)
259 		    ;
260 		if (j < i)
261 		    continue;
262 	    }
263 
264 	    /*
265 	     * We have found a match, stop searching.
266 	     */
267 	    found_one = TRUE;
268 
269 	    if (flags)
270 		*flags = flags_save;
271 	    com_flags = flags_save;
272 
273 	    break;
274 	}
275 
276 	if (found_one)
277 	{
278 	    char_u  part_buf2[COM_MAX_LEN];	// buffer for one option part
279 	    int     len1, len2, off;
280 
281 	    result = i;
282 	    /*
283 	     * If this comment nests, continue searching.
284 	     */
285 	    if (vim_strchr(part_buf, COM_NEST) != NULL)
286 		continue;
287 
288 	    lower_check_bound = i;
289 
290 	    // Let's verify whether the comment leader found is a substring
291 	    // of other comment leaders. If it is, let's adjust the
292 	    // lower_check_bound so that we make sure that we have determined
293 	    // the comment leader correctly.
294 
295 	    while (VIM_ISWHITE(*com_leader))
296 		++com_leader;
297 	    len1 = (int)STRLEN(com_leader);
298 
299 	    for (list = curbuf->b_p_com; *list; )
300 	    {
301 		char_u *flags_save = list;
302 
303 		(void)copy_option_part(&list, part_buf2, COM_MAX_LEN, ",");
304 		if (flags_save == com_flags)
305 		    continue;
306 		string = vim_strchr(part_buf2, ':');
307 		++string;
308 		while (VIM_ISWHITE(*string))
309 		    ++string;
310 		len2 = (int)STRLEN(string);
311 		if (len2 == 0)
312 		    continue;
313 
314 		// Now we have to verify whether string ends with a substring
315 		// beginning the com_leader.
316 		for (off = (len2 > i ? i : len2); off > 0 && off + len1 > len2;)
317 		{
318 		    --off;
319 		    if (!STRNCMP(string + off, com_leader, len2 - off))
320 		    {
321 			if (i - off < lower_check_bound)
322 			    lower_check_bound = i - off;
323 		    }
324 		}
325 	    }
326 	}
327     }
328     return result;
329 }
330 
331 /*
332  * Return the number of window lines occupied by buffer line "lnum".
333  */
334     int
335 plines(linenr_T lnum)
336 {
337     return plines_win(curwin, lnum, TRUE);
338 }
339 
340     int
341 plines_win(
342     win_T	*wp,
343     linenr_T	lnum,
344     int		winheight)	// when TRUE limit to window height
345 {
346 #if defined(FEAT_DIFF) || defined(PROTO)
347     // Check for filler lines above this buffer line.  When folded the result
348     // is one line anyway.
349     return plines_win_nofill(wp, lnum, winheight) + diff_check_fill(wp, lnum);
350 }
351 
352     int
353 plines_nofill(linenr_T lnum)
354 {
355     return plines_win_nofill(curwin, lnum, TRUE);
356 }
357 
358     int
359 plines_win_nofill(
360     win_T	*wp,
361     linenr_T	lnum,
362     int		winheight)	// when TRUE limit to window height
363 {
364 #endif
365     int		lines;
366 
367     if (!wp->w_p_wrap)
368 	return 1;
369 
370     if (wp->w_width == 0)
371 	return 1;
372 
373 #ifdef FEAT_FOLDING
374     // A folded lines is handled just like an empty line.
375     // NOTE: Caller must handle lines that are MAYBE folded.
376     if (lineFolded(wp, lnum) == TRUE)
377 	return 1;
378 #endif
379 
380     lines = plines_win_nofold(wp, lnum);
381     if (winheight > 0 && lines > wp->w_height)
382 	return (int)wp->w_height;
383     return lines;
384 }
385 
386 /*
387  * Return number of window lines physical line "lnum" will occupy in window
388  * "wp".  Does not care about folding, 'wrap' or 'diff'.
389  */
390     int
391 plines_win_nofold(win_T *wp, linenr_T lnum)
392 {
393     char_u	*s;
394     long	col;
395     int		width;
396 
397     s = ml_get_buf(wp->w_buffer, lnum, FALSE);
398     if (*s == NUL)		// empty line
399 	return 1;
400     col = win_linetabsize(wp, s, (colnr_T)MAXCOL);
401 
402     /*
403      * If list mode is on, then the '$' at the end of the line may take up one
404      * extra column.
405      */
406     if (wp->w_p_list && wp->w_lcs_chars.eol != NUL)
407 	col += 1;
408 
409     /*
410      * Add column offset for 'number', 'relativenumber' and 'foldcolumn'.
411      */
412     width = wp->w_width - win_col_off(wp);
413     if (width <= 0)
414 	return 32000;
415     if (col <= width)
416 	return 1;
417     col -= width;
418     width += win_col_off2(wp);
419     return (col + (width - 1)) / width + 1;
420 }
421 
422 /*
423  * Like plines_win(), but only reports the number of physical screen lines
424  * used from the start of the line to the given column number.
425  */
426     int
427 plines_win_col(win_T *wp, linenr_T lnum, long column)
428 {
429     long	col;
430     char_u	*s;
431     int		lines = 0;
432     int		width;
433     char_u	*line;
434 
435 #ifdef FEAT_DIFF
436     // Check for filler lines above this buffer line.  When folded the result
437     // is one line anyway.
438     lines = diff_check_fill(wp, lnum);
439 #endif
440 
441     if (!wp->w_p_wrap)
442 	return lines + 1;
443 
444     if (wp->w_width == 0)
445 	return lines + 1;
446 
447     line = s = ml_get_buf(wp->w_buffer, lnum, FALSE);
448 
449     col = 0;
450     while (*s != NUL && --column >= 0)
451     {
452 	col += win_lbr_chartabsize(wp, line, s, (colnr_T)col, NULL);
453 	MB_PTR_ADV(s);
454     }
455 
456     /*
457      * If *s is a TAB, and the TAB is not displayed as ^I, and we're not in
458      * INSERT mode, then col must be adjusted so that it represents the last
459      * screen position of the TAB.  This only fixes an error when the TAB wraps
460      * from one screen line to the next (when 'columns' is not a multiple of
461      * 'ts') -- webb.
462      */
463     if (*s == TAB && (State & NORMAL) && (!wp->w_p_list ||
464 							wp->w_lcs_chars.tab1))
465 	col += win_lbr_chartabsize(wp, line, s, (colnr_T)col, NULL) - 1;
466 
467     /*
468      * Add column offset for 'number', 'relativenumber', 'foldcolumn', etc.
469      */
470     width = wp->w_width - win_col_off(wp);
471     if (width <= 0)
472 	return 9999;
473 
474     lines += 1;
475     if (col > width)
476 	lines += (col - width) / (width + win_col_off2(wp)) + 1;
477     return lines;
478 }
479 
480     int
481 plines_m_win(win_T *wp, linenr_T first, linenr_T last)
482 {
483     int		count = 0;
484 
485     while (first <= last)
486     {
487 #ifdef FEAT_FOLDING
488 	int	x;
489 
490 	// Check if there are any really folded lines, but also included lines
491 	// that are maybe folded.
492 	x = foldedCount(wp, first, NULL);
493 	if (x > 0)
494 	{
495 	    ++count;	    // count 1 for "+-- folded" line
496 	    first += x;
497 	}
498 	else
499 #endif
500 	{
501 #ifdef FEAT_DIFF
502 	    if (first == wp->w_topline)
503 		count += plines_win_nofill(wp, first, TRUE) + wp->w_topfill;
504 	    else
505 #endif
506 		count += plines_win(wp, first, TRUE);
507 	    ++first;
508 	}
509     }
510     return (count);
511 }
512 
513     int
514 gchar_pos(pos_T *pos)
515 {
516     char_u	*ptr;
517 
518     // When searching columns is sometimes put at the end of a line.
519     if (pos->col == MAXCOL)
520 	return NUL;
521     ptr = ml_get_pos(pos);
522     if (has_mbyte)
523 	return (*mb_ptr2char)(ptr);
524     return (int)*ptr;
525 }
526 
527     int
528 gchar_cursor(void)
529 {
530     if (has_mbyte)
531 	return (*mb_ptr2char)(ml_get_cursor());
532     return (int)*ml_get_cursor();
533 }
534 
535 /*
536  * Write a character at the current cursor position.
537  * It is directly written into the block.
538  */
539     void
540 pchar_cursor(int c)
541 {
542     *(ml_get_buf(curbuf, curwin->w_cursor.lnum, TRUE)
543 						  + curwin->w_cursor.col) = c;
544 }
545 
546 /*
547  * Skip to next part of an option argument: Skip space and comma.
548  */
549     char_u *
550 skip_to_option_part(char_u *p)
551 {
552     if (*p == ',')
553 	++p;
554     while (*p == ' ')
555 	++p;
556     return p;
557 }
558 
559 /*
560  * check_status: called when the status bars for the buffer 'buf'
561  *		 need to be updated
562  */
563     void
564 check_status(buf_T *buf)
565 {
566     win_T	*wp;
567 
568     FOR_ALL_WINDOWS(wp)
569 	if (wp->w_buffer == buf && wp->w_status_height)
570 	{
571 	    wp->w_redr_status = TRUE;
572 	    if (must_redraw < VALID)
573 		must_redraw = VALID;
574 	}
575 }
576 
577 /*
578  * Ask for a reply from the user, a 'y' or a 'n'.
579  * No other characters are accepted, the message is repeated until a valid
580  * reply is entered or CTRL-C is hit.
581  * If direct is TRUE, don't use vgetc() but ui_inchar(), don't get characters
582  * from any buffers but directly from the user.
583  *
584  * return the 'y' or 'n'
585  */
586     int
587 ask_yesno(char_u *str, int direct)
588 {
589     int	    r = ' ';
590     int	    save_State = State;
591 
592     if (exiting)		// put terminal in raw mode for this question
593 	settmode(TMODE_RAW);
594     ++no_wait_return;
595 #ifdef USE_ON_FLY_SCROLL
596     dont_scroll = TRUE;		// disallow scrolling here
597 #endif
598     State = CONFIRM;		// mouse behaves like with :confirm
599     setmouse();			// disables mouse for xterm
600     ++no_mapping;
601     ++allow_keys;		// no mapping here, but recognize keys
602 
603     while (r != 'y' && r != 'n')
604     {
605 	// same highlighting as for wait_return
606 	smsg_attr(HL_ATTR(HLF_R), "%s (y/n)?", str);
607 	if (direct)
608 	    r = get_keystroke();
609 	else
610 	    r = plain_vgetc();
611 	if (r == Ctrl_C || r == ESC)
612 	    r = 'n';
613 	msg_putchar(r);	    // show what you typed
614 	out_flush();
615     }
616     --no_wait_return;
617     State = save_State;
618     setmouse();
619     --no_mapping;
620     --allow_keys;
621 
622     return r;
623 }
624 
625 #if defined(FEAT_EVAL) || defined(PROTO)
626 
627 /*
628  * "mode()" function
629  */
630     void
631 f_mode(typval_T *argvars, typval_T *rettv)
632 {
633     char_u	buf[4];
634 
635     CLEAR_FIELD(buf);
636 
637     if (time_for_testing == 93784)
638     {
639 	// Testing the two-character code.
640 	buf[0] = 'x';
641 	buf[1] = '!';
642     }
643 #ifdef FEAT_TERMINAL
644     else if (term_use_loop())
645 	buf[0] = 't';
646 #endif
647     else if (VIsual_active)
648     {
649 	if (VIsual_select)
650 	    buf[0] = VIsual_mode + 's' - 'v';
651 	else
652 	    buf[0] = VIsual_mode;
653     }
654     else if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
655 		|| State == CONFIRM)
656     {
657 	buf[0] = 'r';
658 	if (State == ASKMORE)
659 	    buf[1] = 'm';
660 	else if (State == CONFIRM)
661 	    buf[1] = '?';
662     }
663     else if (State == EXTERNCMD)
664 	buf[0] = '!';
665     else if (State & INSERT)
666     {
667 	if (State & VREPLACE_FLAG)
668 	{
669 	    buf[0] = 'R';
670 	    buf[1] = 'v';
671 	}
672 	else
673 	{
674 	    if (State & REPLACE_FLAG)
675 		buf[0] = 'R';
676 	    else
677 		buf[0] = 'i';
678 	    if (ins_compl_active())
679 		buf[1] = 'c';
680 	    else if (ctrl_x_mode_not_defined_yet())
681 		buf[1] = 'x';
682 	}
683     }
684     else if ((State & CMDLINE) || exmode_active)
685     {
686 	buf[0] = 'c';
687 	if (exmode_active == EXMODE_VIM)
688 	    buf[1] = 'v';
689 	else if (exmode_active == EXMODE_NORMAL)
690 	    buf[1] = 'e';
691     }
692     else
693     {
694 	buf[0] = 'n';
695 	if (finish_op)
696 	{
697 	    buf[1] = 'o';
698 	    // to be able to detect force-linewise/blockwise/characterwise operations
699 	    buf[2] = motion_force;
700 	}
701 	else if (restart_edit == 'I' || restart_edit == 'R'
702 							|| restart_edit == 'V')
703 	{
704 	    buf[1] = 'i';
705 	    buf[2] = restart_edit;
706 	}
707     }
708 
709     // Clear out the minor mode when the argument is not a non-zero number or
710     // non-empty string.
711     if (!non_zero_arg(&argvars[0]))
712 	buf[1] = NUL;
713 
714     rettv->vval.v_string = vim_strsave(buf);
715     rettv->v_type = VAR_STRING;
716 }
717 
718     static void
719 may_add_state_char(garray_T *gap, char_u *include, int c)
720 {
721     if (include == NULL || vim_strchr(include, c) != NULL)
722 	ga_append(gap, c);
723 }
724 
725 /*
726  * "state()" function
727  */
728     void
729 f_state(typval_T *argvars, typval_T *rettv)
730 {
731     garray_T	ga;
732     char_u	*include = NULL;
733     int		i;
734 
735     ga_init2(&ga, 1, 20);
736     if (argvars[0].v_type != VAR_UNKNOWN)
737 	include = tv_get_string(&argvars[0]);
738 
739     if (!(stuff_empty() && typebuf.tb_len == 0 && scriptin[curscript] == NULL))
740 	may_add_state_char(&ga, include, 'm');
741     if (op_pending())
742 	may_add_state_char(&ga, include, 'o');
743     if (autocmd_busy)
744 	may_add_state_char(&ga, include, 'x');
745     if (ins_compl_active())
746 	may_add_state_char(&ga, include, 'a');
747 
748 # ifdef FEAT_JOB_CHANNEL
749     if (channel_in_blocking_wait())
750 	may_add_state_char(&ga, include, 'w');
751 # endif
752     if (!get_was_safe_state())
753 	may_add_state_char(&ga, include, 'S');
754     for (i = 0; i < get_callback_depth() && i < 3; ++i)
755 	may_add_state_char(&ga, include, 'c');
756     if (msg_scrolled > 0)
757 	may_add_state_char(&ga, include, 's');
758 
759     rettv->v_type = VAR_STRING;
760     rettv->vval.v_string = ga.ga_data;
761 }
762 
763 #endif // FEAT_EVAL
764 
765 /*
766  * Get a key stroke directly from the user.
767  * Ignores mouse clicks and scrollbar events, except a click for the left
768  * button (used at the more prompt).
769  * Doesn't use vgetc(), because it syncs undo and eats mapped characters.
770  * Disadvantage: typeahead is ignored.
771  * Translates the interrupt character for unix to ESC.
772  */
773     int
774 get_keystroke(void)
775 {
776     char_u	*buf = NULL;
777     int		buflen = 150;
778     int		maxlen;
779     int		len = 0;
780     int		n;
781     int		save_mapped_ctrl_c = mapped_ctrl_c;
782     int		waited = 0;
783 
784     mapped_ctrl_c = FALSE;	// mappings are not used here
785     for (;;)
786     {
787 	cursor_on();
788 	out_flush();
789 
790 	// Leave some room for check_termcode() to insert a key code into (max
791 	// 5 chars plus NUL).  And fix_input_buffer() can triple the number of
792 	// bytes.
793 	maxlen = (buflen - 6 - len) / 3;
794 	if (buf == NULL)
795 	    buf = alloc(buflen);
796 	else if (maxlen < 10)
797 	{
798 	    char_u  *t_buf = buf;
799 
800 	    // Need some more space. This might happen when receiving a long
801 	    // escape sequence.
802 	    buflen += 100;
803 	    buf = vim_realloc(buf, buflen);
804 	    if (buf == NULL)
805 		vim_free(t_buf);
806 	    maxlen = (buflen - 6 - len) / 3;
807 	}
808 	if (buf == NULL)
809 	{
810 	    do_outofmem_msg((long_u)buflen);
811 	    return ESC;  // panic!
812 	}
813 
814 	// First time: blocking wait.  Second time: wait up to 100ms for a
815 	// terminal code to complete.
816 	n = ui_inchar(buf + len, maxlen, len == 0 ? -1L : 100L, 0);
817 	if (n > 0)
818 	{
819 	    // Replace zero and CSI by a special key code.
820 	    n = fix_input_buffer(buf + len, n);
821 	    len += n;
822 	    waited = 0;
823 	}
824 	else if (len > 0)
825 	    ++waited;	    // keep track of the waiting time
826 
827 	// Incomplete termcode and not timed out yet: get more characters
828 	if ((n = check_termcode(1, buf, buflen, &len)) < 0
829 	       && (!p_ttimeout || waited * 100L < (p_ttm < 0 ? p_tm : p_ttm)))
830 	    continue;
831 
832 	if (n == KEYLEN_REMOVED)  // key code removed
833 	{
834 	    if (must_redraw != 0 && !need_wait_return && (State & CMDLINE) == 0)
835 	    {
836 		// Redrawing was postponed, do it now.
837 		update_screen(0);
838 		setcursor(); // put cursor back where it belongs
839 	    }
840 	    continue;
841 	}
842 	if (n > 0)		// found a termcode: adjust length
843 	    len = n;
844 	if (len == 0)		// nothing typed yet
845 	    continue;
846 
847 	// Handle modifier and/or special key code.
848 	n = buf[0];
849 	if (n == K_SPECIAL)
850 	{
851 	    n = TO_SPECIAL(buf[1], buf[2]);
852 	    if (buf[1] == KS_MODIFIER
853 		    || n == K_IGNORE
854 		    || (is_mouse_key(n) && n != K_LEFTMOUSE)
855 #ifdef FEAT_GUI
856 		    || n == K_VER_SCROLLBAR
857 		    || n == K_HOR_SCROLLBAR
858 #endif
859 	       )
860 	    {
861 		if (buf[1] == KS_MODIFIER)
862 		    mod_mask = buf[2];
863 		len -= 3;
864 		if (len > 0)
865 		    mch_memmove(buf, buf + 3, (size_t)len);
866 		continue;
867 	    }
868 	    break;
869 	}
870 	if (has_mbyte)
871 	{
872 	    if (MB_BYTE2LEN(n) > len)
873 		continue;	// more bytes to get
874 	    buf[len >= buflen ? buflen - 1 : len] = NUL;
875 	    n = (*mb_ptr2char)(buf);
876 	}
877 #ifdef UNIX
878 	if (n == intr_char)
879 	    n = ESC;
880 #endif
881 	break;
882     }
883     vim_free(buf);
884 
885     mapped_ctrl_c = save_mapped_ctrl_c;
886     return n;
887 }
888 
889 /*
890  * Get a number from the user.
891  * When "mouse_used" is not NULL allow using the mouse.
892  */
893     int
894 get_number(
895     int	    colon,			// allow colon to abort
896     int	    *mouse_used)
897 {
898     int	n = 0;
899     int	c;
900     int typed = 0;
901 
902     if (mouse_used != NULL)
903 	*mouse_used = FALSE;
904 
905     // When not printing messages, the user won't know what to type, return a
906     // zero (as if CR was hit).
907     if (msg_silent != 0)
908 	return 0;
909 
910 #ifdef USE_ON_FLY_SCROLL
911     dont_scroll = TRUE;		// disallow scrolling here
912 #endif
913     ++no_mapping;
914     ++allow_keys;		// no mapping here, but recognize keys
915     for (;;)
916     {
917 	windgoto(msg_row, msg_col);
918 	c = safe_vgetc();
919 	if (VIM_ISDIGIT(c))
920 	{
921 	    n = n * 10 + c - '0';
922 	    msg_putchar(c);
923 	    ++typed;
924 	}
925 	else if (c == K_DEL || c == K_KDEL || c == K_BS || c == Ctrl_H)
926 	{
927 	    if (typed > 0)
928 	    {
929 		msg_puts("\b \b");
930 		--typed;
931 	    }
932 	    n /= 10;
933 	}
934 	else if (mouse_used != NULL && c == K_LEFTMOUSE)
935 	{
936 	    *mouse_used = TRUE;
937 	    n = mouse_row + 1;
938 	    break;
939 	}
940 	else if (n == 0 && c == ':' && colon)
941 	{
942 	    stuffcharReadbuff(':');
943 	    if (!exmode_active)
944 		cmdline_row = msg_row;
945 	    skip_redraw = TRUE;	    // skip redraw once
946 	    do_redraw = FALSE;
947 	    break;
948 	}
949 	else if (c == CAR || c == NL || c == Ctrl_C || c == ESC || c == 'q')
950 	    break;
951     }
952     --no_mapping;
953     --allow_keys;
954     return n;
955 }
956 
957 /*
958  * Ask the user to enter a number.
959  * When "mouse_used" is not NULL allow using the mouse and in that case return
960  * the line number.
961  */
962     int
963 prompt_for_number(int *mouse_used)
964 {
965     int		i;
966     int		save_cmdline_row;
967     int		save_State;
968 
969     // When using ":silent" assume that <CR> was entered.
970     if (mouse_used != NULL)
971 	msg_puts(_("Type number and <Enter> or click with the mouse (q or empty cancels): "));
972     else
973 	msg_puts(_("Type number and <Enter> (q or empty cancels): "));
974 
975     // Set the state such that text can be selected/copied/pasted and we still
976     // get mouse events. redraw_after_callback() will not redraw if cmdline_row
977     // is zero.
978     save_cmdline_row = cmdline_row;
979     cmdline_row = 0;
980     save_State = State;
981     State = CMDLINE;
982     // May show different mouse shape.
983     setmouse();
984 
985     i = get_number(TRUE, mouse_used);
986     if (KeyTyped)
987     {
988 	// don't call wait_return() now
989 	if (msg_row > 0)
990 	    cmdline_row = msg_row - 1;
991 	need_wait_return = FALSE;
992 	msg_didany = FALSE;
993 	msg_didout = FALSE;
994     }
995     else
996 	cmdline_row = save_cmdline_row;
997     State = save_State;
998     // May need to restore mouse shape.
999     setmouse();
1000 
1001     return i;
1002 }
1003 
1004     void
1005 msgmore(long n)
1006 {
1007     long pn;
1008 
1009     if (global_busy	    // no messages now, wait until global is finished
1010 	    || !messaging())  // 'lazyredraw' set, don't do messages now
1011 	return;
1012 
1013     // We don't want to overwrite another important message, but do overwrite
1014     // a previous "more lines" or "fewer lines" message, so that "5dd" and
1015     // then "put" reports the last action.
1016     if (keep_msg != NULL && !keep_msg_more)
1017 	return;
1018 
1019     if (n > 0)
1020 	pn = n;
1021     else
1022 	pn = -n;
1023 
1024     if (pn > p_report)
1025     {
1026 	if (n > 0)
1027 	    vim_snprintf(msg_buf, MSG_BUF_LEN,
1028 		    NGETTEXT("%ld more line", "%ld more lines", pn), pn);
1029 	else
1030 	    vim_snprintf(msg_buf, MSG_BUF_LEN,
1031 		    NGETTEXT("%ld line less", "%ld fewer lines", pn), pn);
1032 	if (got_int)
1033 	    vim_strcat((char_u *)msg_buf, (char_u *)_(" (Interrupted)"),
1034 								  MSG_BUF_LEN);
1035 	if (msg(msg_buf))
1036 	{
1037 	    set_keep_msg((char_u *)msg_buf, 0);
1038 	    keep_msg_more = TRUE;
1039 	}
1040     }
1041 }
1042 
1043 /*
1044  * flush map and typeahead buffers and give a warning for an error
1045  */
1046     void
1047 beep_flush(void)
1048 {
1049     if (emsg_silent == 0)
1050     {
1051 	flush_buffers(FLUSH_MINIMAL);
1052 	vim_beep(BO_ERROR);
1053     }
1054 }
1055 
1056 /*
1057  * Give a warning for an error.
1058  */
1059     void
1060 vim_beep(
1061     unsigned val) // one of the BO_ values, e.g., BO_OPER
1062 {
1063 #ifdef FEAT_EVAL
1064     called_vim_beep = TRUE;
1065 #endif
1066 
1067     if (emsg_silent == 0 && !in_assert_fails)
1068     {
1069 	if (!((bo_flags & val) || (bo_flags & BO_ALL)))
1070 	{
1071 #ifdef ELAPSED_FUNC
1072 	    static int		did_init = FALSE;
1073 	    static elapsed_T	start_tv;
1074 
1075 	    // Only beep once per half a second, otherwise a sequence of beeps
1076 	    // would freeze Vim.
1077 	    if (!did_init || ELAPSED_FUNC(start_tv) > 500)
1078 	    {
1079 		did_init = TRUE;
1080 		ELAPSED_INIT(start_tv);
1081 #endif
1082 		if (p_vb
1083 #ifdef FEAT_GUI
1084 			// While the GUI is starting up the termcap is set for
1085 			// the GUI but the output still goes to a terminal.
1086 			&& !(gui.in_use && gui.starting)
1087 #endif
1088 			)
1089 		{
1090 		    out_str_cf(T_VB);
1091 #ifdef FEAT_VTP
1092 		    // No restore color information, refresh the screen.
1093 		    if (has_vtp_working() != 0
1094 # ifdef FEAT_TERMGUICOLORS
1095 			    && (p_tgc || (!p_tgc && t_colors >= 256))
1096 # endif
1097 			)
1098 		    {
1099 			redraw_later(CLEAR);
1100 			update_screen(0);
1101 			redrawcmd();
1102 		    }
1103 #endif
1104 		}
1105 		else
1106 		    out_char(BELL);
1107 #ifdef ELAPSED_FUNC
1108 	    }
1109 #endif
1110 	}
1111 
1112 	// When 'debug' contains "beep" produce a message.  If we are sourcing
1113 	// a script or executing a function give the user a hint where the beep
1114 	// comes from.
1115 	if (vim_strchr(p_debug, 'e') != NULL)
1116 	{
1117 	    msg_source(HL_ATTR(HLF_W));
1118 	    msg_attr(_("Beep!"), HL_ATTR(HLF_W));
1119 	}
1120     }
1121 }
1122 
1123 /*
1124  * To get the "real" home directory:
1125  * - get value of $HOME
1126  * For Unix:
1127  *  - go to that directory
1128  *  - do mch_dirname() to get the real name of that directory.
1129  *  This also works with mounts and links.
1130  *  Don't do this for MS-DOS, it will change the "current dir" for a drive.
1131  * For Windows:
1132  *  This code is duplicated in init_homedir() in dosinst.c.  Keep in sync!
1133  */
1134     void
1135 init_homedir(void)
1136 {
1137     char_u  *var;
1138 
1139     // In case we are called a second time (when 'encoding' changes).
1140     VIM_CLEAR(homedir);
1141 
1142 #ifdef VMS
1143     var = mch_getenv((char_u *)"SYS$LOGIN");
1144 #else
1145     var = mch_getenv((char_u *)"HOME");
1146 #endif
1147 
1148 #ifdef MSWIN
1149     /*
1150      * Typically, $HOME is not defined on Windows, unless the user has
1151      * specifically defined it for Vim's sake.  However, on Windows NT
1152      * platforms, $HOMEDRIVE and $HOMEPATH are automatically defined for
1153      * each user.  Try constructing $HOME from these.
1154      */
1155     if (var == NULL || *var == NUL)
1156     {
1157 	char_u *homedrive, *homepath;
1158 
1159 	homedrive = mch_getenv((char_u *)"HOMEDRIVE");
1160 	homepath = mch_getenv((char_u *)"HOMEPATH");
1161 	if (homepath == NULL || *homepath == NUL)
1162 	    homepath = (char_u *)"\\";
1163 	if (homedrive != NULL
1164 			   && STRLEN(homedrive) + STRLEN(homepath) < MAXPATHL)
1165 	{
1166 	    sprintf((char *)NameBuff, "%s%s", homedrive, homepath);
1167 	    if (NameBuff[0] != NUL)
1168 		var = NameBuff;
1169 	}
1170     }
1171 
1172     if (var == NULL)
1173 	var = mch_getenv((char_u *)"USERPROFILE");
1174 
1175     /*
1176      * Weird but true: $HOME may contain an indirect reference to another
1177      * variable, esp. "%USERPROFILE%".  Happens when $USERPROFILE isn't set
1178      * when $HOME is being set.
1179      */
1180     if (var != NULL && *var == '%')
1181     {
1182 	char_u	*p;
1183 	char_u	*exp;
1184 
1185 	p = vim_strchr(var + 1, '%');
1186 	if (p != NULL)
1187 	{
1188 	    vim_strncpy(NameBuff, var + 1, p - (var + 1));
1189 	    exp = mch_getenv(NameBuff);
1190 	    if (exp != NULL && *exp != NUL
1191 					&& STRLEN(exp) + STRLEN(p) < MAXPATHL)
1192 	    {
1193 		vim_snprintf((char *)NameBuff, MAXPATHL, "%s%s", exp, p + 1);
1194 		var = NameBuff;
1195 	    }
1196 	}
1197     }
1198 
1199     if (var != NULL && *var == NUL)	// empty is same as not set
1200 	var = NULL;
1201 
1202     if (enc_utf8 && var != NULL)
1203     {
1204 	int	len;
1205 	char_u  *pp = NULL;
1206 
1207 	// Convert from active codepage to UTF-8.  Other conversions are
1208 	// not done, because they would fail for non-ASCII characters.
1209 	acp_to_enc(var, (int)STRLEN(var), &pp, &len);
1210 	if (pp != NULL)
1211 	{
1212 	    homedir = pp;
1213 	    return;
1214 	}
1215     }
1216 
1217     /*
1218      * Default home dir is C:/
1219      * Best assumption we can make in such a situation.
1220      */
1221     if (var == NULL)
1222 	var = (char_u *)"C:/";
1223 #endif
1224 
1225     if (var != NULL)
1226     {
1227 #ifdef UNIX
1228 	/*
1229 	 * Change to the directory and get the actual path.  This resolves
1230 	 * links.  Don't do it when we can't return.
1231 	 */
1232 	if (mch_dirname(NameBuff, MAXPATHL) == OK
1233 					  && mch_chdir((char *)NameBuff) == 0)
1234 	{
1235 	    if (!mch_chdir((char *)var) && mch_dirname(IObuff, IOSIZE) == OK)
1236 		var = IObuff;
1237 	    if (mch_chdir((char *)NameBuff) != 0)
1238 		emsg(_(e_prev_dir));
1239 	}
1240 #endif
1241 	homedir = vim_strsave(var);
1242     }
1243 }
1244 
1245 #if defined(EXITFREE) || defined(PROTO)
1246     void
1247 free_homedir(void)
1248 {
1249     vim_free(homedir);
1250 }
1251 
1252     void
1253 free_users(void)
1254 {
1255     ga_clear_strings(&ga_users);
1256 }
1257 #endif
1258 
1259 /*
1260  * Call expand_env() and store the result in an allocated string.
1261  * This is not very memory efficient, this expects the result to be freed
1262  * again soon.
1263  */
1264     char_u *
1265 expand_env_save(char_u *src)
1266 {
1267     return expand_env_save_opt(src, FALSE);
1268 }
1269 
1270 /*
1271  * Idem, but when "one" is TRUE handle the string as one file name, only
1272  * expand "~" at the start.
1273  */
1274     char_u *
1275 expand_env_save_opt(char_u *src, int one)
1276 {
1277     char_u	*p;
1278 
1279     p = alloc(MAXPATHL);
1280     if (p != NULL)
1281 	expand_env_esc(src, p, MAXPATHL, FALSE, one, NULL);
1282     return p;
1283 }
1284 
1285 /*
1286  * Expand environment variable with path name.
1287  * "~/" is also expanded, using $HOME.	For Unix "~user/" is expanded.
1288  * Skips over "\ ", "\~" and "\$" (not for Win32 though).
1289  * If anything fails no expansion is done and dst equals src.
1290  */
1291     void
1292 expand_env(
1293     char_u	*src,		// input string e.g. "$HOME/vim.hlp"
1294     char_u	*dst,		// where to put the result
1295     int		dstlen)		// maximum length of the result
1296 {
1297     expand_env_esc(src, dst, dstlen, FALSE, FALSE, NULL);
1298 }
1299 
1300     void
1301 expand_env_esc(
1302     char_u	*srcp,		// input string e.g. "$HOME/vim.hlp"
1303     char_u	*dst,		// where to put the result
1304     int		dstlen,		// maximum length of the result
1305     int		esc,		// escape spaces in expanded variables
1306     int		one,		// "srcp" is one file name
1307     char_u	*startstr)	// start again after this (can be NULL)
1308 {
1309     char_u	*src;
1310     char_u	*tail;
1311     int		c;
1312     char_u	*var;
1313     int		copy_char;
1314     int		mustfree;	// var was allocated, need to free it later
1315     int		at_start = TRUE; // at start of a name
1316     int		startstr_len = 0;
1317 
1318     if (startstr != NULL)
1319 	startstr_len = (int)STRLEN(startstr);
1320 
1321     src = skipwhite(srcp);
1322     --dstlen;		    // leave one char space for "\,"
1323     while (*src && dstlen > 0)
1324     {
1325 #ifdef FEAT_EVAL
1326 	// Skip over `=expr`.
1327 	if (src[0] == '`' && src[1] == '=')
1328 	{
1329 	    size_t len;
1330 
1331 	    var = src;
1332 	    src += 2;
1333 	    (void)skip_expr(&src, NULL);
1334 	    if (*src == '`')
1335 		++src;
1336 	    len = src - var;
1337 	    if (len > (size_t)dstlen)
1338 		len = dstlen;
1339 	    vim_strncpy(dst, var, len);
1340 	    dst += len;
1341 	    dstlen -= (int)len;
1342 	    continue;
1343 	}
1344 #endif
1345 	copy_char = TRUE;
1346 	if ((*src == '$'
1347 #ifdef VMS
1348 		    && at_start
1349 #endif
1350 	   )
1351 #if defined(MSWIN)
1352 		|| *src == '%'
1353 #endif
1354 		|| (*src == '~' && at_start))
1355 	{
1356 	    mustfree = FALSE;
1357 
1358 	    /*
1359 	     * The variable name is copied into dst temporarily, because it may
1360 	     * be a string in read-only memory and a NUL needs to be appended.
1361 	     */
1362 	    if (*src != '~')				// environment var
1363 	    {
1364 		tail = src + 1;
1365 		var = dst;
1366 		c = dstlen - 1;
1367 
1368 #ifdef UNIX
1369 		// Unix has ${var-name} type environment vars
1370 		if (*tail == '{' && !vim_isIDc('{'))
1371 		{
1372 		    tail++;	// ignore '{'
1373 		    while (c-- > 0 && *tail && *tail != '}')
1374 			*var++ = *tail++;
1375 		}
1376 		else
1377 #endif
1378 		{
1379 		    while (c-- > 0 && *tail != NUL && ((vim_isIDc(*tail))
1380 #if defined(MSWIN)
1381 			    || (*src == '%' && *tail != '%')
1382 #endif
1383 			    ))
1384 			*var++ = *tail++;
1385 		}
1386 
1387 #if defined(MSWIN) || defined(UNIX)
1388 # ifdef UNIX
1389 		if (src[1] == '{' && *tail != '}')
1390 # else
1391 		if (*src == '%' && *tail != '%')
1392 # endif
1393 		    var = NULL;
1394 		else
1395 		{
1396 # ifdef UNIX
1397 		    if (src[1] == '{')
1398 # else
1399 		    if (*src == '%')
1400 #endif
1401 			++tail;
1402 #endif
1403 		    *var = NUL;
1404 		    var = vim_getenv(dst, &mustfree);
1405 #if defined(MSWIN) || defined(UNIX)
1406 		}
1407 #endif
1408 	    }
1409 							// home directory
1410 	    else if (  src[1] == NUL
1411 		    || vim_ispathsep(src[1])
1412 		    || vim_strchr((char_u *)" ,\t\n", src[1]) != NULL)
1413 	    {
1414 		var = homedir;
1415 		tail = src + 1;
1416 	    }
1417 	    else					// user directory
1418 	    {
1419 #if defined(UNIX) || (defined(VMS) && defined(USER_HOME))
1420 		/*
1421 		 * Copy ~user to dst[], so we can put a NUL after it.
1422 		 */
1423 		tail = src;
1424 		var = dst;
1425 		c = dstlen - 1;
1426 		while (	   c-- > 0
1427 			&& *tail
1428 			&& vim_isfilec(*tail)
1429 			&& !vim_ispathsep(*tail))
1430 		    *var++ = *tail++;
1431 		*var = NUL;
1432 # ifdef UNIX
1433 		/*
1434 		 * If the system supports getpwnam(), use it.
1435 		 * Otherwise, or if getpwnam() fails, the shell is used to
1436 		 * expand ~user.  This is slower and may fail if the shell
1437 		 * does not support ~user (old versions of /bin/sh).
1438 		 */
1439 #  if defined(HAVE_GETPWNAM) && defined(HAVE_PWD_H)
1440 		{
1441 		    // Note: memory allocated by getpwnam() is never freed.
1442 		    // Calling endpwent() apparently doesn't help.
1443 		    struct passwd *pw = (*dst == NUL)
1444 					? NULL : getpwnam((char *)dst + 1);
1445 
1446 		    var = (pw == NULL) ? NULL : (char_u *)pw->pw_dir;
1447 		}
1448 		if (var == NULL)
1449 #  endif
1450 		{
1451 		    expand_T	xpc;
1452 
1453 		    ExpandInit(&xpc);
1454 		    xpc.xp_context = EXPAND_FILES;
1455 		    var = ExpandOne(&xpc, dst, NULL,
1456 				WILD_ADD_SLASH|WILD_SILENT, WILD_EXPAND_FREE);
1457 		    mustfree = TRUE;
1458 		}
1459 
1460 # else	// !UNIX, thus VMS
1461 		/*
1462 		 * USER_HOME is a comma-separated list of
1463 		 * directories to search for the user account in.
1464 		 */
1465 		{
1466 		    char_u	test[MAXPATHL], paths[MAXPATHL];
1467 		    char_u	*path, *next_path, *ptr;
1468 		    stat_T	st;
1469 
1470 		    STRCPY(paths, USER_HOME);
1471 		    next_path = paths;
1472 		    while (*next_path)
1473 		    {
1474 			for (path = next_path; *next_path && *next_path != ',';
1475 				next_path++);
1476 			if (*next_path)
1477 			    *next_path++ = NUL;
1478 			STRCPY(test, path);
1479 			STRCAT(test, "/");
1480 			STRCAT(test, dst + 1);
1481 			if (mch_stat(test, &st) == 0)
1482 			{
1483 			    var = alloc(STRLEN(test) + 1);
1484 			    STRCPY(var, test);
1485 			    mustfree = TRUE;
1486 			    break;
1487 			}
1488 		    }
1489 		}
1490 # endif // UNIX
1491 #else
1492 		// cannot expand user's home directory, so don't try
1493 		var = NULL;
1494 		tail = (char_u *)"";	// for gcc
1495 #endif // UNIX || VMS
1496 	    }
1497 
1498 #ifdef BACKSLASH_IN_FILENAME
1499 	    // If 'shellslash' is set change backslashes to forward slashes.
1500 	    // Can't use slash_adjust(), p_ssl may be set temporarily.
1501 	    if (p_ssl && var != NULL && vim_strchr(var, '\\') != NULL)
1502 	    {
1503 		char_u	*p = vim_strsave(var);
1504 
1505 		if (p != NULL)
1506 		{
1507 		    if (mustfree)
1508 			vim_free(var);
1509 		    var = p;
1510 		    mustfree = TRUE;
1511 		    forward_slash(var);
1512 		}
1513 	    }
1514 #endif
1515 
1516 	    // If "var" contains white space, escape it with a backslash.
1517 	    // Required for ":e ~/tt" when $HOME includes a space.
1518 	    if (esc && var != NULL && vim_strpbrk(var, (char_u *)" \t") != NULL)
1519 	    {
1520 		char_u	*p = vim_strsave_escaped(var, (char_u *)" \t");
1521 
1522 		if (p != NULL)
1523 		{
1524 		    if (mustfree)
1525 			vim_free(var);
1526 		    var = p;
1527 		    mustfree = TRUE;
1528 		}
1529 	    }
1530 
1531 	    if (var != NULL && *var != NUL
1532 		    && (STRLEN(var) + STRLEN(tail) + 1 < (unsigned)dstlen))
1533 	    {
1534 		STRCPY(dst, var);
1535 		dstlen -= (int)STRLEN(var);
1536 		c = (int)STRLEN(var);
1537 		// if var[] ends in a path separator and tail[] starts
1538 		// with it, skip a character
1539 		if (*var != NUL && after_pathsep(dst, dst + c)
1540 #if defined(BACKSLASH_IN_FILENAME) || defined(AMIGA)
1541 			&& dst[-1] != ':'
1542 #endif
1543 			&& vim_ispathsep(*tail))
1544 		    ++tail;
1545 		dst += c;
1546 		src = tail;
1547 		copy_char = FALSE;
1548 	    }
1549 	    if (mustfree)
1550 		vim_free(var);
1551 	}
1552 
1553 	if (copy_char)	    // copy at least one char
1554 	{
1555 	    /*
1556 	     * Recognize the start of a new name, for '~'.
1557 	     * Don't do this when "one" is TRUE, to avoid expanding "~" in
1558 	     * ":edit foo ~ foo".
1559 	     */
1560 	    at_start = FALSE;
1561 	    if (src[0] == '\\' && src[1] != NUL)
1562 	    {
1563 		*dst++ = *src++;
1564 		--dstlen;
1565 	    }
1566 	    else if ((src[0] == ' ' || src[0] == ',') && !one)
1567 		at_start = TRUE;
1568 	    if (dstlen > 0)
1569 	    {
1570 		*dst++ = *src++;
1571 		--dstlen;
1572 
1573 		if (startstr != NULL && src - startstr_len >= srcp
1574 			&& STRNCMP(src - startstr_len, startstr,
1575 							    startstr_len) == 0)
1576 		    at_start = TRUE;
1577 	    }
1578 	}
1579 
1580     }
1581     *dst = NUL;
1582 }
1583 
1584 /*
1585  * If the string between "p" and "pend" ends in "name/", return "pend" minus
1586  * the length of "name/".  Otherwise return "pend".
1587  */
1588     static char_u *
1589 remove_tail(char_u *p, char_u *pend, char_u *name)
1590 {
1591     int		len = (int)STRLEN(name) + 1;
1592     char_u	*newend = pend - len;
1593 
1594     if (newend >= p
1595 	    && fnamencmp(newend, name, len - 1) == 0
1596 	    && (newend == p || after_pathsep(p, newend)))
1597 	return newend;
1598     return pend;
1599 }
1600 
1601 /*
1602  * Check if the directory "vimdir/<version>" or "vimdir/runtime" exists.
1603  * Return NULL if not, return its name in allocated memory otherwise.
1604  */
1605     static char_u *
1606 vim_version_dir(char_u *vimdir)
1607 {
1608     char_u	*p;
1609 
1610     if (vimdir == NULL || *vimdir == NUL)
1611 	return NULL;
1612     p = concat_fnames(vimdir, (char_u *)VIM_VERSION_NODOT, TRUE);
1613     if (p != NULL && mch_isdir(p))
1614 	return p;
1615     vim_free(p);
1616     p = concat_fnames(vimdir, (char_u *)RUNTIME_DIRNAME, TRUE);
1617     if (p != NULL && mch_isdir(p))
1618 	return p;
1619     vim_free(p);
1620     return NULL;
1621 }
1622 
1623 /*
1624  * Vim's version of getenv().
1625  * Special handling of $HOME, $VIM and $VIMRUNTIME.
1626  * Also does ACP to 'enc' conversion for Win32.
1627  * "mustfree" is set to TRUE when returned is allocated, it must be
1628  * initialized to FALSE by the caller.
1629  */
1630     char_u *
1631 vim_getenv(char_u *name, int *mustfree)
1632 {
1633     char_u	*p = NULL;
1634     char_u	*pend;
1635     int		vimruntime;
1636 #ifdef MSWIN
1637     WCHAR	*wn, *wp;
1638 
1639     // use "C:/" when $HOME is not set
1640     if (STRCMP(name, "HOME") == 0)
1641 	return homedir;
1642 
1643     // Use Wide function
1644     wn = enc_to_utf16(name, NULL);
1645     if (wn == NULL)
1646 	return NULL;
1647 
1648     wp = _wgetenv(wn);
1649     vim_free(wn);
1650 
1651     if (wp != NULL && *wp == NUL)   // empty is the same as not set
1652 	wp = NULL;
1653 
1654     if (wp != NULL)
1655     {
1656 	p = utf16_to_enc(wp, NULL);
1657 	if (p == NULL)
1658 	    return NULL;
1659 
1660 	*mustfree = TRUE;
1661 	return p;
1662     }
1663 #else
1664     p = mch_getenv(name);
1665     if (p != NULL && *p == NUL)	    // empty is the same as not set
1666 	p = NULL;
1667 
1668     if (p != NULL)
1669 	return p;
1670 
1671 # ifdef __HAIKU__
1672     // special handling for user settings directory...
1673     if (STRCMP(name, "BE_USER_SETTINGS") == 0)
1674     {
1675 	static char userSettingsPath[MAXPATHL];
1676 
1677 	if (find_directory(B_USER_SETTINGS_DIRECTORY, 0, false,
1678 					   userSettingsPath, MAXPATHL) == B_OK)
1679 	    return (char_u *)userSettingsPath;
1680 	else
1681 	    return NULL;
1682     }
1683 # endif
1684 #endif
1685 
1686     // handling $VIMRUNTIME and $VIM is below, bail out if it's another name.
1687     vimruntime = (STRCMP(name, "VIMRUNTIME") == 0);
1688     if (!vimruntime && STRCMP(name, "VIM") != 0)
1689 	return NULL;
1690 
1691     /*
1692      * When expanding $VIMRUNTIME fails, try using $VIM/vim<version> or $VIM.
1693      * Don't do this when default_vimruntime_dir is non-empty.
1694      */
1695     if (vimruntime
1696 #ifdef HAVE_PATHDEF
1697 	    && *default_vimruntime_dir == NUL
1698 #endif
1699        )
1700     {
1701 #ifdef MSWIN
1702 	// Use Wide function
1703 	wp = _wgetenv(L"VIM");
1704 	if (wp != NULL && *wp == NUL)	    // empty is the same as not set
1705 	    wp = NULL;
1706 	if (wp != NULL)
1707 	{
1708 	    char_u *q = utf16_to_enc(wp, NULL);
1709 	    if (q != NULL)
1710 	    {
1711 		p = vim_version_dir(q);
1712 		*mustfree = TRUE;
1713 		if (p == NULL)
1714 		    p = q;
1715 	    }
1716 	}
1717 #else
1718 	p = mch_getenv((char_u *)"VIM");
1719 	if (p != NULL && *p == NUL)	    // empty is the same as not set
1720 	    p = NULL;
1721 	if (p != NULL)
1722 	{
1723 	    p = vim_version_dir(p);
1724 	    if (p != NULL)
1725 		*mustfree = TRUE;
1726 	    else
1727 		p = mch_getenv((char_u *)"VIM");
1728 	}
1729 #endif
1730     }
1731 
1732     /*
1733      * When expanding $VIM or $VIMRUNTIME fails, try using:
1734      * - the directory name from 'helpfile' (unless it contains '$')
1735      * - the executable name from argv[0]
1736      */
1737     if (p == NULL)
1738     {
1739 	if (p_hf != NULL && vim_strchr(p_hf, '$') == NULL)
1740 	    p = p_hf;
1741 #ifdef USE_EXE_NAME
1742 	/*
1743 	 * Use the name of the executable, obtained from argv[0].
1744 	 */
1745 	else
1746 	    p = exe_name;
1747 #endif
1748 	if (p != NULL)
1749 	{
1750 	    // remove the file name
1751 	    pend = gettail(p);
1752 
1753 	    // remove "doc/" from 'helpfile', if present
1754 	    if (p == p_hf)
1755 		pend = remove_tail(p, pend, (char_u *)"doc");
1756 
1757 #ifdef USE_EXE_NAME
1758 # ifdef MACOS_X
1759 	    // remove "MacOS" from exe_name and add "Resources/vim"
1760 	    if (p == exe_name)
1761 	    {
1762 		char_u	*pend1;
1763 		char_u	*pnew;
1764 
1765 		pend1 = remove_tail(p, pend, (char_u *)"MacOS");
1766 		if (pend1 != pend)
1767 		{
1768 		    pnew = alloc(pend1 - p + 15);
1769 		    if (pnew != NULL)
1770 		    {
1771 			STRNCPY(pnew, p, (pend1 - p));
1772 			STRCPY(pnew + (pend1 - p), "Resources/vim");
1773 			p = pnew;
1774 			pend = p + STRLEN(p);
1775 		    }
1776 		}
1777 	    }
1778 # endif
1779 	    // remove "src/" from exe_name, if present
1780 	    if (p == exe_name)
1781 		pend = remove_tail(p, pend, (char_u *)"src");
1782 #endif
1783 
1784 	    // for $VIM, remove "runtime/" or "vim54/", if present
1785 	    if (!vimruntime)
1786 	    {
1787 		pend = remove_tail(p, pend, (char_u *)RUNTIME_DIRNAME);
1788 		pend = remove_tail(p, pend, (char_u *)VIM_VERSION_NODOT);
1789 	    }
1790 
1791 	    // remove trailing path separator
1792 	    if (pend > p && after_pathsep(p, pend))
1793 		--pend;
1794 
1795 #ifdef MACOS_X
1796 	    if (p == exe_name || p == p_hf)
1797 #endif
1798 		// check that the result is a directory name
1799 		p = vim_strnsave(p, pend - p);
1800 
1801 	    if (p != NULL && !mch_isdir(p))
1802 		VIM_CLEAR(p);
1803 	    else
1804 	    {
1805 #ifdef USE_EXE_NAME
1806 		// may add "/vim54" or "/runtime" if it exists
1807 		if (vimruntime && (pend = vim_version_dir(p)) != NULL)
1808 		{
1809 		    vim_free(p);
1810 		    p = pend;
1811 		}
1812 #endif
1813 		*mustfree = TRUE;
1814 	    }
1815 	}
1816     }
1817 
1818 #ifdef HAVE_PATHDEF
1819     // When there is a pathdef.c file we can use default_vim_dir and
1820     // default_vimruntime_dir
1821     if (p == NULL)
1822     {
1823 	// Only use default_vimruntime_dir when it is not empty
1824 	if (vimruntime && *default_vimruntime_dir != NUL)
1825 	{
1826 	    p = default_vimruntime_dir;
1827 	    *mustfree = FALSE;
1828 	}
1829 	else if (*default_vim_dir != NUL)
1830 	{
1831 	    if (vimruntime && (p = vim_version_dir(default_vim_dir)) != NULL)
1832 		*mustfree = TRUE;
1833 	    else
1834 	    {
1835 		p = default_vim_dir;
1836 		*mustfree = FALSE;
1837 	    }
1838 	}
1839     }
1840 #endif
1841 
1842     /*
1843      * Set the environment variable, so that the new value can be found fast
1844      * next time, and others can also use it (e.g. Perl).
1845      */
1846     if (p != NULL)
1847     {
1848 	if (vimruntime)
1849 	{
1850 	    vim_setenv((char_u *)"VIMRUNTIME", p);
1851 	    didset_vimruntime = TRUE;
1852 	}
1853 	else
1854 	{
1855 	    vim_setenv((char_u *)"VIM", p);
1856 	    didset_vim = TRUE;
1857 	}
1858     }
1859     return p;
1860 }
1861 
1862 #if defined(FEAT_EVAL) || defined(PROTO)
1863     void
1864 vim_unsetenv(char_u *var)
1865 {
1866 #ifdef HAVE_UNSETENV
1867     unsetenv((char *)var);
1868 #else
1869     vim_setenv(var, (char_u *)"");
1870 #endif
1871 }
1872 #endif
1873 
1874 
1875 /*
1876  * Set environment variable "name" and take care of side effects.
1877  */
1878     void
1879 vim_setenv_ext(char_u *name, char_u *val)
1880 {
1881     vim_setenv(name, val);
1882     if (STRICMP(name, "HOME") == 0)
1883 	init_homedir();
1884     else if (didset_vim && STRICMP(name, "VIM") == 0)
1885 	didset_vim = FALSE;
1886     else if (didset_vimruntime
1887 	    && STRICMP(name, "VIMRUNTIME") == 0)
1888 	didset_vimruntime = FALSE;
1889 }
1890 
1891 /*
1892  * Our portable version of setenv.
1893  */
1894     void
1895 vim_setenv(char_u *name, char_u *val)
1896 {
1897 #ifdef HAVE_SETENV
1898     mch_setenv((char *)name, (char *)val, 1);
1899 #else
1900     char_u	*envbuf;
1901 
1902     /*
1903      * Putenv does not copy the string, it has to remain
1904      * valid.  The allocated memory will never be freed.
1905      */
1906     envbuf = alloc(STRLEN(name) + STRLEN(val) + 2);
1907     if (envbuf != NULL)
1908     {
1909 	sprintf((char *)envbuf, "%s=%s", name, val);
1910 	putenv((char *)envbuf);
1911     }
1912 #endif
1913 #ifdef FEAT_GETTEXT
1914     /*
1915      * When setting $VIMRUNTIME adjust the directory to find message
1916      * translations to $VIMRUNTIME/lang.
1917      */
1918     if (*val != NUL && STRICMP(name, "VIMRUNTIME") == 0)
1919     {
1920 	char_u	*buf = concat_str(val, (char_u *)"/lang");
1921 
1922 	if (buf != NULL)
1923 	{
1924 	    bindtextdomain(VIMPACKAGE, (char *)buf);
1925 	    vim_free(buf);
1926 	}
1927     }
1928 #endif
1929 }
1930 
1931 /*
1932  * Function given to ExpandGeneric() to obtain an environment variable name.
1933  */
1934     char_u *
1935 get_env_name(
1936     expand_T	*xp UNUSED,
1937     int		idx)
1938 {
1939 # if defined(AMIGA)
1940     /*
1941      * No environ[] on the Amiga.
1942      */
1943     return NULL;
1944 # else
1945 # ifndef __WIN32__
1946     // Borland C++ 5.2 has this in a header file.
1947     extern char		**environ;
1948 # endif
1949 # define ENVNAMELEN 100
1950     static char_u	name[ENVNAMELEN];
1951     char_u		*str;
1952     int			n;
1953 
1954     str = (char_u *)environ[idx];
1955     if (str == NULL)
1956 	return NULL;
1957 
1958     for (n = 0; n < ENVNAMELEN - 1; ++n)
1959     {
1960 	if (str[n] == '=' || str[n] == NUL)
1961 	    break;
1962 	name[n] = str[n];
1963     }
1964     name[n] = NUL;
1965     return name;
1966 # endif
1967 }
1968 
1969 /*
1970  * Add a user name to the list of users in ga_users.
1971  * Do nothing if user name is NULL or empty.
1972  */
1973     static void
1974 add_user(char_u *user, int need_copy)
1975 {
1976     char_u	*user_copy = (user != NULL && need_copy)
1977 						    ? vim_strsave(user) : user;
1978 
1979     if (user_copy == NULL || *user_copy == NUL || ga_grow(&ga_users, 1) == FAIL)
1980     {
1981 	if (need_copy)
1982 	    vim_free(user);
1983 	return;
1984     }
1985     ((char_u **)(ga_users.ga_data))[ga_users.ga_len++] = user_copy;
1986 }
1987 
1988 /*
1989  * Find all user names for user completion.
1990  * Done only once and then cached.
1991  */
1992     static void
1993 init_users(void)
1994 {
1995     static int	lazy_init_done = FALSE;
1996 
1997     if (lazy_init_done)
1998 	return;
1999 
2000     lazy_init_done = TRUE;
2001     ga_init2(&ga_users, sizeof(char_u *), 20);
2002 
2003 # if defined(HAVE_GETPWENT) && defined(HAVE_PWD_H)
2004     {
2005 	struct passwd*	pw;
2006 
2007 	setpwent();
2008 	while ((pw = getpwent()) != NULL)
2009 	    add_user((char_u *)pw->pw_name, TRUE);
2010 	endpwent();
2011     }
2012 # elif defined(MSWIN)
2013     {
2014 	DWORD		nusers = 0, ntotal = 0, i;
2015 	PUSER_INFO_0	uinfo;
2016 
2017 	if (NetUserEnum(NULL, 0, 0, (LPBYTE *) &uinfo, MAX_PREFERRED_LENGTH,
2018 				       &nusers, &ntotal, NULL) == NERR_Success)
2019 	{
2020 	    for (i = 0; i < nusers; i++)
2021 		add_user(utf16_to_enc(uinfo[i].usri0_name, NULL), FALSE);
2022 
2023 	    NetApiBufferFree(uinfo);
2024 	}
2025     }
2026 # endif
2027 # if defined(HAVE_GETPWNAM)
2028     {
2029 	char_u	*user_env = mch_getenv((char_u *)"USER");
2030 
2031 	// The $USER environment variable may be a valid remote user name (NIS,
2032 	// LDAP) not already listed by getpwent(), as getpwent() only lists
2033 	// local user names.  If $USER is not already listed, check whether it
2034 	// is a valid remote user name using getpwnam() and if it is, add it to
2035 	// the list of user names.
2036 
2037 	if (user_env != NULL && *user_env != NUL)
2038 	{
2039 	    int	i;
2040 
2041 	    for (i = 0; i < ga_users.ga_len; i++)
2042 	    {
2043 		char_u	*local_user = ((char_u **)ga_users.ga_data)[i];
2044 
2045 		if (STRCMP(local_user, user_env) == 0)
2046 		    break;
2047 	    }
2048 
2049 	    if (i == ga_users.ga_len)
2050 	    {
2051 		struct passwd	*pw = getpwnam((char *)user_env);
2052 
2053 		if (pw != NULL)
2054 		    add_user((char_u *)pw->pw_name, TRUE);
2055 	    }
2056 	}
2057     }
2058 # endif
2059 }
2060 
2061 /*
2062  * Function given to ExpandGeneric() to obtain an user names.
2063  */
2064     char_u*
2065 get_users(expand_T *xp UNUSED, int idx)
2066 {
2067     init_users();
2068     if (idx < ga_users.ga_len)
2069 	return ((char_u **)ga_users.ga_data)[idx];
2070     return NULL;
2071 }
2072 
2073 /*
2074  * Check whether name matches a user name. Return:
2075  * 0 if name does not match any user name.
2076  * 1 if name partially matches the beginning of a user name.
2077  * 2 is name fully matches a user name.
2078  */
2079     int
2080 match_user(char_u *name)
2081 {
2082     int i;
2083     int n = (int)STRLEN(name);
2084     int result = 0;
2085 
2086     init_users();
2087     for (i = 0; i < ga_users.ga_len; i++)
2088     {
2089 	if (STRCMP(((char_u **)ga_users.ga_data)[i], name) == 0)
2090 	    return 2; // full match
2091 	if (STRNCMP(((char_u **)ga_users.ga_data)[i], name, n) == 0)
2092 	    result = 1; // partial match
2093     }
2094     return result;
2095 }
2096 
2097 /*
2098  * Concatenate two strings and return the result in allocated memory.
2099  * Returns NULL when out of memory.
2100  */
2101     char_u  *
2102 concat_str(char_u *str1, char_u *str2)
2103 {
2104     char_u  *dest;
2105     size_t  l = str1 == NULL ? 0 : STRLEN(str1);
2106 
2107     dest = alloc(l + (str2 == NULL ? 0 : STRLEN(str2)) + 1L);
2108     if (dest != NULL)
2109     {
2110 	if (str1 == NULL)
2111 	    *dest = NUL;
2112 	else
2113 	    STRCPY(dest, str1);
2114 	if (str2 != NULL)
2115 	    STRCPY(dest + l, str2);
2116     }
2117     return dest;
2118 }
2119 
2120     static void
2121 prepare_to_exit(void)
2122 {
2123 #if defined(SIGHUP) && defined(SIG_IGN)
2124     // Ignore SIGHUP, because a dropped connection causes a read error, which
2125     // makes Vim exit and then handling SIGHUP causes various reentrance
2126     // problems.
2127     signal(SIGHUP, SIG_IGN);
2128 #endif
2129 
2130 #ifdef FEAT_GUI
2131     if (gui.in_use)
2132     {
2133 	gui.dying = TRUE;
2134 	out_trash();	// trash any pending output
2135     }
2136     else
2137 #endif
2138     {
2139 	windgoto((int)Rows - 1, 0);
2140 
2141 	/*
2142 	 * Switch terminal mode back now, so messages end up on the "normal"
2143 	 * screen (if there are two screens).
2144 	 */
2145 	settmode(TMODE_COOK);
2146 	stoptermcap();
2147 	out_flush();
2148     }
2149 }
2150 
2151 /*
2152  * Preserve files and exit.
2153  * When called IObuff must contain a message.
2154  * NOTE: This may be called from deathtrap() in a signal handler, avoid unsafe
2155  * functions, such as allocating memory.
2156  */
2157     void
2158 preserve_exit(void)
2159 {
2160     buf_T	*buf;
2161 
2162     prepare_to_exit();
2163 
2164     // Setting this will prevent free() calls.  That avoids calling free()
2165     // recursively when free() was invoked with a bad pointer.
2166     really_exiting = TRUE;
2167 
2168     out_str(IObuff);
2169     screen_start();		    // don't know where cursor is now
2170     out_flush();
2171 
2172     ml_close_notmod();		    // close all not-modified buffers
2173 
2174     FOR_ALL_BUFFERS(buf)
2175     {
2176 	if (buf->b_ml.ml_mfp != NULL && buf->b_ml.ml_mfp->mf_fname != NULL)
2177 	{
2178 	    OUT_STR("Vim: preserving files...\r\n");
2179 	    screen_start();	    // don't know where cursor is now
2180 	    out_flush();
2181 	    ml_sync_all(FALSE, FALSE);	// preserve all swap files
2182 	    break;
2183 	}
2184     }
2185 
2186     ml_close_all(FALSE);	    // close all memfiles, without deleting
2187 
2188     OUT_STR("Vim: Finished.\r\n");
2189 
2190     getout(1);
2191 }
2192 
2193 /*
2194  * Check for CTRL-C pressed, but only once in a while.
2195  * Should be used instead of ui_breakcheck() for functions that check for
2196  * each line in the file.  Calling ui_breakcheck() each time takes too much
2197  * time, because it can be a system call.
2198  */
2199 
2200 #ifndef BREAKCHECK_SKIP
2201 # define BREAKCHECK_SKIP 1000
2202 #endif
2203 
2204 static int	breakcheck_count = 0;
2205 
2206     void
2207 line_breakcheck(void)
2208 {
2209     if (++breakcheck_count >= BREAKCHECK_SKIP)
2210     {
2211 	breakcheck_count = 0;
2212 	ui_breakcheck();
2213     }
2214 }
2215 
2216 /*
2217  * Like line_breakcheck() but check 10 times less often.
2218  */
2219     void
2220 fast_breakcheck(void)
2221 {
2222     if (++breakcheck_count >= BREAKCHECK_SKIP * 10)
2223     {
2224 	breakcheck_count = 0;
2225 	ui_breakcheck();
2226     }
2227 }
2228 
2229 /*
2230  * Like line_breakcheck() but check 100 times less often.
2231  */
2232     void
2233 veryfast_breakcheck(void)
2234 {
2235     if (++breakcheck_count >= BREAKCHECK_SKIP * 100)
2236     {
2237 	breakcheck_count = 0;
2238 	ui_breakcheck();
2239     }
2240 }
2241 
2242 #if defined(VIM_BACKTICK) || defined(FEAT_EVAL) \
2243 	|| (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
2244 	|| defined(PROTO)
2245 
2246 #ifndef SEEK_SET
2247 # define SEEK_SET 0
2248 #endif
2249 #ifndef SEEK_END
2250 # define SEEK_END 2
2251 #endif
2252 
2253 /*
2254  * Get the stdout of an external command.
2255  * If "ret_len" is NULL replace NUL characters with NL.  When "ret_len" is not
2256  * NULL store the length there.
2257  * Returns an allocated string, or NULL for error.
2258  */
2259     char_u *
2260 get_cmd_output(
2261     char_u	*cmd,
2262     char_u	*infile,	// optional input file name
2263     int		flags,		// can be SHELL_SILENT
2264     int		*ret_len)
2265 {
2266     char_u	*tempname;
2267     char_u	*command;
2268     char_u	*buffer = NULL;
2269     int		len;
2270     int		i = 0;
2271     FILE	*fd;
2272 
2273     if (check_restricted() || check_secure())
2274 	return NULL;
2275 
2276     // get a name for the temp file
2277     if ((tempname = vim_tempname('o', FALSE)) == NULL)
2278     {
2279 	emsg(_(e_notmp));
2280 	return NULL;
2281     }
2282 
2283     // Add the redirection stuff
2284     command = make_filter_cmd(cmd, infile, tempname);
2285     if (command == NULL)
2286 	goto done;
2287 
2288     /*
2289      * Call the shell to execute the command (errors are ignored).
2290      * Don't check timestamps here.
2291      */
2292     ++no_check_timestamps;
2293     call_shell(command, SHELL_DOOUT | SHELL_EXPAND | flags);
2294     --no_check_timestamps;
2295 
2296     vim_free(command);
2297 
2298     /*
2299      * read the names from the file into memory
2300      */
2301 # ifdef VMS
2302     // created temporary file is not always readable as binary
2303     fd = mch_fopen((char *)tempname, "r");
2304 # else
2305     fd = mch_fopen((char *)tempname, READBIN);
2306 # endif
2307 
2308     if (fd == NULL)
2309     {
2310 	semsg(_(e_notopen), tempname);
2311 	goto done;
2312     }
2313 
2314     fseek(fd, 0L, SEEK_END);
2315     len = ftell(fd);		    // get size of temp file
2316     fseek(fd, 0L, SEEK_SET);
2317 
2318     buffer = alloc(len + 1);
2319     if (buffer != NULL)
2320 	i = (int)fread((char *)buffer, (size_t)1, (size_t)len, fd);
2321     fclose(fd);
2322     mch_remove(tempname);
2323     if (buffer == NULL)
2324 	goto done;
2325 #ifdef VMS
2326     len = i;	// VMS doesn't give us what we asked for...
2327 #endif
2328     if (i != len)
2329     {
2330 	semsg(_(e_notread), tempname);
2331 	VIM_CLEAR(buffer);
2332     }
2333     else if (ret_len == NULL)
2334     {
2335 	// Change NUL into SOH, otherwise the string is truncated.
2336 	for (i = 0; i < len; ++i)
2337 	    if (buffer[i] == NUL)
2338 		buffer[i] = 1;
2339 
2340 	buffer[len] = NUL;	// make sure the buffer is terminated
2341     }
2342     else
2343 	*ret_len = len;
2344 
2345 done:
2346     vim_free(tempname);
2347     return buffer;
2348 }
2349 
2350 # if defined(FEAT_EVAL) || defined(PROTO)
2351 
2352     static void
2353 get_cmd_output_as_rettv(
2354     typval_T	*argvars,
2355     typval_T	*rettv,
2356     int		retlist)
2357 {
2358     char_u	*res = NULL;
2359     char_u	*p;
2360     char_u	*infile = NULL;
2361     int		err = FALSE;
2362     FILE	*fd;
2363     list_T	*list = NULL;
2364     int		flags = SHELL_SILENT;
2365 
2366     rettv->v_type = VAR_STRING;
2367     rettv->vval.v_string = NULL;
2368     if (check_restricted() || check_secure())
2369 	goto errret;
2370 
2371     if (argvars[1].v_type != VAR_UNKNOWN)
2372     {
2373 	/*
2374 	 * Write the text to a temp file, to be used for input of the shell
2375 	 * command.
2376 	 */
2377 	if ((infile = vim_tempname('i', TRUE)) == NULL)
2378 	{
2379 	    emsg(_(e_notmp));
2380 	    goto errret;
2381 	}
2382 
2383 	fd = mch_fopen((char *)infile, WRITEBIN);
2384 	if (fd == NULL)
2385 	{
2386 	    semsg(_(e_notopen), infile);
2387 	    goto errret;
2388 	}
2389 	if (argvars[1].v_type == VAR_NUMBER)
2390 	{
2391 	    linenr_T	lnum;
2392 	    buf_T	*buf;
2393 
2394 	    buf = buflist_findnr(argvars[1].vval.v_number);
2395 	    if (buf == NULL)
2396 	    {
2397 		semsg(_(e_nobufnr), argvars[1].vval.v_number);
2398 		fclose(fd);
2399 		goto errret;
2400 	    }
2401 
2402 	    for (lnum = 1; lnum <= buf->b_ml.ml_line_count; lnum++)
2403 	    {
2404 		for (p = ml_get_buf(buf, lnum, FALSE); *p != NUL; ++p)
2405 		    if (putc(*p == '\n' ? NUL : *p, fd) == EOF)
2406 		    {
2407 			err = TRUE;
2408 			break;
2409 		    }
2410 		if (putc(NL, fd) == EOF)
2411 		{
2412 		    err = TRUE;
2413 		    break;
2414 		}
2415 	    }
2416 	}
2417 	else if (argvars[1].v_type == VAR_LIST)
2418 	{
2419 	    if (write_list(fd, argvars[1].vval.v_list, TRUE) == FAIL)
2420 		err = TRUE;
2421 	}
2422 	else
2423 	{
2424 	    size_t	len;
2425 	    char_u	buf[NUMBUFLEN];
2426 
2427 	    p = tv_get_string_buf_chk(&argvars[1], buf);
2428 	    if (p == NULL)
2429 	    {
2430 		fclose(fd);
2431 		goto errret;		// type error; errmsg already given
2432 	    }
2433 	    len = STRLEN(p);
2434 	    if (len > 0 && fwrite(p, len, 1, fd) != 1)
2435 		err = TRUE;
2436 	}
2437 	if (fclose(fd) != 0)
2438 	    err = TRUE;
2439 	if (err)
2440 	{
2441 	    emsg(_("E677: Error writing temp file"));
2442 	    goto errret;
2443 	}
2444     }
2445 
2446     // Omit SHELL_COOKED when invoked with ":silent".  Avoids that the shell
2447     // echoes typeahead, that messes up the display.
2448     if (!msg_silent)
2449 	flags += SHELL_COOKED;
2450 
2451     if (retlist)
2452     {
2453 	int		len;
2454 	listitem_T	*li;
2455 	char_u		*s = NULL;
2456 	char_u		*start;
2457 	char_u		*end;
2458 	int		i;
2459 
2460 	res = get_cmd_output(tv_get_string(&argvars[0]), infile, flags, &len);
2461 	if (res == NULL)
2462 	    goto errret;
2463 
2464 	list = list_alloc();
2465 	if (list == NULL)
2466 	    goto errret;
2467 
2468 	for (i = 0; i < len; ++i)
2469 	{
2470 	    start = res + i;
2471 	    while (i < len && res[i] != NL)
2472 		++i;
2473 	    end = res + i;
2474 
2475 	    s = alloc(end - start + 1);
2476 	    if (s == NULL)
2477 		goto errret;
2478 
2479 	    for (p = s; start < end; ++p, ++start)
2480 		*p = *start == NUL ? NL : *start;
2481 	    *p = NUL;
2482 
2483 	    li = listitem_alloc();
2484 	    if (li == NULL)
2485 	    {
2486 		vim_free(s);
2487 		goto errret;
2488 	    }
2489 	    li->li_tv.v_type = VAR_STRING;
2490 	    li->li_tv.v_lock = 0;
2491 	    li->li_tv.vval.v_string = s;
2492 	    list_append(list, li);
2493 	}
2494 
2495 	rettv_list_set(rettv, list);
2496 	list = NULL;
2497     }
2498     else
2499     {
2500 	res = get_cmd_output(tv_get_string(&argvars[0]), infile, flags, NULL);
2501 #ifdef USE_CRNL
2502 	// translate <CR><NL> into <NL>
2503 	if (res != NULL)
2504 	{
2505 	    char_u	*s, *d;
2506 
2507 	    d = res;
2508 	    for (s = res; *s; ++s)
2509 	    {
2510 		if (s[0] == CAR && s[1] == NL)
2511 		    ++s;
2512 		*d++ = *s;
2513 	    }
2514 	    *d = NUL;
2515 	}
2516 #endif
2517 	rettv->vval.v_string = res;
2518 	res = NULL;
2519     }
2520 
2521 errret:
2522     if (infile != NULL)
2523     {
2524 	mch_remove(infile);
2525 	vim_free(infile);
2526     }
2527     if (res != NULL)
2528 	vim_free(res);
2529     if (list != NULL)
2530 	list_free(list);
2531 }
2532 
2533 /*
2534  * "system()" function
2535  */
2536     void
2537 f_system(typval_T *argvars, typval_T *rettv)
2538 {
2539     get_cmd_output_as_rettv(argvars, rettv, FALSE);
2540 }
2541 
2542 /*
2543  * "systemlist()" function
2544  */
2545     void
2546 f_systemlist(typval_T *argvars, typval_T *rettv)
2547 {
2548     get_cmd_output_as_rettv(argvars, rettv, TRUE);
2549 }
2550 # endif // FEAT_EVAL
2551 
2552 #endif
2553 
2554 /*
2555  * Return TRUE when need to go to Insert mode because of 'insertmode'.
2556  * Don't do this when still processing a command or a mapping.
2557  * Don't do this when inside a ":normal" command.
2558  */
2559     int
2560 goto_im(void)
2561 {
2562     return (p_im && stuff_empty() && typebuf_typed());
2563 }
2564 
2565 /*
2566  * Returns the isolated name of the shell in allocated memory:
2567  * - Skip beyond any path.  E.g., "/usr/bin/csh -f" -> "csh -f".
2568  * - Remove any argument.  E.g., "csh -f" -> "csh".
2569  * But don't allow a space in the path, so that this works:
2570  *   "/usr/bin/csh --rcfile ~/.cshrc"
2571  * But don't do that for Windows, it's common to have a space in the path.
2572  * Returns NULL when out of memory.
2573  */
2574     char_u *
2575 get_isolated_shell_name(void)
2576 {
2577     char_u *p;
2578 
2579 #ifdef MSWIN
2580     p = gettail(p_sh);
2581     p = vim_strnsave(p, skiptowhite(p) - p);
2582 #else
2583     p = skiptowhite(p_sh);
2584     if (*p == NUL)
2585     {
2586 	// No white space, use the tail.
2587 	p = vim_strsave(gettail(p_sh));
2588     }
2589     else
2590     {
2591 	char_u  *p1, *p2;
2592 
2593 	// Find the last path separator before the space.
2594 	p1 = p_sh;
2595 	for (p2 = p_sh; p2 < p; MB_PTR_ADV(p2))
2596 	    if (vim_ispathsep(*p2))
2597 		p1 = p2 + 1;
2598 	p = vim_strnsave(p1, p - p1);
2599     }
2600 #endif
2601     return p;
2602 }
2603 
2604 /*
2605  * Check if the "://" of a URL is at the pointer, return URL_SLASH.
2606  * Also check for ":\\", which MS Internet Explorer accepts, return
2607  * URL_BACKSLASH.
2608  */
2609     int
2610 path_is_url(char_u *p)
2611 {
2612     if (STRNCMP(p, "://", (size_t)3) == 0)
2613 	return URL_SLASH;
2614     else if (STRNCMP(p, ":\\\\", (size_t)3) == 0)
2615 	return URL_BACKSLASH;
2616     return 0;
2617 }
2618 
2619 /*
2620  * Check if "fname" starts with "name://".  Return URL_SLASH if it does.
2621  * Return URL_BACKSLASH for "name:\\".
2622  * Return zero otherwise.
2623  */
2624     int
2625 path_with_url(char_u *fname)
2626 {
2627     char_u *p;
2628 
2629     for (p = fname; isalpha(*p); ++p)
2630 	;
2631     return path_is_url(p);
2632 }
2633