blob: 1ab31594135d059dd76a3bc782ea987e0d6914f1 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
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
Bram Moolenaarb3f74062020-02-26 16:16:53 +010017#if defined(__HAIKU__)
18# include <storage/FindDirectory.h>
19#endif
20
Bram Moolenaar0a52df52019-08-18 22:26:31 +020021#if defined(MSWIN)
Bram Moolenaar828c3d72018-06-19 18:58:07 +020022# include <lm.h>
23#endif
24
Bram Moolenaar85a20022019-12-21 18:25:54 +010025#define URL_SLASH 1 // path_is_url() has found "://"
26#define URL_BACKSLASH 2 // path_is_url() has found ":\\"
Bram Moolenaar5fd0f502019-02-13 23:13:28 +010027
Bram Moolenaar0a52df52019-08-18 22:26:31 +020028// All user names (for ~user completion as done by shell).
Bram Moolenaar24305862012-08-15 14:05:05 +020029static garray_T ga_users;
Bram Moolenaar24305862012-08-15 14:05:05 +020030
Bram Moolenaar071d4272004-06-13 20:20:40 +000031/*
Bram Moolenaar2c019c82013-10-06 17:46:56 +020032 * 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.
Bram Moolenaar071d4272004-06-13 20:20:40 +000035 * 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.
Bram Moolenaar81340392012-06-06 16:12:59 +020038 * If "include_space" is set, include trailing whitespace while calculating the
39 * length.
Bram Moolenaar071d4272004-06-13 20:20:40 +000040 */
41 int
Bram Moolenaar9b578142016-01-30 19:39:49 +010042get_leader_len(
43 char_u *line,
44 char_u **flags,
45 int backward,
46 int include_space)
Bram Moolenaar071d4272004-06-13 20:20:40 +000047{
48 int i, j;
Bram Moolenaar81340392012-06-06 16:12:59 +020049 int result;
Bram Moolenaar071d4272004-06-13 20:20:40 +000050 int got_com = FALSE;
51 int found_one;
Bram Moolenaar85a20022019-12-21 18:25:54 +010052 char_u part_buf[COM_MAX_LEN]; // buffer for one option part
53 char_u *string; // pointer to comment string
Bram Moolenaar071d4272004-06-13 20:20:40 +000054 char_u *list;
Bram Moolenaara4271d52011-05-10 13:38:27 +020055 int middle_match_len = 0;
56 char_u *prev_list;
Bram Moolenaar05da4282011-05-10 14:44:11 +020057 char_u *saved_flags = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000058
Bram Moolenaar81340392012-06-06 16:12:59 +020059 result = i = 0;
Bram Moolenaar85a20022019-12-21 18:25:54 +010060 while (VIM_ISWHITE(line[i])) // leading white space is ignored
Bram Moolenaar071d4272004-06-13 20:20:40 +000061 ++i;
62
63 /*
64 * Repeat to match several nested comment strings.
65 */
Bram Moolenaara4271d52011-05-10 13:38:27 +020066 while (line[i] != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +000067 {
68 /*
69 * scan through the 'comments' option for a match
70 */
71 found_one = FALSE;
72 for (list = curbuf->b_p_com; *list; )
73 {
Bram Moolenaar85a20022019-12-21 18:25:54 +010074 // Get one option part into part_buf[]. Advance "list" to next
75 // one. Put "string" at start of string.
Bram Moolenaara4271d52011-05-10 13:38:27 +020076 if (!got_com && flags != NULL)
Bram Moolenaar85a20022019-12-21 18:25:54 +010077 *flags = list; // remember where flags started
Bram Moolenaara4271d52011-05-10 13:38:27 +020078 prev_list = list;
Bram Moolenaar071d4272004-06-13 20:20:40 +000079 (void)copy_option_part(&list, part_buf, COM_MAX_LEN, ",");
80 string = vim_strchr(part_buf, ':');
Bram Moolenaar85a20022019-12-21 18:25:54 +010081 if (string == NULL) // missing ':', ignore this part
Bram Moolenaar071d4272004-06-13 20:20:40 +000082 continue;
Bram Moolenaar85a20022019-12-21 18:25:54 +010083 *string++ = NUL; // isolate flags from string
Bram Moolenaar071d4272004-06-13 20:20:40 +000084
Bram Moolenaar85a20022019-12-21 18:25:54 +010085 // If we found a middle match previously, use that match when this
86 // is not a middle or end.
Bram Moolenaara4271d52011-05-10 13:38:27 +020087 if (middle_match_len != 0
88 && vim_strchr(part_buf, COM_MIDDLE) == NULL
89 && vim_strchr(part_buf, COM_END) == NULL)
90 break;
91
Bram Moolenaar85a20022019-12-21 18:25:54 +010092 // When we already found a nested comment, only accept further
93 // nested comments.
Bram Moolenaar071d4272004-06-13 20:20:40 +000094 if (got_com && vim_strchr(part_buf, COM_NEST) == NULL)
95 continue;
96
Bram Moolenaar85a20022019-12-21 18:25:54 +010097 // When 'O' flag present and using "O" command skip this one.
Bram Moolenaar071d4272004-06-13 20:20:40 +000098 if (backward && vim_strchr(part_buf, COM_NOBACK) != NULL)
99 continue;
100
Bram Moolenaar85a20022019-12-21 18:25:54 +0100101 // 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).
Bram Moolenaar1c465442017-03-12 20:10:05 +0100105 if (VIM_ISWHITE(string[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100107 if (i == 0 || !VIM_ISWHITE(line[i - 1]))
Bram Moolenaar85a20022019-12-21 18:25:54 +0100108 continue; // missing white space
Bram Moolenaar1c465442017-03-12 20:10:05 +0100109 while (VIM_ISWHITE(string[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000110 ++string;
111 }
112 for (j = 0; string[j] != NUL && string[j] == line[i + j]; ++j)
113 ;
114 if (string[j] != NUL)
Bram Moolenaar85a20022019-12-21 18:25:54 +0100115 continue; // string doesn't match
Bram Moolenaar071d4272004-06-13 20:20:40 +0000116
Bram Moolenaar85a20022019-12-21 18:25:54 +0100117 // When 'b' flag used, there must be white space or an
118 // end-of-line after the string in the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119 if (vim_strchr(part_buf, COM_BLANK) != NULL
Bram Moolenaar1c465442017-03-12 20:10:05 +0100120 && !VIM_ISWHITE(line[i + j]) && line[i + j] != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121 continue;
122
Bram Moolenaar85a20022019-12-21 18:25:54 +0100123 // 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.
Bram Moolenaara4271d52011-05-10 13:38:27 +0200128 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)
Bram Moolenaar85a20022019-12-21 18:25:54 +0100138 // Use this match instead of the middle match, since it's a
139 // longer thus better match.
Bram Moolenaara4271d52011-05-10 13:38:27 +0200140 middle_match_len = 0;
141
142 if (middle_match_len == 0)
143 i += j;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144 found_one = TRUE;
145 break;
146 }
147
Bram Moolenaara4271d52011-05-10 13:38:27 +0200148 if (middle_match_len != 0)
149 {
Bram Moolenaar85a20022019-12-21 18:25:54 +0100150 // Use the previously found middle match after failing to find a
151 // match with an end.
Bram Moolenaara4271d52011-05-10 13:38:27 +0200152 if (!got_com && flags != NULL)
153 *flags = saved_flags;
154 i += middle_match_len;
155 found_one = TRUE;
156 }
157
Bram Moolenaar85a20022019-12-21 18:25:54 +0100158 // No match found, stop scanning.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159 if (!found_one)
160 break;
161
Bram Moolenaar81340392012-06-06 16:12:59 +0200162 result = i;
163
Bram Moolenaar85a20022019-12-21 18:25:54 +0100164 // Include any trailing white space.
Bram Moolenaar1c465442017-03-12 20:10:05 +0100165 while (VIM_ISWHITE(line[i]))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166 ++i;
167
Bram Moolenaar81340392012-06-06 16:12:59 +0200168 if (include_space)
169 result = i;
170
Bram Moolenaar85a20022019-12-21 18:25:54 +0100171 // If this comment doesn't nest, stop here.
Bram Moolenaara4271d52011-05-10 13:38:27 +0200172 got_com = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173 if (vim_strchr(part_buf, COM_NEST) == NULL)
174 break;
175 }
Bram Moolenaar81340392012-06-06 16:12:59 +0200176 return result;
177}
Bram Moolenaara4271d52011-05-10 13:38:27 +0200178
Bram Moolenaar81340392012-06-06 16:12:59 +0200179/*
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
Bram Moolenaar9b578142016-01-30 19:39:49 +0100187get_last_leader_offset(char_u *line, char_u **flags)
Bram Moolenaar81340392012-06-06 16:12:59 +0200188{
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;
Bram Moolenaar85a20022019-12-21 18:25:54 +0100197 char_u part_buf[COM_MAX_LEN]; // buffer for one option part
Bram Moolenaar81340392012-06-06 16:12:59 +0200198
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, ':');
Bram Moolenaar85a20022019-12-21 18:25:54 +0100219 if (string == NULL) // If everything is fine, this cannot actually
220 // happen.
Bram Moolenaar81340392012-06-06 16:12:59 +0200221 continue;
Bram Moolenaar85a20022019-12-21 18:25:54 +0100222 *string++ = NUL; // Isolate flags from string.
Bram Moolenaar81340392012-06-06 16:12:59 +0200223 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 */
Bram Moolenaar1c465442017-03-12 20:10:05 +0100231 if (VIM_ISWHITE(string[0]))
Bram Moolenaar81340392012-06-06 16:12:59 +0200232 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100233 if (i == 0 || !VIM_ISWHITE(line[i - 1]))
Bram Moolenaar81340392012-06-06 16:12:59 +0200234 continue;
Bram Moolenaar53932812018-12-07 21:08:49 +0100235 while (VIM_ISWHITE(*string))
Bram Moolenaar81340392012-06-06 16:12:59 +0200236 ++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
Bram Moolenaar1c465442017-03-12 20:10:05 +0100248 && !VIM_ISWHITE(line[i + j]) && line[i + j] != NUL)
Bram Moolenaar81340392012-06-06 16:12:59 +0200249 continue;
Bram Moolenaar53932812018-12-07 21:08:49 +0100250
Bram Moolenaar4af72592018-12-09 15:00:52 +0100251 if (vim_strchr(part_buf, COM_MIDDLE) != NULL)
Bram Moolenaar53932812018-12-07 21:08:49 +0100252 {
Bram Moolenaar4af72592018-12-09 15:00:52 +0100253 // 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.
Bram Moolenaar53932812018-12-07 21:08:49 +0100258 for (j = 0; VIM_ISWHITE(line[j]) && j <= i; j++)
259 ;
260 if (j < i)
261 continue;
Bram Moolenaar81340392012-06-06 16:12:59 +0200262 }
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 {
Bram Moolenaar85a20022019-12-21 18:25:54 +0100278 char_u part_buf2[COM_MAX_LEN]; // buffer for one option part
Bram Moolenaar81340392012-06-06 16:12:59 +0200279 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
Bram Moolenaar85a20022019-12-21 18:25:54 +0100290 // 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.
Bram Moolenaar81340392012-06-06 16:12:59 +0200294
Bram Moolenaar1c465442017-03-12 20:10:05 +0100295 while (VIM_ISWHITE(*com_leader))
Bram Moolenaar81340392012-06-06 16:12:59 +0200296 ++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;
Bram Moolenaar1c465442017-03-12 20:10:05 +0100308 while (VIM_ISWHITE(*string))
Bram Moolenaar81340392012-06-06 16:12:59 +0200309 ++string;
310 len2 = (int)STRLEN(string);
311 if (len2 == 0)
312 continue;
313
Bram Moolenaar85a20022019-12-21 18:25:54 +0100314 // Now we have to verify whether string ends with a substring
315 // beginning the com_leader.
Bram Moolenaar81340392012-06-06 16:12:59 +0200316 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;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000329}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330
331/*
332 * Return the number of window lines occupied by buffer line "lnum".
333 */
334 int
Bram Moolenaar9b578142016-01-30 19:39:49 +0100335plines(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000336{
337 return plines_win(curwin, lnum, TRUE);
338}
339
340 int
Bram Moolenaar9b578142016-01-30 19:39:49 +0100341plines_win(
342 win_T *wp,
343 linenr_T lnum,
Bram Moolenaar85a20022019-12-21 18:25:54 +0100344 int winheight) // when TRUE limit to window height
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345{
346#if defined(FEAT_DIFF) || defined(PROTO)
Bram Moolenaar85a20022019-12-21 18:25:54 +0100347 // Check for filler lines above this buffer line. When folded the result
348 // is one line anyway.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000349 return plines_win_nofill(wp, lnum, winheight) + diff_check_fill(wp, lnum);
350}
351
352 int
Bram Moolenaar9b578142016-01-30 19:39:49 +0100353plines_nofill(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354{
355 return plines_win_nofill(curwin, lnum, TRUE);
356}
357
358 int
Bram Moolenaar9b578142016-01-30 19:39:49 +0100359plines_win_nofill(
360 win_T *wp,
361 linenr_T lnum,
Bram Moolenaar85a20022019-12-21 18:25:54 +0100362 int winheight) // when TRUE limit to window height
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363{
364#endif
365 int lines;
366
367 if (!wp->w_p_wrap)
368 return 1;
369
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370 if (wp->w_width == 0)
371 return 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372
373#ifdef FEAT_FOLDING
Dominique Pelleaf4a61a2021-12-27 17:21:41 +0000374 // Folded lines are handled just like an empty line.
Bram Moolenaar85a20022019-12-21 18:25:54 +0100375 // NOTE: Caller must handle lines that are MAYBE folded.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376 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)
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +0000382 return wp->w_height;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383 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
Bram Moolenaar9b578142016-01-30 19:39:49 +0100391plines_win_nofold(win_T *wp, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000392{
393 char_u *s;
394 long col;
395 int width;
396
397 s = ml_get_buf(wp->w_buffer, lnum, FALSE);
Bram Moolenaar85a20022019-12-21 18:25:54 +0100398 if (*s == NUL) // empty line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000399 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 */
Bram Moolenaareed9d462021-02-15 20:38:25 +0100406 if (wp->w_p_list && wp->w_lcs_chars.eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407 col += 1;
408
409 /*
Bram Moolenaar64486672010-05-16 15:46:46 +0200410 * Add column offset for 'number', 'relativenumber' and 'foldcolumn'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000411 */
Bram Moolenaar02631462017-09-22 15:20:32 +0200412 width = wp->w_width - win_col_off(wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413 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
Bram Moolenaar9b578142016-01-30 19:39:49 +0100427plines_win_col(win_T *wp, linenr_T lnum, long column)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000428{
429 long col;
430 char_u *s;
431 int lines = 0;
432 int width;
Bram Moolenaar597a4222014-06-25 14:39:50 +0200433 char_u *line;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000434
435#ifdef FEAT_DIFF
Bram Moolenaar85a20022019-12-21 18:25:54 +0100436 // Check for filler lines above this buffer line. When folded the result
437 // is one line anyway.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438 lines = diff_check_fill(wp, lnum);
439#endif
440
441 if (!wp->w_p_wrap)
442 return lines + 1;
443
Bram Moolenaar071d4272004-06-13 20:20:40 +0000444 if (wp->w_width == 0)
445 return lines + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446
Bram Moolenaar597a4222014-06-25 14:39:50 +0200447 line = s = ml_get_buf(wp->w_buffer, lnum, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000448
449 col = 0;
450 while (*s != NUL && --column >= 0)
451 {
Bram Moolenaar597a4222014-06-25 14:39:50 +0200452 col += win_lbr_chartabsize(wp, line, s, (colnr_T)col, NULL);
Bram Moolenaar91acfff2017-03-12 19:22:36 +0100453 MB_PTR_ADV(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454 }
455
456 /*
457 * If *s is a TAB, and the TAB is not displayed as ^I, and we're not in
Bram Moolenaar24959102022-05-07 20:01:16 +0100458 * MODE_INSERT state, then col must be adjusted so that it represents the
459 * last screen position of the TAB. This only fixes an error when the TAB
460 * wraps from one screen line to the next (when 'columns' is not a multiple
461 * of 'ts') -- webb.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000462 */
Bram Moolenaar24959102022-05-07 20:01:16 +0100463 if (*s == TAB && (State & MODE_NORMAL)
464 && (!wp->w_p_list || wp->w_lcs_chars.tab1))
Bram Moolenaar597a4222014-06-25 14:39:50 +0200465 col += win_lbr_chartabsize(wp, line, s, (colnr_T)col, NULL) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000466
467 /*
Bram Moolenaar64486672010-05-16 15:46:46 +0200468 * Add column offset for 'number', 'relativenumber', 'foldcolumn', etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000469 */
Bram Moolenaar02631462017-09-22 15:20:32 +0200470 width = wp->w_width - win_col_off(wp);
Bram Moolenaar26470632006-10-24 19:12:40 +0000471 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;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478}
479
480 int
Bram Moolenaar9b578142016-01-30 19:39:49 +0100481plines_m_win(win_T *wp, linenr_T first, linenr_T last)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000482{
483 int count = 0;
484
485 while (first <= last)
486 {
487#ifdef FEAT_FOLDING
488 int x;
489
Bram Moolenaar85a20022019-12-21 18:25:54 +0100490 // Check if there are any really folded lines, but also included lines
491 // that are maybe folded.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492 x = foldedCount(wp, first, NULL);
493 if (x > 0)
494 {
Bram Moolenaar85a20022019-12-21 18:25:54 +0100495 ++count; // count 1 for "+-- folded" line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496 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
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513 int
Bram Moolenaar9b578142016-01-30 19:39:49 +0100514gchar_pos(pos_T *pos)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515{
Bram Moolenaar8ada6aa2017-12-19 21:23:21 +0100516 char_u *ptr;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517
Bram Moolenaar85a20022019-12-21 18:25:54 +0100518 // When searching columns is sometimes put at the end of a line.
Bram Moolenaar8ada6aa2017-12-19 21:23:21 +0100519 if (pos->col == MAXCOL)
520 return NUL;
521 ptr = ml_get_pos(pos);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000522 if (has_mbyte)
523 return (*mb_ptr2char)(ptr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000524 return (int)*ptr;
525}
526
527 int
Bram Moolenaar9b578142016-01-30 19:39:49 +0100528gchar_cursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530 if (has_mbyte)
531 return (*mb_ptr2char)(ml_get_cursor());
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532 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
Bram Moolenaar9b578142016-01-30 19:39:49 +0100540pchar_cursor(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541{
542 *(ml_get_buf(curbuf, curwin->w_cursor.lnum, TRUE)
543 + curwin->w_cursor.col) = c;
544}
545
Bram Moolenaar071d4272004-06-13 20:20:40 +0000546/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547 * Skip to next part of an option argument: Skip space and comma.
548 */
549 char_u *
Bram Moolenaar9b578142016-01-30 19:39:49 +0100550skip_to_option_part(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551{
552 if (*p == ',')
553 ++p;
554 while (*p == ' ')
555 ++p;
556 return p;
557}
558
559/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560 * check_status: called when the status bars for the buffer 'buf'
561 * need to be updated
562 */
563 void
Bram Moolenaar9b578142016-01-30 19:39:49 +0100564check_status(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565{
566 win_T *wp;
567
Bram Moolenaar29323592016-07-24 22:04:11 +0200568 FOR_ALL_WINDOWS(wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000569 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}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576
577/*
Bram Moolenaar6ed545e2022-05-09 20:09:23 +0100578 * Ask for a reply from the user, a 'y' or a 'n', with prompt "str" (which
579 * should have been translated already).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000580 * No other characters are accepted, the message is repeated until a valid
581 * reply is entered or CTRL-C is hit.
582 * If direct is TRUE, don't use vgetc() but ui_inchar(), don't get characters
583 * from any buffers but directly from the user.
584 *
585 * return the 'y' or 'n'
586 */
587 int
Bram Moolenaar9b578142016-01-30 19:39:49 +0100588ask_yesno(char_u *str, int direct)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589{
590 int r = ' ';
591 int save_State = State;
592
Bram Moolenaar85a20022019-12-21 18:25:54 +0100593 if (exiting) // put terminal in raw mode for this question
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594 settmode(TMODE_RAW);
595 ++no_wait_return;
596#ifdef USE_ON_FLY_SCROLL
Bram Moolenaarb20b9e12019-09-21 20:48:04 +0200597 dont_scroll = TRUE; // disallow scrolling here
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598#endif
Bram Moolenaar24959102022-05-07 20:01:16 +0100599 State = MODE_CONFIRM; // mouse behaves like with :confirm
Bram Moolenaarb20b9e12019-09-21 20:48:04 +0200600 setmouse(); // disables mouse for xterm
Bram Moolenaar071d4272004-06-13 20:20:40 +0000601 ++no_mapping;
Bram Moolenaarb20b9e12019-09-21 20:48:04 +0200602 ++allow_keys; // no mapping here, but recognize keys
Bram Moolenaar071d4272004-06-13 20:20:40 +0000603
604 while (r != 'y' && r != 'n')
605 {
Bram Moolenaar85a20022019-12-21 18:25:54 +0100606 // same highlighting as for wait_return
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100607 smsg_attr(HL_ATTR(HLF_R), "%s (y/n)?", str);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608 if (direct)
609 r = get_keystroke();
610 else
Bram Moolenaar913626c2008-01-03 11:43:42 +0000611 r = plain_vgetc();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612 if (r == Ctrl_C || r == ESC)
613 r = 'n';
Bram Moolenaar85a20022019-12-21 18:25:54 +0100614 msg_putchar(r); // show what you typed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 out_flush();
616 }
617 --no_wait_return;
618 State = save_State;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620 --no_mapping;
621 --allow_keys;
622
623 return r;
624}
625
Bram Moolenaar0e57dd82019-09-16 22:56:03 +0200626#if defined(FEAT_EVAL) || defined(PROTO)
627
628/*
LemonBoy2bf52dd2022-04-09 18:17:34 +0100629 * Returns the current mode as a string in "buf[MODE_MAX_LENGTH]", NUL
630 * terminated.
631 * The first character represents the major mode, the following ones the minor
632 * ones.
633 */
634 void
635get_mode(char_u *buf)
636{
637 int i = 0;
638
639 if (time_for_testing == 93784)
640 {
641 // Testing the two-character code.
642 buf[i++] = 'x';
643 buf[i++] = '!';
644 }
645#ifdef FEAT_TERMINAL
646 else if (term_use_loop())
647 buf[i++] = 't';
648#endif
649 else if (VIsual_active)
650 {
651 if (VIsual_select)
652 buf[i++] = VIsual_mode + 's' - 'v';
653 else
654 {
655 buf[i++] = VIsual_mode;
656 if (restart_VIsual_select)
Bram Moolenaar6ed545e2022-05-09 20:09:23 +0100657 buf[i++] = 's';
LemonBoy2bf52dd2022-04-09 18:17:34 +0100658 }
659 }
Bram Moolenaar24959102022-05-07 20:01:16 +0100660 else if (State == MODE_HITRETURN || State == MODE_ASKMORE
661 || State == MODE_SETWSIZE
662 || State == MODE_CONFIRM)
LemonBoy2bf52dd2022-04-09 18:17:34 +0100663 {
664 buf[i++] = 'r';
Bram Moolenaar24959102022-05-07 20:01:16 +0100665 if (State == MODE_ASKMORE)
LemonBoy2bf52dd2022-04-09 18:17:34 +0100666 buf[i++] = 'm';
Bram Moolenaar24959102022-05-07 20:01:16 +0100667 else if (State == MODE_CONFIRM)
LemonBoy2bf52dd2022-04-09 18:17:34 +0100668 buf[i++] = '?';
669 }
Bram Moolenaar24959102022-05-07 20:01:16 +0100670 else if (State == MODE_EXTERNCMD)
LemonBoy2bf52dd2022-04-09 18:17:34 +0100671 buf[i++] = '!';
Bram Moolenaar24959102022-05-07 20:01:16 +0100672 else if (State & MODE_INSERT)
LemonBoy2bf52dd2022-04-09 18:17:34 +0100673 {
674 if (State & VREPLACE_FLAG)
675 {
676 buf[i++] = 'R';
677 buf[i++] = 'v';
LemonBoy2bf52dd2022-04-09 18:17:34 +0100678 }
679 else
680 {
681 if (State & REPLACE_FLAG)
682 buf[i++] = 'R';
683 else
684 buf[i++] = 'i';
LemonBoy2bf52dd2022-04-09 18:17:34 +0100685 }
zeertzjq590f3652022-04-29 11:29:54 +0100686
687 if (ins_compl_active())
688 buf[i++] = 'c';
689 else if (ctrl_x_mode_not_defined_yet())
690 buf[i++] = 'x';
LemonBoy2bf52dd2022-04-09 18:17:34 +0100691 }
Bram Moolenaar24959102022-05-07 20:01:16 +0100692 else if ((State & MODE_CMDLINE) || exmode_active)
LemonBoy2bf52dd2022-04-09 18:17:34 +0100693 {
694 buf[i++] = 'c';
695 if (exmode_active == EXMODE_VIM)
696 buf[i++] = 'v';
697 else if (exmode_active == EXMODE_NORMAL)
698 buf[i++] = 'e';
699 }
700 else
701 {
702 buf[i++] = 'n';
703 if (finish_op)
704 {
705 buf[i++] = 'o';
706 // to be able to detect force-linewise/blockwise/characterwise
707 // operations
708 buf[i++] = motion_force;
709 }
710 else if (restart_edit == 'I' || restart_edit == 'R'
711 || restart_edit == 'V')
712 {
713 buf[i++] = 'i';
714 buf[i++] = restart_edit;
715 }
716#ifdef FEAT_TERMINAL
717 else if (term_in_normal_mode())
718 buf[i++] = 't';
719#endif
720 }
721
722 buf[i] = NUL;
723}
724
725/*
Bram Moolenaar0e57dd82019-09-16 22:56:03 +0200726 * "mode()" function
727 */
728 void
729f_mode(typval_T *argvars, typval_T *rettv)
730{
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +0200731 char_u buf[MODE_MAX_LENGTH];
Bram Moolenaar0e57dd82019-09-16 22:56:03 +0200732
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200733 if (in_vim9script() && check_for_opt_bool_arg(argvars, 0) == FAIL)
734 return;
735
LemonBoy2bf52dd2022-04-09 18:17:34 +0100736 get_mode(buf);
Bram Moolenaar0e57dd82019-09-16 22:56:03 +0200737
Bram Moolenaar85a20022019-12-21 18:25:54 +0100738 // Clear out the minor mode when the argument is not a non-zero number or
739 // non-empty string.
Bram Moolenaar0e57dd82019-09-16 22:56:03 +0200740 if (!non_zero_arg(&argvars[0]))
741 buf[1] = NUL;
742
743 rettv->vval.v_string = vim_strsave(buf);
744 rettv->v_type = VAR_STRING;
745}
746
747 static void
748may_add_state_char(garray_T *gap, char_u *include, int c)
749{
750 if (include == NULL || vim_strchr(include, c) != NULL)
751 ga_append(gap, c);
752}
753
754/*
755 * "state()" function
756 */
757 void
758f_state(typval_T *argvars, typval_T *rettv)
759{
760 garray_T ga;
761 char_u *include = NULL;
762 int i;
763
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200764 if (in_vim9script() && check_for_opt_string_arg(argvars, 0) == FAIL)
765 return;
766
Bram Moolenaar0e57dd82019-09-16 22:56:03 +0200767 ga_init2(&ga, 1, 20);
768 if (argvars[0].v_type != VAR_UNKNOWN)
769 include = tv_get_string(&argvars[0]);
770
771 if (!(stuff_empty() && typebuf.tb_len == 0 && scriptin[curscript] == NULL))
772 may_add_state_char(&ga, include, 'm');
773 if (op_pending())
774 may_add_state_char(&ga, include, 'o');
775 if (autocmd_busy)
776 may_add_state_char(&ga, include, 'x');
Bram Moolenaarc2585492019-09-22 21:29:53 +0200777 if (ins_compl_active())
Bram Moolenaar0e57dd82019-09-16 22:56:03 +0200778 may_add_state_char(&ga, include, 'a');
779
780# ifdef FEAT_JOB_CHANNEL
781 if (channel_in_blocking_wait())
782 may_add_state_char(&ga, include, 'w');
783# endif
Bram Moolenaarb20b9e12019-09-21 20:48:04 +0200784 if (!get_was_safe_state())
785 may_add_state_char(&ga, include, 'S');
Bram Moolenaar0e57dd82019-09-16 22:56:03 +0200786 for (i = 0; i < get_callback_depth() && i < 3; ++i)
787 may_add_state_char(&ga, include, 'c');
788 if (msg_scrolled > 0)
789 may_add_state_char(&ga, include, 's');
790
791 rettv->v_type = VAR_STRING;
792 rettv->vval.v_string = ga.ga_data;
793}
794
795#endif // FEAT_EVAL
796
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797/*
798 * Get a key stroke directly from the user.
799 * Ignores mouse clicks and scrollbar events, except a click for the left
800 * button (used at the more prompt).
801 * Doesn't use vgetc(), because it syncs undo and eats mapped characters.
802 * Disadvantage: typeahead is ignored.
803 * Translates the interrupt character for unix to ESC.
804 */
805 int
Bram Moolenaar9b578142016-01-30 19:39:49 +0100806get_keystroke(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807{
Bram Moolenaara8c8a682012-02-05 22:05:48 +0100808 char_u *buf = NULL;
809 int buflen = 150;
810 int maxlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 int len = 0;
812 int n;
813 int save_mapped_ctrl_c = mapped_ctrl_c;
Bram Moolenaar4395a712006-09-05 18:57:57 +0000814 int waited = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815
Bram Moolenaar85a20022019-12-21 18:25:54 +0100816 mapped_ctrl_c = FALSE; // mappings are not used here
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 for (;;)
818 {
819 cursor_on();
820 out_flush();
821
Bram Moolenaar85a20022019-12-21 18:25:54 +0100822 // Leave some room for check_termcode() to insert a key code into (max
823 // 5 chars plus NUL). And fix_input_buffer() can triple the number of
824 // bytes.
Bram Moolenaara8c8a682012-02-05 22:05:48 +0100825 maxlen = (buflen - 6 - len) / 3;
826 if (buf == NULL)
827 buf = alloc(buflen);
828 else if (maxlen < 10)
829 {
Bram Moolenaar9abd5c62015-02-10 18:34:01 +0100830 char_u *t_buf = buf;
831
Bram Moolenaar85a20022019-12-21 18:25:54 +0100832 // Need some more space. This might happen when receiving a long
833 // escape sequence.
Bram Moolenaara8c8a682012-02-05 22:05:48 +0100834 buflen += 100;
835 buf = vim_realloc(buf, buflen);
Bram Moolenaar9abd5c62015-02-10 18:34:01 +0100836 if (buf == NULL)
837 vim_free(t_buf);
Bram Moolenaara8c8a682012-02-05 22:05:48 +0100838 maxlen = (buflen - 6 - len) / 3;
839 }
840 if (buf == NULL)
841 {
842 do_outofmem_msg((long_u)buflen);
Bram Moolenaar85a20022019-12-21 18:25:54 +0100843 return ESC; // panic!
Bram Moolenaara8c8a682012-02-05 22:05:48 +0100844 }
845
Bram Moolenaar85a20022019-12-21 18:25:54 +0100846 // First time: blocking wait. Second time: wait up to 100ms for a
847 // terminal code to complete.
Bram Moolenaara8c8a682012-02-05 22:05:48 +0100848 n = ui_inchar(buf + len, maxlen, len == 0 ? -1L : 100L, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849 if (n > 0)
850 {
Bram Moolenaar85a20022019-12-21 18:25:54 +0100851 // Replace zero and CSI by a special key code.
Bram Moolenaar6bff02e2016-08-16 22:50:55 +0200852 n = fix_input_buffer(buf + len, n);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 len += n;
Bram Moolenaar4395a712006-09-05 18:57:57 +0000854 waited = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 }
Bram Moolenaar4395a712006-09-05 18:57:57 +0000856 else if (len > 0)
Bram Moolenaar85a20022019-12-21 18:25:54 +0100857 ++waited; // keep track of the waiting time
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858
Bram Moolenaar85a20022019-12-21 18:25:54 +0100859 // Incomplete termcode and not timed out yet: get more characters
Bram Moolenaara8c8a682012-02-05 22:05:48 +0100860 if ((n = check_termcode(1, buf, buflen, &len)) < 0
Bram Moolenaar4395a712006-09-05 18:57:57 +0000861 && (!p_ttimeout || waited * 100L < (p_ttm < 0 ? p_tm : p_ttm)))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862 continue;
Bram Moolenaar4395a712006-09-05 18:57:57 +0000863
Bram Moolenaar85a20022019-12-21 18:25:54 +0100864 if (n == KEYLEN_REMOVED) // key code removed
Bram Moolenaar6eb634e2011-03-03 15:04:08 +0100865 {
Bram Moolenaar24959102022-05-07 20:01:16 +0100866 if (must_redraw != 0 && !need_wait_return && (State
867 & (MODE_CMDLINE | MODE_HITRETURN | MODE_ASKMORE)) == 0)
Bram Moolenaar6eb634e2011-03-03 15:04:08 +0100868 {
Bram Moolenaar85a20022019-12-21 18:25:54 +0100869 // Redrawing was postponed, do it now.
Bram Moolenaar6eb634e2011-03-03 15:04:08 +0100870 update_screen(0);
Bram Moolenaar85a20022019-12-21 18:25:54 +0100871 setcursor(); // put cursor back where it belongs
Bram Moolenaar6eb634e2011-03-03 15:04:08 +0100872 }
Bram Moolenaar946ffd42010-12-30 12:30:31 +0100873 continue;
Bram Moolenaar6eb634e2011-03-03 15:04:08 +0100874 }
Bram Moolenaar85a20022019-12-21 18:25:54 +0100875 if (n > 0) // found a termcode: adjust length
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876 len = n;
Bram Moolenaar85a20022019-12-21 18:25:54 +0100877 if (len == 0) // nothing typed yet
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878 continue;
879
Bram Moolenaar85a20022019-12-21 18:25:54 +0100880 // Handle modifier and/or special key code.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881 n = buf[0];
882 if (n == K_SPECIAL)
883 {
884 n = TO_SPECIAL(buf[1], buf[2]);
885 if (buf[1] == KS_MODIFIER
886 || n == K_IGNORE
Bram Moolenaar2526ef22013-03-16 14:20:51 +0100887 || (is_mouse_key(n) && n != K_LEFTMOUSE)
888#ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889 || n == K_VER_SCROLLBAR
890 || n == K_HOR_SCROLLBAR
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891#endif
892 )
893 {
894 if (buf[1] == KS_MODIFIER)
895 mod_mask = buf[2];
896 len -= 3;
897 if (len > 0)
898 mch_memmove(buf, buf + 3, (size_t)len);
899 continue;
900 }
Bram Moolenaar7fc904b2006-04-13 20:37:35 +0000901 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 if (has_mbyte)
904 {
905 if (MB_BYTE2LEN(n) > len)
Bram Moolenaar85a20022019-12-21 18:25:54 +0100906 continue; // more bytes to get
Bram Moolenaara8c8a682012-02-05 22:05:48 +0100907 buf[len >= buflen ? buflen - 1 : len] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908 n = (*mb_ptr2char)(buf);
909 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910#ifdef UNIX
911 if (n == intr_char)
912 n = ESC;
913#endif
914 break;
915 }
Bram Moolenaara8c8a682012-02-05 22:05:48 +0100916 vim_free(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000917
918 mapped_ctrl_c = save_mapped_ctrl_c;
919 return n;
920}
921
922/*
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +0000923 * Get a number from the user.
924 * When "mouse_used" is not NULL allow using the mouse.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 */
926 int
Bram Moolenaar9b578142016-01-30 19:39:49 +0100927get_number(
Bram Moolenaar85a20022019-12-21 18:25:54 +0100928 int colon, // allow colon to abort
Bram Moolenaar9b578142016-01-30 19:39:49 +0100929 int *mouse_used)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930{
931 int n = 0;
932 int c;
Bram Moolenaar3991dab2006-03-27 17:01:56 +0000933 int typed = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +0000935 if (mouse_used != NULL)
936 *mouse_used = FALSE;
937
Bram Moolenaar85a20022019-12-21 18:25:54 +0100938 // When not printing messages, the user won't know what to type, return a
939 // zero (as if CR was hit).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 if (msg_silent != 0)
941 return 0;
942
943#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar85a20022019-12-21 18:25:54 +0100944 dont_scroll = TRUE; // disallow scrolling here
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945#endif
946 ++no_mapping;
Bram Moolenaar85a20022019-12-21 18:25:54 +0100947 ++allow_keys; // no mapping here, but recognize keys
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948 for (;;)
949 {
950 windgoto(msg_row, msg_col);
951 c = safe_vgetc();
952 if (VIM_ISDIGIT(c))
953 {
954 n = n * 10 + c - '0';
955 msg_putchar(c);
Bram Moolenaar3991dab2006-03-27 17:01:56 +0000956 ++typed;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000957 }
958 else if (c == K_DEL || c == K_KDEL || c == K_BS || c == Ctrl_H)
959 {
Bram Moolenaar3991dab2006-03-27 17:01:56 +0000960 if (typed > 0)
961 {
Bram Moolenaar32526b32019-01-19 17:43:09 +0100962 msg_puts("\b \b");
Bram Moolenaar3991dab2006-03-27 17:01:56 +0000963 --typed;
964 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 n /= 10;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 }
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +0000967 else if (mouse_used != NULL && c == K_LEFTMOUSE)
968 {
969 *mouse_used = TRUE;
970 n = mouse_row + 1;
971 break;
972 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000973 else if (n == 0 && c == ':' && colon)
974 {
975 stuffcharReadbuff(':');
976 if (!exmode_active)
977 cmdline_row = msg_row;
Bram Moolenaar85a20022019-12-21 18:25:54 +0100978 skip_redraw = TRUE; // skip redraw once
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 do_redraw = FALSE;
980 break;
981 }
=?UTF-8?q?Luka=20Marku=C5=A1i=C4=87?=5cf94572021-05-20 21:14:20 +0200982 else if (c == Ctrl_C || c == ESC || c == 'q')
983 {
984 n = 0;
985 break;
986 }
987 else if (c == CAR || c == NL )
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988 break;
989 }
990 --no_mapping;
991 --allow_keys;
992 return n;
993}
994
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +0000995/*
996 * Ask the user to enter a number.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +0000997 * When "mouse_used" is not NULL allow using the mouse and in that case return
998 * the line number.
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +0000999 */
1000 int
Bram Moolenaar9b578142016-01-30 19:39:49 +01001001prompt_for_number(int *mouse_used)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001002{
1003 int i;
Bram Moolenaard857f0e2005-06-21 22:37:39 +00001004 int save_cmdline_row;
1005 int save_State;
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001006
Bram Moolenaar85a20022019-12-21 18:25:54 +01001007 // When using ":silent" assume that <CR> was entered.
Bram Moolenaar42eeac32005-06-29 22:40:58 +00001008 if (mouse_used != NULL)
Bram Moolenaareebd5552020-06-10 15:45:57 +02001009 msg_puts(_("Type number and <Enter> or click with the mouse (q or empty cancels): "));
Bram Moolenaar42eeac32005-06-29 22:40:58 +00001010 else
Bram Moolenaareebd5552020-06-10 15:45:57 +02001011 msg_puts(_("Type number and <Enter> (q or empty cancels): "));
Bram Moolenaard857f0e2005-06-21 22:37:39 +00001012
Bram Moolenaar4cbdf152018-08-26 21:23:07 +02001013 // Set the state such that text can be selected/copied/pasted and we still
1014 // get mouse events. redraw_after_callback() will not redraw if cmdline_row
1015 // is zero.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00001016 save_cmdline_row = cmdline_row;
Bram Moolenaar203335e2006-09-03 14:35:42 +00001017 cmdline_row = 0;
Bram Moolenaard857f0e2005-06-21 22:37:39 +00001018 save_State = State;
Bram Moolenaar24959102022-05-07 20:01:16 +01001019 State = MODE_CMDLINE;
Bram Moolenaar4cbdf152018-08-26 21:23:07 +02001020 // May show different mouse shape.
Bram Moolenaar73658312018-04-24 17:41:57 +02001021 setmouse();
Bram Moolenaar73658312018-04-24 17:41:57 +02001022
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001023 i = get_number(TRUE, mouse_used);
1024 if (KeyTyped)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001025 {
Bram Moolenaar954bb062019-06-09 16:40:46 +02001026 // don't call wait_return() now
1027 if (msg_row > 0)
1028 cmdline_row = msg_row - 1;
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001029 need_wait_return = FALSE;
Bram Moolenaardc968e72019-11-05 21:53:20 +01001030 msg_didany = FALSE;
1031 msg_didout = FALSE;
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001032 }
Bram Moolenaard857f0e2005-06-21 22:37:39 +00001033 else
1034 cmdline_row = save_cmdline_row;
1035 State = save_State;
Bram Moolenaar4cbdf152018-08-26 21:23:07 +02001036 // May need to restore mouse shape.
Bram Moolenaar73658312018-04-24 17:41:57 +02001037 setmouse();
Bram Moolenaard857f0e2005-06-21 22:37:39 +00001038
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001039 return i;
1040}
1041
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042 void
Bram Moolenaar9b578142016-01-30 19:39:49 +01001043msgmore(long n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001044{
1045 long pn;
1046
Bram Moolenaar85a20022019-12-21 18:25:54 +01001047 if (global_busy // no messages now, wait until global is finished
1048 || !messaging()) // 'lazyredraw' set, don't do messages now
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049 return;
1050
Bram Moolenaar85a20022019-12-21 18:25:54 +01001051 // We don't want to overwrite another important message, but do overwrite
1052 // a previous "more lines" or "fewer lines" message, so that "5dd" and
1053 // then "put" reports the last action.
Bram Moolenaar7df2d662005-01-25 22:18:08 +00001054 if (keep_msg != NULL && !keep_msg_more)
1055 return;
1056
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 if (n > 0)
1058 pn = n;
1059 else
1060 pn = -n;
1061
1062 if (pn > p_report)
1063 {
Bram Moolenaarda6e8912018-08-21 15:12:14 +02001064 if (n > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001065 vim_snprintf(msg_buf, MSG_BUF_LEN,
Bram Moolenaarda6e8912018-08-21 15:12:14 +02001066 NGETTEXT("%ld more line", "%ld more lines", pn), pn);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001068 vim_snprintf(msg_buf, MSG_BUF_LEN,
Bram Moolenaarda6e8912018-08-21 15:12:14 +02001069 NGETTEXT("%ld line less", "%ld fewer lines", pn), pn);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001071 vim_strcat((char_u *)msg_buf, (char_u *)_(" (Interrupted)"),
1072 MSG_BUF_LEN);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 if (msg(msg_buf))
1074 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001075 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar7df2d662005-01-25 22:18:08 +00001076 keep_msg_more = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001077 }
1078 }
1079}
1080
1081/*
1082 * flush map and typeahead buffers and give a warning for an error
1083 */
1084 void
Bram Moolenaar9b578142016-01-30 19:39:49 +01001085beep_flush(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086{
1087 if (emsg_silent == 0)
1088 {
Bram Moolenaar6a2633b2018-10-07 23:16:36 +02001089 flush_buffers(FLUSH_MINIMAL);
Bram Moolenaar165bc692015-07-21 17:53:25 +02001090 vim_beep(BO_ERROR);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 }
1092}
1093
1094/*
Bram Moolenaaraae97622022-04-13 14:28:07 +01001095 * Give a warning for an error. "val" is one of the BO_ values, e.g., BO_OPER.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 */
1097 void
Bram Moolenaaraae97622022-04-13 14:28:07 +01001098vim_beep(unsigned val)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099{
Bram Moolenaarb48e96f2018-02-13 12:26:14 +01001100#ifdef FEAT_EVAL
1101 called_vim_beep = TRUE;
1102#endif
1103
Bram Moolenaar28ee8922020-10-28 20:20:00 +01001104 if (emsg_silent == 0 && !in_assert_fails)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105 {
Bram Moolenaar165bc692015-07-21 17:53:25 +02001106 if (!((bo_flags & val) || (bo_flags & BO_ALL)))
1107 {
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02001108#ifdef ELAPSED_FUNC
1109 static int did_init = FALSE;
Bram Moolenaar1ac56c22019-01-17 22:28:22 +01001110 static elapsed_T start_tv;
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02001111
Bram Moolenaar85a20022019-12-21 18:25:54 +01001112 // Only beep once per half a second, otherwise a sequence of beeps
1113 // would freeze Vim.
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02001114 if (!did_init || ELAPSED_FUNC(start_tv) > 500)
1115 {
1116 did_init = TRUE;
1117 ELAPSED_INIT(start_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118#endif
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02001119 if (p_vb
1120#ifdef FEAT_GUI
Bram Moolenaar85a20022019-12-21 18:25:54 +01001121 // While the GUI is starting up the termcap is set for
1122 // the GUI but the output still goes to a terminal.
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02001123 && !(gui.in_use && gui.starting)
1124#endif
1125 )
Bram Moolenaarcafafb32018-02-22 21:07:09 +01001126 {
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02001127 out_str_cf(T_VB);
Bram Moolenaarcafafb32018-02-22 21:07:09 +01001128#ifdef FEAT_VTP
Bram Moolenaar85a20022019-12-21 18:25:54 +01001129 // No restore color information, refresh the screen.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01001130 if (has_vtp_working() != 0
1131# ifdef FEAT_TERMGUICOLORS
Bram Moolenaarc5cd8852018-05-01 15:47:38 +02001132 && (p_tgc || (!p_tgc && t_colors >= 256))
Bram Moolenaarcafafb32018-02-22 21:07:09 +01001133# endif
1134 )
1135 {
1136 redraw_later(CLEAR);
1137 update_screen(0);
1138 redrawcmd();
1139 }
1140#endif
1141 }
Bram Moolenaar2e147ca2017-06-27 17:09:37 +02001142 else
1143 out_char(BELL);
1144#ifdef ELAPSED_FUNC
1145 }
1146#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001148
Bram Moolenaar85a20022019-12-21 18:25:54 +01001149 // When 'debug' contains "beep" produce a message. If we are sourcing
1150 // a script or executing a function give the user a hint where the beep
1151 // comes from.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001152 if (vim_strchr(p_debug, 'e') != NULL)
1153 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01001154 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar32526b32019-01-19 17:43:09 +01001155 msg_attr(_("Beep!"), HL_ATTR(HLF_W));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001156 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001157 }
1158}
1159
1160/*
1161 * To get the "real" home directory:
1162 * - get value of $HOME
1163 * For Unix:
1164 * - go to that directory
1165 * - do mch_dirname() to get the real name of that directory.
1166 * This also works with mounts and links.
1167 * Don't do this for MS-DOS, it will change the "current dir" for a drive.
Bram Moolenaar25a494c2018-11-16 19:39:50 +01001168 * For Windows:
1169 * This code is duplicated in init_homedir() in dosinst.c. Keep in sync!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171 void
Bram Moolenaar9b578142016-01-30 19:39:49 +01001172init_homedir(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173{
1174 char_u *var;
1175
Bram Moolenaar85a20022019-12-21 18:25:54 +01001176 // In case we are called a second time (when 'encoding' changes).
Bram Moolenaard23a8232018-02-10 18:45:26 +01001177 VIM_CLEAR(homedir);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001178
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179#ifdef VMS
1180 var = mch_getenv((char_u *)"SYS$LOGIN");
1181#else
1182 var = mch_getenv((char_u *)"HOME");
1183#endif
1184
Bram Moolenaar4f974752019-02-17 17:44:42 +01001185#ifdef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 /*
Bram Moolenaar48340b62017-08-29 22:08:53 +02001187 * Typically, $HOME is not defined on Windows, unless the user has
1188 * specifically defined it for Vim's sake. However, on Windows NT
1189 * platforms, $HOMEDRIVE and $HOMEPATH are automatically defined for
1190 * each user. Try constructing $HOME from these.
1191 */
Bram Moolenaarb47a2592017-08-30 13:22:28 +02001192 if (var == NULL || *var == NUL)
Bram Moolenaar48340b62017-08-29 22:08:53 +02001193 {
1194 char_u *homedrive, *homepath;
1195
1196 homedrive = mch_getenv((char_u *)"HOMEDRIVE");
1197 homepath = mch_getenv((char_u *)"HOMEPATH");
1198 if (homepath == NULL || *homepath == NUL)
1199 homepath = (char_u *)"\\";
1200 if (homedrive != NULL
1201 && STRLEN(homedrive) + STRLEN(homepath) < MAXPATHL)
1202 {
1203 sprintf((char *)NameBuff, "%s%s", homedrive, homepath);
1204 if (NameBuff[0] != NUL)
1205 var = NameBuff;
1206 }
1207 }
1208
1209 if (var == NULL)
1210 var = mch_getenv((char_u *)"USERPROFILE");
1211
1212 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 * Weird but true: $HOME may contain an indirect reference to another
1214 * variable, esp. "%USERPROFILE%". Happens when $USERPROFILE isn't set
1215 * when $HOME is being set.
1216 */
1217 if (var != NULL && *var == '%')
1218 {
1219 char_u *p;
1220 char_u *exp;
1221
1222 p = vim_strchr(var + 1, '%');
1223 if (p != NULL)
1224 {
Bram Moolenaarce0842a2005-07-18 21:58:11 +00001225 vim_strncpy(NameBuff, var + 1, p - (var + 1));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226 exp = mch_getenv(NameBuff);
1227 if (exp != NULL && *exp != NUL
1228 && STRLEN(exp) + STRLEN(p) < MAXPATHL)
1229 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00001230 vim_snprintf((char *)NameBuff, MAXPATHL, "%s%s", exp, p + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 var = NameBuff;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 }
1233 }
1234 }
1235
Bram Moolenaar85a20022019-12-21 18:25:54 +01001236 if (var != NULL && *var == NUL) // empty is same as not set
Bram Moolenaar48340b62017-08-29 22:08:53 +02001237 var = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238
Bram Moolenaar05159a02005-02-26 23:04:13 +00001239 if (enc_utf8 && var != NULL)
1240 {
1241 int len;
Bram Moolenaarb453a532011-04-28 17:48:44 +02001242 char_u *pp = NULL;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001243
Bram Moolenaar85a20022019-12-21 18:25:54 +01001244 // Convert from active codepage to UTF-8. Other conversions are
1245 // not done, because they would fail for non-ASCII characters.
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001246 acp_to_enc(var, (int)STRLEN(var), &pp, &len);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001247 if (pp != NULL)
1248 {
1249 homedir = pp;
1250 return;
1251 }
1252 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001253
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254 /*
1255 * Default home dir is C:/
1256 * Best assumption we can make in such a situation.
1257 */
1258 if (var == NULL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01001259 var = (char_u *)"C:/";
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260#endif
Bram Moolenaar48340b62017-08-29 22:08:53 +02001261
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 if (var != NULL)
1263 {
1264#ifdef UNIX
1265 /*
1266 * Change to the directory and get the actual path. This resolves
1267 * links. Don't do it when we can't return.
1268 */
1269 if (mch_dirname(NameBuff, MAXPATHL) == OK
1270 && mch_chdir((char *)NameBuff) == 0)
1271 {
1272 if (!mch_chdir((char *)var) && mch_dirname(IObuff, IOSIZE) == OK)
1273 var = IObuff;
1274 if (mch_chdir((char *)NameBuff) != 0)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001275 emsg(_(e_cannot_go_back_to_previous_directory));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276 }
1277#endif
1278 homedir = vim_strsave(var);
1279 }
1280}
1281
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001282#if defined(EXITFREE) || defined(PROTO)
1283 void
Bram Moolenaar9b578142016-01-30 19:39:49 +01001284free_homedir(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001285{
1286 vim_free(homedir);
1287}
Bram Moolenaar24305862012-08-15 14:05:05 +02001288
Bram Moolenaar24305862012-08-15 14:05:05 +02001289 void
Bram Moolenaar9b578142016-01-30 19:39:49 +01001290free_users(void)
Bram Moolenaar24305862012-08-15 14:05:05 +02001291{
1292 ga_clear_strings(&ga_users);
1293}
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001294#endif
1295
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296/*
Bram Moolenaar9f0545d2007-09-26 20:36:32 +00001297 * Call expand_env() and store the result in an allocated string.
1298 * This is not very memory efficient, this expects the result to be freed
1299 * again soon.
1300 */
1301 char_u *
Bram Moolenaar9b578142016-01-30 19:39:49 +01001302expand_env_save(char_u *src)
Bram Moolenaar9f0545d2007-09-26 20:36:32 +00001303{
1304 return expand_env_save_opt(src, FALSE);
1305}
1306
1307/*
1308 * Idem, but when "one" is TRUE handle the string as one file name, only
1309 * expand "~" at the start.
1310 */
1311 char_u *
Bram Moolenaar9b578142016-01-30 19:39:49 +01001312expand_env_save_opt(char_u *src, int one)
Bram Moolenaar9f0545d2007-09-26 20:36:32 +00001313{
1314 char_u *p;
1315
1316 p = alloc(MAXPATHL);
1317 if (p != NULL)
1318 expand_env_esc(src, p, MAXPATHL, FALSE, one, NULL);
1319 return p;
1320}
1321
1322/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 * Expand environment variable with path name.
1324 * "~/" is also expanded, using $HOME. For Unix "~user/" is expanded.
Bram Moolenaar9f0545d2007-09-26 20:36:32 +00001325 * Skips over "\ ", "\~" and "\$" (not for Win32 though).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326 * If anything fails no expansion is done and dst equals src.
1327 */
1328 void
Bram Moolenaar9b578142016-01-30 19:39:49 +01001329expand_env(
Bram Moolenaar85a20022019-12-21 18:25:54 +01001330 char_u *src, // input string e.g. "$HOME/vim.hlp"
1331 char_u *dst, // where to put the result
1332 int dstlen) // maximum length of the result
Bram Moolenaar071d4272004-06-13 20:20:40 +00001333{
Bram Moolenaar9f0545d2007-09-26 20:36:32 +00001334 expand_env_esc(src, dst, dstlen, FALSE, FALSE, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335}
1336
1337 void
Bram Moolenaar9b578142016-01-30 19:39:49 +01001338expand_env_esc(
Bram Moolenaar85a20022019-12-21 18:25:54 +01001339 char_u *srcp, // input string e.g. "$HOME/vim.hlp"
1340 char_u *dst, // where to put the result
1341 int dstlen, // maximum length of the result
1342 int esc, // escape spaces in expanded variables
1343 int one, // "srcp" is one file name
1344 char_u *startstr) // start again after this (can be NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345{
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001346 char_u *src;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347 char_u *tail;
1348 int c;
1349 char_u *var;
1350 int copy_char;
Bram Moolenaar85a20022019-12-21 18:25:54 +01001351 int mustfree; // var was allocated, need to free it later
1352 int at_start = TRUE; // at start of a name
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001353 int startstr_len = 0;
Yegappan Lakshmanana34b4462022-06-11 10:43:26 +01001354#if defined(BACKSLASH_IN_FILENAME) || defined(AMIGA)
1355 char_u *save_dst = dst;
1356#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001358 if (startstr != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001359 startstr_len = (int)STRLEN(startstr);
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001360
1361 src = skipwhite(srcp);
Bram Moolenaar85a20022019-12-21 18:25:54 +01001362 --dstlen; // leave one char space for "\,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001363 while (*src && dstlen > 0)
1364 {
Bram Moolenaarbe83b732015-08-25 14:21:19 +02001365#ifdef FEAT_EVAL
Bram Moolenaar85a20022019-12-21 18:25:54 +01001366 // Skip over `=expr`.
Bram Moolenaarbe83b732015-08-25 14:21:19 +02001367 if (src[0] == '`' && src[1] == '=')
1368 {
1369 size_t len;
1370
1371 var = src;
1372 src += 2;
Bram Moolenaar683581e2020-10-22 21:22:58 +02001373 (void)skip_expr(&src, NULL);
Bram Moolenaarbe83b732015-08-25 14:21:19 +02001374 if (*src == '`')
1375 ++src;
1376 len = src - var;
1377 if (len > (size_t)dstlen)
1378 len = dstlen;
1379 vim_strncpy(dst, var, len);
1380 dst += len;
Bram Moolenaar5df1ed22015-09-01 16:25:34 +02001381 dstlen -= (int)len;
Bram Moolenaarbe83b732015-08-25 14:21:19 +02001382 continue;
1383 }
1384#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001385 copy_char = TRUE;
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001386 if ((*src == '$'
1387#ifdef VMS
1388 && at_start
1389#endif
1390 )
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001391#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 || *src == '%'
1393#endif
1394 || (*src == '~' && at_start))
1395 {
1396 mustfree = FALSE;
1397
1398 /*
1399 * The variable name is copied into dst temporarily, because it may
1400 * be a string in read-only memory and a NUL needs to be appended.
1401 */
Bram Moolenaar85a20022019-12-21 18:25:54 +01001402 if (*src != '~') // environment var
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403 {
1404 tail = src + 1;
1405 var = dst;
1406 c = dstlen - 1;
1407
1408#ifdef UNIX
Bram Moolenaar85a20022019-12-21 18:25:54 +01001409 // Unix has ${var-name} type environment vars
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410 if (*tail == '{' && !vim_isIDc('{'))
1411 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001412 tail++; // ignore '{'
Bram Moolenaar071d4272004-06-13 20:20:40 +00001413 while (c-- > 0 && *tail && *tail != '}')
1414 *var++ = *tail++;
1415 }
1416 else
1417#endif
1418 {
1419 while (c-- > 0 && *tail != NUL && ((vim_isIDc(*tail))
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001420#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421 || (*src == '%' && *tail != '%')
1422#endif
1423 ))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 *var++ = *tail++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001425 }
1426
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001427#if defined(MSWIN) || defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428# ifdef UNIX
1429 if (src[1] == '{' && *tail != '}')
1430# else
1431 if (*src == '%' && *tail != '%')
1432# endif
1433 var = NULL;
1434 else
1435 {
1436# ifdef UNIX
1437 if (src[1] == '{')
1438# else
1439 if (*src == '%')
1440#endif
1441 ++tail;
1442#endif
1443 *var = NUL;
1444 var = vim_getenv(dst, &mustfree);
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001445#if defined(MSWIN) || defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446 }
1447#endif
1448 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01001449 // home directory
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450 else if ( src[1] == NUL
1451 || vim_ispathsep(src[1])
1452 || vim_strchr((char_u *)" ,\t\n", src[1]) != NULL)
1453 {
1454 var = homedir;
1455 tail = src + 1;
1456 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01001457 else // user directory
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458 {
1459#if defined(UNIX) || (defined(VMS) && defined(USER_HOME))
1460 /*
1461 * Copy ~user to dst[], so we can put a NUL after it.
1462 */
1463 tail = src;
1464 var = dst;
1465 c = dstlen - 1;
1466 while ( c-- > 0
1467 && *tail
1468 && vim_isfilec(*tail)
1469 && !vim_ispathsep(*tail))
1470 *var++ = *tail++;
1471 *var = NUL;
1472# ifdef UNIX
1473 /*
1474 * If the system supports getpwnam(), use it.
1475 * Otherwise, or if getpwnam() fails, the shell is used to
1476 * expand ~user. This is slower and may fail if the shell
1477 * does not support ~user (old versions of /bin/sh).
1478 */
1479# if defined(HAVE_GETPWNAM) && defined(HAVE_PWD_H)
1480 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001481 // Note: memory allocated by getpwnam() is never freed.
1482 // Calling endpwent() apparently doesn't help.
Bram Moolenaar187a4f22017-02-23 17:07:14 +01001483 struct passwd *pw = (*dst == NUL)
1484 ? NULL : getpwnam((char *)dst + 1);
1485
1486 var = (pw == NULL) ? NULL : (char_u *)pw->pw_dir;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487 }
1488 if (var == NULL)
1489# endif
1490 {
1491 expand_T xpc;
1492
1493 ExpandInit(&xpc);
1494 xpc.xp_context = EXPAND_FILES;
1495 var = ExpandOne(&xpc, dst, NULL,
1496 WILD_ADD_SLASH|WILD_SILENT, WILD_EXPAND_FREE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001497 mustfree = TRUE;
1498 }
1499
Bram Moolenaar85a20022019-12-21 18:25:54 +01001500# else // !UNIX, thus VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 /*
1502 * USER_HOME is a comma-separated list of
1503 * directories to search for the user account in.
1504 */
1505 {
1506 char_u test[MAXPATHL], paths[MAXPATHL];
1507 char_u *path, *next_path, *ptr;
Bram Moolenaar8767f522016-07-01 17:17:39 +02001508 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509
1510 STRCPY(paths, USER_HOME);
1511 next_path = paths;
1512 while (*next_path)
1513 {
1514 for (path = next_path; *next_path && *next_path != ',';
1515 next_path++);
1516 if (*next_path)
1517 *next_path++ = NUL;
1518 STRCPY(test, path);
1519 STRCAT(test, "/");
1520 STRCAT(test, dst + 1);
1521 if (mch_stat(test, &st) == 0)
1522 {
1523 var = alloc(STRLEN(test) + 1);
1524 STRCPY(var, test);
1525 mustfree = TRUE;
1526 break;
1527 }
1528 }
1529 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01001530# endif // UNIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531#else
Bram Moolenaar85a20022019-12-21 18:25:54 +01001532 // cannot expand user's home directory, so don't try
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 var = NULL;
Bram Moolenaar85a20022019-12-21 18:25:54 +01001534 tail = (char_u *)""; // for gcc
1535#endif // UNIX || VMS
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 }
1537
1538#ifdef BACKSLASH_IN_FILENAME
Bram Moolenaar85a20022019-12-21 18:25:54 +01001539 // If 'shellslash' is set change backslashes to forward slashes.
1540 // Can't use slash_adjust(), p_ssl may be set temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001541 if (p_ssl && var != NULL && vim_strchr(var, '\\') != NULL)
1542 {
1543 char_u *p = vim_strsave(var);
1544
1545 if (p != NULL)
1546 {
1547 if (mustfree)
1548 vim_free(var);
1549 var = p;
1550 mustfree = TRUE;
1551 forward_slash(var);
1552 }
1553 }
1554#endif
1555
Bram Moolenaar85a20022019-12-21 18:25:54 +01001556 // If "var" contains white space, escape it with a backslash.
1557 // Required for ":e ~/tt" when $HOME includes a space.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 if (esc && var != NULL && vim_strpbrk(var, (char_u *)" \t") != NULL)
1559 {
1560 char_u *p = vim_strsave_escaped(var, (char_u *)" \t");
1561
1562 if (p != NULL)
1563 {
1564 if (mustfree)
1565 vim_free(var);
1566 var = p;
1567 mustfree = TRUE;
1568 }
1569 }
1570
1571 if (var != NULL && *var != NUL
1572 && (STRLEN(var) + STRLEN(tail) + 1 < (unsigned)dstlen))
1573 {
1574 STRCPY(dst, var);
1575 dstlen -= (int)STRLEN(var);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001576 c = (int)STRLEN(var);
Bram Moolenaar85a20022019-12-21 18:25:54 +01001577 // if var[] ends in a path separator and tail[] starts
1578 // with it, skip a character
=?UTF-8?q?Dundar=20G=C3=B6c?=b8366582022-04-14 20:43:56 +01001579 if (after_pathsep(dst, dst + c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580#if defined(BACKSLASH_IN_FILENAME) || defined(AMIGA)
Yegappan Lakshmanana34b4462022-06-11 10:43:26 +01001581 && (dst == save_dst || dst[-1] != ':')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582#endif
1583 && vim_ispathsep(*tail))
1584 ++tail;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001585 dst += c;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001586 src = tail;
1587 copy_char = FALSE;
1588 }
1589 if (mustfree)
1590 vim_free(var);
1591 }
1592
Bram Moolenaar85a20022019-12-21 18:25:54 +01001593 if (copy_char) // copy at least one char
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594 {
1595 /*
Bram Moolenaar25394022007-05-10 19:06:20 +00001596 * Recognize the start of a new name, for '~'.
Bram Moolenaar9f0545d2007-09-26 20:36:32 +00001597 * Don't do this when "one" is TRUE, to avoid expanding "~" in
1598 * ":edit foo ~ foo".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 */
1600 at_start = FALSE;
1601 if (src[0] == '\\' && src[1] != NUL)
1602 {
1603 *dst++ = *src++;
1604 --dstlen;
1605 }
Bram Moolenaar9f0545d2007-09-26 20:36:32 +00001606 else if ((src[0] == ' ' || src[0] == ',') && !one)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 at_start = TRUE;
Bram Moolenaar1c864092017-08-06 18:15:45 +02001608 if (dstlen > 0)
1609 {
1610 *dst++ = *src++;
1611 --dstlen;
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001612
Bram Moolenaar1c864092017-08-06 18:15:45 +02001613 if (startstr != NULL && src - startstr_len >= srcp
1614 && STRNCMP(src - startstr_len, startstr,
1615 startstr_len) == 0)
1616 at_start = TRUE;
1617 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 }
Bram Moolenaar1c864092017-08-06 18:15:45 +02001619
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620 }
1621 *dst = NUL;
1622}
1623
1624/*
Bram Moolenaar26262f82019-09-04 20:59:15 +02001625 * If the string between "p" and "pend" ends in "name/", return "pend" minus
1626 * the length of "name/". Otherwise return "pend".
1627 */
1628 static char_u *
1629remove_tail(char_u *p, char_u *pend, char_u *name)
1630{
1631 int len = (int)STRLEN(name) + 1;
1632 char_u *newend = pend - len;
1633
1634 if (newend >= p
1635 && fnamencmp(newend, name, len - 1) == 0
1636 && (newend == p || after_pathsep(p, newend)))
1637 return newend;
1638 return pend;
1639}
1640
1641/*
1642 * Check if the directory "vimdir/<version>" or "vimdir/runtime" exists.
1643 * Return NULL if not, return its name in allocated memory otherwise.
1644 */
1645 static char_u *
1646vim_version_dir(char_u *vimdir)
1647{
1648 char_u *p;
1649
1650 if (vimdir == NULL || *vimdir == NUL)
1651 return NULL;
1652 p = concat_fnames(vimdir, (char_u *)VIM_VERSION_NODOT, TRUE);
1653 if (p != NULL && mch_isdir(p))
1654 return p;
1655 vim_free(p);
1656 p = concat_fnames(vimdir, (char_u *)RUNTIME_DIRNAME, TRUE);
1657 if (p != NULL && mch_isdir(p))
Bram Moolenaar022f9ef2022-07-02 17:36:31 +01001658 {
1659 char_u *fname = concat_fnames(p, (char_u *)"defaults.vim", TRUE);
1660
1661 // Check that "defaults.vim" exists in this directory, to avoid picking
1662 // up a stray "runtime" directory, it would make many tests fail in
1663 // mysterious ways.
1664 if (fname != NULL)
1665 {
1666 int exists = file_is_readable(fname);
1667
1668 vim_free(fname);
1669 if (exists)
1670 return p;
1671 }
1672 }
Bram Moolenaar26262f82019-09-04 20:59:15 +02001673 vim_free(p);
1674 return NULL;
1675}
1676
1677/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 * Vim's version of getenv().
1679 * Special handling of $HOME, $VIM and $VIMRUNTIME.
Bram Moolenaar2f6b0b82005-03-08 22:43:10 +00001680 * Also does ACP to 'enc' conversion for Win32.
Bram Moolenaarb453a532011-04-28 17:48:44 +02001681 * "mustfree" is set to TRUE when returned is allocated, it must be
1682 * initialized to FALSE by the caller.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683 */
1684 char_u *
Bram Moolenaar9b578142016-01-30 19:39:49 +01001685vim_getenv(char_u *name, int *mustfree)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686{
Bram Moolenaarf0908e62019-03-30 20:11:50 +01001687 char_u *p = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688 char_u *pend;
1689 int vimruntime;
Bram Moolenaarf0908e62019-03-30 20:11:50 +01001690#ifdef MSWIN
1691 WCHAR *wn, *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692
Bram Moolenaarf0908e62019-03-30 20:11:50 +01001693 // use "C:/" when $HOME is not set
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694 if (STRCMP(name, "HOME") == 0)
1695 return homedir;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001696
Bram Moolenaarf0908e62019-03-30 20:11:50 +01001697 // Use Wide function
1698 wn = enc_to_utf16(name, NULL);
1699 if (wn == NULL)
1700 return NULL;
1701
1702 wp = _wgetenv(wn);
1703 vim_free(wn);
1704
1705 if (wp != NULL && *wp == NUL) // empty is the same as not set
1706 wp = NULL;
1707
1708 if (wp != NULL)
1709 {
1710 p = utf16_to_enc(wp, NULL);
1711 if (p == NULL)
1712 return NULL;
1713
1714 *mustfree = TRUE;
1715 return p;
1716 }
1717#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 p = mch_getenv(name);
Bram Moolenaarf0908e62019-03-30 20:11:50 +01001719 if (p != NULL && *p == NUL) // empty is the same as not set
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 p = NULL;
1721
1722 if (p != NULL)
1723 return p;
Bram Moolenaar80a8d382020-05-03 22:57:32 +02001724
1725# ifdef __HAIKU__
1726 // special handling for user settings directory...
1727 if (STRCMP(name, "BE_USER_SETTINGS") == 0)
1728 {
1729 static char userSettingsPath[MAXPATHL];
1730
1731 if (find_directory(B_USER_SETTINGS_DIRECTORY, 0, false,
1732 userSettingsPath, MAXPATHL) == B_OK)
1733 return (char_u *)userSettingsPath;
1734 else
1735 return NULL;
1736 }
1737# endif
Bram Moolenaarf0908e62019-03-30 20:11:50 +01001738#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739
Bram Moolenaarf0908e62019-03-30 20:11:50 +01001740 // handling $VIMRUNTIME and $VIM is below, bail out if it's another name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 vimruntime = (STRCMP(name, "VIMRUNTIME") == 0);
1742 if (!vimruntime && STRCMP(name, "VIM") != 0)
1743 return NULL;
1744
1745 /*
1746 * When expanding $VIMRUNTIME fails, try using $VIM/vim<version> or $VIM.
1747 * Don't do this when default_vimruntime_dir is non-empty.
1748 */
1749 if (vimruntime
1750#ifdef HAVE_PATHDEF
1751 && *default_vimruntime_dir == NUL
1752#endif
1753 )
1754 {
Bram Moolenaarf0908e62019-03-30 20:11:50 +01001755#ifdef MSWIN
1756 // Use Wide function
1757 wp = _wgetenv(L"VIM");
1758 if (wp != NULL && *wp == NUL) // empty is the same as not set
1759 wp = NULL;
1760 if (wp != NULL)
1761 {
1762 char_u *q = utf16_to_enc(wp, NULL);
1763 if (q != NULL)
1764 {
1765 p = vim_version_dir(q);
1766 *mustfree = TRUE;
1767 if (p == NULL)
1768 p = q;
1769 }
1770 }
1771#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 p = mch_getenv((char_u *)"VIM");
Bram Moolenaarf0908e62019-03-30 20:11:50 +01001773 if (p != NULL && *p == NUL) // empty is the same as not set
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 p = NULL;
1775 if (p != NULL)
1776 {
1777 p = vim_version_dir(p);
1778 if (p != NULL)
1779 *mustfree = TRUE;
1780 else
1781 p = mch_getenv((char_u *)"VIM");
1782 }
Bram Moolenaarf0908e62019-03-30 20:11:50 +01001783#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 }
1785
1786 /*
1787 * When expanding $VIM or $VIMRUNTIME fails, try using:
1788 * - the directory name from 'helpfile' (unless it contains '$')
1789 * - the executable name from argv[0]
1790 */
1791 if (p == NULL)
1792 {
1793 if (p_hf != NULL && vim_strchr(p_hf, '$') == NULL)
1794 p = p_hf;
1795#ifdef USE_EXE_NAME
1796 /*
1797 * Use the name of the executable, obtained from argv[0].
1798 */
1799 else
1800 p = exe_name;
1801#endif
1802 if (p != NULL)
1803 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001804 // remove the file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805 pend = gettail(p);
1806
Bram Moolenaar85a20022019-12-21 18:25:54 +01001807 // remove "doc/" from 'helpfile', if present
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 if (p == p_hf)
1809 pend = remove_tail(p, pend, (char_u *)"doc");
1810
1811#ifdef USE_EXE_NAME
1812# ifdef MACOS_X
Bram Moolenaar85a20022019-12-21 18:25:54 +01001813 // remove "MacOS" from exe_name and add "Resources/vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814 if (p == exe_name)
1815 {
1816 char_u *pend1;
Bram Moolenaar95e9b492006-03-15 23:04:43 +00001817 char_u *pnew;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818
Bram Moolenaar95e9b492006-03-15 23:04:43 +00001819 pend1 = remove_tail(p, pend, (char_u *)"MacOS");
1820 if (pend1 != pend)
1821 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001822 pnew = alloc(pend1 - p + 15);
Bram Moolenaar95e9b492006-03-15 23:04:43 +00001823 if (pnew != NULL)
1824 {
1825 STRNCPY(pnew, p, (pend1 - p));
1826 STRCPY(pnew + (pend1 - p), "Resources/vim");
1827 p = pnew;
1828 pend = p + STRLEN(p);
1829 }
1830 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831 }
1832# endif
Bram Moolenaar85a20022019-12-21 18:25:54 +01001833 // remove "src/" from exe_name, if present
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834 if (p == exe_name)
1835 pend = remove_tail(p, pend, (char_u *)"src");
1836#endif
1837
Bram Moolenaar85a20022019-12-21 18:25:54 +01001838 // for $VIM, remove "runtime/" or "vim54/", if present
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 if (!vimruntime)
1840 {
1841 pend = remove_tail(p, pend, (char_u *)RUNTIME_DIRNAME);
1842 pend = remove_tail(p, pend, (char_u *)VIM_VERSION_NODOT);
1843 }
1844
Bram Moolenaar85a20022019-12-21 18:25:54 +01001845 // remove trailing path separator
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001846 if (pend > p && after_pathsep(p, pend))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847 --pend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848
Bram Moolenaar95e9b492006-03-15 23:04:43 +00001849#ifdef MACOS_X
1850 if (p == exe_name || p == p_hf)
1851#endif
Bram Moolenaar85a20022019-12-21 18:25:54 +01001852 // check that the result is a directory name
Bram Moolenaar71ccd032020-06-12 22:59:11 +02001853 p = vim_strnsave(p, pend - p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854
1855 if (p != NULL && !mch_isdir(p))
Bram Moolenaard23a8232018-02-10 18:45:26 +01001856 VIM_CLEAR(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857 else
1858 {
1859#ifdef USE_EXE_NAME
Bram Moolenaar85a20022019-12-21 18:25:54 +01001860 // may add "/vim54" or "/runtime" if it exists
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 if (vimruntime && (pend = vim_version_dir(p)) != NULL)
1862 {
1863 vim_free(p);
1864 p = pend;
1865 }
1866#endif
1867 *mustfree = TRUE;
1868 }
1869 }
1870 }
1871
1872#ifdef HAVE_PATHDEF
Bram Moolenaar85a20022019-12-21 18:25:54 +01001873 // When there is a pathdef.c file we can use default_vim_dir and
1874 // default_vimruntime_dir
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 if (p == NULL)
1876 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001877 // Only use default_vimruntime_dir when it is not empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 if (vimruntime && *default_vimruntime_dir != NUL)
1879 {
1880 p = default_vimruntime_dir;
1881 *mustfree = FALSE;
1882 }
1883 else if (*default_vim_dir != NUL)
1884 {
1885 if (vimruntime && (p = vim_version_dir(default_vim_dir)) != NULL)
1886 *mustfree = TRUE;
1887 else
1888 {
1889 p = default_vim_dir;
1890 *mustfree = FALSE;
1891 }
1892 }
1893 }
1894#endif
1895
1896 /*
1897 * Set the environment variable, so that the new value can be found fast
1898 * next time, and others can also use it (e.g. Perl).
1899 */
1900 if (p != NULL)
1901 {
1902 if (vimruntime)
1903 {
1904 vim_setenv((char_u *)"VIMRUNTIME", p);
1905 didset_vimruntime = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906 }
1907 else
1908 {
1909 vim_setenv((char_u *)"VIM", p);
1910 didset_vim = TRUE;
1911 }
1912 }
1913 return p;
1914}
1915
Bram Moolenaar137374f2018-05-13 15:59:50 +02001916 void
1917vim_unsetenv(char_u *var)
1918{
1919#ifdef HAVE_UNSETENV
1920 unsetenv((char *)var);
1921#else
Bram Moolenaar1af6a4b2018-05-14 22:58:34 +02001922 vim_setenv(var, (char_u *)"");
Bram Moolenaar137374f2018-05-13 15:59:50 +02001923#endif
1924}
1925
LemonBoy77142312022-04-15 20:50:46 +01001926/*
1927 * Removes environment variable "name" and take care of side effects.
1928 */
1929 void
1930vim_unsetenv_ext(char_u *var)
1931{
1932 vim_unsetenv(var);
1933
1934 // "homedir" is not cleared, keep using the old value until $HOME is set.
1935 if (STRICMP(var, "VIM") == 0)
1936 didset_vim = FALSE;
1937 else if (STRICMP(var, "VIMRUNTIME") == 0)
1938 didset_vimruntime = FALSE;
1939}
Bram Moolenaar137374f2018-05-13 15:59:50 +02001940
Bram Moolenaar092e09c2022-04-15 23:29:23 +01001941#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01001943 * Set environment variable "name" and take care of side effects.
1944 */
1945 void
1946vim_setenv_ext(char_u *name, char_u *val)
1947{
1948 vim_setenv(name, val);
1949 if (STRICMP(name, "HOME") == 0)
1950 init_homedir();
1951 else if (didset_vim && STRICMP(name, "VIM") == 0)
1952 didset_vim = FALSE;
LemonBoy77142312022-04-15 20:50:46 +01001953 else if (didset_vimruntime && STRICMP(name, "VIMRUNTIME") == 0)
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01001954 didset_vimruntime = FALSE;
1955}
Dominique Pelle748b3082022-01-08 12:41:16 +00001956#endif
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01001957
1958/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001959 * Our portable version of setenv.
1960 */
1961 void
Bram Moolenaar9b578142016-01-30 19:39:49 +01001962vim_setenv(char_u *name, char_u *val)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963{
1964#ifdef HAVE_SETENV
1965 mch_setenv((char *)name, (char *)val, 1);
1966#else
1967 char_u *envbuf;
1968
1969 /*
1970 * Putenv does not copy the string, it has to remain
1971 * valid. The allocated memory will never be freed.
1972 */
Bram Moolenaar964b3742019-05-24 18:54:09 +02001973 envbuf = alloc(STRLEN(name) + STRLEN(val) + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 if (envbuf != NULL)
1975 {
1976 sprintf((char *)envbuf, "%s=%s", name, val);
1977 putenv((char *)envbuf);
1978 }
1979#endif
Bram Moolenaar011a34d2012-02-29 13:49:09 +01001980#ifdef FEAT_GETTEXT
1981 /*
1982 * When setting $VIMRUNTIME adjust the directory to find message
1983 * translations to $VIMRUNTIME/lang.
1984 */
1985 if (*val != NUL && STRICMP(name, "VIMRUNTIME") == 0)
1986 {
1987 char_u *buf = concat_str(val, (char_u *)"/lang");
1988
1989 if (buf != NULL)
1990 {
1991 bindtextdomain(VIMPACKAGE, (char *)buf);
1992 vim_free(buf);
1993 }
1994 }
1995#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001996}
1997
Bram Moolenaar071d4272004-06-13 20:20:40 +00001998/*
1999 * Function given to ExpandGeneric() to obtain an environment variable name.
2000 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001 char_u *
Bram Moolenaar9b578142016-01-30 19:39:49 +01002002get_env_name(
2003 expand_T *xp UNUSED,
2004 int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005{
Bram Moolenaard0573012017-10-28 21:11:06 +02002006# if defined(AMIGA)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007 /*
Bram Moolenaard0573012017-10-28 21:11:06 +02002008 * No environ[] on the Amiga.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 */
2010 return NULL;
2011# else
2012# ifndef __WIN32__
Bram Moolenaar85a20022019-12-21 18:25:54 +01002013 // Borland C++ 5.2 has this in a header file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014 extern char **environ;
2015# endif
Bram Moolenaar21cf8232004-07-16 20:18:37 +00002016# define ENVNAMELEN 100
2017 static char_u name[ENVNAMELEN];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 char_u *str;
2019 int n;
2020
2021 str = (char_u *)environ[idx];
2022 if (str == NULL)
2023 return NULL;
2024
Bram Moolenaar21cf8232004-07-16 20:18:37 +00002025 for (n = 0; n < ENVNAMELEN - 1; ++n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 {
2027 if (str[n] == '=' || str[n] == NUL)
2028 break;
2029 name[n] = str[n];
2030 }
2031 name[n] = NUL;
2032 return name;
2033# endif
2034}
Bram Moolenaar24305862012-08-15 14:05:05 +02002035
2036/*
Bram Moolenaar6b0b83f2018-09-10 19:03:05 +02002037 * Add a user name to the list of users in ga_users.
2038 * Do nothing if user name is NULL or empty.
2039 */
2040 static void
2041add_user(char_u *user, int need_copy)
2042{
2043 char_u *user_copy = (user != NULL && need_copy)
2044 ? vim_strsave(user) : user;
2045
2046 if (user_copy == NULL || *user_copy == NUL || ga_grow(&ga_users, 1) == FAIL)
2047 {
2048 if (need_copy)
2049 vim_free(user);
2050 return;
2051 }
2052 ((char_u **)(ga_users.ga_data))[ga_users.ga_len++] = user_copy;
2053}
2054
2055/*
Bram Moolenaar24305862012-08-15 14:05:05 +02002056 * Find all user names for user completion.
2057 * Done only once and then cached.
2058 */
2059 static void
Bram Moolenaar9b578142016-01-30 19:39:49 +01002060init_users(void)
Bram Moolenaar01b626c2013-06-16 22:49:14 +02002061{
Bram Moolenaar24305862012-08-15 14:05:05 +02002062 static int lazy_init_done = FALSE;
2063
2064 if (lazy_init_done)
2065 return;
2066
2067 lazy_init_done = TRUE;
2068 ga_init2(&ga_users, sizeof(char_u *), 20);
2069
2070# if defined(HAVE_GETPWENT) && defined(HAVE_PWD_H)
2071 {
Bram Moolenaar24305862012-08-15 14:05:05 +02002072 struct passwd* pw;
2073
2074 setpwent();
2075 while ((pw = getpwent()) != NULL)
Bram Moolenaar6b0b83f2018-09-10 19:03:05 +02002076 add_user((char_u *)pw->pw_name, TRUE);
Bram Moolenaar24305862012-08-15 14:05:05 +02002077 endpwent();
2078 }
Bram Moolenaar4f974752019-02-17 17:44:42 +01002079# elif defined(MSWIN)
Bram Moolenaar828c3d72018-06-19 18:58:07 +02002080 {
Bram Moolenaar828c3d72018-06-19 18:58:07 +02002081 DWORD nusers = 0, ntotal = 0, i;
2082 PUSER_INFO_0 uinfo;
2083
2084 if (NetUserEnum(NULL, 0, 0, (LPBYTE *) &uinfo, MAX_PREFERRED_LENGTH,
2085 &nusers, &ntotal, NULL) == NERR_Success)
2086 {
2087 for (i = 0; i < nusers; i++)
Bram Moolenaar6b0b83f2018-09-10 19:03:05 +02002088 add_user(utf16_to_enc(uinfo[i].usri0_name, NULL), FALSE);
Bram Moolenaar828c3d72018-06-19 18:58:07 +02002089
2090 NetApiBufferFree(uinfo);
2091 }
2092 }
Bram Moolenaar24305862012-08-15 14:05:05 +02002093# endif
Bram Moolenaar6b0b83f2018-09-10 19:03:05 +02002094# if defined(HAVE_GETPWNAM)
2095 {
2096 char_u *user_env = mch_getenv((char_u *)"USER");
2097
2098 // The $USER environment variable may be a valid remote user name (NIS,
2099 // LDAP) not already listed by getpwent(), as getpwent() only lists
2100 // local user names. If $USER is not already listed, check whether it
2101 // is a valid remote user name using getpwnam() and if it is, add it to
2102 // the list of user names.
2103
2104 if (user_env != NULL && *user_env != NUL)
2105 {
2106 int i;
2107
2108 for (i = 0; i < ga_users.ga_len; i++)
2109 {
2110 char_u *local_user = ((char_u **)ga_users.ga_data)[i];
2111
2112 if (STRCMP(local_user, user_env) == 0)
2113 break;
2114 }
2115
2116 if (i == ga_users.ga_len)
2117 {
2118 struct passwd *pw = getpwnam((char *)user_env);
2119
2120 if (pw != NULL)
2121 add_user((char_u *)pw->pw_name, TRUE);
2122 }
2123 }
2124 }
2125# endif
Bram Moolenaar24305862012-08-15 14:05:05 +02002126}
2127
2128/*
2129 * Function given to ExpandGeneric() to obtain an user names.
2130 */
2131 char_u*
Bram Moolenaar9b578142016-01-30 19:39:49 +01002132get_users(expand_T *xp UNUSED, int idx)
Bram Moolenaar24305862012-08-15 14:05:05 +02002133{
2134 init_users();
2135 if (idx < ga_users.ga_len)
2136 return ((char_u **)ga_users.ga_data)[idx];
2137 return NULL;
2138}
2139
2140/*
2141 * Check whether name matches a user name. Return:
2142 * 0 if name does not match any user name.
2143 * 1 if name partially matches the beginning of a user name.
2144 * 2 is name fully matches a user name.
2145 */
Bram Moolenaar6c5d1042018-07-07 16:41:13 +02002146 int
2147match_user(char_u *name)
Bram Moolenaar24305862012-08-15 14:05:05 +02002148{
2149 int i;
2150 int n = (int)STRLEN(name);
2151 int result = 0;
2152
2153 init_users();
2154 for (i = 0; i < ga_users.ga_len; i++)
2155 {
2156 if (STRCMP(((char_u **)ga_users.ga_data)[i], name) == 0)
Bram Moolenaar85a20022019-12-21 18:25:54 +01002157 return 2; // full match
Bram Moolenaar24305862012-08-15 14:05:05 +02002158 if (STRNCMP(((char_u **)ga_users.ga_data)[i], name, n) == 0)
Bram Moolenaar85a20022019-12-21 18:25:54 +01002159 result = 1; // partial match
Bram Moolenaar24305862012-08-15 14:05:05 +02002160 }
2161 return result;
2162}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02002164 static void
Bram Moolenaar9b578142016-01-30 19:39:49 +01002165prepare_to_exit(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166{
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002167#if defined(SIGHUP) && defined(SIG_IGN)
Bram Moolenaar85a20022019-12-21 18:25:54 +01002168 // Ignore SIGHUP, because a dropped connection causes a read error, which
2169 // makes Vim exit and then handling SIGHUP causes various reentrance
2170 // problems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002171 signal(SIGHUP, SIG_IGN);
2172#endif
2173
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174#ifdef FEAT_GUI
2175 if (gui.in_use)
2176 {
2177 gui.dying = TRUE;
Bram Moolenaar85a20022019-12-21 18:25:54 +01002178 out_trash(); // trash any pending output
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 }
2180 else
2181#endif
2182 {
2183 windgoto((int)Rows - 1, 0);
2184
2185 /*
2186 * Switch terminal mode back now, so messages end up on the "normal"
2187 * screen (if there are two screens).
2188 */
2189 settmode(TMODE_COOK);
Bram Moolenaarcea912a2016-10-12 14:20:24 +02002190 stoptermcap();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 out_flush();
2192 }
2193}
2194
2195/*
2196 * Preserve files and exit.
2197 * When called IObuff must contain a message.
Bram Moolenaarbec9c202013-09-05 21:41:39 +02002198 * NOTE: This may be called from deathtrap() in a signal handler, avoid unsafe
2199 * functions, such as allocating memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 */
2201 void
Bram Moolenaar9b578142016-01-30 19:39:49 +01002202preserve_exit(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203{
2204 buf_T *buf;
2205
2206 prepare_to_exit();
2207
Bram Moolenaar85a20022019-12-21 18:25:54 +01002208 // Setting this will prevent free() calls. That avoids calling free()
2209 // recursively when free() was invoked with a bad pointer.
Bram Moolenaar4770d092006-01-12 23:22:24 +00002210 really_exiting = TRUE;
2211
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212 out_str(IObuff);
Bram Moolenaar85a20022019-12-21 18:25:54 +01002213 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214 out_flush();
2215
Bram Moolenaar85a20022019-12-21 18:25:54 +01002216 ml_close_notmod(); // close all not-modified buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217
Bram Moolenaar29323592016-07-24 22:04:11 +02002218 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219 {
2220 if (buf->b_ml.ml_mfp != NULL && buf->b_ml.ml_mfp->mf_fname != NULL)
2221 {
Bram Moolenaar69212b12020-05-10 14:14:03 +02002222 OUT_STR("Vim: preserving files...\r\n");
Bram Moolenaar85a20022019-12-21 18:25:54 +01002223 screen_start(); // don't know where cursor is now
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224 out_flush();
Bram Moolenaar85a20022019-12-21 18:25:54 +01002225 ml_sync_all(FALSE, FALSE); // preserve all swap files
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 break;
2227 }
2228 }
2229
Bram Moolenaar85a20022019-12-21 18:25:54 +01002230 ml_close_all(FALSE); // close all memfiles, without deleting
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231
Bram Moolenaar69212b12020-05-10 14:14:03 +02002232 OUT_STR("Vim: Finished.\r\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233
2234 getout(1);
2235}
2236
2237/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238 * Check for CTRL-C pressed, but only once in a while.
2239 * Should be used instead of ui_breakcheck() for functions that check for
2240 * each line in the file. Calling ui_breakcheck() each time takes too much
2241 * time, because it can be a system call.
2242 */
2243
2244#ifndef BREAKCHECK_SKIP
Bram Moolenaarb4fe0eb2019-07-21 14:50:21 +02002245# define BREAKCHECK_SKIP 1000
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246#endif
2247
2248static int breakcheck_count = 0;
2249
2250 void
Bram Moolenaar9b578142016-01-30 19:39:49 +01002251line_breakcheck(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252{
2253 if (++breakcheck_count >= BREAKCHECK_SKIP)
2254 {
2255 breakcheck_count = 0;
2256 ui_breakcheck();
2257 }
2258}
2259
2260/*
2261 * Like line_breakcheck() but check 10 times less often.
2262 */
2263 void
Bram Moolenaar9b578142016-01-30 19:39:49 +01002264fast_breakcheck(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265{
2266 if (++breakcheck_count >= BREAKCHECK_SKIP * 10)
2267 {
2268 breakcheck_count = 0;
2269 ui_breakcheck();
2270 }
2271}
2272
Dominique Pelle748b3082022-01-08 12:41:16 +00002273# if defined(FEAT_SPELL) || defined(PROTO)
Bram Moolenaarf1ec3782020-03-20 19:37:47 +01002274/*
2275 * Like line_breakcheck() but check 100 times less often.
2276 */
2277 void
2278veryfast_breakcheck(void)
2279{
2280 if (++breakcheck_count >= BREAKCHECK_SKIP * 100)
2281 {
2282 breakcheck_count = 0;
2283 ui_breakcheck();
2284 }
2285}
Dominique Pelle748b3082022-01-08 12:41:16 +00002286#endif
Bram Moolenaarf1ec3782020-03-20 19:37:47 +01002287
Bram Moolenaar0a52df52019-08-18 22:26:31 +02002288#if defined(VIM_BACKTICK) || defined(FEAT_EVAL) \
2289 || (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
2290 || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291
2292#ifndef SEEK_SET
2293# define SEEK_SET 0
2294#endif
2295#ifndef SEEK_END
2296# define SEEK_END 2
2297#endif
2298
2299/*
2300 * Get the stdout of an external command.
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02002301 * If "ret_len" is NULL replace NUL characters with NL. When "ret_len" is not
2302 * NULL store the length there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002303 * Returns an allocated string, or NULL for error.
2304 */
2305 char_u *
Bram Moolenaar9b578142016-01-30 19:39:49 +01002306get_cmd_output(
2307 char_u *cmd,
Bram Moolenaar85a20022019-12-21 18:25:54 +01002308 char_u *infile, // optional input file name
2309 int flags, // can be SHELL_SILENT
Bram Moolenaar9b578142016-01-30 19:39:49 +01002310 int *ret_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311{
2312 char_u *tempname;
2313 char_u *command;
2314 char_u *buffer = NULL;
2315 int len;
2316 int i = 0;
2317 FILE *fd;
2318
2319 if (check_restricted() || check_secure())
2320 return NULL;
2321
Bram Moolenaar85a20022019-12-21 18:25:54 +01002322 // get a name for the temp file
Bram Moolenaare5c421c2015-03-31 13:33:08 +02002323 if ((tempname = vim_tempname('o', FALSE)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002324 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00002325 emsg(_(e_cant_get_temp_file_name));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 return NULL;
2327 }
2328
Bram Moolenaar85a20022019-12-21 18:25:54 +01002329 // Add the redirection stuff
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002330 command = make_filter_cmd(cmd, infile, tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331 if (command == NULL)
2332 goto done;
2333
2334 /*
2335 * Call the shell to execute the command (errors are ignored).
2336 * Don't check timestamps here.
2337 */
2338 ++no_check_timestamps;
2339 call_shell(command, SHELL_DOOUT | SHELL_EXPAND | flags);
2340 --no_check_timestamps;
2341
2342 vim_free(command);
2343
2344 /*
2345 * read the names from the file into memory
2346 */
2347# ifdef VMS
Bram Moolenaar85a20022019-12-21 18:25:54 +01002348 // created temporary file is not always readable as binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349 fd = mch_fopen((char *)tempname, "r");
2350# else
2351 fd = mch_fopen((char *)tempname, READBIN);
2352# endif
2353
Bram Moolenaar3df8f6e2022-04-17 14:01:51 +01002354 // Not being able to seek means we can't read the file.
2355 if (fd == NULL
2356 || fseek(fd, 0L, SEEK_END) == -1
2357 || (len = ftell(fd)) == -1 // get size of temp file
2358 || fseek(fd, 0L, SEEK_SET) == -1) // back to the start
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359 {
Bram Moolenaara9549c92022-04-17 14:18:11 +01002360 semsg(_(e_cannot_read_from_str_2), tempname);
Bram Moolenaar3df8f6e2022-04-17 14:01:51 +01002361 if (fd != NULL)
2362 fclose(fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 goto done;
2364 }
2365
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366 buffer = alloc(len + 1);
2367 if (buffer != NULL)
2368 i = (int)fread((char *)buffer, (size_t)1, (size_t)len, fd);
2369 fclose(fd);
2370 mch_remove(tempname);
2371 if (buffer == NULL)
2372 goto done;
2373#ifdef VMS
Bram Moolenaar85a20022019-12-21 18:25:54 +01002374 len = i; // VMS doesn't give us what we asked for...
Bram Moolenaar071d4272004-06-13 20:20:40 +00002375#endif
2376 if (i != len)
2377 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00002378 semsg(_(e_cant_read_file_str), tempname);
Bram Moolenaard23a8232018-02-10 18:45:26 +01002379 VIM_CLEAR(buffer);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380 }
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02002381 else if (ret_len == NULL)
Bram Moolenaarfb332a22013-08-03 14:10:50 +02002382 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002383 // Change NUL into SOH, otherwise the string is truncated.
Bram Moolenaarfb332a22013-08-03 14:10:50 +02002384 for (i = 0; i < len; ++i)
Bram Moolenaarf40f4ab2013-08-03 17:31:28 +02002385 if (buffer[i] == NUL)
2386 buffer[i] = 1;
Bram Moolenaarfb332a22013-08-03 14:10:50 +02002387
Bram Moolenaar85a20022019-12-21 18:25:54 +01002388 buffer[len] = NUL; // make sure the buffer is terminated
Bram Moolenaarfb332a22013-08-03 14:10:50 +02002389 }
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02002390 else
2391 *ret_len = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392
2393done:
2394 vim_free(tempname);
2395 return buffer;
2396}
Bram Moolenaar26262f82019-09-04 20:59:15 +02002397
2398# if defined(FEAT_EVAL) || defined(PROTO)
2399
Bram Moolenaar840d16f2019-09-10 21:27:18 +02002400 static void
Bram Moolenaar26262f82019-09-04 20:59:15 +02002401get_cmd_output_as_rettv(
2402 typval_T *argvars,
2403 typval_T *rettv,
2404 int retlist)
2405{
2406 char_u *res = NULL;
2407 char_u *p;
2408 char_u *infile = NULL;
2409 int err = FALSE;
2410 FILE *fd;
2411 list_T *list = NULL;
2412 int flags = SHELL_SILENT;
2413
2414 rettv->v_type = VAR_STRING;
2415 rettv->vval.v_string = NULL;
2416 if (check_restricted() || check_secure())
2417 goto errret;
2418
Yegappan Lakshmanan0ad871d2021-07-23 20:37:56 +02002419 if (in_vim9script()
2420 && (check_for_string_arg(argvars, 0) == FAIL
Bram Moolenaar944cc9c2022-06-27 22:17:37 +01002421 || check_for_opt_string_or_number_or_list_arg(argvars, 1)
2422 == FAIL))
Yegappan Lakshmanan0ad871d2021-07-23 20:37:56 +02002423 return;
2424
Bram Moolenaar26262f82019-09-04 20:59:15 +02002425 if (argvars[1].v_type != VAR_UNKNOWN)
2426 {
2427 /*
2428 * Write the text to a temp file, to be used for input of the shell
2429 * command.
2430 */
2431 if ((infile = vim_tempname('i', TRUE)) == NULL)
2432 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00002433 emsg(_(e_cant_get_temp_file_name));
Bram Moolenaar26262f82019-09-04 20:59:15 +02002434 goto errret;
2435 }
2436
2437 fd = mch_fopen((char *)infile, WRITEBIN);
2438 if (fd == NULL)
2439 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00002440 semsg(_(e_cant_open_file_str), infile);
Bram Moolenaar26262f82019-09-04 20:59:15 +02002441 goto errret;
2442 }
2443 if (argvars[1].v_type == VAR_NUMBER)
2444 {
2445 linenr_T lnum;
2446 buf_T *buf;
2447
2448 buf = buflist_findnr(argvars[1].vval.v_number);
2449 if (buf == NULL)
2450 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00002451 semsg(_(e_buffer_nr_does_not_exist), argvars[1].vval.v_number);
Bram Moolenaar26262f82019-09-04 20:59:15 +02002452 fclose(fd);
2453 goto errret;
2454 }
2455
2456 for (lnum = 1; lnum <= buf->b_ml.ml_line_count; lnum++)
2457 {
2458 for (p = ml_get_buf(buf, lnum, FALSE); *p != NUL; ++p)
2459 if (putc(*p == '\n' ? NUL : *p, fd) == EOF)
2460 {
2461 err = TRUE;
2462 break;
2463 }
2464 if (putc(NL, fd) == EOF)
2465 {
2466 err = TRUE;
2467 break;
2468 }
2469 }
2470 }
2471 else if (argvars[1].v_type == VAR_LIST)
2472 {
2473 if (write_list(fd, argvars[1].vval.v_list, TRUE) == FAIL)
2474 err = TRUE;
2475 }
2476 else
2477 {
2478 size_t len;
2479 char_u buf[NUMBUFLEN];
2480
2481 p = tv_get_string_buf_chk(&argvars[1], buf);
2482 if (p == NULL)
2483 {
2484 fclose(fd);
Bram Moolenaar85a20022019-12-21 18:25:54 +01002485 goto errret; // type error; errmsg already given
Bram Moolenaar26262f82019-09-04 20:59:15 +02002486 }
2487 len = STRLEN(p);
2488 if (len > 0 && fwrite(p, len, 1, fd) != 1)
2489 err = TRUE;
2490 }
2491 if (fclose(fd) != 0)
2492 err = TRUE;
2493 if (err)
2494 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00002495 emsg(_(e_error_writing_temp_file));
Bram Moolenaar26262f82019-09-04 20:59:15 +02002496 goto errret;
2497 }
2498 }
2499
Bram Moolenaar85a20022019-12-21 18:25:54 +01002500 // Omit SHELL_COOKED when invoked with ":silent". Avoids that the shell
2501 // echoes typeahead, that messes up the display.
Bram Moolenaar26262f82019-09-04 20:59:15 +02002502 if (!msg_silent)
2503 flags += SHELL_COOKED;
2504
2505 if (retlist)
2506 {
2507 int len;
2508 listitem_T *li;
2509 char_u *s = NULL;
2510 char_u *start;
2511 char_u *end;
2512 int i;
2513
2514 res = get_cmd_output(tv_get_string(&argvars[0]), infile, flags, &len);
2515 if (res == NULL)
2516 goto errret;
2517
2518 list = list_alloc();
2519 if (list == NULL)
2520 goto errret;
2521
2522 for (i = 0; i < len; ++i)
2523 {
2524 start = res + i;
2525 while (i < len && res[i] != NL)
2526 ++i;
2527 end = res + i;
2528
2529 s = alloc(end - start + 1);
2530 if (s == NULL)
2531 goto errret;
2532
2533 for (p = s; start < end; ++p, ++start)
2534 *p = *start == NUL ? NL : *start;
2535 *p = NUL;
2536
2537 li = listitem_alloc();
2538 if (li == NULL)
2539 {
2540 vim_free(s);
2541 goto errret;
2542 }
2543 li->li_tv.v_type = VAR_STRING;
2544 li->li_tv.v_lock = 0;
2545 li->li_tv.vval.v_string = s;
2546 list_append(list, li);
2547 }
2548
2549 rettv_list_set(rettv, list);
2550 list = NULL;
2551 }
2552 else
2553 {
2554 res = get_cmd_output(tv_get_string(&argvars[0]), infile, flags, NULL);
2555#ifdef USE_CRNL
Bram Moolenaar85a20022019-12-21 18:25:54 +01002556 // translate <CR><NL> into <NL>
Bram Moolenaar26262f82019-09-04 20:59:15 +02002557 if (res != NULL)
2558 {
2559 char_u *s, *d;
2560
2561 d = res;
2562 for (s = res; *s; ++s)
2563 {
2564 if (s[0] == CAR && s[1] == NL)
2565 ++s;
2566 *d++ = *s;
2567 }
2568 *d = NUL;
2569 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570#endif
Bram Moolenaar26262f82019-09-04 20:59:15 +02002571 rettv->vval.v_string = res;
2572 res = NULL;
2573 }
2574
2575errret:
2576 if (infile != NULL)
2577 {
2578 mch_remove(infile);
2579 vim_free(infile);
2580 }
2581 if (res != NULL)
2582 vim_free(res);
2583 if (list != NULL)
2584 list_free(list);
2585}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586
2587/*
Bram Moolenaar26262f82019-09-04 20:59:15 +02002588 * "system()" function
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589 */
2590 void
Bram Moolenaar26262f82019-09-04 20:59:15 +02002591f_system(typval_T *argvars, typval_T *rettv)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592{
Bram Moolenaar26262f82019-09-04 20:59:15 +02002593 get_cmd_output_as_rettv(argvars, rettv, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594}
2595
2596/*
Bram Moolenaar26262f82019-09-04 20:59:15 +02002597 * "systemlist()" function
2598 */
2599 void
2600f_systemlist(typval_T *argvars, typval_T *rettv)
2601{
2602 get_cmd_output_as_rettv(argvars, rettv, TRUE);
2603}
2604# endif // FEAT_EVAL
2605
2606#endif
2607
2608/*
Bram Moolenaara9dc3752010-07-11 20:46:53 +02002609 * Return TRUE when need to go to Insert mode because of 'insertmode'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002610 * Don't do this when still processing a command or a mapping.
2611 * Don't do this when inside a ":normal" command.
2612 */
2613 int
Bram Moolenaar9b578142016-01-30 19:39:49 +01002614goto_im(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615{
2616 return (p_im && stuff_empty() && typebuf_typed());
2617}
Bram Moolenaar75a8d742014-05-07 15:10:21 +02002618
2619/*
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02002620 * Returns the isolated name of the shell in allocated memory:
Bram Moolenaar75a8d742014-05-07 15:10:21 +02002621 * - Skip beyond any path. E.g., "/usr/bin/csh -f" -> "csh -f".
2622 * - Remove any argument. E.g., "csh -f" -> "csh".
2623 * But don't allow a space in the path, so that this works:
2624 * "/usr/bin/csh --rcfile ~/.cshrc"
2625 * But don't do that for Windows, it's common to have a space in the path.
Bram Moolenaar28ee8922020-10-28 20:20:00 +01002626 * Returns NULL when out of memory.
Bram Moolenaar75a8d742014-05-07 15:10:21 +02002627 */
2628 char_u *
Bram Moolenaar9b578142016-01-30 19:39:49 +01002629get_isolated_shell_name(void)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02002630{
2631 char_u *p;
2632
Bram Moolenaar4f974752019-02-17 17:44:42 +01002633#ifdef MSWIN
Bram Moolenaar75a8d742014-05-07 15:10:21 +02002634 p = gettail(p_sh);
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002635 p = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02002636#else
2637 p = skiptowhite(p_sh);
2638 if (*p == NUL)
2639 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002640 // No white space, use the tail.
Bram Moolenaar75a8d742014-05-07 15:10:21 +02002641 p = vim_strsave(gettail(p_sh));
2642 }
2643 else
2644 {
2645 char_u *p1, *p2;
2646
Bram Moolenaar85a20022019-12-21 18:25:54 +01002647 // Find the last path separator before the space.
Bram Moolenaar75a8d742014-05-07 15:10:21 +02002648 p1 = p_sh;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01002649 for (p2 = p_sh; p2 < p; MB_PTR_ADV(p2))
Bram Moolenaar75a8d742014-05-07 15:10:21 +02002650 if (vim_ispathsep(*p2))
2651 p1 = p2 + 1;
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002652 p = vim_strnsave(p1, p - p1);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02002653 }
2654#endif
2655 return p;
2656}
Bram Moolenaar5fd0f502019-02-13 23:13:28 +01002657
2658/*
2659 * Check if the "://" of a URL is at the pointer, return URL_SLASH.
2660 * Also check for ":\\", which MS Internet Explorer accepts, return
2661 * URL_BACKSLASH.
2662 */
2663 int
2664path_is_url(char_u *p)
2665{
2666 if (STRNCMP(p, "://", (size_t)3) == 0)
2667 return URL_SLASH;
2668 else if (STRNCMP(p, ":\\\\", (size_t)3) == 0)
2669 return URL_BACKSLASH;
2670 return 0;
2671}
2672
2673/*
Tsuyoshi CHO7b7a1182021-07-11 21:51:17 +02002674 * Check if "fname" starts with "name://" or "name:\\".
2675 * Return URL_SLASH for "name://", URL_BACKSLASH for "name:\\".
Bram Moolenaar5fd0f502019-02-13 23:13:28 +01002676 * Return zero otherwise.
2677 */
2678 int
2679path_with_url(char_u *fname)
2680{
2681 char_u *p;
2682
Tsuyoshi CHO7b7a1182021-07-11 21:51:17 +02002683 // We accept alphabetic characters and a dash in scheme part.
2684 // RFC 3986 allows for more, but it increases the risk of matching
2685 // non-URL text.
2686
2687 // first character must be alpha
2688 if (!isalpha(*fname))
2689 return 0;
2690
2691 // check body: alpha or dash
itchyny94e7d342021-10-21 18:01:13 +01002692 for (p = fname + 1; (isalpha(*p) || (*p == '-')); ++p)
Bram Moolenaar5fd0f502019-02-13 23:13:28 +01002693 ;
Tsuyoshi CHO7b7a1182021-07-11 21:51:17 +02002694
2695 // check last char is not a dash
2696 if (p[-1] == '-')
2697 return 0;
2698
2699 // "://" or ":\\" must follow
Bram Moolenaar5fd0f502019-02-13 23:13:28 +01002700 return path_is_url(p);
2701}
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02002702
Bram Moolenaar3075a452021-11-17 15:51:52 +00002703#if defined(FEAT_EVAL) || defined(PROTO)
2704/*
2705 * Return the dictionary of v:event.
2706 * Save and clear the value in case it already has items.
2707 */
2708 dict_T *
2709get_v_event(save_v_event_T *sve)
2710{
2711 dict_T *v_event = get_vim_var_dict(VV_EVENT);
2712
2713 if (v_event->dv_hashtab.ht_used > 0)
2714 {
2715 // recursive use of v:event, save, make empty and restore later
2716 sve->sve_did_save = TRUE;
2717 sve->sve_hashtab = v_event->dv_hashtab;
2718 hash_init(&v_event->dv_hashtab);
2719 }
2720 else
2721 sve->sve_did_save = FALSE;
2722 return v_event;
2723}
2724
2725 void
2726restore_v_event(dict_T *v_event, save_v_event_T *sve)
2727{
2728 dict_free_contents(v_event);
2729 if (sve->sve_did_save)
2730 v_event->dv_hashtab = sve->sve_hashtab;
2731 else
2732 hash_init(&v_event->dv_hashtab);
2733}
2734#endif
2735
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02002736/*
LemonBoy2bf52dd2022-04-09 18:17:34 +01002737 * Fires a ModeChanged autocmd event if appropriate.
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02002738 */
2739 void
LemonBoy2bf52dd2022-04-09 18:17:34 +01002740may_trigger_modechanged()
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02002741{
Bram Moolenaar3075a452021-11-17 15:51:52 +00002742#ifdef FEAT_EVAL
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02002743 dict_T *v_event;
Bram Moolenaar3075a452021-11-17 15:51:52 +00002744 save_v_event_T save_v_event;
LemonBoy2bf52dd2022-04-09 18:17:34 +01002745 char_u curr_mode[MODE_MAX_LENGTH];
2746 char_u pattern_buf[2 * MODE_MAX_LENGTH];
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02002747
2748 if (!has_modechanged())
2749 return;
2750
LemonBoy2bf52dd2022-04-09 18:17:34 +01002751 get_mode(curr_mode);
2752 if (STRCMP(curr_mode, last_mode) == 0)
=?UTF-8?q?Magnus=20Gro=C3=9F?=25def2c2021-10-22 18:56:39 +01002753 return;
=?UTF-8?q?Magnus=20Gro=C3=9F?=25def2c2021-10-22 18:56:39 +01002754
Bram Moolenaar3075a452021-11-17 15:51:52 +00002755 v_event = get_v_event(&save_v_event);
LemonBoy2bf52dd2022-04-09 18:17:34 +01002756 (void)dict_add_string(v_event, "new_mode", curr_mode);
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02002757 (void)dict_add_string(v_event, "old_mode", last_mode);
2758 dict_set_items_ro(v_event);
2759
2760 // concatenate modes in format "old_mode:new_mode"
LemonBoy2bf52dd2022-04-09 18:17:34 +01002761 vim_snprintf((char *)pattern_buf, sizeof(pattern_buf), "%s:%s", last_mode,
2762 curr_mode);
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02002763
LemonBoy2bf52dd2022-04-09 18:17:34 +01002764 apply_autocmds(EVENT_MODECHANGED, pattern_buf, NULL, FALSE, curbuf);
2765 STRCPY(last_mode, curr_mode);
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02002766
Bram Moolenaar3075a452021-11-17 15:51:52 +00002767 restore_v_event(v_event, &save_v_event);
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02002768#endif
2769}