blob: 0562b4ce22e0c1e2a670fbf3fb44bfc6c1b6f4f8 [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);
Bram Moolenaarbc4c5052020-08-13 22:47:35 +0200808 semsg(_(e_white_space_required_before_and_after), op);
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200809 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 {
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02001140 arg = skipwhite(arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001141 if (tofree != NULL)
1142 name = tofree;
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02001143 if (eval_variable(name, len, &tv, NULL, TRUE, FALSE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001144 error = TRUE;
1145 else
1146 {
1147 // handle d.key, l[idx], f(expr)
1148 arg_subsc = arg;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001149 if (handle_subscript(&arg, &tv, &EVALARG_EVALUATE, TRUE)
Bram Moolenaar0b1cd522020-06-27 13:11:50 +02001150 == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001151 error = TRUE;
1152 else
1153 {
1154 if (arg == arg_subsc && len == 2 && name[1] == ':')
1155 {
1156 switch (*name)
1157 {
1158 case 'g': list_glob_vars(first); break;
1159 case 'b': list_buf_vars(first); break;
1160 case 'w': list_win_vars(first); break;
1161 case 't': list_tab_vars(first); break;
1162 case 'v': list_vim_vars(first); break;
1163 case 's': list_script_vars(first); break;
1164 case 'l': list_func_vars(first); break;
1165 default:
1166 semsg(_("E738: Can't list variables for %s"), name);
1167 }
1168 }
1169 else
1170 {
1171 char_u numbuf[NUMBUFLEN];
1172 char_u *tf;
1173 int c;
1174 char_u *s;
1175
1176 s = echo_string(&tv, &tf, numbuf, 0);
1177 c = *arg;
1178 *arg = NUL;
1179 list_one_var_a("",
1180 arg == arg_subsc ? name : name_start,
1181 tv.v_type,
1182 s == NULL ? (char_u *)"" : s,
1183 first);
1184 *arg = c;
1185 vim_free(tf);
1186 }
1187 clear_tv(&tv);
1188 }
1189 }
1190 }
1191
1192 vim_free(tofree);
1193 }
1194
1195 arg = skipwhite(arg);
1196 }
1197
1198 return arg;
1199}
1200
1201/*
1202 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
1203 * Returns a pointer to the char just after the var name.
1204 * Returns NULL if there is an error.
1205 */
1206 static char_u *
1207ex_let_one(
1208 char_u *arg, // points to variable name
1209 typval_T *tv, // value to assign to variable
1210 int copy, // copy value from "tv"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001211 int flags, // LET_IS_CONST and/or LET_NO_COMMAND
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001212 char_u *endchars, // valid chars after variable name or NULL
1213 char_u *op) // "+", "-", "." or NULL
1214{
1215 int c1;
1216 char_u *name;
1217 char_u *p;
1218 char_u *arg_end = NULL;
1219 int len;
1220 int opt_flags;
1221 char_u *tofree = NULL;
1222
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001223 if (in_vim9script() && (flags & LET_NO_COMMAND) == 0
1224 && vim_strchr((char_u *)"$@&", *arg) != NULL)
1225 {
1226 vim9_declare_error(arg);
1227 return NULL;
1228 }
1229
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001230 // ":let $VAR = expr": Set environment variable.
1231 if (*arg == '$')
1232 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001233 if (flags & LET_IS_CONST)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001234 {
1235 emsg(_("E996: Cannot lock an environment variable"));
1236 return NULL;
1237 }
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001238
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001239 // Find the end of the name.
1240 ++arg;
1241 name = arg;
1242 len = get_env_len(&arg);
1243 if (len == 0)
1244 semsg(_(e_invarg2), name - 1);
1245 else
1246 {
1247 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1248 semsg(_(e_letwrong), op);
1249 else if (endchars != NULL
1250 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
1251 emsg(_(e_letunexp));
1252 else if (!check_secure())
1253 {
1254 c1 = name[len];
1255 name[len] = NUL;
1256 p = tv_get_string_chk(tv);
1257 if (p != NULL && op != NULL && *op == '.')
1258 {
1259 int mustfree = FALSE;
1260 char_u *s = vim_getenv(name, &mustfree);
1261
1262 if (s != NULL)
1263 {
1264 p = tofree = concat_str(s, p);
1265 if (mustfree)
1266 vim_free(s);
1267 }
1268 }
1269 if (p != NULL)
1270 {
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01001271 vim_setenv_ext(name, p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001272 arg_end = arg;
1273 }
1274 name[len] = c1;
1275 vim_free(tofree);
1276 }
1277 }
1278 }
1279
1280 // ":let &option = expr": Set option value.
1281 // ":let &l:option = expr": Set local option value.
1282 // ":let &g:option = expr": Set global option value.
1283 else if (*arg == '&')
1284 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001285 if (flags & LET_IS_CONST)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001286 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001287 emsg(_(e_const_option));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001288 return NULL;
1289 }
1290 // Find the end of the name.
1291 p = find_option_end(&arg, &opt_flags);
1292 if (p == NULL || (endchars != NULL
1293 && vim_strchr(endchars, *skipwhite(p)) == NULL))
1294 emsg(_(e_letunexp));
1295 else
1296 {
1297 long n;
1298 int opt_type;
1299 long numval;
1300 char_u *stringval = NULL;
Bram Moolenaar65d032c2020-04-24 20:57:01 +02001301 char_u *s = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001302
1303 c1 = *p;
1304 *p = NUL;
1305
1306 n = (long)tv_get_number(tv);
Bram Moolenaar65d032c2020-04-24 20:57:01 +02001307 // avoid setting a string option to the text "v:false" or similar.
1308 if (tv->v_type != VAR_BOOL && tv->v_type != VAR_SPECIAL)
1309 s = tv_get_string_chk(tv); // != NULL if number or string
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001310 if (s != NULL && op != NULL && *op != '=')
1311 {
1312 opt_type = get_option_value(arg, &numval,
1313 &stringval, opt_flags);
1314 if ((opt_type == 1 && *op == '.')
1315 || (opt_type == 0 && *op != '.'))
1316 {
1317 semsg(_(e_letwrong), op);
1318 s = NULL; // don't set the value
1319 }
1320 else
1321 {
1322 if (opt_type == 1) // number
1323 {
1324 switch (*op)
1325 {
1326 case '+': n = numval + n; break;
1327 case '-': n = numval - n; break;
1328 case '*': n = numval * n; break;
1329 case '/': n = (long)num_divide(numval, n); break;
1330 case '%': n = (long)num_modulus(numval, n); break;
1331 }
1332 }
1333 else if (opt_type == 0 && stringval != NULL) // string
1334 {
1335 s = concat_str(stringval, s);
1336 vim_free(stringval);
1337 stringval = s;
1338 }
1339 }
1340 }
Bram Moolenaar65d032c2020-04-24 20:57:01 +02001341 if (s != NULL || tv->v_type == VAR_BOOL
1342 || tv->v_type == VAR_SPECIAL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001343 {
1344 set_option_value(arg, n, s, opt_flags);
1345 arg_end = p;
1346 }
1347 *p = c1;
1348 vim_free(stringval);
1349 }
1350 }
1351
1352 // ":let @r = expr": Set register contents.
1353 else if (*arg == '@')
1354 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001355 if (flags & LET_IS_CONST)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001356 {
1357 emsg(_("E996: Cannot lock a register"));
1358 return NULL;
1359 }
1360 ++arg;
1361 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1362 semsg(_(e_letwrong), op);
1363 else if (endchars != NULL
1364 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
1365 emsg(_(e_letunexp));
1366 else
1367 {
1368 char_u *ptofree = NULL;
1369 char_u *s;
1370
1371 p = tv_get_string_chk(tv);
1372 if (p != NULL && op != NULL && *op == '.')
1373 {
1374 s = get_reg_contents(*arg == '@' ? '"' : *arg, GREG_EXPR_SRC);
1375 if (s != NULL)
1376 {
1377 p = ptofree = concat_str(s, p);
1378 vim_free(s);
1379 }
1380 }
1381 if (p != NULL)
1382 {
1383 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
1384 arg_end = arg + 1;
1385 }
1386 vim_free(ptofree);
1387 }
1388 }
1389
1390 // ":let var = expr": Set internal variable.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001391 // ":let var: type = expr": Set internal variable with type.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001392 // ":let {expr} = expr": Idem, name made with curly braces
1393 else if (eval_isnamec1(*arg) || *arg == '{')
1394 {
1395 lval_T lv;
1396
1397 p = get_lval(arg, tv, &lv, FALSE, FALSE, 0, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001398 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001399 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001400 if (endchars != NULL && vim_strchr(endchars,
1401 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001402 emsg(_(e_letunexp));
1403 else
1404 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001405 set_var_lval(&lv, p, tv, copy, flags, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001406 arg_end = p;
1407 }
1408 }
1409 clear_lval(&lv);
1410 }
1411
1412 else
1413 semsg(_(e_invarg2), arg);
1414
1415 return arg_end;
1416}
1417
1418/*
1419 * ":unlet[!] var1 ... " command.
1420 */
1421 void
1422ex_unlet(exarg_T *eap)
1423{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001424 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001425}
1426
1427/*
1428 * ":lockvar" and ":unlockvar" commands
1429 */
1430 void
1431ex_lockvar(exarg_T *eap)
1432{
1433 char_u *arg = eap->arg;
1434 int deep = 2;
1435
1436 if (eap->forceit)
1437 deep = -1;
1438 else if (vim_isdigit(*arg))
1439 {
1440 deep = getdigits(&arg);
1441 arg = skipwhite(arg);
1442 }
1443
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001444 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001445}
1446
1447/*
1448 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001449 * Also used for Vim9 script. "callback" is invoked as:
1450 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001451 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001452 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001453ex_unletlock(
1454 exarg_T *eap,
1455 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001456 int deep,
1457 int glv_flags,
1458 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1459 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001460{
1461 char_u *arg = argstart;
1462 char_u *name_end;
1463 int error = FALSE;
1464 lval_T lv;
1465
1466 do
1467 {
1468 if (*arg == '$')
1469 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001470 lv.ll_name = arg;
1471 lv.ll_tv = NULL;
1472 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001473 if (get_env_len(&arg) == 0)
1474 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001475 semsg(_(e_invarg2), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001476 return;
1477 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001478 if (!error && !eap->skip
1479 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1480 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001481 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001482 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001483 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001484 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001485 // Parse the name and find the end.
1486 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
1487 glv_flags, FNE_CHECK_START);
1488 if (lv.ll_name == NULL)
1489 error = TRUE; // error but continue parsing
1490 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1491 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001492 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001493 if (name_end != NULL)
1494 {
1495 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001496 semsg(_(e_trailing_arg), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001497 }
1498 if (!(eap->skip || error))
1499 clear_lval(&lv);
1500 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001501 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001502
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001503 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001504 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001505 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001506
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001507 if (!eap->skip)
1508 clear_lval(&lv);
1509 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001510
1511 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001512 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001513
1514 eap->nextcmd = check_nextcmd(arg);
1515}
1516
1517 static int
1518do_unlet_var(
1519 lval_T *lp,
1520 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001521 exarg_T *eap,
1522 int deep UNUSED,
1523 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001524{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001525 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001526 int ret = OK;
1527 int cc;
1528
1529 if (lp->ll_tv == NULL)
1530 {
1531 cc = *name_end;
1532 *name_end = NUL;
1533
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001534 // Environment variable, normal name or expanded name.
1535 if (*lp->ll_name == '$')
1536 vim_unsetenv(lp->ll_name + 1);
1537 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001538 ret = FAIL;
1539 *name_end = cc;
1540 }
1541 else if ((lp->ll_list != NULL
1542 && var_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
1543 || (lp->ll_dict != NULL
1544 && var_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
1545 return FAIL;
1546 else if (lp->ll_range)
1547 {
1548 listitem_T *li;
1549 listitem_T *ll_li = lp->ll_li;
1550 int ll_n1 = lp->ll_n1;
1551
1552 while (ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= ll_n1))
1553 {
1554 li = ll_li->li_next;
1555 if (var_check_lock(ll_li->li_tv.v_lock, lp->ll_name, FALSE))
1556 return FAIL;
1557 ll_li = li;
1558 ++ll_n1;
1559 }
1560
1561 // Delete a range of List items.
1562 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
1563 {
1564 li = lp->ll_li->li_next;
1565 listitem_remove(lp->ll_list, lp->ll_li);
1566 lp->ll_li = li;
1567 ++lp->ll_n1;
1568 }
1569 }
1570 else
1571 {
1572 if (lp->ll_list != NULL)
1573 // unlet a List item.
1574 listitem_remove(lp->ll_list, lp->ll_li);
1575 else
1576 // unlet a Dictionary item.
1577 dictitem_remove(lp->ll_dict, lp->ll_di);
1578 }
1579
1580 return ret;
1581}
1582
1583/*
1584 * "unlet" a variable. Return OK if it existed, FAIL if not.
1585 * When "forceit" is TRUE don't complain if the variable doesn't exist.
1586 */
1587 int
1588do_unlet(char_u *name, int forceit)
1589{
1590 hashtab_T *ht;
1591 hashitem_T *hi;
1592 char_u *varname;
1593 dict_T *d;
1594 dictitem_T *di;
1595
Bram Moolenaareb6880b2020-07-12 17:07:05 +02001596 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001597 return FAIL;
1598
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001599 ht = find_var_ht(name, &varname);
1600 if (ht != NULL && *varname != NUL)
1601 {
1602 d = get_current_funccal_dict(ht);
1603 if (d == NULL)
1604 {
1605 if (ht == &globvarht)
1606 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001607 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001608 d = &vimvardict;
1609 else
1610 {
1611 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
1612 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
1613 }
1614 if (d == NULL)
1615 {
1616 internal_error("do_unlet()");
1617 return FAIL;
1618 }
1619 }
1620 hi = hash_find(ht, varname);
1621 if (HASHITEM_EMPTY(hi))
1622 hi = find_hi_in_scoped_ht(name, &ht);
1623 if (hi != NULL && !HASHITEM_EMPTY(hi))
1624 {
1625 di = HI2DI(hi);
1626 if (var_check_fixed(di->di_flags, name, FALSE)
1627 || var_check_ro(di->di_flags, name, FALSE)
1628 || var_check_lock(d->dv_lock, name, FALSE))
1629 return FAIL;
1630
1631 delete_var(ht, hi);
1632 return OK;
1633 }
1634 }
1635 if (forceit)
1636 return OK;
1637 semsg(_("E108: No such variable: \"%s\""), name);
1638 return FAIL;
1639}
1640
1641/*
1642 * Lock or unlock variable indicated by "lp".
1643 * "deep" is the levels to go (-1 for unlimited);
1644 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
1645 */
1646 static int
1647do_lock_var(
1648 lval_T *lp,
1649 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001650 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001651 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001652 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001653{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001654 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001655 int ret = OK;
1656 int cc;
1657 dictitem_T *di;
1658
1659 if (deep == 0) // nothing to do
1660 return OK;
1661
1662 if (lp->ll_tv == NULL)
1663 {
1664 cc = *name_end;
1665 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001666 if (*lp->ll_name == '$')
1667 {
1668 semsg(_(e_lock_unlock), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001669 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001670 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001671 else
1672 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001673 // Normal name or expanded name.
1674 di = find_var(lp->ll_name, NULL, TRUE);
1675 if (di == NULL)
1676 ret = FAIL;
1677 else if ((di->di_flags & DI_FLAGS_FIX)
1678 && di->di_tv.v_type != VAR_DICT
1679 && di->di_tv.v_type != VAR_LIST)
1680 {
1681 // For historic reasons this error is not given for a list or
1682 // dict. E.g., the b: dict could be locked/unlocked.
1683 semsg(_(e_lock_unlock), lp->ll_name);
1684 ret = FAIL;
1685 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001686 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001687 {
1688 if (lock)
1689 di->di_flags |= DI_FLAGS_LOCK;
1690 else
1691 di->di_flags &= ~DI_FLAGS_LOCK;
1692 item_lock(&di->di_tv, deep, lock);
1693 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001694 }
1695 *name_end = cc;
1696 }
1697 else if (lp->ll_range)
1698 {
1699 listitem_T *li = lp->ll_li;
1700
1701 // (un)lock a range of List items.
1702 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
1703 {
1704 item_lock(&li->li_tv, deep, lock);
1705 li = li->li_next;
1706 ++lp->ll_n1;
1707 }
1708 }
1709 else if (lp->ll_list != NULL)
1710 // (un)lock a List item.
1711 item_lock(&lp->ll_li->li_tv, deep, lock);
1712 else
1713 // (un)lock a Dictionary item.
1714 item_lock(&lp->ll_di->di_tv, deep, lock);
1715
1716 return ret;
1717}
1718
1719/*
1720 * Lock or unlock an item. "deep" is nr of levels to go.
1721 */
1722 static void
1723item_lock(typval_T *tv, int deep, int lock)
1724{
1725 static int recurse = 0;
1726 list_T *l;
1727 listitem_T *li;
1728 dict_T *d;
1729 blob_T *b;
1730 hashitem_T *hi;
1731 int todo;
1732
1733 if (recurse >= DICT_MAXNEST)
1734 {
1735 emsg(_("E743: variable nested too deep for (un)lock"));
1736 return;
1737 }
1738 if (deep == 0)
1739 return;
1740 ++recurse;
1741
1742 // lock/unlock the item itself
1743 if (lock)
1744 tv->v_lock |= VAR_LOCKED;
1745 else
1746 tv->v_lock &= ~VAR_LOCKED;
1747
1748 switch (tv->v_type)
1749 {
1750 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02001751 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001752 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001753 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001754 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001755 case VAR_STRING:
1756 case VAR_FUNC:
1757 case VAR_PARTIAL:
1758 case VAR_FLOAT:
1759 case VAR_SPECIAL:
1760 case VAR_JOB:
1761 case VAR_CHANNEL:
1762 break;
1763
1764 case VAR_BLOB:
1765 if ((b = tv->vval.v_blob) != NULL)
1766 {
1767 if (lock)
1768 b->bv_lock |= VAR_LOCKED;
1769 else
1770 b->bv_lock &= ~VAR_LOCKED;
1771 }
1772 break;
1773 case VAR_LIST:
1774 if ((l = tv->vval.v_list) != NULL)
1775 {
1776 if (lock)
1777 l->lv_lock |= VAR_LOCKED;
1778 else
1779 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001780 if ((deep < 0 || deep > 1) && l->lv_first != &range_list_item)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001781 // recursive: lock/unlock the items the List contains
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001782 FOR_ALL_LIST_ITEMS(l, li)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001783 item_lock(&li->li_tv, deep - 1, lock);
1784 }
1785 break;
1786 case VAR_DICT:
1787 if ((d = tv->vval.v_dict) != NULL)
1788 {
1789 if (lock)
1790 d->dv_lock |= VAR_LOCKED;
1791 else
1792 d->dv_lock &= ~VAR_LOCKED;
1793 if (deep < 0 || deep > 1)
1794 {
1795 // recursive: lock/unlock the items the List contains
1796 todo = (int)d->dv_hashtab.ht_used;
1797 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
1798 {
1799 if (!HASHITEM_EMPTY(hi))
1800 {
1801 --todo;
1802 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
1803 }
1804 }
1805 }
1806 }
1807 }
1808 --recurse;
1809}
1810
Bram Moolenaarda6c0332019-09-01 16:01:30 +02001811#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
1812/*
1813 * Delete all "menutrans_" variables.
1814 */
1815 void
1816del_menutrans_vars(void)
1817{
1818 hashitem_T *hi;
1819 int todo;
1820
1821 hash_lock(&globvarht);
1822 todo = (int)globvarht.ht_used;
1823 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
1824 {
1825 if (!HASHITEM_EMPTY(hi))
1826 {
1827 --todo;
1828 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
1829 delete_var(&globvarht, hi);
1830 }
1831 }
1832 hash_unlock(&globvarht);
1833}
1834#endif
1835
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001836/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001837 * Local string buffer for the next two functions to store a variable name
1838 * with its prefix. Allocated in cat_prefix_varname(), freed later in
1839 * get_user_var_name().
1840 */
1841
1842static char_u *varnamebuf = NULL;
1843static int varnamebuflen = 0;
1844
1845/*
1846 * Function to concatenate a prefix and a variable name.
1847 */
1848 static char_u *
1849cat_prefix_varname(int prefix, char_u *name)
1850{
1851 int len;
1852
1853 len = (int)STRLEN(name) + 3;
1854 if (len > varnamebuflen)
1855 {
1856 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02001857 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001858 varnamebuf = alloc(len);
1859 if (varnamebuf == NULL)
1860 {
1861 varnamebuflen = 0;
1862 return NULL;
1863 }
1864 varnamebuflen = len;
1865 }
1866 *varnamebuf = prefix;
1867 varnamebuf[1] = ':';
1868 STRCPY(varnamebuf + 2, name);
1869 return varnamebuf;
1870}
1871
1872/*
1873 * Function given to ExpandGeneric() to obtain the list of user defined
1874 * (global/buffer/window/built-in) variable names.
1875 */
1876 char_u *
1877get_user_var_name(expand_T *xp, int idx)
1878{
1879 static long_u gdone;
1880 static long_u bdone;
1881 static long_u wdone;
1882 static long_u tdone;
1883 static int vidx;
1884 static hashitem_T *hi;
1885 hashtab_T *ht;
1886
1887 if (idx == 0)
1888 {
1889 gdone = bdone = wdone = vidx = 0;
1890 tdone = 0;
1891 }
1892
1893 // Global variables
1894 if (gdone < globvarht.ht_used)
1895 {
1896 if (gdone++ == 0)
1897 hi = globvarht.ht_array;
1898 else
1899 ++hi;
1900 while (HASHITEM_EMPTY(hi))
1901 ++hi;
1902 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
1903 return cat_prefix_varname('g', hi->hi_key);
1904 return hi->hi_key;
1905 }
1906
1907 // b: variables
1908 ht = &curbuf->b_vars->dv_hashtab;
1909 if (bdone < ht->ht_used)
1910 {
1911 if (bdone++ == 0)
1912 hi = ht->ht_array;
1913 else
1914 ++hi;
1915 while (HASHITEM_EMPTY(hi))
1916 ++hi;
1917 return cat_prefix_varname('b', hi->hi_key);
1918 }
1919
1920 // w: variables
1921 ht = &curwin->w_vars->dv_hashtab;
1922 if (wdone < ht->ht_used)
1923 {
1924 if (wdone++ == 0)
1925 hi = ht->ht_array;
1926 else
1927 ++hi;
1928 while (HASHITEM_EMPTY(hi))
1929 ++hi;
1930 return cat_prefix_varname('w', hi->hi_key);
1931 }
1932
1933 // t: variables
1934 ht = &curtab->tp_vars->dv_hashtab;
1935 if (tdone < ht->ht_used)
1936 {
1937 if (tdone++ == 0)
1938 hi = ht->ht_array;
1939 else
1940 ++hi;
1941 while (HASHITEM_EMPTY(hi))
1942 ++hi;
1943 return cat_prefix_varname('t', hi->hi_key);
1944 }
1945
1946 // v: variables
1947 if (vidx < VV_LEN)
1948 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
1949
1950 VIM_CLEAR(varnamebuf);
1951 varnamebuflen = 0;
1952 return NULL;
1953}
1954
Bram Moolenaarda6c0332019-09-01 16:01:30 +02001955 char *
1956get_var_special_name(int nr)
1957{
1958 switch (nr)
1959 {
1960 case VVAL_FALSE: return "v:false";
1961 case VVAL_TRUE: return "v:true";
1962 case VVAL_NONE: return "v:none";
1963 case VVAL_NULL: return "v:null";
1964 }
1965 internal_error("get_var_special_name()");
1966 return "42";
1967}
1968
1969/*
1970 * Returns the global variable dictionary
1971 */
1972 dict_T *
1973get_globvar_dict(void)
1974{
1975 return &globvardict;
1976}
1977
1978/*
1979 * Returns the global variable hash table
1980 */
1981 hashtab_T *
1982get_globvar_ht(void)
1983{
1984 return &globvarht;
1985}
1986
1987/*
1988 * Returns the v: variable dictionary
1989 */
1990 dict_T *
1991get_vimvar_dict(void)
1992{
1993 return &vimvardict;
1994}
1995
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001996/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001997 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02001998 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001999 */
2000 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002001find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002002{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002003 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2004 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002005
2006 if (di == NULL)
2007 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002008 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002009 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2010 return (int)(vv - vimvars);
2011}
2012
2013
2014/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002015 * Set type of v: variable to "type".
2016 */
2017 void
2018set_vim_var_type(int idx, vartype_T type)
2019{
2020 vimvars[idx].vv_type = type;
2021}
2022
2023/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002024 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002025 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002026 */
2027 void
2028set_vim_var_nr(int idx, varnumber_T val)
2029{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002030 vimvars[idx].vv_nr = val;
2031}
2032
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002033 char *
2034get_vim_var_name(int idx)
2035{
2036 return vimvars[idx].vv_name;
2037}
2038
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002039/*
2040 * Get typval_T v: variable value.
2041 */
2042 typval_T *
2043get_vim_var_tv(int idx)
2044{
2045 return &vimvars[idx].vv_tv;
2046}
2047
2048/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002049 * Set v: variable to "tv". Only accepts the same type.
2050 * Takes over the value of "tv".
2051 */
2052 int
2053set_vim_var_tv(int idx, typval_T *tv)
2054{
2055 if (vimvars[idx].vv_type != tv->v_type)
2056 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002057 emsg(_(e_type_mismatch_for_v_variable));
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002058 clear_tv(tv);
2059 return FAIL;
2060 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002061 // VV_RO is also checked when compiling, but let's check here as well.
2062 if (vimvars[idx].vv_flags & VV_RO)
2063 {
2064 semsg(_(e_readonlyvar), vimvars[idx].vv_name);
2065 return FAIL;
2066 }
2067 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2068 {
2069 semsg(_(e_readonlysbx), vimvars[idx].vv_name);
2070 return FAIL;
2071 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002072 clear_tv(&vimvars[idx].vv_di.di_tv);
2073 vimvars[idx].vv_di.di_tv = *tv;
2074 return OK;
2075}
2076
2077/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002078 * Get number v: variable value.
2079 */
2080 varnumber_T
2081get_vim_var_nr(int idx)
2082{
2083 return vimvars[idx].vv_nr;
2084}
2085
2086/*
2087 * Get string v: variable value. Uses a static buffer, can only be used once.
2088 * If the String variable has never been set, return an empty string.
2089 * Never returns NULL;
2090 */
2091 char_u *
2092get_vim_var_str(int idx)
2093{
2094 return tv_get_string(&vimvars[idx].vv_tv);
2095}
2096
2097/*
2098 * Get List v: variable value. Caller must take care of reference count when
2099 * needed.
2100 */
2101 list_T *
2102get_vim_var_list(int idx)
2103{
2104 return vimvars[idx].vv_list;
2105}
2106
2107/*
2108 * Get Dict v: variable value. Caller must take care of reference count when
2109 * needed.
2110 */
2111 dict_T *
2112get_vim_var_dict(int idx)
2113{
2114 return vimvars[idx].vv_dict;
2115}
2116
2117/*
2118 * Set v:char to character "c".
2119 */
2120 void
2121set_vim_var_char(int c)
2122{
2123 char_u buf[MB_MAXBYTES + 1];
2124
2125 if (has_mbyte)
2126 buf[(*mb_char2bytes)(c, buf)] = NUL;
2127 else
2128 {
2129 buf[0] = c;
2130 buf[1] = NUL;
2131 }
2132 set_vim_var_string(VV_CHAR, buf, -1);
2133}
2134
2135/*
2136 * Set v:count to "count" and v:count1 to "count1".
2137 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2138 */
2139 void
2140set_vcount(
2141 long count,
2142 long count1,
2143 int set_prevcount)
2144{
2145 if (set_prevcount)
2146 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2147 vimvars[VV_COUNT].vv_nr = count;
2148 vimvars[VV_COUNT1].vv_nr = count1;
2149}
2150
2151/*
2152 * Save variables that might be changed as a side effect. Used when executing
2153 * a timer callback.
2154 */
2155 void
2156save_vimvars(vimvars_save_T *vvsave)
2157{
2158 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2159 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2160 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2161}
2162
2163/*
2164 * Restore variables saved by save_vimvars().
2165 */
2166 void
2167restore_vimvars(vimvars_save_T *vvsave)
2168{
2169 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2170 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2171 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2172}
2173
2174/*
2175 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2176 * value.
2177 */
2178 void
2179set_vim_var_string(
2180 int idx,
2181 char_u *val,
2182 int len) // length of "val" to use or -1 (whole string)
2183{
2184 clear_tv(&vimvars[idx].vv_di.di_tv);
2185 vimvars[idx].vv_type = VAR_STRING;
2186 if (val == NULL)
2187 vimvars[idx].vv_str = NULL;
2188 else if (len == -1)
2189 vimvars[idx].vv_str = vim_strsave(val);
2190 else
2191 vimvars[idx].vv_str = vim_strnsave(val, len);
2192}
2193
2194/*
2195 * Set List v: variable to "val".
2196 */
2197 void
2198set_vim_var_list(int idx, list_T *val)
2199{
2200 clear_tv(&vimvars[idx].vv_di.di_tv);
2201 vimvars[idx].vv_type = VAR_LIST;
2202 vimvars[idx].vv_list = val;
2203 if (val != NULL)
2204 ++val->lv_refcount;
2205}
2206
2207/*
2208 * Set Dictionary v: variable to "val".
2209 */
2210 void
2211set_vim_var_dict(int idx, dict_T *val)
2212{
2213 clear_tv(&vimvars[idx].vv_di.di_tv);
2214 vimvars[idx].vv_type = VAR_DICT;
2215 vimvars[idx].vv_dict = val;
2216 if (val != NULL)
2217 {
2218 ++val->dv_refcount;
2219 dict_set_items_ro(val);
2220 }
2221}
2222
2223/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002224 * Set the v:argv list.
2225 */
2226 void
2227set_argv_var(char **argv, int argc)
2228{
2229 list_T *l = list_alloc();
2230 int i;
2231
2232 if (l == NULL)
2233 getout(1);
2234 l->lv_lock = VAR_FIXED;
2235 for (i = 0; i < argc; ++i)
2236 {
2237 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2238 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002239 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002240 }
2241 set_vim_var_list(VV_ARGV, l);
2242}
2243
2244/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002245 * Reset v:register, taking the 'clipboard' setting into account.
2246 */
2247 void
2248reset_reg_var(void)
2249{
2250 int regname = 0;
2251
2252 // Adjust the register according to 'clipboard', so that when
2253 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2254#ifdef FEAT_CLIPBOARD
2255 adjust_clip_reg(&regname);
2256#endif
2257 set_reg_var(regname);
2258}
2259
2260/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002261 * Set v:register if needed.
2262 */
2263 void
2264set_reg_var(int c)
2265{
2266 char_u regname;
2267
2268 if (c == 0 || c == ' ')
2269 regname = '"';
2270 else
2271 regname = c;
2272 // Avoid free/alloc when the value is already right.
2273 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2274 set_vim_var_string(VV_REG, &regname, 1);
2275}
2276
2277/*
2278 * Get or set v:exception. If "oldval" == NULL, return the current value.
2279 * Otherwise, restore the value to "oldval" and return NULL.
2280 * Must always be called in pairs to save and restore v:exception! Does not
2281 * take care of memory allocations.
2282 */
2283 char_u *
2284v_exception(char_u *oldval)
2285{
2286 if (oldval == NULL)
2287 return vimvars[VV_EXCEPTION].vv_str;
2288
2289 vimvars[VV_EXCEPTION].vv_str = oldval;
2290 return NULL;
2291}
2292
2293/*
2294 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2295 * Otherwise, restore the value to "oldval" and return NULL.
2296 * Must always be called in pairs to save and restore v:throwpoint! Does not
2297 * take care of memory allocations.
2298 */
2299 char_u *
2300v_throwpoint(char_u *oldval)
2301{
2302 if (oldval == NULL)
2303 return vimvars[VV_THROWPOINT].vv_str;
2304
2305 vimvars[VV_THROWPOINT].vv_str = oldval;
2306 return NULL;
2307}
2308
2309/*
2310 * Set v:cmdarg.
2311 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2312 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2313 * Must always be called in pairs!
2314 */
2315 char_u *
2316set_cmdarg(exarg_T *eap, char_u *oldarg)
2317{
2318 char_u *oldval;
2319 char_u *newval;
2320 unsigned len;
2321
2322 oldval = vimvars[VV_CMDARG].vv_str;
2323 if (eap == NULL)
2324 {
2325 vim_free(oldval);
2326 vimvars[VV_CMDARG].vv_str = oldarg;
2327 return NULL;
2328 }
2329
2330 if (eap->force_bin == FORCE_BIN)
2331 len = 6;
2332 else if (eap->force_bin == FORCE_NOBIN)
2333 len = 8;
2334 else
2335 len = 0;
2336
2337 if (eap->read_edit)
2338 len += 7;
2339
2340 if (eap->force_ff != 0)
2341 len += 10; // " ++ff=unix"
2342 if (eap->force_enc != 0)
2343 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2344 if (eap->bad_char != 0)
2345 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2346
2347 newval = alloc(len + 1);
2348 if (newval == NULL)
2349 return NULL;
2350
2351 if (eap->force_bin == FORCE_BIN)
2352 sprintf((char *)newval, " ++bin");
2353 else if (eap->force_bin == FORCE_NOBIN)
2354 sprintf((char *)newval, " ++nobin");
2355 else
2356 *newval = NUL;
2357
2358 if (eap->read_edit)
2359 STRCAT(newval, " ++edit");
2360
2361 if (eap->force_ff != 0)
2362 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2363 eap->force_ff == 'u' ? "unix"
2364 : eap->force_ff == 'd' ? "dos"
2365 : "mac");
2366 if (eap->force_enc != 0)
2367 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2368 eap->cmd + eap->force_enc);
2369 if (eap->bad_char == BAD_KEEP)
2370 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2371 else if (eap->bad_char == BAD_DROP)
2372 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2373 else if (eap->bad_char != 0)
2374 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2375 vimvars[VV_CMDARG].vv_str = newval;
2376 return oldval;
2377}
2378
2379/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002380 * Get the value of internal variable "name".
2381 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2382 */
2383 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002384eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002385 char_u *name,
2386 int len, // length of "name"
2387 typval_T *rettv, // NULL when only checking existence
2388 dictitem_T **dip, // non-NULL when typval's dict item is needed
2389 int verbose, // may give error message
2390 int no_autoload) // do not use script autoloading
2391{
2392 int ret = OK;
2393 typval_T *tv = NULL;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002394 int foundFunc = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002395 dictitem_T *v;
2396 int cc;
2397
2398 // truncate the name, so that we can use strcmp()
2399 cc = name[len];
2400 name[len] = NUL;
2401
2402 // Check for user-defined variables.
2403 v = find_var(name, NULL, no_autoload);
2404 if (v != NULL)
2405 {
2406 tv = &v->di_tv;
2407 if (dip != NULL)
2408 *dip = v;
2409 }
2410
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002411 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002412 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002413 imported_T *import;
2414 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
2415
2416 import = find_imported(p, 0, NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002417
2418 // imported variable from another script
2419 if (import != NULL)
2420 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002421 if (import->imp_funcname != NULL)
2422 {
2423 foundFunc = TRUE;
2424 if (rettv != NULL)
2425 {
2426 rettv->v_type = VAR_FUNC;
2427 rettv->vval.v_string = vim_strsave(import->imp_funcname);
2428 }
2429 }
2430 else
2431 {
2432 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02002433 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002434 + import->imp_var_vals_idx;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002435 tv = sv->sv_tv;
2436 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002437 }
2438 }
2439
Bram Moolenaarc620c052020-07-08 15:16:19 +02002440 if (!foundFunc)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002441 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002442 if (tv == NULL)
2443 {
2444 if (rettv != NULL && verbose)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002445 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarc620c052020-07-08 15:16:19 +02002446 ret = FAIL;
2447 }
2448 else if (rettv != NULL)
2449 copy_tv(tv, rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002450 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002451
2452 name[len] = cc;
2453
2454 return ret;
2455}
2456
2457/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002458 * Check if variable "name[len]" is a local variable or an argument.
2459 * If so, "*eval_lavars_used" is set to TRUE.
2460 */
2461 void
2462check_vars(char_u *name, int len)
2463{
2464 int cc;
2465 char_u *varname;
2466 hashtab_T *ht;
2467
2468 if (eval_lavars_used == NULL)
2469 return;
2470
2471 // truncate the name, so that we can use strcmp()
2472 cc = name[len];
2473 name[len] = NUL;
2474
2475 ht = find_var_ht(name, &varname);
2476 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
2477 {
2478 if (find_var(name, NULL, TRUE) != NULL)
2479 *eval_lavars_used = TRUE;
2480 }
2481
2482 name[len] = cc;
2483}
2484
2485/*
2486 * Find variable "name" in the list of variables.
2487 * Return a pointer to it if found, NULL if not found.
2488 * Careful: "a:0" variables don't have a name.
2489 * When "htp" is not NULL we are writing to the variable, set "htp" to the
2490 * hashtab_T used.
2491 */
2492 dictitem_T *
2493find_var(char_u *name, hashtab_T **htp, int no_autoload)
2494{
2495 char_u *varname;
2496 hashtab_T *ht;
2497 dictitem_T *ret = NULL;
2498
2499 ht = find_var_ht(name, &varname);
2500 if (htp != NULL)
2501 *htp = ht;
2502 if (ht == NULL)
2503 return NULL;
2504 ret = find_var_in_ht(ht, *name, varname, no_autoload || htp != NULL);
2505 if (ret != NULL)
2506 return ret;
2507
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002508 // Search in parent scope for lambda
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002509 return find_var_in_scoped_ht(name, no_autoload || htp != NULL);
2510}
2511
2512/*
2513 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02002514 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002515 * Returns NULL if not found.
2516 */
2517 dictitem_T *
2518find_var_in_ht(
2519 hashtab_T *ht,
2520 int htname,
2521 char_u *varname,
2522 int no_autoload)
2523{
2524 hashitem_T *hi;
2525
2526 if (*varname == NUL)
2527 {
2528 // Must be something like "s:", otherwise "ht" would be NULL.
2529 switch (htname)
2530 {
2531 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
2532 case 'g': return &globvars_var;
2533 case 'v': return &vimvars_var;
2534 case 'b': return &curbuf->b_bufvar;
2535 case 'w': return &curwin->w_winvar;
2536 case 't': return &curtab->tp_winvar;
2537 case 'l': return get_funccal_local_var();
2538 case 'a': return get_funccal_args_var();
2539 }
2540 return NULL;
2541 }
2542
2543 hi = hash_find(ht, varname);
2544 if (HASHITEM_EMPTY(hi))
2545 {
2546 // For global variables we may try auto-loading the script. If it
2547 // worked find the variable again. Don't auto-load a script if it was
2548 // loaded already, otherwise it would be loaded every time when
2549 // checking if a function name is a Funcref variable.
2550 if (ht == &globvarht && !no_autoload)
2551 {
2552 // Note: script_autoload() may make "hi" invalid. It must either
2553 // be obtained again or not used.
2554 if (!script_autoload(varname, FALSE) || aborting())
2555 return NULL;
2556 hi = hash_find(ht, varname);
2557 }
2558 if (HASHITEM_EMPTY(hi))
2559 return NULL;
2560 }
2561 return HI2DI(hi);
2562}
2563
2564/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002565 * Get the script-local hashtab. NULL if not in a script context.
2566 */
Bram Moolenaarbdff0122020-04-05 18:56:05 +02002567 static hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002568get_script_local_ht(void)
2569{
2570 scid_T sid = current_sctx.sc_sid;
2571
2572 if (sid > 0 && sid <= script_items.ga_len)
2573 return &SCRIPT_VARS(sid);
2574 return NULL;
2575}
2576
2577/*
2578 * Look for "name[len]" in script-local variables.
Bram Moolenaarb84a3812020-05-01 15:44:29 +02002579 * Return a non-NULL pointer when found, NULL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002580 */
Bram Moolenaarb84a3812020-05-01 15:44:29 +02002581 void *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002582lookup_scriptvar(char_u *name, size_t len, cctx_T *dummy UNUSED)
2583{
2584 hashtab_T *ht = get_script_local_ht();
2585 char_u buffer[30];
2586 char_u *p;
Bram Moolenaarb84a3812020-05-01 15:44:29 +02002587 void *res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002588 hashitem_T *hi;
2589
2590 if (ht == NULL)
Bram Moolenaarb84a3812020-05-01 15:44:29 +02002591 return NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002592 if (len < sizeof(buffer) - 1)
2593 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02002594 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002595 vim_strncpy(buffer, name, len);
2596 p = buffer;
2597 }
2598 else
2599 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002600 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002601 if (p == NULL)
Bram Moolenaarb84a3812020-05-01 15:44:29 +02002602 return NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002603 }
2604
2605 hi = hash_find(ht, p);
Bram Moolenaarb84a3812020-05-01 15:44:29 +02002606 res = HASHITEM_EMPTY(hi) ? NULL : hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002607
2608 // if not script-local, then perhaps imported
Bram Moolenaarb84a3812020-05-01 15:44:29 +02002609 if (res == NULL && find_imported(p, 0, NULL) != NULL)
2610 res = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002611
2612 if (p != buffer)
2613 vim_free(p);
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02002614 // Don't return "buffer", gcc complains.
2615 return res == NULL ? NULL : IObuff;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002616}
2617
2618/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002619 * Find the hashtab used for a variable name.
2620 * Return NULL if the name is not valid.
2621 * Set "varname" to the start of name without ':'.
2622 */
2623 hashtab_T *
2624find_var_ht(char_u *name, char_u **varname)
2625{
2626 hashitem_T *hi;
2627 hashtab_T *ht;
2628
2629 if (name[0] == NUL)
2630 return NULL;
2631 if (name[1] != ':')
2632 {
2633 // The name must not start with a colon or #.
2634 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
2635 return NULL;
2636 *varname = name;
2637
2638 // "version" is "v:version" in all scopes if scriptversion < 3.
2639 // Same for a few other variables marked with VV_COMPAT.
2640 if (current_sctx.sc_version < 3)
2641 {
2642 hi = hash_find(&compat_hashtab, name);
2643 if (!HASHITEM_EMPTY(hi))
2644 return &compat_hashtab;
2645 }
2646
2647 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002648 if (ht != NULL)
2649 return ht; // local variable
2650
2651 // in Vim9 script items at the script level are script-local
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002652 if (in_vim9script())
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002653 {
2654 ht = get_script_local_ht();
2655 if (ht != NULL)
2656 return ht;
2657 }
2658
2659 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002660 }
2661 *varname = name + 2;
2662 if (*name == 'g') // global variable
2663 return &globvarht;
2664 // There must be no ':' or '#' in the rest of the name, unless g: is used
2665 if (vim_strchr(name + 2, ':') != NULL
2666 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
2667 return NULL;
2668 if (*name == 'b') // buffer variable
2669 return &curbuf->b_vars->dv_hashtab;
2670 if (*name == 'w') // window variable
2671 return &curwin->w_vars->dv_hashtab;
2672 if (*name == 't') // tab page variable
2673 return &curtab->tp_vars->dv_hashtab;
2674 if (*name == 'v') // v: variable
2675 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002676 if (get_current_funccal() != NULL
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002677 && get_current_funccal()->func->uf_def_status == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002678 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002679 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002680 if (*name == 'a') // a: function argument
2681 return get_funccal_args_ht();
2682 if (*name == 'l') // l: local function variable
2683 return get_funccal_local_ht();
2684 }
2685 if (*name == 's') // script variable
2686 {
2687 ht = get_script_local_ht();
2688 if (ht != NULL)
2689 return ht;
2690 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002691 return NULL;
2692}
2693
2694/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002695 * Get the string value of a (global/local) variable.
2696 * Note: see tv_get_string() for how long the pointer remains valid.
2697 * Returns NULL when it doesn't exist.
2698 */
2699 char_u *
2700get_var_value(char_u *name)
2701{
2702 dictitem_T *v;
2703
2704 v = find_var(name, NULL, FALSE);
2705 if (v == NULL)
2706 return NULL;
2707 return tv_get_string(&v->di_tv);
2708}
2709
2710/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002711 * Allocate a new hashtab for a sourced script. It will be used while
2712 * sourcing this script and when executing functions defined in the script.
2713 */
2714 void
2715new_script_vars(scid_T id)
2716{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002717 scriptvar_T *sv;
2718
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01002719 sv = ALLOC_CLEAR_ONE(scriptvar_T);
2720 if (sv == NULL)
2721 return;
2722 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01002723 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002724}
2725
2726/*
2727 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
2728 * point to it.
2729 */
2730 void
2731init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
2732{
2733 hash_init(&dict->dv_hashtab);
2734 dict->dv_lock = 0;
2735 dict->dv_scope = scope;
2736 dict->dv_refcount = DO_NOT_FREE_CNT;
2737 dict->dv_copyID = 0;
2738 dict_var->di_tv.vval.v_dict = dict;
2739 dict_var->di_tv.v_type = VAR_DICT;
2740 dict_var->di_tv.v_lock = VAR_FIXED;
2741 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2742 dict_var->di_key[0] = NUL;
2743}
2744
2745/*
2746 * Unreference a dictionary initialized by init_var_dict().
2747 */
2748 void
2749unref_var_dict(dict_T *dict)
2750{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002751 // Now the dict needs to be freed if no one else is using it, go back to
2752 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002753 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
2754 dict_unref(dict);
2755}
2756
2757/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002758 * Clean up a list of internal variables.
2759 * Frees all allocated variables and the value they contain.
2760 * Clears hashtab "ht", does not free it.
2761 */
2762 void
2763vars_clear(hashtab_T *ht)
2764{
2765 vars_clear_ext(ht, TRUE);
2766}
2767
2768/*
2769 * Like vars_clear(), but only free the value if "free_val" is TRUE.
2770 */
2771 void
2772vars_clear_ext(hashtab_T *ht, int free_val)
2773{
2774 int todo;
2775 hashitem_T *hi;
2776 dictitem_T *v;
2777
2778 hash_lock(ht);
2779 todo = (int)ht->ht_used;
2780 for (hi = ht->ht_array; todo > 0; ++hi)
2781 {
2782 if (!HASHITEM_EMPTY(hi))
2783 {
2784 --todo;
2785
2786 // Free the variable. Don't remove it from the hashtab,
2787 // ht_array might change then. hash_clear() takes care of it
2788 // later.
2789 v = HI2DI(hi);
2790 if (free_val)
2791 clear_tv(&v->di_tv);
2792 if (v->di_flags & DI_FLAGS_ALLOC)
2793 vim_free(v);
2794 }
2795 }
2796 hash_clear(ht);
2797 ht->ht_used = 0;
2798}
2799
2800/*
2801 * Delete a variable from hashtab "ht" at item "hi".
2802 * Clear the variable value and free the dictitem.
2803 */
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002804 static void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002805delete_var(hashtab_T *ht, hashitem_T *hi)
2806{
2807 dictitem_T *di = HI2DI(hi);
2808
2809 hash_remove(ht, hi);
2810 clear_tv(&di->di_tv);
2811 vim_free(di);
2812}
2813
2814/*
2815 * List the value of one internal variable.
2816 */
2817 static void
2818list_one_var(dictitem_T *v, char *prefix, int *first)
2819{
2820 char_u *tofree;
2821 char_u *s;
2822 char_u numbuf[NUMBUFLEN];
2823
2824 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
2825 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
2826 s == NULL ? (char_u *)"" : s, first);
2827 vim_free(tofree);
2828}
2829
2830 static void
2831list_one_var_a(
2832 char *prefix,
2833 char_u *name,
2834 int type,
2835 char_u *string,
2836 int *first) // when TRUE clear rest of screen and set to FALSE
2837{
2838 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
2839 msg_start();
2840 msg_puts(prefix);
2841 if (name != NULL) // "a:" vars don't have a name stored
2842 msg_puts((char *)name);
2843 msg_putchar(' ');
2844 msg_advance(22);
2845 if (type == VAR_NUMBER)
2846 msg_putchar('#');
2847 else if (type == VAR_FUNC || type == VAR_PARTIAL)
2848 msg_putchar('*');
2849 else if (type == VAR_LIST)
2850 {
2851 msg_putchar('[');
2852 if (*string == '[')
2853 ++string;
2854 }
2855 else if (type == VAR_DICT)
2856 {
2857 msg_putchar('{');
2858 if (*string == '{')
2859 ++string;
2860 }
2861 else
2862 msg_putchar(' ');
2863
2864 msg_outtrans(string);
2865
2866 if (type == VAR_FUNC || type == VAR_PARTIAL)
2867 msg_puts("()");
2868 if (*first)
2869 {
2870 msg_clr_eos();
2871 *first = FALSE;
2872 }
2873}
2874
2875/*
2876 * Set variable "name" to value in "tv".
2877 * If the variable already exists, the value is updated.
2878 * Otherwise the variable is created.
2879 */
2880 void
2881set_var(
2882 char_u *name,
2883 typval_T *tv,
2884 int copy) // make copy of value in "tv"
2885{
Bram Moolenaareeb27bf2020-07-04 17:39:10 +02002886 set_var_const(name, NULL, tv, copy, LET_NO_COMMAND);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002887}
2888
2889/*
2890 * Set variable "name" to value in "tv".
2891 * If the variable already exists and "is_const" is FALSE the value is updated.
2892 * Otherwise the variable is created.
2893 */
2894 void
2895set_var_const(
2896 char_u *name,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002897 type_T *type,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002898 typval_T *tv,
2899 int copy, // make copy of value in "tv"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002900 int flags) // LET_IS_CONST and/or LET_NO_COMMAND
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002901{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002902 dictitem_T *di;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002903 char_u *varname;
2904 hashtab_T *ht;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002905 int is_script_local;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002906
2907 ht = find_var_ht(name, &varname);
2908 if (ht == NULL || *varname == NUL)
2909 {
2910 semsg(_(e_illvar), name);
2911 return;
2912 }
Bram Moolenaare55b1c02020-06-21 15:52:59 +02002913 is_script_local = ht == get_script_local_ht();
2914
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002915 if (in_vim9script()
Bram Moolenaare55b1c02020-06-21 15:52:59 +02002916 && !is_script_local
2917 && (flags & LET_NO_COMMAND) == 0
2918 && name[1] == ':')
Bram Moolenaar67979662020-06-20 22:50:47 +02002919 {
Bram Moolenaare55b1c02020-06-21 15:52:59 +02002920 vim9_declare_error(name);
Bram Moolenaar67979662020-06-20 22:50:47 +02002921 return;
2922 }
2923
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002924 di = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002925
2926 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002927 if (di == NULL)
2928 di = find_var_in_scoped_ht(name, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002929
2930 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
Bram Moolenaar98b4f142020-08-08 15:46:01 +02002931 && var_wrong_func_name(name, di == NULL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002932 return;
2933
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002934 if (di != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002935 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002936 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002937 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002938 if (flags & LET_IS_CONST)
2939 {
2940 emsg(_(e_cannot_mod));
2941 return;
2942 }
2943
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002944 if (is_script_local && in_vim9script())
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002945 {
Bram Moolenaar34db91f2020-06-13 19:00:10 +02002946 if ((flags & LET_NO_COMMAND) == 0)
2947 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002948 semsg(_(e_redefining_script_item_str), name);
Bram Moolenaar34db91f2020-06-13 19:00:10 +02002949 return;
2950 }
2951
2952 // check the type
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02002953 if (check_script_var_type(&di->di_tv, tv, name) == FAIL)
2954 return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002955 }
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02002956
2957 if (var_check_ro(di->di_flags, name, FALSE)
2958 || var_check_lock(di->di_tv.v_lock, name, FALSE))
2959 return;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002960 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002961 else
2962 // can only redefine once
2963 di->di_flags &= ~DI_FLAGS_RELOAD;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002964
2965 // existing variable, need to clear the value
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002966
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002967 // Handle setting internal di: variables separately where needed to
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002968 // prevent changing the type.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002969 if (ht == &vimvarht)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002970 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002971 if (di->di_tv.v_type == VAR_STRING)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002972 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002973 VIM_CLEAR(di->di_tv.vval.v_string);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002974 if (copy || tv->v_type != VAR_STRING)
2975 {
2976 char_u *val = tv_get_string(tv);
2977
2978 // Careful: when assigning to v:errmsg and tv_get_string()
Bram Moolenaar4b96df52020-01-26 22:00:26 +01002979 // causes an error message the variable will already be set.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002980 if (di->di_tv.vval.v_string == NULL)
2981 di->di_tv.vval.v_string = vim_strsave(val);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002982 }
2983 else
2984 {
2985 // Take over the string to avoid an extra alloc/free.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002986 di->di_tv.vval.v_string = tv->vval.v_string;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002987 tv->vval.v_string = NULL;
2988 }
2989 return;
2990 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002991 else if (di->di_tv.v_type == VAR_NUMBER)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002992 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002993 di->di_tv.vval.v_number = tv_get_number(tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002994 if (STRCMP(varname, "searchforward") == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002995 set_search_direction(di->di_tv.vval.v_number ? '/' : '?');
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002996#ifdef FEAT_SEARCH_EXTRA
2997 else if (STRCMP(varname, "hlsearch") == 0)
2998 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002999 no_hlsearch = !di->di_tv.vval.v_number;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003000 redraw_all_later(SOME_VALID);
3001 }
3002#endif
3003 return;
3004 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003005 else if (di->di_tv.v_type != tv->v_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003006 {
3007 semsg(_("E963: setting %s to value with wrong type"), name);
3008 return;
3009 }
3010 }
3011
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003012 clear_tv(&di->di_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003013 }
3014 else // add a new variable
3015 {
3016 // Can't add "v:" or "a:" variable.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003017 if (ht == &vimvarht || ht == get_funccal_args_ht())
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003018 {
3019 semsg(_(e_illvar), name);
3020 return;
3021 }
3022
3023 // Make sure the variable name is valid.
3024 if (!valid_varname(varname))
3025 return;
3026
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003027 di = alloc(sizeof(dictitem_T) + STRLEN(varname));
3028 if (di == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003029 return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003030 STRCPY(di->di_key, varname);
3031 if (hash_add(ht, DI2HIKEY(di)) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003032 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003033 vim_free(di);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003034 return;
3035 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003036 di->di_flags = DI_FLAGS_ALLOC;
3037 if (flags & LET_IS_CONST)
3038 di->di_flags |= DI_FLAGS_LOCK;
3039
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003040 if (is_script_local && in_vim9script())
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003041 {
Bram Moolenaar21b9e972020-01-26 19:26:46 +01003042 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003043
3044 // Store a pointer to the typval_T, so that it can be found by
3045 // index instead of using a hastab lookup.
3046 if (ga_grow(&si->sn_var_vals, 1) == OK)
3047 {
3048 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
3049 + si->sn_var_vals.ga_len;
3050 sv->sv_name = di->di_key;
3051 sv->sv_tv = &di->di_tv;
Bram Moolenaar53b29e42020-08-15 14:31:20 +02003052 if (type == NULL)
3053 sv->sv_type = typval2type(tv, &si->sn_type_list);
3054 else
3055 sv->sv_type = type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003056 sv->sv_const = (flags & LET_IS_CONST);
3057 sv->sv_export = is_export;
3058 ++si->sn_var_vals.ga_len;
3059
3060 // let ex_export() know the export worked.
3061 is_export = FALSE;
3062 }
3063 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003064 }
3065
3066 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003067 copy_tv(tv, &di->di_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003068 else
3069 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003070 di->di_tv = *tv;
3071 di->di_tv.v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003072 init_tv(tv);
3073 }
3074
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003075 if (flags & LET_IS_CONST)
3076 di->di_tv.v_lock |= VAR_LOCKED;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003077}
3078
3079/*
3080 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
3081 * Also give an error message.
3082 */
3083 int
3084var_check_ro(int flags, char_u *name, int use_gettext)
3085{
3086 if (flags & DI_FLAGS_RO)
3087 {
3088 semsg(_(e_readonlyvar), use_gettext ? (char_u *)_(name) : name);
3089 return TRUE;
3090 }
3091 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
3092 {
3093 semsg(_(e_readonlysbx), use_gettext ? (char_u *)_(name) : name);
3094 return TRUE;
3095 }
3096 return FALSE;
3097}
3098
3099/*
3100 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
3101 * Also give an error message.
3102 */
3103 int
3104var_check_fixed(int flags, char_u *name, int use_gettext)
3105{
3106 if (flags & DI_FLAGS_FIX)
3107 {
3108 semsg(_("E795: Cannot delete variable %s"),
3109 use_gettext ? (char_u *)_(name) : name);
3110 return TRUE;
3111 }
3112 return FALSE;
3113}
3114
3115/*
3116 * Check if a funcref is assigned to a valid variable name.
3117 * Return TRUE and give an error if not.
3118 */
3119 int
Bram Moolenaar98b4f142020-08-08 15:46:01 +02003120var_wrong_func_name(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003121 char_u *name, // points to start of variable name
3122 int new_var) // TRUE when creating the variable
3123{
3124 // Allow for w: b: s: and t:.
3125 if (!(vim_strchr((char_u *)"wbst", name[0]) != NULL && name[1] == ':')
3126 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
3127 ? name[2] : name[0]))
3128 {
3129 semsg(_("E704: Funcref variable name must start with a capital: %s"),
3130 name);
3131 return TRUE;
3132 }
3133 // Don't allow hiding a function. When "v" is not NULL we might be
3134 // assigning another function to the same var, the type is checked
3135 // below.
3136 if (new_var && function_exists(name, FALSE))
3137 {
3138 semsg(_("E705: Variable name conflicts with existing function: %s"),
3139 name);
3140 return TRUE;
3141 }
3142 return FALSE;
3143}
3144
3145/*
3146 * Return TRUE if "flags" indicates variable "name" is locked (immutable).
3147 * Also give an error message, using "name" or _("name") when use_gettext is
3148 * TRUE.
3149 */
3150 int
3151var_check_lock(int lock, char_u *name, int use_gettext)
3152{
3153 if (lock & VAR_LOCKED)
3154 {
3155 semsg(_("E741: Value is locked: %s"),
3156 name == NULL ? (char_u *)_("Unknown")
3157 : use_gettext ? (char_u *)_(name)
3158 : name);
3159 return TRUE;
3160 }
3161 if (lock & VAR_FIXED)
3162 {
3163 semsg(_("E742: Cannot change value of %s"),
3164 name == NULL ? (char_u *)_("Unknown")
3165 : use_gettext ? (char_u *)_(name)
3166 : name);
3167 return TRUE;
3168 }
3169 return FALSE;
3170}
3171
3172/*
3173 * Check if a variable name is valid.
3174 * Return FALSE and give an error if not.
3175 */
3176 int
3177valid_varname(char_u *varname)
3178{
3179 char_u *p;
3180
3181 for (p = varname; *p != NUL; ++p)
3182 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
3183 && *p != AUTOLOAD_CHAR)
3184 {
3185 semsg(_(e_illvar), varname);
3186 return FALSE;
3187 }
3188 return TRUE;
3189}
3190
3191/*
3192 * getwinvar() and gettabwinvar()
3193 */
3194 static void
3195getwinvar(
3196 typval_T *argvars,
3197 typval_T *rettv,
3198 int off) // 1 for gettabwinvar()
3199{
3200 win_T *win;
3201 char_u *varname;
3202 dictitem_T *v;
3203 tabpage_T *tp = NULL;
3204 int done = FALSE;
3205 win_T *oldcurwin;
3206 tabpage_T *oldtabpage;
3207 int need_switch_win;
3208
3209 if (off == 1)
3210 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3211 else
3212 tp = curtab;
3213 win = find_win_by_nr(&argvars[off], tp);
3214 varname = tv_get_string_chk(&argvars[off + 1]);
3215 ++emsg_off;
3216
3217 rettv->v_type = VAR_STRING;
3218 rettv->vval.v_string = NULL;
3219
3220 if (win != NULL && varname != NULL)
3221 {
3222 // Set curwin to be our win, temporarily. Also set the tabpage,
3223 // otherwise the window is not valid. Only do this when needed,
3224 // autocommands get blocked.
3225 need_switch_win = !(tp == curtab && win == curwin);
3226 if (!need_switch_win
3227 || switch_win(&oldcurwin, &oldtabpage, win, tp, TRUE) == OK)
3228 {
3229 if (*varname == '&')
3230 {
3231 if (varname[1] == NUL)
3232 {
3233 // get all window-local options in a dict
3234 dict_T *opts = get_winbuf_options(FALSE);
3235
3236 if (opts != NULL)
3237 {
3238 rettv_dict_set(rettv, opts);
3239 done = TRUE;
3240 }
3241 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003242 else if (eval_option(&varname, rettv, 1) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003243 // window-local-option
3244 done = TRUE;
3245 }
3246 else
3247 {
3248 // Look up the variable.
3249 // Let getwinvar({nr}, "") return the "w:" dictionary.
3250 v = find_var_in_ht(&win->w_vars->dv_hashtab, 'w',
3251 varname, FALSE);
3252 if (v != NULL)
3253 {
3254 copy_tv(&v->di_tv, rettv);
3255 done = TRUE;
3256 }
3257 }
3258 }
3259
3260 if (need_switch_win)
3261 // restore previous notion of curwin
3262 restore_win(oldcurwin, oldtabpage, TRUE);
3263 }
3264
3265 if (!done && argvars[off + 2].v_type != VAR_UNKNOWN)
3266 // use the default return value
3267 copy_tv(&argvars[off + 2], rettv);
3268
3269 --emsg_off;
3270}
3271
3272/*
3273 * "setwinvar()" and "settabwinvar()" functions
3274 */
3275 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003276setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003277{
3278 win_T *win;
3279 win_T *save_curwin;
3280 tabpage_T *save_curtab;
3281 int need_switch_win;
3282 char_u *varname, *winvarname;
3283 typval_T *varp;
3284 char_u nbuf[NUMBUFLEN];
3285 tabpage_T *tp = NULL;
3286
3287 if (check_secure())
3288 return;
3289
3290 if (off == 1)
3291 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3292 else
3293 tp = curtab;
3294 win = find_win_by_nr(&argvars[off], tp);
3295 varname = tv_get_string_chk(&argvars[off + 1]);
3296 varp = &argvars[off + 2];
3297
3298 if (win != NULL && varname != NULL && varp != NULL)
3299 {
3300 need_switch_win = !(tp == curtab && win == curwin);
3301 if (!need_switch_win
3302 || switch_win(&save_curwin, &save_curtab, win, tp, TRUE) == OK)
3303 {
3304 if (*varname == '&')
3305 {
3306 long numval;
3307 char_u *strval;
3308 int error = FALSE;
3309
3310 ++varname;
3311 numval = (long)tv_get_number_chk(varp, &error);
3312 strval = tv_get_string_buf_chk(varp, nbuf);
3313 if (!error && strval != NULL)
3314 set_option_value(varname, numval, strval, OPT_LOCAL);
3315 }
3316 else
3317 {
3318 winvarname = alloc(STRLEN(varname) + 3);
3319 if (winvarname != NULL)
3320 {
3321 STRCPY(winvarname, "w:");
3322 STRCPY(winvarname + 2, varname);
3323 set_var(winvarname, varp, TRUE);
3324 vim_free(winvarname);
3325 }
3326 }
3327 }
3328 if (need_switch_win)
3329 restore_win(save_curwin, save_curtab, TRUE);
3330 }
3331}
3332
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003333/*
3334 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
3335 * v:option_type, and v:option_command.
3336 */
3337 void
3338reset_v_option_vars(void)
3339{
3340 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
3341 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
3342 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
3343 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
3344 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
3345 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
3346}
3347
3348/*
3349 * Add an assert error to v:errors.
3350 */
3351 void
3352assert_error(garray_T *gap)
3353{
3354 struct vimvar *vp = &vimvars[VV_ERRORS];
3355
3356 if (vp->vv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003357 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003358 set_vim_var_list(VV_ERRORS, list_alloc());
3359 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
3360}
3361
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003362 int
3363var_exists(char_u *var)
3364{
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003365 char_u *arg = var;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003366 char_u *name;
3367 char_u *tofree;
3368 typval_T tv;
3369 int len = 0;
3370 int n = FALSE;
3371
3372 // get_name_len() takes care of expanding curly braces
3373 name = var;
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003374 len = get_name_len(&arg, &tofree, TRUE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003375 if (len > 0)
3376 {
3377 if (tofree != NULL)
3378 name = tofree;
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003379 n = (eval_variable(name, len, &tv, NULL, FALSE, TRUE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003380 if (n)
3381 {
3382 // handle d.key, l[idx], f(expr)
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003383 arg = skipwhite(arg);
3384 n = (handle_subscript(&arg, &tv, &EVALARG_EVALUATE, FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003385 if (n)
3386 clear_tv(&tv);
3387 }
3388 }
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003389 if (*arg != NUL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003390 n = FALSE;
3391
3392 vim_free(tofree);
3393 return n;
3394}
3395
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003396static lval_T *redir_lval = NULL;
3397#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
3398static garray_T redir_ga; // only valid when redir_lval is not NULL
3399static char_u *redir_endp = NULL;
3400static char_u *redir_varname = NULL;
3401
3402/*
3403 * Start recording command output to a variable
3404 * When "append" is TRUE append to an existing variable.
3405 * Returns OK if successfully completed the setup. FAIL otherwise.
3406 */
3407 int
3408var_redir_start(char_u *name, int append)
3409{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003410 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003411 typval_T tv;
3412
3413 // Catch a bad name early.
3414 if (!eval_isnamec1(*name))
3415 {
3416 emsg(_(e_invarg));
3417 return FAIL;
3418 }
3419
3420 // Make a copy of the name, it is used in redir_lval until redir ends.
3421 redir_varname = vim_strsave(name);
3422 if (redir_varname == NULL)
3423 return FAIL;
3424
3425 redir_lval = ALLOC_CLEAR_ONE(lval_T);
3426 if (redir_lval == NULL)
3427 {
3428 var_redir_stop();
3429 return FAIL;
3430 }
3431
3432 // The output is stored in growarray "redir_ga" until redirection ends.
3433 ga_init2(&redir_ga, (int)sizeof(char), 500);
3434
3435 // Parse the variable name (can be a dict or list entry).
3436 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
3437 FNE_CHECK_START);
3438 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
3439 {
3440 clear_lval(redir_lval);
3441 if (redir_endp != NULL && *redir_endp != NUL)
3442 // Trailing characters are present after the variable name
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003443 semsg(_(e_trailing_arg), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003444 else
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003445 semsg(_(e_invarg2), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003446 redir_endp = NULL; // don't store a value, only cleanup
3447 var_redir_stop();
3448 return FAIL;
3449 }
3450
3451 // check if we can write to the variable: set it to or append an empty
3452 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003453 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003454 tv.v_type = VAR_STRING;
3455 tv.vval.v_string = (char_u *)"";
3456 if (append)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003457 set_var_lval(redir_lval, redir_endp, &tv, TRUE, 0, (char_u *)".");
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003458 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003459 set_var_lval(redir_lval, redir_endp, &tv, TRUE, 0, (char_u *)"=");
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003460 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003461 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003462 {
3463 redir_endp = NULL; // don't store a value, only cleanup
3464 var_redir_stop();
3465 return FAIL;
3466 }
3467
3468 return OK;
3469}
3470
3471/*
3472 * Append "value[value_len]" to the variable set by var_redir_start().
3473 * The actual appending is postponed until redirection ends, because the value
3474 * appended may in fact be the string we write to, changing it may cause freed
3475 * memory to be used:
3476 * :redir => foo
3477 * :let foo
3478 * :redir END
3479 */
3480 void
3481var_redir_str(char_u *value, int value_len)
3482{
3483 int len;
3484
3485 if (redir_lval == NULL)
3486 return;
3487
3488 if (value_len == -1)
3489 len = (int)STRLEN(value); // Append the entire string
3490 else
3491 len = value_len; // Append only "value_len" characters
3492
3493 if (ga_grow(&redir_ga, len) == OK)
3494 {
3495 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
3496 redir_ga.ga_len += len;
3497 }
3498 else
3499 var_redir_stop();
3500}
3501
3502/*
3503 * Stop redirecting command output to a variable.
3504 * Frees the allocated memory.
3505 */
3506 void
3507var_redir_stop(void)
3508{
3509 typval_T tv;
3510
3511 if (EVALCMD_BUSY)
3512 {
3513 redir_lval = NULL;
3514 return;
3515 }
3516
3517 if (redir_lval != NULL)
3518 {
3519 // If there was no error: assign the text to the variable.
3520 if (redir_endp != NULL)
3521 {
3522 ga_append(&redir_ga, NUL); // Append the trailing NUL.
3523 tv.v_type = VAR_STRING;
3524 tv.vval.v_string = redir_ga.ga_data;
3525 // Call get_lval() again, if it's inside a Dict or List it may
3526 // have changed.
3527 redir_endp = get_lval(redir_varname, NULL, redir_lval,
3528 FALSE, FALSE, 0, FNE_CHECK_START);
3529 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003530 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003531 (char_u *)".");
3532 clear_lval(redir_lval);
3533 }
3534
3535 // free the collected output
3536 VIM_CLEAR(redir_ga.ga_data);
3537
3538 VIM_CLEAR(redir_lval);
3539 }
3540 VIM_CLEAR(redir_varname);
3541}
3542
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003543/*
3544 * "gettabvar()" function
3545 */
3546 void
3547f_gettabvar(typval_T *argvars, typval_T *rettv)
3548{
3549 win_T *oldcurwin;
3550 tabpage_T *tp, *oldtabpage;
3551 dictitem_T *v;
3552 char_u *varname;
3553 int done = FALSE;
3554
3555 rettv->v_type = VAR_STRING;
3556 rettv->vval.v_string = NULL;
3557
3558 varname = tv_get_string_chk(&argvars[1]);
3559 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3560 if (tp != NULL && varname != NULL)
3561 {
3562 // Set tp to be our tabpage, temporarily. Also set the window to the
3563 // first window in the tabpage, otherwise the window is not valid.
3564 if (switch_win(&oldcurwin, &oldtabpage,
3565 tp == curtab || tp->tp_firstwin == NULL ? firstwin
3566 : tp->tp_firstwin, tp, TRUE) == OK)
3567 {
3568 // look up the variable
3569 // Let gettabvar({nr}, "") return the "t:" dictionary.
3570 v = find_var_in_ht(&tp->tp_vars->dv_hashtab, 't', varname, FALSE);
3571 if (v != NULL)
3572 {
3573 copy_tv(&v->di_tv, rettv);
3574 done = TRUE;
3575 }
3576 }
3577
3578 // restore previous notion of curwin
3579 restore_win(oldcurwin, oldtabpage, TRUE);
3580 }
3581
3582 if (!done && argvars[2].v_type != VAR_UNKNOWN)
3583 copy_tv(&argvars[2], rettv);
3584}
3585
3586/*
3587 * "gettabwinvar()" function
3588 */
3589 void
3590f_gettabwinvar(typval_T *argvars, typval_T *rettv)
3591{
3592 getwinvar(argvars, rettv, 1);
3593}
3594
3595/*
3596 * "getwinvar()" function
3597 */
3598 void
3599f_getwinvar(typval_T *argvars, typval_T *rettv)
3600{
3601 getwinvar(argvars, rettv, 0);
3602}
3603
3604/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003605 * "getbufvar()" function
3606 */
3607 void
3608f_getbufvar(typval_T *argvars, typval_T *rettv)
3609{
3610 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003611 char_u *varname;
3612 dictitem_T *v;
3613 int done = FALSE;
3614
3615 (void)tv_get_number(&argvars[0]); // issue errmsg if type error
3616 varname = tv_get_string_chk(&argvars[1]);
3617 ++emsg_off;
3618 buf = tv_get_buf(&argvars[0], FALSE);
3619
3620 rettv->v_type = VAR_STRING;
3621 rettv->vval.v_string = NULL;
3622
3623 if (buf != NULL && varname != NULL)
3624 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003625 if (*varname == '&')
3626 {
Bram Moolenaar86015452020-03-29 15:12:15 +02003627 buf_T *save_curbuf = curbuf;
3628
3629 // set curbuf to be our buf, temporarily
3630 curbuf = buf;
3631
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003632 if (varname[1] == NUL)
3633 {
3634 // get all buffer-local options in a dict
3635 dict_T *opts = get_winbuf_options(TRUE);
3636
3637 if (opts != NULL)
3638 {
3639 rettv_dict_set(rettv, opts);
3640 done = TRUE;
3641 }
3642 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003643 else if (eval_option(&varname, rettv, TRUE) == OK)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003644 // buffer-local-option
3645 done = TRUE;
Bram Moolenaar86015452020-03-29 15:12:15 +02003646
3647 // restore previous notion of curbuf
3648 curbuf = save_curbuf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003649 }
3650 else
3651 {
3652 // Look up the variable.
Bram Moolenaar52592752020-04-03 18:43:35 +02003653 if (*varname == NUL)
3654 // Let getbufvar({nr}, "") return the "b:" dictionary.
3655 v = &buf->b_bufvar;
3656 else
3657 v = find_var_in_ht(&buf->b_vars->dv_hashtab, 'b',
3658 varname, FALSE);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003659 if (v != NULL)
3660 {
3661 copy_tv(&v->di_tv, rettv);
3662 done = TRUE;
3663 }
3664 }
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003665 }
3666
3667 if (!done && argvars[2].v_type != VAR_UNKNOWN)
3668 // use the default value
3669 copy_tv(&argvars[2], rettv);
3670
3671 --emsg_off;
3672}
3673
3674/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003675 * "settabvar()" function
3676 */
3677 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003678f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003679{
3680 tabpage_T *save_curtab;
3681 tabpage_T *tp;
3682 char_u *varname, *tabvarname;
3683 typval_T *varp;
3684
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003685 if (check_secure())
3686 return;
3687
3688 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3689 varname = tv_get_string_chk(&argvars[1]);
3690 varp = &argvars[2];
3691
3692 if (varname != NULL && varp != NULL && tp != NULL)
3693 {
3694 save_curtab = curtab;
3695 goto_tabpage_tp(tp, FALSE, FALSE);
3696
3697 tabvarname = alloc(STRLEN(varname) + 3);
3698 if (tabvarname != NULL)
3699 {
3700 STRCPY(tabvarname, "t:");
3701 STRCPY(tabvarname + 2, varname);
3702 set_var(tabvarname, varp, TRUE);
3703 vim_free(tabvarname);
3704 }
3705
3706 // Restore current tabpage
3707 if (valid_tabpage(save_curtab))
3708 goto_tabpage_tp(save_curtab, FALSE, FALSE);
3709 }
3710}
3711
3712/*
3713 * "settabwinvar()" function
3714 */
3715 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003716f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003717{
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003718 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003719}
3720
3721/*
3722 * "setwinvar()" function
3723 */
3724 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003725f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003726{
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003727 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003728}
3729
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003730/*
3731 * "setbufvar()" function
3732 */
3733 void
3734f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
3735{
3736 buf_T *buf;
3737 char_u *varname, *bufvarname;
3738 typval_T *varp;
3739 char_u nbuf[NUMBUFLEN];
3740
3741 if (check_secure())
3742 return;
3743 (void)tv_get_number(&argvars[0]); // issue errmsg if type error
3744 varname = tv_get_string_chk(&argvars[1]);
3745 buf = tv_get_buf(&argvars[0], FALSE);
3746 varp = &argvars[2];
3747
3748 if (buf != NULL && varname != NULL && varp != NULL)
3749 {
3750 if (*varname == '&')
3751 {
3752 long numval;
3753 char_u *strval;
3754 int error = FALSE;
3755 aco_save_T aco;
3756
3757 // set curbuf to be our buf, temporarily
3758 aucmd_prepbuf(&aco, buf);
3759
3760 ++varname;
3761 numval = (long)tv_get_number_chk(varp, &error);
3762 strval = tv_get_string_buf_chk(varp, nbuf);
3763 if (!error && strval != NULL)
3764 set_option_value(varname, numval, strval, OPT_LOCAL);
3765
3766 // reset notion of buffer
3767 aucmd_restbuf(&aco);
3768 }
3769 else
3770 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003771 bufvarname = alloc(STRLEN(varname) + 3);
3772 if (bufvarname != NULL)
3773 {
Bram Moolenaar86015452020-03-29 15:12:15 +02003774 buf_T *save_curbuf = curbuf;
3775
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003776 curbuf = buf;
3777 STRCPY(bufvarname, "b:");
3778 STRCPY(bufvarname + 2, varname);
3779 set_var(bufvarname, varp, TRUE);
3780 vim_free(bufvarname);
3781 curbuf = save_curbuf;
3782 }
3783 }
3784 }
3785}
3786
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02003787/*
3788 * Get a callback from "arg". It can be a Funcref or a function name.
3789 * When "arg" is zero return an empty string.
3790 * "cb_name" is not allocated.
3791 * "cb_name" is set to NULL for an invalid argument.
3792 */
3793 callback_T
3794get_callback(typval_T *arg)
3795{
Bram Moolenaar14e579092020-03-07 16:59:25 +01003796 callback_T res;
3797 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02003798
3799 res.cb_free_name = FALSE;
3800 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
3801 {
3802 res.cb_partial = arg->vval.v_partial;
3803 ++res.cb_partial->pt_refcount;
3804 res.cb_name = partial_name(res.cb_partial);
3805 }
3806 else
3807 {
3808 res.cb_partial = NULL;
Bram Moolenaar14e579092020-03-07 16:59:25 +01003809 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
3810 && isdigit(*arg->vval.v_string))
3811 r = FAIL;
3812 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02003813 {
3814 // Note that we don't make a copy of the string.
3815 res.cb_name = arg->vval.v_string;
3816 func_ref(res.cb_name);
3817 }
3818 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02003819 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02003820 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01003821 r = FAIL;
3822
3823 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02003824 {
3825 emsg(_("E921: Invalid callback argument"));
3826 res.cb_name = NULL;
3827 }
3828 }
3829 return res;
3830}
3831
3832/*
3833 * Copy a callback into a typval_T.
3834 */
3835 void
3836put_callback(callback_T *cb, typval_T *tv)
3837{
3838 if (cb->cb_partial != NULL)
3839 {
3840 tv->v_type = VAR_PARTIAL;
3841 tv->vval.v_partial = cb->cb_partial;
3842 ++tv->vval.v_partial->pt_refcount;
3843 }
3844 else
3845 {
3846 tv->v_type = VAR_FUNC;
3847 tv->vval.v_string = vim_strsave(cb->cb_name);
3848 func_ref(cb->cb_name);
3849 }
3850}
3851
3852/*
3853 * Make a copy of "src" into "dest", allocating the function name if needed,
3854 * without incrementing the refcount.
3855 */
3856 void
3857set_callback(callback_T *dest, callback_T *src)
3858{
3859 if (src->cb_partial == NULL)
3860 {
3861 // just a function name, make a copy
3862 dest->cb_name = vim_strsave(src->cb_name);
3863 dest->cb_free_name = TRUE;
3864 }
3865 else
3866 {
3867 // cb_name is a pointer into cb_partial
3868 dest->cb_name = src->cb_name;
3869 dest->cb_free_name = FALSE;
3870 }
3871 dest->cb_partial = src->cb_partial;
3872}
3873
3874/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02003875 * Copy callback from "src" to "dest", incrementing the refcounts.
3876 */
3877 void
3878copy_callback(callback_T *dest, callback_T *src)
3879{
3880 dest->cb_partial = src->cb_partial;
3881 if (dest->cb_partial != NULL)
3882 {
3883 dest->cb_name = src->cb_name;
3884 dest->cb_free_name = FALSE;
3885 ++dest->cb_partial->pt_refcount;
3886 }
3887 else
3888 {
3889 dest->cb_name = vim_strsave(src->cb_name);
3890 dest->cb_free_name = TRUE;
3891 func_ref(src->cb_name);
3892 }
3893}
3894
3895/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02003896 * Unref/free "callback" returned by get_callback() or set_callback().
3897 */
3898 void
3899free_callback(callback_T *callback)
3900{
3901 if (callback->cb_partial != NULL)
3902 {
3903 partial_unref(callback->cb_partial);
3904 callback->cb_partial = NULL;
3905 }
3906 else if (callback->cb_name != NULL)
3907 func_unref(callback->cb_name);
3908 if (callback->cb_free_name)
3909 {
3910 vim_free(callback->cb_name);
3911 callback->cb_free_name = FALSE;
3912 }
3913 callback->cb_name = NULL;
3914}
3915
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003916#endif // FEAT_EVAL