blob: cf75487eaa89944809a85fdb99ddc097ecd56954 [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 Moolenaare5cdf152019-08-29 22:09:46 +0200149};
150
151// shorthand
152#define vv_type vv_di.di_tv.v_type
153#define vv_nr vv_di.di_tv.vval.v_number
154#define vv_float vv_di.di_tv.vval.v_float
155#define vv_str vv_di.di_tv.vval.v_string
156#define vv_list vv_di.di_tv.vval.v_list
157#define vv_dict vv_di.di_tv.vval.v_dict
158#define vv_blob vv_di.di_tv.vval.v_blob
159#define vv_tv vv_di.di_tv
160
161static dictitem_T vimvars_var; // variable used for v:
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200162static dict_T vimvardict; // Dictionary with v: variables
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200163#define vimvarht vimvardict.dv_hashtab
164
165// for VIM_VERSION_ defines
166#include "version.h"
167
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200168static void list_glob_vars(int *first);
169static void list_buf_vars(int *first);
170static void list_win_vars(int *first);
171static void list_tab_vars(int *first);
172static char_u *list_arg_vars(exarg_T *eap, char_u *arg, int *first);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100173static 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 +0200174static int do_unlet_var(lval_T *lp, char_u *name_end, exarg_T *eap, int deep, void *cookie);
175static 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 +0200176static void item_lock(typval_T *tv, int deep, int lock);
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200177static void delete_var(hashtab_T *ht, hashitem_T *hi);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200178static void list_one_var(dictitem_T *v, char *prefix, int *first);
179static void list_one_var_a(char *prefix, char_u *name, int type, char_u *string, int *first);
180
181/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200182 * Initialize global and vim special variables
183 */
184 void
185evalvars_init(void)
186{
187 int i;
188 struct vimvar *p;
189
190 init_var_dict(&globvardict, &globvars_var, VAR_DEF_SCOPE);
191 init_var_dict(&vimvardict, &vimvars_var, VAR_SCOPE);
192 vimvardict.dv_lock = VAR_FIXED;
193 hash_init(&compat_hashtab);
194
195 for (i = 0; i < VV_LEN; ++i)
196 {
197 p = &vimvars[i];
198 if (STRLEN(p->vv_name) > DICTITEM16_KEY_LEN)
199 {
200 iemsg("INTERNAL: name too long, increase size of dictitem16_T");
201 getout(1);
202 }
203 STRCPY(p->vv_di.di_key, p->vv_name);
204 if (p->vv_flags & VV_RO)
205 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
206 else if (p->vv_flags & VV_RO_SBX)
207 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
208 else
209 p->vv_di.di_flags = DI_FLAGS_FIX;
210
211 // add to v: scope dict, unless the value is not always available
212 if (p->vv_type != VAR_UNKNOWN)
213 hash_add(&vimvarht, p->vv_di.di_key);
214 if (p->vv_flags & VV_COMPAT)
215 // add to compat scope dict
216 hash_add(&compat_hashtab, p->vv_di.di_key);
217 }
218 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
219 vimvars[VV_VERSIONLONG].vv_nr = VIM_VERSION_100 * 10000 + highest_patch();
220
221 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
222 set_vim_var_nr(VV_HLSEARCH, 1L);
223 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{
304 int i;
305 int abort = FALSE;
306
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100307 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200308 abort = abort || set_ref_in_ht(&SCRIPT_VARS(i), copyID, NULL);
309
310 return abort;
311}
312
313/*
314 * Set an internal variable to a string value. Creates the variable if it does
315 * not already exist.
316 */
317 void
318set_internal_string_var(char_u *name, char_u *value)
319{
320 char_u *val;
321 typval_T *tvp;
322
323 val = vim_strsave(value);
324 if (val != NULL)
325 {
326 tvp = alloc_string_tv(val);
327 if (tvp != NULL)
328 {
329 set_var(name, tvp, FALSE);
330 free_tv(tvp);
331 }
332 }
333}
334
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200335 int
336eval_charconvert(
337 char_u *enc_from,
338 char_u *enc_to,
339 char_u *fname_from,
340 char_u *fname_to)
341{
342 int err = FALSE;
343
344 set_vim_var_string(VV_CC_FROM, enc_from, -1);
345 set_vim_var_string(VV_CC_TO, enc_to, -1);
346 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
347 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
348 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
349 err = TRUE;
350 set_vim_var_string(VV_CC_FROM, NULL, -1);
351 set_vim_var_string(VV_CC_TO, NULL, -1);
352 set_vim_var_string(VV_FNAME_IN, NULL, -1);
353 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
354
355 if (err)
356 return FAIL;
357 return OK;
358}
359
360# if defined(FEAT_POSTSCRIPT) || defined(PROTO)
361 int
362eval_printexpr(char_u *fname, char_u *args)
363{
364 int err = FALSE;
365
366 set_vim_var_string(VV_FNAME_IN, fname, -1);
367 set_vim_var_string(VV_CMDARG, args, -1);
368 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
369 err = TRUE;
370 set_vim_var_string(VV_FNAME_IN, NULL, -1);
371 set_vim_var_string(VV_CMDARG, NULL, -1);
372
373 if (err)
374 {
375 mch_remove(fname);
376 return FAIL;
377 }
378 return OK;
379}
380# endif
381
382# if defined(FEAT_DIFF) || defined(PROTO)
383 void
384eval_diff(
385 char_u *origfile,
386 char_u *newfile,
387 char_u *outfile)
388{
389 int err = FALSE;
390
391 set_vim_var_string(VV_FNAME_IN, origfile, -1);
392 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
393 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
394 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
395 set_vim_var_string(VV_FNAME_IN, NULL, -1);
396 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
397 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
398}
399
400 void
401eval_patch(
402 char_u *origfile,
403 char_u *difffile,
404 char_u *outfile)
405{
406 int err;
407
408 set_vim_var_string(VV_FNAME_IN, origfile, -1);
409 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
410 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
411 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
412 set_vim_var_string(VV_FNAME_IN, NULL, -1);
413 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
414 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
415}
416# endif
417
418#if defined(FEAT_SPELL) || defined(PROTO)
419/*
420 * Evaluate an expression to a list with suggestions.
421 * For the "expr:" part of 'spellsuggest'.
422 * Returns NULL when there is an error.
423 */
424 list_T *
425eval_spell_expr(char_u *badword, char_u *expr)
426{
427 typval_T save_val;
428 typval_T rettv;
429 list_T *list = NULL;
430 char_u *p = skipwhite(expr);
431
432 // Set "v:val" to the bad word.
433 prepare_vimvar(VV_VAL, &save_val);
434 set_vim_var_string(VV_VAL, badword, -1);
435 if (p_verbose == 0)
436 ++emsg_off;
437
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200438 if (eval1(&p, &rettv, &EVALARG_EVALUATE) == OK)
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200439 {
440 if (rettv.v_type != VAR_LIST)
441 clear_tv(&rettv);
442 else
443 list = rettv.vval.v_list;
444 }
445
446 if (p_verbose == 0)
447 --emsg_off;
448 clear_tv(get_vim_var_tv(VV_VAL));
449 restore_vimvar(VV_VAL, &save_val);
450
451 return list;
452}
453
454/*
455 * "list" is supposed to contain two items: a word and a number. Return the
456 * word in "pp" and the number as the return value.
457 * Return -1 if anything isn't right.
458 * Used to get the good word and score from the eval_spell_expr() result.
459 */
460 int
461get_spellword(list_T *list, char_u **pp)
462{
463 listitem_T *li;
464
465 li = list->lv_first;
466 if (li == NULL)
467 return -1;
468 *pp = tv_get_string(&li->li_tv);
469
470 li = li->li_next;
471 if (li == NULL)
472 return -1;
473 return (int)tv_get_number(&li->li_tv);
474}
475#endif
476
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200477/*
478 * Prepare v: variable "idx" to be used.
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200479 * Save the current typeval in "save_tv" and clear it.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200480 * When not used yet add the variable to the v: hashtable.
481 */
482 void
483prepare_vimvar(int idx, typval_T *save_tv)
484{
485 *save_tv = vimvars[idx].vv_tv;
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200486 vimvars[idx].vv_str = NULL; // don't free it now
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200487 if (vimvars[idx].vv_type == VAR_UNKNOWN)
488 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
489}
490
491/*
492 * Restore v: variable "idx" to typeval "save_tv".
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200493 * Note that the v: variable must have been cleared already.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200494 * When no longer defined, remove the variable from the v: hashtable.
495 */
496 void
497restore_vimvar(int idx, typval_T *save_tv)
498{
499 hashitem_T *hi;
500
501 vimvars[idx].vv_tv = *save_tv;
502 if (vimvars[idx].vv_type == VAR_UNKNOWN)
503 {
504 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
505 if (HASHITEM_EMPTY(hi))
506 internal_error("restore_vimvar()");
507 else
508 hash_remove(&vimvarht, hi);
509 }
510}
511
512/*
513 * List Vim variables.
514 */
515 static void
516list_vim_vars(int *first)
517{
518 list_hashtable_vars(&vimvarht, "v:", FALSE, first);
519}
520
521/*
522 * List script-local variables, if there is a script.
523 */
524 static void
525list_script_vars(int *first)
526{
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100527 if (current_sctx.sc_sid > 0 && current_sctx.sc_sid <= script_items.ga_len)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200528 list_hashtable_vars(&SCRIPT_VARS(current_sctx.sc_sid),
529 "s:", FALSE, first);
530}
531
532/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200533 * Get a list of lines from a HERE document. The here document is a list of
534 * lines surrounded by a marker.
535 * cmd << {marker}
536 * {line1}
537 * {line2}
538 * ....
539 * {marker}
540 *
541 * The {marker} is a string. If the optional 'trim' word is supplied before the
542 * marker, then the leading indentation before the lines (matching the
543 * indentation in the 'cmd' line) is stripped.
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200544 *
545 * When getting lines for an embedded script (e.g. python, lua, perl, ruby,
546 * tcl, mzscheme), script_get is set to TRUE. In this case, if the marker is
547 * missing, then '.' is accepted as a marker.
548 *
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200549 * Returns a List with {lines} or NULL.
550 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100551 list_T *
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200552heredoc_get(exarg_T *eap, char_u *cmd, int script_get)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200553{
554 char_u *theline;
555 char_u *marker;
556 list_T *l;
557 char_u *p;
558 int marker_indent_len = 0;
559 int text_indent_len = 0;
560 char_u *text_indent = NULL;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200561 char_u dot[] = ".";
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200562
563 if (eap->getline == NULL)
564 {
565 emsg(_("E991: cannot use =<< here"));
566 return NULL;
567 }
568
569 // Check for the optional 'trim' word before the marker
570 cmd = skipwhite(cmd);
571 if (STRNCMP(cmd, "trim", 4) == 0 && (cmd[4] == NUL || VIM_ISWHITE(cmd[4])))
572 {
573 cmd = skipwhite(cmd + 4);
574
575 // Trim the indentation from all the lines in the here document.
576 // The amount of indentation trimmed is the same as the indentation of
577 // the first line after the :let command line. To find the end marker
578 // the indent of the :let command line is trimmed.
579 p = *eap->cmdlinep;
580 while (VIM_ISWHITE(*p))
581 {
582 p++;
583 marker_indent_len++;
584 }
585 text_indent_len = -1;
586 }
587
588 // The marker is the next word.
589 if (*cmd != NUL && *cmd != '"')
590 {
591 marker = skipwhite(cmd);
592 p = skiptowhite(marker);
593 if (*skipwhite(p) != NUL && *skipwhite(p) != '"')
594 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +0200595 semsg(_(e_trailing_arg), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200596 return NULL;
597 }
598 *p = NUL;
Bram Moolenaar6ab09532020-05-01 14:10:13 +0200599 if (!script_get && vim_islower(*marker))
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200600 {
601 emsg(_("E221: Marker cannot start with lower case letter"));
602 return NULL;
603 }
604 }
605 else
606 {
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200607 // When getting lines for an embedded script, if the marker is missing,
608 // accept '.' as the marker.
609 if (script_get)
610 marker = dot;
611 else
612 {
613 emsg(_("E172: Missing marker"));
614 return NULL;
615 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200616 }
617
618 l = list_alloc();
619 if (l == NULL)
620 return NULL;
621
622 for (;;)
623 {
624 int mi = 0;
625 int ti = 0;
626
627 theline = eap->getline(NUL, eap->cookie, 0, FALSE);
628 if (theline == NULL)
629 {
630 semsg(_("E990: Missing end marker '%s'"), marker);
631 break;
632 }
633
634 // with "trim": skip the indent matching the :let line to find the
635 // marker
636 if (marker_indent_len > 0
637 && STRNCMP(theline, *eap->cmdlinep, marker_indent_len) == 0)
638 mi = marker_indent_len;
639 if (STRCMP(marker, theline + mi) == 0)
640 {
641 vim_free(theline);
642 break;
643 }
644
645 if (text_indent_len == -1 && *theline != NUL)
646 {
647 // set the text indent from the first line.
648 p = theline;
649 text_indent_len = 0;
650 while (VIM_ISWHITE(*p))
651 {
652 p++;
653 text_indent_len++;
654 }
655 text_indent = vim_strnsave(theline, text_indent_len);
656 }
657 // with "trim": skip the indent matching the first line
658 if (text_indent != NULL)
659 for (ti = 0; ti < text_indent_len; ++ti)
660 if (theline[ti] != text_indent[ti])
661 break;
662
663 if (list_append_string(l, theline + ti, -1) == FAIL)
664 break;
665 vim_free(theline);
666 }
667 vim_free(text_indent);
668
669 return l;
670}
671
672/*
673 * ":let" list all variable values
674 * ":let var1 var2" list variable values
675 * ":let var = expr" assignment command.
676 * ":let var += expr" assignment command.
677 * ":let var -= expr" assignment command.
678 * ":let var *= expr" assignment command.
679 * ":let var /= expr" assignment command.
680 * ":let var %= expr" assignment command.
681 * ":let var .= expr" assignment command.
682 * ":let var ..= expr" assignment command.
683 * ":let [var1, var2] = expr" unpack list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100684 * ":let var =<< ..." heredoc
Bram Moolenaard672dde2020-02-26 13:43:51 +0100685 * ":let var: string" Vim9 declaration
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200686 *
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200687 * ":const" list all variable values
688 * ":const var1 var2" list variable values
689 * ":const var = expr" assignment command.
690 * ":const [var1, var2] = expr" unpack list.
691 */
692 void
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200693ex_let(exarg_T *eap)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200694{
695 char_u *arg = eap->arg;
696 char_u *expr = NULL;
697 typval_T rettv;
698 int i;
699 int var_count = 0;
700 int semicolon = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200701 char_u op[4];
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200702 char_u *argend;
703 int first = TRUE;
704 int concat;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200705 int has_assign;
Bram Moolenaar09689a02020-05-09 22:50:08 +0200706 int flags = eap->cmdidx == CMD_const ? LET_IS_CONST : 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200707 int vim9script = in_vim9script();
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200708
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100709 // detect Vim9 assignment without ":let" or ":const"
710 if (eap->arg == eap->cmd)
711 flags |= LET_NO_COMMAND;
712
Bram Moolenaar47a519a2020-06-14 23:05:10 +0200713 argend = skip_var_list(arg, TRUE, &var_count, &semicolon, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200714 if (argend == NULL)
715 return;
716 if (argend > arg && argend[-1] == '.') // for var.='str'
717 --argend;
718 expr = skipwhite(argend);
719 concat = expr[0] == '.'
720 && ((expr[1] == '=' && current_sctx.sc_version < 2)
721 || (expr[1] == '.' && expr[2] == '='));
Bram Moolenaar32e35112020-05-14 22:41:15 +0200722 has_assign = *expr == '=' || (vim_strchr((char_u *)"+-*/%", *expr) != NULL
723 && expr[1] == '=');
Bram Moolenaar822ba242020-05-24 23:00:18 +0200724 if (!has_assign && !concat)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200725 {
726 // ":let" without "=": list variables
727 if (*arg == '[')
728 emsg(_(e_invarg));
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200729 else if (expr[0] == '.' && expr[1] == '=')
730 emsg(_("E985: .= is not supported with script version >= 2"));
Bram Moolenaarfaac4102020-04-20 17:46:14 +0200731 else if (!ends_excmd2(eap->cmd, arg))
Bram Moolenaarc82a5b52020-06-13 18:09:19 +0200732 {
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200733 if (vim9script)
Bram Moolenaarc82a5b52020-06-13 18:09:19 +0200734 {
735 // Vim9 declaration ":let var: type"
736 arg = vim9_declare_scriptvar(eap, arg);
737 }
738 else
739 {
740 // ":let var1 var2" - list values
741 arg = list_arg_vars(eap, arg, &first);
742 }
743 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200744 else if (!eap->skip)
745 {
746 // ":let"
747 list_glob_vars(&first);
748 list_buf_vars(&first);
749 list_win_vars(&first);
750 list_tab_vars(&first);
751 list_script_vars(&first);
752 list_func_vars(&first);
753 list_vim_vars(&first);
754 }
755 eap->nextcmd = check_nextcmd(arg);
756 }
757 else if (expr[0] == '=' && expr[1] == '<' && expr[2] == '<')
758 {
759 list_T *l;
760
761 // HERE document
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200762 l = heredoc_get(eap, expr + 3, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200763 if (l != NULL)
764 {
765 rettv_list_set(&rettv, l);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +0200766 if (!eap->skip)
767 {
768 op[0] = '=';
769 op[1] = NUL;
770 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100771 flags, op);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +0200772 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200773 clear_tv(&rettv);
774 }
775 }
776 else
777 {
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200778 evalarg_T evalarg;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200779 int len = 1;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200780
Bram Moolenaar32e35112020-05-14 22:41:15 +0200781 rettv.v_type = VAR_UNKNOWN;
782 i = FAIL;
783 if (has_assign || concat)
784 {
785 op[0] = '=';
786 op[1] = NUL;
787 if (*expr != '=')
788 {
789 if (vim_strchr((char_u *)"+-*/%.", *expr) != NULL)
790 {
791 op[0] = *expr; // +=, -=, *=, /=, %= or .=
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200792 ++len;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200793 if (expr[0] == '.' && expr[1] == '.') // ..=
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200794 {
Bram Moolenaar32e35112020-05-14 22:41:15 +0200795 ++expr;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200796 ++len;
797 }
Bram Moolenaar32e35112020-05-14 22:41:15 +0200798 }
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200799 expr += 2;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200800 }
801 else
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200802 ++expr;
803
Bram Moolenaarc7e44a72020-07-29 21:37:43 +0200804 if (vim9script && (!VIM_ISWHITE(*argend)
805 || !IS_WHITE_OR_NUL(*expr)))
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200806 {
807 vim_strncpy(op, expr - len, len);
808 semsg(_(e_white_both), op);
809 i = FAIL;
810 }
Bram Moolenaar32e35112020-05-14 22:41:15 +0200811
812 if (eap->skip)
813 ++emsg_skip;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200814 CLEAR_FIELD(evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200815 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
Bram Moolenaard5053d02020-06-28 15:51:16 +0200816 if (getline_equal(eap->getline, eap->cookie, getsourceline))
817 {
818 evalarg.eval_getline = eap->getline;
819 evalarg.eval_cookie = eap->cookie;
820 }
Bram Moolenaarc7e44a72020-07-29 21:37:43 +0200821 expr = skipwhite_and_linebreak(expr, &evalarg);
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200822 i = eval0(expr, &rettv, eap, &evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200823 if (eap->skip)
824 --emsg_skip;
Bram Moolenaarfaf86262020-06-27 23:07:36 +0200825 clear_evalarg(&evalarg, eap);
Bram Moolenaar32e35112020-05-14 22:41:15 +0200826 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200827 if (eap->skip)
828 {
829 if (i != FAIL)
830 clear_tv(&rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200831 }
Bram Moolenaar822ba242020-05-24 23:00:18 +0200832 else if (i != FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200833 {
834 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200835 flags, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200836 clear_tv(&rettv);
837 }
838 }
839}
840
841/*
842 * Assign the typevalue "tv" to the variable or variables at "arg_start".
843 * Handles both "var" with any type and "[var, var; var]" with a list type.
844 * When "op" is not NULL it points to a string with characters that
845 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
846 * or concatenate.
847 * Returns OK or FAIL;
848 */
849 int
850ex_let_vars(
851 char_u *arg_start,
852 typval_T *tv,
853 int copy, // copy values from "tv", don't move
854 int semicolon, // from skip_var_list()
855 int var_count, // from skip_var_list()
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100856 int flags, // LET_IS_CONST and/or LET_NO_COMMAND
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200857 char_u *op)
858{
859 char_u *arg = arg_start;
860 list_T *l;
861 int i;
862 listitem_T *item;
863 typval_T ltv;
864
865 if (*arg != '[')
866 {
867 // ":let var = expr" or ":for var in list"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100868 if (ex_let_one(arg, tv, copy, flags, op, op) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200869 return FAIL;
870 return OK;
871 }
872
873 // ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
874 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
875 {
876 emsg(_(e_listreq));
877 return FAIL;
878 }
879
880 i = list_len(l);
881 if (semicolon == 0 && var_count < i)
882 {
883 emsg(_("E687: Less targets than List items"));
884 return FAIL;
885 }
886 if (var_count - semicolon > i)
887 {
888 emsg(_("E688: More targets than List items"));
889 return FAIL;
890 }
891
Bram Moolenaar7e9f3512020-05-13 22:44:22 +0200892 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200893 item = l->lv_first;
894 while (*arg != ']')
895 {
896 arg = skipwhite(arg + 1);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100897 arg = ex_let_one(arg, &item->li_tv, TRUE, flags, (char_u *)",;]", op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200898 item = item->li_next;
899 if (arg == NULL)
900 return FAIL;
901
902 arg = skipwhite(arg);
903 if (*arg == ';')
904 {
905 // Put the rest of the list (may be empty) in the var after ';'.
906 // Create a new list for this.
907 l = list_alloc();
908 if (l == NULL)
909 return FAIL;
910 while (item != NULL)
911 {
912 list_append_tv(l, &item->li_tv);
913 item = item->li_next;
914 }
915
916 ltv.v_type = VAR_LIST;
917 ltv.v_lock = 0;
918 ltv.vval.v_list = l;
919 l->lv_refcount = 1;
920
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100921 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE, flags,
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200922 (char_u *)"]", op);
923 clear_tv(&ltv);
924 if (arg == NULL)
925 return FAIL;
926 break;
927 }
928 else if (*arg != ',' && *arg != ']')
929 {
930 internal_error("ex_let_vars()");
931 return FAIL;
932 }
933 }
934
935 return OK;
936}
937
938/*
939 * Skip over assignable variable "var" or list of variables "[var, var]".
940 * Used for ":let varvar = expr" and ":for varvar in expr".
941 * For "[var, var]" increment "*var_count" for each variable.
Bram Moolenaar47a519a2020-06-14 23:05:10 +0200942 * for "[var, var; var]" set "semicolon" to 1.
943 * If "silent" is TRUE do not give an "invalid argument" error message.
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200944 * Return NULL for an error.
945 */
946 char_u *
947skip_var_list(
948 char_u *arg,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100949 int include_type,
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200950 int *var_count,
Bram Moolenaar47a519a2020-06-14 23:05:10 +0200951 int *semicolon,
952 int silent)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200953{
954 char_u *p, *s;
955
956 if (*arg == '[')
957 {
958 // "[var, var]": find the matching ']'.
959 p = arg;
960 for (;;)
961 {
962 p = skipwhite(p + 1); // skip whites after '[', ';' or ','
Bram Moolenaar47a519a2020-06-14 23:05:10 +0200963 s = skip_var_one(p, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200964 if (s == p)
965 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +0200966 if (!silent)
967 semsg(_(e_invarg2), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200968 return NULL;
969 }
970 ++*var_count;
971
972 p = skipwhite(s);
973 if (*p == ']')
974 break;
975 else if (*p == ';')
976 {
977 if (*semicolon == 1)
978 {
Bram Moolenaar9be61bb2020-03-30 22:51:24 +0200979 emsg(_("E452: Double ; in list of variables"));
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200980 return NULL;
981 }
982 *semicolon = 1;
983 }
984 else if (*p != ',')
985 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +0200986 if (!silent)
987 semsg(_(e_invarg2), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200988 return NULL;
989 }
990 }
991 return p + 1;
992 }
993 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100994 return skip_var_one(arg, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200995}
996
997/*
998 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
999 * l[idx].
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001000 * In Vim9 script also skip over ": type" if "include_type" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001001 */
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001002 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001003skip_var_one(char_u *arg, int include_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001004{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001005 char_u *end;
1006
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001007 if (*arg == '@' && arg[1] != NUL)
1008 return arg + 2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001009 end = find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001010 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
Bram Moolenaareb6880b2020-07-12 17:07:05 +02001011 if (include_type && in_vim9script())
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001012 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001013 // "a: type" is declaring variable "a" with a type, not "a:".
1014 if (end == arg + 2 && end[-1] == ':')
1015 --end;
1016 if (*end == ':')
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02001017 end = skip_type(skipwhite(end + 1), FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001018 }
1019 return end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001020}
1021
1022/*
1023 * List variables for hashtab "ht" with prefix "prefix".
1024 * If "empty" is TRUE also list NULL strings as empty strings.
1025 */
1026 void
1027list_hashtable_vars(
1028 hashtab_T *ht,
1029 char *prefix,
1030 int empty,
1031 int *first)
1032{
1033 hashitem_T *hi;
1034 dictitem_T *di;
1035 int todo;
1036 char_u buf[IOSIZE];
1037
1038 todo = (int)ht->ht_used;
1039 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1040 {
1041 if (!HASHITEM_EMPTY(hi))
1042 {
1043 --todo;
1044 di = HI2DI(hi);
1045
1046 // apply :filter /pat/ to variable name
1047 vim_strncpy((char_u *)buf, (char_u *)prefix, IOSIZE - 1);
1048 vim_strcat((char_u *)buf, di->di_key, IOSIZE);
1049 if (message_filtered(buf))
1050 continue;
1051
1052 if (empty || di->di_tv.v_type != VAR_STRING
1053 || di->di_tv.vval.v_string != NULL)
1054 list_one_var(di, prefix, first);
1055 }
1056 }
1057}
1058
1059/*
1060 * List global variables.
1061 */
1062 static void
1063list_glob_vars(int *first)
1064{
1065 list_hashtable_vars(&globvarht, "", TRUE, first);
1066}
1067
1068/*
1069 * List buffer variables.
1070 */
1071 static void
1072list_buf_vars(int *first)
1073{
1074 list_hashtable_vars(&curbuf->b_vars->dv_hashtab, "b:", TRUE, first);
1075}
1076
1077/*
1078 * List window variables.
1079 */
1080 static void
1081list_win_vars(int *first)
1082{
1083 list_hashtable_vars(&curwin->w_vars->dv_hashtab, "w:", TRUE, first);
1084}
1085
1086/*
1087 * List tab page variables.
1088 */
1089 static void
1090list_tab_vars(int *first)
1091{
1092 list_hashtable_vars(&curtab->tp_vars->dv_hashtab, "t:", TRUE, first);
1093}
1094
1095/*
1096 * List variables in "arg".
1097 */
1098 static char_u *
1099list_arg_vars(exarg_T *eap, char_u *arg, int *first)
1100{
1101 int error = FALSE;
1102 int len;
1103 char_u *name;
1104 char_u *name_start;
1105 char_u *arg_subsc;
1106 char_u *tofree;
1107 typval_T tv;
1108
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001109 while (!ends_excmd2(eap->cmd, arg) && !got_int)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001110 {
1111 if (error || eap->skip)
1112 {
1113 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1114 if (!VIM_ISWHITE(*arg) && !ends_excmd(*arg))
1115 {
1116 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001117 semsg(_(e_trailing_arg), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001118 break;
1119 }
1120 }
1121 else
1122 {
1123 // get_name_len() takes care of expanding curly braces
1124 name_start = name = arg;
1125 len = get_name_len(&arg, &tofree, TRUE, TRUE);
1126 if (len <= 0)
1127 {
1128 // This is mainly to keep test 49 working: when expanding
1129 // curly braces fails overrule the exception error message.
1130 if (len < 0 && !aborting())
1131 {
1132 emsg_severe = TRUE;
1133 semsg(_(e_invarg2), arg);
1134 break;
1135 }
1136 error = TRUE;
1137 }
1138 else
1139 {
1140 if (tofree != NULL)
1141 name = tofree;
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02001142 if (eval_variable(name, len, &tv, NULL, TRUE, FALSE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001143 error = TRUE;
1144 else
1145 {
1146 // handle d.key, l[idx], f(expr)
1147 arg_subsc = arg;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001148 if (handle_subscript(&arg, &tv, &EVALARG_EVALUATE, TRUE)
Bram Moolenaar0b1cd522020-06-27 13:11:50 +02001149 == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001150 error = TRUE;
1151 else
1152 {
1153 if (arg == arg_subsc && len == 2 && name[1] == ':')
1154 {
1155 switch (*name)
1156 {
1157 case 'g': list_glob_vars(first); break;
1158 case 'b': list_buf_vars(first); break;
1159 case 'w': list_win_vars(first); break;
1160 case 't': list_tab_vars(first); break;
1161 case 'v': list_vim_vars(first); break;
1162 case 's': list_script_vars(first); break;
1163 case 'l': list_func_vars(first); break;
1164 default:
1165 semsg(_("E738: Can't list variables for %s"), name);
1166 }
1167 }
1168 else
1169 {
1170 char_u numbuf[NUMBUFLEN];
1171 char_u *tf;
1172 int c;
1173 char_u *s;
1174
1175 s = echo_string(&tv, &tf, numbuf, 0);
1176 c = *arg;
1177 *arg = NUL;
1178 list_one_var_a("",
1179 arg == arg_subsc ? name : name_start,
1180 tv.v_type,
1181 s == NULL ? (char_u *)"" : s,
1182 first);
1183 *arg = c;
1184 vim_free(tf);
1185 }
1186 clear_tv(&tv);
1187 }
1188 }
1189 }
1190
1191 vim_free(tofree);
1192 }
1193
1194 arg = skipwhite(arg);
1195 }
1196
1197 return arg;
1198}
1199
1200/*
1201 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
1202 * Returns a pointer to the char just after the var name.
1203 * Returns NULL if there is an error.
1204 */
1205 static char_u *
1206ex_let_one(
1207 char_u *arg, // points to variable name
1208 typval_T *tv, // value to assign to variable
1209 int copy, // copy value from "tv"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001210 int flags, // LET_IS_CONST and/or LET_NO_COMMAND
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001211 char_u *endchars, // valid chars after variable name or NULL
1212 char_u *op) // "+", "-", "." or NULL
1213{
1214 int c1;
1215 char_u *name;
1216 char_u *p;
1217 char_u *arg_end = NULL;
1218 int len;
1219 int opt_flags;
1220 char_u *tofree = NULL;
1221
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001222 if (in_vim9script() && (flags & LET_NO_COMMAND) == 0
1223 && vim_strchr((char_u *)"$@&", *arg) != NULL)
1224 {
1225 vim9_declare_error(arg);
1226 return NULL;
1227 }
1228
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001229 // ":let $VAR = expr": Set environment variable.
1230 if (*arg == '$')
1231 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001232 if (flags & LET_IS_CONST)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001233 {
1234 emsg(_("E996: Cannot lock an environment variable"));
1235 return NULL;
1236 }
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001237
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001238 // Find the end of the name.
1239 ++arg;
1240 name = arg;
1241 len = get_env_len(&arg);
1242 if (len == 0)
1243 semsg(_(e_invarg2), name - 1);
1244 else
1245 {
1246 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1247 semsg(_(e_letwrong), op);
1248 else if (endchars != NULL
1249 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
1250 emsg(_(e_letunexp));
1251 else if (!check_secure())
1252 {
1253 c1 = name[len];
1254 name[len] = NUL;
1255 p = tv_get_string_chk(tv);
1256 if (p != NULL && op != NULL && *op == '.')
1257 {
1258 int mustfree = FALSE;
1259 char_u *s = vim_getenv(name, &mustfree);
1260
1261 if (s != NULL)
1262 {
1263 p = tofree = concat_str(s, p);
1264 if (mustfree)
1265 vim_free(s);
1266 }
1267 }
1268 if (p != NULL)
1269 {
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01001270 vim_setenv_ext(name, p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001271 arg_end = arg;
1272 }
1273 name[len] = c1;
1274 vim_free(tofree);
1275 }
1276 }
1277 }
1278
1279 // ":let &option = expr": Set option value.
1280 // ":let &l:option = expr": Set local option value.
1281 // ":let &g:option = expr": Set global option value.
1282 else if (*arg == '&')
1283 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001284 if (flags & LET_IS_CONST)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001285 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001286 emsg(_(e_const_option));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001287 return NULL;
1288 }
1289 // Find the end of the name.
1290 p = find_option_end(&arg, &opt_flags);
1291 if (p == NULL || (endchars != NULL
1292 && vim_strchr(endchars, *skipwhite(p)) == NULL))
1293 emsg(_(e_letunexp));
1294 else
1295 {
1296 long n;
1297 int opt_type;
1298 long numval;
1299 char_u *stringval = NULL;
Bram Moolenaar65d032c2020-04-24 20:57:01 +02001300 char_u *s = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001301
1302 c1 = *p;
1303 *p = NUL;
1304
1305 n = (long)tv_get_number(tv);
Bram Moolenaar65d032c2020-04-24 20:57:01 +02001306 // avoid setting a string option to the text "v:false" or similar.
1307 if (tv->v_type != VAR_BOOL && tv->v_type != VAR_SPECIAL)
1308 s = tv_get_string_chk(tv); // != NULL if number or string
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001309 if (s != NULL && op != NULL && *op != '=')
1310 {
1311 opt_type = get_option_value(arg, &numval,
1312 &stringval, opt_flags);
1313 if ((opt_type == 1 && *op == '.')
1314 || (opt_type == 0 && *op != '.'))
1315 {
1316 semsg(_(e_letwrong), op);
1317 s = NULL; // don't set the value
1318 }
1319 else
1320 {
1321 if (opt_type == 1) // number
1322 {
1323 switch (*op)
1324 {
1325 case '+': n = numval + n; break;
1326 case '-': n = numval - n; break;
1327 case '*': n = numval * n; break;
1328 case '/': n = (long)num_divide(numval, n); break;
1329 case '%': n = (long)num_modulus(numval, n); break;
1330 }
1331 }
1332 else if (opt_type == 0 && stringval != NULL) // string
1333 {
1334 s = concat_str(stringval, s);
1335 vim_free(stringval);
1336 stringval = s;
1337 }
1338 }
1339 }
Bram Moolenaar65d032c2020-04-24 20:57:01 +02001340 if (s != NULL || tv->v_type == VAR_BOOL
1341 || tv->v_type == VAR_SPECIAL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001342 {
1343 set_option_value(arg, n, s, opt_flags);
1344 arg_end = p;
1345 }
1346 *p = c1;
1347 vim_free(stringval);
1348 }
1349 }
1350
1351 // ":let @r = expr": Set register contents.
1352 else if (*arg == '@')
1353 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001354 if (flags & LET_IS_CONST)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001355 {
1356 emsg(_("E996: Cannot lock a register"));
1357 return NULL;
1358 }
1359 ++arg;
1360 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1361 semsg(_(e_letwrong), op);
1362 else if (endchars != NULL
1363 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
1364 emsg(_(e_letunexp));
1365 else
1366 {
1367 char_u *ptofree = NULL;
1368 char_u *s;
1369
1370 p = tv_get_string_chk(tv);
1371 if (p != NULL && op != NULL && *op == '.')
1372 {
1373 s = get_reg_contents(*arg == '@' ? '"' : *arg, GREG_EXPR_SRC);
1374 if (s != NULL)
1375 {
1376 p = ptofree = concat_str(s, p);
1377 vim_free(s);
1378 }
1379 }
1380 if (p != NULL)
1381 {
1382 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
1383 arg_end = arg + 1;
1384 }
1385 vim_free(ptofree);
1386 }
1387 }
1388
1389 // ":let var = expr": Set internal variable.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001390 // ":let var: type = expr": Set internal variable with type.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001391 // ":let {expr} = expr": Idem, name made with curly braces
1392 else if (eval_isnamec1(*arg) || *arg == '{')
1393 {
1394 lval_T lv;
1395
1396 p = get_lval(arg, tv, &lv, FALSE, FALSE, 0, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001397 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001398 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001399 if (endchars != NULL && vim_strchr(endchars,
1400 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001401 emsg(_(e_letunexp));
1402 else
1403 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001404 set_var_lval(&lv, p, tv, copy, flags, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001405 arg_end = p;
1406 }
1407 }
1408 clear_lval(&lv);
1409 }
1410
1411 else
1412 semsg(_(e_invarg2), arg);
1413
1414 return arg_end;
1415}
1416
1417/*
1418 * ":unlet[!] var1 ... " command.
1419 */
1420 void
1421ex_unlet(exarg_T *eap)
1422{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001423 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001424}
1425
1426/*
1427 * ":lockvar" and ":unlockvar" commands
1428 */
1429 void
1430ex_lockvar(exarg_T *eap)
1431{
1432 char_u *arg = eap->arg;
1433 int deep = 2;
1434
1435 if (eap->forceit)
1436 deep = -1;
1437 else if (vim_isdigit(*arg))
1438 {
1439 deep = getdigits(&arg);
1440 arg = skipwhite(arg);
1441 }
1442
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001443 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001444}
1445
1446/*
1447 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001448 * Also used for Vim9 script. "callback" is invoked as:
1449 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001450 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001451 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001452ex_unletlock(
1453 exarg_T *eap,
1454 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001455 int deep,
1456 int glv_flags,
1457 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1458 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001459{
1460 char_u *arg = argstart;
1461 char_u *name_end;
1462 int error = FALSE;
1463 lval_T lv;
1464
1465 do
1466 {
1467 if (*arg == '$')
1468 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001469 lv.ll_name = arg;
1470 lv.ll_tv = NULL;
1471 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001472 if (get_env_len(&arg) == 0)
1473 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001474 semsg(_(e_invarg2), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001475 return;
1476 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001477 if (!error && !eap->skip
1478 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1479 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001480 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001481 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001482 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001483 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001484 // Parse the name and find the end.
1485 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
1486 glv_flags, FNE_CHECK_START);
1487 if (lv.ll_name == NULL)
1488 error = TRUE; // error but continue parsing
1489 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1490 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001491 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001492 if (name_end != NULL)
1493 {
1494 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001495 semsg(_(e_trailing_arg), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001496 }
1497 if (!(eap->skip || error))
1498 clear_lval(&lv);
1499 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001500 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001501
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001502 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001503 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001504 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001505
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001506 if (!eap->skip)
1507 clear_lval(&lv);
1508 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001509
1510 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001511 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001512
1513 eap->nextcmd = check_nextcmd(arg);
1514}
1515
1516 static int
1517do_unlet_var(
1518 lval_T *lp,
1519 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001520 exarg_T *eap,
1521 int deep UNUSED,
1522 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001523{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001524 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001525 int ret = OK;
1526 int cc;
1527
1528 if (lp->ll_tv == NULL)
1529 {
1530 cc = *name_end;
1531 *name_end = NUL;
1532
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001533 // Environment variable, normal name or expanded name.
1534 if (*lp->ll_name == '$')
1535 vim_unsetenv(lp->ll_name + 1);
1536 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001537 ret = FAIL;
1538 *name_end = cc;
1539 }
1540 else if ((lp->ll_list != NULL
1541 && var_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
1542 || (lp->ll_dict != NULL
1543 && var_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
1544 return FAIL;
1545 else if (lp->ll_range)
1546 {
1547 listitem_T *li;
1548 listitem_T *ll_li = lp->ll_li;
1549 int ll_n1 = lp->ll_n1;
1550
1551 while (ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= ll_n1))
1552 {
1553 li = ll_li->li_next;
1554 if (var_check_lock(ll_li->li_tv.v_lock, lp->ll_name, FALSE))
1555 return FAIL;
1556 ll_li = li;
1557 ++ll_n1;
1558 }
1559
1560 // Delete a range of List items.
1561 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
1562 {
1563 li = lp->ll_li->li_next;
1564 listitem_remove(lp->ll_list, lp->ll_li);
1565 lp->ll_li = li;
1566 ++lp->ll_n1;
1567 }
1568 }
1569 else
1570 {
1571 if (lp->ll_list != NULL)
1572 // unlet a List item.
1573 listitem_remove(lp->ll_list, lp->ll_li);
1574 else
1575 // unlet a Dictionary item.
1576 dictitem_remove(lp->ll_dict, lp->ll_di);
1577 }
1578
1579 return ret;
1580}
1581
1582/*
1583 * "unlet" a variable. Return OK if it existed, FAIL if not.
1584 * When "forceit" is TRUE don't complain if the variable doesn't exist.
1585 */
1586 int
1587do_unlet(char_u *name, int forceit)
1588{
1589 hashtab_T *ht;
1590 hashitem_T *hi;
1591 char_u *varname;
1592 dict_T *d;
1593 dictitem_T *di;
1594
Bram Moolenaareb6880b2020-07-12 17:07:05 +02001595 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001596 return FAIL;
1597
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001598 ht = find_var_ht(name, &varname);
1599 if (ht != NULL && *varname != NUL)
1600 {
1601 d = get_current_funccal_dict(ht);
1602 if (d == NULL)
1603 {
1604 if (ht == &globvarht)
1605 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001606 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001607 d = &vimvardict;
1608 else
1609 {
1610 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
1611 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
1612 }
1613 if (d == NULL)
1614 {
1615 internal_error("do_unlet()");
1616 return FAIL;
1617 }
1618 }
1619 hi = hash_find(ht, varname);
1620 if (HASHITEM_EMPTY(hi))
1621 hi = find_hi_in_scoped_ht(name, &ht);
1622 if (hi != NULL && !HASHITEM_EMPTY(hi))
1623 {
1624 di = HI2DI(hi);
1625 if (var_check_fixed(di->di_flags, name, FALSE)
1626 || var_check_ro(di->di_flags, name, FALSE)
1627 || var_check_lock(d->dv_lock, name, FALSE))
1628 return FAIL;
1629
1630 delete_var(ht, hi);
1631 return OK;
1632 }
1633 }
1634 if (forceit)
1635 return OK;
1636 semsg(_("E108: No such variable: \"%s\""), name);
1637 return FAIL;
1638}
1639
1640/*
1641 * Lock or unlock variable indicated by "lp".
1642 * "deep" is the levels to go (-1 for unlimited);
1643 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
1644 */
1645 static int
1646do_lock_var(
1647 lval_T *lp,
1648 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001649 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001650 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001651 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001652{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001653 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001654 int ret = OK;
1655 int cc;
1656 dictitem_T *di;
1657
1658 if (deep == 0) // nothing to do
1659 return OK;
1660
1661 if (lp->ll_tv == NULL)
1662 {
1663 cc = *name_end;
1664 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001665 if (*lp->ll_name == '$')
1666 {
1667 semsg(_(e_lock_unlock), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001668 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001669 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001670 else
1671 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001672 // Normal name or expanded name.
1673 di = find_var(lp->ll_name, NULL, TRUE);
1674 if (di == NULL)
1675 ret = FAIL;
1676 else if ((di->di_flags & DI_FLAGS_FIX)
1677 && di->di_tv.v_type != VAR_DICT
1678 && di->di_tv.v_type != VAR_LIST)
1679 {
1680 // For historic reasons this error is not given for a list or
1681 // dict. E.g., the b: dict could be locked/unlocked.
1682 semsg(_(e_lock_unlock), lp->ll_name);
1683 ret = FAIL;
1684 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001685 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001686 {
1687 if (lock)
1688 di->di_flags |= DI_FLAGS_LOCK;
1689 else
1690 di->di_flags &= ~DI_FLAGS_LOCK;
1691 item_lock(&di->di_tv, deep, lock);
1692 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001693 }
1694 *name_end = cc;
1695 }
1696 else if (lp->ll_range)
1697 {
1698 listitem_T *li = lp->ll_li;
1699
1700 // (un)lock a range of List items.
1701 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
1702 {
1703 item_lock(&li->li_tv, deep, lock);
1704 li = li->li_next;
1705 ++lp->ll_n1;
1706 }
1707 }
1708 else if (lp->ll_list != NULL)
1709 // (un)lock a List item.
1710 item_lock(&lp->ll_li->li_tv, deep, lock);
1711 else
1712 // (un)lock a Dictionary item.
1713 item_lock(&lp->ll_di->di_tv, deep, lock);
1714
1715 return ret;
1716}
1717
1718/*
1719 * Lock or unlock an item. "deep" is nr of levels to go.
1720 */
1721 static void
1722item_lock(typval_T *tv, int deep, int lock)
1723{
1724 static int recurse = 0;
1725 list_T *l;
1726 listitem_T *li;
1727 dict_T *d;
1728 blob_T *b;
1729 hashitem_T *hi;
1730 int todo;
1731
1732 if (recurse >= DICT_MAXNEST)
1733 {
1734 emsg(_("E743: variable nested too deep for (un)lock"));
1735 return;
1736 }
1737 if (deep == 0)
1738 return;
1739 ++recurse;
1740
1741 // lock/unlock the item itself
1742 if (lock)
1743 tv->v_lock |= VAR_LOCKED;
1744 else
1745 tv->v_lock &= ~VAR_LOCKED;
1746
1747 switch (tv->v_type)
1748 {
1749 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02001750 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001751 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001752 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001753 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001754 case VAR_STRING:
1755 case VAR_FUNC:
1756 case VAR_PARTIAL:
1757 case VAR_FLOAT:
1758 case VAR_SPECIAL:
1759 case VAR_JOB:
1760 case VAR_CHANNEL:
1761 break;
1762
1763 case VAR_BLOB:
1764 if ((b = tv->vval.v_blob) != NULL)
1765 {
1766 if (lock)
1767 b->bv_lock |= VAR_LOCKED;
1768 else
1769 b->bv_lock &= ~VAR_LOCKED;
1770 }
1771 break;
1772 case VAR_LIST:
1773 if ((l = tv->vval.v_list) != NULL)
1774 {
1775 if (lock)
1776 l->lv_lock |= VAR_LOCKED;
1777 else
1778 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001779 if ((deep < 0 || deep > 1) && l->lv_first != &range_list_item)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001780 // recursive: lock/unlock the items the List contains
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001781 FOR_ALL_LIST_ITEMS(l, li)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001782 item_lock(&li->li_tv, deep - 1, lock);
1783 }
1784 break;
1785 case VAR_DICT:
1786 if ((d = tv->vval.v_dict) != NULL)
1787 {
1788 if (lock)
1789 d->dv_lock |= VAR_LOCKED;
1790 else
1791 d->dv_lock &= ~VAR_LOCKED;
1792 if (deep < 0 || deep > 1)
1793 {
1794 // recursive: lock/unlock the items the List contains
1795 todo = (int)d->dv_hashtab.ht_used;
1796 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
1797 {
1798 if (!HASHITEM_EMPTY(hi))
1799 {
1800 --todo;
1801 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
1802 }
1803 }
1804 }
1805 }
1806 }
1807 --recurse;
1808}
1809
Bram Moolenaarda6c0332019-09-01 16:01:30 +02001810#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
1811/*
1812 * Delete all "menutrans_" variables.
1813 */
1814 void
1815del_menutrans_vars(void)
1816{
1817 hashitem_T *hi;
1818 int todo;
1819
1820 hash_lock(&globvarht);
1821 todo = (int)globvarht.ht_used;
1822 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
1823 {
1824 if (!HASHITEM_EMPTY(hi))
1825 {
1826 --todo;
1827 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
1828 delete_var(&globvarht, hi);
1829 }
1830 }
1831 hash_unlock(&globvarht);
1832}
1833#endif
1834
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001835/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001836 * Local string buffer for the next two functions to store a variable name
1837 * with its prefix. Allocated in cat_prefix_varname(), freed later in
1838 * get_user_var_name().
1839 */
1840
1841static char_u *varnamebuf = NULL;
1842static int varnamebuflen = 0;
1843
1844/*
1845 * Function to concatenate a prefix and a variable name.
1846 */
1847 static char_u *
1848cat_prefix_varname(int prefix, char_u *name)
1849{
1850 int len;
1851
1852 len = (int)STRLEN(name) + 3;
1853 if (len > varnamebuflen)
1854 {
1855 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02001856 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001857 varnamebuf = alloc(len);
1858 if (varnamebuf == NULL)
1859 {
1860 varnamebuflen = 0;
1861 return NULL;
1862 }
1863 varnamebuflen = len;
1864 }
1865 *varnamebuf = prefix;
1866 varnamebuf[1] = ':';
1867 STRCPY(varnamebuf + 2, name);
1868 return varnamebuf;
1869}
1870
1871/*
1872 * Function given to ExpandGeneric() to obtain the list of user defined
1873 * (global/buffer/window/built-in) variable names.
1874 */
1875 char_u *
1876get_user_var_name(expand_T *xp, int idx)
1877{
1878 static long_u gdone;
1879 static long_u bdone;
1880 static long_u wdone;
1881 static long_u tdone;
1882 static int vidx;
1883 static hashitem_T *hi;
1884 hashtab_T *ht;
1885
1886 if (idx == 0)
1887 {
1888 gdone = bdone = wdone = vidx = 0;
1889 tdone = 0;
1890 }
1891
1892 // Global variables
1893 if (gdone < globvarht.ht_used)
1894 {
1895 if (gdone++ == 0)
1896 hi = globvarht.ht_array;
1897 else
1898 ++hi;
1899 while (HASHITEM_EMPTY(hi))
1900 ++hi;
1901 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
1902 return cat_prefix_varname('g', hi->hi_key);
1903 return hi->hi_key;
1904 }
1905
1906 // b: variables
1907 ht = &curbuf->b_vars->dv_hashtab;
1908 if (bdone < ht->ht_used)
1909 {
1910 if (bdone++ == 0)
1911 hi = ht->ht_array;
1912 else
1913 ++hi;
1914 while (HASHITEM_EMPTY(hi))
1915 ++hi;
1916 return cat_prefix_varname('b', hi->hi_key);
1917 }
1918
1919 // w: variables
1920 ht = &curwin->w_vars->dv_hashtab;
1921 if (wdone < ht->ht_used)
1922 {
1923 if (wdone++ == 0)
1924 hi = ht->ht_array;
1925 else
1926 ++hi;
1927 while (HASHITEM_EMPTY(hi))
1928 ++hi;
1929 return cat_prefix_varname('w', hi->hi_key);
1930 }
1931
1932 // t: variables
1933 ht = &curtab->tp_vars->dv_hashtab;
1934 if (tdone < ht->ht_used)
1935 {
1936 if (tdone++ == 0)
1937 hi = ht->ht_array;
1938 else
1939 ++hi;
1940 while (HASHITEM_EMPTY(hi))
1941 ++hi;
1942 return cat_prefix_varname('t', hi->hi_key);
1943 }
1944
1945 // v: variables
1946 if (vidx < VV_LEN)
1947 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
1948
1949 VIM_CLEAR(varnamebuf);
1950 varnamebuflen = 0;
1951 return NULL;
1952}
1953
Bram Moolenaarda6c0332019-09-01 16:01:30 +02001954 char *
1955get_var_special_name(int nr)
1956{
1957 switch (nr)
1958 {
1959 case VVAL_FALSE: return "v:false";
1960 case VVAL_TRUE: return "v:true";
1961 case VVAL_NONE: return "v:none";
1962 case VVAL_NULL: return "v:null";
1963 }
1964 internal_error("get_var_special_name()");
1965 return "42";
1966}
1967
1968/*
1969 * Returns the global variable dictionary
1970 */
1971 dict_T *
1972get_globvar_dict(void)
1973{
1974 return &globvardict;
1975}
1976
1977/*
1978 * Returns the global variable hash table
1979 */
1980 hashtab_T *
1981get_globvar_ht(void)
1982{
1983 return &globvarht;
1984}
1985
1986/*
1987 * Returns the v: variable dictionary
1988 */
1989 dict_T *
1990get_vimvar_dict(void)
1991{
1992 return &vimvardict;
1993}
1994
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001995/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001996 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02001997 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001998 */
1999 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002000find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002001{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002002 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2003 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002004
2005 if (di == NULL)
2006 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002007 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002008 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2009 return (int)(vv - vimvars);
2010}
2011
2012
2013/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002014 * Set type of v: variable to "type".
2015 */
2016 void
2017set_vim_var_type(int idx, vartype_T type)
2018{
2019 vimvars[idx].vv_type = type;
2020}
2021
2022/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002023 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002024 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002025 */
2026 void
2027set_vim_var_nr(int idx, varnumber_T val)
2028{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002029 vimvars[idx].vv_nr = val;
2030}
2031
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002032 char *
2033get_vim_var_name(int idx)
2034{
2035 return vimvars[idx].vv_name;
2036}
2037
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002038/*
2039 * Get typval_T v: variable value.
2040 */
2041 typval_T *
2042get_vim_var_tv(int idx)
2043{
2044 return &vimvars[idx].vv_tv;
2045}
2046
2047/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002048 * Set v: variable to "tv". Only accepts the same type.
2049 * Takes over the value of "tv".
2050 */
2051 int
2052set_vim_var_tv(int idx, typval_T *tv)
2053{
2054 if (vimvars[idx].vv_type != tv->v_type)
2055 {
2056 emsg(_("E1063: type mismatch for v: variable"));
2057 clear_tv(tv);
2058 return FAIL;
2059 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002060 // VV_RO is also checked when compiling, but let's check here as well.
2061 if (vimvars[idx].vv_flags & VV_RO)
2062 {
2063 semsg(_(e_readonlyvar), vimvars[idx].vv_name);
2064 return FAIL;
2065 }
2066 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2067 {
2068 semsg(_(e_readonlysbx), vimvars[idx].vv_name);
2069 return FAIL;
2070 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002071 clear_tv(&vimvars[idx].vv_di.di_tv);
2072 vimvars[idx].vv_di.di_tv = *tv;
2073 return OK;
2074}
2075
2076/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002077 * Get number v: variable value.
2078 */
2079 varnumber_T
2080get_vim_var_nr(int idx)
2081{
2082 return vimvars[idx].vv_nr;
2083}
2084
2085/*
2086 * Get string v: variable value. Uses a static buffer, can only be used once.
2087 * If the String variable has never been set, return an empty string.
2088 * Never returns NULL;
2089 */
2090 char_u *
2091get_vim_var_str(int idx)
2092{
2093 return tv_get_string(&vimvars[idx].vv_tv);
2094}
2095
2096/*
2097 * Get List v: variable value. Caller must take care of reference count when
2098 * needed.
2099 */
2100 list_T *
2101get_vim_var_list(int idx)
2102{
2103 return vimvars[idx].vv_list;
2104}
2105
2106/*
2107 * Get Dict v: variable value. Caller must take care of reference count when
2108 * needed.
2109 */
2110 dict_T *
2111get_vim_var_dict(int idx)
2112{
2113 return vimvars[idx].vv_dict;
2114}
2115
2116/*
2117 * Set v:char to character "c".
2118 */
2119 void
2120set_vim_var_char(int c)
2121{
2122 char_u buf[MB_MAXBYTES + 1];
2123
2124 if (has_mbyte)
2125 buf[(*mb_char2bytes)(c, buf)] = NUL;
2126 else
2127 {
2128 buf[0] = c;
2129 buf[1] = NUL;
2130 }
2131 set_vim_var_string(VV_CHAR, buf, -1);
2132}
2133
2134/*
2135 * Set v:count to "count" and v:count1 to "count1".
2136 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2137 */
2138 void
2139set_vcount(
2140 long count,
2141 long count1,
2142 int set_prevcount)
2143{
2144 if (set_prevcount)
2145 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2146 vimvars[VV_COUNT].vv_nr = count;
2147 vimvars[VV_COUNT1].vv_nr = count1;
2148}
2149
2150/*
2151 * Save variables that might be changed as a side effect. Used when executing
2152 * a timer callback.
2153 */
2154 void
2155save_vimvars(vimvars_save_T *vvsave)
2156{
2157 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2158 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2159 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2160}
2161
2162/*
2163 * Restore variables saved by save_vimvars().
2164 */
2165 void
2166restore_vimvars(vimvars_save_T *vvsave)
2167{
2168 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2169 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2170 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2171}
2172
2173/*
2174 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2175 * value.
2176 */
2177 void
2178set_vim_var_string(
2179 int idx,
2180 char_u *val,
2181 int len) // length of "val" to use or -1 (whole string)
2182{
2183 clear_tv(&vimvars[idx].vv_di.di_tv);
2184 vimvars[idx].vv_type = VAR_STRING;
2185 if (val == NULL)
2186 vimvars[idx].vv_str = NULL;
2187 else if (len == -1)
2188 vimvars[idx].vv_str = vim_strsave(val);
2189 else
2190 vimvars[idx].vv_str = vim_strnsave(val, len);
2191}
2192
2193/*
2194 * Set List v: variable to "val".
2195 */
2196 void
2197set_vim_var_list(int idx, list_T *val)
2198{
2199 clear_tv(&vimvars[idx].vv_di.di_tv);
2200 vimvars[idx].vv_type = VAR_LIST;
2201 vimvars[idx].vv_list = val;
2202 if (val != NULL)
2203 ++val->lv_refcount;
2204}
2205
2206/*
2207 * Set Dictionary v: variable to "val".
2208 */
2209 void
2210set_vim_var_dict(int idx, dict_T *val)
2211{
2212 clear_tv(&vimvars[idx].vv_di.di_tv);
2213 vimvars[idx].vv_type = VAR_DICT;
2214 vimvars[idx].vv_dict = val;
2215 if (val != NULL)
2216 {
2217 ++val->dv_refcount;
2218 dict_set_items_ro(val);
2219 }
2220}
2221
2222/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002223 * Set the v:argv list.
2224 */
2225 void
2226set_argv_var(char **argv, int argc)
2227{
2228 list_T *l = list_alloc();
2229 int i;
2230
2231 if (l == NULL)
2232 getout(1);
2233 l->lv_lock = VAR_FIXED;
2234 for (i = 0; i < argc; ++i)
2235 {
2236 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2237 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002238 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002239 }
2240 set_vim_var_list(VV_ARGV, l);
2241}
2242
2243/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002244 * Reset v:register, taking the 'clipboard' setting into account.
2245 */
2246 void
2247reset_reg_var(void)
2248{
2249 int regname = 0;
2250
2251 // Adjust the register according to 'clipboard', so that when
2252 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2253#ifdef FEAT_CLIPBOARD
2254 adjust_clip_reg(&regname);
2255#endif
2256 set_reg_var(regname);
2257}
2258
2259/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002260 * Set v:register if needed.
2261 */
2262 void
2263set_reg_var(int c)
2264{
2265 char_u regname;
2266
2267 if (c == 0 || c == ' ')
2268 regname = '"';
2269 else
2270 regname = c;
2271 // Avoid free/alloc when the value is already right.
2272 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2273 set_vim_var_string(VV_REG, &regname, 1);
2274}
2275
2276/*
2277 * Get or set v:exception. If "oldval" == NULL, return the current value.
2278 * Otherwise, restore the value to "oldval" and return NULL.
2279 * Must always be called in pairs to save and restore v:exception! Does not
2280 * take care of memory allocations.
2281 */
2282 char_u *
2283v_exception(char_u *oldval)
2284{
2285 if (oldval == NULL)
2286 return vimvars[VV_EXCEPTION].vv_str;
2287
2288 vimvars[VV_EXCEPTION].vv_str = oldval;
2289 return NULL;
2290}
2291
2292/*
2293 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2294 * Otherwise, restore the value to "oldval" and return NULL.
2295 * Must always be called in pairs to save and restore v:throwpoint! Does not
2296 * take care of memory allocations.
2297 */
2298 char_u *
2299v_throwpoint(char_u *oldval)
2300{
2301 if (oldval == NULL)
2302 return vimvars[VV_THROWPOINT].vv_str;
2303
2304 vimvars[VV_THROWPOINT].vv_str = oldval;
2305 return NULL;
2306}
2307
2308/*
2309 * Set v:cmdarg.
2310 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2311 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2312 * Must always be called in pairs!
2313 */
2314 char_u *
2315set_cmdarg(exarg_T *eap, char_u *oldarg)
2316{
2317 char_u *oldval;
2318 char_u *newval;
2319 unsigned len;
2320
2321 oldval = vimvars[VV_CMDARG].vv_str;
2322 if (eap == NULL)
2323 {
2324 vim_free(oldval);
2325 vimvars[VV_CMDARG].vv_str = oldarg;
2326 return NULL;
2327 }
2328
2329 if (eap->force_bin == FORCE_BIN)
2330 len = 6;
2331 else if (eap->force_bin == FORCE_NOBIN)
2332 len = 8;
2333 else
2334 len = 0;
2335
2336 if (eap->read_edit)
2337 len += 7;
2338
2339 if (eap->force_ff != 0)
2340 len += 10; // " ++ff=unix"
2341 if (eap->force_enc != 0)
2342 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2343 if (eap->bad_char != 0)
2344 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2345
2346 newval = alloc(len + 1);
2347 if (newval == NULL)
2348 return NULL;
2349
2350 if (eap->force_bin == FORCE_BIN)
2351 sprintf((char *)newval, " ++bin");
2352 else if (eap->force_bin == FORCE_NOBIN)
2353 sprintf((char *)newval, " ++nobin");
2354 else
2355 *newval = NUL;
2356
2357 if (eap->read_edit)
2358 STRCAT(newval, " ++edit");
2359
2360 if (eap->force_ff != 0)
2361 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2362 eap->force_ff == 'u' ? "unix"
2363 : eap->force_ff == 'd' ? "dos"
2364 : "mac");
2365 if (eap->force_enc != 0)
2366 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2367 eap->cmd + eap->force_enc);
2368 if (eap->bad_char == BAD_KEEP)
2369 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2370 else if (eap->bad_char == BAD_DROP)
2371 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2372 else if (eap->bad_char != 0)
2373 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2374 vimvars[VV_CMDARG].vv_str = newval;
2375 return oldval;
2376}
2377
2378/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002379 * Get the value of internal variable "name".
2380 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2381 */
2382 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002383eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002384 char_u *name,
2385 int len, // length of "name"
2386 typval_T *rettv, // NULL when only checking existence
2387 dictitem_T **dip, // non-NULL when typval's dict item is needed
2388 int verbose, // may give error message
2389 int no_autoload) // do not use script autoloading
2390{
2391 int ret = OK;
2392 typval_T *tv = NULL;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002393 int foundFunc = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002394 dictitem_T *v;
2395 int cc;
2396
2397 // truncate the name, so that we can use strcmp()
2398 cc = name[len];
2399 name[len] = NUL;
2400
2401 // Check for user-defined variables.
2402 v = find_var(name, NULL, no_autoload);
2403 if (v != NULL)
2404 {
2405 tv = &v->di_tv;
2406 if (dip != NULL)
2407 *dip = v;
2408 }
2409
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002410 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002411 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002412 imported_T *import;
2413 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
2414
2415 import = find_imported(p, 0, NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002416
2417 // imported variable from another script
2418 if (import != NULL)
2419 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002420 if (import->imp_funcname != NULL)
2421 {
2422 foundFunc = TRUE;
2423 if (rettv != NULL)
2424 {
2425 rettv->v_type = VAR_FUNC;
2426 rettv->vval.v_string = vim_strsave(import->imp_funcname);
2427 }
2428 }
2429 else
2430 {
2431 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02002432 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002433 + import->imp_var_vals_idx;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002434 tv = sv->sv_tv;
2435 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002436 }
2437 }
2438
Bram Moolenaarc620c052020-07-08 15:16:19 +02002439 if (!foundFunc)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002440 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002441 if (tv == NULL)
2442 {
2443 if (rettv != NULL && verbose)
2444 semsg(_(e_undefvar), name);
2445 ret = FAIL;
2446 }
2447 else if (rettv != NULL)
2448 copy_tv(tv, rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002449 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002450
2451 name[len] = cc;
2452
2453 return ret;
2454}
2455
2456/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002457 * Check if variable "name[len]" is a local variable or an argument.
2458 * If so, "*eval_lavars_used" is set to TRUE.
2459 */
2460 void
2461check_vars(char_u *name, int len)
2462{
2463 int cc;
2464 char_u *varname;
2465 hashtab_T *ht;
2466
2467 if (eval_lavars_used == NULL)
2468 return;
2469
2470 // truncate the name, so that we can use strcmp()
2471 cc = name[len];
2472 name[len] = NUL;
2473
2474 ht = find_var_ht(name, &varname);
2475 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
2476 {
2477 if (find_var(name, NULL, TRUE) != NULL)
2478 *eval_lavars_used = TRUE;
2479 }
2480
2481 name[len] = cc;
2482}
2483
2484/*
2485 * Find variable "name" in the list of variables.
2486 * Return a pointer to it if found, NULL if not found.
2487 * Careful: "a:0" variables don't have a name.
2488 * When "htp" is not NULL we are writing to the variable, set "htp" to the
2489 * hashtab_T used.
2490 */
2491 dictitem_T *
2492find_var(char_u *name, hashtab_T **htp, int no_autoload)
2493{
2494 char_u *varname;
2495 hashtab_T *ht;
2496 dictitem_T *ret = NULL;
2497
2498 ht = find_var_ht(name, &varname);
2499 if (htp != NULL)
2500 *htp = ht;
2501 if (ht == NULL)
2502 return NULL;
2503 ret = find_var_in_ht(ht, *name, varname, no_autoload || htp != NULL);
2504 if (ret != NULL)
2505 return ret;
2506
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002507 // Search in parent scope for lambda
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002508 return find_var_in_scoped_ht(name, no_autoload || htp != NULL);
2509}
2510
2511/*
2512 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02002513 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002514 * Returns NULL if not found.
2515 */
2516 dictitem_T *
2517find_var_in_ht(
2518 hashtab_T *ht,
2519 int htname,
2520 char_u *varname,
2521 int no_autoload)
2522{
2523 hashitem_T *hi;
2524
2525 if (*varname == NUL)
2526 {
2527 // Must be something like "s:", otherwise "ht" would be NULL.
2528 switch (htname)
2529 {
2530 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
2531 case 'g': return &globvars_var;
2532 case 'v': return &vimvars_var;
2533 case 'b': return &curbuf->b_bufvar;
2534 case 'w': return &curwin->w_winvar;
2535 case 't': return &curtab->tp_winvar;
2536 case 'l': return get_funccal_local_var();
2537 case 'a': return get_funccal_args_var();
2538 }
2539 return NULL;
2540 }
2541
2542 hi = hash_find(ht, varname);
2543 if (HASHITEM_EMPTY(hi))
2544 {
2545 // For global variables we may try auto-loading the script. If it
2546 // worked find the variable again. Don't auto-load a script if it was
2547 // loaded already, otherwise it would be loaded every time when
2548 // checking if a function name is a Funcref variable.
2549 if (ht == &globvarht && !no_autoload)
2550 {
2551 // Note: script_autoload() may make "hi" invalid. It must either
2552 // be obtained again or not used.
2553 if (!script_autoload(varname, FALSE) || aborting())
2554 return NULL;
2555 hi = hash_find(ht, varname);
2556 }
2557 if (HASHITEM_EMPTY(hi))
2558 return NULL;
2559 }
2560 return HI2DI(hi);
2561}
2562
2563/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002564 * Get the script-local hashtab. NULL if not in a script context.
2565 */
Bram Moolenaarbdff0122020-04-05 18:56:05 +02002566 static hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002567get_script_local_ht(void)
2568{
2569 scid_T sid = current_sctx.sc_sid;
2570
2571 if (sid > 0 && sid <= script_items.ga_len)
2572 return &SCRIPT_VARS(sid);
2573 return NULL;
2574}
2575
2576/*
2577 * Look for "name[len]" in script-local variables.
Bram Moolenaarb84a3812020-05-01 15:44:29 +02002578 * Return a non-NULL pointer when found, NULL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002579 */
Bram Moolenaarb84a3812020-05-01 15:44:29 +02002580 void *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002581lookup_scriptvar(char_u *name, size_t len, cctx_T *dummy UNUSED)
2582{
2583 hashtab_T *ht = get_script_local_ht();
2584 char_u buffer[30];
2585 char_u *p;
Bram Moolenaarb84a3812020-05-01 15:44:29 +02002586 void *res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002587 hashitem_T *hi;
2588
2589 if (ht == NULL)
Bram Moolenaarb84a3812020-05-01 15:44:29 +02002590 return NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002591 if (len < sizeof(buffer) - 1)
2592 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02002593 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002594 vim_strncpy(buffer, name, len);
2595 p = buffer;
2596 }
2597 else
2598 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002599 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002600 if (p == NULL)
Bram Moolenaarb84a3812020-05-01 15:44:29 +02002601 return NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002602 }
2603
2604 hi = hash_find(ht, p);
Bram Moolenaarb84a3812020-05-01 15:44:29 +02002605 res = HASHITEM_EMPTY(hi) ? NULL : hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002606
2607 // if not script-local, then perhaps imported
Bram Moolenaarb84a3812020-05-01 15:44:29 +02002608 if (res == NULL && find_imported(p, 0, NULL) != NULL)
2609 res = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002610
2611 if (p != buffer)
2612 vim_free(p);
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02002613 // Don't return "buffer", gcc complains.
2614 return res == NULL ? NULL : IObuff;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002615}
2616
2617/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002618 * Find the hashtab used for a variable name.
2619 * Return NULL if the name is not valid.
2620 * Set "varname" to the start of name without ':'.
2621 */
2622 hashtab_T *
2623find_var_ht(char_u *name, char_u **varname)
2624{
2625 hashitem_T *hi;
2626 hashtab_T *ht;
2627
2628 if (name[0] == NUL)
2629 return NULL;
2630 if (name[1] != ':')
2631 {
2632 // The name must not start with a colon or #.
2633 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
2634 return NULL;
2635 *varname = name;
2636
2637 // "version" is "v:version" in all scopes if scriptversion < 3.
2638 // Same for a few other variables marked with VV_COMPAT.
2639 if (current_sctx.sc_version < 3)
2640 {
2641 hi = hash_find(&compat_hashtab, name);
2642 if (!HASHITEM_EMPTY(hi))
2643 return &compat_hashtab;
2644 }
2645
2646 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002647 if (ht != NULL)
2648 return ht; // local variable
2649
2650 // in Vim9 script items at the script level are script-local
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002651 if (in_vim9script())
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002652 {
2653 ht = get_script_local_ht();
2654 if (ht != NULL)
2655 return ht;
2656 }
2657
2658 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002659 }
2660 *varname = name + 2;
2661 if (*name == 'g') // global variable
2662 return &globvarht;
2663 // There must be no ':' or '#' in the rest of the name, unless g: is used
2664 if (vim_strchr(name + 2, ':') != NULL
2665 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
2666 return NULL;
2667 if (*name == 'b') // buffer variable
2668 return &curbuf->b_vars->dv_hashtab;
2669 if (*name == 'w') // window variable
2670 return &curwin->w_vars->dv_hashtab;
2671 if (*name == 't') // tab page variable
2672 return &curtab->tp_vars->dv_hashtab;
2673 if (*name == 'v') // v: variable
2674 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002675 if (get_current_funccal() != NULL
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002676 && get_current_funccal()->func->uf_def_status == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002677 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002678 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002679 if (*name == 'a') // a: function argument
2680 return get_funccal_args_ht();
2681 if (*name == 'l') // l: local function variable
2682 return get_funccal_local_ht();
2683 }
2684 if (*name == 's') // script variable
2685 {
2686 ht = get_script_local_ht();
2687 if (ht != NULL)
2688 return ht;
2689 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002690 return NULL;
2691}
2692
2693/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002694 * Get the string value of a (global/local) variable.
2695 * Note: see tv_get_string() for how long the pointer remains valid.
2696 * Returns NULL when it doesn't exist.
2697 */
2698 char_u *
2699get_var_value(char_u *name)
2700{
2701 dictitem_T *v;
2702
2703 v = find_var(name, NULL, FALSE);
2704 if (v == NULL)
2705 return NULL;
2706 return tv_get_string(&v->di_tv);
2707}
2708
2709/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002710 * Allocate a new hashtab for a sourced script. It will be used while
2711 * sourcing this script and when executing functions defined in the script.
2712 */
2713 void
2714new_script_vars(scid_T id)
2715{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002716 scriptvar_T *sv;
2717
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01002718 sv = ALLOC_CLEAR_ONE(scriptvar_T);
2719 if (sv == NULL)
2720 return;
2721 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01002722 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002723}
2724
2725/*
2726 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
2727 * point to it.
2728 */
2729 void
2730init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
2731{
2732 hash_init(&dict->dv_hashtab);
2733 dict->dv_lock = 0;
2734 dict->dv_scope = scope;
2735 dict->dv_refcount = DO_NOT_FREE_CNT;
2736 dict->dv_copyID = 0;
2737 dict_var->di_tv.vval.v_dict = dict;
2738 dict_var->di_tv.v_type = VAR_DICT;
2739 dict_var->di_tv.v_lock = VAR_FIXED;
2740 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2741 dict_var->di_key[0] = NUL;
2742}
2743
2744/*
2745 * Unreference a dictionary initialized by init_var_dict().
2746 */
2747 void
2748unref_var_dict(dict_T *dict)
2749{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002750 // Now the dict needs to be freed if no one else is using it, go back to
2751 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002752 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
2753 dict_unref(dict);
2754}
2755
2756/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002757 * Clean up a list of internal variables.
2758 * Frees all allocated variables and the value they contain.
2759 * Clears hashtab "ht", does not free it.
2760 */
2761 void
2762vars_clear(hashtab_T *ht)
2763{
2764 vars_clear_ext(ht, TRUE);
2765}
2766
2767/*
2768 * Like vars_clear(), but only free the value if "free_val" is TRUE.
2769 */
2770 void
2771vars_clear_ext(hashtab_T *ht, int free_val)
2772{
2773 int todo;
2774 hashitem_T *hi;
2775 dictitem_T *v;
2776
2777 hash_lock(ht);
2778 todo = (int)ht->ht_used;
2779 for (hi = ht->ht_array; todo > 0; ++hi)
2780 {
2781 if (!HASHITEM_EMPTY(hi))
2782 {
2783 --todo;
2784
2785 // Free the variable. Don't remove it from the hashtab,
2786 // ht_array might change then. hash_clear() takes care of it
2787 // later.
2788 v = HI2DI(hi);
2789 if (free_val)
2790 clear_tv(&v->di_tv);
2791 if (v->di_flags & DI_FLAGS_ALLOC)
2792 vim_free(v);
2793 }
2794 }
2795 hash_clear(ht);
2796 ht->ht_used = 0;
2797}
2798
2799/*
2800 * Delete a variable from hashtab "ht" at item "hi".
2801 * Clear the variable value and free the dictitem.
2802 */
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002803 static void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002804delete_var(hashtab_T *ht, hashitem_T *hi)
2805{
2806 dictitem_T *di = HI2DI(hi);
2807
2808 hash_remove(ht, hi);
2809 clear_tv(&di->di_tv);
2810 vim_free(di);
2811}
2812
2813/*
2814 * List the value of one internal variable.
2815 */
2816 static void
2817list_one_var(dictitem_T *v, char *prefix, int *first)
2818{
2819 char_u *tofree;
2820 char_u *s;
2821 char_u numbuf[NUMBUFLEN];
2822
2823 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
2824 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
2825 s == NULL ? (char_u *)"" : s, first);
2826 vim_free(tofree);
2827}
2828
2829 static void
2830list_one_var_a(
2831 char *prefix,
2832 char_u *name,
2833 int type,
2834 char_u *string,
2835 int *first) // when TRUE clear rest of screen and set to FALSE
2836{
2837 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
2838 msg_start();
2839 msg_puts(prefix);
2840 if (name != NULL) // "a:" vars don't have a name stored
2841 msg_puts((char *)name);
2842 msg_putchar(' ');
2843 msg_advance(22);
2844 if (type == VAR_NUMBER)
2845 msg_putchar('#');
2846 else if (type == VAR_FUNC || type == VAR_PARTIAL)
2847 msg_putchar('*');
2848 else if (type == VAR_LIST)
2849 {
2850 msg_putchar('[');
2851 if (*string == '[')
2852 ++string;
2853 }
2854 else if (type == VAR_DICT)
2855 {
2856 msg_putchar('{');
2857 if (*string == '{')
2858 ++string;
2859 }
2860 else
2861 msg_putchar(' ');
2862
2863 msg_outtrans(string);
2864
2865 if (type == VAR_FUNC || type == VAR_PARTIAL)
2866 msg_puts("()");
2867 if (*first)
2868 {
2869 msg_clr_eos();
2870 *first = FALSE;
2871 }
2872}
2873
2874/*
2875 * Set variable "name" to value in "tv".
2876 * If the variable already exists, the value is updated.
2877 * Otherwise the variable is created.
2878 */
2879 void
2880set_var(
2881 char_u *name,
2882 typval_T *tv,
2883 int copy) // make copy of value in "tv"
2884{
Bram Moolenaareeb27bf2020-07-04 17:39:10 +02002885 set_var_const(name, NULL, tv, copy, LET_NO_COMMAND);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002886}
2887
2888/*
2889 * Set variable "name" to value in "tv".
2890 * If the variable already exists and "is_const" is FALSE the value is updated.
2891 * Otherwise the variable is created.
2892 */
2893 void
2894set_var_const(
2895 char_u *name,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002896 type_T *type,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002897 typval_T *tv,
2898 int copy, // make copy of value in "tv"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002899 int flags) // LET_IS_CONST and/or LET_NO_COMMAND
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002900{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002901 dictitem_T *di;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002902 char_u *varname;
2903 hashtab_T *ht;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002904 int is_script_local;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002905
2906 ht = find_var_ht(name, &varname);
2907 if (ht == NULL || *varname == NUL)
2908 {
2909 semsg(_(e_illvar), name);
2910 return;
2911 }
Bram Moolenaare55b1c02020-06-21 15:52:59 +02002912 is_script_local = ht == get_script_local_ht();
2913
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002914 if (in_vim9script()
Bram Moolenaare55b1c02020-06-21 15:52:59 +02002915 && !is_script_local
2916 && (flags & LET_NO_COMMAND) == 0
2917 && name[1] == ':')
Bram Moolenaar67979662020-06-20 22:50:47 +02002918 {
Bram Moolenaare55b1c02020-06-21 15:52:59 +02002919 vim9_declare_error(name);
Bram Moolenaar67979662020-06-20 22:50:47 +02002920 return;
2921 }
2922
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002923 di = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002924
2925 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002926 if (di == NULL)
2927 di = find_var_in_scoped_ht(name, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002928
2929 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002930 && var_check_func_name(name, di == NULL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002931 return;
2932
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002933 if (di != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002934 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002935 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002936 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002937 if (flags & LET_IS_CONST)
2938 {
2939 emsg(_(e_cannot_mod));
2940 return;
2941 }
2942
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002943 if (is_script_local && in_vim9script())
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002944 {
Bram Moolenaar34db91f2020-06-13 19:00:10 +02002945 if ((flags & LET_NO_COMMAND) == 0)
2946 {
2947 semsg(_("E1041: Redefining script item %s"), name);
2948 return;
2949 }
2950
2951 // check the type
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02002952 if (check_script_var_type(&di->di_tv, tv, name) == FAIL)
2953 return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002954 }
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02002955
2956 if (var_check_ro(di->di_flags, name, FALSE)
2957 || var_check_lock(di->di_tv.v_lock, name, FALSE))
2958 return;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002959 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002960 else
2961 // can only redefine once
2962 di->di_flags &= ~DI_FLAGS_RELOAD;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002963
2964 // existing variable, need to clear the value
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002965
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002966 // Handle setting internal di: variables separately where needed to
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002967 // prevent changing the type.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002968 if (ht == &vimvarht)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002969 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002970 if (di->di_tv.v_type == VAR_STRING)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002971 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002972 VIM_CLEAR(di->di_tv.vval.v_string);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002973 if (copy || tv->v_type != VAR_STRING)
2974 {
2975 char_u *val = tv_get_string(tv);
2976
2977 // Careful: when assigning to v:errmsg and tv_get_string()
Bram Moolenaar4b96df52020-01-26 22:00:26 +01002978 // causes an error message the variable will already be set.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002979 if (di->di_tv.vval.v_string == NULL)
2980 di->di_tv.vval.v_string = vim_strsave(val);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002981 }
2982 else
2983 {
2984 // Take over the string to avoid an extra alloc/free.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002985 di->di_tv.vval.v_string = tv->vval.v_string;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002986 tv->vval.v_string = NULL;
2987 }
2988 return;
2989 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002990 else if (di->di_tv.v_type == VAR_NUMBER)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002991 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002992 di->di_tv.vval.v_number = tv_get_number(tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002993 if (STRCMP(varname, "searchforward") == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002994 set_search_direction(di->di_tv.vval.v_number ? '/' : '?');
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002995#ifdef FEAT_SEARCH_EXTRA
2996 else if (STRCMP(varname, "hlsearch") == 0)
2997 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002998 no_hlsearch = !di->di_tv.vval.v_number;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002999 redraw_all_later(SOME_VALID);
3000 }
3001#endif
3002 return;
3003 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003004 else if (di->di_tv.v_type != tv->v_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003005 {
3006 semsg(_("E963: setting %s to value with wrong type"), name);
3007 return;
3008 }
3009 }
3010
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003011 clear_tv(&di->di_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003012 }
3013 else // add a new variable
3014 {
3015 // Can't add "v:" or "a:" variable.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003016 if (ht == &vimvarht || ht == get_funccal_args_ht())
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003017 {
3018 semsg(_(e_illvar), name);
3019 return;
3020 }
3021
3022 // Make sure the variable name is valid.
3023 if (!valid_varname(varname))
3024 return;
3025
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003026 di = alloc(sizeof(dictitem_T) + STRLEN(varname));
3027 if (di == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003028 return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003029 STRCPY(di->di_key, varname);
3030 if (hash_add(ht, DI2HIKEY(di)) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003031 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003032 vim_free(di);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003033 return;
3034 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003035 di->di_flags = DI_FLAGS_ALLOC;
3036 if (flags & LET_IS_CONST)
3037 di->di_flags |= DI_FLAGS_LOCK;
3038
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003039 if (is_script_local && in_vim9script())
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003040 {
Bram Moolenaar21b9e972020-01-26 19:26:46 +01003041 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003042
3043 // Store a pointer to the typval_T, so that it can be found by
3044 // index instead of using a hastab lookup.
3045 if (ga_grow(&si->sn_var_vals, 1) == OK)
3046 {
3047 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
3048 + si->sn_var_vals.ga_len;
3049 sv->sv_name = di->di_key;
3050 sv->sv_tv = &di->di_tv;
3051 sv->sv_type = type == NULL ? &t_any : type;
3052 sv->sv_const = (flags & LET_IS_CONST);
3053 sv->sv_export = is_export;
3054 ++si->sn_var_vals.ga_len;
3055
3056 // let ex_export() know the export worked.
3057 is_export = FALSE;
3058 }
3059 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003060 }
3061
3062 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003063 copy_tv(tv, &di->di_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003064 else
3065 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003066 di->di_tv = *tv;
3067 di->di_tv.v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003068 init_tv(tv);
3069 }
3070
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003071 if (flags & LET_IS_CONST)
3072 di->di_tv.v_lock |= VAR_LOCKED;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003073}
3074
3075/*
3076 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
3077 * Also give an error message.
3078 */
3079 int
3080var_check_ro(int flags, char_u *name, int use_gettext)
3081{
3082 if (flags & DI_FLAGS_RO)
3083 {
3084 semsg(_(e_readonlyvar), use_gettext ? (char_u *)_(name) : name);
3085 return TRUE;
3086 }
3087 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
3088 {
3089 semsg(_(e_readonlysbx), use_gettext ? (char_u *)_(name) : name);
3090 return TRUE;
3091 }
3092 return FALSE;
3093}
3094
3095/*
3096 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
3097 * Also give an error message.
3098 */
3099 int
3100var_check_fixed(int flags, char_u *name, int use_gettext)
3101{
3102 if (flags & DI_FLAGS_FIX)
3103 {
3104 semsg(_("E795: Cannot delete variable %s"),
3105 use_gettext ? (char_u *)_(name) : name);
3106 return TRUE;
3107 }
3108 return FALSE;
3109}
3110
3111/*
3112 * Check if a funcref is assigned to a valid variable name.
3113 * Return TRUE and give an error if not.
3114 */
3115 int
3116var_check_func_name(
3117 char_u *name, // points to start of variable name
3118 int new_var) // TRUE when creating the variable
3119{
3120 // Allow for w: b: s: and t:.
3121 if (!(vim_strchr((char_u *)"wbst", name[0]) != NULL && name[1] == ':')
3122 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
3123 ? name[2] : name[0]))
3124 {
3125 semsg(_("E704: Funcref variable name must start with a capital: %s"),
3126 name);
3127 return TRUE;
3128 }
3129 // Don't allow hiding a function. When "v" is not NULL we might be
3130 // assigning another function to the same var, the type is checked
3131 // below.
3132 if (new_var && function_exists(name, FALSE))
3133 {
3134 semsg(_("E705: Variable name conflicts with existing function: %s"),
3135 name);
3136 return TRUE;
3137 }
3138 return FALSE;
3139}
3140
3141/*
3142 * Return TRUE if "flags" indicates variable "name" is locked (immutable).
3143 * Also give an error message, using "name" or _("name") when use_gettext is
3144 * TRUE.
3145 */
3146 int
3147var_check_lock(int lock, char_u *name, int use_gettext)
3148{
3149 if (lock & VAR_LOCKED)
3150 {
3151 semsg(_("E741: Value is locked: %s"),
3152 name == NULL ? (char_u *)_("Unknown")
3153 : use_gettext ? (char_u *)_(name)
3154 : name);
3155 return TRUE;
3156 }
3157 if (lock & VAR_FIXED)
3158 {
3159 semsg(_("E742: Cannot change value of %s"),
3160 name == NULL ? (char_u *)_("Unknown")
3161 : use_gettext ? (char_u *)_(name)
3162 : name);
3163 return TRUE;
3164 }
3165 return FALSE;
3166}
3167
3168/*
3169 * Check if a variable name is valid.
3170 * Return FALSE and give an error if not.
3171 */
3172 int
3173valid_varname(char_u *varname)
3174{
3175 char_u *p;
3176
3177 for (p = varname; *p != NUL; ++p)
3178 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
3179 && *p != AUTOLOAD_CHAR)
3180 {
3181 semsg(_(e_illvar), varname);
3182 return FALSE;
3183 }
3184 return TRUE;
3185}
3186
3187/*
3188 * getwinvar() and gettabwinvar()
3189 */
3190 static void
3191getwinvar(
3192 typval_T *argvars,
3193 typval_T *rettv,
3194 int off) // 1 for gettabwinvar()
3195{
3196 win_T *win;
3197 char_u *varname;
3198 dictitem_T *v;
3199 tabpage_T *tp = NULL;
3200 int done = FALSE;
3201 win_T *oldcurwin;
3202 tabpage_T *oldtabpage;
3203 int need_switch_win;
3204
3205 if (off == 1)
3206 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3207 else
3208 tp = curtab;
3209 win = find_win_by_nr(&argvars[off], tp);
3210 varname = tv_get_string_chk(&argvars[off + 1]);
3211 ++emsg_off;
3212
3213 rettv->v_type = VAR_STRING;
3214 rettv->vval.v_string = NULL;
3215
3216 if (win != NULL && varname != NULL)
3217 {
3218 // Set curwin to be our win, temporarily. Also set the tabpage,
3219 // otherwise the window is not valid. Only do this when needed,
3220 // autocommands get blocked.
3221 need_switch_win = !(tp == curtab && win == curwin);
3222 if (!need_switch_win
3223 || switch_win(&oldcurwin, &oldtabpage, win, tp, TRUE) == OK)
3224 {
3225 if (*varname == '&')
3226 {
3227 if (varname[1] == NUL)
3228 {
3229 // get all window-local options in a dict
3230 dict_T *opts = get_winbuf_options(FALSE);
3231
3232 if (opts != NULL)
3233 {
3234 rettv_dict_set(rettv, opts);
3235 done = TRUE;
3236 }
3237 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003238 else if (eval_option(&varname, rettv, 1) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003239 // window-local-option
3240 done = TRUE;
3241 }
3242 else
3243 {
3244 // Look up the variable.
3245 // Let getwinvar({nr}, "") return the "w:" dictionary.
3246 v = find_var_in_ht(&win->w_vars->dv_hashtab, 'w',
3247 varname, FALSE);
3248 if (v != NULL)
3249 {
3250 copy_tv(&v->di_tv, rettv);
3251 done = TRUE;
3252 }
3253 }
3254 }
3255
3256 if (need_switch_win)
3257 // restore previous notion of curwin
3258 restore_win(oldcurwin, oldtabpage, TRUE);
3259 }
3260
3261 if (!done && argvars[off + 2].v_type != VAR_UNKNOWN)
3262 // use the default return value
3263 copy_tv(&argvars[off + 2], rettv);
3264
3265 --emsg_off;
3266}
3267
3268/*
3269 * "setwinvar()" and "settabwinvar()" functions
3270 */
3271 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003272setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003273{
3274 win_T *win;
3275 win_T *save_curwin;
3276 tabpage_T *save_curtab;
3277 int need_switch_win;
3278 char_u *varname, *winvarname;
3279 typval_T *varp;
3280 char_u nbuf[NUMBUFLEN];
3281 tabpage_T *tp = NULL;
3282
3283 if (check_secure())
3284 return;
3285
3286 if (off == 1)
3287 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3288 else
3289 tp = curtab;
3290 win = find_win_by_nr(&argvars[off], tp);
3291 varname = tv_get_string_chk(&argvars[off + 1]);
3292 varp = &argvars[off + 2];
3293
3294 if (win != NULL && varname != NULL && varp != NULL)
3295 {
3296 need_switch_win = !(tp == curtab && win == curwin);
3297 if (!need_switch_win
3298 || switch_win(&save_curwin, &save_curtab, win, tp, TRUE) == OK)
3299 {
3300 if (*varname == '&')
3301 {
3302 long numval;
3303 char_u *strval;
3304 int error = FALSE;
3305
3306 ++varname;
3307 numval = (long)tv_get_number_chk(varp, &error);
3308 strval = tv_get_string_buf_chk(varp, nbuf);
3309 if (!error && strval != NULL)
3310 set_option_value(varname, numval, strval, OPT_LOCAL);
3311 }
3312 else
3313 {
3314 winvarname = alloc(STRLEN(varname) + 3);
3315 if (winvarname != NULL)
3316 {
3317 STRCPY(winvarname, "w:");
3318 STRCPY(winvarname + 2, varname);
3319 set_var(winvarname, varp, TRUE);
3320 vim_free(winvarname);
3321 }
3322 }
3323 }
3324 if (need_switch_win)
3325 restore_win(save_curwin, save_curtab, TRUE);
3326 }
3327}
3328
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003329/*
3330 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
3331 * v:option_type, and v:option_command.
3332 */
3333 void
3334reset_v_option_vars(void)
3335{
3336 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
3337 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
3338 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
3339 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
3340 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
3341 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
3342}
3343
3344/*
3345 * Add an assert error to v:errors.
3346 */
3347 void
3348assert_error(garray_T *gap)
3349{
3350 struct vimvar *vp = &vimvars[VV_ERRORS];
3351
3352 if (vp->vv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003353 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003354 set_vim_var_list(VV_ERRORS, list_alloc());
3355 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
3356}
3357
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003358 int
3359var_exists(char_u *var)
3360{
3361 char_u *name;
3362 char_u *tofree;
3363 typval_T tv;
3364 int len = 0;
3365 int n = FALSE;
3366
3367 // get_name_len() takes care of expanding curly braces
3368 name = var;
3369 len = get_name_len(&var, &tofree, TRUE, FALSE);
3370 if (len > 0)
3371 {
3372 if (tofree != NULL)
3373 name = tofree;
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003374 n = (eval_variable(name, len, &tv, NULL, FALSE, TRUE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003375 if (n)
3376 {
3377 // handle d.key, l[idx], f(expr)
Bram Moolenaare40fbc22020-06-27 18:06:45 +02003378 n = (handle_subscript(&var, &tv, &EVALARG_EVALUATE, FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003379 if (n)
3380 clear_tv(&tv);
3381 }
3382 }
3383 if (*var != NUL)
3384 n = FALSE;
3385
3386 vim_free(tofree);
3387 return n;
3388}
3389
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003390static lval_T *redir_lval = NULL;
3391#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
3392static garray_T redir_ga; // only valid when redir_lval is not NULL
3393static char_u *redir_endp = NULL;
3394static char_u *redir_varname = NULL;
3395
3396/*
3397 * Start recording command output to a variable
3398 * When "append" is TRUE append to an existing variable.
3399 * Returns OK if successfully completed the setup. FAIL otherwise.
3400 */
3401 int
3402var_redir_start(char_u *name, int append)
3403{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003404 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003405 typval_T tv;
3406
3407 // Catch a bad name early.
3408 if (!eval_isnamec1(*name))
3409 {
3410 emsg(_(e_invarg));
3411 return FAIL;
3412 }
3413
3414 // Make a copy of the name, it is used in redir_lval until redir ends.
3415 redir_varname = vim_strsave(name);
3416 if (redir_varname == NULL)
3417 return FAIL;
3418
3419 redir_lval = ALLOC_CLEAR_ONE(lval_T);
3420 if (redir_lval == NULL)
3421 {
3422 var_redir_stop();
3423 return FAIL;
3424 }
3425
3426 // The output is stored in growarray "redir_ga" until redirection ends.
3427 ga_init2(&redir_ga, (int)sizeof(char), 500);
3428
3429 // Parse the variable name (can be a dict or list entry).
3430 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
3431 FNE_CHECK_START);
3432 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
3433 {
3434 clear_lval(redir_lval);
3435 if (redir_endp != NULL && *redir_endp != NUL)
3436 // Trailing characters are present after the variable name
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003437 semsg(_(e_trailing_arg), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003438 else
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003439 semsg(_(e_invarg2), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003440 redir_endp = NULL; // don't store a value, only cleanup
3441 var_redir_stop();
3442 return FAIL;
3443 }
3444
3445 // check if we can write to the variable: set it to or append an empty
3446 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003447 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003448 tv.v_type = VAR_STRING;
3449 tv.vval.v_string = (char_u *)"";
3450 if (append)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003451 set_var_lval(redir_lval, redir_endp, &tv, TRUE, 0, (char_u *)".");
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003452 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003453 set_var_lval(redir_lval, redir_endp, &tv, TRUE, 0, (char_u *)"=");
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003454 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003455 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003456 {
3457 redir_endp = NULL; // don't store a value, only cleanup
3458 var_redir_stop();
3459 return FAIL;
3460 }
3461
3462 return OK;
3463}
3464
3465/*
3466 * Append "value[value_len]" to the variable set by var_redir_start().
3467 * The actual appending is postponed until redirection ends, because the value
3468 * appended may in fact be the string we write to, changing it may cause freed
3469 * memory to be used:
3470 * :redir => foo
3471 * :let foo
3472 * :redir END
3473 */
3474 void
3475var_redir_str(char_u *value, int value_len)
3476{
3477 int len;
3478
3479 if (redir_lval == NULL)
3480 return;
3481
3482 if (value_len == -1)
3483 len = (int)STRLEN(value); // Append the entire string
3484 else
3485 len = value_len; // Append only "value_len" characters
3486
3487 if (ga_grow(&redir_ga, len) == OK)
3488 {
3489 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
3490 redir_ga.ga_len += len;
3491 }
3492 else
3493 var_redir_stop();
3494}
3495
3496/*
3497 * Stop redirecting command output to a variable.
3498 * Frees the allocated memory.
3499 */
3500 void
3501var_redir_stop(void)
3502{
3503 typval_T tv;
3504
3505 if (EVALCMD_BUSY)
3506 {
3507 redir_lval = NULL;
3508 return;
3509 }
3510
3511 if (redir_lval != NULL)
3512 {
3513 // If there was no error: assign the text to the variable.
3514 if (redir_endp != NULL)
3515 {
3516 ga_append(&redir_ga, NUL); // Append the trailing NUL.
3517 tv.v_type = VAR_STRING;
3518 tv.vval.v_string = redir_ga.ga_data;
3519 // Call get_lval() again, if it's inside a Dict or List it may
3520 // have changed.
3521 redir_endp = get_lval(redir_varname, NULL, redir_lval,
3522 FALSE, FALSE, 0, FNE_CHECK_START);
3523 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003524 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003525 (char_u *)".");
3526 clear_lval(redir_lval);
3527 }
3528
3529 // free the collected output
3530 VIM_CLEAR(redir_ga.ga_data);
3531
3532 VIM_CLEAR(redir_lval);
3533 }
3534 VIM_CLEAR(redir_varname);
3535}
3536
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003537/*
3538 * "gettabvar()" function
3539 */
3540 void
3541f_gettabvar(typval_T *argvars, typval_T *rettv)
3542{
3543 win_T *oldcurwin;
3544 tabpage_T *tp, *oldtabpage;
3545 dictitem_T *v;
3546 char_u *varname;
3547 int done = FALSE;
3548
3549 rettv->v_type = VAR_STRING;
3550 rettv->vval.v_string = NULL;
3551
3552 varname = tv_get_string_chk(&argvars[1]);
3553 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3554 if (tp != NULL && varname != NULL)
3555 {
3556 // Set tp to be our tabpage, temporarily. Also set the window to the
3557 // first window in the tabpage, otherwise the window is not valid.
3558 if (switch_win(&oldcurwin, &oldtabpage,
3559 tp == curtab || tp->tp_firstwin == NULL ? firstwin
3560 : tp->tp_firstwin, tp, TRUE) == OK)
3561 {
3562 // look up the variable
3563 // Let gettabvar({nr}, "") return the "t:" dictionary.
3564 v = find_var_in_ht(&tp->tp_vars->dv_hashtab, 't', varname, FALSE);
3565 if (v != NULL)
3566 {
3567 copy_tv(&v->di_tv, rettv);
3568 done = TRUE;
3569 }
3570 }
3571
3572 // restore previous notion of curwin
3573 restore_win(oldcurwin, oldtabpage, TRUE);
3574 }
3575
3576 if (!done && argvars[2].v_type != VAR_UNKNOWN)
3577 copy_tv(&argvars[2], rettv);
3578}
3579
3580/*
3581 * "gettabwinvar()" function
3582 */
3583 void
3584f_gettabwinvar(typval_T *argvars, typval_T *rettv)
3585{
3586 getwinvar(argvars, rettv, 1);
3587}
3588
3589/*
3590 * "getwinvar()" function
3591 */
3592 void
3593f_getwinvar(typval_T *argvars, typval_T *rettv)
3594{
3595 getwinvar(argvars, rettv, 0);
3596}
3597
3598/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003599 * "getbufvar()" function
3600 */
3601 void
3602f_getbufvar(typval_T *argvars, typval_T *rettv)
3603{
3604 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003605 char_u *varname;
3606 dictitem_T *v;
3607 int done = FALSE;
3608
3609 (void)tv_get_number(&argvars[0]); // issue errmsg if type error
3610 varname = tv_get_string_chk(&argvars[1]);
3611 ++emsg_off;
3612 buf = tv_get_buf(&argvars[0], FALSE);
3613
3614 rettv->v_type = VAR_STRING;
3615 rettv->vval.v_string = NULL;
3616
3617 if (buf != NULL && varname != NULL)
3618 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003619 if (*varname == '&')
3620 {
Bram Moolenaar86015452020-03-29 15:12:15 +02003621 buf_T *save_curbuf = curbuf;
3622
3623 // set curbuf to be our buf, temporarily
3624 curbuf = buf;
3625
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003626 if (varname[1] == NUL)
3627 {
3628 // get all buffer-local options in a dict
3629 dict_T *opts = get_winbuf_options(TRUE);
3630
3631 if (opts != NULL)
3632 {
3633 rettv_dict_set(rettv, opts);
3634 done = TRUE;
3635 }
3636 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003637 else if (eval_option(&varname, rettv, TRUE) == OK)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003638 // buffer-local-option
3639 done = TRUE;
Bram Moolenaar86015452020-03-29 15:12:15 +02003640
3641 // restore previous notion of curbuf
3642 curbuf = save_curbuf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003643 }
3644 else
3645 {
3646 // Look up the variable.
Bram Moolenaar52592752020-04-03 18:43:35 +02003647 if (*varname == NUL)
3648 // Let getbufvar({nr}, "") return the "b:" dictionary.
3649 v = &buf->b_bufvar;
3650 else
3651 v = find_var_in_ht(&buf->b_vars->dv_hashtab, 'b',
3652 varname, FALSE);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003653 if (v != NULL)
3654 {
3655 copy_tv(&v->di_tv, rettv);
3656 done = TRUE;
3657 }
3658 }
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003659 }
3660
3661 if (!done && argvars[2].v_type != VAR_UNKNOWN)
3662 // use the default value
3663 copy_tv(&argvars[2], rettv);
3664
3665 --emsg_off;
3666}
3667
3668/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003669 * "settabvar()" function
3670 */
3671 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003672f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003673{
3674 tabpage_T *save_curtab;
3675 tabpage_T *tp;
3676 char_u *varname, *tabvarname;
3677 typval_T *varp;
3678
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003679 if (check_secure())
3680 return;
3681
3682 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3683 varname = tv_get_string_chk(&argvars[1]);
3684 varp = &argvars[2];
3685
3686 if (varname != NULL && varp != NULL && tp != NULL)
3687 {
3688 save_curtab = curtab;
3689 goto_tabpage_tp(tp, FALSE, FALSE);
3690
3691 tabvarname = alloc(STRLEN(varname) + 3);
3692 if (tabvarname != NULL)
3693 {
3694 STRCPY(tabvarname, "t:");
3695 STRCPY(tabvarname + 2, varname);
3696 set_var(tabvarname, varp, TRUE);
3697 vim_free(tabvarname);
3698 }
3699
3700 // Restore current tabpage
3701 if (valid_tabpage(save_curtab))
3702 goto_tabpage_tp(save_curtab, FALSE, FALSE);
3703 }
3704}
3705
3706/*
3707 * "settabwinvar()" function
3708 */
3709 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003710f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003711{
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003712 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003713}
3714
3715/*
3716 * "setwinvar()" function
3717 */
3718 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003719f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003720{
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003721 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003722}
3723
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003724/*
3725 * "setbufvar()" function
3726 */
3727 void
3728f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
3729{
3730 buf_T *buf;
3731 char_u *varname, *bufvarname;
3732 typval_T *varp;
3733 char_u nbuf[NUMBUFLEN];
3734
3735 if (check_secure())
3736 return;
3737 (void)tv_get_number(&argvars[0]); // issue errmsg if type error
3738 varname = tv_get_string_chk(&argvars[1]);
3739 buf = tv_get_buf(&argvars[0], FALSE);
3740 varp = &argvars[2];
3741
3742 if (buf != NULL && varname != NULL && varp != NULL)
3743 {
3744 if (*varname == '&')
3745 {
3746 long numval;
3747 char_u *strval;
3748 int error = FALSE;
3749 aco_save_T aco;
3750
3751 // set curbuf to be our buf, temporarily
3752 aucmd_prepbuf(&aco, buf);
3753
3754 ++varname;
3755 numval = (long)tv_get_number_chk(varp, &error);
3756 strval = tv_get_string_buf_chk(varp, nbuf);
3757 if (!error && strval != NULL)
3758 set_option_value(varname, numval, strval, OPT_LOCAL);
3759
3760 // reset notion of buffer
3761 aucmd_restbuf(&aco);
3762 }
3763 else
3764 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003765 bufvarname = alloc(STRLEN(varname) + 3);
3766 if (bufvarname != NULL)
3767 {
Bram Moolenaar86015452020-03-29 15:12:15 +02003768 buf_T *save_curbuf = curbuf;
3769
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003770 curbuf = buf;
3771 STRCPY(bufvarname, "b:");
3772 STRCPY(bufvarname + 2, varname);
3773 set_var(bufvarname, varp, TRUE);
3774 vim_free(bufvarname);
3775 curbuf = save_curbuf;
3776 }
3777 }
3778 }
3779}
3780
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02003781/*
3782 * Get a callback from "arg". It can be a Funcref or a function name.
3783 * When "arg" is zero return an empty string.
3784 * "cb_name" is not allocated.
3785 * "cb_name" is set to NULL for an invalid argument.
3786 */
3787 callback_T
3788get_callback(typval_T *arg)
3789{
Bram Moolenaar14e579092020-03-07 16:59:25 +01003790 callback_T res;
3791 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02003792
3793 res.cb_free_name = FALSE;
3794 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
3795 {
3796 res.cb_partial = arg->vval.v_partial;
3797 ++res.cb_partial->pt_refcount;
3798 res.cb_name = partial_name(res.cb_partial);
3799 }
3800 else
3801 {
3802 res.cb_partial = NULL;
Bram Moolenaar14e579092020-03-07 16:59:25 +01003803 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
3804 && isdigit(*arg->vval.v_string))
3805 r = FAIL;
3806 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02003807 {
3808 // Note that we don't make a copy of the string.
3809 res.cb_name = arg->vval.v_string;
3810 func_ref(res.cb_name);
3811 }
3812 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02003813 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02003814 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01003815 r = FAIL;
3816
3817 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02003818 {
3819 emsg(_("E921: Invalid callback argument"));
3820 res.cb_name = NULL;
3821 }
3822 }
3823 return res;
3824}
3825
3826/*
3827 * Copy a callback into a typval_T.
3828 */
3829 void
3830put_callback(callback_T *cb, typval_T *tv)
3831{
3832 if (cb->cb_partial != NULL)
3833 {
3834 tv->v_type = VAR_PARTIAL;
3835 tv->vval.v_partial = cb->cb_partial;
3836 ++tv->vval.v_partial->pt_refcount;
3837 }
3838 else
3839 {
3840 tv->v_type = VAR_FUNC;
3841 tv->vval.v_string = vim_strsave(cb->cb_name);
3842 func_ref(cb->cb_name);
3843 }
3844}
3845
3846/*
3847 * Make a copy of "src" into "dest", allocating the function name if needed,
3848 * without incrementing the refcount.
3849 */
3850 void
3851set_callback(callback_T *dest, callback_T *src)
3852{
3853 if (src->cb_partial == NULL)
3854 {
3855 // just a function name, make a copy
3856 dest->cb_name = vim_strsave(src->cb_name);
3857 dest->cb_free_name = TRUE;
3858 }
3859 else
3860 {
3861 // cb_name is a pointer into cb_partial
3862 dest->cb_name = src->cb_name;
3863 dest->cb_free_name = FALSE;
3864 }
3865 dest->cb_partial = src->cb_partial;
3866}
3867
3868/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02003869 * Copy callback from "src" to "dest", incrementing the refcounts.
3870 */
3871 void
3872copy_callback(callback_T *dest, callback_T *src)
3873{
3874 dest->cb_partial = src->cb_partial;
3875 if (dest->cb_partial != NULL)
3876 {
3877 dest->cb_name = src->cb_name;
3878 dest->cb_free_name = FALSE;
3879 ++dest->cb_partial->pt_refcount;
3880 }
3881 else
3882 {
3883 dest->cb_name = vim_strsave(src->cb_name);
3884 dest->cb_free_name = TRUE;
3885 func_ref(src->cb_name);
3886 }
3887}
3888
3889/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02003890 * Unref/free "callback" returned by get_callback() or set_callback().
3891 */
3892 void
3893free_callback(callback_T *callback)
3894{
3895 if (callback->cb_partial != NULL)
3896 {
3897 partial_unref(callback->cb_partial);
3898 callback->cb_partial = NULL;
3899 }
3900 else if (callback->cb_name != NULL)
3901 func_unref(callback->cb_name);
3902 if (callback->cb_free_name)
3903 {
3904 vim_free(callback->cb_name);
3905 callback->cb_free_name = FALSE;
3906 }
3907 callback->cb_name = NULL;
3908}
3909
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003910#endif // FEAT_EVAL