blob: c83aa61c9f8b489b540abbfb12b7be196c84aeca [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!)
Bram Moolenaard787e402021-12-24 21:36:12 +000048 type_T *vv_type; // type or NULL
Bram Moolenaare5cdf152019-08-29 22:09:46 +020049 char vv_flags; // VV_COMPAT, VV_RO, VV_RO_SBX
50} vimvars[VV_LEN] =
51{
Bram Moolenaar8d71b542019-08-30 15:46:30 +020052 // The order here must match the VV_ defines in vim.h!
53 // Initializing a union does not work, leave tv.vval empty to get zero's.
Bram Moolenaard787e402021-12-24 21:36:12 +000054 {VV_NAME("count", VAR_NUMBER), NULL, VV_COMPAT+VV_RO},
55 {VV_NAME("count1", VAR_NUMBER), NULL, VV_RO},
56 {VV_NAME("prevcount", VAR_NUMBER), NULL, VV_RO},
57 {VV_NAME("errmsg", VAR_STRING), NULL, VV_COMPAT},
58 {VV_NAME("warningmsg", VAR_STRING), NULL, 0},
59 {VV_NAME("statusmsg", VAR_STRING), NULL, 0},
60 {VV_NAME("shell_error", VAR_NUMBER), NULL, VV_COMPAT+VV_RO},
61 {VV_NAME("this_session", VAR_STRING), NULL, VV_COMPAT},
62 {VV_NAME("version", VAR_NUMBER), NULL, VV_COMPAT+VV_RO},
63 {VV_NAME("lnum", VAR_NUMBER), NULL, VV_RO_SBX},
64 {VV_NAME("termresponse", VAR_STRING), NULL, VV_RO},
65 {VV_NAME("fname", VAR_STRING), NULL, VV_RO},
66 {VV_NAME("lang", VAR_STRING), NULL, VV_RO},
67 {VV_NAME("lc_time", VAR_STRING), NULL, VV_RO},
68 {VV_NAME("ctype", VAR_STRING), NULL, VV_RO},
69 {VV_NAME("charconvert_from", VAR_STRING), NULL, VV_RO},
70 {VV_NAME("charconvert_to", VAR_STRING), NULL, VV_RO},
71 {VV_NAME("fname_in", VAR_STRING), NULL, VV_RO},
72 {VV_NAME("fname_out", VAR_STRING), NULL, VV_RO},
73 {VV_NAME("fname_new", VAR_STRING), NULL, VV_RO},
74 {VV_NAME("fname_diff", VAR_STRING), NULL, VV_RO},
75 {VV_NAME("cmdarg", VAR_STRING), NULL, VV_RO},
76 {VV_NAME("foldstart", VAR_NUMBER), NULL, VV_RO_SBX},
77 {VV_NAME("foldend", VAR_NUMBER), NULL, VV_RO_SBX},
78 {VV_NAME("folddashes", VAR_STRING), NULL, VV_RO_SBX},
79 {VV_NAME("foldlevel", VAR_NUMBER), NULL, VV_RO_SBX},
80 {VV_NAME("progname", VAR_STRING), NULL, VV_RO},
81 {VV_NAME("servername", VAR_STRING), NULL, VV_RO},
82 {VV_NAME("dying", VAR_NUMBER), NULL, VV_RO},
83 {VV_NAME("exception", VAR_STRING), NULL, VV_RO},
84 {VV_NAME("throwpoint", VAR_STRING), NULL, VV_RO},
85 {VV_NAME("register", VAR_STRING), NULL, VV_RO},
86 {VV_NAME("cmdbang", VAR_NUMBER), NULL, VV_RO},
87 {VV_NAME("insertmode", VAR_STRING), NULL, VV_RO},
88 {VV_NAME("val", VAR_UNKNOWN), NULL, VV_RO},
89 {VV_NAME("key", VAR_UNKNOWN), NULL, VV_RO},
90 {VV_NAME("profiling", VAR_NUMBER), NULL, VV_RO},
91 {VV_NAME("fcs_reason", VAR_STRING), NULL, VV_RO},
92 {VV_NAME("fcs_choice", VAR_STRING), NULL, 0},
93 {VV_NAME("beval_bufnr", VAR_NUMBER), NULL, VV_RO},
94 {VV_NAME("beval_winnr", VAR_NUMBER), NULL, VV_RO},
95 {VV_NAME("beval_winid", VAR_NUMBER), NULL, VV_RO},
96 {VV_NAME("beval_lnum", VAR_NUMBER), NULL, VV_RO},
97 {VV_NAME("beval_col", VAR_NUMBER), NULL, VV_RO},
98 {VV_NAME("beval_text", VAR_STRING), NULL, VV_RO},
99 {VV_NAME("scrollstart", VAR_STRING), NULL, 0},
100 {VV_NAME("swapname", VAR_STRING), NULL, VV_RO},
101 {VV_NAME("swapchoice", VAR_STRING), NULL, 0},
102 {VV_NAME("swapcommand", VAR_STRING), NULL, VV_RO},
103 {VV_NAME("char", VAR_STRING), NULL, 0},
104 {VV_NAME("mouse_win", VAR_NUMBER), NULL, 0},
105 {VV_NAME("mouse_winid", VAR_NUMBER), NULL, 0},
106 {VV_NAME("mouse_lnum", VAR_NUMBER), NULL, 0},
107 {VV_NAME("mouse_col", VAR_NUMBER), NULL, 0},
108 {VV_NAME("operator", VAR_STRING), NULL, VV_RO},
109 {VV_NAME("searchforward", VAR_NUMBER), NULL, 0},
110 {VV_NAME("hlsearch", VAR_NUMBER), NULL, 0},
111 {VV_NAME("oldfiles", VAR_LIST), &t_list_string, 0},
112 {VV_NAME("windowid", VAR_NUMBER), NULL, VV_RO},
113 {VV_NAME("progpath", VAR_STRING), NULL, VV_RO},
114 {VV_NAME("completed_item", VAR_DICT), &t_dict_string, VV_RO},
115 {VV_NAME("option_new", VAR_STRING), NULL, VV_RO},
116 {VV_NAME("option_old", VAR_STRING), NULL, VV_RO},
117 {VV_NAME("option_oldlocal", VAR_STRING), NULL, VV_RO},
118 {VV_NAME("option_oldglobal", VAR_STRING), NULL, VV_RO},
119 {VV_NAME("option_command", VAR_STRING), NULL, VV_RO},
120 {VV_NAME("option_type", VAR_STRING), NULL, VV_RO},
121 {VV_NAME("errors", VAR_LIST), &t_list_string, 0},
122 {VV_NAME("false", VAR_BOOL), NULL, VV_RO},
123 {VV_NAME("true", VAR_BOOL), NULL, VV_RO},
124 {VV_NAME("none", VAR_SPECIAL), NULL, VV_RO},
125 {VV_NAME("null", VAR_SPECIAL), NULL, VV_RO},
126 {VV_NAME("numbermax", VAR_NUMBER), NULL, VV_RO},
127 {VV_NAME("numbermin", VAR_NUMBER), NULL, VV_RO},
128 {VV_NAME("numbersize", VAR_NUMBER), NULL, VV_RO},
129 {VV_NAME("vim_did_enter", VAR_NUMBER), NULL, VV_RO},
130 {VV_NAME("testing", VAR_NUMBER), NULL, 0},
131 {VV_NAME("t_number", VAR_NUMBER), NULL, VV_RO},
132 {VV_NAME("t_string", VAR_NUMBER), NULL, VV_RO},
133 {VV_NAME("t_func", VAR_NUMBER), NULL, VV_RO},
134 {VV_NAME("t_list", VAR_NUMBER), NULL, VV_RO},
135 {VV_NAME("t_dict", VAR_NUMBER), NULL, VV_RO},
136 {VV_NAME("t_float", VAR_NUMBER), NULL, VV_RO},
137 {VV_NAME("t_bool", VAR_NUMBER), NULL, VV_RO},
138 {VV_NAME("t_none", VAR_NUMBER), NULL, VV_RO},
139 {VV_NAME("t_job", VAR_NUMBER), NULL, VV_RO},
140 {VV_NAME("t_channel", VAR_NUMBER), NULL, VV_RO},
141 {VV_NAME("t_blob", VAR_NUMBER), NULL, VV_RO},
142 {VV_NAME("termrfgresp", VAR_STRING), NULL, VV_RO},
143 {VV_NAME("termrbgresp", VAR_STRING), NULL, VV_RO},
144 {VV_NAME("termu7resp", VAR_STRING), NULL, VV_RO},
145 {VV_NAME("termstyleresp", VAR_STRING), NULL, VV_RO},
146 {VV_NAME("termblinkresp", VAR_STRING), NULL, VV_RO},
147 {VV_NAME("event", VAR_DICT), NULL, VV_RO},
148 {VV_NAME("versionlong", VAR_NUMBER), NULL, VV_RO},
149 {VV_NAME("echospace", VAR_NUMBER), NULL, VV_RO},
150 {VV_NAME("argv", VAR_LIST), &t_list_string, VV_RO},
151 {VV_NAME("collate", VAR_STRING), NULL, VV_RO},
152 {VV_NAME("exiting", VAR_SPECIAL), NULL, VV_RO},
153 {VV_NAME("colornames", VAR_DICT), &t_dict_string, VV_RO},
154 {VV_NAME("sizeofint", VAR_NUMBER), NULL, VV_RO},
155 {VV_NAME("sizeoflong", VAR_NUMBER), NULL, VV_RO},
156 {VV_NAME("sizeofpointer", VAR_NUMBER), NULL, VV_RO},
naohiro ono56200ee2022-01-01 14:59:44 +0000157 {VV_NAME("maxcol", VAR_NUMBER), NULL, VV_RO},
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200158};
159
160// shorthand
Bram Moolenaard787e402021-12-24 21:36:12 +0000161#define vv_tv_type vv_di.di_tv.v_type
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200162#define vv_nr vv_di.di_tv.vval.v_number
163#define vv_float vv_di.di_tv.vval.v_float
164#define vv_str vv_di.di_tv.vval.v_string
165#define vv_list vv_di.di_tv.vval.v_list
166#define vv_dict vv_di.di_tv.vval.v_dict
167#define vv_blob vv_di.di_tv.vval.v_blob
168#define vv_tv vv_di.di_tv
169
170static dictitem_T vimvars_var; // variable used for v:
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200171static dict_T vimvardict; // Dictionary with v: variables
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200172#define vimvarht vimvardict.dv_hashtab
173
174// for VIM_VERSION_ defines
175#include "version.h"
176
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200177static void list_glob_vars(int *first);
178static void list_buf_vars(int *first);
179static void list_win_vars(int *first);
180static void list_tab_vars(int *first);
181static char_u *list_arg_vars(exarg_T *eap, char_u *arg, int *first);
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100182static 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 +0200183static int do_unlet_var(lval_T *lp, char_u *name_end, exarg_T *eap, int deep, void *cookie);
184static 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 +0200185static void list_one_var(dictitem_T *v, char *prefix, int *first);
186static void list_one_var_a(char *prefix, char_u *name, int type, char_u *string, int *first);
187
188/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200189 * Initialize global and vim special variables
190 */
191 void
192evalvars_init(void)
193{
194 int i;
195 struct vimvar *p;
196
197 init_var_dict(&globvardict, &globvars_var, VAR_DEF_SCOPE);
198 init_var_dict(&vimvardict, &vimvars_var, VAR_SCOPE);
199 vimvardict.dv_lock = VAR_FIXED;
200 hash_init(&compat_hashtab);
201
202 for (i = 0; i < VV_LEN; ++i)
203 {
204 p = &vimvars[i];
205 if (STRLEN(p->vv_name) > DICTITEM16_KEY_LEN)
206 {
207 iemsg("INTERNAL: name too long, increase size of dictitem16_T");
208 getout(1);
209 }
210 STRCPY(p->vv_di.di_key, p->vv_name);
211 if (p->vv_flags & VV_RO)
212 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
213 else if (p->vv_flags & VV_RO_SBX)
214 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
215 else
216 p->vv_di.di_flags = DI_FLAGS_FIX;
217
218 // add to v: scope dict, unless the value is not always available
Bram Moolenaard787e402021-12-24 21:36:12 +0000219 if (p->vv_tv_type != VAR_UNKNOWN)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200220 hash_add(&vimvarht, p->vv_di.di_key);
221 if (p->vv_flags & VV_COMPAT)
222 // add to compat scope dict
223 hash_add(&compat_hashtab, p->vv_di.di_key);
224 }
Bram Moolenaar016faaa2020-10-03 12:57:27 +0200225 set_vim_var_nr(VV_VERSION, VIM_VERSION_100);
226 set_vim_var_nr(VV_VERSIONLONG, VIM_VERSION_100 * 10000 + highest_patch());
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200227
228 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
229 set_vim_var_nr(VV_HLSEARCH, 1L);
Bram Moolenaarf0068c52020-11-30 17:42:10 +0100230 set_vim_var_nr(VV_EXITING, VVAL_NULL);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200231 set_vim_var_dict(VV_COMPLETED_ITEM, dict_alloc_lock(VAR_FIXED));
232 set_vim_var_list(VV_ERRORS, list_alloc());
233 set_vim_var_dict(VV_EVENT, dict_alloc_lock(VAR_FIXED));
234
235 set_vim_var_nr(VV_FALSE, VVAL_FALSE);
236 set_vim_var_nr(VV_TRUE, VVAL_TRUE);
237 set_vim_var_nr(VV_NONE, VVAL_NONE);
238 set_vim_var_nr(VV_NULL, VVAL_NULL);
Bram Moolenaar57d5a012021-01-21 21:42:31 +0100239 set_vim_var_nr(VV_NUMBERMAX, VARNUM_MAX);
240 set_vim_var_nr(VV_NUMBERMIN, VARNUM_MIN);
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100241 set_vim_var_nr(VV_NUMBERSIZE, sizeof(varnumber_T) * 8);
Bram Moolenaar69b30722021-11-02 21:39:49 +0000242 set_vim_var_nr(VV_SIZEOFINT, sizeof(int));
243 set_vim_var_nr(VV_SIZEOFLONG, sizeof(long));
244 set_vim_var_nr(VV_SIZEOFPOINTER, sizeof(char *));
naohiro ono56200ee2022-01-01 14:59:44 +0000245 set_vim_var_nr(VV_MAXCOL, MAXCOL);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200246
247 set_vim_var_nr(VV_TYPE_NUMBER, VAR_TYPE_NUMBER);
248 set_vim_var_nr(VV_TYPE_STRING, VAR_TYPE_STRING);
249 set_vim_var_nr(VV_TYPE_FUNC, VAR_TYPE_FUNC);
250 set_vim_var_nr(VV_TYPE_LIST, VAR_TYPE_LIST);
251 set_vim_var_nr(VV_TYPE_DICT, VAR_TYPE_DICT);
252 set_vim_var_nr(VV_TYPE_FLOAT, VAR_TYPE_FLOAT);
253 set_vim_var_nr(VV_TYPE_BOOL, VAR_TYPE_BOOL);
254 set_vim_var_nr(VV_TYPE_NONE, VAR_TYPE_NONE);
255 set_vim_var_nr(VV_TYPE_JOB, VAR_TYPE_JOB);
256 set_vim_var_nr(VV_TYPE_CHANNEL, VAR_TYPE_CHANNEL);
257 set_vim_var_nr(VV_TYPE_BLOB, VAR_TYPE_BLOB);
258
259 set_vim_var_nr(VV_ECHOSPACE, sc_col - 1);
260
Drew Vogele30d1022021-10-24 20:35:07 +0100261 set_vim_var_dict(VV_COLORNAMES, dict_alloc());
262
Bram Moolenaar439c0362020-06-06 15:58:03 +0200263 // Default for v:register is not 0 but '"'. This is adjusted once the
264 // clipboard has been setup by calling reset_reg_var().
265 set_reg_var(0);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200266}
267
268#if defined(EXITFREE) || defined(PROTO)
269/*
270 * Free all vim variables information on exit
271 */
272 void
273evalvars_clear(void)
274{
275 int i;
276 struct vimvar *p;
277
278 for (i = 0; i < VV_LEN; ++i)
279 {
280 p = &vimvars[i];
281 if (p->vv_di.di_tv.v_type == VAR_STRING)
282 VIM_CLEAR(p->vv_str);
283 else if (p->vv_di.di_tv.v_type == VAR_LIST)
284 {
285 list_unref(p->vv_list);
286 p->vv_list = NULL;
287 }
288 }
289 hash_clear(&vimvarht);
290 hash_init(&vimvarht); // garbage_collect() will access it
291 hash_clear(&compat_hashtab);
292
293 // global variables
294 vars_clear(&globvarht);
295
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100296 // Script-local variables. Clear all the variables here.
297 // The scriptvar_T is cleared later in free_scriptnames(), because a
298 // variable in one script might hold a reference to the whole scope of
299 // another script.
300 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200301 vars_clear(&SCRIPT_VARS(i));
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200302}
303#endif
304
305 int
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200306garbage_collect_globvars(int copyID)
307{
308 return set_ref_in_ht(&globvarht, copyID, NULL);
309}
310
311 int
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200312garbage_collect_vimvars(int copyID)
313{
314 return set_ref_in_ht(&vimvarht, copyID, NULL);
315}
316
317 int
318garbage_collect_scriptvars(int copyID)
319{
Bram Moolenaared234f22020-10-15 20:42:20 +0200320 int i;
321 int idx;
322 int abort = FALSE;
323 scriptitem_T *si;
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200324
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100325 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaared234f22020-10-15 20:42:20 +0200326 {
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200327 abort = abort || set_ref_in_ht(&SCRIPT_VARS(i), copyID, NULL);
328
Bram Moolenaared234f22020-10-15 20:42:20 +0200329 si = SCRIPT_ITEM(i);
330 for (idx = 0; idx < si->sn_var_vals.ga_len; ++idx)
331 {
332 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + idx;
333
Bram Moolenaard00a7fb2021-03-08 20:47:14 +0100334 if (sv->sv_name != NULL)
335 abort = abort || set_ref_in_item(sv->sv_tv, copyID, NULL, NULL);
Bram Moolenaared234f22020-10-15 20:42:20 +0200336 }
337 }
338
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200339 return abort;
340}
341
342/*
343 * Set an internal variable to a string value. Creates the variable if it does
344 * not already exist.
345 */
346 void
347set_internal_string_var(char_u *name, char_u *value)
348{
349 char_u *val;
350 typval_T *tvp;
351
352 val = vim_strsave(value);
353 if (val != NULL)
354 {
355 tvp = alloc_string_tv(val);
356 if (tvp != NULL)
357 {
358 set_var(name, tvp, FALSE);
359 free_tv(tvp);
360 }
361 }
362}
363
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200364 int
365eval_charconvert(
366 char_u *enc_from,
367 char_u *enc_to,
368 char_u *fname_from,
369 char_u *fname_to)
370{
371 int err = FALSE;
Bram Moolenaarf4e88f22022-01-23 14:17:28 +0000372 sctx_T saved_sctx = current_sctx;
373 sctx_T *ctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200374
375 set_vim_var_string(VV_CC_FROM, enc_from, -1);
376 set_vim_var_string(VV_CC_TO, enc_to, -1);
377 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
378 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
Bram Moolenaarf4e88f22022-01-23 14:17:28 +0000379 ctx = get_option_sctx("charconvert");
380 if (ctx != NULL)
381 current_sctx = *ctx;
382
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200383 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
384 err = TRUE;
Bram Moolenaarf4e88f22022-01-23 14:17:28 +0000385
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200386 set_vim_var_string(VV_CC_FROM, NULL, -1);
387 set_vim_var_string(VV_CC_TO, NULL, -1);
388 set_vim_var_string(VV_FNAME_IN, NULL, -1);
389 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
Bram Moolenaarf4e88f22022-01-23 14:17:28 +0000390 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200391
392 if (err)
393 return FAIL;
394 return OK;
395}
396
397# if defined(FEAT_POSTSCRIPT) || defined(PROTO)
398 int
399eval_printexpr(char_u *fname, char_u *args)
400{
401 int err = FALSE;
Bram Moolenaar7ef4a2f2022-01-23 13:44:35 +0000402 sctx_T saved_sctx = current_sctx;
403 sctx_T *ctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200404
405 set_vim_var_string(VV_FNAME_IN, fname, -1);
406 set_vim_var_string(VV_CMDARG, args, -1);
Bram Moolenaar7ef4a2f2022-01-23 13:44:35 +0000407 ctx = get_option_sctx("printexpr");
408 if (ctx != NULL)
409 current_sctx = *ctx;
410
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200411 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
412 err = TRUE;
Bram Moolenaar7ef4a2f2022-01-23 13:44:35 +0000413
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200414 set_vim_var_string(VV_FNAME_IN, NULL, -1);
415 set_vim_var_string(VV_CMDARG, NULL, -1);
Bram Moolenaar7ef4a2f2022-01-23 13:44:35 +0000416 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200417
418 if (err)
419 {
420 mch_remove(fname);
421 return FAIL;
422 }
423 return OK;
424}
425# endif
426
427# if defined(FEAT_DIFF) || defined(PROTO)
428 void
429eval_diff(
430 char_u *origfile,
431 char_u *newfile,
432 char_u *outfile)
433{
Bram Moolenaar7b29f6a2022-01-22 17:58:13 +0000434 sctx_T saved_sctx = current_sctx;
435 sctx_T *ctx;
436 typval_T *tv;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200437
438 set_vim_var_string(VV_FNAME_IN, origfile, -1);
439 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
440 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
Bram Moolenaar7b29f6a2022-01-22 17:58:13 +0000441
442 ctx = get_option_sctx("diffexpr");
443 if (ctx != NULL)
444 current_sctx = *ctx;
445
446 // errors are ignored
447 tv = eval_expr(p_dex, NULL);
Bram Moolenaar39b89442022-01-22 18:21:36 +0000448 free_tv(tv);
Bram Moolenaar7b29f6a2022-01-22 17:58:13 +0000449
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200450 set_vim_var_string(VV_FNAME_IN, NULL, -1);
451 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
452 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
Bram Moolenaar7b29f6a2022-01-22 17:58:13 +0000453 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200454}
455
456 void
457eval_patch(
458 char_u *origfile,
459 char_u *difffile,
460 char_u *outfile)
461{
Bram Moolenaar36c2add2022-01-22 20:55:30 +0000462 sctx_T saved_sctx = current_sctx;
463 sctx_T *ctx;
464 typval_T *tv;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200465
466 set_vim_var_string(VV_FNAME_IN, origfile, -1);
467 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
468 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
Bram Moolenaar36c2add2022-01-22 20:55:30 +0000469
470 ctx = get_option_sctx("patchexpr");
471 if (ctx != NULL)
472 current_sctx = *ctx;
473
474 // errors are ignored
475 tv = eval_expr(p_pex, NULL);
476 free_tv(tv);
477
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200478 set_vim_var_string(VV_FNAME_IN, NULL, -1);
479 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
480 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
Bram Moolenaar36c2add2022-01-22 20:55:30 +0000481 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200482}
483# endif
484
485#if defined(FEAT_SPELL) || defined(PROTO)
486/*
487 * Evaluate an expression to a list with suggestions.
488 * For the "expr:" part of 'spellsuggest'.
489 * Returns NULL when there is an error.
490 */
491 list_T *
492eval_spell_expr(char_u *badword, char_u *expr)
493{
494 typval_T save_val;
495 typval_T rettv;
496 list_T *list = NULL;
497 char_u *p = skipwhite(expr);
Bram Moolenaar2a7aa832022-01-23 17:59:06 +0000498 sctx_T saved_sctx = current_sctx;
499 sctx_T *ctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200500
501 // Set "v:val" to the bad word.
502 prepare_vimvar(VV_VAL, &save_val);
503 set_vim_var_string(VV_VAL, badword, -1);
504 if (p_verbose == 0)
505 ++emsg_off;
Bram Moolenaar2a7aa832022-01-23 17:59:06 +0000506 ctx = get_option_sctx("spellsuggest");
507 if (ctx != NULL)
508 current_sctx = *ctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200509
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200510 if (eval1(&p, &rettv, &EVALARG_EVALUATE) == OK)
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200511 {
512 if (rettv.v_type != VAR_LIST)
513 clear_tv(&rettv);
514 else
515 list = rettv.vval.v_list;
516 }
517
518 if (p_verbose == 0)
519 --emsg_off;
520 clear_tv(get_vim_var_tv(VV_VAL));
521 restore_vimvar(VV_VAL, &save_val);
Bram Moolenaar2a7aa832022-01-23 17:59:06 +0000522 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200523
524 return list;
525}
526
527/*
528 * "list" is supposed to contain two items: a word and a number. Return the
529 * word in "pp" and the number as the return value.
530 * Return -1 if anything isn't right.
531 * Used to get the good word and score from the eval_spell_expr() result.
532 */
533 int
534get_spellword(list_T *list, char_u **pp)
535{
536 listitem_T *li;
537
538 li = list->lv_first;
539 if (li == NULL)
540 return -1;
541 *pp = tv_get_string(&li->li_tv);
542
543 li = li->li_next;
544 if (li == NULL)
545 return -1;
546 return (int)tv_get_number(&li->li_tv);
547}
548#endif
549
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200550/*
551 * Prepare v: variable "idx" to be used.
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200552 * Save the current typeval in "save_tv" and clear it.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200553 * When not used yet add the variable to the v: hashtable.
554 */
555 void
556prepare_vimvar(int idx, typval_T *save_tv)
557{
558 *save_tv = vimvars[idx].vv_tv;
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200559 vimvars[idx].vv_str = NULL; // don't free it now
Bram Moolenaard787e402021-12-24 21:36:12 +0000560 if (vimvars[idx].vv_tv_type == VAR_UNKNOWN)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200561 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
562}
563
564/*
565 * Restore v: variable "idx" to typeval "save_tv".
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200566 * Note that the v: variable must have been cleared already.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200567 * When no longer defined, remove the variable from the v: hashtable.
568 */
569 void
570restore_vimvar(int idx, typval_T *save_tv)
571{
572 hashitem_T *hi;
573
574 vimvars[idx].vv_tv = *save_tv;
Bram Moolenaard787e402021-12-24 21:36:12 +0000575 if (vimvars[idx].vv_tv_type == VAR_UNKNOWN)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200576 {
577 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
578 if (HASHITEM_EMPTY(hi))
579 internal_error("restore_vimvar()");
580 else
581 hash_remove(&vimvarht, hi);
582 }
583}
584
585/*
586 * List Vim variables.
587 */
588 static void
589list_vim_vars(int *first)
590{
591 list_hashtable_vars(&vimvarht, "v:", FALSE, first);
592}
593
594/*
595 * List script-local variables, if there is a script.
596 */
597 static void
598list_script_vars(int *first)
599{
Bram Moolenaare3d46852020-08-29 13:39:17 +0200600 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200601 list_hashtable_vars(&SCRIPT_VARS(current_sctx.sc_sid),
602 "s:", FALSE, first);
603}
604
605/*
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100606 * Evaluate all the Vim expressions (`=expr`) in string "str" and return the
607 * resulting string. The caller must free the returned string.
608 */
609 static char_u *
610eval_all_expr_in_str(char_u *str)
611{
612 garray_T ga;
613 char_u *s;
614 char_u *p;
615 char_u save_c;
616 char_u *exprval;
617 int status;
618
619 ga_init2(&ga, 1, 80);
620 p = str;
621
622 // Look for `=expr`, evaluate the expression and replace `=expr` with the
623 // result.
624 while (*p != NUL)
625 {
626 s = p;
627 while (*p != NUL && (*p != '`' || p[1] != '='))
628 p++;
629 ga_concat_len(&ga, s, p - s);
630 if (*p == NUL)
631 break; // no backtick expression found
632
633 s = p;
634 p += 2; // skip `=
635
636 status = *p == NUL ? OK : skip_expr(&p, NULL);
637 if (status == FAIL || *p != '`')
638 {
639 // invalid expression or missing ending backtick
640 if (status != FAIL)
641 emsg(_(e_missing_backtick));
642 vim_free(ga.ga_data);
643 return NULL;
644 }
645 s += 2; // skip `=
646 save_c = *p;
647 *p = NUL;
648 exprval = eval_to_string(s, TRUE);
649 *p = save_c;
650 p++;
651 if (exprval == NULL)
652 {
653 // expression evaluation failed
654 vim_free(ga.ga_data);
655 return NULL;
656 }
657 ga_concat(&ga, exprval);
658 vim_free(exprval);
659 }
660 ga_append(&ga, NUL);
661
662 return ga.ga_data;
663}
664
665/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200666 * Get a list of lines from a HERE document. The here document is a list of
667 * lines surrounded by a marker.
668 * cmd << {marker}
669 * {line1}
670 * {line2}
671 * ....
672 * {marker}
673 *
674 * The {marker} is a string. If the optional 'trim' word is supplied before the
675 * marker, then the leading indentation before the lines (matching the
676 * indentation in the 'cmd' line) is stripped.
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200677 *
678 * When getting lines for an embedded script (e.g. python, lua, perl, ruby,
679 * tcl, mzscheme), script_get is set to TRUE. In this case, if the marker is
680 * missing, then '.' is accepted as a marker.
681 *
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100682 * Returns a List with {lines} or NULL on failure.
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200683 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100684 list_T *
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200685heredoc_get(exarg_T *eap, char_u *cmd, int script_get)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200686{
Bram Moolenaar42ccb8d2022-04-18 15:45:23 +0100687 char_u *theline = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200688 char_u *marker;
689 list_T *l;
690 char_u *p;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100691 char_u *str;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200692 int marker_indent_len = 0;
693 int text_indent_len = 0;
694 char_u *text_indent = NULL;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200695 char_u dot[] = ".";
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200696 int comment_char = in_vim9script() ? '#' : '"';
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100697 int evalstr = FALSE;
698 int eval_failed = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200699
700 if (eap->getline == NULL)
701 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000702 emsg(_(e_cannot_use_heredoc_here));
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200703 return NULL;
704 }
705
706 // Check for the optional 'trim' word before the marker
707 cmd = skipwhite(cmd);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200708
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100709 while (TRUE)
710 {
711 if (STRNCMP(cmd, "trim", 4) == 0
712 && (cmd[4] == NUL || VIM_ISWHITE(cmd[4])))
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200713 {
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100714 cmd = skipwhite(cmd + 4);
715
716 // Trim the indentation from all the lines in the here document.
717 // The amount of indentation trimmed is the same as the indentation
718 // of the first line after the :let command line. To find the end
719 // marker the indent of the :let command line is trimmed.
720 p = *eap->cmdlinep;
721 while (VIM_ISWHITE(*p))
722 {
723 p++;
724 marker_indent_len++;
725 }
726 text_indent_len = -1;
727
728 continue;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200729 }
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100730 if (STRNCMP(cmd, "eval", 4) == 0
731 && (cmd[4] == NUL || VIM_ISWHITE(cmd[4])))
732 {
733 cmd = skipwhite(cmd + 4);
734 evalstr = TRUE;
735 continue;
736 }
737 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200738 }
739
740 // The marker is the next word.
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200741 if (*cmd != NUL && *cmd != comment_char)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200742 {
743 marker = skipwhite(cmd);
744 p = skiptowhite(marker);
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200745 if (*skipwhite(p) != NUL && *skipwhite(p) != comment_char)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200746 {
Bram Moolenaar74409f62022-01-01 15:58:22 +0000747 semsg(_(e_trailing_characters_str), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200748 return NULL;
749 }
750 *p = NUL;
Bram Moolenaar6ab09532020-05-01 14:10:13 +0200751 if (!script_get && vim_islower(*marker))
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200752 {
Bram Moolenaar6d057012021-12-31 18:49:43 +0000753 emsg(_(e_marker_cannot_start_with_lower_case_letter));
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200754 return NULL;
755 }
756 }
757 else
758 {
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200759 // When getting lines for an embedded script, if the marker is missing,
760 // accept '.' as the marker.
761 if (script_get)
762 marker = dot;
763 else
764 {
Bram Moolenaar1a992222021-12-31 17:25:48 +0000765 emsg(_(e_missing_marker));
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200766 return NULL;
767 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200768 }
769
770 l = list_alloc();
771 if (l == NULL)
772 return NULL;
773
774 for (;;)
775 {
776 int mi = 0;
777 int ti = 0;
778
Bram Moolenaar42ccb8d2022-04-18 15:45:23 +0100779 vim_free(theline);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200780 theline = eap->getline(NUL, eap->cookie, 0, FALSE);
781 if (theline == NULL)
782 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000783 semsg(_(e_missing_end_marker_str), marker);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200784 break;
785 }
786
787 // with "trim": skip the indent matching the :let line to find the
788 // marker
789 if (marker_indent_len > 0
790 && STRNCMP(theline, *eap->cmdlinep, marker_indent_len) == 0)
791 mi = marker_indent_len;
792 if (STRCMP(marker, theline + mi) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200793 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200794
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100795 // If expression evaluation failed in the heredoc, then skip till the
796 // end marker.
797 if (eval_failed)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100798 continue;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100799
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200800 if (text_indent_len == -1 && *theline != NUL)
801 {
802 // set the text indent from the first line.
803 p = theline;
804 text_indent_len = 0;
805 while (VIM_ISWHITE(*p))
806 {
807 p++;
808 text_indent_len++;
809 }
810 text_indent = vim_strnsave(theline, text_indent_len);
811 }
812 // with "trim": skip the indent matching the first line
813 if (text_indent != NULL)
814 for (ti = 0; ti < text_indent_len; ++ti)
815 if (theline[ti] != text_indent[ti])
816 break;
817
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100818 str = theline + ti;
819 if (evalstr)
820 {
821 str = eval_all_expr_in_str(str);
822 if (str == NULL)
823 {
824 // expression evaluation failed
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100825 eval_failed = TRUE;
826 continue;
827 }
828 vim_free(theline);
829 theline = str;
830 }
831
832 if (list_append_string(l, str, -1) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200833 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200834 }
Bram Moolenaar42ccb8d2022-04-18 15:45:23 +0100835 vim_free(theline);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200836 vim_free(text_indent);
837
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100838 if (eval_failed)
839 {
840 // expression evaluation in the heredoc failed
841 list_free(l);
842 return NULL;
843 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200844 return l;
845}
846
847/*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200848 * Vim9 variable declaration:
849 * ":var name"
850 * ":var name: type"
851 * ":var name = expr"
852 * ":var name: type = expr"
853 * etc.
854 */
855 void
856ex_var(exarg_T *eap)
857{
Bram Moolenaar330a3882022-03-05 11:05:57 +0000858 char_u *p = eap->cmd;
Bram Moolenaare1d12112022-03-05 11:37:48 +0000859 int has_var;
Bram Moolenaar330a3882022-03-05 11:05:57 +0000860
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200861 if (!in_vim9script())
862 {
863 semsg(_(e_str_cannot_be_used_in_legacy_vim_script), ":var");
864 return;
865 }
Bram Moolenaare1d12112022-03-05 11:37:48 +0000866 has_var = checkforcmd_noparen(&p, "var", 3);
867 if (current_sctx.sc_sid == 0 && has_var)
Bram Moolenaar0e1574c2022-03-03 17:05:35 +0000868 {
869 emsg(_(e_cannot_declare_variable_on_command_line));
870 return;
871 }
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200872 ex_let(eap);
873}
874
875/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200876 * ":let" list all variable values
877 * ":let var1 var2" list variable values
878 * ":let var = expr" assignment command.
879 * ":let var += expr" assignment command.
880 * ":let var -= expr" assignment command.
881 * ":let var *= expr" assignment command.
882 * ":let var /= expr" assignment command.
883 * ":let var %= expr" assignment command.
884 * ":let var .= expr" assignment command.
885 * ":let var ..= expr" assignment command.
886 * ":let [var1, var2] = expr" unpack list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100887 * ":let var =<< ..." heredoc
Bram Moolenaard672dde2020-02-26 13:43:51 +0100888 * ":let var: string" Vim9 declaration
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200889 *
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200890 * ":final var = expr" assignment command.
891 * ":final [var1, var2] = expr" unpack list.
892 *
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200893 * ":const" list all variable values
894 * ":const var1 var2" list variable values
895 * ":const var = expr" assignment command.
896 * ":const [var1, var2] = expr" unpack list.
897 */
898 void
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200899ex_let(exarg_T *eap)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200900{
901 char_u *arg = eap->arg;
902 char_u *expr = NULL;
903 typval_T rettv;
904 int i;
905 int var_count = 0;
906 int semicolon = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200907 char_u op[4];
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200908 char_u *argend;
909 int first = TRUE;
910 int concat;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200911 int has_assign;
Bram Moolenaar89b474d2020-12-22 21:19:39 +0100912 int flags = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200913 int vim9script = in_vim9script();
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200914
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200915 if (eap->cmdidx == CMD_final && !vim9script)
916 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +0100917 // In legacy Vim script ":final" is short for ":finally".
918 ex_finally(eap);
919 return;
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200920 }
Bram Moolenaarc58f5452020-10-21 20:58:52 +0200921 if (eap->cmdidx == CMD_let && vim9script)
Bram Moolenaarcfcd0112020-09-27 15:19:27 +0200922 {
923 emsg(_(e_cannot_use_let_in_vim9_script));
924 return;
925 }
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200926
Bram Moolenaar89b474d2020-12-22 21:19:39 +0100927 if (eap->cmdidx == CMD_const)
928 flags |= ASSIGN_CONST;
929 else if (eap->cmdidx == CMD_final)
930 flags |= ASSIGN_FINAL;
931
932 // Vim9 assignment without ":let", ":const" or ":final"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100933 if (eap->arg == eap->cmd)
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200934 flags |= ASSIGN_NO_DECL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100935
Bram Moolenaar47a519a2020-06-14 23:05:10 +0200936 argend = skip_var_list(arg, TRUE, &var_count, &semicolon, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200937 if (argend == NULL)
938 return;
939 if (argend > arg && argend[-1] == '.') // for var.='str'
940 --argend;
941 expr = skipwhite(argend);
942 concat = expr[0] == '.'
Bram Moolenaardd9de502021-08-15 13:49:42 +0200943 && ((expr[1] == '=' && in_old_script(2))
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200944 || (expr[1] == '.' && expr[2] == '='));
Bram Moolenaar32e35112020-05-14 22:41:15 +0200945 has_assign = *expr == '=' || (vim_strchr((char_u *)"+-*/%", *expr) != NULL
946 && expr[1] == '=');
Bram Moolenaar822ba242020-05-24 23:00:18 +0200947 if (!has_assign && !concat)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200948 {
949 // ":let" without "=": list variables
950 if (*arg == '[')
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000951 emsg(_(e_invalid_argument));
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200952 else if (expr[0] == '.' && expr[1] == '=')
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000953 emsg(_(e_dot_equal_not_supported_with_script_version_two));
Bram Moolenaarfaac4102020-04-20 17:46:14 +0200954 else if (!ends_excmd2(eap->cmd, arg))
Bram Moolenaarc82a5b52020-06-13 18:09:19 +0200955 {
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200956 if (vim9script)
Bram Moolenaarc82a5b52020-06-13 18:09:19 +0200957 {
Bram Moolenaarccc25aa2021-03-26 21:27:52 +0100958 if (!ends_excmd2(eap->cmd, skipwhite(argend)))
Bram Moolenaar74409f62022-01-01 15:58:22 +0000959 semsg(_(e_trailing_characters_str), argend);
Bram Moolenaarccc25aa2021-03-26 21:27:52 +0100960 else
961 // Vim9 declaration ":var name: type"
962 arg = vim9_declare_scriptvar(eap, arg);
Bram Moolenaarc82a5b52020-06-13 18:09:19 +0200963 }
964 else
965 {
966 // ":let var1 var2" - list values
967 arg = list_arg_vars(eap, arg, &first);
968 }
969 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200970 else if (!eap->skip)
971 {
972 // ":let"
973 list_glob_vars(&first);
974 list_buf_vars(&first);
975 list_win_vars(&first);
976 list_tab_vars(&first);
977 list_script_vars(&first);
978 list_func_vars(&first);
979 list_vim_vars(&first);
980 }
Bram Moolenaar63b91732021-08-05 20:40:03 +0200981 set_nextcmd(eap, arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200982 }
983 else if (expr[0] == '=' && expr[1] == '<' && expr[2] == '<')
984 {
985 list_T *l;
Bram Moolenaar81530e32021-07-28 21:25:49 +0200986 long cur_lnum = SOURCING_LNUM;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200987
988 // HERE document
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200989 l = heredoc_get(eap, expr + 3, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200990 if (l != NULL)
991 {
992 rettv_list_set(&rettv, l);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +0200993 if (!eap->skip)
994 {
Bram Moolenaar81530e32021-07-28 21:25:49 +0200995 // errors are for the assignment, not the end marker
996 SOURCING_LNUM = cur_lnum;
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +0200997 op[0] = '=';
998 op[1] = NUL;
999 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001000 flags, op);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +02001001 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001002 clear_tv(&rettv);
1003 }
1004 }
1005 else
1006 {
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001007 evalarg_T evalarg;
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001008 int len = 1;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001009
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02001010 CLEAR_FIELD(rettv);
Bram Moolenaar32e35112020-05-14 22:41:15 +02001011 i = FAIL;
1012 if (has_assign || concat)
1013 {
Bram Moolenaar9a562c12021-01-23 13:39:14 +01001014 int cur_lnum;
1015
Bram Moolenaar32e35112020-05-14 22:41:15 +02001016 op[0] = '=';
1017 op[1] = NUL;
1018 if (*expr != '=')
1019 {
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001020 if (vim9script && (flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar122616d2020-08-21 21:32:50 +02001021 {
1022 // +=, /=, etc. require an existing variable
1023 semsg(_(e_cannot_use_operator_on_new_variable), eap->arg);
1024 i = FAIL;
1025 }
1026 else if (vim_strchr((char_u *)"+-*/%.", *expr) != NULL)
Bram Moolenaar32e35112020-05-14 22:41:15 +02001027 {
1028 op[0] = *expr; // +=, -=, *=, /=, %= or .=
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001029 ++len;
Bram Moolenaar32e35112020-05-14 22:41:15 +02001030 if (expr[0] == '.' && expr[1] == '.') // ..=
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001031 {
Bram Moolenaar32e35112020-05-14 22:41:15 +02001032 ++expr;
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001033 ++len;
1034 }
Bram Moolenaar32e35112020-05-14 22:41:15 +02001035 }
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001036 expr += 2;
Bram Moolenaar32e35112020-05-14 22:41:15 +02001037 }
1038 else
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001039 ++expr;
1040
Bram Moolenaar7f2c3412021-11-29 16:01:49 +00001041 if (vim9script && !eap->skip && (!VIM_ISWHITE(*argend)
Bram Moolenaarc7e44a72020-07-29 21:37:43 +02001042 || !IS_WHITE_OR_NUL(*expr)))
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001043 {
1044 vim_strncpy(op, expr - len, len);
Bram Moolenaare7a73e02021-01-01 19:17:55 +01001045 semsg(_(e_white_space_required_before_and_after_str_at_str),
1046 op, argend);
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001047 i = FAIL;
1048 }
Bram Moolenaar32e35112020-05-14 22:41:15 +02001049
1050 if (eap->skip)
1051 ++emsg_skip;
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001052 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaarc7e44a72020-07-29 21:37:43 +02001053 expr = skipwhite_and_linebreak(expr, &evalarg);
Bram Moolenaar9a562c12021-01-23 13:39:14 +01001054 cur_lnum = SOURCING_LNUM;
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001055 i = eval0(expr, &rettv, eap, &evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001056 if (eap->skip)
1057 --emsg_skip;
Bram Moolenaarfaf86262020-06-27 23:07:36 +02001058 clear_evalarg(&evalarg, eap);
Bram Moolenaar9a562c12021-01-23 13:39:14 +01001059
1060 // Restore the line number so that any type error is given for the
1061 // declaration, not the expression.
1062 SOURCING_LNUM = cur_lnum;
Bram Moolenaar32e35112020-05-14 22:41:15 +02001063 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001064 if (eap->skip)
1065 {
1066 if (i != FAIL)
1067 clear_tv(&rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001068 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02001069 else if (i != FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001070 {
1071 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001072 flags, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001073 clear_tv(&rettv);
1074 }
1075 }
1076}
1077
1078/*
Bram Moolenaar6c3843c2021-03-04 12:38:21 +01001079 * Assign the typeval "tv" to the variable or variables at "arg_start".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001080 * Handles both "var" with any type and "[var, var; var]" with a list type.
1081 * When "op" is not NULL it points to a string with characters that
1082 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1083 * or concatenate.
1084 * Returns OK or FAIL;
1085 */
1086 int
1087ex_let_vars(
1088 char_u *arg_start,
1089 typval_T *tv,
1090 int copy, // copy values from "tv", don't move
1091 int semicolon, // from skip_var_list()
1092 int var_count, // from skip_var_list()
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001093 int flags, // ASSIGN_FINAL, ASSIGN_CONST, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001094 char_u *op)
1095{
1096 char_u *arg = arg_start;
1097 list_T *l;
1098 int i;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001099 int var_idx = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001100 listitem_T *item;
1101 typval_T ltv;
1102
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00001103 if (tv->v_type == VAR_VOID)
1104 {
1105 emsg(_(e_cannot_use_void_value));
1106 return FAIL;
1107 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001108 if (*arg != '[')
1109 {
1110 // ":let var = expr" or ":for var in list"
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001111 if (ex_let_one(arg, tv, copy, flags, op, op, var_idx) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001112 return FAIL;
1113 return OK;
1114 }
1115
1116 // ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1117 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1118 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001119 emsg(_(e_list_required));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001120 return FAIL;
1121 }
1122
1123 i = list_len(l);
1124 if (semicolon == 0 && var_count < i)
1125 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00001126 emsg(_(e_less_targets_than_list_items));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001127 return FAIL;
1128 }
1129 if (var_count - semicolon > i)
1130 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00001131 emsg(_(e_more_targets_than_list_items));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001132 return FAIL;
1133 }
1134
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001135 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001136 item = l->lv_first;
1137 while (*arg != ']')
1138 {
1139 arg = skipwhite(arg + 1);
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001140 ++var_idx;
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02001141 arg = ex_let_one(arg, &item->li_tv, TRUE,
1142 flags | ASSIGN_UNPACK, (char_u *)",;]", op, var_idx);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001143 item = item->li_next;
1144 if (arg == NULL)
1145 return FAIL;
1146
1147 arg = skipwhite(arg);
1148 if (*arg == ';')
1149 {
1150 // Put the rest of the list (may be empty) in the var after ';'.
1151 // Create a new list for this.
1152 l = list_alloc();
1153 if (l == NULL)
1154 return FAIL;
1155 while (item != NULL)
1156 {
1157 list_append_tv(l, &item->li_tv);
1158 item = item->li_next;
1159 }
1160
1161 ltv.v_type = VAR_LIST;
1162 ltv.v_lock = 0;
1163 ltv.vval.v_list = l;
1164 l->lv_refcount = 1;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001165 ++var_idx;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001166
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02001167 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1168 flags | ASSIGN_UNPACK, (char_u *)"]", op, var_idx);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001169 clear_tv(&ltv);
1170 if (arg == NULL)
1171 return FAIL;
1172 break;
1173 }
1174 else if (*arg != ',' && *arg != ']')
1175 {
1176 internal_error("ex_let_vars()");
1177 return FAIL;
1178 }
1179 }
1180
1181 return OK;
1182}
1183
1184/*
1185 * Skip over assignable variable "var" or list of variables "[var, var]".
1186 * Used for ":let varvar = expr" and ":for varvar in expr".
1187 * For "[var, var]" increment "*var_count" for each variable.
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001188 * for "[var, var; var]" set "semicolon" to 1.
1189 * If "silent" is TRUE do not give an "invalid argument" error message.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001190 * Return NULL for an error.
1191 */
1192 char_u *
1193skip_var_list(
1194 char_u *arg,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001195 int include_type,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001196 int *var_count,
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001197 int *semicolon,
1198 int silent)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001199{
1200 char_u *p, *s;
1201
1202 if (*arg == '[')
1203 {
1204 // "[var, var]": find the matching ']'.
1205 p = arg;
1206 for (;;)
1207 {
1208 p = skipwhite(p + 1); // skip whites after '[', ';' or ','
Bram Moolenaar036d0712021-01-17 20:23:38 +01001209 s = skip_var_one(p, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001210 if (s == p)
1211 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001212 if (!silent)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001213 semsg(_(e_invalid_argument_str), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001214 return NULL;
1215 }
1216 ++*var_count;
1217
1218 p = skipwhite(s);
1219 if (*p == ']')
1220 break;
1221 else if (*p == ';')
1222 {
1223 if (*semicolon == 1)
1224 {
Bram Moolenaar8b716f52022-02-15 21:17:56 +00001225 if (!silent)
1226 emsg(_(e_double_semicolon_in_list_of_variables));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001227 return NULL;
1228 }
1229 *semicolon = 1;
1230 }
1231 else if (*p != ',')
1232 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001233 if (!silent)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001234 semsg(_(e_invalid_argument_str), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001235 return NULL;
1236 }
1237 }
1238 return p + 1;
1239 }
1240 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001241 return skip_var_one(arg, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001242}
1243
1244/*
1245 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1246 * l[idx].
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001247 * In Vim9 script also skip over ": type" if "include_type" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001248 */
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001249 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001250skip_var_one(char_u *arg, int include_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001251{
Bram Moolenaar585587d2021-01-17 20:52:13 +01001252 char_u *end;
1253 int vim9 = in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001254
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001255 if (*arg == '@' && arg[1] != NUL)
1256 return arg + 2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001257 end = find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001258 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
Bram Moolenaar036d0712021-01-17 20:23:38 +01001259
1260 // "a: type" is declaring variable "a" with a type, not "a:".
1261 // Same for "s: type".
Bram Moolenaar585587d2021-01-17 20:52:13 +01001262 if (vim9 && end == arg + 2 && end[-1] == ':')
Bram Moolenaar036d0712021-01-17 20:23:38 +01001263 --end;
1264
Bram Moolenaar585587d2021-01-17 20:52:13 +01001265 if (include_type && vim9)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001266 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001267 if (*end == ':')
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02001268 end = skip_type(skipwhite(end + 1), FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001269 }
1270 return end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001271}
1272
1273/*
1274 * List variables for hashtab "ht" with prefix "prefix".
1275 * If "empty" is TRUE also list NULL strings as empty strings.
1276 */
1277 void
1278list_hashtable_vars(
1279 hashtab_T *ht,
1280 char *prefix,
1281 int empty,
1282 int *first)
1283{
1284 hashitem_T *hi;
1285 dictitem_T *di;
1286 int todo;
1287 char_u buf[IOSIZE];
1288
1289 todo = (int)ht->ht_used;
1290 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1291 {
1292 if (!HASHITEM_EMPTY(hi))
1293 {
1294 --todo;
1295 di = HI2DI(hi);
1296
1297 // apply :filter /pat/ to variable name
1298 vim_strncpy((char_u *)buf, (char_u *)prefix, IOSIZE - 1);
1299 vim_strcat((char_u *)buf, di->di_key, IOSIZE);
1300 if (message_filtered(buf))
1301 continue;
1302
1303 if (empty || di->di_tv.v_type != VAR_STRING
1304 || di->di_tv.vval.v_string != NULL)
1305 list_one_var(di, prefix, first);
1306 }
1307 }
1308}
1309
1310/*
1311 * List global variables.
1312 */
1313 static void
1314list_glob_vars(int *first)
1315{
1316 list_hashtable_vars(&globvarht, "", TRUE, first);
1317}
1318
1319/*
1320 * List buffer variables.
1321 */
1322 static void
1323list_buf_vars(int *first)
1324{
1325 list_hashtable_vars(&curbuf->b_vars->dv_hashtab, "b:", TRUE, first);
1326}
1327
1328/*
1329 * List window variables.
1330 */
1331 static void
1332list_win_vars(int *first)
1333{
1334 list_hashtable_vars(&curwin->w_vars->dv_hashtab, "w:", TRUE, first);
1335}
1336
1337/*
1338 * List tab page variables.
1339 */
1340 static void
1341list_tab_vars(int *first)
1342{
1343 list_hashtable_vars(&curtab->tp_vars->dv_hashtab, "t:", TRUE, first);
1344}
1345
1346/*
1347 * List variables in "arg".
1348 */
1349 static char_u *
1350list_arg_vars(exarg_T *eap, char_u *arg, int *first)
1351{
1352 int error = FALSE;
1353 int len;
1354 char_u *name;
1355 char_u *name_start;
1356 char_u *arg_subsc;
1357 char_u *tofree;
1358 typval_T tv;
1359
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001360 while (!ends_excmd2(eap->cmd, arg) && !got_int)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001361 {
1362 if (error || eap->skip)
1363 {
1364 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1365 if (!VIM_ISWHITE(*arg) && !ends_excmd(*arg))
1366 {
1367 emsg_severe = TRUE;
Bram Moolenaar4830c212021-08-14 14:59:27 +02001368 if (!did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00001369 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001370 break;
1371 }
1372 }
1373 else
1374 {
1375 // get_name_len() takes care of expanding curly braces
1376 name_start = name = arg;
1377 len = get_name_len(&arg, &tofree, TRUE, TRUE);
1378 if (len <= 0)
1379 {
1380 // This is mainly to keep test 49 working: when expanding
1381 // curly braces fails overrule the exception error message.
1382 if (len < 0 && !aborting())
1383 {
1384 emsg_severe = TRUE;
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001385 semsg(_(e_invalid_argument_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001386 break;
1387 }
1388 error = TRUE;
1389 }
1390 else
1391 {
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02001392 arg = skipwhite(arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001393 if (tofree != NULL)
1394 name = tofree;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001395 if (eval_variable(name, len, 0, &tv, NULL,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01001396 EVAL_VAR_VERBOSE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001397 error = TRUE;
1398 else
1399 {
1400 // handle d.key, l[idx], f(expr)
1401 arg_subsc = arg;
Bram Moolenaar32884ad2022-01-07 12:45:29 +00001402 if (handle_subscript(&arg, name_start, &tv,
1403 &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001404 error = TRUE;
1405 else
1406 {
1407 if (arg == arg_subsc && len == 2 && name[1] == ':')
1408 {
1409 switch (*name)
1410 {
1411 case 'g': list_glob_vars(first); break;
1412 case 'b': list_buf_vars(first); break;
1413 case 'w': list_win_vars(first); break;
1414 case 't': list_tab_vars(first); break;
1415 case 'v': list_vim_vars(first); break;
1416 case 's': list_script_vars(first); break;
1417 case 'l': list_func_vars(first); break;
1418 default:
Bram Moolenaara6f79292022-01-04 21:30:47 +00001419 semsg(_(e_cant_list_variables_for_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001420 }
1421 }
1422 else
1423 {
1424 char_u numbuf[NUMBUFLEN];
1425 char_u *tf;
1426 int c;
1427 char_u *s;
1428
1429 s = echo_string(&tv, &tf, numbuf, 0);
1430 c = *arg;
1431 *arg = NUL;
1432 list_one_var_a("",
1433 arg == arg_subsc ? name : name_start,
1434 tv.v_type,
1435 s == NULL ? (char_u *)"" : s,
1436 first);
1437 *arg = c;
1438 vim_free(tf);
1439 }
1440 clear_tv(&tv);
1441 }
1442 }
1443 }
1444
1445 vim_free(tofree);
1446 }
1447
1448 arg = skipwhite(arg);
1449 }
1450
1451 return arg;
1452}
1453
1454/*
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001455 * Set an environment variable, part of ex_let_one().
1456 */
1457 static char_u *
1458ex_let_env(
1459 char_u *arg,
1460 typval_T *tv,
1461 int flags,
1462 char_u *endchars,
1463 char_u *op)
1464{
1465 char_u *arg_end = NULL;
1466 char_u *name;
1467 int len;
1468
1469 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1470 && (flags & ASSIGN_FOR_LOOP) == 0)
1471 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001472 emsg(_(e_cannot_lock_environment_variable));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001473 return NULL;
1474 }
1475
1476 // Find the end of the name.
1477 ++arg;
1478 name = arg;
1479 len = get_env_len(&arg);
1480 if (len == 0)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001481 semsg(_(e_invalid_argument_str), name - 1);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001482 else
1483 {
1484 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001485 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001486 else if (endchars != NULL
1487 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
1488 emsg(_(e_unexpected_characters_in_let));
1489 else if (!check_secure())
1490 {
1491 char_u *tofree = NULL;
1492 int c1 = name[len];
1493 char_u *p;
1494
1495 name[len] = NUL;
1496 p = tv_get_string_chk(tv);
1497 if (p != NULL && op != NULL && *op == '.')
1498 {
1499 int mustfree = FALSE;
1500 char_u *s = vim_getenv(name, &mustfree);
1501
1502 if (s != NULL)
1503 {
1504 p = tofree = concat_str(s, p);
1505 if (mustfree)
1506 vim_free(s);
1507 }
1508 }
1509 if (p != NULL)
1510 {
1511 vim_setenv_ext(name, p);
1512 arg_end = arg;
1513 }
1514 name[len] = c1;
1515 vim_free(tofree);
1516 }
1517 }
1518 return arg_end;
1519}
1520
1521/*
1522 * Set an option, part of ex_let_one().
1523 */
1524 static char_u *
1525ex_let_option(
1526 char_u *arg,
1527 typval_T *tv,
1528 int flags,
1529 char_u *endchars,
1530 char_u *op)
1531{
1532 char_u *p;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001533 int scope;
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001534 char_u *arg_end = NULL;
1535
1536 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1537 && (flags & ASSIGN_FOR_LOOP) == 0)
1538 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001539 emsg(_(e_cannot_lock_option));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001540 return NULL;
1541 }
1542
1543 // Find the end of the name.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001544 p = find_option_end(&arg, &scope);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001545 if (p == NULL || (endchars != NULL
1546 && vim_strchr(endchars, *skipwhite(p)) == NULL))
1547 emsg(_(e_unexpected_characters_in_let));
1548 else
1549 {
1550 int c1;
1551 long n = 0;
1552 getoption_T opt_type;
1553 long numval;
1554 char_u *stringval = NULL;
1555 char_u *s = NULL;
1556 int failed = FALSE;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001557 int opt_p_flags;
1558 char_u *tofree = NULL;
Bram Moolenaar92c33eb2021-12-07 11:03:39 +00001559 char_u numbuf[NUMBUFLEN];
1560
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001561 c1 = *p;
1562 *p = NUL;
1563
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001564 opt_type = get_option_value(arg, &numval, &stringval, &opt_p_flags,
1565 scope);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001566 if ((opt_type == gov_bool
1567 || opt_type == gov_number
1568 || opt_type == gov_hidden_bool
1569 || opt_type == gov_hidden_number)
1570 && (tv->v_type != VAR_STRING || !in_vim9script()))
1571 {
1572 if (opt_type == gov_bool || opt_type == gov_hidden_bool)
1573 // bool, possibly hidden
1574 n = (long)tv_get_bool(tv);
1575 else
1576 // number, possibly hidden
1577 n = (long)tv_get_number(tv);
1578 }
1579
Bram Moolenaaref082e12021-12-12 21:02:03 +00001580 if ((opt_p_flags & P_FUNC) && (tv->v_type == VAR_PARTIAL
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001581 || tv->v_type == VAR_FUNC))
1582 {
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001583 // If the option can be set to a function reference or a lambda
1584 // and the passed value is a function reference, then convert it to
1585 // the name (string) of the function reference.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001586 s = tv2string(tv, &tofree, numbuf, 0);
1587 }
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001588 // Avoid setting a string option to the text "v:false" or similar.
1589 // In Vim9 script also don't convert a number to string.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001590 else if (tv->v_type != VAR_BOOL && tv->v_type != VAR_SPECIAL
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001591 && (!in_vim9script() || tv->v_type != VAR_NUMBER))
1592 s = tv_get_string_chk(tv);
1593
1594 if (op != NULL && *op != '=')
1595 {
1596 if (((opt_type == gov_bool || opt_type == gov_number) && *op == '.')
1597 || (opt_type == gov_string && *op != '.'))
1598 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001599 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001600 failed = TRUE; // don't set the value
1601
1602 }
1603 else
1604 {
1605 // number, in legacy script also bool
1606 if (opt_type == gov_number
1607 || (opt_type == gov_bool && !in_vim9script()))
1608 {
1609 switch (*op)
1610 {
1611 case '+': n = numval + n; break;
1612 case '-': n = numval - n; break;
1613 case '*': n = numval * n; break;
1614 case '/': n = (long)num_divide(numval, n,
1615 &failed); break;
1616 case '%': n = (long)num_modulus(numval, n,
1617 &failed); break;
1618 }
1619 s = NULL;
1620 }
1621 else if (opt_type == gov_string
1622 && stringval != NULL && s != NULL)
1623 {
1624 // string
1625 s = concat_str(stringval, s);
1626 vim_free(stringval);
1627 stringval = s;
1628 }
1629 }
1630 }
1631
1632 if (!failed)
1633 {
1634 if (opt_type != gov_string || s != NULL)
1635 {
Bram Moolenaar8ccbbeb2022-03-02 19:49:38 +00001636 char *err = set_option_value(arg, n, s, scope);
1637
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001638 arg_end = p;
Bram Moolenaar8ccbbeb2022-03-02 19:49:38 +00001639 if (err != NULL)
1640 emsg(_(err));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001641 }
1642 else
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001643 emsg(_(e_string_required));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001644 }
1645 *p = c1;
1646 vim_free(stringval);
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001647 vim_free(tofree);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001648 }
1649 return arg_end;
1650}
1651
1652/*
1653 * Set a register, part of ex_let_one().
1654 */
1655 static char_u *
1656ex_let_register(
1657 char_u *arg,
1658 typval_T *tv,
1659 int flags,
1660 char_u *endchars,
1661 char_u *op)
1662{
1663 char_u *arg_end = NULL;
1664
1665 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1666 && (flags & ASSIGN_FOR_LOOP) == 0)
1667 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001668 emsg(_(e_cannot_lock_register));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001669 return NULL;
1670 }
1671 ++arg;
1672 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001673 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001674 else if (endchars != NULL
1675 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
1676 emsg(_(e_unexpected_characters_in_let));
1677 else
1678 {
1679 char_u *ptofree = NULL;
1680 char_u *p;
1681
1682 p = tv_get_string_chk(tv);
1683 if (p != NULL && op != NULL && *op == '.')
1684 {
1685 char_u *s = get_reg_contents(*arg == '@'
1686 ? '"' : *arg, GREG_EXPR_SRC);
1687
1688 if (s != NULL)
1689 {
1690 p = ptofree = concat_str(s, p);
1691 vim_free(s);
1692 }
1693 }
1694 if (p != NULL)
1695 {
1696 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
1697 arg_end = arg + 1;
1698 }
1699 vim_free(ptofree);
1700 }
1701 return arg_end;
1702}
1703
1704/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001705 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
1706 * Returns a pointer to the char just after the var name.
1707 * Returns NULL if there is an error.
1708 */
1709 static char_u *
1710ex_let_one(
1711 char_u *arg, // points to variable name
1712 typval_T *tv, // value to assign to variable
1713 int copy, // copy value from "tv"
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001714 int flags, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001715 char_u *endchars, // valid chars after variable name or NULL
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001716 char_u *op, // "+", "-", "." or NULL
1717 int var_idx) // variable index for "let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001718{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001719 char_u *arg_end = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001720
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001721 if (in_vim9script() && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001722 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001723 && vim_strchr((char_u *)"$@&", *arg) != NULL)
1724 {
1725 vim9_declare_error(arg);
1726 return NULL;
1727 }
1728
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001729 if (*arg == '$')
1730 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001731 // ":let $VAR = expr": Set environment variable.
1732 return ex_let_env(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001733 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001734 else if (*arg == '&')
1735 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001736 // ":let &option = expr": Set option value.
1737 // ":let &l:option = expr": Set local option value.
1738 // ":let &g:option = expr": Set global option value.
1739 // ":for &ts in range(8)": Set option value for for loop
1740 return ex_let_option(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001741 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001742 else if (*arg == '@')
1743 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001744 // ":let @r = expr": Set register contents.
1745 return ex_let_register(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001746 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001747 else if (eval_isnamec1(*arg) || *arg == '{')
1748 {
1749 lval_T lv;
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001750 char_u *p;
Bram Moolenaar22ebd172022-04-01 15:26:58 +01001751 int lval_flags = (flags & (ASSIGN_NO_DECL | ASSIGN_DECL))
1752 ? GLV_NO_DECL : 0;
1753 if (op != NULL && *op != '=')
1754 lval_flags |= GLV_ASSIGN_WITH_OP;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001755
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001756 // ":let var = expr": Set internal variable.
1757 // ":let var: type = expr": Set internal variable with type.
1758 // ":let {expr} = expr": Idem, name made with curly braces
Bram Moolenaar22ebd172022-04-01 15:26:58 +01001759 p = get_lval(arg, tv, &lv, FALSE, FALSE, lval_flags, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001760 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001761 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001762 if (endchars != NULL && vim_strchr(endchars,
1763 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001764 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001765 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001766 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001767 else
1768 {
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001769 set_var_lval(&lv, p, tv, copy, flags, op, var_idx);
Bram Moolenaara3589a02021-04-14 13:30:46 +02001770 arg_end = lv.ll_name_end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001771 }
1772 }
1773 clear_lval(&lv);
1774 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001775 else
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001776 semsg(_(e_invalid_argument_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001777
1778 return arg_end;
1779}
1780
1781/*
1782 * ":unlet[!] var1 ... " command.
1783 */
1784 void
1785ex_unlet(exarg_T *eap)
1786{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001787 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001788}
1789
1790/*
1791 * ":lockvar" and ":unlockvar" commands
1792 */
1793 void
1794ex_lockvar(exarg_T *eap)
1795{
1796 char_u *arg = eap->arg;
1797 int deep = 2;
1798
1799 if (eap->forceit)
1800 deep = -1;
1801 else if (vim_isdigit(*arg))
1802 {
1803 deep = getdigits(&arg);
1804 arg = skipwhite(arg);
1805 }
1806
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001807 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001808}
1809
1810/*
1811 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001812 * Also used for Vim9 script. "callback" is invoked as:
1813 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001814 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001815 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001816ex_unletlock(
1817 exarg_T *eap,
1818 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001819 int deep,
1820 int glv_flags,
1821 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1822 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001823{
1824 char_u *arg = argstart;
1825 char_u *name_end;
1826 int error = FALSE;
1827 lval_T lv;
1828
1829 do
1830 {
1831 if (*arg == '$')
1832 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001833 lv.ll_name = arg;
1834 lv.ll_tv = NULL;
1835 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001836 if (get_env_len(&arg) == 0)
1837 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001838 semsg(_(e_invalid_argument_str), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001839 return;
1840 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001841 if (!error && !eap->skip
1842 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1843 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001844 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001845 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001846 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001847 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001848 // Parse the name and find the end.
1849 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
Bram Moolenaarc3689572021-01-01 19:40:02 +01001850 glv_flags | GLV_NO_DECL, FNE_CHECK_START);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001851 if (lv.ll_name == NULL)
1852 error = TRUE; // error but continue parsing
1853 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1854 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001855 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001856 if (name_end != NULL)
1857 {
1858 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00001859 semsg(_(e_trailing_characters_str), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001860 }
1861 if (!(eap->skip || error))
1862 clear_lval(&lv);
1863 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001864 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001865
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001866 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001867 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001868 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001869
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001870 if (!eap->skip)
1871 clear_lval(&lv);
1872 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001873
1874 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001875 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001876
Bram Moolenaar63b91732021-08-05 20:40:03 +02001877 set_nextcmd(eap, arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001878}
1879
1880 static int
1881do_unlet_var(
1882 lval_T *lp,
1883 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001884 exarg_T *eap,
1885 int deep UNUSED,
1886 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001887{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001888 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001889 int ret = OK;
1890 int cc;
1891
1892 if (lp->ll_tv == NULL)
1893 {
1894 cc = *name_end;
1895 *name_end = NUL;
1896
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001897 // Environment variable, normal name or expanded name.
1898 if (*lp->ll_name == '$')
LemonBoy77142312022-04-15 20:50:46 +01001899 vim_unsetenv_ext(lp->ll_name + 1);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001900 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001901 ret = FAIL;
1902 *name_end = cc;
1903 }
1904 else if ((lp->ll_list != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001905 && value_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001906 || (lp->ll_dict != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001907 && value_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001908 return FAIL;
1909 else if (lp->ll_range)
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00001910 list_unlet_range(lp->ll_list, lp->ll_li, lp->ll_n1,
1911 !lp->ll_empty2, lp->ll_n2);
1912 else if (lp->ll_list != NULL)
1913 // unlet a List item.
1914 listitem_remove(lp->ll_list, lp->ll_li);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001915 else
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00001916 // unlet a Dictionary item.
1917 dictitem_remove(lp->ll_dict, lp->ll_di);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001918
1919 return ret;
1920}
1921
1922/*
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01001923 * Unlet one item or a range of items from a list.
1924 * Return OK or FAIL.
1925 */
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00001926 void
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01001927list_unlet_range(
1928 list_T *l,
1929 listitem_T *li_first,
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01001930 long n1_arg,
1931 int has_n2,
1932 long n2)
1933{
1934 listitem_T *li = li_first;
1935 int n1 = n1_arg;
1936
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01001937 // Delete a range of List items.
1938 li = li_first;
1939 n1 = n1_arg;
1940 while (li != NULL && (!has_n2 || n2 >= n1))
1941 {
1942 listitem_T *next = li->li_next;
1943
1944 listitem_remove(l, li);
1945 li = next;
1946 ++n1;
1947 }
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01001948}
1949/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001950 * "unlet" a variable. Return OK if it existed, FAIL if not.
1951 * When "forceit" is TRUE don't complain if the variable doesn't exist.
1952 */
1953 int
1954do_unlet(char_u *name, int forceit)
1955{
1956 hashtab_T *ht;
1957 hashitem_T *hi;
1958 char_u *varname;
1959 dict_T *d;
1960 dictitem_T *di;
1961
Bram Moolenaar9aed7292020-12-18 15:38:00 +01001962 // can't :unlet a script variable in Vim9 script
Bram Moolenaareb6880b2020-07-12 17:07:05 +02001963 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001964 return FAIL;
1965
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001966 ht = find_var_ht(name, &varname);
Bram Moolenaar9aed7292020-12-18 15:38:00 +01001967
1968 // can't :unlet a script variable in Vim9 script from a function
1969 if (ht == get_script_local_ht()
1970 && SCRIPT_ID_VALID(current_sctx.sc_sid)
1971 && SCRIPT_ITEM(current_sctx.sc_sid)->sn_version
1972 == SCRIPT_VERSION_VIM9
1973 && check_vim9_unlet(name) == FAIL)
1974 return FAIL;
1975
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001976 if (ht != NULL && *varname != NUL)
1977 {
1978 d = get_current_funccal_dict(ht);
1979 if (d == NULL)
1980 {
1981 if (ht == &globvarht)
1982 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02001983 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001984 d = &vimvardict;
1985 else
1986 {
1987 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
1988 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
1989 }
1990 if (d == NULL)
1991 {
1992 internal_error("do_unlet()");
1993 return FAIL;
1994 }
1995 }
1996 hi = hash_find(ht, varname);
1997 if (HASHITEM_EMPTY(hi))
1998 hi = find_hi_in_scoped_ht(name, &ht);
1999 if (hi != NULL && !HASHITEM_EMPTY(hi))
2000 {
2001 di = HI2DI(hi);
2002 if (var_check_fixed(di->di_flags, name, FALSE)
2003 || var_check_ro(di->di_flags, name, FALSE)
Bram Moolenaara187c432020-09-16 21:08:28 +02002004 || value_check_lock(d->dv_lock, name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002005 return FAIL;
2006
2007 delete_var(ht, hi);
2008 return OK;
2009 }
2010 }
2011 if (forceit)
2012 return OK;
Bram Moolenaare1242042021-12-16 20:56:57 +00002013 semsg(_(e_no_such_variable_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002014 return FAIL;
2015}
2016
2017/*
2018 * Lock or unlock variable indicated by "lp".
2019 * "deep" is the levels to go (-1 for unlimited);
2020 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
2021 */
2022 static int
2023do_lock_var(
2024 lval_T *lp,
2025 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002026 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002027 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002028 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002029{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002030 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002031 int ret = OK;
2032 int cc;
2033 dictitem_T *di;
2034
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002035 if (lp->ll_tv == NULL)
2036 {
2037 cc = *name_end;
2038 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002039 if (*lp->ll_name == '$')
2040 {
Bram Moolenaar3a846e62022-01-01 16:21:00 +00002041 semsg(_(e_cannot_lock_or_unlock_variable_str), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002042 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002043 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002044 else
2045 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002046 // Normal name or expanded name.
2047 di = find_var(lp->ll_name, NULL, TRUE);
2048 if (di == NULL)
Bram Moolenaar04b568b2021-11-22 21:58:41 +00002049 {
2050 if (in_vim9script())
2051 semsg(_(e_cannot_find_variable_to_unlock_str),
2052 lp->ll_name);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002053 ret = FAIL;
Bram Moolenaar04b568b2021-11-22 21:58:41 +00002054 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002055 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002056 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01002057 if ((di->di_flags & DI_FLAGS_FIX)
2058 && di->di_tv.v_type != VAR_DICT
2059 && di->di_tv.v_type != VAR_LIST)
2060 {
2061 // For historic reasons this error is not given for a list
2062 // or dict. E.g., the b: dict could be locked/unlocked.
2063 semsg(_(e_cannot_lock_or_unlock_variable_str), lp->ll_name);
2064 ret = FAIL;
2065 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002066 else
Bram Moolenaar7a411a32022-04-04 14:58:06 +01002067 {
2068 if (in_vim9script())
2069 {
2070 svar_T *sv = find_typval_in_script(&di->di_tv,
2071 0, FALSE);
2072
2073 if (sv != NULL && sv->sv_const != 0)
2074 {
2075 semsg(_(e_cannot_change_readonly_variable_str),
2076 lp->ll_name);
2077 ret = FAIL;
2078 }
2079 }
2080
2081 if (ret == OK)
2082 {
2083 if (lock)
2084 di->di_flags |= DI_FLAGS_LOCK;
2085 else
2086 di->di_flags &= ~DI_FLAGS_LOCK;
2087 if (deep != 0)
2088 item_lock(&di->di_tv, deep, lock, FALSE);
2089 }
2090 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002091 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002092 }
2093 *name_end = cc;
2094 }
Bram Moolenaara187c432020-09-16 21:08:28 +02002095 else if (deep == 0)
2096 {
2097 // nothing to do
2098 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002099 else if (lp->ll_range)
2100 {
2101 listitem_T *li = lp->ll_li;
2102
2103 // (un)lock a range of List items.
2104 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
2105 {
Bram Moolenaar021bda52020-08-17 21:07:22 +02002106 item_lock(&li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002107 li = li->li_next;
2108 ++lp->ll_n1;
2109 }
2110 }
2111 else if (lp->ll_list != NULL)
2112 // (un)lock a List item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002113 item_lock(&lp->ll_li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002114 else
2115 // (un)lock a Dictionary item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002116 item_lock(&lp->ll_di->di_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002117
2118 return ret;
2119}
2120
2121/*
2122 * Lock or unlock an item. "deep" is nr of levels to go.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002123 * When "check_refcount" is TRUE do not lock a list or dict with a reference
2124 * count larger than 1.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002125 */
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02002126 void
Bram Moolenaar021bda52020-08-17 21:07:22 +02002127item_lock(typval_T *tv, int deep, int lock, int check_refcount)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002128{
2129 static int recurse = 0;
2130 list_T *l;
2131 listitem_T *li;
2132 dict_T *d;
2133 blob_T *b;
2134 hashitem_T *hi;
2135 int todo;
2136
2137 if (recurse >= DICT_MAXNEST)
2138 {
Bram Moolenaar677658a2022-01-05 16:09:06 +00002139 emsg(_(e_variable_nested_too_deep_for_unlock));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002140 return;
2141 }
2142 if (deep == 0)
2143 return;
2144 ++recurse;
2145
2146 // lock/unlock the item itself
2147 if (lock)
2148 tv->v_lock |= VAR_LOCKED;
2149 else
2150 tv->v_lock &= ~VAR_LOCKED;
2151
2152 switch (tv->v_type)
2153 {
2154 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02002155 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002156 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002157 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002158 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002159 case VAR_STRING:
2160 case VAR_FUNC:
2161 case VAR_PARTIAL:
2162 case VAR_FLOAT:
2163 case VAR_SPECIAL:
2164 case VAR_JOB:
2165 case VAR_CHANNEL:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02002166 case VAR_INSTR:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002167 break;
2168
2169 case VAR_BLOB:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002170 if ((b = tv->vval.v_blob) != NULL
2171 && !(check_refcount && b->bv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002172 {
2173 if (lock)
2174 b->bv_lock |= VAR_LOCKED;
2175 else
2176 b->bv_lock &= ~VAR_LOCKED;
2177 }
2178 break;
2179 case VAR_LIST:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002180 if ((l = tv->vval.v_list) != NULL
2181 && !(check_refcount && l->lv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002182 {
2183 if (lock)
2184 l->lv_lock |= VAR_LOCKED;
2185 else
2186 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar70c43d82022-01-26 21:01:15 +00002187 if (deep < 0 || deep > 1)
2188 {
2189 if (l->lv_first == &range_list_item)
2190 l->lv_lock |= VAR_ITEMS_LOCKED;
2191 else
2192 {
2193 // recursive: lock/unlock the items the List contains
2194 CHECK_LIST_MATERIALIZE(l);
2195 FOR_ALL_LIST_ITEMS(l, li) item_lock(&li->li_tv,
2196 deep - 1, lock, check_refcount);
2197 }
2198 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002199 }
2200 break;
2201 case VAR_DICT:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002202 if ((d = tv->vval.v_dict) != NULL
2203 && !(check_refcount && d->dv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002204 {
2205 if (lock)
2206 d->dv_lock |= VAR_LOCKED;
2207 else
2208 d->dv_lock &= ~VAR_LOCKED;
2209 if (deep < 0 || deep > 1)
2210 {
2211 // recursive: lock/unlock the items the List contains
2212 todo = (int)d->dv_hashtab.ht_used;
2213 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
2214 {
2215 if (!HASHITEM_EMPTY(hi))
2216 {
2217 --todo;
Bram Moolenaar021bda52020-08-17 21:07:22 +02002218 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock,
2219 check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002220 }
2221 }
2222 }
2223 }
2224 }
2225 --recurse;
2226}
2227
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002228#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
2229/*
2230 * Delete all "menutrans_" variables.
2231 */
2232 void
2233del_menutrans_vars(void)
2234{
2235 hashitem_T *hi;
2236 int todo;
2237
2238 hash_lock(&globvarht);
2239 todo = (int)globvarht.ht_used;
2240 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
2241 {
2242 if (!HASHITEM_EMPTY(hi))
2243 {
2244 --todo;
2245 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
2246 delete_var(&globvarht, hi);
2247 }
2248 }
2249 hash_unlock(&globvarht);
2250}
2251#endif
2252
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002253/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002254 * Local string buffer for the next two functions to store a variable name
2255 * with its prefix. Allocated in cat_prefix_varname(), freed later in
2256 * get_user_var_name().
2257 */
2258
2259static char_u *varnamebuf = NULL;
2260static int varnamebuflen = 0;
2261
2262/*
2263 * Function to concatenate a prefix and a variable name.
2264 */
Bram Moolenaar1bb4de52021-01-13 19:48:46 +01002265 char_u *
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002266cat_prefix_varname(int prefix, char_u *name)
2267{
2268 int len;
2269
2270 len = (int)STRLEN(name) + 3;
2271 if (len > varnamebuflen)
2272 {
2273 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002274 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002275 varnamebuf = alloc(len);
2276 if (varnamebuf == NULL)
2277 {
2278 varnamebuflen = 0;
2279 return NULL;
2280 }
2281 varnamebuflen = len;
2282 }
2283 *varnamebuf = prefix;
2284 varnamebuf[1] = ':';
2285 STRCPY(varnamebuf + 2, name);
2286 return varnamebuf;
2287}
2288
2289/*
2290 * Function given to ExpandGeneric() to obtain the list of user defined
2291 * (global/buffer/window/built-in) variable names.
2292 */
2293 char_u *
2294get_user_var_name(expand_T *xp, int idx)
2295{
2296 static long_u gdone;
2297 static long_u bdone;
2298 static long_u wdone;
2299 static long_u tdone;
2300 static int vidx;
2301 static hashitem_T *hi;
2302 hashtab_T *ht;
2303
2304 if (idx == 0)
2305 {
2306 gdone = bdone = wdone = vidx = 0;
2307 tdone = 0;
2308 }
2309
2310 // Global variables
2311 if (gdone < globvarht.ht_used)
2312 {
2313 if (gdone++ == 0)
2314 hi = globvarht.ht_array;
2315 else
2316 ++hi;
2317 while (HASHITEM_EMPTY(hi))
2318 ++hi;
2319 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
2320 return cat_prefix_varname('g', hi->hi_key);
2321 return hi->hi_key;
2322 }
2323
2324 // b: variables
Bram Moolenaar0f6e28f2022-02-20 20:49:35 +00002325 ht = &prevwin_curwin()->w_buffer->b_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002326 if (bdone < ht->ht_used)
2327 {
2328 if (bdone++ == 0)
2329 hi = ht->ht_array;
2330 else
2331 ++hi;
2332 while (HASHITEM_EMPTY(hi))
2333 ++hi;
2334 return cat_prefix_varname('b', hi->hi_key);
2335 }
2336
2337 // w: variables
Bram Moolenaar0f6e28f2022-02-20 20:49:35 +00002338 ht = &prevwin_curwin()->w_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002339 if (wdone < ht->ht_used)
2340 {
2341 if (wdone++ == 0)
2342 hi = ht->ht_array;
2343 else
2344 ++hi;
2345 while (HASHITEM_EMPTY(hi))
2346 ++hi;
2347 return cat_prefix_varname('w', hi->hi_key);
2348 }
2349
2350 // t: variables
2351 ht = &curtab->tp_vars->dv_hashtab;
2352 if (tdone < ht->ht_used)
2353 {
2354 if (tdone++ == 0)
2355 hi = ht->ht_array;
2356 else
2357 ++hi;
2358 while (HASHITEM_EMPTY(hi))
2359 ++hi;
2360 return cat_prefix_varname('t', hi->hi_key);
2361 }
2362
2363 // v: variables
2364 if (vidx < VV_LEN)
2365 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
2366
2367 VIM_CLEAR(varnamebuf);
2368 varnamebuflen = 0;
2369 return NULL;
2370}
2371
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002372 char *
2373get_var_special_name(int nr)
2374{
2375 switch (nr)
2376 {
Bram Moolenaara8b8af12021-01-01 15:11:04 +01002377 case VVAL_FALSE: return in_vim9script() ? "false" : "v:false";
2378 case VVAL_TRUE: return in_vim9script() ? "true" : "v:true";
Bram Moolenaar67977822021-01-03 21:53:53 +01002379 case VVAL_NULL: return in_vim9script() ? "null" : "v:null";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002380 case VVAL_NONE: return "v:none";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002381 }
2382 internal_error("get_var_special_name()");
2383 return "42";
2384}
2385
2386/*
2387 * Returns the global variable dictionary
2388 */
2389 dict_T *
2390get_globvar_dict(void)
2391{
2392 return &globvardict;
2393}
2394
2395/*
2396 * Returns the global variable hash table
2397 */
2398 hashtab_T *
2399get_globvar_ht(void)
2400{
2401 return &globvarht;
2402}
2403
2404/*
2405 * Returns the v: variable dictionary
2406 */
2407 dict_T *
2408get_vimvar_dict(void)
2409{
2410 return &vimvardict;
2411}
2412
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002413/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002414 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002415 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002416 */
2417 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002418find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002419{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002420 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2421 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002422
2423 if (di == NULL)
2424 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002425 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002426 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2427 return (int)(vv - vimvars);
2428}
2429
2430
2431/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002432 * Set type of v: variable to "type".
2433 */
2434 void
2435set_vim_var_type(int idx, vartype_T type)
2436{
Bram Moolenaard787e402021-12-24 21:36:12 +00002437 vimvars[idx].vv_tv_type = type;
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002438}
2439
2440/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002441 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002442 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002443 */
2444 void
2445set_vim_var_nr(int idx, varnumber_T val)
2446{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002447 vimvars[idx].vv_nr = val;
2448}
2449
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002450 char *
2451get_vim_var_name(int idx)
2452{
2453 return vimvars[idx].vv_name;
2454}
2455
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002456/*
2457 * Get typval_T v: variable value.
2458 */
2459 typval_T *
2460get_vim_var_tv(int idx)
2461{
2462 return &vimvars[idx].vv_tv;
2463}
2464
Bram Moolenaard787e402021-12-24 21:36:12 +00002465 type_T *
2466get_vim_var_type(int idx, garray_T *type_list)
2467{
2468 if (vimvars[idx].vv_type != NULL)
2469 return vimvars[idx].vv_type;
2470 return typval2type_vimvar(&vimvars[idx].vv_tv, type_list);
2471}
2472
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002473/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002474 * Set v: variable to "tv". Only accepts the same type.
2475 * Takes over the value of "tv".
2476 */
2477 int
2478set_vim_var_tv(int idx, typval_T *tv)
2479{
Bram Moolenaard787e402021-12-24 21:36:12 +00002480 if (vimvars[idx].vv_tv_type != tv->v_type)
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002481 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002482 emsg(_(e_type_mismatch_for_v_variable));
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002483 clear_tv(tv);
2484 return FAIL;
2485 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002486 // VV_RO is also checked when compiling, but let's check here as well.
2487 if (vimvars[idx].vv_flags & VV_RO)
2488 {
Bram Moolenaard8e44472021-07-21 22:20:33 +02002489 semsg(_(e_cannot_change_readonly_variable_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002490 return FAIL;
2491 }
2492 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2493 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00002494 semsg(_(e_cannot_set_variable_in_sandbox_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002495 return FAIL;
2496 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002497 clear_tv(&vimvars[idx].vv_di.di_tv);
2498 vimvars[idx].vv_di.di_tv = *tv;
2499 return OK;
2500}
2501
2502/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002503 * Get number v: variable value.
2504 */
2505 varnumber_T
2506get_vim_var_nr(int idx)
2507{
2508 return vimvars[idx].vv_nr;
2509}
2510
2511/*
2512 * Get string v: variable value. Uses a static buffer, can only be used once.
2513 * If the String variable has never been set, return an empty string.
2514 * Never returns NULL;
2515 */
2516 char_u *
2517get_vim_var_str(int idx)
2518{
2519 return tv_get_string(&vimvars[idx].vv_tv);
2520}
2521
2522/*
2523 * Get List v: variable value. Caller must take care of reference count when
2524 * needed.
2525 */
2526 list_T *
2527get_vim_var_list(int idx)
2528{
2529 return vimvars[idx].vv_list;
2530}
2531
2532/*
2533 * Get Dict v: variable value. Caller must take care of reference count when
2534 * needed.
2535 */
2536 dict_T *
2537get_vim_var_dict(int idx)
2538{
2539 return vimvars[idx].vv_dict;
2540}
2541
2542/*
2543 * Set v:char to character "c".
2544 */
2545 void
2546set_vim_var_char(int c)
2547{
2548 char_u buf[MB_MAXBYTES + 1];
2549
2550 if (has_mbyte)
2551 buf[(*mb_char2bytes)(c, buf)] = NUL;
2552 else
2553 {
2554 buf[0] = c;
2555 buf[1] = NUL;
2556 }
2557 set_vim_var_string(VV_CHAR, buf, -1);
2558}
2559
2560/*
2561 * Set v:count to "count" and v:count1 to "count1".
2562 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2563 */
2564 void
2565set_vcount(
2566 long count,
2567 long count1,
2568 int set_prevcount)
2569{
2570 if (set_prevcount)
2571 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2572 vimvars[VV_COUNT].vv_nr = count;
2573 vimvars[VV_COUNT1].vv_nr = count1;
2574}
2575
2576/*
2577 * Save variables that might be changed as a side effect. Used when executing
2578 * a timer callback.
2579 */
2580 void
2581save_vimvars(vimvars_save_T *vvsave)
2582{
2583 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2584 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2585 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2586}
2587
2588/*
2589 * Restore variables saved by save_vimvars().
2590 */
2591 void
2592restore_vimvars(vimvars_save_T *vvsave)
2593{
2594 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2595 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2596 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2597}
2598
2599/*
2600 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2601 * value.
2602 */
2603 void
2604set_vim_var_string(
2605 int idx,
2606 char_u *val,
2607 int len) // length of "val" to use or -1 (whole string)
2608{
2609 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002610 vimvars[idx].vv_tv_type = VAR_STRING;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002611 if (val == NULL)
2612 vimvars[idx].vv_str = NULL;
2613 else if (len == -1)
2614 vimvars[idx].vv_str = vim_strsave(val);
2615 else
2616 vimvars[idx].vv_str = vim_strnsave(val, len);
2617}
2618
2619/*
2620 * Set List v: variable to "val".
2621 */
2622 void
2623set_vim_var_list(int idx, list_T *val)
2624{
2625 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002626 vimvars[idx].vv_tv_type = VAR_LIST;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002627 vimvars[idx].vv_list = val;
2628 if (val != NULL)
2629 ++val->lv_refcount;
2630}
2631
2632/*
2633 * Set Dictionary v: variable to "val".
2634 */
2635 void
2636set_vim_var_dict(int idx, dict_T *val)
2637{
2638 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002639 vimvars[idx].vv_tv_type = VAR_DICT;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002640 vimvars[idx].vv_dict = val;
2641 if (val != NULL)
2642 {
2643 ++val->dv_refcount;
2644 dict_set_items_ro(val);
2645 }
2646}
2647
2648/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002649 * Set the v:argv list.
2650 */
2651 void
2652set_argv_var(char **argv, int argc)
2653{
2654 list_T *l = list_alloc();
2655 int i;
2656
2657 if (l == NULL)
2658 getout(1);
2659 l->lv_lock = VAR_FIXED;
2660 for (i = 0; i < argc; ++i)
2661 {
2662 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2663 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002664 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002665 }
2666 set_vim_var_list(VV_ARGV, l);
2667}
2668
2669/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002670 * Reset v:register, taking the 'clipboard' setting into account.
2671 */
2672 void
2673reset_reg_var(void)
2674{
2675 int regname = 0;
2676
2677 // Adjust the register according to 'clipboard', so that when
2678 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2679#ifdef FEAT_CLIPBOARD
2680 adjust_clip_reg(&regname);
2681#endif
2682 set_reg_var(regname);
2683}
2684
2685/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002686 * Set v:register if needed.
2687 */
2688 void
2689set_reg_var(int c)
2690{
2691 char_u regname;
2692
2693 if (c == 0 || c == ' ')
2694 regname = '"';
2695 else
2696 regname = c;
2697 // Avoid free/alloc when the value is already right.
2698 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2699 set_vim_var_string(VV_REG, &regname, 1);
2700}
2701
2702/*
2703 * Get or set v:exception. If "oldval" == NULL, return the current value.
2704 * Otherwise, restore the value to "oldval" and return NULL.
2705 * Must always be called in pairs to save and restore v:exception! Does not
2706 * take care of memory allocations.
2707 */
2708 char_u *
2709v_exception(char_u *oldval)
2710{
2711 if (oldval == NULL)
2712 return vimvars[VV_EXCEPTION].vv_str;
2713
2714 vimvars[VV_EXCEPTION].vv_str = oldval;
2715 return NULL;
2716}
2717
2718/*
2719 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2720 * Otherwise, restore the value to "oldval" and return NULL.
2721 * Must always be called in pairs to save and restore v:throwpoint! Does not
2722 * take care of memory allocations.
2723 */
2724 char_u *
2725v_throwpoint(char_u *oldval)
2726{
2727 if (oldval == NULL)
2728 return vimvars[VV_THROWPOINT].vv_str;
2729
2730 vimvars[VV_THROWPOINT].vv_str = oldval;
2731 return NULL;
2732}
2733
2734/*
2735 * Set v:cmdarg.
2736 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2737 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2738 * Must always be called in pairs!
2739 */
2740 char_u *
2741set_cmdarg(exarg_T *eap, char_u *oldarg)
2742{
2743 char_u *oldval;
2744 char_u *newval;
2745 unsigned len;
2746
2747 oldval = vimvars[VV_CMDARG].vv_str;
2748 if (eap == NULL)
2749 {
2750 vim_free(oldval);
2751 vimvars[VV_CMDARG].vv_str = oldarg;
2752 return NULL;
2753 }
2754
2755 if (eap->force_bin == FORCE_BIN)
2756 len = 6;
2757 else if (eap->force_bin == FORCE_NOBIN)
2758 len = 8;
2759 else
2760 len = 0;
2761
2762 if (eap->read_edit)
2763 len += 7;
2764
2765 if (eap->force_ff != 0)
2766 len += 10; // " ++ff=unix"
2767 if (eap->force_enc != 0)
2768 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2769 if (eap->bad_char != 0)
2770 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2771
2772 newval = alloc(len + 1);
2773 if (newval == NULL)
2774 return NULL;
2775
2776 if (eap->force_bin == FORCE_BIN)
2777 sprintf((char *)newval, " ++bin");
2778 else if (eap->force_bin == FORCE_NOBIN)
2779 sprintf((char *)newval, " ++nobin");
2780 else
2781 *newval = NUL;
2782
2783 if (eap->read_edit)
2784 STRCAT(newval, " ++edit");
2785
2786 if (eap->force_ff != 0)
2787 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2788 eap->force_ff == 'u' ? "unix"
2789 : eap->force_ff == 'd' ? "dos"
2790 : "mac");
2791 if (eap->force_enc != 0)
2792 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2793 eap->cmd + eap->force_enc);
2794 if (eap->bad_char == BAD_KEEP)
2795 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2796 else if (eap->bad_char == BAD_DROP)
2797 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2798 else if (eap->bad_char != 0)
2799 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2800 vimvars[VV_CMDARG].vv_str = newval;
2801 return oldval;
2802}
2803
2804/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002805 * Get the value of internal variable "name".
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002806 * If "flags" has EVAL_VAR_IMPORT may return a VAR_ANY with v_number set to the
2807 * imported script ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002808 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2809 */
2810 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002811eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002812 char_u *name,
2813 int len, // length of "name"
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002814 scid_T sid, // script ID for imported item or zero
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002815 typval_T *rettv, // NULL when only checking existence
2816 dictitem_T **dip, // non-NULL when typval's dict item is needed
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002817 int flags) // EVAL_VAR_ flags
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002818{
2819 int ret = OK;
2820 typval_T *tv = NULL;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002821 int found = FALSE;
Bram Moolenaarf055d452021-07-08 20:57:24 +02002822 hashtab_T *ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002823 int cc;
Bram Moolenaarc967d572021-07-08 21:38:50 +02002824 type_T *type = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002825
2826 // truncate the name, so that we can use strcmp()
2827 cc = name[len];
2828 name[len] = NUL;
2829
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002830 // Check for local variable when debugging.
2831 if ((tv = lookup_debug_var(name)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002832 {
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002833 // Check for user-defined variables.
Bram Moolenaarc967d572021-07-08 21:38:50 +02002834 dictitem_T *v = find_var(name, &ht, flags & EVAL_VAR_NOAUTOLOAD);
2835
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002836 if (v != NULL)
2837 {
2838 tv = &v->di_tv;
2839 if (dip != NULL)
2840 *dip = v;
2841 }
Bram Moolenaarc967d572021-07-08 21:38:50 +02002842 else
2843 ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002844 }
2845
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002846 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002847 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002848 imported_T *import = NULL;
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002849 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
2850
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002851 if (sid == 0)
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00002852 import = find_imported(p, 0, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002853
2854 // imported variable from another script
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002855 if (import != NULL || sid != 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002856 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002857 if ((flags & EVAL_VAR_IMPORT) == 0)
Bram Moolenaarc620c052020-07-08 15:16:19 +02002858 {
Bram Moolenaar71f21932022-01-07 18:20:55 +00002859 if (SCRIPT_ID_VALID(sid))
Bram Moolenaarc620c052020-07-08 15:16:19 +02002860 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002861 ht = &SCRIPT_VARS(sid);
2862 if (ht != NULL)
2863 {
2864 dictitem_T *v = find_var_in_ht(ht, 0, name,
2865 flags & EVAL_VAR_NOAUTOLOAD);
2866
2867 if (v != NULL)
2868 {
2869 tv = &v->di_tv;
2870 if (dip != NULL)
2871 *dip = v;
2872 }
2873 else
2874 ht = NULL;
2875 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002876 }
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002877 else
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002878 {
2879 if (flags & EVAL_VAR_VERBOSE)
Bram Moolenaardd5893b2022-01-20 21:32:54 +00002880 semsg(_(e_expected_dot_after_name_str), name);
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002881 ret = FAIL;
2882 }
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002883 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002884 else
2885 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002886 if (rettv != NULL)
2887 {
2888 rettv->v_type = VAR_ANY;
2889 rettv->vval.v_number = sid != 0 ? sid : import->imp_sid;
2890 }
2891 found = TRUE;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002892 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002893 }
Bram Moolenaar052ff292021-12-11 13:54:46 +00002894 else if (in_vim9script() && (flags & EVAL_VAR_NO_FUNC) == 0)
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002895 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002896 int has_g_prefix = STRNCMP(name, "g:", 2) == 0;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002897 ufunc_T *ufunc = find_func(name, FALSE);
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002898
Bram Moolenaarb033ee22021-08-15 16:08:36 +02002899 // In Vim9 script we can get a function reference by using the
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002900 // function name. For a global non-autoload function "g:" is
2901 // required.
2902 if (ufunc != NULL && (has_g_prefix
2903 || !func_requires_g_prefix(ufunc)))
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002904 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002905 found = TRUE;
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002906 if (rettv != NULL)
2907 {
2908 rettv->v_type = VAR_FUNC;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002909 if (has_g_prefix)
Bram Moolenaaref082e12021-12-12 21:02:03 +00002910 // Keep the "g:", otherwise script-local may be
2911 // assumed.
2912 rettv->vval.v_string = vim_strsave(name);
2913 else
2914 rettv->vval.v_string = vim_strsave(ufunc->uf_name);
Bram Moolenaarb033ee22021-08-15 16:08:36 +02002915 if (rettv->vval.v_string != NULL)
2916 func_ref(ufunc->uf_name);
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002917 }
2918 }
2919 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002920 }
2921
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002922 if (!found)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002923 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02002924 if (tv == NULL)
2925 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002926 if (rettv != NULL && (flags & EVAL_VAR_VERBOSE))
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002927 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarc620c052020-07-08 15:16:19 +02002928 ret = FAIL;
2929 }
2930 else if (rettv != NULL)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002931 {
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01002932 svar_T *sv = NULL;
2933 int was_assigned = FALSE;
2934
Bram Moolenaar11005b02021-07-11 20:59:00 +02002935 if (ht != NULL && ht == get_script_local_ht()
2936 && tv != &SCRIPT_SV(current_sctx.sc_sid)->sv_var.di_tv)
Bram Moolenaarf055d452021-07-08 20:57:24 +02002937 {
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01002938 sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaarf055d452021-07-08 20:57:24 +02002939 if (sv != NULL)
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01002940 {
Bram Moolenaarf055d452021-07-08 20:57:24 +02002941 type = sv->sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01002942 was_assigned = sv->sv_flags & SVFLAG_ASSIGNED;
2943 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02002944 }
2945
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01002946 // If a list or dict variable wasn't initialized and has meaningful
2947 // type, do it now. Not for global variables, they are not
2948 // declared.
Bram Moolenaar7a222242022-03-01 19:23:24 +00002949 if (ht != &globvarht)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002950 {
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01002951 if (tv->v_type == VAR_DICT && tv->vval.v_dict == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01002952 && ((type != NULL && !was_assigned)
Bram Moolenaar859cc212022-03-28 15:22:35 +01002953 || !in_vim9script()))
Bram Moolenaarf055d452021-07-08 20:57:24 +02002954 {
Bram Moolenaar7a222242022-03-01 19:23:24 +00002955 tv->vval.v_dict = dict_alloc();
2956 if (tv->vval.v_dict != NULL)
2957 {
2958 ++tv->vval.v_dict->dv_refcount;
2959 tv->vval.v_dict->dv_type = alloc_type(type);
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01002960 if (sv != NULL)
2961 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar7a222242022-03-01 19:23:24 +00002962 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02002963 }
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01002964 else if (tv->v_type == VAR_LIST && tv->vval.v_list == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01002965 && ((type != NULL && !was_assigned)
Bram Moolenaar501f9782022-03-27 16:51:04 +01002966 || !in_vim9script()))
Bram Moolenaarf055d452021-07-08 20:57:24 +02002967 {
Bram Moolenaar7a222242022-03-01 19:23:24 +00002968 tv->vval.v_list = list_alloc();
2969 if (tv->vval.v_list != NULL)
2970 {
2971 ++tv->vval.v_list->lv_refcount;
2972 tv->vval.v_list->lv_type = alloc_type(type);
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01002973 if (sv != NULL)
2974 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar7a222242022-03-01 19:23:24 +00002975 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02002976 }
Bram Moolenaar859cc212022-03-28 15:22:35 +01002977 else if (tv->v_type == VAR_BLOB && tv->vval.v_blob == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01002978 && ((type != NULL && !was_assigned)
Bram Moolenaar859cc212022-03-28 15:22:35 +01002979 || !in_vim9script()))
2980 {
2981 tv->vval.v_blob = blob_alloc();
2982 if (tv->vval.v_blob != NULL)
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01002983 {
Bram Moolenaar859cc212022-03-28 15:22:35 +01002984 ++tv->vval.v_blob->bv_refcount;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01002985 if (sv != NULL)
2986 sv->sv_flags |= SVFLAG_ASSIGNED;
2987 }
Bram Moolenaar859cc212022-03-28 15:22:35 +01002988 }
Bram Moolenaarb7c21af2021-04-18 14:12:31 +02002989 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002990 copy_tv(tv, rettv);
Bram Moolenaar348be7e2020-11-04 11:36:35 +01002991 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002992 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002993
2994 name[len] = cc;
2995
2996 return ret;
2997}
2998
2999/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003000 * Check if variable "name[len]" is a local variable or an argument.
3001 * If so, "*eval_lavars_used" is set to TRUE.
3002 */
3003 void
3004check_vars(char_u *name, int len)
3005{
3006 int cc;
3007 char_u *varname;
3008 hashtab_T *ht;
3009
3010 if (eval_lavars_used == NULL)
3011 return;
3012
3013 // truncate the name, so that we can use strcmp()
3014 cc = name[len];
3015 name[len] = NUL;
3016
3017 ht = find_var_ht(name, &varname);
3018 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
3019 {
3020 if (find_var(name, NULL, TRUE) != NULL)
3021 *eval_lavars_used = TRUE;
3022 }
3023
3024 name[len] = cc;
3025}
3026
3027/*
3028 * Find variable "name" in the list of variables.
3029 * Return a pointer to it if found, NULL if not found.
3030 * Careful: "a:0" variables don't have a name.
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003031 * When "htp" is not NULL set "htp" to the hashtab_T used.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003032 */
3033 dictitem_T *
3034find_var(char_u *name, hashtab_T **htp, int no_autoload)
3035{
3036 char_u *varname;
3037 hashtab_T *ht;
3038 dictitem_T *ret = NULL;
3039
3040 ht = find_var_ht(name, &varname);
3041 if (htp != NULL)
3042 *htp = ht;
3043 if (ht == NULL)
3044 return NULL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003045 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003046 if (ret != NULL)
3047 return ret;
3048
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003049 // Search in parent scope for lambda
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003050 ret = find_var_in_scoped_ht(name, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003051 if (ret != NULL)
3052 return ret;
3053
3054 // in Vim9 script items without a scope can be script-local
3055 if (in_vim9script() && name[0] != NUL && name[1] != ':')
3056 {
3057 ht = get_script_local_ht();
3058 if (ht != NULL)
3059 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003060 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003061 if (ret != NULL)
3062 {
3063 if (htp != NULL)
3064 *htp = ht;
3065 return ret;
3066 }
3067 }
3068 }
3069
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003070 // When using "vim9script autoload" script-local items are prefixed but can
3071 // be used with s:name.
3072 if (SCRIPT_ID_VALID(current_sctx.sc_sid)
3073 && name[0] == 's' && name[1] == ':')
3074 {
3075 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
3076
3077 if (si->sn_autoload_prefix != NULL)
3078 {
3079 char_u *auto_name = concat_str(si->sn_autoload_prefix, name + 2);
3080
3081 if (auto_name != NULL)
3082 {
3083 ht = &globvarht;
3084 ret = find_var_in_ht(ht, *name, auto_name, TRUE);
Bram Moolenaar130f65d2022-01-13 20:39:41 +00003085 vim_free(auto_name);
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003086 if (ret != NULL)
3087 {
3088 if (htp != NULL)
3089 *htp = ht;
3090 return ret;
3091 }
3092 }
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003093 }
3094 }
3095
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003096 return NULL;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003097}
3098
3099/*
Bram Moolenaar71f21932022-01-07 18:20:55 +00003100 * Like find_var() but if the name starts with <SNR>99_ then look in the
3101 * referenced script (used for a funcref).
3102 */
3103 dictitem_T *
3104find_var_also_in_script(char_u *name, hashtab_T **htp, int no_autoload)
3105{
3106 if (STRNCMP(name, "<SNR>", 5) == 0 && isdigit(name[5]))
3107 {
3108 char_u *p = name + 5;
3109 int sid = getdigits(&p);
3110
3111 if (SCRIPT_ID_VALID(sid) && *p == '_')
3112 {
3113 hashtab_T *ht = &SCRIPT_VARS(sid);
3114
3115 if (ht != NULL)
3116 {
3117 dictitem_T *di = find_var_in_ht(ht, 0, p + 1, no_autoload);
3118
3119 if (di != NULL)
Bram Moolenaaraa9b3ca2022-01-08 15:44:22 +00003120 {
3121 if (htp != NULL)
3122 *htp = ht;
Bram Moolenaar71f21932022-01-07 18:20:55 +00003123 return di;
Bram Moolenaaraa9b3ca2022-01-08 15:44:22 +00003124 }
Bram Moolenaar71f21932022-01-07 18:20:55 +00003125 }
3126 }
3127 }
3128
3129 return find_var(name, htp, no_autoload);
3130}
3131
3132/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003133 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02003134 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003135 * Returns NULL if not found.
3136 */
3137 dictitem_T *
3138find_var_in_ht(
3139 hashtab_T *ht,
3140 int htname,
3141 char_u *varname,
3142 int no_autoload)
3143{
3144 hashitem_T *hi;
3145
3146 if (*varname == NUL)
3147 {
3148 // Must be something like "s:", otherwise "ht" would be NULL.
3149 switch (htname)
3150 {
3151 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
3152 case 'g': return &globvars_var;
3153 case 'v': return &vimvars_var;
3154 case 'b': return &curbuf->b_bufvar;
3155 case 'w': return &curwin->w_winvar;
3156 case 't': return &curtab->tp_winvar;
3157 case 'l': return get_funccal_local_var();
3158 case 'a': return get_funccal_args_var();
3159 }
3160 return NULL;
3161 }
3162
3163 hi = hash_find(ht, varname);
3164 if (HASHITEM_EMPTY(hi))
3165 {
3166 // For global variables we may try auto-loading the script. If it
3167 // worked find the variable again. Don't auto-load a script if it was
3168 // loaded already, otherwise it would be loaded every time when
3169 // checking if a function name is a Funcref variable.
3170 if (ht == &globvarht && !no_autoload)
3171 {
3172 // Note: script_autoload() may make "hi" invalid. It must either
3173 // be obtained again or not used.
3174 if (!script_autoload(varname, FALSE) || aborting())
3175 return NULL;
3176 hi = hash_find(ht, varname);
3177 }
3178 if (HASHITEM_EMPTY(hi))
3179 return NULL;
3180 }
3181 return HI2DI(hi);
3182}
3183
3184/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003185 * Get the script-local hashtab. NULL if not in a script context.
3186 */
Bram Moolenaar922acbd2020-10-08 21:30:40 +02003187 hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003188get_script_local_ht(void)
3189{
3190 scid_T sid = current_sctx.sc_sid;
3191
Bram Moolenaare3d46852020-08-29 13:39:17 +02003192 if (SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003193 return &SCRIPT_VARS(sid);
3194 return NULL;
3195}
3196
3197/*
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003198 * Look for "name[len]" in script-local variables and functions.
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003199 * When "cmd" is TRUE it must look like a command, a function must be followed
3200 * by "(" or "->".
Bram Moolenaar709664c2020-12-12 14:33:41 +01003201 * Return OK when found, FAIL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003202 */
Bram Moolenaar709664c2020-12-12 14:33:41 +01003203 int
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003204lookup_scriptitem(
Bram Moolenaar709664c2020-12-12 14:33:41 +01003205 char_u *name,
3206 size_t len,
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003207 int cmd,
Bram Moolenaar709664c2020-12-12 14:33:41 +01003208 cctx_T *dummy UNUSED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003209{
3210 hashtab_T *ht = get_script_local_ht();
3211 char_u buffer[30];
3212 char_u *p;
Bram Moolenaar709664c2020-12-12 14:33:41 +01003213 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003214 hashitem_T *hi;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003215 int is_global = FALSE;
3216 char_u *fname = name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003217
3218 if (ht == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003219 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003220 if (len < sizeof(buffer) - 1)
3221 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02003222 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003223 vim_strncpy(buffer, name, len);
3224 p = buffer;
3225 }
3226 else
3227 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003228 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003229 if (p == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003230 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003231 }
3232
3233 hi = hash_find(ht, p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01003234 res = HASHITEM_EMPTY(hi) ? FAIL : OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003235
3236 // if not script-local, then perhaps imported
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003237 if (res == FAIL && find_imported(p, 0, FALSE) != NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003238 res = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003239 if (p != buffer)
3240 vim_free(p);
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003241
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003242 // Find a function, so that a following "->" works.
3243 // When used as a command require "(" or "->" to follow, "Cmd" is a user
3244 // command while "Cmd()" is a function call.
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003245 if (res != OK)
3246 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003247 p = skipwhite(name + len);
3248
3249 if (!cmd || name[len] == '(' || (p[0] == '-' && p[1] == '>'))
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003250 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003251 // Do not check for an internal function, since it might also be a
3252 // valid command, such as ":split" versus "split()".
3253 // Skip "g:" before a function name.
3254 if (name[0] == 'g' && name[1] == ':')
3255 {
3256 is_global = TRUE;
3257 fname = name + 2;
3258 }
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003259 if (find_func(fname, is_global) != NULL)
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003260 res = OK;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003261 }
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003262 }
3263
Bram Moolenaar709664c2020-12-12 14:33:41 +01003264 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003265}
3266
3267/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003268 * Find the hashtab used for a variable name.
3269 * Return NULL if the name is not valid.
3270 * Set "varname" to the start of name without ':'.
3271 */
3272 hashtab_T *
3273find_var_ht(char_u *name, char_u **varname)
3274{
3275 hashitem_T *hi;
3276 hashtab_T *ht;
3277
3278 if (name[0] == NUL)
3279 return NULL;
3280 if (name[1] != ':')
3281 {
3282 // The name must not start with a colon or #.
3283 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
3284 return NULL;
3285 *varname = name;
3286
3287 // "version" is "v:version" in all scopes if scriptversion < 3.
3288 // Same for a few other variables marked with VV_COMPAT.
Bram Moolenaardd9de502021-08-15 13:49:42 +02003289 if (in_old_script(3))
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003290 {
3291 hi = hash_find(&compat_hashtab, name);
3292 if (!HASHITEM_EMPTY(hi))
3293 return &compat_hashtab;
3294 }
3295
3296 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003297 if (ht != NULL)
3298 return ht; // local variable
3299
Bram Moolenaarf0a40692021-06-11 22:05:47 +02003300 // In Vim9 script items at the script level are script-local, except
3301 // for autoload names.
3302 if (in_vim9script() && vim_strchr(name, AUTOLOAD_CHAR) == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003303 {
3304 ht = get_script_local_ht();
3305 if (ht != NULL)
3306 return ht;
3307 }
3308
3309 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003310 }
3311 *varname = name + 2;
3312 if (*name == 'g') // global variable
3313 return &globvarht;
3314 // There must be no ':' or '#' in the rest of the name, unless g: is used
3315 if (vim_strchr(name + 2, ':') != NULL
3316 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
3317 return NULL;
3318 if (*name == 'b') // buffer variable
3319 return &curbuf->b_vars->dv_hashtab;
3320 if (*name == 'w') // window variable
3321 return &curwin->w_vars->dv_hashtab;
3322 if (*name == 't') // tab page variable
3323 return &curtab->tp_vars->dv_hashtab;
3324 if (*name == 'v') // v: variable
3325 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01003326 if (get_current_funccal() != NULL
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003327 && get_current_funccal()->func->uf_def_status == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003328 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01003329 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003330 if (*name == 'a') // a: function argument
3331 return get_funccal_args_ht();
3332 if (*name == 'l') // l: local function variable
3333 return get_funccal_local_ht();
3334 }
3335 if (*name == 's') // script variable
3336 {
3337 ht = get_script_local_ht();
3338 if (ht != NULL)
3339 return ht;
3340 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003341 return NULL;
3342}
3343
3344/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003345 * Get the string value of a (global/local) variable.
3346 * Note: see tv_get_string() for how long the pointer remains valid.
3347 * Returns NULL when it doesn't exist.
3348 */
3349 char_u *
3350get_var_value(char_u *name)
3351{
3352 dictitem_T *v;
3353
3354 v = find_var(name, NULL, FALSE);
3355 if (v == NULL)
3356 return NULL;
3357 return tv_get_string(&v->di_tv);
3358}
3359
3360/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003361 * Allocate a new hashtab for a sourced script. It will be used while
3362 * sourcing this script and when executing functions defined in the script.
3363 */
3364 void
3365new_script_vars(scid_T id)
3366{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003367 scriptvar_T *sv;
3368
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01003369 sv = ALLOC_CLEAR_ONE(scriptvar_T);
3370 if (sv == NULL)
3371 return;
3372 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01003373 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003374}
3375
3376/*
3377 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
3378 * point to it.
3379 */
3380 void
3381init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
3382{
3383 hash_init(&dict->dv_hashtab);
3384 dict->dv_lock = 0;
3385 dict->dv_scope = scope;
3386 dict->dv_refcount = DO_NOT_FREE_CNT;
3387 dict->dv_copyID = 0;
3388 dict_var->di_tv.vval.v_dict = dict;
3389 dict_var->di_tv.v_type = VAR_DICT;
3390 dict_var->di_tv.v_lock = VAR_FIXED;
3391 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
3392 dict_var->di_key[0] = NUL;
3393}
3394
3395/*
3396 * Unreference a dictionary initialized by init_var_dict().
3397 */
3398 void
3399unref_var_dict(dict_T *dict)
3400{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003401 // Now the dict needs to be freed if no one else is using it, go back to
3402 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003403 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
3404 dict_unref(dict);
3405}
3406
3407/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003408 * Clean up a list of internal variables.
3409 * Frees all allocated variables and the value they contain.
3410 * Clears hashtab "ht", does not free it.
3411 */
3412 void
3413vars_clear(hashtab_T *ht)
3414{
3415 vars_clear_ext(ht, TRUE);
3416}
3417
3418/*
3419 * Like vars_clear(), but only free the value if "free_val" is TRUE.
3420 */
3421 void
3422vars_clear_ext(hashtab_T *ht, int free_val)
3423{
3424 int todo;
3425 hashitem_T *hi;
3426 dictitem_T *v;
3427
3428 hash_lock(ht);
3429 todo = (int)ht->ht_used;
3430 for (hi = ht->ht_array; todo > 0; ++hi)
3431 {
3432 if (!HASHITEM_EMPTY(hi))
3433 {
3434 --todo;
3435
3436 // Free the variable. Don't remove it from the hashtab,
3437 // ht_array might change then. hash_clear() takes care of it
3438 // later.
3439 v = HI2DI(hi);
3440 if (free_val)
3441 clear_tv(&v->di_tv);
3442 if (v->di_flags & DI_FLAGS_ALLOC)
3443 vim_free(v);
3444 }
3445 }
3446 hash_clear(ht);
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003447 hash_init(ht);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003448}
3449
3450/*
3451 * Delete a variable from hashtab "ht" at item "hi".
3452 * Clear the variable value and free the dictitem.
3453 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02003454 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003455delete_var(hashtab_T *ht, hashitem_T *hi)
3456{
3457 dictitem_T *di = HI2DI(hi);
3458
3459 hash_remove(ht, hi);
3460 clear_tv(&di->di_tv);
3461 vim_free(di);
3462}
3463
3464/*
3465 * List the value of one internal variable.
3466 */
3467 static void
3468list_one_var(dictitem_T *v, char *prefix, int *first)
3469{
3470 char_u *tofree;
3471 char_u *s;
3472 char_u numbuf[NUMBUFLEN];
3473
3474 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
3475 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
3476 s == NULL ? (char_u *)"" : s, first);
3477 vim_free(tofree);
3478}
3479
3480 static void
3481list_one_var_a(
3482 char *prefix,
3483 char_u *name,
3484 int type,
3485 char_u *string,
3486 int *first) // when TRUE clear rest of screen and set to FALSE
3487{
3488 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
3489 msg_start();
3490 msg_puts(prefix);
3491 if (name != NULL) // "a:" vars don't have a name stored
3492 msg_puts((char *)name);
3493 msg_putchar(' ');
3494 msg_advance(22);
3495 if (type == VAR_NUMBER)
3496 msg_putchar('#');
3497 else if (type == VAR_FUNC || type == VAR_PARTIAL)
3498 msg_putchar('*');
3499 else if (type == VAR_LIST)
3500 {
3501 msg_putchar('[');
3502 if (*string == '[')
3503 ++string;
3504 }
3505 else if (type == VAR_DICT)
3506 {
3507 msg_putchar('{');
3508 if (*string == '{')
3509 ++string;
3510 }
3511 else
3512 msg_putchar(' ');
3513
3514 msg_outtrans(string);
3515
3516 if (type == VAR_FUNC || type == VAR_PARTIAL)
3517 msg_puts("()");
3518 if (*first)
3519 {
3520 msg_clr_eos();
3521 *first = FALSE;
3522 }
3523}
3524
3525/*
3526 * Set variable "name" to value in "tv".
3527 * If the variable already exists, the value is updated.
3528 * Otherwise the variable is created.
3529 */
3530 void
3531set_var(
3532 char_u *name,
3533 typval_T *tv,
3534 int copy) // make copy of value in "tv"
3535{
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003536 set_var_const(name, 0, NULL, tv, copy, ASSIGN_DECL, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003537}
3538
3539/*
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003540 * Set variable "name" to value in "tv_arg".
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003541 * When "sid" is non-zero "name" is in the script with this ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003542 * If the variable already exists and "is_const" is FALSE the value is updated.
3543 * Otherwise the variable is created.
3544 */
3545 void
3546set_var_const(
3547 char_u *name,
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003548 scid_T sid,
Bram Moolenaar7824fc82021-11-26 17:36:51 +00003549 type_T *type_arg,
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003550 typval_T *tv_arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003551 int copy, // make copy of value in "tv"
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003552 int flags_arg, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003553 int var_idx) // index for ":let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003554{
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003555 typval_T *tv = tv_arg;
Bram Moolenaar7824fc82021-11-26 17:36:51 +00003556 type_T *type = type_arg;
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003557 typval_T bool_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003558 dictitem_T *di;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003559 typval_T *dest_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003560 char_u *varname;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003561 char_u *name_tofree = NULL;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003562 hashtab_T *ht = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003563 int is_script_local;
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003564 int vim9script = in_vim9script();
Bram Moolenaare535db82021-03-31 21:07:24 +02003565 int var_in_vim9script;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003566 int var_in_autoload = FALSE;
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003567 int flags = flags_arg;
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003568 int free_tv_arg = !copy; // free tv_arg if not used
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003569
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003570 if (sid != 0)
3571 {
3572 if (SCRIPT_ID_VALID(sid))
3573 ht = &SCRIPT_VARS(sid);
3574 varname = name;
3575 }
3576 else
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003577 {
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003578 scriptitem_T *si;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003579
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003580 if (in_vim9script() && is_export
3581 && SCRIPT_ID_VALID(current_sctx.sc_sid)
3582 && (si = SCRIPT_ITEM(current_sctx.sc_sid))
Bram Moolenaar0e1574c2022-03-03 17:05:35 +00003583 ->sn_autoload_prefix != NULL)
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003584 {
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003585 // In a vim9 autoload script an exported variable is put in the
3586 // global namespace with the autoload prefix.
3587 var_in_autoload = TRUE;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003588 varname = concat_str(si->sn_autoload_prefix, name);
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003589 if (varname == NULL)
3590 goto failed;
3591 name_tofree = varname;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003592 ht = &globvarht;
3593 }
3594 else
3595 ht = find_var_ht(name, &varname);
3596 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003597 if (ht == NULL || *varname == NUL)
3598 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003599 semsg(_(e_illegal_variable_name_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003600 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003601 }
Bram Moolenaar54969f42022-02-07 13:56:44 +00003602 is_script_local = ht == get_script_local_ht() || sid != 0
3603 || var_in_autoload;
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003604
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003605 if (vim9script
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003606 && !is_script_local
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003607 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003608 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003609 && name[1] == ':')
Bram Moolenaar67979662020-06-20 22:50:47 +02003610 {
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003611 vim9_declare_error(name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003612 goto failed;
Bram Moolenaar67979662020-06-20 22:50:47 +02003613 }
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003614 if ((flags & ASSIGN_FOR_LOOP) && name[1] == ':'
3615 && vim_strchr((char_u *)"gwbt", name[0]) != NULL)
3616 // Do not make g:var, w:var, b:var or t:var final.
3617 flags &= ~ASSIGN_FINAL;
3618
Bram Moolenaare535db82021-03-31 21:07:24 +02003619 var_in_vim9script = is_script_local && current_script_is_vim9();
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003620 if (var_in_vim9script && name[0] == '_' && name[1] == NUL)
3621 {
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02003622 // For "[a, _] = list" the underscore is ignored.
3623 if ((flags & ASSIGN_UNPACK) == 0)
3624 emsg(_(e_cannot_use_underscore_here));
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003625 goto failed;
3626 }
Bram Moolenaar67979662020-06-20 22:50:47 +02003627
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003628 di = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003629
Bram Moolenaar24e93162021-07-18 20:40:33 +02003630 if (di == NULL && var_in_vim9script)
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003631 {
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003632 imported_T *import = find_imported(varname, 0, FALSE);
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003633
Bram Moolenaar24e93162021-07-18 20:40:33 +02003634 if (import != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003635 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003636 // imported name space cannot be used
Bram Moolenaar24e93162021-07-18 20:40:33 +02003637 if ((flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003638 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003639 semsg(_(e_redefining_imported_item_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003640 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003641 }
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003642 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
3643 goto failed;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003644 }
Bram Moolenaar75e27d72022-02-13 13:56:29 +00003645 if (!in_vim9script())
3646 {
3647 semsg(_(e_cannot_create_vim9_script_variable_in_function_str),
3648 name);
3649 goto failed;
3650 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003651 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003652
Bram Moolenaar993faa32022-02-21 15:59:11 +00003653 // Search in parent scope which is possible to reference from lambda
3654 if (di == NULL)
3655 di = find_var_in_scoped_ht(name, TRUE);
3656
3657 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
3658 && var_wrong_func_name(name, di == NULL))
3659 goto failed;
3660
3661 if (need_convert_to_bool(type, tv))
Bram Moolenaar24e93162021-07-18 20:40:33 +02003662 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003663 // Destination is a bool and the value is not, but it can be
3664 // converted.
3665 CLEAR_FIELD(bool_tv);
3666 bool_tv.v_type = VAR_BOOL;
3667 bool_tv.vval.v_number = tv2bool(tv) ? VVAL_TRUE : VVAL_FALSE;
3668 tv = &bool_tv;
3669 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003670
Bram Moolenaar993faa32022-02-21 15:59:11 +00003671 if (di != NULL)
3672 {
3673 // Item already exists. Allowed to replace when reloading.
3674 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003675 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003676 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
3677 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003678 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003679 emsg(_(e_cannot_modify_existing_variable));
3680 goto failed;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003681 }
3682
Bram Moolenaar993faa32022-02-21 15:59:11 +00003683 if (is_script_local && vim9script
3684 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0)
Bram Moolenaar12be7342021-03-31 21:47:33 +02003685 {
3686 semsg(_(e_redefining_script_item_str), name);
3687 goto failed;
3688 }
3689
Bram Moolenaar993faa32022-02-21 15:59:11 +00003690 if (var_in_vim9script && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003691 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003692 where_T where = WHERE_INIT;
Bram Moolenaar7a411a32022-04-04 14:58:06 +01003693 svar_T *sv = find_typval_in_script(&di->di_tv, sid, TRUE);
Bram Moolenaar993faa32022-02-21 15:59:11 +00003694
3695 if (sv != NULL)
3696 {
3697 // check the type and adjust to bool if needed
3698 where.wt_index = var_idx;
3699 where.wt_variable = TRUE;
3700 if (check_script_var_type(sv, tv, name, where) == FAIL)
3701 goto failed;
3702 if (type == NULL)
3703 type = sv->sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003704 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003705 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003706 }
3707
Bram Moolenaar993faa32022-02-21 15:59:11 +00003708 if ((flags & ASSIGN_FOR_LOOP) == 0
3709 && var_check_permission(di, name) == FAIL)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003710 goto failed;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003711 }
3712 else
3713 {
3714 // can only redefine once
3715 di->di_flags &= ~DI_FLAGS_RELOAD;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003716
Bram Moolenaar993faa32022-02-21 15:59:11 +00003717 // A Vim9 script-local variable is also present in sn_all_vars
3718 // and sn_var_vals. It may set "type" from "tv".
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003719 if (var_in_vim9script || var_in_autoload)
Bram Moolenaar993faa32022-02-21 15:59:11 +00003720 update_vim9_script_var(FALSE, di,
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003721 var_in_autoload ? name : di->di_key, flags,
Bram Moolenaar993faa32022-02-21 15:59:11 +00003722 tv, &type, (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003723 }
3724
Bram Moolenaar993faa32022-02-21 15:59:11 +00003725 // existing variable, need to clear the value
3726
3727 // Handle setting internal di: variables separately where needed to
3728 // prevent changing the type.
3729 if (ht == &vimvarht)
3730 {
3731 if (di->di_tv.v_type == VAR_STRING)
3732 {
3733 VIM_CLEAR(di->di_tv.vval.v_string);
3734 if (copy || tv->v_type != VAR_STRING)
3735 {
3736 char_u *val = tv_get_string(tv);
3737
3738 // Careful: when assigning to v:errmsg and
3739 // tv_get_string() causes an error message the variable
3740 // will already be set.
3741 if (di->di_tv.vval.v_string == NULL)
3742 di->di_tv.vval.v_string = vim_strsave(val);
3743 }
3744 else
3745 {
3746 // Take over the string to avoid an extra alloc/free.
3747 di->di_tv.vval.v_string = tv->vval.v_string;
3748 tv->vval.v_string = NULL;
3749 }
3750 goto failed;
3751 }
3752 else if (di->di_tv.v_type == VAR_NUMBER)
3753 {
3754 di->di_tv.vval.v_number = tv_get_number(tv);
3755 if (STRCMP(varname, "searchforward") == 0)
3756 set_search_direction(di->di_tv.vval.v_number
3757 ? '/' : '?');
3758#ifdef FEAT_SEARCH_EXTRA
3759 else if (STRCMP(varname, "hlsearch") == 0)
3760 {
3761 no_hlsearch = !di->di_tv.vval.v_number;
3762 redraw_all_later(SOME_VALID);
3763 }
3764#endif
3765 goto failed;
3766 }
3767 else if (di->di_tv.v_type != tv->v_type)
3768 {
3769 semsg(_(e_setting_str_to_value_with_wrong_type), name);
3770 goto failed;
3771 }
3772 }
3773
3774 clear_tv(&di->di_tv);
3775 }
3776 else
3777 {
3778 // Item not found, check if a function already exists.
3779 if (is_script_local && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
3780 && lookup_scriptitem(name, STRLEN(name), FALSE, NULL) == OK)
3781 {
3782 semsg(_(e_redefining_script_item_str), name);
3783 goto failed;
3784 }
3785
3786 // add a new variable
3787 if (var_in_vim9script && (flags & ASSIGN_NO_DECL))
3788 {
3789 semsg(_(e_unknown_variable_str), name);
3790 goto failed;
3791 }
3792
3793 // Can't add "v:" or "a:" variable.
3794 if (ht == &vimvarht || ht == get_funccal_args_ht())
3795 {
3796 semsg(_(e_illegal_variable_name_str), name);
3797 goto failed;
3798 }
3799
3800 // Make sure the variable name is valid. In Vim9 script an
3801 // autoload variable must be prefixed with "g:" unless in an
3802 // autoload script.
3803 if (!valid_varname(varname, -1, !vim9script
3804 || STRNCMP(name, "g:", 2) == 0 || var_in_autoload))
3805 goto failed;
3806
3807 di = alloc(sizeof(dictitem_T) + STRLEN(varname));
3808 if (di == NULL)
3809 goto failed;
3810 STRCPY(di->di_key, varname);
3811 if (hash_add(ht, DI2HIKEY(di)) == FAIL)
3812 {
3813 vim_free(di);
3814 goto failed;
3815 }
3816 di->di_flags = DI_FLAGS_ALLOC;
3817 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
3818 di->di_flags |= DI_FLAGS_LOCK;
3819
3820 // A Vim9 script-local variable is also added to sn_all_vars and
3821 // sn_var_vals. It may set "type" from "tv".
3822 if (var_in_vim9script || var_in_autoload)
3823 update_vim9_script_var(TRUE, di,
3824 var_in_autoload ? name : di->di_key, flags,
3825 tv, &type, (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003826 }
3827
Bram Moolenaar993faa32022-02-21 15:59:11 +00003828 dest_tv = &di->di_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003829 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003830 copy_tv(tv, dest_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003831 else
3832 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003833 *dest_tv = *tv;
3834 dest_tv->v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003835 init_tv(tv);
3836 }
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003837 free_tv_arg = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003838
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003839 if (vim9script && type != NULL)
Bram Moolenaar381692b2022-02-02 20:01:27 +00003840 set_tv_type(dest_tv, type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003841
Bram Moolenaar1dcf55d2020-12-22 22:07:30 +01003842 // ":const var = value" locks the value
3843 // ":final var = value" locks "var"
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003844 if (flags & ASSIGN_CONST)
Bram Moolenaar021bda52020-08-17 21:07:22 +02003845 // Like :lockvar! name: lock the value and what it contains, but only
3846 // if the reference count is up to one. That locks only literal
3847 // values.
Bram Moolenaar24e93162021-07-18 20:40:33 +02003848 item_lock(dest_tv, DICT_MAXNEST, TRUE, TRUE);
Bram Moolenaar24e93162021-07-18 20:40:33 +02003849
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003850failed:
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003851 vim_free(name_tofree);
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003852 if (free_tv_arg)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003853 clear_tv(tv_arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003854}
3855
3856/*
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003857 * Check in this order for backwards compatibility:
3858 * - Whether the variable is read-only
3859 * - Whether the variable value is locked
3860 * - Whether the variable is locked
3861 */
3862 int
3863var_check_permission(dictitem_T *di, char_u *name)
3864{
3865 if (var_check_ro(di->di_flags, name, FALSE)
3866 || value_check_lock(di->di_tv.v_lock, name, FALSE)
3867 || var_check_lock(di->di_flags, name, FALSE))
3868 return FAIL;
3869 return OK;
3870}
3871
3872/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003873 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
3874 * Also give an error message.
3875 */
3876 int
3877var_check_ro(int flags, char_u *name, int use_gettext)
3878{
3879 if (flags & DI_FLAGS_RO)
3880 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00003881 if (name == NULL)
3882 emsg(_(e_cannot_change_readonly_variable));
3883 else
3884 semsg(_(e_cannot_change_readonly_variable_str),
Bram Moolenaard8e44472021-07-21 22:20:33 +02003885 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003886 return TRUE;
3887 }
3888 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
3889 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00003890 if (name == NULL)
3891 emsg(_(e_cannot_set_variable_in_sandbox));
3892 else
3893 semsg(_(e_cannot_set_variable_in_sandbox_str),
3894 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003895 return TRUE;
3896 }
3897 return FALSE;
3898}
3899
3900/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003901 * Return TRUE if di_flags "flags" indicates variable "name" is locked.
3902 * Also give an error message.
3903 */
3904 int
3905var_check_lock(int flags, char_u *name, int use_gettext)
3906{
3907 if (flags & DI_FLAGS_LOCK)
3908 {
3909 semsg(_(e_variable_is_locked_str),
3910 use_gettext ? (char_u *)_(name) : name);
3911 return TRUE;
3912 }
3913 return FALSE;
3914}
3915
3916/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003917 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
3918 * Also give an error message.
3919 */
3920 int
3921var_check_fixed(int flags, char_u *name, int use_gettext)
3922{
3923 if (flags & DI_FLAGS_FIX)
3924 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00003925 if (name == NULL)
3926 emsg(_(e_cannot_delete_variable));
3927 else
3928 semsg(_(e_cannot_delete_variable_str),
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003929 use_gettext ? (char_u *)_(name) : name);
3930 return TRUE;
3931 }
3932 return FALSE;
3933}
3934
3935/*
3936 * Check if a funcref is assigned to a valid variable name.
3937 * Return TRUE and give an error if not.
3938 */
3939 int
Bram Moolenaar98b4f142020-08-08 15:46:01 +02003940var_wrong_func_name(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003941 char_u *name, // points to start of variable name
3942 int new_var) // TRUE when creating the variable
3943{
Bram Moolenaar32154662021-03-28 21:14:06 +02003944 // Allow for w: b: s: and t:. In Vim9 script s: is not allowed, because
3945 // the name can be used without the s: prefix.
3946 if (!((vim_strchr((char_u *)"wbt", name[0]) != NULL
3947 || (!in_vim9script() && name[0] == 's')) && name[1] == ':')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003948 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
3949 ? name[2] : name[0]))
3950 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003951 semsg(_(e_funcref_variable_name_must_start_with_capital_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003952 return TRUE;
3953 }
3954 // Don't allow hiding a function. When "v" is not NULL we might be
3955 // assigning another function to the same var, the type is checked
3956 // below.
3957 if (new_var && function_exists(name, FALSE))
3958 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003959 semsg(_(e_variable_name_conflicts_with_existing_function_str),
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003960 name);
3961 return TRUE;
3962 }
3963 return FALSE;
3964}
3965
3966/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003967 * Return TRUE if "flags" indicates variable "name" has a locked (immutable)
3968 * value. Also give an error message, using "name" or _("name") when
3969 * "use_gettext" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003970 */
3971 int
Bram Moolenaara187c432020-09-16 21:08:28 +02003972value_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003973{
3974 if (lock & VAR_LOCKED)
3975 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00003976 if (name == NULL)
3977 emsg(_(e_value_is_locked));
3978 else
3979 semsg(_(e_value_is_locked_str),
3980 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003981 return TRUE;
3982 }
3983 if (lock & VAR_FIXED)
3984 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00003985 if (name == NULL)
3986 emsg(_(e_cannot_change_value));
3987 else
3988 semsg(_(e_cannot_change_value_of_str),
3989 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003990 return TRUE;
3991 }
3992 return FALSE;
3993}
3994
3995/*
Bram Moolenaar03290b82020-12-19 16:30:44 +01003996 * Check if a variable name is valid. When "autoload" is true "#" is allowed.
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00003997 * If "len" is -1 use all of "varname", otherwise up to "varname[len]".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003998 * Return FALSE and give an error if not.
3999 */
4000 int
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004001valid_varname(char_u *varname, int len, int autoload)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004002{
4003 char_u *p;
4004
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004005 for (p = varname; len < 0 ? *p != NUL : p < varname + len; ++p)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004006 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
Bram Moolenaar03290b82020-12-19 16:30:44 +01004007 && !(autoload && *p == AUTOLOAD_CHAR))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004008 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004009 semsg(_(e_illegal_variable_name_str), varname);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004010 return FALSE;
4011 }
4012 return TRUE;
4013}
4014
4015/*
4016 * getwinvar() and gettabwinvar()
4017 */
4018 static void
4019getwinvar(
4020 typval_T *argvars,
4021 typval_T *rettv,
4022 int off) // 1 for gettabwinvar()
4023{
4024 win_T *win;
4025 char_u *varname;
4026 dictitem_T *v;
4027 tabpage_T *tp = NULL;
4028 int done = FALSE;
Bram Moolenaar18f47402022-01-06 13:24:51 +00004029 switchwin_T switchwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004030 int need_switch_win;
4031
4032 if (off == 1)
4033 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4034 else
4035 tp = curtab;
4036 win = find_win_by_nr(&argvars[off], tp);
4037 varname = tv_get_string_chk(&argvars[off + 1]);
4038 ++emsg_off;
4039
4040 rettv->v_type = VAR_STRING;
4041 rettv->vval.v_string = NULL;
4042
4043 if (win != NULL && varname != NULL)
4044 {
4045 // Set curwin to be our win, temporarily. Also set the tabpage,
4046 // otherwise the window is not valid. Only do this when needed,
4047 // autocommands get blocked.
4048 need_switch_win = !(tp == curtab && win == curwin);
4049 if (!need_switch_win
Bram Moolenaar18f47402022-01-06 13:24:51 +00004050 || switch_win(&switchwin, win, tp, TRUE) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004051 {
4052 if (*varname == '&')
4053 {
4054 if (varname[1] == NUL)
4055 {
4056 // get all window-local options in a dict
4057 dict_T *opts = get_winbuf_options(FALSE);
4058
4059 if (opts != NULL)
4060 {
4061 rettv_dict_set(rettv, opts);
4062 done = TRUE;
4063 }
4064 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02004065 else if (eval_option(&varname, rettv, 1) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004066 // window-local-option
4067 done = TRUE;
4068 }
4069 else
4070 {
4071 // Look up the variable.
4072 // Let getwinvar({nr}, "") return the "w:" dictionary.
4073 v = find_var_in_ht(&win->w_vars->dv_hashtab, 'w',
4074 varname, FALSE);
4075 if (v != NULL)
4076 {
4077 copy_tv(&v->di_tv, rettv);
4078 done = TRUE;
4079 }
4080 }
4081 }
4082
4083 if (need_switch_win)
4084 // restore previous notion of curwin
Bram Moolenaar18f47402022-01-06 13:24:51 +00004085 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004086 }
4087
4088 if (!done && argvars[off + 2].v_type != VAR_UNKNOWN)
4089 // use the default return value
4090 copy_tv(&argvars[off + 2], rettv);
4091
4092 --emsg_off;
4093}
4094
4095/*
Bram Moolenaar191929b2020-08-19 21:20:49 +02004096 * Set option "varname" to the value of "varp" for the current buffer/window.
4097 */
4098 static void
4099set_option_from_tv(char_u *varname, typval_T *varp)
4100{
4101 long numval = 0;
4102 char_u *strval;
4103 char_u nbuf[NUMBUFLEN];
4104 int error = FALSE;
4105
Bram Moolenaar31a201a2021-01-03 14:47:25 +01004106 if (varp->v_type == VAR_BOOL)
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004107 {
Bram Moolenaar31a201a2021-01-03 14:47:25 +01004108 numval = (long)varp->vval.v_number;
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004109 strval = (char_u *)"0"; // avoid using "false"
4110 }
4111 else
4112 {
4113 if (!in_vim9script() || varp->v_type != VAR_STRING)
4114 numval = (long)tv_get_number_chk(varp, &error);
4115 strval = tv_get_string_buf_chk(varp, nbuf);
4116 }
Bram Moolenaar191929b2020-08-19 21:20:49 +02004117 if (!error && strval != NULL)
Bram Moolenaar31e5c602022-04-15 13:53:33 +01004118 set_option_value_give_err(varname, numval, strval, OPT_LOCAL);
Bram Moolenaar191929b2020-08-19 21:20:49 +02004119}
4120
4121/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004122 * "setwinvar()" and "settabwinvar()" functions
4123 */
4124 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004125setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004126{
4127 win_T *win;
Bram Moolenaar18f47402022-01-06 13:24:51 +00004128 switchwin_T switchwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004129 int need_switch_win;
4130 char_u *varname, *winvarname;
4131 typval_T *varp;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004132 tabpage_T *tp = NULL;
4133
4134 if (check_secure())
4135 return;
4136
4137 if (off == 1)
4138 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4139 else
4140 tp = curtab;
4141 win = find_win_by_nr(&argvars[off], tp);
4142 varname = tv_get_string_chk(&argvars[off + 1]);
4143 varp = &argvars[off + 2];
4144
4145 if (win != NULL && varname != NULL && varp != NULL)
4146 {
4147 need_switch_win = !(tp == curtab && win == curwin);
4148 if (!need_switch_win
Bram Moolenaar18f47402022-01-06 13:24:51 +00004149 || switch_win(&switchwin, win, tp, TRUE) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004150 {
4151 if (*varname == '&')
Bram Moolenaar191929b2020-08-19 21:20:49 +02004152 set_option_from_tv(varname + 1, varp);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004153 else
4154 {
4155 winvarname = alloc(STRLEN(varname) + 3);
4156 if (winvarname != NULL)
4157 {
4158 STRCPY(winvarname, "w:");
4159 STRCPY(winvarname + 2, varname);
4160 set_var(winvarname, varp, TRUE);
4161 vim_free(winvarname);
4162 }
4163 }
4164 }
4165 if (need_switch_win)
Bram Moolenaar18f47402022-01-06 13:24:51 +00004166 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004167 }
4168}
4169
Bram Moolenaare5cdf152019-08-29 22:09:46 +02004170/*
4171 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
4172 * v:option_type, and v:option_command.
4173 */
4174 void
4175reset_v_option_vars(void)
4176{
4177 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
4178 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
4179 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
4180 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
4181 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
4182 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
4183}
4184
4185/*
4186 * Add an assert error to v:errors.
4187 */
4188 void
4189assert_error(garray_T *gap)
4190{
4191 struct vimvar *vp = &vimvars[VV_ERRORS];
4192
Bram Moolenaard787e402021-12-24 21:36:12 +00004193 if (vp->vv_tv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004194 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02004195 set_vim_var_list(VV_ERRORS, list_alloc());
4196 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
4197}
4198
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004199 int
4200var_exists(char_u *var)
4201{
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004202 char_u *arg = var;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004203 char_u *name;
4204 char_u *tofree;
4205 typval_T tv;
4206 int len = 0;
4207 int n = FALSE;
4208
4209 // get_name_len() takes care of expanding curly braces
4210 name = var;
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004211 len = get_name_len(&arg, &tofree, TRUE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004212 if (len > 0)
4213 {
4214 if (tofree != NULL)
4215 name = tofree;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004216 n = (eval_variable(name, len, 0, &tv, NULL,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01004217 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004218 if (n)
4219 {
4220 // handle d.key, l[idx], f(expr)
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004221 arg = skipwhite(arg);
Bram Moolenaar32884ad2022-01-07 12:45:29 +00004222 n = (handle_subscript(&arg, name, &tv, &EVALARG_EVALUATE,
4223 FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004224 if (n)
4225 clear_tv(&tv);
4226 }
4227 }
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004228 if (*arg != NUL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004229 n = FALSE;
4230
4231 vim_free(tofree);
4232 return n;
4233}
4234
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004235static lval_T *redir_lval = NULL;
4236#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
4237static garray_T redir_ga; // only valid when redir_lval is not NULL
4238static char_u *redir_endp = NULL;
4239static char_u *redir_varname = NULL;
4240
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004241 int
4242alloc_redir_lval(void)
4243{
4244 redir_lval = ALLOC_CLEAR_ONE(lval_T);
4245 if (redir_lval == NULL)
4246 return FAIL;
4247 return OK;
4248}
4249
4250 void
4251clear_redir_lval(void)
4252{
4253 VIM_CLEAR(redir_lval);
4254}
4255
4256 void
4257init_redir_ga(void)
4258{
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004259 ga_init2(&redir_ga, sizeof(char), 500);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004260}
4261
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004262/*
4263 * Start recording command output to a variable
4264 * When "append" is TRUE append to an existing variable.
4265 * Returns OK if successfully completed the setup. FAIL otherwise.
4266 */
4267 int
4268var_redir_start(char_u *name, int append)
4269{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004270 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004271 typval_T tv;
4272
4273 // Catch a bad name early.
4274 if (!eval_isnamec1(*name))
4275 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004276 emsg(_(e_invalid_argument));
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004277 return FAIL;
4278 }
4279
4280 // Make a copy of the name, it is used in redir_lval until redir ends.
4281 redir_varname = vim_strsave(name);
4282 if (redir_varname == NULL)
4283 return FAIL;
4284
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004285 if (alloc_redir_lval() == FAIL)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004286 {
4287 var_redir_stop();
4288 return FAIL;
4289 }
4290
4291 // The output is stored in growarray "redir_ga" until redirection ends.
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004292 init_redir_ga();
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004293
4294 // Parse the variable name (can be a dict or list entry).
4295 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
4296 FNE_CHECK_START);
4297 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
4298 {
4299 clear_lval(redir_lval);
4300 if (redir_endp != NULL && *redir_endp != NUL)
4301 // Trailing characters are present after the variable name
Bram Moolenaar74409f62022-01-01 15:58:22 +00004302 semsg(_(e_trailing_characters_str), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004303 else
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004304 semsg(_(e_invalid_argument_str), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004305 redir_endp = NULL; // don't store a value, only cleanup
4306 var_redir_stop();
4307 return FAIL;
4308 }
4309
4310 // check if we can write to the variable: set it to or append an empty
4311 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004312 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004313 tv.v_type = VAR_STRING;
4314 tv.vval.v_string = (char_u *)"";
4315 if (append)
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004316 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004317 ASSIGN_NO_DECL, (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004318 else
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004319 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004320 ASSIGN_NO_DECL, (char_u *)"=", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004321 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004322 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004323 {
4324 redir_endp = NULL; // don't store a value, only cleanup
4325 var_redir_stop();
4326 return FAIL;
4327 }
4328
4329 return OK;
4330}
4331
4332/*
4333 * Append "value[value_len]" to the variable set by var_redir_start().
4334 * The actual appending is postponed until redirection ends, because the value
4335 * appended may in fact be the string we write to, changing it may cause freed
4336 * memory to be used:
4337 * :redir => foo
4338 * :let foo
4339 * :redir END
4340 */
4341 void
4342var_redir_str(char_u *value, int value_len)
4343{
4344 int len;
4345
4346 if (redir_lval == NULL)
4347 return;
4348
4349 if (value_len == -1)
4350 len = (int)STRLEN(value); // Append the entire string
4351 else
4352 len = value_len; // Append only "value_len" characters
4353
4354 if (ga_grow(&redir_ga, len) == OK)
4355 {
4356 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
4357 redir_ga.ga_len += len;
4358 }
4359 else
4360 var_redir_stop();
4361}
4362
4363/*
4364 * Stop redirecting command output to a variable.
4365 * Frees the allocated memory.
4366 */
4367 void
4368var_redir_stop(void)
4369{
4370 typval_T tv;
4371
4372 if (EVALCMD_BUSY)
4373 {
4374 redir_lval = NULL;
4375 return;
4376 }
4377
4378 if (redir_lval != NULL)
4379 {
4380 // If there was no error: assign the text to the variable.
4381 if (redir_endp != NULL)
4382 {
4383 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4384 tv.v_type = VAR_STRING;
4385 tv.vval.v_string = redir_ga.ga_data;
4386 // Call get_lval() again, if it's inside a Dict or List it may
4387 // have changed.
4388 redir_endp = get_lval(redir_varname, NULL, redir_lval,
4389 FALSE, FALSE, 0, FNE_CHECK_START);
4390 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004391 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004392 (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004393 clear_lval(redir_lval);
4394 }
4395
4396 // free the collected output
4397 VIM_CLEAR(redir_ga.ga_data);
4398
4399 VIM_CLEAR(redir_lval);
4400 }
4401 VIM_CLEAR(redir_varname);
4402}
4403
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004404/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004405 * Get the collected redirected text and clear redir_ga.
4406 */
4407 char_u *
4408get_clear_redir_ga(void)
4409{
4410 char_u *res;
4411
4412 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4413 res = redir_ga.ga_data;
4414 redir_ga.ga_data = NULL;
4415 return res;
4416}
4417
4418/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004419 * "gettabvar()" function
4420 */
4421 void
4422f_gettabvar(typval_T *argvars, typval_T *rettv)
4423{
Bram Moolenaar18f47402022-01-06 13:24:51 +00004424 switchwin_T switchwin;
4425 tabpage_T *tp;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004426 dictitem_T *v;
4427 char_u *varname;
4428 int done = FALSE;
4429
4430 rettv->v_type = VAR_STRING;
4431 rettv->vval.v_string = NULL;
4432
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004433 if (in_vim9script()
4434 && (check_for_number_arg(argvars, 0) == FAIL
4435 || check_for_string_arg(argvars, 1) == FAIL))
4436 return;
4437
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004438 varname = tv_get_string_chk(&argvars[1]);
4439 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4440 if (tp != NULL && varname != NULL)
4441 {
4442 // Set tp to be our tabpage, temporarily. Also set the window to the
4443 // first window in the tabpage, otherwise the window is not valid.
Bram Moolenaar18f47402022-01-06 13:24:51 +00004444 if (switch_win(&switchwin,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004445 tp == curtab || tp->tp_firstwin == NULL ? firstwin
4446 : tp->tp_firstwin, tp, TRUE) == OK)
4447 {
4448 // look up the variable
4449 // Let gettabvar({nr}, "") return the "t:" dictionary.
4450 v = find_var_in_ht(&tp->tp_vars->dv_hashtab, 't', varname, FALSE);
4451 if (v != NULL)
4452 {
4453 copy_tv(&v->di_tv, rettv);
4454 done = TRUE;
4455 }
4456 }
4457
4458 // restore previous notion of curwin
Bram Moolenaar18f47402022-01-06 13:24:51 +00004459 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004460 }
4461
4462 if (!done && argvars[2].v_type != VAR_UNKNOWN)
4463 copy_tv(&argvars[2], rettv);
4464}
4465
4466/*
4467 * "gettabwinvar()" function
4468 */
4469 void
4470f_gettabwinvar(typval_T *argvars, typval_T *rettv)
4471{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004472 if (in_vim9script()
4473 && (check_for_number_arg(argvars, 0) == FAIL
4474 || check_for_number_arg(argvars, 1) == FAIL
4475 || check_for_string_arg(argvars, 2) == FAIL))
4476 return;
4477
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004478 getwinvar(argvars, rettv, 1);
4479}
4480
4481/*
4482 * "getwinvar()" function
4483 */
4484 void
4485f_getwinvar(typval_T *argvars, typval_T *rettv)
4486{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004487 if (in_vim9script()
4488 && (check_for_number_arg(argvars, 0) == FAIL
4489 || check_for_string_arg(argvars, 1) == FAIL))
4490 return;
4491
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004492 getwinvar(argvars, rettv, 0);
4493}
4494
4495/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004496 * "getbufvar()" function
4497 */
4498 void
4499f_getbufvar(typval_T *argvars, typval_T *rettv)
4500{
4501 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004502 char_u *varname;
4503 dictitem_T *v;
4504 int done = FALSE;
4505
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004506 if (in_vim9script()
4507 && (check_for_buffer_arg(argvars, 0) == FAIL
4508 || check_for_string_arg(argvars, 1) == FAIL))
4509 return;
4510
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004511 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004512 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004513
4514 rettv->v_type = VAR_STRING;
4515 rettv->vval.v_string = NULL;
4516
4517 if (buf != NULL && varname != NULL)
4518 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004519 if (*varname == '&')
4520 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004521 buf_T *save_curbuf = curbuf;
4522
4523 // set curbuf to be our buf, temporarily
4524 curbuf = buf;
4525
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004526 if (varname[1] == NUL)
4527 {
4528 // get all buffer-local options in a dict
4529 dict_T *opts = get_winbuf_options(TRUE);
4530
4531 if (opts != NULL)
4532 {
4533 rettv_dict_set(rettv, opts);
4534 done = TRUE;
4535 }
4536 }
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02004537 else if (eval_option(&varname, rettv, TRUE) == OK)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004538 // buffer-local-option
4539 done = TRUE;
Bram Moolenaar86015452020-03-29 15:12:15 +02004540
4541 // restore previous notion of curbuf
4542 curbuf = save_curbuf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004543 }
4544 else
4545 {
4546 // Look up the variable.
Bram Moolenaar52592752020-04-03 18:43:35 +02004547 if (*varname == NUL)
4548 // Let getbufvar({nr}, "") return the "b:" dictionary.
4549 v = &buf->b_bufvar;
4550 else
4551 v = find_var_in_ht(&buf->b_vars->dv_hashtab, 'b',
4552 varname, FALSE);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004553 if (v != NULL)
4554 {
4555 copy_tv(&v->di_tv, rettv);
4556 done = TRUE;
4557 }
4558 }
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004559 }
4560
4561 if (!done && argvars[2].v_type != VAR_UNKNOWN)
4562 // use the default value
4563 copy_tv(&argvars[2], rettv);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004564}
4565
4566/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004567 * "settabvar()" function
4568 */
4569 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004570f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004571{
4572 tabpage_T *save_curtab;
4573 tabpage_T *tp;
4574 char_u *varname, *tabvarname;
4575 typval_T *varp;
4576
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004577 if (check_secure())
4578 return;
4579
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004580 if (in_vim9script()
4581 && (check_for_number_arg(argvars, 0) == FAIL
4582 || check_for_string_arg(argvars, 1) == FAIL))
4583 return;
4584
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004585 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4586 varname = tv_get_string_chk(&argvars[1]);
4587 varp = &argvars[2];
4588
4589 if (varname != NULL && varp != NULL && tp != NULL)
4590 {
4591 save_curtab = curtab;
4592 goto_tabpage_tp(tp, FALSE, FALSE);
4593
4594 tabvarname = alloc(STRLEN(varname) + 3);
4595 if (tabvarname != NULL)
4596 {
4597 STRCPY(tabvarname, "t:");
4598 STRCPY(tabvarname + 2, varname);
4599 set_var(tabvarname, varp, TRUE);
4600 vim_free(tabvarname);
4601 }
4602
4603 // Restore current tabpage
4604 if (valid_tabpage(save_curtab))
4605 goto_tabpage_tp(save_curtab, FALSE, FALSE);
4606 }
4607}
4608
4609/*
4610 * "settabwinvar()" function
4611 */
4612 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004613f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004614{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004615 if (in_vim9script()
4616 && (check_for_number_arg(argvars, 0) == FAIL
4617 || check_for_number_arg(argvars, 1) == FAIL
4618 || check_for_string_arg(argvars, 2) == FAIL))
4619 return;
4620
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004621 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004622}
4623
4624/*
4625 * "setwinvar()" function
4626 */
4627 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004628f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004629{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004630 if (in_vim9script()
4631 && (check_for_number_arg(argvars, 0) == FAIL
4632 || check_for_string_arg(argvars, 1) == FAIL))
4633 return;
4634
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004635 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004636}
4637
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004638/*
4639 * "setbufvar()" function
4640 */
4641 void
4642f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
4643{
4644 buf_T *buf;
4645 char_u *varname, *bufvarname;
4646 typval_T *varp;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004647
4648 if (check_secure())
4649 return;
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004650
4651 if (in_vim9script()
4652 && (check_for_buffer_arg(argvars, 0) == FAIL
4653 || check_for_string_arg(argvars, 1) == FAIL))
4654 return;
4655
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004656 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004657 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004658 varp = &argvars[2];
4659
4660 if (buf != NULL && varname != NULL && varp != NULL)
4661 {
4662 if (*varname == '&')
4663 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004664 aco_save_T aco;
4665
4666 // set curbuf to be our buf, temporarily
4667 aucmd_prepbuf(&aco, buf);
4668
Bram Moolenaar191929b2020-08-19 21:20:49 +02004669 set_option_from_tv(varname + 1, varp);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004670
4671 // reset notion of buffer
4672 aucmd_restbuf(&aco);
4673 }
4674 else
4675 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004676 bufvarname = alloc(STRLEN(varname) + 3);
4677 if (bufvarname != NULL)
4678 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004679 buf_T *save_curbuf = curbuf;
4680
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004681 curbuf = buf;
4682 STRCPY(bufvarname, "b:");
4683 STRCPY(bufvarname + 2, varname);
4684 set_var(bufvarname, varp, TRUE);
4685 vim_free(bufvarname);
4686 curbuf = save_curbuf;
4687 }
4688 }
4689 }
4690}
4691
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004692/*
4693 * Get a callback from "arg". It can be a Funcref or a function name.
4694 * When "arg" is zero return an empty string.
4695 * "cb_name" is not allocated.
4696 * "cb_name" is set to NULL for an invalid argument.
4697 */
4698 callback_T
4699get_callback(typval_T *arg)
4700{
Bram Moolenaar14e579092020-03-07 16:59:25 +01004701 callback_T res;
4702 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004703
4704 res.cb_free_name = FALSE;
4705 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
4706 {
4707 res.cb_partial = arg->vval.v_partial;
4708 ++res.cb_partial->pt_refcount;
4709 res.cb_name = partial_name(res.cb_partial);
4710 }
4711 else
4712 {
4713 res.cb_partial = NULL;
Bram Moolenaar14e579092020-03-07 16:59:25 +01004714 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
4715 && isdigit(*arg->vval.v_string))
4716 r = FAIL;
4717 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004718 {
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004719 if (arg->v_type == VAR_STRING)
4720 {
4721 char_u *name;
4722
4723 name = get_scriptlocal_funcname(arg->vval.v_string);
4724 if (name != NULL)
4725 {
4726 vim_free(arg->vval.v_string);
4727 arg->vval.v_string = name;
4728 }
4729 }
4730
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004731 res.cb_name = arg->vval.v_string;
4732 func_ref(res.cb_name);
4733 }
4734 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004735 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004736 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01004737 r = FAIL;
4738
4739 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004740 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004741 emsg(_(e_invalid_callback_argument));
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004742 res.cb_name = NULL;
4743 }
4744 }
4745 return res;
4746}
4747
4748/*
4749 * Copy a callback into a typval_T.
4750 */
4751 void
4752put_callback(callback_T *cb, typval_T *tv)
4753{
4754 if (cb->cb_partial != NULL)
4755 {
4756 tv->v_type = VAR_PARTIAL;
4757 tv->vval.v_partial = cb->cb_partial;
4758 ++tv->vval.v_partial->pt_refcount;
4759 }
4760 else
4761 {
4762 tv->v_type = VAR_FUNC;
4763 tv->vval.v_string = vim_strsave(cb->cb_name);
4764 func_ref(cb->cb_name);
4765 }
4766}
4767
4768/*
4769 * Make a copy of "src" into "dest", allocating the function name if needed,
4770 * without incrementing the refcount.
4771 */
4772 void
4773set_callback(callback_T *dest, callback_T *src)
4774{
4775 if (src->cb_partial == NULL)
4776 {
4777 // just a function name, make a copy
4778 dest->cb_name = vim_strsave(src->cb_name);
4779 dest->cb_free_name = TRUE;
4780 }
4781 else
4782 {
4783 // cb_name is a pointer into cb_partial
4784 dest->cb_name = src->cb_name;
4785 dest->cb_free_name = FALSE;
4786 }
4787 dest->cb_partial = src->cb_partial;
4788}
4789
4790/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02004791 * Copy callback from "src" to "dest", incrementing the refcounts.
4792 */
4793 void
4794copy_callback(callback_T *dest, callback_T *src)
4795{
4796 dest->cb_partial = src->cb_partial;
4797 if (dest->cb_partial != NULL)
4798 {
4799 dest->cb_name = src->cb_name;
4800 dest->cb_free_name = FALSE;
4801 ++dest->cb_partial->pt_refcount;
4802 }
4803 else
4804 {
4805 dest->cb_name = vim_strsave(src->cb_name);
4806 dest->cb_free_name = TRUE;
4807 func_ref(src->cb_name);
4808 }
4809}
4810
4811/*
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004812 * When a callback refers to an autoload import, change the function name to
4813 * the "path#name" form. Uses the current script context.
4814 * Only works when the name is allocated.
4815 */
4816 void
4817expand_autload_callback(callback_T *cb)
4818{
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004819 char_u *name;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004820 char_u *p;
4821 imported_T *import;
4822
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004823 if (!in_vim9script() || cb->cb_name == NULL
4824 || (!cb->cb_free_name
4825 && (cb->cb_partial == NULL || cb->cb_partial->pt_name == NULL)))
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004826 return;
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004827 if (cb->cb_partial != NULL)
4828 name = cb->cb_partial->pt_name;
4829 else
4830 name = cb->cb_name;
4831 p = vim_strchr(name, '.');
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004832 if (p == NULL)
4833 return;
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004834 import = find_imported(name, p - name, FALSE);
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004835 if (import != NULL && SCRIPT_ID_VALID(import->imp_sid))
4836 {
4837 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
4838
4839 if (si->sn_autoload_prefix != NULL)
4840 {
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004841 char_u *newname = concat_str(si->sn_autoload_prefix, p + 1);
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004842
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004843 if (newname != NULL)
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004844 {
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004845 if (cb->cb_partial != NULL)
4846 {
4847 if (cb->cb_name == cb->cb_partial->pt_name)
4848 cb->cb_name = newname;
4849 vim_free(cb->cb_partial->pt_name);
4850 cb->cb_partial->pt_name = newname;
4851 }
4852 else
4853 {
4854 vim_free(cb->cb_name);
4855 cb->cb_name = newname;
4856 }
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004857 }
4858 }
4859 }
4860}
4861
4862/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004863 * Unref/free "callback" returned by get_callback() or set_callback().
4864 */
4865 void
4866free_callback(callback_T *callback)
4867{
4868 if (callback->cb_partial != NULL)
4869 {
4870 partial_unref(callback->cb_partial);
4871 callback->cb_partial = NULL;
4872 }
4873 else if (callback->cb_name != NULL)
4874 func_unref(callback->cb_name);
4875 if (callback->cb_free_name)
4876 {
4877 vim_free(callback->cb_name);
4878 callback->cb_free_name = FALSE;
4879 }
4880 callback->cb_name = NULL;
4881}
4882
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004883#endif // FEAT_EVAL