diff options
author | Yegappan Lakshmanan <yegappan@yahoo.com> | 2022-08-28 18:52:10 +0100 |
---|---|---|
committer | Bram Moolenaar <Bram@vim.org> | 2022-08-28 18:52:10 +0100 |
commit | 2f892d8663498c21296ad6661dac1bb8372cfd10 (patch) | |
tree | 96b4bed89d8d4237fc46370fa227f086944e514f /src | |
parent | 75e9a6693e8d0126b5fff42203bfba9428cd19ae (diff) |
patch 9.0.0303: it is not easy to get information about a scriptv9.0.0303
Problem: It is not easy to get information about a script.
Solution: Make getscriptinf() return the version. When selecting a specific
script return functions and variables. (Yegappan Lakshmanan,
closes #10991)
Diffstat (limited to 'src')
-rw-r--r-- | src/scriptfile.c | 83 | ||||
-rw-r--r-- | src/testdir/test_scriptnames.vim | 39 | ||||
-rw-r--r-- | src/testdir/test_vim9_builtin.vim | 40 | ||||
-rw-r--r-- | src/testdir/test_vim9_import.vim | 1 | ||||
-rw-r--r-- | src/userfunc.c | 2 | ||||
-rw-r--r-- | src/version.c | 2 |
6 files changed, 158 insertions, 9 deletions
diff --git a/src/scriptfile.c b/src/scriptfile.c index a2b88a65aa..34683262a5 100644 --- a/src/scriptfile.c +++ b/src/scriptfile.c @@ -1947,6 +1947,53 @@ get_sourced_lnum( } /* + * Return a List of script-local functions defined in the script with id + * 'sid'. + */ + static list_T * +get_script_local_funcs(scid_T sid) +{ + hashtab_T *functbl; + hashitem_T *hi; + long_u todo; + list_T *l; + + l = list_alloc(); + if (l == NULL) + return NULL; + + // Iterate through all the functions in the global function hash table + // looking for functions with script ID 'sid'. + functbl = func_tbl_get(); + todo = functbl->ht_used; + for (hi = functbl->ht_array; todo > 0; ++hi) + { + ufunc_T *fp; + + if (HASHITEM_EMPTY(hi)) + continue; + + --todo; + fp = HI2UF(hi); + + // Add active functions with script id == 'sid' + if (!(fp->uf_flags & FC_DEAD) && (fp->uf_script_ctx.sc_sid == sid)) + { + char_u *name; + + if (fp->uf_name_exp != NULL) + name = fp->uf_name_exp; + else + name = fp->uf_name; + + list_append_string(l, name, -1); + } + } + + return l; +} + +/* * getscriptinfo() function */ void @@ -1956,6 +2003,8 @@ f_getscriptinfo(typval_T *argvars, typval_T *rettv) list_T *l; char_u *pat = NULL; regmatch_T regmatch; + int filterpat = FALSE; + scid_T sid = -1; if (rettv_list_alloc(rettv) == FAIL) return; @@ -1970,9 +2019,15 @@ f_getscriptinfo(typval_T *argvars, typval_T *rettv) if (argvars[0].v_type == VAR_DICT) { - pat = dict_get_string(argvars[0].vval.v_dict, "name", TRUE); - if (pat != NULL) - regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING); + sid = dict_get_number_def(argvars[0].vval.v_dict, "sid", -1); + if (sid == -1) + { + pat = dict_get_string(argvars[0].vval.v_dict, "name", TRUE); + if (pat != NULL) + regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING); + if (regmatch.regprog != NULL) + filterpat = TRUE; + } } for (i = 1; i <= script_items.ga_len; ++i) @@ -1983,8 +2038,10 @@ f_getscriptinfo(typval_T *argvars, typval_T *rettv) if (si->sn_name == NULL) continue; - if (pat != NULL && regmatch.regprog != NULL - && !vim_regexec(®match, si->sn_name, (colnr_T)0)) + if (filterpat && !vim_regexec(®match, si->sn_name, (colnr_T)0)) + continue; + + if (sid != -1 && sid != i) continue; if ((d = dict_alloc()) == NULL @@ -1996,6 +2053,22 @@ f_getscriptinfo(typval_T *argvars, typval_T *rettv) || dict_add_bool(d, "autoload", si->sn_state == SN_STATE_NOT_LOADED) == FAIL) return; + + // When a filter pattern is specified to return information about only + // specific script(s), also add the script-local variables and + // functions. + if (sid != -1) + { + dict_T *var_dict; + + var_dict = dict_copy(&si->sn_vars->sv_dict, TRUE, TRUE, + get_copyID()); + if (var_dict == NULL + || dict_add_dict(d, "variables", var_dict) == FAIL + || dict_add_list(d, "functions", + get_script_local_funcs(sid)) == FAIL) + return; + } } vim_regfree(regmatch.regprog); diff --git a/src/testdir/test_scriptnames.vim b/src/testdir/test_scriptnames.vim index 2d8ee61867..b558af5b4d 100644 --- a/src/testdir/test_scriptnames.vim +++ b/src/testdir/test_scriptnames.vim @@ -32,20 +32,53 @@ endfunc " Test for the getscriptinfo() function func Test_getscriptinfo() let lines =<< trim END + scriptversion 3 let g:loaded_script_id = expand("<SID>") let s:XscriptVar = [1, #{v: 2}] - func s:XscriptFunc() + func s:XgetScriptVar() + return s:XscriptVar endfunc + func s:Xscript_legacy_func1() + endfunc + def s:Xscript_def_func1() + enddef + func Xscript_legacy_func2() + endfunc + def Xscript_def_func2() + enddef END call writefile(lines, 'X22script91') source X22script91 let l = getscriptinfo() call assert_match('X22script91$', l[-1].name) call assert_equal(g:loaded_script_id, $"<SNR>{l[-1].sid}_") + call assert_equal(3, l[-1].version) + call assert_equal(0, has_key(l[-1], 'variables')) + call assert_equal(0, has_key(l[-1], 'functions')) - let l = getscriptinfo({'name': '22script91'}) + " Get script information using script name + let l = getscriptinfo(#{name: '22script91'}) call assert_equal(1, len(l)) call assert_match('22script91$', l[0].name) + let sid = l[0].sid + + " Get script information using script-ID + let l = getscriptinfo({'sid': sid}) + call assert_equal(#{XscriptVar: [1, {'v': 2}]}, l[0].variables) + let funcs = ['Xscript_legacy_func2', + \ $"<SNR>{sid}_Xscript_legacy_func1", + \ $"<SNR>{sid}_Xscript_def_func1", + \ 'Xscript_def_func2', + \ $"<SNR>{sid}_XgetScriptVar"] + for f in funcs + call assert_true(index(l[0].functions, f) != -1) + endfor + + " Verify that a script-local variable cannot be modified using the dict + " returned by getscriptinfo() + let l[0].variables.XscriptVar = ['n'] + let funcname = $"<SNR>{sid}_XgetScriptVar" + call assert_equal([1, {'v': 2}], call(funcname, [])) let l = getscriptinfo({'name': 'foobar'}) call assert_equal(0, len(l)) @@ -58,6 +91,8 @@ func Test_getscriptinfo() call assert_true(len(l) > 1) call assert_fails("echo getscriptinfo('foobar')", 'E1206:') + call assert_fails("echo getscriptinfo({'sid': []})", 'E745:') + call delete('X22script91') endfunc diff --git a/src/testdir/test_vim9_builtin.vim b/src/testdir/test_vim9_builtin.vim index e3ebc3e587..d68ddce7aa 100644 --- a/src/testdir/test_vim9_builtin.vim +++ b/src/testdir/test_vim9_builtin.vim @@ -1898,6 +1898,46 @@ enddef def Test_getscriptinfo() v9.CheckDefAndScriptFailure(['getscriptinfo("x")'], ['E1013: Argument 1: type mismatch, expected dict<any> but got string', 'E1206: Dictionary required for argument 1']) + + var lines1 =<< trim END + vim9script + g:loaded_script_id = expand("<SID>") + var XscriptVar = [1, {v: 2}] + func XgetScriptVar() + return XscriptVar + endfunc + func Xscript_legacy_func1() + endfunc + def Xscript_def_func1() + enddef + func g:Xscript_legacy_func2() + endfunc + def g:Xscript_def_func2() + enddef + END + writefile(lines1, 'X22script92') + + var lines2 =<< trim END + source X22script92 + var sid = matchstr(g:loaded_script_id, '<SNR>\zs\d\+\ze_')->str2nr() + + var l = getscriptinfo({sid: sid, name: 'ignored'}) + assert_match('X22script92$', l[0].name) + assert_equal(g:loaded_script_id, $"<SNR>{l[0].sid}_") + assert_equal(999999, l[0].version) + assert_equal(0, l[0].sourced) + assert_equal({XscriptVar: [1, {v: 2}]}, l[0].variables) + var funcs = ['Xscript_legacy_func2', + $"<SNR>{sid}_Xscript_legacy_func1", + $"<SNR>{sid}_Xscript_def_func1", + 'Xscript_def_func2', + $"<SNR>{sid}_XgetScriptVar"] + for f in funcs + assert_true(index(l[0].functions, f) != -1) + endfor + END + v9.CheckDefAndScriptSuccess(lines2) + delete('X22script92') enddef def Test_gettabinfo() diff --git a/src/testdir/test_vim9_import.vim b/src/testdir/test_vim9_import.vim index 832fad8d74..ed4e9d2ffd 100644 --- a/src/testdir/test_vim9_import.vim +++ b/src/testdir/test_vim9_import.vim @@ -741,6 +741,7 @@ def Test_use_relative_autoload_import_in_mapping() assert_true(len(l) == 1) assert_match('XrelautoloadExport.vim$', l[0].name) assert_false(l[0].autoload) + assert_equal(999999, l[0].version) unlet g:result delete('XrelautoloadExport.vim') diff --git a/src/userfunc.c b/src/userfunc.c index e0bdc3fda9..00c17b8c00 100644 --- a/src/userfunc.c +++ b/src/userfunc.c @@ -40,7 +40,6 @@ func_init() hash_init(&func_hashtab); } -#if defined(FEAT_PROFILE) || defined(PROTO) /* * Return the function hash table */ @@ -49,7 +48,6 @@ func_tbl_get(void) { return &func_hashtab; } -#endif /* * Get one function argument. diff --git a/src/version.c b/src/version.c index 275492f3af..bdc26b3afe 100644 --- a/src/version.c +++ b/src/version.c @@ -708,6 +708,8 @@ static char *(features[]) = static int included_patches[] = { /* Add new patch number below this line */ /**/ + 303, +/**/ 302, /**/ 301, |