blob: 2de7999a0f4f2c6912b6a8e9601b5c9590448378 [file] [log] [blame]
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001/* vi:set ts=8 sts=4 sw=4 noet:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * evalvars.c: functions for dealing with variables
12 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
17
Bram Moolenaare5cdf152019-08-29 22:09:46 +020018static dictitem_T globvars_var; // variable used for g:
Bram Moolenaarda6c0332019-09-01 16:01:30 +020019static dict_T globvardict; // Dictionary with g: variables
20#define globvarht globvardict.dv_hashtab
Bram Moolenaare5cdf152019-08-29 22:09:46 +020021
22/*
23 * Old Vim variables such as "v:version" are also available without the "v:".
24 * Also in functions. We need a special hashtable for them.
25 */
26static hashtab_T compat_hashtab;
27
28/*
29 * Array to hold the value of v: variables.
30 * The value is in a dictitem, so that it can also be used in the v: scope.
31 * The reason to use this table anyway is for very quick access to the
32 * variables with the VV_ defines.
33 */
34
35// values for vv_flags:
36#define VV_COMPAT 1 // compatible, also used without "v:"
37#define VV_RO 2 // read-only
38#define VV_RO_SBX 4 // read-only in the sandbox
39
40#define VV_NAME(s, t) s, {{t, 0, {0}}, 0, {0}}
41
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010042typedef struct vimvar vimvar_T;
43
Bram Moolenaare5cdf152019-08-29 22:09:46 +020044static struct vimvar
45{
46 char *vv_name; // name of variable, without v:
47 dictitem16_T vv_di; // value and name for key (max 16 chars!)
48 char vv_flags; // VV_COMPAT, VV_RO, VV_RO_SBX
49} vimvars[VV_LEN] =
50{
Bram Moolenaar8d71b542019-08-30 15:46:30 +020051 // The order here must match the VV_ defines in vim.h!
52 // Initializing a union does not work, leave tv.vval empty to get zero's.
Bram Moolenaare5cdf152019-08-29 22:09:46 +020053 {VV_NAME("count", VAR_NUMBER), VV_COMPAT+VV_RO},
54 {VV_NAME("count1", VAR_NUMBER), VV_RO},
55 {VV_NAME("prevcount", VAR_NUMBER), VV_RO},
56 {VV_NAME("errmsg", VAR_STRING), VV_COMPAT},
57 {VV_NAME("warningmsg", VAR_STRING), 0},
58 {VV_NAME("statusmsg", VAR_STRING), 0},
59 {VV_NAME("shell_error", VAR_NUMBER), VV_COMPAT+VV_RO},
60 {VV_NAME("this_session", VAR_STRING), VV_COMPAT},
61 {VV_NAME("version", VAR_NUMBER), VV_COMPAT+VV_RO},
62 {VV_NAME("lnum", VAR_NUMBER), VV_RO_SBX},
63 {VV_NAME("termresponse", VAR_STRING), VV_RO},
64 {VV_NAME("fname", VAR_STRING), VV_RO},
65 {VV_NAME("lang", VAR_STRING), VV_RO},
66 {VV_NAME("lc_time", VAR_STRING), VV_RO},
67 {VV_NAME("ctype", VAR_STRING), VV_RO},
68 {VV_NAME("charconvert_from", VAR_STRING), VV_RO},
69 {VV_NAME("charconvert_to", VAR_STRING), VV_RO},
70 {VV_NAME("fname_in", VAR_STRING), VV_RO},
71 {VV_NAME("fname_out", VAR_STRING), VV_RO},
72 {VV_NAME("fname_new", VAR_STRING), VV_RO},
73 {VV_NAME("fname_diff", VAR_STRING), VV_RO},
74 {VV_NAME("cmdarg", VAR_STRING), VV_RO},
75 {VV_NAME("foldstart", VAR_NUMBER), VV_RO_SBX},
76 {VV_NAME("foldend", VAR_NUMBER), VV_RO_SBX},
77 {VV_NAME("folddashes", VAR_STRING), VV_RO_SBX},
78 {VV_NAME("foldlevel", VAR_NUMBER), VV_RO_SBX},
79 {VV_NAME("progname", VAR_STRING), VV_RO},
80 {VV_NAME("servername", VAR_STRING), VV_RO},
81 {VV_NAME("dying", VAR_NUMBER), VV_RO},
82 {VV_NAME("exception", VAR_STRING), VV_RO},
83 {VV_NAME("throwpoint", VAR_STRING), VV_RO},
84 {VV_NAME("register", VAR_STRING), VV_RO},
85 {VV_NAME("cmdbang", VAR_NUMBER), VV_RO},
86 {VV_NAME("insertmode", VAR_STRING), VV_RO},
87 {VV_NAME("val", VAR_UNKNOWN), VV_RO},
88 {VV_NAME("key", VAR_UNKNOWN), VV_RO},
89 {VV_NAME("profiling", VAR_NUMBER), VV_RO},
90 {VV_NAME("fcs_reason", VAR_STRING), VV_RO},
91 {VV_NAME("fcs_choice", VAR_STRING), 0},
92 {VV_NAME("beval_bufnr", VAR_NUMBER), VV_RO},
93 {VV_NAME("beval_winnr", VAR_NUMBER), VV_RO},
94 {VV_NAME("beval_winid", VAR_NUMBER), VV_RO},
95 {VV_NAME("beval_lnum", VAR_NUMBER), VV_RO},
96 {VV_NAME("beval_col", VAR_NUMBER), VV_RO},
97 {VV_NAME("beval_text", VAR_STRING), VV_RO},
98 {VV_NAME("scrollstart", VAR_STRING), 0},
99 {VV_NAME("swapname", VAR_STRING), VV_RO},
100 {VV_NAME("swapchoice", VAR_STRING), 0},
101 {VV_NAME("swapcommand", VAR_STRING), VV_RO},
102 {VV_NAME("char", VAR_STRING), 0},
103 {VV_NAME("mouse_win", VAR_NUMBER), 0},
104 {VV_NAME("mouse_winid", VAR_NUMBER), 0},
105 {VV_NAME("mouse_lnum", VAR_NUMBER), 0},
106 {VV_NAME("mouse_col", VAR_NUMBER), 0},
107 {VV_NAME("operator", VAR_STRING), VV_RO},
108 {VV_NAME("searchforward", VAR_NUMBER), 0},
109 {VV_NAME("hlsearch", VAR_NUMBER), 0},
110 {VV_NAME("oldfiles", VAR_LIST), 0},
111 {VV_NAME("windowid", VAR_NUMBER), VV_RO},
112 {VV_NAME("progpath", VAR_STRING), VV_RO},
113 {VV_NAME("completed_item", VAR_DICT), VV_RO},
114 {VV_NAME("option_new", VAR_STRING), VV_RO},
115 {VV_NAME("option_old", VAR_STRING), VV_RO},
116 {VV_NAME("option_oldlocal", VAR_STRING), VV_RO},
117 {VV_NAME("option_oldglobal", VAR_STRING), VV_RO},
118 {VV_NAME("option_command", VAR_STRING), VV_RO},
119 {VV_NAME("option_type", VAR_STRING), VV_RO},
120 {VV_NAME("errors", VAR_LIST), 0},
Bram Moolenaar9b4a15d2020-01-11 16:05:23 +0100121 {VV_NAME("false", VAR_BOOL), VV_RO},
122 {VV_NAME("true", VAR_BOOL), VV_RO},
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200123 {VV_NAME("none", VAR_SPECIAL), VV_RO},
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100124 {VV_NAME("null", VAR_SPECIAL), VV_RO},
Bram Moolenaar57d5a012021-01-21 21:42:31 +0100125 {VV_NAME("numbermax", VAR_NUMBER), VV_RO},
126 {VV_NAME("numbermin", VAR_NUMBER), VV_RO},
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100127 {VV_NAME("numbersize", VAR_NUMBER), VV_RO},
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200128 {VV_NAME("vim_did_enter", VAR_NUMBER), VV_RO},
129 {VV_NAME("testing", VAR_NUMBER), 0},
130 {VV_NAME("t_number", VAR_NUMBER), VV_RO},
131 {VV_NAME("t_string", VAR_NUMBER), VV_RO},
132 {VV_NAME("t_func", VAR_NUMBER), VV_RO},
133 {VV_NAME("t_list", VAR_NUMBER), VV_RO},
134 {VV_NAME("t_dict", VAR_NUMBER), VV_RO},
135 {VV_NAME("t_float", VAR_NUMBER), VV_RO},
136 {VV_NAME("t_bool", VAR_NUMBER), VV_RO},
137 {VV_NAME("t_none", VAR_NUMBER), VV_RO},
138 {VV_NAME("t_job", VAR_NUMBER), VV_RO},
139 {VV_NAME("t_channel", VAR_NUMBER), VV_RO},
140 {VV_NAME("t_blob", VAR_NUMBER), VV_RO},
141 {VV_NAME("termrfgresp", VAR_STRING), VV_RO},
142 {VV_NAME("termrbgresp", VAR_STRING), VV_RO},
143 {VV_NAME("termu7resp", VAR_STRING), VV_RO},
144 {VV_NAME("termstyleresp", VAR_STRING), VV_RO},
145 {VV_NAME("termblinkresp", VAR_STRING), VV_RO},
146 {VV_NAME("event", VAR_DICT), VV_RO},
147 {VV_NAME("versionlong", VAR_NUMBER), VV_RO},
148 {VV_NAME("echospace", VAR_NUMBER), VV_RO},
Bram Moolenaar69bf6342019-10-29 04:16:57 +0100149 {VV_NAME("argv", VAR_LIST), VV_RO},
Bram Moolenaar84cf6bd2020-06-16 20:03:43 +0200150 {VV_NAME("collate", VAR_STRING), VV_RO},
Bram Moolenaarf0068c52020-11-30 17:42:10 +0100151 {VV_NAME("exiting", VAR_SPECIAL), VV_RO},
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200152};
153
154// shorthand
155#define vv_type vv_di.di_tv.v_type
156#define vv_nr vv_di.di_tv.vval.v_number
157#define vv_float vv_di.di_tv.vval.v_float
158#define vv_str vv_di.di_tv.vval.v_string
159#define vv_list vv_di.di_tv.vval.v_list
160#define vv_dict vv_di.di_tv.vval.v_dict
161#define vv_blob vv_di.di_tv.vval.v_blob
162#define vv_tv vv_di.di_tv
163
164static dictitem_T vimvars_var; // variable used for v:
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200165static dict_T vimvardict; // Dictionary with v: variables
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200166#define vimvarht vimvardict.dv_hashtab
167
168// for VIM_VERSION_ defines
169#include "version.h"
170
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200171static void list_glob_vars(int *first);
172static void list_buf_vars(int *first);
173static void list_win_vars(int *first);
174static void list_tab_vars(int *first);
175static char_u *list_arg_vars(exarg_T *eap, char_u *arg, int *first);
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100176static char_u *ex_let_one(char_u *arg, typval_T *tv, int copy, int flags, char_u *endchars, char_u *op, int var_idx);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +0200177static int do_unlet_var(lval_T *lp, char_u *name_end, exarg_T *eap, int deep, void *cookie);
178static int do_lock_var(lval_T *lp, char_u *name_end, exarg_T *eap, int deep, void *cookie);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200179static void list_one_var(dictitem_T *v, char *prefix, int *first);
180static void list_one_var_a(char *prefix, char_u *name, int type, char_u *string, int *first);
181
182/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200183 * Initialize global and vim special variables
184 */
185 void
186evalvars_init(void)
187{
188 int i;
189 struct vimvar *p;
190
191 init_var_dict(&globvardict, &globvars_var, VAR_DEF_SCOPE);
192 init_var_dict(&vimvardict, &vimvars_var, VAR_SCOPE);
193 vimvardict.dv_lock = VAR_FIXED;
194 hash_init(&compat_hashtab);
195
196 for (i = 0; i < VV_LEN; ++i)
197 {
198 p = &vimvars[i];
199 if (STRLEN(p->vv_name) > DICTITEM16_KEY_LEN)
200 {
201 iemsg("INTERNAL: name too long, increase size of dictitem16_T");
202 getout(1);
203 }
204 STRCPY(p->vv_di.di_key, p->vv_name);
205 if (p->vv_flags & VV_RO)
206 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
207 else if (p->vv_flags & VV_RO_SBX)
208 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
209 else
210 p->vv_di.di_flags = DI_FLAGS_FIX;
211
212 // add to v: scope dict, unless the value is not always available
213 if (p->vv_type != VAR_UNKNOWN)
214 hash_add(&vimvarht, p->vv_di.di_key);
215 if (p->vv_flags & VV_COMPAT)
216 // add to compat scope dict
217 hash_add(&compat_hashtab, p->vv_di.di_key);
218 }
Bram Moolenaar016faaa2020-10-03 12:57:27 +0200219 set_vim_var_nr(VV_VERSION, VIM_VERSION_100);
220 set_vim_var_nr(VV_VERSIONLONG, VIM_VERSION_100 * 10000 + highest_patch());
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200221
222 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
223 set_vim_var_nr(VV_HLSEARCH, 1L);
Bram Moolenaarf0068c52020-11-30 17:42:10 +0100224 set_vim_var_nr(VV_EXITING, VVAL_NULL);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200225 set_vim_var_dict(VV_COMPLETED_ITEM, dict_alloc_lock(VAR_FIXED));
226 set_vim_var_list(VV_ERRORS, list_alloc());
227 set_vim_var_dict(VV_EVENT, dict_alloc_lock(VAR_FIXED));
228
229 set_vim_var_nr(VV_FALSE, VVAL_FALSE);
230 set_vim_var_nr(VV_TRUE, VVAL_TRUE);
231 set_vim_var_nr(VV_NONE, VVAL_NONE);
232 set_vim_var_nr(VV_NULL, VVAL_NULL);
Bram Moolenaar57d5a012021-01-21 21:42:31 +0100233 set_vim_var_nr(VV_NUMBERMAX, VARNUM_MAX);
234 set_vim_var_nr(VV_NUMBERMIN, VARNUM_MIN);
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100235 set_vim_var_nr(VV_NUMBERSIZE, sizeof(varnumber_T) * 8);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200236
237 set_vim_var_nr(VV_TYPE_NUMBER, VAR_TYPE_NUMBER);
238 set_vim_var_nr(VV_TYPE_STRING, VAR_TYPE_STRING);
239 set_vim_var_nr(VV_TYPE_FUNC, VAR_TYPE_FUNC);
240 set_vim_var_nr(VV_TYPE_LIST, VAR_TYPE_LIST);
241 set_vim_var_nr(VV_TYPE_DICT, VAR_TYPE_DICT);
242 set_vim_var_nr(VV_TYPE_FLOAT, VAR_TYPE_FLOAT);
243 set_vim_var_nr(VV_TYPE_BOOL, VAR_TYPE_BOOL);
244 set_vim_var_nr(VV_TYPE_NONE, VAR_TYPE_NONE);
245 set_vim_var_nr(VV_TYPE_JOB, VAR_TYPE_JOB);
246 set_vim_var_nr(VV_TYPE_CHANNEL, VAR_TYPE_CHANNEL);
247 set_vim_var_nr(VV_TYPE_BLOB, VAR_TYPE_BLOB);
248
249 set_vim_var_nr(VV_ECHOSPACE, sc_col - 1);
250
Bram Moolenaar439c0362020-06-06 15:58:03 +0200251 // Default for v:register is not 0 but '"'. This is adjusted once the
252 // clipboard has been setup by calling reset_reg_var().
253 set_reg_var(0);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200254}
255
256#if defined(EXITFREE) || defined(PROTO)
257/*
258 * Free all vim variables information on exit
259 */
260 void
261evalvars_clear(void)
262{
263 int i;
264 struct vimvar *p;
265
266 for (i = 0; i < VV_LEN; ++i)
267 {
268 p = &vimvars[i];
269 if (p->vv_di.di_tv.v_type == VAR_STRING)
270 VIM_CLEAR(p->vv_str);
271 else if (p->vv_di.di_tv.v_type == VAR_LIST)
272 {
273 list_unref(p->vv_list);
274 p->vv_list = NULL;
275 }
276 }
277 hash_clear(&vimvarht);
278 hash_init(&vimvarht); // garbage_collect() will access it
279 hash_clear(&compat_hashtab);
280
281 // global variables
282 vars_clear(&globvarht);
283
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100284 // Script-local variables. Clear all the variables here.
285 // The scriptvar_T is cleared later in free_scriptnames(), because a
286 // variable in one script might hold a reference to the whole scope of
287 // another script.
288 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200289 vars_clear(&SCRIPT_VARS(i));
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200290}
291#endif
292
293 int
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200294garbage_collect_globvars(int copyID)
295{
296 return set_ref_in_ht(&globvarht, copyID, NULL);
297}
298
299 int
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200300garbage_collect_vimvars(int copyID)
301{
302 return set_ref_in_ht(&vimvarht, copyID, NULL);
303}
304
305 int
306garbage_collect_scriptvars(int copyID)
307{
Bram Moolenaared234f22020-10-15 20:42:20 +0200308 int i;
309 int idx;
310 int abort = FALSE;
311 scriptitem_T *si;
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200312
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100313 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaared234f22020-10-15 20:42:20 +0200314 {
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200315 abort = abort || set_ref_in_ht(&SCRIPT_VARS(i), copyID, NULL);
316
Bram Moolenaared234f22020-10-15 20:42:20 +0200317 si = SCRIPT_ITEM(i);
318 for (idx = 0; idx < si->sn_var_vals.ga_len; ++idx)
319 {
320 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + idx;
321
Bram Moolenaard00a7fb2021-03-08 20:47:14 +0100322 if (sv->sv_name != NULL)
323 abort = abort || set_ref_in_item(sv->sv_tv, copyID, NULL, NULL);
Bram Moolenaared234f22020-10-15 20:42:20 +0200324 }
325 }
326
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200327 return abort;
328}
329
330/*
331 * Set an internal variable to a string value. Creates the variable if it does
332 * not already exist.
333 */
334 void
335set_internal_string_var(char_u *name, char_u *value)
336{
337 char_u *val;
338 typval_T *tvp;
339
340 val = vim_strsave(value);
341 if (val != NULL)
342 {
343 tvp = alloc_string_tv(val);
344 if (tvp != NULL)
345 {
346 set_var(name, tvp, FALSE);
347 free_tv(tvp);
348 }
349 }
350}
351
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200352 int
353eval_charconvert(
354 char_u *enc_from,
355 char_u *enc_to,
356 char_u *fname_from,
357 char_u *fname_to)
358{
359 int err = FALSE;
360
361 set_vim_var_string(VV_CC_FROM, enc_from, -1);
362 set_vim_var_string(VV_CC_TO, enc_to, -1);
363 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
364 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
365 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
366 err = TRUE;
367 set_vim_var_string(VV_CC_FROM, NULL, -1);
368 set_vim_var_string(VV_CC_TO, NULL, -1);
369 set_vim_var_string(VV_FNAME_IN, NULL, -1);
370 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
371
372 if (err)
373 return FAIL;
374 return OK;
375}
376
377# if defined(FEAT_POSTSCRIPT) || defined(PROTO)
378 int
379eval_printexpr(char_u *fname, char_u *args)
380{
381 int err = FALSE;
382
383 set_vim_var_string(VV_FNAME_IN, fname, -1);
384 set_vim_var_string(VV_CMDARG, args, -1);
385 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
386 err = TRUE;
387 set_vim_var_string(VV_FNAME_IN, NULL, -1);
388 set_vim_var_string(VV_CMDARG, NULL, -1);
389
390 if (err)
391 {
392 mch_remove(fname);
393 return FAIL;
394 }
395 return OK;
396}
397# endif
398
399# if defined(FEAT_DIFF) || defined(PROTO)
400 void
401eval_diff(
402 char_u *origfile,
403 char_u *newfile,
404 char_u *outfile)
405{
406 int err = FALSE;
407
408 set_vim_var_string(VV_FNAME_IN, origfile, -1);
409 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
410 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
411 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
412 set_vim_var_string(VV_FNAME_IN, NULL, -1);
413 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
414 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
415}
416
417 void
418eval_patch(
419 char_u *origfile,
420 char_u *difffile,
421 char_u *outfile)
422{
423 int err;
424
425 set_vim_var_string(VV_FNAME_IN, origfile, -1);
426 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
427 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
428 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
429 set_vim_var_string(VV_FNAME_IN, NULL, -1);
430 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
431 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
432}
433# endif
434
435#if defined(FEAT_SPELL) || defined(PROTO)
436/*
437 * Evaluate an expression to a list with suggestions.
438 * For the "expr:" part of 'spellsuggest'.
439 * Returns NULL when there is an error.
440 */
441 list_T *
442eval_spell_expr(char_u *badword, char_u *expr)
443{
444 typval_T save_val;
445 typval_T rettv;
446 list_T *list = NULL;
447 char_u *p = skipwhite(expr);
448
449 // Set "v:val" to the bad word.
450 prepare_vimvar(VV_VAL, &save_val);
451 set_vim_var_string(VV_VAL, badword, -1);
452 if (p_verbose == 0)
453 ++emsg_off;
454
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200455 if (eval1(&p, &rettv, &EVALARG_EVALUATE) == OK)
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200456 {
457 if (rettv.v_type != VAR_LIST)
458 clear_tv(&rettv);
459 else
460 list = rettv.vval.v_list;
461 }
462
463 if (p_verbose == 0)
464 --emsg_off;
465 clear_tv(get_vim_var_tv(VV_VAL));
466 restore_vimvar(VV_VAL, &save_val);
467
468 return list;
469}
470
471/*
472 * "list" is supposed to contain two items: a word and a number. Return the
473 * word in "pp" and the number as the return value.
474 * Return -1 if anything isn't right.
475 * Used to get the good word and score from the eval_spell_expr() result.
476 */
477 int
478get_spellword(list_T *list, char_u **pp)
479{
480 listitem_T *li;
481
482 li = list->lv_first;
483 if (li == NULL)
484 return -1;
485 *pp = tv_get_string(&li->li_tv);
486
487 li = li->li_next;
488 if (li == NULL)
489 return -1;
490 return (int)tv_get_number(&li->li_tv);
491}
492#endif
493
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200494/*
495 * Prepare v: variable "idx" to be used.
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200496 * Save the current typeval in "save_tv" and clear it.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200497 * When not used yet add the variable to the v: hashtable.
498 */
499 void
500prepare_vimvar(int idx, typval_T *save_tv)
501{
502 *save_tv = vimvars[idx].vv_tv;
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200503 vimvars[idx].vv_str = NULL; // don't free it now
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200504 if (vimvars[idx].vv_type == VAR_UNKNOWN)
505 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
506}
507
508/*
509 * Restore v: variable "idx" to typeval "save_tv".
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200510 * Note that the v: variable must have been cleared already.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200511 * When no longer defined, remove the variable from the v: hashtable.
512 */
513 void
514restore_vimvar(int idx, typval_T *save_tv)
515{
516 hashitem_T *hi;
517
518 vimvars[idx].vv_tv = *save_tv;
519 if (vimvars[idx].vv_type == VAR_UNKNOWN)
520 {
521 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
522 if (HASHITEM_EMPTY(hi))
523 internal_error("restore_vimvar()");
524 else
525 hash_remove(&vimvarht, hi);
526 }
527}
528
529/*
530 * List Vim variables.
531 */
532 static void
533list_vim_vars(int *first)
534{
535 list_hashtable_vars(&vimvarht, "v:", FALSE, first);
536}
537
538/*
539 * List script-local variables, if there is a script.
540 */
541 static void
542list_script_vars(int *first)
543{
Bram Moolenaare3d46852020-08-29 13:39:17 +0200544 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200545 list_hashtable_vars(&SCRIPT_VARS(current_sctx.sc_sid),
546 "s:", FALSE, first);
547}
548
549/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200550 * Get a list of lines from a HERE document. The here document is a list of
551 * lines surrounded by a marker.
552 * cmd << {marker}
553 * {line1}
554 * {line2}
555 * ....
556 * {marker}
557 *
558 * The {marker} is a string. If the optional 'trim' word is supplied before the
559 * marker, then the leading indentation before the lines (matching the
560 * indentation in the 'cmd' line) is stripped.
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200561 *
562 * When getting lines for an embedded script (e.g. python, lua, perl, ruby,
563 * tcl, mzscheme), script_get is set to TRUE. In this case, if the marker is
564 * missing, then '.' is accepted as a marker.
565 *
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200566 * Returns a List with {lines} or NULL.
567 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100568 list_T *
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200569heredoc_get(exarg_T *eap, char_u *cmd, int script_get)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200570{
571 char_u *theline;
572 char_u *marker;
573 list_T *l;
574 char_u *p;
575 int marker_indent_len = 0;
576 int text_indent_len = 0;
577 char_u *text_indent = NULL;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200578 char_u dot[] = ".";
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200579 int comment_char = in_vim9script() ? '#' : '"';
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200580
581 if (eap->getline == NULL)
582 {
583 emsg(_("E991: cannot use =<< here"));
584 return NULL;
585 }
586
587 // Check for the optional 'trim' word before the marker
588 cmd = skipwhite(cmd);
589 if (STRNCMP(cmd, "trim", 4) == 0 && (cmd[4] == NUL || VIM_ISWHITE(cmd[4])))
590 {
591 cmd = skipwhite(cmd + 4);
592
593 // Trim the indentation from all the lines in the here document.
594 // The amount of indentation trimmed is the same as the indentation of
595 // the first line after the :let command line. To find the end marker
596 // the indent of the :let command line is trimmed.
597 p = *eap->cmdlinep;
598 while (VIM_ISWHITE(*p))
599 {
600 p++;
601 marker_indent_len++;
602 }
603 text_indent_len = -1;
604 }
605
606 // The marker is the next word.
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200607 if (*cmd != NUL && *cmd != comment_char)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200608 {
609 marker = skipwhite(cmd);
610 p = skiptowhite(marker);
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200611 if (*skipwhite(p) != NUL && *skipwhite(p) != comment_char)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200612 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +0200613 semsg(_(e_trailing_arg), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200614 return NULL;
615 }
616 *p = NUL;
Bram Moolenaar6ab09532020-05-01 14:10:13 +0200617 if (!script_get && vim_islower(*marker))
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200618 {
619 emsg(_("E221: Marker cannot start with lower case letter"));
620 return NULL;
621 }
622 }
623 else
624 {
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200625 // When getting lines for an embedded script, if the marker is missing,
626 // accept '.' as the marker.
627 if (script_get)
628 marker = dot;
629 else
630 {
631 emsg(_("E172: Missing marker"));
632 return NULL;
633 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200634 }
635
636 l = list_alloc();
637 if (l == NULL)
638 return NULL;
639
640 for (;;)
641 {
642 int mi = 0;
643 int ti = 0;
644
645 theline = eap->getline(NUL, eap->cookie, 0, FALSE);
646 if (theline == NULL)
647 {
648 semsg(_("E990: Missing end marker '%s'"), marker);
649 break;
650 }
651
652 // with "trim": skip the indent matching the :let line to find the
653 // marker
654 if (marker_indent_len > 0
655 && STRNCMP(theline, *eap->cmdlinep, marker_indent_len) == 0)
656 mi = marker_indent_len;
657 if (STRCMP(marker, theline + mi) == 0)
658 {
659 vim_free(theline);
660 break;
661 }
662
663 if (text_indent_len == -1 && *theline != NUL)
664 {
665 // set the text indent from the first line.
666 p = theline;
667 text_indent_len = 0;
668 while (VIM_ISWHITE(*p))
669 {
670 p++;
671 text_indent_len++;
672 }
673 text_indent = vim_strnsave(theline, text_indent_len);
674 }
675 // with "trim": skip the indent matching the first line
676 if (text_indent != NULL)
677 for (ti = 0; ti < text_indent_len; ++ti)
678 if (theline[ti] != text_indent[ti])
679 break;
680
681 if (list_append_string(l, theline + ti, -1) == FAIL)
682 break;
683 vim_free(theline);
684 }
685 vim_free(text_indent);
686
687 return l;
688}
689
690/*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200691 * Vim9 variable declaration:
692 * ":var name"
693 * ":var name: type"
694 * ":var name = expr"
695 * ":var name: type = expr"
696 * etc.
697 */
698 void
699ex_var(exarg_T *eap)
700{
701 if (!in_vim9script())
702 {
703 semsg(_(e_str_cannot_be_used_in_legacy_vim_script), ":var");
704 return;
705 }
706 ex_let(eap);
707}
708
709/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200710 * ":let" list all variable values
711 * ":let var1 var2" list variable values
712 * ":let var = expr" assignment command.
713 * ":let var += expr" assignment command.
714 * ":let var -= expr" assignment command.
715 * ":let var *= expr" assignment command.
716 * ":let var /= expr" assignment command.
717 * ":let var %= expr" assignment command.
718 * ":let var .= expr" assignment command.
719 * ":let var ..= expr" assignment command.
720 * ":let [var1, var2] = expr" unpack list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100721 * ":let var =<< ..." heredoc
Bram Moolenaard672dde2020-02-26 13:43:51 +0100722 * ":let var: string" Vim9 declaration
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200723 *
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200724 * ":final var = expr" assignment command.
725 * ":final [var1, var2] = expr" unpack list.
726 *
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200727 * ":const" list all variable values
728 * ":const var1 var2" list variable values
729 * ":const var = expr" assignment command.
730 * ":const [var1, var2] = expr" unpack list.
731 */
732 void
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200733ex_let(exarg_T *eap)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200734{
735 char_u *arg = eap->arg;
736 char_u *expr = NULL;
737 typval_T rettv;
738 int i;
739 int var_count = 0;
740 int semicolon = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200741 char_u op[4];
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200742 char_u *argend;
743 int first = TRUE;
744 int concat;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200745 int has_assign;
Bram Moolenaar89b474d2020-12-22 21:19:39 +0100746 int flags = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200747 int vim9script = in_vim9script();
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200748
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200749 if (eap->cmdidx == CMD_final && !vim9script)
750 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +0100751 // In legacy Vim script ":final" is short for ":finally".
752 ex_finally(eap);
753 return;
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200754 }
Bram Moolenaarc58f5452020-10-21 20:58:52 +0200755 if (eap->cmdidx == CMD_let && vim9script)
Bram Moolenaarcfcd0112020-09-27 15:19:27 +0200756 {
757 emsg(_(e_cannot_use_let_in_vim9_script));
758 return;
759 }
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200760
Bram Moolenaar89b474d2020-12-22 21:19:39 +0100761 if (eap->cmdidx == CMD_const)
762 flags |= ASSIGN_CONST;
763 else if (eap->cmdidx == CMD_final)
764 flags |= ASSIGN_FINAL;
765
766 // Vim9 assignment without ":let", ":const" or ":final"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100767 if (eap->arg == eap->cmd)
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200768 flags |= ASSIGN_NO_DECL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100769
Bram Moolenaar47a519a2020-06-14 23:05:10 +0200770 argend = skip_var_list(arg, TRUE, &var_count, &semicolon, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200771 if (argend == NULL)
772 return;
773 if (argend > arg && argend[-1] == '.') // for var.='str'
774 --argend;
775 expr = skipwhite(argend);
776 concat = expr[0] == '.'
Bram Moolenaardd9de502021-08-15 13:49:42 +0200777 && ((expr[1] == '=' && in_old_script(2))
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200778 || (expr[1] == '.' && expr[2] == '='));
Bram Moolenaar32e35112020-05-14 22:41:15 +0200779 has_assign = *expr == '=' || (vim_strchr((char_u *)"+-*/%", *expr) != NULL
780 && expr[1] == '=');
Bram Moolenaar822ba242020-05-24 23:00:18 +0200781 if (!has_assign && !concat)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200782 {
783 // ":let" without "=": list variables
784 if (*arg == '[')
785 emsg(_(e_invarg));
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200786 else if (expr[0] == '.' && expr[1] == '=')
787 emsg(_("E985: .= is not supported with script version >= 2"));
Bram Moolenaarfaac4102020-04-20 17:46:14 +0200788 else if (!ends_excmd2(eap->cmd, arg))
Bram Moolenaarc82a5b52020-06-13 18:09:19 +0200789 {
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200790 if (vim9script)
Bram Moolenaarc82a5b52020-06-13 18:09:19 +0200791 {
Bram Moolenaarccc25aa2021-03-26 21:27:52 +0100792 if (!ends_excmd2(eap->cmd, skipwhite(argend)))
793 semsg(_(e_trailing_arg), argend);
794 else
795 // Vim9 declaration ":var name: type"
796 arg = vim9_declare_scriptvar(eap, arg);
Bram Moolenaarc82a5b52020-06-13 18:09:19 +0200797 }
798 else
799 {
800 // ":let var1 var2" - list values
801 arg = list_arg_vars(eap, arg, &first);
802 }
803 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200804 else if (!eap->skip)
805 {
806 // ":let"
807 list_glob_vars(&first);
808 list_buf_vars(&first);
809 list_win_vars(&first);
810 list_tab_vars(&first);
811 list_script_vars(&first);
812 list_func_vars(&first);
813 list_vim_vars(&first);
814 }
Bram Moolenaar63b91732021-08-05 20:40:03 +0200815 set_nextcmd(eap, arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200816 }
817 else if (expr[0] == '=' && expr[1] == '<' && expr[2] == '<')
818 {
819 list_T *l;
Bram Moolenaar81530e32021-07-28 21:25:49 +0200820 long cur_lnum = SOURCING_LNUM;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200821
822 // HERE document
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200823 l = heredoc_get(eap, expr + 3, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200824 if (l != NULL)
825 {
826 rettv_list_set(&rettv, l);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +0200827 if (!eap->skip)
828 {
Bram Moolenaar81530e32021-07-28 21:25:49 +0200829 // errors are for the assignment, not the end marker
830 SOURCING_LNUM = cur_lnum;
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +0200831 op[0] = '=';
832 op[1] = NUL;
833 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100834 flags, op);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +0200835 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200836 clear_tv(&rettv);
837 }
838 }
839 else
840 {
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200841 evalarg_T evalarg;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200842 int len = 1;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200843
Bram Moolenaarc1ec0422020-09-09 22:27:58 +0200844 CLEAR_FIELD(rettv);
Bram Moolenaar32e35112020-05-14 22:41:15 +0200845 i = FAIL;
846 if (has_assign || concat)
847 {
Bram Moolenaar9a562c12021-01-23 13:39:14 +0100848 int cur_lnum;
849
Bram Moolenaar32e35112020-05-14 22:41:15 +0200850 op[0] = '=';
851 op[1] = NUL;
852 if (*expr != '=')
853 {
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200854 if (vim9script && (flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar122616d2020-08-21 21:32:50 +0200855 {
856 // +=, /=, etc. require an existing variable
857 semsg(_(e_cannot_use_operator_on_new_variable), eap->arg);
858 i = FAIL;
859 }
860 else if (vim_strchr((char_u *)"+-*/%.", *expr) != NULL)
Bram Moolenaar32e35112020-05-14 22:41:15 +0200861 {
862 op[0] = *expr; // +=, -=, *=, /=, %= or .=
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200863 ++len;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200864 if (expr[0] == '.' && expr[1] == '.') // ..=
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200865 {
Bram Moolenaar32e35112020-05-14 22:41:15 +0200866 ++expr;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200867 ++len;
868 }
Bram Moolenaar32e35112020-05-14 22:41:15 +0200869 }
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200870 expr += 2;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200871 }
872 else
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200873 ++expr;
874
Bram Moolenaarc7e44a72020-07-29 21:37:43 +0200875 if (vim9script && (!VIM_ISWHITE(*argend)
876 || !IS_WHITE_OR_NUL(*expr)))
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200877 {
878 vim_strncpy(op, expr - len, len);
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100879 semsg(_(e_white_space_required_before_and_after_str_at_str),
880 op, argend);
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200881 i = FAIL;
882 }
Bram Moolenaar32e35112020-05-14 22:41:15 +0200883
884 if (eap->skip)
885 ++emsg_skip;
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200886 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaarc7e44a72020-07-29 21:37:43 +0200887 expr = skipwhite_and_linebreak(expr, &evalarg);
Bram Moolenaar9a562c12021-01-23 13:39:14 +0100888 cur_lnum = SOURCING_LNUM;
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200889 i = eval0(expr, &rettv, eap, &evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200890 if (eap->skip)
891 --emsg_skip;
Bram Moolenaarfaf86262020-06-27 23:07:36 +0200892 clear_evalarg(&evalarg, eap);
Bram Moolenaar9a562c12021-01-23 13:39:14 +0100893
894 // Restore the line number so that any type error is given for the
895 // declaration, not the expression.
896 SOURCING_LNUM = cur_lnum;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200897 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200898 if (eap->skip)
899 {
900 if (i != FAIL)
901 clear_tv(&rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200902 }
Bram Moolenaar822ba242020-05-24 23:00:18 +0200903 else if (i != FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200904 {
905 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200906 flags, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200907 clear_tv(&rettv);
908 }
909 }
910}
911
912/*
Bram Moolenaar6c3843c2021-03-04 12:38:21 +0100913 * Assign the typeval "tv" to the variable or variables at "arg_start".
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200914 * Handles both "var" with any type and "[var, var; var]" with a list type.
915 * When "op" is not NULL it points to a string with characters that
916 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
917 * or concatenate.
918 * Returns OK or FAIL;
919 */
920 int
921ex_let_vars(
922 char_u *arg_start,
923 typval_T *tv,
924 int copy, // copy values from "tv", don't move
925 int semicolon, // from skip_var_list()
926 int var_count, // from skip_var_list()
Bram Moolenaar3862ea32021-01-01 21:05:55 +0100927 int flags, // ASSIGN_FINAL, ASSIGN_CONST, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200928 char_u *op)
929{
930 char_u *arg = arg_start;
931 list_T *l;
932 int i;
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100933 int var_idx = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200934 listitem_T *item;
935 typval_T ltv;
936
937 if (*arg != '[')
938 {
939 // ":let var = expr" or ":for var in list"
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100940 if (ex_let_one(arg, tv, copy, flags, op, op, var_idx) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200941 return FAIL;
942 return OK;
943 }
944
945 // ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
946 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
947 {
948 emsg(_(e_listreq));
949 return FAIL;
950 }
951
952 i = list_len(l);
953 if (semicolon == 0 && var_count < i)
954 {
955 emsg(_("E687: Less targets than List items"));
956 return FAIL;
957 }
958 if (var_count - semicolon > i)
959 {
960 emsg(_("E688: More targets than List items"));
961 return FAIL;
962 }
963
Bram Moolenaar7e9f3512020-05-13 22:44:22 +0200964 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200965 item = l->lv_first;
966 while (*arg != ']')
967 {
968 arg = skipwhite(arg + 1);
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100969 ++var_idx;
Bram Moolenaarf93bbd02021-04-10 22:35:43 +0200970 arg = ex_let_one(arg, &item->li_tv, TRUE,
971 flags | ASSIGN_UNPACK, (char_u *)",;]", op, var_idx);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200972 item = item->li_next;
973 if (arg == NULL)
974 return FAIL;
975
976 arg = skipwhite(arg);
977 if (*arg == ';')
978 {
979 // Put the rest of the list (may be empty) in the var after ';'.
980 // Create a new list for this.
981 l = list_alloc();
982 if (l == NULL)
983 return FAIL;
984 while (item != NULL)
985 {
986 list_append_tv(l, &item->li_tv);
987 item = item->li_next;
988 }
989
990 ltv.v_type = VAR_LIST;
991 ltv.v_lock = 0;
992 ltv.vval.v_list = l;
993 l->lv_refcount = 1;
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100994 ++var_idx;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200995
Bram Moolenaarf93bbd02021-04-10 22:35:43 +0200996 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
997 flags | ASSIGN_UNPACK, (char_u *)"]", op, var_idx);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200998 clear_tv(&ltv);
999 if (arg == NULL)
1000 return FAIL;
1001 break;
1002 }
1003 else if (*arg != ',' && *arg != ']')
1004 {
1005 internal_error("ex_let_vars()");
1006 return FAIL;
1007 }
1008 }
1009
1010 return OK;
1011}
1012
1013/*
1014 * Skip over assignable variable "var" or list of variables "[var, var]".
1015 * Used for ":let varvar = expr" and ":for varvar in expr".
1016 * For "[var, var]" increment "*var_count" for each variable.
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001017 * for "[var, var; var]" set "semicolon" to 1.
1018 * If "silent" is TRUE do not give an "invalid argument" error message.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001019 * Return NULL for an error.
1020 */
1021 char_u *
1022skip_var_list(
1023 char_u *arg,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001024 int include_type,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001025 int *var_count,
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001026 int *semicolon,
1027 int silent)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001028{
1029 char_u *p, *s;
1030
1031 if (*arg == '[')
1032 {
1033 // "[var, var]": find the matching ']'.
1034 p = arg;
1035 for (;;)
1036 {
1037 p = skipwhite(p + 1); // skip whites after '[', ';' or ','
Bram Moolenaar036d0712021-01-17 20:23:38 +01001038 s = skip_var_one(p, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001039 if (s == p)
1040 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001041 if (!silent)
1042 semsg(_(e_invarg2), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001043 return NULL;
1044 }
1045 ++*var_count;
1046
1047 p = skipwhite(s);
1048 if (*p == ']')
1049 break;
1050 else if (*p == ';')
1051 {
1052 if (*semicolon == 1)
1053 {
Bram Moolenaar9be61bb2020-03-30 22:51:24 +02001054 emsg(_("E452: Double ; in list of variables"));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001055 return NULL;
1056 }
1057 *semicolon = 1;
1058 }
1059 else if (*p != ',')
1060 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001061 if (!silent)
1062 semsg(_(e_invarg2), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001063 return NULL;
1064 }
1065 }
1066 return p + 1;
1067 }
1068 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001069 return skip_var_one(arg, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001070}
1071
1072/*
1073 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1074 * l[idx].
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001075 * In Vim9 script also skip over ": type" if "include_type" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001076 */
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001077 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001078skip_var_one(char_u *arg, int include_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001079{
Bram Moolenaar585587d2021-01-17 20:52:13 +01001080 char_u *end;
1081 int vim9 = in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001082
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001083 if (*arg == '@' && arg[1] != NUL)
1084 return arg + 2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001085 end = find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001086 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
Bram Moolenaar036d0712021-01-17 20:23:38 +01001087
1088 // "a: type" is declaring variable "a" with a type, not "a:".
1089 // Same for "s: type".
Bram Moolenaar585587d2021-01-17 20:52:13 +01001090 if (vim9 && end == arg + 2 && end[-1] == ':')
Bram Moolenaar036d0712021-01-17 20:23:38 +01001091 --end;
1092
Bram Moolenaar585587d2021-01-17 20:52:13 +01001093 if (include_type && vim9)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001094 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001095 if (*end == ':')
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02001096 end = skip_type(skipwhite(end + 1), FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001097 }
1098 return end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001099}
1100
1101/*
1102 * List variables for hashtab "ht" with prefix "prefix".
1103 * If "empty" is TRUE also list NULL strings as empty strings.
1104 */
1105 void
1106list_hashtable_vars(
1107 hashtab_T *ht,
1108 char *prefix,
1109 int empty,
1110 int *first)
1111{
1112 hashitem_T *hi;
1113 dictitem_T *di;
1114 int todo;
1115 char_u buf[IOSIZE];
1116
1117 todo = (int)ht->ht_used;
1118 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1119 {
1120 if (!HASHITEM_EMPTY(hi))
1121 {
1122 --todo;
1123 di = HI2DI(hi);
1124
1125 // apply :filter /pat/ to variable name
1126 vim_strncpy((char_u *)buf, (char_u *)prefix, IOSIZE - 1);
1127 vim_strcat((char_u *)buf, di->di_key, IOSIZE);
1128 if (message_filtered(buf))
1129 continue;
1130
1131 if (empty || di->di_tv.v_type != VAR_STRING
1132 || di->di_tv.vval.v_string != NULL)
1133 list_one_var(di, prefix, first);
1134 }
1135 }
1136}
1137
1138/*
1139 * List global variables.
1140 */
1141 static void
1142list_glob_vars(int *first)
1143{
1144 list_hashtable_vars(&globvarht, "", TRUE, first);
1145}
1146
1147/*
1148 * List buffer variables.
1149 */
1150 static void
1151list_buf_vars(int *first)
1152{
1153 list_hashtable_vars(&curbuf->b_vars->dv_hashtab, "b:", TRUE, first);
1154}
1155
1156/*
1157 * List window variables.
1158 */
1159 static void
1160list_win_vars(int *first)
1161{
1162 list_hashtable_vars(&curwin->w_vars->dv_hashtab, "w:", TRUE, first);
1163}
1164
1165/*
1166 * List tab page variables.
1167 */
1168 static void
1169list_tab_vars(int *first)
1170{
1171 list_hashtable_vars(&curtab->tp_vars->dv_hashtab, "t:", TRUE, first);
1172}
1173
1174/*
1175 * List variables in "arg".
1176 */
1177 static char_u *
1178list_arg_vars(exarg_T *eap, char_u *arg, int *first)
1179{
1180 int error = FALSE;
1181 int len;
1182 char_u *name;
1183 char_u *name_start;
1184 char_u *arg_subsc;
1185 char_u *tofree;
1186 typval_T tv;
1187
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001188 while (!ends_excmd2(eap->cmd, arg) && !got_int)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001189 {
1190 if (error || eap->skip)
1191 {
1192 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1193 if (!VIM_ISWHITE(*arg) && !ends_excmd(*arg))
1194 {
1195 emsg_severe = TRUE;
Bram Moolenaar4830c212021-08-14 14:59:27 +02001196 if (!did_emsg)
Bram Moolenaar88c89c72021-08-14 14:01:05 +02001197 semsg(_(e_trailing_arg), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001198 break;
1199 }
1200 }
1201 else
1202 {
1203 // get_name_len() takes care of expanding curly braces
1204 name_start = name = arg;
1205 len = get_name_len(&arg, &tofree, TRUE, TRUE);
1206 if (len <= 0)
1207 {
1208 // This is mainly to keep test 49 working: when expanding
1209 // curly braces fails overrule the exception error message.
1210 if (len < 0 && !aborting())
1211 {
1212 emsg_severe = TRUE;
1213 semsg(_(e_invarg2), arg);
1214 break;
1215 }
1216 error = TRUE;
1217 }
1218 else
1219 {
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02001220 arg = skipwhite(arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001221 if (tofree != NULL)
1222 name = tofree;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01001223 if (eval_variable(name, len, &tv, NULL,
1224 EVAL_VAR_VERBOSE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001225 error = TRUE;
1226 else
1227 {
1228 // handle d.key, l[idx], f(expr)
1229 arg_subsc = arg;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001230 if (handle_subscript(&arg, &tv, &EVALARG_EVALUATE, TRUE)
Bram Moolenaar0b1cd522020-06-27 13:11:50 +02001231 == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001232 error = TRUE;
1233 else
1234 {
1235 if (arg == arg_subsc && len == 2 && name[1] == ':')
1236 {
1237 switch (*name)
1238 {
1239 case 'g': list_glob_vars(first); break;
1240 case 'b': list_buf_vars(first); break;
1241 case 'w': list_win_vars(first); break;
1242 case 't': list_tab_vars(first); break;
1243 case 'v': list_vim_vars(first); break;
1244 case 's': list_script_vars(first); break;
1245 case 'l': list_func_vars(first); break;
1246 default:
1247 semsg(_("E738: Can't list variables for %s"), name);
1248 }
1249 }
1250 else
1251 {
1252 char_u numbuf[NUMBUFLEN];
1253 char_u *tf;
1254 int c;
1255 char_u *s;
1256
1257 s = echo_string(&tv, &tf, numbuf, 0);
1258 c = *arg;
1259 *arg = NUL;
1260 list_one_var_a("",
1261 arg == arg_subsc ? name : name_start,
1262 tv.v_type,
1263 s == NULL ? (char_u *)"" : s,
1264 first);
1265 *arg = c;
1266 vim_free(tf);
1267 }
1268 clear_tv(&tv);
1269 }
1270 }
1271 }
1272
1273 vim_free(tofree);
1274 }
1275
1276 arg = skipwhite(arg);
1277 }
1278
1279 return arg;
1280}
1281
1282/*
1283 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
1284 * Returns a pointer to the char just after the var name.
1285 * Returns NULL if there is an error.
1286 */
1287 static char_u *
1288ex_let_one(
1289 char_u *arg, // points to variable name
1290 typval_T *tv, // value to assign to variable
1291 int copy, // copy value from "tv"
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001292 int flags, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001293 char_u *endchars, // valid chars after variable name or NULL
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001294 char_u *op, // "+", "-", "." or NULL
1295 int var_idx) // variable index for "let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001296{
1297 int c1;
1298 char_u *name;
1299 char_u *p;
1300 char_u *arg_end = NULL;
1301 int len;
1302 int opt_flags;
1303 char_u *tofree = NULL;
1304
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001305 if (in_vim9script() && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001306 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001307 && vim_strchr((char_u *)"$@&", *arg) != NULL)
1308 {
1309 vim9_declare_error(arg);
1310 return NULL;
1311 }
1312
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001313 // ":let $VAR = expr": Set environment variable.
1314 if (*arg == '$')
1315 {
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02001316 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1317 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001318 {
1319 emsg(_("E996: Cannot lock an environment variable"));
1320 return NULL;
1321 }
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001322
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001323 // Find the end of the name.
1324 ++arg;
1325 name = arg;
1326 len = get_env_len(&arg);
1327 if (len == 0)
1328 semsg(_(e_invarg2), name - 1);
1329 else
1330 {
1331 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1332 semsg(_(e_letwrong), op);
1333 else if (endchars != NULL
1334 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
Bram Moolenaar108010a2021-06-27 22:03:33 +02001335 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001336 else if (!check_secure())
1337 {
1338 c1 = name[len];
1339 name[len] = NUL;
1340 p = tv_get_string_chk(tv);
1341 if (p != NULL && op != NULL && *op == '.')
1342 {
1343 int mustfree = FALSE;
1344 char_u *s = vim_getenv(name, &mustfree);
1345
1346 if (s != NULL)
1347 {
1348 p = tofree = concat_str(s, p);
1349 if (mustfree)
1350 vim_free(s);
1351 }
1352 }
1353 if (p != NULL)
1354 {
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01001355 vim_setenv_ext(name, p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001356 arg_end = arg;
1357 }
1358 name[len] = c1;
1359 vim_free(tofree);
1360 }
1361 }
1362 }
1363
1364 // ":let &option = expr": Set option value.
1365 // ":let &l:option = expr": Set local option value.
1366 // ":let &g:option = expr": Set global option value.
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02001367 // ":for &ts in range(8)": Set option value for for loop
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001368 else if (*arg == '&')
1369 {
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02001370 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1371 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001372 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001373 emsg(_(e_const_option));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001374 return NULL;
1375 }
1376 // Find the end of the name.
1377 p = find_option_end(&arg, &opt_flags);
1378 if (p == NULL || (endchars != NULL
1379 && vim_strchr(endchars, *skipwhite(p)) == NULL))
Bram Moolenaar108010a2021-06-27 22:03:33 +02001380 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001381 else
1382 {
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001383 long n = 0;
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001384 getoption_T opt_type;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001385 long numval;
1386 char_u *stringval = NULL;
Bram Moolenaar65d032c2020-04-24 20:57:01 +02001387 char_u *s = NULL;
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001388 int failed = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001389
1390 c1 = *p;
1391 *p = NUL;
1392
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001393 opt_type = get_option_value(arg, &numval, &stringval, opt_flags);
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001394 if ((opt_type == gov_bool
1395 || opt_type == gov_number
1396 || opt_type == gov_hidden_bool
1397 || opt_type == gov_hidden_number)
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001398 && (tv->v_type != VAR_STRING || !in_vim9script()))
Bram Moolenaar0ea04402021-01-04 13:37:54 +01001399 {
1400 if (opt_type == gov_bool || opt_type == gov_hidden_bool)
1401 // bool, possibly hidden
1402 n = (long)tv_get_bool(tv);
1403 else
1404 // number, possibly hidden
1405 n = (long)tv_get_number(tv);
1406 }
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001407
1408 // Avoid setting a string option to the text "v:false" or similar.
1409 // In Vim9 script also don't convert a number to string.
1410 if (tv->v_type != VAR_BOOL && tv->v_type != VAR_SPECIAL
1411 && (!in_vim9script() || tv->v_type != VAR_NUMBER))
1412 s = tv_get_string_chk(tv);
1413
1414 if (op != NULL && *op != '=')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001415 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001416 if (((opt_type == gov_bool || opt_type == gov_number)
1417 && *op == '.')
1418 || (opt_type == gov_string && *op != '.'))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001419 {
1420 semsg(_(e_letwrong), op);
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001421 failed = TRUE; // don't set the value
1422
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001423 }
1424 else
1425 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001426 // number, in legacy script also bool
1427 if (opt_type == gov_number
1428 || (opt_type == gov_bool && !in_vim9script()))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001429 {
1430 switch (*op)
1431 {
1432 case '+': n = numval + n; break;
1433 case '-': n = numval - n; break;
1434 case '*': n = numval * n; break;
Bram Moolenaarc5f59fa2021-01-21 12:34:14 +01001435 case '/': n = (long)num_divide(numval, n,
1436 &failed); break;
1437 case '%': n = (long)num_modulus(numval, n,
1438 &failed); break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001439 }
Bram Moolenaara42e6e02021-06-10 18:43:25 +02001440 s = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001441 }
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001442 else if (opt_type == gov_string
1443 && stringval != NULL && s != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001444 {
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001445 // string
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001446 s = concat_str(stringval, s);
1447 vim_free(stringval);
1448 stringval = s;
1449 }
1450 }
1451 }
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001452
1453 if (!failed)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001454 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001455 if (opt_type != gov_string || s != NULL)
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001456 {
1457 set_option_value(arg, n, s, opt_flags);
1458 arg_end = p;
1459 }
1460 else
1461 emsg(_(e_stringreq));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001462 }
1463 *p = c1;
1464 vim_free(stringval);
1465 }
1466 }
1467
1468 // ":let @r = expr": Set register contents.
1469 else if (*arg == '@')
1470 {
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02001471 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1472 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001473 {
1474 emsg(_("E996: Cannot lock a register"));
1475 return NULL;
1476 }
1477 ++arg;
1478 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1479 semsg(_(e_letwrong), op);
1480 else if (endchars != NULL
1481 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
Bram Moolenaar108010a2021-06-27 22:03:33 +02001482 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001483 else
1484 {
1485 char_u *ptofree = NULL;
1486 char_u *s;
1487
1488 p = tv_get_string_chk(tv);
1489 if (p != NULL && op != NULL && *op == '.')
1490 {
1491 s = get_reg_contents(*arg == '@' ? '"' : *arg, GREG_EXPR_SRC);
1492 if (s != NULL)
1493 {
1494 p = ptofree = concat_str(s, p);
1495 vim_free(s);
1496 }
1497 }
1498 if (p != NULL)
1499 {
1500 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
1501 arg_end = arg + 1;
1502 }
1503 vim_free(ptofree);
1504 }
1505 }
1506
1507 // ":let var = expr": Set internal variable.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001508 // ":let var: type = expr": Set internal variable with type.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001509 // ":let {expr} = expr": Idem, name made with curly braces
1510 else if (eval_isnamec1(*arg) || *arg == '{')
1511 {
1512 lval_T lv;
1513
Bram Moolenaar8f22f5c2020-12-19 22:10:13 +01001514 p = get_lval(arg, tv, &lv, FALSE, FALSE,
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001515 (flags & (ASSIGN_NO_DECL | ASSIGN_DECL))
1516 ? GLV_NO_DECL : 0, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001517 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001518 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001519 if (endchars != NULL && vim_strchr(endchars,
1520 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar108010a2021-06-27 22:03:33 +02001521 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001522 else
1523 {
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001524 set_var_lval(&lv, p, tv, copy, flags, op, var_idx);
Bram Moolenaara3589a02021-04-14 13:30:46 +02001525 arg_end = lv.ll_name_end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001526 }
1527 }
1528 clear_lval(&lv);
1529 }
1530
1531 else
1532 semsg(_(e_invarg2), arg);
1533
1534 return arg_end;
1535}
1536
1537/*
1538 * ":unlet[!] var1 ... " command.
1539 */
1540 void
1541ex_unlet(exarg_T *eap)
1542{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001543 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001544}
1545
1546/*
1547 * ":lockvar" and ":unlockvar" commands
1548 */
1549 void
1550ex_lockvar(exarg_T *eap)
1551{
1552 char_u *arg = eap->arg;
1553 int deep = 2;
1554
1555 if (eap->forceit)
1556 deep = -1;
1557 else if (vim_isdigit(*arg))
1558 {
1559 deep = getdigits(&arg);
1560 arg = skipwhite(arg);
1561 }
1562
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001563 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001564}
1565
1566/*
1567 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001568 * Also used for Vim9 script. "callback" is invoked as:
1569 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001570 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001571 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001572ex_unletlock(
1573 exarg_T *eap,
1574 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001575 int deep,
1576 int glv_flags,
1577 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1578 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001579{
1580 char_u *arg = argstart;
1581 char_u *name_end;
1582 int error = FALSE;
1583 lval_T lv;
1584
1585 do
1586 {
1587 if (*arg == '$')
1588 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001589 lv.ll_name = arg;
1590 lv.ll_tv = NULL;
1591 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001592 if (get_env_len(&arg) == 0)
1593 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001594 semsg(_(e_invarg2), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001595 return;
1596 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001597 if (!error && !eap->skip
1598 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1599 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001600 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001601 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001602 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001603 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001604 // Parse the name and find the end.
1605 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
Bram Moolenaarc3689572021-01-01 19:40:02 +01001606 glv_flags | GLV_NO_DECL, FNE_CHECK_START);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001607 if (lv.ll_name == NULL)
1608 error = TRUE; // error but continue parsing
1609 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1610 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001611 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001612 if (name_end != NULL)
1613 {
1614 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001615 semsg(_(e_trailing_arg), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001616 }
1617 if (!(eap->skip || error))
1618 clear_lval(&lv);
1619 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001620 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001621
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001622 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001623 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001624 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001625
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001626 if (!eap->skip)
1627 clear_lval(&lv);
1628 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001629
1630 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001631 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001632
Bram Moolenaar63b91732021-08-05 20:40:03 +02001633 set_nextcmd(eap, arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001634}
1635
1636 static int
1637do_unlet_var(
1638 lval_T *lp,
1639 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001640 exarg_T *eap,
1641 int deep UNUSED,
1642 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001643{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001644 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001645 int ret = OK;
1646 int cc;
1647
1648 if (lp->ll_tv == NULL)
1649 {
1650 cc = *name_end;
1651 *name_end = NUL;
1652
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001653 // Environment variable, normal name or expanded name.
1654 if (*lp->ll_name == '$')
1655 vim_unsetenv(lp->ll_name + 1);
1656 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001657 ret = FAIL;
1658 *name_end = cc;
1659 }
1660 else if ((lp->ll_list != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001661 && value_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001662 || (lp->ll_dict != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001663 && value_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001664 return FAIL;
1665 else if (lp->ll_range)
1666 {
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01001667 if (list_unlet_range(lp->ll_list, lp->ll_li, lp->ll_name, lp->ll_n1,
1668 !lp->ll_empty2, lp->ll_n2) == FAIL)
1669 return FAIL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001670 }
1671 else
1672 {
1673 if (lp->ll_list != NULL)
1674 // unlet a List item.
1675 listitem_remove(lp->ll_list, lp->ll_li);
1676 else
1677 // unlet a Dictionary item.
1678 dictitem_remove(lp->ll_dict, lp->ll_di);
1679 }
1680
1681 return ret;
1682}
1683
1684/*
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01001685 * Unlet one item or a range of items from a list.
1686 * Return OK or FAIL.
1687 */
1688 int
1689list_unlet_range(
1690 list_T *l,
1691 listitem_T *li_first,
1692 char_u *name,
1693 long n1_arg,
1694 int has_n2,
1695 long n2)
1696{
1697 listitem_T *li = li_first;
1698 int n1 = n1_arg;
1699
1700 while (li != NULL && (!has_n2 || n2 >= n1))
1701 {
1702 if (value_check_lock(li->li_tv.v_lock, name, FALSE))
1703 return FAIL;
1704 li = li->li_next;
1705 ++n1;
1706 }
1707
1708 // Delete a range of List items.
1709 li = li_first;
1710 n1 = n1_arg;
1711 while (li != NULL && (!has_n2 || n2 >= n1))
1712 {
1713 listitem_T *next = li->li_next;
1714
1715 listitem_remove(l, li);
1716 li = next;
1717 ++n1;
1718 }
1719 return OK;
1720}
1721/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001722 * "unlet" a variable. Return OK if it existed, FAIL if not.
1723 * When "forceit" is TRUE don't complain if the variable doesn't exist.
1724 */
1725 int
1726do_unlet(char_u *name, int forceit)
1727{
1728 hashtab_T *ht;
1729 hashitem_T *hi;
1730 char_u *varname;
1731 dict_T *d;
1732 dictitem_T *di;
1733
Bram Moolenaar9aed7292020-12-18 15:38:00 +01001734 // can't :unlet a script variable in Vim9 script
Bram Moolenaareb6880b2020-07-12 17:07:05 +02001735 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001736 return FAIL;
1737
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001738 ht = find_var_ht(name, &varname);
Bram Moolenaar9aed7292020-12-18 15:38:00 +01001739
1740 // can't :unlet a script variable in Vim9 script from a function
1741 if (ht == get_script_local_ht()
1742 && SCRIPT_ID_VALID(current_sctx.sc_sid)
1743 && SCRIPT_ITEM(current_sctx.sc_sid)->sn_version
1744 == SCRIPT_VERSION_VIM9
1745 && check_vim9_unlet(name) == FAIL)
1746 return FAIL;
1747
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001748 if (ht != NULL && *varname != NUL)
1749 {
1750 d = get_current_funccal_dict(ht);
1751 if (d == NULL)
1752 {
1753 if (ht == &globvarht)
1754 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001755 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001756 d = &vimvardict;
1757 else
1758 {
1759 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
1760 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
1761 }
1762 if (d == NULL)
1763 {
1764 internal_error("do_unlet()");
1765 return FAIL;
1766 }
1767 }
1768 hi = hash_find(ht, varname);
1769 if (HASHITEM_EMPTY(hi))
1770 hi = find_hi_in_scoped_ht(name, &ht);
1771 if (hi != NULL && !HASHITEM_EMPTY(hi))
1772 {
1773 di = HI2DI(hi);
1774 if (var_check_fixed(di->di_flags, name, FALSE)
1775 || var_check_ro(di->di_flags, name, FALSE)
Bram Moolenaara187c432020-09-16 21:08:28 +02001776 || value_check_lock(d->dv_lock, name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001777 return FAIL;
1778
1779 delete_var(ht, hi);
1780 return OK;
1781 }
1782 }
1783 if (forceit)
1784 return OK;
1785 semsg(_("E108: No such variable: \"%s\""), name);
1786 return FAIL;
1787}
1788
1789/*
1790 * Lock or unlock variable indicated by "lp".
1791 * "deep" is the levels to go (-1 for unlimited);
1792 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
1793 */
1794 static int
1795do_lock_var(
1796 lval_T *lp,
1797 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001798 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001799 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001800 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001801{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001802 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001803 int ret = OK;
1804 int cc;
1805 dictitem_T *di;
1806
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001807 if (lp->ll_tv == NULL)
1808 {
1809 cc = *name_end;
1810 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001811 if (*lp->ll_name == '$')
1812 {
1813 semsg(_(e_lock_unlock), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001814 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001815 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001816 else
1817 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001818 // Normal name or expanded name.
1819 di = find_var(lp->ll_name, NULL, TRUE);
1820 if (di == NULL)
1821 ret = FAIL;
1822 else if ((di->di_flags & DI_FLAGS_FIX)
1823 && di->di_tv.v_type != VAR_DICT
1824 && di->di_tv.v_type != VAR_LIST)
1825 {
1826 // For historic reasons this error is not given for a list or
1827 // dict. E.g., the b: dict could be locked/unlocked.
1828 semsg(_(e_lock_unlock), lp->ll_name);
1829 ret = FAIL;
1830 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001831 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001832 {
1833 if (lock)
1834 di->di_flags |= DI_FLAGS_LOCK;
1835 else
1836 di->di_flags &= ~DI_FLAGS_LOCK;
Bram Moolenaara187c432020-09-16 21:08:28 +02001837 if (deep != 0)
1838 item_lock(&di->di_tv, deep, lock, FALSE);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001839 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001840 }
1841 *name_end = cc;
1842 }
Bram Moolenaara187c432020-09-16 21:08:28 +02001843 else if (deep == 0)
1844 {
1845 // nothing to do
1846 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001847 else if (lp->ll_range)
1848 {
1849 listitem_T *li = lp->ll_li;
1850
1851 // (un)lock a range of List items.
1852 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
1853 {
Bram Moolenaar021bda52020-08-17 21:07:22 +02001854 item_lock(&li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001855 li = li->li_next;
1856 ++lp->ll_n1;
1857 }
1858 }
1859 else if (lp->ll_list != NULL)
1860 // (un)lock a List item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001861 item_lock(&lp->ll_li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001862 else
1863 // (un)lock a Dictionary item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001864 item_lock(&lp->ll_di->di_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001865
1866 return ret;
1867}
1868
1869/*
1870 * Lock or unlock an item. "deep" is nr of levels to go.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001871 * When "check_refcount" is TRUE do not lock a list or dict with a reference
1872 * count larger than 1.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001873 */
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02001874 void
Bram Moolenaar021bda52020-08-17 21:07:22 +02001875item_lock(typval_T *tv, int deep, int lock, int check_refcount)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001876{
1877 static int recurse = 0;
1878 list_T *l;
1879 listitem_T *li;
1880 dict_T *d;
1881 blob_T *b;
1882 hashitem_T *hi;
1883 int todo;
1884
1885 if (recurse >= DICT_MAXNEST)
1886 {
1887 emsg(_("E743: variable nested too deep for (un)lock"));
1888 return;
1889 }
1890 if (deep == 0)
1891 return;
1892 ++recurse;
1893
1894 // lock/unlock the item itself
1895 if (lock)
1896 tv->v_lock |= VAR_LOCKED;
1897 else
1898 tv->v_lock &= ~VAR_LOCKED;
1899
1900 switch (tv->v_type)
1901 {
1902 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02001903 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001904 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001905 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001906 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001907 case VAR_STRING:
1908 case VAR_FUNC:
1909 case VAR_PARTIAL:
1910 case VAR_FLOAT:
1911 case VAR_SPECIAL:
1912 case VAR_JOB:
1913 case VAR_CHANNEL:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02001914 case VAR_INSTR:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001915 break;
1916
1917 case VAR_BLOB:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001918 if ((b = tv->vval.v_blob) != NULL
1919 && !(check_refcount && b->bv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001920 {
1921 if (lock)
1922 b->bv_lock |= VAR_LOCKED;
1923 else
1924 b->bv_lock &= ~VAR_LOCKED;
1925 }
1926 break;
1927 case VAR_LIST:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001928 if ((l = tv->vval.v_list) != NULL
1929 && !(check_refcount && l->lv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001930 {
1931 if (lock)
1932 l->lv_lock |= VAR_LOCKED;
1933 else
1934 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001935 if ((deep < 0 || deep > 1) && l->lv_first != &range_list_item)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001936 // recursive: lock/unlock the items the List contains
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001937 FOR_ALL_LIST_ITEMS(l, li)
Bram Moolenaar021bda52020-08-17 21:07:22 +02001938 item_lock(&li->li_tv, deep - 1, lock, check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001939 }
1940 break;
1941 case VAR_DICT:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001942 if ((d = tv->vval.v_dict) != NULL
1943 && !(check_refcount && d->dv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001944 {
1945 if (lock)
1946 d->dv_lock |= VAR_LOCKED;
1947 else
1948 d->dv_lock &= ~VAR_LOCKED;
1949 if (deep < 0 || deep > 1)
1950 {
1951 // recursive: lock/unlock the items the List contains
1952 todo = (int)d->dv_hashtab.ht_used;
1953 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
1954 {
1955 if (!HASHITEM_EMPTY(hi))
1956 {
1957 --todo;
Bram Moolenaar021bda52020-08-17 21:07:22 +02001958 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock,
1959 check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001960 }
1961 }
1962 }
1963 }
1964 }
1965 --recurse;
1966}
1967
Bram Moolenaarda6c0332019-09-01 16:01:30 +02001968#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
1969/*
1970 * Delete all "menutrans_" variables.
1971 */
1972 void
1973del_menutrans_vars(void)
1974{
1975 hashitem_T *hi;
1976 int todo;
1977
1978 hash_lock(&globvarht);
1979 todo = (int)globvarht.ht_used;
1980 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
1981 {
1982 if (!HASHITEM_EMPTY(hi))
1983 {
1984 --todo;
1985 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
1986 delete_var(&globvarht, hi);
1987 }
1988 }
1989 hash_unlock(&globvarht);
1990}
1991#endif
1992
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001993/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001994 * Local string buffer for the next two functions to store a variable name
1995 * with its prefix. Allocated in cat_prefix_varname(), freed later in
1996 * get_user_var_name().
1997 */
1998
1999static char_u *varnamebuf = NULL;
2000static int varnamebuflen = 0;
2001
2002/*
2003 * Function to concatenate a prefix and a variable name.
2004 */
Bram Moolenaar1bb4de52021-01-13 19:48:46 +01002005 char_u *
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002006cat_prefix_varname(int prefix, char_u *name)
2007{
2008 int len;
2009
2010 len = (int)STRLEN(name) + 3;
2011 if (len > varnamebuflen)
2012 {
2013 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002014 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002015 varnamebuf = alloc(len);
2016 if (varnamebuf == NULL)
2017 {
2018 varnamebuflen = 0;
2019 return NULL;
2020 }
2021 varnamebuflen = len;
2022 }
2023 *varnamebuf = prefix;
2024 varnamebuf[1] = ':';
2025 STRCPY(varnamebuf + 2, name);
2026 return varnamebuf;
2027}
2028
2029/*
2030 * Function given to ExpandGeneric() to obtain the list of user defined
2031 * (global/buffer/window/built-in) variable names.
2032 */
2033 char_u *
2034get_user_var_name(expand_T *xp, int idx)
2035{
2036 static long_u gdone;
2037 static long_u bdone;
2038 static long_u wdone;
2039 static long_u tdone;
2040 static int vidx;
2041 static hashitem_T *hi;
2042 hashtab_T *ht;
2043
2044 if (idx == 0)
2045 {
2046 gdone = bdone = wdone = vidx = 0;
2047 tdone = 0;
2048 }
2049
2050 // Global variables
2051 if (gdone < globvarht.ht_used)
2052 {
2053 if (gdone++ == 0)
2054 hi = globvarht.ht_array;
2055 else
2056 ++hi;
2057 while (HASHITEM_EMPTY(hi))
2058 ++hi;
2059 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
2060 return cat_prefix_varname('g', hi->hi_key);
2061 return hi->hi_key;
2062 }
2063
2064 // b: variables
Bram Moolenaar4ff2f2f2020-10-25 13:22:42 +01002065 ht =
2066#ifdef FEAT_CMDWIN
2067 // In cmdwin, the alternative buffer should be used.
2068 (cmdwin_type != 0 && get_cmdline_type() == NUL) ?
2069 &prevwin->w_buffer->b_vars->dv_hashtab :
2070#endif
2071 &curbuf->b_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002072 if (bdone < ht->ht_used)
2073 {
2074 if (bdone++ == 0)
2075 hi = ht->ht_array;
2076 else
2077 ++hi;
2078 while (HASHITEM_EMPTY(hi))
2079 ++hi;
2080 return cat_prefix_varname('b', hi->hi_key);
2081 }
2082
2083 // w: variables
Bram Moolenaar4ff2f2f2020-10-25 13:22:42 +01002084 ht =
2085#ifdef FEAT_CMDWIN
2086 // In cmdwin, the alternative window should be used.
2087 (cmdwin_type != 0 && get_cmdline_type() == NUL) ?
2088 &prevwin->w_vars->dv_hashtab :
2089#endif
2090 &curwin->w_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002091 if (wdone < ht->ht_used)
2092 {
2093 if (wdone++ == 0)
2094 hi = ht->ht_array;
2095 else
2096 ++hi;
2097 while (HASHITEM_EMPTY(hi))
2098 ++hi;
2099 return cat_prefix_varname('w', hi->hi_key);
2100 }
2101
2102 // t: variables
2103 ht = &curtab->tp_vars->dv_hashtab;
2104 if (tdone < ht->ht_used)
2105 {
2106 if (tdone++ == 0)
2107 hi = ht->ht_array;
2108 else
2109 ++hi;
2110 while (HASHITEM_EMPTY(hi))
2111 ++hi;
2112 return cat_prefix_varname('t', hi->hi_key);
2113 }
2114
2115 // v: variables
2116 if (vidx < VV_LEN)
2117 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
2118
2119 VIM_CLEAR(varnamebuf);
2120 varnamebuflen = 0;
2121 return NULL;
2122}
2123
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002124 char *
2125get_var_special_name(int nr)
2126{
2127 switch (nr)
2128 {
Bram Moolenaara8b8af12021-01-01 15:11:04 +01002129 case VVAL_FALSE: return in_vim9script() ? "false" : "v:false";
2130 case VVAL_TRUE: return in_vim9script() ? "true" : "v:true";
Bram Moolenaar67977822021-01-03 21:53:53 +01002131 case VVAL_NULL: return in_vim9script() ? "null" : "v:null";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002132 case VVAL_NONE: return "v:none";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002133 }
2134 internal_error("get_var_special_name()");
2135 return "42";
2136}
2137
2138/*
2139 * Returns the global variable dictionary
2140 */
2141 dict_T *
2142get_globvar_dict(void)
2143{
2144 return &globvardict;
2145}
2146
2147/*
2148 * Returns the global variable hash table
2149 */
2150 hashtab_T *
2151get_globvar_ht(void)
2152{
2153 return &globvarht;
2154}
2155
2156/*
2157 * Returns the v: variable dictionary
2158 */
2159 dict_T *
2160get_vimvar_dict(void)
2161{
2162 return &vimvardict;
2163}
2164
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002165/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002166 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002167 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002168 */
2169 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002170find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002171{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002172 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2173 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002174
2175 if (di == NULL)
2176 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002177 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002178 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2179 return (int)(vv - vimvars);
2180}
2181
2182
2183/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002184 * Set type of v: variable to "type".
2185 */
2186 void
2187set_vim_var_type(int idx, vartype_T type)
2188{
2189 vimvars[idx].vv_type = type;
2190}
2191
2192/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002193 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002194 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002195 */
2196 void
2197set_vim_var_nr(int idx, varnumber_T val)
2198{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002199 vimvars[idx].vv_nr = val;
2200}
2201
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002202 char *
2203get_vim_var_name(int idx)
2204{
2205 return vimvars[idx].vv_name;
2206}
2207
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002208/*
2209 * Get typval_T v: variable value.
2210 */
2211 typval_T *
2212get_vim_var_tv(int idx)
2213{
2214 return &vimvars[idx].vv_tv;
2215}
2216
2217/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002218 * Set v: variable to "tv". Only accepts the same type.
2219 * Takes over the value of "tv".
2220 */
2221 int
2222set_vim_var_tv(int idx, typval_T *tv)
2223{
2224 if (vimvars[idx].vv_type != tv->v_type)
2225 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002226 emsg(_(e_type_mismatch_for_v_variable));
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002227 clear_tv(tv);
2228 return FAIL;
2229 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002230 // VV_RO is also checked when compiling, but let's check here as well.
2231 if (vimvars[idx].vv_flags & VV_RO)
2232 {
Bram Moolenaard8e44472021-07-21 22:20:33 +02002233 semsg(_(e_cannot_change_readonly_variable_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002234 return FAIL;
2235 }
2236 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2237 {
2238 semsg(_(e_readonlysbx), vimvars[idx].vv_name);
2239 return FAIL;
2240 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002241 clear_tv(&vimvars[idx].vv_di.di_tv);
2242 vimvars[idx].vv_di.di_tv = *tv;
2243 return OK;
2244}
2245
2246/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002247 * Get number v: variable value.
2248 */
2249 varnumber_T
2250get_vim_var_nr(int idx)
2251{
2252 return vimvars[idx].vv_nr;
2253}
2254
2255/*
2256 * Get string v: variable value. Uses a static buffer, can only be used once.
2257 * If the String variable has never been set, return an empty string.
2258 * Never returns NULL;
2259 */
2260 char_u *
2261get_vim_var_str(int idx)
2262{
2263 return tv_get_string(&vimvars[idx].vv_tv);
2264}
2265
2266/*
2267 * Get List v: variable value. Caller must take care of reference count when
2268 * needed.
2269 */
2270 list_T *
2271get_vim_var_list(int idx)
2272{
2273 return vimvars[idx].vv_list;
2274}
2275
2276/*
2277 * Get Dict v: variable value. Caller must take care of reference count when
2278 * needed.
2279 */
2280 dict_T *
2281get_vim_var_dict(int idx)
2282{
2283 return vimvars[idx].vv_dict;
2284}
2285
2286/*
2287 * Set v:char to character "c".
2288 */
2289 void
2290set_vim_var_char(int c)
2291{
2292 char_u buf[MB_MAXBYTES + 1];
2293
2294 if (has_mbyte)
2295 buf[(*mb_char2bytes)(c, buf)] = NUL;
2296 else
2297 {
2298 buf[0] = c;
2299 buf[1] = NUL;
2300 }
2301 set_vim_var_string(VV_CHAR, buf, -1);
2302}
2303
2304/*
2305 * Set v:count to "count" and v:count1 to "count1".
2306 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2307 */
2308 void
2309set_vcount(
2310 long count,
2311 long count1,
2312 int set_prevcount)
2313{
2314 if (set_prevcount)
2315 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2316 vimvars[VV_COUNT].vv_nr = count;
2317 vimvars[VV_COUNT1].vv_nr = count1;
2318}
2319
2320/*
2321 * Save variables that might be changed as a side effect. Used when executing
2322 * a timer callback.
2323 */
2324 void
2325save_vimvars(vimvars_save_T *vvsave)
2326{
2327 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2328 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2329 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2330}
2331
2332/*
2333 * Restore variables saved by save_vimvars().
2334 */
2335 void
2336restore_vimvars(vimvars_save_T *vvsave)
2337{
2338 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2339 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2340 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2341}
2342
2343/*
2344 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2345 * value.
2346 */
2347 void
2348set_vim_var_string(
2349 int idx,
2350 char_u *val,
2351 int len) // length of "val" to use or -1 (whole string)
2352{
2353 clear_tv(&vimvars[idx].vv_di.di_tv);
2354 vimvars[idx].vv_type = VAR_STRING;
2355 if (val == NULL)
2356 vimvars[idx].vv_str = NULL;
2357 else if (len == -1)
2358 vimvars[idx].vv_str = vim_strsave(val);
2359 else
2360 vimvars[idx].vv_str = vim_strnsave(val, len);
2361}
2362
2363/*
2364 * Set List v: variable to "val".
2365 */
2366 void
2367set_vim_var_list(int idx, list_T *val)
2368{
2369 clear_tv(&vimvars[idx].vv_di.di_tv);
2370 vimvars[idx].vv_type = VAR_LIST;
2371 vimvars[idx].vv_list = val;
2372 if (val != NULL)
2373 ++val->lv_refcount;
2374}
2375
2376/*
2377 * Set Dictionary v: variable to "val".
2378 */
2379 void
2380set_vim_var_dict(int idx, dict_T *val)
2381{
2382 clear_tv(&vimvars[idx].vv_di.di_tv);
2383 vimvars[idx].vv_type = VAR_DICT;
2384 vimvars[idx].vv_dict = val;
2385 if (val != NULL)
2386 {
2387 ++val->dv_refcount;
2388 dict_set_items_ro(val);
2389 }
2390}
2391
2392/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002393 * Set the v:argv list.
2394 */
2395 void
2396set_argv_var(char **argv, int argc)
2397{
2398 list_T *l = list_alloc();
2399 int i;
2400
2401 if (l == NULL)
2402 getout(1);
2403 l->lv_lock = VAR_FIXED;
2404 for (i = 0; i < argc; ++i)
2405 {
2406 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2407 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002408 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002409 }
2410 set_vim_var_list(VV_ARGV, l);
2411}
2412
2413/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002414 * Reset v:register, taking the 'clipboard' setting into account.
2415 */
2416 void
2417reset_reg_var(void)
2418{
2419 int regname = 0;
2420
2421 // Adjust the register according to 'clipboard', so that when
2422 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2423#ifdef FEAT_CLIPBOARD
2424 adjust_clip_reg(&regname);
2425#endif
2426 set_reg_var(regname);
2427}
2428
2429/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002430 * Set v:register if needed.
2431 */
2432 void
2433set_reg_var(int c)
2434{
2435 char_u regname;
2436
2437 if (c == 0 || c == ' ')
2438 regname = '"';
2439 else
2440 regname = c;
2441 // Avoid free/alloc when the value is already right.
2442 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2443 set_vim_var_string(VV_REG, &regname, 1);
2444}
2445
2446/*
2447 * Get or set v:exception. If "oldval" == NULL, return the current value.
2448 * Otherwise, restore the value to "oldval" and return NULL.
2449 * Must always be called in pairs to save and restore v:exception! Does not
2450 * take care of memory allocations.
2451 */
2452 char_u *
2453v_exception(char_u *oldval)
2454{
2455 if (oldval == NULL)
2456 return vimvars[VV_EXCEPTION].vv_str;
2457
2458 vimvars[VV_EXCEPTION].vv_str = oldval;
2459 return NULL;
2460}
2461
2462/*
2463 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2464 * Otherwise, restore the value to "oldval" and return NULL.
2465 * Must always be called in pairs to save and restore v:throwpoint! Does not
2466 * take care of memory allocations.
2467 */
2468 char_u *
2469v_throwpoint(char_u *oldval)
2470{
2471 if (oldval == NULL)
2472 return vimvars[VV_THROWPOINT].vv_str;
2473
2474 vimvars[VV_THROWPOINT].vv_str = oldval;
2475 return NULL;
2476}
2477
2478/*
2479 * Set v:cmdarg.
2480 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2481 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2482 * Must always be called in pairs!
2483 */
2484 char_u *
2485set_cmdarg(exarg_T *eap, char_u *oldarg)
2486{
2487 char_u *oldval;
2488 char_u *newval;
2489 unsigned len;
2490
2491 oldval = vimvars[VV_CMDARG].vv_str;
2492 if (eap == NULL)
2493 {
2494 vim_free(oldval);
2495 vimvars[VV_CMDARG].vv_str = oldarg;
2496 return NULL;
2497 }
2498
2499 if (eap->force_bin == FORCE_BIN)
2500 len = 6;
2501 else if (eap->force_bin == FORCE_NOBIN)
2502 len = 8;
2503 else
2504 len = 0;
2505
2506 if (eap->read_edit)
2507 len += 7;
2508
2509 if (eap->force_ff != 0)
2510 len += 10; // " ++ff=unix"
2511 if (eap->force_enc != 0)
2512 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2513 if (eap->bad_char != 0)
2514 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2515
2516 newval = alloc(len + 1);
2517 if (newval == NULL)
2518 return NULL;
2519
2520 if (eap->force_bin == FORCE_BIN)
2521 sprintf((char *)newval, " ++bin");
2522 else if (eap->force_bin == FORCE_NOBIN)
2523 sprintf((char *)newval, " ++nobin");
2524 else
2525 *newval = NUL;
2526
2527 if (eap->read_edit)
2528 STRCAT(newval, " ++edit");
2529
2530 if (eap->force_ff != 0)
2531 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2532 eap->force_ff == 'u' ? "unix"
2533 : eap->force_ff == 'd' ? "dos"
2534 : "mac");
2535 if (eap->force_enc != 0)
2536 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2537 eap->cmd + eap->force_enc);
2538 if (eap->bad_char == BAD_KEEP)
2539 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2540 else if (eap->bad_char == BAD_DROP)
2541 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2542 else if (eap->bad_char != 0)
2543 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2544 vimvars[VV_CMDARG].vv_str = newval;
2545 return oldval;
2546}
2547
2548/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002549 * Get the value of internal variable "name".
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002550 * If "flags" has EVAL_VAR_IMPORT may return a VAR_ANY with v_number set to the
2551 * imported script ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002552 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2553 */
2554 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002555eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002556 char_u *name,
2557 int len, // length of "name"
2558 typval_T *rettv, // NULL when only checking existence
2559 dictitem_T **dip, // non-NULL when typval's dict item is needed
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002560 int flags) // EVAL_VAR_ flags
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002561{
2562 int ret = OK;
2563 typval_T *tv = NULL;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002564 int found = FALSE;
Bram Moolenaarf055d452021-07-08 20:57:24 +02002565 hashtab_T *ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002566 int cc;
Bram Moolenaarc967d572021-07-08 21:38:50 +02002567 type_T *type = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002568
2569 // truncate the name, so that we can use strcmp()
2570 cc = name[len];
2571 name[len] = NUL;
2572
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002573 // Check for local variable when debugging.
2574 if ((tv = lookup_debug_var(name)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002575 {
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002576 // Check for user-defined variables.
Bram Moolenaarc967d572021-07-08 21:38:50 +02002577 dictitem_T *v = find_var(name, &ht, flags & EVAL_VAR_NOAUTOLOAD);
2578
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002579 if (v != NULL)
2580 {
2581 tv = &v->di_tv;
2582 if (dip != NULL)
2583 *dip = v;
2584 }
Bram Moolenaarc967d572021-07-08 21:38:50 +02002585 else
2586 ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002587 }
2588
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002589 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002590 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002591 imported_T *import;
2592 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
2593
2594 import = find_imported(p, 0, NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002595
2596 // imported variable from another script
2597 if (import != NULL)
2598 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002599 if (import->imp_funcname != NULL)
2600 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002601 found = TRUE;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002602 if (rettv != NULL)
2603 {
2604 rettv->v_type = VAR_FUNC;
2605 rettv->vval.v_string = vim_strsave(import->imp_funcname);
2606 }
2607 }
Bram Moolenaara6294952020-12-27 13:39:50 +01002608 else if (import->imp_flags & IMP_FLAGS_STAR)
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002609 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002610 if ((flags & EVAL_VAR_IMPORT) == 0)
2611 {
2612 if (flags & EVAL_VAR_VERBOSE)
2613 emsg(_(e_import_as_name_not_supported_here));
2614 ret = FAIL;
2615 }
2616 else
2617 {
2618 if (rettv != NULL)
2619 {
2620 rettv->v_type = VAR_ANY;
2621 rettv->vval.v_number = import->imp_sid;
2622 }
2623 found = TRUE;
2624 }
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002625 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002626 else
2627 {
2628 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02002629 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002630 + import->imp_var_vals_idx;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002631 tv = sv->sv_tv;
Bram Moolenaarc967d572021-07-08 21:38:50 +02002632 type = sv->sv_type;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002633 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002634 }
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002635 else if (in_vim9script())
2636 {
2637 ufunc_T *ufunc = find_func(name, FALSE, NULL);
2638
2639 if (ufunc != NULL)
2640 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002641 found = TRUE;
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002642 if (rettv != NULL)
2643 {
2644 rettv->v_type = VAR_FUNC;
2645 rettv->vval.v_string = vim_strsave(ufunc->uf_name);
2646 }
2647 }
2648 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002649 }
2650
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002651 if (!found)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002652 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002653 if (tv == NULL)
2654 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002655 if (rettv != NULL && (flags & EVAL_VAR_VERBOSE))
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002656 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarc620c052020-07-08 15:16:19 +02002657 ret = FAIL;
2658 }
2659 else if (rettv != NULL)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002660 {
Bram Moolenaar11005b02021-07-11 20:59:00 +02002661 if (ht != NULL && ht == get_script_local_ht()
2662 && tv != &SCRIPT_SV(current_sctx.sc_sid)->sv_var.di_tv)
Bram Moolenaarf055d452021-07-08 20:57:24 +02002663 {
Bram Moolenaarc967d572021-07-08 21:38:50 +02002664 svar_T *sv = find_typval_in_script(tv);
Bram Moolenaarf055d452021-07-08 20:57:24 +02002665
Bram Moolenaarf055d452021-07-08 20:57:24 +02002666 if (sv != NULL)
2667 type = sv->sv_type;
2668 }
2669
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002670 // If a list or dict variable wasn't initialized, do it now.
2671 if (tv->v_type == VAR_DICT && tv->vval.v_dict == NULL)
2672 {
2673 tv->vval.v_dict = dict_alloc();
2674 if (tv->vval.v_dict != NULL)
Bram Moolenaarf055d452021-07-08 20:57:24 +02002675 {
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002676 ++tv->vval.v_dict->dv_refcount;
Bram Moolenaarf055d452021-07-08 20:57:24 +02002677 tv->vval.v_dict->dv_type = alloc_type(type);
2678 }
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002679 }
2680 else if (tv->v_type == VAR_LIST && tv->vval.v_list == NULL)
2681 {
2682 tv->vval.v_list = list_alloc();
2683 if (tv->vval.v_list != NULL)
Bram Moolenaarf055d452021-07-08 20:57:24 +02002684 {
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002685 ++tv->vval.v_list->lv_refcount;
Bram Moolenaarf055d452021-07-08 20:57:24 +02002686 tv->vval.v_list->lv_type = alloc_type(type);
2687 }
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002688 }
Bram Moolenaarb7c21af2021-04-18 14:12:31 +02002689 else if (tv->v_type == VAR_BLOB && tv->vval.v_blob == NULL)
2690 {
2691 tv->vval.v_blob = blob_alloc();
2692 if (tv->vval.v_blob != NULL)
2693 ++tv->vval.v_blob->bv_refcount;
2694 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002695 copy_tv(tv, rettv);
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002696 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002697 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002698
2699 name[len] = cc;
2700
2701 return ret;
2702}
2703
2704/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002705 * Check if variable "name[len]" is a local variable or an argument.
2706 * If so, "*eval_lavars_used" is set to TRUE.
2707 */
2708 void
2709check_vars(char_u *name, int len)
2710{
2711 int cc;
2712 char_u *varname;
2713 hashtab_T *ht;
2714
2715 if (eval_lavars_used == NULL)
2716 return;
2717
2718 // truncate the name, so that we can use strcmp()
2719 cc = name[len];
2720 name[len] = NUL;
2721
2722 ht = find_var_ht(name, &varname);
2723 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
2724 {
2725 if (find_var(name, NULL, TRUE) != NULL)
2726 *eval_lavars_used = TRUE;
2727 }
2728
2729 name[len] = cc;
2730}
2731
2732/*
2733 * Find variable "name" in the list of variables.
2734 * Return a pointer to it if found, NULL if not found.
2735 * Careful: "a:0" variables don't have a name.
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002736 * When "htp" is not NULL set "htp" to the hashtab_T used.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002737 */
2738 dictitem_T *
2739find_var(char_u *name, hashtab_T **htp, int no_autoload)
2740{
2741 char_u *varname;
2742 hashtab_T *ht;
2743 dictitem_T *ret = NULL;
2744
2745 ht = find_var_ht(name, &varname);
2746 if (htp != NULL)
2747 *htp = ht;
2748 if (ht == NULL)
2749 return NULL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002750 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002751 if (ret != NULL)
2752 return ret;
2753
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002754 // Search in parent scope for lambda
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002755 ret = find_var_in_scoped_ht(name, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01002756 if (ret != NULL)
2757 return ret;
2758
2759 // in Vim9 script items without a scope can be script-local
2760 if (in_vim9script() && name[0] != NUL && name[1] != ':')
2761 {
2762 ht = get_script_local_ht();
2763 if (ht != NULL)
2764 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002765 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01002766 if (ret != NULL)
2767 {
2768 if (htp != NULL)
2769 *htp = ht;
2770 return ret;
2771 }
2772 }
2773 }
2774
2775 return NULL;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002776}
2777
2778/*
2779 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02002780 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002781 * Returns NULL if not found.
2782 */
2783 dictitem_T *
2784find_var_in_ht(
2785 hashtab_T *ht,
2786 int htname,
2787 char_u *varname,
2788 int no_autoload)
2789{
2790 hashitem_T *hi;
2791
2792 if (*varname == NUL)
2793 {
2794 // Must be something like "s:", otherwise "ht" would be NULL.
2795 switch (htname)
2796 {
2797 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
2798 case 'g': return &globvars_var;
2799 case 'v': return &vimvars_var;
2800 case 'b': return &curbuf->b_bufvar;
2801 case 'w': return &curwin->w_winvar;
2802 case 't': return &curtab->tp_winvar;
2803 case 'l': return get_funccal_local_var();
2804 case 'a': return get_funccal_args_var();
2805 }
2806 return NULL;
2807 }
2808
2809 hi = hash_find(ht, varname);
2810 if (HASHITEM_EMPTY(hi))
2811 {
2812 // For global variables we may try auto-loading the script. If it
2813 // worked find the variable again. Don't auto-load a script if it was
2814 // loaded already, otherwise it would be loaded every time when
2815 // checking if a function name is a Funcref variable.
2816 if (ht == &globvarht && !no_autoload)
2817 {
2818 // Note: script_autoload() may make "hi" invalid. It must either
2819 // be obtained again or not used.
2820 if (!script_autoload(varname, FALSE) || aborting())
2821 return NULL;
2822 hi = hash_find(ht, varname);
2823 }
2824 if (HASHITEM_EMPTY(hi))
2825 return NULL;
2826 }
2827 return HI2DI(hi);
2828}
2829
2830/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002831 * Get the script-local hashtab. NULL if not in a script context.
2832 */
Bram Moolenaar922acbd2020-10-08 21:30:40 +02002833 hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002834get_script_local_ht(void)
2835{
2836 scid_T sid = current_sctx.sc_sid;
2837
Bram Moolenaare3d46852020-08-29 13:39:17 +02002838 if (SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002839 return &SCRIPT_VARS(sid);
2840 return NULL;
2841}
2842
2843/*
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002844 * Look for "name[len]" in script-local variables and functions.
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002845 * When "cmd" is TRUE it must look like a command, a function must be followed
2846 * by "(" or "->".
Bram Moolenaar709664c2020-12-12 14:33:41 +01002847 * Return OK when found, FAIL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002848 */
Bram Moolenaar709664c2020-12-12 14:33:41 +01002849 int
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002850lookup_scriptitem(
Bram Moolenaar709664c2020-12-12 14:33:41 +01002851 char_u *name,
2852 size_t len,
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002853 int cmd,
Bram Moolenaar709664c2020-12-12 14:33:41 +01002854 cctx_T *dummy UNUSED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002855{
2856 hashtab_T *ht = get_script_local_ht();
2857 char_u buffer[30];
2858 char_u *p;
Bram Moolenaar709664c2020-12-12 14:33:41 +01002859 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002860 hashitem_T *hi;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002861 int is_global = FALSE;
2862 char_u *fname = name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002863
2864 if (ht == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01002865 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002866 if (len < sizeof(buffer) - 1)
2867 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02002868 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002869 vim_strncpy(buffer, name, len);
2870 p = buffer;
2871 }
2872 else
2873 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002874 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002875 if (p == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01002876 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002877 }
2878
2879 hi = hash_find(ht, p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01002880 res = HASHITEM_EMPTY(hi) ? FAIL : OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002881
2882 // if not script-local, then perhaps imported
Bram Moolenaar709664c2020-12-12 14:33:41 +01002883 if (res == FAIL && find_imported(p, 0, NULL) != NULL)
2884 res = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002885 if (p != buffer)
2886 vim_free(p);
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002887
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002888 // Find a function, so that a following "->" works.
2889 // When used as a command require "(" or "->" to follow, "Cmd" is a user
2890 // command while "Cmd()" is a function call.
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002891 if (res != OK)
2892 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002893 p = skipwhite(name + len);
2894
2895 if (!cmd || name[len] == '(' || (p[0] == '-' && p[1] == '>'))
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002896 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002897 // Do not check for an internal function, since it might also be a
2898 // valid command, such as ":split" versus "split()".
2899 // Skip "g:" before a function name.
2900 if (name[0] == 'g' && name[1] == ':')
2901 {
2902 is_global = TRUE;
2903 fname = name + 2;
2904 }
2905 if (find_func(fname, is_global, NULL) != NULL)
2906 res = OK;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002907 }
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002908 }
2909
Bram Moolenaar709664c2020-12-12 14:33:41 +01002910 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002911}
2912
2913/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002914 * Find the hashtab used for a variable name.
2915 * Return NULL if the name is not valid.
2916 * Set "varname" to the start of name without ':'.
2917 */
2918 hashtab_T *
2919find_var_ht(char_u *name, char_u **varname)
2920{
2921 hashitem_T *hi;
2922 hashtab_T *ht;
2923
2924 if (name[0] == NUL)
2925 return NULL;
2926 if (name[1] != ':')
2927 {
2928 // The name must not start with a colon or #.
2929 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
2930 return NULL;
2931 *varname = name;
2932
2933 // "version" is "v:version" in all scopes if scriptversion < 3.
2934 // Same for a few other variables marked with VV_COMPAT.
Bram Moolenaardd9de502021-08-15 13:49:42 +02002935 if (in_old_script(3))
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002936 {
2937 hi = hash_find(&compat_hashtab, name);
2938 if (!HASHITEM_EMPTY(hi))
2939 return &compat_hashtab;
2940 }
2941
2942 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002943 if (ht != NULL)
2944 return ht; // local variable
2945
Bram Moolenaarf0a40692021-06-11 22:05:47 +02002946 // In Vim9 script items at the script level are script-local, except
2947 // for autoload names.
2948 if (in_vim9script() && vim_strchr(name, AUTOLOAD_CHAR) == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002949 {
2950 ht = get_script_local_ht();
2951 if (ht != NULL)
2952 return ht;
2953 }
2954
2955 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002956 }
2957 *varname = name + 2;
2958 if (*name == 'g') // global variable
2959 return &globvarht;
2960 // There must be no ':' or '#' in the rest of the name, unless g: is used
2961 if (vim_strchr(name + 2, ':') != NULL
2962 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
2963 return NULL;
2964 if (*name == 'b') // buffer variable
2965 return &curbuf->b_vars->dv_hashtab;
2966 if (*name == 'w') // window variable
2967 return &curwin->w_vars->dv_hashtab;
2968 if (*name == 't') // tab page variable
2969 return &curtab->tp_vars->dv_hashtab;
2970 if (*name == 'v') // v: variable
2971 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002972 if (get_current_funccal() != NULL
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002973 && get_current_funccal()->func->uf_def_status == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002974 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002975 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002976 if (*name == 'a') // a: function argument
2977 return get_funccal_args_ht();
2978 if (*name == 'l') // l: local function variable
2979 return get_funccal_local_ht();
2980 }
2981 if (*name == 's') // script variable
2982 {
2983 ht = get_script_local_ht();
2984 if (ht != NULL)
2985 return ht;
2986 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002987 return NULL;
2988}
2989
2990/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002991 * Get the string value of a (global/local) variable.
2992 * Note: see tv_get_string() for how long the pointer remains valid.
2993 * Returns NULL when it doesn't exist.
2994 */
2995 char_u *
2996get_var_value(char_u *name)
2997{
2998 dictitem_T *v;
2999
3000 v = find_var(name, NULL, FALSE);
3001 if (v == NULL)
3002 return NULL;
3003 return tv_get_string(&v->di_tv);
3004}
3005
3006/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003007 * Allocate a new hashtab for a sourced script. It will be used while
3008 * sourcing this script and when executing functions defined in the script.
3009 */
3010 void
3011new_script_vars(scid_T id)
3012{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003013 scriptvar_T *sv;
3014
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01003015 sv = ALLOC_CLEAR_ONE(scriptvar_T);
3016 if (sv == NULL)
3017 return;
3018 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01003019 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003020}
3021
3022/*
3023 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
3024 * point to it.
3025 */
3026 void
3027init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
3028{
3029 hash_init(&dict->dv_hashtab);
3030 dict->dv_lock = 0;
3031 dict->dv_scope = scope;
3032 dict->dv_refcount = DO_NOT_FREE_CNT;
3033 dict->dv_copyID = 0;
3034 dict_var->di_tv.vval.v_dict = dict;
3035 dict_var->di_tv.v_type = VAR_DICT;
3036 dict_var->di_tv.v_lock = VAR_FIXED;
3037 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
3038 dict_var->di_key[0] = NUL;
3039}
3040
3041/*
3042 * Unreference a dictionary initialized by init_var_dict().
3043 */
3044 void
3045unref_var_dict(dict_T *dict)
3046{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003047 // Now the dict needs to be freed if no one else is using it, go back to
3048 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003049 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
3050 dict_unref(dict);
3051}
3052
3053/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003054 * Clean up a list of internal variables.
3055 * Frees all allocated variables and the value they contain.
3056 * Clears hashtab "ht", does not free it.
3057 */
3058 void
3059vars_clear(hashtab_T *ht)
3060{
3061 vars_clear_ext(ht, TRUE);
3062}
3063
3064/*
3065 * Like vars_clear(), but only free the value if "free_val" is TRUE.
3066 */
3067 void
3068vars_clear_ext(hashtab_T *ht, int free_val)
3069{
3070 int todo;
3071 hashitem_T *hi;
3072 dictitem_T *v;
3073
3074 hash_lock(ht);
3075 todo = (int)ht->ht_used;
3076 for (hi = ht->ht_array; todo > 0; ++hi)
3077 {
3078 if (!HASHITEM_EMPTY(hi))
3079 {
3080 --todo;
3081
3082 // Free the variable. Don't remove it from the hashtab,
3083 // ht_array might change then. hash_clear() takes care of it
3084 // later.
3085 v = HI2DI(hi);
3086 if (free_val)
3087 clear_tv(&v->di_tv);
3088 if (v->di_flags & DI_FLAGS_ALLOC)
3089 vim_free(v);
3090 }
3091 }
3092 hash_clear(ht);
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003093 hash_init(ht);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003094}
3095
3096/*
3097 * Delete a variable from hashtab "ht" at item "hi".
3098 * Clear the variable value and free the dictitem.
3099 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02003100 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003101delete_var(hashtab_T *ht, hashitem_T *hi)
3102{
3103 dictitem_T *di = HI2DI(hi);
3104
3105 hash_remove(ht, hi);
3106 clear_tv(&di->di_tv);
3107 vim_free(di);
3108}
3109
3110/*
3111 * List the value of one internal variable.
3112 */
3113 static void
3114list_one_var(dictitem_T *v, char *prefix, int *first)
3115{
3116 char_u *tofree;
3117 char_u *s;
3118 char_u numbuf[NUMBUFLEN];
3119
3120 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
3121 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
3122 s == NULL ? (char_u *)"" : s, first);
3123 vim_free(tofree);
3124}
3125
3126 static void
3127list_one_var_a(
3128 char *prefix,
3129 char_u *name,
3130 int type,
3131 char_u *string,
3132 int *first) // when TRUE clear rest of screen and set to FALSE
3133{
3134 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
3135 msg_start();
3136 msg_puts(prefix);
3137 if (name != NULL) // "a:" vars don't have a name stored
3138 msg_puts((char *)name);
3139 msg_putchar(' ');
3140 msg_advance(22);
3141 if (type == VAR_NUMBER)
3142 msg_putchar('#');
3143 else if (type == VAR_FUNC || type == VAR_PARTIAL)
3144 msg_putchar('*');
3145 else if (type == VAR_LIST)
3146 {
3147 msg_putchar('[');
3148 if (*string == '[')
3149 ++string;
3150 }
3151 else if (type == VAR_DICT)
3152 {
3153 msg_putchar('{');
3154 if (*string == '{')
3155 ++string;
3156 }
3157 else
3158 msg_putchar(' ');
3159
3160 msg_outtrans(string);
3161
3162 if (type == VAR_FUNC || type == VAR_PARTIAL)
3163 msg_puts("()");
3164 if (*first)
3165 {
3166 msg_clr_eos();
3167 *first = FALSE;
3168 }
3169}
3170
3171/*
3172 * Set variable "name" to value in "tv".
3173 * If the variable already exists, the value is updated.
3174 * Otherwise the variable is created.
3175 */
3176 void
3177set_var(
3178 char_u *name,
3179 typval_T *tv,
3180 int copy) // make copy of value in "tv"
3181{
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003182 set_var_const(name, NULL, tv, copy, ASSIGN_DECL, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003183}
3184
3185/*
3186 * Set variable "name" to value in "tv".
3187 * If the variable already exists and "is_const" is FALSE the value is updated.
3188 * Otherwise the variable is created.
3189 */
3190 void
3191set_var_const(
3192 char_u *name,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003193 type_T *type,
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003194 typval_T *tv_arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003195 int copy, // make copy of value in "tv"
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003196 int flags_arg, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003197 int var_idx) // index for ":let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003198{
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003199 typval_T *tv = tv_arg;
3200 typval_T bool_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003201 dictitem_T *di;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003202 typval_T *dest_tv = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003203 char_u *varname;
3204 hashtab_T *ht;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003205 int is_script_local;
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003206 int vim9script = in_vim9script();
Bram Moolenaare535db82021-03-31 21:07:24 +02003207 int var_in_vim9script;
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003208 int flags = flags_arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003209
3210 ht = find_var_ht(name, &varname);
3211 if (ht == NULL || *varname == NUL)
3212 {
3213 semsg(_(e_illvar), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003214 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003215 }
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003216 is_script_local = ht == get_script_local_ht();
3217
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003218 if (vim9script
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003219 && !is_script_local
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003220 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003221 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003222 && name[1] == ':')
Bram Moolenaar67979662020-06-20 22:50:47 +02003223 {
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003224 vim9_declare_error(name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003225 goto failed;
Bram Moolenaar67979662020-06-20 22:50:47 +02003226 }
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003227 if ((flags & ASSIGN_FOR_LOOP) && name[1] == ':'
3228 && vim_strchr((char_u *)"gwbt", name[0]) != NULL)
3229 // Do not make g:var, w:var, b:var or t:var final.
3230 flags &= ~ASSIGN_FINAL;
3231
Bram Moolenaare535db82021-03-31 21:07:24 +02003232 var_in_vim9script = is_script_local && current_script_is_vim9();
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003233 if (var_in_vim9script && name[0] == '_' && name[1] == NUL)
3234 {
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02003235 // For "[a, _] = list" the underscore is ignored.
3236 if ((flags & ASSIGN_UNPACK) == 0)
3237 emsg(_(e_cannot_use_underscore_here));
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003238 goto failed;
3239 }
Bram Moolenaar67979662020-06-20 22:50:47 +02003240
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003241 di = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003242
Bram Moolenaar24e93162021-07-18 20:40:33 +02003243 if (di == NULL && var_in_vim9script)
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003244 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003245 imported_T *import = find_imported(varname, 0, NULL);
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003246
Bram Moolenaar24e93162021-07-18 20:40:33 +02003247 if (import != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003248 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003249 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
3250 svar_T *sv;
Bram Moolenaar2b59df02021-07-22 15:14:25 +02003251 where_T where = WHERE_INIT;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003252
3253 // imported variable from another script
3254 if ((flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003255 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003256 semsg(_(e_redefining_imported_item_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003257 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003258 }
Bram Moolenaar60579352021-07-19 21:45:07 +02003259 sv = ((svar_T *)si->sn_var_vals.ga_data) + import->imp_var_vals_idx;
3260
Bram Moolenaar60579352021-07-19 21:45:07 +02003261 where.wt_variable = TRUE;
3262 if (check_typval_type(sv->sv_type, tv, where) == FAIL
3263 || value_check_lock(sv->sv_tv->v_lock, name, FALSE))
3264 {
3265 goto failed;
3266 }
3267
Bram Moolenaar24e93162021-07-18 20:40:33 +02003268 dest_tv = sv->sv_tv;
Bram Moolenaarf6488542021-07-18 21:24:50 +02003269 clear_tv(dest_tv);
Bram Moolenaar24e93162021-07-18 20:40:33 +02003270 }
3271 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003272
Bram Moolenaar24e93162021-07-18 20:40:33 +02003273 if (dest_tv == NULL)
3274 {
3275 // Search in parent scope which is possible to reference from lambda
3276 if (di == NULL)
3277 di = find_var_in_scoped_ht(name, TRUE);
3278
3279 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
Bram Moolenaarf6488542021-07-18 21:24:50 +02003280 && var_wrong_func_name(name, di == NULL))
Bram Moolenaar24e93162021-07-18 20:40:33 +02003281 goto failed;
3282
3283 if (need_convert_to_bool(type, tv))
3284 {
Bram Moolenaarf6488542021-07-18 21:24:50 +02003285 // Destination is a bool and the value is not, but it can be
3286 // converted.
Bram Moolenaar24e93162021-07-18 20:40:33 +02003287 CLEAR_FIELD(bool_tv);
3288 bool_tv.v_type = VAR_BOOL;
3289 bool_tv.vval.v_number = tv2bool(tv) ? VVAL_TRUE : VVAL_FALSE;
3290 tv = &bool_tv;
3291 }
3292
3293 if (di != NULL)
3294 {
3295 // Item already exists. Allowed to replace when reloading.
3296 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
3297 {
3298 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaarf6488542021-07-18 21:24:50 +02003299 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003300 {
3301 emsg(_(e_cannot_mod));
3302 goto failed;
3303 }
3304
3305 if (is_script_local && vim9script
Bram Moolenaarf6488542021-07-18 21:24:50 +02003306 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003307 {
3308 semsg(_(e_redefining_script_item_str), name);
3309 goto failed;
3310 }
3311
3312 if (var_in_vim9script)
3313 {
Bram Moolenaar2b59df02021-07-22 15:14:25 +02003314 where_T where = WHERE_INIT;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003315
3316 // check the type and adjust to bool if needed
3317 where.wt_index = var_idx;
3318 where.wt_variable = TRUE;
Bram Moolenaarf6488542021-07-18 21:24:50 +02003319 if (check_script_var_type(&di->di_tv, tv, name, where)
3320 == FAIL)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003321 goto failed;
3322 }
3323
3324 if (var_check_permission(di, name) == FAIL)
3325 goto failed;
3326 }
3327 else
3328 {
3329 // can only redefine once
3330 di->di_flags &= ~DI_FLAGS_RELOAD;
3331
Bram Moolenaarf6488542021-07-18 21:24:50 +02003332 // A Vim9 script-local variable is also present in sn_all_vars
3333 // and sn_var_vals. It may set "type" from "tv".
Bram Moolenaar24e93162021-07-18 20:40:33 +02003334 if (var_in_vim9script)
3335 update_vim9_script_var(FALSE, di, flags, tv, &type,
Bram Moolenaarf6488542021-07-18 21:24:50 +02003336 (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar24e93162021-07-18 20:40:33 +02003337 }
3338
3339 // existing variable, need to clear the value
3340
3341 // Handle setting internal di: variables separately where needed to
3342 // prevent changing the type.
3343 if (ht == &vimvarht)
3344 {
3345 if (di->di_tv.v_type == VAR_STRING)
3346 {
3347 VIM_CLEAR(di->di_tv.vval.v_string);
3348 if (copy || tv->v_type != VAR_STRING)
3349 {
3350 char_u *val = tv_get_string(tv);
3351
Bram Moolenaarf6488542021-07-18 21:24:50 +02003352 // Careful: when assigning to v:errmsg and
3353 // tv_get_string() causes an error message the variable
3354 // will already be set.
Bram Moolenaar24e93162021-07-18 20:40:33 +02003355 if (di->di_tv.vval.v_string == NULL)
3356 di->di_tv.vval.v_string = vim_strsave(val);
3357 }
3358 else
3359 {
3360 // Take over the string to avoid an extra alloc/free.
3361 di->di_tv.vval.v_string = tv->vval.v_string;
3362 tv->vval.v_string = NULL;
3363 }
3364 goto failed;
3365 }
3366 else if (di->di_tv.v_type == VAR_NUMBER)
3367 {
3368 di->di_tv.vval.v_number = tv_get_number(tv);
3369 if (STRCMP(varname, "searchforward") == 0)
Bram Moolenaarf6488542021-07-18 21:24:50 +02003370 set_search_direction(di->di_tv.vval.v_number
3371 ? '/' : '?');
Bram Moolenaar24e93162021-07-18 20:40:33 +02003372#ifdef FEAT_SEARCH_EXTRA
3373 else if (STRCMP(varname, "hlsearch") == 0)
3374 {
3375 no_hlsearch = !di->di_tv.vval.v_number;
3376 redraw_all_later(SOME_VALID);
3377 }
3378#endif
3379 goto failed;
3380 }
3381 else if (di->di_tv.v_type != tv->v_type)
3382 {
3383 semsg(_("E963: setting %s to value with wrong type"), name);
3384 goto failed;
3385 }
3386 }
3387
3388 clear_tv(&di->di_tv);
3389 }
3390 else
3391 {
3392 // Item not found, check if a function already exists.
3393 if (is_script_local && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaarf6488542021-07-18 21:24:50 +02003394 && lookup_scriptitem(name, STRLEN(name), FALSE, NULL) == OK)
Bram Moolenaar12be7342021-03-31 21:47:33 +02003395 {
3396 semsg(_(e_redefining_script_item_str), name);
3397 goto failed;
3398 }
3399
Bram Moolenaar24e93162021-07-18 20:40:33 +02003400 // add a new variable
3401 if (var_in_vim9script && (flags & ASSIGN_NO_DECL))
3402 {
3403 semsg(_(e_unknown_variable_str), name);
3404 goto failed;
3405 }
3406
3407 // Can't add "v:" or "a:" variable.
3408 if (ht == &vimvarht || ht == get_funccal_args_ht())
3409 {
3410 semsg(_(e_illvar), name);
3411 goto failed;
3412 }
3413
3414 // Make sure the variable name is valid. In Vim9 script an autoload
3415 // variable must be prefixed with "g:".
3416 if (!valid_varname(varname, !vim9script
Bram Moolenaarf6488542021-07-18 21:24:50 +02003417 || STRNCMP(name, "g:", 2) == 0))
Bram Moolenaar24e93162021-07-18 20:40:33 +02003418 goto failed;
3419
3420 di = alloc(sizeof(dictitem_T) + STRLEN(varname));
3421 if (di == NULL)
3422 goto failed;
3423 STRCPY(di->di_key, varname);
3424 if (hash_add(ht, DI2HIKEY(di)) == FAIL)
3425 {
3426 vim_free(di);
3427 goto failed;
3428 }
3429 di->di_flags = DI_FLAGS_ALLOC;
3430 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
3431 di->di_flags |= DI_FLAGS_LOCK;
3432
3433 // A Vim9 script-local variable is also added to sn_all_vars and
3434 // sn_var_vals. It may set "type" from "tv".
Bram Moolenaare535db82021-03-31 21:07:24 +02003435 if (var_in_vim9script)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003436 update_vim9_script_var(TRUE, di, flags, tv, &type,
Bram Moolenaarf6488542021-07-18 21:24:50 +02003437 (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003438 }
3439
Bram Moolenaar24e93162021-07-18 20:40:33 +02003440 dest_tv = &di->di_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003441 }
3442
3443 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003444 copy_tv(tv, dest_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003445 else
3446 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003447 *dest_tv = *tv;
3448 dest_tv->v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003449 init_tv(tv);
3450 }
3451
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003452 if (vim9script && type != NULL)
3453 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003454 if (type->tt_type == VAR_DICT && dest_tv->vval.v_dict != NULL)
3455 dest_tv->vval.v_dict->dv_type = alloc_type(type);
3456 else if (type->tt_type == VAR_LIST && dest_tv->vval.v_list != NULL)
3457 dest_tv->vval.v_list->lv_type = alloc_type(type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003458 }
3459
Bram Moolenaar1dcf55d2020-12-22 22:07:30 +01003460 // ":const var = value" locks the value
3461 // ":final var = value" locks "var"
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003462 if (flags & ASSIGN_CONST)
Bram Moolenaar021bda52020-08-17 21:07:22 +02003463 // Like :lockvar! name: lock the value and what it contains, but only
3464 // if the reference count is up to one. That locks only literal
3465 // values.
Bram Moolenaar24e93162021-07-18 20:40:33 +02003466 item_lock(dest_tv, DICT_MAXNEST, TRUE, TRUE);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003467 return;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003468
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003469failed:
3470 if (!copy)
3471 clear_tv(tv_arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003472}
3473
3474/*
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003475 * Check in this order for backwards compatibility:
3476 * - Whether the variable is read-only
3477 * - Whether the variable value is locked
3478 * - Whether the variable is locked
3479 */
3480 int
3481var_check_permission(dictitem_T *di, char_u *name)
3482{
3483 if (var_check_ro(di->di_flags, name, FALSE)
3484 || value_check_lock(di->di_tv.v_lock, name, FALSE)
3485 || var_check_lock(di->di_flags, name, FALSE))
3486 return FAIL;
3487 return OK;
3488}
3489
3490/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003491 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
3492 * Also give an error message.
3493 */
3494 int
3495var_check_ro(int flags, char_u *name, int use_gettext)
3496{
3497 if (flags & DI_FLAGS_RO)
3498 {
Bram Moolenaard8e44472021-07-21 22:20:33 +02003499 semsg(_(e_cannot_change_readonly_variable_str),
3500 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003501 return TRUE;
3502 }
3503 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
3504 {
3505 semsg(_(e_readonlysbx), use_gettext ? (char_u *)_(name) : name);
3506 return TRUE;
3507 }
3508 return FALSE;
3509}
3510
3511/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003512 * Return TRUE if di_flags "flags" indicates variable "name" is locked.
3513 * Also give an error message.
3514 */
3515 int
3516var_check_lock(int flags, char_u *name, int use_gettext)
3517{
3518 if (flags & DI_FLAGS_LOCK)
3519 {
3520 semsg(_(e_variable_is_locked_str),
3521 use_gettext ? (char_u *)_(name) : name);
3522 return TRUE;
3523 }
3524 return FALSE;
3525}
3526
3527/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003528 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
3529 * Also give an error message.
3530 */
3531 int
3532var_check_fixed(int flags, char_u *name, int use_gettext)
3533{
3534 if (flags & DI_FLAGS_FIX)
3535 {
3536 semsg(_("E795: Cannot delete variable %s"),
3537 use_gettext ? (char_u *)_(name) : name);
3538 return TRUE;
3539 }
3540 return FALSE;
3541}
3542
3543/*
3544 * Check if a funcref is assigned to a valid variable name.
3545 * Return TRUE and give an error if not.
3546 */
3547 int
Bram Moolenaar98b4f142020-08-08 15:46:01 +02003548var_wrong_func_name(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003549 char_u *name, // points to start of variable name
3550 int new_var) // TRUE when creating the variable
3551{
Bram Moolenaar32154662021-03-28 21:14:06 +02003552 // Allow for w: b: s: and t:. In Vim9 script s: is not allowed, because
3553 // the name can be used without the s: prefix.
3554 if (!((vim_strchr((char_u *)"wbt", name[0]) != NULL
3555 || (!in_vim9script() && name[0] == 's')) && name[1] == ':')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003556 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
3557 ? name[2] : name[0]))
3558 {
3559 semsg(_("E704: Funcref variable name must start with a capital: %s"),
3560 name);
3561 return TRUE;
3562 }
3563 // Don't allow hiding a function. When "v" is not NULL we might be
3564 // assigning another function to the same var, the type is checked
3565 // below.
3566 if (new_var && function_exists(name, FALSE))
3567 {
3568 semsg(_("E705: Variable name conflicts with existing function: %s"),
3569 name);
3570 return TRUE;
3571 }
3572 return FALSE;
3573}
3574
3575/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003576 * Return TRUE if "flags" indicates variable "name" has a locked (immutable)
3577 * value. Also give an error message, using "name" or _("name") when
3578 * "use_gettext" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003579 */
3580 int
Bram Moolenaara187c432020-09-16 21:08:28 +02003581value_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003582{
3583 if (lock & VAR_LOCKED)
3584 {
3585 semsg(_("E741: Value is locked: %s"),
3586 name == NULL ? (char_u *)_("Unknown")
3587 : use_gettext ? (char_u *)_(name)
3588 : name);
3589 return TRUE;
3590 }
3591 if (lock & VAR_FIXED)
3592 {
3593 semsg(_("E742: Cannot change value of %s"),
3594 name == NULL ? (char_u *)_("Unknown")
3595 : use_gettext ? (char_u *)_(name)
3596 : name);
3597 return TRUE;
3598 }
3599 return FALSE;
3600}
3601
3602/*
Bram Moolenaar03290b82020-12-19 16:30:44 +01003603 * Check if a variable name is valid. When "autoload" is true "#" is allowed.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003604 * Return FALSE and give an error if not.
3605 */
3606 int
Bram Moolenaar03290b82020-12-19 16:30:44 +01003607valid_varname(char_u *varname, int autoload)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003608{
3609 char_u *p;
3610
3611 for (p = varname; *p != NUL; ++p)
3612 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
Bram Moolenaar03290b82020-12-19 16:30:44 +01003613 && !(autoload && *p == AUTOLOAD_CHAR))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003614 {
3615 semsg(_(e_illvar), varname);
3616 return FALSE;
3617 }
3618 return TRUE;
3619}
3620
3621/*
3622 * getwinvar() and gettabwinvar()
3623 */
3624 static void
3625getwinvar(
3626 typval_T *argvars,
3627 typval_T *rettv,
3628 int off) // 1 for gettabwinvar()
3629{
3630 win_T *win;
3631 char_u *varname;
3632 dictitem_T *v;
3633 tabpage_T *tp = NULL;
3634 int done = FALSE;
3635 win_T *oldcurwin;
3636 tabpage_T *oldtabpage;
3637 int need_switch_win;
3638
3639 if (off == 1)
3640 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3641 else
3642 tp = curtab;
3643 win = find_win_by_nr(&argvars[off], tp);
3644 varname = tv_get_string_chk(&argvars[off + 1]);
3645 ++emsg_off;
3646
3647 rettv->v_type = VAR_STRING;
3648 rettv->vval.v_string = NULL;
3649
3650 if (win != NULL && varname != NULL)
3651 {
3652 // Set curwin to be our win, temporarily. Also set the tabpage,
3653 // otherwise the window is not valid. Only do this when needed,
3654 // autocommands get blocked.
3655 need_switch_win = !(tp == curtab && win == curwin);
3656 if (!need_switch_win
3657 || switch_win(&oldcurwin, &oldtabpage, win, tp, TRUE) == OK)
3658 {
3659 if (*varname == '&')
3660 {
3661 if (varname[1] == NUL)
3662 {
3663 // get all window-local options in a dict
3664 dict_T *opts = get_winbuf_options(FALSE);
3665
3666 if (opts != NULL)
3667 {
3668 rettv_dict_set(rettv, opts);
3669 done = TRUE;
3670 }
3671 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003672 else if (eval_option(&varname, rettv, 1) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003673 // window-local-option
3674 done = TRUE;
3675 }
3676 else
3677 {
3678 // Look up the variable.
3679 // Let getwinvar({nr}, "") return the "w:" dictionary.
3680 v = find_var_in_ht(&win->w_vars->dv_hashtab, 'w',
3681 varname, FALSE);
3682 if (v != NULL)
3683 {
3684 copy_tv(&v->di_tv, rettv);
3685 done = TRUE;
3686 }
3687 }
3688 }
3689
3690 if (need_switch_win)
3691 // restore previous notion of curwin
3692 restore_win(oldcurwin, oldtabpage, TRUE);
3693 }
3694
3695 if (!done && argvars[off + 2].v_type != VAR_UNKNOWN)
3696 // use the default return value
3697 copy_tv(&argvars[off + 2], rettv);
3698
3699 --emsg_off;
3700}
3701
3702/*
Bram Moolenaar191929b2020-08-19 21:20:49 +02003703 * Set option "varname" to the value of "varp" for the current buffer/window.
3704 */
3705 static void
3706set_option_from_tv(char_u *varname, typval_T *varp)
3707{
3708 long numval = 0;
3709 char_u *strval;
3710 char_u nbuf[NUMBUFLEN];
3711 int error = FALSE;
3712
Bram Moolenaar31a201a2021-01-03 14:47:25 +01003713 if (varp->v_type == VAR_BOOL)
Bram Moolenaarb0d81822021-01-03 15:55:10 +01003714 {
Bram Moolenaar31a201a2021-01-03 14:47:25 +01003715 numval = (long)varp->vval.v_number;
Bram Moolenaarb0d81822021-01-03 15:55:10 +01003716 strval = (char_u *)"0"; // avoid using "false"
3717 }
3718 else
3719 {
3720 if (!in_vim9script() || varp->v_type != VAR_STRING)
3721 numval = (long)tv_get_number_chk(varp, &error);
3722 strval = tv_get_string_buf_chk(varp, nbuf);
3723 }
Bram Moolenaar191929b2020-08-19 21:20:49 +02003724 if (!error && strval != NULL)
3725 set_option_value(varname, numval, strval, OPT_LOCAL);
3726}
3727
3728/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003729 * "setwinvar()" and "settabwinvar()" functions
3730 */
3731 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003732setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003733{
3734 win_T *win;
3735 win_T *save_curwin;
3736 tabpage_T *save_curtab;
3737 int need_switch_win;
3738 char_u *varname, *winvarname;
3739 typval_T *varp;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003740 tabpage_T *tp = NULL;
3741
3742 if (check_secure())
3743 return;
3744
3745 if (off == 1)
3746 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3747 else
3748 tp = curtab;
3749 win = find_win_by_nr(&argvars[off], tp);
3750 varname = tv_get_string_chk(&argvars[off + 1]);
3751 varp = &argvars[off + 2];
3752
3753 if (win != NULL && varname != NULL && varp != NULL)
3754 {
3755 need_switch_win = !(tp == curtab && win == curwin);
3756 if (!need_switch_win
3757 || switch_win(&save_curwin, &save_curtab, win, tp, TRUE) == OK)
3758 {
3759 if (*varname == '&')
Bram Moolenaar191929b2020-08-19 21:20:49 +02003760 set_option_from_tv(varname + 1, varp);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003761 else
3762 {
3763 winvarname = alloc(STRLEN(varname) + 3);
3764 if (winvarname != NULL)
3765 {
3766 STRCPY(winvarname, "w:");
3767 STRCPY(winvarname + 2, varname);
3768 set_var(winvarname, varp, TRUE);
3769 vim_free(winvarname);
3770 }
3771 }
3772 }
3773 if (need_switch_win)
3774 restore_win(save_curwin, save_curtab, TRUE);
3775 }
3776}
3777
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003778/*
3779 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
3780 * v:option_type, and v:option_command.
3781 */
3782 void
3783reset_v_option_vars(void)
3784{
3785 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
3786 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
3787 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
3788 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
3789 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
3790 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
3791}
3792
3793/*
3794 * Add an assert error to v:errors.
3795 */
3796 void
3797assert_error(garray_T *gap)
3798{
3799 struct vimvar *vp = &vimvars[VV_ERRORS];
3800
3801 if (vp->vv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003802 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003803 set_vim_var_list(VV_ERRORS, list_alloc());
3804 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
3805}
3806
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003807 int
3808var_exists(char_u *var)
3809{
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003810 char_u *arg = var;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003811 char_u *name;
3812 char_u *tofree;
3813 typval_T tv;
3814 int len = 0;
3815 int n = FALSE;
3816
3817 // get_name_len() takes care of expanding curly braces
3818 name = var;
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003819 len = get_name_len(&arg, &tofree, TRUE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003820 if (len > 0)
3821 {
3822 if (tofree != NULL)
3823 name = tofree;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003824 n = (eval_variable(name, len, &tv, NULL,
3825 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003826 if (n)
3827 {
3828 // handle d.key, l[idx], f(expr)
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003829 arg = skipwhite(arg);
3830 n = (handle_subscript(&arg, &tv, &EVALARG_EVALUATE, FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003831 if (n)
3832 clear_tv(&tv);
3833 }
3834 }
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003835 if (*arg != NUL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003836 n = FALSE;
3837
3838 vim_free(tofree);
3839 return n;
3840}
3841
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003842static lval_T *redir_lval = NULL;
3843#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
3844static garray_T redir_ga; // only valid when redir_lval is not NULL
3845static char_u *redir_endp = NULL;
3846static char_u *redir_varname = NULL;
3847
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003848 int
3849alloc_redir_lval(void)
3850{
3851 redir_lval = ALLOC_CLEAR_ONE(lval_T);
3852 if (redir_lval == NULL)
3853 return FAIL;
3854 return OK;
3855}
3856
3857 void
3858clear_redir_lval(void)
3859{
3860 VIM_CLEAR(redir_lval);
3861}
3862
3863 void
3864init_redir_ga(void)
3865{
3866 ga_init2(&redir_ga, (int)sizeof(char), 500);
3867}
3868
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003869/*
3870 * Start recording command output to a variable
3871 * When "append" is TRUE append to an existing variable.
3872 * Returns OK if successfully completed the setup. FAIL otherwise.
3873 */
3874 int
3875var_redir_start(char_u *name, int append)
3876{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003877 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003878 typval_T tv;
3879
3880 // Catch a bad name early.
3881 if (!eval_isnamec1(*name))
3882 {
3883 emsg(_(e_invarg));
3884 return FAIL;
3885 }
3886
3887 // Make a copy of the name, it is used in redir_lval until redir ends.
3888 redir_varname = vim_strsave(name);
3889 if (redir_varname == NULL)
3890 return FAIL;
3891
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003892 if (alloc_redir_lval() == FAIL)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003893 {
3894 var_redir_stop();
3895 return FAIL;
3896 }
3897
3898 // The output is stored in growarray "redir_ga" until redirection ends.
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003899 init_redir_ga();
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003900
3901 // Parse the variable name (can be a dict or list entry).
3902 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
3903 FNE_CHECK_START);
3904 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
3905 {
3906 clear_lval(redir_lval);
3907 if (redir_endp != NULL && *redir_endp != NUL)
3908 // Trailing characters are present after the variable name
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003909 semsg(_(e_trailing_arg), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003910 else
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003911 semsg(_(e_invarg2), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003912 redir_endp = NULL; // don't store a value, only cleanup
3913 var_redir_stop();
3914 return FAIL;
3915 }
3916
3917 // check if we can write to the variable: set it to or append an empty
3918 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003919 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003920 tv.v_type = VAR_STRING;
3921 tv.vval.v_string = (char_u *)"";
3922 if (append)
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02003923 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003924 ASSIGN_NO_DECL, (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003925 else
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02003926 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003927 ASSIGN_NO_DECL, (char_u *)"=", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003928 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003929 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003930 {
3931 redir_endp = NULL; // don't store a value, only cleanup
3932 var_redir_stop();
3933 return FAIL;
3934 }
3935
3936 return OK;
3937}
3938
3939/*
3940 * Append "value[value_len]" to the variable set by var_redir_start().
3941 * The actual appending is postponed until redirection ends, because the value
3942 * appended may in fact be the string we write to, changing it may cause freed
3943 * memory to be used:
3944 * :redir => foo
3945 * :let foo
3946 * :redir END
3947 */
3948 void
3949var_redir_str(char_u *value, int value_len)
3950{
3951 int len;
3952
3953 if (redir_lval == NULL)
3954 return;
3955
3956 if (value_len == -1)
3957 len = (int)STRLEN(value); // Append the entire string
3958 else
3959 len = value_len; // Append only "value_len" characters
3960
3961 if (ga_grow(&redir_ga, len) == OK)
3962 {
3963 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
3964 redir_ga.ga_len += len;
3965 }
3966 else
3967 var_redir_stop();
3968}
3969
3970/*
3971 * Stop redirecting command output to a variable.
3972 * Frees the allocated memory.
3973 */
3974 void
3975var_redir_stop(void)
3976{
3977 typval_T tv;
3978
3979 if (EVALCMD_BUSY)
3980 {
3981 redir_lval = NULL;
3982 return;
3983 }
3984
3985 if (redir_lval != NULL)
3986 {
3987 // If there was no error: assign the text to the variable.
3988 if (redir_endp != NULL)
3989 {
3990 ga_append(&redir_ga, NUL); // Append the trailing NUL.
3991 tv.v_type = VAR_STRING;
3992 tv.vval.v_string = redir_ga.ga_data;
3993 // Call get_lval() again, if it's inside a Dict or List it may
3994 // have changed.
3995 redir_endp = get_lval(redir_varname, NULL, redir_lval,
3996 FALSE, FALSE, 0, FNE_CHECK_START);
3997 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003998 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003999 (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004000 clear_lval(redir_lval);
4001 }
4002
4003 // free the collected output
4004 VIM_CLEAR(redir_ga.ga_data);
4005
4006 VIM_CLEAR(redir_lval);
4007 }
4008 VIM_CLEAR(redir_varname);
4009}
4010
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004011/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004012 * Get the collected redirected text and clear redir_ga.
4013 */
4014 char_u *
4015get_clear_redir_ga(void)
4016{
4017 char_u *res;
4018
4019 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4020 res = redir_ga.ga_data;
4021 redir_ga.ga_data = NULL;
4022 return res;
4023}
4024
4025/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004026 * "gettabvar()" function
4027 */
4028 void
4029f_gettabvar(typval_T *argvars, typval_T *rettv)
4030{
4031 win_T *oldcurwin;
4032 tabpage_T *tp, *oldtabpage;
4033 dictitem_T *v;
4034 char_u *varname;
4035 int done = FALSE;
4036
4037 rettv->v_type = VAR_STRING;
4038 rettv->vval.v_string = NULL;
4039
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004040 if (in_vim9script()
4041 && (check_for_number_arg(argvars, 0) == FAIL
4042 || check_for_string_arg(argvars, 1) == FAIL))
4043 return;
4044
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004045 varname = tv_get_string_chk(&argvars[1]);
4046 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4047 if (tp != NULL && varname != NULL)
4048 {
4049 // Set tp to be our tabpage, temporarily. Also set the window to the
4050 // first window in the tabpage, otherwise the window is not valid.
4051 if (switch_win(&oldcurwin, &oldtabpage,
4052 tp == curtab || tp->tp_firstwin == NULL ? firstwin
4053 : tp->tp_firstwin, tp, TRUE) == OK)
4054 {
4055 // look up the variable
4056 // Let gettabvar({nr}, "") return the "t:" dictionary.
4057 v = find_var_in_ht(&tp->tp_vars->dv_hashtab, 't', varname, FALSE);
4058 if (v != NULL)
4059 {
4060 copy_tv(&v->di_tv, rettv);
4061 done = TRUE;
4062 }
4063 }
4064
4065 // restore previous notion of curwin
4066 restore_win(oldcurwin, oldtabpage, TRUE);
4067 }
4068
4069 if (!done && argvars[2].v_type != VAR_UNKNOWN)
4070 copy_tv(&argvars[2], rettv);
4071}
4072
4073/*
4074 * "gettabwinvar()" function
4075 */
4076 void
4077f_gettabwinvar(typval_T *argvars, typval_T *rettv)
4078{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004079 if (in_vim9script()
4080 && (check_for_number_arg(argvars, 0) == FAIL
4081 || check_for_number_arg(argvars, 1) == FAIL
4082 || check_for_string_arg(argvars, 2) == FAIL))
4083 return;
4084
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004085 getwinvar(argvars, rettv, 1);
4086}
4087
4088/*
4089 * "getwinvar()" function
4090 */
4091 void
4092f_getwinvar(typval_T *argvars, typval_T *rettv)
4093{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004094 if (in_vim9script()
4095 && (check_for_number_arg(argvars, 0) == FAIL
4096 || check_for_string_arg(argvars, 1) == FAIL))
4097 return;
4098
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004099 getwinvar(argvars, rettv, 0);
4100}
4101
4102/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004103 * "getbufvar()" function
4104 */
4105 void
4106f_getbufvar(typval_T *argvars, typval_T *rettv)
4107{
4108 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004109 char_u *varname;
4110 dictitem_T *v;
4111 int done = FALSE;
4112
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004113 if (in_vim9script()
4114 && (check_for_buffer_arg(argvars, 0) == FAIL
4115 || check_for_string_arg(argvars, 1) == FAIL))
4116 return;
4117
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004118 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004119 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004120
4121 rettv->v_type = VAR_STRING;
4122 rettv->vval.v_string = NULL;
4123
4124 if (buf != NULL && varname != NULL)
4125 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004126 if (*varname == '&')
4127 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004128 buf_T *save_curbuf = curbuf;
4129
4130 // set curbuf to be our buf, temporarily
4131 curbuf = buf;
4132
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004133 if (varname[1] == NUL)
4134 {
4135 // get all buffer-local options in a dict
4136 dict_T *opts = get_winbuf_options(TRUE);
4137
4138 if (opts != NULL)
4139 {
4140 rettv_dict_set(rettv, opts);
4141 done = TRUE;
4142 }
4143 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02004144 else if (eval_option(&varname, rettv, TRUE) == OK)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004145 // buffer-local-option
4146 done = TRUE;
Bram Moolenaar86015452020-03-29 15:12:15 +02004147
4148 // restore previous notion of curbuf
4149 curbuf = save_curbuf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004150 }
4151 else
4152 {
4153 // Look up the variable.
Bram Moolenaar52592752020-04-03 18:43:35 +02004154 if (*varname == NUL)
4155 // Let getbufvar({nr}, "") return the "b:" dictionary.
4156 v = &buf->b_bufvar;
4157 else
4158 v = find_var_in_ht(&buf->b_vars->dv_hashtab, 'b',
4159 varname, FALSE);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004160 if (v != NULL)
4161 {
4162 copy_tv(&v->di_tv, rettv);
4163 done = TRUE;
4164 }
4165 }
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004166 }
4167
4168 if (!done && argvars[2].v_type != VAR_UNKNOWN)
4169 // use the default value
4170 copy_tv(&argvars[2], rettv);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004171}
4172
4173/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004174 * "settabvar()" function
4175 */
4176 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004177f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004178{
4179 tabpage_T *save_curtab;
4180 tabpage_T *tp;
4181 char_u *varname, *tabvarname;
4182 typval_T *varp;
4183
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004184 if (check_secure())
4185 return;
4186
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004187 if (in_vim9script()
4188 && (check_for_number_arg(argvars, 0) == FAIL
4189 || check_for_string_arg(argvars, 1) == FAIL))
4190 return;
4191
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004192 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4193 varname = tv_get_string_chk(&argvars[1]);
4194 varp = &argvars[2];
4195
4196 if (varname != NULL && varp != NULL && tp != NULL)
4197 {
4198 save_curtab = curtab;
4199 goto_tabpage_tp(tp, FALSE, FALSE);
4200
4201 tabvarname = alloc(STRLEN(varname) + 3);
4202 if (tabvarname != NULL)
4203 {
4204 STRCPY(tabvarname, "t:");
4205 STRCPY(tabvarname + 2, varname);
4206 set_var(tabvarname, varp, TRUE);
4207 vim_free(tabvarname);
4208 }
4209
4210 // Restore current tabpage
4211 if (valid_tabpage(save_curtab))
4212 goto_tabpage_tp(save_curtab, FALSE, FALSE);
4213 }
4214}
4215
4216/*
4217 * "settabwinvar()" function
4218 */
4219 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004220f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004221{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004222 if (in_vim9script()
4223 && (check_for_number_arg(argvars, 0) == FAIL
4224 || check_for_number_arg(argvars, 1) == FAIL
4225 || check_for_string_arg(argvars, 2) == FAIL))
4226 return;
4227
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004228 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004229}
4230
4231/*
4232 * "setwinvar()" function
4233 */
4234 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004235f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004236{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004237 if (in_vim9script()
4238 && (check_for_number_arg(argvars, 0) == FAIL
4239 || check_for_string_arg(argvars, 1) == FAIL))
4240 return;
4241
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004242 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004243}
4244
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004245/*
4246 * "setbufvar()" function
4247 */
4248 void
4249f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
4250{
4251 buf_T *buf;
4252 char_u *varname, *bufvarname;
4253 typval_T *varp;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004254
4255 if (check_secure())
4256 return;
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004257
4258 if (in_vim9script()
4259 && (check_for_buffer_arg(argvars, 0) == FAIL
4260 || check_for_string_arg(argvars, 1) == FAIL))
4261 return;
4262
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004263 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004264 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004265 varp = &argvars[2];
4266
4267 if (buf != NULL && varname != NULL && varp != NULL)
4268 {
4269 if (*varname == '&')
4270 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004271 aco_save_T aco;
4272
4273 // set curbuf to be our buf, temporarily
4274 aucmd_prepbuf(&aco, buf);
4275
Bram Moolenaar191929b2020-08-19 21:20:49 +02004276 set_option_from_tv(varname + 1, varp);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004277
4278 // reset notion of buffer
4279 aucmd_restbuf(&aco);
4280 }
4281 else
4282 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004283 bufvarname = alloc(STRLEN(varname) + 3);
4284 if (bufvarname != NULL)
4285 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004286 buf_T *save_curbuf = curbuf;
4287
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004288 curbuf = buf;
4289 STRCPY(bufvarname, "b:");
4290 STRCPY(bufvarname + 2, varname);
4291 set_var(bufvarname, varp, TRUE);
4292 vim_free(bufvarname);
4293 curbuf = save_curbuf;
4294 }
4295 }
4296 }
4297}
4298
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004299/*
4300 * Get a callback from "arg". It can be a Funcref or a function name.
4301 * When "arg" is zero return an empty string.
4302 * "cb_name" is not allocated.
4303 * "cb_name" is set to NULL for an invalid argument.
4304 */
4305 callback_T
4306get_callback(typval_T *arg)
4307{
Bram Moolenaar14e579092020-03-07 16:59:25 +01004308 callback_T res;
4309 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004310
4311 res.cb_free_name = FALSE;
4312 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
4313 {
4314 res.cb_partial = arg->vval.v_partial;
4315 ++res.cb_partial->pt_refcount;
4316 res.cb_name = partial_name(res.cb_partial);
4317 }
4318 else
4319 {
4320 res.cb_partial = NULL;
Bram Moolenaar14e579092020-03-07 16:59:25 +01004321 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
4322 && isdigit(*arg->vval.v_string))
4323 r = FAIL;
4324 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004325 {
4326 // Note that we don't make a copy of the string.
4327 res.cb_name = arg->vval.v_string;
4328 func_ref(res.cb_name);
4329 }
4330 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004331 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004332 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01004333 r = FAIL;
4334
4335 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004336 {
4337 emsg(_("E921: Invalid callback argument"));
4338 res.cb_name = NULL;
4339 }
4340 }
4341 return res;
4342}
4343
4344/*
4345 * Copy a callback into a typval_T.
4346 */
4347 void
4348put_callback(callback_T *cb, typval_T *tv)
4349{
4350 if (cb->cb_partial != NULL)
4351 {
4352 tv->v_type = VAR_PARTIAL;
4353 tv->vval.v_partial = cb->cb_partial;
4354 ++tv->vval.v_partial->pt_refcount;
4355 }
4356 else
4357 {
4358 tv->v_type = VAR_FUNC;
4359 tv->vval.v_string = vim_strsave(cb->cb_name);
4360 func_ref(cb->cb_name);
4361 }
4362}
4363
4364/*
4365 * Make a copy of "src" into "dest", allocating the function name if needed,
4366 * without incrementing the refcount.
4367 */
4368 void
4369set_callback(callback_T *dest, callback_T *src)
4370{
4371 if (src->cb_partial == NULL)
4372 {
4373 // just a function name, make a copy
4374 dest->cb_name = vim_strsave(src->cb_name);
4375 dest->cb_free_name = TRUE;
4376 }
4377 else
4378 {
4379 // cb_name is a pointer into cb_partial
4380 dest->cb_name = src->cb_name;
4381 dest->cb_free_name = FALSE;
4382 }
4383 dest->cb_partial = src->cb_partial;
4384}
4385
4386/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02004387 * Copy callback from "src" to "dest", incrementing the refcounts.
4388 */
4389 void
4390copy_callback(callback_T *dest, callback_T *src)
4391{
4392 dest->cb_partial = src->cb_partial;
4393 if (dest->cb_partial != NULL)
4394 {
4395 dest->cb_name = src->cb_name;
4396 dest->cb_free_name = FALSE;
4397 ++dest->cb_partial->pt_refcount;
4398 }
4399 else
4400 {
4401 dest->cb_name = vim_strsave(src->cb_name);
4402 dest->cb_free_name = TRUE;
4403 func_ref(src->cb_name);
4404 }
4405}
4406
4407/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004408 * Unref/free "callback" returned by get_callback() or set_callback().
4409 */
4410 void
4411free_callback(callback_T *callback)
4412{
4413 if (callback->cb_partial != NULL)
4414 {
4415 partial_unref(callback->cb_partial);
4416 callback->cb_partial = NULL;
4417 }
4418 else if (callback->cb_name != NULL)
4419 func_unref(callback->cb_name);
4420 if (callback->cb_free_name)
4421 {
4422 vim_free(callback->cb_name);
4423 callback->cb_free_name = FALSE;
4424 }
4425 callback->cb_name = NULL;
4426}
4427
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004428#endif // FEAT_EVAL