blob: c4b95bc17c628c48a14c000d6b8f487b946ada70 [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 {
1069 list_T *l;
Bram Moolenaar81530e32021-07-28 21:25:49 +02001070 long cur_lnum = SOURCING_LNUM;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001071
1072 // HERE document
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001073 l = heredoc_get(eap, expr + 3, FALSE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001074 if (l != NULL)
1075 {
1076 rettv_list_set(&rettv, l);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +02001077 if (!eap->skip)
1078 {
Bram Moolenaar81530e32021-07-28 21:25:49 +02001079 // errors are for the assignment, not the end marker
1080 SOURCING_LNUM = cur_lnum;
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +02001081 op[0] = '=';
1082 op[1] = NUL;
1083 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001084 flags, op);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +02001085 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001086 clear_tv(&rettv);
1087 }
1088 }
1089 else
1090 {
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001091 evalarg_T evalarg;
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001092 int len = 1;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001093
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02001094 CLEAR_FIELD(rettv);
Bram Moolenaar32e35112020-05-14 22:41:15 +02001095 i = FAIL;
1096 if (has_assign || concat)
1097 {
Bram Moolenaar9a562c12021-01-23 13:39:14 +01001098 int cur_lnum;
1099
Bram Moolenaar32e35112020-05-14 22:41:15 +02001100 op[0] = '=';
1101 op[1] = NUL;
1102 if (*expr != '=')
1103 {
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001104 if (vim9script && (flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar122616d2020-08-21 21:32:50 +02001105 {
1106 // +=, /=, etc. require an existing variable
1107 semsg(_(e_cannot_use_operator_on_new_variable), eap->arg);
Bram Moolenaar122616d2020-08-21 21:32:50 +02001108 }
1109 else if (vim_strchr((char_u *)"+-*/%.", *expr) != NULL)
Bram Moolenaar32e35112020-05-14 22:41:15 +02001110 {
1111 op[0] = *expr; // +=, -=, *=, /=, %= or .=
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001112 ++len;
Bram Moolenaar32e35112020-05-14 22:41:15 +02001113 if (expr[0] == '.' && expr[1] == '.') // ..=
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001114 {
Bram Moolenaar32e35112020-05-14 22:41:15 +02001115 ++expr;
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001116 ++len;
1117 }
Bram Moolenaar32e35112020-05-14 22:41:15 +02001118 }
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001119 expr += 2;
Bram Moolenaar32e35112020-05-14 22:41:15 +02001120 }
1121 else
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001122 ++expr;
1123
Bram Moolenaar7f2c3412021-11-29 16:01:49 +00001124 if (vim9script && !eap->skip && (!VIM_ISWHITE(*argend)
Bram Moolenaarc7e44a72020-07-29 21:37:43 +02001125 || !IS_WHITE_OR_NUL(*expr)))
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001126 {
1127 vim_strncpy(op, expr - len, len);
Bram Moolenaare7a73e02021-01-01 19:17:55 +01001128 semsg(_(e_white_space_required_before_and_after_str_at_str),
1129 op, argend);
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001130 }
Bram Moolenaar32e35112020-05-14 22:41:15 +02001131
1132 if (eap->skip)
1133 ++emsg_skip;
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001134 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaarc7e44a72020-07-29 21:37:43 +02001135 expr = skipwhite_and_linebreak(expr, &evalarg);
Bram Moolenaar9a562c12021-01-23 13:39:14 +01001136 cur_lnum = SOURCING_LNUM;
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001137 i = eval0(expr, &rettv, eap, &evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001138 if (eap->skip)
1139 --emsg_skip;
Bram Moolenaarfaf86262020-06-27 23:07:36 +02001140 clear_evalarg(&evalarg, eap);
Bram Moolenaar9a562c12021-01-23 13:39:14 +01001141
1142 // Restore the line number so that any type error is given for the
1143 // declaration, not the expression.
1144 SOURCING_LNUM = cur_lnum;
Bram Moolenaar32e35112020-05-14 22:41:15 +02001145 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001146 if (eap->skip)
1147 {
1148 if (i != FAIL)
1149 clear_tv(&rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001150 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02001151 else if (i != FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001152 {
1153 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001154 flags, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001155 clear_tv(&rettv);
1156 }
1157 }
1158}
1159
1160/*
Bram Moolenaar6c3843c2021-03-04 12:38:21 +01001161 * Assign the typeval "tv" to the variable or variables at "arg_start".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001162 * Handles both "var" with any type and "[var, var; var]" with a list type.
1163 * When "op" is not NULL it points to a string with characters that
1164 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1165 * or concatenate.
1166 * Returns OK or FAIL;
1167 */
1168 int
1169ex_let_vars(
1170 char_u *arg_start,
1171 typval_T *tv,
1172 int copy, // copy values from "tv", don't move
1173 int semicolon, // from skip_var_list()
1174 int var_count, // from skip_var_list()
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001175 int flags, // ASSIGN_FINAL, ASSIGN_CONST, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001176 char_u *op)
1177{
1178 char_u *arg = arg_start;
1179 list_T *l;
1180 int i;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001181 int var_idx = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001182 listitem_T *item;
1183 typval_T ltv;
1184
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00001185 if (tv->v_type == VAR_VOID)
1186 {
1187 emsg(_(e_cannot_use_void_value));
1188 return FAIL;
1189 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001190 if (*arg != '[')
1191 {
1192 // ":let var = expr" or ":for var in list"
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001193 if (ex_let_one(arg, tv, copy, flags, op, op, var_idx) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001194 return FAIL;
1195 return OK;
1196 }
1197
1198 // ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1199 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1200 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001201 emsg(_(e_list_required));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001202 return FAIL;
1203 }
1204
1205 i = list_len(l);
1206 if (semicolon == 0 && var_count < i)
1207 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00001208 emsg(_(e_less_targets_than_list_items));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001209 return FAIL;
1210 }
1211 if (var_count - semicolon > i)
1212 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00001213 emsg(_(e_more_targets_than_list_items));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001214 return FAIL;
1215 }
1216
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001217 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001218 item = l->lv_first;
1219 while (*arg != ']')
1220 {
1221 arg = skipwhite(arg + 1);
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001222 ++var_idx;
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02001223 arg = ex_let_one(arg, &item->li_tv, TRUE,
1224 flags | ASSIGN_UNPACK, (char_u *)",;]", op, var_idx);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001225 item = item->li_next;
1226 if (arg == NULL)
1227 return FAIL;
1228
1229 arg = skipwhite(arg);
1230 if (*arg == ';')
1231 {
1232 // Put the rest of the list (may be empty) in the var after ';'.
1233 // Create a new list for this.
1234 l = list_alloc();
1235 if (l == NULL)
1236 return FAIL;
1237 while (item != NULL)
1238 {
1239 list_append_tv(l, &item->li_tv);
1240 item = item->li_next;
1241 }
1242
1243 ltv.v_type = VAR_LIST;
1244 ltv.v_lock = 0;
1245 ltv.vval.v_list = l;
1246 l->lv_refcount = 1;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001247 ++var_idx;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001248
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02001249 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1250 flags | ASSIGN_UNPACK, (char_u *)"]", op, var_idx);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001251 clear_tv(&ltv);
1252 if (arg == NULL)
1253 return FAIL;
1254 break;
1255 }
1256 else if (*arg != ',' && *arg != ']')
1257 {
1258 internal_error("ex_let_vars()");
1259 return FAIL;
1260 }
1261 }
1262
1263 return OK;
1264}
1265
1266/*
1267 * Skip over assignable variable "var" or list of variables "[var, var]".
1268 * Used for ":let varvar = expr" and ":for varvar in expr".
1269 * For "[var, var]" increment "*var_count" for each variable.
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001270 * for "[var, var; var]" set "semicolon" to 1.
1271 * If "silent" is TRUE do not give an "invalid argument" error message.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001272 * Return NULL for an error.
1273 */
1274 char_u *
1275skip_var_list(
1276 char_u *arg,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001277 int include_type,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001278 int *var_count,
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001279 int *semicolon,
1280 int silent)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001281{
1282 char_u *p, *s;
1283
1284 if (*arg == '[')
1285 {
1286 // "[var, var]": find the matching ']'.
1287 p = arg;
1288 for (;;)
1289 {
1290 p = skipwhite(p + 1); // skip whites after '[', ';' or ','
Bram Moolenaar036d0712021-01-17 20:23:38 +01001291 s = skip_var_one(p, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001292 if (s == p)
1293 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001294 if (!silent)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001295 semsg(_(e_invalid_argument_str), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001296 return NULL;
1297 }
1298 ++*var_count;
1299
1300 p = skipwhite(s);
1301 if (*p == ']')
1302 break;
1303 else if (*p == ';')
1304 {
1305 if (*semicolon == 1)
1306 {
Bram Moolenaar8b716f52022-02-15 21:17:56 +00001307 if (!silent)
1308 emsg(_(e_double_semicolon_in_list_of_variables));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001309 return NULL;
1310 }
1311 *semicolon = 1;
1312 }
1313 else if (*p != ',')
1314 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001315 if (!silent)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001316 semsg(_(e_invalid_argument_str), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001317 return NULL;
1318 }
1319 }
1320 return p + 1;
1321 }
Bram Moolenaare8e369a2022-09-21 18:59:14 +01001322
1323 return skip_var_one(arg, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001324}
1325
1326/*
1327 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1328 * l[idx].
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001329 * In Vim9 script also skip over ": type" if "include_type" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001330 */
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001331 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001332skip_var_one(char_u *arg, int include_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001333{
Bram Moolenaar585587d2021-01-17 20:52:13 +01001334 char_u *end;
1335 int vim9 = in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001336
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001337 if (*arg == '@' && arg[1] != NUL)
1338 return arg + 2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001339 end = find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001340 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
Bram Moolenaar036d0712021-01-17 20:23:38 +01001341
1342 // "a: type" is declaring variable "a" with a type, not "a:".
1343 // Same for "s: type".
Bram Moolenaar585587d2021-01-17 20:52:13 +01001344 if (vim9 && end == arg + 2 && end[-1] == ':')
Bram Moolenaar036d0712021-01-17 20:23:38 +01001345 --end;
1346
Bram Moolenaar585587d2021-01-17 20:52:13 +01001347 if (include_type && vim9)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001348 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001349 if (*end == ':')
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02001350 end = skip_type(skipwhite(end + 1), FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001351 }
1352 return end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001353}
1354
1355/*
1356 * List variables for hashtab "ht" with prefix "prefix".
1357 * If "empty" is TRUE also list NULL strings as empty strings.
1358 */
1359 void
1360list_hashtable_vars(
1361 hashtab_T *ht,
1362 char *prefix,
1363 int empty,
1364 int *first)
1365{
1366 hashitem_T *hi;
1367 dictitem_T *di;
1368 int todo;
1369 char_u buf[IOSIZE];
1370
1371 todo = (int)ht->ht_used;
1372 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1373 {
1374 if (!HASHITEM_EMPTY(hi))
1375 {
1376 --todo;
1377 di = HI2DI(hi);
1378
1379 // apply :filter /pat/ to variable name
1380 vim_strncpy((char_u *)buf, (char_u *)prefix, IOSIZE - 1);
1381 vim_strcat((char_u *)buf, di->di_key, IOSIZE);
1382 if (message_filtered(buf))
1383 continue;
1384
1385 if (empty || di->di_tv.v_type != VAR_STRING
1386 || di->di_tv.vval.v_string != NULL)
1387 list_one_var(di, prefix, first);
1388 }
1389 }
1390}
1391
1392/*
1393 * List global variables.
1394 */
1395 static void
1396list_glob_vars(int *first)
1397{
1398 list_hashtable_vars(&globvarht, "", TRUE, first);
1399}
1400
1401/*
1402 * List buffer variables.
1403 */
1404 static void
1405list_buf_vars(int *first)
1406{
1407 list_hashtable_vars(&curbuf->b_vars->dv_hashtab, "b:", TRUE, first);
1408}
1409
1410/*
1411 * List window variables.
1412 */
1413 static void
1414list_win_vars(int *first)
1415{
1416 list_hashtable_vars(&curwin->w_vars->dv_hashtab, "w:", TRUE, first);
1417}
1418
1419/*
1420 * List tab page variables.
1421 */
1422 static void
1423list_tab_vars(int *first)
1424{
1425 list_hashtable_vars(&curtab->tp_vars->dv_hashtab, "t:", TRUE, first);
1426}
1427
1428/*
1429 * List variables in "arg".
1430 */
1431 static char_u *
1432list_arg_vars(exarg_T *eap, char_u *arg, int *first)
1433{
1434 int error = FALSE;
1435 int len;
1436 char_u *name;
1437 char_u *name_start;
1438 char_u *arg_subsc;
1439 char_u *tofree;
1440 typval_T tv;
1441
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001442 while (!ends_excmd2(eap->cmd, arg) && !got_int)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001443 {
1444 if (error || eap->skip)
1445 {
1446 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1447 if (!VIM_ISWHITE(*arg) && !ends_excmd(*arg))
1448 {
1449 emsg_severe = TRUE;
Bram Moolenaar4830c212021-08-14 14:59:27 +02001450 if (!did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00001451 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001452 break;
1453 }
1454 }
1455 else
1456 {
1457 // get_name_len() takes care of expanding curly braces
1458 name_start = name = arg;
1459 len = get_name_len(&arg, &tofree, TRUE, TRUE);
1460 if (len <= 0)
1461 {
1462 // This is mainly to keep test 49 working: when expanding
1463 // curly braces fails overrule the exception error message.
1464 if (len < 0 && !aborting())
1465 {
1466 emsg_severe = TRUE;
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001467 semsg(_(e_invalid_argument_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001468 break;
1469 }
1470 error = TRUE;
1471 }
1472 else
1473 {
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02001474 arg = skipwhite(arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001475 if (tofree != NULL)
1476 name = tofree;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001477 if (eval_variable(name, len, 0, &tv, NULL,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01001478 EVAL_VAR_VERBOSE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001479 error = TRUE;
1480 else
1481 {
1482 // handle d.key, l[idx], f(expr)
1483 arg_subsc = arg;
Bram Moolenaar32884ad2022-01-07 12:45:29 +00001484 if (handle_subscript(&arg, name_start, &tv,
1485 &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001486 error = TRUE;
1487 else
1488 {
1489 if (arg == arg_subsc && len == 2 && name[1] == ':')
1490 {
1491 switch (*name)
1492 {
1493 case 'g': list_glob_vars(first); break;
1494 case 'b': list_buf_vars(first); break;
1495 case 'w': list_win_vars(first); break;
1496 case 't': list_tab_vars(first); break;
1497 case 'v': list_vim_vars(first); break;
1498 case 's': list_script_vars(first); break;
1499 case 'l': list_func_vars(first); break;
1500 default:
Bram Moolenaara6f79292022-01-04 21:30:47 +00001501 semsg(_(e_cant_list_variables_for_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001502 }
1503 }
1504 else
1505 {
1506 char_u numbuf[NUMBUFLEN];
1507 char_u *tf;
1508 int c;
1509 char_u *s;
1510
1511 s = echo_string(&tv, &tf, numbuf, 0);
1512 c = *arg;
1513 *arg = NUL;
1514 list_one_var_a("",
1515 arg == arg_subsc ? name : name_start,
1516 tv.v_type,
1517 s == NULL ? (char_u *)"" : s,
1518 first);
1519 *arg = c;
1520 vim_free(tf);
1521 }
1522 clear_tv(&tv);
1523 }
1524 }
1525 }
1526
1527 vim_free(tofree);
1528 }
1529
1530 arg = skipwhite(arg);
1531 }
1532
1533 return arg;
1534}
1535
1536/*
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001537 * Set an environment variable, part of ex_let_one().
1538 */
1539 static char_u *
1540ex_let_env(
1541 char_u *arg,
1542 typval_T *tv,
1543 int flags,
1544 char_u *endchars,
1545 char_u *op)
1546{
1547 char_u *arg_end = NULL;
1548 char_u *name;
1549 int len;
1550
1551 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1552 && (flags & ASSIGN_FOR_LOOP) == 0)
1553 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001554 emsg(_(e_cannot_lock_environment_variable));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001555 return NULL;
1556 }
1557
1558 // Find the end of the name.
1559 ++arg;
1560 name = arg;
1561 len = get_env_len(&arg);
1562 if (len == 0)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001563 semsg(_(e_invalid_argument_str), name - 1);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001564 else
1565 {
1566 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001567 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001568 else if (endchars != NULL
1569 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
1570 emsg(_(e_unexpected_characters_in_let));
1571 else if (!check_secure())
1572 {
1573 char_u *tofree = NULL;
1574 int c1 = name[len];
1575 char_u *p;
1576
1577 name[len] = NUL;
1578 p = tv_get_string_chk(tv);
1579 if (p != NULL && op != NULL && *op == '.')
1580 {
1581 int mustfree = FALSE;
1582 char_u *s = vim_getenv(name, &mustfree);
1583
1584 if (s != NULL)
1585 {
1586 p = tofree = concat_str(s, p);
1587 if (mustfree)
1588 vim_free(s);
1589 }
1590 }
1591 if (p != NULL)
1592 {
1593 vim_setenv_ext(name, p);
1594 arg_end = arg;
1595 }
1596 name[len] = c1;
1597 vim_free(tofree);
1598 }
1599 }
1600 return arg_end;
1601}
1602
1603/*
1604 * Set an option, part of ex_let_one().
1605 */
1606 static char_u *
1607ex_let_option(
1608 char_u *arg,
1609 typval_T *tv,
1610 int flags,
1611 char_u *endchars,
1612 char_u *op)
1613{
1614 char_u *p;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001615 int scope;
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001616 char_u *arg_end = NULL;
1617
1618 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1619 && (flags & ASSIGN_FOR_LOOP) == 0)
1620 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001621 emsg(_(e_cannot_lock_option));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001622 return NULL;
1623 }
1624
1625 // Find the end of the name.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001626 p = find_option_end(&arg, &scope);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001627 if (p == NULL || (endchars != NULL
1628 && vim_strchr(endchars, *skipwhite(p)) == NULL))
1629 emsg(_(e_unexpected_characters_in_let));
1630 else
1631 {
1632 int c1;
1633 long n = 0;
1634 getoption_T opt_type;
1635 long numval;
1636 char_u *stringval = NULL;
1637 char_u *s = NULL;
1638 int failed = FALSE;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001639 int opt_p_flags;
1640 char_u *tofree = NULL;
Bram Moolenaar92c33eb2021-12-07 11:03:39 +00001641 char_u numbuf[NUMBUFLEN];
1642
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001643 c1 = *p;
1644 *p = NUL;
1645
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001646 opt_type = get_option_value(arg, &numval, &stringval, &opt_p_flags,
1647 scope);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001648 if ((opt_type == gov_bool
1649 || opt_type == gov_number
1650 || opt_type == gov_hidden_bool
1651 || opt_type == gov_hidden_number)
1652 && (tv->v_type != VAR_STRING || !in_vim9script()))
1653 {
1654 if (opt_type == gov_bool || opt_type == gov_hidden_bool)
1655 // bool, possibly hidden
1656 n = (long)tv_get_bool(tv);
1657 else
1658 // number, possibly hidden
1659 n = (long)tv_get_number(tv);
1660 }
1661
Bram Moolenaaref082e12021-12-12 21:02:03 +00001662 if ((opt_p_flags & P_FUNC) && (tv->v_type == VAR_PARTIAL
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001663 || tv->v_type == VAR_FUNC))
1664 {
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001665 // If the option can be set to a function reference or a lambda
1666 // and the passed value is a function reference, then convert it to
1667 // the name (string) of the function reference.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001668 s = tv2string(tv, &tofree, numbuf, 0);
1669 }
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001670 // Avoid setting a string option to the text "v:false" or similar.
1671 // In Vim9 script also don't convert a number to string.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001672 else if (tv->v_type != VAR_BOOL && tv->v_type != VAR_SPECIAL
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001673 && (!in_vim9script() || tv->v_type != VAR_NUMBER))
1674 s = tv_get_string_chk(tv);
1675
1676 if (op != NULL && *op != '=')
1677 {
1678 if (((opt_type == gov_bool || opt_type == gov_number) && *op == '.')
1679 || (opt_type == gov_string && *op != '.'))
1680 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001681 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001682 failed = TRUE; // don't set the value
1683
1684 }
1685 else
1686 {
1687 // number, in legacy script also bool
1688 if (opt_type == gov_number
1689 || (opt_type == gov_bool && !in_vim9script()))
1690 {
1691 switch (*op)
1692 {
1693 case '+': n = numval + n; break;
1694 case '-': n = numval - n; break;
1695 case '*': n = numval * n; break;
1696 case '/': n = (long)num_divide(numval, n,
1697 &failed); break;
1698 case '%': n = (long)num_modulus(numval, n,
1699 &failed); break;
1700 }
1701 s = NULL;
1702 }
1703 else if (opt_type == gov_string
1704 && stringval != NULL && s != NULL)
1705 {
1706 // string
1707 s = concat_str(stringval, s);
1708 vim_free(stringval);
1709 stringval = s;
1710 }
1711 }
1712 }
1713
1714 if (!failed)
1715 {
1716 if (opt_type != gov_string || s != NULL)
1717 {
Bram Moolenaar8ccbbeb2022-03-02 19:49:38 +00001718 char *err = set_option_value(arg, n, s, scope);
1719
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001720 arg_end = p;
Bram Moolenaar8ccbbeb2022-03-02 19:49:38 +00001721 if (err != NULL)
1722 emsg(_(err));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001723 }
1724 else
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001725 emsg(_(e_string_required));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001726 }
1727 *p = c1;
1728 vim_free(stringval);
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001729 vim_free(tofree);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001730 }
1731 return arg_end;
1732}
1733
1734/*
1735 * Set a register, part of ex_let_one().
1736 */
1737 static char_u *
1738ex_let_register(
1739 char_u *arg,
1740 typval_T *tv,
1741 int flags,
1742 char_u *endchars,
1743 char_u *op)
1744{
1745 char_u *arg_end = NULL;
1746
1747 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1748 && (flags & ASSIGN_FOR_LOOP) == 0)
1749 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001750 emsg(_(e_cannot_lock_register));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001751 return NULL;
1752 }
1753 ++arg;
1754 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001755 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001756 else if (endchars != NULL
1757 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
1758 emsg(_(e_unexpected_characters_in_let));
1759 else
1760 {
1761 char_u *ptofree = NULL;
1762 char_u *p;
1763
1764 p = tv_get_string_chk(tv);
1765 if (p != NULL && op != NULL && *op == '.')
1766 {
1767 char_u *s = get_reg_contents(*arg == '@'
1768 ? '"' : *arg, GREG_EXPR_SRC);
1769
1770 if (s != NULL)
1771 {
1772 p = ptofree = concat_str(s, p);
1773 vim_free(s);
1774 }
1775 }
1776 if (p != NULL)
1777 {
1778 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
1779 arg_end = arg + 1;
1780 }
1781 vim_free(ptofree);
1782 }
1783 return arg_end;
1784}
1785
1786/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001787 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
1788 * Returns a pointer to the char just after the var name.
1789 * Returns NULL if there is an error.
1790 */
1791 static char_u *
1792ex_let_one(
1793 char_u *arg, // points to variable name
1794 typval_T *tv, // value to assign to variable
1795 int copy, // copy value from "tv"
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001796 int flags, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001797 char_u *endchars, // valid chars after variable name or NULL
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001798 char_u *op, // "+", "-", "." or NULL
1799 int var_idx) // variable index for "let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001800{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001801 char_u *arg_end = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001802
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001803 if (in_vim9script() && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001804 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001805 && vim_strchr((char_u *)"$@&", *arg) != NULL)
1806 {
1807 vim9_declare_error(arg);
1808 return NULL;
1809 }
1810
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001811 if (*arg == '$')
1812 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001813 // ":let $VAR = expr": Set environment variable.
1814 return ex_let_env(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001815 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001816 else if (*arg == '&')
1817 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001818 // ":let &option = expr": Set option value.
1819 // ":let &l:option = expr": Set local option value.
1820 // ":let &g:option = expr": Set global option value.
1821 // ":for &ts in range(8)": Set option value for for loop
1822 return ex_let_option(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001823 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001824 else if (*arg == '@')
1825 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001826 // ":let @r = expr": Set register contents.
1827 return ex_let_register(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001828 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001829 else if (eval_isnamec1(*arg) || *arg == '{')
1830 {
1831 lval_T lv;
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001832 char_u *p;
Bram Moolenaar22ebd172022-04-01 15:26:58 +01001833 int lval_flags = (flags & (ASSIGN_NO_DECL | ASSIGN_DECL))
1834 ? GLV_NO_DECL : 0;
1835 if (op != NULL && *op != '=')
1836 lval_flags |= GLV_ASSIGN_WITH_OP;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001837
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001838 // ":let var = expr": Set internal variable.
1839 // ":let var: type = expr": Set internal variable with type.
1840 // ":let {expr} = expr": Idem, name made with curly braces
Bram Moolenaar22ebd172022-04-01 15:26:58 +01001841 p = get_lval(arg, tv, &lv, FALSE, FALSE, lval_flags, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001842 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001843 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001844 if (endchars != NULL && vim_strchr(endchars,
1845 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001846 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001847 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001848 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001849 else
1850 {
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001851 set_var_lval(&lv, p, tv, copy, flags, op, var_idx);
Bram Moolenaara3589a02021-04-14 13:30:46 +02001852 arg_end = lv.ll_name_end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001853 }
1854 }
1855 clear_lval(&lv);
1856 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001857 else
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001858 semsg(_(e_invalid_argument_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001859
1860 return arg_end;
1861}
1862
1863/*
1864 * ":unlet[!] var1 ... " command.
1865 */
1866 void
1867ex_unlet(exarg_T *eap)
1868{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001869 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001870}
1871
1872/*
1873 * ":lockvar" and ":unlockvar" commands
1874 */
1875 void
1876ex_lockvar(exarg_T *eap)
1877{
1878 char_u *arg = eap->arg;
1879 int deep = 2;
1880
1881 if (eap->forceit)
1882 deep = -1;
1883 else if (vim_isdigit(*arg))
1884 {
1885 deep = getdigits(&arg);
1886 arg = skipwhite(arg);
1887 }
1888
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001889 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001890}
1891
1892/*
1893 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001894 * Also used for Vim9 script. "callback" is invoked as:
1895 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001896 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001897 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001898ex_unletlock(
1899 exarg_T *eap,
1900 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001901 int deep,
1902 int glv_flags,
1903 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1904 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001905{
1906 char_u *arg = argstart;
1907 char_u *name_end;
1908 int error = FALSE;
1909 lval_T lv;
1910
1911 do
1912 {
1913 if (*arg == '$')
1914 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001915 lv.ll_name = arg;
1916 lv.ll_tv = NULL;
1917 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001918 if (get_env_len(&arg) == 0)
1919 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001920 semsg(_(e_invalid_argument_str), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001921 return;
1922 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001923 if (!error && !eap->skip
1924 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1925 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001926 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001927 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001928 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001929 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001930 // Parse the name and find the end.
1931 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
Bram Moolenaarc3689572021-01-01 19:40:02 +01001932 glv_flags | GLV_NO_DECL, FNE_CHECK_START);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001933 if (lv.ll_name == NULL)
1934 error = TRUE; // error but continue parsing
1935 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1936 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001937 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001938 if (name_end != NULL)
1939 {
1940 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00001941 semsg(_(e_trailing_characters_str), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001942 }
1943 if (!(eap->skip || error))
1944 clear_lval(&lv);
1945 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001946 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001947
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001948 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001949 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001950 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001951
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001952 if (!eap->skip)
1953 clear_lval(&lv);
1954 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001955
1956 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001957 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001958
Bram Moolenaar63b91732021-08-05 20:40:03 +02001959 set_nextcmd(eap, arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001960}
1961
1962 static int
1963do_unlet_var(
1964 lval_T *lp,
1965 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001966 exarg_T *eap,
1967 int deep UNUSED,
1968 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001969{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001970 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001971 int ret = OK;
1972 int cc;
1973
1974 if (lp->ll_tv == NULL)
1975 {
1976 cc = *name_end;
1977 *name_end = NUL;
1978
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001979 // Environment variable, normal name or expanded name.
1980 if (*lp->ll_name == '$')
LemonBoy77142312022-04-15 20:50:46 +01001981 vim_unsetenv_ext(lp->ll_name + 1);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001982 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001983 ret = FAIL;
1984 *name_end = cc;
1985 }
1986 else if ((lp->ll_list != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001987 && value_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001988 || (lp->ll_dict != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02001989 && value_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001990 return FAIL;
1991 else if (lp->ll_range)
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00001992 list_unlet_range(lp->ll_list, lp->ll_li, lp->ll_n1,
1993 !lp->ll_empty2, lp->ll_n2);
1994 else if (lp->ll_list != NULL)
1995 // unlet a List item.
1996 listitem_remove(lp->ll_list, lp->ll_li);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001997 else
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00001998 // unlet a Dictionary item.
1999 dictitem_remove(lp->ll_dict, lp->ll_di);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002000
2001 return ret;
2002}
2003
2004/*
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002005 * Unlet one item or a range of items from a list.
2006 * Return OK or FAIL.
2007 */
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002008 void
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002009list_unlet_range(
2010 list_T *l,
2011 listitem_T *li_first,
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002012 long n1_arg,
2013 int has_n2,
2014 long n2)
2015{
2016 listitem_T *li = li_first;
2017 int n1 = n1_arg;
2018
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002019 // Delete a range of List items.
2020 li = li_first;
2021 n1 = n1_arg;
2022 while (li != NULL && (!has_n2 || n2 >= n1))
2023 {
2024 listitem_T *next = li->li_next;
2025
2026 listitem_remove(l, li);
2027 li = next;
2028 ++n1;
2029 }
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002030}
2031/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002032 * "unlet" a variable. Return OK if it existed, FAIL if not.
2033 * When "forceit" is TRUE don't complain if the variable doesn't exist.
2034 */
2035 int
2036do_unlet(char_u *name, int forceit)
2037{
2038 hashtab_T *ht;
2039 hashitem_T *hi;
mityu8be36ee2022-05-25 17:29:46 +01002040 char_u *varname = NULL; // init to shut up gcc
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002041 dict_T *d;
2042 dictitem_T *di;
2043
Bram Moolenaar9aed7292020-12-18 15:38:00 +01002044 // can't :unlet a script variable in Vim9 script
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002045 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002046 return FAIL;
2047
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002048 ht = find_var_ht(name, &varname);
Bram Moolenaar9aed7292020-12-18 15:38:00 +01002049
2050 // can't :unlet a script variable in Vim9 script from a function
2051 if (ht == get_script_local_ht()
2052 && SCRIPT_ID_VALID(current_sctx.sc_sid)
2053 && SCRIPT_ITEM(current_sctx.sc_sid)->sn_version
2054 == SCRIPT_VERSION_VIM9
2055 && check_vim9_unlet(name) == FAIL)
2056 return FAIL;
2057
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002058 if (ht != NULL && *varname != NUL)
2059 {
2060 d = get_current_funccal_dict(ht);
2061 if (d == NULL)
2062 {
2063 if (ht == &globvarht)
2064 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002065 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002066 d = &vimvardict;
2067 else
2068 {
2069 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
2070 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
2071 }
2072 if (d == NULL)
2073 {
2074 internal_error("do_unlet()");
2075 return FAIL;
2076 }
2077 }
2078 hi = hash_find(ht, varname);
2079 if (HASHITEM_EMPTY(hi))
2080 hi = find_hi_in_scoped_ht(name, &ht);
2081 if (hi != NULL && !HASHITEM_EMPTY(hi))
2082 {
2083 di = HI2DI(hi);
2084 if (var_check_fixed(di->di_flags, name, FALSE)
2085 || var_check_ro(di->di_flags, name, FALSE)
Bram Moolenaara187c432020-09-16 21:08:28 +02002086 || value_check_lock(d->dv_lock, name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002087 return FAIL;
2088
2089 delete_var(ht, hi);
2090 return OK;
2091 }
2092 }
2093 if (forceit)
2094 return OK;
Bram Moolenaare1242042021-12-16 20:56:57 +00002095 semsg(_(e_no_such_variable_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002096 return FAIL;
2097}
2098
2099/*
2100 * Lock or unlock variable indicated by "lp".
2101 * "deep" is the levels to go (-1 for unlimited);
2102 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
2103 */
2104 static int
2105do_lock_var(
2106 lval_T *lp,
2107 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002108 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002109 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002110 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002111{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002112 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002113 int ret = OK;
2114 int cc;
2115 dictitem_T *di;
2116
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002117 if (lp->ll_tv == NULL)
2118 {
2119 cc = *name_end;
2120 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002121 if (*lp->ll_name == '$')
2122 {
Bram Moolenaar3a846e62022-01-01 16:21:00 +00002123 semsg(_(e_cannot_lock_or_unlock_variable_str), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002124 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002125 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002126 else
2127 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002128 // Normal name or expanded name.
2129 di = find_var(lp->ll_name, NULL, TRUE);
2130 if (di == NULL)
Bram Moolenaar04b568b2021-11-22 21:58:41 +00002131 {
2132 if (in_vim9script())
2133 semsg(_(e_cannot_find_variable_to_unlock_str),
2134 lp->ll_name);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002135 ret = FAIL;
Bram Moolenaar04b568b2021-11-22 21:58:41 +00002136 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002137 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002138 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01002139 if ((di->di_flags & DI_FLAGS_FIX)
2140 && di->di_tv.v_type != VAR_DICT
2141 && di->di_tv.v_type != VAR_LIST)
2142 {
2143 // For historic reasons this error is not given for a list
2144 // or dict. E.g., the b: dict could be locked/unlocked.
2145 semsg(_(e_cannot_lock_or_unlock_variable_str), lp->ll_name);
2146 ret = FAIL;
2147 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002148 else
Bram Moolenaar7a411a32022-04-04 14:58:06 +01002149 {
2150 if (in_vim9script())
2151 {
2152 svar_T *sv = find_typval_in_script(&di->di_tv,
2153 0, FALSE);
2154
2155 if (sv != NULL && sv->sv_const != 0)
2156 {
2157 semsg(_(e_cannot_change_readonly_variable_str),
2158 lp->ll_name);
2159 ret = FAIL;
2160 }
2161 }
2162
2163 if (ret == OK)
2164 {
2165 if (lock)
2166 di->di_flags |= DI_FLAGS_LOCK;
2167 else
2168 di->di_flags &= ~DI_FLAGS_LOCK;
2169 if (deep != 0)
2170 item_lock(&di->di_tv, deep, lock, FALSE);
2171 }
2172 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002173 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002174 }
2175 *name_end = cc;
2176 }
Bram Moolenaara187c432020-09-16 21:08:28 +02002177 else if (deep == 0)
2178 {
2179 // nothing to do
2180 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002181 else if (lp->ll_range)
2182 {
2183 listitem_T *li = lp->ll_li;
2184
2185 // (un)lock a range of List items.
2186 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
2187 {
Bram Moolenaar021bda52020-08-17 21:07:22 +02002188 item_lock(&li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002189 li = li->li_next;
2190 ++lp->ll_n1;
2191 }
2192 }
2193 else if (lp->ll_list != NULL)
2194 // (un)lock a List item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002195 item_lock(&lp->ll_li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002196 else
2197 // (un)lock a Dictionary item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002198 item_lock(&lp->ll_di->di_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002199
2200 return ret;
2201}
2202
2203/*
2204 * Lock or unlock an item. "deep" is nr of levels to go.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002205 * When "check_refcount" is TRUE do not lock a list or dict with a reference
2206 * count larger than 1.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002207 */
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02002208 void
Bram Moolenaar021bda52020-08-17 21:07:22 +02002209item_lock(typval_T *tv, int deep, int lock, int check_refcount)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002210{
2211 static int recurse = 0;
2212 list_T *l;
2213 listitem_T *li;
2214 dict_T *d;
2215 blob_T *b;
2216 hashitem_T *hi;
2217 int todo;
2218
2219 if (recurse >= DICT_MAXNEST)
2220 {
Bram Moolenaar677658a2022-01-05 16:09:06 +00002221 emsg(_(e_variable_nested_too_deep_for_unlock));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002222 return;
2223 }
2224 if (deep == 0)
2225 return;
2226 ++recurse;
2227
2228 // lock/unlock the item itself
2229 if (lock)
2230 tv->v_lock |= VAR_LOCKED;
2231 else
2232 tv->v_lock &= ~VAR_LOCKED;
2233
2234 switch (tv->v_type)
2235 {
2236 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02002237 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002238 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002239 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002240 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002241 case VAR_STRING:
2242 case VAR_FUNC:
2243 case VAR_PARTIAL:
2244 case VAR_FLOAT:
2245 case VAR_SPECIAL:
2246 case VAR_JOB:
2247 case VAR_CHANNEL:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02002248 case VAR_INSTR:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002249 break;
2250
2251 case VAR_BLOB:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002252 if ((b = tv->vval.v_blob) != NULL
2253 && !(check_refcount && b->bv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002254 {
2255 if (lock)
2256 b->bv_lock |= VAR_LOCKED;
2257 else
2258 b->bv_lock &= ~VAR_LOCKED;
2259 }
2260 break;
2261 case VAR_LIST:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002262 if ((l = tv->vval.v_list) != NULL
2263 && !(check_refcount && l->lv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002264 {
2265 if (lock)
2266 l->lv_lock |= VAR_LOCKED;
2267 else
2268 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar70c43d82022-01-26 21:01:15 +00002269 if (deep < 0 || deep > 1)
2270 {
2271 if (l->lv_first == &range_list_item)
2272 l->lv_lock |= VAR_ITEMS_LOCKED;
2273 else
2274 {
2275 // recursive: lock/unlock the items the List contains
2276 CHECK_LIST_MATERIALIZE(l);
2277 FOR_ALL_LIST_ITEMS(l, li) item_lock(&li->li_tv,
2278 deep - 1, lock, check_refcount);
2279 }
2280 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002281 }
2282 break;
2283 case VAR_DICT:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002284 if ((d = tv->vval.v_dict) != NULL
2285 && !(check_refcount && d->dv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002286 {
2287 if (lock)
2288 d->dv_lock |= VAR_LOCKED;
2289 else
2290 d->dv_lock &= ~VAR_LOCKED;
2291 if (deep < 0 || deep > 1)
2292 {
2293 // recursive: lock/unlock the items the List contains
2294 todo = (int)d->dv_hashtab.ht_used;
2295 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
2296 {
2297 if (!HASHITEM_EMPTY(hi))
2298 {
2299 --todo;
Bram Moolenaar021bda52020-08-17 21:07:22 +02002300 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock,
2301 check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002302 }
2303 }
2304 }
2305 }
2306 }
2307 --recurse;
2308}
2309
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002310#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
2311/*
2312 * Delete all "menutrans_" variables.
2313 */
2314 void
2315del_menutrans_vars(void)
2316{
2317 hashitem_T *hi;
2318 int todo;
2319
2320 hash_lock(&globvarht);
2321 todo = (int)globvarht.ht_used;
2322 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
2323 {
2324 if (!HASHITEM_EMPTY(hi))
2325 {
2326 --todo;
2327 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
2328 delete_var(&globvarht, hi);
2329 }
2330 }
2331 hash_unlock(&globvarht);
2332}
2333#endif
2334
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002335/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002336 * Local string buffer for the next two functions to store a variable name
2337 * with its prefix. Allocated in cat_prefix_varname(), freed later in
2338 * get_user_var_name().
2339 */
2340
2341static char_u *varnamebuf = NULL;
2342static int varnamebuflen = 0;
2343
2344/*
2345 * Function to concatenate a prefix and a variable name.
2346 */
Bram Moolenaar1bb4de52021-01-13 19:48:46 +01002347 char_u *
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002348cat_prefix_varname(int prefix, char_u *name)
2349{
2350 int len;
2351
2352 len = (int)STRLEN(name) + 3;
2353 if (len > varnamebuflen)
2354 {
2355 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002356 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002357 varnamebuf = alloc(len);
2358 if (varnamebuf == NULL)
2359 {
2360 varnamebuflen = 0;
2361 return NULL;
2362 }
2363 varnamebuflen = len;
2364 }
2365 *varnamebuf = prefix;
2366 varnamebuf[1] = ':';
2367 STRCPY(varnamebuf + 2, name);
2368 return varnamebuf;
2369}
2370
2371/*
2372 * Function given to ExpandGeneric() to obtain the list of user defined
2373 * (global/buffer/window/built-in) variable names.
2374 */
2375 char_u *
2376get_user_var_name(expand_T *xp, int idx)
2377{
2378 static long_u gdone;
2379 static long_u bdone;
2380 static long_u wdone;
2381 static long_u tdone;
2382 static int vidx;
2383 static hashitem_T *hi;
2384 hashtab_T *ht;
2385
2386 if (idx == 0)
2387 {
2388 gdone = bdone = wdone = vidx = 0;
2389 tdone = 0;
2390 }
2391
2392 // Global variables
2393 if (gdone < globvarht.ht_used)
2394 {
2395 if (gdone++ == 0)
2396 hi = globvarht.ht_array;
2397 else
2398 ++hi;
2399 while (HASHITEM_EMPTY(hi))
2400 ++hi;
2401 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
2402 return cat_prefix_varname('g', hi->hi_key);
2403 return hi->hi_key;
2404 }
2405
2406 // b: variables
Bram Moolenaar0f6e28f2022-02-20 20:49:35 +00002407 ht = &prevwin_curwin()->w_buffer->b_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002408 if (bdone < ht->ht_used)
2409 {
2410 if (bdone++ == 0)
2411 hi = ht->ht_array;
2412 else
2413 ++hi;
2414 while (HASHITEM_EMPTY(hi))
2415 ++hi;
2416 return cat_prefix_varname('b', hi->hi_key);
2417 }
2418
2419 // w: variables
Bram Moolenaar0f6e28f2022-02-20 20:49:35 +00002420 ht = &prevwin_curwin()->w_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002421 if (wdone < ht->ht_used)
2422 {
2423 if (wdone++ == 0)
2424 hi = ht->ht_array;
2425 else
2426 ++hi;
2427 while (HASHITEM_EMPTY(hi))
2428 ++hi;
2429 return cat_prefix_varname('w', hi->hi_key);
2430 }
2431
2432 // t: variables
2433 ht = &curtab->tp_vars->dv_hashtab;
2434 if (tdone < ht->ht_used)
2435 {
2436 if (tdone++ == 0)
2437 hi = ht->ht_array;
2438 else
2439 ++hi;
2440 while (HASHITEM_EMPTY(hi))
2441 ++hi;
2442 return cat_prefix_varname('t', hi->hi_key);
2443 }
2444
2445 // v: variables
2446 if (vidx < VV_LEN)
2447 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
2448
2449 VIM_CLEAR(varnamebuf);
2450 varnamebuflen = 0;
2451 return NULL;
2452}
2453
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002454 char *
2455get_var_special_name(int nr)
2456{
2457 switch (nr)
2458 {
Bram Moolenaara8b8af12021-01-01 15:11:04 +01002459 case VVAL_FALSE: return in_vim9script() ? "false" : "v:false";
2460 case VVAL_TRUE: return in_vim9script() ? "true" : "v:true";
Bram Moolenaar67977822021-01-03 21:53:53 +01002461 case VVAL_NULL: return in_vim9script() ? "null" : "v:null";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002462 case VVAL_NONE: return "v:none";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002463 }
2464 internal_error("get_var_special_name()");
2465 return "42";
2466}
2467
2468/*
2469 * Returns the global variable dictionary
2470 */
2471 dict_T *
2472get_globvar_dict(void)
2473{
2474 return &globvardict;
2475}
2476
2477/*
2478 * Returns the global variable hash table
2479 */
2480 hashtab_T *
2481get_globvar_ht(void)
2482{
2483 return &globvarht;
2484}
2485
2486/*
2487 * Returns the v: variable dictionary
2488 */
2489 dict_T *
2490get_vimvar_dict(void)
2491{
2492 return &vimvardict;
2493}
2494
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002495/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002496 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002497 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002498 */
2499 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002500find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002501{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002502 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2503 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002504
2505 if (di == NULL)
2506 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002507 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002508 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2509 return (int)(vv - vimvars);
2510}
2511
2512
2513/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002514 * Set type of v: variable to "type".
2515 */
2516 void
2517set_vim_var_type(int idx, vartype_T type)
2518{
Bram Moolenaard787e402021-12-24 21:36:12 +00002519 vimvars[idx].vv_tv_type = type;
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002520}
2521
2522/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002523 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002524 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002525 */
2526 void
2527set_vim_var_nr(int idx, varnumber_T val)
2528{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002529 vimvars[idx].vv_nr = val;
2530}
2531
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002532 char *
2533get_vim_var_name(int idx)
2534{
2535 return vimvars[idx].vv_name;
2536}
2537
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002538/*
2539 * Get typval_T v: variable value.
2540 */
2541 typval_T *
2542get_vim_var_tv(int idx)
2543{
2544 return &vimvars[idx].vv_tv;
2545}
2546
Bram Moolenaard787e402021-12-24 21:36:12 +00002547 type_T *
2548get_vim_var_type(int idx, garray_T *type_list)
2549{
2550 if (vimvars[idx].vv_type != NULL)
2551 return vimvars[idx].vv_type;
2552 return typval2type_vimvar(&vimvars[idx].vv_tv, type_list);
2553}
2554
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002555/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002556 * Set v: variable to "tv". Only accepts the same type.
2557 * Takes over the value of "tv".
2558 */
2559 int
2560set_vim_var_tv(int idx, typval_T *tv)
2561{
Bram Moolenaard787e402021-12-24 21:36:12 +00002562 if (vimvars[idx].vv_tv_type != tv->v_type)
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002563 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002564 emsg(_(e_type_mismatch_for_v_variable));
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002565 clear_tv(tv);
2566 return FAIL;
2567 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002568 // VV_RO is also checked when compiling, but let's check here as well.
2569 if (vimvars[idx].vv_flags & VV_RO)
2570 {
Bram Moolenaard8e44472021-07-21 22:20:33 +02002571 semsg(_(e_cannot_change_readonly_variable_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002572 return FAIL;
2573 }
2574 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2575 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00002576 semsg(_(e_cannot_set_variable_in_sandbox_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002577 return FAIL;
2578 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002579 clear_tv(&vimvars[idx].vv_di.di_tv);
2580 vimvars[idx].vv_di.di_tv = *tv;
2581 return OK;
2582}
2583
2584/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002585 * Get number v: variable value.
2586 */
2587 varnumber_T
2588get_vim_var_nr(int idx)
2589{
2590 return vimvars[idx].vv_nr;
2591}
2592
2593/*
2594 * Get string v: variable value. Uses a static buffer, can only be used once.
2595 * If the String variable has never been set, return an empty string.
2596 * Never returns NULL;
2597 */
2598 char_u *
2599get_vim_var_str(int idx)
2600{
2601 return tv_get_string(&vimvars[idx].vv_tv);
2602}
2603
2604/*
2605 * Get List v: variable value. Caller must take care of reference count when
2606 * needed.
2607 */
2608 list_T *
2609get_vim_var_list(int idx)
2610{
2611 return vimvars[idx].vv_list;
2612}
2613
2614/*
2615 * Get Dict v: variable value. Caller must take care of reference count when
2616 * needed.
2617 */
2618 dict_T *
2619get_vim_var_dict(int idx)
2620{
2621 return vimvars[idx].vv_dict;
2622}
2623
2624/*
2625 * Set v:char to character "c".
2626 */
2627 void
2628set_vim_var_char(int c)
2629{
2630 char_u buf[MB_MAXBYTES + 1];
2631
2632 if (has_mbyte)
2633 buf[(*mb_char2bytes)(c, buf)] = NUL;
2634 else
2635 {
2636 buf[0] = c;
2637 buf[1] = NUL;
2638 }
2639 set_vim_var_string(VV_CHAR, buf, -1);
2640}
2641
2642/*
2643 * Set v:count to "count" and v:count1 to "count1".
2644 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2645 */
2646 void
2647set_vcount(
2648 long count,
2649 long count1,
2650 int set_prevcount)
2651{
2652 if (set_prevcount)
2653 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2654 vimvars[VV_COUNT].vv_nr = count;
2655 vimvars[VV_COUNT1].vv_nr = count1;
2656}
2657
2658/*
2659 * Save variables that might be changed as a side effect. Used when executing
2660 * a timer callback.
2661 */
2662 void
2663save_vimvars(vimvars_save_T *vvsave)
2664{
2665 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2666 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2667 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2668}
2669
2670/*
2671 * Restore variables saved by save_vimvars().
2672 */
2673 void
2674restore_vimvars(vimvars_save_T *vvsave)
2675{
2676 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2677 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2678 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2679}
2680
2681/*
2682 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2683 * value.
2684 */
2685 void
2686set_vim_var_string(
2687 int idx,
2688 char_u *val,
2689 int len) // length of "val" to use or -1 (whole string)
2690{
2691 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002692 vimvars[idx].vv_tv_type = VAR_STRING;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002693 if (val == NULL)
2694 vimvars[idx].vv_str = NULL;
2695 else if (len == -1)
2696 vimvars[idx].vv_str = vim_strsave(val);
2697 else
2698 vimvars[idx].vv_str = vim_strnsave(val, len);
2699}
2700
2701/*
2702 * Set List v: variable to "val".
2703 */
2704 void
2705set_vim_var_list(int idx, list_T *val)
2706{
2707 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002708 vimvars[idx].vv_tv_type = VAR_LIST;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002709 vimvars[idx].vv_list = val;
2710 if (val != NULL)
2711 ++val->lv_refcount;
2712}
2713
2714/*
2715 * Set Dictionary v: variable to "val".
2716 */
2717 void
2718set_vim_var_dict(int idx, dict_T *val)
2719{
2720 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002721 vimvars[idx].vv_tv_type = VAR_DICT;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002722 vimvars[idx].vv_dict = val;
2723 if (val != NULL)
2724 {
2725 ++val->dv_refcount;
2726 dict_set_items_ro(val);
2727 }
2728}
2729
2730/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002731 * Set the v:argv list.
2732 */
2733 void
2734set_argv_var(char **argv, int argc)
2735{
2736 list_T *l = list_alloc();
2737 int i;
2738
2739 if (l == NULL)
2740 getout(1);
2741 l->lv_lock = VAR_FIXED;
2742 for (i = 0; i < argc; ++i)
2743 {
2744 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2745 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002746 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002747 }
2748 set_vim_var_list(VV_ARGV, l);
2749}
2750
2751/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002752 * Reset v:register, taking the 'clipboard' setting into account.
2753 */
2754 void
2755reset_reg_var(void)
2756{
2757 int regname = 0;
2758
2759 // Adjust the register according to 'clipboard', so that when
2760 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2761#ifdef FEAT_CLIPBOARD
2762 adjust_clip_reg(&regname);
2763#endif
2764 set_reg_var(regname);
2765}
2766
2767/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002768 * Set v:register if needed.
2769 */
2770 void
2771set_reg_var(int c)
2772{
2773 char_u regname;
2774
2775 if (c == 0 || c == ' ')
2776 regname = '"';
2777 else
2778 regname = c;
2779 // Avoid free/alloc when the value is already right.
2780 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2781 set_vim_var_string(VV_REG, &regname, 1);
2782}
2783
2784/*
2785 * Get or set v:exception. If "oldval" == NULL, return the current value.
2786 * Otherwise, restore the value to "oldval" and return NULL.
2787 * Must always be called in pairs to save and restore v:exception! Does not
2788 * take care of memory allocations.
2789 */
2790 char_u *
2791v_exception(char_u *oldval)
2792{
2793 if (oldval == NULL)
2794 return vimvars[VV_EXCEPTION].vv_str;
2795
2796 vimvars[VV_EXCEPTION].vv_str = oldval;
2797 return NULL;
2798}
2799
2800/*
2801 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2802 * Otherwise, restore the value to "oldval" and return NULL.
2803 * Must always be called in pairs to save and restore v:throwpoint! Does not
2804 * take care of memory allocations.
2805 */
2806 char_u *
2807v_throwpoint(char_u *oldval)
2808{
2809 if (oldval == NULL)
2810 return vimvars[VV_THROWPOINT].vv_str;
2811
2812 vimvars[VV_THROWPOINT].vv_str = oldval;
2813 return NULL;
2814}
2815
2816/*
2817 * Set v:cmdarg.
2818 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2819 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2820 * Must always be called in pairs!
2821 */
2822 char_u *
2823set_cmdarg(exarg_T *eap, char_u *oldarg)
2824{
2825 char_u *oldval;
2826 char_u *newval;
2827 unsigned len;
2828
2829 oldval = vimvars[VV_CMDARG].vv_str;
2830 if (eap == NULL)
2831 {
2832 vim_free(oldval);
2833 vimvars[VV_CMDARG].vv_str = oldarg;
2834 return NULL;
2835 }
2836
2837 if (eap->force_bin == FORCE_BIN)
2838 len = 6;
2839 else if (eap->force_bin == FORCE_NOBIN)
2840 len = 8;
2841 else
2842 len = 0;
2843
2844 if (eap->read_edit)
2845 len += 7;
2846
2847 if (eap->force_ff != 0)
2848 len += 10; // " ++ff=unix"
2849 if (eap->force_enc != 0)
2850 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2851 if (eap->bad_char != 0)
2852 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2853
2854 newval = alloc(len + 1);
2855 if (newval == NULL)
2856 return NULL;
2857
2858 if (eap->force_bin == FORCE_BIN)
2859 sprintf((char *)newval, " ++bin");
2860 else if (eap->force_bin == FORCE_NOBIN)
2861 sprintf((char *)newval, " ++nobin");
2862 else
2863 *newval = NUL;
2864
2865 if (eap->read_edit)
2866 STRCAT(newval, " ++edit");
2867
2868 if (eap->force_ff != 0)
2869 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2870 eap->force_ff == 'u' ? "unix"
2871 : eap->force_ff == 'd' ? "dos"
2872 : "mac");
2873 if (eap->force_enc != 0)
2874 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2875 eap->cmd + eap->force_enc);
2876 if (eap->bad_char == BAD_KEEP)
2877 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2878 else if (eap->bad_char == BAD_DROP)
2879 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2880 else if (eap->bad_char != 0)
2881 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2882 vimvars[VV_CMDARG].vv_str = newval;
2883 return oldval;
2884}
2885
2886/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002887 * Get the value of internal variable "name".
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002888 * If "flags" has EVAL_VAR_IMPORT may return a VAR_ANY with v_number set to the
2889 * imported script ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002890 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2891 */
2892 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002893eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002894 char_u *name,
2895 int len, // length of "name"
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002896 scid_T sid, // script ID for imported item or zero
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002897 typval_T *rettv, // NULL when only checking existence
2898 dictitem_T **dip, // non-NULL when typval's dict item is needed
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002899 int flags) // EVAL_VAR_ flags
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002900{
2901 int ret = OK;
2902 typval_T *tv = NULL;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002903 int found = FALSE;
Bram Moolenaarf055d452021-07-08 20:57:24 +02002904 hashtab_T *ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002905 int cc;
Bram Moolenaarc967d572021-07-08 21:38:50 +02002906 type_T *type = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002907
2908 // truncate the name, so that we can use strcmp()
2909 cc = name[len];
2910 name[len] = NUL;
2911
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002912 // Check for local variable when debugging.
2913 if ((tv = lookup_debug_var(name)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002914 {
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002915 // Check for user-defined variables.
Bram Moolenaarc967d572021-07-08 21:38:50 +02002916 dictitem_T *v = find_var(name, &ht, flags & EVAL_VAR_NOAUTOLOAD);
2917
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002918 if (v != NULL)
2919 {
2920 tv = &v->di_tv;
2921 if (dip != NULL)
2922 *dip = v;
2923 }
Bram Moolenaarc967d572021-07-08 21:38:50 +02002924 else
2925 ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002926 }
2927
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002928 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002929 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002930 imported_T *import = NULL;
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002931 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
2932
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002933 if (sid == 0)
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00002934 import = find_imported(p, 0, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002935
2936 // imported variable from another script
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002937 if (import != NULL || sid != 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002938 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002939 if ((flags & EVAL_VAR_IMPORT) == 0)
Bram Moolenaarc620c052020-07-08 15:16:19 +02002940 {
Bram Moolenaar71f21932022-01-07 18:20:55 +00002941 if (SCRIPT_ID_VALID(sid))
Bram Moolenaarc620c052020-07-08 15:16:19 +02002942 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002943 ht = &SCRIPT_VARS(sid);
2944 if (ht != NULL)
2945 {
2946 dictitem_T *v = find_var_in_ht(ht, 0, name,
2947 flags & EVAL_VAR_NOAUTOLOAD);
2948
2949 if (v != NULL)
2950 {
2951 tv = &v->di_tv;
2952 if (dip != NULL)
2953 *dip = v;
2954 }
2955 else
2956 ht = NULL;
2957 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002958 }
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002959 else
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002960 {
2961 if (flags & EVAL_VAR_VERBOSE)
Bram Moolenaardd5893b2022-01-20 21:32:54 +00002962 semsg(_(e_expected_dot_after_name_str), name);
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002963 ret = FAIL;
2964 }
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002965 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002966 else
2967 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002968 if (rettv != NULL)
2969 {
Bram Moolenaar753885b2022-08-24 16:30:36 +01002970 // special value that is used in handle_subscript()
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002971 rettv->v_type = VAR_ANY;
2972 rettv->vval.v_number = sid != 0 ? sid : import->imp_sid;
2973 }
2974 found = TRUE;
Bram Moolenaarc620c052020-07-08 15:16:19 +02002975 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002976 }
Bram Moolenaar052ff292021-12-11 13:54:46 +00002977 else if (in_vim9script() && (flags & EVAL_VAR_NO_FUNC) == 0)
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002978 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002979 int has_g_prefix = STRNCMP(name, "g:", 2) == 0;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002980 ufunc_T *ufunc = find_func(name, FALSE);
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002981
Bram Moolenaarb033ee22021-08-15 16:08:36 +02002982 // In Vim9 script we can get a function reference by using the
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002983 // function name. For a global non-autoload function "g:" is
2984 // required.
2985 if (ufunc != NULL && (has_g_prefix
2986 || !func_requires_g_prefix(ufunc)))
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002987 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002988 found = TRUE;
Bram Moolenaar601e76a2020-08-27 21:33:10 +02002989 if (rettv != NULL)
2990 {
2991 rettv->v_type = VAR_FUNC;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002992 if (has_g_prefix)
Bram Moolenaaref082e12021-12-12 21:02:03 +00002993 // Keep the "g:", otherwise script-local may be
2994 // assumed.
2995 rettv->vval.v_string = vim_strsave(name);
2996 else
2997 rettv->vval.v_string = vim_strsave(ufunc->uf_name);
Bram Moolenaarb033ee22021-08-15 16:08:36 +02002998 if (rettv->vval.v_string != NULL)
2999 func_ref(ufunc->uf_name);
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003000 }
3001 }
3002 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003003 }
3004
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003005 if (!found)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003006 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02003007 if (tv == NULL)
3008 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003009 if (rettv != NULL && (flags & EVAL_VAR_VERBOSE))
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003010 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarc620c052020-07-08 15:16:19 +02003011 ret = FAIL;
3012 }
3013 else if (rettv != NULL)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003014 {
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003015 svar_T *sv = NULL;
3016 int was_assigned = FALSE;
3017
Bram Moolenaar11005b02021-07-11 20:59:00 +02003018 if (ht != NULL && ht == get_script_local_ht()
3019 && tv != &SCRIPT_SV(current_sctx.sc_sid)->sv_var.di_tv)
Bram Moolenaarf055d452021-07-08 20:57:24 +02003020 {
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003021 sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaarf055d452021-07-08 20:57:24 +02003022 if (sv != NULL)
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003023 {
Bram Moolenaarf055d452021-07-08 20:57:24 +02003024 type = sv->sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003025 was_assigned = sv->sv_flags & SVFLAG_ASSIGNED;
3026 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003027 }
3028
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003029 // If a list or dict variable wasn't initialized and has meaningful
3030 // type, do it now. Not for global variables, they are not
3031 // declared.
Bram Moolenaar7a222242022-03-01 19:23:24 +00003032 if (ht != &globvarht)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003033 {
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003034 if (tv->v_type == VAR_DICT && tv->vval.v_dict == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003035 && ((type != NULL && !was_assigned)
Bram Moolenaar859cc212022-03-28 15:22:35 +01003036 || !in_vim9script()))
Bram Moolenaarf055d452021-07-08 20:57:24 +02003037 {
Bram Moolenaar7a222242022-03-01 19:23:24 +00003038 tv->vval.v_dict = dict_alloc();
3039 if (tv->vval.v_dict != NULL)
3040 {
3041 ++tv->vval.v_dict->dv_refcount;
3042 tv->vval.v_dict->dv_type = alloc_type(type);
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003043 if (sv != NULL)
3044 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar7a222242022-03-01 19:23:24 +00003045 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003046 }
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003047 else if (tv->v_type == VAR_LIST && tv->vval.v_list == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003048 && ((type != NULL && !was_assigned)
Bram Moolenaar501f9782022-03-27 16:51:04 +01003049 || !in_vim9script()))
Bram Moolenaarf055d452021-07-08 20:57:24 +02003050 {
Bram Moolenaar7a222242022-03-01 19:23:24 +00003051 tv->vval.v_list = list_alloc();
3052 if (tv->vval.v_list != NULL)
3053 {
3054 ++tv->vval.v_list->lv_refcount;
3055 tv->vval.v_list->lv_type = alloc_type(type);
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003056 if (sv != NULL)
3057 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar7a222242022-03-01 19:23:24 +00003058 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003059 }
Bram Moolenaar859cc212022-03-28 15:22:35 +01003060 else if (tv->v_type == VAR_BLOB && tv->vval.v_blob == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003061 && ((type != NULL && !was_assigned)
Bram Moolenaar859cc212022-03-28 15:22:35 +01003062 || !in_vim9script()))
3063 {
3064 tv->vval.v_blob = blob_alloc();
3065 if (tv->vval.v_blob != NULL)
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003066 {
Bram Moolenaar859cc212022-03-28 15:22:35 +01003067 ++tv->vval.v_blob->bv_refcount;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003068 if (sv != NULL)
3069 sv->sv_flags |= SVFLAG_ASSIGNED;
3070 }
Bram Moolenaar859cc212022-03-28 15:22:35 +01003071 }
Bram Moolenaarb7c21af2021-04-18 14:12:31 +02003072 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02003073 copy_tv(tv, rettv);
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003074 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003075 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003076
3077 name[len] = cc;
3078
3079 return ret;
3080}
3081
3082/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003083 * Check if variable "name[len]" is a local variable or an argument.
3084 * If so, "*eval_lavars_used" is set to TRUE.
3085 */
3086 void
3087check_vars(char_u *name, int len)
3088{
3089 int cc;
3090 char_u *varname;
3091 hashtab_T *ht;
3092
3093 if (eval_lavars_used == NULL)
3094 return;
3095
3096 // truncate the name, so that we can use strcmp()
3097 cc = name[len];
3098 name[len] = NUL;
3099
3100 ht = find_var_ht(name, &varname);
3101 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
3102 {
3103 if (find_var(name, NULL, TRUE) != NULL)
3104 *eval_lavars_used = TRUE;
3105 }
3106
3107 name[len] = cc;
3108}
3109
3110/*
3111 * Find variable "name" in the list of variables.
3112 * Return a pointer to it if found, NULL if not found.
3113 * Careful: "a:0" variables don't have a name.
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003114 * When "htp" is not NULL set "htp" to the hashtab_T used.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003115 */
3116 dictitem_T *
3117find_var(char_u *name, hashtab_T **htp, int no_autoload)
3118{
3119 char_u *varname;
3120 hashtab_T *ht;
3121 dictitem_T *ret = NULL;
3122
3123 ht = find_var_ht(name, &varname);
3124 if (htp != NULL)
3125 *htp = ht;
3126 if (ht == NULL)
3127 return NULL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003128 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003129 if (ret != NULL)
3130 return ret;
3131
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003132 // Search in parent scope for lambda
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003133 ret = find_var_in_scoped_ht(name, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003134 if (ret != NULL)
3135 return ret;
3136
3137 // in Vim9 script items without a scope can be script-local
3138 if (in_vim9script() && name[0] != NUL && name[1] != ':')
3139 {
3140 ht = get_script_local_ht();
3141 if (ht != NULL)
3142 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003143 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003144 if (ret != NULL)
3145 {
3146 if (htp != NULL)
3147 *htp = ht;
3148 return ret;
3149 }
3150 }
3151 }
3152
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003153 // When using "vim9script autoload" script-local items are prefixed but can
3154 // be used with s:name.
3155 if (SCRIPT_ID_VALID(current_sctx.sc_sid)
3156 && name[0] == 's' && name[1] == ':')
3157 {
3158 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
3159
3160 if (si->sn_autoload_prefix != NULL)
3161 {
3162 char_u *auto_name = concat_str(si->sn_autoload_prefix, name + 2);
3163
3164 if (auto_name != NULL)
3165 {
3166 ht = &globvarht;
3167 ret = find_var_in_ht(ht, *name, auto_name, TRUE);
Bram Moolenaar130f65d2022-01-13 20:39:41 +00003168 vim_free(auto_name);
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003169 if (ret != NULL)
3170 {
3171 if (htp != NULL)
3172 *htp = ht;
3173 return ret;
3174 }
3175 }
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003176 }
3177 }
3178
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003179 return NULL;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003180}
3181
3182/*
Bram Moolenaar71f21932022-01-07 18:20:55 +00003183 * Like find_var() but if the name starts with <SNR>99_ then look in the
3184 * referenced script (used for a funcref).
3185 */
3186 dictitem_T *
3187find_var_also_in_script(char_u *name, hashtab_T **htp, int no_autoload)
3188{
3189 if (STRNCMP(name, "<SNR>", 5) == 0 && isdigit(name[5]))
3190 {
3191 char_u *p = name + 5;
3192 int sid = getdigits(&p);
3193
3194 if (SCRIPT_ID_VALID(sid) && *p == '_')
3195 {
3196 hashtab_T *ht = &SCRIPT_VARS(sid);
3197
3198 if (ht != NULL)
3199 {
3200 dictitem_T *di = find_var_in_ht(ht, 0, p + 1, no_autoload);
3201
3202 if (di != NULL)
Bram Moolenaaraa9b3ca2022-01-08 15:44:22 +00003203 {
3204 if (htp != NULL)
3205 *htp = ht;
Bram Moolenaar71f21932022-01-07 18:20:55 +00003206 return di;
Bram Moolenaaraa9b3ca2022-01-08 15:44:22 +00003207 }
Bram Moolenaar71f21932022-01-07 18:20:55 +00003208 }
3209 }
3210 }
3211
3212 return find_var(name, htp, no_autoload);
3213}
3214
3215/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003216 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02003217 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003218 * Returns NULL if not found.
3219 */
3220 dictitem_T *
3221find_var_in_ht(
3222 hashtab_T *ht,
3223 int htname,
3224 char_u *varname,
3225 int no_autoload)
3226{
3227 hashitem_T *hi;
3228
3229 if (*varname == NUL)
3230 {
3231 // Must be something like "s:", otherwise "ht" would be NULL.
3232 switch (htname)
3233 {
3234 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
3235 case 'g': return &globvars_var;
3236 case 'v': return &vimvars_var;
3237 case 'b': return &curbuf->b_bufvar;
3238 case 'w': return &curwin->w_winvar;
3239 case 't': return &curtab->tp_winvar;
3240 case 'l': return get_funccal_local_var();
3241 case 'a': return get_funccal_args_var();
3242 }
3243 return NULL;
3244 }
3245
3246 hi = hash_find(ht, varname);
3247 if (HASHITEM_EMPTY(hi))
3248 {
3249 // For global variables we may try auto-loading the script. If it
3250 // worked find the variable again. Don't auto-load a script if it was
3251 // loaded already, otherwise it would be loaded every time when
3252 // checking if a function name is a Funcref variable.
3253 if (ht == &globvarht && !no_autoload)
3254 {
3255 // Note: script_autoload() may make "hi" invalid. It must either
3256 // be obtained again or not used.
3257 if (!script_autoload(varname, FALSE) || aborting())
3258 return NULL;
3259 hi = hash_find(ht, varname);
3260 }
3261 if (HASHITEM_EMPTY(hi))
3262 return NULL;
3263 }
3264 return HI2DI(hi);
3265}
3266
3267/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003268 * Get the script-local hashtab. NULL if not in a script context.
3269 */
Bram Moolenaar922acbd2020-10-08 21:30:40 +02003270 hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003271get_script_local_ht(void)
3272{
3273 scid_T sid = current_sctx.sc_sid;
3274
Bram Moolenaare3d46852020-08-29 13:39:17 +02003275 if (SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003276 return &SCRIPT_VARS(sid);
3277 return NULL;
3278}
3279
3280/*
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003281 * Look for "name[len]" in script-local variables and functions.
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003282 * When "cmd" is TRUE it must look like a command, a function must be followed
3283 * by "(" or "->".
Bram Moolenaar709664c2020-12-12 14:33:41 +01003284 * Return OK when found, FAIL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003285 */
Bram Moolenaar709664c2020-12-12 14:33:41 +01003286 int
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003287lookup_scriptitem(
Bram Moolenaar709664c2020-12-12 14:33:41 +01003288 char_u *name,
3289 size_t len,
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003290 int cmd,
Bram Moolenaar709664c2020-12-12 14:33:41 +01003291 cctx_T *dummy UNUSED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003292{
3293 hashtab_T *ht = get_script_local_ht();
3294 char_u buffer[30];
3295 char_u *p;
Bram Moolenaar709664c2020-12-12 14:33:41 +01003296 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003297 hashitem_T *hi;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003298 int is_global = FALSE;
3299 char_u *fname = name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003300
3301 if (ht == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003302 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003303 if (len < sizeof(buffer) - 1)
3304 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02003305 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003306 vim_strncpy(buffer, name, len);
3307 p = buffer;
3308 }
3309 else
3310 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003311 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003312 if (p == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003313 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003314 }
3315
3316 hi = hash_find(ht, p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01003317 res = HASHITEM_EMPTY(hi) ? FAIL : OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003318
3319 // if not script-local, then perhaps imported
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003320 if (res == FAIL && find_imported(p, 0, FALSE) != NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003321 res = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003322 if (p != buffer)
3323 vim_free(p);
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003324
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003325 // Find a function, so that a following "->" works.
3326 // When used as a command require "(" or "->" to follow, "Cmd" is a user
3327 // command while "Cmd()" is a function call.
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003328 if (res != OK)
3329 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003330 p = skipwhite(name + len);
3331
3332 if (!cmd || name[len] == '(' || (p[0] == '-' && p[1] == '>'))
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003333 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003334 // Do not check for an internal function, since it might also be a
3335 // valid command, such as ":split" versus "split()".
3336 // Skip "g:" before a function name.
3337 if (name[0] == 'g' && name[1] == ':')
3338 {
3339 is_global = TRUE;
3340 fname = name + 2;
3341 }
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003342 if (find_func(fname, is_global) != NULL)
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003343 res = OK;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003344 }
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003345 }
3346
Bram Moolenaar709664c2020-12-12 14:33:41 +01003347 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003348}
3349
3350/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003351 * Find the hashtab used for a variable name.
3352 * Return NULL if the name is not valid.
3353 * Set "varname" to the start of name without ':'.
3354 */
3355 hashtab_T *
3356find_var_ht(char_u *name, char_u **varname)
3357{
3358 hashitem_T *hi;
3359 hashtab_T *ht;
3360
3361 if (name[0] == NUL)
3362 return NULL;
3363 if (name[1] != ':')
3364 {
3365 // The name must not start with a colon or #.
3366 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
3367 return NULL;
3368 *varname = name;
3369
3370 // "version" is "v:version" in all scopes if scriptversion < 3.
3371 // Same for a few other variables marked with VV_COMPAT.
Bram Moolenaardd9de502021-08-15 13:49:42 +02003372 if (in_old_script(3))
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003373 {
3374 hi = hash_find(&compat_hashtab, name);
3375 if (!HASHITEM_EMPTY(hi))
3376 return &compat_hashtab;
3377 }
3378
3379 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003380 if (ht != NULL)
3381 return ht; // local variable
3382
Bram Moolenaarf0a40692021-06-11 22:05:47 +02003383 // In Vim9 script items at the script level are script-local, except
3384 // for autoload names.
3385 if (in_vim9script() && vim_strchr(name, AUTOLOAD_CHAR) == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003386 {
3387 ht = get_script_local_ht();
3388 if (ht != NULL)
3389 return ht;
3390 }
3391
3392 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003393 }
3394 *varname = name + 2;
3395 if (*name == 'g') // global variable
3396 return &globvarht;
3397 // There must be no ':' or '#' in the rest of the name, unless g: is used
3398 if (vim_strchr(name + 2, ':') != NULL
3399 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
3400 return NULL;
3401 if (*name == 'b') // buffer variable
3402 return &curbuf->b_vars->dv_hashtab;
3403 if (*name == 'w') // window variable
3404 return &curwin->w_vars->dv_hashtab;
3405 if (*name == 't') // tab page variable
3406 return &curtab->tp_vars->dv_hashtab;
3407 if (*name == 'v') // v: variable
3408 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01003409 if (get_current_funccal() != NULL
Bram Moolenaarca16c602022-09-06 18:57:08 +01003410 && get_current_funccal()->fc_func->uf_def_status
3411 == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003412 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01003413 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003414 if (*name == 'a') // a: function argument
3415 return get_funccal_args_ht();
3416 if (*name == 'l') // l: local function variable
3417 return get_funccal_local_ht();
3418 }
3419 if (*name == 's') // script variable
3420 {
3421 ht = get_script_local_ht();
3422 if (ht != NULL)
3423 return ht;
3424 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003425 return NULL;
3426}
3427
3428/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003429 * Get the string value of a (global/local) variable.
3430 * Note: see tv_get_string() for how long the pointer remains valid.
3431 * Returns NULL when it doesn't exist.
3432 */
3433 char_u *
3434get_var_value(char_u *name)
3435{
3436 dictitem_T *v;
3437
3438 v = find_var(name, NULL, FALSE);
3439 if (v == NULL)
3440 return NULL;
3441 return tv_get_string(&v->di_tv);
3442}
3443
3444/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003445 * Allocate a new hashtab for a sourced script. It will be used while
3446 * sourcing this script and when executing functions defined in the script.
3447 */
3448 void
3449new_script_vars(scid_T id)
3450{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003451 scriptvar_T *sv;
3452
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01003453 sv = ALLOC_CLEAR_ONE(scriptvar_T);
3454 if (sv == NULL)
3455 return;
3456 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01003457 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003458}
3459
3460/*
3461 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
3462 * point to it.
3463 */
3464 void
3465init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
3466{
3467 hash_init(&dict->dv_hashtab);
3468 dict->dv_lock = 0;
3469 dict->dv_scope = scope;
3470 dict->dv_refcount = DO_NOT_FREE_CNT;
3471 dict->dv_copyID = 0;
3472 dict_var->di_tv.vval.v_dict = dict;
3473 dict_var->di_tv.v_type = VAR_DICT;
3474 dict_var->di_tv.v_lock = VAR_FIXED;
3475 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
3476 dict_var->di_key[0] = NUL;
3477}
3478
3479/*
3480 * Unreference a dictionary initialized by init_var_dict().
3481 */
3482 void
3483unref_var_dict(dict_T *dict)
3484{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003485 // Now the dict needs to be freed if no one else is using it, go back to
3486 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003487 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
3488 dict_unref(dict);
3489}
3490
3491/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003492 * Clean up a list of internal variables.
3493 * Frees all allocated variables and the value they contain.
3494 * Clears hashtab "ht", does not free it.
3495 */
3496 void
3497vars_clear(hashtab_T *ht)
3498{
3499 vars_clear_ext(ht, TRUE);
3500}
3501
3502/*
3503 * Like vars_clear(), but only free the value if "free_val" is TRUE.
3504 */
3505 void
3506vars_clear_ext(hashtab_T *ht, int free_val)
3507{
3508 int todo;
3509 hashitem_T *hi;
3510 dictitem_T *v;
3511
3512 hash_lock(ht);
3513 todo = (int)ht->ht_used;
3514 for (hi = ht->ht_array; todo > 0; ++hi)
3515 {
3516 if (!HASHITEM_EMPTY(hi))
3517 {
3518 --todo;
3519
3520 // Free the variable. Don't remove it from the hashtab,
3521 // ht_array might change then. hash_clear() takes care of it
3522 // later.
3523 v = HI2DI(hi);
3524 if (free_val)
3525 clear_tv(&v->di_tv);
3526 if (v->di_flags & DI_FLAGS_ALLOC)
3527 vim_free(v);
3528 }
3529 }
3530 hash_clear(ht);
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003531 hash_init(ht);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003532}
3533
3534/*
3535 * Delete a variable from hashtab "ht" at item "hi".
3536 * Clear the variable value and free the dictitem.
3537 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02003538 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003539delete_var(hashtab_T *ht, hashitem_T *hi)
3540{
3541 dictitem_T *di = HI2DI(hi);
3542
3543 hash_remove(ht, hi);
3544 clear_tv(&di->di_tv);
3545 vim_free(di);
3546}
3547
3548/*
3549 * List the value of one internal variable.
3550 */
3551 static void
3552list_one_var(dictitem_T *v, char *prefix, int *first)
3553{
3554 char_u *tofree;
3555 char_u *s;
3556 char_u numbuf[NUMBUFLEN];
3557
3558 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
3559 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
3560 s == NULL ? (char_u *)"" : s, first);
3561 vim_free(tofree);
3562}
3563
3564 static void
3565list_one_var_a(
3566 char *prefix,
3567 char_u *name,
3568 int type,
3569 char_u *string,
3570 int *first) // when TRUE clear rest of screen and set to FALSE
3571{
3572 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
3573 msg_start();
3574 msg_puts(prefix);
3575 if (name != NULL) // "a:" vars don't have a name stored
3576 msg_puts((char *)name);
3577 msg_putchar(' ');
3578 msg_advance(22);
3579 if (type == VAR_NUMBER)
3580 msg_putchar('#');
3581 else if (type == VAR_FUNC || type == VAR_PARTIAL)
3582 msg_putchar('*');
3583 else if (type == VAR_LIST)
3584 {
3585 msg_putchar('[');
3586 if (*string == '[')
3587 ++string;
3588 }
3589 else if (type == VAR_DICT)
3590 {
3591 msg_putchar('{');
3592 if (*string == '{')
3593 ++string;
3594 }
3595 else
3596 msg_putchar(' ');
3597
3598 msg_outtrans(string);
3599
3600 if (type == VAR_FUNC || type == VAR_PARTIAL)
3601 msg_puts("()");
3602 if (*first)
3603 {
3604 msg_clr_eos();
3605 *first = FALSE;
3606 }
3607}
3608
3609/*
3610 * Set variable "name" to value in "tv".
3611 * If the variable already exists, the value is updated.
3612 * Otherwise the variable is created.
3613 */
3614 void
3615set_var(
3616 char_u *name,
3617 typval_T *tv,
3618 int copy) // make copy of value in "tv"
3619{
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003620 set_var_const(name, 0, NULL, tv, copy, ASSIGN_DECL, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003621}
3622
3623/*
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003624 * Set variable "name" to value in "tv_arg".
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003625 * When "sid" is non-zero "name" is in the script with this ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003626 * If the variable already exists and "is_const" is FALSE the value is updated.
3627 * Otherwise the variable is created.
3628 */
3629 void
3630set_var_const(
3631 char_u *name,
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003632 scid_T sid,
Bram Moolenaar7824fc82021-11-26 17:36:51 +00003633 type_T *type_arg,
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003634 typval_T *tv_arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003635 int copy, // make copy of value in "tv"
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003636 int flags_arg, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003637 int var_idx) // index for ":let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003638{
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003639 typval_T *tv = tv_arg;
Bram Moolenaar7824fc82021-11-26 17:36:51 +00003640 type_T *type = type_arg;
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003641 typval_T bool_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003642 dictitem_T *di;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003643 typval_T *dest_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003644 char_u *varname;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003645 char_u *name_tofree = NULL;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003646 hashtab_T *ht = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003647 int is_script_local;
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003648 int vim9script = in_vim9script();
Bram Moolenaare535db82021-03-31 21:07:24 +02003649 int var_in_vim9script;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003650 int var_in_autoload = FALSE;
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003651 int flags = flags_arg;
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003652 int free_tv_arg = !copy; // free tv_arg if not used
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003653
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003654 if (sid != 0)
3655 {
3656 if (SCRIPT_ID_VALID(sid))
3657 ht = &SCRIPT_VARS(sid);
3658 varname = name;
3659 }
3660 else
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003661 {
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003662 scriptitem_T *si;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003663
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003664 if (in_vim9script() && is_export
3665 && SCRIPT_ID_VALID(current_sctx.sc_sid)
3666 && (si = SCRIPT_ITEM(current_sctx.sc_sid))
Bram Moolenaar0e1574c2022-03-03 17:05:35 +00003667 ->sn_autoload_prefix != NULL)
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003668 {
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003669 // In a vim9 autoload script an exported variable is put in the
3670 // global namespace with the autoload prefix.
3671 var_in_autoload = TRUE;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003672 varname = concat_str(si->sn_autoload_prefix, name);
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003673 if (varname == NULL)
3674 goto failed;
3675 name_tofree = varname;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003676 ht = &globvarht;
3677 }
3678 else
3679 ht = find_var_ht(name, &varname);
3680 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003681 if (ht == NULL || *varname == NUL)
3682 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003683 semsg(_(e_illegal_variable_name_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003684 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003685 }
Bram Moolenaar54969f42022-02-07 13:56:44 +00003686 is_script_local = ht == get_script_local_ht() || sid != 0
3687 || var_in_autoload;
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003688
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003689 if (vim9script
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003690 && !is_script_local
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003691 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003692 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003693 && name[1] == ':')
Bram Moolenaar67979662020-06-20 22:50:47 +02003694 {
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003695 vim9_declare_error(name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003696 goto failed;
Bram Moolenaar67979662020-06-20 22:50:47 +02003697 }
Bram Moolenaar9510d222022-09-11 15:14:05 +01003698 if ((flags & ASSIGN_FOR_LOOP) && is_scoped_variable(name))
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003699 // Do not make g:var, w:var, b:var or t:var final.
3700 flags &= ~ASSIGN_FINAL;
3701
Bram Moolenaare535db82021-03-31 21:07:24 +02003702 var_in_vim9script = is_script_local && current_script_is_vim9();
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003703 if (var_in_vim9script && name[0] == '_' && name[1] == NUL)
3704 {
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02003705 // For "[a, _] = list" the underscore is ignored.
3706 if ((flags & ASSIGN_UNPACK) == 0)
3707 emsg(_(e_cannot_use_underscore_here));
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003708 goto failed;
3709 }
Bram Moolenaar67979662020-06-20 22:50:47 +02003710
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003711 di = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003712
Bram Moolenaar24e93162021-07-18 20:40:33 +02003713 if (di == NULL && var_in_vim9script)
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003714 {
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003715 imported_T *import = find_imported(varname, 0, FALSE);
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003716
Bram Moolenaar24e93162021-07-18 20:40:33 +02003717 if (import != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003718 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003719 // imported name space cannot be used
Bram Moolenaar24e93162021-07-18 20:40:33 +02003720 if ((flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003721 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003722 semsg(_(e_redefining_imported_item_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003723 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003724 }
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003725 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
3726 goto failed;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003727 }
Bram Moolenaar75e27d72022-02-13 13:56:29 +00003728 if (!in_vim9script())
3729 {
3730 semsg(_(e_cannot_create_vim9_script_variable_in_function_str),
3731 name);
3732 goto failed;
3733 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003734 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003735
Bram Moolenaar993faa32022-02-21 15:59:11 +00003736 // Search in parent scope which is possible to reference from lambda
3737 if (di == NULL)
3738 di = find_var_in_scoped_ht(name, TRUE);
3739
3740 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
3741 && var_wrong_func_name(name, di == NULL))
3742 goto failed;
3743
3744 if (need_convert_to_bool(type, tv))
Bram Moolenaar24e93162021-07-18 20:40:33 +02003745 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003746 // Destination is a bool and the value is not, but it can be
3747 // converted.
3748 CLEAR_FIELD(bool_tv);
3749 bool_tv.v_type = VAR_BOOL;
3750 bool_tv.vval.v_number = tv2bool(tv) ? VVAL_TRUE : VVAL_FALSE;
3751 tv = &bool_tv;
3752 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003753
Bram Moolenaar993faa32022-02-21 15:59:11 +00003754 if (di != NULL)
3755 {
3756 // Item already exists. Allowed to replace when reloading.
3757 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003758 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003759 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
3760 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003761 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003762 emsg(_(e_cannot_modify_existing_variable));
3763 goto failed;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003764 }
3765
Bram Moolenaar993faa32022-02-21 15:59:11 +00003766 if (is_script_local && vim9script
3767 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0)
Bram Moolenaar12be7342021-03-31 21:47:33 +02003768 {
3769 semsg(_(e_redefining_script_item_str), name);
3770 goto failed;
3771 }
3772
Bram Moolenaar993faa32022-02-21 15:59:11 +00003773 if (var_in_vim9script && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003774 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003775 where_T where = WHERE_INIT;
Bram Moolenaar7a411a32022-04-04 14:58:06 +01003776 svar_T *sv = find_typval_in_script(&di->di_tv, sid, TRUE);
Bram Moolenaar993faa32022-02-21 15:59:11 +00003777
3778 if (sv != NULL)
3779 {
3780 // check the type and adjust to bool if needed
3781 where.wt_index = var_idx;
3782 where.wt_variable = TRUE;
3783 if (check_script_var_type(sv, tv, name, where) == FAIL)
3784 goto failed;
3785 if (type == NULL)
3786 type = sv->sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003787 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003788 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003789 }
3790
Bram Moolenaar993faa32022-02-21 15:59:11 +00003791 if ((flags & ASSIGN_FOR_LOOP) == 0
3792 && var_check_permission(di, name) == FAIL)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003793 goto failed;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003794 }
3795 else
3796 {
3797 // can only redefine once
3798 di->di_flags &= ~DI_FLAGS_RELOAD;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003799
Bram Moolenaar993faa32022-02-21 15:59:11 +00003800 // A Vim9 script-local variable is also present in sn_all_vars
3801 // and sn_var_vals. It may set "type" from "tv".
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003802 if (var_in_vim9script || var_in_autoload)
Bram Moolenaar993faa32022-02-21 15:59:11 +00003803 update_vim9_script_var(FALSE, di,
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003804 var_in_autoload ? name : di->di_key, flags,
Bram Moolenaar993faa32022-02-21 15:59:11 +00003805 tv, &type, (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003806 }
3807
Bram Moolenaar993faa32022-02-21 15:59:11 +00003808 // existing variable, need to clear the value
3809
3810 // Handle setting internal di: variables separately where needed to
3811 // prevent changing the type.
3812 if (ht == &vimvarht)
3813 {
3814 if (di->di_tv.v_type == VAR_STRING)
3815 {
3816 VIM_CLEAR(di->di_tv.vval.v_string);
3817 if (copy || tv->v_type != VAR_STRING)
3818 {
3819 char_u *val = tv_get_string(tv);
3820
3821 // Careful: when assigning to v:errmsg and
3822 // tv_get_string() causes an error message the variable
3823 // will already be set.
3824 if (di->di_tv.vval.v_string == NULL)
3825 di->di_tv.vval.v_string = vim_strsave(val);
3826 }
3827 else
3828 {
3829 // Take over the string to avoid an extra alloc/free.
3830 di->di_tv.vval.v_string = tv->vval.v_string;
3831 tv->vval.v_string = NULL;
3832 }
3833 goto failed;
3834 }
3835 else if (di->di_tv.v_type == VAR_NUMBER)
3836 {
3837 di->di_tv.vval.v_number = tv_get_number(tv);
3838 if (STRCMP(varname, "searchforward") == 0)
3839 set_search_direction(di->di_tv.vval.v_number
3840 ? '/' : '?');
3841#ifdef FEAT_SEARCH_EXTRA
3842 else if (STRCMP(varname, "hlsearch") == 0)
3843 {
3844 no_hlsearch = !di->di_tv.vval.v_number;
Bram Moolenaara4d158b2022-08-14 14:17:45 +01003845 redraw_all_later(UPD_SOME_VALID);
Bram Moolenaar993faa32022-02-21 15:59:11 +00003846 }
3847#endif
3848 goto failed;
3849 }
3850 else if (di->di_tv.v_type != tv->v_type)
3851 {
3852 semsg(_(e_setting_str_to_value_with_wrong_type), name);
3853 goto failed;
3854 }
3855 }
3856
3857 clear_tv(&di->di_tv);
Bram Moolenaar766ae5b2022-09-14 00:30:51 +01003858
3859 if ((flags & ASSIGN_UPDATE_BLOCK_ID)
3860 && SCRIPT_ID_VALID(current_sctx.sc_sid))
3861 {
3862 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
3863
3864 update_script_var_block_id(name, si->sn_current_block_id);
3865 }
Bram Moolenaar993faa32022-02-21 15:59:11 +00003866 }
3867 else
3868 {
3869 // Item not found, check if a function already exists.
3870 if (is_script_local && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
3871 && lookup_scriptitem(name, STRLEN(name), FALSE, NULL) == OK)
3872 {
3873 semsg(_(e_redefining_script_item_str), name);
3874 goto failed;
3875 }
3876
3877 // add a new variable
3878 if (var_in_vim9script && (flags & ASSIGN_NO_DECL))
3879 {
3880 semsg(_(e_unknown_variable_str), name);
3881 goto failed;
3882 }
3883
3884 // Can't add "v:" or "a:" variable.
3885 if (ht == &vimvarht || ht == get_funccal_args_ht())
3886 {
3887 semsg(_(e_illegal_variable_name_str), name);
3888 goto failed;
3889 }
3890
3891 // Make sure the variable name is valid. In Vim9 script an
3892 // autoload variable must be prefixed with "g:" unless in an
3893 // autoload script.
3894 if (!valid_varname(varname, -1, !vim9script
3895 || STRNCMP(name, "g:", 2) == 0 || var_in_autoload))
3896 goto failed;
3897
3898 di = alloc(sizeof(dictitem_T) + STRLEN(varname));
3899 if (di == NULL)
3900 goto failed;
3901 STRCPY(di->di_key, varname);
3902 if (hash_add(ht, DI2HIKEY(di)) == FAIL)
3903 {
3904 vim_free(di);
3905 goto failed;
3906 }
3907 di->di_flags = DI_FLAGS_ALLOC;
3908 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
3909 di->di_flags |= DI_FLAGS_LOCK;
3910
3911 // A Vim9 script-local variable is also added to sn_all_vars and
3912 // sn_var_vals. It may set "type" from "tv".
3913 if (var_in_vim9script || var_in_autoload)
3914 update_vim9_script_var(TRUE, di,
3915 var_in_autoload ? name : di->di_key, flags,
3916 tv, &type, (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003917 }
3918
Bram Moolenaar993faa32022-02-21 15:59:11 +00003919 dest_tv = &di->di_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003920 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003921 copy_tv(tv, dest_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003922 else
3923 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003924 *dest_tv = *tv;
3925 dest_tv->v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003926 init_tv(tv);
3927 }
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003928 free_tv_arg = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003929
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003930 if (vim9script && type != NULL)
Bram Moolenaar381692b2022-02-02 20:01:27 +00003931 set_tv_type(dest_tv, type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003932
Bram Moolenaar1dcf55d2020-12-22 22:07:30 +01003933 // ":const var = value" locks the value
3934 // ":final var = value" locks "var"
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003935 if (flags & ASSIGN_CONST)
Bram Moolenaar021bda52020-08-17 21:07:22 +02003936 // Like :lockvar! name: lock the value and what it contains, but only
3937 // if the reference count is up to one. That locks only literal
3938 // values.
Bram Moolenaar24e93162021-07-18 20:40:33 +02003939 item_lock(dest_tv, DICT_MAXNEST, TRUE, TRUE);
Bram Moolenaar24e93162021-07-18 20:40:33 +02003940
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003941failed:
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003942 vim_free(name_tofree);
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003943 if (free_tv_arg)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003944 clear_tv(tv_arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003945}
3946
3947/*
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01003948 * Check in this order for backwards compatibility:
3949 * - Whether the variable is read-only
3950 * - Whether the variable value is locked
3951 * - Whether the variable is locked
3952 */
3953 int
3954var_check_permission(dictitem_T *di, char_u *name)
3955{
3956 if (var_check_ro(di->di_flags, name, FALSE)
3957 || value_check_lock(di->di_tv.v_lock, name, FALSE)
3958 || var_check_lock(di->di_flags, name, FALSE))
3959 return FAIL;
3960 return OK;
3961}
3962
3963/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003964 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
3965 * Also give an error message.
3966 */
3967 int
3968var_check_ro(int flags, char_u *name, int use_gettext)
3969{
3970 if (flags & DI_FLAGS_RO)
3971 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00003972 if (name == NULL)
3973 emsg(_(e_cannot_change_readonly_variable));
3974 else
3975 semsg(_(e_cannot_change_readonly_variable_str),
Bram Moolenaard8e44472021-07-21 22:20:33 +02003976 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003977 return TRUE;
3978 }
3979 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
3980 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00003981 if (name == NULL)
3982 emsg(_(e_cannot_set_variable_in_sandbox));
3983 else
3984 semsg(_(e_cannot_set_variable_in_sandbox_str),
3985 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003986 return TRUE;
3987 }
3988 return FALSE;
3989}
3990
3991/*
Bram Moolenaara187c432020-09-16 21:08:28 +02003992 * Return TRUE if di_flags "flags" indicates variable "name" is locked.
3993 * Also give an error message.
3994 */
3995 int
3996var_check_lock(int flags, char_u *name, int use_gettext)
3997{
3998 if (flags & DI_FLAGS_LOCK)
3999 {
4000 semsg(_(e_variable_is_locked_str),
4001 use_gettext ? (char_u *)_(name) : name);
4002 return TRUE;
4003 }
4004 return FALSE;
4005}
4006
4007/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004008 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
4009 * Also give an error message.
4010 */
4011 int
4012var_check_fixed(int flags, char_u *name, int use_gettext)
4013{
4014 if (flags & DI_FLAGS_FIX)
4015 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004016 if (name == NULL)
4017 emsg(_(e_cannot_delete_variable));
4018 else
4019 semsg(_(e_cannot_delete_variable_str),
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004020 use_gettext ? (char_u *)_(name) : name);
4021 return TRUE;
4022 }
4023 return FALSE;
4024}
4025
4026/*
4027 * Check if a funcref is assigned to a valid variable name.
4028 * Return TRUE and give an error if not.
4029 */
4030 int
Bram Moolenaar98b4f142020-08-08 15:46:01 +02004031var_wrong_func_name(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004032 char_u *name, // points to start of variable name
4033 int new_var) // TRUE when creating the variable
4034{
Bram Moolenaar32154662021-03-28 21:14:06 +02004035 // Allow for w: b: s: and t:. In Vim9 script s: is not allowed, because
4036 // the name can be used without the s: prefix.
thinca6c667bd2022-09-02 11:25:37 +01004037 // Allow autoload variable.
Bram Moolenaar32154662021-03-28 21:14:06 +02004038 if (!((vim_strchr((char_u *)"wbt", name[0]) != NULL
4039 || (!in_vim9script() && name[0] == 's')) && name[1] == ':')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004040 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
thinca6c667bd2022-09-02 11:25:37 +01004041 ? name[2] : name[0])
4042 && vim_strchr(name, '#') == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004043 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004044 semsg(_(e_funcref_variable_name_must_start_with_capital_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004045 return TRUE;
4046 }
4047 // Don't allow hiding a function. When "v" is not NULL we might be
4048 // assigning another function to the same var, the type is checked
4049 // below.
4050 if (new_var && function_exists(name, FALSE))
4051 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004052 semsg(_(e_variable_name_conflicts_with_existing_function_str),
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004053 name);
4054 return TRUE;
4055 }
4056 return FALSE;
4057}
4058
4059/*
Bram Moolenaara187c432020-09-16 21:08:28 +02004060 * Return TRUE if "flags" indicates variable "name" has a locked (immutable)
4061 * value. Also give an error message, using "name" or _("name") when
4062 * "use_gettext" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004063 */
4064 int
Bram Moolenaara187c432020-09-16 21:08:28 +02004065value_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004066{
4067 if (lock & VAR_LOCKED)
4068 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004069 if (name == NULL)
4070 emsg(_(e_value_is_locked));
4071 else
4072 semsg(_(e_value_is_locked_str),
4073 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004074 return TRUE;
4075 }
4076 if (lock & VAR_FIXED)
4077 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004078 if (name == NULL)
4079 emsg(_(e_cannot_change_value));
4080 else
4081 semsg(_(e_cannot_change_value_of_str),
4082 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004083 return TRUE;
4084 }
4085 return FALSE;
4086}
4087
4088/*
Bram Moolenaar03290b82020-12-19 16:30:44 +01004089 * Check if a variable name is valid. When "autoload" is true "#" is allowed.
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004090 * If "len" is -1 use all of "varname", otherwise up to "varname[len]".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004091 * Return FALSE and give an error if not.
4092 */
4093 int
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004094valid_varname(char_u *varname, int len, int autoload)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004095{
4096 char_u *p;
4097
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004098 for (p = varname; len < 0 ? *p != NUL : p < varname + len; ++p)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004099 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
Bram Moolenaar03290b82020-12-19 16:30:44 +01004100 && !(autoload && *p == AUTOLOAD_CHAR))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004101 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004102 semsg(_(e_illegal_variable_name_str), varname);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004103 return FALSE;
4104 }
4105 return TRUE;
4106}
4107
4108/*
LemonBoy47d4e312022-05-04 18:12:55 +01004109 * Implements the logic to retrieve local variable and option values.
4110 * Used by "getwinvar()" "gettabvar()" "gettabwinvar()" "getbufvar()".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004111 */
4112 static void
LemonBoy47d4e312022-05-04 18:12:55 +01004113get_var_from(
4114 char_u *varname,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004115 typval_T *rettv,
LemonBoy47d4e312022-05-04 18:12:55 +01004116 typval_T *deftv, // Default value if not found.
4117 int htname, // 't'ab, 'w'indow or 'b'uffer local.
4118 tabpage_T *tp, // can be NULL
4119 win_T *win,
4120 buf_T *buf) // Ignored if htname is not 'b'.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004121{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004122 dictitem_T *v;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004123 int done = FALSE;
Bram Moolenaar18f47402022-01-06 13:24:51 +00004124 switchwin_T switchwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004125 int need_switch_win;
zeertzjqcd6ad642022-07-25 12:28:09 +01004126 int do_change_curbuf = buf != NULL && htname == 'b';
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004127
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004128 ++emsg_off;
4129
4130 rettv->v_type = VAR_STRING;
4131 rettv->vval.v_string = NULL;
4132
LemonBoy47d4e312022-05-04 18:12:55 +01004133 if (varname != NULL && tp != NULL && win != NULL
4134 && (htname != 'b' || buf != NULL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004135 {
4136 // Set curwin to be our win, temporarily. Also set the tabpage,
4137 // otherwise the window is not valid. Only do this when needed,
4138 // autocommands get blocked.
LemonBoy47d4e312022-05-04 18:12:55 +01004139 // If we have a buffer reference avoid the switching, we're saving and
4140 // restoring curbuf directly.
zeertzjqcd6ad642022-07-25 12:28:09 +01004141 need_switch_win = !(tp == curtab && win == curwin) && !do_change_curbuf;
LemonBoy47d4e312022-05-04 18:12:55 +01004142 if (!need_switch_win || switch_win(&switchwin, win, tp, TRUE) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004143 {
LemonBoy47d4e312022-05-04 18:12:55 +01004144 // Handle options. There are no tab-local options.
4145 if (*varname == '&' && htname != 't')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004146 {
LemonBoy47d4e312022-05-04 18:12:55 +01004147 buf_T *save_curbuf = curbuf;
4148
4149 // Change curbuf so the option is read from the correct buffer.
zeertzjqcd6ad642022-07-25 12:28:09 +01004150 if (do_change_curbuf)
LemonBoy47d4e312022-05-04 18:12:55 +01004151 curbuf = buf;
4152
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004153 if (varname[1] == NUL)
4154 {
zeertzjqcd6ad642022-07-25 12:28:09 +01004155 // get all window-local or buffer-local options in a dict
LemonBoy47d4e312022-05-04 18:12:55 +01004156 dict_T *opts = get_winbuf_options(htname == 'b');
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004157
4158 if (opts != NULL)
4159 {
4160 rettv_dict_set(rettv, opts);
4161 done = TRUE;
4162 }
4163 }
LemonBoy47d4e312022-05-04 18:12:55 +01004164 else if (eval_option(&varname, rettv, TRUE) == OK)
4165 // Local option
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004166 done = TRUE;
LemonBoy47d4e312022-05-04 18:12:55 +01004167
4168 curbuf = save_curbuf;
4169 }
4170 else if (*varname == NUL)
4171 {
4172 // Empty string: return a dict with all the local variables.
4173 if (htname == 'b')
4174 v = &buf->b_bufvar;
4175 else if (htname == 'w')
4176 v = &win->w_winvar;
4177 else
4178 v = &tp->tp_winvar;
4179 copy_tv(&v->di_tv, rettv);
4180 done = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004181 }
4182 else
4183 {
LemonBoy47d4e312022-05-04 18:12:55 +01004184 hashtab_T *ht;
4185
4186 if (htname == 'b')
4187 ht = &buf->b_vars->dv_hashtab;
4188 else if (htname == 'w')
4189 ht = &win->w_vars->dv_hashtab;
4190 else
4191 ht = &tp->tp_vars->dv_hashtab;
4192
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004193 // Look up the variable.
LemonBoy47d4e312022-05-04 18:12:55 +01004194 v = find_var_in_ht(ht, htname, varname, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004195 if (v != NULL)
4196 {
4197 copy_tv(&v->di_tv, rettv);
4198 done = TRUE;
4199 }
4200 }
4201 }
4202
4203 if (need_switch_win)
4204 // restore previous notion of curwin
Bram Moolenaar18f47402022-01-06 13:24:51 +00004205 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004206 }
4207
LemonBoy47d4e312022-05-04 18:12:55 +01004208 if (!done && deftv->v_type != VAR_UNKNOWN)
4209 // use the default value
4210 copy_tv(deftv, rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004211
4212 --emsg_off;
4213}
4214
4215/*
LemonBoy47d4e312022-05-04 18:12:55 +01004216 * getwinvar() and gettabwinvar()
4217 */
4218 static void
4219getwinvar(
4220 typval_T *argvars,
4221 typval_T *rettv,
4222 int off) // 1 for gettabwinvar()
4223{
4224 char_u *varname;
4225 tabpage_T *tp;
4226 win_T *win;
4227
4228 if (off == 1)
4229 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4230 else
4231 tp = curtab;
4232 win = find_win_by_nr(&argvars[off], tp);
4233 varname = tv_get_string_chk(&argvars[off + 1]);
4234
4235 get_var_from(varname, rettv, &argvars[off + 2], 'w', tp, win, NULL);
4236}
4237
4238/*
Bram Moolenaar191929b2020-08-19 21:20:49 +02004239 * Set option "varname" to the value of "varp" for the current buffer/window.
4240 */
4241 static void
4242set_option_from_tv(char_u *varname, typval_T *varp)
4243{
4244 long numval = 0;
4245 char_u *strval;
4246 char_u nbuf[NUMBUFLEN];
4247 int error = FALSE;
4248
Bram Moolenaar31a201a2021-01-03 14:47:25 +01004249 if (varp->v_type == VAR_BOOL)
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004250 {
Bram Moolenaar28f84e12022-07-27 12:30:13 +01004251 if (is_string_option(varname))
4252 {
4253 emsg(_(e_string_required));
4254 return;
4255 }
Bram Moolenaar31a201a2021-01-03 14:47:25 +01004256 numval = (long)varp->vval.v_number;
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004257 strval = (char_u *)"0"; // avoid using "false"
4258 }
4259 else
4260 {
4261 if (!in_vim9script() || varp->v_type != VAR_STRING)
4262 numval = (long)tv_get_number_chk(varp, &error);
4263 strval = tv_get_string_buf_chk(varp, nbuf);
4264 }
Bram Moolenaar191929b2020-08-19 21:20:49 +02004265 if (!error && strval != NULL)
Bram Moolenaar31e5c602022-04-15 13:53:33 +01004266 set_option_value_give_err(varname, numval, strval, OPT_LOCAL);
Bram Moolenaar191929b2020-08-19 21:20:49 +02004267}
4268
4269/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004270 * "setwinvar()" and "settabwinvar()" functions
4271 */
4272 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004273setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004274{
4275 win_T *win;
Bram Moolenaar18f47402022-01-06 13:24:51 +00004276 switchwin_T switchwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004277 int need_switch_win;
4278 char_u *varname, *winvarname;
4279 typval_T *varp;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004280 tabpage_T *tp = NULL;
4281
4282 if (check_secure())
4283 return;
4284
4285 if (off == 1)
4286 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4287 else
4288 tp = curtab;
4289 win = find_win_by_nr(&argvars[off], tp);
4290 varname = tv_get_string_chk(&argvars[off + 1]);
4291 varp = &argvars[off + 2];
4292
4293 if (win != NULL && varname != NULL && varp != NULL)
4294 {
4295 need_switch_win = !(tp == curtab && win == curwin);
4296 if (!need_switch_win
Bram Moolenaar18f47402022-01-06 13:24:51 +00004297 || switch_win(&switchwin, win, tp, TRUE) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004298 {
4299 if (*varname == '&')
Bram Moolenaar191929b2020-08-19 21:20:49 +02004300 set_option_from_tv(varname + 1, varp);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004301 else
4302 {
4303 winvarname = alloc(STRLEN(varname) + 3);
4304 if (winvarname != NULL)
4305 {
4306 STRCPY(winvarname, "w:");
4307 STRCPY(winvarname + 2, varname);
4308 set_var(winvarname, varp, TRUE);
4309 vim_free(winvarname);
4310 }
4311 }
4312 }
4313 if (need_switch_win)
Bram Moolenaar18f47402022-01-06 13:24:51 +00004314 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004315 }
4316}
4317
Bram Moolenaare5cdf152019-08-29 22:09:46 +02004318/*
4319 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
4320 * v:option_type, and v:option_command.
4321 */
4322 void
4323reset_v_option_vars(void)
4324{
4325 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
4326 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
4327 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
4328 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
4329 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
4330 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
4331}
4332
4333/*
4334 * Add an assert error to v:errors.
4335 */
4336 void
4337assert_error(garray_T *gap)
4338{
4339 struct vimvar *vp = &vimvars[VV_ERRORS];
4340
Bram Moolenaard787e402021-12-24 21:36:12 +00004341 if (vp->vv_tv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004342 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02004343 set_vim_var_list(VV_ERRORS, list_alloc());
4344 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
4345}
4346
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004347 int
4348var_exists(char_u *var)
4349{
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004350 char_u *arg = var;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004351 char_u *name;
4352 char_u *tofree;
4353 typval_T tv;
4354 int len = 0;
4355 int n = FALSE;
4356
4357 // get_name_len() takes care of expanding curly braces
4358 name = var;
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004359 len = get_name_len(&arg, &tofree, TRUE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004360 if (len > 0)
4361 {
4362 if (tofree != NULL)
4363 name = tofree;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004364 n = (eval_variable(name, len, 0, &tv, NULL,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01004365 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004366 if (n)
4367 {
4368 // handle d.key, l[idx], f(expr)
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004369 arg = skipwhite(arg);
Bram Moolenaar32884ad2022-01-07 12:45:29 +00004370 n = (handle_subscript(&arg, name, &tv, &EVALARG_EVALUATE,
4371 FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004372 if (n)
4373 clear_tv(&tv);
4374 }
4375 }
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004376 if (*arg != NUL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004377 n = FALSE;
4378
4379 vim_free(tofree);
4380 return n;
4381}
4382
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004383static lval_T *redir_lval = NULL;
4384#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
4385static garray_T redir_ga; // only valid when redir_lval is not NULL
4386static char_u *redir_endp = NULL;
4387static char_u *redir_varname = NULL;
4388
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004389 int
4390alloc_redir_lval(void)
4391{
4392 redir_lval = ALLOC_CLEAR_ONE(lval_T);
4393 if (redir_lval == NULL)
4394 return FAIL;
4395 return OK;
4396}
4397
4398 void
4399clear_redir_lval(void)
4400{
4401 VIM_CLEAR(redir_lval);
4402}
4403
4404 void
4405init_redir_ga(void)
4406{
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004407 ga_init2(&redir_ga, sizeof(char), 500);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004408}
4409
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004410/*
4411 * Start recording command output to a variable
4412 * When "append" is TRUE append to an existing variable.
4413 * Returns OK if successfully completed the setup. FAIL otherwise.
4414 */
4415 int
4416var_redir_start(char_u *name, int append)
4417{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004418 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004419 typval_T tv;
4420
4421 // Catch a bad name early.
4422 if (!eval_isnamec1(*name))
4423 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004424 emsg(_(e_invalid_argument));
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004425 return FAIL;
4426 }
4427
4428 // Make a copy of the name, it is used in redir_lval until redir ends.
4429 redir_varname = vim_strsave(name);
4430 if (redir_varname == NULL)
4431 return FAIL;
4432
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004433 if (alloc_redir_lval() == FAIL)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004434 {
4435 var_redir_stop();
4436 return FAIL;
4437 }
4438
4439 // The output is stored in growarray "redir_ga" until redirection ends.
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004440 init_redir_ga();
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004441
4442 // Parse the variable name (can be a dict or list entry).
4443 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
4444 FNE_CHECK_START);
4445 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
4446 {
4447 clear_lval(redir_lval);
4448 if (redir_endp != NULL && *redir_endp != NUL)
4449 // Trailing characters are present after the variable name
Bram Moolenaar74409f62022-01-01 15:58:22 +00004450 semsg(_(e_trailing_characters_str), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004451 else
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004452 semsg(_(e_invalid_argument_str), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004453 redir_endp = NULL; // don't store a value, only cleanup
4454 var_redir_stop();
4455 return FAIL;
4456 }
4457
4458 // check if we can write to the variable: set it to or append an empty
4459 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004460 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004461 tv.v_type = VAR_STRING;
4462 tv.vval.v_string = (char_u *)"";
4463 if (append)
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004464 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004465 ASSIGN_NO_DECL, (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004466 else
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004467 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004468 ASSIGN_NO_DECL, (char_u *)"=", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004469 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004470 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004471 {
4472 redir_endp = NULL; // don't store a value, only cleanup
4473 var_redir_stop();
4474 return FAIL;
4475 }
4476
4477 return OK;
4478}
4479
4480/*
4481 * Append "value[value_len]" to the variable set by var_redir_start().
4482 * The actual appending is postponed until redirection ends, because the value
4483 * appended may in fact be the string we write to, changing it may cause freed
4484 * memory to be used:
4485 * :redir => foo
4486 * :let foo
4487 * :redir END
4488 */
4489 void
4490var_redir_str(char_u *value, int value_len)
4491{
4492 int len;
4493
4494 if (redir_lval == NULL)
4495 return;
4496
4497 if (value_len == -1)
4498 len = (int)STRLEN(value); // Append the entire string
4499 else
4500 len = value_len; // Append only "value_len" characters
4501
4502 if (ga_grow(&redir_ga, len) == OK)
4503 {
4504 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
4505 redir_ga.ga_len += len;
4506 }
4507 else
4508 var_redir_stop();
4509}
4510
4511/*
4512 * Stop redirecting command output to a variable.
4513 * Frees the allocated memory.
4514 */
4515 void
4516var_redir_stop(void)
4517{
4518 typval_T tv;
4519
4520 if (EVALCMD_BUSY)
4521 {
4522 redir_lval = NULL;
4523 return;
4524 }
4525
4526 if (redir_lval != NULL)
4527 {
4528 // If there was no error: assign the text to the variable.
4529 if (redir_endp != NULL)
4530 {
4531 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4532 tv.v_type = VAR_STRING;
4533 tv.vval.v_string = redir_ga.ga_data;
4534 // Call get_lval() again, if it's inside a Dict or List it may
4535 // have changed.
4536 redir_endp = get_lval(redir_varname, NULL, redir_lval,
4537 FALSE, FALSE, 0, FNE_CHECK_START);
4538 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004539 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004540 (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004541 clear_lval(redir_lval);
4542 }
4543
4544 // free the collected output
4545 VIM_CLEAR(redir_ga.ga_data);
4546
4547 VIM_CLEAR(redir_lval);
4548 }
4549 VIM_CLEAR(redir_varname);
4550}
4551
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004552/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004553 * Get the collected redirected text and clear redir_ga.
4554 */
4555 char_u *
4556get_clear_redir_ga(void)
4557{
4558 char_u *res;
4559
4560 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4561 res = redir_ga.ga_data;
4562 redir_ga.ga_data = NULL;
4563 return res;
4564}
4565
4566/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004567 * "gettabvar()" function
4568 */
4569 void
4570f_gettabvar(typval_T *argvars, typval_T *rettv)
4571{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004572 char_u *varname;
LemonBoy47d4e312022-05-04 18:12:55 +01004573 tabpage_T *tp;
4574 win_T *win = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004575
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004576 if (in_vim9script()
4577 && (check_for_number_arg(argvars, 0) == FAIL
4578 || check_for_string_arg(argvars, 1) == FAIL))
4579 return;
4580
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004581 varname = tv_get_string_chk(&argvars[1]);
4582 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
LemonBoy47d4e312022-05-04 18:12:55 +01004583 if (tp != NULL)
4584 win = tp == curtab || tp->tp_firstwin == NULL ? firstwin
4585 : tp->tp_firstwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004586
LemonBoy47d4e312022-05-04 18:12:55 +01004587 get_var_from(varname, rettv, &argvars[2], 't', tp, win, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004588}
4589
4590/*
4591 * "gettabwinvar()" function
4592 */
4593 void
4594f_gettabwinvar(typval_T *argvars, typval_T *rettv)
4595{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004596 if (in_vim9script()
4597 && (check_for_number_arg(argvars, 0) == FAIL
4598 || check_for_number_arg(argvars, 1) == FAIL
4599 || check_for_string_arg(argvars, 2) == FAIL))
4600 return;
4601
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004602 getwinvar(argvars, rettv, 1);
4603}
4604
4605/*
4606 * "getwinvar()" function
4607 */
4608 void
4609f_getwinvar(typval_T *argvars, typval_T *rettv)
4610{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004611 if (in_vim9script()
4612 && (check_for_number_arg(argvars, 0) == FAIL
4613 || check_for_string_arg(argvars, 1) == FAIL))
4614 return;
4615
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004616 getwinvar(argvars, rettv, 0);
4617}
4618
4619/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004620 * "getbufvar()" function
4621 */
4622 void
4623f_getbufvar(typval_T *argvars, typval_T *rettv)
4624{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004625 char_u *varname;
LemonBoy47d4e312022-05-04 18:12:55 +01004626 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004627
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004628 if (in_vim9script()
4629 && (check_for_buffer_arg(argvars, 0) == FAIL
4630 || check_for_string_arg(argvars, 1) == FAIL))
4631 return;
4632
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004633 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004634 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004635
LemonBoy47d4e312022-05-04 18:12:55 +01004636 get_var_from(varname, rettv, &argvars[2], 'b', curtab, curwin, buf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004637}
4638
4639/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004640 * "settabvar()" function
4641 */
4642 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004643f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004644{
4645 tabpage_T *save_curtab;
4646 tabpage_T *tp;
4647 char_u *varname, *tabvarname;
4648 typval_T *varp;
4649
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004650 if (check_secure())
4651 return;
4652
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004653 if (in_vim9script()
4654 && (check_for_number_arg(argvars, 0) == FAIL
4655 || check_for_string_arg(argvars, 1) == FAIL))
4656 return;
4657
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004658 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4659 varname = tv_get_string_chk(&argvars[1]);
4660 varp = &argvars[2];
4661
4662 if (varname != NULL && varp != NULL && tp != NULL)
4663 {
4664 save_curtab = curtab;
4665 goto_tabpage_tp(tp, FALSE, FALSE);
4666
4667 tabvarname = alloc(STRLEN(varname) + 3);
4668 if (tabvarname != NULL)
4669 {
4670 STRCPY(tabvarname, "t:");
4671 STRCPY(tabvarname + 2, varname);
4672 set_var(tabvarname, varp, TRUE);
4673 vim_free(tabvarname);
4674 }
4675
4676 // Restore current tabpage
4677 if (valid_tabpage(save_curtab))
4678 goto_tabpage_tp(save_curtab, FALSE, FALSE);
4679 }
4680}
4681
4682/*
4683 * "settabwinvar()" function
4684 */
4685 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004686f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004687{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004688 if (in_vim9script()
4689 && (check_for_number_arg(argvars, 0) == FAIL
4690 || check_for_number_arg(argvars, 1) == FAIL
4691 || check_for_string_arg(argvars, 2) == FAIL))
4692 return;
4693
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004694 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004695}
4696
4697/*
4698 * "setwinvar()" function
4699 */
4700 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004701f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004702{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004703 if (in_vim9script()
4704 && (check_for_number_arg(argvars, 0) == FAIL
4705 || check_for_string_arg(argvars, 1) == FAIL))
4706 return;
4707
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004708 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004709}
4710
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004711/*
4712 * "setbufvar()" function
4713 */
4714 void
4715f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
4716{
4717 buf_T *buf;
4718 char_u *varname, *bufvarname;
4719 typval_T *varp;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004720
4721 if (check_secure())
4722 return;
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004723
4724 if (in_vim9script()
4725 && (check_for_buffer_arg(argvars, 0) == FAIL
4726 || check_for_string_arg(argvars, 1) == FAIL))
4727 return;
4728
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004729 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004730 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004731 varp = &argvars[2];
4732
4733 if (buf != NULL && varname != NULL && varp != NULL)
4734 {
4735 if (*varname == '&')
4736 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004737 aco_save_T aco;
4738
4739 // set curbuf to be our buf, temporarily
4740 aucmd_prepbuf(&aco, buf);
4741
Bram Moolenaar191929b2020-08-19 21:20:49 +02004742 set_option_from_tv(varname + 1, varp);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004743
4744 // reset notion of buffer
4745 aucmd_restbuf(&aco);
4746 }
4747 else
4748 {
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004749 bufvarname = alloc(STRLEN(varname) + 3);
4750 if (bufvarname != NULL)
4751 {
Bram Moolenaar86015452020-03-29 15:12:15 +02004752 buf_T *save_curbuf = curbuf;
4753
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004754 curbuf = buf;
4755 STRCPY(bufvarname, "b:");
4756 STRCPY(bufvarname + 2, varname);
4757 set_var(bufvarname, varp, TRUE);
4758 vim_free(bufvarname);
4759 curbuf = save_curbuf;
4760 }
4761 }
4762 }
4763}
4764
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004765/*
4766 * Get a callback from "arg". It can be a Funcref or a function name.
4767 * When "arg" is zero return an empty string.
4768 * "cb_name" is not allocated.
4769 * "cb_name" is set to NULL for an invalid argument.
4770 */
4771 callback_T
4772get_callback(typval_T *arg)
4773{
Bram Moolenaar14e579092020-03-07 16:59:25 +01004774 callback_T res;
4775 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004776
4777 res.cb_free_name = FALSE;
4778 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
4779 {
4780 res.cb_partial = arg->vval.v_partial;
4781 ++res.cb_partial->pt_refcount;
4782 res.cb_name = partial_name(res.cb_partial);
4783 }
4784 else
4785 {
4786 res.cb_partial = NULL;
Bram Moolenaar14e579092020-03-07 16:59:25 +01004787 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
4788 && isdigit(*arg->vval.v_string))
4789 r = FAIL;
4790 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004791 {
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004792 if (arg->v_type == VAR_STRING)
4793 {
4794 char_u *name;
4795
4796 name = get_scriptlocal_funcname(arg->vval.v_string);
4797 if (name != NULL)
4798 {
4799 vim_free(arg->vval.v_string);
4800 arg->vval.v_string = name;
4801 }
4802 }
4803
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004804 res.cb_name = arg->vval.v_string;
4805 func_ref(res.cb_name);
4806 }
4807 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004808 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004809 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01004810 r = FAIL;
4811
4812 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004813 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004814 emsg(_(e_invalid_callback_argument));
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004815 res.cb_name = NULL;
4816 }
4817 }
4818 return res;
4819}
4820
4821/*
4822 * Copy a callback into a typval_T.
4823 */
4824 void
4825put_callback(callback_T *cb, typval_T *tv)
4826{
4827 if (cb->cb_partial != NULL)
4828 {
4829 tv->v_type = VAR_PARTIAL;
4830 tv->vval.v_partial = cb->cb_partial;
4831 ++tv->vval.v_partial->pt_refcount;
4832 }
4833 else
4834 {
4835 tv->v_type = VAR_FUNC;
4836 tv->vval.v_string = vim_strsave(cb->cb_name);
4837 func_ref(cb->cb_name);
4838 }
4839}
4840
4841/*
4842 * Make a copy of "src" into "dest", allocating the function name if needed,
4843 * without incrementing the refcount.
4844 */
4845 void
4846set_callback(callback_T *dest, callback_T *src)
4847{
4848 if (src->cb_partial == NULL)
4849 {
4850 // just a function name, make a copy
4851 dest->cb_name = vim_strsave(src->cb_name);
4852 dest->cb_free_name = TRUE;
4853 }
4854 else
4855 {
4856 // cb_name is a pointer into cb_partial
4857 dest->cb_name = src->cb_name;
4858 dest->cb_free_name = FALSE;
4859 }
4860 dest->cb_partial = src->cb_partial;
4861}
4862
4863/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02004864 * Copy callback from "src" to "dest", incrementing the refcounts.
4865 */
4866 void
4867copy_callback(callback_T *dest, callback_T *src)
4868{
4869 dest->cb_partial = src->cb_partial;
4870 if (dest->cb_partial != NULL)
4871 {
4872 dest->cb_name = src->cb_name;
4873 dest->cb_free_name = FALSE;
4874 ++dest->cb_partial->pt_refcount;
4875 }
4876 else
4877 {
4878 dest->cb_name = vim_strsave(src->cb_name);
4879 dest->cb_free_name = TRUE;
4880 func_ref(src->cb_name);
4881 }
4882}
4883
4884/*
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004885 * When a callback refers to an autoload import, change the function name to
4886 * the "path#name" form. Uses the current script context.
4887 * Only works when the name is allocated.
4888 */
4889 void
4890expand_autload_callback(callback_T *cb)
4891{
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004892 char_u *name;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004893 char_u *p;
4894 imported_T *import;
4895
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004896 if (!in_vim9script() || cb->cb_name == NULL
4897 || (!cb->cb_free_name
4898 && (cb->cb_partial == NULL || cb->cb_partial->pt_name == NULL)))
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004899 return;
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004900 if (cb->cb_partial != NULL)
4901 name = cb->cb_partial->pt_name;
4902 else
4903 name = cb->cb_name;
4904 p = vim_strchr(name, '.');
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004905 if (p == NULL)
4906 return;
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004907 import = find_imported(name, p - name, FALSE);
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004908 if (import != NULL && SCRIPT_ID_VALID(import->imp_sid))
4909 {
4910 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
4911
4912 if (si->sn_autoload_prefix != NULL)
4913 {
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004914 char_u *newname = concat_str(si->sn_autoload_prefix, p + 1);
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004915
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004916 if (newname != NULL)
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004917 {
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004918 if (cb->cb_partial != NULL)
4919 {
4920 if (cb->cb_name == cb->cb_partial->pt_name)
4921 cb->cb_name = newname;
4922 vim_free(cb->cb_partial->pt_name);
4923 cb->cb_partial->pt_name = newname;
4924 }
4925 else
4926 {
4927 vim_free(cb->cb_name);
4928 cb->cb_name = newname;
4929 }
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004930 }
4931 }
4932 }
4933}
4934
4935/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004936 * Unref/free "callback" returned by get_callback() or set_callback().
4937 */
4938 void
4939free_callback(callback_T *callback)
4940{
4941 if (callback->cb_partial != NULL)
4942 {
4943 partial_unref(callback->cb_partial);
4944 callback->cb_partial = NULL;
4945 }
4946 else if (callback->cb_name != NULL)
4947 func_unref(callback->cb_name);
4948 if (callback->cb_free_name)
4949 {
4950 vim_free(callback->cb_name);
4951 callback->cb_free_name = FALSE;
4952 }
4953 callback->cb_name = NULL;
4954}
4955
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004956#endif // FEAT_EVAL