blob: 8aac7667d4cffecdbc9cb9557f71de001ce71ca8 [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},
125 {VV_NAME("numbersize", VAR_NUMBER), VV_RO},
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200126 {VV_NAME("vim_did_enter", VAR_NUMBER), VV_RO},
127 {VV_NAME("testing", VAR_NUMBER), 0},
128 {VV_NAME("t_number", VAR_NUMBER), VV_RO},
129 {VV_NAME("t_string", VAR_NUMBER), VV_RO},
130 {VV_NAME("t_func", VAR_NUMBER), VV_RO},
131 {VV_NAME("t_list", VAR_NUMBER), VV_RO},
132 {VV_NAME("t_dict", VAR_NUMBER), VV_RO},
133 {VV_NAME("t_float", VAR_NUMBER), VV_RO},
134 {VV_NAME("t_bool", VAR_NUMBER), VV_RO},
135 {VV_NAME("t_none", VAR_NUMBER), VV_RO},
136 {VV_NAME("t_job", VAR_NUMBER), VV_RO},
137 {VV_NAME("t_channel", VAR_NUMBER), VV_RO},
138 {VV_NAME("t_blob", VAR_NUMBER), VV_RO},
139 {VV_NAME("termrfgresp", VAR_STRING), VV_RO},
140 {VV_NAME("termrbgresp", VAR_STRING), VV_RO},
141 {VV_NAME("termu7resp", VAR_STRING), VV_RO},
142 {VV_NAME("termstyleresp", VAR_STRING), VV_RO},
143 {VV_NAME("termblinkresp", VAR_STRING), VV_RO},
144 {VV_NAME("event", VAR_DICT), VV_RO},
145 {VV_NAME("versionlong", VAR_NUMBER), VV_RO},
146 {VV_NAME("echospace", VAR_NUMBER), VV_RO},
Bram Moolenaar69bf6342019-10-29 04:16:57 +0100147 {VV_NAME("argv", VAR_LIST), VV_RO},
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +0200148 {VV_NAME("collate", VAR_STRING), VV_RO},
Bram Moolenaarf0068c52020-11-30 17:42:10 +0100149 {VV_NAME("exiting", VAR_SPECIAL), VV_RO},
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200150};
151
152// shorthand
153#define vv_type vv_di.di_tv.v_type
154#define vv_nr vv_di.di_tv.vval.v_number
155#define vv_float vv_di.di_tv.vval.v_float
156#define vv_str vv_di.di_tv.vval.v_string
157#define vv_list vv_di.di_tv.vval.v_list
158#define vv_dict vv_di.di_tv.vval.v_dict
159#define vv_blob vv_di.di_tv.vval.v_blob
160#define vv_tv vv_di.di_tv
161
162static dictitem_T vimvars_var; // variable used for v:
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200163static dict_T vimvardict; // Dictionary with v: variables
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200164#define vimvarht vimvardict.dv_hashtab
165
166// for VIM_VERSION_ defines
167#include "version.h"
168
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200169static void list_glob_vars(int *first);
170static void list_buf_vars(int *first);
171static void list_win_vars(int *first);
172static void list_tab_vars(int *first);
173static char_u *list_arg_vars(exarg_T *eap, char_u *arg, int *first);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100174static 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 +0200175static int do_unlet_var(lval_T *lp, char_u *name_end, exarg_T *eap, int deep, void *cookie);
176static 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 +0200177static void list_one_var(dictitem_T *v, char *prefix, int *first);
178static void list_one_var_a(char *prefix, char_u *name, int type, char_u *string, int *first);
179
180/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200181 * Initialize global and vim special variables
182 */
183 void
184evalvars_init(void)
185{
186 int i;
187 struct vimvar *p;
188
189 init_var_dict(&globvardict, &globvars_var, VAR_DEF_SCOPE);
190 init_var_dict(&vimvardict, &vimvars_var, VAR_SCOPE);
191 vimvardict.dv_lock = VAR_FIXED;
192 hash_init(&compat_hashtab);
193
194 for (i = 0; i < VV_LEN; ++i)
195 {
196 p = &vimvars[i];
197 if (STRLEN(p->vv_name) > DICTITEM16_KEY_LEN)
198 {
199 iemsg("INTERNAL: name too long, increase size of dictitem16_T");
200 getout(1);
201 }
202 STRCPY(p->vv_di.di_key, p->vv_name);
203 if (p->vv_flags & VV_RO)
204 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
205 else if (p->vv_flags & VV_RO_SBX)
206 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
207 else
208 p->vv_di.di_flags = DI_FLAGS_FIX;
209
210 // add to v: scope dict, unless the value is not always available
211 if (p->vv_type != VAR_UNKNOWN)
212 hash_add(&vimvarht, p->vv_di.di_key);
213 if (p->vv_flags & VV_COMPAT)
214 // add to compat scope dict
215 hash_add(&compat_hashtab, p->vv_di.di_key);
216 }
Bram Moolenaar016faaa2020-10-03 12:57:27 +0200217 set_vim_var_nr(VV_VERSION, VIM_VERSION_100);
218 set_vim_var_nr(VV_VERSIONLONG, VIM_VERSION_100 * 10000 + highest_patch());
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200219
220 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
221 set_vim_var_nr(VV_HLSEARCH, 1L);
Bram Moolenaarf0068c52020-11-30 17:42:10 +0100222 set_vim_var_nr(VV_EXITING, VVAL_NULL);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200223 set_vim_var_dict(VV_COMPLETED_ITEM, dict_alloc_lock(VAR_FIXED));
224 set_vim_var_list(VV_ERRORS, list_alloc());
225 set_vim_var_dict(VV_EVENT, dict_alloc_lock(VAR_FIXED));
226
227 set_vim_var_nr(VV_FALSE, VVAL_FALSE);
228 set_vim_var_nr(VV_TRUE, VVAL_TRUE);
229 set_vim_var_nr(VV_NONE, VVAL_NONE);
230 set_vim_var_nr(VV_NULL, VVAL_NULL);
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100231 set_vim_var_nr(VV_NUMBERSIZE, sizeof(varnumber_T) * 8);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200232
233 set_vim_var_nr(VV_TYPE_NUMBER, VAR_TYPE_NUMBER);
234 set_vim_var_nr(VV_TYPE_STRING, VAR_TYPE_STRING);
235 set_vim_var_nr(VV_TYPE_FUNC, VAR_TYPE_FUNC);
236 set_vim_var_nr(VV_TYPE_LIST, VAR_TYPE_LIST);
237 set_vim_var_nr(VV_TYPE_DICT, VAR_TYPE_DICT);
238 set_vim_var_nr(VV_TYPE_FLOAT, VAR_TYPE_FLOAT);
239 set_vim_var_nr(VV_TYPE_BOOL, VAR_TYPE_BOOL);
240 set_vim_var_nr(VV_TYPE_NONE, VAR_TYPE_NONE);
241 set_vim_var_nr(VV_TYPE_JOB, VAR_TYPE_JOB);
242 set_vim_var_nr(VV_TYPE_CHANNEL, VAR_TYPE_CHANNEL);
243 set_vim_var_nr(VV_TYPE_BLOB, VAR_TYPE_BLOB);
244
245 set_vim_var_nr(VV_ECHOSPACE, sc_col - 1);
246
Bram Moolenaar439c0362020-06-06 15:58:03 +0200247 // Default for v:register is not 0 but '"'. This is adjusted once the
248 // clipboard has been setup by calling reset_reg_var().
249 set_reg_var(0);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200250}
251
252#if defined(EXITFREE) || defined(PROTO)
253/*
254 * Free all vim variables information on exit
255 */
256 void
257evalvars_clear(void)
258{
259 int i;
260 struct vimvar *p;
261
262 for (i = 0; i < VV_LEN; ++i)
263 {
264 p = &vimvars[i];
265 if (p->vv_di.di_tv.v_type == VAR_STRING)
266 VIM_CLEAR(p->vv_str);
267 else if (p->vv_di.di_tv.v_type == VAR_LIST)
268 {
269 list_unref(p->vv_list);
270 p->vv_list = NULL;
271 }
272 }
273 hash_clear(&vimvarht);
274 hash_init(&vimvarht); // garbage_collect() will access it
275 hash_clear(&compat_hashtab);
276
277 // global variables
278 vars_clear(&globvarht);
279
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100280 // Script-local variables. Clear all the variables here.
281 // The scriptvar_T is cleared later in free_scriptnames(), because a
282 // variable in one script might hold a reference to the whole scope of
283 // another script.
284 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200285 vars_clear(&SCRIPT_VARS(i));
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200286}
287#endif
288
289 int
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200290garbage_collect_globvars(int copyID)
291{
292 return set_ref_in_ht(&globvarht, copyID, NULL);
293}
294
295 int
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200296garbage_collect_vimvars(int copyID)
297{
298 return set_ref_in_ht(&vimvarht, copyID, NULL);
299}
300
301 int
302garbage_collect_scriptvars(int copyID)
303{
Bram Moolenaared234f22020-10-15 20:42:20 +0200304 int i;
305 int idx;
306 int abort = FALSE;
307 scriptitem_T *si;
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200308
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100309 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaared234f22020-10-15 20:42:20 +0200310 {
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200311 abort = abort || set_ref_in_ht(&SCRIPT_VARS(i), copyID, NULL);
312
Bram Moolenaared234f22020-10-15 20:42:20 +0200313 si = SCRIPT_ITEM(i);
314 for (idx = 0; idx < si->sn_var_vals.ga_len; ++idx)
315 {
316 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + idx;
317
318 abort = abort || set_ref_in_item(sv->sv_tv, copyID, NULL, NULL);
319 }
320 }
321
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200322 return abort;
323}
324
325/*
326 * Set an internal variable to a string value. Creates the variable if it does
327 * not already exist.
328 */
329 void
330set_internal_string_var(char_u *name, char_u *value)
331{
332 char_u *val;
333 typval_T *tvp;
334
335 val = vim_strsave(value);
336 if (val != NULL)
337 {
338 tvp = alloc_string_tv(val);
339 if (tvp != NULL)
340 {
341 set_var(name, tvp, FALSE);
342 free_tv(tvp);
343 }
344 }
345}
346
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200347 int
348eval_charconvert(
349 char_u *enc_from,
350 char_u *enc_to,
351 char_u *fname_from,
352 char_u *fname_to)
353{
354 int err = FALSE;
355
356 set_vim_var_string(VV_CC_FROM, enc_from, -1);
357 set_vim_var_string(VV_CC_TO, enc_to, -1);
358 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
359 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
360 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
361 err = TRUE;
362 set_vim_var_string(VV_CC_FROM, NULL, -1);
363 set_vim_var_string(VV_CC_TO, NULL, -1);
364 set_vim_var_string(VV_FNAME_IN, NULL, -1);
365 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
366
367 if (err)
368 return FAIL;
369 return OK;
370}
371
372# if defined(FEAT_POSTSCRIPT) || defined(PROTO)
373 int
374eval_printexpr(char_u *fname, char_u *args)
375{
376 int err = FALSE;
377
378 set_vim_var_string(VV_FNAME_IN, fname, -1);
379 set_vim_var_string(VV_CMDARG, args, -1);
380 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
381 err = TRUE;
382 set_vim_var_string(VV_FNAME_IN, NULL, -1);
383 set_vim_var_string(VV_CMDARG, NULL, -1);
384
385 if (err)
386 {
387 mch_remove(fname);
388 return FAIL;
389 }
390 return OK;
391}
392# endif
393
394# if defined(FEAT_DIFF) || defined(PROTO)
395 void
396eval_diff(
397 char_u *origfile,
398 char_u *newfile,
399 char_u *outfile)
400{
401 int err = FALSE;
402
403 set_vim_var_string(VV_FNAME_IN, origfile, -1);
404 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
405 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
406 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
407 set_vim_var_string(VV_FNAME_IN, NULL, -1);
408 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
409 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
410}
411
412 void
413eval_patch(
414 char_u *origfile,
415 char_u *difffile,
416 char_u *outfile)
417{
418 int err;
419
420 set_vim_var_string(VV_FNAME_IN, origfile, -1);
421 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
422 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
423 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
424 set_vim_var_string(VV_FNAME_IN, NULL, -1);
425 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
426 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
427}
428# endif
429
430#if defined(FEAT_SPELL) || defined(PROTO)
431/*
432 * Evaluate an expression to a list with suggestions.
433 * For the "expr:" part of 'spellsuggest'.
434 * Returns NULL when there is an error.
435 */
436 list_T *
437eval_spell_expr(char_u *badword, char_u *expr)
438{
439 typval_T save_val;
440 typval_T rettv;
441 list_T *list = NULL;
442 char_u *p = skipwhite(expr);
443
444 // Set "v:val" to the bad word.
445 prepare_vimvar(VV_VAL, &save_val);
446 set_vim_var_string(VV_VAL, badword, -1);
447 if (p_verbose == 0)
448 ++emsg_off;
449
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200450 if (eval1(&p, &rettv, &EVALARG_EVALUATE) == OK)
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200451 {
452 if (rettv.v_type != VAR_LIST)
453 clear_tv(&rettv);
454 else
455 list = rettv.vval.v_list;
456 }
457
458 if (p_verbose == 0)
459 --emsg_off;
460 clear_tv(get_vim_var_tv(VV_VAL));
461 restore_vimvar(VV_VAL, &save_val);
462
463 return list;
464}
465
466/*
467 * "list" is supposed to contain two items: a word and a number. Return the
468 * word in "pp" and the number as the return value.
469 * Return -1 if anything isn't right.
470 * Used to get the good word and score from the eval_spell_expr() result.
471 */
472 int
473get_spellword(list_T *list, char_u **pp)
474{
475 listitem_T *li;
476
477 li = list->lv_first;
478 if (li == NULL)
479 return -1;
480 *pp = tv_get_string(&li->li_tv);
481
482 li = li->li_next;
483 if (li == NULL)
484 return -1;
485 return (int)tv_get_number(&li->li_tv);
486}
487#endif
488
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200489/*
490 * Prepare v: variable "idx" to be used.
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200491 * Save the current typeval in "save_tv" and clear it.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200492 * When not used yet add the variable to the v: hashtable.
493 */
494 void
495prepare_vimvar(int idx, typval_T *save_tv)
496{
497 *save_tv = vimvars[idx].vv_tv;
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200498 vimvars[idx].vv_str = NULL; // don't free it now
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200499 if (vimvars[idx].vv_type == VAR_UNKNOWN)
500 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
501}
502
503/*
504 * Restore v: variable "idx" to typeval "save_tv".
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200505 * Note that the v: variable must have been cleared already.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200506 * When no longer defined, remove the variable from the v: hashtable.
507 */
508 void
509restore_vimvar(int idx, typval_T *save_tv)
510{
511 hashitem_T *hi;
512
513 vimvars[idx].vv_tv = *save_tv;
514 if (vimvars[idx].vv_type == VAR_UNKNOWN)
515 {
516 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
517 if (HASHITEM_EMPTY(hi))
518 internal_error("restore_vimvar()");
519 else
520 hash_remove(&vimvarht, hi);
521 }
522}
523
524/*
525 * List Vim variables.
526 */
527 static void
528list_vim_vars(int *first)
529{
530 list_hashtable_vars(&vimvarht, "v:", FALSE, first);
531}
532
533/*
534 * List script-local variables, if there is a script.
535 */
536 static void
537list_script_vars(int *first)
538{
Bram Moolenaare3d46852020-08-29 13:39:17 +0200539 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200540 list_hashtable_vars(&SCRIPT_VARS(current_sctx.sc_sid),
541 "s:", FALSE, first);
542}
543
544/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200545 * Get a list of lines from a HERE document. The here document is a list of
546 * lines surrounded by a marker.
547 * cmd << {marker}
548 * {line1}
549 * {line2}
550 * ....
551 * {marker}
552 *
553 * The {marker} is a string. If the optional 'trim' word is supplied before the
554 * marker, then the leading indentation before the lines (matching the
555 * indentation in the 'cmd' line) is stripped.
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200556 *
557 * When getting lines for an embedded script (e.g. python, lua, perl, ruby,
558 * tcl, mzscheme), script_get is set to TRUE. In this case, if the marker is
559 * missing, then '.' is accepted as a marker.
560 *
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200561 * Returns a List with {lines} or NULL.
562 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100563 list_T *
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200564heredoc_get(exarg_T *eap, char_u *cmd, int script_get)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200565{
566 char_u *theline;
567 char_u *marker;
568 list_T *l;
569 char_u *p;
570 int marker_indent_len = 0;
571 int text_indent_len = 0;
572 char_u *text_indent = NULL;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200573 char_u dot[] = ".";
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200574 int comment_char = in_vim9script() ? '#' : '"';
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200575
576 if (eap->getline == NULL)
577 {
578 emsg(_("E991: cannot use =<< here"));
579 return NULL;
580 }
581
582 // Check for the optional 'trim' word before the marker
583 cmd = skipwhite(cmd);
584 if (STRNCMP(cmd, "trim", 4) == 0 && (cmd[4] == NUL || VIM_ISWHITE(cmd[4])))
585 {
586 cmd = skipwhite(cmd + 4);
587
588 // Trim the indentation from all the lines in the here document.
589 // The amount of indentation trimmed is the same as the indentation of
590 // the first line after the :let command line. To find the end marker
591 // the indent of the :let command line is trimmed.
592 p = *eap->cmdlinep;
593 while (VIM_ISWHITE(*p))
594 {
595 p++;
596 marker_indent_len++;
597 }
598 text_indent_len = -1;
599 }
600
601 // The marker is the next word.
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200602 if (*cmd != NUL && *cmd != comment_char)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200603 {
604 marker = skipwhite(cmd);
605 p = skiptowhite(marker);
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200606 if (*skipwhite(p) != NUL && *skipwhite(p) != comment_char)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200607 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +0200608 semsg(_(e_trailing_arg), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200609 return NULL;
610 }
611 *p = NUL;
Bram Moolenaar6ab09532020-05-01 14:10:13 +0200612 if (!script_get && vim_islower(*marker))
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200613 {
614 emsg(_("E221: Marker cannot start with lower case letter"));
615 return NULL;
616 }
617 }
618 else
619 {
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200620 // When getting lines for an embedded script, if the marker is missing,
621 // accept '.' as the marker.
622 if (script_get)
623 marker = dot;
624 else
625 {
626 emsg(_("E172: Missing marker"));
627 return NULL;
628 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200629 }
630
631 l = list_alloc();
632 if (l == NULL)
633 return NULL;
634
635 for (;;)
636 {
637 int mi = 0;
638 int ti = 0;
639
640 theline = eap->getline(NUL, eap->cookie, 0, FALSE);
641 if (theline == NULL)
642 {
643 semsg(_("E990: Missing end marker '%s'"), marker);
644 break;
645 }
646
647 // with "trim": skip the indent matching the :let line to find the
648 // marker
649 if (marker_indent_len > 0
650 && STRNCMP(theline, *eap->cmdlinep, marker_indent_len) == 0)
651 mi = marker_indent_len;
652 if (STRCMP(marker, theline + mi) == 0)
653 {
654 vim_free(theline);
655 break;
656 }
657
658 if (text_indent_len == -1 && *theline != NUL)
659 {
660 // set the text indent from the first line.
661 p = theline;
662 text_indent_len = 0;
663 while (VIM_ISWHITE(*p))
664 {
665 p++;
666 text_indent_len++;
667 }
668 text_indent = vim_strnsave(theline, text_indent_len);
669 }
670 // with "trim": skip the indent matching the first line
671 if (text_indent != NULL)
672 for (ti = 0; ti < text_indent_len; ++ti)
673 if (theline[ti] != text_indent[ti])
674 break;
675
676 if (list_append_string(l, theline + ti, -1) == FAIL)
677 break;
678 vim_free(theline);
679 }
680 vim_free(text_indent);
681
682 return l;
683}
684
685/*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200686 * Vim9 variable declaration:
687 * ":var name"
688 * ":var name: type"
689 * ":var name = expr"
690 * ":var name: type = expr"
691 * etc.
692 */
693 void
694ex_var(exarg_T *eap)
695{
696 if (!in_vim9script())
697 {
698 semsg(_(e_str_cannot_be_used_in_legacy_vim_script), ":var");
699 return;
700 }
701 ex_let(eap);
702}
703
704/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200705 * ":let" list all variable values
706 * ":let var1 var2" list variable values
707 * ":let var = expr" assignment command.
708 * ":let var += expr" assignment command.
709 * ":let var -= expr" assignment command.
710 * ":let var *= expr" assignment command.
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 [var1, var2] = expr" unpack list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100716 * ":let var =<< ..." heredoc
Bram Moolenaard672dde2020-02-26 13:43:51 +0100717 * ":let var: string" Vim9 declaration
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200718 *
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200719 * ":final var = expr" assignment command.
720 * ":final [var1, var2] = expr" unpack list.
721 *
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200722 * ":const" list all variable values
723 * ":const var1 var2" list variable values
724 * ":const var = expr" assignment command.
725 * ":const [var1, var2] = expr" unpack list.
726 */
727 void
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200728ex_let(exarg_T *eap)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200729{
730 char_u *arg = eap->arg;
731 char_u *expr = NULL;
732 typval_T rettv;
733 int i;
734 int var_count = 0;
735 int semicolon = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200736 char_u op[4];
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200737 char_u *argend;
738 int first = TRUE;
739 int concat;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200740 int has_assign;
Bram Moolenaar89b474d2020-12-22 21:19:39 +0100741 int flags = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200742 int vim9script = in_vim9script();
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200743
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200744 if (eap->cmdidx == CMD_final && !vim9script)
745 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +0100746 // In legacy Vim script ":final" is short for ":finally".
747 ex_finally(eap);
748 return;
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200749 }
Bram Moolenaarc58f5452020-10-21 20:58:52 +0200750 if (eap->cmdidx == CMD_let && vim9script)
Bram Moolenaarcfcd0112020-09-27 15:19:27 +0200751 {
752 emsg(_(e_cannot_use_let_in_vim9_script));
753 return;
754 }
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200755
Bram Moolenaar89b474d2020-12-22 21:19:39 +0100756 if (eap->cmdidx == CMD_const)
757 flags |= ASSIGN_CONST;
758 else if (eap->cmdidx == CMD_final)
759 flags |= ASSIGN_FINAL;
760
761 // Vim9 assignment without ":let", ":const" or ":final"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100762 if (eap->arg == eap->cmd)
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200763 flags |= ASSIGN_NO_DECL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100764
Bram Moolenaar47a519a2020-06-14 23:05:10 +0200765 argend = skip_var_list(arg, TRUE, &var_count, &semicolon, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200766 if (argend == NULL)
767 return;
768 if (argend > arg && argend[-1] == '.') // for var.='str'
769 --argend;
770 expr = skipwhite(argend);
771 concat = expr[0] == '.'
772 && ((expr[1] == '=' && current_sctx.sc_version < 2)
773 || (expr[1] == '.' && expr[2] == '='));
Bram Moolenaar32e35112020-05-14 22:41:15 +0200774 has_assign = *expr == '=' || (vim_strchr((char_u *)"+-*/%", *expr) != NULL
775 && expr[1] == '=');
Bram Moolenaar822ba242020-05-24 23:00:18 +0200776 if (!has_assign && !concat)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200777 {
778 // ":let" without "=": list variables
779 if (*arg == '[')
780 emsg(_(e_invarg));
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200781 else if (expr[0] == '.' && expr[1] == '=')
782 emsg(_("E985: .= is not supported with script version >= 2"));
Bram Moolenaarfaac4102020-04-20 17:46:14 +0200783 else if (!ends_excmd2(eap->cmd, arg))
Bram Moolenaarc82a5b52020-06-13 18:09:19 +0200784 {
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200785 if (vim9script)
Bram Moolenaarc82a5b52020-06-13 18:09:19 +0200786 {
Bram Moolenaar07a65d22020-12-26 20:09:15 +0100787 // Vim9 declaration ":var name: type"
Bram Moolenaarc82a5b52020-06-13 18:09:19 +0200788 arg = vim9_declare_scriptvar(eap, arg);
789 }
790 else
791 {
792 // ":let var1 var2" - list values
793 arg = list_arg_vars(eap, arg, &first);
794 }
795 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200796 else if (!eap->skip)
797 {
798 // ":let"
799 list_glob_vars(&first);
800 list_buf_vars(&first);
801 list_win_vars(&first);
802 list_tab_vars(&first);
803 list_script_vars(&first);
804 list_func_vars(&first);
805 list_vim_vars(&first);
806 }
807 eap->nextcmd = check_nextcmd(arg);
808 }
809 else if (expr[0] == '=' && expr[1] == '<' && expr[2] == '<')
810 {
811 list_T *l;
812
813 // HERE document
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200814 l = heredoc_get(eap, expr + 3, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200815 if (l != NULL)
816 {
817 rettv_list_set(&rettv, l);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +0200818 if (!eap->skip)
819 {
820 op[0] = '=';
821 op[1] = NUL;
822 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100823 flags, op);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +0200824 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200825 clear_tv(&rettv);
826 }
827 }
828 else
829 {
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200830 evalarg_T evalarg;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200831 int len = 1;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200832
Bram Moolenaarc1ec0422020-09-09 22:27:58 +0200833 CLEAR_FIELD(rettv);
Bram Moolenaar32e35112020-05-14 22:41:15 +0200834 i = FAIL;
835 if (has_assign || concat)
836 {
837 op[0] = '=';
838 op[1] = NUL;
839 if (*expr != '=')
840 {
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200841 if (vim9script && (flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar122616d2020-08-21 21:32:50 +0200842 {
843 // +=, /=, etc. require an existing variable
844 semsg(_(e_cannot_use_operator_on_new_variable), eap->arg);
845 i = FAIL;
846 }
847 else if (vim_strchr((char_u *)"+-*/%.", *expr) != NULL)
Bram Moolenaar32e35112020-05-14 22:41:15 +0200848 {
849 op[0] = *expr; // +=, -=, *=, /=, %= or .=
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200850 ++len;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200851 if (expr[0] == '.' && expr[1] == '.') // ..=
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200852 {
Bram Moolenaar32e35112020-05-14 22:41:15 +0200853 ++expr;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200854 ++len;
855 }
Bram Moolenaar32e35112020-05-14 22:41:15 +0200856 }
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200857 expr += 2;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200858 }
859 else
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200860 ++expr;
861
Bram Moolenaarc7e44a72020-07-29 21:37:43 +0200862 if (vim9script && (!VIM_ISWHITE(*argend)
863 || !IS_WHITE_OR_NUL(*expr)))
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200864 {
865 vim_strncpy(op, expr - len, len);
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100866 semsg(_(e_white_space_required_before_and_after_str_at_str),
867 op, argend);
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200868 i = FAIL;
869 }
Bram Moolenaar32e35112020-05-14 22:41:15 +0200870
871 if (eap->skip)
872 ++emsg_skip;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200873 CLEAR_FIELD(evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200874 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
Bram Moolenaard5053d02020-06-28 15:51:16 +0200875 if (getline_equal(eap->getline, eap->cookie, getsourceline))
876 {
877 evalarg.eval_getline = eap->getline;
878 evalarg.eval_cookie = eap->cookie;
879 }
Bram Moolenaarc7e44a72020-07-29 21:37:43 +0200880 expr = skipwhite_and_linebreak(expr, &evalarg);
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200881 i = eval0(expr, &rettv, eap, &evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200882 if (eap->skip)
883 --emsg_skip;
Bram Moolenaarfaf86262020-06-27 23:07:36 +0200884 clear_evalarg(&evalarg, eap);
Bram Moolenaar32e35112020-05-14 22:41:15 +0200885 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200886 if (eap->skip)
887 {
888 if (i != FAIL)
889 clear_tv(&rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200890 }
Bram Moolenaar822ba242020-05-24 23:00:18 +0200891 else if (i != FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200892 {
893 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200894 flags, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200895 clear_tv(&rettv);
896 }
897 }
898}
899
900/*
901 * Assign the typevalue "tv" to the variable or variables at "arg_start".
902 * Handles both "var" with any type and "[var, var; var]" with a list type.
903 * When "op" is not NULL it points to a string with characters that
904 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
905 * or concatenate.
906 * Returns OK or FAIL;
907 */
908 int
909ex_let_vars(
910 char_u *arg_start,
911 typval_T *tv,
912 int copy, // copy values from "tv", don't move
913 int semicolon, // from skip_var_list()
914 int var_count, // from skip_var_list()
Bram Moolenaar3862ea32021-01-01 21:05:55 +0100915 int flags, // ASSIGN_FINAL, ASSIGN_CONST, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200916 char_u *op)
917{
918 char_u *arg = arg_start;
919 list_T *l;
920 int i;
921 listitem_T *item;
922 typval_T ltv;
923
924 if (*arg != '[')
925 {
926 // ":let var = expr" or ":for var in list"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100927 if (ex_let_one(arg, tv, copy, flags, op, op) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200928 return FAIL;
929 return OK;
930 }
931
932 // ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
933 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
934 {
935 emsg(_(e_listreq));
936 return FAIL;
937 }
938
939 i = list_len(l);
940 if (semicolon == 0 && var_count < i)
941 {
942 emsg(_("E687: Less targets than List items"));
943 return FAIL;
944 }
945 if (var_count - semicolon > i)
946 {
947 emsg(_("E688: More targets than List items"));
948 return FAIL;
949 }
950
Bram Moolenaar7e9f3512020-05-13 22:44:22 +0200951 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200952 item = l->lv_first;
953 while (*arg != ']')
954 {
955 arg = skipwhite(arg + 1);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100956 arg = ex_let_one(arg, &item->li_tv, TRUE, flags, (char_u *)",;]", op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200957 item = item->li_next;
958 if (arg == NULL)
959 return FAIL;
960
961 arg = skipwhite(arg);
962 if (*arg == ';')
963 {
964 // Put the rest of the list (may be empty) in the var after ';'.
965 // Create a new list for this.
966 l = list_alloc();
967 if (l == NULL)
968 return FAIL;
969 while (item != NULL)
970 {
971 list_append_tv(l, &item->li_tv);
972 item = item->li_next;
973 }
974
975 ltv.v_type = VAR_LIST;
976 ltv.v_lock = 0;
977 ltv.vval.v_list = l;
978 l->lv_refcount = 1;
979
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100980 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE, flags,
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200981 (char_u *)"]", op);
982 clear_tv(&ltv);
983 if (arg == NULL)
984 return FAIL;
985 break;
986 }
987 else if (*arg != ',' && *arg != ']')
988 {
989 internal_error("ex_let_vars()");
990 return FAIL;
991 }
992 }
993
994 return OK;
995}
996
997/*
998 * Skip over assignable variable "var" or list of variables "[var, var]".
999 * Used for ":let varvar = expr" and ":for varvar in expr".
1000 * For "[var, var]" increment "*var_count" for each variable.
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001001 * for "[var, var; var]" set "semicolon" to 1.
1002 * If "silent" is TRUE do not give an "invalid argument" error message.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001003 * Return NULL for an error.
1004 */
1005 char_u *
1006skip_var_list(
1007 char_u *arg,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001008 int include_type,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001009 int *var_count,
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001010 int *semicolon,
1011 int silent)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001012{
1013 char_u *p, *s;
1014
1015 if (*arg == '[')
1016 {
1017 // "[var, var]": find the matching ']'.
1018 p = arg;
1019 for (;;)
1020 {
1021 p = skipwhite(p + 1); // skip whites after '[', ';' or ','
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001022 s = skip_var_one(p, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001023 if (s == p)
1024 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001025 if (!silent)
1026 semsg(_(e_invarg2), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001027 return NULL;
1028 }
1029 ++*var_count;
1030
1031 p = skipwhite(s);
1032 if (*p == ']')
1033 break;
1034 else if (*p == ';')
1035 {
1036 if (*semicolon == 1)
1037 {
Bram Moolenaar9be61bb2020-03-30 22:51:24 +02001038 emsg(_("E452: Double ; in list of variables"));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001039 return NULL;
1040 }
1041 *semicolon = 1;
1042 }
1043 else if (*p != ',')
1044 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001045 if (!silent)
1046 semsg(_(e_invarg2), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001047 return NULL;
1048 }
1049 }
1050 return p + 1;
1051 }
1052 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001053 return skip_var_one(arg, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001054}
1055
1056/*
1057 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1058 * l[idx].
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001059 * In Vim9 script also skip over ": type" if "include_type" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001060 */
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001061 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001062skip_var_one(char_u *arg, int include_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001063{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001064 char_u *end;
1065
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001066 if (*arg == '@' && arg[1] != NUL)
1067 return arg + 2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001068 end = find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001069 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
Bram Moolenaareb6880b2020-07-12 17:07:05 +02001070 if (include_type && in_vim9script())
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001071 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001072 // "a: type" is declaring variable "a" with a type, not "a:".
1073 if (end == arg + 2 && end[-1] == ':')
1074 --end;
1075 if (*end == ':')
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02001076 end = skip_type(skipwhite(end + 1), FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001077 }
1078 return end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001079}
1080
1081/*
1082 * List variables for hashtab "ht" with prefix "prefix".
1083 * If "empty" is TRUE also list NULL strings as empty strings.
1084 */
1085 void
1086list_hashtable_vars(
1087 hashtab_T *ht,
1088 char *prefix,
1089 int empty,
1090 int *first)
1091{
1092 hashitem_T *hi;
1093 dictitem_T *di;
1094 int todo;
1095 char_u buf[IOSIZE];
1096
1097 todo = (int)ht->ht_used;
1098 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1099 {
1100 if (!HASHITEM_EMPTY(hi))
1101 {
1102 --todo;
1103 di = HI2DI(hi);
1104
1105 // apply :filter /pat/ to variable name
1106 vim_strncpy((char_u *)buf, (char_u *)prefix, IOSIZE - 1);
1107 vim_strcat((char_u *)buf, di->di_key, IOSIZE);
1108 if (message_filtered(buf))
1109 continue;
1110
1111 if (empty || di->di_tv.v_type != VAR_STRING
1112 || di->di_tv.vval.v_string != NULL)
1113 list_one_var(di, prefix, first);
1114 }
1115 }
1116}
1117
1118/*
1119 * List global variables.
1120 */
1121 static void
1122list_glob_vars(int *first)
1123{
1124 list_hashtable_vars(&globvarht, "", TRUE, first);
1125}
1126
1127/*
1128 * List buffer variables.
1129 */
1130 static void
1131list_buf_vars(int *first)
1132{
1133 list_hashtable_vars(&curbuf->b_vars->dv_hashtab, "b:", TRUE, first);
1134}
1135
1136/*
1137 * List window variables.
1138 */
1139 static void
1140list_win_vars(int *first)
1141{
1142 list_hashtable_vars(&curwin->w_vars->dv_hashtab, "w:", TRUE, first);
1143}
1144
1145/*
1146 * List tab page variables.
1147 */
1148 static void
1149list_tab_vars(int *first)
1150{
1151 list_hashtable_vars(&curtab->tp_vars->dv_hashtab, "t:", TRUE, first);
1152}
1153
1154/*
1155 * List variables in "arg".
1156 */
1157 static char_u *
1158list_arg_vars(exarg_T *eap, char_u *arg, int *first)
1159{
1160 int error = FALSE;
1161 int len;
1162 char_u *name;
1163 char_u *name_start;
1164 char_u *arg_subsc;
1165 char_u *tofree;
1166 typval_T tv;
1167
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001168 while (!ends_excmd2(eap->cmd, arg) && !got_int)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001169 {
1170 if (error || eap->skip)
1171 {
1172 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1173 if (!VIM_ISWHITE(*arg) && !ends_excmd(*arg))
1174 {
1175 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001176 semsg(_(e_trailing_arg), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001177 break;
1178 }
1179 }
1180 else
1181 {
1182 // get_name_len() takes care of expanding curly braces
1183 name_start = name = arg;
1184 len = get_name_len(&arg, &tofree, TRUE, TRUE);
1185 if (len <= 0)
1186 {
1187 // This is mainly to keep test 49 working: when expanding
1188 // curly braces fails overrule the exception error message.
1189 if (len < 0 && !aborting())
1190 {
1191 emsg_severe = TRUE;
1192 semsg(_(e_invarg2), arg);
1193 break;
1194 }
1195 error = TRUE;
1196 }
1197 else
1198 {
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02001199 arg = skipwhite(arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001200 if (tofree != NULL)
1201 name = tofree;
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02001202 if (eval_variable(name, len, &tv, NULL, TRUE, FALSE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001203 error = TRUE;
1204 else
1205 {
1206 // handle d.key, l[idx], f(expr)
1207 arg_subsc = arg;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001208 if (handle_subscript(&arg, &tv, &EVALARG_EVALUATE, TRUE)
Bram Moolenaar0b1cd522020-06-27 13:11:50 +02001209 == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001210 error = TRUE;
1211 else
1212 {
1213 if (arg == arg_subsc && len == 2 && name[1] == ':')
1214 {
1215 switch (*name)
1216 {
1217 case 'g': list_glob_vars(first); break;
1218 case 'b': list_buf_vars(first); break;
1219 case 'w': list_win_vars(first); break;
1220 case 't': list_tab_vars(first); break;
1221 case 'v': list_vim_vars(first); break;
1222 case 's': list_script_vars(first); break;
1223 case 'l': list_func_vars(first); break;
1224 default:
1225 semsg(_("E738: Can't list variables for %s"), name);
1226 }
1227 }
1228 else
1229 {
1230 char_u numbuf[NUMBUFLEN];
1231 char_u *tf;
1232 int c;
1233 char_u *s;
1234
1235 s = echo_string(&tv, &tf, numbuf, 0);
1236 c = *arg;
1237 *arg = NUL;
1238 list_one_var_a("",
1239 arg == arg_subsc ? name : name_start,
1240 tv.v_type,
1241 s == NULL ? (char_u *)"" : s,
1242 first);
1243 *arg = c;
1244 vim_free(tf);
1245 }
1246 clear_tv(&tv);
1247 }
1248 }
1249 }
1250
1251 vim_free(tofree);
1252 }
1253
1254 arg = skipwhite(arg);
1255 }
1256
1257 return arg;
1258}
1259
1260/*
1261 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
1262 * Returns a pointer to the char just after the var name.
1263 * Returns NULL if there is an error.
1264 */
1265 static char_u *
1266ex_let_one(
1267 char_u *arg, // points to variable name
1268 typval_T *tv, // value to assign to variable
1269 int copy, // copy value from "tv"
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001270 int flags, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001271 char_u *endchars, // valid chars after variable name or NULL
1272 char_u *op) // "+", "-", "." or NULL
1273{
1274 int c1;
1275 char_u *name;
1276 char_u *p;
1277 char_u *arg_end = NULL;
1278 int len;
1279 int opt_flags;
1280 char_u *tofree = NULL;
1281
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001282 if (in_vim9script() && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001283 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001284 && vim_strchr((char_u *)"$@&", *arg) != NULL)
1285 {
1286 vim9_declare_error(arg);
1287 return NULL;
1288 }
1289
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001290 // ":let $VAR = expr": Set environment variable.
1291 if (*arg == '$')
1292 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001293 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001294 {
1295 emsg(_("E996: Cannot lock an environment variable"));
1296 return NULL;
1297 }
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001298
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001299 // Find the end of the name.
1300 ++arg;
1301 name = arg;
1302 len = get_env_len(&arg);
1303 if (len == 0)
1304 semsg(_(e_invarg2), name - 1);
1305 else
1306 {
1307 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1308 semsg(_(e_letwrong), op);
1309 else if (endchars != NULL
1310 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
1311 emsg(_(e_letunexp));
1312 else if (!check_secure())
1313 {
1314 c1 = name[len];
1315 name[len] = NUL;
1316 p = tv_get_string_chk(tv);
1317 if (p != NULL && op != NULL && *op == '.')
1318 {
1319 int mustfree = FALSE;
1320 char_u *s = vim_getenv(name, &mustfree);
1321
1322 if (s != NULL)
1323 {
1324 p = tofree = concat_str(s, p);
1325 if (mustfree)
1326 vim_free(s);
1327 }
1328 }
1329 if (p != NULL)
1330 {
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01001331 vim_setenv_ext(name, p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001332 arg_end = arg;
1333 }
1334 name[len] = c1;
1335 vim_free(tofree);
1336 }
1337 }
1338 }
1339
1340 // ":let &option = expr": Set option value.
1341 // ":let &l:option = expr": Set local option value.
1342 // ":let &g:option = expr": Set global option value.
1343 else if (*arg == '&')
1344 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001345 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001346 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001347 emsg(_(e_const_option));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001348 return NULL;
1349 }
1350 // Find the end of the name.
1351 p = find_option_end(&arg, &opt_flags);
1352 if (p == NULL || (endchars != NULL
1353 && vim_strchr(endchars, *skipwhite(p)) == NULL))
1354 emsg(_(e_letunexp));
1355 else
1356 {
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001357 long n = 0;
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001358 getoption_T opt_type;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001359 long numval;
1360 char_u *stringval = NULL;
Bram Moolenaar65d032c2020-04-24 20:57:01 +02001361 char_u *s = NULL;
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001362 int failed = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001363
1364 c1 = *p;
1365 *p = NUL;
1366
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001367 opt_type = get_option_value(arg, &numval, &stringval, opt_flags);
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001368 if ((opt_type == gov_bool
1369 || opt_type == gov_number
1370 || opt_type == gov_hidden_bool
1371 || opt_type == gov_hidden_number)
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001372 && (tv->v_type != VAR_STRING || !in_vim9script()))
Bram Moolenaar0ea04402021-01-04 13:37:54 +01001373 {
1374 if (opt_type == gov_bool || opt_type == gov_hidden_bool)
1375 // bool, possibly hidden
1376 n = (long)tv_get_bool(tv);
1377 else
1378 // number, possibly hidden
1379 n = (long)tv_get_number(tv);
1380 }
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001381
1382 // Avoid setting a string option to the text "v:false" or similar.
1383 // In Vim9 script also don't convert a number to string.
1384 if (tv->v_type != VAR_BOOL && tv->v_type != VAR_SPECIAL
1385 && (!in_vim9script() || tv->v_type != VAR_NUMBER))
1386 s = tv_get_string_chk(tv);
1387
1388 if (op != NULL && *op != '=')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001389 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001390 if (((opt_type == gov_bool || opt_type == gov_number)
1391 && *op == '.')
1392 || (opt_type == gov_string && *op != '.'))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001393 {
1394 semsg(_(e_letwrong), op);
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001395 failed = TRUE; // don't set the value
1396
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001397 }
1398 else
1399 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001400 // number, in legacy script also bool
1401 if (opt_type == gov_number
1402 || (opt_type == gov_bool && !in_vim9script()))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001403 {
1404 switch (*op)
1405 {
1406 case '+': n = numval + n; break;
1407 case '-': n = numval - n; break;
1408 case '*': n = numval * n; break;
1409 case '/': n = (long)num_divide(numval, n); break;
1410 case '%': n = (long)num_modulus(numval, n); break;
1411 }
1412 }
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001413 else if (opt_type == gov_string
1414 && stringval != NULL && s != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001415 {
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001416 // string
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001417 s = concat_str(stringval, s);
1418 vim_free(stringval);
1419 stringval = s;
1420 }
1421 }
1422 }
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001423
1424 if (!failed)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001425 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001426 if (opt_type != gov_string || s != NULL)
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001427 {
1428 set_option_value(arg, n, s, opt_flags);
1429 arg_end = p;
1430 }
1431 else
1432 emsg(_(e_stringreq));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001433 }
1434 *p = c1;
1435 vim_free(stringval);
1436 }
1437 }
1438
1439 // ":let @r = expr": Set register contents.
1440 else if (*arg == '@')
1441 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001442 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001443 {
1444 emsg(_("E996: Cannot lock a register"));
1445 return NULL;
1446 }
1447 ++arg;
1448 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1449 semsg(_(e_letwrong), op);
1450 else if (endchars != NULL
1451 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
1452 emsg(_(e_letunexp));
1453 else
1454 {
1455 char_u *ptofree = NULL;
1456 char_u *s;
1457
1458 p = tv_get_string_chk(tv);
1459 if (p != NULL && op != NULL && *op == '.')
1460 {
1461 s = get_reg_contents(*arg == '@' ? '"' : *arg, GREG_EXPR_SRC);
1462 if (s != NULL)
1463 {
1464 p = ptofree = concat_str(s, p);
1465 vim_free(s);
1466 }
1467 }
1468 if (p != NULL)
1469 {
1470 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
1471 arg_end = arg + 1;
1472 }
1473 vim_free(ptofree);
1474 }
1475 }
1476
1477 // ":let var = expr": Set internal variable.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001478 // ":let var: type = expr": Set internal variable with type.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001479 // ":let {expr} = expr": Idem, name made with curly braces
1480 else if (eval_isnamec1(*arg) || *arg == '{')
1481 {
1482 lval_T lv;
1483
Bram Moolenaar8f22f5c2020-12-19 22:10:13 +01001484 p = get_lval(arg, tv, &lv, FALSE, FALSE,
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001485 (flags & (ASSIGN_NO_DECL | ASSIGN_DECL))
1486 ? GLV_NO_DECL : 0, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001487 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001488 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001489 if (endchars != NULL && vim_strchr(endchars,
1490 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001491 emsg(_(e_letunexp));
1492 else
1493 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001494 set_var_lval(&lv, p, tv, copy, flags, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001495 arg_end = p;
1496 }
1497 }
1498 clear_lval(&lv);
1499 }
1500
1501 else
1502 semsg(_(e_invarg2), arg);
1503
1504 return arg_end;
1505}
1506
1507/*
1508 * ":unlet[!] var1 ... " command.
1509 */
1510 void
1511ex_unlet(exarg_T *eap)
1512{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001513 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001514}
1515
1516/*
1517 * ":lockvar" and ":unlockvar" commands
1518 */
1519 void
1520ex_lockvar(exarg_T *eap)
1521{
1522 char_u *arg = eap->arg;
1523 int deep = 2;
1524
1525 if (eap->forceit)
1526 deep = -1;
1527 else if (vim_isdigit(*arg))
1528 {
1529 deep = getdigits(&arg);
1530 arg = skipwhite(arg);
1531 }
1532
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001533 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001534}
1535
1536/*
1537 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001538 * Also used for Vim9 script. "callback" is invoked as:
1539 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001540 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001541 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001542ex_unletlock(
1543 exarg_T *eap,
1544 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001545 int deep,
1546 int glv_flags,
1547 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1548 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001549{
1550 char_u *arg = argstart;
1551 char_u *name_end;
1552 int error = FALSE;
1553 lval_T lv;
1554
1555 do
1556 {
1557 if (*arg == '$')
1558 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001559 lv.ll_name = arg;
1560 lv.ll_tv = NULL;
1561 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001562 if (get_env_len(&arg) == 0)
1563 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001564 semsg(_(e_invarg2), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001565 return;
1566 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001567 if (!error && !eap->skip
1568 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1569 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001570 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001571 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001572 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001573 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001574 // Parse the name and find the end.
1575 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
Bram Moolenaarc3689572021-01-01 19:40:02 +01001576 glv_flags | GLV_NO_DECL, FNE_CHECK_START);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001577 if (lv.ll_name == NULL)
1578 error = TRUE; // error but continue parsing
1579 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1580 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001581 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001582 if (name_end != NULL)
1583 {
1584 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001585 semsg(_(e_trailing_arg), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001586 }
1587 if (!(eap->skip || error))
1588 clear_lval(&lv);
1589 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001590 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001591
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001592 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001593 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001594 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001595
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001596 if (!eap->skip)
1597 clear_lval(&lv);
1598 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001599
1600 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001601 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001602
1603 eap->nextcmd = check_nextcmd(arg);
1604}
1605
1606 static int
1607do_unlet_var(
1608 lval_T *lp,
1609 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001610 exarg_T *eap,
1611 int deep UNUSED,
1612 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001613{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001614 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001615 int ret = OK;
1616 int cc;
1617
1618 if (lp->ll_tv == NULL)
1619 {
1620 cc = *name_end;
1621 *name_end = NUL;
1622
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001623 // Environment variable, normal name or expanded name.
1624 if (*lp->ll_name == '$')
1625 vim_unsetenv(lp->ll_name + 1);
1626 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001627 ret = FAIL;
1628 *name_end = cc;
1629 }
1630 else if ((lp->ll_list != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001631 && value_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001632 || (lp->ll_dict != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001633 && value_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001634 return FAIL;
1635 else if (lp->ll_range)
1636 {
1637 listitem_T *li;
1638 listitem_T *ll_li = lp->ll_li;
1639 int ll_n1 = lp->ll_n1;
1640
1641 while (ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= ll_n1))
1642 {
1643 li = ll_li->li_next;
Bram Moolenaara187c432020-09-16 21:08:28 +02001644 if (value_check_lock(ll_li->li_tv.v_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001645 return FAIL;
1646 ll_li = li;
1647 ++ll_n1;
1648 }
1649
1650 // Delete a range of List items.
1651 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
1652 {
1653 li = lp->ll_li->li_next;
1654 listitem_remove(lp->ll_list, lp->ll_li);
1655 lp->ll_li = li;
1656 ++lp->ll_n1;
1657 }
1658 }
1659 else
1660 {
1661 if (lp->ll_list != NULL)
1662 // unlet a List item.
1663 listitem_remove(lp->ll_list, lp->ll_li);
1664 else
1665 // unlet a Dictionary item.
1666 dictitem_remove(lp->ll_dict, lp->ll_di);
1667 }
1668
1669 return ret;
1670}
1671
1672/*
1673 * "unlet" a variable. Return OK if it existed, FAIL if not.
1674 * When "forceit" is TRUE don't complain if the variable doesn't exist.
1675 */
1676 int
1677do_unlet(char_u *name, int forceit)
1678{
1679 hashtab_T *ht;
1680 hashitem_T *hi;
1681 char_u *varname;
1682 dict_T *d;
1683 dictitem_T *di;
1684
Bram Moolenaar9aed7292020-12-18 15:38:00 +01001685 // can't :unlet a script variable in Vim9 script
Bram Moolenaareb6880b2020-07-12 17:07:05 +02001686 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001687 return FAIL;
1688
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001689 ht = find_var_ht(name, &varname);
Bram Moolenaar9aed7292020-12-18 15:38:00 +01001690
1691 // can't :unlet a script variable in Vim9 script from a function
1692 if (ht == get_script_local_ht()
1693 && SCRIPT_ID_VALID(current_sctx.sc_sid)
1694 && SCRIPT_ITEM(current_sctx.sc_sid)->sn_version
1695 == SCRIPT_VERSION_VIM9
1696 && check_vim9_unlet(name) == FAIL)
1697 return FAIL;
1698
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001699 if (ht != NULL && *varname != NUL)
1700 {
1701 d = get_current_funccal_dict(ht);
1702 if (d == NULL)
1703 {
1704 if (ht == &globvarht)
1705 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001706 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001707 d = &vimvardict;
1708 else
1709 {
1710 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
1711 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
1712 }
1713 if (d == NULL)
1714 {
1715 internal_error("do_unlet()");
1716 return FAIL;
1717 }
1718 }
1719 hi = hash_find(ht, varname);
1720 if (HASHITEM_EMPTY(hi))
1721 hi = find_hi_in_scoped_ht(name, &ht);
1722 if (hi != NULL && !HASHITEM_EMPTY(hi))
1723 {
1724 di = HI2DI(hi);
1725 if (var_check_fixed(di->di_flags, name, FALSE)
1726 || var_check_ro(di->di_flags, name, FALSE)
Bram Moolenaara187c432020-09-16 21:08:28 +02001727 || value_check_lock(d->dv_lock, name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001728 return FAIL;
1729
1730 delete_var(ht, hi);
1731 return OK;
1732 }
1733 }
1734 if (forceit)
1735 return OK;
1736 semsg(_("E108: No such variable: \"%s\""), name);
1737 return FAIL;
1738}
1739
1740/*
1741 * Lock or unlock variable indicated by "lp".
1742 * "deep" is the levels to go (-1 for unlimited);
1743 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
1744 */
1745 static int
1746do_lock_var(
1747 lval_T *lp,
1748 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001749 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001750 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001751 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001752{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001753 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001754 int ret = OK;
1755 int cc;
1756 dictitem_T *di;
1757
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001758 if (lp->ll_tv == NULL)
1759 {
1760 cc = *name_end;
1761 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001762 if (*lp->ll_name == '$')
1763 {
1764 semsg(_(e_lock_unlock), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001765 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001766 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001767 else
1768 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001769 // Normal name or expanded name.
1770 di = find_var(lp->ll_name, NULL, TRUE);
1771 if (di == NULL)
1772 ret = FAIL;
1773 else if ((di->di_flags & DI_FLAGS_FIX)
1774 && di->di_tv.v_type != VAR_DICT
1775 && di->di_tv.v_type != VAR_LIST)
1776 {
1777 // For historic reasons this error is not given for a list or
1778 // dict. E.g., the b: dict could be locked/unlocked.
1779 semsg(_(e_lock_unlock), lp->ll_name);
1780 ret = FAIL;
1781 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001782 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001783 {
1784 if (lock)
1785 di->di_flags |= DI_FLAGS_LOCK;
1786 else
1787 di->di_flags &= ~DI_FLAGS_LOCK;
Bram Moolenaara187c432020-09-16 21:08:28 +02001788 if (deep != 0)
1789 item_lock(&di->di_tv, deep, lock, FALSE);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001790 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001791 }
1792 *name_end = cc;
1793 }
Bram Moolenaara187c432020-09-16 21:08:28 +02001794 else if (deep == 0)
1795 {
1796 // nothing to do
1797 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001798 else if (lp->ll_range)
1799 {
1800 listitem_T *li = lp->ll_li;
1801
1802 // (un)lock a range of List items.
1803 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
1804 {
Bram Moolenaar021bda52020-08-17 21:07:22 +02001805 item_lock(&li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001806 li = li->li_next;
1807 ++lp->ll_n1;
1808 }
1809 }
1810 else if (lp->ll_list != NULL)
1811 // (un)lock a List item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001812 item_lock(&lp->ll_li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001813 else
1814 // (un)lock a Dictionary item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001815 item_lock(&lp->ll_di->di_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001816
1817 return ret;
1818}
1819
1820/*
1821 * Lock or unlock an item. "deep" is nr of levels to go.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001822 * When "check_refcount" is TRUE do not lock a list or dict with a reference
1823 * count larger than 1.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001824 */
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02001825 void
Bram Moolenaar021bda52020-08-17 21:07:22 +02001826item_lock(typval_T *tv, int deep, int lock, int check_refcount)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001827{
1828 static int recurse = 0;
1829 list_T *l;
1830 listitem_T *li;
1831 dict_T *d;
1832 blob_T *b;
1833 hashitem_T *hi;
1834 int todo;
1835
1836 if (recurse >= DICT_MAXNEST)
1837 {
1838 emsg(_("E743: variable nested too deep for (un)lock"));
1839 return;
1840 }
1841 if (deep == 0)
1842 return;
1843 ++recurse;
1844
1845 // lock/unlock the item itself
1846 if (lock)
1847 tv->v_lock |= VAR_LOCKED;
1848 else
1849 tv->v_lock &= ~VAR_LOCKED;
1850
1851 switch (tv->v_type)
1852 {
1853 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02001854 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001855 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001856 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001857 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001858 case VAR_STRING:
1859 case VAR_FUNC:
1860 case VAR_PARTIAL:
1861 case VAR_FLOAT:
1862 case VAR_SPECIAL:
1863 case VAR_JOB:
1864 case VAR_CHANNEL:
1865 break;
1866
1867 case VAR_BLOB:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001868 if ((b = tv->vval.v_blob) != NULL
1869 && !(check_refcount && b->bv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001870 {
1871 if (lock)
1872 b->bv_lock |= VAR_LOCKED;
1873 else
1874 b->bv_lock &= ~VAR_LOCKED;
1875 }
1876 break;
1877 case VAR_LIST:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001878 if ((l = tv->vval.v_list) != NULL
1879 && !(check_refcount && l->lv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001880 {
1881 if (lock)
1882 l->lv_lock |= VAR_LOCKED;
1883 else
1884 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001885 if ((deep < 0 || deep > 1) && l->lv_first != &range_list_item)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001886 // recursive: lock/unlock the items the List contains
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001887 FOR_ALL_LIST_ITEMS(l, li)
Bram Moolenaar021bda52020-08-17 21:07:22 +02001888 item_lock(&li->li_tv, deep - 1, lock, check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001889 }
1890 break;
1891 case VAR_DICT:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001892 if ((d = tv->vval.v_dict) != NULL
1893 && !(check_refcount && d->dv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001894 {
1895 if (lock)
1896 d->dv_lock |= VAR_LOCKED;
1897 else
1898 d->dv_lock &= ~VAR_LOCKED;
1899 if (deep < 0 || deep > 1)
1900 {
1901 // recursive: lock/unlock the items the List contains
1902 todo = (int)d->dv_hashtab.ht_used;
1903 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
1904 {
1905 if (!HASHITEM_EMPTY(hi))
1906 {
1907 --todo;
Bram Moolenaar021bda52020-08-17 21:07:22 +02001908 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock,
1909 check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001910 }
1911 }
1912 }
1913 }
1914 }
1915 --recurse;
1916}
1917
Bram Moolenaarda6c0332019-09-01 16:01:30 +02001918#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
1919/*
1920 * Delete all "menutrans_" variables.
1921 */
1922 void
1923del_menutrans_vars(void)
1924{
1925 hashitem_T *hi;
1926 int todo;
1927
1928 hash_lock(&globvarht);
1929 todo = (int)globvarht.ht_used;
1930 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
1931 {
1932 if (!HASHITEM_EMPTY(hi))
1933 {
1934 --todo;
1935 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
1936 delete_var(&globvarht, hi);
1937 }
1938 }
1939 hash_unlock(&globvarht);
1940}
1941#endif
1942
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001943/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001944 * Local string buffer for the next two functions to store a variable name
1945 * with its prefix. Allocated in cat_prefix_varname(), freed later in
1946 * get_user_var_name().
1947 */
1948
1949static char_u *varnamebuf = NULL;
1950static int varnamebuflen = 0;
1951
1952/*
1953 * Function to concatenate a prefix and a variable name.
1954 */
1955 static char_u *
1956cat_prefix_varname(int prefix, char_u *name)
1957{
1958 int len;
1959
1960 len = (int)STRLEN(name) + 3;
1961 if (len > varnamebuflen)
1962 {
1963 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02001964 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001965 varnamebuf = alloc(len);
1966 if (varnamebuf == NULL)
1967 {
1968 varnamebuflen = 0;
1969 return NULL;
1970 }
1971 varnamebuflen = len;
1972 }
1973 *varnamebuf = prefix;
1974 varnamebuf[1] = ':';
1975 STRCPY(varnamebuf + 2, name);
1976 return varnamebuf;
1977}
1978
1979/*
1980 * Function given to ExpandGeneric() to obtain the list of user defined
1981 * (global/buffer/window/built-in) variable names.
1982 */
1983 char_u *
1984get_user_var_name(expand_T *xp, int idx)
1985{
1986 static long_u gdone;
1987 static long_u bdone;
1988 static long_u wdone;
1989 static long_u tdone;
1990 static int vidx;
1991 static hashitem_T *hi;
1992 hashtab_T *ht;
1993
1994 if (idx == 0)
1995 {
1996 gdone = bdone = wdone = vidx = 0;
1997 tdone = 0;
1998 }
1999
2000 // Global variables
2001 if (gdone < globvarht.ht_used)
2002 {
2003 if (gdone++ == 0)
2004 hi = globvarht.ht_array;
2005 else
2006 ++hi;
2007 while (HASHITEM_EMPTY(hi))
2008 ++hi;
2009 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
2010 return cat_prefix_varname('g', hi->hi_key);
2011 return hi->hi_key;
2012 }
2013
2014 // b: variables
Bram Moolenaar4ff2f2f2020-10-25 13:22:42 +01002015 ht =
2016#ifdef FEAT_CMDWIN
2017 // In cmdwin, the alternative buffer should be used.
2018 (cmdwin_type != 0 && get_cmdline_type() == NUL) ?
2019 &prevwin->w_buffer->b_vars->dv_hashtab :
2020#endif
2021 &curbuf->b_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002022 if (bdone < ht->ht_used)
2023 {
2024 if (bdone++ == 0)
2025 hi = ht->ht_array;
2026 else
2027 ++hi;
2028 while (HASHITEM_EMPTY(hi))
2029 ++hi;
2030 return cat_prefix_varname('b', hi->hi_key);
2031 }
2032
2033 // w: variables
Bram Moolenaar4ff2f2f2020-10-25 13:22:42 +01002034 ht =
2035#ifdef FEAT_CMDWIN
2036 // In cmdwin, the alternative window should be used.
2037 (cmdwin_type != 0 && get_cmdline_type() == NUL) ?
2038 &prevwin->w_vars->dv_hashtab :
2039#endif
2040 &curwin->w_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002041 if (wdone < ht->ht_used)
2042 {
2043 if (wdone++ == 0)
2044 hi = ht->ht_array;
2045 else
2046 ++hi;
2047 while (HASHITEM_EMPTY(hi))
2048 ++hi;
2049 return cat_prefix_varname('w', hi->hi_key);
2050 }
2051
2052 // t: variables
2053 ht = &curtab->tp_vars->dv_hashtab;
2054 if (tdone < ht->ht_used)
2055 {
2056 if (tdone++ == 0)
2057 hi = ht->ht_array;
2058 else
2059 ++hi;
2060 while (HASHITEM_EMPTY(hi))
2061 ++hi;
2062 return cat_prefix_varname('t', hi->hi_key);
2063 }
2064
2065 // v: variables
2066 if (vidx < VV_LEN)
2067 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
2068
2069 VIM_CLEAR(varnamebuf);
2070 varnamebuflen = 0;
2071 return NULL;
2072}
2073
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002074 char *
2075get_var_special_name(int nr)
2076{
2077 switch (nr)
2078 {
Bram Moolenaara8b8af12021-01-01 15:11:04 +01002079 case VVAL_FALSE: return in_vim9script() ? "false" : "v:false";
2080 case VVAL_TRUE: return in_vim9script() ? "true" : "v:true";
Bram Moolenaar67977822021-01-03 21:53:53 +01002081 case VVAL_NULL: return in_vim9script() ? "null" : "v:null";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002082 case VVAL_NONE: return "v:none";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002083 }
2084 internal_error("get_var_special_name()");
2085 return "42";
2086}
2087
2088/*
2089 * Returns the global variable dictionary
2090 */
2091 dict_T *
2092get_globvar_dict(void)
2093{
2094 return &globvardict;
2095}
2096
2097/*
2098 * Returns the global variable hash table
2099 */
2100 hashtab_T *
2101get_globvar_ht(void)
2102{
2103 return &globvarht;
2104}
2105
2106/*
2107 * Returns the v: variable dictionary
2108 */
2109 dict_T *
2110get_vimvar_dict(void)
2111{
2112 return &vimvardict;
2113}
2114
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002115/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002116 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002117 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002118 */
2119 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002120find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002121{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002122 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2123 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002124
2125 if (di == NULL)
2126 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002127 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002128 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2129 return (int)(vv - vimvars);
2130}
2131
2132
2133/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002134 * Set type of v: variable to "type".
2135 */
2136 void
2137set_vim_var_type(int idx, vartype_T type)
2138{
2139 vimvars[idx].vv_type = type;
2140}
2141
2142/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002143 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002144 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002145 */
2146 void
2147set_vim_var_nr(int idx, varnumber_T val)
2148{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002149 vimvars[idx].vv_nr = val;
2150}
2151
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002152 char *
2153get_vim_var_name(int idx)
2154{
2155 return vimvars[idx].vv_name;
2156}
2157
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002158/*
2159 * Get typval_T v: variable value.
2160 */
2161 typval_T *
2162get_vim_var_tv(int idx)
2163{
2164 return &vimvars[idx].vv_tv;
2165}
2166
2167/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002168 * Set v: variable to "tv". Only accepts the same type.
2169 * Takes over the value of "tv".
2170 */
2171 int
2172set_vim_var_tv(int idx, typval_T *tv)
2173{
2174 if (vimvars[idx].vv_type != tv->v_type)
2175 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002176 emsg(_(e_type_mismatch_for_v_variable));
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002177 clear_tv(tv);
2178 return FAIL;
2179 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002180 // VV_RO is also checked when compiling, but let's check here as well.
2181 if (vimvars[idx].vv_flags & VV_RO)
2182 {
2183 semsg(_(e_readonlyvar), vimvars[idx].vv_name);
2184 return FAIL;
2185 }
2186 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2187 {
2188 semsg(_(e_readonlysbx), vimvars[idx].vv_name);
2189 return FAIL;
2190 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002191 clear_tv(&vimvars[idx].vv_di.di_tv);
2192 vimvars[idx].vv_di.di_tv = *tv;
2193 return OK;
2194}
2195
2196/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002197 * Get number v: variable value.
2198 */
2199 varnumber_T
2200get_vim_var_nr(int idx)
2201{
2202 return vimvars[idx].vv_nr;
2203}
2204
2205/*
2206 * Get string v: variable value. Uses a static buffer, can only be used once.
2207 * If the String variable has never been set, return an empty string.
2208 * Never returns NULL;
2209 */
2210 char_u *
2211get_vim_var_str(int idx)
2212{
2213 return tv_get_string(&vimvars[idx].vv_tv);
2214}
2215
2216/*
2217 * Get List v: variable value. Caller must take care of reference count when
2218 * needed.
2219 */
2220 list_T *
2221get_vim_var_list(int idx)
2222{
2223 return vimvars[idx].vv_list;
2224}
2225
2226/*
2227 * Get Dict v: variable value. Caller must take care of reference count when
2228 * needed.
2229 */
2230 dict_T *
2231get_vim_var_dict(int idx)
2232{
2233 return vimvars[idx].vv_dict;
2234}
2235
2236/*
2237 * Set v:char to character "c".
2238 */
2239 void
2240set_vim_var_char(int c)
2241{
2242 char_u buf[MB_MAXBYTES + 1];
2243
2244 if (has_mbyte)
2245 buf[(*mb_char2bytes)(c, buf)] = NUL;
2246 else
2247 {
2248 buf[0] = c;
2249 buf[1] = NUL;
2250 }
2251 set_vim_var_string(VV_CHAR, buf, -1);
2252}
2253
2254/*
2255 * Set v:count to "count" and v:count1 to "count1".
2256 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2257 */
2258 void
2259set_vcount(
2260 long count,
2261 long count1,
2262 int set_prevcount)
2263{
2264 if (set_prevcount)
2265 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2266 vimvars[VV_COUNT].vv_nr = count;
2267 vimvars[VV_COUNT1].vv_nr = count1;
2268}
2269
2270/*
2271 * Save variables that might be changed as a side effect. Used when executing
2272 * a timer callback.
2273 */
2274 void
2275save_vimvars(vimvars_save_T *vvsave)
2276{
2277 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2278 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2279 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2280}
2281
2282/*
2283 * Restore variables saved by save_vimvars().
2284 */
2285 void
2286restore_vimvars(vimvars_save_T *vvsave)
2287{
2288 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2289 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2290 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2291}
2292
2293/*
2294 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2295 * value.
2296 */
2297 void
2298set_vim_var_string(
2299 int idx,
2300 char_u *val,
2301 int len) // length of "val" to use or -1 (whole string)
2302{
2303 clear_tv(&vimvars[idx].vv_di.di_tv);
2304 vimvars[idx].vv_type = VAR_STRING;
2305 if (val == NULL)
2306 vimvars[idx].vv_str = NULL;
2307 else if (len == -1)
2308 vimvars[idx].vv_str = vim_strsave(val);
2309 else
2310 vimvars[idx].vv_str = vim_strnsave(val, len);
2311}
2312
2313/*
2314 * Set List v: variable to "val".
2315 */
2316 void
2317set_vim_var_list(int idx, list_T *val)
2318{
2319 clear_tv(&vimvars[idx].vv_di.di_tv);
2320 vimvars[idx].vv_type = VAR_LIST;
2321 vimvars[idx].vv_list = val;
2322 if (val != NULL)
2323 ++val->lv_refcount;
2324}
2325
2326/*
2327 * Set Dictionary v: variable to "val".
2328 */
2329 void
2330set_vim_var_dict(int idx, dict_T *val)
2331{
2332 clear_tv(&vimvars[idx].vv_di.di_tv);
2333 vimvars[idx].vv_type = VAR_DICT;
2334 vimvars[idx].vv_dict = val;
2335 if (val != NULL)
2336 {
2337 ++val->dv_refcount;
2338 dict_set_items_ro(val);
2339 }
2340}
2341
2342/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002343 * Set the v:argv list.
2344 */
2345 void
2346set_argv_var(char **argv, int argc)
2347{
2348 list_T *l = list_alloc();
2349 int i;
2350
2351 if (l == NULL)
2352 getout(1);
2353 l->lv_lock = VAR_FIXED;
2354 for (i = 0; i < argc; ++i)
2355 {
2356 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2357 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002358 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002359 }
2360 set_vim_var_list(VV_ARGV, l);
2361}
2362
2363/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002364 * Reset v:register, taking the 'clipboard' setting into account.
2365 */
2366 void
2367reset_reg_var(void)
2368{
2369 int regname = 0;
2370
2371 // Adjust the register according to 'clipboard', so that when
2372 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2373#ifdef FEAT_CLIPBOARD
2374 adjust_clip_reg(&regname);
2375#endif
2376 set_reg_var(regname);
2377}
2378
2379/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002380 * Set v:register if needed.
2381 */
2382 void
2383set_reg_var(int c)
2384{
2385 char_u regname;
2386
2387 if (c == 0 || c == ' ')
2388 regname = '"';
2389 else
2390 regname = c;
2391 // Avoid free/alloc when the value is already right.
2392 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2393 set_vim_var_string(VV_REG, &regname, 1);
2394}
2395
2396/*
2397 * Get or set v:exception. If "oldval" == NULL, return the current value.
2398 * Otherwise, restore the value to "oldval" and return NULL.
2399 * Must always be called in pairs to save and restore v:exception! Does not
2400 * take care of memory allocations.
2401 */
2402 char_u *
2403v_exception(char_u *oldval)
2404{
2405 if (oldval == NULL)
2406 return vimvars[VV_EXCEPTION].vv_str;
2407
2408 vimvars[VV_EXCEPTION].vv_str = oldval;
2409 return NULL;
2410}
2411
2412/*
2413 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2414 * Otherwise, restore the value to "oldval" and return NULL.
2415 * Must always be called in pairs to save and restore v:throwpoint! Does not
2416 * take care of memory allocations.
2417 */
2418 char_u *
2419v_throwpoint(char_u *oldval)
2420{
2421 if (oldval == NULL)
2422 return vimvars[VV_THROWPOINT].vv_str;
2423
2424 vimvars[VV_THROWPOINT].vv_str = oldval;
2425 return NULL;
2426}
2427
2428/*
2429 * Set v:cmdarg.
2430 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2431 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2432 * Must always be called in pairs!
2433 */
2434 char_u *
2435set_cmdarg(exarg_T *eap, char_u *oldarg)
2436{
2437 char_u *oldval;
2438 char_u *newval;
2439 unsigned len;
2440
2441 oldval = vimvars[VV_CMDARG].vv_str;
2442 if (eap == NULL)
2443 {
2444 vim_free(oldval);
2445 vimvars[VV_CMDARG].vv_str = oldarg;
2446 return NULL;
2447 }
2448
2449 if (eap->force_bin == FORCE_BIN)
2450 len = 6;
2451 else if (eap->force_bin == FORCE_NOBIN)
2452 len = 8;
2453 else
2454 len = 0;
2455
2456 if (eap->read_edit)
2457 len += 7;
2458
2459 if (eap->force_ff != 0)
2460 len += 10; // " ++ff=unix"
2461 if (eap->force_enc != 0)
2462 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2463 if (eap->bad_char != 0)
2464 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2465
2466 newval = alloc(len + 1);
2467 if (newval == NULL)
2468 return NULL;
2469
2470 if (eap->force_bin == FORCE_BIN)
2471 sprintf((char *)newval, " ++bin");
2472 else if (eap->force_bin == FORCE_NOBIN)
2473 sprintf((char *)newval, " ++nobin");
2474 else
2475 *newval = NUL;
2476
2477 if (eap->read_edit)
2478 STRCAT(newval, " ++edit");
2479
2480 if (eap->force_ff != 0)
2481 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2482 eap->force_ff == 'u' ? "unix"
2483 : eap->force_ff == 'd' ? "dos"
2484 : "mac");
2485 if (eap->force_enc != 0)
2486 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2487 eap->cmd + eap->force_enc);
2488 if (eap->bad_char == BAD_KEEP)
2489 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2490 else if (eap->bad_char == BAD_DROP)
2491 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2492 else if (eap->bad_char != 0)
2493 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2494 vimvars[VV_CMDARG].vv_str = newval;
2495 return oldval;
2496}
2497
2498/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002499 * Get the value of internal variable "name".
2500 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2501 */
2502 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002503eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002504 char_u *name,
2505 int len, // length of "name"
2506 typval_T *rettv, // NULL when only checking existence
2507 dictitem_T **dip, // non-NULL when typval's dict item is needed
2508 int verbose, // may give error message
2509 int no_autoload) // do not use script autoloading
2510{
2511 int ret = OK;
2512 typval_T *tv = NULL;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002513 int foundFunc = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002514 dictitem_T *v;
2515 int cc;
2516
2517 // truncate the name, so that we can use strcmp()
2518 cc = name[len];
2519 name[len] = NUL;
2520
2521 // Check for user-defined variables.
2522 v = find_var(name, NULL, no_autoload);
2523 if (v != NULL)
2524 {
2525 tv = &v->di_tv;
2526 if (dip != NULL)
2527 *dip = v;
2528 }
2529
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002530 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002531 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002532 imported_T *import;
2533 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
2534
2535 import = find_imported(p, 0, NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002536
2537 // imported variable from another script
2538 if (import != NULL)
2539 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002540 if (import->imp_funcname != NULL)
2541 {
2542 foundFunc = TRUE;
2543 if (rettv != NULL)
2544 {
2545 rettv->v_type = VAR_FUNC;
2546 rettv->vval.v_string = vim_strsave(import->imp_funcname);
2547 }
2548 }
Bram Moolenaara6294952020-12-27 13:39:50 +01002549 else if (import->imp_flags & IMP_FLAGS_STAR)
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002550 {
2551 emsg("Sorry, 'import * as X' not implemented yet");
2552 ret = FAIL;
2553 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002554 else
2555 {
2556 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02002557 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002558 + import->imp_var_vals_idx;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002559 tv = sv->sv_tv;
2560 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002561 }
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002562 else if (in_vim9script())
2563 {
2564 ufunc_T *ufunc = find_func(name, FALSE, NULL);
2565
2566 if (ufunc != NULL)
2567 {
2568 foundFunc = TRUE;
2569 if (rettv != NULL)
2570 {
2571 rettv->v_type = VAR_FUNC;
2572 rettv->vval.v_string = vim_strsave(ufunc->uf_name);
2573 }
2574 }
2575 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002576 }
2577
Bram Moolenaarc620c052020-07-08 15:16:19 +02002578 if (!foundFunc)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002579 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002580 if (tv == NULL)
2581 {
2582 if (rettv != NULL && verbose)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002583 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarc620c052020-07-08 15:16:19 +02002584 ret = FAIL;
2585 }
2586 else if (rettv != NULL)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002587 {
2588 // If a list or dict variable wasn't initialized, do it now.
2589 if (tv->v_type == VAR_DICT && tv->vval.v_dict == NULL)
2590 {
2591 tv->vval.v_dict = dict_alloc();
2592 if (tv->vval.v_dict != NULL)
2593 ++tv->vval.v_dict->dv_refcount;
2594 }
2595 else if (tv->v_type == VAR_LIST && tv->vval.v_list == NULL)
2596 {
2597 tv->vval.v_list = list_alloc();
2598 if (tv->vval.v_list != NULL)
2599 ++tv->vval.v_list->lv_refcount;
2600 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002601 copy_tv(tv, rettv);
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002602 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002603 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002604
2605 name[len] = cc;
2606
2607 return ret;
2608}
2609
2610/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002611 * Check if variable "name[len]" is a local variable or an argument.
2612 * If so, "*eval_lavars_used" is set to TRUE.
2613 */
2614 void
2615check_vars(char_u *name, int len)
2616{
2617 int cc;
2618 char_u *varname;
2619 hashtab_T *ht;
2620
2621 if (eval_lavars_used == NULL)
2622 return;
2623
2624 // truncate the name, so that we can use strcmp()
2625 cc = name[len];
2626 name[len] = NUL;
2627
2628 ht = find_var_ht(name, &varname);
2629 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
2630 {
2631 if (find_var(name, NULL, TRUE) != NULL)
2632 *eval_lavars_used = TRUE;
2633 }
2634
2635 name[len] = cc;
2636}
2637
2638/*
2639 * Find variable "name" in the list of variables.
2640 * Return a pointer to it if found, NULL if not found.
2641 * Careful: "a:0" variables don't have a name.
2642 * When "htp" is not NULL we are writing to the variable, set "htp" to the
2643 * hashtab_T used.
2644 */
2645 dictitem_T *
2646find_var(char_u *name, hashtab_T **htp, int no_autoload)
2647{
2648 char_u *varname;
2649 hashtab_T *ht;
2650 dictitem_T *ret = NULL;
2651
2652 ht = find_var_ht(name, &varname);
2653 if (htp != NULL)
2654 *htp = ht;
2655 if (ht == NULL)
2656 return NULL;
2657 ret = find_var_in_ht(ht, *name, varname, no_autoload || htp != NULL);
2658 if (ret != NULL)
2659 return ret;
2660
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002661 // Search in parent scope for lambda
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01002662 ret = find_var_in_scoped_ht(name, no_autoload || htp != NULL);
2663 if (ret != NULL)
2664 return ret;
2665
2666 // in Vim9 script items without a scope can be script-local
2667 if (in_vim9script() && name[0] != NUL && name[1] != ':')
2668 {
2669 ht = get_script_local_ht();
2670 if (ht != NULL)
2671 {
2672 ret = find_var_in_ht(ht, *name, varname,
2673 no_autoload || htp != NULL);
2674 if (ret != NULL)
2675 {
2676 if (htp != NULL)
2677 *htp = ht;
2678 return ret;
2679 }
2680 }
2681 }
2682
2683 return NULL;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002684}
2685
2686/*
2687 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02002688 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002689 * Returns NULL if not found.
2690 */
2691 dictitem_T *
2692find_var_in_ht(
2693 hashtab_T *ht,
2694 int htname,
2695 char_u *varname,
2696 int no_autoload)
2697{
2698 hashitem_T *hi;
2699
2700 if (*varname == NUL)
2701 {
2702 // Must be something like "s:", otherwise "ht" would be NULL.
2703 switch (htname)
2704 {
2705 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
2706 case 'g': return &globvars_var;
2707 case 'v': return &vimvars_var;
2708 case 'b': return &curbuf->b_bufvar;
2709 case 'w': return &curwin->w_winvar;
2710 case 't': return &curtab->tp_winvar;
2711 case 'l': return get_funccal_local_var();
2712 case 'a': return get_funccal_args_var();
2713 }
2714 return NULL;
2715 }
2716
2717 hi = hash_find(ht, varname);
2718 if (HASHITEM_EMPTY(hi))
2719 {
2720 // For global variables we may try auto-loading the script. If it
2721 // worked find the variable again. Don't auto-load a script if it was
2722 // loaded already, otherwise it would be loaded every time when
2723 // checking if a function name is a Funcref variable.
2724 if (ht == &globvarht && !no_autoload)
2725 {
2726 // Note: script_autoload() may make "hi" invalid. It must either
2727 // be obtained again or not used.
2728 if (!script_autoload(varname, FALSE) || aborting())
2729 return NULL;
2730 hi = hash_find(ht, varname);
2731 }
2732 if (HASHITEM_EMPTY(hi))
2733 return NULL;
2734 }
2735 return HI2DI(hi);
2736}
2737
2738/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002739 * Get the script-local hashtab. NULL if not in a script context.
2740 */
Bram Moolenaar922acbd2020-10-08 21:30:40 +02002741 hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002742get_script_local_ht(void)
2743{
2744 scid_T sid = current_sctx.sc_sid;
2745
Bram Moolenaare3d46852020-08-29 13:39:17 +02002746 if (SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002747 return &SCRIPT_VARS(sid);
2748 return NULL;
2749}
2750
2751/*
2752 * Look for "name[len]" in script-local variables.
Bram Moolenaar709664c2020-12-12 14:33:41 +01002753 * Return OK when found, FAIL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002754 */
Bram Moolenaar709664c2020-12-12 14:33:41 +01002755 int
2756lookup_scriptvar(
2757 char_u *name,
2758 size_t len,
2759 void *lvar UNUSED,
2760 cctx_T *dummy UNUSED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002761{
2762 hashtab_T *ht = get_script_local_ht();
2763 char_u buffer[30];
2764 char_u *p;
Bram Moolenaar709664c2020-12-12 14:33:41 +01002765 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002766 hashitem_T *hi;
2767
2768 if (ht == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01002769 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002770 if (len < sizeof(buffer) - 1)
2771 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02002772 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002773 vim_strncpy(buffer, name, len);
2774 p = buffer;
2775 }
2776 else
2777 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002778 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002779 if (p == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01002780 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002781 }
2782
2783 hi = hash_find(ht, p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01002784 res = HASHITEM_EMPTY(hi) ? FAIL : OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002785
2786 // if not script-local, then perhaps imported
Bram Moolenaar709664c2020-12-12 14:33:41 +01002787 if (res == FAIL && find_imported(p, 0, NULL) != NULL)
2788 res = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002789
2790 if (p != buffer)
2791 vim_free(p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01002792 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002793}
2794
2795/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002796 * Find the hashtab used for a variable name.
2797 * Return NULL if the name is not valid.
2798 * Set "varname" to the start of name without ':'.
2799 */
2800 hashtab_T *
2801find_var_ht(char_u *name, char_u **varname)
2802{
2803 hashitem_T *hi;
2804 hashtab_T *ht;
2805
2806 if (name[0] == NUL)
2807 return NULL;
2808 if (name[1] != ':')
2809 {
2810 // The name must not start with a colon or #.
2811 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
2812 return NULL;
2813 *varname = name;
2814
2815 // "version" is "v:version" in all scopes if scriptversion < 3.
2816 // Same for a few other variables marked with VV_COMPAT.
2817 if (current_sctx.sc_version < 3)
2818 {
2819 hi = hash_find(&compat_hashtab, name);
2820 if (!HASHITEM_EMPTY(hi))
2821 return &compat_hashtab;
2822 }
2823
2824 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002825 if (ht != NULL)
2826 return ht; // local variable
2827
2828 // in Vim9 script items at the script level are script-local
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002829 if (in_vim9script())
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002830 {
2831 ht = get_script_local_ht();
2832 if (ht != NULL)
2833 return ht;
2834 }
2835
2836 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002837 }
2838 *varname = name + 2;
2839 if (*name == 'g') // global variable
2840 return &globvarht;
2841 // There must be no ':' or '#' in the rest of the name, unless g: is used
2842 if (vim_strchr(name + 2, ':') != NULL
2843 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
2844 return NULL;
2845 if (*name == 'b') // buffer variable
2846 return &curbuf->b_vars->dv_hashtab;
2847 if (*name == 'w') // window variable
2848 return &curwin->w_vars->dv_hashtab;
2849 if (*name == 't') // tab page variable
2850 return &curtab->tp_vars->dv_hashtab;
2851 if (*name == 'v') // v: variable
2852 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002853 if (get_current_funccal() != NULL
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002854 && get_current_funccal()->func->uf_def_status == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002855 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002856 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002857 if (*name == 'a') // a: function argument
2858 return get_funccal_args_ht();
2859 if (*name == 'l') // l: local function variable
2860 return get_funccal_local_ht();
2861 }
2862 if (*name == 's') // script variable
2863 {
2864 ht = get_script_local_ht();
2865 if (ht != NULL)
2866 return ht;
2867 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002868 return NULL;
2869}
2870
2871/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002872 * Get the string value of a (global/local) variable.
2873 * Note: see tv_get_string() for how long the pointer remains valid.
2874 * Returns NULL when it doesn't exist.
2875 */
2876 char_u *
2877get_var_value(char_u *name)
2878{
2879 dictitem_T *v;
2880
2881 v = find_var(name, NULL, FALSE);
2882 if (v == NULL)
2883 return NULL;
2884 return tv_get_string(&v->di_tv);
2885}
2886
2887/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002888 * Allocate a new hashtab for a sourced script. It will be used while
2889 * sourcing this script and when executing functions defined in the script.
2890 */
2891 void
2892new_script_vars(scid_T id)
2893{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002894 scriptvar_T *sv;
2895
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01002896 sv = ALLOC_CLEAR_ONE(scriptvar_T);
2897 if (sv == NULL)
2898 return;
2899 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01002900 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002901}
2902
2903/*
2904 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
2905 * point to it.
2906 */
2907 void
2908init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
2909{
2910 hash_init(&dict->dv_hashtab);
2911 dict->dv_lock = 0;
2912 dict->dv_scope = scope;
2913 dict->dv_refcount = DO_NOT_FREE_CNT;
2914 dict->dv_copyID = 0;
2915 dict_var->di_tv.vval.v_dict = dict;
2916 dict_var->di_tv.v_type = VAR_DICT;
2917 dict_var->di_tv.v_lock = VAR_FIXED;
2918 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2919 dict_var->di_key[0] = NUL;
2920}
2921
2922/*
2923 * Unreference a dictionary initialized by init_var_dict().
2924 */
2925 void
2926unref_var_dict(dict_T *dict)
2927{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002928 // Now the dict needs to be freed if no one else is using it, go back to
2929 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002930 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
2931 dict_unref(dict);
2932}
2933
2934/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002935 * Clean up a list of internal variables.
2936 * Frees all allocated variables and the value they contain.
2937 * Clears hashtab "ht", does not free it.
2938 */
2939 void
2940vars_clear(hashtab_T *ht)
2941{
2942 vars_clear_ext(ht, TRUE);
2943}
2944
2945/*
2946 * Like vars_clear(), but only free the value if "free_val" is TRUE.
2947 */
2948 void
2949vars_clear_ext(hashtab_T *ht, int free_val)
2950{
2951 int todo;
2952 hashitem_T *hi;
2953 dictitem_T *v;
2954
2955 hash_lock(ht);
2956 todo = (int)ht->ht_used;
2957 for (hi = ht->ht_array; todo > 0; ++hi)
2958 {
2959 if (!HASHITEM_EMPTY(hi))
2960 {
2961 --todo;
2962
2963 // Free the variable. Don't remove it from the hashtab,
2964 // ht_array might change then. hash_clear() takes care of it
2965 // later.
2966 v = HI2DI(hi);
2967 if (free_val)
2968 clear_tv(&v->di_tv);
2969 if (v->di_flags & DI_FLAGS_ALLOC)
2970 vim_free(v);
2971 }
2972 }
2973 hash_clear(ht);
Bram Moolenaar8d739de2020-10-14 19:39:19 +02002974 hash_init(ht);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002975}
2976
2977/*
2978 * Delete a variable from hashtab "ht" at item "hi".
2979 * Clear the variable value and free the dictitem.
2980 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002981 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002982delete_var(hashtab_T *ht, hashitem_T *hi)
2983{
2984 dictitem_T *di = HI2DI(hi);
2985
2986 hash_remove(ht, hi);
2987 clear_tv(&di->di_tv);
2988 vim_free(di);
2989}
2990
2991/*
2992 * List the value of one internal variable.
2993 */
2994 static void
2995list_one_var(dictitem_T *v, char *prefix, int *first)
2996{
2997 char_u *tofree;
2998 char_u *s;
2999 char_u numbuf[NUMBUFLEN];
3000
3001 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
3002 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
3003 s == NULL ? (char_u *)"" : s, first);
3004 vim_free(tofree);
3005}
3006
3007 static void
3008list_one_var_a(
3009 char *prefix,
3010 char_u *name,
3011 int type,
3012 char_u *string,
3013 int *first) // when TRUE clear rest of screen and set to FALSE
3014{
3015 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
3016 msg_start();
3017 msg_puts(prefix);
3018 if (name != NULL) // "a:" vars don't have a name stored
3019 msg_puts((char *)name);
3020 msg_putchar(' ');
3021 msg_advance(22);
3022 if (type == VAR_NUMBER)
3023 msg_putchar('#');
3024 else if (type == VAR_FUNC || type == VAR_PARTIAL)
3025 msg_putchar('*');
3026 else if (type == VAR_LIST)
3027 {
3028 msg_putchar('[');
3029 if (*string == '[')
3030 ++string;
3031 }
3032 else if (type == VAR_DICT)
3033 {
3034 msg_putchar('{');
3035 if (*string == '{')
3036 ++string;
3037 }
3038 else
3039 msg_putchar(' ');
3040
3041 msg_outtrans(string);
3042
3043 if (type == VAR_FUNC || type == VAR_PARTIAL)
3044 msg_puts("()");
3045 if (*first)
3046 {
3047 msg_clr_eos();
3048 *first = FALSE;
3049 }
3050}
3051
3052/*
3053 * Set variable "name" to value in "tv".
3054 * If the variable already exists, the value is updated.
3055 * Otherwise the variable is created.
3056 */
3057 void
3058set_var(
3059 char_u *name,
3060 typval_T *tv,
3061 int copy) // make copy of value in "tv"
3062{
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003063 set_var_const(name, NULL, tv, copy, ASSIGN_DECL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003064}
3065
3066/*
3067 * Set variable "name" to value in "tv".
3068 * If the variable already exists and "is_const" is FALSE the value is updated.
3069 * Otherwise the variable is created.
3070 */
3071 void
3072set_var_const(
3073 char_u *name,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003074 type_T *type,
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003075 typval_T *tv_arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003076 int copy, // make copy of value in "tv"
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003077 int flags) // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003078{
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003079 typval_T *tv = tv_arg;
3080 typval_T bool_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003081 dictitem_T *di;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003082 char_u *varname;
3083 hashtab_T *ht;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003084 int is_script_local;
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003085 int vim9script = in_vim9script();
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003086
3087 ht = find_var_ht(name, &varname);
3088 if (ht == NULL || *varname == NUL)
3089 {
3090 semsg(_(e_illvar), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003091 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003092 }
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003093 is_script_local = ht == get_script_local_ht();
3094
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003095 if (vim9script
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003096 && !is_script_local
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003097 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003098 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003099 && name[1] == ':')
Bram Moolenaar67979662020-06-20 22:50:47 +02003100 {
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003101 vim9_declare_error(name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003102 goto failed;
Bram Moolenaar67979662020-06-20 22:50:47 +02003103 }
3104
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003105 di = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003106
3107 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003108 if (di == NULL)
3109 di = find_var_in_scoped_ht(name, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003110
3111 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
Bram Moolenaar98b4f142020-08-08 15:46:01 +02003112 && var_wrong_func_name(name, di == NULL))
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003113 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003114
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003115 if (need_convert_to_bool(type, tv))
3116 {
3117 // Destination is a bool and the value is not, but it can be converted.
3118 CLEAR_FIELD(bool_tv);
3119 bool_tv.v_type = VAR_BOOL;
3120 bool_tv.vval.v_number = tv2bool(tv) ? VVAL_TRUE : VVAL_FALSE;
3121 tv = &bool_tv;
3122 }
3123
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003124 if (di != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003125 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003126 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003127 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003128 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003129 {
3130 emsg(_(e_cannot_mod));
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003131 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003132 }
3133
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003134 if (is_script_local && vim9script)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003135 {
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003136 if ((flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0)
Bram Moolenaar34db91f2020-06-13 19:00:10 +02003137 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003138 semsg(_(e_redefining_script_item_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003139 goto failed;
Bram Moolenaar34db91f2020-06-13 19:00:10 +02003140 }
3141
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003142 // check the type and adjust to bool if needed
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02003143 if (check_script_var_type(&di->di_tv, tv, name) == FAIL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003144 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003145 }
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02003146
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003147 if (var_check_permission(di, name) == FAIL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003148 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003149 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003150 else
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003151 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003152 // can only redefine once
3153 di->di_flags &= ~DI_FLAGS_RELOAD;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003154
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003155 // A Vim9 script-local variable is also present in sn_all_vars and
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003156 // sn_var_vals. It may set "type" from "tv".
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003157 if (is_script_local && vim9script)
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003158 update_vim9_script_var(FALSE, di, tv, &type);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003159 }
3160
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003161 // existing variable, need to clear the value
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003162
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003163 // Handle setting internal di: variables separately where needed to
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003164 // prevent changing the type.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003165 if (ht == &vimvarht)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003166 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003167 if (di->di_tv.v_type == VAR_STRING)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003168 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003169 VIM_CLEAR(di->di_tv.vval.v_string);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003170 if (copy || tv->v_type != VAR_STRING)
3171 {
3172 char_u *val = tv_get_string(tv);
3173
3174 // Careful: when assigning to v:errmsg and tv_get_string()
Bram Moolenaar4b96df52020-01-26 22:00:26 +01003175 // causes an error message the variable will already be set.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003176 if (di->di_tv.vval.v_string == NULL)
3177 di->di_tv.vval.v_string = vim_strsave(val);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003178 }
3179 else
3180 {
3181 // Take over the string to avoid an extra alloc/free.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003182 di->di_tv.vval.v_string = tv->vval.v_string;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003183 tv->vval.v_string = NULL;
3184 }
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003185 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003186 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003187 else if (di->di_tv.v_type == VAR_NUMBER)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003188 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003189 di->di_tv.vval.v_number = tv_get_number(tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003190 if (STRCMP(varname, "searchforward") == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003191 set_search_direction(di->di_tv.vval.v_number ? '/' : '?');
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003192#ifdef FEAT_SEARCH_EXTRA
3193 else if (STRCMP(varname, "hlsearch") == 0)
3194 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003195 no_hlsearch = !di->di_tv.vval.v_number;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003196 redraw_all_later(SOME_VALID);
3197 }
3198#endif
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003199 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003200 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003201 else if (di->di_tv.v_type != tv->v_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003202 {
3203 semsg(_("E963: setting %s to value with wrong type"), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003204 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003205 }
3206 }
3207
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003208 clear_tv(&di->di_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003209 }
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003210 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003211 {
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003212 // add a new variable
3213 if (vim9script && is_script_local && (flags & ASSIGN_NO_DECL))
3214 {
3215 semsg(_(e_unknown_variable_str), name);
3216 goto failed;
3217 }
3218
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003219 // Can't add "v:" or "a:" variable.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003220 if (ht == &vimvarht || ht == get_funccal_args_ht())
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003221 {
3222 semsg(_(e_illvar), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003223 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003224 }
3225
Bram Moolenaar03290b82020-12-19 16:30:44 +01003226 // Make sure the variable name is valid. In Vim9 script an autoload
3227 // variable must be prefixed with "g:".
3228 if (!valid_varname(varname, !vim9script
3229 || STRNCMP(name, "g:", 2) == 0))
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003230 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003231
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003232 di = alloc(sizeof(dictitem_T) + STRLEN(varname));
3233 if (di == NULL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003234 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003235 STRCPY(di->di_key, varname);
3236 if (hash_add(ht, DI2HIKEY(di)) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003237 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003238 vim_free(di);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003239 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003240 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003241 di->di_flags = DI_FLAGS_ALLOC;
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003242 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003243 di->di_flags |= DI_FLAGS_LOCK;
3244
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003245 // A Vim9 script-local variable is also added to sn_all_vars and
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003246 // sn_var_vals. It may set "type" from "tv".
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003247 if (is_script_local && vim9script)
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003248 update_vim9_script_var(TRUE, di, tv, &type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003249 }
3250
3251 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003252 copy_tv(tv, &di->di_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003253 else
3254 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003255 di->di_tv = *tv;
3256 di->di_tv.v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003257 init_tv(tv);
3258 }
3259
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003260 if (vim9script && type != NULL)
3261 {
3262 if (type->tt_type == VAR_DICT && di->di_tv.vval.v_dict != NULL)
3263 di->di_tv.vval.v_dict->dv_type = alloc_type(type);
3264 else if (type->tt_type == VAR_LIST && di->di_tv.vval.v_list != NULL)
3265 di->di_tv.vval.v_list->lv_type = alloc_type(type);
3266 }
3267
Bram Moolenaar1dcf55d2020-12-22 22:07:30 +01003268 // ":const var = value" locks the value
3269 // ":final var = value" locks "var"
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003270 if (flags & ASSIGN_CONST)
Bram Moolenaar021bda52020-08-17 21:07:22 +02003271 // Like :lockvar! name: lock the value and what it contains, but only
3272 // if the reference count is up to one. That locks only literal
3273 // values.
3274 item_lock(&di->di_tv, DICT_MAXNEST, TRUE, TRUE);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003275 return;
3276failed:
3277 if (!copy)
3278 clear_tv(tv_arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003279}
3280
3281/*
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003282 * Check in this order for backwards compatibility:
3283 * - Whether the variable is read-only
3284 * - Whether the variable value is locked
3285 * - Whether the variable is locked
3286 */
3287 int
3288var_check_permission(dictitem_T *di, char_u *name)
3289{
3290 if (var_check_ro(di->di_flags, name, FALSE)
3291 || value_check_lock(di->di_tv.v_lock, name, FALSE)
3292 || var_check_lock(di->di_flags, name, FALSE))
3293 return FAIL;
3294 return OK;
3295}
3296
3297/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003298 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
3299 * Also give an error message.
3300 */
3301 int
3302var_check_ro(int flags, char_u *name, int use_gettext)
3303{
3304 if (flags & DI_FLAGS_RO)
3305 {
3306 semsg(_(e_readonlyvar), use_gettext ? (char_u *)_(name) : name);
3307 return TRUE;
3308 }
3309 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
3310 {
3311 semsg(_(e_readonlysbx), use_gettext ? (char_u *)_(name) : name);
3312 return TRUE;
3313 }
3314 return FALSE;
3315}
3316
3317/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003318 * Return TRUE if di_flags "flags" indicates variable "name" is locked.
3319 * Also give an error message.
3320 */
3321 int
3322var_check_lock(int flags, char_u *name, int use_gettext)
3323{
3324 if (flags & DI_FLAGS_LOCK)
3325 {
3326 semsg(_(e_variable_is_locked_str),
3327 use_gettext ? (char_u *)_(name) : name);
3328 return TRUE;
3329 }
3330 return FALSE;
3331}
3332
3333/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003334 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
3335 * Also give an error message.
3336 */
3337 int
3338var_check_fixed(int flags, char_u *name, int use_gettext)
3339{
3340 if (flags & DI_FLAGS_FIX)
3341 {
3342 semsg(_("E795: Cannot delete variable %s"),
3343 use_gettext ? (char_u *)_(name) : name);
3344 return TRUE;
3345 }
3346 return FALSE;
3347}
3348
3349/*
3350 * Check if a funcref is assigned to a valid variable name.
3351 * Return TRUE and give an error if not.
3352 */
3353 int
Bram Moolenaar98b4f142020-08-08 15:46:01 +02003354var_wrong_func_name(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003355 char_u *name, // points to start of variable name
3356 int new_var) // TRUE when creating the variable
3357{
3358 // Allow for w: b: s: and t:.
3359 if (!(vim_strchr((char_u *)"wbst", name[0]) != NULL && name[1] == ':')
3360 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
3361 ? name[2] : name[0]))
3362 {
3363 semsg(_("E704: Funcref variable name must start with a capital: %s"),
3364 name);
3365 return TRUE;
3366 }
3367 // Don't allow hiding a function. When "v" is not NULL we might be
3368 // assigning another function to the same var, the type is checked
3369 // below.
3370 if (new_var && function_exists(name, FALSE))
3371 {
3372 semsg(_("E705: Variable name conflicts with existing function: %s"),
3373 name);
3374 return TRUE;
3375 }
3376 return FALSE;
3377}
3378
3379/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003380 * Return TRUE if "flags" indicates variable "name" has a locked (immutable)
3381 * value. Also give an error message, using "name" or _("name") when
3382 * "use_gettext" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003383 */
3384 int
Bram Moolenaara187c432020-09-16 21:08:28 +02003385value_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003386{
3387 if (lock & VAR_LOCKED)
3388 {
3389 semsg(_("E741: Value is locked: %s"),
3390 name == NULL ? (char_u *)_("Unknown")
3391 : use_gettext ? (char_u *)_(name)
3392 : name);
3393 return TRUE;
3394 }
3395 if (lock & VAR_FIXED)
3396 {
3397 semsg(_("E742: Cannot change value of %s"),
3398 name == NULL ? (char_u *)_("Unknown")
3399 : use_gettext ? (char_u *)_(name)
3400 : name);
3401 return TRUE;
3402 }
3403 return FALSE;
3404}
3405
3406/*
Bram Moolenaar03290b82020-12-19 16:30:44 +01003407 * Check if a variable name is valid. When "autoload" is true "#" is allowed.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003408 * Return FALSE and give an error if not.
3409 */
3410 int
Bram Moolenaar03290b82020-12-19 16:30:44 +01003411valid_varname(char_u *varname, int autoload)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003412{
3413 char_u *p;
3414
3415 for (p = varname; *p != NUL; ++p)
3416 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
Bram Moolenaar03290b82020-12-19 16:30:44 +01003417 && !(autoload && *p == AUTOLOAD_CHAR))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003418 {
3419 semsg(_(e_illvar), varname);
3420 return FALSE;
3421 }
3422 return TRUE;
3423}
3424
3425/*
3426 * getwinvar() and gettabwinvar()
3427 */
3428 static void
3429getwinvar(
3430 typval_T *argvars,
3431 typval_T *rettv,
3432 int off) // 1 for gettabwinvar()
3433{
3434 win_T *win;
3435 char_u *varname;
3436 dictitem_T *v;
3437 tabpage_T *tp = NULL;
3438 int done = FALSE;
3439 win_T *oldcurwin;
3440 tabpage_T *oldtabpage;
3441 int need_switch_win;
3442
3443 if (off == 1)
3444 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3445 else
3446 tp = curtab;
3447 win = find_win_by_nr(&argvars[off], tp);
3448 varname = tv_get_string_chk(&argvars[off + 1]);
3449 ++emsg_off;
3450
3451 rettv->v_type = VAR_STRING;
3452 rettv->vval.v_string = NULL;
3453
3454 if (win != NULL && varname != NULL)
3455 {
3456 // Set curwin to be our win, temporarily. Also set the tabpage,
3457 // otherwise the window is not valid. Only do this when needed,
3458 // autocommands get blocked.
3459 need_switch_win = !(tp == curtab && win == curwin);
3460 if (!need_switch_win
3461 || switch_win(&oldcurwin, &oldtabpage, win, tp, TRUE) == OK)
3462 {
3463 if (*varname == '&')
3464 {
3465 if (varname[1] == NUL)
3466 {
3467 // get all window-local options in a dict
3468 dict_T *opts = get_winbuf_options(FALSE);
3469
3470 if (opts != NULL)
3471 {
3472 rettv_dict_set(rettv, opts);
3473 done = TRUE;
3474 }
3475 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003476 else if (eval_option(&varname, rettv, 1) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003477 // window-local-option
3478 done = TRUE;
3479 }
3480 else
3481 {
3482 // Look up the variable.
3483 // Let getwinvar({nr}, "") return the "w:" dictionary.
3484 v = find_var_in_ht(&win->w_vars->dv_hashtab, 'w',
3485 varname, FALSE);
3486 if (v != NULL)
3487 {
3488 copy_tv(&v->di_tv, rettv);
3489 done = TRUE;
3490 }
3491 }
3492 }
3493
3494 if (need_switch_win)
3495 // restore previous notion of curwin
3496 restore_win(oldcurwin, oldtabpage, TRUE);
3497 }
3498
3499 if (!done && argvars[off + 2].v_type != VAR_UNKNOWN)
3500 // use the default return value
3501 copy_tv(&argvars[off + 2], rettv);
3502
3503 --emsg_off;
3504}
3505
3506/*
Bram Moolenaar191929b2020-08-19 21:20:49 +02003507 * Set option "varname" to the value of "varp" for the current buffer/window.
3508 */
3509 static void
3510set_option_from_tv(char_u *varname, typval_T *varp)
3511{
3512 long numval = 0;
3513 char_u *strval;
3514 char_u nbuf[NUMBUFLEN];
3515 int error = FALSE;
3516
Bram Moolenaar31a201a2021-01-03 14:47:25 +01003517 if (varp->v_type == VAR_BOOL)
Bram Moolenaarb0d81822021-01-03 15:55:10 +01003518 {
Bram Moolenaar31a201a2021-01-03 14:47:25 +01003519 numval = (long)varp->vval.v_number;
Bram Moolenaarb0d81822021-01-03 15:55:10 +01003520 strval = (char_u *)"0"; // avoid using "false"
3521 }
3522 else
3523 {
3524 if (!in_vim9script() || varp->v_type != VAR_STRING)
3525 numval = (long)tv_get_number_chk(varp, &error);
3526 strval = tv_get_string_buf_chk(varp, nbuf);
3527 }
Bram Moolenaar191929b2020-08-19 21:20:49 +02003528 if (!error && strval != NULL)
3529 set_option_value(varname, numval, strval, OPT_LOCAL);
3530}
3531
3532/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003533 * "setwinvar()" and "settabwinvar()" functions
3534 */
3535 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003536setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003537{
3538 win_T *win;
3539 win_T *save_curwin;
3540 tabpage_T *save_curtab;
3541 int need_switch_win;
3542 char_u *varname, *winvarname;
3543 typval_T *varp;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003544 tabpage_T *tp = NULL;
3545
3546 if (check_secure())
3547 return;
3548
3549 if (off == 1)
3550 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3551 else
3552 tp = curtab;
3553 win = find_win_by_nr(&argvars[off], tp);
3554 varname = tv_get_string_chk(&argvars[off + 1]);
3555 varp = &argvars[off + 2];
3556
3557 if (win != NULL && varname != NULL && varp != NULL)
3558 {
3559 need_switch_win = !(tp == curtab && win == curwin);
3560 if (!need_switch_win
3561 || switch_win(&save_curwin, &save_curtab, win, tp, TRUE) == OK)
3562 {
3563 if (*varname == '&')
Bram Moolenaar191929b2020-08-19 21:20:49 +02003564 set_option_from_tv(varname + 1, varp);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003565 else
3566 {
3567 winvarname = alloc(STRLEN(varname) + 3);
3568 if (winvarname != NULL)
3569 {
3570 STRCPY(winvarname, "w:");
3571 STRCPY(winvarname + 2, varname);
3572 set_var(winvarname, varp, TRUE);
3573 vim_free(winvarname);
3574 }
3575 }
3576 }
3577 if (need_switch_win)
3578 restore_win(save_curwin, save_curtab, TRUE);
3579 }
3580}
3581
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003582/*
3583 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
3584 * v:option_type, and v:option_command.
3585 */
3586 void
3587reset_v_option_vars(void)
3588{
3589 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
3590 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
3591 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
3592 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
3593 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
3594 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
3595}
3596
3597/*
3598 * Add an assert error to v:errors.
3599 */
3600 void
3601assert_error(garray_T *gap)
3602{
3603 struct vimvar *vp = &vimvars[VV_ERRORS];
3604
3605 if (vp->vv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003606 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003607 set_vim_var_list(VV_ERRORS, list_alloc());
3608 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
3609}
3610
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003611 int
3612var_exists(char_u *var)
3613{
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003614 char_u *arg = var;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003615 char_u *name;
3616 char_u *tofree;
3617 typval_T tv;
3618 int len = 0;
3619 int n = FALSE;
3620
3621 // get_name_len() takes care of expanding curly braces
3622 name = var;
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003623 len = get_name_len(&arg, &tofree, TRUE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003624 if (len > 0)
3625 {
3626 if (tofree != NULL)
3627 name = tofree;
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003628 n = (eval_variable(name, len, &tv, NULL, FALSE, TRUE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003629 if (n)
3630 {
3631 // handle d.key, l[idx], f(expr)
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003632 arg = skipwhite(arg);
3633 n = (handle_subscript(&arg, &tv, &EVALARG_EVALUATE, FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003634 if (n)
3635 clear_tv(&tv);
3636 }
3637 }
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003638 if (*arg != NUL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003639 n = FALSE;
3640
3641 vim_free(tofree);
3642 return n;
3643}
3644
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003645static lval_T *redir_lval = NULL;
3646#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
3647static garray_T redir_ga; // only valid when redir_lval is not NULL
3648static char_u *redir_endp = NULL;
3649static char_u *redir_varname = NULL;
3650
3651/*
3652 * Start recording command output to a variable
3653 * When "append" is TRUE append to an existing variable.
3654 * Returns OK if successfully completed the setup. FAIL otherwise.
3655 */
3656 int
3657var_redir_start(char_u *name, int append)
3658{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003659 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003660 typval_T tv;
3661
3662 // Catch a bad name early.
3663 if (!eval_isnamec1(*name))
3664 {
3665 emsg(_(e_invarg));
3666 return FAIL;
3667 }
3668
3669 // Make a copy of the name, it is used in redir_lval until redir ends.
3670 redir_varname = vim_strsave(name);
3671 if (redir_varname == NULL)
3672 return FAIL;
3673
3674 redir_lval = ALLOC_CLEAR_ONE(lval_T);
3675 if (redir_lval == NULL)
3676 {
3677 var_redir_stop();
3678 return FAIL;
3679 }
3680
3681 // The output is stored in growarray "redir_ga" until redirection ends.
3682 ga_init2(&redir_ga, (int)sizeof(char), 500);
3683
3684 // Parse the variable name (can be a dict or list entry).
3685 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
3686 FNE_CHECK_START);
3687 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
3688 {
3689 clear_lval(redir_lval);
3690 if (redir_endp != NULL && *redir_endp != NUL)
3691 // Trailing characters are present after the variable name
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003692 semsg(_(e_trailing_arg), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003693 else
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003694 semsg(_(e_invarg2), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003695 redir_endp = NULL; // don't store a value, only cleanup
3696 var_redir_stop();
3697 return FAIL;
3698 }
3699
3700 // check if we can write to the variable: set it to or append an empty
3701 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003702 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003703 tv.v_type = VAR_STRING;
3704 tv.vval.v_string = (char_u *)"";
3705 if (append)
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02003706 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
3707 ASSIGN_NO_DECL, (char_u *)".");
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003708 else
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02003709 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
3710 ASSIGN_NO_DECL, (char_u *)"=");
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003711 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003712 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003713 {
3714 redir_endp = NULL; // don't store a value, only cleanup
3715 var_redir_stop();
3716 return FAIL;
3717 }
3718
3719 return OK;
3720}
3721
3722/*
3723 * Append "value[value_len]" to the variable set by var_redir_start().
3724 * The actual appending is postponed until redirection ends, because the value
3725 * appended may in fact be the string we write to, changing it may cause freed
3726 * memory to be used:
3727 * :redir => foo
3728 * :let foo
3729 * :redir END
3730 */
3731 void
3732var_redir_str(char_u *value, int value_len)
3733{
3734 int len;
3735
3736 if (redir_lval == NULL)
3737 return;
3738
3739 if (value_len == -1)
3740 len = (int)STRLEN(value); // Append the entire string
3741 else
3742 len = value_len; // Append only "value_len" characters
3743
3744 if (ga_grow(&redir_ga, len) == OK)
3745 {
3746 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
3747 redir_ga.ga_len += len;
3748 }
3749 else
3750 var_redir_stop();
3751}
3752
3753/*
3754 * Stop redirecting command output to a variable.
3755 * Frees the allocated memory.
3756 */
3757 void
3758var_redir_stop(void)
3759{
3760 typval_T tv;
3761
3762 if (EVALCMD_BUSY)
3763 {
3764 redir_lval = NULL;
3765 return;
3766 }
3767
3768 if (redir_lval != NULL)
3769 {
3770 // If there was no error: assign the text to the variable.
3771 if (redir_endp != NULL)
3772 {
3773 ga_append(&redir_ga, NUL); // Append the trailing NUL.
3774 tv.v_type = VAR_STRING;
3775 tv.vval.v_string = redir_ga.ga_data;
3776 // Call get_lval() again, if it's inside a Dict or List it may
3777 // have changed.
3778 redir_endp = get_lval(redir_varname, NULL, redir_lval,
3779 FALSE, FALSE, 0, FNE_CHECK_START);
3780 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003781 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003782 (char_u *)".");
3783 clear_lval(redir_lval);
3784 }
3785
3786 // free the collected output
3787 VIM_CLEAR(redir_ga.ga_data);
3788
3789 VIM_CLEAR(redir_lval);
3790 }
3791 VIM_CLEAR(redir_varname);
3792}
3793
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003794/*
3795 * "gettabvar()" function
3796 */
3797 void
3798f_gettabvar(typval_T *argvars, typval_T *rettv)
3799{
3800 win_T *oldcurwin;
3801 tabpage_T *tp, *oldtabpage;
3802 dictitem_T *v;
3803 char_u *varname;
3804 int done = FALSE;
3805
3806 rettv->v_type = VAR_STRING;
3807 rettv->vval.v_string = NULL;
3808
3809 varname = tv_get_string_chk(&argvars[1]);
3810 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3811 if (tp != NULL && varname != NULL)
3812 {
3813 // Set tp to be our tabpage, temporarily. Also set the window to the
3814 // first window in the tabpage, otherwise the window is not valid.
3815 if (switch_win(&oldcurwin, &oldtabpage,
3816 tp == curtab || tp->tp_firstwin == NULL ? firstwin
3817 : tp->tp_firstwin, tp, TRUE) == OK)
3818 {
3819 // look up the variable
3820 // Let gettabvar({nr}, "") return the "t:" dictionary.
3821 v = find_var_in_ht(&tp->tp_vars->dv_hashtab, 't', varname, FALSE);
3822 if (v != NULL)
3823 {
3824 copy_tv(&v->di_tv, rettv);
3825 done = TRUE;
3826 }
3827 }
3828
3829 // restore previous notion of curwin
3830 restore_win(oldcurwin, oldtabpage, TRUE);
3831 }
3832
3833 if (!done && argvars[2].v_type != VAR_UNKNOWN)
3834 copy_tv(&argvars[2], rettv);
3835}
3836
3837/*
3838 * "gettabwinvar()" function
3839 */
3840 void
3841f_gettabwinvar(typval_T *argvars, typval_T *rettv)
3842{
3843 getwinvar(argvars, rettv, 1);
3844}
3845
3846/*
3847 * "getwinvar()" function
3848 */
3849 void
3850f_getwinvar(typval_T *argvars, typval_T *rettv)
3851{
3852 getwinvar(argvars, rettv, 0);
3853}
3854
3855/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003856 * "getbufvar()" function
3857 */
3858 void
3859f_getbufvar(typval_T *argvars, typval_T *rettv)
3860{
3861 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003862 char_u *varname;
3863 dictitem_T *v;
3864 int done = FALSE;
3865
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003866 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02003867 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003868
3869 rettv->v_type = VAR_STRING;
3870 rettv->vval.v_string = NULL;
3871
3872 if (buf != NULL && varname != NULL)
3873 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003874 if (*varname == '&')
3875 {
Bram Moolenaar86015452020-03-29 15:12:15 +02003876 buf_T *save_curbuf = curbuf;
3877
3878 // set curbuf to be our buf, temporarily
3879 curbuf = buf;
3880
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003881 if (varname[1] == NUL)
3882 {
3883 // get all buffer-local options in a dict
3884 dict_T *opts = get_winbuf_options(TRUE);
3885
3886 if (opts != NULL)
3887 {
3888 rettv_dict_set(rettv, opts);
3889 done = TRUE;
3890 }
3891 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003892 else if (eval_option(&varname, rettv, TRUE) == OK)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003893 // buffer-local-option
3894 done = TRUE;
Bram Moolenaar86015452020-03-29 15:12:15 +02003895
3896 // restore previous notion of curbuf
3897 curbuf = save_curbuf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003898 }
3899 else
3900 {
3901 // Look up the variable.
Bram Moolenaar52592752020-04-03 18:43:35 +02003902 if (*varname == NUL)
3903 // Let getbufvar({nr}, "") return the "b:" dictionary.
3904 v = &buf->b_bufvar;
3905 else
3906 v = find_var_in_ht(&buf->b_vars->dv_hashtab, 'b',
3907 varname, FALSE);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003908 if (v != NULL)
3909 {
3910 copy_tv(&v->di_tv, rettv);
3911 done = TRUE;
3912 }
3913 }
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003914 }
3915
3916 if (!done && argvars[2].v_type != VAR_UNKNOWN)
3917 // use the default value
3918 copy_tv(&argvars[2], rettv);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003919}
3920
3921/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003922 * "settabvar()" function
3923 */
3924 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003925f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003926{
3927 tabpage_T *save_curtab;
3928 tabpage_T *tp;
3929 char_u *varname, *tabvarname;
3930 typval_T *varp;
3931
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003932 if (check_secure())
3933 return;
3934
3935 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3936 varname = tv_get_string_chk(&argvars[1]);
3937 varp = &argvars[2];
3938
3939 if (varname != NULL && varp != NULL && tp != NULL)
3940 {
3941 save_curtab = curtab;
3942 goto_tabpage_tp(tp, FALSE, FALSE);
3943
3944 tabvarname = alloc(STRLEN(varname) + 3);
3945 if (tabvarname != NULL)
3946 {
3947 STRCPY(tabvarname, "t:");
3948 STRCPY(tabvarname + 2, varname);
3949 set_var(tabvarname, varp, TRUE);
3950 vim_free(tabvarname);
3951 }
3952
3953 // Restore current tabpage
3954 if (valid_tabpage(save_curtab))
3955 goto_tabpage_tp(save_curtab, FALSE, FALSE);
3956 }
3957}
3958
3959/*
3960 * "settabwinvar()" function
3961 */
3962 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003963f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003964{
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003965 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003966}
3967
3968/*
3969 * "setwinvar()" function
3970 */
3971 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003972f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003973{
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003974 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003975}
3976
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003977/*
3978 * "setbufvar()" function
3979 */
3980 void
3981f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
3982{
3983 buf_T *buf;
3984 char_u *varname, *bufvarname;
3985 typval_T *varp;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003986
3987 if (check_secure())
3988 return;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003989 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02003990 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003991 varp = &argvars[2];
3992
3993 if (buf != NULL && varname != NULL && varp != NULL)
3994 {
3995 if (*varname == '&')
3996 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003997 aco_save_T aco;
3998
3999 // set curbuf to be our buf, temporarily
4000 aucmd_prepbuf(&aco, buf);
4001
Bram Moolenaar191929b2020-08-19 21:20:49 +02004002 set_option_from_tv(varname + 1, varp);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004003
4004 // reset notion of buffer
4005 aucmd_restbuf(&aco);
4006 }
4007 else
4008 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004009 bufvarname = alloc(STRLEN(varname) + 3);
4010 if (bufvarname != NULL)
4011 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004012 buf_T *save_curbuf = curbuf;
4013
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004014 curbuf = buf;
4015 STRCPY(bufvarname, "b:");
4016 STRCPY(bufvarname + 2, varname);
4017 set_var(bufvarname, varp, TRUE);
4018 vim_free(bufvarname);
4019 curbuf = save_curbuf;
4020 }
4021 }
4022 }
4023}
4024
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004025/*
4026 * Get a callback from "arg". It can be a Funcref or a function name.
4027 * When "arg" is zero return an empty string.
4028 * "cb_name" is not allocated.
4029 * "cb_name" is set to NULL for an invalid argument.
4030 */
4031 callback_T
4032get_callback(typval_T *arg)
4033{
Bram Moolenaar14e579092020-03-07 16:59:25 +01004034 callback_T res;
4035 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004036
4037 res.cb_free_name = FALSE;
4038 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
4039 {
4040 res.cb_partial = arg->vval.v_partial;
4041 ++res.cb_partial->pt_refcount;
4042 res.cb_name = partial_name(res.cb_partial);
4043 }
4044 else
4045 {
4046 res.cb_partial = NULL;
Bram Moolenaar14e579092020-03-07 16:59:25 +01004047 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
4048 && isdigit(*arg->vval.v_string))
4049 r = FAIL;
4050 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004051 {
4052 // Note that we don't make a copy of the string.
4053 res.cb_name = arg->vval.v_string;
4054 func_ref(res.cb_name);
4055 }
4056 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004057 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004058 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01004059 r = FAIL;
4060
4061 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004062 {
4063 emsg(_("E921: Invalid callback argument"));
4064 res.cb_name = NULL;
4065 }
4066 }
4067 return res;
4068}
4069
4070/*
4071 * Copy a callback into a typval_T.
4072 */
4073 void
4074put_callback(callback_T *cb, typval_T *tv)
4075{
4076 if (cb->cb_partial != NULL)
4077 {
4078 tv->v_type = VAR_PARTIAL;
4079 tv->vval.v_partial = cb->cb_partial;
4080 ++tv->vval.v_partial->pt_refcount;
4081 }
4082 else
4083 {
4084 tv->v_type = VAR_FUNC;
4085 tv->vval.v_string = vim_strsave(cb->cb_name);
4086 func_ref(cb->cb_name);
4087 }
4088}
4089
4090/*
4091 * Make a copy of "src" into "dest", allocating the function name if needed,
4092 * without incrementing the refcount.
4093 */
4094 void
4095set_callback(callback_T *dest, callback_T *src)
4096{
4097 if (src->cb_partial == NULL)
4098 {
4099 // just a function name, make a copy
4100 dest->cb_name = vim_strsave(src->cb_name);
4101 dest->cb_free_name = TRUE;
4102 }
4103 else
4104 {
4105 // cb_name is a pointer into cb_partial
4106 dest->cb_name = src->cb_name;
4107 dest->cb_free_name = FALSE;
4108 }
4109 dest->cb_partial = src->cb_partial;
4110}
4111
4112/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02004113 * Copy callback from "src" to "dest", incrementing the refcounts.
4114 */
4115 void
4116copy_callback(callback_T *dest, callback_T *src)
4117{
4118 dest->cb_partial = src->cb_partial;
4119 if (dest->cb_partial != NULL)
4120 {
4121 dest->cb_name = src->cb_name;
4122 dest->cb_free_name = FALSE;
4123 ++dest->cb_partial->pt_refcount;
4124 }
4125 else
4126 {
4127 dest->cb_name = vim_strsave(src->cb_name);
4128 dest->cb_free_name = TRUE;
4129 func_ref(src->cb_name);
4130 }
4131}
4132
4133/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004134 * Unref/free "callback" returned by get_callback() or set_callback().
4135 */
4136 void
4137free_callback(callback_T *callback)
4138{
4139 if (callback->cb_partial != NULL)
4140 {
4141 partial_unref(callback->cb_partial);
4142 callback->cb_partial = NULL;
4143 }
4144 else if (callback->cb_name != NULL)
4145 func_unref(callback->cb_name);
4146 if (callback->cb_free_name)
4147 {
4148 vim_free(callback->cb_name);
4149 callback->cb_free_name = FALSE;
4150 }
4151 callback->cb_name = NULL;
4152}
4153
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004154#endif // FEAT_EVAL