blob: fd443cd40f901429e97e15a0e0bae59e89539b22 [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 Moolenaare5cdf152019-08-29 22:09:46 +0200220 hash_add(&vimvarht, p->vv_di.di_key);
221 if (p->vv_flags & VV_COMPAT)
222 // add to compat scope dict
223 hash_add(&compat_hashtab, p->vv_di.di_key);
224 }
Bram Moolenaar016faaa2020-10-03 12:57:27 +0200225 set_vim_var_nr(VV_VERSION, VIM_VERSION_100);
226 set_vim_var_nr(VV_VERSIONLONG, VIM_VERSION_100 * 10000 + highest_patch());
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200227
228 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
229 set_vim_var_nr(VV_HLSEARCH, 1L);
Bram Moolenaarf0068c52020-11-30 17:42:10 +0100230 set_vim_var_nr(VV_EXITING, VVAL_NULL);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200231 set_vim_var_dict(VV_COMPLETED_ITEM, dict_alloc_lock(VAR_FIXED));
232 set_vim_var_list(VV_ERRORS, list_alloc());
233 set_vim_var_dict(VV_EVENT, dict_alloc_lock(VAR_FIXED));
234
235 set_vim_var_nr(VV_FALSE, VVAL_FALSE);
236 set_vim_var_nr(VV_TRUE, VVAL_TRUE);
237 set_vim_var_nr(VV_NONE, VVAL_NONE);
238 set_vim_var_nr(VV_NULL, VVAL_NULL);
Bram Moolenaar57d5a012021-01-21 21:42:31 +0100239 set_vim_var_nr(VV_NUMBERMAX, VARNUM_MAX);
240 set_vim_var_nr(VV_NUMBERMIN, VARNUM_MIN);
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100241 set_vim_var_nr(VV_NUMBERSIZE, sizeof(varnumber_T) * 8);
Bram Moolenaar69b30722021-11-02 21:39:49 +0000242 set_vim_var_nr(VV_SIZEOFINT, sizeof(int));
243 set_vim_var_nr(VV_SIZEOFLONG, sizeof(long));
244 set_vim_var_nr(VV_SIZEOFPOINTER, sizeof(char *));
naohiro ono56200ee2022-01-01 14:59:44 +0000245 set_vim_var_nr(VV_MAXCOL, MAXCOL);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200246
247 set_vim_var_nr(VV_TYPE_NUMBER, VAR_TYPE_NUMBER);
248 set_vim_var_nr(VV_TYPE_STRING, VAR_TYPE_STRING);
249 set_vim_var_nr(VV_TYPE_FUNC, VAR_TYPE_FUNC);
250 set_vim_var_nr(VV_TYPE_LIST, VAR_TYPE_LIST);
251 set_vim_var_nr(VV_TYPE_DICT, VAR_TYPE_DICT);
252 set_vim_var_nr(VV_TYPE_FLOAT, VAR_TYPE_FLOAT);
253 set_vim_var_nr(VV_TYPE_BOOL, VAR_TYPE_BOOL);
254 set_vim_var_nr(VV_TYPE_NONE, VAR_TYPE_NONE);
255 set_vim_var_nr(VV_TYPE_JOB, VAR_TYPE_JOB);
256 set_vim_var_nr(VV_TYPE_CHANNEL, VAR_TYPE_CHANNEL);
257 set_vim_var_nr(VV_TYPE_BLOB, VAR_TYPE_BLOB);
258
259 set_vim_var_nr(VV_ECHOSPACE, sc_col - 1);
260
Drew Vogele30d1022021-10-24 20:35:07 +0100261 set_vim_var_dict(VV_COLORNAMES, dict_alloc());
262
Bram Moolenaar439c0362020-06-06 15:58:03 +0200263 // Default for v:register is not 0 but '"'. This is adjusted once the
264 // clipboard has been setup by calling reset_reg_var().
265 set_reg_var(0);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200266}
267
268#if defined(EXITFREE) || defined(PROTO)
269/*
270 * Free all vim variables information on exit
271 */
272 void
273evalvars_clear(void)
274{
275 int i;
276 struct vimvar *p;
277
278 for (i = 0; i < VV_LEN; ++i)
279 {
280 p = &vimvars[i];
281 if (p->vv_di.di_tv.v_type == VAR_STRING)
282 VIM_CLEAR(p->vv_str);
283 else if (p->vv_di.di_tv.v_type == VAR_LIST)
284 {
285 list_unref(p->vv_list);
286 p->vv_list = NULL;
287 }
288 }
289 hash_clear(&vimvarht);
290 hash_init(&vimvarht); // garbage_collect() will access it
291 hash_clear(&compat_hashtab);
292
293 // global variables
294 vars_clear(&globvarht);
295
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100296 // Script-local variables. Clear all the variables here.
297 // The scriptvar_T is cleared later in free_scriptnames(), because a
298 // variable in one script might hold a reference to the whole scope of
299 // another script.
300 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200301 vars_clear(&SCRIPT_VARS(i));
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200302}
303#endif
304
305 int
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200306garbage_collect_globvars(int copyID)
307{
308 return set_ref_in_ht(&globvarht, copyID, NULL);
309}
310
311 int
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200312garbage_collect_vimvars(int copyID)
313{
314 return set_ref_in_ht(&vimvarht, copyID, NULL);
315}
316
317 int
318garbage_collect_scriptvars(int copyID)
319{
Bram Moolenaared234f22020-10-15 20:42:20 +0200320 int i;
321 int idx;
322 int abort = FALSE;
323 scriptitem_T *si;
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200324
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100325 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaared234f22020-10-15 20:42:20 +0200326 {
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200327 abort = abort || set_ref_in_ht(&SCRIPT_VARS(i), copyID, NULL);
328
Bram Moolenaared234f22020-10-15 20:42:20 +0200329 si = SCRIPT_ITEM(i);
330 for (idx = 0; idx < si->sn_var_vals.ga_len; ++idx)
331 {
332 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + idx;
333
Bram Moolenaard00a7fb2021-03-08 20:47:14 +0100334 if (sv->sv_name != NULL)
335 abort = abort || set_ref_in_item(sv->sv_tv, copyID, NULL, NULL);
Bram Moolenaared234f22020-10-15 20:42:20 +0200336 }
337 }
338
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200339 return abort;
340}
341
342/*
343 * Set an internal variable to a string value. Creates the variable if it does
344 * not already exist.
345 */
346 void
347set_internal_string_var(char_u *name, char_u *value)
348{
349 char_u *val;
350 typval_T *tvp;
351
352 val = vim_strsave(value);
353 if (val != NULL)
354 {
355 tvp = alloc_string_tv(val);
356 if (tvp != NULL)
357 {
358 set_var(name, tvp, FALSE);
359 free_tv(tvp);
360 }
361 }
362}
363
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200364 int
365eval_charconvert(
366 char_u *enc_from,
367 char_u *enc_to,
368 char_u *fname_from,
369 char_u *fname_to)
370{
371 int err = FALSE;
Bram Moolenaarf4e88f22022-01-23 14:17:28 +0000372 sctx_T saved_sctx = current_sctx;
373 sctx_T *ctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200374
375 set_vim_var_string(VV_CC_FROM, enc_from, -1);
376 set_vim_var_string(VV_CC_TO, enc_to, -1);
377 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
378 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
Bram Moolenaarf4e88f22022-01-23 14:17:28 +0000379 ctx = get_option_sctx("charconvert");
380 if (ctx != NULL)
381 current_sctx = *ctx;
382
Bram 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 Moolenaare5cdf152019-08-29 22:09:46 +0200565 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
566}
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
585 hash_remove(&vimvarht, hi);
586 }
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 Moolenaare8e369a2022-09-21 18:59:14 +01001329
1330 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 Moolenaar8a7d6542020-01-26 15:56:19 +01001346 end = find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001347 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
Bram Moolenaar036d0712021-01-17 20:23:38 +01001348
1349 // "a: type" is declaring variable "a" with a type, not "a:".
1350 // Same for "s: type".
Bram Moolenaar585587d2021-01-17 20:52:13 +01001351 if (vim9 && end == arg + 2 && end[-1] == ':')
Bram Moolenaar036d0712021-01-17 20:23:38 +01001352 --end;
1353
Bram Moolenaar585587d2021-01-17 20:52:13 +01001354 if (include_type && vim9)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001355 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001356 if (*end == ':')
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02001357 end = skip_type(skipwhite(end + 1), FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001358 }
1359 return end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001360}
1361
1362/*
1363 * List variables for hashtab "ht" with prefix "prefix".
1364 * If "empty" is TRUE also list NULL strings as empty strings.
1365 */
1366 void
1367list_hashtable_vars(
1368 hashtab_T *ht,
1369 char *prefix,
1370 int empty,
1371 int *first)
1372{
1373 hashitem_T *hi;
1374 dictitem_T *di;
1375 int todo;
1376 char_u buf[IOSIZE];
1377
1378 todo = (int)ht->ht_used;
1379 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1380 {
1381 if (!HASHITEM_EMPTY(hi))
1382 {
1383 --todo;
1384 di = HI2DI(hi);
1385
1386 // apply :filter /pat/ to variable name
1387 vim_strncpy((char_u *)buf, (char_u *)prefix, IOSIZE - 1);
1388 vim_strcat((char_u *)buf, di->di_key, IOSIZE);
1389 if (message_filtered(buf))
1390 continue;
1391
1392 if (empty || di->di_tv.v_type != VAR_STRING
1393 || di->di_tv.vval.v_string != NULL)
1394 list_one_var(di, prefix, first);
1395 }
1396 }
1397}
1398
1399/*
1400 * List global variables.
1401 */
1402 static void
1403list_glob_vars(int *first)
1404{
1405 list_hashtable_vars(&globvarht, "", TRUE, first);
1406}
1407
1408/*
1409 * List buffer variables.
1410 */
1411 static void
1412list_buf_vars(int *first)
1413{
1414 list_hashtable_vars(&curbuf->b_vars->dv_hashtab, "b:", TRUE, first);
1415}
1416
1417/*
1418 * List window variables.
1419 */
1420 static void
1421list_win_vars(int *first)
1422{
1423 list_hashtable_vars(&curwin->w_vars->dv_hashtab, "w:", TRUE, first);
1424}
1425
1426/*
1427 * List tab page variables.
1428 */
1429 static void
1430list_tab_vars(int *first)
1431{
1432 list_hashtable_vars(&curtab->tp_vars->dv_hashtab, "t:", TRUE, first);
1433}
1434
1435/*
1436 * List variables in "arg".
1437 */
1438 static char_u *
1439list_arg_vars(exarg_T *eap, char_u *arg, int *first)
1440{
1441 int error = FALSE;
1442 int len;
1443 char_u *name;
1444 char_u *name_start;
1445 char_u *arg_subsc;
1446 char_u *tofree;
1447 typval_T tv;
1448
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001449 while (!ends_excmd2(eap->cmd, arg) && !got_int)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001450 {
1451 if (error || eap->skip)
1452 {
1453 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1454 if (!VIM_ISWHITE(*arg) && !ends_excmd(*arg))
1455 {
1456 emsg_severe = TRUE;
Bram Moolenaar4830c212021-08-14 14:59:27 +02001457 if (!did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00001458 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001459 break;
1460 }
1461 }
1462 else
1463 {
1464 // get_name_len() takes care of expanding curly braces
1465 name_start = name = arg;
1466 len = get_name_len(&arg, &tofree, TRUE, TRUE);
1467 if (len <= 0)
1468 {
1469 // This is mainly to keep test 49 working: when expanding
1470 // curly braces fails overrule the exception error message.
1471 if (len < 0 && !aborting())
1472 {
1473 emsg_severe = TRUE;
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001474 semsg(_(e_invalid_argument_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001475 break;
1476 }
1477 error = TRUE;
1478 }
1479 else
1480 {
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02001481 arg = skipwhite(arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001482 if (tofree != NULL)
1483 name = tofree;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001484 if (eval_variable(name, len, 0, &tv, NULL,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01001485 EVAL_VAR_VERBOSE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001486 error = TRUE;
1487 else
1488 {
1489 // handle d.key, l[idx], f(expr)
1490 arg_subsc = arg;
Bram Moolenaar32884ad2022-01-07 12:45:29 +00001491 if (handle_subscript(&arg, name_start, &tv,
1492 &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001493 error = TRUE;
1494 else
1495 {
1496 if (arg == arg_subsc && len == 2 && name[1] == ':')
1497 {
1498 switch (*name)
1499 {
1500 case 'g': list_glob_vars(first); break;
1501 case 'b': list_buf_vars(first); break;
1502 case 'w': list_win_vars(first); break;
1503 case 't': list_tab_vars(first); break;
1504 case 'v': list_vim_vars(first); break;
1505 case 's': list_script_vars(first); break;
1506 case 'l': list_func_vars(first); break;
1507 default:
Bram Moolenaara6f79292022-01-04 21:30:47 +00001508 semsg(_(e_cant_list_variables_for_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001509 }
1510 }
1511 else
1512 {
1513 char_u numbuf[NUMBUFLEN];
1514 char_u *tf;
1515 int c;
1516 char_u *s;
1517
1518 s = echo_string(&tv, &tf, numbuf, 0);
1519 c = *arg;
1520 *arg = NUL;
1521 list_one_var_a("",
1522 arg == arg_subsc ? name : name_start,
1523 tv.v_type,
1524 s == NULL ? (char_u *)"" : s,
1525 first);
1526 *arg = c;
1527 vim_free(tf);
1528 }
1529 clear_tv(&tv);
1530 }
1531 }
1532 }
1533
1534 vim_free(tofree);
1535 }
1536
1537 arg = skipwhite(arg);
1538 }
1539
1540 return arg;
1541}
1542
1543/*
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001544 * Set an environment variable, part of ex_let_one().
1545 */
1546 static char_u *
1547ex_let_env(
1548 char_u *arg,
1549 typval_T *tv,
1550 int flags,
1551 char_u *endchars,
1552 char_u *op)
1553{
1554 char_u *arg_end = NULL;
1555 char_u *name;
1556 int len;
1557
1558 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1559 && (flags & ASSIGN_FOR_LOOP) == 0)
1560 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001561 emsg(_(e_cannot_lock_environment_variable));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001562 return NULL;
1563 }
1564
1565 // Find the end of the name.
1566 ++arg;
1567 name = arg;
1568 len = get_env_len(&arg);
1569 if (len == 0)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001570 semsg(_(e_invalid_argument_str), name - 1);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001571 else
1572 {
1573 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001574 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001575 else if (endchars != NULL
1576 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
1577 emsg(_(e_unexpected_characters_in_let));
1578 else if (!check_secure())
1579 {
1580 char_u *tofree = NULL;
1581 int c1 = name[len];
1582 char_u *p;
1583
1584 name[len] = NUL;
1585 p = tv_get_string_chk(tv);
1586 if (p != NULL && op != NULL && *op == '.')
1587 {
1588 int mustfree = FALSE;
1589 char_u *s = vim_getenv(name, &mustfree);
1590
1591 if (s != NULL)
1592 {
1593 p = tofree = concat_str(s, p);
1594 if (mustfree)
1595 vim_free(s);
1596 }
1597 }
1598 if (p != NULL)
1599 {
1600 vim_setenv_ext(name, p);
1601 arg_end = arg;
1602 }
1603 name[len] = c1;
1604 vim_free(tofree);
1605 }
1606 }
1607 return arg_end;
1608}
1609
1610/*
1611 * Set an option, part of ex_let_one().
1612 */
1613 static char_u *
1614ex_let_option(
1615 char_u *arg,
1616 typval_T *tv,
1617 int flags,
1618 char_u *endchars,
1619 char_u *op)
1620{
1621 char_u *p;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001622 int scope;
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001623 char_u *arg_end = NULL;
1624
1625 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1626 && (flags & ASSIGN_FOR_LOOP) == 0)
1627 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001628 emsg(_(e_cannot_lock_option));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001629 return NULL;
1630 }
1631
1632 // Find the end of the name.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001633 p = find_option_end(&arg, &scope);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001634 if (p == NULL || (endchars != NULL
1635 && vim_strchr(endchars, *skipwhite(p)) == NULL))
1636 emsg(_(e_unexpected_characters_in_let));
1637 else
1638 {
1639 int c1;
1640 long n = 0;
1641 getoption_T opt_type;
1642 long numval;
1643 char_u *stringval = NULL;
1644 char_u *s = NULL;
1645 int failed = FALSE;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001646 int opt_p_flags;
1647 char_u *tofree = NULL;
Bram Moolenaar92c33eb2021-12-07 11:03:39 +00001648 char_u numbuf[NUMBUFLEN];
1649
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001650 c1 = *p;
1651 *p = NUL;
1652
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001653 opt_type = get_option_value(arg, &numval, &stringval, &opt_p_flags,
1654 scope);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001655 if ((opt_type == gov_bool
1656 || opt_type == gov_number
1657 || opt_type == gov_hidden_bool
1658 || opt_type == gov_hidden_number)
1659 && (tv->v_type != VAR_STRING || !in_vim9script()))
1660 {
1661 if (opt_type == gov_bool || opt_type == gov_hidden_bool)
1662 // bool, possibly hidden
1663 n = (long)tv_get_bool(tv);
1664 else
1665 // number, possibly hidden
1666 n = (long)tv_get_number(tv);
1667 }
1668
Bram Moolenaaref082e12021-12-12 21:02:03 +00001669 if ((opt_p_flags & P_FUNC) && (tv->v_type == VAR_PARTIAL
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001670 || tv->v_type == VAR_FUNC))
1671 {
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001672 // If the option can be set to a function reference or a lambda
1673 // and the passed value is a function reference, then convert it to
1674 // the name (string) of the function reference.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001675 s = tv2string(tv, &tofree, numbuf, 0);
1676 }
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001677 // Avoid setting a string option to the text "v:false" or similar.
1678 // In Vim9 script also don't convert a number to string.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001679 else if (tv->v_type != VAR_BOOL && tv->v_type != VAR_SPECIAL
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001680 && (!in_vim9script() || tv->v_type != VAR_NUMBER))
1681 s = tv_get_string_chk(tv);
1682
1683 if (op != NULL && *op != '=')
1684 {
1685 if (((opt_type == gov_bool || opt_type == gov_number) && *op == '.')
1686 || (opt_type == gov_string && *op != '.'))
1687 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001688 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001689 failed = TRUE; // don't set the value
1690
1691 }
1692 else
1693 {
1694 // number, in legacy script also bool
1695 if (opt_type == gov_number
1696 || (opt_type == gov_bool && !in_vim9script()))
1697 {
1698 switch (*op)
1699 {
1700 case '+': n = numval + n; break;
1701 case '-': n = numval - n; break;
1702 case '*': n = numval * n; break;
1703 case '/': n = (long)num_divide(numval, n,
1704 &failed); break;
1705 case '%': n = (long)num_modulus(numval, n,
1706 &failed); break;
1707 }
1708 s = NULL;
1709 }
1710 else if (opt_type == gov_string
1711 && stringval != NULL && s != NULL)
1712 {
1713 // string
1714 s = concat_str(stringval, s);
1715 vim_free(stringval);
1716 stringval = s;
1717 }
1718 }
1719 }
1720
1721 if (!failed)
1722 {
1723 if (opt_type != gov_string || s != NULL)
1724 {
Bram Moolenaar8ccbbeb2022-03-02 19:49:38 +00001725 char *err = set_option_value(arg, n, s, scope);
1726
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001727 arg_end = p;
Bram Moolenaar8ccbbeb2022-03-02 19:49:38 +00001728 if (err != NULL)
1729 emsg(_(err));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001730 }
1731 else
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001732 emsg(_(e_string_required));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001733 }
1734 *p = c1;
1735 vim_free(stringval);
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001736 vim_free(tofree);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001737 }
1738 return arg_end;
1739}
1740
1741/*
1742 * Set a register, part of ex_let_one().
1743 */
1744 static char_u *
1745ex_let_register(
1746 char_u *arg,
1747 typval_T *tv,
1748 int flags,
1749 char_u *endchars,
1750 char_u *op)
1751{
1752 char_u *arg_end = NULL;
1753
1754 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1755 && (flags & ASSIGN_FOR_LOOP) == 0)
1756 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001757 emsg(_(e_cannot_lock_register));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001758 return NULL;
1759 }
1760 ++arg;
1761 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001762 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001763 else if (endchars != NULL
1764 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
1765 emsg(_(e_unexpected_characters_in_let));
1766 else
1767 {
1768 char_u *ptofree = NULL;
1769 char_u *p;
1770
1771 p = tv_get_string_chk(tv);
1772 if (p != NULL && op != NULL && *op == '.')
1773 {
1774 char_u *s = get_reg_contents(*arg == '@'
1775 ? '"' : *arg, GREG_EXPR_SRC);
1776
1777 if (s != NULL)
1778 {
1779 p = ptofree = concat_str(s, p);
1780 vim_free(s);
1781 }
1782 }
1783 if (p != NULL)
1784 {
1785 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
1786 arg_end = arg + 1;
1787 }
1788 vim_free(ptofree);
1789 }
1790 return arg_end;
1791}
1792
1793/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001794 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
1795 * Returns a pointer to the char just after the var name.
1796 * Returns NULL if there is an error.
1797 */
1798 static char_u *
1799ex_let_one(
1800 char_u *arg, // points to variable name
1801 typval_T *tv, // value to assign to variable
1802 int copy, // copy value from "tv"
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001803 int flags, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001804 char_u *endchars, // valid chars after variable name or NULL
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001805 char_u *op, // "+", "-", "." or NULL
1806 int var_idx) // variable index for "let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001807{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001808 char_u *arg_end = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001809
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001810 if (in_vim9script() && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001811 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001812 && vim_strchr((char_u *)"$@&", *arg) != NULL)
1813 {
1814 vim9_declare_error(arg);
1815 return NULL;
1816 }
1817
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001818 if (*arg == '$')
1819 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001820 // ":let $VAR = expr": Set environment variable.
1821 return ex_let_env(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001822 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001823 else if (*arg == '&')
1824 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001825 // ":let &option = expr": Set option value.
1826 // ":let &l:option = expr": Set local option value.
1827 // ":let &g:option = expr": Set global option value.
1828 // ":for &ts in range(8)": Set option value for for loop
1829 return ex_let_option(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001830 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001831 else if (*arg == '@')
1832 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001833 // ":let @r = expr": Set register contents.
1834 return ex_let_register(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001835 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001836 else if (eval_isnamec1(*arg) || *arg == '{')
1837 {
1838 lval_T lv;
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001839 char_u *p;
Bram Moolenaar22ebd172022-04-01 15:26:58 +01001840 int lval_flags = (flags & (ASSIGN_NO_DECL | ASSIGN_DECL))
1841 ? GLV_NO_DECL : 0;
1842 if (op != NULL && *op != '=')
1843 lval_flags |= GLV_ASSIGN_WITH_OP;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001844
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001845 // ":let var = expr": Set internal variable.
1846 // ":let var: type = expr": Set internal variable with type.
1847 // ":let {expr} = expr": Idem, name made with curly braces
Bram Moolenaar22ebd172022-04-01 15:26:58 +01001848 p = get_lval(arg, tv, &lv, FALSE, FALSE, lval_flags, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001849 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001850 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001851 if (endchars != NULL && vim_strchr(endchars,
1852 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001853 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001854 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001855 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001856 else
1857 {
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001858 set_var_lval(&lv, p, tv, copy, flags, op, var_idx);
Bram Moolenaara3589a02021-04-14 13:30:46 +02001859 arg_end = lv.ll_name_end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001860 }
1861 }
1862 clear_lval(&lv);
1863 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001864 else
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001865 semsg(_(e_invalid_argument_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001866
1867 return arg_end;
1868}
1869
1870/*
1871 * ":unlet[!] var1 ... " command.
1872 */
1873 void
1874ex_unlet(exarg_T *eap)
1875{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001876 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001877}
1878
1879/*
1880 * ":lockvar" and ":unlockvar" commands
1881 */
1882 void
1883ex_lockvar(exarg_T *eap)
1884{
1885 char_u *arg = eap->arg;
1886 int deep = 2;
1887
1888 if (eap->forceit)
1889 deep = -1;
1890 else if (vim_isdigit(*arg))
1891 {
1892 deep = getdigits(&arg);
1893 arg = skipwhite(arg);
1894 }
1895
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001896 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001897}
1898
1899/*
1900 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001901 * Also used for Vim9 script. "callback" is invoked as:
1902 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001903 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001904 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001905ex_unletlock(
1906 exarg_T *eap,
1907 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001908 int deep,
1909 int glv_flags,
1910 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1911 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001912{
1913 char_u *arg = argstart;
1914 char_u *name_end;
1915 int error = FALSE;
1916 lval_T lv;
1917
1918 do
1919 {
1920 if (*arg == '$')
1921 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001922 lv.ll_name = arg;
1923 lv.ll_tv = NULL;
1924 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001925 if (get_env_len(&arg) == 0)
1926 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001927 semsg(_(e_invalid_argument_str), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001928 return;
1929 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001930 if (!error && !eap->skip
1931 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1932 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001933 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001934 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001935 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001936 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001937 // Parse the name and find the end.
1938 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
Bram Moolenaarc3689572021-01-01 19:40:02 +01001939 glv_flags | GLV_NO_DECL, FNE_CHECK_START);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001940 if (lv.ll_name == NULL)
1941 error = TRUE; // error but continue parsing
1942 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1943 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001944 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001945 if (name_end != NULL)
1946 {
1947 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00001948 semsg(_(e_trailing_characters_str), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001949 }
1950 if (!(eap->skip || error))
1951 clear_lval(&lv);
1952 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001953 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001954
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001955 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001956 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001957 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001958
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001959 if (!eap->skip)
1960 clear_lval(&lv);
1961 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001962
1963 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001964 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001965
Bram Moolenaar63b91732021-08-05 20:40:03 +02001966 set_nextcmd(eap, arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001967}
1968
1969 static int
1970do_unlet_var(
1971 lval_T *lp,
1972 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001973 exarg_T *eap,
1974 int deep UNUSED,
1975 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001976{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001977 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001978 int ret = OK;
1979 int cc;
1980
1981 if (lp->ll_tv == NULL)
1982 {
1983 cc = *name_end;
1984 *name_end = NUL;
1985
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001986 // Environment variable, normal name or expanded name.
1987 if (*lp->ll_name == '$')
LemonBoy77142312022-04-15 20:50:46 +01001988 vim_unsetenv_ext(lp->ll_name + 1);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001989 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001990 ret = FAIL;
1991 *name_end = cc;
1992 }
1993 else if ((lp->ll_list != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001994 && value_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001995 || (lp->ll_dict != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001996 && value_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001997 return FAIL;
1998 else if (lp->ll_range)
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00001999 list_unlet_range(lp->ll_list, lp->ll_li, lp->ll_n1,
2000 !lp->ll_empty2, lp->ll_n2);
2001 else if (lp->ll_list != NULL)
2002 // unlet a List item.
2003 listitem_remove(lp->ll_list, lp->ll_li);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002004 else
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002005 // unlet a Dictionary item.
2006 dictitem_remove(lp->ll_dict, lp->ll_di);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002007
2008 return ret;
2009}
2010
2011/*
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002012 * Unlet one item or a range of items from a list.
2013 * Return OK or FAIL.
2014 */
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002015 void
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002016list_unlet_range(
2017 list_T *l,
2018 listitem_T *li_first,
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002019 long n1_arg,
2020 int has_n2,
2021 long n2)
2022{
2023 listitem_T *li = li_first;
2024 int n1 = n1_arg;
2025
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002026 // Delete a range of List items.
2027 li = li_first;
2028 n1 = n1_arg;
2029 while (li != NULL && (!has_n2 || n2 >= n1))
2030 {
2031 listitem_T *next = li->li_next;
2032
2033 listitem_remove(l, li);
2034 li = next;
2035 ++n1;
2036 }
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002037}
2038/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002039 * "unlet" a variable. Return OK if it existed, FAIL if not.
2040 * When "forceit" is TRUE don't complain if the variable doesn't exist.
2041 */
2042 int
2043do_unlet(char_u *name, int forceit)
2044{
2045 hashtab_T *ht;
2046 hashitem_T *hi;
mityu8be36ee2022-05-25 17:29:46 +01002047 char_u *varname = NULL; // init to shut up gcc
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002048 dict_T *d;
2049 dictitem_T *di;
2050
Bram Moolenaar9aed7292020-12-18 15:38:00 +01002051 // can't :unlet a script variable in Vim9 script
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002052 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002053 return FAIL;
2054
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002055 ht = find_var_ht(name, &varname);
Bram Moolenaar9aed7292020-12-18 15:38:00 +01002056
2057 // can't :unlet a script variable in Vim9 script from a function
2058 if (ht == get_script_local_ht()
2059 && SCRIPT_ID_VALID(current_sctx.sc_sid)
2060 && SCRIPT_ITEM(current_sctx.sc_sid)->sn_version
2061 == SCRIPT_VERSION_VIM9
2062 && check_vim9_unlet(name) == FAIL)
2063 return FAIL;
2064
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002065 if (ht != NULL && *varname != NUL)
2066 {
2067 d = get_current_funccal_dict(ht);
2068 if (d == NULL)
2069 {
2070 if (ht == &globvarht)
2071 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002072 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002073 d = &vimvardict;
2074 else
2075 {
2076 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
2077 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
2078 }
2079 if (d == NULL)
2080 {
2081 internal_error("do_unlet()");
2082 return FAIL;
2083 }
2084 }
2085 hi = hash_find(ht, varname);
2086 if (HASHITEM_EMPTY(hi))
2087 hi = find_hi_in_scoped_ht(name, &ht);
2088 if (hi != NULL && !HASHITEM_EMPTY(hi))
2089 {
2090 di = HI2DI(hi);
2091 if (var_check_fixed(di->di_flags, name, FALSE)
2092 || var_check_ro(di->di_flags, name, FALSE)
Bram Moolenaara187c432020-09-16 21:08:28 +02002093 || value_check_lock(d->dv_lock, name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002094 return FAIL;
2095
2096 delete_var(ht, hi);
2097 return OK;
2098 }
2099 }
2100 if (forceit)
2101 return OK;
Bram Moolenaare1242042021-12-16 20:56:57 +00002102 semsg(_(e_no_such_variable_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002103 return FAIL;
2104}
2105
2106/*
2107 * Lock or unlock variable indicated by "lp".
2108 * "deep" is the levels to go (-1 for unlimited);
2109 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
2110 */
2111 static int
2112do_lock_var(
2113 lval_T *lp,
2114 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002115 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002116 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002117 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002118{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002119 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002120 int ret = OK;
2121 int cc;
2122 dictitem_T *di;
2123
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002124 if (lp->ll_tv == NULL)
2125 {
2126 cc = *name_end;
2127 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002128 if (*lp->ll_name == '$')
2129 {
Bram Moolenaar3a846e62022-01-01 16:21:00 +00002130 semsg(_(e_cannot_lock_or_unlock_variable_str), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002131 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002132 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002133 else
2134 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002135 // Normal name or expanded name.
2136 di = find_var(lp->ll_name, NULL, TRUE);
2137 if (di == NULL)
Bram Moolenaar04b568b2021-11-22 21:58:41 +00002138 {
2139 if (in_vim9script())
2140 semsg(_(e_cannot_find_variable_to_unlock_str),
2141 lp->ll_name);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002142 ret = FAIL;
Bram Moolenaar04b568b2021-11-22 21:58:41 +00002143 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002144 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002145 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01002146 if ((di->di_flags & DI_FLAGS_FIX)
2147 && di->di_tv.v_type != VAR_DICT
2148 && di->di_tv.v_type != VAR_LIST)
2149 {
2150 // For historic reasons this error is not given for a list
2151 // or dict. E.g., the b: dict could be locked/unlocked.
2152 semsg(_(e_cannot_lock_or_unlock_variable_str), lp->ll_name);
2153 ret = FAIL;
2154 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002155 else
Bram Moolenaar7a411a32022-04-04 14:58:06 +01002156 {
2157 if (in_vim9script())
2158 {
2159 svar_T *sv = find_typval_in_script(&di->di_tv,
2160 0, FALSE);
2161
2162 if (sv != NULL && sv->sv_const != 0)
2163 {
2164 semsg(_(e_cannot_change_readonly_variable_str),
2165 lp->ll_name);
2166 ret = FAIL;
2167 }
2168 }
2169
2170 if (ret == OK)
2171 {
2172 if (lock)
2173 di->di_flags |= DI_FLAGS_LOCK;
2174 else
2175 di->di_flags &= ~DI_FLAGS_LOCK;
2176 if (deep != 0)
2177 item_lock(&di->di_tv, deep, lock, FALSE);
2178 }
2179 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002180 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002181 }
2182 *name_end = cc;
2183 }
Bram Moolenaara187c432020-09-16 21:08:28 +02002184 else if (deep == 0)
2185 {
2186 // nothing to do
2187 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002188 else if (lp->ll_range)
2189 {
2190 listitem_T *li = lp->ll_li;
2191
2192 // (un)lock a range of List items.
2193 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
2194 {
Bram Moolenaar021bda52020-08-17 21:07:22 +02002195 item_lock(&li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002196 li = li->li_next;
2197 ++lp->ll_n1;
2198 }
2199 }
2200 else if (lp->ll_list != NULL)
2201 // (un)lock a List item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002202 item_lock(&lp->ll_li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002203 else
2204 // (un)lock a Dictionary item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002205 item_lock(&lp->ll_di->di_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002206
2207 return ret;
2208}
2209
2210/*
2211 * Lock or unlock an item. "deep" is nr of levels to go.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002212 * When "check_refcount" is TRUE do not lock a list or dict with a reference
2213 * count larger than 1.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002214 */
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02002215 void
Bram Moolenaar021bda52020-08-17 21:07:22 +02002216item_lock(typval_T *tv, int deep, int lock, int check_refcount)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002217{
2218 static int recurse = 0;
2219 list_T *l;
2220 listitem_T *li;
2221 dict_T *d;
2222 blob_T *b;
2223 hashitem_T *hi;
2224 int todo;
2225
2226 if (recurse >= DICT_MAXNEST)
2227 {
Bram Moolenaar677658a2022-01-05 16:09:06 +00002228 emsg(_(e_variable_nested_too_deep_for_unlock));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002229 return;
2230 }
2231 if (deep == 0)
2232 return;
2233 ++recurse;
2234
2235 // lock/unlock the item itself
2236 if (lock)
2237 tv->v_lock |= VAR_LOCKED;
2238 else
2239 tv->v_lock &= ~VAR_LOCKED;
2240
2241 switch (tv->v_type)
2242 {
2243 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02002244 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002245 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002246 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002247 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002248 case VAR_STRING:
2249 case VAR_FUNC:
2250 case VAR_PARTIAL:
2251 case VAR_FLOAT:
2252 case VAR_SPECIAL:
2253 case VAR_JOB:
2254 case VAR_CHANNEL:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02002255 case VAR_INSTR:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002256 break;
2257
2258 case VAR_BLOB:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002259 if ((b = tv->vval.v_blob) != NULL
2260 && !(check_refcount && b->bv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002261 {
2262 if (lock)
2263 b->bv_lock |= VAR_LOCKED;
2264 else
2265 b->bv_lock &= ~VAR_LOCKED;
2266 }
2267 break;
2268 case VAR_LIST:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002269 if ((l = tv->vval.v_list) != NULL
2270 && !(check_refcount && l->lv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002271 {
2272 if (lock)
2273 l->lv_lock |= VAR_LOCKED;
2274 else
2275 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar70c43d82022-01-26 21:01:15 +00002276 if (deep < 0 || deep > 1)
2277 {
2278 if (l->lv_first == &range_list_item)
2279 l->lv_lock |= VAR_ITEMS_LOCKED;
2280 else
2281 {
2282 // recursive: lock/unlock the items the List contains
2283 CHECK_LIST_MATERIALIZE(l);
2284 FOR_ALL_LIST_ITEMS(l, li) item_lock(&li->li_tv,
2285 deep - 1, lock, check_refcount);
2286 }
2287 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002288 }
2289 break;
2290 case VAR_DICT:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002291 if ((d = tv->vval.v_dict) != NULL
2292 && !(check_refcount && d->dv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002293 {
2294 if (lock)
2295 d->dv_lock |= VAR_LOCKED;
2296 else
2297 d->dv_lock &= ~VAR_LOCKED;
2298 if (deep < 0 || deep > 1)
2299 {
2300 // recursive: lock/unlock the items the List contains
2301 todo = (int)d->dv_hashtab.ht_used;
2302 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
2303 {
2304 if (!HASHITEM_EMPTY(hi))
2305 {
2306 --todo;
Bram Moolenaar021bda52020-08-17 21:07:22 +02002307 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock,
2308 check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002309 }
2310 }
2311 }
2312 }
2313 }
2314 --recurse;
2315}
2316
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002317#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
2318/*
2319 * Delete all "menutrans_" variables.
2320 */
2321 void
2322del_menutrans_vars(void)
2323{
2324 hashitem_T *hi;
2325 int todo;
2326
2327 hash_lock(&globvarht);
2328 todo = (int)globvarht.ht_used;
2329 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
2330 {
2331 if (!HASHITEM_EMPTY(hi))
2332 {
2333 --todo;
2334 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
2335 delete_var(&globvarht, hi);
2336 }
2337 }
2338 hash_unlock(&globvarht);
2339}
2340#endif
2341
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002342/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002343 * Local string buffer for the next two functions to store a variable name
2344 * with its prefix. Allocated in cat_prefix_varname(), freed later in
2345 * get_user_var_name().
2346 */
2347
2348static char_u *varnamebuf = NULL;
2349static int varnamebuflen = 0;
2350
2351/*
2352 * Function to concatenate a prefix and a variable name.
2353 */
Bram Moolenaar1bb4de52021-01-13 19:48:46 +01002354 char_u *
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002355cat_prefix_varname(int prefix, char_u *name)
2356{
2357 int len;
2358
2359 len = (int)STRLEN(name) + 3;
2360 if (len > varnamebuflen)
2361 {
2362 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002363 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002364 varnamebuf = alloc(len);
2365 if (varnamebuf == NULL)
2366 {
2367 varnamebuflen = 0;
2368 return NULL;
2369 }
2370 varnamebuflen = len;
2371 }
2372 *varnamebuf = prefix;
2373 varnamebuf[1] = ':';
2374 STRCPY(varnamebuf + 2, name);
2375 return varnamebuf;
2376}
2377
2378/*
2379 * Function given to ExpandGeneric() to obtain the list of user defined
2380 * (global/buffer/window/built-in) variable names.
2381 */
2382 char_u *
2383get_user_var_name(expand_T *xp, int idx)
2384{
2385 static long_u gdone;
2386 static long_u bdone;
2387 static long_u wdone;
2388 static long_u tdone;
2389 static int vidx;
2390 static hashitem_T *hi;
2391 hashtab_T *ht;
2392
2393 if (idx == 0)
2394 {
2395 gdone = bdone = wdone = vidx = 0;
2396 tdone = 0;
2397 }
2398
2399 // Global variables
2400 if (gdone < globvarht.ht_used)
2401 {
2402 if (gdone++ == 0)
2403 hi = globvarht.ht_array;
2404 else
2405 ++hi;
2406 while (HASHITEM_EMPTY(hi))
2407 ++hi;
2408 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
2409 return cat_prefix_varname('g', hi->hi_key);
2410 return hi->hi_key;
2411 }
2412
2413 // b: variables
Bram Moolenaar0f6e28f2022-02-20 20:49:35 +00002414 ht = &prevwin_curwin()->w_buffer->b_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002415 if (bdone < ht->ht_used)
2416 {
2417 if (bdone++ == 0)
2418 hi = ht->ht_array;
2419 else
2420 ++hi;
2421 while (HASHITEM_EMPTY(hi))
2422 ++hi;
2423 return cat_prefix_varname('b', hi->hi_key);
2424 }
2425
2426 // w: variables
Bram Moolenaar0f6e28f2022-02-20 20:49:35 +00002427 ht = &prevwin_curwin()->w_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002428 if (wdone < ht->ht_used)
2429 {
2430 if (wdone++ == 0)
2431 hi = ht->ht_array;
2432 else
2433 ++hi;
2434 while (HASHITEM_EMPTY(hi))
2435 ++hi;
2436 return cat_prefix_varname('w', hi->hi_key);
2437 }
2438
2439 // t: variables
2440 ht = &curtab->tp_vars->dv_hashtab;
2441 if (tdone < ht->ht_used)
2442 {
2443 if (tdone++ == 0)
2444 hi = ht->ht_array;
2445 else
2446 ++hi;
2447 while (HASHITEM_EMPTY(hi))
2448 ++hi;
2449 return cat_prefix_varname('t', hi->hi_key);
2450 }
2451
2452 // v: variables
2453 if (vidx < VV_LEN)
2454 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
2455
2456 VIM_CLEAR(varnamebuf);
2457 varnamebuflen = 0;
2458 return NULL;
2459}
2460
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002461 char *
2462get_var_special_name(int nr)
2463{
2464 switch (nr)
2465 {
Bram Moolenaara8b8af12021-01-01 15:11:04 +01002466 case VVAL_FALSE: return in_vim9script() ? "false" : "v:false";
2467 case VVAL_TRUE: return in_vim9script() ? "true" : "v:true";
Bram Moolenaar67977822021-01-03 21:53:53 +01002468 case VVAL_NULL: return in_vim9script() ? "null" : "v:null";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002469 case VVAL_NONE: return "v:none";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002470 }
2471 internal_error("get_var_special_name()");
2472 return "42";
2473}
2474
2475/*
2476 * Returns the global variable dictionary
2477 */
2478 dict_T *
2479get_globvar_dict(void)
2480{
2481 return &globvardict;
2482}
2483
2484/*
2485 * Returns the global variable hash table
2486 */
2487 hashtab_T *
2488get_globvar_ht(void)
2489{
2490 return &globvarht;
2491}
2492
2493/*
2494 * Returns the v: variable dictionary
2495 */
2496 dict_T *
2497get_vimvar_dict(void)
2498{
2499 return &vimvardict;
2500}
2501
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002502/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002503 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002504 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002505 */
2506 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002507find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002508{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002509 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2510 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002511
2512 if (di == NULL)
2513 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002514 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002515 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2516 return (int)(vv - vimvars);
2517}
2518
2519
2520/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002521 * Set type of v: variable to "type".
2522 */
2523 void
2524set_vim_var_type(int idx, vartype_T type)
2525{
Bram Moolenaard787e402021-12-24 21:36:12 +00002526 vimvars[idx].vv_tv_type = type;
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002527}
2528
2529/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002530 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002531 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002532 */
2533 void
2534set_vim_var_nr(int idx, varnumber_T val)
2535{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002536 vimvars[idx].vv_nr = val;
2537}
2538
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002539 char *
2540get_vim_var_name(int idx)
2541{
2542 return vimvars[idx].vv_name;
2543}
2544
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002545/*
2546 * Get typval_T v: variable value.
2547 */
2548 typval_T *
2549get_vim_var_tv(int idx)
2550{
2551 return &vimvars[idx].vv_tv;
2552}
2553
Bram Moolenaard787e402021-12-24 21:36:12 +00002554 type_T *
2555get_vim_var_type(int idx, garray_T *type_list)
2556{
2557 if (vimvars[idx].vv_type != NULL)
2558 return vimvars[idx].vv_type;
2559 return typval2type_vimvar(&vimvars[idx].vv_tv, type_list);
2560}
2561
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002562/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002563 * Set v: variable to "tv". Only accepts the same type.
2564 * Takes over the value of "tv".
2565 */
2566 int
2567set_vim_var_tv(int idx, typval_T *tv)
2568{
Bram Moolenaard787e402021-12-24 21:36:12 +00002569 if (vimvars[idx].vv_tv_type != tv->v_type)
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002570 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002571 emsg(_(e_type_mismatch_for_v_variable));
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002572 clear_tv(tv);
2573 return FAIL;
2574 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002575 // VV_RO is also checked when compiling, but let's check here as well.
2576 if (vimvars[idx].vv_flags & VV_RO)
2577 {
Bram Moolenaard8e44472021-07-21 22:20:33 +02002578 semsg(_(e_cannot_change_readonly_variable_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002579 return FAIL;
2580 }
2581 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2582 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00002583 semsg(_(e_cannot_set_variable_in_sandbox_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002584 return FAIL;
2585 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002586 clear_tv(&vimvars[idx].vv_di.di_tv);
2587 vimvars[idx].vv_di.di_tv = *tv;
2588 return OK;
2589}
2590
2591/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002592 * Get number v: variable value.
2593 */
2594 varnumber_T
2595get_vim_var_nr(int idx)
2596{
2597 return vimvars[idx].vv_nr;
2598}
2599
2600/*
2601 * Get string v: variable value. Uses a static buffer, can only be used once.
2602 * If the String variable has never been set, return an empty string.
2603 * Never returns NULL;
2604 */
2605 char_u *
2606get_vim_var_str(int idx)
2607{
2608 return tv_get_string(&vimvars[idx].vv_tv);
2609}
2610
2611/*
2612 * Get List v: variable value. Caller must take care of reference count when
2613 * needed.
2614 */
2615 list_T *
2616get_vim_var_list(int idx)
2617{
2618 return vimvars[idx].vv_list;
2619}
2620
2621/*
2622 * Get Dict v: variable value. Caller must take care of reference count when
2623 * needed.
2624 */
2625 dict_T *
2626get_vim_var_dict(int idx)
2627{
2628 return vimvars[idx].vv_dict;
2629}
2630
2631/*
2632 * Set v:char to character "c".
2633 */
2634 void
2635set_vim_var_char(int c)
2636{
2637 char_u buf[MB_MAXBYTES + 1];
2638
2639 if (has_mbyte)
2640 buf[(*mb_char2bytes)(c, buf)] = NUL;
2641 else
2642 {
2643 buf[0] = c;
2644 buf[1] = NUL;
2645 }
2646 set_vim_var_string(VV_CHAR, buf, -1);
2647}
2648
2649/*
2650 * Set v:count to "count" and v:count1 to "count1".
2651 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2652 */
2653 void
2654set_vcount(
2655 long count,
2656 long count1,
2657 int set_prevcount)
2658{
2659 if (set_prevcount)
2660 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2661 vimvars[VV_COUNT].vv_nr = count;
2662 vimvars[VV_COUNT1].vv_nr = count1;
2663}
2664
2665/*
2666 * Save variables that might be changed as a side effect. Used when executing
2667 * a timer callback.
2668 */
2669 void
2670save_vimvars(vimvars_save_T *vvsave)
2671{
2672 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2673 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2674 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2675}
2676
2677/*
2678 * Restore variables saved by save_vimvars().
2679 */
2680 void
2681restore_vimvars(vimvars_save_T *vvsave)
2682{
2683 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2684 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2685 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2686}
2687
2688/*
2689 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2690 * value.
2691 */
2692 void
2693set_vim_var_string(
2694 int idx,
2695 char_u *val,
2696 int len) // length of "val" to use or -1 (whole string)
2697{
2698 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002699 vimvars[idx].vv_tv_type = VAR_STRING;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002700 if (val == NULL)
2701 vimvars[idx].vv_str = NULL;
2702 else if (len == -1)
2703 vimvars[idx].vv_str = vim_strsave(val);
2704 else
2705 vimvars[idx].vv_str = vim_strnsave(val, len);
2706}
2707
2708/*
2709 * Set List v: variable to "val".
2710 */
2711 void
2712set_vim_var_list(int idx, list_T *val)
2713{
2714 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002715 vimvars[idx].vv_tv_type = VAR_LIST;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002716 vimvars[idx].vv_list = val;
2717 if (val != NULL)
2718 ++val->lv_refcount;
2719}
2720
2721/*
2722 * Set Dictionary v: variable to "val".
2723 */
2724 void
2725set_vim_var_dict(int idx, dict_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_DICT;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002729 vimvars[idx].vv_dict = val;
2730 if (val != NULL)
2731 {
2732 ++val->dv_refcount;
2733 dict_set_items_ro(val);
2734 }
2735}
2736
2737/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002738 * Set the v:argv list.
2739 */
2740 void
2741set_argv_var(char **argv, int argc)
2742{
2743 list_T *l = list_alloc();
2744 int i;
2745
2746 if (l == NULL)
2747 getout(1);
2748 l->lv_lock = VAR_FIXED;
2749 for (i = 0; i < argc; ++i)
2750 {
2751 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2752 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002753 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002754 }
2755 set_vim_var_list(VV_ARGV, l);
2756}
2757
2758/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002759 * Reset v:register, taking the 'clipboard' setting into account.
2760 */
2761 void
2762reset_reg_var(void)
2763{
2764 int regname = 0;
2765
2766 // Adjust the register according to 'clipboard', so that when
2767 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2768#ifdef FEAT_CLIPBOARD
2769 adjust_clip_reg(&regname);
2770#endif
2771 set_reg_var(regname);
2772}
2773
2774/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002775 * Set v:register if needed.
2776 */
2777 void
2778set_reg_var(int c)
2779{
2780 char_u regname;
2781
2782 if (c == 0 || c == ' ')
2783 regname = '"';
2784 else
2785 regname = c;
2786 // Avoid free/alloc when the value is already right.
2787 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2788 set_vim_var_string(VV_REG, &regname, 1);
2789}
2790
2791/*
2792 * Get or set v:exception. If "oldval" == NULL, return the current value.
2793 * Otherwise, restore the value to "oldval" and return NULL.
2794 * Must always be called in pairs to save and restore v:exception! Does not
2795 * take care of memory allocations.
2796 */
2797 char_u *
2798v_exception(char_u *oldval)
2799{
2800 if (oldval == NULL)
2801 return vimvars[VV_EXCEPTION].vv_str;
2802
2803 vimvars[VV_EXCEPTION].vv_str = oldval;
2804 return NULL;
2805}
2806
2807/*
2808 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2809 * Otherwise, restore the value to "oldval" and return NULL.
2810 * Must always be called in pairs to save and restore v:throwpoint! Does not
2811 * take care of memory allocations.
2812 */
2813 char_u *
2814v_throwpoint(char_u *oldval)
2815{
2816 if (oldval == NULL)
2817 return vimvars[VV_THROWPOINT].vv_str;
2818
2819 vimvars[VV_THROWPOINT].vv_str = oldval;
2820 return NULL;
2821}
2822
2823/*
2824 * Set v:cmdarg.
2825 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2826 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2827 * Must always be called in pairs!
2828 */
2829 char_u *
2830set_cmdarg(exarg_T *eap, char_u *oldarg)
2831{
2832 char_u *oldval;
2833 char_u *newval;
2834 unsigned len;
2835
2836 oldval = vimvars[VV_CMDARG].vv_str;
2837 if (eap == NULL)
2838 {
2839 vim_free(oldval);
2840 vimvars[VV_CMDARG].vv_str = oldarg;
2841 return NULL;
2842 }
2843
2844 if (eap->force_bin == FORCE_BIN)
2845 len = 6;
2846 else if (eap->force_bin == FORCE_NOBIN)
2847 len = 8;
2848 else
2849 len = 0;
2850
2851 if (eap->read_edit)
2852 len += 7;
2853
2854 if (eap->force_ff != 0)
2855 len += 10; // " ++ff=unix"
2856 if (eap->force_enc != 0)
2857 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2858 if (eap->bad_char != 0)
2859 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2860
2861 newval = alloc(len + 1);
2862 if (newval == NULL)
2863 return NULL;
2864
2865 if (eap->force_bin == FORCE_BIN)
2866 sprintf((char *)newval, " ++bin");
2867 else if (eap->force_bin == FORCE_NOBIN)
2868 sprintf((char *)newval, " ++nobin");
2869 else
2870 *newval = NUL;
2871
2872 if (eap->read_edit)
2873 STRCAT(newval, " ++edit");
2874
2875 if (eap->force_ff != 0)
2876 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2877 eap->force_ff == 'u' ? "unix"
2878 : eap->force_ff == 'd' ? "dos"
2879 : "mac");
2880 if (eap->force_enc != 0)
2881 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2882 eap->cmd + eap->force_enc);
2883 if (eap->bad_char == BAD_KEEP)
2884 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2885 else if (eap->bad_char == BAD_DROP)
2886 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2887 else if (eap->bad_char != 0)
2888 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2889 vimvars[VV_CMDARG].vv_str = newval;
2890 return oldval;
2891}
2892
2893/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002894 * Get the value of internal variable "name".
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002895 * If "flags" has EVAL_VAR_IMPORT may return a VAR_ANY with v_number set to the
2896 * imported script ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002897 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2898 */
2899 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002900eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002901 char_u *name,
2902 int len, // length of "name"
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002903 scid_T sid, // script ID for imported item or zero
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002904 typval_T *rettv, // NULL when only checking existence
2905 dictitem_T **dip, // non-NULL when typval's dict item is needed
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002906 int flags) // EVAL_VAR_ flags
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002907{
2908 int ret = OK;
2909 typval_T *tv = NULL;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002910 int found = FALSE;
Bram Moolenaarf055d452021-07-08 20:57:24 +02002911 hashtab_T *ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002912 int cc;
Bram Moolenaarc967d572021-07-08 21:38:50 +02002913 type_T *type = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002914
2915 // truncate the name, so that we can use strcmp()
2916 cc = name[len];
2917 name[len] = NUL;
2918
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002919 // Check for local variable when debugging.
2920 if ((tv = lookup_debug_var(name)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002921 {
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002922 // Check for user-defined variables.
Bram Moolenaarc967d572021-07-08 21:38:50 +02002923 dictitem_T *v = find_var(name, &ht, flags & EVAL_VAR_NOAUTOLOAD);
2924
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002925 if (v != NULL)
2926 {
2927 tv = &v->di_tv;
2928 if (dip != NULL)
2929 *dip = v;
2930 }
Bram Moolenaarc967d572021-07-08 21:38:50 +02002931 else
2932 ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002933 }
2934
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002935 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002936 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002937 imported_T *import = NULL;
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002938 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
2939
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002940 if (sid == 0)
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00002941 import = find_imported(p, 0, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002942
2943 // imported variable from another script
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002944 if (import != NULL || sid != 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002945 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002946 if ((flags & EVAL_VAR_IMPORT) == 0)
Bram Moolenaarc620c052020-07-08 15:16:19 +02002947 {
Bram Moolenaar71f21932022-01-07 18:20:55 +00002948 if (SCRIPT_ID_VALID(sid))
Bram Moolenaarc620c052020-07-08 15:16:19 +02002949 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002950 ht = &SCRIPT_VARS(sid);
2951 if (ht != NULL)
2952 {
2953 dictitem_T *v = find_var_in_ht(ht, 0, name,
2954 flags & EVAL_VAR_NOAUTOLOAD);
2955
2956 if (v != NULL)
2957 {
2958 tv = &v->di_tv;
2959 if (dip != NULL)
2960 *dip = v;
2961 }
2962 else
2963 ht = NULL;
2964 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002965 }
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002966 else
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002967 {
2968 if (flags & EVAL_VAR_VERBOSE)
Bram Moolenaardd5893b2022-01-20 21:32:54 +00002969 semsg(_(e_expected_dot_after_name_str), name);
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002970 ret = FAIL;
2971 }
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002972 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002973 else
2974 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002975 if (rettv != NULL)
2976 {
Bram Moolenaar753885b2022-08-24 16:30:36 +01002977 // special value that is used in handle_subscript()
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002978 rettv->v_type = VAR_ANY;
2979 rettv->vval.v_number = sid != 0 ? sid : import->imp_sid;
2980 }
2981 found = TRUE;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002982 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002983 }
Bram Moolenaar052ff292021-12-11 13:54:46 +00002984 else if (in_vim9script() && (flags & EVAL_VAR_NO_FUNC) == 0)
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002985 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002986 int has_g_prefix = STRNCMP(name, "g:", 2) == 0;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002987 ufunc_T *ufunc = find_func(name, FALSE);
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002988
Bram Moolenaarb033ee22021-08-15 16:08:36 +02002989 // In Vim9 script we can get a function reference by using the
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002990 // function name. For a global non-autoload function "g:" is
2991 // required.
2992 if (ufunc != NULL && (has_g_prefix
2993 || !func_requires_g_prefix(ufunc)))
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002994 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002995 found = TRUE;
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002996 if (rettv != NULL)
2997 {
2998 rettv->v_type = VAR_FUNC;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002999 if (has_g_prefix)
Bram Moolenaaref082e12021-12-12 21:02:03 +00003000 // Keep the "g:", otherwise script-local may be
3001 // assumed.
3002 rettv->vval.v_string = vim_strsave(name);
3003 else
3004 rettv->vval.v_string = vim_strsave(ufunc->uf_name);
Bram Moolenaarb033ee22021-08-15 16:08:36 +02003005 if (rettv->vval.v_string != NULL)
3006 func_ref(ufunc->uf_name);
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003007 }
3008 }
3009 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003010 }
3011
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003012 if (!found)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003013 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02003014 if (tv == NULL)
3015 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003016 if (rettv != NULL && (flags & EVAL_VAR_VERBOSE))
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003017 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarc620c052020-07-08 15:16:19 +02003018 ret = FAIL;
3019 }
3020 else if (rettv != NULL)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003021 {
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003022 svar_T *sv = NULL;
3023 int was_assigned = FALSE;
3024
Bram Moolenaar11005b02021-07-11 20:59:00 +02003025 if (ht != NULL && ht == get_script_local_ht()
3026 && tv != &SCRIPT_SV(current_sctx.sc_sid)->sv_var.di_tv)
Bram Moolenaarf055d452021-07-08 20:57:24 +02003027 {
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003028 sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaarf055d452021-07-08 20:57:24 +02003029 if (sv != NULL)
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003030 {
Bram Moolenaarf055d452021-07-08 20:57:24 +02003031 type = sv->sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003032 was_assigned = sv->sv_flags & SVFLAG_ASSIGNED;
3033 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003034 }
3035
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003036 // If a list or dict variable wasn't initialized and has meaningful
3037 // type, do it now. Not for global variables, they are not
3038 // declared.
Bram Moolenaar7a222242022-03-01 19:23:24 +00003039 if (ht != &globvarht)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003040 {
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003041 if (tv->v_type == VAR_DICT && tv->vval.v_dict == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003042 && ((type != NULL && !was_assigned)
Bram Moolenaar859cc212022-03-28 15:22:35 +01003043 || !in_vim9script()))
Bram Moolenaarf055d452021-07-08 20:57:24 +02003044 {
Bram Moolenaar7a222242022-03-01 19:23:24 +00003045 tv->vval.v_dict = dict_alloc();
3046 if (tv->vval.v_dict != NULL)
3047 {
3048 ++tv->vval.v_dict->dv_refcount;
3049 tv->vval.v_dict->dv_type = alloc_type(type);
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003050 if (sv != NULL)
3051 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar7a222242022-03-01 19:23:24 +00003052 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003053 }
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003054 else if (tv->v_type == VAR_LIST && tv->vval.v_list == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003055 && ((type != NULL && !was_assigned)
Bram Moolenaar501f9782022-03-27 16:51:04 +01003056 || !in_vim9script()))
Bram Moolenaarf055d452021-07-08 20:57:24 +02003057 {
Bram Moolenaar7a222242022-03-01 19:23:24 +00003058 tv->vval.v_list = list_alloc();
3059 if (tv->vval.v_list != NULL)
3060 {
3061 ++tv->vval.v_list->lv_refcount;
3062 tv->vval.v_list->lv_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 Moolenaar859cc212022-03-28 15:22:35 +01003067 else if (tv->v_type == VAR_BLOB && tv->vval.v_blob == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003068 && ((type != NULL && !was_assigned)
Bram Moolenaar859cc212022-03-28 15:22:35 +01003069 || !in_vim9script()))
3070 {
3071 tv->vval.v_blob = blob_alloc();
3072 if (tv->vval.v_blob != NULL)
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003073 {
Bram Moolenaar859cc212022-03-28 15:22:35 +01003074 ++tv->vval.v_blob->bv_refcount;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003075 if (sv != NULL)
3076 sv->sv_flags |= SVFLAG_ASSIGNED;
3077 }
Bram Moolenaar859cc212022-03-28 15:22:35 +01003078 }
Bram Moolenaarb7c21af2021-04-18 14:12:31 +02003079 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02003080 copy_tv(tv, rettv);
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003081 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003082 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003083
3084 name[len] = cc;
3085
3086 return ret;
3087}
3088
3089/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003090 * Check if variable "name[len]" is a local variable or an argument.
3091 * If so, "*eval_lavars_used" is set to TRUE.
3092 */
3093 void
3094check_vars(char_u *name, int len)
3095{
3096 int cc;
3097 char_u *varname;
3098 hashtab_T *ht;
3099
3100 if (eval_lavars_used == NULL)
3101 return;
3102
3103 // truncate the name, so that we can use strcmp()
3104 cc = name[len];
3105 name[len] = NUL;
3106
3107 ht = find_var_ht(name, &varname);
3108 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
3109 {
3110 if (find_var(name, NULL, TRUE) != NULL)
3111 *eval_lavars_used = TRUE;
3112 }
3113
3114 name[len] = cc;
3115}
3116
3117/*
3118 * Find variable "name" in the list of variables.
3119 * Return a pointer to it if found, NULL if not found.
3120 * Careful: "a:0" variables don't have a name.
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003121 * When "htp" is not NULL set "htp" to the hashtab_T used.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003122 */
3123 dictitem_T *
3124find_var(char_u *name, hashtab_T **htp, int no_autoload)
3125{
3126 char_u *varname;
3127 hashtab_T *ht;
3128 dictitem_T *ret = NULL;
3129
3130 ht = find_var_ht(name, &varname);
3131 if (htp != NULL)
3132 *htp = ht;
3133 if (ht == NULL)
3134 return NULL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003135 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003136 if (ret != NULL)
3137 return ret;
3138
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003139 // Search in parent scope for lambda
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003140 ret = find_var_in_scoped_ht(name, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003141 if (ret != NULL)
3142 return ret;
3143
3144 // in Vim9 script items without a scope can be script-local
3145 if (in_vim9script() && name[0] != NUL && name[1] != ':')
3146 {
3147 ht = get_script_local_ht();
3148 if (ht != NULL)
3149 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003150 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003151 if (ret != NULL)
3152 {
3153 if (htp != NULL)
3154 *htp = ht;
3155 return ret;
3156 }
3157 }
3158 }
3159
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003160 // When using "vim9script autoload" script-local items are prefixed but can
3161 // be used with s:name.
3162 if (SCRIPT_ID_VALID(current_sctx.sc_sid)
3163 && name[0] == 's' && name[1] == ':')
3164 {
3165 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
3166
3167 if (si->sn_autoload_prefix != NULL)
3168 {
3169 char_u *auto_name = concat_str(si->sn_autoload_prefix, name + 2);
3170
3171 if (auto_name != NULL)
3172 {
3173 ht = &globvarht;
3174 ret = find_var_in_ht(ht, *name, auto_name, TRUE);
Bram Moolenaar130f65d2022-01-13 20:39:41 +00003175 vim_free(auto_name);
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003176 if (ret != NULL)
3177 {
3178 if (htp != NULL)
3179 *htp = ht;
3180 return ret;
3181 }
3182 }
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003183 }
3184 }
3185
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003186 return NULL;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003187}
3188
3189/*
Bram Moolenaar71f21932022-01-07 18:20:55 +00003190 * Like find_var() but if the name starts with <SNR>99_ then look in the
3191 * referenced script (used for a funcref).
3192 */
3193 dictitem_T *
3194find_var_also_in_script(char_u *name, hashtab_T **htp, int no_autoload)
3195{
3196 if (STRNCMP(name, "<SNR>", 5) == 0 && isdigit(name[5]))
3197 {
3198 char_u *p = name + 5;
3199 int sid = getdigits(&p);
3200
3201 if (SCRIPT_ID_VALID(sid) && *p == '_')
3202 {
3203 hashtab_T *ht = &SCRIPT_VARS(sid);
3204
3205 if (ht != NULL)
3206 {
3207 dictitem_T *di = find_var_in_ht(ht, 0, p + 1, no_autoload);
3208
3209 if (di != NULL)
Bram Moolenaaraa9b3ca2022-01-08 15:44:22 +00003210 {
3211 if (htp != NULL)
3212 *htp = ht;
Bram Moolenaar71f21932022-01-07 18:20:55 +00003213 return di;
Bram Moolenaaraa9b3ca2022-01-08 15:44:22 +00003214 }
Bram Moolenaar71f21932022-01-07 18:20:55 +00003215 }
3216 }
3217 }
3218
3219 return find_var(name, htp, no_autoload);
3220}
3221
3222/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003223 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02003224 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003225 * Returns NULL if not found.
3226 */
3227 dictitem_T *
3228find_var_in_ht(
3229 hashtab_T *ht,
3230 int htname,
3231 char_u *varname,
3232 int no_autoload)
3233{
3234 hashitem_T *hi;
3235
3236 if (*varname == NUL)
3237 {
3238 // Must be something like "s:", otherwise "ht" would be NULL.
3239 switch (htname)
3240 {
3241 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
3242 case 'g': return &globvars_var;
3243 case 'v': return &vimvars_var;
3244 case 'b': return &curbuf->b_bufvar;
3245 case 'w': return &curwin->w_winvar;
3246 case 't': return &curtab->tp_winvar;
3247 case 'l': return get_funccal_local_var();
3248 case 'a': return get_funccal_args_var();
3249 }
3250 return NULL;
3251 }
3252
3253 hi = hash_find(ht, varname);
3254 if (HASHITEM_EMPTY(hi))
3255 {
3256 // For global variables we may try auto-loading the script. If it
3257 // worked find the variable again. Don't auto-load a script if it was
3258 // loaded already, otherwise it would be loaded every time when
3259 // checking if a function name is a Funcref variable.
3260 if (ht == &globvarht && !no_autoload)
3261 {
3262 // Note: script_autoload() may make "hi" invalid. It must either
3263 // be obtained again or not used.
3264 if (!script_autoload(varname, FALSE) || aborting())
3265 return NULL;
3266 hi = hash_find(ht, varname);
3267 }
3268 if (HASHITEM_EMPTY(hi))
3269 return NULL;
3270 }
3271 return HI2DI(hi);
3272}
3273
3274/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003275 * Get the script-local hashtab. NULL if not in a script context.
3276 */
Bram Moolenaar922acbd2020-10-08 21:30:40 +02003277 hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003278get_script_local_ht(void)
3279{
3280 scid_T sid = current_sctx.sc_sid;
3281
Bram Moolenaare3d46852020-08-29 13:39:17 +02003282 if (SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003283 return &SCRIPT_VARS(sid);
3284 return NULL;
3285}
3286
3287/*
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003288 * Look for "name[len]" in script-local variables and functions.
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003289 * When "cmd" is TRUE it must look like a command, a function must be followed
3290 * by "(" or "->".
Bram Moolenaar709664c2020-12-12 14:33:41 +01003291 * Return OK when found, FAIL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003292 */
Bram Moolenaar709664c2020-12-12 14:33:41 +01003293 int
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003294lookup_scriptitem(
Bram Moolenaar709664c2020-12-12 14:33:41 +01003295 char_u *name,
3296 size_t len,
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003297 int cmd,
Bram Moolenaar709664c2020-12-12 14:33:41 +01003298 cctx_T *dummy UNUSED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003299{
3300 hashtab_T *ht = get_script_local_ht();
3301 char_u buffer[30];
3302 char_u *p;
Bram Moolenaar709664c2020-12-12 14:33:41 +01003303 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003304 hashitem_T *hi;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003305 int is_global = FALSE;
3306 char_u *fname = name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003307
3308 if (ht == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003309 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003310 if (len < sizeof(buffer) - 1)
3311 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02003312 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003313 vim_strncpy(buffer, name, len);
3314 p = buffer;
3315 }
3316 else
3317 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003318 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003319 if (p == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003320 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003321 }
3322
3323 hi = hash_find(ht, p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01003324 res = HASHITEM_EMPTY(hi) ? FAIL : OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003325
3326 // if not script-local, then perhaps imported
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003327 if (res == FAIL && find_imported(p, 0, FALSE) != NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003328 res = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003329 if (p != buffer)
3330 vim_free(p);
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003331
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003332 // Find a function, so that a following "->" works.
3333 // When used as a command require "(" or "->" to follow, "Cmd" is a user
3334 // command while "Cmd()" is a function call.
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003335 if (res != OK)
3336 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003337 p = skipwhite(name + len);
3338
3339 if (!cmd || name[len] == '(' || (p[0] == '-' && p[1] == '>'))
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003340 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003341 // Do not check for an internal function, since it might also be a
3342 // valid command, such as ":split" versus "split()".
3343 // Skip "g:" before a function name.
3344 if (name[0] == 'g' && name[1] == ':')
3345 {
3346 is_global = TRUE;
3347 fname = name + 2;
3348 }
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003349 if (find_func(fname, is_global) != NULL)
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003350 res = OK;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003351 }
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003352 }
3353
Bram Moolenaar709664c2020-12-12 14:33:41 +01003354 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003355}
3356
3357/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003358 * Find the hashtab used for a variable name.
3359 * Return NULL if the name is not valid.
3360 * Set "varname" to the start of name without ':'.
3361 */
3362 hashtab_T *
3363find_var_ht(char_u *name, char_u **varname)
3364{
3365 hashitem_T *hi;
3366 hashtab_T *ht;
3367
3368 if (name[0] == NUL)
3369 return NULL;
3370 if (name[1] != ':')
3371 {
3372 // The name must not start with a colon or #.
3373 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
3374 return NULL;
3375 *varname = name;
3376
3377 // "version" is "v:version" in all scopes if scriptversion < 3.
3378 // Same for a few other variables marked with VV_COMPAT.
Bram Moolenaardd9de502021-08-15 13:49:42 +02003379 if (in_old_script(3))
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003380 {
3381 hi = hash_find(&compat_hashtab, name);
3382 if (!HASHITEM_EMPTY(hi))
3383 return &compat_hashtab;
3384 }
3385
3386 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003387 if (ht != NULL)
3388 return ht; // local variable
3389
Bram Moolenaarf0a40692021-06-11 22:05:47 +02003390 // In Vim9 script items at the script level are script-local, except
3391 // for autoload names.
3392 if (in_vim9script() && vim_strchr(name, AUTOLOAD_CHAR) == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003393 {
3394 ht = get_script_local_ht();
3395 if (ht != NULL)
3396 return ht;
3397 }
3398
3399 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003400 }
3401 *varname = name + 2;
3402 if (*name == 'g') // global variable
3403 return &globvarht;
3404 // There must be no ':' or '#' in the rest of the name, unless g: is used
3405 if (vim_strchr(name + 2, ':') != NULL
3406 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
3407 return NULL;
3408 if (*name == 'b') // buffer variable
3409 return &curbuf->b_vars->dv_hashtab;
3410 if (*name == 'w') // window variable
3411 return &curwin->w_vars->dv_hashtab;
3412 if (*name == 't') // tab page variable
3413 return &curtab->tp_vars->dv_hashtab;
3414 if (*name == 'v') // v: variable
3415 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01003416 if (get_current_funccal() != NULL
Bram Moolenaarca16c602022-09-06 18:57:08 +01003417 && get_current_funccal()->fc_func->uf_def_status
3418 == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003419 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01003420 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003421 if (*name == 'a') // a: function argument
3422 return get_funccal_args_ht();
3423 if (*name == 'l') // l: local function variable
3424 return get_funccal_local_ht();
3425 }
3426 if (*name == 's') // script variable
3427 {
3428 ht = get_script_local_ht();
3429 if (ht != NULL)
3430 return ht;
3431 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003432 return NULL;
3433}
3434
3435/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003436 * Get the string value of a (global/local) variable.
3437 * Note: see tv_get_string() for how long the pointer remains valid.
3438 * Returns NULL when it doesn't exist.
3439 */
3440 char_u *
3441get_var_value(char_u *name)
3442{
3443 dictitem_T *v;
3444
3445 v = find_var(name, NULL, FALSE);
3446 if (v == NULL)
3447 return NULL;
3448 return tv_get_string(&v->di_tv);
3449}
3450
3451/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003452 * Allocate a new hashtab for a sourced script. It will be used while
3453 * sourcing this script and when executing functions defined in the script.
3454 */
3455 void
3456new_script_vars(scid_T id)
3457{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003458 scriptvar_T *sv;
3459
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01003460 sv = ALLOC_CLEAR_ONE(scriptvar_T);
3461 if (sv == NULL)
3462 return;
3463 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01003464 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003465}
3466
3467/*
3468 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
3469 * point to it.
3470 */
3471 void
3472init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
3473{
3474 hash_init(&dict->dv_hashtab);
3475 dict->dv_lock = 0;
3476 dict->dv_scope = scope;
3477 dict->dv_refcount = DO_NOT_FREE_CNT;
3478 dict->dv_copyID = 0;
3479 dict_var->di_tv.vval.v_dict = dict;
3480 dict_var->di_tv.v_type = VAR_DICT;
3481 dict_var->di_tv.v_lock = VAR_FIXED;
3482 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
3483 dict_var->di_key[0] = NUL;
3484}
3485
3486/*
3487 * Unreference a dictionary initialized by init_var_dict().
3488 */
3489 void
3490unref_var_dict(dict_T *dict)
3491{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003492 // Now the dict needs to be freed if no one else is using it, go back to
3493 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003494 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
3495 dict_unref(dict);
3496}
3497
3498/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003499 * Clean up a list of internal variables.
3500 * Frees all allocated variables and the value they contain.
3501 * Clears hashtab "ht", does not free it.
3502 */
3503 void
3504vars_clear(hashtab_T *ht)
3505{
3506 vars_clear_ext(ht, TRUE);
3507}
3508
3509/*
3510 * Like vars_clear(), but only free the value if "free_val" is TRUE.
3511 */
3512 void
3513vars_clear_ext(hashtab_T *ht, int free_val)
3514{
3515 int todo;
3516 hashitem_T *hi;
3517 dictitem_T *v;
3518
3519 hash_lock(ht);
3520 todo = (int)ht->ht_used;
3521 for (hi = ht->ht_array; todo > 0; ++hi)
3522 {
3523 if (!HASHITEM_EMPTY(hi))
3524 {
3525 --todo;
3526
3527 // Free the variable. Don't remove it from the hashtab,
3528 // ht_array might change then. hash_clear() takes care of it
3529 // later.
3530 v = HI2DI(hi);
3531 if (free_val)
3532 clear_tv(&v->di_tv);
3533 if (v->di_flags & DI_FLAGS_ALLOC)
3534 vim_free(v);
3535 }
3536 }
3537 hash_clear(ht);
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003538 hash_init(ht);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003539}
3540
3541/*
3542 * Delete a variable from hashtab "ht" at item "hi".
3543 * Clear the variable value and free the dictitem.
3544 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02003545 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003546delete_var(hashtab_T *ht, hashitem_T *hi)
3547{
3548 dictitem_T *di = HI2DI(hi);
3549
3550 hash_remove(ht, hi);
3551 clear_tv(&di->di_tv);
3552 vim_free(di);
3553}
3554
3555/*
3556 * List the value of one internal variable.
3557 */
3558 static void
3559list_one_var(dictitem_T *v, char *prefix, int *first)
3560{
3561 char_u *tofree;
3562 char_u *s;
3563 char_u numbuf[NUMBUFLEN];
3564
3565 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
3566 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
3567 s == NULL ? (char_u *)"" : s, first);
3568 vim_free(tofree);
3569}
3570
3571 static void
3572list_one_var_a(
3573 char *prefix,
3574 char_u *name,
3575 int type,
3576 char_u *string,
3577 int *first) // when TRUE clear rest of screen and set to FALSE
3578{
3579 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
3580 msg_start();
3581 msg_puts(prefix);
3582 if (name != NULL) // "a:" vars don't have a name stored
3583 msg_puts((char *)name);
3584 msg_putchar(' ');
3585 msg_advance(22);
3586 if (type == VAR_NUMBER)
3587 msg_putchar('#');
3588 else if (type == VAR_FUNC || type == VAR_PARTIAL)
3589 msg_putchar('*');
3590 else if (type == VAR_LIST)
3591 {
3592 msg_putchar('[');
3593 if (*string == '[')
3594 ++string;
3595 }
3596 else if (type == VAR_DICT)
3597 {
3598 msg_putchar('{');
3599 if (*string == '{')
3600 ++string;
3601 }
3602 else
3603 msg_putchar(' ');
3604
3605 msg_outtrans(string);
3606
3607 if (type == VAR_FUNC || type == VAR_PARTIAL)
3608 msg_puts("()");
3609 if (*first)
3610 {
3611 msg_clr_eos();
3612 *first = FALSE;
3613 }
3614}
3615
3616/*
3617 * Set variable "name" to value in "tv".
3618 * If the variable already exists, the value is updated.
3619 * Otherwise the variable is created.
3620 */
3621 void
3622set_var(
3623 char_u *name,
3624 typval_T *tv,
3625 int copy) // make copy of value in "tv"
3626{
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003627 set_var_const(name, 0, NULL, tv, copy, ASSIGN_DECL, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003628}
3629
3630/*
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003631 * Set variable "name" to value in "tv_arg".
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003632 * When "sid" is non-zero "name" is in the script with this ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003633 * If the variable already exists and "is_const" is FALSE the value is updated.
3634 * Otherwise the variable is created.
3635 */
3636 void
3637set_var_const(
3638 char_u *name,
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003639 scid_T sid,
Bram Moolenaar7824fc82021-11-26 17:36:51 +00003640 type_T *type_arg,
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003641 typval_T *tv_arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003642 int copy, // make copy of value in "tv"
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003643 int flags_arg, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003644 int var_idx) // index for ":let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003645{
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003646 typval_T *tv = tv_arg;
Bram Moolenaar7824fc82021-11-26 17:36:51 +00003647 type_T *type = type_arg;
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003648 typval_T bool_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003649 dictitem_T *di;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003650 typval_T *dest_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003651 char_u *varname;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003652 char_u *name_tofree = NULL;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003653 hashtab_T *ht = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003654 int is_script_local;
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003655 int vim9script = in_vim9script();
Bram Moolenaare535db82021-03-31 21:07:24 +02003656 int var_in_vim9script;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003657 int var_in_autoload = FALSE;
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003658 int flags = flags_arg;
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003659 int free_tv_arg = !copy; // free tv_arg if not used
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003660
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003661 if (sid != 0)
3662 {
3663 if (SCRIPT_ID_VALID(sid))
3664 ht = &SCRIPT_VARS(sid);
3665 varname = name;
3666 }
3667 else
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003668 {
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003669 scriptitem_T *si;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003670
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003671 if (in_vim9script() && is_export
3672 && SCRIPT_ID_VALID(current_sctx.sc_sid)
3673 && (si = SCRIPT_ITEM(current_sctx.sc_sid))
Bram Moolenaar0e1574c2022-03-03 17:05:35 +00003674 ->sn_autoload_prefix != NULL)
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003675 {
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003676 // In a vim9 autoload script an exported variable is put in the
3677 // global namespace with the autoload prefix.
3678 var_in_autoload = TRUE;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003679 varname = concat_str(si->sn_autoload_prefix, name);
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003680 if (varname == NULL)
3681 goto failed;
3682 name_tofree = varname;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003683 ht = &globvarht;
3684 }
3685 else
3686 ht = find_var_ht(name, &varname);
3687 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003688 if (ht == NULL || *varname == NUL)
3689 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003690 semsg(_(e_illegal_variable_name_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003691 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003692 }
Bram Moolenaar54969f42022-02-07 13:56:44 +00003693 is_script_local = ht == get_script_local_ht() || sid != 0
3694 || var_in_autoload;
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003695
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003696 if (vim9script
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003697 && !is_script_local
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003698 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003699 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003700 && name[1] == ':')
Bram Moolenaar67979662020-06-20 22:50:47 +02003701 {
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003702 vim9_declare_error(name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003703 goto failed;
Bram Moolenaar67979662020-06-20 22:50:47 +02003704 }
Bram Moolenaar9510d222022-09-11 15:14:05 +01003705 if ((flags & ASSIGN_FOR_LOOP) && is_scoped_variable(name))
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003706 // Do not make g:var, w:var, b:var or t:var final.
3707 flags &= ~ASSIGN_FINAL;
3708
Bram Moolenaare535db82021-03-31 21:07:24 +02003709 var_in_vim9script = is_script_local && current_script_is_vim9();
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003710 if (var_in_vim9script && name[0] == '_' && name[1] == NUL)
3711 {
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02003712 // For "[a, _] = list" the underscore is ignored.
3713 if ((flags & ASSIGN_UNPACK) == 0)
3714 emsg(_(e_cannot_use_underscore_here));
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003715 goto failed;
3716 }
Bram Moolenaar67979662020-06-20 22:50:47 +02003717
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003718 di = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003719
Bram Moolenaar24e93162021-07-18 20:40:33 +02003720 if (di == NULL && var_in_vim9script)
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003721 {
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003722 imported_T *import = find_imported(varname, 0, FALSE);
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003723
Bram Moolenaar24e93162021-07-18 20:40:33 +02003724 if (import != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003725 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003726 // imported name space cannot be used
Bram Moolenaar24e93162021-07-18 20:40:33 +02003727 if ((flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003728 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003729 semsg(_(e_redefining_imported_item_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003730 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003731 }
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003732 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
3733 goto failed;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003734 }
Bram Moolenaar75e27d72022-02-13 13:56:29 +00003735 if (!in_vim9script())
3736 {
3737 semsg(_(e_cannot_create_vim9_script_variable_in_function_str),
3738 name);
3739 goto failed;
3740 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003741 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003742
Bram Moolenaar993faa32022-02-21 15:59:11 +00003743 // Search in parent scope which is possible to reference from lambda
3744 if (di == NULL)
3745 di = find_var_in_scoped_ht(name, TRUE);
3746
3747 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
3748 && var_wrong_func_name(name, di == NULL))
3749 goto failed;
3750
3751 if (need_convert_to_bool(type, tv))
Bram Moolenaar24e93162021-07-18 20:40:33 +02003752 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003753 // Destination is a bool and the value is not, but it can be
3754 // converted.
3755 CLEAR_FIELD(bool_tv);
3756 bool_tv.v_type = VAR_BOOL;
3757 bool_tv.vval.v_number = tv2bool(tv) ? VVAL_TRUE : VVAL_FALSE;
3758 tv = &bool_tv;
3759 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003760
Bram Moolenaar993faa32022-02-21 15:59:11 +00003761 if (di != NULL)
3762 {
3763 // Item already exists. Allowed to replace when reloading.
3764 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003765 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003766 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
3767 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003768 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003769 emsg(_(e_cannot_modify_existing_variable));
3770 goto failed;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003771 }
3772
Bram Moolenaar993faa32022-02-21 15:59:11 +00003773 if (is_script_local && vim9script
3774 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0)
Bram Moolenaar12be7342021-03-31 21:47:33 +02003775 {
3776 semsg(_(e_redefining_script_item_str), name);
3777 goto failed;
3778 }
3779
Bram Moolenaar993faa32022-02-21 15:59:11 +00003780 if (var_in_vim9script && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003781 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003782 where_T where = WHERE_INIT;
Bram Moolenaar7a411a32022-04-04 14:58:06 +01003783 svar_T *sv = find_typval_in_script(&di->di_tv, sid, TRUE);
Bram Moolenaar993faa32022-02-21 15:59:11 +00003784
3785 if (sv != NULL)
3786 {
3787 // check the type and adjust to bool if needed
3788 where.wt_index = var_idx;
3789 where.wt_variable = TRUE;
3790 if (check_script_var_type(sv, tv, name, where) == FAIL)
3791 goto failed;
3792 if (type == NULL)
3793 type = sv->sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003794 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003795 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003796 }
3797
Bram Moolenaar993faa32022-02-21 15:59:11 +00003798 if ((flags & ASSIGN_FOR_LOOP) == 0
3799 && var_check_permission(di, name) == FAIL)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003800 goto failed;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003801 }
3802 else
3803 {
3804 // can only redefine once
3805 di->di_flags &= ~DI_FLAGS_RELOAD;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003806
Bram Moolenaar993faa32022-02-21 15:59:11 +00003807 // A Vim9 script-local variable is also present in sn_all_vars
3808 // and sn_var_vals. It may set "type" from "tv".
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003809 if (var_in_vim9script || var_in_autoload)
Bram Moolenaar993faa32022-02-21 15:59:11 +00003810 update_vim9_script_var(FALSE, di,
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003811 var_in_autoload ? name : di->di_key, flags,
Bram Moolenaar993faa32022-02-21 15:59:11 +00003812 tv, &type, (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003813 }
3814
Bram Moolenaar993faa32022-02-21 15:59:11 +00003815 // existing variable, need to clear the value
3816
3817 // Handle setting internal di: variables separately where needed to
3818 // prevent changing the type.
3819 if (ht == &vimvarht)
3820 {
3821 if (di->di_tv.v_type == VAR_STRING)
3822 {
3823 VIM_CLEAR(di->di_tv.vval.v_string);
3824 if (copy || tv->v_type != VAR_STRING)
3825 {
3826 char_u *val = tv_get_string(tv);
3827
3828 // Careful: when assigning to v:errmsg and
3829 // tv_get_string() causes an error message the variable
3830 // will already be set.
3831 if (di->di_tv.vval.v_string == NULL)
3832 di->di_tv.vval.v_string = vim_strsave(val);
3833 }
3834 else
3835 {
3836 // Take over the string to avoid an extra alloc/free.
3837 di->di_tv.vval.v_string = tv->vval.v_string;
3838 tv->vval.v_string = NULL;
3839 }
3840 goto failed;
3841 }
3842 else if (di->di_tv.v_type == VAR_NUMBER)
3843 {
3844 di->di_tv.vval.v_number = tv_get_number(tv);
3845 if (STRCMP(varname, "searchforward") == 0)
3846 set_search_direction(di->di_tv.vval.v_number
3847 ? '/' : '?');
3848#ifdef FEAT_SEARCH_EXTRA
3849 else if (STRCMP(varname, "hlsearch") == 0)
3850 {
3851 no_hlsearch = !di->di_tv.vval.v_number;
Bram Moolenaara4d158b2022-08-14 14:17:45 +01003852 redraw_all_later(UPD_SOME_VALID);
Bram Moolenaar993faa32022-02-21 15:59:11 +00003853 }
3854#endif
3855 goto failed;
3856 }
3857 else if (di->di_tv.v_type != tv->v_type)
3858 {
3859 semsg(_(e_setting_str_to_value_with_wrong_type), name);
3860 goto failed;
3861 }
3862 }
3863
3864 clear_tv(&di->di_tv);
Bram Moolenaar766ae5b2022-09-14 00:30:51 +01003865
3866 if ((flags & ASSIGN_UPDATE_BLOCK_ID)
3867 && SCRIPT_ID_VALID(current_sctx.sc_sid))
3868 {
3869 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
3870
3871 update_script_var_block_id(name, si->sn_current_block_id);
3872 }
Bram Moolenaar993faa32022-02-21 15:59:11 +00003873 }
3874 else
3875 {
3876 // Item not found, check if a function already exists.
3877 if (is_script_local && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
3878 && lookup_scriptitem(name, STRLEN(name), FALSE, NULL) == OK)
3879 {
3880 semsg(_(e_redefining_script_item_str), name);
3881 goto failed;
3882 }
3883
3884 // add a new variable
3885 if (var_in_vim9script && (flags & ASSIGN_NO_DECL))
3886 {
3887 semsg(_(e_unknown_variable_str), name);
3888 goto failed;
3889 }
3890
3891 // Can't add "v:" or "a:" variable.
3892 if (ht == &vimvarht || ht == get_funccal_args_ht())
3893 {
3894 semsg(_(e_illegal_variable_name_str), name);
3895 goto failed;
3896 }
3897
3898 // Make sure the variable name is valid. In Vim9 script an
3899 // autoload variable must be prefixed with "g:" unless in an
3900 // autoload script.
3901 if (!valid_varname(varname, -1, !vim9script
3902 || STRNCMP(name, "g:", 2) == 0 || var_in_autoload))
3903 goto failed;
3904
3905 di = alloc(sizeof(dictitem_T) + STRLEN(varname));
3906 if (di == NULL)
3907 goto failed;
3908 STRCPY(di->di_key, varname);
3909 if (hash_add(ht, DI2HIKEY(di)) == FAIL)
3910 {
3911 vim_free(di);
3912 goto failed;
3913 }
3914 di->di_flags = DI_FLAGS_ALLOC;
3915 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
3916 di->di_flags |= DI_FLAGS_LOCK;
3917
3918 // A Vim9 script-local variable is also added to sn_all_vars and
3919 // sn_var_vals. It may set "type" from "tv".
3920 if (var_in_vim9script || var_in_autoload)
3921 update_vim9_script_var(TRUE, di,
3922 var_in_autoload ? name : di->di_key, flags,
3923 tv, &type, (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003924 }
3925
Bram Moolenaar993faa32022-02-21 15:59:11 +00003926 dest_tv = &di->di_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003927 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003928 copy_tv(tv, dest_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003929 else
3930 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003931 *dest_tv = *tv;
3932 dest_tv->v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003933 init_tv(tv);
3934 }
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003935 free_tv_arg = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003936
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003937 if (vim9script && type != NULL)
Bram Moolenaar381692b2022-02-02 20:01:27 +00003938 set_tv_type(dest_tv, type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003939
Bram Moolenaar1dcf55d2020-12-22 22:07:30 +01003940 // ":const var = value" locks the value
3941 // ":final var = value" locks "var"
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003942 if (flags & ASSIGN_CONST)
Bram Moolenaar021bda52020-08-17 21:07:22 +02003943 // Like :lockvar! name: lock the value and what it contains, but only
3944 // if the reference count is up to one. That locks only literal
3945 // values.
Bram Moolenaar24e93162021-07-18 20:40:33 +02003946 item_lock(dest_tv, DICT_MAXNEST, TRUE, TRUE);
Bram Moolenaar24e93162021-07-18 20:40:33 +02003947
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003948failed:
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003949 vim_free(name_tofree);
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003950 if (free_tv_arg)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003951 clear_tv(tv_arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003952}
3953
3954/*
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003955 * Check in this order for backwards compatibility:
3956 * - Whether the variable is read-only
3957 * - Whether the variable value is locked
3958 * - Whether the variable is locked
3959 */
3960 int
3961var_check_permission(dictitem_T *di, char_u *name)
3962{
3963 if (var_check_ro(di->di_flags, name, FALSE)
3964 || value_check_lock(di->di_tv.v_lock, name, FALSE)
3965 || var_check_lock(di->di_flags, name, FALSE))
3966 return FAIL;
3967 return OK;
3968}
3969
3970/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003971 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
3972 * Also give an error message.
3973 */
3974 int
3975var_check_ro(int flags, char_u *name, int use_gettext)
3976{
3977 if (flags & DI_FLAGS_RO)
3978 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00003979 if (name == NULL)
3980 emsg(_(e_cannot_change_readonly_variable));
3981 else
3982 semsg(_(e_cannot_change_readonly_variable_str),
Bram Moolenaard8e44472021-07-21 22:20:33 +02003983 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003984 return TRUE;
3985 }
3986 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
3987 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00003988 if (name == NULL)
3989 emsg(_(e_cannot_set_variable_in_sandbox));
3990 else
3991 semsg(_(e_cannot_set_variable_in_sandbox_str),
3992 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003993 return TRUE;
3994 }
3995 return FALSE;
3996}
3997
3998/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003999 * Return TRUE if di_flags "flags" indicates variable "name" is locked.
4000 * Also give an error message.
4001 */
4002 int
4003var_check_lock(int flags, char_u *name, int use_gettext)
4004{
4005 if (flags & DI_FLAGS_LOCK)
4006 {
4007 semsg(_(e_variable_is_locked_str),
4008 use_gettext ? (char_u *)_(name) : name);
4009 return TRUE;
4010 }
4011 return FALSE;
4012}
4013
4014/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004015 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
4016 * Also give an error message.
4017 */
4018 int
4019var_check_fixed(int flags, char_u *name, int use_gettext)
4020{
4021 if (flags & DI_FLAGS_FIX)
4022 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004023 if (name == NULL)
4024 emsg(_(e_cannot_delete_variable));
4025 else
4026 semsg(_(e_cannot_delete_variable_str),
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004027 use_gettext ? (char_u *)_(name) : name);
4028 return TRUE;
4029 }
4030 return FALSE;
4031}
4032
4033/*
4034 * Check if a funcref is assigned to a valid variable name.
4035 * Return TRUE and give an error if not.
4036 */
4037 int
Bram Moolenaar98b4f142020-08-08 15:46:01 +02004038var_wrong_func_name(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004039 char_u *name, // points to start of variable name
4040 int new_var) // TRUE when creating the variable
4041{
Bram Moolenaar32154662021-03-28 21:14:06 +02004042 // Allow for w: b: s: and t:. In Vim9 script s: is not allowed, because
4043 // the name can be used without the s: prefix.
thinca6c667bd2022-09-02 11:25:37 +01004044 // Allow autoload variable.
Bram Moolenaar32154662021-03-28 21:14:06 +02004045 if (!((vim_strchr((char_u *)"wbt", name[0]) != NULL
4046 || (!in_vim9script() && name[0] == 's')) && name[1] == ':')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004047 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
thinca6c667bd2022-09-02 11:25:37 +01004048 ? name[2] : name[0])
4049 && vim_strchr(name, '#') == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004050 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004051 semsg(_(e_funcref_variable_name_must_start_with_capital_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004052 return TRUE;
4053 }
4054 // Don't allow hiding a function. When "v" is not NULL we might be
4055 // assigning another function to the same var, the type is checked
4056 // below.
4057 if (new_var && function_exists(name, FALSE))
4058 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004059 semsg(_(e_variable_name_conflicts_with_existing_function_str),
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004060 name);
4061 return TRUE;
4062 }
4063 return FALSE;
4064}
4065
4066/*
Bram Moolenaara187c432020-09-16 21:08:28 +02004067 * Return TRUE if "flags" indicates variable "name" has a locked (immutable)
4068 * value. Also give an error message, using "name" or _("name") when
4069 * "use_gettext" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004070 */
4071 int
Bram Moolenaara187c432020-09-16 21:08:28 +02004072value_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004073{
4074 if (lock & VAR_LOCKED)
4075 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004076 if (name == NULL)
4077 emsg(_(e_value_is_locked));
4078 else
4079 semsg(_(e_value_is_locked_str),
4080 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004081 return TRUE;
4082 }
4083 if (lock & VAR_FIXED)
4084 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004085 if (name == NULL)
4086 emsg(_(e_cannot_change_value));
4087 else
4088 semsg(_(e_cannot_change_value_of_str),
4089 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004090 return TRUE;
4091 }
4092 return FALSE;
4093}
4094
4095/*
Bram Moolenaar03290b82020-12-19 16:30:44 +01004096 * Check if a variable name is valid. When "autoload" is true "#" is allowed.
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004097 * If "len" is -1 use all of "varname", otherwise up to "varname[len]".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004098 * Return FALSE and give an error if not.
4099 */
4100 int
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004101valid_varname(char_u *varname, int len, int autoload)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004102{
4103 char_u *p;
4104
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004105 for (p = varname; len < 0 ? *p != NUL : p < varname + len; ++p)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004106 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
Bram Moolenaar03290b82020-12-19 16:30:44 +01004107 && !(autoload && *p == AUTOLOAD_CHAR))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004108 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004109 semsg(_(e_illegal_variable_name_str), varname);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004110 return FALSE;
4111 }
4112 return TRUE;
4113}
4114
4115/*
LemonBoy47d4e312022-05-04 18:12:55 +01004116 * Implements the logic to retrieve local variable and option values.
4117 * Used by "getwinvar()" "gettabvar()" "gettabwinvar()" "getbufvar()".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004118 */
4119 static void
LemonBoy47d4e312022-05-04 18:12:55 +01004120get_var_from(
4121 char_u *varname,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004122 typval_T *rettv,
LemonBoy47d4e312022-05-04 18:12:55 +01004123 typval_T *deftv, // Default value if not found.
4124 int htname, // 't'ab, 'w'indow or 'b'uffer local.
4125 tabpage_T *tp, // can be NULL
4126 win_T *win,
4127 buf_T *buf) // Ignored if htname is not 'b'.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004128{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004129 dictitem_T *v;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004130 int done = FALSE;
Bram Moolenaar18f47402022-01-06 13:24:51 +00004131 switchwin_T switchwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004132 int need_switch_win;
zeertzjqcd6ad642022-07-25 12:28:09 +01004133 int do_change_curbuf = buf != NULL && htname == 'b';
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004134
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004135 ++emsg_off;
4136
4137 rettv->v_type = VAR_STRING;
4138 rettv->vval.v_string = NULL;
4139
LemonBoy47d4e312022-05-04 18:12:55 +01004140 if (varname != NULL && tp != NULL && win != NULL
4141 && (htname != 'b' || buf != NULL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004142 {
4143 // Set curwin to be our win, temporarily. Also set the tabpage,
4144 // otherwise the window is not valid. Only do this when needed,
4145 // autocommands get blocked.
LemonBoy47d4e312022-05-04 18:12:55 +01004146 // If we have a buffer reference avoid the switching, we're saving and
4147 // restoring curbuf directly.
zeertzjqcd6ad642022-07-25 12:28:09 +01004148 need_switch_win = !(tp == curtab && win == curwin) && !do_change_curbuf;
LemonBoy47d4e312022-05-04 18:12:55 +01004149 if (!need_switch_win || switch_win(&switchwin, win, tp, TRUE) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004150 {
LemonBoy47d4e312022-05-04 18:12:55 +01004151 // Handle options. There are no tab-local options.
4152 if (*varname == '&' && htname != 't')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004153 {
LemonBoy47d4e312022-05-04 18:12:55 +01004154 buf_T *save_curbuf = curbuf;
4155
4156 // Change curbuf so the option is read from the correct buffer.
zeertzjqcd6ad642022-07-25 12:28:09 +01004157 if (do_change_curbuf)
LemonBoy47d4e312022-05-04 18:12:55 +01004158 curbuf = buf;
4159
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004160 if (varname[1] == NUL)
4161 {
zeertzjqcd6ad642022-07-25 12:28:09 +01004162 // get all window-local or buffer-local options in a dict
LemonBoy47d4e312022-05-04 18:12:55 +01004163 dict_T *opts = get_winbuf_options(htname == 'b');
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004164
4165 if (opts != NULL)
4166 {
4167 rettv_dict_set(rettv, opts);
4168 done = TRUE;
4169 }
4170 }
LemonBoy47d4e312022-05-04 18:12:55 +01004171 else if (eval_option(&varname, rettv, TRUE) == OK)
4172 // Local option
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004173 done = TRUE;
LemonBoy47d4e312022-05-04 18:12:55 +01004174
4175 curbuf = save_curbuf;
4176 }
4177 else if (*varname == NUL)
4178 {
4179 // Empty string: return a dict with all the local variables.
4180 if (htname == 'b')
4181 v = &buf->b_bufvar;
4182 else if (htname == 'w')
4183 v = &win->w_winvar;
4184 else
4185 v = &tp->tp_winvar;
4186 copy_tv(&v->di_tv, rettv);
4187 done = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004188 }
4189 else
4190 {
LemonBoy47d4e312022-05-04 18:12:55 +01004191 hashtab_T *ht;
4192
4193 if (htname == 'b')
4194 ht = &buf->b_vars->dv_hashtab;
4195 else if (htname == 'w')
4196 ht = &win->w_vars->dv_hashtab;
4197 else
4198 ht = &tp->tp_vars->dv_hashtab;
4199
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004200 // Look up the variable.
LemonBoy47d4e312022-05-04 18:12:55 +01004201 v = find_var_in_ht(ht, htname, varname, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004202 if (v != NULL)
4203 {
4204 copy_tv(&v->di_tv, rettv);
4205 done = TRUE;
4206 }
4207 }
4208 }
4209
4210 if (need_switch_win)
4211 // restore previous notion of curwin
Bram Moolenaar18f47402022-01-06 13:24:51 +00004212 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004213 }
4214
LemonBoy47d4e312022-05-04 18:12:55 +01004215 if (!done && deftv->v_type != VAR_UNKNOWN)
4216 // use the default value
4217 copy_tv(deftv, rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004218
4219 --emsg_off;
4220}
4221
4222/*
LemonBoy47d4e312022-05-04 18:12:55 +01004223 * getwinvar() and gettabwinvar()
4224 */
4225 static void
4226getwinvar(
4227 typval_T *argvars,
4228 typval_T *rettv,
4229 int off) // 1 for gettabwinvar()
4230{
4231 char_u *varname;
4232 tabpage_T *tp;
4233 win_T *win;
4234
4235 if (off == 1)
4236 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4237 else
4238 tp = curtab;
4239 win = find_win_by_nr(&argvars[off], tp);
4240 varname = tv_get_string_chk(&argvars[off + 1]);
4241
4242 get_var_from(varname, rettv, &argvars[off + 2], 'w', tp, win, NULL);
4243}
4244
4245/*
Bram Moolenaar191929b2020-08-19 21:20:49 +02004246 * Set option "varname" to the value of "varp" for the current buffer/window.
4247 */
4248 static void
4249set_option_from_tv(char_u *varname, typval_T *varp)
4250{
4251 long numval = 0;
4252 char_u *strval;
4253 char_u nbuf[NUMBUFLEN];
4254 int error = FALSE;
4255
Bram Moolenaar31a201a2021-01-03 14:47:25 +01004256 if (varp->v_type == VAR_BOOL)
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004257 {
Bram Moolenaar28f84e12022-07-27 12:30:13 +01004258 if (is_string_option(varname))
4259 {
4260 emsg(_(e_string_required));
4261 return;
4262 }
Bram Moolenaar31a201a2021-01-03 14:47:25 +01004263 numval = (long)varp->vval.v_number;
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004264 strval = (char_u *)"0"; // avoid using "false"
4265 }
4266 else
4267 {
4268 if (!in_vim9script() || varp->v_type != VAR_STRING)
4269 numval = (long)tv_get_number_chk(varp, &error);
4270 strval = tv_get_string_buf_chk(varp, nbuf);
4271 }
Bram Moolenaar191929b2020-08-19 21:20:49 +02004272 if (!error && strval != NULL)
Bram Moolenaar31e5c602022-04-15 13:53:33 +01004273 set_option_value_give_err(varname, numval, strval, OPT_LOCAL);
Bram Moolenaar191929b2020-08-19 21:20:49 +02004274}
4275
4276/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004277 * "setwinvar()" and "settabwinvar()" functions
4278 */
4279 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004280setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004281{
4282 win_T *win;
Bram Moolenaar18f47402022-01-06 13:24:51 +00004283 switchwin_T switchwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004284 int need_switch_win;
4285 char_u *varname, *winvarname;
4286 typval_T *varp;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004287 tabpage_T *tp = NULL;
4288
4289 if (check_secure())
4290 return;
4291
4292 if (off == 1)
4293 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4294 else
4295 tp = curtab;
4296 win = find_win_by_nr(&argvars[off], tp);
4297 varname = tv_get_string_chk(&argvars[off + 1]);
4298 varp = &argvars[off + 2];
4299
4300 if (win != NULL && varname != NULL && varp != NULL)
4301 {
4302 need_switch_win = !(tp == curtab && win == curwin);
4303 if (!need_switch_win
Bram Moolenaar18f47402022-01-06 13:24:51 +00004304 || switch_win(&switchwin, win, tp, TRUE) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004305 {
4306 if (*varname == '&')
Bram Moolenaar191929b2020-08-19 21:20:49 +02004307 set_option_from_tv(varname + 1, varp);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004308 else
4309 {
4310 winvarname = alloc(STRLEN(varname) + 3);
4311 if (winvarname != NULL)
4312 {
4313 STRCPY(winvarname, "w:");
4314 STRCPY(winvarname + 2, varname);
4315 set_var(winvarname, varp, TRUE);
4316 vim_free(winvarname);
4317 }
4318 }
4319 }
4320 if (need_switch_win)
Bram Moolenaar18f47402022-01-06 13:24:51 +00004321 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004322 }
4323}
4324
Bram Moolenaare5cdf152019-08-29 22:09:46 +02004325/*
4326 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
4327 * v:option_type, and v:option_command.
4328 */
4329 void
4330reset_v_option_vars(void)
4331{
4332 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
4333 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
4334 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
4335 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
4336 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
4337 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
4338}
4339
4340/*
4341 * Add an assert error to v:errors.
4342 */
4343 void
4344assert_error(garray_T *gap)
4345{
4346 struct vimvar *vp = &vimvars[VV_ERRORS];
4347
Bram Moolenaard787e402021-12-24 21:36:12 +00004348 if (vp->vv_tv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004349 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02004350 set_vim_var_list(VV_ERRORS, list_alloc());
4351 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
4352}
4353
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004354 int
4355var_exists(char_u *var)
4356{
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004357 char_u *arg = var;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004358 char_u *name;
4359 char_u *tofree;
4360 typval_T tv;
4361 int len = 0;
4362 int n = FALSE;
4363
4364 // get_name_len() takes care of expanding curly braces
4365 name = var;
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004366 len = get_name_len(&arg, &tofree, TRUE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004367 if (len > 0)
4368 {
4369 if (tofree != NULL)
4370 name = tofree;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004371 n = (eval_variable(name, len, 0, &tv, NULL,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01004372 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004373 if (n)
4374 {
4375 // handle d.key, l[idx], f(expr)
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004376 arg = skipwhite(arg);
Bram Moolenaar32884ad2022-01-07 12:45:29 +00004377 n = (handle_subscript(&arg, name, &tv, &EVALARG_EVALUATE,
4378 FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004379 if (n)
4380 clear_tv(&tv);
4381 }
4382 }
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004383 if (*arg != NUL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004384 n = FALSE;
4385
4386 vim_free(tofree);
4387 return n;
4388}
4389
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004390static lval_T *redir_lval = NULL;
4391#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
4392static garray_T redir_ga; // only valid when redir_lval is not NULL
4393static char_u *redir_endp = NULL;
4394static char_u *redir_varname = NULL;
4395
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004396 int
4397alloc_redir_lval(void)
4398{
4399 redir_lval = ALLOC_CLEAR_ONE(lval_T);
4400 if (redir_lval == NULL)
4401 return FAIL;
4402 return OK;
4403}
4404
4405 void
4406clear_redir_lval(void)
4407{
4408 VIM_CLEAR(redir_lval);
4409}
4410
4411 void
4412init_redir_ga(void)
4413{
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004414 ga_init2(&redir_ga, sizeof(char), 500);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004415}
4416
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004417/*
4418 * Start recording command output to a variable
4419 * When "append" is TRUE append to an existing variable.
4420 * Returns OK if successfully completed the setup. FAIL otherwise.
4421 */
4422 int
4423var_redir_start(char_u *name, int append)
4424{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004425 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004426 typval_T tv;
4427
4428 // Catch a bad name early.
4429 if (!eval_isnamec1(*name))
4430 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004431 emsg(_(e_invalid_argument));
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004432 return FAIL;
4433 }
4434
4435 // Make a copy of the name, it is used in redir_lval until redir ends.
4436 redir_varname = vim_strsave(name);
4437 if (redir_varname == NULL)
4438 return FAIL;
4439
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004440 if (alloc_redir_lval() == FAIL)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004441 {
4442 var_redir_stop();
4443 return FAIL;
4444 }
4445
4446 // The output is stored in growarray "redir_ga" until redirection ends.
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004447 init_redir_ga();
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004448
4449 // Parse the variable name (can be a dict or list entry).
4450 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
4451 FNE_CHECK_START);
4452 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
4453 {
4454 clear_lval(redir_lval);
4455 if (redir_endp != NULL && *redir_endp != NUL)
4456 // Trailing characters are present after the variable name
Bram Moolenaar74409f62022-01-01 15:58:22 +00004457 semsg(_(e_trailing_characters_str), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004458 else
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004459 semsg(_(e_invalid_argument_str), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004460 redir_endp = NULL; // don't store a value, only cleanup
4461 var_redir_stop();
4462 return FAIL;
4463 }
4464
4465 // check if we can write to the variable: set it to or append an empty
4466 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004467 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004468 tv.v_type = VAR_STRING;
4469 tv.vval.v_string = (char_u *)"";
4470 if (append)
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004471 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004472 ASSIGN_NO_DECL, (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004473 else
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004474 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004475 ASSIGN_NO_DECL, (char_u *)"=", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004476 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004477 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004478 {
4479 redir_endp = NULL; // don't store a value, only cleanup
4480 var_redir_stop();
4481 return FAIL;
4482 }
4483
4484 return OK;
4485}
4486
4487/*
4488 * Append "value[value_len]" to the variable set by var_redir_start().
4489 * The actual appending is postponed until redirection ends, because the value
4490 * appended may in fact be the string we write to, changing it may cause freed
4491 * memory to be used:
4492 * :redir => foo
4493 * :let foo
4494 * :redir END
4495 */
4496 void
4497var_redir_str(char_u *value, int value_len)
4498{
4499 int len;
4500
4501 if (redir_lval == NULL)
4502 return;
4503
4504 if (value_len == -1)
4505 len = (int)STRLEN(value); // Append the entire string
4506 else
4507 len = value_len; // Append only "value_len" characters
4508
4509 if (ga_grow(&redir_ga, len) == OK)
4510 {
4511 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
4512 redir_ga.ga_len += len;
4513 }
4514 else
4515 var_redir_stop();
4516}
4517
4518/*
4519 * Stop redirecting command output to a variable.
4520 * Frees the allocated memory.
4521 */
4522 void
4523var_redir_stop(void)
4524{
4525 typval_T tv;
4526
4527 if (EVALCMD_BUSY)
4528 {
4529 redir_lval = NULL;
4530 return;
4531 }
4532
4533 if (redir_lval != NULL)
4534 {
4535 // If there was no error: assign the text to the variable.
4536 if (redir_endp != NULL)
4537 {
4538 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4539 tv.v_type = VAR_STRING;
4540 tv.vval.v_string = redir_ga.ga_data;
4541 // Call get_lval() again, if it's inside a Dict or List it may
4542 // have changed.
4543 redir_endp = get_lval(redir_varname, NULL, redir_lval,
4544 FALSE, FALSE, 0, FNE_CHECK_START);
4545 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004546 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004547 (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004548 clear_lval(redir_lval);
4549 }
4550
4551 // free the collected output
4552 VIM_CLEAR(redir_ga.ga_data);
4553
4554 VIM_CLEAR(redir_lval);
4555 }
4556 VIM_CLEAR(redir_varname);
4557}
4558
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004559/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004560 * Get the collected redirected text and clear redir_ga.
4561 */
4562 char_u *
4563get_clear_redir_ga(void)
4564{
4565 char_u *res;
4566
4567 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4568 res = redir_ga.ga_data;
4569 redir_ga.ga_data = NULL;
4570 return res;
4571}
4572
4573/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004574 * "gettabvar()" function
4575 */
4576 void
4577f_gettabvar(typval_T *argvars, typval_T *rettv)
4578{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004579 char_u *varname;
LemonBoy47d4e312022-05-04 18:12:55 +01004580 tabpage_T *tp;
4581 win_T *win = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004582
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004583 if (in_vim9script()
4584 && (check_for_number_arg(argvars, 0) == FAIL
4585 || check_for_string_arg(argvars, 1) == FAIL))
4586 return;
4587
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004588 varname = tv_get_string_chk(&argvars[1]);
4589 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
LemonBoy47d4e312022-05-04 18:12:55 +01004590 if (tp != NULL)
4591 win = tp == curtab || tp->tp_firstwin == NULL ? firstwin
4592 : tp->tp_firstwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004593
LemonBoy47d4e312022-05-04 18:12:55 +01004594 get_var_from(varname, rettv, &argvars[2], 't', tp, win, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004595}
4596
4597/*
4598 * "gettabwinvar()" function
4599 */
4600 void
4601f_gettabwinvar(typval_T *argvars, typval_T *rettv)
4602{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004603 if (in_vim9script()
4604 && (check_for_number_arg(argvars, 0) == FAIL
4605 || check_for_number_arg(argvars, 1) == FAIL
4606 || check_for_string_arg(argvars, 2) == FAIL))
4607 return;
4608
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004609 getwinvar(argvars, rettv, 1);
4610}
4611
4612/*
4613 * "getwinvar()" function
4614 */
4615 void
4616f_getwinvar(typval_T *argvars, typval_T *rettv)
4617{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004618 if (in_vim9script()
4619 && (check_for_number_arg(argvars, 0) == FAIL
4620 || check_for_string_arg(argvars, 1) == FAIL))
4621 return;
4622
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004623 getwinvar(argvars, rettv, 0);
4624}
4625
4626/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004627 * "getbufvar()" function
4628 */
4629 void
4630f_getbufvar(typval_T *argvars, typval_T *rettv)
4631{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004632 char_u *varname;
LemonBoy47d4e312022-05-04 18:12:55 +01004633 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004634
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004635 if (in_vim9script()
4636 && (check_for_buffer_arg(argvars, 0) == FAIL
4637 || check_for_string_arg(argvars, 1) == FAIL))
4638 return;
4639
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004640 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004641 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004642
LemonBoy47d4e312022-05-04 18:12:55 +01004643 get_var_from(varname, rettv, &argvars[2], 'b', curtab, curwin, buf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004644}
4645
4646/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004647 * "settabvar()" function
4648 */
4649 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004650f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004651{
4652 tabpage_T *save_curtab;
4653 tabpage_T *tp;
4654 char_u *varname, *tabvarname;
4655 typval_T *varp;
4656
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004657 if (check_secure())
4658 return;
4659
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004660 if (in_vim9script()
4661 && (check_for_number_arg(argvars, 0) == FAIL
4662 || check_for_string_arg(argvars, 1) == FAIL))
4663 return;
4664
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004665 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4666 varname = tv_get_string_chk(&argvars[1]);
4667 varp = &argvars[2];
4668
4669 if (varname != NULL && varp != NULL && tp != NULL)
4670 {
4671 save_curtab = curtab;
4672 goto_tabpage_tp(tp, FALSE, FALSE);
4673
4674 tabvarname = alloc(STRLEN(varname) + 3);
4675 if (tabvarname != NULL)
4676 {
4677 STRCPY(tabvarname, "t:");
4678 STRCPY(tabvarname + 2, varname);
4679 set_var(tabvarname, varp, TRUE);
4680 vim_free(tabvarname);
4681 }
4682
4683 // Restore current tabpage
4684 if (valid_tabpage(save_curtab))
4685 goto_tabpage_tp(save_curtab, FALSE, FALSE);
4686 }
4687}
4688
4689/*
4690 * "settabwinvar()" function
4691 */
4692 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004693f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004694{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004695 if (in_vim9script()
4696 && (check_for_number_arg(argvars, 0) == FAIL
4697 || check_for_number_arg(argvars, 1) == FAIL
4698 || check_for_string_arg(argvars, 2) == FAIL))
4699 return;
4700
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004701 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004702}
4703
4704/*
4705 * "setwinvar()" function
4706 */
4707 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004708f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004709{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004710 if (in_vim9script()
4711 && (check_for_number_arg(argvars, 0) == FAIL
4712 || check_for_string_arg(argvars, 1) == FAIL))
4713 return;
4714
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004715 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004716}
4717
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004718/*
4719 * "setbufvar()" function
4720 */
4721 void
4722f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
4723{
4724 buf_T *buf;
4725 char_u *varname, *bufvarname;
4726 typval_T *varp;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004727
4728 if (check_secure())
4729 return;
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004730
4731 if (in_vim9script()
4732 && (check_for_buffer_arg(argvars, 0) == FAIL
4733 || check_for_string_arg(argvars, 1) == FAIL))
4734 return;
4735
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004736 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004737 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004738 varp = &argvars[2];
4739
4740 if (buf != NULL && varname != NULL && varp != NULL)
4741 {
4742 if (*varname == '&')
4743 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004744 aco_save_T aco;
4745
4746 // set curbuf to be our buf, temporarily
4747 aucmd_prepbuf(&aco, buf);
4748
Bram Moolenaar191929b2020-08-19 21:20:49 +02004749 set_option_from_tv(varname + 1, varp);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004750
4751 // reset notion of buffer
4752 aucmd_restbuf(&aco);
4753 }
4754 else
4755 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004756 bufvarname = alloc(STRLEN(varname) + 3);
4757 if (bufvarname != NULL)
4758 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004759 buf_T *save_curbuf = curbuf;
4760
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004761 curbuf = buf;
4762 STRCPY(bufvarname, "b:");
4763 STRCPY(bufvarname + 2, varname);
4764 set_var(bufvarname, varp, TRUE);
4765 vim_free(bufvarname);
4766 curbuf = save_curbuf;
4767 }
4768 }
4769 }
4770}
4771
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004772/*
4773 * Get a callback from "arg". It can be a Funcref or a function name.
4774 * When "arg" is zero return an empty string.
4775 * "cb_name" is not allocated.
4776 * "cb_name" is set to NULL for an invalid argument.
4777 */
4778 callback_T
4779get_callback(typval_T *arg)
4780{
Bram Moolenaar14e579092020-03-07 16:59:25 +01004781 callback_T res;
4782 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004783
4784 res.cb_free_name = FALSE;
4785 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
4786 {
4787 res.cb_partial = arg->vval.v_partial;
4788 ++res.cb_partial->pt_refcount;
4789 res.cb_name = partial_name(res.cb_partial);
4790 }
4791 else
4792 {
4793 res.cb_partial = NULL;
Bram Moolenaar14e579092020-03-07 16:59:25 +01004794 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
4795 && isdigit(*arg->vval.v_string))
4796 r = FAIL;
4797 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004798 {
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004799 if (arg->v_type == VAR_STRING)
4800 {
4801 char_u *name;
4802
4803 name = get_scriptlocal_funcname(arg->vval.v_string);
4804 if (name != NULL)
4805 {
4806 vim_free(arg->vval.v_string);
4807 arg->vval.v_string = name;
4808 }
4809 }
4810
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004811 res.cb_name = arg->vval.v_string;
4812 func_ref(res.cb_name);
4813 }
4814 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004815 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004816 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01004817 r = FAIL;
4818
4819 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004820 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004821 emsg(_(e_invalid_callback_argument));
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004822 res.cb_name = NULL;
4823 }
4824 }
4825 return res;
4826}
4827
4828/*
4829 * Copy a callback into a typval_T.
4830 */
4831 void
4832put_callback(callback_T *cb, typval_T *tv)
4833{
4834 if (cb->cb_partial != NULL)
4835 {
4836 tv->v_type = VAR_PARTIAL;
4837 tv->vval.v_partial = cb->cb_partial;
4838 ++tv->vval.v_partial->pt_refcount;
4839 }
4840 else
4841 {
4842 tv->v_type = VAR_FUNC;
4843 tv->vval.v_string = vim_strsave(cb->cb_name);
4844 func_ref(cb->cb_name);
4845 }
4846}
4847
4848/*
4849 * Make a copy of "src" into "dest", allocating the function name if needed,
4850 * without incrementing the refcount.
4851 */
4852 void
4853set_callback(callback_T *dest, callback_T *src)
4854{
4855 if (src->cb_partial == NULL)
4856 {
4857 // just a function name, make a copy
4858 dest->cb_name = vim_strsave(src->cb_name);
4859 dest->cb_free_name = TRUE;
4860 }
4861 else
4862 {
4863 // cb_name is a pointer into cb_partial
4864 dest->cb_name = src->cb_name;
4865 dest->cb_free_name = FALSE;
4866 }
4867 dest->cb_partial = src->cb_partial;
4868}
4869
4870/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02004871 * Copy callback from "src" to "dest", incrementing the refcounts.
4872 */
4873 void
4874copy_callback(callback_T *dest, callback_T *src)
4875{
4876 dest->cb_partial = src->cb_partial;
4877 if (dest->cb_partial != NULL)
4878 {
4879 dest->cb_name = src->cb_name;
4880 dest->cb_free_name = FALSE;
4881 ++dest->cb_partial->pt_refcount;
4882 }
4883 else
4884 {
4885 dest->cb_name = vim_strsave(src->cb_name);
4886 dest->cb_free_name = TRUE;
4887 func_ref(src->cb_name);
4888 }
4889}
4890
4891/*
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004892 * When a callback refers to an autoload import, change the function name to
4893 * the "path#name" form. Uses the current script context.
4894 * Only works when the name is allocated.
4895 */
4896 void
4897expand_autload_callback(callback_T *cb)
4898{
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004899 char_u *name;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004900 char_u *p;
4901 imported_T *import;
4902
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004903 if (!in_vim9script() || cb->cb_name == NULL
4904 || (!cb->cb_free_name
4905 && (cb->cb_partial == NULL || cb->cb_partial->pt_name == NULL)))
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004906 return;
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004907 if (cb->cb_partial != NULL)
4908 name = cb->cb_partial->pt_name;
4909 else
4910 name = cb->cb_name;
4911 p = vim_strchr(name, '.');
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004912 if (p == NULL)
4913 return;
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004914 import = find_imported(name, p - name, FALSE);
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004915 if (import != NULL && SCRIPT_ID_VALID(import->imp_sid))
4916 {
4917 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
4918
4919 if (si->sn_autoload_prefix != NULL)
4920 {
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004921 char_u *newname = concat_str(si->sn_autoload_prefix, p + 1);
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004922
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004923 if (newname != NULL)
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004924 {
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004925 if (cb->cb_partial != NULL)
4926 {
4927 if (cb->cb_name == cb->cb_partial->pt_name)
4928 cb->cb_name = newname;
4929 vim_free(cb->cb_partial->pt_name);
4930 cb->cb_partial->pt_name = newname;
4931 }
4932 else
4933 {
4934 vim_free(cb->cb_name);
4935 cb->cb_name = newname;
4936 }
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004937 }
4938 }
4939 }
4940}
4941
4942/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004943 * Unref/free "callback" returned by get_callback() or set_callback().
4944 */
4945 void
4946free_callback(callback_T *callback)
4947{
4948 if (callback->cb_partial != NULL)
4949 {
4950 partial_unref(callback->cb_partial);
4951 callback->cb_partial = NULL;
4952 }
4953 else if (callback->cb_name != NULL)
4954 func_unref(callback->cb_name);
4955 if (callback->cb_free_name)
4956 {
4957 vim_free(callback->cb_name);
4958 callback->cb_free_name = FALSE;
4959 }
4960 callback->cb_name = NULL;
4961}
4962
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004963#endif // FEAT_EVAL