blob: d9466691f40b9df9258b90b7d3d786c206b0efe0 [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},
Shougo Matsushita61021aa2022-07-27 14:40:00 +0100114 {VV_NAME("completed_item", VAR_DICT), &t_dict_string, 0},
Bram Moolenaard787e402021-12-24 21:36:12 +0000115 {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 Moolenaaref2c3252022-11-25 16:31:51 +0000220 hash_add(&vimvarht, p->vv_di.di_key, "initialization");
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200221 if (p->vv_flags & VV_COMPAT)
222 // add to compat scope dict
Bram Moolenaaref2c3252022-11-25 16:31:51 +0000223 hash_add(&compat_hashtab, p->vv_di.di_key, "initialization");
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200224 }
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 Moolenaara4e0b972022-10-01 19:43:52 +0100383 if (eval_to_bool(p_ccv, &err, NULL, FALSE, TRUE))
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200384 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 Moolenaara4e0b972022-10-01 19:43:52 +0100411 if (eval_to_bool(p_pexpr, &err, NULL, FALSE, TRUE))
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200412 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
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100447 tv = eval_expr_ext(p_dex, NULL, TRUE);
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
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100475 tv = eval_expr_ext(p_pex, NULL, TRUE);
Bram Moolenaar36c2add2022-01-22 20:55:30 +0000476 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 Moolenaara4e0b972022-10-01 19:43:52 +0100500 int r;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200501
502 // Set "v:val" to the bad word.
503 prepare_vimvar(VV_VAL, &save_val);
504 set_vim_var_string(VV_VAL, badword, -1);
505 if (p_verbose == 0)
506 ++emsg_off;
Bram Moolenaar2a7aa832022-01-23 17:59:06 +0000507 ctx = get_option_sctx("spellsuggest");
508 if (ctx != NULL)
509 current_sctx = *ctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200510
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100511 r = may_call_simple_func(p, &rettv);
512 if (r == NOTDONE)
513 r = eval1(&p, &rettv, &EVALARG_EVALUATE);
514 if (r == OK)
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200515 {
516 if (rettv.v_type != VAR_LIST)
517 clear_tv(&rettv);
518 else
519 list = rettv.vval.v_list;
520 }
521
522 if (p_verbose == 0)
523 --emsg_off;
524 clear_tv(get_vim_var_tv(VV_VAL));
525 restore_vimvar(VV_VAL, &save_val);
Bram Moolenaar2a7aa832022-01-23 17:59:06 +0000526 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200527
528 return list;
529}
530
531/*
532 * "list" is supposed to contain two items: a word and a number. Return the
533 * word in "pp" and the number as the return value.
534 * Return -1 if anything isn't right.
535 * Used to get the good word and score from the eval_spell_expr() result.
536 */
537 int
538get_spellword(list_T *list, char_u **pp)
539{
540 listitem_T *li;
541
542 li = list->lv_first;
543 if (li == NULL)
544 return -1;
545 *pp = tv_get_string(&li->li_tv);
546
547 li = li->li_next;
548 if (li == NULL)
549 return -1;
550 return (int)tv_get_number(&li->li_tv);
551}
552#endif
553
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200554/*
555 * Prepare v: variable "idx" to be used.
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200556 * Save the current typeval in "save_tv" and clear it.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200557 * When not used yet add the variable to the v: hashtable.
558 */
559 void
560prepare_vimvar(int idx, typval_T *save_tv)
561{
562 *save_tv = vimvars[idx].vv_tv;
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200563 vimvars[idx].vv_str = NULL; // don't free it now
Bram Moolenaard787e402021-12-24 21:36:12 +0000564 if (vimvars[idx].vv_tv_type == VAR_UNKNOWN)
Bram Moolenaaref2c3252022-11-25 16:31:51 +0000565 hash_add(&vimvarht, vimvars[idx].vv_di.di_key, "prepare vimvar");
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200566}
567
568/*
569 * Restore v: variable "idx" to typeval "save_tv".
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200570 * Note that the v: variable must have been cleared already.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200571 * When no longer defined, remove the variable from the v: hashtable.
572 */
573 void
574restore_vimvar(int idx, typval_T *save_tv)
575{
576 hashitem_T *hi;
577
578 vimvars[idx].vv_tv = *save_tv;
Bram Moolenaard787e402021-12-24 21:36:12 +0000579 if (vimvars[idx].vv_tv_type == VAR_UNKNOWN)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200580 {
581 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
582 if (HASHITEM_EMPTY(hi))
583 internal_error("restore_vimvar()");
584 else
Bram Moolenaaref2c3252022-11-25 16:31:51 +0000585 hash_remove(&vimvarht, hi, "restore vimvar");
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200586 }
587}
588
589/*
590 * List Vim variables.
591 */
592 static void
593list_vim_vars(int *first)
594{
595 list_hashtable_vars(&vimvarht, "v:", FALSE, first);
596}
597
598/*
599 * List script-local variables, if there is a script.
600 */
601 static void
602list_script_vars(int *first)
603{
Bram Moolenaare3d46852020-08-29 13:39:17 +0200604 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200605 list_hashtable_vars(&SCRIPT_VARS(current_sctx.sc_sid),
606 "s:", FALSE, first);
607}
608
609/*
Bram Moolenaar9510d222022-09-11 15:14:05 +0100610 * Return TRUE if "name" starts with "g:", "w:", "t:" or "b:".
611 * But only when an identifier character follows.
612 */
613 int
614is_scoped_variable(char_u *name)
615{
616 return vim_strchr((char_u *)"gwbt", name[0]) != NULL
617 && name[1] == ':'
618 && eval_isnamec(name[2]);
619}
620
621/*
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100622 * Evaluate one Vim expression {expr} in string "p" and append the
623 * resulting string to "gap". "p" points to the opening "{".
Bram Moolenaar70c41242022-05-10 18:11:43 +0100624 * When "evaluate" is FALSE only skip over the expression.
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100625 * Return a pointer to the character after "}", NULL for an error.
626 */
627 char_u *
Bram Moolenaar70c41242022-05-10 18:11:43 +0100628eval_one_expr_in_str(char_u *p, garray_T *gap, int evaluate)
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100629{
630 char_u *block_start = skipwhite(p + 1); // skip the opening {
631 char_u *block_end = block_start;
632 char_u *expr_val;
633
634 if (*block_start == NUL)
635 {
636 semsg(_(e_missing_close_curly_str), p);
637 return NULL;
638 }
639 if (skip_expr(&block_end, NULL) == FAIL)
640 return NULL;
641 block_end = skipwhite(block_end);
642 if (*block_end != '}')
643 {
644 semsg(_(e_missing_close_curly_str), p);
645 return NULL;
646 }
Bram Moolenaar70c41242022-05-10 18:11:43 +0100647 if (evaluate)
648 {
649 *block_end = NUL;
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100650 expr_val = eval_to_string(block_start, TRUE, FALSE);
Bram Moolenaar70c41242022-05-10 18:11:43 +0100651 *block_end = '}';
652 if (expr_val == NULL)
653 return NULL;
654 ga_concat(gap, expr_val);
655 vim_free(expr_val);
656 }
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100657
658 return block_end + 1;
659}
660
661/*
662 * Evaluate all the Vim expressions {expr} in "str" and return the resulting
663 * string in allocated memory. "{{" is reduced to "{" and "}}" to "}".
664 * Used for a heredoc assignment.
665 * Returns NULL for an error.
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100666 */
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +0100667 static char_u *
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100668eval_all_expr_in_str(char_u *str)
669{
670 garray_T ga;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100671 char_u *p;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100672
673 ga_init2(&ga, 1, 80);
674 p = str;
675
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100676 while (*p != NUL)
677 {
LemonBoy2eaef102022-05-06 13:14:50 +0100678 char_u *lit_start;
LemonBoy2eaef102022-05-06 13:14:50 +0100679 int escaped_brace = FALSE;
680
681 // Look for a block start.
682 lit_start = p;
683 while (*p != '{' && *p != '}' && *p != NUL)
684 ++p;
685
686 if (*p != NUL && *p == p[1])
687 {
688 // Escaped brace, unescape and continue.
689 // Include the brace in the literal string.
690 ++p;
691 escaped_brace = TRUE;
692 }
693 else if (*p == '}')
694 {
695 semsg(_(e_stray_closing_curly_str), str);
696 ga_clear(&ga);
697 return NULL;
698 }
699
700 // Append the literal part.
701 ga_concat_len(&ga, lit_start, (size_t)(p - lit_start));
702
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100703 if (*p == NUL)
LemonBoy2eaef102022-05-06 13:14:50 +0100704 break;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100705
LemonBoy2eaef102022-05-06 13:14:50 +0100706 if (escaped_brace)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100707 {
LemonBoy2eaef102022-05-06 13:14:50 +0100708 // Skip the second brace.
709 ++p;
710 continue;
711 }
712
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100713 // Evaluate the expression and append the result.
Bram Moolenaar70c41242022-05-10 18:11:43 +0100714 p = eval_one_expr_in_str(p, &ga, TRUE);
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100715 if (p == NULL)
LemonBoy2eaef102022-05-06 13:14:50 +0100716 {
717 ga_clear(&ga);
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100718 return NULL;
719 }
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100720 }
721 ga_append(&ga, NUL);
722
723 return ga.ga_data;
724}
725
726/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200727 * Get a list of lines from a HERE document. The here document is a list of
728 * lines surrounded by a marker.
729 * cmd << {marker}
730 * {line1}
731 * {line2}
732 * ....
733 * {marker}
734 *
735 * The {marker} is a string. If the optional 'trim' word is supplied before the
736 * marker, then the leading indentation before the lines (matching the
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100737 * indentation in the "cmd" line) is stripped.
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200738 *
739 * When getting lines for an embedded script (e.g. python, lua, perl, ruby,
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100740 * tcl, mzscheme), "script_get" is set to TRUE. In this case, if the marker is
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200741 * missing, then '.' is accepted as a marker.
742 *
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100743 * When compiling a heredoc assignment to a variable in a Vim9 def function,
744 * "vim9compile" is set to TRUE. In this case, instead of generating a list of
745 * string values from the heredoc, vim9 instructions are generated. On success
746 * the returned list will be empty.
747 *
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100748 * Returns a List with {lines} or NULL on failure.
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200749 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100750 list_T *
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100751heredoc_get(exarg_T *eap, char_u *cmd, int script_get, int vim9compile)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200752{
Bram Moolenaar42ccb8d2022-04-18 15:45:23 +0100753 char_u *theline = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200754 char_u *marker;
755 list_T *l;
756 char_u *p;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100757 char_u *str;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200758 int marker_indent_len = 0;
759 int text_indent_len = 0;
760 char_u *text_indent = NULL;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200761 char_u dot[] = ".";
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200762 int comment_char = in_vim9script() ? '#' : '"';
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100763 int evalstr = FALSE;
764 int eval_failed = FALSE;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100765 cctx_T *cctx = vim9compile ? eap->cookie : NULL;
766 int count = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200767
768 if (eap->getline == NULL)
769 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000770 emsg(_(e_cannot_use_heredoc_here));
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200771 return NULL;
772 }
773
774 // Check for the optional 'trim' word before the marker
775 cmd = skipwhite(cmd);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200776
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100777 while (TRUE)
778 {
779 if (STRNCMP(cmd, "trim", 4) == 0
780 && (cmd[4] == NUL || VIM_ISWHITE(cmd[4])))
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200781 {
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100782 cmd = skipwhite(cmd + 4);
783
784 // Trim the indentation from all the lines in the here document.
785 // The amount of indentation trimmed is the same as the indentation
786 // of the first line after the :let command line. To find the end
787 // marker the indent of the :let command line is trimmed.
788 p = *eap->cmdlinep;
789 while (VIM_ISWHITE(*p))
790 {
791 p++;
792 marker_indent_len++;
793 }
794 text_indent_len = -1;
795
796 continue;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200797 }
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100798 if (STRNCMP(cmd, "eval", 4) == 0
799 && (cmd[4] == NUL || VIM_ISWHITE(cmd[4])))
800 {
801 cmd = skipwhite(cmd + 4);
802 evalstr = TRUE;
803 continue;
804 }
805 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200806 }
807
808 // The marker is the next word.
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200809 if (*cmd != NUL && *cmd != comment_char)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200810 {
811 marker = skipwhite(cmd);
812 p = skiptowhite(marker);
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200813 if (*skipwhite(p) != NUL && *skipwhite(p) != comment_char)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200814 {
Bram Moolenaar74409f62022-01-01 15:58:22 +0000815 semsg(_(e_trailing_characters_str), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200816 return NULL;
817 }
818 *p = NUL;
Bram Moolenaar6ab09532020-05-01 14:10:13 +0200819 if (!script_get && vim_islower(*marker))
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200820 {
Bram Moolenaar6d057012021-12-31 18:49:43 +0000821 emsg(_(e_marker_cannot_start_with_lower_case_letter));
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200822 return NULL;
823 }
824 }
825 else
826 {
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200827 // When getting lines for an embedded script, if the marker is missing,
828 // accept '.' as the marker.
829 if (script_get)
830 marker = dot;
831 else
832 {
Bram Moolenaar1a992222021-12-31 17:25:48 +0000833 emsg(_(e_missing_marker));
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200834 return NULL;
835 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200836 }
837
838 l = list_alloc();
839 if (l == NULL)
840 return NULL;
841
842 for (;;)
843 {
844 int mi = 0;
845 int ti = 0;
846
Bram Moolenaar42ccb8d2022-04-18 15:45:23 +0100847 vim_free(theline);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200848 theline = eap->getline(NUL, eap->cookie, 0, FALSE);
849 if (theline == NULL)
850 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000851 semsg(_(e_missing_end_marker_str), marker);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200852 break;
853 }
854
855 // with "trim": skip the indent matching the :let line to find the
856 // marker
857 if (marker_indent_len > 0
858 && STRNCMP(theline, *eap->cmdlinep, marker_indent_len) == 0)
859 mi = marker_indent_len;
860 if (STRCMP(marker, theline + mi) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200861 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200862
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100863 // If expression evaluation failed in the heredoc, then skip till the
864 // end marker.
865 if (eval_failed)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100866 continue;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100867
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200868 if (text_indent_len == -1 && *theline != NUL)
869 {
870 // set the text indent from the first line.
871 p = theline;
872 text_indent_len = 0;
873 while (VIM_ISWHITE(*p))
874 {
875 p++;
876 text_indent_len++;
877 }
878 text_indent = vim_strnsave(theline, text_indent_len);
879 }
880 // with "trim": skip the indent matching the first line
881 if (text_indent != NULL)
882 for (ti = 0; ti < text_indent_len; ++ti)
883 if (theline[ti] != text_indent[ti])
884 break;
885
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100886 str = theline + ti;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100887 if (vim9compile)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100888 {
LemonBoy2eaef102022-05-06 13:14:50 +0100889 if (compile_all_expr_in_str(str, evalstr, cctx) == FAIL)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100890 {
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100891 vim_free(theline);
892 vim_free(text_indent);
893 return FAIL;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100894 }
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100895 count++;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100896 }
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100897 else
898 {
Bram Moolenaar05c7f5d2022-04-28 16:51:41 +0100899 if (evalstr && !eap->skip)
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100900 {
901 str = eval_all_expr_in_str(str);
902 if (str == NULL)
903 {
904 // expression evaluation failed
905 eval_failed = TRUE;
906 continue;
907 }
908 vim_free(theline);
909 theline = str;
910 }
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100911
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100912 if (list_append_string(l, str, -1) == FAIL)
913 break;
914 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200915 }
Bram Moolenaar42ccb8d2022-04-18 15:45:23 +0100916 vim_free(theline);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200917 vim_free(text_indent);
918
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100919 if (vim9compile && cctx->ctx_skip != SKIP_YES && !eval_failed)
920 generate_NEWLIST(cctx, count, FALSE);
921
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100922 if (eval_failed)
923 {
924 // expression evaluation in the heredoc failed
925 list_free(l);
926 return NULL;
927 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200928 return l;
929}
930
931/*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200932 * Vim9 variable declaration:
933 * ":var name"
934 * ":var name: type"
935 * ":var name = expr"
936 * ":var name: type = expr"
937 * etc.
938 */
939 void
940ex_var(exarg_T *eap)
941{
Bram Moolenaar330a3882022-03-05 11:05:57 +0000942 char_u *p = eap->cmd;
Bram Moolenaare1d12112022-03-05 11:37:48 +0000943 int has_var;
Bram Moolenaar330a3882022-03-05 11:05:57 +0000944
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200945 if (!in_vim9script())
946 {
947 semsg(_(e_str_cannot_be_used_in_legacy_vim_script), ":var");
948 return;
949 }
Bram Moolenaare1d12112022-03-05 11:37:48 +0000950 has_var = checkforcmd_noparen(&p, "var", 3);
951 if (current_sctx.sc_sid == 0 && has_var)
Bram Moolenaar0e1574c2022-03-03 17:05:35 +0000952 {
953 emsg(_(e_cannot_declare_variable_on_command_line));
954 return;
955 }
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200956 ex_let(eap);
957}
958
959/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200960 * ":let" list all variable values
961 * ":let var1 var2" list variable values
962 * ":let var = expr" assignment command.
963 * ":let var += expr" assignment command.
964 * ":let var -= expr" assignment command.
965 * ":let var *= expr" assignment command.
966 * ":let var /= expr" assignment command.
967 * ":let var %= expr" assignment command.
968 * ":let var .= expr" assignment command.
969 * ":let var ..= expr" assignment command.
970 * ":let [var1, var2] = expr" unpack list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100971 * ":let var =<< ..." heredoc
Bram Moolenaard672dde2020-02-26 13:43:51 +0100972 * ":let var: string" Vim9 declaration
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200973 *
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200974 * ":final var = expr" assignment command.
975 * ":final [var1, var2] = expr" unpack list.
976 *
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200977 * ":const" list all variable values
978 * ":const var1 var2" list variable values
979 * ":const var = expr" assignment command.
980 * ":const [var1, var2] = expr" unpack list.
981 */
982 void
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200983ex_let(exarg_T *eap)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200984{
985 char_u *arg = eap->arg;
986 char_u *expr = NULL;
987 typval_T rettv;
988 int i;
989 int var_count = 0;
990 int semicolon = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200991 char_u op[4];
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200992 char_u *argend;
993 int first = TRUE;
994 int concat;
Bram Moolenaar32e35112020-05-14 22:41:15 +0200995 int has_assign;
Bram Moolenaar89b474d2020-12-22 21:19:39 +0100996 int flags = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200997 int vim9script = in_vim9script();
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200998
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200999 if (eap->cmdidx == CMD_final && !vim9script)
1000 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001001 // In legacy Vim script ":final" is short for ":finally".
1002 ex_finally(eap);
1003 return;
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001004 }
Bram Moolenaarc58f5452020-10-21 20:58:52 +02001005 if (eap->cmdidx == CMD_let && vim9script)
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02001006 {
1007 emsg(_(e_cannot_use_let_in_vim9_script));
1008 return;
1009 }
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001010
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001011 if (eap->cmdidx == CMD_const)
1012 flags |= ASSIGN_CONST;
1013 else if (eap->cmdidx == CMD_final)
1014 flags |= ASSIGN_FINAL;
1015
1016 // Vim9 assignment without ":let", ":const" or ":final"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001017 if (eap->arg == eap->cmd)
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001018 flags |= ASSIGN_NO_DECL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001019
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001020 argend = skip_var_list(arg, TRUE, &var_count, &semicolon, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001021 if (argend == NULL)
1022 return;
1023 if (argend > arg && argend[-1] == '.') // for var.='str'
1024 --argend;
1025 expr = skipwhite(argend);
1026 concat = expr[0] == '.'
Bram Moolenaardd9de502021-08-15 13:49:42 +02001027 && ((expr[1] == '=' && in_old_script(2))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001028 || (expr[1] == '.' && expr[2] == '='));
Bram Moolenaar32e35112020-05-14 22:41:15 +02001029 has_assign = *expr == '=' || (vim_strchr((char_u *)"+-*/%", *expr) != NULL
1030 && expr[1] == '=');
Bram Moolenaar822ba242020-05-24 23:00:18 +02001031 if (!has_assign && !concat)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001032 {
1033 // ":let" without "=": list variables
1034 if (*arg == '[')
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001035 emsg(_(e_invalid_argument));
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001036 else if (expr[0] == '.' && expr[1] == '=')
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001037 emsg(_(e_dot_equal_not_supported_with_script_version_two));
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001038 else if (!ends_excmd2(eap->cmd, arg))
Bram Moolenaarc82a5b52020-06-13 18:09:19 +02001039 {
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001040 if (vim9script)
Bram Moolenaarc82a5b52020-06-13 18:09:19 +02001041 {
Bram Moolenaarccc25aa2021-03-26 21:27:52 +01001042 if (!ends_excmd2(eap->cmd, skipwhite(argend)))
Bram Moolenaar74409f62022-01-01 15:58:22 +00001043 semsg(_(e_trailing_characters_str), argend);
Bram Moolenaarccc25aa2021-03-26 21:27:52 +01001044 else
1045 // Vim9 declaration ":var name: type"
1046 arg = vim9_declare_scriptvar(eap, arg);
Bram Moolenaarc82a5b52020-06-13 18:09:19 +02001047 }
1048 else
1049 {
1050 // ":let var1 var2" - list values
1051 arg = list_arg_vars(eap, arg, &first);
1052 }
1053 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001054 else if (!eap->skip)
1055 {
1056 // ":let"
1057 list_glob_vars(&first);
1058 list_buf_vars(&first);
1059 list_win_vars(&first);
1060 list_tab_vars(&first);
1061 list_script_vars(&first);
1062 list_func_vars(&first);
1063 list_vim_vars(&first);
1064 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02001065 set_nextcmd(eap, arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001066 }
1067 else if (expr[0] == '=' && expr[1] == '<' && expr[2] == '<')
1068 {
Bram Moolenaard9876422022-10-12 12:58:54 +01001069 list_T *l = NULL;
Bram Moolenaar81530e32021-07-28 21:25:49 +02001070 long cur_lnum = SOURCING_LNUM;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001071
Bram Moolenaard9876422022-10-12 12:58:54 +01001072 // :let text =<< [trim] [eval] END
1073 // :var text =<< [trim] [eval] END
1074 if (vim9script && !eap->skip && (!VIM_ISWHITE(expr[-1])
1075 || !IS_WHITE_OR_NUL(expr[3])))
1076 semsg(_(e_white_space_required_before_and_after_str_at_str),
1077 "=<<", expr);
1078 else
1079 l = heredoc_get(eap, expr + 3, FALSE, FALSE);
1080
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001081 if (l != NULL)
1082 {
1083 rettv_list_set(&rettv, l);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +02001084 if (!eap->skip)
1085 {
Bram Moolenaar81530e32021-07-28 21:25:49 +02001086 // errors are for the assignment, not the end marker
1087 SOURCING_LNUM = cur_lnum;
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +02001088 op[0] = '=';
1089 op[1] = NUL;
1090 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001091 flags, op);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +02001092 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001093 clear_tv(&rettv);
1094 }
1095 }
1096 else
1097 {
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001098 evalarg_T evalarg;
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001099 int len = 1;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001100
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02001101 CLEAR_FIELD(rettv);
Bram Moolenaar32e35112020-05-14 22:41:15 +02001102 i = FAIL;
1103 if (has_assign || concat)
1104 {
Bram Moolenaar9a562c12021-01-23 13:39:14 +01001105 int cur_lnum;
1106
Bram Moolenaar32e35112020-05-14 22:41:15 +02001107 op[0] = '=';
1108 op[1] = NUL;
1109 if (*expr != '=')
1110 {
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001111 if (vim9script && (flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar122616d2020-08-21 21:32:50 +02001112 {
1113 // +=, /=, etc. require an existing variable
1114 semsg(_(e_cannot_use_operator_on_new_variable), eap->arg);
Bram Moolenaar122616d2020-08-21 21:32:50 +02001115 }
1116 else if (vim_strchr((char_u *)"+-*/%.", *expr) != NULL)
Bram Moolenaar32e35112020-05-14 22:41:15 +02001117 {
1118 op[0] = *expr; // +=, -=, *=, /=, %= or .=
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001119 ++len;
Bram Moolenaar32e35112020-05-14 22:41:15 +02001120 if (expr[0] == '.' && expr[1] == '.') // ..=
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001121 {
Bram Moolenaar32e35112020-05-14 22:41:15 +02001122 ++expr;
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001123 ++len;
1124 }
Bram Moolenaar32e35112020-05-14 22:41:15 +02001125 }
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001126 expr += 2;
Bram Moolenaar32e35112020-05-14 22:41:15 +02001127 }
1128 else
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001129 ++expr;
1130
Bram Moolenaar7f2c3412021-11-29 16:01:49 +00001131 if (vim9script && !eap->skip && (!VIM_ISWHITE(*argend)
Bram Moolenaarc7e44a72020-07-29 21:37:43 +02001132 || !IS_WHITE_OR_NUL(*expr)))
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001133 {
1134 vim_strncpy(op, expr - len, len);
Bram Moolenaare7a73e02021-01-01 19:17:55 +01001135 semsg(_(e_white_space_required_before_and_after_str_at_str),
1136 op, argend);
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001137 }
Bram Moolenaar32e35112020-05-14 22:41:15 +02001138
1139 if (eap->skip)
1140 ++emsg_skip;
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001141 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaarc7e44a72020-07-29 21:37:43 +02001142 expr = skipwhite_and_linebreak(expr, &evalarg);
Bram Moolenaar9a562c12021-01-23 13:39:14 +01001143 cur_lnum = SOURCING_LNUM;
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001144 i = eval0(expr, &rettv, eap, &evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001145 if (eap->skip)
1146 --emsg_skip;
Bram Moolenaarfaf86262020-06-27 23:07:36 +02001147 clear_evalarg(&evalarg, eap);
Bram Moolenaar9a562c12021-01-23 13:39:14 +01001148
1149 // Restore the line number so that any type error is given for the
1150 // declaration, not the expression.
1151 SOURCING_LNUM = cur_lnum;
Bram Moolenaar32e35112020-05-14 22:41:15 +02001152 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001153 if (eap->skip)
1154 {
1155 if (i != FAIL)
1156 clear_tv(&rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001157 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02001158 else if (i != FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001159 {
1160 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001161 flags, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001162 clear_tv(&rettv);
1163 }
1164 }
1165}
1166
1167/*
Bram Moolenaar6c3843c2021-03-04 12:38:21 +01001168 * Assign the typeval "tv" to the variable or variables at "arg_start".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001169 * Handles both "var" with any type and "[var, var; var]" with a list type.
1170 * When "op" is not NULL it points to a string with characters that
1171 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1172 * or concatenate.
1173 * Returns OK or FAIL;
1174 */
1175 int
1176ex_let_vars(
1177 char_u *arg_start,
1178 typval_T *tv,
1179 int copy, // copy values from "tv", don't move
1180 int semicolon, // from skip_var_list()
1181 int var_count, // from skip_var_list()
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001182 int flags, // ASSIGN_FINAL, ASSIGN_CONST, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001183 char_u *op)
1184{
1185 char_u *arg = arg_start;
1186 list_T *l;
1187 int i;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001188 int var_idx = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001189 listitem_T *item;
1190 typval_T ltv;
1191
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00001192 if (tv->v_type == VAR_VOID)
1193 {
1194 emsg(_(e_cannot_use_void_value));
1195 return FAIL;
1196 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001197 if (*arg != '[')
1198 {
1199 // ":let var = expr" or ":for var in list"
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001200 if (ex_let_one(arg, tv, copy, flags, op, op, var_idx) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001201 return FAIL;
1202 return OK;
1203 }
1204
1205 // ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1206 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1207 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001208 emsg(_(e_list_required));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001209 return FAIL;
1210 }
1211
1212 i = list_len(l);
1213 if (semicolon == 0 && var_count < i)
1214 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00001215 emsg(_(e_less_targets_than_list_items));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001216 return FAIL;
1217 }
1218 if (var_count - semicolon > i)
1219 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00001220 emsg(_(e_more_targets_than_list_items));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001221 return FAIL;
1222 }
1223
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001224 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001225 item = l->lv_first;
1226 while (*arg != ']')
1227 {
1228 arg = skipwhite(arg + 1);
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001229 ++var_idx;
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02001230 arg = ex_let_one(arg, &item->li_tv, TRUE,
1231 flags | ASSIGN_UNPACK, (char_u *)",;]", op, var_idx);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001232 item = item->li_next;
1233 if (arg == NULL)
1234 return FAIL;
1235
1236 arg = skipwhite(arg);
1237 if (*arg == ';')
1238 {
1239 // Put the rest of the list (may be empty) in the var after ';'.
1240 // Create a new list for this.
1241 l = list_alloc();
1242 if (l == NULL)
1243 return FAIL;
1244 while (item != NULL)
1245 {
1246 list_append_tv(l, &item->li_tv);
1247 item = item->li_next;
1248 }
1249
1250 ltv.v_type = VAR_LIST;
1251 ltv.v_lock = 0;
1252 ltv.vval.v_list = l;
1253 l->lv_refcount = 1;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001254 ++var_idx;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001255
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02001256 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1257 flags | ASSIGN_UNPACK, (char_u *)"]", op, var_idx);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001258 clear_tv(&ltv);
1259 if (arg == NULL)
1260 return FAIL;
1261 break;
1262 }
1263 else if (*arg != ',' && *arg != ']')
1264 {
1265 internal_error("ex_let_vars()");
1266 return FAIL;
1267 }
1268 }
1269
1270 return OK;
1271}
1272
1273/*
1274 * Skip over assignable variable "var" or list of variables "[var, var]".
1275 * Used for ":let varvar = expr" and ":for varvar in expr".
1276 * For "[var, var]" increment "*var_count" for each variable.
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001277 * for "[var, var; var]" set "semicolon" to 1.
1278 * If "silent" is TRUE do not give an "invalid argument" error message.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001279 * Return NULL for an error.
1280 */
1281 char_u *
1282skip_var_list(
1283 char_u *arg,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001284 int include_type,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001285 int *var_count,
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001286 int *semicolon,
1287 int silent)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001288{
1289 char_u *p, *s;
1290
1291 if (*arg == '[')
1292 {
1293 // "[var, var]": find the matching ']'.
1294 p = arg;
1295 for (;;)
1296 {
1297 p = skipwhite(p + 1); // skip whites after '[', ';' or ','
Bram Moolenaar036d0712021-01-17 20:23:38 +01001298 s = skip_var_one(p, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001299 if (s == p)
1300 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001301 if (!silent)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001302 semsg(_(e_invalid_argument_str), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001303 return NULL;
1304 }
1305 ++*var_count;
1306
1307 p = skipwhite(s);
1308 if (*p == ']')
1309 break;
1310 else if (*p == ';')
1311 {
1312 if (*semicolon == 1)
1313 {
Bram Moolenaar8b716f52022-02-15 21:17:56 +00001314 if (!silent)
1315 emsg(_(e_double_semicolon_in_list_of_variables));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001316 return NULL;
1317 }
1318 *semicolon = 1;
1319 }
1320 else if (*p != ',')
1321 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001322 if (!silent)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001323 semsg(_(e_invalid_argument_str), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001324 return NULL;
1325 }
1326 }
1327 return p + 1;
1328 }
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01001329
Bram Moolenaare8e369a2022-09-21 18:59:14 +01001330 return skip_var_one(arg, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001331}
1332
1333/*
1334 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1335 * l[idx].
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001336 * In Vim9 script also skip over ": type" if "include_type" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001337 */
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001338 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001339skip_var_one(char_u *arg, int include_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001340{
Bram Moolenaar585587d2021-01-17 20:52:13 +01001341 char_u *end;
1342 int vim9 = in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001343
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001344 if (*arg == '@' && arg[1] != NUL)
1345 return arg + 2;
Bram Moolenaar1573e732022-11-16 20:33:21 +00001346
1347 // termcap option name may have non-alpha characters
1348 if (STRNCMP(arg, "&t_", 3) == 0 && arg[3] != NUL && arg[4] != NUL)
1349 return arg + 5;
1350
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001351 end = find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001352 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
Bram Moolenaar036d0712021-01-17 20:23:38 +01001353
1354 // "a: type" is declaring variable "a" with a type, not "a:".
1355 // Same for "s: type".
Bram Moolenaar585587d2021-01-17 20:52:13 +01001356 if (vim9 && end == arg + 2 && end[-1] == ':')
Bram Moolenaar036d0712021-01-17 20:23:38 +01001357 --end;
1358
Bram Moolenaar585587d2021-01-17 20:52:13 +01001359 if (include_type && vim9)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001360 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001361 if (*end == ':')
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02001362 end = skip_type(skipwhite(end + 1), FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001363 }
1364 return end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001365}
1366
1367/*
1368 * List variables for hashtab "ht" with prefix "prefix".
1369 * If "empty" is TRUE also list NULL strings as empty strings.
1370 */
1371 void
1372list_hashtable_vars(
1373 hashtab_T *ht,
1374 char *prefix,
1375 int empty,
1376 int *first)
1377{
1378 hashitem_T *hi;
1379 dictitem_T *di;
1380 int todo;
1381 char_u buf[IOSIZE];
1382
Bram Moolenaaref2c3252022-11-25 16:31:51 +00001383 int save_ht_flags = ht->ht_flags;
1384 ht->ht_flags |= HTFLAGS_FROZEN;
1385
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001386 todo = (int)ht->ht_used;
1387 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1388 {
1389 if (!HASHITEM_EMPTY(hi))
1390 {
1391 --todo;
1392 di = HI2DI(hi);
1393
1394 // apply :filter /pat/ to variable name
1395 vim_strncpy((char_u *)buf, (char_u *)prefix, IOSIZE - 1);
1396 vim_strcat((char_u *)buf, di->di_key, IOSIZE);
1397 if (message_filtered(buf))
1398 continue;
1399
1400 if (empty || di->di_tv.v_type != VAR_STRING
1401 || di->di_tv.vval.v_string != NULL)
1402 list_one_var(di, prefix, first);
1403 }
1404 }
Bram Moolenaaref2c3252022-11-25 16:31:51 +00001405
1406 ht->ht_flags = save_ht_flags;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001407}
1408
1409/*
1410 * List global variables.
1411 */
1412 static void
1413list_glob_vars(int *first)
1414{
1415 list_hashtable_vars(&globvarht, "", TRUE, first);
1416}
1417
1418/*
1419 * List buffer variables.
1420 */
1421 static void
1422list_buf_vars(int *first)
1423{
1424 list_hashtable_vars(&curbuf->b_vars->dv_hashtab, "b:", TRUE, first);
1425}
1426
1427/*
1428 * List window variables.
1429 */
1430 static void
1431list_win_vars(int *first)
1432{
1433 list_hashtable_vars(&curwin->w_vars->dv_hashtab, "w:", TRUE, first);
1434}
1435
1436/*
1437 * List tab page variables.
1438 */
1439 static void
1440list_tab_vars(int *first)
1441{
1442 list_hashtable_vars(&curtab->tp_vars->dv_hashtab, "t:", TRUE, first);
1443}
1444
1445/*
1446 * List variables in "arg".
1447 */
1448 static char_u *
1449list_arg_vars(exarg_T *eap, char_u *arg, int *first)
1450{
1451 int error = FALSE;
1452 int len;
1453 char_u *name;
1454 char_u *name_start;
1455 char_u *arg_subsc;
1456 char_u *tofree;
1457 typval_T tv;
1458
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001459 while (!ends_excmd2(eap->cmd, arg) && !got_int)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001460 {
1461 if (error || eap->skip)
1462 {
1463 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1464 if (!VIM_ISWHITE(*arg) && !ends_excmd(*arg))
1465 {
1466 emsg_severe = TRUE;
Bram Moolenaar4830c212021-08-14 14:59:27 +02001467 if (!did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00001468 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001469 break;
1470 }
1471 }
1472 else
1473 {
1474 // get_name_len() takes care of expanding curly braces
1475 name_start = name = arg;
1476 len = get_name_len(&arg, &tofree, TRUE, TRUE);
1477 if (len <= 0)
1478 {
1479 // This is mainly to keep test 49 working: when expanding
1480 // curly braces fails overrule the exception error message.
1481 if (len < 0 && !aborting())
1482 {
1483 emsg_severe = TRUE;
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001484 semsg(_(e_invalid_argument_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001485 break;
1486 }
1487 error = TRUE;
1488 }
1489 else
1490 {
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02001491 arg = skipwhite(arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001492 if (tofree != NULL)
1493 name = tofree;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001494 if (eval_variable(name, len, 0, &tv, NULL,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01001495 EVAL_VAR_VERBOSE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001496 error = TRUE;
1497 else
1498 {
1499 // handle d.key, l[idx], f(expr)
1500 arg_subsc = arg;
Bram Moolenaar32884ad2022-01-07 12:45:29 +00001501 if (handle_subscript(&arg, name_start, &tv,
1502 &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001503 error = TRUE;
1504 else
1505 {
1506 if (arg == arg_subsc && len == 2 && name[1] == ':')
1507 {
1508 switch (*name)
1509 {
1510 case 'g': list_glob_vars(first); break;
1511 case 'b': list_buf_vars(first); break;
1512 case 'w': list_win_vars(first); break;
1513 case 't': list_tab_vars(first); break;
1514 case 'v': list_vim_vars(first); break;
1515 case 's': list_script_vars(first); break;
1516 case 'l': list_func_vars(first); break;
1517 default:
Bram Moolenaara6f79292022-01-04 21:30:47 +00001518 semsg(_(e_cant_list_variables_for_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001519 }
1520 }
1521 else
1522 {
1523 char_u numbuf[NUMBUFLEN];
1524 char_u *tf;
1525 int c;
1526 char_u *s;
1527
1528 s = echo_string(&tv, &tf, numbuf, 0);
1529 c = *arg;
1530 *arg = NUL;
1531 list_one_var_a("",
1532 arg == arg_subsc ? name : name_start,
1533 tv.v_type,
1534 s == NULL ? (char_u *)"" : s,
1535 first);
1536 *arg = c;
1537 vim_free(tf);
1538 }
1539 clear_tv(&tv);
1540 }
1541 }
1542 }
1543
1544 vim_free(tofree);
1545 }
1546
1547 arg = skipwhite(arg);
1548 }
1549
1550 return arg;
1551}
1552
1553/*
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001554 * Set an environment variable, part of ex_let_one().
1555 */
1556 static char_u *
1557ex_let_env(
1558 char_u *arg,
1559 typval_T *tv,
1560 int flags,
1561 char_u *endchars,
1562 char_u *op)
1563{
1564 char_u *arg_end = NULL;
1565 char_u *name;
1566 int len;
1567
1568 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1569 && (flags & ASSIGN_FOR_LOOP) == 0)
1570 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001571 emsg(_(e_cannot_lock_environment_variable));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001572 return NULL;
1573 }
1574
1575 // Find the end of the name.
1576 ++arg;
1577 name = arg;
1578 len = get_env_len(&arg);
1579 if (len == 0)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001580 semsg(_(e_invalid_argument_str), name - 1);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001581 else
1582 {
1583 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001584 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001585 else if (endchars != NULL
1586 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
1587 emsg(_(e_unexpected_characters_in_let));
1588 else if (!check_secure())
1589 {
1590 char_u *tofree = NULL;
1591 int c1 = name[len];
1592 char_u *p;
1593
1594 name[len] = NUL;
1595 p = tv_get_string_chk(tv);
1596 if (p != NULL && op != NULL && *op == '.')
1597 {
1598 int mustfree = FALSE;
1599 char_u *s = vim_getenv(name, &mustfree);
1600
1601 if (s != NULL)
1602 {
1603 p = tofree = concat_str(s, p);
1604 if (mustfree)
1605 vim_free(s);
1606 }
1607 }
1608 if (p != NULL)
1609 {
1610 vim_setenv_ext(name, p);
1611 arg_end = arg;
1612 }
1613 name[len] = c1;
1614 vim_free(tofree);
1615 }
1616 }
1617 return arg_end;
1618}
1619
1620/*
1621 * Set an option, part of ex_let_one().
1622 */
1623 static char_u *
1624ex_let_option(
1625 char_u *arg,
1626 typval_T *tv,
1627 int flags,
1628 char_u *endchars,
1629 char_u *op)
1630{
1631 char_u *p;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001632 int scope;
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001633 char_u *arg_end = NULL;
1634
1635 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1636 && (flags & ASSIGN_FOR_LOOP) == 0)
1637 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001638 emsg(_(e_cannot_lock_option));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001639 return NULL;
1640 }
1641
1642 // Find the end of the name.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001643 p = find_option_end(&arg, &scope);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001644 if (p == NULL || (endchars != NULL
1645 && vim_strchr(endchars, *skipwhite(p)) == NULL))
1646 emsg(_(e_unexpected_characters_in_let));
1647 else
1648 {
1649 int c1;
1650 long n = 0;
1651 getoption_T opt_type;
1652 long numval;
1653 char_u *stringval = NULL;
1654 char_u *s = NULL;
1655 int failed = FALSE;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001656 int opt_p_flags;
1657 char_u *tofree = NULL;
Bram Moolenaar92c33eb2021-12-07 11:03:39 +00001658 char_u numbuf[NUMBUFLEN];
1659
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001660 c1 = *p;
1661 *p = NUL;
1662
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001663 opt_type = get_option_value(arg, &numval, &stringval, &opt_p_flags,
1664 scope);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001665 if ((opt_type == gov_bool
1666 || opt_type == gov_number
1667 || opt_type == gov_hidden_bool
1668 || opt_type == gov_hidden_number)
1669 && (tv->v_type != VAR_STRING || !in_vim9script()))
1670 {
1671 if (opt_type == gov_bool || opt_type == gov_hidden_bool)
1672 // bool, possibly hidden
1673 n = (long)tv_get_bool(tv);
1674 else
1675 // number, possibly hidden
1676 n = (long)tv_get_number(tv);
1677 }
1678
Bram Moolenaaref082e12021-12-12 21:02:03 +00001679 if ((opt_p_flags & P_FUNC) && (tv->v_type == VAR_PARTIAL
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001680 || tv->v_type == VAR_FUNC))
1681 {
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001682 // If the option can be set to a function reference or a lambda
1683 // and the passed value is a function reference, then convert it to
1684 // the name (string) of the function reference.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001685 s = tv2string(tv, &tofree, numbuf, 0);
1686 }
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001687 // Avoid setting a string option to the text "v:false" or similar.
1688 // In Vim9 script also don't convert a number to string.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001689 else if (tv->v_type != VAR_BOOL && tv->v_type != VAR_SPECIAL
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001690 && (!in_vim9script() || tv->v_type != VAR_NUMBER))
1691 s = tv_get_string_chk(tv);
1692
1693 if (op != NULL && *op != '=')
1694 {
1695 if (((opt_type == gov_bool || opt_type == gov_number) && *op == '.')
1696 || (opt_type == gov_string && *op != '.'))
1697 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001698 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001699 failed = TRUE; // don't set the value
1700
1701 }
1702 else
1703 {
1704 // number, in legacy script also bool
1705 if (opt_type == gov_number
1706 || (opt_type == gov_bool && !in_vim9script()))
1707 {
1708 switch (*op)
1709 {
1710 case '+': n = numval + n; break;
1711 case '-': n = numval - n; break;
1712 case '*': n = numval * n; break;
1713 case '/': n = (long)num_divide(numval, n,
1714 &failed); break;
1715 case '%': n = (long)num_modulus(numval, n,
1716 &failed); break;
1717 }
1718 s = NULL;
1719 }
1720 else if (opt_type == gov_string
1721 && stringval != NULL && s != NULL)
1722 {
1723 // string
1724 s = concat_str(stringval, s);
1725 vim_free(stringval);
1726 stringval = s;
1727 }
1728 }
1729 }
1730
1731 if (!failed)
1732 {
1733 if (opt_type != gov_string || s != NULL)
1734 {
Bram Moolenaar8ccbbeb2022-03-02 19:49:38 +00001735 char *err = set_option_value(arg, n, s, scope);
1736
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001737 arg_end = p;
Bram Moolenaar8ccbbeb2022-03-02 19:49:38 +00001738 if (err != NULL)
1739 emsg(_(err));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001740 }
1741 else
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001742 emsg(_(e_string_required));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001743 }
1744 *p = c1;
1745 vim_free(stringval);
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001746 vim_free(tofree);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001747 }
1748 return arg_end;
1749}
1750
1751/*
1752 * Set a register, part of ex_let_one().
1753 */
1754 static char_u *
1755ex_let_register(
1756 char_u *arg,
1757 typval_T *tv,
1758 int flags,
1759 char_u *endchars,
1760 char_u *op)
1761{
1762 char_u *arg_end = NULL;
1763
1764 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1765 && (flags & ASSIGN_FOR_LOOP) == 0)
1766 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001767 emsg(_(e_cannot_lock_register));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001768 return NULL;
1769 }
1770 ++arg;
1771 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001772 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001773 else if (endchars != NULL
1774 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
1775 emsg(_(e_unexpected_characters_in_let));
1776 else
1777 {
1778 char_u *ptofree = NULL;
1779 char_u *p;
1780
1781 p = tv_get_string_chk(tv);
1782 if (p != NULL && op != NULL && *op == '.')
1783 {
1784 char_u *s = get_reg_contents(*arg == '@'
1785 ? '"' : *arg, GREG_EXPR_SRC);
1786
1787 if (s != NULL)
1788 {
1789 p = ptofree = concat_str(s, p);
1790 vim_free(s);
1791 }
1792 }
1793 if (p != NULL)
1794 {
1795 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
1796 arg_end = arg + 1;
1797 }
1798 vim_free(ptofree);
1799 }
1800 return arg_end;
1801}
1802
1803/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001804 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
1805 * Returns a pointer to the char just after the var name.
1806 * Returns NULL if there is an error.
1807 */
1808 static char_u *
1809ex_let_one(
1810 char_u *arg, // points to variable name
1811 typval_T *tv, // value to assign to variable
1812 int copy, // copy value from "tv"
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001813 int flags, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001814 char_u *endchars, // valid chars after variable name or NULL
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001815 char_u *op, // "+", "-", "." or NULL
1816 int var_idx) // variable index for "let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001817{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001818 char_u *arg_end = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001819
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001820 if (in_vim9script() && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001821 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001822 && vim_strchr((char_u *)"$@&", *arg) != NULL)
1823 {
1824 vim9_declare_error(arg);
1825 return NULL;
1826 }
1827
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001828 if (*arg == '$')
1829 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001830 // ":let $VAR = expr": Set environment variable.
1831 return ex_let_env(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001832 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001833 else if (*arg == '&')
1834 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001835 // ":let &option = expr": Set option value.
1836 // ":let &l:option = expr": Set local option value.
1837 // ":let &g:option = expr": Set global option value.
1838 // ":for &ts in range(8)": Set option value for for loop
1839 return ex_let_option(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001840 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001841 else if (*arg == '@')
1842 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001843 // ":let @r = expr": Set register contents.
1844 return ex_let_register(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001845 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001846 else if (eval_isnamec1(*arg) || *arg == '{')
1847 {
1848 lval_T lv;
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001849 char_u *p;
Bram Moolenaar22ebd172022-04-01 15:26:58 +01001850 int lval_flags = (flags & (ASSIGN_NO_DECL | ASSIGN_DECL))
1851 ? GLV_NO_DECL : 0;
1852 if (op != NULL && *op != '=')
1853 lval_flags |= GLV_ASSIGN_WITH_OP;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001854
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001855 // ":let var = expr": Set internal variable.
1856 // ":let var: type = expr": Set internal variable with type.
1857 // ":let {expr} = expr": Idem, name made with curly braces
Bram Moolenaar22ebd172022-04-01 15:26:58 +01001858 p = get_lval(arg, tv, &lv, FALSE, FALSE, lval_flags, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001859 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001860 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001861 if (endchars != NULL && vim_strchr(endchars,
1862 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001863 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001864 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001865 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001866 else
1867 {
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001868 set_var_lval(&lv, p, tv, copy, flags, op, var_idx);
Bram Moolenaara3589a02021-04-14 13:30:46 +02001869 arg_end = lv.ll_name_end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001870 }
1871 }
1872 clear_lval(&lv);
1873 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001874 else
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001875 semsg(_(e_invalid_argument_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001876
1877 return arg_end;
1878}
1879
1880/*
1881 * ":unlet[!] var1 ... " command.
1882 */
1883 void
1884ex_unlet(exarg_T *eap)
1885{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001886 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001887}
1888
1889/*
1890 * ":lockvar" and ":unlockvar" commands
1891 */
1892 void
1893ex_lockvar(exarg_T *eap)
1894{
1895 char_u *arg = eap->arg;
1896 int deep = 2;
1897
1898 if (eap->forceit)
1899 deep = -1;
1900 else if (vim_isdigit(*arg))
1901 {
1902 deep = getdigits(&arg);
1903 arg = skipwhite(arg);
1904 }
1905
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001906 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001907}
1908
1909/*
1910 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001911 * Also used for Vim9 script. "callback" is invoked as:
1912 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001913 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001914 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001915ex_unletlock(
1916 exarg_T *eap,
1917 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001918 int deep,
1919 int glv_flags,
1920 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1921 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001922{
1923 char_u *arg = argstart;
1924 char_u *name_end;
1925 int error = FALSE;
1926 lval_T lv;
1927
1928 do
1929 {
1930 if (*arg == '$')
1931 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001932 lv.ll_name = arg;
1933 lv.ll_tv = NULL;
1934 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001935 if (get_env_len(&arg) == 0)
1936 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001937 semsg(_(e_invalid_argument_str), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001938 return;
1939 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001940 if (!error && !eap->skip
1941 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1942 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001943 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001944 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001945 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001946 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001947 // Parse the name and find the end.
1948 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
Bram Moolenaarc3689572021-01-01 19:40:02 +01001949 glv_flags | GLV_NO_DECL, FNE_CHECK_START);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001950 if (lv.ll_name == NULL)
1951 error = TRUE; // error but continue parsing
1952 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1953 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001954 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001955 if (name_end != NULL)
1956 {
1957 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00001958 semsg(_(e_trailing_characters_str), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001959 }
1960 if (!(eap->skip || error))
1961 clear_lval(&lv);
1962 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001963 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001964
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001965 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001966 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001967 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001968
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001969 if (!eap->skip)
1970 clear_lval(&lv);
1971 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001972
1973 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001974 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001975
Bram Moolenaar63b91732021-08-05 20:40:03 +02001976 set_nextcmd(eap, arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001977}
1978
1979 static int
1980do_unlet_var(
1981 lval_T *lp,
1982 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001983 exarg_T *eap,
1984 int deep UNUSED,
1985 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001986{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001987 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001988 int ret = OK;
1989 int cc;
1990
1991 if (lp->ll_tv == NULL)
1992 {
1993 cc = *name_end;
1994 *name_end = NUL;
1995
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001996 // Environment variable, normal name or expanded name.
1997 if (*lp->ll_name == '$')
LemonBoy77142312022-04-15 20:50:46 +01001998 vim_unsetenv_ext(lp->ll_name + 1);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001999 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002000 ret = FAIL;
2001 *name_end = cc;
2002 }
2003 else if ((lp->ll_list != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02002004 && value_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002005 || (lp->ll_dict != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02002006 && value_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002007 return FAIL;
2008 else if (lp->ll_range)
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002009 list_unlet_range(lp->ll_list, lp->ll_li, lp->ll_n1,
2010 !lp->ll_empty2, lp->ll_n2);
2011 else if (lp->ll_list != NULL)
2012 // unlet a List item.
2013 listitem_remove(lp->ll_list, lp->ll_li);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002014 else
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002015 // unlet a Dictionary item.
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002016 dictitem_remove(lp->ll_dict, lp->ll_di, "unlet");
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002017
2018 return ret;
2019}
2020
2021/*
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002022 * Unlet one item or a range of items from a list.
2023 * Return OK or FAIL.
2024 */
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002025 void
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002026list_unlet_range(
2027 list_T *l,
2028 listitem_T *li_first,
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002029 long n1_arg,
2030 int has_n2,
2031 long n2)
2032{
2033 listitem_T *li = li_first;
2034 int n1 = n1_arg;
2035
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002036 // Delete a range of List items.
2037 li = li_first;
2038 n1 = n1_arg;
2039 while (li != NULL && (!has_n2 || n2 >= n1))
2040 {
2041 listitem_T *next = li->li_next;
2042
2043 listitem_remove(l, li);
2044 li = next;
2045 ++n1;
2046 }
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002047}
2048/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002049 * "unlet" a variable. Return OK if it existed, FAIL if not.
2050 * When "forceit" is TRUE don't complain if the variable doesn't exist.
2051 */
2052 int
2053do_unlet(char_u *name, int forceit)
2054{
2055 hashtab_T *ht;
2056 hashitem_T *hi;
mityu8be36ee2022-05-25 17:29:46 +01002057 char_u *varname = NULL; // init to shut up gcc
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002058 dict_T *d;
2059 dictitem_T *di;
2060
Bram Moolenaar9aed7292020-12-18 15:38:00 +01002061 // can't :unlet a script variable in Vim9 script
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002062 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002063 return FAIL;
2064
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002065 ht = find_var_ht(name, &varname);
Bram Moolenaar9aed7292020-12-18 15:38:00 +01002066
2067 // can't :unlet a script variable in Vim9 script from a function
2068 if (ht == get_script_local_ht()
2069 && SCRIPT_ID_VALID(current_sctx.sc_sid)
2070 && SCRIPT_ITEM(current_sctx.sc_sid)->sn_version
2071 == SCRIPT_VERSION_VIM9
2072 && check_vim9_unlet(name) == FAIL)
2073 return FAIL;
2074
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002075 if (ht != NULL && *varname != NUL)
2076 {
2077 d = get_current_funccal_dict(ht);
2078 if (d == NULL)
2079 {
2080 if (ht == &globvarht)
2081 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002082 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002083 d = &vimvardict;
2084 else
2085 {
2086 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
2087 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
2088 }
2089 if (d == NULL)
2090 {
2091 internal_error("do_unlet()");
2092 return FAIL;
2093 }
2094 }
2095 hi = hash_find(ht, varname);
2096 if (HASHITEM_EMPTY(hi))
2097 hi = find_hi_in_scoped_ht(name, &ht);
2098 if (hi != NULL && !HASHITEM_EMPTY(hi))
2099 {
2100 di = HI2DI(hi);
2101 if (var_check_fixed(di->di_flags, name, FALSE)
2102 || var_check_ro(di->di_flags, name, FALSE)
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002103 || value_check_lock(d->dv_lock, name, FALSE)
2104 || check_hashtab_frozen(ht, "unlet"))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002105 return FAIL;
2106
2107 delete_var(ht, hi);
2108 return OK;
2109 }
2110 }
2111 if (forceit)
2112 return OK;
Bram Moolenaare1242042021-12-16 20:56:57 +00002113 semsg(_(e_no_such_variable_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002114 return FAIL;
2115}
2116
2117/*
2118 * Lock or unlock variable indicated by "lp".
2119 * "deep" is the levels to go (-1 for unlimited);
2120 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
2121 */
2122 static int
2123do_lock_var(
2124 lval_T *lp,
2125 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002126 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002127 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002128 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002129{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002130 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002131 int ret = OK;
2132 int cc;
2133 dictitem_T *di;
2134
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002135 if (lp->ll_tv == NULL)
2136 {
2137 cc = *name_end;
2138 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002139 if (*lp->ll_name == '$')
2140 {
Bram Moolenaar3a846e62022-01-01 16:21:00 +00002141 semsg(_(e_cannot_lock_or_unlock_variable_str), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002142 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002143 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002144 else
2145 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002146 // Normal name or expanded name.
2147 di = find_var(lp->ll_name, NULL, TRUE);
2148 if (di == NULL)
Bram Moolenaar04b568b2021-11-22 21:58:41 +00002149 {
2150 if (in_vim9script())
2151 semsg(_(e_cannot_find_variable_to_unlock_str),
2152 lp->ll_name);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002153 ret = FAIL;
Bram Moolenaar04b568b2021-11-22 21:58:41 +00002154 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002155 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002156 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01002157 if ((di->di_flags & DI_FLAGS_FIX)
2158 && di->di_tv.v_type != VAR_DICT
2159 && di->di_tv.v_type != VAR_LIST)
2160 {
2161 // For historic reasons this error is not given for a list
2162 // or dict. E.g., the b: dict could be locked/unlocked.
2163 semsg(_(e_cannot_lock_or_unlock_variable_str), lp->ll_name);
2164 ret = FAIL;
2165 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002166 else
Bram Moolenaar7a411a32022-04-04 14:58:06 +01002167 {
2168 if (in_vim9script())
2169 {
2170 svar_T *sv = find_typval_in_script(&di->di_tv,
2171 0, FALSE);
2172
2173 if (sv != NULL && sv->sv_const != 0)
2174 {
2175 semsg(_(e_cannot_change_readonly_variable_str),
2176 lp->ll_name);
2177 ret = FAIL;
2178 }
2179 }
2180
2181 if (ret == OK)
2182 {
2183 if (lock)
2184 di->di_flags |= DI_FLAGS_LOCK;
2185 else
2186 di->di_flags &= ~DI_FLAGS_LOCK;
2187 if (deep != 0)
2188 item_lock(&di->di_tv, deep, lock, FALSE);
2189 }
2190 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002191 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002192 }
2193 *name_end = cc;
2194 }
Bram Moolenaara187c432020-09-16 21:08:28 +02002195 else if (deep == 0)
2196 {
2197 // nothing to do
2198 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002199 else if (lp->ll_range)
2200 {
2201 listitem_T *li = lp->ll_li;
2202
2203 // (un)lock a range of List items.
2204 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
2205 {
Bram Moolenaar021bda52020-08-17 21:07:22 +02002206 item_lock(&li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002207 li = li->li_next;
2208 ++lp->ll_n1;
2209 }
2210 }
2211 else if (lp->ll_list != NULL)
2212 // (un)lock a List item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002213 item_lock(&lp->ll_li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002214 else
2215 // (un)lock a Dictionary item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002216 item_lock(&lp->ll_di->di_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002217
2218 return ret;
2219}
2220
2221/*
2222 * Lock or unlock an item. "deep" is nr of levels to go.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002223 * When "check_refcount" is TRUE do not lock a list or dict with a reference
2224 * count larger than 1.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002225 */
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02002226 void
Bram Moolenaar021bda52020-08-17 21:07:22 +02002227item_lock(typval_T *tv, int deep, int lock, int check_refcount)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002228{
2229 static int recurse = 0;
2230 list_T *l;
2231 listitem_T *li;
2232 dict_T *d;
2233 blob_T *b;
2234 hashitem_T *hi;
2235 int todo;
2236
2237 if (recurse >= DICT_MAXNEST)
2238 {
Bram Moolenaar677658a2022-01-05 16:09:06 +00002239 emsg(_(e_variable_nested_too_deep_for_unlock));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002240 return;
2241 }
2242 if (deep == 0)
2243 return;
2244 ++recurse;
2245
2246 // lock/unlock the item itself
2247 if (lock)
2248 tv->v_lock |= VAR_LOCKED;
2249 else
2250 tv->v_lock &= ~VAR_LOCKED;
2251
2252 switch (tv->v_type)
2253 {
2254 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02002255 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002256 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002257 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002258 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002259 case VAR_STRING:
2260 case VAR_FUNC:
2261 case VAR_PARTIAL:
2262 case VAR_FLOAT:
2263 case VAR_SPECIAL:
2264 case VAR_JOB:
2265 case VAR_CHANNEL:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02002266 case VAR_INSTR:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002267 case VAR_CLASS:
2268 case VAR_OBJECT:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002269 break;
2270
2271 case VAR_BLOB:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002272 if ((b = tv->vval.v_blob) != NULL
2273 && !(check_refcount && b->bv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002274 {
2275 if (lock)
2276 b->bv_lock |= VAR_LOCKED;
2277 else
2278 b->bv_lock &= ~VAR_LOCKED;
2279 }
2280 break;
2281 case VAR_LIST:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002282 if ((l = tv->vval.v_list) != NULL
2283 && !(check_refcount && l->lv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002284 {
2285 if (lock)
2286 l->lv_lock |= VAR_LOCKED;
2287 else
2288 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar70c43d82022-01-26 21:01:15 +00002289 if (deep < 0 || deep > 1)
2290 {
2291 if (l->lv_first == &range_list_item)
2292 l->lv_lock |= VAR_ITEMS_LOCKED;
2293 else
2294 {
2295 // recursive: lock/unlock the items the List contains
2296 CHECK_LIST_MATERIALIZE(l);
2297 FOR_ALL_LIST_ITEMS(l, li) item_lock(&li->li_tv,
2298 deep - 1, lock, check_refcount);
2299 }
2300 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002301 }
2302 break;
2303 case VAR_DICT:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002304 if ((d = tv->vval.v_dict) != NULL
2305 && !(check_refcount && d->dv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002306 {
2307 if (lock)
2308 d->dv_lock |= VAR_LOCKED;
2309 else
2310 d->dv_lock &= ~VAR_LOCKED;
2311 if (deep < 0 || deep > 1)
2312 {
2313 // recursive: lock/unlock the items the List contains
2314 todo = (int)d->dv_hashtab.ht_used;
2315 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
2316 {
2317 if (!HASHITEM_EMPTY(hi))
2318 {
2319 --todo;
Bram Moolenaar021bda52020-08-17 21:07:22 +02002320 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock,
2321 check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002322 }
2323 }
2324 }
2325 }
2326 }
2327 --recurse;
2328}
2329
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002330#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
2331/*
2332 * Delete all "menutrans_" variables.
2333 */
2334 void
2335del_menutrans_vars(void)
2336{
2337 hashitem_T *hi;
2338 int todo;
2339
2340 hash_lock(&globvarht);
2341 todo = (int)globvarht.ht_used;
2342 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
2343 {
2344 if (!HASHITEM_EMPTY(hi))
2345 {
2346 --todo;
2347 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
2348 delete_var(&globvarht, hi);
2349 }
2350 }
2351 hash_unlock(&globvarht);
2352}
2353#endif
2354
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002355/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002356 * Local string buffer for the next two functions to store a variable name
2357 * with its prefix. Allocated in cat_prefix_varname(), freed later in
2358 * get_user_var_name().
2359 */
2360
2361static char_u *varnamebuf = NULL;
2362static int varnamebuflen = 0;
2363
2364/*
2365 * Function to concatenate a prefix and a variable name.
2366 */
Bram Moolenaar1bb4de52021-01-13 19:48:46 +01002367 char_u *
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002368cat_prefix_varname(int prefix, char_u *name)
2369{
2370 int len;
2371
2372 len = (int)STRLEN(name) + 3;
2373 if (len > varnamebuflen)
2374 {
2375 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002376 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002377 varnamebuf = alloc(len);
2378 if (varnamebuf == NULL)
2379 {
2380 varnamebuflen = 0;
2381 return NULL;
2382 }
2383 varnamebuflen = len;
2384 }
2385 *varnamebuf = prefix;
2386 varnamebuf[1] = ':';
2387 STRCPY(varnamebuf + 2, name);
2388 return varnamebuf;
2389}
2390
2391/*
2392 * Function given to ExpandGeneric() to obtain the list of user defined
2393 * (global/buffer/window/built-in) variable names.
2394 */
2395 char_u *
2396get_user_var_name(expand_T *xp, int idx)
2397{
2398 static long_u gdone;
2399 static long_u bdone;
2400 static long_u wdone;
2401 static long_u tdone;
2402 static int vidx;
2403 static hashitem_T *hi;
2404 hashtab_T *ht;
2405
2406 if (idx == 0)
2407 {
2408 gdone = bdone = wdone = vidx = 0;
2409 tdone = 0;
2410 }
2411
2412 // Global variables
2413 if (gdone < globvarht.ht_used)
2414 {
2415 if (gdone++ == 0)
2416 hi = globvarht.ht_array;
2417 else
2418 ++hi;
2419 while (HASHITEM_EMPTY(hi))
2420 ++hi;
2421 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
2422 return cat_prefix_varname('g', hi->hi_key);
2423 return hi->hi_key;
2424 }
2425
2426 // b: variables
Bram Moolenaar0f6e28f2022-02-20 20:49:35 +00002427 ht = &prevwin_curwin()->w_buffer->b_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002428 if (bdone < ht->ht_used)
2429 {
2430 if (bdone++ == 0)
2431 hi = ht->ht_array;
2432 else
2433 ++hi;
2434 while (HASHITEM_EMPTY(hi))
2435 ++hi;
2436 return cat_prefix_varname('b', hi->hi_key);
2437 }
2438
2439 // w: variables
Bram Moolenaar0f6e28f2022-02-20 20:49:35 +00002440 ht = &prevwin_curwin()->w_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002441 if (wdone < ht->ht_used)
2442 {
2443 if (wdone++ == 0)
2444 hi = ht->ht_array;
2445 else
2446 ++hi;
2447 while (HASHITEM_EMPTY(hi))
2448 ++hi;
2449 return cat_prefix_varname('w', hi->hi_key);
2450 }
2451
2452 // t: variables
2453 ht = &curtab->tp_vars->dv_hashtab;
2454 if (tdone < ht->ht_used)
2455 {
2456 if (tdone++ == 0)
2457 hi = ht->ht_array;
2458 else
2459 ++hi;
2460 while (HASHITEM_EMPTY(hi))
2461 ++hi;
2462 return cat_prefix_varname('t', hi->hi_key);
2463 }
2464
2465 // v: variables
2466 if (vidx < VV_LEN)
2467 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
2468
2469 VIM_CLEAR(varnamebuf);
2470 varnamebuflen = 0;
2471 return NULL;
2472}
2473
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002474 char *
2475get_var_special_name(int nr)
2476{
2477 switch (nr)
2478 {
Bram Moolenaara8b8af12021-01-01 15:11:04 +01002479 case VVAL_FALSE: return in_vim9script() ? "false" : "v:false";
2480 case VVAL_TRUE: return in_vim9script() ? "true" : "v:true";
Bram Moolenaar67977822021-01-03 21:53:53 +01002481 case VVAL_NULL: return in_vim9script() ? "null" : "v:null";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002482 case VVAL_NONE: return "v:none";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002483 }
2484 internal_error("get_var_special_name()");
2485 return "42";
2486}
2487
2488/*
2489 * Returns the global variable dictionary
2490 */
2491 dict_T *
2492get_globvar_dict(void)
2493{
2494 return &globvardict;
2495}
2496
2497/*
2498 * Returns the global variable hash table
2499 */
2500 hashtab_T *
2501get_globvar_ht(void)
2502{
2503 return &globvarht;
2504}
2505
2506/*
2507 * Returns the v: variable dictionary
2508 */
2509 dict_T *
2510get_vimvar_dict(void)
2511{
2512 return &vimvardict;
2513}
2514
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002515/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002516 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002517 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002518 */
2519 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002520find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002521{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002522 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2523 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002524
2525 if (di == NULL)
2526 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002527 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002528 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2529 return (int)(vv - vimvars);
2530}
2531
2532
2533/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002534 * Set type of v: variable to "type".
2535 */
2536 void
2537set_vim_var_type(int idx, vartype_T type)
2538{
Bram Moolenaard787e402021-12-24 21:36:12 +00002539 vimvars[idx].vv_tv_type = type;
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002540}
2541
2542/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002543 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002544 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002545 */
2546 void
2547set_vim_var_nr(int idx, varnumber_T val)
2548{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002549 vimvars[idx].vv_nr = val;
2550}
2551
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002552 char *
2553get_vim_var_name(int idx)
2554{
2555 return vimvars[idx].vv_name;
2556}
2557
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002558/*
2559 * Get typval_T v: variable value.
2560 */
2561 typval_T *
2562get_vim_var_tv(int idx)
2563{
2564 return &vimvars[idx].vv_tv;
2565}
2566
Bram Moolenaard787e402021-12-24 21:36:12 +00002567 type_T *
2568get_vim_var_type(int idx, garray_T *type_list)
2569{
2570 if (vimvars[idx].vv_type != NULL)
2571 return vimvars[idx].vv_type;
2572 return typval2type_vimvar(&vimvars[idx].vv_tv, type_list);
2573}
2574
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002575/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002576 * Set v: variable to "tv". Only accepts the same type.
2577 * Takes over the value of "tv".
2578 */
2579 int
2580set_vim_var_tv(int idx, typval_T *tv)
2581{
Bram Moolenaard787e402021-12-24 21:36:12 +00002582 if (vimvars[idx].vv_tv_type != tv->v_type)
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002583 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002584 emsg(_(e_type_mismatch_for_v_variable));
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002585 clear_tv(tv);
2586 return FAIL;
2587 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002588 // VV_RO is also checked when compiling, but let's check here as well.
2589 if (vimvars[idx].vv_flags & VV_RO)
2590 {
Bram Moolenaard8e44472021-07-21 22:20:33 +02002591 semsg(_(e_cannot_change_readonly_variable_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002592 return FAIL;
2593 }
2594 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2595 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00002596 semsg(_(e_cannot_set_variable_in_sandbox_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002597 return FAIL;
2598 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002599 clear_tv(&vimvars[idx].vv_di.di_tv);
2600 vimvars[idx].vv_di.di_tv = *tv;
2601 return OK;
2602}
2603
2604/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002605 * Get number v: variable value.
2606 */
2607 varnumber_T
2608get_vim_var_nr(int idx)
2609{
2610 return vimvars[idx].vv_nr;
2611}
2612
2613/*
2614 * Get string v: variable value. Uses a static buffer, can only be used once.
2615 * If the String variable has never been set, return an empty string.
2616 * Never returns NULL;
2617 */
2618 char_u *
2619get_vim_var_str(int idx)
2620{
2621 return tv_get_string(&vimvars[idx].vv_tv);
2622}
2623
2624/*
2625 * Get List v: variable value. Caller must take care of reference count when
2626 * needed.
2627 */
2628 list_T *
2629get_vim_var_list(int idx)
2630{
2631 return vimvars[idx].vv_list;
2632}
2633
2634/*
2635 * Get Dict v: variable value. Caller must take care of reference count when
2636 * needed.
2637 */
2638 dict_T *
2639get_vim_var_dict(int idx)
2640{
2641 return vimvars[idx].vv_dict;
2642}
2643
2644/*
2645 * Set v:char to character "c".
2646 */
2647 void
2648set_vim_var_char(int c)
2649{
2650 char_u buf[MB_MAXBYTES + 1];
2651
2652 if (has_mbyte)
2653 buf[(*mb_char2bytes)(c, buf)] = NUL;
2654 else
2655 {
2656 buf[0] = c;
2657 buf[1] = NUL;
2658 }
2659 set_vim_var_string(VV_CHAR, buf, -1);
2660}
2661
2662/*
2663 * Set v:count to "count" and v:count1 to "count1".
2664 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2665 */
2666 void
2667set_vcount(
2668 long count,
2669 long count1,
2670 int set_prevcount)
2671{
2672 if (set_prevcount)
2673 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2674 vimvars[VV_COUNT].vv_nr = count;
2675 vimvars[VV_COUNT1].vv_nr = count1;
2676}
2677
2678/*
2679 * Save variables that might be changed as a side effect. Used when executing
2680 * a timer callback.
2681 */
2682 void
2683save_vimvars(vimvars_save_T *vvsave)
2684{
2685 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2686 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2687 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2688}
2689
2690/*
2691 * Restore variables saved by save_vimvars().
2692 */
2693 void
2694restore_vimvars(vimvars_save_T *vvsave)
2695{
2696 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2697 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2698 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2699}
2700
2701/*
2702 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2703 * value.
2704 */
2705 void
2706set_vim_var_string(
2707 int idx,
2708 char_u *val,
2709 int len) // length of "val" to use or -1 (whole string)
2710{
2711 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002712 vimvars[idx].vv_tv_type = VAR_STRING;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002713 if (val == NULL)
2714 vimvars[idx].vv_str = NULL;
2715 else if (len == -1)
2716 vimvars[idx].vv_str = vim_strsave(val);
2717 else
2718 vimvars[idx].vv_str = vim_strnsave(val, len);
2719}
2720
2721/*
2722 * Set List v: variable to "val".
2723 */
2724 void
2725set_vim_var_list(int idx, list_T *val)
2726{
2727 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002728 vimvars[idx].vv_tv_type = VAR_LIST;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002729 vimvars[idx].vv_list = val;
2730 if (val != NULL)
2731 ++val->lv_refcount;
2732}
2733
2734/*
2735 * Set Dictionary v: variable to "val".
2736 */
2737 void
2738set_vim_var_dict(int idx, dict_T *val)
2739{
2740 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002741 vimvars[idx].vv_tv_type = VAR_DICT;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002742 vimvars[idx].vv_dict = val;
2743 if (val != NULL)
2744 {
2745 ++val->dv_refcount;
2746 dict_set_items_ro(val);
2747 }
2748}
2749
2750/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002751 * Set the v:argv list.
2752 */
2753 void
2754set_argv_var(char **argv, int argc)
2755{
2756 list_T *l = list_alloc();
2757 int i;
2758
2759 if (l == NULL)
2760 getout(1);
2761 l->lv_lock = VAR_FIXED;
2762 for (i = 0; i < argc; ++i)
2763 {
2764 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2765 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002766 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002767 }
2768 set_vim_var_list(VV_ARGV, l);
2769}
2770
2771/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002772 * Reset v:register, taking the 'clipboard' setting into account.
2773 */
2774 void
2775reset_reg_var(void)
2776{
2777 int regname = 0;
2778
2779 // Adjust the register according to 'clipboard', so that when
2780 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2781#ifdef FEAT_CLIPBOARD
2782 adjust_clip_reg(&regname);
2783#endif
2784 set_reg_var(regname);
2785}
2786
2787/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002788 * Set v:register if needed.
2789 */
2790 void
2791set_reg_var(int c)
2792{
2793 char_u regname;
2794
2795 if (c == 0 || c == ' ')
2796 regname = '"';
2797 else
2798 regname = c;
2799 // Avoid free/alloc when the value is already right.
2800 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2801 set_vim_var_string(VV_REG, &regname, 1);
2802}
2803
2804/*
2805 * Get or set v:exception. If "oldval" == NULL, return the current value.
2806 * Otherwise, restore the value to "oldval" and return NULL.
2807 * Must always be called in pairs to save and restore v:exception! Does not
2808 * take care of memory allocations.
2809 */
2810 char_u *
2811v_exception(char_u *oldval)
2812{
2813 if (oldval == NULL)
2814 return vimvars[VV_EXCEPTION].vv_str;
2815
2816 vimvars[VV_EXCEPTION].vv_str = oldval;
2817 return NULL;
2818}
2819
2820/*
2821 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2822 * Otherwise, restore the value to "oldval" and return NULL.
2823 * Must always be called in pairs to save and restore v:throwpoint! Does not
2824 * take care of memory allocations.
2825 */
2826 char_u *
2827v_throwpoint(char_u *oldval)
2828{
2829 if (oldval == NULL)
2830 return vimvars[VV_THROWPOINT].vv_str;
2831
2832 vimvars[VV_THROWPOINT].vv_str = oldval;
2833 return NULL;
2834}
2835
2836/*
2837 * Set v:cmdarg.
2838 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2839 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2840 * Must always be called in pairs!
2841 */
2842 char_u *
2843set_cmdarg(exarg_T *eap, char_u *oldarg)
2844{
2845 char_u *oldval;
2846 char_u *newval;
2847 unsigned len;
2848
2849 oldval = vimvars[VV_CMDARG].vv_str;
2850 if (eap == NULL)
2851 {
2852 vim_free(oldval);
2853 vimvars[VV_CMDARG].vv_str = oldarg;
2854 return NULL;
2855 }
2856
2857 if (eap->force_bin == FORCE_BIN)
2858 len = 6;
2859 else if (eap->force_bin == FORCE_NOBIN)
2860 len = 8;
2861 else
2862 len = 0;
2863
2864 if (eap->read_edit)
2865 len += 7;
2866
2867 if (eap->force_ff != 0)
2868 len += 10; // " ++ff=unix"
2869 if (eap->force_enc != 0)
2870 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2871 if (eap->bad_char != 0)
2872 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2873
2874 newval = alloc(len + 1);
2875 if (newval == NULL)
2876 return NULL;
2877
2878 if (eap->force_bin == FORCE_BIN)
2879 sprintf((char *)newval, " ++bin");
2880 else if (eap->force_bin == FORCE_NOBIN)
2881 sprintf((char *)newval, " ++nobin");
2882 else
2883 *newval = NUL;
2884
2885 if (eap->read_edit)
2886 STRCAT(newval, " ++edit");
2887
2888 if (eap->force_ff != 0)
2889 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2890 eap->force_ff == 'u' ? "unix"
2891 : eap->force_ff == 'd' ? "dos"
2892 : "mac");
2893 if (eap->force_enc != 0)
2894 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2895 eap->cmd + eap->force_enc);
2896 if (eap->bad_char == BAD_KEEP)
2897 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2898 else if (eap->bad_char == BAD_DROP)
2899 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2900 else if (eap->bad_char != 0)
2901 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2902 vimvars[VV_CMDARG].vv_str = newval;
2903 return oldval;
2904}
2905
2906/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002907 * Get the value of internal variable "name".
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002908 * If "flags" has EVAL_VAR_IMPORT may return a VAR_ANY with v_number set to the
2909 * imported script ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002910 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2911 */
2912 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002913eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002914 char_u *name,
2915 int len, // length of "name"
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002916 scid_T sid, // script ID for imported item or zero
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002917 typval_T *rettv, // NULL when only checking existence
2918 dictitem_T **dip, // non-NULL when typval's dict item is needed
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002919 int flags) // EVAL_VAR_ flags
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002920{
2921 int ret = OK;
2922 typval_T *tv = NULL;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002923 int found = FALSE;
Bram Moolenaarf055d452021-07-08 20:57:24 +02002924 hashtab_T *ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002925 int cc;
Bram Moolenaarc967d572021-07-08 21:38:50 +02002926 type_T *type = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002927
2928 // truncate the name, so that we can use strcmp()
2929 cc = name[len];
2930 name[len] = NUL;
2931
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002932 // Check for local variable when debugging.
2933 if ((tv = lookup_debug_var(name)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002934 {
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002935 // Check for user-defined variables.
Bram Moolenaarc967d572021-07-08 21:38:50 +02002936 dictitem_T *v = find_var(name, &ht, flags & EVAL_VAR_NOAUTOLOAD);
2937
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002938 if (v != NULL)
2939 {
2940 tv = &v->di_tv;
2941 if (dip != NULL)
2942 *dip = v;
2943 }
Bram Moolenaarc967d572021-07-08 21:38:50 +02002944 else
2945 ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002946 }
2947
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002948 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002949 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002950 imported_T *import = NULL;
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002951 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
2952
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002953 if (sid == 0)
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00002954 import = find_imported(p, 0, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002955
2956 // imported variable from another script
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002957 if (import != NULL || sid != 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002958 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002959 if ((flags & EVAL_VAR_IMPORT) == 0)
Bram Moolenaarc620c052020-07-08 15:16:19 +02002960 {
Bram Moolenaar71f21932022-01-07 18:20:55 +00002961 if (SCRIPT_ID_VALID(sid))
Bram Moolenaarc620c052020-07-08 15:16:19 +02002962 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002963 ht = &SCRIPT_VARS(sid);
2964 if (ht != NULL)
2965 {
2966 dictitem_T *v = find_var_in_ht(ht, 0, name,
2967 flags & EVAL_VAR_NOAUTOLOAD);
2968
2969 if (v != NULL)
2970 {
2971 tv = &v->di_tv;
2972 if (dip != NULL)
2973 *dip = v;
2974 }
2975 else
2976 ht = NULL;
2977 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002978 }
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002979 else
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002980 {
2981 if (flags & EVAL_VAR_VERBOSE)
Bram Moolenaardd5893b2022-01-20 21:32:54 +00002982 semsg(_(e_expected_dot_after_name_str), name);
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002983 ret = FAIL;
2984 }
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002985 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002986 else
2987 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002988 if (rettv != NULL)
2989 {
Bram Moolenaar753885b2022-08-24 16:30:36 +01002990 // special value that is used in handle_subscript()
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002991 rettv->v_type = VAR_ANY;
2992 rettv->vval.v_number = sid != 0 ? sid : import->imp_sid;
2993 }
2994 found = TRUE;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002995 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002996 }
Bram Moolenaar052ff292021-12-11 13:54:46 +00002997 else if (in_vim9script() && (flags & EVAL_VAR_NO_FUNC) == 0)
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002998 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002999 int has_g_prefix = STRNCMP(name, "g:", 2) == 0;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003000 ufunc_T *ufunc = find_func(name, FALSE);
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003001
Bram Moolenaarb033ee22021-08-15 16:08:36 +02003002 // In Vim9 script we can get a function reference by using the
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003003 // function name. For a global non-autoload function "g:" is
3004 // required.
3005 if (ufunc != NULL && (has_g_prefix
3006 || !func_requires_g_prefix(ufunc)))
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003007 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003008 found = TRUE;
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003009 if (rettv != NULL)
3010 {
3011 rettv->v_type = VAR_FUNC;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003012 if (has_g_prefix)
Bram Moolenaaref082e12021-12-12 21:02:03 +00003013 // Keep the "g:", otherwise script-local may be
3014 // assumed.
3015 rettv->vval.v_string = vim_strsave(name);
3016 else
3017 rettv->vval.v_string = vim_strsave(ufunc->uf_name);
Bram Moolenaarb033ee22021-08-15 16:08:36 +02003018 if (rettv->vval.v_string != NULL)
3019 func_ref(ufunc->uf_name);
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003020 }
3021 }
3022 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003023 }
3024
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003025 if (!found)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003026 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02003027 if (tv == NULL)
3028 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003029 if (rettv != NULL && (flags & EVAL_VAR_VERBOSE))
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003030 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarc620c052020-07-08 15:16:19 +02003031 ret = FAIL;
3032 }
3033 else if (rettv != NULL)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003034 {
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003035 svar_T *sv = NULL;
3036 int was_assigned = FALSE;
3037
Bram Moolenaar11005b02021-07-11 20:59:00 +02003038 if (ht != NULL && ht == get_script_local_ht()
3039 && tv != &SCRIPT_SV(current_sctx.sc_sid)->sv_var.di_tv)
Bram Moolenaarf055d452021-07-08 20:57:24 +02003040 {
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003041 sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaarf055d452021-07-08 20:57:24 +02003042 if (sv != NULL)
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003043 {
Bram Moolenaarf055d452021-07-08 20:57:24 +02003044 type = sv->sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003045 was_assigned = sv->sv_flags & SVFLAG_ASSIGNED;
3046 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003047 }
3048
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003049 // If a list or dict variable wasn't initialized and has meaningful
3050 // type, do it now. Not for global variables, they are not
3051 // declared.
Bram Moolenaar7a222242022-03-01 19:23:24 +00003052 if (ht != &globvarht)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003053 {
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003054 if (tv->v_type == VAR_DICT && tv->vval.v_dict == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003055 && ((type != NULL && !was_assigned)
Bram Moolenaar859cc212022-03-28 15:22:35 +01003056 || !in_vim9script()))
Bram Moolenaarf055d452021-07-08 20:57:24 +02003057 {
Bram Moolenaar7a222242022-03-01 19:23:24 +00003058 tv->vval.v_dict = dict_alloc();
3059 if (tv->vval.v_dict != NULL)
3060 {
3061 ++tv->vval.v_dict->dv_refcount;
3062 tv->vval.v_dict->dv_type = alloc_type(type);
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003063 if (sv != NULL)
3064 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar7a222242022-03-01 19:23:24 +00003065 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003066 }
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003067 else if (tv->v_type == VAR_LIST && tv->vval.v_list == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003068 && ((type != NULL && !was_assigned)
Bram Moolenaar501f9782022-03-27 16:51:04 +01003069 || !in_vim9script()))
Bram Moolenaarf055d452021-07-08 20:57:24 +02003070 {
Bram Moolenaar7a222242022-03-01 19:23:24 +00003071 tv->vval.v_list = list_alloc();
3072 if (tv->vval.v_list != NULL)
3073 {
3074 ++tv->vval.v_list->lv_refcount;
3075 tv->vval.v_list->lv_type = alloc_type(type);
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003076 if (sv != NULL)
3077 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar7a222242022-03-01 19:23:24 +00003078 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003079 }
Bram Moolenaar859cc212022-03-28 15:22:35 +01003080 else if (tv->v_type == VAR_BLOB && tv->vval.v_blob == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003081 && ((type != NULL && !was_assigned)
Bram Moolenaar859cc212022-03-28 15:22:35 +01003082 || !in_vim9script()))
3083 {
3084 tv->vval.v_blob = blob_alloc();
3085 if (tv->vval.v_blob != NULL)
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003086 {
Bram Moolenaar859cc212022-03-28 15:22:35 +01003087 ++tv->vval.v_blob->bv_refcount;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003088 if (sv != NULL)
3089 sv->sv_flags |= SVFLAG_ASSIGNED;
3090 }
Bram Moolenaar859cc212022-03-28 15:22:35 +01003091 }
Bram Moolenaarb7c21af2021-04-18 14:12:31 +02003092 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02003093 copy_tv(tv, rettv);
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003094 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003095 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003096
3097 name[len] = cc;
3098
3099 return ret;
3100}
3101
3102/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003103 * Check if variable "name[len]" is a local variable or an argument.
3104 * If so, "*eval_lavars_used" is set to TRUE.
3105 */
3106 void
3107check_vars(char_u *name, int len)
3108{
3109 int cc;
3110 char_u *varname;
3111 hashtab_T *ht;
3112
3113 if (eval_lavars_used == NULL)
3114 return;
3115
3116 // truncate the name, so that we can use strcmp()
3117 cc = name[len];
3118 name[len] = NUL;
3119
3120 ht = find_var_ht(name, &varname);
3121 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
3122 {
3123 if (find_var(name, NULL, TRUE) != NULL)
3124 *eval_lavars_used = TRUE;
3125 }
3126
3127 name[len] = cc;
3128}
3129
3130/*
3131 * Find variable "name" in the list of variables.
3132 * Return a pointer to it if found, NULL if not found.
3133 * Careful: "a:0" variables don't have a name.
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003134 * When "htp" is not NULL set "htp" to the hashtab_T used.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003135 */
3136 dictitem_T *
3137find_var(char_u *name, hashtab_T **htp, int no_autoload)
3138{
3139 char_u *varname;
3140 hashtab_T *ht;
3141 dictitem_T *ret = NULL;
3142
3143 ht = find_var_ht(name, &varname);
3144 if (htp != NULL)
3145 *htp = ht;
3146 if (ht == NULL)
3147 return NULL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003148 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003149 if (ret != NULL)
3150 return ret;
3151
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003152 // Search in parent scope for lambda
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003153 ret = find_var_in_scoped_ht(name, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003154 if (ret != NULL)
3155 return ret;
3156
3157 // in Vim9 script items without a scope can be script-local
3158 if (in_vim9script() && name[0] != NUL && name[1] != ':')
3159 {
3160 ht = get_script_local_ht();
3161 if (ht != NULL)
3162 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003163 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003164 if (ret != NULL)
3165 {
3166 if (htp != NULL)
3167 *htp = ht;
3168 return ret;
3169 }
3170 }
3171 }
3172
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003173 // When using "vim9script autoload" script-local items are prefixed but can
3174 // be used with s:name.
3175 if (SCRIPT_ID_VALID(current_sctx.sc_sid)
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01003176 && (in_vim9script() || (name[0] == 's' && name[1] == ':')))
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003177 {
3178 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
3179
3180 if (si->sn_autoload_prefix != NULL)
3181 {
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01003182 char_u *base_name = (name[0] == 's' && name[1] == ':')
3183 ? name + 2 : name;
3184 char_u *auto_name = concat_str(si->sn_autoload_prefix, base_name);
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003185
3186 if (auto_name != NULL)
3187 {
3188 ht = &globvarht;
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01003189 ret = find_var_in_ht(ht, 'g', auto_name, TRUE);
Bram Moolenaar130f65d2022-01-13 20:39:41 +00003190 vim_free(auto_name);
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003191 if (ret != NULL)
3192 {
3193 if (htp != NULL)
3194 *htp = ht;
3195 return ret;
3196 }
3197 }
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003198 }
3199 }
3200
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003201 return NULL;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003202}
3203
3204/*
Bram Moolenaar71f21932022-01-07 18:20:55 +00003205 * Like find_var() but if the name starts with <SNR>99_ then look in the
3206 * referenced script (used for a funcref).
3207 */
3208 dictitem_T *
3209find_var_also_in_script(char_u *name, hashtab_T **htp, int no_autoload)
3210{
3211 if (STRNCMP(name, "<SNR>", 5) == 0 && isdigit(name[5]))
3212 {
3213 char_u *p = name + 5;
3214 int sid = getdigits(&p);
3215
3216 if (SCRIPT_ID_VALID(sid) && *p == '_')
3217 {
3218 hashtab_T *ht = &SCRIPT_VARS(sid);
3219
3220 if (ht != NULL)
3221 {
3222 dictitem_T *di = find_var_in_ht(ht, 0, p + 1, no_autoload);
3223
3224 if (di != NULL)
Bram Moolenaaraa9b3ca2022-01-08 15:44:22 +00003225 {
3226 if (htp != NULL)
3227 *htp = ht;
Bram Moolenaar71f21932022-01-07 18:20:55 +00003228 return di;
Bram Moolenaaraa9b3ca2022-01-08 15:44:22 +00003229 }
Bram Moolenaar71f21932022-01-07 18:20:55 +00003230 }
3231 }
3232 }
3233
3234 return find_var(name, htp, no_autoload);
3235}
3236
3237/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003238 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02003239 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003240 * Returns NULL if not found.
3241 */
3242 dictitem_T *
3243find_var_in_ht(
3244 hashtab_T *ht,
3245 int htname,
3246 char_u *varname,
3247 int no_autoload)
3248{
3249 hashitem_T *hi;
3250
3251 if (*varname == NUL)
3252 {
3253 // Must be something like "s:", otherwise "ht" would be NULL.
3254 switch (htname)
3255 {
3256 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
3257 case 'g': return &globvars_var;
3258 case 'v': return &vimvars_var;
3259 case 'b': return &curbuf->b_bufvar;
3260 case 'w': return &curwin->w_winvar;
3261 case 't': return &curtab->tp_winvar;
3262 case 'l': return get_funccal_local_var();
3263 case 'a': return get_funccal_args_var();
3264 }
3265 return NULL;
3266 }
3267
3268 hi = hash_find(ht, varname);
3269 if (HASHITEM_EMPTY(hi))
3270 {
3271 // For global variables we may try auto-loading the script. If it
3272 // worked find the variable again. Don't auto-load a script if it was
3273 // loaded already, otherwise it would be loaded every time when
3274 // checking if a function name is a Funcref variable.
3275 if (ht == &globvarht && !no_autoload)
3276 {
3277 // Note: script_autoload() may make "hi" invalid. It must either
3278 // be obtained again or not used.
3279 if (!script_autoload(varname, FALSE) || aborting())
3280 return NULL;
3281 hi = hash_find(ht, varname);
3282 }
3283 if (HASHITEM_EMPTY(hi))
3284 return NULL;
3285 }
3286 return HI2DI(hi);
3287}
3288
3289/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003290 * Get the script-local hashtab. NULL if not in a script context.
3291 */
Bram Moolenaar922acbd2020-10-08 21:30:40 +02003292 hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003293get_script_local_ht(void)
3294{
3295 scid_T sid = current_sctx.sc_sid;
3296
Bram Moolenaare3d46852020-08-29 13:39:17 +02003297 if (SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003298 return &SCRIPT_VARS(sid);
3299 return NULL;
3300}
3301
3302/*
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003303 * Look for "name[len]" in script-local variables and functions.
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003304 * When "cmd" is TRUE it must look like a command, a function must be followed
3305 * by "(" or "->".
Bram Moolenaar709664c2020-12-12 14:33:41 +01003306 * Return OK when found, FAIL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003307 */
Bram Moolenaar709664c2020-12-12 14:33:41 +01003308 int
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003309lookup_scriptitem(
Bram Moolenaar709664c2020-12-12 14:33:41 +01003310 char_u *name,
3311 size_t len,
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003312 int cmd,
Bram Moolenaar709664c2020-12-12 14:33:41 +01003313 cctx_T *dummy UNUSED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003314{
3315 hashtab_T *ht = get_script_local_ht();
3316 char_u buffer[30];
3317 char_u *p;
Bram Moolenaar709664c2020-12-12 14:33:41 +01003318 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003319 hashitem_T *hi;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003320 int is_global = FALSE;
3321 char_u *fname = name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003322
3323 if (ht == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003324 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003325 if (len < sizeof(buffer) - 1)
3326 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02003327 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003328 vim_strncpy(buffer, name, len);
3329 p = buffer;
3330 }
3331 else
3332 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003333 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003334 if (p == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003335 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003336 }
3337
3338 hi = hash_find(ht, p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01003339 res = HASHITEM_EMPTY(hi) ? FAIL : OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003340
3341 // if not script-local, then perhaps imported
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003342 if (res == FAIL && find_imported(p, 0, FALSE) != NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003343 res = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003344 if (p != buffer)
3345 vim_free(p);
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003346
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003347 // Find a function, so that a following "->" works.
3348 // When used as a command require "(" or "->" to follow, "Cmd" is a user
3349 // command while "Cmd()" is a function call.
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003350 if (res != OK)
3351 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003352 p = skipwhite(name + len);
3353
3354 if (!cmd || name[len] == '(' || (p[0] == '-' && p[1] == '>'))
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003355 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003356 // Do not check for an internal function, since it might also be a
3357 // valid command, such as ":split" versus "split()".
3358 // Skip "g:" before a function name.
3359 if (name[0] == 'g' && name[1] == ':')
3360 {
3361 is_global = TRUE;
3362 fname = name + 2;
3363 }
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003364 if (find_func(fname, is_global) != NULL)
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003365 res = OK;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003366 }
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003367 }
3368
Bram Moolenaar709664c2020-12-12 14:33:41 +01003369 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003370}
3371
3372/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003373 * Find the hashtab used for a variable name.
3374 * Return NULL if the name is not valid.
3375 * Set "varname" to the start of name without ':'.
3376 */
3377 hashtab_T *
3378find_var_ht(char_u *name, char_u **varname)
3379{
3380 hashitem_T *hi;
3381 hashtab_T *ht;
3382
3383 if (name[0] == NUL)
3384 return NULL;
3385 if (name[1] != ':')
3386 {
3387 // The name must not start with a colon or #.
3388 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
3389 return NULL;
3390 *varname = name;
3391
3392 // "version" is "v:version" in all scopes if scriptversion < 3.
3393 // Same for a few other variables marked with VV_COMPAT.
Bram Moolenaardd9de502021-08-15 13:49:42 +02003394 if (in_old_script(3))
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003395 {
3396 hi = hash_find(&compat_hashtab, name);
3397 if (!HASHITEM_EMPTY(hi))
3398 return &compat_hashtab;
3399 }
3400
3401 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003402 if (ht != NULL)
3403 return ht; // local variable
3404
Bram Moolenaarf0a40692021-06-11 22:05:47 +02003405 // In Vim9 script items at the script level are script-local, except
3406 // for autoload names.
3407 if (in_vim9script() && vim_strchr(name, AUTOLOAD_CHAR) == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003408 {
3409 ht = get_script_local_ht();
3410 if (ht != NULL)
3411 return ht;
3412 }
3413
3414 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003415 }
3416 *varname = name + 2;
3417 if (*name == 'g') // global variable
3418 return &globvarht;
3419 // There must be no ':' or '#' in the rest of the name, unless g: is used
3420 if (vim_strchr(name + 2, ':') != NULL
3421 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
3422 return NULL;
3423 if (*name == 'b') // buffer variable
3424 return &curbuf->b_vars->dv_hashtab;
3425 if (*name == 'w') // window variable
3426 return &curwin->w_vars->dv_hashtab;
3427 if (*name == 't') // tab page variable
3428 return &curtab->tp_vars->dv_hashtab;
3429 if (*name == 'v') // v: variable
3430 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01003431 if (get_current_funccal() != NULL
Bram Moolenaarca16c602022-09-06 18:57:08 +01003432 && get_current_funccal()->fc_func->uf_def_status
3433 == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003434 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01003435 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003436 if (*name == 'a') // a: function argument
3437 return get_funccal_args_ht();
3438 if (*name == 'l') // l: local function variable
3439 return get_funccal_local_ht();
3440 }
3441 if (*name == 's') // script variable
3442 {
3443 ht = get_script_local_ht();
3444 if (ht != NULL)
3445 return ht;
3446 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003447 return NULL;
3448}
3449
3450/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003451 * Get the string value of a (global/local) variable.
3452 * Note: see tv_get_string() for how long the pointer remains valid.
3453 * Returns NULL when it doesn't exist.
3454 */
3455 char_u *
3456get_var_value(char_u *name)
3457{
3458 dictitem_T *v;
3459
3460 v = find_var(name, NULL, FALSE);
3461 if (v == NULL)
3462 return NULL;
3463 return tv_get_string(&v->di_tv);
3464}
3465
3466/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003467 * Allocate a new hashtab for a sourced script. It will be used while
3468 * sourcing this script and when executing functions defined in the script.
3469 */
3470 void
3471new_script_vars(scid_T id)
3472{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003473 scriptvar_T *sv;
3474
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01003475 sv = ALLOC_CLEAR_ONE(scriptvar_T);
3476 if (sv == NULL)
3477 return;
3478 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01003479 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003480}
3481
3482/*
3483 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
3484 * point to it.
3485 */
3486 void
3487init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
3488{
3489 hash_init(&dict->dv_hashtab);
3490 dict->dv_lock = 0;
3491 dict->dv_scope = scope;
3492 dict->dv_refcount = DO_NOT_FREE_CNT;
3493 dict->dv_copyID = 0;
3494 dict_var->di_tv.vval.v_dict = dict;
3495 dict_var->di_tv.v_type = VAR_DICT;
3496 dict_var->di_tv.v_lock = VAR_FIXED;
3497 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
3498 dict_var->di_key[0] = NUL;
3499}
3500
3501/*
3502 * Unreference a dictionary initialized by init_var_dict().
3503 */
3504 void
3505unref_var_dict(dict_T *dict)
3506{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003507 // Now the dict needs to be freed if no one else is using it, go back to
3508 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003509 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
3510 dict_unref(dict);
3511}
3512
3513/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003514 * Clean up a list of internal variables.
3515 * Frees all allocated variables and the value they contain.
3516 * Clears hashtab "ht", does not free it.
3517 */
3518 void
3519vars_clear(hashtab_T *ht)
3520{
3521 vars_clear_ext(ht, TRUE);
3522}
3523
3524/*
3525 * Like vars_clear(), but only free the value if "free_val" is TRUE.
3526 */
3527 void
3528vars_clear_ext(hashtab_T *ht, int free_val)
3529{
3530 int todo;
3531 hashitem_T *hi;
3532 dictitem_T *v;
3533
3534 hash_lock(ht);
3535 todo = (int)ht->ht_used;
3536 for (hi = ht->ht_array; todo > 0; ++hi)
3537 {
3538 if (!HASHITEM_EMPTY(hi))
3539 {
3540 --todo;
3541
3542 // Free the variable. Don't remove it from the hashtab,
3543 // ht_array might change then. hash_clear() takes care of it
3544 // later.
3545 v = HI2DI(hi);
3546 if (free_val)
3547 clear_tv(&v->di_tv);
3548 if (v->di_flags & DI_FLAGS_ALLOC)
3549 vim_free(v);
3550 }
3551 }
3552 hash_clear(ht);
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003553 hash_init(ht);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003554}
3555
3556/*
3557 * Delete a variable from hashtab "ht" at item "hi".
3558 * Clear the variable value and free the dictitem.
3559 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02003560 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003561delete_var(hashtab_T *ht, hashitem_T *hi)
3562{
3563 dictitem_T *di = HI2DI(hi);
3564
Bram Moolenaaref2c3252022-11-25 16:31:51 +00003565 if (hash_remove(ht, hi, "delete variable") == OK)
3566 {
3567 clear_tv(&di->di_tv);
3568 vim_free(di);
3569 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003570}
3571
3572/*
3573 * List the value of one internal variable.
3574 */
3575 static void
3576list_one_var(dictitem_T *v, char *prefix, int *first)
3577{
3578 char_u *tofree;
3579 char_u *s;
3580 char_u numbuf[NUMBUFLEN];
3581
3582 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
3583 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
3584 s == NULL ? (char_u *)"" : s, first);
3585 vim_free(tofree);
3586}
3587
3588 static void
3589list_one_var_a(
3590 char *prefix,
3591 char_u *name,
3592 int type,
3593 char_u *string,
3594 int *first) // when TRUE clear rest of screen and set to FALSE
3595{
3596 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
3597 msg_start();
3598 msg_puts(prefix);
3599 if (name != NULL) // "a:" vars don't have a name stored
3600 msg_puts((char *)name);
3601 msg_putchar(' ');
3602 msg_advance(22);
3603 if (type == VAR_NUMBER)
3604 msg_putchar('#');
3605 else if (type == VAR_FUNC || type == VAR_PARTIAL)
3606 msg_putchar('*');
3607 else if (type == VAR_LIST)
3608 {
3609 msg_putchar('[');
3610 if (*string == '[')
3611 ++string;
3612 }
3613 else if (type == VAR_DICT)
3614 {
3615 msg_putchar('{');
3616 if (*string == '{')
3617 ++string;
3618 }
3619 else
3620 msg_putchar(' ');
3621
3622 msg_outtrans(string);
3623
3624 if (type == VAR_FUNC || type == VAR_PARTIAL)
3625 msg_puts("()");
3626 if (*first)
3627 {
3628 msg_clr_eos();
3629 *first = FALSE;
3630 }
3631}
3632
3633/*
3634 * Set variable "name" to value in "tv".
3635 * If the variable already exists, the value is updated.
3636 * Otherwise the variable is created.
3637 */
3638 void
3639set_var(
3640 char_u *name,
3641 typval_T *tv,
3642 int copy) // make copy of value in "tv"
3643{
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003644 set_var_const(name, 0, NULL, tv, copy, ASSIGN_DECL, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003645}
3646
3647/*
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003648 * Set variable "name" to value in "tv_arg".
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003649 * When "sid" is non-zero "name" is in the script with this ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003650 * If the variable already exists and "is_const" is FALSE the value is updated.
3651 * Otherwise the variable is created.
3652 */
3653 void
3654set_var_const(
3655 char_u *name,
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003656 scid_T sid,
Bram Moolenaar7824fc82021-11-26 17:36:51 +00003657 type_T *type_arg,
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003658 typval_T *tv_arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003659 int copy, // make copy of value in "tv"
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003660 int flags_arg, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003661 int var_idx) // index for ":let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003662{
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003663 typval_T *tv = tv_arg;
Bram Moolenaar7824fc82021-11-26 17:36:51 +00003664 type_T *type = type_arg;
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003665 typval_T bool_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003666 dictitem_T *di;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003667 typval_T *dest_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003668 char_u *varname;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003669 char_u *name_tofree = NULL;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003670 hashtab_T *ht = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003671 int is_script_local;
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003672 int vim9script = in_vim9script();
Bram Moolenaare535db82021-03-31 21:07:24 +02003673 int var_in_vim9script;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003674 int var_in_autoload = FALSE;
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003675 int flags = flags_arg;
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003676 int free_tv_arg = !copy; // free tv_arg if not used
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003677
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003678 if (sid != 0)
3679 {
3680 if (SCRIPT_ID_VALID(sid))
3681 ht = &SCRIPT_VARS(sid);
3682 varname = name;
3683 }
3684 else
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003685 {
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003686 scriptitem_T *si;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003687
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003688 if (in_vim9script() && is_export
3689 && SCRIPT_ID_VALID(current_sctx.sc_sid)
3690 && (si = SCRIPT_ITEM(current_sctx.sc_sid))
Bram Moolenaar0e1574c2022-03-03 17:05:35 +00003691 ->sn_autoload_prefix != NULL)
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003692 {
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003693 // In a vim9 autoload script an exported variable is put in the
3694 // global namespace with the autoload prefix.
3695 var_in_autoload = TRUE;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003696 varname = concat_str(si->sn_autoload_prefix, name);
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003697 if (varname == NULL)
3698 goto failed;
3699 name_tofree = varname;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003700 ht = &globvarht;
3701 }
3702 else
3703 ht = find_var_ht(name, &varname);
3704 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003705 if (ht == NULL || *varname == NUL)
3706 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003707 semsg(_(e_illegal_variable_name_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003708 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003709 }
Bram Moolenaar54969f42022-02-07 13:56:44 +00003710 is_script_local = ht == get_script_local_ht() || sid != 0
3711 || var_in_autoload;
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003712
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003713 if (vim9script
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003714 && !is_script_local
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003715 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003716 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003717 && name[1] == ':')
Bram Moolenaar67979662020-06-20 22:50:47 +02003718 {
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003719 vim9_declare_error(name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003720 goto failed;
Bram Moolenaar67979662020-06-20 22:50:47 +02003721 }
Bram Moolenaar9510d222022-09-11 15:14:05 +01003722 if ((flags & ASSIGN_FOR_LOOP) && is_scoped_variable(name))
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003723 // Do not make g:var, w:var, b:var or t:var final.
3724 flags &= ~ASSIGN_FINAL;
3725
Bram Moolenaare535db82021-03-31 21:07:24 +02003726 var_in_vim9script = is_script_local && current_script_is_vim9();
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003727 if (var_in_vim9script && name[0] == '_' && name[1] == NUL)
3728 {
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02003729 // For "[a, _] = list" the underscore is ignored.
3730 if ((flags & ASSIGN_UNPACK) == 0)
3731 emsg(_(e_cannot_use_underscore_here));
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003732 goto failed;
3733 }
Bram Moolenaar67979662020-06-20 22:50:47 +02003734
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003735 di = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003736
Bram Moolenaar24e93162021-07-18 20:40:33 +02003737 if (di == NULL && var_in_vim9script)
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003738 {
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003739 imported_T *import = find_imported(varname, 0, FALSE);
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003740
Bram Moolenaar24e93162021-07-18 20:40:33 +02003741 if (import != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003742 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003743 // imported name space cannot be used
Bram Moolenaar24e93162021-07-18 20:40:33 +02003744 if ((flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003745 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003746 semsg(_(e_redefining_imported_item_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003747 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003748 }
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003749 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
3750 goto failed;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003751 }
Bram Moolenaar75e27d72022-02-13 13:56:29 +00003752 if (!in_vim9script())
3753 {
3754 semsg(_(e_cannot_create_vim9_script_variable_in_function_str),
3755 name);
3756 goto failed;
3757 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003758 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003759
Bram Moolenaar993faa32022-02-21 15:59:11 +00003760 // Search in parent scope which is possible to reference from lambda
3761 if (di == NULL)
3762 di = find_var_in_scoped_ht(name, TRUE);
3763
3764 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
3765 && var_wrong_func_name(name, di == NULL))
3766 goto failed;
3767
3768 if (need_convert_to_bool(type, tv))
Bram Moolenaar24e93162021-07-18 20:40:33 +02003769 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003770 // Destination is a bool and the value is not, but it can be
3771 // converted.
3772 CLEAR_FIELD(bool_tv);
3773 bool_tv.v_type = VAR_BOOL;
3774 bool_tv.vval.v_number = tv2bool(tv) ? VVAL_TRUE : VVAL_FALSE;
3775 tv = &bool_tv;
3776 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003777
Bram Moolenaar993faa32022-02-21 15:59:11 +00003778 if (di != NULL)
3779 {
3780 // Item already exists. Allowed to replace when reloading.
3781 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003782 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003783 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
3784 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003785 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003786 emsg(_(e_cannot_modify_existing_variable));
3787 goto failed;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003788 }
3789
Bram Moolenaar993faa32022-02-21 15:59:11 +00003790 if (is_script_local && vim9script
3791 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0)
Bram Moolenaar12be7342021-03-31 21:47:33 +02003792 {
3793 semsg(_(e_redefining_script_item_str), name);
3794 goto failed;
3795 }
3796
Bram Moolenaar993faa32022-02-21 15:59:11 +00003797 if (var_in_vim9script && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003798 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003799 where_T where = WHERE_INIT;
Bram Moolenaar7a411a32022-04-04 14:58:06 +01003800 svar_T *sv = find_typval_in_script(&di->di_tv, sid, TRUE);
Bram Moolenaar993faa32022-02-21 15:59:11 +00003801
3802 if (sv != NULL)
3803 {
3804 // check the type and adjust to bool if needed
3805 where.wt_index = var_idx;
3806 where.wt_variable = TRUE;
3807 if (check_script_var_type(sv, tv, name, where) == FAIL)
3808 goto failed;
3809 if (type == NULL)
3810 type = sv->sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003811 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003812 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003813 }
3814
Bram Moolenaar993faa32022-02-21 15:59:11 +00003815 if ((flags & ASSIGN_FOR_LOOP) == 0
3816 && var_check_permission(di, name) == FAIL)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003817 goto failed;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003818 }
3819 else
3820 {
3821 // can only redefine once
3822 di->di_flags &= ~DI_FLAGS_RELOAD;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003823
Bram Moolenaar993faa32022-02-21 15:59:11 +00003824 // A Vim9 script-local variable is also present in sn_all_vars
3825 // and sn_var_vals. It may set "type" from "tv".
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003826 if (var_in_vim9script || var_in_autoload)
Bram Moolenaar993faa32022-02-21 15:59:11 +00003827 update_vim9_script_var(FALSE, di,
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003828 var_in_autoload ? name : di->di_key, flags,
Bram Moolenaar993faa32022-02-21 15:59:11 +00003829 tv, &type, (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003830 }
3831
Bram Moolenaar993faa32022-02-21 15:59:11 +00003832 // existing variable, need to clear the value
3833
3834 // Handle setting internal di: variables separately where needed to
3835 // prevent changing the type.
3836 if (ht == &vimvarht)
3837 {
3838 if (di->di_tv.v_type == VAR_STRING)
3839 {
3840 VIM_CLEAR(di->di_tv.vval.v_string);
3841 if (copy || tv->v_type != VAR_STRING)
3842 {
3843 char_u *val = tv_get_string(tv);
3844
3845 // Careful: when assigning to v:errmsg and
3846 // tv_get_string() causes an error message the variable
3847 // will already be set.
3848 if (di->di_tv.vval.v_string == NULL)
3849 di->di_tv.vval.v_string = vim_strsave(val);
3850 }
3851 else
3852 {
3853 // Take over the string to avoid an extra alloc/free.
3854 di->di_tv.vval.v_string = tv->vval.v_string;
3855 tv->vval.v_string = NULL;
3856 }
3857 goto failed;
3858 }
3859 else if (di->di_tv.v_type == VAR_NUMBER)
3860 {
3861 di->di_tv.vval.v_number = tv_get_number(tv);
3862 if (STRCMP(varname, "searchforward") == 0)
3863 set_search_direction(di->di_tv.vval.v_number
3864 ? '/' : '?');
3865#ifdef FEAT_SEARCH_EXTRA
3866 else if (STRCMP(varname, "hlsearch") == 0)
3867 {
3868 no_hlsearch = !di->di_tv.vval.v_number;
Bram Moolenaara4d158b2022-08-14 14:17:45 +01003869 redraw_all_later(UPD_SOME_VALID);
Bram Moolenaar993faa32022-02-21 15:59:11 +00003870 }
3871#endif
3872 goto failed;
3873 }
3874 else if (di->di_tv.v_type != tv->v_type)
3875 {
3876 semsg(_(e_setting_str_to_value_with_wrong_type), name);
3877 goto failed;
3878 }
3879 }
3880
3881 clear_tv(&di->di_tv);
Bram Moolenaar766ae5b2022-09-14 00:30:51 +01003882
3883 if ((flags & ASSIGN_UPDATE_BLOCK_ID)
3884 && SCRIPT_ID_VALID(current_sctx.sc_sid))
3885 {
3886 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
3887
3888 update_script_var_block_id(name, si->sn_current_block_id);
3889 }
Bram Moolenaar993faa32022-02-21 15:59:11 +00003890 }
3891 else
3892 {
3893 // Item not found, check if a function already exists.
3894 if (is_script_local && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
3895 && lookup_scriptitem(name, STRLEN(name), FALSE, NULL) == OK)
3896 {
3897 semsg(_(e_redefining_script_item_str), name);
3898 goto failed;
3899 }
3900
3901 // add a new variable
3902 if (var_in_vim9script && (flags & ASSIGN_NO_DECL))
3903 {
3904 semsg(_(e_unknown_variable_str), name);
3905 goto failed;
3906 }
3907
Bram Moolenaaref2c3252022-11-25 16:31:51 +00003908 if (check_hashtab_frozen(ht, "add variable"))
3909 goto failed;
3910
Bram Moolenaar993faa32022-02-21 15:59:11 +00003911 // Can't add "v:" or "a:" variable.
3912 if (ht == &vimvarht || ht == get_funccal_args_ht())
3913 {
3914 semsg(_(e_illegal_variable_name_str), name);
3915 goto failed;
3916 }
3917
3918 // Make sure the variable name is valid. In Vim9 script an
3919 // autoload variable must be prefixed with "g:" unless in an
3920 // autoload script.
3921 if (!valid_varname(varname, -1, !vim9script
3922 || STRNCMP(name, "g:", 2) == 0 || var_in_autoload))
3923 goto failed;
3924
3925 di = alloc(sizeof(dictitem_T) + STRLEN(varname));
3926 if (di == NULL)
3927 goto failed;
3928 STRCPY(di->di_key, varname);
Bram Moolenaaref2c3252022-11-25 16:31:51 +00003929 if (hash_add(ht, DI2HIKEY(di), "add variable") == FAIL)
Bram Moolenaar993faa32022-02-21 15:59:11 +00003930 {
3931 vim_free(di);
3932 goto failed;
3933 }
3934 di->di_flags = DI_FLAGS_ALLOC;
3935 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
3936 di->di_flags |= DI_FLAGS_LOCK;
3937
3938 // A Vim9 script-local variable is also added to sn_all_vars and
3939 // sn_var_vals. It may set "type" from "tv".
3940 if (var_in_vim9script || var_in_autoload)
3941 update_vim9_script_var(TRUE, di,
3942 var_in_autoload ? name : di->di_key, flags,
3943 tv, &type, (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003944 }
3945
Bram Moolenaar993faa32022-02-21 15:59:11 +00003946 dest_tv = &di->di_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003947 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003948 copy_tv(tv, dest_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003949 else
3950 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003951 *dest_tv = *tv;
3952 dest_tv->v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003953 init_tv(tv);
3954 }
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003955 free_tv_arg = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003956
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003957 if (vim9script && type != NULL)
Bram Moolenaar381692b2022-02-02 20:01:27 +00003958 set_tv_type(dest_tv, type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003959
Bram Moolenaar1dcf55d2020-12-22 22:07:30 +01003960 // ":const var = value" locks the value
3961 // ":final var = value" locks "var"
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003962 if (flags & ASSIGN_CONST)
Bram Moolenaar021bda52020-08-17 21:07:22 +02003963 // Like :lockvar! name: lock the value and what it contains, but only
3964 // if the reference count is up to one. That locks only literal
3965 // values.
Bram Moolenaar24e93162021-07-18 20:40:33 +02003966 item_lock(dest_tv, DICT_MAXNEST, TRUE, TRUE);
Bram Moolenaar24e93162021-07-18 20:40:33 +02003967
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003968failed:
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003969 vim_free(name_tofree);
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003970 if (free_tv_arg)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003971 clear_tv(tv_arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003972}
3973
3974/*
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003975 * Check in this order for backwards compatibility:
3976 * - Whether the variable is read-only
3977 * - Whether the variable value is locked
3978 * - Whether the variable is locked
3979 */
3980 int
3981var_check_permission(dictitem_T *di, char_u *name)
3982{
3983 if (var_check_ro(di->di_flags, name, FALSE)
3984 || value_check_lock(di->di_tv.v_lock, name, FALSE)
3985 || var_check_lock(di->di_flags, name, FALSE))
3986 return FAIL;
3987 return OK;
3988}
3989
3990/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003991 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
3992 * Also give an error message.
3993 */
3994 int
3995var_check_ro(int flags, char_u *name, int use_gettext)
3996{
3997 if (flags & DI_FLAGS_RO)
3998 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00003999 if (name == NULL)
4000 emsg(_(e_cannot_change_readonly_variable));
4001 else
4002 semsg(_(e_cannot_change_readonly_variable_str),
Bram Moolenaard8e44472021-07-21 22:20:33 +02004003 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004004 return TRUE;
4005 }
4006 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
4007 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004008 if (name == NULL)
4009 emsg(_(e_cannot_set_variable_in_sandbox));
4010 else
4011 semsg(_(e_cannot_set_variable_in_sandbox_str),
4012 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004013 return TRUE;
4014 }
4015 return FALSE;
4016}
4017
4018/*
Bram Moolenaara187c432020-09-16 21:08:28 +02004019 * Return TRUE if di_flags "flags" indicates variable "name" is locked.
4020 * Also give an error message.
4021 */
4022 int
4023var_check_lock(int flags, char_u *name, int use_gettext)
4024{
4025 if (flags & DI_FLAGS_LOCK)
4026 {
4027 semsg(_(e_variable_is_locked_str),
4028 use_gettext ? (char_u *)_(name) : name);
4029 return TRUE;
4030 }
4031 return FALSE;
4032}
4033
4034/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004035 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
4036 * Also give an error message.
4037 */
4038 int
4039var_check_fixed(int flags, char_u *name, int use_gettext)
4040{
4041 if (flags & DI_FLAGS_FIX)
4042 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004043 if (name == NULL)
4044 emsg(_(e_cannot_delete_variable));
4045 else
4046 semsg(_(e_cannot_delete_variable_str),
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004047 use_gettext ? (char_u *)_(name) : name);
4048 return TRUE;
4049 }
4050 return FALSE;
4051}
4052
4053/*
4054 * Check if a funcref is assigned to a valid variable name.
4055 * Return TRUE and give an error if not.
4056 */
4057 int
Bram Moolenaar98b4f142020-08-08 15:46:01 +02004058var_wrong_func_name(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004059 char_u *name, // points to start of variable name
4060 int new_var) // TRUE when creating the variable
4061{
Bram Moolenaar32154662021-03-28 21:14:06 +02004062 // Allow for w: b: s: and t:. In Vim9 script s: is not allowed, because
4063 // the name can be used without the s: prefix.
thinca6c667bd2022-09-02 11:25:37 +01004064 // Allow autoload variable.
Bram Moolenaar32154662021-03-28 21:14:06 +02004065 if (!((vim_strchr((char_u *)"wbt", name[0]) != NULL
4066 || (!in_vim9script() && name[0] == 's')) && name[1] == ':')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004067 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
thinca6c667bd2022-09-02 11:25:37 +01004068 ? name[2] : name[0])
4069 && vim_strchr(name, '#') == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004070 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004071 semsg(_(e_funcref_variable_name_must_start_with_capital_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004072 return TRUE;
4073 }
4074 // Don't allow hiding a function. When "v" is not NULL we might be
4075 // assigning another function to the same var, the type is checked
4076 // below.
4077 if (new_var && function_exists(name, FALSE))
4078 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004079 semsg(_(e_variable_name_conflicts_with_existing_function_str),
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004080 name);
4081 return TRUE;
4082 }
4083 return FALSE;
4084}
4085
4086/*
Bram Moolenaara187c432020-09-16 21:08:28 +02004087 * Return TRUE if "flags" indicates variable "name" has a locked (immutable)
4088 * value. Also give an error message, using "name" or _("name") when
4089 * "use_gettext" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004090 */
4091 int
Bram Moolenaara187c432020-09-16 21:08:28 +02004092value_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004093{
4094 if (lock & VAR_LOCKED)
4095 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004096 if (name == NULL)
4097 emsg(_(e_value_is_locked));
4098 else
4099 semsg(_(e_value_is_locked_str),
4100 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004101 return TRUE;
4102 }
4103 if (lock & VAR_FIXED)
4104 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004105 if (name == NULL)
4106 emsg(_(e_cannot_change_value));
4107 else
4108 semsg(_(e_cannot_change_value_of_str),
4109 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004110 return TRUE;
4111 }
4112 return FALSE;
4113}
4114
4115/*
Bram Moolenaar03290b82020-12-19 16:30:44 +01004116 * Check if a variable name is valid. When "autoload" is true "#" is allowed.
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004117 * If "len" is -1 use all of "varname", otherwise up to "varname[len]".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004118 * Return FALSE and give an error if not.
4119 */
4120 int
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004121valid_varname(char_u *varname, int len, int autoload)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004122{
4123 char_u *p;
4124
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004125 for (p = varname; len < 0 ? *p != NUL : p < varname + len; ++p)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004126 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
Bram Moolenaar03290b82020-12-19 16:30:44 +01004127 && !(autoload && *p == AUTOLOAD_CHAR))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004128 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004129 semsg(_(e_illegal_variable_name_str), varname);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004130 return FALSE;
4131 }
4132 return TRUE;
4133}
4134
4135/*
LemonBoy47d4e312022-05-04 18:12:55 +01004136 * Implements the logic to retrieve local variable and option values.
4137 * Used by "getwinvar()" "gettabvar()" "gettabwinvar()" "getbufvar()".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004138 */
4139 static void
LemonBoy47d4e312022-05-04 18:12:55 +01004140get_var_from(
4141 char_u *varname,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004142 typval_T *rettv,
LemonBoy47d4e312022-05-04 18:12:55 +01004143 typval_T *deftv, // Default value if not found.
4144 int htname, // 't'ab, 'w'indow or 'b'uffer local.
4145 tabpage_T *tp, // can be NULL
4146 win_T *win,
4147 buf_T *buf) // Ignored if htname is not 'b'.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004148{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004149 dictitem_T *v;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004150 int done = FALSE;
Bram Moolenaar18f47402022-01-06 13:24:51 +00004151 switchwin_T switchwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004152 int need_switch_win;
zeertzjqcd6ad642022-07-25 12:28:09 +01004153 int do_change_curbuf = buf != NULL && htname == 'b';
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004154
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004155 ++emsg_off;
4156
4157 rettv->v_type = VAR_STRING;
4158 rettv->vval.v_string = NULL;
4159
LemonBoy47d4e312022-05-04 18:12:55 +01004160 if (varname != NULL && tp != NULL && win != NULL
4161 && (htname != 'b' || buf != NULL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004162 {
4163 // Set curwin to be our win, temporarily. Also set the tabpage,
4164 // otherwise the window is not valid. Only do this when needed,
4165 // autocommands get blocked.
LemonBoy47d4e312022-05-04 18:12:55 +01004166 // If we have a buffer reference avoid the switching, we're saving and
4167 // restoring curbuf directly.
zeertzjqcd6ad642022-07-25 12:28:09 +01004168 need_switch_win = !(tp == curtab && win == curwin) && !do_change_curbuf;
LemonBoy47d4e312022-05-04 18:12:55 +01004169 if (!need_switch_win || switch_win(&switchwin, win, tp, TRUE) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004170 {
LemonBoy47d4e312022-05-04 18:12:55 +01004171 // Handle options. There are no tab-local options.
4172 if (*varname == '&' && htname != 't')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004173 {
LemonBoy47d4e312022-05-04 18:12:55 +01004174 buf_T *save_curbuf = curbuf;
4175
4176 // Change curbuf so the option is read from the correct buffer.
zeertzjqcd6ad642022-07-25 12:28:09 +01004177 if (do_change_curbuf)
LemonBoy47d4e312022-05-04 18:12:55 +01004178 curbuf = buf;
4179
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004180 if (varname[1] == NUL)
4181 {
zeertzjqcd6ad642022-07-25 12:28:09 +01004182 // get all window-local or buffer-local options in a dict
LemonBoy47d4e312022-05-04 18:12:55 +01004183 dict_T *opts = get_winbuf_options(htname == 'b');
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004184
4185 if (opts != NULL)
4186 {
4187 rettv_dict_set(rettv, opts);
4188 done = TRUE;
4189 }
4190 }
LemonBoy47d4e312022-05-04 18:12:55 +01004191 else if (eval_option(&varname, rettv, TRUE) == OK)
4192 // Local option
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004193 done = TRUE;
LemonBoy47d4e312022-05-04 18:12:55 +01004194
4195 curbuf = save_curbuf;
4196 }
4197 else if (*varname == NUL)
4198 {
4199 // Empty string: return a dict with all the local variables.
4200 if (htname == 'b')
4201 v = &buf->b_bufvar;
4202 else if (htname == 'w')
4203 v = &win->w_winvar;
4204 else
4205 v = &tp->tp_winvar;
4206 copy_tv(&v->di_tv, rettv);
4207 done = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004208 }
4209 else
4210 {
LemonBoy47d4e312022-05-04 18:12:55 +01004211 hashtab_T *ht;
4212
4213 if (htname == 'b')
4214 ht = &buf->b_vars->dv_hashtab;
4215 else if (htname == 'w')
4216 ht = &win->w_vars->dv_hashtab;
4217 else
4218 ht = &tp->tp_vars->dv_hashtab;
4219
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004220 // Look up the variable.
LemonBoy47d4e312022-05-04 18:12:55 +01004221 v = find_var_in_ht(ht, htname, varname, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004222 if (v != NULL)
4223 {
4224 copy_tv(&v->di_tv, rettv);
4225 done = TRUE;
4226 }
4227 }
4228 }
4229
4230 if (need_switch_win)
4231 // restore previous notion of curwin
Bram Moolenaar18f47402022-01-06 13:24:51 +00004232 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004233 }
4234
LemonBoy47d4e312022-05-04 18:12:55 +01004235 if (!done && deftv->v_type != VAR_UNKNOWN)
4236 // use the default value
4237 copy_tv(deftv, rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004238
4239 --emsg_off;
4240}
4241
4242/*
LemonBoy47d4e312022-05-04 18:12:55 +01004243 * getwinvar() and gettabwinvar()
4244 */
4245 static void
4246getwinvar(
4247 typval_T *argvars,
4248 typval_T *rettv,
4249 int off) // 1 for gettabwinvar()
4250{
4251 char_u *varname;
4252 tabpage_T *tp;
4253 win_T *win;
4254
4255 if (off == 1)
4256 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4257 else
4258 tp = curtab;
4259 win = find_win_by_nr(&argvars[off], tp);
4260 varname = tv_get_string_chk(&argvars[off + 1]);
4261
4262 get_var_from(varname, rettv, &argvars[off + 2], 'w', tp, win, NULL);
4263}
4264
4265/*
Bram Moolenaar191929b2020-08-19 21:20:49 +02004266 * Set option "varname" to the value of "varp" for the current buffer/window.
4267 */
4268 static void
4269set_option_from_tv(char_u *varname, typval_T *varp)
4270{
4271 long numval = 0;
4272 char_u *strval;
4273 char_u nbuf[NUMBUFLEN];
4274 int error = FALSE;
4275
Bram Moolenaar31a201a2021-01-03 14:47:25 +01004276 if (varp->v_type == VAR_BOOL)
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004277 {
Bram Moolenaar28f84e12022-07-27 12:30:13 +01004278 if (is_string_option(varname))
4279 {
4280 emsg(_(e_string_required));
4281 return;
4282 }
Bram Moolenaar31a201a2021-01-03 14:47:25 +01004283 numval = (long)varp->vval.v_number;
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004284 strval = (char_u *)"0"; // avoid using "false"
4285 }
4286 else
4287 {
4288 if (!in_vim9script() || varp->v_type != VAR_STRING)
4289 numval = (long)tv_get_number_chk(varp, &error);
4290 strval = tv_get_string_buf_chk(varp, nbuf);
4291 }
Bram Moolenaar191929b2020-08-19 21:20:49 +02004292 if (!error && strval != NULL)
Bram Moolenaar31e5c602022-04-15 13:53:33 +01004293 set_option_value_give_err(varname, numval, strval, OPT_LOCAL);
Bram Moolenaar191929b2020-08-19 21:20:49 +02004294}
4295
4296/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004297 * "setwinvar()" and "settabwinvar()" functions
4298 */
4299 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004300setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004301{
4302 win_T *win;
Bram Moolenaar18f47402022-01-06 13:24:51 +00004303 switchwin_T switchwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004304 int need_switch_win;
4305 char_u *varname, *winvarname;
4306 typval_T *varp;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004307 tabpage_T *tp = NULL;
4308
4309 if (check_secure())
4310 return;
4311
4312 if (off == 1)
4313 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4314 else
4315 tp = curtab;
4316 win = find_win_by_nr(&argvars[off], tp);
4317 varname = tv_get_string_chk(&argvars[off + 1]);
4318 varp = &argvars[off + 2];
4319
4320 if (win != NULL && varname != NULL && varp != NULL)
4321 {
4322 need_switch_win = !(tp == curtab && win == curwin);
4323 if (!need_switch_win
Bram Moolenaar18f47402022-01-06 13:24:51 +00004324 || switch_win(&switchwin, win, tp, TRUE) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004325 {
4326 if (*varname == '&')
Bram Moolenaar191929b2020-08-19 21:20:49 +02004327 set_option_from_tv(varname + 1, varp);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004328 else
4329 {
4330 winvarname = alloc(STRLEN(varname) + 3);
4331 if (winvarname != NULL)
4332 {
4333 STRCPY(winvarname, "w:");
4334 STRCPY(winvarname + 2, varname);
4335 set_var(winvarname, varp, TRUE);
4336 vim_free(winvarname);
4337 }
4338 }
4339 }
4340 if (need_switch_win)
Bram Moolenaar18f47402022-01-06 13:24:51 +00004341 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004342 }
4343}
4344
Bram Moolenaare5cdf152019-08-29 22:09:46 +02004345/*
4346 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
4347 * v:option_type, and v:option_command.
4348 */
4349 void
4350reset_v_option_vars(void)
4351{
4352 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
4353 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
4354 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
4355 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
4356 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
4357 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
4358}
4359
4360/*
4361 * Add an assert error to v:errors.
4362 */
4363 void
4364assert_error(garray_T *gap)
4365{
4366 struct vimvar *vp = &vimvars[VV_ERRORS];
4367
Bram Moolenaard787e402021-12-24 21:36:12 +00004368 if (vp->vv_tv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004369 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02004370 set_vim_var_list(VV_ERRORS, list_alloc());
4371 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
4372}
4373
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004374 int
4375var_exists(char_u *var)
4376{
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004377 char_u *arg = var;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004378 char_u *name;
4379 char_u *tofree;
4380 typval_T tv;
4381 int len = 0;
4382 int n = FALSE;
4383
4384 // get_name_len() takes care of expanding curly braces
4385 name = var;
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004386 len = get_name_len(&arg, &tofree, TRUE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004387 if (len > 0)
4388 {
4389 if (tofree != NULL)
4390 name = tofree;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004391 n = (eval_variable(name, len, 0, &tv, NULL,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01004392 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004393 if (n)
4394 {
4395 // handle d.key, l[idx], f(expr)
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004396 arg = skipwhite(arg);
Bram Moolenaar32884ad2022-01-07 12:45:29 +00004397 n = (handle_subscript(&arg, name, &tv, &EVALARG_EVALUATE,
4398 FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004399 if (n)
4400 clear_tv(&tv);
4401 }
4402 }
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004403 if (*arg != NUL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004404 n = FALSE;
4405
4406 vim_free(tofree);
4407 return n;
4408}
4409
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004410static lval_T *redir_lval = NULL;
4411#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
4412static garray_T redir_ga; // only valid when redir_lval is not NULL
4413static char_u *redir_endp = NULL;
4414static char_u *redir_varname = NULL;
4415
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004416 int
4417alloc_redir_lval(void)
4418{
4419 redir_lval = ALLOC_CLEAR_ONE(lval_T);
4420 if (redir_lval == NULL)
4421 return FAIL;
4422 return OK;
4423}
4424
4425 void
4426clear_redir_lval(void)
4427{
4428 VIM_CLEAR(redir_lval);
4429}
4430
4431 void
4432init_redir_ga(void)
4433{
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004434 ga_init2(&redir_ga, sizeof(char), 500);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004435}
4436
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004437/*
4438 * Start recording command output to a variable
4439 * When "append" is TRUE append to an existing variable.
4440 * Returns OK if successfully completed the setup. FAIL otherwise.
4441 */
4442 int
4443var_redir_start(char_u *name, int append)
4444{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004445 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004446 typval_T tv;
4447
4448 // Catch a bad name early.
4449 if (!eval_isnamec1(*name))
4450 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004451 emsg(_(e_invalid_argument));
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004452 return FAIL;
4453 }
4454
4455 // Make a copy of the name, it is used in redir_lval until redir ends.
4456 redir_varname = vim_strsave(name);
4457 if (redir_varname == NULL)
4458 return FAIL;
4459
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004460 if (alloc_redir_lval() == FAIL)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004461 {
4462 var_redir_stop();
4463 return FAIL;
4464 }
4465
4466 // The output is stored in growarray "redir_ga" until redirection ends.
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004467 init_redir_ga();
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004468
4469 // Parse the variable name (can be a dict or list entry).
4470 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
4471 FNE_CHECK_START);
4472 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
4473 {
4474 clear_lval(redir_lval);
4475 if (redir_endp != NULL && *redir_endp != NUL)
4476 // Trailing characters are present after the variable name
Bram Moolenaar74409f62022-01-01 15:58:22 +00004477 semsg(_(e_trailing_characters_str), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004478 else
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004479 semsg(_(e_invalid_argument_str), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004480 redir_endp = NULL; // don't store a value, only cleanup
4481 var_redir_stop();
4482 return FAIL;
4483 }
4484
4485 // check if we can write to the variable: set it to or append an empty
4486 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004487 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004488 tv.v_type = VAR_STRING;
4489 tv.vval.v_string = (char_u *)"";
4490 if (append)
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004491 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004492 ASSIGN_NO_DECL, (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004493 else
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004494 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004495 ASSIGN_NO_DECL, (char_u *)"=", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004496 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004497 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004498 {
4499 redir_endp = NULL; // don't store a value, only cleanup
4500 var_redir_stop();
4501 return FAIL;
4502 }
4503
4504 return OK;
4505}
4506
4507/*
4508 * Append "value[value_len]" to the variable set by var_redir_start().
4509 * The actual appending is postponed until redirection ends, because the value
4510 * appended may in fact be the string we write to, changing it may cause freed
4511 * memory to be used:
4512 * :redir => foo
4513 * :let foo
4514 * :redir END
4515 */
4516 void
4517var_redir_str(char_u *value, int value_len)
4518{
4519 int len;
4520
4521 if (redir_lval == NULL)
4522 return;
4523
4524 if (value_len == -1)
4525 len = (int)STRLEN(value); // Append the entire string
4526 else
4527 len = value_len; // Append only "value_len" characters
4528
4529 if (ga_grow(&redir_ga, len) == OK)
4530 {
4531 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
4532 redir_ga.ga_len += len;
4533 }
4534 else
4535 var_redir_stop();
4536}
4537
4538/*
4539 * Stop redirecting command output to a variable.
4540 * Frees the allocated memory.
4541 */
4542 void
4543var_redir_stop(void)
4544{
4545 typval_T tv;
4546
4547 if (EVALCMD_BUSY)
4548 {
4549 redir_lval = NULL;
4550 return;
4551 }
4552
4553 if (redir_lval != NULL)
4554 {
4555 // If there was no error: assign the text to the variable.
4556 if (redir_endp != NULL)
4557 {
4558 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4559 tv.v_type = VAR_STRING;
4560 tv.vval.v_string = redir_ga.ga_data;
4561 // Call get_lval() again, if it's inside a Dict or List it may
4562 // have changed.
4563 redir_endp = get_lval(redir_varname, NULL, redir_lval,
4564 FALSE, FALSE, 0, FNE_CHECK_START);
4565 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004566 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004567 (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004568 clear_lval(redir_lval);
4569 }
4570
4571 // free the collected output
4572 VIM_CLEAR(redir_ga.ga_data);
4573
4574 VIM_CLEAR(redir_lval);
4575 }
4576 VIM_CLEAR(redir_varname);
4577}
4578
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004579/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004580 * Get the collected redirected text and clear redir_ga.
4581 */
4582 char_u *
4583get_clear_redir_ga(void)
4584{
4585 char_u *res;
4586
4587 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4588 res = redir_ga.ga_data;
4589 redir_ga.ga_data = NULL;
4590 return res;
4591}
4592
4593/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004594 * "gettabvar()" function
4595 */
4596 void
4597f_gettabvar(typval_T *argvars, typval_T *rettv)
4598{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004599 char_u *varname;
LemonBoy47d4e312022-05-04 18:12:55 +01004600 tabpage_T *tp;
4601 win_T *win = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004602
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004603 if (in_vim9script()
4604 && (check_for_number_arg(argvars, 0) == FAIL
4605 || check_for_string_arg(argvars, 1) == FAIL))
4606 return;
4607
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004608 varname = tv_get_string_chk(&argvars[1]);
4609 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
LemonBoy47d4e312022-05-04 18:12:55 +01004610 if (tp != NULL)
4611 win = tp == curtab || tp->tp_firstwin == NULL ? firstwin
4612 : tp->tp_firstwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004613
LemonBoy47d4e312022-05-04 18:12:55 +01004614 get_var_from(varname, rettv, &argvars[2], 't', tp, win, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004615}
4616
4617/*
4618 * "gettabwinvar()" function
4619 */
4620 void
4621f_gettabwinvar(typval_T *argvars, typval_T *rettv)
4622{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004623 if (in_vim9script()
4624 && (check_for_number_arg(argvars, 0) == FAIL
4625 || check_for_number_arg(argvars, 1) == FAIL
4626 || check_for_string_arg(argvars, 2) == FAIL))
4627 return;
4628
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004629 getwinvar(argvars, rettv, 1);
4630}
4631
4632/*
4633 * "getwinvar()" function
4634 */
4635 void
4636f_getwinvar(typval_T *argvars, typval_T *rettv)
4637{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004638 if (in_vim9script()
4639 && (check_for_number_arg(argvars, 0) == FAIL
4640 || check_for_string_arg(argvars, 1) == FAIL))
4641 return;
4642
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004643 getwinvar(argvars, rettv, 0);
4644}
4645
4646/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004647 * "getbufvar()" function
4648 */
4649 void
4650f_getbufvar(typval_T *argvars, typval_T *rettv)
4651{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004652 char_u *varname;
LemonBoy47d4e312022-05-04 18:12:55 +01004653 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004654
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004655 if (in_vim9script()
4656 && (check_for_buffer_arg(argvars, 0) == FAIL
4657 || check_for_string_arg(argvars, 1) == FAIL))
4658 return;
4659
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004660 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004661 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004662
LemonBoy47d4e312022-05-04 18:12:55 +01004663 get_var_from(varname, rettv, &argvars[2], 'b', curtab, curwin, buf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004664}
4665
4666/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004667 * "settabvar()" function
4668 */
4669 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004670f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004671{
4672 tabpage_T *save_curtab;
4673 tabpage_T *tp;
4674 char_u *varname, *tabvarname;
4675 typval_T *varp;
4676
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004677 if (check_secure())
4678 return;
4679
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004680 if (in_vim9script()
4681 && (check_for_number_arg(argvars, 0) == FAIL
4682 || check_for_string_arg(argvars, 1) == FAIL))
4683 return;
4684
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004685 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4686 varname = tv_get_string_chk(&argvars[1]);
4687 varp = &argvars[2];
4688
4689 if (varname != NULL && varp != NULL && tp != NULL)
4690 {
4691 save_curtab = curtab;
4692 goto_tabpage_tp(tp, FALSE, FALSE);
4693
4694 tabvarname = alloc(STRLEN(varname) + 3);
4695 if (tabvarname != NULL)
4696 {
4697 STRCPY(tabvarname, "t:");
4698 STRCPY(tabvarname + 2, varname);
4699 set_var(tabvarname, varp, TRUE);
4700 vim_free(tabvarname);
4701 }
4702
4703 // Restore current tabpage
4704 if (valid_tabpage(save_curtab))
4705 goto_tabpage_tp(save_curtab, FALSE, FALSE);
4706 }
4707}
4708
4709/*
4710 * "settabwinvar()" function
4711 */
4712 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004713f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004714{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004715 if (in_vim9script()
4716 && (check_for_number_arg(argvars, 0) == FAIL
4717 || check_for_number_arg(argvars, 1) == FAIL
4718 || check_for_string_arg(argvars, 2) == FAIL))
4719 return;
4720
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004721 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004722}
4723
4724/*
4725 * "setwinvar()" function
4726 */
4727 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004728f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004729{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004730 if (in_vim9script()
4731 && (check_for_number_arg(argvars, 0) == FAIL
4732 || check_for_string_arg(argvars, 1) == FAIL))
4733 return;
4734
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004735 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004736}
4737
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004738/*
4739 * "setbufvar()" function
4740 */
4741 void
4742f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
4743{
4744 buf_T *buf;
4745 char_u *varname, *bufvarname;
4746 typval_T *varp;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004747
4748 if (check_secure())
4749 return;
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004750
4751 if (in_vim9script()
4752 && (check_for_buffer_arg(argvars, 0) == FAIL
4753 || check_for_string_arg(argvars, 1) == FAIL))
4754 return;
4755
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004756 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004757 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004758 varp = &argvars[2];
4759
4760 if (buf != NULL && varname != NULL && varp != NULL)
4761 {
4762 if (*varname == '&')
4763 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004764 aco_save_T aco;
4765
Bram Moolenaare76062c2022-11-28 18:51:43 +00004766 // Set curbuf to be our buf, temporarily.
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004767 aucmd_prepbuf(&aco, buf);
Bram Moolenaare76062c2022-11-28 18:51:43 +00004768 if (curbuf == buf)
4769 {
4770 // Only when it worked to set "curbuf".
4771 set_option_from_tv(varname + 1, varp);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004772
Bram Moolenaare76062c2022-11-28 18:51:43 +00004773 // reset notion of buffer
4774 aucmd_restbuf(&aco);
4775 }
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004776 }
4777 else
4778 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004779 bufvarname = alloc(STRLEN(varname) + 3);
4780 if (bufvarname != NULL)
4781 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004782 buf_T *save_curbuf = curbuf;
4783
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004784 curbuf = buf;
4785 STRCPY(bufvarname, "b:");
4786 STRCPY(bufvarname + 2, varname);
4787 set_var(bufvarname, varp, TRUE);
4788 vim_free(bufvarname);
4789 curbuf = save_curbuf;
4790 }
4791 }
4792 }
4793}
4794
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004795/*
4796 * Get a callback from "arg". It can be a Funcref or a function name.
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004797 * When "arg" is zero "res.cb_name" is set to an empty string.
4798 * If "res.cb_name" is allocated then "res.cb_free_name" is set to TRUE.
4799 * "res.cb_name" is set to NULL for an invalid argument.
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004800 */
4801 callback_T
4802get_callback(typval_T *arg)
4803{
Bram Moolenaar14e579092020-03-07 16:59:25 +01004804 callback_T res;
4805 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004806
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004807 CLEAR_FIELD(res);
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004808 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
4809 {
4810 res.cb_partial = arg->vval.v_partial;
4811 ++res.cb_partial->pt_refcount;
4812 res.cb_name = partial_name(res.cb_partial);
4813 }
4814 else
4815 {
Bram Moolenaar14e579092020-03-07 16:59:25 +01004816 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
4817 && isdigit(*arg->vval.v_string))
4818 r = FAIL;
4819 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004820 {
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004821 res.cb_name = arg->vval.v_string;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004822 if (arg->v_type == VAR_STRING)
4823 {
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004824 char_u *name = get_scriptlocal_funcname(arg->vval.v_string);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004825 if (name != NULL)
4826 {
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004827 res.cb_name = name;
4828 res.cb_free_name = TRUE;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004829 }
4830 }
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004831 func_ref(res.cb_name);
4832 }
4833 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004834 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004835 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01004836 r = FAIL;
4837
4838 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004839 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004840 emsg(_(e_invalid_callback_argument));
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004841 res.cb_name = NULL;
4842 }
4843 }
4844 return res;
4845}
4846
4847/*
4848 * Copy a callback into a typval_T.
4849 */
4850 void
4851put_callback(callback_T *cb, typval_T *tv)
4852{
4853 if (cb->cb_partial != NULL)
4854 {
4855 tv->v_type = VAR_PARTIAL;
4856 tv->vval.v_partial = cb->cb_partial;
4857 ++tv->vval.v_partial->pt_refcount;
4858 }
4859 else
4860 {
4861 tv->v_type = VAR_FUNC;
4862 tv->vval.v_string = vim_strsave(cb->cb_name);
4863 func_ref(cb->cb_name);
4864 }
4865}
4866
4867/*
4868 * Make a copy of "src" into "dest", allocating the function name if needed,
4869 * without incrementing the refcount.
4870 */
4871 void
4872set_callback(callback_T *dest, callback_T *src)
4873{
4874 if (src->cb_partial == NULL)
4875 {
4876 // just a function name, make a copy
4877 dest->cb_name = vim_strsave(src->cb_name);
4878 dest->cb_free_name = TRUE;
4879 }
4880 else
4881 {
4882 // cb_name is a pointer into cb_partial
4883 dest->cb_name = src->cb_name;
4884 dest->cb_free_name = FALSE;
4885 }
4886 dest->cb_partial = src->cb_partial;
4887}
4888
4889/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02004890 * Copy callback from "src" to "dest", incrementing the refcounts.
4891 */
4892 void
4893copy_callback(callback_T *dest, callback_T *src)
4894{
4895 dest->cb_partial = src->cb_partial;
4896 if (dest->cb_partial != NULL)
4897 {
4898 dest->cb_name = src->cb_name;
4899 dest->cb_free_name = FALSE;
4900 ++dest->cb_partial->pt_refcount;
4901 }
4902 else
4903 {
4904 dest->cb_name = vim_strsave(src->cb_name);
4905 dest->cb_free_name = TRUE;
4906 func_ref(src->cb_name);
4907 }
4908}
4909
4910/*
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004911 * When a callback refers to an autoload import, change the function name to
4912 * the "path#name" form. Uses the current script context.
4913 * Only works when the name is allocated.
4914 */
4915 void
4916expand_autload_callback(callback_T *cb)
4917{
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004918 char_u *name;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004919 char_u *p;
4920 imported_T *import;
4921
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004922 if (!in_vim9script() || cb->cb_name == NULL
4923 || (!cb->cb_free_name
4924 && (cb->cb_partial == NULL || cb->cb_partial->pt_name == NULL)))
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004925 return;
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004926 if (cb->cb_partial != NULL)
4927 name = cb->cb_partial->pt_name;
4928 else
4929 name = cb->cb_name;
4930 p = vim_strchr(name, '.');
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004931 if (p == NULL)
4932 return;
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004933 import = find_imported(name, p - name, FALSE);
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004934 if (import != NULL && SCRIPT_ID_VALID(import->imp_sid))
4935 {
4936 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
4937
4938 if (si->sn_autoload_prefix != NULL)
4939 {
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004940 char_u *newname = concat_str(si->sn_autoload_prefix, p + 1);
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004941
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004942 if (newname != NULL)
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004943 {
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004944 if (cb->cb_partial != NULL)
4945 {
4946 if (cb->cb_name == cb->cb_partial->pt_name)
4947 cb->cb_name = newname;
4948 vim_free(cb->cb_partial->pt_name);
4949 cb->cb_partial->pt_name = newname;
4950 }
4951 else
4952 {
4953 vim_free(cb->cb_name);
4954 cb->cb_name = newname;
4955 }
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004956 }
4957 }
4958 }
4959}
4960
4961/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004962 * Unref/free "callback" returned by get_callback() or set_callback().
4963 */
4964 void
4965free_callback(callback_T *callback)
4966{
4967 if (callback->cb_partial != NULL)
4968 {
4969 partial_unref(callback->cb_partial);
4970 callback->cb_partial = NULL;
4971 }
4972 else if (callback->cb_name != NULL)
4973 func_unref(callback->cb_name);
4974 if (callback->cb_free_name)
4975 {
4976 vim_free(callback->cb_name);
4977 callback->cb_free_name = FALSE;
4978 }
4979 callback->cb_name = NULL;
4980}
4981
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004982#endif // FEAT_EVAL