Mercurial > vim
view src/scriptfile.c @ 29756:2acb87ee55fc
Update runtime files
Commit: https://github.com/vim/vim/commit/e1f3fd1d02e3f5fe6d2b6d82687c6846b8e500f8
Author: Bram Moolenaar <Bram@vim.org>
Date: Mon Aug 15 18:51:32 2022 +0100
Update runtime files
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Mon, 15 Aug 2022 20:00:05 +0200 |
parents | 32f358d71ec2 |
children | bc6cf208b1b4 |
line wrap: on
line source
/* vi:set ts=8 sts=4 sw=4 noet: * * VIM - Vi IMproved by Bram Moolenaar * * Do ":help uganda" in Vim to read copying and usage conditions. * Do ":help credits" in Vim to see a list of people who contributed. * See README.txt for an overview of the Vim source code. */ /* * scriptfile.c: functions for dealing with the runtime directories/files */ #include "vim.h" #if defined(FEAT_EVAL) || defined(PROTO) // The names of packages that once were loaded are remembered. static garray_T ga_loaded = {0, 0, sizeof(char_u *), 4, NULL}; #endif // last used sequence number for sourcing scripts (current_sctx.sc_seq) #ifdef FEAT_EVAL static int last_current_SID_seq = 0; #endif static int do_source_ext(char_u *fname, int check_other, int is_vimrc, int *ret_sid, exarg_T *eap, int clearvars); /* * Initialize the execution stack. */ void estack_init(void) { estack_T *entry; if (ga_grow(&exestack, 10) == FAIL) mch_exit(0); entry = ((estack_T *)exestack.ga_data) + exestack.ga_len; entry->es_type = ETYPE_TOP; entry->es_name = NULL; entry->es_lnum = 0; #ifdef FEAT_EVAL entry->es_info.ufunc = NULL; #endif ++exestack.ga_len; } /* * Add an item to the execution stack. * Returns the new entry or NULL when out of memory. */ estack_T * estack_push(etype_T type, char_u *name, long lnum) { estack_T *entry; // If memory allocation fails then we'll pop more than we push, eventually // at the top level it will be OK again. if (ga_grow(&exestack, 1) == OK) { entry = ((estack_T *)exestack.ga_data) + exestack.ga_len; entry->es_type = type; entry->es_name = name; entry->es_lnum = lnum; #ifdef FEAT_EVAL entry->es_info.ufunc = NULL; #endif ++exestack.ga_len; return entry; } return NULL; } #if defined(FEAT_EVAL) || defined(PROTO) /* * Add a user function to the execution stack. */ estack_T * estack_push_ufunc(ufunc_T *ufunc, long lnum) { estack_T *entry = estack_push(ETYPE_UFUNC, ufunc->uf_name_exp != NULL ? ufunc->uf_name_exp : ufunc->uf_name, lnum); if (entry != NULL) entry->es_info.ufunc = ufunc; return entry; } /* * Return TRUE if "ufunc" with "lnum" is already at the top of the exe stack. */ int estack_top_is_ufunc(ufunc_T *ufunc, long lnum) { estack_T *entry; if (exestack.ga_len == 0) return FALSE; entry = ((estack_T *)exestack.ga_data) + exestack.ga_len - 1; return entry->es_type == ETYPE_UFUNC && STRCMP( entry->es_name, ufunc->uf_name_exp != NULL ? ufunc->uf_name_exp : ufunc->uf_name) == 0 && entry->es_lnum == lnum; } #endif /* * Take an item off of the execution stack and return it. */ estack_T * estack_pop(void) { if (exestack.ga_len == 0) return NULL; --exestack.ga_len; return ((estack_T *)exestack.ga_data) + exestack.ga_len; } /* * Get the current value for "which" in allocated memory. * "which" is ESTACK_SFILE for <sfile>, ESTACK_STACK for <stack> or * ESTACK_SCRIPT for <script>. */ char_u * estack_sfile(estack_arg_T which UNUSED) { estack_T *entry; #ifdef FEAT_EVAL garray_T ga; size_t len; int idx; etype_T last_type = ETYPE_SCRIPT; char *type_name; #endif entry = ((estack_T *)exestack.ga_data) + exestack.ga_len - 1; #ifdef FEAT_EVAL if (which == ESTACK_SFILE && entry->es_type != ETYPE_UFUNC) #endif { if (entry->es_name == NULL) return NULL; return vim_strsave(entry->es_name); } #ifdef FEAT_EVAL // expand('<sfile>') works in a function for backwards compatibility, but // may give an unexpected result. Disallow it in Vim 9 script. if (which == ESTACK_SFILE && in_vim9script()) { int save_emsg_off = emsg_off; if (emsg_off == 1) // f_expand() silences errors but we do want this one emsg_off = 0; emsg(_(e_cannot_expand_sfile_in_vim9_function)); emsg_off = save_emsg_off; return NULL; } // If evaluated in a function or autocommand, return the path of the script // where it is defined, at script level the current script path is returned // instead. if (which == ESTACK_SCRIPT) { entry = ((estack_T *)exestack.ga_data) + exestack.ga_len - 1; // Walk the stack backwards, starting from the current frame. for (idx = exestack.ga_len - 1; idx >= 0; --idx, --entry) { if (entry->es_type == ETYPE_UFUNC) { sctx_T *def_ctx = &entry->es_info.ufunc->uf_script_ctx; if (def_ctx->sc_sid > 0) return vim_strsave(SCRIPT_ITEM(def_ctx->sc_sid)->sn_name); else return NULL; } else if (entry->es_type == ETYPE_AUCMD) { sctx_T *def_ctx = acp_script_ctx(entry->es_info.aucmd); if (def_ctx->sc_sid > 0) return vim_strsave(SCRIPT_ITEM(def_ctx->sc_sid)->sn_name); else return NULL; } else if (entry->es_type == ETYPE_SCRIPT) { return vim_strsave(entry->es_name); } } return NULL; } // Give information about each stack entry up to the root. // For a function we compose the call stack, as it was done in the past: // "function One[123]..Two[456]..Three" ga_init2(&ga, sizeof(char), 100); for (idx = 0; idx < exestack.ga_len; ++idx) { entry = ((estack_T *)exestack.ga_data) + idx; if (entry->es_name != NULL) { long lnum = 0; char *dots; len = STRLEN(entry->es_name) + 15; type_name = ""; if (entry->es_type != last_type) { switch (entry->es_type) { case ETYPE_SCRIPT: type_name = "script "; break; case ETYPE_UFUNC: type_name = "function "; break; default: type_name = ""; break; } last_type = entry->es_type; } len += STRLEN(type_name); if (ga_grow(&ga, (int)len) == FAIL) break; if (idx == exestack.ga_len - 1) lnum = which == ESTACK_STACK ? SOURCING_LNUM : 0; else lnum = entry->es_lnum; dots = idx == exestack.ga_len - 1 ? "" : ".."; if (lnum == 0) // For the bottom entry of <sfile>: do not add the line number, // it is used in <slnum>. Also leave it out when the number is // not set. vim_snprintf((char *)ga.ga_data + ga.ga_len, len, "%s%s%s", type_name, entry->es_name, dots); else vim_snprintf((char *)ga.ga_data + ga.ga_len, len, "%s%s[%ld]%s", type_name, entry->es_name, lnum, dots); ga.ga_len += (int)STRLEN((char *)ga.ga_data + ga.ga_len); } } return (char_u *)ga.ga_data; #endif } /* * ":runtime [what] {name}" */ void ex_runtime(exarg_T *eap) { char_u *arg = eap->arg; char_u *p = skiptowhite(arg); int len = (int)(p - arg); int flags = eap->forceit ? DIP_ALL : 0; if (STRNCMP(arg, "START", len) == 0) { flags += DIP_START + DIP_NORTP; arg = skipwhite(arg + len); } else if (STRNCMP(arg, "OPT", len) == 0) { flags += DIP_OPT + DIP_NORTP; arg = skipwhite(arg + len); } else if (STRNCMP(arg, "PACK", len) == 0) { flags += DIP_START + DIP_OPT + DIP_NORTP; arg = skipwhite(arg + len); } else if (STRNCMP(arg, "ALL", len) == 0) { flags += DIP_START + DIP_OPT; arg = skipwhite(arg + len); } source_runtime(arg, flags); } static void source_callback(char_u *fname, void *cookie) { (void)do_source(fname, FALSE, DOSO_NONE, cookie); } #ifdef FEAT_EVAL /* * Find an already loaded script "name". * If found returns its script ID. If not found returns -1. */ int find_script_by_name(char_u *name) { int sid; scriptitem_T *si; for (sid = script_items.ga_len; sid > 0; --sid) { // We used to check inode here, but that doesn't work: // - If a script is edited and written, it may get a different // inode number, even though to the user it is the same script. // - If a script is deleted and another script is written, with a // different name, the inode may be re-used. si = SCRIPT_ITEM(sid); if (si->sn_name != NULL && fnamecmp(si->sn_name, name) == 0) return sid; } return -1; } /* * Add a new scriptitem with all items initialized. * When running out of memory "error" is set to FAIL. * Returns the script ID. */ static int get_new_scriptitem(int *error) { static scid_T last_current_SID = 0; int sid = ++last_current_SID; scriptitem_T *si = NULL; if (ga_grow(&script_items, (int)(sid - script_items.ga_len)) == FAIL) { *error = FAIL; return sid; } while (script_items.ga_len < sid) { si = ALLOC_CLEAR_ONE(scriptitem_T); if (si == NULL) { *error = FAIL; return sid; } ++script_items.ga_len; SCRIPT_ITEM(script_items.ga_len) = si; si->sn_name = NULL; si->sn_version = 1; // Allocate the local script variables to use for this script. new_script_vars(script_items.ga_len); ga_init2(&si->sn_var_vals, sizeof(svar_T), 10); hash_init(&si->sn_all_vars.dv_hashtab); ga_init2(&si->sn_imports, sizeof(imported_T), 10); ga_init2(&si->sn_type_list, sizeof(type_T), 10); # ifdef FEAT_PROFILE si->sn_prof_on = FALSE; # endif } // "si" can't be NULL, check only to avoid a compiler warning if (si != NULL) // Used to check script variable index is still valid. si->sn_script_seq = current_sctx.sc_seq; return sid; } int get_new_scriptitem_for_fname(int *error, char_u *fname) { int sid = get_new_scriptitem(error); if (*error == OK) { scriptitem_T *si = SCRIPT_ITEM(sid); si->sn_name = vim_strsave(fname); si->sn_state = SN_STATE_NOT_LOADED; } return sid; } static void find_script_callback(char_u *fname, void *cookie) { int sid; int error = OK; int *ret_sid = cookie; sid = find_script_by_name(fname); if (sid < 0) // script does not exist yet, create a new scriptitem sid = get_new_scriptitem_for_fname(&error, fname); *ret_sid = sid; } #endif /* * Find the file "name" in all directories in "path" and invoke * "callback(fname, cookie)". * "name" can contain wildcards. * When "flags" has DIP_ALL: source all files, otherwise only the first one. * When "flags" has DIP_DIR: find directories instead of files. * When "flags" has DIP_ERR: give an error message if there is no match. * * return FAIL when no file could be sourced, OK otherwise. */ int do_in_path( char_u *path, char_u *name, int flags, void (*callback)(char_u *fname, void *ck), void *cookie) { char_u *rtp; char_u *np; char_u *buf; char_u *rtp_copy; char_u *tail; int num_files; char_u **files; int i; int did_one = FALSE; #ifdef AMIGA struct Process *proc = (struct Process *)FindTask(0L); APTR save_winptr = proc->pr_WindowPtr; // Avoid a requester here for a volume that doesn't exist. proc->pr_WindowPtr = (APTR)-1L; #endif // Make a copy of 'runtimepath'. Invoking the callback may change the // value. rtp_copy = vim_strsave(path); buf = alloc(MAXPATHL); if (buf != NULL && rtp_copy != NULL) { if (p_verbose > 10 && name != NULL) { verbose_enter(); smsg(_("Searching for \"%s\" in \"%s\""), (char *)name, (char *)path); verbose_leave(); } // Loop over all entries in 'runtimepath'. rtp = rtp_copy; while (*rtp != NUL && ((flags & DIP_ALL) || !did_one)) { size_t buflen; // Copy the path from 'runtimepath' to buf[]. copy_option_part(&rtp, buf, MAXPATHL, ","); buflen = STRLEN(buf); // Skip after or non-after directories. if (flags & (DIP_NOAFTER | DIP_AFTER)) { int is_after = buflen >= 5 && STRCMP(buf + buflen - 5, "after") == 0; if ((is_after && (flags & DIP_NOAFTER)) || (!is_after && (flags & DIP_AFTER))) continue; } if (name == NULL) { (*callback)(buf, (void *) &cookie); if (!did_one) did_one = (cookie == NULL); } else if (buflen + STRLEN(name) + 2 < MAXPATHL) { add_pathsep(buf); tail = buf + STRLEN(buf); // Loop over all patterns in "name" np = name; while (*np != NUL && ((flags & DIP_ALL) || !did_one)) { // Append the pattern from "name" to buf[]. copy_option_part(&np, tail, (int)(MAXPATHL - (tail - buf)), "\t "); if (p_verbose > 10) { verbose_enter(); smsg(_("Searching for \"%s\""), buf); verbose_leave(); } // Expand wildcards, invoke the callback for each match. if (gen_expand_wildcards(1, &buf, &num_files, &files, (flags & DIP_DIR) ? EW_DIR : EW_FILE) == OK) { for (i = 0; i < num_files; ++i) { (*callback)(files[i], cookie); did_one = TRUE; if (!(flags & DIP_ALL)) break; } FreeWild(num_files, files); } } } } } vim_free(buf); vim_free(rtp_copy); if (!did_one && name != NULL) { char *basepath = path == p_rtp ? "runtimepath" : "packpath"; if (flags & DIP_ERR) semsg(_(e_directory_not_found_in_str_str), basepath, name); else if (p_verbose > 0) { verbose_enter(); smsg(_("not found in '%s': \"%s\""), basepath, name); verbose_leave(); } } #ifdef AMIGA proc->pr_WindowPtr = save_winptr; #endif return did_one ? OK : FAIL; } /* * Find "name" in "path". When found, invoke the callback function for * it: callback(fname, "cookie") * When "flags" has DIP_ALL repeat for all matches, otherwise only the first * one is used. * Returns OK when at least one match found, FAIL otherwise. * * If "name" is NULL calls callback for each entry in "path". Cookie is * passed by reference in this case, setting it to NULL indicates that callback * has done its job. */ static int do_in_path_and_pp( char_u *path, char_u *name, int flags, void (*callback)(char_u *fname, void *ck), void *cookie) { int done = FAIL; char_u *s; int len; char *start_dir = "pack/*/start/*/%s"; char *opt_dir = "pack/*/opt/*/%s"; if ((flags & DIP_NORTP) == 0) done = do_in_path(path, name, flags, callback, cookie); if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_START)) { len = (int)(STRLEN(start_dir) + STRLEN(name)); s = alloc(len); if (s == NULL) return FAIL; vim_snprintf((char *)s, len, start_dir, name); done = do_in_path(p_pp, s, flags, callback, cookie); vim_free(s); } if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_OPT)) { len = (int)(STRLEN(opt_dir) + STRLEN(name)); s = alloc(len); if (s == NULL) return FAIL; vim_snprintf((char *)s, len, opt_dir, name); done = do_in_path(p_pp, s, flags, callback, cookie); vim_free(s); } return done; } /* * Just like do_in_path_and_pp(), using 'runtimepath' for "path". */ int do_in_runtimepath( char_u *name, int flags, void (*callback)(char_u *fname, void *ck), void *cookie) { return do_in_path_and_pp(p_rtp, name, flags, callback, cookie); } /* * Source the file "name" from all directories in 'runtimepath'. * "name" can contain wildcards. * When "flags" has DIP_ALL: source all files, otherwise only the first one. * * return FAIL when no file could be sourced, OK otherwise. */ int source_runtime(char_u *name, int flags) { return source_in_path(p_rtp, name, flags, NULL); } /* * Just like source_runtime(), but use "path" instead of 'runtimepath' * and return the script ID in "ret_sid". */ int source_in_path(char_u *path, char_u *name, int flags, int *ret_sid) { return do_in_path_and_pp(path, name, flags, source_callback, ret_sid); } #if defined(FEAT_EVAL) || defined(PROTO) /* * Find "name" in 'runtimepath'. If found a new scriptitem is created for it * and it's script ID is returned. * If not found returns -1. */ int find_script_in_rtp(char_u *name) { int sid = -1; (void)do_in_path_and_pp(p_rtp, name, DIP_NOAFTER, find_script_callback, &sid); return sid; } /* * Expand wildcards in "pat" and invoke do_source() for each match. */ static void source_all_matches(char_u *pat) { int num_files; char_u **files; int i; if (gen_expand_wildcards(1, &pat, &num_files, &files, EW_FILE) == OK) { for (i = 0; i < num_files; ++i) (void)do_source(files[i], FALSE, DOSO_NONE, NULL); FreeWild(num_files, files); } } /* * Add the package directory to 'runtimepath'. */ static int add_pack_dir_to_rtp(char_u *fname) { char_u *p4, *p3, *p2, *p1, *p; char_u *entry; char_u *insp = NULL; int c; char_u *new_rtp; int keep; size_t oldlen; size_t addlen; size_t new_rtp_len; char_u *afterdir = NULL; size_t afterlen = 0; char_u *after_insp = NULL; char_u *ffname = NULL; size_t fname_len; char_u *buf = NULL; char_u *rtp_ffname; int match; int retval = FAIL; p4 = p3 = p2 = p1 = get_past_head(fname); for (p = p1; *p; MB_PTR_ADV(p)) if (vim_ispathsep_nocolon(*p)) { p4 = p3; p3 = p2; p2 = p1; p1 = p; } // now we have: // rtp/pack/name/start/name // p4 p3 p2 p1 // // find the part up to "pack" in 'runtimepath' c = *++p4; // append pathsep in order to expand symlink *p4 = NUL; ffname = fix_fname(fname); *p4 = c; if (ffname == NULL) return FAIL; // Find "ffname" in "p_rtp", ignoring '/' vs '\' differences. // Also stop at the first "after" directory. fname_len = STRLEN(ffname); buf = alloc(MAXPATHL); if (buf == NULL) goto theend; for (entry = p_rtp; *entry != NUL; ) { char_u *cur_entry = entry; copy_option_part(&entry, buf, MAXPATHL, ","); if (insp == NULL) { add_pathsep(buf); rtp_ffname = fix_fname(buf); if (rtp_ffname == NULL) goto theend; match = vim_fnamencmp(rtp_ffname, ffname, fname_len) == 0; vim_free(rtp_ffname); if (match) // Insert "ffname" after this entry (and comma). insp = entry; } if ((p = (char_u *)strstr((char *)buf, "after")) != NULL && p > buf && vim_ispathsep(p[-1]) && (vim_ispathsep(p[5]) || p[5] == NUL || p[5] == ',')) { if (insp == NULL) // Did not find "ffname" before the first "after" directory, // insert it before this entry. insp = cur_entry; after_insp = cur_entry; break; } } if (insp == NULL) // Both "fname" and "after" not found, append at the end. insp = p_rtp + STRLEN(p_rtp); // check if rtp/pack/name/start/name/after exists afterdir = concat_fnames(fname, (char_u *)"after", TRUE); if (afterdir != NULL && mch_isdir(afterdir)) afterlen = STRLEN(afterdir) + 1; // add one for comma oldlen = STRLEN(p_rtp); addlen = STRLEN(fname) + 1; // add one for comma new_rtp = alloc(oldlen + addlen + afterlen + 1); // add one for NUL if (new_rtp == NULL) goto theend; // We now have 'rtp' parts: {keep}{keep_after}{rest}. // Create new_rtp, first: {keep},{fname} keep = (int)(insp - p_rtp); mch_memmove(new_rtp, p_rtp, keep); new_rtp_len = keep; if (*insp == NUL) new_rtp[new_rtp_len++] = ','; // add comma before mch_memmove(new_rtp + new_rtp_len, fname, addlen - 1); new_rtp_len += addlen - 1; if (*insp != NUL) new_rtp[new_rtp_len++] = ','; // add comma after if (afterlen > 0 && after_insp != NULL) { int keep_after = (int)(after_insp - p_rtp); // Add to new_rtp: {keep},{fname}{keep_after},{afterdir} mch_memmove(new_rtp + new_rtp_len, p_rtp + keep, keep_after - keep); new_rtp_len += keep_after - keep; mch_memmove(new_rtp + new_rtp_len, afterdir, afterlen - 1); new_rtp_len += afterlen - 1; new_rtp[new_rtp_len++] = ','; keep = keep_after; } if (p_rtp[keep] != NUL) // Append rest: {keep},{fname}{keep_after},{afterdir}{rest} mch_memmove(new_rtp + new_rtp_len, p_rtp + keep, oldlen - keep + 1); else new_rtp[new_rtp_len] = NUL; if (afterlen > 0 && after_insp == NULL) { // Append afterdir when "after" was not found: // {keep},{fname}{rest},{afterdir} STRCAT(new_rtp, ","); STRCAT(new_rtp, afterdir); } set_option_value_give_err((char_u *)"rtp", 0L, new_rtp, 0); vim_free(new_rtp); retval = OK; theend: vim_free(buf); vim_free(ffname); vim_free(afterdir); return retval; } /* * Load scripts in "plugin" and "ftdetect" directories of the package. */ static int load_pack_plugin(char_u *fname) { static char *plugpat = "%s/plugin/**/*.vim"; static char *ftpat = "%s/ftdetect/*.vim"; int len; char_u *ffname = fix_fname(fname); char_u *pat = NULL; int retval = FAIL; if (ffname == NULL) return FAIL; len = (int)STRLEN(ffname) + (int)STRLEN(ftpat); pat = alloc(len); if (pat == NULL) goto theend; vim_snprintf((char *)pat, len, plugpat, ffname); source_all_matches(pat); { char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes"); // If runtime/filetype.vim wasn't loaded yet, the scripts will be // found when it loads. if (cmd != NULL && eval_to_number(cmd) > 0) { do_cmdline_cmd((char_u *)"augroup filetypedetect"); vim_snprintf((char *)pat, len, ftpat, ffname); source_all_matches(pat); do_cmdline_cmd((char_u *)"augroup END"); } vim_free(cmd); } vim_free(pat); retval = OK; theend: vim_free(ffname); return retval; } // used for "cookie" of add_pack_plugin() static int APP_ADD_DIR; static int APP_LOAD; static int APP_BOTH; static void add_pack_plugin(char_u *fname, void *cookie) { if (cookie != &APP_LOAD) { char_u *buf = alloc(MAXPATHL); char_u *p; int found = FALSE; if (buf == NULL) return; p = p_rtp; while (*p != NUL) { copy_option_part(&p, buf, MAXPATHL, ","); if (pathcmp((char *)buf, (char *)fname, -1) == 0) { found = TRUE; break; } } vim_free(buf); if (!found) // directory is not yet in 'runtimepath', add it if (add_pack_dir_to_rtp(fname) == FAIL) return; } if (cookie != &APP_ADD_DIR) load_pack_plugin(fname); } /* * Add all packages in the "start" directory to 'runtimepath'. */ void add_pack_start_dirs(void) { do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR, add_pack_plugin, &APP_ADD_DIR); } /* * Load plugins from all packages in the "start" directory. */ void load_start_packages(void) { did_source_packages = TRUE; do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR, add_pack_plugin, &APP_LOAD); } /* * ":packloadall" * Find plugins in the package directories and source them. */ void ex_packloadall(exarg_T *eap) { if (!did_source_packages || eap->forceit) { // First do a round to add all directories to 'runtimepath', then load // the plugins. This allows for plugins to use an autoload directory // of another plugin. add_pack_start_dirs(); load_start_packages(); } } /* * ":packadd[!] {name}" */ void ex_packadd(exarg_T *eap) { static char *plugpat = "pack/*/%s/%s"; int len; char *pat; int round; int res = OK; // Round 1: use "start", round 2: use "opt". for (round = 1; round <= 2; ++round) { // Only look under "start" when loading packages wasn't done yet. if (round == 1 && did_source_packages) continue; len = (int)STRLEN(plugpat) + (int)STRLEN(eap->arg) + 5; pat = alloc(len); if (pat == NULL) return; vim_snprintf(pat, len, plugpat, round == 1 ? "start" : "opt", eap->arg); // The first round don't give a "not found" error, in the second round // only when nothing was found in the first round. res = do_in_path(p_pp, (char_u *)pat, DIP_ALL + DIP_DIR + (round == 2 && res == FAIL ? DIP_ERR : 0), add_pack_plugin, eap->forceit ? &APP_ADD_DIR : &APP_BOTH); vim_free(pat); } } #endif /* * Sort "gap" and remove duplicate entries. "gap" is expected to contain a * list of file names in allocated memory. */ void remove_duplicates(garray_T *gap) { int i; int j; char_u **fnames = (char_u **)gap->ga_data; sort_strings(fnames, gap->ga_len); for (i = gap->ga_len - 1; i > 0; --i) if (fnamecmp(fnames[i - 1], fnames[i]) == 0) { vim_free(fnames[i]); for (j = i + 1; j < gap->ga_len; ++j) fnames[j - 1] = fnames[j]; --gap->ga_len; } } /* * Expand color scheme, compiler or filetype names. * Search from 'runtimepath': * 'runtimepath'/{dirnames}/{pat}.vim * When "flags" has DIP_START: search also from 'start' of 'packpath': * 'packpath'/pack/ * /start/ * /{dirnames}/{pat}.vim * When "flags" has DIP_OPT: search also from 'opt' of 'packpath': * 'packpath'/pack/ * /opt/ * /{dirnames}/{pat}.vim * "dirnames" is an array with one or more directory names. */ int ExpandRTDir( char_u *pat, int flags, int *num_file, char_u ***file, char *dirnames[]) { char_u *s; char_u *e; char_u *match; garray_T ga; int i; int pat_len; *num_file = 0; *file = NULL; pat_len = (int)STRLEN(pat); ga_init2(&ga, sizeof(char *), 10); for (i = 0; dirnames[i] != NULL; ++i) { s = alloc(STRLEN(dirnames[i]) + pat_len + 7); if (s == NULL) { ga_clear_strings(&ga); return FAIL; } sprintf((char *)s, "%s/%s*.vim", dirnames[i], pat); globpath(p_rtp, s, &ga, 0); vim_free(s); } if (flags & DIP_START) { for (i = 0; dirnames[i] != NULL; ++i) { s = alloc(STRLEN(dirnames[i]) + pat_len + 22); if (s == NULL) { ga_clear_strings(&ga); return FAIL; } sprintf((char *)s, "pack/*/start/*/%s/%s*.vim", dirnames[i], pat); globpath(p_pp, s, &ga, 0); vim_free(s); } } if (flags & DIP_OPT) { for (i = 0; dirnames[i] != NULL; ++i) { s = alloc(STRLEN(dirnames[i]) + pat_len + 20); if (s == NULL) { ga_clear_strings(&ga); return FAIL; } sprintf((char *)s, "pack/*/opt/*/%s/%s*.vim", dirnames[i], pat); globpath(p_pp, s, &ga, 0); vim_free(s); } } for (i = 0; i < ga.ga_len; ++i) { match = ((char_u **)ga.ga_data)[i]; s = match; e = s + STRLEN(s); if (e - 4 > s && STRNICMP(e - 4, ".vim", 4) == 0) { e -= 4; for (s = e; s > match; MB_PTR_BACK(match, s)) if (s < match || vim_ispathsep(*s)) break; ++s; *e = NUL; mch_memmove(match, s, e - s + 1); } } if (ga.ga_len == 0) return FAIL; // Sort and remove duplicates which can happen when specifying multiple // directories in dirnames. remove_duplicates(&ga); *file = ga.ga_data; *num_file = ga.ga_len; return OK; } /* * Expand loadplugin names: * 'packpath'/pack/ * /opt/{pat} */ int ExpandPackAddDir( char_u *pat, int *num_file, char_u ***file) { char_u *s; char_u *e; char_u *match; garray_T ga; int i; int pat_len; *num_file = 0; *file = NULL; pat_len = (int)STRLEN(pat); ga_init2(&ga, sizeof(char *), 10); s = alloc(pat_len + 26); if (s == NULL) { ga_clear_strings(&ga); return FAIL; } sprintf((char *)s, "pack/*/opt/%s*", pat); globpath(p_pp, s, &ga, 0); vim_free(s); for (i = 0; i < ga.ga_len; ++i) { match = ((char_u **)ga.ga_data)[i]; s = gettail(match); e = s + STRLEN(s); mch_memmove(match, s, e - s + 1); } if (ga.ga_len == 0) return FAIL; // Sort and remove duplicates which can happen when specifying multiple // directories in dirnames. remove_duplicates(&ga); *file = ga.ga_data; *num_file = ga.ga_len; return OK; } static void cmd_source(char_u *fname, exarg_T *eap) { int clearvars = FALSE; if (*fname != NUL && STRNCMP(fname, "++clear", 7) == 0) { // ++clear argument is supplied clearvars = TRUE; fname = fname + 7; if (*fname != NUL) { semsg(_(e_invalid_argument_str), eap->arg); return; } } if (*fname != NUL && eap != NULL && eap->addr_count > 0) { // if a filename is specified to :source, then a range is not allowed emsg(_(e_no_range_allowed)); return; } if (eap != NULL && *fname == NUL) { if (eap->forceit) // a file name is needed to source normal mode commands emsg(_(e_argument_required)); else // source ex commands from the current buffer do_source_ext(NULL, FALSE, FALSE, NULL, eap, clearvars); } else if (eap != NULL && eap->forceit) // ":source!": read Normal mode commands // Need to execute the commands directly. This is required at least // for: // - ":g" command busy // - after ":argdo", ":windo" or ":bufdo" // - another command follows // - inside a loop openscript(fname, global_busy || listcmd_busy || eap->nextcmd != NULL #ifdef FEAT_EVAL || eap->cstack->cs_idx >= 0 #endif ); // ":source" read ex commands else if (do_source(fname, FALSE, DOSO_NONE, NULL) == FAIL) semsg(_(e_cant_open_file_str), fname); } /* * ":source {fname}" */ void ex_source(exarg_T *eap) { #ifdef FEAT_BROWSE if (cmdmod.cmod_flags & CMOD_BROWSE) { char_u *fname = NULL; fname = do_browse(0, (char_u *)_("Source Vim script"), eap->arg, NULL, NULL, (char_u *)_(BROWSE_FILTER_MACROS), NULL); if (fname != NULL) { cmd_source(fname, eap); vim_free(fname); } } else #endif cmd_source(eap->arg, eap); } #if defined(FEAT_EVAL) || defined(PROTO) /* * ":options" */ void ex_options( exarg_T *eap UNUSED) { char_u buf[500]; int multi_mods = 0; buf[0] = NUL; (void)add_win_cmd_modifers(buf, &cmdmod, &multi_mods); vim_setenv((char_u *)"OPTWIN_CMD", buf); cmd_source((char_u *)SYS_OPTWIN_FILE, NULL); } #endif /* * ":source" and associated commands. */ #ifdef FEAT_EVAL /* * Return the address holding the next breakpoint line for a source cookie. */ linenr_T * source_breakpoint(void *cookie) { return &((source_cookie_T *)cookie)->breakpoint; } /* * Return the address holding the debug tick for a source cookie. */ int * source_dbg_tick(void *cookie) { return &((source_cookie_T *)cookie)->dbg_tick; } /* * Return the nesting level for a source cookie. */ int source_level(void *cookie) { return ((source_cookie_T *)cookie)->level; } /* * Return the readahead line. Note that the pointer may become invalid when * getting the next line, if it's concatenated with the next one. */ char_u * source_nextline(void *cookie) { return ((source_cookie_T *)cookie)->nextline; } #endif #if (defined(MSWIN) && defined(FEAT_CSCOPE)) || defined(HAVE_FD_CLOEXEC) # define USE_FOPEN_NOINH /* * Special function to open a file without handle inheritance. * When possible the handle is closed on exec(). */ static FILE * fopen_noinh_readbin(char *filename) { # ifdef MSWIN int fd_tmp = mch_open(filename, O_RDONLY | O_BINARY | O_NOINHERIT, 0); # else int fd_tmp = mch_open(filename, O_RDONLY, 0); # endif if (fd_tmp == -1) return NULL; # ifdef HAVE_FD_CLOEXEC { int fdflags = fcntl(fd_tmp, F_GETFD); if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0) (void)fcntl(fd_tmp, F_SETFD, fdflags | FD_CLOEXEC); } # endif return fdopen(fd_tmp, READBIN); } #endif /* * Initialization for sourcing lines from the current buffer. Reads all the * lines from the buffer and stores it in the cookie grow array. * Returns a pointer to the name ":source buffer=<n>" on success and NULL on * failure. */ static char_u * do_source_buffer_init(source_cookie_T *sp, exarg_T *eap) { linenr_T curr_lnum; char_u *line = NULL; char_u *fname; CLEAR_FIELD(*sp); if (curbuf == NULL) return NULL; // Use ":source buffer=<num>" as the script name vim_snprintf((char *)IObuff, IOSIZE, ":source buffer=%d", curbuf->b_fnum); fname = vim_strsave(IObuff); if (fname == NULL) return NULL; ga_init2(&sp->buflines, sizeof(char_u *), 100); // Copy the lines from the buffer into a grow array for (curr_lnum = eap->line1; curr_lnum <= eap->line2; curr_lnum++) { line = vim_strsave(ml_get(curr_lnum)); if (line == NULL) goto errret; if (ga_add_string(&sp->buflines, line) == FAIL) goto errret; line = NULL; } sp->buf_lnum = 0; sp->source_from_buf = TRUE; return fname; errret: vim_free(fname); vim_free(line); ga_clear_strings(&sp->buflines); return NULL; } /* * Read the file "fname" and execute its lines as EX commands. * When "ret_sid" is not NULL and we loaded the script before, don't load it * again. * * The 'eap' argument is used when sourcing lines from a buffer instead of a * file. * * If 'clearvars' is TRUE, then for scripts which are loaded more than * once, clear all the functions and variables previously defined in that * script. * * This function may be called recursively! * * Return FAIL if file could not be opened, OK otherwise. * If a scriptitem_T was found or created "*ret_sid" is set to the SID. */ static int do_source_ext( char_u *fname, int check_other, // check for .vimrc and _vimrc int is_vimrc, // DOSO_ value int *ret_sid UNUSED, exarg_T *eap, int clearvars UNUSED) { source_cookie_T cookie; char_u *p; char_u *fname_exp; char_u *firstline = NULL; int retval = FAIL; sctx_T save_current_sctx; #ifdef FEAT_EVAL funccal_entry_T funccalp_entry; int save_debug_break_level = debug_break_level; int sid; scriptitem_T *si = NULL; int save_estack_compiling = estack_compiling; #endif #ifdef STARTUPTIME struct timeval tv_rel; struct timeval tv_start; #endif #ifdef FEAT_PROFILE proftime_T wait_start; #endif int save_sticky_cmdmod_flags = sticky_cmdmod_flags; int trigger_source_post = FALSE; ESTACK_CHECK_DECLARATION CLEAR_FIELD(cookie); if (fname == NULL) { // sourcing lines from a buffer fname_exp = do_source_buffer_init(&cookie, eap); if (fname_exp == NULL) return FAIL; } else { p = expand_env_save(fname); if (p == NULL) return retval; fname_exp = fix_fname(p); vim_free(p); if (fname_exp == NULL) return retval; if (mch_isdir(fname_exp)) { smsg(_("Cannot source a directory: \"%s\""), fname); goto theend; } } #ifdef FEAT_EVAL estack_compiling = FALSE; // See if we loaded this script before. sid = find_script_by_name(fname_exp); if (sid > 0 && ret_sid != NULL && SCRIPT_ITEM(sid)->sn_state != SN_STATE_NOT_LOADED) { // Already loaded and no need to load again, return here. *ret_sid = sid; retval = OK; goto theend; } #endif // Apply SourceCmd autocommands, they should get the file and source it. if (has_autocmd(EVENT_SOURCECMD, fname_exp, NULL) && apply_autocmds(EVENT_SOURCECMD, fname_exp, fname_exp, FALSE, curbuf)) { #ifdef FEAT_EVAL retval = aborting() ? FAIL : OK; #else retval = OK; #endif if (retval == OK) // Apply SourcePost autocommands. apply_autocmds(EVENT_SOURCEPOST, fname_exp, fname_exp, FALSE, curbuf); goto theend; } // Apply SourcePre autocommands, they may get the file. apply_autocmds(EVENT_SOURCEPRE, fname_exp, fname_exp, FALSE, curbuf); if (!cookie.source_from_buf) { #ifdef USE_FOPEN_NOINH cookie.fp = fopen_noinh_readbin((char *)fname_exp); #else cookie.fp = mch_fopen((char *)fname_exp, READBIN); #endif } if (cookie.fp == NULL && check_other) { // Try again, replacing file name ".vimrc" by "_vimrc" or vice versa, // and ".exrc" by "_exrc" or vice versa. p = gettail(fname_exp); if ((*p == '.' || *p == '_') && (STRICMP(p + 1, "vimrc") == 0 || STRICMP(p + 1, "gvimrc") == 0 || STRICMP(p + 1, "exrc") == 0)) { if (*p == '_') *p = '.'; else *p = '_'; #ifdef USE_FOPEN_NOINH cookie.fp = fopen_noinh_readbin((char *)fname_exp); #else cookie.fp = mch_fopen((char *)fname_exp, READBIN); #endif } } if (cookie.fp == NULL && !cookie.source_from_buf) { if (p_verbose > 0) { verbose_enter(); if (SOURCING_NAME == NULL) smsg(_("could not source \"%s\""), fname); else smsg(_("line %ld: could not source \"%s\""), SOURCING_LNUM, fname); verbose_leave(); } goto theend; } // The file exists. // - In verbose mode, give a message. // - For a vimrc file, may want to set 'compatible', call vimrc_found(). if (p_verbose > 1) { verbose_enter(); if (SOURCING_NAME == NULL) smsg(_("sourcing \"%s\""), fname); else smsg(_("line %ld: sourcing \"%s\""), SOURCING_LNUM, fname); verbose_leave(); } if (is_vimrc == DOSO_VIMRC) vimrc_found(fname_exp, (char_u *)"MYVIMRC"); else if (is_vimrc == DOSO_GVIMRC) vimrc_found(fname_exp, (char_u *)"MYGVIMRC"); #ifdef USE_CRNL // If no automatic file format: Set default to CR-NL. if (*p_ffs == NUL) cookie.fileformat = EOL_DOS; else cookie.fileformat = EOL_UNKNOWN; #endif if (fname == NULL) // When sourcing a range of lines from a buffer, use the buffer line // number. cookie.sourcing_lnum = eap->line1 - 1; else cookie.sourcing_lnum = 0; #ifdef FEAT_EVAL // Check if this script has a breakpoint. cookie.breakpoint = dbg_find_breakpoint(TRUE, fname_exp, (linenr_T)0); cookie.fname = fname_exp; cookie.dbg_tick = debug_tick; cookie.level = ex_nesting_level; #endif #ifdef STARTUPTIME if (time_fd != NULL) time_push(&tv_rel, &tv_start); #endif // "legacy" does not apply to commands in the script sticky_cmdmod_flags = 0; save_current_sctx = current_sctx; if (cmdmod.cmod_flags & CMOD_VIM9CMD) // When the ":vim9cmd" command modifier is used, source the script as a // Vim9 script. current_sctx.sc_version = SCRIPT_VERSION_VIM9; else current_sctx.sc_version = 1; // default script version #ifdef FEAT_EVAL # ifdef FEAT_PROFILE if (do_profiling == PROF_YES) prof_child_enter(&wait_start); // entering a child now # endif // Don't use local function variables, if called from a function. // Also starts profiling timer for nested script. save_funccal(&funccalp_entry); current_sctx.sc_lnum = 0; // Check if this script was sourced before to find its SID. // Always use a new sequence number. current_sctx.sc_seq = ++last_current_SID_seq; if (sid > 0) { hashtab_T *ht; int todo; hashitem_T *hi; dictitem_T *di; // loading the same script again current_sctx.sc_sid = sid; si = SCRIPT_ITEM(sid); if (si->sn_state == SN_STATE_NOT_LOADED) { // this script was found but not loaded yet si->sn_state = SN_STATE_NEW; } else { si->sn_state = SN_STATE_RELOAD; if (!clearvars) { // Script-local variables remain but "const" can be set again. // In Vim9 script variables will be cleared when "vim9script" // is encountered without the "noclear" argument. ht = &SCRIPT_VARS(sid); todo = (int)ht->ht_used; for (hi = ht->ht_array; todo > 0; ++hi) if (!HASHITEM_EMPTY(hi)) { --todo; di = HI2DI(hi); di->di_flags |= DI_FLAGS_RELOAD; } // imports can be redefined once mark_imports_for_reload(sid); } else clear_vim9_scriptlocal_vars(sid); // reset version, "vim9script" may have been added or removed. si->sn_version = 1; } } else { int error = OK; // It's new, generate a new SID and initialize the scriptitem. current_sctx.sc_sid = get_new_scriptitem(&error); if (error == FAIL) goto almosttheend; si = SCRIPT_ITEM(current_sctx.sc_sid); si->sn_name = fname_exp; fname_exp = vim_strsave(si->sn_name); // used for autocmd if (ret_sid != NULL) *ret_sid = current_sctx.sc_sid; // Remember the "is_vimrc" flag for when the file is sourced again. si->sn_is_vimrc = is_vimrc; } // Keep the sourcing name/lnum, for recursive calls. estack_push(ETYPE_SCRIPT, si->sn_name, 0); ESTACK_CHECK_SETUP # ifdef FEAT_PROFILE if (do_profiling == PROF_YES) { int forceit; // Check if we do profiling for this script. if (!si->sn_prof_on && has_profiling(TRUE, si->sn_name, &forceit)) { script_do_profile(si); si->sn_pr_force = forceit; } if (si->sn_prof_on) { ++si->sn_pr_count; profile_start(&si->sn_pr_start); profile_zero(&si->sn_pr_children); } } # endif #endif cookie.conv.vc_type = CONV_NONE; // no conversion // Read the first line so we can check for a UTF-8 BOM. firstline = getsourceline(0, (void *)&cookie, 0, TRUE); if (firstline != NULL && STRLEN(firstline) >= 3 && firstline[0] == 0xef && firstline[1] == 0xbb && firstline[2] == 0xbf) { // Found BOM; setup conversion, skip over BOM and recode the line. convert_setup(&cookie.conv, (char_u *)"utf-8", p_enc); p = string_convert(&cookie.conv, firstline + 3, NULL); if (p == NULL) p = vim_strsave(firstline + 3); if (p != NULL) { vim_free(firstline); firstline = p; } } // Call do_cmdline, which will call getsourceline() to get the lines. do_cmdline(firstline, getsourceline, (void *)&cookie, DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_REPEAT); retval = OK; #ifdef FEAT_PROFILE if (do_profiling == PROF_YES) { // Get "si" again, "script_items" may have been reallocated. si = SCRIPT_ITEM(current_sctx.sc_sid); if (si->sn_prof_on) { profile_end(&si->sn_pr_start); profile_sub_wait(&wait_start, &si->sn_pr_start); profile_add(&si->sn_pr_total, &si->sn_pr_start); profile_self(&si->sn_pr_self, &si->sn_pr_start, &si->sn_pr_children); } } #endif if (got_int) emsg(_(e_interrupted)); ESTACK_CHECK_NOW estack_pop(); if (p_verbose > 1) { verbose_enter(); smsg(_("finished sourcing %s"), fname); if (SOURCING_NAME != NULL) smsg(_("continuing in %s"), SOURCING_NAME); verbose_leave(); } #ifdef STARTUPTIME if (time_fd != NULL) { vim_snprintf((char *)IObuff, IOSIZE, "sourcing %s", fname); time_msg((char *)IObuff, &tv_start); time_pop(&tv_rel); } #endif if (!got_int) trigger_source_post = TRUE; #ifdef FEAT_EVAL // After a "finish" in debug mode, need to break at first command of next // sourced file. if (save_debug_break_level > ex_nesting_level && debug_break_level == ex_nesting_level) ++debug_break_level; #endif #ifdef FEAT_EVAL almosttheend: // If "sn_save_cpo" is set that means we encountered "vim9script": restore // 'cpoptions', unless in the main .vimrc file. // Get "si" again, "script_items" may have been reallocated. si = SCRIPT_ITEM(current_sctx.sc_sid); if (si->sn_save_cpo != NULL && si->sn_is_vimrc == DOSO_NONE) { if (STRCMP(p_cpo, CPO_VIM) != 0) { char_u *f; char_u *t; // 'cpo' was changed in the script. Apply the same change to the // saved value, if possible. for (f = (char_u *)CPO_VIM; *f != NUL; ++f) if (vim_strchr(p_cpo, *f) == NULL && (t = vim_strchr(si->sn_save_cpo, *f)) != NULL) // flag was removed, also remove it from the saved 'cpo' mch_memmove(t, t + 1, STRLEN(t)); for (f = p_cpo; *f != NUL; ++f) if (vim_strchr((char_u *)CPO_VIM, *f) == NULL && vim_strchr(si->sn_save_cpo, *f) == NULL) { // flag was added, also add it to the saved 'cpo' t = alloc(STRLEN(si->sn_save_cpo) + 2); if (t != NULL) { *t = *f; STRCPY(t + 1, si->sn_save_cpo); vim_free(si->sn_save_cpo); si->sn_save_cpo = t; } } } set_option_value_give_err((char_u *)"cpo", 0L, si->sn_save_cpo, OPT_NO_REDRAW); } VIM_CLEAR(si->sn_save_cpo); restore_funccal(); # ifdef FEAT_PROFILE if (do_profiling == PROF_YES) prof_child_exit(&wait_start); // leaving a child now # endif #endif current_sctx = save_current_sctx; if (cookie.fp != NULL) fclose(cookie.fp); if (cookie.source_from_buf) ga_clear_strings(&cookie.buflines); vim_free(cookie.nextline); vim_free(firstline); convert_setup(&cookie.conv, NULL, NULL); if (trigger_source_post) apply_autocmds(EVENT_SOURCEPOST, fname_exp, fname_exp, FALSE, curbuf); theend: vim_free(fname_exp); sticky_cmdmod_flags = save_sticky_cmdmod_flags; #ifdef FEAT_EVAL estack_compiling = save_estack_compiling; #endif return retval; } int do_source( char_u *fname, int check_other, // check for .vimrc and _vimrc int is_vimrc, // DOSO_ value int *ret_sid UNUSED) { return do_source_ext(fname, check_other, is_vimrc, ret_sid, NULL, FALSE); } #if defined(FEAT_EVAL) || defined(PROTO) /* * ":scriptnames" */ void ex_scriptnames(exarg_T *eap) { int i; if (eap->addr_count > 0 || *eap->arg != NUL) { // :script {scriptId}: edit the script if (eap->addr_count > 0 && !SCRIPT_ID_VALID(eap->line2)) emsg(_(e_invalid_argument)); else { if (eap->addr_count > 0) eap->arg = SCRIPT_ITEM(eap->line2)->sn_name; else { expand_env(eap->arg, NameBuff, MAXPATHL); eap->arg = NameBuff; } do_exedit(eap, NULL); } return; } for (i = 1; i <= script_items.ga_len && !got_int; ++i) { scriptitem_T *si = SCRIPT_ITEM(i); if (si->sn_name != NULL) { home_replace(NULL, si->sn_name, NameBuff, MAXPATHL, TRUE); vim_snprintf((char *)IObuff, IOSIZE, "%3d%s: %s", i, si->sn_state == SN_STATE_NOT_LOADED ? " A" : "", NameBuff); if (!message_filtered(IObuff)) { msg_putchar('\n'); msg_outtrans(IObuff); out_flush(); // output one line at a time ui_breakcheck(); } } } } # if defined(BACKSLASH_IN_FILENAME) || defined(PROTO) /* * Fix slashes in the list of script names for 'shellslash'. */ void scriptnames_slash_adjust(void) { int i; for (i = 1; i <= script_items.ga_len; ++i) if (SCRIPT_ITEM(i)->sn_name != NULL) slash_adjust(SCRIPT_ITEM(i)->sn_name); } # endif /* * Get a pointer to a script name. Used for ":verbose set". * Message appended to "Last set from " */ char_u * get_scriptname(scid_T id) { if (id == SID_MODELINE) return (char_u *)_("modeline"); if (id == SID_CMDARG) return (char_u *)_("--cmd argument"); if (id == SID_CARG) return (char_u *)_("-c argument"); if (id == SID_ENV) return (char_u *)_("environment variable"); if (id == SID_ERROR) return (char_u *)_("error handler"); if (id == SID_WINLAYOUT) return (char_u *)_("changed window size"); return SCRIPT_ITEM(id)->sn_name; } # if defined(EXITFREE) || defined(PROTO) void free_scriptnames(void) { int i; for (i = script_items.ga_len; i > 0; --i) { scriptitem_T *si = SCRIPT_ITEM(i); // the variables themselves are cleared in evalvars_clear() vim_free(si->sn_vars); vim_free(si->sn_name); free_imports_and_script_vars(i); free_string_option(si->sn_save_cpo); # ifdef FEAT_PROFILE ga_clear(&si->sn_prl_ga); # endif vim_free(si->sn_autoload_prefix); vim_free(si); } ga_clear(&script_items); } void free_autoload_scriptnames(void) { ga_clear_strings(&ga_loaded); } # endif linenr_T get_sourced_lnum( char_u *(*fgetline)(int, void *, int, getline_opt_T), void *cookie) { return fgetline == getsourceline ? ((source_cookie_T *)cookie)->sourcing_lnum : SOURCING_LNUM; } #endif static char_u * get_one_sourceline(source_cookie_T *sp) { garray_T ga; int len; int c; char_u *buf; #ifdef USE_CRNL int has_cr; // CR-LF found #endif int have_read = FALSE; // use a growarray to store the sourced line ga_init2(&ga, 1, 250); // Loop until there is a finished line (or end-of-file). ++sp->sourcing_lnum; for (;;) { // make room to read at least 120 (more) characters if (ga_grow(&ga, 120) == FAIL) break; if (sp->source_from_buf) { if (sp->buf_lnum >= sp->buflines.ga_len) break; // all the lines are processed ga_concat(&ga, ((char_u **)sp->buflines.ga_data)[sp->buf_lnum]); sp->buf_lnum++; if (ga_grow(&ga, 1) == FAIL) break; buf = (char_u *)ga.ga_data; buf[ga.ga_len++] = NUL; len = ga.ga_len; } else { buf = (char_u *)ga.ga_data; if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len, sp->fp) == NULL) break; len = ga.ga_len + (int)STRLEN(buf + ga.ga_len); } #ifdef USE_CRNL // Ignore a trailing CTRL-Z, when in Dos mode. Only recognize the // CTRL-Z by its own, or after a NL. if ( (len == 1 || (len >= 2 && buf[len - 2] == '\n')) && sp->fileformat == EOL_DOS && buf[len - 1] == Ctrl_Z) { buf[len - 1] = NUL; break; } #endif have_read = TRUE; ga.ga_len = len; // If the line was longer than the buffer, read more. if (ga.ga_maxlen - ga.ga_len == 1 && buf[len - 1] != '\n') continue; if (len >= 1 && buf[len - 1] == '\n') // remove trailing NL { #ifdef USE_CRNL has_cr = (len >= 2 && buf[len - 2] == '\r'); if (sp->fileformat == EOL_UNKNOWN) { if (has_cr) sp->fileformat = EOL_DOS; else sp->fileformat = EOL_UNIX; } if (sp->fileformat == EOL_DOS) { if (has_cr) // replace trailing CR { buf[len - 2] = '\n'; --len; --ga.ga_len; } else // lines like ":map xx yy^M" will have failed { if (!sp->error) { msg_source(HL_ATTR(HLF_W)); emsg(_("W15: Warning: Wrong line separator, ^M may be missing")); } sp->error = TRUE; sp->fileformat = EOL_UNIX; } } #endif // The '\n' is escaped if there is an odd number of ^V's just // before it, first set "c" just before the 'V's and then check // len&c parities (is faster than ((len-c)%2 == 0)) -- Acevedo for (c = len - 2; c >= 0 && buf[c] == Ctrl_V; c--) ; if ((len & 1) != (c & 1)) // escaped NL, read more { ++sp->sourcing_lnum; continue; } buf[len - 1] = NUL; // remove the NL } // Check for ^C here now and then, so recursive :so can be broken. line_breakcheck(); break; } if (have_read) return (char_u *)ga.ga_data; vim_free(ga.ga_data); return NULL; } /* * Get one full line from a sourced file. * Called by do_cmdline() when it's called from do_source(). * * Return a pointer to the line in allocated memory. * Return NULL for end-of-file or some error. */ char_u * getsourceline( int c UNUSED, void *cookie, int indent UNUSED, getline_opt_T options) { source_cookie_T *sp = (source_cookie_T *)cookie; char_u *line; char_u *p; int do_vim9_all = in_vim9script() && options == GETLINE_CONCAT_ALL; int do_bar_cont = do_vim9_all || options == GETLINE_CONCAT_CONTBAR; #ifdef FEAT_EVAL // If breakpoints have been added/deleted need to check for it. if ((sp->dbg_tick < debug_tick) && !sp->source_from_buf) { sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, SOURCING_LNUM); sp->dbg_tick = debug_tick; } # ifdef FEAT_PROFILE if (do_profiling == PROF_YES) script_line_end(); # endif #endif // Set the current sourcing line number. SOURCING_LNUM = sp->sourcing_lnum + 1; // Get current line. If there is a read-ahead line, use it, otherwise get // one now. "fp" is NULL if actually using a string. if (sp->finished || (!sp->source_from_buf && sp->fp == NULL)) line = NULL; else if (sp->nextline == NULL) line = get_one_sourceline(sp); else { line = sp->nextline; sp->nextline = NULL; ++sp->sourcing_lnum; } #ifdef FEAT_PROFILE if (line != NULL && do_profiling == PROF_YES) script_line_start(); #endif // Only concatenate lines starting with a \ when 'cpoptions' doesn't // contain the 'C' flag. if (line != NULL && options != GETLINE_NONE && vim_strchr(p_cpo, CPO_CONCAT) == NULL) { int comment_char = in_vim9script() ? '#' : '"'; // compensate for the one line read-ahead --sp->sourcing_lnum; // Get the next line and concatenate it when it starts with a // backslash. We always need to read the next line, keep it in // sp->nextline. /* Also check for a comment in between continuation lines: "\ */ // Also check for a Vim9 comment, empty line, line starting with '|', // but not "||". sp->nextline = get_one_sourceline(sp); if (sp->nextline != NULL && (*(p = skipwhite(sp->nextline)) == '\\' || (p[0] == comment_char && p[1] == '\\' && p[2] == ' ') || (do_vim9_all && (*p == NUL || vim9_comment_start(p))) || (do_bar_cont && p[0] == '|' && p[1] != '|'))) { garray_T ga; ga_init2(&ga, sizeof(char_u), 400); ga_concat(&ga, line); if (*p == '\\') ga_concat(&ga, p + 1); else if (*p == '|') { ga_concat(&ga, (char_u *)" "); ga_concat(&ga, p); } for (;;) { vim_free(sp->nextline); sp->nextline = get_one_sourceline(sp); if (sp->nextline == NULL) break; p = skipwhite(sp->nextline); if (*p == '\\' || (do_bar_cont && p[0] == '|' && p[1] != '|')) { // Adjust the growsize to the current length to speed up // concatenating many lines. if (ga.ga_len > 400) { if (ga.ga_len > 8000) ga.ga_growsize = 8000; else ga.ga_growsize = ga.ga_len; } if (*p == '\\') ga_concat(&ga, p + 1); else { ga_concat(&ga, (char_u *)" "); ga_concat(&ga, p); } } else if (!(p[0] == (comment_char) && p[1] == '\\' && p[2] == ' ') && !(do_vim9_all && (*p == NUL || vim9_comment_start(p)))) break; /* drop a # comment or "\ comment line */ } ga_append(&ga, NUL); vim_free(line); line = ga.ga_data; } } if (line != NULL && sp->conv.vc_type != CONV_NONE) { char_u *s; // Convert the encoding of the script line. s = string_convert(&sp->conv, line, NULL); if (s != NULL) { vim_free(line); line = s; } } #ifdef FEAT_EVAL // Did we encounter a breakpoint? if (!sp->source_from_buf && sp->breakpoint != 0 && sp->breakpoint <= SOURCING_LNUM) { dbg_breakpoint(sp->fname, SOURCING_LNUM); // Find next breakpoint. sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, SOURCING_LNUM); sp->dbg_tick = debug_tick; } #endif return line; } /* * Returns TRUE if sourcing a script either from a file or a buffer. * Otherwise returns FALSE. */ int sourcing_a_script(exarg_T *eap) { return (getline_equal(eap->getline, eap->cookie, getsourceline)); } /* * ":scriptencoding": Set encoding conversion for a sourced script. */ void ex_scriptencoding(exarg_T *eap) { source_cookie_T *sp; char_u *name; if (!sourcing_a_script(eap)) { emsg(_(e_scriptencoding_used_outside_of_sourced_file)); return; } if (*eap->arg != NUL) { name = enc_canonize(eap->arg); if (name == NULL) // out of memory return; } else name = eap->arg; // Setup for conversion from the specified encoding to 'encoding'. sp = (source_cookie_T *)getline_cookie(eap->getline, eap->cookie); convert_setup(&sp->conv, name, p_enc); if (name != eap->arg) vim_free(name); } /* * ":scriptversion": Set Vim script version for a sourced script. */ void ex_scriptversion(exarg_T *eap UNUSED) { int nr; if (!sourcing_a_script(eap)) { emsg(_(e_scriptversion_used_outside_of_sourced_file)); return; } if (in_vim9script()) { emsg(_(e_cannot_use_scriptversion_after_vim9script)); return; } nr = getdigits(&eap->arg); if (nr == 0 || *eap->arg != NUL) emsg(_(e_invalid_argument)); else if (nr > SCRIPT_VERSION_MAX) semsg(_(e_scriptversion_not_supported_nr), nr); else { current_sctx.sc_version = nr; #ifdef FEAT_EVAL SCRIPT_ITEM(current_sctx.sc_sid)->sn_version = nr; #endif } } #if defined(FEAT_EVAL) || defined(PROTO) /* * ":finish": Mark a sourced file as finished. */ void ex_finish(exarg_T *eap) { if (sourcing_a_script(eap)) do_finish(eap, FALSE); else emsg(_(e_finish_used_outside_of_sourced_file)); } /* * Mark a sourced file as finished. Possibly makes the ":finish" pending. * Also called for a pending finish at the ":endtry" or after returning from * an extra do_cmdline(). "reanimate" is used in the latter case. */ void do_finish(exarg_T *eap, int reanimate) { int idx; if (reanimate) ((source_cookie_T *)getline_cookie(eap->getline, eap->cookie))->finished = FALSE; // Cleanup (and inactivate) conditionals, but stop when a try conditional // not in its finally clause (which then is to be executed next) is found. // In this case, make the ":finish" pending for execution at the ":endtry". // Otherwise, finish normally. idx = cleanup_conditionals(eap->cstack, 0, TRUE); if (idx >= 0) { eap->cstack->cs_pending[idx] = CSTP_FINISH; report_make_pending(CSTP_FINISH, NULL); } else ((source_cookie_T *)getline_cookie(eap->getline, eap->cookie))->finished = TRUE; } /* * Return TRUE when a sourced file had the ":finish" command: Don't give error * message for missing ":endif". * Return FALSE when not sourcing a file. */ int source_finished( char_u *(*fgetline)(int, void *, int, getline_opt_T), void *cookie) { return (getline_equal(fgetline, cookie, getsourceline) && ((source_cookie_T *)getline_cookie( fgetline, cookie))->finished); } /* * Find the path of a script below the "autoload" directory. * Returns NULL if there is no "/autoload/" in the script name. */ static char_u * script_name_after_autoload(scriptitem_T *si) { char_u *p = si->sn_name; char_u *res = NULL; for (;;) { char_u *n = (char_u *)strstr((char *)p, "autoload"); if (n == NULL) break; if (n > p && vim_ispathsep(n[-1]) && vim_ispathsep(n[8])) res = n + 9; p = n + 8; } return res; } /* * For an autoload script "autoload/dir/script.vim" return the prefix * "dir#script#" in allocated memory. * Returns NULL if anything is wrong. */ char_u * get_autoload_prefix(scriptitem_T *si) { char_u *p = script_name_after_autoload(si); char_u *prefix; if (p == NULL) return NULL; prefix = vim_strsave(p); if (prefix == NULL) return NULL; // replace all '/' with '#' and locate ".vim" at the end for (p = prefix; *p != NUL; p += mb_ptr2len(p)) { if (vim_ispathsep(*p)) *p = '#'; else if (STRCMP(p, ".vim") == 0) { p[0] = '#'; p[1] = NUL; return prefix; } } // did not find ".vim" at the end vim_free(prefix); return NULL; } /* * If in a Vim9 autoload script return "name" with the autoload prefix for the * script. If successful the returned name is allocated. * Otherwise it returns "name" unmodified. */ char_u * may_prefix_autoload(char_u *name) { if (SCRIPT_ID_VALID(current_sctx.sc_sid)) { scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid); if (si->sn_autoload_prefix != NULL) { char_u *basename = name; size_t len; char_u *res; if (*name == K_SPECIAL) { char_u *p = vim_strchr(name, '_'); // skip over "<SNR>99_" if (p != NULL) basename = p + 1; } len = STRLEN(si->sn_autoload_prefix) + STRLEN(basename) + 2; res = alloc(len); if (res != NULL) { vim_snprintf((char *)res, len, "%s%s", si->sn_autoload_prefix, basename); return res; } } } return name; } /* * Return the autoload script name for a function or variable name. * Returns NULL when out of memory. * Caller must make sure that "name" contains AUTOLOAD_CHAR. */ char_u * autoload_name(char_u *name) { char_u *p, *q = NULL; char_u *scriptname; // Get the script file name: replace '#' with '/', append ".vim". scriptname = alloc(STRLEN(name) + 14); if (scriptname == NULL) return NULL; STRCPY(scriptname, "autoload/"); STRCAT(scriptname, name[0] == 'g' && name[1] == ':' ? name + 2: name); for (p = scriptname + 9; (p = vim_strchr(p, AUTOLOAD_CHAR)) != NULL; q = p, ++p) *p = '/'; STRCPY(q, ".vim"); return scriptname; } /* * If "name" has a package name try autoloading the script for it. * Return TRUE if a package was loaded. */ int script_autoload( char_u *name, int reload) // load script again when already loaded { char_u *p; char_u *scriptname, *tofree; int ret = FALSE; int i; int ret_sid; // If the name starts with "<SNR>123_" then "123" is the script ID. if (name[0] == K_SPECIAL && name[1] == KS_EXTRA && name[2] == KE_SNR) { p = name + 3; ret_sid = (int)getdigits(&p); if (*p == '_' && SCRIPT_ID_VALID(ret_sid)) { may_load_script(ret_sid, &ret); return ret; } } // If there is no '#' after name[0] there is no package name. p = vim_strchr(name, AUTOLOAD_CHAR); if (p == NULL || p == name) return FALSE; tofree = scriptname = autoload_name(name); if (scriptname == NULL) return FALSE; // Find the name in the list of previously loaded package names. Skip // "autoload/", it's always the same. for (i = 0; i < ga_loaded.ga_len; ++i) if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0) break; if (!reload && i < ga_loaded.ga_len) ret = FALSE; // was loaded already else { // Remember the name if it wasn't loaded already. if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK) { ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname; tofree = NULL; } // Try loading the package from $VIMRUNTIME/autoload/<name>.vim // Use "ret_sid" to avoid loading the same script again. if (source_in_path(p_rtp, scriptname, DIP_START, &ret_sid) == OK) ret = TRUE; } vim_free(tofree); return ret; } #endif