blob: 200fb8f12c1709ef9c32dad6891f2e71912c77e7 [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 Moolenaar036d0712021-01-17 20:23:38 +01001022 s = skip_var_one(p, include_type);
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 Moolenaar585587d2021-01-17 20:52:13 +01001064 char_u *end;
1065 int vim9 = in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001066
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001067 if (*arg == '@' && arg[1] != NUL)
1068 return arg + 2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001069 end = find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001070 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
Bram Moolenaar036d0712021-01-17 20:23:38 +01001071
1072 // "a: type" is declaring variable "a" with a type, not "a:".
1073 // Same for "s: type".
Bram Moolenaar585587d2021-01-17 20:52:13 +01001074 if (vim9 && end == arg + 2 && end[-1] == ':')
Bram Moolenaar036d0712021-01-17 20:23:38 +01001075 --end;
1076
Bram Moolenaar585587d2021-01-17 20:52:13 +01001077 if (include_type && vim9)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001078 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001079 if (*end == ':')
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02001080 end = skip_type(skipwhite(end + 1), FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001081 }
1082 return end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001083}
1084
1085/*
1086 * List variables for hashtab "ht" with prefix "prefix".
1087 * If "empty" is TRUE also list NULL strings as empty strings.
1088 */
1089 void
1090list_hashtable_vars(
1091 hashtab_T *ht,
1092 char *prefix,
1093 int empty,
1094 int *first)
1095{
1096 hashitem_T *hi;
1097 dictitem_T *di;
1098 int todo;
1099 char_u buf[IOSIZE];
1100
1101 todo = (int)ht->ht_used;
1102 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1103 {
1104 if (!HASHITEM_EMPTY(hi))
1105 {
1106 --todo;
1107 di = HI2DI(hi);
1108
1109 // apply :filter /pat/ to variable name
1110 vim_strncpy((char_u *)buf, (char_u *)prefix, IOSIZE - 1);
1111 vim_strcat((char_u *)buf, di->di_key, IOSIZE);
1112 if (message_filtered(buf))
1113 continue;
1114
1115 if (empty || di->di_tv.v_type != VAR_STRING
1116 || di->di_tv.vval.v_string != NULL)
1117 list_one_var(di, prefix, first);
1118 }
1119 }
1120}
1121
1122/*
1123 * List global variables.
1124 */
1125 static void
1126list_glob_vars(int *first)
1127{
1128 list_hashtable_vars(&globvarht, "", TRUE, first);
1129}
1130
1131/*
1132 * List buffer variables.
1133 */
1134 static void
1135list_buf_vars(int *first)
1136{
1137 list_hashtable_vars(&curbuf->b_vars->dv_hashtab, "b:", TRUE, first);
1138}
1139
1140/*
1141 * List window variables.
1142 */
1143 static void
1144list_win_vars(int *first)
1145{
1146 list_hashtable_vars(&curwin->w_vars->dv_hashtab, "w:", TRUE, first);
1147}
1148
1149/*
1150 * List tab page variables.
1151 */
1152 static void
1153list_tab_vars(int *first)
1154{
1155 list_hashtable_vars(&curtab->tp_vars->dv_hashtab, "t:", TRUE, first);
1156}
1157
1158/*
1159 * List variables in "arg".
1160 */
1161 static char_u *
1162list_arg_vars(exarg_T *eap, char_u *arg, int *first)
1163{
1164 int error = FALSE;
1165 int len;
1166 char_u *name;
1167 char_u *name_start;
1168 char_u *arg_subsc;
1169 char_u *tofree;
1170 typval_T tv;
1171
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001172 while (!ends_excmd2(eap->cmd, arg) && !got_int)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001173 {
1174 if (error || eap->skip)
1175 {
1176 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1177 if (!VIM_ISWHITE(*arg) && !ends_excmd(*arg))
1178 {
1179 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001180 semsg(_(e_trailing_arg), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001181 break;
1182 }
1183 }
1184 else
1185 {
1186 // get_name_len() takes care of expanding curly braces
1187 name_start = name = arg;
1188 len = get_name_len(&arg, &tofree, TRUE, TRUE);
1189 if (len <= 0)
1190 {
1191 // This is mainly to keep test 49 working: when expanding
1192 // curly braces fails overrule the exception error message.
1193 if (len < 0 && !aborting())
1194 {
1195 emsg_severe = TRUE;
1196 semsg(_(e_invarg2), arg);
1197 break;
1198 }
1199 error = TRUE;
1200 }
1201 else
1202 {
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02001203 arg = skipwhite(arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001204 if (tofree != NULL)
1205 name = tofree;
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02001206 if (eval_variable(name, len, &tv, NULL, TRUE, FALSE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001207 error = TRUE;
1208 else
1209 {
1210 // handle d.key, l[idx], f(expr)
1211 arg_subsc = arg;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001212 if (handle_subscript(&arg, &tv, &EVALARG_EVALUATE, TRUE)
Bram Moolenaar0b1cd522020-06-27 13:11:50 +02001213 == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001214 error = TRUE;
1215 else
1216 {
1217 if (arg == arg_subsc && len == 2 && name[1] == ':')
1218 {
1219 switch (*name)
1220 {
1221 case 'g': list_glob_vars(first); break;
1222 case 'b': list_buf_vars(first); break;
1223 case 'w': list_win_vars(first); break;
1224 case 't': list_tab_vars(first); break;
1225 case 'v': list_vim_vars(first); break;
1226 case 's': list_script_vars(first); break;
1227 case 'l': list_func_vars(first); break;
1228 default:
1229 semsg(_("E738: Can't list variables for %s"), name);
1230 }
1231 }
1232 else
1233 {
1234 char_u numbuf[NUMBUFLEN];
1235 char_u *tf;
1236 int c;
1237 char_u *s;
1238
1239 s = echo_string(&tv, &tf, numbuf, 0);
1240 c = *arg;
1241 *arg = NUL;
1242 list_one_var_a("",
1243 arg == arg_subsc ? name : name_start,
1244 tv.v_type,
1245 s == NULL ? (char_u *)"" : s,
1246 first);
1247 *arg = c;
1248 vim_free(tf);
1249 }
1250 clear_tv(&tv);
1251 }
1252 }
1253 }
1254
1255 vim_free(tofree);
1256 }
1257
1258 arg = skipwhite(arg);
1259 }
1260
1261 return arg;
1262}
1263
1264/*
1265 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
1266 * Returns a pointer to the char just after the var name.
1267 * Returns NULL if there is an error.
1268 */
1269 static char_u *
1270ex_let_one(
1271 char_u *arg, // points to variable name
1272 typval_T *tv, // value to assign to variable
1273 int copy, // copy value from "tv"
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001274 int flags, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001275 char_u *endchars, // valid chars after variable name or NULL
1276 char_u *op) // "+", "-", "." or NULL
1277{
1278 int c1;
1279 char_u *name;
1280 char_u *p;
1281 char_u *arg_end = NULL;
1282 int len;
1283 int opt_flags;
1284 char_u *tofree = NULL;
1285
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001286 if (in_vim9script() && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001287 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001288 && vim_strchr((char_u *)"$@&", *arg) != NULL)
1289 {
1290 vim9_declare_error(arg);
1291 return NULL;
1292 }
1293
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001294 // ":let $VAR = expr": Set environment variable.
1295 if (*arg == '$')
1296 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001297 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001298 {
1299 emsg(_("E996: Cannot lock an environment variable"));
1300 return NULL;
1301 }
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001302
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001303 // Find the end of the name.
1304 ++arg;
1305 name = arg;
1306 len = get_env_len(&arg);
1307 if (len == 0)
1308 semsg(_(e_invarg2), name - 1);
1309 else
1310 {
1311 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1312 semsg(_(e_letwrong), op);
1313 else if (endchars != NULL
1314 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
1315 emsg(_(e_letunexp));
1316 else if (!check_secure())
1317 {
1318 c1 = name[len];
1319 name[len] = NUL;
1320 p = tv_get_string_chk(tv);
1321 if (p != NULL && op != NULL && *op == '.')
1322 {
1323 int mustfree = FALSE;
1324 char_u *s = vim_getenv(name, &mustfree);
1325
1326 if (s != NULL)
1327 {
1328 p = tofree = concat_str(s, p);
1329 if (mustfree)
1330 vim_free(s);
1331 }
1332 }
1333 if (p != NULL)
1334 {
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01001335 vim_setenv_ext(name, p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001336 arg_end = arg;
1337 }
1338 name[len] = c1;
1339 vim_free(tofree);
1340 }
1341 }
1342 }
1343
1344 // ":let &option = expr": Set option value.
1345 // ":let &l:option = expr": Set local option value.
1346 // ":let &g:option = expr": Set global option value.
1347 else if (*arg == '&')
1348 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001349 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001350 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001351 emsg(_(e_const_option));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001352 return NULL;
1353 }
1354 // Find the end of the name.
1355 p = find_option_end(&arg, &opt_flags);
1356 if (p == NULL || (endchars != NULL
1357 && vim_strchr(endchars, *skipwhite(p)) == NULL))
1358 emsg(_(e_letunexp));
1359 else
1360 {
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001361 long n = 0;
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001362 getoption_T opt_type;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001363 long numval;
1364 char_u *stringval = NULL;
Bram Moolenaar65d032c2020-04-24 20:57:01 +02001365 char_u *s = NULL;
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001366 int failed = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001367
1368 c1 = *p;
1369 *p = NUL;
1370
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001371 opt_type = get_option_value(arg, &numval, &stringval, opt_flags);
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001372 if ((opt_type == gov_bool
1373 || opt_type == gov_number
1374 || opt_type == gov_hidden_bool
1375 || opt_type == gov_hidden_number)
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001376 && (tv->v_type != VAR_STRING || !in_vim9script()))
Bram Moolenaar0ea04402021-01-04 13:37:54 +01001377 {
1378 if (opt_type == gov_bool || opt_type == gov_hidden_bool)
1379 // bool, possibly hidden
1380 n = (long)tv_get_bool(tv);
1381 else
1382 // number, possibly hidden
1383 n = (long)tv_get_number(tv);
1384 }
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001385
1386 // Avoid setting a string option to the text "v:false" or similar.
1387 // In Vim9 script also don't convert a number to string.
1388 if (tv->v_type != VAR_BOOL && tv->v_type != VAR_SPECIAL
1389 && (!in_vim9script() || tv->v_type != VAR_NUMBER))
1390 s = tv_get_string_chk(tv);
1391
1392 if (op != NULL && *op != '=')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001393 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001394 if (((opt_type == gov_bool || opt_type == gov_number)
1395 && *op == '.')
1396 || (opt_type == gov_string && *op != '.'))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001397 {
1398 semsg(_(e_letwrong), op);
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001399 failed = TRUE; // don't set the value
1400
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001401 }
1402 else
1403 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001404 // number, in legacy script also bool
1405 if (opt_type == gov_number
1406 || (opt_type == gov_bool && !in_vim9script()))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001407 {
1408 switch (*op)
1409 {
1410 case '+': n = numval + n; break;
1411 case '-': n = numval - n; break;
1412 case '*': n = numval * n; break;
1413 case '/': n = (long)num_divide(numval, n); break;
1414 case '%': n = (long)num_modulus(numval, n); break;
1415 }
1416 }
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001417 else if (opt_type == gov_string
1418 && stringval != NULL && s != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001419 {
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001420 // string
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001421 s = concat_str(stringval, s);
1422 vim_free(stringval);
1423 stringval = s;
1424 }
1425 }
1426 }
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001427
1428 if (!failed)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001429 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001430 if (opt_type != gov_string || s != NULL)
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001431 {
1432 set_option_value(arg, n, s, opt_flags);
1433 arg_end = p;
1434 }
1435 else
1436 emsg(_(e_stringreq));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001437 }
1438 *p = c1;
1439 vim_free(stringval);
1440 }
1441 }
1442
1443 // ":let @r = expr": Set register contents.
1444 else if (*arg == '@')
1445 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001446 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001447 {
1448 emsg(_("E996: Cannot lock a register"));
1449 return NULL;
1450 }
1451 ++arg;
1452 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1453 semsg(_(e_letwrong), op);
1454 else if (endchars != NULL
1455 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
1456 emsg(_(e_letunexp));
1457 else
1458 {
1459 char_u *ptofree = NULL;
1460 char_u *s;
1461
1462 p = tv_get_string_chk(tv);
1463 if (p != NULL && op != NULL && *op == '.')
1464 {
1465 s = get_reg_contents(*arg == '@' ? '"' : *arg, GREG_EXPR_SRC);
1466 if (s != NULL)
1467 {
1468 p = ptofree = concat_str(s, p);
1469 vim_free(s);
1470 }
1471 }
1472 if (p != NULL)
1473 {
1474 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
1475 arg_end = arg + 1;
1476 }
1477 vim_free(ptofree);
1478 }
1479 }
1480
1481 // ":let var = expr": Set internal variable.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001482 // ":let var: type = expr": Set internal variable with type.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001483 // ":let {expr} = expr": Idem, name made with curly braces
1484 else if (eval_isnamec1(*arg) || *arg == '{')
1485 {
1486 lval_T lv;
1487
Bram Moolenaar8f22f5c2020-12-19 22:10:13 +01001488 p = get_lval(arg, tv, &lv, FALSE, FALSE,
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001489 (flags & (ASSIGN_NO_DECL | ASSIGN_DECL))
1490 ? GLV_NO_DECL : 0, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001491 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001492 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001493 if (endchars != NULL && vim_strchr(endchars,
1494 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001495 emsg(_(e_letunexp));
1496 else
1497 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001498 set_var_lval(&lv, p, tv, copy, flags, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001499 arg_end = p;
1500 }
1501 }
1502 clear_lval(&lv);
1503 }
1504
1505 else
1506 semsg(_(e_invarg2), arg);
1507
1508 return arg_end;
1509}
1510
1511/*
1512 * ":unlet[!] var1 ... " command.
1513 */
1514 void
1515ex_unlet(exarg_T *eap)
1516{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001517 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001518}
1519
1520/*
1521 * ":lockvar" and ":unlockvar" commands
1522 */
1523 void
1524ex_lockvar(exarg_T *eap)
1525{
1526 char_u *arg = eap->arg;
1527 int deep = 2;
1528
1529 if (eap->forceit)
1530 deep = -1;
1531 else if (vim_isdigit(*arg))
1532 {
1533 deep = getdigits(&arg);
1534 arg = skipwhite(arg);
1535 }
1536
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001537 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001538}
1539
1540/*
1541 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001542 * Also used for Vim9 script. "callback" is invoked as:
1543 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001544 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001545 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001546ex_unletlock(
1547 exarg_T *eap,
1548 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001549 int deep,
1550 int glv_flags,
1551 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1552 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001553{
1554 char_u *arg = argstart;
1555 char_u *name_end;
1556 int error = FALSE;
1557 lval_T lv;
1558
1559 do
1560 {
1561 if (*arg == '$')
1562 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001563 lv.ll_name = arg;
1564 lv.ll_tv = NULL;
1565 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001566 if (get_env_len(&arg) == 0)
1567 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001568 semsg(_(e_invarg2), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001569 return;
1570 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001571 if (!error && !eap->skip
1572 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1573 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001574 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001575 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001576 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001577 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001578 // Parse the name and find the end.
1579 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
Bram Moolenaarc3689572021-01-01 19:40:02 +01001580 glv_flags | GLV_NO_DECL, FNE_CHECK_START);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001581 if (lv.ll_name == NULL)
1582 error = TRUE; // error but continue parsing
1583 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1584 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001585 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001586 if (name_end != NULL)
1587 {
1588 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001589 semsg(_(e_trailing_arg), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001590 }
1591 if (!(eap->skip || error))
1592 clear_lval(&lv);
1593 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001594 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001595
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001596 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001597 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001598 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001599
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001600 if (!eap->skip)
1601 clear_lval(&lv);
1602 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001603
1604 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001605 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001606
1607 eap->nextcmd = check_nextcmd(arg);
1608}
1609
1610 static int
1611do_unlet_var(
1612 lval_T *lp,
1613 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001614 exarg_T *eap,
1615 int deep UNUSED,
1616 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001617{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001618 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001619 int ret = OK;
1620 int cc;
1621
1622 if (lp->ll_tv == NULL)
1623 {
1624 cc = *name_end;
1625 *name_end = NUL;
1626
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001627 // Environment variable, normal name or expanded name.
1628 if (*lp->ll_name == '$')
1629 vim_unsetenv(lp->ll_name + 1);
1630 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001631 ret = FAIL;
1632 *name_end = cc;
1633 }
1634 else if ((lp->ll_list != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001635 && value_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001636 || (lp->ll_dict != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001637 && value_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001638 return FAIL;
1639 else if (lp->ll_range)
1640 {
1641 listitem_T *li;
1642 listitem_T *ll_li = lp->ll_li;
1643 int ll_n1 = lp->ll_n1;
1644
1645 while (ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= ll_n1))
1646 {
1647 li = ll_li->li_next;
Bram Moolenaara187c432020-09-16 21:08:28 +02001648 if (value_check_lock(ll_li->li_tv.v_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001649 return FAIL;
1650 ll_li = li;
1651 ++ll_n1;
1652 }
1653
1654 // Delete a range of List items.
1655 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
1656 {
1657 li = lp->ll_li->li_next;
1658 listitem_remove(lp->ll_list, lp->ll_li);
1659 lp->ll_li = li;
1660 ++lp->ll_n1;
1661 }
1662 }
1663 else
1664 {
1665 if (lp->ll_list != NULL)
1666 // unlet a List item.
1667 listitem_remove(lp->ll_list, lp->ll_li);
1668 else
1669 // unlet a Dictionary item.
1670 dictitem_remove(lp->ll_dict, lp->ll_di);
1671 }
1672
1673 return ret;
1674}
1675
1676/*
1677 * "unlet" a variable. Return OK if it existed, FAIL if not.
1678 * When "forceit" is TRUE don't complain if the variable doesn't exist.
1679 */
1680 int
1681do_unlet(char_u *name, int forceit)
1682{
1683 hashtab_T *ht;
1684 hashitem_T *hi;
1685 char_u *varname;
1686 dict_T *d;
1687 dictitem_T *di;
1688
Bram Moolenaar9aed7292020-12-18 15:38:00 +01001689 // can't :unlet a script variable in Vim9 script
Bram Moolenaareb6880b2020-07-12 17:07:05 +02001690 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001691 return FAIL;
1692
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001693 ht = find_var_ht(name, &varname);
Bram Moolenaar9aed7292020-12-18 15:38:00 +01001694
1695 // can't :unlet a script variable in Vim9 script from a function
1696 if (ht == get_script_local_ht()
1697 && SCRIPT_ID_VALID(current_sctx.sc_sid)
1698 && SCRIPT_ITEM(current_sctx.sc_sid)->sn_version
1699 == SCRIPT_VERSION_VIM9
1700 && check_vim9_unlet(name) == FAIL)
1701 return FAIL;
1702
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001703 if (ht != NULL && *varname != NUL)
1704 {
1705 d = get_current_funccal_dict(ht);
1706 if (d == NULL)
1707 {
1708 if (ht == &globvarht)
1709 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001710 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001711 d = &vimvardict;
1712 else
1713 {
1714 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
1715 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
1716 }
1717 if (d == NULL)
1718 {
1719 internal_error("do_unlet()");
1720 return FAIL;
1721 }
1722 }
1723 hi = hash_find(ht, varname);
1724 if (HASHITEM_EMPTY(hi))
1725 hi = find_hi_in_scoped_ht(name, &ht);
1726 if (hi != NULL && !HASHITEM_EMPTY(hi))
1727 {
1728 di = HI2DI(hi);
1729 if (var_check_fixed(di->di_flags, name, FALSE)
1730 || var_check_ro(di->di_flags, name, FALSE)
Bram Moolenaara187c432020-09-16 21:08:28 +02001731 || value_check_lock(d->dv_lock, name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001732 return FAIL;
1733
1734 delete_var(ht, hi);
1735 return OK;
1736 }
1737 }
1738 if (forceit)
1739 return OK;
1740 semsg(_("E108: No such variable: \"%s\""), name);
1741 return FAIL;
1742}
1743
1744/*
1745 * Lock or unlock variable indicated by "lp".
1746 * "deep" is the levels to go (-1 for unlimited);
1747 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
1748 */
1749 static int
1750do_lock_var(
1751 lval_T *lp,
1752 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001753 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001754 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001755 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001756{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001757 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001758 int ret = OK;
1759 int cc;
1760 dictitem_T *di;
1761
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001762 if (lp->ll_tv == NULL)
1763 {
1764 cc = *name_end;
1765 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001766 if (*lp->ll_name == '$')
1767 {
1768 semsg(_(e_lock_unlock), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001769 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001770 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001771 else
1772 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001773 // Normal name or expanded name.
1774 di = find_var(lp->ll_name, NULL, TRUE);
1775 if (di == NULL)
1776 ret = FAIL;
1777 else if ((di->di_flags & DI_FLAGS_FIX)
1778 && di->di_tv.v_type != VAR_DICT
1779 && di->di_tv.v_type != VAR_LIST)
1780 {
1781 // For historic reasons this error is not given for a list or
1782 // dict. E.g., the b: dict could be locked/unlocked.
1783 semsg(_(e_lock_unlock), lp->ll_name);
1784 ret = FAIL;
1785 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001786 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001787 {
1788 if (lock)
1789 di->di_flags |= DI_FLAGS_LOCK;
1790 else
1791 di->di_flags &= ~DI_FLAGS_LOCK;
Bram Moolenaara187c432020-09-16 21:08:28 +02001792 if (deep != 0)
1793 item_lock(&di->di_tv, deep, lock, FALSE);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001794 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001795 }
1796 *name_end = cc;
1797 }
Bram Moolenaara187c432020-09-16 21:08:28 +02001798 else if (deep == 0)
1799 {
1800 // nothing to do
1801 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001802 else if (lp->ll_range)
1803 {
1804 listitem_T *li = lp->ll_li;
1805
1806 // (un)lock a range of List items.
1807 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
1808 {
Bram Moolenaar021bda52020-08-17 21:07:22 +02001809 item_lock(&li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001810 li = li->li_next;
1811 ++lp->ll_n1;
1812 }
1813 }
1814 else if (lp->ll_list != NULL)
1815 // (un)lock a List item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001816 item_lock(&lp->ll_li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001817 else
1818 // (un)lock a Dictionary item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001819 item_lock(&lp->ll_di->di_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001820
1821 return ret;
1822}
1823
1824/*
1825 * Lock or unlock an item. "deep" is nr of levels to go.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001826 * When "check_refcount" is TRUE do not lock a list or dict with a reference
1827 * count larger than 1.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001828 */
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02001829 void
Bram Moolenaar021bda52020-08-17 21:07:22 +02001830item_lock(typval_T *tv, int deep, int lock, int check_refcount)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001831{
1832 static int recurse = 0;
1833 list_T *l;
1834 listitem_T *li;
1835 dict_T *d;
1836 blob_T *b;
1837 hashitem_T *hi;
1838 int todo;
1839
1840 if (recurse >= DICT_MAXNEST)
1841 {
1842 emsg(_("E743: variable nested too deep for (un)lock"));
1843 return;
1844 }
1845 if (deep == 0)
1846 return;
1847 ++recurse;
1848
1849 // lock/unlock the item itself
1850 if (lock)
1851 tv->v_lock |= VAR_LOCKED;
1852 else
1853 tv->v_lock &= ~VAR_LOCKED;
1854
1855 switch (tv->v_type)
1856 {
1857 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02001858 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001859 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001860 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001861 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001862 case VAR_STRING:
1863 case VAR_FUNC:
1864 case VAR_PARTIAL:
1865 case VAR_FLOAT:
1866 case VAR_SPECIAL:
1867 case VAR_JOB:
1868 case VAR_CHANNEL:
1869 break;
1870
1871 case VAR_BLOB:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001872 if ((b = tv->vval.v_blob) != NULL
1873 && !(check_refcount && b->bv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001874 {
1875 if (lock)
1876 b->bv_lock |= VAR_LOCKED;
1877 else
1878 b->bv_lock &= ~VAR_LOCKED;
1879 }
1880 break;
1881 case VAR_LIST:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001882 if ((l = tv->vval.v_list) != NULL
1883 && !(check_refcount && l->lv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001884 {
1885 if (lock)
1886 l->lv_lock |= VAR_LOCKED;
1887 else
1888 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001889 if ((deep < 0 || deep > 1) && l->lv_first != &range_list_item)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001890 // recursive: lock/unlock the items the List contains
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001891 FOR_ALL_LIST_ITEMS(l, li)
Bram Moolenaar021bda52020-08-17 21:07:22 +02001892 item_lock(&li->li_tv, deep - 1, lock, check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001893 }
1894 break;
1895 case VAR_DICT:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001896 if ((d = tv->vval.v_dict) != NULL
1897 && !(check_refcount && d->dv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001898 {
1899 if (lock)
1900 d->dv_lock |= VAR_LOCKED;
1901 else
1902 d->dv_lock &= ~VAR_LOCKED;
1903 if (deep < 0 || deep > 1)
1904 {
1905 // recursive: lock/unlock the items the List contains
1906 todo = (int)d->dv_hashtab.ht_used;
1907 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
1908 {
1909 if (!HASHITEM_EMPTY(hi))
1910 {
1911 --todo;
Bram Moolenaar021bda52020-08-17 21:07:22 +02001912 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock,
1913 check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001914 }
1915 }
1916 }
1917 }
1918 }
1919 --recurse;
1920}
1921
Bram Moolenaarda6c0332019-09-01 16:01:30 +02001922#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
1923/*
1924 * Delete all "menutrans_" variables.
1925 */
1926 void
1927del_menutrans_vars(void)
1928{
1929 hashitem_T *hi;
1930 int todo;
1931
1932 hash_lock(&globvarht);
1933 todo = (int)globvarht.ht_used;
1934 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
1935 {
1936 if (!HASHITEM_EMPTY(hi))
1937 {
1938 --todo;
1939 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
1940 delete_var(&globvarht, hi);
1941 }
1942 }
1943 hash_unlock(&globvarht);
1944}
1945#endif
1946
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001947/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001948 * Local string buffer for the next two functions to store a variable name
1949 * with its prefix. Allocated in cat_prefix_varname(), freed later in
1950 * get_user_var_name().
1951 */
1952
1953static char_u *varnamebuf = NULL;
1954static int varnamebuflen = 0;
1955
1956/*
1957 * Function to concatenate a prefix and a variable name.
1958 */
Bram Moolenaar1bb4de52021-01-13 19:48:46 +01001959 char_u *
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001960cat_prefix_varname(int prefix, char_u *name)
1961{
1962 int len;
1963
1964 len = (int)STRLEN(name) + 3;
1965 if (len > varnamebuflen)
1966 {
1967 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02001968 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001969 varnamebuf = alloc(len);
1970 if (varnamebuf == NULL)
1971 {
1972 varnamebuflen = 0;
1973 return NULL;
1974 }
1975 varnamebuflen = len;
1976 }
1977 *varnamebuf = prefix;
1978 varnamebuf[1] = ':';
1979 STRCPY(varnamebuf + 2, name);
1980 return varnamebuf;
1981}
1982
1983/*
1984 * Function given to ExpandGeneric() to obtain the list of user defined
1985 * (global/buffer/window/built-in) variable names.
1986 */
1987 char_u *
1988get_user_var_name(expand_T *xp, int idx)
1989{
1990 static long_u gdone;
1991 static long_u bdone;
1992 static long_u wdone;
1993 static long_u tdone;
1994 static int vidx;
1995 static hashitem_T *hi;
1996 hashtab_T *ht;
1997
1998 if (idx == 0)
1999 {
2000 gdone = bdone = wdone = vidx = 0;
2001 tdone = 0;
2002 }
2003
2004 // Global variables
2005 if (gdone < globvarht.ht_used)
2006 {
2007 if (gdone++ == 0)
2008 hi = globvarht.ht_array;
2009 else
2010 ++hi;
2011 while (HASHITEM_EMPTY(hi))
2012 ++hi;
2013 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
2014 return cat_prefix_varname('g', hi->hi_key);
2015 return hi->hi_key;
2016 }
2017
2018 // b: variables
Bram Moolenaar4ff2f2f2020-10-25 13:22:42 +01002019 ht =
2020#ifdef FEAT_CMDWIN
2021 // In cmdwin, the alternative buffer should be used.
2022 (cmdwin_type != 0 && get_cmdline_type() == NUL) ?
2023 &prevwin->w_buffer->b_vars->dv_hashtab :
2024#endif
2025 &curbuf->b_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002026 if (bdone < ht->ht_used)
2027 {
2028 if (bdone++ == 0)
2029 hi = ht->ht_array;
2030 else
2031 ++hi;
2032 while (HASHITEM_EMPTY(hi))
2033 ++hi;
2034 return cat_prefix_varname('b', hi->hi_key);
2035 }
2036
2037 // w: variables
Bram Moolenaar4ff2f2f2020-10-25 13:22:42 +01002038 ht =
2039#ifdef FEAT_CMDWIN
2040 // In cmdwin, the alternative window should be used.
2041 (cmdwin_type != 0 && get_cmdline_type() == NUL) ?
2042 &prevwin->w_vars->dv_hashtab :
2043#endif
2044 &curwin->w_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002045 if (wdone < ht->ht_used)
2046 {
2047 if (wdone++ == 0)
2048 hi = ht->ht_array;
2049 else
2050 ++hi;
2051 while (HASHITEM_EMPTY(hi))
2052 ++hi;
2053 return cat_prefix_varname('w', hi->hi_key);
2054 }
2055
2056 // t: variables
2057 ht = &curtab->tp_vars->dv_hashtab;
2058 if (tdone < ht->ht_used)
2059 {
2060 if (tdone++ == 0)
2061 hi = ht->ht_array;
2062 else
2063 ++hi;
2064 while (HASHITEM_EMPTY(hi))
2065 ++hi;
2066 return cat_prefix_varname('t', hi->hi_key);
2067 }
2068
2069 // v: variables
2070 if (vidx < VV_LEN)
2071 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
2072
2073 VIM_CLEAR(varnamebuf);
2074 varnamebuflen = 0;
2075 return NULL;
2076}
2077
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002078 char *
2079get_var_special_name(int nr)
2080{
2081 switch (nr)
2082 {
Bram Moolenaara8b8af12021-01-01 15:11:04 +01002083 case VVAL_FALSE: return in_vim9script() ? "false" : "v:false";
2084 case VVAL_TRUE: return in_vim9script() ? "true" : "v:true";
Bram Moolenaar67977822021-01-03 21:53:53 +01002085 case VVAL_NULL: return in_vim9script() ? "null" : "v:null";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002086 case VVAL_NONE: return "v:none";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002087 }
2088 internal_error("get_var_special_name()");
2089 return "42";
2090}
2091
2092/*
2093 * Returns the global variable dictionary
2094 */
2095 dict_T *
2096get_globvar_dict(void)
2097{
2098 return &globvardict;
2099}
2100
2101/*
2102 * Returns the global variable hash table
2103 */
2104 hashtab_T *
2105get_globvar_ht(void)
2106{
2107 return &globvarht;
2108}
2109
2110/*
2111 * Returns the v: variable dictionary
2112 */
2113 dict_T *
2114get_vimvar_dict(void)
2115{
2116 return &vimvardict;
2117}
2118
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002119/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002120 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002121 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002122 */
2123 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002124find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002125{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002126 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2127 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002128
2129 if (di == NULL)
2130 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002131 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002132 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2133 return (int)(vv - vimvars);
2134}
2135
2136
2137/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002138 * Set type of v: variable to "type".
2139 */
2140 void
2141set_vim_var_type(int idx, vartype_T type)
2142{
2143 vimvars[idx].vv_type = type;
2144}
2145
2146/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002147 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002148 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002149 */
2150 void
2151set_vim_var_nr(int idx, varnumber_T val)
2152{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002153 vimvars[idx].vv_nr = val;
2154}
2155
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002156 char *
2157get_vim_var_name(int idx)
2158{
2159 return vimvars[idx].vv_name;
2160}
2161
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002162/*
2163 * Get typval_T v: variable value.
2164 */
2165 typval_T *
2166get_vim_var_tv(int idx)
2167{
2168 return &vimvars[idx].vv_tv;
2169}
2170
2171/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002172 * Set v: variable to "tv". Only accepts the same type.
2173 * Takes over the value of "tv".
2174 */
2175 int
2176set_vim_var_tv(int idx, typval_T *tv)
2177{
2178 if (vimvars[idx].vv_type != tv->v_type)
2179 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002180 emsg(_(e_type_mismatch_for_v_variable));
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002181 clear_tv(tv);
2182 return FAIL;
2183 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002184 // VV_RO is also checked when compiling, but let's check here as well.
2185 if (vimvars[idx].vv_flags & VV_RO)
2186 {
2187 semsg(_(e_readonlyvar), vimvars[idx].vv_name);
2188 return FAIL;
2189 }
2190 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2191 {
2192 semsg(_(e_readonlysbx), vimvars[idx].vv_name);
2193 return FAIL;
2194 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002195 clear_tv(&vimvars[idx].vv_di.di_tv);
2196 vimvars[idx].vv_di.di_tv = *tv;
2197 return OK;
2198}
2199
2200/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002201 * Get number v: variable value.
2202 */
2203 varnumber_T
2204get_vim_var_nr(int idx)
2205{
2206 return vimvars[idx].vv_nr;
2207}
2208
2209/*
2210 * Get string v: variable value. Uses a static buffer, can only be used once.
2211 * If the String variable has never been set, return an empty string.
2212 * Never returns NULL;
2213 */
2214 char_u *
2215get_vim_var_str(int idx)
2216{
2217 return tv_get_string(&vimvars[idx].vv_tv);
2218}
2219
2220/*
2221 * Get List v: variable value. Caller must take care of reference count when
2222 * needed.
2223 */
2224 list_T *
2225get_vim_var_list(int idx)
2226{
2227 return vimvars[idx].vv_list;
2228}
2229
2230/*
2231 * Get Dict v: variable value. Caller must take care of reference count when
2232 * needed.
2233 */
2234 dict_T *
2235get_vim_var_dict(int idx)
2236{
2237 return vimvars[idx].vv_dict;
2238}
2239
2240/*
2241 * Set v:char to character "c".
2242 */
2243 void
2244set_vim_var_char(int c)
2245{
2246 char_u buf[MB_MAXBYTES + 1];
2247
2248 if (has_mbyte)
2249 buf[(*mb_char2bytes)(c, buf)] = NUL;
2250 else
2251 {
2252 buf[0] = c;
2253 buf[1] = NUL;
2254 }
2255 set_vim_var_string(VV_CHAR, buf, -1);
2256}
2257
2258/*
2259 * Set v:count to "count" and v:count1 to "count1".
2260 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2261 */
2262 void
2263set_vcount(
2264 long count,
2265 long count1,
2266 int set_prevcount)
2267{
2268 if (set_prevcount)
2269 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2270 vimvars[VV_COUNT].vv_nr = count;
2271 vimvars[VV_COUNT1].vv_nr = count1;
2272}
2273
2274/*
2275 * Save variables that might be changed as a side effect. Used when executing
2276 * a timer callback.
2277 */
2278 void
2279save_vimvars(vimvars_save_T *vvsave)
2280{
2281 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2282 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2283 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2284}
2285
2286/*
2287 * Restore variables saved by save_vimvars().
2288 */
2289 void
2290restore_vimvars(vimvars_save_T *vvsave)
2291{
2292 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2293 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2294 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2295}
2296
2297/*
2298 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2299 * value.
2300 */
2301 void
2302set_vim_var_string(
2303 int idx,
2304 char_u *val,
2305 int len) // length of "val" to use or -1 (whole string)
2306{
2307 clear_tv(&vimvars[idx].vv_di.di_tv);
2308 vimvars[idx].vv_type = VAR_STRING;
2309 if (val == NULL)
2310 vimvars[idx].vv_str = NULL;
2311 else if (len == -1)
2312 vimvars[idx].vv_str = vim_strsave(val);
2313 else
2314 vimvars[idx].vv_str = vim_strnsave(val, len);
2315}
2316
2317/*
2318 * Set List v: variable to "val".
2319 */
2320 void
2321set_vim_var_list(int idx, list_T *val)
2322{
2323 clear_tv(&vimvars[idx].vv_di.di_tv);
2324 vimvars[idx].vv_type = VAR_LIST;
2325 vimvars[idx].vv_list = val;
2326 if (val != NULL)
2327 ++val->lv_refcount;
2328}
2329
2330/*
2331 * Set Dictionary v: variable to "val".
2332 */
2333 void
2334set_vim_var_dict(int idx, dict_T *val)
2335{
2336 clear_tv(&vimvars[idx].vv_di.di_tv);
2337 vimvars[idx].vv_type = VAR_DICT;
2338 vimvars[idx].vv_dict = val;
2339 if (val != NULL)
2340 {
2341 ++val->dv_refcount;
2342 dict_set_items_ro(val);
2343 }
2344}
2345
2346/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002347 * Set the v:argv list.
2348 */
2349 void
2350set_argv_var(char **argv, int argc)
2351{
2352 list_T *l = list_alloc();
2353 int i;
2354
2355 if (l == NULL)
2356 getout(1);
2357 l->lv_lock = VAR_FIXED;
2358 for (i = 0; i < argc; ++i)
2359 {
2360 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2361 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002362 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002363 }
2364 set_vim_var_list(VV_ARGV, l);
2365}
2366
2367/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002368 * Reset v:register, taking the 'clipboard' setting into account.
2369 */
2370 void
2371reset_reg_var(void)
2372{
2373 int regname = 0;
2374
2375 // Adjust the register according to 'clipboard', so that when
2376 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2377#ifdef FEAT_CLIPBOARD
2378 adjust_clip_reg(&regname);
2379#endif
2380 set_reg_var(regname);
2381}
2382
2383/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002384 * Set v:register if needed.
2385 */
2386 void
2387set_reg_var(int c)
2388{
2389 char_u regname;
2390
2391 if (c == 0 || c == ' ')
2392 regname = '"';
2393 else
2394 regname = c;
2395 // Avoid free/alloc when the value is already right.
2396 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2397 set_vim_var_string(VV_REG, &regname, 1);
2398}
2399
2400/*
2401 * Get or set v:exception. If "oldval" == NULL, return the current value.
2402 * Otherwise, restore the value to "oldval" and return NULL.
2403 * Must always be called in pairs to save and restore v:exception! Does not
2404 * take care of memory allocations.
2405 */
2406 char_u *
2407v_exception(char_u *oldval)
2408{
2409 if (oldval == NULL)
2410 return vimvars[VV_EXCEPTION].vv_str;
2411
2412 vimvars[VV_EXCEPTION].vv_str = oldval;
2413 return NULL;
2414}
2415
2416/*
2417 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2418 * Otherwise, restore the value to "oldval" and return NULL.
2419 * Must always be called in pairs to save and restore v:throwpoint! Does not
2420 * take care of memory allocations.
2421 */
2422 char_u *
2423v_throwpoint(char_u *oldval)
2424{
2425 if (oldval == NULL)
2426 return vimvars[VV_THROWPOINT].vv_str;
2427
2428 vimvars[VV_THROWPOINT].vv_str = oldval;
2429 return NULL;
2430}
2431
2432/*
2433 * Set v:cmdarg.
2434 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2435 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2436 * Must always be called in pairs!
2437 */
2438 char_u *
2439set_cmdarg(exarg_T *eap, char_u *oldarg)
2440{
2441 char_u *oldval;
2442 char_u *newval;
2443 unsigned len;
2444
2445 oldval = vimvars[VV_CMDARG].vv_str;
2446 if (eap == NULL)
2447 {
2448 vim_free(oldval);
2449 vimvars[VV_CMDARG].vv_str = oldarg;
2450 return NULL;
2451 }
2452
2453 if (eap->force_bin == FORCE_BIN)
2454 len = 6;
2455 else if (eap->force_bin == FORCE_NOBIN)
2456 len = 8;
2457 else
2458 len = 0;
2459
2460 if (eap->read_edit)
2461 len += 7;
2462
2463 if (eap->force_ff != 0)
2464 len += 10; // " ++ff=unix"
2465 if (eap->force_enc != 0)
2466 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2467 if (eap->bad_char != 0)
2468 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2469
2470 newval = alloc(len + 1);
2471 if (newval == NULL)
2472 return NULL;
2473
2474 if (eap->force_bin == FORCE_BIN)
2475 sprintf((char *)newval, " ++bin");
2476 else if (eap->force_bin == FORCE_NOBIN)
2477 sprintf((char *)newval, " ++nobin");
2478 else
2479 *newval = NUL;
2480
2481 if (eap->read_edit)
2482 STRCAT(newval, " ++edit");
2483
2484 if (eap->force_ff != 0)
2485 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2486 eap->force_ff == 'u' ? "unix"
2487 : eap->force_ff == 'd' ? "dos"
2488 : "mac");
2489 if (eap->force_enc != 0)
2490 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2491 eap->cmd + eap->force_enc);
2492 if (eap->bad_char == BAD_KEEP)
2493 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2494 else if (eap->bad_char == BAD_DROP)
2495 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2496 else if (eap->bad_char != 0)
2497 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2498 vimvars[VV_CMDARG].vv_str = newval;
2499 return oldval;
2500}
2501
2502/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002503 * Get the value of internal variable "name".
2504 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2505 */
2506 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002507eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002508 char_u *name,
2509 int len, // length of "name"
2510 typval_T *rettv, // NULL when only checking existence
2511 dictitem_T **dip, // non-NULL when typval's dict item is needed
2512 int verbose, // may give error message
2513 int no_autoload) // do not use script autoloading
2514{
2515 int ret = OK;
2516 typval_T *tv = NULL;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002517 int foundFunc = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002518 dictitem_T *v;
2519 int cc;
2520
2521 // truncate the name, so that we can use strcmp()
2522 cc = name[len];
2523 name[len] = NUL;
2524
2525 // Check for user-defined variables.
2526 v = find_var(name, NULL, no_autoload);
2527 if (v != NULL)
2528 {
2529 tv = &v->di_tv;
2530 if (dip != NULL)
2531 *dip = v;
2532 }
2533
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002534 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002535 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002536 imported_T *import;
2537 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
2538
2539 import = find_imported(p, 0, NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002540
2541 // imported variable from another script
2542 if (import != NULL)
2543 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002544 if (import->imp_funcname != NULL)
2545 {
2546 foundFunc = TRUE;
2547 if (rettv != NULL)
2548 {
2549 rettv->v_type = VAR_FUNC;
2550 rettv->vval.v_string = vim_strsave(import->imp_funcname);
2551 }
2552 }
Bram Moolenaara6294952020-12-27 13:39:50 +01002553 else if (import->imp_flags & IMP_FLAGS_STAR)
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002554 {
2555 emsg("Sorry, 'import * as X' not implemented yet");
2556 ret = FAIL;
2557 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002558 else
2559 {
2560 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02002561 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002562 + import->imp_var_vals_idx;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002563 tv = sv->sv_tv;
2564 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002565 }
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002566 else if (in_vim9script())
2567 {
2568 ufunc_T *ufunc = find_func(name, FALSE, NULL);
2569
2570 if (ufunc != NULL)
2571 {
2572 foundFunc = TRUE;
2573 if (rettv != NULL)
2574 {
2575 rettv->v_type = VAR_FUNC;
2576 rettv->vval.v_string = vim_strsave(ufunc->uf_name);
2577 }
2578 }
2579 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002580 }
2581
Bram Moolenaarc620c052020-07-08 15:16:19 +02002582 if (!foundFunc)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002583 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002584 if (tv == NULL)
2585 {
2586 if (rettv != NULL && verbose)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002587 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarc620c052020-07-08 15:16:19 +02002588 ret = FAIL;
2589 }
2590 else if (rettv != NULL)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002591 {
2592 // If a list or dict variable wasn't initialized, do it now.
2593 if (tv->v_type == VAR_DICT && tv->vval.v_dict == NULL)
2594 {
2595 tv->vval.v_dict = dict_alloc();
2596 if (tv->vval.v_dict != NULL)
2597 ++tv->vval.v_dict->dv_refcount;
2598 }
2599 else if (tv->v_type == VAR_LIST && tv->vval.v_list == NULL)
2600 {
2601 tv->vval.v_list = list_alloc();
2602 if (tv->vval.v_list != NULL)
2603 ++tv->vval.v_list->lv_refcount;
2604 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002605 copy_tv(tv, rettv);
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002606 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002607 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002608
2609 name[len] = cc;
2610
2611 return ret;
2612}
2613
2614/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002615 * Check if variable "name[len]" is a local variable or an argument.
2616 * If so, "*eval_lavars_used" is set to TRUE.
2617 */
2618 void
2619check_vars(char_u *name, int len)
2620{
2621 int cc;
2622 char_u *varname;
2623 hashtab_T *ht;
2624
2625 if (eval_lavars_used == NULL)
2626 return;
2627
2628 // truncate the name, so that we can use strcmp()
2629 cc = name[len];
2630 name[len] = NUL;
2631
2632 ht = find_var_ht(name, &varname);
2633 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
2634 {
2635 if (find_var(name, NULL, TRUE) != NULL)
2636 *eval_lavars_used = TRUE;
2637 }
2638
2639 name[len] = cc;
2640}
2641
2642/*
2643 * Find variable "name" in the list of variables.
2644 * Return a pointer to it if found, NULL if not found.
2645 * Careful: "a:0" variables don't have a name.
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002646 * When "htp" is not NULL set "htp" to the hashtab_T used.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002647 */
2648 dictitem_T *
2649find_var(char_u *name, hashtab_T **htp, int no_autoload)
2650{
2651 char_u *varname;
2652 hashtab_T *ht;
2653 dictitem_T *ret = NULL;
2654
2655 ht = find_var_ht(name, &varname);
2656 if (htp != NULL)
2657 *htp = ht;
2658 if (ht == NULL)
2659 return NULL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002660 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002661 if (ret != NULL)
2662 return ret;
2663
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002664 // Search in parent scope for lambda
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002665 ret = find_var_in_scoped_ht(name, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01002666 if (ret != NULL)
2667 return ret;
2668
2669 // in Vim9 script items without a scope can be script-local
2670 if (in_vim9script() && name[0] != NUL && name[1] != ':')
2671 {
2672 ht = get_script_local_ht();
2673 if (ht != NULL)
2674 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002675 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01002676 if (ret != NULL)
2677 {
2678 if (htp != NULL)
2679 *htp = ht;
2680 return ret;
2681 }
2682 }
2683 }
2684
2685 return NULL;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002686}
2687
2688/*
2689 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02002690 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002691 * Returns NULL if not found.
2692 */
2693 dictitem_T *
2694find_var_in_ht(
2695 hashtab_T *ht,
2696 int htname,
2697 char_u *varname,
2698 int no_autoload)
2699{
2700 hashitem_T *hi;
2701
2702 if (*varname == NUL)
2703 {
2704 // Must be something like "s:", otherwise "ht" would be NULL.
2705 switch (htname)
2706 {
2707 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
2708 case 'g': return &globvars_var;
2709 case 'v': return &vimvars_var;
2710 case 'b': return &curbuf->b_bufvar;
2711 case 'w': return &curwin->w_winvar;
2712 case 't': return &curtab->tp_winvar;
2713 case 'l': return get_funccal_local_var();
2714 case 'a': return get_funccal_args_var();
2715 }
2716 return NULL;
2717 }
2718
2719 hi = hash_find(ht, varname);
2720 if (HASHITEM_EMPTY(hi))
2721 {
2722 // For global variables we may try auto-loading the script. If it
2723 // worked find the variable again. Don't auto-load a script if it was
2724 // loaded already, otherwise it would be loaded every time when
2725 // checking if a function name is a Funcref variable.
2726 if (ht == &globvarht && !no_autoload)
2727 {
2728 // Note: script_autoload() may make "hi" invalid. It must either
2729 // be obtained again or not used.
2730 if (!script_autoload(varname, FALSE) || aborting())
2731 return NULL;
2732 hi = hash_find(ht, varname);
2733 }
2734 if (HASHITEM_EMPTY(hi))
2735 return NULL;
2736 }
2737 return HI2DI(hi);
2738}
2739
2740/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002741 * Get the script-local hashtab. NULL if not in a script context.
2742 */
Bram Moolenaar922acbd2020-10-08 21:30:40 +02002743 hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002744get_script_local_ht(void)
2745{
2746 scid_T sid = current_sctx.sc_sid;
2747
Bram Moolenaare3d46852020-08-29 13:39:17 +02002748 if (SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002749 return &SCRIPT_VARS(sid);
2750 return NULL;
2751}
2752
2753/*
2754 * Look for "name[len]" in script-local variables.
Bram Moolenaar709664c2020-12-12 14:33:41 +01002755 * Return OK when found, FAIL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002756 */
Bram Moolenaar709664c2020-12-12 14:33:41 +01002757 int
2758lookup_scriptvar(
2759 char_u *name,
2760 size_t len,
2761 void *lvar UNUSED,
2762 cctx_T *dummy UNUSED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002763{
2764 hashtab_T *ht = get_script_local_ht();
2765 char_u buffer[30];
2766 char_u *p;
Bram Moolenaar709664c2020-12-12 14:33:41 +01002767 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002768 hashitem_T *hi;
2769
2770 if (ht == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01002771 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002772 if (len < sizeof(buffer) - 1)
2773 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02002774 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002775 vim_strncpy(buffer, name, len);
2776 p = buffer;
2777 }
2778 else
2779 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002780 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002781 if (p == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01002782 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002783 }
2784
2785 hi = hash_find(ht, p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01002786 res = HASHITEM_EMPTY(hi) ? FAIL : OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002787
2788 // if not script-local, then perhaps imported
Bram Moolenaar709664c2020-12-12 14:33:41 +01002789 if (res == FAIL && find_imported(p, 0, NULL) != NULL)
2790 res = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002791
2792 if (p != buffer)
2793 vim_free(p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01002794 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002795}
2796
2797/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002798 * Find the hashtab used for a variable name.
2799 * Return NULL if the name is not valid.
2800 * Set "varname" to the start of name without ':'.
2801 */
2802 hashtab_T *
2803find_var_ht(char_u *name, char_u **varname)
2804{
2805 hashitem_T *hi;
2806 hashtab_T *ht;
2807
2808 if (name[0] == NUL)
2809 return NULL;
2810 if (name[1] != ':')
2811 {
2812 // The name must not start with a colon or #.
2813 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
2814 return NULL;
2815 *varname = name;
2816
2817 // "version" is "v:version" in all scopes if scriptversion < 3.
2818 // Same for a few other variables marked with VV_COMPAT.
2819 if (current_sctx.sc_version < 3)
2820 {
2821 hi = hash_find(&compat_hashtab, name);
2822 if (!HASHITEM_EMPTY(hi))
2823 return &compat_hashtab;
2824 }
2825
2826 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002827 if (ht != NULL)
2828 return ht; // local variable
2829
2830 // in Vim9 script items at the script level are script-local
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002831 if (in_vim9script())
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002832 {
2833 ht = get_script_local_ht();
2834 if (ht != NULL)
2835 return ht;
2836 }
2837
2838 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002839 }
2840 *varname = name + 2;
2841 if (*name == 'g') // global variable
2842 return &globvarht;
2843 // There must be no ':' or '#' in the rest of the name, unless g: is used
2844 if (vim_strchr(name + 2, ':') != NULL
2845 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
2846 return NULL;
2847 if (*name == 'b') // buffer variable
2848 return &curbuf->b_vars->dv_hashtab;
2849 if (*name == 'w') // window variable
2850 return &curwin->w_vars->dv_hashtab;
2851 if (*name == 't') // tab page variable
2852 return &curtab->tp_vars->dv_hashtab;
2853 if (*name == 'v') // v: variable
2854 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002855 if (get_current_funccal() != NULL
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002856 && get_current_funccal()->func->uf_def_status == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002857 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002858 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002859 if (*name == 'a') // a: function argument
2860 return get_funccal_args_ht();
2861 if (*name == 'l') // l: local function variable
2862 return get_funccal_local_ht();
2863 }
2864 if (*name == 's') // script variable
2865 {
2866 ht = get_script_local_ht();
2867 if (ht != NULL)
2868 return ht;
2869 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002870 return NULL;
2871}
2872
2873/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002874 * Get the string value of a (global/local) variable.
2875 * Note: see tv_get_string() for how long the pointer remains valid.
2876 * Returns NULL when it doesn't exist.
2877 */
2878 char_u *
2879get_var_value(char_u *name)
2880{
2881 dictitem_T *v;
2882
2883 v = find_var(name, NULL, FALSE);
2884 if (v == NULL)
2885 return NULL;
2886 return tv_get_string(&v->di_tv);
2887}
2888
2889/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002890 * Allocate a new hashtab for a sourced script. It will be used while
2891 * sourcing this script and when executing functions defined in the script.
2892 */
2893 void
2894new_script_vars(scid_T id)
2895{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002896 scriptvar_T *sv;
2897
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01002898 sv = ALLOC_CLEAR_ONE(scriptvar_T);
2899 if (sv == NULL)
2900 return;
2901 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01002902 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002903}
2904
2905/*
2906 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
2907 * point to it.
2908 */
2909 void
2910init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
2911{
2912 hash_init(&dict->dv_hashtab);
2913 dict->dv_lock = 0;
2914 dict->dv_scope = scope;
2915 dict->dv_refcount = DO_NOT_FREE_CNT;
2916 dict->dv_copyID = 0;
2917 dict_var->di_tv.vval.v_dict = dict;
2918 dict_var->di_tv.v_type = VAR_DICT;
2919 dict_var->di_tv.v_lock = VAR_FIXED;
2920 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2921 dict_var->di_key[0] = NUL;
2922}
2923
2924/*
2925 * Unreference a dictionary initialized by init_var_dict().
2926 */
2927 void
2928unref_var_dict(dict_T *dict)
2929{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002930 // Now the dict needs to be freed if no one else is using it, go back to
2931 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002932 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
2933 dict_unref(dict);
2934}
2935
2936/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002937 * Clean up a list of internal variables.
2938 * Frees all allocated variables and the value they contain.
2939 * Clears hashtab "ht", does not free it.
2940 */
2941 void
2942vars_clear(hashtab_T *ht)
2943{
2944 vars_clear_ext(ht, TRUE);
2945}
2946
2947/*
2948 * Like vars_clear(), but only free the value if "free_val" is TRUE.
2949 */
2950 void
2951vars_clear_ext(hashtab_T *ht, int free_val)
2952{
2953 int todo;
2954 hashitem_T *hi;
2955 dictitem_T *v;
2956
2957 hash_lock(ht);
2958 todo = (int)ht->ht_used;
2959 for (hi = ht->ht_array; todo > 0; ++hi)
2960 {
2961 if (!HASHITEM_EMPTY(hi))
2962 {
2963 --todo;
2964
2965 // Free the variable. Don't remove it from the hashtab,
2966 // ht_array might change then. hash_clear() takes care of it
2967 // later.
2968 v = HI2DI(hi);
2969 if (free_val)
2970 clear_tv(&v->di_tv);
2971 if (v->di_flags & DI_FLAGS_ALLOC)
2972 vim_free(v);
2973 }
2974 }
2975 hash_clear(ht);
Bram Moolenaar8d739de2020-10-14 19:39:19 +02002976 hash_init(ht);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002977}
2978
2979/*
2980 * Delete a variable from hashtab "ht" at item "hi".
2981 * Clear the variable value and free the dictitem.
2982 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002983 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002984delete_var(hashtab_T *ht, hashitem_T *hi)
2985{
2986 dictitem_T *di = HI2DI(hi);
2987
2988 hash_remove(ht, hi);
2989 clear_tv(&di->di_tv);
2990 vim_free(di);
2991}
2992
2993/*
2994 * List the value of one internal variable.
2995 */
2996 static void
2997list_one_var(dictitem_T *v, char *prefix, int *first)
2998{
2999 char_u *tofree;
3000 char_u *s;
3001 char_u numbuf[NUMBUFLEN];
3002
3003 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
3004 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
3005 s == NULL ? (char_u *)"" : s, first);
3006 vim_free(tofree);
3007}
3008
3009 static void
3010list_one_var_a(
3011 char *prefix,
3012 char_u *name,
3013 int type,
3014 char_u *string,
3015 int *first) // when TRUE clear rest of screen and set to FALSE
3016{
3017 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
3018 msg_start();
3019 msg_puts(prefix);
3020 if (name != NULL) // "a:" vars don't have a name stored
3021 msg_puts((char *)name);
3022 msg_putchar(' ');
3023 msg_advance(22);
3024 if (type == VAR_NUMBER)
3025 msg_putchar('#');
3026 else if (type == VAR_FUNC || type == VAR_PARTIAL)
3027 msg_putchar('*');
3028 else if (type == VAR_LIST)
3029 {
3030 msg_putchar('[');
3031 if (*string == '[')
3032 ++string;
3033 }
3034 else if (type == VAR_DICT)
3035 {
3036 msg_putchar('{');
3037 if (*string == '{')
3038 ++string;
3039 }
3040 else
3041 msg_putchar(' ');
3042
3043 msg_outtrans(string);
3044
3045 if (type == VAR_FUNC || type == VAR_PARTIAL)
3046 msg_puts("()");
3047 if (*first)
3048 {
3049 msg_clr_eos();
3050 *first = FALSE;
3051 }
3052}
3053
3054/*
3055 * Set variable "name" to value in "tv".
3056 * If the variable already exists, the value is updated.
3057 * Otherwise the variable is created.
3058 */
3059 void
3060set_var(
3061 char_u *name,
3062 typval_T *tv,
3063 int copy) // make copy of value in "tv"
3064{
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003065 set_var_const(name, NULL, tv, copy, ASSIGN_DECL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003066}
3067
3068/*
3069 * Set variable "name" to value in "tv".
3070 * If the variable already exists and "is_const" is FALSE the value is updated.
3071 * Otherwise the variable is created.
3072 */
3073 void
3074set_var_const(
3075 char_u *name,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003076 type_T *type,
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003077 typval_T *tv_arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003078 int copy, // make copy of value in "tv"
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003079 int flags) // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003080{
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003081 typval_T *tv = tv_arg;
3082 typval_T bool_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003083 dictitem_T *di;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003084 char_u *varname;
3085 hashtab_T *ht;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003086 int is_script_local;
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003087 int vim9script = in_vim9script();
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003088
3089 ht = find_var_ht(name, &varname);
3090 if (ht == NULL || *varname == NUL)
3091 {
3092 semsg(_(e_illvar), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003093 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003094 }
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003095 is_script_local = ht == get_script_local_ht();
3096
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003097 if (vim9script
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003098 && !is_script_local
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003099 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003100 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003101 && name[1] == ':')
Bram Moolenaar67979662020-06-20 22:50:47 +02003102 {
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003103 vim9_declare_error(name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003104 goto failed;
Bram Moolenaar67979662020-06-20 22:50:47 +02003105 }
3106
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003107 di = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003108
3109 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003110 if (di == NULL)
3111 di = find_var_in_scoped_ht(name, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003112
3113 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
Bram Moolenaar98b4f142020-08-08 15:46:01 +02003114 && var_wrong_func_name(name, di == NULL))
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003115 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003116
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003117 if (need_convert_to_bool(type, tv))
3118 {
3119 // Destination is a bool and the value is not, but it can be converted.
3120 CLEAR_FIELD(bool_tv);
3121 bool_tv.v_type = VAR_BOOL;
3122 bool_tv.vval.v_number = tv2bool(tv) ? VVAL_TRUE : VVAL_FALSE;
3123 tv = &bool_tv;
3124 }
3125
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003126 if (di != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003127 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003128 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003129 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003130 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003131 {
3132 emsg(_(e_cannot_mod));
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003133 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003134 }
3135
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003136 if (is_script_local && vim9script)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003137 {
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003138 if ((flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0)
Bram Moolenaar34db91f2020-06-13 19:00:10 +02003139 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003140 semsg(_(e_redefining_script_item_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003141 goto failed;
Bram Moolenaar34db91f2020-06-13 19:00:10 +02003142 }
3143
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003144 // check the type and adjust to bool if needed
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02003145 if (check_script_var_type(&di->di_tv, tv, name) == FAIL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003146 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003147 }
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02003148
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003149 if (var_check_permission(di, name) == FAIL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003150 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003151 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003152 else
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003153 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003154 // can only redefine once
3155 di->di_flags &= ~DI_FLAGS_RELOAD;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003156
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003157 // A Vim9 script-local variable is also present in sn_all_vars and
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003158 // sn_var_vals. It may set "type" from "tv".
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003159 if (is_script_local && vim9script)
Bram Moolenaar08251752021-01-11 21:20:18 +01003160 update_vim9_script_var(FALSE, di, flags, tv, &type);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003161 }
3162
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003163 // existing variable, need to clear the value
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003164
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003165 // Handle setting internal di: variables separately where needed to
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003166 // prevent changing the type.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003167 if (ht == &vimvarht)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003168 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003169 if (di->di_tv.v_type == VAR_STRING)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003170 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003171 VIM_CLEAR(di->di_tv.vval.v_string);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003172 if (copy || tv->v_type != VAR_STRING)
3173 {
3174 char_u *val = tv_get_string(tv);
3175
3176 // Careful: when assigning to v:errmsg and tv_get_string()
Bram Moolenaar4b96df52020-01-26 22:00:26 +01003177 // causes an error message the variable will already be set.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003178 if (di->di_tv.vval.v_string == NULL)
3179 di->di_tv.vval.v_string = vim_strsave(val);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003180 }
3181 else
3182 {
3183 // Take over the string to avoid an extra alloc/free.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003184 di->di_tv.vval.v_string = tv->vval.v_string;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003185 tv->vval.v_string = NULL;
3186 }
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003187 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003188 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003189 else if (di->di_tv.v_type == VAR_NUMBER)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003190 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003191 di->di_tv.vval.v_number = tv_get_number(tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003192 if (STRCMP(varname, "searchforward") == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003193 set_search_direction(di->di_tv.vval.v_number ? '/' : '?');
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003194#ifdef FEAT_SEARCH_EXTRA
3195 else if (STRCMP(varname, "hlsearch") == 0)
3196 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003197 no_hlsearch = !di->di_tv.vval.v_number;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003198 redraw_all_later(SOME_VALID);
3199 }
3200#endif
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003201 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003202 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003203 else if (di->di_tv.v_type != tv->v_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003204 {
3205 semsg(_("E963: setting %s to value with wrong type"), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003206 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003207 }
3208 }
3209
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003210 clear_tv(&di->di_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003211 }
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003212 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003213 {
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003214 // add a new variable
3215 if (vim9script && is_script_local && (flags & ASSIGN_NO_DECL))
3216 {
3217 semsg(_(e_unknown_variable_str), name);
3218 goto failed;
3219 }
3220
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003221 // Can't add "v:" or "a:" variable.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003222 if (ht == &vimvarht || ht == get_funccal_args_ht())
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003223 {
3224 semsg(_(e_illvar), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003225 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003226 }
3227
Bram Moolenaar03290b82020-12-19 16:30:44 +01003228 // Make sure the variable name is valid. In Vim9 script an autoload
3229 // variable must be prefixed with "g:".
3230 if (!valid_varname(varname, !vim9script
3231 || STRNCMP(name, "g:", 2) == 0))
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003232 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003233
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003234 di = alloc(sizeof(dictitem_T) + STRLEN(varname));
3235 if (di == NULL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003236 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003237 STRCPY(di->di_key, varname);
3238 if (hash_add(ht, DI2HIKEY(di)) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003239 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003240 vim_free(di);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003241 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003242 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003243 di->di_flags = DI_FLAGS_ALLOC;
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003244 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003245 di->di_flags |= DI_FLAGS_LOCK;
3246
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003247 // A Vim9 script-local variable is also added to sn_all_vars and
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003248 // sn_var_vals. It may set "type" from "tv".
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003249 if (is_script_local && vim9script)
Bram Moolenaar08251752021-01-11 21:20:18 +01003250 update_vim9_script_var(TRUE, di, flags, tv, &type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003251 }
3252
3253 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003254 copy_tv(tv, &di->di_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003255 else
3256 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003257 di->di_tv = *tv;
3258 di->di_tv.v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003259 init_tv(tv);
3260 }
3261
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003262 if (vim9script && type != NULL)
3263 {
3264 if (type->tt_type == VAR_DICT && di->di_tv.vval.v_dict != NULL)
3265 di->di_tv.vval.v_dict->dv_type = alloc_type(type);
3266 else if (type->tt_type == VAR_LIST && di->di_tv.vval.v_list != NULL)
3267 di->di_tv.vval.v_list->lv_type = alloc_type(type);
3268 }
3269
Bram Moolenaar1dcf55d2020-12-22 22:07:30 +01003270 // ":const var = value" locks the value
3271 // ":final var = value" locks "var"
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003272 if (flags & ASSIGN_CONST)
Bram Moolenaar021bda52020-08-17 21:07:22 +02003273 // Like :lockvar! name: lock the value and what it contains, but only
3274 // if the reference count is up to one. That locks only literal
3275 // values.
3276 item_lock(&di->di_tv, DICT_MAXNEST, TRUE, TRUE);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003277 return;
3278failed:
3279 if (!copy)
3280 clear_tv(tv_arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003281}
3282
3283/*
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003284 * Check in this order for backwards compatibility:
3285 * - Whether the variable is read-only
3286 * - Whether the variable value is locked
3287 * - Whether the variable is locked
3288 */
3289 int
3290var_check_permission(dictitem_T *di, char_u *name)
3291{
3292 if (var_check_ro(di->di_flags, name, FALSE)
3293 || value_check_lock(di->di_tv.v_lock, name, FALSE)
3294 || var_check_lock(di->di_flags, name, FALSE))
3295 return FAIL;
3296 return OK;
3297}
3298
3299/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003300 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
3301 * Also give an error message.
3302 */
3303 int
3304var_check_ro(int flags, char_u *name, int use_gettext)
3305{
3306 if (flags & DI_FLAGS_RO)
3307 {
3308 semsg(_(e_readonlyvar), use_gettext ? (char_u *)_(name) : name);
3309 return TRUE;
3310 }
3311 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
3312 {
3313 semsg(_(e_readonlysbx), use_gettext ? (char_u *)_(name) : name);
3314 return TRUE;
3315 }
3316 return FALSE;
3317}
3318
3319/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003320 * Return TRUE if di_flags "flags" indicates variable "name" is locked.
3321 * Also give an error message.
3322 */
3323 int
3324var_check_lock(int flags, char_u *name, int use_gettext)
3325{
3326 if (flags & DI_FLAGS_LOCK)
3327 {
3328 semsg(_(e_variable_is_locked_str),
3329 use_gettext ? (char_u *)_(name) : name);
3330 return TRUE;
3331 }
3332 return FALSE;
3333}
3334
3335/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003336 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
3337 * Also give an error message.
3338 */
3339 int
3340var_check_fixed(int flags, char_u *name, int use_gettext)
3341{
3342 if (flags & DI_FLAGS_FIX)
3343 {
3344 semsg(_("E795: Cannot delete variable %s"),
3345 use_gettext ? (char_u *)_(name) : name);
3346 return TRUE;
3347 }
3348 return FALSE;
3349}
3350
3351/*
3352 * Check if a funcref is assigned to a valid variable name.
3353 * Return TRUE and give an error if not.
3354 */
3355 int
Bram Moolenaar98b4f142020-08-08 15:46:01 +02003356var_wrong_func_name(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003357 char_u *name, // points to start of variable name
3358 int new_var) // TRUE when creating the variable
3359{
3360 // Allow for w: b: s: and t:.
3361 if (!(vim_strchr((char_u *)"wbst", name[0]) != NULL && name[1] == ':')
3362 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
3363 ? name[2] : name[0]))
3364 {
3365 semsg(_("E704: Funcref variable name must start with a capital: %s"),
3366 name);
3367 return TRUE;
3368 }
3369 // Don't allow hiding a function. When "v" is not NULL we might be
3370 // assigning another function to the same var, the type is checked
3371 // below.
3372 if (new_var && function_exists(name, FALSE))
3373 {
3374 semsg(_("E705: Variable name conflicts with existing function: %s"),
3375 name);
3376 return TRUE;
3377 }
3378 return FALSE;
3379}
3380
3381/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003382 * Return TRUE if "flags" indicates variable "name" has a locked (immutable)
3383 * value. Also give an error message, using "name" or _("name") when
3384 * "use_gettext" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003385 */
3386 int
Bram Moolenaara187c432020-09-16 21:08:28 +02003387value_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003388{
3389 if (lock & VAR_LOCKED)
3390 {
3391 semsg(_("E741: Value is locked: %s"),
3392 name == NULL ? (char_u *)_("Unknown")
3393 : use_gettext ? (char_u *)_(name)
3394 : name);
3395 return TRUE;
3396 }
3397 if (lock & VAR_FIXED)
3398 {
3399 semsg(_("E742: Cannot change value of %s"),
3400 name == NULL ? (char_u *)_("Unknown")
3401 : use_gettext ? (char_u *)_(name)
3402 : name);
3403 return TRUE;
3404 }
3405 return FALSE;
3406}
3407
3408/*
Bram Moolenaar03290b82020-12-19 16:30:44 +01003409 * Check if a variable name is valid. When "autoload" is true "#" is allowed.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003410 * Return FALSE and give an error if not.
3411 */
3412 int
Bram Moolenaar03290b82020-12-19 16:30:44 +01003413valid_varname(char_u *varname, int autoload)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003414{
3415 char_u *p;
3416
3417 for (p = varname; *p != NUL; ++p)
3418 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
Bram Moolenaar03290b82020-12-19 16:30:44 +01003419 && !(autoload && *p == AUTOLOAD_CHAR))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003420 {
3421 semsg(_(e_illvar), varname);
3422 return FALSE;
3423 }
3424 return TRUE;
3425}
3426
3427/*
3428 * getwinvar() and gettabwinvar()
3429 */
3430 static void
3431getwinvar(
3432 typval_T *argvars,
3433 typval_T *rettv,
3434 int off) // 1 for gettabwinvar()
3435{
3436 win_T *win;
3437 char_u *varname;
3438 dictitem_T *v;
3439 tabpage_T *tp = NULL;
3440 int done = FALSE;
3441 win_T *oldcurwin;
3442 tabpage_T *oldtabpage;
3443 int need_switch_win;
3444
3445 if (off == 1)
3446 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3447 else
3448 tp = curtab;
3449 win = find_win_by_nr(&argvars[off], tp);
3450 varname = tv_get_string_chk(&argvars[off + 1]);
3451 ++emsg_off;
3452
3453 rettv->v_type = VAR_STRING;
3454 rettv->vval.v_string = NULL;
3455
3456 if (win != NULL && varname != NULL)
3457 {
3458 // Set curwin to be our win, temporarily. Also set the tabpage,
3459 // otherwise the window is not valid. Only do this when needed,
3460 // autocommands get blocked.
3461 need_switch_win = !(tp == curtab && win == curwin);
3462 if (!need_switch_win
3463 || switch_win(&oldcurwin, &oldtabpage, win, tp, TRUE) == OK)
3464 {
3465 if (*varname == '&')
3466 {
3467 if (varname[1] == NUL)
3468 {
3469 // get all window-local options in a dict
3470 dict_T *opts = get_winbuf_options(FALSE);
3471
3472 if (opts != NULL)
3473 {
3474 rettv_dict_set(rettv, opts);
3475 done = TRUE;
3476 }
3477 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003478 else if (eval_option(&varname, rettv, 1) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003479 // window-local-option
3480 done = TRUE;
3481 }
3482 else
3483 {
3484 // Look up the variable.
3485 // Let getwinvar({nr}, "") return the "w:" dictionary.
3486 v = find_var_in_ht(&win->w_vars->dv_hashtab, 'w',
3487 varname, FALSE);
3488 if (v != NULL)
3489 {
3490 copy_tv(&v->di_tv, rettv);
3491 done = TRUE;
3492 }
3493 }
3494 }
3495
3496 if (need_switch_win)
3497 // restore previous notion of curwin
3498 restore_win(oldcurwin, oldtabpage, TRUE);
3499 }
3500
3501 if (!done && argvars[off + 2].v_type != VAR_UNKNOWN)
3502 // use the default return value
3503 copy_tv(&argvars[off + 2], rettv);
3504
3505 --emsg_off;
3506}
3507
3508/*
Bram Moolenaar191929b2020-08-19 21:20:49 +02003509 * Set option "varname" to the value of "varp" for the current buffer/window.
3510 */
3511 static void
3512set_option_from_tv(char_u *varname, typval_T *varp)
3513{
3514 long numval = 0;
3515 char_u *strval;
3516 char_u nbuf[NUMBUFLEN];
3517 int error = FALSE;
3518
Bram Moolenaar31a201a2021-01-03 14:47:25 +01003519 if (varp->v_type == VAR_BOOL)
Bram Moolenaarb0d81822021-01-03 15:55:10 +01003520 {
Bram Moolenaar31a201a2021-01-03 14:47:25 +01003521 numval = (long)varp->vval.v_number;
Bram Moolenaarb0d81822021-01-03 15:55:10 +01003522 strval = (char_u *)"0"; // avoid using "false"
3523 }
3524 else
3525 {
3526 if (!in_vim9script() || varp->v_type != VAR_STRING)
3527 numval = (long)tv_get_number_chk(varp, &error);
3528 strval = tv_get_string_buf_chk(varp, nbuf);
3529 }
Bram Moolenaar191929b2020-08-19 21:20:49 +02003530 if (!error && strval != NULL)
3531 set_option_value(varname, numval, strval, OPT_LOCAL);
3532}
3533
3534/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003535 * "setwinvar()" and "settabwinvar()" functions
3536 */
3537 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003538setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003539{
3540 win_T *win;
3541 win_T *save_curwin;
3542 tabpage_T *save_curtab;
3543 int need_switch_win;
3544 char_u *varname, *winvarname;
3545 typval_T *varp;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003546 tabpage_T *tp = NULL;
3547
3548 if (check_secure())
3549 return;
3550
3551 if (off == 1)
3552 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3553 else
3554 tp = curtab;
3555 win = find_win_by_nr(&argvars[off], tp);
3556 varname = tv_get_string_chk(&argvars[off + 1]);
3557 varp = &argvars[off + 2];
3558
3559 if (win != NULL && varname != NULL && varp != NULL)
3560 {
3561 need_switch_win = !(tp == curtab && win == curwin);
3562 if (!need_switch_win
3563 || switch_win(&save_curwin, &save_curtab, win, tp, TRUE) == OK)
3564 {
3565 if (*varname == '&')
Bram Moolenaar191929b2020-08-19 21:20:49 +02003566 set_option_from_tv(varname + 1, varp);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003567 else
3568 {
3569 winvarname = alloc(STRLEN(varname) + 3);
3570 if (winvarname != NULL)
3571 {
3572 STRCPY(winvarname, "w:");
3573 STRCPY(winvarname + 2, varname);
3574 set_var(winvarname, varp, TRUE);
3575 vim_free(winvarname);
3576 }
3577 }
3578 }
3579 if (need_switch_win)
3580 restore_win(save_curwin, save_curtab, TRUE);
3581 }
3582}
3583
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003584/*
3585 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
3586 * v:option_type, and v:option_command.
3587 */
3588 void
3589reset_v_option_vars(void)
3590{
3591 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
3592 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
3593 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
3594 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
3595 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
3596 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
3597}
3598
3599/*
3600 * Add an assert error to v:errors.
3601 */
3602 void
3603assert_error(garray_T *gap)
3604{
3605 struct vimvar *vp = &vimvars[VV_ERRORS];
3606
3607 if (vp->vv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003608 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003609 set_vim_var_list(VV_ERRORS, list_alloc());
3610 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
3611}
3612
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003613 int
3614var_exists(char_u *var)
3615{
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003616 char_u *arg = var;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003617 char_u *name;
3618 char_u *tofree;
3619 typval_T tv;
3620 int len = 0;
3621 int n = FALSE;
3622
3623 // get_name_len() takes care of expanding curly braces
3624 name = var;
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003625 len = get_name_len(&arg, &tofree, TRUE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003626 if (len > 0)
3627 {
3628 if (tofree != NULL)
3629 name = tofree;
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003630 n = (eval_variable(name, len, &tv, NULL, FALSE, TRUE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003631 if (n)
3632 {
3633 // handle d.key, l[idx], f(expr)
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003634 arg = skipwhite(arg);
3635 n = (handle_subscript(&arg, &tv, &EVALARG_EVALUATE, FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003636 if (n)
3637 clear_tv(&tv);
3638 }
3639 }
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003640 if (*arg != NUL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003641 n = FALSE;
3642
3643 vim_free(tofree);
3644 return n;
3645}
3646
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003647static lval_T *redir_lval = NULL;
3648#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
3649static garray_T redir_ga; // only valid when redir_lval is not NULL
3650static char_u *redir_endp = NULL;
3651static char_u *redir_varname = NULL;
3652
3653/*
3654 * Start recording command output to a variable
3655 * When "append" is TRUE append to an existing variable.
3656 * Returns OK if successfully completed the setup. FAIL otherwise.
3657 */
3658 int
3659var_redir_start(char_u *name, int append)
3660{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003661 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003662 typval_T tv;
3663
3664 // Catch a bad name early.
3665 if (!eval_isnamec1(*name))
3666 {
3667 emsg(_(e_invarg));
3668 return FAIL;
3669 }
3670
3671 // Make a copy of the name, it is used in redir_lval until redir ends.
3672 redir_varname = vim_strsave(name);
3673 if (redir_varname == NULL)
3674 return FAIL;
3675
3676 redir_lval = ALLOC_CLEAR_ONE(lval_T);
3677 if (redir_lval == NULL)
3678 {
3679 var_redir_stop();
3680 return FAIL;
3681 }
3682
3683 // The output is stored in growarray "redir_ga" until redirection ends.
3684 ga_init2(&redir_ga, (int)sizeof(char), 500);
3685
3686 // Parse the variable name (can be a dict or list entry).
3687 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
3688 FNE_CHECK_START);
3689 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
3690 {
3691 clear_lval(redir_lval);
3692 if (redir_endp != NULL && *redir_endp != NUL)
3693 // Trailing characters are present after the variable name
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003694 semsg(_(e_trailing_arg), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003695 else
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003696 semsg(_(e_invarg2), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003697 redir_endp = NULL; // don't store a value, only cleanup
3698 var_redir_stop();
3699 return FAIL;
3700 }
3701
3702 // check if we can write to the variable: set it to or append an empty
3703 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003704 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003705 tv.v_type = VAR_STRING;
3706 tv.vval.v_string = (char_u *)"";
3707 if (append)
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02003708 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
3709 ASSIGN_NO_DECL, (char_u *)".");
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003710 else
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02003711 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
3712 ASSIGN_NO_DECL, (char_u *)"=");
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003713 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003714 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003715 {
3716 redir_endp = NULL; // don't store a value, only cleanup
3717 var_redir_stop();
3718 return FAIL;
3719 }
3720
3721 return OK;
3722}
3723
3724/*
3725 * Append "value[value_len]" to the variable set by var_redir_start().
3726 * The actual appending is postponed until redirection ends, because the value
3727 * appended may in fact be the string we write to, changing it may cause freed
3728 * memory to be used:
3729 * :redir => foo
3730 * :let foo
3731 * :redir END
3732 */
3733 void
3734var_redir_str(char_u *value, int value_len)
3735{
3736 int len;
3737
3738 if (redir_lval == NULL)
3739 return;
3740
3741 if (value_len == -1)
3742 len = (int)STRLEN(value); // Append the entire string
3743 else
3744 len = value_len; // Append only "value_len" characters
3745
3746 if (ga_grow(&redir_ga, len) == OK)
3747 {
3748 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
3749 redir_ga.ga_len += len;
3750 }
3751 else
3752 var_redir_stop();
3753}
3754
3755/*
3756 * Stop redirecting command output to a variable.
3757 * Frees the allocated memory.
3758 */
3759 void
3760var_redir_stop(void)
3761{
3762 typval_T tv;
3763
3764 if (EVALCMD_BUSY)
3765 {
3766 redir_lval = NULL;
3767 return;
3768 }
3769
3770 if (redir_lval != NULL)
3771 {
3772 // If there was no error: assign the text to the variable.
3773 if (redir_endp != NULL)
3774 {
3775 ga_append(&redir_ga, NUL); // Append the trailing NUL.
3776 tv.v_type = VAR_STRING;
3777 tv.vval.v_string = redir_ga.ga_data;
3778 // Call get_lval() again, if it's inside a Dict or List it may
3779 // have changed.
3780 redir_endp = get_lval(redir_varname, NULL, redir_lval,
3781 FALSE, FALSE, 0, FNE_CHECK_START);
3782 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003783 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003784 (char_u *)".");
3785 clear_lval(redir_lval);
3786 }
3787
3788 // free the collected output
3789 VIM_CLEAR(redir_ga.ga_data);
3790
3791 VIM_CLEAR(redir_lval);
3792 }
3793 VIM_CLEAR(redir_varname);
3794}
3795
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003796/*
3797 * "gettabvar()" function
3798 */
3799 void
3800f_gettabvar(typval_T *argvars, typval_T *rettv)
3801{
3802 win_T *oldcurwin;
3803 tabpage_T *tp, *oldtabpage;
3804 dictitem_T *v;
3805 char_u *varname;
3806 int done = FALSE;
3807
3808 rettv->v_type = VAR_STRING;
3809 rettv->vval.v_string = NULL;
3810
3811 varname = tv_get_string_chk(&argvars[1]);
3812 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3813 if (tp != NULL && varname != NULL)
3814 {
3815 // Set tp to be our tabpage, temporarily. Also set the window to the
3816 // first window in the tabpage, otherwise the window is not valid.
3817 if (switch_win(&oldcurwin, &oldtabpage,
3818 tp == curtab || tp->tp_firstwin == NULL ? firstwin
3819 : tp->tp_firstwin, tp, TRUE) == OK)
3820 {
3821 // look up the variable
3822 // Let gettabvar({nr}, "") return the "t:" dictionary.
3823 v = find_var_in_ht(&tp->tp_vars->dv_hashtab, 't', varname, FALSE);
3824 if (v != NULL)
3825 {
3826 copy_tv(&v->di_tv, rettv);
3827 done = TRUE;
3828 }
3829 }
3830
3831 // restore previous notion of curwin
3832 restore_win(oldcurwin, oldtabpage, TRUE);
3833 }
3834
3835 if (!done && argvars[2].v_type != VAR_UNKNOWN)
3836 copy_tv(&argvars[2], rettv);
3837}
3838
3839/*
3840 * "gettabwinvar()" function
3841 */
3842 void
3843f_gettabwinvar(typval_T *argvars, typval_T *rettv)
3844{
3845 getwinvar(argvars, rettv, 1);
3846}
3847
3848/*
3849 * "getwinvar()" function
3850 */
3851 void
3852f_getwinvar(typval_T *argvars, typval_T *rettv)
3853{
3854 getwinvar(argvars, rettv, 0);
3855}
3856
3857/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003858 * "getbufvar()" function
3859 */
3860 void
3861f_getbufvar(typval_T *argvars, typval_T *rettv)
3862{
3863 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003864 char_u *varname;
3865 dictitem_T *v;
3866 int done = FALSE;
3867
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003868 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02003869 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003870
3871 rettv->v_type = VAR_STRING;
3872 rettv->vval.v_string = NULL;
3873
3874 if (buf != NULL && varname != NULL)
3875 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003876 if (*varname == '&')
3877 {
Bram Moolenaar86015452020-03-29 15:12:15 +02003878 buf_T *save_curbuf = curbuf;
3879
3880 // set curbuf to be our buf, temporarily
3881 curbuf = buf;
3882
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003883 if (varname[1] == NUL)
3884 {
3885 // get all buffer-local options in a dict
3886 dict_T *opts = get_winbuf_options(TRUE);
3887
3888 if (opts != NULL)
3889 {
3890 rettv_dict_set(rettv, opts);
3891 done = TRUE;
3892 }
3893 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003894 else if (eval_option(&varname, rettv, TRUE) == OK)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003895 // buffer-local-option
3896 done = TRUE;
Bram Moolenaar86015452020-03-29 15:12:15 +02003897
3898 // restore previous notion of curbuf
3899 curbuf = save_curbuf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003900 }
3901 else
3902 {
3903 // Look up the variable.
Bram Moolenaar52592752020-04-03 18:43:35 +02003904 if (*varname == NUL)
3905 // Let getbufvar({nr}, "") return the "b:" dictionary.
3906 v = &buf->b_bufvar;
3907 else
3908 v = find_var_in_ht(&buf->b_vars->dv_hashtab, 'b',
3909 varname, FALSE);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003910 if (v != NULL)
3911 {
3912 copy_tv(&v->di_tv, rettv);
3913 done = TRUE;
3914 }
3915 }
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003916 }
3917
3918 if (!done && argvars[2].v_type != VAR_UNKNOWN)
3919 // use the default value
3920 copy_tv(&argvars[2], rettv);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003921}
3922
3923/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003924 * "settabvar()" function
3925 */
3926 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003927f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003928{
3929 tabpage_T *save_curtab;
3930 tabpage_T *tp;
3931 char_u *varname, *tabvarname;
3932 typval_T *varp;
3933
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003934 if (check_secure())
3935 return;
3936
3937 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3938 varname = tv_get_string_chk(&argvars[1]);
3939 varp = &argvars[2];
3940
3941 if (varname != NULL && varp != NULL && tp != NULL)
3942 {
3943 save_curtab = curtab;
3944 goto_tabpage_tp(tp, FALSE, FALSE);
3945
3946 tabvarname = alloc(STRLEN(varname) + 3);
3947 if (tabvarname != NULL)
3948 {
3949 STRCPY(tabvarname, "t:");
3950 STRCPY(tabvarname + 2, varname);
3951 set_var(tabvarname, varp, TRUE);
3952 vim_free(tabvarname);
3953 }
3954
3955 // Restore current tabpage
3956 if (valid_tabpage(save_curtab))
3957 goto_tabpage_tp(save_curtab, FALSE, FALSE);
3958 }
3959}
3960
3961/*
3962 * "settabwinvar()" function
3963 */
3964 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003965f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003966{
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003967 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003968}
3969
3970/*
3971 * "setwinvar()" function
3972 */
3973 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003974f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003975{
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003976 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003977}
3978
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003979/*
3980 * "setbufvar()" function
3981 */
3982 void
3983f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
3984{
3985 buf_T *buf;
3986 char_u *varname, *bufvarname;
3987 typval_T *varp;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003988
3989 if (check_secure())
3990 return;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003991 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02003992 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003993 varp = &argvars[2];
3994
3995 if (buf != NULL && varname != NULL && varp != NULL)
3996 {
3997 if (*varname == '&')
3998 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003999 aco_save_T aco;
4000
4001 // set curbuf to be our buf, temporarily
4002 aucmd_prepbuf(&aco, buf);
4003
Bram Moolenaar191929b2020-08-19 21:20:49 +02004004 set_option_from_tv(varname + 1, varp);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004005
4006 // reset notion of buffer
4007 aucmd_restbuf(&aco);
4008 }
4009 else
4010 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004011 bufvarname = alloc(STRLEN(varname) + 3);
4012 if (bufvarname != NULL)
4013 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004014 buf_T *save_curbuf = curbuf;
4015
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004016 curbuf = buf;
4017 STRCPY(bufvarname, "b:");
4018 STRCPY(bufvarname + 2, varname);
4019 set_var(bufvarname, varp, TRUE);
4020 vim_free(bufvarname);
4021 curbuf = save_curbuf;
4022 }
4023 }
4024 }
4025}
4026
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004027/*
4028 * Get a callback from "arg". It can be a Funcref or a function name.
4029 * When "arg" is zero return an empty string.
4030 * "cb_name" is not allocated.
4031 * "cb_name" is set to NULL for an invalid argument.
4032 */
4033 callback_T
4034get_callback(typval_T *arg)
4035{
Bram Moolenaar14e579092020-03-07 16:59:25 +01004036 callback_T res;
4037 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004038
4039 res.cb_free_name = FALSE;
4040 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
4041 {
4042 res.cb_partial = arg->vval.v_partial;
4043 ++res.cb_partial->pt_refcount;
4044 res.cb_name = partial_name(res.cb_partial);
4045 }
4046 else
4047 {
4048 res.cb_partial = NULL;
Bram Moolenaar14e579092020-03-07 16:59:25 +01004049 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
4050 && isdigit(*arg->vval.v_string))
4051 r = FAIL;
4052 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004053 {
4054 // Note that we don't make a copy of the string.
4055 res.cb_name = arg->vval.v_string;
4056 func_ref(res.cb_name);
4057 }
4058 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004059 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004060 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01004061 r = FAIL;
4062
4063 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004064 {
4065 emsg(_("E921: Invalid callback argument"));
4066 res.cb_name = NULL;
4067 }
4068 }
4069 return res;
4070}
4071
4072/*
4073 * Copy a callback into a typval_T.
4074 */
4075 void
4076put_callback(callback_T *cb, typval_T *tv)
4077{
4078 if (cb->cb_partial != NULL)
4079 {
4080 tv->v_type = VAR_PARTIAL;
4081 tv->vval.v_partial = cb->cb_partial;
4082 ++tv->vval.v_partial->pt_refcount;
4083 }
4084 else
4085 {
4086 tv->v_type = VAR_FUNC;
4087 tv->vval.v_string = vim_strsave(cb->cb_name);
4088 func_ref(cb->cb_name);
4089 }
4090}
4091
4092/*
4093 * Make a copy of "src" into "dest", allocating the function name if needed,
4094 * without incrementing the refcount.
4095 */
4096 void
4097set_callback(callback_T *dest, callback_T *src)
4098{
4099 if (src->cb_partial == NULL)
4100 {
4101 // just a function name, make a copy
4102 dest->cb_name = vim_strsave(src->cb_name);
4103 dest->cb_free_name = TRUE;
4104 }
4105 else
4106 {
4107 // cb_name is a pointer into cb_partial
4108 dest->cb_name = src->cb_name;
4109 dest->cb_free_name = FALSE;
4110 }
4111 dest->cb_partial = src->cb_partial;
4112}
4113
4114/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02004115 * Copy callback from "src" to "dest", incrementing the refcounts.
4116 */
4117 void
4118copy_callback(callback_T *dest, callback_T *src)
4119{
4120 dest->cb_partial = src->cb_partial;
4121 if (dest->cb_partial != NULL)
4122 {
4123 dest->cb_name = src->cb_name;
4124 dest->cb_free_name = FALSE;
4125 ++dest->cb_partial->pt_refcount;
4126 }
4127 else
4128 {
4129 dest->cb_name = vim_strsave(src->cb_name);
4130 dest->cb_free_name = TRUE;
4131 func_ref(src->cb_name);
4132 }
4133}
4134
4135/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004136 * Unref/free "callback" returned by get_callback() or set_callback().
4137 */
4138 void
4139free_callback(callback_T *callback)
4140{
4141 if (callback->cb_partial != NULL)
4142 {
4143 partial_unref(callback->cb_partial);
4144 callback->cb_partial = NULL;
4145 }
4146 else if (callback->cb_name != NULL)
4147 func_unref(callback->cb_name);
4148 if (callback->cb_free_name)
4149 {
4150 vim_free(callback->cb_name);
4151 callback->cb_free_name = FALSE;
4152 }
4153 callback->cb_name = NULL;
4154}
4155
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004156#endif // FEAT_EVAL