blob: b6a6927d60f38184f53ad2374b14d9531816b17f [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!)
48 char vv_flags; // VV_COMPAT, VV_RO, VV_RO_SBX
49} vimvars[VV_LEN] =
50{
Bram Moolenaar8d71b542019-08-30 15:46:30 +020051 // The order here must match the VV_ defines in vim.h!
52 // Initializing a union does not work, leave tv.vval empty to get zero's.
Bram Moolenaare5cdf152019-08-29 22:09:46 +020053 {VV_NAME("count", VAR_NUMBER), VV_COMPAT+VV_RO},
54 {VV_NAME("count1", VAR_NUMBER), VV_RO},
55 {VV_NAME("prevcount", VAR_NUMBER), VV_RO},
56 {VV_NAME("errmsg", VAR_STRING), VV_COMPAT},
57 {VV_NAME("warningmsg", VAR_STRING), 0},
58 {VV_NAME("statusmsg", VAR_STRING), 0},
59 {VV_NAME("shell_error", VAR_NUMBER), VV_COMPAT+VV_RO},
60 {VV_NAME("this_session", VAR_STRING), VV_COMPAT},
61 {VV_NAME("version", VAR_NUMBER), VV_COMPAT+VV_RO},
62 {VV_NAME("lnum", VAR_NUMBER), VV_RO_SBX},
63 {VV_NAME("termresponse", VAR_STRING), VV_RO},
64 {VV_NAME("fname", VAR_STRING), VV_RO},
65 {VV_NAME("lang", VAR_STRING), VV_RO},
66 {VV_NAME("lc_time", VAR_STRING), VV_RO},
67 {VV_NAME("ctype", VAR_STRING), VV_RO},
68 {VV_NAME("charconvert_from", VAR_STRING), VV_RO},
69 {VV_NAME("charconvert_to", VAR_STRING), VV_RO},
70 {VV_NAME("fname_in", VAR_STRING), VV_RO},
71 {VV_NAME("fname_out", VAR_STRING), VV_RO},
72 {VV_NAME("fname_new", VAR_STRING), VV_RO},
73 {VV_NAME("fname_diff", VAR_STRING), VV_RO},
74 {VV_NAME("cmdarg", VAR_STRING), VV_RO},
75 {VV_NAME("foldstart", VAR_NUMBER), VV_RO_SBX},
76 {VV_NAME("foldend", VAR_NUMBER), VV_RO_SBX},
77 {VV_NAME("folddashes", VAR_STRING), VV_RO_SBX},
78 {VV_NAME("foldlevel", VAR_NUMBER), VV_RO_SBX},
79 {VV_NAME("progname", VAR_STRING), VV_RO},
80 {VV_NAME("servername", VAR_STRING), VV_RO},
81 {VV_NAME("dying", VAR_NUMBER), VV_RO},
82 {VV_NAME("exception", VAR_STRING), VV_RO},
83 {VV_NAME("throwpoint", VAR_STRING), VV_RO},
84 {VV_NAME("register", VAR_STRING), VV_RO},
85 {VV_NAME("cmdbang", VAR_NUMBER), VV_RO},
86 {VV_NAME("insertmode", VAR_STRING), VV_RO},
87 {VV_NAME("val", VAR_UNKNOWN), VV_RO},
88 {VV_NAME("key", VAR_UNKNOWN), VV_RO},
89 {VV_NAME("profiling", VAR_NUMBER), VV_RO},
90 {VV_NAME("fcs_reason", VAR_STRING), VV_RO},
91 {VV_NAME("fcs_choice", VAR_STRING), 0},
92 {VV_NAME("beval_bufnr", VAR_NUMBER), VV_RO},
93 {VV_NAME("beval_winnr", VAR_NUMBER), VV_RO},
94 {VV_NAME("beval_winid", VAR_NUMBER), VV_RO},
95 {VV_NAME("beval_lnum", VAR_NUMBER), VV_RO},
96 {VV_NAME("beval_col", VAR_NUMBER), VV_RO},
97 {VV_NAME("beval_text", VAR_STRING), VV_RO},
98 {VV_NAME("scrollstart", VAR_STRING), 0},
99 {VV_NAME("swapname", VAR_STRING), VV_RO},
100 {VV_NAME("swapchoice", VAR_STRING), 0},
101 {VV_NAME("swapcommand", VAR_STRING), VV_RO},
102 {VV_NAME("char", VAR_STRING), 0},
103 {VV_NAME("mouse_win", VAR_NUMBER), 0},
104 {VV_NAME("mouse_winid", VAR_NUMBER), 0},
105 {VV_NAME("mouse_lnum", VAR_NUMBER), 0},
106 {VV_NAME("mouse_col", VAR_NUMBER), 0},
107 {VV_NAME("operator", VAR_STRING), VV_RO},
108 {VV_NAME("searchforward", VAR_NUMBER), 0},
109 {VV_NAME("hlsearch", VAR_NUMBER), 0},
110 {VV_NAME("oldfiles", VAR_LIST), 0},
111 {VV_NAME("windowid", VAR_NUMBER), VV_RO},
112 {VV_NAME("progpath", VAR_STRING), VV_RO},
113 {VV_NAME("completed_item", VAR_DICT), VV_RO},
114 {VV_NAME("option_new", VAR_STRING), VV_RO},
115 {VV_NAME("option_old", VAR_STRING), VV_RO},
116 {VV_NAME("option_oldlocal", VAR_STRING), VV_RO},
117 {VV_NAME("option_oldglobal", VAR_STRING), VV_RO},
118 {VV_NAME("option_command", VAR_STRING), VV_RO},
119 {VV_NAME("option_type", VAR_STRING), VV_RO},
120 {VV_NAME("errors", VAR_LIST), 0},
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +0100121 {VV_NAME("false", VAR_BOOL), VV_RO},
122 {VV_NAME("true", VAR_BOOL), VV_RO},
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200123 {VV_NAME("none", VAR_SPECIAL), VV_RO},
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100124 {VV_NAME("null", VAR_SPECIAL), VV_RO},
Bram Moolenaar57d5a012021-01-21 21:42:31 +0100125 {VV_NAME("numbermax", VAR_NUMBER), VV_RO},
126 {VV_NAME("numbermin", VAR_NUMBER), VV_RO},
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100127 {VV_NAME("numbersize", VAR_NUMBER), VV_RO},
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200128 {VV_NAME("vim_did_enter", VAR_NUMBER), VV_RO},
129 {VV_NAME("testing", VAR_NUMBER), 0},
130 {VV_NAME("t_number", VAR_NUMBER), VV_RO},
131 {VV_NAME("t_string", VAR_NUMBER), VV_RO},
132 {VV_NAME("t_func", VAR_NUMBER), VV_RO},
133 {VV_NAME("t_list", VAR_NUMBER), VV_RO},
134 {VV_NAME("t_dict", VAR_NUMBER), VV_RO},
135 {VV_NAME("t_float", VAR_NUMBER), VV_RO},
136 {VV_NAME("t_bool", VAR_NUMBER), VV_RO},
137 {VV_NAME("t_none", VAR_NUMBER), VV_RO},
138 {VV_NAME("t_job", VAR_NUMBER), VV_RO},
139 {VV_NAME("t_channel", VAR_NUMBER), VV_RO},
140 {VV_NAME("t_blob", VAR_NUMBER), VV_RO},
141 {VV_NAME("termrfgresp", VAR_STRING), VV_RO},
142 {VV_NAME("termrbgresp", VAR_STRING), VV_RO},
143 {VV_NAME("termu7resp", VAR_STRING), VV_RO},
144 {VV_NAME("termstyleresp", VAR_STRING), VV_RO},
145 {VV_NAME("termblinkresp", VAR_STRING), VV_RO},
146 {VV_NAME("event", VAR_DICT), VV_RO},
147 {VV_NAME("versionlong", VAR_NUMBER), VV_RO},
148 {VV_NAME("echospace", VAR_NUMBER), VV_RO},
Bram Moolenaar69bf6342019-10-29 04:16:57 +0100149 {VV_NAME("argv", VAR_LIST), VV_RO},
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +0200150 {VV_NAME("collate", VAR_STRING), VV_RO},
Bram Moolenaarf0068c52020-11-30 17:42:10 +0100151 {VV_NAME("exiting", VAR_SPECIAL), VV_RO},
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200152};
153
154// shorthand
155#define vv_type vv_di.di_tv.v_type
156#define vv_nr vv_di.di_tv.vval.v_number
157#define vv_float vv_di.di_tv.vval.v_float
158#define vv_str vv_di.di_tv.vval.v_string
159#define vv_list vv_di.di_tv.vval.v_list
160#define vv_dict vv_di.di_tv.vval.v_dict
161#define vv_blob vv_di.di_tv.vval.v_blob
162#define vv_tv vv_di.di_tv
163
164static dictitem_T vimvars_var; // variable used for v:
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200165static dict_T vimvardict; // Dictionary with v: variables
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200166#define vimvarht vimvardict.dv_hashtab
167
168// for VIM_VERSION_ defines
169#include "version.h"
170
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200171static void list_glob_vars(int *first);
172static void list_buf_vars(int *first);
173static void list_win_vars(int *first);
174static void list_tab_vars(int *first);
175static char_u *list_arg_vars(exarg_T *eap, char_u *arg, int *first);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100176static char_u *ex_let_one(char_u *arg, typval_T *tv, int copy, int flags, char_u *endchars, char_u *op);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +0200177static int do_unlet_var(lval_T *lp, char_u *name_end, exarg_T *eap, int deep, void *cookie);
178static 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 +0200179static void list_one_var(dictitem_T *v, char *prefix, int *first);
180static void list_one_var_a(char *prefix, char_u *name, int type, char_u *string, int *first);
181
182/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200183 * Initialize global and vim special variables
184 */
185 void
186evalvars_init(void)
187{
188 int i;
189 struct vimvar *p;
190
191 init_var_dict(&globvardict, &globvars_var, VAR_DEF_SCOPE);
192 init_var_dict(&vimvardict, &vimvars_var, VAR_SCOPE);
193 vimvardict.dv_lock = VAR_FIXED;
194 hash_init(&compat_hashtab);
195
196 for (i = 0; i < VV_LEN; ++i)
197 {
198 p = &vimvars[i];
199 if (STRLEN(p->vv_name) > DICTITEM16_KEY_LEN)
200 {
201 iemsg("INTERNAL: name too long, increase size of dictitem16_T");
202 getout(1);
203 }
204 STRCPY(p->vv_di.di_key, p->vv_name);
205 if (p->vv_flags & VV_RO)
206 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
207 else if (p->vv_flags & VV_RO_SBX)
208 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
209 else
210 p->vv_di.di_flags = DI_FLAGS_FIX;
211
212 // add to v: scope dict, unless the value is not always available
213 if (p->vv_type != VAR_UNKNOWN)
214 hash_add(&vimvarht, p->vv_di.di_key);
215 if (p->vv_flags & VV_COMPAT)
216 // add to compat scope dict
217 hash_add(&compat_hashtab, p->vv_di.di_key);
218 }
Bram Moolenaar016faaa2020-10-03 12:57:27 +0200219 set_vim_var_nr(VV_VERSION, VIM_VERSION_100);
220 set_vim_var_nr(VV_VERSIONLONG, VIM_VERSION_100 * 10000 + highest_patch());
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200221
222 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
223 set_vim_var_nr(VV_HLSEARCH, 1L);
Bram Moolenaarf0068c52020-11-30 17:42:10 +0100224 set_vim_var_nr(VV_EXITING, VVAL_NULL);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200225 set_vim_var_dict(VV_COMPLETED_ITEM, dict_alloc_lock(VAR_FIXED));
226 set_vim_var_list(VV_ERRORS, list_alloc());
227 set_vim_var_dict(VV_EVENT, dict_alloc_lock(VAR_FIXED));
228
229 set_vim_var_nr(VV_FALSE, VVAL_FALSE);
230 set_vim_var_nr(VV_TRUE, VVAL_TRUE);
231 set_vim_var_nr(VV_NONE, VVAL_NONE);
232 set_vim_var_nr(VV_NULL, VVAL_NULL);
Bram Moolenaar57d5a012021-01-21 21:42:31 +0100233 set_vim_var_nr(VV_NUMBERMAX, VARNUM_MAX);
234 set_vim_var_nr(VV_NUMBERMIN, VARNUM_MIN);
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100235 set_vim_var_nr(VV_NUMBERSIZE, sizeof(varnumber_T) * 8);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200236
237 set_vim_var_nr(VV_TYPE_NUMBER, VAR_TYPE_NUMBER);
238 set_vim_var_nr(VV_TYPE_STRING, VAR_TYPE_STRING);
239 set_vim_var_nr(VV_TYPE_FUNC, VAR_TYPE_FUNC);
240 set_vim_var_nr(VV_TYPE_LIST, VAR_TYPE_LIST);
241 set_vim_var_nr(VV_TYPE_DICT, VAR_TYPE_DICT);
242 set_vim_var_nr(VV_TYPE_FLOAT, VAR_TYPE_FLOAT);
243 set_vim_var_nr(VV_TYPE_BOOL, VAR_TYPE_BOOL);
244 set_vim_var_nr(VV_TYPE_NONE, VAR_TYPE_NONE);
245 set_vim_var_nr(VV_TYPE_JOB, VAR_TYPE_JOB);
246 set_vim_var_nr(VV_TYPE_CHANNEL, VAR_TYPE_CHANNEL);
247 set_vim_var_nr(VV_TYPE_BLOB, VAR_TYPE_BLOB);
248
249 set_vim_var_nr(VV_ECHOSPACE, sc_col - 1);
250
Bram Moolenaar439c0362020-06-06 15:58:03 +0200251 // Default for v:register is not 0 but '"'. This is adjusted once the
252 // clipboard has been setup by calling reset_reg_var().
253 set_reg_var(0);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200254}
255
256#if defined(EXITFREE) || defined(PROTO)
257/*
258 * Free all vim variables information on exit
259 */
260 void
261evalvars_clear(void)
262{
263 int i;
264 struct vimvar *p;
265
266 for (i = 0; i < VV_LEN; ++i)
267 {
268 p = &vimvars[i];
269 if (p->vv_di.di_tv.v_type == VAR_STRING)
270 VIM_CLEAR(p->vv_str);
271 else if (p->vv_di.di_tv.v_type == VAR_LIST)
272 {
273 list_unref(p->vv_list);
274 p->vv_list = NULL;
275 }
276 }
277 hash_clear(&vimvarht);
278 hash_init(&vimvarht); // garbage_collect() will access it
279 hash_clear(&compat_hashtab);
280
281 // global variables
282 vars_clear(&globvarht);
283
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100284 // Script-local variables. Clear all the variables here.
285 // The scriptvar_T is cleared later in free_scriptnames(), because a
286 // variable in one script might hold a reference to the whole scope of
287 // another script.
288 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200289 vars_clear(&SCRIPT_VARS(i));
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200290}
291#endif
292
293 int
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200294garbage_collect_globvars(int copyID)
295{
296 return set_ref_in_ht(&globvarht, copyID, NULL);
297}
298
299 int
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200300garbage_collect_vimvars(int copyID)
301{
302 return set_ref_in_ht(&vimvarht, copyID, NULL);
303}
304
305 int
306garbage_collect_scriptvars(int copyID)
307{
Bram Moolenaared234f22020-10-15 20:42:20 +0200308 int i;
309 int idx;
310 int abort = FALSE;
311 scriptitem_T *si;
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200312
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100313 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaared234f22020-10-15 20:42:20 +0200314 {
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200315 abort = abort || set_ref_in_ht(&SCRIPT_VARS(i), copyID, NULL);
316
Bram Moolenaared234f22020-10-15 20:42:20 +0200317 si = SCRIPT_ITEM(i);
318 for (idx = 0; idx < si->sn_var_vals.ga_len; ++idx)
319 {
320 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + idx;
321
322 abort = abort || set_ref_in_item(sv->sv_tv, copyID, NULL, NULL);
323 }
324 }
325
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200326 return abort;
327}
328
329/*
330 * Set an internal variable to a string value. Creates the variable if it does
331 * not already exist.
332 */
333 void
334set_internal_string_var(char_u *name, char_u *value)
335{
336 char_u *val;
337 typval_T *tvp;
338
339 val = vim_strsave(value);
340 if (val != NULL)
341 {
342 tvp = alloc_string_tv(val);
343 if (tvp != NULL)
344 {
345 set_var(name, tvp, FALSE);
346 free_tv(tvp);
347 }
348 }
349}
350
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200351 int
352eval_charconvert(
353 char_u *enc_from,
354 char_u *enc_to,
355 char_u *fname_from,
356 char_u *fname_to)
357{
358 int err = FALSE;
359
360 set_vim_var_string(VV_CC_FROM, enc_from, -1);
361 set_vim_var_string(VV_CC_TO, enc_to, -1);
362 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
363 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
364 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
365 err = TRUE;
366 set_vim_var_string(VV_CC_FROM, NULL, -1);
367 set_vim_var_string(VV_CC_TO, NULL, -1);
368 set_vim_var_string(VV_FNAME_IN, NULL, -1);
369 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
370
371 if (err)
372 return FAIL;
373 return OK;
374}
375
376# if defined(FEAT_POSTSCRIPT) || defined(PROTO)
377 int
378eval_printexpr(char_u *fname, char_u *args)
379{
380 int err = FALSE;
381
382 set_vim_var_string(VV_FNAME_IN, fname, -1);
383 set_vim_var_string(VV_CMDARG, args, -1);
384 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
385 err = TRUE;
386 set_vim_var_string(VV_FNAME_IN, NULL, -1);
387 set_vim_var_string(VV_CMDARG, NULL, -1);
388
389 if (err)
390 {
391 mch_remove(fname);
392 return FAIL;
393 }
394 return OK;
395}
396# endif
397
398# if defined(FEAT_DIFF) || defined(PROTO)
399 void
400eval_diff(
401 char_u *origfile,
402 char_u *newfile,
403 char_u *outfile)
404{
405 int err = FALSE;
406
407 set_vim_var_string(VV_FNAME_IN, origfile, -1);
408 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
409 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
410 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
411 set_vim_var_string(VV_FNAME_IN, NULL, -1);
412 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
413 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
414}
415
416 void
417eval_patch(
418 char_u *origfile,
419 char_u *difffile,
420 char_u *outfile)
421{
422 int err;
423
424 set_vim_var_string(VV_FNAME_IN, origfile, -1);
425 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
426 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
427 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
428 set_vim_var_string(VV_FNAME_IN, NULL, -1);
429 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
430 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
431}
432# endif
433
434#if defined(FEAT_SPELL) || defined(PROTO)
435/*
436 * Evaluate an expression to a list with suggestions.
437 * For the "expr:" part of 'spellsuggest'.
438 * Returns NULL when there is an error.
439 */
440 list_T *
441eval_spell_expr(char_u *badword, char_u *expr)
442{
443 typval_T save_val;
444 typval_T rettv;
445 list_T *list = NULL;
446 char_u *p = skipwhite(expr);
447
448 // Set "v:val" to the bad word.
449 prepare_vimvar(VV_VAL, &save_val);
450 set_vim_var_string(VV_VAL, badword, -1);
451 if (p_verbose == 0)
452 ++emsg_off;
453
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200454 if (eval1(&p, &rettv, &EVALARG_EVALUATE) == OK)
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200455 {
456 if (rettv.v_type != VAR_LIST)
457 clear_tv(&rettv);
458 else
459 list = rettv.vval.v_list;
460 }
461
462 if (p_verbose == 0)
463 --emsg_off;
464 clear_tv(get_vim_var_tv(VV_VAL));
465 restore_vimvar(VV_VAL, &save_val);
466
467 return list;
468}
469
470/*
471 * "list" is supposed to contain two items: a word and a number. Return the
472 * word in "pp" and the number as the return value.
473 * Return -1 if anything isn't right.
474 * Used to get the good word and score from the eval_spell_expr() result.
475 */
476 int
477get_spellword(list_T *list, char_u **pp)
478{
479 listitem_T *li;
480
481 li = list->lv_first;
482 if (li == NULL)
483 return -1;
484 *pp = tv_get_string(&li->li_tv);
485
486 li = li->li_next;
487 if (li == NULL)
488 return -1;
489 return (int)tv_get_number(&li->li_tv);
490}
491#endif
492
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200493/*
494 * Prepare v: variable "idx" to be used.
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200495 * Save the current typeval in "save_tv" and clear it.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200496 * When not used yet add the variable to the v: hashtable.
497 */
498 void
499prepare_vimvar(int idx, typval_T *save_tv)
500{
501 *save_tv = vimvars[idx].vv_tv;
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200502 vimvars[idx].vv_str = NULL; // don't free it now
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200503 if (vimvars[idx].vv_type == VAR_UNKNOWN)
504 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
505}
506
507/*
508 * Restore v: variable "idx" to typeval "save_tv".
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200509 * Note that the v: variable must have been cleared already.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200510 * When no longer defined, remove the variable from the v: hashtable.
511 */
512 void
513restore_vimvar(int idx, typval_T *save_tv)
514{
515 hashitem_T *hi;
516
517 vimvars[idx].vv_tv = *save_tv;
518 if (vimvars[idx].vv_type == VAR_UNKNOWN)
519 {
520 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
521 if (HASHITEM_EMPTY(hi))
522 internal_error("restore_vimvar()");
523 else
524 hash_remove(&vimvarht, hi);
525 }
526}
527
528/*
529 * List Vim variables.
530 */
531 static void
532list_vim_vars(int *first)
533{
534 list_hashtable_vars(&vimvarht, "v:", FALSE, first);
535}
536
537/*
538 * List script-local variables, if there is a script.
539 */
540 static void
541list_script_vars(int *first)
542{
Bram Moolenaare3d46852020-08-29 13:39:17 +0200543 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200544 list_hashtable_vars(&SCRIPT_VARS(current_sctx.sc_sid),
545 "s:", FALSE, first);
546}
547
548/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200549 * Get a list of lines from a HERE document. The here document is a list of
550 * lines surrounded by a marker.
551 * cmd << {marker}
552 * {line1}
553 * {line2}
554 * ....
555 * {marker}
556 *
557 * The {marker} is a string. If the optional 'trim' word is supplied before the
558 * marker, then the leading indentation before the lines (matching the
559 * indentation in the 'cmd' line) is stripped.
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200560 *
561 * When getting lines for an embedded script (e.g. python, lua, perl, ruby,
562 * tcl, mzscheme), script_get is set to TRUE. In this case, if the marker is
563 * missing, then '.' is accepted as a marker.
564 *
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200565 * Returns a List with {lines} or NULL.
566 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100567 list_T *
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200568heredoc_get(exarg_T *eap, char_u *cmd, int script_get)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200569{
570 char_u *theline;
571 char_u *marker;
572 list_T *l;
573 char_u *p;
574 int marker_indent_len = 0;
575 int text_indent_len = 0;
576 char_u *text_indent = NULL;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200577 char_u dot[] = ".";
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200578 int comment_char = in_vim9script() ? '#' : '"';
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200579
580 if (eap->getline == NULL)
581 {
582 emsg(_("E991: cannot use =<< here"));
583 return NULL;
584 }
585
586 // Check for the optional 'trim' word before the marker
587 cmd = skipwhite(cmd);
588 if (STRNCMP(cmd, "trim", 4) == 0 && (cmd[4] == NUL || VIM_ISWHITE(cmd[4])))
589 {
590 cmd = skipwhite(cmd + 4);
591
592 // Trim the indentation from all the lines in the here document.
593 // The amount of indentation trimmed is the same as the indentation of
594 // the first line after the :let command line. To find the end marker
595 // the indent of the :let command line is trimmed.
596 p = *eap->cmdlinep;
597 while (VIM_ISWHITE(*p))
598 {
599 p++;
600 marker_indent_len++;
601 }
602 text_indent_len = -1;
603 }
604
605 // The marker is the next word.
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200606 if (*cmd != NUL && *cmd != comment_char)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200607 {
608 marker = skipwhite(cmd);
609 p = skiptowhite(marker);
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200610 if (*skipwhite(p) != NUL && *skipwhite(p) != comment_char)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200611 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +0200612 semsg(_(e_trailing_arg), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200613 return NULL;
614 }
615 *p = NUL;
Bram Moolenaar6ab09532020-05-01 14:10:13 +0200616 if (!script_get && vim_islower(*marker))
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200617 {
618 emsg(_("E221: Marker cannot start with lower case letter"));
619 return NULL;
620 }
621 }
622 else
623 {
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200624 // When getting lines for an embedded script, if the marker is missing,
625 // accept '.' as the marker.
626 if (script_get)
627 marker = dot;
628 else
629 {
630 emsg(_("E172: Missing marker"));
631 return NULL;
632 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200633 }
634
635 l = list_alloc();
636 if (l == NULL)
637 return NULL;
638
639 for (;;)
640 {
641 int mi = 0;
642 int ti = 0;
643
644 theline = eap->getline(NUL, eap->cookie, 0, FALSE);
645 if (theline == NULL)
646 {
647 semsg(_("E990: Missing end marker '%s'"), marker);
648 break;
649 }
650
651 // with "trim": skip the indent matching the :let line to find the
652 // marker
653 if (marker_indent_len > 0
654 && STRNCMP(theline, *eap->cmdlinep, marker_indent_len) == 0)
655 mi = marker_indent_len;
656 if (STRCMP(marker, theline + mi) == 0)
657 {
658 vim_free(theline);
659 break;
660 }
661
662 if (text_indent_len == -1 && *theline != NUL)
663 {
664 // set the text indent from the first line.
665 p = theline;
666 text_indent_len = 0;
667 while (VIM_ISWHITE(*p))
668 {
669 p++;
670 text_indent_len++;
671 }
672 text_indent = vim_strnsave(theline, text_indent_len);
673 }
674 // with "trim": skip the indent matching the first line
675 if (text_indent != NULL)
676 for (ti = 0; ti < text_indent_len; ++ti)
677 if (theline[ti] != text_indent[ti])
678 break;
679
680 if (list_append_string(l, theline + ti, -1) == FAIL)
681 break;
682 vim_free(theline);
683 }
684 vim_free(text_indent);
685
686 return l;
687}
688
689/*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200690 * Vim9 variable declaration:
691 * ":var name"
692 * ":var name: type"
693 * ":var name = expr"
694 * ":var name: type = expr"
695 * etc.
696 */
697 void
698ex_var(exarg_T *eap)
699{
700 if (!in_vim9script())
701 {
702 semsg(_(e_str_cannot_be_used_in_legacy_vim_script), ":var");
703 return;
704 }
705 ex_let(eap);
706}
707
708/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200709 * ":let" list all variable values
710 * ":let var1 var2" list variable values
711 * ":let var = expr" assignment command.
712 * ":let var += expr" assignment command.
713 * ":let var -= expr" assignment command.
714 * ":let var *= expr" assignment command.
715 * ":let var /= expr" assignment command.
716 * ":let var %= expr" assignment command.
717 * ":let var .= expr" assignment command.
718 * ":let var ..= expr" assignment command.
719 * ":let [var1, var2] = expr" unpack list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100720 * ":let var =<< ..." heredoc
Bram Moolenaard672dde2020-02-26 13:43:51 +0100721 * ":let var: string" Vim9 declaration
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200722 *
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200723 * ":final var = expr" assignment command.
724 * ":final [var1, var2] = expr" unpack list.
725 *
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200726 * ":const" list all variable values
727 * ":const var1 var2" list variable values
728 * ":const var = expr" assignment command.
729 * ":const [var1, var2] = expr" unpack list.
730 */
731 void
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200732ex_let(exarg_T *eap)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200733{
734 char_u *arg = eap->arg;
735 char_u *expr = NULL;
736 typval_T rettv;
737 int i;
738 int var_count = 0;
739 int semicolon = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200740 char_u op[4];
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200741 char_u *argend;
742 int first = TRUE;
743 int concat;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200744 int has_assign;
Bram Moolenaar89b474d2020-12-22 21:19:39 +0100745 int flags = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200746 int vim9script = in_vim9script();
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200747
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200748 if (eap->cmdidx == CMD_final && !vim9script)
749 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +0100750 // In legacy Vim script ":final" is short for ":finally".
751 ex_finally(eap);
752 return;
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200753 }
Bram Moolenaarc58f5452020-10-21 20:58:52 +0200754 if (eap->cmdidx == CMD_let && vim9script)
Bram Moolenaarcfcd0112020-09-27 15:19:27 +0200755 {
756 emsg(_(e_cannot_use_let_in_vim9_script));
757 return;
758 }
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200759
Bram Moolenaar89b474d2020-12-22 21:19:39 +0100760 if (eap->cmdidx == CMD_const)
761 flags |= ASSIGN_CONST;
762 else if (eap->cmdidx == CMD_final)
763 flags |= ASSIGN_FINAL;
764
765 // Vim9 assignment without ":let", ":const" or ":final"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100766 if (eap->arg == eap->cmd)
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200767 flags |= ASSIGN_NO_DECL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100768
Bram Moolenaar47a519a2020-06-14 23:05:10 +0200769 argend = skip_var_list(arg, TRUE, &var_count, &semicolon, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200770 if (argend == NULL)
771 return;
772 if (argend > arg && argend[-1] == '.') // for var.='str'
773 --argend;
774 expr = skipwhite(argend);
775 concat = expr[0] == '.'
776 && ((expr[1] == '=' && current_sctx.sc_version < 2)
777 || (expr[1] == '.' && expr[2] == '='));
Bram Moolenaar32e35112020-05-14 22:41:15 +0200778 has_assign = *expr == '=' || (vim_strchr((char_u *)"+-*/%", *expr) != NULL
779 && expr[1] == '=');
Bram Moolenaar822ba242020-05-24 23:00:18 +0200780 if (!has_assign && !concat)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200781 {
782 // ":let" without "=": list variables
783 if (*arg == '[')
784 emsg(_(e_invarg));
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200785 else if (expr[0] == '.' && expr[1] == '=')
786 emsg(_("E985: .= is not supported with script version >= 2"));
Bram Moolenaarfaac4102020-04-20 17:46:14 +0200787 else if (!ends_excmd2(eap->cmd, arg))
Bram Moolenaarc82a5b52020-06-13 18:09:19 +0200788 {
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200789 if (vim9script)
Bram Moolenaarc82a5b52020-06-13 18:09:19 +0200790 {
Bram Moolenaar07a65d22020-12-26 20:09:15 +0100791 // Vim9 declaration ":var name: type"
Bram Moolenaarc82a5b52020-06-13 18:09:19 +0200792 arg = vim9_declare_scriptvar(eap, arg);
793 }
794 else
795 {
796 // ":let var1 var2" - list values
797 arg = list_arg_vars(eap, arg, &first);
798 }
799 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200800 else if (!eap->skip)
801 {
802 // ":let"
803 list_glob_vars(&first);
804 list_buf_vars(&first);
805 list_win_vars(&first);
806 list_tab_vars(&first);
807 list_script_vars(&first);
808 list_func_vars(&first);
809 list_vim_vars(&first);
810 }
811 eap->nextcmd = check_nextcmd(arg);
812 }
813 else if (expr[0] == '=' && expr[1] == '<' && expr[2] == '<')
814 {
815 list_T *l;
816
817 // HERE document
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200818 l = heredoc_get(eap, expr + 3, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200819 if (l != NULL)
820 {
821 rettv_list_set(&rettv, l);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +0200822 if (!eap->skip)
823 {
824 op[0] = '=';
825 op[1] = NUL;
826 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100827 flags, op);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +0200828 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200829 clear_tv(&rettv);
830 }
831 }
832 else
833 {
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200834 evalarg_T evalarg;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200835 int len = 1;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200836
Bram Moolenaarc1ec0422020-09-09 22:27:58 +0200837 CLEAR_FIELD(rettv);
Bram Moolenaar32e35112020-05-14 22:41:15 +0200838 i = FAIL;
839 if (has_assign || concat)
840 {
Bram Moolenaar9a562c12021-01-23 13:39:14 +0100841 int cur_lnum;
842
Bram Moolenaar32e35112020-05-14 22:41:15 +0200843 op[0] = '=';
844 op[1] = NUL;
845 if (*expr != '=')
846 {
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200847 if (vim9script && (flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar122616d2020-08-21 21:32:50 +0200848 {
849 // +=, /=, etc. require an existing variable
850 semsg(_(e_cannot_use_operator_on_new_variable), eap->arg);
851 i = FAIL;
852 }
853 else if (vim_strchr((char_u *)"+-*/%.", *expr) != NULL)
Bram Moolenaar32e35112020-05-14 22:41:15 +0200854 {
855 op[0] = *expr; // +=, -=, *=, /=, %= or .=
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200856 ++len;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200857 if (expr[0] == '.' && expr[1] == '.') // ..=
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200858 {
Bram Moolenaar32e35112020-05-14 22:41:15 +0200859 ++expr;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200860 ++len;
861 }
Bram Moolenaar32e35112020-05-14 22:41:15 +0200862 }
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200863 expr += 2;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200864 }
865 else
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200866 ++expr;
867
Bram Moolenaarc7e44a72020-07-29 21:37:43 +0200868 if (vim9script && (!VIM_ISWHITE(*argend)
869 || !IS_WHITE_OR_NUL(*expr)))
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200870 {
871 vim_strncpy(op, expr - len, len);
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100872 semsg(_(e_white_space_required_before_and_after_str_at_str),
873 op, argend);
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200874 i = FAIL;
875 }
Bram Moolenaar32e35112020-05-14 22:41:15 +0200876
877 if (eap->skip)
878 ++emsg_skip;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200879 CLEAR_FIELD(evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200880 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
Bram Moolenaard5053d02020-06-28 15:51:16 +0200881 if (getline_equal(eap->getline, eap->cookie, getsourceline))
882 {
883 evalarg.eval_getline = eap->getline;
884 evalarg.eval_cookie = eap->cookie;
885 }
Bram Moolenaarc7e44a72020-07-29 21:37:43 +0200886 expr = skipwhite_and_linebreak(expr, &evalarg);
Bram Moolenaar9a562c12021-01-23 13:39:14 +0100887 cur_lnum = SOURCING_LNUM;
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200888 i = eval0(expr, &rettv, eap, &evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200889 if (eap->skip)
890 --emsg_skip;
Bram Moolenaarfaf86262020-06-27 23:07:36 +0200891 clear_evalarg(&evalarg, eap);
Bram Moolenaar9a562c12021-01-23 13:39:14 +0100892
893 // Restore the line number so that any type error is given for the
894 // declaration, not the expression.
895 SOURCING_LNUM = cur_lnum;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200896 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200897 if (eap->skip)
898 {
899 if (i != FAIL)
900 clear_tv(&rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200901 }
Bram Moolenaar822ba242020-05-24 23:00:18 +0200902 else if (i != FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200903 {
904 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200905 flags, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200906 clear_tv(&rettv);
907 }
908 }
909}
910
911/*
912 * Assign the typevalue "tv" to the variable or variables at "arg_start".
913 * Handles both "var" with any type and "[var, var; var]" with a list type.
914 * When "op" is not NULL it points to a string with characters that
915 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
916 * or concatenate.
917 * Returns OK or FAIL;
918 */
919 int
920ex_let_vars(
921 char_u *arg_start,
922 typval_T *tv,
923 int copy, // copy values from "tv", don't move
924 int semicolon, // from skip_var_list()
925 int var_count, // from skip_var_list()
Bram Moolenaar3862ea32021-01-01 21:05:55 +0100926 int flags, // ASSIGN_FINAL, ASSIGN_CONST, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200927 char_u *op)
928{
929 char_u *arg = arg_start;
930 list_T *l;
931 int i;
932 listitem_T *item;
933 typval_T ltv;
934
935 if (*arg != '[')
936 {
937 // ":let var = expr" or ":for var in list"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100938 if (ex_let_one(arg, tv, copy, flags, op, op) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200939 return FAIL;
940 return OK;
941 }
942
943 // ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
944 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
945 {
946 emsg(_(e_listreq));
947 return FAIL;
948 }
949
950 i = list_len(l);
951 if (semicolon == 0 && var_count < i)
952 {
953 emsg(_("E687: Less targets than List items"));
954 return FAIL;
955 }
956 if (var_count - semicolon > i)
957 {
958 emsg(_("E688: More targets than List items"));
959 return FAIL;
960 }
961
Bram Moolenaar7e9f3512020-05-13 22:44:22 +0200962 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200963 item = l->lv_first;
964 while (*arg != ']')
965 {
966 arg = skipwhite(arg + 1);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100967 arg = ex_let_one(arg, &item->li_tv, TRUE, flags, (char_u *)",;]", op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200968 item = item->li_next;
969 if (arg == NULL)
970 return FAIL;
971
972 arg = skipwhite(arg);
973 if (*arg == ';')
974 {
975 // Put the rest of the list (may be empty) in the var after ';'.
976 // Create a new list for this.
977 l = list_alloc();
978 if (l == NULL)
979 return FAIL;
980 while (item != NULL)
981 {
982 list_append_tv(l, &item->li_tv);
983 item = item->li_next;
984 }
985
986 ltv.v_type = VAR_LIST;
987 ltv.v_lock = 0;
988 ltv.vval.v_list = l;
989 l->lv_refcount = 1;
990
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100991 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE, flags,
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200992 (char_u *)"]", op);
993 clear_tv(&ltv);
994 if (arg == NULL)
995 return FAIL;
996 break;
997 }
998 else if (*arg != ',' && *arg != ']')
999 {
1000 internal_error("ex_let_vars()");
1001 return FAIL;
1002 }
1003 }
1004
1005 return OK;
1006}
1007
1008/*
1009 * Skip over assignable variable "var" or list of variables "[var, var]".
1010 * Used for ":let varvar = expr" and ":for varvar in expr".
1011 * For "[var, var]" increment "*var_count" for each variable.
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001012 * for "[var, var; var]" set "semicolon" to 1.
1013 * If "silent" is TRUE do not give an "invalid argument" error message.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001014 * Return NULL for an error.
1015 */
1016 char_u *
1017skip_var_list(
1018 char_u *arg,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001019 int include_type,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001020 int *var_count,
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001021 int *semicolon,
1022 int silent)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001023{
1024 char_u *p, *s;
1025
1026 if (*arg == '[')
1027 {
1028 // "[var, var]": find the matching ']'.
1029 p = arg;
1030 for (;;)
1031 {
1032 p = skipwhite(p + 1); // skip whites after '[', ';' or ','
Bram Moolenaar036d0712021-01-17 20:23:38 +01001033 s = skip_var_one(p, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001034 if (s == p)
1035 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001036 if (!silent)
1037 semsg(_(e_invarg2), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001038 return NULL;
1039 }
1040 ++*var_count;
1041
1042 p = skipwhite(s);
1043 if (*p == ']')
1044 break;
1045 else if (*p == ';')
1046 {
1047 if (*semicolon == 1)
1048 {
Bram Moolenaar9be61bb2020-03-30 22:51:24 +02001049 emsg(_("E452: Double ; in list of variables"));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001050 return NULL;
1051 }
1052 *semicolon = 1;
1053 }
1054 else if (*p != ',')
1055 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001056 if (!silent)
1057 semsg(_(e_invarg2), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001058 return NULL;
1059 }
1060 }
1061 return p + 1;
1062 }
1063 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001064 return skip_var_one(arg, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001065}
1066
1067/*
1068 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1069 * l[idx].
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001070 * In Vim9 script also skip over ": type" if "include_type" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001071 */
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001072 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001073skip_var_one(char_u *arg, int include_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001074{
Bram Moolenaar585587d2021-01-17 20:52:13 +01001075 char_u *end;
1076 int vim9 = in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001077
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001078 if (*arg == '@' && arg[1] != NUL)
1079 return arg + 2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001080 end = find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001081 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
Bram Moolenaar036d0712021-01-17 20:23:38 +01001082
1083 // "a: type" is declaring variable "a" with a type, not "a:".
1084 // Same for "s: type".
Bram Moolenaar585587d2021-01-17 20:52:13 +01001085 if (vim9 && end == arg + 2 && end[-1] == ':')
Bram Moolenaar036d0712021-01-17 20:23:38 +01001086 --end;
1087
Bram Moolenaar585587d2021-01-17 20:52:13 +01001088 if (include_type && vim9)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001089 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001090 if (*end == ':')
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02001091 end = skip_type(skipwhite(end + 1), FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001092 }
1093 return end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001094}
1095
1096/*
1097 * List variables for hashtab "ht" with prefix "prefix".
1098 * If "empty" is TRUE also list NULL strings as empty strings.
1099 */
1100 void
1101list_hashtable_vars(
1102 hashtab_T *ht,
1103 char *prefix,
1104 int empty,
1105 int *first)
1106{
1107 hashitem_T *hi;
1108 dictitem_T *di;
1109 int todo;
1110 char_u buf[IOSIZE];
1111
1112 todo = (int)ht->ht_used;
1113 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1114 {
1115 if (!HASHITEM_EMPTY(hi))
1116 {
1117 --todo;
1118 di = HI2DI(hi);
1119
1120 // apply :filter /pat/ to variable name
1121 vim_strncpy((char_u *)buf, (char_u *)prefix, IOSIZE - 1);
1122 vim_strcat((char_u *)buf, di->di_key, IOSIZE);
1123 if (message_filtered(buf))
1124 continue;
1125
1126 if (empty || di->di_tv.v_type != VAR_STRING
1127 || di->di_tv.vval.v_string != NULL)
1128 list_one_var(di, prefix, first);
1129 }
1130 }
1131}
1132
1133/*
1134 * List global variables.
1135 */
1136 static void
1137list_glob_vars(int *first)
1138{
1139 list_hashtable_vars(&globvarht, "", TRUE, first);
1140}
1141
1142/*
1143 * List buffer variables.
1144 */
1145 static void
1146list_buf_vars(int *first)
1147{
1148 list_hashtable_vars(&curbuf->b_vars->dv_hashtab, "b:", TRUE, first);
1149}
1150
1151/*
1152 * List window variables.
1153 */
1154 static void
1155list_win_vars(int *first)
1156{
1157 list_hashtable_vars(&curwin->w_vars->dv_hashtab, "w:", TRUE, first);
1158}
1159
1160/*
1161 * List tab page variables.
1162 */
1163 static void
1164list_tab_vars(int *first)
1165{
1166 list_hashtable_vars(&curtab->tp_vars->dv_hashtab, "t:", TRUE, first);
1167}
1168
1169/*
1170 * List variables in "arg".
1171 */
1172 static char_u *
1173list_arg_vars(exarg_T *eap, char_u *arg, int *first)
1174{
1175 int error = FALSE;
1176 int len;
1177 char_u *name;
1178 char_u *name_start;
1179 char_u *arg_subsc;
1180 char_u *tofree;
1181 typval_T tv;
1182
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001183 while (!ends_excmd2(eap->cmd, arg) && !got_int)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001184 {
1185 if (error || eap->skip)
1186 {
1187 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1188 if (!VIM_ISWHITE(*arg) && !ends_excmd(*arg))
1189 {
1190 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001191 semsg(_(e_trailing_arg), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001192 break;
1193 }
1194 }
1195 else
1196 {
1197 // get_name_len() takes care of expanding curly braces
1198 name_start = name = arg;
1199 len = get_name_len(&arg, &tofree, TRUE, TRUE);
1200 if (len <= 0)
1201 {
1202 // This is mainly to keep test 49 working: when expanding
1203 // curly braces fails overrule the exception error message.
1204 if (len < 0 && !aborting())
1205 {
1206 emsg_severe = TRUE;
1207 semsg(_(e_invarg2), arg);
1208 break;
1209 }
1210 error = TRUE;
1211 }
1212 else
1213 {
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02001214 arg = skipwhite(arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001215 if (tofree != NULL)
1216 name = tofree;
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02001217 if (eval_variable(name, len, &tv, NULL, TRUE, FALSE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001218 error = TRUE;
1219 else
1220 {
1221 // handle d.key, l[idx], f(expr)
1222 arg_subsc = arg;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001223 if (handle_subscript(&arg, &tv, &EVALARG_EVALUATE, TRUE)
Bram Moolenaar0b1cd522020-06-27 13:11:50 +02001224 == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001225 error = TRUE;
1226 else
1227 {
1228 if (arg == arg_subsc && len == 2 && name[1] == ':')
1229 {
1230 switch (*name)
1231 {
1232 case 'g': list_glob_vars(first); break;
1233 case 'b': list_buf_vars(first); break;
1234 case 'w': list_win_vars(first); break;
1235 case 't': list_tab_vars(first); break;
1236 case 'v': list_vim_vars(first); break;
1237 case 's': list_script_vars(first); break;
1238 case 'l': list_func_vars(first); break;
1239 default:
1240 semsg(_("E738: Can't list variables for %s"), name);
1241 }
1242 }
1243 else
1244 {
1245 char_u numbuf[NUMBUFLEN];
1246 char_u *tf;
1247 int c;
1248 char_u *s;
1249
1250 s = echo_string(&tv, &tf, numbuf, 0);
1251 c = *arg;
1252 *arg = NUL;
1253 list_one_var_a("",
1254 arg == arg_subsc ? name : name_start,
1255 tv.v_type,
1256 s == NULL ? (char_u *)"" : s,
1257 first);
1258 *arg = c;
1259 vim_free(tf);
1260 }
1261 clear_tv(&tv);
1262 }
1263 }
1264 }
1265
1266 vim_free(tofree);
1267 }
1268
1269 arg = skipwhite(arg);
1270 }
1271
1272 return arg;
1273}
1274
1275/*
1276 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
1277 * Returns a pointer to the char just after the var name.
1278 * Returns NULL if there is an error.
1279 */
1280 static char_u *
1281ex_let_one(
1282 char_u *arg, // points to variable name
1283 typval_T *tv, // value to assign to variable
1284 int copy, // copy value from "tv"
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001285 int flags, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001286 char_u *endchars, // valid chars after variable name or NULL
1287 char_u *op) // "+", "-", "." or NULL
1288{
1289 int c1;
1290 char_u *name;
1291 char_u *p;
1292 char_u *arg_end = NULL;
1293 int len;
1294 int opt_flags;
1295 char_u *tofree = NULL;
1296
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001297 if (in_vim9script() && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001298 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001299 && vim_strchr((char_u *)"$@&", *arg) != NULL)
1300 {
1301 vim9_declare_error(arg);
1302 return NULL;
1303 }
1304
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001305 // ":let $VAR = expr": Set environment variable.
1306 if (*arg == '$')
1307 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001308 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001309 {
1310 emsg(_("E996: Cannot lock an environment variable"));
1311 return NULL;
1312 }
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001313
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001314 // Find the end of the name.
1315 ++arg;
1316 name = arg;
1317 len = get_env_len(&arg);
1318 if (len == 0)
1319 semsg(_(e_invarg2), name - 1);
1320 else
1321 {
1322 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1323 semsg(_(e_letwrong), op);
1324 else if (endchars != NULL
1325 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
1326 emsg(_(e_letunexp));
1327 else if (!check_secure())
1328 {
1329 c1 = name[len];
1330 name[len] = NUL;
1331 p = tv_get_string_chk(tv);
1332 if (p != NULL && op != NULL && *op == '.')
1333 {
1334 int mustfree = FALSE;
1335 char_u *s = vim_getenv(name, &mustfree);
1336
1337 if (s != NULL)
1338 {
1339 p = tofree = concat_str(s, p);
1340 if (mustfree)
1341 vim_free(s);
1342 }
1343 }
1344 if (p != NULL)
1345 {
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01001346 vim_setenv_ext(name, p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001347 arg_end = arg;
1348 }
1349 name[len] = c1;
1350 vim_free(tofree);
1351 }
1352 }
1353 }
1354
1355 // ":let &option = expr": Set option value.
1356 // ":let &l:option = expr": Set local option value.
1357 // ":let &g:option = expr": Set global option value.
1358 else if (*arg == '&')
1359 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001360 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001361 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001362 emsg(_(e_const_option));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001363 return NULL;
1364 }
1365 // Find the end of the name.
1366 p = find_option_end(&arg, &opt_flags);
1367 if (p == NULL || (endchars != NULL
1368 && vim_strchr(endchars, *skipwhite(p)) == NULL))
1369 emsg(_(e_letunexp));
1370 else
1371 {
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001372 long n = 0;
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001373 getoption_T opt_type;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001374 long numval;
1375 char_u *stringval = NULL;
Bram Moolenaar65d032c2020-04-24 20:57:01 +02001376 char_u *s = NULL;
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001377 int failed = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001378
1379 c1 = *p;
1380 *p = NUL;
1381
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001382 opt_type = get_option_value(arg, &numval, &stringval, opt_flags);
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001383 if ((opt_type == gov_bool
1384 || opt_type == gov_number
1385 || opt_type == gov_hidden_bool
1386 || opt_type == gov_hidden_number)
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001387 && (tv->v_type != VAR_STRING || !in_vim9script()))
Bram Moolenaar0ea04402021-01-04 13:37:54 +01001388 {
1389 if (opt_type == gov_bool || opt_type == gov_hidden_bool)
1390 // bool, possibly hidden
1391 n = (long)tv_get_bool(tv);
1392 else
1393 // number, possibly hidden
1394 n = (long)tv_get_number(tv);
1395 }
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001396
1397 // Avoid setting a string option to the text "v:false" or similar.
1398 // In Vim9 script also don't convert a number to string.
1399 if (tv->v_type != VAR_BOOL && tv->v_type != VAR_SPECIAL
1400 && (!in_vim9script() || tv->v_type != VAR_NUMBER))
1401 s = tv_get_string_chk(tv);
1402
1403 if (op != NULL && *op != '=')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001404 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001405 if (((opt_type == gov_bool || opt_type == gov_number)
1406 && *op == '.')
1407 || (opt_type == gov_string && *op != '.'))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001408 {
1409 semsg(_(e_letwrong), op);
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001410 failed = TRUE; // don't set the value
1411
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001412 }
1413 else
1414 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001415 // number, in legacy script also bool
1416 if (opt_type == gov_number
1417 || (opt_type == gov_bool && !in_vim9script()))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001418 {
1419 switch (*op)
1420 {
1421 case '+': n = numval + n; break;
1422 case '-': n = numval - n; break;
1423 case '*': n = numval * n; break;
Bram Moolenaarc5f59fa2021-01-21 12:34:14 +01001424 case '/': n = (long)num_divide(numval, n,
1425 &failed); break;
1426 case '%': n = (long)num_modulus(numval, n,
1427 &failed); break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001428 }
1429 }
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001430 else if (opt_type == gov_string
1431 && stringval != NULL && s != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001432 {
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001433 // string
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001434 s = concat_str(stringval, s);
1435 vim_free(stringval);
1436 stringval = s;
1437 }
1438 }
1439 }
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001440
1441 if (!failed)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001442 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001443 if (opt_type != gov_string || s != NULL)
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001444 {
1445 set_option_value(arg, n, s, opt_flags);
1446 arg_end = p;
1447 }
1448 else
1449 emsg(_(e_stringreq));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001450 }
1451 *p = c1;
1452 vim_free(stringval);
1453 }
1454 }
1455
1456 // ":let @r = expr": Set register contents.
1457 else if (*arg == '@')
1458 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001459 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001460 {
1461 emsg(_("E996: Cannot lock a register"));
1462 return NULL;
1463 }
1464 ++arg;
1465 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1466 semsg(_(e_letwrong), op);
1467 else if (endchars != NULL
1468 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
1469 emsg(_(e_letunexp));
1470 else
1471 {
1472 char_u *ptofree = NULL;
1473 char_u *s;
1474
1475 p = tv_get_string_chk(tv);
1476 if (p != NULL && op != NULL && *op == '.')
1477 {
1478 s = get_reg_contents(*arg == '@' ? '"' : *arg, GREG_EXPR_SRC);
1479 if (s != NULL)
1480 {
1481 p = ptofree = concat_str(s, p);
1482 vim_free(s);
1483 }
1484 }
1485 if (p != NULL)
1486 {
1487 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
1488 arg_end = arg + 1;
1489 }
1490 vim_free(ptofree);
1491 }
1492 }
1493
1494 // ":let var = expr": Set internal variable.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001495 // ":let var: type = expr": Set internal variable with type.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001496 // ":let {expr} = expr": Idem, name made with curly braces
1497 else if (eval_isnamec1(*arg) || *arg == '{')
1498 {
1499 lval_T lv;
1500
Bram Moolenaar8f22f5c2020-12-19 22:10:13 +01001501 p = get_lval(arg, tv, &lv, FALSE, FALSE,
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001502 (flags & (ASSIGN_NO_DECL | ASSIGN_DECL))
1503 ? GLV_NO_DECL : 0, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001504 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001505 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001506 if (endchars != NULL && vim_strchr(endchars,
1507 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001508 emsg(_(e_letunexp));
1509 else
1510 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001511 set_var_lval(&lv, p, tv, copy, flags, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001512 arg_end = p;
1513 }
1514 }
1515 clear_lval(&lv);
1516 }
1517
1518 else
1519 semsg(_(e_invarg2), arg);
1520
1521 return arg_end;
1522}
1523
1524/*
1525 * ":unlet[!] var1 ... " command.
1526 */
1527 void
1528ex_unlet(exarg_T *eap)
1529{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001530 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001531}
1532
1533/*
1534 * ":lockvar" and ":unlockvar" commands
1535 */
1536 void
1537ex_lockvar(exarg_T *eap)
1538{
1539 char_u *arg = eap->arg;
1540 int deep = 2;
1541
1542 if (eap->forceit)
1543 deep = -1;
1544 else if (vim_isdigit(*arg))
1545 {
1546 deep = getdigits(&arg);
1547 arg = skipwhite(arg);
1548 }
1549
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001550 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001551}
1552
1553/*
1554 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001555 * Also used for Vim9 script. "callback" is invoked as:
1556 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001557 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001558 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001559ex_unletlock(
1560 exarg_T *eap,
1561 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001562 int deep,
1563 int glv_flags,
1564 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1565 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001566{
1567 char_u *arg = argstart;
1568 char_u *name_end;
1569 int error = FALSE;
1570 lval_T lv;
1571
1572 do
1573 {
1574 if (*arg == '$')
1575 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001576 lv.ll_name = arg;
1577 lv.ll_tv = NULL;
1578 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001579 if (get_env_len(&arg) == 0)
1580 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001581 semsg(_(e_invarg2), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001582 return;
1583 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001584 if (!error && !eap->skip
1585 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1586 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001587 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001588 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001589 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001590 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001591 // Parse the name and find the end.
1592 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
Bram Moolenaarc3689572021-01-01 19:40:02 +01001593 glv_flags | GLV_NO_DECL, FNE_CHECK_START);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001594 if (lv.ll_name == NULL)
1595 error = TRUE; // error but continue parsing
1596 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1597 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001598 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001599 if (name_end != NULL)
1600 {
1601 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001602 semsg(_(e_trailing_arg), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001603 }
1604 if (!(eap->skip || error))
1605 clear_lval(&lv);
1606 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001607 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001608
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001609 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001610 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001611 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001612
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001613 if (!eap->skip)
1614 clear_lval(&lv);
1615 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001616
1617 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001618 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001619
1620 eap->nextcmd = check_nextcmd(arg);
1621}
1622
1623 static int
1624do_unlet_var(
1625 lval_T *lp,
1626 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001627 exarg_T *eap,
1628 int deep UNUSED,
1629 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001630{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001631 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001632 int ret = OK;
1633 int cc;
1634
1635 if (lp->ll_tv == NULL)
1636 {
1637 cc = *name_end;
1638 *name_end = NUL;
1639
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001640 // Environment variable, normal name or expanded name.
1641 if (*lp->ll_name == '$')
1642 vim_unsetenv(lp->ll_name + 1);
1643 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001644 ret = FAIL;
1645 *name_end = cc;
1646 }
1647 else if ((lp->ll_list != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001648 && value_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001649 || (lp->ll_dict != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001650 && value_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001651 return FAIL;
1652 else if (lp->ll_range)
1653 {
1654 listitem_T *li;
1655 listitem_T *ll_li = lp->ll_li;
1656 int ll_n1 = lp->ll_n1;
1657
1658 while (ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= ll_n1))
1659 {
1660 li = ll_li->li_next;
Bram Moolenaara187c432020-09-16 21:08:28 +02001661 if (value_check_lock(ll_li->li_tv.v_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001662 return FAIL;
1663 ll_li = li;
1664 ++ll_n1;
1665 }
1666
1667 // Delete a range of List items.
1668 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
1669 {
1670 li = lp->ll_li->li_next;
1671 listitem_remove(lp->ll_list, lp->ll_li);
1672 lp->ll_li = li;
1673 ++lp->ll_n1;
1674 }
1675 }
1676 else
1677 {
1678 if (lp->ll_list != NULL)
1679 // unlet a List item.
1680 listitem_remove(lp->ll_list, lp->ll_li);
1681 else
1682 // unlet a Dictionary item.
1683 dictitem_remove(lp->ll_dict, lp->ll_di);
1684 }
1685
1686 return ret;
1687}
1688
1689/*
1690 * "unlet" a variable. Return OK if it existed, FAIL if not.
1691 * When "forceit" is TRUE don't complain if the variable doesn't exist.
1692 */
1693 int
1694do_unlet(char_u *name, int forceit)
1695{
1696 hashtab_T *ht;
1697 hashitem_T *hi;
1698 char_u *varname;
1699 dict_T *d;
1700 dictitem_T *di;
1701
Bram Moolenaar9aed7292020-12-18 15:38:00 +01001702 // can't :unlet a script variable in Vim9 script
Bram Moolenaareb6880b2020-07-12 17:07:05 +02001703 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001704 return FAIL;
1705
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001706 ht = find_var_ht(name, &varname);
Bram Moolenaar9aed7292020-12-18 15:38:00 +01001707
1708 // can't :unlet a script variable in Vim9 script from a function
1709 if (ht == get_script_local_ht()
1710 && SCRIPT_ID_VALID(current_sctx.sc_sid)
1711 && SCRIPT_ITEM(current_sctx.sc_sid)->sn_version
1712 == SCRIPT_VERSION_VIM9
1713 && check_vim9_unlet(name) == FAIL)
1714 return FAIL;
1715
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001716 if (ht != NULL && *varname != NUL)
1717 {
1718 d = get_current_funccal_dict(ht);
1719 if (d == NULL)
1720 {
1721 if (ht == &globvarht)
1722 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001723 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001724 d = &vimvardict;
1725 else
1726 {
1727 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
1728 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
1729 }
1730 if (d == NULL)
1731 {
1732 internal_error("do_unlet()");
1733 return FAIL;
1734 }
1735 }
1736 hi = hash_find(ht, varname);
1737 if (HASHITEM_EMPTY(hi))
1738 hi = find_hi_in_scoped_ht(name, &ht);
1739 if (hi != NULL && !HASHITEM_EMPTY(hi))
1740 {
1741 di = HI2DI(hi);
1742 if (var_check_fixed(di->di_flags, name, FALSE)
1743 || var_check_ro(di->di_flags, name, FALSE)
Bram Moolenaara187c432020-09-16 21:08:28 +02001744 || value_check_lock(d->dv_lock, name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001745 return FAIL;
1746
1747 delete_var(ht, hi);
1748 return OK;
1749 }
1750 }
1751 if (forceit)
1752 return OK;
1753 semsg(_("E108: No such variable: \"%s\""), name);
1754 return FAIL;
1755}
1756
1757/*
1758 * Lock or unlock variable indicated by "lp".
1759 * "deep" is the levels to go (-1 for unlimited);
1760 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
1761 */
1762 static int
1763do_lock_var(
1764 lval_T *lp,
1765 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001766 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001767 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001768 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001769{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001770 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001771 int ret = OK;
1772 int cc;
1773 dictitem_T *di;
1774
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001775 if (lp->ll_tv == NULL)
1776 {
1777 cc = *name_end;
1778 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001779 if (*lp->ll_name == '$')
1780 {
1781 semsg(_(e_lock_unlock), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001782 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001783 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001784 else
1785 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001786 // Normal name or expanded name.
1787 di = find_var(lp->ll_name, NULL, TRUE);
1788 if (di == NULL)
1789 ret = FAIL;
1790 else if ((di->di_flags & DI_FLAGS_FIX)
1791 && di->di_tv.v_type != VAR_DICT
1792 && di->di_tv.v_type != VAR_LIST)
1793 {
1794 // For historic reasons this error is not given for a list or
1795 // dict. E.g., the b: dict could be locked/unlocked.
1796 semsg(_(e_lock_unlock), lp->ll_name);
1797 ret = FAIL;
1798 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001799 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001800 {
1801 if (lock)
1802 di->di_flags |= DI_FLAGS_LOCK;
1803 else
1804 di->di_flags &= ~DI_FLAGS_LOCK;
Bram Moolenaara187c432020-09-16 21:08:28 +02001805 if (deep != 0)
1806 item_lock(&di->di_tv, deep, lock, FALSE);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001807 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001808 }
1809 *name_end = cc;
1810 }
Bram Moolenaara187c432020-09-16 21:08:28 +02001811 else if (deep == 0)
1812 {
1813 // nothing to do
1814 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001815 else if (lp->ll_range)
1816 {
1817 listitem_T *li = lp->ll_li;
1818
1819 // (un)lock a range of List items.
1820 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
1821 {
Bram Moolenaar021bda52020-08-17 21:07:22 +02001822 item_lock(&li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001823 li = li->li_next;
1824 ++lp->ll_n1;
1825 }
1826 }
1827 else if (lp->ll_list != NULL)
1828 // (un)lock a List item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001829 item_lock(&lp->ll_li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001830 else
1831 // (un)lock a Dictionary item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001832 item_lock(&lp->ll_di->di_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001833
1834 return ret;
1835}
1836
1837/*
1838 * Lock or unlock an item. "deep" is nr of levels to go.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001839 * When "check_refcount" is TRUE do not lock a list or dict with a reference
1840 * count larger than 1.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001841 */
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02001842 void
Bram Moolenaar021bda52020-08-17 21:07:22 +02001843item_lock(typval_T *tv, int deep, int lock, int check_refcount)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001844{
1845 static int recurse = 0;
1846 list_T *l;
1847 listitem_T *li;
1848 dict_T *d;
1849 blob_T *b;
1850 hashitem_T *hi;
1851 int todo;
1852
1853 if (recurse >= DICT_MAXNEST)
1854 {
1855 emsg(_("E743: variable nested too deep for (un)lock"));
1856 return;
1857 }
1858 if (deep == 0)
1859 return;
1860 ++recurse;
1861
1862 // lock/unlock the item itself
1863 if (lock)
1864 tv->v_lock |= VAR_LOCKED;
1865 else
1866 tv->v_lock &= ~VAR_LOCKED;
1867
1868 switch (tv->v_type)
1869 {
1870 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02001871 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001872 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001873 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001874 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001875 case VAR_STRING:
1876 case VAR_FUNC:
1877 case VAR_PARTIAL:
1878 case VAR_FLOAT:
1879 case VAR_SPECIAL:
1880 case VAR_JOB:
1881 case VAR_CHANNEL:
1882 break;
1883
1884 case VAR_BLOB:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001885 if ((b = tv->vval.v_blob) != NULL
1886 && !(check_refcount && b->bv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001887 {
1888 if (lock)
1889 b->bv_lock |= VAR_LOCKED;
1890 else
1891 b->bv_lock &= ~VAR_LOCKED;
1892 }
1893 break;
1894 case VAR_LIST:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001895 if ((l = tv->vval.v_list) != NULL
1896 && !(check_refcount && l->lv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001897 {
1898 if (lock)
1899 l->lv_lock |= VAR_LOCKED;
1900 else
1901 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001902 if ((deep < 0 || deep > 1) && l->lv_first != &range_list_item)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001903 // recursive: lock/unlock the items the List contains
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001904 FOR_ALL_LIST_ITEMS(l, li)
Bram Moolenaar021bda52020-08-17 21:07:22 +02001905 item_lock(&li->li_tv, deep - 1, lock, check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001906 }
1907 break;
1908 case VAR_DICT:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001909 if ((d = tv->vval.v_dict) != NULL
1910 && !(check_refcount && d->dv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001911 {
1912 if (lock)
1913 d->dv_lock |= VAR_LOCKED;
1914 else
1915 d->dv_lock &= ~VAR_LOCKED;
1916 if (deep < 0 || deep > 1)
1917 {
1918 // recursive: lock/unlock the items the List contains
1919 todo = (int)d->dv_hashtab.ht_used;
1920 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
1921 {
1922 if (!HASHITEM_EMPTY(hi))
1923 {
1924 --todo;
Bram Moolenaar021bda52020-08-17 21:07:22 +02001925 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock,
1926 check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001927 }
1928 }
1929 }
1930 }
1931 }
1932 --recurse;
1933}
1934
Bram Moolenaarda6c0332019-09-01 16:01:30 +02001935#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
1936/*
1937 * Delete all "menutrans_" variables.
1938 */
1939 void
1940del_menutrans_vars(void)
1941{
1942 hashitem_T *hi;
1943 int todo;
1944
1945 hash_lock(&globvarht);
1946 todo = (int)globvarht.ht_used;
1947 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
1948 {
1949 if (!HASHITEM_EMPTY(hi))
1950 {
1951 --todo;
1952 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
1953 delete_var(&globvarht, hi);
1954 }
1955 }
1956 hash_unlock(&globvarht);
1957}
1958#endif
1959
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001960/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001961 * Local string buffer for the next two functions to store a variable name
1962 * with its prefix. Allocated in cat_prefix_varname(), freed later in
1963 * get_user_var_name().
1964 */
1965
1966static char_u *varnamebuf = NULL;
1967static int varnamebuflen = 0;
1968
1969/*
1970 * Function to concatenate a prefix and a variable name.
1971 */
Bram Moolenaar1bb4de52021-01-13 19:48:46 +01001972 char_u *
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001973cat_prefix_varname(int prefix, char_u *name)
1974{
1975 int len;
1976
1977 len = (int)STRLEN(name) + 3;
1978 if (len > varnamebuflen)
1979 {
1980 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02001981 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001982 varnamebuf = alloc(len);
1983 if (varnamebuf == NULL)
1984 {
1985 varnamebuflen = 0;
1986 return NULL;
1987 }
1988 varnamebuflen = len;
1989 }
1990 *varnamebuf = prefix;
1991 varnamebuf[1] = ':';
1992 STRCPY(varnamebuf + 2, name);
1993 return varnamebuf;
1994}
1995
1996/*
1997 * Function given to ExpandGeneric() to obtain the list of user defined
1998 * (global/buffer/window/built-in) variable names.
1999 */
2000 char_u *
2001get_user_var_name(expand_T *xp, int idx)
2002{
2003 static long_u gdone;
2004 static long_u bdone;
2005 static long_u wdone;
2006 static long_u tdone;
2007 static int vidx;
2008 static hashitem_T *hi;
2009 hashtab_T *ht;
2010
2011 if (idx == 0)
2012 {
2013 gdone = bdone = wdone = vidx = 0;
2014 tdone = 0;
2015 }
2016
2017 // Global variables
2018 if (gdone < globvarht.ht_used)
2019 {
2020 if (gdone++ == 0)
2021 hi = globvarht.ht_array;
2022 else
2023 ++hi;
2024 while (HASHITEM_EMPTY(hi))
2025 ++hi;
2026 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
2027 return cat_prefix_varname('g', hi->hi_key);
2028 return hi->hi_key;
2029 }
2030
2031 // b: variables
Bram Moolenaar4ff2f2f2020-10-25 13:22:42 +01002032 ht =
2033#ifdef FEAT_CMDWIN
2034 // In cmdwin, the alternative buffer should be used.
2035 (cmdwin_type != 0 && get_cmdline_type() == NUL) ?
2036 &prevwin->w_buffer->b_vars->dv_hashtab :
2037#endif
2038 &curbuf->b_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002039 if (bdone < ht->ht_used)
2040 {
2041 if (bdone++ == 0)
2042 hi = ht->ht_array;
2043 else
2044 ++hi;
2045 while (HASHITEM_EMPTY(hi))
2046 ++hi;
2047 return cat_prefix_varname('b', hi->hi_key);
2048 }
2049
2050 // w: variables
Bram Moolenaar4ff2f2f2020-10-25 13:22:42 +01002051 ht =
2052#ifdef FEAT_CMDWIN
2053 // In cmdwin, the alternative window should be used.
2054 (cmdwin_type != 0 && get_cmdline_type() == NUL) ?
2055 &prevwin->w_vars->dv_hashtab :
2056#endif
2057 &curwin->w_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002058 if (wdone < ht->ht_used)
2059 {
2060 if (wdone++ == 0)
2061 hi = ht->ht_array;
2062 else
2063 ++hi;
2064 while (HASHITEM_EMPTY(hi))
2065 ++hi;
2066 return cat_prefix_varname('w', hi->hi_key);
2067 }
2068
2069 // t: variables
2070 ht = &curtab->tp_vars->dv_hashtab;
2071 if (tdone < ht->ht_used)
2072 {
2073 if (tdone++ == 0)
2074 hi = ht->ht_array;
2075 else
2076 ++hi;
2077 while (HASHITEM_EMPTY(hi))
2078 ++hi;
2079 return cat_prefix_varname('t', hi->hi_key);
2080 }
2081
2082 // v: variables
2083 if (vidx < VV_LEN)
2084 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
2085
2086 VIM_CLEAR(varnamebuf);
2087 varnamebuflen = 0;
2088 return NULL;
2089}
2090
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002091 char *
2092get_var_special_name(int nr)
2093{
2094 switch (nr)
2095 {
Bram Moolenaara8b8af12021-01-01 15:11:04 +01002096 case VVAL_FALSE: return in_vim9script() ? "false" : "v:false";
2097 case VVAL_TRUE: return in_vim9script() ? "true" : "v:true";
Bram Moolenaar67977822021-01-03 21:53:53 +01002098 case VVAL_NULL: return in_vim9script() ? "null" : "v:null";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002099 case VVAL_NONE: return "v:none";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002100 }
2101 internal_error("get_var_special_name()");
2102 return "42";
2103}
2104
2105/*
2106 * Returns the global variable dictionary
2107 */
2108 dict_T *
2109get_globvar_dict(void)
2110{
2111 return &globvardict;
2112}
2113
2114/*
2115 * Returns the global variable hash table
2116 */
2117 hashtab_T *
2118get_globvar_ht(void)
2119{
2120 return &globvarht;
2121}
2122
2123/*
2124 * Returns the v: variable dictionary
2125 */
2126 dict_T *
2127get_vimvar_dict(void)
2128{
2129 return &vimvardict;
2130}
2131
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002132/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002133 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002134 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002135 */
2136 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002137find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002138{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002139 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2140 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002141
2142 if (di == NULL)
2143 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002144 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002145 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2146 return (int)(vv - vimvars);
2147}
2148
2149
2150/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002151 * Set type of v: variable to "type".
2152 */
2153 void
2154set_vim_var_type(int idx, vartype_T type)
2155{
2156 vimvars[idx].vv_type = type;
2157}
2158
2159/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002160 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002161 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002162 */
2163 void
2164set_vim_var_nr(int idx, varnumber_T val)
2165{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002166 vimvars[idx].vv_nr = val;
2167}
2168
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002169 char *
2170get_vim_var_name(int idx)
2171{
2172 return vimvars[idx].vv_name;
2173}
2174
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002175/*
2176 * Get typval_T v: variable value.
2177 */
2178 typval_T *
2179get_vim_var_tv(int idx)
2180{
2181 return &vimvars[idx].vv_tv;
2182}
2183
2184/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002185 * Set v: variable to "tv". Only accepts the same type.
2186 * Takes over the value of "tv".
2187 */
2188 int
2189set_vim_var_tv(int idx, typval_T *tv)
2190{
2191 if (vimvars[idx].vv_type != tv->v_type)
2192 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002193 emsg(_(e_type_mismatch_for_v_variable));
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002194 clear_tv(tv);
2195 return FAIL;
2196 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002197 // VV_RO is also checked when compiling, but let's check here as well.
2198 if (vimvars[idx].vv_flags & VV_RO)
2199 {
2200 semsg(_(e_readonlyvar), vimvars[idx].vv_name);
2201 return FAIL;
2202 }
2203 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2204 {
2205 semsg(_(e_readonlysbx), vimvars[idx].vv_name);
2206 return FAIL;
2207 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002208 clear_tv(&vimvars[idx].vv_di.di_tv);
2209 vimvars[idx].vv_di.di_tv = *tv;
2210 return OK;
2211}
2212
2213/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002214 * Get number v: variable value.
2215 */
2216 varnumber_T
2217get_vim_var_nr(int idx)
2218{
2219 return vimvars[idx].vv_nr;
2220}
2221
2222/*
2223 * Get string v: variable value. Uses a static buffer, can only be used once.
2224 * If the String variable has never been set, return an empty string.
2225 * Never returns NULL;
2226 */
2227 char_u *
2228get_vim_var_str(int idx)
2229{
2230 return tv_get_string(&vimvars[idx].vv_tv);
2231}
2232
2233/*
2234 * Get List v: variable value. Caller must take care of reference count when
2235 * needed.
2236 */
2237 list_T *
2238get_vim_var_list(int idx)
2239{
2240 return vimvars[idx].vv_list;
2241}
2242
2243/*
2244 * Get Dict v: variable value. Caller must take care of reference count when
2245 * needed.
2246 */
2247 dict_T *
2248get_vim_var_dict(int idx)
2249{
2250 return vimvars[idx].vv_dict;
2251}
2252
2253/*
2254 * Set v:char to character "c".
2255 */
2256 void
2257set_vim_var_char(int c)
2258{
2259 char_u buf[MB_MAXBYTES + 1];
2260
2261 if (has_mbyte)
2262 buf[(*mb_char2bytes)(c, buf)] = NUL;
2263 else
2264 {
2265 buf[0] = c;
2266 buf[1] = NUL;
2267 }
2268 set_vim_var_string(VV_CHAR, buf, -1);
2269}
2270
2271/*
2272 * Set v:count to "count" and v:count1 to "count1".
2273 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2274 */
2275 void
2276set_vcount(
2277 long count,
2278 long count1,
2279 int set_prevcount)
2280{
2281 if (set_prevcount)
2282 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2283 vimvars[VV_COUNT].vv_nr = count;
2284 vimvars[VV_COUNT1].vv_nr = count1;
2285}
2286
2287/*
2288 * Save variables that might be changed as a side effect. Used when executing
2289 * a timer callback.
2290 */
2291 void
2292save_vimvars(vimvars_save_T *vvsave)
2293{
2294 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2295 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2296 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2297}
2298
2299/*
2300 * Restore variables saved by save_vimvars().
2301 */
2302 void
2303restore_vimvars(vimvars_save_T *vvsave)
2304{
2305 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2306 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2307 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2308}
2309
2310/*
2311 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2312 * value.
2313 */
2314 void
2315set_vim_var_string(
2316 int idx,
2317 char_u *val,
2318 int len) // length of "val" to use or -1 (whole string)
2319{
2320 clear_tv(&vimvars[idx].vv_di.di_tv);
2321 vimvars[idx].vv_type = VAR_STRING;
2322 if (val == NULL)
2323 vimvars[idx].vv_str = NULL;
2324 else if (len == -1)
2325 vimvars[idx].vv_str = vim_strsave(val);
2326 else
2327 vimvars[idx].vv_str = vim_strnsave(val, len);
2328}
2329
2330/*
2331 * Set List v: variable to "val".
2332 */
2333 void
2334set_vim_var_list(int idx, list_T *val)
2335{
2336 clear_tv(&vimvars[idx].vv_di.di_tv);
2337 vimvars[idx].vv_type = VAR_LIST;
2338 vimvars[idx].vv_list = val;
2339 if (val != NULL)
2340 ++val->lv_refcount;
2341}
2342
2343/*
2344 * Set Dictionary v: variable to "val".
2345 */
2346 void
2347set_vim_var_dict(int idx, dict_T *val)
2348{
2349 clear_tv(&vimvars[idx].vv_di.di_tv);
2350 vimvars[idx].vv_type = VAR_DICT;
2351 vimvars[idx].vv_dict = val;
2352 if (val != NULL)
2353 {
2354 ++val->dv_refcount;
2355 dict_set_items_ro(val);
2356 }
2357}
2358
2359/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002360 * Set the v:argv list.
2361 */
2362 void
2363set_argv_var(char **argv, int argc)
2364{
2365 list_T *l = list_alloc();
2366 int i;
2367
2368 if (l == NULL)
2369 getout(1);
2370 l->lv_lock = VAR_FIXED;
2371 for (i = 0; i < argc; ++i)
2372 {
2373 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2374 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002375 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002376 }
2377 set_vim_var_list(VV_ARGV, l);
2378}
2379
2380/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002381 * Reset v:register, taking the 'clipboard' setting into account.
2382 */
2383 void
2384reset_reg_var(void)
2385{
2386 int regname = 0;
2387
2388 // Adjust the register according to 'clipboard', so that when
2389 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2390#ifdef FEAT_CLIPBOARD
2391 adjust_clip_reg(&regname);
2392#endif
2393 set_reg_var(regname);
2394}
2395
2396/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002397 * Set v:register if needed.
2398 */
2399 void
2400set_reg_var(int c)
2401{
2402 char_u regname;
2403
2404 if (c == 0 || c == ' ')
2405 regname = '"';
2406 else
2407 regname = c;
2408 // Avoid free/alloc when the value is already right.
2409 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2410 set_vim_var_string(VV_REG, &regname, 1);
2411}
2412
2413/*
2414 * Get or set v:exception. If "oldval" == NULL, return the current value.
2415 * Otherwise, restore the value to "oldval" and return NULL.
2416 * Must always be called in pairs to save and restore v:exception! Does not
2417 * take care of memory allocations.
2418 */
2419 char_u *
2420v_exception(char_u *oldval)
2421{
2422 if (oldval == NULL)
2423 return vimvars[VV_EXCEPTION].vv_str;
2424
2425 vimvars[VV_EXCEPTION].vv_str = oldval;
2426 return NULL;
2427}
2428
2429/*
2430 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2431 * Otherwise, restore the value to "oldval" and return NULL.
2432 * Must always be called in pairs to save and restore v:throwpoint! Does not
2433 * take care of memory allocations.
2434 */
2435 char_u *
2436v_throwpoint(char_u *oldval)
2437{
2438 if (oldval == NULL)
2439 return vimvars[VV_THROWPOINT].vv_str;
2440
2441 vimvars[VV_THROWPOINT].vv_str = oldval;
2442 return NULL;
2443}
2444
2445/*
2446 * Set v:cmdarg.
2447 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2448 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2449 * Must always be called in pairs!
2450 */
2451 char_u *
2452set_cmdarg(exarg_T *eap, char_u *oldarg)
2453{
2454 char_u *oldval;
2455 char_u *newval;
2456 unsigned len;
2457
2458 oldval = vimvars[VV_CMDARG].vv_str;
2459 if (eap == NULL)
2460 {
2461 vim_free(oldval);
2462 vimvars[VV_CMDARG].vv_str = oldarg;
2463 return NULL;
2464 }
2465
2466 if (eap->force_bin == FORCE_BIN)
2467 len = 6;
2468 else if (eap->force_bin == FORCE_NOBIN)
2469 len = 8;
2470 else
2471 len = 0;
2472
2473 if (eap->read_edit)
2474 len += 7;
2475
2476 if (eap->force_ff != 0)
2477 len += 10; // " ++ff=unix"
2478 if (eap->force_enc != 0)
2479 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2480 if (eap->bad_char != 0)
2481 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2482
2483 newval = alloc(len + 1);
2484 if (newval == NULL)
2485 return NULL;
2486
2487 if (eap->force_bin == FORCE_BIN)
2488 sprintf((char *)newval, " ++bin");
2489 else if (eap->force_bin == FORCE_NOBIN)
2490 sprintf((char *)newval, " ++nobin");
2491 else
2492 *newval = NUL;
2493
2494 if (eap->read_edit)
2495 STRCAT(newval, " ++edit");
2496
2497 if (eap->force_ff != 0)
2498 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2499 eap->force_ff == 'u' ? "unix"
2500 : eap->force_ff == 'd' ? "dos"
2501 : "mac");
2502 if (eap->force_enc != 0)
2503 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2504 eap->cmd + eap->force_enc);
2505 if (eap->bad_char == BAD_KEEP)
2506 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2507 else if (eap->bad_char == BAD_DROP)
2508 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2509 else if (eap->bad_char != 0)
2510 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2511 vimvars[VV_CMDARG].vv_str = newval;
2512 return oldval;
2513}
2514
2515/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002516 * Get the value of internal variable "name".
2517 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2518 */
2519 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002520eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002521 char_u *name,
2522 int len, // length of "name"
2523 typval_T *rettv, // NULL when only checking existence
2524 dictitem_T **dip, // non-NULL when typval's dict item is needed
2525 int verbose, // may give error message
2526 int no_autoload) // do not use script autoloading
2527{
2528 int ret = OK;
2529 typval_T *tv = NULL;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002530 int foundFunc = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002531 dictitem_T *v;
2532 int cc;
2533
2534 // truncate the name, so that we can use strcmp()
2535 cc = name[len];
2536 name[len] = NUL;
2537
2538 // Check for user-defined variables.
2539 v = find_var(name, NULL, no_autoload);
2540 if (v != NULL)
2541 {
2542 tv = &v->di_tv;
2543 if (dip != NULL)
2544 *dip = v;
2545 }
2546
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002547 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002548 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002549 imported_T *import;
2550 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
2551
2552 import = find_imported(p, 0, NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002553
2554 // imported variable from another script
2555 if (import != NULL)
2556 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002557 if (import->imp_funcname != NULL)
2558 {
2559 foundFunc = TRUE;
2560 if (rettv != NULL)
2561 {
2562 rettv->v_type = VAR_FUNC;
2563 rettv->vval.v_string = vim_strsave(import->imp_funcname);
2564 }
2565 }
Bram Moolenaara6294952020-12-27 13:39:50 +01002566 else if (import->imp_flags & IMP_FLAGS_STAR)
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002567 {
2568 emsg("Sorry, 'import * as X' not implemented yet");
2569 ret = FAIL;
2570 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002571 else
2572 {
2573 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02002574 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002575 + import->imp_var_vals_idx;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002576 tv = sv->sv_tv;
2577 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002578 }
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002579 else if (in_vim9script())
2580 {
2581 ufunc_T *ufunc = find_func(name, FALSE, NULL);
2582
2583 if (ufunc != NULL)
2584 {
2585 foundFunc = TRUE;
2586 if (rettv != NULL)
2587 {
2588 rettv->v_type = VAR_FUNC;
2589 rettv->vval.v_string = vim_strsave(ufunc->uf_name);
2590 }
2591 }
2592 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002593 }
2594
Bram Moolenaarc620c052020-07-08 15:16:19 +02002595 if (!foundFunc)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002596 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002597 if (tv == NULL)
2598 {
2599 if (rettv != NULL && verbose)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002600 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarc620c052020-07-08 15:16:19 +02002601 ret = FAIL;
2602 }
2603 else if (rettv != NULL)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002604 {
2605 // If a list or dict variable wasn't initialized, do it now.
2606 if (tv->v_type == VAR_DICT && tv->vval.v_dict == NULL)
2607 {
2608 tv->vval.v_dict = dict_alloc();
2609 if (tv->vval.v_dict != NULL)
2610 ++tv->vval.v_dict->dv_refcount;
2611 }
2612 else if (tv->v_type == VAR_LIST && tv->vval.v_list == NULL)
2613 {
2614 tv->vval.v_list = list_alloc();
2615 if (tv->vval.v_list != NULL)
2616 ++tv->vval.v_list->lv_refcount;
2617 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002618 copy_tv(tv, rettv);
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002619 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002620 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002621
2622 name[len] = cc;
2623
2624 return ret;
2625}
2626
2627/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002628 * Check if variable "name[len]" is a local variable or an argument.
2629 * If so, "*eval_lavars_used" is set to TRUE.
2630 */
2631 void
2632check_vars(char_u *name, int len)
2633{
2634 int cc;
2635 char_u *varname;
2636 hashtab_T *ht;
2637
2638 if (eval_lavars_used == NULL)
2639 return;
2640
2641 // truncate the name, so that we can use strcmp()
2642 cc = name[len];
2643 name[len] = NUL;
2644
2645 ht = find_var_ht(name, &varname);
2646 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
2647 {
2648 if (find_var(name, NULL, TRUE) != NULL)
2649 *eval_lavars_used = TRUE;
2650 }
2651
2652 name[len] = cc;
2653}
2654
2655/*
2656 * Find variable "name" in the list of variables.
2657 * Return a pointer to it if found, NULL if not found.
2658 * Careful: "a:0" variables don't have a name.
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002659 * When "htp" is not NULL set "htp" to the hashtab_T used.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002660 */
2661 dictitem_T *
2662find_var(char_u *name, hashtab_T **htp, int no_autoload)
2663{
2664 char_u *varname;
2665 hashtab_T *ht;
2666 dictitem_T *ret = NULL;
2667
2668 ht = find_var_ht(name, &varname);
2669 if (htp != NULL)
2670 *htp = ht;
2671 if (ht == NULL)
2672 return NULL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002673 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002674 if (ret != NULL)
2675 return ret;
2676
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002677 // Search in parent scope for lambda
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002678 ret = find_var_in_scoped_ht(name, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01002679 if (ret != NULL)
2680 return ret;
2681
2682 // in Vim9 script items without a scope can be script-local
2683 if (in_vim9script() && name[0] != NUL && name[1] != ':')
2684 {
2685 ht = get_script_local_ht();
2686 if (ht != NULL)
2687 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002688 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01002689 if (ret != NULL)
2690 {
2691 if (htp != NULL)
2692 *htp = ht;
2693 return ret;
2694 }
2695 }
2696 }
2697
2698 return NULL;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002699}
2700
2701/*
2702 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02002703 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002704 * Returns NULL if not found.
2705 */
2706 dictitem_T *
2707find_var_in_ht(
2708 hashtab_T *ht,
2709 int htname,
2710 char_u *varname,
2711 int no_autoload)
2712{
2713 hashitem_T *hi;
2714
2715 if (*varname == NUL)
2716 {
2717 // Must be something like "s:", otherwise "ht" would be NULL.
2718 switch (htname)
2719 {
2720 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
2721 case 'g': return &globvars_var;
2722 case 'v': return &vimvars_var;
2723 case 'b': return &curbuf->b_bufvar;
2724 case 'w': return &curwin->w_winvar;
2725 case 't': return &curtab->tp_winvar;
2726 case 'l': return get_funccal_local_var();
2727 case 'a': return get_funccal_args_var();
2728 }
2729 return NULL;
2730 }
2731
2732 hi = hash_find(ht, varname);
2733 if (HASHITEM_EMPTY(hi))
2734 {
2735 // For global variables we may try auto-loading the script. If it
2736 // worked find the variable again. Don't auto-load a script if it was
2737 // loaded already, otherwise it would be loaded every time when
2738 // checking if a function name is a Funcref variable.
2739 if (ht == &globvarht && !no_autoload)
2740 {
2741 // Note: script_autoload() may make "hi" invalid. It must either
2742 // be obtained again or not used.
2743 if (!script_autoload(varname, FALSE) || aborting())
2744 return NULL;
2745 hi = hash_find(ht, varname);
2746 }
2747 if (HASHITEM_EMPTY(hi))
2748 return NULL;
2749 }
2750 return HI2DI(hi);
2751}
2752
2753/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002754 * Get the script-local hashtab. NULL if not in a script context.
2755 */
Bram Moolenaar922acbd2020-10-08 21:30:40 +02002756 hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002757get_script_local_ht(void)
2758{
2759 scid_T sid = current_sctx.sc_sid;
2760
Bram Moolenaare3d46852020-08-29 13:39:17 +02002761 if (SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002762 return &SCRIPT_VARS(sid);
2763 return NULL;
2764}
2765
2766/*
2767 * Look for "name[len]" in script-local variables.
Bram Moolenaar709664c2020-12-12 14:33:41 +01002768 * Return OK when found, FAIL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002769 */
Bram Moolenaar709664c2020-12-12 14:33:41 +01002770 int
2771lookup_scriptvar(
2772 char_u *name,
2773 size_t len,
2774 void *lvar UNUSED,
2775 cctx_T *dummy UNUSED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002776{
2777 hashtab_T *ht = get_script_local_ht();
2778 char_u buffer[30];
2779 char_u *p;
Bram Moolenaar709664c2020-12-12 14:33:41 +01002780 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002781 hashitem_T *hi;
2782
2783 if (ht == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01002784 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002785 if (len < sizeof(buffer) - 1)
2786 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02002787 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002788 vim_strncpy(buffer, name, len);
2789 p = buffer;
2790 }
2791 else
2792 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002793 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002794 if (p == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01002795 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002796 }
2797
2798 hi = hash_find(ht, p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01002799 res = HASHITEM_EMPTY(hi) ? FAIL : OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002800
2801 // if not script-local, then perhaps imported
Bram Moolenaar709664c2020-12-12 14:33:41 +01002802 if (res == FAIL && find_imported(p, 0, NULL) != NULL)
2803 res = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002804
2805 if (p != buffer)
2806 vim_free(p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01002807 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002808}
2809
2810/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002811 * Find the hashtab used for a variable name.
2812 * Return NULL if the name is not valid.
2813 * Set "varname" to the start of name without ':'.
2814 */
2815 hashtab_T *
2816find_var_ht(char_u *name, char_u **varname)
2817{
2818 hashitem_T *hi;
2819 hashtab_T *ht;
2820
2821 if (name[0] == NUL)
2822 return NULL;
2823 if (name[1] != ':')
2824 {
2825 // The name must not start with a colon or #.
2826 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
2827 return NULL;
2828 *varname = name;
2829
2830 // "version" is "v:version" in all scopes if scriptversion < 3.
2831 // Same for a few other variables marked with VV_COMPAT.
2832 if (current_sctx.sc_version < 3)
2833 {
2834 hi = hash_find(&compat_hashtab, name);
2835 if (!HASHITEM_EMPTY(hi))
2836 return &compat_hashtab;
2837 }
2838
2839 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002840 if (ht != NULL)
2841 return ht; // local variable
2842
2843 // in Vim9 script items at the script level are script-local
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002844 if (in_vim9script())
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002845 {
2846 ht = get_script_local_ht();
2847 if (ht != NULL)
2848 return ht;
2849 }
2850
2851 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002852 }
2853 *varname = name + 2;
2854 if (*name == 'g') // global variable
2855 return &globvarht;
2856 // There must be no ':' or '#' in the rest of the name, unless g: is used
2857 if (vim_strchr(name + 2, ':') != NULL
2858 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
2859 return NULL;
2860 if (*name == 'b') // buffer variable
2861 return &curbuf->b_vars->dv_hashtab;
2862 if (*name == 'w') // window variable
2863 return &curwin->w_vars->dv_hashtab;
2864 if (*name == 't') // tab page variable
2865 return &curtab->tp_vars->dv_hashtab;
2866 if (*name == 'v') // v: variable
2867 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002868 if (get_current_funccal() != NULL
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002869 && get_current_funccal()->func->uf_def_status == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002870 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002871 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002872 if (*name == 'a') // a: function argument
2873 return get_funccal_args_ht();
2874 if (*name == 'l') // l: local function variable
2875 return get_funccal_local_ht();
2876 }
2877 if (*name == 's') // script variable
2878 {
2879 ht = get_script_local_ht();
2880 if (ht != NULL)
2881 return ht;
2882 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002883 return NULL;
2884}
2885
2886/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002887 * Get the string value of a (global/local) variable.
2888 * Note: see tv_get_string() for how long the pointer remains valid.
2889 * Returns NULL when it doesn't exist.
2890 */
2891 char_u *
2892get_var_value(char_u *name)
2893{
2894 dictitem_T *v;
2895
2896 v = find_var(name, NULL, FALSE);
2897 if (v == NULL)
2898 return NULL;
2899 return tv_get_string(&v->di_tv);
2900}
2901
2902/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002903 * Allocate a new hashtab for a sourced script. It will be used while
2904 * sourcing this script and when executing functions defined in the script.
2905 */
2906 void
2907new_script_vars(scid_T id)
2908{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002909 scriptvar_T *sv;
2910
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01002911 sv = ALLOC_CLEAR_ONE(scriptvar_T);
2912 if (sv == NULL)
2913 return;
2914 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01002915 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002916}
2917
2918/*
2919 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
2920 * point to it.
2921 */
2922 void
2923init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
2924{
2925 hash_init(&dict->dv_hashtab);
2926 dict->dv_lock = 0;
2927 dict->dv_scope = scope;
2928 dict->dv_refcount = DO_NOT_FREE_CNT;
2929 dict->dv_copyID = 0;
2930 dict_var->di_tv.vval.v_dict = dict;
2931 dict_var->di_tv.v_type = VAR_DICT;
2932 dict_var->di_tv.v_lock = VAR_FIXED;
2933 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2934 dict_var->di_key[0] = NUL;
2935}
2936
2937/*
2938 * Unreference a dictionary initialized by init_var_dict().
2939 */
2940 void
2941unref_var_dict(dict_T *dict)
2942{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002943 // Now the dict needs to be freed if no one else is using it, go back to
2944 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002945 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
2946 dict_unref(dict);
2947}
2948
2949/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002950 * Clean up a list of internal variables.
2951 * Frees all allocated variables and the value they contain.
2952 * Clears hashtab "ht", does not free it.
2953 */
2954 void
2955vars_clear(hashtab_T *ht)
2956{
2957 vars_clear_ext(ht, TRUE);
2958}
2959
2960/*
2961 * Like vars_clear(), but only free the value if "free_val" is TRUE.
2962 */
2963 void
2964vars_clear_ext(hashtab_T *ht, int free_val)
2965{
2966 int todo;
2967 hashitem_T *hi;
2968 dictitem_T *v;
2969
2970 hash_lock(ht);
2971 todo = (int)ht->ht_used;
2972 for (hi = ht->ht_array; todo > 0; ++hi)
2973 {
2974 if (!HASHITEM_EMPTY(hi))
2975 {
2976 --todo;
2977
2978 // Free the variable. Don't remove it from the hashtab,
2979 // ht_array might change then. hash_clear() takes care of it
2980 // later.
2981 v = HI2DI(hi);
2982 if (free_val)
2983 clear_tv(&v->di_tv);
2984 if (v->di_flags & DI_FLAGS_ALLOC)
2985 vim_free(v);
2986 }
2987 }
2988 hash_clear(ht);
Bram Moolenaar8d739de2020-10-14 19:39:19 +02002989 hash_init(ht);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002990}
2991
2992/*
2993 * Delete a variable from hashtab "ht" at item "hi".
2994 * Clear the variable value and free the dictitem.
2995 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002996 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002997delete_var(hashtab_T *ht, hashitem_T *hi)
2998{
2999 dictitem_T *di = HI2DI(hi);
3000
3001 hash_remove(ht, hi);
3002 clear_tv(&di->di_tv);
3003 vim_free(di);
3004}
3005
3006/*
3007 * List the value of one internal variable.
3008 */
3009 static void
3010list_one_var(dictitem_T *v, char *prefix, int *first)
3011{
3012 char_u *tofree;
3013 char_u *s;
3014 char_u numbuf[NUMBUFLEN];
3015
3016 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
3017 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
3018 s == NULL ? (char_u *)"" : s, first);
3019 vim_free(tofree);
3020}
3021
3022 static void
3023list_one_var_a(
3024 char *prefix,
3025 char_u *name,
3026 int type,
3027 char_u *string,
3028 int *first) // when TRUE clear rest of screen and set to FALSE
3029{
3030 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
3031 msg_start();
3032 msg_puts(prefix);
3033 if (name != NULL) // "a:" vars don't have a name stored
3034 msg_puts((char *)name);
3035 msg_putchar(' ');
3036 msg_advance(22);
3037 if (type == VAR_NUMBER)
3038 msg_putchar('#');
3039 else if (type == VAR_FUNC || type == VAR_PARTIAL)
3040 msg_putchar('*');
3041 else if (type == VAR_LIST)
3042 {
3043 msg_putchar('[');
3044 if (*string == '[')
3045 ++string;
3046 }
3047 else if (type == VAR_DICT)
3048 {
3049 msg_putchar('{');
3050 if (*string == '{')
3051 ++string;
3052 }
3053 else
3054 msg_putchar(' ');
3055
3056 msg_outtrans(string);
3057
3058 if (type == VAR_FUNC || type == VAR_PARTIAL)
3059 msg_puts("()");
3060 if (*first)
3061 {
3062 msg_clr_eos();
3063 *first = FALSE;
3064 }
3065}
3066
3067/*
3068 * Set variable "name" to value in "tv".
3069 * If the variable already exists, the value is updated.
3070 * Otherwise the variable is created.
3071 */
3072 void
3073set_var(
3074 char_u *name,
3075 typval_T *tv,
3076 int copy) // make copy of value in "tv"
3077{
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003078 set_var_const(name, NULL, tv, copy, ASSIGN_DECL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003079}
3080
3081/*
3082 * Set variable "name" to value in "tv".
3083 * If the variable already exists and "is_const" is FALSE the value is updated.
3084 * Otherwise the variable is created.
3085 */
3086 void
3087set_var_const(
3088 char_u *name,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003089 type_T *type,
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003090 typval_T *tv_arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003091 int copy, // make copy of value in "tv"
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003092 int flags) // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003093{
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003094 typval_T *tv = tv_arg;
3095 typval_T bool_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003096 dictitem_T *di;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003097 char_u *varname;
3098 hashtab_T *ht;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003099 int is_script_local;
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003100 int vim9script = in_vim9script();
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003101
3102 ht = find_var_ht(name, &varname);
3103 if (ht == NULL || *varname == NUL)
3104 {
3105 semsg(_(e_illvar), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003106 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003107 }
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003108 is_script_local = ht == get_script_local_ht();
3109
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003110 if (vim9script
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003111 && !is_script_local
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003112 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003113 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003114 && name[1] == ':')
Bram Moolenaar67979662020-06-20 22:50:47 +02003115 {
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003116 vim9_declare_error(name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003117 goto failed;
Bram Moolenaar67979662020-06-20 22:50:47 +02003118 }
3119
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003120 di = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003121
3122 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003123 if (di == NULL)
3124 di = find_var_in_scoped_ht(name, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003125
3126 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
Bram Moolenaar98b4f142020-08-08 15:46:01 +02003127 && var_wrong_func_name(name, di == NULL))
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003128 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003129
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003130 if (need_convert_to_bool(type, tv))
3131 {
3132 // Destination is a bool and the value is not, but it can be converted.
3133 CLEAR_FIELD(bool_tv);
3134 bool_tv.v_type = VAR_BOOL;
3135 bool_tv.vval.v_number = tv2bool(tv) ? VVAL_TRUE : VVAL_FALSE;
3136 tv = &bool_tv;
3137 }
3138
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003139 if (di != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003140 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003141 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003142 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003143 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003144 {
3145 emsg(_(e_cannot_mod));
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003146 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003147 }
3148
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003149 if (is_script_local && vim9script)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003150 {
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003151 if ((flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0)
Bram Moolenaar34db91f2020-06-13 19:00:10 +02003152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003153 semsg(_(e_redefining_script_item_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003154 goto failed;
Bram Moolenaar34db91f2020-06-13 19:00:10 +02003155 }
3156
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003157 // check the type and adjust to bool if needed
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02003158 if (check_script_var_type(&di->di_tv, tv, name) == FAIL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003159 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003160 }
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02003161
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003162 if (var_check_permission(di, name) == FAIL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003163 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003165 else
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003166 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003167 // can only redefine once
3168 di->di_flags &= ~DI_FLAGS_RELOAD;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003169
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003170 // A Vim9 script-local variable is also present in sn_all_vars and
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003171 // sn_var_vals. It may set "type" from "tv".
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003172 if (is_script_local && vim9script)
Bram Moolenaar08251752021-01-11 21:20:18 +01003173 update_vim9_script_var(FALSE, di, flags, tv, &type);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003174 }
3175
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003176 // existing variable, need to clear the value
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003177
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003178 // Handle setting internal di: variables separately where needed to
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003179 // prevent changing the type.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003180 if (ht == &vimvarht)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003181 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003182 if (di->di_tv.v_type == VAR_STRING)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003183 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003184 VIM_CLEAR(di->di_tv.vval.v_string);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003185 if (copy || tv->v_type != VAR_STRING)
3186 {
3187 char_u *val = tv_get_string(tv);
3188
3189 // Careful: when assigning to v:errmsg and tv_get_string()
Bram Moolenaar4b96df52020-01-26 22:00:26 +01003190 // causes an error message the variable will already be set.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003191 if (di->di_tv.vval.v_string == NULL)
3192 di->di_tv.vval.v_string = vim_strsave(val);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003193 }
3194 else
3195 {
3196 // Take over the string to avoid an extra alloc/free.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003197 di->di_tv.vval.v_string = tv->vval.v_string;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003198 tv->vval.v_string = NULL;
3199 }
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003200 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003201 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003202 else if (di->di_tv.v_type == VAR_NUMBER)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003203 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003204 di->di_tv.vval.v_number = tv_get_number(tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003205 if (STRCMP(varname, "searchforward") == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003206 set_search_direction(di->di_tv.vval.v_number ? '/' : '?');
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003207#ifdef FEAT_SEARCH_EXTRA
3208 else if (STRCMP(varname, "hlsearch") == 0)
3209 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003210 no_hlsearch = !di->di_tv.vval.v_number;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003211 redraw_all_later(SOME_VALID);
3212 }
3213#endif
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003214 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003215 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003216 else if (di->di_tv.v_type != tv->v_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003217 {
3218 semsg(_("E963: setting %s to value with wrong type"), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003219 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003220 }
3221 }
3222
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003223 clear_tv(&di->di_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003224 }
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003225 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003226 {
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003227 // add a new variable
3228 if (vim9script && is_script_local && (flags & ASSIGN_NO_DECL))
3229 {
3230 semsg(_(e_unknown_variable_str), name);
3231 goto failed;
3232 }
3233
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003234 // Can't add "v:" or "a:" variable.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003235 if (ht == &vimvarht || ht == get_funccal_args_ht())
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003236 {
3237 semsg(_(e_illvar), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003238 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003239 }
3240
Bram Moolenaar03290b82020-12-19 16:30:44 +01003241 // Make sure the variable name is valid. In Vim9 script an autoload
3242 // variable must be prefixed with "g:".
3243 if (!valid_varname(varname, !vim9script
3244 || STRNCMP(name, "g:", 2) == 0))
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003245 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003246
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003247 di = alloc(sizeof(dictitem_T) + STRLEN(varname));
3248 if (di == NULL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003249 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003250 STRCPY(di->di_key, varname);
3251 if (hash_add(ht, DI2HIKEY(di)) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003252 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003253 vim_free(di);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003254 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003255 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003256 di->di_flags = DI_FLAGS_ALLOC;
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003257 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003258 di->di_flags |= DI_FLAGS_LOCK;
3259
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003260 // A Vim9 script-local variable is also added to sn_all_vars and
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003261 // sn_var_vals. It may set "type" from "tv".
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003262 if (is_script_local && vim9script)
Bram Moolenaar08251752021-01-11 21:20:18 +01003263 update_vim9_script_var(TRUE, di, flags, tv, &type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003264 }
3265
3266 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003267 copy_tv(tv, &di->di_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003268 else
3269 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003270 di->di_tv = *tv;
3271 di->di_tv.v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003272 init_tv(tv);
3273 }
3274
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003275 if (vim9script && type != NULL)
3276 {
3277 if (type->tt_type == VAR_DICT && di->di_tv.vval.v_dict != NULL)
3278 di->di_tv.vval.v_dict->dv_type = alloc_type(type);
3279 else if (type->tt_type == VAR_LIST && di->di_tv.vval.v_list != NULL)
3280 di->di_tv.vval.v_list->lv_type = alloc_type(type);
3281 }
3282
Bram Moolenaar1dcf55d2020-12-22 22:07:30 +01003283 // ":const var = value" locks the value
3284 // ":final var = value" locks "var"
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003285 if (flags & ASSIGN_CONST)
Bram Moolenaar021bda52020-08-17 21:07:22 +02003286 // Like :lockvar! name: lock the value and what it contains, but only
3287 // if the reference count is up to one. That locks only literal
3288 // values.
3289 item_lock(&di->di_tv, DICT_MAXNEST, TRUE, TRUE);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003290 return;
3291failed:
3292 if (!copy)
3293 clear_tv(tv_arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003294}
3295
3296/*
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003297 * Check in this order for backwards compatibility:
3298 * - Whether the variable is read-only
3299 * - Whether the variable value is locked
3300 * - Whether the variable is locked
3301 */
3302 int
3303var_check_permission(dictitem_T *di, char_u *name)
3304{
3305 if (var_check_ro(di->di_flags, name, FALSE)
3306 || value_check_lock(di->di_tv.v_lock, name, FALSE)
3307 || var_check_lock(di->di_flags, name, FALSE))
3308 return FAIL;
3309 return OK;
3310}
3311
3312/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003313 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
3314 * Also give an error message.
3315 */
3316 int
3317var_check_ro(int flags, char_u *name, int use_gettext)
3318{
3319 if (flags & DI_FLAGS_RO)
3320 {
3321 semsg(_(e_readonlyvar), use_gettext ? (char_u *)_(name) : name);
3322 return TRUE;
3323 }
3324 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
3325 {
3326 semsg(_(e_readonlysbx), use_gettext ? (char_u *)_(name) : name);
3327 return TRUE;
3328 }
3329 return FALSE;
3330}
3331
3332/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003333 * Return TRUE if di_flags "flags" indicates variable "name" is locked.
3334 * Also give an error message.
3335 */
3336 int
3337var_check_lock(int flags, char_u *name, int use_gettext)
3338{
3339 if (flags & DI_FLAGS_LOCK)
3340 {
3341 semsg(_(e_variable_is_locked_str),
3342 use_gettext ? (char_u *)_(name) : name);
3343 return TRUE;
3344 }
3345 return FALSE;
3346}
3347
3348/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003349 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
3350 * Also give an error message.
3351 */
3352 int
3353var_check_fixed(int flags, char_u *name, int use_gettext)
3354{
3355 if (flags & DI_FLAGS_FIX)
3356 {
3357 semsg(_("E795: Cannot delete variable %s"),
3358 use_gettext ? (char_u *)_(name) : name);
3359 return TRUE;
3360 }
3361 return FALSE;
3362}
3363
3364/*
3365 * Check if a funcref is assigned to a valid variable name.
3366 * Return TRUE and give an error if not.
3367 */
3368 int
Bram Moolenaar98b4f142020-08-08 15:46:01 +02003369var_wrong_func_name(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003370 char_u *name, // points to start of variable name
3371 int new_var) // TRUE when creating the variable
3372{
3373 // Allow for w: b: s: and t:.
3374 if (!(vim_strchr((char_u *)"wbst", name[0]) != NULL && name[1] == ':')
3375 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
3376 ? name[2] : name[0]))
3377 {
3378 semsg(_("E704: Funcref variable name must start with a capital: %s"),
3379 name);
3380 return TRUE;
3381 }
3382 // Don't allow hiding a function. When "v" is not NULL we might be
3383 // assigning another function to the same var, the type is checked
3384 // below.
3385 if (new_var && function_exists(name, FALSE))
3386 {
3387 semsg(_("E705: Variable name conflicts with existing function: %s"),
3388 name);
3389 return TRUE;
3390 }
3391 return FALSE;
3392}
3393
3394/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003395 * Return TRUE if "flags" indicates variable "name" has a locked (immutable)
3396 * value. Also give an error message, using "name" or _("name") when
3397 * "use_gettext" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003398 */
3399 int
Bram Moolenaara187c432020-09-16 21:08:28 +02003400value_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003401{
3402 if (lock & VAR_LOCKED)
3403 {
3404 semsg(_("E741: Value is locked: %s"),
3405 name == NULL ? (char_u *)_("Unknown")
3406 : use_gettext ? (char_u *)_(name)
3407 : name);
3408 return TRUE;
3409 }
3410 if (lock & VAR_FIXED)
3411 {
3412 semsg(_("E742: Cannot change value of %s"),
3413 name == NULL ? (char_u *)_("Unknown")
3414 : use_gettext ? (char_u *)_(name)
3415 : name);
3416 return TRUE;
3417 }
3418 return FALSE;
3419}
3420
3421/*
Bram Moolenaar03290b82020-12-19 16:30:44 +01003422 * Check if a variable name is valid. When "autoload" is true "#" is allowed.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003423 * Return FALSE and give an error if not.
3424 */
3425 int
Bram Moolenaar03290b82020-12-19 16:30:44 +01003426valid_varname(char_u *varname, int autoload)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003427{
3428 char_u *p;
3429
3430 for (p = varname; *p != NUL; ++p)
3431 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
Bram Moolenaar03290b82020-12-19 16:30:44 +01003432 && !(autoload && *p == AUTOLOAD_CHAR))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003433 {
3434 semsg(_(e_illvar), varname);
3435 return FALSE;
3436 }
3437 return TRUE;
3438}
3439
3440/*
3441 * getwinvar() and gettabwinvar()
3442 */
3443 static void
3444getwinvar(
3445 typval_T *argvars,
3446 typval_T *rettv,
3447 int off) // 1 for gettabwinvar()
3448{
3449 win_T *win;
3450 char_u *varname;
3451 dictitem_T *v;
3452 tabpage_T *tp = NULL;
3453 int done = FALSE;
3454 win_T *oldcurwin;
3455 tabpage_T *oldtabpage;
3456 int need_switch_win;
3457
3458 if (off == 1)
3459 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3460 else
3461 tp = curtab;
3462 win = find_win_by_nr(&argvars[off], tp);
3463 varname = tv_get_string_chk(&argvars[off + 1]);
3464 ++emsg_off;
3465
3466 rettv->v_type = VAR_STRING;
3467 rettv->vval.v_string = NULL;
3468
3469 if (win != NULL && varname != NULL)
3470 {
3471 // Set curwin to be our win, temporarily. Also set the tabpage,
3472 // otherwise the window is not valid. Only do this when needed,
3473 // autocommands get blocked.
3474 need_switch_win = !(tp == curtab && win == curwin);
3475 if (!need_switch_win
3476 || switch_win(&oldcurwin, &oldtabpage, win, tp, TRUE) == OK)
3477 {
3478 if (*varname == '&')
3479 {
3480 if (varname[1] == NUL)
3481 {
3482 // get all window-local options in a dict
3483 dict_T *opts = get_winbuf_options(FALSE);
3484
3485 if (opts != NULL)
3486 {
3487 rettv_dict_set(rettv, opts);
3488 done = TRUE;
3489 }
3490 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003491 else if (eval_option(&varname, rettv, 1) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003492 // window-local-option
3493 done = TRUE;
3494 }
3495 else
3496 {
3497 // Look up the variable.
3498 // Let getwinvar({nr}, "") return the "w:" dictionary.
3499 v = find_var_in_ht(&win->w_vars->dv_hashtab, 'w',
3500 varname, FALSE);
3501 if (v != NULL)
3502 {
3503 copy_tv(&v->di_tv, rettv);
3504 done = TRUE;
3505 }
3506 }
3507 }
3508
3509 if (need_switch_win)
3510 // restore previous notion of curwin
3511 restore_win(oldcurwin, oldtabpage, TRUE);
3512 }
3513
3514 if (!done && argvars[off + 2].v_type != VAR_UNKNOWN)
3515 // use the default return value
3516 copy_tv(&argvars[off + 2], rettv);
3517
3518 --emsg_off;
3519}
3520
3521/*
Bram Moolenaar191929b2020-08-19 21:20:49 +02003522 * Set option "varname" to the value of "varp" for the current buffer/window.
3523 */
3524 static void
3525set_option_from_tv(char_u *varname, typval_T *varp)
3526{
3527 long numval = 0;
3528 char_u *strval;
3529 char_u nbuf[NUMBUFLEN];
3530 int error = FALSE;
3531
Bram Moolenaar31a201a2021-01-03 14:47:25 +01003532 if (varp->v_type == VAR_BOOL)
Bram Moolenaarb0d81822021-01-03 15:55:10 +01003533 {
Bram Moolenaar31a201a2021-01-03 14:47:25 +01003534 numval = (long)varp->vval.v_number;
Bram Moolenaarb0d81822021-01-03 15:55:10 +01003535 strval = (char_u *)"0"; // avoid using "false"
3536 }
3537 else
3538 {
3539 if (!in_vim9script() || varp->v_type != VAR_STRING)
3540 numval = (long)tv_get_number_chk(varp, &error);
3541 strval = tv_get_string_buf_chk(varp, nbuf);
3542 }
Bram Moolenaar191929b2020-08-19 21:20:49 +02003543 if (!error && strval != NULL)
3544 set_option_value(varname, numval, strval, OPT_LOCAL);
3545}
3546
3547/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003548 * "setwinvar()" and "settabwinvar()" functions
3549 */
3550 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003551setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003552{
3553 win_T *win;
3554 win_T *save_curwin;
3555 tabpage_T *save_curtab;
3556 int need_switch_win;
3557 char_u *varname, *winvarname;
3558 typval_T *varp;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003559 tabpage_T *tp = NULL;
3560
3561 if (check_secure())
3562 return;
3563
3564 if (off == 1)
3565 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3566 else
3567 tp = curtab;
3568 win = find_win_by_nr(&argvars[off], tp);
3569 varname = tv_get_string_chk(&argvars[off + 1]);
3570 varp = &argvars[off + 2];
3571
3572 if (win != NULL && varname != NULL && varp != NULL)
3573 {
3574 need_switch_win = !(tp == curtab && win == curwin);
3575 if (!need_switch_win
3576 || switch_win(&save_curwin, &save_curtab, win, tp, TRUE) == OK)
3577 {
3578 if (*varname == '&')
Bram Moolenaar191929b2020-08-19 21:20:49 +02003579 set_option_from_tv(varname + 1, varp);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003580 else
3581 {
3582 winvarname = alloc(STRLEN(varname) + 3);
3583 if (winvarname != NULL)
3584 {
3585 STRCPY(winvarname, "w:");
3586 STRCPY(winvarname + 2, varname);
3587 set_var(winvarname, varp, TRUE);
3588 vim_free(winvarname);
3589 }
3590 }
3591 }
3592 if (need_switch_win)
3593 restore_win(save_curwin, save_curtab, TRUE);
3594 }
3595}
3596
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003597/*
3598 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
3599 * v:option_type, and v:option_command.
3600 */
3601 void
3602reset_v_option_vars(void)
3603{
3604 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
3605 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
3606 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
3607 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
3608 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
3609 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
3610}
3611
3612/*
3613 * Add an assert error to v:errors.
3614 */
3615 void
3616assert_error(garray_T *gap)
3617{
3618 struct vimvar *vp = &vimvars[VV_ERRORS];
3619
3620 if (vp->vv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003621 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003622 set_vim_var_list(VV_ERRORS, list_alloc());
3623 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
3624}
3625
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003626 int
3627var_exists(char_u *var)
3628{
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003629 char_u *arg = var;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003630 char_u *name;
3631 char_u *tofree;
3632 typval_T tv;
3633 int len = 0;
3634 int n = FALSE;
3635
3636 // get_name_len() takes care of expanding curly braces
3637 name = var;
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003638 len = get_name_len(&arg, &tofree, TRUE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003639 if (len > 0)
3640 {
3641 if (tofree != NULL)
3642 name = tofree;
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003643 n = (eval_variable(name, len, &tv, NULL, FALSE, TRUE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003644 if (n)
3645 {
3646 // handle d.key, l[idx], f(expr)
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003647 arg = skipwhite(arg);
3648 n = (handle_subscript(&arg, &tv, &EVALARG_EVALUATE, FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003649 if (n)
3650 clear_tv(&tv);
3651 }
3652 }
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003653 if (*arg != NUL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003654 n = FALSE;
3655
3656 vim_free(tofree);
3657 return n;
3658}
3659
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003660static lval_T *redir_lval = NULL;
3661#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
3662static garray_T redir_ga; // only valid when redir_lval is not NULL
3663static char_u *redir_endp = NULL;
3664static char_u *redir_varname = NULL;
3665
3666/*
3667 * Start recording command output to a variable
3668 * When "append" is TRUE append to an existing variable.
3669 * Returns OK if successfully completed the setup. FAIL otherwise.
3670 */
3671 int
3672var_redir_start(char_u *name, int append)
3673{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003674 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003675 typval_T tv;
3676
3677 // Catch a bad name early.
3678 if (!eval_isnamec1(*name))
3679 {
3680 emsg(_(e_invarg));
3681 return FAIL;
3682 }
3683
3684 // Make a copy of the name, it is used in redir_lval until redir ends.
3685 redir_varname = vim_strsave(name);
3686 if (redir_varname == NULL)
3687 return FAIL;
3688
3689 redir_lval = ALLOC_CLEAR_ONE(lval_T);
3690 if (redir_lval == NULL)
3691 {
3692 var_redir_stop();
3693 return FAIL;
3694 }
3695
3696 // The output is stored in growarray "redir_ga" until redirection ends.
3697 ga_init2(&redir_ga, (int)sizeof(char), 500);
3698
3699 // Parse the variable name (can be a dict or list entry).
3700 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
3701 FNE_CHECK_START);
3702 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
3703 {
3704 clear_lval(redir_lval);
3705 if (redir_endp != NULL && *redir_endp != NUL)
3706 // Trailing characters are present after the variable name
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003707 semsg(_(e_trailing_arg), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003708 else
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003709 semsg(_(e_invarg2), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003710 redir_endp = NULL; // don't store a value, only cleanup
3711 var_redir_stop();
3712 return FAIL;
3713 }
3714
3715 // check if we can write to the variable: set it to or append an empty
3716 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003717 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003718 tv.v_type = VAR_STRING;
3719 tv.vval.v_string = (char_u *)"";
3720 if (append)
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02003721 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
3722 ASSIGN_NO_DECL, (char_u *)".");
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003723 else
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02003724 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
3725 ASSIGN_NO_DECL, (char_u *)"=");
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003726 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003727 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003728 {
3729 redir_endp = NULL; // don't store a value, only cleanup
3730 var_redir_stop();
3731 return FAIL;
3732 }
3733
3734 return OK;
3735}
3736
3737/*
3738 * Append "value[value_len]" to the variable set by var_redir_start().
3739 * The actual appending is postponed until redirection ends, because the value
3740 * appended may in fact be the string we write to, changing it may cause freed
3741 * memory to be used:
3742 * :redir => foo
3743 * :let foo
3744 * :redir END
3745 */
3746 void
3747var_redir_str(char_u *value, int value_len)
3748{
3749 int len;
3750
3751 if (redir_lval == NULL)
3752 return;
3753
3754 if (value_len == -1)
3755 len = (int)STRLEN(value); // Append the entire string
3756 else
3757 len = value_len; // Append only "value_len" characters
3758
3759 if (ga_grow(&redir_ga, len) == OK)
3760 {
3761 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
3762 redir_ga.ga_len += len;
3763 }
3764 else
3765 var_redir_stop();
3766}
3767
3768/*
3769 * Stop redirecting command output to a variable.
3770 * Frees the allocated memory.
3771 */
3772 void
3773var_redir_stop(void)
3774{
3775 typval_T tv;
3776
3777 if (EVALCMD_BUSY)
3778 {
3779 redir_lval = NULL;
3780 return;
3781 }
3782
3783 if (redir_lval != NULL)
3784 {
3785 // If there was no error: assign the text to the variable.
3786 if (redir_endp != NULL)
3787 {
3788 ga_append(&redir_ga, NUL); // Append the trailing NUL.
3789 tv.v_type = VAR_STRING;
3790 tv.vval.v_string = redir_ga.ga_data;
3791 // Call get_lval() again, if it's inside a Dict or List it may
3792 // have changed.
3793 redir_endp = get_lval(redir_varname, NULL, redir_lval,
3794 FALSE, FALSE, 0, FNE_CHECK_START);
3795 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003796 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003797 (char_u *)".");
3798 clear_lval(redir_lval);
3799 }
3800
3801 // free the collected output
3802 VIM_CLEAR(redir_ga.ga_data);
3803
3804 VIM_CLEAR(redir_lval);
3805 }
3806 VIM_CLEAR(redir_varname);
3807}
3808
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003809/*
3810 * "gettabvar()" function
3811 */
3812 void
3813f_gettabvar(typval_T *argvars, typval_T *rettv)
3814{
3815 win_T *oldcurwin;
3816 tabpage_T *tp, *oldtabpage;
3817 dictitem_T *v;
3818 char_u *varname;
3819 int done = FALSE;
3820
3821 rettv->v_type = VAR_STRING;
3822 rettv->vval.v_string = NULL;
3823
3824 varname = tv_get_string_chk(&argvars[1]);
3825 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3826 if (tp != NULL && varname != NULL)
3827 {
3828 // Set tp to be our tabpage, temporarily. Also set the window to the
3829 // first window in the tabpage, otherwise the window is not valid.
3830 if (switch_win(&oldcurwin, &oldtabpage,
3831 tp == curtab || tp->tp_firstwin == NULL ? firstwin
3832 : tp->tp_firstwin, tp, TRUE) == OK)
3833 {
3834 // look up the variable
3835 // Let gettabvar({nr}, "") return the "t:" dictionary.
3836 v = find_var_in_ht(&tp->tp_vars->dv_hashtab, 't', varname, FALSE);
3837 if (v != NULL)
3838 {
3839 copy_tv(&v->di_tv, rettv);
3840 done = TRUE;
3841 }
3842 }
3843
3844 // restore previous notion of curwin
3845 restore_win(oldcurwin, oldtabpage, TRUE);
3846 }
3847
3848 if (!done && argvars[2].v_type != VAR_UNKNOWN)
3849 copy_tv(&argvars[2], rettv);
3850}
3851
3852/*
3853 * "gettabwinvar()" function
3854 */
3855 void
3856f_gettabwinvar(typval_T *argvars, typval_T *rettv)
3857{
3858 getwinvar(argvars, rettv, 1);
3859}
3860
3861/*
3862 * "getwinvar()" function
3863 */
3864 void
3865f_getwinvar(typval_T *argvars, typval_T *rettv)
3866{
3867 getwinvar(argvars, rettv, 0);
3868}
3869
3870/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003871 * "getbufvar()" function
3872 */
3873 void
3874f_getbufvar(typval_T *argvars, typval_T *rettv)
3875{
3876 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003877 char_u *varname;
3878 dictitem_T *v;
3879 int done = FALSE;
3880
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003881 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02003882 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003883
3884 rettv->v_type = VAR_STRING;
3885 rettv->vval.v_string = NULL;
3886
3887 if (buf != NULL && varname != NULL)
3888 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003889 if (*varname == '&')
3890 {
Bram Moolenaar86015452020-03-29 15:12:15 +02003891 buf_T *save_curbuf = curbuf;
3892
3893 // set curbuf to be our buf, temporarily
3894 curbuf = buf;
3895
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003896 if (varname[1] == NUL)
3897 {
3898 // get all buffer-local options in a dict
3899 dict_T *opts = get_winbuf_options(TRUE);
3900
3901 if (opts != NULL)
3902 {
3903 rettv_dict_set(rettv, opts);
3904 done = TRUE;
3905 }
3906 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003907 else if (eval_option(&varname, rettv, TRUE) == OK)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003908 // buffer-local-option
3909 done = TRUE;
Bram Moolenaar86015452020-03-29 15:12:15 +02003910
3911 // restore previous notion of curbuf
3912 curbuf = save_curbuf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003913 }
3914 else
3915 {
3916 // Look up the variable.
Bram Moolenaar52592752020-04-03 18:43:35 +02003917 if (*varname == NUL)
3918 // Let getbufvar({nr}, "") return the "b:" dictionary.
3919 v = &buf->b_bufvar;
3920 else
3921 v = find_var_in_ht(&buf->b_vars->dv_hashtab, 'b',
3922 varname, FALSE);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003923 if (v != NULL)
3924 {
3925 copy_tv(&v->di_tv, rettv);
3926 done = TRUE;
3927 }
3928 }
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003929 }
3930
3931 if (!done && argvars[2].v_type != VAR_UNKNOWN)
3932 // use the default value
3933 copy_tv(&argvars[2], rettv);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003934}
3935
3936/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003937 * "settabvar()" function
3938 */
3939 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003940f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003941{
3942 tabpage_T *save_curtab;
3943 tabpage_T *tp;
3944 char_u *varname, *tabvarname;
3945 typval_T *varp;
3946
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003947 if (check_secure())
3948 return;
3949
3950 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3951 varname = tv_get_string_chk(&argvars[1]);
3952 varp = &argvars[2];
3953
3954 if (varname != NULL && varp != NULL && tp != NULL)
3955 {
3956 save_curtab = curtab;
3957 goto_tabpage_tp(tp, FALSE, FALSE);
3958
3959 tabvarname = alloc(STRLEN(varname) + 3);
3960 if (tabvarname != NULL)
3961 {
3962 STRCPY(tabvarname, "t:");
3963 STRCPY(tabvarname + 2, varname);
3964 set_var(tabvarname, varp, TRUE);
3965 vim_free(tabvarname);
3966 }
3967
3968 // Restore current tabpage
3969 if (valid_tabpage(save_curtab))
3970 goto_tabpage_tp(save_curtab, FALSE, FALSE);
3971 }
3972}
3973
3974/*
3975 * "settabwinvar()" function
3976 */
3977 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003978f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003979{
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003980 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003981}
3982
3983/*
3984 * "setwinvar()" function
3985 */
3986 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003987f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003988{
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003989 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003990}
3991
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003992/*
3993 * "setbufvar()" function
3994 */
3995 void
3996f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
3997{
3998 buf_T *buf;
3999 char_u *varname, *bufvarname;
4000 typval_T *varp;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004001
4002 if (check_secure())
4003 return;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004004 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004005 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004006 varp = &argvars[2];
4007
4008 if (buf != NULL && varname != NULL && varp != NULL)
4009 {
4010 if (*varname == '&')
4011 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004012 aco_save_T aco;
4013
4014 // set curbuf to be our buf, temporarily
4015 aucmd_prepbuf(&aco, buf);
4016
Bram Moolenaar191929b2020-08-19 21:20:49 +02004017 set_option_from_tv(varname + 1, varp);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004018
4019 // reset notion of buffer
4020 aucmd_restbuf(&aco);
4021 }
4022 else
4023 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004024 bufvarname = alloc(STRLEN(varname) + 3);
4025 if (bufvarname != NULL)
4026 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004027 buf_T *save_curbuf = curbuf;
4028
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004029 curbuf = buf;
4030 STRCPY(bufvarname, "b:");
4031 STRCPY(bufvarname + 2, varname);
4032 set_var(bufvarname, varp, TRUE);
4033 vim_free(bufvarname);
4034 curbuf = save_curbuf;
4035 }
4036 }
4037 }
4038}
4039
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004040/*
4041 * Get a callback from "arg". It can be a Funcref or a function name.
4042 * When "arg" is zero return an empty string.
4043 * "cb_name" is not allocated.
4044 * "cb_name" is set to NULL for an invalid argument.
4045 */
4046 callback_T
4047get_callback(typval_T *arg)
4048{
Bram Moolenaar14e579092020-03-07 16:59:25 +01004049 callback_T res;
4050 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004051
4052 res.cb_free_name = FALSE;
4053 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
4054 {
4055 res.cb_partial = arg->vval.v_partial;
4056 ++res.cb_partial->pt_refcount;
4057 res.cb_name = partial_name(res.cb_partial);
4058 }
4059 else
4060 {
4061 res.cb_partial = NULL;
Bram Moolenaar14e579092020-03-07 16:59:25 +01004062 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
4063 && isdigit(*arg->vval.v_string))
4064 r = FAIL;
4065 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004066 {
4067 // Note that we don't make a copy of the string.
4068 res.cb_name = arg->vval.v_string;
4069 func_ref(res.cb_name);
4070 }
4071 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004072 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004073 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01004074 r = FAIL;
4075
4076 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004077 {
4078 emsg(_("E921: Invalid callback argument"));
4079 res.cb_name = NULL;
4080 }
4081 }
4082 return res;
4083}
4084
4085/*
4086 * Copy a callback into a typval_T.
4087 */
4088 void
4089put_callback(callback_T *cb, typval_T *tv)
4090{
4091 if (cb->cb_partial != NULL)
4092 {
4093 tv->v_type = VAR_PARTIAL;
4094 tv->vval.v_partial = cb->cb_partial;
4095 ++tv->vval.v_partial->pt_refcount;
4096 }
4097 else
4098 {
4099 tv->v_type = VAR_FUNC;
4100 tv->vval.v_string = vim_strsave(cb->cb_name);
4101 func_ref(cb->cb_name);
4102 }
4103}
4104
4105/*
4106 * Make a copy of "src" into "dest", allocating the function name if needed,
4107 * without incrementing the refcount.
4108 */
4109 void
4110set_callback(callback_T *dest, callback_T *src)
4111{
4112 if (src->cb_partial == NULL)
4113 {
4114 // just a function name, make a copy
4115 dest->cb_name = vim_strsave(src->cb_name);
4116 dest->cb_free_name = TRUE;
4117 }
4118 else
4119 {
4120 // cb_name is a pointer into cb_partial
4121 dest->cb_name = src->cb_name;
4122 dest->cb_free_name = FALSE;
4123 }
4124 dest->cb_partial = src->cb_partial;
4125}
4126
4127/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02004128 * Copy callback from "src" to "dest", incrementing the refcounts.
4129 */
4130 void
4131copy_callback(callback_T *dest, callback_T *src)
4132{
4133 dest->cb_partial = src->cb_partial;
4134 if (dest->cb_partial != NULL)
4135 {
4136 dest->cb_name = src->cb_name;
4137 dest->cb_free_name = FALSE;
4138 ++dest->cb_partial->pt_refcount;
4139 }
4140 else
4141 {
4142 dest->cb_name = vim_strsave(src->cb_name);
4143 dest->cb_free_name = TRUE;
4144 func_ref(src->cb_name);
4145 }
4146}
4147
4148/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004149 * Unref/free "callback" returned by get_callback() or set_callback().
4150 */
4151 void
4152free_callback(callback_T *callback)
4153{
4154 if (callback->cb_partial != NULL)
4155 {
4156 partial_unref(callback->cb_partial);
4157 callback->cb_partial = NULL;
4158 }
4159 else if (callback->cb_name != NULL)
4160 func_unref(callback->cb_name);
4161 if (callback->cb_free_name)
4162 {
4163 vim_free(callback->cb_name);
4164 callback->cb_free_name = FALSE;
4165 }
4166 callback->cb_name = NULL;
4167}
4168
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004169#endif // FEAT_EVAL