xref: /vim-8.2.3635/src/scriptfile.c (revision b16ad968)
1 /* vi:set ts=8 sts=4 sw=4 noet:
2  *
3  * VIM - Vi IMproved	by Bram Moolenaar
4  *
5  * Do ":help uganda"  in Vim to read copying and usage conditions.
6  * Do ":help credits" in Vim to see a list of people who contributed.
7  * See README.txt for an overview of the Vim source code.
8  */
9 
10 /*
11  * scriptfile.c: functions for dealing with the runtime directories/files
12  */
13 
14 #include "vim.h"
15 
16 #if defined(FEAT_EVAL) || defined(PROTO)
17 // The names of packages that once were loaded are remembered.
18 static garray_T		ga_loaded = {0, 0, sizeof(char_u *), 4, NULL};
19 #endif
20 
21 /*
22  * Initialize the execution stack.
23  */
24     void
25 estack_init(void)
26 {
27     estack_T *entry;
28 
29     if (ga_grow(&exestack, 10) == FAIL)
30 	mch_exit(0);
31     entry = ((estack_T *)exestack.ga_data) + exestack.ga_len;
32     entry->es_type = ETYPE_TOP;
33     entry->es_name = NULL;
34     entry->es_lnum = 0;
35 #ifdef FEAT_EVAL
36     entry->es_info.ufunc = NULL;
37 #endif
38     ++exestack.ga_len;
39 }
40 
41 /*
42  * Add an item to the execution stack.
43  * Returns the new entry or NULL when out of memory.
44  */
45     estack_T *
46 estack_push(etype_T type, char_u *name, long lnum)
47 {
48     estack_T *entry;
49 
50     // If memory allocation fails then we'll pop more than we push, eventually
51     // at the top level it will be OK again.
52     if (ga_grow(&exestack, 1) == OK)
53     {
54 	entry = ((estack_T *)exestack.ga_data) + exestack.ga_len;
55 	entry->es_type = type;
56 	entry->es_name = name;
57 	entry->es_lnum = lnum;
58 #ifdef FEAT_EVAL
59 	entry->es_info.ufunc = NULL;
60 #endif
61 	++exestack.ga_len;
62 	return entry;
63     }
64     return NULL;
65 }
66 
67 #if defined(FEAT_EVAL) || defined(PROTO)
68 /*
69  * Add a user function to the execution stack.
70  */
71     void
72 estack_push_ufunc(etype_T type, ufunc_T *ufunc, long lnum)
73 {
74     estack_T *entry = estack_push(type,
75 	    ufunc->uf_name_exp != NULL
76 				  ? ufunc->uf_name_exp : ufunc->uf_name, lnum);
77     if (entry != NULL)
78 	entry->es_info.ufunc = ufunc;
79 }
80 #endif
81 
82 /*
83  * Take an item off of the execution stack.
84  */
85     void
86 estack_pop(void)
87 {
88     if (exestack.ga_len > 1)
89 	--exestack.ga_len;
90 }
91 
92 /*
93  * Get the current value for <sfile> in allocated memory.
94  */
95     char_u *
96 estack_sfile(void)
97 {
98     estack_T	*entry;
99 #ifdef FEAT_EVAL
100     size_t	len;
101     int		idx;
102     char	*res;
103     size_t	done;
104 #endif
105 
106     entry = ((estack_T *)exestack.ga_data) + exestack.ga_len - 1;
107     if (entry->es_name == NULL)
108 	return NULL;
109 #ifdef FEAT_EVAL
110     if (entry->es_info.ufunc == NULL)
111 #endif
112 	return vim_strsave(entry->es_name);
113 
114 #ifdef FEAT_EVAL
115     // For a function we compose the call stack, as it was done in the past:
116     //   "function One[123]..Two[456]..Three"
117     len = STRLEN(entry->es_name) + 10;
118     for (idx = exestack.ga_len - 2; idx >= 0; --idx)
119     {
120 	entry = ((estack_T *)exestack.ga_data) + idx;
121 	if (entry->es_name == NULL || entry->es_info.ufunc == NULL)
122 	{
123 	    ++idx;
124 	    break;
125 	}
126 	len += STRLEN(entry->es_name) + 15;
127     }
128 
129     res = (char *)alloc((int)len);
130     if (res != NULL)
131     {
132 	STRCPY(res, "function ");
133 	while (idx < exestack.ga_len - 1)
134 	{
135 	    done = STRLEN(res);
136 	    entry = ((estack_T *)exestack.ga_data) + idx;
137 	    vim_snprintf(res + done, len - done, "%s[%ld]..",
138 					       entry->es_name, entry->es_lnum);
139 	    ++idx;
140 	}
141 	done = STRLEN(res);
142 	entry = ((estack_T *)exestack.ga_data) + idx;
143 	vim_snprintf(res + done, len - done, "%s", entry->es_name);
144     }
145     return (char_u *)res;
146 #endif
147 }
148 
149 /*
150  * ":runtime [what] {name}"
151  */
152     void
153 ex_runtime(exarg_T *eap)
154 {
155     char_u  *arg = eap->arg;
156     char_u  *p = skiptowhite(arg);
157     int	    len = (int)(p - arg);
158     int	    flags = eap->forceit ? DIP_ALL : 0;
159 
160     if (STRNCMP(arg, "START", len) == 0)
161     {
162 	flags += DIP_START + DIP_NORTP;
163 	arg = skipwhite(arg + len);
164     }
165     else if (STRNCMP(arg, "OPT", len) == 0)
166     {
167 	flags += DIP_OPT + DIP_NORTP;
168 	arg = skipwhite(arg + len);
169     }
170     else if (STRNCMP(arg, "PACK", len) == 0)
171     {
172 	flags += DIP_START + DIP_OPT + DIP_NORTP;
173 	arg = skipwhite(arg + len);
174     }
175     else if (STRNCMP(arg, "ALL", len) == 0)
176     {
177 	flags += DIP_START + DIP_OPT;
178 	arg = skipwhite(arg + len);
179     }
180 
181     source_runtime(arg, flags);
182 }
183 
184     static void
185 source_callback(char_u *fname, void *cookie UNUSED)
186 {
187     (void)do_source(fname, FALSE, DOSO_NONE);
188 }
189 
190 /*
191  * Find the file "name" in all directories in "path" and invoke
192  * "callback(fname, cookie)".
193  * "name" can contain wildcards.
194  * When "flags" has DIP_ALL: source all files, otherwise only the first one.
195  * When "flags" has DIP_DIR: find directories instead of files.
196  * When "flags" has DIP_ERR: give an error message if there is no match.
197  *
198  * return FAIL when no file could be sourced, OK otherwise.
199  */
200     int
201 do_in_path(
202     char_u	*path,
203     char_u	*name,
204     int		flags,
205     void	(*callback)(char_u *fname, void *ck),
206     void	*cookie)
207 {
208     char_u	*rtp;
209     char_u	*np;
210     char_u	*buf;
211     char_u	*rtp_copy;
212     char_u	*tail;
213     int		num_files;
214     char_u	**files;
215     int		i;
216     int		did_one = FALSE;
217 #ifdef AMIGA
218     struct Process	*proc = (struct Process *)FindTask(0L);
219     APTR		save_winptr = proc->pr_WindowPtr;
220 
221     // Avoid a requester here for a volume that doesn't exist.
222     proc->pr_WindowPtr = (APTR)-1L;
223 #endif
224 
225     // Make a copy of 'runtimepath'.  Invoking the callback may change the
226     // value.
227     rtp_copy = vim_strsave(path);
228     buf = alloc(MAXPATHL);
229     if (buf != NULL && rtp_copy != NULL)
230     {
231 	if (p_verbose > 1 && name != NULL)
232 	{
233 	    verbose_enter();
234 	    smsg(_("Searching for \"%s\" in \"%s\""),
235 						 (char *)name, (char *)path);
236 	    verbose_leave();
237 	}
238 
239 	// Loop over all entries in 'runtimepath'.
240 	rtp = rtp_copy;
241 	while (*rtp != NUL && ((flags & DIP_ALL) || !did_one))
242 	{
243 	    size_t buflen;
244 
245 	    // Copy the path from 'runtimepath' to buf[].
246 	    copy_option_part(&rtp, buf, MAXPATHL, ",");
247 	    buflen = STRLEN(buf);
248 
249 	    // Skip after or non-after directories.
250 	    if (flags & (DIP_NOAFTER | DIP_AFTER))
251 	    {
252 		int is_after = buflen >= 5
253 				     && STRCMP(buf + buflen - 5, "after") == 0;
254 
255 		if ((is_after && (flags & DIP_NOAFTER))
256 			|| (!is_after && (flags & DIP_AFTER)))
257 		    continue;
258 	    }
259 
260 	    if (name == NULL)
261 	    {
262 		(*callback)(buf, (void *) &cookie);
263 		if (!did_one)
264 		    did_one = (cookie == NULL);
265 	    }
266 	    else if (buflen + STRLEN(name) + 2 < MAXPATHL)
267 	    {
268 		add_pathsep(buf);
269 		tail = buf + STRLEN(buf);
270 
271 		// Loop over all patterns in "name"
272 		np = name;
273 		while (*np != NUL && ((flags & DIP_ALL) || !did_one))
274 		{
275 		    // Append the pattern from "name" to buf[].
276 		    copy_option_part(&np, tail, (int)(MAXPATHL - (tail - buf)),
277 								       "\t ");
278 
279 		    if (p_verbose > 2)
280 		    {
281 			verbose_enter();
282 			smsg(_("Searching for \"%s\""), buf);
283 			verbose_leave();
284 		    }
285 
286 		    // Expand wildcards, invoke the callback for each match.
287 		    if (gen_expand_wildcards(1, &buf, &num_files, &files,
288 				  (flags & DIP_DIR) ? EW_DIR : EW_FILE) == OK)
289 		    {
290 			for (i = 0; i < num_files; ++i)
291 			{
292 			    (*callback)(files[i], cookie);
293 			    did_one = TRUE;
294 			    if (!(flags & DIP_ALL))
295 				break;
296 			}
297 			FreeWild(num_files, files);
298 		    }
299 		}
300 	    }
301 	}
302     }
303     vim_free(buf);
304     vim_free(rtp_copy);
305     if (!did_one && name != NULL)
306     {
307 	char *basepath = path == p_rtp ? "runtimepath" : "packpath";
308 
309 	if (flags & DIP_ERR)
310 	    semsg(_(e_dirnotf), basepath, name);
311 	else if (p_verbose > 0)
312 	{
313 	    verbose_enter();
314 	    smsg(_("not found in '%s': \"%s\""), basepath, name);
315 	    verbose_leave();
316 	}
317     }
318 
319 #ifdef AMIGA
320     proc->pr_WindowPtr = save_winptr;
321 #endif
322 
323     return did_one ? OK : FAIL;
324 }
325 
326 /*
327  * Find "name" in "path".  When found, invoke the callback function for
328  * it: callback(fname, "cookie")
329  * When "flags" has DIP_ALL repeat for all matches, otherwise only the first
330  * one is used.
331  * Returns OK when at least one match found, FAIL otherwise.
332  *
333  * If "name" is NULL calls callback for each entry in "path". Cookie is
334  * passed by reference in this case, setting it to NULL indicates that callback
335  * has done its job.
336  */
337     static int
338 do_in_path_and_pp(
339     char_u	*path,
340     char_u	*name,
341     int		flags,
342     void	(*callback)(char_u *fname, void *ck),
343     void	*cookie)
344 {
345     int		done = FAIL;
346     char_u	*s;
347     int		len;
348     char	*start_dir = "pack/*/start/*/%s";
349     char	*opt_dir = "pack/*/opt/*/%s";
350 
351     if ((flags & DIP_NORTP) == 0)
352 	done = do_in_path(path, name, flags, callback, cookie);
353 
354     if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_START))
355     {
356 	len = (int)(STRLEN(start_dir) + STRLEN(name));
357 	s = alloc(len);
358 	if (s == NULL)
359 	    return FAIL;
360 	vim_snprintf((char *)s, len, start_dir, name);
361 	done = do_in_path(p_pp, s, flags, callback, cookie);
362 	vim_free(s);
363     }
364 
365     if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_OPT))
366     {
367 	len = (int)(STRLEN(opt_dir) + STRLEN(name));
368 	s = alloc(len);
369 	if (s == NULL)
370 	    return FAIL;
371 	vim_snprintf((char *)s, len, opt_dir, name);
372 	done = do_in_path(p_pp, s, flags, callback, cookie);
373 	vim_free(s);
374     }
375 
376     return done;
377 }
378 
379 /*
380  * Just like do_in_path_and_pp(), using 'runtimepath' for "path".
381  */
382     int
383 do_in_runtimepath(
384     char_u	*name,
385     int		flags,
386     void	(*callback)(char_u *fname, void *ck),
387     void	*cookie)
388 {
389     return do_in_path_and_pp(p_rtp, name, flags, callback, cookie);
390 }
391 
392 /*
393  * Source the file "name" from all directories in 'runtimepath'.
394  * "name" can contain wildcards.
395  * When "flags" has DIP_ALL: source all files, otherwise only the first one.
396  *
397  * return FAIL when no file could be sourced, OK otherwise.
398  */
399     int
400 source_runtime(char_u *name, int flags)
401 {
402     return source_in_path(p_rtp, name, flags);
403 }
404 
405 /*
406  * Just like source_runtime(), but use "path" instead of 'runtimepath'.
407  */
408     int
409 source_in_path(char_u *path, char_u *name, int flags)
410 {
411     return do_in_path_and_pp(path, name, flags, source_callback, NULL);
412 }
413 
414 
415 #if defined(FEAT_EVAL) || defined(PROTO)
416 
417 /*
418  * Expand wildcards in "pat" and invoke do_source() for each match.
419  */
420     static void
421 source_all_matches(char_u *pat)
422 {
423     int	    num_files;
424     char_u  **files;
425     int	    i;
426 
427     if (gen_expand_wildcards(1, &pat, &num_files, &files, EW_FILE) == OK)
428     {
429 	for (i = 0; i < num_files; ++i)
430 	    (void)do_source(files[i], FALSE, DOSO_NONE);
431 	FreeWild(num_files, files);
432     }
433 }
434 
435 /*
436  * Add the package directory to 'runtimepath'.
437  */
438     static int
439 add_pack_dir_to_rtp(char_u *fname)
440 {
441     char_u  *p4, *p3, *p2, *p1, *p;
442     char_u  *entry;
443     char_u  *insp = NULL;
444     int	    c;
445     char_u  *new_rtp;
446     int	    keep;
447     size_t  oldlen;
448     size_t  addlen;
449     size_t  new_rtp_len;
450     char_u  *afterdir = NULL;
451     size_t  afterlen = 0;
452     char_u  *after_insp = NULL;
453     char_u  *ffname = NULL;
454     size_t  fname_len;
455     char_u  *buf = NULL;
456     char_u  *rtp_ffname;
457     int	    match;
458     int	    retval = FAIL;
459 
460     p4 = p3 = p2 = p1 = get_past_head(fname);
461     for (p = p1; *p; MB_PTR_ADV(p))
462 	if (vim_ispathsep_nocolon(*p))
463 	{
464 	    p4 = p3; p3 = p2; p2 = p1; p1 = p;
465 	}
466 
467     // now we have:
468     // rtp/pack/name/start/name
469     //    p4   p3   p2    p1
470     //
471     // find the part up to "pack" in 'runtimepath'
472     c = *++p4; // append pathsep in order to expand symlink
473     *p4 = NUL;
474     ffname = fix_fname(fname);
475     *p4 = c;
476     if (ffname == NULL)
477 	return FAIL;
478 
479     // Find "ffname" in "p_rtp", ignoring '/' vs '\' differences.
480     // Also stop at the first "after" directory.
481     fname_len = STRLEN(ffname);
482     buf = alloc(MAXPATHL);
483     if (buf == NULL)
484 	goto theend;
485     for (entry = p_rtp; *entry != NUL; )
486     {
487 	char_u *cur_entry = entry;
488 
489 	copy_option_part(&entry, buf, MAXPATHL, ",");
490 	if (insp == NULL)
491 	{
492 	    add_pathsep(buf);
493 	    rtp_ffname = fix_fname(buf);
494 	    if (rtp_ffname == NULL)
495 		goto theend;
496 	    match = vim_fnamencmp(rtp_ffname, ffname, fname_len) == 0;
497 	    vim_free(rtp_ffname);
498 	    if (match)
499 		// Insert "ffname" after this entry (and comma).
500 		insp = entry;
501 	}
502 
503 	if ((p = (char_u *)strstr((char *)buf, "after")) != NULL
504 		&& p > buf
505 		&& vim_ispathsep(p[-1])
506 		&& (vim_ispathsep(p[5]) || p[5] == NUL || p[5] == ','))
507 	{
508 	    if (insp == NULL)
509 		// Did not find "ffname" before the first "after" directory,
510 		// insert it before this entry.
511 		insp = cur_entry;
512 	    after_insp = cur_entry;
513 	    break;
514 	}
515     }
516 
517     if (insp == NULL)
518 	// Both "fname" and "after" not found, append at the end.
519 	insp = p_rtp + STRLEN(p_rtp);
520 
521     // check if rtp/pack/name/start/name/after exists
522     afterdir = concat_fnames(fname, (char_u *)"after", TRUE);
523     if (afterdir != NULL && mch_isdir(afterdir))
524 	afterlen = STRLEN(afterdir) + 1; // add one for comma
525 
526     oldlen = STRLEN(p_rtp);
527     addlen = STRLEN(fname) + 1; // add one for comma
528     new_rtp = alloc(oldlen + addlen + afterlen + 1); // add one for NUL
529     if (new_rtp == NULL)
530 	goto theend;
531 
532     // We now have 'rtp' parts: {keep}{keep_after}{rest}.
533     // Create new_rtp, first: {keep},{fname}
534     keep = (int)(insp - p_rtp);
535     mch_memmove(new_rtp, p_rtp, keep);
536     new_rtp_len = keep;
537     if (*insp == NUL)
538 	new_rtp[new_rtp_len++] = ',';  // add comma before
539     mch_memmove(new_rtp + new_rtp_len, fname, addlen - 1);
540     new_rtp_len += addlen - 1;
541     if (*insp != NUL)
542 	new_rtp[new_rtp_len++] = ',';  // add comma after
543 
544     if (afterlen > 0 && after_insp != NULL)
545     {
546 	int keep_after = (int)(after_insp - p_rtp);
547 
548 	// Add to new_rtp: {keep},{fname}{keep_after},{afterdir}
549 	mch_memmove(new_rtp + new_rtp_len, p_rtp + keep,
550 							keep_after - keep);
551 	new_rtp_len += keep_after - keep;
552 	mch_memmove(new_rtp + new_rtp_len, afterdir, afterlen - 1);
553 	new_rtp_len += afterlen - 1;
554 	new_rtp[new_rtp_len++] = ',';
555 	keep = keep_after;
556     }
557 
558     if (p_rtp[keep] != NUL)
559 	// Append rest: {keep},{fname}{keep_after},{afterdir}{rest}
560 	mch_memmove(new_rtp + new_rtp_len, p_rtp + keep, oldlen - keep + 1);
561     else
562 	new_rtp[new_rtp_len] = NUL;
563 
564     if (afterlen > 0 && after_insp == NULL)
565     {
566 	// Append afterdir when "after" was not found:
567 	// {keep},{fname}{rest},{afterdir}
568 	STRCAT(new_rtp, ",");
569 	STRCAT(new_rtp, afterdir);
570     }
571 
572     set_option_value((char_u *)"rtp", 0L, new_rtp, 0);
573     vim_free(new_rtp);
574     retval = OK;
575 
576 theend:
577     vim_free(buf);
578     vim_free(ffname);
579     vim_free(afterdir);
580     return retval;
581 }
582 
583 /*
584  * Load scripts in "plugin" and "ftdetect" directories of the package.
585  */
586     static int
587 load_pack_plugin(char_u *fname)
588 {
589     static char *plugpat = "%s/plugin/**/*.vim";
590     static char *ftpat = "%s/ftdetect/*.vim";
591     int		len;
592     char_u	*ffname = fix_fname(fname);
593     char_u	*pat = NULL;
594     int		retval = FAIL;
595 
596     if (ffname == NULL)
597 	return FAIL;
598     len = (int)STRLEN(ffname) + (int)STRLEN(ftpat);
599     pat = alloc(len);
600     if (pat == NULL)
601 	goto theend;
602     vim_snprintf((char *)pat, len, plugpat, ffname);
603     source_all_matches(pat);
604 
605     {
606 	char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes");
607 
608 	// If runtime/filetype.vim wasn't loaded yet, the scripts will be
609 	// found when it loads.
610 	if (cmd != NULL && eval_to_number(cmd) > 0)
611 	{
612 	    do_cmdline_cmd((char_u *)"augroup filetypedetect");
613 	    vim_snprintf((char *)pat, len, ftpat, ffname);
614 	    source_all_matches(pat);
615 	    do_cmdline_cmd((char_u *)"augroup END");
616 	}
617 	vim_free(cmd);
618     }
619     vim_free(pat);
620     retval = OK;
621 
622 theend:
623     vim_free(ffname);
624     return retval;
625 }
626 
627 // used for "cookie" of add_pack_plugin()
628 static int APP_ADD_DIR;
629 static int APP_LOAD;
630 static int APP_BOTH;
631 
632     static void
633 add_pack_plugin(char_u *fname, void *cookie)
634 {
635     if (cookie != &APP_LOAD)
636     {
637 	char_u	*buf = alloc(MAXPATHL);
638 	char_u	*p;
639 	int	found = FALSE;
640 
641 	if (buf == NULL)
642 	    return;
643 	p = p_rtp;
644 	while (*p != NUL)
645 	{
646 	    copy_option_part(&p, buf, MAXPATHL, ",");
647 	    if (pathcmp((char *)buf, (char *)fname, -1) == 0)
648 	    {
649 		found = TRUE;
650 		break;
651 	    }
652 	}
653 	vim_free(buf);
654 	if (!found)
655 	    // directory is not yet in 'runtimepath', add it
656 	    if (add_pack_dir_to_rtp(fname) == FAIL)
657 		return;
658     }
659 
660     if (cookie != &APP_ADD_DIR)
661 	load_pack_plugin(fname);
662 }
663 
664 /*
665  * Add all packages in the "start" directory to 'runtimepath'.
666  */
667     void
668 add_pack_start_dirs(void)
669 {
670     do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
671 					       add_pack_plugin, &APP_ADD_DIR);
672 }
673 
674 /*
675  * Load plugins from all packages in the "start" directory.
676  */
677     void
678 load_start_packages(void)
679 {
680     did_source_packages = TRUE;
681     do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
682 						  add_pack_plugin, &APP_LOAD);
683 }
684 
685 /*
686  * ":packloadall"
687  * Find plugins in the package directories and source them.
688  */
689     void
690 ex_packloadall(exarg_T *eap)
691 {
692     if (!did_source_packages || eap->forceit)
693     {
694 	// First do a round to add all directories to 'runtimepath', then load
695 	// the plugins. This allows for plugins to use an autoload directory
696 	// of another plugin.
697 	add_pack_start_dirs();
698 	load_start_packages();
699     }
700 }
701 
702 /*
703  * ":packadd[!] {name}"
704  */
705     void
706 ex_packadd(exarg_T *eap)
707 {
708     static char *plugpat = "pack/*/%s/%s";
709     int		len;
710     char	*pat;
711     int		round;
712     int		res = OK;
713 
714     // Round 1: use "start", round 2: use "opt".
715     for (round = 1; round <= 2; ++round)
716     {
717 	// Only look under "start" when loading packages wasn't done yet.
718 	if (round == 1 && did_source_packages)
719 	    continue;
720 
721 	len = (int)STRLEN(plugpat) + (int)STRLEN(eap->arg) + 5;
722 	pat = alloc(len);
723 	if (pat == NULL)
724 	    return;
725 	vim_snprintf(pat, len, plugpat, round == 1 ? "start" : "opt", eap->arg);
726 	// The first round don't give a "not found" error, in the second round
727 	// only when nothing was found in the first round.
728 	res = do_in_path(p_pp, (char_u *)pat,
729 		DIP_ALL + DIP_DIR + (round == 2 && res == FAIL ? DIP_ERR : 0),
730 		add_pack_plugin, eap->forceit ? &APP_ADD_DIR : &APP_BOTH);
731 	vim_free(pat);
732     }
733 }
734 #endif
735 
736 /*
737  * Sort "gap" and remove duplicate entries.  "gap" is expected to contain a
738  * list of file names in allocated memory.
739  */
740     void
741 remove_duplicates(garray_T *gap)
742 {
743     int	    i;
744     int	    j;
745     char_u  **fnames = (char_u **)gap->ga_data;
746 
747     sort_strings(fnames, gap->ga_len);
748     for (i = gap->ga_len - 1; i > 0; --i)
749 	if (fnamecmp(fnames[i - 1], fnames[i]) == 0)
750 	{
751 	    vim_free(fnames[i]);
752 	    for (j = i + 1; j < gap->ga_len; ++j)
753 		fnames[j - 1] = fnames[j];
754 	    --gap->ga_len;
755 	}
756 }
757 
758 /*
759  * Expand color scheme, compiler or filetype names.
760  * Search from 'runtimepath':
761  *   'runtimepath'/{dirnames}/{pat}.vim
762  * When "flags" has DIP_START: search also from 'start' of 'packpath':
763  *   'packpath'/pack/ * /start/ * /{dirnames}/{pat}.vim
764  * When "flags" has DIP_OPT: search also from 'opt' of 'packpath':
765  *   'packpath'/pack/ * /opt/ * /{dirnames}/{pat}.vim
766  * "dirnames" is an array with one or more directory names.
767  */
768     int
769 ExpandRTDir(
770     char_u	*pat,
771     int		flags,
772     int		*num_file,
773     char_u	***file,
774     char	*dirnames[])
775 {
776     char_u	*s;
777     char_u	*e;
778     char_u	*match;
779     garray_T	ga;
780     int		i;
781     int		pat_len;
782 
783     *num_file = 0;
784     *file = NULL;
785     pat_len = (int)STRLEN(pat);
786     ga_init2(&ga, (int)sizeof(char *), 10);
787 
788     for (i = 0; dirnames[i] != NULL; ++i)
789     {
790 	s = alloc(STRLEN(dirnames[i]) + pat_len + 7);
791 	if (s == NULL)
792 	{
793 	    ga_clear_strings(&ga);
794 	    return FAIL;
795 	}
796 	sprintf((char *)s, "%s/%s*.vim", dirnames[i], pat);
797 	globpath(p_rtp, s, &ga, 0);
798 	vim_free(s);
799     }
800 
801     if (flags & DIP_START) {
802 	for (i = 0; dirnames[i] != NULL; ++i)
803 	{
804 	    s = alloc(STRLEN(dirnames[i]) + pat_len + 22);
805 	    if (s == NULL)
806 	    {
807 		ga_clear_strings(&ga);
808 		return FAIL;
809 	    }
810 	    sprintf((char *)s, "pack/*/start/*/%s/%s*.vim", dirnames[i], pat);
811 	    globpath(p_pp, s, &ga, 0);
812 	    vim_free(s);
813 	}
814     }
815 
816     if (flags & DIP_OPT) {
817 	for (i = 0; dirnames[i] != NULL; ++i)
818 	{
819 	    s = alloc(STRLEN(dirnames[i]) + pat_len + 20);
820 	    if (s == NULL)
821 	    {
822 		ga_clear_strings(&ga);
823 		return FAIL;
824 	    }
825 	    sprintf((char *)s, "pack/*/opt/*/%s/%s*.vim", dirnames[i], pat);
826 	    globpath(p_pp, s, &ga, 0);
827 	    vim_free(s);
828 	}
829     }
830 
831     for (i = 0; i < ga.ga_len; ++i)
832     {
833 	match = ((char_u **)ga.ga_data)[i];
834 	s = match;
835 	e = s + STRLEN(s);
836 	if (e - 4 > s && STRNICMP(e - 4, ".vim", 4) == 0)
837 	{
838 	    e -= 4;
839 	    for (s = e; s > match; MB_PTR_BACK(match, s))
840 		if (s < match || vim_ispathsep(*s))
841 		    break;
842 	    ++s;
843 	    *e = NUL;
844 	    mch_memmove(match, s, e - s + 1);
845 	}
846     }
847 
848     if (ga.ga_len == 0)
849 	return FAIL;
850 
851     // Sort and remove duplicates which can happen when specifying multiple
852     // directories in dirnames.
853     remove_duplicates(&ga);
854 
855     *file = ga.ga_data;
856     *num_file = ga.ga_len;
857     return OK;
858 }
859 
860 /*
861  * Expand loadplugin names:
862  * 'packpath'/pack/ * /opt/{pat}
863  */
864     int
865 ExpandPackAddDir(
866     char_u	*pat,
867     int		*num_file,
868     char_u	***file)
869 {
870     char_u	*s;
871     char_u	*e;
872     char_u	*match;
873     garray_T	ga;
874     int		i;
875     int		pat_len;
876 
877     *num_file = 0;
878     *file = NULL;
879     pat_len = (int)STRLEN(pat);
880     ga_init2(&ga, (int)sizeof(char *), 10);
881 
882     s = alloc(pat_len + 26);
883     if (s == NULL)
884     {
885 	ga_clear_strings(&ga);
886 	return FAIL;
887     }
888     sprintf((char *)s, "pack/*/opt/%s*", pat);
889     globpath(p_pp, s, &ga, 0);
890     vim_free(s);
891 
892     for (i = 0; i < ga.ga_len; ++i)
893     {
894 	match = ((char_u **)ga.ga_data)[i];
895 	s = gettail(match);
896 	e = s + STRLEN(s);
897 	mch_memmove(match, s, e - s + 1);
898     }
899 
900     if (ga.ga_len == 0)
901 	return FAIL;
902 
903     // Sort and remove duplicates which can happen when specifying multiple
904     // directories in dirnames.
905     remove_duplicates(&ga);
906 
907     *file = ga.ga_data;
908     *num_file = ga.ga_len;
909     return OK;
910 }
911 
912     static void
913 cmd_source(char_u *fname, exarg_T *eap)
914 {
915     if (*fname == NUL)
916 	emsg(_(e_argreq));
917 
918     else if (eap != NULL && eap->forceit)
919 	// ":source!": read Normal mode commands
920 	// Need to execute the commands directly.  This is required at least
921 	// for:
922 	// - ":g" command busy
923 	// - after ":argdo", ":windo" or ":bufdo"
924 	// - another command follows
925 	// - inside a loop
926 	openscript(fname, global_busy || listcmd_busy || eap->nextcmd != NULL
927 #ifdef FEAT_EVAL
928 						 || eap->cstack->cs_idx >= 0
929 #endif
930 						 );
931 
932     // ":source" read ex commands
933     else if (do_source(fname, FALSE, DOSO_NONE) == FAIL)
934 	semsg(_(e_notopen), fname);
935 }
936 
937 /*
938  * ":source {fname}"
939  */
940     void
941 ex_source(exarg_T *eap)
942 {
943 #ifdef FEAT_BROWSE
944     if (cmdmod.browse)
945     {
946 	char_u *fname = NULL;
947 
948 	fname = do_browse(0, (char_u *)_("Source Vim script"), eap->arg,
949 				      NULL, NULL,
950 				      (char_u *)_(BROWSE_FILTER_MACROS), NULL);
951 	if (fname != NULL)
952 	{
953 	    cmd_source(fname, eap);
954 	    vim_free(fname);
955 	}
956     }
957     else
958 #endif
959 	cmd_source(eap->arg, eap);
960 }
961 
962 #if defined(FEAT_EVAL) || defined(PROTO)
963 /*
964  * ":options"
965  */
966     void
967 ex_options(
968     exarg_T	*eap UNUSED)
969 {
970     vim_setenv((char_u *)"OPTWIN_CMD",
971 	    (char_u *)(cmdmod.tab ? "tab"
972 		: (cmdmod.split & WSP_VERT) ? "vert" : ""));
973     cmd_source((char_u *)SYS_OPTWIN_FILE, NULL);
974 }
975 #endif
976 
977 /*
978  * ":source" and associated commands.
979  */
980 /*
981  * Structure used to store info for each sourced file.
982  * It is shared between do_source() and getsourceline().
983  * This is required, because it needs to be handed to do_cmdline() and
984  * sourcing can be done recursively.
985  */
986 struct source_cookie
987 {
988     FILE	*fp;		// opened file for sourcing
989     char_u	*nextline;	// if not NULL: line that was read ahead
990     linenr_T	sourcing_lnum;	// line number of the source file
991     int		finished;	// ":finish" used
992 #ifdef USE_CRNL
993     int		fileformat;	// EOL_UNKNOWN, EOL_UNIX or EOL_DOS
994     int		error;		// TRUE if LF found after CR-LF
995 #endif
996 #ifdef FEAT_EVAL
997     linenr_T	breakpoint;	// next line with breakpoint or zero
998     char_u	*fname;		// name of sourced file
999     int		dbg_tick;	// debug_tick when breakpoint was set
1000     int		level;		// top nesting level of sourced file
1001 #endif
1002     vimconv_T	conv;		// type of conversion
1003 };
1004 
1005 #ifdef FEAT_EVAL
1006 /*
1007  * Return the address holding the next breakpoint line for a source cookie.
1008  */
1009     linenr_T *
1010 source_breakpoint(void *cookie)
1011 {
1012     return &((struct source_cookie *)cookie)->breakpoint;
1013 }
1014 
1015 /*
1016  * Return the address holding the debug tick for a source cookie.
1017  */
1018     int *
1019 source_dbg_tick(void *cookie)
1020 {
1021     return &((struct source_cookie *)cookie)->dbg_tick;
1022 }
1023 
1024 /*
1025  * Return the nesting level for a source cookie.
1026  */
1027     int
1028 source_level(void *cookie)
1029 {
1030     return ((struct source_cookie *)cookie)->level;
1031 }
1032 #endif
1033 
1034 #if (defined(MSWIN) && defined(FEAT_CSCOPE)) || defined(HAVE_FD_CLOEXEC)
1035 # define USE_FOPEN_NOINH
1036 /*
1037  * Special function to open a file without handle inheritance.
1038  * When possible the handle is closed on exec().
1039  */
1040     static FILE *
1041 fopen_noinh_readbin(char *filename)
1042 {
1043 # ifdef MSWIN
1044     int	fd_tmp = mch_open(filename, O_RDONLY | O_BINARY | O_NOINHERIT, 0);
1045 # else
1046     int	fd_tmp = mch_open(filename, O_RDONLY, 0);
1047 # endif
1048 
1049     if (fd_tmp == -1)
1050 	return NULL;
1051 
1052 # ifdef HAVE_FD_CLOEXEC
1053     {
1054 	int fdflags = fcntl(fd_tmp, F_GETFD);
1055 	if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
1056 	    (void)fcntl(fd_tmp, F_SETFD, fdflags | FD_CLOEXEC);
1057     }
1058 # endif
1059 
1060     return fdopen(fd_tmp, READBIN);
1061 }
1062 #endif
1063 
1064 /*
1065  * do_source: Read the file "fname" and execute its lines as EX commands.
1066  *
1067  * This function may be called recursively!
1068  *
1069  * return FAIL if file could not be opened, OK otherwise
1070  */
1071     int
1072 do_source(
1073     char_u	*fname,
1074     int		check_other,	    // check for .vimrc and _vimrc
1075     int		is_vimrc)	    // DOSO_ value
1076 {
1077     struct source_cookie    cookie;
1078     char_u		    *p;
1079     char_u		    *fname_exp;
1080     char_u		    *firstline = NULL;
1081     int			    retval = FAIL;
1082 #ifdef FEAT_EVAL
1083     sctx_T		    save_current_sctx;
1084     static scid_T	    last_current_SID = 0;
1085     static int		    last_current_SID_seq = 0;
1086     funccal_entry_T	    funccalp_entry;
1087     int			    save_debug_break_level = debug_break_level;
1088     scriptitem_T	    *si = NULL;
1089 # ifdef UNIX
1090     stat_T		    st;
1091     int			    stat_ok;
1092 # endif
1093 #endif
1094 #ifdef STARTUPTIME
1095     struct timeval	    tv_rel;
1096     struct timeval	    tv_start;
1097 #endif
1098 #ifdef FEAT_PROFILE
1099     proftime_T		    wait_start;
1100 #endif
1101     int			    trigger_source_post = FALSE;
1102     ESTACK_CHECK_DECLARATION
1103 
1104     p = expand_env_save(fname);
1105     if (p == NULL)
1106 	return retval;
1107     fname_exp = fix_fname(p);
1108     vim_free(p);
1109     if (fname_exp == NULL)
1110 	return retval;
1111     if (mch_isdir(fname_exp))
1112     {
1113 	smsg(_("Cannot source a directory: \"%s\""), fname);
1114 	goto theend;
1115     }
1116 
1117     // Apply SourceCmd autocommands, they should get the file and source it.
1118     if (has_autocmd(EVENT_SOURCECMD, fname_exp, NULL)
1119 	    && apply_autocmds(EVENT_SOURCECMD, fname_exp, fname_exp,
1120 							       FALSE, curbuf))
1121     {
1122 #ifdef FEAT_EVAL
1123 	retval = aborting() ? FAIL : OK;
1124 #else
1125 	retval = OK;
1126 #endif
1127 	if (retval == OK)
1128 	    // Apply SourcePost autocommands.
1129 	    apply_autocmds(EVENT_SOURCEPOST, fname_exp, fname_exp,
1130 								FALSE, curbuf);
1131 	goto theend;
1132     }
1133 
1134     // Apply SourcePre autocommands, they may get the file.
1135     apply_autocmds(EVENT_SOURCEPRE, fname_exp, fname_exp, FALSE, curbuf);
1136 
1137 #ifdef USE_FOPEN_NOINH
1138     cookie.fp = fopen_noinh_readbin((char *)fname_exp);
1139 #else
1140     cookie.fp = mch_fopen((char *)fname_exp, READBIN);
1141 #endif
1142     if (cookie.fp == NULL && check_other)
1143     {
1144 	// Try again, replacing file name ".vimrc" by "_vimrc" or vice versa,
1145 	// and ".exrc" by "_exrc" or vice versa.
1146 	p = gettail(fname_exp);
1147 	if ((*p == '.' || *p == '_')
1148 		&& (STRICMP(p + 1, "vimrc") == 0
1149 		    || STRICMP(p + 1, "gvimrc") == 0
1150 		    || STRICMP(p + 1, "exrc") == 0))
1151 	{
1152 	    if (*p == '_')
1153 		*p = '.';
1154 	    else
1155 		*p = '_';
1156 #ifdef USE_FOPEN_NOINH
1157 	    cookie.fp = fopen_noinh_readbin((char *)fname_exp);
1158 #else
1159 	    cookie.fp = mch_fopen((char *)fname_exp, READBIN);
1160 #endif
1161 	}
1162     }
1163 
1164     if (cookie.fp == NULL)
1165     {
1166 	if (p_verbose > 0)
1167 	{
1168 	    verbose_enter();
1169 	    if (SOURCING_NAME == NULL)
1170 		smsg(_("could not source \"%s\""), fname);
1171 	    else
1172 		smsg(_("line %ld: could not source \"%s\""),
1173 							SOURCING_LNUM, fname);
1174 	    verbose_leave();
1175 	}
1176 	goto theend;
1177     }
1178 
1179     // The file exists.
1180     // - In verbose mode, give a message.
1181     // - For a vimrc file, may want to set 'compatible', call vimrc_found().
1182     if (p_verbose > 1)
1183     {
1184 	verbose_enter();
1185 	if (SOURCING_NAME == NULL)
1186 	    smsg(_("sourcing \"%s\""), fname);
1187 	else
1188 	    smsg(_("line %ld: sourcing \"%s\""), SOURCING_LNUM, fname);
1189 	verbose_leave();
1190     }
1191     if (is_vimrc == DOSO_VIMRC)
1192 	vimrc_found(fname_exp, (char_u *)"MYVIMRC");
1193     else if (is_vimrc == DOSO_GVIMRC)
1194 	vimrc_found(fname_exp, (char_u *)"MYGVIMRC");
1195 
1196 #ifdef USE_CRNL
1197     // If no automatic file format: Set default to CR-NL.
1198     if (*p_ffs == NUL)
1199 	cookie.fileformat = EOL_DOS;
1200     else
1201 	cookie.fileformat = EOL_UNKNOWN;
1202     cookie.error = FALSE;
1203 #endif
1204 
1205     cookie.nextline = NULL;
1206     cookie.sourcing_lnum = 0;
1207     cookie.finished = FALSE;
1208 
1209 #ifdef FEAT_EVAL
1210     // Check if this script has a breakpoint.
1211     cookie.breakpoint = dbg_find_breakpoint(TRUE, fname_exp, (linenr_T)0);
1212     cookie.fname = fname_exp;
1213     cookie.dbg_tick = debug_tick;
1214 
1215     cookie.level = ex_nesting_level;
1216 #endif
1217 
1218     // Keep the sourcing name/lnum, for recursive calls.
1219     estack_push(ETYPE_SCRIPT, fname_exp, 0);
1220     ESTACK_CHECK_SETUP
1221 
1222 #ifdef STARTUPTIME
1223     if (time_fd != NULL)
1224 	time_push(&tv_rel, &tv_start);
1225 #endif
1226 
1227 #ifdef FEAT_EVAL
1228 # ifdef FEAT_PROFILE
1229     if (do_profiling == PROF_YES)
1230 	prof_child_enter(&wait_start);		// entering a child now
1231 # endif
1232 
1233     // Don't use local function variables, if called from a function.
1234     // Also starts profiling timer for nested script.
1235     save_funccal(&funccalp_entry);
1236 
1237     save_current_sctx = current_sctx;
1238     current_sctx.sc_lnum = 0;
1239     current_sctx.sc_version = 1;
1240 
1241     // Check if this script was sourced before to finds its SID.
1242     // If it's new, generate a new SID.
1243     // Always use a new sequence number.
1244     current_sctx.sc_seq = ++last_current_SID_seq;
1245 # ifdef UNIX
1246     stat_ok = (mch_stat((char *)fname_exp, &st) >= 0);
1247 # endif
1248     for (current_sctx.sc_sid = script_items.ga_len; current_sctx.sc_sid > 0;
1249 							 --current_sctx.sc_sid)
1250     {
1251 	si = &SCRIPT_ITEM(current_sctx.sc_sid);
1252 	if (si->sn_name != NULL
1253 		&& (
1254 # ifdef UNIX
1255 		    // Compare dev/ino when possible, it catches symbolic
1256 		    // links.  Also compare file names, the inode may change
1257 		    // when the file was edited.
1258 		    ((stat_ok && si->sn_dev_valid)
1259 			&& (si->sn_dev == st.st_dev
1260 			    && si->sn_ino == st.st_ino)) ||
1261 # endif
1262 		fnamecmp(si->sn_name, fname_exp) == 0))
1263 	    break;
1264     }
1265     if (current_sctx.sc_sid == 0)
1266     {
1267 	current_sctx.sc_sid = ++last_current_SID;
1268 	if (ga_grow(&script_items,
1269 		     (int)(current_sctx.sc_sid - script_items.ga_len)) == FAIL)
1270 	    goto almosttheend;
1271 	while (script_items.ga_len < current_sctx.sc_sid)
1272 	{
1273 	    ++script_items.ga_len;
1274 	    SCRIPT_ITEM(script_items.ga_len).sn_name = NULL;
1275 # ifdef FEAT_PROFILE
1276 	    SCRIPT_ITEM(script_items.ga_len).sn_prof_on = FALSE;
1277 # endif
1278 	}
1279 	si = &SCRIPT_ITEM(current_sctx.sc_sid);
1280 	si->sn_name = fname_exp;
1281 	fname_exp = vim_strsave(si->sn_name);  // used for autocmd
1282 # ifdef UNIX
1283 	if (stat_ok)
1284 	{
1285 	    si->sn_dev_valid = TRUE;
1286 	    si->sn_dev = st.st_dev;
1287 	    si->sn_ino = st.st_ino;
1288 	}
1289 	else
1290 	    si->sn_dev_valid = FALSE;
1291 # endif
1292 
1293 	// Allocate the local script variables to use for this script.
1294 	new_script_vars(current_sctx.sc_sid);
1295     }
1296 
1297 # ifdef FEAT_PROFILE
1298     if (do_profiling == PROF_YES)
1299     {
1300 	int	forceit;
1301 
1302 	// Check if we do profiling for this script.
1303 	if (!si->sn_prof_on && has_profiling(TRUE, si->sn_name, &forceit))
1304 	{
1305 	    script_do_profile(si);
1306 	    si->sn_pr_force = forceit;
1307 	}
1308 	if (si->sn_prof_on)
1309 	{
1310 	    ++si->sn_pr_count;
1311 	    profile_start(&si->sn_pr_start);
1312 	    profile_zero(&si->sn_pr_children);
1313 	}
1314     }
1315 # endif
1316 #endif
1317 
1318     cookie.conv.vc_type = CONV_NONE;		// no conversion
1319 
1320     // Read the first line so we can check for a UTF-8 BOM.
1321     firstline = getsourceline(0, (void *)&cookie, 0, TRUE);
1322     if (firstline != NULL && STRLEN(firstline) >= 3 && firstline[0] == 0xef
1323 			      && firstline[1] == 0xbb && firstline[2] == 0xbf)
1324     {
1325 	// Found BOM; setup conversion, skip over BOM and recode the line.
1326 	convert_setup(&cookie.conv, (char_u *)"utf-8", p_enc);
1327 	p = string_convert(&cookie.conv, firstline + 3, NULL);
1328 	if (p == NULL)
1329 	    p = vim_strsave(firstline + 3);
1330 	if (p != NULL)
1331 	{
1332 	    vim_free(firstline);
1333 	    firstline = p;
1334 	}
1335     }
1336 
1337     // Call do_cmdline, which will call getsourceline() to get the lines.
1338     do_cmdline(firstline, getsourceline, (void *)&cookie,
1339 				     DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_REPEAT);
1340     retval = OK;
1341 
1342 #ifdef FEAT_PROFILE
1343     if (do_profiling == PROF_YES)
1344     {
1345 	// Get "si" again, "script_items" may have been reallocated.
1346 	si = &SCRIPT_ITEM(current_sctx.sc_sid);
1347 	if (si->sn_prof_on)
1348 	{
1349 	    profile_end(&si->sn_pr_start);
1350 	    profile_sub_wait(&wait_start, &si->sn_pr_start);
1351 	    profile_add(&si->sn_pr_total, &si->sn_pr_start);
1352 	    profile_self(&si->sn_pr_self, &si->sn_pr_start,
1353 							 &si->sn_pr_children);
1354 	}
1355     }
1356 #endif
1357 
1358     if (got_int)
1359 	emsg(_(e_interr));
1360     ESTACK_CHECK_NOW
1361     estack_pop();
1362     if (p_verbose > 1)
1363     {
1364 	verbose_enter();
1365 	smsg(_("finished sourcing %s"), fname);
1366 	if (SOURCING_NAME != NULL)
1367 	    smsg(_("continuing in %s"), SOURCING_NAME);
1368 	verbose_leave();
1369     }
1370 #ifdef STARTUPTIME
1371     if (time_fd != NULL)
1372     {
1373 	vim_snprintf((char *)IObuff, IOSIZE, "sourcing %s", fname);
1374 	time_msg((char *)IObuff, &tv_start);
1375 	time_pop(&tv_rel);
1376     }
1377 #endif
1378 
1379     if (!got_int)
1380 	trigger_source_post = TRUE;
1381 
1382 #ifdef FEAT_EVAL
1383     // After a "finish" in debug mode, need to break at first command of next
1384     // sourced file.
1385     if (save_debug_break_level > ex_nesting_level
1386 	    && debug_break_level == ex_nesting_level)
1387 	++debug_break_level;
1388 #endif
1389 
1390 #ifdef FEAT_EVAL
1391 almosttheend:
1392     current_sctx = save_current_sctx;
1393     restore_funccal();
1394 # ifdef FEAT_PROFILE
1395     if (do_profiling == PROF_YES)
1396 	prof_child_exit(&wait_start);		// leaving a child now
1397 # endif
1398 #endif
1399     fclose(cookie.fp);
1400     vim_free(cookie.nextline);
1401     vim_free(firstline);
1402     convert_setup(&cookie.conv, NULL, NULL);
1403 
1404     if (trigger_source_post)
1405 	apply_autocmds(EVENT_SOURCEPOST, fname_exp, fname_exp, FALSE, curbuf);
1406 
1407 theend:
1408     vim_free(fname_exp);
1409     return retval;
1410 }
1411 
1412 #if defined(FEAT_EVAL) || defined(PROTO)
1413 
1414 /*
1415  * ":scriptnames"
1416  */
1417     void
1418 ex_scriptnames(exarg_T *eap)
1419 {
1420     int i;
1421 
1422     if (eap->addr_count > 0)
1423     {
1424 	// :script {scriptId}: edit the script
1425 	if (eap->line2 < 1 || eap->line2 > script_items.ga_len)
1426 	    emsg(_(e_invarg));
1427 	else
1428 	{
1429 	    eap->arg = SCRIPT_ITEM(eap->line2).sn_name;
1430 	    do_exedit(eap, NULL);
1431 	}
1432 	return;
1433     }
1434 
1435     for (i = 1; i <= script_items.ga_len && !got_int; ++i)
1436 	if (SCRIPT_ITEM(i).sn_name != NULL)
1437 	{
1438 	    home_replace(NULL, SCRIPT_ITEM(i).sn_name,
1439 						    NameBuff, MAXPATHL, TRUE);
1440 	    smsg("%3d: %s", i, NameBuff);
1441 	}
1442 }
1443 
1444 # if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
1445 /*
1446  * Fix slashes in the list of script names for 'shellslash'.
1447  */
1448     void
1449 scriptnames_slash_adjust(void)
1450 {
1451     int i;
1452 
1453     for (i = 1; i <= script_items.ga_len; ++i)
1454 	if (SCRIPT_ITEM(i).sn_name != NULL)
1455 	    slash_adjust(SCRIPT_ITEM(i).sn_name);
1456 }
1457 # endif
1458 
1459 /*
1460  * Get a pointer to a script name.  Used for ":verbose set".
1461  */
1462     char_u *
1463 get_scriptname(scid_T id)
1464 {
1465     if (id == SID_MODELINE)
1466 	return (char_u *)_("modeline");
1467     if (id == SID_CMDARG)
1468 	return (char_u *)_("--cmd argument");
1469     if (id == SID_CARG)
1470 	return (char_u *)_("-c argument");
1471     if (id == SID_ENV)
1472 	return (char_u *)_("environment variable");
1473     if (id == SID_ERROR)
1474 	return (char_u *)_("error handler");
1475     return SCRIPT_ITEM(id).sn_name;
1476 }
1477 
1478 # if defined(EXITFREE) || defined(PROTO)
1479     void
1480 free_scriptnames(void)
1481 {
1482     int			i;
1483 
1484     for (i = script_items.ga_len; i > 0; --i)
1485     {
1486 	vim_free(SCRIPT_ITEM(i).sn_name);
1487 #  ifdef FEAT_PROFILE
1488 	ga_clear(&SCRIPT_ITEM(i).sn_prl_ga);
1489 #  endif
1490     }
1491     ga_clear(&script_items);
1492 }
1493 
1494     void
1495 free_autoload_scriptnames(void)
1496 {
1497     ga_clear_strings(&ga_loaded);
1498 }
1499 # endif
1500 
1501 #endif
1502 
1503     linenr_T
1504 get_sourced_lnum(char_u *(*fgetline)(int, void *, int, int), void *cookie)
1505 {
1506     return fgetline == getsourceline
1507 			? ((struct source_cookie *)cookie)->sourcing_lnum
1508 			: SOURCING_LNUM;
1509 }
1510 
1511     static char_u *
1512 get_one_sourceline(struct source_cookie *sp)
1513 {
1514     garray_T		ga;
1515     int			len;
1516     int			c;
1517     char_u		*buf;
1518 #ifdef USE_CRNL
1519     int			has_cr;		// CR-LF found
1520 #endif
1521     int			have_read = FALSE;
1522 
1523     // use a growarray to store the sourced line
1524     ga_init2(&ga, 1, 250);
1525 
1526     // Loop until there is a finished line (or end-of-file).
1527     ++sp->sourcing_lnum;
1528     for (;;)
1529     {
1530 	// make room to read at least 120 (more) characters
1531 	if (ga_grow(&ga, 120) == FAIL)
1532 	    break;
1533 	buf = (char_u *)ga.ga_data;
1534 
1535 	if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
1536 							      sp->fp) == NULL)
1537 	    break;
1538 	len = ga.ga_len + (int)STRLEN(buf + ga.ga_len);
1539 #ifdef USE_CRNL
1540 	// Ignore a trailing CTRL-Z, when in Dos mode.	Only recognize the
1541 	// CTRL-Z by its own, or after a NL.
1542 	if (	   (len == 1 || (len >= 2 && buf[len - 2] == '\n'))
1543 		&& sp->fileformat == EOL_DOS
1544 		&& buf[len - 1] == Ctrl_Z)
1545 	{
1546 	    buf[len - 1] = NUL;
1547 	    break;
1548 	}
1549 #endif
1550 
1551 	have_read = TRUE;
1552 	ga.ga_len = len;
1553 
1554 	// If the line was longer than the buffer, read more.
1555 	if (ga.ga_maxlen - ga.ga_len == 1 && buf[len - 1] != '\n')
1556 	    continue;
1557 
1558 	if (len >= 1 && buf[len - 1] == '\n')	// remove trailing NL
1559 	{
1560 #ifdef USE_CRNL
1561 	    has_cr = (len >= 2 && buf[len - 2] == '\r');
1562 	    if (sp->fileformat == EOL_UNKNOWN)
1563 	    {
1564 		if (has_cr)
1565 		    sp->fileformat = EOL_DOS;
1566 		else
1567 		    sp->fileformat = EOL_UNIX;
1568 	    }
1569 
1570 	    if (sp->fileformat == EOL_DOS)
1571 	    {
1572 		if (has_cr)	    // replace trailing CR
1573 		{
1574 		    buf[len - 2] = '\n';
1575 		    --len;
1576 		    --ga.ga_len;
1577 		}
1578 		else	    // lines like ":map xx yy^M" will have failed
1579 		{
1580 		    if (!sp->error)
1581 		    {
1582 			msg_source(HL_ATTR(HLF_W));
1583 			emsg(_("W15: Warning: Wrong line separator, ^M may be missing"));
1584 		    }
1585 		    sp->error = TRUE;
1586 		    sp->fileformat = EOL_UNIX;
1587 		}
1588 	    }
1589 #endif
1590 	    // The '\n' is escaped if there is an odd number of ^V's just
1591 	    // before it, first set "c" just before the 'V's and then check
1592 	    // len&c parities (is faster than ((len-c)%2 == 0)) -- Acevedo
1593 	    for (c = len - 2; c >= 0 && buf[c] == Ctrl_V; c--)
1594 		;
1595 	    if ((len & 1) != (c & 1))	// escaped NL, read more
1596 	    {
1597 		++sp->sourcing_lnum;
1598 		continue;
1599 	    }
1600 
1601 	    buf[len - 1] = NUL;		// remove the NL
1602 	}
1603 
1604 	// Check for ^C here now and then, so recursive :so can be broken.
1605 	line_breakcheck();
1606 	break;
1607     }
1608 
1609     if (have_read)
1610 	return (char_u *)ga.ga_data;
1611 
1612     vim_free(ga.ga_data);
1613     return NULL;
1614 }
1615 
1616 /*
1617  * Get one full line from a sourced file.
1618  * Called by do_cmdline() when it's called from do_source().
1619  *
1620  * Return a pointer to the line in allocated memory.
1621  * Return NULL for end-of-file or some error.
1622  */
1623     char_u *
1624 getsourceline(int c UNUSED, void *cookie, int indent UNUSED, int do_concat)
1625 {
1626     struct source_cookie *sp = (struct source_cookie *)cookie;
1627     char_u		*line;
1628     char_u		*p;
1629 
1630 #ifdef FEAT_EVAL
1631     // If breakpoints have been added/deleted need to check for it.
1632     if (sp->dbg_tick < debug_tick)
1633     {
1634 	sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, SOURCING_LNUM);
1635 	sp->dbg_tick = debug_tick;
1636     }
1637 # ifdef FEAT_PROFILE
1638     if (do_profiling == PROF_YES)
1639 	script_line_end();
1640 # endif
1641 #endif
1642 
1643     // Set the current sourcing line number.
1644     SOURCING_LNUM = sp->sourcing_lnum + 1;
1645 
1646     // Get current line.  If there is a read-ahead line, use it, otherwise get
1647     // one now.
1648     if (sp->finished)
1649 	line = NULL;
1650     else if (sp->nextline == NULL)
1651 	line = get_one_sourceline(sp);
1652     else
1653     {
1654 	line = sp->nextline;
1655 	sp->nextline = NULL;
1656 	++sp->sourcing_lnum;
1657     }
1658 #ifdef FEAT_PROFILE
1659     if (line != NULL && do_profiling == PROF_YES)
1660 	script_line_start();
1661 #endif
1662 
1663     // Only concatenate lines starting with a \ when 'cpoptions' doesn't
1664     // contain the 'C' flag.
1665     if (line != NULL && do_concat && vim_strchr(p_cpo, CPO_CONCAT) == NULL)
1666     {
1667 	// compensate for the one line read-ahead
1668 	--sp->sourcing_lnum;
1669 
1670 	// Get the next line and concatenate it when it starts with a
1671 	// backslash. We always need to read the next line, keep it in
1672 	// sp->nextline.
1673 	/* Also check for a comment in between continuation lines: "\ */
1674 	sp->nextline = get_one_sourceline(sp);
1675 	if (sp->nextline != NULL
1676 		&& (*(p = skipwhite(sp->nextline)) == '\\'
1677 			      || (p[0] == '"' && p[1] == '\\' && p[2] == ' ')))
1678 	{
1679 	    garray_T    ga;
1680 
1681 	    ga_init2(&ga, (int)sizeof(char_u), 400);
1682 	    ga_concat(&ga, line);
1683 	    if (*p == '\\')
1684 		ga_concat(&ga, p + 1);
1685 	    for (;;)
1686 	    {
1687 		vim_free(sp->nextline);
1688 		sp->nextline = get_one_sourceline(sp);
1689 		if (sp->nextline == NULL)
1690 		    break;
1691 		p = skipwhite(sp->nextline);
1692 		if (*p == '\\')
1693 		{
1694 		    // Adjust the growsize to the current length to speed up
1695 		    // concatenating many lines.
1696 		    if (ga.ga_len > 400)
1697 		    {
1698 			if (ga.ga_len > 8000)
1699 			    ga.ga_growsize = 8000;
1700 			else
1701 			    ga.ga_growsize = ga.ga_len;
1702 		    }
1703 		    ga_concat(&ga, p + 1);
1704 		}
1705 		else if (p[0] != '"' || p[1] != '\\' || p[2] != ' ')
1706 		    break;
1707 	    }
1708 	    ga_append(&ga, NUL);
1709 	    vim_free(line);
1710 	    line = ga.ga_data;
1711 	}
1712     }
1713 
1714     if (line != NULL && sp->conv.vc_type != CONV_NONE)
1715     {
1716 	char_u	*s;
1717 
1718 	// Convert the encoding of the script line.
1719 	s = string_convert(&sp->conv, line, NULL);
1720 	if (s != NULL)
1721 	{
1722 	    vim_free(line);
1723 	    line = s;
1724 	}
1725     }
1726 
1727 #ifdef FEAT_EVAL
1728     // Did we encounter a breakpoint?
1729     if (sp->breakpoint != 0 && sp->breakpoint <= SOURCING_LNUM)
1730     {
1731 	dbg_breakpoint(sp->fname, SOURCING_LNUM);
1732 	// Find next breakpoint.
1733 	sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, SOURCING_LNUM);
1734 	sp->dbg_tick = debug_tick;
1735     }
1736 #endif
1737 
1738     return line;
1739 }
1740 
1741 /*
1742  * ":scriptencoding": Set encoding conversion for a sourced script.
1743  */
1744     void
1745 ex_scriptencoding(exarg_T *eap)
1746 {
1747     struct source_cookie	*sp;
1748     char_u			*name;
1749 
1750     if (!getline_equal(eap->getline, eap->cookie, getsourceline))
1751     {
1752 	emsg(_("E167: :scriptencoding used outside of a sourced file"));
1753 	return;
1754     }
1755 
1756     if (*eap->arg != NUL)
1757     {
1758 	name = enc_canonize(eap->arg);
1759 	if (name == NULL)	// out of memory
1760 	    return;
1761     }
1762     else
1763 	name = eap->arg;
1764 
1765     // Setup for conversion from the specified encoding to 'encoding'.
1766     sp = (struct source_cookie *)getline_cookie(eap->getline, eap->cookie);
1767     convert_setup(&sp->conv, name, p_enc);
1768 
1769     if (name != eap->arg)
1770 	vim_free(name);
1771 }
1772 
1773 /*
1774  * ":scriptversion": Set Vim script version for a sourced script.
1775  */
1776     void
1777 ex_scriptversion(exarg_T *eap UNUSED)
1778 {
1779 #ifdef FEAT_EVAL
1780     int		nr;
1781 
1782     if (!getline_equal(eap->getline, eap->cookie, getsourceline))
1783     {
1784 	emsg(_("E984: :scriptversion used outside of a sourced file"));
1785 	return;
1786     }
1787 
1788     nr = getdigits(&eap->arg);
1789     if (nr == 0 || *eap->arg != NUL)
1790 	emsg(_(e_invarg));
1791     else if (nr > 4)
1792 	semsg(_("E999: scriptversion not supported: %d"), nr);
1793     else
1794 	current_sctx.sc_version = nr;
1795 #endif
1796 }
1797 
1798 #if defined(FEAT_EVAL) || defined(PROTO)
1799 /*
1800  * ":finish": Mark a sourced file as finished.
1801  */
1802     void
1803 ex_finish(exarg_T *eap)
1804 {
1805     if (getline_equal(eap->getline, eap->cookie, getsourceline))
1806 	do_finish(eap, FALSE);
1807     else
1808 	emsg(_("E168: :finish used outside of a sourced file"));
1809 }
1810 
1811 /*
1812  * Mark a sourced file as finished.  Possibly makes the ":finish" pending.
1813  * Also called for a pending finish at the ":endtry" or after returning from
1814  * an extra do_cmdline().  "reanimate" is used in the latter case.
1815  */
1816     void
1817 do_finish(exarg_T *eap, int reanimate)
1818 {
1819     int		idx;
1820 
1821     if (reanimate)
1822 	((struct source_cookie *)getline_cookie(eap->getline,
1823 					      eap->cookie))->finished = FALSE;
1824 
1825     // Cleanup (and inactivate) conditionals, but stop when a try conditional
1826     // not in its finally clause (which then is to be executed next) is found.
1827     // In this case, make the ":finish" pending for execution at the ":endtry".
1828     // Otherwise, finish normally.
1829     idx = cleanup_conditionals(eap->cstack, 0, TRUE);
1830     if (idx >= 0)
1831     {
1832 	eap->cstack->cs_pending[idx] = CSTP_FINISH;
1833 	report_make_pending(CSTP_FINISH, NULL);
1834     }
1835     else
1836 	((struct source_cookie *)getline_cookie(eap->getline,
1837 					       eap->cookie))->finished = TRUE;
1838 }
1839 
1840 
1841 /*
1842  * Return TRUE when a sourced file had the ":finish" command: Don't give error
1843  * message for missing ":endif".
1844  * Return FALSE when not sourcing a file.
1845  */
1846     int
1847 source_finished(
1848     char_u	*(*fgetline)(int, void *, int, int),
1849     void	*cookie)
1850 {
1851     return (getline_equal(fgetline, cookie, getsourceline)
1852 	    && ((struct source_cookie *)getline_cookie(
1853 						fgetline, cookie))->finished);
1854 }
1855 
1856 /*
1857  * Return the autoload script name for a function or variable name.
1858  * Returns NULL when out of memory.
1859  * Caller must make sure that "name" contains AUTOLOAD_CHAR.
1860  */
1861     char_u *
1862 autoload_name(char_u *name)
1863 {
1864     char_u	*p, *q = NULL;
1865     char_u	*scriptname;
1866 
1867     // Get the script file name: replace '#' with '/', append ".vim".
1868     scriptname = alloc(STRLEN(name) + 14);
1869     if (scriptname == NULL)
1870 	return NULL;
1871     STRCPY(scriptname, "autoload/");
1872     STRCAT(scriptname, name);
1873     for (p = scriptname + 9; (p = vim_strchr(p, AUTOLOAD_CHAR)) != NULL;
1874 								    q = p, ++p)
1875 	*p = '/';
1876     STRCPY(q, ".vim");
1877     return scriptname;
1878 }
1879 
1880 /*
1881  * If "name" has a package name try autoloading the script for it.
1882  * Return TRUE if a package was loaded.
1883  */
1884     int
1885 script_autoload(
1886     char_u	*name,
1887     int		reload)	    // load script again when already loaded
1888 {
1889     char_u	*p;
1890     char_u	*scriptname, *tofree;
1891     int		ret = FALSE;
1892     int		i;
1893 
1894     // If there is no '#' after name[0] there is no package name.
1895     p = vim_strchr(name, AUTOLOAD_CHAR);
1896     if (p == NULL || p == name)
1897 	return FALSE;
1898 
1899     tofree = scriptname = autoload_name(name);
1900     if (scriptname == NULL)
1901 	return FALSE;
1902 
1903     // Find the name in the list of previously loaded package names.  Skip
1904     // "autoload/", it's always the same.
1905     for (i = 0; i < ga_loaded.ga_len; ++i)
1906 	if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
1907 	    break;
1908     if (!reload && i < ga_loaded.ga_len)
1909 	ret = FALSE;	    // was loaded already
1910     else
1911     {
1912 	// Remember the name if it wasn't loaded already.
1913 	if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
1914 	{
1915 	    ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
1916 	    tofree = NULL;
1917 	}
1918 
1919 	// Try loading the package from $VIMRUNTIME/autoload/<name>.vim
1920 	if (source_runtime(scriptname, 0) == OK)
1921 	    ret = TRUE;
1922     }
1923 
1924     vim_free(tofree);
1925     return ret;
1926 }
1927 #endif
1928