blob: 02e7ed7dce2ac7bedeb0035cecaa74d6099ca590 [file] [log] [blame]
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001/* vi:set ts=8 sts=4 sw=4 noet:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar9810cfb2019-12-11 21:23:00 +010011 * filepath.c: dealing with file names and paths.
Bram Moolenaarb005cd82019-09-04 15:54:55 +020012 */
13
14#include "vim.h"
15
16#ifdef MSWIN
17/*
18 * Functions for ":8" filename modifier: get 8.3 version of a filename.
19 */
20
21/*
22 * Get the short path (8.3) for the filename in "fnamep".
23 * Only works for a valid file name.
24 * When the path gets longer "fnamep" is changed and the allocated buffer
25 * is put in "bufp".
26 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
27 * Returns OK on success, FAIL on failure.
28 */
29 static int
30get_short_pathname(char_u **fnamep, char_u **bufp, int *fnamelen)
31{
32 int l, len;
Bram Moolenaar3f396972019-10-30 04:10:06 +010033 WCHAR *newbuf;
34 WCHAR *wfname;
Bram Moolenaarb005cd82019-09-04 15:54:55 +020035
Bram Moolenaar3f396972019-10-30 04:10:06 +010036 len = MAXPATHL;
37 newbuf = malloc(len * sizeof(*newbuf));
38 if (newbuf == NULL)
39 return FAIL;
40
41 wfname = enc_to_utf16(*fnamep, NULL);
42 if (wfname == NULL)
43 {
44 vim_free(newbuf);
45 return FAIL;
46 }
47
48 l = GetShortPathNameW(wfname, newbuf, len);
Bram Moolenaarb005cd82019-09-04 15:54:55 +020049 if (l > len - 1)
50 {
Bram Moolenaar26262f82019-09-04 20:59:15 +020051 // If that doesn't work (not enough space), then save the string
52 // and try again with a new buffer big enough.
Bram Moolenaar3f396972019-10-30 04:10:06 +010053 WCHAR *newbuf_t = newbuf;
54 newbuf = vim_realloc(newbuf, (l + 1) * sizeof(*newbuf));
Bram Moolenaarb005cd82019-09-04 15:54:55 +020055 if (newbuf == NULL)
Bram Moolenaar3f396972019-10-30 04:10:06 +010056 {
57 vim_free(wfname);
58 vim_free(newbuf_t);
Bram Moolenaarb005cd82019-09-04 15:54:55 +020059 return FAIL;
Bram Moolenaar3f396972019-10-30 04:10:06 +010060 }
Bram Moolenaar26262f82019-09-04 20:59:15 +020061 // Really should always succeed, as the buffer is big enough.
Bram Moolenaar3f396972019-10-30 04:10:06 +010062 l = GetShortPathNameW(wfname, newbuf, l+1);
Bram Moolenaarb005cd82019-09-04 15:54:55 +020063 }
Bram Moolenaar3f396972019-10-30 04:10:06 +010064 if (l != 0)
65 {
66 char_u *p = utf16_to_enc(newbuf, NULL);
Bram Moolenaarc74fbfe2020-04-06 22:56:28 +020067
Bram Moolenaar3f396972019-10-30 04:10:06 +010068 if (p != NULL)
69 {
70 vim_free(*bufp);
71 *fnamep = *bufp = p;
72 }
73 else
74 {
75 vim_free(wfname);
76 vim_free(newbuf);
77 return FAIL;
78 }
79 }
80 vim_free(wfname);
81 vim_free(newbuf);
Bram Moolenaarb005cd82019-09-04 15:54:55 +020082
Bram Moolenaar2ade7142019-11-04 20:36:50 +010083 *fnamelen = l == 0 ? l : (int)STRLEN(*bufp);
Bram Moolenaarb005cd82019-09-04 15:54:55 +020084 return OK;
85}
86
87/*
88 * Get the short path (8.3) for the filename in "fname". The converted
89 * path is returned in "bufp".
90 *
91 * Some of the directories specified in "fname" may not exist. This function
92 * will shorten the existing directories at the beginning of the path and then
93 * append the remaining non-existing path.
94 *
95 * fname - Pointer to the filename to shorten. On return, contains the
96 * pointer to the shortened pathname
97 * bufp - Pointer to an allocated buffer for the filename.
98 * fnamelen - Length of the filename pointed to by fname
99 *
100 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
101 */
102 static int
103shortpath_for_invalid_fname(
104 char_u **fname,
105 char_u **bufp,
106 int *fnamelen)
107{
108 char_u *short_fname, *save_fname, *pbuf_unused;
109 char_u *endp, *save_endp;
110 char_u ch;
111 int old_len, len;
112 int new_len, sfx_len;
113 int retval = OK;
114
Bram Moolenaar26262f82019-09-04 20:59:15 +0200115 // Make a copy
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200116 old_len = *fnamelen;
117 save_fname = vim_strnsave(*fname, old_len);
118 pbuf_unused = NULL;
119 short_fname = NULL;
120
Bram Moolenaar26262f82019-09-04 20:59:15 +0200121 endp = save_fname + old_len - 1; // Find the end of the copy
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200122 save_endp = endp;
123
124 /*
125 * Try shortening the supplied path till it succeeds by removing one
126 * directory at a time from the tail of the path.
127 */
128 len = 0;
129 for (;;)
130 {
Bram Moolenaar26262f82019-09-04 20:59:15 +0200131 // go back one path-separator
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200132 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
133 --endp;
134 if (endp <= save_fname)
Bram Moolenaar26262f82019-09-04 20:59:15 +0200135 break; // processed the complete path
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200136
137 /*
138 * Replace the path separator with a NUL and try to shorten the
139 * resulting path.
140 */
141 ch = *endp;
142 *endp = 0;
143 short_fname = save_fname;
144 len = (int)STRLEN(short_fname) + 1;
145 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
146 {
147 retval = FAIL;
148 goto theend;
149 }
Bram Moolenaar26262f82019-09-04 20:59:15 +0200150 *endp = ch; // preserve the string
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200151
152 if (len > 0)
Bram Moolenaar26262f82019-09-04 20:59:15 +0200153 break; // successfully shortened the path
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200154
Bram Moolenaar26262f82019-09-04 20:59:15 +0200155 // failed to shorten the path. Skip the path separator
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200156 --endp;
157 }
158
159 if (len > 0)
160 {
161 /*
162 * Succeeded in shortening the path. Now concatenate the shortened
163 * path with the remaining path at the tail.
164 */
165
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100166 // Compute the length of the new path.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200167 sfx_len = (int)(save_endp - endp) + 1;
168 new_len = len + sfx_len;
169
170 *fnamelen = new_len;
171 vim_free(*bufp);
172 if (new_len > old_len)
173 {
Bram Moolenaar26262f82019-09-04 20:59:15 +0200174 // There is not enough space in the currently allocated string,
175 // copy it to a buffer big enough.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200176 *fname = *bufp = vim_strnsave(short_fname, new_len);
177 if (*fname == NULL)
178 {
179 retval = FAIL;
180 goto theend;
181 }
182 }
183 else
184 {
Bram Moolenaar26262f82019-09-04 20:59:15 +0200185 // Transfer short_fname to the main buffer (it's big enough),
186 // unless get_short_pathname() did its work in-place.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200187 *fname = *bufp = save_fname;
188 if (short_fname != save_fname)
Christian Brabandt81da16b2022-03-10 12:24:02 +0000189 STRNCPY(save_fname, short_fname, len);
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200190 save_fname = NULL;
191 }
192
Bram Moolenaar26262f82019-09-04 20:59:15 +0200193 // concat the not-shortened part of the path
Yegappan Lakshmanana34b4462022-06-11 10:43:26 +0100194 if ((*fname + len) != endp)
195 vim_strncpy(*fname + len, endp, sfx_len);
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200196 (*fname)[new_len] = NUL;
197 }
198
199theend:
200 vim_free(pbuf_unused);
201 vim_free(save_fname);
202
203 return retval;
204}
205
206/*
207 * Get a pathname for a partial path.
208 * Returns OK for success, FAIL for failure.
209 */
210 static int
211shortpath_for_partial(
212 char_u **fnamep,
213 char_u **bufp,
214 int *fnamelen)
215{
216 int sepcount, len, tflen;
217 char_u *p;
218 char_u *pbuf, *tfname;
219 int hasTilde;
220
Bram Moolenaar26262f82019-09-04 20:59:15 +0200221 // Count up the path separators from the RHS.. so we know which part
222 // of the path to return.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200223 sepcount = 0;
224 for (p = *fnamep; p < *fnamep + *fnamelen; MB_PTR_ADV(p))
225 if (vim_ispathsep(*p))
226 ++sepcount;
227
Bram Moolenaar26262f82019-09-04 20:59:15 +0200228 // Need full path first (use expand_env() to remove a "~/")
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200229 hasTilde = (**fnamep == '~');
230 if (hasTilde)
231 pbuf = tfname = expand_env_save(*fnamep);
232 else
233 pbuf = tfname = FullName_save(*fnamep, FALSE);
234
235 len = tflen = (int)STRLEN(tfname);
236
237 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
238 return FAIL;
239
240 if (len == 0)
241 {
Bram Moolenaar26262f82019-09-04 20:59:15 +0200242 // Don't have a valid filename, so shorten the rest of the
243 // path if we can. This CAN give us invalid 8.3 filenames, but
244 // there's not a lot of point in guessing what it might be.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200245 len = tflen;
246 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
247 return FAIL;
248 }
249
Bram Moolenaar26262f82019-09-04 20:59:15 +0200250 // Count the paths backward to find the beginning of the desired string.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200251 for (p = tfname + len - 1; p >= tfname; --p)
252 {
253 if (has_mbyte)
254 p -= mb_head_off(tfname, p);
255 if (vim_ispathsep(*p))
256 {
257 if (sepcount == 0 || (hasTilde && sepcount == 1))
258 break;
259 else
260 sepcount --;
261 }
262 }
263 if (hasTilde)
264 {
265 --p;
266 if (p >= tfname)
267 *p = '~';
268 else
269 return FAIL;
270 }
271 else
272 ++p;
273
Bram Moolenaar26262f82019-09-04 20:59:15 +0200274 // Copy in the string - p indexes into tfname - allocated at pbuf
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200275 vim_free(*bufp);
276 *fnamelen = (int)STRLEN(p);
277 *bufp = pbuf;
278 *fnamep = p;
279
280 return OK;
281}
282#endif // MSWIN
283
284/*
285 * Adjust a filename, according to a string of modifiers.
286 * *fnamep must be NUL terminated when called. When returning, the length is
287 * determined by *fnamelen.
288 * Returns VALID_ flags or -1 for failure.
289 * When there is an error, *fnamep is set to NULL.
290 */
291 int
292modify_fname(
293 char_u *src, // string with modifiers
294 int tilde_file, // "~" is a file name, not $HOME
295 int *usedlen, // characters after src that are used
296 char_u **fnamep, // file name so far
297 char_u **bufp, // buffer for allocated file name or NULL
298 int *fnamelen) // length of fnamep
299{
300 int valid = 0;
301 char_u *tail;
302 char_u *s, *p, *pbuf;
303 char_u dirname[MAXPATHL];
304 int c;
305 int has_fullname = 0;
Bram Moolenaard816cd92020-02-04 22:23:09 +0100306 int has_homerelative = 0;
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200307#ifdef MSWIN
308 char_u *fname_start = *fnamep;
309 int has_shortname = 0;
310#endif
311
312repeat:
Bram Moolenaar26262f82019-09-04 20:59:15 +0200313 // ":p" - full path/file_name
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200314 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
315 {
316 has_fullname = 1;
317
318 valid |= VALID_PATH;
319 *usedlen += 2;
320
Bram Moolenaar26262f82019-09-04 20:59:15 +0200321 // Expand "~/path" for all systems and "~user/path" for Unix and VMS
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200322 if ((*fnamep)[0] == '~'
323#if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
324 && ((*fnamep)[1] == '/'
325# ifdef BACKSLASH_IN_FILENAME
326 || (*fnamep)[1] == '\\'
327# endif
328 || (*fnamep)[1] == NUL)
329#endif
330 && !(tilde_file && (*fnamep)[1] == NUL)
331 )
332 {
333 *fnamep = expand_env_save(*fnamep);
Bram Moolenaar26262f82019-09-04 20:59:15 +0200334 vim_free(*bufp); // free any allocated file name
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200335 *bufp = *fnamep;
336 if (*fnamep == NULL)
337 return -1;
338 }
339
Bram Moolenaar26262f82019-09-04 20:59:15 +0200340 // When "/." or "/.." is used: force expansion to get rid of it.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200341 for (p = *fnamep; *p != NUL; MB_PTR_ADV(p))
342 {
343 if (vim_ispathsep(*p)
344 && p[1] == '.'
345 && (p[2] == NUL
346 || vim_ispathsep(p[2])
347 || (p[2] == '.'
348 && (p[3] == NUL || vim_ispathsep(p[3])))))
349 break;
350 }
351
Bram Moolenaar26262f82019-09-04 20:59:15 +0200352 // FullName_save() is slow, don't use it when not needed.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200353 if (*p != NUL || !vim_isAbsName(*fnamep))
354 {
355 *fnamep = FullName_save(*fnamep, *p != NUL);
Bram Moolenaar26262f82019-09-04 20:59:15 +0200356 vim_free(*bufp); // free any allocated file name
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200357 *bufp = *fnamep;
358 if (*fnamep == NULL)
359 return -1;
360 }
361
362#ifdef MSWIN
363# if _WIN32_WINNT >= 0x0500
364 if (vim_strchr(*fnamep, '~') != NULL)
365 {
366 // Expand 8.3 filename to full path. Needed to make sure the same
367 // file does not have two different names.
368 // Note: problem does not occur if _WIN32_WINNT < 0x0500.
369 WCHAR *wfname = enc_to_utf16(*fnamep, NULL);
370 WCHAR buf[_MAX_PATH];
371
372 if (wfname != NULL)
373 {
374 if (GetLongPathNameW(wfname, buf, _MAX_PATH))
375 {
K.Takata54119102022-02-03 13:33:03 +0000376 char_u *q = utf16_to_enc(buf, NULL);
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200377
K.Takata54119102022-02-03 13:33:03 +0000378 if (q != NULL)
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200379 {
380 vim_free(*bufp); // free any allocated file name
K.Takata54119102022-02-03 13:33:03 +0000381 *bufp = *fnamep = q;
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200382 }
383 }
384 vim_free(wfname);
385 }
386 }
387# endif
388#endif
Bram Moolenaar26262f82019-09-04 20:59:15 +0200389 // Append a path separator to a directory.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200390 if (mch_isdir(*fnamep))
391 {
Bram Moolenaar26262f82019-09-04 20:59:15 +0200392 // Make room for one or two extra characters.
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200393 *fnamep = vim_strnsave(*fnamep, STRLEN(*fnamep) + 2);
Bram Moolenaar26262f82019-09-04 20:59:15 +0200394 vim_free(*bufp); // free any allocated file name
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200395 *bufp = *fnamep;
396 if (*fnamep == NULL)
397 return -1;
398 add_pathsep(*fnamep);
399 }
400 }
401
Bram Moolenaar26262f82019-09-04 20:59:15 +0200402 // ":." - path relative to the current directory
403 // ":~" - path relative to the home directory
404 // ":8" - shortname path - postponed till after
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200405 while (src[*usedlen] == ':'
406 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
407 {
408 *usedlen += 2;
409 if (c == '8')
410 {
411#ifdef MSWIN
Bram Moolenaar26262f82019-09-04 20:59:15 +0200412 has_shortname = 1; // Postpone this.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200413#endif
414 continue;
415 }
416 pbuf = NULL;
Bram Moolenaar26262f82019-09-04 20:59:15 +0200417 // Need full path first (use expand_env() to remove a "~/")
Bram Moolenaard816cd92020-02-04 22:23:09 +0100418 if (!has_fullname && !has_homerelative)
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200419 {
=?UTF-8?q?Dundar=20G=C3=B6c?=78a84042022-02-09 15:20:39 +0000420 if (**fnamep == '~')
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200421 p = pbuf = expand_env_save(*fnamep);
422 else
423 p = pbuf = FullName_save(*fnamep, FALSE);
424 }
425 else
426 p = *fnamep;
427
428 has_fullname = 0;
429
430 if (p != NULL)
431 {
432 if (c == '.')
433 {
Bram Moolenaard816cd92020-02-04 22:23:09 +0100434 size_t namelen;
435
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200436 mch_dirname(dirname, MAXPATHL);
Bram Moolenaard816cd92020-02-04 22:23:09 +0100437 if (has_homerelative)
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200438 {
Bram Moolenaard816cd92020-02-04 22:23:09 +0100439 s = vim_strsave(dirname);
440 if (s != NULL)
441 {
442 home_replace(NULL, s, dirname, MAXPATHL, TRUE);
443 vim_free(s);
444 }
445 }
446 namelen = STRLEN(dirname);
447
448 // Do not call shorten_fname() here since it removes the prefix
449 // even though the path does not have a prefix.
450 if (fnamencmp(p, dirname, namelen) == 0)
451 {
452 p += namelen;
Bram Moolenaara78e9c62020-02-05 21:14:00 +0100453 if (vim_ispathsep(*p))
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200454 {
Bram Moolenaara78e9c62020-02-05 21:14:00 +0100455 while (*p && vim_ispathsep(*p))
456 ++p;
457 *fnamep = p;
458 if (pbuf != NULL)
459 {
460 // free any allocated file name
461 vim_free(*bufp);
462 *bufp = pbuf;
463 pbuf = NULL;
464 }
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200465 }
466 }
467 }
468 else
469 {
470 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
Bram Moolenaar26262f82019-09-04 20:59:15 +0200471 // Only replace it when it starts with '~'
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200472 if (*dirname == '~')
473 {
474 s = vim_strsave(dirname);
475 if (s != NULL)
476 {
477 *fnamep = s;
478 vim_free(*bufp);
479 *bufp = s;
Bram Moolenaard816cd92020-02-04 22:23:09 +0100480 has_homerelative = TRUE;
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200481 }
482 }
483 }
484 vim_free(pbuf);
485 }
486 }
487
488 tail = gettail(*fnamep);
489 *fnamelen = (int)STRLEN(*fnamep);
490
Bram Moolenaar26262f82019-09-04 20:59:15 +0200491 // ":h" - head, remove "/file_name", can be repeated
492 // Don't remove the first "/" or "c:\"
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200493 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
494 {
495 valid |= VALID_HEAD;
496 *usedlen += 2;
497 s = get_past_head(*fnamep);
498 while (tail > s && after_pathsep(s, tail))
499 MB_PTR_BACK(*fnamep, tail);
500 *fnamelen = (int)(tail - *fnamep);
501#ifdef VMS
502 if (*fnamelen > 0)
Bram Moolenaar26262f82019-09-04 20:59:15 +0200503 *fnamelen += 1; // the path separator is part of the path
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200504#endif
505 if (*fnamelen == 0)
506 {
Bram Moolenaar26262f82019-09-04 20:59:15 +0200507 // Result is empty. Turn it into "." to make ":cd %:h" work.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200508 p = vim_strsave((char_u *)".");
509 if (p == NULL)
510 return -1;
511 vim_free(*bufp);
512 *bufp = *fnamep = tail = p;
513 *fnamelen = 1;
514 }
515 else
516 {
517 while (tail > s && !after_pathsep(s, tail))
518 MB_PTR_BACK(*fnamep, tail);
519 }
520 }
521
Bram Moolenaar26262f82019-09-04 20:59:15 +0200522 // ":8" - shortname
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200523 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
524 {
525 *usedlen += 2;
526#ifdef MSWIN
527 has_shortname = 1;
528#endif
529 }
530
531#ifdef MSWIN
532 /*
533 * Handle ":8" after we have done 'heads' and before we do 'tails'.
534 */
535 if (has_shortname)
536 {
Bram Moolenaar26262f82019-09-04 20:59:15 +0200537 // Copy the string if it is shortened by :h and when it wasn't copied
538 // yet, because we are going to change it in place. Avoids changing
539 // the buffer name for "%:8".
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200540 if (*fnamelen < (int)STRLEN(*fnamep) || *fnamep == fname_start)
541 {
542 p = vim_strnsave(*fnamep, *fnamelen);
543 if (p == NULL)
544 return -1;
545 vim_free(*bufp);
546 *bufp = *fnamep = p;
547 }
548
Bram Moolenaar26262f82019-09-04 20:59:15 +0200549 // Split into two implementations - makes it easier. First is where
550 // there isn't a full name already, second is where there is.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200551 if (!has_fullname && !vim_isAbsName(*fnamep))
552 {
553 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
554 return -1;
555 }
556 else
557 {
558 int l = *fnamelen;
559
Bram Moolenaar26262f82019-09-04 20:59:15 +0200560 // Simple case, already have the full-name.
561 // Nearly always shorter, so try first time.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200562 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
563 return -1;
564
565 if (l == 0)
566 {
Bram Moolenaar26262f82019-09-04 20:59:15 +0200567 // Couldn't find the filename, search the paths.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200568 l = *fnamelen;
569 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
570 return -1;
571 }
572 *fnamelen = l;
573 }
574 }
575#endif // MSWIN
576
Bram Moolenaar26262f82019-09-04 20:59:15 +0200577 // ":t" - tail, just the basename
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200578 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
579 {
580 *usedlen += 2;
581 *fnamelen -= (int)(tail - *fnamep);
582 *fnamep = tail;
583 }
584
Bram Moolenaar26262f82019-09-04 20:59:15 +0200585 // ":e" - extension, can be repeated
586 // ":r" - root, without extension, can be repeated
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200587 while (src[*usedlen] == ':'
588 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
589 {
Bram Moolenaar26262f82019-09-04 20:59:15 +0200590 // find a '.' in the tail:
591 // - for second :e: before the current fname
592 // - otherwise: The last '.'
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200593 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
594 s = *fnamep - 2;
595 else
596 s = *fnamep + *fnamelen - 1;
597 for ( ; s > tail; --s)
598 if (s[0] == '.')
599 break;
Bram Moolenaar26262f82019-09-04 20:59:15 +0200600 if (src[*usedlen + 1] == 'e') // :e
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200601 {
602 if (s > tail)
603 {
604 *fnamelen += (int)(*fnamep - (s + 1));
605 *fnamep = s + 1;
606#ifdef VMS
Bram Moolenaar26262f82019-09-04 20:59:15 +0200607 // cut version from the extension
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200608 s = *fnamep + *fnamelen - 1;
609 for ( ; s > *fnamep; --s)
610 if (s[0] == ';')
611 break;
612 if (s > *fnamep)
613 *fnamelen = s - *fnamep;
614#endif
615 }
616 else if (*fnamep <= tail)
617 *fnamelen = 0;
618 }
Bram Moolenaar26262f82019-09-04 20:59:15 +0200619 else // :r
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200620 {
Bram Moolenaarb1892952019-10-08 23:26:50 +0200621 char_u *limit = *fnamep;
622
623 if (limit < tail)
624 limit = tail;
625 if (s > limit) // remove one extension
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200626 *fnamelen = (int)(s - *fnamep);
627 }
628 *usedlen += 2;
629 }
630
Bram Moolenaar26262f82019-09-04 20:59:15 +0200631 // ":s?pat?foo?" - substitute
632 // ":gs?pat?foo?" - global substitute
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200633 if (src[*usedlen] == ':'
634 && (src[*usedlen + 1] == 's'
635 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
636 {
637 char_u *str;
638 char_u *pat;
639 char_u *sub;
640 int sep;
641 char_u *flags;
642 int didit = FALSE;
643
644 flags = (char_u *)"";
645 s = src + *usedlen + 2;
646 if (src[*usedlen + 1] == 'g')
647 {
648 flags = (char_u *)"g";
649 ++s;
650 }
651
652 sep = *s++;
653 if (sep)
654 {
Bram Moolenaar26262f82019-09-04 20:59:15 +0200655 // find end of pattern
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200656 p = vim_strchr(s, sep);
657 if (p != NULL)
658 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200659 pat = vim_strnsave(s, p - s);
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200660 if (pat != NULL)
661 {
662 s = p + 1;
Bram Moolenaar26262f82019-09-04 20:59:15 +0200663 // find end of substitution
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200664 p = vim_strchr(s, sep);
665 if (p != NULL)
666 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200667 sub = vim_strnsave(s, p - s);
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200668 str = vim_strnsave(*fnamep, *fnamelen);
669 if (sub != NULL && str != NULL)
670 {
671 *usedlen = (int)(p + 1 - src);
672 s = do_string_sub(str, pat, sub, NULL, flags);
673 if (s != NULL)
674 {
675 *fnamep = s;
676 *fnamelen = (int)STRLEN(s);
677 vim_free(*bufp);
678 *bufp = s;
679 didit = TRUE;
680 }
681 }
682 vim_free(sub);
683 vim_free(str);
684 }
685 vim_free(pat);
686 }
687 }
Bram Moolenaar26262f82019-09-04 20:59:15 +0200688 // after using ":s", repeat all the modifiers
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200689 if (didit)
690 goto repeat;
691 }
692 }
693
694 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'S')
695 {
Bram Moolenaar26262f82019-09-04 20:59:15 +0200696 // vim_strsave_shellescape() needs a NUL terminated string.
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200697 c = (*fnamep)[*fnamelen];
698 if (c != NUL)
699 (*fnamep)[*fnamelen] = NUL;
700 p = vim_strsave_shellescape(*fnamep, FALSE, FALSE);
701 if (c != NUL)
702 (*fnamep)[*fnamelen] = c;
703 if (p == NULL)
704 return -1;
705 vim_free(*bufp);
706 *bufp = *fnamep = p;
707 *fnamelen = (int)STRLEN(p);
708 *usedlen += 2;
709 }
710
711 return valid;
712}
713
Bram Moolenaar273af492020-09-25 23:49:01 +0200714/*
715 * Shorten the path of a file from "~/foo/../.bar/fname" to "~/f/../.b/fname"
716 * "trim_len" specifies how many characters to keep for each directory.
717 * Must be 1 or more.
718 * It's done in-place.
719 */
720 static void
721shorten_dir_len(char_u *str, int trim_len)
722{
723 char_u *tail, *s, *d;
724 int skip = FALSE;
725 int dirchunk_len = 0;
726
727 tail = gettail(str);
728 d = str;
729 for (s = str; ; ++s)
730 {
731 if (s >= tail) // copy the whole tail
732 {
733 *d++ = *s;
734 if (*s == NUL)
735 break;
736 }
737 else if (vim_ispathsep(*s)) // copy '/' and next char
738 {
739 *d++ = *s;
740 skip = FALSE;
741 dirchunk_len = 0;
742 }
743 else if (!skip)
744 {
745 *d++ = *s; // copy next char
746 if (*s != '~' && *s != '.') // and leading "~" and "."
747 {
748 ++dirchunk_len; // only count word chars for the size
749
750 // keep copying chars until we have our preferred length (or
751 // until the above if/else branches move us along)
752 if (dirchunk_len >= trim_len)
753 skip = TRUE;
754 }
755
756 if (has_mbyte)
757 {
758 int l = mb_ptr2len(s);
759
760 while (--l > 0)
761 *d++ = *++s;
762 }
763 }
764 }
765}
766
767/*
768 * Shorten the path of a file from "~/foo/../.bar/fname" to "~/f/../.b/fname"
769 * It's done in-place.
770 */
771 void
772shorten_dir(char_u *str)
773{
774 shorten_dir_len(str, 1);
775}
776
Bram Moolenaar022f9ef2022-07-02 17:36:31 +0100777/*
778 * Return TRUE if "fname" is a readable file.
779 */
780 int
781file_is_readable(char_u *fname)
782{
783 int fd;
784
785#ifndef O_NONBLOCK
786# define O_NONBLOCK 0
787#endif
788 if (*fname && !mch_isdir(fname)
789 && (fd = mch_open((char *)fname, O_RDONLY | O_NONBLOCK, 0)) >= 0)
790 {
791 close(fd);
792 return TRUE;
793 }
794 return FALSE;
795}
796
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200797#if defined(FEAT_EVAL) || defined(PROTO)
798
799/*
800 * "chdir(dir)" function
801 */
802 void
803f_chdir(typval_T *argvars, typval_T *rettv)
804{
805 char_u *cwd;
806 cdscope_T scope = CDSCOPE_GLOBAL;
807
808 rettv->v_type = VAR_STRING;
809 rettv->vval.v_string = NULL;
810
811 if (argvars[0].v_type != VAR_STRING)
Bram Moolenaarc5809432021-03-27 21:23:30 +0100812 {
Bram Moolenaard816cd92020-02-04 22:23:09 +0100813 // Returning an empty string means it failed.
Bram Moolenaar002bc792020-06-05 22:33:42 +0200814 // No error message, for historic reasons.
Bram Moolenaarc5809432021-03-27 21:23:30 +0100815 if (in_vim9script())
816 (void) check_for_string_arg(argvars, 0);
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200817 return;
Bram Moolenaarc5809432021-03-27 21:23:30 +0100818 }
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200819
820 // Return the current directory
821 cwd = alloc(MAXPATHL);
822 if (cwd != NULL)
823 {
824 if (mch_dirname(cwd, MAXPATHL) != FAIL)
825 {
826#ifdef BACKSLASH_IN_FILENAME
827 slash_adjust(cwd);
828#endif
829 rettv->vval.v_string = vim_strsave(cwd);
830 }
831 vim_free(cwd);
832 }
833
834 if (curwin->w_localdir != NULL)
835 scope = CDSCOPE_WINDOW;
836 else if (curtab->tp_localdir != NULL)
837 scope = CDSCOPE_TABPAGE;
838
839 if (!changedir_func(argvars[0].vval.v_string, TRUE, scope))
840 // Directory change failed
841 VIM_CLEAR(rettv->vval.v_string);
842}
843
844/*
845 * "delete()" function
846 */
847 void
848f_delete(typval_T *argvars, typval_T *rettv)
849{
850 char_u nbuf[NUMBUFLEN];
851 char_u *name;
852 char_u *flags;
853
854 rettv->vval.v_number = -1;
855 if (check_restricted() || check_secure())
856 return;
857
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200858 if (in_vim9script()
859 && (check_for_string_arg(argvars, 0) == FAIL
860 || check_for_opt_string_arg(argvars, 1) == FAIL))
861 return;
862
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200863 name = tv_get_string(&argvars[0]);
864 if (name == NULL || *name == NUL)
865 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000866 emsg(_(e_invalid_argument));
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200867 return;
868 }
869
870 if (argvars[1].v_type != VAR_UNKNOWN)
871 flags = tv_get_string_buf(&argvars[1], nbuf);
872 else
873 flags = (char_u *)"";
874
875 if (*flags == NUL)
Bram Moolenaar26262f82019-09-04 20:59:15 +0200876 // delete a file
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200877 rettv->vval.v_number = mch_remove(name) == 0 ? 0 : -1;
878 else if (STRCMP(flags, "d") == 0)
Bram Moolenaar26262f82019-09-04 20:59:15 +0200879 // delete an empty directory
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200880 rettv->vval.v_number = mch_rmdir(name) == 0 ? 0 : -1;
881 else if (STRCMP(flags, "rf") == 0)
Bram Moolenaar26262f82019-09-04 20:59:15 +0200882 // delete a directory recursively
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200883 rettv->vval.v_number = delete_recursive(name);
884 else
Bram Moolenaar108010a2021-06-27 22:03:33 +0200885 semsg(_(e_invalid_expression_str), flags);
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200886}
887
888/*
889 * "executable()" function
890 */
891 void
892f_executable(typval_T *argvars, typval_T *rettv)
893{
Bram Moolenaar32105ae2021-03-27 18:59:25 +0100894 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
Bram Moolenaar7bb4e742020-12-09 12:41:50 +0100895 return;
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200896
Bram Moolenaar26262f82019-09-04 20:59:15 +0200897 // Check in $PATH and also check directly if there is a directory name.
Bram Moolenaar7bb4e742020-12-09 12:41:50 +0100898 rettv->vval.v_number = mch_can_exe(tv_get_string(&argvars[0]), NULL, TRUE);
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200899}
900
901/*
902 * "exepath()" function
903 */
904 void
905f_exepath(typval_T *argvars, typval_T *rettv)
906{
907 char_u *p = NULL;
908
Bram Moolenaar32105ae2021-03-27 18:59:25 +0100909 if (in_vim9script() && check_for_nonempty_string_arg(argvars, 0) == FAIL)
Bram Moolenaar7bb4e742020-12-09 12:41:50 +0100910 return;
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200911 (void)mch_can_exe(tv_get_string(&argvars[0]), &p, TRUE);
912 rettv->v_type = VAR_STRING;
913 rettv->vval.v_string = p;
914}
915
916/*
917 * "filereadable()" function
918 */
919 void
920f_filereadable(typval_T *argvars, typval_T *rettv)
921{
Bram Moolenaar32105ae2021-03-27 18:59:25 +0100922 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
Bram Moolenaar7bb4e742020-12-09 12:41:50 +0100923 return;
Bram Moolenaar4dea2d92022-03-31 11:37:57 +0100924 rettv->vval.v_number = file_is_readable(tv_get_string(&argvars[0]));
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200925}
926
927/*
928 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
929 * rights to write into.
930 */
931 void
932f_filewritable(typval_T *argvars, typval_T *rettv)
933{
Bram Moolenaar32105ae2021-03-27 18:59:25 +0100934 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
Bram Moolenaar7bb4e742020-12-09 12:41:50 +0100935 return;
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200936 rettv->vval.v_number = filewritable(tv_get_string(&argvars[0]));
937}
938
Bram Moolenaar840d16f2019-09-10 21:27:18 +0200939 static void
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200940findfilendir(
941 typval_T *argvars UNUSED,
942 typval_T *rettv,
943 int find_what UNUSED)
944{
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200945 char_u *fname;
946 char_u *fresult = NULL;
947 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
948 char_u *p;
949 char_u pathbuf[NUMBUFLEN];
950 int count = 1;
951 int first = TRUE;
952 int error = FALSE;
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200953
954 rettv->vval.v_string = NULL;
955 rettv->v_type = VAR_STRING;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200956 if (in_vim9script()
957 && (check_for_nonempty_string_arg(argvars, 0) == FAIL
958 || check_for_opt_string_arg(argvars, 1) == FAIL
959 || (argvars[1].v_type != VAR_UNKNOWN
960 && check_for_opt_number_arg(argvars, 2) == FAIL)))
Bram Moolenaar7bb4e742020-12-09 12:41:50 +0100961 return;
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200962
Bram Moolenaarb005cd82019-09-04 15:54:55 +0200963 fname = tv_get_string(&argvars[0]);
964
965 if (argvars[1].v_type != VAR_UNKNOWN)
966 {
967 p = tv_get_string_buf_chk(&argvars[1], pathbuf);
968 if (p == NULL)
969 error = TRUE;
970 else
971 {
972 if (*p != NUL)
973 path = p;
974
975 if (argvars[2].v_type != VAR_UNKNOWN)
976 count = (int)tv_get_number_chk(&argvars[2], &error);
977 }
978 }
979
980 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
981 error = TRUE;
982
983 if (*fname != NUL && !error)
984 {
985 do
986 {
987 if (rettv->v_type == VAR_STRING || rettv->v_type == VAR_LIST)
988 vim_free(fresult);
989 fresult = find_file_in_path_option(first ? fname : NULL,
990 first ? (int)STRLEN(fname) : 0,
991 0, first, path,
992 find_what,
993 curbuf->b_ffname,
994 find_what == FINDFILE_DIR
995 ? (char_u *)"" : curbuf->b_p_sua);
996 first = FALSE;
997
998 if (fresult != NULL && rettv->v_type == VAR_LIST)
999 list_append_string(rettv->vval.v_list, fresult, -1);
1000
1001 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
1002 }
1003
1004 if (rettv->v_type == VAR_STRING)
1005 rettv->vval.v_string = fresult;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001006}
1007
1008/*
1009 * "finddir({fname}[, {path}[, {count}]])" function
1010 */
1011 void
1012f_finddir(typval_T *argvars, typval_T *rettv)
1013{
1014 findfilendir(argvars, rettv, FINDFILE_DIR);
1015}
1016
1017/*
1018 * "findfile({fname}[, {path}[, {count}]])" function
1019 */
1020 void
1021f_findfile(typval_T *argvars, typval_T *rettv)
1022{
1023 findfilendir(argvars, rettv, FINDFILE_FILE);
1024}
1025
1026/*
1027 * "fnamemodify({fname}, {mods})" function
1028 */
1029 void
1030f_fnamemodify(typval_T *argvars, typval_T *rettv)
1031{
1032 char_u *fname;
1033 char_u *mods;
1034 int usedlen = 0;
Bram Moolenaarc5308522020-12-13 12:25:35 +01001035 int len = 0;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001036 char_u *fbuf = NULL;
1037 char_u buf[NUMBUFLEN];
1038
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001039 if (in_vim9script()
1040 && (check_for_string_arg(argvars, 0) == FAIL
1041 || check_for_string_arg(argvars, 1) == FAIL))
Bram Moolenaar7bb4e742020-12-09 12:41:50 +01001042 return;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001043
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001044 fname = tv_get_string_chk(&argvars[0]);
1045 mods = tv_get_string_buf_chk(&argvars[1], buf);
Bram Moolenaarc5308522020-12-13 12:25:35 +01001046 if (mods == NULL || fname == NULL)
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001047 fname = NULL;
Bram Moolenaarc5308522020-12-13 12:25:35 +01001048 else
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001049 {
1050 len = (int)STRLEN(fname);
Bram Moolenaarc5308522020-12-13 12:25:35 +01001051 if (mods != NULL && *mods != NUL)
1052 (void)modify_fname(mods, FALSE, &usedlen, &fname, &fbuf, &len);
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001053 }
1054
1055 rettv->v_type = VAR_STRING;
1056 if (fname == NULL)
1057 rettv->vval.v_string = NULL;
1058 else
1059 rettv->vval.v_string = vim_strnsave(fname, len);
1060 vim_free(fbuf);
1061}
1062
1063/*
1064 * "getcwd()" function
1065 *
1066 * Return the current working directory of a window in a tab page.
1067 * First optional argument 'winnr' is the window number or -1 and the second
1068 * optional argument 'tabnr' is the tab page number.
1069 *
1070 * If no arguments are supplied, then return the directory of the current
1071 * window.
1072 * If only 'winnr' is specified and is not -1 or 0 then return the directory of
1073 * the specified window.
1074 * If 'winnr' is 0 then return the directory of the current window.
1075 * If both 'winnr and 'tabnr' are specified and 'winnr' is -1 then return the
1076 * directory of the specified tab page. Otherwise return the directory of the
1077 * specified window in the specified tab page.
1078 * If the window or the tab page doesn't exist then return NULL.
1079 */
1080 void
1081f_getcwd(typval_T *argvars, typval_T *rettv)
1082{
1083 win_T *wp = NULL;
1084 tabpage_T *tp = NULL;
1085 char_u *cwd;
1086 int global = FALSE;
1087
1088 rettv->v_type = VAR_STRING;
1089 rettv->vval.v_string = NULL;
1090
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001091 if (in_vim9script()
1092 && (check_for_opt_number_arg(argvars, 0) == FAIL
1093 || (argvars[0].v_type != VAR_UNKNOWN
1094 && check_for_opt_number_arg(argvars, 1) == FAIL)))
1095 return;
1096
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001097 if (argvars[0].v_type == VAR_NUMBER
1098 && argvars[0].vval.v_number == -1
1099 && argvars[1].v_type == VAR_UNKNOWN)
1100 global = TRUE;
1101 else
1102 wp = find_tabwin(&argvars[0], &argvars[1], &tp);
1103
Bram Moolenaar851c7a62021-11-18 20:47:31 +00001104 if (wp != NULL && wp->w_localdir != NULL
1105 && argvars[0].v_type != VAR_UNKNOWN)
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001106 rettv->vval.v_string = vim_strsave(wp->w_localdir);
Bram Moolenaar851c7a62021-11-18 20:47:31 +00001107 else if (tp != NULL && tp->tp_localdir != NULL
1108 && argvars[0].v_type != VAR_UNKNOWN)
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001109 rettv->vval.v_string = vim_strsave(tp->tp_localdir);
1110 else if (wp != NULL || tp != NULL || global)
1111 {
Bram Moolenaar851c7a62021-11-18 20:47:31 +00001112 if (globaldir != NULL && argvars[0].v_type != VAR_UNKNOWN)
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001113 rettv->vval.v_string = vim_strsave(globaldir);
1114 else
1115 {
1116 cwd = alloc(MAXPATHL);
1117 if (cwd != NULL)
1118 {
1119 if (mch_dirname(cwd, MAXPATHL) != FAIL)
1120 rettv->vval.v_string = vim_strsave(cwd);
1121 vim_free(cwd);
1122 }
1123 }
1124 }
1125#ifdef BACKSLASH_IN_FILENAME
1126 if (rettv->vval.v_string != NULL)
1127 slash_adjust(rettv->vval.v_string);
1128#endif
1129}
1130
1131/*
Bram Moolenaar6c9ba042020-06-01 16:09:41 +02001132 * Convert "st" to file permission string.
1133 */
1134 char_u *
1135getfpermst(stat_T *st, char_u *perm)
1136{
1137 char_u flags[] = "rwx";
1138 int i;
1139
1140 for (i = 0; i < 9; i++)
1141 {
1142 if (st->st_mode & (1 << (8 - i)))
1143 perm[i] = flags[i % 3];
1144 else
1145 perm[i] = '-';
1146 }
1147 return perm;
1148}
1149
1150/*
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001151 * "getfperm({fname})" function
1152 */
1153 void
1154f_getfperm(typval_T *argvars, typval_T *rettv)
1155{
1156 char_u *fname;
1157 stat_T st;
1158 char_u *perm = NULL;
Bram Moolenaar6c9ba042020-06-01 16:09:41 +02001159 char_u permbuf[] = "---------";
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001160
Bram Moolenaar32105ae2021-03-27 18:59:25 +01001161 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
Bram Moolenaar7bb4e742020-12-09 12:41:50 +01001162 return;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001163
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001164 fname = tv_get_string(&argvars[0]);
1165
1166 rettv->v_type = VAR_STRING;
1167 if (mch_stat((char *)fname, &st) >= 0)
Bram Moolenaar6c9ba042020-06-01 16:09:41 +02001168 perm = vim_strsave(getfpermst(&st, permbuf));
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001169 rettv->vval.v_string = perm;
1170}
1171
1172/*
1173 * "getfsize({fname})" function
1174 */
1175 void
1176f_getfsize(typval_T *argvars, typval_T *rettv)
1177{
1178 char_u *fname;
1179 stat_T st;
1180
Bram Moolenaar32105ae2021-03-27 18:59:25 +01001181 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
Bram Moolenaar7bb4e742020-12-09 12:41:50 +01001182 return;
1183
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001184 fname = tv_get_string(&argvars[0]);
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001185 if (mch_stat((char *)fname, &st) >= 0)
1186 {
1187 if (mch_isdir(fname))
1188 rettv->vval.v_number = 0;
1189 else
1190 {
1191 rettv->vval.v_number = (varnumber_T)st.st_size;
1192
Bram Moolenaar26262f82019-09-04 20:59:15 +02001193 // non-perfect check for overflow
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001194 if ((off_T)rettv->vval.v_number != (off_T)st.st_size)
1195 rettv->vval.v_number = -2;
1196 }
1197 }
1198 else
1199 rettv->vval.v_number = -1;
1200}
1201
1202/*
1203 * "getftime({fname})" function
1204 */
1205 void
1206f_getftime(typval_T *argvars, typval_T *rettv)
1207{
1208 char_u *fname;
1209 stat_T st;
1210
Bram Moolenaar32105ae2021-03-27 18:59:25 +01001211 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
Bram Moolenaar7bb4e742020-12-09 12:41:50 +01001212 return;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001213
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001214 fname = tv_get_string(&argvars[0]);
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001215 if (mch_stat((char *)fname, &st) >= 0)
1216 rettv->vval.v_number = (varnumber_T)st.st_mtime;
1217 else
1218 rettv->vval.v_number = -1;
1219}
1220
1221/*
Bram Moolenaar6c9ba042020-06-01 16:09:41 +02001222 * Convert "st" to file type string.
1223 */
1224 char_u *
1225getftypest(stat_T *st)
1226{
1227 char *t;
1228
1229 if (S_ISREG(st->st_mode))
1230 t = "file";
1231 else if (S_ISDIR(st->st_mode))
1232 t = "dir";
1233 else if (S_ISLNK(st->st_mode))
1234 t = "link";
1235 else if (S_ISBLK(st->st_mode))
1236 t = "bdev";
1237 else if (S_ISCHR(st->st_mode))
1238 t = "cdev";
1239 else if (S_ISFIFO(st->st_mode))
1240 t = "fifo";
1241 else if (S_ISSOCK(st->st_mode))
1242 t = "socket";
1243 else
1244 t = "other";
1245 return (char_u*)t;
1246}
1247
1248/*
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001249 * "getftype({fname})" function
1250 */
1251 void
1252f_getftype(typval_T *argvars, typval_T *rettv)
1253{
1254 char_u *fname;
1255 stat_T st;
1256 char_u *type = NULL;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001257
Bram Moolenaar32105ae2021-03-27 18:59:25 +01001258 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
Bram Moolenaar7bb4e742020-12-09 12:41:50 +01001259 return;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001260
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001261 fname = tv_get_string(&argvars[0]);
1262
1263 rettv->v_type = VAR_STRING;
1264 if (mch_lstat((char *)fname, &st) >= 0)
Bram Moolenaar6c9ba042020-06-01 16:09:41 +02001265 type = vim_strsave(getftypest(&st));
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001266 rettv->vval.v_string = type;
1267}
1268
1269/*
1270 * "glob()" function
1271 */
1272 void
1273f_glob(typval_T *argvars, typval_T *rettv)
1274{
1275 int options = WILD_SILENT|WILD_USE_NL;
1276 expand_T xpc;
1277 int error = FALSE;
1278
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001279 if (in_vim9script()
1280 && (check_for_string_arg(argvars, 0) == FAIL
1281 || check_for_opt_bool_arg(argvars, 1) == FAIL
1282 || (argvars[1].v_type != VAR_UNKNOWN
1283 && (check_for_opt_bool_arg(argvars, 2) == FAIL
1284 || (argvars[2].v_type != VAR_UNKNOWN
1285 && check_for_opt_bool_arg(argvars, 3) == FAIL)))))
1286 return;
1287
Bram Moolenaar26262f82019-09-04 20:59:15 +02001288 // When the optional second argument is non-zero, don't remove matches
1289 // for 'wildignore' and don't put matches for 'suffixes' at the end.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001290 rettv->v_type = VAR_STRING;
1291 if (argvars[1].v_type != VAR_UNKNOWN)
1292 {
Bram Moolenaar5892ea12020-09-02 21:53:11 +02001293 if (tv_get_bool_chk(&argvars[1], &error))
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001294 options |= WILD_KEEP_ALL;
1295 if (argvars[2].v_type != VAR_UNKNOWN)
1296 {
Bram Moolenaar5892ea12020-09-02 21:53:11 +02001297 if (tv_get_bool_chk(&argvars[2], &error))
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001298 rettv_list_set(rettv, NULL);
1299 if (argvars[3].v_type != VAR_UNKNOWN
Bram Moolenaar5892ea12020-09-02 21:53:11 +02001300 && tv_get_bool_chk(&argvars[3], &error))
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001301 options |= WILD_ALLLINKS;
1302 }
1303 }
1304 if (!error)
1305 {
1306 ExpandInit(&xpc);
1307 xpc.xp_context = EXPAND_FILES;
1308 if (p_wic)
1309 options += WILD_ICASE;
1310 if (rettv->v_type == VAR_STRING)
1311 rettv->vval.v_string = ExpandOne(&xpc, tv_get_string(&argvars[0]),
1312 NULL, options, WILD_ALL);
Bram Moolenaar8088ae92022-06-20 11:38:17 +01001313 else if (rettv_list_alloc(rettv) == OK)
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001314 {
1315 int i;
1316
1317 ExpandOne(&xpc, tv_get_string(&argvars[0]),
1318 NULL, options, WILD_ALL_KEEP);
1319 for (i = 0; i < xpc.xp_numfiles; i++)
1320 list_append_string(rettv->vval.v_list, xpc.xp_files[i], -1);
1321
1322 ExpandCleanup(&xpc);
1323 }
1324 }
1325 else
1326 rettv->vval.v_string = NULL;
1327}
1328
1329/*
1330 * "glob2regpat()" function
1331 */
1332 void
1333f_glob2regpat(typval_T *argvars, typval_T *rettv)
1334{
Bram Moolenaar3cfa5b12021-06-06 14:14:39 +02001335 char_u buf[NUMBUFLEN];
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001336 char_u *pat;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001337
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001338 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1339 return;
1340
1341 pat = tv_get_string_buf_chk_strict(&argvars[0], buf, in_vim9script());
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001342 rettv->v_type = VAR_STRING;
1343 rettv->vval.v_string = (pat == NULL)
1344 ? NULL : file_pat_to_reg_pat(pat, NULL, NULL, FALSE);
1345}
1346
1347/*
1348 * "globpath()" function
1349 */
1350 void
1351f_globpath(typval_T *argvars, typval_T *rettv)
1352{
1353 int flags = WILD_IGNORE_COMPLETESLASH;
1354 char_u buf1[NUMBUFLEN];
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001355 char_u *file;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001356 int error = FALSE;
1357 garray_T ga;
1358 int i;
1359
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001360 if (in_vim9script()
1361 && (check_for_string_arg(argvars, 0) == FAIL
1362 || check_for_string_arg(argvars, 1) == FAIL
1363 || check_for_opt_bool_arg(argvars, 2) == FAIL
1364 || (argvars[2].v_type != VAR_UNKNOWN
1365 && (check_for_opt_bool_arg(argvars, 3) == FAIL
1366 || (argvars[3].v_type != VAR_UNKNOWN
1367 && check_for_opt_bool_arg(argvars, 4) == FAIL)))))
1368 return;
1369
1370 file = tv_get_string_buf_chk(&argvars[1], buf1);
1371
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001372 // When the optional second argument is non-zero, don't remove matches
1373 // for 'wildignore' and don't put matches for 'suffixes' at the end.
1374 rettv->v_type = VAR_STRING;
1375 if (argvars[2].v_type != VAR_UNKNOWN)
1376 {
Bram Moolenaarf966ce52020-09-02 21:57:07 +02001377 if (tv_get_bool_chk(&argvars[2], &error))
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001378 flags |= WILD_KEEP_ALL;
1379 if (argvars[3].v_type != VAR_UNKNOWN)
1380 {
Bram Moolenaarf966ce52020-09-02 21:57:07 +02001381 if (tv_get_bool_chk(&argvars[3], &error))
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001382 rettv_list_set(rettv, NULL);
1383 if (argvars[4].v_type != VAR_UNKNOWN
Bram Moolenaarf966ce52020-09-02 21:57:07 +02001384 && tv_get_bool_chk(&argvars[4], &error))
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001385 flags |= WILD_ALLLINKS;
1386 }
1387 }
1388 if (file != NULL && !error)
1389 {
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001390 ga_init2(&ga, sizeof(char_u *), 10);
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001391 globpath(tv_get_string(&argvars[0]), file, &ga, flags);
1392 if (rettv->v_type == VAR_STRING)
1393 rettv->vval.v_string = ga_concat_strings(&ga, "\n");
Bram Moolenaar8088ae92022-06-20 11:38:17 +01001394 else if (rettv_list_alloc(rettv) == OK)
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001395 for (i = 0; i < ga.ga_len; ++i)
1396 list_append_string(rettv->vval.v_list,
1397 ((char_u **)(ga.ga_data))[i], -1);
1398 ga_clear_strings(&ga);
1399 }
1400 else
1401 rettv->vval.v_string = NULL;
1402}
1403
1404/*
1405 * "isdirectory()" function
1406 */
1407 void
1408f_isdirectory(typval_T *argvars, typval_T *rettv)
1409{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001410 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1411 return;
1412
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001413 rettv->vval.v_number = mch_isdir(tv_get_string(&argvars[0]));
1414}
1415
1416/*
LemonBoydca1d402022-04-28 15:26:33 +01001417 * "isabsolutepath()" function
1418 */
1419 void
1420f_isabsolutepath(typval_T *argvars, typval_T *rettv)
1421{
1422 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
1423 return;
1424
1425 rettv->vval.v_number = mch_isFullName(tv_get_string_strict(&argvars[0]));
1426}
1427
1428/*
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001429 * Create the directory in which "dir" is located, and higher levels when
1430 * needed.
Bram Moolenaar6f14da12022-09-07 21:30:44 +01001431 * Set "created" to the full name of the first created directory. It will be
1432 * NULL until that happens.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001433 * Return OK or FAIL.
1434 */
1435 static int
Bram Moolenaar6f14da12022-09-07 21:30:44 +01001436mkdir_recurse(char_u *dir, int prot, char_u **created)
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001437{
1438 char_u *p;
1439 char_u *updir;
1440 int r = FAIL;
1441
Bram Moolenaar26262f82019-09-04 20:59:15 +02001442 // Get end of directory name in "dir".
1443 // We're done when it's "/" or "c:/".
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001444 p = gettail_sep(dir);
1445 if (p <= get_past_head(dir))
1446 return OK;
1447
Bram Moolenaar26262f82019-09-04 20:59:15 +02001448 // If the directory exists we're done. Otherwise: create it.
Bram Moolenaar71ccd032020-06-12 22:59:11 +02001449 updir = vim_strnsave(dir, p - dir);
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001450 if (updir == NULL)
1451 return FAIL;
1452 if (mch_isdir(updir))
1453 r = OK;
Bram Moolenaar6f14da12022-09-07 21:30:44 +01001454 else if (mkdir_recurse(updir, prot, created) == OK)
1455 {
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001456 r = vim_mkdir_emsg(updir, prot);
Bram Moolenaar6f14da12022-09-07 21:30:44 +01001457 if (r == OK && created != NULL && *created == NULL)
1458 *created = FullName_save(updir, FALSE);
1459 }
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001460 vim_free(updir);
1461 return r;
1462}
1463
1464/*
1465 * "mkdir()" function
1466 */
1467 void
1468f_mkdir(typval_T *argvars, typval_T *rettv)
1469{
1470 char_u *dir;
1471 char_u buf[NUMBUFLEN];
1472 int prot = 0755;
Bram Moolenaar6f14da12022-09-07 21:30:44 +01001473 int defer = FALSE;
1474 int defer_recurse = FALSE;
1475 char_u *created = NULL;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001476
1477 rettv->vval.v_number = FAIL;
1478 if (check_restricted() || check_secure())
1479 return;
1480
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001481 if (in_vim9script()
1482 && (check_for_nonempty_string_arg(argvars, 0) == FAIL
1483 || check_for_opt_string_arg(argvars, 1) == FAIL
1484 || (argvars[1].v_type != VAR_UNKNOWN
1485 && check_for_opt_number_arg(argvars, 2) == FAIL)))
1486 return;
1487
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001488 dir = tv_get_string_buf(&argvars[0], buf);
1489 if (*dir == NUL)
1490 return;
1491
1492 if (*gettail(dir) == NUL)
Bram Moolenaar26262f82019-09-04 20:59:15 +02001493 // remove trailing slashes
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001494 *gettail_sep(dir) = NUL;
1495
1496 if (argvars[1].v_type != VAR_UNKNOWN)
1497 {
Bram Moolenaar6f14da12022-09-07 21:30:44 +01001498 char_u *arg2;
1499
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001500 if (argvars[2].v_type != VAR_UNKNOWN)
1501 {
1502 prot = (int)tv_get_number_chk(&argvars[2], NULL);
1503 if (prot == -1)
1504 return;
1505 }
Bram Moolenaar6f14da12022-09-07 21:30:44 +01001506 arg2 = tv_get_string(&argvars[1]);
1507 defer = vim_strchr(arg2, 'D') != NULL;
1508 defer_recurse = vim_strchr(arg2, 'R') != NULL;
1509 if ((defer || defer_recurse) && !can_add_defer())
1510 return;
1511
1512 if (vim_strchr(arg2, 'p') != NULL)
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001513 {
1514 if (mch_isdir(dir))
1515 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02001516 // With the "p" flag it's OK if the dir already exists.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001517 rettv->vval.v_number = OK;
1518 return;
1519 }
Bram Moolenaar6f14da12022-09-07 21:30:44 +01001520 mkdir_recurse(dir, prot, defer || defer_recurse ? &created : NULL);
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001521 }
1522 }
1523 rettv->vval.v_number = vim_mkdir_emsg(dir, prot);
Bram Moolenaar6f14da12022-09-07 21:30:44 +01001524
1525 // Handle "D" and "R": deferred deletion of the created directory.
1526 if (rettv->vval.v_number == OK
1527 && created == NULL && (defer || defer_recurse))
1528 created = FullName_save(dir, FALSE);
1529 if (created != NULL)
1530 {
1531 typval_T tv[2];
1532
1533 tv[0].v_type = VAR_STRING;
1534 tv[0].v_lock = 0;
1535 tv[0].vval.v_string = created;
1536 tv[1].v_type = VAR_STRING;
1537 tv[1].v_lock = 0;
1538 tv[1].vval.v_string = vim_strsave(
1539 (char_u *)(defer_recurse ? "rf" : "d"));
1540 if (tv[0].vval.v_string == NULL || tv[1].vval.v_string == NULL
1541 || add_defer((char_u *)"delete", 2, tv) == FAIL)
1542 {
1543 vim_free(tv[0].vval.v_string);
1544 vim_free(tv[1].vval.v_string);
1545 }
1546 }
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001547}
1548
1549/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02001550 * "pathshorten()" function
1551 */
1552 void
1553f_pathshorten(typval_T *argvars, typval_T *rettv)
1554{
1555 char_u *p;
Bram Moolenaar6a33ef02020-09-25 22:42:48 +02001556 int trim_len = 1;
1557
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001558 if (in_vim9script()
1559 && (check_for_string_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001560 || check_for_opt_number_arg(argvars, 1) == FAIL))
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001561 return;
1562
Bram Moolenaar6a33ef02020-09-25 22:42:48 +02001563 if (argvars[1].v_type != VAR_UNKNOWN)
1564 {
1565 trim_len = (int)tv_get_number(&argvars[1]);
1566 if (trim_len < 1)
1567 trim_len = 1;
1568 }
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02001569
1570 rettv->v_type = VAR_STRING;
1571 p = tv_get_string_chk(&argvars[0]);
Bram Moolenaar6a33ef02020-09-25 22:42:48 +02001572
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02001573 if (p == NULL)
1574 rettv->vval.v_string = NULL;
1575 else
1576 {
1577 p = vim_strsave(p);
1578 rettv->vval.v_string = p;
1579 if (p != NULL)
Bram Moolenaar6a33ef02020-09-25 22:42:48 +02001580 shorten_dir_len(p, trim_len);
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02001581 }
1582}
1583
1584/*
Bram Moolenaarf8abbf32020-08-19 16:00:06 +02001585 * Common code for readdir_checkitem() and readdirex_checkitem().
1586 * Either "name" or "dict" is NULL.
Bram Moolenaar80147dd2020-02-04 22:32:59 +01001587 */
1588 static int
Bram Moolenaarf8abbf32020-08-19 16:00:06 +02001589checkitem_common(void *context, char_u *name, dict_T *dict)
Bram Moolenaar80147dd2020-02-04 22:32:59 +01001590{
1591 typval_T *expr = (typval_T *)context;
1592 typval_T save_val;
1593 typval_T rettv;
1594 typval_T argv[2];
1595 int retval = 0;
1596 int error = FALSE;
Bram Moolenaar80147dd2020-02-04 22:32:59 +01001597
1598 prepare_vimvar(VV_VAL, &save_val);
Bram Moolenaarf8abbf32020-08-19 16:00:06 +02001599 if (name != NULL)
1600 {
1601 set_vim_var_string(VV_VAL, name, -1);
1602 argv[0].v_type = VAR_STRING;
1603 argv[0].vval.v_string = name;
1604 }
1605 else
1606 {
1607 set_vim_var_dict(VV_VAL, dict);
1608 argv[0].v_type = VAR_DICT;
1609 argv[0].vval.v_dict = dict;
1610 }
Bram Moolenaar80147dd2020-02-04 22:32:59 +01001611
Bram Moolenaar82418262022-09-28 16:16:15 +01001612 if (eval_expr_typval(expr, argv, 1, NULL, &rettv) == FAIL)
Bram Moolenaar80147dd2020-02-04 22:32:59 +01001613 goto theend;
1614
Bram Moolenaarf8abbf32020-08-19 16:00:06 +02001615 // We want to use -1, but also true/false should be allowed.
1616 if (rettv.v_type == VAR_SPECIAL || rettv.v_type == VAR_BOOL)
1617 {
1618 rettv.v_type = VAR_NUMBER;
1619 rettv.vval.v_number = rettv.vval.v_number == VVAL_TRUE;
1620 }
Bram Moolenaar80147dd2020-02-04 22:32:59 +01001621 retval = tv_get_number_chk(&rettv, &error);
1622 if (error)
1623 retval = -1;
1624 clear_tv(&rettv);
1625
1626theend:
Bram Moolenaarf8abbf32020-08-19 16:00:06 +02001627 if (name != NULL)
1628 set_vim_var_string(VV_VAL, NULL, 0);
1629 else
1630 set_vim_var_dict(VV_VAL, NULL);
Bram Moolenaar80147dd2020-02-04 22:32:59 +01001631 restore_vimvar(VV_VAL, &save_val);
1632 return retval;
1633}
1634
Bram Moolenaarf8abbf32020-08-19 16:00:06 +02001635/*
1636 * Evaluate "expr" (= "context") for readdir().
1637 */
1638 static int
1639readdir_checkitem(void *context, void *item)
1640{
1641 char_u *name = (char_u *)item;
1642
1643 return checkitem_common(context, name, NULL);
1644}
1645
Bram Moolenaard83392a2022-09-01 12:22:46 +01001646/*
1647 * Process the keys in the Dict argument to the readdir() and readdirex()
1648 * functions. Assumes the Dict argument is the 3rd argument.
1649 */
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +02001650 static int
Bram Moolenaard83392a2022-09-01 12:22:46 +01001651readdirex_dict_arg(typval_T *argvars, int *cmp)
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +02001652{
1653 char_u *compare;
1654
Bram Moolenaard83392a2022-09-01 12:22:46 +01001655 if (check_for_nonnull_dict_arg(argvars, 2) == FAIL)
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +02001656 return FAIL;
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +02001657
Bram Moolenaard83392a2022-09-01 12:22:46 +01001658 if (dict_has_key(argvars[2].vval.v_dict, "sort"))
1659 compare = dict_get_string(argvars[2].vval.v_dict, "sort", FALSE);
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +02001660 else
1661 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001662 semsg(_(e_dictionary_key_str_required), "sort");
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +02001663 return FAIL;
1664 }
1665
1666 if (STRCMP(compare, (char_u *) "none") == 0)
1667 *cmp = READDIR_SORT_NONE;
1668 else if (STRCMP(compare, (char_u *) "case") == 0)
1669 *cmp = READDIR_SORT_BYTE;
1670 else if (STRCMP(compare, (char_u *) "icase") == 0)
1671 *cmp = READDIR_SORT_IC;
1672 else if (STRCMP(compare, (char_u *) "collate") == 0)
1673 *cmp = READDIR_SORT_COLLATE;
1674 return OK;
1675}
1676
Bram Moolenaar80147dd2020-02-04 22:32:59 +01001677/*
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001678 * "readdir()" function
1679 */
1680 void
1681f_readdir(typval_T *argvars, typval_T *rettv)
1682{
1683 typval_T *expr;
1684 int ret;
1685 char_u *path;
1686 char_u *p;
1687 garray_T ga;
1688 int i;
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01001689 int sort = READDIR_SORT_BYTE;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001690
1691 if (rettv_list_alloc(rettv) == FAIL)
1692 return;
Yegappan Lakshmanan5bca9062021-07-24 21:33:26 +02001693
1694 if (in_vim9script()
1695 && (check_for_string_arg(argvars, 0) == FAIL
1696 || (argvars[1].v_type != VAR_UNKNOWN
1697 && check_for_opt_dict_arg(argvars, 2) == FAIL)))
1698 return;
1699
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001700 path = tv_get_string(&argvars[0]);
1701 expr = &argvars[1];
1702
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +02001703 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN &&
Bram Moolenaard83392a2022-09-01 12:22:46 +01001704 readdirex_dict_arg(argvars, &sort) == FAIL)
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +02001705 return;
1706
Bram Moolenaar6c9ba042020-06-01 16:09:41 +02001707 ret = readdir_core(&ga, path, FALSE, (void *)expr,
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +02001708 (expr->v_type == VAR_UNKNOWN) ? NULL : readdir_checkitem, sort);
Bram Moolenaar6c9ba042020-06-01 16:09:41 +02001709 if (ret == OK)
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001710 {
1711 for (i = 0; i < ga.ga_len; i++)
1712 {
1713 p = ((char_u **)ga.ga_data)[i];
1714 list_append_string(rettv->vval.v_list, p, -1);
1715 }
1716 }
1717 ga_clear_strings(&ga);
1718}
1719
1720/*
Bram Moolenaar6c9ba042020-06-01 16:09:41 +02001721 * Evaluate "expr" (= "context") for readdirex().
1722 */
1723 static int
1724readdirex_checkitem(void *context, void *item)
1725{
Bram Moolenaar6c9ba042020-06-01 16:09:41 +02001726 dict_T *dict = (dict_T*)item;
1727
Bram Moolenaarf8abbf32020-08-19 16:00:06 +02001728 return checkitem_common(context, NULL, dict);
Bram Moolenaar6c9ba042020-06-01 16:09:41 +02001729}
1730
1731/*
1732 * "readdirex()" function
1733 */
1734 void
1735f_readdirex(typval_T *argvars, typval_T *rettv)
1736{
1737 typval_T *expr;
1738 int ret;
1739 char_u *path;
1740 garray_T ga;
1741 int i;
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01001742 int sort = READDIR_SORT_BYTE;
Bram Moolenaar6c9ba042020-06-01 16:09:41 +02001743
1744 if (rettv_list_alloc(rettv) == FAIL)
1745 return;
Yegappan Lakshmanan5bca9062021-07-24 21:33:26 +02001746
1747 if (in_vim9script()
1748 && (check_for_string_arg(argvars, 0) == FAIL
1749 || (argvars[1].v_type != VAR_UNKNOWN
1750 && check_for_opt_dict_arg(argvars, 2) == FAIL)))
1751 return;
1752
Bram Moolenaar6c9ba042020-06-01 16:09:41 +02001753 path = tv_get_string(&argvars[0]);
1754 expr = &argvars[1];
1755
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +02001756 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN &&
Bram Moolenaard83392a2022-09-01 12:22:46 +01001757 readdirex_dict_arg(argvars, &sort) == FAIL)
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +02001758 return;
1759
Bram Moolenaar6c9ba042020-06-01 16:09:41 +02001760 ret = readdir_core(&ga, path, TRUE, (void *)expr,
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +02001761 (expr->v_type == VAR_UNKNOWN) ? NULL : readdirex_checkitem, sort);
Bram Moolenaar6c9ba042020-06-01 16:09:41 +02001762 if (ret == OK)
1763 {
1764 for (i = 0; i < ga.ga_len; i++)
1765 {
1766 dict_T *dict = ((dict_T**)ga.ga_data)[i];
1767 list_append_dict(rettv->vval.v_list, dict);
1768 dict_unref(dict);
1769 }
1770 }
1771 ga_clear(&ga);
1772}
1773
1774/*
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001775 * "readfile()" function
1776 */
Bram Moolenaarc423ad72021-01-13 20:38:03 +01001777 static void
1778read_file_or_blob(typval_T *argvars, typval_T *rettv, int always_blob)
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001779{
1780 int binary = FALSE;
Bram Moolenaarc423ad72021-01-13 20:38:03 +01001781 int blob = always_blob;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001782 int failed = FALSE;
1783 char_u *fname;
1784 FILE *fd;
Bram Moolenaar26262f82019-09-04 20:59:15 +02001785 char_u buf[(IOSIZE/256)*256]; // rounded to avoid odd + 1
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001786 int io_size = sizeof(buf);
Bram Moolenaar26262f82019-09-04 20:59:15 +02001787 int readlen; // size of last fread()
1788 char_u *prev = NULL; // previously read bytes, if any
1789 long prevlen = 0; // length of data in prev
1790 long prevsize = 0; // size of prev buffer
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001791 long maxline = MAXLNUM;
1792 long cnt = 0;
Bram Moolenaar26262f82019-09-04 20:59:15 +02001793 char_u *p; // position in buf
1794 char_u *start; // start of current line
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001795
1796 if (argvars[1].v_type != VAR_UNKNOWN)
1797 {
1798 if (STRCMP(tv_get_string(&argvars[1]), "b") == 0)
1799 binary = TRUE;
1800 if (STRCMP(tv_get_string(&argvars[1]), "B") == 0)
1801 blob = TRUE;
1802
1803 if (argvars[2].v_type != VAR_UNKNOWN)
1804 maxline = (long)tv_get_number(&argvars[2]);
1805 }
1806
Bram Moolenaar15352dc2020-04-06 21:12:42 +02001807 if ((blob ? rettv_blob_alloc(rettv) : rettv_list_alloc(rettv)) == FAIL)
1808 return;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001809
Bram Moolenaar26262f82019-09-04 20:59:15 +02001810 // Always open the file in binary mode, library functions have a mind of
1811 // their own about CR-LF conversion.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001812 fname = tv_get_string(&argvars[0]);
Bram Moolenaar15352dc2020-04-06 21:12:42 +02001813
1814 if (mch_isdir(fname))
1815 {
Bram Moolenaar4dea2d92022-03-31 11:37:57 +01001816 semsg(_(e_str_is_directory), fname);
Bram Moolenaar15352dc2020-04-06 21:12:42 +02001817 return;
1818 }
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001819 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
1820 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001821 semsg(_(e_cant_open_file_str), *fname == NUL ? (char_u *)_("<empty>") : fname);
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001822 return;
1823 }
1824
1825 if (blob)
1826 {
1827 if (read_blob(fd, rettv->vval.v_blob) == FAIL)
1828 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001829 semsg(_(e_cant_read_file_str), fname);
Bram Moolenaar15352dc2020-04-06 21:12:42 +02001830 // An empty blob is returned on error.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001831 blob_free(rettv->vval.v_blob);
Bram Moolenaar15352dc2020-04-06 21:12:42 +02001832 rettv->vval.v_blob = NULL;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001833 }
1834 fclose(fd);
1835 return;
1836 }
1837
1838 while (cnt < maxline || maxline < 0)
1839 {
1840 readlen = (int)fread(buf, 1, io_size, fd);
1841
Bram Moolenaar26262f82019-09-04 20:59:15 +02001842 // This for loop processes what was read, but is also entered at end
1843 // of file so that either:
1844 // - an incomplete line gets written
1845 // - a "binary" file gets an empty line at the end if it ends in a
1846 // newline.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001847 for (p = buf, start = buf;
1848 p < buf + readlen || (readlen <= 0 && (prevlen > 0 || binary));
1849 ++p)
1850 {
Dominique Pellef5d639a2022-01-12 15:24:40 +00001851 if (readlen <= 0 || *p == '\n')
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001852 {
1853 listitem_T *li;
1854 char_u *s = NULL;
1855 long_u len = p - start;
1856
Bram Moolenaar26262f82019-09-04 20:59:15 +02001857 // Finished a line. Remove CRs before NL.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001858 if (readlen > 0 && !binary)
1859 {
1860 while (len > 0 && start[len - 1] == '\r')
1861 --len;
Bram Moolenaar26262f82019-09-04 20:59:15 +02001862 // removal may cross back to the "prev" string
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001863 if (len == 0)
1864 while (prevlen > 0 && prev[prevlen - 1] == '\r')
1865 --prevlen;
1866 }
1867 if (prevlen == 0)
Bram Moolenaar71ccd032020-06-12 22:59:11 +02001868 s = vim_strnsave(start, len);
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001869 else
1870 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02001871 // Change "prev" buffer to be the right size. This way
1872 // the bytes are only copied once, and very long lines are
1873 // allocated only once.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001874 if ((s = vim_realloc(prev, prevlen + len + 1)) != NULL)
1875 {
1876 mch_memmove(s + prevlen, start, len);
1877 s[prevlen + len] = NUL;
Bram Moolenaar26262f82019-09-04 20:59:15 +02001878 prev = NULL; // the list will own the string
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001879 prevlen = prevsize = 0;
1880 }
1881 }
1882 if (s == NULL)
1883 {
1884 do_outofmem_msg((long_u) prevlen + len + 1);
1885 failed = TRUE;
1886 break;
1887 }
1888
1889 if ((li = listitem_alloc()) == NULL)
1890 {
1891 vim_free(s);
1892 failed = TRUE;
1893 break;
1894 }
1895 li->li_tv.v_type = VAR_STRING;
1896 li->li_tv.v_lock = 0;
1897 li->li_tv.vval.v_string = s;
1898 list_append(rettv->vval.v_list, li);
1899
Bram Moolenaar26262f82019-09-04 20:59:15 +02001900 start = p + 1; // step over newline
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001901 if ((++cnt >= maxline && maxline >= 0) || readlen <= 0)
1902 break;
1903 }
1904 else if (*p == NUL)
1905 *p = '\n';
Bram Moolenaar26262f82019-09-04 20:59:15 +02001906 // Check for utf8 "bom"; U+FEFF is encoded as EF BB BF. Do this
1907 // when finding the BF and check the previous two bytes.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001908 else if (*p == 0xbf && enc_utf8 && !binary)
1909 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02001910 // Find the two bytes before the 0xbf. If p is at buf, or buf
1911 // + 1, these may be in the "prev" string.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001912 char_u back1 = p >= buf + 1 ? p[-1]
1913 : prevlen >= 1 ? prev[prevlen - 1] : NUL;
1914 char_u back2 = p >= buf + 2 ? p[-2]
1915 : p == buf + 1 && prevlen >= 1 ? prev[prevlen - 1]
1916 : prevlen >= 2 ? prev[prevlen - 2] : NUL;
1917
1918 if (back2 == 0xef && back1 == 0xbb)
1919 {
1920 char_u *dest = p - 2;
1921
Bram Moolenaar26262f82019-09-04 20:59:15 +02001922 // Usually a BOM is at the beginning of a file, and so at
1923 // the beginning of a line; then we can just step over it.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001924 if (start == dest)
1925 start = p + 1;
1926 else
1927 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02001928 // have to shuffle buf to close gap
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001929 int adjust_prevlen = 0;
1930
1931 if (dest < buf)
1932 {
Bram Moolenaarc423ad72021-01-13 20:38:03 +01001933 // must be 1 or 2
1934 adjust_prevlen = (int)(buf - dest);
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001935 dest = buf;
1936 }
1937 if (readlen > p - buf + 1)
1938 mch_memmove(dest, p + 1, readlen - (p - buf) - 1);
1939 readlen -= 3 - adjust_prevlen;
1940 prevlen -= adjust_prevlen;
1941 p = dest - 1;
1942 }
1943 }
1944 }
Bram Moolenaar26262f82019-09-04 20:59:15 +02001945 } // for
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001946
1947 if (failed || (cnt >= maxline && maxline >= 0) || readlen <= 0)
1948 break;
1949 if (start < p)
1950 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02001951 // There's part of a line in buf, store it in "prev".
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001952 if (p - start + prevlen >= prevsize)
1953 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02001954 // need bigger "prev" buffer
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001955 char_u *newprev;
1956
Bram Moolenaar26262f82019-09-04 20:59:15 +02001957 // A common use case is ordinary text files and "prev" gets a
1958 // fragment of a line, so the first allocation is made
1959 // small, to avoid repeatedly 'allocing' large and
1960 // 'reallocing' small.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001961 if (prevsize == 0)
1962 prevsize = (long)(p - start);
1963 else
1964 {
1965 long grow50pc = (prevsize * 3) / 2;
1966 long growmin = (long)((p - start) * 2 + prevlen);
1967 prevsize = grow50pc > growmin ? grow50pc : growmin;
1968 }
1969 newprev = vim_realloc(prev, prevsize);
1970 if (newprev == NULL)
1971 {
1972 do_outofmem_msg((long_u)prevsize);
1973 failed = TRUE;
1974 break;
1975 }
1976 prev = newprev;
1977 }
Bram Moolenaar26262f82019-09-04 20:59:15 +02001978 // Add the line part to end of "prev".
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001979 mch_memmove(prev + prevlen, start, p - start);
1980 prevlen += (long)(p - start);
1981 }
Bram Moolenaar26262f82019-09-04 20:59:15 +02001982 } // while
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001983
Bram Moolenaar26262f82019-09-04 20:59:15 +02001984 // For a negative line count use only the lines at the end of the file,
1985 // free the rest.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02001986 if (!failed && maxline < 0)
1987 while (cnt > -maxline)
1988 {
1989 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
1990 --cnt;
1991 }
1992
1993 if (failed)
1994 {
1995 // an empty list is returned on error
1996 list_free(rettv->vval.v_list);
1997 rettv_list_alloc(rettv);
1998 }
1999
2000 vim_free(prev);
2001 fclose(fd);
2002}
2003
2004/*
Bram Moolenaarc423ad72021-01-13 20:38:03 +01002005 * "readblob()" function
2006 */
2007 void
2008f_readblob(typval_T *argvars, typval_T *rettv)
2009{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02002010 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
2011 return;
2012
Bram Moolenaarc423ad72021-01-13 20:38:03 +01002013 read_file_or_blob(argvars, rettv, TRUE);
2014}
2015
2016/*
2017 * "readfile()" function
2018 */
2019 void
2020f_readfile(typval_T *argvars, typval_T *rettv)
2021{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02002022 if (in_vim9script()
2023 && (check_for_nonempty_string_arg(argvars, 0) == FAIL
2024 || check_for_opt_string_arg(argvars, 1) == FAIL
2025 || (argvars[1].v_type != VAR_UNKNOWN
2026 && check_for_opt_number_arg(argvars, 2) == FAIL)))
2027 return;
2028
Bram Moolenaarc423ad72021-01-13 20:38:03 +01002029 read_file_or_blob(argvars, rettv, FALSE);
2030}
2031
2032/*
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002033 * "resolve()" function
2034 */
2035 void
2036f_resolve(typval_T *argvars, typval_T *rettv)
2037{
2038 char_u *p;
2039#ifdef HAVE_READLINK
2040 char_u *buf = NULL;
2041#endif
2042
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02002043 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
2044 return;
2045
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002046 p = tv_get_string(&argvars[0]);
2047#ifdef FEAT_SHORTCUT
2048 {
2049 char_u *v = NULL;
2050
2051 v = mch_resolve_path(p, TRUE);
2052 if (v != NULL)
2053 rettv->vval.v_string = v;
2054 else
2055 rettv->vval.v_string = vim_strsave(p);
2056 }
2057#else
2058# ifdef HAVE_READLINK
2059 {
2060 char_u *cpy;
2061 int len;
2062 char_u *remain = NULL;
2063 char_u *q;
2064 int is_relative_to_current = FALSE;
2065 int has_trailing_pathsep = FALSE;
2066 int limit = 100;
2067
2068 p = vim_strsave(p);
Bram Moolenaar70188f52019-12-23 18:18:52 +01002069 if (p == NULL)
2070 goto fail;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002071 if (p[0] == '.' && (vim_ispathsep(p[1])
2072 || (p[1] == '.' && (vim_ispathsep(p[2])))))
2073 is_relative_to_current = TRUE;
2074
2075 len = STRLEN(p);
Bram Moolenaar50c4e9e2020-10-05 20:38:06 +02002076 if (len > 1 && after_pathsep(p, p + len))
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002077 {
2078 has_trailing_pathsep = TRUE;
Bram Moolenaar26262f82019-09-04 20:59:15 +02002079 p[len - 1] = NUL; // the trailing slash breaks readlink()
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002080 }
2081
2082 q = getnextcomp(p);
2083 if (*q != NUL)
2084 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02002085 // Separate the first path component in "p", and keep the
2086 // remainder (beginning with the path separator).
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002087 remain = vim_strsave(q - 1);
2088 q[-1] = NUL;
2089 }
2090
2091 buf = alloc(MAXPATHL + 1);
2092 if (buf == NULL)
Bram Moolenaar70188f52019-12-23 18:18:52 +01002093 {
2094 vim_free(p);
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002095 goto fail;
Bram Moolenaar70188f52019-12-23 18:18:52 +01002096 }
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002097
2098 for (;;)
2099 {
2100 for (;;)
2101 {
2102 len = readlink((char *)p, (char *)buf, MAXPATHL);
2103 if (len <= 0)
2104 break;
2105 buf[len] = NUL;
2106
2107 if (limit-- == 0)
2108 {
2109 vim_free(p);
2110 vim_free(remain);
Bram Moolenaara6f79292022-01-04 21:30:47 +00002111 emsg(_(e_too_many_symbolic_links_cycle));
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002112 rettv->vval.v_string = NULL;
2113 goto fail;
2114 }
2115
Bram Moolenaar26262f82019-09-04 20:59:15 +02002116 // Ensure that the result will have a trailing path separator
2117 // if the argument has one.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002118 if (remain == NULL && has_trailing_pathsep)
2119 add_pathsep(buf);
2120
Bram Moolenaar26262f82019-09-04 20:59:15 +02002121 // Separate the first path component in the link value and
2122 // concatenate the remainders.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002123 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
2124 if (*q != NUL)
2125 {
2126 if (remain == NULL)
2127 remain = vim_strsave(q - 1);
2128 else
2129 {
2130 cpy = concat_str(q - 1, remain);
2131 if (cpy != NULL)
2132 {
2133 vim_free(remain);
2134 remain = cpy;
2135 }
2136 }
2137 q[-1] = NUL;
2138 }
2139
2140 q = gettail(p);
2141 if (q > p && *q == NUL)
2142 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02002143 // Ignore trailing path separator.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002144 q[-1] = NUL;
2145 q = gettail(p);
2146 }
2147 if (q > p && !mch_isFullName(buf))
2148 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02002149 // symlink is relative to directory of argument
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002150 cpy = alloc(STRLEN(p) + STRLEN(buf) + 1);
2151 if (cpy != NULL)
2152 {
2153 STRCPY(cpy, p);
2154 STRCPY(gettail(cpy), buf);
2155 vim_free(p);
2156 p = cpy;
2157 }
2158 }
2159 else
2160 {
2161 vim_free(p);
2162 p = vim_strsave(buf);
2163 }
2164 }
2165
2166 if (remain == NULL)
2167 break;
2168
Bram Moolenaar26262f82019-09-04 20:59:15 +02002169 // Append the first path component of "remain" to "p".
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002170 q = getnextcomp(remain + 1);
2171 len = q - remain - (*q != NUL);
2172 cpy = vim_strnsave(p, STRLEN(p) + len);
2173 if (cpy != NULL)
2174 {
2175 STRNCAT(cpy, remain, len);
2176 vim_free(p);
2177 p = cpy;
2178 }
Bram Moolenaar26262f82019-09-04 20:59:15 +02002179 // Shorten "remain".
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002180 if (*q != NUL)
2181 STRMOVE(remain, q - 1);
2182 else
2183 VIM_CLEAR(remain);
2184 }
2185
Bram Moolenaar26262f82019-09-04 20:59:15 +02002186 // If the result is a relative path name, make it explicitly relative to
2187 // the current directory if and only if the argument had this form.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002188 if (!vim_ispathsep(*p))
2189 {
2190 if (is_relative_to_current
2191 && *p != NUL
2192 && !(p[0] == '.'
2193 && (p[1] == NUL
2194 || vim_ispathsep(p[1])
2195 || (p[1] == '.'
2196 && (p[2] == NUL
2197 || vim_ispathsep(p[2]))))))
2198 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02002199 // Prepend "./".
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002200 cpy = concat_str((char_u *)"./", p);
2201 if (cpy != NULL)
2202 {
2203 vim_free(p);
2204 p = cpy;
2205 }
2206 }
2207 else if (!is_relative_to_current)
2208 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02002209 // Strip leading "./".
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002210 q = p;
2211 while (q[0] == '.' && vim_ispathsep(q[1]))
2212 q += 2;
2213 if (q > p)
2214 STRMOVE(p, p + 2);
2215 }
2216 }
2217
Bram Moolenaar26262f82019-09-04 20:59:15 +02002218 // Ensure that the result will have no trailing path separator
2219 // if the argument had none. But keep "/" or "//".
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002220 if (!has_trailing_pathsep)
2221 {
2222 q = p + STRLEN(p);
2223 if (after_pathsep(p, q))
2224 *gettail_sep(p) = NUL;
2225 }
2226
2227 rettv->vval.v_string = p;
2228 }
2229# else
2230 rettv->vval.v_string = vim_strsave(p);
2231# endif
2232#endif
2233
2234 simplify_filename(rettv->vval.v_string);
2235
2236#ifdef HAVE_READLINK
2237fail:
2238 vim_free(buf);
2239#endif
2240 rettv->v_type = VAR_STRING;
2241}
2242
2243/*
2244 * "tempname()" function
2245 */
2246 void
2247f_tempname(typval_T *argvars UNUSED, typval_T *rettv)
2248{
2249 static int x = 'A';
2250
2251 rettv->v_type = VAR_STRING;
2252 rettv->vval.v_string = vim_tempname(x, FALSE);
2253
Bram Moolenaar26262f82019-09-04 20:59:15 +02002254 // Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
2255 // names. Skip 'I' and 'O', they are used for shell redirection.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002256 do
2257 {
2258 if (x == 'Z')
2259 x = '0';
2260 else if (x == '9')
2261 x = 'A';
2262 else
Bram Moolenaar424bcae2022-01-31 14:59:41 +00002263 ++x;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002264 } while (x == 'I' || x == 'O');
2265}
2266
2267/*
2268 * "writefile()" function
2269 */
2270 void
2271f_writefile(typval_T *argvars, typval_T *rettv)
2272{
2273 int binary = FALSE;
2274 int append = FALSE;
Bram Moolenaar806a2732022-09-04 15:40:36 +01002275 int defer = FALSE;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002276#ifdef HAVE_FSYNC
2277 int do_fsync = p_fs;
2278#endif
2279 char_u *fname;
2280 FILE *fd;
2281 int ret = 0;
2282 listitem_T *li;
2283 list_T *list = NULL;
2284 blob_T *blob = NULL;
2285
2286 rettv->vval.v_number = -1;
2287 if (check_secure())
2288 return;
2289
Yegappan Lakshmanan0ad871d2021-07-23 20:37:56 +02002290 if (in_vim9script()
2291 && (check_for_list_or_blob_arg(argvars, 0) == FAIL
2292 || check_for_string_arg(argvars, 1) == FAIL
2293 || check_for_opt_string_arg(argvars, 2) == FAIL))
2294 return;
2295
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002296 if (argvars[0].v_type == VAR_LIST)
2297 {
2298 list = argvars[0].vval.v_list;
2299 if (list == NULL)
2300 return;
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002301 CHECK_LIST_MATERIALIZE(list);
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002302 FOR_ALL_LIST_ITEMS(list, li)
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002303 if (tv_get_string_chk(&li->li_tv) == NULL)
2304 return;
2305 }
2306 else if (argvars[0].v_type == VAR_BLOB)
2307 {
2308 blob = argvars[0].vval.v_blob;
2309 if (blob == NULL)
2310 return;
2311 }
2312 else
2313 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00002314 semsg(_(e_invalid_argument_str),
Bram Moolenaar18a2b872020-03-19 13:08:45 +01002315 _("writefile() first argument must be a List or a Blob"));
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002316 return;
2317 }
2318
2319 if (argvars[2].v_type != VAR_UNKNOWN)
2320 {
2321 char_u *arg2 = tv_get_string_chk(&argvars[2]);
2322
2323 if (arg2 == NULL)
2324 return;
2325 if (vim_strchr(arg2, 'b') != NULL)
2326 binary = TRUE;
2327 if (vim_strchr(arg2, 'a') != NULL)
2328 append = TRUE;
Bram Moolenaar806a2732022-09-04 15:40:36 +01002329 if (vim_strchr(arg2, 'D') != NULL)
2330 defer = TRUE;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002331#ifdef HAVE_FSYNC
2332 if (vim_strchr(arg2, 's') != NULL)
2333 do_fsync = TRUE;
2334 else if (vim_strchr(arg2, 'S') != NULL)
2335 do_fsync = FALSE;
2336#endif
2337 }
2338
2339 fname = tv_get_string_chk(&argvars[1]);
2340 if (fname == NULL)
2341 return;
2342
Bram Moolenaar6f14da12022-09-07 21:30:44 +01002343 if (defer && !can_add_defer())
Bram Moolenaar806a2732022-09-04 15:40:36 +01002344 return;
Bram Moolenaar806a2732022-09-04 15:40:36 +01002345
Bram Moolenaar26262f82019-09-04 20:59:15 +02002346 // Always open the file in binary mode, library functions have a mind of
2347 // their own about CR-LF conversion.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002348 if (*fname == NUL || (fd = mch_fopen((char *)fname,
2349 append ? APPENDBIN : WRITEBIN)) == NULL)
2350 {
Bram Moolenaar806a2732022-09-04 15:40:36 +01002351 semsg(_(e_cant_create_file_str),
2352 *fname == NUL ? (char_u *)_("<empty>") : fname);
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002353 ret = -1;
2354 }
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002355 else
2356 {
Bram Moolenaar806a2732022-09-04 15:40:36 +01002357 if (defer)
2358 {
2359 typval_T tv;
2360
2361 tv.v_type = VAR_STRING;
2362 tv.v_lock = 0;
Bram Moolenaar6f14da12022-09-07 21:30:44 +01002363 tv.vval.v_string = FullName_save(fname, FALSE);
Bram Moolenaar806a2732022-09-04 15:40:36 +01002364 if (tv.vval.v_string == NULL
2365 || add_defer((char_u *)"delete", 1, &tv) == FAIL)
2366 {
2367 ret = -1;
2368 fclose(fd);
2369 (void)mch_remove(fname);
2370 }
2371 }
2372
2373 if (ret == 0)
2374 {
2375 if (blob)
2376 {
2377 if (write_blob(fd, blob) == FAIL)
2378 ret = -1;
2379 }
2380 else
2381 {
2382 if (write_list(fd, list, binary) == FAIL)
2383 ret = -1;
2384 }
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002385#ifdef HAVE_FSYNC
Bram Moolenaar806a2732022-09-04 15:40:36 +01002386 if (ret == 0 && do_fsync)
2387 // Ignore the error, the user wouldn't know what to do about
2388 // it. May happen for a device.
2389 vim_ignored = vim_fsync(fileno(fd));
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002390#endif
Bram Moolenaar806a2732022-09-04 15:40:36 +01002391 fclose(fd);
2392 }
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002393 }
2394
2395 rettv->vval.v_number = ret;
2396}
2397
2398#endif // FEAT_EVAL
2399
2400#if defined(FEAT_BROWSE) || defined(PROTO)
2401/*
2402 * Generic browse function. Calls gui_mch_browse() when possible.
2403 * Later this may pop-up a non-GUI file selector (external command?).
2404 */
2405 char_u *
2406do_browse(
Bram Moolenaar26262f82019-09-04 20:59:15 +02002407 int flags, // BROWSE_SAVE and BROWSE_DIR
2408 char_u *title, // title for the window
2409 char_u *dflt, // default file name (may include directory)
2410 char_u *ext, // extension added
2411 char_u *initdir, // initial directory, NULL for current dir or
2412 // when using path from "dflt"
2413 char_u *filter, // file name filter
2414 buf_T *buf) // buffer to read/write for
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002415{
2416 char_u *fname;
Bram Moolenaar26262f82019-09-04 20:59:15 +02002417 static char_u *last_dir = NULL; // last used directory
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002418 char_u *tofree = NULL;
Bram Moolenaare1004402020-10-24 20:49:43 +02002419 int save_cmod_flags = cmdmod.cmod_flags;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002420
Bram Moolenaar26262f82019-09-04 20:59:15 +02002421 // Must turn off browse to avoid that autocommands will get the
2422 // flag too!
Bram Moolenaare1004402020-10-24 20:49:43 +02002423 cmdmod.cmod_flags &= ~CMOD_BROWSE;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002424
2425 if (title == NULL || *title == NUL)
2426 {
2427 if (flags & BROWSE_DIR)
2428 title = (char_u *)_("Select Directory dialog");
2429 else if (flags & BROWSE_SAVE)
2430 title = (char_u *)_("Save File dialog");
2431 else
2432 title = (char_u *)_("Open File dialog");
2433 }
2434
Bram Moolenaar26262f82019-09-04 20:59:15 +02002435 // When no directory specified, use default file name, default dir, buffer
2436 // dir, last dir or current dir
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002437 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
2438 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02002439 if (mch_isdir(dflt)) // default file name is a directory
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002440 {
2441 initdir = dflt;
2442 dflt = NULL;
2443 }
Bram Moolenaar26262f82019-09-04 20:59:15 +02002444 else if (gettail(dflt) != dflt) // default file name includes a path
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002445 {
2446 tofree = vim_strsave(dflt);
2447 if (tofree != NULL)
2448 {
2449 initdir = tofree;
2450 *gettail(initdir) = NUL;
2451 dflt = gettail(dflt);
2452 }
2453 }
2454 }
2455
2456 if (initdir == NULL || *initdir == NUL)
2457 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02002458 // When 'browsedir' is a directory, use it
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002459 if (STRCMP(p_bsdir, "last") != 0
2460 && STRCMP(p_bsdir, "buffer") != 0
2461 && STRCMP(p_bsdir, "current") != 0
2462 && mch_isdir(p_bsdir))
2463 initdir = p_bsdir;
Bram Moolenaar26262f82019-09-04 20:59:15 +02002464 // When saving or 'browsedir' is "buffer", use buffer fname
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002465 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
2466 && buf != NULL && buf->b_ffname != NULL)
2467 {
2468 if (dflt == NULL || *dflt == NUL)
2469 dflt = gettail(curbuf->b_ffname);
2470 tofree = vim_strsave(curbuf->b_ffname);
2471 if (tofree != NULL)
2472 {
2473 initdir = tofree;
2474 *gettail(initdir) = NUL;
2475 }
2476 }
Bram Moolenaar26262f82019-09-04 20:59:15 +02002477 // When 'browsedir' is "last", use dir from last browse
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002478 else if (*p_bsdir == 'l')
2479 initdir = last_dir;
Bram Moolenaar26262f82019-09-04 20:59:15 +02002480 // When 'browsedir is "current", use current directory. This is the
2481 // default already, leave initdir empty.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002482 }
2483
2484# ifdef FEAT_GUI
Bram Moolenaar26262f82019-09-04 20:59:15 +02002485 if (gui.in_use) // when this changes, also adjust f_has()!
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002486 {
2487 if (filter == NULL
2488# ifdef FEAT_EVAL
2489 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
2490 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
2491# endif
2492 )
2493 filter = BROWSE_FILTER_DEFAULT;
2494 if (flags & BROWSE_DIR)
2495 {
2496# if defined(FEAT_GUI_GTK) || defined(MSWIN)
Bram Moolenaar26262f82019-09-04 20:59:15 +02002497 // For systems that have a directory dialog.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002498 fname = gui_mch_browsedir(title, initdir);
2499# else
Bram Moolenaar26262f82019-09-04 20:59:15 +02002500 // Generic solution for selecting a directory: select a file and
2501 // remove the file name.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002502 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
2503# endif
2504# if !defined(FEAT_GUI_GTK)
Bram Moolenaar26262f82019-09-04 20:59:15 +02002505 // Win32 adds a dummy file name, others return an arbitrary file
2506 // name. GTK+ 2 returns only the directory,
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002507 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
2508 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02002509 // Remove the file name.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002510 char_u *tail = gettail_sep(fname);
2511
2512 if (tail == fname)
Bram Moolenaar26262f82019-09-04 20:59:15 +02002513 *tail++ = '.'; // use current dir
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002514 *tail = NUL;
2515 }
2516# endif
2517 }
2518 else
2519 fname = gui_mch_browse(flags & BROWSE_SAVE,
2520 title, dflt, ext, initdir, (char_u *)_(filter));
2521
Bram Moolenaar26262f82019-09-04 20:59:15 +02002522 // We hang around in the dialog for a while, the user might do some
2523 // things to our files. The Win32 dialog allows deleting or renaming
2524 // a file, check timestamps.
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002525 need_check_timestamps = TRUE;
2526 did_check_timestamps = FALSE;
2527 }
2528 else
2529# endif
2530 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02002531 // TODO: non-GUI file selector here
Bram Moolenaareaaac012022-01-02 17:00:40 +00002532 emsg(_(e_sorry_no_file_browser_in_console_mode));
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002533 fname = NULL;
2534 }
2535
Bram Moolenaar26262f82019-09-04 20:59:15 +02002536 // keep the directory for next time
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002537 if (fname != NULL)
2538 {
2539 vim_free(last_dir);
2540 last_dir = vim_strsave(fname);
2541 if (last_dir != NULL && !(flags & BROWSE_DIR))
2542 {
2543 *gettail(last_dir) = NUL;
2544 if (*last_dir == NUL)
2545 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02002546 // filename only returned, must be in current dir
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002547 vim_free(last_dir);
2548 last_dir = alloc(MAXPATHL);
2549 if (last_dir != NULL)
2550 mch_dirname(last_dir, MAXPATHL);
2551 }
2552 }
2553 }
2554
2555 vim_free(tofree);
Bram Moolenaare1004402020-10-24 20:49:43 +02002556 cmdmod.cmod_flags = save_cmod_flags;
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002557
2558 return fname;
2559}
2560#endif
2561
2562#if defined(FEAT_EVAL) || defined(PROTO)
2563
2564/*
2565 * "browse(save, title, initdir, default)" function
2566 */
2567 void
2568f_browse(typval_T *argvars UNUSED, typval_T *rettv)
2569{
2570# ifdef FEAT_BROWSE
2571 int save;
2572 char_u *title;
2573 char_u *initdir;
2574 char_u *defname;
2575 char_u buf[NUMBUFLEN];
2576 char_u buf2[NUMBUFLEN];
2577 int error = FALSE;
2578
Bram Moolenaarf28f2ac2021-03-22 22:21:26 +01002579 if (in_vim9script()
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02002580 && (check_for_bool_arg(argvars, 0) == FAIL
2581 || check_for_string_arg(argvars, 1) == FAIL
Bram Moolenaar32105ae2021-03-27 18:59:25 +01002582 || check_for_string_arg(argvars, 2) == FAIL
2583 || check_for_string_arg(argvars, 3) == FAIL))
Bram Moolenaarf28f2ac2021-03-22 22:21:26 +01002584 return;
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02002585
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002586 save = (int)tv_get_number_chk(&argvars[0], &error);
2587 title = tv_get_string_chk(&argvars[1]);
2588 initdir = tv_get_string_buf_chk(&argvars[2], buf);
2589 defname = tv_get_string_buf_chk(&argvars[3], buf2);
2590
2591 if (error || title == NULL || initdir == NULL || defname == NULL)
2592 rettv->vval.v_string = NULL;
2593 else
2594 rettv->vval.v_string =
2595 do_browse(save ? BROWSE_SAVE : 0,
2596 title, defname, NULL, initdir, NULL, curbuf);
2597# else
2598 rettv->vval.v_string = NULL;
2599# endif
2600 rettv->v_type = VAR_STRING;
2601}
2602
2603/*
2604 * "browsedir(title, initdir)" function
2605 */
2606 void
2607f_browsedir(typval_T *argvars UNUSED, typval_T *rettv)
2608{
2609# ifdef FEAT_BROWSE
2610 char_u *title;
2611 char_u *initdir;
2612 char_u buf[NUMBUFLEN];
2613
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02002614 if (in_vim9script()
2615 && (check_for_string_arg(argvars, 0) == FAIL
2616 || check_for_string_arg(argvars, 1) == FAIL))
2617 return;
2618
Bram Moolenaarb005cd82019-09-04 15:54:55 +02002619 title = tv_get_string_chk(&argvars[0]);
2620 initdir = tv_get_string_buf_chk(&argvars[1], buf);
2621
2622 if (title == NULL || initdir == NULL)
2623 rettv->vval.v_string = NULL;
2624 else
2625 rettv->vval.v_string = do_browse(BROWSE_DIR,
2626 title, NULL, NULL, initdir, NULL, curbuf);
2627# else
2628 rettv->vval.v_string = NULL;
2629# endif
2630 rettv->v_type = VAR_STRING;
2631}
2632
2633#endif // FEAT_EVAL
Bram Moolenaar26262f82019-09-04 20:59:15 +02002634
2635/*
2636 * Replace home directory by "~" in each space or comma separated file name in
2637 * 'src'.
2638 * If anything fails (except when out of space) dst equals src.
2639 */
2640 void
2641home_replace(
2642 buf_T *buf, // when not NULL, check for help files
2643 char_u *src, // input file name
2644 char_u *dst, // where to put the result
2645 int dstlen, // maximum length of the result
2646 int one) // if TRUE, only replace one file name, include
2647 // spaces and commas in the file name.
2648{
2649 size_t dirlen = 0, envlen = 0;
2650 size_t len;
2651 char_u *homedir_env, *homedir_env_orig;
2652 char_u *p;
2653
2654 if (src == NULL)
2655 {
2656 *dst = NUL;
2657 return;
2658 }
2659
2660 /*
2661 * If the file is a help file, remove the path completely.
2662 */
2663 if (buf != NULL && buf->b_help)
2664 {
2665 vim_snprintf((char *)dst, dstlen, "%s", gettail(src));
2666 return;
2667 }
2668
2669 /*
2670 * We check both the value of the $HOME environment variable and the
2671 * "real" home directory.
2672 */
2673 if (homedir != NULL)
2674 dirlen = STRLEN(homedir);
2675
2676#ifdef VMS
2677 homedir_env_orig = homedir_env = mch_getenv((char_u *)"SYS$LOGIN");
2678#else
2679 homedir_env_orig = homedir_env = mch_getenv((char_u *)"HOME");
2680#endif
2681#ifdef MSWIN
2682 if (homedir_env == NULL)
2683 homedir_env_orig = homedir_env = mch_getenv((char_u *)"USERPROFILE");
2684#endif
2685 // Empty is the same as not set.
2686 if (homedir_env != NULL && *homedir_env == NUL)
2687 homedir_env = NULL;
2688
2689 if (homedir_env != NULL && *homedir_env == '~')
2690 {
2691 int usedlen = 0;
2692 int flen;
2693 char_u *fbuf = NULL;
2694
2695 flen = (int)STRLEN(homedir_env);
2696 (void)modify_fname((char_u *)":p", FALSE, &usedlen,
2697 &homedir_env, &fbuf, &flen);
2698 flen = (int)STRLEN(homedir_env);
2699 if (flen > 0 && vim_ispathsep(homedir_env[flen - 1]))
2700 // Remove the trailing / that is added to a directory.
2701 homedir_env[flen - 1] = NUL;
2702 }
2703
2704 if (homedir_env != NULL)
2705 envlen = STRLEN(homedir_env);
2706
2707 if (!one)
2708 src = skipwhite(src);
2709 while (*src && dstlen > 0)
2710 {
2711 /*
2712 * Here we are at the beginning of a file name.
2713 * First, check to see if the beginning of the file name matches
2714 * $HOME or the "real" home directory. Check that there is a '/'
2715 * after the match (so that if e.g. the file is "/home/pieter/bla",
2716 * and the home directory is "/home/piet", the file does not end up
2717 * as "~er/bla" (which would seem to indicate the file "bla" in user
2718 * er's home directory)).
2719 */
2720 p = homedir;
2721 len = dirlen;
2722 for (;;)
2723 {
2724 if ( len
2725 && fnamencmp(src, p, len) == 0
2726 && (vim_ispathsep(src[len])
2727 || (!one && (src[len] == ',' || src[len] == ' '))
2728 || src[len] == NUL))
2729 {
2730 src += len;
2731 if (--dstlen > 0)
2732 *dst++ = '~';
2733
Bram Moolenaar0e390f42020-06-10 13:12:28 +02002734 // Do not add directory separator into dst, because dst is
2735 // expected to just return the directory name without the
2736 // directory separator '/'.
Bram Moolenaar26262f82019-09-04 20:59:15 +02002737 break;
2738 }
2739 if (p == homedir_env)
2740 break;
2741 p = homedir_env;
2742 len = envlen;
2743 }
2744
2745 // if (!one) skip to separator: space or comma
2746 while (*src && (one || (*src != ',' && *src != ' ')) && --dstlen > 0)
2747 *dst++ = *src++;
2748 // skip separator
2749 while ((*src == ' ' || *src == ',') && --dstlen > 0)
2750 *dst++ = *src++;
2751 }
2752 // if (dstlen == 0) out of space, what to do???
2753
2754 *dst = NUL;
2755
2756 if (homedir_env != homedir_env_orig)
2757 vim_free(homedir_env);
2758}
2759
2760/*
2761 * Like home_replace, store the replaced string in allocated memory.
2762 * When something fails, NULL is returned.
2763 */
2764 char_u *
2765home_replace_save(
2766 buf_T *buf, // when not NULL, check for help files
2767 char_u *src) // input file name
2768{
2769 char_u *dst;
2770 unsigned len;
2771
2772 len = 3; // space for "~/" and trailing NUL
2773 if (src != NULL) // just in case
2774 len += (unsigned)STRLEN(src);
2775 dst = alloc(len);
2776 if (dst != NULL)
2777 home_replace(buf, src, dst, len, TRUE);
2778 return dst;
2779}
2780
2781/*
2782 * Compare two file names and return:
2783 * FPC_SAME if they both exist and are the same file.
2784 * FPC_SAMEX if they both don't exist and have the same file name.
2785 * FPC_DIFF if they both exist and are different files.
2786 * FPC_NOTX if they both don't exist.
2787 * FPC_DIFFX if one of them doesn't exist.
2788 * For the first name environment variables are expanded if "expandenv" is
2789 * TRUE.
2790 */
2791 int
2792fullpathcmp(
2793 char_u *s1,
2794 char_u *s2,
2795 int checkname, // when both don't exist, check file names
2796 int expandenv)
2797{
2798#ifdef UNIX
2799 char_u exp1[MAXPATHL];
2800 char_u full1[MAXPATHL];
2801 char_u full2[MAXPATHL];
2802 stat_T st1, st2;
2803 int r1, r2;
2804
2805 if (expandenv)
2806 expand_env(s1, exp1, MAXPATHL);
2807 else
2808 vim_strncpy(exp1, s1, MAXPATHL - 1);
2809 r1 = mch_stat((char *)exp1, &st1);
2810 r2 = mch_stat((char *)s2, &st2);
2811 if (r1 != 0 && r2 != 0)
2812 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002813 // if mch_stat() doesn't work, may compare the names
Bram Moolenaar26262f82019-09-04 20:59:15 +02002814 if (checkname)
2815 {
2816 if (fnamecmp(exp1, s2) == 0)
2817 return FPC_SAMEX;
2818 r1 = vim_FullName(exp1, full1, MAXPATHL, FALSE);
2819 r2 = vim_FullName(s2, full2, MAXPATHL, FALSE);
2820 if (r1 == OK && r2 == OK && fnamecmp(full1, full2) == 0)
2821 return FPC_SAMEX;
2822 }
2823 return FPC_NOTX;
2824 }
2825 if (r1 != 0 || r2 != 0)
2826 return FPC_DIFFX;
2827 if (st1.st_dev == st2.st_dev && st1.st_ino == st2.st_ino)
2828 return FPC_SAME;
2829 return FPC_DIFF;
2830#else
2831 char_u *exp1; // expanded s1
2832 char_u *full1; // full path of s1
2833 char_u *full2; // full path of s2
2834 int retval = FPC_DIFF;
2835 int r1, r2;
2836
2837 // allocate one buffer to store three paths (alloc()/free() is slow!)
2838 if ((exp1 = alloc(MAXPATHL * 3)) != NULL)
2839 {
2840 full1 = exp1 + MAXPATHL;
2841 full2 = full1 + MAXPATHL;
2842
2843 if (expandenv)
2844 expand_env(s1, exp1, MAXPATHL);
2845 else
2846 vim_strncpy(exp1, s1, MAXPATHL - 1);
2847 r1 = vim_FullName(exp1, full1, MAXPATHL, FALSE);
2848 r2 = vim_FullName(s2, full2, MAXPATHL, FALSE);
2849
2850 // If vim_FullName() fails, the file probably doesn't exist.
2851 if (r1 != OK && r2 != OK)
2852 {
2853 if (checkname && fnamecmp(exp1, s2) == 0)
2854 retval = FPC_SAMEX;
2855 else
2856 retval = FPC_NOTX;
2857 }
2858 else if (r1 != OK || r2 != OK)
2859 retval = FPC_DIFFX;
2860 else if (fnamecmp(full1, full2))
2861 retval = FPC_DIFF;
2862 else
2863 retval = FPC_SAME;
2864 vim_free(exp1);
2865 }
2866 return retval;
2867#endif
2868}
2869
2870/*
2871 * Get the tail of a path: the file name.
2872 * When the path ends in a path separator the tail is the NUL after it.
2873 * Fail safe: never returns NULL.
2874 */
2875 char_u *
2876gettail(char_u *fname)
2877{
2878 char_u *p1, *p2;
2879
2880 if (fname == NULL)
2881 return (char_u *)"";
2882 for (p1 = p2 = get_past_head(fname); *p2; ) // find last part of path
2883 {
2884 if (vim_ispathsep_nocolon(*p2))
2885 p1 = p2 + 1;
2886 MB_PTR_ADV(p2);
2887 }
2888 return p1;
2889}
2890
2891/*
2892 * Get pointer to tail of "fname", including path separators. Putting a NUL
2893 * here leaves the directory name. Takes care of "c:/" and "//".
2894 * Always returns a valid pointer.
2895 */
2896 char_u *
2897gettail_sep(char_u *fname)
2898{
2899 char_u *p;
2900 char_u *t;
2901
2902 p = get_past_head(fname); // don't remove the '/' from "c:/file"
2903 t = gettail(fname);
2904 while (t > p && after_pathsep(fname, t))
2905 --t;
2906#ifdef VMS
2907 // path separator is part of the path
2908 ++t;
2909#endif
2910 return t;
2911}
2912
2913/*
2914 * get the next path component (just after the next path separator).
2915 */
2916 char_u *
2917getnextcomp(char_u *fname)
2918{
2919 while (*fname && !vim_ispathsep(*fname))
2920 MB_PTR_ADV(fname);
2921 if (*fname)
2922 ++fname;
2923 return fname;
2924}
2925
2926/*
2927 * Get a pointer to one character past the head of a path name.
2928 * Unix: after "/"; DOS: after "c:\"; Amiga: after "disk:/"; Mac: no head.
2929 * If there is no head, path is returned.
2930 */
2931 char_u *
2932get_past_head(char_u *path)
2933{
2934 char_u *retval;
2935
2936#if defined(MSWIN)
2937 // may skip "c:"
2938 if (isalpha(path[0]) && path[1] == ':')
2939 retval = path + 2;
2940 else
2941 retval = path;
2942#else
2943# if defined(AMIGA)
2944 // may skip "label:"
2945 retval = vim_strchr(path, ':');
2946 if (retval == NULL)
2947 retval = path;
2948# else // Unix
2949 retval = path;
2950# endif
2951#endif
2952
2953 while (vim_ispathsep(*retval))
2954 ++retval;
2955
2956 return retval;
2957}
2958
2959/*
2960 * Return TRUE if 'c' is a path separator.
2961 * Note that for MS-Windows this includes the colon.
2962 */
2963 int
2964vim_ispathsep(int c)
2965{
2966#ifdef UNIX
2967 return (c == '/'); // UNIX has ':' inside file names
2968#else
2969# ifdef BACKSLASH_IN_FILENAME
2970 return (c == ':' || c == '/' || c == '\\');
2971# else
2972# ifdef VMS
2973 // server"user passwd"::device:[full.path.name]fname.extension;version"
2974 return (c == ':' || c == '[' || c == ']' || c == '/'
2975 || c == '<' || c == '>' || c == '"' );
2976# else
2977 return (c == ':' || c == '/');
2978# endif // VMS
2979# endif
2980#endif
2981}
2982
2983/*
2984 * Like vim_ispathsep(c), but exclude the colon for MS-Windows.
2985 */
2986 int
2987vim_ispathsep_nocolon(int c)
2988{
2989 return vim_ispathsep(c)
2990#ifdef BACKSLASH_IN_FILENAME
2991 && c != ':'
2992#endif
2993 ;
2994}
2995
2996/*
Bram Moolenaar26262f82019-09-04 20:59:15 +02002997 * Return TRUE if the directory of "fname" exists, FALSE otherwise.
2998 * Also returns TRUE if there is no directory name.
2999 * "fname" must be writable!.
3000 */
3001 int
3002dir_of_file_exists(char_u *fname)
3003{
3004 char_u *p;
3005 int c;
3006 int retval;
3007
3008 p = gettail_sep(fname);
3009 if (p == fname)
3010 return TRUE;
3011 c = *p;
3012 *p = NUL;
3013 retval = mch_isdir(fname);
3014 *p = c;
3015 return retval;
3016}
3017
3018/*
3019 * Versions of fnamecmp() and fnamencmp() that handle '/' and '\' equally
3020 * and deal with 'fileignorecase'.
3021 */
3022 int
3023vim_fnamecmp(char_u *x, char_u *y)
3024{
3025#ifdef BACKSLASH_IN_FILENAME
3026 return vim_fnamencmp(x, y, MAXPATHL);
3027#else
3028 if (p_fic)
3029 return MB_STRICMP(x, y);
3030 return STRCMP(x, y);
3031#endif
3032}
3033
3034 int
3035vim_fnamencmp(char_u *x, char_u *y, size_t len)
3036{
3037#ifdef BACKSLASH_IN_FILENAME
3038 char_u *px = x;
3039 char_u *py = y;
3040 int cx = NUL;
3041 int cy = NUL;
3042
3043 while (len > 0)
3044 {
3045 cx = PTR2CHAR(px);
3046 cy = PTR2CHAR(py);
3047 if (cx == NUL || cy == NUL
3048 || ((p_fic ? MB_TOLOWER(cx) != MB_TOLOWER(cy) : cx != cy)
3049 && !(cx == '/' && cy == '\\')
3050 && !(cx == '\\' && cy == '/')))
3051 break;
Bram Moolenaar1614a142019-10-06 22:00:13 +02003052 len -= mb_ptr2len(px);
3053 px += mb_ptr2len(px);
3054 py += mb_ptr2len(py);
Bram Moolenaar26262f82019-09-04 20:59:15 +02003055 }
3056 if (len == 0)
3057 return 0;
3058 return (cx - cy);
3059#else
3060 if (p_fic)
3061 return MB_STRNICMP(x, y, len);
3062 return STRNCMP(x, y, len);
3063#endif
3064}
3065
3066/*
3067 * Concatenate file names fname1 and fname2 into allocated memory.
3068 * Only add a '/' or '\\' when 'sep' is TRUE and it is necessary.
3069 */
3070 char_u *
3071concat_fnames(char_u *fname1, char_u *fname2, int sep)
3072{
3073 char_u *dest;
3074
3075 dest = alloc(STRLEN(fname1) + STRLEN(fname2) + 3);
3076 if (dest != NULL)
3077 {
3078 STRCPY(dest, fname1);
3079 if (sep)
3080 add_pathsep(dest);
3081 STRCAT(dest, fname2);
3082 }
3083 return dest;
3084}
3085
3086/*
3087 * Add a path separator to a file name, unless it already ends in a path
3088 * separator.
3089 */
3090 void
3091add_pathsep(char_u *p)
3092{
3093 if (*p != NUL && !after_pathsep(p, p + STRLEN(p)))
3094 STRCAT(p, PATHSEPSTR);
3095}
3096
3097/*
3098 * FullName_save - Make an allocated copy of a full file name.
3099 * Returns NULL when out of memory.
3100 */
3101 char_u *
3102FullName_save(
3103 char_u *fname,
3104 int force) // force expansion, even when it already looks
3105 // like a full path name
3106{
3107 char_u *buf;
3108 char_u *new_fname = NULL;
3109
3110 if (fname == NULL)
3111 return NULL;
3112
3113 buf = alloc(MAXPATHL);
3114 if (buf != NULL)
3115 {
3116 if (vim_FullName(fname, buf, MAXPATHL, force) != FAIL)
3117 new_fname = vim_strsave(buf);
3118 else
3119 new_fname = vim_strsave(fname);
3120 vim_free(buf);
3121 }
3122 return new_fname;
3123}
3124
3125/*
3126 * return TRUE if "fname" exists.
3127 */
3128 int
3129vim_fexists(char_u *fname)
3130{
3131 stat_T st;
3132
3133 if (mch_stat((char *)fname, &st))
3134 return FALSE;
3135 return TRUE;
3136}
3137
3138/*
3139 * Invoke expand_wildcards() for one pattern.
3140 * Expand items like "%:h" before the expansion.
3141 * Returns OK or FAIL.
3142 */
3143 int
3144expand_wildcards_eval(
3145 char_u **pat, // pointer to input pattern
3146 int *num_file, // resulting number of files
3147 char_u ***file, // array of resulting files
3148 int flags) // EW_DIR, etc.
3149{
3150 int ret = FAIL;
3151 char_u *eval_pat = NULL;
3152 char_u *exp_pat = *pat;
Bram Moolenaarf5724372022-09-02 19:45:15 +01003153 char *ignored_msg;
Bram Moolenaar26262f82019-09-04 20:59:15 +02003154 int usedlen;
Bram Moolenaarf5724372022-09-02 19:45:15 +01003155 int is_cur_alt_file = *exp_pat == '%' || *exp_pat == '#';
3156 int star_follows = FALSE;
Bram Moolenaar26262f82019-09-04 20:59:15 +02003157
Bram Moolenaarf5724372022-09-02 19:45:15 +01003158 if (is_cur_alt_file || *exp_pat == '<')
Bram Moolenaar26262f82019-09-04 20:59:15 +02003159 {
3160 ++emsg_off;
3161 eval_pat = eval_vars(exp_pat, exp_pat, &usedlen,
Bram Moolenaara96edb72022-04-28 17:52:24 +01003162 NULL, &ignored_msg, NULL, TRUE);
Bram Moolenaar26262f82019-09-04 20:59:15 +02003163 --emsg_off;
3164 if (eval_pat != NULL)
Bram Moolenaarf5724372022-09-02 19:45:15 +01003165 {
3166 star_follows = STRCMP(exp_pat + usedlen, "*") == 0;
Bram Moolenaar26262f82019-09-04 20:59:15 +02003167 exp_pat = concat_str(eval_pat, exp_pat + usedlen);
Bram Moolenaarf5724372022-09-02 19:45:15 +01003168 }
Bram Moolenaar26262f82019-09-04 20:59:15 +02003169 }
3170
3171 if (exp_pat != NULL)
3172 ret = expand_wildcards(1, &exp_pat, num_file, file, flags);
3173
3174 if (eval_pat != NULL)
3175 {
Bram Moolenaarf5724372022-09-02 19:45:15 +01003176 if (*num_file == 0 && is_cur_alt_file && star_follows)
3177 {
3178 // Expanding "%" or "#" and the file does not exist: Add the
3179 // pattern anyway (without the star) so that this works for remote
3180 // files and non-file buffer names.
3181 *file = ALLOC_ONE(char_u *);
3182 if (*file != NULL)
3183 {
3184 **file = eval_pat;
3185 eval_pat = NULL;
3186 *num_file = 1;
3187 ret = OK;
3188 }
3189 }
Bram Moolenaar26262f82019-09-04 20:59:15 +02003190 vim_free(exp_pat);
3191 vim_free(eval_pat);
3192 }
3193
3194 return ret;
3195}
3196
3197/*
3198 * Expand wildcards. Calls gen_expand_wildcards() and removes files matching
3199 * 'wildignore'.
3200 * Returns OK or FAIL. When FAIL then "num_files" won't be set.
3201 */
3202 int
3203expand_wildcards(
3204 int num_pat, // number of input patterns
3205 char_u **pat, // array of input patterns
3206 int *num_files, // resulting number of files
3207 char_u ***files, // array of resulting files
3208 int flags) // EW_DIR, etc.
3209{
3210 int retval;
3211 int i, j;
3212 char_u *p;
3213 int non_suf_match; // number without matching suffix
3214
3215 retval = gen_expand_wildcards(num_pat, pat, num_files, files, flags);
3216
3217 // When keeping all matches, return here
3218 if ((flags & EW_KEEPALL) || retval == FAIL)
3219 return retval;
3220
Bram Moolenaar26262f82019-09-04 20:59:15 +02003221 /*
3222 * Remove names that match 'wildignore'.
3223 */
3224 if (*p_wig)
3225 {
3226 char_u *ffname;
3227
3228 // check all files in (*files)[]
3229 for (i = 0; i < *num_files; ++i)
3230 {
3231 ffname = FullName_save((*files)[i], FALSE);
3232 if (ffname == NULL) // out of memory
3233 break;
3234# ifdef VMS
3235 vms_remove_version(ffname);
3236# endif
3237 if (match_file_list(p_wig, (*files)[i], ffname))
3238 {
3239 // remove this matching file from the list
3240 vim_free((*files)[i]);
3241 for (j = i; j + 1 < *num_files; ++j)
3242 (*files)[j] = (*files)[j + 1];
3243 --*num_files;
3244 --i;
3245 }
3246 vim_free(ffname);
3247 }
3248
3249 // If the number of matches is now zero, we fail.
3250 if (*num_files == 0)
3251 {
3252 VIM_CLEAR(*files);
3253 return FAIL;
3254 }
3255 }
Bram Moolenaar26262f82019-09-04 20:59:15 +02003256
3257 /*
3258 * Move the names where 'suffixes' match to the end.
Bram Moolenaar57e95172022-08-20 19:26:14 +01003259 * Skip when interrupted, the result probably won't be used.
Bram Moolenaar26262f82019-09-04 20:59:15 +02003260 */
Bram Moolenaar57e95172022-08-20 19:26:14 +01003261 if (*num_files > 1 && !got_int)
Bram Moolenaar26262f82019-09-04 20:59:15 +02003262 {
3263 non_suf_match = 0;
3264 for (i = 0; i < *num_files; ++i)
3265 {
3266 if (!match_suffix((*files)[i]))
3267 {
3268 /*
3269 * Move the name without matching suffix to the front
3270 * of the list.
3271 */
3272 p = (*files)[i];
3273 for (j = i; j > non_suf_match; --j)
3274 (*files)[j] = (*files)[j - 1];
3275 (*files)[non_suf_match++] = p;
3276 }
3277 }
3278 }
3279
3280 return retval;
3281}
3282
3283/*
3284 * Return TRUE if "fname" matches with an entry in 'suffixes'.
3285 */
3286 int
3287match_suffix(char_u *fname)
3288{
3289 int fnamelen, setsuflen;
3290 char_u *setsuf;
3291#define MAXSUFLEN 30 // maximum length of a file suffix
3292 char_u suf_buf[MAXSUFLEN];
3293
3294 fnamelen = (int)STRLEN(fname);
3295 setsuflen = 0;
3296 for (setsuf = p_su; *setsuf; )
3297 {
3298 setsuflen = copy_option_part(&setsuf, suf_buf, MAXSUFLEN, ".,");
3299 if (setsuflen == 0)
3300 {
3301 char_u *tail = gettail(fname);
3302
3303 // empty entry: match name without a '.'
3304 if (vim_strchr(tail, '.') == NULL)
3305 {
3306 setsuflen = 1;
3307 break;
3308 }
3309 }
3310 else
3311 {
3312 if (fnamelen >= setsuflen
3313 && fnamencmp(suf_buf, fname + fnamelen - setsuflen,
3314 (size_t)setsuflen) == 0)
3315 break;
3316 setsuflen = 0;
3317 }
3318 }
3319 return (setsuflen != 0);
3320}
3321
3322#ifdef VIM_BACKTICK
3323
3324/*
3325 * Return TRUE if we can expand this backtick thing here.
3326 */
3327 static int
3328vim_backtick(char_u *p)
3329{
3330 return (*p == '`' && *(p + 1) != NUL && *(p + STRLEN(p) - 1) == '`');
3331}
3332
3333/*
3334 * Expand an item in `backticks` by executing it as a command.
3335 * Currently only works when pat[] starts and ends with a `.
3336 * Returns number of file names found, -1 if an error is encountered.
3337 */
3338 static int
3339expand_backtick(
3340 garray_T *gap,
3341 char_u *pat,
3342 int flags) // EW_* flags
3343{
3344 char_u *p;
3345 char_u *cmd;
3346 char_u *buffer;
3347 int cnt = 0;
3348 int i;
3349
3350 // Create the command: lop off the backticks.
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003351 cmd = vim_strnsave(pat + 1, STRLEN(pat) - 2);
Bram Moolenaar26262f82019-09-04 20:59:15 +02003352 if (cmd == NULL)
3353 return -1;
3354
3355#ifdef FEAT_EVAL
3356 if (*cmd == '=') // `={expr}`: Expand expression
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003357 buffer = eval_to_string(cmd + 1, TRUE, FALSE);
Bram Moolenaar26262f82019-09-04 20:59:15 +02003358 else
3359#endif
3360 buffer = get_cmd_output(cmd, NULL,
3361 (flags & EW_SILENT) ? SHELL_SILENT : 0, NULL);
3362 vim_free(cmd);
3363 if (buffer == NULL)
3364 return -1;
3365
3366 cmd = buffer;
3367 while (*cmd != NUL)
3368 {
3369 cmd = skipwhite(cmd); // skip over white space
3370 p = cmd;
3371 while (*p != NUL && *p != '\r' && *p != '\n') // skip over entry
3372 ++p;
3373 // add an entry if it is not empty
3374 if (p > cmd)
3375 {
3376 i = *p;
3377 *p = NUL;
3378 addfile(gap, cmd, flags);
3379 *p = i;
3380 ++cnt;
3381 }
3382 cmd = p;
3383 while (*cmd != NUL && (*cmd == '\r' || *cmd == '\n'))
3384 ++cmd;
3385 }
3386
3387 vim_free(buffer);
3388 return cnt;
3389}
3390#endif // VIM_BACKTICK
3391
3392#if defined(MSWIN)
3393/*
3394 * File name expansion code for MS-DOS, Win16 and Win32. It's here because
3395 * it's shared between these systems.
3396 */
3397
3398/*
3399 * comparison function for qsort in dos_expandpath()
3400 */
3401 static int
3402pstrcmp(const void *a, const void *b)
3403{
3404 return (pathcmp(*(char **)a, *(char **)b, -1));
3405}
3406
3407/*
3408 * Recursively expand one path component into all matching files and/or
3409 * directories. Adds matches to "gap". Handles "*", "?", "[a-z]", "**", etc.
3410 * Return the number of matches found.
3411 * "path" has backslashes before chars that are not to be expanded, starting
3412 * at "path[wildoff]".
3413 * Return the number of matches found.
3414 * NOTE: much of this is identical to unix_expandpath(), keep in sync!
3415 */
3416 static int
3417dos_expandpath(
3418 garray_T *gap,
3419 char_u *path,
3420 int wildoff,
3421 int flags, // EW_* flags
3422 int didstar) // expanded "**" once already
3423{
3424 char_u *buf;
3425 char_u *path_end;
3426 char_u *p, *s, *e;
3427 int start_len = gap->ga_len;
3428 char_u *pat;
3429 regmatch_T regmatch;
3430 int starts_with_dot;
3431 int matches;
3432 int len;
3433 int starstar = FALSE;
3434 static int stardepth = 0; // depth for "**" expansion
3435 HANDLE hFind = INVALID_HANDLE_VALUE;
3436 WIN32_FIND_DATAW wfb;
3437 WCHAR *wn = NULL; // UCS-2 name, NULL when not used.
3438 char_u *matchname;
3439 int ok;
Bram Moolenaarc74fbfe2020-04-06 22:56:28 +02003440 char_u *p_alt;
Bram Moolenaar26262f82019-09-04 20:59:15 +02003441
3442 // Expanding "**" may take a long time, check for CTRL-C.
3443 if (stardepth > 0)
3444 {
3445 ui_breakcheck();
3446 if (got_int)
3447 return 0;
3448 }
3449
3450 // Make room for file name. When doing encoding conversion the actual
3451 // length may be quite a bit longer, thus use the maximum possible length.
3452 buf = alloc(MAXPATHL);
3453 if (buf == NULL)
3454 return 0;
3455
3456 /*
3457 * Find the first part in the path name that contains a wildcard or a ~1.
3458 * Copy it into buf, including the preceding characters.
3459 */
3460 p = buf;
3461 s = buf;
3462 e = NULL;
3463 path_end = path;
3464 while (*path_end != NUL)
3465 {
3466 // May ignore a wildcard that has a backslash before it; it will
3467 // be removed by rem_backslash() or file_pat_to_reg_pat() below.
3468 if (path_end >= path + wildoff && rem_backslash(path_end))
3469 *p++ = *path_end++;
3470 else if (*path_end == '\\' || *path_end == ':' || *path_end == '/')
3471 {
3472 if (e != NULL)
3473 break;
3474 s = p + 1;
3475 }
3476 else if (path_end >= path + wildoff
3477 && vim_strchr((char_u *)"*?[~", *path_end) != NULL)
3478 e = p;
3479 if (has_mbyte)
3480 {
3481 len = (*mb_ptr2len)(path_end);
3482 STRNCPY(p, path_end, len);
3483 p += len;
3484 path_end += len;
3485 }
3486 else
3487 *p++ = *path_end++;
3488 }
3489 e = p;
3490 *e = NUL;
3491
3492 // now we have one wildcard component between s and e
3493 // Remove backslashes between "wildoff" and the start of the wildcard
3494 // component.
3495 for (p = buf + wildoff; p < s; ++p)
3496 if (rem_backslash(p))
3497 {
3498 STRMOVE(p, p + 1);
3499 --e;
3500 --s;
3501 }
3502
3503 // Check for "**" between "s" and "e".
3504 for (p = s; p < e; ++p)
3505 if (p[0] == '*' && p[1] == '*')
3506 starstar = TRUE;
3507
3508 starts_with_dot = *s == '.';
3509 pat = file_pat_to_reg_pat(s, e, NULL, FALSE);
3510 if (pat == NULL)
3511 {
3512 vim_free(buf);
3513 return 0;
3514 }
3515
3516 // compile the regexp into a program
3517 if (flags & (EW_NOERROR | EW_NOTWILD))
3518 ++emsg_silent;
3519 regmatch.rm_ic = TRUE; // Always ignore case
3520 regmatch.regprog = vim_regcomp(pat, RE_MAGIC);
3521 if (flags & (EW_NOERROR | EW_NOTWILD))
3522 --emsg_silent;
3523 vim_free(pat);
3524
3525 if (regmatch.regprog == NULL && (flags & EW_NOTWILD) == 0)
3526 {
3527 vim_free(buf);
3528 return 0;
3529 }
3530
3531 // remember the pattern or file name being looked for
3532 matchname = vim_strsave(s);
3533
3534 // If "**" is by itself, this is the first time we encounter it and more
3535 // is following then find matches without any directory.
3536 if (!didstar && stardepth < 100 && starstar && e - s == 2
3537 && *path_end == '/')
3538 {
3539 STRCPY(s, path_end + 1);
3540 ++stardepth;
3541 (void)dos_expandpath(gap, buf, (int)(s - buf), flags, TRUE);
3542 --stardepth;
3543 }
3544
3545 // Scan all files in the directory with "dir/ *.*"
3546 STRCPY(s, "*.*");
3547 wn = enc_to_utf16(buf, NULL);
3548 if (wn != NULL)
3549 hFind = FindFirstFileW(wn, &wfb);
3550 ok = (hFind != INVALID_HANDLE_VALUE);
3551
3552 while (ok)
3553 {
3554 p = utf16_to_enc(wfb.cFileName, NULL); // p is allocated here
Bram Moolenaarc74fbfe2020-04-06 22:56:28 +02003555
Bram Moolenaar26262f82019-09-04 20:59:15 +02003556 if (p == NULL)
3557 break; // out of memory
3558
Bram Moolenaar0dc5f602021-02-07 14:01:35 +01003559 // Do not use the alternate filename when the file name ends in '~',
3560 // because it picks up backup files: short name for "foo.vim~" is
3561 // "foo~1.vim", which matches "*.vim".
3562 if (*wfb.cAlternateFileName == NUL || p[STRLEN(p) - 1] == '~')
Bram Moolenaar40655d52020-04-06 23:49:50 +02003563 p_alt = NULL;
Bram Moolenaarc74fbfe2020-04-06 22:56:28 +02003564 else
3565 p_alt = utf16_to_enc(wfb.cAlternateFileName, NULL);
3566
Bram Moolenaar26262f82019-09-04 20:59:15 +02003567 // Ignore entries starting with a dot, unless when asked for. Accept
3568 // all entries found with "matchname".
3569 if ((p[0] != '.' || starts_with_dot
3570 || ((flags & EW_DODOT)
3571 && p[1] != NUL && (p[1] != '.' || p[2] != NUL)))
3572 && (matchname == NULL
3573 || (regmatch.regprog != NULL
Bram Moolenaar40655d52020-04-06 23:49:50 +02003574 && (vim_regexec(&regmatch, p, (colnr_T)0)
Bram Moolenaarc74fbfe2020-04-06 22:56:28 +02003575 || (p_alt != NULL
Bram Moolenaar40655d52020-04-06 23:49:50 +02003576 && vim_regexec(&regmatch, p_alt, (colnr_T)0))))
Bram Moolenaar26262f82019-09-04 20:59:15 +02003577 || ((flags & EW_NOTWILD)
3578 && fnamencmp(path + (s - buf), p, e - s) == 0)))
3579 {
3580 STRCPY(s, p);
3581 len = (int)STRLEN(buf);
3582
Bram Moolenaarc74fbfe2020-04-06 22:56:28 +02003583 if (starstar && stardepth < 100
3584 && (wfb.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY))
Bram Moolenaar26262f82019-09-04 20:59:15 +02003585 {
3586 // For "**" in the pattern first go deeper in the tree to
3587 // find matches.
3588 STRCPY(buf + len, "/**");
3589 STRCPY(buf + len + 3, path_end);
3590 ++stardepth;
3591 (void)dos_expandpath(gap, buf, len + 1, flags, TRUE);
3592 --stardepth;
3593 }
3594
3595 STRCPY(buf + len, path_end);
3596 if (mch_has_exp_wildcard(path_end))
3597 {
3598 // need to expand another component of the path
3599 // remove backslashes for the remaining components only
3600 (void)dos_expandpath(gap, buf, len + 1, flags, FALSE);
3601 }
3602 else
3603 {
3604 // no more wildcards, check if there is a match
3605 // remove backslashes for the remaining components only
3606 if (*path_end != 0)
3607 backslash_halve(buf + len + 1);
3608 if (mch_getperm(buf) >= 0) // add existing file
3609 addfile(gap, buf, flags);
3610 }
3611 }
3612
Bram Moolenaarc74fbfe2020-04-06 22:56:28 +02003613 vim_free(p_alt);
Bram Moolenaar26262f82019-09-04 20:59:15 +02003614 vim_free(p);
3615 ok = FindNextFileW(hFind, &wfb);
Bram Moolenaar26262f82019-09-04 20:59:15 +02003616 }
3617
3618 FindClose(hFind);
3619 vim_free(wn);
3620 vim_free(buf);
3621 vim_regfree(regmatch.regprog);
3622 vim_free(matchname);
3623
3624 matches = gap->ga_len - start_len;
3625 if (matches > 0)
3626 qsort(((char_u **)gap->ga_data) + start_len, (size_t)matches,
3627 sizeof(char_u *), pstrcmp);
3628 return matches;
3629}
3630
3631 int
3632mch_expandpath(
3633 garray_T *gap,
3634 char_u *path,
3635 int flags) // EW_* flags
3636{
3637 return dos_expandpath(gap, path, 0, flags, FALSE);
3638}
3639#endif // MSWIN
3640
3641#if (defined(UNIX) && !defined(VMS)) || defined(USE_UNIXFILENAME) \
3642 || defined(PROTO)
3643/*
3644 * Unix style wildcard expansion code.
3645 * It's here because it's used both for Unix and Mac.
3646 */
3647 static int
3648pstrcmp(const void *a, const void *b)
3649{
3650 return (pathcmp(*(char **)a, *(char **)b, -1));
3651}
3652
3653/*
3654 * Recursively expand one path component into all matching files and/or
3655 * directories. Adds matches to "gap". Handles "*", "?", "[a-z]", "**", etc.
3656 * "path" has backslashes before chars that are not to be expanded, starting
3657 * at "path + wildoff".
3658 * Return the number of matches found.
3659 * NOTE: much of this is identical to dos_expandpath(), keep in sync!
3660 */
3661 int
3662unix_expandpath(
3663 garray_T *gap,
3664 char_u *path,
3665 int wildoff,
3666 int flags, // EW_* flags
3667 int didstar) // expanded "**" once already
3668{
3669 char_u *buf;
Bram Moolenaar386c24c2022-05-16 12:37:36 +01003670 size_t buflen;
Bram Moolenaar26262f82019-09-04 20:59:15 +02003671 char_u *path_end;
3672 char_u *p, *s, *e;
3673 int start_len = gap->ga_len;
3674 char_u *pat;
3675 regmatch_T regmatch;
3676 int starts_with_dot;
3677 int matches;
3678 int len;
3679 int starstar = FALSE;
3680 static int stardepth = 0; // depth for "**" expansion
3681
3682 DIR *dirp;
3683 struct dirent *dp;
3684
3685 // Expanding "**" may take a long time, check for CTRL-C.
3686 if (stardepth > 0)
3687 {
3688 ui_breakcheck();
3689 if (got_int)
3690 return 0;
3691 }
3692
3693 // make room for file name
Bram Moolenaar386c24c2022-05-16 12:37:36 +01003694 buflen = STRLEN(path) + BASENAMELEN + 5;
3695 buf = alloc(buflen);
Bram Moolenaar26262f82019-09-04 20:59:15 +02003696 if (buf == NULL)
3697 return 0;
3698
3699 /*
3700 * Find the first part in the path name that contains a wildcard.
3701 * When EW_ICASE is set every letter is considered to be a wildcard.
3702 * Copy it into "buf", including the preceding characters.
3703 */
3704 p = buf;
3705 s = buf;
3706 e = NULL;
3707 path_end = path;
3708 while (*path_end != NUL)
3709 {
3710 // May ignore a wildcard that has a backslash before it; it will
3711 // be removed by rem_backslash() or file_pat_to_reg_pat() below.
3712 if (path_end >= path + wildoff && rem_backslash(path_end))
3713 *p++ = *path_end++;
3714 else if (*path_end == '/')
3715 {
3716 if (e != NULL)
3717 break;
3718 s = p + 1;
3719 }
3720 else if (path_end >= path + wildoff
3721 && (vim_strchr((char_u *)"*?[{~$", *path_end) != NULL
3722 || (!p_fic && (flags & EW_ICASE)
Bram Moolenaar5921aeb2022-02-19 11:20:12 +00003723 && vim_isalpha(PTR2CHAR(path_end)))))
Bram Moolenaar26262f82019-09-04 20:59:15 +02003724 e = p;
3725 if (has_mbyte)
3726 {
3727 len = (*mb_ptr2len)(path_end);
3728 STRNCPY(p, path_end, len);
3729 p += len;
3730 path_end += len;
3731 }
3732 else
3733 *p++ = *path_end++;
3734 }
3735 e = p;
3736 *e = NUL;
3737
3738 // Now we have one wildcard component between "s" and "e".
3739 // Remove backslashes between "wildoff" and the start of the wildcard
3740 // component.
3741 for (p = buf + wildoff; p < s; ++p)
3742 if (rem_backslash(p))
3743 {
3744 STRMOVE(p, p + 1);
3745 --e;
3746 --s;
3747 }
3748
3749 // Check for "**" between "s" and "e".
3750 for (p = s; p < e; ++p)
3751 if (p[0] == '*' && p[1] == '*')
3752 starstar = TRUE;
3753
3754 // convert the file pattern to a regexp pattern
3755 starts_with_dot = *s == '.';
3756 pat = file_pat_to_reg_pat(s, e, NULL, FALSE);
3757 if (pat == NULL)
3758 {
3759 vim_free(buf);
3760 return 0;
3761 }
3762
3763 // compile the regexp into a program
3764 if (flags & EW_ICASE)
3765 regmatch.rm_ic = TRUE; // 'wildignorecase' set
3766 else
3767 regmatch.rm_ic = p_fic; // ignore case when 'fileignorecase' is set
3768 if (flags & (EW_NOERROR | EW_NOTWILD))
3769 ++emsg_silent;
3770 regmatch.regprog = vim_regcomp(pat, RE_MAGIC);
3771 if (flags & (EW_NOERROR | EW_NOTWILD))
3772 --emsg_silent;
3773 vim_free(pat);
3774
3775 if (regmatch.regprog == NULL && (flags & EW_NOTWILD) == 0)
3776 {
3777 vim_free(buf);
3778 return 0;
3779 }
3780
3781 // If "**" is by itself, this is the first time we encounter it and more
3782 // is following then find matches without any directory.
3783 if (!didstar && stardepth < 100 && starstar && e - s == 2
3784 && *path_end == '/')
3785 {
3786 STRCPY(s, path_end + 1);
3787 ++stardepth;
3788 (void)unix_expandpath(gap, buf, (int)(s - buf), flags, TRUE);
3789 --stardepth;
3790 }
3791
3792 // open the directory for scanning
3793 *s = NUL;
3794 dirp = opendir(*buf == NUL ? "." : (char *)buf);
3795
3796 // Find all matching entries
3797 if (dirp != NULL)
3798 {
Bram Moolenaar57e95172022-08-20 19:26:14 +01003799 while (!got_int)
Bram Moolenaar26262f82019-09-04 20:59:15 +02003800 {
3801 dp = readdir(dirp);
3802 if (dp == NULL)
3803 break;
3804 if ((dp->d_name[0] != '.' || starts_with_dot
3805 || ((flags & EW_DODOT)
3806 && dp->d_name[1] != NUL
3807 && (dp->d_name[1] != '.' || dp->d_name[2] != NUL)))
3808 && ((regmatch.regprog != NULL && vim_regexec(&regmatch,
3809 (char_u *)dp->d_name, (colnr_T)0))
3810 || ((flags & EW_NOTWILD)
3811 && fnamencmp(path + (s - buf), dp->d_name, e - s) == 0)))
3812 {
3813 STRCPY(s, dp->d_name);
3814 len = STRLEN(buf);
3815
3816 if (starstar && stardepth < 100)
3817 {
3818 // For "**" in the pattern first go deeper in the tree to
3819 // find matches.
Bram Moolenaar386c24c2022-05-16 12:37:36 +01003820 vim_snprintf((char *)buf + len, buflen - len,
3821 "/**%s", path_end);
Bram Moolenaar26262f82019-09-04 20:59:15 +02003822 ++stardepth;
3823 (void)unix_expandpath(gap, buf, len + 1, flags, TRUE);
3824 --stardepth;
3825 }
3826
Bram Moolenaar386c24c2022-05-16 12:37:36 +01003827 vim_snprintf((char *)buf + len, buflen - len, "%s", path_end);
Bram Moolenaar26262f82019-09-04 20:59:15 +02003828 if (mch_has_exp_wildcard(path_end)) // handle more wildcards
3829 {
3830 // need to expand another component of the path
3831 // remove backslashes for the remaining components only
3832 (void)unix_expandpath(gap, buf, len + 1, flags, FALSE);
3833 }
3834 else
3835 {
3836 stat_T sb;
3837
3838 // no more wildcards, check if there is a match
3839 // remove backslashes for the remaining components only
3840 if (*path_end != NUL)
3841 backslash_halve(buf + len + 1);
3842 // add existing file or symbolic link
3843 if ((flags & EW_ALLLINKS) ? mch_lstat((char *)buf, &sb) >= 0
3844 : mch_getperm(buf) >= 0)
3845 {
3846#ifdef MACOS_CONVERT
3847 size_t precomp_len = STRLEN(buf)+1;
3848 char_u *precomp_buf =
3849 mac_precompose_path(buf, precomp_len, &precomp_len);
3850
3851 if (precomp_buf)
3852 {
3853 mch_memmove(buf, precomp_buf, precomp_len);
3854 vim_free(precomp_buf);
3855 }
3856#endif
3857 addfile(gap, buf, flags);
3858 }
3859 }
3860 }
3861 }
3862
3863 closedir(dirp);
3864 }
3865
3866 vim_free(buf);
3867 vim_regfree(regmatch.regprog);
3868
Bram Moolenaar57e95172022-08-20 19:26:14 +01003869 // When interrupted the matches probably won't be used and sorting can be
3870 // slow, thus skip it.
Bram Moolenaar26262f82019-09-04 20:59:15 +02003871 matches = gap->ga_len - start_len;
Bram Moolenaar57e95172022-08-20 19:26:14 +01003872 if (matches > 0 && !got_int)
Bram Moolenaar26262f82019-09-04 20:59:15 +02003873 qsort(((char_u **)gap->ga_data) + start_len, matches,
3874 sizeof(char_u *), pstrcmp);
3875 return matches;
3876}
3877#endif
3878
3879/*
3880 * Return TRUE if "p" contains what looks like an environment variable.
3881 * Allowing for escaping.
3882 */
3883 static int
3884has_env_var(char_u *p)
3885{
3886 for ( ; *p; MB_PTR_ADV(p))
3887 {
3888 if (*p == '\\' && p[1] != NUL)
3889 ++p;
3890 else if (vim_strchr((char_u *)
3891#if defined(MSWIN)
3892 "$%"
3893#else
3894 "$"
3895#endif
3896 , *p) != NULL)
3897 return TRUE;
3898 }
3899 return FALSE;
3900}
3901
3902#ifdef SPECIAL_WILDCHAR
3903/*
3904 * Return TRUE if "p" contains a special wildcard character, one that Vim
3905 * cannot expand, requires using a shell.
3906 */
3907 static int
3908has_special_wildchar(char_u *p)
3909{
3910 for ( ; *p; MB_PTR_ADV(p))
3911 {
3912 // Disallow line break characters.
3913 if (*p == '\r' || *p == '\n')
3914 break;
3915 // Allow for escaping.
3916 if (*p == '\\' && p[1] != NUL && p[1] != '\r' && p[1] != '\n')
3917 ++p;
3918 else if (vim_strchr((char_u *)SPECIAL_WILDCHAR, *p) != NULL)
3919 {
3920 // A { must be followed by a matching }.
3921 if (*p == '{' && vim_strchr(p, '}') == NULL)
3922 continue;
3923 // A quote and backtick must be followed by another one.
3924 if ((*p == '`' || *p == '\'') && vim_strchr(p, *p) == NULL)
3925 continue;
3926 return TRUE;
3927 }
3928 }
3929 return FALSE;
3930}
3931#endif
3932
3933/*
3934 * Generic wildcard expansion code.
3935 *
3936 * Characters in "pat" that should not be expanded must be preceded with a
3937 * backslash. E.g., "/path\ with\ spaces/my\*star*"
3938 *
3939 * Return FAIL when no single file was found. In this case "num_file" is not
3940 * set, and "file" may contain an error message.
3941 * Return OK when some files found. "num_file" is set to the number of
3942 * matches, "file" to the array of matches. Call FreeWild() later.
3943 */
3944 int
3945gen_expand_wildcards(
3946 int num_pat, // number of input patterns
3947 char_u **pat, // array of input patterns
3948 int *num_file, // resulting number of files
3949 char_u ***file, // array of resulting files
3950 int flags) // EW_* flags
3951{
3952 int i;
3953 garray_T ga;
3954 char_u *p;
3955 static int recursive = FALSE;
3956 int add_pat;
3957 int retval = OK;
Bram Moolenaar26262f82019-09-04 20:59:15 +02003958 int did_expand_in_path = FALSE;
Bram Moolenaar26262f82019-09-04 20:59:15 +02003959
3960 /*
3961 * expand_env() is called to expand things like "~user". If this fails,
3962 * it calls ExpandOne(), which brings us back here. In this case, always
3963 * call the machine specific expansion function, if possible. Otherwise,
3964 * return FAIL.
3965 */
3966 if (recursive)
3967#ifdef SPECIAL_WILDCHAR
3968 return mch_expand_wildcards(num_pat, pat, num_file, file, flags);
3969#else
3970 return FAIL;
3971#endif
3972
3973#ifdef SPECIAL_WILDCHAR
3974 /*
3975 * If there are any special wildcard characters which we cannot handle
3976 * here, call machine specific function for all the expansion. This
3977 * avoids starting the shell for each argument separately.
3978 * For `=expr` do use the internal function.
3979 */
3980 for (i = 0; i < num_pat; i++)
3981 {
3982 if (has_special_wildchar(pat[i])
3983# ifdef VIM_BACKTICK
3984 && !(vim_backtick(pat[i]) && pat[i][1] == '=')
3985# endif
3986 )
3987 return mch_expand_wildcards(num_pat, pat, num_file, file, flags);
3988 }
3989#endif
3990
3991 recursive = TRUE;
3992
3993 /*
3994 * The matching file names are stored in a growarray. Init it empty.
3995 */
Bram Moolenaar04935fb2022-01-08 16:19:22 +00003996 ga_init2(&ga, sizeof(char_u *), 30);
Bram Moolenaar26262f82019-09-04 20:59:15 +02003997
Bram Moolenaar57e95172022-08-20 19:26:14 +01003998 for (i = 0; i < num_pat && !got_int; ++i)
Bram Moolenaar26262f82019-09-04 20:59:15 +02003999 {
4000 add_pat = -1;
4001 p = pat[i];
4002
4003#ifdef VIM_BACKTICK
4004 if (vim_backtick(p))
4005 {
4006 add_pat = expand_backtick(&ga, p, flags);
4007 if (add_pat == -1)
4008 retval = FAIL;
4009 }
4010 else
4011#endif
4012 {
4013 /*
4014 * First expand environment variables, "~/" and "~user/".
4015 */
4016 if ((has_env_var(p) && !(flags & EW_NOTENV)) || *p == '~')
4017 {
4018 p = expand_env_save_opt(p, TRUE);
4019 if (p == NULL)
4020 p = pat[i];
4021#ifdef UNIX
4022 /*
4023 * On Unix, if expand_env() can't expand an environment
4024 * variable, use the shell to do that. Discard previously
4025 * found file names and start all over again.
4026 */
4027 else if (has_env_var(p) || *p == '~')
4028 {
4029 vim_free(p);
4030 ga_clear_strings(&ga);
4031 i = mch_expand_wildcards(num_pat, pat, num_file, file,
4032 flags|EW_KEEPDOLLAR);
4033 recursive = FALSE;
4034 return i;
4035 }
4036#endif
4037 }
4038
4039 /*
LemonBoya3157a42022-04-03 11:58:31 +01004040 * If there are wildcards or case-insensitive expansion is
4041 * required: Expand file names and add each match to the list. If
4042 * there is no match, and EW_NOTFOUND is given, add the pattern.
4043 * Otherwise: Add the file name if it exists or when EW_NOTFOUND is
4044 * given.
Bram Moolenaar26262f82019-09-04 20:59:15 +02004045 */
LemonBoya3157a42022-04-03 11:58:31 +01004046 if (mch_has_exp_wildcard(p) || (flags & EW_ICASE))
Bram Moolenaar26262f82019-09-04 20:59:15 +02004047 {
Bram Moolenaar26262f82019-09-04 20:59:15 +02004048 if ((flags & EW_PATH)
4049 && !mch_isFullName(p)
4050 && !(p[0] == '.'
4051 && (vim_ispathsep(p[1])
4052 || (p[1] == '.' && vim_ispathsep(p[2]))))
4053 )
4054 {
4055 // :find completion where 'path' is used.
4056 // Recursiveness is OK here.
4057 recursive = FALSE;
4058 add_pat = expand_in_path(&ga, p, flags);
4059 recursive = TRUE;
4060 did_expand_in_path = TRUE;
4061 }
4062 else
Bram Moolenaar26262f82019-09-04 20:59:15 +02004063 add_pat = mch_expandpath(&ga, p, flags);
4064 }
4065 }
4066
4067 if (add_pat == -1 || (add_pat == 0 && (flags & EW_NOTFOUND)))
4068 {
4069 char_u *t = backslash_halve_save(p);
4070
4071 // When EW_NOTFOUND is used, always add files and dirs. Makes
4072 // "vim c:/" work.
4073 if (flags & EW_NOTFOUND)
4074 addfile(&ga, t, flags | EW_DIR | EW_FILE);
4075 else
4076 addfile(&ga, t, flags);
4077
4078 if (t != p)
4079 vim_free(t);
4080 }
4081
Bram Moolenaar26262f82019-09-04 20:59:15 +02004082 if (did_expand_in_path && ga.ga_len > 0 && (flags & EW_PATH))
4083 uniquefy_paths(&ga, p);
Bram Moolenaar26262f82019-09-04 20:59:15 +02004084 if (p != pat[i])
4085 vim_free(p);
4086 }
4087
Bram Moolenaar566cc8c2020-06-29 21:14:51 +02004088 // When returning FAIL the array must be freed here.
4089 if (retval == FAIL)
Yegappan Lakshmanan2b74b682022-04-03 21:30:32 +01004090 ga_clear_strings(&ga);
Bram Moolenaar566cc8c2020-06-29 21:14:51 +02004091
Bram Moolenaar26262f82019-09-04 20:59:15 +02004092 *num_file = ga.ga_len;
Bram Moolenaar566cc8c2020-06-29 21:14:51 +02004093 *file = (ga.ga_data != NULL) ? (char_u **)ga.ga_data
4094 : (char_u **)_("no matches");
Bram Moolenaar26262f82019-09-04 20:59:15 +02004095
4096 recursive = FALSE;
4097
4098 return ((flags & EW_EMPTYOK) || ga.ga_data != NULL) ? retval : FAIL;
4099}
4100
4101/*
4102 * Add a file to a file list. Accepted flags:
4103 * EW_DIR add directories
4104 * EW_FILE add files
4105 * EW_EXEC add executable files
4106 * EW_NOTFOUND add even when it doesn't exist
4107 * EW_ADDSLASH add slash after directory name
4108 * EW_ALLLINKS add symlink also when the referred file does not exist
4109 */
4110 void
4111addfile(
4112 garray_T *gap,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004113 char_u *f, // filename
Bram Moolenaar26262f82019-09-04 20:59:15 +02004114 int flags)
4115{
4116 char_u *p;
4117 int isdir;
4118 stat_T sb;
4119
4120 // if the file/dir/link doesn't exist, may not add it
4121 if (!(flags & EW_NOTFOUND) && ((flags & EW_ALLLINKS)
4122 ? mch_lstat((char *)f, &sb) < 0 : mch_getperm(f) < 0))
4123 return;
4124
4125#ifdef FNAME_ILLEGAL
4126 // if the file/dir contains illegal characters, don't add it
4127 if (vim_strpbrk(f, (char_u *)FNAME_ILLEGAL) != NULL)
4128 return;
4129#endif
4130
4131 isdir = mch_isdir(f);
4132 if ((isdir && !(flags & EW_DIR)) || (!isdir && !(flags & EW_FILE)))
4133 return;
4134
4135 // If the file isn't executable, may not add it. Do accept directories.
4136 // When invoked from expand_shellcmd() do not use $PATH.
4137 if (!isdir && (flags & EW_EXEC)
4138 && !mch_can_exe(f, NULL, !(flags & EW_SHELLCMD)))
4139 return;
4140
4141 // Make room for another item in the file list.
4142 if (ga_grow(gap, 1) == FAIL)
4143 return;
4144
4145 p = alloc(STRLEN(f) + 1 + isdir);
4146 if (p == NULL)
4147 return;
4148
4149 STRCPY(p, f);
4150#ifdef BACKSLASH_IN_FILENAME
4151 slash_adjust(p);
4152#endif
4153 /*
4154 * Append a slash or backslash after directory names if none is present.
4155 */
Bram Moolenaar26262f82019-09-04 20:59:15 +02004156 if (isdir && (flags & EW_ADDSLASH))
4157 add_pathsep(p);
Bram Moolenaar26262f82019-09-04 20:59:15 +02004158 ((char_u **)gap->ga_data)[gap->ga_len++] = p;
4159}
4160
4161/*
4162 * Free the list of files returned by expand_wildcards() or other expansion
4163 * functions.
4164 */
4165 void
4166FreeWild(int count, char_u **files)
4167{
4168 if (count <= 0 || files == NULL)
4169 return;
4170 while (count--)
4171 vim_free(files[count]);
4172 vim_free(files);
4173}
4174
4175/*
4176 * Compare path "p[]" to "q[]".
4177 * If "maxlen" >= 0 compare "p[maxlen]" to "q[maxlen]"
4178 * Return value like strcmp(p, q), but consider path separators.
4179 */
4180 int
4181pathcmp(const char *p, const char *q, int maxlen)
4182{
4183 int i, j;
4184 int c1, c2;
4185 const char *s = NULL;
4186
4187 for (i = 0, j = 0; maxlen < 0 || (i < maxlen && j < maxlen);)
4188 {
4189 c1 = PTR2CHAR((char_u *)p + i);
4190 c2 = PTR2CHAR((char_u *)q + j);
4191
4192 // End of "p": check if "q" also ends or just has a slash.
4193 if (c1 == NUL)
4194 {
4195 if (c2 == NUL) // full match
4196 return 0;
4197 s = q;
4198 i = j;
4199 break;
4200 }
4201
4202 // End of "q": check if "p" just has a slash.
4203 if (c2 == NUL)
4204 {
4205 s = p;
4206 break;
4207 }
4208
4209 if ((p_fic ? MB_TOUPPER(c1) != MB_TOUPPER(c2) : c1 != c2)
4210#ifdef BACKSLASH_IN_FILENAME
4211 // consider '/' and '\\' to be equal
4212 && !((c1 == '/' && c2 == '\\')
4213 || (c1 == '\\' && c2 == '/'))
4214#endif
4215 )
4216 {
4217 if (vim_ispathsep(c1))
4218 return -1;
4219 if (vim_ispathsep(c2))
4220 return 1;
4221 return p_fic ? MB_TOUPPER(c1) - MB_TOUPPER(c2)
4222 : c1 - c2; // no match
4223 }
4224
Bram Moolenaar1614a142019-10-06 22:00:13 +02004225 i += mb_ptr2len((char_u *)p + i);
4226 j += mb_ptr2len((char_u *)q + j);
Bram Moolenaar26262f82019-09-04 20:59:15 +02004227 }
4228 if (s == NULL) // "i" or "j" ran into "maxlen"
4229 return 0;
4230
4231 c1 = PTR2CHAR((char_u *)s + i);
Bram Moolenaar1614a142019-10-06 22:00:13 +02004232 c2 = PTR2CHAR((char_u *)s + i + mb_ptr2len((char_u *)s + i));
Bram Moolenaar26262f82019-09-04 20:59:15 +02004233 // ignore a trailing slash, but not "//" or ":/"
4234 if (c2 == NUL
4235 && i > 0
4236 && !after_pathsep((char_u *)s, (char_u *)s + i)
4237#ifdef BACKSLASH_IN_FILENAME
4238 && (c1 == '/' || c1 == '\\')
4239#else
4240 && c1 == '/'
4241#endif
4242 )
4243 return 0; // match with trailing slash
4244 if (s == q)
4245 return -1; // no match
4246 return 1;
4247}
4248
4249/*
4250 * Return TRUE if "name" is a full (absolute) path name or URL.
4251 */
4252 int
4253vim_isAbsName(char_u *name)
4254{
4255 return (path_with_url(name) != 0 || mch_isFullName(name));
4256}
4257
4258/*
4259 * Get absolute file name into buffer "buf[len]".
4260 *
4261 * return FAIL for failure, OK otherwise
4262 */
4263 int
4264vim_FullName(
4265 char_u *fname,
4266 char_u *buf,
4267 int len,
4268 int force) // force expansion even when already absolute
4269{
4270 int retval = OK;
4271 int url;
4272
4273 *buf = NUL;
4274 if (fname == NULL)
4275 return FAIL;
4276
4277 url = path_with_url(fname);
4278 if (!url)
4279 retval = mch_FullName(fname, buf, len, force);
4280 if (url || retval == FAIL)
4281 {
4282 // something failed; use the file name (truncate when too long)
4283 vim_strncpy(buf, fname, len - 1);
4284 }
4285#if defined(MSWIN)
4286 slash_adjust(buf);
4287#endif
4288 return retval;
4289}