blob: 793f5632c2271d8b91901d54526cac6a2dbba32e [file] [log] [blame]
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001/* vi:set ts=8 sts=4 sw=4 noet:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * evalvars.c: functions for dealing with variables
12 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
17
Bram Moolenaare5cdf152019-08-29 22:09:46 +020018static dictitem_T globvars_var; // variable used for g:
Bram Moolenaarda6c0332019-09-01 16:01:30 +020019static dict_T globvardict; // Dictionary with g: variables
20#define globvarht globvardict.dv_hashtab
Bram Moolenaare5cdf152019-08-29 22:09:46 +020021
22/*
23 * Old Vim variables such as "v:version" are also available without the "v:".
24 * Also in functions. We need a special hashtable for them.
25 */
26static hashtab_T compat_hashtab;
27
28/*
29 * Array to hold the value of v: variables.
30 * The value is in a dictitem, so that it can also be used in the v: scope.
31 * The reason to use this table anyway is for very quick access to the
32 * variables with the VV_ defines.
33 */
34
35// values for vv_flags:
36#define VV_COMPAT 1 // compatible, also used without "v:"
37#define VV_RO 2 // read-only
38#define VV_RO_SBX 4 // read-only in the sandbox
39
40#define VV_NAME(s, t) s, {{t, 0, {0}}, 0, {0}}
41
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010042typedef struct vimvar vimvar_T;
43
Bram Moolenaare5cdf152019-08-29 22:09:46 +020044static struct vimvar
45{
46 char *vv_name; // name of variable, without v:
47 dictitem16_T vv_di; // value and name for key (max 16 chars!)
Bram Moolenaard787e402021-12-24 21:36:12 +000048 type_T *vv_type; // type or NULL
Bram Moolenaare5cdf152019-08-29 22:09:46 +020049 char vv_flags; // VV_COMPAT, VV_RO, VV_RO_SBX
50} vimvars[VV_LEN] =
51{
Bram Moolenaar8d71b542019-08-30 15:46:30 +020052 // The order here must match the VV_ defines in vim.h!
53 // Initializing a union does not work, leave tv.vval empty to get zero's.
Bram Moolenaard787e402021-12-24 21:36:12 +000054 {VV_NAME("count", VAR_NUMBER), NULL, VV_COMPAT+VV_RO},
55 {VV_NAME("count1", VAR_NUMBER), NULL, VV_RO},
56 {VV_NAME("prevcount", VAR_NUMBER), NULL, VV_RO},
57 {VV_NAME("errmsg", VAR_STRING), NULL, VV_COMPAT},
58 {VV_NAME("warningmsg", VAR_STRING), NULL, 0},
59 {VV_NAME("statusmsg", VAR_STRING), NULL, 0},
60 {VV_NAME("shell_error", VAR_NUMBER), NULL, VV_COMPAT+VV_RO},
61 {VV_NAME("this_session", VAR_STRING), NULL, VV_COMPAT},
62 {VV_NAME("version", VAR_NUMBER), NULL, VV_COMPAT+VV_RO},
63 {VV_NAME("lnum", VAR_NUMBER), NULL, VV_RO_SBX},
64 {VV_NAME("termresponse", VAR_STRING), NULL, VV_RO},
65 {VV_NAME("fname", VAR_STRING), NULL, VV_RO},
66 {VV_NAME("lang", VAR_STRING), NULL, VV_RO},
67 {VV_NAME("lc_time", VAR_STRING), NULL, VV_RO},
68 {VV_NAME("ctype", VAR_STRING), NULL, VV_RO},
69 {VV_NAME("charconvert_from", VAR_STRING), NULL, VV_RO},
70 {VV_NAME("charconvert_to", VAR_STRING), NULL, VV_RO},
71 {VV_NAME("fname_in", VAR_STRING), NULL, VV_RO},
72 {VV_NAME("fname_out", VAR_STRING), NULL, VV_RO},
73 {VV_NAME("fname_new", VAR_STRING), NULL, VV_RO},
74 {VV_NAME("fname_diff", VAR_STRING), NULL, VV_RO},
75 {VV_NAME("cmdarg", VAR_STRING), NULL, VV_RO},
76 {VV_NAME("foldstart", VAR_NUMBER), NULL, VV_RO_SBX},
77 {VV_NAME("foldend", VAR_NUMBER), NULL, VV_RO_SBX},
78 {VV_NAME("folddashes", VAR_STRING), NULL, VV_RO_SBX},
79 {VV_NAME("foldlevel", VAR_NUMBER), NULL, VV_RO_SBX},
80 {VV_NAME("progname", VAR_STRING), NULL, VV_RO},
81 {VV_NAME("servername", VAR_STRING), NULL, VV_RO},
82 {VV_NAME("dying", VAR_NUMBER), NULL, VV_RO},
83 {VV_NAME("exception", VAR_STRING), NULL, VV_RO},
84 {VV_NAME("throwpoint", VAR_STRING), NULL, VV_RO},
85 {VV_NAME("register", VAR_STRING), NULL, VV_RO},
86 {VV_NAME("cmdbang", VAR_NUMBER), NULL, VV_RO},
87 {VV_NAME("insertmode", VAR_STRING), NULL, VV_RO},
88 {VV_NAME("val", VAR_UNKNOWN), NULL, VV_RO},
89 {VV_NAME("key", VAR_UNKNOWN), NULL, VV_RO},
90 {VV_NAME("profiling", VAR_NUMBER), NULL, VV_RO},
91 {VV_NAME("fcs_reason", VAR_STRING), NULL, VV_RO},
92 {VV_NAME("fcs_choice", VAR_STRING), NULL, 0},
93 {VV_NAME("beval_bufnr", VAR_NUMBER), NULL, VV_RO},
94 {VV_NAME("beval_winnr", VAR_NUMBER), NULL, VV_RO},
95 {VV_NAME("beval_winid", VAR_NUMBER), NULL, VV_RO},
96 {VV_NAME("beval_lnum", VAR_NUMBER), NULL, VV_RO},
97 {VV_NAME("beval_col", VAR_NUMBER), NULL, VV_RO},
98 {VV_NAME("beval_text", VAR_STRING), NULL, VV_RO},
99 {VV_NAME("scrollstart", VAR_STRING), NULL, 0},
100 {VV_NAME("swapname", VAR_STRING), NULL, VV_RO},
101 {VV_NAME("swapchoice", VAR_STRING), NULL, 0},
102 {VV_NAME("swapcommand", VAR_STRING), NULL, VV_RO},
103 {VV_NAME("char", VAR_STRING), NULL, 0},
104 {VV_NAME("mouse_win", VAR_NUMBER), NULL, 0},
105 {VV_NAME("mouse_winid", VAR_NUMBER), NULL, 0},
106 {VV_NAME("mouse_lnum", VAR_NUMBER), NULL, 0},
107 {VV_NAME("mouse_col", VAR_NUMBER), NULL, 0},
108 {VV_NAME("operator", VAR_STRING), NULL, VV_RO},
109 {VV_NAME("searchforward", VAR_NUMBER), NULL, 0},
110 {VV_NAME("hlsearch", VAR_NUMBER), NULL, 0},
111 {VV_NAME("oldfiles", VAR_LIST), &t_list_string, 0},
112 {VV_NAME("windowid", VAR_NUMBER), NULL, VV_RO},
113 {VV_NAME("progpath", VAR_STRING), NULL, VV_RO},
Shougo Matsushita61021aa2022-07-27 14:40:00 +0100114 {VV_NAME("completed_item", VAR_DICT), &t_dict_string, 0},
Bram Moolenaard787e402021-12-24 21:36:12 +0000115 {VV_NAME("option_new", VAR_STRING), NULL, VV_RO},
116 {VV_NAME("option_old", VAR_STRING), NULL, VV_RO},
117 {VV_NAME("option_oldlocal", VAR_STRING), NULL, VV_RO},
118 {VV_NAME("option_oldglobal", VAR_STRING), NULL, VV_RO},
119 {VV_NAME("option_command", VAR_STRING), NULL, VV_RO},
120 {VV_NAME("option_type", VAR_STRING), NULL, VV_RO},
121 {VV_NAME("errors", VAR_LIST), &t_list_string, 0},
122 {VV_NAME("false", VAR_BOOL), NULL, VV_RO},
123 {VV_NAME("true", VAR_BOOL), NULL, VV_RO},
124 {VV_NAME("none", VAR_SPECIAL), NULL, VV_RO},
125 {VV_NAME("null", VAR_SPECIAL), NULL, VV_RO},
126 {VV_NAME("numbermax", VAR_NUMBER), NULL, VV_RO},
127 {VV_NAME("numbermin", VAR_NUMBER), NULL, VV_RO},
128 {VV_NAME("numbersize", VAR_NUMBER), NULL, VV_RO},
129 {VV_NAME("vim_did_enter", VAR_NUMBER), NULL, VV_RO},
130 {VV_NAME("testing", VAR_NUMBER), NULL, 0},
131 {VV_NAME("t_number", VAR_NUMBER), NULL, VV_RO},
132 {VV_NAME("t_string", VAR_NUMBER), NULL, VV_RO},
133 {VV_NAME("t_func", VAR_NUMBER), NULL, VV_RO},
134 {VV_NAME("t_list", VAR_NUMBER), NULL, VV_RO},
135 {VV_NAME("t_dict", VAR_NUMBER), NULL, VV_RO},
136 {VV_NAME("t_float", VAR_NUMBER), NULL, VV_RO},
137 {VV_NAME("t_bool", VAR_NUMBER), NULL, VV_RO},
138 {VV_NAME("t_none", VAR_NUMBER), NULL, VV_RO},
139 {VV_NAME("t_job", VAR_NUMBER), NULL, VV_RO},
140 {VV_NAME("t_channel", VAR_NUMBER), NULL, VV_RO},
141 {VV_NAME("t_blob", VAR_NUMBER), NULL, VV_RO},
142 {VV_NAME("termrfgresp", VAR_STRING), NULL, VV_RO},
143 {VV_NAME("termrbgresp", VAR_STRING), NULL, VV_RO},
144 {VV_NAME("termu7resp", VAR_STRING), NULL, VV_RO},
145 {VV_NAME("termstyleresp", VAR_STRING), NULL, VV_RO},
146 {VV_NAME("termblinkresp", VAR_STRING), NULL, VV_RO},
147 {VV_NAME("event", VAR_DICT), NULL, VV_RO},
148 {VV_NAME("versionlong", VAR_NUMBER), NULL, VV_RO},
149 {VV_NAME("echospace", VAR_NUMBER), NULL, VV_RO},
150 {VV_NAME("argv", VAR_LIST), &t_list_string, VV_RO},
151 {VV_NAME("collate", VAR_STRING), NULL, VV_RO},
152 {VV_NAME("exiting", VAR_SPECIAL), NULL, VV_RO},
153 {VV_NAME("colornames", VAR_DICT), &t_dict_string, VV_RO},
154 {VV_NAME("sizeofint", VAR_NUMBER), NULL, VV_RO},
155 {VV_NAME("sizeoflong", VAR_NUMBER), NULL, VV_RO},
156 {VV_NAME("sizeofpointer", VAR_NUMBER), NULL, VV_RO},
naohiro ono56200ee2022-01-01 14:59:44 +0000157 {VV_NAME("maxcol", VAR_NUMBER), NULL, VV_RO},
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200158};
159
160// shorthand
Bram Moolenaard787e402021-12-24 21:36:12 +0000161#define vv_tv_type vv_di.di_tv.v_type
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200162#define vv_nr vv_di.di_tv.vval.v_number
163#define vv_float vv_di.di_tv.vval.v_float
164#define vv_str vv_di.di_tv.vval.v_string
165#define vv_list vv_di.di_tv.vval.v_list
166#define vv_dict vv_di.di_tv.vval.v_dict
167#define vv_blob vv_di.di_tv.vval.v_blob
168#define vv_tv vv_di.di_tv
169
170static dictitem_T vimvars_var; // variable used for v:
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200171static dict_T vimvardict; // Dictionary with v: variables
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200172#define vimvarht vimvardict.dv_hashtab
173
174// for VIM_VERSION_ defines
175#include "version.h"
176
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200177static void list_glob_vars(int *first);
178static void list_buf_vars(int *first);
179static void list_win_vars(int *first);
180static void list_tab_vars(int *first);
181static char_u *list_arg_vars(exarg_T *eap, char_u *arg, int *first);
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100182static char_u *ex_let_one(char_u *arg, typval_T *tv, int copy, int flags, char_u *endchars, char_u *op, int var_idx);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +0200183static int do_unlet_var(lval_T *lp, char_u *name_end, exarg_T *eap, int deep, void *cookie);
184static int do_lock_var(lval_T *lp, char_u *name_end, exarg_T *eap, int deep, void *cookie);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200185static void list_one_var(dictitem_T *v, char *prefix, int *first);
186static void list_one_var_a(char *prefix, char_u *name, int type, char_u *string, int *first);
187
188/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200189 * Initialize global and vim special variables
190 */
191 void
192evalvars_init(void)
193{
194 int i;
195 struct vimvar *p;
196
197 init_var_dict(&globvardict, &globvars_var, VAR_DEF_SCOPE);
198 init_var_dict(&vimvardict, &vimvars_var, VAR_SCOPE);
199 vimvardict.dv_lock = VAR_FIXED;
200 hash_init(&compat_hashtab);
201
202 for (i = 0; i < VV_LEN; ++i)
203 {
204 p = &vimvars[i];
205 if (STRLEN(p->vv_name) > DICTITEM16_KEY_LEN)
206 {
207 iemsg("INTERNAL: name too long, increase size of dictitem16_T");
208 getout(1);
209 }
210 STRCPY(p->vv_di.di_key, p->vv_name);
211 if (p->vv_flags & VV_RO)
212 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
213 else if (p->vv_flags & VV_RO_SBX)
214 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
215 else
216 p->vv_di.di_flags = DI_FLAGS_FIX;
217
218 // add to v: scope dict, unless the value is not always available
Bram Moolenaard787e402021-12-24 21:36:12 +0000219 if (p->vv_tv_type != VAR_UNKNOWN)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200220 hash_add(&vimvarht, p->vv_di.di_key);
221 if (p->vv_flags & VV_COMPAT)
222 // add to compat scope dict
223 hash_add(&compat_hashtab, p->vv_di.di_key);
224 }
Bram Moolenaar016faaa2020-10-03 12:57:27 +0200225 set_vim_var_nr(VV_VERSION, VIM_VERSION_100);
226 set_vim_var_nr(VV_VERSIONLONG, VIM_VERSION_100 * 10000 + highest_patch());
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200227
228 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
229 set_vim_var_nr(VV_HLSEARCH, 1L);
Bram Moolenaarf0068c52020-11-30 17:42:10 +0100230 set_vim_var_nr(VV_EXITING, VVAL_NULL);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200231 set_vim_var_dict(VV_COMPLETED_ITEM, dict_alloc_lock(VAR_FIXED));
232 set_vim_var_list(VV_ERRORS, list_alloc());
233 set_vim_var_dict(VV_EVENT, dict_alloc_lock(VAR_FIXED));
234
235 set_vim_var_nr(VV_FALSE, VVAL_FALSE);
236 set_vim_var_nr(VV_TRUE, VVAL_TRUE);
237 set_vim_var_nr(VV_NONE, VVAL_NONE);
238 set_vim_var_nr(VV_NULL, VVAL_NULL);
Bram Moolenaar57d5a012021-01-21 21:42:31 +0100239 set_vim_var_nr(VV_NUMBERMAX, VARNUM_MAX);
240 set_vim_var_nr(VV_NUMBERMIN, VARNUM_MIN);
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100241 set_vim_var_nr(VV_NUMBERSIZE, sizeof(varnumber_T) * 8);
Bram Moolenaar69b30722021-11-02 21:39:49 +0000242 set_vim_var_nr(VV_SIZEOFINT, sizeof(int));
243 set_vim_var_nr(VV_SIZEOFLONG, sizeof(long));
244 set_vim_var_nr(VV_SIZEOFPOINTER, sizeof(char *));
naohiro ono56200ee2022-01-01 14:59:44 +0000245 set_vim_var_nr(VV_MAXCOL, MAXCOL);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200246
247 set_vim_var_nr(VV_TYPE_NUMBER, VAR_TYPE_NUMBER);
248 set_vim_var_nr(VV_TYPE_STRING, VAR_TYPE_STRING);
249 set_vim_var_nr(VV_TYPE_FUNC, VAR_TYPE_FUNC);
250 set_vim_var_nr(VV_TYPE_LIST, VAR_TYPE_LIST);
251 set_vim_var_nr(VV_TYPE_DICT, VAR_TYPE_DICT);
252 set_vim_var_nr(VV_TYPE_FLOAT, VAR_TYPE_FLOAT);
253 set_vim_var_nr(VV_TYPE_BOOL, VAR_TYPE_BOOL);
254 set_vim_var_nr(VV_TYPE_NONE, VAR_TYPE_NONE);
255 set_vim_var_nr(VV_TYPE_JOB, VAR_TYPE_JOB);
256 set_vim_var_nr(VV_TYPE_CHANNEL, VAR_TYPE_CHANNEL);
257 set_vim_var_nr(VV_TYPE_BLOB, VAR_TYPE_BLOB);
258
259 set_vim_var_nr(VV_ECHOSPACE, sc_col - 1);
260
Drew Vogele30d1022021-10-24 20:35:07 +0100261 set_vim_var_dict(VV_COLORNAMES, dict_alloc());
262
Bram Moolenaar439c0362020-06-06 15:58:03 +0200263 // Default for v:register is not 0 but '"'. This is adjusted once the
264 // clipboard has been setup by calling reset_reg_var().
265 set_reg_var(0);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200266}
267
268#if defined(EXITFREE) || defined(PROTO)
269/*
270 * Free all vim variables information on exit
271 */
272 void
273evalvars_clear(void)
274{
275 int i;
276 struct vimvar *p;
277
278 for (i = 0; i < VV_LEN; ++i)
279 {
280 p = &vimvars[i];
281 if (p->vv_di.di_tv.v_type == VAR_STRING)
282 VIM_CLEAR(p->vv_str);
283 else if (p->vv_di.di_tv.v_type == VAR_LIST)
284 {
285 list_unref(p->vv_list);
286 p->vv_list = NULL;
287 }
288 }
289 hash_clear(&vimvarht);
290 hash_init(&vimvarht); // garbage_collect() will access it
291 hash_clear(&compat_hashtab);
292
293 // global variables
294 vars_clear(&globvarht);
295
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100296 // Script-local variables. Clear all the variables here.
297 // The scriptvar_T is cleared later in free_scriptnames(), because a
298 // variable in one script might hold a reference to the whole scope of
299 // another script.
300 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200301 vars_clear(&SCRIPT_VARS(i));
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200302}
303#endif
304
305 int
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200306garbage_collect_globvars(int copyID)
307{
308 return set_ref_in_ht(&globvarht, copyID, NULL);
309}
310
311 int
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200312garbage_collect_vimvars(int copyID)
313{
314 return set_ref_in_ht(&vimvarht, copyID, NULL);
315}
316
317 int
318garbage_collect_scriptvars(int copyID)
319{
Bram Moolenaared234f22020-10-15 20:42:20 +0200320 int i;
321 int idx;
322 int abort = FALSE;
323 scriptitem_T *si;
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200324
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100325 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaared234f22020-10-15 20:42:20 +0200326 {
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200327 abort = abort || set_ref_in_ht(&SCRIPT_VARS(i), copyID, NULL);
328
Bram Moolenaared234f22020-10-15 20:42:20 +0200329 si = SCRIPT_ITEM(i);
330 for (idx = 0; idx < si->sn_var_vals.ga_len; ++idx)
331 {
332 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + idx;
333
Bram Moolenaard00a7fb2021-03-08 20:47:14 +0100334 if (sv->sv_name != NULL)
335 abort = abort || set_ref_in_item(sv->sv_tv, copyID, NULL, NULL);
Bram Moolenaared234f22020-10-15 20:42:20 +0200336 }
337 }
338
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200339 return abort;
340}
341
342/*
343 * Set an internal variable to a string value. Creates the variable if it does
344 * not already exist.
345 */
346 void
347set_internal_string_var(char_u *name, char_u *value)
348{
349 char_u *val;
350 typval_T *tvp;
351
352 val = vim_strsave(value);
353 if (val != NULL)
354 {
355 tvp = alloc_string_tv(val);
356 if (tvp != NULL)
357 {
358 set_var(name, tvp, FALSE);
359 free_tv(tvp);
360 }
361 }
362}
363
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200364 int
365eval_charconvert(
366 char_u *enc_from,
367 char_u *enc_to,
368 char_u *fname_from,
369 char_u *fname_to)
370{
371 int err = FALSE;
Bram Moolenaarf4e88f22022-01-23 14:17:28 +0000372 sctx_T saved_sctx = current_sctx;
373 sctx_T *ctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200374
375 set_vim_var_string(VV_CC_FROM, enc_from, -1);
376 set_vim_var_string(VV_CC_TO, enc_to, -1);
377 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
378 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
Bram Moolenaarf4e88f22022-01-23 14:17:28 +0000379 ctx = get_option_sctx("charconvert");
380 if (ctx != NULL)
381 current_sctx = *ctx;
382
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100383 if (eval_to_bool(p_ccv, &err, NULL, FALSE, TRUE))
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200384 err = TRUE;
Bram Moolenaarf4e88f22022-01-23 14:17:28 +0000385
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200386 set_vim_var_string(VV_CC_FROM, NULL, -1);
387 set_vim_var_string(VV_CC_TO, NULL, -1);
388 set_vim_var_string(VV_FNAME_IN, NULL, -1);
389 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
Bram Moolenaarf4e88f22022-01-23 14:17:28 +0000390 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200391
392 if (err)
393 return FAIL;
394 return OK;
395}
396
397# if defined(FEAT_POSTSCRIPT) || defined(PROTO)
398 int
399eval_printexpr(char_u *fname, char_u *args)
400{
401 int err = FALSE;
Bram Moolenaar7ef4a2f2022-01-23 13:44:35 +0000402 sctx_T saved_sctx = current_sctx;
403 sctx_T *ctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200404
405 set_vim_var_string(VV_FNAME_IN, fname, -1);
406 set_vim_var_string(VV_CMDARG, args, -1);
Bram Moolenaar7ef4a2f2022-01-23 13:44:35 +0000407 ctx = get_option_sctx("printexpr");
408 if (ctx != NULL)
409 current_sctx = *ctx;
410
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100411 if (eval_to_bool(p_pexpr, &err, NULL, FALSE, TRUE))
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200412 err = TRUE;
Bram Moolenaar7ef4a2f2022-01-23 13:44:35 +0000413
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200414 set_vim_var_string(VV_FNAME_IN, NULL, -1);
415 set_vim_var_string(VV_CMDARG, NULL, -1);
Bram Moolenaar7ef4a2f2022-01-23 13:44:35 +0000416 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200417
418 if (err)
419 {
420 mch_remove(fname);
421 return FAIL;
422 }
423 return OK;
424}
425# endif
426
427# if defined(FEAT_DIFF) || defined(PROTO)
428 void
429eval_diff(
430 char_u *origfile,
431 char_u *newfile,
432 char_u *outfile)
433{
Bram Moolenaar7b29f6a2022-01-22 17:58:13 +0000434 sctx_T saved_sctx = current_sctx;
435 sctx_T *ctx;
436 typval_T *tv;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200437
438 set_vim_var_string(VV_FNAME_IN, origfile, -1);
439 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
440 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
Bram Moolenaar7b29f6a2022-01-22 17:58:13 +0000441
442 ctx = get_option_sctx("diffexpr");
443 if (ctx != NULL)
444 current_sctx = *ctx;
445
446 // errors are ignored
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100447 tv = eval_expr_ext(p_dex, NULL, TRUE);
Bram Moolenaar39b89442022-01-22 18:21:36 +0000448 free_tv(tv);
Bram Moolenaar7b29f6a2022-01-22 17:58:13 +0000449
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200450 set_vim_var_string(VV_FNAME_IN, NULL, -1);
451 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
452 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
Bram Moolenaar7b29f6a2022-01-22 17:58:13 +0000453 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200454}
455
456 void
457eval_patch(
458 char_u *origfile,
459 char_u *difffile,
460 char_u *outfile)
461{
Bram Moolenaar36c2add2022-01-22 20:55:30 +0000462 sctx_T saved_sctx = current_sctx;
463 sctx_T *ctx;
464 typval_T *tv;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200465
466 set_vim_var_string(VV_FNAME_IN, origfile, -1);
467 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
468 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
Bram Moolenaar36c2add2022-01-22 20:55:30 +0000469
470 ctx = get_option_sctx("patchexpr");
471 if (ctx != NULL)
472 current_sctx = *ctx;
473
474 // errors are ignored
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100475 tv = eval_expr_ext(p_pex, NULL, TRUE);
Bram Moolenaar36c2add2022-01-22 20:55:30 +0000476 free_tv(tv);
477
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200478 set_vim_var_string(VV_FNAME_IN, NULL, -1);
479 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
480 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
Bram Moolenaar36c2add2022-01-22 20:55:30 +0000481 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200482}
483# endif
484
485#if defined(FEAT_SPELL) || defined(PROTO)
486/*
487 * Evaluate an expression to a list with suggestions.
488 * For the "expr:" part of 'spellsuggest'.
489 * Returns NULL when there is an error.
490 */
491 list_T *
492eval_spell_expr(char_u *badword, char_u *expr)
493{
494 typval_T save_val;
495 typval_T rettv;
496 list_T *list = NULL;
497 char_u *p = skipwhite(expr);
Bram Moolenaar2a7aa832022-01-23 17:59:06 +0000498 sctx_T saved_sctx = current_sctx;
499 sctx_T *ctx;
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100500 int r;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200501
502 // Set "v:val" to the bad word.
503 prepare_vimvar(VV_VAL, &save_val);
504 set_vim_var_string(VV_VAL, badword, -1);
505 if (p_verbose == 0)
506 ++emsg_off;
Bram Moolenaar2a7aa832022-01-23 17:59:06 +0000507 ctx = get_option_sctx("spellsuggest");
508 if (ctx != NULL)
509 current_sctx = *ctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200510
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100511 r = may_call_simple_func(p, &rettv);
512 if (r == NOTDONE)
513 r = eval1(&p, &rettv, &EVALARG_EVALUATE);
514 if (r == OK)
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200515 {
516 if (rettv.v_type != VAR_LIST)
517 clear_tv(&rettv);
518 else
519 list = rettv.vval.v_list;
520 }
521
522 if (p_verbose == 0)
523 --emsg_off;
524 clear_tv(get_vim_var_tv(VV_VAL));
525 restore_vimvar(VV_VAL, &save_val);
Bram Moolenaar2a7aa832022-01-23 17:59:06 +0000526 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200527
528 return list;
529}
530
531/*
532 * "list" is supposed to contain two items: a word and a number. Return the
533 * word in "pp" and the number as the return value.
534 * Return -1 if anything isn't right.
535 * Used to get the good word and score from the eval_spell_expr() result.
536 */
537 int
538get_spellword(list_T *list, char_u **pp)
539{
540 listitem_T *li;
541
542 li = list->lv_first;
543 if (li == NULL)
544 return -1;
545 *pp = tv_get_string(&li->li_tv);
546
547 li = li->li_next;
548 if (li == NULL)
549 return -1;
550 return (int)tv_get_number(&li->li_tv);
551}
552#endif
553
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200554/*
555 * Prepare v: variable "idx" to be used.
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200556 * Save the current typeval in "save_tv" and clear it.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200557 * When not used yet add the variable to the v: hashtable.
558 */
559 void
560prepare_vimvar(int idx, typval_T *save_tv)
561{
562 *save_tv = vimvars[idx].vv_tv;
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200563 vimvars[idx].vv_str = NULL; // don't free it now
Bram Moolenaard787e402021-12-24 21:36:12 +0000564 if (vimvars[idx].vv_tv_type == VAR_UNKNOWN)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200565 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
566}
567
568/*
569 * Restore v: variable "idx" to typeval "save_tv".
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200570 * Note that the v: variable must have been cleared already.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200571 * When no longer defined, remove the variable from the v: hashtable.
572 */
573 void
574restore_vimvar(int idx, typval_T *save_tv)
575{
576 hashitem_T *hi;
577
578 vimvars[idx].vv_tv = *save_tv;
Bram Moolenaard787e402021-12-24 21:36:12 +0000579 if (vimvars[idx].vv_tv_type == VAR_UNKNOWN)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200580 {
581 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
582 if (HASHITEM_EMPTY(hi))
583 internal_error("restore_vimvar()");
584 else
585 hash_remove(&vimvarht, hi);
586 }
587}
588
589/*
590 * List Vim variables.
591 */
592 static void
593list_vim_vars(int *first)
594{
595 list_hashtable_vars(&vimvarht, "v:", FALSE, first);
596}
597
598/*
599 * List script-local variables, if there is a script.
600 */
601 static void
602list_script_vars(int *first)
603{
Bram Moolenaare3d46852020-08-29 13:39:17 +0200604 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200605 list_hashtable_vars(&SCRIPT_VARS(current_sctx.sc_sid),
606 "s:", FALSE, first);
607}
608
609/*
Bram Moolenaar9510d222022-09-11 15:14:05 +0100610 * Return TRUE if "name" starts with "g:", "w:", "t:" or "b:".
611 * But only when an identifier character follows.
612 */
613 int
614is_scoped_variable(char_u *name)
615{
616 return vim_strchr((char_u *)"gwbt", name[0]) != NULL
617 && name[1] == ':'
618 && eval_isnamec(name[2]);
619}
620
621/*
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100622 * Evaluate one Vim expression {expr} in string "p" and append the
623 * resulting string to "gap". "p" points to the opening "{".
Bram Moolenaar70c41242022-05-10 18:11:43 +0100624 * When "evaluate" is FALSE only skip over the expression.
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100625 * Return a pointer to the character after "}", NULL for an error.
626 */
627 char_u *
Bram Moolenaar70c41242022-05-10 18:11:43 +0100628eval_one_expr_in_str(char_u *p, garray_T *gap, int evaluate)
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100629{
630 char_u *block_start = skipwhite(p + 1); // skip the opening {
631 char_u *block_end = block_start;
632 char_u *expr_val;
633
634 if (*block_start == NUL)
635 {
636 semsg(_(e_missing_close_curly_str), p);
637 return NULL;
638 }
639 if (skip_expr(&block_end, NULL) == FAIL)
640 return NULL;
641 block_end = skipwhite(block_end);
642 if (*block_end != '}')
643 {
644 semsg(_(e_missing_close_curly_str), p);
645 return NULL;
646 }
Bram Moolenaar70c41242022-05-10 18:11:43 +0100647 if (evaluate)
648 {
649 *block_end = NUL;
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100650 expr_val = eval_to_string(block_start, TRUE, FALSE);
Bram Moolenaar70c41242022-05-10 18:11:43 +0100651 *block_end = '}';
652 if (expr_val == NULL)
653 return NULL;
654 ga_concat(gap, expr_val);
655 vim_free(expr_val);
656 }
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100657
658 return block_end + 1;
659}
660
661/*
662 * Evaluate all the Vim expressions {expr} in "str" and return the resulting
663 * string in allocated memory. "{{" is reduced to "{" and "}}" to "}".
664 * Used for a heredoc assignment.
665 * Returns NULL for an error.
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100666 */
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +0100667 static char_u *
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100668eval_all_expr_in_str(char_u *str)
669{
670 garray_T ga;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100671 char_u *p;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100672
673 ga_init2(&ga, 1, 80);
674 p = str;
675
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100676 while (*p != NUL)
677 {
LemonBoy2eaef102022-05-06 13:14:50 +0100678 char_u *lit_start;
LemonBoy2eaef102022-05-06 13:14:50 +0100679 int escaped_brace = FALSE;
680
681 // Look for a block start.
682 lit_start = p;
683 while (*p != '{' && *p != '}' && *p != NUL)
684 ++p;
685
686 if (*p != NUL && *p == p[1])
687 {
688 // Escaped brace, unescape and continue.
689 // Include the brace in the literal string.
690 ++p;
691 escaped_brace = TRUE;
692 }
693 else if (*p == '}')
694 {
695 semsg(_(e_stray_closing_curly_str), str);
696 ga_clear(&ga);
697 return NULL;
698 }
699
700 // Append the literal part.
701 ga_concat_len(&ga, lit_start, (size_t)(p - lit_start));
702
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100703 if (*p == NUL)
LemonBoy2eaef102022-05-06 13:14:50 +0100704 break;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100705
LemonBoy2eaef102022-05-06 13:14:50 +0100706 if (escaped_brace)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100707 {
LemonBoy2eaef102022-05-06 13:14:50 +0100708 // Skip the second brace.
709 ++p;
710 continue;
711 }
712
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100713 // Evaluate the expression and append the result.
Bram Moolenaar70c41242022-05-10 18:11:43 +0100714 p = eval_one_expr_in_str(p, &ga, TRUE);
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100715 if (p == NULL)
LemonBoy2eaef102022-05-06 13:14:50 +0100716 {
717 ga_clear(&ga);
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100718 return NULL;
719 }
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100720 }
721 ga_append(&ga, NUL);
722
723 return ga.ga_data;
724}
725
726/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200727 * Get a list of lines from a HERE document. The here document is a list of
728 * lines surrounded by a marker.
729 * cmd << {marker}
730 * {line1}
731 * {line2}
732 * ....
733 * {marker}
734 *
735 * The {marker} is a string. If the optional 'trim' word is supplied before the
736 * marker, then the leading indentation before the lines (matching the
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100737 * indentation in the "cmd" line) is stripped.
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200738 *
739 * When getting lines for an embedded script (e.g. python, lua, perl, ruby,
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100740 * tcl, mzscheme), "script_get" is set to TRUE. In this case, if the marker is
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200741 * missing, then '.' is accepted as a marker.
742 *
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100743 * When compiling a heredoc assignment to a variable in a Vim9 def function,
744 * "vim9compile" is set to TRUE. In this case, instead of generating a list of
745 * string values from the heredoc, vim9 instructions are generated. On success
746 * the returned list will be empty.
747 *
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100748 * Returns a List with {lines} or NULL on failure.
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200749 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100750 list_T *
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100751heredoc_get(exarg_T *eap, char_u *cmd, int script_get, int vim9compile)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200752{
Bram Moolenaar42ccb8d2022-04-18 15:45:23 +0100753 char_u *theline = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200754 char_u *marker;
755 list_T *l;
756 char_u *p;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100757 char_u *str;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200758 int marker_indent_len = 0;
759 int text_indent_len = 0;
760 char_u *text_indent = NULL;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200761 char_u dot[] = ".";
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200762 int comment_char = in_vim9script() ? '#' : '"';
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100763 int evalstr = FALSE;
764 int eval_failed = FALSE;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100765 cctx_T *cctx = vim9compile ? eap->cookie : NULL;
766 int count = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200767
768 if (eap->getline == NULL)
769 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000770 emsg(_(e_cannot_use_heredoc_here));
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200771 return NULL;
772 }
773
774 // Check for the optional 'trim' word before the marker
775 cmd = skipwhite(cmd);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200776
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100777 while (TRUE)
778 {
779 if (STRNCMP(cmd, "trim", 4) == 0
780 && (cmd[4] == NUL || VIM_ISWHITE(cmd[4])))
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200781 {
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100782 cmd = skipwhite(cmd + 4);
783
784 // Trim the indentation from all the lines in the here document.
785 // The amount of indentation trimmed is the same as the indentation
786 // of the first line after the :let command line. To find the end
787 // marker the indent of the :let command line is trimmed.
788 p = *eap->cmdlinep;
789 while (VIM_ISWHITE(*p))
790 {
791 p++;
792 marker_indent_len++;
793 }
794 text_indent_len = -1;
795
796 continue;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200797 }
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100798 if (STRNCMP(cmd, "eval", 4) == 0
799 && (cmd[4] == NUL || VIM_ISWHITE(cmd[4])))
800 {
801 cmd = skipwhite(cmd + 4);
802 evalstr = TRUE;
803 continue;
804 }
805 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200806 }
807
808 // The marker is the next word.
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200809 if (*cmd != NUL && *cmd != comment_char)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200810 {
811 marker = skipwhite(cmd);
812 p = skiptowhite(marker);
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200813 if (*skipwhite(p) != NUL && *skipwhite(p) != comment_char)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200814 {
Bram Moolenaar74409f62022-01-01 15:58:22 +0000815 semsg(_(e_trailing_characters_str), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200816 return NULL;
817 }
818 *p = NUL;
Bram Moolenaar6ab09532020-05-01 14:10:13 +0200819 if (!script_get && vim_islower(*marker))
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200820 {
Bram Moolenaar6d057012021-12-31 18:49:43 +0000821 emsg(_(e_marker_cannot_start_with_lower_case_letter));
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200822 return NULL;
823 }
824 }
825 else
826 {
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200827 // When getting lines for an embedded script, if the marker is missing,
828 // accept '.' as the marker.
829 if (script_get)
830 marker = dot;
831 else
832 {
Bram Moolenaar1a992222021-12-31 17:25:48 +0000833 emsg(_(e_missing_marker));
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200834 return NULL;
835 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200836 }
837
838 l = list_alloc();
839 if (l == NULL)
840 return NULL;
841
842 for (;;)
843 {
844 int mi = 0;
845 int ti = 0;
846
Bram Moolenaar42ccb8d2022-04-18 15:45:23 +0100847 vim_free(theline);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200848 theline = eap->getline(NUL, eap->cookie, 0, FALSE);
849 if (theline == NULL)
850 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000851 semsg(_(e_missing_end_marker_str), marker);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200852 break;
853 }
854
855 // with "trim": skip the indent matching the :let line to find the
856 // marker
857 if (marker_indent_len > 0
858 && STRNCMP(theline, *eap->cmdlinep, marker_indent_len) == 0)
859 mi = marker_indent_len;
860 if (STRCMP(marker, theline + mi) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200861 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200862
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100863 // If expression evaluation failed in the heredoc, then skip till the
864 // end marker.
865 if (eval_failed)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100866 continue;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100867
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200868 if (text_indent_len == -1 && *theline != NUL)
869 {
870 // set the text indent from the first line.
871 p = theline;
872 text_indent_len = 0;
873 while (VIM_ISWHITE(*p))
874 {
875 p++;
876 text_indent_len++;
877 }
878 text_indent = vim_strnsave(theline, text_indent_len);
879 }
880 // with "trim": skip the indent matching the first line
881 if (text_indent != NULL)
882 for (ti = 0; ti < text_indent_len; ++ti)
883 if (theline[ti] != text_indent[ti])
884 break;
885
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100886 str = theline + ti;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100887 if (vim9compile)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100888 {
LemonBoy2eaef102022-05-06 13:14:50 +0100889 if (compile_all_expr_in_str(str, evalstr, cctx) == FAIL)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100890 {
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100891 vim_free(theline);
892 vim_free(text_indent);
893 return FAIL;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100894 }
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100895 count++;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100896 }
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100897 else
898 {
Bram Moolenaar05c7f5d2022-04-28 16:51:41 +0100899 if (evalstr && !eap->skip)
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100900 {
901 str = eval_all_expr_in_str(str);
902 if (str == NULL)
903 {
904 // expression evaluation failed
905 eval_failed = TRUE;
906 continue;
907 }
908 vim_free(theline);
909 theline = str;
910 }
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100911
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100912 if (list_append_string(l, str, -1) == FAIL)
913 break;
914 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200915 }
Bram Moolenaar42ccb8d2022-04-18 15:45:23 +0100916 vim_free(theline);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200917 vim_free(text_indent);
918
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100919 if (vim9compile && cctx->ctx_skip != SKIP_YES && !eval_failed)
920 generate_NEWLIST(cctx, count, FALSE);
921
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100922 if (eval_failed)
923 {
924 // expression evaluation in the heredoc failed
925 list_free(l);
926 return NULL;
927 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200928 return l;
929}
930
931/*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200932 * Vim9 variable declaration:
933 * ":var name"
934 * ":var name: type"
935 * ":var name = expr"
936 * ":var name: type = expr"
937 * etc.
938 */
939 void
940ex_var(exarg_T *eap)
941{
Bram Moolenaar330a3882022-03-05 11:05:57 +0000942 char_u *p = eap->cmd;
Bram Moolenaare1d12112022-03-05 11:37:48 +0000943 int has_var;
Bram Moolenaar330a3882022-03-05 11:05:57 +0000944
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200945 if (!in_vim9script())
946 {
947 semsg(_(e_str_cannot_be_used_in_legacy_vim_script), ":var");
948 return;
949 }
Bram Moolenaare1d12112022-03-05 11:37:48 +0000950 has_var = checkforcmd_noparen(&p, "var", 3);
951 if (current_sctx.sc_sid == 0 && has_var)
Bram Moolenaar0e1574c2022-03-03 17:05:35 +0000952 {
953 emsg(_(e_cannot_declare_variable_on_command_line));
954 return;
955 }
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200956 ex_let(eap);
957}
958
959/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200960 * ":let" list all variable values
961 * ":let var1 var2" list variable values
962 * ":let var = expr" assignment command.
963 * ":let var += expr" assignment command.
964 * ":let var -= expr" assignment command.
965 * ":let var *= expr" assignment command.
966 * ":let var /= expr" assignment command.
967 * ":let var %= expr" assignment command.
968 * ":let var .= expr" assignment command.
969 * ":let var ..= expr" assignment command.
970 * ":let [var1, var2] = expr" unpack list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100971 * ":let var =<< ..." heredoc
Bram Moolenaard672dde2020-02-26 13:43:51 +0100972 * ":let var: string" Vim9 declaration
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200973 *
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200974 * ":final var = expr" assignment command.
975 * ":final [var1, var2] = expr" unpack list.
976 *
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200977 * ":const" list all variable values
978 * ":const var1 var2" list variable values
979 * ":const var = expr" assignment command.
980 * ":const [var1, var2] = expr" unpack list.
981 */
982 void
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200983ex_let(exarg_T *eap)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200984{
985 char_u *arg = eap->arg;
986 char_u *expr = NULL;
987 typval_T rettv;
988 int i;
989 int var_count = 0;
990 int semicolon = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200991 char_u op[4];
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200992 char_u *argend;
993 int first = TRUE;
994 int concat;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200995 int has_assign;
Bram Moolenaar89b474d2020-12-22 21:19:39 +0100996 int flags = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200997 int vim9script = in_vim9script();
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200998
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200999 if (eap->cmdidx == CMD_final && !vim9script)
1000 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001001 // In legacy Vim script ":final" is short for ":finally".
1002 ex_finally(eap);
1003 return;
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001004 }
Bram Moolenaarc58f5452020-10-21 20:58:52 +02001005 if (eap->cmdidx == CMD_let && vim9script)
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02001006 {
1007 emsg(_(e_cannot_use_let_in_vim9_script));
1008 return;
1009 }
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001010
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001011 if (eap->cmdidx == CMD_const)
1012 flags |= ASSIGN_CONST;
1013 else if (eap->cmdidx == CMD_final)
1014 flags |= ASSIGN_FINAL;
1015
1016 // Vim9 assignment without ":let", ":const" or ":final"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001017 if (eap->arg == eap->cmd)
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001018 flags |= ASSIGN_NO_DECL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001019
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001020 argend = skip_var_list(arg, TRUE, &var_count, &semicolon, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001021 if (argend == NULL)
1022 return;
1023 if (argend > arg && argend[-1] == '.') // for var.='str'
1024 --argend;
1025 expr = skipwhite(argend);
1026 concat = expr[0] == '.'
Bram Moolenaardd9de502021-08-15 13:49:42 +02001027 && ((expr[1] == '=' && in_old_script(2))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001028 || (expr[1] == '.' && expr[2] == '='));
Bram Moolenaar32e35112020-05-14 22:41:15 +02001029 has_assign = *expr == '=' || (vim_strchr((char_u *)"+-*/%", *expr) != NULL
1030 && expr[1] == '=');
Bram Moolenaar822ba242020-05-24 23:00:18 +02001031 if (!has_assign && !concat)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001032 {
1033 // ":let" without "=": list variables
1034 if (*arg == '[')
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001035 emsg(_(e_invalid_argument));
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001036 else if (expr[0] == '.' && expr[1] == '=')
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001037 emsg(_(e_dot_equal_not_supported_with_script_version_two));
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001038 else if (!ends_excmd2(eap->cmd, arg))
Bram Moolenaarc82a5b52020-06-13 18:09:19 +02001039 {
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001040 if (vim9script)
Bram Moolenaarc82a5b52020-06-13 18:09:19 +02001041 {
Bram Moolenaarccc25aa2021-03-26 21:27:52 +01001042 if (!ends_excmd2(eap->cmd, skipwhite(argend)))
Bram Moolenaar74409f62022-01-01 15:58:22 +00001043 semsg(_(e_trailing_characters_str), argend);
Bram Moolenaarccc25aa2021-03-26 21:27:52 +01001044 else
1045 // Vim9 declaration ":var name: type"
1046 arg = vim9_declare_scriptvar(eap, arg);
Bram Moolenaarc82a5b52020-06-13 18:09:19 +02001047 }
1048 else
1049 {
1050 // ":let var1 var2" - list values
1051 arg = list_arg_vars(eap, arg, &first);
1052 }
1053 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001054 else if (!eap->skip)
1055 {
1056 // ":let"
1057 list_glob_vars(&first);
1058 list_buf_vars(&first);
1059 list_win_vars(&first);
1060 list_tab_vars(&first);
1061 list_script_vars(&first);
1062 list_func_vars(&first);
1063 list_vim_vars(&first);
1064 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02001065 set_nextcmd(eap, arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001066 }
1067 else if (expr[0] == '=' && expr[1] == '<' && expr[2] == '<')
1068 {
Bram Moolenaard9876422022-10-12 12:58:54 +01001069 list_T *l = NULL;
Bram Moolenaar81530e32021-07-28 21:25:49 +02001070 long cur_lnum = SOURCING_LNUM;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001071
Bram Moolenaard9876422022-10-12 12:58:54 +01001072 // :let text =<< [trim] [eval] END
1073 // :var text =<< [trim] [eval] END
1074 if (vim9script && !eap->skip && (!VIM_ISWHITE(expr[-1])
1075 || !IS_WHITE_OR_NUL(expr[3])))
1076 semsg(_(e_white_space_required_before_and_after_str_at_str),
1077 "=<<", expr);
1078 else
1079 l = heredoc_get(eap, expr + 3, FALSE, FALSE);
1080
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001081 if (l != NULL)
1082 {
1083 rettv_list_set(&rettv, l);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +02001084 if (!eap->skip)
1085 {
Bram Moolenaar81530e32021-07-28 21:25:49 +02001086 // errors are for the assignment, not the end marker
1087 SOURCING_LNUM = cur_lnum;
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +02001088 op[0] = '=';
1089 op[1] = NUL;
1090 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001091 flags, op);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +02001092 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001093 clear_tv(&rettv);
1094 }
1095 }
1096 else
1097 {
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001098 evalarg_T evalarg;
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001099 int len = 1;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001100
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02001101 CLEAR_FIELD(rettv);
Bram Moolenaar32e35112020-05-14 22:41:15 +02001102 i = FAIL;
1103 if (has_assign || concat)
1104 {
Bram Moolenaar9a562c12021-01-23 13:39:14 +01001105 int cur_lnum;
1106
Bram Moolenaar32e35112020-05-14 22:41:15 +02001107 op[0] = '=';
1108 op[1] = NUL;
1109 if (*expr != '=')
1110 {
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001111 if (vim9script && (flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar122616d2020-08-21 21:32:50 +02001112 {
1113 // +=, /=, etc. require an existing variable
1114 semsg(_(e_cannot_use_operator_on_new_variable), eap->arg);
Bram Moolenaar122616d2020-08-21 21:32:50 +02001115 }
1116 else if (vim_strchr((char_u *)"+-*/%.", *expr) != NULL)
Bram Moolenaar32e35112020-05-14 22:41:15 +02001117 {
1118 op[0] = *expr; // +=, -=, *=, /=, %= or .=
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001119 ++len;
Bram Moolenaar32e35112020-05-14 22:41:15 +02001120 if (expr[0] == '.' && expr[1] == '.') // ..=
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001121 {
Bram Moolenaar32e35112020-05-14 22:41:15 +02001122 ++expr;
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001123 ++len;
1124 }
Bram Moolenaar32e35112020-05-14 22:41:15 +02001125 }
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001126 expr += 2;
Bram Moolenaar32e35112020-05-14 22:41:15 +02001127 }
1128 else
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001129 ++expr;
1130
Bram Moolenaar7f2c3412021-11-29 16:01:49 +00001131 if (vim9script && !eap->skip && (!VIM_ISWHITE(*argend)
Bram Moolenaarc7e44a72020-07-29 21:37:43 +02001132 || !IS_WHITE_OR_NUL(*expr)))
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001133 {
1134 vim_strncpy(op, expr - len, len);
Bram Moolenaare7a73e02021-01-01 19:17:55 +01001135 semsg(_(e_white_space_required_before_and_after_str_at_str),
1136 op, argend);
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001137 }
Bram Moolenaar32e35112020-05-14 22:41:15 +02001138
1139 if (eap->skip)
1140 ++emsg_skip;
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001141 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaarc7e44a72020-07-29 21:37:43 +02001142 expr = skipwhite_and_linebreak(expr, &evalarg);
Bram Moolenaar9a562c12021-01-23 13:39:14 +01001143 cur_lnum = SOURCING_LNUM;
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001144 i = eval0(expr, &rettv, eap, &evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001145 if (eap->skip)
1146 --emsg_skip;
Bram Moolenaarfaf86262020-06-27 23:07:36 +02001147 clear_evalarg(&evalarg, eap);
Bram Moolenaar9a562c12021-01-23 13:39:14 +01001148
1149 // Restore the line number so that any type error is given for the
1150 // declaration, not the expression.
1151 SOURCING_LNUM = cur_lnum;
Bram Moolenaar32e35112020-05-14 22:41:15 +02001152 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001153 if (eap->skip)
1154 {
1155 if (i != FAIL)
1156 clear_tv(&rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001157 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02001158 else if (i != FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001159 {
1160 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001161 flags, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001162 clear_tv(&rettv);
1163 }
1164 }
1165}
1166
1167/*
Bram Moolenaar6c3843c2021-03-04 12:38:21 +01001168 * Assign the typeval "tv" to the variable or variables at "arg_start".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001169 * Handles both "var" with any type and "[var, var; var]" with a list type.
1170 * When "op" is not NULL it points to a string with characters that
1171 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1172 * or concatenate.
1173 * Returns OK or FAIL;
1174 */
1175 int
1176ex_let_vars(
1177 char_u *arg_start,
1178 typval_T *tv,
1179 int copy, // copy values from "tv", don't move
1180 int semicolon, // from skip_var_list()
1181 int var_count, // from skip_var_list()
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001182 int flags, // ASSIGN_FINAL, ASSIGN_CONST, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001183 char_u *op)
1184{
1185 char_u *arg = arg_start;
1186 list_T *l;
1187 int i;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001188 int var_idx = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001189 listitem_T *item;
1190 typval_T ltv;
1191
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00001192 if (tv->v_type == VAR_VOID)
1193 {
1194 emsg(_(e_cannot_use_void_value));
1195 return FAIL;
1196 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001197 if (*arg != '[')
1198 {
1199 // ":let var = expr" or ":for var in list"
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001200 if (ex_let_one(arg, tv, copy, flags, op, op, var_idx) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001201 return FAIL;
1202 return OK;
1203 }
1204
1205 // ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1206 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1207 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001208 emsg(_(e_list_required));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001209 return FAIL;
1210 }
1211
1212 i = list_len(l);
1213 if (semicolon == 0 && var_count < i)
1214 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00001215 emsg(_(e_less_targets_than_list_items));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001216 return FAIL;
1217 }
1218 if (var_count - semicolon > i)
1219 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00001220 emsg(_(e_more_targets_than_list_items));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001221 return FAIL;
1222 }
1223
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001224 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001225 item = l->lv_first;
1226 while (*arg != ']')
1227 {
1228 arg = skipwhite(arg + 1);
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001229 ++var_idx;
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02001230 arg = ex_let_one(arg, &item->li_tv, TRUE,
1231 flags | ASSIGN_UNPACK, (char_u *)",;]", op, var_idx);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001232 item = item->li_next;
1233 if (arg == NULL)
1234 return FAIL;
1235
1236 arg = skipwhite(arg);
1237 if (*arg == ';')
1238 {
1239 // Put the rest of the list (may be empty) in the var after ';'.
1240 // Create a new list for this.
1241 l = list_alloc();
1242 if (l == NULL)
1243 return FAIL;
1244 while (item != NULL)
1245 {
1246 list_append_tv(l, &item->li_tv);
1247 item = item->li_next;
1248 }
1249
1250 ltv.v_type = VAR_LIST;
1251 ltv.v_lock = 0;
1252 ltv.vval.v_list = l;
1253 l->lv_refcount = 1;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001254 ++var_idx;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001255
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02001256 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1257 flags | ASSIGN_UNPACK, (char_u *)"]", op, var_idx);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001258 clear_tv(&ltv);
1259 if (arg == NULL)
1260 return FAIL;
1261 break;
1262 }
1263 else if (*arg != ',' && *arg != ']')
1264 {
1265 internal_error("ex_let_vars()");
1266 return FAIL;
1267 }
1268 }
1269
1270 return OK;
1271}
1272
1273/*
1274 * Skip over assignable variable "var" or list of variables "[var, var]".
1275 * Used for ":let varvar = expr" and ":for varvar in expr".
1276 * For "[var, var]" increment "*var_count" for each variable.
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001277 * for "[var, var; var]" set "semicolon" to 1.
1278 * If "silent" is TRUE do not give an "invalid argument" error message.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001279 * Return NULL for an error.
1280 */
1281 char_u *
1282skip_var_list(
1283 char_u *arg,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001284 int include_type,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001285 int *var_count,
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001286 int *semicolon,
1287 int silent)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001288{
1289 char_u *p, *s;
1290
1291 if (*arg == '[')
1292 {
1293 // "[var, var]": find the matching ']'.
1294 p = arg;
1295 for (;;)
1296 {
1297 p = skipwhite(p + 1); // skip whites after '[', ';' or ','
Bram Moolenaar036d0712021-01-17 20:23:38 +01001298 s = skip_var_one(p, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001299 if (s == p)
1300 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001301 if (!silent)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001302 semsg(_(e_invalid_argument_str), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001303 return NULL;
1304 }
1305 ++*var_count;
1306
1307 p = skipwhite(s);
1308 if (*p == ']')
1309 break;
1310 else if (*p == ';')
1311 {
1312 if (*semicolon == 1)
1313 {
Bram Moolenaar8b716f52022-02-15 21:17:56 +00001314 if (!silent)
1315 emsg(_(e_double_semicolon_in_list_of_variables));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001316 return NULL;
1317 }
1318 *semicolon = 1;
1319 }
1320 else if (*p != ',')
1321 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001322 if (!silent)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001323 semsg(_(e_invalid_argument_str), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001324 return NULL;
1325 }
1326 }
1327 return p + 1;
1328 }
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01001329
Bram Moolenaare8e369a2022-09-21 18:59:14 +01001330 return skip_var_one(arg, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001331}
1332
1333/*
1334 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1335 * l[idx].
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001336 * In Vim9 script also skip over ": type" if "include_type" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001337 */
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001338 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001339skip_var_one(char_u *arg, int include_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001340{
Bram Moolenaar585587d2021-01-17 20:52:13 +01001341 char_u *end;
1342 int vim9 = in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001343
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001344 if (*arg == '@' && arg[1] != NUL)
1345 return arg + 2;
Bram Moolenaar1573e732022-11-16 20:33:21 +00001346
1347 // termcap option name may have non-alpha characters
1348 if (STRNCMP(arg, "&t_", 3) == 0 && arg[3] != NUL && arg[4] != NUL)
1349 return arg + 5;
1350
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001351 end = find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001352 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
Bram Moolenaar036d0712021-01-17 20:23:38 +01001353
1354 // "a: type" is declaring variable "a" with a type, not "a:".
1355 // Same for "s: type".
Bram Moolenaar585587d2021-01-17 20:52:13 +01001356 if (vim9 && end == arg + 2 && end[-1] == ':')
Bram Moolenaar036d0712021-01-17 20:23:38 +01001357 --end;
1358
Bram Moolenaar585587d2021-01-17 20:52:13 +01001359 if (include_type && vim9)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001360 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001361 if (*end == ':')
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02001362 end = skip_type(skipwhite(end + 1), FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001363 }
1364 return end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001365}
1366
1367/*
1368 * List variables for hashtab "ht" with prefix "prefix".
1369 * If "empty" is TRUE also list NULL strings as empty strings.
1370 */
1371 void
1372list_hashtable_vars(
1373 hashtab_T *ht,
1374 char *prefix,
1375 int empty,
1376 int *first)
1377{
1378 hashitem_T *hi;
1379 dictitem_T *di;
1380 int todo;
1381 char_u buf[IOSIZE];
1382
1383 todo = (int)ht->ht_used;
1384 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1385 {
1386 if (!HASHITEM_EMPTY(hi))
1387 {
1388 --todo;
1389 di = HI2DI(hi);
1390
1391 // apply :filter /pat/ to variable name
1392 vim_strncpy((char_u *)buf, (char_u *)prefix, IOSIZE - 1);
1393 vim_strcat((char_u *)buf, di->di_key, IOSIZE);
1394 if (message_filtered(buf))
1395 continue;
1396
1397 if (empty || di->di_tv.v_type != VAR_STRING
1398 || di->di_tv.vval.v_string != NULL)
1399 list_one_var(di, prefix, first);
1400 }
1401 }
1402}
1403
1404/*
1405 * List global variables.
1406 */
1407 static void
1408list_glob_vars(int *first)
1409{
1410 list_hashtable_vars(&globvarht, "", TRUE, first);
1411}
1412
1413/*
1414 * List buffer variables.
1415 */
1416 static void
1417list_buf_vars(int *first)
1418{
1419 list_hashtable_vars(&curbuf->b_vars->dv_hashtab, "b:", TRUE, first);
1420}
1421
1422/*
1423 * List window variables.
1424 */
1425 static void
1426list_win_vars(int *first)
1427{
1428 list_hashtable_vars(&curwin->w_vars->dv_hashtab, "w:", TRUE, first);
1429}
1430
1431/*
1432 * List tab page variables.
1433 */
1434 static void
1435list_tab_vars(int *first)
1436{
1437 list_hashtable_vars(&curtab->tp_vars->dv_hashtab, "t:", TRUE, first);
1438}
1439
1440/*
1441 * List variables in "arg".
1442 */
1443 static char_u *
1444list_arg_vars(exarg_T *eap, char_u *arg, int *first)
1445{
1446 int error = FALSE;
1447 int len;
1448 char_u *name;
1449 char_u *name_start;
1450 char_u *arg_subsc;
1451 char_u *tofree;
1452 typval_T tv;
1453
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001454 while (!ends_excmd2(eap->cmd, arg) && !got_int)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001455 {
1456 if (error || eap->skip)
1457 {
1458 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1459 if (!VIM_ISWHITE(*arg) && !ends_excmd(*arg))
1460 {
1461 emsg_severe = TRUE;
Bram Moolenaar4830c212021-08-14 14:59:27 +02001462 if (!did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00001463 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001464 break;
1465 }
1466 }
1467 else
1468 {
1469 // get_name_len() takes care of expanding curly braces
1470 name_start = name = arg;
1471 len = get_name_len(&arg, &tofree, TRUE, TRUE);
1472 if (len <= 0)
1473 {
1474 // This is mainly to keep test 49 working: when expanding
1475 // curly braces fails overrule the exception error message.
1476 if (len < 0 && !aborting())
1477 {
1478 emsg_severe = TRUE;
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001479 semsg(_(e_invalid_argument_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001480 break;
1481 }
1482 error = TRUE;
1483 }
1484 else
1485 {
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02001486 arg = skipwhite(arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001487 if (tofree != NULL)
1488 name = tofree;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001489 if (eval_variable(name, len, 0, &tv, NULL,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01001490 EVAL_VAR_VERBOSE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001491 error = TRUE;
1492 else
1493 {
1494 // handle d.key, l[idx], f(expr)
1495 arg_subsc = arg;
Bram Moolenaar32884ad2022-01-07 12:45:29 +00001496 if (handle_subscript(&arg, name_start, &tv,
1497 &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001498 error = TRUE;
1499 else
1500 {
1501 if (arg == arg_subsc && len == 2 && name[1] == ':')
1502 {
1503 switch (*name)
1504 {
1505 case 'g': list_glob_vars(first); break;
1506 case 'b': list_buf_vars(first); break;
1507 case 'w': list_win_vars(first); break;
1508 case 't': list_tab_vars(first); break;
1509 case 'v': list_vim_vars(first); break;
1510 case 's': list_script_vars(first); break;
1511 case 'l': list_func_vars(first); break;
1512 default:
Bram Moolenaara6f79292022-01-04 21:30:47 +00001513 semsg(_(e_cant_list_variables_for_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001514 }
1515 }
1516 else
1517 {
1518 char_u numbuf[NUMBUFLEN];
1519 char_u *tf;
1520 int c;
1521 char_u *s;
1522
1523 s = echo_string(&tv, &tf, numbuf, 0);
1524 c = *arg;
1525 *arg = NUL;
1526 list_one_var_a("",
1527 arg == arg_subsc ? name : name_start,
1528 tv.v_type,
1529 s == NULL ? (char_u *)"" : s,
1530 first);
1531 *arg = c;
1532 vim_free(tf);
1533 }
1534 clear_tv(&tv);
1535 }
1536 }
1537 }
1538
1539 vim_free(tofree);
1540 }
1541
1542 arg = skipwhite(arg);
1543 }
1544
1545 return arg;
1546}
1547
1548/*
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001549 * Set an environment variable, part of ex_let_one().
1550 */
1551 static char_u *
1552ex_let_env(
1553 char_u *arg,
1554 typval_T *tv,
1555 int flags,
1556 char_u *endchars,
1557 char_u *op)
1558{
1559 char_u *arg_end = NULL;
1560 char_u *name;
1561 int len;
1562
1563 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1564 && (flags & ASSIGN_FOR_LOOP) == 0)
1565 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001566 emsg(_(e_cannot_lock_environment_variable));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001567 return NULL;
1568 }
1569
1570 // Find the end of the name.
1571 ++arg;
1572 name = arg;
1573 len = get_env_len(&arg);
1574 if (len == 0)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001575 semsg(_(e_invalid_argument_str), name - 1);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001576 else
1577 {
1578 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001579 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001580 else if (endchars != NULL
1581 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
1582 emsg(_(e_unexpected_characters_in_let));
1583 else if (!check_secure())
1584 {
1585 char_u *tofree = NULL;
1586 int c1 = name[len];
1587 char_u *p;
1588
1589 name[len] = NUL;
1590 p = tv_get_string_chk(tv);
1591 if (p != NULL && op != NULL && *op == '.')
1592 {
1593 int mustfree = FALSE;
1594 char_u *s = vim_getenv(name, &mustfree);
1595
1596 if (s != NULL)
1597 {
1598 p = tofree = concat_str(s, p);
1599 if (mustfree)
1600 vim_free(s);
1601 }
1602 }
1603 if (p != NULL)
1604 {
1605 vim_setenv_ext(name, p);
1606 arg_end = arg;
1607 }
1608 name[len] = c1;
1609 vim_free(tofree);
1610 }
1611 }
1612 return arg_end;
1613}
1614
1615/*
1616 * Set an option, part of ex_let_one().
1617 */
1618 static char_u *
1619ex_let_option(
1620 char_u *arg,
1621 typval_T *tv,
1622 int flags,
1623 char_u *endchars,
1624 char_u *op)
1625{
1626 char_u *p;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001627 int scope;
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001628 char_u *arg_end = NULL;
1629
1630 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1631 && (flags & ASSIGN_FOR_LOOP) == 0)
1632 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001633 emsg(_(e_cannot_lock_option));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001634 return NULL;
1635 }
1636
1637 // Find the end of the name.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001638 p = find_option_end(&arg, &scope);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001639 if (p == NULL || (endchars != NULL
1640 && vim_strchr(endchars, *skipwhite(p)) == NULL))
1641 emsg(_(e_unexpected_characters_in_let));
1642 else
1643 {
1644 int c1;
1645 long n = 0;
1646 getoption_T opt_type;
1647 long numval;
1648 char_u *stringval = NULL;
1649 char_u *s = NULL;
1650 int failed = FALSE;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001651 int opt_p_flags;
1652 char_u *tofree = NULL;
Bram Moolenaar92c33eb2021-12-07 11:03:39 +00001653 char_u numbuf[NUMBUFLEN];
1654
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001655 c1 = *p;
1656 *p = NUL;
1657
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001658 opt_type = get_option_value(arg, &numval, &stringval, &opt_p_flags,
1659 scope);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001660 if ((opt_type == gov_bool
1661 || opt_type == gov_number
1662 || opt_type == gov_hidden_bool
1663 || opt_type == gov_hidden_number)
1664 && (tv->v_type != VAR_STRING || !in_vim9script()))
1665 {
1666 if (opt_type == gov_bool || opt_type == gov_hidden_bool)
1667 // bool, possibly hidden
1668 n = (long)tv_get_bool(tv);
1669 else
1670 // number, possibly hidden
1671 n = (long)tv_get_number(tv);
1672 }
1673
Bram Moolenaaref082e12021-12-12 21:02:03 +00001674 if ((opt_p_flags & P_FUNC) && (tv->v_type == VAR_PARTIAL
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001675 || tv->v_type == VAR_FUNC))
1676 {
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001677 // If the option can be set to a function reference or a lambda
1678 // and the passed value is a function reference, then convert it to
1679 // the name (string) of the function reference.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001680 s = tv2string(tv, &tofree, numbuf, 0);
1681 }
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001682 // Avoid setting a string option to the text "v:false" or similar.
1683 // In Vim9 script also don't convert a number to string.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001684 else if (tv->v_type != VAR_BOOL && tv->v_type != VAR_SPECIAL
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001685 && (!in_vim9script() || tv->v_type != VAR_NUMBER))
1686 s = tv_get_string_chk(tv);
1687
1688 if (op != NULL && *op != '=')
1689 {
1690 if (((opt_type == gov_bool || opt_type == gov_number) && *op == '.')
1691 || (opt_type == gov_string && *op != '.'))
1692 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001693 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001694 failed = TRUE; // don't set the value
1695
1696 }
1697 else
1698 {
1699 // number, in legacy script also bool
1700 if (opt_type == gov_number
1701 || (opt_type == gov_bool && !in_vim9script()))
1702 {
1703 switch (*op)
1704 {
1705 case '+': n = numval + n; break;
1706 case '-': n = numval - n; break;
1707 case '*': n = numval * n; break;
1708 case '/': n = (long)num_divide(numval, n,
1709 &failed); break;
1710 case '%': n = (long)num_modulus(numval, n,
1711 &failed); break;
1712 }
1713 s = NULL;
1714 }
1715 else if (opt_type == gov_string
1716 && stringval != NULL && s != NULL)
1717 {
1718 // string
1719 s = concat_str(stringval, s);
1720 vim_free(stringval);
1721 stringval = s;
1722 }
1723 }
1724 }
1725
1726 if (!failed)
1727 {
1728 if (opt_type != gov_string || s != NULL)
1729 {
Bram Moolenaar8ccbbeb2022-03-02 19:49:38 +00001730 char *err = set_option_value(arg, n, s, scope);
1731
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001732 arg_end = p;
Bram Moolenaar8ccbbeb2022-03-02 19:49:38 +00001733 if (err != NULL)
1734 emsg(_(err));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001735 }
1736 else
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001737 emsg(_(e_string_required));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001738 }
1739 *p = c1;
1740 vim_free(stringval);
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001741 vim_free(tofree);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001742 }
1743 return arg_end;
1744}
1745
1746/*
1747 * Set a register, part of ex_let_one().
1748 */
1749 static char_u *
1750ex_let_register(
1751 char_u *arg,
1752 typval_T *tv,
1753 int flags,
1754 char_u *endchars,
1755 char_u *op)
1756{
1757 char_u *arg_end = NULL;
1758
1759 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1760 && (flags & ASSIGN_FOR_LOOP) == 0)
1761 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001762 emsg(_(e_cannot_lock_register));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001763 return NULL;
1764 }
1765 ++arg;
1766 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001767 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001768 else if (endchars != NULL
1769 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
1770 emsg(_(e_unexpected_characters_in_let));
1771 else
1772 {
1773 char_u *ptofree = NULL;
1774 char_u *p;
1775
1776 p = tv_get_string_chk(tv);
1777 if (p != NULL && op != NULL && *op == '.')
1778 {
1779 char_u *s = get_reg_contents(*arg == '@'
1780 ? '"' : *arg, GREG_EXPR_SRC);
1781
1782 if (s != NULL)
1783 {
1784 p = ptofree = concat_str(s, p);
1785 vim_free(s);
1786 }
1787 }
1788 if (p != NULL)
1789 {
1790 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
1791 arg_end = arg + 1;
1792 }
1793 vim_free(ptofree);
1794 }
1795 return arg_end;
1796}
1797
1798/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001799 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
1800 * Returns a pointer to the char just after the var name.
1801 * Returns NULL if there is an error.
1802 */
1803 static char_u *
1804ex_let_one(
1805 char_u *arg, // points to variable name
1806 typval_T *tv, // value to assign to variable
1807 int copy, // copy value from "tv"
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001808 int flags, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001809 char_u *endchars, // valid chars after variable name or NULL
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001810 char_u *op, // "+", "-", "." or NULL
1811 int var_idx) // variable index for "let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001812{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001813 char_u *arg_end = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001814
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001815 if (in_vim9script() && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001816 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001817 && vim_strchr((char_u *)"$@&", *arg) != NULL)
1818 {
1819 vim9_declare_error(arg);
1820 return NULL;
1821 }
1822
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001823 if (*arg == '$')
1824 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001825 // ":let $VAR = expr": Set environment variable.
1826 return ex_let_env(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001827 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001828 else if (*arg == '&')
1829 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001830 // ":let &option = expr": Set option value.
1831 // ":let &l:option = expr": Set local option value.
1832 // ":let &g:option = expr": Set global option value.
1833 // ":for &ts in range(8)": Set option value for for loop
1834 return ex_let_option(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001835 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001836 else if (*arg == '@')
1837 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001838 // ":let @r = expr": Set register contents.
1839 return ex_let_register(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001840 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001841 else if (eval_isnamec1(*arg) || *arg == '{')
1842 {
1843 lval_T lv;
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001844 char_u *p;
Bram Moolenaar22ebd172022-04-01 15:26:58 +01001845 int lval_flags = (flags & (ASSIGN_NO_DECL | ASSIGN_DECL))
1846 ? GLV_NO_DECL : 0;
1847 if (op != NULL && *op != '=')
1848 lval_flags |= GLV_ASSIGN_WITH_OP;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001849
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001850 // ":let var = expr": Set internal variable.
1851 // ":let var: type = expr": Set internal variable with type.
1852 // ":let {expr} = expr": Idem, name made with curly braces
Bram Moolenaar22ebd172022-04-01 15:26:58 +01001853 p = get_lval(arg, tv, &lv, FALSE, FALSE, lval_flags, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001854 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001855 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001856 if (endchars != NULL && vim_strchr(endchars,
1857 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001858 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001859 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001860 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001861 else
1862 {
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001863 set_var_lval(&lv, p, tv, copy, flags, op, var_idx);
Bram Moolenaara3589a02021-04-14 13:30:46 +02001864 arg_end = lv.ll_name_end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001865 }
1866 }
1867 clear_lval(&lv);
1868 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001869 else
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001870 semsg(_(e_invalid_argument_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001871
1872 return arg_end;
1873}
1874
1875/*
1876 * ":unlet[!] var1 ... " command.
1877 */
1878 void
1879ex_unlet(exarg_T *eap)
1880{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001881 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001882}
1883
1884/*
1885 * ":lockvar" and ":unlockvar" commands
1886 */
1887 void
1888ex_lockvar(exarg_T *eap)
1889{
1890 char_u *arg = eap->arg;
1891 int deep = 2;
1892
1893 if (eap->forceit)
1894 deep = -1;
1895 else if (vim_isdigit(*arg))
1896 {
1897 deep = getdigits(&arg);
1898 arg = skipwhite(arg);
1899 }
1900
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001901 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001902}
1903
1904/*
1905 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001906 * Also used for Vim9 script. "callback" is invoked as:
1907 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001908 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001909 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001910ex_unletlock(
1911 exarg_T *eap,
1912 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001913 int deep,
1914 int glv_flags,
1915 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1916 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001917{
1918 char_u *arg = argstart;
1919 char_u *name_end;
1920 int error = FALSE;
1921 lval_T lv;
1922
1923 do
1924 {
1925 if (*arg == '$')
1926 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001927 lv.ll_name = arg;
1928 lv.ll_tv = NULL;
1929 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001930 if (get_env_len(&arg) == 0)
1931 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001932 semsg(_(e_invalid_argument_str), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001933 return;
1934 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001935 if (!error && !eap->skip
1936 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1937 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001938 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001939 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001940 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001941 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001942 // Parse the name and find the end.
1943 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
Bram Moolenaarc3689572021-01-01 19:40:02 +01001944 glv_flags | GLV_NO_DECL, FNE_CHECK_START);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001945 if (lv.ll_name == NULL)
1946 error = TRUE; // error but continue parsing
1947 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1948 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001949 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001950 if (name_end != NULL)
1951 {
1952 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00001953 semsg(_(e_trailing_characters_str), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001954 }
1955 if (!(eap->skip || error))
1956 clear_lval(&lv);
1957 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001958 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001959
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001960 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001961 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001962 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001963
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001964 if (!eap->skip)
1965 clear_lval(&lv);
1966 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001967
1968 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001969 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001970
Bram Moolenaar63b91732021-08-05 20:40:03 +02001971 set_nextcmd(eap, arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001972}
1973
1974 static int
1975do_unlet_var(
1976 lval_T *lp,
1977 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001978 exarg_T *eap,
1979 int deep UNUSED,
1980 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001981{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001982 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001983 int ret = OK;
1984 int cc;
1985
1986 if (lp->ll_tv == NULL)
1987 {
1988 cc = *name_end;
1989 *name_end = NUL;
1990
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001991 // Environment variable, normal name or expanded name.
1992 if (*lp->ll_name == '$')
LemonBoy77142312022-04-15 20:50:46 +01001993 vim_unsetenv_ext(lp->ll_name + 1);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001994 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001995 ret = FAIL;
1996 *name_end = cc;
1997 }
1998 else if ((lp->ll_list != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001999 && value_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002000 || (lp->ll_dict != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02002001 && value_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002002 return FAIL;
2003 else if (lp->ll_range)
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002004 list_unlet_range(lp->ll_list, lp->ll_li, lp->ll_n1,
2005 !lp->ll_empty2, lp->ll_n2);
2006 else if (lp->ll_list != NULL)
2007 // unlet a List item.
2008 listitem_remove(lp->ll_list, lp->ll_li);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002009 else
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002010 // unlet a Dictionary item.
2011 dictitem_remove(lp->ll_dict, lp->ll_di);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002012
2013 return ret;
2014}
2015
2016/*
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002017 * Unlet one item or a range of items from a list.
2018 * Return OK or FAIL.
2019 */
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002020 void
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002021list_unlet_range(
2022 list_T *l,
2023 listitem_T *li_first,
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002024 long n1_arg,
2025 int has_n2,
2026 long n2)
2027{
2028 listitem_T *li = li_first;
2029 int n1 = n1_arg;
2030
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002031 // Delete a range of List items.
2032 li = li_first;
2033 n1 = n1_arg;
2034 while (li != NULL && (!has_n2 || n2 >= n1))
2035 {
2036 listitem_T *next = li->li_next;
2037
2038 listitem_remove(l, li);
2039 li = next;
2040 ++n1;
2041 }
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002042}
2043/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002044 * "unlet" a variable. Return OK if it existed, FAIL if not.
2045 * When "forceit" is TRUE don't complain if the variable doesn't exist.
2046 */
2047 int
2048do_unlet(char_u *name, int forceit)
2049{
2050 hashtab_T *ht;
2051 hashitem_T *hi;
mityu8be36ee2022-05-25 17:29:46 +01002052 char_u *varname = NULL; // init to shut up gcc
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002053 dict_T *d;
2054 dictitem_T *di;
2055
Bram Moolenaar9aed7292020-12-18 15:38:00 +01002056 // can't :unlet a script variable in Vim9 script
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002057 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002058 return FAIL;
2059
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002060 ht = find_var_ht(name, &varname);
Bram Moolenaar9aed7292020-12-18 15:38:00 +01002061
2062 // can't :unlet a script variable in Vim9 script from a function
2063 if (ht == get_script_local_ht()
2064 && SCRIPT_ID_VALID(current_sctx.sc_sid)
2065 && SCRIPT_ITEM(current_sctx.sc_sid)->sn_version
2066 == SCRIPT_VERSION_VIM9
2067 && check_vim9_unlet(name) == FAIL)
2068 return FAIL;
2069
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002070 if (ht != NULL && *varname != NUL)
2071 {
2072 d = get_current_funccal_dict(ht);
2073 if (d == NULL)
2074 {
2075 if (ht == &globvarht)
2076 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002077 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002078 d = &vimvardict;
2079 else
2080 {
2081 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
2082 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
2083 }
2084 if (d == NULL)
2085 {
2086 internal_error("do_unlet()");
2087 return FAIL;
2088 }
2089 }
2090 hi = hash_find(ht, varname);
2091 if (HASHITEM_EMPTY(hi))
2092 hi = find_hi_in_scoped_ht(name, &ht);
2093 if (hi != NULL && !HASHITEM_EMPTY(hi))
2094 {
2095 di = HI2DI(hi);
2096 if (var_check_fixed(di->di_flags, name, FALSE)
2097 || var_check_ro(di->di_flags, name, FALSE)
Bram Moolenaara187c432020-09-16 21:08:28 +02002098 || value_check_lock(d->dv_lock, name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002099 return FAIL;
2100
2101 delete_var(ht, hi);
2102 return OK;
2103 }
2104 }
2105 if (forceit)
2106 return OK;
Bram Moolenaare1242042021-12-16 20:56:57 +00002107 semsg(_(e_no_such_variable_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002108 return FAIL;
2109}
2110
2111/*
2112 * Lock or unlock variable indicated by "lp".
2113 * "deep" is the levels to go (-1 for unlimited);
2114 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
2115 */
2116 static int
2117do_lock_var(
2118 lval_T *lp,
2119 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002120 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002121 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002122 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002123{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002124 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002125 int ret = OK;
2126 int cc;
2127 dictitem_T *di;
2128
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002129 if (lp->ll_tv == NULL)
2130 {
2131 cc = *name_end;
2132 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002133 if (*lp->ll_name == '$')
2134 {
Bram Moolenaar3a846e62022-01-01 16:21:00 +00002135 semsg(_(e_cannot_lock_or_unlock_variable_str), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002136 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002137 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002138 else
2139 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002140 // Normal name or expanded name.
2141 di = find_var(lp->ll_name, NULL, TRUE);
2142 if (di == NULL)
Bram Moolenaar04b568b2021-11-22 21:58:41 +00002143 {
2144 if (in_vim9script())
2145 semsg(_(e_cannot_find_variable_to_unlock_str),
2146 lp->ll_name);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002147 ret = FAIL;
Bram Moolenaar04b568b2021-11-22 21:58:41 +00002148 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002149 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002150 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01002151 if ((di->di_flags & DI_FLAGS_FIX)
2152 && di->di_tv.v_type != VAR_DICT
2153 && di->di_tv.v_type != VAR_LIST)
2154 {
2155 // For historic reasons this error is not given for a list
2156 // or dict. E.g., the b: dict could be locked/unlocked.
2157 semsg(_(e_cannot_lock_or_unlock_variable_str), lp->ll_name);
2158 ret = FAIL;
2159 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002160 else
Bram Moolenaar7a411a32022-04-04 14:58:06 +01002161 {
2162 if (in_vim9script())
2163 {
2164 svar_T *sv = find_typval_in_script(&di->di_tv,
2165 0, FALSE);
2166
2167 if (sv != NULL && sv->sv_const != 0)
2168 {
2169 semsg(_(e_cannot_change_readonly_variable_str),
2170 lp->ll_name);
2171 ret = FAIL;
2172 }
2173 }
2174
2175 if (ret == OK)
2176 {
2177 if (lock)
2178 di->di_flags |= DI_FLAGS_LOCK;
2179 else
2180 di->di_flags &= ~DI_FLAGS_LOCK;
2181 if (deep != 0)
2182 item_lock(&di->di_tv, deep, lock, FALSE);
2183 }
2184 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002185 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002186 }
2187 *name_end = cc;
2188 }
Bram Moolenaara187c432020-09-16 21:08:28 +02002189 else if (deep == 0)
2190 {
2191 // nothing to do
2192 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002193 else if (lp->ll_range)
2194 {
2195 listitem_T *li = lp->ll_li;
2196
2197 // (un)lock a range of List items.
2198 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
2199 {
Bram Moolenaar021bda52020-08-17 21:07:22 +02002200 item_lock(&li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002201 li = li->li_next;
2202 ++lp->ll_n1;
2203 }
2204 }
2205 else if (lp->ll_list != NULL)
2206 // (un)lock a List item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002207 item_lock(&lp->ll_li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002208 else
2209 // (un)lock a Dictionary item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002210 item_lock(&lp->ll_di->di_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002211
2212 return ret;
2213}
2214
2215/*
2216 * Lock or unlock an item. "deep" is nr of levels to go.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002217 * When "check_refcount" is TRUE do not lock a list or dict with a reference
2218 * count larger than 1.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002219 */
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02002220 void
Bram Moolenaar021bda52020-08-17 21:07:22 +02002221item_lock(typval_T *tv, int deep, int lock, int check_refcount)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002222{
2223 static int recurse = 0;
2224 list_T *l;
2225 listitem_T *li;
2226 dict_T *d;
2227 blob_T *b;
2228 hashitem_T *hi;
2229 int todo;
2230
2231 if (recurse >= DICT_MAXNEST)
2232 {
Bram Moolenaar677658a2022-01-05 16:09:06 +00002233 emsg(_(e_variable_nested_too_deep_for_unlock));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002234 return;
2235 }
2236 if (deep == 0)
2237 return;
2238 ++recurse;
2239
2240 // lock/unlock the item itself
2241 if (lock)
2242 tv->v_lock |= VAR_LOCKED;
2243 else
2244 tv->v_lock &= ~VAR_LOCKED;
2245
2246 switch (tv->v_type)
2247 {
2248 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02002249 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002250 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002251 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002252 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002253 case VAR_STRING:
2254 case VAR_FUNC:
2255 case VAR_PARTIAL:
2256 case VAR_FLOAT:
2257 case VAR_SPECIAL:
2258 case VAR_JOB:
2259 case VAR_CHANNEL:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02002260 case VAR_INSTR:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002261 break;
2262
2263 case VAR_BLOB:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002264 if ((b = tv->vval.v_blob) != NULL
2265 && !(check_refcount && b->bv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002266 {
2267 if (lock)
2268 b->bv_lock |= VAR_LOCKED;
2269 else
2270 b->bv_lock &= ~VAR_LOCKED;
2271 }
2272 break;
2273 case VAR_LIST:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002274 if ((l = tv->vval.v_list) != NULL
2275 && !(check_refcount && l->lv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002276 {
2277 if (lock)
2278 l->lv_lock |= VAR_LOCKED;
2279 else
2280 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar70c43d82022-01-26 21:01:15 +00002281 if (deep < 0 || deep > 1)
2282 {
2283 if (l->lv_first == &range_list_item)
2284 l->lv_lock |= VAR_ITEMS_LOCKED;
2285 else
2286 {
2287 // recursive: lock/unlock the items the List contains
2288 CHECK_LIST_MATERIALIZE(l);
2289 FOR_ALL_LIST_ITEMS(l, li) item_lock(&li->li_tv,
2290 deep - 1, lock, check_refcount);
2291 }
2292 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002293 }
2294 break;
2295 case VAR_DICT:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002296 if ((d = tv->vval.v_dict) != NULL
2297 && !(check_refcount && d->dv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002298 {
2299 if (lock)
2300 d->dv_lock |= VAR_LOCKED;
2301 else
2302 d->dv_lock &= ~VAR_LOCKED;
2303 if (deep < 0 || deep > 1)
2304 {
2305 // recursive: lock/unlock the items the List contains
2306 todo = (int)d->dv_hashtab.ht_used;
2307 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
2308 {
2309 if (!HASHITEM_EMPTY(hi))
2310 {
2311 --todo;
Bram Moolenaar021bda52020-08-17 21:07:22 +02002312 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock,
2313 check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002314 }
2315 }
2316 }
2317 }
2318 }
2319 --recurse;
2320}
2321
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002322#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
2323/*
2324 * Delete all "menutrans_" variables.
2325 */
2326 void
2327del_menutrans_vars(void)
2328{
2329 hashitem_T *hi;
2330 int todo;
2331
2332 hash_lock(&globvarht);
2333 todo = (int)globvarht.ht_used;
2334 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
2335 {
2336 if (!HASHITEM_EMPTY(hi))
2337 {
2338 --todo;
2339 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
2340 delete_var(&globvarht, hi);
2341 }
2342 }
2343 hash_unlock(&globvarht);
2344}
2345#endif
2346
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002347/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002348 * Local string buffer for the next two functions to store a variable name
2349 * with its prefix. Allocated in cat_prefix_varname(), freed later in
2350 * get_user_var_name().
2351 */
2352
2353static char_u *varnamebuf = NULL;
2354static int varnamebuflen = 0;
2355
2356/*
2357 * Function to concatenate a prefix and a variable name.
2358 */
Bram Moolenaar1bb4de52021-01-13 19:48:46 +01002359 char_u *
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002360cat_prefix_varname(int prefix, char_u *name)
2361{
2362 int len;
2363
2364 len = (int)STRLEN(name) + 3;
2365 if (len > varnamebuflen)
2366 {
2367 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002368 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002369 varnamebuf = alloc(len);
2370 if (varnamebuf == NULL)
2371 {
2372 varnamebuflen = 0;
2373 return NULL;
2374 }
2375 varnamebuflen = len;
2376 }
2377 *varnamebuf = prefix;
2378 varnamebuf[1] = ':';
2379 STRCPY(varnamebuf + 2, name);
2380 return varnamebuf;
2381}
2382
2383/*
2384 * Function given to ExpandGeneric() to obtain the list of user defined
2385 * (global/buffer/window/built-in) variable names.
2386 */
2387 char_u *
2388get_user_var_name(expand_T *xp, int idx)
2389{
2390 static long_u gdone;
2391 static long_u bdone;
2392 static long_u wdone;
2393 static long_u tdone;
2394 static int vidx;
2395 static hashitem_T *hi;
2396 hashtab_T *ht;
2397
2398 if (idx == 0)
2399 {
2400 gdone = bdone = wdone = vidx = 0;
2401 tdone = 0;
2402 }
2403
2404 // Global variables
2405 if (gdone < globvarht.ht_used)
2406 {
2407 if (gdone++ == 0)
2408 hi = globvarht.ht_array;
2409 else
2410 ++hi;
2411 while (HASHITEM_EMPTY(hi))
2412 ++hi;
2413 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
2414 return cat_prefix_varname('g', hi->hi_key);
2415 return hi->hi_key;
2416 }
2417
2418 // b: variables
Bram Moolenaar0f6e28f2022-02-20 20:49:35 +00002419 ht = &prevwin_curwin()->w_buffer->b_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002420 if (bdone < ht->ht_used)
2421 {
2422 if (bdone++ == 0)
2423 hi = ht->ht_array;
2424 else
2425 ++hi;
2426 while (HASHITEM_EMPTY(hi))
2427 ++hi;
2428 return cat_prefix_varname('b', hi->hi_key);
2429 }
2430
2431 // w: variables
Bram Moolenaar0f6e28f2022-02-20 20:49:35 +00002432 ht = &prevwin_curwin()->w_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002433 if (wdone < ht->ht_used)
2434 {
2435 if (wdone++ == 0)
2436 hi = ht->ht_array;
2437 else
2438 ++hi;
2439 while (HASHITEM_EMPTY(hi))
2440 ++hi;
2441 return cat_prefix_varname('w', hi->hi_key);
2442 }
2443
2444 // t: variables
2445 ht = &curtab->tp_vars->dv_hashtab;
2446 if (tdone < ht->ht_used)
2447 {
2448 if (tdone++ == 0)
2449 hi = ht->ht_array;
2450 else
2451 ++hi;
2452 while (HASHITEM_EMPTY(hi))
2453 ++hi;
2454 return cat_prefix_varname('t', hi->hi_key);
2455 }
2456
2457 // v: variables
2458 if (vidx < VV_LEN)
2459 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
2460
2461 VIM_CLEAR(varnamebuf);
2462 varnamebuflen = 0;
2463 return NULL;
2464}
2465
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002466 char *
2467get_var_special_name(int nr)
2468{
2469 switch (nr)
2470 {
Bram Moolenaara8b8af12021-01-01 15:11:04 +01002471 case VVAL_FALSE: return in_vim9script() ? "false" : "v:false";
2472 case VVAL_TRUE: return in_vim9script() ? "true" : "v:true";
Bram Moolenaar67977822021-01-03 21:53:53 +01002473 case VVAL_NULL: return in_vim9script() ? "null" : "v:null";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002474 case VVAL_NONE: return "v:none";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002475 }
2476 internal_error("get_var_special_name()");
2477 return "42";
2478}
2479
2480/*
2481 * Returns the global variable dictionary
2482 */
2483 dict_T *
2484get_globvar_dict(void)
2485{
2486 return &globvardict;
2487}
2488
2489/*
2490 * Returns the global variable hash table
2491 */
2492 hashtab_T *
2493get_globvar_ht(void)
2494{
2495 return &globvarht;
2496}
2497
2498/*
2499 * Returns the v: variable dictionary
2500 */
2501 dict_T *
2502get_vimvar_dict(void)
2503{
2504 return &vimvardict;
2505}
2506
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002507/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002508 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002509 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002510 */
2511 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002512find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002513{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002514 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2515 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002516
2517 if (di == NULL)
2518 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002519 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002520 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2521 return (int)(vv - vimvars);
2522}
2523
2524
2525/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002526 * Set type of v: variable to "type".
2527 */
2528 void
2529set_vim_var_type(int idx, vartype_T type)
2530{
Bram Moolenaard787e402021-12-24 21:36:12 +00002531 vimvars[idx].vv_tv_type = type;
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002532}
2533
2534/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002535 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002536 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002537 */
2538 void
2539set_vim_var_nr(int idx, varnumber_T val)
2540{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002541 vimvars[idx].vv_nr = val;
2542}
2543
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002544 char *
2545get_vim_var_name(int idx)
2546{
2547 return vimvars[idx].vv_name;
2548}
2549
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002550/*
2551 * Get typval_T v: variable value.
2552 */
2553 typval_T *
2554get_vim_var_tv(int idx)
2555{
2556 return &vimvars[idx].vv_tv;
2557}
2558
Bram Moolenaard787e402021-12-24 21:36:12 +00002559 type_T *
2560get_vim_var_type(int idx, garray_T *type_list)
2561{
2562 if (vimvars[idx].vv_type != NULL)
2563 return vimvars[idx].vv_type;
2564 return typval2type_vimvar(&vimvars[idx].vv_tv, type_list);
2565}
2566
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002567/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002568 * Set v: variable to "tv". Only accepts the same type.
2569 * Takes over the value of "tv".
2570 */
2571 int
2572set_vim_var_tv(int idx, typval_T *tv)
2573{
Bram Moolenaard787e402021-12-24 21:36:12 +00002574 if (vimvars[idx].vv_tv_type != tv->v_type)
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002575 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002576 emsg(_(e_type_mismatch_for_v_variable));
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002577 clear_tv(tv);
2578 return FAIL;
2579 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002580 // VV_RO is also checked when compiling, but let's check here as well.
2581 if (vimvars[idx].vv_flags & VV_RO)
2582 {
Bram Moolenaard8e44472021-07-21 22:20:33 +02002583 semsg(_(e_cannot_change_readonly_variable_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002584 return FAIL;
2585 }
2586 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2587 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00002588 semsg(_(e_cannot_set_variable_in_sandbox_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002589 return FAIL;
2590 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002591 clear_tv(&vimvars[idx].vv_di.di_tv);
2592 vimvars[idx].vv_di.di_tv = *tv;
2593 return OK;
2594}
2595
2596/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002597 * Get number v: variable value.
2598 */
2599 varnumber_T
2600get_vim_var_nr(int idx)
2601{
2602 return vimvars[idx].vv_nr;
2603}
2604
2605/*
2606 * Get string v: variable value. Uses a static buffer, can only be used once.
2607 * If the String variable has never been set, return an empty string.
2608 * Never returns NULL;
2609 */
2610 char_u *
2611get_vim_var_str(int idx)
2612{
2613 return tv_get_string(&vimvars[idx].vv_tv);
2614}
2615
2616/*
2617 * Get List v: variable value. Caller must take care of reference count when
2618 * needed.
2619 */
2620 list_T *
2621get_vim_var_list(int idx)
2622{
2623 return vimvars[idx].vv_list;
2624}
2625
2626/*
2627 * Get Dict v: variable value. Caller must take care of reference count when
2628 * needed.
2629 */
2630 dict_T *
2631get_vim_var_dict(int idx)
2632{
2633 return vimvars[idx].vv_dict;
2634}
2635
2636/*
2637 * Set v:char to character "c".
2638 */
2639 void
2640set_vim_var_char(int c)
2641{
2642 char_u buf[MB_MAXBYTES + 1];
2643
2644 if (has_mbyte)
2645 buf[(*mb_char2bytes)(c, buf)] = NUL;
2646 else
2647 {
2648 buf[0] = c;
2649 buf[1] = NUL;
2650 }
2651 set_vim_var_string(VV_CHAR, buf, -1);
2652}
2653
2654/*
2655 * Set v:count to "count" and v:count1 to "count1".
2656 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2657 */
2658 void
2659set_vcount(
2660 long count,
2661 long count1,
2662 int set_prevcount)
2663{
2664 if (set_prevcount)
2665 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2666 vimvars[VV_COUNT].vv_nr = count;
2667 vimvars[VV_COUNT1].vv_nr = count1;
2668}
2669
2670/*
2671 * Save variables that might be changed as a side effect. Used when executing
2672 * a timer callback.
2673 */
2674 void
2675save_vimvars(vimvars_save_T *vvsave)
2676{
2677 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2678 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2679 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2680}
2681
2682/*
2683 * Restore variables saved by save_vimvars().
2684 */
2685 void
2686restore_vimvars(vimvars_save_T *vvsave)
2687{
2688 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2689 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2690 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2691}
2692
2693/*
2694 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2695 * value.
2696 */
2697 void
2698set_vim_var_string(
2699 int idx,
2700 char_u *val,
2701 int len) // length of "val" to use or -1 (whole string)
2702{
2703 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002704 vimvars[idx].vv_tv_type = VAR_STRING;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002705 if (val == NULL)
2706 vimvars[idx].vv_str = NULL;
2707 else if (len == -1)
2708 vimvars[idx].vv_str = vim_strsave(val);
2709 else
2710 vimvars[idx].vv_str = vim_strnsave(val, len);
2711}
2712
2713/*
2714 * Set List v: variable to "val".
2715 */
2716 void
2717set_vim_var_list(int idx, list_T *val)
2718{
2719 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002720 vimvars[idx].vv_tv_type = VAR_LIST;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002721 vimvars[idx].vv_list = val;
2722 if (val != NULL)
2723 ++val->lv_refcount;
2724}
2725
2726/*
2727 * Set Dictionary v: variable to "val".
2728 */
2729 void
2730set_vim_var_dict(int idx, dict_T *val)
2731{
2732 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002733 vimvars[idx].vv_tv_type = VAR_DICT;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002734 vimvars[idx].vv_dict = val;
2735 if (val != NULL)
2736 {
2737 ++val->dv_refcount;
2738 dict_set_items_ro(val);
2739 }
2740}
2741
2742/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002743 * Set the v:argv list.
2744 */
2745 void
2746set_argv_var(char **argv, int argc)
2747{
2748 list_T *l = list_alloc();
2749 int i;
2750
2751 if (l == NULL)
2752 getout(1);
2753 l->lv_lock = VAR_FIXED;
2754 for (i = 0; i < argc; ++i)
2755 {
2756 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2757 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002758 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002759 }
2760 set_vim_var_list(VV_ARGV, l);
2761}
2762
2763/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002764 * Reset v:register, taking the 'clipboard' setting into account.
2765 */
2766 void
2767reset_reg_var(void)
2768{
2769 int regname = 0;
2770
2771 // Adjust the register according to 'clipboard', so that when
2772 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2773#ifdef FEAT_CLIPBOARD
2774 adjust_clip_reg(&regname);
2775#endif
2776 set_reg_var(regname);
2777}
2778
2779/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002780 * Set v:register if needed.
2781 */
2782 void
2783set_reg_var(int c)
2784{
2785 char_u regname;
2786
2787 if (c == 0 || c == ' ')
2788 regname = '"';
2789 else
2790 regname = c;
2791 // Avoid free/alloc when the value is already right.
2792 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2793 set_vim_var_string(VV_REG, &regname, 1);
2794}
2795
2796/*
2797 * Get or set v:exception. If "oldval" == NULL, return the current value.
2798 * Otherwise, restore the value to "oldval" and return NULL.
2799 * Must always be called in pairs to save and restore v:exception! Does not
2800 * take care of memory allocations.
2801 */
2802 char_u *
2803v_exception(char_u *oldval)
2804{
2805 if (oldval == NULL)
2806 return vimvars[VV_EXCEPTION].vv_str;
2807
2808 vimvars[VV_EXCEPTION].vv_str = oldval;
2809 return NULL;
2810}
2811
2812/*
2813 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2814 * Otherwise, restore the value to "oldval" and return NULL.
2815 * Must always be called in pairs to save and restore v:throwpoint! Does not
2816 * take care of memory allocations.
2817 */
2818 char_u *
2819v_throwpoint(char_u *oldval)
2820{
2821 if (oldval == NULL)
2822 return vimvars[VV_THROWPOINT].vv_str;
2823
2824 vimvars[VV_THROWPOINT].vv_str = oldval;
2825 return NULL;
2826}
2827
2828/*
2829 * Set v:cmdarg.
2830 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2831 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2832 * Must always be called in pairs!
2833 */
2834 char_u *
2835set_cmdarg(exarg_T *eap, char_u *oldarg)
2836{
2837 char_u *oldval;
2838 char_u *newval;
2839 unsigned len;
2840
2841 oldval = vimvars[VV_CMDARG].vv_str;
2842 if (eap == NULL)
2843 {
2844 vim_free(oldval);
2845 vimvars[VV_CMDARG].vv_str = oldarg;
2846 return NULL;
2847 }
2848
2849 if (eap->force_bin == FORCE_BIN)
2850 len = 6;
2851 else if (eap->force_bin == FORCE_NOBIN)
2852 len = 8;
2853 else
2854 len = 0;
2855
2856 if (eap->read_edit)
2857 len += 7;
2858
2859 if (eap->force_ff != 0)
2860 len += 10; // " ++ff=unix"
2861 if (eap->force_enc != 0)
2862 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2863 if (eap->bad_char != 0)
2864 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2865
2866 newval = alloc(len + 1);
2867 if (newval == NULL)
2868 return NULL;
2869
2870 if (eap->force_bin == FORCE_BIN)
2871 sprintf((char *)newval, " ++bin");
2872 else if (eap->force_bin == FORCE_NOBIN)
2873 sprintf((char *)newval, " ++nobin");
2874 else
2875 *newval = NUL;
2876
2877 if (eap->read_edit)
2878 STRCAT(newval, " ++edit");
2879
2880 if (eap->force_ff != 0)
2881 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2882 eap->force_ff == 'u' ? "unix"
2883 : eap->force_ff == 'd' ? "dos"
2884 : "mac");
2885 if (eap->force_enc != 0)
2886 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2887 eap->cmd + eap->force_enc);
2888 if (eap->bad_char == BAD_KEEP)
2889 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2890 else if (eap->bad_char == BAD_DROP)
2891 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2892 else if (eap->bad_char != 0)
2893 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2894 vimvars[VV_CMDARG].vv_str = newval;
2895 return oldval;
2896}
2897
2898/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002899 * Get the value of internal variable "name".
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002900 * If "flags" has EVAL_VAR_IMPORT may return a VAR_ANY with v_number set to the
2901 * imported script ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002902 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2903 */
2904 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002905eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002906 char_u *name,
2907 int len, // length of "name"
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002908 scid_T sid, // script ID for imported item or zero
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002909 typval_T *rettv, // NULL when only checking existence
2910 dictitem_T **dip, // non-NULL when typval's dict item is needed
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002911 int flags) // EVAL_VAR_ flags
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002912{
2913 int ret = OK;
2914 typval_T *tv = NULL;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002915 int found = FALSE;
Bram Moolenaarf055d452021-07-08 20:57:24 +02002916 hashtab_T *ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002917 int cc;
Bram Moolenaarc967d572021-07-08 21:38:50 +02002918 type_T *type = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002919
2920 // truncate the name, so that we can use strcmp()
2921 cc = name[len];
2922 name[len] = NUL;
2923
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002924 // Check for local variable when debugging.
2925 if ((tv = lookup_debug_var(name)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002926 {
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002927 // Check for user-defined variables.
Bram Moolenaarc967d572021-07-08 21:38:50 +02002928 dictitem_T *v = find_var(name, &ht, flags & EVAL_VAR_NOAUTOLOAD);
2929
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002930 if (v != NULL)
2931 {
2932 tv = &v->di_tv;
2933 if (dip != NULL)
2934 *dip = v;
2935 }
Bram Moolenaarc967d572021-07-08 21:38:50 +02002936 else
2937 ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002938 }
2939
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002940 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002941 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002942 imported_T *import = NULL;
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002943 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
2944
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002945 if (sid == 0)
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00002946 import = find_imported(p, 0, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002947
2948 // imported variable from another script
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002949 if (import != NULL || sid != 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002950 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002951 if ((flags & EVAL_VAR_IMPORT) == 0)
Bram Moolenaarc620c052020-07-08 15:16:19 +02002952 {
Bram Moolenaar71f21932022-01-07 18:20:55 +00002953 if (SCRIPT_ID_VALID(sid))
Bram Moolenaarc620c052020-07-08 15:16:19 +02002954 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002955 ht = &SCRIPT_VARS(sid);
2956 if (ht != NULL)
2957 {
2958 dictitem_T *v = find_var_in_ht(ht, 0, name,
2959 flags & EVAL_VAR_NOAUTOLOAD);
2960
2961 if (v != NULL)
2962 {
2963 tv = &v->di_tv;
2964 if (dip != NULL)
2965 *dip = v;
2966 }
2967 else
2968 ht = NULL;
2969 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002970 }
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002971 else
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002972 {
2973 if (flags & EVAL_VAR_VERBOSE)
Bram Moolenaardd5893b2022-01-20 21:32:54 +00002974 semsg(_(e_expected_dot_after_name_str), name);
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002975 ret = FAIL;
2976 }
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002977 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002978 else
2979 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002980 if (rettv != NULL)
2981 {
Bram Moolenaar753885b2022-08-24 16:30:36 +01002982 // special value that is used in handle_subscript()
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002983 rettv->v_type = VAR_ANY;
2984 rettv->vval.v_number = sid != 0 ? sid : import->imp_sid;
2985 }
2986 found = TRUE;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002987 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002988 }
Bram Moolenaar052ff292021-12-11 13:54:46 +00002989 else if (in_vim9script() && (flags & EVAL_VAR_NO_FUNC) == 0)
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002990 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002991 int has_g_prefix = STRNCMP(name, "g:", 2) == 0;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002992 ufunc_T *ufunc = find_func(name, FALSE);
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002993
Bram Moolenaarb033ee22021-08-15 16:08:36 +02002994 // In Vim9 script we can get a function reference by using the
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002995 // function name. For a global non-autoload function "g:" is
2996 // required.
2997 if (ufunc != NULL && (has_g_prefix
2998 || !func_requires_g_prefix(ufunc)))
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002999 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003000 found = TRUE;
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003001 if (rettv != NULL)
3002 {
3003 rettv->v_type = VAR_FUNC;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003004 if (has_g_prefix)
Bram Moolenaaref082e12021-12-12 21:02:03 +00003005 // Keep the "g:", otherwise script-local may be
3006 // assumed.
3007 rettv->vval.v_string = vim_strsave(name);
3008 else
3009 rettv->vval.v_string = vim_strsave(ufunc->uf_name);
Bram Moolenaarb033ee22021-08-15 16:08:36 +02003010 if (rettv->vval.v_string != NULL)
3011 func_ref(ufunc->uf_name);
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003012 }
3013 }
3014 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003015 }
3016
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003017 if (!found)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003018 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02003019 if (tv == NULL)
3020 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003021 if (rettv != NULL && (flags & EVAL_VAR_VERBOSE))
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003022 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarc620c052020-07-08 15:16:19 +02003023 ret = FAIL;
3024 }
3025 else if (rettv != NULL)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003026 {
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003027 svar_T *sv = NULL;
3028 int was_assigned = FALSE;
3029
Bram Moolenaar11005b02021-07-11 20:59:00 +02003030 if (ht != NULL && ht == get_script_local_ht()
3031 && tv != &SCRIPT_SV(current_sctx.sc_sid)->sv_var.di_tv)
Bram Moolenaarf055d452021-07-08 20:57:24 +02003032 {
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003033 sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaarf055d452021-07-08 20:57:24 +02003034 if (sv != NULL)
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003035 {
Bram Moolenaarf055d452021-07-08 20:57:24 +02003036 type = sv->sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003037 was_assigned = sv->sv_flags & SVFLAG_ASSIGNED;
3038 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003039 }
3040
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003041 // If a list or dict variable wasn't initialized and has meaningful
3042 // type, do it now. Not for global variables, they are not
3043 // declared.
Bram Moolenaar7a222242022-03-01 19:23:24 +00003044 if (ht != &globvarht)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003045 {
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003046 if (tv->v_type == VAR_DICT && tv->vval.v_dict == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003047 && ((type != NULL && !was_assigned)
Bram Moolenaar859cc212022-03-28 15:22:35 +01003048 || !in_vim9script()))
Bram Moolenaarf055d452021-07-08 20:57:24 +02003049 {
Bram Moolenaar7a222242022-03-01 19:23:24 +00003050 tv->vval.v_dict = dict_alloc();
3051 if (tv->vval.v_dict != NULL)
3052 {
3053 ++tv->vval.v_dict->dv_refcount;
3054 tv->vval.v_dict->dv_type = alloc_type(type);
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003055 if (sv != NULL)
3056 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar7a222242022-03-01 19:23:24 +00003057 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003058 }
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003059 else if (tv->v_type == VAR_LIST && tv->vval.v_list == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003060 && ((type != NULL && !was_assigned)
Bram Moolenaar501f9782022-03-27 16:51:04 +01003061 || !in_vim9script()))
Bram Moolenaarf055d452021-07-08 20:57:24 +02003062 {
Bram Moolenaar7a222242022-03-01 19:23:24 +00003063 tv->vval.v_list = list_alloc();
3064 if (tv->vval.v_list != NULL)
3065 {
3066 ++tv->vval.v_list->lv_refcount;
3067 tv->vval.v_list->lv_type = alloc_type(type);
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003068 if (sv != NULL)
3069 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar7a222242022-03-01 19:23:24 +00003070 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003071 }
Bram Moolenaar859cc212022-03-28 15:22:35 +01003072 else if (tv->v_type == VAR_BLOB && tv->vval.v_blob == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003073 && ((type != NULL && !was_assigned)
Bram Moolenaar859cc212022-03-28 15:22:35 +01003074 || !in_vim9script()))
3075 {
3076 tv->vval.v_blob = blob_alloc();
3077 if (tv->vval.v_blob != NULL)
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003078 {
Bram Moolenaar859cc212022-03-28 15:22:35 +01003079 ++tv->vval.v_blob->bv_refcount;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003080 if (sv != NULL)
3081 sv->sv_flags |= SVFLAG_ASSIGNED;
3082 }
Bram Moolenaar859cc212022-03-28 15:22:35 +01003083 }
Bram Moolenaarb7c21af2021-04-18 14:12:31 +02003084 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02003085 copy_tv(tv, rettv);
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003086 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003087 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003088
3089 name[len] = cc;
3090
3091 return ret;
3092}
3093
3094/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003095 * Check if variable "name[len]" is a local variable or an argument.
3096 * If so, "*eval_lavars_used" is set to TRUE.
3097 */
3098 void
3099check_vars(char_u *name, int len)
3100{
3101 int cc;
3102 char_u *varname;
3103 hashtab_T *ht;
3104
3105 if (eval_lavars_used == NULL)
3106 return;
3107
3108 // truncate the name, so that we can use strcmp()
3109 cc = name[len];
3110 name[len] = NUL;
3111
3112 ht = find_var_ht(name, &varname);
3113 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
3114 {
3115 if (find_var(name, NULL, TRUE) != NULL)
3116 *eval_lavars_used = TRUE;
3117 }
3118
3119 name[len] = cc;
3120}
3121
3122/*
3123 * Find variable "name" in the list of variables.
3124 * Return a pointer to it if found, NULL if not found.
3125 * Careful: "a:0" variables don't have a name.
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003126 * When "htp" is not NULL set "htp" to the hashtab_T used.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003127 */
3128 dictitem_T *
3129find_var(char_u *name, hashtab_T **htp, int no_autoload)
3130{
3131 char_u *varname;
3132 hashtab_T *ht;
3133 dictitem_T *ret = NULL;
3134
3135 ht = find_var_ht(name, &varname);
3136 if (htp != NULL)
3137 *htp = ht;
3138 if (ht == NULL)
3139 return NULL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003140 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003141 if (ret != NULL)
3142 return ret;
3143
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003144 // Search in parent scope for lambda
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003145 ret = find_var_in_scoped_ht(name, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003146 if (ret != NULL)
3147 return ret;
3148
3149 // in Vim9 script items without a scope can be script-local
3150 if (in_vim9script() && name[0] != NUL && name[1] != ':')
3151 {
3152 ht = get_script_local_ht();
3153 if (ht != NULL)
3154 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003155 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003156 if (ret != NULL)
3157 {
3158 if (htp != NULL)
3159 *htp = ht;
3160 return ret;
3161 }
3162 }
3163 }
3164
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003165 // When using "vim9script autoload" script-local items are prefixed but can
3166 // be used with s:name.
3167 if (SCRIPT_ID_VALID(current_sctx.sc_sid)
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01003168 && (in_vim9script() || (name[0] == 's' && name[1] == ':')))
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003169 {
3170 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
3171
3172 if (si->sn_autoload_prefix != NULL)
3173 {
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01003174 char_u *base_name = (name[0] == 's' && name[1] == ':')
3175 ? name + 2 : name;
3176 char_u *auto_name = concat_str(si->sn_autoload_prefix, base_name);
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003177
3178 if (auto_name != NULL)
3179 {
3180 ht = &globvarht;
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01003181 ret = find_var_in_ht(ht, 'g', auto_name, TRUE);
Bram Moolenaar130f65d2022-01-13 20:39:41 +00003182 vim_free(auto_name);
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003183 if (ret != NULL)
3184 {
3185 if (htp != NULL)
3186 *htp = ht;
3187 return ret;
3188 }
3189 }
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003190 }
3191 }
3192
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003193 return NULL;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003194}
3195
3196/*
Bram Moolenaar71f21932022-01-07 18:20:55 +00003197 * Like find_var() but if the name starts with <SNR>99_ then look in the
3198 * referenced script (used for a funcref).
3199 */
3200 dictitem_T *
3201find_var_also_in_script(char_u *name, hashtab_T **htp, int no_autoload)
3202{
3203 if (STRNCMP(name, "<SNR>", 5) == 0 && isdigit(name[5]))
3204 {
3205 char_u *p = name + 5;
3206 int sid = getdigits(&p);
3207
3208 if (SCRIPT_ID_VALID(sid) && *p == '_')
3209 {
3210 hashtab_T *ht = &SCRIPT_VARS(sid);
3211
3212 if (ht != NULL)
3213 {
3214 dictitem_T *di = find_var_in_ht(ht, 0, p + 1, no_autoload);
3215
3216 if (di != NULL)
Bram Moolenaaraa9b3ca2022-01-08 15:44:22 +00003217 {
3218 if (htp != NULL)
3219 *htp = ht;
Bram Moolenaar71f21932022-01-07 18:20:55 +00003220 return di;
Bram Moolenaaraa9b3ca2022-01-08 15:44:22 +00003221 }
Bram Moolenaar71f21932022-01-07 18:20:55 +00003222 }
3223 }
3224 }
3225
3226 return find_var(name, htp, no_autoload);
3227}
3228
3229/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003230 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02003231 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003232 * Returns NULL if not found.
3233 */
3234 dictitem_T *
3235find_var_in_ht(
3236 hashtab_T *ht,
3237 int htname,
3238 char_u *varname,
3239 int no_autoload)
3240{
3241 hashitem_T *hi;
3242
3243 if (*varname == NUL)
3244 {
3245 // Must be something like "s:", otherwise "ht" would be NULL.
3246 switch (htname)
3247 {
3248 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
3249 case 'g': return &globvars_var;
3250 case 'v': return &vimvars_var;
3251 case 'b': return &curbuf->b_bufvar;
3252 case 'w': return &curwin->w_winvar;
3253 case 't': return &curtab->tp_winvar;
3254 case 'l': return get_funccal_local_var();
3255 case 'a': return get_funccal_args_var();
3256 }
3257 return NULL;
3258 }
3259
3260 hi = hash_find(ht, varname);
3261 if (HASHITEM_EMPTY(hi))
3262 {
3263 // For global variables we may try auto-loading the script. If it
3264 // worked find the variable again. Don't auto-load a script if it was
3265 // loaded already, otherwise it would be loaded every time when
3266 // checking if a function name is a Funcref variable.
3267 if (ht == &globvarht && !no_autoload)
3268 {
3269 // Note: script_autoload() may make "hi" invalid. It must either
3270 // be obtained again or not used.
3271 if (!script_autoload(varname, FALSE) || aborting())
3272 return NULL;
3273 hi = hash_find(ht, varname);
3274 }
3275 if (HASHITEM_EMPTY(hi))
3276 return NULL;
3277 }
3278 return HI2DI(hi);
3279}
3280
3281/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003282 * Get the script-local hashtab. NULL if not in a script context.
3283 */
Bram Moolenaar922acbd2020-10-08 21:30:40 +02003284 hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003285get_script_local_ht(void)
3286{
3287 scid_T sid = current_sctx.sc_sid;
3288
Bram Moolenaare3d46852020-08-29 13:39:17 +02003289 if (SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003290 return &SCRIPT_VARS(sid);
3291 return NULL;
3292}
3293
3294/*
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003295 * Look for "name[len]" in script-local variables and functions.
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003296 * When "cmd" is TRUE it must look like a command, a function must be followed
3297 * by "(" or "->".
Bram Moolenaar709664c2020-12-12 14:33:41 +01003298 * Return OK when found, FAIL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003299 */
Bram Moolenaar709664c2020-12-12 14:33:41 +01003300 int
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003301lookup_scriptitem(
Bram Moolenaar709664c2020-12-12 14:33:41 +01003302 char_u *name,
3303 size_t len,
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003304 int cmd,
Bram Moolenaar709664c2020-12-12 14:33:41 +01003305 cctx_T *dummy UNUSED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003306{
3307 hashtab_T *ht = get_script_local_ht();
3308 char_u buffer[30];
3309 char_u *p;
Bram Moolenaar709664c2020-12-12 14:33:41 +01003310 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003311 hashitem_T *hi;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003312 int is_global = FALSE;
3313 char_u *fname = name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003314
3315 if (ht == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003316 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003317 if (len < sizeof(buffer) - 1)
3318 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02003319 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003320 vim_strncpy(buffer, name, len);
3321 p = buffer;
3322 }
3323 else
3324 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003325 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003326 if (p == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003327 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003328 }
3329
3330 hi = hash_find(ht, p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01003331 res = HASHITEM_EMPTY(hi) ? FAIL : OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003332
3333 // if not script-local, then perhaps imported
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003334 if (res == FAIL && find_imported(p, 0, FALSE) != NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003335 res = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003336 if (p != buffer)
3337 vim_free(p);
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003338
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003339 // Find a function, so that a following "->" works.
3340 // When used as a command require "(" or "->" to follow, "Cmd" is a user
3341 // command while "Cmd()" is a function call.
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003342 if (res != OK)
3343 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003344 p = skipwhite(name + len);
3345
3346 if (!cmd || name[len] == '(' || (p[0] == '-' && p[1] == '>'))
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003347 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003348 // Do not check for an internal function, since it might also be a
3349 // valid command, such as ":split" versus "split()".
3350 // Skip "g:" before a function name.
3351 if (name[0] == 'g' && name[1] == ':')
3352 {
3353 is_global = TRUE;
3354 fname = name + 2;
3355 }
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003356 if (find_func(fname, is_global) != NULL)
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003357 res = OK;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003358 }
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003359 }
3360
Bram Moolenaar709664c2020-12-12 14:33:41 +01003361 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003362}
3363
3364/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003365 * Find the hashtab used for a variable name.
3366 * Return NULL if the name is not valid.
3367 * Set "varname" to the start of name without ':'.
3368 */
3369 hashtab_T *
3370find_var_ht(char_u *name, char_u **varname)
3371{
3372 hashitem_T *hi;
3373 hashtab_T *ht;
3374
3375 if (name[0] == NUL)
3376 return NULL;
3377 if (name[1] != ':')
3378 {
3379 // The name must not start with a colon or #.
3380 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
3381 return NULL;
3382 *varname = name;
3383
3384 // "version" is "v:version" in all scopes if scriptversion < 3.
3385 // Same for a few other variables marked with VV_COMPAT.
Bram Moolenaardd9de502021-08-15 13:49:42 +02003386 if (in_old_script(3))
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003387 {
3388 hi = hash_find(&compat_hashtab, name);
3389 if (!HASHITEM_EMPTY(hi))
3390 return &compat_hashtab;
3391 }
3392
3393 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003394 if (ht != NULL)
3395 return ht; // local variable
3396
Bram Moolenaarf0a40692021-06-11 22:05:47 +02003397 // In Vim9 script items at the script level are script-local, except
3398 // for autoload names.
3399 if (in_vim9script() && vim_strchr(name, AUTOLOAD_CHAR) == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003400 {
3401 ht = get_script_local_ht();
3402 if (ht != NULL)
3403 return ht;
3404 }
3405
3406 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003407 }
3408 *varname = name + 2;
3409 if (*name == 'g') // global variable
3410 return &globvarht;
3411 // There must be no ':' or '#' in the rest of the name, unless g: is used
3412 if (vim_strchr(name + 2, ':') != NULL
3413 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
3414 return NULL;
3415 if (*name == 'b') // buffer variable
3416 return &curbuf->b_vars->dv_hashtab;
3417 if (*name == 'w') // window variable
3418 return &curwin->w_vars->dv_hashtab;
3419 if (*name == 't') // tab page variable
3420 return &curtab->tp_vars->dv_hashtab;
3421 if (*name == 'v') // v: variable
3422 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01003423 if (get_current_funccal() != NULL
Bram Moolenaarca16c602022-09-06 18:57:08 +01003424 && get_current_funccal()->fc_func->uf_def_status
3425 == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003426 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01003427 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003428 if (*name == 'a') // a: function argument
3429 return get_funccal_args_ht();
3430 if (*name == 'l') // l: local function variable
3431 return get_funccal_local_ht();
3432 }
3433 if (*name == 's') // script variable
3434 {
3435 ht = get_script_local_ht();
3436 if (ht != NULL)
3437 return ht;
3438 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003439 return NULL;
3440}
3441
3442/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003443 * Get the string value of a (global/local) variable.
3444 * Note: see tv_get_string() for how long the pointer remains valid.
3445 * Returns NULL when it doesn't exist.
3446 */
3447 char_u *
3448get_var_value(char_u *name)
3449{
3450 dictitem_T *v;
3451
3452 v = find_var(name, NULL, FALSE);
3453 if (v == NULL)
3454 return NULL;
3455 return tv_get_string(&v->di_tv);
3456}
3457
3458/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003459 * Allocate a new hashtab for a sourced script. It will be used while
3460 * sourcing this script and when executing functions defined in the script.
3461 */
3462 void
3463new_script_vars(scid_T id)
3464{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003465 scriptvar_T *sv;
3466
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01003467 sv = ALLOC_CLEAR_ONE(scriptvar_T);
3468 if (sv == NULL)
3469 return;
3470 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01003471 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003472}
3473
3474/*
3475 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
3476 * point to it.
3477 */
3478 void
3479init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
3480{
3481 hash_init(&dict->dv_hashtab);
3482 dict->dv_lock = 0;
3483 dict->dv_scope = scope;
3484 dict->dv_refcount = DO_NOT_FREE_CNT;
3485 dict->dv_copyID = 0;
3486 dict_var->di_tv.vval.v_dict = dict;
3487 dict_var->di_tv.v_type = VAR_DICT;
3488 dict_var->di_tv.v_lock = VAR_FIXED;
3489 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
3490 dict_var->di_key[0] = NUL;
3491}
3492
3493/*
3494 * Unreference a dictionary initialized by init_var_dict().
3495 */
3496 void
3497unref_var_dict(dict_T *dict)
3498{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003499 // Now the dict needs to be freed if no one else is using it, go back to
3500 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003501 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
3502 dict_unref(dict);
3503}
3504
3505/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003506 * Clean up a list of internal variables.
3507 * Frees all allocated variables and the value they contain.
3508 * Clears hashtab "ht", does not free it.
3509 */
3510 void
3511vars_clear(hashtab_T *ht)
3512{
3513 vars_clear_ext(ht, TRUE);
3514}
3515
3516/*
3517 * Like vars_clear(), but only free the value if "free_val" is TRUE.
3518 */
3519 void
3520vars_clear_ext(hashtab_T *ht, int free_val)
3521{
3522 int todo;
3523 hashitem_T *hi;
3524 dictitem_T *v;
3525
3526 hash_lock(ht);
3527 todo = (int)ht->ht_used;
3528 for (hi = ht->ht_array; todo > 0; ++hi)
3529 {
3530 if (!HASHITEM_EMPTY(hi))
3531 {
3532 --todo;
3533
3534 // Free the variable. Don't remove it from the hashtab,
3535 // ht_array might change then. hash_clear() takes care of it
3536 // later.
3537 v = HI2DI(hi);
3538 if (free_val)
3539 clear_tv(&v->di_tv);
3540 if (v->di_flags & DI_FLAGS_ALLOC)
3541 vim_free(v);
3542 }
3543 }
3544 hash_clear(ht);
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003545 hash_init(ht);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003546}
3547
3548/*
3549 * Delete a variable from hashtab "ht" at item "hi".
3550 * Clear the variable value and free the dictitem.
3551 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02003552 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003553delete_var(hashtab_T *ht, hashitem_T *hi)
3554{
3555 dictitem_T *di = HI2DI(hi);
3556
3557 hash_remove(ht, hi);
3558 clear_tv(&di->di_tv);
3559 vim_free(di);
3560}
3561
3562/*
3563 * List the value of one internal variable.
3564 */
3565 static void
3566list_one_var(dictitem_T *v, char *prefix, int *first)
3567{
3568 char_u *tofree;
3569 char_u *s;
3570 char_u numbuf[NUMBUFLEN];
3571
3572 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
3573 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
3574 s == NULL ? (char_u *)"" : s, first);
3575 vim_free(tofree);
3576}
3577
3578 static void
3579list_one_var_a(
3580 char *prefix,
3581 char_u *name,
3582 int type,
3583 char_u *string,
3584 int *first) // when TRUE clear rest of screen and set to FALSE
3585{
3586 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
3587 msg_start();
3588 msg_puts(prefix);
3589 if (name != NULL) // "a:" vars don't have a name stored
3590 msg_puts((char *)name);
3591 msg_putchar(' ');
3592 msg_advance(22);
3593 if (type == VAR_NUMBER)
3594 msg_putchar('#');
3595 else if (type == VAR_FUNC || type == VAR_PARTIAL)
3596 msg_putchar('*');
3597 else if (type == VAR_LIST)
3598 {
3599 msg_putchar('[');
3600 if (*string == '[')
3601 ++string;
3602 }
3603 else if (type == VAR_DICT)
3604 {
3605 msg_putchar('{');
3606 if (*string == '{')
3607 ++string;
3608 }
3609 else
3610 msg_putchar(' ');
3611
3612 msg_outtrans(string);
3613
3614 if (type == VAR_FUNC || type == VAR_PARTIAL)
3615 msg_puts("()");
3616 if (*first)
3617 {
3618 msg_clr_eos();
3619 *first = FALSE;
3620 }
3621}
3622
3623/*
3624 * Set variable "name" to value in "tv".
3625 * If the variable already exists, the value is updated.
3626 * Otherwise the variable is created.
3627 */
3628 void
3629set_var(
3630 char_u *name,
3631 typval_T *tv,
3632 int copy) // make copy of value in "tv"
3633{
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003634 set_var_const(name, 0, NULL, tv, copy, ASSIGN_DECL, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003635}
3636
3637/*
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003638 * Set variable "name" to value in "tv_arg".
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003639 * When "sid" is non-zero "name" is in the script with this ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003640 * If the variable already exists and "is_const" is FALSE the value is updated.
3641 * Otherwise the variable is created.
3642 */
3643 void
3644set_var_const(
3645 char_u *name,
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003646 scid_T sid,
Bram Moolenaar7824fc82021-11-26 17:36:51 +00003647 type_T *type_arg,
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003648 typval_T *tv_arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003649 int copy, // make copy of value in "tv"
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003650 int flags_arg, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003651 int var_idx) // index for ":let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003652{
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003653 typval_T *tv = tv_arg;
Bram Moolenaar7824fc82021-11-26 17:36:51 +00003654 type_T *type = type_arg;
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003655 typval_T bool_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003656 dictitem_T *di;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003657 typval_T *dest_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003658 char_u *varname;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003659 char_u *name_tofree = NULL;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003660 hashtab_T *ht = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003661 int is_script_local;
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003662 int vim9script = in_vim9script();
Bram Moolenaare535db82021-03-31 21:07:24 +02003663 int var_in_vim9script;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003664 int var_in_autoload = FALSE;
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003665 int flags = flags_arg;
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003666 int free_tv_arg = !copy; // free tv_arg if not used
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003667
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003668 if (sid != 0)
3669 {
3670 if (SCRIPT_ID_VALID(sid))
3671 ht = &SCRIPT_VARS(sid);
3672 varname = name;
3673 }
3674 else
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003675 {
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003676 scriptitem_T *si;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003677
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003678 if (in_vim9script() && is_export
3679 && SCRIPT_ID_VALID(current_sctx.sc_sid)
3680 && (si = SCRIPT_ITEM(current_sctx.sc_sid))
Bram Moolenaar0e1574c2022-03-03 17:05:35 +00003681 ->sn_autoload_prefix != NULL)
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003682 {
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003683 // In a vim9 autoload script an exported variable is put in the
3684 // global namespace with the autoload prefix.
3685 var_in_autoload = TRUE;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003686 varname = concat_str(si->sn_autoload_prefix, name);
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003687 if (varname == NULL)
3688 goto failed;
3689 name_tofree = varname;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003690 ht = &globvarht;
3691 }
3692 else
3693 ht = find_var_ht(name, &varname);
3694 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003695 if (ht == NULL || *varname == NUL)
3696 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003697 semsg(_(e_illegal_variable_name_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003698 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003699 }
Bram Moolenaar54969f42022-02-07 13:56:44 +00003700 is_script_local = ht == get_script_local_ht() || sid != 0
3701 || var_in_autoload;
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003702
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003703 if (vim9script
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003704 && !is_script_local
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003705 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003706 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003707 && name[1] == ':')
Bram Moolenaar67979662020-06-20 22:50:47 +02003708 {
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003709 vim9_declare_error(name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003710 goto failed;
Bram Moolenaar67979662020-06-20 22:50:47 +02003711 }
Bram Moolenaar9510d222022-09-11 15:14:05 +01003712 if ((flags & ASSIGN_FOR_LOOP) && is_scoped_variable(name))
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003713 // Do not make g:var, w:var, b:var or t:var final.
3714 flags &= ~ASSIGN_FINAL;
3715
Bram Moolenaare535db82021-03-31 21:07:24 +02003716 var_in_vim9script = is_script_local && current_script_is_vim9();
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003717 if (var_in_vim9script && name[0] == '_' && name[1] == NUL)
3718 {
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02003719 // For "[a, _] = list" the underscore is ignored.
3720 if ((flags & ASSIGN_UNPACK) == 0)
3721 emsg(_(e_cannot_use_underscore_here));
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003722 goto failed;
3723 }
Bram Moolenaar67979662020-06-20 22:50:47 +02003724
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003725 di = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003726
Bram Moolenaar24e93162021-07-18 20:40:33 +02003727 if (di == NULL && var_in_vim9script)
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003728 {
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003729 imported_T *import = find_imported(varname, 0, FALSE);
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003730
Bram Moolenaar24e93162021-07-18 20:40:33 +02003731 if (import != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003732 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003733 // imported name space cannot be used
Bram Moolenaar24e93162021-07-18 20:40:33 +02003734 if ((flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003735 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003736 semsg(_(e_redefining_imported_item_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003737 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003738 }
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003739 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
3740 goto failed;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003741 }
Bram Moolenaar75e27d72022-02-13 13:56:29 +00003742 if (!in_vim9script())
3743 {
3744 semsg(_(e_cannot_create_vim9_script_variable_in_function_str),
3745 name);
3746 goto failed;
3747 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003748 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003749
Bram Moolenaar993faa32022-02-21 15:59:11 +00003750 // Search in parent scope which is possible to reference from lambda
3751 if (di == NULL)
3752 di = find_var_in_scoped_ht(name, TRUE);
3753
3754 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
3755 && var_wrong_func_name(name, di == NULL))
3756 goto failed;
3757
3758 if (need_convert_to_bool(type, tv))
Bram Moolenaar24e93162021-07-18 20:40:33 +02003759 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003760 // Destination is a bool and the value is not, but it can be
3761 // converted.
3762 CLEAR_FIELD(bool_tv);
3763 bool_tv.v_type = VAR_BOOL;
3764 bool_tv.vval.v_number = tv2bool(tv) ? VVAL_TRUE : VVAL_FALSE;
3765 tv = &bool_tv;
3766 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003767
Bram Moolenaar993faa32022-02-21 15:59:11 +00003768 if (di != NULL)
3769 {
3770 // Item already exists. Allowed to replace when reloading.
3771 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003772 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003773 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
3774 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003775 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003776 emsg(_(e_cannot_modify_existing_variable));
3777 goto failed;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003778 }
3779
Bram Moolenaar993faa32022-02-21 15:59:11 +00003780 if (is_script_local && vim9script
3781 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0)
Bram Moolenaar12be7342021-03-31 21:47:33 +02003782 {
3783 semsg(_(e_redefining_script_item_str), name);
3784 goto failed;
3785 }
3786
Bram Moolenaar993faa32022-02-21 15:59:11 +00003787 if (var_in_vim9script && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003788 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003789 where_T where = WHERE_INIT;
Bram Moolenaar7a411a32022-04-04 14:58:06 +01003790 svar_T *sv = find_typval_in_script(&di->di_tv, sid, TRUE);
Bram Moolenaar993faa32022-02-21 15:59:11 +00003791
3792 if (sv != NULL)
3793 {
3794 // check the type and adjust to bool if needed
3795 where.wt_index = var_idx;
3796 where.wt_variable = TRUE;
3797 if (check_script_var_type(sv, tv, name, where) == FAIL)
3798 goto failed;
3799 if (type == NULL)
3800 type = sv->sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003801 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003802 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003803 }
3804
Bram Moolenaar993faa32022-02-21 15:59:11 +00003805 if ((flags & ASSIGN_FOR_LOOP) == 0
3806 && var_check_permission(di, name) == FAIL)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003807 goto failed;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003808 }
3809 else
3810 {
3811 // can only redefine once
3812 di->di_flags &= ~DI_FLAGS_RELOAD;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003813
Bram Moolenaar993faa32022-02-21 15:59:11 +00003814 // A Vim9 script-local variable is also present in sn_all_vars
3815 // and sn_var_vals. It may set "type" from "tv".
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003816 if (var_in_vim9script || var_in_autoload)
Bram Moolenaar993faa32022-02-21 15:59:11 +00003817 update_vim9_script_var(FALSE, di,
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003818 var_in_autoload ? name : di->di_key, flags,
Bram Moolenaar993faa32022-02-21 15:59:11 +00003819 tv, &type, (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003820 }
3821
Bram Moolenaar993faa32022-02-21 15:59:11 +00003822 // existing variable, need to clear the value
3823
3824 // Handle setting internal di: variables separately where needed to
3825 // prevent changing the type.
3826 if (ht == &vimvarht)
3827 {
3828 if (di->di_tv.v_type == VAR_STRING)
3829 {
3830 VIM_CLEAR(di->di_tv.vval.v_string);
3831 if (copy || tv->v_type != VAR_STRING)
3832 {
3833 char_u *val = tv_get_string(tv);
3834
3835 // Careful: when assigning to v:errmsg and
3836 // tv_get_string() causes an error message the variable
3837 // will already be set.
3838 if (di->di_tv.vval.v_string == NULL)
3839 di->di_tv.vval.v_string = vim_strsave(val);
3840 }
3841 else
3842 {
3843 // Take over the string to avoid an extra alloc/free.
3844 di->di_tv.vval.v_string = tv->vval.v_string;
3845 tv->vval.v_string = NULL;
3846 }
3847 goto failed;
3848 }
3849 else if (di->di_tv.v_type == VAR_NUMBER)
3850 {
3851 di->di_tv.vval.v_number = tv_get_number(tv);
3852 if (STRCMP(varname, "searchforward") == 0)
3853 set_search_direction(di->di_tv.vval.v_number
3854 ? '/' : '?');
3855#ifdef FEAT_SEARCH_EXTRA
3856 else if (STRCMP(varname, "hlsearch") == 0)
3857 {
3858 no_hlsearch = !di->di_tv.vval.v_number;
Bram Moolenaara4d158b2022-08-14 14:17:45 +01003859 redraw_all_later(UPD_SOME_VALID);
Bram Moolenaar993faa32022-02-21 15:59:11 +00003860 }
3861#endif
3862 goto failed;
3863 }
3864 else if (di->di_tv.v_type != tv->v_type)
3865 {
3866 semsg(_(e_setting_str_to_value_with_wrong_type), name);
3867 goto failed;
3868 }
3869 }
3870
3871 clear_tv(&di->di_tv);
Bram Moolenaar766ae5b2022-09-14 00:30:51 +01003872
3873 if ((flags & ASSIGN_UPDATE_BLOCK_ID)
3874 && SCRIPT_ID_VALID(current_sctx.sc_sid))
3875 {
3876 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
3877
3878 update_script_var_block_id(name, si->sn_current_block_id);
3879 }
Bram Moolenaar993faa32022-02-21 15:59:11 +00003880 }
3881 else
3882 {
3883 // Item not found, check if a function already exists.
3884 if (is_script_local && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
3885 && lookup_scriptitem(name, STRLEN(name), FALSE, NULL) == OK)
3886 {
3887 semsg(_(e_redefining_script_item_str), name);
3888 goto failed;
3889 }
3890
3891 // add a new variable
3892 if (var_in_vim9script && (flags & ASSIGN_NO_DECL))
3893 {
3894 semsg(_(e_unknown_variable_str), name);
3895 goto failed;
3896 }
3897
3898 // Can't add "v:" or "a:" variable.
3899 if (ht == &vimvarht || ht == get_funccal_args_ht())
3900 {
3901 semsg(_(e_illegal_variable_name_str), name);
3902 goto failed;
3903 }
3904
3905 // Make sure the variable name is valid. In Vim9 script an
3906 // autoload variable must be prefixed with "g:" unless in an
3907 // autoload script.
3908 if (!valid_varname(varname, -1, !vim9script
3909 || STRNCMP(name, "g:", 2) == 0 || var_in_autoload))
3910 goto failed;
3911
3912 di = alloc(sizeof(dictitem_T) + STRLEN(varname));
3913 if (di == NULL)
3914 goto failed;
3915 STRCPY(di->di_key, varname);
3916 if (hash_add(ht, DI2HIKEY(di)) == FAIL)
3917 {
3918 vim_free(di);
3919 goto failed;
3920 }
3921 di->di_flags = DI_FLAGS_ALLOC;
3922 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
3923 di->di_flags |= DI_FLAGS_LOCK;
3924
3925 // A Vim9 script-local variable is also added to sn_all_vars and
3926 // sn_var_vals. It may set "type" from "tv".
3927 if (var_in_vim9script || var_in_autoload)
3928 update_vim9_script_var(TRUE, di,
3929 var_in_autoload ? name : di->di_key, flags,
3930 tv, &type, (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003931 }
3932
Bram Moolenaar993faa32022-02-21 15:59:11 +00003933 dest_tv = &di->di_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003934 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003935 copy_tv(tv, dest_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003936 else
3937 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003938 *dest_tv = *tv;
3939 dest_tv->v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003940 init_tv(tv);
3941 }
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003942 free_tv_arg = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003943
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003944 if (vim9script && type != NULL)
Bram Moolenaar381692b2022-02-02 20:01:27 +00003945 set_tv_type(dest_tv, type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003946
Bram Moolenaar1dcf55d2020-12-22 22:07:30 +01003947 // ":const var = value" locks the value
3948 // ":final var = value" locks "var"
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003949 if (flags & ASSIGN_CONST)
Bram Moolenaar021bda52020-08-17 21:07:22 +02003950 // Like :lockvar! name: lock the value and what it contains, but only
3951 // if the reference count is up to one. That locks only literal
3952 // values.
Bram Moolenaar24e93162021-07-18 20:40:33 +02003953 item_lock(dest_tv, DICT_MAXNEST, TRUE, TRUE);
Bram Moolenaar24e93162021-07-18 20:40:33 +02003954
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003955failed:
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003956 vim_free(name_tofree);
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003957 if (free_tv_arg)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003958 clear_tv(tv_arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003959}
3960
3961/*
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003962 * Check in this order for backwards compatibility:
3963 * - Whether the variable is read-only
3964 * - Whether the variable value is locked
3965 * - Whether the variable is locked
3966 */
3967 int
3968var_check_permission(dictitem_T *di, char_u *name)
3969{
3970 if (var_check_ro(di->di_flags, name, FALSE)
3971 || value_check_lock(di->di_tv.v_lock, name, FALSE)
3972 || var_check_lock(di->di_flags, name, FALSE))
3973 return FAIL;
3974 return OK;
3975}
3976
3977/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003978 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
3979 * Also give an error message.
3980 */
3981 int
3982var_check_ro(int flags, char_u *name, int use_gettext)
3983{
3984 if (flags & DI_FLAGS_RO)
3985 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00003986 if (name == NULL)
3987 emsg(_(e_cannot_change_readonly_variable));
3988 else
3989 semsg(_(e_cannot_change_readonly_variable_str),
Bram Moolenaard8e44472021-07-21 22:20:33 +02003990 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003991 return TRUE;
3992 }
3993 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
3994 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00003995 if (name == NULL)
3996 emsg(_(e_cannot_set_variable_in_sandbox));
3997 else
3998 semsg(_(e_cannot_set_variable_in_sandbox_str),
3999 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004000 return TRUE;
4001 }
4002 return FALSE;
4003}
4004
4005/*
Bram Moolenaara187c432020-09-16 21:08:28 +02004006 * Return TRUE if di_flags "flags" indicates variable "name" is locked.
4007 * Also give an error message.
4008 */
4009 int
4010var_check_lock(int flags, char_u *name, int use_gettext)
4011{
4012 if (flags & DI_FLAGS_LOCK)
4013 {
4014 semsg(_(e_variable_is_locked_str),
4015 use_gettext ? (char_u *)_(name) : name);
4016 return TRUE;
4017 }
4018 return FALSE;
4019}
4020
4021/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004022 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
4023 * Also give an error message.
4024 */
4025 int
4026var_check_fixed(int flags, char_u *name, int use_gettext)
4027{
4028 if (flags & DI_FLAGS_FIX)
4029 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004030 if (name == NULL)
4031 emsg(_(e_cannot_delete_variable));
4032 else
4033 semsg(_(e_cannot_delete_variable_str),
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004034 use_gettext ? (char_u *)_(name) : name);
4035 return TRUE;
4036 }
4037 return FALSE;
4038}
4039
4040/*
4041 * Check if a funcref is assigned to a valid variable name.
4042 * Return TRUE and give an error if not.
4043 */
4044 int
Bram Moolenaar98b4f142020-08-08 15:46:01 +02004045var_wrong_func_name(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004046 char_u *name, // points to start of variable name
4047 int new_var) // TRUE when creating the variable
4048{
Bram Moolenaar32154662021-03-28 21:14:06 +02004049 // Allow for w: b: s: and t:. In Vim9 script s: is not allowed, because
4050 // the name can be used without the s: prefix.
thinca6c667bd2022-09-02 11:25:37 +01004051 // Allow autoload variable.
Bram Moolenaar32154662021-03-28 21:14:06 +02004052 if (!((vim_strchr((char_u *)"wbt", name[0]) != NULL
4053 || (!in_vim9script() && name[0] == 's')) && name[1] == ':')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004054 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
thinca6c667bd2022-09-02 11:25:37 +01004055 ? name[2] : name[0])
4056 && vim_strchr(name, '#') == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004057 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004058 semsg(_(e_funcref_variable_name_must_start_with_capital_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004059 return TRUE;
4060 }
4061 // Don't allow hiding a function. When "v" is not NULL we might be
4062 // assigning another function to the same var, the type is checked
4063 // below.
4064 if (new_var && function_exists(name, FALSE))
4065 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004066 semsg(_(e_variable_name_conflicts_with_existing_function_str),
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004067 name);
4068 return TRUE;
4069 }
4070 return FALSE;
4071}
4072
4073/*
Bram Moolenaara187c432020-09-16 21:08:28 +02004074 * Return TRUE if "flags" indicates variable "name" has a locked (immutable)
4075 * value. Also give an error message, using "name" or _("name") when
4076 * "use_gettext" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004077 */
4078 int
Bram Moolenaara187c432020-09-16 21:08:28 +02004079value_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004080{
4081 if (lock & VAR_LOCKED)
4082 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004083 if (name == NULL)
4084 emsg(_(e_value_is_locked));
4085 else
4086 semsg(_(e_value_is_locked_str),
4087 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004088 return TRUE;
4089 }
4090 if (lock & VAR_FIXED)
4091 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004092 if (name == NULL)
4093 emsg(_(e_cannot_change_value));
4094 else
4095 semsg(_(e_cannot_change_value_of_str),
4096 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004097 return TRUE;
4098 }
4099 return FALSE;
4100}
4101
4102/*
Bram Moolenaar03290b82020-12-19 16:30:44 +01004103 * Check if a variable name is valid. When "autoload" is true "#" is allowed.
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004104 * If "len" is -1 use all of "varname", otherwise up to "varname[len]".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004105 * Return FALSE and give an error if not.
4106 */
4107 int
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004108valid_varname(char_u *varname, int len, int autoload)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004109{
4110 char_u *p;
4111
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004112 for (p = varname; len < 0 ? *p != NUL : p < varname + len; ++p)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004113 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
Bram Moolenaar03290b82020-12-19 16:30:44 +01004114 && !(autoload && *p == AUTOLOAD_CHAR))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004115 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004116 semsg(_(e_illegal_variable_name_str), varname);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004117 return FALSE;
4118 }
4119 return TRUE;
4120}
4121
4122/*
LemonBoy47d4e312022-05-04 18:12:55 +01004123 * Implements the logic to retrieve local variable and option values.
4124 * Used by "getwinvar()" "gettabvar()" "gettabwinvar()" "getbufvar()".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004125 */
4126 static void
LemonBoy47d4e312022-05-04 18:12:55 +01004127get_var_from(
4128 char_u *varname,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004129 typval_T *rettv,
LemonBoy47d4e312022-05-04 18:12:55 +01004130 typval_T *deftv, // Default value if not found.
4131 int htname, // 't'ab, 'w'indow or 'b'uffer local.
4132 tabpage_T *tp, // can be NULL
4133 win_T *win,
4134 buf_T *buf) // Ignored if htname is not 'b'.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004135{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004136 dictitem_T *v;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004137 int done = FALSE;
Bram Moolenaar18f47402022-01-06 13:24:51 +00004138 switchwin_T switchwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004139 int need_switch_win;
zeertzjqcd6ad642022-07-25 12:28:09 +01004140 int do_change_curbuf = buf != NULL && htname == 'b';
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004141
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004142 ++emsg_off;
4143
4144 rettv->v_type = VAR_STRING;
4145 rettv->vval.v_string = NULL;
4146
LemonBoy47d4e312022-05-04 18:12:55 +01004147 if (varname != NULL && tp != NULL && win != NULL
4148 && (htname != 'b' || buf != NULL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004149 {
4150 // Set curwin to be our win, temporarily. Also set the tabpage,
4151 // otherwise the window is not valid. Only do this when needed,
4152 // autocommands get blocked.
LemonBoy47d4e312022-05-04 18:12:55 +01004153 // If we have a buffer reference avoid the switching, we're saving and
4154 // restoring curbuf directly.
zeertzjqcd6ad642022-07-25 12:28:09 +01004155 need_switch_win = !(tp == curtab && win == curwin) && !do_change_curbuf;
LemonBoy47d4e312022-05-04 18:12:55 +01004156 if (!need_switch_win || switch_win(&switchwin, win, tp, TRUE) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004157 {
LemonBoy47d4e312022-05-04 18:12:55 +01004158 // Handle options. There are no tab-local options.
4159 if (*varname == '&' && htname != 't')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004160 {
LemonBoy47d4e312022-05-04 18:12:55 +01004161 buf_T *save_curbuf = curbuf;
4162
4163 // Change curbuf so the option is read from the correct buffer.
zeertzjqcd6ad642022-07-25 12:28:09 +01004164 if (do_change_curbuf)
LemonBoy47d4e312022-05-04 18:12:55 +01004165 curbuf = buf;
4166
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004167 if (varname[1] == NUL)
4168 {
zeertzjqcd6ad642022-07-25 12:28:09 +01004169 // get all window-local or buffer-local options in a dict
LemonBoy47d4e312022-05-04 18:12:55 +01004170 dict_T *opts = get_winbuf_options(htname == 'b');
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004171
4172 if (opts != NULL)
4173 {
4174 rettv_dict_set(rettv, opts);
4175 done = TRUE;
4176 }
4177 }
LemonBoy47d4e312022-05-04 18:12:55 +01004178 else if (eval_option(&varname, rettv, TRUE) == OK)
4179 // Local option
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004180 done = TRUE;
LemonBoy47d4e312022-05-04 18:12:55 +01004181
4182 curbuf = save_curbuf;
4183 }
4184 else if (*varname == NUL)
4185 {
4186 // Empty string: return a dict with all the local variables.
4187 if (htname == 'b')
4188 v = &buf->b_bufvar;
4189 else if (htname == 'w')
4190 v = &win->w_winvar;
4191 else
4192 v = &tp->tp_winvar;
4193 copy_tv(&v->di_tv, rettv);
4194 done = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004195 }
4196 else
4197 {
LemonBoy47d4e312022-05-04 18:12:55 +01004198 hashtab_T *ht;
4199
4200 if (htname == 'b')
4201 ht = &buf->b_vars->dv_hashtab;
4202 else if (htname == 'w')
4203 ht = &win->w_vars->dv_hashtab;
4204 else
4205 ht = &tp->tp_vars->dv_hashtab;
4206
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004207 // Look up the variable.
LemonBoy47d4e312022-05-04 18:12:55 +01004208 v = find_var_in_ht(ht, htname, varname, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004209 if (v != NULL)
4210 {
4211 copy_tv(&v->di_tv, rettv);
4212 done = TRUE;
4213 }
4214 }
4215 }
4216
4217 if (need_switch_win)
4218 // restore previous notion of curwin
Bram Moolenaar18f47402022-01-06 13:24:51 +00004219 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004220 }
4221
LemonBoy47d4e312022-05-04 18:12:55 +01004222 if (!done && deftv->v_type != VAR_UNKNOWN)
4223 // use the default value
4224 copy_tv(deftv, rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004225
4226 --emsg_off;
4227}
4228
4229/*
LemonBoy47d4e312022-05-04 18:12:55 +01004230 * getwinvar() and gettabwinvar()
4231 */
4232 static void
4233getwinvar(
4234 typval_T *argvars,
4235 typval_T *rettv,
4236 int off) // 1 for gettabwinvar()
4237{
4238 char_u *varname;
4239 tabpage_T *tp;
4240 win_T *win;
4241
4242 if (off == 1)
4243 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4244 else
4245 tp = curtab;
4246 win = find_win_by_nr(&argvars[off], tp);
4247 varname = tv_get_string_chk(&argvars[off + 1]);
4248
4249 get_var_from(varname, rettv, &argvars[off + 2], 'w', tp, win, NULL);
4250}
4251
4252/*
Bram Moolenaar191929b2020-08-19 21:20:49 +02004253 * Set option "varname" to the value of "varp" for the current buffer/window.
4254 */
4255 static void
4256set_option_from_tv(char_u *varname, typval_T *varp)
4257{
4258 long numval = 0;
4259 char_u *strval;
4260 char_u nbuf[NUMBUFLEN];
4261 int error = FALSE;
4262
Bram Moolenaar31a201a2021-01-03 14:47:25 +01004263 if (varp->v_type == VAR_BOOL)
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004264 {
Bram Moolenaar28f84e12022-07-27 12:30:13 +01004265 if (is_string_option(varname))
4266 {
4267 emsg(_(e_string_required));
4268 return;
4269 }
Bram Moolenaar31a201a2021-01-03 14:47:25 +01004270 numval = (long)varp->vval.v_number;
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004271 strval = (char_u *)"0"; // avoid using "false"
4272 }
4273 else
4274 {
4275 if (!in_vim9script() || varp->v_type != VAR_STRING)
4276 numval = (long)tv_get_number_chk(varp, &error);
4277 strval = tv_get_string_buf_chk(varp, nbuf);
4278 }
Bram Moolenaar191929b2020-08-19 21:20:49 +02004279 if (!error && strval != NULL)
Bram Moolenaar31e5c602022-04-15 13:53:33 +01004280 set_option_value_give_err(varname, numval, strval, OPT_LOCAL);
Bram Moolenaar191929b2020-08-19 21:20:49 +02004281}
4282
4283/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004284 * "setwinvar()" and "settabwinvar()" functions
4285 */
4286 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004287setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004288{
4289 win_T *win;
Bram Moolenaar18f47402022-01-06 13:24:51 +00004290 switchwin_T switchwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004291 int need_switch_win;
4292 char_u *varname, *winvarname;
4293 typval_T *varp;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004294 tabpage_T *tp = NULL;
4295
4296 if (check_secure())
4297 return;
4298
4299 if (off == 1)
4300 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4301 else
4302 tp = curtab;
4303 win = find_win_by_nr(&argvars[off], tp);
4304 varname = tv_get_string_chk(&argvars[off + 1]);
4305 varp = &argvars[off + 2];
4306
4307 if (win != NULL && varname != NULL && varp != NULL)
4308 {
4309 need_switch_win = !(tp == curtab && win == curwin);
4310 if (!need_switch_win
Bram Moolenaar18f47402022-01-06 13:24:51 +00004311 || switch_win(&switchwin, win, tp, TRUE) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004312 {
4313 if (*varname == '&')
Bram Moolenaar191929b2020-08-19 21:20:49 +02004314 set_option_from_tv(varname + 1, varp);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004315 else
4316 {
4317 winvarname = alloc(STRLEN(varname) + 3);
4318 if (winvarname != NULL)
4319 {
4320 STRCPY(winvarname, "w:");
4321 STRCPY(winvarname + 2, varname);
4322 set_var(winvarname, varp, TRUE);
4323 vim_free(winvarname);
4324 }
4325 }
4326 }
4327 if (need_switch_win)
Bram Moolenaar18f47402022-01-06 13:24:51 +00004328 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004329 }
4330}
4331
Bram Moolenaare5cdf152019-08-29 22:09:46 +02004332/*
4333 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
4334 * v:option_type, and v:option_command.
4335 */
4336 void
4337reset_v_option_vars(void)
4338{
4339 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
4340 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
4341 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
4342 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
4343 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
4344 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
4345}
4346
4347/*
4348 * Add an assert error to v:errors.
4349 */
4350 void
4351assert_error(garray_T *gap)
4352{
4353 struct vimvar *vp = &vimvars[VV_ERRORS];
4354
Bram Moolenaard787e402021-12-24 21:36:12 +00004355 if (vp->vv_tv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004356 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02004357 set_vim_var_list(VV_ERRORS, list_alloc());
4358 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
4359}
4360
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004361 int
4362var_exists(char_u *var)
4363{
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004364 char_u *arg = var;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004365 char_u *name;
4366 char_u *tofree;
4367 typval_T tv;
4368 int len = 0;
4369 int n = FALSE;
4370
4371 // get_name_len() takes care of expanding curly braces
4372 name = var;
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004373 len = get_name_len(&arg, &tofree, TRUE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004374 if (len > 0)
4375 {
4376 if (tofree != NULL)
4377 name = tofree;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004378 n = (eval_variable(name, len, 0, &tv, NULL,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01004379 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004380 if (n)
4381 {
4382 // handle d.key, l[idx], f(expr)
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004383 arg = skipwhite(arg);
Bram Moolenaar32884ad2022-01-07 12:45:29 +00004384 n = (handle_subscript(&arg, name, &tv, &EVALARG_EVALUATE,
4385 FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004386 if (n)
4387 clear_tv(&tv);
4388 }
4389 }
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004390 if (*arg != NUL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004391 n = FALSE;
4392
4393 vim_free(tofree);
4394 return n;
4395}
4396
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004397static lval_T *redir_lval = NULL;
4398#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
4399static garray_T redir_ga; // only valid when redir_lval is not NULL
4400static char_u *redir_endp = NULL;
4401static char_u *redir_varname = NULL;
4402
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004403 int
4404alloc_redir_lval(void)
4405{
4406 redir_lval = ALLOC_CLEAR_ONE(lval_T);
4407 if (redir_lval == NULL)
4408 return FAIL;
4409 return OK;
4410}
4411
4412 void
4413clear_redir_lval(void)
4414{
4415 VIM_CLEAR(redir_lval);
4416}
4417
4418 void
4419init_redir_ga(void)
4420{
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004421 ga_init2(&redir_ga, sizeof(char), 500);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004422}
4423
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004424/*
4425 * Start recording command output to a variable
4426 * When "append" is TRUE append to an existing variable.
4427 * Returns OK if successfully completed the setup. FAIL otherwise.
4428 */
4429 int
4430var_redir_start(char_u *name, int append)
4431{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004432 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004433 typval_T tv;
4434
4435 // Catch a bad name early.
4436 if (!eval_isnamec1(*name))
4437 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004438 emsg(_(e_invalid_argument));
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004439 return FAIL;
4440 }
4441
4442 // Make a copy of the name, it is used in redir_lval until redir ends.
4443 redir_varname = vim_strsave(name);
4444 if (redir_varname == NULL)
4445 return FAIL;
4446
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004447 if (alloc_redir_lval() == FAIL)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004448 {
4449 var_redir_stop();
4450 return FAIL;
4451 }
4452
4453 // The output is stored in growarray "redir_ga" until redirection ends.
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004454 init_redir_ga();
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004455
4456 // Parse the variable name (can be a dict or list entry).
4457 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
4458 FNE_CHECK_START);
4459 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
4460 {
4461 clear_lval(redir_lval);
4462 if (redir_endp != NULL && *redir_endp != NUL)
4463 // Trailing characters are present after the variable name
Bram Moolenaar74409f62022-01-01 15:58:22 +00004464 semsg(_(e_trailing_characters_str), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004465 else
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004466 semsg(_(e_invalid_argument_str), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004467 redir_endp = NULL; // don't store a value, only cleanup
4468 var_redir_stop();
4469 return FAIL;
4470 }
4471
4472 // check if we can write to the variable: set it to or append an empty
4473 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004474 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004475 tv.v_type = VAR_STRING;
4476 tv.vval.v_string = (char_u *)"";
4477 if (append)
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004478 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004479 ASSIGN_NO_DECL, (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004480 else
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004481 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004482 ASSIGN_NO_DECL, (char_u *)"=", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004483 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004484 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004485 {
4486 redir_endp = NULL; // don't store a value, only cleanup
4487 var_redir_stop();
4488 return FAIL;
4489 }
4490
4491 return OK;
4492}
4493
4494/*
4495 * Append "value[value_len]" to the variable set by var_redir_start().
4496 * The actual appending is postponed until redirection ends, because the value
4497 * appended may in fact be the string we write to, changing it may cause freed
4498 * memory to be used:
4499 * :redir => foo
4500 * :let foo
4501 * :redir END
4502 */
4503 void
4504var_redir_str(char_u *value, int value_len)
4505{
4506 int len;
4507
4508 if (redir_lval == NULL)
4509 return;
4510
4511 if (value_len == -1)
4512 len = (int)STRLEN(value); // Append the entire string
4513 else
4514 len = value_len; // Append only "value_len" characters
4515
4516 if (ga_grow(&redir_ga, len) == OK)
4517 {
4518 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
4519 redir_ga.ga_len += len;
4520 }
4521 else
4522 var_redir_stop();
4523}
4524
4525/*
4526 * Stop redirecting command output to a variable.
4527 * Frees the allocated memory.
4528 */
4529 void
4530var_redir_stop(void)
4531{
4532 typval_T tv;
4533
4534 if (EVALCMD_BUSY)
4535 {
4536 redir_lval = NULL;
4537 return;
4538 }
4539
4540 if (redir_lval != NULL)
4541 {
4542 // If there was no error: assign the text to the variable.
4543 if (redir_endp != NULL)
4544 {
4545 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4546 tv.v_type = VAR_STRING;
4547 tv.vval.v_string = redir_ga.ga_data;
4548 // Call get_lval() again, if it's inside a Dict or List it may
4549 // have changed.
4550 redir_endp = get_lval(redir_varname, NULL, redir_lval,
4551 FALSE, FALSE, 0, FNE_CHECK_START);
4552 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004553 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004554 (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004555 clear_lval(redir_lval);
4556 }
4557
4558 // free the collected output
4559 VIM_CLEAR(redir_ga.ga_data);
4560
4561 VIM_CLEAR(redir_lval);
4562 }
4563 VIM_CLEAR(redir_varname);
4564}
4565
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004566/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004567 * Get the collected redirected text and clear redir_ga.
4568 */
4569 char_u *
4570get_clear_redir_ga(void)
4571{
4572 char_u *res;
4573
4574 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4575 res = redir_ga.ga_data;
4576 redir_ga.ga_data = NULL;
4577 return res;
4578}
4579
4580/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004581 * "gettabvar()" function
4582 */
4583 void
4584f_gettabvar(typval_T *argvars, typval_T *rettv)
4585{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004586 char_u *varname;
LemonBoy47d4e312022-05-04 18:12:55 +01004587 tabpage_T *tp;
4588 win_T *win = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004589
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004590 if (in_vim9script()
4591 && (check_for_number_arg(argvars, 0) == FAIL
4592 || check_for_string_arg(argvars, 1) == FAIL))
4593 return;
4594
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004595 varname = tv_get_string_chk(&argvars[1]);
4596 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
LemonBoy47d4e312022-05-04 18:12:55 +01004597 if (tp != NULL)
4598 win = tp == curtab || tp->tp_firstwin == NULL ? firstwin
4599 : tp->tp_firstwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004600
LemonBoy47d4e312022-05-04 18:12:55 +01004601 get_var_from(varname, rettv, &argvars[2], 't', tp, win, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004602}
4603
4604/*
4605 * "gettabwinvar()" function
4606 */
4607 void
4608f_gettabwinvar(typval_T *argvars, typval_T *rettv)
4609{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004610 if (in_vim9script()
4611 && (check_for_number_arg(argvars, 0) == FAIL
4612 || check_for_number_arg(argvars, 1) == FAIL
4613 || check_for_string_arg(argvars, 2) == FAIL))
4614 return;
4615
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004616 getwinvar(argvars, rettv, 1);
4617}
4618
4619/*
4620 * "getwinvar()" function
4621 */
4622 void
4623f_getwinvar(typval_T *argvars, typval_T *rettv)
4624{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004625 if (in_vim9script()
4626 && (check_for_number_arg(argvars, 0) == FAIL
4627 || check_for_string_arg(argvars, 1) == FAIL))
4628 return;
4629
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004630 getwinvar(argvars, rettv, 0);
4631}
4632
4633/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004634 * "getbufvar()" function
4635 */
4636 void
4637f_getbufvar(typval_T *argvars, typval_T *rettv)
4638{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004639 char_u *varname;
LemonBoy47d4e312022-05-04 18:12:55 +01004640 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004641
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004642 if (in_vim9script()
4643 && (check_for_buffer_arg(argvars, 0) == FAIL
4644 || check_for_string_arg(argvars, 1) == FAIL))
4645 return;
4646
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004647 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004648 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004649
LemonBoy47d4e312022-05-04 18:12:55 +01004650 get_var_from(varname, rettv, &argvars[2], 'b', curtab, curwin, buf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004651}
4652
4653/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004654 * "settabvar()" function
4655 */
4656 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004657f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004658{
4659 tabpage_T *save_curtab;
4660 tabpage_T *tp;
4661 char_u *varname, *tabvarname;
4662 typval_T *varp;
4663
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004664 if (check_secure())
4665 return;
4666
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004667 if (in_vim9script()
4668 && (check_for_number_arg(argvars, 0) == FAIL
4669 || check_for_string_arg(argvars, 1) == FAIL))
4670 return;
4671
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004672 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4673 varname = tv_get_string_chk(&argvars[1]);
4674 varp = &argvars[2];
4675
4676 if (varname != NULL && varp != NULL && tp != NULL)
4677 {
4678 save_curtab = curtab;
4679 goto_tabpage_tp(tp, FALSE, FALSE);
4680
4681 tabvarname = alloc(STRLEN(varname) + 3);
4682 if (tabvarname != NULL)
4683 {
4684 STRCPY(tabvarname, "t:");
4685 STRCPY(tabvarname + 2, varname);
4686 set_var(tabvarname, varp, TRUE);
4687 vim_free(tabvarname);
4688 }
4689
4690 // Restore current tabpage
4691 if (valid_tabpage(save_curtab))
4692 goto_tabpage_tp(save_curtab, FALSE, FALSE);
4693 }
4694}
4695
4696/*
4697 * "settabwinvar()" function
4698 */
4699 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004700f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004701{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004702 if (in_vim9script()
4703 && (check_for_number_arg(argvars, 0) == FAIL
4704 || check_for_number_arg(argvars, 1) == FAIL
4705 || check_for_string_arg(argvars, 2) == FAIL))
4706 return;
4707
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004708 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004709}
4710
4711/*
4712 * "setwinvar()" function
4713 */
4714 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004715f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004716{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004717 if (in_vim9script()
4718 && (check_for_number_arg(argvars, 0) == FAIL
4719 || check_for_string_arg(argvars, 1) == FAIL))
4720 return;
4721
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004722 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004723}
4724
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004725/*
4726 * "setbufvar()" function
4727 */
4728 void
4729f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
4730{
4731 buf_T *buf;
4732 char_u *varname, *bufvarname;
4733 typval_T *varp;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004734
4735 if (check_secure())
4736 return;
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004737
4738 if (in_vim9script()
4739 && (check_for_buffer_arg(argvars, 0) == FAIL
4740 || check_for_string_arg(argvars, 1) == FAIL))
4741 return;
4742
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004743 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004744 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004745 varp = &argvars[2];
4746
4747 if (buf != NULL && varname != NULL && varp != NULL)
4748 {
4749 if (*varname == '&')
4750 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004751 aco_save_T aco;
4752
4753 // set curbuf to be our buf, temporarily
4754 aucmd_prepbuf(&aco, buf);
4755
Bram Moolenaar191929b2020-08-19 21:20:49 +02004756 set_option_from_tv(varname + 1, varp);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004757
4758 // reset notion of buffer
4759 aucmd_restbuf(&aco);
4760 }
4761 else
4762 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004763 bufvarname = alloc(STRLEN(varname) + 3);
4764 if (bufvarname != NULL)
4765 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004766 buf_T *save_curbuf = curbuf;
4767
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004768 curbuf = buf;
4769 STRCPY(bufvarname, "b:");
4770 STRCPY(bufvarname + 2, varname);
4771 set_var(bufvarname, varp, TRUE);
4772 vim_free(bufvarname);
4773 curbuf = save_curbuf;
4774 }
4775 }
4776 }
4777}
4778
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004779/*
4780 * Get a callback from "arg". It can be a Funcref or a function name.
4781 * When "arg" is zero return an empty string.
4782 * "cb_name" is not allocated.
4783 * "cb_name" is set to NULL for an invalid argument.
4784 */
4785 callback_T
4786get_callback(typval_T *arg)
4787{
Bram Moolenaar14e579092020-03-07 16:59:25 +01004788 callback_T res;
4789 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004790
4791 res.cb_free_name = FALSE;
4792 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
4793 {
4794 res.cb_partial = arg->vval.v_partial;
4795 ++res.cb_partial->pt_refcount;
4796 res.cb_name = partial_name(res.cb_partial);
4797 }
4798 else
4799 {
4800 res.cb_partial = NULL;
Bram Moolenaar14e579092020-03-07 16:59:25 +01004801 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
4802 && isdigit(*arg->vval.v_string))
4803 r = FAIL;
4804 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004805 {
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004806 if (arg->v_type == VAR_STRING)
4807 {
4808 char_u *name;
4809
4810 name = get_scriptlocal_funcname(arg->vval.v_string);
4811 if (name != NULL)
4812 {
4813 vim_free(arg->vval.v_string);
4814 arg->vval.v_string = name;
4815 }
4816 }
4817
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004818 res.cb_name = arg->vval.v_string;
4819 func_ref(res.cb_name);
4820 }
4821 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004822 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004823 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01004824 r = FAIL;
4825
4826 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004827 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004828 emsg(_(e_invalid_callback_argument));
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004829 res.cb_name = NULL;
4830 }
4831 }
4832 return res;
4833}
4834
4835/*
4836 * Copy a callback into a typval_T.
4837 */
4838 void
4839put_callback(callback_T *cb, typval_T *tv)
4840{
4841 if (cb->cb_partial != NULL)
4842 {
4843 tv->v_type = VAR_PARTIAL;
4844 tv->vval.v_partial = cb->cb_partial;
4845 ++tv->vval.v_partial->pt_refcount;
4846 }
4847 else
4848 {
4849 tv->v_type = VAR_FUNC;
4850 tv->vval.v_string = vim_strsave(cb->cb_name);
4851 func_ref(cb->cb_name);
4852 }
4853}
4854
4855/*
4856 * Make a copy of "src" into "dest", allocating the function name if needed,
4857 * without incrementing the refcount.
4858 */
4859 void
4860set_callback(callback_T *dest, callback_T *src)
4861{
4862 if (src->cb_partial == NULL)
4863 {
4864 // just a function name, make a copy
4865 dest->cb_name = vim_strsave(src->cb_name);
4866 dest->cb_free_name = TRUE;
4867 }
4868 else
4869 {
4870 // cb_name is a pointer into cb_partial
4871 dest->cb_name = src->cb_name;
4872 dest->cb_free_name = FALSE;
4873 }
4874 dest->cb_partial = src->cb_partial;
4875}
4876
4877/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02004878 * Copy callback from "src" to "dest", incrementing the refcounts.
4879 */
4880 void
4881copy_callback(callback_T *dest, callback_T *src)
4882{
4883 dest->cb_partial = src->cb_partial;
4884 if (dest->cb_partial != NULL)
4885 {
4886 dest->cb_name = src->cb_name;
4887 dest->cb_free_name = FALSE;
4888 ++dest->cb_partial->pt_refcount;
4889 }
4890 else
4891 {
4892 dest->cb_name = vim_strsave(src->cb_name);
4893 dest->cb_free_name = TRUE;
4894 func_ref(src->cb_name);
4895 }
4896}
4897
4898/*
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004899 * When a callback refers to an autoload import, change the function name to
4900 * the "path#name" form. Uses the current script context.
4901 * Only works when the name is allocated.
4902 */
4903 void
4904expand_autload_callback(callback_T *cb)
4905{
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004906 char_u *name;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004907 char_u *p;
4908 imported_T *import;
4909
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004910 if (!in_vim9script() || cb->cb_name == NULL
4911 || (!cb->cb_free_name
4912 && (cb->cb_partial == NULL || cb->cb_partial->pt_name == NULL)))
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004913 return;
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004914 if (cb->cb_partial != NULL)
4915 name = cb->cb_partial->pt_name;
4916 else
4917 name = cb->cb_name;
4918 p = vim_strchr(name, '.');
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004919 if (p == NULL)
4920 return;
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004921 import = find_imported(name, p - name, FALSE);
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004922 if (import != NULL && SCRIPT_ID_VALID(import->imp_sid))
4923 {
4924 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
4925
4926 if (si->sn_autoload_prefix != NULL)
4927 {
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004928 char_u *newname = concat_str(si->sn_autoload_prefix, p + 1);
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004929
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004930 if (newname != NULL)
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004931 {
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004932 if (cb->cb_partial != NULL)
4933 {
4934 if (cb->cb_name == cb->cb_partial->pt_name)
4935 cb->cb_name = newname;
4936 vim_free(cb->cb_partial->pt_name);
4937 cb->cb_partial->pt_name = newname;
4938 }
4939 else
4940 {
4941 vim_free(cb->cb_name);
4942 cb->cb_name = newname;
4943 }
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004944 }
4945 }
4946 }
4947}
4948
4949/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004950 * Unref/free "callback" returned by get_callback() or set_callback().
4951 */
4952 void
4953free_callback(callback_T *callback)
4954{
4955 if (callback->cb_partial != NULL)
4956 {
4957 partial_unref(callback->cb_partial);
4958 callback->cb_partial = NULL;
4959 }
4960 else if (callback->cb_name != NULL)
4961 func_unref(callback->cb_name);
4962 if (callback->cb_free_name)
4963 {
4964 vim_free(callback->cb_name);
4965 callback->cb_free_name = FALSE;
4966 }
4967 callback->cb_name = NULL;
4968}
4969
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004970#endif // FEAT_EVAL