blob: f3b4da222bf36e1e452d9f6524ef765cb4e01586 [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)
1337 emsg(_(e_letunexp));
1338 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))
1382 emsg(_(e_letunexp));
1383 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 }
1442 }
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001443 else if (opt_type == gov_string
1444 && stringval != NULL && s != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001445 {
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001446 // string
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001447 s = concat_str(stringval, s);
1448 vim_free(stringval);
1449 stringval = s;
1450 }
1451 }
1452 }
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001453
1454 if (!failed)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001455 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001456 if (opt_type != gov_string || s != NULL)
Bram Moolenaar0aae4802020-08-16 21:29:05 +02001457 {
1458 set_option_value(arg, n, s, opt_flags);
1459 arg_end = p;
1460 }
1461 else
1462 emsg(_(e_stringreq));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001463 }
1464 *p = c1;
1465 vim_free(stringval);
1466 }
1467 }
1468
1469 // ":let @r = expr": Set register contents.
1470 else if (*arg == '@')
1471 {
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02001472 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1473 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001474 {
1475 emsg(_("E996: Cannot lock a register"));
1476 return NULL;
1477 }
1478 ++arg;
1479 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
1480 semsg(_(e_letwrong), op);
1481 else if (endchars != NULL
1482 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
1483 emsg(_(e_letunexp));
1484 else
1485 {
1486 char_u *ptofree = NULL;
1487 char_u *s;
1488
1489 p = tv_get_string_chk(tv);
1490 if (p != NULL && op != NULL && *op == '.')
1491 {
1492 s = get_reg_contents(*arg == '@' ? '"' : *arg, GREG_EXPR_SRC);
1493 if (s != NULL)
1494 {
1495 p = ptofree = concat_str(s, p);
1496 vim_free(s);
1497 }
1498 }
1499 if (p != NULL)
1500 {
1501 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
1502 arg_end = arg + 1;
1503 }
1504 vim_free(ptofree);
1505 }
1506 }
1507
1508 // ":let var = expr": Set internal variable.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001509 // ":let var: type = expr": Set internal variable with type.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001510 // ":let {expr} = expr": Idem, name made with curly braces
1511 else if (eval_isnamec1(*arg) || *arg == '{')
1512 {
1513 lval_T lv;
1514
Bram Moolenaar8f22f5c2020-12-19 22:10:13 +01001515 p = get_lval(arg, tv, &lv, FALSE, FALSE,
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001516 (flags & (ASSIGN_NO_DECL | ASSIGN_DECL))
1517 ? GLV_NO_DECL : 0, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001518 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001519 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001520 if (endchars != NULL && vim_strchr(endchars,
1521 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001522 emsg(_(e_letunexp));
1523 else
1524 {
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001525 set_var_lval(&lv, p, tv, copy, flags, op, var_idx);
Bram Moolenaara3589a02021-04-14 13:30:46 +02001526 arg_end = lv.ll_name_end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001527 }
1528 }
1529 clear_lval(&lv);
1530 }
1531
1532 else
1533 semsg(_(e_invarg2), arg);
1534
1535 return arg_end;
1536}
1537
1538/*
1539 * ":unlet[!] var1 ... " command.
1540 */
1541 void
1542ex_unlet(exarg_T *eap)
1543{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001544 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001545}
1546
1547/*
1548 * ":lockvar" and ":unlockvar" commands
1549 */
1550 void
1551ex_lockvar(exarg_T *eap)
1552{
1553 char_u *arg = eap->arg;
1554 int deep = 2;
1555
1556 if (eap->forceit)
1557 deep = -1;
1558 else if (vim_isdigit(*arg))
1559 {
1560 deep = getdigits(&arg);
1561 arg = skipwhite(arg);
1562 }
1563
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001564 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001565}
1566
1567/*
1568 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001569 * Also used for Vim9 script. "callback" is invoked as:
1570 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001571 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001572 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001573ex_unletlock(
1574 exarg_T *eap,
1575 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001576 int deep,
1577 int glv_flags,
1578 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1579 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001580{
1581 char_u *arg = argstart;
1582 char_u *name_end;
1583 int error = FALSE;
1584 lval_T lv;
1585
1586 do
1587 {
1588 if (*arg == '$')
1589 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001590 lv.ll_name = arg;
1591 lv.ll_tv = NULL;
1592 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001593 if (get_env_len(&arg) == 0)
1594 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001595 semsg(_(e_invarg2), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001596 return;
1597 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001598 if (!error && !eap->skip
1599 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1600 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001601 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001602 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001603 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001604 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001605 // Parse the name and find the end.
1606 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
Bram Moolenaarc3689572021-01-01 19:40:02 +01001607 glv_flags | GLV_NO_DECL, FNE_CHECK_START);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001608 if (lv.ll_name == NULL)
1609 error = TRUE; // error but continue parsing
1610 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1611 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001612 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001613 if (name_end != NULL)
1614 {
1615 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001616 semsg(_(e_trailing_arg), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001617 }
1618 if (!(eap->skip || error))
1619 clear_lval(&lv);
1620 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001621 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001622
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001623 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001624 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001625 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001626
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001627 if (!eap->skip)
1628 clear_lval(&lv);
1629 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001630
1631 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001632 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001633
1634 eap->nextcmd = check_nextcmd(arg);
1635}
1636
1637 static int
1638do_unlet_var(
1639 lval_T *lp,
1640 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001641 exarg_T *eap,
1642 int deep UNUSED,
1643 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001644{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001645 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001646 int ret = OK;
1647 int cc;
1648
1649 if (lp->ll_tv == NULL)
1650 {
1651 cc = *name_end;
1652 *name_end = NUL;
1653
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001654 // Environment variable, normal name or expanded name.
1655 if (*lp->ll_name == '$')
1656 vim_unsetenv(lp->ll_name + 1);
1657 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001658 ret = FAIL;
1659 *name_end = cc;
1660 }
1661 else if ((lp->ll_list != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001662 && value_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001663 || (lp->ll_dict != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001664 && value_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001665 return FAIL;
1666 else if (lp->ll_range)
1667 {
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01001668 if (list_unlet_range(lp->ll_list, lp->ll_li, lp->ll_name, lp->ll_n1,
1669 !lp->ll_empty2, lp->ll_n2) == FAIL)
1670 return FAIL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001671 }
1672 else
1673 {
1674 if (lp->ll_list != NULL)
1675 // unlet a List item.
1676 listitem_remove(lp->ll_list, lp->ll_li);
1677 else
1678 // unlet a Dictionary item.
1679 dictitem_remove(lp->ll_dict, lp->ll_di);
1680 }
1681
1682 return ret;
1683}
1684
1685/*
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01001686 * Unlet one item or a range of items from a list.
1687 * Return OK or FAIL.
1688 */
1689 int
1690list_unlet_range(
1691 list_T *l,
1692 listitem_T *li_first,
1693 char_u *name,
1694 long n1_arg,
1695 int has_n2,
1696 long n2)
1697{
1698 listitem_T *li = li_first;
1699 int n1 = n1_arg;
1700
1701 while (li != NULL && (!has_n2 || n2 >= n1))
1702 {
1703 if (value_check_lock(li->li_tv.v_lock, name, FALSE))
1704 return FAIL;
1705 li = li->li_next;
1706 ++n1;
1707 }
1708
1709 // Delete a range of List items.
1710 li = li_first;
1711 n1 = n1_arg;
1712 while (li != NULL && (!has_n2 || n2 >= n1))
1713 {
1714 listitem_T *next = li->li_next;
1715
1716 listitem_remove(l, li);
1717 li = next;
1718 ++n1;
1719 }
1720 return OK;
1721}
1722/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001723 * "unlet" a variable. Return OK if it existed, FAIL if not.
1724 * When "forceit" is TRUE don't complain if the variable doesn't exist.
1725 */
1726 int
1727do_unlet(char_u *name, int forceit)
1728{
1729 hashtab_T *ht;
1730 hashitem_T *hi;
1731 char_u *varname;
1732 dict_T *d;
1733 dictitem_T *di;
1734
Bram Moolenaar9aed7292020-12-18 15:38:00 +01001735 // can't :unlet a script variable in Vim9 script
Bram Moolenaareb6880b2020-07-12 17:07:05 +02001736 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001737 return FAIL;
1738
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001739 ht = find_var_ht(name, &varname);
Bram Moolenaar9aed7292020-12-18 15:38:00 +01001740
1741 // can't :unlet a script variable in Vim9 script from a function
1742 if (ht == get_script_local_ht()
1743 && SCRIPT_ID_VALID(current_sctx.sc_sid)
1744 && SCRIPT_ITEM(current_sctx.sc_sid)->sn_version
1745 == SCRIPT_VERSION_VIM9
1746 && check_vim9_unlet(name) == FAIL)
1747 return FAIL;
1748
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001749 if (ht != NULL && *varname != NUL)
1750 {
1751 d = get_current_funccal_dict(ht);
1752 if (d == NULL)
1753 {
1754 if (ht == &globvarht)
1755 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001756 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001757 d = &vimvardict;
1758 else
1759 {
1760 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
1761 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
1762 }
1763 if (d == NULL)
1764 {
1765 internal_error("do_unlet()");
1766 return FAIL;
1767 }
1768 }
1769 hi = hash_find(ht, varname);
1770 if (HASHITEM_EMPTY(hi))
1771 hi = find_hi_in_scoped_ht(name, &ht);
1772 if (hi != NULL && !HASHITEM_EMPTY(hi))
1773 {
1774 di = HI2DI(hi);
1775 if (var_check_fixed(di->di_flags, name, FALSE)
1776 || var_check_ro(di->di_flags, name, FALSE)
Bram Moolenaara187c432020-09-16 21:08:28 +02001777 || value_check_lock(d->dv_lock, name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001778 return FAIL;
1779
1780 delete_var(ht, hi);
1781 return OK;
1782 }
1783 }
1784 if (forceit)
1785 return OK;
1786 semsg(_("E108: No such variable: \"%s\""), name);
1787 return FAIL;
1788}
1789
1790/*
1791 * Lock or unlock variable indicated by "lp".
1792 * "deep" is the levels to go (-1 for unlimited);
1793 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
1794 */
1795 static int
1796do_lock_var(
1797 lval_T *lp,
1798 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001799 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001800 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001801 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001802{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001803 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001804 int ret = OK;
1805 int cc;
1806 dictitem_T *di;
1807
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001808 if (lp->ll_tv == NULL)
1809 {
1810 cc = *name_end;
1811 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001812 if (*lp->ll_name == '$')
1813 {
1814 semsg(_(e_lock_unlock), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001815 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001816 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001817 else
1818 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001819 // Normal name or expanded name.
1820 di = find_var(lp->ll_name, NULL, TRUE);
1821 if (di == NULL)
1822 ret = FAIL;
1823 else if ((di->di_flags & DI_FLAGS_FIX)
1824 && di->di_tv.v_type != VAR_DICT
1825 && di->di_tv.v_type != VAR_LIST)
1826 {
1827 // For historic reasons this error is not given for a list or
1828 // dict. E.g., the b: dict could be locked/unlocked.
1829 semsg(_(e_lock_unlock), lp->ll_name);
1830 ret = FAIL;
1831 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001832 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001833 {
1834 if (lock)
1835 di->di_flags |= DI_FLAGS_LOCK;
1836 else
1837 di->di_flags &= ~DI_FLAGS_LOCK;
Bram Moolenaara187c432020-09-16 21:08:28 +02001838 if (deep != 0)
1839 item_lock(&di->di_tv, deep, lock, FALSE);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001840 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001841 }
1842 *name_end = cc;
1843 }
Bram Moolenaara187c432020-09-16 21:08:28 +02001844 else if (deep == 0)
1845 {
1846 // nothing to do
1847 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001848 else if (lp->ll_range)
1849 {
1850 listitem_T *li = lp->ll_li;
1851
1852 // (un)lock a range of List items.
1853 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
1854 {
Bram Moolenaar021bda52020-08-17 21:07:22 +02001855 item_lock(&li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001856 li = li->li_next;
1857 ++lp->ll_n1;
1858 }
1859 }
1860 else if (lp->ll_list != NULL)
1861 // (un)lock a List item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001862 item_lock(&lp->ll_li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001863 else
1864 // (un)lock a Dictionary item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001865 item_lock(&lp->ll_di->di_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001866
1867 return ret;
1868}
1869
1870/*
1871 * Lock or unlock an item. "deep" is nr of levels to go.
Bram Moolenaar021bda52020-08-17 21:07:22 +02001872 * When "check_refcount" is TRUE do not lock a list or dict with a reference
1873 * count larger than 1.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001874 */
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02001875 void
Bram Moolenaar021bda52020-08-17 21:07:22 +02001876item_lock(typval_T *tv, int deep, int lock, int check_refcount)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001877{
1878 static int recurse = 0;
1879 list_T *l;
1880 listitem_T *li;
1881 dict_T *d;
1882 blob_T *b;
1883 hashitem_T *hi;
1884 int todo;
1885
1886 if (recurse >= DICT_MAXNEST)
1887 {
1888 emsg(_("E743: variable nested too deep for (un)lock"));
1889 return;
1890 }
1891 if (deep == 0)
1892 return;
1893 ++recurse;
1894
1895 // lock/unlock the item itself
1896 if (lock)
1897 tv->v_lock |= VAR_LOCKED;
1898 else
1899 tv->v_lock &= ~VAR_LOCKED;
1900
1901 switch (tv->v_type)
1902 {
1903 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02001904 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001905 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001906 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001907 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001908 case VAR_STRING:
1909 case VAR_FUNC:
1910 case VAR_PARTIAL:
1911 case VAR_FLOAT:
1912 case VAR_SPECIAL:
1913 case VAR_JOB:
1914 case VAR_CHANNEL:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02001915 case VAR_INSTR:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001916 break;
1917
1918 case VAR_BLOB:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001919 if ((b = tv->vval.v_blob) != NULL
1920 && !(check_refcount && b->bv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001921 {
1922 if (lock)
1923 b->bv_lock |= VAR_LOCKED;
1924 else
1925 b->bv_lock &= ~VAR_LOCKED;
1926 }
1927 break;
1928 case VAR_LIST:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001929 if ((l = tv->vval.v_list) != NULL
1930 && !(check_refcount && l->lv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001931 {
1932 if (lock)
1933 l->lv_lock |= VAR_LOCKED;
1934 else
1935 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001936 if ((deep < 0 || deep > 1) && l->lv_first != &range_list_item)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001937 // recursive: lock/unlock the items the List contains
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001938 FOR_ALL_LIST_ITEMS(l, li)
Bram Moolenaar021bda52020-08-17 21:07:22 +02001939 item_lock(&li->li_tv, deep - 1, lock, check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001940 }
1941 break;
1942 case VAR_DICT:
Bram Moolenaar021bda52020-08-17 21:07:22 +02001943 if ((d = tv->vval.v_dict) != NULL
1944 && !(check_refcount && d->dv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001945 {
1946 if (lock)
1947 d->dv_lock |= VAR_LOCKED;
1948 else
1949 d->dv_lock &= ~VAR_LOCKED;
1950 if (deep < 0 || deep > 1)
1951 {
1952 // recursive: lock/unlock the items the List contains
1953 todo = (int)d->dv_hashtab.ht_used;
1954 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
1955 {
1956 if (!HASHITEM_EMPTY(hi))
1957 {
1958 --todo;
Bram Moolenaar021bda52020-08-17 21:07:22 +02001959 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock,
1960 check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001961 }
1962 }
1963 }
1964 }
1965 }
1966 --recurse;
1967}
1968
Bram Moolenaarda6c0332019-09-01 16:01:30 +02001969#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
1970/*
1971 * Delete all "menutrans_" variables.
1972 */
1973 void
1974del_menutrans_vars(void)
1975{
1976 hashitem_T *hi;
1977 int todo;
1978
1979 hash_lock(&globvarht);
1980 todo = (int)globvarht.ht_used;
1981 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
1982 {
1983 if (!HASHITEM_EMPTY(hi))
1984 {
1985 --todo;
1986 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
1987 delete_var(&globvarht, hi);
1988 }
1989 }
1990 hash_unlock(&globvarht);
1991}
1992#endif
1993
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001994/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001995 * Local string buffer for the next two functions to store a variable name
1996 * with its prefix. Allocated in cat_prefix_varname(), freed later in
1997 * get_user_var_name().
1998 */
1999
2000static char_u *varnamebuf = NULL;
2001static int varnamebuflen = 0;
2002
2003/*
2004 * Function to concatenate a prefix and a variable name.
2005 */
Bram Moolenaar1bb4de52021-01-13 19:48:46 +01002006 char_u *
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002007cat_prefix_varname(int prefix, char_u *name)
2008{
2009 int len;
2010
2011 len = (int)STRLEN(name) + 3;
2012 if (len > varnamebuflen)
2013 {
2014 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002015 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002016 varnamebuf = alloc(len);
2017 if (varnamebuf == NULL)
2018 {
2019 varnamebuflen = 0;
2020 return NULL;
2021 }
2022 varnamebuflen = len;
2023 }
2024 *varnamebuf = prefix;
2025 varnamebuf[1] = ':';
2026 STRCPY(varnamebuf + 2, name);
2027 return varnamebuf;
2028}
2029
2030/*
2031 * Function given to ExpandGeneric() to obtain the list of user defined
2032 * (global/buffer/window/built-in) variable names.
2033 */
2034 char_u *
2035get_user_var_name(expand_T *xp, int idx)
2036{
2037 static long_u gdone;
2038 static long_u bdone;
2039 static long_u wdone;
2040 static long_u tdone;
2041 static int vidx;
2042 static hashitem_T *hi;
2043 hashtab_T *ht;
2044
2045 if (idx == 0)
2046 {
2047 gdone = bdone = wdone = vidx = 0;
2048 tdone = 0;
2049 }
2050
2051 // Global variables
2052 if (gdone < globvarht.ht_used)
2053 {
2054 if (gdone++ == 0)
2055 hi = globvarht.ht_array;
2056 else
2057 ++hi;
2058 while (HASHITEM_EMPTY(hi))
2059 ++hi;
2060 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
2061 return cat_prefix_varname('g', hi->hi_key);
2062 return hi->hi_key;
2063 }
2064
2065 // b: variables
Bram Moolenaar4ff2f2f2020-10-25 13:22:42 +01002066 ht =
2067#ifdef FEAT_CMDWIN
2068 // In cmdwin, the alternative buffer should be used.
2069 (cmdwin_type != 0 && get_cmdline_type() == NUL) ?
2070 &prevwin->w_buffer->b_vars->dv_hashtab :
2071#endif
2072 &curbuf->b_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002073 if (bdone < ht->ht_used)
2074 {
2075 if (bdone++ == 0)
2076 hi = ht->ht_array;
2077 else
2078 ++hi;
2079 while (HASHITEM_EMPTY(hi))
2080 ++hi;
2081 return cat_prefix_varname('b', hi->hi_key);
2082 }
2083
2084 // w: variables
Bram Moolenaar4ff2f2f2020-10-25 13:22:42 +01002085 ht =
2086#ifdef FEAT_CMDWIN
2087 // In cmdwin, the alternative window should be used.
2088 (cmdwin_type != 0 && get_cmdline_type() == NUL) ?
2089 &prevwin->w_vars->dv_hashtab :
2090#endif
2091 &curwin->w_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002092 if (wdone < ht->ht_used)
2093 {
2094 if (wdone++ == 0)
2095 hi = ht->ht_array;
2096 else
2097 ++hi;
2098 while (HASHITEM_EMPTY(hi))
2099 ++hi;
2100 return cat_prefix_varname('w', hi->hi_key);
2101 }
2102
2103 // t: variables
2104 ht = &curtab->tp_vars->dv_hashtab;
2105 if (tdone < ht->ht_used)
2106 {
2107 if (tdone++ == 0)
2108 hi = ht->ht_array;
2109 else
2110 ++hi;
2111 while (HASHITEM_EMPTY(hi))
2112 ++hi;
2113 return cat_prefix_varname('t', hi->hi_key);
2114 }
2115
2116 // v: variables
2117 if (vidx < VV_LEN)
2118 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
2119
2120 VIM_CLEAR(varnamebuf);
2121 varnamebuflen = 0;
2122 return NULL;
2123}
2124
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002125 char *
2126get_var_special_name(int nr)
2127{
2128 switch (nr)
2129 {
Bram Moolenaara8b8af12021-01-01 15:11:04 +01002130 case VVAL_FALSE: return in_vim9script() ? "false" : "v:false";
2131 case VVAL_TRUE: return in_vim9script() ? "true" : "v:true";
Bram Moolenaar67977822021-01-03 21:53:53 +01002132 case VVAL_NULL: return in_vim9script() ? "null" : "v:null";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002133 case VVAL_NONE: return "v:none";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002134 }
2135 internal_error("get_var_special_name()");
2136 return "42";
2137}
2138
2139/*
2140 * Returns the global variable dictionary
2141 */
2142 dict_T *
2143get_globvar_dict(void)
2144{
2145 return &globvardict;
2146}
2147
2148/*
2149 * Returns the global variable hash table
2150 */
2151 hashtab_T *
2152get_globvar_ht(void)
2153{
2154 return &globvarht;
2155}
2156
2157/*
2158 * Returns the v: variable dictionary
2159 */
2160 dict_T *
2161get_vimvar_dict(void)
2162{
2163 return &vimvardict;
2164}
2165
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002166/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002167 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002168 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002169 */
2170 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002171find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002172{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002173 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2174 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002175
2176 if (di == NULL)
2177 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002178 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002179 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2180 return (int)(vv - vimvars);
2181}
2182
2183
2184/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002185 * Set type of v: variable to "type".
2186 */
2187 void
2188set_vim_var_type(int idx, vartype_T type)
2189{
2190 vimvars[idx].vv_type = type;
2191}
2192
2193/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002194 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002195 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002196 */
2197 void
2198set_vim_var_nr(int idx, varnumber_T val)
2199{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002200 vimvars[idx].vv_nr = val;
2201}
2202
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002203 char *
2204get_vim_var_name(int idx)
2205{
2206 return vimvars[idx].vv_name;
2207}
2208
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002209/*
2210 * Get typval_T v: variable value.
2211 */
2212 typval_T *
2213get_vim_var_tv(int idx)
2214{
2215 return &vimvars[idx].vv_tv;
2216}
2217
2218/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002219 * Set v: variable to "tv". Only accepts the same type.
2220 * Takes over the value of "tv".
2221 */
2222 int
2223set_vim_var_tv(int idx, typval_T *tv)
2224{
2225 if (vimvars[idx].vv_type != tv->v_type)
2226 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002227 emsg(_(e_type_mismatch_for_v_variable));
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002228 clear_tv(tv);
2229 return FAIL;
2230 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002231 // VV_RO is also checked when compiling, but let's check here as well.
2232 if (vimvars[idx].vv_flags & VV_RO)
2233 {
2234 semsg(_(e_readonlyvar), vimvars[idx].vv_name);
2235 return FAIL;
2236 }
2237 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2238 {
2239 semsg(_(e_readonlysbx), vimvars[idx].vv_name);
2240 return FAIL;
2241 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002242 clear_tv(&vimvars[idx].vv_di.di_tv);
2243 vimvars[idx].vv_di.di_tv = *tv;
2244 return OK;
2245}
2246
2247/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002248 * Get number v: variable value.
2249 */
2250 varnumber_T
2251get_vim_var_nr(int idx)
2252{
2253 return vimvars[idx].vv_nr;
2254}
2255
2256/*
2257 * Get string v: variable value. Uses a static buffer, can only be used once.
2258 * If the String variable has never been set, return an empty string.
2259 * Never returns NULL;
2260 */
2261 char_u *
2262get_vim_var_str(int idx)
2263{
2264 return tv_get_string(&vimvars[idx].vv_tv);
2265}
2266
2267/*
2268 * Get List v: variable value. Caller must take care of reference count when
2269 * needed.
2270 */
2271 list_T *
2272get_vim_var_list(int idx)
2273{
2274 return vimvars[idx].vv_list;
2275}
2276
2277/*
2278 * Get Dict v: variable value. Caller must take care of reference count when
2279 * needed.
2280 */
2281 dict_T *
2282get_vim_var_dict(int idx)
2283{
2284 return vimvars[idx].vv_dict;
2285}
2286
2287/*
2288 * Set v:char to character "c".
2289 */
2290 void
2291set_vim_var_char(int c)
2292{
2293 char_u buf[MB_MAXBYTES + 1];
2294
2295 if (has_mbyte)
2296 buf[(*mb_char2bytes)(c, buf)] = NUL;
2297 else
2298 {
2299 buf[0] = c;
2300 buf[1] = NUL;
2301 }
2302 set_vim_var_string(VV_CHAR, buf, -1);
2303}
2304
2305/*
2306 * Set v:count to "count" and v:count1 to "count1".
2307 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2308 */
2309 void
2310set_vcount(
2311 long count,
2312 long count1,
2313 int set_prevcount)
2314{
2315 if (set_prevcount)
2316 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2317 vimvars[VV_COUNT].vv_nr = count;
2318 vimvars[VV_COUNT1].vv_nr = count1;
2319}
2320
2321/*
2322 * Save variables that might be changed as a side effect. Used when executing
2323 * a timer callback.
2324 */
2325 void
2326save_vimvars(vimvars_save_T *vvsave)
2327{
2328 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2329 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2330 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2331}
2332
2333/*
2334 * Restore variables saved by save_vimvars().
2335 */
2336 void
2337restore_vimvars(vimvars_save_T *vvsave)
2338{
2339 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2340 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2341 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2342}
2343
2344/*
2345 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2346 * value.
2347 */
2348 void
2349set_vim_var_string(
2350 int idx,
2351 char_u *val,
2352 int len) // length of "val" to use or -1 (whole string)
2353{
2354 clear_tv(&vimvars[idx].vv_di.di_tv);
2355 vimvars[idx].vv_type = VAR_STRING;
2356 if (val == NULL)
2357 vimvars[idx].vv_str = NULL;
2358 else if (len == -1)
2359 vimvars[idx].vv_str = vim_strsave(val);
2360 else
2361 vimvars[idx].vv_str = vim_strnsave(val, len);
2362}
2363
2364/*
2365 * Set List v: variable to "val".
2366 */
2367 void
2368set_vim_var_list(int idx, list_T *val)
2369{
2370 clear_tv(&vimvars[idx].vv_di.di_tv);
2371 vimvars[idx].vv_type = VAR_LIST;
2372 vimvars[idx].vv_list = val;
2373 if (val != NULL)
2374 ++val->lv_refcount;
2375}
2376
2377/*
2378 * Set Dictionary v: variable to "val".
2379 */
2380 void
2381set_vim_var_dict(int idx, dict_T *val)
2382{
2383 clear_tv(&vimvars[idx].vv_di.di_tv);
2384 vimvars[idx].vv_type = VAR_DICT;
2385 vimvars[idx].vv_dict = val;
2386 if (val != NULL)
2387 {
2388 ++val->dv_refcount;
2389 dict_set_items_ro(val);
2390 }
2391}
2392
2393/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002394 * Set the v:argv list.
2395 */
2396 void
2397set_argv_var(char **argv, int argc)
2398{
2399 list_T *l = list_alloc();
2400 int i;
2401
2402 if (l == NULL)
2403 getout(1);
2404 l->lv_lock = VAR_FIXED;
2405 for (i = 0; i < argc; ++i)
2406 {
2407 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2408 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002409 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002410 }
2411 set_vim_var_list(VV_ARGV, l);
2412}
2413
2414/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002415 * Reset v:register, taking the 'clipboard' setting into account.
2416 */
2417 void
2418reset_reg_var(void)
2419{
2420 int regname = 0;
2421
2422 // Adjust the register according to 'clipboard', so that when
2423 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2424#ifdef FEAT_CLIPBOARD
2425 adjust_clip_reg(&regname);
2426#endif
2427 set_reg_var(regname);
2428}
2429
2430/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002431 * Set v:register if needed.
2432 */
2433 void
2434set_reg_var(int c)
2435{
2436 char_u regname;
2437
2438 if (c == 0 || c == ' ')
2439 regname = '"';
2440 else
2441 regname = c;
2442 // Avoid free/alloc when the value is already right.
2443 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2444 set_vim_var_string(VV_REG, &regname, 1);
2445}
2446
2447/*
2448 * Get or set v:exception. If "oldval" == NULL, return the current value.
2449 * Otherwise, restore the value to "oldval" and return NULL.
2450 * Must always be called in pairs to save and restore v:exception! Does not
2451 * take care of memory allocations.
2452 */
2453 char_u *
2454v_exception(char_u *oldval)
2455{
2456 if (oldval == NULL)
2457 return vimvars[VV_EXCEPTION].vv_str;
2458
2459 vimvars[VV_EXCEPTION].vv_str = oldval;
2460 return NULL;
2461}
2462
2463/*
2464 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2465 * Otherwise, restore the value to "oldval" and return NULL.
2466 * Must always be called in pairs to save and restore v:throwpoint! Does not
2467 * take care of memory allocations.
2468 */
2469 char_u *
2470v_throwpoint(char_u *oldval)
2471{
2472 if (oldval == NULL)
2473 return vimvars[VV_THROWPOINT].vv_str;
2474
2475 vimvars[VV_THROWPOINT].vv_str = oldval;
2476 return NULL;
2477}
2478
2479/*
2480 * Set v:cmdarg.
2481 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2482 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2483 * Must always be called in pairs!
2484 */
2485 char_u *
2486set_cmdarg(exarg_T *eap, char_u *oldarg)
2487{
2488 char_u *oldval;
2489 char_u *newval;
2490 unsigned len;
2491
2492 oldval = vimvars[VV_CMDARG].vv_str;
2493 if (eap == NULL)
2494 {
2495 vim_free(oldval);
2496 vimvars[VV_CMDARG].vv_str = oldarg;
2497 return NULL;
2498 }
2499
2500 if (eap->force_bin == FORCE_BIN)
2501 len = 6;
2502 else if (eap->force_bin == FORCE_NOBIN)
2503 len = 8;
2504 else
2505 len = 0;
2506
2507 if (eap->read_edit)
2508 len += 7;
2509
2510 if (eap->force_ff != 0)
2511 len += 10; // " ++ff=unix"
2512 if (eap->force_enc != 0)
2513 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2514 if (eap->bad_char != 0)
2515 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2516
2517 newval = alloc(len + 1);
2518 if (newval == NULL)
2519 return NULL;
2520
2521 if (eap->force_bin == FORCE_BIN)
2522 sprintf((char *)newval, " ++bin");
2523 else if (eap->force_bin == FORCE_NOBIN)
2524 sprintf((char *)newval, " ++nobin");
2525 else
2526 *newval = NUL;
2527
2528 if (eap->read_edit)
2529 STRCAT(newval, " ++edit");
2530
2531 if (eap->force_ff != 0)
2532 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2533 eap->force_ff == 'u' ? "unix"
2534 : eap->force_ff == 'd' ? "dos"
2535 : "mac");
2536 if (eap->force_enc != 0)
2537 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2538 eap->cmd + eap->force_enc);
2539 if (eap->bad_char == BAD_KEEP)
2540 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2541 else if (eap->bad_char == BAD_DROP)
2542 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2543 else if (eap->bad_char != 0)
2544 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2545 vimvars[VV_CMDARG].vv_str = newval;
2546 return oldval;
2547}
2548
2549/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002550 * Get the value of internal variable "name".
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002551 * If "flags" has EVAL_VAR_IMPORT may return a VAR_ANY with v_number set to the
2552 * imported script ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002553 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2554 */
2555 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002556eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002557 char_u *name,
2558 int len, // length of "name"
2559 typval_T *rettv, // NULL when only checking existence
2560 dictitem_T **dip, // non-NULL when typval's dict item is needed
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002561 int flags) // EVAL_VAR_ flags
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002562{
2563 int ret = OK;
2564 typval_T *tv = NULL;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002565 int found = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002566 dictitem_T *v;
2567 int cc;
2568
2569 // truncate the name, so that we can use strcmp()
2570 cc = name[len];
2571 name[len] = NUL;
2572
2573 // Check for user-defined variables.
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002574 v = find_var(name, NULL, flags & EVAL_VAR_NOAUTOLOAD);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002575 if (v != NULL)
2576 {
2577 tv = &v->di_tv;
2578 if (dip != NULL)
2579 *dip = v;
2580 }
2581
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002582 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002583 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002584 imported_T *import;
2585 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
2586
2587 import = find_imported(p, 0, NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002588
2589 // imported variable from another script
2590 if (import != NULL)
2591 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002592 if (import->imp_funcname != NULL)
2593 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002594 found = TRUE;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002595 if (rettv != NULL)
2596 {
2597 rettv->v_type = VAR_FUNC;
2598 rettv->vval.v_string = vim_strsave(import->imp_funcname);
2599 }
2600 }
Bram Moolenaara6294952020-12-27 13:39:50 +01002601 else if (import->imp_flags & IMP_FLAGS_STAR)
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002602 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002603 if ((flags & EVAL_VAR_IMPORT) == 0)
2604 {
2605 if (flags & EVAL_VAR_VERBOSE)
2606 emsg(_(e_import_as_name_not_supported_here));
2607 ret = FAIL;
2608 }
2609 else
2610 {
2611 if (rettv != NULL)
2612 {
2613 rettv->v_type = VAR_ANY;
2614 rettv->vval.v_number = import->imp_sid;
2615 }
2616 found = TRUE;
2617 }
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002618 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002619 else
2620 {
2621 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02002622 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002623 + import->imp_var_vals_idx;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002624 tv = sv->sv_tv;
2625 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002626 }
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002627 else if (in_vim9script())
2628 {
2629 ufunc_T *ufunc = find_func(name, FALSE, NULL);
2630
2631 if (ufunc != NULL)
2632 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002633 found = TRUE;
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002634 if (rettv != NULL)
2635 {
2636 rettv->v_type = VAR_FUNC;
2637 rettv->vval.v_string = vim_strsave(ufunc->uf_name);
2638 }
2639 }
2640 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002641 }
2642
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002643 if (!found)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002644 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002645 if (tv == NULL)
2646 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002647 if (rettv != NULL && (flags & EVAL_VAR_VERBOSE))
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002648 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarc620c052020-07-08 15:16:19 +02002649 ret = FAIL;
2650 }
2651 else if (rettv != NULL)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002652 {
2653 // If a list or dict variable wasn't initialized, do it now.
2654 if (tv->v_type == VAR_DICT && tv->vval.v_dict == NULL)
2655 {
2656 tv->vval.v_dict = dict_alloc();
2657 if (tv->vval.v_dict != NULL)
2658 ++tv->vval.v_dict->dv_refcount;
2659 }
2660 else if (tv->v_type == VAR_LIST && tv->vval.v_list == NULL)
2661 {
2662 tv->vval.v_list = list_alloc();
2663 if (tv->vval.v_list != NULL)
2664 ++tv->vval.v_list->lv_refcount;
2665 }
Bram Moolenaarb7c21af2021-04-18 14:12:31 +02002666 else if (tv->v_type == VAR_BLOB && tv->vval.v_blob == NULL)
2667 {
2668 tv->vval.v_blob = blob_alloc();
2669 if (tv->vval.v_blob != NULL)
2670 ++tv->vval.v_blob->bv_refcount;
2671 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002672 copy_tv(tv, rettv);
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002673 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002674 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002675
2676 name[len] = cc;
2677
2678 return ret;
2679}
2680
2681/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002682 * Check if variable "name[len]" is a local variable or an argument.
2683 * If so, "*eval_lavars_used" is set to TRUE.
2684 */
2685 void
2686check_vars(char_u *name, int len)
2687{
2688 int cc;
2689 char_u *varname;
2690 hashtab_T *ht;
2691
2692 if (eval_lavars_used == NULL)
2693 return;
2694
2695 // truncate the name, so that we can use strcmp()
2696 cc = name[len];
2697 name[len] = NUL;
2698
2699 ht = find_var_ht(name, &varname);
2700 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
2701 {
2702 if (find_var(name, NULL, TRUE) != NULL)
2703 *eval_lavars_used = TRUE;
2704 }
2705
2706 name[len] = cc;
2707}
2708
2709/*
2710 * Find variable "name" in the list of variables.
2711 * Return a pointer to it if found, NULL if not found.
2712 * Careful: "a:0" variables don't have a name.
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002713 * When "htp" is not NULL set "htp" to the hashtab_T used.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002714 */
2715 dictitem_T *
2716find_var(char_u *name, hashtab_T **htp, int no_autoload)
2717{
2718 char_u *varname;
2719 hashtab_T *ht;
2720 dictitem_T *ret = NULL;
2721
2722 ht = find_var_ht(name, &varname);
2723 if (htp != NULL)
2724 *htp = ht;
2725 if (ht == NULL)
2726 return NULL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002727 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002728 if (ret != NULL)
2729 return ret;
2730
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002731 // Search in parent scope for lambda
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002732 ret = find_var_in_scoped_ht(name, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01002733 if (ret != NULL)
2734 return ret;
2735
2736 // in Vim9 script items without a scope can be script-local
2737 if (in_vim9script() && name[0] != NUL && name[1] != ':')
2738 {
2739 ht = get_script_local_ht();
2740 if (ht != NULL)
2741 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002742 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01002743 if (ret != NULL)
2744 {
2745 if (htp != NULL)
2746 *htp = ht;
2747 return ret;
2748 }
2749 }
2750 }
2751
2752 return NULL;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002753}
2754
2755/*
2756 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02002757 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002758 * Returns NULL if not found.
2759 */
2760 dictitem_T *
2761find_var_in_ht(
2762 hashtab_T *ht,
2763 int htname,
2764 char_u *varname,
2765 int no_autoload)
2766{
2767 hashitem_T *hi;
2768
2769 if (*varname == NUL)
2770 {
2771 // Must be something like "s:", otherwise "ht" would be NULL.
2772 switch (htname)
2773 {
2774 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
2775 case 'g': return &globvars_var;
2776 case 'v': return &vimvars_var;
2777 case 'b': return &curbuf->b_bufvar;
2778 case 'w': return &curwin->w_winvar;
2779 case 't': return &curtab->tp_winvar;
2780 case 'l': return get_funccal_local_var();
2781 case 'a': return get_funccal_args_var();
2782 }
2783 return NULL;
2784 }
2785
2786 hi = hash_find(ht, varname);
2787 if (HASHITEM_EMPTY(hi))
2788 {
2789 // For global variables we may try auto-loading the script. If it
2790 // worked find the variable again. Don't auto-load a script if it was
2791 // loaded already, otherwise it would be loaded every time when
2792 // checking if a function name is a Funcref variable.
2793 if (ht == &globvarht && !no_autoload)
2794 {
2795 // Note: script_autoload() may make "hi" invalid. It must either
2796 // be obtained again or not used.
2797 if (!script_autoload(varname, FALSE) || aborting())
2798 return NULL;
2799 hi = hash_find(ht, varname);
2800 }
2801 if (HASHITEM_EMPTY(hi))
2802 return NULL;
2803 }
2804 return HI2DI(hi);
2805}
2806
2807/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002808 * Get the script-local hashtab. NULL if not in a script context.
2809 */
Bram Moolenaar922acbd2020-10-08 21:30:40 +02002810 hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002811get_script_local_ht(void)
2812{
2813 scid_T sid = current_sctx.sc_sid;
2814
Bram Moolenaare3d46852020-08-29 13:39:17 +02002815 if (SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002816 return &SCRIPT_VARS(sid);
2817 return NULL;
2818}
2819
2820/*
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002821 * Look for "name[len]" in script-local variables and functions.
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002822 * When "cmd" is TRUE it must look like a command, a function must be followed
2823 * by "(" or "->".
Bram Moolenaar709664c2020-12-12 14:33:41 +01002824 * Return OK when found, FAIL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002825 */
Bram Moolenaar709664c2020-12-12 14:33:41 +01002826 int
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002827lookup_scriptitem(
Bram Moolenaar709664c2020-12-12 14:33:41 +01002828 char_u *name,
2829 size_t len,
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002830 int cmd,
Bram Moolenaar709664c2020-12-12 14:33:41 +01002831 cctx_T *dummy UNUSED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002832{
2833 hashtab_T *ht = get_script_local_ht();
2834 char_u buffer[30];
2835 char_u *p;
Bram Moolenaar709664c2020-12-12 14:33:41 +01002836 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002837 hashitem_T *hi;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002838 int is_global = FALSE;
2839 char_u *fname = name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002840
2841 if (ht == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01002842 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002843 if (len < sizeof(buffer) - 1)
2844 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02002845 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002846 vim_strncpy(buffer, name, len);
2847 p = buffer;
2848 }
2849 else
2850 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002851 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002852 if (p == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01002853 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002854 }
2855
2856 hi = hash_find(ht, p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01002857 res = HASHITEM_EMPTY(hi) ? FAIL : OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002858
2859 // if not script-local, then perhaps imported
Bram Moolenaar709664c2020-12-12 14:33:41 +01002860 if (res == FAIL && find_imported(p, 0, NULL) != NULL)
2861 res = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002862 if (p != buffer)
2863 vim_free(p);
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002864
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002865 // Find a function, so that a following "->" works.
2866 // When used as a command require "(" or "->" to follow, "Cmd" is a user
2867 // command while "Cmd()" is a function call.
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002868 if (res != OK)
2869 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002870 p = skipwhite(name + len);
2871
2872 if (!cmd || name[len] == '(' || (p[0] == '-' && p[1] == '>'))
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002873 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01002874 // Do not check for an internal function, since it might also be a
2875 // valid command, such as ":split" versus "split()".
2876 // Skip "g:" before a function name.
2877 if (name[0] == 'g' && name[1] == ':')
2878 {
2879 is_global = TRUE;
2880 fname = name + 2;
2881 }
2882 if (find_func(fname, is_global, NULL) != NULL)
2883 res = OK;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002884 }
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01002885 }
2886
Bram Moolenaar709664c2020-12-12 14:33:41 +01002887 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002888}
2889
2890/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002891 * Find the hashtab used for a variable name.
2892 * Return NULL if the name is not valid.
2893 * Set "varname" to the start of name without ':'.
2894 */
2895 hashtab_T *
2896find_var_ht(char_u *name, char_u **varname)
2897{
2898 hashitem_T *hi;
2899 hashtab_T *ht;
2900
2901 if (name[0] == NUL)
2902 return NULL;
2903 if (name[1] != ':')
2904 {
2905 // The name must not start with a colon or #.
2906 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
2907 return NULL;
2908 *varname = name;
2909
2910 // "version" is "v:version" in all scopes if scriptversion < 3.
2911 // Same for a few other variables marked with VV_COMPAT.
2912 if (current_sctx.sc_version < 3)
2913 {
2914 hi = hash_find(&compat_hashtab, name);
2915 if (!HASHITEM_EMPTY(hi))
2916 return &compat_hashtab;
2917 }
2918
2919 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002920 if (ht != NULL)
2921 return ht; // local variable
2922
2923 // in Vim9 script items at the script level are script-local
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002924 if (in_vim9script())
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002925 {
2926 ht = get_script_local_ht();
2927 if (ht != NULL)
2928 return ht;
2929 }
2930
2931 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002932 }
2933 *varname = name + 2;
2934 if (*name == 'g') // global variable
2935 return &globvarht;
2936 // There must be no ':' or '#' in the rest of the name, unless g: is used
2937 if (vim_strchr(name + 2, ':') != NULL
2938 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
2939 return NULL;
2940 if (*name == 'b') // buffer variable
2941 return &curbuf->b_vars->dv_hashtab;
2942 if (*name == 'w') // window variable
2943 return &curwin->w_vars->dv_hashtab;
2944 if (*name == 't') // tab page variable
2945 return &curtab->tp_vars->dv_hashtab;
2946 if (*name == 'v') // v: variable
2947 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002948 if (get_current_funccal() != NULL
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002949 && get_current_funccal()->func->uf_def_status == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002950 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01002951 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002952 if (*name == 'a') // a: function argument
2953 return get_funccal_args_ht();
2954 if (*name == 'l') // l: local function variable
2955 return get_funccal_local_ht();
2956 }
2957 if (*name == 's') // script variable
2958 {
2959 ht = get_script_local_ht();
2960 if (ht != NULL)
2961 return ht;
2962 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002963 return NULL;
2964}
2965
2966/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002967 * Get the string value of a (global/local) variable.
2968 * Note: see tv_get_string() for how long the pointer remains valid.
2969 * Returns NULL when it doesn't exist.
2970 */
2971 char_u *
2972get_var_value(char_u *name)
2973{
2974 dictitem_T *v;
2975
2976 v = find_var(name, NULL, FALSE);
2977 if (v == NULL)
2978 return NULL;
2979 return tv_get_string(&v->di_tv);
2980}
2981
2982/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002983 * Allocate a new hashtab for a sourced script. It will be used while
2984 * sourcing this script and when executing functions defined in the script.
2985 */
2986 void
2987new_script_vars(scid_T id)
2988{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002989 scriptvar_T *sv;
2990
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01002991 sv = ALLOC_CLEAR_ONE(scriptvar_T);
2992 if (sv == NULL)
2993 return;
2994 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01002995 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002996}
2997
2998/*
2999 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
3000 * point to it.
3001 */
3002 void
3003init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
3004{
3005 hash_init(&dict->dv_hashtab);
3006 dict->dv_lock = 0;
3007 dict->dv_scope = scope;
3008 dict->dv_refcount = DO_NOT_FREE_CNT;
3009 dict->dv_copyID = 0;
3010 dict_var->di_tv.vval.v_dict = dict;
3011 dict_var->di_tv.v_type = VAR_DICT;
3012 dict_var->di_tv.v_lock = VAR_FIXED;
3013 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
3014 dict_var->di_key[0] = NUL;
3015}
3016
3017/*
3018 * Unreference a dictionary initialized by init_var_dict().
3019 */
3020 void
3021unref_var_dict(dict_T *dict)
3022{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003023 // Now the dict needs to be freed if no one else is using it, go back to
3024 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003025 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
3026 dict_unref(dict);
3027}
3028
3029/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003030 * Clean up a list of internal variables.
3031 * Frees all allocated variables and the value they contain.
3032 * Clears hashtab "ht", does not free it.
3033 */
3034 void
3035vars_clear(hashtab_T *ht)
3036{
3037 vars_clear_ext(ht, TRUE);
3038}
3039
3040/*
3041 * Like vars_clear(), but only free the value if "free_val" is TRUE.
3042 */
3043 void
3044vars_clear_ext(hashtab_T *ht, int free_val)
3045{
3046 int todo;
3047 hashitem_T *hi;
3048 dictitem_T *v;
3049
3050 hash_lock(ht);
3051 todo = (int)ht->ht_used;
3052 for (hi = ht->ht_array; todo > 0; ++hi)
3053 {
3054 if (!HASHITEM_EMPTY(hi))
3055 {
3056 --todo;
3057
3058 // Free the variable. Don't remove it from the hashtab,
3059 // ht_array might change then. hash_clear() takes care of it
3060 // later.
3061 v = HI2DI(hi);
3062 if (free_val)
3063 clear_tv(&v->di_tv);
3064 if (v->di_flags & DI_FLAGS_ALLOC)
3065 vim_free(v);
3066 }
3067 }
3068 hash_clear(ht);
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003069 hash_init(ht);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003070}
3071
3072/*
3073 * Delete a variable from hashtab "ht" at item "hi".
3074 * Clear the variable value and free the dictitem.
3075 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02003076 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003077delete_var(hashtab_T *ht, hashitem_T *hi)
3078{
3079 dictitem_T *di = HI2DI(hi);
3080
3081 hash_remove(ht, hi);
3082 clear_tv(&di->di_tv);
3083 vim_free(di);
3084}
3085
3086/*
3087 * List the value of one internal variable.
3088 */
3089 static void
3090list_one_var(dictitem_T *v, char *prefix, int *first)
3091{
3092 char_u *tofree;
3093 char_u *s;
3094 char_u numbuf[NUMBUFLEN];
3095
3096 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
3097 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
3098 s == NULL ? (char_u *)"" : s, first);
3099 vim_free(tofree);
3100}
3101
3102 static void
3103list_one_var_a(
3104 char *prefix,
3105 char_u *name,
3106 int type,
3107 char_u *string,
3108 int *first) // when TRUE clear rest of screen and set to FALSE
3109{
3110 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
3111 msg_start();
3112 msg_puts(prefix);
3113 if (name != NULL) // "a:" vars don't have a name stored
3114 msg_puts((char *)name);
3115 msg_putchar(' ');
3116 msg_advance(22);
3117 if (type == VAR_NUMBER)
3118 msg_putchar('#');
3119 else if (type == VAR_FUNC || type == VAR_PARTIAL)
3120 msg_putchar('*');
3121 else if (type == VAR_LIST)
3122 {
3123 msg_putchar('[');
3124 if (*string == '[')
3125 ++string;
3126 }
3127 else if (type == VAR_DICT)
3128 {
3129 msg_putchar('{');
3130 if (*string == '{')
3131 ++string;
3132 }
3133 else
3134 msg_putchar(' ');
3135
3136 msg_outtrans(string);
3137
3138 if (type == VAR_FUNC || type == VAR_PARTIAL)
3139 msg_puts("()");
3140 if (*first)
3141 {
3142 msg_clr_eos();
3143 *first = FALSE;
3144 }
3145}
3146
3147/*
3148 * Set variable "name" to value in "tv".
3149 * If the variable already exists, the value is updated.
3150 * Otherwise the variable is created.
3151 */
3152 void
3153set_var(
3154 char_u *name,
3155 typval_T *tv,
3156 int copy) // make copy of value in "tv"
3157{
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003158 set_var_const(name, NULL, tv, copy, ASSIGN_DECL, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003159}
3160
3161/*
3162 * Set variable "name" to value in "tv".
3163 * If the variable already exists and "is_const" is FALSE the value is updated.
3164 * Otherwise the variable is created.
3165 */
3166 void
3167set_var_const(
3168 char_u *name,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003169 type_T *type,
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003170 typval_T *tv_arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003171 int copy, // make copy of value in "tv"
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003172 int flags_arg, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003173 int var_idx) // index for ":let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003174{
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003175 typval_T *tv = tv_arg;
3176 typval_T bool_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003177 dictitem_T *di;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003178 char_u *varname;
3179 hashtab_T *ht;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003180 int is_script_local;
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003181 int vim9script = in_vim9script();
Bram Moolenaare535db82021-03-31 21:07:24 +02003182 int var_in_vim9script;
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003183 int flags = flags_arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003184
3185 ht = find_var_ht(name, &varname);
3186 if (ht == NULL || *varname == NUL)
3187 {
3188 semsg(_(e_illvar), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003189 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003190 }
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003191 is_script_local = ht == get_script_local_ht();
3192
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003193 if (vim9script
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003194 && !is_script_local
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003195 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003196 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003197 && name[1] == ':')
Bram Moolenaar67979662020-06-20 22:50:47 +02003198 {
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003199 vim9_declare_error(name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003200 goto failed;
Bram Moolenaar67979662020-06-20 22:50:47 +02003201 }
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003202 if ((flags & ASSIGN_FOR_LOOP) && name[1] == ':'
3203 && vim_strchr((char_u *)"gwbt", name[0]) != NULL)
3204 // Do not make g:var, w:var, b:var or t:var final.
3205 flags &= ~ASSIGN_FINAL;
3206
Bram Moolenaare535db82021-03-31 21:07:24 +02003207 var_in_vim9script = is_script_local && current_script_is_vim9();
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003208 if (var_in_vim9script && name[0] == '_' && name[1] == NUL)
3209 {
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02003210 // For "[a, _] = list" the underscore is ignored.
3211 if ((flags & ASSIGN_UNPACK) == 0)
3212 emsg(_(e_cannot_use_underscore_here));
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003213 goto failed;
3214 }
Bram Moolenaar67979662020-06-20 22:50:47 +02003215
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003216 di = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003217
3218 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003219 if (di == NULL)
3220 di = find_var_in_scoped_ht(name, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003221
3222 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
Bram Moolenaar98b4f142020-08-08 15:46:01 +02003223 && var_wrong_func_name(name, di == NULL))
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003224 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003225
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003226 if (need_convert_to_bool(type, tv))
3227 {
3228 // Destination is a bool and the value is not, but it can be converted.
3229 CLEAR_FIELD(bool_tv);
3230 bool_tv.v_type = VAR_BOOL;
3231 bool_tv.vval.v_number = tv2bool(tv) ? VVAL_TRUE : VVAL_FALSE;
3232 tv = &bool_tv;
3233 }
3234
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003235 if (di != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003236 {
Bram Moolenaar6c3843c2021-03-04 12:38:21 +01003237 // Item already exists. Allowed to replace when reloading.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003238 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003239 {
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003240 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
3241 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003242 {
3243 emsg(_(e_cannot_mod));
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003244 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003245 }
3246
Bram Moolenaar12be7342021-03-31 21:47:33 +02003247 if (is_script_local && vim9script
3248 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0)
3249 {
3250 semsg(_(e_redefining_script_item_str), name);
3251 goto failed;
3252 }
3253
Bram Moolenaare535db82021-03-31 21:07:24 +02003254 if (var_in_vim9script)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003255 {
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003256 where_T where;
3257
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003258 // check the type and adjust to bool if needed
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003259 where.wt_index = var_idx;
3260 where.wt_variable = TRUE;
3261 if (check_script_var_type(&di->di_tv, tv, name, where) == FAIL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003262 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003263 }
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02003264
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003265 if (var_check_permission(di, name) == FAIL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003266 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003267 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003268 else
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003269 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003270 // can only redefine once
3271 di->di_flags &= ~DI_FLAGS_RELOAD;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003272
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003273 // A Vim9 script-local variable is also present in sn_all_vars and
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003274 // sn_var_vals. It may set "type" from "tv".
Bram Moolenaare535db82021-03-31 21:07:24 +02003275 if (var_in_vim9script)
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003276 update_vim9_script_var(FALSE, di, flags, tv, &type,
3277 (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003278 }
3279
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003280 // existing variable, need to clear the value
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003281
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003282 // Handle setting internal di: variables separately where needed to
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003283 // prevent changing the type.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003284 if (ht == &vimvarht)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003285 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003286 if (di->di_tv.v_type == VAR_STRING)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003287 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003288 VIM_CLEAR(di->di_tv.vval.v_string);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003289 if (copy || tv->v_type != VAR_STRING)
3290 {
3291 char_u *val = tv_get_string(tv);
3292
3293 // Careful: when assigning to v:errmsg and tv_get_string()
Bram Moolenaar4b96df52020-01-26 22:00:26 +01003294 // causes an error message the variable will already be set.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003295 if (di->di_tv.vval.v_string == NULL)
3296 di->di_tv.vval.v_string = vim_strsave(val);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003297 }
3298 else
3299 {
3300 // Take over the string to avoid an extra alloc/free.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003301 di->di_tv.vval.v_string = tv->vval.v_string;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003302 tv->vval.v_string = NULL;
3303 }
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003304 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003305 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003306 else if (di->di_tv.v_type == VAR_NUMBER)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003307 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003308 di->di_tv.vval.v_number = tv_get_number(tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003309 if (STRCMP(varname, "searchforward") == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003310 set_search_direction(di->di_tv.vval.v_number ? '/' : '?');
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003311#ifdef FEAT_SEARCH_EXTRA
3312 else if (STRCMP(varname, "hlsearch") == 0)
3313 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003314 no_hlsearch = !di->di_tv.vval.v_number;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003315 redraw_all_later(SOME_VALID);
3316 }
3317#endif
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003318 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003319 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003320 else if (di->di_tv.v_type != tv->v_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003321 {
3322 semsg(_("E963: setting %s to value with wrong type"), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003323 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003324 }
3325 }
3326
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003327 clear_tv(&di->di_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003328 }
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003329 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003330 {
Bram Moolenaar6c3843c2021-03-04 12:38:21 +01003331 // Item not found, check if a function already exists.
3332 if (is_script_local && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003333 && lookup_scriptitem(name, STRLEN(name), FALSE, NULL) == OK)
Bram Moolenaar6c3843c2021-03-04 12:38:21 +01003334 {
3335 semsg(_(e_redefining_script_item_str), name);
3336 goto failed;
3337 }
3338
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003339 // add a new variable
Bram Moolenaare535db82021-03-31 21:07:24 +02003340 if (var_in_vim9script && (flags & ASSIGN_NO_DECL))
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003341 {
3342 semsg(_(e_unknown_variable_str), name);
3343 goto failed;
3344 }
3345
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003346 // Can't add "v:" or "a:" variable.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003347 if (ht == &vimvarht || ht == get_funccal_args_ht())
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003348 {
3349 semsg(_(e_illvar), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003350 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003351 }
3352
Bram Moolenaar03290b82020-12-19 16:30:44 +01003353 // Make sure the variable name is valid. In Vim9 script an autoload
3354 // variable must be prefixed with "g:".
3355 if (!valid_varname(varname, !vim9script
3356 || STRNCMP(name, "g:", 2) == 0))
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003357 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003358
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003359 di = alloc(sizeof(dictitem_T) + STRLEN(varname));
3360 if (di == NULL)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003361 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003362 STRCPY(di->di_key, varname);
3363 if (hash_add(ht, DI2HIKEY(di)) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003364 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003365 vim_free(di);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003366 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003367 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003368 di->di_flags = DI_FLAGS_ALLOC;
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003369 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003370 di->di_flags |= DI_FLAGS_LOCK;
3371
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003372 // A Vim9 script-local variable is also added to sn_all_vars and
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003373 // sn_var_vals. It may set "type" from "tv".
Bram Moolenaare535db82021-03-31 21:07:24 +02003374 if (var_in_vim9script)
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003375 update_vim9_script_var(TRUE, di, flags, tv, &type,
3376 (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003377 }
3378
3379 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003380 copy_tv(tv, &di->di_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003381 else
3382 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003383 di->di_tv = *tv;
3384 di->di_tv.v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003385 init_tv(tv);
3386 }
3387
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003388 if (vim9script && type != NULL)
3389 {
3390 if (type->tt_type == VAR_DICT && di->di_tv.vval.v_dict != NULL)
3391 di->di_tv.vval.v_dict->dv_type = alloc_type(type);
3392 else if (type->tt_type == VAR_LIST && di->di_tv.vval.v_list != NULL)
3393 di->di_tv.vval.v_list->lv_type = alloc_type(type);
3394 }
3395
Bram Moolenaar1dcf55d2020-12-22 22:07:30 +01003396 // ":const var = value" locks the value
3397 // ":final var = value" locks "var"
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003398 if (flags & ASSIGN_CONST)
Bram Moolenaar021bda52020-08-17 21:07:22 +02003399 // Like :lockvar! name: lock the value and what it contains, but only
3400 // if the reference count is up to one. That locks only literal
3401 // values.
3402 item_lock(&di->di_tv, DICT_MAXNEST, TRUE, TRUE);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003403 return;
3404failed:
3405 if (!copy)
3406 clear_tv(tv_arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003407}
3408
3409/*
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003410 * Check in this order for backwards compatibility:
3411 * - Whether the variable is read-only
3412 * - Whether the variable value is locked
3413 * - Whether the variable is locked
3414 */
3415 int
3416var_check_permission(dictitem_T *di, char_u *name)
3417{
3418 if (var_check_ro(di->di_flags, name, FALSE)
3419 || value_check_lock(di->di_tv.v_lock, name, FALSE)
3420 || var_check_lock(di->di_flags, name, FALSE))
3421 return FAIL;
3422 return OK;
3423}
3424
3425/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003426 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
3427 * Also give an error message.
3428 */
3429 int
3430var_check_ro(int flags, char_u *name, int use_gettext)
3431{
3432 if (flags & DI_FLAGS_RO)
3433 {
3434 semsg(_(e_readonlyvar), use_gettext ? (char_u *)_(name) : name);
3435 return TRUE;
3436 }
3437 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
3438 {
3439 semsg(_(e_readonlysbx), use_gettext ? (char_u *)_(name) : name);
3440 return TRUE;
3441 }
3442 return FALSE;
3443}
3444
3445/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003446 * Return TRUE if di_flags "flags" indicates variable "name" is locked.
3447 * Also give an error message.
3448 */
3449 int
3450var_check_lock(int flags, char_u *name, int use_gettext)
3451{
3452 if (flags & DI_FLAGS_LOCK)
3453 {
3454 semsg(_(e_variable_is_locked_str),
3455 use_gettext ? (char_u *)_(name) : name);
3456 return TRUE;
3457 }
3458 return FALSE;
3459}
3460
3461/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003462 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
3463 * Also give an error message.
3464 */
3465 int
3466var_check_fixed(int flags, char_u *name, int use_gettext)
3467{
3468 if (flags & DI_FLAGS_FIX)
3469 {
3470 semsg(_("E795: Cannot delete variable %s"),
3471 use_gettext ? (char_u *)_(name) : name);
3472 return TRUE;
3473 }
3474 return FALSE;
3475}
3476
3477/*
3478 * Check if a funcref is assigned to a valid variable name.
3479 * Return TRUE and give an error if not.
3480 */
3481 int
Bram Moolenaar98b4f142020-08-08 15:46:01 +02003482var_wrong_func_name(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003483 char_u *name, // points to start of variable name
3484 int new_var) // TRUE when creating the variable
3485{
Bram Moolenaar32154662021-03-28 21:14:06 +02003486 // Allow for w: b: s: and t:. In Vim9 script s: is not allowed, because
3487 // the name can be used without the s: prefix.
3488 if (!((vim_strchr((char_u *)"wbt", name[0]) != NULL
3489 || (!in_vim9script() && name[0] == 's')) && name[1] == ':')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003490 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
3491 ? name[2] : name[0]))
3492 {
3493 semsg(_("E704: Funcref variable name must start with a capital: %s"),
3494 name);
3495 return TRUE;
3496 }
3497 // Don't allow hiding a function. When "v" is not NULL we might be
3498 // assigning another function to the same var, the type is checked
3499 // below.
3500 if (new_var && function_exists(name, FALSE))
3501 {
3502 semsg(_("E705: Variable name conflicts with existing function: %s"),
3503 name);
3504 return TRUE;
3505 }
3506 return FALSE;
3507}
3508
3509/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003510 * Return TRUE if "flags" indicates variable "name" has a locked (immutable)
3511 * value. Also give an error message, using "name" or _("name") when
3512 * "use_gettext" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003513 */
3514 int
Bram Moolenaara187c432020-09-16 21:08:28 +02003515value_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003516{
3517 if (lock & VAR_LOCKED)
3518 {
3519 semsg(_("E741: Value is locked: %s"),
3520 name == NULL ? (char_u *)_("Unknown")
3521 : use_gettext ? (char_u *)_(name)
3522 : name);
3523 return TRUE;
3524 }
3525 if (lock & VAR_FIXED)
3526 {
3527 semsg(_("E742: Cannot change value of %s"),
3528 name == NULL ? (char_u *)_("Unknown")
3529 : use_gettext ? (char_u *)_(name)
3530 : name);
3531 return TRUE;
3532 }
3533 return FALSE;
3534}
3535
3536/*
Bram Moolenaar03290b82020-12-19 16:30:44 +01003537 * Check if a variable name is valid. When "autoload" is true "#" is allowed.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003538 * Return FALSE and give an error if not.
3539 */
3540 int
Bram Moolenaar03290b82020-12-19 16:30:44 +01003541valid_varname(char_u *varname, int autoload)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003542{
3543 char_u *p;
3544
3545 for (p = varname; *p != NUL; ++p)
3546 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
Bram Moolenaar03290b82020-12-19 16:30:44 +01003547 && !(autoload && *p == AUTOLOAD_CHAR))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003548 {
3549 semsg(_(e_illvar), varname);
3550 return FALSE;
3551 }
3552 return TRUE;
3553}
3554
3555/*
3556 * getwinvar() and gettabwinvar()
3557 */
3558 static void
3559getwinvar(
3560 typval_T *argvars,
3561 typval_T *rettv,
3562 int off) // 1 for gettabwinvar()
3563{
3564 win_T *win;
3565 char_u *varname;
3566 dictitem_T *v;
3567 tabpage_T *tp = NULL;
3568 int done = FALSE;
3569 win_T *oldcurwin;
3570 tabpage_T *oldtabpage;
3571 int need_switch_win;
3572
3573 if (off == 1)
3574 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3575 else
3576 tp = curtab;
3577 win = find_win_by_nr(&argvars[off], tp);
3578 varname = tv_get_string_chk(&argvars[off + 1]);
3579 ++emsg_off;
3580
3581 rettv->v_type = VAR_STRING;
3582 rettv->vval.v_string = NULL;
3583
3584 if (win != NULL && varname != NULL)
3585 {
3586 // Set curwin to be our win, temporarily. Also set the tabpage,
3587 // otherwise the window is not valid. Only do this when needed,
3588 // autocommands get blocked.
3589 need_switch_win = !(tp == curtab && win == curwin);
3590 if (!need_switch_win
3591 || switch_win(&oldcurwin, &oldtabpage, win, tp, TRUE) == OK)
3592 {
3593 if (*varname == '&')
3594 {
3595 if (varname[1] == NUL)
3596 {
3597 // get all window-local options in a dict
3598 dict_T *opts = get_winbuf_options(FALSE);
3599
3600 if (opts != NULL)
3601 {
3602 rettv_dict_set(rettv, opts);
3603 done = TRUE;
3604 }
3605 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003606 else if (eval_option(&varname, rettv, 1) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003607 // window-local-option
3608 done = TRUE;
3609 }
3610 else
3611 {
3612 // Look up the variable.
3613 // Let getwinvar({nr}, "") return the "w:" dictionary.
3614 v = find_var_in_ht(&win->w_vars->dv_hashtab, 'w',
3615 varname, FALSE);
3616 if (v != NULL)
3617 {
3618 copy_tv(&v->di_tv, rettv);
3619 done = TRUE;
3620 }
3621 }
3622 }
3623
3624 if (need_switch_win)
3625 // restore previous notion of curwin
3626 restore_win(oldcurwin, oldtabpage, TRUE);
3627 }
3628
3629 if (!done && argvars[off + 2].v_type != VAR_UNKNOWN)
3630 // use the default return value
3631 copy_tv(&argvars[off + 2], rettv);
3632
3633 --emsg_off;
3634}
3635
3636/*
Bram Moolenaar191929b2020-08-19 21:20:49 +02003637 * Set option "varname" to the value of "varp" for the current buffer/window.
3638 */
3639 static void
3640set_option_from_tv(char_u *varname, typval_T *varp)
3641{
3642 long numval = 0;
3643 char_u *strval;
3644 char_u nbuf[NUMBUFLEN];
3645 int error = FALSE;
3646
Bram Moolenaar31a201a2021-01-03 14:47:25 +01003647 if (varp->v_type == VAR_BOOL)
Bram Moolenaarb0d81822021-01-03 15:55:10 +01003648 {
Bram Moolenaar31a201a2021-01-03 14:47:25 +01003649 numval = (long)varp->vval.v_number;
Bram Moolenaarb0d81822021-01-03 15:55:10 +01003650 strval = (char_u *)"0"; // avoid using "false"
3651 }
3652 else
3653 {
3654 if (!in_vim9script() || varp->v_type != VAR_STRING)
3655 numval = (long)tv_get_number_chk(varp, &error);
3656 strval = tv_get_string_buf_chk(varp, nbuf);
3657 }
Bram Moolenaar191929b2020-08-19 21:20:49 +02003658 if (!error && strval != NULL)
3659 set_option_value(varname, numval, strval, OPT_LOCAL);
3660}
3661
3662/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003663 * "setwinvar()" and "settabwinvar()" functions
3664 */
3665 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01003666setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003667{
3668 win_T *win;
3669 win_T *save_curwin;
3670 tabpage_T *save_curtab;
3671 int need_switch_win;
3672 char_u *varname, *winvarname;
3673 typval_T *varp;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003674 tabpage_T *tp = NULL;
3675
3676 if (check_secure())
3677 return;
3678
3679 if (off == 1)
3680 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3681 else
3682 tp = curtab;
3683 win = find_win_by_nr(&argvars[off], tp);
3684 varname = tv_get_string_chk(&argvars[off + 1]);
3685 varp = &argvars[off + 2];
3686
3687 if (win != NULL && varname != NULL && varp != NULL)
3688 {
3689 need_switch_win = !(tp == curtab && win == curwin);
3690 if (!need_switch_win
3691 || switch_win(&save_curwin, &save_curtab, win, tp, TRUE) == OK)
3692 {
3693 if (*varname == '&')
Bram Moolenaar191929b2020-08-19 21:20:49 +02003694 set_option_from_tv(varname + 1, varp);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003695 else
3696 {
3697 winvarname = alloc(STRLEN(varname) + 3);
3698 if (winvarname != NULL)
3699 {
3700 STRCPY(winvarname, "w:");
3701 STRCPY(winvarname + 2, varname);
3702 set_var(winvarname, varp, TRUE);
3703 vim_free(winvarname);
3704 }
3705 }
3706 }
3707 if (need_switch_win)
3708 restore_win(save_curwin, save_curtab, TRUE);
3709 }
3710}
3711
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003712/*
3713 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
3714 * v:option_type, and v:option_command.
3715 */
3716 void
3717reset_v_option_vars(void)
3718{
3719 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
3720 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
3721 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
3722 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
3723 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
3724 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
3725}
3726
3727/*
3728 * Add an assert error to v:errors.
3729 */
3730 void
3731assert_error(garray_T *gap)
3732{
3733 struct vimvar *vp = &vimvars[VV_ERRORS];
3734
3735 if (vp->vv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003736 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003737 set_vim_var_list(VV_ERRORS, list_alloc());
3738 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
3739}
3740
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003741 int
3742var_exists(char_u *var)
3743{
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003744 char_u *arg = var;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003745 char_u *name;
3746 char_u *tofree;
3747 typval_T tv;
3748 int len = 0;
3749 int n = FALSE;
3750
3751 // get_name_len() takes care of expanding curly braces
3752 name = var;
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003753 len = get_name_len(&arg, &tofree, TRUE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003754 if (len > 0)
3755 {
3756 if (tofree != NULL)
3757 name = tofree;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003758 n = (eval_variable(name, len, &tv, NULL,
3759 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003760 if (n)
3761 {
3762 // handle d.key, l[idx], f(expr)
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003763 arg = skipwhite(arg);
3764 n = (handle_subscript(&arg, &tv, &EVALARG_EVALUATE, FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003765 if (n)
3766 clear_tv(&tv);
3767 }
3768 }
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02003769 if (*arg != NUL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003770 n = FALSE;
3771
3772 vim_free(tofree);
3773 return n;
3774}
3775
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003776static lval_T *redir_lval = NULL;
3777#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
3778static garray_T redir_ga; // only valid when redir_lval is not NULL
3779static char_u *redir_endp = NULL;
3780static char_u *redir_varname = NULL;
3781
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003782 int
3783alloc_redir_lval(void)
3784{
3785 redir_lval = ALLOC_CLEAR_ONE(lval_T);
3786 if (redir_lval == NULL)
3787 return FAIL;
3788 return OK;
3789}
3790
3791 void
3792clear_redir_lval(void)
3793{
3794 VIM_CLEAR(redir_lval);
3795}
3796
3797 void
3798init_redir_ga(void)
3799{
3800 ga_init2(&redir_ga, (int)sizeof(char), 500);
3801}
3802
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003803/*
3804 * Start recording command output to a variable
3805 * When "append" is TRUE append to an existing variable.
3806 * Returns OK if successfully completed the setup. FAIL otherwise.
3807 */
3808 int
3809var_redir_start(char_u *name, int append)
3810{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003811 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003812 typval_T tv;
3813
3814 // Catch a bad name early.
3815 if (!eval_isnamec1(*name))
3816 {
3817 emsg(_(e_invarg));
3818 return FAIL;
3819 }
3820
3821 // Make a copy of the name, it is used in redir_lval until redir ends.
3822 redir_varname = vim_strsave(name);
3823 if (redir_varname == NULL)
3824 return FAIL;
3825
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003826 if (alloc_redir_lval() == FAIL)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003827 {
3828 var_redir_stop();
3829 return FAIL;
3830 }
3831
3832 // The output is stored in growarray "redir_ga" until redirection ends.
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003833 init_redir_ga();
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003834
3835 // Parse the variable name (can be a dict or list entry).
3836 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
3837 FNE_CHECK_START);
3838 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
3839 {
3840 clear_lval(redir_lval);
3841 if (redir_endp != NULL && *redir_endp != NUL)
3842 // Trailing characters are present after the variable name
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003843 semsg(_(e_trailing_arg), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003844 else
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003845 semsg(_(e_invarg2), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003846 redir_endp = NULL; // don't store a value, only cleanup
3847 var_redir_stop();
3848 return FAIL;
3849 }
3850
3851 // check if we can write to the variable: set it to or append an empty
3852 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003853 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003854 tv.v_type = VAR_STRING;
3855 tv.vval.v_string = (char_u *)"";
3856 if (append)
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02003857 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003858 ASSIGN_NO_DECL, (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003859 else
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02003860 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003861 ASSIGN_NO_DECL, (char_u *)"=", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003862 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02003863 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003864 {
3865 redir_endp = NULL; // don't store a value, only cleanup
3866 var_redir_stop();
3867 return FAIL;
3868 }
3869
3870 return OK;
3871}
3872
3873/*
3874 * Append "value[value_len]" to the variable set by var_redir_start().
3875 * The actual appending is postponed until redirection ends, because the value
3876 * appended may in fact be the string we write to, changing it may cause freed
3877 * memory to be used:
3878 * :redir => foo
3879 * :let foo
3880 * :redir END
3881 */
3882 void
3883var_redir_str(char_u *value, int value_len)
3884{
3885 int len;
3886
3887 if (redir_lval == NULL)
3888 return;
3889
3890 if (value_len == -1)
3891 len = (int)STRLEN(value); // Append the entire string
3892 else
3893 len = value_len; // Append only "value_len" characters
3894
3895 if (ga_grow(&redir_ga, len) == OK)
3896 {
3897 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
3898 redir_ga.ga_len += len;
3899 }
3900 else
3901 var_redir_stop();
3902}
3903
3904/*
3905 * Stop redirecting command output to a variable.
3906 * Frees the allocated memory.
3907 */
3908 void
3909var_redir_stop(void)
3910{
3911 typval_T tv;
3912
3913 if (EVALCMD_BUSY)
3914 {
3915 redir_lval = NULL;
3916 return;
3917 }
3918
3919 if (redir_lval != NULL)
3920 {
3921 // If there was no error: assign the text to the variable.
3922 if (redir_endp != NULL)
3923 {
3924 ga_append(&redir_ga, NUL); // Append the trailing NUL.
3925 tv.v_type = VAR_STRING;
3926 tv.vval.v_string = redir_ga.ga_data;
3927 // Call get_lval() again, if it's inside a Dict or List it may
3928 // have changed.
3929 redir_endp = get_lval(redir_varname, NULL, redir_lval,
3930 FALSE, FALSE, 0, FNE_CHECK_START);
3931 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003932 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003933 (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02003934 clear_lval(redir_lval);
3935 }
3936
3937 // free the collected output
3938 VIM_CLEAR(redir_ga.ga_data);
3939
3940 VIM_CLEAR(redir_lval);
3941 }
3942 VIM_CLEAR(redir_varname);
3943}
3944
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003945/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003946 * Get the collected redirected text and clear redir_ga.
3947 */
3948 char_u *
3949get_clear_redir_ga(void)
3950{
3951 char_u *res;
3952
3953 ga_append(&redir_ga, NUL); // Append the trailing NUL.
3954 res = redir_ga.ga_data;
3955 redir_ga.ga_data = NULL;
3956 return res;
3957}
3958
3959/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003960 * "gettabvar()" function
3961 */
3962 void
3963f_gettabvar(typval_T *argvars, typval_T *rettv)
3964{
3965 win_T *oldcurwin;
3966 tabpage_T *tp, *oldtabpage;
3967 dictitem_T *v;
3968 char_u *varname;
3969 int done = FALSE;
3970
3971 rettv->v_type = VAR_STRING;
3972 rettv->vval.v_string = NULL;
3973
3974 varname = tv_get_string_chk(&argvars[1]);
3975 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
3976 if (tp != NULL && varname != NULL)
3977 {
3978 // Set tp to be our tabpage, temporarily. Also set the window to the
3979 // first window in the tabpage, otherwise the window is not valid.
3980 if (switch_win(&oldcurwin, &oldtabpage,
3981 tp == curtab || tp->tp_firstwin == NULL ? firstwin
3982 : tp->tp_firstwin, tp, TRUE) == OK)
3983 {
3984 // look up the variable
3985 // Let gettabvar({nr}, "") return the "t:" dictionary.
3986 v = find_var_in_ht(&tp->tp_vars->dv_hashtab, 't', varname, FALSE);
3987 if (v != NULL)
3988 {
3989 copy_tv(&v->di_tv, rettv);
3990 done = TRUE;
3991 }
3992 }
3993
3994 // restore previous notion of curwin
3995 restore_win(oldcurwin, oldtabpage, TRUE);
3996 }
3997
3998 if (!done && argvars[2].v_type != VAR_UNKNOWN)
3999 copy_tv(&argvars[2], rettv);
4000}
4001
4002/*
4003 * "gettabwinvar()" function
4004 */
4005 void
4006f_gettabwinvar(typval_T *argvars, typval_T *rettv)
4007{
4008 getwinvar(argvars, rettv, 1);
4009}
4010
4011/*
4012 * "getwinvar()" function
4013 */
4014 void
4015f_getwinvar(typval_T *argvars, typval_T *rettv)
4016{
4017 getwinvar(argvars, rettv, 0);
4018}
4019
4020/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004021 * "getbufvar()" function
4022 */
4023 void
4024f_getbufvar(typval_T *argvars, typval_T *rettv)
4025{
4026 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004027 char_u *varname;
4028 dictitem_T *v;
4029 int done = FALSE;
4030
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004031 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004032 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004033
4034 rettv->v_type = VAR_STRING;
4035 rettv->vval.v_string = NULL;
4036
4037 if (buf != NULL && varname != NULL)
4038 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004039 if (*varname == '&')
4040 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004041 buf_T *save_curbuf = curbuf;
4042
4043 // set curbuf to be our buf, temporarily
4044 curbuf = buf;
4045
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004046 if (varname[1] == NUL)
4047 {
4048 // get all buffer-local options in a dict
4049 dict_T *opts = get_winbuf_options(TRUE);
4050
4051 if (opts != NULL)
4052 {
4053 rettv_dict_set(rettv, opts);
4054 done = TRUE;
4055 }
4056 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02004057 else if (eval_option(&varname, rettv, TRUE) == OK)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004058 // buffer-local-option
4059 done = TRUE;
Bram Moolenaar86015452020-03-29 15:12:15 +02004060
4061 // restore previous notion of curbuf
4062 curbuf = save_curbuf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004063 }
4064 else
4065 {
4066 // Look up the variable.
Bram Moolenaar52592752020-04-03 18:43:35 +02004067 if (*varname == NUL)
4068 // Let getbufvar({nr}, "") return the "b:" dictionary.
4069 v = &buf->b_bufvar;
4070 else
4071 v = find_var_in_ht(&buf->b_vars->dv_hashtab, 'b',
4072 varname, FALSE);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004073 if (v != NULL)
4074 {
4075 copy_tv(&v->di_tv, rettv);
4076 done = TRUE;
4077 }
4078 }
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004079 }
4080
4081 if (!done && argvars[2].v_type != VAR_UNKNOWN)
4082 // use the default value
4083 copy_tv(&argvars[2], rettv);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004084}
4085
4086/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004087 * "settabvar()" function
4088 */
4089 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004090f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004091{
4092 tabpage_T *save_curtab;
4093 tabpage_T *tp;
4094 char_u *varname, *tabvarname;
4095 typval_T *varp;
4096
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004097 if (check_secure())
4098 return;
4099
4100 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4101 varname = tv_get_string_chk(&argvars[1]);
4102 varp = &argvars[2];
4103
4104 if (varname != NULL && varp != NULL && tp != NULL)
4105 {
4106 save_curtab = curtab;
4107 goto_tabpage_tp(tp, FALSE, FALSE);
4108
4109 tabvarname = alloc(STRLEN(varname) + 3);
4110 if (tabvarname != NULL)
4111 {
4112 STRCPY(tabvarname, "t:");
4113 STRCPY(tabvarname + 2, varname);
4114 set_var(tabvarname, varp, TRUE);
4115 vim_free(tabvarname);
4116 }
4117
4118 // Restore current tabpage
4119 if (valid_tabpage(save_curtab))
4120 goto_tabpage_tp(save_curtab, FALSE, FALSE);
4121 }
4122}
4123
4124/*
4125 * "settabwinvar()" function
4126 */
4127 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004128f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004129{
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004130 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004131}
4132
4133/*
4134 * "setwinvar()" function
4135 */
4136 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004137f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004138{
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004139 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004140}
4141
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004142/*
4143 * "setbufvar()" function
4144 */
4145 void
4146f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
4147{
4148 buf_T *buf;
4149 char_u *varname, *bufvarname;
4150 typval_T *varp;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004151
4152 if (check_secure())
4153 return;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004154 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004155 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004156 varp = &argvars[2];
4157
4158 if (buf != NULL && varname != NULL && varp != NULL)
4159 {
4160 if (*varname == '&')
4161 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004162 aco_save_T aco;
4163
4164 // set curbuf to be our buf, temporarily
4165 aucmd_prepbuf(&aco, buf);
4166
Bram Moolenaar191929b2020-08-19 21:20:49 +02004167 set_option_from_tv(varname + 1, varp);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004168
4169 // reset notion of buffer
4170 aucmd_restbuf(&aco);
4171 }
4172 else
4173 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004174 bufvarname = alloc(STRLEN(varname) + 3);
4175 if (bufvarname != NULL)
4176 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004177 buf_T *save_curbuf = curbuf;
4178
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004179 curbuf = buf;
4180 STRCPY(bufvarname, "b:");
4181 STRCPY(bufvarname + 2, varname);
4182 set_var(bufvarname, varp, TRUE);
4183 vim_free(bufvarname);
4184 curbuf = save_curbuf;
4185 }
4186 }
4187 }
4188}
4189
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004190/*
4191 * Get a callback from "arg". It can be a Funcref or a function name.
4192 * When "arg" is zero return an empty string.
4193 * "cb_name" is not allocated.
4194 * "cb_name" is set to NULL for an invalid argument.
4195 */
4196 callback_T
4197get_callback(typval_T *arg)
4198{
Bram Moolenaar14e579092020-03-07 16:59:25 +01004199 callback_T res;
4200 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004201
4202 res.cb_free_name = FALSE;
4203 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
4204 {
4205 res.cb_partial = arg->vval.v_partial;
4206 ++res.cb_partial->pt_refcount;
4207 res.cb_name = partial_name(res.cb_partial);
4208 }
4209 else
4210 {
4211 res.cb_partial = NULL;
Bram Moolenaar14e579092020-03-07 16:59:25 +01004212 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
4213 && isdigit(*arg->vval.v_string))
4214 r = FAIL;
4215 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004216 {
4217 // Note that we don't make a copy of the string.
4218 res.cb_name = arg->vval.v_string;
4219 func_ref(res.cb_name);
4220 }
4221 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004222 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004223 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01004224 r = FAIL;
4225
4226 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004227 {
4228 emsg(_("E921: Invalid callback argument"));
4229 res.cb_name = NULL;
4230 }
4231 }
4232 return res;
4233}
4234
4235/*
4236 * Copy a callback into a typval_T.
4237 */
4238 void
4239put_callback(callback_T *cb, typval_T *tv)
4240{
4241 if (cb->cb_partial != NULL)
4242 {
4243 tv->v_type = VAR_PARTIAL;
4244 tv->vval.v_partial = cb->cb_partial;
4245 ++tv->vval.v_partial->pt_refcount;
4246 }
4247 else
4248 {
4249 tv->v_type = VAR_FUNC;
4250 tv->vval.v_string = vim_strsave(cb->cb_name);
4251 func_ref(cb->cb_name);
4252 }
4253}
4254
4255/*
4256 * Make a copy of "src" into "dest", allocating the function name if needed,
4257 * without incrementing the refcount.
4258 */
4259 void
4260set_callback(callback_T *dest, callback_T *src)
4261{
4262 if (src->cb_partial == NULL)
4263 {
4264 // just a function name, make a copy
4265 dest->cb_name = vim_strsave(src->cb_name);
4266 dest->cb_free_name = TRUE;
4267 }
4268 else
4269 {
4270 // cb_name is a pointer into cb_partial
4271 dest->cb_name = src->cb_name;
4272 dest->cb_free_name = FALSE;
4273 }
4274 dest->cb_partial = src->cb_partial;
4275}
4276
4277/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02004278 * Copy callback from "src" to "dest", incrementing the refcounts.
4279 */
4280 void
4281copy_callback(callback_T *dest, callback_T *src)
4282{
4283 dest->cb_partial = src->cb_partial;
4284 if (dest->cb_partial != NULL)
4285 {
4286 dest->cb_name = src->cb_name;
4287 dest->cb_free_name = FALSE;
4288 ++dest->cb_partial->pt_refcount;
4289 }
4290 else
4291 {
4292 dest->cb_name = vim_strsave(src->cb_name);
4293 dest->cb_free_name = TRUE;
4294 func_ref(src->cb_name);
4295 }
4296}
4297
4298/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004299 * Unref/free "callback" returned by get_callback() or set_callback().
4300 */
4301 void
4302free_callback(callback_T *callback)
4303{
4304 if (callback->cb_partial != NULL)
4305 {
4306 partial_unref(callback->cb_partial);
4307 callback->cb_partial = NULL;
4308 }
4309 else if (callback->cb_name != NULL)
4310 func_unref(callback->cb_name);
4311 if (callback->cb_free_name)
4312 {
4313 vim_free(callback->cb_name);
4314 callback->cb_free_name = FALSE;
4315 }
4316 callback->cb_name = NULL;
4317}
4318
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004319#endif // FEAT_EVAL