blob: 66018cff0592d7ddca760decf29f40533f6944d1 [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] == '.'
777 && ((expr[1] == '=' && current_sctx.sc_version < 2)
778 || (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 }
815 eap->nextcmd = check_nextcmd(arg);
816 }
817 else if (expr[0] == '=' && expr[1] == '<' && expr[2] == '<')
818 {
819 list_T *l;
820
821 // HERE document
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200822 l = heredoc_get(eap, expr + 3, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200823 if (l != NULL)
824 {
825 rettv_list_set(&rettv, l);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +0200826 if (!eap->skip)
827 {
828 op[0] = '=';
829 op[1] = NUL;
830 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100831 flags, op);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +0200832 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200833 clear_tv(&rettv);
834 }
835 }
836 else
837 {
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200838 evalarg_T evalarg;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200839 int len = 1;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200840
Bram Moolenaarc1ec0422020-09-09 22:27:58 +0200841 CLEAR_FIELD(rettv);
Bram Moolenaar32e35112020-05-14 22:41:15 +0200842 i = FAIL;
843 if (has_assign || concat)
844 {
Bram Moolenaar9a562c12021-01-23 13:39:14 +0100845 int cur_lnum;
846
Bram Moolenaar32e35112020-05-14 22:41:15 +0200847 op[0] = '=';
848 op[1] = NUL;
849 if (*expr != '=')
850 {
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200851 if (vim9script && (flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar122616d2020-08-21 21:32:50 +0200852 {
853 // +=, /=, etc. require an existing variable
854 semsg(_(e_cannot_use_operator_on_new_variable), eap->arg);
855 i = FAIL;
856 }
857 else if (vim_strchr((char_u *)"+-*/%.", *expr) != NULL)
Bram Moolenaar32e35112020-05-14 22:41:15 +0200858 {
859 op[0] = *expr; // +=, -=, *=, /=, %= or .=
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200860 ++len;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200861 if (expr[0] == '.' && expr[1] == '.') // ..=
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200862 {
Bram Moolenaar32e35112020-05-14 22:41:15 +0200863 ++expr;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200864 ++len;
865 }
Bram Moolenaar32e35112020-05-14 22:41:15 +0200866 }
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200867 expr += 2;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200868 }
869 else
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200870 ++expr;
871
Bram Moolenaarc7e44a72020-07-29 21:37:43 +0200872 if (vim9script && (!VIM_ISWHITE(*argend)
873 || !IS_WHITE_OR_NUL(*expr)))
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200874 {
875 vim_strncpy(op, expr - len, len);
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100876 semsg(_(e_white_space_required_before_and_after_str_at_str),
877 op, argend);
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200878 i = FAIL;
879 }
Bram Moolenaar32e35112020-05-14 22:41:15 +0200880
881 if (eap->skip)
882 ++emsg_skip;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200883 CLEAR_FIELD(evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200884 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
Bram Moolenaard5053d02020-06-28 15:51:16 +0200885 if (getline_equal(eap->getline, eap->cookie, getsourceline))
886 {
887 evalarg.eval_getline = eap->getline;
888 evalarg.eval_cookie = eap->cookie;
889 }
Bram Moolenaarc7e44a72020-07-29 21:37:43 +0200890 expr = skipwhite_and_linebreak(expr, &evalarg);
Bram Moolenaar9a562c12021-01-23 13:39:14 +0100891 cur_lnum = SOURCING_LNUM;
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200892 i = eval0(expr, &rettv, eap, &evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200893 if (eap->skip)
894 --emsg_skip;
Bram Moolenaarfaf86262020-06-27 23:07:36 +0200895 clear_evalarg(&evalarg, eap);
Bram Moolenaar9a562c12021-01-23 13:39:14 +0100896
897 // Restore the line number so that any type error is given for the
898 // declaration, not the expression.
899 SOURCING_LNUM = cur_lnum;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200900 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200901 if (eap->skip)
902 {
903 if (i != FAIL)
904 clear_tv(&rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200905 }
Bram Moolenaar822ba242020-05-24 23:00:18 +0200906 else if (i != FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200907 {
908 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200909 flags, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200910 clear_tv(&rettv);
911 }
912 }
913}
914
915/*
Bram Moolenaar6c3843c2021-03-04 12:38:21 +0100916 * Assign the typeval "tv" to the variable or variables at "arg_start".
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200917 * Handles both "var" with any type and "[var, var; var]" with a list type.
918 * When "op" is not NULL it points to a string with characters that
919 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
920 * or concatenate.
921 * Returns OK or FAIL;
922 */
923 int
924ex_let_vars(
925 char_u *arg_start,
926 typval_T *tv,
927 int copy, // copy values from "tv", don't move
928 int semicolon, // from skip_var_list()
929 int var_count, // from skip_var_list()
Bram Moolenaar3862ea32021-01-01 21:05:55 +0100930 int flags, // ASSIGN_FINAL, ASSIGN_CONST, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200931 char_u *op)
932{
933 char_u *arg = arg_start;
934 list_T *l;
935 int i;
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100936 int var_idx = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200937 listitem_T *item;
938 typval_T ltv;
939
940 if (*arg != '[')
941 {
942 // ":let var = expr" or ":for var in list"
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100943 if (ex_let_one(arg, tv, copy, flags, op, op, var_idx) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200944 return FAIL;
945 return OK;
946 }
947
948 // ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
949 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
950 {
951 emsg(_(e_listreq));
952 return FAIL;
953 }
954
955 i = list_len(l);
956 if (semicolon == 0 && var_count < i)
957 {
958 emsg(_("E687: Less targets than List items"));
959 return FAIL;
960 }
961 if (var_count - semicolon > i)
962 {
963 emsg(_("E688: More targets than List items"));
964 return FAIL;
965 }
966
Bram Moolenaar7e9f3512020-05-13 22:44:22 +0200967 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200968 item = l->lv_first;
969 while (*arg != ']')
970 {
971 arg = skipwhite(arg + 1);
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100972 ++var_idx;
Bram Moolenaarf93bbd02021-04-10 22:35:43 +0200973 arg = ex_let_one(arg, &item->li_tv, TRUE,
974 flags | ASSIGN_UNPACK, (char_u *)",;]", op, var_idx);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200975 item = item->li_next;
976 if (arg == NULL)
977 return FAIL;
978
979 arg = skipwhite(arg);
980 if (*arg == ';')
981 {
982 // Put the rest of the list (may be empty) in the var after ';'.
983 // Create a new list for this.
984 l = list_alloc();
985 if (l == NULL)
986 return FAIL;
987 while (item != NULL)
988 {
989 list_append_tv(l, &item->li_tv);
990 item = item->li_next;
991 }
992
993 ltv.v_type = VAR_LIST;
994 ltv.v_lock = 0;
995 ltv.vval.v_list = l;
996 l->lv_refcount = 1;
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100997 ++var_idx;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200998
Bram Moolenaarf93bbd02021-04-10 22:35:43 +0200999 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1000 flags | ASSIGN_UNPACK, (char_u *)"]", op, var_idx);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001001 clear_tv(&ltv);
1002 if (arg == NULL)
1003 return FAIL;
1004 break;
1005 }
1006 else if (*arg != ',' && *arg != ']')
1007 {
1008 internal_error("ex_let_vars()");
1009 return FAIL;
1010 }
1011 }
1012
1013 return OK;
1014}
1015
1016/*
1017 * Skip over assignable variable "var" or list of variables "[var, var]".
1018 * Used for ":let varvar = expr" and ":for varvar in expr".
1019 * For "[var, var]" increment "*var_count" for each variable.
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001020 * for "[var, var; var]" set "semicolon" to 1.
1021 * If "silent" is TRUE do not give an "invalid argument" error message.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001022 * Return NULL for an error.
1023 */
1024 char_u *
1025skip_var_list(
1026 char_u *arg,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001027 int include_type,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001028 int *var_count,
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001029 int *semicolon,
1030 int silent)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001031{
1032 char_u *p, *s;
1033
1034 if (*arg == '[')
1035 {
1036 // "[var, var]": find the matching ']'.
1037 p = arg;
1038 for (;;)
1039 {
1040 p = skipwhite(p + 1); // skip whites after '[', ';' or ','
Bram Moolenaar036d0712021-01-17 20:23:38 +01001041 s = skip_var_one(p, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001042 if (s == p)
1043 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001044 if (!silent)
1045 semsg(_(e_invarg2), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001046 return NULL;
1047 }
1048 ++*var_count;
1049
1050 p = skipwhite(s);
1051 if (*p == ']')
1052 break;
1053 else if (*p == ';')
1054 {
1055 if (*semicolon == 1)
1056 {
Bram Moolenaar9be61bb2020-03-30 22:51:24 +02001057 emsg(_("E452: Double ; in list of variables"));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001058 return NULL;
1059 }
1060 *semicolon = 1;
1061 }
1062 else if (*p != ',')
1063 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001064 if (!silent)
1065 semsg(_(e_invarg2), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001066 return NULL;
1067 }
1068 }
1069 return p + 1;
1070 }
1071 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001072 return skip_var_one(arg, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001073}
1074
1075/*
1076 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1077 * l[idx].
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001078 * In Vim9 script also skip over ": type" if "include_type" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001079 */
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001080 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001081skip_var_one(char_u *arg, int include_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001082{
Bram Moolenaar585587d2021-01-17 20:52:13 +01001083 char_u *end;
1084 int vim9 = in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001085
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001086 if (*arg == '@' && arg[1] != NUL)
1087 return arg + 2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001088 end = find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001089 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
Bram Moolenaar036d0712021-01-17 20:23:38 +01001090
1091 // "a: type" is declaring variable "a" with a type, not "a:".
1092 // Same for "s: type".
Bram Moolenaar585587d2021-01-17 20:52:13 +01001093 if (vim9 && end == arg + 2 && end[-1] == ':')
Bram Moolenaar036d0712021-01-17 20:23:38 +01001094 --end;
1095
Bram Moolenaar585587d2021-01-17 20:52:13 +01001096 if (include_type && vim9)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001097 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001098 if (*end == ':')
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02001099 end = skip_type(skipwhite(end + 1), FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001100 }
1101 return end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001102}
1103
1104/*
1105 * List variables for hashtab "ht" with prefix "prefix".
1106 * If "empty" is TRUE also list NULL strings as empty strings.
1107 */
1108 void
1109list_hashtable_vars(
1110 hashtab_T *ht,
1111 char *prefix,
1112 int empty,
1113 int *first)
1114{
1115 hashitem_T *hi;
1116 dictitem_T *di;
1117 int todo;
1118 char_u buf[IOSIZE];
1119
1120 todo = (int)ht->ht_used;
1121 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1122 {
1123 if (!HASHITEM_EMPTY(hi))
1124 {
1125 --todo;
1126 di = HI2DI(hi);
1127
1128 // apply :filter /pat/ to variable name
1129 vim_strncpy((char_u *)buf, (char_u *)prefix, IOSIZE - 1);
1130 vim_strcat((char_u *)buf, di->di_key, IOSIZE);
1131 if (message_filtered(buf))
1132 continue;
1133
1134 if (empty || di->di_tv.v_type != VAR_STRING
1135 || di->di_tv.vval.v_string != NULL)
1136 list_one_var(di, prefix, first);
1137 }
1138 }
1139}
1140
1141/*
1142 * List global variables.
1143 */
1144 static void
1145list_glob_vars(int *first)
1146{
1147 list_hashtable_vars(&globvarht, "", TRUE, first);
1148}
1149
1150/*
1151 * List buffer variables.
1152 */
1153 static void
1154list_buf_vars(int *first)
1155{
1156 list_hashtable_vars(&curbuf->b_vars->dv_hashtab, "b:", TRUE, first);
1157}
1158
1159/*
1160 * List window variables.
1161 */
1162 static void
1163list_win_vars(int *first)
1164{
1165 list_hashtable_vars(&curwin->w_vars->dv_hashtab, "w:", TRUE, first);
1166}
1167
1168/*
1169 * List tab page variables.
1170 */
1171 static void
1172list_tab_vars(int *first)
1173{
1174 list_hashtable_vars(&curtab->tp_vars->dv_hashtab, "t:", TRUE, first);
1175}
1176
1177/*
1178 * List variables in "arg".
1179 */
1180 static char_u *
1181list_arg_vars(exarg_T *eap, char_u *arg, int *first)
1182{
1183 int error = FALSE;
1184 int len;
1185 char_u *name;
1186 char_u *name_start;
1187 char_u *arg_subsc;
1188 char_u *tofree;
1189 typval_T tv;
1190
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001191 while (!ends_excmd2(eap->cmd, arg) && !got_int)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001192 {
1193 if (error || eap->skip)
1194 {
1195 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1196 if (!VIM_ISWHITE(*arg) && !ends_excmd(*arg))
1197 {
1198 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001199 semsg(_(e_trailing_arg), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001200 break;
1201 }
1202 }
1203 else
1204 {
1205 // get_name_len() takes care of expanding curly braces
1206 name_start = name = arg;
1207 len = get_name_len(&arg, &tofree, TRUE, TRUE);
1208 if (len <= 0)
1209 {
1210 // This is mainly to keep test 49 working: when expanding
1211 // curly braces fails overrule the exception error message.
1212 if (len < 0 && !aborting())
1213 {
1214 emsg_severe = TRUE;
1215 semsg(_(e_invarg2), arg);
1216 break;
1217 }
1218 error = TRUE;
1219 }
1220 else
1221 {
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02001222 arg = skipwhite(arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001223 if (tofree != NULL)
1224 name = tofree;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01001225 if (eval_variable(name, len, &tv, NULL,
1226 EVAL_VAR_VERBOSE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001227 error = TRUE;
1228 else
1229 {
1230 // handle d.key, l[idx], f(expr)
1231 arg_subsc = arg;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001232 if (handle_subscript(&arg, &tv, &EVALARG_EVALUATE, TRUE)
Bram Moolenaar0b1cd522020-06-27 13:11:50 +02001233 == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001234 error = TRUE;
1235 else
1236 {
1237 if (arg == arg_subsc && len == 2 && name[1] == ':')
1238 {
1239 switch (*name)
1240 {
1241 case 'g': list_glob_vars(first); break;
1242 case 'b': list_buf_vars(first); break;
1243 case 'w': list_win_vars(first); break;
1244 case 't': list_tab_vars(first); break;
1245 case 'v': list_vim_vars(first); break;
1246 case 's': list_script_vars(first); break;
1247 case 'l': list_func_vars(first); break;
1248 default:
1249 semsg(_("E738: Can't list variables for %s"), name);
1250 }
1251 }
1252 else
1253 {
1254 char_u numbuf[NUMBUFLEN];
1255 char_u *tf;
1256 int c;
1257 char_u *s;
1258
1259 s = echo_string(&tv, &tf, numbuf, 0);
1260 c = *arg;
1261 *arg = NUL;
1262 list_one_var_a("",
1263 arg == arg_subsc ? name : name_start,
1264 tv.v_type,
1265 s == NULL ? (char_u *)"" : s,
1266 first);
1267 *arg = c;
1268 vim_free(tf);
1269 }
1270 clear_tv(&tv);
1271 }
1272 }
1273 }
1274
1275 vim_free(tofree);
1276 }
1277
1278 arg = skipwhite(arg);
1279 }
1280
1281 return arg;
1282}
1283
1284/*
1285 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
1286 * Returns a pointer to the char just after the var name.
1287 * Returns NULL if there is an error.
1288 */
1289 static char_u *
1290ex_let_one(
1291 char_u *arg, // points to variable name
1292 typval_T *tv, // value to assign to variable
1293 int copy, // copy value from "tv"
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001294 int flags, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001295 char_u *endchars, // valid chars after variable name or NULL
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001296 char_u *op, // "+", "-", "." or NULL
1297 int var_idx) // variable index for "let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001298{
1299 int c1;
1300 char_u *name;
1301 char_u *p;
1302 char_u *arg_end = NULL;
1303 int len;
1304 int opt_flags;
1305 char_u *tofree = NULL;
1306
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001307 if (in_vim9script() && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001308 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001309 && vim_strchr((char_u *)"$@&", *arg) != NULL)
1310 {
1311 vim9_declare_error(arg);
1312 return NULL;
1313 }
1314
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001315 // ":let $VAR = expr": Set environment variable.
1316 if (*arg == '$')
1317 {
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02001318 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1319 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001320 {
1321 emsg(_("E996: Cannot lock an environment variable"));
1322 return NULL;
1323 }
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001324
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001325 // Find the end of the name.
1326 ++arg;
1327 name = arg;
1328 len = get_env_len(&arg);
1329 if (len == 0)
1330 semsg(_(e_invarg2), name - 1);
1331 else
1332 {
1333 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1334 semsg(_(e_letwrong), op);
1335 else if (endchars != NULL
1336 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
Bram Moolenaar108010a2021-06-27 22:03:33 +02001337 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001338 else if (!check_secure())
1339 {
1340 c1 = name[len];
1341 name[len] = NUL;
1342 p = tv_get_string_chk(tv);
1343 if (p != NULL && op != NULL && *op == '.')
1344 {
1345 int mustfree = FALSE;
1346 char_u *s = vim_getenv(name, &mustfree);
1347
1348 if (s != NULL)
1349 {
1350 p = tofree = concat_str(s, p);
1351 if (mustfree)
1352 vim_free(s);
1353 }
1354 }
1355 if (p != NULL)
1356 {
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01001357 vim_setenv_ext(name, p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001358 arg_end = arg;
1359 }
1360 name[len] = c1;
1361 vim_free(tofree);
1362 }
1363 }
1364 }
1365
1366 // ":let &option = expr": Set option value.
1367 // ":let &l:option = expr": Set local option value.
1368 // ":let &g:option = expr": Set global option value.
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02001369 // ":for &ts in range(8)": Set option value for for loop
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001370 else if (*arg == '&')
1371 {
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02001372 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1373 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001374 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001375 emsg(_(e_const_option));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001376 return NULL;
1377 }
1378 // Find the end of the name.
1379 p = find_option_end(&arg, &opt_flags);
1380 if (p == NULL || (endchars != NULL
1381 && vim_strchr(endchars, *skipwhite(p)) == NULL))
Bram Moolenaar108010a2021-06-27 22:03:33 +02001382 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001383 else
1384 {
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001385 long n = 0;
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001386 getoption_T opt_type;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001387 long numval;
1388 char_u *stringval = NULL;
Bram Moolenaar65d032c2020-04-24 20:57:01 +02001389 char_u *s = NULL;
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001390 int failed = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001391
1392 c1 = *p;
1393 *p = NUL;
1394
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001395 opt_type = get_option_value(arg, &numval, &stringval, opt_flags);
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001396 if ((opt_type == gov_bool
1397 || opt_type == gov_number
1398 || opt_type == gov_hidden_bool
1399 || opt_type == gov_hidden_number)
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001400 && (tv->v_type != VAR_STRING || !in_vim9script()))
Bram Moolenaar0ea04402021-01-04 13:37:54 +01001401 {
1402 if (opt_type == gov_bool || opt_type == gov_hidden_bool)
1403 // bool, possibly hidden
1404 n = (long)tv_get_bool(tv);
1405 else
1406 // number, possibly hidden
1407 n = (long)tv_get_number(tv);
1408 }
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001409
1410 // Avoid setting a string option to the text "v:false" or similar.
1411 // In Vim9 script also don't convert a number to string.
1412 if (tv->v_type != VAR_BOOL && tv->v_type != VAR_SPECIAL
1413 && (!in_vim9script() || tv->v_type != VAR_NUMBER))
1414 s = tv_get_string_chk(tv);
1415
1416 if (op != NULL && *op != '=')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001417 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001418 if (((opt_type == gov_bool || opt_type == gov_number)
1419 && *op == '.')
1420 || (opt_type == gov_string && *op != '.'))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001421 {
1422 semsg(_(e_letwrong), op);
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001423 failed = TRUE; // don't set the value
1424
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001425 }
1426 else
1427 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001428 // number, in legacy script also bool
1429 if (opt_type == gov_number
1430 || (opt_type == gov_bool && !in_vim9script()))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001431 {
1432 switch (*op)
1433 {
1434 case '+': n = numval + n; break;
1435 case '-': n = numval - n; break;
1436 case '*': n = numval * n; break;
Bram Moolenaarc5f59fa2021-01-21 12:34:14 +01001437 case '/': n = (long)num_divide(numval, n,
1438 &failed); break;
1439 case '%': n = (long)num_modulus(numval, n,
1440 &failed); break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001441 }
Bram Moolenaara42e6e02021-06-10 18:43:25 +02001442 s = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001443 }
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001444 else if (opt_type == gov_string
1445 && stringval != NULL && s != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001446 {
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001447 // string
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001448 s = concat_str(stringval, s);
1449 vim_free(stringval);
1450 stringval = s;
1451 }
1452 }
1453 }
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001454
1455 if (!failed)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001456 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001457 if (opt_type != gov_string || s != NULL)
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001458 {
1459 set_option_value(arg, n, s, opt_flags);
1460 arg_end = p;
1461 }
1462 else
1463 emsg(_(e_stringreq));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001464 }
1465 *p = c1;
1466 vim_free(stringval);
1467 }
1468 }
1469
1470 // ":let @r = expr": Set register contents.
1471 else if (*arg == '@')
1472 {
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02001473 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1474 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001475 {
1476 emsg(_("E996: Cannot lock a register"));
1477 return NULL;
1478 }
1479 ++arg;
1480 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1481 semsg(_(e_letwrong), op);
1482 else if (endchars != NULL
1483 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
Bram Moolenaar108010a2021-06-27 22:03:33 +02001484 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001485 else
1486 {
1487 char_u *ptofree = NULL;
1488 char_u *s;
1489
1490 p = tv_get_string_chk(tv);
1491 if (p != NULL && op != NULL && *op == '.')
1492 {
1493 s = get_reg_contents(*arg == '@' ? '"' : *arg, GREG_EXPR_SRC);
1494 if (s != NULL)
1495 {
1496 p = ptofree = concat_str(s, p);
1497 vim_free(s);
1498 }
1499 }
1500 if (p != NULL)
1501 {
1502 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
1503 arg_end = arg + 1;
1504 }
1505 vim_free(ptofree);
1506 }
1507 }
1508
1509 // ":let var = expr": Set internal variable.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001510 // ":let var: type = expr": Set internal variable with type.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001511 // ":let {expr} = expr": Idem, name made with curly braces
1512 else if (eval_isnamec1(*arg) || *arg == '{')
1513 {
1514 lval_T lv;
1515
Bram Moolenaar8f22f5c2020-12-19 22:10:13 +01001516 p = get_lval(arg, tv, &lv, FALSE, FALSE,
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001517 (flags & (ASSIGN_NO_DECL | ASSIGN_DECL))
1518 ? GLV_NO_DECL : 0, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001519 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001520 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001521 if (endchars != NULL && vim_strchr(endchars,
1522 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar108010a2021-06-27 22:03:33 +02001523 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001524 else
1525 {
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001526 set_var_lval(&lv, p, tv, copy, flags, op, var_idx);
Bram Moolenaara3589a02021-04-14 13:30:46 +02001527 arg_end = lv.ll_name_end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001528 }
1529 }
1530 clear_lval(&lv);
1531 }
1532
1533 else
1534 semsg(_(e_invarg2), arg);
1535
1536 return arg_end;
1537}
1538
1539/*
1540 * ":unlet[!] var1 ... " command.
1541 */
1542 void
1543ex_unlet(exarg_T *eap)
1544{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001545 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001546}
1547
1548/*
1549 * ":lockvar" and ":unlockvar" commands
1550 */
1551 void
1552ex_lockvar(exarg_T *eap)
1553{
1554 char_u *arg = eap->arg;
1555 int deep = 2;
1556
1557 if (eap->forceit)
1558 deep = -1;
1559 else if (vim_isdigit(*arg))
1560 {
1561 deep = getdigits(&arg);
1562 arg = skipwhite(arg);
1563 }
1564
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001565 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001566}
1567
1568/*
1569 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001570 * Also used for Vim9 script. "callback" is invoked as:
1571 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001572 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001573 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001574ex_unletlock(
1575 exarg_T *eap,
1576 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001577 int deep,
1578 int glv_flags,
1579 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1580 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001581{
1582 char_u *arg = argstart;
1583 char_u *name_end;
1584 int error = FALSE;
1585 lval_T lv;
1586
1587 do
1588 {
1589 if (*arg == '$')
1590 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001591 lv.ll_name = arg;
1592 lv.ll_tv = NULL;
1593 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001594 if (get_env_len(&arg) == 0)
1595 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001596 semsg(_(e_invarg2), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001597 return;
1598 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001599 if (!error && !eap->skip
1600 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1601 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001602 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001603 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001604 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001605 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001606 // Parse the name and find the end.
1607 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
Bram Moolenaarc3689572021-01-01 19:40:02 +01001608 glv_flags | GLV_NO_DECL, FNE_CHECK_START);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001609 if (lv.ll_name == NULL)
1610 error = TRUE; // error but continue parsing
1611 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1612 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001613 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001614 if (name_end != NULL)
1615 {
1616 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001617 semsg(_(e_trailing_arg), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001618 }
1619 if (!(eap->skip || error))
1620 clear_lval(&lv);
1621 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001622 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001623
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001624 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001625 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001626 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001627
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001628 if (!eap->skip)
1629 clear_lval(&lv);
1630 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001631
1632 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001633 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001634
1635 eap->nextcmd = check_nextcmd(arg);
1636}
1637
1638 static int
1639do_unlet_var(
1640 lval_T *lp,
1641 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001642 exarg_T *eap,
1643 int deep UNUSED,
1644 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001645{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001646 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001647 int ret = OK;
1648 int cc;
1649
1650 if (lp->ll_tv == NULL)
1651 {
1652 cc = *name_end;
1653 *name_end = NUL;
1654
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001655 // Environment variable, normal name or expanded name.
1656 if (*lp->ll_name == '$')
1657 vim_unsetenv(lp->ll_name + 1);
1658 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001659 ret = FAIL;
1660 *name_end = cc;
1661 }
1662 else if ((lp->ll_list != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001663 && value_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001664 || (lp->ll_dict != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001665 && value_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001666 return FAIL;
1667 else if (lp->ll_range)
1668 {
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01001669 if (list_unlet_range(lp->ll_list, lp->ll_li, lp->ll_name, lp->ll_n1,
1670 !lp->ll_empty2, lp->ll_n2) == FAIL)
1671 return FAIL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001672 }
1673 else
1674 {
1675 if (lp->ll_list != NULL)
1676 // unlet a List item.
1677 listitem_remove(lp->ll_list, lp->ll_li);
1678 else
1679 // unlet a Dictionary item.
1680 dictitem_remove(lp->ll_dict, lp->ll_di);
1681 }
1682
1683 return ret;
1684}
1685
1686/*
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01001687 * Unlet one item or a range of items from a list.
1688 * Return OK or FAIL.
1689 */
1690 int
1691list_unlet_range(
1692 list_T *l,
1693 listitem_T *li_first,
1694 char_u *name,
1695 long n1_arg,
1696 int has_n2,
1697 long n2)
1698{
1699 listitem_T *li = li_first;
1700 int n1 = n1_arg;
1701
1702 while (li != NULL && (!has_n2 || n2 >= n1))
1703 {
1704 if (value_check_lock(li->li_tv.v_lock, name, FALSE))
1705 return FAIL;
1706 li = li->li_next;
1707 ++n1;
1708 }
1709
1710 // Delete a range of List items.
1711 li = li_first;
1712 n1 = n1_arg;
1713 while (li != NULL && (!has_n2 || n2 >= n1))
1714 {
1715 listitem_T *next = li->li_next;
1716
1717 listitem_remove(l, li);
1718 li = next;
1719 ++n1;
1720 }
1721 return OK;
1722}
1723/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001724 * "unlet" a variable. Return OK if it existed, FAIL if not.
1725 * When "forceit" is TRUE don't complain if the variable doesn't exist.
1726 */
1727 int
1728do_unlet(char_u *name, int forceit)
1729{
1730 hashtab_T *ht;
1731 hashitem_T *hi;
1732 char_u *varname;
1733 dict_T *d;
1734 dictitem_T *di;
1735
Bram Moolenaar9aed7292020-12-18 15:38:00 +01001736 // can't :unlet a script variable in Vim9 script
Bram Moolenaareb6880b2020-07-12 17:07:05 +02001737 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001738 return FAIL;
1739
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001740 ht = find_var_ht(name, &varname);
Bram Moolenaar9aed7292020-12-18 15:38:00 +01001741
1742 // can't :unlet a script variable in Vim9 script from a function
1743 if (ht == get_script_local_ht()
1744 && SCRIPT_ID_VALID(current_sctx.sc_sid)
1745 && SCRIPT_ITEM(current_sctx.sc_sid)->sn_version
1746 == SCRIPT_VERSION_VIM9
1747 && check_vim9_unlet(name) == FAIL)
1748 return FAIL;
1749
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001750 if (ht != NULL && *varname != NUL)
1751 {
1752 d = get_current_funccal_dict(ht);
1753 if (d == NULL)
1754 {
1755 if (ht == &globvarht)
1756 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001757 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001758 d = &vimvardict;
1759 else
1760 {
1761 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
1762 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
1763 }
1764 if (d == NULL)
1765 {
1766 internal_error("do_unlet()");
1767 return FAIL;
1768 }
1769 }
1770 hi = hash_find(ht, varname);
1771 if (HASHITEM_EMPTY(hi))
1772 hi = find_hi_in_scoped_ht(name, &ht);
1773 if (hi != NULL && !HASHITEM_EMPTY(hi))
1774 {
1775 di = HI2DI(hi);
1776 if (var_check_fixed(di->di_flags, name, FALSE)
1777 || var_check_ro(di->di_flags, name, FALSE)
Bram Moolenaara187c432020-09-16 21:08:28 +02001778 || value_check_lock(d->dv_lock, name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001779 return FAIL;
1780
1781 delete_var(ht, hi);
1782 return OK;
1783 }
1784 }
1785 if (forceit)
1786 return OK;
1787 semsg(_("E108: No such variable: \"%s\""), name);
1788 return FAIL;
1789}
1790
1791/*
1792 * Lock or unlock variable indicated by "lp".
1793 * "deep" is the levels to go (-1 for unlimited);
1794 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
1795 */
1796 static int
1797do_lock_var(
1798 lval_T *lp,
1799 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001800 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001801 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001802 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001803{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001804 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001805 int ret = OK;
1806 int cc;
1807 dictitem_T *di;
1808
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001809 if (lp->ll_tv == NULL)
1810 {
1811 cc = *name_end;
1812 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001813 if (*lp->ll_name == '$')
1814 {
1815 semsg(_(e_lock_unlock), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001816 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001817 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001818 else
1819 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001820 // Normal name or expanded name.
1821 di = find_var(lp->ll_name, NULL, TRUE);
1822 if (di == NULL)
1823 ret = FAIL;
1824 else if ((di->di_flags & DI_FLAGS_FIX)
1825 && di->di_tv.v_type != VAR_DICT
1826 && di->di_tv.v_type != VAR_LIST)
1827 {
1828 // For historic reasons this error is not given for a list or
1829 // dict. E.g., the b: dict could be locked/unlocked.
1830 semsg(_(e_lock_unlock), lp->ll_name);
1831 ret = FAIL;
1832 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001833 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001834 {
1835 if (lock)
1836 di->di_flags |= DI_FLAGS_LOCK;
1837 else
1838 di->di_flags &= ~DI_FLAGS_LOCK;
Bram Moolenaara187c432020-09-16 21:08:28 +02001839 if (deep != 0)
1840 item_lock(&di->di_tv, deep, lock, FALSE);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001841 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001842 }
1843 *name_end = cc;
1844 }
Bram Moolenaara187c432020-09-16 21:08:28 +02001845 else if (deep == 0)
1846 {
1847 // nothing to do
1848 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001849 else if (lp->ll_range)
1850 {
1851 listitem_T *li = lp->ll_li;
1852
1853 // (un)lock a range of List items.
1854 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
1855 {
Bram Moolenaar021bda52020-08-17 21:07:22 +02001856 item_lock(&li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001857 li = li->li_next;
1858 ++lp->ll_n1;
1859 }
1860 }
1861 else if (lp->ll_list != NULL)
1862 // (un)lock a List item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001863 item_lock(&lp->ll_li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001864 else
1865 // (un)lock a Dictionary item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001866 item_lock(&lp->ll_di->di_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001867
1868 return ret;
1869}
1870
1871/*
1872 * Lock or unlock an item. "deep" is nr of levels to go.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001873 * When "check_refcount" is TRUE do not lock a list or dict with a reference
1874 * count larger than 1.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001875 */
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02001876 void
Bram Moolenaar021bda52020-08-17 21:07:22 +02001877item_lock(typval_T *tv, int deep, int lock, int check_refcount)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001878{
1879 static int recurse = 0;
1880 list_T *l;
1881 listitem_T *li;
1882 dict_T *d;
1883 blob_T *b;
1884 hashitem_T *hi;
1885 int todo;
1886
1887 if (recurse >= DICT_MAXNEST)
1888 {
1889 emsg(_("E743: variable nested too deep for (un)lock"));
1890 return;
1891 }
1892 if (deep == 0)
1893 return;
1894 ++recurse;
1895
1896 // lock/unlock the item itself
1897 if (lock)
1898 tv->v_lock |= VAR_LOCKED;
1899 else
1900 tv->v_lock &= ~VAR_LOCKED;
1901
1902 switch (tv->v_type)
1903 {
1904 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02001905 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001906 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001907 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001908 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001909 case VAR_STRING:
1910 case VAR_FUNC:
1911 case VAR_PARTIAL:
1912 case VAR_FLOAT:
1913 case VAR_SPECIAL:
1914 case VAR_JOB:
1915 case VAR_CHANNEL:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02001916 case VAR_INSTR:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001917 break;
1918
1919 case VAR_BLOB:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001920 if ((b = tv->vval.v_blob) != NULL
1921 && !(check_refcount && b->bv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001922 {
1923 if (lock)
1924 b->bv_lock |= VAR_LOCKED;
1925 else
1926 b->bv_lock &= ~VAR_LOCKED;
1927 }
1928 break;
1929 case VAR_LIST:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001930 if ((l = tv->vval.v_list) != NULL
1931 && !(check_refcount && l->lv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001932 {
1933 if (lock)
1934 l->lv_lock |= VAR_LOCKED;
1935 else
1936 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001937 if ((deep < 0 || deep > 1) && l->lv_first != &range_list_item)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001938 // recursive: lock/unlock the items the List contains
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001939 FOR_ALL_LIST_ITEMS(l, li)
Bram Moolenaar021bda52020-08-17 21:07:22 +02001940 item_lock(&li->li_tv, deep - 1, lock, check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001941 }
1942 break;
1943 case VAR_DICT:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001944 if ((d = tv->vval.v_dict) != NULL
1945 && !(check_refcount && d->dv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001946 {
1947 if (lock)
1948 d->dv_lock |= VAR_LOCKED;
1949 else
1950 d->dv_lock &= ~VAR_LOCKED;
1951 if (deep < 0 || deep > 1)
1952 {
1953 // recursive: lock/unlock the items the List contains
1954 todo = (int)d->dv_hashtab.ht_used;
1955 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
1956 {
1957 if (!HASHITEM_EMPTY(hi))
1958 {
1959 --todo;
Bram Moolenaar021bda52020-08-17 21:07:22 +02001960 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock,
1961 check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001962 }
1963 }
1964 }
1965 }
1966 }
1967 --recurse;
1968}
1969
Bram Moolenaarda6c0332019-09-01 16:01:30 +02001970#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
1971/*
1972 * Delete all "menutrans_" variables.
1973 */
1974 void
1975del_menutrans_vars(void)
1976{
1977 hashitem_T *hi;
1978 int todo;
1979
1980 hash_lock(&globvarht);
1981 todo = (int)globvarht.ht_used;
1982 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
1983 {
1984 if (!HASHITEM_EMPTY(hi))
1985 {
1986 --todo;
1987 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
1988 delete_var(&globvarht, hi);
1989 }
1990 }
1991 hash_unlock(&globvarht);
1992}
1993#endif
1994
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001995/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001996 * Local string buffer for the next two functions to store a variable name
1997 * with its prefix. Allocated in cat_prefix_varname(), freed later in
1998 * get_user_var_name().
1999 */
2000
2001static char_u *varnamebuf = NULL;
2002static int varnamebuflen = 0;
2003
2004/*
2005 * Function to concatenate a prefix and a variable name.
2006 */
Bram Moolenaar1bb4de52021-01-13 19:48:46 +01002007 char_u *
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002008cat_prefix_varname(int prefix, char_u *name)
2009{
2010 int len;
2011
2012 len = (int)STRLEN(name) + 3;
2013 if (len > varnamebuflen)
2014 {
2015 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002016 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002017 varnamebuf = alloc(len);
2018 if (varnamebuf == NULL)
2019 {
2020 varnamebuflen = 0;
2021 return NULL;
2022 }
2023 varnamebuflen = len;
2024 }
2025 *varnamebuf = prefix;
2026 varnamebuf[1] = ':';
2027 STRCPY(varnamebuf + 2, name);
2028 return varnamebuf;
2029}
2030
2031/*
2032 * Function given to ExpandGeneric() to obtain the list of user defined
2033 * (global/buffer/window/built-in) variable names.
2034 */
2035 char_u *
2036get_user_var_name(expand_T *xp, int idx)
2037{
2038 static long_u gdone;
2039 static long_u bdone;
2040 static long_u wdone;
2041 static long_u tdone;
2042 static int vidx;
2043 static hashitem_T *hi;
2044 hashtab_T *ht;
2045
2046 if (idx == 0)
2047 {
2048 gdone = bdone = wdone = vidx = 0;
2049 tdone = 0;
2050 }
2051
2052 // Global variables
2053 if (gdone < globvarht.ht_used)
2054 {
2055 if (gdone++ == 0)
2056 hi = globvarht.ht_array;
2057 else
2058 ++hi;
2059 while (HASHITEM_EMPTY(hi))
2060 ++hi;
2061 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
2062 return cat_prefix_varname('g', hi->hi_key);
2063 return hi->hi_key;
2064 }
2065
2066 // b: variables
Bram Moolenaar4ff2f2f2020-10-25 13:22:42 +01002067 ht =
2068#ifdef FEAT_CMDWIN
2069 // In cmdwin, the alternative buffer should be used.
2070 (cmdwin_type != 0 && get_cmdline_type() == NUL) ?
2071 &prevwin->w_buffer->b_vars->dv_hashtab :
2072#endif
2073 &curbuf->b_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002074 if (bdone < ht->ht_used)
2075 {
2076 if (bdone++ == 0)
2077 hi = ht->ht_array;
2078 else
2079 ++hi;
2080 while (HASHITEM_EMPTY(hi))
2081 ++hi;
2082 return cat_prefix_varname('b', hi->hi_key);
2083 }
2084
2085 // w: variables
Bram Moolenaar4ff2f2f2020-10-25 13:22:42 +01002086 ht =
2087#ifdef FEAT_CMDWIN
2088 // In cmdwin, the alternative window should be used.
2089 (cmdwin_type != 0 && get_cmdline_type() == NUL) ?
2090 &prevwin->w_vars->dv_hashtab :
2091#endif
2092 &curwin->w_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002093 if (wdone < ht->ht_used)
2094 {
2095 if (wdone++ == 0)
2096 hi = ht->ht_array;
2097 else
2098 ++hi;
2099 while (HASHITEM_EMPTY(hi))
2100 ++hi;
2101 return cat_prefix_varname('w', hi->hi_key);
2102 }
2103
2104 // t: variables
2105 ht = &curtab->tp_vars->dv_hashtab;
2106 if (tdone < ht->ht_used)
2107 {
2108 if (tdone++ == 0)
2109 hi = ht->ht_array;
2110 else
2111 ++hi;
2112 while (HASHITEM_EMPTY(hi))
2113 ++hi;
2114 return cat_prefix_varname('t', hi->hi_key);
2115 }
2116
2117 // v: variables
2118 if (vidx < VV_LEN)
2119 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
2120
2121 VIM_CLEAR(varnamebuf);
2122 varnamebuflen = 0;
2123 return NULL;
2124}
2125
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002126 char *
2127get_var_special_name(int nr)
2128{
2129 switch (nr)
2130 {
Bram Moolenaara8b8af12021-01-01 15:11:04 +01002131 case VVAL_FALSE: return in_vim9script() ? "false" : "v:false";
2132 case VVAL_TRUE: return in_vim9script() ? "true" : "v:true";
Bram Moolenaar67977822021-01-03 21:53:53 +01002133 case VVAL_NULL: return in_vim9script() ? "null" : "v:null";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002134 case VVAL_NONE: return "v:none";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002135 }
2136 internal_error("get_var_special_name()");
2137 return "42";
2138}
2139
2140/*
2141 * Returns the global variable dictionary
2142 */
2143 dict_T *
2144get_globvar_dict(void)
2145{
2146 return &globvardict;
2147}
2148
2149/*
2150 * Returns the global variable hash table
2151 */
2152 hashtab_T *
2153get_globvar_ht(void)
2154{
2155 return &globvarht;
2156}
2157
2158/*
2159 * Returns the v: variable dictionary
2160 */
2161 dict_T *
2162get_vimvar_dict(void)
2163{
2164 return &vimvardict;
2165}
2166
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002167/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002168 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002169 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002170 */
2171 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002172find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002173{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002174 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2175 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002176
2177 if (di == NULL)
2178 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002179 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002180 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2181 return (int)(vv - vimvars);
2182}
2183
2184
2185/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002186 * Set type of v: variable to "type".
2187 */
2188 void
2189set_vim_var_type(int idx, vartype_T type)
2190{
2191 vimvars[idx].vv_type = type;
2192}
2193
2194/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002195 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002196 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002197 */
2198 void
2199set_vim_var_nr(int idx, varnumber_T val)
2200{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002201 vimvars[idx].vv_nr = val;
2202}
2203
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002204 char *
2205get_vim_var_name(int idx)
2206{
2207 return vimvars[idx].vv_name;
2208}
2209
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002210/*
2211 * Get typval_T v: variable value.
2212 */
2213 typval_T *
2214get_vim_var_tv(int idx)
2215{
2216 return &vimvars[idx].vv_tv;
2217}
2218
2219/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002220 * Set v: variable to "tv". Only accepts the same type.
2221 * Takes over the value of "tv".
2222 */
2223 int
2224set_vim_var_tv(int idx, typval_T *tv)
2225{
2226 if (vimvars[idx].vv_type != tv->v_type)
2227 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002228 emsg(_(e_type_mismatch_for_v_variable));
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002229 clear_tv(tv);
2230 return FAIL;
2231 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002232 // VV_RO is also checked when compiling, but let's check here as well.
2233 if (vimvars[idx].vv_flags & VV_RO)
2234 {
2235 semsg(_(e_readonlyvar), vimvars[idx].vv_name);
2236 return FAIL;
2237 }
2238 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2239 {
2240 semsg(_(e_readonlysbx), vimvars[idx].vv_name);
2241 return FAIL;
2242 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002243 clear_tv(&vimvars[idx].vv_di.di_tv);
2244 vimvars[idx].vv_di.di_tv = *tv;
2245 return OK;
2246}
2247
2248/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002249 * Get number v: variable value.
2250 */
2251 varnumber_T
2252get_vim_var_nr(int idx)
2253{
2254 return vimvars[idx].vv_nr;
2255}
2256
2257/*
2258 * Get string v: variable value. Uses a static buffer, can only be used once.
2259 * If the String variable has never been set, return an empty string.
2260 * Never returns NULL;
2261 */
2262 char_u *
2263get_vim_var_str(int idx)
2264{
2265 return tv_get_string(&vimvars[idx].vv_tv);
2266}
2267
2268/*
2269 * Get List v: variable value. Caller must take care of reference count when
2270 * needed.
2271 */
2272 list_T *
2273get_vim_var_list(int idx)
2274{
2275 return vimvars[idx].vv_list;
2276}
2277
2278/*
2279 * Get Dict v: variable value. Caller must take care of reference count when
2280 * needed.
2281 */
2282 dict_T *
2283get_vim_var_dict(int idx)
2284{
2285 return vimvars[idx].vv_dict;
2286}
2287
2288/*
2289 * Set v:char to character "c".
2290 */
2291 void
2292set_vim_var_char(int c)
2293{
2294 char_u buf[MB_MAXBYTES + 1];
2295
2296 if (has_mbyte)
2297 buf[(*mb_char2bytes)(c, buf)] = NUL;
2298 else
2299 {
2300 buf[0] = c;
2301 buf[1] = NUL;
2302 }
2303 set_vim_var_string(VV_CHAR, buf, -1);
2304}
2305
2306/*
2307 * Set v:count to "count" and v:count1 to "count1".
2308 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2309 */
2310 void
2311set_vcount(
2312 long count,
2313 long count1,
2314 int set_prevcount)
2315{
2316 if (set_prevcount)
2317 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2318 vimvars[VV_COUNT].vv_nr = count;
2319 vimvars[VV_COUNT1].vv_nr = count1;
2320}
2321
2322/*
2323 * Save variables that might be changed as a side effect. Used when executing
2324 * a timer callback.
2325 */
2326 void
2327save_vimvars(vimvars_save_T *vvsave)
2328{
2329 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2330 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2331 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2332}
2333
2334/*
2335 * Restore variables saved by save_vimvars().
2336 */
2337 void
2338restore_vimvars(vimvars_save_T *vvsave)
2339{
2340 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2341 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2342 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2343}
2344
2345/*
2346 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2347 * value.
2348 */
2349 void
2350set_vim_var_string(
2351 int idx,
2352 char_u *val,
2353 int len) // length of "val" to use or -1 (whole string)
2354{
2355 clear_tv(&vimvars[idx].vv_di.di_tv);
2356 vimvars[idx].vv_type = VAR_STRING;
2357 if (val == NULL)
2358 vimvars[idx].vv_str = NULL;
2359 else if (len == -1)
2360 vimvars[idx].vv_str = vim_strsave(val);
2361 else
2362 vimvars[idx].vv_str = vim_strnsave(val, len);
2363}
2364
2365/*
2366 * Set List v: variable to "val".
2367 */
2368 void
2369set_vim_var_list(int idx, list_T *val)
2370{
2371 clear_tv(&vimvars[idx].vv_di.di_tv);
2372 vimvars[idx].vv_type = VAR_LIST;
2373 vimvars[idx].vv_list = val;
2374 if (val != NULL)
2375 ++val->lv_refcount;
2376}
2377
2378/*
2379 * Set Dictionary v: variable to "val".
2380 */
2381 void
2382set_vim_var_dict(int idx, dict_T *val)
2383{
2384 clear_tv(&vimvars[idx].vv_di.di_tv);
2385 vimvars[idx].vv_type = VAR_DICT;
2386 vimvars[idx].vv_dict = val;
2387 if (val != NULL)
2388 {
2389 ++val->dv_refcount;
2390 dict_set_items_ro(val);
2391 }
2392}
2393
2394/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002395 * Set the v:argv list.
2396 */
2397 void
2398set_argv_var(char **argv, int argc)
2399{
2400 list_T *l = list_alloc();
2401 int i;
2402
2403 if (l == NULL)
2404 getout(1);
2405 l->lv_lock = VAR_FIXED;
2406 for (i = 0; i < argc; ++i)
2407 {
2408 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2409 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002410 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002411 }
2412 set_vim_var_list(VV_ARGV, l);
2413}
2414
2415/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002416 * Reset v:register, taking the 'clipboard' setting into account.
2417 */
2418 void
2419reset_reg_var(void)
2420{
2421 int regname = 0;
2422
2423 // Adjust the register according to 'clipboard', so that when
2424 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2425#ifdef FEAT_CLIPBOARD
2426 adjust_clip_reg(&regname);
2427#endif
2428 set_reg_var(regname);
2429}
2430
2431/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002432 * Set v:register if needed.
2433 */
2434 void
2435set_reg_var(int c)
2436{
2437 char_u regname;
2438
2439 if (c == 0 || c == ' ')
2440 regname = '"';
2441 else
2442 regname = c;
2443 // Avoid free/alloc when the value is already right.
2444 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2445 set_vim_var_string(VV_REG, &regname, 1);
2446}
2447
2448/*
2449 * Get or set v:exception. If "oldval" == NULL, return the current value.
2450 * Otherwise, restore the value to "oldval" and return NULL.
2451 * Must always be called in pairs to save and restore v:exception! Does not
2452 * take care of memory allocations.
2453 */
2454 char_u *
2455v_exception(char_u *oldval)
2456{
2457 if (oldval == NULL)
2458 return vimvars[VV_EXCEPTION].vv_str;
2459
2460 vimvars[VV_EXCEPTION].vv_str = oldval;
2461 return NULL;
2462}
2463
2464/*
2465 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2466 * Otherwise, restore the value to "oldval" and return NULL.
2467 * Must always be called in pairs to save and restore v:throwpoint! Does not
2468 * take care of memory allocations.
2469 */
2470 char_u *
2471v_throwpoint(char_u *oldval)
2472{
2473 if (oldval == NULL)
2474 return vimvars[VV_THROWPOINT].vv_str;
2475
2476 vimvars[VV_THROWPOINT].vv_str = oldval;
2477 return NULL;
2478}
2479
2480/*
2481 * Set v:cmdarg.
2482 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2483 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2484 * Must always be called in pairs!
2485 */
2486 char_u *
2487set_cmdarg(exarg_T *eap, char_u *oldarg)
2488{
2489 char_u *oldval;
2490 char_u *newval;
2491 unsigned len;
2492
2493 oldval = vimvars[VV_CMDARG].vv_str;
2494 if (eap == NULL)
2495 {
2496 vim_free(oldval);
2497 vimvars[VV_CMDARG].vv_str = oldarg;
2498 return NULL;
2499 }
2500
2501 if (eap->force_bin == FORCE_BIN)
2502 len = 6;
2503 else if (eap->force_bin == FORCE_NOBIN)
2504 len = 8;
2505 else
2506 len = 0;
2507
2508 if (eap->read_edit)
2509 len += 7;
2510
2511 if (eap->force_ff != 0)
2512 len += 10; // " ++ff=unix"
2513 if (eap->force_enc != 0)
2514 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2515 if (eap->bad_char != 0)
2516 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2517
2518 newval = alloc(len + 1);
2519 if (newval == NULL)
2520 return NULL;
2521
2522 if (eap->force_bin == FORCE_BIN)
2523 sprintf((char *)newval, " ++bin");
2524 else if (eap->force_bin == FORCE_NOBIN)
2525 sprintf((char *)newval, " ++nobin");
2526 else
2527 *newval = NUL;
2528
2529 if (eap->read_edit)
2530 STRCAT(newval, " ++edit");
2531
2532 if (eap->force_ff != 0)
2533 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2534 eap->force_ff == 'u' ? "unix"
2535 : eap->force_ff == 'd' ? "dos"
2536 : "mac");
2537 if (eap->force_enc != 0)
2538 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2539 eap->cmd + eap->force_enc);
2540 if (eap->bad_char == BAD_KEEP)
2541 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2542 else if (eap->bad_char == BAD_DROP)
2543 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2544 else if (eap->bad_char != 0)
2545 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2546 vimvars[VV_CMDARG].vv_str = newval;
2547 return oldval;
2548}
2549
2550/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002551 * Get the value of internal variable "name".
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002552 * If "flags" has EVAL_VAR_IMPORT may return a VAR_ANY with v_number set to the
2553 * imported script ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002554 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2555 */
2556 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002557eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002558 char_u *name,
2559 int len, // length of "name"
2560 typval_T *rettv, // NULL when only checking existence
2561 dictitem_T **dip, // non-NULL when typval's dict item is needed
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002562 int flags) // EVAL_VAR_ flags
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002563{
2564 int ret = OK;
2565 typval_T *tv = NULL;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002566 int found = FALSE;
Bram Moolenaarf055d452021-07-08 20:57:24 +02002567 hashtab_T *ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002568 int cc;
Bram Moolenaarc967d572021-07-08 21:38:50 +02002569 type_T *type = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002570
2571 // truncate the name, so that we can use strcmp()
2572 cc = name[len];
2573 name[len] = NUL;
2574
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002575 // Check for local variable when debugging.
2576 if ((tv = lookup_debug_var(name)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002577 {
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002578 // Check for user-defined variables.
Bram Moolenaarc967d572021-07-08 21:38:50 +02002579 dictitem_T *v = find_var(name, &ht, flags & EVAL_VAR_NOAUTOLOAD);
2580
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002581 if (v != NULL)
2582 {
2583 tv = &v->di_tv;
2584 if (dip != NULL)
2585 *dip = v;
2586 }
Bram Moolenaarc967d572021-07-08 21:38:50 +02002587 else
2588 ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002589 }
2590
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002591 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002592 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002593 imported_T *import;
2594 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
2595
2596 import = find_imported(p, 0, NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002597
2598 // imported variable from another script
2599 if (import != NULL)
2600 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002601 if (import->imp_funcname != NULL)
2602 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002603 found = TRUE;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002604 if (rettv != NULL)
2605 {
2606 rettv->v_type = VAR_FUNC;
2607 rettv->vval.v_string = vim_strsave(import->imp_funcname);
2608 }
2609 }
Bram Moolenaara6294952020-12-27 13:39:50 +01002610 else if (import->imp_flags & IMP_FLAGS_STAR)
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002611 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002612 if ((flags & EVAL_VAR_IMPORT) == 0)
2613 {
2614 if (flags & EVAL_VAR_VERBOSE)
2615 emsg(_(e_import_as_name_not_supported_here));
2616 ret = FAIL;
2617 }
2618 else
2619 {
2620 if (rettv != NULL)
2621 {
2622 rettv->v_type = VAR_ANY;
2623 rettv->vval.v_number = import->imp_sid;
2624 }
2625 found = TRUE;
2626 }
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002627 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002628 else
2629 {
2630 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02002631 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002632 + import->imp_var_vals_idx;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002633 tv = sv->sv_tv;
Bram Moolenaarc967d572021-07-08 21:38:50 +02002634 type = sv->sv_type;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002635 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002636 }
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002637 else if (in_vim9script())
2638 {
2639 ufunc_T *ufunc = find_func(name, FALSE, NULL);
2640
2641 if (ufunc != NULL)
2642 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002643 found = TRUE;
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002644 if (rettv != NULL)
2645 {
2646 rettv->v_type = VAR_FUNC;
2647 rettv->vval.v_string = vim_strsave(ufunc->uf_name);
2648 }
2649 }
2650 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002651 }
2652
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002653 if (!found)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002654 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002655 if (tv == NULL)
2656 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002657 if (rettv != NULL && (flags & EVAL_VAR_VERBOSE))
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002658 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarc620c052020-07-08 15:16:19 +02002659 ret = FAIL;
2660 }
2661 else if (rettv != NULL)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002662 {
Bram Moolenaarf055d452021-07-08 20:57:24 +02002663 if (ht != NULL && ht == get_script_local_ht())
2664 {
Bram Moolenaarc967d572021-07-08 21:38:50 +02002665 svar_T *sv = find_typval_in_script(tv);
Bram Moolenaarf055d452021-07-08 20:57:24 +02002666
Bram Moolenaarf055d452021-07-08 20:57:24 +02002667 if (sv != NULL)
2668 type = sv->sv_type;
2669 }
2670
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002671 // If a list or dict variable wasn't initialized, do it now.
2672 if (tv->v_type == VAR_DICT && tv->vval.v_dict == NULL)
2673 {
2674 tv->vval.v_dict = dict_alloc();
2675 if (tv->vval.v_dict != NULL)
Bram Moolenaarf055d452021-07-08 20:57:24 +02002676 {
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002677 ++tv->vval.v_dict->dv_refcount;
Bram Moolenaarf055d452021-07-08 20:57:24 +02002678 tv->vval.v_dict->dv_type = alloc_type(type);
2679 }
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002680 }
2681 else if (tv->v_type == VAR_LIST && tv->vval.v_list == NULL)
2682 {
2683 tv->vval.v_list = list_alloc();
2684 if (tv->vval.v_list != NULL)
Bram Moolenaarf055d452021-07-08 20:57:24 +02002685 {
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002686 ++tv->vval.v_list->lv_refcount;
Bram Moolenaarf055d452021-07-08 20:57:24 +02002687 tv->vval.v_list->lv_type = alloc_type(type);
2688 }
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002689 }
Bram Moolenaarb7c21af2021-04-18 14:12:31 +02002690 else if (tv->v_type == VAR_BLOB && tv->vval.v_blob == NULL)
2691 {
2692 tv->vval.v_blob = blob_alloc();
2693 if (tv->vval.v_blob != NULL)
2694 ++tv->vval.v_blob->bv_refcount;
2695 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002696 copy_tv(tv, rettv);
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002697 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002698 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002699
2700 name[len] = cc;
2701
2702 return ret;
2703}
2704
2705/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002706 * Check if variable "name[len]" is a local variable or an argument.
2707 * If so, "*eval_lavars_used" is set to TRUE.
2708 */
2709 void
2710check_vars(char_u *name, int len)
2711{
2712 int cc;
2713 char_u *varname;
2714 hashtab_T *ht;
2715
2716 if (eval_lavars_used == NULL)
2717 return;
2718
2719 // truncate the name, so that we can use strcmp()
2720 cc = name[len];
2721 name[len] = NUL;
2722
2723 ht = find_var_ht(name, &varname);
2724 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
2725 {
2726 if (find_var(name, NULL, TRUE) != NULL)
2727 *eval_lavars_used = TRUE;
2728 }
2729
2730 name[len] = cc;
2731}
2732
2733/*
2734 * Find variable "name" in the list of variables.
2735 * Return a pointer to it if found, NULL if not found.
2736 * Careful: "a:0" variables don't have a name.
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002737 * When "htp" is not NULL set "htp" to the hashtab_T used.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002738 */
2739 dictitem_T *
2740find_var(char_u *name, hashtab_T **htp, int no_autoload)
2741{
2742 char_u *varname;
2743 hashtab_T *ht;
2744 dictitem_T *ret = NULL;
2745
2746 ht = find_var_ht(name, &varname);
2747 if (htp != NULL)
2748 *htp = ht;
2749 if (ht == NULL)
2750 return NULL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002751 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002752 if (ret != NULL)
2753 return ret;
2754
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002755 // Search in parent scope for lambda
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002756 ret = find_var_in_scoped_ht(name, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01002757 if (ret != NULL)
2758 return ret;
2759
2760 // in Vim9 script items without a scope can be script-local
2761 if (in_vim9script() && name[0] != NUL && name[1] != ':')
2762 {
2763 ht = get_script_local_ht();
2764 if (ht != NULL)
2765 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002766 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01002767 if (ret != NULL)
2768 {
2769 if (htp != NULL)
2770 *htp = ht;
2771 return ret;
2772 }
2773 }
2774 }
2775
2776 return NULL;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002777}
2778
2779/*
2780 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02002781 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002782 * Returns NULL if not found.
2783 */
2784 dictitem_T *
2785find_var_in_ht(
2786 hashtab_T *ht,
2787 int htname,
2788 char_u *varname,
2789 int no_autoload)
2790{
2791 hashitem_T *hi;
2792
2793 if (*varname == NUL)
2794 {
2795 // Must be something like "s:", otherwise "ht" would be NULL.
2796 switch (htname)
2797 {
2798 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
2799 case 'g': return &globvars_var;
2800 case 'v': return &vimvars_var;
2801 case 'b': return &curbuf->b_bufvar;
2802 case 'w': return &curwin->w_winvar;
2803 case 't': return &curtab->tp_winvar;
2804 case 'l': return get_funccal_local_var();
2805 case 'a': return get_funccal_args_var();
2806 }
2807 return NULL;
2808 }
2809
2810 hi = hash_find(ht, varname);
2811 if (HASHITEM_EMPTY(hi))
2812 {
2813 // For global variables we may try auto-loading the script. If it
2814 // worked find the variable again. Don't auto-load a script if it was
2815 // loaded already, otherwise it would be loaded every time when
2816 // checking if a function name is a Funcref variable.
2817 if (ht == &globvarht && !no_autoload)
2818 {
2819 // Note: script_autoload() may make "hi" invalid. It must either
2820 // be obtained again or not used.
2821 if (!script_autoload(varname, FALSE) || aborting())
2822 return NULL;
2823 hi = hash_find(ht, varname);
2824 }
2825 if (HASHITEM_EMPTY(hi))
2826 return NULL;
2827 }
2828 return HI2DI(hi);
2829}
2830
2831/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002832 * Get the script-local hashtab. NULL if not in a script context.
2833 */
Bram Moolenaar922acbd2020-10-08 21:30:40 +02002834 hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002835get_script_local_ht(void)
2836{
2837 scid_T sid = current_sctx.sc_sid;
2838
Bram Moolenaare3d46852020-08-29 13:39:17 +02002839 if (SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002840 return &SCRIPT_VARS(sid);
2841 return NULL;
2842}
2843
2844/*
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002845 * Look for "name[len]" in script-local variables and functions.
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002846 * When "cmd" is TRUE it must look like a command, a function must be followed
2847 * by "(" or "->".
Bram Moolenaar709664c2020-12-12 14:33:41 +01002848 * Return OK when found, FAIL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002849 */
Bram Moolenaar709664c2020-12-12 14:33:41 +01002850 int
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002851lookup_scriptitem(
Bram Moolenaar709664c2020-12-12 14:33:41 +01002852 char_u *name,
2853 size_t len,
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002854 int cmd,
Bram Moolenaar709664c2020-12-12 14:33:41 +01002855 cctx_T *dummy UNUSED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002856{
2857 hashtab_T *ht = get_script_local_ht();
2858 char_u buffer[30];
2859 char_u *p;
Bram Moolenaar709664c2020-12-12 14:33:41 +01002860 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002861 hashitem_T *hi;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002862 int is_global = FALSE;
2863 char_u *fname = name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002864
2865 if (ht == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01002866 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002867 if (len < sizeof(buffer) - 1)
2868 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02002869 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002870 vim_strncpy(buffer, name, len);
2871 p = buffer;
2872 }
2873 else
2874 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002875 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002876 if (p == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01002877 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002878 }
2879
2880 hi = hash_find(ht, p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01002881 res = HASHITEM_EMPTY(hi) ? FAIL : OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002882
2883 // if not script-local, then perhaps imported
Bram Moolenaar709664c2020-12-12 14:33:41 +01002884 if (res == FAIL && find_imported(p, 0, NULL) != NULL)
2885 res = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002886 if (p != buffer)
2887 vim_free(p);
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002888
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002889 // Find a function, so that a following "->" works.
2890 // When used as a command require "(" or "->" to follow, "Cmd" is a user
2891 // command while "Cmd()" is a function call.
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002892 if (res != OK)
2893 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002894 p = skipwhite(name + len);
2895
2896 if (!cmd || name[len] == '(' || (p[0] == '-' && p[1] == '>'))
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002897 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002898 // Do not check for an internal function, since it might also be a
2899 // valid command, such as ":split" versus "split()".
2900 // Skip "g:" before a function name.
2901 if (name[0] == 'g' && name[1] == ':')
2902 {
2903 is_global = TRUE;
2904 fname = name + 2;
2905 }
2906 if (find_func(fname, is_global, NULL) != NULL)
2907 res = OK;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002908 }
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002909 }
2910
Bram Moolenaar709664c2020-12-12 14:33:41 +01002911 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002912}
2913
2914/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002915 * Find the hashtab used for a variable name.
2916 * Return NULL if the name is not valid.
2917 * Set "varname" to the start of name without ':'.
2918 */
2919 hashtab_T *
2920find_var_ht(char_u *name, char_u **varname)
2921{
2922 hashitem_T *hi;
2923 hashtab_T *ht;
2924
2925 if (name[0] == NUL)
2926 return NULL;
2927 if (name[1] != ':')
2928 {
2929 // The name must not start with a colon or #.
2930 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
2931 return NULL;
2932 *varname = name;
2933
2934 // "version" is "v:version" in all scopes if scriptversion < 3.
2935 // Same for a few other variables marked with VV_COMPAT.
2936 if (current_sctx.sc_version < 3)
2937 {
2938 hi = hash_find(&compat_hashtab, name);
2939 if (!HASHITEM_EMPTY(hi))
2940 return &compat_hashtab;
2941 }
2942
2943 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002944 if (ht != NULL)
2945 return ht; // local variable
2946
Bram Moolenaarf0a40692021-06-11 22:05:47 +02002947 // In Vim9 script items at the script level are script-local, except
2948 // for autoload names.
2949 if (in_vim9script() && vim_strchr(name, AUTOLOAD_CHAR) == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002950 {
2951 ht = get_script_local_ht();
2952 if (ht != NULL)
2953 return ht;
2954 }
2955
2956 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002957 }
2958 *varname = name + 2;
2959 if (*name == 'g') // global variable
2960 return &globvarht;
2961 // There must be no ':' or '#' in the rest of the name, unless g: is used
2962 if (vim_strchr(name + 2, ':') != NULL
2963 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
2964 return NULL;
2965 if (*name == 'b') // buffer variable
2966 return &curbuf->b_vars->dv_hashtab;
2967 if (*name == 'w') // window variable
2968 return &curwin->w_vars->dv_hashtab;
2969 if (*name == 't') // tab page variable
2970 return &curtab->tp_vars->dv_hashtab;
2971 if (*name == 'v') // v: variable
2972 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002973 if (get_current_funccal() != NULL
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002974 && get_current_funccal()->func->uf_def_status == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002975 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002976 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002977 if (*name == 'a') // a: function argument
2978 return get_funccal_args_ht();
2979 if (*name == 'l') // l: local function variable
2980 return get_funccal_local_ht();
2981 }
2982 if (*name == 's') // script variable
2983 {
2984 ht = get_script_local_ht();
2985 if (ht != NULL)
2986 return ht;
2987 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002988 return NULL;
2989}
2990
2991/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002992 * Get the string value of a (global/local) variable.
2993 * Note: see tv_get_string() for how long the pointer remains valid.
2994 * Returns NULL when it doesn't exist.
2995 */
2996 char_u *
2997get_var_value(char_u *name)
2998{
2999 dictitem_T *v;
3000
3001 v = find_var(name, NULL, FALSE);
3002 if (v == NULL)
3003 return NULL;
3004 return tv_get_string(&v->di_tv);
3005}
3006
3007/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003008 * Allocate a new hashtab for a sourced script. It will be used while
3009 * sourcing this script and when executing functions defined in the script.
3010 */
3011 void
3012new_script_vars(scid_T id)
3013{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003014 scriptvar_T *sv;
3015
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01003016 sv = ALLOC_CLEAR_ONE(scriptvar_T);
3017 if (sv == NULL)
3018 return;
3019 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01003020 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003021}
3022
3023/*
3024 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
3025 * point to it.
3026 */
3027 void
3028init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
3029{
3030 hash_init(&dict->dv_hashtab);
3031 dict->dv_lock = 0;
3032 dict->dv_scope = scope;
3033 dict->dv_refcount = DO_NOT_FREE_CNT;
3034 dict->dv_copyID = 0;
3035 dict_var->di_tv.vval.v_dict = dict;
3036 dict_var->di_tv.v_type = VAR_DICT;
3037 dict_var->di_tv.v_lock = VAR_FIXED;
3038 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
3039 dict_var->di_key[0] = NUL;
3040}
3041
3042/*
3043 * Unreference a dictionary initialized by init_var_dict().
3044 */
3045 void
3046unref_var_dict(dict_T *dict)
3047{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003048 // Now the dict needs to be freed if no one else is using it, go back to
3049 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003050 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
3051 dict_unref(dict);
3052}
3053
3054/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003055 * Clean up a list of internal variables.
3056 * Frees all allocated variables and the value they contain.
3057 * Clears hashtab "ht", does not free it.
3058 */
3059 void
3060vars_clear(hashtab_T *ht)
3061{
3062 vars_clear_ext(ht, TRUE);
3063}
3064
3065/*
3066 * Like vars_clear(), but only free the value if "free_val" is TRUE.
3067 */
3068 void
3069vars_clear_ext(hashtab_T *ht, int free_val)
3070{
3071 int todo;
3072 hashitem_T *hi;
3073 dictitem_T *v;
3074
3075 hash_lock(ht);
3076 todo = (int)ht->ht_used;
3077 for (hi = ht->ht_array; todo > 0; ++hi)
3078 {
3079 if (!HASHITEM_EMPTY(hi))
3080 {
3081 --todo;
3082
3083 // Free the variable. Don't remove it from the hashtab,
3084 // ht_array might change then. hash_clear() takes care of it
3085 // later.
3086 v = HI2DI(hi);
3087 if (free_val)
3088 clear_tv(&v->di_tv);
3089 if (v->di_flags & DI_FLAGS_ALLOC)
3090 vim_free(v);
3091 }
3092 }
3093 hash_clear(ht);
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003094 hash_init(ht);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003095}
3096
3097/*
3098 * Delete a variable from hashtab "ht" at item "hi".
3099 * Clear the variable value and free the dictitem.
3100 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02003101 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003102delete_var(hashtab_T *ht, hashitem_T *hi)
3103{
3104 dictitem_T *di = HI2DI(hi);
3105
3106 hash_remove(ht, hi);
3107 clear_tv(&di->di_tv);
3108 vim_free(di);
3109}
3110
3111/*
3112 * List the value of one internal variable.
3113 */
3114 static void
3115list_one_var(dictitem_T *v, char *prefix, int *first)
3116{
3117 char_u *tofree;
3118 char_u *s;
3119 char_u numbuf[NUMBUFLEN];
3120
3121 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
3122 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
3123 s == NULL ? (char_u *)"" : s, first);
3124 vim_free(tofree);
3125}
3126
3127 static void
3128list_one_var_a(
3129 char *prefix,
3130 char_u *name,
3131 int type,
3132 char_u *string,
3133 int *first) // when TRUE clear rest of screen and set to FALSE
3134{
3135 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
3136 msg_start();
3137 msg_puts(prefix);
3138 if (name != NULL) // "a:" vars don't have a name stored
3139 msg_puts((char *)name);
3140 msg_putchar(' ');
3141 msg_advance(22);
3142 if (type == VAR_NUMBER)
3143 msg_putchar('#');
3144 else if (type == VAR_FUNC || type == VAR_PARTIAL)
3145 msg_putchar('*');
3146 else if (type == VAR_LIST)
3147 {
3148 msg_putchar('[');
3149 if (*string == '[')
3150 ++string;
3151 }
3152 else if (type == VAR_DICT)
3153 {
3154 msg_putchar('{');
3155 if (*string == '{')
3156 ++string;
3157 }
3158 else
3159 msg_putchar(' ');
3160
3161 msg_outtrans(string);
3162
3163 if (type == VAR_FUNC || type == VAR_PARTIAL)
3164 msg_puts("()");
3165 if (*first)
3166 {
3167 msg_clr_eos();
3168 *first = FALSE;
3169 }
3170}
3171
3172/*
3173 * Set variable "name" to value in "tv".
3174 * If the variable already exists, the value is updated.
3175 * Otherwise the variable is created.
3176 */
3177 void
3178set_var(
3179 char_u *name,
3180 typval_T *tv,
3181 int copy) // make copy of value in "tv"
3182{
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003183 set_var_const(name, NULL, tv, copy, ASSIGN_DECL, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003184}
3185
3186/*
3187 * Set variable "name" to value in "tv".
3188 * If the variable already exists and "is_const" is FALSE the value is updated.
3189 * Otherwise the variable is created.
3190 */
3191 void
3192set_var_const(
3193 char_u *name,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003194 type_T *type,
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003195 typval_T *tv_arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003196 int copy, // make copy of value in "tv"
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003197 int flags_arg, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003198 int var_idx) // index for ":let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003199{
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003200 typval_T *tv = tv_arg;
3201 typval_T bool_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003202 dictitem_T *di;
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
3243 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003244 if (di == NULL)
3245 di = find_var_in_scoped_ht(name, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003246
3247 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
Bram Moolenaar98b4f142020-08-08 15:46:01 +02003248 && var_wrong_func_name(name, di == NULL))
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003249 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003250
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003251 if (need_convert_to_bool(type, tv))
3252 {
3253 // Destination is a bool and the value is not, but it can be converted.
3254 CLEAR_FIELD(bool_tv);
3255 bool_tv.v_type = VAR_BOOL;
3256 bool_tv.vval.v_number = tv2bool(tv) ? VVAL_TRUE : VVAL_FALSE;
3257 tv = &bool_tv;
3258 }
3259
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003260 if (di != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003261 {
Bram Moolenaar6c3843c2021-03-04 12:38:21 +01003262 // Item already exists. Allowed to replace when reloading.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003263 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003264 {
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003265 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
3266 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003267 {
3268 emsg(_(e_cannot_mod));
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003269 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003270 }
3271
Bram Moolenaar12be7342021-03-31 21:47:33 +02003272 if (is_script_local && vim9script
3273 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0)
3274 {
3275 semsg(_(e_redefining_script_item_str), name);
3276 goto failed;
3277 }
3278
Bram Moolenaare535db82021-03-31 21:07:24 +02003279 if (var_in_vim9script)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003280 {
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003281 where_T where;
3282
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003283 // check the type and adjust to bool if needed
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003284 where.wt_index = var_idx;
3285 where.wt_variable = TRUE;
3286 if (check_script_var_type(&di->di_tv, tv, name, where) == FAIL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003287 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003288 }
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02003289
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003290 if (var_check_permission(di, name) == FAIL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003291 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003292 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003293 else
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003294 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003295 // can only redefine once
3296 di->di_flags &= ~DI_FLAGS_RELOAD;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003297
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003298 // A Vim9 script-local variable is also present in sn_all_vars and
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003299 // sn_var_vals. It may set "type" from "tv".
Bram Moolenaare535db82021-03-31 21:07:24 +02003300 if (var_in_vim9script)
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003301 update_vim9_script_var(FALSE, di, flags, tv, &type,
3302 (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003303 }
3304
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003305 // existing variable, need to clear the value
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003306
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003307 // Handle setting internal di: variables separately where needed to
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003308 // prevent changing the type.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003309 if (ht == &vimvarht)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003310 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003311 if (di->di_tv.v_type == VAR_STRING)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003312 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003313 VIM_CLEAR(di->di_tv.vval.v_string);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003314 if (copy || tv->v_type != VAR_STRING)
3315 {
3316 char_u *val = tv_get_string(tv);
3317
3318 // Careful: when assigning to v:errmsg and tv_get_string()
Bram Moolenaar4b96df52020-01-26 22:00:26 +01003319 // causes an error message the variable will already be set.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003320 if (di->di_tv.vval.v_string == NULL)
3321 di->di_tv.vval.v_string = vim_strsave(val);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003322 }
3323 else
3324 {
3325 // Take over the string to avoid an extra alloc/free.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003326 di->di_tv.vval.v_string = tv->vval.v_string;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003327 tv->vval.v_string = NULL;
3328 }
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003329 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003330 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003331 else if (di->di_tv.v_type == VAR_NUMBER)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003332 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003333 di->di_tv.vval.v_number = tv_get_number(tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003334 if (STRCMP(varname, "searchforward") == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003335 set_search_direction(di->di_tv.vval.v_number ? '/' : '?');
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003336#ifdef FEAT_SEARCH_EXTRA
3337 else if (STRCMP(varname, "hlsearch") == 0)
3338 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003339 no_hlsearch = !di->di_tv.vval.v_number;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003340 redraw_all_later(SOME_VALID);
3341 }
3342#endif
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003343 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003344 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003345 else if (di->di_tv.v_type != tv->v_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003346 {
3347 semsg(_("E963: setting %s to value with wrong type"), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003348 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003349 }
3350 }
3351
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003352 clear_tv(&di->di_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003353 }
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003354 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003355 {
Bram Moolenaar6c3843c2021-03-04 12:38:21 +01003356 // Item not found, check if a function already exists.
3357 if (is_script_local && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003358 && lookup_scriptitem(name, STRLEN(name), FALSE, NULL) == OK)
Bram Moolenaar6c3843c2021-03-04 12:38:21 +01003359 {
3360 semsg(_(e_redefining_script_item_str), name);
3361 goto failed;
3362 }
3363
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003364 // add a new variable
Bram Moolenaare535db82021-03-31 21:07:24 +02003365 if (var_in_vim9script && (flags & ASSIGN_NO_DECL))
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003366 {
3367 semsg(_(e_unknown_variable_str), name);
3368 goto failed;
3369 }
3370
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003371 // Can't add "v:" or "a:" variable.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003372 if (ht == &vimvarht || ht == get_funccal_args_ht())
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003373 {
3374 semsg(_(e_illvar), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003375 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003376 }
3377
Bram Moolenaar03290b82020-12-19 16:30:44 +01003378 // Make sure the variable name is valid. In Vim9 script an autoload
3379 // variable must be prefixed with "g:".
3380 if (!valid_varname(varname, !vim9script
3381 || STRNCMP(name, "g:", 2) == 0))
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003382 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003383
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003384 di = alloc(sizeof(dictitem_T) + STRLEN(varname));
3385 if (di == NULL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003386 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003387 STRCPY(di->di_key, varname);
3388 if (hash_add(ht, DI2HIKEY(di)) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003389 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003390 vim_free(di);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003391 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003392 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003393 di->di_flags = DI_FLAGS_ALLOC;
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003394 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003395 di->di_flags |= DI_FLAGS_LOCK;
3396
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003397 // A Vim9 script-local variable is also added to sn_all_vars and
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003398 // sn_var_vals. It may set "type" from "tv".
Bram Moolenaare535db82021-03-31 21:07:24 +02003399 if (var_in_vim9script)
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003400 update_vim9_script_var(TRUE, di, flags, tv, &type,
3401 (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003402 }
3403
3404 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003405 copy_tv(tv, &di->di_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003406 else
3407 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003408 di->di_tv = *tv;
3409 di->di_tv.v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003410 init_tv(tv);
3411 }
3412
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003413 if (vim9script && type != NULL)
3414 {
3415 if (type->tt_type == VAR_DICT && di->di_tv.vval.v_dict != NULL)
3416 di->di_tv.vval.v_dict->dv_type = alloc_type(type);
3417 else if (type->tt_type == VAR_LIST && di->di_tv.vval.v_list != NULL)
3418 di->di_tv.vval.v_list->lv_type = alloc_type(type);
3419 }
3420
Bram Moolenaar1dcf55d2020-12-22 22:07:30 +01003421 // ":const var = value" locks the value
3422 // ":final var = value" locks "var"
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003423 if (flags & ASSIGN_CONST)
Bram Moolenaar021bda52020-08-17 21:07:22 +02003424 // Like :lockvar! name: lock the value and what it contains, but only
3425 // if the reference count is up to one. That locks only literal
3426 // values.
3427 item_lock(&di->di_tv, DICT_MAXNEST, TRUE, TRUE);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003428 return;
3429failed:
3430 if (!copy)
3431 clear_tv(tv_arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003432}
3433
3434/*
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003435 * Check in this order for backwards compatibility:
3436 * - Whether the variable is read-only
3437 * - Whether the variable value is locked
3438 * - Whether the variable is locked
3439 */
3440 int
3441var_check_permission(dictitem_T *di, char_u *name)
3442{
3443 if (var_check_ro(di->di_flags, name, FALSE)
3444 || value_check_lock(di->di_tv.v_lock, name, FALSE)
3445 || var_check_lock(di->di_flags, name, FALSE))
3446 return FAIL;
3447 return OK;
3448}
3449
3450/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003451 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
3452 * Also give an error message.
3453 */
3454 int
3455var_check_ro(int flags, char_u *name, int use_gettext)
3456{
3457 if (flags & DI_FLAGS_RO)
3458 {
3459 semsg(_(e_readonlyvar), use_gettext ? (char_u *)_(name) : name);
3460 return TRUE;
3461 }
3462 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
3463 {
3464 semsg(_(e_readonlysbx), use_gettext ? (char_u *)_(name) : name);
3465 return TRUE;
3466 }
3467 return FALSE;
3468}
3469
3470/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003471 * Return TRUE if di_flags "flags" indicates variable "name" is locked.
3472 * Also give an error message.
3473 */
3474 int
3475var_check_lock(int flags, char_u *name, int use_gettext)
3476{
3477 if (flags & DI_FLAGS_LOCK)
3478 {
3479 semsg(_(e_variable_is_locked_str),
3480 use_gettext ? (char_u *)_(name) : name);
3481 return TRUE;
3482 }
3483 return FALSE;
3484}
3485
3486/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003487 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
3488 * Also give an error message.
3489 */
3490 int
3491var_check_fixed(int flags, char_u *name, int use_gettext)
3492{
3493 if (flags & DI_FLAGS_FIX)
3494 {
3495 semsg(_("E795: Cannot delete variable %s"),
3496 use_gettext ? (char_u *)_(name) : name);
3497 return TRUE;
3498 }
3499 return FALSE;
3500}
3501
3502/*
3503 * Check if a funcref is assigned to a valid variable name.
3504 * Return TRUE and give an error if not.
3505 */
3506 int
Bram Moolenaar98b4f142020-08-08 15:46:01 +02003507var_wrong_func_name(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003508 char_u *name, // points to start of variable name
3509 int new_var) // TRUE when creating the variable
3510{
Bram Moolenaar32154662021-03-28 21:14:06 +02003511 // Allow for w: b: s: and t:. In Vim9 script s: is not allowed, because
3512 // the name can be used without the s: prefix.
3513 if (!((vim_strchr((char_u *)"wbt", name[0]) != NULL
3514 || (!in_vim9script() && name[0] == 's')) && name[1] == ':')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003515 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
3516 ? name[2] : name[0]))
3517 {
3518 semsg(_("E704: Funcref variable name must start with a capital: %s"),
3519 name);
3520 return TRUE;
3521 }
3522 // Don't allow hiding a function. When "v" is not NULL we might be
3523 // assigning another function to the same var, the type is checked
3524 // below.
3525 if (new_var && function_exists(name, FALSE))
3526 {
3527 semsg(_("E705: Variable name conflicts with existing function: %s"),
3528 name);
3529 return TRUE;
3530 }
3531 return FALSE;
3532}
3533
3534/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003535 * Return TRUE if "flags" indicates variable "name" has a locked (immutable)
3536 * value. Also give an error message, using "name" or _("name") when
3537 * "use_gettext" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003538 */
3539 int
Bram Moolenaara187c432020-09-16 21:08:28 +02003540value_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003541{
3542 if (lock & VAR_LOCKED)
3543 {
3544 semsg(_("E741: Value is locked: %s"),
3545 name == NULL ? (char_u *)_("Unknown")
3546 : use_gettext ? (char_u *)_(name)
3547 : name);
3548 return TRUE;
3549 }
3550 if (lock & VAR_FIXED)
3551 {
3552 semsg(_("E742: Cannot change value of %s"),
3553 name == NULL ? (char_u *)_("Unknown")
3554 : use_gettext ? (char_u *)_(name)
3555 : name);
3556 return TRUE;
3557 }
3558 return FALSE;
3559}
3560
3561/*
Bram Moolenaar03290b82020-12-19 16:30:44 +01003562 * Check if a variable name is valid. When "autoload" is true "#" is allowed.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003563 * Return FALSE and give an error if not.
3564 */
3565 int
Bram Moolenaar03290b82020-12-19 16:30:44 +01003566valid_varname(char_u *varname, int autoload)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003567{
3568 char_u *p;
3569
3570 for (p = varname; *p != NUL; ++p)
3571 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
Bram Moolenaar03290b82020-12-19 16:30:44 +01003572 && !(autoload && *p == AUTOLOAD_CHAR))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003573 {
3574 semsg(_(e_illvar), varname);
3575 return FALSE;
3576 }
3577 return TRUE;
3578}
3579
3580/*
3581 * getwinvar() and gettabwinvar()
3582 */
3583 static void
3584getwinvar(
3585 typval_T *argvars,
3586 typval_T *rettv,
3587 int off) // 1 for gettabwinvar()
3588{
3589 win_T *win;
3590 char_u *varname;
3591 dictitem_T *v;
3592 tabpage_T *tp = NULL;
3593 int done = FALSE;
3594 win_T *oldcurwin;
3595 tabpage_T *oldtabpage;
3596 int need_switch_win;
3597
3598 if (off == 1)
3599 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3600 else
3601 tp = curtab;
3602 win = find_win_by_nr(&argvars[off], tp);
3603 varname = tv_get_string_chk(&argvars[off + 1]);
3604 ++emsg_off;
3605
3606 rettv->v_type = VAR_STRING;
3607 rettv->vval.v_string = NULL;
3608
3609 if (win != NULL && varname != NULL)
3610 {
3611 // Set curwin to be our win, temporarily. Also set the tabpage,
3612 // otherwise the window is not valid. Only do this when needed,
3613 // autocommands get blocked.
3614 need_switch_win = !(tp == curtab && win == curwin);
3615 if (!need_switch_win
3616 || switch_win(&oldcurwin, &oldtabpage, win, tp, TRUE) == OK)
3617 {
3618 if (*varname == '&')
3619 {
3620 if (varname[1] == NUL)
3621 {
3622 // get all window-local options in a dict
3623 dict_T *opts = get_winbuf_options(FALSE);
3624
3625 if (opts != NULL)
3626 {
3627 rettv_dict_set(rettv, opts);
3628 done = TRUE;
3629 }
3630 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003631 else if (eval_option(&varname, rettv, 1) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003632 // window-local-option
3633 done = TRUE;
3634 }
3635 else
3636 {
3637 // Look up the variable.
3638 // Let getwinvar({nr}, "") return the "w:" dictionary.
3639 v = find_var_in_ht(&win->w_vars->dv_hashtab, 'w',
3640 varname, FALSE);
3641 if (v != NULL)
3642 {
3643 copy_tv(&v->di_tv, rettv);
3644 done = TRUE;
3645 }
3646 }
3647 }
3648
3649 if (need_switch_win)
3650 // restore previous notion of curwin
3651 restore_win(oldcurwin, oldtabpage, TRUE);
3652 }
3653
3654 if (!done && argvars[off + 2].v_type != VAR_UNKNOWN)
3655 // use the default return value
3656 copy_tv(&argvars[off + 2], rettv);
3657
3658 --emsg_off;
3659}
3660
3661/*
Bram Moolenaar191929b2020-08-19 21:20:49 +02003662 * Set option "varname" to the value of "varp" for the current buffer/window.
3663 */
3664 static void
3665set_option_from_tv(char_u *varname, typval_T *varp)
3666{
3667 long numval = 0;
3668 char_u *strval;
3669 char_u nbuf[NUMBUFLEN];
3670 int error = FALSE;
3671
Bram Moolenaar31a201a2021-01-03 14:47:25 +01003672 if (varp->v_type == VAR_BOOL)
Bram Moolenaarb0d81822021-01-03 15:55:10 +01003673 {
Bram Moolenaar31a201a2021-01-03 14:47:25 +01003674 numval = (long)varp->vval.v_number;
Bram Moolenaarb0d81822021-01-03 15:55:10 +01003675 strval = (char_u *)"0"; // avoid using "false"
3676 }
3677 else
3678 {
3679 if (!in_vim9script() || varp->v_type != VAR_STRING)
3680 numval = (long)tv_get_number_chk(varp, &error);
3681 strval = tv_get_string_buf_chk(varp, nbuf);
3682 }
Bram Moolenaar191929b2020-08-19 21:20:49 +02003683 if (!error && strval != NULL)
3684 set_option_value(varname, numval, strval, OPT_LOCAL);
3685}
3686
3687/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003688 * "setwinvar()" and "settabwinvar()" functions
3689 */
3690 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003691setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003692{
3693 win_T *win;
3694 win_T *save_curwin;
3695 tabpage_T *save_curtab;
3696 int need_switch_win;
3697 char_u *varname, *winvarname;
3698 typval_T *varp;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003699 tabpage_T *tp = NULL;
3700
3701 if (check_secure())
3702 return;
3703
3704 if (off == 1)
3705 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3706 else
3707 tp = curtab;
3708 win = find_win_by_nr(&argvars[off], tp);
3709 varname = tv_get_string_chk(&argvars[off + 1]);
3710 varp = &argvars[off + 2];
3711
3712 if (win != NULL && varname != NULL && varp != NULL)
3713 {
3714 need_switch_win = !(tp == curtab && win == curwin);
3715 if (!need_switch_win
3716 || switch_win(&save_curwin, &save_curtab, win, tp, TRUE) == OK)
3717 {
3718 if (*varname == '&')
Bram Moolenaar191929b2020-08-19 21:20:49 +02003719 set_option_from_tv(varname + 1, varp);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003720 else
3721 {
3722 winvarname = alloc(STRLEN(varname) + 3);
3723 if (winvarname != NULL)
3724 {
3725 STRCPY(winvarname, "w:");
3726 STRCPY(winvarname + 2, varname);
3727 set_var(winvarname, varp, TRUE);
3728 vim_free(winvarname);
3729 }
3730 }
3731 }
3732 if (need_switch_win)
3733 restore_win(save_curwin, save_curtab, TRUE);
3734 }
3735}
3736
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003737/*
3738 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
3739 * v:option_type, and v:option_command.
3740 */
3741 void
3742reset_v_option_vars(void)
3743{
3744 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
3745 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
3746 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
3747 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
3748 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
3749 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
3750}
3751
3752/*
3753 * Add an assert error to v:errors.
3754 */
3755 void
3756assert_error(garray_T *gap)
3757{
3758 struct vimvar *vp = &vimvars[VV_ERRORS];
3759
3760 if (vp->vv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003761 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003762 set_vim_var_list(VV_ERRORS, list_alloc());
3763 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
3764}
3765
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003766 int
3767var_exists(char_u *var)
3768{
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003769 char_u *arg = var;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003770 char_u *name;
3771 char_u *tofree;
3772 typval_T tv;
3773 int len = 0;
3774 int n = FALSE;
3775
3776 // get_name_len() takes care of expanding curly braces
3777 name = var;
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003778 len = get_name_len(&arg, &tofree, TRUE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003779 if (len > 0)
3780 {
3781 if (tofree != NULL)
3782 name = tofree;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003783 n = (eval_variable(name, len, &tv, NULL,
3784 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003785 if (n)
3786 {
3787 // handle d.key, l[idx], f(expr)
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003788 arg = skipwhite(arg);
3789 n = (handle_subscript(&arg, &tv, &EVALARG_EVALUATE, FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003790 if (n)
3791 clear_tv(&tv);
3792 }
3793 }
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003794 if (*arg != NUL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003795 n = FALSE;
3796
3797 vim_free(tofree);
3798 return n;
3799}
3800
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003801static lval_T *redir_lval = NULL;
3802#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
3803static garray_T redir_ga; // only valid when redir_lval is not NULL
3804static char_u *redir_endp = NULL;
3805static char_u *redir_varname = NULL;
3806
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003807 int
3808alloc_redir_lval(void)
3809{
3810 redir_lval = ALLOC_CLEAR_ONE(lval_T);
3811 if (redir_lval == NULL)
3812 return FAIL;
3813 return OK;
3814}
3815
3816 void
3817clear_redir_lval(void)
3818{
3819 VIM_CLEAR(redir_lval);
3820}
3821
3822 void
3823init_redir_ga(void)
3824{
3825 ga_init2(&redir_ga, (int)sizeof(char), 500);
3826}
3827
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003828/*
3829 * Start recording command output to a variable
3830 * When "append" is TRUE append to an existing variable.
3831 * Returns OK if successfully completed the setup. FAIL otherwise.
3832 */
3833 int
3834var_redir_start(char_u *name, int append)
3835{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003836 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003837 typval_T tv;
3838
3839 // Catch a bad name early.
3840 if (!eval_isnamec1(*name))
3841 {
3842 emsg(_(e_invarg));
3843 return FAIL;
3844 }
3845
3846 // Make a copy of the name, it is used in redir_lval until redir ends.
3847 redir_varname = vim_strsave(name);
3848 if (redir_varname == NULL)
3849 return FAIL;
3850
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003851 if (alloc_redir_lval() == FAIL)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003852 {
3853 var_redir_stop();
3854 return FAIL;
3855 }
3856
3857 // The output is stored in growarray "redir_ga" until redirection ends.
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003858 init_redir_ga();
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003859
3860 // Parse the variable name (can be a dict or list entry).
3861 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
3862 FNE_CHECK_START);
3863 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
3864 {
3865 clear_lval(redir_lval);
3866 if (redir_endp != NULL && *redir_endp != NUL)
3867 // Trailing characters are present after the variable name
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003868 semsg(_(e_trailing_arg), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003869 else
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003870 semsg(_(e_invarg2), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003871 redir_endp = NULL; // don't store a value, only cleanup
3872 var_redir_stop();
3873 return FAIL;
3874 }
3875
3876 // check if we can write to the variable: set it to or append an empty
3877 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003878 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003879 tv.v_type = VAR_STRING;
3880 tv.vval.v_string = (char_u *)"";
3881 if (append)
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02003882 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003883 ASSIGN_NO_DECL, (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003884 else
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02003885 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003886 ASSIGN_NO_DECL, (char_u *)"=", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003887 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003888 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003889 {
3890 redir_endp = NULL; // don't store a value, only cleanup
3891 var_redir_stop();
3892 return FAIL;
3893 }
3894
3895 return OK;
3896}
3897
3898/*
3899 * Append "value[value_len]" to the variable set by var_redir_start().
3900 * The actual appending is postponed until redirection ends, because the value
3901 * appended may in fact be the string we write to, changing it may cause freed
3902 * memory to be used:
3903 * :redir => foo
3904 * :let foo
3905 * :redir END
3906 */
3907 void
3908var_redir_str(char_u *value, int value_len)
3909{
3910 int len;
3911
3912 if (redir_lval == NULL)
3913 return;
3914
3915 if (value_len == -1)
3916 len = (int)STRLEN(value); // Append the entire string
3917 else
3918 len = value_len; // Append only "value_len" characters
3919
3920 if (ga_grow(&redir_ga, len) == OK)
3921 {
3922 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
3923 redir_ga.ga_len += len;
3924 }
3925 else
3926 var_redir_stop();
3927}
3928
3929/*
3930 * Stop redirecting command output to a variable.
3931 * Frees the allocated memory.
3932 */
3933 void
3934var_redir_stop(void)
3935{
3936 typval_T tv;
3937
3938 if (EVALCMD_BUSY)
3939 {
3940 redir_lval = NULL;
3941 return;
3942 }
3943
3944 if (redir_lval != NULL)
3945 {
3946 // If there was no error: assign the text to the variable.
3947 if (redir_endp != NULL)
3948 {
3949 ga_append(&redir_ga, NUL); // Append the trailing NUL.
3950 tv.v_type = VAR_STRING;
3951 tv.vval.v_string = redir_ga.ga_data;
3952 // Call get_lval() again, if it's inside a Dict or List it may
3953 // have changed.
3954 redir_endp = get_lval(redir_varname, NULL, redir_lval,
3955 FALSE, FALSE, 0, FNE_CHECK_START);
3956 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003957 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003958 (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003959 clear_lval(redir_lval);
3960 }
3961
3962 // free the collected output
3963 VIM_CLEAR(redir_ga.ga_data);
3964
3965 VIM_CLEAR(redir_lval);
3966 }
3967 VIM_CLEAR(redir_varname);
3968}
3969
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003970/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003971 * Get the collected redirected text and clear redir_ga.
3972 */
3973 char_u *
3974get_clear_redir_ga(void)
3975{
3976 char_u *res;
3977
3978 ga_append(&redir_ga, NUL); // Append the trailing NUL.
3979 res = redir_ga.ga_data;
3980 redir_ga.ga_data = NULL;
3981 return res;
3982}
3983
3984/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003985 * "gettabvar()" function
3986 */
3987 void
3988f_gettabvar(typval_T *argvars, typval_T *rettv)
3989{
3990 win_T *oldcurwin;
3991 tabpage_T *tp, *oldtabpage;
3992 dictitem_T *v;
3993 char_u *varname;
3994 int done = FALSE;
3995
3996 rettv->v_type = VAR_STRING;
3997 rettv->vval.v_string = NULL;
3998
3999 varname = tv_get_string_chk(&argvars[1]);
4000 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4001 if (tp != NULL && varname != NULL)
4002 {
4003 // Set tp to be our tabpage, temporarily. Also set the window to the
4004 // first window in the tabpage, otherwise the window is not valid.
4005 if (switch_win(&oldcurwin, &oldtabpage,
4006 tp == curtab || tp->tp_firstwin == NULL ? firstwin
4007 : tp->tp_firstwin, tp, TRUE) == OK)
4008 {
4009 // look up the variable
4010 // Let gettabvar({nr}, "") return the "t:" dictionary.
4011 v = find_var_in_ht(&tp->tp_vars->dv_hashtab, 't', varname, FALSE);
4012 if (v != NULL)
4013 {
4014 copy_tv(&v->di_tv, rettv);
4015 done = TRUE;
4016 }
4017 }
4018
4019 // restore previous notion of curwin
4020 restore_win(oldcurwin, oldtabpage, TRUE);
4021 }
4022
4023 if (!done && argvars[2].v_type != VAR_UNKNOWN)
4024 copy_tv(&argvars[2], rettv);
4025}
4026
4027/*
4028 * "gettabwinvar()" function
4029 */
4030 void
4031f_gettabwinvar(typval_T *argvars, typval_T *rettv)
4032{
4033 getwinvar(argvars, rettv, 1);
4034}
4035
4036/*
4037 * "getwinvar()" function
4038 */
4039 void
4040f_getwinvar(typval_T *argvars, typval_T *rettv)
4041{
4042 getwinvar(argvars, rettv, 0);
4043}
4044
4045/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004046 * "getbufvar()" function
4047 */
4048 void
4049f_getbufvar(typval_T *argvars, typval_T *rettv)
4050{
4051 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004052 char_u *varname;
4053 dictitem_T *v;
4054 int done = FALSE;
4055
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004056 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004057 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004058
4059 rettv->v_type = VAR_STRING;
4060 rettv->vval.v_string = NULL;
4061
4062 if (buf != NULL && varname != NULL)
4063 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004064 if (*varname == '&')
4065 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004066 buf_T *save_curbuf = curbuf;
4067
4068 // set curbuf to be our buf, temporarily
4069 curbuf = buf;
4070
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004071 if (varname[1] == NUL)
4072 {
4073 // get all buffer-local options in a dict
4074 dict_T *opts = get_winbuf_options(TRUE);
4075
4076 if (opts != NULL)
4077 {
4078 rettv_dict_set(rettv, opts);
4079 done = TRUE;
4080 }
4081 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02004082 else if (eval_option(&varname, rettv, TRUE) == OK)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004083 // buffer-local-option
4084 done = TRUE;
Bram Moolenaar86015452020-03-29 15:12:15 +02004085
4086 // restore previous notion of curbuf
4087 curbuf = save_curbuf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004088 }
4089 else
4090 {
4091 // Look up the variable.
Bram Moolenaar52592752020-04-03 18:43:35 +02004092 if (*varname == NUL)
4093 // Let getbufvar({nr}, "") return the "b:" dictionary.
4094 v = &buf->b_bufvar;
4095 else
4096 v = find_var_in_ht(&buf->b_vars->dv_hashtab, 'b',
4097 varname, FALSE);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004098 if (v != NULL)
4099 {
4100 copy_tv(&v->di_tv, rettv);
4101 done = TRUE;
4102 }
4103 }
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004104 }
4105
4106 if (!done && argvars[2].v_type != VAR_UNKNOWN)
4107 // use the default value
4108 copy_tv(&argvars[2], rettv);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004109}
4110
4111/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004112 * "settabvar()" function
4113 */
4114 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004115f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004116{
4117 tabpage_T *save_curtab;
4118 tabpage_T *tp;
4119 char_u *varname, *tabvarname;
4120 typval_T *varp;
4121
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004122 if (check_secure())
4123 return;
4124
4125 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4126 varname = tv_get_string_chk(&argvars[1]);
4127 varp = &argvars[2];
4128
4129 if (varname != NULL && varp != NULL && tp != NULL)
4130 {
4131 save_curtab = curtab;
4132 goto_tabpage_tp(tp, FALSE, FALSE);
4133
4134 tabvarname = alloc(STRLEN(varname) + 3);
4135 if (tabvarname != NULL)
4136 {
4137 STRCPY(tabvarname, "t:");
4138 STRCPY(tabvarname + 2, varname);
4139 set_var(tabvarname, varp, TRUE);
4140 vim_free(tabvarname);
4141 }
4142
4143 // Restore current tabpage
4144 if (valid_tabpage(save_curtab))
4145 goto_tabpage_tp(save_curtab, FALSE, FALSE);
4146 }
4147}
4148
4149/*
4150 * "settabwinvar()" function
4151 */
4152 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004153f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004154{
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004155 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004156}
4157
4158/*
4159 * "setwinvar()" function
4160 */
4161 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004162f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004163{
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004164 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004165}
4166
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004167/*
4168 * "setbufvar()" function
4169 */
4170 void
4171f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
4172{
4173 buf_T *buf;
4174 char_u *varname, *bufvarname;
4175 typval_T *varp;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004176
4177 if (check_secure())
4178 return;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004179 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004180 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004181 varp = &argvars[2];
4182
4183 if (buf != NULL && varname != NULL && varp != NULL)
4184 {
4185 if (*varname == '&')
4186 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004187 aco_save_T aco;
4188
4189 // set curbuf to be our buf, temporarily
4190 aucmd_prepbuf(&aco, buf);
4191
Bram Moolenaar191929b2020-08-19 21:20:49 +02004192 set_option_from_tv(varname + 1, varp);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004193
4194 // reset notion of buffer
4195 aucmd_restbuf(&aco);
4196 }
4197 else
4198 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004199 bufvarname = alloc(STRLEN(varname) + 3);
4200 if (bufvarname != NULL)
4201 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004202 buf_T *save_curbuf = curbuf;
4203
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004204 curbuf = buf;
4205 STRCPY(bufvarname, "b:");
4206 STRCPY(bufvarname + 2, varname);
4207 set_var(bufvarname, varp, TRUE);
4208 vim_free(bufvarname);
4209 curbuf = save_curbuf;
4210 }
4211 }
4212 }
4213}
4214
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004215/*
4216 * Get a callback from "arg". It can be a Funcref or a function name.
4217 * When "arg" is zero return an empty string.
4218 * "cb_name" is not allocated.
4219 * "cb_name" is set to NULL for an invalid argument.
4220 */
4221 callback_T
4222get_callback(typval_T *arg)
4223{
Bram Moolenaar14e579092020-03-07 16:59:25 +01004224 callback_T res;
4225 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004226
4227 res.cb_free_name = FALSE;
4228 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
4229 {
4230 res.cb_partial = arg->vval.v_partial;
4231 ++res.cb_partial->pt_refcount;
4232 res.cb_name = partial_name(res.cb_partial);
4233 }
4234 else
4235 {
4236 res.cb_partial = NULL;
Bram Moolenaar14e579092020-03-07 16:59:25 +01004237 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
4238 && isdigit(*arg->vval.v_string))
4239 r = FAIL;
4240 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004241 {
4242 // Note that we don't make a copy of the string.
4243 res.cb_name = arg->vval.v_string;
4244 func_ref(res.cb_name);
4245 }
4246 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004247 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004248 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01004249 r = FAIL;
4250
4251 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004252 {
4253 emsg(_("E921: Invalid callback argument"));
4254 res.cb_name = NULL;
4255 }
4256 }
4257 return res;
4258}
4259
4260/*
4261 * Copy a callback into a typval_T.
4262 */
4263 void
4264put_callback(callback_T *cb, typval_T *tv)
4265{
4266 if (cb->cb_partial != NULL)
4267 {
4268 tv->v_type = VAR_PARTIAL;
4269 tv->vval.v_partial = cb->cb_partial;
4270 ++tv->vval.v_partial->pt_refcount;
4271 }
4272 else
4273 {
4274 tv->v_type = VAR_FUNC;
4275 tv->vval.v_string = vim_strsave(cb->cb_name);
4276 func_ref(cb->cb_name);
4277 }
4278}
4279
4280/*
4281 * Make a copy of "src" into "dest", allocating the function name if needed,
4282 * without incrementing the refcount.
4283 */
4284 void
4285set_callback(callback_T *dest, callback_T *src)
4286{
4287 if (src->cb_partial == NULL)
4288 {
4289 // just a function name, make a copy
4290 dest->cb_name = vim_strsave(src->cb_name);
4291 dest->cb_free_name = TRUE;
4292 }
4293 else
4294 {
4295 // cb_name is a pointer into cb_partial
4296 dest->cb_name = src->cb_name;
4297 dest->cb_free_name = FALSE;
4298 }
4299 dest->cb_partial = src->cb_partial;
4300}
4301
4302/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02004303 * Copy callback from "src" to "dest", incrementing the refcounts.
4304 */
4305 void
4306copy_callback(callback_T *dest, callback_T *src)
4307{
4308 dest->cb_partial = src->cb_partial;
4309 if (dest->cb_partial != NULL)
4310 {
4311 dest->cb_name = src->cb_name;
4312 dest->cb_free_name = FALSE;
4313 ++dest->cb_partial->pt_refcount;
4314 }
4315 else
4316 {
4317 dest->cb_name = vim_strsave(src->cb_name);
4318 dest->cb_free_name = TRUE;
4319 func_ref(src->cb_name);
4320 }
4321}
4322
4323/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004324 * Unref/free "callback" returned by get_callback() or set_callback().
4325 */
4326 void
4327free_callback(callback_T *callback)
4328{
4329 if (callback->cb_partial != NULL)
4330 {
4331 partial_unref(callback->cb_partial);
4332 callback->cb_partial = NULL;
4333 }
4334 else if (callback->cb_name != NULL)
4335 func_unref(callback->cb_name);
4336 if (callback->cb_free_name)
4337 {
4338 vim_free(callback->cb_name);
4339 callback->cb_free_name = FALSE;
4340 }
4341 callback->cb_name = NULL;
4342}
4343
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004344#endif // FEAT_EVAL